Class: AvalaraSdk::A1099::V2::FormsW9Api

Inherits:
Object
  • Object
show all
Defined in:
lib/avalara_sdk/api/A1099/V2/forms_w9_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client) ⇒ FormsW9Api

Returns a new instance of FormsW9Api.



16
17
18
19
20
21
22
 
# File 'lib/avalara_sdk/api/A1099/V2/forms_w9_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.8.3")
  @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/A1099/V2/forms_w9_api.rb', line 14

def api_client
  @api_client
end

Instance Method Details

#build_collection_param(param, collection_format) ⇒ Object

Build parameter value according to the given collection format.

Parameters:

  • collection_format (String) —

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



210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/avalara_sdk/api/A1099/V2/forms_w9_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/A1099/V2/forms_w9_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::A1099::V2.const_get(return_type)
    klass.respond_to?(:openapi_one_of) ? klass.build(data) : klass.build_from_hash(data)
  end
end

#create_and_send_w9_form_email(request_parameters) ⇒ CreateW9Form201Response

Create a minimal W9/W4/W8 form and sends the e-mail request Create a minimal W9/W4/W8 form and sends the e-mail request.

Parameters:

  • avalara_version (String) —

    API version # @param x_correlation_id [String] Unique correlation Id in a GUID format # @param x_avalara_client [String] Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](developer.avalara.com/avatax/client-headers/) . # @param create_and_send_w9_form_email_request [CreateAndSendW9FormEmailRequest] Form to be created

Returns:



232
233
234
235
 
# File 'lib/avalara_sdk/api/A1099/V2/forms_w9_api.rb', line 232

def create_and_send_w9_form_email(request_parameters)
  data, _status_code, _headers = create_and_send_w9_form_email_with_http_info(request_parameters)
  data
end

#create_and_send_w9_form_email_with_http_info(request_parameters) ⇒ Array<(CreateW9Form201Response, Integer, Hash)>

Returns CreateW9Form201Response data, response status code and response headers.

Parameters:

  • avalara_version (String) —

    API version

  • x_correlation_id (String) —

    Unique correlation Id in a GUID format

  • x_avalara_client (String) —

    Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](developer.avalara.com/avatax/client-headers/) .

  • create_and_send_w9_form_email_request (CreateAndSendW9FormEmailRequest) —

    Form to be created

Returns:

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

    CreateW9Form201Response data, response status code and response headers



245
246
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
 
# File 'lib/avalara_sdk/api/A1099/V2/forms_w9_api.rb', line 245

def create_and_send_w9_form_email_with_http_info(request_parameters)
  # OAuth2 Scopes
  required_scopes = ''
  # Request Parameters
  avalara_version = request_parameters.get_avalara_version()
  x_correlation_id = request_parameters.get_x_correlation_id()
  x_avalara_client = request_parameters.get_x_avalara_client()
  create_and_send_w9_form_email_request = request_parameters.get_create_and_send_w9_form_email_request()
  # 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 FormsW9Api.create_and_send_w9_form_email"
  end
  # resource path
  local_var_path = '/w9/forms/$create-and-send-email'

  # 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', 'text/json', '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_correlation_id.nil?
    header_params[:'X-Correlation-Id'] = x_correlation_id
  end
  if !x_avalara_client.nil?
    header_params[:'X-Avalara-Client'] = x_avalara_client
  end

  # form parameters
  form_params = {}

  # http body (model)
  post_body =  @api_client.object_to_http_body(create_and_send_w9_form_email_request) || {}

  # return_type
  return_type = 'CreateW9Form201Response'

  # auth_names
  auth_names = ['bearer']

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

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

#create_w9_form(request_parameters) ⇒ CreateW9Form201Response

Create a W9/W4/W8 form Create a W9/W4/W8 form.

Parameters:

  • avalara_version (String) —

    API version # @param x_correlation_id [String] Unique correlation Id in a GUID format # @param x_avalara_client [String] Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](developer.avalara.com/avatax/client-headers/) . # @param create_w9_form_request [CreateW9FormRequest] Form to be created

