square.rb 38.1.1.20240717 → 39.1.0.20240919

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5cce93ff0125b15e7eade6f156a88af3df95fefe77472e14145003f647ac3290
-  data.tar.gz: 5fb22cfd130b0e709f84c17a1eee3f3796fb3cf24e69c32c92f11924bb2d8013
+  metadata.gz: 4b82da00c49c7711552f187854839f8ab615cc3c066d98ac7cd8ddf735655e3d
+  data.tar.gz: 0371cc7d2c09338e65e60d0dd553c24a8d48b640280d3a9d289dec3070908b38
 SHA512:
-  metadata.gz: 22248613a64e80016c2da4c143cd16833dfdf5d617baafd79cd73194cdeef521e56351a4f0f94c39d088fc77a90e09f1ee3e90b87397dc4525d906937c2936af
-  data.tar.gz: bc563352893ab4ebc268778f52181f755ea3f4bcc612ea1cd764e4aed18659335af2232133d953ae163fd0d4f454fba827f81b6d1e284fd454c88f2fab3ab7a6
+  metadata.gz: 21f25423c2fb51a640d15792ab6611c1787c3d6213b6d66bbd8cef84692afaa84b075c9165f043809260b3eaf55863409df5f94bf989632a325ab40c5af064a1
+  data.tar.gz: 3362c8d3438ae2bbadf9d23a4fcb56ec1fcf2a0b1822403c52c60f9ee81018907be8a9d6db862ce4dfa0df29aa35f13e36239c6e908b50276a5d9e9e11647a5f

data/lib/square/api/apple_pay_api.rb

@@ -26,7 +26,7 @@ module Square
     # @param [RegisterDomainRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
-    # @return [RegisterDomainResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def register_domain(body:)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::POST,

data/lib/square/api/bank_accounts_api.rb

@@ -15,7 +15,7 @@ module Square
     # @param [String] location_id Optional parameter: Location ID. You can
     # specify this optional filter  to retrieve only the linked bank accounts
     # belonging to a specific location.
-    # @return [ListBankAccountsResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def list_bank_accounts(cursor: nil,
                            limit: nil,
                            location_id: nil)
@@ -42,7 +42,7 @@ module Square
     # account by using an ID issued by V1 Bank Accounts
     # API](https://developer.squareup.com/docs/bank-accounts-api#retrieve-a-bank
     # -account-by-using-an-id-issued-by-v1-bank-accounts-api).
-    # @return [GetBankAccountByV1IdResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def get_bank_account_by_v1_id(v1_bank_account_id:)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::GET,
@@ -63,7 +63,7 @@ module Square
     # linked to a Square account.
     # @param [String] bank_account_id Required parameter: Square-issued ID of
     # the desired `BankAccount`.
-    # @return [GetBankAccountResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def get_bank_account(bank_account_id:)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::GET,

data/lib/square/api/base_api.rb

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

data/lib/square/api/booking_custom_attributes_api.rb

@@ -18,7 +18,7 @@ module Square
     # more information, see
     # [Pagination](https://developer.squareup.com/docs/build-basics/common-api-p
     # atterns/pagination).
-    # @return [ListBookingCustomAttributeDefinitionsResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def list_booking_custom_attribute_definitions(limit: nil,
                                                   cursor: nil)
       new_api_call_builder
@@ -47,7 +47,7 @@ module Square
     # @param [CreateBookingCustomAttributeDefinitionRequest] body Required
     # parameter: An object containing the fields to POST for the request.  See
     # the corresponding object definition for field details.
-    # @return [CreateBookingCustomAttributeDefinitionResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def create_booking_custom_attribute_definition(body:)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::POST,
@@ -75,7 +75,7 @@ module Square
     # or *Appointments Premium*.
     # @param [String] key Required parameter: The key of the custom attribute
     # definition to delete.
-    # @return [DeleteBookingCustomAttributeDefinitionResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def delete_booking_custom_attribute_definition(key:)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::DELETE,
@@ -106,7 +106,7 @@ module Square
     # the request, Square returns the specified version or a higher version if
     # one exists. If the specified version is higher than the current version,
     # Square returns a `BAD_REQUEST` error.
-    # @return [RetrieveBookingCustomAttributeDefinitionResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def retrieve_booking_custom_attribute_definition(key:,
                                                      version: nil)
       new_api_call_builder
@@ -138,7 +138,7 @@ module Square
     # @param [UpdateBookingCustomAttributeDefinitionRequest] body Required
     # parameter: An object containing the fields to POST for the request.  See
     # the corresponding object definition for field details.
