square.rb 6.2.0.20200812 → 6.3.0.20200826

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 491aaaccfa43e7c8d9d17a2d48624c28207bbea80dc75359d525b3d4cd64b0cf
-  data.tar.gz: 645d97dc4dcef2655903ad1f89dee5e361c6b072794bf2920d83fe66dfae1723
+  metadata.gz: 973136d2e4f8177385869ee692c78d893fc79df5a5cb27512a57a24318027cfe
+  data.tar.gz: 8b502686044b15c7a047abc2c2a6dfa44cd7741406892b7bfb1f42e5a8af9190
 SHA512:
-  metadata.gz: 41bc326ab367dae322de2187a0fb3d509384f5af88787e75ab37db42db1263833f65fd0bf39e48ecd60d437970752eb5380cba65eeee02a113c39ae48692e74d
-  data.tar.gz: d2f6cd63f7a4475ae78c64a980831c4f3b2b23ca8e657deb6dc737b188906987f2b67a21966ed74f7001c25553d5590b1a619c923713f25e9000d199f6196e21
+  metadata.gz: 1138a5aeefa0e9f4a1c7fbb8d9275b7f9519bcd3092f7ee694818e00077c661893fa5c1c200d75b587bf8f6a4752b874c32f00a7f089036304302c880e5d2fc9
+  data.tar.gz: 669ef667f74ed01898f5fabcde7be3c92835878cc7a0fbded426b44906478a7c37dc72d1d3bd730c9d6b4701754592b24414cd33ca30402741664997907d403b

data/README.md

@@ -80,7 +80,6 @@ gem 'square.rb'
 * [V1 Transactions]
 * [V1 Items]
 * [Transactions]
-* [Reporting]
 
 ## Usage
 
@@ -308,7 +307,6 @@ You can also use the Square API to create applications or services that work wit
 [Invoices]: doc/invoices.md
 [Apple Pay]: doc/apple-pay.md
 [Refunds]: doc/refunds.md
-[Reporting]: doc/reporting.md
 [Mobile Authorization]: doc/mobile-authorization.md
 [O Auth]: doc/o-auth.md
 [V1 Locations]: doc/v1-locations.md

data/lib/square.rb

@@ -49,12 +49,11 @@ require_relative 'square/api/inventory_api.rb'
 require_relative 'square/api/invoices_api.rb'
 require_relative 'square/api/labor_api.rb'
 require_relative 'square/api/locations_api.rb'
-require_relative 'square/api/reporting_api.rb'
 require_relative 'square/api/checkout_api.rb'
-require_relative 'square/api/orders_api.rb'
 require_relative 'square/api/transactions_api.rb'
 require_relative 'square/api/loyalty_api.rb'
 require_relative 'square/api/merchants_api.rb'
+require_relative 'square/api/orders_api.rb'
 require_relative 'square/api/payments_api.rb'
 require_relative 'square/api/refunds_api.rb'
 require_relative 'square/api/subscriptions_api.rb'

data/lib/square/api/base_api.rb

@@ -8,7 +8,7 @@ module Square
       @http_call_back = http_call_back
 
       @global_headers = {
-        'user-agent' => 'Square-Ruby-SDK/6.2.0.20200812',
+        'user-agent' => 'Square-Ruby-SDK/6.3.0.20200826',
         'Square-Version' => config.square_version
       }
     end

data/lib/square/api/employees_api.rb

@@ -6,8 +6,7 @@ module Square
     end
 
     # ListEmployees
-    # @param [String] location_id Optional parameter: Filter employees returned
-    # to only those that are associated with the specified location.
+    # @param [String] location_id Optional parameter: Example:
     # @param [EmployeeStatus] status Optional parameter: Specifies the
     # EmployeeStatus to filter the employee by.
     # @param [Integer] limit Optional parameter: The number of employees to be
@@ -19,6 +18,7 @@ module Square
                        status: nil,
                        limit: nil,
                        cursor: nil)
+      warn 'Endpoint list_employees in EmployeesApi is deprecated'
       # Prepare query url.
       _query_builder = config.get_base_uri
       _query_builder << '/v2/employees'
@@ -55,6 +55,7 @@ module Square
     # requested.
     # @return [RetrieveEmployeeResponse Hash] response from the API call
     def retrieve_employee(id:)
+      warn 'Endpoint retrieve_employee in EmployeesApi is deprecated'
       # Prepare query url.
       _query_builder = config.get_base_uri
       _query_builder << '/v2/employees/{id}'

data/lib/square/api/inventory_api.rb

