ultracart_api 4.0.32.rc → 4.0.33.rc

Sign up to get free protection for your applications and to get access to all the features.
data/docs/TaxApi.md CHANGED
@@ -47,18 +47,15 @@ Deletes a Self tax provider city.
47
47
  ```ruby
48
48
  require 'time'
49
49
  require 'ultracart_api'
50
- # setup authorization
51
- UltracartClient.configure do |config|
52
- # Configure OAuth2 access token for authorization: ultraCartOauth
53
- config.access_token = 'YOUR ACCESS TOKEN'
54
-
55
- # Configure API key authorization: ultraCartSimpleApiKey
56
- config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
57
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
58
- # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
59
- end
50
+ require 'json'
51
+ require 'yaml'
52
+ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
53
+
54
+ # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
55
+ # As such, this might not be the best way to use this object.
56
+ # Please see https://github.com/UltraCart/sdk_samples for working examples.
60
57
 
61
- api_instance = UltracartClient::TaxApi.new
58
+ api = UltracartClient::TaxApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
62
59
  city = 'city_example' # String | The city being deleted.
63
60
  tax_city = UltracartClient::TaxCity.new # TaxCity | tax city to be deleted
64
61
 
@@ -122,18 +119,15 @@ Deletes a Self tax provider country.
122
119
  ```ruby
123
120
  require 'time'
124
121
  require 'ultracart_api'
125
- # setup authorization
126
- UltracartClient.configure do |config|
127
- # Configure OAuth2 access token for authorization: ultraCartOauth
128
- config.access_token = 'YOUR ACCESS TOKEN'
129
-
130
- # Configure API key authorization: ultraCartSimpleApiKey
131
- config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
132
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
133
- # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
134
- end
122
+ require 'json'
123
+ require 'yaml'
124
+ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
125
+
126
+ # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
127
+ # As such, this might not be the best way to use this object.
128
+ # Please see https://github.com/UltraCart/sdk_samples for working examples.
135
129
 
136
- api_instance = UltracartClient::TaxApi.new
130
+ api = UltracartClient::TaxApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
137
131
  country_code = 'country_code_example' # String | The country code being deleted.
138
132
  tax_country = UltracartClient::TaxCountry.new # TaxCountry | tax country to be deleted
139
133
 
@@ -197,18 +191,15 @@ Deletes a Self tax provider county.
197
191
  ```ruby
198
192
  require 'time'
199
193
  require 'ultracart_api'
200
- # setup authorization
201
- UltracartClient.configure do |config|
202
- # Configure OAuth2 access token for authorization: ultraCartOauth
203
- config.access_token = 'YOUR ACCESS TOKEN'
204
-
205
- # Configure API key authorization: ultraCartSimpleApiKey
206
- config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
207
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
208
- # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
209
- end
194
+ require 'json'
195
+ require 'yaml'
196
+ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
197
+
198
+ # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
199
+ # As such, this might not be the best way to use this object.
200
+ # Please see https://github.com/UltraCart/sdk_samples for working examples.
210
201
 
211
- api_instance = UltracartClient::TaxApi.new
202
+ api = UltracartClient::TaxApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
212
203
  county = 'county_example' # String | The county being deleted.
213
204
  tax_county = UltracartClient::TaxCounty.new # TaxCounty | tax county to be deleted
214
205
 
@@ -272,18 +263,15 @@ Deletes a Self tax provider postalCode.
272
263
  ```ruby
273
264
  require 'time'
274
265
  require 'ultracart_api'
275
- # setup authorization
276
- UltracartClient.configure do |config|
277
- # Configure OAuth2 access token for authorization: ultraCartOauth
278
- config.access_token = 'YOUR ACCESS TOKEN'
279
-
280
- # Configure API key authorization: ultraCartSimpleApiKey
281
- config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
282
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
283
- # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
284
- end
266
+ require 'json'
267
+ require 'yaml'
268
+ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
285
269
 
286
- api_instance = UltracartClient::TaxApi.new
270
+ # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
271
+ # As such, this might not be the best way to use this object.
272
+ # Please see https://github.com/UltraCart/sdk_samples for working examples.
273
+
274
+ api = UltracartClient::TaxApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
287
275
  postal_code = 'postal_code_example' # String | The postal code being deleted.
