Class: GoCardlessPro::Services::CreditorsService

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

Overview

Service for making requests to the Creditor 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.



70
71
72
73
74
75
 
# File 'lib/gocardless_pro/services/creditors_service.rb', line 70

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

#create(options = {}) ⇒ Object

Creates a new creditor. Example URL: /creditors

Parameters:

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

    parameters as a hash, under a params key.



16
17
18
19
20
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
 
# File 'lib/gocardless_pro/services/creditors_service.rb', line 16

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

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

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

Retrieves the details of an existing creditor. Example URL: /creditors/:identity

Parameters:

  • identity —

    # Unique identifier, beginning with “CR”.

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

    parameters as a hash, under a params key.



82
83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/gocardless_pro/services/creditors_service.rb', line 82

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

  options[:retry_failures] = true

  response = make_request(:get, path, options)

  return if response.body.nil?

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

#list(options = {}) ⇒ Object

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

Parameters:

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

    parameters as a hash, under a params key.



52
53
54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/gocardless_pro/services/creditors_service.rb', line 52

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

  options[:retry_failures] = true

  response = make_request(:get, path, options)

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

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

Updates a creditor object. Supports all of the fields supported when creating a creditor. Example URL: /creditors/:identity

Parameters:

  • identity —

    # Unique identifier, beginning with “CR”.

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

    parameters as a hash, under a params key.



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/gocardless_pro/services/creditors_service.rb', line 102

def update(identity, options = {})
  path = sub_url('/creditors/: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::Creditor.new(unenvelope_body(response.body), response)
end