@@ -242,8 +242,9 @@ module Square
     # [Location](#type-location)s.
     # Results are paginated and sorted in descending order according to their
     # `occurred_at` timestamp (newest first).
-    # There are no limits on how far back the caller can page. This endpoint is
-    # useful when displaying recent changes for a specific item. For more
+    # There are no limits on how far back the caller can page. This endpoint can
+    # be
+    # used to display recent changes for a specific item. For more
     # sophisticated queries, use a batch endpoint.
     # @param [String] catalog_object_id Required parameter: ID of the
     # [CatalogObject](#type-catalogobject) to retrieve.

data/lib/square/api/labor_api.rb

@@ -209,6 +209,7 @@ module Square
     def list_employee_wages(employee_id: nil,
                             limit: nil,
                             cursor: nil)
+      warn 'Endpoint list_employee_wages in LaborApi is deprecated'
       # Prepare query url.
       _query_builder = config.get_base_uri
       _query_builder << '/v2/labor/employee-wages'
@@ -244,6 +245,7 @@ module Square
     # retrieved.
     # @return [GetEmployeeWageResponse Hash] response from the API call
     def get_employee_wage(id:)
+      warn 'Endpoint get_employee_wage in LaborApi is deprecated'
       # Prepare query url.
       _query_builder = config.get_base_uri
       _query_builder << '/v2/labor/employee-wages/{id}'
@@ -474,6 +476,81 @@ module Square
       ApiResponse.new(_response, data: decoded, errors: _errors)
     end
 
