class GoCardlessPro::Services::InstalmentSchedulesService

Service for making requests to the InstalmentSchedule endpoints

Public Instance Methods

all(options = {}) click to toggle source

Get a lazily enumerated list of all the items returned. This is simmilar to the `list` method but will paginate for you automatically.

@param options [Hash] parameters as a hash. If the request is a GET, these will be converted to query parameters. Otherwise they will be the body of the request.

# File lib/gocardless_pro/services/instalment_schedules_service.rb, line 136
def all(options = {})
  Paginator.new(
    service: self,
    options: options
  ).enumerator
end
cancel(identity, options = {}) click to toggle source

Immediately cancels an instalment schedule; no further payments will be collected for it.

This will fail with a `cancellation_failed` error if the instalment schedule is already cancelled or has completed. Example URL: /instalment_schedules/:identity/actions/cancel

@param identity # Unique identifier, beginning with “IS”. @param options [Hash] parameters as a hash, under a params key.

# File lib/gocardless_pro/services/instalment_schedules_service.rb, line 190
def cancel(identity, options = {})
  path = sub_url('/instalment_schedules/:identity/actions/cancel', 'identity' => identity)

  params = options.delete(:params) || {}
  options[:params] = {}
  options[:params]['data'] = params

  options[:retry_failures] = false

  begin
    response = make_request(:post, path, options)

    # Response doesn't raise any errors until #body is called
    response.tap(&:body)
  rescue InvalidStateError => e
    if e.idempotent_creation_conflict?
      case @api_service.on_idempotency_conflict
      when :raise
        raise IdempotencyConflict, e.error
      when :fetch
        return get(e.conflicting_resource_id)
      end
    end

    raise e
  end

  return if response.body.nil?

  Resources::InstalmentSchedule.new(unenvelope_body(response.body), response)
end
create_with_dates(options = {}) click to toggle source

Creates a new instalment schedule object, along with the associated payments. This API is recommended if you know the specific dates you wish to charge. Otherwise, please check out the [scheduling version](instalment-schedules-create-with-schedule).

The `instalments` property is an array of payment properties (`amount` and `charge_date`).

It can take quite a while to create the associated payments, so the API will return the status as `pending` initially. When processing has completed, a subsequent GET request for the instalment schedule will either have the status `success` and link to the created payments, or the status `error` and detailed information about the failures. Example URL: /instalment_schedules @param options [Hash] parameters as a hash, under a params key.

# File lib/gocardless_pro/services/instalment_schedules_service.rb, line 34
def create_with_dates(options = {})
  path = '/instalment_schedules'

  params = options.delete(:params) || {}
  options[:params] = {}
  options[:params][envelope_key] = params

  options[:retry_failures] = true

  begin
    response = make_request(:post, path, options)

    # Response doesn't raise any errors until #body is called
    response.tap(&:body)
  rescue InvalidStateError => e
    if e.idempotent_creation_conflict?
      case @api_service.on_idempotency_conflict
      when :raise
        raise IdempotencyConflict, e.error
      when :fetch
        return get(e.conflicting_resource_id)
      end
    end

    raise e
  end

  return if response.body.nil?

  Resources::InstalmentSchedule.new(unenvelope_body(response.body), response)
end
create_with_schedule(options = {}) click to toggle source

Creates a new instalment schedule object, along with the associated payments. This API is recommended if you wish to use the GoCardless scheduling logic. For finer control over the individual dates, please check out the [alternative version](instalment-schedules-create-with-dates).

It can take quite a while to create the associated payments, so the API will return the status as `pending` initially. When processing has completed, a subsequent GET request for the instalment schedule will either have the status `success` and link to the created payments, or the status `error` and detailed information about the failures. Example URL: /instalment_schedules @param options [Hash] parameters as a hash, under a params key.

# File lib/gocardless_pro/services/instalment_schedules_service.rb, line 82
def create_with_schedule(options = {})
  path = '/instalment_schedules'

  params = options.delete(:params) || {}
  options[:params] = {}
  options[:params][envelope_key] = params

  options[:retry_failures] = true

  begin
    response = make_request(:post, path, options)

    # Response doesn't raise any errors until #body is called
    response.tap(&:body)
  rescue InvalidStateError => e
    if e.idempotent_creation_conflict?
      case @api_service.on_idempotency_conflict
      when :raise
        raise IdempotencyConflict, e.error
      when :fetch
        return get(e.conflicting_resource_id)
      end
    end

    raise e
  end

  return if response.body.nil?

  Resources::InstalmentSchedule.new(unenvelope_body(response.body), response)
end
get(identity, options = {}) click to toggle source

Retrieves the details of an existing instalment schedule. Example URL: /instalment_schedules/:identity

@param identity # Unique identifier, beginning with “IS”. @param options [Hash] parameters as a hash, under a params key.

# File lib/gocardless_pro/services/instalment_schedules_service.rb, line 148
def get(identity, options = {})
  path = sub_url('/instalment_schedules/:identity', 'identity' => identity)

  options[:retry_failures] = true

  response = make_request(:get, path, options)

  return if response.body.nil?

  Resources::InstalmentSchedule.new(unenvelope_body(response.body), response)
end
list(options = {}) click to toggle source

Returns a [cursor-paginated](api-usage-cursor-pagination) list of your instalment schedules. Example URL: /instalment_schedules @param options [Hash] parameters as a hash, under a params key.

# File lib/gocardless_pro/services/instalment_schedules_service.rb, line 118
def list(options = {})
  path = '/instalment_schedules'

  options[:retry_failures] = true

  response = make_request(:get, path, options)

  ListResponse.new(
    response: response,
    unenveloped_body: unenvelope_body(response.body),
    resource_class: Resources::InstalmentSchedule
  )
end
update(identity, options = {}) click to toggle source

Updates an instalment schedule. This accepts only the metadata parameter. Example URL: /instalment_schedules/:identity

@param identity # Unique identifier, beginning with “IS”. @param options [Hash] parameters as a hash, under a params key.

# File lib/gocardless_pro/services/instalment_schedules_service.rb, line 165
def update(identity, options = {})
  path = sub_url('/instalment_schedules/:identity', 'identity' => identity)

  params = options.delete(:params) || {}
  options[:params] = {}
  options[:params][envelope_key] = params

  options[:retry_failures] = true

  response = make_request(:put, path, options)

  return if response.body.nil?

  Resources::InstalmentSchedule.new(unenvelope_body(response.body), response)
end

Private Instance Methods

envelope_key() click to toggle source

return the key which API responses will envelope data under

# File lib/gocardless_pro/services/instalment_schedules_service.rb, line 232
def envelope_key
  'instalment_schedules'
end
unenvelope_body(body) click to toggle source

Unenvelope the response of the body using the service's `envelope_key`

@param body [Hash]

# File lib/gocardless_pro/services/instalment_schedules_service.rb, line 227
def unenvelope_body(body)
  body[envelope_key] || body['data']
end