288
276
  tax_postal_code = UltracartClient::TaxPostalCode.new # TaxPostalCode | tax postal code to be deleted
289
277
 
@@ -347,18 +335,15 @@ Deletes a Self tax provider state.
347
335
  ```ruby
348
336
  require 'time'
349
337
  require 'ultracart_api'
350
- # setup authorization
351
- UltracartClient.configure do |config|
352
- # Configure OAuth2 access token for authorization: ultraCartOauth
353
- config.access_token = 'YOUR ACCESS TOKEN'
354
-
355
- # Configure API key authorization: ultraCartSimpleApiKey
356
- config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
357
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
358
- # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
359
- end
338
+ require 'json'
339
+ require 'yaml'
340
+ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
360
341
 
361
- api_instance = UltracartClient::TaxApi.new
342
+ # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
343
+ # As such, this might not be the best way to use this object.
344
+ # Please see https://github.com/UltraCart/sdk_samples for working examples.
345
+
346
+ api = UltracartClient::TaxApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
362
347
  state_code = 'state_code_example' # String | The state code being deleted.
363
348
  tax_state = UltracartClient::TaxState.new # TaxState | tax state to be deleted
364
349
 
@@ -422,18 +407,15 @@ Retrieves the Avalara tax provider.
422
407
  ```ruby
423
408
  require 'time'
424
409
  require 'ultracart_api'
425
- # setup authorization
426
- UltracartClient.configure do |config|
427
- # Configure OAuth2 access token for authorization: ultraCartOauth
428
- config.access_token = 'YOUR ACCESS TOKEN'
429
-
430
- # Configure API key authorization: ultraCartSimpleApiKey
431
- config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
432
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
433
- # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
434
- end
410
+ require 'json'
411
+ require 'yaml'
412
+ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
435
413
 
436
- api_instance = UltracartClient::TaxApi.new
414
+ # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
415
+ # As such, this might not be the best way to use this object.
416
+ # Please see https://github.com/UltraCart/sdk_samples for working examples.
417
+
418
+ api = UltracartClient::TaxApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
437
419
 
438
420
  begin
439
421
  # Retrieve the Avalara tax provider
@@ -493,18 +475,15 @@ Returns Avalara Tax companies configured by the merchant
493
475
  ```ruby
494
476
  require 'time'
495
477
  require 'ultracart_api'
496
- # setup authorization
497
- UltracartClient.configure do |config|
498
- # Configure OAuth2 access token for authorization: ultraCartOauth
499
- config.access_token = 'YOUR ACCESS TOKEN'
500
-
501
- # Configure API key authorization: ultraCartSimpleApiKey
502
- config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
503
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
504
- # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
505
- end
478
+ require 'json'
479
+ require 'yaml'
480
+ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
481
+
482
+ # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
483
+ # As such, this might not be the best way to use this object.
484
+ # Please see https://github.com/UltraCart/sdk_samples for working examples.
506
485
 
507
- api_instance = UltracartClient::TaxApi.new
486
+ api = UltracartClient::TaxApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
508
487
  tax_provider_avalara = UltracartClient::TaxProviderAvalara.new # TaxProviderAvalara | TaxProviderAvalara object
509
488
 
510
489
  begin
@@ -567,18 +546,15 @@ Attempts to connect to Avalara and returns back the response.
567
546
  ```ruby
568
547
  require 'time'
569
548
  require 'ultracart_api'
570
- # setup authorization
571
- UltracartClient.configure do |config|
572
- # Configure OAuth2 access token for authorization: ultraCartOauth
573
- config.access_token = 'YOUR ACCESS TOKEN'
574
-
575
- # Configure API key authorization: ultraCartSimpleApiKey
576
- config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
577
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
578
- # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
579
- end
549
+ require 'json'
550
+ require 'yaml'
551
+ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
552
+
553
+ # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
554
+ # As such, this might not be the best way to use this object.
555
+ # Please see https://github.com/UltraCart/sdk_samples for working examples.
580
556
 
581
- api_instance = UltracartClient::TaxApi.new
557
+ api = UltracartClient::TaxApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
582
558
 
583
559
  begin
584
560
  # Attempts to connect to Avalara and returns back the response
