ultracart_api 3.10.50 → 3.10.52
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +17 -8
- data/docs/FileManagerDirectory.md +20 -0
- data/docs/FileManagerFile.md +26 -0
- data/docs/FileManagerPage.md +3 -0
- data/docs/FileManagerPageResponse.md +12 -0
- data/docs/FileManagerUploadRequest.md +10 -0
- data/docs/FileManagerUploadUrlResponse.md +12 -0
- data/docs/ItemApi.md +51 -0
- data/docs/ItemDigitalItem.md +1 -0
- data/docs/StorefrontApi.md +240 -190
- data/lib/ultracart_api/api/item_api.rb +55 -0
- data/lib/ultracart_api/api/storefront_api.rb +279 -218
- data/lib/ultracart_api/models/file_manager_directory.rb +292 -0
- data/lib/ultracart_api/models/file_manager_file.rb +346 -0
- data/lib/ultracart_api/models/file_manager_page.rb +34 -1
- data/lib/ultracart_api/models/file_manager_page_response.rb +221 -0
- data/lib/ultracart_api/models/file_manager_upload_request.rb +202 -0
- data/lib/ultracart_api/models/file_manager_upload_url_response.rb +221 -0
- data/lib/ultracart_api/models/item_digital_item.rb +26 -1
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +5 -0
- metadata +12 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: b1d440fa981851f2de48d56b33e73e8f8357141dd04d5c02288399e4b2733574
|
4
|
+
data.tar.gz: 8e74f69548ee133af17162801b5fa758b9fb6ad0ea5f6426b31467b5ef4f140d
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: c0877c997ab6e78c7308cdb4520e6ca8c736561f22c01ebe3d350304e8b058f198ed2f025bca81e9e5852e008e40050df79f9d0740f8fca9356b9c3cfa9642bd
|
7
|
+
data.tar.gz: 47f26909fcd7a22083902415882410b4b525f8baf5f59baa9801591fe15fd650784dce051fb864547b2c8b5bf9a910343c778d356d2349e2503261cd4bfc143c
|
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.
|
10
|
+
- Package version: 3.10.52
|
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.10.
|
27
|
+
gem install ./ultracart_api-3.10.52.gem
|
28
28
|
```
|
29
|
-
(for development, run `gem install --dev ./ultracart_api-3.10.
|
29
|
+
(for development, run `gem install --dev ./ultracart_api-3.10.52.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.10.
|
35
|
+
gem 'ultracart_api', '~> 3.10.52'
|
36
36
|
|
37
37
|
### Install from Git
|
38
38
|
|
@@ -197,6 +197,7 @@ Class | Method | HTTP request | Description
|
|
197
197
|
*UltracartClient::ItemApi* | [**delete_item**](docs/ItemApi.md#delete_item) | **DELETE** /item/items/{merchant_item_oid} | Delete an item
|
198
198
|
*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
|
199
199
|
*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
|
200
|
+
*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
|
200
201
|
*UltracartClient::ItemApi* | [**get_item**](docs/ItemApi.md#get_item) | **GET** /item/items/{merchant_item_oid} | Retrieve an item
|
201
202
|
*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
|
202
203
|
*UltracartClient::ItemApi* | [**get_items**](docs/ItemApi.md#get_items) | **GET** /item/items | Retrieve items
|
@@ -245,12 +246,10 @@ Class | Method | HTTP request | Description
|
|
245
246
|
*UltracartClient::StorefrontApi* | [**check_download_email_segment**](docs/StorefrontApi.md#check_download_email_segment) | **POST** /storefront/{storefront_oid}/email/segments/{email_segment_uuid}/downloadPrepare/{email_segment_rebuild_uuid} | Check download of email segment
|
246
247
|
*UltracartClient::StorefrontApi* | [**clone_email_campaign**](docs/StorefrontApi.md#clone_email_campaign) | **POST** /storefront/{storefront_oid}/email/campaigns/{email_campaign_uuid}/clone | Clone email campaign
|
247
248
|
*UltracartClient::StorefrontApi* | [**clone_email_flow**](docs/StorefrontApi.md#clone_email_flow) | **POST** /storefront/{storefront_oid}/email/flows/{email_flow_uuid}/clone | Clone email flow
|
248
|
-
*UltracartClient::StorefrontApi* | [**create_admin_panel_fs_directory**](docs/StorefrontApi.md#create_admin_panel_fs_directory) | **POST** /storefront/{id}/adminPanel/fs/dir | Create file manager directory for admin panel
|
249
|
-
*UltracartClient::StorefrontApi* | [**create_admin_panel_fs_file_upload**](docs/StorefrontApi.md#create_admin_panel_fs_file_upload) | **POST** /storefront/{id}/adminPanel/fs/file | Upload file manager file for admin panel
|
250
249
|
*UltracartClient::StorefrontApi* | [**create_email_sending_domain**](docs/StorefrontApi.md#create_email_sending_domain) | **POST** /storefront/email/sending_domains/{domain}/create | Create email campaign
|
251
250
|
*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
|
251
|
+
*UltracartClient::StorefrontApi* | [**create_fs_directory**](docs/StorefrontApi.md#create_fs_directory) | **POST** /storefront/{id}/fs/dir | Create file manager directory
|
252
252
|
*UltracartClient::StorefrontApi* | [**create_twilio_account**](docs/StorefrontApi.md#create_twilio_account) | **POST** /storefront/twilio/accounts | Create Twilio account
|
253
|
-
*UltracartClient::StorefrontApi* | [**delete_admin_panel_fs_file**](docs/StorefrontApi.md#delete_admin_panel_fs_file) | **DELETE** /storefront/{id}/adminPanel/fs/file | Delete file manager directory for admin panel
|
254
253
|
*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
|
255
254
|
*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
|
256
255
|
*UltracartClient::StorefrontApi* | [**delete_email_email**](docs/StorefrontApi.md#delete_email_email) | **DELETE** /storefront/{storefront_oid}/email/emails/{commseq_email_uuid} | Delete email email
|
@@ -260,6 +259,7 @@ Class | Method | HTTP request | Description
|
|
260
259
|
*UltracartClient::StorefrontApi* | [**delete_email_postcard**](docs/StorefrontApi.md#delete_email_postcard) | **DELETE** /storefront/{storefront_oid}/email/postcards/{commseq_postcard_uuid} | Delete email postcard
|
261
260
|
*UltracartClient::StorefrontApi* | [**delete_email_sending_domain**](docs/StorefrontApi.md#delete_email_sending_domain) | **DELETE** /storefront/email/sending_domains/{domain} | delete email campaign
|
262
261
|
*UltracartClient::StorefrontApi* | [**delete_experiment**](docs/StorefrontApi.md#delete_experiment) | **DELETE** /storefront/{storefront_oid}/experiments/{storefront_experiment_oid} | Delete experiment
|
262
|
+
*UltracartClient::StorefrontApi* | [**delete_fs_file**](docs/StorefrontApi.md#delete_fs_file) | **DELETE** /storefront/{id}/fs/file | Delete file manager directory
|
263
263
|
*UltracartClient::StorefrontApi* | [**delete_heatmap**](docs/StorefrontApi.md#delete_heatmap) | **DELETE** /storefront/{storefront_oid}/screen_recordings/heatmap | Delete screen recording heatmap
|
264
264
|
*UltracartClient::StorefrontApi* | [**delete_library_item**](docs/StorefrontApi.md#delete_library_item) | **DELETE** /storefront/code_library/{library_item_oid} | Delete library item
|
265
265
|
*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.
|
@@ -268,7 +268,6 @@ Class | Method | HTTP request | Description
|
|
268
268
|
*UltracartClient::StorefrontApi* | [**duplicate_library_item**](docs/StorefrontApi.md#duplicate_library_item) | **POST** /storefront/code_library/{library_item_oid}/duplicate | Duplicate library item.
|
269
269
|
*UltracartClient::StorefrontApi* | [**favorite_screen_recording**](docs/StorefrontApi.md#favorite_screen_recording) | **POST** /storefront/{storefront_oid}/screen_recordings/{screen_recording_uuid}/favorite | Update favorite flag on screen recording
|
270
270
|
*UltracartClient::StorefrontApi* | [**geocode_address**](docs/StorefrontApi.md#geocode_address) | **POST** /storefront/{storefront_oid}/email/geocode | Obtain lat/long for an address
|
271
|
-
*UltracartClient::StorefrontApi* | [**get_admin_panel_fs_directory**](docs/StorefrontApi.md#get_admin_panel_fs_directory) | **GET** /storefront/{id}/adminPanel/fs/dir | Get file manager directory for admin panel
|
272
271
|
*UltracartClient::StorefrontApi* | [**get_countries**](docs/StorefrontApi.md#get_countries) | **GET** /storefront/{storefront_oid}/email/countries | Get countries
|
273
272
|
*UltracartClient::StorefrontApi* | [**get_editor_token**](docs/StorefrontApi.md#get_editor_token) | **GET** /storefront/{storefront_oid}/editor_token | Gets editor token
|
274
273
|
*UltracartClient::StorefrontApi* | [**get_email_base_templates**](docs/StorefrontApi.md#get_email_base_templates) | **GET** /storefront/{storefront_oid}/email/baseTemplates | Get email communication base templates
|
@@ -327,6 +326,7 @@ Class | Method | HTTP request | Description
|
|
327
326
|
*UltracartClient::StorefrontApi* | [**get_email_templates**](docs/StorefrontApi.md#get_email_templates) | **GET** /storefront/{storefront_oid}/email/templates | Get email templates
|
328
327
|
*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
|
329
328
|
*UltracartClient::StorefrontApi* | [**get_experiments**](docs/StorefrontApi.md#get_experiments) | **GET** /storefront/{storefront_oid}/experiments | Get experiments
|
329
|
+
*UltracartClient::StorefrontApi* | [**get_fs_directory**](docs/StorefrontApi.md#get_fs_directory) | **GET** /storefront/{id}/fs/dir | Get file manager directory
|
330
330
|
*UltracartClient::StorefrontApi* | [**get_heatmap**](docs/StorefrontApi.md#get_heatmap) | **POST** /storefront/{storefront_oid}/screen_recordings/heatmap | Get screen recording heatmap
|
331
331
|
*UltracartClient::StorefrontApi* | [**get_heatmap_index**](docs/StorefrontApi.md#get_heatmap_index) | **POST** /storefront/{storefront_oid}/screen_recordings/heatmap/index | Get screen recording heatmap index
|
332
332
|
*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
|
@@ -350,6 +350,7 @@ Class | Method | HTTP request | Description
|
|
350
350
|
*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
|
351
351
|
*UltracartClient::StorefrontApi* | [**get_twilio_account**](docs/StorefrontApi.md#get_twilio_account) | **GET** /storefront/twilio/accounts/{esp_twilio_uuid} | Get Twilio account
|
352
352
|
*UltracartClient::StorefrontApi* | [**get_twilio_accounts**](docs/StorefrontApi.md#get_twilio_accounts) | **GET** /storefront/twilio/accounts | Get all Twilio accounts
|
353
|
+
*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.
|
353
354
|
*UltracartClient::StorefrontApi* | [**global_unsubscribe**](docs/StorefrontApi.md#global_unsubscribe) | **POST** /storefront/{storefront_oid}/email/globalUnsubscribe | Globally unsubscribe a customer
|
354
355
|
*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
|
355
356
|
*UltracartClient::StorefrontApi* | [**insert_email_campaign**](docs/StorefrontApi.md#insert_email_campaign) | **POST** /storefront/{storefront_oid}/email/campaigns | Insert email campaign
|
@@ -406,6 +407,7 @@ Class | Method | HTTP request | Description
|
|
406
407
|
*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
|
407
408
|
*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
|
408
409
|
*UltracartClient::StorefrontApi* | [**update_twilio_account**](docs/StorefrontApi.md#update_twilio_account) | **PUT** /storefront/twilio/accounts/{esp_twilio_uuid} | Update Twilio account
|
410
|
+
*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.
|
409
411
|
*UltracartClient::StorefrontApi* | [**validate_ruler**](docs/StorefrontApi.md#validate_ruler) | **POST** /storefront/ruler/validate | Validate AWS Event Ruler
|
410
412
|
*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
|
411
413
|
*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
|
@@ -820,7 +822,12 @@ Class | Method | HTTP request | Description
|
|
820
822
|
- [UltracartClient::ExperimentVariation](docs/ExperimentVariation.md)
|
821
823
|
- [UltracartClient::ExperimentVariationStat](docs/ExperimentVariationStat.md)
|
822
824
|
- [UltracartClient::ExperimentsResponse](docs/ExperimentsResponse.md)
|
825
|
+
- [UltracartClient::FileManagerDirectory](docs/FileManagerDirectory.md)
|
826
|
+
- [UltracartClient::FileManagerFile](docs/FileManagerFile.md)
|
823
827
|
- [UltracartClient::FileManagerPage](docs/FileManagerPage.md)
|
828
|
+
- [UltracartClient::FileManagerPageResponse](docs/FileManagerPageResponse.md)
|
829
|
+
- [UltracartClient::FileManagerUploadRequest](docs/FileManagerUploadRequest.md)
|
830
|
+
- [UltracartClient::FileManagerUploadUrlResponse](docs/FileManagerUploadUrlResponse.md)
|
824
831
|
- [UltracartClient::FulfillmentInventory](docs/FulfillmentInventory.md)
|
825
832
|
- [UltracartClient::FulfillmentShipment](docs/FulfillmentShipment.md)
|
826
833
|
- [UltracartClient::GeoPoint](docs/GeoPoint.md)
|
@@ -1202,6 +1209,8 @@ Not every change is committed to every SDK.
|
|
1202
1209
|
|
1203
1210
|
| Version | Date | Comments |
|
1204
1211
|
| --: | :-: | --- |
|
1212
|
+
| 3.10.52 | 09/29/2022 | storefront file mgr calls tweaks |
|
1213
|
+
| 3.10.51 | 09/29/2022 | storefront methods for file manager ui |
|
1205
1214
|
| 3.10.50 | 09/27/2022 | added digital library call for unassociated content |
|
1206
1215
|
| 3.10.49 | 09/22/2022 | digital item mgmt testing |
|
1207
1216
|
| 3.10.48 | 09/22/2022 | testing digital file mgmt calls |
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# UltracartClient::FileManagerDirectory
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**active_theme_directory** | **BOOLEAN** | | [optional]
|
7
|
+
**favorite** | **BOOLEAN** | | [optional]
|
8
|
+
**hostname** | **String** | | [optional]
|
9
|
+
**icon** | **String** | | [optional]
|
10
|
+
**last_modified** | **String** | | [optional]
|
11
|
+
**name** | **String** | | [optional]
|
12
|
+
**parent_storefront_fs_directory_oid** | **Integer** | | [optional]
|
13
|
+
**part_of_active_theme** | **BOOLEAN** | | [optional]
|
14
|
+
**selected** | **BOOLEAN** | | [optional]
|
15
|
+
**storefront_fs_directory_oid** | **Integer** | | [optional]
|
16
|
+
**storefront_fs_file_oid** | **Integer** | | [optional]
|
17
|
+
**storefront_oid** | **Integer** | | [optional]
|
18
|
+
**type** | **String** | | [optional]
|
19
|
+
|
20
|
+
|
@@ -0,0 +1,26 @@
|
|
1
|
+
# UltracartClient::FileManagerFile
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**favorite** | **BOOLEAN** | | [optional]
|
7
|
+
**hostname** | **String** | | [optional]
|
8
|
+
**i18n_violation** | **BOOLEAN** | | [optional]
|
9
|
+
**icon** | **String** | | [optional]
|
10
|
+
**internal_version** | **Integer** | | [optional]
|
11
|
+
**last_modified** | **String** | | [optional]
|
12
|
+
**merge_conflict** | **BOOLEAN** | | [optional]
|
13
|
+
**name** | **String** | | [optional]
|
14
|
+
**parent_storefront_fs_directory_oid** | **Integer** | | [optional]
|
15
|
+
**part_of_active_theme** | **BOOLEAN** | | [optional]
|
16
|
+
**path** | **String** | | [optional]
|
17
|
+
**raw_size** | **Integer** | | [optional]
|
18
|
+
**selected** | **BOOLEAN** | | [optional]
|
19
|
+
**size** | **String** | | [optional]
|
20
|
+
**storefront_fs_directory_oid** | **Integer** | | [optional]
|
21
|
+
**storefront_fs_file_oid** | **Integer** | | [optional]
|
22
|
+
**storefront_oid** | **Integer** | | [optional]
|
23
|
+
**type** | **String** | | [optional]
|
24
|
+
**valid_velocity** | **String** | | [optional]
|
25
|
+
|
26
|
+
|
data/docs/FileManagerPage.md
CHANGED
@@ -4,9 +4,12 @@
|
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**current_storefront_fs_directory_oid** | **Integer** | | [optional]
|
7
|
+
**directories** | [**Array<FileManagerDirectory>**](FileManagerDirectory.md) | | [optional]
|
8
|
+
**files** | [**Array<FileManagerFile>**](FileManagerFile.md) | | [optional]
|
7
9
|
**hostname** | **String** | | [optional]
|
8
10
|
**parent_storefront_fs_directory_oid** | **Integer** | | [optional]
|
9
11
|
**path** | **String** | | [optional]
|
12
|
+
**path_list** | [**Array<FileManagerDirectory>**](FileManagerDirectory.md) | | [optional]
|
10
13
|
**storefront_oid** | **Integer** | | [optional]
|
11
14
|
|
12
15
|
|
@@ -0,0 +1,12 @@
|
|
1
|
+
# UltracartClient::FileManagerPageResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**error** | [**Error**](Error.md) | | [optional]
|
7
|
+
**file_manager_page** | [**FileManagerPage**](FileManagerPage.md) | | [optional]
|
8
|
+
**metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
|
9
|
+
**success** | **BOOLEAN** | Indicates if API call was successful | [optional]
|
10
|
+
**warning** | [**Warning**](Warning.md) | | [optional]
|
11
|
+
|
12
|
+
|
@@ -0,0 +1,10 @@
|
|
1
|
+
# UltracartClient::FileManagerUploadRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**filename** | **String** | | [optional]
|
7
|
+
**key** | **String** | | [optional]
|
8
|
+
**parent_storefront_fs_directory_oid** | **Integer** | | [optional]
|
9
|
+
|
10
|
+
|
@@ -0,0 +1,12 @@
|
|
1
|
+
# UltracartClient::FileManagerUploadUrlResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**error** | [**Error**](Error.md) | | [optional]
|
7
|
+
**key** | **String** | | [optional]
|
8
|
+
**metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
|
9
|
+
**success** | **BOOLEAN** | Indicates if API call was successful | [optional]
|
10
|
+
**warning** | [**Warning**](Warning.md) | | [optional]
|
11
|
+
|
12
|
+
|
data/docs/ItemApi.md
CHANGED
@@ -8,6 +8,7 @@ Method | HTTP request | Description
|
|
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
|
@@ -230,6 +231,56 @@ Name | Type | Description | Notes
|
|
230
231
|
|
231
232
|
|
232
233
|
|
234
|
+
# **get_digital_items_by_external_id**
|
235
|
+
> ItemDigitalItemsResponse get_digital_items_by_external_id(external_id)
|
236
|
+
|
237
|
+
Retrieves digital items from the digital library (which are digital files that may be attached to normal items) that having a matching external id
|
238
|
+
|
239
|
+
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.
|
240
|
+
|
241
|
+
### Example
|
242
|
+
```ruby
|
243
|
+
# load the gem
|
244
|
+
require 'ultracart_api'
|
245
|
+
|
246
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
247
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
248
|
+
api_instance = UltracartClient::ItemApi.new_using_api_key(simple_key, false, false)
|
249
|
+
|
250
|
+
|
251
|
+
external_id = 'external_id_example' # String | The external id to match against.
|
252
|
+
|
253
|
+
|
254
|
+
begin
|
255
|
+
#Retrieves digital items from the digital library (which are digital files that may be attached to normal items) that having a matching external id
|
256
|
+
result = api_instance.get_digital_items_by_external_id(external_id)
|
257
|
+
p result
|
258
|
+
rescue UltracartClient::ApiError => e
|
259
|
+
puts "Exception when calling ItemApi->get_digital_items_by_external_id: #{e}"
|
260
|
+
end
|
261
|
+
```
|
262
|
+
|
263
|
+
### Parameters
|
264
|
+
|
265
|
+
Name | Type | Description | Notes
|
266
|
+
------------- | ------------- | ------------- | -------------
|
267
|
+
**external_id** | **String**| The external id to match against. |
|
268
|
+
|
269
|
+
### Return type
|
270
|
+
|
271
|
+
[**ItemDigitalItemsResponse**](ItemDigitalItemsResponse.md)
|
272
|
+
|
273
|
+
### Authorization
|
274
|
+
|
275
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
276
|
+
|
277
|
+
### HTTP request headers
|
278
|
+
|
279
|
+
- **Content-Type**: application/json
|
280
|
+
- **Accept**: application/json
|
281
|
+
|
282
|
+
|
283
|
+
|
233
284
|
# **get_item**
|
234
285
|
> ItemResponse get_item(merchant_item_oid, opts)
|
235
286
|
|
data/docs/ItemDigitalItem.md
CHANGED
@@ -7,6 +7,7 @@ Name | Type | Description | Notes
|
|
7
7
|
**creation_dts** | **String** | File creation date | [optional]
|
8
8
|
**description** | **String** | Description of the digital item | [optional]
|
9
9
|
**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]
|
10
|
+
**external_id** | **String** | External Id useful for syncing with a remote filesystem, this may be an MD5 hash or whatever suits your needs. | [optional]
|
10
11
|
**file_size** | **Integer** | File size | [optional]
|
11
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]
|
12
13
|
**mime_type** | **String** | Mime type associated with the file | [optional]
|