square_connect 2.0.0 → 2.0.2.13

data/lib/square_connect/models/customer.rb

@@ -1,17 +1,16 @@
 =begin
-Square Connect API
+#Square Connect API
 
 OpenAPI spec version: 2.0
 
 Generated by: https://github.com/swagger-api/swagger-codegen.git
 
-
 =end
 
 require 'date'
 
 module SquareConnect
-  # 
+  # Represents one of a business's customers, which can have one or more cards on file associated with it.
   class Customer
     # The customer's unique ID.
     attr_accessor :id
@@ -19,69 +18,64 @@ module SquareConnect
     # The time when the customer was created, in RFC 3339 format.
     attr_accessor :created_at
 
-    # The time when the customer was updated, in RFC 3339 format.
+    # The time when the customer was last updated, in RFC 3339 format.
     attr_accessor :updated_at
 
-    # Cards on file for the customer.
+    # The non-confidential details of the customer's cards on file.
     attr_accessor :cards
 
-    # 
+    # The customer's given (i.e., first) name.
     attr_accessor :given_name
 
-    # 
+    # The customer's family (i.e., last) name.
     attr_accessor :family_name
 
-    # 
+    # The customer's nickname.
     attr_accessor :nickname
 
-    # 
+    # The name of the customer's company.
     attr_accessor :company_name
 
-    # 
+    # The customer's email address.
     attr_accessor :email_address
 
-    # 
+    # The customer's physical address.
     attr_accessor :address
 
-    # 
+    # The customer's phone number.
     attr_accessor :phone_number
 
-    # 
+    # A second ID you can set to associate the customer with an entity in another system.
     attr_accessor :reference_id
 
-    # 
+    # A note to associate with the customer.
     attr_accessor :note
 
+    # The customer's preferences.
+    attr_accessor :preferences
+
+    # The groups the customer belongs to.
+    attr_accessor :groups
+
+
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        
         :'id' => :'id',
-        
         :'created_at' => :'created_at',
-        
         :'updated_at' => :'updated_at',
-        
         :'cards' => :'cards',
-        
         :'given_name' => :'given_name',
-        
         :'family_name' => :'family_name',
-        
         :'nickname' => :'nickname',
-        
         :'company_name' => :'company_name',
-        
         :'email_address' => :'email_address',
-        
         :'address' => :'address',
-        
         :'phone_number' => :'phone_number',
-        
         :'reference_id' => :'reference_id',
-        
-        :'note' => :'note'
-        
+        :'note' => :'note',
+        :'preferences' => :'preferences',
+        :'groups' => :'groups'
       }
     end
 
@@ -100,75 +94,116 @@ module SquareConnect
         :'address' => :'Address',
         :'phone_number' => :'String',
         :'reference_id' => :'String',
-        :'note' => :'String'
-        
+        :'note' => :'String',
+        :'preferences' => :'CustomerPreferences',
+        :'groups' => :'Array<CustomerGroupInfo>'
       }
     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.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}
+      attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
 
-      
-      if attributes[:'id']
+      if attributes.has_key?(:'id')
         self.id = attributes[:'id']
       end
-      
-      if attributes[:'created_at']
+
+      if attributes.has_key?(:'created_at')
         self.created_at = attributes[:'created_at']
       end
-      
-      if attributes[:'updated_at']
+
+      if attributes.has_key?(:'updated_at')
         self.updated_at = attributes[:'updated_at']
       end
-      
-      if attributes[:'cards']
+
+      if attributes.has_key?(:'cards')
         if (value = attributes[:'cards']).is_a?(Array)
           self.cards = value
         end
       end
-      
-      if attributes[:'given_name']
+
+      if attributes.has_key?(:'given_name')
         self.given_name = attributes[:'given_name']
       end
-      
-      if attributes[:'family_name']
+
+      if attributes.has_key?(:'family_name')
         self.family_name = attributes[:'family_name']
       end
-      
-      if attributes[:'nickname']
+
+      if attributes.has_key?(:'nickname')
         self.nickname = attributes[:'nickname']
       end
-      
-      if attributes[:'company_name']
+
+      if attributes.has_key?(:'company_name')
         self.company_name = attributes[:'company_name']
       end
-      
-      if attributes[:'email_address']
+
+      if attributes.has_key?(:'email_address')
         self.email_address = attributes[:'email_address']
       end
