ultracart_api 4.1.82 → 4.1.84

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 (28) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +15 -8
  3. data/docs/AutoOrderItemCancelRequest.md +3 -1
  4. data/docs/ConversationAgentStatusEvent.md +2 -0
  5. data/docs/ConversationPbxCallAgent.md +2 -0
  6. data/docs/Item.md +2 -0
  7. data/docs/ItemApi.md +328 -167
  8. data/docs/ItemGatedCode.md +24 -0
  9. data/docs/{ItemShippingDistributionCenterResponse.md → ItemGatedCodeResponse.md} +4 -4
  10. data/docs/ItemGatedCodesRequest.md +18 -0
  11. data/docs/ItemGatedCodesResponse.md +26 -0
  12. data/docs/ItemGenerateGatedCodesRequest.md +22 -0
  13. data/lib/ultracart_api/api/item_api.rb +423 -226
  14. data/lib/ultracart_api/models/auto_order_item_cancel_request.rb +14 -2
  15. data/lib/ultracart_api/models/conversation_agent_status_event.rb +11 -1
  16. data/lib/ultracart_api/models/conversation_pbx_call_agent.rb +11 -1
  17. data/lib/ultracart_api/models/item.rb +13 -1
  18. data/lib/ultracart_api/models/item_gated_code.rb +265 -0
  19. data/lib/ultracart_api/models/{item_shipping_distribution_center_response.rb → item_gated_code_response.rb} +10 -10
  20. data/lib/ultracart_api/models/{item_inventory_update_request.rb → item_gated_codes_request.rb} +12 -12
  21. data/lib/ultracart_api/models/item_gated_codes_response.rb +259 -0
  22. data/lib/ultracart_api/models/{item_inventory_update.rb → item_generate_gated_codes_request.rb} +27 -25
  23. data/lib/ultracart_api/models/order_query.rb +2 -2
  24. data/lib/ultracart_api/version.rb +1 -1
  25. data/lib/ultracart_api.rb +5 -3
  26. metadata +12 -8
  27. data/docs/ItemInventoryUpdate.md +0 -22
  28. data/docs/ItemInventoryUpdateRequest.md +0 -18
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 8aaed656cc976cd373c03c99e5256c57c34f96934b5f195e7c5bade723a61cf3
4
- data.tar.gz: 5808b14252013fd02f424178ce1d21df042b5627feaba74b102b03bc8ef53e77
3
+ metadata.gz: b8728bb3fa0c26246f58c8188529196d268b7dd187c8297f3e85dbdc475ca1e1
4
+ data.tar.gz: d43769ea615c3bb8167a3f0a5325a24e624f13afe505571ca6b73a8d68e042c9
5
5
  SHA512:
