square.rb 26.1.0.20230119 → 27.0.0.20230419

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ac8d00e1d947c816019d207e36e19a85ef2f8d66e3b5c4295e3e19f6cfcd5af6
-  data.tar.gz: ba91ef39e6e11e16af9a859abe126cd8f25e0d0751a65a101e63dfb0bbbf4718
+  metadata.gz: fdabb66c5a5371d040a4be402521d22cbbae8048a8a454d86de0d3ac139efd73
+  data.tar.gz: cd7609d304a6ff18b1fb32ae192389f0aaec364f8f0af3f3befa192b3141e4be
 SHA512:
-  metadata.gz: 23f2218d4d9757a648c69c5d6d21eb764f121695c6a11ac80607f24bb86301745f410b1103937ad49a157f150784ea1d396ea57393d0743c0742848b8beba0fa
-  data.tar.gz: fc4af83a8b04a151839c45f6f0c632f2b6b5b65abfcde66027d89714ac8566770b5f70407d021337d7cae3daa67957b06ca373eaf4b3b6791aef13ae1029ca87
+  metadata.gz: 8400694e8fe8d5c33cf5825cddeb92a1965abf7f9441df640ef0fbeff21ab700a006c349d9449a86f4c7b39a8be4e37815c18159d3de093a6a4196335ee7f843
+  data.tar.gz: c7ebf17f937a606f6ac3b82a46a532015340e8b906fa1908cfc615e1f46527491f1853b0e6d66d054634a294312385befee3ea482c67dd025400d034ea0db36c

data/README.md

@@ -126,6 +126,9 @@ rake
 * [Mobile Authorization]
 * [OAuth]
 
+### Webhook Subscriptions
+* [Webhook Subscriptions]
+
 ## Deprecated APIs
 
 The following Square APIs are [deprecated](https://developer.squareup.com/docs/build-basics/api-lifecycle):
@@ -176,3 +179,4 @@ The following Square APIs are [deprecated](https://developer.squareup.com/docs/b
 [Gift Card Activities]: doc/api/gift-card-activities.md
 [Employees]: doc/api/employees.md
 [Transactions]: doc/api/transactions.md
+[Webhook Subscriptions]: doc/api/webhook-subscriptions.md

data/lib/square/api/apple_pay_api.rb

@@ -1,10 +1,6 @@
 module Square
   # ApplePayApi
   class ApplePayApi < BaseApi
-    def initialize(config, http_call_back: nil)
-      super(config, http_call_back: http_call_back)
-    end
-
     # Activates a domain for use with Apple Pay on the Web and Square. A
     # validation
     # is performed on this domain by Apple to ensure that it is properly set up
@@ -28,32 +24,20 @@ module Square
     # object definition for field details.
     # @return [RegisterDomainResponse Hash] response from the API call
     def register_domain(body:)
-      # Prepare query url.
-      _query_builder = config.get_base_uri
-      _query_builder << '/v2/apple-pay/domains'
-      _query_url = APIHelper.clean_url _query_builder
-
-      # Prepare headers.
-      _headers = {
-        'accept' => 'application/json',
-        'Content-Type' => 'application/json'
-      }
-
-      # 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
-      )
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/v2/apple-pay/domains',
+                                     'default')
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('global')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:json_deserialize))
+                   .is_api_response(true)
+                   .convertor(ApiResponse.method(:create)))
+        .execute
     end
   end
 end

data/lib/square/api/bank_accounts_api.rb

@@ -1,10 +1,6 @@
 module Square
   # BankAccountsApi
   class BankAccountsApi < BaseApi
-    def initialize(config, http_call_back: nil)
-      super(config, http_call_back: http_call_back)
-    end
-
     # Returns a list of [BankAccount]($m/BankAccount) objects linked to a Square
     # account.
     # @param [String] cursor Optional parameter: The pagination cursor returned
@@ -23,36 +19,20 @@ module Square
     def list_bank_accounts(cursor: nil,
                            limit: nil,
                            location_id: nil)
-      # Prepare query url.
-      _query_builder = config.get_base_uri
-      _query_builder << '/v2/bank-accounts'
-      _query_builder = APIHelper.append_url_with_query_parameters(
-        _query_builder,
-        'cursor' => cursor,
-        'limit' => limit,
-        '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
-      )
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/v2/bank-accounts',
+                                     'default')
+                   .query_param(new_parameter(cursor, key: 'cursor'))
+                   .query_param(new_parameter(limit, key: 'limit'))
+                   .query_param(new_parameter(location_id, key: 'location_id'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('global')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:json_deserialize))
+                   .is_api_response(true)
+                   .convertor(ApiResponse.method(:create)))
+        .execute
     end
 
     # Returns details of a [BankAccount]($m/BankAccount) identified by V1 bank
@@ -64,34 +44,19 @@ module Square
     # -account-by-using-an-id-issued-by-v1-bank-accounts-api).
     # @return [GetBankAccountByV1IdResponse Hash] response from the API call
     def get_bank_account_by_v1_id(v1_bank_account_id:)