-      
-      if attributes[:'address']
+
+      if attributes.has_key?(:'address')
         self.address = attributes[:'address']
       end
-      
-      if attributes[:'phone_number']
+
+      if attributes.has_key?(:'phone_number')
         self.phone_number = attributes[:'phone_number']
       end
-      
-      if attributes[:'reference_id']
+
+      if attributes.has_key?(:'reference_id')
         self.reference_id = attributes[:'reference_id']
       end
-      
-      if attributes[:'note']
+
+      if attributes.has_key?(:'note')
         self.note = attributes[:'note']
       end
-      
+
+      if attributes.has_key?(:'preferences')
+        self.preferences = attributes[:'preferences']
+      end
+
+      if attributes.has_key?(:'groups')
+        if (value = attributes[:'groups']).is_a?(Array)
+          self.groups = value
+        end
+      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 @id.nil?
+        invalid_properties.push("invalid value for 'id', id cannot be nil.")
+      end
+
+      if @created_at.nil?
+        invalid_properties.push("invalid value for 'created_at', created_at cannot be nil.")
+      end
+
+      if @updated_at.nil?
+        invalid_properties.push("invalid value for 'updated_at', updated_at 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 @id.nil?
+      return false if @created_at.nil?
+      return false if @updated_at.nil?
+      return true
     end
 
-    # Check equality by comparing each attribute.
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
     def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
@@ -184,39 +219,47 @@ module SquareConnect
           address == o.address &&
           phone_number == o.phone_number &&
           reference_id == o.reference_id &&
-          note == o.note
+          note == o.note &&
+          preferences == o.preferences &&
+          groups == o.groups
     end
 
     # @see the `==` method
+    # @param [Object] Object to be compared
     def eql?(o)
       self == o
     end
 
-    # Calculate hash code according to all attributes.
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
     def hash
-      [id, created_at, updated_at, cards, given_name, family_name, nickname, company_name, email_address, address, phone_number, reference_id, note].hash
+      [id, created_at, updated_at, cards, given_name, family_name, nickname, company_name, email_address, address, phone_number, reference_id, note, preferences, groups].hash
     end
 
-    # build the object from hash
+    # 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 =~ /^Array<(.*)>/i
+        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) } )
-          else
-            #TODO show warning in debug mode
           end
         elsif !attributes[self.class.attribute_map[key]].nil?
           self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
-        else
-          # data not found in attributes(hash), not an issue as the data can be optional
-        end
+        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
@@ -230,15 +273,18 @@ module SquareConnect
       when :Float
         value.to_f
       when :BOOLEAN
-        if value.to_s =~ /^(true|t|yes|y|1)$/i
+        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/
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
         k_type = Regexp.last_match[:k_type]
         v_type = Regexp.last_match[:v_type]
         {}.tap do |hash|
@@ -247,21 +293,25 @@ module SquareConnect
           end
         end
       else # model
-        _model = SquareConnect.const_get(type).new
-        _model.build_from_hash(value)
+        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_body (backward compatibility))
+    # 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
 
-    # return the object in the form of hash
+    # 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|
@@ -272,8 +322,10 @@ module SquareConnect
       hash
     end
 
-    # Method to output non-array value in the form of hash
+    # 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) }
@@ -289,4 +341,5 @@ module SquareConnect
     end
 
   end
+
 end

data/lib/square_connect/models/customer_group_info.rb

@@ -0,0 +1,206 @@
+=begin
+#Square Connect API
+
+OpenAPI spec version: 2.0
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+
+=end
+
+require 'date'
+
+module SquareConnect
+  # Contains some brief information about a customer group with its identifier included.
+  class CustomerGroupInfo
+    # The ID of the customer group.
+    attr_accessor :id
+
+    # The name of the customer group.
+    attr_accessor :name
+
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'id' => :'id',
+        :'name' => :'name'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'id' => :'String',
+        :'name' => :'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
+
+    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 @id.nil?
+        invalid_properties.push("invalid value for 'id', id cannot be nil.")
+      end
+
+      if @name.nil?
+        invalid_properties.push("invalid value for 'name', name 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 @id.nil?
+      return false if @name.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 &&
+          name == o.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 [Fixnum] Hash code
+    def hash
+      [id, 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 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