-    # @return [UpdateBookingCustomAttributeDefinitionResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def update_booking_custom_attribute_definition(key:,
                                                    body:)
       new_api_call_builder
@@ -170,7 +170,7 @@ module Square
     # @param [BulkDeleteBookingCustomAttributesRequest] body Required parameter:
     # An object containing the fields to POST for the request.  See the
     # corresponding object definition for field details.
-    # @return [BulkDeleteBookingCustomAttributesResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def bulk_delete_booking_custom_attributes(body:)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::POST,
@@ -199,7 +199,7 @@ module Square
     # @param [BulkUpsertBookingCustomAttributesRequest] body Required parameter:
     # An object containing the fields to POST for the request.  See the
     # corresponding object definition for field details.
-    # @return [BulkUpsertBookingCustomAttributesResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def bulk_upsert_booking_custom_attributes(body:)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::POST,
@@ -242,7 +242,7 @@ module Square
     # each custom attribute. Set this parameter to `true` to get the name and
     # description of each custom attribute, information about the data type, or
     # other definition details. The default value is `false`.
-    # @return [ListBookingCustomAttributesResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def list_booking_custom_attributes(booking_id:,
                                        limit: nil,
                                        cursor: nil,
@@ -279,7 +279,7 @@ module Square
     # delete. This key must match the `key` of a custom attribute definition in
     # the Square seller account. If the requesting application is not the
     # definition owner, you must use the qualified key.
-    # @return [DeleteBookingCustomAttributeResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def delete_booking_custom_attribute(booking_id:,
                                         key:)
       new_api_call_builder
@@ -322,7 +322,7 @@ module Square
     # Square returns the specified version or a higher version if one exists. If
     # the specified version is higher than the current version, Square returns a
     # `BAD_REQUEST` error.
-    # @return [RetrieveBookingCustomAttributeResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def retrieve_booking_custom_attribute(booking_id:,
                                           key:,
                                           with_definition: false,
@@ -363,7 +363,7 @@ module Square
     # @param [UpsertBookingCustomAttributeRequest] body Required parameter: An
     # object containing the fields to POST for the request.  See the
     # corresponding object definition for field details.
-    # @return [UpsertBookingCustomAttributeResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def upsert_booking_custom_attribute(booking_id:,
                                         key:,
                                         body:)

data/lib/square/api/bookings_api.rb

@@ -26,7 +26,7 @@ module Square
     # @param [String] start_at_max Optional parameter: The RFC 3339 timestamp
     # specifying the latest of the start time. If this is not set, the time of
     # 31 days after `start_at_min` is used.
-    # @return [ListBookingsResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def list_bookings(limit: nil,
                       cursor: nil,
                       customer_id: nil,
@@ -71,7 +71,7 @@ module Square
     # @param [CreateBookingRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
-    # @return [CreateBookingResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def create_booking(body:)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::POST,
@@ -97,7 +97,7 @@ module Square
     # @param [SearchAvailabilityRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
-    # @return [SearchAvailabilityResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def search_availability(body:)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::POST,
@@ -123,7 +123,7 @@ module Square
     # @param [BulkRetrieveBookingsRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
-    # @return [BulkRetrieveBookingsResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def bulk_retrieve_bookings(body:)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::POST,
@@ -142,7 +142,7 @@ module Square
     end
 
     # Retrieves a seller's booking profile.
-    # @return [RetrieveBusinessBookingProfileResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def retrieve_business_booking_profile
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::GET,
@@ -163,7 +163,7 @@ module Square
     # @param [String] cursor Optional parameter: The pagination cursor from the
     # preceding response to return the next page of the results. Do not set this
     # when retrieving the first page of the results.
-    # @return [ListLocationBookingProfilesResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def list_location_booking_profiles(limit: nil,
                                        cursor: nil)
       new_api_call_builder
@@ -184,7 +184,7 @@ module Square
     # Retrieves a seller's location booking profile.
     # @param [String] location_id Required parameter: The ID of the location to
     # retrieve the booking profile.
-    # @return [RetrieveLocationBookingProfileResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def retrieve_location_booking_profile(location_id:)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::GET,
@@ -213,7 +213,7 @@ module Square
     # @param [String] location_id Optional parameter: Indicates whether to
     # include only team members enabled at the given location in the returned
     # result.
-    # @return [ListTeamMemberBookingProfilesResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def list_team_member_booking_profiles(bookable_only: false,
                                           limit: nil,
                                           cursor: nil,
