square_connect 2.8.0.215 → 2.9.0.220

data/lib/square_connect/api/customers_api.rb

@@ -241,8 +241,8 @@ module SquareConnect
     # Lists a business's customers.
     # @param [Hash] opts the optional parameters
     # @option opts [String] :cursor A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query.  See [Paginating results](#paginatingresults) for more information.
-    # @option opts [String] :sort_field Indicates how Customers should be sorted. Default: `DEFAULT`.
-    # @option opts [String] :sort_order Indicates whether Customers should be sorted in ascending (`ASC`) or descending (`DESC`) order. Default: `ASC`.
+    # @option opts [String] :sort_field Indicates how Customers should be sorted. Default: `DEFAULT`. See [CustomerSortField](#type-customersortfield) for possible values.
+    # @option opts [String] :sort_order Indicates whether Customers should be sorted in ascending (`ASC`) or descending (`DESC`) order. Default: `ASC`. See [SortOrder](#type-sortorder) for possible values.
     # @return [ListCustomersResponse]
     def list_customers(opts = {})
       data, _status_code, _headers = list_customers_with_http_info(opts)
@@ -253,8 +253,8 @@ module SquareConnect
     # Lists a business's customers.
     # @param [Hash] opts the optional parameters
     # @option opts [String] :cursor A pagination cursor returned by a previous call to this endpoint. Provide this to retrieve the next set of results for your original query.  See [Paginating results](#paginatingresults) for more information.
-    # @option opts [String] :sort_field Indicates how Customers should be sorted. Default: `DEFAULT`.
-    # @option opts [String] :sort_order Indicates whether Customers should be sorted in ascending (`ASC`) or descending (`DESC`) order. Default: `ASC`.
+    # @option opts [String] :sort_field Indicates how Customers should be sorted. Default: `DEFAULT`. See [CustomerSortField](#type-customersortfield) for possible values.
+    # @option opts [String] :sort_order Indicates whether Customers should be sorted in ascending (`ASC`) or descending (`DESC`) order. Default: `ASC`. See [SortOrder](#type-sortorder) for possible values.
     # @return [Array<(ListCustomersResponse, Fixnum, Hash)>] ListCustomersResponse data, response status code and response headers
     def list_customers_with_http_info(opts = {})
       if @api_client.config.debugging
@@ -354,6 +354,59 @@ module SquareConnect
       return data, status_code, headers
     end
 
+    # SearchCustomers
+    # Searches a business's customers.
+    # @param body An object containing the fields to POST for the request.  See the corresponding object definition for field details.
+    # @param [Hash] opts the optional parameters
+    # @return [SearchCustomersResponse]
+    def search_customers(body, opts = {})
+      data, _status_code, _headers = search_customers_with_http_info(body, opts)
+      return data
+    end
+
+    # SearchCustomers
+    # Searches a business&#39;s customers.
+    # @param body An object containing the fields to POST for the request.  See the corresponding object definition for field details.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(SearchCustomersResponse, Fixnum, Hash)>] SearchCustomersResponse data, response status code and response headers
+    def search_customers_with_http_info(body, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: CustomersApi.search_customers ..."
+      end
+      # verify the required parameter 'body' is set
+      fail ArgumentError, "Missing the required parameter 'body' when calling CustomersApi.search_customers" if body.nil?
+      # resource path
+      local_var_path = "/v2/customers/search".sub('{format}','json')
+
+      # query parameters
+      query_params = {}
+
+      # header parameters
+      header_params = {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      # HTTP header 'Content-Type'
+      header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
+
+      # form parameters
+      form_params = {}
+
+      # http body (model)
+      post_body = @api_client.object_to_http_body(body)
+      auth_names = ['oauth2']
+      data, status_code, headers = @api_client.call_api(:POST, local_var_path,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => 'SearchCustomersResponse')
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: CustomersApi#search_customers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # UpdateCustomer
     # Updates the details of an existing customer. The ID of the customer may change if the customer has been merged into another customer.  You cannot edit a customer's cards on file with this endpoint. To make changes to a card on file, you must delete the existing card on file with the [DeleteCustomerCard](#endpoint-deletecustomercard) endpoint, then create a new one with the [CreateCustomerCard](#endpoint-createcustomercard) endpoint.
     # @param customer_id The ID of the customer to update.

data/lib/square_connect/api_client.rb

@@ -30,7 +30,7 @@ module SquareConnect
       @config = config
 
       # Construct user agent string. Returns slightly different string for JRuby
-      @user_agent = "Square-Connect-Ruby/2.8.0"
+      @user_agent = "Square-Connect-Ruby/2.9.0"
 
       @default_headers = {
         'Content-Type' => "application/json",

data/lib/square_connect/models/customer.rb

@@ -57,6 +57,30 @@ module SquareConnect
     # The groups the customer belongs to.
     attr_accessor :groups
 
+    # A creation source represents the method used to create the customer profile.
+    attr_accessor :creation_source
+
+    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
@@ -75,7 +99,8 @@ module SquareConnect
         :'reference_id' => :'reference_id',
         :'note' => :'note',
         :'preferences' => :'preferences',
-        :'groups' => :'groups'
+        :'groups' => :'groups',
+        :'creation_source' => :'creation_source'
       }
     end
 
@@ -96,7 +121,8 @@ module SquareConnect
         :'reference_id' => :'String',
         :'note' => :'String',
         :'preferences' => :'CustomerPreferences',
-        :'groups' => :'Array<CustomerGroupInfo>'
+        :'groups' => :'Array<CustomerGroupInfo>',
+        :'creation_source' => :'String'
       }
     end
 
@@ -172,6 +198,10 @@ module SquareConnect
         end
       end
 
+      if attributes.has_key?(:'creation_source')
+        self.creation_source = attributes[:'creation_source']
+      end
+
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -199,9 +229,21 @@ module SquareConnect
       return false if @id.nil?
       return false if @created_at.nil?
       return false if @updated_at.nil?
+      creation_source_validator = EnumAttributeValidator.new('String', ["OTHER", "APPOINTMENTS", "COUPON", "DELETION_RECOVERY", "DIRECTORY", "EGIFTING", "EMAIL_COLLECTION", "FEEDBACK", "IMPORT", "INVOICES", "LOYALTY", "MARKETING", "MERGE", "ONLINE_STORE", "INSTANT_PROFILE", "TERMINAL", "THIRD_PARTY", "THIRD_PARTY_IMPORT", "UNMERGE_RECOVERY"])
+      return false unless creation_source_validator.valid?(@creation_source)
       return true
     end
 
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] creation_source Object to be assigned
+    def creation_source=(creation_source)
+      validator = EnumAttributeValidator.new('String', ["OTHER", "APPOINTMENTS", "COUPON", "DELETION_RECOVERY", "DIRECTORY", "EGIFTING", "EMAIL_COLLECTION", "FEEDBACK", "IMPORT", "INVOICES", "LOYALTY", "MARKETING", "MERGE", "ONLINE_STORE", "INSTANT_PROFILE", "TERMINAL", "THIRD_PARTY", "THIRD_PARTY_IMPORT", "UNMERGE_RECOVERY"])
+      unless validator.valid?(creation_source)
+        fail ArgumentError, "invalid value for 'creation_source', must be one of #{validator.allowable_values}."
+      end
+      @creation_source = creation_source
+    end
+
     # Checks equality by comparing each attribute.
     # @param [Object] Object to be compared
     def ==(o)
