square.rb 39.0.0.20240821 → 39.1.0.20240919

data/lib/square/api/terminal_api.rb

@@ -5,7 +5,7 @@ module Square
     # @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
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def create_terminal_action(body:)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::POST,
@@ -29,7 +29,7 @@ module Square
     # @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
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def search_terminal_actions(body:)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::POST,
@@ -51,7 +51,7 @@ module Square
     # 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
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def get_terminal_action(action_id:)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::GET,
@@ -71,7 +71,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`.
-    # @return [CancelTerminalActionResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def cancel_terminal_action(action_id:)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::POST,
@@ -95,7 +95,7 @@ module Square
     # s/custom-workflows/link-and-dismiss-actions) for more details.
     # @param [String] action_id Required parameter: Unique ID for the
     # `TerminalAction` associated with the action to be dismissed.
-    # @return [DismissTerminalActionResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def dismiss_terminal_action(action_id:)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::POST,
@@ -118,7 +118,7 @@ module Square
     # @param [CreateTerminalCheckoutRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
-    # @return [CreateTerminalCheckoutResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def create_terminal_checkout(body:)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::POST,
@@ -143,7 +143,7 @@ module Square
     # @param [SearchTerminalCheckoutsRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
-    # @return [SearchTerminalCheckoutsResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def search_terminal_checkouts(body:)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::POST,
@@ -165,7 +165,7 @@ module Square
     # 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
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def get_terminal_checkout(checkout_id:)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::GET,
@@ -186,7 +186,7 @@ module Square
     # it.
     # @param [String] checkout_id Required parameter: The unique ID for the
     # desired `TerminalCheckout`.
-    # @return [CancelTerminalCheckoutResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def cancel_terminal_checkout(checkout_id:)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::POST,
@@ -207,7 +207,7 @@ module Square
     # request permits it.
     # @param [String] checkout_id Required parameter: Unique ID for the
     # `TerminalCheckout` associated with the checkout to be dismissed.
-    # @return [DismissTerminalCheckoutResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def dismiss_terminal_checkout(checkout_id:)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::POST,
@@ -232,7 +232,7 @@ module Square
     # @param [CreateTerminalRefundRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
-    # @return [CreateTerminalRefundResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def create_terminal_refund(body:)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::POST,
@@ -256,7 +256,7 @@ module Square
     # @param [SearchTerminalRefundsRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
-    # @return [SearchTerminalRefundsResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def search_terminal_refunds(body:)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::POST,
@@ -278,7 +278,7 @@ module Square
     # 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
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def get_terminal_refund(terminal_refund_id:)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::GET,
@@ -299,7 +299,7 @@ module Square
     # status of the request permits it.
     # @param [String] terminal_refund_id Required parameter: The unique ID for
     # the desired `TerminalRefund`.
-    # @return [CancelTerminalRefundResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def cancel_terminal_refund(terminal_refund_id:)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::POST,
@@ -320,7 +320,7 @@ module Square
     # permits it.
     # @param [String] terminal_refund_id Required parameter: Unique ID for the
     # `TerminalRefund` associated with the refund to be dismissed.
-    # @return [DismissTerminalRefundResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def dismiss_terminal_refund(terminal_refund_id:)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::POST,

data/lib/square/api/transactions_api.rb

@@ -28,7 +28,7 @@ module Square
     # results for your original query.  See [Paginating
     # results](https://developer.squareup.com/docs/working-with-apis/pagination)
     # for more information.
-    # @return [ListTransactionsResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def list_transactions(location_id:,
                           begin_time: nil,
                           end_time: nil,
@@ -59,7 +59,7 @@ module Square
     # transaction's associated location.
     # @param [String] transaction_id Required parameter: The ID of the
     # transaction to retrieve.
-    # @return [RetrieveTransactionResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def retrieve_transaction(location_id:,
                              transaction_id:)
       warn 'Endpoint retrieve_transaction in TransactionsApi is deprecated'
@@ -89,7 +89,7 @@ module Square
     # for more information.
     # @param [String] location_id Required parameter: Example:
     # @param [String] transaction_id Required parameter: Example:
-    # @return [CaptureTransactionResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def capture_transaction(location_id:,
                             transaction_id:)
       warn 'Endpoint capture_transaction in TransactionsApi is deprecated'
@@ -119,7 +119,7 @@ module Square
     # for more information.
     # @param [String] location_id Required parameter: Example:
     # @param [String] transaction_id Required parameter: Example:
-    # @return [VoidTransactionResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def void_transaction(location_id:,
                          transaction_id:)
       warn 'Endpoint void_transaction in TransactionsApi is deprecated'

data/lib/square/api/v1_transactions_api.rb

@@ -11,7 +11,7 @@ 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.
-    # @return [Array[V1Order] Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def v1_list_orders(location_id:,
                        order: nil,
                        limit: nil,
@@ -43,7 +43,7 @@ module Square
     # @param [String] order_id Required parameter: The order's Square-issued ID.
     # You obtain this value from Order objects returned by the List Orders
     # endpoint
-    # @return [V1Order Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def v1_retrieve_order(location_id:,
                           order_id:)
       warn 'Endpoint v1_retrieve_order in V1TransactionsApi is deprecated'
@@ -74,7 +74,7 @@ module Square
     # @param [V1UpdateOrderRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
-    # @return [V1Order Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def v1_update_order(location_id:,
                         order_id:,
                         body:)

data/lib/square/api/vendors_api.rb

@@ -6,7 +6,7 @@ module Square
     # @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
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def bulk_create_vendors(body:)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::POST,
@@ -28,7 +28,7 @@ module Square
     # @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
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def bulk_retrieve_vendors(body:)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::POST,
@@ -51,7 +51,7 @@ module Square
     # @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
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def bulk_update_vendors(body:)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::PUT,
@@ -74,7 +74,7 @@ module Square
     # @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
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def create_vendor(body:)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::POST,
@@ -97,7 +97,7 @@ module Square
     # @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
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def search_vendors(body:)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::POST,
@@ -118,7 +118,7 @@ module Square
     # Retrieves the vendor of a specified [Vendor]($m/Vendor) ID.
     # @param [String] vendor_id Required parameter: ID of the
     # [Vendor](entity:Vendor) to retrieve.
-    # @return [RetrieveVendorResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def retrieve_vendor(vendor_id:)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::GET,
@@ -140,7 +140,7 @@ module Square
     # 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
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def update_vendor(body:,
                       vendor_id:)
       new_api_call_builder

data/lib/square/api/webhook_subscriptions_api.rb

@@ -5,7 +5,7 @@ module Square
     # @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
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def list_webhook_event_types(api_version: nil)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::GET,
@@ -37,7 +37,7 @@ module Square
     # 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.  Default: 100
-    # @return [ListWebhookSubscriptionsResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def list_webhook_subscriptions(cursor: nil,
                                    include_disabled: false,
                                    sort_order: nil,
@@ -63,7 +63,7 @@ module Square
     # @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
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def create_webhook_subscription(body:)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::POST,
@@ -84,7 +84,7 @@ module Square
     # Deletes a webhook subscription.
     # @param [String] subscription_id Required parameter: [REQUIRED] The ID of
     # the [Subscription](entity:WebhookSubscription) to delete.
-    # @return [DeleteWebhookSubscriptionResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def delete_webhook_subscription(subscription_id:)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::DELETE,
@@ -104,7 +104,7 @@ module Square
     # Retrieves a webhook subscription identified by its ID.
     # @param [String] subscription_id Required parameter: [REQUIRED] The ID of
     # the [Subscription](entity:WebhookSubscription) to retrieve.
-    # @return [RetrieveWebhookSubscriptionResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def retrieve_webhook_subscription(subscription_id:)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::GET,
@@ -127,7 +127,7 @@ module Square
     # @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
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def update_webhook_subscription(subscription_id:,
                                     body:)
       new_api_call_builder
@@ -155,7 +155,7 @@ module Square
     # @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
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def update_webhook_subscription_signature_key(subscription_id:,
                                                   body:)
       new_api_call_builder
@@ -183,7 +183,7 @@ module Square
     # @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
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def test_webhook_subscription(subscription_id:,
                                   body:)
       new_api_call_builder

data/lib/square/client.rb

@@ -5,7 +5,7 @@ module Square
     attr_reader :config, :auth_managers
 
     def sdk_version
-      '39.0.0.20240821'
+      '39.1.0.20240919'
     end
 
     def square_version
@@ -274,7 +274,7 @@ module Square
       retry_statuses: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524],
       retry_methods: %i[get put], http_callback: nil, environment: 'production',
       custom_url: 'https://connect.squareup.com', access_token: nil,
-      bearer_auth_credentials: nil, square_version: '2024-08-21',
+      bearer_auth_credentials: nil, square_version: '2024-09-19',
       user_agent_detail: '', additional_headers: {}, config: nil
     )
       @config = if config.nil?

data/lib/square/configuration.rb

@@ -24,7 +24,7 @@ module Square
       retry_statuses: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524],
       retry_methods: %i[get put], http_callback: nil, environment: 'production',
       custom_url: 'https://connect.squareup.com', access_token: nil,
-      bearer_auth_credentials: nil, square_version: '2024-08-21',
+      bearer_auth_credentials: nil, square_version: '2024-09-19',
       user_agent_detail: '', additional_headers: {}
     )
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: square.rb
 version: !ruby/object:Gem::Version
-  version: 39.0.0.20240821
+  version: 39.1.0.20240919
 platform: ruby
 authors:
 - Square Developer Platform
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-08-21 00:00:00.000000000 Z
+date: 2024-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: apimatic_core_interfaces