@@ -638,18 +614,15 @@ Retrieves the Self tax provider.
638
614
  ```ruby
639
615
  require 'time'
640
616
  require 'ultracart_api'
641
- # setup authorization
642
- UltracartClient.configure do |config|
643
- # Configure OAuth2 access token for authorization: ultraCartOauth
644
- config.access_token = 'YOUR ACCESS TOKEN'
645
-
646
- # Configure API key authorization: ultraCartSimpleApiKey
647
- config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
648
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
649
- # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
650
- end
617
+ require 'json'
618
+ require 'yaml'
619
+ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
620
+
621
+ # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
622
+ # As such, this might not be the best way to use this object.
623
+ # Please see https://github.com/UltraCart/sdk_samples for working examples.
651
624
 
652
- api_instance = UltracartClient::TaxApi.new
625
+ api = UltracartClient::TaxApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
653
626
 
654
627
  begin
655
628
  # Retrieve the Self tax provider
@@ -709,18 +682,15 @@ Retrieves the Self tax provider countries.
709
682
  ```ruby
710
683
  require 'time'
711
684
  require 'ultracart_api'
712
- # setup authorization
713
- UltracartClient.configure do |config|
714
- # Configure OAuth2 access token for authorization: ultraCartOauth
715
- config.access_token = 'YOUR ACCESS TOKEN'
716
-
717
- # Configure API key authorization: ultraCartSimpleApiKey
718
- config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
719
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
720
- # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
721
- end
685
+ require 'json'
686
+ require 'yaml'
687
+ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
688
+
689
+ # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
690
+ # As such, this might not be the best way to use this object.
691
+ # Please see https://github.com/UltraCart/sdk_samples for working examples.
722
692
 
723
- api_instance = UltracartClient::TaxApi.new
693
+ api = UltracartClient::TaxApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
724
694
 
725
695
  begin
726
696
  # Retrieve the Self tax provider countries
@@ -780,18 +750,15 @@ Retrieves the Self tax provider regions for a given country code.
780
750
  ```ruby
781
751
  require 'time'
782
752
  require 'ultracart_api'
783
- # setup authorization
784
- UltracartClient.configure do |config|
785
- # Configure OAuth2 access token for authorization: ultraCartOauth
786
- config.access_token = 'YOUR ACCESS TOKEN'
787
-
788
- # Configure API key authorization: ultraCartSimpleApiKey
789
- config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
790
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
791
- # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
792
- end
753
+ require 'json'
754
+ require 'yaml'
755
+ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
793
756
 
794
- api_instance = UltracartClient::TaxApi.new
757
+ # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
758
+ # As such, this might not be the best way to use this object.
759
+ # Please see https://github.com/UltraCart/sdk_samples for working examples.
760
+
761
+ api = UltracartClient::TaxApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
795
762
  country_code = 'country_code_example' # String | The country code regions desired.
796
763
 
797
764
  begin
@@ -854,18 +821,15 @@ Retrieves the Sovos tax provider.
854
821
  ```ruby
855
822
  require 'time'
856
823
  require 'ultracart_api'
857
- # setup authorization
858
- UltracartClient.configure do |config|
859
- # Configure OAuth2 access token for authorization: ultraCartOauth
860
- config.access_token = 'YOUR ACCESS TOKEN'
861
-
862
- # Configure API key authorization: ultraCartSimpleApiKey
863
- config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
864
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
865
- # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
866
- end
824
+ require 'json'
825
+ require 'yaml'
826
+ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
867
827
 
868
- api_instance = UltracartClient::TaxApi.new
828
+ # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
829
+ # As such, this might not be the best way to use this object.
830
+ # Please see https://github.com/UltraCart/sdk_samples for working examples.
831
+
832
+ api = UltracartClient::TaxApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
869
833
 
870
834
  begin
871
835
  # Retrieve the Sovos tax provider
