square.rb 21.0.0.20220720 → 22.1.0.20220823

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b8c49dc5dec3f51ebfdb70e1789d9ffd0c1826b9f953c7a1e0fa59b62dae9d4f
-  data.tar.gz: b49dd9dbf71cdb0c1371dc0f5fb9505a26aaffe5c1905a366a3e46ecae5ea7fe
+  metadata.gz: f952653c6d92ab4ba153d309a21a095d59ce4592c5f7660b3a0f91e15ff2815a
+  data.tar.gz: 2f714f5c6b9fcb2b93f999e0d351fffcd0f01a913bfddad6afa9df9429b6f143
 SHA512:
-  metadata.gz: bf2fcb52842fd5fc4f4b0cce1196a0276b882ec2d27d9a1d1eb6c717c0130eca6c52c0fda1d176bf4cc7f78f64b018162a58e484aa548534f58bf5738cee0e8d
-  data.tar.gz: d2efdfc7be2f8afde9906e01bc3b6dac865fd092f0394ea5ebe3e427101752251100ff409e8a9fff7b5c7d7af5d52278ec641289b90a52a8c6aa70715ce6c39c
+  metadata.gz: 4ac0adc3626aea0ad54bf9a40b1200429e8359c19a72da3f8e359b33ea686642c29f0f97519a4d9f9831095e64e4b8d3b2dcec35c032dcdf20784baa4e1cb235
+  data.tar.gz: 6b6e81d0b85c809a44df30fd0e53754cc881ebe1c3a37722ef9b4db476f0b2fb8bcf67090ed061b79ea2b0468378fdc409ac2a278bf266fb5efc97567aa5a986

data/lib/square/api/base_api.rb

@@ -45,7 +45,7 @@ module Square
     end
 
     def get_user_agent
-      user_agent = 'Square-Ruby-SDK/21.0.0.20220720 ({api-version}) {engine}/{engine-version} ({os-info}) {detail}'
+      user_agent = 'Square-Ruby-SDK/22.1.0.20220823 ({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/checkout_api.rb

@@ -23,6 +23,7 @@ module Square
     # @return [CreateCheckoutResponse Hash] response from the API call
     def create_checkout(location_id:,
                         body:)
+      warn 'Endpoint create_checkout in CheckoutApi is deprecated'
       # Prepare query url.
       _query_builder = config.get_base_uri
       _query_builder << '/v2/locations/{location_id}/checkouts'
@@ -57,14 +58,13 @@ module Square
 
     # Lists all payment links.
     # @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.  If a cursor is not provided,
-    # the endpoint returns the first page of the results.  For more 
-    # information, see
+    # a previous call to this endpoint. Provide this cursor to retrieve the next
+    # set of results for the original query. If a cursor is not provided, the
+    # endpoint returns the first page of the results. For more  information, see
     # [Pagination](https://developer.squareup.com/docs/basics/api101/pagination)
     # .
     # @param [Integer] limit Optional parameter: A limit on the number of
-    # results to return per page. The limit is advisory and  the implementation
+    # results to return per page. The limit is advisory and the implementation
     # might return more or less results. If the supplied limit is negative,
     # zero, or greater than the maximum limit of 1000, it is ignored.  Default
     # value: `100`

data/lib/square/api/customer_custom_attributes_api.rb

@@ -5,14 +5,17 @@ module Square
       super(config, http_call_back: http_call_back)
     end
 
-    # Lists the customer-related custom attribute definitions that belong to a
-    # Square seller account.
+    # Lists the customer-related [custom attribute
+    # definitions]($m/CustomAttributeDefinition) that belong to a Square seller
+    # account.
     # When all response pages are retrieved, the results include all custom
     # attribute definitions
     # that are visible to the requesting application, including those that are
     # created by other
     # applications and set to `VISIBILITY_READ_ONLY` or
-    # `VISIBILITY_READ_WRITE_VALUES`.
+    # `VISIBILITY_READ_WRITE_VALUES`. Note that
+    # seller-defined custom attributes (also known as custom fields) are always
+    # set to `VISIBILITY_READ_WRITE_VALUES`.
     # @param [Integer] limit Optional parameter: The maximum number of results
     # to return in a single paged response. This limit is advisory. The response
     # might contain more or fewer results. The minimum value is 1 and the
@@ -59,10 +62,10 @@ module Square
       )
     end
 
