square.rb 18.1.0.20220316 → 19.0.0.20220420

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bbb5aeea53c32ac7828ffb52501c522f8e4811bb81aa4f0deb453802dcc9147e
-  data.tar.gz: 2526651aefdbeb8e605d35ef011de1c21f241e860c9d3fde2853b3c9e8912932
+  metadata.gz: 431d8365d32b12be40203cfb143d88518f74cee228a0b36755cdc5fc8b782200
+  data.tar.gz: 5349f02eb93bf190d16d17ea0f13d3c434fdcb75a37825e1cdcb6406744c7385
 SHA512:
-  metadata.gz: 500aa37342e9b95690d2541bc0f55d4b2ba2797290439a9da44bb1056b3aaf20d741a30b853afdaf9a81be4720b1b2284062974ac5c31908b17e0bc858725fa8
-  data.tar.gz: 83e45f18a23572b205a30ac3aad83529a6f94e0ae2a340ce28d3a06b243ace51e315114ca5e24cfa8676420d705dd7d80aec69053306eb63f799578c9a499f97
+  metadata.gz: 65afbe4492802c447ee9aa509cc282720a88e7e34f398609818e4cc60b2262d05584bdb736793d44f4a2d49299f350a4c8241666ebe452634e2ac73097424633
+  data.tar.gz: a0a524485adeb61c20502b6956df68fc908c0e9e52459421be2382ad962ccd17a0e4f128d1bf7ed341a2f9bed95c31da735512ddd73327d7ba739c52ae38d1f9

data/lib/square/api/base_api.rb

@@ -38,7 +38,7 @@ module Square
     end
 
     def get_user_agent
-      user_agent = 'Square-Ruby-SDK/18.1.0.20220316 ({api-version}) {engine}/{engine-version} ({os-info}) {detail}'
+      user_agent = 'Square-Ruby-SDK/19.0.0.20220420 ({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

data/lib/square/api/locations_api.rb

@@ -40,12 +40,11 @@ module Square
     # Creating new locations allows for separate configuration of receipt
     # layouts, item prices,
     # and sales reports. Developers can use locations to separate sales activity
-    # via applications
+    # through applications
     # that integrate with Square from sales activity elsewhere in a seller's
     # account.
-    # Locations created programmatically with the Locations API will last
-    # forever and
-    # are visible to the seller for their own management, so ensure that
+    # Locations created programmatically with the Locations API last forever and
+    # are visible to the seller for their own management. Therefore, ensure that
     # each location has a sensible and unique name.
     # @param [CreateLocationRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding

data/lib/square/api/orders_api.rb

@@ -311,8 +311,8 @@ module Square
     # the
     # `payment_ids` is canceled.
     # - Be approved with [delayed
-    # capture](https://developer.squareup.com/docs/payments-api/take-payments#de
-    # layed-capture).
+    # capture](https://developer.squareup.com/docs/payments-api/take-payments/ca
+    # rd-payments/delayed-capture).
     # Using a delayed capture payment with `PayOrder` completes the approved
     # payment.
     # @param [String] order_id Required parameter: The ID of the order being

data/lib/square/api/payouts_api.rb

