ultracart_api 4.1.57 → 4.1.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: 9498240fb0695280ac3c7c08be852d2e493aacf97bdc1acbfd2582de6185e105
4
- data.tar.gz: a60ae09cf9b122ad973a2b0101be7846ebbc06ffd107101aae321331d73c36da
3
+ metadata.gz: 7d0bf9840e526c1fd1a79d5195fb6d64ce24aa4061ce4fb55a23c3bb19a5d719
4
+ data.tar.gz: 73f41a2e74f316f355d5129625b0fbae7c3fa3a468773a27935d92f89b1a20cd
5
5
  SHA512:
6
- metadata.gz: 6e88ae0c21d05a118352e9ef8d799e2e2ca2317e540e885d00414d1446a378be0addf323387010498b01fcd35d5d9adcb4f216ea3d848221165d2fde22763170
7
- data.tar.gz: 87a375ac90b8ebeb5ba344659f96cea76f8676a2b64ab989b42ccaefb20733bdd7254042ab680402da89b16f3532728adedeb605ec2d1bca49a1412db7ee0fd0
6
+ metadata.gz: 04c6b026aaf1afe4880e28bffe349d0c286d7773e5cf582089ed669dbb900ac3c75cf841a7a4976703cb1b741dd7bcff58b7d40e3cad3aa07c661235ca04ccb1
7
+ data.tar.gz: 88da9adbc8e750e6ae220a9e14fd0eeac0e6f2c877922f750842d6727b2a829a5b3349a3bc1bb6628d5429850c4b3956d277ea4a9a453c020e45cc14dd002e14
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.57
10
+ - Package version: 4.1.58
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.57'
19
+ gem 'ultracart_api', '4.1.58'
20
20
  ```
21
21
 
22
22
  install:
@@ -353,7 +353,6 @@ Class | Method | HTTP request | Description
353
353
  *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
354
  *UltracartClient::ItemApi* | [**get_item**](docs/ItemApi.md#get_item) | **GET** /item/items/{merchant_item_oid} | Retrieve an item
355
355
  *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
356
- *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
357
356
  *UltracartClient::ItemApi* | [**get_items**](docs/ItemApi.md#get_items) | **GET** /item/items | Retrieve items
358
357
  *UltracartClient::ItemApi* | [**get_pricing_tiers**](docs/ItemApi.md#get_pricing_tiers) | **GET** /item/pricing_tiers | Retrieve pricing tiers
359
358
  *UltracartClient::ItemApi* | [**get_review**](docs/ItemApi.md#get_review) | **GET** /item/items/{merchant_item_oid}/reviews/{review_oid} | Get a review
@@ -365,8 +364,6 @@ Class | Method | HTTP request | Description
365
364
  *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
366
365
  *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
367
366
  *UltracartClient::ItemApi* | [**update_item**](docs/ItemApi.md#update_item) | **PUT** /item/items/{merchant_item_oid} | Update an item
368
- *UltracartClient::ItemApi* | [**update_item_inventories**](docs/ItemApi.md#update_item_inventories) | **PUT** /item/items/update_item_inventories | Update item inventories for a distribution center
369
- *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
370
367
  *UltracartClient::ItemApi* | [**update_items**](docs/ItemApi.md#update_items) | **PUT** /item/items/batch | Update multiple items
371
368
  *UltracartClient::ItemApi* | [**update_review**](docs/ItemApi.md#update_review) | **PUT** /item/items/{merchant_item_oid}/reviews/{review_oid} | Update a review
372
369
  *UltracartClient::ItemApi* | [**upload_temporary_multimedia**](docs/ItemApi.md#upload_temporary_multimedia) | **POST** /item/temp_multimedia | Upload an image to the temporary multimedia.
@@ -388,6 +385,7 @@ Class | Method | HTTP request | Description
388
385
  *UltracartClient::OrderApi* | [**get_order**](docs/OrderApi.md#get_order) | **GET** /order/orders/{order_id} | Retrieve an order
389
386
  *UltracartClient::OrderApi* | [**get_order_by_token**](docs/OrderApi.md#get_order_by_token) | **POST** /order/orders/token | Retrieve an order using a token
390
387
  *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.
388
+ *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
391
389
  *UltracartClient::OrderApi* | [**get_orders**](docs/OrderApi.md#get_orders) | **GET** /order/orders | Retrieve orders
392
390
  *UltracartClient::OrderApi* | [**get_orders_batch**](docs/OrderApi.md#get_orders_batch) | **POST** /order/orders/batch | Retrieve order batch
393
391
  *UltracartClient::OrderApi* | [**get_orders_by_query**](docs/OrderApi.md#get_orders_by_query) | **POST** /order/orders/query | Retrieve orders by query
@@ -1271,8 +1269,6 @@ Class | Method | HTTP request | Description
1271
1269
  - [UltracartClient::ItemInventorySnapshot](docs/ItemInventorySnapshot.md)
1272
1270
  - [UltracartClient::ItemInventorySnapshotDistributionCenter](docs/ItemInventorySnapshotDistributionCenter.md)
1273
1271
  - [UltracartClient::ItemInventorySnapshotResponse](docs/ItemInventorySnapshotResponse.md)
1274
- - [UltracartClient::ItemInventoryUpdate](docs/ItemInventoryUpdate.md)
1275
- - [UltracartClient::ItemInventoryUpdateRequest](docs/ItemInventoryUpdateRequest.md)
1276
1272
  - [UltracartClient::ItemKitComponent](docs/ItemKitComponent.md)
1277
1273
  - [UltracartClient::ItemKitDefinition](docs/ItemKitDefinition.md)
1278
1274
  - [UltracartClient::ItemOption](docs/ItemOption.md)
@@ -1304,7 +1300,6 @@ Class | Method | HTTP request | Description
1304
1300
  - [UltracartClient::ItemShippingDestinationMarkup](docs/ItemShippingDestinationMarkup.md)
1305
1301
  - [UltracartClient::ItemShippingDestinationRestriction](docs/ItemShippingDestinationRestriction.md)
1306
1302
  - [UltracartClient::ItemShippingDistributionCenter](docs/ItemShippingDistributionCenter.md)
1307
- - [UltracartClient::ItemShippingDistributionCenterResponse](docs/ItemShippingDistributionCenterResponse.md)
1308
1303
  - [UltracartClient::ItemShippingMethod](docs/ItemShippingMethod.md)
1309
1304
  - [UltracartClient::ItemShippingPackageRequirement](docs/ItemShippingPackageRequirement.md)
1310
1305
  - [UltracartClient::ItemTag](docs/ItemTag.md)
@@ -1410,6 +1405,7 @@ Class | Method | HTTP request | Description
1410
1405
  - [UltracartClient::OrderTrackingNumberDetail](docs/OrderTrackingNumberDetail.md)
1411
1406
  - [UltracartClient::OrderTrackingNumberDetails](docs/OrderTrackingNumberDetails.md)
1412
1407
  - [UltracartClient::OrderTransactionalMerchantNote](docs/OrderTransactionalMerchantNote.md)
1408
+ - [UltracartClient::OrderUpsellCartRequest](docs/OrderUpsellCartRequest.md)
1413
1409
  - [UltracartClient::OrderUtm](docs/OrderUtm.md)
1414
1410
  - [UltracartClient::OrderValidationRequest](docs/OrderValidationRequest.md)
1415
1411
  - [UltracartClient::OrderValidationResponse](docs/OrderValidationResponse.md)
@@ -1667,6 +1663,7 @@ Not every change is committed to every SDK.
1667
1663
 
1668
1664
  | Version | Date | Comments |
1669
1665
  | --: | :-: | --- |
1666
+ | 4.1.58 | 02/10/2026 | conversations - new method to look up an item with sparse variations. |
1670
1667
  | 4.1.57 | 02/03/2026 | conversations - pbx class of service objects and endpoints |
1671
1668
  | 4.1.56 | 02/02/2026 | conversations - add default phone number to the agent auth |
1672
1669
  | 4.1.55 | 02/02/2026 | conversations - add enumerated values for say voice on queue and agent |
@@ -3101,6 +3101,7 @@ end
3101
3101
  | ---- | ---- | ----------- | ----- |
3102
3102
  | **since** | **String** | ISO timestamp to filter entries since | [optional] |
3103
3103
  | **agent_login** | **String** | Filter by agent login | [optional] |
3104
+ | **action** | **String** | Action | [optional] |
3104
3105
  | **limit** | **Integer** | Maximum number of entries to return (default 100) | [optional] |
3105
3106
 
3106
3107
  ### Return type
@@ -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 back of the postcard | [optional] |
17
+ | **screenshot_back_url** | **String** | URL to screenshot of the front 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
 
data/docs/ItemApi.md CHANGED
@@ -13,7 +13,6 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
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 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
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. |
@@ -838,62 +835,6 @@ end
838
835
  - **Accept**: application/json
839
836
 
840
837
 
841
- ## get_item_shipping_distribution_center_by_code
842
-
843
- > <ItemShippingDistributionCenterResponse> get_item_shipping_distribution_center_by_code(merchant_item_oid, distribution_center_code, opts)
844
-
845
- Retrieve an item shipping distribution center
846
-
847
- Retrieve an item shipping distribution center.
848
-
849
-
850
- ### Examples
851
-
852
-
853
- (No example for this operation).
854
-
855
-
856
- #### Using the get_item_shipping_distribution_center_by_code_with_http_info variant
857
-
858
- This returns an Array which contains the response data, status code and headers.
859
-
860
- > <Array(<ItemShippingDistributionCenterResponse>, Integer, Hash)> get_item_shipping_distribution_center_by_code_with_http_info(merchant_item_oid, distribution_center_code, opts)
861
-
862
- ```ruby
863
- begin
864
- # Retrieve an item shipping distribution center
865
- data, status_code, headers = api_instance.get_item_shipping_distribution_center_by_code_with_http_info(merchant_item_oid, distribution_center_code, opts)
866
- p status_code # => 2xx
867
- p headers # => { ... }
868
- p data # => <ItemShippingDistributionCenterResponse>
869
- rescue UltracartClient::ApiError => e
870
- puts "Error when calling ItemApi->get_item_shipping_distribution_center_by_code_with_http_info: #{e}"
871
- end
872
- ```
873
-
874
- ### Parameters
875
-
876
- | Name | Type | Description | Notes |
877
- | ---- | ---- | ----------- | ----- |
878
- | **merchant_item_oid** | **Integer** | The item oid to retrieve. | |
879
- | **distribution_center_code** | **String** | | |
880
- | **_expand** | **String** | The object expansion to perform on the result. See documentation for examples | [optional] |
881
- | **_placeholders** | **Boolean** | Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API. | [optional] |
882
-
883
- ### Return type
884
-
885
- [**ItemShippingDistributionCenterResponse**](ItemShippingDistributionCenterResponse.md)
886
-
887
- ### Authorization
888
-
889
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
890
-
891
- ### HTTP request headers
892
-
893
- - **Content-Type**: Not defined
894
- - **Accept**: application/json
895
-
896
-
897
838
  ## get_items
898
839
 
899
840
  > <ItemsResponse> get_items(opts)
@@ -1962,114 +1903,6 @@ end
1962
1903
  - **Accept**: application/json
1963
1904
 
1964
1905
 
1965
- ## update_item_inventories
1966
-
1967
- > update_item_inventories(item_inventory_update_request)
1968
-
1969
- Update item inventories for a distribution center
1970
-
1971
- Update item inventories for a distribution center
1972
-
1973
-
1974
- ### Examples
1975
-
1976
-
1977
- (No example for this operation).
1978
-
1979
-
1980
- #### Using the update_item_inventories_with_http_info variant
1981
-
1982
- This returns an Array which contains the response data (`nil` in this case), status code and headers.
1983
-
1984
- > <Array(nil, Integer, Hash)> update_item_inventories_with_http_info(item_inventory_update_request)
1985
-
1986
- ```ruby
1987
- begin
1988
- # Update item inventories for a distribution center
1989
- data, status_code, headers = api_instance.update_item_inventories_with_http_info(item_inventory_update_request)
1990
- p status_code # => 2xx
1991
- p headers # => { ... }
1992
- p data # => nil
1993
- rescue UltracartClient::ApiError => e
1994
- puts "Error when calling ItemApi->update_item_inventories_with_http_info: #{e}"
1995
- end
1996
- ```
1997
-
1998
- ### Parameters
1999
-
2000
- | Name | Type | Description | Notes |
2001
- | ---- | ---- | ----------- | ----- |
2002
- | **item_inventory_update_request** | [**ItemInventoryUpdateRequest**](ItemInventoryUpdateRequest.md) | Item inventory updates | |
2003
-
2004
- ### Return type
2005
-
2006
- nil (empty response body)
2007
-
2008
- ### Authorization
2009
-
2010
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
2011
-
2012
- ### HTTP request headers
2013
-
2014
- - **Content-Type**: application/json; charset=UTF-8
2015
- - **Accept**: application/json
2016
-
2017
-
2018
- ## update_item_shipping_distribution_center_by_code
2019
-
2020
- > update_item_shipping_distribution_center_by_code(merchant_item_oid, distribution_center_code, item_shipping_distribution_center)
2021
-
2022
- Update an item shipping distribution center
2023
-
2024
- Update an item shipping distribution center
2025
-
2026
-
2027
- ### Examples
2028
-
2029
-
2030
- (No example for this operation).
2031
-
2032
-
2033
- #### Using the update_item_shipping_distribution_center_by_code_with_http_info variant
2034
-
2035
- This returns an Array which contains the response data (`nil` in this case), status code and headers.
2036
-
2037
- > <Array(nil, Integer, Hash)> update_item_shipping_distribution_center_by_code_with_http_info(merchant_item_oid, distribution_center_code, item_shipping_distribution_center)
2038
-
2039
- ```ruby
2040
- begin
2041
- # Update an item shipping distribution center
2042
- data, status_code, headers = api_instance.update_item_shipping_distribution_center_by_code_with_http_info(merchant_item_oid, distribution_center_code, item_shipping_distribution_center)
2043
- p status_code # => 2xx
2044
- p headers # => { ... }
2045
- p data # => nil
2046
- rescue UltracartClient::ApiError => e
2047
- puts "Error when calling ItemApi->update_item_shipping_distribution_center_by_code_with_http_info: #{e}"
2048
- end
2049
- ```
2050
-
2051
- ### Parameters
2052
-
2053
- | Name | Type | Description | Notes |
2054
- | ---- | ---- | ----------- | ----- |
2055
- | **merchant_item_oid** | **Integer** | The item oid to update. | |
2056
- | **distribution_center_code** | **String** | | |
2057
- | **item_shipping_distribution_center** | [**ItemShippingDistributionCenter**](ItemShippingDistributionCenter.md) | Item shipping distribution center | |
2058
-
2059
- ### Return type
2060
-
2061
- nil (empty response body)
2062
-
2063
- ### Authorization
2064
-
2065
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
2066
-
2067
- ### HTTP request headers
2068
-
2069
- - **Content-Type**: application/json; charset=UTF-8
2070
- - **Accept**: application/json
2071
-
2072
-
2073
1906
  ## update_items
2074
1907
 
2075
1908
  > <ItemsResponse> update_items(items_request, opts)
data/docs/OrderApi.md CHANGED
@@ -20,6 +20,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
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 |
@@ -1249,6 +1250,61 @@ end
1249
1250
  - **Accept**: application/json
1250
1251
 
1251
1252
 
1253
+ ## get_order_upsell_cart
1254
+
1255
+ > <OrderResponse> get_order_upsell_cart(order_id, upsell_cart_request, opts)
1256
+
1257
+ Get Order Upsell Cart
1258
+
1259
+ 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
1260
+
1261
+
1262
+ ### Examples
1263
+
1264
+
1265
+ (No example for this operation).
1266
+
1267
+
1268
+ #### Using the get_order_upsell_cart_with_http_info variant
1269
+
1270
+ This returns an Array which contains the response data, status code and headers.
1271
+
1272
+ > <Array(<OrderResponse>, Integer, Hash)> get_order_upsell_cart_with_http_info(order_id, upsell_cart_request, opts)
1273
+
1274
+ ```ruby
1275
+ begin
1276
+ # Get Order Upsell Cart
1277
+ data, status_code, headers = api_instance.get_order_upsell_cart_with_http_info(order_id, upsell_cart_request, opts)
1278
+ p status_code # => 2xx
1279
+ p headers # => { ... }
1280
+ p data # => <OrderResponse>
1281
+ rescue UltracartClient::ApiError => e
1282
+ puts "Error when calling OrderApi->get_order_upsell_cart_with_http_info: #{e}"
1283
+ end
1284
+ ```
1285
+
1286
+ ### Parameters
1287
+
1288
+ | Name | Type | Description | Notes |
1289
+ | ---- | ---- | ----------- | ----- |
1290
+ | **order_id** | **String** | The order id to base things on. | |
1291
+ | **upsell_cart_request** | [**OrderUpsellCartRequest**](OrderUpsellCartRequest.md) | Request for the upsell cart | |
1292
+ | **_expand** | **String** | The object expansion to perform on the result. See documentation for examples | [optional] |
1293
+
1294
+ ### Return type
1295
+
1296
+ [**OrderResponse**](OrderResponse.md)
1297
+
1298
+ ### Authorization
1299
+
1300
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
1301
+
1302
+ ### HTTP request headers
1303
+
1304
+ - **Content-Type**: application/json; charset=UTF-8
1305
+ - **Accept**: application/json
1306
+
1307
+
1252
1308
  ## get_orders
1253
1309
 
1254
1310
  > <OrdersResponse> get_orders(opts)
@@ -0,0 +1,22 @@
1
+ # UltracartClient::OrderUpsellCartRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **checkout_url** | **String** | | [optional] |
8
+ | **coupon_codes** | **Array&lt;String&gt;** | | [optional] |
9
+ | **items** | [**Array&lt;CartItem&gt;**](CartItem.md) | | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'ultracart_api'
15
+
16
+ instance = UltracartClient::OrderUpsellCartRequest.new(
17
+ checkout_url: null,
18
+ coupon_codes: null,
19
+ items: null
20
+ )
21
+ ```
22
+
@@ -3530,6 +3530,7 @@ module UltracartClient
3530
3530
  # @param [Hash] opts the optional parameters
