ultracart_api 4.1.136 → 4.1.140

data/lib/ultracart_api/models/sfvb_version_response.rb

@@ -0,0 +1,344 @@
+=begin
+#UltraCart Rest API V2
+
+#UltraCart REST API Version 2
+
+The version of the OpenAPI document: 2.0.0
+Contact: support@ultracart.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.0.1-SNAPSHOT
+
+=end
+
+require 'date'
+require 'time'
+
+module UltracartClient
+  class SfvbVersionResponse
+    # Container manager version used to compile for this merchant.
+    attr_accessor :container_manager_version
+
+    # Versions kept per non-file container before the oldest are pruned.  Beyond this, history is gone - not merely paginated.
+    attr_accessor :container_versions_retained
+
+    # Number of element types this version recognizes.
+    attr_accessor :element_count
+
+    # Largest CJSON document that will be parsed, in bytes.
+    attr_accessor :max_cjson_bytes
+
+    # Largest payload one preview session may hold, in bytes.
+    attr_accessor :max_preview_session_bytes
+
+    # Hard ceiling on file search results per page.
+    attr_accessor :max_search_results
+
+    # Largest template file that can be written, in bytes.
+    attr_accessor :max_template_bytes
+
+    # Most widget ids that can be reserved in one call.
+    attr_accessor :max_widget_ids_per_request
+
+    # Seconds a preview session survives before expiring.
+    attr_accessor :preview_session_ttl_seconds
+
+    # Release channel selected for this merchant.
+    attr_accessor :release
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'container_manager_version' => :'containerManagerVersion',
+        :'container_versions_retained' => :'containerVersionsRetained',
+        :'element_count' => :'elementCount',
+        :'max_cjson_bytes' => :'maxCjsonBytes',
+        :'max_preview_session_bytes' => :'maxPreviewSessionBytes',
+        :'max_search_results' => :'maxSearchResults',
+        :'max_template_bytes' => :'maxTemplateBytes',
+        :'max_widget_ids_per_request' => :'maxWidgetIdsPerRequest',
+        :'preview_session_ttl_seconds' => :'previewSessionTtlSeconds',
+        :'release' => :'release'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'container_manager_version' => :'String',
+        :'container_versions_retained' => :'Integer',
+        :'element_count' => :'Integer',
+        :'max_cjson_bytes' => :'Integer',
+        :'max_preview_session_bytes' => :'Integer',
+        :'max_search_results' => :'Integer',
+        :'max_template_bytes' => :'Integer',
+        :'max_widget_ids_per_request' => :'Integer',
+        :'preview_session_ttl_seconds' => :'Integer',
+        :'release' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `UltracartClient::SfvbVersionResponse` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `UltracartClient::SfvbVersionResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'container_manager_version')
+        self.container_manager_version = attributes[:'container_manager_version']
+      end
+
+      if attributes.key?(:'container_versions_retained')
+        self.container_versions_retained = attributes[:'container_versions_retained']
+      end
+
+      if attributes.key?(:'element_count')
+        self.element_count = attributes[:'element_count']
+      end
+
+      if attributes.key?(:'max_cjson_bytes')
+        self.max_cjson_bytes = attributes[:'max_cjson_bytes']
+      end
+
+      if attributes.key?(:'max_preview_session_bytes')
+        self.max_preview_session_bytes = attributes[:'max_preview_session_bytes']
+      end
+
+      if attributes.key?(:'max_search_results')
+        self.max_search_results = attributes[:'max_search_results']
+      end
+
+      if attributes.key?(:'max_template_bytes')
+        self.max_template_bytes = attributes[:'max_template_bytes']
+      end
+
+      if attributes.key?(:'max_widget_ids_per_request')
+        self.max_widget_ids_per_request = attributes[:'max_widget_ids_per_request']
+      end
+
+      if attributes.key?(:'preview_session_ttl_seconds')
+        self.preview_session_ttl_seconds = attributes[:'preview_session_ttl_seconds']
+      end
+
+      if attributes.key?(:'release')
+        self.release = attributes[:'release']
+      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?
+      release_validator = EnumAttributeValidator.new('String', ["ga", "beta", "alpha"])
+      return false unless release_validator.valid?(@release)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] release Object to be assigned
+    def release=(release)
+      validator = EnumAttributeValidator.new('String', ["ga", "beta", "alpha"])
+      unless validator.valid?(release)
+        fail ArgumentError, "invalid value for \"release\", must be one of #{validator.allowable_values}."
+      end
+      @release = release
+    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 &&
+          container_manager_version == o.container_manager_version &&
+          container_versions_retained == o.container_versions_retained &&
+          element_count == o.element_count &&
+          max_cjson_bytes == o.max_cjson_bytes &&
+          max_preview_session_bytes == o.max_preview_session_bytes &&
+          max_search_results == o.max_search_results &&
+          max_template_bytes == o.max_template_bytes &&
+          max_widget_ids_per_request == o.max_widget_ids_per_request &&
+          preview_session_ttl_seconds == o.preview_session_ttl_seconds &&
+          release == o.release
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [container_manager_version, container_versions_retained, element_count, max_cjson_bytes, max_preview_session_bytes, max_search_results, max_template_bytes, max_widget_ids_per_request, preview_session_ttl_seconds, release].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    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)
+      attributes = attributes.transform_keys(&:to_sym)
+      self.class.openapi_types.each_pair do |key, type|
+        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{key}=", nil)
+        elsif 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
+      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 :Time
+        Time.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
+        # models (e.g. Pet) or oneOf
+        klass = UltracartClient.const_get(type)
+        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        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

data/lib/ultracart_api/models/sfvb_whoami_response.rb

@@ -0,0 +1,314 @@
+=begin
+#UltraCart Rest API V2
+
+#UltraCart REST API Version 2
+
+The version of the OpenAPI document: 2.0.0
+Contact: support@ultracart.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 6.0.1-SNAPSHOT
+
+=end
+
+require 'date'
+require 'time'
+
+module UltracartClient
+  class SfvbWhoamiResponse
+    # True when this token resolves to a merchant user.  Preview sessions and file writes need one, because they are recorded against the person who approved the token.  Only device flow tokens resolve a user, so a plain API key will see this false.
+    attr_accessor :acting_as_user
+
+    # Description of the application this credential belongs to.
+    attr_accessor :application_name
+
+    # How this token authenticated - Oauth2, Simple Key, Public/Private Key or Browser Key.
+    attr_accessor :authentication_type
+
+    # Device scope name, when this is a device flow token.
+    attr_accessor :device_scope
+
+    # Login of the user who approved this token.  Populated for device flow tokens; null for plain API key credentials.
+    attr_accessor :login
+
+    # Merchant id this token acts against.
+    attr_accessor :merchant_id
+
+    # Scopes granted to this token.
+    attr_accessor :scopes
+
+    # Storefronts reachable with this token.  Empty unless the token holds sfvb_read, because storefront inventory is resource data rather than identity.
+    attr_accessor :storefronts
+
+    # True when storefronts was emptied because the token lacks sfvb_read, rather than because the account has none.  Without this the two look identical.
+    attr_accessor :storefronts_withheld
+
+    # Display name of the approving user, when known.
+    attr_accessor :user_name
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'acting_as_user' => :'actingAsUser',
+        :'application_name' => :'applicationName',
+        :'authentication_type' => :'authenticationType',
+        :'device_scope' => :'deviceScope',
+        :'login' => :'login',
+        :'merchant_id' => :'merchantId',
+        :'scopes' => :'scopes',
+        :'storefronts' => :'storefronts',
+        :'storefronts_withheld' => :'storefrontsWithheld',
+        :'user_name' => :'userName'
+      }
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'acting_as_user' => :'Boolean',
+        :'application_name' => :'String',
+        :'authentication_type' => :'String',
+        :'device_scope' => :'String',
+        :'login' => :'String',
+        :'merchant_id' => :'String',
+        :'scopes' => :'Array<String>',
+        :'storefronts' => :'Array<SfvbStorefront>',
+        :'storefronts_withheld' => :'Boolean',
+        :'user_name' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `UltracartClient::SfvbWhoamiResponse` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `UltracartClient::SfvbWhoamiResponse`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'acting_as_user')
+        self.acting_as_user = attributes[:'acting_as_user']
+      end
+
+      if attributes.key?(:'application_name')
+        self.application_name = attributes[:'application_name']
+      end
+
+      if attributes.key?(:'authentication_type')
+        self.authentication_type = attributes[:'authentication_type']
+      end
+
+      if attributes.key?(:'device_scope')
+        self.device_scope = attributes[:'device_scope']
+      end
+
+      if attributes.key?(:'login')
+        self.login = attributes[:'login']
+      end
+
+      if attributes.key?(:'merchant_id')
+        self.merchant_id = attributes[:'merchant_id']
+      end
+
+      if attributes.key?(:'scopes')
+        if (value = attributes[:'scopes']).is_a?(Array)
+          self.scopes = value
+        end
+      end
+
+      if attributes.key?(:'storefronts')
+        if (value = attributes[:'storefronts']).is_a?(Array)
+          self.storefronts = value
+        end
+      end
+
+      if attributes.key?(:'storefronts_withheld')
+        self.storefronts_withheld = attributes[:'storefronts_withheld']
+      end
+
+      if attributes.key?(:'user_name')
+        self.user_name = attributes[:'user_name']
+      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 &&
+          acting_as_user == o.acting_as_user &&
+          application_name == o.application_name &&
+          authentication_type == o.authentication_type &&
+          device_scope == o.device_scope &&
+          login == o.login &&
+          merchant_id == o.merchant_id &&
+          scopes == o.scopes &&
+          storefronts == o.storefronts &&
+          storefronts_withheld == o.storefronts_withheld &&
+          user_name == o.user_name
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [acting_as_user, application_name, authentication_type, device_scope, login, merchant_id, scopes, storefronts, storefronts_withheld, user_name].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      new.build_from_hash(attributes)
+    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)
+      attributes = attributes.transform_keys(&:to_sym)
+      self.class.openapi_types.each_pair do |key, type|
+        if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
+          self.send("#{key}=", nil)
+        elsif 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
+      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 :Time
+        Time.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
+        # models (e.g. Pet) or oneOf
+        klass = UltracartClient.const_get(type)
+        klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        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