square.rb 6.4.0.20200923 → 9.0.0.20210226

data/lib/square/api/v1_transactions_api.rb

@@ -5,87 +5,10 @@ module Square
       super(config, http_call_back: http_call_back)
     end
 
-    # Provides non-confidential details for all of a location's associated bank
-    # accounts. This endpoint does not provide full bank account numbers, and
-    # there is no way to obtain a full bank account number with the Connect API.
-    # @param [String] location_id Required parameter: The ID of the location to
-    # list bank accounts for.
-    # @return [List of V1BankAccount Hash] response from the API call
-    def list_bank_accounts(location_id:)
-      warn 'Endpoint list_bank_accounts in V1TransactionsApi is deprecated'
-      # Prepare query url.
-      _query_builder = config.get_base_uri
-      _query_builder << '/v1/{location_id}/bank-accounts'
-      _query_builder = APIHelper.append_url_with_template_parameters(
-        _query_builder,
-        'location_id' => location_id
-      )
-      _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
-
-    # Provides non-confidential details for a merchant's associated bank
-    # account. This endpoint does not provide full bank account numbers, and
-    # there is no way to obtain a full bank account number with the Connect API.
-    # @param [String] location_id Required parameter: The ID of the bank
-    # account's associated location.
-    # @param [String] bank_account_id Required parameter: The bank account's
-    # Square-issued ID. You obtain this value from Settlement objects
-    # returned.
-    # @return [V1BankAccount Hash] response from the API call
-    def retrieve_bank_account(location_id:,
-                              bank_account_id:)
-      warn 'Endpoint retrieve_bank_account in V1TransactionsApi is deprecated'
-      # Prepare query url.
-      _query_builder = config.get_base_uri
-      _query_builder << '/v1/{location_id}/bank-accounts/{bank_account_id}'
-      _query_builder = APIHelper.append_url_with_template_parameters(
-        _query_builder,
-        'location_id' => location_id,
-        'bank_account_id' => bank_account_id
-      )
-      _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
-
     # Provides summary information for a merchant's online store orders.
     # @param [String] location_id Required parameter: The ID of the location to
     # list online store orders for.
-    # @param [SortOrder] order Optional parameter: TThe order in which payments
+    # @param [SortOrder] order Optional parameter: The order in which payments
     # are listed in the response.
     # @param [Integer] limit Optional parameter: The maximum number of payments
     # to return in a single response. This value cannot exceed 200.
@@ -102,7 +25,7 @@ module Square
       _query_builder << '/v1/{location_id}/orders'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'location_id' => location_id