@@ -239,7 +239,7 @@ module Square
     # @param [BulkRetrieveTeamMemberBookingProfilesRequest] body Required
     # parameter: An object containing the fields to POST for the request.  See
     # the corresponding object definition for field details.
-    # @return [BulkRetrieveTeamMemberBookingProfilesResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def bulk_retrieve_team_member_booking_profiles(body:)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::POST,
@@ -260,7 +260,7 @@ module Square
     # Retrieves a team member's booking profile.
     # @param [String] team_member_id Required parameter: The ID of the team
     # member to retrieve.
-    # @return [RetrieveTeamMemberBookingProfileResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def retrieve_team_member_booking_profile(team_member_id:)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::GET,
@@ -285,7 +285,7 @@ module Square
     # @param [String] booking_id Required parameter: The ID of the
     # [Booking](entity:Booking) object representing the to-be-retrieved
     # booking.
-    # @return [RetrieveBookingResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def retrieve_booking(booking_id:)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::GET,
@@ -315,7 +315,7 @@ module Square
     # @param [UpdateBookingRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
-    # @return [UpdateBookingResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def update_booking(booking_id:,
                        body:)
       new_api_call_builder
@@ -350,7 +350,7 @@ module Square
     # @param [CancelBookingRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
-    # @return [CancelBookingResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def cancel_booking(booking_id:,
                        body:)
       new_api_call_builder

data/lib/square/api/cards_api.rb

@@ -19,7 +19,7 @@ module Square
     # @param [SortOrder] sort_order Optional parameter: Sorts the returned list
     # by when the card was created with the specified order. This field defaults
     # to ASC.
-    # @return [ListCardsResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def list_cards(cursor: nil,
                    customer_id: nil,
                    include_disabled: false,
@@ -47,7 +47,7 @@ module Square
     # @param [CreateCardRequest] body Required parameter: An object containing
     # the fields to POST for the request.  See the corresponding object
     # definition for field details.
-    # @return [CreateCardResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def create_card(body:)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::POST,
@@ -68,7 +68,7 @@ module Square
     # Retrieves details for a specific Card.
     # @param [String] card_id Required parameter: Unique ID for the desired
     # Card.
-    # @return [RetrieveCardResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def retrieve_card(card_id:)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::GET,
@@ -89,7 +89,7 @@ module Square
     # Disabling an already disabled card is allowed but has no effect.
     # @param [String] card_id Required parameter: Unique ID for the desired
     # Card.
-    # @return [DisableCardResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def disable_card(card_id:)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::POST,

data/lib/square/api/cash_drawers_api.rb

@@ -16,7 +16,7 @@ module Square
     # events in a page of results (200 by default, 1000 max).
     # @param [String] cursor Optional parameter: Opaque cursor for fetching the
     # next page of results.
-    # @return [ListCashDrawerShiftsResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def list_cash_drawer_shifts(location_id:,
                                 sort_order: nil,
                                 begin_time: nil,
@@ -48,7 +48,7 @@ module Square
     # @param [String] location_id Required parameter: The ID of the location to
     # retrieve cash drawer shifts from.
     # @param [String] shift_id Required parameter: The shift ID.
-    # @return [RetrieveCashDrawerShiftResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def retrieve_cash_drawer_shift(location_id:,
                                    shift_id:)
       new_api_call_builder
@@ -75,7 +75,7 @@ module Square
     # returned in a page of results (200 by default, 1000 max).
     # @param [String] cursor Optional parameter: Opaque cursor for fetching the
     # next page of results.
-    # @return [ListCashDrawerShiftEventsResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def list_cash_drawer_shift_events(location_id:,
                                       shift_id:,
                                       limit: nil,

data/lib/square/api/catalog_api.rb

@@ -20,7 +20,7 @@ module Square
     # @param [BatchDeleteCatalogObjectsRequest] body Required parameter: An
     # object containing the fields to POST for the request.  See the
     # corresponding object definition for field details.
-    # @return [BatchDeleteCatalogObjectsResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def batch_delete_catalog_objects(body:)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::POST,
@@ -47,7 +47,7 @@ module Square
     # @param [BatchRetrieveCatalogObjectsRequest] body Required parameter: An
     # object containing the fields to POST for the request.  See the
     # corresponding object definition for field details.
-    # @return [BatchRetrieveCatalogObjectsResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def batch_retrieve_catalog_objects(body:)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::POST,
@@ -87,7 +87,7 @@ module Square
     # @param [BatchUpsertCatalogObjectsRequest] body Required parameter: An
     # object containing the fields to POST for the request.  See the
     # corresponding object definition for field details.
