Class: AvalaraSdk::EInvoicing::V1::TradingPartnersApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client) ⇒ TradingPartnersApi

Returns a new instance of TradingPartnersApi.



16
17
18
19
20
21
22
 
# File 'lib/avalara_sdk/api/EInvoicing/V1/trading_partners_api.rb', line 16

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



14
15
16
 
# File 'lib/avalara_sdk/api/EInvoicing/V1/trading_partners_api.rb', line 14

def api_client
  @api_client
end

Instance Method Details

#batch_search_participants(request_parameters) ⇒ nil

Creates a batch search and performs a batch search in the directory for participants in the background. Handles batch search requests by uploading a file containing search parameters.

Parameters:

  • avalara_version (String) —

    The HTTP Header meant to specify the version of the API intended to be used # @param name [String] The human readable name given to this batch search. # @param notification_email [String] The email address of the user to whom the batch search completion notification must go to. # @param file [File] CSV file containing search parameters. # @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 "Fingerprint" # @param x_correlation_id [String] The caller can use this as an identifier to use as a correlation id to trace the call.

Returns:

  • (nil) 


232
233
234
235
 
# File 'lib/avalara_sdk/api/EInvoicing/V1/trading_partners_api.rb', line 232

def batch_search_participants(request_parameters)
  batch_search_participants_with_http_info(request_parameters)
  nil
end

#batch_search_participants_with_http_info(request_parameters) ⇒ Array<(nil, Integer, Hash)>

Returns nil, 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

  • name (String) —

    The human readable name given to this batch search.

  • notification_email (String) —

    The email address of the user to whom the batch search completion notification must go to.

  • file (File) —

    CSV file containing search parameters.

  • 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;

  • x_correlation_id (String) —

    The caller can use this as an identifier to use as a correlation id to trace the call.

Returns:

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

    nil, response status code and response headers



247
248
249
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
330
331
332
333
334
335
336
337
338
 
# File 'lib/avalara_sdk/api/EInvoicing/V1/trading_partners_api.rb', line 247

