ultracart_api 4.1.83 → 4.1.85
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 +4 -4
- data/README.md +17 -8
- data/docs/Item.md +2 -0
- data/docs/ItemApi.md +328 -167
- data/docs/ItemGatedCode.md +24 -0
- data/docs/{ItemShippingDistributionCenterResponse.md → ItemGatedCodeResponse.md} +4 -4
- data/docs/ItemGatedCodesRequest.md +18 -0
- data/docs/ItemGatedCodesResponse.md +26 -0
- data/docs/ItemGenerateGatedCodesRequest.md +22 -0
- data/docs/OrderApi.md +107 -0
- data/docs/Warning.md +2 -0
- data/lib/ultracart_api/api/item_api.rb +423 -226
- data/lib/ultracart_api/api/order_api.rb +126 -0
- data/lib/ultracart_api/models/item.rb +13 -1
- data/lib/ultracart_api/models/item_gated_code.rb +265 -0
- data/lib/ultracart_api/models/{item_shipping_distribution_center_response.rb → item_gated_code_response.rb} +10 -10
- data/lib/ultracart_api/models/{item_inventory_update_request.rb → item_gated_codes_request.rb} +12 -12
- data/lib/ultracart_api/models/item_gated_codes_response.rb +259 -0
- data/lib/ultracart_api/models/{item_inventory_update.rb → item_generate_gated_codes_request.rb} +27 -25
- data/lib/ultracart_api/models/order_query.rb +2 -2
- data/lib/ultracart_api/models/warning.rb +11 -1
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +5 -3
- metadata +12 -8
- data/docs/ItemInventoryUpdate.md +0 -22
- data/docs/ItemInventoryUpdateRequest.md +0 -18
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: b4dc4707ec92c97447f89b7672c1ed259f460726ce9070a05f703ceb675567d9
|
|
4
|
+
data.tar.gz: 6f6e2f35db2231846dc4e23774a554eb999781bb3efb5a6c4b648728682d74c1
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: d5dc9ceafd811738990645dd7062fa6f9c7f603a1cad472e74b84ffb83b3688eafacf9a902c910d531684000a7bdb66044156282ccb56a0a5c9a908f64eff24a
|
|
7
|
+
data.tar.gz: f4c6b80d11a02a22767504284bbd4f64470750cc6d707289dd2a5cdbeb81abbcf7ae05e5f118a003de0176317248e8c698603e5e68cce78e2d65ef1fdf138f3f
|
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.
|
|
10
|
+
- Package version: 4.1.85
|
|
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.
|
|
19
|
+
gem 'ultracart_api', '4.1.85'
|
|
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.
|
|
@@ -410,6 +413,8 @@ Class | Method | HTTP request | Description
|
|
|
410
413
|
*UltracartClient::OrderApi* | [**generate_order_token**](docs/OrderApi.md#generate_order_token) | **GET** /order/orders/token/{order_id} | Generate an order token for a given order id
|
|
411
414
|
*UltracartClient::OrderApi* | [**generate_packing_slip_all_dc**](docs/OrderApi.md#generate_packing_slip_all_dc) | **GET** /order/orders/{order_id}/packing_slip | Generate a packing slip for this order across all distribution centers.
|
|
412
415
|
*UltracartClient::OrderApi* | [**generate_packing_slip_specific_dc**](docs/OrderApi.md#generate_packing_slip_specific_dc) | **GET** /order/orders/{order_id}/packing_slip/{distribution_center_code} | Generate a packing slip for this order for the given distribution center.
|
|
416
|
+
*UltracartClient::OrderApi* | [**get_accounts_receivable_detail_value_histogram**](docs/OrderApi.md#get_accounts_receivable_detail_value_histogram) | **GET** /order/accounts_receivable/detail_value_histogram | Retrieve a value histogram for a given AR transaction-detail name
|
|
417
|
+
*UltracartClient::OrderApi* | [**get_accounts_receivable_gateway_detail_names**](docs/OrderApi.md#get_accounts_receivable_gateway_detail_names) | **GET** /order/accounts_receivable/gateway_detail_names | Retrieve gateway / detail-name picker data for the AR filter modal
|
|
413
418
|
*UltracartClient::OrderApi* | [**get_accounts_receivable_retry_config**](docs/OrderApi.md#get_accounts_receivable_retry_config) | **GET** /order/accountsReceivableRetryConfig | Retrieve A/R Retry Configuration
|
|
414
419
|
*UltracartClient::OrderApi* | [**get_accounts_receivable_retry_stats**](docs/OrderApi.md#get_accounts_receivable_retry_stats) | **GET** /order/accountsReceivableRetryConfig/stats | Retrieve A/R Retry Statistics
|
|
415
420
|
*UltracartClient::OrderApi* | [**get_order**](docs/OrderApi.md#get_order) | **GET** /order/orders/{order_id} | Retrieve an order
|
|
@@ -1319,6 +1324,11 @@ Class | Method | HTTP request | Description
|
|
|
1319
1324
|
- [UltracartClient::ItemEmailNotifications](docs/ItemEmailNotifications.md)
|
|
1320
1325
|
- [UltracartClient::ItemEnrollment123](docs/ItemEnrollment123.md)
|
|
1321
1326
|
- [UltracartClient::ItemFulfillmentAddon](docs/ItemFulfillmentAddon.md)
|
|
1327
|
+
- [UltracartClient::ItemGatedCode](docs/ItemGatedCode.md)
|
|
1328
|
+
- [UltracartClient::ItemGatedCodeResponse](docs/ItemGatedCodeResponse.md)
|
|
1329
|
+
- [UltracartClient::ItemGatedCodesRequest](docs/ItemGatedCodesRequest.md)
|
|
1330
|
+
- [UltracartClient::ItemGatedCodesResponse](docs/ItemGatedCodesResponse.md)
|
|
1331
|
+
- [UltracartClient::ItemGenerateGatedCodesRequest](docs/ItemGenerateGatedCodesRequest.md)
|
|
1322
1332
|
- [UltracartClient::ItemGiftCertificate](docs/ItemGiftCertificate.md)
|
|
1323
1333
|
- [UltracartClient::ItemGoogleProductSearch](docs/ItemGoogleProductSearch.md)
|
|
1324
1334
|
- [UltracartClient::ItemIdentifiers](docs/ItemIdentifiers.md)
|
|
@@ -1328,8 +1338,6 @@ Class | Method | HTTP request | Description
|
|
|
1328
1338
|
- [UltracartClient::ItemInventorySnapshot](docs/ItemInventorySnapshot.md)
|
|
1329
1339
|
- [UltracartClient::ItemInventorySnapshotDistributionCenter](docs/ItemInventorySnapshotDistributionCenter.md)
|
|
1330
1340
|
- [UltracartClient::ItemInventorySnapshotResponse](docs/ItemInventorySnapshotResponse.md)
|
|
1331
|
-
- [UltracartClient::ItemInventoryUpdate](docs/ItemInventoryUpdate.md)
|
|
1332
|
-
- [UltracartClient::ItemInventoryUpdateRequest](docs/ItemInventoryUpdateRequest.md)
|
|
1333
1341
|
- [UltracartClient::ItemKitComponent](docs/ItemKitComponent.md)
|
|
1334
1342
|
- [UltracartClient::ItemKitDefinition](docs/ItemKitDefinition.md)
|
|
1335
1343
|
- [UltracartClient::ItemOption](docs/ItemOption.md)
|
|
@@ -1361,7 +1369,6 @@ Class | Method | HTTP request | Description
|
|
|
1361
1369
|
- [UltracartClient::ItemShippingDestinationMarkup](docs/ItemShippingDestinationMarkup.md)
|
|
1362
1370
|
- [UltracartClient::ItemShippingDestinationRestriction](docs/ItemShippingDestinationRestriction.md)
|
|
1363
1371
|
- [UltracartClient::ItemShippingDistributionCenter](docs/ItemShippingDistributionCenter.md)
|
|
1364
|
-
- [UltracartClient::ItemShippingDistributionCenterResponse](docs/ItemShippingDistributionCenterResponse.md)
|
|
1365
1372
|
- [UltracartClient::ItemShippingMethod](docs/ItemShippingMethod.md)
|
|
1366
1373
|
- [UltracartClient::ItemShippingPackageRequirement](docs/ItemShippingPackageRequirement.md)
|
|
1367
1374
|
- [UltracartClient::ItemTag](docs/ItemTag.md)
|
|
@@ -1728,6 +1735,8 @@ Not every change is committed to every SDK.
|
|
|
1728
1735
|
|
|
1729
1736
|
| Version | Date | Comments |
|
|
1730
1737
|
| --: | :-: | --- |
|
|
1738
|
+
| 4.1.85 | 05/05/2026 | improved warning object for customer insertCustomer and updateCustomer |
|
|
1739
|
+
| 4.1.84 | 05/04/2026 | Order API - add hold stage to allowed values on order query request |
|
|
1731
1740
|
| 4.1.83 | 04/29/2026 | AO support for item appending on cancel request, order payment method test routing on hold release |
|
|
1732
1741
|
| 4.1.82 | 04/27/2026 | converation - agent status and availability |
|
|
1733
1742
|
| 4.1.81 | 04/27/2026 | conversations - agent status and availability |
|
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,
|