Class: Bfwd::VaultedgatewaysApi

Inherits:
Object
  • Object
show all
Defined in:
lib/bf_ruby2/api/vaultedgateways_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ VaultedgatewaysApi

Returns a new instance of VaultedgatewaysApi.



19
20
21
 
# File 'lib/bf_ruby2/api/vaultedgateways_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/bf_ruby2/api/vaultedgateways_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_authorize_net_token(authorize_net_token, opts = {}) ⇒ AuthorizeNetTokenPagedMetadata

Create an authorize-net-token. a authorize-net-token","request":"createAuthorizeNetTokenRequest.html","response":"createAuthorizeNetTokenResponse.html"

Parameters:

  • authorize_net_token —

    The authorize-net-token object to be created.

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

    the optional parameters

Returns:



28
29
30
31
 
# File 'lib/bf_ruby2/api/vaultedgateways_api.rb', line 28

def create_authorize_net_token(authorize_net_token, opts = {})
  data, _status_code, _headers = create_authorize_net_token_with_http_info(authorize_net_token, opts)
  return data
end

#create_authorize_net_token_with_http_info(authorize_net_token, opts = {}) ⇒ Array<(AuthorizeNetTokenPagedMetadata, Fixnum, Hash)>

Create an authorize-net-token. a authorize-net-token&quot;,&quot;request&quot;:&quot;createAuthorizeNetTokenRequest.html&quot;,&quot;response&quot;:&quot;createAuthorizeNetTokenResponse.html&quot;

Parameters:

  • authorize_net_token —

    The authorize-net-token object to be created.

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

    the optional parameters

Returns:



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
 
# File 'lib/bf_ruby2/api/vaultedgateways_api.rb', line 38

