ultracart_api 4.1.62 → 4.1.63

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.
Files changed (35) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +19 -2
  3. data/docs/AutoOrder.md +2 -0
  4. data/docs/AutoOrderAddonItemsUpdateRequest.md +18 -0
  5. data/docs/AutoOrderApi.md +170 -0
  6. data/docs/AutoOrderItem.md +4 -0
  7. data/docs/AutoOrderPropertiesUpdateRequest.md +18 -0
  8. data/docs/AutoOrderProperty.md +20 -0
  9. data/docs/ConversationApi.md +54 -0
  10. data/docs/EmailCommseqPostcard.md +1 -1
  11. data/docs/ItemApi.md +167 -0
  12. data/docs/ItemInventoryUpdate.md +22 -0
  13. data/docs/ItemInventoryUpdateRequest.md +18 -0
  14. data/docs/ItemShipping.md +2 -0
  15. data/docs/ItemShippingDistributionCenterResponse.md +26 -0
  16. data/docs/OrderAddItemsAndReleaseRequest.md +18 -0
  17. data/docs/OrderApi.md +111 -0
  18. data/lib/ultracart_api/api/auto_order_api.rb +246 -0
  19. data/lib/ultracart_api/api/conversation_api.rb +64 -0
  20. data/lib/ultracart_api/api/item_api.rb +226 -0
  21. data/lib/ultracart_api/api/order_api.rb +145 -0
  22. data/lib/ultracart_api/models/auto_order.rb +13 -1
  23. data/lib/ultracart_api/models/auto_order_addon_items_update_request.rb +222 -0
  24. data/lib/ultracart_api/models/auto_order_item.rb +25 -1
  25. data/lib/ultracart_api/models/auto_order_properties_update_request.rb +222 -0
  26. data/lib/ultracart_api/models/auto_order_property.rb +230 -0
  27. data/lib/ultracart_api/models/email_commseq_postcard.rb +1 -1
  28. data/lib/ultracart_api/models/item_inventory_update.rb +240 -0
  29. data/lib/ultracart_api/models/item_inventory_update_request.rb +222 -0
  30. data/lib/ultracart_api/models/item_shipping.rb +11 -1
  31. data/lib/ultracart_api/models/item_shipping_distribution_center_response.rb +256 -0
  32. data/lib/ultracart_api/models/order_add_items_and_release_request.rb +222 -0
  33. data/lib/ultracart_api/version.rb +1 -1
  34. data/lib/ultracart_api.rb +7 -0
  35. metadata +15 -1
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: b7a5fc12acb1e76ac4387c7b8078750e2a337d43748f8f00e80899a87d2e05c3
4
- data.tar.gz: 2cd244783976dce7a0acc219a29638286fa18ec85b3b8a2b4a85bb4d84e6cd17
3
+ metadata.gz: c5f1c846344132f6391610f68da28a977ac65b36592a5c93b62cf047ed37d768
4
+ data.tar.gz: 81f57162066164f0f8aa72c436d2e3134776f80faf8b98aefd7de9514c796d48
5
5
  SHA512:
6
- metadata.gz: 3843671f518496b876ca1777e9ddb44c637cb036212fa948623b9ab4b006d960a3e0f623b10e88a5930fb74d72a11b6d598738b02616bf10cf309c6009eb578a
7
- data.tar.gz: a3bccd891f9acfef5e7d006b1bf8a0e86352d2153e69f98e6fb2482642c2ea7319e346af48d8e970eb8780f00964bbb47c7bd703f42e0982ad8fe67be6883879
6
+ metadata.gz: 7a8014610ea5517333e6bdf6220575bc156cbfb9f016266019b8dfb62a35d34e28f2e614efacc8350689231497f0331adbe7d730b79203dbc137e27ec60c7911
7
+ data.tar.gz: 8c6919768a506888ca7487bc48992f3ab75470246f1327e04a4d5401f60c8710f45f0576c8208f430bf6d6d4dfb2d884eef096d845c5a379ba47f20a5d3ef5ac
data/README.md CHANGED
@@ -7,7 +7,7 @@ Note: Every method has a sample for every language. See https://github.com/Ultr
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.1.62
10
+ - Package version: 4.1.63
11
11
  - Build package: org.openapitools.codegen.languages.RubyClientCodegen
