ultracart_api 3.10.49 → 3.10.51

data/lib/ultracart_api/api/storefront_api.rb

@@ -616,6 +616,65 @@ module UltracartClient
       end
       return data, status_code, headers
     end
+    # Create file manager directory
+    # @param id 
+    # @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 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :name 
+    # @option opts [Integer] :parent_storefront_fs_directory_oid 
+    # @return [Array<(FileManagerPage, Fixnum, 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' + '}', id.to_s)
+
+      # query parameters
+      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 = {}
+      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 = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'FileManagerPage')
+      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
     # @param [Hash] opts the optional parameters
@@ -1198,6 +1257,65 @@ module UltracartClient
       end
       return data, status_code, headers
     end
+    # Delete file manager directory
+    # @param id 
+    # @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 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Integer] :parent_storefront_fs_directory_oid 
+    # @option opts [Integer] :storefront_fs_file_oid 
+    # @return [Array<(FileManagerPage, Fixnum, 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' + '}', id.to_s)
+
+      # query parameters
+      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 = {}
+      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 = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
+      data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'FileManagerPage')
+      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 
@@ -5011,6 +5129,68 @@ module UltracartClient
       end
       return data, status_code, headers
     end
+    # Get file manager directory
+    # @param id 
+    # @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 
+    # @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, Fixnum, 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' + '}', id.to_s)
+
+      # query parameters
+      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 = {}
+      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 = ['ultraCartBrowserApiKey', '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 => 'FileManagerPage')
+      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 
@@ -6332,6 +6512,65 @@ module UltracartClient
       end
       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 
+    # @param extension 
+    # @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 
+    # @param extension 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(FileManagerUploadUrlResponse, Fixnum, 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' + '}', id.to_s).sub('{' + 'extension' + '}', extension.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 = ['ultraCartBrowserApiKey', '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 => 'FileManagerUploadUrlResponse')
+      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 
     # @param unsubscribe Unsubscribe
@@ -9784,6 +10023,64 @@ module UltracartClient
       end
       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 
+    # @param upload_request 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 
+    # @param upload_request UploadRequest
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Fixnum, 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' + '}', 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 = @api_client.object_to_http_body(upload_request)
+      auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names)
+      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 Ruler Validate Request
     # @param [Hash] opts the optional parameters

data/lib/ultracart_api/models/file_manager_directory.rb

@@ -0,0 +1,292 @@
+=begin
+#UltraCart Rest API V2
+
+#UltraCart REST API Version 2
+
+OpenAPI spec version: 2.0.0
+Contact: support@ultracart.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.4.15-SNAPSHOT
+
+=end
+
+require 'date'
+
+module UltracartClient
+  class FileManagerDirectory
+    attr_accessor :active_theme_directory
+
+    attr_accessor :favorite
+
+    attr_accessor :hostname
+
+    attr_accessor :icon
+
+    attr_accessor :last_modified
+
+    attr_accessor :name
+
+    attr_accessor :parent_storefront_fs_directory_oid
+
+    attr_accessor :part_of_active_theme
+
+    attr_accessor :selected
+
+    attr_accessor :storefront_fs_directory_oid
+
+    attr_accessor :storefront_fs_file_oid
+
+    attr_accessor :storefront_oid
+
+    attr_accessor :type
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'active_theme_directory' => :'active_theme_directory',
+        :'favorite' => :'favorite',
+        :'hostname' => :'hostname',
+        :'icon' => :'icon',
+        :'last_modified' => :'last_modified',
+        :'name' => :'name',
+        :'parent_storefront_fs_directory_oid' => :'parent_storefront_fs_directory_oid',
+        :'part_of_active_theme' => :'part_of_active_theme',
+        :'selected' => :'selected',
+        :'storefront_fs_directory_oid' => :'storefront_fs_directory_oid',
+        :'storefront_fs_file_oid' => :'storefront_fs_file_oid',
+        :'storefront_oid' => :'storefront_oid',
+        :'type' => :'type'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'active_theme_directory' => :'BOOLEAN',
+        :'favorite' => :'BOOLEAN',
+        :'hostname' => :'String',
+        :'icon' => :'String',
+        :'last_modified' => :'String',
+        :'name' => :'String',
+        :'parent_storefront_fs_directory_oid' => :'Integer',
+        :'part_of_active_theme' => :'BOOLEAN',
+        :'selected' => :'BOOLEAN',
+        :'storefront_fs_directory_oid' => :'Integer',
+        :'storefront_fs_file_oid' => :'Integer',
+        :'storefront_oid' => :'Integer',
+        :'type' => :'String'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }
+
+      if attributes.has_key?(:'active_theme_directory')
+        self.active_theme_directory = attributes[:'active_theme_directory']
+      end
+
+      if attributes.has_key?(:'favorite')
+        self.favorite = attributes[:'favorite']
+      end
+
+      if attributes.has_key?(:'hostname')
+        self.hostname = attributes[:'hostname']
+      end
+
+      if attributes.has_key?(:'icon')
+        self.icon = attributes[:'icon']
+      end
+
+      if attributes.has_key?(:'last_modified')
+        self.last_modified = attributes[:'last_modified']
+      end
+
+      if attributes.has_key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.has_key?(:'parent_storefront_fs_directory_oid')
+        self.parent_storefront_fs_directory_oid = attributes[:'parent_storefront_fs_directory_oid']
+      end
+
+      if attributes.has_key?(:'part_of_active_theme')
+        self.part_of_active_theme = attributes[:'part_of_active_theme']
+      end
+
+      if attributes.has_key?(:'selected')
+        self.selected = attributes[:'selected']
+      end
+
+      if attributes.has_key?(:'storefront_fs_directory_oid')
+        self.storefront_fs_directory_oid = attributes[:'storefront_fs_directory_oid']
+      end
+
+      if attributes.has_key?(:'storefront_fs_file_oid')
+        self.storefront_fs_file_oid = attributes[:'storefront_fs_file_oid']
+      end
+
+      if attributes.has_key?(:'storefront_oid')
+        self.storefront_oid = attributes[:'storefront_oid']
+      end
+
+      if attributes.has_key?(:'type')
+        self.type = attributes[:'type']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          active_theme_directory == o.active_theme_directory &&
+          favorite == o.favorite &&
+          hostname == o.hostname &&
+          icon == o.icon &&
+          last_modified == o.last_modified &&
+          name == o.name &&
+          parent_storefront_fs_directory_oid == o.parent_storefront_fs_directory_oid &&
+          part_of_active_theme == o.part_of_active_theme &&
+          selected == o.selected &&
+          storefront_fs_directory_oid == o.storefront_fs_directory_oid &&
+          storefront_fs_file_oid == o.storefront_fs_file_oid &&
+          storefront_oid == o.storefront_oid &&
+          type == o.type
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [active_theme_directory, favorite, hostname, icon, last_modified, name, parent_storefront_fs_directory_oid, part_of_active_theme, selected, storefront_fs_directory_oid, storefront_fs_file_oid, storefront_oid, type].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.swagger_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BOOLEAN
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        temp_model = UltracartClient.const_get(type).new
+        temp_model.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map { |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+end