class Bfwd::VaultedgatewaysApi

Attributes

api_client[RW]

Public Class Methods

new(api_client = ApiClient.default) click to toggle source
# File lib/bf_ruby2/api/vaultedgateways_api.rb, line 19
def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Public Instance Methods

create_authorize_net_token(authorize_net_token, opts = {}) click to toggle source

Create an authorize-net-token. {"nickname":"Create a authorize-net-token","request":"createAuthorizeNetTokenRequest.html","response":"createAuthorizeNetTokenResponse.html"} @param authorize_net_token The authorize-net-token object to be created. @param [Hash] opts the optional parameters @return [AuthorizeNetTokenPagedMetadata]

# 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 = {}) click to toggle source

Create an authorize-net-token. {&quot;nickname&quot;:&quot;Create a authorize-net-token&quot;,&quot;request&quot;:&quot;createAuthorizeNetTokenRequest.html&quot;,&quot;response&quot;:&quot;createAuthorizeNetTokenResponse.html&quot;} @param authorize_net_token The authorize-net-token object to be created. @param [Hash] opts the optional parameters @return [Array<(AuthorizeNetTokenPagedMetadata, Fixnum, Hash)>] AuthorizeNetTokenPagedMetadata data, response status code and response headers

# 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 = {}) click to toggle source

Create a braintree-token. {"nickname":"Create a braintree-token","request":"createBraintreeTokenRequest.html","response":"BraintreeTokenResponse.html"} @param braintree_token The braintree-token object to be created. @param [Hash] opts the optional parameters @return [BraintreeTokenPagedMetadata]

# 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 = {}) click to toggle source

Create a braintree-token. {&quot;nickname&quot;:&quot;Create a braintree-token&quot;,&quot;request&quot;:&quot;createBraintreeTokenRequest.html&quot;,&quot;response&quot;:&quot;BraintreeTokenResponse.html&quot;} @param braintree_token The braintree-token object to be created. @param [Hash] opts the optional parameters @return [Array<(BraintreeTokenPagedMetadata, Fixnum, Hash)>] BraintreeTokenPagedMetadata data, response status code and response headers

# 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 = {}) click to toggle source

Create a stripe-ACH-token. {"nickname":"Create a stripe-ACH-token","request":"createstripeACHTokenRequest.html","response":"createstripeACHTokenResponse.html"} @param stripe_ach_token The stripe-ACH-token object to be created. @param [Hash] opts the optional parameters @return [StripeACHTokenPagedMetadata]

# 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 = {}) click to toggle source

Create a stripe-ACH-token. {&quot;nickname&quot;:&quot;Create a stripe-ACH-token&quot;,&quot;request&quot;:&quot;createstripeACHTokenRequest.html&quot;,&quot;response&quot;:&quot;createstripeACHTokenResponse.html&quot;} @param stripe_ach_token The stripe-ACH-token object to be created. @param [Hash] opts the optional parameters @return [Array<(StripeACHTokenPagedMetadata, Fixnum, Hash)>] StripeACHTokenPagedMetadata data, response status code and response headers

# 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 = {}) click to toggle source

Create a stripe-token. {"nickname":"Create a stripe-token","request":"createstripeTokenRequest.html","response":"createstripeTokenResponse.html"} @param stripe_token The stripe-token object to be created. @param [Hash] opts the optional parameters @return [StripeTokenPagedMetadata]

# 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 = {}) click to toggle source

Create a stripe-token. {&quot;nickname&quot;:&quot;Create a stripe-token&quot;,&quot;request&quot;:&quot;createstripeTokenRequest.html&quot;,&quot;response&quot;:&quot;createstripeTokenResponse.html&quot;} @param stripe_token The stripe-token object to be created. @param [Hash] opts the optional parameters @return [Array<(StripeTokenPagedMetadata, Fixnum, Hash)>] StripeTokenPagedMetadata data, response status code and response headers

# 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 = {}) click to toggle source

Create a trust-commerce-token. {"nickname":"Create a trust-commerce-token","request":"createTrustCommerceTokenRequest.html","response":"TrustCommerceTokenResponse.html"} @param trust_commerce_token The trust-commerce-token object to be created. @param [Hash] opts the optional parameters @return [TrustCommerceTokenPagedMetadata]

# 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 = {}) click to toggle source