def create_authorize_net_token_with_http_info(authorize_net_token, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: VaultedgatewaysApi.create_authorize_net_token ..."
  end
  # verify the required parameter 'authorize_net_token' is set
  if @api_client.config.client_side_validation && authorize_net_token.nil?
    fail ArgumentError, "Missing the required parameter 'authorize_net_token' when calling VaultedgatewaysApi.create_authorize_net_token"
  end
  # resource path
  local_var_path = "/vaulted-gateways/authorize-net"

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/xml', 'application/xml', 'application/json; charset=utf-8'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=utf-8'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(authorize_net_token)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'AuthorizeNetTokenPagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: VaultedgatewaysApi#create_authorize_net_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_braintree_token(braintree_token, opts = {}) ⇒ BraintreeTokenPagedMetadata

Create a braintree-token. a braintree-token","request":"createBraintreeTokenRequest.html","response":"BraintreeTokenResponse.html"

Parameters:

  • braintree_token —

    The braintree-token object to be created.

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

    the optional parameters

Returns:



83
84
85
86
 
# File 'lib/bf_ruby2/api/vaultedgateways_api.rb', line 83

def create_braintree_token(braintree_token, opts = {})
  data, _status_code, _headers = create_braintree_token_with_http_info(braintree_token, opts)
  return data
end

#create_braintree_token_with_http_info(braintree_token, opts = {}) ⇒ Array<(BraintreeTokenPagedMetadata, Fixnum, Hash)>

Create a braintree-token. a braintree-token&quot;,&quot;request&quot;:&quot;createBraintreeTokenRequest.html&quot;,&quot;response&quot;:&quot;BraintreeTokenResponse.html&quot;

Parameters:

  • braintree_token —

    The braintree-token object to be created.

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

    the optional parameters

Returns:



93
94
95
96
97
98
99
100
101
102
103
104
105
106
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
 
# File 'lib/bf_ruby2/api/vaultedgateways_api.rb', line 93

def create_braintree_token_with_http_info(braintree_token, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: VaultedgatewaysApi.create_braintree_token ..."
  end
  # verify the required parameter 'braintree_token' is set
  if @api_client.config.client_side_validation && braintree_token.nil?
    fail ArgumentError, "Missing the required parameter 'braintree_token' when calling VaultedgatewaysApi.create_braintree_token"
  end
  # resource path
  local_var_path = "/vaulted-gateways/braintree"

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/xml', 'application/xml', 'application/json; charset=utf-8'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=utf-8'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(braintree_token)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'BraintreeTokenPagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: VaultedgatewaysApi#create_braintree_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_stripe_ach_token(stripe_ach_token, opts = {}) ⇒ StripeACHTokenPagedMetadata

Create a stripe-ACH-token. a stripe-ACH-token","request":"createstripeACHTokenRequest.html","response":"createstripeACHTokenResponse.html"

Parameters:

  • stripe_ach_token —

    The stripe-ACH-token object to be created.

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

    the optional parameters

Returns:



138
139
140
141
 
# File 'lib/bf_ruby2/api/vaultedgateways_api.rb', line 138

def create_stripe_ach_token(stripe_ach_token, opts = {})
  data, _status_code, _headers = create_stripe_ach_token_with_http_info(stripe_ach_token, opts)
  return data
end

#create_stripe_ach_token_with_http_info(stripe_ach_token, opts = {}) ⇒ Array<(StripeACHTokenPagedMetadata, Fixnum, Hash)>

Create a stripe-ACH-token. a stripe-ACH-token&quot;,&quot;request&quot;:&quot;createstripeACHTokenRequest.html&quot;,&quot;response&quot;:&quot;createstripeACHTokenResponse.html&quot;

Parameters:

  • stripe_ach_token —

    The stripe-ACH-token object to be created.

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

    the optional parameters

Returns:



148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/bf_ruby2/api/vaultedgateways_api.rb', line 148

def create_stripe_ach_token_with_http_info(stripe_ach_token, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: VaultedgatewaysApi.create_stripe_ach_token ..."
  end
  # verify the required parameter 'stripe_ach_token' is set
  if @api_client.config.client_side_validation && stripe_ach_token.nil?
    fail ArgumentError, "Missing the required parameter 'stripe_ach_token' when calling VaultedgatewaysApi.create_stripe_ach_token"
  end
  # resource path
  local_var_path = "/vaulted-gateways/stripe-ACH"

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/xml', 'application/xml', 'application/json; charset=utf-8'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=utf-8'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(stripe_ach_token)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'StripeACHTokenPagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: VaultedgatewaysApi#create_stripe_ach_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_stripe_token(stripe_token, opts = {}) ⇒ StripeTokenPagedMetadata

Create a stripe-token. a stripe-token","request":"createstripeTokenRequest.html","response":"createstripeTokenResponse.html"

Parameters:

  • stripe_token —

    The stripe-token object to be created.

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

    the optional parameters

Returns:



193
194
195
196
 
# File 'lib/bf_ruby2/api/vaultedgateways_api.rb', line 193

def create_stripe_token(stripe_token, opts = {})
  data, _status_code, _headers = create_stripe_token_with_http_info(stripe_token, opts)
  return data
end

#create_stripe_token_with_http_info(stripe_token, opts = {}) ⇒ Array<(StripeTokenPagedMetadata, Fixnum, Hash)>

Create a stripe-token. a stripe-token&quot;,&quot;request&quot;:&quot;createstripeTokenRequest.html&quot;,&quot;response&quot;:&quot;createstripeTokenResponse.html&quot;

Parameters:

  • stripe_token —

    The stripe-token object to be created.

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

    the optional parameters

Returns:

  • (Array<(StripeTokenPagedMetadata, Fixnum, Hash)>) —

    StripeTokenPagedMetadata data, response status code and response headers



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/bf_ruby2/api/vaultedgateways_api.rb', line 203

def create_stripe_token_with_http_info(stripe_token, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: VaultedgatewaysApi.create_stripe_token ..."
  end
  # verify the required parameter 'stripe_token' is set
  if @api_client.config.client_side_validation && stripe_token.nil?
    fail ArgumentError, "Missing the required parameter 'stripe_token' when calling VaultedgatewaysApi.create_stripe_token"
  end
  # resource path
  local_var_path = "/vaulted-gateways/stripe"

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/xml', 'application/xml', 'application/json; charset=utf-8'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=utf-8'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(stripe_token)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'StripeTokenPagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: VaultedgatewaysApi#create_stripe_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_trust_commerce_token(trust_commerce_token, opts = {}) ⇒ TrustCommerceTokenPagedMetadata

Create a trust-commerce-token. a trust-commerce-token","request":"createTrustCommerceTokenRequest.html","response":"TrustCommerceTokenResponse.html"

Parameters:

  • trust_commerce_token —

    The trust-commerce-token object to be created.

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

    the optional parameters

Returns:



248
249
250
251
 
# File 'lib/bf_ruby2/api/vaultedgateways_api.rb', line 248

def create_trust_commerce_token(trust_commerce_token, opts = {})
  data, _status_code, _headers = create_trust_commerce_token_with_http_info(trust_commerce_token, opts)
  return data
end

#create_trust_commerce_token_with_http_info(trust_commerce_token, opts = {}) ⇒ Array<(TrustCommerceTokenPagedMetadata, Fixnum, Hash)>

Create a trust-commerce-token. a trust-commerce-token&quot;,&quot;request&quot;:&quot;createTrustCommerceTokenRequest.html&quot;,&quot;response&quot;:&quot;TrustCommerceTokenResponse.html&quot;

Parameters:

  • trust_commerce_token —

    The trust-commerce-token object to be created.

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

    the optional parameters

Returns:



258
259
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
 
# File 'lib/bf_ruby2/api/vaultedgateways_api.rb', line 258

def create_trust_commerce_token_with_http_info(trust_commerce_token, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: VaultedgatewaysApi.create_trust_commerce_token ..."
  end
  # verify the required parameter 'trust_commerce_token' is set
  if @api_client.config.client_side_validation && trust_commerce_token.nil?
    fail ArgumentError, "Missing the required parameter 'trust_commerce_token' when calling VaultedgatewaysApi.create_trust_commerce_token"
  end
  # resource path
  local_var_path = "/vaulted-gateways/trustCommerce"

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/xml', 'application/xml', 'application/json; charset=utf-8'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=utf-8'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(trust_commerce_token)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'TrustCommerceTokenPagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: VaultedgatewaysApi#create_trust_commerce_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_braintree_by_account_id(account_id, opts = {}) ⇒ BraintreeTokenPagedMetadata

Returns a list of braintree-tokens backing PaymentMethods belonging to the specified account parameter. a list of braintree-token","response":"getBraintreeByAccountID.html"

Parameters:

  • account_id —

    The string ID of the account-ID.

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

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.Multiple organization-IDs may be specified by repeated use of the query parameter. Example: …&amp;organizations&#x3D;org1&amp;organizations&#x3D;org2

Returns:



304
305
306
307
 
# File 'lib/bf_ruby2/api/vaultedgateways_api.rb', line 304

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

#get_braintree_by_account_id_with_http_info(account_id, opts = {}) ⇒ Array<(BraintreeTokenPagedMetadata, Fixnum, Hash)>

Returns a list of braintree-tokens backing PaymentMethods belonging to the specified account parameter. a list of braintree-token&quot;,&quot;response&quot;:&quot;getBraintreeByAccountID.html&quot;

Parameters:

  • account_id —

    The string ID of the account-ID.

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

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.Multiple organization-IDs may be specified by repeated use of the query parameter. Example: …&amp;organizations&#x3D;org1&amp;organizations&#x3D;org2

Returns:



315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
 
# File 'lib/bf_ruby2/api/vaultedgateways_api.rb', line 315

def (, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: VaultedgatewaysApi.get_braintree_by_account_id ..."
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling VaultedgatewaysApi.get_braintree_by_account_id"
  end
  # resource path
  local_var_path = "/vaulted-gateways/braintree/{accountID}".sub('{' + 'accountID' + '}', .to_s)

  # query parameters
  query_params = {}
  query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json; charset=utf-8'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['text/plain'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'BraintreeTokenPagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: VaultedgatewaysApi#get_braintree_by_account_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_by_card_details_id(card_details_id, opts = {}) ⇒ StripeTokenPagedMetadata

Returns a single stripe-token, specified by the cardDetailsID parameter. a stripe-token by cardDetailsID","response":"getStripeTokenByCardDetailsID.html"

Parameters:

  • card_details_id —

    The card details id of the stripe-token.

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

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

Returns:



362
363
364
365
 
# File 'lib/bf_ruby2/api/vaultedgateways_api.rb', line 362

def get_by_card_details_id(card_details_id, opts = {})
  data, _status_code, _headers = get_by_card_details_id_with_http_info(card_details_id, opts)
  return data
end

#get_by_card_details_id_with_http_info(card_details_id, opts = {}) ⇒ Array<(StripeTokenPagedMetadata, Fixnum, Hash)>

Returns a single stripe-token, specified by the cardDetailsID parameter. a stripe-token by cardDetailsID&quot;,&quot;response&quot;:&quot;getStripeTokenByCardDetailsID.html&quot;

Parameters:

  • card_details_id —

    The card details id of the stripe-token.

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

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.

Returns:

  • (Array<(StripeTokenPagedMetadata, Fixnum, Hash)>) —

    StripeTokenPagedMetadata data, response status code and response headers



373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
 
# File 'lib/bf_ruby2/api/vaultedgateways_api.rb', line 373

def get_by_card_details_id_with_http_info(card_details_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: VaultedgatewaysApi.get_by_card_details_id ..."
  end
  # verify the required parameter 'card_details_id' is set
  if @api_client.config.client_side_validation && card_details_id.nil?
    fail ArgumentError, "Missing the required parameter 'card_details_id' when calling VaultedgatewaysApi.get_by_card_details_id"
  end
  # resource path
  local_var_path = "/vaulted-gateways/stripe/card-details-id/{cardDetailsID}".sub('{' + 'cardDetailsID' + '}', card_details_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json; charset=utf-8'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['text/plain'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'StripeTokenPagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: VaultedgatewaysApi#get_by_card_details_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_stripe_ach(stripe_ach_token_id, opts = {}) ⇒ StripeACHTokenPagedMetadata

Returns a single stripe-ACH-token, specified by the stripeACHTokenID parameter. a stripe-ACH-token","response":"getStripeACHTokenByID.html"

Parameters:

  • stripe_ach_token_id —

    The string ID of the stripe-ACH-token.

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

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.Multiple organization-IDs may be specified by repeated use of the query parameter. Example: …&amp;organizations&#x3D;org1&amp;organizations&#x3D;org2

Returns:



420
421
422
423
 
# File 'lib/bf_ruby2/api/vaultedgateways_api.rb', line 420

def get_stripe_ach(stripe_ach_token_id, opts = {})
  data, _status_code, _headers = get_stripe_ach_with_http_info(stripe_ach_token_id, opts)
  return data
end

#get_stripe_ach_with_http_info(stripe_ach_token_id, opts = {}) ⇒ Array<(StripeACHTokenPagedMetadata, Fixnum, Hash)>

Returns a single stripe-ACH-token, specified by the stripeACHTokenID parameter. a stripe-ACH-token&quot;,&quot;response&quot;:&quot;getStripeACHTokenByID.html&quot;

Parameters:

  • stripe_ach_token_id —

    The string ID of the stripe-ACH-token.

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

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.Multiple organization-IDs may be specified by repeated use of the query parameter. Example: …&amp;organizations&#x3D;org1&amp;organizations&#x3D;org2

Returns:



431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
 
# File 'lib/bf_ruby2/api/vaultedgateways_api.rb', line 431

def get_stripe_ach_with_http_info(stripe_ach_token_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: VaultedgatewaysApi.get_stripe_ach ..."
  end
  # verify the required parameter 'stripe_ach_token_id' is set
  if @api_client.config.client_side_validation && stripe_ach_token_id.nil?
    fail ArgumentError, "Missing the required parameter 'stripe_ach_token_id' when calling VaultedgatewaysApi.get_stripe_ach"
  end
  # resource path
  local_var_path = "/vaulted-gateways/stripe-ACH/{stripeACHTokenID}".sub('{' + 'stripeACHTokenID' + '}', stripe_ach_token_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json; charset=utf-8'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['text/plain'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'StripeACHTokenPagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: VaultedgatewaysApi#get_stripe_ach\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_stripe_token(stripe_token_id, opts = {}) ⇒ StripeTokenPagedMetadata

Returns a single stripe-token, specified by the stripeTokenID parameter. a stripe-token","response":"getStripeTokenByID.html"

Parameters:

  • stripe_token_id —

    The string ID of the stripe-token.

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

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.Multiple organization-IDs may be specified by repeated use of the query parameter. Example: …&amp;organizations&#x3D;org1&amp;organizations&#x3D;org2

Returns:



478
479
480
481
 
# File 'lib/bf_ruby2/api/vaultedgateways_api.rb', line 478

def get_stripe_token(stripe_token_id, opts = {})
  data, _status_code, _headers = get_stripe_token_with_http_info(stripe_token_id, opts)
  return data
end

#get_stripe_token_with_http_info(stripe_token_id, opts = {}) ⇒ Array<(StripeTokenPagedMetadata, Fixnum, Hash)>

Returns a single stripe-token, specified by the stripeTokenID parameter. a stripe-token&quot;,&quot;response&quot;:&quot;getStripeTokenByID.html&quot;

Parameters:

  • stripe_token_id —

    The string ID of the stripe-token.

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

    the optional parameters

Options Hash (opts):

  • :organizations (Array<String>) —

    A list of organization-IDs used to restrict the scope of API calls.Multiple organization-IDs may be specified by repeated use of the query parameter. Example: …&amp;organizations&#x3D;org1&amp;organizations&#x3D;org2

Returns:

  • (Array<(StripeTokenPagedMetadata, Fixnum, Hash)>) —

    StripeTokenPagedMetadata data, response status code and response headers



489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
 
# File 'lib/bf_ruby2/api/vaultedgateways_api.rb', line 489

def get_stripe_token_with_http_info(stripe_token_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: VaultedgatewaysApi.get_stripe_token ..."
  end
  # verify the required parameter 'stripe_token_id' is set
  if @api_client.config.client_side_validation && stripe_token_id.nil?
    fail ArgumentError, "Missing the required parameter 'stripe_token_id' when calling VaultedgatewaysApi.get_stripe_token"
  end
  # resource path
  local_var_path = "/vaulted-gateways/stripe/{stripeTokenID}".sub('{' + 'stripeTokenID' + '}', stripe_token_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'organizations'] = @api_client.build_collection_param(opts[:'organizations'], :multi) if !opts[:'organizations'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json; charset=utf-8'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['text/plain'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'StripeTokenPagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: VaultedgatewaysApi#get_stripe_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_stripe_ach_token(stripe_token, opts = {}) ⇒ StripeACHTokenPagedMetadata

Update a stripe-ACH-token. a stripe-ACH-token","request":"updatestripeACHTokenRequest.html","response":"updatestripeACHTokenResponse.html"

Parameters:

  • stripe_token —

    The stripe-ACH-token object to be updated.

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

    the optional parameters

Returns:



535
536
537
538
 
# File 'lib/bf_ruby2/api/vaultedgateways_api.rb', line 535

def update_stripe_ach_token(stripe_token, opts = {})
  data, _status_code, _headers = update_stripe_ach_token_with_http_info(stripe_token, opts)
  return data
end

#update_stripe_ach_token_with_http_info(stripe_token, opts = {}) ⇒ Array<(StripeACHTokenPagedMetadata, Fixnum, Hash)>

Update a stripe-ACH-token. a stripe-ACH-token&quot;,&quot;request&quot;:&quot;updatestripeACHTokenRequest.html&quot;,&quot;response&quot;:&quot;updatestripeACHTokenResponse.html&quot;

Parameters:

  • stripe_token —

    The stripe-ACH-token object to be updated.

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

    the optional parameters

Returns:



545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
 
# File 'lib/bf_ruby2/api/vaultedgateways_api.rb', line 545

def update_stripe_ach_token_with_http_info(stripe_token, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: VaultedgatewaysApi.update_stripe_ach_token ..."
  end
  # verify the required parameter 'stripe_token' is set
  if @api_client.config.client_side_validation && stripe_token.nil?
    fail ArgumentError, "Missing the required parameter 'stripe_token' when calling VaultedgatewaysApi.update_stripe_ach_token"
  end
  # resource path
  local_var_path = "/vaulted-gateways/stripe-ACH"

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/xml', 'application/xml', 'application/json; charset=utf-8'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=utf-8'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(stripe_token)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'StripeACHTokenPagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: VaultedgatewaysApi#update_stripe_ach_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_stripe_token(stripe_token, opts = {}) ⇒ StripeTokenPagedMetadata

Update a stripe-token. a stripe-token","request":"updatestripeTokenRequest.html","response":"updatestripeTokenResponse.html"

Parameters:

  • stripe_token —

    The stripe-token object to be updated.

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

    the optional parameters

Returns:



590
591
592
593
 
# File 'lib/bf_ruby2/api/vaultedgateways_api.rb', line 590

def update_stripe_token(stripe_token, opts = {})
  data, _status_code, _headers = update_stripe_token_with_http_info(stripe_token, opts)
  return data
end

#update_stripe_token_with_http_info(stripe_token, opts = {}) ⇒ Array<(StripeTokenPagedMetadata, Fixnum, Hash)>

Update a stripe-token. a stripe-token&quot;,&quot;request&quot;:&quot;updatestripeTokenRequest.html&quot;,&quot;response&quot;:&quot;updatestripeTokenResponse.html&quot;

Parameters:

  • stripe_token —

    The stripe-token object to be updated.

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

    the optional parameters

Returns:

  • (Array<(StripeTokenPagedMetadata, Fixnum, Hash)>) —

    StripeTokenPagedMetadata data, response status code and response headers



600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
 
# File 'lib/bf_ruby2/api/vaultedgateways_api.rb', line 600

def update_stripe_token_with_http_info(stripe_token, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: VaultedgatewaysApi.update_stripe_token ..."
  end
  # verify the required parameter 'stripe_token' is set
  if @api_client.config.client_side_validation && stripe_token.nil?
    fail ArgumentError, "Missing the required parameter 'stripe_token' when calling VaultedgatewaysApi.update_stripe_token"
  end
  # resource path
  local_var_path = "/vaulted-gateways/stripe"

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/xml', 'application/xml', 'application/json; charset=utf-8'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=utf-8'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(stripe_token)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'StripeTokenPagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: VaultedgatewaysApi#update_stripe_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#verify_bank_account(bank_account_verification, opts = {}) ⇒ BankAccountVerificationPagedMetadata

Verify Stripe bank account. Stripe bank account","response":"verifyStripeBankAccount.html"

Parameters:

  • bank_account_verification —

    The Bank-Account-Verification object.

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

    the optional parameters

Returns:



645
646
647
648
 
# File 'lib/bf_ruby2/api/vaultedgateways_api.rb', line 645

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

#verify_bank_account_with_http_info(bank_account_verification, opts = {}) ⇒ Array<(BankAccountVerificationPagedMetadata, Fixnum, Hash)>

Verify Stripe bank account. Stripe bank account&quot;,&quot;response&quot;:&quot;verifyStripeBankAccount.html&quot;

Parameters:

  • bank_account_verification —

    The Bank-Account-Verification object.

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

    the optional parameters

Returns:



655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
 
# File 'lib/bf_ruby2/api/vaultedgateways_api.rb', line 655

def (, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: VaultedgatewaysApi.verify_bank_account ..."
  end
  # verify the required parameter 'bank_account_verification' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'bank_account_verification' when calling VaultedgatewaysApi.verify_bank_account"
  end
  # resource path
  local_var_path = "/vaulted-gateways/stripe/verify-bank-account"

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json; charset=utf-8'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=utf-8'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body()
  auth_names = []
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'BankAccountVerificationPagedMetadata')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: VaultedgatewaysApi#verify_bank_account\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#webhook(event, opts = {}) ⇒ String

Receive and handle webhook from Stripe. Stripe webhook","response":"receiveStripeWebhook.html"

Parameters:

  • event —

    The event received.

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

    the optional parameters

Returns:

  • (String) 


700
701
702
703
 
# File 'lib/bf_ruby2/api/vaultedgateways_api.rb', line 700

def webhook(event, opts = {})
  data, _status_code, _headers = webhook_with_http_info(event, opts)
  return data
end

#webhook_with_http_info(event, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Receive and handle webhook from Stripe. Stripe webhook&quot;,&quot;response&quot;:&quot;receiveStripeWebhook.html&quot;

Parameters:

  • event —

    The event received.

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

    the optional parameters

Returns:

  • (Array<(String, Fixnum, Hash)>) —

    String data, response status code and response headers



710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
 
# File 'lib/bf_ruby2/api/vaultedgateways_api.rb', line 710

def webhook_with_http_info(event, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: VaultedgatewaysApi.webhook ..."
  end
  # verify the required parameter 'event' is set
  if @api_client.config.client_side_validation && event.nil?
    fail ArgumentError, "Missing the required parameter 'event' when calling VaultedgatewaysApi.webhook"
  end
  # resource path
  local_var_path = "/vaulted-gateways/stripe/webhook"

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/xml', 'application/xml', 'application/json; charset=utf-8'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=utf-8'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(event)
  auth_names = []
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'String')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: VaultedgatewaysApi#webhook\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end