@@ -925,18 +889,15 @@ Attempts to connect to Sovos and returns back the response.
925
889
  ```ruby
926
890
  require 'time'
927
891
  require 'ultracart_api'
928
- # setup authorization
929
- UltracartClient.configure do |config|
930
- # Configure OAuth2 access token for authorization: ultraCartOauth
931
- config.access_token = 'YOUR ACCESS TOKEN'
932
-
933
- # Configure API key authorization: ultraCartSimpleApiKey
934
- config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
935
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
936
- # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
937
- end
892
+ require 'json'
893
+ require 'yaml'
894
+ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
938
895
 
939
- api_instance = UltracartClient::TaxApi.new
896
+ # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
897
+ # As such, this might not be the best way to use this object.
898
+ # Please see https://github.com/UltraCart/sdk_samples for working examples.
899
+
900
+ api = UltracartClient::TaxApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
940
901
 
941
902
  begin
942
903
  # Attempts to connect to Sovos and returns back the response
@@ -996,18 +957,15 @@ Retrieves the TaxJar tax provider.
996
957
  ```ruby
997
958
  require 'time'
998
959
  require 'ultracart_api'
999
- # setup authorization
1000
- UltracartClient.configure do |config|
1001
- # Configure OAuth2 access token for authorization: ultraCartOauth
1002
- config.access_token = 'YOUR ACCESS TOKEN'
1003
-
1004
- # Configure API key authorization: ultraCartSimpleApiKey
1005
- config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
1006
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1007
- # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
1008
- end
960
+ require 'json'
961
+ require 'yaml'
962
+ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
963
+
964
+ # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
965
+ # As such, this might not be the best way to use this object.
966
+ # Please see https://github.com/UltraCart/sdk_samples for working examples.
1009
967
 
1010
- api_instance = UltracartClient::TaxApi.new
968
+ api = UltracartClient::TaxApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
1011
969
 
1012
970
  begin
1013
971
  # Retrieve the TaxJar tax provider
@@ -1067,18 +1025,15 @@ Attempts to connect to TaxJar and returns back the response.
1067
1025
  ```ruby
1068
1026
  require 'time'
1069
1027
  require 'ultracart_api'
1070
- # setup authorization
1071
- UltracartClient.configure do |config|
1072
- # Configure OAuth2 access token for authorization: ultraCartOauth
1073
- config.access_token = 'YOUR ACCESS TOKEN'
1074
-
1075
- # Configure API key authorization: ultraCartSimpleApiKey
1076
- config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
1077
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1078
- # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
1079
- end
1028
+ require 'json'
1029
+ require 'yaml'
1030
+ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
1031
+
1032
+ # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
1033
+ # As such, this might not be the best way to use this object.
1034
+ # Please see https://github.com/UltraCart/sdk_samples for working examples.
1080
1035
 
1081
- api_instance = UltracartClient::TaxApi.new
1036
+ api = UltracartClient::TaxApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
1082
1037
 
1083
1038
  begin
1084
1039
  # Attempts to connect to TaxJar and returns back the response
@@ -1138,18 +1093,15 @@ Retrieves the UltraCart tax provider.
1138
1093
  ```ruby
1139
1094
  require 'time'
1140
1095
  require 'ultracart_api'
1141
- # setup authorization
1142
- UltracartClient.configure do |config|
1143
- # Configure OAuth2 access token for authorization: ultraCartOauth
1144
- config.access_token = 'YOUR ACCESS TOKEN'
1145
-
1146
- # Configure API key authorization: ultraCartSimpleApiKey
1147
- config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
1148
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1149
- # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
1150
- end
1096
+ require 'json'
1097
+ require 'yaml'
1098
+ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
1099
+
1100
+ # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
1101
+ # As such, this might not be the best way to use this object.
1102
+ # Please see https://github.com/UltraCart/sdk_samples for working examples.
1151
1103
 
1152
- api_instance = UltracartClient::TaxApi.new
1104
+ api = UltracartClient::TaxApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
1153
1105
 
1154
1106
  begin
1155
1107
  # Retrieve the UltraCart tax provider
@@ -1209,18 +1161,15 @@ Retrieves tax methods for this account.
1209
1161
  ```ruby
1210
1162
  require 'time'
1211
1163
  require 'ultracart_api'
1212
- # setup authorization
1213
- UltracartClient.configure do |config|
1214
- # Configure OAuth2 access token for authorization: ultraCartOauth
1215
- config.access_token = 'YOUR ACCESS TOKEN'
1216
-
1217
- # Configure API key authorization: ultraCartSimpleApiKey
1218
- config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
1219
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1220
- # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
1221
- end
1164
+ require 'json'
1165
+ require 'yaml'
1166
+ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
1167
+
1168
+ # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
1169
+ # As such, this might not be the best way to use this object.
1170
+ # Please see https://github.com/UltraCart/sdk_samples for working examples.
1222
1171
 
1223
- api_instance = UltracartClient::TaxApi.new
1172
+ api = UltracartClient::TaxApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
1224
1173
  opts = {
1225
1174
  _limit: 56, # Integer | The maximum number of records to return on this one API call. (Max 200)
1226
1175
  _offset: 56, # Integer | Pagination of the record set. Offset is a zero based index.
@@ -1289,18 +1238,15 @@ Toggle a tax provider to active.
1289
1238
  ```ruby