+        'location_id' => { 'value' => location_id, 'encode' => true }
       )
       _query_builder = APIHelper.append_url_with_query_parameters(
         _query_builder,
@@ -128,7 +51,9 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
     end
 
     # Provides comprehensive information for a single online store order,
@@ -146,8 +71,8 @@ module Square
       _query_builder << '/v1/{location_id}/orders/{order_id}'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'location_id' => location_id,
-        'order_id' => order_id
+        'location_id' => { 'value' => location_id, 'encode' => true },
+        'order_id' => { 'value' => order_id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -167,7 +92,9 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
     end
 
     # Updates the details of an online store order. Every update you perform on
@@ -189,8 +116,8 @@ module Square
       _query_builder << '/v1/{location_id}/orders/{order_id}'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'location_id' => location_id,
-        'order_id' => order_id
+        'location_id' => { 'value' => location_id, 'encode' => true },
+        'order_id' => { 'value' => order_id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -212,7 +139,9 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
     end
 
     # Provides summary information for all payments taken for a given
@@ -260,7 +189,7 @@ module Square
       _query_builder << '/v1/{location_id}/payments'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'location_id' => location_id
+        'location_id' => { 'value' => location_id, 'encode' => true }
       )
       _query_builder = APIHelper.append_url_with_query_parameters(
         _query_builder,
@@ -289,7 +218,9 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
     end
 
     # Provides comprehensive information for a single payment.
@@ -307,8 +238,8 @@ module Square
       _query_builder << '/v1/{location_id}/payments/{payment_id}'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'location_id' => location_id,
-        'payment_id' => payment_id
+        'location_id' => { 'value' => location_id, 'encode' => true },
+        'payment_id' => { 'value' => payment_id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -328,7 +259,9 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
     end
 
     # Provides the details for all refunds initiated by a merchant or any of the
@@ -336,7 +269,7 @@ module Square
     # year in length.
     # @param [String] location_id Required parameter: The ID of the location to
     # list refunds for.
-    # @param [SortOrder] order Optional parameter: TThe order in which payments
+    # @param [SortOrder] order Optional parameter: The order in which payments
     # are listed in the response.
     # @param [String] begin_time Optional parameter: The beginning of the
     # requested reporting period, in ISO 8601 format. If this value is before
@@ -366,7 +299,7 @@ module Square
       _query_builder << '/v1/{location_id}/refunds'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'location_id' => location_id
+        'location_id' => { 'value' => location_id, 'encode' => true }
       )
       _query_builder = APIHelper.append_url_with_query_parameters(
         _query_builder,
@@ -394,7 +327,9 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
     end
 
     # Issues a refund for a previously processed payment. You must issue
@@ -420,7 +355,7 @@ module Square
       _query_builder << '/v1/{location_id}/refunds'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'location_id' => location_id
+        'location_id' => { 'value' => location_id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -442,7 +377,9 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
     end
 
     # Provides summary information for all deposits and withdrawals
@@ -485,7 +422,7 @@ module Square
       _query_builder << '/v1/{location_id}/settlements'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'location_id' => location_id
+        'location_id' => { 'value' => location_id, 'encode' => true }
       )
       _query_builder = APIHelper.append_url_with_query_parameters(
         _query_builder,
@@ -514,7 +451,9 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
     end
 
     # Provides comprehensive information for a single settlement.
@@ -545,8 +484,8 @@ module Square
       _query_builder << '/v1/{location_id}/settlements/{settlement_id}'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'location_id' => location_id,
-        'settlement_id' => settlement_id
+        'location_id' => { 'value' => location_id, 'encode' => true },
+        'settlement_id' => { 'value' => settlement_id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -566,7 +505,9 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
     end
   end
 end

data/lib/square/api_helper.rb

@@ -36,17 +36,22 @@ module Square
       # Return if there are no parameters to replace.
       return query_builder if parameters.nil?
 
-      # Iterate and append parameters.
-      parameters.each do |key, value|
-        replace_value = ''
-
-        if value.nil?
+      parameters.each do |key, val|
+        if val.nil?
           replace_value = ''
-        elsif value.instance_of? Array
-          value.map! { |element| CGI.escape(element.to_s) }
-          replace_value = value.join('/')
+        elsif val['value'].instance_of? Array
+          if val['encode'] == true
+            val['value'].map! { |element| CGI.escape(element.to_s) }
+          else
+            val['value'].map!(&:to_s)
+          end
+          replace_value = val['value'].join('/')
         else
-          replace_value = CGI.escape(value.to_s)
+          replace_value = if val['encode'] == true
+                            CGI.escape(val['value'].to_s)
+                          else
+                            val['value'].to_s
+                          end
         end
 
         # Find the template parameter and replace it with its value.

data/lib/square/client.rb

@@ -4,7 +4,7 @@ module Square
     attr_reader :config
 
     def sdk_version
-      '6.4.0.20200923'
+      '9.0.0.20210226'
     end
 
     def square_version
@@ -23,12 +23,6 @@ module Square
       @o_auth ||= OAuthApi.new config
     end
 
-    # Access to v1_locations controller.
-    # @return [V1LocationsApi] Returns the controller instance.
-    def v1_locations
-      @v1_locations ||= V1LocationsApi.new config
-    end
-
     # Access to v1_employees controller.
     # @return [V1EmployeesApi] Returns the controller instance.
     def v1_employees
@@ -41,12 +35,6 @@ module Square
       @v1_transactions ||= V1TransactionsApi.new config
     end
 
-    # Access to v1_items controller.
-    # @return [V1ItemsApi] Returns the controller instance.
-    def v1_items
-      @v1_items ||= V1ItemsApi.new config
-    end
-
     # Access to apple_pay controller.
     # @return [ApplePayApi] Returns the controller instance.
     def apple_pay
@@ -59,6 +47,12 @@ module Square
       @bank_accounts ||= BankAccountsApi.new config
     end
 
+    # Access to bookings controller.
+    # @return [BookingsApi] Returns the controller instance.
+    def bookings
+      @bookings ||= BookingsApi.new config
+    end
+
     # Access to cash_drawers controller.
     # @return [CashDrawersApi] Returns the controller instance.
     def cash_drawers
@@ -193,13 +187,15 @@ module Square
 
     def initialize(timeout: 60, max_retries: 0, retry_interval: 1,
                    backoff_factor: 1, environment: 'production',
-                   square_version: '2020-09-23', access_token: 'TODO: Replace',
+                   custom_url: 'https://connect.squareup.com',
+                   square_version: '2021-02-26', access_token: 'TODO: Replace',
                    additional_headers: {}, config: nil)
       @config = if config.nil?
                   Configuration.new(timeout: timeout, max_retries: max_retries,
                                     retry_interval: retry_interval,
                                     backoff_factor: backoff_factor,
                                     environment: environment,
+                                    custom_url: custom_url,
                                     square_version: square_version,
                                     access_token: access_token,
                                     additional_headers: additional_headers)

data/lib/square/configuration.rb

@@ -9,6 +9,7 @@ module Square
     attr_reader :retry_interval
     attr_reader :backoff_factor
     attr_reader :environment
+    attr_reader :custom_url
     attr_reader :square_version
     attr_reader :access_token
 
@@ -22,7 +23,8 @@ module Square
 
     def initialize(timeout: 60, max_retries: 0, retry_interval: 1,
                    backoff_factor: 1, environment: 'production',
-                   square_version: '2020-09-23', access_token: 'TODO: Replace',
+                   custom_url: 'https://connect.squareup.com',
+                   square_version: '2021-02-26', access_token: 'TODO: Replace',
                    additional_headers: {})
       # The value to use for connection timeout
       @timeout = timeout
@@ -40,10 +42,13 @@ module Square
       # Current API environment
       @environment = String(environment)
 
+      # Sets the base URL requests are made to. Defaults to `https://connect.squareup.com`
+      @custom_url = custom_url
+
       # Square Connect API versions
       @square_version = square_version
 
-      # OAuth 2.0 Access Token
+      # The OAuth 2.0 Access Token to use for API requests.
       @access_token = access_token
 
       # Additional headers to add to each API request
@@ -54,13 +59,15 @@ module Square
     end
 
     def clone_with(timeout: nil, max_retries: nil, retry_interval: nil,
-                   backoff_factor: nil, environment: nil, square_version: nil,
-                   access_token: nil, additional_headers: nil)
+                   backoff_factor: nil, environment: nil, custom_url: nil,
+                   square_version: nil, access_token: nil,
+                   additional_headers: nil)
       timeout ||= self.timeout
       max_retries ||= self.max_retries
       retry_interval ||= self.retry_interval
       backoff_factor ||= self.backoff_factor
       environment ||= self.environment
+      custom_url ||= self.custom_url
       square_version ||= self.square_version
       access_token ||= self.access_token
       additional_headers ||= self.additional_headers
@@ -68,7 +75,7 @@ module Square
       Configuration.new(timeout: timeout, max_retries: max_retries,
                         retry_interval: retry_interval,
                         backoff_factor: backoff_factor,
-                        environment: environment,
+                        environment: environment, custom_url: custom_url,
                         square_version: square_version,
                         access_token: access_token,
                         additional_headers: additional_headers)
@@ -87,6 +94,9 @@ module Square
       },
       'sandbox' => {
         'default' => 'https://connect.squareupsandbox.com'
+      },
+      'custom' => {
+        'default' => '{custom_url}'
       }
     }.freeze
 
@@ -95,7 +105,12 @@ module Square
     # required.
     # @return [String] The base URI.
     def get_base_uri(server = 'default')
-      ENVIRONMENTS[environment][server].clone
+      parameters = {
+        'custom_url' => { 'value' => custom_url, 'encode' => false }
+      }
+      APIHelper.append_url_with_template_parameters(
+        ENVIRONMENTS[environment][server], parameters
+      )
     end
   end
 end