ultracart_api 3.11.57 → 3.11.58

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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 725ca91c0dd7cf015731d6e9c17e9c9fdcb2a4afb6e926367a2297abf23fe821
4
- data.tar.gz: c184dd0263f729eeb4691252cda7cb533d63912dcbc8a8c57aea0c7809d93e89
3
+ metadata.gz: 1544517bc089adac08a4db0063aa74360791d4b0fa88bca87cb6b41bde21ddbf
4
+ data.tar.gz: 8ae92db575c3dab039225679197ae6d83eede922879d89d3aa4191d54f9efcf7
5
5
  SHA512:
6
- metadata.gz: 2ef7f3eb26fc189b3b569e5e8af066f899edc641fa783fd5e8785c80940ddeaadfc9c72ba7d5805fdf13ea45ed4567fb4017e826da4c18b1f53502ec262fce48
7
- data.tar.gz: 7f58cffeaaf7b564db7b12c22e11ef018d67c0cb13a6230920d4760d12dd67212d0db1806b01836f07d4dc4fae358acbf5f2ae3b1414aebef4a97fd88093fe01
6
+ metadata.gz: 16f1333cf7b9ca1d432879fd747100eeb59e61fc69c4207b34239a19cd239c43ddd914d564aee7f0c01efd39694e33d5eeb092f8063ec00524246d2f7a5e45f0
7
+ data.tar.gz: 59957646047c5cb8f9b72d5480910920f5d9d0e6f9094bdeda2b202cc83e6afab101cb4e755d3ce02e5a2f25d3bcd24a92873cd170de23ab4c42598f3ee0d3f3
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.11.57
10
+ - Package version: 3.11.58
11
11
  - Build package: io.swagger.codegen.languages.RubyClientCodegen