3531
3531
  # @option opts [String] :since ISO timestamp to filter entries since
3532
3532
  # @option opts [String] :agent_login Filter by agent login
3533
+ # @option opts [String] :action Action
3533
3534
  # @option opts [Integer] :limit Maximum number of entries to return (default 100)
3534
3535
  # @return [ConversationPbxCosAuditLogsResponse]
3535
3536
  def get_pbx_cos_audit_logs(opts = {})
@@ -3542,6 +3543,7 @@ module UltracartClient
3542
3543
  # @param [Hash] opts the optional parameters
3543
3544
  # @option opts [String] :since ISO timestamp to filter entries since
3544
3545
  # @option opts [String] :agent_login Filter by agent login
3546
+ # @option opts [String] :action Action
3545
3547
  # @option opts [Integer] :limit Maximum number of entries to return (default 100)
3546
3548
  # @return [Array<(ConversationPbxCosAuditLogsResponse, Integer, Hash)>] ConversationPbxCosAuditLogsResponse data, response status code and response headers
3547
3549
  def get_pbx_cos_audit_logs_with_http_info(opts = {})
@@ -3555,6 +3557,7 @@ module UltracartClient
3555
3557
  query_params = opts[:query_params] || {}
3556
3558
  query_params[:'since'] = opts[:'since'] if !opts[:'since'].nil?