6
- metadata.gz: 2b08f8fc9f672f3755bf1395f567208a07a4a8064085a91487d2867f7fb97632017e31b273485ecb1762e05fc507fa36496f7cafd4d72d74030c05eeb5ab9e77
7
- data.tar.gz: 7f5879c236d140b646dd17e7ce03939d80ed90cbc971b7590b61fc7e2cc19531b41eeeb082759092fe3bacf5c58987ab3da59c0a54b8908da5bcc163caeefa4a
6
+ metadata.gz: 66f34f4045d3997e67bd952ced21ab23225a0da708d5bdc6c88d920771745533332c23a37d5cafd23063276cc744880874b3a54c8673c86bc0f143c4cba8bd9a
7
+ data.tar.gz: c644a2149626b1605e1f2705c86cd2321c4d252d2b0c3ce12b442a79e6accf20fc8f19a9f4a9b3c54a3933a30c7e66bcdff0704bdabbb5698dc0e89495664be3
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.82
10
+ - Package version: 4.1.84
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.82'
19
+ gem 'ultracart_api', '4.1.84'
20
20
  ```
21
21
 
22
22
  install:
@@ -370,29 +370,32 @@ Class | Method | HTTP request | Description
370
370
  *UltracartClient::IntegrationLogApi* | [**get_integration_log_file_pdf**](docs/IntegrationLogApi.md#get_integration_log_file_pdf) | **GET** /integration_log/query/{pk}/{sk}/{uuid}/pdf | Retrieve an integration log file converted to PDF
371
371
  *UltracartClient::IntegrationLogApi* | [**get_integration_log_summaries_query**](docs/IntegrationLogApi.md#get_integration_log_summaries_query) | **POST** /integration_log/summary/query | Retrieve integration log summaries
372
372
  *UltracartClient::IntegrationLogApi* | [**get_integration_logs_query**](docs/IntegrationLogApi.md#get_integration_logs_query) | **POST** /integration_log/query | Retrieve integration logs
373
+ *UltracartClient::ItemApi* | [**delete_all_gated_codes**](docs/ItemApi.md#delete_all_gated_codes) | **DELETE** /item/items/{merchant_item_oid}/gated_codes | Delete all gated access codes for an item
373
374
  *UltracartClient::ItemApi* | [**delete_digital_item**](docs/ItemApi.md#delete_digital_item) | **DELETE** /item/digital_library/{digital_item_oid} | Delete a digital item, which is a file within the digital library, not an actual merchant item
375
+ *UltracartClient::ItemApi* | [**delete_gated_code**](docs/ItemApi.md#delete_gated_code) | **DELETE** /item/items/{merchant_item_oid}/gated_codes/{merchant_item_gated_code_oid} | Delete a gated access code by OID
374
376
  *UltracartClient::ItemApi* | [**delete_item**](docs/ItemApi.md#delete_item) | **DELETE** /item/items/{merchant_item_oid} | Delete an item
375
377
  *UltracartClient::ItemApi* | [**delete_review**](docs/ItemApi.md#delete_review) | **DELETE** /item/items/{merchant_item_oid}/reviews/{review_oid} | Delete a review
378
+ *UltracartClient::ItemApi* | [**generate_gated_codes**](docs/ItemApi.md#generate_gated_codes) | **POST** /item/items/{merchant_item_oid}/gated_codes/generate | Generate a batch of gated access codes
376
379
  *UltracartClient::ItemApi* | [**get_digital_item**](docs/ItemApi.md#get_digital_item) | **GET** /item/digital_library/{digital_item_oid} | Retrieve a digital item from the digital library, which are digital files that may be attached to normal items
377
380
  *UltracartClient::ItemApi* | [**get_digital_items**](docs/ItemApi.md#get_digital_items) | **GET** /item/digital_library | Retrieve digital items from the digital library which are digital files that may be attached to normal items
378
381
  *UltracartClient::ItemApi* | [**get_digital_items_by_external_id**](docs/ItemApi.md#get_digital_items_by_external_id) | **GET** /item/digital_library/by_external/{external_id} | Retrieves digital items from the digital library (which are digital files that may be attached to normal items) that having a matching external id
382
+ *UltracartClient::ItemApi* | [**get_gated_codes**](docs/ItemApi.md#get_gated_codes) | **GET** /item/items/{merchant_item_oid}/gated_codes | Get gated access codes for an item
379
383
  *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.
380
384
  *UltracartClient::ItemApi* | [**get_item**](docs/ItemApi.md#get_item) | **GET** /item/items/{merchant_item_oid} | Retrieve an item
381
385
  *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
382
- *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
383
386
  *UltracartClient::ItemApi* | [**get_items**](docs/ItemApi.md#get_items) | **GET** /item/items | Retrieve items
384
387
  *UltracartClient::ItemApi* | [**get_pricing_tiers**](docs/ItemApi.md#get_pricing_tiers) | **GET** /item/pricing_tiers | Retrieve pricing tiers
385
388
  *UltracartClient::ItemApi* | [**get_review**](docs/ItemApi.md#get_review) | **GET** /item/items/{merchant_item_oid}/reviews/{review_oid} | Get a review
386
389
  *UltracartClient::ItemApi* | [**get_reviews**](docs/ItemApi.md#get_reviews) | **GET** /item/items/{merchant_item_oid}/reviews | Get reviews for an item
387
390
  *UltracartClient::ItemApi* | [**get_unassociated_digital_items**](docs/ItemApi.md#get_unassociated_digital_items) | **GET** /item/digital_library/unassociated | Retrieve digital items from the digital library (which are digital files that may be attached to normal items) not yet associated with actual items
388
391
  *UltracartClient::ItemApi* | [**insert_digital_item**](docs/ItemApi.md#insert_digital_item) | **POST** /item/digital_library | Create a file within the digital library
392
+ *UltracartClient::ItemApi* | [**insert_gated_code**](docs/ItemApi.md#insert_gated_code) | **POST** /item/items/{merchant_item_oid}/gated_codes | Add a single gated access code to an item
389
393
  *UltracartClient::ItemApi* | [**insert_item**](docs/ItemApi.md#insert_item) | **POST** /item/items | Create an item
390
394
  *UltracartClient::ItemApi* | [**insert_review**](docs/ItemApi.md#insert_review) | **POST** /item/items/{merchant_item_oid}/reviews | Insert a review
391
395
  *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
396
+ *UltracartClient::ItemApi* | [**replace_gated_codes**](docs/ItemApi.md#replace_gated_codes) | **PUT** /item/items/{merchant_item_oid}/gated_codes | Replace the full list of gated access codes for an item
392
397
  *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
393
398
  *UltracartClient::ItemApi* | [**update_item**](docs/ItemApi.md#update_item) | **PUT** /item/items/{merchant_item_oid} | Update an item
394
- *UltracartClient::ItemApi* | [**update_item_inventories**](docs/ItemApi.md#update_item_inventories) | **PUT** /item/items/update_item_inventories | Update item inventories for a distribution center
395
- *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
396
399
  *UltracartClient::ItemApi* | [**update_items**](docs/ItemApi.md#update_items) | **PUT** /item/items/batch | Update multiple items
397
400
  *UltracartClient::ItemApi* | [**update_review**](docs/ItemApi.md#update_review) | **PUT** /item/items/{merchant_item_oid}/reviews/{review_oid} | Update a review
398
401
  *UltracartClient::ItemApi* | [**upload_temporary_multimedia**](docs/ItemApi.md#upload_temporary_multimedia) | **POST** /item/temp_multimedia | Upload an image to the temporary multimedia.
@@ -1319,6 +1322,11 @@ Class | Method | HTTP request | Description
1319
1322
  - [UltracartClient::ItemEmailNotifications](docs/ItemEmailNotifications.md)
1320
1323
  - [UltracartClient::ItemEnrollment123](docs/ItemEnrollment123.md)
1321
1324
  - [UltracartClient::ItemFulfillmentAddon](docs/ItemFulfillmentAddon.md)
1325
+ - [UltracartClient::ItemGatedCode](docs/ItemGatedCode.md)
1326
+ - [UltracartClient::ItemGatedCodeResponse](docs/ItemGatedCodeResponse.md)
1327
+ - [UltracartClient::ItemGatedCodesRequest](docs/ItemGatedCodesRequest.md)
1328
+ - [UltracartClient::ItemGatedCodesResponse](docs/ItemGatedCodesResponse.md)
1329
+ - [UltracartClient::ItemGenerateGatedCodesRequest](docs/ItemGenerateGatedCodesRequest.md)
1322
1330
  - [UltracartClient::ItemGiftCertificate](docs/ItemGiftCertificate.md)
1323
1331
  - [UltracartClient::ItemGoogleProductSearch](docs/ItemGoogleProductSearch.md)
1324
1332
  - [UltracartClient::ItemIdentifiers](docs/ItemIdentifiers.md)
@@ -1328,8 +1336,6 @@ Class | Method | HTTP request | Description
1328
1336
  - [UltracartClient::ItemInventorySnapshot](docs/ItemInventorySnapshot.md)
1329
1337
  - [UltracartClient::ItemInventorySnapshotDistributionCenter](docs/ItemInventorySnapshotDistributionCenter.md)
1330
1338
  - [UltracartClient::ItemInventorySnapshotResponse](docs/ItemInventorySnapshotResponse.md)
1331
- - [UltracartClient::ItemInventoryUpdate](docs/ItemInventoryUpdate.md)
1332
- - [UltracartClient::ItemInventoryUpdateRequest](docs/ItemInventoryUpdateRequest.md)
1333
1339
  - [UltracartClient::ItemKitComponent](docs/ItemKitComponent.md)
1334
1340
  - [UltracartClient::ItemKitDefinition](docs/ItemKitDefinition.md)
1335
1341
  - [UltracartClient::ItemOption](docs/ItemOption.md)
@@ -1361,7 +1367,6 @@ Class | Method | HTTP request | Description
1361
1367
  - [UltracartClient::ItemShippingDestinationMarkup](docs/ItemShippingDestinationMarkup.md)
1362
1368
  - [UltracartClient::ItemShippingDestinationRestriction](docs/ItemShippingDestinationRestriction.md)
1363
1369
  - [UltracartClient::ItemShippingDistributionCenter](docs/ItemShippingDistributionCenter.md)
1364
- - [UltracartClient::ItemShippingDistributionCenterResponse](docs/ItemShippingDistributionCenterResponse.md)
1365
1370
  - [UltracartClient::ItemShippingMethod](docs/ItemShippingMethod.md)
1366
1371
  - [UltracartClient::ItemShippingPackageRequirement](docs/ItemShippingPackageRequirement.md)
1367
1372
  - [UltracartClient::ItemTag](docs/ItemTag.md)
@@ -1728,6 +1733,8 @@ Not every change is committed to every SDK.
1728
1733
 
1729
1734
  | Version | Date | Comments |
1730
1735
  | --: | :-: | --- |
1736
+ | 4.1.84 | 05/04/2026 | Order API - add hold stage to allowed values on order query request |
1737
+ | 4.1.83 | 04/29/2026 | AO support for item appending on cancel request, order payment method test routing on hold release |
1731
1738
  | 4.1.82 | 04/27/2026 | converation - agent status and availability |
1732
1739
  | 4.1.81 | 04/27/2026 | conversations - agent status and availability |
1733
1740
  | 4.1.80 | 04/22/2026 | customer - e.164 read only fields on billing/shipping child objects |
data/docs/AutoOrderItemCancelRequest.md CHANGED
@@ -4,7 +4,8 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
- | **auto_order_item_oid** | **Integer** | Optional tiebreaker when more than one item on the auto order shares the same original_item_id. When present, the item with this oid is targeted and its original_item_id must match the URL path parameter (safety check). Leave unset for the common case of a unique original_item_id. | [optional] |
7
+ | **append_items** | [**Array<AutoOrderItem>**](AutoOrderItem.md) | Specifying these items allows for an easier immutable item contact. Validation will occur before any operations take place. After the end/remove operation is successful, append these additional item(s) to the auto order. The changes will be available in the response if the expansion includes items. | [optional] |
8
+ | **auto_order_item_oid** | **Integer** | Optional tiebreaker when more than one item on the auto order shares the same original_item_id. When present, the item with this oid is targeted and its original_item_id must match the URL path parameter (safety check). Leave unset for the common case of a unique original_item_id. For reference the order_item.item_reference_oid is the same value as auto_order_item.auto_order_item_oid UNLESS the a manual edit took place AFTER the original order was placed. | [optional] |
8
9
  | **mode** | **String** | Cancellation mode. 'end' soft-cancels the item by setting no_order_after_dts to the current time, preserving the row for reporting. 'remove' hard-deletes the item from the auto order. Defaults to 'end' (the less destructive option) when omitted. | [optional] |
9
10
 
10
11
  ## Example
@@ -13,6 +14,7 @@
13
14
  require 'ultracart_api'
14
15
 
15
16
  instance = UltracartClient::AutoOrderItemCancelRequest.new(
17
+ append_items: null,
16
18
  auto_order_item_oid: null,
17
19
  mode: null
18
20
  )
data/docs/ConversationAgentStatusEvent.md CHANGED
@@ -4,6 +4,7 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
+ | **agent_identifier** | **String** | Agent identifier — voice_identity for PBX (e.g. 'client:login'), participant_arn for chat, synthetic 'ai:<user_id>' for AI flag events. Stable across an agent's events; participates in DDB pk and GSI1 sk. | [optional] |
7
8
  | **agent_name** | **String** | Agent display name at the time of the event | [optional] |
8
9
  | **agent_type** | **String** | Agent type | [optional] |
9
10
  | **agent_user_id** | **String** | Agent user id (links across channels) | [optional] |
@@ -27,6 +28,7 @@
27
28
  require 'ultracart_api'
28
29
 
29
30
  instance = UltracartClient::ConversationAgentStatusEvent.new(
31
+ agent_identifier: null,
30
32
  agent_name: null,
31
33
  agent_type: null,
32
34
  agent_user_id: null,
data/docs/ConversationPbxCallAgent.md CHANGED
@@ -7,6 +7,7 @@
7
7
  | **agent_extension** | **String** | Agent's phone extension | [optional] |
8
8
  | **agent_id** | **String** | Unique identifier for the agent | [optional] |
9
9
  | **agent_name** | **String** | Display name of the agent | [optional] |
10
+ | **agent_user_id** | **String** | UltraCart user id for the agent (denormalized at index time so reporting endpoints can join on agent_user_id without translating from the agent_id login). | [optional] |
10
11
  | **answered** | **Boolean** | Whether the agent answered the call | [optional] |
11
12
  | **call_sid** | **String** | Twilio call SID for the agent's call leg | [optional] |
12
13
  | **joined_at_dts** | **String** | Timestamp when the agent joined the call | [optional] |
@@ -23,6 +24,7 @@ instance = UltracartClient::ConversationPbxCallAgent.new(
23
24
  agent_extension: null,
24
25
  agent_id: null,
25
26
  agent_name: null,
27
+ agent_user_id: null,
26
28
  answered: null,
27
29
  call_sid: null,
28
30
  joined_at_dts: null,
data/docs/Item.md CHANGED
@@ -20,6 +20,7 @@
20
20
  | **email_notifications** | [**ItemEmailNotifications**](ItemEmailNotifications.md) | | [optional] |
21
21
  | **enrollment123** | [**ItemEnrollment123**](ItemEnrollment123.md) | | [optional] |
22
22
  | **fulfillment_addons** | [**Array<ItemFulfillmentAddon>**](ItemFulfillmentAddon.md) | Fulfillment Add-ons | [optional] |
23
+ | **gated_codes** | [**Array<ItemGatedCode>**](ItemGatedCode.md) | Gated access codes for this item. Read-only on this object. Use the /items/{merchant_item_oid}/gated_codes endpoints to manage. | [optional] |
23
24
  | **gift_certificate** | [**ItemGiftCertificate**](ItemGiftCertificate.md) | | [optional] |
24
25
  | **google_product_search** | [**ItemGoogleProductSearch**](ItemGoogleProductSearch.md) | | [optional] |
25
26
  | **identifiers** | [**ItemIdentifiers**](ItemIdentifiers.md) | | [optional] |
@@ -78,6 +79,7 @@ instance = UltracartClient::Item.new(
78
79
  email_notifications: null,
79
80
  enrollment123: null,
80
81
  fulfillment_addons: null,
82
+ gated_codes: null,
81
83
  gift_certificate: null,
82
84
  google_product_search: null,
83
85
  identifiers: null,