ultra_cart_rest_api_v2 3.10.50 → 3.10.51

package/README.md

@@ -5,7 +5,7 @@ UltraCart REST API Version 2
 This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
 
 - API version: 2.0.0
-- Package version: 3.10.50
+- Package version: 3.10.51
 - Build package: io.swagger.codegen.languages.JavascriptClientCodegen
 For more information, please visit [http://www.ultracart.com](http://www.ultracart.com)
 
@@ -237,6 +237,7 @@ Class | Method | HTTP request | Description
 *UltraCartRestApiV2.ItemApi* | [**deleteItem**](docs/ItemApi.md#deleteItem) | **DELETE** /item/items/{merchant_item_oid} | Delete an item
 *UltraCartRestApiV2.ItemApi* | [**getDigitalItem**](docs/ItemApi.md#getDigitalItem) | **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
 *UltraCartRestApiV2.ItemApi* | [**getDigitalItems**](docs/ItemApi.md#getDigitalItems) | **GET** /item/digital_library | Retrieve digital items from the digital library which are digital files that may be attached to normal items
+*UltraCartRestApiV2.ItemApi* | [**getDigitalItemsByExternalId**](docs/ItemApi.md#getDigitalItemsByExternalId) | **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
 *UltraCartRestApiV2.ItemApi* | [**getItem**](docs/ItemApi.md#getItem) | **GET** /item/items/{merchant_item_oid} | Retrieve an item
 *UltraCartRestApiV2.ItemApi* | [**getItemByMerchantItemId**](docs/ItemApi.md#getItemByMerchantItemId) | **GET** /item/items/merchant_item_id/{merchant_item_id} | Retrieve an item by item id
 *UltraCartRestApiV2.ItemApi* | [**getItems**](docs/ItemApi.md#getItems) | **GET** /item/items | Retrieve items
@@ -285,12 +286,10 @@ Class | Method | HTTP request | Description
 *UltraCartRestApiV2.StorefrontApi* | [**checkDownloadEmailSegment**](docs/StorefrontApi.md#checkDownloadEmailSegment) | **POST** /storefront/{storefront_oid}/email/segments/{email_segment_uuid}/downloadPrepare/{email_segment_rebuild_uuid} | Check download of email segment
 *UltraCartRestApiV2.StorefrontApi* | [**cloneEmailCampaign**](docs/StorefrontApi.md#cloneEmailCampaign) | **POST** /storefront/{storefront_oid}/email/campaigns/{email_campaign_uuid}/clone | Clone email campaign
 *UltraCartRestApiV2.StorefrontApi* | [**cloneEmailFlow**](docs/StorefrontApi.md#cloneEmailFlow) | **POST** /storefront/{storefront_oid}/email/flows/{email_flow_uuid}/clone | Clone email flow
-*UltraCartRestApiV2.StorefrontApi* | [**createAdminPanelFsDirectory**](docs/StorefrontApi.md#createAdminPanelFsDirectory) | **POST** /storefront/{id}/adminPanel/fs/dir | Create file manager directory for admin panel
-*UltraCartRestApiV2.StorefrontApi* | [**createAdminPanelFsFileUpload**](docs/StorefrontApi.md#createAdminPanelFsFileUpload) | **POST** /storefront/{id}/adminPanel/fs/file | Upload file manager file for admin panel
 *UltraCartRestApiV2.StorefrontApi* | [**createEmailSendingDomain**](docs/StorefrontApi.md#createEmailSendingDomain) | **POST** /storefront/email/sending_domains/{domain}/create | Create email campaign
 *UltraCartRestApiV2.StorefrontApi* | [**createEmailSendingDomain2**](docs/StorefrontApi.md#createEmailSendingDomain2) | **POST** /storefront/email/sending_domains | Create email sending domain for various providers
+*UltraCartRestApiV2.StorefrontApi* | [**createFsDirectory**](docs/StorefrontApi.md#createFsDirectory) | **POST** /storefront/{id}/fs/dir | Create file manager directory
 *UltraCartRestApiV2.StorefrontApi* | [**createTwilioAccount**](docs/StorefrontApi.md#createTwilioAccount) | **POST** /storefront/twilio/accounts | Create Twilio account
-*UltraCartRestApiV2.StorefrontApi* | [**deleteAdminPanelFsFile**](docs/StorefrontApi.md#deleteAdminPanelFsFile) | **DELETE** /storefront/{id}/adminPanel/fs/file | Delete file manager directory for admin panel
 *UltraCartRestApiV2.StorefrontApi* | [**deleteEmailCampaignFolder**](docs/StorefrontApi.md#deleteEmailCampaignFolder) | **DELETE** /storefront/{storefront_oid}/email/campaign_folders/{email_campaign_folder_uuid} | Delete email campaignFolder
 *UltraCartRestApiV2.StorefrontApi* | [**deleteEmailCommseqStat**](docs/StorefrontApi.md#deleteEmailCommseqStat) | **DELETE** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/stat | Delete communication sequence stats
 *UltraCartRestApiV2.StorefrontApi* | [**deleteEmailEmail**](docs/StorefrontApi.md#deleteEmailEmail) | **DELETE** /storefront/{storefront_oid}/email/emails/{commseq_email_uuid} | Delete email email
@@ -300,6 +299,7 @@ Class | Method | HTTP request | Description
 *UltraCartRestApiV2.StorefrontApi* | [**deleteEmailPostcard**](docs/StorefrontApi.md#deleteEmailPostcard) | **DELETE** /storefront/{storefront_oid}/email/postcards/{commseq_postcard_uuid} | Delete email postcard
 *UltraCartRestApiV2.StorefrontApi* | [**deleteEmailSendingDomain**](docs/StorefrontApi.md#deleteEmailSendingDomain) | **DELETE** /storefront/email/sending_domains/{domain} | delete email campaign
 *UltraCartRestApiV2.StorefrontApi* | [**deleteExperiment**](docs/StorefrontApi.md#deleteExperiment) | **DELETE** /storefront/{storefront_oid}/experiments/{storefront_experiment_oid} | Delete experiment
+*UltraCartRestApiV2.StorefrontApi* | [**deleteFsFile**](docs/StorefrontApi.md#deleteFsFile) | **DELETE** /storefront/{id}/fs/file | Delete file manager directory
 *UltraCartRestApiV2.StorefrontApi* | [**deleteHeatmap**](docs/StorefrontApi.md#deleteHeatmap) | **DELETE** /storefront/{storefront_oid}/screen_recordings/heatmap | Delete screen recording heatmap
 *UltraCartRestApiV2.StorefrontApi* | [**deleteLibraryItem**](docs/StorefrontApi.md#deleteLibraryItem) | **DELETE** /storefront/code_library/{library_item_oid} | Delete library item
 *UltraCartRestApiV2.StorefrontApi* | [**deleteLibraryItemPublishedVersions**](docs/StorefrontApi.md#deleteLibraryItemPublishedVersions) | **DELETE** /storefront/code_library/{library_item_oid}/published_versions | Delete all published versions for a library item, including anything in review.
@@ -308,7 +308,6 @@ Class | Method | HTTP request | Description
 *UltraCartRestApiV2.StorefrontApi* | [**duplicateLibraryItem**](docs/StorefrontApi.md#duplicateLibraryItem) | **POST** /storefront/code_library/{library_item_oid}/duplicate | Duplicate library item.
 *UltraCartRestApiV2.StorefrontApi* | [**favoriteScreenRecording**](docs/StorefrontApi.md#favoriteScreenRecording) | **POST** /storefront/{storefront_oid}/screen_recordings/{screen_recording_uuid}/favorite | Update favorite flag on screen recording
 *UltraCartRestApiV2.StorefrontApi* | [**geocodeAddress**](docs/StorefrontApi.md#geocodeAddress) | **POST** /storefront/{storefront_oid}/email/geocode | Obtain lat/long for an address
-*UltraCartRestApiV2.StorefrontApi* | [**getAdminPanelFsDirectory**](docs/StorefrontApi.md#getAdminPanelFsDirectory) | **GET** /storefront/{id}/adminPanel/fs/dir | Get file manager directory for admin panel
 *UltraCartRestApiV2.StorefrontApi* | [**getCountries**](docs/StorefrontApi.md#getCountries) | **GET** /storefront/{storefront_oid}/email/countries | Get countries
 *UltraCartRestApiV2.StorefrontApi* | [**getEditorToken**](docs/StorefrontApi.md#getEditorToken) | **GET** /storefront/{storefront_oid}/editor_token | Gets editor token
 *UltraCartRestApiV2.StorefrontApi* | [**getEmailBaseTemplates**](docs/StorefrontApi.md#getEmailBaseTemplates) | **GET** /storefront/{storefront_oid}/email/baseTemplates | Get email communication base templates
@@ -367,6 +366,7 @@ Class | Method | HTTP request | Description
 *UltraCartRestApiV2.StorefrontApi* | [**getEmailTemplates**](docs/StorefrontApi.md#getEmailTemplates) | **GET** /storefront/{storefront_oid}/email/templates | Get email templates
 *UltraCartRestApiV2.StorefrontApi* | [**getEmailThirdPartyProviders**](docs/StorefrontApi.md#getEmailThirdPartyProviders) | **GET** /storefront/{storefront_oid}/email/third_party_providers | Get a list of third party email providers
 *UltraCartRestApiV2.StorefrontApi* | [**getExperiments**](docs/StorefrontApi.md#getExperiments) | **GET** /storefront/{storefront_oid}/experiments | Get experiments
+*UltraCartRestApiV2.StorefrontApi* | [**getFsDirectory**](docs/StorefrontApi.md#getFsDirectory) | **GET** /storefront/{id}/fs/dir | Get file manager directory
 *UltraCartRestApiV2.StorefrontApi* | [**getHeatmap**](docs/StorefrontApi.md#getHeatmap) | **POST** /storefront/{storefront_oid}/screen_recordings/heatmap | Get screen recording heatmap
 *UltraCartRestApiV2.StorefrontApi* | [**getHeatmapIndex**](docs/StorefrontApi.md#getHeatmapIndex) | **POST** /storefront/{storefront_oid}/screen_recordings/heatmap/index | Get screen recording heatmap index
 *UltraCartRestApiV2.StorefrontApi* | [**getHistogramPropertyNames**](docs/StorefrontApi.md#getHistogramPropertyNames) | **GET** /storefront/{storefront_oid}/email/histogram/property_names | Get histogram property names
@@ -390,6 +390,7 @@ Class | Method | HTTP request | Description
 *UltraCartRestApiV2.StorefrontApi* | [**getTransactionEmailScreenshots**](docs/StorefrontApi.md#getTransactionEmailScreenshots) | **GET** /storefront/{storefront_oid}/transaction_email/list/{email_id}/screenshots | Get transactional email screenshots
 *UltraCartRestApiV2.StorefrontApi* | [**getTwilioAccount**](docs/StorefrontApi.md#getTwilioAccount) | **GET** /storefront/twilio/accounts/{esp_twilio_uuid} | Get Twilio account
 *UltraCartRestApiV2.StorefrontApi* | [**getTwilioAccounts**](docs/StorefrontApi.md#getTwilioAccounts) | **GET** /storefront/twilio/accounts | Get all Twilio accounts
+*UltraCartRestApiV2.StorefrontApi* | [**getUploadFsFileUrl**](docs/StorefrontApi.md#getUploadFsFileUrl) | **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.
 *UltraCartRestApiV2.StorefrontApi* | [**globalUnsubscribe**](docs/StorefrontApi.md#globalUnsubscribe) | **POST** /storefront/{storefront_oid}/email/globalUnsubscribe | Globally unsubscribe a customer
 *UltraCartRestApiV2.StorefrontApi* | [**importEmailThirdPartyProviderList**](docs/StorefrontApi.md#importEmailThirdPartyProviderList) | **POST** /storefront/{storefront_oid}/email/third_party_providers/import | Import a third party provider list
 *UltraCartRestApiV2.StorefrontApi* | [**insertEmailCampaign**](docs/StorefrontApi.md#insertEmailCampaign) | **POST** /storefront/{storefront_oid}/email/campaigns | Insert email campaign
@@ -446,6 +447,7 @@ Class | Method | HTTP request | Description
 *UltraCartRestApiV2.StorefrontApi* | [**updateScreenRecordingTags**](docs/StorefrontApi.md#updateScreenRecordingTags) | **POST** /storefront/{storefront_oid}/screen_recordings/{screen_recording_uuid}/tags | Update tags on a screen recording
 *UltraCartRestApiV2.StorefrontApi* | [**updateTransactionEmail**](docs/StorefrontApi.md#updateTransactionEmail) | **PUT** /storefront/{storefront_oid}/transaction_email/list/{email_id} | Updates a transaction email object
 *UltraCartRestApiV2.StorefrontApi* | [**updateTwilioAccount**](docs/StorefrontApi.md#updateTwilioAccount) | **PUT** /storefront/twilio/accounts/{esp_twilio_uuid} | Update Twilio account
+*UltraCartRestApiV2.StorefrontApi* | [**uploadFsFile**](docs/StorefrontApi.md#uploadFsFile) | **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.
 *UltraCartRestApiV2.StorefrontApi* | [**validateRuler**](docs/StorefrontApi.md#validateRuler) | **POST** /storefront/ruler/validate | Validate AWS Event Ruler
 *UltraCartRestApiV2.TaxApi* | [**deleteTaxProviderSelfCity**](docs/TaxApi.md#deleteTaxProviderSelfCity) | **DELETE** /tax/providers/self/city/{city} | Deletes a Self tax provider city
 *UltraCartRestApiV2.TaxApi* | [**deleteTaxProviderSelfCountry**](docs/TaxApi.md#deleteTaxProviderSelfCountry) | **DELETE** /tax/providers/self/country/{countryCode} | Deletes a Self tax provider country
@@ -860,7 +862,11 @@ Class | Method | HTTP request | Description
  - [UltraCartRestApiV2.ExperimentVariation](docs/ExperimentVariation.md)
  - [UltraCartRestApiV2.ExperimentVariationStat](docs/ExperimentVariationStat.md)
  - [UltraCartRestApiV2.ExperimentsResponse](docs/ExperimentsResponse.md)
+ - [UltraCartRestApiV2.FileManagerDirectory](docs/FileManagerDirectory.md)
+ - [UltraCartRestApiV2.FileManagerFile](docs/FileManagerFile.md)
  - [UltraCartRestApiV2.FileManagerPage](docs/FileManagerPage.md)
+ - [UltraCartRestApiV2.FileManagerUploadRequest](docs/FileManagerUploadRequest.md)
+ - [UltraCartRestApiV2.FileManagerUploadUrlResponse](docs/FileManagerUploadUrlResponse.md)
  - [UltraCartRestApiV2.FulfillmentInventory](docs/FulfillmentInventory.md)
  - [UltraCartRestApiV2.FulfillmentShipment](docs/FulfillmentShipment.md)
  - [UltraCartRestApiV2.GeoPoint](docs/GeoPoint.md)
@@ -1242,6 +1248,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 3.10.51 | 09/29/2022 | storefront methods for file manager ui |
 | 3.10.50 | 09/27/2022 | added digital library call for unassociated content |
 | 3.10.49 | 09/22/2022 | digital item mgmt testing |
 | 3.10.48 | 09/22/2022 | testing digital file mgmt calls |

package/docs/FileManagerDirectory.md

@@ -0,0 +1,20 @@
+# UltraCartRestApiV2.FileManagerDirectory
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**active_theme_directory** | **Boolean** |  | [optional] 
+**favorite** | **Boolean** |  | [optional] 
+**hostname** | **String** |  | [optional] 
+**icon** | **String** |  | [optional] 
+**last_modified** | **String** |  | [optional] 
+**name** | **String** |  | [optional] 
+**parent_storefront_fs_directory_oid** | **Number** |  | [optional] 
+**part_of_active_theme** | **Boolean** |  | [optional] 
+**selected** | **Boolean** |  | [optional] 
+**storefront_fs_directory_oid** | **Number** |  | [optional] 
+**storefront_fs_file_oid** | **Number** |  | [optional] 
+**storefront_oid** | **Number** |  | [optional] 
+**type** | **String** |  | [optional] 
+
+

package/docs/FileManagerFile.md

@@ -0,0 +1,26 @@
+# UltraCartRestApiV2.FileManagerFile
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**favorite** | **Boolean** |  | [optional] 
+**hostname** | **String** |  | [optional] 
+**i18n_violation** | **Boolean** |  | [optional] 
+**icon** | **String** |  | [optional] 
+**internal_version** | **Number** |  | [optional] 
+**last_modified** | **String** |  | [optional] 
+**merge_conflict** | **Boolean** |  | [optional] 
+**name** | **String** |  | [optional] 
+**parent_storefront_fs_directory_oid** | **Number** |  | [optional] 
+**part_of_active_theme** | **Boolean** |  | [optional] 
+**path** | **String** |  | [optional] 
+**raw_size** | **Number** |  | [optional] 
+**selected** | **Boolean** |  | [optional] 
+**size** | **String** |  | [optional] 
+**storefront_fs_directory_oid** | **Number** |  | [optional] 
+**storefront_fs_file_oid** | **Number** |  | [optional] 
+**storefront_oid** | **Number** |  | [optional] 
+**type** | **String** |  | [optional] 
+**valid_velocity** | **String** |  | [optional] 
+
+

package/docs/FileManagerPage.md

@@ -4,9 +4,12 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **current_storefront_fs_directory_oid** | **Number** |  | [optional] 
+**directories** | [**[FileManagerDirectory]**](FileManagerDirectory.md) |  | [optional] 
+**files** | [**[FileManagerFile]**](FileManagerFile.md) |  | [optional] 
 **hostname** | **String** |  | [optional] 
 **parent_storefront_fs_directory_oid** | **Number** |  | [optional] 
 **path** | **String** |  | [optional] 
+**path_list** | [**[FileManagerDirectory]**](FileManagerDirectory.md) |  | [optional] 
 **storefront_oid** | **Number** |  | [optional] 
 
 

package/docs/FileManagerUploadRequest.md

@@ -0,0 +1,10 @@
+# UltraCartRestApiV2.FileManagerUploadRequest
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**filename** | **String** |  | [optional] 
+**key** | **String** |  | [optional] 
+**parent_storefront_fs_directory_oid** | **Number** |  | [optional] 
+
+

package/docs/FileManagerUploadUrlResponse.md

@@ -0,0 +1,12 @@
+# UltraCartRestApiV2.FileManagerUploadUrlResponse
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**error** | [**Error**](Error.md) |  | [optional] 
+**key** | **String** |  | [optional] 
+**metadata** | [**ResponseMetadata**](ResponseMetadata.md) |  | [optional] 
+**success** | **Boolean** | Indicates if API call was successful | [optional] 
+**warning** | [**Warning**](Warning.md) |  | [optional] 
+
+

package/docs/ItemApi.md

@@ -8,6 +8,7 @@ Method | HTTP request | Description
 [**deleteItem**](ItemApi.md#deleteItem) | **DELETE** /item/items/{merchant_item_oid} | Delete an item
 [**getDigitalItem**](ItemApi.md#getDigitalItem) | **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
 [**getDigitalItems**](ItemApi.md#getDigitalItems) | **GET** /item/digital_library | Retrieve digital items from the digital library which are digital files that may be attached to normal items
+[**getDigitalItemsByExternalId**](ItemApi.md#getDigitalItemsByExternalId) | **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
 [**getItem**](ItemApi.md#getItem) | **GET** /item/items/{merchant_item_oid} | Retrieve an item
 [**getItemByMerchantItemId**](ItemApi.md#getItemByMerchantItemId) | **GET** /item/items/merchant_item_id/{merchant_item_id} | Retrieve an item by item id
 [**getItems**](ItemApi.md#getItems) | **GET** /item/items | Retrieve items
@@ -227,6 +228,56 @@ Name | Type | Description  | Notes
 
 [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
 
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+<a name="getDigitalItemsByExternalId"></a>
+# **getDigitalItemsByExternalId**
+> ItemDigitalItemsResponse getDigitalItemsByExternalId(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
+
+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. 
+
+### Example
+```javascript
+var UltraCartRestApiV2 = require('ultra_cart_rest_api_v2');
+
+// Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
+var simpleKey = "109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00";
+UltraCartRestApiV2.ApiClient.usingApiKey(simpleKey, false)
+var apiInstance = new UltraCartRestApiV2.ItemApi();
+
+
+var external_id = "external_id_example"; // String | The external id to match against.
+
+
+var callback = function(error, data, response) {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully. Returned data: ' + data);
+  }
+};
+apiInstance.getDigitalItemsByExternalId(external_id, callback);
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **external_id** | **String**| The external id to match against. | 
+
+### Return type
+
+[**ItemDigitalItemsResponse**](ItemDigitalItemsResponse.md)
+
+### Authorization
+
+[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
 ### HTTP request headers
 
  - **Content-Type**: application/json

package/docs/ItemDigitalItem.md

@@ -7,6 +7,7 @@ Name | Type | Description | Notes
 **creation_dts** | **String** | File creation date | [optional] 
 **description** | **String** | Description of the digital item | [optional] 
 **digital_item_oid** | **Number** | 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] 
+**external_id** | **String** | External Id useful for syncing with a remote filesystem, this may be an MD5 hash or whatever suits your needs. | [optional] 
 **file_size** | **Number** | File size | [optional] 
 **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] 
 **mime_type** | **String** | Mime type associated with the file | [optional]