Class: MergeAccountingClient::AddressesApi

Inherits:
Object
  • Object
show all
Defined in:
lib/merge_accounting_client/api/addresses_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ AddressesApi 



19
20
21
 
# File 'lib/merge_accounting_client/api/addresses_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/merge_accounting_client/api/addresses_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#addresses_retrieve(x_account_token, id, opts = {}) ⇒ Address

Returns an Address object with the given id.

Options Hash (opts):

  • :include_remote_data (Boolean) —

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

  • :remote_fields (String) —

    Deprecated. Use show_enum_origins.

  • :show_enum_origins (String) —

    Which fields should be returned in non-normalized form.



30
31
32
33
 
# File 'lib/merge_accounting_client/api/addresses_api.rb', line 30

def addresses_retrieve(, id, opts = {})
  data, _status_code, _headers = addresses_retrieve_with_http_info(, id, opts)
  data
end

#addresses_retrieve_with_http_info(x_account_token, id, opts = {}) ⇒ Array<(Address, Integer, Hash)>

Returns an &#x60;Address&#x60; object with the given &#x60;id&#x60;.

Options Hash (opts):

  • :include_remote_data (Boolean) —

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

  • :remote_fields (String) —

    Deprecated. Use show_enum_origins.

  • :show_enum_origins (String) —

    Which fields should be returned in non-normalized form.



43
44
45
46
47
48
49
50
51
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
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/merge_accounting_client/api/addresses_api.rb', line 43

def addresses_retrieve_with_http_info(, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AddressesApi.addresses_retrieve ...'
  end
  # verify the required parameter 'x_account_token' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'x_account_token' when calling AddressesApi.addresses_retrieve"
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling AddressesApi.addresses_retrieve"
  end
  allowable_values = ["type"]
  if @api_client.config.client_side_validation && opts[:'remote_fields'] && !allowable_values.include?(opts[:'remote_fields'])
    fail ArgumentError, "invalid value for \"remote_fields\", must be one of #{allowable_values}"
  end
  allowable_values = ["type"]
  if @api_client.config.client_side_validation && opts[:'show_enum_origins'] && !allowable_values.include?(opts[:'show_enum_origins'])
    fail ArgumentError, "invalid value for \"show_enum_origins\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/addresses/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'include_remote_data'] = opts[:'include_remote_data'] if !opts[:'include_remote_data'].nil?
  query_params[:'remote_fields'] = opts[:'remote_fields'] if !opts[:'remote_fields'].nil?
  query_params[:'show_enum_origins'] = opts[:'show_enum_origins'] if !opts[:'show_enum_origins'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  header_params[:'X-Account-Token'] = 

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Address'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['tokenAuth']

  new_options = opts.merge(
    :operation => :"AddressesApi.addresses_retrieve",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AddressesApi#addresses_retrieve\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end