ultracart_api 3.10.228 → 3.11.0
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 +6 -5
- data/docs/ItemApi.md +46 -46
- data/lib/ultracart_api/api/item_api.rb +49 -49
- data/lib/ultracart_api/version.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 725ed0b206f1917d80a865a5dc8dc8e6e790a95c5828bdf455db4bdc01404b6f
|
4
|
+
data.tar.gz: 0ef425c465404557555727415f0996daf3dc534662b08b92ae46b9631bb5aa5c
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 6c17bbe56bc91e12b742a6a17de7688e40d9e9d5ab7463c0a70de7eed4280a3c7389127f0b3de3e4bbac19dd466b79114d5f29537f64209673cae7eb87a56378
|
7
|
+
data.tar.gz: 80188f20da8972a8da1c8e2876b4ba1f936687fac228c69615cd303a66daf82e97a99da792732a1a419ec2dc08065083f2d77ba5646c0a68ac7cb0d8070abcbf
|
data/README.md
CHANGED
@@ -7,7 +7,7 @@ UltraCart REST API Version 2
|
|
7
7
|
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
|
8
8
|
|
9
9
|
- API version: 2.0.0
|
10
|
-
- Package version: 3.
|
10
|
+
- Package version: 3.11.0
|
11
11
|
- Build package: io.swagger.codegen.languages.RubyClientCodegen
|
12
12
|
For more information, please visit [http://www.ultracart.com](http://www.ultracart.com)
|
13
13
|
|
@@ -24,15 +24,15 @@ gem build ultracart_api.gemspec
|
|
24
24
|
Then either install the gem locally:
|
25
25
|
|
26
26
|
```shell
|
27
|
-
gem install ./ultracart_api-3.
|
27
|
+
gem install ./ultracart_api-3.11.0.gem
|
28
28
|
```
|
29
|
-
(for development, run `gem install --dev ./ultracart_api-3.
|
29
|
+
(for development, run `gem install --dev ./ultracart_api-3.11.0.gem` to install the development dependencies)
|
30
30
|
|
31
31
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
32
32
|
|
33
33
|
Finally add this to the Gemfile:
|
34
34
|
|
35
|
-
gem 'ultracart_api', '~> 3.
|
35
|
+
gem 'ultracart_api', '~> 3.11.0'
|
36
36
|
|
37
37
|
### Install from Git
|
38
38
|
|
@@ -297,6 +297,7 @@ Class | Method | HTTP request | Description
|
|
297
297
|
*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
|
298
298
|
*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
|
299
299
|
*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
|
300
|
+
*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.
|
300
301
|
*UltracartClient::ItemApi* | [**get_item**](docs/ItemApi.md#get_item) | **GET** /item/items/{merchant_item_oid} | Retrieve an item
|
301
302
|
*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
|
302
303
|
*UltracartClient::ItemApi* | [**get_items**](docs/ItemApi.md#get_items) | **GET** /item/items | Retrieve items
|
@@ -308,7 +309,6 @@ Class | Method | HTTP request | Description
|
|
308
309
|
*UltracartClient::ItemApi* | [**insert_item**](docs/ItemApi.md#insert_item) | **POST** /item/items | Create an item
|
309
310
|
*UltracartClient::ItemApi* | [**insert_review**](docs/ItemApi.md#insert_review) | **POST** /item/items/{merchant_item_oid}/reviews | Insert a review
|
310
311
|
*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
|
311
|
-
*UltracartClient::ItemApi* | [**rest_item_inventory_snapshot_response**](docs/ItemApi.md#rest_item_inventory_snapshot_response) | **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.
|
312
312
|
*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
|
313
313
|
*UltracartClient::ItemApi* | [**update_item**](docs/ItemApi.md#update_item) | **PUT** /item/items/{merchant_item_oid} | Update an item
|
314
314
|
*UltracartClient::ItemApi* | [**update_items**](docs/ItemApi.md#update_items) | **PUT** /item/items/batch | Update multiple items
|
@@ -1517,6 +1517,7 @@ Not every change is committed to every SDK.
|
|
1517
1517
|
|
1518
1518
|
| Version | Date | Comments |
|
1519
1519
|
| --: | :-: | --- |
|
1520
|
+
| 3.11.0 | 02/21/2025 | ItemApi.getInventorySnapshot had bad nickname causing bad sdk method name |
|
1520
1521
|
| 3.10.228 | 02/20/2025 | automation fix |
|
1521
1522
|
| 3.10.227 | 02/20/2025 | no change, revving sdk to troubleshoot java deployment automation |
|
1522
1523
|
| 3.10.226 | 02/20/2025 | no change, revving sdk to troubleshoot java deployment automation |
|
data/docs/ItemApi.md
CHANGED
@@ -10,6 +10,7 @@ Method | HTTP request | Description
|
|
10
10
|
[**get_digital_item**](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
|
11
11
|
[**get_digital_items**](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
|
12
12
|
[**get_digital_items_by_external_id**](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
|
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.
|
13
14
|
[**get_item**](ItemApi.md#get_item) | **GET** /item/items/{merchant_item_oid} | Retrieve an item
|
14
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
|
15
16
|
[**get_items**](ItemApi.md#get_items) | **GET** /item/items | Retrieve items
|
@@ -21,7 +22,6 @@ Method | HTTP request | Description
|
|
21
22
|
[**insert_item**](ItemApi.md#insert_item) | **POST** /item/items | Create an item
|
22
23
|
[**insert_review**](ItemApi.md#insert_review) | **POST** /item/items/{merchant_item_oid}/reviews | Insert a review
|
23
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
|
24
|
-
[**rest_item_inventory_snapshot_response**](ItemApi.md#rest_item_inventory_snapshot_response) | **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.
|
25
25
|
[**update_digital_item**](ItemApi.md#update_digital_item) | **PUT** /item/digital_library/{digital_item_oid} | Updates a file within the digital library
|
26
26
|
[**update_item**](ItemApi.md#update_item) | **PUT** /item/items/{merchant_item_oid} | Update an item
|
27
27
|
[**update_items**](ItemApi.md#update_items) | **PUT** /item/items/batch | Update multiple items
|
@@ -340,6 +340,51 @@ Name | Type | Description | Notes
|
|
340
340
|
|
341
341
|
|
342
342
|
|
343
|
+
# **get_inventory_snapshot**
|
344
|
+
> ItemInventorySnapshotResponse get_inventory_snapshot
|
345
|
+
|
346
|
+
Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response.
|
347
|
+
|
348
|
+
Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response.
|
349
|
+
|
350
|
+
### Example
|
351
|
+
```ruby
|
352
|
+
# load the gem
|
353
|
+
require 'ultracart_api'
|
354
|
+
|
355
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
356
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
357
|
+
api_instance = UltracartClient::ItemApi.new_using_api_key(simple_key, false, false)
|
358
|
+
|
359
|
+
|
360
|
+
|
361
|
+
begin
|
362
|
+
#Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response.
|
363
|
+
result = api_instance.get_inventory_snapshot
|
364
|
+
p result
|
365
|
+
rescue UltracartClient::ApiError => e
|
366
|
+
puts "Exception when calling ItemApi->get_inventory_snapshot: #{e}"
|
367
|
+
end
|
368
|
+
```
|
369
|
+
|
370
|
+
### Parameters
|
371
|
+
This endpoint does not need any parameter.
|
372
|
+
|
373
|
+
### Return type
|
374
|
+
|
375
|
+
[**ItemInventorySnapshotResponse**](ItemInventorySnapshotResponse.md)
|
376
|
+
|
377
|
+
### Authorization
|
378
|
+
|
379
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
380
|
+
|
381
|
+
### HTTP request headers
|
382
|
+
|
383
|
+
- **Content-Type**: application/json
|
384
|
+
- **Accept**: application/json
|
385
|
+
|
386
|
+
|
387
|
+
|
343
388
|
# **get_item**
|
344
389
|
> ItemResponse get_item(merchant_item_oid, opts)
|
345
390
|
|
@@ -943,51 +988,6 @@ nil (empty response body)
|
|
943
988
|
|
944
989
|
|
945
990
|
|
946
|
-
# **rest_item_inventory_snapshot_response**
|
947
|
-
> ItemInventorySnapshotResponse rest_item_inventory_snapshot_response
|
948
|
-
|
949
|
-
Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response.
|
950
|
-
|
951
|
-
Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response.
|
952
|
-
|
953
|
-
### Example
|
954
|
-
```ruby
|
955
|
-
# load the gem
|
956
|
-
require 'ultracart_api'
|
957
|
-
|
958
|
-
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
959
|
-
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
960
|
-
api_instance = UltracartClient::ItemApi.new_using_api_key(simple_key, false, false)
|
961
|
-
|
962
|
-
|
963
|
-
|
964
|
-
begin
|
965
|
-
#Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response.
|
966
|
-
result = api_instance.rest_item_inventory_snapshot_response
|
967
|
-
p result
|
968
|
-
rescue UltracartClient::ApiError => e
|
969
|
-
puts "Exception when calling ItemApi->rest_item_inventory_snapshot_response: #{e}"
|
970
|
-
end
|
971
|
-
```
|
972
|
-
|
973
|
-
### Parameters
|
974
|
-
This endpoint does not need any parameter.
|
975
|
-
|
976
|
-
### Return type
|
977
|
-
|
978
|
-
[**ItemInventorySnapshotResponse**](ItemInventorySnapshotResponse.md)
|
979
|
-
|
980
|
-
### Authorization
|
981
|
-
|
982
|
-
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
983
|
-
|
984
|
-
### HTTP request headers
|
985
|
-
|
986
|
-
- **Content-Type**: application/json
|
987
|
-
- **Accept**: application/json
|
988
|
-
|
989
|
-
|
990
|
-
|
991
991
|
# **update_digital_item**
|
992
992
|
> ItemDigitalItemResponse update_digital_item(digital_item_oid, digital_item)
|
993
993
|
|
@@ -377,6 +377,55 @@ module UltracartClient
|
|
377
377
|
end
|
378
378
|
return data, status_code, headers
|
379
379
|
end
|
380
|
+
# Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response.
|
381
|
+
# Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response.
|
382
|
+
# @param [Hash] opts the optional parameters
|
383
|
+
# @return [ItemInventorySnapshotResponse]
|
384
|
+
def get_inventory_snapshot(opts = {})
|
385
|
+
data, _status_code, _headers = get_inventory_snapshot_with_http_info(opts)
|
386
|
+
data
|
387
|
+
end
|
388
|
+
|
389
|
+
# Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response.
|
390
|
+
# Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response.
|
391
|
+
# @param [Hash] opts the optional parameters
|
392
|
+
# @return [Array<(ItemInventorySnapshotResponse, Fixnum, Hash)>] ItemInventorySnapshotResponse data, response status code and response headers
|
393
|
+
def get_inventory_snapshot_with_http_info(opts = {})
|
394
|
+
if @api_client.config.debugging
|
395
|
+
@api_client.config.logger.debug 'Calling API: ItemApi.get_inventory_snapshot ...'
|
396
|
+
end
|
397
|
+
# resource path
|
398
|
+
local_var_path = '/item/items/inventory_snapshot'
|
399
|
+
|
400
|
+
# query parameters
|
401
|
+
query_params = {}
|
402
|
+
|
403
|
+
# header parameters
|
404
|
+
header_params = {}
|
405
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
406
|
+
# HTTP header 'Accept' (if needed)
|
407
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
408
|
+
# HTTP header 'Content-Type'
|
409
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
410
|
+
|
411
|
+
# form parameters
|
412
|
+
form_params = {}
|
413
|
+
|
414
|
+
# http body (model)
|
415
|
+
post_body = nil
|
416
|
+
auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
417
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
418
|
+
:header_params => header_params,
|
419
|
+
:query_params => query_params,
|
420
|
+
:form_params => form_params,
|
421
|
+
:body => post_body,
|
422
|
+
:auth_names => auth_names,
|
423
|
+
:return_type => 'ItemInventorySnapshotResponse')
|
424
|
+
if @api_client.config.debugging
|
425
|
+
@api_client.config.logger.debug "API called: ItemApi#get_inventory_snapshot\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
426
|
+
end
|
427
|
+
return data, status_code, headers
|
428
|
+
end
|
380
429
|
# Retrieve an item
|
381
430
|
# Retrieves a single item using the specified item oid.
|
382
431
|
# @param merchant_item_oid The item oid to retrieve.
|
@@ -1044,55 +1093,6 @@ module UltracartClient
|
|
1044
1093
|
end
|
1045
1094
|
return data, status_code, headers
|
1046
1095
|
end
|
1047
|
-
# Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response.
|
1048
|
-
# Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response.
|
1049
|
-
# @param [Hash] opts the optional parameters
|
1050
|
-
# @return [ItemInventorySnapshotResponse]
|
1051
|
-
def rest_item_inventory_snapshot_response(opts = {})
|
1052
|
-
data, _status_code, _headers = rest_item_inventory_snapshot_response_with_http_info(opts)
|
1053
|
-
data
|
1054
|
-
end
|
1055
|
-
|
1056
|
-
# Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response.
|
1057
|
-
# Retrieve a list of item inventories. This method may be called once every 15 minutes. More than that will result in a 429 response.
|
1058
|
-
# @param [Hash] opts the optional parameters
|
1059
|
-
# @return [Array<(ItemInventorySnapshotResponse, Fixnum, Hash)>] ItemInventorySnapshotResponse data, response status code and response headers
|
1060
|
-
def rest_item_inventory_snapshot_response_with_http_info(opts = {})
|
1061
|
-
if @api_client.config.debugging
|
1062
|
-
@api_client.config.logger.debug 'Calling API: ItemApi.rest_item_inventory_snapshot_response ...'
|
1063
|
-
end
|
1064
|
-
# resource path
|
1065
|
-
local_var_path = '/item/items/inventory_snapshot'
|
1066
|
-
|
1067
|
-
# query parameters
|
1068
|
-
query_params = {}
|
1069
|
-
|
1070
|
-
# header parameters
|
1071
|
-
header_params = {}
|
1072
|
-
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
1073
|
-
# HTTP header 'Accept' (if needed)
|
1074
|
-
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
1075
|
-
# HTTP header 'Content-Type'
|
1076
|
-
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
1077
|
-
|
1078
|
-
# form parameters
|
1079
|
-
form_params = {}
|
1080
|
-
|
1081
|
-
# http body (model)
|
1082
|
-
post_body = nil
|
1083
|
-
auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
1084
|
-
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
1085
|
-
:header_params => header_params,
|
1086
|
-
:query_params => query_params,
|
1087
|
-
:form_params => form_params,
|
1088
|
-
:body => post_body,
|
1089
|
-
:auth_names => auth_names,
|
1090
|
-
:return_type => 'ItemInventorySnapshotResponse')
|
1091
|
-
if @api_client.config.debugging
|
1092
|
-
@api_client.config.logger.debug "API called: ItemApi#rest_item_inventory_snapshot_response\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
1093
|
-
end
|
1094
|
-
return data, status_code, headers
|
1095
|
-
end
|
1096
1096
|
# Updates a file within the digital library
|
1097
1097
|
# Updates a file within the digital library. This does not update an item, but updates a digital file available and selectable as part (or all) of an item.
|
1098
1098
|
# @param digital_item_oid The digital item oid to update.
|
metadata
CHANGED
@@ -1,14 +1,14 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: ultracart_api
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 3.
|
4
|
+
version: 3.11.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- UltraCart
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2025-02-
|
11
|
+
date: 2025-02-21 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
14
|
name: typhoeus
|