Class: AvalaraSdk::EInvoicing::V1::MandatesApi

Inherits:
Object
  • Object
show all
Defined in:
lib/avalara_sdk/api/EInvoicing/V1/mandates_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client) ⇒ MandatesApi

Returns a new instance of MandatesApi.



18
19
20
21
22
23
24
 
# File 'lib/avalara_sdk/api/EInvoicing/V1/mandates_api.rb', line 18

def initialize(api_client)
  if (api_client.nil?)
    fail  ArgumentError,'api_client is nil'
  end
  api_client.set_sdk_version("")
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



16
17
18
 
# File 'lib/avalara_sdk/api/EInvoicing/V1/mandates_api.rb', line 16

def api_client
  @api_client
end

Instance Method Details

#build_collection_param(param, collection_format) ⇒ Object

Build parameter value according to the given collection format.

Parameters:

  • collection_format (String) —

    one of :csv, :ssv, :tsv, :pipes and :multi



212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/avalara_sdk/api/EInvoicing/V1/mandates_api.rb', line 212

def build_collection_param(param, collection_format)
  case collection_format
  when :csv
    param.join(',')
  when :ssv
    param.join(' ')
  when :tsv
    param.join("\t")
  when :pipes
    param.join('|')
  when :multi
    # return the array directly as typhoeus will handle it as expected
    param
  else
    fail "unknown collection format: #{collection_format.inspect}"
  end
end

#convert_to_type(data, return_type) ⇒ Mixed

Convert data to the given return type.

Parameters:

  • data (Object) —

    Data to be converted

  • return_type (String) —

    Return type

Returns:

  • (Mixed) —

    Data in a particular type



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/avalara_sdk/api/EInvoicing/V1/mandates_api.rb', line 93

def convert_to_type(data, return_type)
  return nil if data.nil?
  case return_type
  when 'String'
    data.to_s
  when 'Integer'
    data.to_i
  when 'Float'
    data.to_f
  when 'Boolean'
    data == true
  when 'Time'
    # parse date time (expecting ISO 8601 format)
    Time.parse data
  when 'Date'
    # parse date time (expecting ISO 8601 format)
    Date.parse data
  when 'Object'
    # generic object (usually a Hash), return directly
    data
  when /\AArray<(.+)>\z/
    # e.g. Array<Pet>
    sub_type = $1
    data.map { |item| convert_to_type(item, sub_type) }
  when /\AHash\<String, (.+)\>\z/
    # e.g. Hash<String, Integer>
    sub_type = $1
    {}.tap do |hash|
      data.each { |k, v| hash[k] = convert_to_type(v, sub_type) }
    end
  else
    # models (e.g. Pet) or oneOf
    klass = AvalaraSdk::EInvoicing::V1.const_get(return_type)
    klass.respond_to?(:openapi_one_of) ? klass.build(data) : klass.build_from_hash(data)
  end
end

#deserialize(response, return_type) ⇒ Object

Deserialize the response to the given return type.

Parameters:

  • response (Response) —

    HTTP response

  • return_type (String) —

    some examples: “User”, “Array<User>”, “Hash<String, Integer>”



41
42
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
 
# File 'lib/avalara_sdk/api/EInvoicing/V1/mandates_api.rb', line 41

def deserialize(response, return_type)
  body = response.body

  # handle file downloading - return the File instance processed in request callbacks
  # note that response body is empty when the file is written in chunks in request on_body callback
  if return_type == 'File'
    content_disposition = response.headers['Content-Disposition']
    if content_disposition && content_disposition =~ /filename=/i
      filename = content_disposition[/filename=['"]?([^'"\s]+)['"]?/, 1]
      prefix = sanitize_filename(filename)
    else
      prefix = 'download-'
    end
    prefix = prefix + '-' unless prefix.end_with?('-')
    encoding = body.encoding
    @tempfile = Tempfile.open(prefix, @config.temp_folder_path, encoding: encoding)
    @tempfile.write(@stream.join.force_encoding(encoding))
    @tempfile.close
    @config.logger.info "Temp file written to #{@tempfile.path}, please copy the file to a proper folder "\
                        "with e.g. `FileUtils.cp(tempfile.path, '/new/file/path')` otherwise the temp file "\
                        "will be deleted automatically with GC. It's also recommended to delete the temp file "\
                        "explicitly with `tempfile.delete`"
    return @tempfile
  end

  return nil if body.nil? || body.empty?

  # return response body directly for String return type
  return body if return_type == 'String'

  # ensuring a default content type
  content_type = response.headers['Content-Type'] || 'application/json'

  fail "Content-Type is not supported: #{content_type}" unless json_mime?(content_type)

  begin
    data = JSON.parse("[#{body}]", :symbolize_names => true)[0]
  rescue JSON::ParserError => e
    if %w(String Date Time).include?(return_type)
      data = body
    else
      raise e
    end
  end

  convert_to_type data, return_type
