square.rb 13.0.0.20210721 → 16.0.0.20211117

data/lib/square/api/terminal_api.rb

@@ -21,7 +21,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
@@ -56,7 +56,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
@@ -162,7 +162,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
@@ -197,7 +197,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.

data/lib/square/api/transactions_api.rb

@@ -5,80 +5,6 @@ module Square
       super(config, http_call_back: http_call_back)
     end
 
-    # Lists refunds for one of a business's locations.
-    # In addition to full or partial tender refunds processed through Square
-    # APIs,
-    # refunds may result from itemized returns or exchanges through Square's
-    # Point of Sale applications.
-    # Refunds with a `status` of `PENDING` are not currently included in this
-    # endpoint's response.
-    # Max results per
-    # [page](https://developer.squareup.com/docs/working-with-apis/pagination):
-    # 50
-    # @param [String] location_id Required parameter: The ID of the location to
-    # list refunds for.
-    # @param [String] begin_time Optional parameter: The beginning of the
-    # requested reporting period, in RFC 3339 format.  See [Date
-    # ranges](https://developer.squareup.com/docs/build-basics/working-with-date
-    # s) for details on date inclusivity/exclusivity.  Default value: The
-    # current time minus one year.
-    # @param [String] end_time Optional parameter: The end of the requested
-    # reporting period, in RFC 3339 format.  See [Date
-    # ranges](https://developer.squareup.com/docs/build-basics/working-with-date
-    # s) for details on date inclusivity/exclusivity.  Default value: The
-    # current time.
-    # @param [SortOrder] sort_order Optional parameter: The order in which
-    # results are listed in the response (`ASC` for oldest first, `DESC` for
-    # newest first).  Default value: `DESC`
-    # @param [String] cursor Optional parameter: 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](https://developer.squareup.com/docs/working-with-apis/pagination)
-    # for more information.
-    # @return [ListRefundsResponse Hash] response from the API call
-    def list_refunds(location_id:,
-                     begin_time: nil,
-                     end_time: nil,
-                     sort_order: nil,
-                     cursor: nil)
-      warn 'Endpoint list_refunds in TransactionsApi is deprecated'
-      # Prepare query url.
-      _query_builder = config.get_base_uri
-      _query_builder << '/v2/locations/{location_id}/refunds'
-      _query_builder = APIHelper.append_url_with_template_parameters(
-        _query_builder,
-        'location_id' => { 'value' => location_id, 'encode' => true }
-      )
-      _query_builder = APIHelper.append_url_with_query_parameters(
-        _query_builder,
-        'begin_time' => begin_time,
-        'end_time' => end_time,
-        'sort_order' => sort_order,
-        'cursor' => cursor
-      )
-      _query_url = APIHelper.clean_url _query_builder
-
-      # Prepare headers.
-      _headers = {
-        'accept' => 'application/json'
-      }
-
-      # Prepare and execute HttpRequest.
-      _request = config.http_client.get(
-        _query_url,
-        headers: _headers
-      )
-      OAuth2.apply(config, _request)
-      _response = execute_request(_request)
-
-      # Return appropriate response type.
-      decoded = APIHelper.json_deserialize(_response.raw_body)
-      _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(
-        _response, data: decoded, errors: _errors
-      )
-    end
-
     # Lists transactions for a particular location.
     # Transactions include payment information from sales and exchanges and
     # refund
@@ -150,67 +76,6 @@ module Square
       )
     end
 