12
12
  For more information, please visit [http://www.ultracart.com/api/](http://www.ultracart.com/api/)
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.11.57.gem
27
+ gem install ./ultracart_api-3.11.58.gem
28
28
  ```
29
- (for development, run `gem install --dev ./ultracart_api-3.11.57.gem` to install the development dependencies)
29
+ (for development, run `gem install --dev ./ultracart_api-3.11.58.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.11.57'
35
+ gem 'ultracart_api', '~> 3.11.58'
36
36
 
37
37
  ### Install from Git
38
38
 
@@ -357,7 +357,6 @@ Class | Method | HTTP request | Description
357
357
  *UltracartClient::ItemApi* | [**get_inventory_snapshot**](docs/ItemApi.md#get_inventory_snapshot) | **GET** /item/items/inventory_snapshot | Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response.
358
358
  *UltracartClient::ItemApi* | [**get_item**](docs/ItemApi.md#get_item) | **GET** /item/items/{merchant_item_oid} | Retrieve an item
359
359
  *UltracartClient::ItemApi* | [**get_item_by_merchant_item_id**](docs/ItemApi.md#get_item_by_merchant_item_id) | **GET** /item/items/merchant_item_id/{merchant_item_id} | Retrieve an item by item id
360
- *UltracartClient::ItemApi* | [**get_item_shipping_distribution_center_by_code**](docs/ItemApi.md#get_item_shipping_distribution_center_by_code) | **GET** /item/items/{merchant_item_oid}/shipping/distribution_centers/by_code/{distribution_center_code} | Retrieve an item shipping distribution center
361
360
  *UltracartClient::ItemApi* | [**get_items**](docs/ItemApi.md#get_items) | **GET** /item/items | Retrieve items
362
361
  *UltracartClient::ItemApi* | [**get_pricing_tiers**](docs/ItemApi.md#get_pricing_tiers) | **GET** /item/pricing_tiers | Retrieve pricing tiers
363
362
  *UltracartClient::ItemApi* | [**get_review**](docs/ItemApi.md#get_review) | **GET** /item/items/{merchant_item_oid}/reviews/{review_oid} | Get a review
@@ -369,8 +368,6 @@ Class | Method | HTTP request | Description
369
368
  *UltracartClient::ItemApi* | [**insert_update_item_content_attribute**](docs/ItemApi.md#insert_update_item_content_attribute) | **POST** /item/items/{merchant_item_oid}/content/attributes | Upsert an item content attribute
370
369
  *UltracartClient::ItemApi* | [**update_digital_item**](docs/ItemApi.md#update_digital_item) | **PUT** /item/digital_library/{digital_item_oid} | Updates a file within the digital library
371
370
  *UltracartClient::ItemApi* | [**update_item**](docs/ItemApi.md#update_item) | **PUT** /item/items/{merchant_item_oid} | Update an item
372
- *UltracartClient::ItemApi* | [**update_item_inventories**](docs/ItemApi.md#update_item_inventories) | **PUT** /item/items/update_item_inventories | Update item inventories for a distribution center
373
- *UltracartClient::ItemApi* | [**update_item_shipping_distribution_center_by_code**](docs/ItemApi.md#update_item_shipping_distribution_center_by_code) | **PUT** /item/items/{merchant_item_oid}/shipping/distribution_centers/by_code/{distribution_center_code} | Update an item shipping distribution center
374
371
  *UltracartClient::ItemApi* | [**update_items**](docs/ItemApi.md#update_items) | **PUT** /item/items/batch | Update multiple items
375
372
  *UltracartClient::ItemApi* | [**update_review**](docs/ItemApi.md#update_review) | **PUT** /item/items/{merchant_item_oid}/reviews/{review_oid} | Update a review
376
373
  *UltracartClient::ItemApi* | [**upload_temporary_multimedia**](docs/ItemApi.md#upload_temporary_multimedia) | **POST** /item/temp_multimedia | Upload an image to the temporary multimedia.
@@ -392,6 +389,7 @@ Class | Method | HTTP request | Description
392
389
  *UltracartClient::OrderApi* | [**get_order**](docs/OrderApi.md#get_order) | **GET** /order/orders/{order_id} | Retrieve an order
393
390
  *UltracartClient::OrderApi* | [**get_order_by_token**](docs/OrderApi.md#get_order_by_token) | **POST** /order/orders/token | Retrieve an order using a token
394
391
  *UltracartClient::OrderApi* | [**get_order_edi_documents**](docs/OrderApi.md#get_order_edi_documents) | **GET** /order/orders/{order_id}/edi | Retrieve EDI documents associated with this order.
392
+ *UltracartClient::OrderApi* | [**get_order_upsell_cart**](docs/OrderApi.md#get_order_upsell_cart) | **PUT** /order/orders/{order_id}/upsell_with_cart | Get Order Upsell Cart
395
393
  *UltracartClient::OrderApi* | [**get_orders**](docs/OrderApi.md#get_orders) | **GET** /order/orders | Retrieve orders
396
394
  *UltracartClient::OrderApi* | [**get_orders_batch**](docs/OrderApi.md#get_orders_batch) | **POST** /order/orders/batch | Retrieve order batch
397
395
  *UltracartClient::OrderApi* | [**get_orders_by_query**](docs/OrderApi.md#get_orders_by_query) | **POST** /order/orders/query | Retrieve orders by query
@@ -1276,8 +1274,6 @@ Class | Method | HTTP request | Description
1276
1274
  - [UltracartClient::ItemInventorySnapshot](docs/ItemInventorySnapshot.md)
1277
1275
  - [UltracartClient::ItemInventorySnapshotDistributionCenter](docs/ItemInventorySnapshotDistributionCenter.md)
1278
1276
  - [UltracartClient::ItemInventorySnapshotResponse](docs/ItemInventorySnapshotResponse.md)
1279
- - [UltracartClient::ItemInventoryUpdate](docs/ItemInventoryUpdate.md)
1280
- - [UltracartClient::ItemInventoryUpdateRequest](docs/ItemInventoryUpdateRequest.md)
1281
1277
  - [UltracartClient::ItemKitComponent](docs/ItemKitComponent.md)
1282
1278
  - [UltracartClient::ItemKitDefinition](docs/ItemKitDefinition.md)
1283
1279
  - [UltracartClient::ItemOption](docs/ItemOption.md)
@@ -1309,7 +1305,6 @@ Class | Method | HTTP request | Description
1309
1305
  - [UltracartClient::ItemShippingDestinationMarkup](docs/ItemShippingDestinationMarkup.md)
1310
1306
  - [UltracartClient::ItemShippingDestinationRestriction](docs/ItemShippingDestinationRestriction.md)
1311
1307
  - [UltracartClient::ItemShippingDistributionCenter](docs/ItemShippingDistributionCenter.md)
1312
- - [UltracartClient::ItemShippingDistributionCenterResponse](docs/ItemShippingDistributionCenterResponse.md)
1313
1308
  - [UltracartClient::ItemShippingMethod](docs/ItemShippingMethod.md)
1314
1309
  - [UltracartClient::ItemShippingPackageRequirement](docs/ItemShippingPackageRequirement.md)
1315
1310
  - [UltracartClient::ItemTag](docs/ItemTag.md)
@@ -1415,6 +1410,7 @@ Class | Method | HTTP request | Description
1415
1410
  - [UltracartClient::OrderTrackingNumberDetail](docs/OrderTrackingNumberDetail.md)
1416
1411
  - [UltracartClient::OrderTrackingNumberDetails](docs/OrderTrackingNumberDetails.md)
1417
1412
  - [UltracartClient::OrderTransactionalMerchantNote](docs/OrderTransactionalMerchantNote.md)
1413
+ - [UltracartClient::OrderUpsellCartRequest](docs/OrderUpsellCartRequest.md)
1418
1414
  - [UltracartClient::OrderUtm](docs/OrderUtm.md)
1419
1415
  - [UltracartClient::OrderValidationRequest](docs/OrderValidationRequest.md)
1420
1416
  - [UltracartClient::OrderValidationResponse](docs/OrderValidationResponse.md)
@@ -1669,6 +1665,7 @@ Not every change is committed to every SDK.
1669
1665
 
1670
1666
  | Version | Date | Comments |
1671
1667
  | --: | :-: | --- |
1668
+ | 3.11.58 | 02/10/2026 | conversations - new method to look up an item with sparse variations. |
1672
1669
  | 3.11.57 | 02/03/2026 | conversations - pbx class of service objects and endpoints |
1673
1670
  | 3.11.56 | 02/02/2026 | conversations - add default phone number to the agent auth |
1674
1671
  | 3.11.55 | 02/02/2026 | conversations - add enumerated values for say voice on queue and agent |
@@ -2846,6 +2846,7 @@ api_instance = UltracartClient::ConversationApi.new_using_api_key(simple_key, fa
2846
2846
  opts = {
2847
2847
  since: 'since_example', # String | ISO timestamp to filter entries since
2848
2848
  agent_login: 'agent_login_example', # String | Filter by agent login
2849
+ action: 'action_example', # String | Action
2849
2850
  limit: 56 # Integer | Maximum number of entries to return (default 100)
2850
2851
  }
2851
2852
 
@@ -2864,6 +2865,7 @@ Name | Type | Description | Notes
2864
2865
  ------------- | ------------- | ------------- | -------------
2865
2866
  **since** | **String**| ISO timestamp to filter entries since | [optional]
2866
2867
  **agent_login** | **String**| Filter by agent login | [optional]
2868
+ **action** | **String**| Action | [optional]
2867
2869
  **limit** | **Integer**| Maximum number of entries to return (default 100) | [optional]
2868
2870
 
2869
2871
  ### Return type
@@ -13,7 +13,7 @@ Name | Type | Description | Notes
13
13
  **postcard_container_cjson_last_modified_dts** | **String** | Timestamp the last time the container was modified. | [optional]
14
14
  **postcard_front_container_cjson** | **String** | Postcard front container cjson | [optional]
15
15
  **postcard_front_container_uuid** | **String** | Postcard front container uuid | [optional]
16
- **screenshot_back_url** | **String** | URL to screenshot of the back of the postcard | [optional]
16
+ **screenshot_back_url** | **String** | URL to screenshot of the front of the postcard | [optional]
17
17
  **screenshot_front_url** | **String** | URL to screenshot of the front of the postcard | [optional]
18
18
  **storefront_oid** | **Integer** | Storefront oid | [optional]
19
19
 
data/docs/ItemApi.md CHANGED
@@ -13,7 +13,6 @@ Method | HTTP request | Description
13
13
  [**get_inventory_snapshot**](ItemApi.md#get_inventory_snapshot) | **GET** /item/items/inventory_snapshot | Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response.
14
14
  [**get_item**](ItemApi.md#get_item) | **GET** /item/items/{merchant_item_oid} | Retrieve an item
15
15
  [**get_item_by_merchant_item_id**](ItemApi.md#get_item_by_merchant_item_id) | **GET** /item/items/merchant_item_id/{merchant_item_id} | Retrieve an item by item id
16
- [**get_item_shipping_distribution_center_by_code**](ItemApi.md#get_item_shipping_distribution_center_by_code) | **GET** /item/items/{merchant_item_oid}/shipping/distribution_centers/by_code/{distribution_center_code} | Retrieve an item shipping distribution center
17
16
  [**get_items**](ItemApi.md#get_items) | **GET** /item/items | Retrieve items
18
17
  [**get_pricing_tiers**](ItemApi.md#get_pricing_tiers) | **GET** /item/pricing_tiers | Retrieve pricing tiers
19
18
  [**get_review**](ItemApi.md#get_review) | **GET** /item/items/{merchant_item_oid}/reviews/{review_oid} | Get a review
@@ -25,8 +24,6 @@ Method | HTTP request | Description
25
24
  [**insert_update_item_content_attribute**](ItemApi.md#insert_update_item_content_attribute) | **POST** /item/items/{merchant_item_oid}/content/attributes | Upsert an item content attribute
26
25
  [**update_digital_item**](ItemApi.md#update_digital_item) | **PUT** /item/digital_library/{digital_item_oid} | Updates a file within the digital library
27
26
  [**update_item**](ItemApi.md#update_item) | **PUT** /item/items/{merchant_item_oid} | Update an item
28
- [**update_item_inventories**](ItemApi.md#update_item_inventories) | **PUT** /item/items/update_item_inventories | Update item inventories for a distribution center
29
- [**update_item_shipping_distribution_center_by_code**](ItemApi.md#update_item_shipping_distribution_center_by_code) | **PUT** /item/items/{merchant_item_oid}/shipping/distribution_centers/by_code/{distribution_center_code} | Update an item shipping distribution center
30
27
  [**update_items**](ItemApi.md#update_items) | **PUT** /item/items/batch | Update multiple items
31
28
  [**update_review**](ItemApi.md#update_review) | **PUT** /item/items/{merchant_item_oid}/reviews/{review_oid} | Update a review
32
29
  [**upload_temporary_multimedia**](ItemApi.md#upload_temporary_multimedia) | **POST** /item/temp_multimedia | Upload an image to the temporary multimedia.
@@ -500,65 +497,6 @@ Name | Type | Description | Notes
500
497
 
501
498
 
502
499
 
503
- # **get_item_shipping_distribution_center_by_code**
504
- > ItemShippingDistributionCenterResponse get_item_shipping_distribution_center_by_code(merchant_item_oid, distribution_center_code, opts)
505
-
506
- Retrieve an item shipping distribution center
507
-
508
- Retrieve an item shipping distribution center.
509
-
510
- ### Example
511
- ```ruby
512
- # load the gem
513
- require 'ultracart_api'
514
-
515
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
516
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
517
- api_instance = UltracartClient::ItemApi.new_using_api_key(simple_key, false, false)
518
-
519
-
520
- merchant_item_oid = 56 # Integer | The item oid to retrieve.
521
-
522
- distribution_center_code = 'distribution_center_code_example' # String |
523
-
524
- opts = {
525
- _expand: '_expand_example', # String | The object expansion to perform on the result. See documentation for examples
526
- _placeholders: true # BOOLEAN | Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.
527
- }
528
-
529
- begin
530
- #Retrieve an item shipping distribution center
531
- result = api_instance.get_item_shipping_distribution_center_by_code(merchant_item_oid, distribution_center_code, opts)
532
- p result
533
- rescue UltracartClient::ApiError => e
534
- puts "Exception when calling ItemApi->get_item_shipping_distribution_center_by_code: #{e}"
535
- end
536
- ```
537
-
538
- ### Parameters
539
-
540
- Name | Type | Description | Notes
541
- ------------- | ------------- | ------------- | -------------
542
- **merchant_item_oid** | **Integer**| The item oid to retrieve. |
543
- **distribution_center_code** | **String**| |
544
- **_expand** | **String**| The object expansion to perform on the result. See documentation for examples | [optional]
545
- **_placeholders** | **BOOLEAN**| Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API. | [optional]
546
-
547
- ### Return type
548
-
549
- [**ItemShippingDistributionCenterResponse**](ItemShippingDistributionCenterResponse.md)
550
-
551
- ### Authorization
552
-
553
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
554
-
555
- ### HTTP request headers
556
-
557
- - **Content-Type**: application/json
558
- - **Accept**: application/json
559
-
560
-
561
-
562
500
  # **get_items**
563
501
  > ItemsResponse get_items(opts)
564
502
 
@@ -1162,110 +1100,6 @@ Name | Type | Description | Notes
1162
1100
 
1163
1101
 
1164
1102
 
1165
- # **update_item_inventories**
1166
- > update_item_inventories(item_inventory_update_request)
1167
-
1168
- Update item inventories for a distribution center
1169
-
1170
- Update item inventories for a distribution center
1171
-
1172
- ### Example
1173
- ```ruby
1174
- # load the gem
1175
- require 'ultracart_api'
1176
-
1177
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
1178
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
1179
- api_instance = UltracartClient::ItemApi.new_using_api_key(simple_key, false, false)
1180
-
1181
-
1182
- item_inventory_update_request = UltracartClient::ItemInventoryUpdateRequest.new # ItemInventoryUpdateRequest | Item inventory updates
1183
-
1184
-
1185
- begin
1186
- #Update item inventories for a distribution center
1187
- api_instance.update_item_inventories(item_inventory_update_request)
1188
- rescue UltracartClient::ApiError => e
1189
- puts "Exception when calling ItemApi->update_item_inventories: #{e}"
1190
- end
1191
- ```
1192
-
1193
- ### Parameters
1194
-
1195
- Name | Type | Description | Notes
1196
- ------------- | ------------- | ------------- | -------------
1197
- **item_inventory_update_request** | [**ItemInventoryUpdateRequest**](ItemInventoryUpdateRequest.md)| Item inventory updates |
1198
-
1199
- ### Return type
1200
-
1201
- nil (empty response body)
1202
-
1203
- ### Authorization
1204
-
1205
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1206
-
1207
- ### HTTP request headers
1208
-
1209
- - **Content-Type**: application/json; charset=UTF-8
1210
- - **Accept**: application/json
1211
-
1212
-
1213
-
1214
- # **update_item_shipping_distribution_center_by_code**
1215
- > update_item_shipping_distribution_center_by_code(item_shipping_distribution_center, merchant_item_oid, distribution_center_code)
1216
-
1217
- Update an item shipping distribution center
1218
-
1219
- Update an item shipping distribution center
1220
-
1221
- ### Example
1222
- ```ruby
1223
- # load the gem
1224
- require 'ultracart_api'
1225
-
1226
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
1227
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
1228
- api_instance = UltracartClient::ItemApi.new_using_api_key(simple_key, false, false)
1229
-
1230
-
1231
- item_shipping_distribution_center = UltracartClient::ItemShippingDistributionCenter.new # ItemShippingDistributionCenter | Item shipping distribution center
1232
-
1233
- merchant_item_oid = 56 # Integer | The item oid to update.
1234
-
1235
- distribution_center_code = 'distribution_center_code_example' # String |
1236
-
1237
-
1238
- begin
1239
- #Update an item shipping distribution center
1240
- api_instance.update_item_shipping_distribution_center_by_code(item_shipping_distribution_center, merchant_item_oid, distribution_center_code)
1241
- rescue UltracartClient::ApiError => e
1242
- puts "Exception when calling ItemApi->update_item_shipping_distribution_center_by_code: #{e}"
1243
- end
1244
- ```
1245
-
1246
- ### Parameters
1247
-
1248
- Name | Type | Description | Notes
1249
- ------------- | ------------- | ------------- | -------------
1250
- **item_shipping_distribution_center** | [**ItemShippingDistributionCenter**](ItemShippingDistributionCenter.md)| Item shipping distribution center |
1251
- **merchant_item_oid** | **Integer**| The item oid to update. |
1252
- **distribution_center_code** | **String**| |
1253
-
1254
- ### Return type
1255
-
1256
- nil (empty response body)
1257
-
1258
- ### Authorization
1259
-
1260
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1261
-
1262
- ### HTTP request headers
1263
-
1264
- - **Content-Type**: application/json; charset=UTF-8
1265
- - **Accept**: application/json
1266
-
1267
-
1268
-
1269
1103
  # **update_items**
1270
1104
  > ItemsResponse update_items(items_request, opts)
1271
1105
 
data/docs/OrderApi.md CHANGED
@@ -20,6 +20,7 @@ Method | HTTP request | Description
20
20
  [**get_order**](OrderApi.md#get_order) | **GET** /order/orders/{order_id} | Retrieve an order
21
21
  [**get_order_by_token**](OrderApi.md#get_order_by_token) | **POST** /order/orders/token | Retrieve an order using a token
22
22
  [**get_order_edi_documents**](OrderApi.md#get_order_edi_documents) | **GET** /order/orders/{order_id}/edi | Retrieve EDI documents associated with this order.
23
+ [**get_order_upsell_cart**](OrderApi.md#get_order_upsell_cart) | **PUT** /order/orders/{order_id}/upsell_with_cart | Get Order Upsell Cart
23
24
  [**get_orders**](OrderApi.md#get_orders) | **GET** /order/orders | Retrieve orders
24
25
  [**get_orders_batch**](OrderApi.md#get_orders_batch) | **POST** /order/orders/batch | Retrieve order batch
25
26
  [**get_orders_by_query**](OrderApi.md#get_orders_by_query) | **POST** /order/orders/query | Retrieve orders by query
@@ -871,6 +872,63 @@ Name | Type | Description | Notes
871
872
 
872
873
 
873
874
 
875
+ # **get_order_upsell_cart**
876
+ > OrderResponse get_order_upsell_cart(upsell_cart_request, order_id, opts)
877
+
878
+ Get Order Upsell Cart
879
+
880
+ Creates a new cart using cloned information from the order, but with a specific set of items, coupons and optionally a checkout URL to return the customer to
881
+
882
+ ### Example
883
+ ```ruby
884
+ # load the gem
885
+ require 'ultracart_api'
886
+
887
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
888
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
889
+ api_instance = UltracartClient::OrderApi.new_using_api_key(simple_key, false, false)
890
+
891
+
892
+ upsell_cart_request = UltracartClient::OrderUpsellCartRequest.new # OrderUpsellCartRequest | Request for the upsell cart
893
+
894
+ order_id = 'order_id_example' # String | The order id to base things on.
895
+
896
+ opts = {
897
+ _expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
898
+ }
899
+
900
+ begin
901
+ #Get Order Upsell Cart
902
+ result = api_instance.get_order_upsell_cart(upsell_cart_request, order_id, opts)
903
+ p result
904
+ rescue UltracartClient::ApiError => e
905
+ puts "Exception when calling OrderApi->get_order_upsell_cart: #{e}"
906
+ end
907
+ ```
908
+
909
+ ### Parameters
910
+
911
+ Name | Type | Description | Notes
912
+ ------------- | ------------- | ------------- | -------------
913
+ **upsell_cart_request** | [**OrderUpsellCartRequest**](OrderUpsellCartRequest.md)| Request for the upsell cart |
914
+ **order_id** | **String**| The order id to base things on. |
915
+ **_expand** | **String**| The object expansion to perform on the result. See documentation for examples | [optional]
916
+
917
+ ### Return type
918
+
919
+ [**OrderResponse**](OrderResponse.md)
920
+
921
+ ### Authorization
922
+
923
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
924
+
925
+ ### HTTP request headers
926
+
927
+ - **Content-Type**: application/json; charset=UTF-8
928
+ - **Accept**: application/json
929
+
930
+
931
+
874
932
  # **get_orders**
875
933
  > OrdersResponse get_orders(opts)
876
934
 
@@ -0,0 +1,10 @@
1
+ # UltracartClient::OrderUpsellCartRequest
2
+
3
+ ## Properties
4
+ Name | Type | Description | Notes
5
+ ------------ | ------------- | ------------- | -------------
6
+ **checkout_url** | **String** | | [optional]
7
+ **coupon_codes** | **Array<String>** | | [optional]
8
+ **items** | [**Array<CartItem>**](CartItem.md) | | [optional]
9
+
10
+
@@ -3012,6 +3012,7 @@ module UltracartClient
3012
3012
  # @param [Hash] opts the optional parameters
3013
3013
  # @option opts [String] :since ISO timestamp to filter entries since
3014
3014
  # @option opts [String] :agent_login Filter by agent login
3015
+ # @option opts [String] :action Action
3015
3016
  # @option opts [Integer] :limit Maximum number of entries to return (default 100)
3016
3017
  # @return [ConversationPbxCosAuditLogsResponse]
3017
3018
  def get_pbx_cos_audit_logs(opts = {})
@@ -3024,6 +3025,7 @@ module UltracartClient
3024
3025
  # @param [Hash] opts the optional parameters
3025
3026
  # @option opts [String] :since ISO timestamp to filter entries since
3026
3027
  # @option opts [String] :agent_login Filter by agent login
3028
+ # @option opts [String] :action Action
3027
3029
  # @option opts [Integer] :limit Maximum number of entries to return (default 100)
3028
3030
  # @return [Array<(ConversationPbxCosAuditLogsResponse, Fixnum, Hash)>] ConversationPbxCosAuditLogsResponse data, response status code and response headers
3029
3031
  def get_pbx_cos_audit_logs_with_http_info(opts = {})
@@ -3037,6 +3039,7 @@ module UltracartClient
3037
3039
  query_params = {}
3038
3040
  query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
3039
3041
  query_params[:'agent_login'] = opts[:'agent_login'] if !opts[:'agent_login'].nil?
3042
+ query_params[:'action'] = opts[:'action'] if !opts[:'action'].nil?
3040
3043
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
3041
3044
 
3042
3045
  # header parameters
@@ -548,73 +548,6 @@ module UltracartClient
548
548
  end
549
549
  return data, status_code, headers
550
550
  end
551
- # Retrieve an item shipping distribution center
552
- # Retrieve an item shipping distribution center.
553
- # @param merchant_item_oid The item oid to retrieve.
554
- # @param distribution_center_code
555
- # @param [Hash] opts the optional parameters
556
- # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
557
- # @option opts [BOOLEAN] :_placeholders Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.
558
- # @return [ItemShippingDistributionCenterResponse]
559
- def get_item_shipping_distribution_center_by_code(merchant_item_oid, distribution_center_code, opts = {})
560
- data, _status_code, _headers = get_item_shipping_distribution_center_by_code_with_http_info(merchant_item_oid, distribution_center_code, opts)
561
- data
562
- end
563
-
564
- # Retrieve an item shipping distribution center
565
- # Retrieve an item shipping distribution center.
566
- # @param merchant_item_oid The item oid to retrieve.
567
- # @param distribution_center_code
568
- # @param [Hash] opts the optional parameters
569
- # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
570
- # @option opts [BOOLEAN] :_placeholders Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.
571
- # @return [Array<(ItemShippingDistributionCenterResponse, Fixnum, Hash)>] ItemShippingDistributionCenterResponse data, response status code and response headers
572
- def get_item_shipping_distribution_center_by_code_with_http_info(merchant_item_oid, distribution_center_code, opts = {})
573
- if @api_client.config.debugging
574
- @api_client.config.logger.debug 'Calling API: ItemApi.get_item_shipping_distribution_center_by_code ...'
575
- end
576
- # verify the required parameter 'merchant_item_oid' is set
577
- if @api_client.config.client_side_validation && merchant_item_oid.nil?
578
- fail ArgumentError, "Missing the required parameter 'merchant_item_oid' when calling ItemApi.get_item_shipping_distribution_center_by_code"
579
- end
580
- # verify the required parameter 'distribution_center_code' is set
581
- if @api_client.config.client_side_validation && distribution_center_code.nil?
582
- fail ArgumentError, "Missing the required parameter 'distribution_center_code' when calling ItemApi.get_item_shipping_distribution_center_by_code"
583
- end
584
- # resource path
585
- local_var_path = '/item/items/{merchant_item_oid}/shipping/distribution_centers/by_code/{distribution_center_code}'.sub('{' + 'merchant_item_oid' + '}', merchant_item_oid.to_s).sub('{' + 'distribution_center_code' + '}', distribution_center_code.to_s)
586
-
587
- # query parameters
588
- query_params = {}
589
- query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
590
- query_params[:'_placeholders'] = opts[:'_placeholders'] if !opts[:'_placeholders'].nil?
591
-
592
- # header parameters
593
- header_params = {}
594
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
595
- # HTTP header 'Accept' (if needed)
596
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
597
- # HTTP header 'Content-Type'
598
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
599
-
600
- # form parameters
601
- form_params = {}
602
-
603
- # http body (model)
604
- post_body = nil
605
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
606
- data, status_code, headers = @api_client.call_api(:GET, local_var_path,
607
- :header_params => header_params,
608
- :query_params => query_params,
609
- :form_params => form_params,
610
- :body => post_body,
611
- :auth_names => auth_names,
612
- :return_type => 'ItemShippingDistributionCenterResponse')
613
- if @api_client.config.debugging
614
- @api_client.config.logger.debug "API called: ItemApi#get_item_shipping_distribution_center_by_code\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
615
- end
616
- return data, status_code, headers
617
- end
618
551
  # Retrieve items
619
552
  # Retrieves a group of items from the account. If no parameters are specified, all items will be returned. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
620
553
  # @param [Hash] opts the optional parameters
@@ -1288,126 +1221,6 @@ module UltracartClient
1288
1221
  end
1289
1222
  return data, status_code, headers
1290
1223
  end
1291
- # Update item inventories for a distribution center
1292
- # Update item inventories for a distribution center
1293
- # @param item_inventory_update_request Item inventory updates
1294
- # @param [Hash] opts the optional parameters
1295
- # @return [nil]
1296
- def update_item_inventories(item_inventory_update_request, opts = {})
1297
- update_item_inventories_with_http_info(item_inventory_update_request, opts)
1298
- nil
1299
- end
1300
-
1301
- # Update item inventories for a distribution center
1302
- # Update item inventories for a distribution center
1303
- # @param item_inventory_update_request Item inventory updates
1304
- # @param [Hash] opts the optional parameters
1305
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
1306
- def update_item_inventories_with_http_info(item_inventory_update_request, opts = {})
1307
- if @api_client.config.debugging
1308
- @api_client.config.logger.debug 'Calling API: ItemApi.update_item_inventories ...'
1309
- end
1310
- # verify the required parameter 'item_inventory_update_request' is set
1311
- if @api_client.config.client_side_validation && item_inventory_update_request.nil?
1312
- fail ArgumentError, "Missing the required parameter 'item_inventory_update_request' when calling ItemApi.update_item_inventories"
1313
- end
1314
- # resource path
1315
- local_var_path = '/item/items/update_item_inventories'
1316
-
1317
- # query parameters
1318
- query_params = {}
1319
-
1320
- # header parameters
1321
- header_params = {}
1322
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1323
- # HTTP header 'Accept' (if needed)
1324
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1325
- # HTTP header 'Content-Type'
1326
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
1327
-
1328
- # form parameters
1329
- form_params = {}
1330
-
1331
- # http body (model)
1332
- post_body = @api_client.object_to_http_body(item_inventory_update_request)
1333
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
1334
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
1335
- :header_params => header_params,
1336
- :query_params => query_params,
1337
- :form_params => form_params,
1338
- :body => post_body,
1339
- :auth_names => auth_names)
1340
- if @api_client.config.debugging
1341
- @api_client.config.logger.debug "API called: ItemApi#update_item_inventories\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1342
- end
1343
- return data, status_code, headers
1344
- end
1345
- # Update an item shipping distribution center
1346
- # Update an item shipping distribution center
1347
- # @param item_shipping_distribution_center Item shipping distribution center
1348
- # @param merchant_item_oid The item oid to update.
1349
- # @param distribution_center_code
1350
- # @param [Hash] opts the optional parameters
1351
- # @return [nil]
1352
- def update_item_shipping_distribution_center_by_code(item_shipping_distribution_center, merchant_item_oid, distribution_center_code, opts = {})
1353
- update_item_shipping_distribution_center_by_code_with_http_info(item_shipping_distribution_center, merchant_item_oid, distribution_center_code, opts)
1354
- nil
1355
- end
1356
-
1357
- # Update an item shipping distribution center
1358
- # Update an item shipping distribution center
1359
- # @param item_shipping_distribution_center Item shipping distribution center
1360
- # @param merchant_item_oid The item oid to update.
1361
- # @param distribution_center_code
1362
- # @param [Hash] opts the optional parameters
1363
- # @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
1364
- def update_item_shipping_distribution_center_by_code_with_http_info(item_shipping_distribution_center, merchant_item_oid, distribution_center_code, opts = {})
1365
- if @api_client.config.debugging
1366
- @api_client.config.logger.debug 'Calling API: ItemApi.update_item_shipping_distribution_center_by_code ...'
1367
- end
1368
- # verify the required parameter 'item_shipping_distribution_center' is set
1369
- if @api_client.config.client_side_validation && item_shipping_distribution_center.nil?
1370
- fail ArgumentError, "Missing the required parameter 'item_shipping_distribution_center' when calling ItemApi.update_item_shipping_distribution_center_by_code"
1371
- end
1372
- # verify the required parameter 'merchant_item_oid' is set
1373
- if @api_client.config.client_side_validation && merchant_item_oid.nil?
1374
- fail ArgumentError, "Missing the required parameter 'merchant_item_oid' when calling ItemApi.update_item_shipping_distribution_center_by_code"
1375
- end
1376
- # verify the required parameter 'distribution_center_code' is set
1377
- if @api_client.config.client_side_validation && distribution_center_code.nil?
1378
- fail ArgumentError, "Missing the required parameter 'distribution_center_code' when calling ItemApi.update_item_shipping_distribution_center_by_code"
1379
- end
1380
- # resource path
1381
- local_var_path = '/item/items/{merchant_item_oid}/shipping/distribution_centers/by_code/{distribution_center_code}'.sub('{' + 'merchant_item_oid' + '}', merchant_item_oid.to_s).sub('{' + 'distribution_center_code' + '}', distribution_center_code.to_s)
1382
-
1383
- # query parameters
1384
- query_params = {}
1385
-
1386
- # header parameters
1387
- header_params = {}
1388
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1389
- # HTTP header 'Accept' (if needed)
1390
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1391
- # HTTP header 'Content-Type'
1392
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
1393
-
1394
- # form parameters
1395
- form_params = {}
1396
-
1397
- # http body (model)
1398
- post_body = @api_client.object_to_http_body(item_shipping_distribution_center)
1399
- auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
1400
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
1401
- :header_params => header_params,
1402
- :query_params => query_params,
1403
- :form_params => form_params,
1404
- :body => post_body,
1405
- :auth_names => auth_names)
1406
- if @api_client.config.debugging
1407
- @api_client.config.logger.debug "API called: ItemApi#update_item_shipping_distribution_center_by_code\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1408
- end
1409
- return data, status_code, headers
1410
- end
1411
1224
  # Update multiple items
1412
1225
  # Update multiple item on the UltraCart account.
1413
1226
  # @param items_request Items to update (synchronous maximum 20 / asynchronous maximum 100)