square.rb 20.1.0.20220616 → 22.0.0.20220817

data/lib/square/api/loyalty_api.rb

@@ -113,20 +113,30 @@ module Square
       )
     end
 
-    # Adds points earned from the base loyalty program to a loyalty account.
-    # - If you are using the Orders API to manage orders, you only provide the
-    # `order_id`.
-    # The endpoint reads the order to compute points to add to the buyer's
-    # account.
-    # - If you are not using the Orders API to manage orders,
-    # you first perform a client-side computation to compute the points.
-    # For spend-based and visit-based programs, you can first call
-    # [CalculateLoyaltyPoints]($e/Loyalty/CalculateLoyaltyPoints) to compute the
-    # points
-    # that you provide to this endpoint.
-    # This endpoint excludes additional points earned from loyalty promotions.
-    # @param [String] account_id Required parameter: The [loyalty
-    # account]($m/LoyaltyAccount) ID to which to add the points.
+    # Adds points earned from a purchase to a [loyalty
+    # account]($m/LoyaltyAccount).
+    # - If you are using the Orders API to manage orders, provide the
+    # `order_id`. Square reads the order
+    # to compute the points earned from both the base loyalty program and an
+    # associated
+    # [loyalty promotion]($m/LoyaltyPromotion). For purchases that qualify for
+    # multiple accrual
+    # rules, Square computes points based on the accrual rule that grants the
+    # most points.
+    # For purchases that qualify for multiple promotions, Square computes points
+    # based on the most
+    # recently created promotion. A purchase must first qualify for program
+    # points to be eligible for promotion points.
+    # - If you are not using the Orders API to manage orders, provide `points`
+    # with the number of points to add.
+    # You must first perform a client-side computation of the points earned from
+    # the loyalty program and
+    # loyalty promotion. For spend-based and visit-based programs, you can call
+    # [CalculateLoyaltyPoints]($e/Loyalty/CalculateLoyaltyPoints)
+    # to compute the points earned from the loyalty program (but not points
+    # earned from a loyalty promotion).
+    # @param [String] account_id Required parameter: The ID of the target
+    # [loyalty account]($m/LoyaltyAccount).
     # @param [AccumulateLoyaltyPointsRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
@@ -170,8 +180,8 @@ module Square
     # in your application flow, you call
     # [AccumulateLoyaltyPoints]($e/Loyalty/AccumulateLoyaltyPoints)
     # to add points when a buyer pays for the purchase.
-    # @param [String] account_id Required parameter: The ID of the [loyalty
-    # account]($m/LoyaltyAccount) in which to adjust the points.
+    # @param [String] account_id Required parameter: The ID of the target
+    # [loyalty account]($m/LoyaltyAccount).
     # @param [AdjustLoyaltyPointsRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
@@ -330,21 +340,32 @@ module Square
       )
     end
 
-    # Calculates the points a purchase earns from the base loyalty program.
-    # - If you are using the Orders API to manage orders, you provide the
-    # `order_id` in the request. The
-    # endpoint calculates the points by reading the order.
-    # - If you are not using the Orders API to manage orders, you provide the
-    # purchase amount in
-    # the request for the endpoint to calculate the points.
-    # An application might call this endpoint to show the points that a buyer
-    # can earn with the
-    # specific purchase.
-    # For spend-based and visit-based programs, the `tax_mode` setting of the
-    # accrual rule indicates how taxes should be treated for loyalty points
-    # accrual.
-    # @param [String] program_id Required parameter: The [loyalty
-    # program]($m/LoyaltyProgram) ID, which defines the rules for accruing
+    # Calculates the number of points a buyer can earn from a purchase.
+    # Applications might call this endpoint
+    # to display the points to the buyer.
+    # - If you are using the Orders API to manage orders, provide the `order_id`
+    # and (optional) `loyalty_account_id`.
+    # Square reads the order to compute the points earned from the base loyalty
+    # program and an associated
+    # [loyalty promotion]($m/LoyaltyPromotion).
+    # - If you are not using the Orders API to manage orders, provide
+    # `transaction_amount_money` with the
+    # purchase amount. Square uses this amount to calculate the points earned
+    # from the base loyalty program,
+    # but not points earned from a loyalty promotion. For spend-based and
+    # visit-based programs, the `tax_mode`
+    # setting of the accrual rule indicates how taxes should be treated for
+    # loyalty points accrual.
+    # If the purchase qualifies for program points, call
+    # [ListLoyaltyPromotions]($e/Loyalty/ListLoyaltyPromotions) and perform a
+    # client-side computation
+    # to calculate whether the purchase also qualifies for promotion points. For
+    # more information, see
+    # [Calculating promotion
+    # points](https://developer.squareup.com/docs/loyalty-api/loyalty-promotions
+    # #calculate-promotion-points).
+    # @param [String] program_id Required parameter: The ID of the [loyalty
+    # program]($m/LoyaltyProgram), which defines the rules for accruing
     # points.
     # @param [CalculateLoyaltyPointsRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
