ultracart_api 4.0.66.rc → 4.0.68.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: a5b5866fdb4743492a6768ddb77e914aa66b2852a2362620134a0011f1020256
4
- data.tar.gz: a3da7152e142ecc93dcede347add472eb7ae074ac72ad9b4d3f1bc8a163c3411
3
+ metadata.gz: d8c4b903ce14ec1f657043bf48cc9c634b9826688b4d4ff1a08db79607e33202
4
+ data.tar.gz: e65e687aa31e65bf23177fc0da02ca3d7cc23d96bbe53c1c5d6314913f9f75d8
5
5
  SHA512:
6
- metadata.gz: 41a4b01ba5ea040cdea0124003fe38cb346df4b6687a4654fbf9905999f9f01ff3f9fad7188d9c063c3d8b0425f7bd78c89112568a2fb9a6beac249de6f09226
7
- data.tar.gz: be5512567f46d8a5716bf465787ea809e056bdea19cae31a40fb24bfa6061989714603e7df603deb3f0e00c3f5574c769f93409195d58595b77621c44d0028e1
6
+ metadata.gz: 6f5436e24c2a2cf0b532b5ab1b709cbd2626c076ac1df51cf248f9e9af050c1f99371c9e76f19c21135b67def035fac251387693516d22db674365f0ebeedef3
7
+ data.tar.gz: 2ba409aa671f317e42d0a99cfe347475d21b8f23038a0eb9d83cbdf411dda9c4e5f3993f76da31703325af9cfa8ef24577462e440428dc450fd75f519979b804
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.66.rc
10
+ - Package version: 4.0.68.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.66.rc.gem
27
+ gem install ./ultracart_api-4.0.68.rc.gem
28
28
  ```
29
29
 
30
- (for development, run `gem install --dev ./ultracart_api-4.0.66.rc.gem` to install the development dependencies)
30
+ (for development, run `gem install --dev ./ultracart_api-4.0.68.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.66.rc'
36
+ gem 'ultracart_api', '~> 4.0.68.rc'
37
37
 
38
38
  ### Install from Git
39
39
 