-    # @return [BatchUpsertCatalogObjectsResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def batch_upsert_catalog_objects(body:)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::POST,
@@ -115,7 +115,7 @@ module Square
     # JPEG, PJPEG, PNG, or GIF format. The maximum file size is 15MB.
     # @param [CreateCatalogImageRequest] request Optional parameter: Example:
     # @param [File | UploadIO] image_file Optional parameter: Example:
-    # @return [CreateCatalogImageResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def create_catalog_image(request: nil,
                              image_file: nil)
       new_api_call_builder
@@ -144,7 +144,7 @@ module Square
     # object to update the encapsulated image file.
     # @param [UpdateCatalogImageRequest] request Optional parameter: Example:
     # @param [File | UploadIO] image_file Optional parameter: Example:
-    # @return [UpdateCatalogImageResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def update_catalog_image(image_id:,
                              request: nil,
                              image_file: nil)
@@ -169,7 +169,7 @@ module Square
 
     # Retrieves information about the Square Catalog API, such as batch size
     # limits that can be used by the `BatchUpsertCatalogObjects` endpoint.
-    # @return [CatalogInfoResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def catalog_info
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::GET,
@@ -218,7 +218,7 @@ module Square
     # matched against the [CatalogObject]($m/CatalogObject)s' `version`
     # attribute.  If not included, results will be from the current version of
     # the catalog.
-    # @return [ListCatalogResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def list_catalog(cursor: nil,
                      types: nil,
                      catalog_version: nil)
@@ -247,7 +247,7 @@ module Square
     # @param [UpsertCatalogObjectRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
-    # @return [UpsertCatalogObjectResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def upsert_catalog_object(body:)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::POST,
@@ -282,7 +282,7 @@ module Square
     # to be deleted. When an object is deleted, other objects in the graph that
     # depend on that object will be deleted as well (for example, deleting a
     # catalog item will delete its catalog item variations).
-    # @return [DeleteCatalogObjectResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def delete_catalog_object(object_id:)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::DELETE,
@@ -336,7 +336,7 @@ module Square
     # root category. If the returned category is a top-level category, the
     # `path_to_root` list is empty and is not returned in the response
     # payload.
-    # @return [RetrieveCatalogObjectResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def retrieve_catalog_object(object_id:,
                                 include_related_objects: false,
                                 catalog_version: nil,
@@ -379,7 +379,7 @@ module Square
     # @param [SearchCatalogObjectsRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
-    # @return [SearchCatalogObjectsResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def search_catalog_objects(body:)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::POST,
@@ -417,7 +417,7 @@ module Square
     # @param [SearchCatalogItemsRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
-    # @return [SearchCatalogItemsResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def search_catalog_items(body:)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::POST,
@@ -441,7 +441,7 @@ module Square
     # @param [UpdateItemModifierListsRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
-    # @return [UpdateItemModifierListsResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def update_item_modifier_lists(body:)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::POST,
@@ -465,7 +465,7 @@ module Square
     # @param [UpdateItemTaxesRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
-    # @return [UpdateItemTaxesResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def update_item_taxes(body:)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::POST,

data/lib/square/api/checkout_api.rb

@@ -13,7 +13,7 @@ module Square
     # @param [CreateCheckoutRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
-    # @return [CreateCheckoutResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def create_checkout(location_id:,
                         body:)
       warn 'Endpoint create_checkout in CheckoutApi is deprecated'
@@ -38,7 +38,7 @@ module Square
     # Retrieves the location-level settings for a Square-hosted checkout page.
     # @param [String] location_id Required parameter: The ID of the location for
     # which to retrieve settings.
-    # @return [RetrieveLocationSettingsResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def retrieve_location_settings(location_id:)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::GET,
@@ -61,7 +61,7 @@ module Square
     # @param [UpdateLocationSettingsRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
-    # @return [UpdateLocationSettingsResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def update_location_settings(location_id:,
                                  body:)
       new_api_call_builder
@@ -83,7 +83,7 @@ module Square
     end
 
     # Retrieves the merchant-level settings for a Square-hosted checkout page.
-    # @return [RetrieveMerchantSettingsResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def retrieve_merchant_settings
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::GET,
@@ -102,7 +102,7 @@ module Square
     # @param [UpdateMerchantSettingsRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
-    # @return [UpdateMerchantSettingsResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def update_merchant_settings(body:)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::PUT,
@@ -132,7 +132,7 @@ module Square
     # 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`
-    # @return [ListPaymentLinksResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def list_payment_links(cursor: nil,
                            limit: nil)
       new_api_call_builder