3557
3559
  query_params[:'agent_login'] = opts[:'agent_login'] if !opts[:'agent_login'].nil?
3560
+ query_params[:'action'] = opts[:'action'] if !opts[:'action'].nil?
3558
3561
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
3559
3562
 
3560
3563
  # header parameters
@@ -632,82 +632,6 @@ module UltracartClient
632
632
  return data, status_code, headers
633
633
  end
634
634
 
635
- # Retrieve an item shipping distribution center
636
- # Retrieve an item shipping distribution center.
637
- # @param merchant_item_oid [Integer] The item oid to retrieve.
638
- # @param distribution_center_code [String]
639
- # @param [Hash] opts the optional parameters
640
- # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
641
- # @option opts [Boolean] :_placeholders Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.
642
- # @return [ItemShippingDistributionCenterResponse]
643
- def get_item_shipping_distribution_center_by_code(merchant_item_oid, distribution_center_code, opts = {})
644
- data, _status_code, _headers = get_item_shipping_distribution_center_by_code_with_http_info(merchant_item_oid, distribution_center_code, opts)
645
- data
646
- end
647
-
648
- # Retrieve an item shipping distribution center
649
- # Retrieve an item shipping distribution center.
650
- # @param merchant_item_oid [Integer] The item oid to retrieve.
651
- # @param distribution_center_code [String]
652
- # @param [Hash] opts the optional parameters
653
- # @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
654
- # @option opts [Boolean] :_placeholders Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.
655
- # @return [Array<(ItemShippingDistributionCenterResponse, Integer, Hash)>] ItemShippingDistributionCenterResponse data, response status code and response headers
656
- def get_item_shipping_distribution_center_by_code_with_http_info(merchant_item_oid, distribution_center_code, opts = {})
657
- if @api_client.config.debugging
658
- @api_client.config.logger.debug 'Calling API: ItemApi.get_item_shipping_distribution_center_by_code ...'
659
- end
660
- # verify the required parameter 'merchant_item_oid' is set
661
- if @api_client.config.client_side_validation && merchant_item_oid.nil?
662
- fail ArgumentError, "Missing the required parameter 'merchant_item_oid' when calling ItemApi.get_item_shipping_distribution_center_by_code"
663
- end
664
- # verify the required parameter 'distribution_center_code' is set
665
- if @api_client.config.client_side_validation && distribution_center_code.nil?
666
- fail ArgumentError, "Missing the required parameter 'distribution_center_code' when calling ItemApi.get_item_shipping_distribution_center_by_code"
667
- end
668
- # resource path
669
- local_var_path = '/item/items/{merchant_item_oid}/shipping/distribution_centers/by_code/{distribution_center_code}'.sub('{' + 'merchant_item_oid' + '}', CGI.escape(merchant_item_oid.to_s)).sub('{' + 'distribution_center_code' + '}', CGI.escape(distribution_center_code.to_s))
670
-
671
- # query parameters
672
- query_params = opts[:query_params] || {}
673
- query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
674
- query_params[:'_placeholders'] = opts[:'_placeholders'] if !opts[:'_placeholders'].nil?
675
-
676
- # header parameters
677
- header_params = opts[:header_params] || {}
678
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
679
- # HTTP header 'Accept' (if needed)
680
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
681
-
682
- # form parameters
683
- form_params = opts[:form_params] || {}
684
-
685
- # http body (model)
686
- post_body = opts[:debug_body]
687
-
688
- # return_type
689
- return_type = opts[:debug_return_type] || 'ItemShippingDistributionCenterResponse'
690
-
691
- # auth_names
692
- auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
693
-
694
- new_options = opts.merge(
695
- :operation => :"ItemApi.get_item_shipping_distribution_center_by_code",
696
- :header_params => header_params,
697
- :query_params => query_params,
698
- :form_params => form_params,
699
- :body => post_body,
700
- :auth_names => auth_names,
701
- :return_type => return_type
702
- )
703
-
704
- data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
705
- if @api_client.config.debugging
706
- @api_client.config.logger.debug "API called: ItemApi#get_item_shipping_distribution_center_by_code\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
707
- end
708
- return data, status_code, headers
709
- end
710
-
711
635
  # Retrieve items
