square.rb 17.1.0.20220120 → 19.0.0.20220420

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 407147246777f8a4eda2d4848cad5edb62be5801c25b6361f0dfb21d58663fd9
-  data.tar.gz: 735c7e92297b1d4a79ebd856dbe39cc304051536622f0277ddd9489811652cb6
+  metadata.gz: 431d8365d32b12be40203cfb143d88518f74cee228a0b36755cdc5fc8b782200
+  data.tar.gz: 5349f02eb93bf190d16d17ea0f13d3c434fdcb75a37825e1cdcb6406744c7385
 SHA512:
-  metadata.gz: 90ccb1516f8ff8998787d63a168c8c8688b9a12691d85cac3a2b6af35ce52af93bbc013e11336d5319cc252ec75ce7f790165ea5c38c69367f092e5ef62b365d
-  data.tar.gz: 05a3eb69caf678ad7f071b66a27c3ed4375ac96470ba09e51df9db6eba1401b80bd461c7fd6cb7bde91f30bb7ee5d11b9f7f293a59d40c70ab5ed52b25b9d180
+  metadata.gz: 65afbe4492802c447ee9aa509cc282720a88e7e34f398609818e4cc60b2262d05584bdb736793d44f4a2d49299f350a4c8241666ebe452634e2ac73097424633
+  data.tar.gz: a0a524485adeb61c20502b6956df68fc908c0e9e52459421be2382ad962ccd17a0e4f128d1bf7ed341a2f9bed95c31da735512ddd73327d7ba739c52ae38d1f9

data/README.md