end

#get_mandates(request_parameters) ⇒ MandatesResponse

List country mandates that are supported by the Avalara E-Invoicing platform This endpoint offers a list of country mandates supported by the Avalara E-Invoicing API.

Parameters:

  • avalara_version (String) —

    The HTTP Header meant to specify the version of the API intended to be used # @param x_avalara_client [String] You can freely use any text you wish for this value. This feature can help you diagnose and solve problems with your software. The header can be treated like a &quot;Fingerprint&quot; # @param filter [String] Filter by field name and value. This filter only supports &lt;code&gt;eq&lt;/code&gt; and &lt;code&gt;contains&lt;/code&gt;. Refer to [developer.avalara.com/avatax/filtering-in-rest/](https://developer.avalara.com/avatax/filtering-in-rest/) for more information on filtering. # @param top [Float] If nonzero, return no more than this number of results. Used with &lt;code&gt;$skip&lt;/code&gt; to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records. # @param skip [Float] If nonzero, skip this number of results before returning data. Used with &lt;code&gt;$top&lt;/code&gt; to provide pagination for large datasets. # @param count [Boolean] When set to true, the count of the collection is also returned in the response body. # @param count_only [Boolean] When set to true, only the count of the collection is returned

Returns:



234
235
236
237
 
# File 'lib/avalara_sdk/api/EInvoicing/V1/mandates_api.rb', line 234

def get_mandates(request_parameters)
  data, _status_code, _headers = get_mandates_with_http_info(request_parameters)
  data
end

#get_mandates_with_http_info(request_parameters) ⇒ Array<(MandatesResponse, Integer, Hash)>

Returns MandatesResponse data, response status code and response headers.

