Class: CybridApiBank::CustomersBankApi

Inherits:
Object
  • Object
show all
Defined in:
lib/cybrid_api_bank_ruby/api/customers_bank_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ CustomersBankApi

Returns a new instance of CustomersBankApi.



19
20
21
 
# File 'lib/cybrid_api_bank_ruby/api/customers_bank_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/cybrid_api_bank_ruby/api/customers_bank_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_customer(post_customer_bank_model, opts = {}) ⇒ CustomerBankModel

Create Customer Creates a customer. ## Customer Type Customer resources are an abstraction for real world individuals and businesses on the Cybrid Platform and are used throughout the platform to perform high level operations, e.g., create a quote, execute a trade, etc.. Customers can have additional resources attached to them, e.g., identity verifications, accounts, etc. ## State | State | Description | |——-|————-| | storing | The Platform is storing the customer details in our private store | | unverified | The Platform has not yet verified the customer’s identity | | verified | The Platform has verified the customer’s identity | | rejected | The Platform was not able to successfully verify the customer’s identity | | frozen | The customer has been frozen on the Platform | Required scope: customers:execute

Parameters:

  • post_customer_bank_model (PostCustomerBankModel)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



27
28
29
30
 
# File 'lib/cybrid_api_bank_ruby/api/customers_bank_api.rb', line 27

def create_customer(post_customer_bank_model, opts = {})
  data, _status_code, _headers = create_customer_with_http_info(post_customer_bank_model, opts)
  data
end

#create_customer_with_http_info(post_customer_bank_model, opts = {}) ⇒ Array<(CustomerBankModel, Integer, Hash)>

Create Customer Creates a customer. ## Customer Type Customer resources are an abstraction for real world individuals and businesses on the Cybrid Platform and are used throughout the platform to perform high level operations, e.g., create a quote, execute a trade, etc.. Customers can have additional resources attached to them, e.g., identity verifications, accounts, etc. ## State | State | Description | |——-|————-| | storing | The Platform is storing the customer details in our private store | | unverified | The Platform has not yet verified the customer&#39;s identity | | verified | The Platform has verified the customer&#39;s identity | | rejected | The Platform was not able to successfully verify the customer&#39;s identity | | frozen | The customer has been frozen on the Platform | Required scope: customers:execute

Parameters:

  • post_customer_bank_model (PostCustomerBankModel)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(CustomerBankModel, Integer, Hash)>) —

    CustomerBankModel data, response status code and response headers



37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/cybrid_api_bank_ruby/api/customers_bank_api.rb', line 37