1290
1239
  require 'time'
1291
1240
  require 'ultracart_api'
1292
- # setup authorization
1293
- UltracartClient.configure do |config|
1294
- # Configure OAuth2 access token for authorization: ultraCartOauth
1295
- config.access_token = 'YOUR ACCESS TOKEN'
1296
-
1297
- # Configure API key authorization: ultraCartSimpleApiKey
1298
- config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
1299
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1300
- # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
1301
- end
1241
+ require 'json'
1242
+ require 'yaml'
1243
+ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
1302
1244
 
1303
- api_instance = UltracartClient::TaxApi.new
1245
+ # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
1246
+ # As such, this might not be the best way to use this object.
1247
+ # Please see https://github.com/UltraCart/sdk_samples for working examples.
1248
+
1249
+ api = UltracartClient::TaxApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
1304
1250
  provider_name = 'provider_name_example' # String | The tax provider to set active.
1305
1251
 
1306
1252
  begin
@@ -1363,18 +1309,15 @@ Update the Avalara tax provider.
1363
1309
  ```ruby
1364
1310
  require 'time'
1365
1311
  require 'ultracart_api'
1366
- # setup authorization
1367
- UltracartClient.configure do |config|
1368
- # Configure OAuth2 access token for authorization: ultraCartOauth
1369
- config.access_token = 'YOUR ACCESS TOKEN'
1370
-
1371
- # Configure API key authorization: ultraCartSimpleApiKey
1372
- config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
1373
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1374
- # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
1375
- end
1312
+ require 'json'
1313
+ require 'yaml'
1314
+ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
1376
1315
 
1377
- api_instance = UltracartClient::TaxApi.new
1316
+ # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
1317
+ # As such, this might not be the best way to use this object.
1318
+ # Please see https://github.com/UltraCart/sdk_samples for working examples.
1319
+
1320
+ api = UltracartClient::TaxApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
1378
1321
  tax_provider_avalara = UltracartClient::TaxProviderAvalara.new # TaxProviderAvalara | TaxProviderAvalara object
1379
1322
 
1380
1323
  begin
@@ -1437,18 +1380,15 @@ Update the Self tax provider.
1437
1380
  ```ruby
1438
1381
  require 'time'
1439
1382
  require 'ultracart_api'
1440
- # setup authorization
1441
- UltracartClient.configure do |config|
1442
- # Configure OAuth2 access token for authorization: ultraCartOauth
1443
- config.access_token = 'YOUR ACCESS TOKEN'
1444
-
1445
- # Configure API key authorization: ultraCartSimpleApiKey
1446
- config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
1447
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1448
- # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
1449
- end
1383
+ require 'json'
1384
+ require 'yaml'
1385
+ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
1450
1386
 
1451
- api_instance = UltracartClient::TaxApi.new
1387
+ # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
1388
+ # As such, this might not be the best way to use this object.
1389
+ # Please see https://github.com/UltraCart/sdk_samples for working examples.
1390
+
1391
+ api = UltracartClient::TaxApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
1452
1392
  tax_provider_self = UltracartClient::TaxProviderSelf.new # TaxProviderSelf | TaxProviderSelf object
1453
1393
 
1454
1394
  begin
