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("25.11.0")
  @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) ⇒ BatchSearchParticipants202Response

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

Parameters:

  • avalara_version (String) —

    The HTTP Header meant to specify the version of the API intended to be used. # @param name [String] A <b>human-readable</b> name for the batch search. # @param notification_email [String] The email address to which a notification will be sent once the batch search is complete. # @param file [File] CSV file containing search parameters. Input Constraints: - Maximum file size: 1 MB - File Header: Must be less than 500 KB - Total number of lines (including header): Must be 101 or fewer # @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:



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

def batch_search_participants(request_parameters)
  data, _status_code, _headers = batch_search_participants_with_http_info(request_parameters)
  data
end

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

Returns BatchSearchParticipants202Response 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.

  • name (String) —

    A &lt;b&gt;human-readable&lt;/b&gt; name for the batch search.

  • notification_email (String) —

    The email address to which a notification will be sent once the batch search is complete.

  • file (File) —

    CSV file containing search parameters. Input Constraints: - Maximum file size: 1 MB - File Header: Must be less than 500 KB - Total number of lines (including header): Must be 101 or fewer

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



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 = 'BatchSearchParticipants202Response'

  # 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, false, :EInvoicing)
  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

#create_trading_partner(request_parameters) ⇒ CreateTradingPartner201Response

