square.rb 18.0.0.20220216 → 20.0.0.20220512

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/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

@@ -5,6 +5,149 @@ module Square
       super(config, http_call_back: http_call_back)
     end
 
+    # Creates a Terminal action request and sends it to the specified device to
+    # take a payment
+    # for the requested amount.
+    # @param [CreateTerminalActionRequest] body Required parameter: An object
+    # containing the fields to POST for the request.  See the corresponding
+    # object definition for field details.
+    # @return [CreateTerminalActionResponse Hash] response from the API call
+    def create_terminal_action(body:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/terminals/actions'
+      _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
+      )
+    end
+
+    # Retrieves a filtered list of Terminal action requests created by the
+    # account making the request. Terminal action requests are available for 30
+    # days.
+    # @param [SearchTerminalActionsRequest] body Required parameter: An object
+    # containing the fields to POST for the request.  See the corresponding
+    # object definition for field details.
+    # @return [SearchTerminalActionsResponse Hash] response from the API call
+    def search_terminal_actions(body:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/terminals/actions/search'
+      _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
+      )
+    end
+
+    # Retrieves a Terminal action request by `action_id`. Terminal action
+    # requests are available for 30 days.
+    # @param [String] action_id Required parameter: Unique ID for the desired
+    # `TerminalAction`
+    # @return [GetTerminalActionResponse Hash] response from the API call
+    def get_terminal_action(action_id:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/terminals/actions/{action_id}'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'action_id' => { 'value' => action_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
+
+    # Cancels a Terminal action request if the status of the request permits it.
+    # @param [String] action_id Required parameter: Unique ID for the desired
+    # `TerminalAction`
+    # @return [CancelTerminalActionResponse Hash] response from the API call
+    def cancel_terminal_action(action_id:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/terminals/actions/{action_id}/cancel'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'action_id' => { 'value' => action_id, 'encode' => true }
+      )
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json'
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.post(
+        _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
+
     # Creates a Terminal checkout request and sends it to the specified device
     # to take a payment
     # for the requested amount.
@@ -41,8 +184,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 +221,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 +294,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 +332,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 +367,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/api/vendors_api.rb

@@ -0,0 +1,257 @@
+module Square
+  # VendorsApi
+  class VendorsApi < BaseApi
+    def initialize(config, http_call_back: nil)
+      super(config, http_call_back: http_call_back)
+    end
+
+    # Creates one or more [Vendor]($m/Vendor) objects to represent suppliers to
+    # a seller.
+    # @param [BulkCreateVendorsRequest] body Required parameter: An object
+    # containing the fields to POST for the request.  See the corresponding
+    # object definition for field details.
+    # @return [BulkCreateVendorsResponse Hash] response from the API call
+    def bulk_create_vendors(body:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/vendors/bulk-create'
+      _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
+      )
+    end
+
+    # Retrieves one or more vendors of specified [Vendor]($m/Vendor) IDs.
+    # @param [BulkRetrieveVendorsRequest] body Required parameter: An object
+    # containing the fields to POST for the request.  See the corresponding
+    # object definition for field details.
+    # @return [BulkRetrieveVendorsResponse Hash] response from the API call
+    def bulk_retrieve_vendors(body:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/vendors/bulk-retrieve'
+      _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
+      )
+    end
+
+    # Updates one or more of existing [Vendor]($m/Vendor) objects as suppliers
+    # to a seller.
+    # @param [BulkUpdateVendorsRequest] body Required parameter: An object
+    # containing the fields to POST for the request.  See the corresponding
+    # object definition for field details.
+    # @return [BulkUpdateVendorsResponse Hash] response from the API call
+    def bulk_update_vendors(body:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/vendors/bulk-update'
+      _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.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
+
+    # Creates a single [Vendor]($m/Vendor) object to represent a supplier to a
+    # seller.
+    # @param [CreateVendorRequest] body Required parameter: An object containing
+    # the fields to POST for the request.  See the corresponding object
+    # definition for field details.
+    # @return [CreateVendorResponse Hash] response from the API call
+    def create_vendor(body:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/vendors/create'
+      _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
+      )
+    end
+
+    # Searches for vendors using a filter against supported [Vendor]($m/Vendor)
+    # properties and a supported sorter.
+    # @param [SearchVendorsRequest] body Required parameter: An object
+    # containing the fields to POST for the request.  See the corresponding
+    # object definition for field details.
+    # @return [SearchVendorsResponse Hash] response from the API call
+    def search_vendors(body:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/vendors/search'
+      _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
+      )
+    end
+
+    # Retrieves the vendor of a specified [Vendor]($m/Vendor) ID.
+    # @param [String] vendor_id Required parameter: ID of the
+    # [Vendor]($m/Vendor) to retrieve.
+    # @return [RetrieveVendorResponse Hash] response from the API call
+    def retrieve_vendor(vendor_id:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/vendors/{vendor_id}'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'vendor_id' => { 'value' => vendor_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
+
+    # Updates an existing [Vendor]($m/Vendor) object as a supplier to a seller.
+    # @param [UpdateVendorRequest] body Required parameter: An object containing
+    # the fields to POST for the request.  See the corresponding object
+    # definition for field details.
+    # @param [String] vendor_id Required parameter: Example:
+    # @return [UpdateVendorResponse Hash] response from the API call
+    def update_vendor(body:,
+                      vendor_id:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/vendors/{vendor_id}'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'vendor_id' => { 'value' => vendor_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.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
+  end
+end