square.rb 28.0.0.20230517 → 29.0.0.20230608

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7aad233be99bfca2993a00a7c626631d148ed55b31b1e066374f4140f24e39d8
-  data.tar.gz: 495f1f8e3090fdcff82d59bb5f3a107d6e3041054c84ab025a6f10349bfc0103
+  metadata.gz: 6f8d15edb9a8dd68b46a879c0afacf648c322c9e31373fce770c109b4dfae6b6
+  data.tar.gz: 892d648f4b7bfe44d6fb162e13d544867df6a8b6e3b173f5ca516ca78aa3e3e4
 SHA512:
-  metadata.gz: '08e41c2920e1801d7a40ec683df94518d41b00953c46079de8749dd8f1c6a207750f17ea001d4e293d8cd493dee568b7d23204e2e60c9a864bf25933841bd1a0'
-  data.tar.gz: e6f513724723fd25e7009dff20d565ce765b20312496409822bd492a96157c71e5c31eb207b2508faa75e9d5f8d424cc43bf670c19626fdfe6dae7bf9f78a3b2
+  metadata.gz: 0b83f14d0f0291d461b694c853e38bad88b508a1bbab94df7faac7a550ddd99e499bba08882b4ce82a194eefeae64b5515481a708c6194dfcefa40c2b85eb98e
+  data.tar.gz: 169dc96d375401735be90799acb4b08e96199286a4ec89395015edfcc28736bde58e8e4ed41e784d97e8e5652287a6e96ffd0cc0e6aa8515eebe0fcaf988cb72

data/lib/square/api/base_api.rb

@@ -4,7 +4,7 @@ module Square
     attr_accessor :config, :http_call_back
 
     def self.user_agent
-      'Square-Ruby-SDK/28.0.0.20230517 ({api-version}) {engine}/{engine-version} ({os-info}) {detail}'
+      'Square-Ruby-SDK/29.0.0.20230608 ({api-version}) {engine}/{engine-version} ({os-info}) {detail}'
     end
 
     def self.user_agent_parameters

data/lib/square/api/o_auth_api.rb

@@ -20,10 +20,10 @@ module Square
     # Authorization: Client APPLICATION_SECRET
     # ```
     # Replace `APPLICATION_SECRET` with the application secret on the
-    # Credentials
+    # **Credentials**
     # page in the [Developer Dashboard](https://developer.squareup.com/apps).
     # @param [String] client_id Required parameter: Your application ID, which
-    # is available in the OAuth page in the [Developer
+    # is available on the **OAuth** page in the [Developer
     # Dashboard](https://developer.squareup.com/apps).
     # @param [RenewTokenRequest] body Required parameter: An object containing
     # the fields to POST for the request.  See the corresponding object
@@ -65,8 +65,8 @@ module Square
     # ```
     # Authorization: Client APPLICATION_SECRET
     # ```
-    # Replace `APPLICATION_SECRET` with the application secret on the OAuth
-    # page for your application on the Developer Dashboard.
+    # Replace `APPLICATION_SECRET` with the application secret on the **OAuth**
+    # page for your application in the Developer Dashboard.
     # @param [RevokeTokenRequest] body Required parameter: An object containing
     # the fields to POST for the request.  See the corresponding object
     # definition for field details.
@@ -97,7 +97,7 @@ module Square
     # The `grant_type` parameter specifies the type of OAuth request. If
     # `grant_type` is `authorization_code`, you must include the authorization
     # code you received when a seller granted you authorization. If `grant_type`
-    # is `refresh_token`, you must provide a valid refresh token. If you are
+    # is `refresh_token`, you must provide a valid refresh token. If you're
     # using
     # an old version of the Square APIs (prior to March 13, 2019), `grant_type`
     # can be `migration_token` and you must provide a valid migration token.

data/lib/square/api/subscriptions_api.rb

@@ -1,13 +1,16 @@
 module Square
   # SubscriptionsApi
   class SubscriptionsApi < BaseApi
-    # Creates a subscription to a subscription plan by a customer.
+    # Enrolls a customer in a subscription.
     # If you provide a card on file in the request, Square charges the card for
-    # the subscription. Otherwise, Square bills an invoice to the customer's
+    # the subscription. Otherwise, Square sends an invoice to the customer's
     # email
     # address. The subscription starts immediately, unless the request includes
     # the optional `start_date`. Each individual subscription is associated with
     # a particular location.
+    # For more information, see [Create a
+    # subscription](https://developer.squareup.com/docs/subscriptions-api/manage
+    # -subscriptions#create-a-subscription).
     # @param [CreateSubscriptionRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
@@ -42,10 +45,6 @@ module Square
     # If the request specifies customer IDs, the endpoint orders results
     # first by location, within location by customer ID, and within
     # customer by subscription creation date.
-    # For more information, see
-    # [Retrieve
-    # subscriptions](https://developer.squareup.com/docs/subscriptions-api/overv
-    # iew#retrieve-subscriptions).
     # @param [SearchSubscriptionsRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
@@ -67,7 +66,7 @@ module Square
         .execute
     end
 
-    # Retrieves a subscription.
+    # Retrieves a specific subscription.
     # @param [String] subscription_id Required parameter: The ID of the
     # subscription to retrieve.
     # @param [String] include Optional parameter: A query parameter to specify
@@ -93,8 +92,9 @@ module Square
         .execute
     end
 
