ultracart_api 4.0.64.rc → 4.0.65.rc

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: e1ed1c97e3f263b06950618cb32dfc1ee9a59a5bd94a42b54c29b474be60adef
4
- data.tar.gz: 84cc1f79eaaa7e85018ef417c020d639a0a7d4bc95668c6bd83a46e004d66a8c
3
+ metadata.gz: f94d77f310c53ac9af806f040781f34087f78b1a16540c1f2c9782b61c37fc89
4
+ data.tar.gz: 0132a21aeaaf1460ce49512cb4349c434035fdb49346b074e134e97cc664d62b
5
5
  SHA512:
6
- metadata.gz: 64acc6802ec8ded7e8c438358339e97119ac57d46879a43b7a0cb49f544e5d4661491c70a33824134c3068459ad32d5f696f2e82cc0410a2d91e5a153ae677f8
7
- data.tar.gz: 0656ec27b524e46538da54766cb20a6fa26475c3e0c61898b95829102edb4b9f1040a9026acfae3e98081c2ef1efc4080c2f3536a2215dda1d2cfca5a6de2a9c
6
+ metadata.gz: 6472c8c04811613a4e5cc130ffdf910baae4718fc790f2136153714afc2076cc043a65a754096fac91f91098ab161a92773933080250e6971cef17da50e6b9a8
7
+ data.tar.gz: 4d962e9e90745e87e4f710c32b9d5f7a83588a5e35073270810e3580f030c7dd79fb39fa431094974ac0f9ef790e4f210f9f5780609d7ce996f365d28a978b1b
data/README.md CHANGED
@@ -7,7 +7,7 @@ UltraCart REST API Version 2
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.0.64.rc
10
+ - Package version: 4.0.65.rc
11
11
  - Build package: org.openapitools.codegen.languages.RubyClientCodegen
