ultracart_api 4.0.67.rc → 4.0.68.rc
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 +15 -8
- data/docs/FileManagerDirectory.md +42 -0
- data/docs/FileManagerFile.md +54 -0
- data/docs/FileManagerPage.md +6 -0
- data/docs/FileManagerUploadRequest.md +22 -0
- data/docs/FileManagerUploadUrlResponse.md +26 -0
- data/docs/ItemApi.md +72 -0
- data/docs/ItemDigitalItem.md +2 -0
- data/docs/StorefrontApi.md +336 -267
- data/lib/ultracart_api/api/item_api.rb +64 -0
- data/lib/ultracart_api/api/storefront_api.rb +328 -252
- data/lib/ultracart_api/models/file_manager_directory.rb +327 -0
- data/lib/ultracart_api/models/file_manager_file.rb +381 -0
- data/lib/ultracart_api/models/file_manager_page.rb +34 -1
- data/lib/ultracart_api/models/file_manager_upload_request.rb +237 -0
- data/lib/ultracart_api/models/file_manager_upload_url_response.rb +256 -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 +4 -0
- metadata +10 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: d8c4b903ce14ec1f657043bf48cc9c634b9826688b4d4ff1a08db79607e33202
|
|
4
|
+
data.tar.gz: e65e687aa31e65bf23177fc0da02ca3d7cc23d96bbe53c1c5d6314913f9f75d8
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
36
|
+
gem 'ultracart_api', '~> 4.0.68.rc'
|
|
37
37
|
|
|
38
38
|
### Install from Git
|
|
39
39
|
|
|
@@ -203,6 +203,7 @@ 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
|
|
@@ -251,12 +252,10 @@ Class | Method | HTTP request | Description
|
|
|
251
252
|
*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
|
|
252
253
|
*UltracartClient::StorefrontApi* | [**clone_email_campaign**](docs/StorefrontApi.md#clone_email_campaign) | **POST** /storefront/{storefront_oid}/email/campaigns/{email_campaign_uuid}/clone | Clone email campaign
|
|
253
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
|
|
254
|
-
*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
|
|
255
|
-
*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
|
|
256
255
|
*UltracartClient::StorefrontApi* | [**create_email_sending_domain**](docs/StorefrontApi.md#create_email_sending_domain) | **POST** /storefront/email/sending_domains/{domain}/create | Create email campaign
|
|
257
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
|
|
258
258
|
*UltracartClient::StorefrontApi* | [**create_twilio_account**](docs/StorefrontApi.md#create_twilio_account) | **POST** /storefront/twilio/accounts | Create Twilio account
|
|
259
|
-
*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
|
|
260
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
|
|
261
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
261
|
*UltracartClient::StorefrontApi* | [**delete_email_email**](docs/StorefrontApi.md#delete_email_email) | **DELETE** /storefront/{storefront_oid}/email/emails/{commseq_email_uuid} | Delete email email
|
|
@@ -266,6 +265,7 @@ Class | Method | HTTP request | Description
|
|
|
266
265
|
*UltracartClient::StorefrontApi* | [**delete_email_postcard**](docs/StorefrontApi.md#delete_email_postcard) | **DELETE** /storefront/{storefront_oid}/email/postcards/{commseq_postcard_uuid} | Delete email postcard
|
|
267
266
|
*UltracartClient::StorefrontApi* | [**delete_email_sending_domain**](docs/StorefrontApi.md#delete_email_sending_domain) | **DELETE** /storefront/email/sending_domains/{domain} | delete email campaign
|
|
268
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
|
|
269
269
|
*UltracartClient::StorefrontApi* | [**delete_heatmap**](docs/StorefrontApi.md#delete_heatmap) | **DELETE** /storefront/{storefront_oid}/screen_recordings/heatmap | Delete screen recording heatmap
|
|
270
270
|
*UltracartClient::StorefrontApi* | [**delete_library_item**](docs/StorefrontApi.md#delete_library_item) | **DELETE** /storefront/code_library/{library_item_oid} | Delete library item
|
|
271
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.
|
|
@@ -274,7 +274,6 @@ Class | Method | HTTP request | Description
|
|
|
274
274
|
*UltracartClient::StorefrontApi* | [**duplicate_library_item**](docs/StorefrontApi.md#duplicate_library_item) | **POST** /storefront/code_library/{library_item_oid}/duplicate | Duplicate library item.
|
|
275
275
|
*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
|
|
276
276
|
*UltracartClient::StorefrontApi* | [**geocode_address**](docs/StorefrontApi.md#geocode_address) | **POST** /storefront/{storefront_oid}/email/geocode | Obtain lat/long for an address
|
|
277
|
-
*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
|
|
278
277
|
*UltracartClient::StorefrontApi* | [**get_countries**](docs/StorefrontApi.md#get_countries) | **GET** /storefront/{storefront_oid}/email/countries | Get countries
|
|
279
278
|
*UltracartClient::StorefrontApi* | [**get_editor_token**](docs/StorefrontApi.md#get_editor_token) | **GET** /storefront/{storefront_oid}/editor_token | Gets editor token
|
|
280
279
|
*UltracartClient::StorefrontApi* | [**get_email_base_templates**](docs/StorefrontApi.md#get_email_base_templates) | **GET** /storefront/{storefront_oid}/email/baseTemplates | Get email communication base templates
|
|
@@ -333,6 +332,7 @@ Class | Method | HTTP request | Description
|
|
|
333
332
|
*UltracartClient::StorefrontApi* | [**get_email_templates**](docs/StorefrontApi.md#get_email_templates) | **GET** /storefront/{storefront_oid}/email/templates | Get email templates
|
|
334
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
|
|
335
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
|
|
336
336
|
*UltracartClient::StorefrontApi* | [**get_heatmap**](docs/StorefrontApi.md#get_heatmap) | **POST** /storefront/{storefront_oid}/screen_recordings/heatmap | Get screen recording heatmap
|
|
337
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
|
|
338
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
|
|
@@ -356,6 +356,7 @@ Class | Method | HTTP request | Description
|
|
|
356
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
|
|
357
357
|
*UltracartClient::StorefrontApi* | [**get_twilio_account**](docs/StorefrontApi.md#get_twilio_account) | **GET** /storefront/twilio/accounts/{esp_twilio_uuid} | Get Twilio account
|
|
358
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.
|
|
359
360
|
*UltracartClient::StorefrontApi* | [**global_unsubscribe**](docs/StorefrontApi.md#global_unsubscribe) | **POST** /storefront/{storefront_oid}/email/globalUnsubscribe | Globally unsubscribe a customer
|
|
360
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
|
|
361
362
|
*UltracartClient::StorefrontApi* | [**insert_email_campaign**](docs/StorefrontApi.md#insert_email_campaign) | **POST** /storefront/{storefront_oid}/email/campaigns | Insert email campaign
|
|
@@ -412,6 +413,7 @@ Class | Method | HTTP request | Description
|
|
|
412
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
|
|
413
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
|
|
414
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.
|
|
415
417
|
*UltracartClient::StorefrontApi* | [**validate_ruler**](docs/StorefrontApi.md#validate_ruler) | **POST** /storefront/ruler/validate | Validate AWS Event Ruler
|
|
416
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
|
|
417
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
|
|
@@ -826,7 +828,11 @@ Class | Method | HTTP request | Description
|
|
|
826
828
|
- [UltracartClient::ExperimentVariation](docs/ExperimentVariation.md)
|
|
827
829
|
- [UltracartClient::ExperimentVariationStat](docs/ExperimentVariationStat.md)
|
|
828
830
|
- [UltracartClient::ExperimentsResponse](docs/ExperimentsResponse.md)
|
|
831
|
+
- [UltracartClient::FileManagerDirectory](docs/FileManagerDirectory.md)
|
|
832
|
+
- [UltracartClient::FileManagerFile](docs/FileManagerFile.md)
|
|
829
833
|
- [UltracartClient::FileManagerPage](docs/FileManagerPage.md)
|
|
834
|
+
- [UltracartClient::FileManagerUploadRequest](docs/FileManagerUploadRequest.md)
|
|
835
|
+
- [UltracartClient::FileManagerUploadUrlResponse](docs/FileManagerUploadUrlResponse.md)
|
|
830
836
|
- [UltracartClient::FulfillmentInventory](docs/FulfillmentInventory.md)
|
|
831
837
|
- [UltracartClient::FulfillmentShipment](docs/FulfillmentShipment.md)
|
|
832
838
|
- [UltracartClient::GeoPoint](docs/GeoPoint.md)
|
|
@@ -1211,6 +1217,7 @@ Not every change is committed to every SDK.
|
|
|
1211
1217
|
|
|
1212
1218
|
| Version | Date | Comments |
|
|
1213
1219
|
| --: | :-: | --- |
|
|
1220
|
+
| 4.0.68-RC | 09/29/2022 | storefront methods for file manager ui |
|
|
1214
1221
|
| 4.0.67-RC | 09/27/2022 | added digital library call for unassociated content |
|
|
1215
1222
|
| 4.0.66-RC | 09/22/2022 | digital item mgmt testing |
|
|
1216
1223
|
| 4.0.65-RC | 09/22/2022 | testing digital file mgmt calls |
|
|
@@ -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
|
+
|
data/docs/FileManagerPage.md
CHANGED
|
@@ -5,9 +5,12 @@
|
|
|
5
5
|
| Name | Type | Description | Notes |
|
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
|
7
7
|
| **current_storefront_fs_directory_oid** | **Integer** | | [optional] |
|
|
8
|
+
| **directories** | [**Array<FileManagerDirectory>**](FileManagerDirectory.md) | | [optional] |
|
|
9
|
+
| **files** | [**Array<FileManagerFile>**](FileManagerFile.md) | | [optional] |
|
|
8
10
|
| **hostname** | **String** | | [optional] |
|
|
9
11
|
| **parent_storefront_fs_directory_oid** | **Integer** | | [optional] |
|
|
10
12
|
| **path** | **String** | | [optional] |
|
|
13
|
+
| **path_list** | [**Array<FileManagerDirectory>**](FileManagerDirectory.md) | | [optional] |
|
|
11
14
|
| **storefront_oid** | **Integer** | | [optional] |
|
|
12
15
|
|
|
13
16
|
## Example
|
|
@@ -17,9 +20,12 @@ require 'ultracart_api'
|
|
|
17
20
|
|
|
18
21
|
instance = UltracartClient::FileManagerPage.new(
|
|
19
22
|
current_storefront_fs_directory_oid: null,
|
|
23
|
+
directories: null,
|
|
24
|
+
files: null,
|
|
20
25
|
hostname: null,
|
|
21
26
|
parent_storefront_fs_directory_oid: null,
|
|
22
27
|
path: null,
|
|
28
|
+
path_list: null,
|
|
23
29
|
storefront_oid: null
|
|
24
30
|
)
|
|
25
31
|
```
|
|
@@ -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,6 +8,7 @@ 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 |
|
|
@@ -315,6 +316,77 @@ end
|
|
|
315
316
|
- **Accept**: application/json
|
|
316
317
|
|
|
317
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
|
+
|
|
318
390
|
## get_item
|
|
319
391
|
|
|
320
392
|
> <ItemResponse> get_item(merchant_item_oid, opts)
|
data/docs/ItemDigitalItem.md
CHANGED
|
@@ -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,
|