Class: FreightFinancialsWebhookIngestionApi::Client

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

Overview

freight_financials_webhook_ingestion_api 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, config: nil) ⇒ Client

Returns a new instance of Client.



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
 
# File 'lib/freight_financials_webhook_ingestion_api/client.rb', line 52

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,
  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
              )
            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)
end

Instance Attribute Details

#config ⇒ Object (readonly)

Returns the value of attribute config.



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

def config
  @config
end

Class Method Details

.from_env(**overrides) ⇒ Object

Creates a client directly from environment variables.



84
85
86
87
88
 
# File 'lib/freight_financials_webhook_ingestion_api/client.rb', line 84

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

#assignments ⇒ AssignmentsApi

Access to assignments controller.

Returns:



18
19
20
 
# File 'lib/freight_financials_webhook_ingestion_api/client.rb', line 18

def assignments
  @assignments ||= AssignmentsApi.new @global_configuration
end

#documents ⇒ DocumentsApi

Access to documents controller.

Returns:



24
25
26
 
# File 'lib/freight_financials_webhook_ingestion_api/client.rb', line 24

def documents
  @documents ||= DocumentsApi.new @global_configuration
end

#freight_audit ⇒ FreightAuditApi

Access to freight_audit controller.

Returns:



30
31
32
 
# File 'lib/freight_financials_webhook_ingestion_api/client.rb', line 30

def freight_audit
  @freight_audit ||= FreightAuditApi.new @global_configuration
end

#invoices ⇒ InvoicesApi

Access to invoices controller.

Returns:



36
37
38
 
# File 'lib/freight_financials_webhook_ingestion_api/client.rb', line 36

def invoices
  @invoices ||= InvoicesApi.new @global_configuration
end

#loads ⇒ LoadsApi

Access to loads controller.

Returns:

  • (LoadsApi) —

    Returns the controller instance.



42
43
44
 
# File 'lib/freight_financials_webhook_ingestion_api/client.rb', line 42

def loads
  @loads ||= LoadsApi.new @global_configuration
end

#rating ⇒ RatingApi

Access to rating controller.

Returns:

  • (RatingApi) —

    Returns the controller instance.



48
49
50
 
# File 'lib/freight_financials_webhook_ingestion_api/client.rb', line 48

def rating
  @rating ||= RatingApi.new @global_configuration
end

#user_agent_detail ⇒ Object 



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

def user_agent_detail
  config.user_agent_detail
end