Class: Merge::Accounting::AsyncAddressesClient

Inherits:
Object
  • Object
show all
Defined in:
lib/merge_ruby_client/accounting/addresses/client.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(request_client:) ⇒ Merge::Accounting::AsyncAddressesClient

Parameters:



68
69
70
 
# File 'lib/merge_ruby_client/accounting/addresses/client.rb', line 68

def initialize(request_client:)
  @request_client = request_client
end

Instance Attribute Details

#request_client ⇒ Merge::AsyncRequestClient (readonly)

Returns:



64
65
66
 
# File 'lib/merge_ruby_client/accounting/addresses/client.rb', line 64

def request_client
  @request_client
end

Instance Method Details

#retrieve(id:, include_remote_data: nil, remote_fields: nil, show_enum_origins: nil, request_options: nil) ⇒ Merge::Accounting::Address

Returns an ‘Address` object with the given `id`.

Examples:

api = Merge::Client.new(
  base_url: "https://api.example.com",
  environment: Merge::Environment::PRODUCTION,
  api_key: "YOUR_AUTH_TOKEN"
)
api.accounting.addresses.retrieve(id: "id")

Parameters:

  • id (String)
  • include_remote_data (Boolean) (defaults to: nil) —

    Whether to include the original data Merge fetched from the third-party to produce these models.

  • remote_fields (String) (defaults to: nil) —

    Deprecated. Use show_enum_origins.

  • show_enum_origins (String) (defaults to: nil) —

    A comma separated list of enum field names for which you’d like the original values to be returned, instead of Merge’s normalized enum values. [Learn e](help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)

  • request_options (Merge::RequestOptions) (defaults to: nil)

Returns:



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/merge_ruby_client/accounting/addresses/client.rb', line 90

def retrieve(id:, include_remote_data: nil, remote_fields: nil, show_enum_origins: nil, request_options: nil)
  Async do
    response = @request_client.conn.get do |req|
      req.options.timeout = request_options.timeout_in_seconds unless request_options&.timeout_in_seconds.nil?
      req.headers["Authorization"] = request_options.api_key unless request_options&.api_key.nil?
      req.headers["X-Account-Token"] = request_options. unless request_options&..nil?
      req.headers = {
    **(req.headers || {}),
    **@request_client.get_headers,
    **(request_options&.additional_headers || {})
      }.compact
      req.params = {
        **(request_options&.additional_query_parameters || {}),
        "include_remote_data": include_remote_data,
        "remote_fields": remote_fields,
        "show_enum_origins": show_enum_origins
      }.compact
      unless request_options.nil? || request_options&.additional_body_parameters.nil?
        req.body = { **(request_options&.additional_body_parameters || {}) }.compact
      end
      req.url "#{@request_client.get_url(request_options: request_options)}/accounting/v1/addresses/#{id}"
    end
    Merge::Accounting::Address.from_json(json_object: response.body)
  end
end