ultracart_api 4.0.32.rc → 4.0.35.rc

Sign up to get free protection for your applications and to get access to all the features.
Files changed (48) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +25 -4
  3. data/docs/Activity.md +4 -0
  4. data/docs/AffiliateApi.md +16 -22
  5. data/docs/AutoOrderApi.md +64 -88
  6. data/docs/ChannelPartnerApi.md +40 -55
  7. data/docs/ChargebackApi.md +40 -55
  8. data/docs/CheckoutApi.md +152 -294
  9. data/docs/Conversation.md +26 -0
  10. data/docs/ConversationAgentAuthResponse.md +22 -0
  11. data/docs/ConversationApi.md +438 -0
  12. data/docs/ConversationMessage.md +26 -0
  13. data/docs/ConversationParticipant.md +30 -0
  14. data/docs/ConversationStartRequest.md +20 -0
  15. data/docs/ConversationStartResponse.md +20 -0
  16. data/docs/ConversationSummary.md +34 -0
  17. data/docs/ConversationsResponse.md +26 -0
  18. data/docs/CouponApi.md +152 -209
  19. data/docs/CustomerActivity.md +9 -1
  20. data/docs/CustomerApi.md +213 -192
  21. data/docs/CustomerMergeRequest.md +20 -0
  22. data/docs/FulfillmentApi.md +48 -66
  23. data/docs/GiftCertificateApi.md +64 -88
  24. data/docs/IntegrationLogApi.md +40 -55
  25. data/docs/ItemApi.md +72 -99
  26. data/docs/OauthApi.md +16 -32
  27. data/docs/OrderApi.md +184 -253
  28. data/docs/SsoApi.md +32 -44
  29. data/docs/StorefrontApi.md +1134 -2345
  30. data/docs/TaxApi.md +224 -308
  31. data/docs/UserApi.md +88 -121
  32. data/docs/WebhookApi.md +64 -88
  33. data/lib/ultracart_api/api/conversation_api.rb +418 -0
  34. data/lib/ultracart_api/api/customer_api.rb +78 -0
  35. data/lib/ultracart_api/models/activity.rb +19 -1
  36. data/lib/ultracart_api/models/conversation.rb +259 -0
  37. data/lib/ultracart_api/models/conversation_agent_auth_response.rb +237 -0
  38. data/lib/ultracart_api/models/conversation_message.rb +258 -0
  39. data/lib/ultracart_api/models/conversation_participant.rb +276 -0
  40. data/lib/ultracart_api/models/conversation_start_request.rb +230 -0
  41. data/lib/ultracart_api/models/conversation_start_response.rb +228 -0
  42. data/lib/ultracart_api/models/conversation_summary.rb +292 -0
  43. data/lib/ultracart_api/models/conversations_response.rb +258 -0
  44. data/lib/ultracart_api/models/customer_activity.rb +40 -4
  45. data/lib/ultracart_api/models/customer_merge_request.rb +230 -0
  46. data/lib/ultracart_api/version.rb +1 -1
  47. data/lib/ultracart_api.rb +10 -0
  48. metadata +22 -2
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: fcd318eb8ea140e95de80e25c0feed0d8edee99c252f0dd9fdec7104d5c0d01b
4
- data.tar.gz: bbf7d6d9b0ac4c7098189925192492f1e46bede34c111a5fa0f6dbaf855842ce
3
+ metadata.gz: ec0b15ab8f5732d2610da8f17630a375777626f69578ccaba758538d2bdaefab
4
+ data.tar.gz: 59036a582ba2f6b3de969236a82a036da124931e5847fd4435cb84c3ed1ebb1d
5
5
  SHA512:
6
- metadata.gz: 21838df1402992721ed0407bf16e92a938fbef18e9689d507e31a905d68a53d65b109f41eb255056f6e7592cb6016fecf4c667d48668560ae561bd44ae564826
7
- data.tar.gz: ec4986c80a8113f7ef3595895d9646f351dec18e356c8310ec0221e88a0871bb059ee1bd5cac6c1f4146cb143c2470427e9c79b179c5c73bd28cb2fd4fd37ec0
6
+ metadata.gz: c4dbbce61f74ff85c83a3c30b8ca3a6ff25fdd382375b39470685f1633520ad2a19c05e4430cadab55a624beea3cf0ceec89f32fbc2eeda22cd08ef08b0f26bd
7
+ data.tar.gz: 99771aa3cdd92f851f5556e5f1fd78194ad01562ba7b91b3a5ac99a3b6488d0ed6aab3cf8986c0152e6a19fff6819f1cb24e0f2daebf102a8885eef98530d191
data/README.md CHANGED
@@ -7,7 +7,7 @@ UltraCart REST API Version 2
7
7
  This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