Create a trust-commerce-token. {&quot;nickname&quot;:&quot;Create a trust-commerce-token&quot;,&quot;request&quot;:&quot;createTrustCommerceTokenRequest.html&quot;,&quot;response&quot;:&quot;TrustCommerceTokenResponse.html&quot;} @param trust_commerce_token The trust-commerce-token object to be created. @param [Hash] opts the optional parameters @return [Array<(TrustCommerceTokenPagedMetadata, Fixnum, Hash)>] TrustCommerceTokenPagedMetadata data, response status code and response headers

# 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 = {}) click to toggle source

Returns a list of braintree-tokens backing PaymentMethods belonging to the specified account parameter. {"nickname":"Retrieve a list of braintree-token","response":"getBraintreeByAccountID.html"} @param account_id The string ID of the account-ID. @param [Hash] opts the optional parameters @option opts [Array<String>] :organizations 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 @return [BraintreeTokenPagedMetadata]

# File lib/bf_ruby2/api/vaultedgateways_api.rb, line 304
def get_braintree_by_account_id(account_id, opts = {})
  data, _status_code, _headers = get_braintree_by_account_id_with_http_info(account_id, opts)
  return data
end
get_braintree_by_account_id_with_http_info(account_id, opts = {}) click to toggle source

Returns a list of braintree-tokens backing PaymentMethods belonging to the specified account parameter. {&quot;nickname&quot;:&quot;Retrieve a list of braintree-token&quot;,&quot;response&quot;:&quot;getBraintreeByAccountID.html&quot;} @param account_id The string ID of the account-ID. @param [Hash] opts the optional parameters @option opts [Array<String>] :organizations 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 @return [Array<(BraintreeTokenPagedMetadata, Fixnum, Hash)>] BraintreeTokenPagedMetadata data, response status code and response headers

# File lib/bf_ruby2/api/vaultedgateways_api.rb, line 315
def get_braintree_by_account_id_with_http_info(account_id, 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 && account_id.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' + '}', account_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 => '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 = {}) click to toggle source

Returns a single stripe-token, specified by the cardDetailsID parameter. {"nickname":"Retrieve a stripe-token by cardDetailsID","response":"getStripeTokenByCardDetailsID.html"} @param card_details_id The card details id of the stripe-token. @param [Hash] opts the optional parameters @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls. @return [StripeTokenPagedMetadata]

# 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 = {}) click to toggle source

Returns a single stripe-token, specified by the cardDetailsID parameter. {&quot;nickname&quot;:&quot;Retrieve a stripe-token by cardDetailsID&quot;,&quot;response&quot;:&quot;getStripeTokenByCardDetailsID.html&quot;} @param card_details_id The card details id of the stripe-token. @param [Hash] opts the optional parameters @option opts [Array<String>] :organizations A list of organization-IDs used to restrict the scope of API calls. @return [Array<(StripeTokenPagedMetadata, Fixnum, Hash)>] StripeTokenPagedMetadata data, response status code and response headers

# 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 = {}) click to toggle source

Returns a single stripe-ACH-token, specified by the stripeACHTokenID parameter. {"nickname":"Retrieve a stripe-ACH-token","response":"getStripeACHTokenByID.html"} @param stripe_ach_token_id The string ID of the stripe-ACH-token. @param [Hash] opts the optional parameters @option opts [Array<String>] :organizations 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 @return [StripeACHTokenPagedMetadata]

# 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 = {}) click to toggle source

Returns a single stripe-ACH-token, specified by the stripeACHTokenID parameter. {&quot;nickname&quot;:&quot;Retrieve a stripe-ACH-token&quot;,&quot;response&quot;:&quot;getStripeACHTokenByID.html&quot;} @param stripe_ach_token_id The string ID of the stripe-ACH-token. @param [Hash] opts the optional parameters @option opts [Array<String>] :organizations 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 @return [Array<(StripeACHTokenPagedMetadata, Fixnum, Hash)>] StripeACHTokenPagedMetadata data, response status code and response headers

# 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 = {}) click to toggle source

Returns a single stripe-token, specified by the stripeTokenID parameter. {"nickname":"Retrieve a stripe-token","response":"getStripeTokenByID.html"} @param stripe_token_id The string ID of the stripe-token. @param [Hash] opts the optional parameters @option opts [Array<String>] :organizations 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 @return [StripeTokenPagedMetadata]