Parameters:

  • avalara_version (String) —

    The HTTP Header meant to specify the version of the API intended to be used

  • x_avalara_client (String) —

    You can freely use any text you wish for this value. This feature can help you diagnose and solve problems with your software. The header can be treated like a &quot;Fingerprint&quot;

  • filter (String) —

    Filter by field name and value. This filter only supports &lt;code&gt;eq&lt;/code&gt; and &lt;code&gt;contains&lt;/code&gt;. Refer to [developer.avalara.com/avatax/filtering-in-rest/](https://developer.avalara.com/avatax/filtering-in-rest/) for more information on filtering.

  • top (Float) —

    If nonzero, return no more than this number of results. Used with &lt;code&gt;$skip&lt;/code&gt; to provide pagination for large datasets. Unless otherwise specified, the maximum number of records that can be returned from an API call is 1,000 records.

  • skip (Float) —

    If nonzero, skip this number of results before returning data. Used with &lt;code&gt;$top&lt;/code&gt; to provide pagination for large datasets.

  • count (Boolean) —

    When set to true, the count of the collection is also returned in the response body.

  • count_only (Boolean) —

    When set to true, only the count of the collection is returned

Returns:

  • (Array<(MandatesResponse, Integer, Hash)>) —

    MandatesResponse data, response status code and response headers



250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'lib/avalara_sdk/api/EInvoicing/V1/mandates_api.rb', line 250

def get_mandates_with_http_info(request_parameters)
  # OAuth2 Scopes
  required_scopes = ''
  # Request Parameters
  avalara_version = request_parameters.get_avalara_version()
  x_avalara_client = request_parameters.get_x_avalara_client()
  filter = request_parameters.get_filter()
  top = request_parameters.get_top()
  skip = request_parameters.get_skip()
  count = request_parameters.get_count()
  count_only = request_parameters.get_count_only()
  # verify the required parameter 'avalara_version' is set
  if @api_client.config.client_side_validation && avalara_version.nil?
    fail ArgumentError, "Missing the required parameter 'avalara_version' when calling MandatesApi.get_mandates"
  end
  # resource path
  local_var_path = '/einvoicing/mandates'

  # query parameters
  query_params = {}
  if !filter.nil?
    query_params[:'$filter'] = filter
  end
  if !top.nil?
    query_params[:'$top'] = top
  end
  if !skip.nil?
    query_params[:'$skip'] = skip
  end
  if !count.nil?
    query_params[:'$count'] = count
  end
  if !count_only.nil?
    query_params[:'$countOnly'] = count_only
  end

  # header parameters
  header_params = {}
  header_params[:'avalara-version'] = '1.0'
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  if !avalara_version.nil?
    header_params[:'avalara-version'] = avalara_version
  end
  if !x_avalara_client.nil?
    header_params[:'X-Avalara-Client'] = x_avalara_client
  end

  # form parameters
  form_params = {}

  # http body (model)
  post_body = {}

  # return_type
  return_type = 'MandatesResponse'

  # auth_names
  auth_names = ['Bearer']

  @api_client.apply_auth_to_request!(header_params, auth_names, required_scopes)

  new_options = {
    :operation => :"MandatesApi.get_mandates",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  }

  response = @api_client.call_api(:GET, local_var_path, new_options, required_scopes)
  if new_options[:return_type]
    data = deserialize(response, new_options[:return_type])
  else
    data = nil
  end
  return data, response.code, response.headers
end

#json_mime?(mime) ⇒ Boolean

JSON MIME examples:

application/json
application/json; charset=UTF8
APPLICATION/JSON
*/*

Parameters:

  • mime (String) —

    MIME

Returns:

  • (Boolean) —

    True if the MIME is application/json



33
34
35
 
# File 'lib/avalara_sdk/api/EInvoicing/V1/mandates_api.rb', line 33

def json_mime?(mime)
  (mime == '*/*') || !(mime =~ /Application\/.*json(?!p)(;.*)?/i).nil?
end

#object_to_hash(obj) ⇒ String

Convert object(non-array) to hash.

Parameters:

  • obj (Object) —

    object to be converted into JSON string

Returns:

  • (String) —

    JSON string representation of the object



202
203
204
205
206
207
208
 
# File 'lib/avalara_sdk/api/EInvoicing/V1/mandates_api.rb', line 202

def object_to_hash(obj)
  if obj.respond_to?(:to_hash)
    obj.to_hash
  else
    obj
  end
end

#object_to_http_body(model) ⇒ String

Convert object (array, hash, object, etc) to JSON string.

Parameters:

  • model (Object) —

    object to be converted into JSON string

Returns:

  • (String) —

    JSON string representation of the object



188
189
190
191
192
193
194
195
196
197
 
# File 'lib/avalara_sdk/api/EInvoicing/V1/mandates_api.rb', line 188

def object_to_http_body(model)
  return model if model.nil? || model.is_a?(String)
  local_body = nil
  if model.is_a?(Array)
    local_body = model.map { |m| object_to_hash(m) }
  else
    local_body = object_to_hash(model)
  end
  local_body.to_json
end

#sanitize_filename(filename) ⇒ String

Sanitize filename by removing path. e.g. ../../sun.gif becomes sun.gif

Parameters:

  • filename (String) —

    the filename to be sanitized

Returns:

  • (String) —

    the sanitized filename



135
136
137
 
# File 'lib/avalara_sdk/api/EInvoicing/V1/mandates_api.rb', line 135

def sanitize_filename(filename)
  filename.gsub(/.*[\/\\]/, '')
end

#select_header_accept(accepts) ⇒ String

Return Accept header based on an array of accepts provided.

Parameters:

  • accepts (Array) —

    array for Accept

Returns:

  • (String) —

    the Accept header (e.g. application/json)



167
168
169
170
171
172
 
# File 'lib/avalara_sdk/api/EInvoicing/V1/mandates_api.rb', line 167

def select_header_accept(accepts)
  return nil if accepts.nil? || accepts.empty?
  # use JSON when present, otherwise use all of the provided
  json_accept = accepts.find { |s| json_mime?(s) }
  json_accept || accepts.join(',')
end

#select_header_content_type(content_types) ⇒ String

Return Content-Type header based on an array of content types provided.

Parameters:

  • content_types (Array) —

    array for Content-Type

Returns:

  • (String) —

    the Content-Type header (e.g. application/json)



177
178
179
180
181
182
183
 
# File 'lib/avalara_sdk/api/EInvoicing/V1/mandates_api.rb', line 177

def select_header_content_type(content_types)
  # return nil by default
  return if content_types.nil? || content_types.empty?
  # use JSON when present, otherwise use the first one
  json_content_type = content_types.find { |s| json_mime?(s) }
  json_content_type || content_types.first
end

#update_params_for_auth!(header_params, query_params, auth_names) ⇒ Object

Update header and query params based on authentication settings.

Parameters:

  • header_params (Hash) —

    Header parameters

  • query_params (Hash) —

    Query parameters

  • auth_names (String) —

    Authentication scheme name



144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/avalara_sdk/api/EInvoicing/V1/mandates_api.rb', line 144

def update_params_for_auth!(header_params, query_params, auth_names)
  Array(auth_names).each do |auth_name|
    auth_setting = @config.auth_settings[auth_name]
    next unless auth_setting
    case auth_setting[:in]
    when 'header' then header_params[auth_setting[:key]] = auth_setting[:value]
    when 'query'  then query_params[auth_setting[:key]] = auth_setting[:value]
    else fail ArgumentError, 'Authentication token must be in `query` or `header`'
    end
  end
end

#user_agent=(user_agent) ⇒ Object

Sets user agent in HTTP header

Parameters:

  • user_agent (String) —

    User agent (e.g. openapi-generator/ruby/1.0.0)



159
160
161
162
 
# File 'lib/avalara_sdk/api/EInvoicing/V1/mandates_api.rb', line 159

def user_agent=(user_agent)
  @user_agent = user_agent
  @default_headers['User-Agent'] = @user_agent
end