-      # Prepare query url.
-      _query_builder = config.get_base_uri
-      _query_builder << '/v2/bank-accounts/by-v1-id/{v1_bank_account_id}'
-      _query_builder = APIHelper.append_url_with_template_parameters(
-        _query_builder,
-        'v1_bank_account_id' => { 'value' => v1_bank_account_id, 'encode' => true }
-      )
-      _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
-      )
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/v2/bank-accounts/by-v1-id/{v1_bank_account_id}',
+                                     'default')
+                   .template_param(new_parameter(v1_bank_account_id, key: 'v1_bank_account_id')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('global')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:json_deserialize))
+                   .is_api_response(true)
+                   .convertor(ApiResponse.method(:create)))
+        .execute
     end
 
     # Returns details of a [BankAccount]($m/BankAccount)
@@ -100,34 +65,19 @@ module Square
     # the desired `BankAccount`.
     # @return [GetBankAccountResponse Hash] response from the API call
     def get_bank_account(bank_account_id:)
-      # Prepare query url.
-      _query_builder = config.get_base_uri
-      _query_builder << '/v2/bank-accounts/{bank_account_id}'
-      _query_builder = APIHelper.append_url_with_template_parameters(
-        _query_builder,
-        'bank_account_id' => { 'value' => bank_account_id, 'encode' => true }
-      )
-      _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
-      )
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/v2/bank-accounts/{bank_account_id}',
+                                     'default')
+                   .template_param(new_parameter(bank_account_id, key: 'bank_account_id')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('global')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:json_deserialize))
+                   .is_api_response(true)
+                   .convertor(ApiResponse.method(:create)))
+        .execute
     end
   end
 end

data/lib/square/api/base_api.rb

@@ -1,61 +1,61 @@
-require 'erb'
 module Square
   # BaseApi.
   class BaseApi
     attr_accessor :config, :http_call_back
 
-    def initialize(config, http_call_back: nil)
-      @config = config
-      @http_call_back = http_call_back
+    def self.user_agent
+      'Square-Ruby-SDK/27.0.0.20230419 ({api-version}) {engine}/{engine-version} ({os-info}) {detail}'
+    end
 
-      @global_headers = {
-        'user-agent' => get_user_agent,
-        'Square-Version' => config.square_version
+    def self.user_agent_parameters
+      {
+        '{engine}' => { 'value' => RUBY_ENGINE, 'encode' => false },
+        '{engine-version}' => { 'value' => RUBY_ENGINE_VERSION, 'encode' => false },
+        '{os-info}' => { 'value' => RUBY_PLATFORM, 'encode' => false }
       }
     end
 
-    def validate_parameters(args)
-      args.each do |_name, value|
-        raise ArgumentError, "Required parameter #{_name} cannot be nil." if value.nil?
-      end
+    # Initialization constructor.
+    # @param [GlobalConfiguration] global_configuration The instance of GlobalConfiguration.
+    def initialize(global_configuration)
+      @global_configuration = global_configuration
+      @config = @global_configuration.client_configuration
+      @http_call_back = @config.http_callback
+      @api_call = ApiCall.new(@global_configuration)
     end
 
-    def validate_parameters_types(args)
-      args.each do |_name, type|
-        key, val = type.first
-        APIHelper.validate_types(key, val) unless key.nil?
-      end
+    # Creates a new builder for the Api Call instance.
+    # @return [ApiCall] The instance of ApiCall.
+    def new_api_call_builder
+      @api_call.new_builder
     end
 
-    def execute_request(request, binary: false)
-      @http_call_back&.on_before_request(request)
-
-      APIHelper.clean_hash(request.headers)
-      request.headers.merge!(@global_headers)
-      request.headers.merge!(config.additional_headers) unless config.additional_headers.nil?
-
-      response = if binary
-                   config.http_client.execute_as_binary(request)
-                 else
-                   config.http_client.execute_as_string(request)
-                 end
-      @http_call_back&.on_after_response(response)
+    # Creates a new instance of the request builder.
+    # @param [HttpMethodEnum] http_method The HTTP method to use in the request.
+    # @param [String] path The endpoint path to use in the request.
+    # @param [String] server The server to extract the base uri for the request.
+    # @return [RequestBuilder] The instance of RequestBuilder.
+    def new_request_builder(http_method, path, server)
+      RequestBuilder.new
+                    .http_method(http_method)
+                    .path(path)
+                    .server(server)
+    end
 
-      response
+    # Creates a new instance of the response handler.
+    # @return [ResponseHandler] The instance of ResponseHandler.
+    def new_response_handler
+      ResponseHandler.new
     end
 
-    def get_user_agent
-      user_agent = 'Square-Ruby-SDK/26.1.0.20230119 ({api-version}) {engine}/{engine-version} ({os-info}) {detail}'
-      user_agent['{engine}'] = RUBY_ENGINE
-      user_agent['{engine-version}'] = RUBY_ENGINE_VERSION
-      user_agent['{os-info}'] = RUBY_PLATFORM
-      user_agent['{api-version}'] = config.square_version
-      if config.user_agent_detail.nil? || config.user_agent_detail.empty?
-        user_agent = user_agent.gsub('{detail}', '')
-      else
-        user_agent['{detail}'] = ERB::Util.url_encode(config.user_agent_detail.to_s)
-      end
-      user_agent
+    # Creates a new instance of the parameter.
+    # @param [String|optional] key The key of the parameter.
+    # @param [Object] value The value of the parameter.
+    # @return [Parameter] The instance of Parameter.
+    def new_parameter(value, key: nil)
+      Parameter.new
+               .key(key)
+               .value(value)
     end
   end
 end