Creates a new trading partner. This endpoint creates a new trading partner with the provided details. The request body must include the necessary information as defined in the ‘TradingPartner` schema.

Parameters:

  • avalara_version (String) —

    The HTTP Header meant to specify the version of the API intended to be used. # @param trading_partner [TradingPartner] # @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:



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

def create_trading_partner(request_parameters)
  data, _status_code, _headers = create_trading_partner_with_http_info(request_parameters)
  data
end

#create_trading_partner_with_http_info(request_parameters) ⇒ Array<(CreateTradingPartner201Response, Integer, Hash)>

Returns CreateTradingPartner201Response 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.

  • trading_partner (TradingPartner)
  • 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:



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
425
426
427
428
429
 
# File 'lib/avalara_sdk/api/EInvoicing/V1/trading_partners_api.rb', line 357

def create_trading_partner_with_http_info(request_parameters)
  # OAuth2 Scopes

  required_scopes = ''
  # Request Parameters

  avalara_version = request_parameters.get_avalara_version()
  trading_partner = request_parameters.get_trading_partner()
  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.create_trading_partner"
  end
  # verify the required parameter 'trading_partner' is set

  if @api_client.config.client_side_validation && trading_partner.nil?
    fail ArgumentError, "Missing the required parameter 'trading_partner' when calling TradingPartnersApi.create_trading_partner"
  end
  # resource path

  local_var_path = '/einvoicing/trading-partners'

  # query parameters

  query_params = {}

  # 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(['application/json'])
  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 = {}

  # http body (model)

  post_body =  @api_client.object_to_http_body(trading_partner) || {}

  # return_type

  return_type = 'CreateTradingPartner201Response'

  # auth_names

  auth_names = ['Bearer']

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

  new_options = {
    :operation => :"TradingPartnersApi.create_trading_partner",
    :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, false, :EInvoicing)
  if new_options[:return_type]
    data = deserialize(response, new_options[:return_type])
  else
    data = nil
  end
  return data, response.code, response.headers
end

#create_trading_partners_batch(request_parameters) ⇒ CreateTradingPartnersBatch200Response

Creates a batch of multiple trading partners. This endpoint creates multiple trading partners in a single batch request. It accepts an array of trading partners and processes them synchronously. Supports a maximum of 100 records or 1 MB request payload. The batch is processed atomically and partial success is not allowed.

Parameters:

  • avalara_version (String) —

    The HTTP Header meant to specify the version of the API intended to be used. # @param create_trading_partners_batch_request [CreateTradingPartnersBatchRequest] # @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:



435
436
437
438
 
# File 'lib/avalara_sdk/api/EInvoicing/V1/trading_partners_api.rb', line 435

def create_trading_partners_batch(request_parameters)
  data, _status_code, _headers = create_trading_partners_batch_with_http_info(request_parameters)
  data
end

#create_trading_partners_batch_with_http_info(request_parameters) ⇒ Array<(CreateTradingPartnersBatch200Response, Integer, Hash)>

Returns CreateTradingPartnersBatch200Response 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.

  • create_trading_partners_batch_request (CreateTradingPartnersBatchRequest)
  • 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:



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
511
512
513
514
515
516
517
518
519
520
 
# File 'lib/avalara_sdk/api/EInvoicing/V1/trading_partners_api.rb', line 448

def create_trading_partners_batch_with_http_info(request_parameters)
  # OAuth2 Scopes

  required_scopes = ''
  # Request Parameters

  avalara_version = request_parameters.get_avalara_version()
  create_trading_partners_batch_request = request_parameters.get_create_trading_partners_batch_request()
  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.create_trading_partners_batch"
  end
  # verify the required parameter 'create_trading_partners_batch_request' is set

  if @api_client.config.client_side_validation && create_trading_partners_batch_request.nil?
    fail ArgumentError, "Missing the required parameter 'create_trading_partners_batch_request' when calling TradingPartnersApi.create_trading_partners_batch"
  end
  # resource path

  local_var_path = '/einvoicing/trading-partners/batch'

  # query parameters

  query_params = {}

  # 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(['application/json'])
  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 = {}

  # http body (model)

  post_body =  @api_client.object_to_http_body(create_trading_partners_batch_request) || {}

  # return_type

  return_type = 'CreateTradingPartnersBatch200Response'

  # auth_names

  auth_names = ['Bearer']

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

  new_options = {
    :operation => :"TradingPartnersApi.create_trading_partners_batch",
    :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, false, :EInvoicing)
  if new_options[:return_type]
    data = deserialize(response, new_options[:return_type])
  else
    data = nil
  end
  return data, response.code, response.headers
end

#delete_trading_partner(request_parameters) ⇒ nil

Deletes a trading partner using ID. This endpoint deletes an existing trading partner identified by the provided 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 trading partner which is being deleted. # @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:

  • (nil) 


526
527
528
529
 
# File 'lib/avalara_sdk/api/EInvoicing/V1/trading_partners_api.rb', line 526

def delete_trading_partner(request_parameters)
  delete_trading_partner_with_http_info(request_parameters)
  nil
end

#delete_trading_partner_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.

  • id (String) —

    The ID of the trading partner which is being deleted.

  • 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



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

def delete_trading_partner_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.delete_trading_partner"
  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.delete_trading_partner"
  end
  # resource path

  local_var_path = '/einvoicing/trading-partners/{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 = ''

  # auth_names

  auth_names = ['Bearer']

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

  new_options = {
    :operation => :"TradingPartnersApi.delete_trading_partner",
    :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(:DELETE, local_var_path, new_options, required_scopes, false, :EInvoicing)
  if new_options[:return_type]
    data = deserialize(response, new_options[:return_type])
  else
    data = nil
  end
  return data, response.code, response.headers
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

Downloads batch search results in a csv file. This endpoint downloads the report for a specific batch search using the batch search ID. It returns a CSV file containing up to 1,000 query results.

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 for which the report should 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) 


612
613
614
615
 
# File 'lib/avalara_sdk/api/EInvoicing/V1/trading_partners_api.rb', line 612

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 for which the report should 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



625
626
627
628
629
630
631
632
633
634
635
636
637
638
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
 
# File 'lib/avalara_sdk/api/EInvoicing/V1/trading_partners_api.rb', line 625

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, false, :EInvoicing)
  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

Returns the batch search details using ID. This endpoint returns detailed information for a specific batch search using the provided ID. It is useful for tracking the status and progress of a previously initiated batch search operation.

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:



698
699
700
701
 
# File 'lib/avalara_sdk/api/EInvoicing/V1/trading_partners_api.rb', line 698

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



711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
 
# File 'lib/avalara_sdk/api/EInvoicing/V1/trading_partners_api.rb', line 711

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, false, :EInvoicing)
  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

Lists all batch searches that were previously submitted. This endpoint retrieves a list of all batch search operations that have been previously submitted. It returns details such as the batch search ID, status, creation date, and associated metadata. It is useful for tracking the progress of a previously initiated batch search operations.

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] Filters the results by field name. Only the &lt;code&gt;eq&lt;/code&gt; operator and the name field is supported. For more information, refer to [AvaTax filtering guide](developer.avalara.com/avatax/filtering-in-rest/). # @param count [Boolean] When set to &lt;code&gt;true&lt;/code&gt;, returns the total count of matching records included as &lt;code&gt;@recordSetCount&lt;/code&gt; in the response body. # @param top [Integer] The number of items to include in the result. # @param skip [Integer] The number of items to skip in the result. # @param order_by [String] The &lt;code&gt;$orderBy&lt;/code&gt; 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:



784
785
786
787
 
# File 'lib/avalara_sdk/api/EInvoicing/V1/trading_partners_api.rb', line 784

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

    Filters the results by field name. Only the &lt;code&gt;eq&lt;/code&gt; operator and the name field is supported. For more information, refer to [AvaTax filtering guide](developer.avalara.com/avatax/filtering-in-rest/).

  • count (Boolean) —

    When set to &lt;code&gt;true&lt;/code&gt;, returns the total count of matching records included as &lt;code&gt;@recordSetCount&lt;/code&gt; in the response body.

  • top (Integer) —

    The number of items to include in the result.

  • skip (Integer) —

    The number of items to skip in the result.

  • order_by (String) —

    The &lt;code&gt;$orderBy&lt;/code&gt; 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



801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
 
# File 'lib/avalara_sdk/api/EInvoicing/V1/trading_partners_api.rb', line 801

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, false, :EInvoicing)
  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) ⇒ SearchParticipants200Response

Returns a list of participants matching the input query. This endpoint retrieves a list of trading partners that match the specified search criteria. It supports filtering, search text, and other relevant query parameters to narrow down the results.

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 &lt;code&gt;AND&lt;/code&gt; / &lt;code&gt;OR&lt;/code&gt; operators. Search is performed only over the name and identifier value fields. For more information, refer to [Query options overview - OData.](learn.microsoft.com/en-us/odata/concepts/queryoptions-overview#search). # @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 &lt;code&gt;true&lt;/code&gt;, returns the total count of matching records included as &lt;code&gt;@recordSetCount&lt;/code&gt; in the response body. # @param filter [String] Filters the results using the &lt;code&gt;eq&lt;/code&gt; operator. Supported fields: &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;. For more information, refer to [AvaTax filtering guide](developer.avalara.com/avatax/filtering-in-rest/). # @param top [Integer] The number of items to include in the result. # @param skip [Integer] The number of items to skip in the result. # @param order_by [String] The &lt;code&gt;$orderBy&lt;/code&gt; 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:



889
890
891
892
 
# File 'lib/avalara_sdk/api/EInvoicing/V1/trading_partners_api.rb', line 889

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<(SearchParticipants200Response, Integer, Hash)>

Returns SearchParticipants200Response 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 &lt;code&gt;AND&lt;/code&gt; / &lt;code&gt;OR&lt;/code&gt; operators. Search is performed only over the name and identifier value fields. For more information, refer to [Query options overview - OData.](learn.microsoft.com/en-us/odata/concepts/queryoptions-overview#search).

  • 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 &lt;code&gt;true&lt;/code&gt;, returns the total count of matching records included as &lt;code&gt;@recordSetCount&lt;/code&gt; in the response body.

  • filter (String) —

    Filters the results using the &lt;code&gt;eq&lt;/code&gt; operator. Supported fields: &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;. For more information, refer to [AvaTax filtering guide](developer.avalara.com/avatax/filtering-in-rest/).

  • top (Integer) —

    The number of items to include in the result.

  • skip (Integer) —

    The number of items to skip in the result.

  • order_by (String) —

    The &lt;code&gt;$orderBy&lt;/code&gt; 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:



907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
 
# File 'lib/avalara_sdk/api/EInvoicing/V1/trading_partners_api.rb', line 907

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 = 'SearchParticipants200Response'

  # 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, false, :EInvoicing)
  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

#update_trading_partner(request_parameters) ⇒ UpdateTradingPartner200Response

Updates a trading partner using ID. This endpoint updates the details of an existing trading partner specified by the provided ID. It performs a full update, and the request body must include all required fields.

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 trading partner which is being updated. # @param trading_partner [TradingPartner] # @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:



1003
1004
1005
1006
 
# File 'lib/avalara_sdk/api/EInvoicing/V1/trading_partners_api.rb', line 1003

def update_trading_partner(request_parameters)
  data, _status_code, _headers = update_trading_partner_with_http_info(request_parameters)
  data
end

#update_trading_partner_with_http_info(request_parameters) ⇒ Array<(UpdateTradingPartner200Response, Integer, Hash)>

Returns UpdateTradingPartner200Response 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 trading partner which is being updated.

  • trading_partner (TradingPartner)
  • 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:



1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
 
# File 'lib/avalara_sdk/api/EInvoicing/V1/trading_partners_api.rb', line 1017

def update_trading_partner_with_http_info(request_parameters)
  # OAuth2 Scopes

  required_scopes = ''
  # Request Parameters

  avalara_version = request_parameters.get_avalara_version()
  id = request_parameters.get_id()
  trading_partner = request_parameters.get_trading_partner()
  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.update_trading_partner"
  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.update_trading_partner"
  end
  # verify the required parameter 'trading_partner' is set

  if @api_client.config.client_side_validation && trading_partner.nil?
    fail ArgumentError, "Missing the required parameter 'trading_partner' when calling TradingPartnersApi.update_trading_partner"
  end
  # resource path

  local_var_path = '/einvoicing/trading-partners/{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'])
  # HTTP header 'Content-Type'

  content_type = @api_client.select_header_content_type(['application/json'])
  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 = {}

  # http body (model)

  post_body =  @api_client.object_to_http_body(trading_partner) || {}

  # return_type

  return_type = 'UpdateTradingPartner200Response'

  # auth_names

  auth_names = ['Bearer']

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

  new_options = {
    :operation => :"TradingPartnersApi.update_trading_partner",
    :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(:PUT, local_var_path, new_options, required_scopes, false, :EInvoicing)
  if new_options[:return_type]
    data = deserialize(response, new_options[:return_type])
  else
    data = nil
  end
  return data, response.code, response.headers
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