@@ -6,30 +6,54 @@
 [![Gem version](https://badge.fury.io/rb/square.rb.svg?new)](https://badge.fury.io/rb/square.rb)
 [![Apache-2 license](https://img.shields.io/badge/license-Apache2-brightgreen.svg)](https://www.apache.org/licenses/LICENSE-2.0)
 
-Use this gem to integrate Square payments into your app and grow your business with Square APIs including Catalog, Customers, Employees, Inventory, Labor, Locations, and Orders.
+Use this library to integrate Square payments into your app and grow your business with Square APIs including Catalog, Customers, Employees, Inventory, Labor, Locations, and Orders.
 
 ## Requirements
 
-We support Ruby 2.5.x, 2.6.x, 2.7.x, and 3.0.x.
+Use of the Square Ruby SDK requires:
+
+* Ruby 2.6 through 3.1
 
 ## Installation
 
-Install the gem from the command line:
+For more information, see [Set Up Your Square SDK for a Ruby Project](https://developer.squareup.com/docs/sdks/ruby/setup-project).
+
+## Quickstart
+
+For more information, see [Square Ruby SDK Quickstart](https://developer.squareup.com/docs/sdks/ruby/quick-start).
+
+## Usage
+For more information, see [Using the Square Ruby SDK](https://developer.squareup.com/docs/sdks/ruby/using-ruby-sdk).
+
+## Tests
+
+First, clone the repo locally and `cd` into the directory.
+
+```sh
+git clone https://github.com/square/square-ruby-sdk.git
+cd square-ruby-sdk
+```
+
+Next, make sure Bundler is installed and install the development dependencies.
 
-```ruby
-gem install square.rb
+```sh
+gem install bundler
+bundle
 ```
 
-Or add the gem to your Gemfile and `bundle`:
+Before running the tests, find a sandbox token in your [Developer Dashboard] and set a `SQUARE_SANDBOX_TOKEN` environment variable.
 
-```ruby
-gem 'square.rb'
+```sh
+export SQUARE_SANDBOX_TOKEN="YOUR SANDBOX TOKEN HERE"
 ```
 
-### API Client
-* [Client]
+And run the tests.
 
-## API documentation
+```sh
+rake
+```
+
+## SDK Reference
 
 ### Payments
 * [Payments]
@@ -98,216 +122,6 @@ gem 'square.rb'
 * [V1 Items]
 * [Transactions]
 
-## Usage
-
-First time using Square? Here’s how to get started:
-
-1. **Create a Square account.** If you don’t have one already, [sign up for a developer account].
-1. **Create an application.** Go to your [Developer Dashboard] and create your first application. All you need to do is give it a name. When you’re doing this for your production application, enter the name as you would want a customer to see it.
-1. **Make your first API call.** Almost all Square API calls require a location ID. You’ll make your first call to #list_locations, which happens to be one of the API calls that don’t require a location ID. For more information about locations, see the [Locations] API documentation.
-
-Now let’s call your first Square API. Open your favorite text editor, create a new file called `locations.rb`, and copy the following code into that file:
-
-```ruby
-require 'square'
- 
-# Create an instance of the API Client and initialize it with the credentials 
-# for the Square account whose assets you want to manage.
-
-client = Square::Client.new(
-  access_token: 'YOUR SANDBOX ACCESS TOKEN HERE',
-  environment: 'sandbox'
-)
-
-# Call list_locations method to get all locations in this Square account
-result = client.locations.list_locations
-
-# Call the #success? method to see if the call succeeded
-if result.success?
-  # The #data Struct contains a list of locations
-  locations = result.data.locations
-
-  # Iterate over the list
-  locations.each do |location|
-    # Each location is represented as a Hash
-    location.each do |key, value|
-      puts "#{key}: #{value}"
-    end
-  end
-else
-  # Handle the case that the result is an error.
-  warn 'Error calling LocationsApi.listlocations ...'
-
-  # The #errors method returns an Array of error Hashes
-  result.errors.each do |key, value|
-    warn "#{key}: #{value}"
-  end
-end
-```
-
-Next, get an access token and reference it in your code. Go back to your application in the Developer Dashboard, in the Sandbox section click Show in the Sandbox Access Token box, copy that access token, and replace `'YOUR SANDBOX ACCESS TOKEN HERE'` with that token.
-
-**Important** When you eventually switch from trying things out on sandbox to actually working with your real production resources, you should not embed the access token in your code. Make sure you store and access your production access tokens securely.
-
-Now save `locations.rb` and run it:
-
-```sh
-ruby locations.rb
-```
-
-If your call is successful, you’ll get a response that looks like this:
-
-```
-address : {'address_line_1': '1455 Market Street', 'administrative_district_level_1': 'CA', 'country': 'US', 'locality': 'San Francisco', 'postal_code': '94103'}
-# ...
-```
-
-Yay! You successfully made your first call. If you didn’t, you would see an error message that looks something like this:
-
-```
-Error calling LocationsApi.listlocations
-category : AUTHENTICATION_ERROR
-code : UNAUTHORIZED
-detail : This request could not be authorized.
-```
-
-This error was returned when an invalid token was used to call the API.
-
-After you’ve tried out the Square APIs and tested your application using sandbox, you will want to switch to your production credentials so that you can manage real Square resources. Don't forget to switch your access token from sandbox to production for real data.
-
-## SDK patterns
-
-If you know a few patterns, you’ll be able to call any API in the SDK. Here are some important ones:
-
-### Get an access token
-
-To use the Square API to manage the resources (such as payments, orders, customers, etc.) of a Square account, you need to create an application (or use an existing one) in the Developer Dashboard and get an access token.
-
-When you call a Square API, you call it using an access key. An access key has specific permissions to resources in a specific Square account that can be accessed by a specific application in a specific developer account.
-Use an access token that is appropriate for your use case. There are two options:
-
-- To manage the resources for your own Square account, use the Personal Access Token for the application created in your Square account.
-- To manage resources for other Square accounts, use OAuth to ask owners of the accounts you want to manage so that you can work on their behalf. When you implement OAuth, you ask the Square account holder for permission to manage resources in their account (you can define the specific resources to access) and get an OAuth access token and refresh token for their account.
-
-**Important** For both use cases, make sure you store and access the tokens securely.
-
-### Import and Instantiate the Client Class
-
-To use the Square API, you import the Client class, instantiate a Client object, and initialize it with the appropriate access token. Here’s how:
-
-- Instantiate a `Square::Client` object with the access token for the Square account whose resources you want to manage. To access sandbox resources, initialize the `Square::Client` with environment set to sandbox:
-
-  ```ruby
-  client = Square::Client.new(
-    access_token: 'SANDBOX ACCESS TOKEN HERE',
-    environment: 'sandbox'
-  )
-  ```
-
-- To access production resources, set environment to production:
-
-  ```ruby
-  client = Square::Client.new(
-    access_token: 'ACCESS TOKEN HERE',
-    environment: 'production'
-  )
-  ```
-
-- To set a custom environment provide a `custom_url`, and set environment to `custom`:
-
-  ```ruby
-  client = Square::Client.new(
-    access_token:'ACCESS TOKEN HERE',
-    environment: 'custom',
-    custom_url: 'https://your.customdomain.com'
-  )
-  ```
- 
-### Get an Instance of an API object and call its methods
-
-Each API is implemented as a class. The Client object instantiates every API class and exposes them as properties so you can easily start using any Square API. You work with an API by calling methods on an instance of an API class. Here’s how:
-
-- Work with an API by calling the methods on the API object. For example, you would call list_customers to get a list of all customers in the Square account:
-
-  ```ruby
-  result = client.customers.list_customers
-  ```
-
-See the SDK documentation for the list of methods for each API class.
-
-Pass complex parameters (such as create, update, search, etc.) as a Hash. For example, you would pass a Hash containing the values used to create a new customer using create_customer:
-
-```ruby
-# Create a unique key for this creation operation so you don't accidentally
-# create the customer multiple times if you need to retry this operation.
-require 'securerandom'
-
-idempotency_key = SecureRandom.uuid
-
-# To create a customer, you'll need to specify at least a few required fields.
-request_body = {idempotency_key: idempotency_key, given_name: 'Amelia', family_name: 'Earhardt'}
-
-# Call create_customer method to create a new customer in this Square account
-result = client.customers.create_customer(request_body)
-```
-
-If your call succeeds, you’ll see a response that looks like this:
-
-```
-{'customer': {'created_at': '2019-06-28T21:23:05.126Z', 'creation_source': 'THIRD_PARTY', 'family_name': 'Earhardt', 'given_name': 'Amelia', 'id': 'CBASEDwl3El91nohQ2FLEk4aBfcgAQ', 'preferences': {'email_unsubscribed': False}, 'updated_at': '2019-06-28T21:23:05.126Z'}}
-```
-
-- Use idempotency for create, update, or other calls that you want to avoid calling twice. To make an idempotent API call, you add the idempotency_key with a unique value in the Hash for the API call’s request.
-- Specify a location ID for APIs such as Transactions, Orders, and Checkout that deal with payments. When a payment or order is created in Square, it is always associated with a location.
-
-### Handle the response
-
-API calls return a response object that contains properties that describe both the request (headers and request) and the response (status_code, reason_phrase, text, errors, body, and cursor). The response also has #success? and #error? helper methods so you can easily determine the success or failure of a call:
-
-```ruby
-if result.success?
-  p result.data
-elsif result.error?
-  warn result.errors.inspect
-end
-```
-
-- Read the response payload. The response payload is returned as a Struct from the #data method. For retrieve calls, a Struct containing a single item is returned with a key name that is the name of the object (for example, customer). For list calls, a Struct containing a Array of objects is returned with a key name that is the plural of the object name (for example, customers).
-- Make sure you get all items returned in a list call by checking the cursor value returned in the API response. When you call a list API the first time, set the cursor to an empty String or omit it from the API request. If the API response contains a cursor with a value, you call the API again to get the next page of items and continue to call that API again until the cursor is an empty String.
-
-## Tests
-
-First, clone the repo locally and `cd` into the directory.
-
-```sh
-git clone https://github.com/square/square-ruby-sdk.git
-cd square-ruby-sdk
-```
-
-Next, make sure Bundler is installed and install the development dependencies.
-
-```sh
-gem install bundler
-bundle
-```
-
-Before running the tests, find a sandbox token in your [Developer Dashboard] and set a `SQUARE_SANDBOX_TOKEN` environment variable.
-
-```sh
-export SQUARE_SANDBOX_TOKEN="YOUR SANDBOX TOKEN HERE"
-```
-
-And run the tests.
-
-```sh
-rake
-```
-
-## Learn more
-
-The Square Platform is built on the [Square API]. Square has a number of other SDKs that enable you to securely handle credit card information on both mobile and web so that you can process payments via the Square API. 
-
-You can also use the Square API to create applications or services that work with payments, orders, inventory, etc. that have been created and managed in Square’s in-person hardware products (Square Point of Sale and Square Register).
 
 [//]: # "Link anchor definitions"
 [Square Logo]: https://docs.connect.squareup.com/images/github/github-square-logo.svg

data/lib/square/api/base_api.rb

@@ -38,7 +38,7 @@ module Square
     end
 
     def get_user_agent
-      user_agent = 'Square-Ruby-SDK/17.1.0.20220120 ({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/customer_groups_api.rb

@@ -9,14 +9,15 @@ module Square
     # @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 your original query.  For more information, see
-    # [Pagination](https://developer.squareup.com/docs/working-with-apis/paginat
-    # ion).
+    # [Pagination](https://developer.squareup.com/docs/build-basics/common-api-p
+    # atterns/pagination).
     # @param [Integer] limit Optional parameter: The maximum number of results
     # to return in a single page. This limit is advisory. The response might
-    # contain more or fewer results. The limit is ignored if it is less than 1
-    # or greater than 50. The default value is 50.  For more information, see
-    # [Pagination](https://developer.squareup.com/docs/working-with-apis/paginat
-    # ion).
+    # contain more or fewer results. If the limit is less than 1 or greater than
+    # 50, Square returns a `400 VALUE_TOO_LOW` or `400 VALUE_TOO_HIGH` error.
+    # The default value is 50.  For more information, see
+    # [Pagination](https://developer.squareup.com/docs/build-basics/common-api-p
+    # atterns/pagination).
     # @return [ListCustomerGroupsResponse Hash] response from the API call
     def list_customer_groups(cursor: nil,
                              limit: nil)

data/lib/square/api/customer_segments_api.rb

@@ -9,14 +9,15 @@ module Square
     # @param [String] cursor Optional parameter: A pagination cursor returned by
     # previous calls to `ListCustomerSegments`. This cursor is used to retrieve
     # the next set of query results.  For more information, see
-    # [Pagination](https://developer.squareup.com/docs/working-with-apis/paginat
-    # ion).
+    # [Pagination](https://developer.squareup.com/docs/build-basics/common-api-p
+    # atterns/pagination).
     # @param [Integer] limit Optional parameter: The maximum number of results
     # to return in a single page. This limit is advisory. The response might
-    # contain more or fewer results. The limit is ignored if it is less than 1
-    # or greater than 50. The default value is 50.  For more information, see
-    # [Pagination](https://developer.squareup.com/docs/working-with-apis/paginat
-    # ion).
+    # contain more or fewer results. If the specified limit is less than 1 or
+    # greater than 50, Square returns a `400 VALUE_TOO_LOW` or `400
+    # VALUE_TOO_HIGH` error. The default value is 50.  For more information, see
+    # [Pagination](https://developer.squareup.com/docs/build-basics/common-api-p
+    # atterns/pagination).
     # @return [ListCustomerSegmentsResponse Hash] response from the API call
     def list_customer_segments(cursor: nil,
                                limit: nil)

data/lib/square/api/customers_api.rb

@@ -15,14 +15,16 @@ module Square
     # @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 your original query.  For more information, see
-    # [Pagination](https://developer.squareup.com/docs/working-with-apis/paginat
-    # ion).
+    # [Pagination](https://developer.squareup.com/docs/build-basics/common-api-p
+    # atterns/pagination).
     # @param [Integer] limit Optional parameter: The maximum number of results
     # to return in a single page. This limit is advisory. The response might
-    # contain more or fewer results. The limit is ignored if it is less than 1
-    # or greater than 100. The default value is 100.  For more information, see
-    # [Pagination](https://developer.squareup.com/docs/working-with-apis/paginat
-    # ion).
+    # contain more or fewer results. If the specified limit is less than 1 or
+    # greater than 100, Square returns a `400 VALUE_TOO_LOW` or `400
+    # VALUE_TOO_HIGH` error. The default value is 100.  For more information,
+    # see
+    # [Pagination](https://developer.squareup.com/docs/build-basics/common-api-p
+    # atterns/pagination).
     # @param [CustomerSortField] sort_field Optional parameter: Indicates how
     # customers should be sorted.  The default value is `DEFAULT`.
     # @param [SortOrder] sort_order Optional parameter: Indicates whether
@@ -166,8 +168,9 @@ module Square
     # @param [Long] version Optional parameter: The current version of the
     # customer profile.  As a best practice, you should include this parameter
     # to enable [optimistic
-    # concurrency](https://developer.squareup.com/docs/working-with-apis/optimis
-    # tic-concurrency) control.  For more information, see [Delete a customer
+    # concurrency](https://developer.squareup.com/docs/build-basics/common-api-p
+    # atterns/optimistic-concurrency) control.  For more information, see
+    # [Delete a customer
     # profile](https://developer.squareup.com/docs/customers-api/use-the-api/kee
     # p-records#delete-customer-profile).
     # @return [DeleteCustomerResponse Hash] response from the API call

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/loyalty_api.rb

@@ -424,9 +424,10 @@ module Square
       )
     end
 
-    # Searches for loyalty rewards in a loyalty account.
-    # In the current implementation, the endpoint supports search by the reward
-    # `status`.
+    # Searches for loyalty rewards. This endpoint accepts a request with no
+    # query filters and returns results for all loyalty accounts.
+    # If you include a `query` object, `loyalty_account_id` is required and
+    # `status` is  optional.
     # If you know a reward ID, use the
     # [RetrieveLoyaltyReward]($e/Loyalty/RetrieveLoyaltyReward) endpoint.
     # Search results are sorted by `updated_at` in descending order.

data/lib/square/api/merchants_api.rb

@@ -5,15 +5,17 @@ module Square
       super(config, http_call_back: http_call_back)
     end
 
-    # Returns `Merchant` information for a given access token.
-    # If you don't know a `Merchant` ID, you can use this endpoint to retrieve
-    # the merchant ID for an access token.
-    # You can specify your personal access token to get your own merchant
-    # information or specify an OAuth token
-    # to get the information for the  merchant that granted you access.
+    # Provides details about the merchant associated with a given access token.
+    # The access token used to connect your application to a Square seller is
+    # associated
+    # with a single merchant. That means that `ListMerchants` returns a list
+    # with a single `Merchant` object. You can specify your personal access
+    # token
+    # to get your own merchant information or specify an OAuth token to get the
+    # information for the merchant that granted your application access.
     # If you know the merchant ID, you can also use the
     # [RetrieveMerchant]($e/Merchants/RetrieveMerchant)
-    # endpoint to get the merchant information.
+    # endpoint to retrieve the merchant information.
     # @param [Integer] cursor Optional parameter: The cursor generated by the
     # previous response.
     # @return [ListMerchantsResponse Hash] response from the API call
@@ -48,7 +50,7 @@ module Square
       )
     end
 
-    # Retrieve a `Merchant` object for the given `merchant_id`.
+    # Retrieves the `Merchant` object for the given `merchant_id`.
     # @param [String] merchant_id Required parameter: The ID of the merchant to
     # retrieve. If the string "me" is supplied as the ID, then retrieve the
     # merchant that is currently accessible to this call.

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