ultracart_api 4.1.219 → 4.1.221

data/lib/ultracart_api/models/sfvb_postcard_proof_request.rb

@@ -0,0 +1,302 @@
+=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 SfvbPostcardProofRequest
+    # The recipient street address.  Without address1, city, state and postal_code, a sample address is used.
+    attr_accessor :address1
+
+    # The recipient second address line.
+    attr_accessor :address2
+
+    # Item ids for the cart a cart flow card renders with.  The cart is made for the proof and deleted after it.
+    attr_accessor :cart_item_ids
+
+    # The recipient city.
+    attr_accessor :city
+
+    # The recipient name the card greets and is addressed to.  Defaults to the signed in user.
+    attr_accessor :customer_name
+
+    # True to return only the rendered HTML of both sides, with no print vendor render.  The default, false, also returns the images that would print and the vendor proof PDF.
+    attr_accessor :html_only
+
+    # A test order for an order flow card.  Real orders are refused.  Without one, an order flow card renders with a made up order.
+    attr_accessor :order_id
+
+    # The recipient postal code.
+    attr_accessor :postal_code
+
+    # The recipient state.
+    attr_accessor :state
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'address1' => :'address1',
+        :'address2' => :'address2',
+        :'cart_item_ids' => :'cart_item_ids',
+        :'city' => :'city',
+        :'customer_name' => :'customer_name',
+        :'html_only' => :'html_only',
+        :'order_id' => :'order_id',
+        :'postal_code' => :'postal_code',
+        :'state' => :'state'
+      }
+    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
+      {
+        :'address1' => :'String',
+        :'address2' => :'String',
+        :'cart_item_ids' => :'Array<String>',
+        :'city' => :'String',
+        :'customer_name' => :'String',
+        :'html_only' => :'Boolean',
+        :'order_id' => :'String',
+        :'postal_code' => :'String',
+        :'state' => :'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::SfvbPostcardProofRequest` 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::SfvbPostcardProofRequest`. 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?(:'address1')
+        self.address1 = attributes[:'address1']
+      end
+
+      if attributes.key?(:'address2')
+        self.address2 = attributes[:'address2']
+      end
+
+      if attributes.key?(:'cart_item_ids')
+        if (value = attributes[:'cart_item_ids']).is_a?(Array)
+          self.cart_item_ids = value
+        end
+      end
+
+      if attributes.key?(:'city')
+        self.city = attributes[:'city']
+      end
+
+      if attributes.key?(:'customer_name')
+        self.customer_name = attributes[:'customer_name']
+      end
+
+      if attributes.key?(:'html_only')
+        self.html_only = attributes[:'html_only']
+      end
+
+      if attributes.key?(:'order_id')
+        self.order_id = attributes[:'order_id']
+      end
+
+      if attributes.key?(:'postal_code')
+        self.postal_code = attributes[:'postal_code']
+      end
+
+      if attributes.key?(:'state')
+        self.state = attributes[:'state']
+      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 &&
+          address1 == o.address1 &&
+          address2 == o.address2 &&
+          cart_item_ids == o.cart_item_ids &&
+          city == o.city &&
+          customer_name == o.customer_name &&
+          html_only == o.html_only &&
+          order_id == o.order_id &&
+          postal_code == o.postal_code &&
+          state == o.state
+    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
+      [address1, address2, cart_item_ids, city, customer_name, html_only, order_id, postal_code, state].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_postcard_proof_response.rb

@@ -0,0 +1,356 @@
+=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 SfvbPostcardProofResponse
+    # The back as the send renders it, after the name tokens are filled.
+    attr_accessor :back_html
+
+    # The back as the PNG image the print vendor prints from.  A public url.
+    attr_accessor :back_image_url
+
+    # The print vendor thumbnail of the back.
+    attr_accessor :back_thumbnail_url
+
+    # The front as the send renders it, after the name tokens are filled.
+    attr_accessor :front_html
+
+    # The front as the PNG image the print vendor prints from.  A public url.
+    attr_accessor :front_image_url
+
+    # The print vendor thumbnail of the front.
+    attr_accessor :front_thumbnail_url
+
+    # Where the order came from.  test for the order_id given, dummy for a made up one, none for no order.
+    attr_accessor :order_source
+
+    # The postcard the step mails.
+    attr_accessor :postcard_uuid
+
+    # The print vendor proof PDF of both sides.
+    attr_accessor :rendered_pdf_url
+
+    # True when the print vendor rendered the card, so the image and PDF urls are set.
+    attr_accessor :vendor_rendered
+
+    # Where the proof differs from a send, such as a placeholder coupon code or a sample address, and anything that would make a send skip the card.
+    attr_accessor :warnings
+
+    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
+      {
+        :'back_html' => :'back_html',
+        :'back_image_url' => :'back_image_url',
+        :'back_thumbnail_url' => :'back_thumbnail_url',
+        :'front_html' => :'front_html',
+        :'front_image_url' => :'front_image_url',
+        :'front_thumbnail_url' => :'front_thumbnail_url',
+        :'order_source' => :'order_source',
+        :'postcard_uuid' => :'postcard_uuid',
+        :'rendered_pdf_url' => :'rendered_pdf_url',
+        :'vendor_rendered' => :'vendor_rendered',
+        :'warnings' => :'warnings'
+      }
+    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
+      {
+        :'back_html' => :'String',
+        :'back_image_url' => :'String',
+        :'back_thumbnail_url' => :'String',
+        :'front_html' => :'String',
+        :'front_image_url' => :'String',
+        :'front_thumbnail_url' => :'String',
+        :'order_source' => :'String',
+        :'postcard_uuid' => :'String',
+        :'rendered_pdf_url' => :'String',
+        :'vendor_rendered' => :'Boolean',
+        :'warnings' => :'Array<SfvbErrorDetail>'
+      }
+    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::SfvbPostcardProofResponse` 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::SfvbPostcardProofResponse`. 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?(:'back_html')
+        self.back_html = attributes[:'back_html']
+      end
+
+      if attributes.key?(:'back_image_url')
+        self.back_image_url = attributes[:'back_image_url']
+      end
+
+      if attributes.key?(:'back_thumbnail_url')
+        self.back_thumbnail_url = attributes[:'back_thumbnail_url']
+      end
+
+      if attributes.key?(:'front_html')
+        self.front_html = attributes[:'front_html']
+      end
+
+      if attributes.key?(:'front_image_url')
+        self.front_image_url = attributes[:'front_image_url']
+      end
+
+      if attributes.key?(:'front_thumbnail_url')
+        self.front_thumbnail_url = attributes[:'front_thumbnail_url']
+      end
+
+      if attributes.key?(:'order_source')
+        self.order_source = attributes[:'order_source']
+      end
+
+      if attributes.key?(:'postcard_uuid')
+        self.postcard_uuid = attributes[:'postcard_uuid']
+      end
+
+      if attributes.key?(:'rendered_pdf_url')
+        self.rendered_pdf_url = attributes[:'rendered_pdf_url']
+      end
+
+      if attributes.key?(:'vendor_rendered')
+        self.vendor_rendered = attributes[:'vendor_rendered']
+      end
+
+      if attributes.key?(:'warnings')
+        if (value = attributes[:'warnings']).is_a?(Array)
+          self.warnings = value
+        end
+      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?
+      order_source_validator = EnumAttributeValidator.new('String', ["test", "dummy", "none"])
+      return false unless order_source_validator.valid?(@order_source)
+      true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] order_source Object to be assigned
+    def order_source=(order_source)
+      validator = EnumAttributeValidator.new('String', ["test", "dummy", "none"])
+      unless validator.valid?(order_source)
+        fail ArgumentError, "invalid value for \"order_source\", must be one of #{validator.allowable_values}."
+      end
+      @order_source = order_source
+    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 &&
+          back_html == o.back_html &&
+          back_image_url == o.back_image_url &&
+          back_thumbnail_url == o.back_thumbnail_url &&
+          front_html == o.front_html &&
+          front_image_url == o.front_image_url &&
+          front_thumbnail_url == o.front_thumbnail_url &&
+          order_source == o.order_source &&
+          postcard_uuid == o.postcard_uuid &&
+          rendered_pdf_url == o.rendered_pdf_url &&
+          vendor_rendered == o.vendor_rendered &&
+          warnings == o.warnings
+    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
+      [back_html, back_image_url, back_thumbnail_url, front_html, front_image_url, front_thumbnail_url, order_source, postcard_uuid, rendered_pdf_url, vendor_rendered, warnings].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