Class: GoCardlessPro::Services::SchemeIdentifiersService

Inherits:
BaseService
  • Object
show all
Defined in:
lib/gocardless_pro/services/scheme_identifiers_service.rb

Overview

Service for making requests to the SchemeIdentifier endpoints

Instance Method Summary collapse

Methods inherited from BaseService

#initialize, #make_request, #sub_url

Constructor Details

This class inherits a constructor from GoCardlessPro::Services::BaseService

Instance Method Details

#all(options = {}) ⇒ Object

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

Otherwise they will be the body of the request.

Parameters:

  • options (Hash) (defaults to: {}) —

    parameters as a hash. If the request is a GET, these will be converted to query parameters.



75
76
77
78
79
80
 
# File 'lib/gocardless_pro/services/scheme_identifiers_service.rb', line 75

def all(options = {})
  Paginator.new(
    service: self,
    options: options
  ).enumerator
end

#create(options = {}) ⇒ Object

Creates a new scheme identifier. The scheme identifier must be [applied to a creditor](#creditors-apply-a-scheme-identifier) before payments are taken using it. The scheme identifier must also have the status of active before it can be used. For some schemes e.g. faster_payments this will happen instantly. For other schemes e.g. bacs this can take several days.

Example URL: /scheme_identifiers

Parameters:

  • options (Hash) (defaults to: {}) —

    parameters as a hash, under a params key.



21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
 
# File 'lib/gocardless_pro/services/scheme_identifiers_service.rb', line 21

def create(options = {})
  path = '/scheme_identifiers'

  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::SchemeIdentifier.new(unenvelope_body(response.body), response)
end

#get(identity, options = {}) ⇒ Object

Retrieves the details of an existing scheme identifier. Example URL: /scheme_identifiers/:identity

Parameters:

  • identity —

    # Unique identifier, usually beginning with “SU”.

  • options (Hash) (defaults to: {}) —

    parameters as a hash, under a params key.



87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/gocardless_pro/services/scheme_identifiers_service.rb', line 87

def get(identity, options = {})
  path = sub_url('/scheme_identifiers/:identity', {
                   'identity' => identity,
                 })

  options[:retry_failures] = true

  response = make_request(:get, path, options)

  return if response.body.nil?

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

#list(options = {}) ⇒ Object

Returns a [cursor-paginated](#api-usage-cursor-pagination) list of your scheme identifiers. Example URL: /scheme_identifiers

Parameters:

  • options (Hash) (defaults to: {}) —

    parameters as a hash, under a params key.



57
58
59
60
61
62
63
64
65
66
67
68
69
 
# File 'lib/gocardless_pro/services/scheme_identifiers_service.rb', line 57

def list(options = {})
  path = '/scheme_identifiers'

  options[:retry_failures] = true

  response = make_request(:get, path, options)

  ListResponse.new(
    response: response,
    unenveloped_body: unenvelope_body(response.body),
    resource_class: Resources::SchemeIdentifier
  )
end