-    # Charges a card represented by a card nonce or a customer's card on file.
-    # Your request to this endpoint must include _either_:
-    # - A value for the `card_nonce` parameter (to charge a card payment token
-    # generated
-    # with the Web Payments SDK)
-    # - Values for the `customer_card_id` and `customer_id` parameters (to
-    # charge
-    # a customer's card on file)
-    # In order for an eCommerce payment to potentially qualify for
-    # [Square chargeback protection](https://squareup.com/help/article/5394),
-    # you
-    # _must_ provide values for the following parameters in your request:
-    # - `buyer_email_address`
-    # - At least one of `billing_address` or `shipping_address`
-    # When this response is returned, the amount of Square's processing fee
-    # might not yet be
-    # calculated. To obtain the processing fee, wait about ten seconds and call
-    # [RetrieveTransaction]($e/Transactions/RetrieveTransaction). See the
-    # `processing_fee_money`
-    # field of each [Tender included]($m/Tender) in the transaction.
-    # @param [String] location_id Required parameter: The ID of the location to
-    # associate the created transaction with.
-    # @param [ChargeRequest] body Required parameter: An object containing the
-    # fields to POST for the request.  See the corresponding object definition
-    # for field details.
-    # @return [ChargeResponse Hash] response from the API call
-    def charge(location_id:,
-               body:)
-      warn 'Endpoint charge in TransactionsApi is deprecated'
-      # Prepare query url.
-      _query_builder = config.get_base_uri
-      _query_builder << '/v2/locations/{location_id}/transactions'
-      _query_builder = APIHelper.append_url_with_template_parameters(
-        _query_builder,
-        'location_id' => { 'value' => location_id, 'encode' => true }
-      )
-      _query_url = APIHelper.clean_url _query_builder
-
-      # Prepare headers.
-      _headers = {
-        'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
-      }
-
-      # Prepare and execute HttpRequest.
-      _request = config.http_client.post(
-        _query_url,
-        headers: _headers,
-        parameters: body.to_json
-      )
-      OAuth2.apply(config, _request)
-      _response = execute_request(_request)
-
-      # Return appropriate response type.
-      decoded = APIHelper.json_deserialize(_response.raw_body)
-      _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(
-        _response, data: decoded, errors: _errors
-      )
-    end
-
     # Retrieves details for a single transaction.
     # @param [String] location_id Required parameter: The ID of the
     # transaction's associated location.
@@ -295,59 +160,6 @@ module Square
       )
     end
 
-    # Initiates a refund for a previously charged tender.
-    # You must issue a refund within 120 days of the associated payment. See
-    # [this article](https://squareup.com/help/us/en/article/5060) for more
-    # information
-    # on refund behavior.
-    # NOTE: Card-present transactions with Interac credit cards **cannot be
-    # refunded using the Connect API**. Interac transactions must refunded
-    # in-person (e.g., dipping the card using POS app).
-    # @param [String] location_id Required parameter: The ID of the original
-    # transaction's associated location.
-    # @param [String] transaction_id Required parameter: The ID of the original
-    # transaction that includes the tender to refund.
-    # @param [CreateRefundRequest] body Required parameter: An object containing
-    # the fields to POST for the request.  See the corresponding object
-    # definition for field details.
-    # @return [CreateRefundResponse Hash] response from the API call
-    def create_refund(location_id:,
-                      transaction_id:,
-                      body:)
-      warn 'Endpoint create_refund in TransactionsApi is deprecated'
-      # Prepare query url.
-      _query_builder = config.get_base_uri
-      _query_builder << '/v2/locations/{location_id}/transactions/{transaction_id}/refund'
-      _query_builder = APIHelper.append_url_with_template_parameters(
-        _query_builder,
-        'location_id' => { 'value' => location_id, 'encode' => true },
-        'transaction_id' => { 'value' => transaction_id, 'encode' => true }
-      )
-      _query_url = APIHelper.clean_url _query_builder
-
-      # Prepare headers.
-      _headers = {
-        'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
-      }
-
-      # Prepare and execute HttpRequest.
-      _request = config.http_client.post(
-        _query_url,
-        headers: _headers,
-        parameters: body.to_json
-      )
-      OAuth2.apply(config, _request)
-      _response = execute_request(_request)
-
-      # Return appropriate response type.
-      decoded = APIHelper.json_deserialize(_response.raw_body)
-      _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(
-        _response, data: decoded, errors: _errors
-      )
-    end
-
     # Cancels a transaction that was created with the
     # [Charge]($e/Transactions/Charge)
     # endpoint with a `delay_capture` value of `true`.

data/lib/square/api/v1_transactions_api.rb

@@ -127,7 +127,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
@@ -369,7 +369,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.

data/lib/square/api_helper.rb

@@ -8,13 +8,14 @@ module Square
     def self.serialize_array(key, array, formatting: 'indexed')
       tuples = []
 