Returns:



319
320
321
322
 
# File 'lib/avalara_sdk/api/A1099/V2/forms_w9_api.rb', line 319

def create_w9_form(request_parameters)
  data, _status_code, _headers = create_w9_form_with_http_info(request_parameters)
  data
end

#create_w9_form_with_http_info(request_parameters) ⇒ Array<(CreateW9Form201Response, Integer, Hash)>

Returns CreateW9Form201Response data, response status code and response headers.

Parameters:

  • avalara_version (String) —

    API version

  • x_correlation_id (String) —

    Unique correlation Id in a GUID format

  • x_avalara_client (String) —

    Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](developer.avalara.com/avatax/client-headers/) .

  • create_w9_form_request (CreateW9FormRequest) —

    Form to be created

Returns:

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

    CreateW9Form201Response data, response status code and response headers



332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
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
 
# File 'lib/avalara_sdk/api/A1099/V2/forms_w9_api.rb', line 332

def create_w9_form_with_http_info(request_parameters)
  # OAuth2 Scopes
  required_scopes = ''
  # Request Parameters
  avalara_version = request_parameters.get_avalara_version()
  x_correlation_id = request_parameters.get_x_correlation_id()
  x_avalara_client = request_parameters.get_x_avalara_client()
  create_w9_form_request = request_parameters.get_create_w9_form_request()
  # 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 FormsW9Api.create_w9_form"
  end
  # resource path
  local_var_path = '/w9/forms'

  # 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', 'text/json', '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_correlation_id.nil?
    header_params[:'X-Correlation-Id'] = x_correlation_id
  end
  if !x_avalara_client.nil?
    header_params[:'X-Avalara-Client'] = x_avalara_client
  end

  # form parameters
  form_params = {}

  # http body (model)
  post_body =  @api_client.object_to_http_body(create_w9_form_request) || {}

  # return_type
  return_type = 'CreateW9Form201Response'

  # auth_names
  auth_names = ['bearer']

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

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

#delete_w9_form(request_parameters) ⇒ nil

Delete a W9/W4/W8 form Delete a W9/W4/W8 form.

Parameters:

  • id (String) —

    ID of the form to delete # @param avalara_version [String] API version # @param x_correlation_id [String] Unique correlation Id in a GUID format # @param x_avalara_client [String] Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](developer.avalara.com/avatax/client-headers/) .

Returns:

  • (nil) 


406
407
408
409
 
# File 'lib/avalara_sdk/api/A1099/V2/forms_w9_api.rb', line 406

def delete_w9_form(request_parameters)
  delete_w9_form_with_http_info(request_parameters)
  nil
end

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

Returns nil, response status code and response headers.

Parameters:

  • id (String) —

    ID of the form to delete

  • avalara_version (String) —

    API version

  • x_correlation_id (String) —

    Unique correlation Id in a GUID format

  • x_avalara_client (String) —

    Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](developer.avalara.com/avatax/client-headers/) .

Returns:

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

    nil, response status code and response headers



419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
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
 
# File 'lib/avalara_sdk/api/A1099/V2/forms_w9_api.rb', line 419

def delete_w9_form_with_http_info(request_parameters)
  # OAuth2 Scopes
  required_scopes = ''
  # Request Parameters
  id = request_parameters.get_id()
  avalara_version = request_parameters.get_avalara_version()
  x_correlation_id = request_parameters.get_x_correlation_id()
  x_avalara_client = request_parameters.get_x_avalara_client()
  # 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 FormsW9Api.delete_w9_form"
  end
  # 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 FormsW9Api.delete_w9_form"
  end
  # resource path
  local_var_path = '/w9/forms/{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_correlation_id.nil?
    header_params[:'X-Correlation-Id'] = x_correlation_id
  end
  if !x_avalara_client.nil?
    header_params[:'X-Avalara-Client'] = x_avalara_client
  end

  # form parameters
  form_params = {}

  # http body (model)
  post_body = {}

  # return_type
  return_type = ''

  # auth_names
  auth_names = ['bearer']

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

  new_options = {
    :operation => :"FormsW9Api.delete_w9_form",
    :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, :A1099)
  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/A1099/V2/forms_w9_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