12
12
  For more information, please visit [http://www.ultracart.com](http://www.ultracart.com)
13
13
 
@@ -24,16 +24,16 @@ gem build ultracart_api.gemspec
24
24
  Then either install the gem locally:
25
25
 
26
26
  ```shell
27
- gem install ./ultracart_api-4.0.64.rc.gem
27
+ gem install ./ultracart_api-4.0.65.rc.gem
28
28
  ```
29
29
 
30
- (for development, run `gem install --dev ./ultracart_api-4.0.64.rc.gem` to install the development dependencies)
30
+ (for development, run `gem install --dev ./ultracart_api-4.0.65.rc.gem` to install the development dependencies)
31
31
 
32
32
  or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
33
33
 
34
34
  Finally add this to the Gemfile:
35
35
 
36
- gem 'ultracart_api', '~> 4.0.64.rc'
36
+ gem 'ultracart_api', '~> 4.0.65.rc'
37
37
 
38
38
  ### Install from Git
39
39
 
@@ -199,12 +199,17 @@ Class | Method | HTTP request | Description
199
199
  *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
200
200
  *UltracartClient::IntegrationLogApi* | [**get_integration_log_summaries_query**](docs/IntegrationLogApi.md#get_integration_log_summaries_query) | **POST** /integration_log/summary/query | Retrieve integration log summaries
201
201
  *UltracartClient::IntegrationLogApi* | [**get_integration_logs_query**](docs/IntegrationLogApi.md#get_integration_logs_query) | **POST** /integration_log/query | Retrieve integration logs
202
+ *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
202
203
  *UltracartClient::ItemApi* | [**delete_item**](docs/ItemApi.md#delete_item) | **DELETE** /item/items/{merchant_item_oid} | Delete an item
204
+ *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
205
+ *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
203
206
  *UltracartClient::ItemApi* | [**get_item**](docs/ItemApi.md#get_item) | **GET** /item/items/{merchant_item_oid} | Retrieve an item
204
207
  *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
205
208
  *UltracartClient::ItemApi* | [**get_items**](docs/ItemApi.md#get_items) | **GET** /item/items | Retrieve items
206
209
  *UltracartClient::ItemApi* | [**get_pricing_tiers**](docs/ItemApi.md#get_pricing_tiers) | **GET** /item/pricing_tiers | Retrieve pricing tiers
210
+ *UltracartClient::ItemApi* | [**insert_digital_item**](docs/ItemApi.md#insert_digital_item) | **POST** /item/digital_library | Create a file within the digital library
207
211
  *UltracartClient::ItemApi* | [**insert_item**](docs/ItemApi.md#insert_item) | **POST** /item/items | Create an item
212
+ *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
208
213
  *UltracartClient::ItemApi* | [**update_item**](docs/ItemApi.md#update_item) | **PUT** /item/items/{merchant_item_oid} | Update an item
209
214
  *UltracartClient::ItemApi* | [**update_items**](docs/ItemApi.md#update_items) | **PUT** /item/items/batch | Update multiple items
210
215
  *UltracartClient::ItemApi* | [**upload_temporary_multimedia**](docs/ItemApi.md#upload_temporary_multimedia) | **POST** /item/temp_multimedia | Upload an image to the temporary multimedia.
@@ -862,6 +867,9 @@ Class | Method | HTTP request | Description
862
867
  - [UltracartClient::ItemContentMultimediaThumbnail](docs/ItemContentMultimediaThumbnail.md)
863
868
  - [UltracartClient::ItemDigitalDelivery](docs/ItemDigitalDelivery.md)
864
869
  - [UltracartClient::ItemDigitalItem](docs/ItemDigitalItem.md)
870
+ - [UltracartClient::ItemDigitalItemPdfMeta](docs/ItemDigitalItemPdfMeta.md)
871
+ - [UltracartClient::ItemDigitalItemResponse](docs/ItemDigitalItemResponse.md)
872
+ - [UltracartClient::ItemDigitalItemsResponse](docs/ItemDigitalItemsResponse.md)
865
873
  - [UltracartClient::ItemEbay](docs/ItemEbay.md)
866
874
  - [UltracartClient::ItemEbayCategorySpecific](docs/ItemEbayCategorySpecific.md)
867
875
  - [UltracartClient::ItemEbayMarketListing](docs/ItemEbayMarketListing.md)
@@ -1197,6 +1205,7 @@ Not every change is committed to every SDK.
1197
1205
 
1198
1206
  | Version | Date | Comments |
1199
1207
  | --: | :-: | --- |
1208
+ | 4.0.65-RC | 09/22/2022 | testing digital file mgmt calls |
1200
1209
  | 4.0.64-RC | 09/19/2022 | conversations pagination |
1201
1210
  | 4.0.63-RC | 09/13/2022 | storefront comms - postcard tracking |
1202
1211
  | 4.0.62-RC | 09/12/2022 | storefront comm - send back reviews.io configured flag on getEmailSettings |
data/docs/ItemApi.md CHANGED
@@ -4,17 +4,92 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
4
4
 
5
5
  | Method | HTTP request | Description |
6
6
  | ------ | ------------ | ----------- |
7
+ | [**delete_digital_item**](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 |
7
8
  | [**delete_item**](ItemApi.md#delete_item) | **DELETE** /item/items/{merchant_item_oid} | Delete an item |
9
+ | [**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 |
10
+ | [**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 |
8
11
  | [**get_item**](ItemApi.md#get_item) | **GET** /item/items/{merchant_item_oid} | Retrieve an item |
9
12
  | [**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 |
10
13
  | [**get_items**](ItemApi.md#get_items) | **GET** /item/items | Retrieve items |
11
14
  | [**get_pricing_tiers**](ItemApi.md#get_pricing_tiers) | **GET** /item/pricing_tiers | Retrieve pricing tiers |
15
+ | [**insert_digital_item**](ItemApi.md#insert_digital_item) | **POST** /item/digital_library | Create a file within the digital library |
12
16
  | [**insert_item**](ItemApi.md#insert_item) | **POST** /item/items | Create an item |
17
+ | [**update_digital_item**](ItemApi.md#update_digital_item) | **PUT** /item/digital_library/{digital_item_oid} | Updates a file within the digital library |
13
18
  | [**update_item**](ItemApi.md#update_item) | **PUT** /item/items/{merchant_item_oid} | Update an item |
14
19
  | [**update_items**](ItemApi.md#update_items) | **PUT** /item/items/batch | Update multiple items |
15
20
  | [**upload_temporary_multimedia**](ItemApi.md#upload_temporary_multimedia) | **POST** /item/temp_multimedia | Upload an image to the temporary multimedia. |
16
21
 
17
22
 
23
+ ## delete_digital_item
24
+
25
+ > delete_digital_item(digital_item_oid)
26
+
27
+ Delete a digital item, which is a file within the digital library, not an actual merchant item
28
+
29
+ Delete a digital item on the UltraCart account.
30
+
31
+ ### Examples
32
+
33
+ ```ruby
34
+ require 'time'
35
+ require 'ultracart_api'
36
+ require 'json'
37
+ require 'yaml'
38
+ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
39
+
40
+ # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
41
+ # As such, this might not be the best way to use this object.
42
+ # Please see https://github.com/UltraCart/sdk_samples for working examples.
43
+
44
+ api = UltracartClient::ItemApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
45
+ digital_item_oid = 56 # Integer | The digital item oid to delete.
46
+
47
+ begin
48
+ # Delete a digital item, which is a file within the digital library, not an actual merchant item
49
+ api_instance.delete_digital_item(digital_item_oid)
50
+ rescue UltracartClient::ApiError => e
51
+ puts "Error when calling ItemApi->delete_digital_item: #{e}"
52
+ end
53
+ ```
54
+
55
+ #### Using the delete_digital_item_with_http_info variant
56
+
57
+ This returns an Array which contains the response data (`nil` in this case), status code and headers.
58
+
59
+ > <Array(nil, Integer, Hash)> delete_digital_item_with_http_info(digital_item_oid)
60
+
61
+ ```ruby
62
+ begin
63
+ # Delete a digital item, which is a file within the digital library, not an actual merchant item
64
+ data, status_code, headers = api_instance.delete_digital_item_with_http_info(digital_item_oid)
65
+ p status_code # => 2xx
66
+ p headers # => { ... }
67
+ p data # => nil
68
+ rescue UltracartClient::ApiError => e
69
+ puts "Error when calling ItemApi->delete_digital_item_with_http_info: #{e}"
70
+ end
71
+ ```
72
+
73
+ ### Parameters
74
+
75
+ | Name | Type | Description | Notes |
76
+ | ---- | ---- | ----------- | ----- |
77
+ | **digital_item_oid** | **Integer** | The digital item oid to delete. | |
78
+
79
+ ### Return type
80
+
81
+ nil (empty response body)
82
+
83
+ ### Authorization
84
+
85
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
86
+
87
+ ### HTTP request headers
88
+
89
+ - **Content-Type**: Not defined
90
+ - **Accept**: application/json
91
+
92
+
18
93
  ## delete_item
19
94
 
20
95
  > delete_item(merchant_item_oid)
@@ -85,6 +160,174 @@ nil (empty response body)
85
160
  - **Accept**: application/json
86
161
 
87
162
 
163
+ ## get_digital_item
164
+
165
+ > <ItemDigitalItemResponse> get_digital_item(digital_item_oid, opts)
166
+
167
+ Retrieve a digital item from the digital library, which are digital files that may be attached to normal items
168
+
169
+ Retrieves a digital item (file information) from the account. Be aware that these are not normal items that can be added to a shopping cart. Rather, they are digital files that may be associated with normal items.
170
+
171
+ ### Examples
172
+
173
+ ```ruby
174
+ require 'time'
175
+ require 'ultracart_api'
176
+ require 'json'
177
+ require 'yaml'
178
+ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
179
+
180
+ # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
181
+ # As such, this might not be the best way to use this object.
182
+ # Please see https://github.com/UltraCart/sdk_samples for working examples.
183
+
184
+ api = UltracartClient::ItemApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
185
+ digital_item_oid = 56 # Integer | The digital item oid to retrieve.
186
+ opts = {
187
+ _limit: 56, # Integer | The maximum number of records to return on this one API call. (Default 100, Max 2000)
188
+ _offset: 56, # Integer | Pagination of the record set. Offset is a zero based index.
189
+ _since: '_since_example', # String | Fetch items that have been created/modified since this date/time.
190
+ _sort: '_sort_example', # String | The sort order of the items. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
191
+ _expand: '_expand_example', # String | The object expansion to perform on the result. See documentation for examples
192
+ _placeholders: true # Boolean | Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.
193
+ }
194
+
195
+ begin
196
+ # Retrieve a digital item from the digital library, which are digital files that may be attached to normal items
197
+ result = api_instance.get_digital_item(digital_item_oid, opts)
198
+ p result
199
+ rescue UltracartClient::ApiError => e
200
+ puts "Error when calling ItemApi->get_digital_item: #{e}"
201
+ end
202
+ ```
203
+
204
+ #### Using the get_digital_item_with_http_info variant
205
+
206
+ This returns an Array which contains the response data, status code and headers.
207
+
208
+ > <Array(<ItemDigitalItemResponse>, Integer, Hash)> get_digital_item_with_http_info(digital_item_oid, opts)
209
+
210
+ ```ruby
211
+ begin
212
+ # Retrieve a digital item from the digital library, which are digital files that may be attached to normal items
213
+ data, status_code, headers = api_instance.get_digital_item_with_http_info(digital_item_oid, opts)
214
+ p status_code # => 2xx
215
+ p headers # => { ... }
216
+ p data # => <ItemDigitalItemResponse>
217
+ rescue UltracartClient::ApiError => e
218
+ puts "Error when calling ItemApi->get_digital_item_with_http_info: #{e}"
219
+ end
220
+ ```
221
+
222
+ ### Parameters
223
+
224
+ | Name | Type | Description | Notes |
225
+ | ---- | ---- | ----------- | ----- |
226
+ | **digital_item_oid** | **Integer** | The digital item oid to retrieve. | |
227
+ | **_limit** | **Integer** | The maximum number of records to return on this one API call. (Default 100, Max 2000) | [optional][default to 100] |
228
+ | **_offset** | **Integer** | Pagination of the record set. Offset is a zero based index. | [optional][default to 0] |
229
+ | **_since** | **String** | Fetch items that have been created/modified since this date/time. | [optional] |
230
+ | **_sort** | **String** | The sort order of the items. See Sorting documentation for examples of using multiple values and sorting by ascending and descending. | [optional] |
231
+ | **_expand** | **String** | The object expansion to perform on the result. See documentation for examples | [optional] |
232
+ | **_placeholders** | **Boolean** | Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API. | [optional] |
233
+
234
+ ### Return type
235
+
236
+ [**ItemDigitalItemResponse**](ItemDigitalItemResponse.md)
237
+
238
+ ### Authorization
239
+
240
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
241
+
242
+ ### HTTP request headers
243
+
244
+ - **Content-Type**: Not defined
245
+ - **Accept**: application/json
246
+
247
+
248
+ ## get_digital_items
249
+
250
+ > <ItemDigitalItemsResponse> get_digital_items(opts)
251
+
252
+ Retrieve digital items from the digital library which are digital files that may be attached to normal items
253
+
254
+ Retrieves a group of digital items (file information) from the account. If no parameters are specified, all digital items will be returned. Be aware that these are not normal items that can be added to a shopping cart. Rather, they are digital files that may be associated with normal items. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
255
+
256
+ ### Examples
257
+
258
+ ```ruby
259
+ require 'time'
260
+ require 'ultracart_api'
261
+ require 'json'
262
+ require 'yaml'
263
+ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
264
+
265
+ # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
266
+ # As such, this might not be the best way to use this object.
267
+ # Please see https://github.com/UltraCart/sdk_samples for working examples.
268
+
269
+ api = UltracartClient::ItemApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
270
+ opts = {
271
+ _limit: 56, # Integer | The maximum number of records to return on this one API call. (Default 100, Max 2000)
272
+ _offset: 56, # Integer | Pagination of the record set. Offset is a zero based index.
273
+ _since: '_since_example', # String | Fetch items that have been created/modified since this date/time.
274
+ _sort: '_sort_example', # String | The sort order of the items. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
275
+ _expand: '_expand_example', # String | The object expansion to perform on the result. See documentation for examples
276
+ _placeholders: true # Boolean | Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.
277
+ }
278
+
279
+ begin
280
+ # Retrieve digital items from the digital library which are digital files that may be attached to normal items
281
+ result = api_instance.get_digital_items(opts)
282
+ p result
283
+ rescue UltracartClient::ApiError => e
284
+ puts "Error when calling ItemApi->get_digital_items: #{e}"
285
+ end
286
+ ```
287
+
288
+ #### Using the get_digital_items_with_http_info variant
289
+
290
+ This returns an Array which contains the response data, status code and headers.
291
+
292
+ > <Array(<ItemDigitalItemsResponse>, Integer, Hash)> get_digital_items_with_http_info(opts)
293
+
294
+ ```ruby
295
+ begin
296
+ # Retrieve digital items from the digital library which are digital files that may be attached to normal items
297
+ data, status_code, headers = api_instance.get_digital_items_with_http_info(opts)
298
+ p status_code # => 2xx
299
+ p headers # => { ... }
300
+ p data # => <ItemDigitalItemsResponse>
301
+ rescue UltracartClient::ApiError => e
302
+ puts "Error when calling ItemApi->get_digital_items_with_http_info: #{e}"
303
+ end
304
+ ```
305
+
306
+ ### Parameters
307
+
308
+ | Name | Type | Description | Notes |
309
+ | ---- | ---- | ----------- | ----- |
310
+ | **_limit** | **Integer** | The maximum number of records to return on this one API call. (Default 100, Max 2000) | [optional][default to 100] |
311
+ | **_offset** | **Integer** | Pagination of the record set. Offset is a zero based index. | [optional][default to 0] |
312
+ | **_since** | **String** | Fetch items that have been created/modified since this date/time. | [optional] |
313
+ | **_sort** | **String** | The sort order of the items. See Sorting documentation for examples of using multiple values and sorting by ascending and descending. | [optional] |
314
+ | **_expand** | **String** | The object expansion to perform on the result. See documentation for examples | [optional] |
315
+ | **_placeholders** | **Boolean** | Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API. | [optional] |
316
+
317
+ ### Return type
318
+
319
+ [**ItemDigitalItemsResponse**](ItemDigitalItemsResponse.md)
320
+
321
+ ### Authorization
322
+
323
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
324
+
325
+ ### HTTP request headers
326
+
327
+ - **Content-Type**: Not defined
328
+ - **Accept**: application/json
329
+
330
+
88
331
  ## get_item
89
332
 
90
333
  > <ItemResponse> get_item(merchant_item_oid, opts)
@@ -399,6 +642,77 @@ end
399
642
  - **Accept**: application/json
400
643
 
401
644
 
645
+ ## insert_digital_item
646
+
647
+ > <ItemDigitalItemResponse> insert_digital_item(digital_item)
648
+
649
+ Create a file within the digital library
650
+
651
+ Create a file within the digital library. This does not create an item, but makes this digital file available and selectable as part (or all) of an item.
652
+
653
+ ### Examples
654
+
655
+ ```ruby
656
+ require 'time'
657
+ require 'ultracart_api'
658
+ require 'json'
659
+ require 'yaml'
660
+ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
661
+
662
+ # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
663
+ # As such, this might not be the best way to use this object.
664
+ # Please see https://github.com/UltraCart/sdk_samples for working examples.
665
+
666
+ api = UltracartClient::ItemApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
667
+ digital_item = UltracartClient::ItemDigitalItem.new # ItemDigitalItem | Digital item to create
668
+
669
+ begin
670
+ # Create a file within the digital library
671
+ result = api_instance.insert_digital_item(digital_item)
672
+ p result
673
+ rescue UltracartClient::ApiError => e
674
+ puts "Error when calling ItemApi->insert_digital_item: #{e}"
675
+ end
676
+ ```
677
+
678
+ #### Using the insert_digital_item_with_http_info variant
679
+
680
+ This returns an Array which contains the response data, status code and headers.
681
+
682
+ > <Array(<ItemDigitalItemResponse>, Integer, Hash)> insert_digital_item_with_http_info(digital_item)
683
+
684
+ ```ruby
685
+ begin
686
+ # Create a file within the digital library
687
+ data, status_code, headers = api_instance.insert_digital_item_with_http_info(digital_item)
688
+ p status_code # => 2xx
689
+ p headers # => { ... }
690
+ p data # => <ItemDigitalItemResponse>
691
+ rescue UltracartClient::ApiError => e
692
+ puts "Error when calling ItemApi->insert_digital_item_with_http_info: #{e}"
693
+ end
694
+ ```
695
+
696
+ ### Parameters
697
+
698
+ | Name | Type | Description | Notes |
699
+ | ---- | ---- | ----------- | ----- |
700
+ | **digital_item** | [**ItemDigitalItem**](ItemDigitalItem.md) | Digital item to create | |
701
+
702
+ ### Return type
703
+
704
+ [**ItemDigitalItemResponse**](ItemDigitalItemResponse.md)
705
+
706
+ ### Authorization
707
+
708
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
709
+
710
+ ### HTTP request headers
711
+
712
+ - **Content-Type**: application/json; charset=UTF-8
713
+ - **Accept**: application/json
714
+
715
+
402
716
  ## insert_item
403
717
 
404
718
  > <ItemResponse> insert_item(item, opts)
@@ -476,6 +790,79 @@ end
476
790
  - **Accept**: application/json
477
791
 
478
792
 
793
+ ## update_digital_item
794
+
795
+ > <ItemDigitalItemResponse> update_digital_item(digital_item_oid, digital_item)
796
+
797
+ Updates a file within the digital library
798
+
799
+ 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.
800
+
801
+ ### Examples
802
+
803
+ ```ruby
804
+ require 'time'
805
+ require 'ultracart_api'
806
+ require 'json'
807
+ require 'yaml'
808
+ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
809
+
810
+ # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
811
+ # As such, this might not be the best way to use this object.
812
+ # Please see https://github.com/UltraCart/sdk_samples for working examples.
813
+
814
+ api = UltracartClient::ItemApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
815
+ digital_item_oid = 56 # Integer | The digital item oid to update.
816
+ digital_item = UltracartClient::ItemDigitalItem.new # ItemDigitalItem | Digital item to update
817
+
818
+ begin
819
+ # Updates a file within the digital library
820
+ result = api_instance.update_digital_item(digital_item_oid, digital_item)
821
+ p result
822
+ rescue UltracartClient::ApiError => e
823
+ puts "Error when calling ItemApi->update_digital_item: #{e}"
824
+ end
825
+ ```
826
+
827
+ #### Using the update_digital_item_with_http_info variant
828
+
829
+ This returns an Array which contains the response data, status code and headers.
830
+
831
+ > <Array(<ItemDigitalItemResponse>, Integer, Hash)> update_digital_item_with_http_info(digital_item_oid, digital_item)
832
+
833
+ ```ruby
834
+ begin
835
+ # Updates a file within the digital library
836
+ data, status_code, headers = api_instance.update_digital_item_with_http_info(digital_item_oid, digital_item)
837
+ p status_code # => 2xx
838
+ p headers # => { ... }
839
+ p data # => <ItemDigitalItemResponse>
840
+ rescue UltracartClient::ApiError => e
841
+ puts "Error when calling ItemApi->update_digital_item_with_http_info: #{e}"
842
+ end
843
+ ```
844
+
845
+ ### Parameters
846
+
847
+ | Name | Type | Description | Notes |
848
+ | ---- | ---- | ----------- | ----- |
849
+ | **digital_item_oid** | **Integer** | The digital item oid to update. | |
850
+ | **digital_item** | [**ItemDigitalItem**](ItemDigitalItem.md) | Digital item to update | |
851
+
852
+ ### Return type
853
+
854
+ [**ItemDigitalItemResponse**](ItemDigitalItemResponse.md)
855
+
856
+ ### Authorization
857
+
858
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
859
+
860
+ ### HTTP request headers
861
+
862
+ - **Content-Type**: application/json; charset=UTF-8
863
+ - **Accept**: application/json
864
+
865
+
479
866
  ## update_item
480
867
 
481
868
  > <ItemResponse> update_item(merchant_item_oid, item, opts)
@@ -4,11 +4,15 @@
4
4
 
5
5
  | Name | Type | Description | Notes |
6
6
  | ---- | ---- | ----------- | ----- |
7
+ | **click_wrap_agreement** | **String** | Click wrap agreement is presented to the customer before they can purchase your product. | [optional] |
7
8
  | **creation_dts** | **String** | File creation date | [optional] |
8
9
  | **description** | **String** | Description of the digital item | [optional] |
10
+ | **digital_item_oid** | **Integer** | The Digital item oid is a primary key used internally by UltraCart. You should not set or change this value. Doing so will have no effect. | [optional] |
9
11
  | **file_size** | **Integer** | File size | [optional] |
12
+ | **import_from_url** | **String** | This url is sourced to create or update a digital file in your digital library. It is only considered during an insert or update operation. | [optional] |
10
13
  | **mime_type** | **String** | Mime type associated with the file | [optional] |
11
14
  | **original_filename** | **String** | Original filename | [optional] |
15
+ | **pdf_meta** | [**ItemDigitalItemPdfMeta**](ItemDigitalItemPdfMeta.md) | | [optional] |
12
16
 
13
17
  ## Example
14
18
 
@@ -16,11 +20,15 @@
16
20
  require 'ultracart_api'
17
21
 
18
22
  instance = UltracartClient::ItemDigitalItem.new(
23
+ click_wrap_agreement: null,
19
24
  creation_dts: null,
20
25
  description: null,
26
+ digital_item_oid: null,
21
27
  file_size: null,
28
+ import_from_url: null,
22
29
  mime_type: null,
23
- original_filename: null
30
+ original_filename: null,
31
+ pdf_meta: null
24
32
  )
25
33
  ```
26
34
 
@@ -0,0 +1,38 @@
1
+ # UltracartClient::ItemDigitalItemPdfMeta
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **assembly_allowed** | **Boolean** | Assembly allowed | [optional] |
8
+ | **copy_allowed** | **Boolean** | Copy/Paste is allowed | [optional] |
9
+ | **custom_footer** | **String** | A custom footer for each pdf page | [optional] |
10
+ | **custom_header** | **String** | A custom header for each pdf page | [optional] |
11
+ | **degraded_printing_allowed** | **Boolean** | Degraded printing allowed | [optional] |
12
+ | **fillin_allowed** | **Boolean** | Fillin is allowed | [optional] |
13
+ | **modify_annotations_allowed** | **Boolean** | Modifying annotations is allowed | [optional] |
14
+ | **modify_contents_allowed** | **Boolean** | Modifying contents is allowed | [optional] |
15
+ | **printing_allowed** | **Boolean** | Printing is allowed | [optional] |
16
+ | **screen_readers_allowed** | **Boolean** | Screen readers are allowed | [optional] |
17
+ | **tagged** | **Boolean** | PDF is tagged | [optional] |
18
+
19
+ ## Example
20
+
21
+ ```ruby
22
+ require 'ultracart_api'
23
+
24
+ instance = UltracartClient::ItemDigitalItemPdfMeta.new(
25
+ assembly_allowed: null,
26
+ copy_allowed: null,
27
+ custom_footer: null,
28
+ custom_header: null,
29
+ degraded_printing_allowed: null,
30
+ fillin_allowed: null,
31
+ modify_annotations_allowed: null,
32
+ modify_contents_allowed: null,
33
+ printing_allowed: null,
34
+ screen_readers_allowed: null,
35
+ tagged: null
36
+ )
37
+ ```
38
+
@@ -0,0 +1,26 @@
1
+ # UltracartClient::ItemDigitalItemResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **digital_item** | [**ItemDigitalItem**](ItemDigitalItem.md) | | [optional] |
8
+ | **error** | [**Error**](Error.md) | | [optional] |
9
+ | **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional] |
10
+ | **success** | **Boolean** | Indicates if API call was successful | [optional] |
11
+ | **warning** | [**Warning**](Warning.md) | | [optional] |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'ultracart_api'
17
+
18
+ instance = UltracartClient::ItemDigitalItemResponse.new(
19
+ digital_item: null,
20
+ error: null,
21
+ metadata: null,
22
+ success: null,
23
+ warning: null
24
+ )
25
+ ```
26
+
@@ -0,0 +1,26 @@
1
+ # UltracartClient::ItemDigitalItemsResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **digital_items** | [**Array&lt;ItemDigitalItem&gt;**](ItemDigitalItem.md) | digital_items | [optional] |
8
+ | **error** | [**Error**](Error.md) | | [optional] |
9
+ | **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional] |
10
+ | **success** | **Boolean** | Indicates if API call was successful | [optional] |
11
+ | **warning** | [**Warning**](Warning.md) | | [optional] |
12
+
13
+ ## Example
14
+
15
+ ```ruby
16
+ require 'ultracart_api'
17
+
18
+ instance = UltracartClient::ItemDigitalItemsResponse.new(
19
+ digital_items: null,
20
+ error: null,
21
+ metadata: null,
22
+ success: null,
23
+ warning: null
24
+ )
25
+ ```
26
+