square.rb 26.1.0.20230119 → 27.0.0.20230419

data/lib/square/api/refunds_api.rb

@@ -1,35 +1,33 @@
 module Square
   # RefundsApi
   class RefundsApi < BaseApi
-    def initialize(config, http_call_back: nil)
-      super(config, http_call_back: http_call_back)
-    end
-
     # Retrieves a list of refunds for the account making the request.
     # Results are eventually consistent, and new refunds or changes to refunds
     # might take several
     # seconds to appear.
     # The maximum results per page is 100.
-    # @param [String] begin_time Optional parameter: The timestamp for the
-    # beginning of the requested reporting period, in RFC 3339 format.  Default:
-    # The current time minus one year.
-    # @param [String] end_time Optional parameter: The timestamp for the end of
-    # the requested reporting period, in RFC 3339 format.  Default: The current
-    # time.
+    # @param [String] begin_time Optional parameter: Indicates the start of the
+    # time range to retrieve each PaymentRefund` for, in RFC 3339  format.  The
+    # range is determined using the `created_at` field for each `PaymentRefund`.
+    #   Default: The current time minus one year.
+    # @param [String] end_time Optional parameter: Indicates the end of the time
+    # range to retrieve each `PaymentRefund` for, in RFC 3339  format.  The
+    # range is determined using the `created_at` field for each `PaymentRefund`.
+    #  Default: The current time.
     # @param [String] sort_order Optional parameter: The order in which results
-    # are listed: - `ASC` - Oldest to newest. - `DESC` - Newest to oldest
-    # (default).
+    # are listed by `PaymentRefund.created_at`: - `ASC` - Oldest to newest. -
+    # `DESC` - Newest to oldest (default).
     # @param [String] cursor Optional parameter: A pagination cursor returned by
     # a previous call to this endpoint. Provide this cursor to retrieve the next
     # set of results for the original query.  For more information, see
-    # [Pagination](https://developer.squareup.com/docs/basics/api101/pagination)
-    # .
+    # [Pagination](https://developer.squareup.com/docs/build-basics/common-api-p
+    # atterns/pagination).
     # @param [String] location_id Optional parameter: Limit results to the
     # location supplied. By default, results are returned for all locations
     # associated with the seller.
     # @param [String] status Optional parameter: If provided, only refunds with
     # the given status are returned. For a list of refund status values, see
-    # [PaymentRefund]($m/PaymentRefund).  Default: If omitted, refunds are
+    # [PaymentRefund](entity:PaymentRefund).  Default: If omitted, refunds are
     # returned regardless of their status.
     # @param [String] source_type Optional parameter: If provided, only returns
     # refunds whose payments have the indicated source type. Current values
@@ -51,41 +49,25 @@ module Square
                              status: nil,
                              source_type: nil,
                              limit: nil)
-      # Prepare query url.
-      _query_builder = config.get_base_uri
-      _query_builder << '/v2/refunds'
-      _query_builder = APIHelper.append_url_with_query_parameters(
-        _query_builder,
-        'begin_time' => begin_time,
-        'end_time' => end_time,
-        'sort_order' => sort_order,
-        'cursor' => cursor,
-        'location_id' => location_id,
-        'status' => status,
-        'source_type' => source_type,
-        'limit' => limit
-      )
-      _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/refunds',
+                                     'default')
+                   .query_param(new_parameter(begin_time, key: 'begin_time'))
+                   .query_param(new_parameter(end_time, key: 'end_time'))
+                   .query_param(new_parameter(sort_order, key: 'sort_order'))
+                   .query_param(new_parameter(cursor, key: 'cursor'))
+                   .query_param(new_parameter(location_id, key: 'location_id'))
+                   .query_param(new_parameter(status, key: 'status'))
+                   .query_param(new_parameter(source_type, key: 'source_type'))
+                   .query_param(new_parameter(limit, key: 'limit'))
+                   .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
 
     # Refunds a payment. You can refund the entire payment amount or a
@@ -100,32 +82,20 @@ module Square
     # object definition for field details.
     # @return [RefundPaymentResponse Hash] response from the API call
     def refund_payment(body:)
