ultracart_api 4.0.66.rc → 4.0.68.rc

data/lib/ultracart_api/api/storefront_api.rb

@@ -726,6 +726,74 @@ module UltracartClient
       return data, status_code, headers
     end
 
+    # Create file manager directory
+    # @param id [Integer] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :name 
+    # @option opts [Integer] :parent_storefront_fs_directory_oid 
+    # @return [FileManagerPage]
+    def create_fs_directory(id, opts = {})
+      data, _status_code, _headers = create_fs_directory_with_http_info(id, opts)
+      data
+    end
+
+    # Create file manager directory
+    # @param id [Integer] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :name 
+    # @option opts [Integer] :parent_storefront_fs_directory_oid 
+    # @return [Array<(FileManagerPage, Integer, Hash)>] FileManagerPage data, response status code and response headers
+    def create_fs_directory_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: StorefrontApi.create_fs_directory ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling StorefrontApi.create_fs_directory"
+      end
+      # resource path
+      local_var_path = '/storefront/{id}/fs/dir'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'name'] = opts[:'name'] if !opts[:'name'].nil?
+      query_params[:'parent_storefront_fs_directory_oid'] = opts[:'parent_storefront_fs_directory_oid'] if !opts[:'parent_storefront_fs_directory_oid'].nil?
+
+      # header parameters
+      header_params = opts[: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'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'FileManagerPage'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"StorefrontApi.create_fs_directory",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: StorefrontApi#create_fs_directory\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Create Twilio account
     # @param twilio [Twilio] Twilio
     # @param [Hash] opts the optional parameters
@@ -1405,6 +1473,74 @@ module UltracartClient
       return data, status_code, headers
     end
 
+    # Delete file manager directory
+    # @param id [Integer] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :parent_storefront_fs_directory_oid 
+    # @option opts [Integer] :storefront_fs_file_oid 
+    # @return [FileManagerPage]
+    def delete_fs_file(id, opts = {})
+      data, _status_code, _headers = delete_fs_file_with_http_info(id, opts)
+      data
+    end
+
+    # Delete file manager directory
+    # @param id [Integer] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :parent_storefront_fs_directory_oid 
+    # @option opts [Integer] :storefront_fs_file_oid 
+    # @return [Array<(FileManagerPage, Integer, Hash)>] FileManagerPage data, response status code and response headers
+    def delete_fs_file_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: StorefrontApi.delete_fs_file ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling StorefrontApi.delete_fs_file"
+      end
+      # resource path
+      local_var_path = '/storefront/{id}/fs/file'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'parent_storefront_fs_directory_oid'] = opts[:'parent_storefront_fs_directory_oid'] if !opts[:'parent_storefront_fs_directory_oid'].nil?
+      query_params[:'storefront_fs_file_oid'] = opts[:'storefront_fs_file_oid'] if !opts[:'storefront_fs_file_oid'].nil?
+
+      # header parameters
+      header_params = opts[: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'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'FileManagerPage'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"StorefrontApi.delete_fs_file",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: StorefrontApi#delete_fs_file\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Delete screen recording heatmap
     # Delete screen recording heatmap 
     # @param storefront_oid [Integer] 
@@ -5857,6 +5993,77 @@ module UltracartClient
       return data, status_code, headers
     end
 
+    # Get file manager directory
+    # @param id [Integer] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :path 
+    # @option opts [Integer] :storefront_fs_directory_oid 
+    # @option opts [Integer] :storefront_theme_oid 
+    # @return [FileManagerPage]
+    def get_fs_directory(id, opts = {})
+      data, _status_code, _headers = get_fs_directory_with_http_info(id, opts)
+      data
+    end
+
+    # Get file manager directory
+    # @param id [Integer] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :path 
+    # @option opts [Integer] :storefront_fs_directory_oid 
+    # @option opts [Integer] :storefront_theme_oid 
+    # @return [Array<(FileManagerPage, Integer, Hash)>] FileManagerPage data, response status code and response headers
+    def get_fs_directory_with_http_info(id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: StorefrontApi.get_fs_directory ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling StorefrontApi.get_fs_directory"
+      end
+      # resource path
+      local_var_path = '/storefront/{id}/fs/dir'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'path'] = opts[:'path'] if !opts[:'path'].nil?
+      query_params[:'storefront_fs_directory_oid'] = opts[:'storefront_fs_directory_oid'] if !opts[:'storefront_fs_directory_oid'].nil?
+      query_params[:'storefront_theme_oid'] = opts[:'storefront_theme_oid'] if !opts[:'storefront_theme_oid'].nil?
+
+      # header parameters
+      header_params = opts[: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'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'FileManagerPage'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"StorefrontApi.get_fs_directory",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: StorefrontApi#get_fs_directory\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get screen recording heatmap
     # Get screen recording heatmap 
     # @param storefront_oid [Integer] 
@@ -7405,6 +7612,74 @@ module UltracartClient
       return data, status_code, headers
     end
 
+    # 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.
+    # @param id [Integer] 
+    # @param extension [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [FileManagerUploadUrlResponse]
+    def get_upload_fs_file_url(id, extension, opts = {})
+      data, _status_code, _headers = get_upload_fs_file_url_with_http_info(id, extension, opts)
+      data
+    end
+
+    # 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.
+    # @param id [Integer] 
+    # @param extension [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(FileManagerUploadUrlResponse, Integer, Hash)>] FileManagerUploadUrlResponse data, response status code and response headers
+    def get_upload_fs_file_url_with_http_info(id, extension, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: StorefrontApi.get_upload_fs_file_url ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling StorefrontApi.get_upload_fs_file_url"
+      end
+      # verify the required parameter 'extension' is set
+      if @api_client.config.client_side_validation && extension.nil?
+        fail ArgumentError, "Missing the required parameter 'extension' when calling StorefrontApi.get_upload_fs_file_url"
+      end
+      # resource path
+      local_var_path = '/storefront/{id}/fs/upload_url/{extension}'.sub('{' + 'id' + '}', CGI.escape(id.to_s)).sub('{' + 'extension' + '}', CGI.escape(extension.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[: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'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'FileManagerUploadUrlResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"StorefrontApi.get_upload_fs_file_url",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: StorefrontApi#get_upload_fs_file_url\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Globally unsubscribe a customer
     # @param storefront_oid [Integer] 
     # @param unsubscribe [EmailGlobalUnsubscribeRequest] Unsubscribe
@@ -11607,6 +11882,79 @@ module UltracartClient
       return data, status_code, headers
     end
 
+    # 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.
+    # @param id [Integer] 
+    # @param upload_request [FileManagerUploadRequest] UploadRequest
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def upload_fs_file(id, upload_request, opts = {})
+      upload_fs_file_with_http_info(id, upload_request, opts)
+      nil
+    end
+
+    # 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.
+    # @param id [Integer] 
+    # @param upload_request [FileManagerUploadRequest] UploadRequest
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def upload_fs_file_with_http_info(id, upload_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: StorefrontApi.upload_fs_file ...'
+      end
+      # verify the required parameter 'id' is set
+      if @api_client.config.client_side_validation && id.nil?
+        fail ArgumentError, "Missing the required parameter 'id' when calling StorefrontApi.upload_fs_file"
+      end
+      # verify the required parameter 'upload_request' is set
+      if @api_client.config.client_side_validation && upload_request.nil?
+        fail ArgumentError, "Missing the required parameter 'upload_request' when calling StorefrontApi.upload_fs_file"
+      end
+      # resource path
+      local_var_path = '/storefront/{id}/fs/upload'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[: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'
+      content_type = @api_client.select_header_content_type(['application/json'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(upload_request)
+
+      # return_type
+      return_type = opts[:debug_return_type]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
+
+      new_options = opts.merge(
+        :operation => :"StorefrontApi.upload_fs_file",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: StorefrontApi#upload_fs_file\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Validate AWS Event Ruler
     # @param ruler_validate_request [RulerValidationRequest] Ruler Validate Request
     # @param [Hash] opts the optional parameters