@@ -203,10 +203,12 @@ Class | Method | HTTP request | Description
203
203
  *UltracartClient::ItemApi* | [**delete_item**](docs/ItemApi.md#delete_item) | **DELETE** /item/items/{merchant_item_oid} | Delete an item
204
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
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
206
+ *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
206
207
  *UltracartClient::ItemApi* | [**get_item**](docs/ItemApi.md#get_item) | **GET** /item/items/{merchant_item_oid} | Retrieve an item
207
208
  *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
208
209
  *UltracartClient::ItemApi* | [**get_items**](docs/ItemApi.md#get_items) | **GET** /item/items | Retrieve items
209
210
  *UltracartClient::ItemApi* | [**get_pricing_tiers**](docs/ItemApi.md#get_pricing_tiers) | **GET** /item/pricing_tiers | Retrieve pricing tiers
211
+ *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
210
212
  *UltracartClient::ItemApi* | [**insert_digital_item**](docs/ItemApi.md#insert_digital_item) | **POST** /item/digital_library | Create a file within the digital library
211
213
  *UltracartClient::ItemApi* | [**insert_item**](docs/ItemApi.md#insert_item) | **POST** /item/items | Create an item
212
214
  *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
@@ -252,6 +254,7 @@ Class | Method | HTTP request | Description
252
254
  *UltracartClient::StorefrontApi* | [**clone_email_flow**](docs/StorefrontApi.md#clone_email_flow) | **POST** /storefront/{storefront_oid}/email/flows/{email_flow_uuid}/clone | Clone email flow
253
255
  *UltracartClient::StorefrontApi* | [**create_email_sending_domain**](docs/StorefrontApi.md#create_email_sending_domain) | **POST** /storefront/email/sending_domains/{domain}/create | Create email campaign
254
256
  *UltracartClient::StorefrontApi* | [**create_email_sending_domain2**](docs/StorefrontApi.md#create_email_sending_domain2) | **POST** /storefront/email/sending_domains | Create email sending domain for various providers
257
+ *UltracartClient::StorefrontApi* | [**create_fs_directory**](docs/StorefrontApi.md#create_fs_directory) | **POST** /storefront/{id}/fs/dir | Create file manager directory
255
258
  *UltracartClient::StorefrontApi* | [**create_twilio_account**](docs/StorefrontApi.md#create_twilio_account) | **POST** /storefront/twilio/accounts | Create Twilio account
256
259
  *UltracartClient::StorefrontApi* | [**delete_email_campaign_folder**](docs/StorefrontApi.md#delete_email_campaign_folder) | **DELETE** /storefront/{storefront_oid}/email/campaign_folders/{email_campaign_folder_uuid} | Delete email campaignFolder
257
260
  *UltracartClient::StorefrontApi* | [**delete_email_commseq_stat**](docs/StorefrontApi.md#delete_email_commseq_stat) | **DELETE** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/stat | Delete communication sequence stats
@@ -262,6 +265,7 @@ Class | Method | HTTP request | Description
262
265
  *UltracartClient::StorefrontApi* | [**delete_email_postcard**](docs/StorefrontApi.md#delete_email_postcard) | **DELETE** /storefront/{storefront_oid}/email/postcards/{commseq_postcard_uuid} | Delete email postcard
263
266
  *UltracartClient::StorefrontApi* | [**delete_email_sending_domain**](docs/StorefrontApi.md#delete_email_sending_domain) | **DELETE** /storefront/email/sending_domains/{domain} | delete email campaign
264
267
  *UltracartClient::StorefrontApi* | [**delete_experiment**](docs/StorefrontApi.md#delete_experiment) | **DELETE** /storefront/{storefront_oid}/experiments/{storefront_experiment_oid} | Delete experiment
268
+ *UltracartClient::StorefrontApi* | [**delete_fs_file**](docs/StorefrontApi.md#delete_fs_file) | **DELETE** /storefront/{id}/fs/file | Delete file manager directory
265
269
  *UltracartClient::StorefrontApi* | [**delete_heatmap**](docs/StorefrontApi.md#delete_heatmap) | **DELETE** /storefront/{storefront_oid}/screen_recordings/heatmap | Delete screen recording heatmap
266
270
  *UltracartClient::StorefrontApi* | [**delete_library_item**](docs/StorefrontApi.md#delete_library_item) | **DELETE** /storefront/code_library/{library_item_oid} | Delete library item
267
271
  *UltracartClient::StorefrontApi* | [**delete_library_item_published_versions**](docs/StorefrontApi.md#delete_library_item_published_versions) | **DELETE** /storefront/code_library/{library_item_oid}/published_versions | Delete all published versions for a library item, including anything in review.
@@ -328,6 +332,7 @@ Class | Method | HTTP request | Description
328
332
  *UltracartClient::StorefrontApi* | [**get_email_templates**](docs/StorefrontApi.md#get_email_templates) | **GET** /storefront/{storefront_oid}/email/templates | Get email templates
329
333
  *UltracartClient::StorefrontApi* | [**get_email_third_party_providers**](docs/StorefrontApi.md#get_email_third_party_providers) | **GET** /storefront/{storefront_oid}/email/third_party_providers | Get a list of third party email providers
330
334
  *UltracartClient::StorefrontApi* | [**get_experiments**](docs/StorefrontApi.md#get_experiments) | **GET** /storefront/{storefront_oid}/experiments | Get experiments
335
+ *UltracartClient::StorefrontApi* | [**get_fs_directory**](docs/StorefrontApi.md#get_fs_directory) | **GET** /storefront/{id}/fs/dir | Get file manager directory
331
336
  *UltracartClient::StorefrontApi* | [**get_heatmap**](docs/StorefrontApi.md#get_heatmap) | **POST** /storefront/{storefront_oid}/screen_recordings/heatmap | Get screen recording heatmap
332
337
  *UltracartClient::StorefrontApi* | [**get_heatmap_index**](docs/StorefrontApi.md#get_heatmap_index) | **POST** /storefront/{storefront_oid}/screen_recordings/heatmap/index | Get screen recording heatmap index
333
338
  *UltracartClient::StorefrontApi* | [**get_histogram_property_names**](docs/StorefrontApi.md#get_histogram_property_names) | **GET** /storefront/{storefront_oid}/email/histogram/property_names | Get histogram property names
@@ -351,6 +356,7 @@ Class | Method | HTTP request | Description
351
356
  *UltracartClient::StorefrontApi* | [**get_transaction_email_screenshots**](docs/StorefrontApi.md#get_transaction_email_screenshots) | **GET** /storefront/{storefront_oid}/transaction_email/list/{email_id}/screenshots | Get transactional email screenshots
352
357
  *UltracartClient::StorefrontApi* | [**get_twilio_account**](docs/StorefrontApi.md#get_twilio_account) | **GET** /storefront/twilio/accounts/{esp_twilio_uuid} | Get Twilio account
353
358
  *UltracartClient::StorefrontApi* | [**get_twilio_accounts**](docs/StorefrontApi.md#get_twilio_accounts) | **GET** /storefront/twilio/accounts | Get all Twilio accounts
359
+ *UltracartClient::StorefrontApi* | [**get_upload_fs_file_url**](docs/StorefrontApi.md#get_upload_fs_file_url) | **GET** /storefront/{id}/fs/upload_url/{extension} | Retrieves a S3 url where a file may be uploaded. Once uploaded, use uploadFsFile to trigger the server into reading the S3 bucket and retrieving the file.
354
360
  *UltracartClient::StorefrontApi* | [**global_unsubscribe**](docs/StorefrontApi.md#global_unsubscribe) | **POST** /storefront/{storefront_oid}/email/globalUnsubscribe | Globally unsubscribe a customer
355
361
  *UltracartClient::StorefrontApi* | [**import_email_third_party_provider_list**](docs/StorefrontApi.md#import_email_third_party_provider_list) | **POST** /storefront/{storefront_oid}/email/third_party_providers/import | Import a third party provider list
356
362
  *UltracartClient::StorefrontApi* | [**insert_email_campaign**](docs/StorefrontApi.md#insert_email_campaign) | **POST** /storefront/{storefront_oid}/email/campaigns | Insert email campaign
@@ -407,6 +413,7 @@ Class | Method | HTTP request | Description
407
413
  *UltracartClient::StorefrontApi* | [**update_screen_recording_tags**](docs/StorefrontApi.md#update_screen_recording_tags) | **POST** /storefront/{storefront_oid}/screen_recordings/{screen_recording_uuid}/tags | Update tags on a screen recording
408
414
  *UltracartClient::StorefrontApi* | [**update_transaction_email**](docs/StorefrontApi.md#update_transaction_email) | **PUT** /storefront/{storefront_oid}/transaction_email/list/{email_id} | Updates a transaction email object
409
415
  *UltracartClient::StorefrontApi* | [**update_twilio_account**](docs/StorefrontApi.md#update_twilio_account) | **PUT** /storefront/twilio/accounts/{esp_twilio_uuid} | Update Twilio account
416
+ *UltracartClient::StorefrontApi* | [**upload_fs_file**](docs/StorefrontApi.md#upload_fs_file) | **POST** /storefront/{id}/fs/upload | This is the last step in uploading a file after 1) calling getUploadFsFileUrl and 2) uploading a file to the provided url, then finally 3) calling this method and providing the key to trigger the server into reading the S3 bucket and retrieving the file.
410
417
  *UltracartClient::StorefrontApi* | [**validate_ruler**](docs/StorefrontApi.md#validate_ruler) | **POST** /storefront/ruler/validate | Validate AWS Event Ruler
411
418
  *UltracartClient::TaxApi* | [**delete_tax_provider_self_city**](docs/TaxApi.md#delete_tax_provider_self_city) | **DELETE** /tax/providers/self/city/{city} | Deletes a Self tax provider city
412
419
  *UltracartClient::TaxApi* | [**delete_tax_provider_self_country**](docs/TaxApi.md#delete_tax_provider_self_country) | **DELETE** /tax/providers/self/country/{countryCode} | Deletes a Self tax provider country
@@ -821,6 +828,11 @@ Class | Method | HTTP request | Description
821
828
  - [UltracartClient::ExperimentVariation](docs/ExperimentVariation.md)
822
829
  - [UltracartClient::ExperimentVariationStat](docs/ExperimentVariationStat.md)
823
830
  - [UltracartClient::ExperimentsResponse](docs/ExperimentsResponse.md)
831
+ - [UltracartClient::FileManagerDirectory](docs/FileManagerDirectory.md)
832
+ - [UltracartClient::FileManagerFile](docs/FileManagerFile.md)
833
+ - [UltracartClient::FileManagerPage](docs/FileManagerPage.md)
834
+ - [UltracartClient::FileManagerUploadRequest](docs/FileManagerUploadRequest.md)
835
+ - [UltracartClient::FileManagerUploadUrlResponse](docs/FileManagerUploadUrlResponse.md)
824
836
  - [UltracartClient::FulfillmentInventory](docs/FulfillmentInventory.md)
825
837
  - [UltracartClient::FulfillmentShipment](docs/FulfillmentShipment.md)
826
838
  - [UltracartClient::GeoPoint](docs/GeoPoint.md)
@@ -1205,6 +1217,8 @@ Not every change is committed to every SDK.
1205
1217
 
1206
1218
  | Version | Date | Comments |
1207
1219
  | --: | :-: | --- |
1220
+ | 4.0.68-RC | 09/29/2022 | storefront methods for file manager ui |
1221
+ | 4.0.67-RC | 09/27/2022 | added digital library call for unassociated content |
1208
1222
  | 4.0.66-RC | 09/22/2022 | digital item mgmt testing |
1209
1223
  | 4.0.65-RC | 09/22/2022 | testing digital file mgmt calls |
1210
1224
  | 4.0.64-RC | 09/19/2022 | conversations pagination |
@@ -0,0 +1,42 @@
1
+ # UltracartClient::FileManagerDirectory
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **active_theme_directory** | **Boolean** | | [optional] |
8
+ | **favorite** | **Boolean** | | [optional] |
9
+ | **hostname** | **String** | | [optional] |
10
+ | **icon** | **String** | | [optional] |
11
+ | **last_modified** | **String** | | [optional] |
12
+ | **name** | **String** | | [optional] |
13
+ | **parent_storefront_fs_directory_oid** | **Integer** | | [optional] |
14
+ | **part_of_active_theme** | **Boolean** | | [optional] |
15
+ | **selected** | **Boolean** | | [optional] |
16
+ | **storefront_fs_directory_oid** | **Integer** | | [optional] |
17
+ | **storefront_fs_file_oid** | **Integer** | | [optional] |
18
+ | **storefront_oid** | **Integer** | | [optional] |
19
+ | **type** | **String** | | [optional] |
20
+
21
+ ## Example
22
+
23
+ ```ruby
24
+ require 'ultracart_api'
25
+
26
+ instance = UltracartClient::FileManagerDirectory.new(
27
+ active_theme_directory: null,
28
+ favorite: null,
29
+ hostname: null,
30
+ icon: null,
31
+ last_modified: null,
32
+ name: null,
33
+ parent_storefront_fs_directory_oid: null,
34
+ part_of_active_theme: null,
35
+ selected: null,
36
+ storefront_fs_directory_oid: null,
37
+ storefront_fs_file_oid: null,
38
+ storefront_oid: null,
39
+ type: null
40
+ )
41
+ ```
42
+
@@ -0,0 +1,54 @@
1
+ # UltracartClient::FileManagerFile
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **favorite** | **Boolean** | | [optional] |
8
+ | **hostname** | **String** | | [optional] |
9
+ | **i18n_violation** | **Boolean** | | [optional] |
10
+ | **icon** | **String** | | [optional] |
11
+ | **internal_version** | **Integer** | | [optional] |
12
+ | **last_modified** | **String** | | [optional] |
13
+ | **merge_conflict** | **Boolean** | | [optional] |
14
+ | **name** | **String** | | [optional] |
15
+ | **parent_storefront_fs_directory_oid** | **Integer** | | [optional] |
16
+ | **part_of_active_theme** | **Boolean** | | [optional] |
17
+ | **path** | **String** | | [optional] |
18
+ | **raw_size** | **Integer** | | [optional] |
19
+ | **selected** | **Boolean** | | [optional] |
20
+ | **size** | **String** | | [optional] |
21
+ | **storefront_fs_directory_oid** | **Integer** | | [optional] |
22
+ | **storefront_fs_file_oid** | **Integer** | | [optional] |
23
+ | **storefront_oid** | **Integer** | | [optional] |
24
+ | **type** | **String** | | [optional] |
25
+ | **valid_velocity** | **String** | | [optional] |
26
+
27
+ ## Example
28
+
29
+ ```ruby
30
+ require 'ultracart_api'
31
+
32
+ instance = UltracartClient::FileManagerFile.new(
33
+ favorite: null,
34
+ hostname: null,
35
+ i18n_violation: null,
36
+ icon: null,
37
+ internal_version: null,
38
+ last_modified: null,
39
+ merge_conflict: null,
40
+ name: null,
41
+ parent_storefront_fs_directory_oid: null,
42
+ part_of_active_theme: null,
43
+ path: null,
44
+ raw_size: null,
45
+ selected: null,
46
+ size: null,
47
+ storefront_fs_directory_oid: null,
48
+ storefront_fs_file_oid: null,
49
+ storefront_oid: null,
50
+ type: null,
51
+ valid_velocity: null
52
+ )
53
+ ```
54
+
@@ -0,0 +1,32 @@
1
+ # UltracartClient::FileManagerPage
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **current_storefront_fs_directory_oid** | **Integer** | | [optional] |
8
+ | **directories** | [**Array<FileManagerDirectory>**](FileManagerDirectory.md) | | [optional] |
9
+ | **files** | [**Array<FileManagerFile>**](FileManagerFile.md) | | [optional] |
10
+ | **hostname** | **String** | | [optional] |
11
+ | **parent_storefront_fs_directory_oid** | **Integer** | | [optional] |
12
+ | **path** | **String** | | [optional] |
13
+ | **path_list** | [**Array<FileManagerDirectory>**](FileManagerDirectory.md) | | [optional] |
14
+ | **storefront_oid** | **Integer** | | [optional] |
15
+
16
+ ## Example
17
+
18
+ ```ruby
19
+ require 'ultracart_api'
20
+
21
+ instance = UltracartClient::FileManagerPage.new(
22
+ current_storefront_fs_directory_oid: null,
23
+ directories: null,
24
+ files: null,
25
+ hostname: null,
26
+ parent_storefront_fs_directory_oid: null,
27
+ path: null,
28
+ path_list: null,
29
+ storefront_oid: null
30
+ )
31
+ ```
32
+
@@ -0,0 +1,22 @@
1
+ # UltracartClient::FileManagerUploadRequest
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **filename** | **String** | | [optional] |
8
+ | **key** | **String** | | [optional] |
9
+ | **parent_storefront_fs_directory_oid** | **Integer** | | [optional] |
10
+
11
+ ## Example
12
+
13
+ ```ruby
14
+ require 'ultracart_api'
15
+
16
+ instance = UltracartClient::FileManagerUploadRequest.new(
17
+ filename: null,
18
+ key: null,
19
+ parent_storefront_fs_directory_oid: null
20
+ )
21
+ ```
22
+
@@ -0,0 +1,26 @@
1
+ # UltracartClient::FileManagerUploadUrlResponse
2
+
3
+ ## Properties
4
+
5
+ | Name | Type | Description | Notes |
6
+ | ---- | ---- | ----------- | ----- |
7
+ | **error** | [**Error**](Error.md) | | [optional] |
8
+ | **key** | **String** | | [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::FileManagerUploadUrlResponse.new(
19
+ error: null,
20
+ key: null,
21
+ metadata: null,
22
+ success: null,
23
+ warning: null
24
+ )
25
+ ```
26
+
data/docs/ItemApi.md CHANGED
@@ -8,10 +8,12 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
8
8
  | [**delete_item**](ItemApi.md#delete_item) | **DELETE** /item/items/{merchant_item_oid} | Delete an item |
9
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
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 |
11
+ | [**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 |
11
12
  | [**get_item**](ItemApi.md#get_item) | **GET** /item/items/{merchant_item_oid} | Retrieve an item |
12
13
  | [**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 |
13
14
  | [**get_items**](ItemApi.md#get_items) | **GET** /item/items | Retrieve items |
14
15
  | [**get_pricing_tiers**](ItemApi.md#get_pricing_tiers) | **GET** /item/pricing_tiers | Retrieve pricing tiers |
16
+ | [**get_unassociated_digital_items**](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 |
15
17
  | [**insert_digital_item**](ItemApi.md#insert_digital_item) | **POST** /item/digital_library | Create a file within the digital library |
16
18
  | [**insert_item**](ItemApi.md#insert_item) | **POST** /item/items | Create an item |
17
19
  | [**update_digital_item**](ItemApi.md#update_digital_item) | **PUT** /item/digital_library/{digital_item_oid} | Updates a file within the digital library |
@@ -314,6 +316,77 @@ end
314
316
  - **Accept**: application/json
315
317
 
316
318
 
319
+ ## get_digital_items_by_external_id
320
+
321
+ > <ItemDigitalItemsResponse> get_digital_items_by_external_id(external_id)
322
+
323
+ Retrieves digital items from the digital library (which are digital files that may be attached to normal items) that having a matching external id
324
+
325
+ Retrieves digital items from the digital library (which are digital files that may be attached to normal items) that having a matching external id. 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.
326
+
327
+ ### Examples
328
+
329
+ ```ruby
330
+ require 'time'
331
+ require 'ultracart_api'
332
+ require 'json'
333
+ require 'yaml'
334
+ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
335
+
336
+ # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
337
+ # As such, this might not be the best way to use this object.
338
+ # Please see https://github.com/UltraCart/sdk_samples for working examples.
339
+
340
+ api = UltracartClient::ItemApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
341
+ external_id = 'external_id_example' # String | The external id to match against.
342
+
343
+ begin
344
+ # Retrieves digital items from the digital library (which are digital files that may be attached to normal items) that having a matching external id
345
+ result = api_instance.get_digital_items_by_external_id(external_id)
346
+ p result
347
+ rescue UltracartClient::ApiError => e
348
+ puts "Error when calling ItemApi->get_digital_items_by_external_id: #{e}"
349
+ end
350
+ ```
351
+
352
+ #### Using the get_digital_items_by_external_id_with_http_info variant
353
+
354
+ This returns an Array which contains the response data, status code and headers.
355
+
356
+ > <Array(<ItemDigitalItemsResponse>, Integer, Hash)> get_digital_items_by_external_id_with_http_info(external_id)
357
+
358
+ ```ruby
359
+ begin
360
+ # Retrieves digital items from the digital library (which are digital files that may be attached to normal items) that having a matching external id
361
+ data, status_code, headers = api_instance.get_digital_items_by_external_id_with_http_info(external_id)
362
+ p status_code # => 2xx
363
+ p headers # => { ... }
364
+ p data # => <ItemDigitalItemsResponse>
365
+ rescue UltracartClient::ApiError => e
366
+ puts "Error when calling ItemApi->get_digital_items_by_external_id_with_http_info: #{e}"
367
+ end
368
+ ```
369
+
370
+ ### Parameters
371
+
372
+ | Name | Type | Description | Notes |
373
+ | ---- | ---- | ----------- | ----- |
374
+ | **external_id** | **String** | The external id to match against. | |
375
+
376
+ ### Return type
377
+
378
+ [**ItemDigitalItemsResponse**](ItemDigitalItemsResponse.md)
379
+
380
+ ### Authorization
381
+
382
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
383
+
384
+ ### HTTP request headers
385
+
386
+ - **Content-Type**: Not defined
387
+ - **Accept**: application/json
388
+
389
+
317
390
  ## get_item
318
391
 
319
392
  > <ItemResponse> get_item(merchant_item_oid, opts)
@@ -628,6 +701,89 @@ end
628
701
  - **Accept**: application/json
629
702
 
630
703
 
704
+ ## get_unassociated_digital_items
705
+
706
+ > <ItemDigitalItemsResponse> get_unassociated_digital_items(opts)
707
+
708
+ Retrieve digital items from the digital library (which are digital files that may be attached to normal items) not yet associated with actual items
709
+
710
+ Retrieves a group of digital items (file information) from the account that are not yet associated with any actual items. 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.
711
+
712
+ ### Examples
713
+
714
+ ```ruby
715
+ require 'time'
716
+ require 'ultracart_api'
717
+ require 'json'
718
+ require 'yaml'
719
+ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
720
+
721
+ # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
722
+ # As such, this might not be the best way to use this object.
723
+ # Please see https://github.com/UltraCart/sdk_samples for working examples.
724
+
725
+ api = UltracartClient::ItemApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
726
+ opts = {
727
+ _limit: 56, # Integer | The maximum number of records to return on this one API call. (Default 100, Max 2000)
728
+ _offset: 56, # Integer | Pagination of the record set. Offset is a zero based index.
729
+ _since: '_since_example', # String | Fetch items that have been created/modified since this date/time.
730
+ _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.
731
+ _expand: '_expand_example', # String | The object expansion to perform on the result. See documentation for examples
732
+ _placeholders: true # Boolean | Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.
733
+ }
734
+
735
+ begin
736
+ # Retrieve digital items from the digital library (which are digital files that may be attached to normal items) not yet associated with actual items
737
+ result = api_instance.get_unassociated_digital_items(opts)
738
+ p result
739
+ rescue UltracartClient::ApiError => e
740
+ puts "Error when calling ItemApi->get_unassociated_digital_items: #{e}"
741
+ end
742
+ ```
743
+
744
+ #### Using the get_unassociated_digital_items_with_http_info variant
745
+
746
+ This returns an Array which contains the response data, status code and headers.
747
+
748
+ > <Array(<ItemDigitalItemsResponse>, Integer, Hash)> get_unassociated_digital_items_with_http_info(opts)
749
+
750
+ ```ruby
751
+ begin
752
+ # Retrieve digital items from the digital library (which are digital files that may be attached to normal items) not yet associated with actual items
753
+ data, status_code, headers = api_instance.get_unassociated_digital_items_with_http_info(opts)
754
+ p status_code # => 2xx
755
+ p headers # => { ... }
756
+ p data # => <ItemDigitalItemsResponse>
757
+ rescue UltracartClient::ApiError => e
758
+ puts "Error when calling ItemApi->get_unassociated_digital_items_with_http_info: #{e}"
759
+ end
760
+ ```
761
+
762
+ ### Parameters
763
+
764
+ | Name | Type | Description | Notes |
765
+ | ---- | ---- | ----------- | ----- |
766
+ | **_limit** | **Integer** | The maximum number of records to return on this one API call. (Default 100, Max 2000) | [optional][default to 100] |
767
+ | **_offset** | **Integer** | Pagination of the record set. Offset is a zero based index. | [optional][default to 0] |
768
+ | **_since** | **String** | Fetch items that have been created/modified since this date/time. | [optional] |
769
+ | **_sort** | **String** | The sort order of the items. See Sorting documentation for examples of using multiple values and sorting by ascending and descending. | [optional] |
770
+ | **_expand** | **String** | The object expansion to perform on the result. See documentation for examples | [optional] |
771
+ | **_placeholders** | **Boolean** | Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API. | [optional] |
772
+
773
+ ### Return type
774
+
775
+ [**ItemDigitalItemsResponse**](ItemDigitalItemsResponse.md)
776
+
777
+ ### Authorization
778
+
779
+ [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
780
+
781
+ ### HTTP request headers
782
+
783
+ - **Content-Type**: Not defined
784
+ - **Accept**: application/json
785
+
786
+
631
787
  ## insert_digital_item
632
788
 
633
789
  > <ItemDigitalItemResponse> insert_digital_item(digital_item)
@@ -8,6 +8,7 @@
8
8
  | **creation_dts** | **String** | File creation date | [optional] |
9
9
  | **description** | **String** | Description of the digital item | [optional] |
10
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] |
11
+ | **external_id** | **String** | External Id useful for syncing with a remote filesystem, this may be an MD5 hash or whatever suits your needs. | [optional] |
11
12
  | **file_size** | **Integer** | File size | [optional] |
12
13
  | **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] |
13
14
  | **mime_type** | **String** | Mime type associated with the file | [optional] |
@@ -24,6 +25,7 @@ instance = UltracartClient::ItemDigitalItem.new(
24
25
  creation_dts: null,
25
26
  description: null,
26
27
  digital_item_oid: null,
28
+ external_id: null,
27
29
  file_size: null,
28
30
  import_from_url: null,
29
31
  mime_type: null,