ultracart_api 3.0.75 → 3.1.3
Sign up to get free protection for your applications and to get access to all the features.
- 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
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: dedd83b9a5fef7b80e96ad9682d7011512e6e4d12c2b243c75a8db4a4c91d972
|
4
|
+
data.tar.gz: 45245d3b2545759641472bfee7a49fba4387f6513d306791260a33244e748d84
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: dc2a4966d53f3f6893da77d8c49844e7d40fa3602f84ca430e704f0feb2c942bdd1337208cb0becdba7669eee00bb0196f4ccb57bfc0dfcb0304ae0e587aefc7
|
7
|
+
data.tar.gz: c79618dc49f5269b4b3ee0c7f78bc8d9d9c8ef437e7d4f2e9be9e860e3d5fab8669200a5c4cb642efe7196f3ee6b7bf4044a84a0a16456dbb779aee8269fdbc8
|
data/README.md
CHANGED
@@ -7,7 +7,7 @@ UltraCart REST API Version 2
|
|
7
7
|
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
|
8
8
|
|
9
9
|
- API version: 2.0.0
|
10
|
-
- Package version: 3.
|
10
|
+
- Package version: 3.1.3
|
11
11
|
- Build package: io.swagger.codegen.languages.RubyClientCodegen
|
12
12
|
For more information, please visit [http://www.ultracart.com](http://www.ultracart.com)
|
13
13
|
|
@@ -24,15 +24,15 @@ gem build ultracart_api.gemspec
|
|
24
24
|
Then either install the gem locally:
|
25
25
|
|
26
26
|
```shell
|
27
|
-
gem install ./ultracart_api-3.
|
27
|
+
gem install ./ultracart_api-3.1.3.gem
|
28
28
|
```
|
29
|
-
(for development, run `gem install --dev ./ultracart_api-3.
|
29
|
+
(for development, run `gem install --dev ./ultracart_api-3.1.3.gem` to install the development dependencies)
|
30
30
|
|
31
31
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
32
32
|
|
33
33
|
Finally add this to the Gemfile:
|
34
34
|
|
35
|
-
gem 'ultracart_api', '~> 3.
|
35
|
+
gem 'ultracart_api', '~> 3.1.3'
|
36
36
|
|
37
37
|
### Install from Git
|
38
38
|
|
@@ -55,16 +55,10 @@ Please follow the [installation](#installation) procedure and then run the follo
|
|
55
55
|
# Load the gem
|
56
56
|
require 'ultracart_api'
|
57
57
|
|
58
|
-
# Setup authorization
|
59
|
-
UltracartClient.configure do |config|
|
60
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
61
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
62
58
|
|
63
|
-
|
64
|
-
|
65
|
-
|
66
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
67
|
-
end
|
59
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
60
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
61
|
+
api_instance = UltracartClient::AffiliateApi.new_using_api_key(simple_key, false, false)
|
68
62
|
|
69
63
|
api_instance = UltracartClient::AffiliateApi.new
|
70
64
|
|
@@ -94,12 +88,12 @@ Class | Method | HTTP request | Description
|
|
94
88
|
------------ | ------------- | ------------- | -------------
|
95
89
|
*UltracartClient::AffiliateApi* | [**get_clicks_by_query**](docs/AffiliateApi.md#get_clicks_by_query) | **POST** /affiliate/clicks/query | Retrieve clicks
|
96
90
|
*UltracartClient::AffiliateApi* | [**get_ledgers_by_query**](docs/AffiliateApi.md#get_ledgers_by_query) | **POST** /affiliate/ledgers/query | Retrieve ledger entries
|
97
|
-
*UltracartClient::AutoOrderApi* | [**get_auto_order**](docs/AutoOrderApi.md#get_auto_order) | **GET** /auto_order/auto_orders/{auto_order_oid} | Retrieve an auto order
|
98
|
-
*UltracartClient::AutoOrderApi* | [**get_auto_order_by_code**](docs/AutoOrderApi.md#get_auto_order_by_code) | **GET** /auto_order/auto_orders/code/{auto_order_code} | Retrieve an auto order
|
99
|
-
*UltracartClient::AutoOrderApi* | [**get_auto_order_by_reference_order_id**](docs/AutoOrderApi.md#get_auto_order_by_reference_order_id) | **GET** /auto_order/auto_orders/reference_order_id/{reference_order_id} | Retrieve an auto order
|
91
|
+
*UltracartClient::AutoOrderApi* | [**get_auto_order**](docs/AutoOrderApi.md#get_auto_order) | **GET** /auto_order/auto_orders/{auto_order_oid} | Retrieve an auto order by oid
|
92
|
+
*UltracartClient::AutoOrderApi* | [**get_auto_order_by_code**](docs/AutoOrderApi.md#get_auto_order_by_code) | **GET** /auto_order/auto_orders/code/{auto_order_code} | Retrieve an auto order by code
|
93
|
+
*UltracartClient::AutoOrderApi* | [**get_auto_order_by_reference_order_id**](docs/AutoOrderApi.md#get_auto_order_by_reference_order_id) | **GET** /auto_order/auto_orders/reference_order_id/{reference_order_id} | Retrieve an auto order by order id
|
100
94
|
*UltracartClient::AutoOrderApi* | [**get_auto_orders**](docs/AutoOrderApi.md#get_auto_orders) | **GET** /auto_order/auto_orders | Retrieve auto orders
|
101
95
|
*UltracartClient::AutoOrderApi* | [**get_auto_orders_batch**](docs/AutoOrderApi.md#get_auto_orders_batch) | **POST** /auto_order/auto_orders/batch | Retrieve auto order batch
|
102
|
-
*UltracartClient::AutoOrderApi* | [**get_auto_orders_by_query**](docs/AutoOrderApi.md#get_auto_orders_by_query) | **POST** /auto_order/auto_orders/query | Retrieve auto orders
|
96
|
+
*UltracartClient::AutoOrderApi* | [**get_auto_orders_by_query**](docs/AutoOrderApi.md#get_auto_orders_by_query) | **POST** /auto_order/auto_orders/query | Retrieve auto orders by query
|
103
97
|
*UltracartClient::AutoOrderApi* | [**update_auto_order**](docs/AutoOrderApi.md#update_auto_order) | **PUT** /auto_order/auto_orders/{auto_order_oid} | Update an auto order
|
104
98
|
*UltracartClient::AutoOrderApi* | [**update_auto_orders_batch**](docs/AutoOrderApi.md#update_auto_orders_batch) | **PUT** /auto_order/auto_orders/batch | Update multiple auto orders
|
105
99
|
*UltracartClient::ChargebackApi* | [**delete_chargeback**](docs/ChargebackApi.md#delete_chargeback) | **DELETE** /chargeback/chargebacks/{chargeback_dispute_oid} | Delete a chargeback
|
@@ -147,14 +141,17 @@ Class | Method | HTTP request | Description
|
|
147
141
|
*UltracartClient::CouponApi* | [**upload_coupon_codes**](docs/CouponApi.md#upload_coupon_codes) | **POST** /coupon/coupons/{coupon_oid}/upload_codes | Upload one-time codes for a coupon
|
148
142
|
*UltracartClient::CustomerApi* | [**delete_customer**](docs/CustomerApi.md#delete_customer) | **DELETE** /customer/customers/{customer_profile_oid} | Delete a customer
|
149
143
|
*UltracartClient::CustomerApi* | [**get_customer**](docs/CustomerApi.md#get_customer) | **GET** /customer/customers/{customer_profile_oid} | Retrieve a customer
|
144
|
+
*UltracartClient::CustomerApi* | [**get_customer_by_email**](docs/CustomerApi.md#get_customer_by_email) | **GET** /customer/customers/by_email/{email} | Retrieve a customer by Email
|
150
145
|
*UltracartClient::CustomerApi* | [**get_customers**](docs/CustomerApi.md#get_customers) | **GET** /customer/customers | Retrieve customers
|
151
146
|
*UltracartClient::CustomerApi* | [**get_customers_by_query**](docs/CustomerApi.md#get_customers_by_query) | **POST** /customer/customers/query | Retrieve customers by query
|
152
147
|
*UltracartClient::CustomerApi* | [**get_customers_for_data_tables**](docs/CustomerApi.md#get_customers_for_data_tables) | **POST** /customer/customers/dataTables | Retrieve customers for DataTables plugin
|
153
148
|
*UltracartClient::CustomerApi* | [**get_editor_values**](docs/CustomerApi.md#get_editor_values) | **GET** /customer/editor_values | Retrieve values needed for a customer profile editor
|
154
149
|
*UltracartClient::CustomerApi* | [**get_email_lists**](docs/CustomerApi.md#get_email_lists) | **GET** /customer/email_lists | Retrieve all email lists across all storefronts
|
150
|
+
*UltracartClient::CustomerApi* | [**get_email_verification_token**](docs/CustomerApi.md#get_email_verification_token) | **POST** /customer/customers/email_verify/get_token | Create a token that can be used to verify a customer email address
|
155
151
|
*UltracartClient::CustomerApi* | [**insert_customer**](docs/CustomerApi.md#insert_customer) | **POST** /customer/customers | Insert a customer
|
156
152
|
*UltracartClient::CustomerApi* | [**update_customer**](docs/CustomerApi.md#update_customer) | **PUT** /customer/customers/{customer_profile_oid} | Update a customer
|
157
153
|
*UltracartClient::CustomerApi* | [**update_customer_email_lists**](docs/CustomerApi.md#update_customer_email_lists) | **POST** /customer/customers/{customer_profile_oid}/email_lists | Update email list subscriptions for a customer
|
154
|
+
*UltracartClient::CustomerApi* | [**validate_email_verification_token**](docs/CustomerApi.md#validate_email_verification_token) | **POST** /customer/customers/email_verify/validate_token | Validate a token that can be used to verify a customer email address
|
158
155
|
*UltracartClient::FulfillmentApi* | [**acknowledge_orders**](docs/FulfillmentApi.md#acknowledge_orders) | **PUT** /fulfillment/distribution_centers/{distribution_center_code}/acknowledgements | Acknowledge receipt of orders.
|
159
156
|
*UltracartClient::FulfillmentApi* | [**get_distribution_center_orders**](docs/FulfillmentApi.md#get_distribution_center_orders) | **GET** /fulfillment/distribution_centers/{distribution_center_code}/orders | Retrieve orders queued up for this distribution center.
|
160
157
|
*UltracartClient::FulfillmentApi* | [**get_distribution_centers**](docs/FulfillmentApi.md#get_distribution_centers) | **GET** /fulfillment/distribution_centers | Retrieve distribution centers
|
@@ -182,7 +179,7 @@ Class | Method | HTTP request | Description
|
|
182
179
|
*UltracartClient::OrderApi* | [**get_order_by_token**](docs/OrderApi.md#get_order_by_token) | **POST** /order/orders/token | Retrieve an order using a token
|
183
180
|
*UltracartClient::OrderApi* | [**get_orders**](docs/OrderApi.md#get_orders) | **GET** /order/orders | Retrieve orders
|
184
181
|
*UltracartClient::OrderApi* | [**get_orders_batch**](docs/OrderApi.md#get_orders_batch) | **POST** /order/orders/batch | Retrieve order batch
|
185
|
-
*UltracartClient::OrderApi* | [**get_orders_by_query**](docs/OrderApi.md#get_orders_by_query) | **POST** /order/orders/query | Retrieve orders
|
182
|
+
*UltracartClient::OrderApi* | [**get_orders_by_query**](docs/OrderApi.md#get_orders_by_query) | **POST** /order/orders/query | Retrieve orders by query
|
186
183
|
*UltracartClient::OrderApi* | [**insert_order**](docs/OrderApi.md#insert_order) | **POST** /order/orders | Insert an order
|
187
184
|
*UltracartClient::OrderApi* | [**process_payment**](docs/OrderApi.md#process_payment) | **POST** /order/orders/{order_id}/process_payment | Process payment
|
188
185
|
*UltracartClient::OrderApi* | [**refund_order**](docs/OrderApi.md#refund_order) | **PUT** /order/orders/{order_id}/refund | Refund an order
|
@@ -671,6 +668,10 @@ Class | Method | HTTP request | Description
|
|
671
668
|
- [UltracartClient::EmailThirdPartyListImportRequest](docs/EmailThirdPartyListImportRequest.md)
|
672
669
|
- [UltracartClient::EmailThirdPartyProvider](docs/EmailThirdPartyProvider.md)
|
673
670
|
- [UltracartClient::EmailThirdPartyProvidersResponse](docs/EmailThirdPartyProvidersResponse.md)
|
671
|
+
- [UltracartClient::EmailVerifyTokenRequest](docs/EmailVerifyTokenRequest.md)
|
672
|
+
- [UltracartClient::EmailVerifyTokenResponse](docs/EmailVerifyTokenResponse.md)
|
673
|
+
- [UltracartClient::EmailVerifyTokenValidateRequest](docs/EmailVerifyTokenValidateRequest.md)
|
674
|
+
- [UltracartClient::EmailVerifyTokenValidateResponse](docs/EmailVerifyTokenValidateResponse.md)
|
674
675
|
- [UltracartClient::Error](docs/Error.md)
|
675
676
|
- [UltracartClient::ErrorResponse](docs/ErrorResponse.md)
|
676
677
|
- [UltracartClient::Experiment](docs/Experiment.md)
|
@@ -1001,6 +1002,10 @@ Not every change is committed to every SDK.
|
|
1001
1002
|
|
1002
1003
|
| Version | Date | Comments |
|
1003
1004
|
| --: | :-: | --- |
|
1005
|
+
| 3.1.3 | 02/11/2021 | Bug Fix: wrong return type on CustomerApi.validateEmailVerificationToken |
|
1006
|
+
| 3.1.2 | 02/11/2021 | CustomerApi.getEmailVerificationToken, CustomerApi.validateEmailVerificationToken added to allow for custom email verification. Also added favorite flag to screen recording object |
|
1007
|
+
| 3.1.1 | 02/10/2021 | CustomerApi.getCustomerByEmail() method added |
|
1008
|
+
| 3.1.0 | 02/10/2021 | Minor revision jump. Added new convenience methods for simple_key use to all api calls. Updated docs |
|
1004
1009
|
| 3.0.75 | 02/01/2021 | StoreFront Communication plan revision (internal use) |
|
1005
1010
|
| 3.0.71 | 01/28/2021 | BugFix: PHP SDK retry logic NPE |
|
1006
1011
|
| 3.0.70 | 01/26/2021 | Checkout return URL support |
|
data/docs/AffiliateApi.md
CHANGED
@@ -19,18 +19,11 @@ Retrieves a group of clicks from the account based on a query object. If no par
|
|
19
19
|
```ruby
|
20
20
|
# load the gem
|
21
21
|
require 'ultracart_api'
|
22
|
-
# setup authorization
|
23
|
-
UltracartClient.configure do |config|
|
24
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
25
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
26
|
-
|
27
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
28
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
29
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
30
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
31
|
-
end
|
32
22
|
|
33
|
-
|
23
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
24
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
25
|
+
api_instance = UltracartClient::AffiliateApi.new_using_api_key(simple_key, false, false)
|
26
|
+
|
34
27
|
|
35
28
|
click_query = UltracartClient::AffiliateClickQuery.new # AffiliateClickQuery | Click query
|
36
29
|
|
@@ -84,18 +77,11 @@ Retrieves a group of ledger entries from the account based on a query object. I
|
|
84
77
|
```ruby
|
85
78
|
# load the gem
|
86
79
|
require 'ultracart_api'
|
87
|
-
# setup authorization
|
88
|
-
UltracartClient.configure do |config|
|
89
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
90
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
91
|
-
|
92
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
93
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
94
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
95
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
96
|
-
end
|
97
80
|
|
98
|
-
|
81
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
82
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
83
|
+
api_instance = UltracartClient::AffiliateApi.new_using_api_key(simple_key, false, false)
|
84
|
+
|
99
85
|
|
100
86
|
ledger_query = UltracartClient::AffiliateLedgerQuery.new # AffiliateLedgerQuery | Ledger query
|
101
87
|
|
data/docs/AutoOrderApi.md
CHANGED
@@ -4,12 +4,12 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
|
-
[**get_auto_order**](AutoOrderApi.md#get_auto_order) | **GET** /auto_order/auto_orders/{auto_order_oid} | Retrieve an auto order
|
8
|
-
[**get_auto_order_by_code**](AutoOrderApi.md#get_auto_order_by_code) | **GET** /auto_order/auto_orders/code/{auto_order_code} | Retrieve an auto order
|
9
|
-
[**get_auto_order_by_reference_order_id**](AutoOrderApi.md#get_auto_order_by_reference_order_id) | **GET** /auto_order/auto_orders/reference_order_id/{reference_order_id} | Retrieve an auto order
|
7
|
+
[**get_auto_order**](AutoOrderApi.md#get_auto_order) | **GET** /auto_order/auto_orders/{auto_order_oid} | Retrieve an auto order by oid
|
8
|
+
[**get_auto_order_by_code**](AutoOrderApi.md#get_auto_order_by_code) | **GET** /auto_order/auto_orders/code/{auto_order_code} | Retrieve an auto order by code
|
9
|
+
[**get_auto_order_by_reference_order_id**](AutoOrderApi.md#get_auto_order_by_reference_order_id) | **GET** /auto_order/auto_orders/reference_order_id/{reference_order_id} | Retrieve an auto order by order id
|
10
10
|
[**get_auto_orders**](AutoOrderApi.md#get_auto_orders) | **GET** /auto_order/auto_orders | Retrieve auto orders
|
11
11
|
[**get_auto_orders_batch**](AutoOrderApi.md#get_auto_orders_batch) | **POST** /auto_order/auto_orders/batch | Retrieve auto order batch
|
12
|
-
[**get_auto_orders_by_query**](AutoOrderApi.md#get_auto_orders_by_query) | **POST** /auto_order/auto_orders/query | Retrieve auto orders
|
12
|
+
[**get_auto_orders_by_query**](AutoOrderApi.md#get_auto_orders_by_query) | **POST** /auto_order/auto_orders/query | Retrieve auto orders by query
|
13
13
|
[**update_auto_order**](AutoOrderApi.md#update_auto_order) | **PUT** /auto_order/auto_orders/{auto_order_oid} | Update an auto order
|
14
14
|
[**update_auto_orders_batch**](AutoOrderApi.md#update_auto_orders_batch) | **PUT** /auto_order/auto_orders/batch | Update multiple auto orders
|
15
15
|
|
@@ -17,7 +17,7 @@ Method | HTTP request | Description
|
|
17
17
|
# **get_auto_order**
|
18
18
|
> AutoOrderResponse get_auto_order(auto_order_oid, opts)
|
19
19
|
|
20
|
-
Retrieve an auto order
|
20
|
+
Retrieve an auto order by oid
|
21
21
|
|
22
22
|
Retrieves a single auto order using the specified auto order oid.
|
23
23
|
|
@@ -25,18 +25,11 @@ Retrieves a single auto order using the specified auto order oid.
|
|
25
25
|
```ruby
|
26
26
|
# load the gem
|
27
27
|
require 'ultracart_api'
|
28
|
-
# setup authorization
|
29
|
-
UltracartClient.configure do |config|
|
30
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
31
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
32
|
-
|
33
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
34
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
35
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
36
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
37
|
-
end
|
38
28
|
|
39
|
-
|
29
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
30
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
31
|
+
api_instance = UltracartClient::AutoOrderApi.new_using_api_key(simple_key, false, false)
|
32
|
+
|
40
33
|
|
41
34
|
auto_order_oid = 56 # Integer | The auto order oid to retrieve.
|
42
35
|
|
@@ -45,7 +38,7 @@ opts = {
|
|
45
38
|
}
|
46
39
|
|
47
40
|
begin
|
48
|
-
#Retrieve an auto order
|
41
|
+
#Retrieve an auto order by oid
|
49
42
|
result = api_instance.get_auto_order(auto_order_oid, opts)
|
50
43
|
p result
|
51
44
|
rescue UltracartClient::ApiError => e
|
@@ -78,7 +71,7 @@ Name | Type | Description | Notes
|
|
78
71
|
# **get_auto_order_by_code**
|
79
72
|
> AutoOrderResponse get_auto_order_by_code(auto_order_code, opts)
|
80
73
|
|
81
|
-
Retrieve an auto order
|
74
|
+
Retrieve an auto order by code
|
82
75
|
|
83
76
|
Retrieves a single auto order using the specified reference (original) order id.
|
84
77
|
|
@@ -86,18 +79,11 @@ Retrieves a single auto order using the specified reference (original) order id.
|
|
86
79
|
```ruby
|
87
80
|
# load the gem
|
88
81
|
require 'ultracart_api'
|
89
|
-
# setup authorization
|
90
|
-
UltracartClient.configure do |config|
|
91
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
92
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
93
|
-
|
94
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
95
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
96
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
97
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
98
|
-
end
|
99
82
|
|
100
|
-
|
83
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
84
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
85
|
+
api_instance = UltracartClient::AutoOrderApi.new_using_api_key(simple_key, false, false)
|
86
|
+
|
101
87
|
|
102
88
|
auto_order_code = 'auto_order_code_example' # String | The auto order oid to retrieve.
|
103
89
|
|
@@ -106,7 +92,7 @@ opts = {
|
|
106
92
|
}
|
107
93
|
|
108
94
|
begin
|
109
|
-
#Retrieve an auto order
|
95
|
+
#Retrieve an auto order by code
|
110
96
|
result = api_instance.get_auto_order_by_code(auto_order_code, opts)
|
111
97
|
p result
|
112
98
|
rescue UltracartClient::ApiError => e
|
@@ -139,7 +125,7 @@ Name | Type | Description | Notes
|
|
139
125
|
# **get_auto_order_by_reference_order_id**
|
140
126
|
> AutoOrderResponse get_auto_order_by_reference_order_id(reference_order_id, opts)
|
141
127
|
|
142
|
-
Retrieve an auto order
|
128
|
+
Retrieve an auto order by order id
|
143
129
|
|
144
130
|
Retrieves a single auto order using the specified reference (original) order id.
|
145
131
|
|
@@ -147,18 +133,11 @@ Retrieves a single auto order using the specified reference (original) order id.
|
|
147
133
|
```ruby
|
148
134
|
# load the gem
|
149
135
|
require 'ultracart_api'
|
150
|
-
# setup authorization
|
151
|
-
UltracartClient.configure do |config|
|
152
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
153
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
154
|
-
|
155
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
156
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
157
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
158
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
159
|
-
end
|
160
136
|
|
161
|
-
|
137
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
138
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
139
|
+
api_instance = UltracartClient::AutoOrderApi.new_using_api_key(simple_key, false, false)
|
140
|
+
|
162
141
|
|
163
142
|
reference_order_id = 'reference_order_id_example' # String | The auto order oid to retrieve.
|
164
143
|
|
@@ -167,7 +146,7 @@ opts = {
|
|
167
146
|
}
|
168
147
|
|
169
148
|
begin
|
170
|
-
#Retrieve an auto order
|
149
|
+
#Retrieve an auto order by order id
|
171
150
|
result = api_instance.get_auto_order_by_reference_order_id(reference_order_id, opts)
|
172
151
|
p result
|
173
152
|
rescue UltracartClient::ApiError => e
|
@@ -208,18 +187,11 @@ Retrieves auto orders from the account. If no parameters are specified, all aut
|
|
208
187
|
```ruby
|
209
188
|
# load the gem
|
210
189
|
require 'ultracart_api'
|
211
|
-
# setup authorization
|
212
|
-
UltracartClient.configure do |config|
|
213
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
214
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
215
|
-
|
216
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
217
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
218
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
219
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
220
|
-
end
|
221
190
|
|
222
|
-
|
191
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
192
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
193
|
+
api_instance = UltracartClient::AutoOrderApi.new_using_api_key(simple_key, false, false)
|
194
|
+
|
223
195
|
|
224
196
|
opts = {
|
225
197
|
auto_order_code: 'auto_order_code_example', # String | Auto order code
|
@@ -310,18 +282,11 @@ Retrieves a group of auto orders from the account based on an array of auto orde
|
|
310
282
|
```ruby
|
311
283
|
# load the gem
|
312
284
|
require 'ultracart_api'
|
313
|
-
# setup authorization
|
314
|
-
UltracartClient.configure do |config|
|
315
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
316
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
317
|
-
|
318
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
319
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
320
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
321
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
322
|
-
end
|
323
285
|
|
324
|
-
|
286
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
287
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
288
|
+
api_instance = UltracartClient::AutoOrderApi.new_using_api_key(simple_key, false, false)
|
289
|
+
|
325
290
|
|
326
291
|
auto_order_batch = UltracartClient::AutoOrderQueryBatch.new # AutoOrderQueryBatch | Auto order batch
|
327
292
|
|
@@ -363,7 +328,7 @@ Name | Type | Description | Notes
|
|
363
328
|
# **get_auto_orders_by_query**
|
364
329
|
> AutoOrdersResponse get_auto_orders_by_query(auto_order_query, opts)
|
365
330
|
|
366
|
-
Retrieve auto orders
|
331
|
+
Retrieve auto orders by query
|
367
332
|
|
368
333
|
Retrieves a group of auto orders from the account based on a query object. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
|
369
334
|
|
@@ -371,18 +336,11 @@ Retrieves a group of auto orders from the account based on a query object. You
|
|
371
336
|
```ruby
|
372
337
|
# load the gem
|
373
338
|
require 'ultracart_api'
|
374
|
-
# setup authorization
|
375
|
-
UltracartClient.configure do |config|
|
376
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
377
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
378
|
-
|
379
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
380
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
381
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
382
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
383
|
-
end
|
384
339
|
|
385
|
-
|
340
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
341
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
342
|
+
api_instance = UltracartClient::AutoOrderApi.new_using_api_key(simple_key, false, false)
|
343
|
+
|
386
344
|
|
387
345
|
auto_order_query = UltracartClient::AutoOrderQuery.new # AutoOrderQuery | Auto order query
|
388
346
|
|
@@ -394,7 +352,7 @@ opts = {
|
|
394
352
|
}
|
395
353
|
|
396
354
|
begin
|
397
|
-
#Retrieve auto orders
|
355
|
+
#Retrieve auto orders by query
|
398
356
|
result = api_instance.get_auto_orders_by_query(auto_order_query, opts)
|
399
357
|
p result
|
400
358
|
rescue UltracartClient::ApiError => e
|
@@ -438,18 +396,11 @@ Update an auto order on the UltraCart account.
|
|
438
396
|
```ruby
|
439
397
|
# load the gem
|
440
398
|
require 'ultracart_api'
|
441
|
-
# setup authorization
|
442
|
-
UltracartClient.configure do |config|
|
443
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
444
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
445
|
-
|
446
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
447
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
448
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
449
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
450
|
-
end
|
451
399
|
|
452
|
-
|
400
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
401
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
402
|
+
api_instance = UltracartClient::AutoOrderApi.new_using_api_key(simple_key, false, false)
|
403
|
+
|
453
404
|
|
454
405
|
auto_order = UltracartClient::AutoOrder.new # AutoOrder | Auto order to update
|
455
406
|
|
@@ -502,18 +453,11 @@ Update multiple auto orders on the UltraCart account.
|
|
502
453
|
```ruby
|
503
454
|
# load the gem
|
504
455
|
require 'ultracart_api'
|
505
|
-
# setup authorization
|
506
|
-
UltracartClient.configure do |config|
|
507
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
508
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
509
|
-
|
510
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
511
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
512
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
513
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
514
|
-
end
|
515
456
|
|
516
|
-
|
457
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
458
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
459
|
+
api_instance = UltracartClient::AutoOrderApi.new_using_api_key(simple_key, false, false)
|
460
|
+
|
517
461
|
|
518
462
|
auto_orders_request = UltracartClient::AutoOrdersRequest.new # AutoOrdersRequest | Auto orders to update (synchronous maximum 20 / asynchronous maximum 100)
|
519
463
|
|
data/docs/ChargebackApi.md
CHANGED
@@ -22,18 +22,11 @@ Delete a chargeback on the UltraCart account.
|
|
22
22
|
```ruby
|
23
23
|
# load the gem
|
24
24
|
require 'ultracart_api'
|
25
|
-
# setup authorization
|
26
|
-
UltracartClient.configure do |config|
|
27
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
28
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
29
|
-
|
30
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
31
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
32
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
33
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
34
|
-
end
|
35
25
|
|
36
|
-
|
26
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
27
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
28
|
+
api_instance = UltracartClient::ChargebackApi.new_using_api_key(simple_key, false, false)
|
29
|
+
|
37
30
|
|
38
31
|
chargeback_dispute_oid = 56 # Integer | The chargeback_dispute_oid to delete.
|
39
32
|
|
@@ -79,18 +72,11 @@ Retrieves a single chargeback using the specified chargeback dispute oid.
|
|
79
72
|
```ruby
|
80
73
|
# load the gem
|
81
74
|
require 'ultracart_api'
|
82
|
-
# setup authorization
|
83
|
-
UltracartClient.configure do |config|
|
84
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
85
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
86
|
-
|
87
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
88
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
89
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
90
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
91
|
-
end
|
92
75
|
|
93
|
-
|
76
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
77
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
78
|
+
api_instance = UltracartClient::ChargebackApi.new_using_api_key(simple_key, false, false)
|
79
|
+
|
94
80
|
|
95
81
|
chargeback_dispute_oid = 56 # Integer | The chargeback dispute oid to retrieve.
|
96
82
|
|
@@ -140,18 +126,11 @@ Retrieves chargebacks from the account. If no parameters are specified, all cha
|
|
140
126
|
```ruby
|
141
127
|
# load the gem
|
142
128
|
require 'ultracart_api'
|
143
|
-
# setup authorization
|
144
|
-
UltracartClient.configure do |config|
|
145
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
146
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
147
|
-
|
148
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
149
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
150
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
151
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
152
|
-
end
|
153
129
|
|
154
|
-
|
130
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
131
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
132
|
+
api_instance = UltracartClient::ChargebackApi.new_using_api_key(simple_key, false, false)
|
133
|
+
|
155
134
|
|
156
135
|
opts = {
|
157
136
|
order_id: 'order_id_example', # String | Order Id
|
@@ -220,18 +199,11 @@ Insert a chargeback on the UltraCart account.
|
|
220
199
|
```ruby
|
221
200
|
# load the gem
|
222
201
|
require 'ultracart_api'
|
223
|
-
# setup authorization
|
224
|
-
UltracartClient.configure do |config|
|
225
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
226
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
227
|
-
|
228
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
229
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
230
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
231
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
232
|
-
end
|
233
202
|
|
234
|
-
|
203
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
204
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
205
|
+
api_instance = UltracartClient::ChargebackApi.new_using_api_key(simple_key, false, false)
|
206
|
+
|
235
207
|
|
236
208
|
chargeback = UltracartClient::ChargebackDispute.new # ChargebackDispute | Chargeback to insert
|
237
209
|
|
@@ -281,18 +253,11 @@ Update a chargeback on the UltraCart account.
|
|
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::ChargebackApi.new_using_api_key(simple_key, false, false)
|
260
|
+
|
296
261
|
|
297
262
|
chargeback = UltracartClient::ChargebackDispute.new # ChargebackDispute | Chargeback to update
|
298
263
|
|