@@ -221,7 +263,8 @@ module SquareConnect
           reference_id == o.reference_id &&
           note == o.note &&
           preferences == o.preferences &&
-          groups == o.groups
+          groups == o.groups &&
+          creation_source == o.creation_source
     end
 
     # @see the `==` method
@@ -233,7 +276,7 @@ module SquareConnect
     # 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, preferences, groups].hash
+      [id, created_at, updated_at, cards, given_name, family_name, nickname, company_name, email_address, address, phone_number, reference_id, note, preferences, groups, creation_source].hash
     end
 
     # Builds the object from hash

data/lib/square_connect/models/customer_creation_source.rb

@@ -0,0 +1,36 @@
+=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 CustomerCreationSource
+    
+    OTHER = "OTHER".freeze
+    APPOINTMENTS = "APPOINTMENTS".freeze
+    COUPON = "COUPON".freeze
+    DELETION_RECOVERY = "DELETION_RECOVERY".freeze
+    DIRECTORY = "DIRECTORY".freeze
+    EGIFTING = "EGIFTING".freeze
+    EMAIL_COLLECTION = "EMAIL_COLLECTION".freeze
+    FEEDBACK = "FEEDBACK".freeze
+    IMPORT = "IMPORT".freeze
+    INVOICES = "INVOICES".freeze
+    LOYALTY = "LOYALTY".freeze
+    MARKETING = "MARKETING".freeze
+    MERGE = "MERGE".freeze
+    ONLINE_STORE = "ONLINE_STORE".freeze
+    INSTANT_PROFILE = "INSTANT_PROFILE".freeze
+    TERMINAL = "TERMINAL".freeze
+    THIRD_PARTY = "THIRD_PARTY".freeze
+    THIRD_PARTY_IMPORT = "THIRD_PARTY_IMPORT".freeze
+    UNMERGE_RECOVERY = "UNMERGE_RECOVERY".freeze
+  end
+
+end

data/lib/square_connect/models/customer_creation_source_filter.rb

@@ -0,0 +1,231 @@
+=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
+  # Creation source filter.  If one or more creation sources are set, customer profiles are included in, or excluded from, the result if they match at least one of the filter criteria.
+  class CustomerCreationSourceFilter
+    # The list of creation sources used as filtering criteria.
+    attr_accessor :values
+
+    # Indicates whether a customer profile matching the filter criteria should be included in the result or excluded from the result. Default: `INCLUDE`. See [CustomerInclusionExclusion](#type-customerinclusionexclusion) for possible values.
+    attr_accessor :rule
+
+    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
+      {
+        :'values' => :'values',
+        :'rule' => :'rule'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'values' => :'Array<String>',
+        :'rule' => :'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?(:'values')
+        if (value = attributes[:'values']).is_a?(Array)
+          self.values = value
+        end
+      end
+
+      if attributes.has_key?(:'rule')
+        self.rule = attributes[:'rule']
+      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?
+      rule_validator = EnumAttributeValidator.new('String', ["INCLUDE", "EXCLUDE"])
+      return false unless rule_validator.valid?(@rule)
+      return true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] rule Object to be assigned
+    def rule=(rule)
+      validator = EnumAttributeValidator.new('String', ["INCLUDE", "EXCLUDE"])
+      unless validator.valid?(rule)
+        fail ArgumentError, "invalid value for 'rule', must be one of #{validator.allowable_values}."
+      end
+      @rule = rule
+    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 &&
+          values == o.values &&
+          rule == o.rule
+    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
+      [values, rule].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