def batch_search_participants_with_http_info(request_parameters)
  # OAuth2 Scopes
  required_scopes = ''
  # Request Parameters
  avalara_version = request_parameters.get_avalara_version()
  name = request_parameters.get_name()
  notification_email = request_parameters.get_notification_email()
  file = request_parameters.get_file()
  x_avalara_client = request_parameters.get_x_avalara_client()
  x_correlation_id = request_parameters.get_x_correlation_id()
  # 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 TradingPartnersApi.batch_search_participants"
  end
  # verify the required parameter 'name' is set
  if @api_client.config.client_side_validation && name.nil?
    fail ArgumentError, "Missing the required parameter 'name' when calling TradingPartnersApi.batch_search_participants"
  end
  # verify the required parameter 'notification_email' is set
  if @api_client.config.client_side_validation && notification_email.nil?
    fail ArgumentError, "Missing the required parameter 'notification_email' when calling TradingPartnersApi.batch_search_participants"
  end
  # verify the required parameter 'file' is set
  if @api_client.config.client_side_validation && file.nil?
    fail ArgumentError, "Missing the required parameter 'file' when calling TradingPartnersApi.batch_search_participants"
  end
  # resource path
  local_var_path = '/einvoicing/trading-partners/batch-searches'

  # query parameters
  query_params = {}
  if !name.nil?
    query_params[:'name'] = name
  end
  if !notification_email.nil?
    query_params[:'notificationEmail'] = notification_email
  end

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['multipart/form-data'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end
  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
  if !x_correlation_id.nil?
    header_params[:'X-Correlation-ID'] = x_correlation_id
  end

  # form parameters
  form_params = {}
  if !file.nil?
    form_params['file'] = file
  end

  # http body (model)
  post_body = {}

  # return_type
  return_type = ''

  # auth_names
  auth_names = ['Bearer']

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

  new_options = {
    :operation => :"TradingPartnersApi.batch_search_participants",
    :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(:POST, 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

#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



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

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



91
92
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
 
# File 'lib/avalara_sdk/api/EInvoicing/V1/trading_partners_api.rb', line 91

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>”



39
40
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
 
# File 'lib/avalara_sdk/api/EInvoicing/V1/trading_partners_api.rb', line 39

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

#download_batch_search_report(request_parameters) ⇒ File

Download batch search results in a csv file. Downloads the report for a specific batch search using the batch search ID.

Parameters:

  • avalara_version (String) —

    The HTTP Header meant to specify the version of the API intended to be used # @param id [String] The ID of the batch search whose report is to be downloaded. # @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 x_correlation_id [String] The caller can use this as an identifier to use as a correlation id to trace the call.

Returns:

  • (File) 


344
345
346
347
 
# File 'lib/avalara_sdk/api/EInvoicing/V1/trading_partners_api.rb', line 344

def download_batch_search_report(request_parameters)
  data, _status_code, _headers = download_batch_search_report_with_http_info(request_parameters)
  data
end

#download_batch_search_report_with_http_info(request_parameters) ⇒ Array<(File, Integer, Hash)>

Returns File 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

  • id (String) —

    The ID of the batch search whose report is to be downloaded.

  • 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;

  • x_correlation_id (String) —

    The caller can use this as an identifier to use as a correlation id to trace the call.

Returns:

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

    File data, response status code and response headers



357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
 
# File 'lib/avalara_sdk/api/EInvoicing/V1/trading_partners_api.rb', line 357

def download_batch_search_report_with_http_info(request_parameters)
  # OAuth2 Scopes
  required_scopes = ''
  # Request Parameters
  avalara_version = request_parameters.get_avalara_version()
  id = request_parameters.get_id()
  x_avalara_client = request_parameters.get_x_avalara_client()
  x_correlation_id = request_parameters.get_x_correlation_id()
  # 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 TradingPartnersApi.download_batch_search_report"
  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 TradingPartnersApi.download_batch_search_report"
  end
  # resource path
  local_var_path = '/einvoicing/trading-partners/batch-searches/{id}/$download-results'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['text/csv', '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
  if !x_correlation_id.nil?
    header_params[:'X-Correlation-ID'] = x_correlation_id
  end

  # form parameters
  form_params = {}

  # http body (model)
  post_body = {}

  # return_type
  return_type = 'File'

  # auth_names
  auth_names = ['Bearer']

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

  new_options = {
    :operation => :"TradingPartnersApi.download_batch_search_report",
    :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

#get_batch_search_detail(request_parameters) ⇒ BatchSearch

Get the batch search details for a given id. Get the batch search details for a given id.

Parameters:

  • avalara_version (String) —

    The HTTP Header meant to specify the version of the API intended to be used # @param id [String] The ID of the batch search that was submitted earlier. # @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 x_correlation_id [String] The caller can use this as an identifier to use as a correlation id to trace the call.

Returns:



430
431
432
433
 
# File 'lib/avalara_sdk/api/EInvoicing/V1/trading_partners_api.rb', line 430

def get_batch_search_detail(request_parameters)
  data, _status_code, _headers = get_batch_search_detail_with_http_info(request_parameters)
  data
end

#get_batch_search_detail_with_http_info(request_parameters) ⇒ Array<(BatchSearch, Integer, Hash)>

Returns BatchSearch 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

  • id (String) —

    The ID of the batch search that was submitted earlier.

  • 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;

  • x_correlation_id (String) —

    The caller can use this as an identifier to use as a correlation id to trace the call.

Returns:

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

    BatchSearch data, response status code and response headers



443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
 
# File 'lib/avalara_sdk/api/EInvoicing/V1/trading_partners_api.rb', line 443

def get_batch_search_detail_with_http_info(request_parameters)
  # OAuth2 Scopes
  required_scopes = ''
  # Request Parameters
  avalara_version = request_parameters.get_avalara_version()
  id = request_parameters.get_id()
  x_avalara_client = request_parameters.get_x_avalara_client()
  x_correlation_id = request_parameters.get_x_correlation_id()
  # 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 TradingPartnersApi.get_batch_search_detail"
  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 TradingPartnersApi.get_batch_search_detail"
  end
  # resource path
  local_var_path = '/einvoicing/trading-partners/batch-searches/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # 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
  if !x_correlation_id.nil?
    header_params[:'X-Correlation-ID'] = x_correlation_id
  end

  # form parameters
  form_params = {}

  # http body (model)
  post_body = {}

  # return_type
  return_type = 'BatchSearch'

  # auth_names
  auth_names = ['Bearer']

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

  new_options = {
    :operation => :"TradingPartnersApi.get_batch_search_detail",
    :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



31
32
33
 
# File 'lib/avalara_sdk/api/EInvoicing/V1/trading_partners_api.rb', line 31

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

#list_batch_searches(request_parameters) ⇒ BatchSearchListResponse

List all batch searches that were previously submitted. Retrieves all batch searches performed by the user.

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; .The parameters supported is &lt;code&gt;name&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. Filtering will be done over the provided parameters. # @param count [Boolean] When set to true, the count of the collection is included as @recordSetCount in the response body. # @param top [String] 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 200 records. # @param skip [String] 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 order_by [String] The $orderBy query parameter specifies the field and sorting direction for ordering the result set. The value is a string that combines a field name and a sorting direction (asc for ascending or desc for descending), separated by a space. # @param x_correlation_id [String] The caller can use this as an identifier to use as a correlation id to trace the call.

Returns:



516
517
518
519
 
# File 'lib/avalara_sdk/api/EInvoicing/V1/trading_partners_api.rb', line 516

def list_batch_searches(request_parameters)
  data, _status_code, _headers = list_batch_searches_with_http_info(request_parameters)
  data
end

#list_batch_searches_with_http_info(request_parameters) ⇒ Array<(BatchSearchListResponse, Integer, Hash)>

Returns BatchSearchListResponse 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; .The parameters supported is &lt;code&gt;name&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. Filtering will be done over the provided parameters.

  • count (Boolean) —

    When set to true, the count of the collection is included as @recordSetCount in the response body.

  • top (String) —

    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 200 records.

  • skip (String) —

    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.

  • order_by (String) —

    The $orderBy query parameter specifies the field and sorting direction for ordering the result set. The value is a string that combines a field name and a sorting direction (asc for ascending or desc for descending), separated by a space.

  • x_correlation_id (String) —

    The caller can use this as an identifier to use as a correlation id to trace the call.

Returns:

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

    BatchSearchListResponse data, response status code and response headers



533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
 
# File 'lib/avalara_sdk/api/EInvoicing/V1/trading_partners_api.rb', line 533

def list_batch_searches_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()
  count = request_parameters.get_count()
  top = request_parameters.get_top()
  skip = request_parameters.get_skip()
  order_by = request_parameters.get_order_by()
  x_correlation_id = request_parameters.get_x_correlation_id()
  # 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 TradingPartnersApi.list_batch_searches"
  end
  # resource path
  local_var_path = '/einvoicing/trading-partners/batch-searches'

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

  # header parameters
  header_params = {}
  # 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
  if !x_correlation_id.nil?
    header_params[:'X-Correlation-ID'] = x_correlation_id
  end

  # form parameters
  form_params = {}

  # http body (model)
  post_body = {}

  # return_type
  return_type = 'BatchSearchListResponse'

  # auth_names
  auth_names = ['Bearer']

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

  new_options = {
    :operation => :"TradingPartnersApi.list_batch_searches",
    :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

#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



200
201
202
203
204
205
206
 
# File 'lib/avalara_sdk/api/EInvoicing/V1/trading_partners_api.rb', line 200

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



186
187
188
189
190
191
192
193
194
195
 
# File 'lib/avalara_sdk/api/EInvoicing/V1/trading_partners_api.rb', line 186

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



133
134
135
 
# File 'lib/avalara_sdk/api/EInvoicing/V1/trading_partners_api.rb', line 133

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

#search_participants(request_parameters) ⇒ DirectorySearchResponse

Returns a list of participants matching the input query. Returns a list of participants matching the input query.

Parameters:

  • avalara_version (String) —

    The HTTP Header meant to specify the version of the API intended to be used # @param search [String] Search by value supports logical AND and OR. Refer to [learn.microsoft.com/en-us/odata/concepts/queryoptions-overview#search](https://learn.microsoft.com/en-us/odata/concepts/queryoptions-overview#search) for more information on search. Search will be done over &lt;code&gt;name&lt;/code&gt; and &lt;code&gt;identifier&lt;/code&gt; parameters only. # @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 count [Boolean] When set to true, the count of the collection is included as @recordSetCount in the response body. # @param filter [String] Filter by field name and value. This filter only supports &lt;code&gt;eq&lt;/code&gt; .The parameters supported are &lt;code&gt;network&lt;/code&gt;, &lt;code&gt;country&lt;/code&gt;, &lt;code&gt;documentType&lt;/code&gt;, &lt;code&gt;idType&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. Filtering will be done over the provided parameters. # @param top [String] 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 200 records. # @param skip [String] 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 order_by [String] The $orderBy query parameter specifies the field and sorting direction for ordering the result set. The value is a string that combines a field name and a sorting direction (asc for ascending or desc for descending), separated by a space. # @param x_correlation_id [String] The caller can use this as an identifier to use as a correlation id to trace the call.

Returns:



621
622
623
624
 
# File 'lib/avalara_sdk/api/EInvoicing/V1/trading_partners_api.rb', line 621

def search_participants(request_parameters)
  data, _status_code, _headers = search_participants_with_http_info(request_parameters)
  data
end

#search_participants_with_http_info(request_parameters) ⇒ Array<(DirectorySearchResponse, Integer, Hash)>

Returns DirectorySearchResponse 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

  • search (String) —

    Search by value supports logical AND and OR. Refer to [learn.microsoft.com/en-us/odata/concepts/queryoptions-overview#search](https://learn.microsoft.com/en-us/odata/concepts/queryoptions-overview#search) for more information on search. Search will be done over &lt;code&gt;name&lt;/code&gt; and &lt;code&gt;identifier&lt;/code&gt; parameters only.

  • 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;

  • count (Boolean) —

    When set to true, the count of the collection is included as @recordSetCount in the response body.

  • filter (String) —

    Filter by field name and value. This filter only supports &lt;code&gt;eq&lt;/code&gt; .The parameters supported are &lt;code&gt;network&lt;/code&gt;, &lt;code&gt;country&lt;/code&gt;, &lt;code&gt;documentType&lt;/code&gt;, &lt;code&gt;idType&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. Filtering will be done over the provided parameters.

  • top (String) —

    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 200 records.

  • skip (String) —

    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.

  • order_by (String) —

    The $orderBy query parameter specifies the field and sorting direction for ordering the result set. The value is a string that combines a field name and a sorting direction (asc for ascending or desc for descending), separated by a space.

  • x_correlation_id (String) —

    The caller can use this as an identifier to use as a correlation id to trace the call.

Returns:

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

    DirectorySearchResponse data, response status code and response headers



639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
 
# File 'lib/avalara_sdk/api/EInvoicing/V1/trading_partners_api.rb', line 639

def search_participants_with_http_info(request_parameters)
  # OAuth2 Scopes
  required_scopes = ''
  # Request Parameters
  avalara_version = request_parameters.get_avalara_version()
  search = request_parameters.get_search()
  x_avalara_client = request_parameters.get_x_avalara_client()
  count = request_parameters.get_count()
  filter = request_parameters.get_filter()
  top = request_parameters.get_top()
  skip = request_parameters.get_skip()
  order_by = request_parameters.get_order_by()
  x_correlation_id = request_parameters.get_x_correlation_id()
  # 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 TradingPartnersApi.search_participants"
  end
  # verify the required parameter 'search' is set
  if @api_client.config.client_side_validation && search.nil?
    fail ArgumentError, "Missing the required parameter 'search' when calling TradingPartnersApi.search_participants"
  end
  # resource path
  local_var_path = '/einvoicing/trading-partners'

  # query parameters
  query_params = {}
  if !count.nil?
    query_params[:'count'] = count
  end
  if !search.nil?
    query_params[:'$search'] = search
  end
  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 !order_by.nil?
    query_params[:'$orderBy'] = order_by
  end

  # header parameters
  header_params = {}
  # 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
  if !x_correlation_id.nil?
    header_params[:'X-Correlation-ID'] = x_correlation_id
  end

  # form parameters
  form_params = {}

  # http body (model)
  post_body = {}

  # return_type
  return_type = 'DirectorySearchResponse'

  # auth_names
  auth_names = ['Bearer']

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

  new_options = {
    :operation => :"TradingPartnersApi.search_participants",
    :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

#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)



165
166
167
168
169
170
 
# File 'lib/avalara_sdk/api/EInvoicing/V1/trading_partners_api.rb', line 165

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)



175
176
177
178
179
180
181
 
# File 'lib/avalara_sdk/api/EInvoicing/V1/trading_partners_api.rb', line 175

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



142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/avalara_sdk/api/EInvoicing/V1/trading_partners_api.rb', line 142

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)



157
158
159
160
 
# File 'lib/avalara_sdk/api/EInvoicing/V1/trading_partners_api.rb', line 157

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