-    # Creates a customer-related custom attribute definition for a Square seller
-    # account. Use this
-    # endpoint to define a custom attribute that can be associated with customer
-    # profiles.
+    # Creates a customer-related [custom attribute
+    # definition]($m/CustomAttributeDefinition) for a Square seller account.
+    # Use this endpoint to define a custom attribute that can be associated with
+    # customer profiles.
     # A custom attribute definition specifies the `key`, `visibility`, `schema`,
     # and other properties
     # for a custom attribute. After the definition is created, you can call
@@ -108,8 +111,8 @@ module Square
       )
     end
 
-    # Deletes a customer-related custom attribute definition from a Square
-    # seller account.
+    # Deletes a customer-related [custom attribute
+    # definition]($m/CustomAttributeDefinition) from a Square seller account.
     # Deleting a custom attribute definition also deletes the corresponding
     # custom attribute from
     # all customer profiles in the seller's Customer Directory.
@@ -148,11 +151,14 @@ module Square
       )
     end
 
-    # Retrieves a customer-related custom attribute definition from a Square
-    # seller account.
+    # Retrieves a customer-related [custom attribute
+    # definition]($m/CustomAttributeDefinition) from a Square seller account.
     # To retrieve a custom attribute definition created by another application,
     # the `visibility`
     # setting must be `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.
+    # Note that seller-defined custom attributes
+    # (also known as custom fields) are always set to
+    # `VISIBILITY_READ_WRITE_VALUES`.
     # @param [String] key Required parameter: The key of the custom attribute
     # definition to retrieve. If the requesting application is not the
     # definition owner, you must use the qualified key.
@@ -199,8 +205,8 @@ module Square
       )
     end
 
-    # Updates a customer-related custom attribute definition for a Square seller
-    # account.
+    # Updates a customer-related [custom attribute
+    # definition]($m/CustomAttributeDefinition) for a Square seller account.
     # Use this endpoint to update the following fields: `name`, `description`,
     # `visibility`, or the
     # `schema` for a `Selection` data type.
@@ -248,8 +254,8 @@ module Square
       )
     end
 
-    # Creates or updates custom attributes for customer profiles as a bulk
-    # operation.
+    # Creates or updates [custom attributes]($m/CustomAttribute) for customer
+    # profiles as a bulk operation.
     # Use this endpoint to set the value of one or more custom attributes for
     # one or more customer profiles.
     # A custom attribute is based on a custom attribute definition in a Square
@@ -266,7 +272,10 @@ module Square
     # of the corresponding request.
     # To create or update a custom attribute owned by another application, the
     # `visibility` setting
-    # must be `VISIBILITY_READ_WRITE_VALUES`.
+    # must be `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom
+    # attributes
+    # (also known as custom fields) are always set to
+    # `VISIBILITY_READ_WRITE_VALUES`.
     # @param [BulkUpsertCustomerCustomAttributesRequest] body Required
     # parameter: An object containing the fields to POST for the request.  See
     # the corresponding object definition for field details.
@@ -300,7 +309,8 @@ module Square
       )
     end
 
-    # Lists the custom attributes associated with a customer profile.
+    # Lists the [custom attributes]($m/CustomAttribute) associated with a
+    # customer profile.
     # You can use the `with_definitions` query parameter to also retrieve custom
     # attribute definitions
     # in the same call.
@@ -370,9 +380,12 @@ module Square
       )
     end
 
-    # Deletes a custom attribute associated with a customer profile.
+    # Deletes a [custom attribute]($m/CustomAttribute) associated with a
+    # customer profile.
     # To delete a custom attribute owned by another application, the
     # `visibility` setting must be
+    # `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom attributes
+    # (also known as custom fields) are always set to
     # `VISIBILITY_READ_WRITE_VALUES`.
     # @param [String] customer_id Required parameter: The ID of the target
     # [customer profile]($m/Customer).
@@ -414,13 +427,17 @@ module Square
       )
     end
 
-    # Retrieves a custom attribute associated with a customer profile.
+    # Retrieves a [custom attribute]($m/CustomAttribute) associated with a
+    # customer profile.
     # You can use the `with_definition` query parameter to also retrieve the
     # custom attribute definition
     # in the same call.
     # To retrieve a custom attribute owned by another application, the
     # `visibility` setting must be
-    # `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`.
+    # `VISIBILITY_READ_ONLY` or `VISIBILITY_READ_WRITE_VALUES`. Note that
+    # seller-defined custom attributes
+    # (also known as custom fields) are always set to
+    # `VISIBILITY_READ_WRITE_VALUES`.
     # @param [String] customer_id Required parameter: The ID of the target
     # [customer profile]($m/Customer).
     # @param [String] key Required parameter: The key of the custom attribute to
@@ -480,7 +497,8 @@ module Square
       )
     end
 
