square_connect 2.0.2.69 → 2.1.0.beta

data/lib/square_connect/models/v1_tender.rb

@@ -0,0 +1,363 @@
+=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 V1Tender
+    # The tender's unique ID.
+    attr_accessor :id
+
+    # The type of tender.
+    attr_accessor :type
+
+    # A human-readable description of the tender.
+    attr_accessor :name
+
+    # The ID of the employee that processed the tender.
+    attr_accessor :employee_id
+
+    # The URL of the receipt for the tender.
+    attr_accessor :receipt_url
+
+    # The brand of credit card provided.
+    attr_accessor :card_brand
+
+    # The last four digits of the provided credit card's account number.
+    attr_accessor :pan_suffix
+
+    # The tender's unique ID.
+    attr_accessor :entry_method
+
+    # Notes entered by the merchant about the tender at the time of payment, if any. Typically only present for tender with the type: OTHER.
+    attr_accessor :payment_note
+
+    # The total amount of money provided in this form of tender.
+    attr_accessor :total_money
+
+    # The amount of total_money applied to the payment.
+    attr_accessor :tendered_money
+
+    # The amount of total_money returned to the buyer as change.
+    attr_accessor :change_back_money
+
+    # The total of all refunds applied to this tender. This amount is always negative or zero.
+    attr_accessor :refunded_money
+
+    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',
+        :'type' => :'type',
+        :'name' => :'name',
+        :'employee_id' => :'employee_id',
+        :'receipt_url' => :'receipt_url',
+        :'card_brand' => :'card_brand',
+        :'pan_suffix' => :'pan_suffix',
+        :'entry_method' => :'entry_method',
+        :'payment_note' => :'payment_note',
+        :'total_money' => :'total_money',
+        :'tendered_money' => :'tendered_money',
+        :'change_back_money' => :'change_back_money',
+        :'refunded_money' => :'refunded_money'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'id' => :'String',
+        :'type' => :'String',
+        :'name' => :'String',
+        :'employee_id' => :'String',
+        :'receipt_url' => :'String',
+        :'card_brand' => :'String',
+        :'pan_suffix' => :'String',
+        :'entry_method' => :'String',
+        :'payment_note' => :'String',
+        :'total_money' => :'V1Money',
+        :'tendered_money' => :'V1Money',
+        :'change_back_money' => :'V1Money',
+        :'refunded_money' => :'V1Money'
+      }
+    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?(:'type')
+        self.type = attributes[:'type']
+      end
+
+      if attributes.has_key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.has_key?(:'employee_id')
+        self.employee_id = attributes[:'employee_id']
+      end
+
+      if attributes.has_key?(:'receipt_url')
+        self.receipt_url = attributes[:'receipt_url']
+      end
+
+      if attributes.has_key?(:'card_brand')
+        self.card_brand = attributes[:'card_brand']
+      end
+
+      if attributes.has_key?(:'pan_suffix')
+        self.pan_suffix = attributes[:'pan_suffix']
+      end
+
+      if attributes.has_key?(:'entry_method')
+        self.entry_method = attributes[:'entry_method']
+      end
+
+      if attributes.has_key?(:'payment_note')
+        self.payment_note = attributes[:'payment_note']
+      end
+
+      if attributes.has_key?(:'total_money')
+        self.total_money = attributes[:'total_money']
+      end
+
+      if attributes.has_key?(:'tendered_money')
+        self.tendered_money = attributes[:'tendered_money']
+      end
+
+      if attributes.has_key?(:'change_back_money')
+        self.change_back_money = attributes[:'change_back_money']
+      end
+
+      if attributes.has_key?(:'refunded_money')
+        self.refunded_money = attributes[:'refunded_money']
+      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?
+      type_validator = EnumAttributeValidator.new('String', ["CREDIT_CARD", "CASH", "THIRD_PARTY_CARD", "NO_SALE", "SQUARE_WALLET", "SQUARE_GIFT_CARD", "UNKNOWN", "OTHER"])
+      return false unless type_validator.valid?(@type)
+      card_brand_validator = EnumAttributeValidator.new('String', ["OTHER_BRAND", "VISA", "MASTER_CARD", "AMERICAN_EXPRESS", "DISCOVER", "DISCOVER_DINERS", "JCB", "CHINA_UNIONPAY", "SQUARE_GIFT_CARD"])
+      return false unless card_brand_validator.valid?(@card_brand)
+      entry_method_validator = EnumAttributeValidator.new('String', ["MANUAL", "SCANNED", "SQUARE_CASH", "SQUARE_WALLET", "SWIPED", "WEB_FORM", "OTHER"])
+      return false unless entry_method_validator.valid?(@entry_method)
+      return true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] type Object to be assigned
+    def type=(type)
+      validator = EnumAttributeValidator.new('String', ["CREDIT_CARD", "CASH", "THIRD_PARTY_CARD", "NO_SALE", "SQUARE_WALLET", "SQUARE_GIFT_CARD", "UNKNOWN", "OTHER"])
+      unless validator.valid?(type)
+        fail ArgumentError, "invalid value for 'type', must be one of #{validator.allowable_values}."
+      end
+      @type = type
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] card_brand Object to be assigned
+    def card_brand=(card_brand)
+      validator = EnumAttributeValidator.new('String', ["OTHER_BRAND", "VISA", "MASTER_CARD", "AMERICAN_EXPRESS", "DISCOVER", "DISCOVER_DINERS", "JCB", "CHINA_UNIONPAY", "SQUARE_GIFT_CARD"])
+      unless validator.valid?(card_brand)
+        fail ArgumentError, "invalid value for 'card_brand', must be one of #{validator.allowable_values}."
+      end
+      @card_brand = card_brand
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] entry_method Object to be assigned
+    def entry_method=(entry_method)
+      validator = EnumAttributeValidator.new('String', ["MANUAL", "SCANNED", "SQUARE_CASH", "SQUARE_WALLET", "SWIPED", "WEB_FORM", "OTHER"])
+      unless validator.valid?(entry_method)
+        fail ArgumentError, "invalid value for 'entry_method', must be one of #{validator.allowable_values}."
+      end
+      @entry_method = entry_method
+    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 &&
+          type == o.type &&
+          name == o.name &&
+          employee_id == o.employee_id &&
+          receipt_url == o.receipt_url &&
+          card_brand == o.card_brand &&
+          pan_suffix == o.pan_suffix &&
+          entry_method == o.entry_method &&
+          payment_note == o.payment_note &&
+          total_money == o.total_money &&
+          tendered_money == o.tendered_money &&
+          change_back_money == o.change_back_money &&
+          refunded_money == o.refunded_money
+    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, type, name, employee_id, receipt_url, card_brand, pan_suffix, entry_method, payment_note, total_money, tendered_money, change_back_money, refunded_money].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_timecard.rb