#get_w9_form(request_parameters) ⇒ CreateW9Form201Response

Retrieve a W9/W4/W8 form Retrieve a W9/W4/W8 form.

Parameters:

  • id (String) —

    ID of the form # @param avalara_version [String] API version # @param x_correlation_id [String] Unique correlation Id in a GUID format # @param x_avalara_client [String] Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](developer.avalara.com/avatax/client-headers/) .

Returns:



492
493
494
495
 
# File 'lib/avalara_sdk/api/A1099/V2/forms_w9_api.rb', line 492

def get_w9_form(request_parameters)
  data, _status_code, _headers = get_w9_form_with_http_info(request_parameters)
  data
end

#get_w9_form_with_http_info(request_parameters) ⇒ Array<(CreateW9Form201Response, Integer, Hash)>

Returns CreateW9Form201Response data, response status code and response headers.

Parameters:

  • id (String) —

    ID of the form

  • avalara_version (String) —

    API version

  • x_correlation_id (String) —

    Unique correlation Id in a GUID format

  • x_avalara_client (String) —

    Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](developer.avalara.com/avatax/client-headers/) .

Returns:

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

    CreateW9Form201Response data, response status code and response headers



505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
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
 
# File 'lib/avalara_sdk/api/A1099/V2/forms_w9_api.rb', line 505

def get_w9_form_with_http_info(request_parameters)
  # OAuth2 Scopes
  required_scopes = ''
  # Request Parameters
  id = request_parameters.get_id()
  avalara_version = request_parameters.get_avalara_version()
  x_correlation_id = request_parameters.get_x_correlation_id()
  x_avalara_client = request_parameters.get_x_avalara_client()
  # 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 FormsW9Api.get_w9_form"
  end
  # 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 FormsW9Api.get_w9_form"
  end
  # resource path
  local_var_path = '/w9/forms/{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_correlation_id.nil?
    header_params[:'X-Correlation-Id'] = x_correlation_id
  end
  if !x_avalara_client.nil?
    header_params[:'X-Avalara-Client'] = x_avalara_client
  end

  # form parameters
  form_params = {}

  # http body (model)
  post_body = {}

  # return_type
  return_type = 'CreateW9Form201Response'

  # auth_names
  auth_names = ['bearer']

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

  new_options = {
    :operation => :"FormsW9Api.get_w9_form",
    :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, :A1099)
  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/A1099/V2/forms_w9_api.rb', line 31

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

#list_w9_forms(request_parameters) ⇒ PaginatedQueryResultModelW9FormBaseResponse

List W9/W4/W8 forms List W9/W4/W8 forms. Filterable/Sortable fields are: "companyId", "type", "displayName", "entryStatus", "email", "archived" and "referenceId".

Parameters:

  • avalara_version (String) —

    API version # @param filter [String] A filter statement to identify specific records to retrieve. For more information on filtering, see &lt;a href&#x3D;&quot;developer.avalara.com/avatax/filtering-in-rest/&quot;&gt;Filtering in REST&lt;/a&gt;. # @param top [Integer] If zero or greater than 1000, return at most 1000 results. Otherwise, return this number of results. Used with skip to provide pagination for large datasets. # @param skip [Integer] If nonzero, skip this number of results before returning data. Used with top to provide pagination for large datasets. # @param order_by [String] A comma separated list of sort statements in the format (fieldname) [ASC|DESC], for example id ASC. # @param count [Boolean] If true, return the global count of elements in the collection. # @param count_only [Boolean] If true, return ONLY the global count of elements in the collection. It only applies when count&#x3D;true. # @param x_correlation_id [String] Unique correlation Id in a GUID format # @param x_avalara_client [String] Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](developer.avalara.com/avatax/client-headers/) .