@@ -155,7 +155,7 @@ module Square
     # @param [CreatePaymentLinkRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
-    # @return [CreatePaymentLinkResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def create_payment_link(body:)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::POST,
@@ -176,7 +176,7 @@ module Square
     # Deletes a payment link.
     # @param [String] id Required parameter: The ID of the payment link to
     # delete.
-    # @return [DeletePaymentLinkResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def delete_payment_link(id:)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::DELETE,
@@ -195,7 +195,7 @@ module Square
 
     # Retrieves a payment link.
     # @param [String] id Required parameter: The ID of link to retrieve.
-    # @return [RetrievePaymentLinkResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def retrieve_payment_link(id:)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::GET,
@@ -221,7 +221,7 @@ module Square
     # @param [UpdatePaymentLinkRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
-    # @return [UpdatePaymentLinkResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def update_payment_link(id:,
                             body:)
       new_api_call_builder

data/lib/square/api/customer_custom_attributes_api.rb

@@ -24,7 +24,7 @@ module Square
     # more information, see
     # [Pagination](https://developer.squareup.com/docs/build-basics/common-api-p
     # atterns/pagination).
-    # @return [ListCustomerCustomAttributeDefinitionsResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def list_customer_custom_attribute_definitions(limit: nil,
                                                    cursor: nil)
       new_api_call_builder
@@ -61,7 +61,7 @@ module Square
     # @param [CreateCustomerCustomAttributeDefinitionRequest] body Required
     # parameter: An object containing the fields to POST for the request.  See
     # the corresponding object definition for field details.
-    # @return [CreateCustomerCustomAttributeDefinitionResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def create_customer_custom_attribute_definition(body:)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::POST,
@@ -87,7 +87,7 @@ module Square
     # Only the definition owner can delete a custom attribute definition.
     # @param [String] key Required parameter: The key of the custom attribute
     # definition to delete.
-    # @return [DeleteCustomerCustomAttributeDefinitionResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def delete_customer_custom_attribute_definition(key:)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::DELETE,
@@ -121,7 +121,7 @@ module Square
     # the request, Square returns the specified version or a higher version if
     # one exists. If the specified version is higher than the current version,
     # Square returns a `BAD_REQUEST` error.
-    # @return [RetrieveCustomerCustomAttributeDefinitionResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def retrieve_customer_custom_attribute_definition(key:,
                                                       version: nil)
       new_api_call_builder
@@ -154,7 +154,7 @@ module Square
     # @param [UpdateCustomerCustomAttributeDefinitionRequest] body Required
     # parameter: An object containing the fields to POST for the request.  See
     # the corresponding object definition for field details.
-    # @return [UpdateCustomerCustomAttributeDefinitionResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def update_customer_custom_attribute_definition(key:,
                                                     body:)
       new_api_call_builder
@@ -200,7 +200,7 @@ module Square
     # @param [BulkUpsertCustomerCustomAttributesRequest] body Required
     # parameter: An object containing the fields to POST for the request.  See
     # the corresponding object definition for field details.
-    # @return [BulkUpsertCustomerCustomAttributesResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def bulk_upsert_customer_custom_attributes(body:)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::POST,
@@ -248,7 +248,7 @@ module Square
     # each custom attribute. Set this parameter to `true` to get the name and
     # description of each custom attribute, information about the data type, or
     # other definition details. The default value is `false`.
-    # @return [ListCustomerCustomAttributesResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def list_customer_custom_attributes(customer_id:,
                                         limit: nil,
                                         cursor: nil,
@@ -284,7 +284,7 @@ module Square
     # delete. This key must match the `key` of a custom attribute definition in
     # the Square seller account. If the requesting application is not the
     # definition owner, you must use the qualified key.
-    # @return [DeleteCustomerCustomAttributeResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def delete_customer_custom_attribute(customer_id:,
                                          key:)
       new_api_call_builder
@@ -333,7 +333,7 @@ module Square
     # Square returns the specified version or a higher version if one exists. If
     # the specified version is higher than the current version, Square returns a
     # `BAD_REQUEST` error.
-    # @return [RetrieveCustomerCustomAttributeResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def retrieve_customer_custom_attribute(customer_id:,
                                            key:,
                                            with_definition: false,
@@ -381,7 +381,7 @@ module Square
     # @param [UpsertCustomerCustomAttributeRequest] body Required parameter: An
     # object containing the fields to POST for the request.  See the
     # corresponding object definition for field details.
-    # @return [UpsertCustomerCustomAttributeResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def upsert_customer_custom_attribute(customer_id:,
                                          key:,
                                          body:)