@@ -0,0 +1,271 @@
+=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
+  # Represents a timecard for an employee.
+  class V1Timecard
+    # The timecard's unique ID.
+    attr_accessor :id
+
+    # The ID of the employee the timecard is associated with.
+    attr_accessor :employee_id
+
+    # If true, the timecard was deleted by the merchant, and it is no longer valid.
+    attr_accessor :deleted
+
+    # The clock-in time for the timecard, in ISO 8601 format.
+    attr_accessor :clockin_time
+
+    # The clock-out time for the timecard, in ISO 8601 format. Provide this value only if importing timecard information from another system.
+    attr_accessor :clockout_time
+
+    # The ID of the location the employee clocked in from, if any.
+    attr_accessor :clockin_location_id
+
+    # The ID of the location the employee clocked out from. Provide this value only if importing timecard information from another system.
+    attr_accessor :clockout_location_id
+
+    # The time when the timecard was created, in ISO 8601 format.
+    attr_accessor :created_at
+
+    # The time when the timecard was most recently updated, in ISO 8601 format.
+    attr_accessor :updated_at
+
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'employee_id' => :'employee_id',
+        :'deleted' => :'deleted',
+        :'clockin_time' => :'clockin_time',
+        :'clockout_time' => :'clockout_time',
+        :'clockin_location_id' => :'clockin_location_id',
+        :'clockout_location_id' => :'clockout_location_id',
+        :'created_at' => :'created_at',
+        :'updated_at' => :'updated_at'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'id' => :'String',
+        :'employee_id' => :'String',
+        :'deleted' => :'BOOLEAN',
+        :'clockin_time' => :'String',
+        :'clockout_time' => :'String',
+        :'clockin_location_id' => :'String',
+        :'clockout_location_id' => :'String',
+        :'created_at' => :'String',
+        :'updated_at' => :'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?(:'employee_id')
+        self.employee_id = attributes[:'employee_id']
+      end
+
+      if attributes.has_key?(:'deleted')
+        self.deleted = attributes[:'deleted']
+      end
+
+      if attributes.has_key?(:'clockin_time')
+        self.clockin_time = attributes[:'clockin_time']
+      end
+
+      if attributes.has_key?(:'clockout_time')
+        self.clockout_time = attributes[:'clockout_time']
+      end
+
+      if attributes.has_key?(:'clockin_location_id')
+        self.clockin_location_id = attributes[:'clockin_location_id']
+      end
+
+      if attributes.has_key?(:'clockout_location_id')
+        self.clockout_location_id = attributes[:'clockout_location_id']
+      end
+
+      if attributes.has_key?(:'created_at')
+        self.created_at = attributes[:'created_at']
+      end
+
+      if attributes.has_key?(:'updated_at')
+        self.updated_at = attributes[:'updated_at']
+      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 @employee_id.nil?
+        invalid_properties.push("invalid value for 'employee_id', employee_id 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 @employee_id.nil?
+      return 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 &&
+          id == o.id &&
+          employee_id == o.employee_id &&
+          deleted == o.deleted &&
+          clockin_time == o.clockin_time &&
+          clockout_time == o.clockout_time &&
+          clockin_location_id == o.clockin_location_id &&
+          clockout_location_id == o.clockout_location_id &&
+          created_at == o.created_at &&
+          updated_at == o.updated_at
+    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, employee_id, deleted, clockin_time, clockout_time, clockin_location_id, clockout_location_id, created_at, updated_at].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