@@ -1511,18 +1451,15 @@ Updates a Self tax provider city.
1511
1451
  ```ruby
1512
1452
  require 'time'
1513
1453
  require 'ultracart_api'
1514
- # setup authorization
1515
- UltracartClient.configure do |config|
1516
- # Configure OAuth2 access token for authorization: ultraCartOauth
1517
- config.access_token = 'YOUR ACCESS TOKEN'
1518
-
1519
- # Configure API key authorization: ultraCartSimpleApiKey
1520
- config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
1521
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1522
- # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
1523
- end
1454
+ require 'json'
1455
+ require 'yaml'
1456
+ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
1457
+
1458
+ # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
1459
+ # As such, this might not be the best way to use this object.
1460
+ # Please see https://github.com/UltraCart/sdk_samples for working examples.
1524
1461
 
1525
- api_instance = UltracartClient::TaxApi.new
1462
+ api = UltracartClient::TaxApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
1526
1463
  city = 'city_example' # String | The city being updated.
1527
1464
  tax_city = UltracartClient::TaxCity.new # TaxCity | tax city to be updated
1528
1465
 
@@ -1587,18 +1524,15 @@ Updates a Self tax provider country.
1587
1524
  ```ruby
1588
1525
  require 'time'
1589
1526
  require 'ultracart_api'
1590
- # setup authorization
1591
- UltracartClient.configure do |config|
1592
- # Configure OAuth2 access token for authorization: ultraCartOauth
1593
- config.access_token = 'YOUR ACCESS TOKEN'
1594
-
1595
- # Configure API key authorization: ultraCartSimpleApiKey
1596
- config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
1597
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1598
- # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
1599
- end
1527
+ require 'json'
1528
+ require 'yaml'
1529
+ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
1530
+
1531
+ # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
1532
+ # As such, this might not be the best way to use this object.
1533
+ # Please see https://github.com/UltraCart/sdk_samples for working examples.
1600
1534
 
1601
- api_instance = UltracartClient::TaxApi.new
1535
+ api = UltracartClient::TaxApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
1602
1536
  country_code = 'country_code_example' # String | The country code being updated.
1603
1537
  tax_country = UltracartClient::TaxCountry.new # TaxCountry | tax country to be updated
1604
1538
 
@@ -1663,18 +1597,15 @@ Updates a Self tax provider county.
1663
1597
  ```ruby
1664
1598
  require 'time'
1665
1599
  require 'ultracart_api'
1666
- # setup authorization
1667
- UltracartClient.configure do |config|
1668
- # Configure OAuth2 access token for authorization: ultraCartOauth
1669
- config.access_token = 'YOUR ACCESS TOKEN'
1670
-
1671
- # Configure API key authorization: ultraCartSimpleApiKey
1672
- config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
1673
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1674
- # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
1675
- end
1600
+ require 'json'
1601
+ require 'yaml'
1602
+ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
1603
+
1604
+ # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
1605
+ # As such, this might not be the best way to use this object.
1606
+ # Please see https://github.com/UltraCart/sdk_samples for working examples.
1676
1607
 
1677
- api_instance = UltracartClient::TaxApi.new
1608
+ api = UltracartClient::TaxApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
1678
1609
  county = 'county_example' # String | The county being updated.
1679
1610
  tax_county = UltracartClient::TaxCounty.new # TaxCounty | tax county to be updated
1680
1611
 
@@ -1739,18 +1670,15 @@ Updates a Self tax provider postalCode.
1739
1670
  ```ruby
1740
1671
  require 'time'
1741
1672
  require 'ultracart_api'
1742
- # setup authorization
1743
- UltracartClient.configure do |config|
1744
- # Configure OAuth2 access token for authorization: ultraCartOauth
1745
- config.access_token = 'YOUR ACCESS TOKEN'
1746
-
1747
- # Configure API key authorization: ultraCartSimpleApiKey
1748
- config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
1749
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1750
- # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
1751
- end
1673
+ require 'json'
1674
+ require 'yaml'
1675
+ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
1676
+
1677
+ # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
1678
+ # As such, this might not be the best way to use this object.
1679
+ # Please see https://github.com/UltraCart/sdk_samples for working examples.
1752
1680
 
1753
- api_instance = UltracartClient::TaxApi.new
1681
+ api = UltracartClient::TaxApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
1754
1682
  postal_code = 'postal_code_example' # String | The postal code being updated.
1755
1683
  tax_postal_code = UltracartClient::TaxPostalCode.new # TaxPostalCode | tax postal code to be updated
1756
1684
 