8
8
 
9
9
  - API version: 2.0.0
10
- - Package version: 4.0.32.rc
10
+ - Package version: 4.0.35.rc
11
11
  - Build package: org.openapitools.codegen.languages.RubyClientCodegen
12
12
  For more information, please visit [http://www.ultracart.com](http://www.ultracart.com)
13
13
 
@@ -24,16 +24,16 @@ gem build ultracart_api.gemspec
24
24
  Then either install the gem locally:
25
25
 
26
26
  ```shell
27
- gem install ./ultracart_api-4.0.32.rc.gem
27
+ gem install ./ultracart_api-4.0.35.rc.gem
28
28
  ```
29
29
 
30
- (for development, run `gem install --dev ./ultracart_api-4.0.32.rc.gem` to install the development dependencies)
30
+ (for development, run `gem install --dev ./ultracart_api-4.0.35.rc.gem` to install the development dependencies)
31
31
 
32
32
  or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
33
33
 
34
34
  Finally add this to the Gemfile:
35
35
 
36
- gem 'ultracart_api', '~> 4.0.32.rc'
36
+ gem 'ultracart_api', '~> 4.0.35.rc'
37
37
 
38
38
  ### Install from Git
39
39
 
@@ -131,6 +131,12 @@ Class | Method | HTTP request | Description
131
131
  *UltracartClient::CheckoutApi* | [**setup_browser_key**](docs/CheckoutApi.md#setup_browser_key) | **PUT** /checkout/browser_key | Setup Browser Application
132
132
  *UltracartClient::CheckoutApi* | [**update_cart**](docs/CheckoutApi.md#update_cart) | **PUT** /checkout/cart | Update cart
133
133
  *UltracartClient::CheckoutApi* | [**validate_cart**](docs/CheckoutApi.md#validate_cart) | **POST** /checkout/cart/validate | Validate
134
+ *UltracartClient::ConversationApi* | [**get_agent_websocket_authorization**](docs/ConversationApi.md#get_agent_websocket_authorization) | **PUT** /conversation/agent/auth | Get agent websocket authorization
135
+ *UltracartClient::ConversationApi* | [**get_conversation**](docs/ConversationApi.md#get_conversation) | **GET** /conversation/conversations/{conversation_uuid} | Retrieve a conversation
136
+ *UltracartClient::ConversationApi* | [**get_conversations**](docs/ConversationApi.md#get_conversations) | **GET** /conversation/conversations | Retrieve a list of conversation summaries newest to oldest
137
+ *UltracartClient::ConversationApi* | [**join_conversation**](docs/ConversationApi.md#join_conversation) | **PUT** /conversation/conversations/{conversation_uuid}/join | Join a conversation
138
+ *UltracartClient::ConversationApi* | [**leave_conversation**](docs/ConversationApi.md#leave_conversation) | **DELETE** /conversation/conversations/{conversation_uuid}/leave | Leave a conversation
139
+ *UltracartClient::ConversationApi* | [**start_conversation**](docs/ConversationApi.md#start_conversation) | **PUT** /conversation/conversations | Start a conversation
134
140
  *UltracartClient::CouponApi* | [**delete_coupon**](docs/CouponApi.md#delete_coupon) | **DELETE** /coupon/coupons/{coupon_oid} | Delete a coupon
135
141
  *UltracartClient::CouponApi* | [**delete_coupons_by_code**](docs/CouponApi.md#delete_coupons_by_code) | **DELETE** /coupon/coupons/by_code | Deletes multiple coupons
136
142
  *UltracartClient::CouponApi* | [**delete_coupons_by_oid**](docs/CouponApi.md#delete_coupons_by_oid) | **DELETE** /coupon/coupons/by_oid | Deletes multiple coupons
@@ -163,6 +169,7 @@ Class | Method | HTTP request | Description
163
169
  *UltracartClient::CustomerApi* | [**get_customers_for_data_tables**](docs/CustomerApi.md#get_customers_for_data_tables) | **POST** /customer/customers/dataTables | Retrieve customers for DataTables plugin
164
170
  *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
165
171
  *UltracartClient::CustomerApi* | [**insert_customer**](docs/CustomerApi.md#insert_customer) | **POST** /customer/customers | Insert a customer
172
+ *UltracartClient::CustomerApi* | [**merge_customer**](docs/CustomerApi.md#merge_customer) | **PUT** /customer/customers/{customer_profile_oid}/merge | Merge customer into this customer
166
173
  *UltracartClient::CustomerApi* | [**search_customer_profile_values**](docs/CustomerApi.md#search_customer_profile_values) | **POST** /customer/search | Searches for all matching values (using POST)
167
174
  *UltracartClient::CustomerApi* | [**update_customer**](docs/CustomerApi.md#update_customer) | **PUT** /customer/customers/{customer_profile_oid} | Update a customer
168
175
  *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
@@ -553,6 +560,14 @@ Class | Method | HTTP request | Description
553
560
  - [UltracartClient::CheckoutSetupBrowserKeyResponse](docs/CheckoutSetupBrowserKeyResponse.md)
554
561
  - [UltracartClient::CheckoutStateProvinceResponse](docs/CheckoutStateProvinceResponse.md)
555
562
  - [UltracartClient::CityStateZip](docs/CityStateZip.md)
563
+ - [UltracartClient::Conversation](docs/Conversation.md)
564
+ - [UltracartClient::ConversationAgentAuthResponse](docs/ConversationAgentAuthResponse.md)
565
+ - [UltracartClient::ConversationMessage](docs/ConversationMessage.md)
566
+ - [UltracartClient::ConversationParticipant](docs/ConversationParticipant.md)
567
+ - [UltracartClient::ConversationStartRequest](docs/ConversationStartRequest.md)
568
+ - [UltracartClient::ConversationStartResponse](docs/ConversationStartResponse.md)
569
+ - [UltracartClient::ConversationSummary](docs/ConversationSummary.md)
570
+ - [UltracartClient::ConversationsResponse](docs/ConversationsResponse.md)
556
571
  - [UltracartClient::CountriesResponse](docs/CountriesResponse.md)
557
572
  - [UltracartClient::Country](docs/Country.md)
558
573
  - [UltracartClient::Coupon](docs/Coupon.md)
@@ -630,6 +645,7 @@ Class | Method | HTTP request | Description
630
645
  - [UltracartClient::CustomerLoyalty](docs/CustomerLoyalty.md)
631
646
  - [UltracartClient::CustomerLoyaltyLedger](docs/CustomerLoyaltyLedger.md)
632
647
  - [UltracartClient::CustomerLoyaltyRedemption](docs/CustomerLoyaltyRedemption.md)
648
+ - [UltracartClient::CustomerMergeRequest](docs/CustomerMergeRequest.md)
633
649
  - [UltracartClient::CustomerOrdersSummary](docs/CustomerOrdersSummary.md)
634
650
  - [UltracartClient::CustomerPricingTier](docs/CustomerPricingTier.md)
635
651
  - [UltracartClient::CustomerPrivacy](docs/CustomerPrivacy.md)
@@ -1100,6 +1116,8 @@ Class | Method | HTTP request | Description
1100
1116
  - checkout_write: Allows you to write checkout information.
1101
1117
  - configuration_read: Allows you to read configuration information.
1102
1118
  - configuration_write: Allows you to write configuration information.
1119
+ - conversation_read: Allows you to read conversation information.
1120
+ - conversation_write: Allows you to write conversation information.
1103
1121
  - coupon_read: Allows you to read coupon information.
1104
1122
  - coupon_write: Allows you to write coupon information.
1105
1123
  - customer_read: Allows you to read customer information.
@@ -1140,6 +1158,9 @@ Not every change is committed to every SDK.
1140
1158
 
1141
1159
  | Version | Date | Comments |
1142
1160
  | --: | :-: | --- |
1161
+ | 4.0.35-RC | 07/14/2022 | Add channel storefront_oid to the customer activity record |
1162
+ | 4.0.34-RC | 07/11/2022 | Customer API - mergeCustomer method |
1163
+ | 4.0.33-RC | 07/05/2022 | docs update |
1143
1164
  | 4.0.32-RC | 06/24/2022 | removed unneeded consumes declarations on several api calls (yaml fix) |
1144
1165
  | 4.0.31-RC | 06/24/2022 | removed unneeded consumes declarations on several api calls (yaml fix) |
1145
1166
  | 4.0.30-RC | 06/24/2022 | removed unneeded consumes declarations on several api calls (yaml fix) |
data/docs/Activity.md CHANGED
@@ -5,7 +5,9 @@
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
7
  | **action** | **String** | | [optional] |
8
+ | **channel** | **String** | | [optional] |
8
9
  | **metric** | **String** | | [optional] |
10
+ | **storefront_oid** | **Integer** | | [optional] |
9
11
  | **subject** | **String** | | [optional] |
10
12
  | **ts** | **Integer** | | [optional] |
11
13
  | **type** | **String** | | [optional] |
@@ -18,7 +20,9 @@ require 'ultracart_api'
18
20
 
19
21
  instance = UltracartClient::Activity.new(
20
22
  action: null,
23
+ channel: null,
21
24
  metric: null,
25
+ storefront_oid: null,
22
26
  subject: null,
23
27
  ts: null,
24
28
  type: null,
data/docs/AffiliateApi.md CHANGED
@@ -21,18 +21,15 @@ Retrieves a group of clicks from the account based on a query object. If no par
21
21
  ```ruby
22
22
  require 'time'
23
23
  require 'ultracart_api'
24
- # setup authorization
25
- UltracartClient.configure do |config|
26
- # Configure OAuth2 access token for authorization: ultraCartOauth
27
- config.access_token = 'YOUR ACCESS TOKEN'
28
-
29
- # Configure API key authorization: ultraCartSimpleApiKey
30
- config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
31
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
32
- # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
33
- end
24
+ require 'json'
25
+ require 'yaml'
26
+ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
27
+
28
+ # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
29
+ # As such, this might not be the best way to use this object.
30
+ # Please see https://github.com/UltraCart/sdk_samples for working examples.
34
31
 
35
- api_instance = UltracartClient::AffiliateApi.new
32
+ api = UltracartClient::AffiliateApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
36
33
  click_query = UltracartClient::AffiliateClickQuery.new # AffiliateClickQuery | Click query
37
34
  opts = {
38
35
  _limit: 56, # Integer | The maximum number of records to return on this one API call. (Maximum 10000)
@@ -103,18 +100,15 @@ Retrieves a group of ledger entries from the account based on a query object. I
103
100
  ```ruby
104
101
  require 'time'
105
102
  require 'ultracart_api'
106
- # setup authorization
107
- UltracartClient.configure do |config|
108
- # Configure OAuth2 access token for authorization: ultraCartOauth
109
- config.access_token = 'YOUR ACCESS TOKEN'
110
-
111
- # Configure API key authorization: ultraCartSimpleApiKey
112
- config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
113
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
114
- # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
115
- end
103
+ require 'json'
104
+ require 'yaml'
105
+ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
106
+
107
+ # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
108
+ # As such, this might not be the best way to use this object.
109
+ # Please see https://github.com/UltraCart/sdk_samples for working examples.
116
110
 
117
- api_instance = UltracartClient::AffiliateApi.new
111
+ api = UltracartClient::AffiliateApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
118
112
  ledger_query = UltracartClient::AffiliateLedgerQuery.new # AffiliateLedgerQuery | Ledger query
119
113
  opts = {
120
114
  _limit: 56, # Integer | The maximum number of records to return on this one API call. (Maximum 200)
data/docs/AutoOrderApi.md CHANGED
@@ -27,18 +27,15 @@ Retrieves a single auto order using the specified auto order oid.
27
27
  ```ruby
28
28
  require 'time'
29
29
  require 'ultracart_api'
30
- # setup authorization
31
- UltracartClient.configure do |config|
32
- # Configure OAuth2 access token for authorization: ultraCartOauth
33
- config.access_token = 'YOUR ACCESS TOKEN'
34
-
35
- # Configure API key authorization: ultraCartSimpleApiKey
36
- config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
37
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
38
- # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
39
- end
30
+ require 'json'
31
+ require 'yaml'
32
+ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
33
+
34
+ # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
35
+ # As such, this might not be the best way to use this object.
36
+ # Please see https://github.com/UltraCart/sdk_samples for working examples.
40
37
 
41
- api_instance = UltracartClient::AutoOrderApi.new
38
+ api = UltracartClient::AutoOrderApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
42
39
  auto_order_oid = 56 # Integer | The auto order oid to retrieve.
43
40
  opts = {
44
41
  _expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
@@ -105,18 +102,15 @@ Retrieves a single auto order using the specified reference (original) order id.
105
102
  ```ruby
106
103
  require 'time'
107
104
  require 'ultracart_api'
108
- # setup authorization
109
- UltracartClient.configure do |config|
110
- # Configure OAuth2 access token for authorization: ultraCartOauth
111
- config.access_token = 'YOUR ACCESS TOKEN'
112
-
113
- # Configure API key authorization: ultraCartSimpleApiKey
114
- config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
115
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
116
- # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
117
- end
105
+ require 'json'
106
+ require 'yaml'
107
+ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
108
+
109
+ # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
110
+ # As such, this might not be the best way to use this object.
111
+ # Please see https://github.com/UltraCart/sdk_samples for working examples.
118
112
 
119
- api_instance = UltracartClient::AutoOrderApi.new
113
+ api = UltracartClient::AutoOrderApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
120
114
  auto_order_code = 'auto_order_code_example' # String | The auto order oid to retrieve.
121
115
  opts = {
122
116
  _expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
@@ -183,18 +177,15 @@ Retrieves a single auto order using the specified reference (original) order id.
183
177
  ```ruby
184
178
  require 'time'
185
179
  require 'ultracart_api'
186
- # setup authorization
187
- UltracartClient.configure do |config|
188
- # Configure OAuth2 access token for authorization: ultraCartOauth
189
- config.access_token = 'YOUR ACCESS TOKEN'
190
-
191
- # Configure API key authorization: ultraCartSimpleApiKey
192
- config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
193
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
194
- # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
195
- end
180
+ require 'json'
181
+ require 'yaml'
182
+ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
183
+
184
+ # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
185
+ # As such, this might not be the best way to use this object.
186
+ # Please see https://github.com/UltraCart/sdk_samples for working examples.
196
187
 
197
- api_instance = UltracartClient::AutoOrderApi.new
188
+ api = UltracartClient::AutoOrderApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
198
189
  reference_order_id = 'reference_order_id_example' # String | The auto order oid to retrieve.
199
190
  opts = {
200
191
  _expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
@@ -261,18 +252,15 @@ Retrieves auto orders from the account. If no parameters are specified, all aut
261
252
  ```ruby
262
253
  require 'time'
263
254
  require 'ultracart_api'
264
- # setup authorization
265
- UltracartClient.configure do |config|
266
- # Configure OAuth2 access token for authorization: ultraCartOauth
267
- config.access_token = 'YOUR ACCESS TOKEN'
268
-
269
- # Configure API key authorization: ultraCartSimpleApiKey
270
- config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
271
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
272
- # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
273
- end
255
+ require 'json'
256
+ require 'yaml'
257
+ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
258
+
259
+ # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
260
+ # As such, this might not be the best way to use this object.
261
+ # Please see https://github.com/UltraCart/sdk_samples for working examples.
274
262
 
275
- api_instance = UltracartClient::AutoOrderApi.new
263
+ api = UltracartClient::AutoOrderApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
276
264
  opts = {
277
265
  auto_order_code: 'auto_order_code_example', # String | Auto order code
278
266
  original_order_id: 'original_order_id_example', # String | Original order id
@@ -381,18 +369,15 @@ Retrieves a group of auto orders from the account based on an array of auto orde
381
369
  ```ruby
382
370
  require 'time'
383
371
  require 'ultracart_api'
384
- # setup authorization
385
- UltracartClient.configure do |config|
386
- # Configure OAuth2 access token for authorization: ultraCartOauth
387
- config.access_token = 'YOUR ACCESS TOKEN'
388
-
389
- # Configure API key authorization: ultraCartSimpleApiKey
390
- config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
391
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
392
- # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
393
- end
372
+ require 'json'
373
+ require 'yaml'
374
+ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
375
+
376
+ # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
377
+ # As such, this might not be the best way to use this object.
378
+ # Please see https://github.com/UltraCart/sdk_samples for working examples.
394
379
 
395
- api_instance = UltracartClient::AutoOrderApi.new
380
+ api = UltracartClient::AutoOrderApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
396
381
  auto_order_batch = UltracartClient::AutoOrderQueryBatch.new # AutoOrderQueryBatch | Auto order batch
397
382
  opts = {
398
383
  _expand: '_expand_example' # String | The object expansion to perform on the result.
@@ -459,18 +444,15 @@ Retrieves a group of auto orders from the account based on a query object. You
459
444
  ```ruby
460
445
  require 'time'
461
446
  require 'ultracart_api'
462
- # setup authorization
463
- UltracartClient.configure do |config|
464
- # Configure OAuth2 access token for authorization: ultraCartOauth
465
- config.access_token = 'YOUR ACCESS TOKEN'
466
-
467
- # Configure API key authorization: ultraCartSimpleApiKey
468
- config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
469
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
470
- # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
471
- end
447
+ require 'json'
448
+ require 'yaml'
449
+ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
450
+
451
+ # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
452
+ # As such, this might not be the best way to use this object.
453
+ # Please see https://github.com/UltraCart/sdk_samples for working examples.
472
454
 
473
- api_instance = UltracartClient::AutoOrderApi.new
455
+ api = UltracartClient::AutoOrderApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
474
456
  auto_order_query = UltracartClient::AutoOrderQuery.new # AutoOrderQuery | Auto order query
475
457
  opts = {
476
458
  _limit: 56, # Integer | The maximum number of records to return on this one API call. (Maximum 200)
@@ -543,18 +525,15 @@ Update an auto order on the UltraCart account.
543
525
  ```ruby
544
526
  require 'time'
545
527
  require 'ultracart_api'
546
- # setup authorization
547
- UltracartClient.configure do |config|
548
- # Configure OAuth2 access token for authorization: ultraCartOauth
549
- config.access_token = 'YOUR ACCESS TOKEN'
550
-
551
- # Configure API key authorization: ultraCartSimpleApiKey
552
- config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
553
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
554
- # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
555
- end
528
+ require 'json'
529
+ require 'yaml'
530
+ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
531
+
532
+ # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
533
+ # As such, this might not be the best way to use this object.
534
+ # Please see https://github.com/UltraCart/sdk_samples for working examples.
556
535
 
557
- api_instance = UltracartClient::AutoOrderApi.new
536
+ api = UltracartClient::AutoOrderApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
558
537
  auto_order_oid = 56 # Integer | The auto order oid to update.
559
538
  auto_order = UltracartClient::AutoOrder.new # AutoOrder | Auto order to update
560
539
  opts = {
@@ -623,18 +602,15 @@ Update multiple auto orders on the UltraCart account.
623
602
  ```ruby
624
603
  require 'time'
625
604
  require 'ultracart_api'
626
- # setup authorization
627
- UltracartClient.configure do |config|
628
- # Configure OAuth2 access token for authorization: ultraCartOauth
629
- config.access_token = 'YOUR ACCESS TOKEN'
630
-
631
- # Configure API key authorization: ultraCartSimpleApiKey
632
- config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
633
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
634
- # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
635
- end
605
+ require 'json'
606
+ require 'yaml'
607
+ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
608
+
609
+ # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
610
+ # As such, this might not be the best way to use this object.
611
+ # Please see https://github.com/UltraCart/sdk_samples for working examples.
636
612
 
637
- api_instance = UltracartClient::AutoOrderApi.new
613
+ api = UltracartClient::AutoOrderApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
638
614
  auto_orders_request = UltracartClient::AutoOrdersRequest.new # AutoOrdersRequest | Auto orders to update (synchronous maximum 20 / asynchronous maximum 100)
639
615
  opts = {
640
616
  _expand: '_expand_example', # String | The object expansion to perform on the result. See documentation for examples
@@ -24,18 +24,15 @@ Cancel channel partner order by channel partner order id
24
24
  ```ruby
25
25
  require 'time'
26
26
  require 'ultracart_api'
27
- # setup authorization
28
- UltracartClient.configure do |config|
29
- # Configure OAuth2 access token for authorization: ultraCartOauth
30
- config.access_token = 'YOUR ACCESS TOKEN'
31
-
32
- # Configure API key authorization: ultraCartSimpleApiKey
33
- config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
34
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
35
- # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
36
- end
27
+ require 'json'
28
+ require 'yaml'
29
+ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
30
+
31
+ # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
32
+ # As such, this might not be the best way to use this object.
33
+ # Please see https://github.com/UltraCart/sdk_samples for working examples.
37
34
 
38
- api_instance = UltracartClient::ChannelPartnerApi.new
35
+ api = UltracartClient::ChannelPartnerApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
39
36
  order_id = 'order_id_example' # String | The channel partner order id to delete.
40
37
 
41
38
  begin
@@ -98,18 +95,15 @@ Cancel channel partner order by UltraCart order id
98
95
  ```ruby
99
96
  require 'time'
100
97
  require 'ultracart_api'
101
- # setup authorization
102
- UltracartClient.configure do |config|
103
- # Configure OAuth2 access token for authorization: ultraCartOauth
104
- config.access_token = 'YOUR ACCESS TOKEN'
105
-
106
- # Configure API key authorization: ultraCartSimpleApiKey
107
- config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
108
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
109
- # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
110
- end
98
+ require 'json'
99
+ require 'yaml'
100
+ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
111
101
 
112
- api_instance = UltracartClient::ChannelPartnerApi.new
102
+ # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
103
+ # As such, this might not be the best way to use this object.
104
+ # Please see https://github.com/UltraCart/sdk_samples for working examples.
105
+
106
+ api = UltracartClient::ChannelPartnerApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
113
107
  order_id = 'order_id_example' # String | The UltraCart order id to delete.
114
108
 
115
109
  begin
@@ -172,18 +166,15 @@ Estimate shipping for order from a channel partner.
172
166
  ```ruby
173
167
  require 'time'
174
168
  require 'ultracart_api'
175
- # setup authorization
176
- UltracartClient.configure do |config|
177
- # Configure OAuth2 access token for authorization: ultraCartOauth
178
- config.access_token = 'YOUR ACCESS TOKEN'
179
-
180
- # Configure API key authorization: ultraCartSimpleApiKey
181
- config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
182
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
183
- # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
184
- end
169
+ require 'json'
170
+ require 'yaml'
171
+ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
185
172
 
186
- api_instance = UltracartClient::ChannelPartnerApi.new
173
+ # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
174
+ # As such, this might not be the best way to use this object.
175
+ # Please see https://github.com/UltraCart/sdk_samples for working examples.
176
+
177
+ api = UltracartClient::ChannelPartnerApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
187
178
  channel_partner_order = UltracartClient::ChannelPartnerOrder.new # ChannelPartnerOrder | Order needing shipping estimate
188
179
 
189
180
  begin
@@ -246,18 +237,15 @@ Estimate tax for order from a channel partner.
246
237
  ```ruby
247
238
  require 'time'
248
239
  require 'ultracart_api'
249
- # setup authorization
250
- UltracartClient.configure do |config|
251
- # Configure OAuth2 access token for authorization: ultraCartOauth
252
- config.access_token = 'YOUR ACCESS TOKEN'
253
-
254
- # Configure API key authorization: ultraCartSimpleApiKey
255
- config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
256
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
257
- # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
258
- end
240
+ require 'json'
241
+ require 'yaml'
242
+ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
243
+
244
+ # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
245
+ # As such, this might not be the best way to use this object.
246
+ # Please see https://github.com/UltraCart/sdk_samples for working examples.
259
247
 
260
- api_instance = UltracartClient::ChannelPartnerApi.new
248
+ api = UltracartClient::ChannelPartnerApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
261
249
  channel_partner_order = UltracartClient::ChannelPartnerOrder.new # ChannelPartnerOrder | Order needing tax estimate
262
250
 
263
251
  begin
@@ -320,18 +308,15 @@ Insert order from a channel partner.
320
308
  ```ruby
321
309
  require 'time'
322
310
  require 'ultracart_api'
323
- # setup authorization
324
- UltracartClient.configure do |config|
325
- # Configure OAuth2 access token for authorization: ultraCartOauth
326
- config.access_token = 'YOUR ACCESS TOKEN'
327
-
328
- # Configure API key authorization: ultraCartSimpleApiKey
329
- config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
330
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
331
- # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
332
- end
311
+ require 'json'
312
+ require 'yaml'
313
+ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
314
+
315
+ # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
316
+ # As such, this might not be the best way to use this object.
317
+ # Please see https://github.com/UltraCart/sdk_samples for working examples.
333
318
 
334
- api_instance = UltracartClient::ChannelPartnerApi.new
319
+ api = UltracartClient::ChannelPartnerApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
335
320
  channel_partner_order = UltracartClient::ChannelPartnerOrder.new # ChannelPartnerOrder | Order to insert
336
321
 
337
322
  begin