def create_customer_with_http_info(post_customer_bank_model, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomersBankApi.create_customer ...'
  end
  # verify the required parameter 'post_customer_bank_model' is set
  if @api_client.config.client_side_validation && post_customer_bank_model.nil?
    fail ArgumentError, "Missing the required parameter 'post_customer_bank_model' when calling CustomersBankApi.create_customer"
  end
  # resource path
  local_var_path = '/api/customers'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(post_customer_bank_model)

  # return_type
  return_type = opts[:debug_return_type] || 'CustomerBankModel'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['BearerAuth', 'oauth2']

  new_options = opts.merge(
    :operation => :"CustomersBankApi.create_customer",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CustomersBankApi#create_customer\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_customer(customer_guid, opts = {}) ⇒ CustomerBankModel

Get Customer Retrieves a customer. Required scope: customers:read

Parameters:

  • customer_guid (String) —

    Identifier for the customer.

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

    the optional parameters

Options Hash (opts):

  • :include_pii (Boolean) —

    Include PII in the response.

Returns:



96
97
98
99
 
# File 'lib/cybrid_api_bank_ruby/api/customers_bank_api.rb', line 96

def get_customer(customer_guid, opts = {})
  data, _status_code, _headers = get_customer_with_http_info(customer_guid, opts)
  data
end

#get_customer_with_http_info(customer_guid, opts = {}) ⇒ Array<(CustomerBankModel, Integer, Hash)>

Get Customer Retrieves a customer. Required scope: customers:read

Parameters:

  • customer_guid (String) —

    Identifier for the customer.

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

    the optional parameters

Options Hash (opts):

  • :include_pii (Boolean) —

    Include PII in the response.

Returns:

  • (Array<(CustomerBankModel, Integer, Hash)>) —

    CustomerBankModel data, response status code and response headers



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/cybrid_api_bank_ruby/api/customers_bank_api.rb', line 107

def get_customer_with_http_info(customer_guid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomersBankApi.get_customer ...'
  end
  # verify the required parameter 'customer_guid' is set
  if @api_client.config.client_side_validation && customer_guid.nil?
    fail ArgumentError, "Missing the required parameter 'customer_guid' when calling CustomersBankApi.get_customer"
  end
  # resource path
  local_var_path = '/api/customers/{customer_guid}'.sub('{' + 'customer_guid' + '}', CGI.escape(customer_guid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'include_pii'] = opts[:'include_pii'] if !opts[:'include_pii'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'CustomerBankModel'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['BearerAuth', 'oauth2']

  new_options = opts.merge(
    :operation => :"CustomersBankApi.get_customer",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CustomersBankApi#get_customer\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_customers(opts = {}) ⇒ CustomerListBankModel

Get customers list Retrieves a listing of customers. Required scope: customers:read

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer)
  • :per_page (Integer)
  • :type (String) —

    Comma separated types to list customers for.

  • :bank_guid (String) —

    Comma separated bank_guids to list customers for.

  • :guid (String) —

    Comma separated customer_guids to list customers for.

  • :label (String) —

    Comma separated labels to list customers for.

Returns:



166
167
168
169
 
# File 'lib/cybrid_api_bank_ruby/api/customers_bank_api.rb', line 166

def list_customers(opts = {})
  data, _status_code, _headers = list_customers_with_http_info(opts)
  data
end

#list_customers_with_http_info(opts = {}) ⇒ Array<(CustomerListBankModel, Integer, Hash)>

Get customers list Retrieves a listing of customers. Required scope: customers:read

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :page (Integer)
  • :per_page (Integer)
  • :type (String) —

    Comma separated types to list customers for.

  • :bank_guid (String) —

    Comma separated bank_guids to list customers for.

  • :guid (String) —

    Comma separated customer_guids to list customers for.

  • :label (String) —

    Comma separated labels to list customers for.

Returns:

  • (Array<(CustomerListBankModel, Integer, Hash)>) —

    CustomerListBankModel data, response status code and response headers



181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/cybrid_api_bank_ruby/api/customers_bank_api.rb', line 181

def list_customers_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomersBankApi.list_customers ...'
  end
  if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 0
    fail ArgumentError, 'invalid value for "opts[:"page"]" when calling CustomersBankApi.list_customers, must be greater than or equal to 0.'
  end

  if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] > 100
    fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling CustomersBankApi.list_customers, must be smaller than or equal to 100.'
  end

  if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] < 1
    fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling CustomersBankApi.list_customers, must be greater than or equal to 1.'
  end

  # resource path
  local_var_path = '/api/customers'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil?
  query_params[:'type'] = opts[:'type'] if !opts[:'type'].nil?
  query_params[:'bank_guid'] = opts[:'bank_guid'] if !opts[:'bank_guid'].nil?
  query_params[:'guid'] = opts[:'guid'] if !opts[:'guid'].nil?
  query_params[:'label'] = opts[:'label'] if !opts[:'label'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'CustomerListBankModel'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['BearerAuth', 'oauth2']

  new_options = opts.merge(
    :operation => :"CustomersBankApi.list_customers",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CustomersBankApi#list_customers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_customer(customer_guid, patch_customer_bank_model, opts = {}) ⇒ CustomerBankModel

Patch Customer Update a customer. Required scope: customers:write

Parameters:

  • customer_guid (String) —

    Identifier for the customer.

  • patch_customer_bank_model (PatchCustomerBankModel)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



249
250
251
252
 
# File 'lib/cybrid_api_bank_ruby/api/customers_bank_api.rb', line 249

def update_customer(customer_guid, patch_customer_bank_model, opts = {})
  data, _status_code, _headers = update_customer_with_http_info(customer_guid, patch_customer_bank_model, opts)
  data
end

#update_customer_with_http_info(customer_guid, patch_customer_bank_model, opts = {}) ⇒ Array<(CustomerBankModel, Integer, Hash)>

Patch Customer Update a customer. Required scope: customers:write

Parameters:

  • customer_guid (String) —

    Identifier for the customer.

  • patch_customer_bank_model (PatchCustomerBankModel)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(CustomerBankModel, Integer, Hash)>) —

    CustomerBankModel data, response status code and response headers



260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
 
# File 'lib/cybrid_api_bank_ruby/api/customers_bank_api.rb', line 260

def update_customer_with_http_info(customer_guid, patch_customer_bank_model, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CustomersBankApi.update_customer ...'
  end
  # verify the required parameter 'customer_guid' is set
  if @api_client.config.client_side_validation && customer_guid.nil?
    fail ArgumentError, "Missing the required parameter 'customer_guid' when calling CustomersBankApi.update_customer"
  end
  # verify the required parameter 'patch_customer_bank_model' is set
  if @api_client.config.client_side_validation && patch_customer_bank_model.nil?
    fail ArgumentError, "Missing the required parameter 'patch_customer_bank_model' when calling CustomersBankApi.update_customer"
  end
  # resource path
  local_var_path = '/api/customers/{customer_guid}'.sub('{' + 'customer_guid' + '}', CGI.escape(customer_guid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(patch_customer_bank_model)

  # return_type
  return_type = opts[:debug_return_type] || 'CustomerBankModel'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['BearerAuth', 'oauth2']

  new_options = opts.merge(
    :operation => :"CustomersBankApi.update_customer",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CustomersBankApi#update_customer\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end