-    # Updates a subscription. You can set, modify, and clear the
-    # `subscription` field values.
+    # Updates a subscription by modifying or clearing `subscription` field
+    # values.
+    # To clear a field, set its value to `null`.
     # @param [String] subscription_id Required parameter: The ID of the
     # subscription to update.
     # @param [UpdateSubscriptionRequest] body Required parameter: An object
@@ -146,11 +146,10 @@ module Square
         .execute
     end
 
-    # Schedules a `CANCEL` action to cancel an active subscription
-    # by setting the `canceled_date` field to the end of the active billing
-    # period
-    # and changing the subscription status from ACTIVE to CANCELED after this
-    # date.
+    # Schedules a `CANCEL` action to cancel an active subscription. This
+    # sets the `canceled_date` field to the end of the active billing period.
+    # After this date,
+    # the subscription status changes from ACTIVE to CANCELED.
     # @param [String] subscription_id Required parameter: The ID of the
     # subscription to cancel.
     # @return [CancelSubscriptionResponse Hash] response from the API call
@@ -170,7 +169,9 @@ module Square
         .execute
     end
 
-    # Lists all events for a specific subscription.
+    # Lists all
+    # [events](https://developer.squareup.com/docs/subscriptions-api/actions-eve
+    # nts) for a specific subscription.
     # @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
@@ -178,8 +179,8 @@ module Square
     # specify the cursor returned from a preceding response here to fetch the
     # next set of results. If the cursor is unset, the response contains the
     # last page of the results.  For more information, see
-    # [Pagination](https://developer.squareup.com/docs/working-with-apis/paginat
-    # ion).
+    # [Pagination](https://developer.squareup.com/docs/build-basics/common-api-p
+    # atterns/pagination).
     # @param [Integer] limit Optional parameter: The upper limit on the number
     # of subscription events to return in a paged response.
     # @return [ListSubscriptionEventsResponse Hash] response from the API call
@@ -258,8 +259,11 @@ module Square
         .execute
     end
 
-    # Schedules a `SWAP_PLAN` action to swap a subscription plan in an existing
-    # subscription.
+    # Schedules a `SWAP_PLAN` action to swap a subscription plan variation in an
+    # existing subscription.
+    # For more information, see [Swap Subscription Plan
+    # Variations](https://developer.squareup.com/docs/subscriptions-api/swap-pla
+    # n-variations).
     # @param [String] subscription_id Required parameter: The ID of the
     # subscription to swap the subscription plan for.
     # @param [SwapPlanRequest] body Required parameter: An object containing the

data/lib/square/api/terminal_api.rb

@@ -50,7 +50,7 @@ module Square
     # 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`
+    # `TerminalAction`.
     # @return [GetTerminalActionResponse Hash] response from the API call
     def get_terminal_action(action_id:)
       new_api_call_builder
@@ -70,7 +70,7 @@ module Square
 
     # 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`
+    # `TerminalAction`.
     # @return [CancelTerminalActionResponse Hash] response from the API call
     def cancel_terminal_action(action_id:)
       new_api_call_builder
@@ -88,6 +88,30 @@ module Square
         .execute
     end
 
+    # Dismisses a Terminal action request if the status and type of the request
+    # permits it.
+    # See [Link and Dismiss
+    # Actions](https://developer.squareup.com/docs/terminal-api/advanced-feature
+    # s/custom-workflows/link-and-dismiss-actions) for more details.
+    # @param [String] action_id Required parameter: Unique ID for the
+    # `TerminalAction` associated with the waiting dialog to be dismissed.
+    # @return [DismissTerminalActionResponse Hash] response from the API call
+    def dismiss_terminal_action(action_id:)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/v2/terminals/actions/{action_id}/dismiss',
+                                     'default')
+                   .template_param(new_parameter(action_id, key: 'action_id')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('global')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:json_deserialize))
+                   .is_api_response(true)
+                   .convertor(ApiResponse.method(:create)))
+        .execute
+    end
+
     # Creates a Terminal checkout request and sends it to the specified device
     # to take a payment
     # for the requested amount.

data/lib/square/client.rb

@@ -4,7 +4,7 @@ module Square
     attr_reader :config, :auth_managers
 
     def sdk_version
-      '28.0.0.20230517'
+      '29.0.0.20230608'
     end
 
     def square_version
@@ -267,7 +267,7 @@ module Square
                    retry_methods: %i[get put], http_callback: nil,
                    environment: 'production',
                    custom_url: 'https://connect.squareup.com', access_token: '',
-                   square_version: '2023-05-17', user_agent_detail: '',
+                   square_version: '2023-06-08', user_agent_detail: '',
                    additional_headers: {}, config: nil)
       @config = if config.nil?
                   Configuration.new(connection: connection, adapter: adapter,

data/lib/square/configuration.rb

@@ -19,7 +19,7 @@ module Square
                    retry_methods: %i[get put], http_callback: nil,
                    environment: 'production',
                    custom_url: 'https://connect.squareup.com', access_token: '',
-                   square_version: '2023-05-17', user_agent_detail: '',
+                   square_version: '2023-06-08', user_agent_detail: '',
                    additional_headers: {})
 
       super connection: connection, adapter: adapter, timeout: timeout,

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: square.rb
 version: !ruby/object:Gem::Version
-  version: 28.0.0.20230517
+  version: 29.0.0.20230608
 platform: ruby
 authors:
 - Square Developer Platform
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-05-16 00:00:00.000000000 Z
+date: 2023-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: apimatic_core_interfaces