Class: GoCardlessPro::Services::CustomersService
- Inherits:
-
BaseService
- Object
- BaseService
- GoCardlessPro::Services::CustomersService
- Defined in:
- lib/gocardless_pro/services/customers_service.rb
Overview
Service for making requests to the Customer endpoints
Instance Method Summary collapse
-
#all(options = {}) ⇒ Object
Get a lazily enumerated list of all the items returned.
-
#create(options = {}) ⇒ Object
Creates a new customer object.
-
#get(identity, options = {}) ⇒ Object
Retrieves the details of an existing customer.
-
#list(options = {}) ⇒ Object
Returns a [cursor-paginated](#api-usage-cursor-pagination) list of your customers.
-
#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.
-
#update(identity, options = {}) ⇒ Object
Updates a customer object.
Methods inherited from BaseService
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 simmilar to the ‘list` method but will paginate for you automatically.
Otherwise they will be the body of the request.
73 74 75 76 77 78 |
# File 'lib/gocardless_pro/services/customers_service.rb', line 73 def all( = {}) Paginator.new( service: self, options: ).enumerator end |
#create(options = {}) ⇒ Object
Creates a new customer object. Example URL: /customers
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 47 48 49 |
# File 'lib/gocardless_pro/services/customers_service.rb', line 17 def create( = {}) path = '/customers' params = .delete(:params) || {} [:params] = {} [:params][envelope_key] = params [:retry_failures] = true begin response = make_request(:post, path, ) # 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) else raise ArgumentError, 'Unknown mode for :on_idempotency_conflict' 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
85 86 87 88 89 90 91 92 93 94 95 |
# File 'lib/gocardless_pro/services/customers_service.rb', line 85 def get(identity, = {}) path = sub_url('/customers/:identity', 'identity' => identity) [:retry_failures] = true response = make_request(:get, path, ) 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
55 56 57 58 59 60 61 62 63 64 65 66 67 |
# File 'lib/gocardless_pro/services/customers_service.rb', line 55 def list( = {}) path = '/customers' [:retry_failures] = true response = make_request(:get, path, ) 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
132 133 134 135 136 137 138 139 140 141 142 |
# File 'lib/gocardless_pro/services/customers_service.rb', line 132 def remove(identity, = {}) path = sub_url('/customers/:identity', 'identity' => identity) [:retry_failures] = false response = make_request(:delete, path, ) 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
103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 |
# File 'lib/gocardless_pro/services/customers_service.rb', line 103 def update(identity, = {}) path = sub_url('/customers/:identity', 'identity' => identity) params = .delete(:params) || {} [:params] = {} [:params][envelope_key] = params [:retry_failures] = true response = make_request(:put, path, ) return if response.body.nil? Resources::Customer.new(unenvelope_body(response.body), response) end |