-      # Prepare query url.
-      _query_builder = config.get_base_uri
-      _query_builder << '/v2/refunds'
-      _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/refunds',
+                                     '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
 
     # Retrieves a specific refund using the `refund_id`.
@@ -133,34 +103,19 @@ module Square
     # desired `PaymentRefund`.
     # @return [GetPaymentRefundResponse Hash] response from the API call
     def get_payment_refund(refund_id:)
-      # Prepare query url.
-      _query_builder = config.get_base_uri
-      _query_builder << '/v2/refunds/{refund_id}'
-      _query_builder = APIHelper.append_url_with_template_parameters(
-        _query_builder,
-        'refund_id' => { 'value' => refund_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/refunds/{refund_id}',
+                                     'default')
+                   .template_param(new_parameter(refund_id, key: 'refund_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/sites_api.rb

@@ -1,10 +1,6 @@
 module Square
   # SitesApi
   class SitesApi < BaseApi
-    def initialize(config, http_call_back: nil)
-      super(config, http_call_back: http_call_back)
-    end
-
     # Lists the Square Online sites that belong to a seller. Sites are listed in
     # descending order by the `created_at` date.
     # __Note:__ Square Online APIs are publicly available as part of an early
@@ -14,30 +10,17 @@ module Square
     # for-square-online-apis).
     # @return [ListSitesResponse Hash] response from the API call
     def list_sites
-      # Prepare query url.
-      _query_builder = config.get_base_uri
-      _query_builder << '/v2/sites'
-      _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/sites',
+                                     'default')
+                   .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/snippets_api.rb

@@ -1,10 +1,6 @@
 module Square
   # SnippetsApi
   class SnippetsApi < BaseApi
-    def initialize(config, http_call_back: nil)
-      super(config, http_call_back: http_call_back)
-    end
-
     # Removes your snippet from a Square Online site.
     # You can call [ListSites]($e/Sites/ListSites) to get the IDs of the sites
     # that belong to a seller.
@@ -17,34 +13,19 @@ module Square
     # contains the snippet.
     # @return [DeleteSnippetResponse Hash] response from the API call
     def delete_snippet(site_id:)
-      # Prepare query url.
-      _query_builder = config.get_base_uri
-      _query_builder << '/v2/sites/{site_id}/snippet'
-      _query_builder = APIHelper.append_url_with_template_parameters(
-        _query_builder,
-        'site_id' => { 'value' => site_id, 'encode' => true }
-      )
-      _query_url = APIHelper.clean_url _query_builder
-
-      # Prepare headers.
-      _headers = {
-        'accept' => 'application/json'
-      }
-
-      # Prepare and execute HttpRequest.
-      _request = config.http_client.delete(
-        _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::DELETE,
+                                     '/v2/sites/{site_id}/snippet',
+                                     'default')
+                   .template_param(new_parameter(site_id, key: 'site_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
 
     # Retrieves your snippet from a Square Online site. A site can contain
@@ -61,34 +42,19 @@ module Square
     # contains the snippet.
     # @return [RetrieveSnippetResponse Hash] response from the API call
     def retrieve_snippet(site_id:)
-      # Prepare query url.
-      _query_builder = config.get_base_uri
-      _query_builder << '/v2/sites/{site_id}/snippet'
-      _query_builder = APIHelper.append_url_with_template_parameters(
-        _query_builder,
-        'site_id' => { 'value' => site_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/sites/{site_id}/snippet',
+                                     'default')
+                   .template_param(new_parameter(site_id, key: 'site_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
 
     # Adds a snippet to a Square Online site or updates the existing snippet on
@@ -111,36 +77,22 @@ module Square
     # @return [UpsertSnippetResponse Hash] response from the API call
     def upsert_snippet(site_id:,
                        body:)
-      # Prepare query url.
-      _query_builder = config.get_base_uri
-      _query_builder << '/v2/sites/{site_id}/snippet'
-      _query_builder = APIHelper.append_url_with_template_parameters(
-        _query_builder,
-        'site_id' => { 'value' => site_id, 'encode' => true }
-      )
-      _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/sites/{site_id}/snippet',
+                                     'default')
+                   .template_param(new_parameter(site_id, key: 'site_id')
+                                    .should_encode(true))
+                   .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