@@ -1815,18 +1743,15 @@ Updates a Self tax provider state.
1815
1743
  ```ruby
1816
1744
  require 'time'
1817
1745
  require 'ultracart_api'
1818
- # setup authorization
1819
- UltracartClient.configure do |config|
1820
- # Configure OAuth2 access token for authorization: ultraCartOauth
1821
- config.access_token = 'YOUR ACCESS TOKEN'
1822
-
1823
- # Configure API key authorization: ultraCartSimpleApiKey
1824
- config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
1825
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1826
- # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
1827
- end
1746
+ require 'json'
1747
+ require 'yaml'
1748
+ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
1828
1749
 
1829
- api_instance = UltracartClient::TaxApi.new
1750
+ # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
1751
+ # As such, this might not be the best way to use this object.
1752
+ # Please see https://github.com/UltraCart/sdk_samples for working examples.
1753
+
1754
+ api = UltracartClient::TaxApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
1830
1755
  state_code = 'state_code_example' # String | The state code being updated.
1831
1756
  tax_state = UltracartClient::TaxState.new # TaxState | tax state to be updated
1832
1757
 
@@ -1891,18 +1816,15 @@ Update the Sovos tax provider.
1891
1816
  ```ruby
1892
1817
  require 'time'
1893
1818
  require 'ultracart_api'
1894
- # setup authorization
1895
- UltracartClient.configure do |config|
1896
- # Configure OAuth2 access token for authorization: ultraCartOauth
1897
- config.access_token = 'YOUR ACCESS TOKEN'
1898
-
1899
- # Configure API key authorization: ultraCartSimpleApiKey
1900
- config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
1901
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1902
- # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
1903
- end
1819
+ require 'json'
1820
+ require 'yaml'
1821
+ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
1904
1822
 
1905
- api_instance = UltracartClient::TaxApi.new
1823
+ # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
1824
+ # As such, this might not be the best way to use this object.
1825
+ # Please see https://github.com/UltraCart/sdk_samples for working examples.
1826
+
1827
+ api = UltracartClient::TaxApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
1906
1828
  tax_provider_sovos = UltracartClient::TaxProviderSovos.new # TaxProviderSovos | TaxProviderSovos object
1907
1829
 
1908
1830
  begin
@@ -1965,18 +1887,15 @@ Update the TaxJar tax provider.
1965
1887
  ```ruby
1966
1888
  require 'time'
1967
1889
  require 'ultracart_api'
1968
- # setup authorization
1969
- UltracartClient.configure do |config|
1970
- # Configure OAuth2 access token for authorization: ultraCartOauth
1971
- config.access_token = 'YOUR ACCESS TOKEN'
1972
-
1973
- # Configure API key authorization: ultraCartSimpleApiKey
1974
- config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
1975
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1976
- # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
1977
- end
1890
+ require 'json'
1891
+ require 'yaml'
1892
+ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
1978
1893
 
1979
- api_instance = UltracartClient::TaxApi.new
1894
+ # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
1895
+ # As such, this might not be the best way to use this object.
1896
+ # Please see https://github.com/UltraCart/sdk_samples for working examples.
1897
+
1898
+ api = UltracartClient::TaxApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
1980
1899
  tax_provider_tax_jar = UltracartClient::TaxProviderTaxJar.new # TaxProviderTaxJar | TaxProviderTaxJar object
1981
1900
 
1982
1901
  begin
@@ -2039,18 +1958,15 @@ Update the UltraCart tax provider.
2039
1958
  ```ruby
2040
1959
  require 'time'
2041
1960
  require 'ultracart_api'
2042
- # setup authorization
2043
- UltracartClient.configure do |config|
2044
- # Configure OAuth2 access token for authorization: ultraCartOauth
2045
- config.access_token = 'YOUR ACCESS TOKEN'
2046
-
2047
- # Configure API key authorization: ultraCartSimpleApiKey
2048
- config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
2049
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
2050
- # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
2051
- end
1961
+ require 'json'
1962
+ require 'yaml'
1963
+ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
1964
+
1965
+ # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
1966
+ # As such, this might not be the best way to use this object.
1967
+ # Please see https://github.com/UltraCart/sdk_samples for working examples.
2052
1968
 
2053
- api_instance = UltracartClient::TaxApi.new
1969
+ api = UltracartClient::TaxApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
2054
1970
  tax_provider_ultracart = UltracartClient::TaxProviderUltraCart.new # TaxProviderUltraCart | TaxProviderUltraCart object
2055
1971
 
2056
1972
  begin