ultracart_api 3.0.75 → 3.1.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +23 -18
- data/docs/AffiliateApi.md +8 -22
- data/docs/AutoOrderApi.md +44 -100
- data/docs/ChargebackApi.md +20 -55
- data/docs/CheckoutApi.md +78 -295
- data/docs/CouponApi.md +78 -209
- data/docs/CouponTieredAmountOffItem.md +1 -1
- data/docs/CouponTieredPercentOffItems.md +1 -1
- data/docs/CustomerApi.md +199 -110
- data/docs/EmailPlanAdditional.md +1 -0
- data/docs/EmailVerifyTokenRequest.md +9 -0
- data/docs/EmailVerifyTokenResponse.md +12 -0
- data/docs/EmailVerifyTokenValidateRequest.md +8 -0
- data/docs/EmailVerifyTokenValidateResponse.md +11 -0
- data/docs/FulfillmentApi.md +21 -55
- data/docs/ItemApi.md +36 -99
- data/docs/OauthApi.md +8 -32
- data/docs/OrderApi.md +84 -223
- data/docs/ScreenRecording.md +2 -1
- data/docs/StorefrontApi.md +429 -2077
- data/docs/TaxApi.md +121 -308
- data/docs/UserApi.md +46 -121
- data/docs/WebhookApi.md +32 -88
- data/lib/ultracart_api.rb +4 -0
- data/lib/ultracart_api/api/affiliate_api.rb +13 -0
- data/lib/ultracart_api/api/auto_order_api.rb +21 -8
- data/lib/ultracart_api/api/chargeback_api.rb +13 -0
- data/lib/ultracart_api/api/checkout_api.rb +15 -2
- data/lib/ultracart_api/api/coupon_api.rb +13 -0
- data/lib/ultracart_api/api/customer_api.rb +181 -0
- data/lib/ultracart_api/api/fulfillment_api.rb +13 -0
- data/lib/ultracart_api/api/item_api.rb +13 -0
- data/lib/ultracart_api/api/oauth_api.rb +13 -0
- data/lib/ultracart_api/api/order_api.rb +15 -2
- data/lib/ultracart_api/api/storefront_api.rb +13 -0
- data/lib/ultracart_api/api/tax_api.rb +13 -0
- data/lib/ultracart_api/api/user_api.rb +13 -0
- data/lib/ultracart_api/api/webhook_api.rb +13 -0
- data/lib/ultracart_api/models/coupon_tiered_amount_off_item.rb +1 -1
- data/lib/ultracart_api/models/coupon_tiered_percent_off_items.rb +1 -1
- data/lib/ultracart_api/models/email_plan_additional.rb +10 -1
- data/lib/ultracart_api/models/email_verify_token_request.rb +195 -0
- data/lib/ultracart_api/models/email_verify_token_response.rb +222 -0
- data/lib/ultracart_api/models/email_verify_token_validate_request.rb +185 -0
- data/lib/ultracart_api/models/email_verify_token_validate_response.rb +212 -0
- data/lib/ultracart_api/models/screen_recording.rb +12 -1
- data/lib/ultracart_api/version.rb +1 -1
- metadata +10 -2
data/docs/TaxApi.md
CHANGED
|
@@ -45,18 +45,11 @@ Deletes a Self tax provider city.
|
|
|
45
45
|
```ruby
|
|
46
46
|
# load the gem
|
|
47
47
|
require 'ultracart_api'
|
|
48
|
-
# setup authorization
|
|
49
|
-
UltracartClient.configure do |config|
|
|
50
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
51
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
52
|
-
|
|
53
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
|
54
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
55
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
56
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
57
|
-
end
|
|
58
48
|
|
|
59
|
-
|
|
49
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
50
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
51
|
+
api_instance = UltracartClient::TaxApi.new_using_api_key(simple_key, false, false)
|
|
52
|
+
|
|
60
53
|
|
|
61
54
|
city = 'city_example' # String | The city being deleted.
|
|
62
55
|
|
|
@@ -104,18 +97,11 @@ Deletes a Self tax provider country.
|
|
|
104
97
|
```ruby
|
|
105
98
|
# load the gem
|
|
106
99
|
require 'ultracart_api'
|
|
107
|
-
# setup authorization
|
|
108
|
-
UltracartClient.configure do |config|
|
|
109
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
110
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
111
|
-
|
|
112
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
|
113
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
114
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
115
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
116
|
-
end
|
|
117
100
|
|
|
118
|
-
|
|
101
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
102
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
103
|
+
api_instance = UltracartClient::TaxApi.new_using_api_key(simple_key, false, false)
|
|
104
|
+
|
|
119
105
|
|
|
120
106
|
country_code = 'country_code_example' # String | The country code being deleted.
|
|
121
107
|
|
|
@@ -163,18 +149,11 @@ Deletes a Self tax provider county.
|
|
|
163
149
|
```ruby
|
|
164
150
|
# load the gem
|
|
165
151
|
require 'ultracart_api'
|
|
166
|
-
# setup authorization
|
|
167
|
-
UltracartClient.configure do |config|
|
|
168
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
169
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
170
|
-
|
|
171
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
|
172
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
173
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
174
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
175
|
-
end
|
|
176
152
|
|
|
177
|
-
|
|
153
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
154
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
155
|
+
api_instance = UltracartClient::TaxApi.new_using_api_key(simple_key, false, false)
|
|
156
|
+
|
|
178
157
|
|
|
179
158
|
county = 'county_example' # String | The county being deleted.
|
|
180
159
|
|
|
@@ -222,18 +201,11 @@ Deletes a Self tax provider postalCode.
|
|
|
222
201
|
```ruby
|
|
223
202
|
# load the gem
|
|
224
203
|
require 'ultracart_api'
|
|
225
|
-
# setup authorization
|
|
226
|
-
UltracartClient.configure do |config|
|
|
227
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
228
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
229
|
-
|
|
230
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
|
231
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
232
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
233
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
234
|
-
end
|
|
235
204
|
|
|
236
|
-
|
|
205
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
206
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
207
|
+
api_instance = UltracartClient::TaxApi.new_using_api_key(simple_key, false, false)
|
|
208
|
+
|
|
237
209
|
|
|
238
210
|
postal_code = 'postal_code_example' # String | The postal code being deleted.
|
|
239
211
|
|
|
@@ -281,18 +253,11 @@ Deletes a Self tax provider state.
|
|
|
281
253
|
```ruby
|
|
282
254
|
# load the gem
|
|
283
255
|
require 'ultracart_api'
|
|
284
|
-
# setup authorization
|
|
285
|
-
UltracartClient.configure do |config|
|
|
286
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
287
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
288
|
-
|
|
289
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
|
290
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
291
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
292
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
293
|
-
end
|
|
294
256
|
|
|
295
|
-
|
|
257
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
258
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
259
|
+
api_instance = UltracartClient::TaxApi.new_using_api_key(simple_key, false, false)
|
|
260
|
+
|
|
296
261
|
|
|
297
262
|
state_code = 'state_code_example' # String | The state code being deleted.
|
|
298
263
|
|
|
@@ -340,18 +305,12 @@ Retrieves the Avalara tax provider.
|
|
|
340
305
|
```ruby
|
|
341
306
|
# load the gem
|
|
342
307
|
require 'ultracart_api'
|
|
343
|
-
# setup authorization
|
|
344
|
-
UltracartClient.configure do |config|
|
|
345
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
346
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
347
|
-
|
|
348
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
|
349
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
350
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
351
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
352
|
-
end
|
|
353
308
|
|
|
354
|
-
|
|
309
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
310
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
311
|
+
api_instance = UltracartClient::TaxApi.new_using_api_key(simple_key, false, false)
|
|
312
|
+
|
|
313
|
+
|
|
355
314
|
|
|
356
315
|
begin
|
|
357
316
|
#Retrieve the Avalara tax provider
|
|
@@ -391,18 +350,11 @@ Returns Avalara Tax companies configured by the merchant
|
|
|
391
350
|
```ruby
|
|
392
351
|
# load the gem
|
|
393
352
|
require 'ultracart_api'
|
|
394
|
-
# setup authorization
|
|
395
|
-
UltracartClient.configure do |config|
|
|
396
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
397
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
398
|
-
|
|
399
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
|
400
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
401
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
402
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
403
|
-
end
|
|
404
353
|
|
|
405
|
-
|
|
354
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
355
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
356
|
+
api_instance = UltracartClient::TaxApi.new_using_api_key(simple_key, false, false)
|
|
357
|
+
|
|
406
358
|
|
|
407
359
|
tax_provider_avalara = UltracartClient::TaxProviderAvalara.new # TaxProviderAvalara | TaxProviderAvalara object
|
|
408
360
|
|
|
@@ -448,18 +400,12 @@ Attempts to connect to Avalara and returns back the response.
|
|
|
448
400
|
```ruby
|
|
449
401
|
# load the gem
|
|
450
402
|
require 'ultracart_api'
|
|
451
|
-
# setup authorization
|
|
452
|
-
UltracartClient.configure do |config|
|
|
453
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
454
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
455
|
-
|
|
456
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
|
457
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
458
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
459
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
460
|
-
end
|
|
461
403
|
|
|
462
|
-
|
|
404
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
405
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
406
|
+
api_instance = UltracartClient::TaxApi.new_using_api_key(simple_key, false, false)
|
|
407
|
+
|
|
408
|
+
|
|
463
409
|
|
|
464
410
|
begin
|
|
465
411
|
#Attempts to connect to Avalara and returns back the response
|
|
@@ -499,18 +445,12 @@ Retrieves the Self tax provider.
|
|
|
499
445
|
```ruby
|
|
500
446
|
# load the gem
|
|
501
447
|
require 'ultracart_api'
|
|
502
|
-
# setup authorization
|
|
503
|
-
UltracartClient.configure do |config|
|
|
504
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
505
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
506
|
-
|
|
507
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
|
508
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
509
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
510
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
511
|
-
end
|
|
512
448
|
|
|
513
|
-
|
|
449
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
450
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
451
|
+
api_instance = UltracartClient::TaxApi.new_using_api_key(simple_key, false, false)
|
|
452
|
+
|
|
453
|
+
|
|
514
454
|
|
|
515
455
|
begin
|
|
516
456
|
#Retrieve the Self tax provider
|
|
@@ -550,18 +490,12 @@ Retrieves the Self tax provider countries.
|
|
|
550
490
|
```ruby
|
|
551
491
|
# load the gem
|
|
552
492
|
require 'ultracart_api'
|
|
553
|
-
# setup authorization
|
|
554
|
-
UltracartClient.configure do |config|
|
|
555
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
556
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
557
|
-
|
|
558
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
|
559
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
560
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
561
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
562
|
-
end
|
|
563
493
|
|
|
564
|
-
|
|
494
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
495
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
496
|
+
api_instance = UltracartClient::TaxApi.new_using_api_key(simple_key, false, false)
|
|
497
|
+
|
|
498
|
+
|
|
565
499
|
|
|
566
500
|
begin
|
|
567
501
|
#Retrieve the Self tax provider countries
|
|
@@ -601,18 +535,11 @@ Retrieves the Self tax provider regions for a given country code.
|
|
|
601
535
|
```ruby
|
|
602
536
|
# load the gem
|
|
603
537
|
require 'ultracart_api'
|
|
604
|
-
# setup authorization
|
|
605
|
-
UltracartClient.configure do |config|
|
|
606
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
607
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
608
|
-
|
|
609
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
|
610
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
611
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
612
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
613
|
-
end
|
|
614
538
|
|
|
615
|
-
|
|
539
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
540
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
541
|
+
api_instance = UltracartClient::TaxApi.new_using_api_key(simple_key, false, false)
|
|
542
|
+
|
|
616
543
|
|
|
617
544
|
country_code = 'country_code_example' # String | The country code regions desired.
|
|
618
545
|
|
|
@@ -658,18 +585,12 @@ Retrieves the Sovos tax provider.
|
|
|
658
585
|
```ruby
|
|
659
586
|
# load the gem
|
|
660
587
|
require 'ultracart_api'
|
|
661
|
-
# setup authorization
|
|
662
|
-
UltracartClient.configure do |config|
|
|
663
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
664
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
665
|
-
|
|
666
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
|
667
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
668
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
669
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
670
|
-
end
|
|
671
588
|
|
|
672
|
-
|
|
589
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
590
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
591
|
+
api_instance = UltracartClient::TaxApi.new_using_api_key(simple_key, false, false)
|
|
592
|
+
|
|
593
|
+
|
|
673
594
|
|
|
674
595
|
begin
|
|
675
596
|
#Retrieve the Sovos tax provider
|
|
@@ -709,18 +630,12 @@ Attempts to connect to Sovos and returns back the response.
|
|
|
709
630
|
```ruby
|
|
710
631
|
# load the gem
|
|
711
632
|
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['x-ultracart-simple-key'] = '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['x-ultracart-simple-key'] = 'Bearer'
|
|
721
|
-
end
|
|
722
633
|
|
|
723
|
-
|
|
634
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
635
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
636
|
+
api_instance = UltracartClient::TaxApi.new_using_api_key(simple_key, false, false)
|
|
637
|
+
|
|
638
|
+
|
|
724
639
|
|
|
725
640
|
begin
|
|
726
641
|
#Attempts to connect to Sovos and returns back the response
|
|
@@ -760,18 +675,12 @@ Retrieves the TaxJar tax provider.
|
|
|
760
675
|
```ruby
|
|
761
676
|
# load the gem
|
|
762
677
|
require 'ultracart_api'
|
|
763
|
-
# setup authorization
|
|
764
|
-
UltracartClient.configure do |config|
|
|
765
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
766
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
767
|
-
|
|
768
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
|
769
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
770
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
771
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
772
|
-
end
|
|
773
678
|
|
|
774
|
-
|
|
679
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
680
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
681
|
+
api_instance = UltracartClient::TaxApi.new_using_api_key(simple_key, false, false)
|
|
682
|
+
|
|
683
|
+
|
|
775
684
|
|
|
776
685
|
begin
|
|
777
686
|
#Retrieve the TaxJar tax provider
|
|
@@ -811,18 +720,12 @@ Attempts to connect to TaxJar and returns back the response.
|
|
|
811
720
|
```ruby
|
|
812
721
|
# load the gem
|
|
813
722
|
require 'ultracart_api'
|
|
814
|
-
# setup authorization
|
|
815
|
-
UltracartClient.configure do |config|
|
|
816
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
817
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
818
|
-
|
|
819
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
|
820
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
821
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
822
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
823
|
-
end
|
|
824
723
|
|
|
825
|
-
|
|
724
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
725
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
726
|
+
api_instance = UltracartClient::TaxApi.new_using_api_key(simple_key, false, false)
|
|
727
|
+
|
|
728
|
+
|
|
826
729
|
|
|
827
730
|
begin
|
|
828
731
|
#Attempts to connect to TaxJar and returns back the response
|
|
@@ -862,18 +765,12 @@ Retrieves the UltraCart tax provider.
|
|
|
862
765
|
```ruby
|
|
863
766
|
# load the gem
|
|
864
767
|
require 'ultracart_api'
|
|
865
|
-
# setup authorization
|
|
866
|
-
UltracartClient.configure do |config|
|
|
867
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
868
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
869
|
-
|
|
870
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
|
871
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
872
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
873
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
874
|
-
end
|
|
875
768
|
|
|
876
|
-
|
|
769
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
770
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
771
|
+
api_instance = UltracartClient::TaxApi.new_using_api_key(simple_key, false, false)
|
|
772
|
+
|
|
773
|
+
|
|
877
774
|
|
|
878
775
|
begin
|
|
879
776
|
#Retrieve the UltraCart tax provider
|
|
@@ -913,18 +810,11 @@ Retrieves tax methods for this account.
|
|
|
913
810
|
```ruby
|
|
914
811
|
# load the gem
|
|
915
812
|
require 'ultracart_api'
|
|
916
|
-
# setup authorization
|
|
917
|
-
UltracartClient.configure do |config|
|
|
918
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
919
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
920
|
-
|
|
921
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
|
922
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
923
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
924
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
925
|
-
end
|
|
926
813
|
|
|
927
|
-
|
|
814
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
815
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
816
|
+
api_instance = UltracartClient::TaxApi.new_using_api_key(simple_key, false, false)
|
|
817
|
+
|
|
928
818
|
|
|
929
819
|
opts = {
|
|
930
820
|
_limit: 100, # Integer | The maximum number of records to return on this one API call. (Max 200)
|
|
@@ -975,18 +865,11 @@ Toggle a tax provider to active.
|
|
|
975
865
|
```ruby
|
|
976
866
|
# load the gem
|
|
977
867
|
require 'ultracart_api'
|
|
978
|
-
# setup authorization
|
|
979
|
-
UltracartClient.configure do |config|
|
|
980
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
981
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
982
|
-
|
|
983
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
|
984
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
985
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
986
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
987
|
-
end
|
|
988
868
|
|
|
989
|
-
|
|
869
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
870
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
871
|
+
api_instance = UltracartClient::TaxApi.new_using_api_key(simple_key, false, false)
|
|
872
|
+
|
|
990
873
|
|
|
991
874
|
provider_name = 'provider_name_example' # String | The tax provider to set active.
|
|
992
875
|
|
|
@@ -1032,18 +915,11 @@ Update the Avalara tax provider.
|
|
|
1032
915
|
```ruby
|
|
1033
916
|
# load the gem
|
|
1034
917
|
require 'ultracart_api'
|
|
1035
|
-
# setup authorization
|
|
1036
|
-
UltracartClient.configure do |config|
|
|
1037
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
1038
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
1039
|
-
|
|
1040
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
|
1041
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
1042
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1043
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
1044
|
-
end
|
|
1045
918
|
|
|
1046
|
-
|
|
919
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
920
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
921
|
+
api_instance = UltracartClient::TaxApi.new_using_api_key(simple_key, false, false)
|
|
922
|
+
|
|
1047
923
|
|
|
1048
924
|
tax_provider_avalara = UltracartClient::TaxProviderAvalara.new # TaxProviderAvalara | TaxProviderAvalara object
|
|
1049
925
|
|
|
@@ -1089,18 +965,11 @@ Update the Self tax provider.
|
|
|
1089
965
|
```ruby
|
|
1090
966
|
# load the gem
|
|
1091
967
|
require 'ultracart_api'
|
|
1092
|
-
# setup authorization
|
|
1093
|
-
UltracartClient.configure do |config|
|
|
1094
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
1095
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
1096
|
-
|
|
1097
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
|
1098
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
1099
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1100
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
1101
|
-
end
|
|
1102
968
|
|
|
1103
|
-
|
|
969
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
970
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
971
|
+
api_instance = UltracartClient::TaxApi.new_using_api_key(simple_key, false, false)
|
|
972
|
+
|
|
1104
973
|
|
|
1105
974
|
tax_provider_self = UltracartClient::TaxProviderSelf.new # TaxProviderSelf | TaxProviderSelf object
|
|
1106
975
|
|
|
@@ -1146,18 +1015,11 @@ Updates a Self tax provider city.
|
|
|
1146
1015
|
```ruby
|
|
1147
1016
|
# load the gem
|
|
1148
1017
|
require 'ultracart_api'
|
|
1149
|
-
# setup authorization
|
|
1150
|
-
UltracartClient.configure do |config|
|
|
1151
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
1152
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
1153
|
-
|
|
1154
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
|
1155
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
1156
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1157
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
1158
|
-
end
|
|
1159
1018
|
|
|
1160
|
-
|
|
1019
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
1020
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
1021
|
+
api_instance = UltracartClient::TaxApi.new_using_api_key(simple_key, false, false)
|
|
1022
|
+
|
|
1161
1023
|
|
|
1162
1024
|
city = 'city_example' # String | The city being updated.
|
|
1163
1025
|
|
|
@@ -1206,18 +1068,11 @@ Updates a Self tax provider country.
|
|
|
1206
1068
|
```ruby
|
|
1207
1069
|
# load the gem
|
|
1208
1070
|
require 'ultracart_api'
|
|
1209
|
-
# setup authorization
|
|
1210
|
-
UltracartClient.configure do |config|
|
|
1211
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
1212
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
1213
|
-
|
|
1214
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
|
1215
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
1216
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1217
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
1218
|
-
end
|
|
1219
1071
|
|
|
1220
|
-
|
|
1072
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
1073
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
1074
|
+
api_instance = UltracartClient::TaxApi.new_using_api_key(simple_key, false, false)
|
|
1075
|
+
|
|
1221
1076
|
|
|
1222
1077
|
country_code = 'country_code_example' # String | The country code being updated.
|
|
1223
1078
|
|
|
@@ -1266,18 +1121,11 @@ Updates a Self tax provider county.
|
|
|
1266
1121
|
```ruby
|
|
1267
1122
|
# load the gem
|
|
1268
1123
|
require 'ultracart_api'
|
|
1269
|
-
# setup authorization
|
|
1270
|
-
UltracartClient.configure do |config|
|
|
1271
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
1272
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
1273
|
-
|
|
1274
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
|
1275
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
1276
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1277
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
1278
|
-
end
|
|
1279
1124
|
|
|
1280
|
-
|
|
1125
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
1126
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
1127
|
+
api_instance = UltracartClient::TaxApi.new_using_api_key(simple_key, false, false)
|
|
1128
|
+
|
|
1281
1129
|
|
|
1282
1130
|
county = 'county_example' # String | The county being updated.
|
|
1283
1131
|
|
|
@@ -1326,18 +1174,11 @@ Updates a Self tax provider postalCode.
|
|
|
1326
1174
|
```ruby
|
|
1327
1175
|
# load the gem
|
|
1328
1176
|
require 'ultracart_api'
|
|
1329
|
-
# setup authorization
|
|
1330
|
-
UltracartClient.configure do |config|
|
|
1331
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
1332
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
1333
|
-
|
|
1334
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
|
1335
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
1336
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1337
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
1338
|
-
end
|
|
1339
1177
|
|
|
1340
|
-
|
|
1178
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
1179
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
1180
|
+
api_instance = UltracartClient::TaxApi.new_using_api_key(simple_key, false, false)
|
|
1181
|
+
|
|
1341
1182
|
|
|
1342
1183
|
postal_code = 'postal_code_example' # String | The postal code being updated.
|
|
1343
1184
|
|
|
@@ -1386,18 +1227,11 @@ Updates a Self tax provider state.
|
|
|
1386
1227
|
```ruby
|
|
1387
1228
|
# load the gem
|
|
1388
1229
|
require 'ultracart_api'
|
|
1389
|
-
# setup authorization
|
|
1390
|
-
UltracartClient.configure do |config|
|
|
1391
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
1392
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
1393
|
-
|
|
1394
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
|
1395
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
1396
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1397
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
1398
|
-
end
|
|
1399
1230
|
|
|
1400
|
-
|
|
1231
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
1232
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
1233
|
+
api_instance = UltracartClient::TaxApi.new_using_api_key(simple_key, false, false)
|
|
1234
|
+
|
|
1401
1235
|
|
|
1402
1236
|
state_code = 'state_code_example' # String | The state code being updated.
|
|
1403
1237
|
|
|
@@ -1446,18 +1280,11 @@ Update the Sovos tax provider.
|
|
|
1446
1280
|
```ruby
|
|
1447
1281
|
# load the gem
|
|
1448
1282
|
require 'ultracart_api'
|
|
1449
|
-
# setup authorization
|
|
1450
|
-
UltracartClient.configure do |config|
|
|
1451
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
1452
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
1453
|
-
|
|
1454
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
|
1455
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
1456
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1457
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
1458
|
-
end
|
|
1459
1283
|
|
|
1460
|
-
|
|
1284
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
1285
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
1286
|
+
api_instance = UltracartClient::TaxApi.new_using_api_key(simple_key, false, false)
|
|
1287
|
+
|
|
1461
1288
|
|
|
1462
1289
|
tax_provider_sovos = UltracartClient::TaxProviderSovos.new # TaxProviderSovos | TaxProviderSovos object
|
|
1463
1290
|
|
|
@@ -1503,18 +1330,11 @@ Update the TaxJar tax provider.
|
|
|
1503
1330
|
```ruby
|
|
1504
1331
|
# load the gem
|
|
1505
1332
|
require 'ultracart_api'
|
|
1506
|
-
# setup authorization
|
|
1507
|
-
UltracartClient.configure do |config|
|
|
1508
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
1509
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
1510
|
-
|
|
1511
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
|
1512
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
1513
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1514
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
1515
|
-
end
|
|
1516
1333
|
|
|
1517
|
-
|
|
1334
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
1335
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
1336
|
+
api_instance = UltracartClient::TaxApi.new_using_api_key(simple_key, false, false)
|
|
1337
|
+
|
|
1518
1338
|
|
|
1519
1339
|
tax_provider_tax_jar = UltracartClient::TaxProviderTaxJar.new # TaxProviderTaxJar | TaxProviderTaxJar object
|
|
1520
1340
|
|
|
@@ -1560,18 +1380,11 @@ Update the UltraCart tax provider.
|
|
|
1560
1380
|
```ruby
|
|
1561
1381
|
# load the gem
|
|
1562
1382
|
require 'ultracart_api'
|
|
1563
|
-
# setup authorization
|
|
1564
|
-
UltracartClient.configure do |config|
|
|
1565
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
1566
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
1567
|
-
|
|
1568
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
|
1569
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
1570
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1571
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
1572
|
-
end
|
|
1573
1383
|
|
|
1574
|
-
|
|
1384
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
1385
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
1386
|
+
api_instance = UltracartClient::TaxApi.new_using_api_key(simple_key, false, false)
|
|
1387
|
+
|
|
1575
1388
|
|
|
1576
1389
|
tax_provider_ultracart = UltracartClient::TaxProviderUltraCart.new # TaxProviderUltraCart | TaxProviderUltraCart object
|
|
1577
1390
|
|