Class: DnaPaymentsPartnerReportingSettlementApIs::Client

Inherits:
Object
  • Object
show all
Includes:
CoreLibrary
Defined in:
lib/dna_payments_partner_reporting_settlement_ap_is/client.rb

Overview

dna_payments_partner_reporting_settlement_ap_is client class.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(connection: nil, adapter: :net_http_persistent, timeout: 30, max_retries: 0, retry_interval: 1, backoff_factor: 2, retry_statuses: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524], retry_methods: %i[get put],, http_callback: nil, proxy_settings: nil, logging_configuration: nil, environment: Environment::PRODUCTION, client_credentials_auth_credentials: nil, config: nil) ⇒ Client

Returns a new instance of Client.



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
89
90
 
# File 'lib/dna_payments_partner_reporting_settlement_ap_is/client.rb', line 57

def initialize(
  connection: nil, adapter: :net_http_persistent, timeout: 30,
  max_retries: 0, retry_interval: 1, backoff_factor: 2,
  retry_statuses: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524],
  retry_methods: %i[get put], http_callback: nil, proxy_settings: nil,
  logging_configuration: nil, environment: Environment::PRODUCTION,
  client_credentials_auth_credentials: nil, config: nil
)
  @config = if config.nil?
              Configuration.new(
                connection: connection, adapter: adapter, timeout: timeout,
                max_retries: max_retries, retry_interval: retry_interval,
                backoff_factor: backoff_factor,
                retry_statuses: retry_statuses,
                retry_methods: retry_methods, http_callback: http_callback,
                proxy_settings: proxy_settings,
                logging_configuration: logging_configuration,
                environment: environment,
                client_credentials_auth_credentials: client_credentials_auth_credentials
              )
            else
              config
            end
  user_agent_params = BaseApi.user_agent_parameters

  @global_configuration = GlobalConfiguration.new(client_configuration: @config)
                                             .base_uri_executor(@config.method(:get_base_uri))
                                             .global_errors(BaseApi::GLOBAL_ERRORS)
                                             .user_agent(BaseApi.user_agent,
                                                         agent_parameters: user_agent_params)

  initialize_auth_managers(@global_configuration)
  @global_configuration = @global_configuration.auth_managers(@auth_managers)
end

Instance Attribute Details

#auth_managers ⇒ Object (readonly)

Returns the value of attribute auth_managers.



10
11
12
 
# File 'lib/dna_payments_partner_reporting_settlement_ap_is/client.rb', line 10

def auth_managers
  @auth_managers
end

#config ⇒ Object (readonly)

Returns the value of attribute config.



10
11
12
 
# File 'lib/dna_payments_partner_reporting_settlement_ap_is/client.rb', line 10

def config
  @config
end

Class Method Details

.from_env(**overrides) ⇒ Object

Creates a client directly from environment variables.



104
105
106
107
108
 
# File 'lib/dna_payments_partner_reporting_settlement_ap_is/client.rb', line 104

def self.from_env(**overrides)
  default_config = Configuration.build_default_config_from_env
  new_config = default_config.clone_with(**overrides)
  new(config: new_config)
end

Instance Method Details

#authentication ⇒ AuthenticationApi

Access to authentication controller.

Returns:



23
24
25
 
# File 'lib/dna_payments_partner_reporting_settlement_ap_is/client.rb', line 23

def authentication
  @authentication ||= AuthenticationApi.new @global_configuration
end

#bearer_auth ⇒ Object

Returns the configured authentication BearerAuth instance.



17
18
19
 
# File 'lib/dna_payments_partner_reporting_settlement_ap_is/client.rb', line 17

def bearer_auth
  @auth_managers['BearerAuth']
end

#ecommerce_transactions ⇒ EcommerceTransactionsApi

Access to ecommerce_transactions controller.

Returns:



35
36
37
 
# File 'lib/dna_payments_partner_reporting_settlement_ap_is/client.rb', line 35

def ecommerce_transactions
  @ecommerce_transactions ||= EcommerceTransactionsApi.new @global_configuration
end

#initialize_auth_managers(global_config) ⇒ Object

Initializes the auth managers hash used for authenticating API calls.

Parameters:

  • global_config (GlobalConfiguration) —

    The global configuration of the SDK)



94
95
96
97
98
99
100
101
 
# File 'lib/dna_payments_partner_reporting_settlement_ap_is/client.rb', line 94

def initialize_auth_managers(global_config)
  @auth_managers = {}
  http_client_config = global_config.client_configuration
  %w[BearerAuth].each { |auth| @auth_managers[auth] = nil }
  @auth_managers['BearerAuth'] = Oauth2.new(
    http_client_config.client_credentials_auth_credentials, global_config
  )
end

#merchants ⇒ MerchantsApi

Access to merchants controller.

Returns:



29
30
31
 
# File 'lib/dna_payments_partner_reporting_settlement_ap_is/client.rb', line 29

def merchants
  @merchants ||= MerchantsApi.new @global_configuration
end

#oauth_authorization ⇒ OauthAuthorizationApi

Access to oauth_authorization controller.

Returns:



53
54
55
 
# File 'lib/dna_payments_partner_reporting_settlement_ap_is/client.rb', line 53

def oauth_authorization
  @oauth_authorization ||= OauthAuthorizationApi.new @global_configuration
end

#pos_transactions ⇒ PosTransactionsApi

Access to pos_transactions controller.

Returns:



41
42
43
 
# File 'lib/dna_payments_partner_reporting_settlement_ap_is/client.rb', line 41

def pos_transactions
  @pos_transactions ||= PosTransactionsApi.new @global_configuration
end

#settlements ⇒ SettlementsApi

Access to settlements controller.

Returns:



47
48
49
 
# File 'lib/dna_payments_partner_reporting_settlement_ap_is/client.rb', line 47

def settlements
  @settlements ||= SettlementsApi.new @global_configuration
end

#user_agent_detail ⇒ Object 



12
13
14
 
# File 'lib/dna_payments_partner_reporting_settlement_ap_is/client.rb', line 12

def user_agent_detail
  config.user_agent_detail
end