@@ -0,0 +1,173 @@
+module Square
+  # PayoutsApi
+  class PayoutsApi < BaseApi
+    def initialize(config, http_call_back: nil)
+      super(config, http_call_back: http_call_back)
+    end
+
+    # Retrieves a list of all payouts for the default location.
+    # You can filter payouts by location ID, status, time range, and order them
+    # in ascending or descending order.
+    # To call this endpoint, set `PAYOUTS_READ` for the OAuth scope.
+    # @param [String] location_id Optional parameter: The ID of the location for
+    # which to list the payouts.  By default, payouts are returned for the
+    # default (main) location associated with the seller.
+    # @param [PayoutStatus] status Optional parameter: If provided, only payouts
+    # with the given status are returned.
+    # @param [String] begin_time Optional parameter: The timestamp for the
+    # beginning of the payout creation time, in RFC 3339 format. Inclusive.
+    # Default: The current time minus one year.
+    # @param [String] end_time Optional parameter: The timestamp for the end of
+    # the payout creation time, in RFC 3339 format. Default: The current time.
+    # @param [SortOrder] sort_order Optional parameter: The order in which
+    # payouts are listed.
+    # @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)
+    # . If request parameters change between requests, subsequent results may
+    # contain duplicates or missing records.
+    # @param [Integer] limit Optional parameter: The maximum number of results
+    # to be returned in a single page. It is possible to receive fewer results
+    # than the specified limit on a given page. The default value of 100 is also
+    # the maximum allowed value. If the provided value is greater than 100, it
+    # is ignored and the default value is used instead. Default: `100`
+    # @return [ListPayoutsResponse Hash] response from the API call
+    def list_payouts(location_id: nil,
+                     status: nil,
+                     begin_time: nil,
+                     end_time: nil,
+                     sort_order: nil,
+                     cursor: nil,
+                     limit: nil)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/payouts'
+      _query_builder = APIHelper.append_url_with_query_parameters(
+        _query_builder,
+        'location_id' => location_id,
+        'status' => status,
+        'begin_time' => begin_time,
+        'end_time' => end_time,
+        'sort_order' => sort_order,
+        'cursor' => cursor,
+        '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
+      )
+    end
+
+    # Retrieves details of a specific payout identified by a payout ID.
+    # To call this endpoint, set `PAYOUTS_READ` for the OAuth scope.
+    # @param [String] payout_id Required parameter: The ID of the payout to
+    # retrieve the information for.
+    # @return [GetPayoutResponse Hash] response from the API call
+    def get_payout(payout_id:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/payouts/{payout_id}'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'payout_id' => { 'value' => payout_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
+      )
+    end
+
+    # Retrieves a list of all payout entries for a specific payout.
+    # To call this endpoint, set `PAYOUTS_READ` for the OAuth scope.
+    # @param [String] payout_id Required parameter: The ID of the payout to
+    # retrieve the information for.
+    # @param [SortOrder] sort_order Optional parameter: The order in which
+    # payout entries are listed.
+    # @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)
+    # . If request parameters change between requests, subsequent results may
+    # contain duplicates or missing records.
+    # @param [Integer] limit Optional parameter: The maximum number of results
+    # to be returned in a single page. It is possible to receive fewer results
+    # than the specified limit on a given page. The default value of 100 is also
+    # the maximum allowed value. If the provided value is greater than 100, it
+    # is ignored and the default value is used instead. Default: `100`
+    # @return [ListPayoutEntriesResponse Hash] response from the API call
+    def list_payout_entries(payout_id:,
+                            sort_order: nil,
+                            cursor: nil,
+                            limit: nil)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/payouts/{payout_id}/payout-entries'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'payout_id' => { 'value' => payout_id, 'encode' => true }
+      )
+      _query_builder = APIHelper.append_url_with_query_parameters(
+        _query_builder,
+        'sort_order' => sort_order,
+        'cursor' => cursor,
+        '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
+      )
+    end
+  end
+end

data/lib/square/api/subscriptions_api.rb

@@ -260,9 +260,6 @@ module Square
     end
 
     # Lists all events for a specific subscription.
-    # In the current implementation, only `START_SUBSCRIPTION` and
-    # `STOP_SUBSCRIPTION` (when the subscription was canceled) events are
-    # returned.
     # @param [String] subscription_id Required parameter: The ID of the
     # subscription to retrieve the events for.
     # @param [String] cursor Optional parameter: When the total number of

data/lib/square/api/terminal_api.rb

@@ -41,8 +41,10 @@ module Square
       )
     end
 
-    # Retrieves a filtered list of Terminal checkout requests created by the
-    # account making the request.
+    # Returns a filtered list of Terminal checkout requests created by the
+    # application making the request. Only Terminal checkout requests created
+    # for the merchant scoped to the OAuth token are returned. Terminal checkout
+    # requests are available for 30 days.
     # @param [SearchTerminalCheckoutsRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
@@ -76,7 +78,8 @@ module Square
       )
     end
 
-    # Retrieves a Terminal checkout request by `checkout_id`.
+    # Retrieves a Terminal checkout request by `checkout_id`. Terminal checkout
+    # requests are available for 30 days.
     # @param [String] checkout_id Required parameter: The unique ID for the
     # desired `TerminalCheckout`.
     # @return [GetTerminalCheckoutResponse Hash] response from the API call
@@ -148,7 +151,10 @@ module Square
     end
 
     # Creates a request to refund an Interac payment completed on a Square
-    # Terminal.
+    # Terminal. Refunds for Interac payments on a Square Terminal are supported
+    # only for Interac debit cards in Canada. Other refunds for Terminal
+    # payments should use the Refunds API. For more information, see [Refunds
+    # API]($e/Refunds).
     # @param [CreateTerminalRefundRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
@@ -183,7 +189,8 @@ module Square
     end
 
     # Retrieves a filtered list of Interac Terminal refund requests created by
-    # the seller making the request.
+    # the seller making the request. Terminal refund requests are available for
+    # 30 days.
     # @param [SearchTerminalRefundsRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
@@ -217,7 +224,8 @@ module Square
       )
     end
 
