Class: GoCardlessPro::Services::CustomersService

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

Overview

Service for making requests to the Customer 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/customers_service.rb', line 70

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

#create(options = {}) ⇒ Object

Creates a new customer object. Example URL: /customers

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/customers_service.rb', line 16

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

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

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

Retrieves the details of an existing customer. Example URL: /customers/:identity

Parameters:

  • identity —

    # Unique identifier, beginning with “CU”.

  • 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/customers_service.rb', line 82

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

  options[:retry_failures] = true

  response = make_request(:get, path, options)

  return if response.body.nil?

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

#list(options = {}) ⇒ Object

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

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/customers_service.rb', line 52

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

  options[:retry_failures] = true

  response = make_request(:get, path, options)

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

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

Removed customers will not appear in search results or lists of customers (in our API or exports), and it will not be possible to load an individually removed customer by ID.

<p class=“restricted-notice”><strong>The action of removing a customer cannot be reversed, so please use with care.</strong></p> Example URL: /customers/:identity

Parameters:

  • identity —

    # Unique identifier, beginning with “CU”.

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

    parameters as a hash, under a params key.



132
133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/gocardless_pro/services/customers_service.rb', line 132

def remove(identity, options = {})
  path = sub_url('/customers/:identity', {
                   'identity' => identity
                 })

  options[:retry_failures] = false

  response = make_request(:delete, path, options)

  return if response.body.nil?

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

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

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

Parameters:

  • identity —

    # Unique identifier, beginning with “CU”.

  • 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/customers_service.rb', line 102

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