square_connect 2.0.2.69 → 2.1.0.beta

data/lib/square_connect/models/v1_update_order_request.rb

@@ -0,0 +1,264 @@
+=begin
+#Square Connect API
+
+OpenAPI spec version: 2.0
+Contact: developers@squareup.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+
+=end
+
+require 'date'
+
+module SquareConnect
+
+  class V1UpdateOrderRequest
+    # The action to perform on the order (COMPLETE, CANCEL, or REFUND).
+    attr_accessor :action
+
+    # The tracking number of the shipment associated with the order. Only valid if action is COMPLETE.
+    attr_accessor :shipped_tracking_number
+
+    # A merchant-specified note about the completion of the order. Only valid if action is COMPLETE.
+    attr_accessor :completed_note
+
+    # A merchant-specified note about the refunding of the order. Only valid if action is REFUND.
+    attr_accessor :refunded_note
+
+    # A merchant-specified note about the canceling of the order. Only valid if action is CANCEL.
+    attr_accessor :canceled_note
+
+    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
+      {
+        :'action' => :'action',
+        :'shipped_tracking_number' => :'shipped_tracking_number',
+        :'completed_note' => :'completed_note',
+        :'refunded_note' => :'refunded_note',
+        :'canceled_note' => :'canceled_note'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'action' => :'String',
+        :'shipped_tracking_number' => :'String',
+        :'completed_note' => :'String',
+        :'refunded_note' => :'String',
+        :'canceled_note' => :'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?(:'action')
+        self.action = attributes[:'action']
+      end
+
+      if attributes.has_key?(:'shipped_tracking_number')
+        self.shipped_tracking_number = attributes[:'shipped_tracking_number']
+      end
+
+      if attributes.has_key?(:'completed_note')
+        self.completed_note = attributes[:'completed_note']
+      end
+
+      if attributes.has_key?(:'refunded_note')
+        self.refunded_note = attributes[:'refunded_note']
+      end
+
+      if attributes.has_key?(:'canceled_note')
+        self.canceled_note = attributes[:'canceled_note']
+      end
+
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properies with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      if @action.nil?
+        invalid_properties.push("invalid value for 'action', action cannot be nil.")
+      end
+
+      return 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?
+      return false if @action.nil?
+      action_validator = EnumAttributeValidator.new('String', ["COMPLETE", "CANCEL", "REFUND"])
+      return false unless action_validator.valid?(@action)
+      return true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] action Object to be assigned
+    def action=(action)
+      validator = EnumAttributeValidator.new('String', ["COMPLETE", "CANCEL", "REFUND"])
+      unless validator.valid?(action)
+        fail ArgumentError, "invalid value for 'action', must be one of #{validator.allowable_values}."
+      end
+      @action = action
+    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 &&
+          action == o.action &&
+          shipped_tracking_number == o.shipped_tracking_number &&
+          completed_note == o.completed_note &&
+          refunded_note == o.refunded_note &&
+          canceled_note == o.canceled_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 [Fixnum] Hash code
+    def hash
+      [action, shipped_tracking_number, completed_note, refunded_note, canceled_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 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 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 = SquareConnect.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

data/lib/square_connect/models/v1_variation.rb

@@ -0,0 +1,331 @@
+=begin
+#Square Connect API
+
+OpenAPI spec version: 2.0
+Contact: developers@squareup.com
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+
+=end
+
+require 'date'
+
+module SquareConnect
+
+  class V1Variation
+    # The item variation's unique ID.
+    attr_accessor :id
+
+    # The item variation's name.
+    attr_accessor :name
+
+    # The ID of the variation's associated item.
+    attr_accessor :item_id
+
+    # ndicates the variation's list position when displayed in Square Register and the merchant dashboard. If more than one variation for the same item has the same ordinal value, those variations are displayed in alphabetical order
+    attr_accessor :ordinal
+
+    # Indicates whether the item variation's price is fixed or determined at the time of sale.
+    attr_accessor :pricing_type
+
+    # The item variation's price, if any.
+    attr_accessor :price_money
+
+    # The item variation's SKU, if any.
+    attr_accessor :sku
+
+    # If true, inventory tracking is active for the variation.
+    attr_accessor :track_inventory
+
+    # Indicates whether the item variation displays an alert when its inventory quantity is less than or equal to its inventory_alert_threshold.
+    attr_accessor :inventory_alert_type
+
+    # If the inventory quantity for the variation is less than or equal to this value and inventory_alert_type is LOW_QUANTITY, the variation displays an alert in the merchant dashboard.
+    attr_accessor :inventory_alert_threshold
+
+    # Arbitrary metadata associated with the variation. Cannot exceed 255 characters.
+    attr_accessor :user_data
+
+    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
+      {
+        :'id' => :'id',
+        :'name' => :'name',
+        :'item_id' => :'item_id',
+        :'ordinal' => :'ordinal',
+        :'pricing_type' => :'pricing_type',
+        :'price_money' => :'price_money',
+        :'sku' => :'sku',
+        :'track_inventory' => :'track_inventory',
+        :'inventory_alert_type' => :'inventory_alert_type',
+        :'inventory_alert_threshold' => :'inventory_alert_threshold',
+        :'user_data' => :'user_data'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'id' => :'String',
+        :'name' => :'String',
+        :'item_id' => :'String',
+        :'ordinal' => :'String',
+        :'pricing_type' => :'String',
+        :'price_money' => :'V1Money',
+        :'sku' => :'String',
+        :'track_inventory' => :'BOOLEAN',
+        :'inventory_alert_type' => :'String',
+        :'inventory_alert_threshold' => :'Integer',
+        :'user_data' => :'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?(:'id')
+        self.id = attributes[:'id']
+      end
+
+      if attributes.has_key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.has_key?(:'item_id')
+        self.item_id = attributes[:'item_id']
+      end
+
+      if attributes.has_key?(:'ordinal')
+        self.ordinal = attributes[:'ordinal']
+      end
+
+      if attributes.has_key?(:'pricing_type')
+        self.pricing_type = attributes[:'pricing_type']
+      end
+
+      if attributes.has_key?(:'price_money')
+        self.price_money = attributes[:'price_money']
+      end
+
+      if attributes.has_key?(:'sku')
+        self.sku = attributes[:'sku']
+      end
+
+      if attributes.has_key?(:'track_inventory')
+        self.track_inventory = attributes[:'track_inventory']
+      end
+
+      if attributes.has_key?(:'inventory_alert_type')
+        self.inventory_alert_type = attributes[:'inventory_alert_type']
+      end
+
+      if attributes.has_key?(:'inventory_alert_threshold')
+        self.inventory_alert_threshold = attributes[:'inventory_alert_threshold']
+      end
+
+      if attributes.has_key?(:'user_data')
+        self.user_data = attributes[:'user_data']
+      end
+
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properies with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      return 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?
+      pricing_type_validator = EnumAttributeValidator.new('String', ["FIXED_PRICING", "VARIABLE_PRICING"])
+      return false unless pricing_type_validator.valid?(@pricing_type)
+      inventory_alert_type_validator = EnumAttributeValidator.new('String', ["LOW_QUANTITY", "NONE", "INVESTMENT", "LOAN", "SAVINGS", "OTHER"])
+      return false unless inventory_alert_type_validator.valid?(@inventory_alert_type)
+      return true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] pricing_type Object to be assigned
+    def pricing_type=(pricing_type)
+      validator = EnumAttributeValidator.new('String', ["FIXED_PRICING", "VARIABLE_PRICING"])
+      unless validator.valid?(pricing_type)
+        fail ArgumentError, "invalid value for 'pricing_type', must be one of #{validator.allowable_values}."
+      end
+      @pricing_type = pricing_type
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] inventory_alert_type Object to be assigned
+    def inventory_alert_type=(inventory_alert_type)
+      validator = EnumAttributeValidator.new('String', ["LOW_QUANTITY", "NONE", "INVESTMENT", "LOAN", "SAVINGS", "OTHER"])
+      unless validator.valid?(inventory_alert_type)
+        fail ArgumentError, "invalid value for 'inventory_alert_type', must be one of #{validator.allowable_values}."
+      end
+      @inventory_alert_type = inventory_alert_type
+    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 &&
+          id == o.id &&
+          name == o.name &&
+          item_id == o.item_id &&
+          ordinal == o.ordinal &&
+          pricing_type == o.pricing_type &&
+          price_money == o.price_money &&
+          sku == o.sku &&
+          track_inventory == o.track_inventory &&
+          inventory_alert_type == o.inventory_alert_type &&
+          inventory_alert_threshold == o.inventory_alert_threshold &&
+          user_data == o.user_data
+    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
+      [id, name, item_id, ordinal, pricing_type, price_money, sku, track_inventory, inventory_alert_type, inventory_alert_threshold, user_data].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 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 = SquareConnect.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