-    # Retrieves an Interac Terminal refund object by ID.
+    # Retrieves an Interac Terminal refund object by ID. Terminal refund objects
+    # are available for 30 days.
     # @param [String] terminal_refund_id Required parameter: The unique ID for
     # the desired `TerminalRefund`.
     # @return [GetTerminalRefundResponse Hash] response from the API call

data/lib/square/client.rb

@@ -4,7 +4,7 @@ module Square
     attr_reader :config
 
     def sdk_version
-      '18.1.0.20220316'
+      '19.0.0.20220420'
     end
 
     def square_version
@@ -177,6 +177,12 @@ module Square
       @payments ||= PaymentsApi.new config
     end
 
+    # Access to payouts controller.
+    # @return [PayoutsApi] Returns the controller instance.
+    def payouts
+      @payouts ||= PayoutsApi.new config
+    end
+
     # Access to refunds controller.
     # @return [RefundsApi] Returns the controller instance.
     def refunds
@@ -224,7 +230,7 @@ module Square
                    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: '2022-03-16', access_token: '',
+                   square_version: '2022-04-20', access_token: '',
                    user_agent_detail: '', additional_headers: {}, config: nil)
       @config = if config.nil?
                   Configuration.new(connection: connection, timeout: timeout,

data/lib/square/configuration.rb

@@ -20,7 +20,7 @@ module Square
                    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: '2022-03-16', access_token: '',
+                   square_version: '2022-04-20', access_token: '',
                    user_agent_detail: '', additional_headers: {})
       # The Faraday connection object passed by the SDK user for making requests
       @connection = connection

data/lib/square/http/faraday_client.rb

@@ -1,5 +1,8 @@
 require 'faraday/http_cache'
-require 'faraday_middleware'
+require 'faraday/retry'
+require 'faraday/multipart'
+require 'faraday/follow_redirects'
+require 'faraday/gzip'
 
 module Square
   # An implementation of HttpClient.
@@ -27,8 +30,8 @@ module Square
                           cache: false, verify: true)
       Faraday.new do |faraday|
         faraday.use Faraday::HttpCache, serializer: Marshal if cache
-        faraday.use FaradayMiddleware::FollowRedirects
-        faraday.use :gzip
+        faraday.use Faraday::FollowRedirects::Middleware
+        faraday.request :gzip
         faraday.request :multipart
         faraday.request :url_encoded
         faraday.ssl[:ca_file] = Certifi.where
@@ -36,7 +39,10 @@ module Square
         faraday.request :retry, max: max_retries, interval: retry_interval,
                                 backoff_factor: backoff_factor,
                                 retry_statuses: retry_statuses,
-                                methods: retry_methods
+                                methods: retry_methods,
+                                retry_if: proc { |env, _exc|
+                                            env.request.context['forced_retry'] ||= false
+                                          }
         faraday.adapter Faraday.default_adapter
         faraday.options[:params_encoder] = Faraday::FlatParamsEncoder
         faraday.options[:timeout] = timeout if timeout.positive?
@@ -49,7 +55,9 @@ module Square
         http_request.http_method.downcase,
         http_request.query_url
       ) do |request|
-        request.headers = http_request.headers
+        request.headers = http_request.headers.map { |k, v| [k.to_s, v.to_s] }
+        request.options.context ||= {}
+        request.options.context.merge!(http_request.context)
         unless http_request.http_method == HttpMethodEnum::GET &&
                http_request.parameters.empty?
           request.body = http_request.parameters
@@ -65,6 +73,8 @@ module Square
         http_request.query_url
       ) do |request|
         request.headers = http_request.headers
+        request.options.context ||= {}
+        request.options.context.merge!(http_request.context)
         unless http_request.http_method == HttpMethodEnum::GET &&
                http_request.parameters.empty?
           request.body = http_request.parameters

data/lib/square/http/http_client.rb

@@ -28,72 +28,91 @@ module Square
     # Get a GET HttpRequest object.
     # @param [String] The URL to send the request to.
     # @param [Hash, Optional] The headers for the HTTP Request.
+    # @param [Hash, Optional] The context for the HTTP Request.
     def get(query_url,
-            headers: {})
+            headers: {},
+            context: {})
       HttpRequest.new(HttpMethodEnum::GET,
                       query_url,
-                      headers: headers)
+                      headers: headers,
+                      context: context)
     end
 
     # Get a HEAD HttpRequest object.
     # @param [String] The URL to send the request to.
     # @param [Hash, Optional] The headers for the HTTP Request.
+    # @param [Hash, Optional] The context for the HTTP Request.
     def head(query_url,
-             headers: {})
+             headers: {},
+             context: {})
       HttpRequest.new(HttpMethodEnum::HEAD,
                       query_url,
-                      headers: headers)
+                      headers: headers,
+                      context: context)
     end
 
     # Get a POST HttpRequest object.
     # @param [String] The URL to send the request to.
     # @param [Hash, Optional] The headers for the HTTP Request.
     # @param [Hash, Optional] The parameters for the HTTP Request.