-      if formatting == 'unindexed'
+      case formatting
+      when 'unindexed'
         tuples += array.map { |element| ["#{key}[]", element] }
-      elsif formatting == 'indexed'
+      when 'indexed'
         tuples += array.map.with_index do |element, index|
           ["#{key}[#{index}]", element]
         end
-      elsif formatting == 'plain'
+      when 'plain'
         tuples += array.map { |element| [key, element] }
       else
         raise ArgumentError, 'Invalid format provided.'
@@ -55,7 +56,7 @@ module Square
         end
 
         # Find the template parameter and replace it with its value.
-        query_builder = query_builder.gsub('{' + key.to_s + '}', replace_value)
+        query_builder = query_builder.gsub("{#{key}}", replace_value)
       end
       query_builder
     end
@@ -80,15 +81,16 @@ module Square
         unless value.nil?
           if value.instance_of? Array
             value.compact!
-            query_builder += if array_serialization == 'csv'
+            query_builder += case array_serialization
+                             when 'csv'
                                "#{seperator}#{key}=#{value.map do |element|
                                  CGI.escape(element.to_s)
                                end.join(',')}"
-                             elsif array_serialization == 'psv'
+                             when 'psv'
                                "#{seperator}#{key}=#{value.map do |element|
                                  CGI.escape(element.to_s)
                                end.join('|')}"
-                             elsif array_serialization == 'tsv'
+                             when 'tsv'
                                "#{seperator}#{key}=#{value.map do |element|
                                  CGI.escape(element.to_s)
                                end.join("\t")}"
@@ -114,7 +116,7 @@ module Square
       raise ArgumentError, 'Invalid Url.' unless url.instance_of? String
 
       # Ensure that the urls are absolute.