+    # Returns a paginated list of `TeamMemberWage` instances for a business.
+    # @param [String] team_member_id Optional parameter: Filter wages returned
+    # to only those that are associated with the specified team member.
+    # @param [Integer] limit Optional parameter: Maximum number of Team Member
+    # Wages to return per page. Can range between 1 and 200. The default is the
+    # maximum at 200.
+    # @param [String] cursor Optional parameter: Pointer to the next page of
+    # Employee Wage results to fetch.
+    # @return [ListTeamMemberWagesResponse Hash] response from the API call
+    def list_team_member_wages(team_member_id: nil,
+                               limit: nil,
+                               cursor: nil)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/labor/team-member-wages'
+      _query_builder = APIHelper.append_url_with_query_parameters(
+        _query_builder,
+        'team_member_id' => team_member_id,
+        'limit' => limit,
+        'cursor' => cursor
+      )
+      _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
+
+    # Returns a single `TeamMemberWage` specified by id.
+    # @param [String] id Required parameter: UUID for the `TeamMemberWage` being
+    # retrieved.
+    # @return [GetTeamMemberWageResponse Hash] response from the API call
+    def get_team_member_wage(id:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/labor/team-member-wages/{id}'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'id' => 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
+
     # Returns a list of `WorkweekConfig` instances for a business.
     # @param [Integer] limit Optional parameter: Maximum number of Workweek
     # Configs to return per page.

data/lib/square/api/orders_api.rb

@@ -16,21 +16,14 @@ module Square
     # To learn more about the Orders API, see the
     # [Orders API
     # Overview](https://developer.squareup.com/docs/orders-api/what-it-does).
-    # @param [String] location_id Required parameter: The ID of the business
-    # location to associate the order with.
     # @param [CreateOrderRequest] body Required parameter: An object containing
     # the fields to POST for the request.  See the corresponding object
     # definition for field details.
     # @return [CreateOrderResponse Hash] response from the API call
-    def create_order(location_id:,
-                     body:)
+    def create_order(body:)
       # Prepare query url.
       _query_builder = config.get_base_uri
-      _query_builder << '/v2/locations/{location_id}/orders'
-      _query_builder = APIHelper.append_url_with_template_parameters(
-        _query_builder,
-        'location_id' => location_id
-      )
+      _query_builder << '/v2/orders'
       _query_url = APIHelper.clean_url _query_builder
 
       # Prepare headers.
@@ -57,21 +50,14 @@ module Square
     # Retrieves a set of [Order](#type-order)s by their IDs.
     # If a given Order ID does not exist, the ID is ignored instead of
     # generating an error.
-    # @param [String] location_id Required parameter: The ID of the orders'
-    # associated location.
     # @param [BatchRetrieveOrdersRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
     # @return [BatchRetrieveOrdersResponse Hash] response from the API call
-    def batch_retrieve_orders(location_id:,
-                              body:)
+    def batch_retrieve_orders(body:)
       # Prepare query url.
       _query_builder = config.get_base_uri
-      _query_builder << '/v2/locations/{location_id}/orders/batch-retrieve'
-      _query_builder = APIHelper.append_url_with_template_parameters(
-        _query_builder,
-        'location_id' => location_id
-      )
+      _query_builder << '/v2/orders/batch-retrieve'
       _query_url = APIHelper.clean_url _query_builder
 
       # Prepare headers.
@@ -95,68 +81,6 @@ module Square
       ApiResponse.new(_response, data: decoded, errors: _errors)
     end
 
-    # Updates an open [Order](#type-order) by adding, replacing, or deleting
-    # fields. Orders with a `COMPLETED` or `CANCELED` state cannot be updated.
-    # An UpdateOrder request requires the following:
-    # - The `order_id` in the endpoint path, identifying the order to update.
-    # - The latest `version` of the order to update.
-    # - The [sparse
-    # order](https://developer.squareup.com/docs/orders-api/manage-orders#sparse
-    # -order-objects)
-    # containing only the fields to update and the version the update is
-    # being applied to.
-    # - If deleting fields, the [dot notation
-    # paths](https://developer.squareup.com/docs/orders-api/manage-orders#on-dot
-    # -notation)
-    # identifying fields to clear.
-    # To pay for an order, please refer to the [Pay for
-    # Orders](https://developer.squareup.com/docs/orders-api/pay-for-orders)
-    # guide.
-    # To learn more about the Orders API, see the
-    # [Orders API
-    # Overview](https://developer.squareup.com/docs/orders-api/what-it-does).
-    # @param [String] location_id Required parameter: The ID of the order's
-    # associated location.
-    # @param [String] order_id Required parameter: The ID of the order to
-    # update.
-    # @param [UpdateOrderRequest] body Required parameter: An object containing
-    # the fields to POST for the request.  See the corresponding object
-    # definition for field details.
-    # @return [UpdateOrderResponse Hash] response from the API call
-    def update_order(location_id:,
-                     order_id:,
-                     body:)
-      # Prepare query url.
-      _query_builder = config.get_base_uri
-      _query_builder << '/v2/locations/{location_id}/orders/{order_id}'
-      _query_builder = APIHelper.append_url_with_template_parameters(
-        _query_builder,
-        'location_id' => location_id,
-        'order_id' => order_id
-      )
-      _query_url = APIHelper.clean_url _query_builder
-
-      # Prepare headers.
-      _headers = {
-        'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
-      }
-
-      # Prepare and execute HttpRequest.
-      _request = config.http_client.put(
-        _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)
-    end
-
     # Calculates an [Order](#type-order).
     # @param [CalculateOrderRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
@@ -236,6 +160,64 @@ module Square
       ApiResponse.new(_response, data: decoded, errors: _errors)
     end
 
+    # Updates an open [Order](#type-order) by adding, replacing, or deleting
+    # fields. Orders with a `COMPLETED` or `CANCELED` state cannot be updated.
+    # An UpdateOrder request requires the following:
+    # - The `order_id` in the endpoint path, identifying the order to update.
+    # - The latest `version` of the order to update.
+    # - The [sparse
+    # order](https://developer.squareup.com/docs/orders-api/manage-orders#sparse
+    # -order-objects)
+    # containing only the fields to update and the version the update is
+    # being applied to.
+    # - If deleting fields, the [dot notation
+    # paths](https://developer.squareup.com/docs/orders-api/manage-orders#on-dot
+    # -notation)
+    # identifying fields to clear.
+    # To pay for an order, please refer to the [Pay for
+    # Orders](https://developer.squareup.com/docs/orders-api/pay-for-orders)
+    # guide.
+    # To learn more about the Orders API, see the
+    # [Orders API
+    # Overview](https://developer.squareup.com/docs/orders-api/what-it-does).
+    # @param [String] order_id Required parameter: The ID of the order to
+    # update.
+    # @param [UpdateOrderRequest] body Required parameter: An object containing
+    # the fields to POST for the request.  See the corresponding object
+    # definition for field details.
+    # @return [UpdateOrderResponse Hash] response from the API call
+    def update_order(order_id:,
+                     body:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/orders/{order_id}'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'order_id' => order_id
+      )
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json',
+        'content-type' => 'application/json; charset=utf-8'
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.put(
+        _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)
+    end
+
     # Pay for an [order](#type-order) using one or more approved
     # [payments](#type-payment),
     # or settle an order with a total of `0`.

data/lib/square/api/subscriptions_api.rb

@@ -12,10 +12,6 @@ module Square
     # address. The subscription starts immediately, unless the request includes
     # the optional `start_date`. Each individual subscription is associated with
     # a particular location.
-    # For more information,
-    # see [Subscription API
-    # Overview](https://developer.squareup.com/docs/docs/subscriptions-api/overv
-    # iew).
     # @param [CreateSubscriptionRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
@@ -129,10 +125,7 @@ module Square
     end
 
     # Updates a subscription. You can set, modify, and clear the
-    # `subscription` field values. For more information and examples, see
-    # [Update
-    # subscriptions](https://developer.squareup.com/docs/docs/subscriptions-api/
-    # overview#update-subscriptions).
+    # `subscription` field values.
     # @param [String] subscription_id Required parameter: The ID for the
     # subscription to update.
     # @param [UpdateSubscriptionRequest] body Required parameter: An object
@@ -171,12 +164,8 @@ module Square
       ApiResponse.new(_response, data: decoded, errors: _errors)
     end
 
-    # Cancels a subscription immediately and sets the subscription
-    # `status` to `CANCELED`. You can also use the `UpdateSubscription`
-    # endpoint to cancel a subscription at a future date. For more
-    # information, see
-    # [CancelSubscriptions](https://developer.squareup.com/docs/docs/subscriptio
-    # ns-api/overview#cancel-subscriptions).
+    # Sets the `canceled_date` field to the end of the active billing period.
+    # After this date, the status changes from ACTIVE to CANCELED.
     # @param [String] subscription_id Required parameter: The ID of the
     # subscription to cancel.
     # @return [CancelSubscriptionResponse Hash] response from the API call

data/lib/square/client.rb

@@ -4,7 +4,7 @@ module Square
     attr_reader :config
 
     def sdk_version
-      '6.2.0.20200812'
+      '6.3.0.20200826'
     end
 
     def square_version
@@ -131,24 +131,12 @@ module Square
       @locations ||= LocationsApi.new config
     end
 
-    # Access to reporting controller.
-    # @return [ReportingApi] Returns the controller instance.
-    def reporting
-      @reporting ||= ReportingApi.new config
-    end
-
     # Access to checkout controller.
     # @return [CheckoutApi] Returns the controller instance.
     def checkout
       @checkout ||= CheckoutApi.new config
     end
 
-    # Access to orders controller.
-    # @return [OrdersApi] Returns the controller instance.
-    def orders
-      @orders ||= OrdersApi.new config
-    end
-
     # Access to transactions controller.
     # @return [TransactionsApi] Returns the controller instance.
     def transactions
@@ -167,6 +155,12 @@ module Square
       @merchants ||= MerchantsApi.new config
     end
 
+    # Access to orders controller.
+    # @return [OrdersApi] Returns the controller instance.
+    def orders
+      @orders ||= OrdersApi.new config
+    end
+
     # Access to payments controller.
     # @return [PaymentsApi] Returns the controller instance.
     def payments
@@ -199,7 +193,7 @@ module Square
 
     def initialize(timeout: 60, max_retries: 0, retry_interval: 1,
                    backoff_factor: 1, environment: 'production',
-                   square_version: '2020-08-12', access_token: 'TODO: Replace',
+                   square_version: '2020-08-26', access_token: 'TODO: Replace',
                    additional_headers: {}, config: nil)
       @config = if config.nil?
                   Configuration.new(timeout: timeout, max_retries: max_retries,

data/lib/square/configuration.rb

@@ -22,7 +22,7 @@ module Square
 
     def initialize(timeout: 60, max_retries: 0, retry_interval: 1,
                    backoff_factor: 1, environment: 'production',
-                   square_version: '2020-08-12', access_token: 'TODO: Replace',
+                   square_version: '2020-08-26', access_token: 'TODO: Replace',
                    additional_headers: {})
       # The value to use for connection timeout
       @timeout = timeout

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: square.rb
 version: !ruby/object:Gem::Version
-  version: 6.2.0.20200812
+  version: 6.3.0.20200826
 platform: ruby
 authors:
 - Square Developer Platform
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-12 00:00:00.000000000 Z
+date: 2020-08-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logging
@@ -141,7 +141,6 @@ files:
 - lib/square/api/orders_api.rb
 - lib/square/api/payments_api.rb
 - lib/square/api/refunds_api.rb
-- lib/square/api/reporting_api.rb
 - lib/square/api/subscriptions_api.rb
 - lib/square/api/team_api.rb
 - lib/square/api/terminal_api.rb

data/lib/square/api/reporting_api.rb

@@ -1,138 +0,0 @@
-module Square
-  # ReportingApi
-  class ReportingApi < BaseApi
-    def initialize(config, http_call_back: nil)
-      super(config, http_call_back: http_call_back)
-    end
-
-    # Returns a list of refunded transactions (across all possible originating
-    # locations) relating to monies
-    # credited to the provided location ID by another Square account using the
-    # `additional_recipients` field in a transaction.
-    # Max results per [page](#paginatingresults): 50
-    # @param [String] location_id Required parameter: The ID of the location to
-    # list AdditionalRecipientReceivableRefunds for.
-    # @param [String] begin_time Optional parameter: The beginning of the
-    # requested reporting period, in RFC 3339 format.  See [Date
-    # ranges](#dateranges) for details on date inclusivity/exclusivity.  Default
-    # value: The current time minus one year.
-    # @param [String] end_time Optional parameter: The end of the requested
-    # reporting period, in RFC 3339 format.  See [Date ranges](#dateranges) for
-    # details on date inclusivity/exclusivity.  Default value: The current
-    # time.
-    # @param [SortOrder] sort_order Optional parameter: The order in which
-    # results are listed in the response (`ASC` for oldest first, `DESC` for
-    # newest first).  Default value: `DESC`
-    # @param [String] cursor Optional parameter: A pagination cursor returned by
-    # a previous call to this endpoint. Provide this to retrieve the next set of
-    # results for your original query.  See [Paginating
-    # results](#paginatingresults) for more information.
-    # @return [ListAdditionalRecipientReceivableRefundsResponse Hash] response from the API call
-    def list_additional_recipient_receivable_refunds(location_id:,
-                                                     begin_time: nil,
-                                                     end_time: nil,
-                                                     sort_order: nil,
-                                                     cursor: nil)
-      warn 'Endpoint list_additional_recipient_receivable_refunds in Reporting'\
-           'Api is deprecated'
-      # Prepare query url.
-      _query_builder = config.get_base_uri
-      _query_builder << '/v2/locations/{location_id}/additional-recipient-receivable-refunds'
-      _query_builder = APIHelper.append_url_with_template_parameters(
-        _query_builder,
-        'location_id' => location_id
-      )
-      _query_builder = APIHelper.append_url_with_query_parameters(
-        _query_builder,
-        'begin_time' => begin_time,
-        'end_time' => end_time,
-        'sort_order' => sort_order,
-        'cursor' => cursor
-      )
-      _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
-
-    # Returns a list of receivables (across all possible sending locations)
-    # representing monies credited
-    # to the provided location ID by another Square account using the
-    # `additional_recipients` field in a transaction.
-    # Max results per [page](#paginatingresults): 50
-    # @param [String] location_id Required parameter: The ID of the location to
-    # list AdditionalRecipientReceivables for.
-    # @param [String] begin_time Optional parameter: The beginning of the
-    # requested reporting period, in RFC 3339 format.  See [Date
-    # ranges](#dateranges) for details on date inclusivity/exclusivity.  Default
-    # value: The current time minus one year.
-    # @param [String] end_time Optional parameter: The end of the requested
-    # reporting period, in RFC 3339 format.  See [Date ranges](#dateranges) for
-    # details on date inclusivity/exclusivity.  Default value: The current
-    # time.
-    # @param [SortOrder] sort_order Optional parameter: The order in which
-    # results are listed in the response (`ASC` for oldest first, `DESC` for
-    # newest first).  Default value: `DESC`
-    # @param [String] cursor Optional parameter: A pagination cursor returned by
-    # a previous call to this endpoint. Provide this to retrieve the next set of
-    # results for your original query.  See [Paginating
-    # results](#paginatingresults) for more information.
-    # @return [ListAdditionalRecipientReceivablesResponse Hash] response from the API call
-    def list_additional_recipient_receivables(location_id:,
-                                              begin_time: nil,
-                                              end_time: nil,
-                                              sort_order: nil,
-                                              cursor: nil)
-      warn 'Endpoint list_additional_recipient_receivables in ReportingApi is '\
-           'deprecated'
-      # Prepare query url.
-      _query_builder = config.get_base_uri
-      _query_builder << '/v2/locations/{location_id}/additional-recipient-receivables'
-      _query_builder = APIHelper.append_url_with_template_parameters(
-        _query_builder,
-        'location_id' => location_id
-      )
-      _query_builder = APIHelper.append_url_with_query_parameters(
-        _query_builder,
-        'begin_time' => begin_time,
-        'end_time' => end_time,
-        'sort_order' => sort_order,
-        'cursor' => cursor
-      )
-      _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