+    # @param [Hash, Optional] The context for the HTTP Request.
     def post(query_url,
              headers: {},
-             parameters: {})
+             parameters: {},
+             context: {})
       HttpRequest.new(HttpMethodEnum::POST,
                       query_url,
                       headers: headers,
-                      parameters: parameters)
+                      parameters: parameters,
+                      context: context)
     end
 
     # Get a PUT HttpRequest object.
     # @param [String] The URL to send the request to.
     # @param [Hash, Optional] The headers for the HTTP Request.
     # @param [Hash, Optional] The parameters for the HTTP Request.
+    # @param [Hash, Optional] The context for the HTTP Request.
     def put(query_url,
             headers: {},
-            parameters: {})
+            parameters: {},
+            context: {})
       HttpRequest.new(HttpMethodEnum::PUT,
                       query_url,
                       headers: headers,
-                      parameters: parameters)
+                      parameters: parameters,
+                      context: context)
     end
 
     # Get a PATCH HttpRequest object.
     # @param [String] The URL to send the request to.
     # @param [Hash, Optional] The headers for the HTTP Request.
     # @param [Hash, Optional] The parameters for the HTTP Request.
+    # @param [Hash, Optional] The context for the HTTP Request.
     def patch(query_url,
               headers: {},
-              parameters: {})
+              parameters: {},
+              context: {})
       HttpRequest.new(HttpMethodEnum::PATCH,
                       query_url,
                       headers: headers,
-                      parameters: parameters)
+                      parameters: parameters,
+                      context: context)
     end
 
     # Get a DELETE HttpRequest object.
     # @param [String] The URL to send the request to.
     # @param [Hash, Optional] The headers for the HTTP Request.
+    # @param [Hash, Optional] The parameters for the HTTP Request.
+    # @param [Hash, Optional] The context for the HTTP Request.
     def delete(query_url,
                headers: {},
-               parameters: {})
+               parameters: {},
+               context: {})
       HttpRequest.new(HttpMethodEnum::DELETE,
                       query_url,
                       headers: headers,
-                      parameters: parameters)
+                      parameters: parameters,
+                      context: context)
     end
   end
 end

data/lib/square/http/http_request.rb

@@ -2,21 +2,25 @@ module Square
   # Represents a single Http Request.
   class HttpRequest
     attr_accessor :http_method, :query_url, :headers,
-                  :parameters, :username, :password
+                  :parameters, :username, :password,
+                  :context
 
     # The constructor.
     # @param [HttpMethodEnum] The HTTP method.
     # @param [String] The URL to send the request to.
     # @param [Hash, Optional] The headers for the HTTP Request.
     # @param [Hash, Optional] The parameters for the HTTP Request.
+    # @param [Hash, Optional] The context for the HTTP Request.
     def initialize(http_method,
                    query_url,
                    headers: {},
-                   parameters: {})
+                   parameters: {},
+                   context: {})
       @http_method = http_method
       @query_url = query_url
       @headers = headers
       @parameters = parameters
+      @context = context
     end
 
     # Add a header to the HttpRequest.

data/lib/square.rb

@@ -57,6 +57,7 @@ require_relative 'square/api/loyalty_api'
 require_relative 'square/api/merchants_api'
 require_relative 'square/api/orders_api'
 require_relative 'square/api/payments_api'
+require_relative 'square/api/payouts_api'
 require_relative 'square/api/refunds_api'
 require_relative 'square/api/sites_api'
 require_relative 'square/api/snippets_api'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: square.rb
 version: !ruby/object:Gem::Version
-  version: 18.1.0.20220316
+  version: 19.0.0.20220420
 platform: ruby
 authors:
 - Square Developer Platform
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-03-15 00:00:00.000000000 Z
+date: 2022-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logging
@@ -30,22 +30,58 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
-    - - ">="
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: faraday-follow_redirects
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: '0.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: faraday-multipart
+  requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-    - - ">="
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: faraday-gzip
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: '0.1'
 - !ruby/object:Gem::Dependency
-  name: faraday_middleware
+  name: faraday-retry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -162,6 +198,7 @@ files:
 - lib/square/api/o_auth_api.rb
 - lib/square/api/orders_api.rb
 - lib/square/api/payments_api.rb
+- lib/square/api/payouts_api.rb
 - lib/square/api/refunds_api.rb
 - lib/square/api/sites_api.rb
 - lib/square/api/snippets_api.rb
@@ -209,7 +246,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '2.6'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="