Returns:



578
579
580
581
 
# File 'lib/avalara_sdk/api/A1099/V2/forms_w9_api.rb', line 578

def list_w9_forms(request_parameters)
  data, _status_code, _headers = list_w9_forms_with_http_info(request_parameters)
  data
end

#list_w9_forms_with_http_info(request_parameters) ⇒ Array<(PaginatedQueryResultModelW9FormBaseResponse, Integer, Hash)>

Returns PaginatedQueryResultModelW9FormBaseResponse data, response status code and response headers.

Parameters:

  • avalara_version (String) —

    API version

  • filter (String) —

    A filter statement to identify specific records to retrieve. For more information on filtering, see &lt;a href&#x3D;&quot;developer.avalara.com/avatax/filtering-in-rest/&quot;&gt;Filtering in REST&lt;/a&gt;.

  • top (Integer) —

    If zero or greater than 1000, return at most 1000 results. Otherwise, return this number of results. Used with skip to provide pagination for large datasets.

  • skip (Integer) —

    If nonzero, skip this number of results before returning data. Used with top to provide pagination for large datasets.

  • order_by (String) —

    A comma separated list of sort statements in the format (fieldname) [ASC|DESC], for example id ASC.

  • count (Boolean) —

    If true, return the global count of elements in the collection.

  • count_only (Boolean) —

    If true, return ONLY the global count of elements in the collection. It only applies when count&#x3D;true.

  • x_correlation_id (String) —

    Unique correlation Id in a GUID format

  • x_avalara_client (String) —

    Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](developer.avalara.com/avatax/client-headers/) .

Returns:



596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
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
 
# File 'lib/avalara_sdk/api/A1099/V2/forms_w9_api.rb', line 596

def list_w9_forms_with_http_info(request_parameters)
  # OAuth2 Scopes
  required_scopes = ''
  # Request Parameters
  avalara_version = request_parameters.get_avalara_version()
  filter = request_parameters.get_filter()
  top = request_parameters.get_top()
  skip = request_parameters.get_skip()
  order_by = request_parameters.get_order_by()
  count = request_parameters.get_count()
  count_only = request_parameters.get_count_only()
  x_correlation_id = request_parameters.get_x_correlation_id()
  x_avalara_client = request_parameters.get_x_avalara_client()
  # 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 FormsW9Api.list_w9_forms"
  end
  # resource path
  local_var_path = '/w9/forms'

  # query parameters
  query_params = {}
  if !filter.nil?
    query_params[:'$filter'] = filter
  end
  if !top.nil?
    query_params[:'$top'] = top
  end
  if !skip.nil?
    query_params[:'$skip'] = skip
  end
  if !order_by.nil?
    query_params[:'$orderBy'] = order_by
  end
  if !count.nil?
    query_params[:'count'] = count
  end
  if !count_only.nil?
    query_params[:'countOnly'] = count_only
  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_correlation_id.nil?
    header_params[:'X-Correlation-Id'] = x_correlation_id
  end
  if !x_avalara_client.nil?
    header_params[:'X-Avalara-Client'] = x_avalara_client
  end

  # form parameters
  form_params = {}

  # http body (model)
  post_body = {}

  # return_type
  return_type = 'PaginatedQueryResultModelW9FormBaseResponse'

  # auth_names
  auth_names = ['bearer']

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

  new_options = {
    :operation => :"FormsW9Api.list_w9_forms",
    :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, :A1099)
  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/A1099/V2/forms_w9_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/A1099/V2/forms_w9_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/A1099/V2/forms_w9_api.rb', line 133

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

#select_header_accept(accepts) ⇒ String

Return Accept header based on an array of accepts provided.

Parameters:

  • accepts (Array) —

    array for Accept

Returns:

  • (String) —

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



165
166
167
168
169
170
 