-    # Creates or updates a custom attribute for a customer profile.
+    # Creates or updates a [custom attribute]($m/CustomAttribute) for a customer
+    # profile.
     # Use this endpoint to set the value of a custom attribute for a specified
     # customer profile.
     # A custom attribute is based on a custom attribute definition in a Square
@@ -490,7 +508,10 @@ module Square
     # teCustomerCustomAttributeDefinition) endpoint.
     # To create or update a custom attribute owned by another application, the
     # `visibility` setting
-    # must be `VISIBILITY_READ_WRITE_VALUES`.
+    # must be `VISIBILITY_READ_WRITE_VALUES`. Note that seller-defined custom
+    # attributes
+    # (also known as custom fields) are always set to
+    # `VISIBILITY_READ_WRITE_VALUES`.
     # @param [String] customer_id Required parameter: The ID of the target
     # [customer profile]($m/Customer).
     # @param [String] key Required parameter: The key of the custom attribute to

data/lib/square/api/customers_api.rb

@@ -110,8 +110,8 @@ module Square
       )
     end
 
-    # Searches the customer profiles associated with a Square account using a
-    # supported query filter.
+    # Searches the customer profiles associated with a Square account using one
+    # or more supported query filters.
     # Calling `SearchCustomers` without any explicit query filter returns all
     # customer profiles ordered alphabetically based on `given_name` and
     # `family_name`.

data/lib/square/api/disputes_api.rb

@@ -11,13 +11,12 @@ module Square
     # set of results for the original query. For more information, see
     # [Pagination](https://developer.squareup.com/docs/basics/api101/pagination)
     # .
-    # @param [DisputeState] states Optional parameter: The dispute states to
-    # filter the result. If not specified, the endpoint returns all open
-    # disputes (the dispute status is not `INQUIRY_CLOSED`, `WON`, or `LOST`).
+    # @param [DisputeState] states Optional parameter: The dispute states used
+    # to filter the result. If not specified, the endpoint returns all
+    # disputes.
     # @param [String] location_id Optional parameter: The ID of the location for
     # which to return a list of disputes. If not specified, the endpoint returns
-    # all open disputes (the dispute status is not `INQUIRY_CLOSED`, `WON`, or
-    # `LOST`) associated with all locations.
+    # disputes associated with all locations.
     # @return [ListDisputesResponse Hash] response from the API call
     def list_disputes(cursor: nil,
                       states: nil,
@@ -134,8 +133,8 @@ 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 the original query. For more information, see
-    # [Pagination](https://developer.squareup.com/docs/basics/api101/pagination)
-    # .
+    # [Pagination](https://developer.squareup.com/docs/build-basics/common-api-p
+    # atterns/pagination).
     # @return [ListDisputeEvidenceResponse Hash] response from the API call
     def list_dispute_evidence(dispute_id:,
                               cursor: nil)
@@ -177,8 +176,8 @@ module Square
     # accepts HTTP
     # multipart/form-data file uploads in HEIC, HEIF, JPEG, PDF, PNG, and TIFF
     # formats.
-    # @param [String] dispute_id Required parameter: The ID of the dispute you
-    # want to upload evidence for.
+    # @param [String] dispute_id Required parameter: The ID of the dispute for
+    # which you want to upload evidence.
     # @param [CreateDisputeEvidenceFileRequest] request Optional parameter:
     # Defines the parameters for a `CreateDisputeEvidenceFile` request.
     # @param [File | UploadIO] image_file Optional parameter: Example:
@@ -239,8 +238,8 @@ module Square
     end
 
     # Uploads text to use as evidence for a dispute challenge.
-    # @param [String] dispute_id Required parameter: The ID of the dispute you
-    # want to upload evidence for.
+    # @param [String] dispute_id Required parameter: The ID of the dispute for
+    # which you want to upload evidence.
     # @param [CreateDisputeEvidenceTextRequest] body Required parameter: An
     # object containing the fields to POST for the request.  See the
     # corresponding object definition for field details.
@@ -280,12 +279,9 @@ module Square
     end
 
     # Removes specified evidence from a dispute.
-    # Square does not send the bank any evidence that is removed. Also, you
-    # cannot remove evidence after
-    # submitting it to the bank using
-    # [SubmitEvidence]($e/Disputes/SubmitEvidence).
-    # @param [String] dispute_id Required parameter: The ID of the dispute you
-    # want to remove evidence from.
+    # Square does not send the bank any evidence that is removed.
+    # @param [String] dispute_id Required parameter: The ID of the dispute from
+    # which you want to remove evidence.
     # @param [String] evidence_id Required parameter: The ID of the evidence you
     # want to remove.
     # @return [DeleteDisputeEvidenceResponse Hash] response from the API call
@@ -322,13 +318,11 @@ module Square
       )
     end
 