712
636
  # 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.
713
637
  # @param [Hash] opts the optional parameters
@@ -1511,156 +1435,6 @@ module UltracartClient
1511
1435
  return data, status_code, headers
1512
1436
  end
1513
1437
 
1514
- # Update item inventories for a distribution center
1515
- # Update item inventories for a distribution center
1516
- # @param item_inventory_update_request [ItemInventoryUpdateRequest] Item inventory updates
1517
- # @param [Hash] opts the optional parameters
1518
- # @return [nil]
1519
- def update_item_inventories(item_inventory_update_request, opts = {})
1520
- update_item_inventories_with_http_info(item_inventory_update_request, opts)
1521
- nil
1522
- end
1523
-
1524
- # Update item inventories for a distribution center
1525
- # Update item inventories for a distribution center
1526
- # @param item_inventory_update_request [ItemInventoryUpdateRequest] Item inventory updates
1527
- # @param [Hash] opts the optional parameters
1528
- # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
1529
- def update_item_inventories_with_http_info(item_inventory_update_request, opts = {})
1530
- if @api_client.config.debugging
1531
- @api_client.config.logger.debug 'Calling API: ItemApi.update_item_inventories ...'
1532
- end
1533
- # verify the required parameter 'item_inventory_update_request' is set
1534
- if @api_client.config.client_side_validation && item_inventory_update_request.nil?
1535
- fail ArgumentError, "Missing the required parameter 'item_inventory_update_request' when calling ItemApi.update_item_inventories"
1536
- end
1537
- # resource path
1538
- local_var_path = '/item/items/update_item_inventories'
1539
-
1540
- # query parameters
1541
- query_params = opts[:query_params] || {}
1542
-
1543
- # header parameters
1544
- header_params = opts[:header_params] || {}
1545
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1546
- # HTTP header 'Accept' (if needed)
1547
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1548
- # HTTP header 'Content-Type'
1549
- content_type = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
1550
- if !content_type.nil?
1551
- header_params['Content-Type'] = content_type
1552
- end
1553
-
1554
- # form parameters
1555
- form_params = opts[:form_params] || {}
1556
-
1557
- # http body (model)
1558
- post_body = opts[:debug_body] || @api_client.object_to_http_body(item_inventory_update_request)
1559
-
1560
- # return_type
1561
- return_type = opts[:debug_return_type]
1562
-
1563
- # auth_names
1564
- auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
1565
-
1566
- new_options = opts.merge(
1567
- :operation => :"ItemApi.update_item_inventories",
1568
- :header_params => header_params,
1569
- :query_params => query_params,
1570
- :form_params => form_params,
1571
- :body => post_body,
1572
- :auth_names => auth_names,
1573
- :return_type => return_type
1574
- )
1575
-
1576
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
1577
- if @api_client.config.debugging
1578
- @api_client.config.logger.debug "API called: ItemApi#update_item_inventories\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1579
- end
1580
- return data, status_code, headers
1581
- end
1582
-
1583
- # Update an item shipping distribution center
1584
- # Update an item shipping distribution center
1585
- # @param merchant_item_oid [Integer] The item oid to update.
1586
- # @param distribution_center_code [String]
1587
- # @param item_shipping_distribution_center [ItemShippingDistributionCenter] Item shipping distribution center
1588
- # @param [Hash] opts the optional parameters
1589
- # @return [nil]
1590
- def update_item_shipping_distribution_center_by_code(merchant_item_oid, distribution_center_code, item_shipping_distribution_center, opts = {})
1591
- update_item_shipping_distribution_center_by_code_with_http_info(merchant_item_oid, distribution_center_code, item_shipping_distribution_center, opts)
1592
- nil
1593
- end
1594
-
1595
- # Update an item shipping distribution center
1596
- # Update an item shipping distribution center
1597
- # @param merchant_item_oid [Integer] The item oid to update.
1598
- # @param distribution_center_code [String]
1599
- # @param item_shipping_distribution_center [ItemShippingDistributionCenter] Item shipping distribution center
1600
- # @param [Hash] opts the optional parameters
1601
- # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
1602
- def update_item_shipping_distribution_center_by_code_with_http_info(merchant_item_oid, distribution_center_code, item_shipping_distribution_center, opts = {})
1603
- if @api_client.config.debugging
1604
- @api_client.config.logger.debug 'Calling API: ItemApi.update_item_shipping_distribution_center_by_code ...'
1605
- end
1606
- # verify the required parameter 'merchant_item_oid' is set
1607
- if @api_client.config.client_side_validation && merchant_item_oid.nil?
1608
- fail ArgumentError, "Missing the required parameter 'merchant_item_oid' when calling ItemApi.update_item_shipping_distribution_center_by_code"
1609
- end
1610
- # verify the required parameter 'distribution_center_code' is set
1611
- if @api_client.config.client_side_validation && distribution_center_code.nil?
1612
- fail ArgumentError, "Missing the required parameter 'distribution_center_code' when calling ItemApi.update_item_shipping_distribution_center_by_code"
1613
- end
1614
- # verify the required parameter 'item_shipping_distribution_center' is set
1615
- if @api_client.config.client_side_validation && item_shipping_distribution_center.nil?
1616
- fail ArgumentError, "Missing the required parameter 'item_shipping_distribution_center' when calling ItemApi.update_item_shipping_distribution_center_by_code"
1617
- end
1618
- # resource path
1619
- local_var_path = '/item/items/{merchant_item_oid}/shipping/distribution_centers/by_code/{distribution_center_code}'.sub('{' + 'merchant_item_oid' + '}', CGI.escape(merchant_item_oid.to_s)).sub('{' + 'distribution_center_code' + '}', CGI.escape(distribution_center_code.to_s))
1620
-
1621
- # query parameters
1622
- query_params = opts[:query_params] || {}
1623
-
1624
- # header parameters
1625
- header_params = opts[:header_params] || {}
1626
- header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
1627
- # HTTP header 'Accept' (if needed)
1628
- header_params['Accept'] = @api_client.select_header_accept(['application/json'])
1629
- # HTTP header 'Content-Type'
1630
- content_type = @api_client.select_header_content_type(['application/json; charset=UTF-8'])
1631
- if !content_type.nil?
1632
- header_params['Content-Type'] = content_type
1633
- end
1634
-
1635
- # form parameters
1636
- form_params = opts[:form_params] || {}
1637
-
1638
- # http body (model)
1639
- post_body = opts[:debug_body] || @api_client.object_to_http_body(item_shipping_distribution_center)
1640
-
1641
- # return_type
1642
- return_type = opts[:debug_return_type]
1643
-
1644
- # auth_names
1645
- auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']
1646
-
1647
- new_options = opts.merge(
1648
- :operation => :"ItemApi.update_item_shipping_distribution_center_by_code",
1649
- :header_params => header_params,
1650
- :query_params => query_params,
1651
- :form_params => form_params,
1652
- :body => post_body,
1653
- :auth_names => auth_names,
1654
- :return_type => return_type
1655
- )
1656
-
1657
- data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
1658
- if @api_client.config.debugging
1659
- @api_client.config.logger.debug "API called: ItemApi#update_item_shipping_distribution_center_by_code\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
1660
- end
1661
- return data, status_code, headers
1662
- end
1663
-
1664
1438
  # Update multiple items
1665
1439
  # Update multiple item on the UltraCart account.
1666
1440
  # @param items_request [ItemsRequest] Items to update (synchronous maximum 20 / asynchronous maximum 100)