# File 'lib/avalara_sdk/api/A1099/V2/forms_w9_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/A1099/V2/forms_w9_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

#send_w9_form_email(request_parameters) ⇒ CreateW9Form201Response

Send an email to the vendor/payee requesting they fill out a W9/W4/W8 form Send an email to the vendor/payee requesting they fill out a W9/W4/W8 form. If the form is not in ‘Requested’ status, it will either use an existing descendant form in ‘Requested’ status or create a new minimal form and send the email request.

Parameters:

  • id (String) —

    The ID of the W9/W4/W8 form. # @param avalara_version [String] API version # @param x_correlation_id [String] Unique correlation Id in a GUID format # @param x_avalara_client [String] Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](developer.avalara.com/avatax/client-headers/) .

Returns:



688
689
690
691
 
# File 'lib/avalara_sdk/api/A1099/V2/forms_w9_api.rb', line 688

def send_w9_form_email(request_parameters)
  data, _status_code, _headers = send_w9_form_email_with_http_info(request_parameters)
  data
end

#send_w9_form_email_with_http_info(request_parameters) ⇒ Array<(CreateW9Form201Response, Integer, Hash)>

Returns CreateW9Form201Response data, response status code and response headers.

Parameters:

  • id (String) —

    The ID of the W9/W4/W8 form.

  • avalara_version (String) —

    API version

  • x_correlation_id (String) —

    Unique correlation Id in a GUID format

  • x_avalara_client (String) —

    Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](developer.avalara.com/avatax/client-headers/) .

Returns:

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

    CreateW9Form201Response data, response status code and response headers



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
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
 
# File 'lib/avalara_sdk/api/A1099/V2/forms_w9_api.rb', line 701

def send_w9_form_email_with_http_info(request_parameters)
  # OAuth2 Scopes
  required_scopes = ''
  # Request Parameters
  id = request_parameters.get_id()
  avalara_version = request_parameters.get_avalara_version()
  x_correlation_id = request_parameters.get_x_correlation_id()
  x_avalara_client = request_parameters.get_x_avalara_client()
  # 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 FormsW9Api.send_w9_form_email"
  end
  # 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 FormsW9Api.send_w9_form_email"
  end
  # resource path
  local_var_path = '/w9/forms/{id}/$send-email'.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_correlation_id.nil?
    header_params[:'X-Correlation-Id'] = x_correlation_id
  end
  if !x_avalara_client.nil?
    header_params[:'X-Avalara-Client'] = x_avalara_client
  end

  # form parameters
  form_params = {}

  # http body (model)
  post_body = {}

  # return_type
  return_type = 'CreateW9Form201Response'

  # auth_names
  auth_names = ['bearer']

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

  new_options = {
    :operation => :"FormsW9Api.send_w9_form_email",
    :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, :A1099)
  if new_options[:return_type]
    data = deserialize(response, new_options[:return_type])
  else
    data = nil
  end
  return data, response.code, response.headers
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/A1099/V2/forms_w9_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_w9_form(request_parameters) ⇒ IW9FormDataModelsOneOf

Update a W9/W4/W8 form Update a W9/W4/W8 form.

Parameters:

  • id (String) —

    ID of the form to update # @param avalara_version [String] API version # @param x_correlation_id [String] Unique correlation Id in a GUID format # @param x_avalara_client [String] Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](developer.avalara.com/avatax/client-headers/) . # @param iw9_form_data_models_one_of [IW9FormDataModelsOneOf] Form to be updated

Returns:



774
775
776
777
 
# File 'lib/avalara_sdk/api/A1099/V2/forms_w9_api.rb', line 774

def update_w9_form(request_parameters)
  data, _status_code, _headers = update_w9_form_with_http_info(request_parameters)
  data
end

#update_w9_form_with_http_info(request_parameters) ⇒ Array<(IW9FormDataModelsOneOf, Integer, Hash)>

Returns IW9FormDataModelsOneOf data, response status code and response headers.