-      matches = url.match(%r{^(https?:\/\/[^\/]+)})
+      matches = url.match(%r{^(https?://[^/]+)})
       raise ArgumentError, 'Invalid Url format.' if matches.nil?
 
       # Get the http protocol match.
@@ -125,7 +127,7 @@ module Square
 
       # Remove redundant forward slashes.
       query = url[protocol.length...(!index.nil? ? index : url.length)]
-      query.gsub!(%r{\/\/+}, '/')
+      query.gsub!(%r{//+}, '/')
 
       # Get the parameters.
       parameters = !index.nil? ? url[url.index('?')...url.length] : ''
@@ -137,7 +139,7 @@ module Square
     # Parses JSON string.
     # @param [String] A JSON string.
     def self.json_deserialize(json)
-      return JSON.parse(json, symbolize_names: true)
+      JSON.parse(json, symbolize_names: true)
     rescue StandardError
       raise TypeError, 'Server responded with invalid JSON.'
     end
@@ -166,6 +168,7 @@ module Square
       a.each do |key, value_a|
         b.each do |k, value_b|
           next unless key == k
+
           x[k] = []
           if value_a.instance_of? Array
             value_a.each do |v|
@@ -207,13 +210,12 @@ module Square
       elsif obj.instance_of? Array
         if formatting == 'indexed'
           obj.each_with_index do |value, index|
-            retval.merge!(APIHelper.form_encode(value, instance_name + '[' +
-              index.to_s + ']'))
+            retval.merge!(APIHelper.form_encode(value, "#{instance_name}[#{index}]"))
           end
         elsif serializable_types.map { |x| obj[0].is_a? x }.any?
           obj.each do |value|
             abc = if formatting == 'unindexed'
-                    APIHelper.form_encode(value, instance_name + '[]',
+                    APIHelper.form_encode(value, "#{instance_name}[]",
                                           formatting: formatting)
                   else
                     APIHelper.form_encode(value, instance_name,
@@ -223,14 +225,14 @@ module Square
           end
         else
           obj.each_with_index do |value, index|
-            retval.merge!(APIHelper.form_encode(value, instance_name + '[' +
-              index.to_s + ']', formatting: formatting))
+            retval.merge!(APIHelper.form_encode(value, "#{instance_name}[#{index}]",
+                                                formatting: formatting))
           end
         end
       elsif obj.instance_of? Hash
         obj.each do |key, value|
-          retval.merge!(APIHelper.form_encode(value, instance_name + '[' +
-            key.to_s + ']', formatting: formatting))
+          retval.merge!(APIHelper.form_encode(value, "#{instance_name}[#{key}]",
+                                              formatting: formatting))
         end
       elsif obj.instance_of? File
         retval[instance_name] = UploadIO.new(

data/lib/square/client.rb

@@ -4,7 +4,7 @@ module Square
     attr_reader :config
 
     def sdk_version
-      '13.0.0.20210721'
+      '16.0.0.20211117'
     end
 
     def square_version
@@ -23,12 +23,6 @@ module Square
       @o_auth ||= OAuthApi.new config
     end
 
-    # Access to v1_employees controller.
-    # @return [V1EmployeesApi] Returns the controller instance.
-    def v1_employees
-      @v1_employees ||= V1EmployeesApi.new config
-    end
-
     # Access to v1_transactions controller.
     # @return [V1TransactionsApi] Returns the controller instance.
     def v1_transactions
@@ -215,15 +209,16 @@ module Square
       @terminal ||= TerminalApi.new config
     end
 
-    def initialize(timeout: 60, max_retries: 0, retry_interval: 1,
-                   backoff_factor: 2,
+    def initialize(http_client_instance: nil, timeout: 60, max_retries: 0,
+                   retry_interval: 1, backoff_factor: 2,
                    retry_statuses: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524],
                    retry_methods: %i[get put], environment: 'production',
                    custom_url: 'https://connect.squareup.com',
-                   square_version: '2021-07-21', access_token: 'TODO: Replace',
+                   square_version: '2021-11-17', access_token: '',
                    additional_headers: {}, config: nil)
       @config = if config.nil?
-                  Configuration.new(timeout: timeout, max_retries: max_retries,
+                  Configuration.new(http_client_instance: http_client_instance,
+                                    timeout: timeout, max_retries: max_retries,
                                     retry_interval: retry_interval,
                                     backoff_factor: backoff_factor,
                                     retry_statuses: retry_statuses,

data/lib/square/configuration.rb

@@ -3,17 +3,9 @@ module Square
   # are configured in this class.
   class Configuration
     # The attribute readers for properties.
-    attr_reader :http_client
-    attr_reader :timeout
-    attr_reader :max_retries
-    attr_reader :retry_interval
-    attr_reader :backoff_factor
-    attr_reader :retry_statuses
-    attr_reader :retry_methods
-    attr_reader :environment
-    attr_reader :custom_url
-    attr_reader :square_version
-    attr_reader :access_token
+    attr_reader :http_client, :http_client_instance, :timeout, :max_retries, :retry_interval,
+                :backoff_factor, :retry_statuses, :retry_methods, :environment, :custom_url,
+                :square_version, :access_token
 
     def additional_headers
       @additional_headers.clone
@@ -23,13 +15,16 @@ module Square
       attr_reader :environments
     end
 
-    def initialize(timeout: 60, max_retries: 0, retry_interval: 1,
-                   backoff_factor: 2,
+    def initialize(http_client_instance: nil, timeout: 60, max_retries: 0,
+                   retry_interval: 1, backoff_factor: 2,
                    retry_statuses: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524],
                    retry_methods: %i[get put], environment: 'production',
                    custom_url: 'https://connect.squareup.com',
-                   square_version: '2021-07-21', access_token: 'TODO: Replace',
+                   square_version: '2021-11-17', access_token: '',
                    additional_headers: {})
+      # The Http Client passed from the sdk user for making requests
+      @http_client_instance = http_client_instance
+
       # The value to use for connection timeout
       @timeout = timeout
 
@@ -68,10 +63,12 @@ module Square
       @http_client = create_http_client
     end
 
-    def clone_with(timeout: nil, max_retries: nil, retry_interval: nil,
-                   backoff_factor: nil, retry_statuses: nil, retry_methods: nil,
-                   environment: nil, custom_url: nil, square_version: nil,
-                   access_token: nil, additional_headers: nil)
+    def clone_with(http_client_instance: nil, timeout: nil, max_retries: nil,
+                   retry_interval: nil, backoff_factor: nil,
+                   retry_statuses: nil, retry_methods: nil, environment: nil,
+                   custom_url: nil, square_version: nil, access_token: nil,
+                   additional_headers: nil)
+      http_client_instance ||= self.http_client_instance
       timeout ||= self.timeout
       max_retries ||= self.max_retries
       retry_interval ||= self.retry_interval
@@ -84,7 +81,8 @@ module Square
       access_token ||= self.access_token
       additional_headers ||= self.additional_headers
 
-      Configuration.new(timeout: timeout, max_retries: max_retries,
+      Configuration.new(http_client_instance: http_client_instance,
+                        timeout: timeout, max_retries: max_retries,
                         retry_interval: retry_interval,
                         backoff_factor: backoff_factor,
                         retry_statuses: retry_statuses,
@@ -99,7 +97,8 @@ module Square
                         retry_interval: retry_interval,
                         backoff_factor: backoff_factor,
                         retry_statuses: retry_statuses,
-                        retry_methods: retry_methods)
+                        retry_methods: retry_methods,
+                        http_client_instance: http_client_instance)
     end
 
     # All the environments the SDK can run in.

data/lib/square/http/api_response.rb

@@ -25,7 +25,7 @@ module Square
           end.new(*data.values)
 
           @cursor = data.fetch(:cursor, nil)
-          data.reject! { |k| k == :cursor || k == :errors }
+          data.reject! { |k| %i[cursor errors].include?(k) }
           @data = Struct.new(*data.keys).new(*data.values) if data.keys.any?
         end
       else

data/lib/square/http/faraday_client.rb

@@ -7,7 +7,25 @@ module Square
     # The constructor.
     def initialize(timeout:, max_retries:, retry_interval:,
                    backoff_factor:, retry_statuses:, retry_methods:,
-                   cache: false, verify: true)
+                   http_client_instance: nil, cache: false, verify: true)
+      if http_client_instance.nil?
+        create_connection(timeout: timeout, max_retries: max_retries,
+                          retry_interval: retry_interval, backoff_factor: backoff_factor,
+                          retry_statuses: retry_statuses, retry_methods: retry_methods,
+                          cache: cache, verify: verify)
+      else
+        if http_client_instance.instance_variable_get('@connection').nil?
+          raise ArgumentError,
+                "`connection` cannot be nil in `#{self.class}`. Please specify a valid value."
+        end
+        @connection = http_client_instance.instance_variable_get('@connection')
+      end
+    end
+
+    # Method to initialize connection.
+    def create_connection(timeout:, max_retries:, retry_interval:,
+                          backoff_factor:, retry_statuses:, retry_methods:,
+                          cache: false, verify: true)
       @connection = Faraday.new do |faraday|
         faraday.use Faraday::HttpCache, serializer: Marshal if cache
         faraday.use FaradayMiddleware::FollowRedirects
@@ -22,8 +40,9 @@ module Square
                                 methods: retry_methods
         faraday.adapter Faraday.default_adapter
         faraday.options[:params_encoder] = Faraday::FlatParamsEncoder
-        faraday.options[:timeout] = timeout if timeout > 0
+        faraday.options[:timeout] = timeout if timeout.positive?
       end
+      @connection
     end
 
     # Method overridden from HttpClient.

data/lib/square/utilities/date_time_helper.rb

@@ -6,7 +6,7 @@ module Square
     # @param [DateTime] The DateTime object
     # @return [String] The rfc1123 formatted datetime string
     def self.to_rfc1123(date_time)
-      date_time.httpdate unless date_time.nil?
+      date_time&.httpdate
     end
 
     # Safely converts a map of DateTime objects into a map of rfc1123 format string
@@ -86,7 +86,7 @@ module Square
     # @param [DateTime] The DateTime object
     # @return [String] The rfc3339 formatted datetime string
     def self.to_rfc3339(date_time)
-      date_time.rfc3339 unless date_time.nil?
+      date_time&.rfc3339
     end
 
     # Safely converts a map of DateTime objects into a map of rfc1123 format string

data/lib/square/utilities/file_wrapper.rb

@@ -1,8 +1,7 @@
 module Square
   # A utility to allow users to set the content-type for files
   class FileWrapper
-    attr_reader :content_type
-    attr_reader :file
+    attr_reader :content_type, :file
 
     def initialize(file, content_type: 'application/octet-stream')
       @file = file