12
12
  - For more information, please visit [http://www.ultracart.com/api/](http://www.ultracart.com/api/)
13
13
 
@@ -16,7 +16,7 @@ This SDK is automatically generated by the [OpenAPI Generator](https://openapi-g
16
16
  gemfile:
17
17
 
18
18
  ```shell
19
- gem 'ultracart_api', '4.1.62'
19
+ gem 'ultracart_api', '4.1.63'
20
20
  ```
21
21
 
22
22
  install:
@@ -94,6 +94,9 @@ Class | Method | HTTP request | Description
94
94
  *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
95
95
  *UltracartClient::AutoOrderApi* | [**pause_auto_order**](docs/AutoOrderApi.md#pause_auto_order) | **PUT** /auto_order/auto_orders/{auto_order_oid}/pause | Pause auto order
96
96
  *UltracartClient::AutoOrderApi* | [**update_auto_order**](docs/AutoOrderApi.md#update_auto_order) | **PUT** /auto_order/auto_orders/{auto_order_oid} | Update an auto order
97
+ *UltracartClient::AutoOrderApi* | [**update_auto_order_item_add_ons**](docs/AutoOrderApi.md#update_auto_order_item_add_ons) | **PUT** /auto_order/auto_orders/{auto_order_oid}/items/{auto_order_item_oid}/add_ons | Update an auto order item add ons
98
+ *UltracartClient::AutoOrderApi* | [**update_auto_order_item_properties**](docs/AutoOrderApi.md#update_auto_order_item_properties) | **PUT** /auto_order/auto_orders/{auto_order_oid}/items/{auto_order_item_oid}/properties | Update an auto order item properties
99
+ *UltracartClient::AutoOrderApi* | [**update_auto_order_properties**](docs/AutoOrderApi.md#update_auto_order_properties) | **PUT** /auto_order/auto_orders/{auto_order_oid}/properties | Update an auto order properties
97
100
  *UltracartClient::AutoOrderApi* | [**update_auto_orders_batch**](docs/AutoOrderApi.md#update_auto_orders_batch) | **PUT** /auto_order/auto_orders/batch | Update multiple auto orders
98
101
  *UltracartClient::ChannelPartnerApi* | [**cancel_order_by_channel_partner_order_id**](docs/ChannelPartnerApi.md#cancel_order_by_channel_partner_order_id) | **DELETE** /channel_partner/cancel/by_channel_partner_order_id/{order_id} | Cancel channel partner order by channel partner order id
99
102
  *UltracartClient::ChannelPartnerApi* | [**cancel_order_by_ultra_cart_order_id**](docs/ChannelPartnerApi.md#cancel_order_by_ultra_cart_order_id) | **DELETE** /channel_partner/cancel/by_ultracart_order_id/{order_id} | Cancel channel partner order by UltraCart order id
@@ -161,6 +164,7 @@ Class | Method | HTTP request | Description
161
164
  *UltracartClient::ConversationApi* | [**get_conversation_departments**](docs/ConversationApi.md#get_conversation_departments) | **GET** /conversation/departments | Retrieve a list of departments ordered by name
162
165
  *UltracartClient::ConversationApi* | [**get_conversation_engagement**](docs/ConversationApi.md#get_conversation_engagement) | **GET** /conversation/engagements/{conversation_engagement_oid} | Retrieve an engagement
163
166
  *UltracartClient::ConversationApi* | [**get_conversation_engagements**](docs/ConversationApi.md#get_conversation_engagements) | **GET** /conversation/engagements | Retrieve a list of engagements ordered by name
167
+ *UltracartClient::ConversationApi* | [**get_conversation_item_variations**](docs/ConversationApi.md#get_conversation_item_variations) | **GET** /conversation/items/{merchant_item_id}/variations | Retrieve an item with sparse variations populated
164
168
  *UltracartClient::ConversationApi* | [**get_conversation_knowledge_base_document_upload_url**](docs/ConversationApi.md#get_conversation_knowledge_base_document_upload_url) | **GET** /conversation/agent/profiles/{user_id}/knowledge_base/upload_url/{extension} | Get a pre-signed conversation knowledge base document upload URL
165
169
  *UltracartClient::ConversationApi* | [**get_conversation_messages**](docs/ConversationApi.md#get_conversation_messages) | **GET** /conversation/conversations/{conversation_uuid}/messages/{since} | Retrieve conversation messages
166
170
  *UltracartClient::ConversationApi* | [**get_conversation_multimedia_upload_url**](docs/ConversationApi.md#get_conversation_multimedia_upload_url) | **GET** /conversation/upload_url/{extension} | Get a presigned conversation multimedia upload URL
@@ -353,6 +357,7 @@ Class | Method | HTTP request | Description
353
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.
354
358
  *UltracartClient::ItemApi* | [**get_item**](docs/ItemApi.md#get_item) | **GET** /item/items/{merchant_item_oid} | Retrieve an item
355
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
356
361
  *UltracartClient::ItemApi* | [**get_items**](docs/ItemApi.md#get_items) | **GET** /item/items | Retrieve items
357
362
  *UltracartClient::ItemApi* | [**get_pricing_tiers**](docs/ItemApi.md#get_pricing_tiers) | **GET** /item/pricing_tiers | Retrieve pricing tiers
358
363
  *UltracartClient::ItemApi* | [**get_review**](docs/ItemApi.md#get_review) | **GET** /item/items/{merchant_item_oid}/reviews/{review_oid} | Get a review
@@ -364,6 +369,8 @@ Class | Method | HTTP request | Description
364
369
  *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
365
370
  *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
366
371
  *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
367
374
  *UltracartClient::ItemApi* | [**update_items**](docs/ItemApi.md#update_items) | **PUT** /item/items/batch | Update multiple items
368
375
  *UltracartClient::ItemApi* | [**update_review**](docs/ItemApi.md#update_review) | **PUT** /item/items/{merchant_item_oid}/reviews/{review_oid} | Update a review
369
376
  *UltracartClient::ItemApi* | [**upload_temporary_multimedia**](docs/ItemApi.md#upload_temporary_multimedia) | **POST** /item/temp_multimedia | Upload an image to the temporary multimedia.
@@ -389,6 +396,8 @@ Class | Method | HTTP request | Description
389
396
  *UltracartClient::OrderApi* | [**get_orders**](docs/OrderApi.md#get_orders) | **GET** /order/orders | Retrieve orders
390
397
  *UltracartClient::OrderApi* | [**get_orders_batch**](docs/OrderApi.md#get_orders_batch) | **POST** /order/orders/batch | Retrieve order batch
391
398
  *UltracartClient::OrderApi* | [**get_orders_by_query**](docs/OrderApi.md#get_orders_by_query) | **POST** /order/orders/query | Retrieve orders by query
399
+ *UltracartClient::OrderApi* | [**held_order_add_items_and_release**](docs/OrderApi.md#held_order_add_items_and_release) | **PUT** /order/orders/{order_id}/hold/add_items_and_release | Add items and release a held order
400
+ *UltracartClient::OrderApi* | [**held_order_release**](docs/OrderApi.md#held_order_release) | **PUT** /order/orders/{order_id}/hold/release | Release a held order
392
401
  *UltracartClient::OrderApi* | [**insert_order**](docs/OrderApi.md#insert_order) | **POST** /order/orders | Insert an order
393
402
  *UltracartClient::OrderApi* | [**is_refundable_order**](docs/OrderApi.md#is_refundable_order) | **GET** /order/orders/{order_id}/refundable | Determine if an order can be refunded
394
403
  *UltracartClient::OrderApi* | [**process_payment**](docs/OrderApi.md#process_payment) | **POST** /order/orders/{order_id}/process_payment | Process payment
@@ -672,6 +681,7 @@ Class | Method | HTTP request | Description
672
681
  - [UltracartClient::AutoOrder](docs/AutoOrder.md)
673
682
  - [UltracartClient::AutoOrderAddonItem](docs/AutoOrderAddonItem.md)
674
683
  - [UltracartClient::AutoOrderAddonItemOption](docs/AutoOrderAddonItemOption.md)
684
+ - [UltracartClient::AutoOrderAddonItemsUpdateRequest](docs/AutoOrderAddonItemsUpdateRequest.md)
675
685
  - [UltracartClient::AutoOrderConsolidate](docs/AutoOrderConsolidate.md)
676
686
  - [UltracartClient::AutoOrderItem](docs/AutoOrderItem.md)
677
687
  - [UltracartClient::AutoOrderItemFutureSchedule](docs/AutoOrderItemFutureSchedule.md)
@@ -679,6 +689,8 @@ Class | Method | HTTP request | Description
679
689
  - [UltracartClient::AutoOrderItemSimpleSchedule](docs/AutoOrderItemSimpleSchedule.md)
680
690
  - [UltracartClient::AutoOrderLog](docs/AutoOrderLog.md)
681
691
  - [UltracartClient::AutoOrderManagement](docs/AutoOrderManagement.md)
692
+ - [UltracartClient::AutoOrderPropertiesUpdateRequest](docs/AutoOrderPropertiesUpdateRequest.md)
693
+ - [UltracartClient::AutoOrderProperty](docs/AutoOrderProperty.md)
682
694
  - [UltracartClient::AutoOrderQuery](docs/AutoOrderQuery.md)
683
695
  - [UltracartClient::AutoOrderQueryBatch](docs/AutoOrderQueryBatch.md)
684
696
  - [UltracartClient::AutoOrderResponse](docs/AutoOrderResponse.md)
@@ -1269,6 +1281,8 @@ Class | Method | HTTP request | Description
1269
1281
  - [UltracartClient::ItemInventorySnapshot](docs/ItemInventorySnapshot.md)
1270
1282
  - [UltracartClient::ItemInventorySnapshotDistributionCenter](docs/ItemInventorySnapshotDistributionCenter.md)
1271
1283
  - [UltracartClient::ItemInventorySnapshotResponse](docs/ItemInventorySnapshotResponse.md)
1284
+ - [UltracartClient::ItemInventoryUpdate](docs/ItemInventoryUpdate.md)
1285
+ - [UltracartClient::ItemInventoryUpdateRequest](docs/ItemInventoryUpdateRequest.md)
1272
1286
  - [UltracartClient::ItemKitComponent](docs/ItemKitComponent.md)
1273
1287
  - [UltracartClient::ItemKitDefinition](docs/ItemKitDefinition.md)
1274
1288
  - [UltracartClient::ItemOption](docs/ItemOption.md)
@@ -1300,6 +1314,7 @@ Class | Method | HTTP request | Description
1300
1314
  - [UltracartClient::ItemShippingDestinationMarkup](docs/ItemShippingDestinationMarkup.md)
1301
1315
  - [UltracartClient::ItemShippingDestinationRestriction](docs/ItemShippingDestinationRestriction.md)
1302
1316
  - [UltracartClient::ItemShippingDistributionCenter](docs/ItemShippingDistributionCenter.md)
1317
+ - [UltracartClient::ItemShippingDistributionCenterResponse](docs/ItemShippingDistributionCenterResponse.md)
1303
1318
  - [UltracartClient::ItemShippingMethod](docs/ItemShippingMethod.md)
1304
1319
  - [UltracartClient::ItemShippingPackageRequirement](docs/ItemShippingPackageRequirement.md)
1305
1320
  - [UltracartClient::ItemTag](docs/ItemTag.md)
@@ -1337,6 +1352,7 @@ Class | Method | HTTP request | Description
1337
1352
  - [UltracartClient::OauthRevokeSuccessResponse](docs/OauthRevokeSuccessResponse.md)
1338
1353
  - [UltracartClient::OauthTokenResponse](docs/OauthTokenResponse.md)
1339
1354
  - [UltracartClient::Order](docs/Order.md)
1355
+ - [UltracartClient::OrderAddItemsAndReleaseRequest](docs/OrderAddItemsAndReleaseRequest.md)
1340
1356
  - [UltracartClient::OrderAffiliate](docs/OrderAffiliate.md)
1341
1357
  - [UltracartClient::OrderAffiliateLedger](docs/OrderAffiliateLedger.md)
1342
1358
  - [UltracartClient::OrderAssignToAffiliateRequest](docs/OrderAssignToAffiliateRequest.md)
@@ -1663,6 +1679,7 @@ Not every change is committed to every SDK.
1663
1679
 
1664
1680
  | Version | Date | Comments |
1665
1681
  | --: | :-: | --- |
1682
+ | 4.1.63 | 02/12/2026 | build automation issue |
1666
1683
  | 4.1.62 | 02/12/2026 | build automation run, no code changes |
1667
1684
  | 4.1.61 | 02/12/2026 | order - methods to release held orders |
1668
1685
  | 4.1.60 | 02/12/2026 | auto order - properties, item add-ons, and item properties |
data/docs/AutoOrder.md CHANGED
@@ -28,6 +28,7 @@
28
28
  | **original_order** | [**Order**](Order.md) | | [optional] |
29
29
  | **original_order_id** | **String** | The original order id that this auto order is associated with. | [optional] |
30
30
  | **override_affiliate_id** | **Integer** | Override the affiliate id given credit for rebills of this auto order | [optional] |
31
+ | **properties** | [**Array<AutoOrderProperty>**](AutoOrderProperty.md) | Array of property objects | [optional] |
31
32
  | **rebill_orders** | [**Array<Order>**](Order.md) | Rebill orders that have taken place on this auto order | [optional] |
32
33
  | **rotating_transaction_gateway_code** | **String** | The RTG code associated with this order for future rebills | [optional] |
33
34
  | **status** | **String** | The status of the auto order | [optional] |
@@ -62,6 +63,7 @@ instance = UltracartClient::AutoOrder.new(
62
63
  original_order: null,
63
64
  original_order_id: null,
64
65
  override_affiliate_id: null,
66
+ properties: null,
65
67
  rebill_orders: null,
66
68
  rotating_transaction_gateway_code: null,
67
69
  status: null
@@ -0,0 +1,18 @@
1
+ # UltracartClient::AutoOrderAddonItemsUpdateRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **add_on_items** | [**Array<AutoOrderAddonItem>**](AutoOrderAddonItem.md) | Add on items to update | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'ultracart_api'
13
+
14
+ instance = UltracartClient::AutoOrderAddonItemsUpdateRequest.new(
15
+ add_on_items: null
16
+ )
17
+ ```
18
+
data/docs/AutoOrderApi.md CHANGED
@@ -14,6 +14,9 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
14
14
  | [**get_auto_orders_by_query**](AutoOrderApi.md#get_auto_orders_by_query) | **POST** /auto_order/auto_orders/query | Retrieve auto orders by query |
15
15
  | [**pause_auto_order**](AutoOrderApi.md#pause_auto_order) | **PUT** /auto_order/auto_orders/{auto_order_oid}/pause | Pause auto order |
16
16
  | [**update_auto_order**](AutoOrderApi.md#update_auto_order) | **PUT** /auto_order/auto_orders/{auto_order_oid} | Update an auto order |
17
+ | [**update_auto_order_item_add_ons**](AutoOrderApi.md#update_auto_order_item_add_ons) | **PUT** /auto_order/auto_orders/{auto_order_oid}/items/{auto_order_item_oid}/add_ons | Update an auto order item add ons |
18
+ | [**update_auto_order_item_properties**](AutoOrderApi.md#update_auto_order_item_properties) | **PUT** /auto_order/auto_orders/{auto_order_oid}/items/{auto_order_item_oid}/properties | Update an auto order item properties |
19
+ | [**update_auto_order_properties**](AutoOrderApi.md#update_auto_order_properties) | **PUT** /auto_order/auto_orders/{auto_order_oid}/properties | Update an auto order properties |
17
20
  | [**update_auto_orders_batch**](AutoOrderApi.md#update_auto_orders_batch) | **PUT** /auto_order/auto_orders/batch | Update multiple auto orders |
18
21
 
19
22
 
@@ -1152,6 +1155,173 @@ end
1152
1155
  - **Accept**: application/json
1153
1156
 
1154
1157
 
1158
+ ## update_auto_order_item_add_ons
1159
+
1160
+ > <AutoOrderResponse> update_auto_order_item_add_ons(auto_order_oid, auto_order_item_oid, auto_order_add_ons_update_request, opts)
1161
+
1162
+ Update an auto order item add ons
1163
+
1164
+ Update an auto order item add ons. Returns the auto order based upon expansion
1165
+
1166
+
1167
+ ### Examples
1168
+
1169
+
1170
+ (No example for this operation).
1171
+
1172
+
1173
+ #### Using the update_auto_order_item_add_ons_with_http_info variant
1174
+
1175
+ This returns an Array which contains the response data, status code and headers.
1176
+
1177
+ > <Array(<AutoOrderResponse>, Integer, Hash)> update_auto_order_item_add_ons_with_http_info(auto_order_oid, auto_order_item_oid, auto_order_add_ons_update_request, opts)
1178
+
1179
+ ```ruby
1180
+ begin
1181
+ # Update an auto order item add ons
1182
+ data, status_code, headers = api_instance.update_auto_order_item_add_ons_with_http_info(auto_order_oid, auto_order_item_oid, auto_order_add_ons_update_request, opts)
1183
+ p status_code # => 2xx
1184
+ p headers # => { ... }
1185
+ p data # => <AutoOrderResponse>
1186
+ rescue UltracartClient::ApiError => e
1187
+ puts "Error when calling AutoOrderApi->update_auto_order_item_add_ons_with_http_info: #{e}"
1188
+ end
1189
+ ```
1190
+
1191
+ ### Parameters
1192
+
1193
+ | Name | Type | Description | Notes |
1194
+ | ---- | ---- | ----------- | ----- |
1195
+ | **auto_order_oid** | **Integer** | The auto order oid to update. | |
1196
+ | **auto_order_item_oid** | **Integer** | The auto order item oid to update. | |
1197
+ | **auto_order_add_ons_update_request** | [**AutoOrderAddonItemsUpdateRequest**](AutoOrderAddonItemsUpdateRequest.md) | Auto order add ons update request | |
1198
+ | **_expand** | **String** | The object expansion to perform on the result. See documentation for examples | [optional] |
1199
+
1200
+ ### Return type
1201
+
1202
+ [**AutoOrderResponse**](AutoOrderResponse.md)
1203
+
1204
+ ### Authorization
1205
+
1206
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1207
+
1208
+ ### HTTP request headers
1209
+
1210
+ - **Content-Type**: application/json; charset=UTF-8
1211
+ - **Accept**: application/json
1212
+
1213
+
1214
+ ## update_auto_order_item_properties
1215
+
1216
+ > <AutoOrderResponse> update_auto_order_item_properties(auto_order_oid, auto_order_item_oid, auto_order_properties_update_request, opts)
1217
+
1218
+ Update an auto order item properties
1219
+
1220
+ Update an auto order item properties. Returns the auto order based upon expansion
1221
+
1222
+
1223
+ ### Examples
1224
+
1225
+
1226
+ (No example for this operation).
1227
+
1228
+
1229
+ #### Using the update_auto_order_item_properties_with_http_info variant
1230
+
1231
+ This returns an Array which contains the response data, status code and headers.
1232
+
1233
+ > <Array(<AutoOrderResponse>, Integer, Hash)> update_auto_order_item_properties_with_http_info(auto_order_oid, auto_order_item_oid, auto_order_properties_update_request, opts)
1234
+
1235
+ ```ruby
1236
+ begin
1237
+ # Update an auto order item properties
1238
+ data, status_code, headers = api_instance.update_auto_order_item_properties_with_http_info(auto_order_oid, auto_order_item_oid, auto_order_properties_update_request, opts)
1239
+ p status_code # => 2xx
1240
+ p headers # => { ... }
1241
+ p data # => <AutoOrderResponse>
1242
+ rescue UltracartClient::ApiError => e
1243
+ puts "Error when calling AutoOrderApi->update_auto_order_item_properties_with_http_info: #{e}"
1244
+ end
1245
+ ```
1246
+
1247
+ ### Parameters
1248
+
1249
+ | Name | Type | Description | Notes |
1250
+ | ---- | ---- | ----------- | ----- |
1251
+ | **auto_order_oid** | **Integer** | The auto order oid to update. | |
1252
+ | **auto_order_item_oid** | **Integer** | The auto order item oid to update. | |
1253
+ | **auto_order_properties_update_request** | [**AutoOrderPropertiesUpdateRequest**](AutoOrderPropertiesUpdateRequest.md) | Auto order property update request | |
1254
+ | **_expand** | **String** | The object expansion to perform on the result. See documentation for examples | [optional] |
1255
+
1256
+ ### Return type
1257
+
1258
+ [**AutoOrderResponse**](AutoOrderResponse.md)
1259
+
1260
+ ### Authorization
1261
+
1262
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1263
+
1264
+ ### HTTP request headers
1265
+
1266
+ - **Content-Type**: application/json; charset=UTF-8
1267
+ - **Accept**: application/json
1268
+
1269
+
1270
+ ## update_auto_order_properties
1271
+
1272
+ > <AutoOrderResponse> update_auto_order_properties(auto_order_oid, auto_order_properties_update_request, opts)
1273
+
1274
+ Update an auto order properties
1275
+
1276
+ Update an auto order properties. Returns the auto order based upon expansion
1277
+
1278
+
1279
+ ### Examples
1280
+
1281
+
1282
+ (No example for this operation).
1283
+
1284
+
1285
+ #### Using the update_auto_order_properties_with_http_info variant
1286
+
1287
+ This returns an Array which contains the response data, status code and headers.
1288
+
1289
+ > <Array(<AutoOrderResponse>, Integer, Hash)> update_auto_order_properties_with_http_info(auto_order_oid, auto_order_properties_update_request, opts)
1290
+
1291
+ ```ruby
1292
+ begin
1293
+ # Update an auto order properties
1294
+ data, status_code, headers = api_instance.update_auto_order_properties_with_http_info(auto_order_oid, auto_order_properties_update_request, opts)
1295
+ p status_code # => 2xx
1296
+ p headers # => { ... }
1297
+ p data # => <AutoOrderResponse>
1298
+ rescue UltracartClient::ApiError => e
1299
+ puts "Error when calling AutoOrderApi->update_auto_order_properties_with_http_info: #{e}"
1300
+ end
1301
+ ```
1302
+
1303
+ ### Parameters
1304
+
1305
+ | Name | Type | Description | Notes |
1306
+ | ---- | ---- | ----------- | ----- |
1307
+ | **auto_order_oid** | **Integer** | The auto order oid to update. | |
1308
+ | **auto_order_properties_update_request** | [**AutoOrderPropertiesUpdateRequest**](AutoOrderPropertiesUpdateRequest.md) | Auto order property update request | |
1309
+ | **_expand** | **String** | The object expansion to perform on the result. See documentation for examples | [optional] |
1310
+
1311
+ ### Return type
1312
+
1313
+ [**AutoOrderResponse**](AutoOrderResponse.md)
1314
+
1315
+ ### Authorization
1316
+
1317
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1318
+
1319
+ ### HTTP request headers
1320
+
1321
+ - **Content-Type**: application/json; charset=UTF-8
1322
+ - **Accept**: application/json
1323
+
1324
+
1155
1325
  ## update_auto_orders_batch
1156
1326
 
1157
1327
  > <AutoOrdersResponse> update_auto_orders_batch(auto_orders_request, opts)
@@ -4,6 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
+ | **add_ons** | [**Array&lt;AutoOrderAddonItem&gt;**](AutoOrderAddonItem.md) | Array of addon objects instructing which items to add to auto order and how many times they should be added. | [optional] |
7
8
  | **arbitrary_item_id** | **String** | Arbitrary item id that should be rebilled instead of the normal schedule | [optional] |
8
9
  | **arbitrary_percentage_discount** | **Float** | An arbitrary percentage discount to provide on future rebills | [optional] |
9
10
  | **arbitrary_quantity** | **Float** | Arbitrary quantity to rebill | [optional] |
@@ -29,6 +30,7 @@
29
30
  | **paypal_payer_id** | **String** | The PayPal Payer ID tied to this item | [optional] |
30
31
  | **paypal_recurring_payment_profile_id** | **String** | The PayPal Profile ID tied to this item | [optional] |
31
32
  | **preshipment_notice_sent** | **Boolean** | True if the preshipment notice associated with the next rebill has been sent | [optional] |
33
+ | **properties** | [**Array&lt;AutoOrderProperty&gt;**](AutoOrderProperty.md) | Array of property objects | [optional] |
32
34
  | **rebill_value** | **Float** | The value of the rebills of this item | [optional] |
33
35
  | **remaining_repeat_count** | **Integer** | The number of rebills remaining before this item is complete | [optional] |
34
36
  | **simple_schedule** | [**AutoOrderItemSimpleSchedule**](AutoOrderItemSimpleSchedule.md) | | [optional] |
@@ -39,6 +41,7 @@
39
41
  require 'ultracart_api'
40
42
 
41
43
  instance = UltracartClient::AutoOrderItem.new(
44
+ add_ons: null,
42
45
  arbitrary_item_id: null,
43
46
  arbitrary_percentage_discount: null,
44
47
  arbitrary_quantity: null,
@@ -64,6 +67,7 @@ instance = UltracartClient::AutoOrderItem.new(
64
67
  paypal_payer_id: null,
65
68
  paypal_recurring_payment_profile_id: null,
66
69
  preshipment_notice_sent: null,
70
+ properties: null,
67
71
  rebill_value: null,
68
72
  remaining_repeat_count: null,
69
73
  simple_schedule: null
@@ -0,0 +1,18 @@
1
+ # UltracartClient::AutoOrderPropertiesUpdateRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **properties** | [**Array&lt;AutoOrderProperty&gt;**](AutoOrderProperty.md) | Properties to update | [optional] |
8
+
9
+ ## Example
10
+
11
+ ```ruby
12
+ require 'ultracart_api'
13
+
14
+ instance = UltracartClient::AutoOrderPropertiesUpdateRequest.new(
15
+ properties: null
16
+ )
17
+ ```
18
+
@@ -0,0 +1,20 @@
1
+ # UltracartClient::AutoOrderProperty
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **name** | **String** | Name of the property | [optional] |
8
+ | **value** | **String** | Value of the property | [optional] |
9
+
10
+ ## Example
11
+
12
+ ```ruby
13
+ require 'ultracart_api'
14
+
15
+ instance = UltracartClient::AutoOrderProperty.new(
16
+ name: null,
17
+ value: null
18
+ )
19
+ ```
20
+
@@ -36,6 +36,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
36
36
  | [**get_conversation_departments**](ConversationApi.md#get_conversation_departments) | **GET** /conversation/departments | Retrieve a list of departments ordered by name |
37
37
  | [**get_conversation_engagement**](ConversationApi.md#get_conversation_engagement) | **GET** /conversation/engagements/{conversation_engagement_oid} | Retrieve an engagement |
38
38
  | [**get_conversation_engagements**](ConversationApi.md#get_conversation_engagements) | **GET** /conversation/engagements | Retrieve a list of engagements ordered by name |
39
+ | [**get_conversation_item_variations**](ConversationApi.md#get_conversation_item_variations) | **GET** /conversation/items/{merchant_item_id}/variations | Retrieve an item with sparse variations populated |
39
40
  | [**get_conversation_knowledge_base_document_upload_url**](ConversationApi.md#get_conversation_knowledge_base_document_upload_url) | **GET** /conversation/agent/profiles/{user_id}/knowledge_base/upload_url/{extension} | Get a pre-signed conversation knowledge base document upload URL |
40
41
  | [**get_conversation_messages**](ConversationApi.md#get_conversation_messages) | **GET** /conversation/conversations/{conversation_uuid}/messages/{since} | Retrieve conversation messages |
41
42
  | [**get_conversation_multimedia_upload_url**](ConversationApi.md#get_conversation_multimedia_upload_url) | **GET** /conversation/upload_url/{extension} | Get a presigned conversation multimedia upload URL |
@@ -1836,6 +1837,59 @@ This endpoint does not need any parameter.
1836
1837
  - **Accept**: application/json
1837
1838
 
1838
1839
 
1840
+ ## get_conversation_item_variations
1841
+
1842
+ > <ItemResponse> get_conversation_item_variations(merchant_item_id)
1843
+
1844
+ Retrieve an item with sparse variations populated
1845
+
1846
+ Retrieve an item with sparse variations populated
1847
+
1848
+
1849
+ ### Examples
1850
+
1851
+
1852
+ (No example for this operation).
1853
+
1854
+
1855
+ #### Using the get_conversation_item_variations_with_http_info variant
1856
+
1857
+ This returns an Array which contains the response data, status code and headers.
1858
+
1859
+ > <Array(<ItemResponse>, Integer, Hash)> get_conversation_item_variations_with_http_info(merchant_item_id)
1860
+
1861
+ ```ruby
1862
+ begin
1863
+ # Retrieve an item with sparse variations populated
1864
+ data, status_code, headers = api_instance.get_conversation_item_variations_with_http_info(merchant_item_id)
1865
+ p status_code # => 2xx
1866
+ p headers # => { ... }
1867
+ p data # => <ItemResponse>
1868
+ rescue UltracartClient::ApiError => e
1869
+ puts "Error when calling ConversationApi->get_conversation_item_variations_with_http_info: #{e}"
1870
+ end
1871
+ ```
1872
+
1873
+ ### Parameters
1874
+
1875
+ | Name | Type | Description | Notes |
1876
+ | ---- | ---- | ----------- | ----- |
1877
+ | **merchant_item_id** | **String** | | |
1878
+
1879
+ ### Return type
1880
+
1881
+ [**ItemResponse**](ItemResponse.md)
1882
+
1883
+ ### Authorization
1884
+
1885
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1886
+
1887
+ ### HTTP request headers
1888
+
1889
+ - **Content-Type**: Not defined
1890
+ - **Accept**: application/json
1891
+
1892
+
1839
1893
  ## get_conversation_knowledge_base_document_upload_url
1840
1894
 
1841
1895
  > <ConversationKnowledgeBaseDocumentUploadUrlResponse> get_conversation_knowledge_base_document_upload_url(user_id, extension)
@@ -14,7 +14,7 @@
14
14
  | **postcard_container_cjson_last_modified_dts** | **String** | Timestamp the last time the container was modified. | [optional] |
15
15
  | **postcard_front_container_cjson** | **String** | Postcard front container cjson | [optional] |
16
16
  | **postcard_front_container_uuid** | **String** | Postcard front container uuid | [optional] |
17
- | **screenshot_back_url** | **String** | URL to screenshot of the front of the postcard | [optional] |
17
+ | **screenshot_back_url** | **String** | URL to screenshot of the back of the postcard | [optional] |
18
18
  | **screenshot_front_url** | **String** | URL to screenshot of the front of the postcard | [optional] |
19
19
  | **storefront_oid** | **Integer** | Storefront oid | [optional] |
20
20