Class: CheckoutSdk::Instruments::InstrumentsClient

Inherits:

BaseInstrumentsClient

• Object
• Client
• BaseInstrumentsClient
• CheckoutSdk::Instruments::InstrumentsClient

Defined in:

lib/checkout_sdk/instruments/instruments_client.rb

Instance Attribute Summary

Attributes inherited from Client

#api_client, #authorization_type, #configuration

Instance Method Summary

• #create(create_instrument_request) ⇒ Object
• #get_bank_account_field_formatting(country, currency, bank_account_field_query) ⇒ Object
• #initialize(api_client, configuration) ⇒ InstrumentsClient constructor

  A new instance of InstrumentsClient.

• #update(instrument_id, update_instrument_request) ⇒ Object

Methods inherited from BaseInstrumentsClient

#delete, #get

Constructor Details

#initialize(api_client, configuration) ⇒ InstrumentsClient

Returns a new instance of InstrumentsClient.

Parameters:

• api_client (ApiClient)
• configuration (CheckoutConfiguration)

# File 'lib/checkout_sdk/instruments/instruments_client.rb', line 11

def initialize(api_client, configuration)
  super api_client, configuration, CheckoutSdk::AuthorizationType::SECRET_KEY_OR_OAUTH
end

Instance Method Details

#create(create_instrument_request) ⇒ Object

Parameters:

• create_instrument_request (Hash, Instrument)

# File 'lib/checkout_sdk/instruments/instruments_client.rb', line 16

def create(create_instrument_request)
  api_client.invoke_post(INSTRUMENTS, sdk_authorization, create_instrument_request)
end

#get_bank_account_field_formatting(country, currency, bank_account_field_query) ⇒ Object

Parameters:

• country (String) —

  Common::Country

• currency (String) —

  Common::Currency

• bank_account_field_query (Hash, BankAccountFieldQuery)

# File 'lib/checkout_sdk/instruments/instruments_client.rb', line 31

def get_bank_account_field_formatting(country, currency, bank_account_field_query)
  api_client.invoke_get(build_path(VALIDATION, country, currency),
                        sdk_authorization(CheckoutSdk::AuthorizationType::OAUTH),
                        bank_account_field_query)
end

#update(instrument_id, update_instrument_request) ⇒ Object

Parameters:

• instrument_id (String)
• update_instrument_request (Hash, UpdateInstrument)

# File 'lib/checkout_sdk/instruments/instruments_client.rb', line 22

def update(instrument_id, update_instrument_request)
  api_client.invoke_patch(build_path(INSTRUMENTS, instrument_id),
                          sdk_authorization,
                          update_instrument_request)
end