@@ -384,6 +405,210 @@ module Square
       )
     end
 
+    # Lists the loyalty promotions associated with a [loyalty
+    # program]($m/LoyaltyProgram).
+    # Results are sorted by the `created_at` date in descending order (newest to
+    # oldest).
+    # @param [String] program_id Required parameter: The ID of the base [loyalty
+    # program]($m/LoyaltyProgram). To get the program ID, call
+    # [RetrieveLoyaltyProgram]($e/Loyalty/RetrieveLoyaltyProgram) using the
+    # `main` keyword.
+    # @param [LoyaltyPromotionStatus] status Optional parameter: The status to
+    # filter the results by. If a status is provided, only loyalty promotions
+    # with the specified status are returned. Otherwise, all loyalty promotions
+    # associated with the loyalty program are returned.
+    # @param [String] cursor Optional parameter: The cursor returned in the
+    # paged response from the previous call to this endpoint. Provide this
+    # cursor to retrieve the next page of results for your original request. For
+    # more information, see
+    # [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 paged response. The minimum value is 1 and the
+    # maximum value is 30. The default value is 30. For more information, see
+    # [Pagination](https://developer.squareup.com/docs/build-basics/common-api-p
+    # atterns/pagination).
+    # @return [ListLoyaltyPromotionsResponse Hash] response from the API call
+    def list_loyalty_promotions(program_id:,
+                                status: nil,
+                                cursor: nil,
+                                limit: nil)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/loyalty/programs/{program_id}/promotions'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'program_id' => { 'value' => program_id, 'encode' => true }
+      )
+      _query_builder = APIHelper.append_url_with_query_parameters(
+        _query_builder,
+        'status' => status,
+        '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
+
+    # Creates a loyalty promotion for a [loyalty program]($m/LoyaltyProgram). A
+    # loyalty promotion
+    # enables buyers to earn points in addition to those earned from the base
+    # loyalty program.
+    # This endpoint sets the loyalty promotion to the `ACTIVE` or `SCHEDULED`
+    # status, depending on the
+    # `available_time` setting. A loyalty program can have a maximum of 10
+    # loyalty promotions with an
+    # `ACTIVE` or `SCHEDULED` status.
+    # @param [String] program_id Required parameter: The ID of the [loyalty
+    # program]($m/LoyaltyProgram) to associate with the promotion. To get the
+    # program ID, call
+    # [RetrieveLoyaltyProgram]($e/Loyalty/RetrieveLoyaltyProgram) using the
+    # `main` keyword.
+    # @param [CreateLoyaltyPromotionRequest] body Required parameter: An object
+    # containing the fields to POST for the request.  See the corresponding
+    # object definition for field details.
+    # @return [CreateLoyaltyPromotionResponse Hash] response from the API call
+    def create_loyalty_promotion(program_id:,
+                                 body:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/loyalty/programs/{program_id}/promotions'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'program_id' => { 'value' => program_id, 'encode' => true }
+      )
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json',
+        'Content-Type' => 'application/json'
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.post(
+        _query_url,
+        headers: _headers,
+        parameters: body.to_json
+      )
+      OAuth2.apply(config, _request)
+      _response = execute_request(_request)
+
+      # Return appropriate response type.
+      decoded = APIHelper.json_deserialize(_response.raw_body)
+      _errors = APIHelper.map_response(decoded, ['errors'])
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
+    end
+
+    # Retrieves a loyalty promotion.
+    # @param [String] promotion_id Required parameter: The ID of the [loyalty
+    # promotion]($m/LoyaltyPromotion) to retrieve.
+    # @param [String] program_id Required parameter: The ID of the base [loyalty
+    # program]($m/LoyaltyProgram). To get the program ID, call
+    # [RetrieveLoyaltyProgram]($e/Loyalty/RetrieveLoyaltyProgram) using the
+    # `main` keyword.
+    # @return [RetrieveLoyaltyPromotionResponse Hash] response from the API call
+    def retrieve_loyalty_promotion(promotion_id:,
+                                   program_id:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/loyalty/programs/{program_id}/promotions/{promotion_id}'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'promotion_id' => { 'value' => promotion_id, 'encode' => true },
+        'program_id' => { 'value' => program_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 loyalty promotion. Use this endpoint to cancel an `ACTIVE`
+    # promotion earlier than the
+    # end date, cancel an `ACTIVE` promotion when an end date is not specified,
+    # or cancel a `SCHEDULED` promotion.
+    # Because updating a promotion is not supported, you can also use this
+    # endpoint to cancel a promotion before
+    # you create a new one.
+    # This endpoint sets the loyalty promotion to the `CANCELED` state
+    # @param [String] promotion_id Required parameter: The ID of the [loyalty
+    # promotion]($m/LoyaltyPromotion) to cancel. You can cancel a promotion that
+    # has an `ACTIVE` or `SCHEDULED` status.
+    # @param [String] program_id Required parameter: The ID of the base [loyalty
+    # program]($m/LoyaltyProgram).
+    # @return [CancelLoyaltyPromotionResponse Hash] response from the API call
+    def cancel_loyalty_promotion(promotion_id:,
+                                 program_id:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/loyalty/programs/{program_id}/promotions/{promotion_id}/cancel'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'promotion_id' => { 'value' => promotion_id, 'encode' => true },
+        'program_id' => { 'value' => program_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 loyalty reward. In the process, the endpoint does following:
     # - Uses the `reward_tier_id` in the request to determine the number of
     # points

data/lib/square/api/orders_api.rb

@@ -244,8 +244,8 @@ module Square
     # - 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)
+    # order](https://developer.squareup.com/docs/orders-api/manage-orders/update
+    # -orders#sparse-order-objects)
     # containing only the fields to update and the version to which the update
     # is
     # being applied.

data/lib/square/api/payments_api.rb

@@ -26,7 +26,7 @@ module Square
     # @param [String] location_id Optional parameter: Limit results to the
     # location supplied. By default, results are returned for the default (main)
     # location associated with the seller.
-    # @param [Long] total Optional parameter: The exact amount in the
+    # @param [Integer] total Optional parameter: The exact amount in the
     # `total_money` for a payment.
     # @param [String] last_4 Optional parameter: The last four digits of a
     # payment card.

data/lib/square/api/v1_transactions_api.rb

@@ -175,10 +175,10 @@ module Square
     # @param [String] batch_token Optional parameter: A pagination cursor to
     # retrieve the next set of results for your original query to the
     # endpoint.
-    # @param [Boolean] include_partial Optional parameter: Indicates whether or
-    # not to include partial payments in the response. Partial payments will
-    # have the tenders collected so far, but the itemizations will be empty
-    # until the payment is completed.
+    # @param [TrueClass|FalseClass] include_partial Optional parameter:
+    # Indicates whether or not to include partial payments in the response.
+    # Partial payments will have the tenders collected so far, but the
+    # itemizations will be empty until the payment is completed.
     # @return [List of V1Payment Hash] response from the API call
     def list_payments(location_id:,
                       order: nil,

data/lib/square/api/webhook_subscriptions_api.rb

@@ -0,0 +1,328 @@
+module Square
+  # WebhookSubscriptionsApi
+  class WebhookSubscriptionsApi < BaseApi
+    def initialize(config, http_call_back: nil)
+      super(config, http_call_back: http_call_back)
+    end
+
+    # Lists all webhook event types that can be subscribed to.
+    # @param [String] api_version Optional parameter: The API version for which
+    # to list event types. Setting this field overrides the default version used
+    # by the application.
+    # @return [ListWebhookEventTypesResponse Hash] response from the API call
+    def list_webhook_event_types(api_version: nil)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/webhooks/event-types'
+      _query_builder = APIHelper.append_url_with_query_parameters(
+        _query_builder,
+        'api_version' => api_version
+      )
+      _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
+
+    # Lists all webhook subscriptions owned by your application.
+    # @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.  For more information, see
+    # [Pagination](https://developer.squareup.com/docs/basics/api101/pagination)
+    # .
+    # @param [TrueClass|FalseClass] include_disabled Optional parameter:
+    # Includes disabled [Subscription]($m/WebhookSubscription)s. By default, all
+    # enabled [Subscription]($m/WebhookSubscription)s are returned.
+    # @param [SortOrder] sort_order Optional parameter: Sorts the returned list
+    # by when the [Subscription]($m/WebhookSubscription) was created with the
+    # specified order. This field defaults to ASC.
+    # @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 [ListWebhookSubscriptionsResponse Hash] response from the API call
+    def list_webhook_subscriptions(cursor: nil,
+                                   include_disabled: false,
+                                   sort_order: nil,
+                                   limit: nil)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/webhooks/subscriptions'
+      _query_builder = APIHelper.append_url_with_query_parameters(
+        _query_builder,
+        'cursor' => cursor,
+        'include_disabled' => include_disabled,
+        'sort_order' => sort_order,
+        '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
+
+    # Creates a webhook subscription.
+    # @param [CreateWebhookSubscriptionRequest] body Required parameter: An
+    # object containing the fields to POST for the request.  See the
+    # corresponding object definition for field details.
+    # @return [CreateWebhookSubscriptionResponse Hash] response from the API call
+    def create_webhook_subscription(body:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/webhooks/subscriptions'
+      _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
+
+    # Deletes a webhook subscription.
+    # @param [String] subscription_id Required parameter: [REQUIRED] The ID of
+    # the [Subscription]($m/WebhookSubscription) to delete.
+    # @return [DeleteWebhookSubscriptionResponse Hash] response from the API call
+    def delete_webhook_subscription(subscription_id:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/webhooks/subscriptions/{subscription_id}'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'subscription_id' => { 'value' => subscription_id, 'encode' => true }
+      )
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json'
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.delete(
+        _query_url,
+        headers: _headers
+      )
+      OAuth2.apply(config, _request)
+      _response = execute_request(_request)
+
+      # Return appropriate response type.
+      decoded = APIHelper.json_deserialize(_response.raw_body)
+      _errors = APIHelper.map_response(decoded, ['errors'])
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
+    end
+
+    # Retrieves a webhook subscription identified by its ID.
+    # @param [String] subscription_id Required parameter: [REQUIRED] The ID of
+    # the [Subscription]($m/WebhookSubscription) to retrieve.
+    # @return [RetrieveWebhookSubscriptionResponse Hash] response from the API call
+    def retrieve_webhook_subscription(subscription_id:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/webhooks/subscriptions/{subscription_id}'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'subscription_id' => { 'value' => subscription_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 a webhook subscription.
+    # @param [String] subscription_id Required parameter: [REQUIRED] The ID of
+    # the [Subscription]($m/WebhookSubscription) to update.
+    # @param [UpdateWebhookSubscriptionRequest] body Required parameter: An
+    # object containing the fields to POST for the request.  See the
+    # corresponding object definition for field details.
+    # @return [UpdateWebhookSubscriptionResponse Hash] response from the API call
+    def update_webhook_subscription(subscription_id:,
+                                    body:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/webhooks/subscriptions/{subscription_id}'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'subscription_id' => { 'value' => subscription_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
+
+    # Updates a webhook subscription by replacing the existing signature key
+    # with a new one.
+    # @param [String] subscription_id Required parameter: [REQUIRED] The ID of
+    # the [Subscription]($m/WebhookSubscription) to update.
+    # @param [UpdateWebhookSubscriptionSignatureKeyRequest] body Required
+    # parameter: An object containing the fields to POST for the request.  See
+    # the corresponding object definition for field details.
+    # @return [UpdateWebhookSubscriptionSignatureKeyResponse Hash] response from the API call
+    def update_webhook_subscription_signature_key(subscription_id:,
+                                                  body:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/webhooks/subscriptions/{subscription_id}/signature-key'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'subscription_id' => { 'value' => subscription_id, 'encode' => true }
+      )
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json',
+        'Content-Type' => 'application/json'
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.post(
+        _query_url,
+        headers: _headers,
+        parameters: body.to_json
+      )
+      OAuth2.apply(config, _request)
+      _response = execute_request(_request)
+
+      # Return appropriate response type.
+      decoded = APIHelper.json_deserialize(_response.raw_body)
+      _errors = APIHelper.map_response(decoded, ['errors'])
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
+    end
+
+    # Tests a webhook subscription by sending a test event to the notification
+    # URL.
+    # @param [String] subscription_id Required parameter: [REQUIRED] The ID of
+    # the [Subscription]($m/WebhookSubscription) to test.
+    # @param [TestWebhookSubscriptionRequest] body Required parameter: An object
+    # containing the fields to POST for the request.  See the corresponding
+    # object definition for field details.
+    # @return [TestWebhookSubscriptionResponse Hash] response from the API call
+    def test_webhook_subscription(subscription_id:,
+                                  body:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/webhooks/subscriptions/{subscription_id}/test'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'subscription_id' => { 'value' => subscription_id, 'encode' => true }
+      )
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json',
+        'Content-Type' => 'application/json'
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.post(
+        _query_url,
+        headers: _headers,
+        parameters: body.to_json
+      )
+      OAuth2.apply(config, _request)
+      _response = execute_request(_request)
+
+      # Return appropriate response type.
+      decoded = APIHelper.json_deserialize(_response.raw_body)
+      _errors = APIHelper.map_response(decoded, ['errors'])
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
+    end
+  end
+end