ultracart_api 3.10.49 → 3.10.51

data/docs/StorefrontApi.md

@@ -14,6 +14,7 @@ Method | HTTP request | Description
 [**clone_email_flow**](StorefrontApi.md#clone_email_flow) | **POST** /storefront/{storefront_oid}/email/flows/{email_flow_uuid}/clone | Clone email flow
 [**create_email_sending_domain**](StorefrontApi.md#create_email_sending_domain) | **POST** /storefront/email/sending_domains/{domain}/create | Create email campaign
 [**create_email_sending_domain2**](StorefrontApi.md#create_email_sending_domain2) | **POST** /storefront/email/sending_domains | Create email sending domain for various providers
+[**create_fs_directory**](StorefrontApi.md#create_fs_directory) | **POST** /storefront/{id}/fs/dir | Create file manager directory
 [**create_twilio_account**](StorefrontApi.md#create_twilio_account) | **POST** /storefront/twilio/accounts | Create Twilio account
 [**delete_email_campaign_folder**](StorefrontApi.md#delete_email_campaign_folder) | **DELETE** /storefront/{storefront_oid}/email/campaign_folders/{email_campaign_folder_uuid} | Delete email campaignFolder
 [**delete_email_commseq_stat**](StorefrontApi.md#delete_email_commseq_stat) | **DELETE** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/stat | Delete communication sequence stats
@@ -24,6 +25,7 @@ Method | HTTP request | Description
 [**delete_email_postcard**](StorefrontApi.md#delete_email_postcard) | **DELETE** /storefront/{storefront_oid}/email/postcards/{commseq_postcard_uuid} | Delete email postcard
 [**delete_email_sending_domain**](StorefrontApi.md#delete_email_sending_domain) | **DELETE** /storefront/email/sending_domains/{domain} | delete email campaign
 [**delete_experiment**](StorefrontApi.md#delete_experiment) | **DELETE** /storefront/{storefront_oid}/experiments/{storefront_experiment_oid} | Delete experiment
+[**delete_fs_file**](StorefrontApi.md#delete_fs_file) | **DELETE** /storefront/{id}/fs/file | Delete file manager directory
 [**delete_heatmap**](StorefrontApi.md#delete_heatmap) | **DELETE** /storefront/{storefront_oid}/screen_recordings/heatmap | Delete screen recording heatmap
 [**delete_library_item**](StorefrontApi.md#delete_library_item) | **DELETE** /storefront/code_library/{library_item_oid} | Delete library item
 [**delete_library_item_published_versions**](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.
@@ -90,6 +92,7 @@ Method | HTTP request | Description
 [**get_email_templates**](StorefrontApi.md#get_email_templates) | **GET** /storefront/{storefront_oid}/email/templates | Get email templates
 [**get_email_third_party_providers**](StorefrontApi.md#get_email_third_party_providers) | **GET** /storefront/{storefront_oid}/email/third_party_providers | Get a list of third party email providers
 [**get_experiments**](StorefrontApi.md#get_experiments) | **GET** /storefront/{storefront_oid}/experiments | Get experiments
+[**get_fs_directory**](StorefrontApi.md#get_fs_directory) | **GET** /storefront/{id}/fs/dir | Get file manager directory
 [**get_heatmap**](StorefrontApi.md#get_heatmap) | **POST** /storefront/{storefront_oid}/screen_recordings/heatmap | Get screen recording heatmap
 [**get_heatmap_index**](StorefrontApi.md#get_heatmap_index) | **POST** /storefront/{storefront_oid}/screen_recordings/heatmap/index | Get screen recording heatmap index
 [**get_histogram_property_names**](StorefrontApi.md#get_histogram_property_names) | **GET** /storefront/{storefront_oid}/email/histogram/property_names | Get histogram property names
@@ -113,6 +116,7 @@ Method | HTTP request | Description
 [**get_transaction_email_screenshots**](StorefrontApi.md#get_transaction_email_screenshots) | **GET** /storefront/{storefront_oid}/transaction_email/list/{email_id}/screenshots | Get transactional email screenshots
 [**get_twilio_account**](StorefrontApi.md#get_twilio_account) | **GET** /storefront/twilio/accounts/{esp_twilio_uuid} | Get Twilio account
 [**get_twilio_accounts**](StorefrontApi.md#get_twilio_accounts) | **GET** /storefront/twilio/accounts | Get all Twilio accounts
+[**get_upload_fs_file_url**](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.
 [**global_unsubscribe**](StorefrontApi.md#global_unsubscribe) | **POST** /storefront/{storefront_oid}/email/globalUnsubscribe | Globally unsubscribe a customer
 [**import_email_third_party_provider_list**](StorefrontApi.md#import_email_third_party_provider_list) | **POST** /storefront/{storefront_oid}/email/third_party_providers/import | Import a third party provider list
 [**insert_email_campaign**](StorefrontApi.md#insert_email_campaign) | **POST** /storefront/{storefront_oid}/email/campaigns | Insert email campaign
@@ -169,6 +173,7 @@ Method | HTTP request | Description
 [**update_screen_recording_tags**](StorefrontApi.md#update_screen_recording_tags) | **POST** /storefront/{storefront_oid}/screen_recordings/{screen_recording_uuid}/tags | Update tags on a screen recording
 [**update_transaction_email**](StorefrontApi.md#update_transaction_email) | **PUT** /storefront/{storefront_oid}/transaction_email/list/{email_id} | Updates a transaction email object
 [**update_twilio_account**](StorefrontApi.md#update_twilio_account) | **PUT** /storefront/twilio/accounts/{esp_twilio_uuid} | Update Twilio account
+[**upload_fs_file**](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.
 [**validate_ruler**](StorefrontApi.md#validate_ruler) | **POST** /storefront/ruler/validate | Validate AWS Event Ruler
 
 
@@ -684,6 +689,60 @@ Name | Type | Description  | Notes
 
 
 
+# **create_fs_directory**
+> FileManagerPage create_fs_directory(id, opts)
+
+Create file manager directory
+
+### Example
+```ruby
+# load the gem
+require 'ultracart_api'
+
+# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
+simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
+api_instance = UltracartClient::StorefrontApi.new_using_api_key(simple_key, false, false)
+
+
+id = 56 # Integer | 
+
+opts = { 
+  name: 'name_example', # String | 
+  parent_storefront_fs_directory_oid: 56 # Integer | 
+}
+
+begin
+  #Create file manager directory
+  result = api_instance.create_fs_directory(id, opts)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling StorefrontApi->create_fs_directory: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Integer**|  | 
+ **name** | **String**|  | [optional] 
+ **parent_storefront_fs_directory_oid** | **Integer**|  | [optional] 
+
+### Return type
+
+[**FileManagerPage**](FileManagerPage.md)
+
+### Authorization
+
+[ultraCartBrowserApiKey](../README.md#ultraCartBrowserApiKey), [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 # **create_twilio_account**
 > TwilioResponse create_twilio_account(twilio)
 
@@ -1189,6 +1248,60 @@ nil (empty response body)
 
 
 
+# **delete_fs_file**
+> FileManagerPage delete_fs_file(id, opts)
+
+Delete file manager directory
+
+### Example
+```ruby
+# load the gem
+require 'ultracart_api'
+
+# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
+simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
+api_instance = UltracartClient::StorefrontApi.new_using_api_key(simple_key, false, false)
+
+
+id = 56 # Integer | 
+
+opts = { 
+  parent_storefront_fs_directory_oid: 56, # Integer | 
+  storefront_fs_file_oid: 56 # Integer | 
+}
+
+begin
+  #Delete file manager directory
+  result = api_instance.delete_fs_file(id, opts)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling StorefrontApi->delete_fs_file: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Integer**|  | 
+ **parent_storefront_fs_directory_oid** | **Integer**|  | [optional] 
+ **storefront_fs_file_oid** | **Integer**|  | [optional] 
+
+### Return type
+
+[**FileManagerPage**](FileManagerPage.md)
+
+### Authorization
+
+[ultraCartBrowserApiKey](../README.md#ultraCartBrowserApiKey), [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 # **delete_heatmap**
 > delete_heatmap(storefront_oid, query)
 
@@ -4534,6 +4647,62 @@ Name | Type | Description  | Notes
 
 
 
+# **get_fs_directory**
+> FileManagerPage get_fs_directory(id, opts)
+
+Get file manager directory
+
+### Example
+```ruby
+# load the gem
+require 'ultracart_api'
+
+# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
+simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
+api_instance = UltracartClient::StorefrontApi.new_using_api_key(simple_key, false, false)
+
+
+id = 56 # Integer | 
+
+opts = { 
+  path: 'path_example', # String | 
+  storefront_fs_directory_oid: 56, # Integer | 
+  storefront_theme_oid: 56 # Integer | 
+}
+
+begin
+  #Get file manager directory
+  result = api_instance.get_fs_directory(id, opts)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling StorefrontApi->get_fs_directory: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Integer**|  | 
+ **path** | **String**|  | [optional] 
+ **storefront_fs_directory_oid** | **Integer**|  | [optional] 
+ **storefront_theme_oid** | **Integer**|  | [optional] 
+
+### Return type
+
+[**FileManagerPage**](FileManagerPage.md)
+
+### Authorization
+
+[ultraCartBrowserApiKey](../README.md#ultraCartBrowserApiKey), [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 # **get_heatmap**
 > ScreenRecordingHeatmapResponse get_heatmap(storefront_oid, query)
 
@@ -5714,6 +5883,57 @@ This endpoint does not need any parameter.
 
 
 
+# **get_upload_fs_file_url**
+> FileManagerUploadUrlResponse get_upload_fs_file_url(id, 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.
+
+### Example
+```ruby
+# load the gem
+require 'ultracart_api'
+
+# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
+simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
+api_instance = UltracartClient::StorefrontApi.new_using_api_key(simple_key, false, false)
+
+
+id = 56 # Integer | 
+
+extension = 'extension_example' # String | 
+
+
+begin
+  #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.
+  result = api_instance.get_upload_fs_file_url(id, extension)
+  p result
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling StorefrontApi->get_upload_fs_file_url: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Integer**|  | 
+ **extension** | **String**|  | 
+
+### Return type
+
+[**FileManagerUploadUrlResponse**](FileManagerUploadUrlResponse.md)
+
+### Authorization
+
+[ultraCartBrowserApiKey](../README.md#ultraCartBrowserApiKey), [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 # **global_unsubscribe**
 > EmailGlobalUnsubscribeResponse global_unsubscribe(storefront_oid, unsubscribe)
 
@@ -8675,6 +8895,56 @@ Name | Type | Description  | Notes
 
 
 
+# **upload_fs_file**
+> upload_fs_file(id, upload_request)
+
+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.
+
+### Example
+```ruby
+# load the gem
+require 'ultracart_api'
+
+# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
+simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
+api_instance = UltracartClient::StorefrontApi.new_using_api_key(simple_key, false, false)
+
+
+id = 56 # Integer | 
+
+upload_request = UltracartClient::FileManagerUploadRequest.new # FileManagerUploadRequest | UploadRequest
+
+
+begin
+  #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.
+  api_instance.upload_fs_file(id, upload_request)
+rescue UltracartClient::ApiError => e
+  puts "Exception when calling StorefrontApi->upload_fs_file: #{e}"
+end
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **id** | **Integer**|  | 
+ **upload_request** | [**FileManagerUploadRequest**](FileManagerUploadRequest.md)| UploadRequest | 
+
+### Return type
+
+nil (empty response body)
+
+### Authorization
+
+[ultraCartBrowserApiKey](../README.md#ultraCartBrowserApiKey), [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+
 # **validate_ruler**
 > RulerValidationResponse validate_ruler(ruler_validate_request)
 

data/lib/ultracart_api/api/item_api.rb

@@ -262,6 +262,61 @@ module UltracartClient
       end
       return data, status_code, headers
     end
+    # 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. 
+    # @param external_id The external id to match against.
+    # @param [Hash] opts the optional parameters
+    # @return [ItemDigitalItemsResponse]
+    def get_digital_items_by_external_id(external_id, opts = {})
+      data, _status_code, _headers = get_digital_items_by_external_id_with_http_info(external_id, opts)
+      data
+    end
+
+    # 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. 
+    # @param external_id The external id to match against.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(ItemDigitalItemsResponse, Fixnum, Hash)>] ItemDigitalItemsResponse data, response status code and response headers
+    def get_digital_items_by_external_id_with_http_info(external_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ItemApi.get_digital_items_by_external_id ...'
+      end
+      # verify the required parameter 'external_id' is set
+      if @api_client.config.client_side_validation && external_id.nil?
+        fail ArgumentError, "Missing the required parameter 'external_id' when calling ItemApi.get_digital_items_by_external_id"
+      end
+      # resource path
+      local_var_path = '/item/digital_library/by_external/{external_id}'.sub('{' + 'external_id' + '}', external_id.to_s)
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'ItemDigitalItemsResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ItemApi#get_digital_items_by_external_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # Retrieve an item
     # Retrieves a single item using the specified item oid. 
     # @param merchant_item_oid The item oid to retrieve.
@@ -509,6 +564,73 @@ module UltracartClient
       end
       return data, status_code, headers
     end
+    # Retrieve digital items from the digital library (which are digital files that may be attached to normal items) not yet associated with actual items
+    # 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. 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :_limit The maximum number of records to return on this one API call. (Default 100, Max 2000) (default to 100)
+    # @option opts [Integer] :_offset Pagination of the record set.  Offset is a zero based index. (default to 0)
+    # @option opts [String] :_since Fetch items that have been created/modified since this date/time.
+    # @option opts [String] :_sort The sort order of the items.  See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
+    # @option opts [String] :_expand The object expansion to perform on the result.  See documentation for examples
+    # @option opts [BOOLEAN] :_placeholders Whether or not placeholder values should be returned in the result.  Useful for UIs that consume this REST API.
+    # @return [ItemDigitalItemsResponse]
+    def get_unassociated_digital_items(opts = {})
+      data, _status_code, _headers = get_unassociated_digital_items_with_http_info(opts)
+      data
+    end
+
+    # Retrieve digital items from the digital library (which are digital files that may be attached to normal items) not yet associated with actual items
+    # 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. 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :_limit The maximum number of records to return on this one API call. (Default 100, Max 2000)
+    # @option opts [Integer] :_offset Pagination of the record set.  Offset is a zero based index.
+    # @option opts [String] :_since Fetch items that have been created/modified since this date/time.
+    # @option opts [String] :_sort The sort order of the items.  See Sorting documentation for examples of using multiple values and sorting by ascending and descending.
+    # @option opts [String] :_expand The object expansion to perform on the result.  See documentation for examples
+    # @option opts [BOOLEAN] :_placeholders Whether or not placeholder values should be returned in the result.  Useful for UIs that consume this REST API.
+    # @return [Array<(ItemDigitalItemsResponse, Fixnum, Hash)>] ItemDigitalItemsResponse data, response status code and response headers
+    def get_unassociated_digital_items_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: ItemApi.get_unassociated_digital_items ...'
+      end
+      # resource path
+      local_var_path = '/item/digital_library/unassociated'
+
+      # query parameters
+      query_params = {}
+      query_params[:'_limit'] = opts[:'_limit'] if !opts[:'_limit'].nil?
+      query_params[:'_offset'] = opts[:'_offset'] if !opts[:'_offset'].nil?
+      query_params[:'_since'] = opts[:'_since'] if !opts[:'_since'].nil?
+      query_params[:'_sort'] = opts[:'_sort'] if !opts[:'_sort'].nil?
+      query_params[:'_expand'] = opts[:'_expand'] if !opts[:'_expand'].nil?
+      query_params[:'_placeholders'] = opts[:'_placeholders'] if !opts[:'_placeholders'].nil?
+
+      # header parameters
+      header_params = {}
+      header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = nil
+      auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'ItemDigitalItemsResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: ItemApi#get_unassociated_digital_items\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
     # Create a file within the digital library
     # Create a file within the digital library.  This does not create an item, but makes this digital file available and selectable as part (or all) of an item. 
     # @param digital_item Digital item to create