-    # Returns the evidence metadata specified by the evidence ID in the request
-    # URL path
-    # You must maintain a copy of the evidence you upload if you want to
-    # reference it later. You cannot
-    # download the evidence after you upload it.
-    # @param [String] dispute_id Required parameter: The ID of the dispute that
-    # you want to retrieve evidence from.
+    # Returns the metadata for the evidence specified in the request URL path.
+    # You must maintain a copy of any evidence uploaded if you want to reference
+    # it later. Evidence cannot be downloaded after you upload it.
+    # @param [String] dispute_id Required parameter: The ID of the dispute from
+    # which you want to retrieve evidence metadata.
     # @param [String] evidence_id Required parameter: The ID of the evidence to
     # retrieve.
     # @return [RetrieveDisputeEvidenceResponse Hash] response from the API call
@@ -366,15 +360,16 @@ module Square
     end
 
     # Submits evidence to the cardholder's bank.
-    # Before submitting evidence, Square compiles all available evidence. This
-    # includes evidence uploaded
+    # The evidence submitted by this endpoint includes evidence uploaded
     # using the
     # [CreateDisputeEvidenceFile]($e/Disputes/CreateDisputeEvidenceFile) and
     # [CreateDisputeEvidenceText]($e/Disputes/CreateDisputeEvidenceText)
     # endpoints and
-    # evidence automatically provided by Square, when available.
-    # @param [String] dispute_id Required parameter: The ID of the dispute that
-    # you want to submit evidence for.
+    # evidence automatically provided by Square, when available. Evidence cannot
+    # be removed from
+    # a dispute after submission.
+    # @param [String] dispute_id Required parameter: The ID of the dispute for
+    # which you want to submit evidence.
     # @return [SubmitEvidenceResponse Hash] response from the API call
     def submit_evidence(dispute_id:)
       # Prepare query url.

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

data/lib/square/client.rb

@@ -4,7 +4,7 @@ module Square
     attr_reader :config
 
     def sdk_version
-      '21.0.0.20220720'
+      '22.1.0.20220823'
     end
 
     def square_version
@@ -231,12 +231,18 @@ module Square
       @vendors ||= VendorsApi.new config
     end
 
+    # Access to webhook_subscriptions controller.
+    # @return [WebhookSubscriptionsApi] Returns the controller instance.
+    def webhook_subscriptions
+      @webhook_subscriptions ||= WebhookSubscriptionsApi.new config
+    end
+
     def initialize(connection: nil, adapter: :net_http_persistent, timeout: 60,
                    max_retries: 0, retry_interval: 1, backoff_factor: 2,
                    retry_statuses: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524],
                    retry_methods: %i[get put], environment: 'production',
                    custom_url: 'https://connect.squareup.com',
-                   square_version: '2022-07-20', access_token: '',
+                   square_version: '2022-08-23', access_token: '',
                    user_agent_detail: '', additional_headers: {}, config: nil)
       @config = if config.nil?
                   Configuration.new(connection: connection, adapter: adapter,

data/lib/square/configuration.rb

@@ -20,7 +20,7 @@ module Square
                    retry_statuses: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524],
                    retry_methods: %i[get put], environment: 'production',
                    custom_url: 'https://connect.squareup.com',
-                   square_version: '2022-07-20', access_token: '',
+                   square_version: '2022-08-23', access_token: '',
                    user_agent_detail: '', additional_headers: {})
       # The Faraday connection object passed by the SDK user for making requests
       @connection = connection

data/lib/square.rb

@@ -67,3 +67,4 @@ require_relative 'square/api/subscriptions_api'
 require_relative 'square/api/team_api'
 require_relative 'square/api/terminal_api'
 require_relative 'square/api/vendors_api'
+require_relative 'square/api/webhook_subscriptions_api'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: square.rb
 version: !ruby/object:Gem::Version
-  version: 21.0.0.20220720
+  version: 22.1.0.20220823
 platform: ruby
 authors:
 - Square Developer Platform
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-07-20 00:00:00.000000000 Z
+date: 2022-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: logging
@@ -229,6 +229,7 @@ files:
 - lib/square/api/transactions_api.rb
 - lib/square/api/v1_transactions_api.rb
 - lib/square/api/vendors_api.rb
+- lib/square/api/webhook_subscriptions_api.rb
 - lib/square/api_helper.rb
 - lib/square/client.rb
 - lib/square/configuration.rb