Parameters:

  • id (String) —

    ID of the form to update

  • avalara_version (String) —

    API version

  • x_correlation_id (String) —

    Unique correlation Id in a GUID format

  • x_avalara_client (String) —

    Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](developer.avalara.com/avatax/client-headers/) .

  • iw9_form_data_models_one_of (IW9FormDataModelsOneOf) —

    Form to be updated

Returns:

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

    IW9FormDataModelsOneOf data, response status code and response headers



788
789
790
791
792
793
794
795
796
797
798
799
800
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
 
# File 'lib/avalara_sdk/api/A1099/V2/forms_w9_api.rb', line 788

def update_w9_form_with_http_info(request_parameters)
  # OAuth2 Scopes
  required_scopes = ''
  # Request Parameters
  id = request_parameters.get_id()
  avalara_version = request_parameters.get_avalara_version()
  x_correlation_id = request_parameters.get_x_correlation_id()
  x_avalara_client = request_parameters.get_x_avalara_client()
  iw9_form_data_models_one_of = request_parameters.get_iw9_form_data_models_one_of()
  # 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 FormsW9Api.update_w9_form"
  end
  # 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 FormsW9Api.update_w9_form"
  end
  # resource path
  local_var_path = '/w9/forms/{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', 'text/json', '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_correlation_id.nil?
    header_params[:'X-Correlation-Id'] = x_correlation_id
  end
  if !x_avalara_client.nil?
    header_params[:'X-Avalara-Client'] = x_avalara_client
  end

  # form parameters
  form_params = {}

  # http body (model)
  post_body =  @api_client.object_to_http_body(iw9_form_data_models_one_of) || {}

  # return_type
  return_type = 'IW9FormDataModelsOneOf'

  # auth_names
  auth_names = ['bearer']

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

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

#upload_w9_files(request_parameters) ⇒ nil

Replace the PDF file for a W9/W4/W8 form Replaces the PDF file for a W9/W4/W8 form.

Parameters:

  • id (String) —

    Id of the form # @param avalara_version [String] API version # @param x_correlation_id [String] Unique correlation Id in a GUID format # @param x_avalara_client [String] Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](developer.avalara.com/avatax/client-headers/) . # @param file [File]

Returns:

  • (nil) 


867
868
869
870
 
# File 'lib/avalara_sdk/api/A1099/V2/forms_w9_api.rb', line 867

def upload_w9_files(request_parameters)
  upload_w9_files_with_http_info(request_parameters)
  nil
end

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

Returns nil, response status code and response headers.

Parameters:

  • id (String) —

    Id of the form

  • avalara_version (String) —

    API version

  • x_correlation_id (String) —

    Unique correlation Id in a GUID format

  • x_avalara_client (String) —

    Identifies the software you are using to call this API. For more information on the client header, see [Client Headers](developer.avalara.com/avatax/client-headers/) .

  • file (File)

Returns:

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

    nil, response status code and response headers



881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
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
 
# File 'lib/avalara_sdk/api/A1099/V2/forms_w9_api.rb', line 881

def upload_w9_files_with_http_info(request_parameters)
  # OAuth2 Scopes
  required_scopes = ''
  # Request Parameters
  id = request_parameters.get_id()
  avalara_version = request_parameters.get_avalara_version()
  x_correlation_id = request_parameters.get_x_correlation_id()
  x_avalara_client = request_parameters.get_x_avalara_client()
  file = request_parameters.get_file()
  # 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 FormsW9Api.upload_w9_files"
  end
  # 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 FormsW9Api.upload_w9_files"
  end
  # resource path
  local_var_path = '/w9/forms/{id}/attachment'.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(['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_correlation_id.nil?
    header_params[:'X-Correlation-Id'] = x_correlation_id
  end
  if !x_avalara_client.nil?
    header_params[:'X-Avalara-Client'] = x_avalara_client
  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 => :"FormsW9Api.upload_w9_files",
    :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, :A1099)
  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/A1099/V2/forms_w9_api.rb', line 157

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