ultracart_api 4.1.136 → 4.1.140

data/lib/ultracart_api/models/sfvb_preview_url_response.rb

@@ -0,0 +1,280 @@
+=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 SfvbPreviewUrlResponse
+    # Seconds until the session expires.
+    attr_accessor :expires_in_seconds
+
+    # Storefront path being previewed.
+    attr_accessor :path
+
+    # The preview session id used.
+    attr_accessor :preview_session_id
+
+    # URL that renders the storefront page with the preview session's containers substituted for the stored ones.
+    attr_accessor :preview_url
+
+    # Always true.  The preview only applies to a request carrying the UltraCart admin session cookie of the user who authorised this token.  Fetched without it, the URL returns the LIVE page with a 200 and no error, so a successful fetch is not evidence the preview was applied.  Present this URL for a human to open; do not fetch it.
+    attr_accessor :requires_browser_session
+
+    # Always false.  The session is keyed by individual login, so anyone else opening this URL sees the live page rather than the preview.
+    attr_accessor :shareable
+
+    # Plain language restatement of the two flags above, safe to show a user.
+    attr_accessor :usage_note
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'expires_in_seconds' => :'expiresInSeconds',
+        :'path' => :'path',
+        :'preview_session_id' => :'previewSessionId',
+        :'preview_url' => :'previewUrl',
+        :'requires_browser_session' => :'requiresBrowserSession',
+        :'shareable' => :'shareable',
+        :'usage_note' => :'usageNote'
+      }
+    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
+      {
+        :'expires_in_seconds' => :'Integer',
+        :'path' => :'String',
+        :'preview_session_id' => :'String',
+        :'preview_url' => :'String',
+        :'requires_browser_session' => :'Boolean',
+        :'shareable' => :'Boolean',
+        :'usage_note' => :'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::SfvbPreviewUrlResponse` 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::SfvbPreviewUrlResponse`. 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?(:'expires_in_seconds')
+        self.expires_in_seconds = attributes[:'expires_in_seconds']
+      end
+
+      if attributes.key?(:'path')
+        self.path = attributes[:'path']
+      end
+
+      if attributes.key?(:'preview_session_id')
+        self.preview_session_id = attributes[:'preview_session_id']
+      end
+
+      if attributes.key?(:'preview_url')
+        self.preview_url = attributes[:'preview_url']
+      end
+
+      if attributes.key?(:'requires_browser_session')
+        self.requires_browser_session = attributes[:'requires_browser_session']
+      end
+
+      if attributes.key?(:'shareable')
+        self.shareable = attributes[:'shareable']
+      end
+
+      if attributes.key?(:'usage_note')
+        self.usage_note = attributes[:'usage_note']
+      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 &&
+          expires_in_seconds == o.expires_in_seconds &&
+          path == o.path &&
+          preview_session_id == o.preview_session_id &&
+          preview_url == o.preview_url &&
+          requires_browser_session == o.requires_browser_session &&
+          shareable == o.shareable &&
+          usage_note == o.usage_note
+    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
+      [expires_in_seconds, path, preview_session_id, preview_url, requires_browser_session, shareable, usage_note].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_render_request.rb

@@ -0,0 +1,330 @@
+=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 SfvbRenderRequest
+    # The chain of ancestor nodes above this one, as CJSON.  Elements that inherit layout or styling from a parent render differently without it, so supply it when rendering a node from inside a container rather than a standalone fragment.
+    attr_accessor :ancestors_cjson
+
+    # Child containers this node references, as a JSON object keyed by container id.  Compiled into the render context so nested containers resolve.
+    attr_accessor :child_containers_json
+
+    # The CJSON node to render.
+    attr_accessor :cjson
+
+    # Affiliate oid for the rendering context.
+    attr_accessor :context_affiliate_oid
+
+    # Blog post oid for the rendering context.
+    attr_accessor :context_blog_post_oid
+
+    # Catalog group path for the rendering context.
+    attr_accessor :context_group_path
+
+    # Item id for the rendering context.  Required for item bound elements.
+    attr_accessor :context_item_id
+
+    # Order id for the rendering context.
+    attr_accessor :context_order_id
+
+    # Page number for paginated elements.  Defaults to 1.
+    attr_accessor :context_page_number
+
+    # Upsell offer oid for the rendering context.
+    attr_accessor :context_upsell_offer_oid
+
+    # Language ISO code.  Defaults to ENG.
+    attr_accessor :language_iso_code
+
+    # Storefront URI the node would appear on.  Affects rendering of anything page relative.
+    attr_accessor :uri
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'ancestors_cjson' => :'ancestorsCjson',
+        :'child_containers_json' => :'childContainersJson',
+        :'cjson' => :'cjson',
+        :'context_affiliate_oid' => :'contextAffiliateOid',
+        :'context_blog_post_oid' => :'contextBlogPostOid',
+        :'context_group_path' => :'contextGroupPath',
+        :'context_item_id' => :'contextItemId',
+        :'context_order_id' => :'contextOrderId',
+        :'context_page_number' => :'contextPageNumber',
+        :'context_upsell_offer_oid' => :'contextUpsellOfferOid',
+        :'language_iso_code' => :'languageIsoCode',
+        :'uri' => :'uri'
+      }
+    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
+      {
+        :'ancestors_cjson' => :'String',
+        :'child_containers_json' => :'String',
+        :'cjson' => :'String',
+        :'context_affiliate_oid' => :'Integer',
+        :'context_blog_post_oid' => :'Integer',
+        :'context_group_path' => :'String',
+        :'context_item_id' => :'String',
+        :'context_order_id' => :'String',
+        :'context_page_number' => :'String',
+        :'context_upsell_offer_oid' => :'Integer',
+        :'language_iso_code' => :'String',
+        :'uri' => :'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::SfvbRenderRequest` 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::SfvbRenderRequest`. 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?(:'ancestors_cjson')
+        self.ancestors_cjson = attributes[:'ancestors_cjson']
+      end
+
+      if attributes.key?(:'child_containers_json')
+        self.child_containers_json = attributes[:'child_containers_json']
+      end
+
+      if attributes.key?(:'cjson')
+        self.cjson = attributes[:'cjson']
+      end
+
+      if attributes.key?(:'context_affiliate_oid')
+        self.context_affiliate_oid = attributes[:'context_affiliate_oid']
+      end
+
+      if attributes.key?(:'context_blog_post_oid')
+        self.context_blog_post_oid = attributes[:'context_blog_post_oid']
+      end
+
+      if attributes.key?(:'context_group_path')
+        self.context_group_path = attributes[:'context_group_path']
+      end
+
+      if attributes.key?(:'context_item_id')
+        self.context_item_id = attributes[:'context_item_id']
+      end
+
+      if attributes.key?(:'context_order_id')
+        self.context_order_id = attributes[:'context_order_id']
+      end
+
+      if attributes.key?(:'context_page_number')
+        self.context_page_number = attributes[:'context_page_number']
+      end
+
+      if attributes.key?(:'context_upsell_offer_oid')
+        self.context_upsell_offer_oid = attributes[:'context_upsell_offer_oid']
+      end
+
+      if attributes.key?(:'language_iso_code')
+        self.language_iso_code = attributes[:'language_iso_code']
+      end
+
+      if attributes.key?(:'uri')
+        self.uri = attributes[:'uri']
+      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 &&
+          ancestors_cjson == o.ancestors_cjson &&
+          child_containers_json == o.child_containers_json &&
+          cjson == o.cjson &&
+          context_affiliate_oid == o.context_affiliate_oid &&
+          context_blog_post_oid == o.context_blog_post_oid &&
+          context_group_path == o.context_group_path &&
+          context_item_id == o.context_item_id &&
+          context_order_id == o.context_order_id &&
+          context_page_number == o.context_page_number &&
+          context_upsell_offer_oid == o.context_upsell_offer_oid &&
+          language_iso_code == o.language_iso_code &&
+          uri == o.uri
+    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
+      [ancestors_cjson, child_containers_json, cjson, context_affiliate_oid, context_blog_post_oid, context_group_path, context_item_id, context_order_id, context_page_number, context_upsell_offer_oid, language_iso_code, uri].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