# 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 = {}) click to toggle source

Returns a single stripe-token, specified by the stripeTokenID parameter. {&quot;nickname&quot;:&quot;Retrieve a stripe-token&quot;,&quot;response&quot;:&quot;getStripeTokenByID.html&quot;} @param stripe_token_id The string ID of the stripe-token. @param [Hash] opts the optional parameters @option opts [Array<String>] :organizations 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 @return [Array<(StripeTokenPagedMetadata, Fixnum, Hash)>] StripeTokenPagedMetadata data, response status code and response headers

# 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 = {}) click to toggle source

Update a stripe-ACH-token. {"nickname":"Update a stripe-ACH-token","request":"updatestripeACHTokenRequest.html","response":"updatestripeACHTokenResponse.html"} @param stripe_token The stripe-ACH-token object to be updated. @param [Hash] opts the optional parameters @return [StripeACHTokenPagedMetadata]

# 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 = {}) click to toggle source

Update a stripe-ACH-token. {&quot;nickname&quot;:&quot;Update a stripe-ACH-token&quot;,&quot;request&quot;:&quot;updatestripeACHTokenRequest.html&quot;,&quot;response&quot;:&quot;updatestripeACHTokenResponse.html&quot;} @param stripe_token The stripe-ACH-token object to be updated. @param [Hash] opts the optional parameters @return [Array<(StripeACHTokenPagedMetadata, Fixnum, Hash)>] StripeACHTokenPagedMetadata data, response status code and response headers

# 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 = {}) click to toggle source

Update a stripe-token. {"nickname":"Update a stripe-token","request":"updatestripeTokenRequest.html","response":"updatestripeTokenResponse.html"} @param stripe_token The stripe-token object to be updated. @param [Hash] opts the optional parameters @return [StripeTokenPagedMetadata]

# 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 = {}) click to toggle source

Update a stripe-token. {&quot;nickname&quot;:&quot;Update a stripe-token&quot;,&quot;request&quot;:&quot;updatestripeTokenRequest.html&quot;,&quot;response&quot;:&quot;updatestripeTokenResponse.html&quot;} @param stripe_token The stripe-token object to be updated. @param [Hash] opts the optional parameters @return [Array<(StripeTokenPagedMetadata, Fixnum, Hash)>] StripeTokenPagedMetadata data, response status code and response headers

# 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 = {}) click to toggle source

Verify Stripe bank account. {"nickname":"Verify Stripe bank account","response":"verifyStripeBankAccount.html"} @param bank_account_verification The Bank-Account-Verification object. @param [Hash] opts the optional parameters @return [BankAccountVerificationPagedMetadata]

# File lib/bf_ruby2/api/vaultedgateways_api.rb, line 645
def verify_bank_account(bank_account_verification, opts = {})
  data, _status_code, _headers = verify_bank_account_with_http_info(bank_account_verification, opts)
  return data
end
verify_bank_account_with_http_info(bank_account_verification, opts = {}) click to toggle source

Verify Stripe bank account. {&quot;nickname&quot;:&quot;Verify Stripe bank account&quot;,&quot;response&quot;:&quot;verifyStripeBankAccount.html&quot;} @param bank_account_verification The Bank-Account-Verification object. @param [Hash] opts the optional parameters @return [Array<(BankAccountVerificationPagedMetadata, Fixnum, Hash)>] BankAccountVerificationPagedMetadata data, response status code and response headers

# File lib/bf_ruby2/api/vaultedgateways_api.rb, line 655
def verify_bank_account_with_http_info(bank_account_verification, 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 && bank_account_verification.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(bank_account_verification)
  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 = {}) click to toggle source

Receive and handle webhook from Stripe. {"nickname":"Receive Stripe webhook","response":"receiveStripeWebhook.html"} @param event The event received. @param [Hash] opts the optional parameters @return [String]

# 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 = {}) click to toggle source

Receive and handle webhook from Stripe. {&quot;nickname&quot;:&quot;Receive Stripe webhook&quot;,&quot;response&quot;:&quot;receiveStripeWebhook.html&quot;} @param event The event received. @param [Hash] opts the optional parameters @return [Array<(String, Fixnum, Hash)>] String data, response status code and response headers

# 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