square.rb 39.0.0.20240821 → 39.1.0.20240919

data/lib/square/api/invoices_api.rb

@@ -14,7 +14,7 @@ module Square
     # @param [Integer] limit Optional parameter: The maximum number of invoices
     # to return (200 is the maximum `limit`).  If not provided, the server uses
     # a default limit of 100 invoices.
-    # @return [ListInvoicesResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def list_invoices(location_id:,
                       cursor: nil,
                       limit: nil)
@@ -42,7 +42,7 @@ module Square
     # @param [CreateInvoiceRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
-    # @return [CreateInvoiceResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def create_invoice(body:)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::POST,
@@ -70,7 +70,7 @@ module Square
     # @param [SearchInvoicesRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
-    # @return [SearchInvoicesResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def search_invoices(body:)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::POST,
@@ -98,7 +98,7 @@ module Square
     # [invoice](entity:Invoice) to delete. If you do not know the version, you
     # can call [GetInvoice](api-endpoint:Invoices-GetInvoice) or
     # [ListInvoices](api-endpoint:Invoices-ListInvoices).
-    # @return [DeleteInvoiceResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def delete_invoice(invoice_id:,
                        version: nil)
       new_api_call_builder
@@ -120,7 +120,7 @@ module Square
     # Retrieves an invoice by invoice ID.
     # @param [String] invoice_id Required parameter: The ID of the invoice to
     # retrieve.
-    # @return [GetInvoiceResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def get_invoice(invoice_id:)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::GET,
@@ -149,7 +149,7 @@ module Square
     # @param [UpdateInvoiceRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
-    # @return [UpdateInvoiceResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def update_invoice(invoice_id:,
                        body:)
       new_api_call_builder
@@ -184,7 +184,7 @@ module Square
     # Represents a
     # [CreateInvoiceAttachment]($e/Invoices/CreateInvoiceAttachment) request.
     # @param [File | UploadIO] image_file Optional parameter: Example:
-    # @return [CreateInvoiceAttachmentResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def create_invoice_attachment(invoice_id:,
                                   request: nil,
                                   image_file: nil)
@@ -215,7 +215,7 @@ module Square
     # [invoice](entity:Invoice) to delete the attachment from.
     # @param [String] attachment_id Required parameter: The ID of the
     # [attachment](entity:InvoiceAttachment) to delete.
-    # @return [DeleteInvoiceAttachmentResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def delete_invoice_attachment(invoice_id:,
                                   attachment_id:)
       new_api_call_builder
@@ -244,7 +244,7 @@ module Square
     # @param [CancelInvoiceRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
-    # @return [CancelInvoiceResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def cancel_invoice(invoice_id:,
                        body:)
       new_api_call_builder
@@ -287,7 +287,7 @@ module Square
     # @param [PublishInvoiceRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
-    # @return [PublishInvoiceResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def publish_invoice(invoice_id:,
                         body:)
       new_api_call_builder

data/lib/square/api/labor_api.rb

@@ -10,7 +10,7 @@ module Square
     # 200. The default is 200.
     # @param [String] cursor Optional parameter: A pointer to the next page of
     # `BreakType` results to fetch.
-    # @return [ListBreakTypesResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def list_break_types(location_id: nil,
                          limit: nil,
                          cursor: nil)
@@ -46,7 +46,7 @@ module Square
     # @param [CreateBreakTypeRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
-    # @return [CreateBreakTypeResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def create_break_type(body:)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::POST,
@@ -68,7 +68,7 @@ module Square
     # A `BreakType` can be deleted even if it is referenced from a `Shift`.
     # @param [String] id Required parameter: The UUID for the `BreakType` being
     # deleted.
-    # @return [DeleteBreakTypeResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def delete_break_type(id:)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::DELETE,
@@ -88,7 +88,7 @@ module Square
     # Returns a single `BreakType` specified by `id`.
     # @param [String] id Required parameter: The UUID for the `BreakType` being
     # retrieved.
-    # @return [GetBreakTypeResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def get_break_type(id:)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::GET,
@@ -111,7 +111,7 @@ module Square
     # @param [UpdateBreakTypeRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
-    # @return [UpdateBreakTypeResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def update_break_type(id:,
                           body:)
       new_api_call_builder
@@ -140,7 +140,7 @@ module Square
     # and 200. The default is 200.
     # @param [String] cursor Optional parameter: A pointer to the next page of
     # `EmployeeWage` results to fetch.
-    # @return [ListEmployeeWagesResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def list_employee_wages(employee_id: nil,
                             limit: nil,
                             cursor: nil)
@@ -164,7 +164,7 @@ module Square
     # Returns a single `EmployeeWage` specified by `id`.
     # @param [String] id Required parameter: The UUID for the `EmployeeWage`
     # being retrieved.
-    # @return [GetEmployeeWageResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def get_employee_wage(id:)
       warn 'Endpoint get_employee_wage in LaborApi is deprecated'
       new_api_call_builder
@@ -203,7 +203,7 @@ module Square
     # @param [CreateShiftRequest] body Required parameter: An object containing
     # the fields to POST for the request.  See the corresponding object
     # definition for field details.
-    # @return [CreateShiftResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def create_shift(body:)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::POST,
@@ -237,7 +237,7 @@ module Square
     # @param [SearchShiftsRequest] body Required parameter: An object containing
     # the fields to POST for the request.  See the corresponding object
     # definition for field details.
-    # @return [SearchShiftsResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def search_shifts(body:)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::POST,
@@ -258,7 +258,7 @@ module Square
     # Deletes a `Shift`.
     # @param [String] id Required parameter: The UUID for the `Shift` being
     # deleted.
-    # @return [DeleteShiftResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def delete_shift(id:)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::DELETE,
@@ -278,7 +278,7 @@ module Square
     # Returns a single `Shift` specified by `id`.
     # @param [String] id Required parameter: The UUID for the `Shift` being
     # retrieved.
-    # @return [GetShiftResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def get_shift(id:)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::GET,
@@ -307,7 +307,7 @@ module Square
     # @param [UpdateShiftRequest] body Required parameter: An object containing
     # the fields to POST for the request.  See the corresponding object
     # definition for field details.
-    # @return [UpdateShiftResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def update_shift(id:,
                      body:)
       new_api_call_builder
@@ -336,7 +336,7 @@ module Square
     # 1 and 200. The default is 200.
     # @param [String] cursor Optional parameter: A pointer to the next page of
     # `EmployeeWage` results to fetch.
-    # @return [ListTeamMemberWagesResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def list_team_member_wages(team_member_id: nil,
                                limit: nil,
                                cursor: nil)
@@ -359,7 +359,7 @@ module Square
     # Returns a single `TeamMemberWage` specified by `id`.
     # @param [String] id Required parameter: The UUID for the `TeamMemberWage`
     # being retrieved.
-    # @return [GetTeamMemberWageResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def get_team_member_wage(id:)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::GET,
@@ -381,7 +381,7 @@ module Square
     # `WorkweekConfigs` results to return per page.
     # @param [String] cursor Optional parameter: A pointer to the next page of
     # `WorkweekConfig` results to fetch.
-    # @return [ListWorkweekConfigsResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def list_workweek_configs(limit: nil,
                               cursor: nil)
       new_api_call_builder
@@ -405,7 +405,7 @@ module Square
     # @param [UpdateWorkweekConfigRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
-    # @return [UpdateWorkweekConfigResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def update_workweek_config(id:,
                                body:)
       new_api_call_builder

data/lib/square/api/location_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 [ListLocationCustomAttributeDefinitionsResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def list_location_custom_attribute_definitions(visibility_filter: nil,
                                                    limit: nil,
                                                    cursor: nil)
@@ -59,7 +59,7 @@ module Square
     # @param [CreateLocationCustomAttributeDefinitionRequest] body Required
     # parameter: An object containing the fields to POST for the request.  See
     # the corresponding object definition for field details.
-    # @return [CreateLocationCustomAttributeDefinitionResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def create_location_custom_attribute_definition(body:)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::POST,
@@ -85,7 +85,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 [DeleteLocationCustomAttributeDefinitionResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def delete_location_custom_attribute_definition(key:)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::DELETE,
@@ -116,7 +116,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 [RetrieveLocationCustomAttributeDefinitionResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def retrieve_location_custom_attribute_definition(key:,
                                                       version: nil)
       new_api_call_builder
@@ -146,7 +146,7 @@ module Square
     # @param [UpdateLocationCustomAttributeDefinitionRequest] body Required
     # parameter: An object containing the fields to POST for the request.  See
     # the corresponding object definition for field details.
-    # @return [UpdateLocationCustomAttributeDefinitionResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def update_location_custom_attribute_definition(key:,
                                                     body:)
       new_api_call_builder
@@ -175,7 +175,7 @@ module Square
     # @param [BulkDeleteLocationCustomAttributesRequest] body Required
     # parameter: An object containing the fields to POST for the request.  See
     # the corresponding object definition for field details.
-    # @return [BulkDeleteLocationCustomAttributesResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def bulk_delete_location_custom_attributes(body:)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::POST,
@@ -215,7 +215,7 @@ module Square
     # @param [BulkUpsertLocationCustomAttributesRequest] body Required
     # parameter: An object containing the fields to POST for the request.  See
     # the corresponding object definition for field details.
-    # @return [BulkUpsertLocationCustomAttributesResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def bulk_upsert_location_custom_attributes(body:)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::POST,
@@ -265,7 +265,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 [ListLocationCustomAttributesResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def list_location_custom_attributes(location_id:,
                                         visibility_filter: nil,
                                         limit: nil,
@@ -301,7 +301,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 [DeleteLocationCustomAttributeResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def delete_location_custom_attribute(location_id:,
                                          key:)
       new_api_call_builder
@@ -347,7 +347,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 [RetrieveLocationCustomAttributeResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def retrieve_location_custom_attribute(location_id:,
                                            key:,
                                            with_definition: false,
@@ -392,7 +392,7 @@ module Square
     # @param [UpsertLocationCustomAttributeRequest] body Required parameter: An
     # object containing the fields to POST for the request.  See the
     # corresponding object definition for field details.
-    # @return [UpsertLocationCustomAttributeResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def upsert_location_custom_attribute(location_id:,
                                          key:,
                                          body:)

data/lib/square/api/locations_api.rb

@@ -5,7 +5,7 @@ module Square
     # [locations](https://developer.squareup.com/docs/locations-api),
     # including those with an inactive status. Locations are listed
     # alphabetically by `name`.
-    # @return [ListLocationsResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def list_locations
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::GET,
@@ -33,7 +33,7 @@ module Square
     # @param [CreateLocationRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
-    # @return [CreateLocationResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def create_location(body:)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::POST,
@@ -57,7 +57,7 @@ module Square
     # -location).
     # @param [String] location_id Required parameter: The ID of the location to
     # retrieve. Specify the string "main" to return the main location.
-    # @return [RetrieveLocationResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def retrieve_location(location_id:)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::GET,
@@ -80,7 +80,7 @@ module Square
     # @param [UpdateLocationRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
-    # @return [UpdateLocationResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def update_location(location_id:,
                         body:)
       new_api_call_builder

data/lib/square/api/loyalty_api.rb

@@ -6,7 +6,7 @@ module Square
     # @param [CreateLoyaltyAccountRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
-    # @return [CreateLoyaltyAccountResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def create_loyalty_account(body:)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::POST,
@@ -32,7 +32,7 @@ module Square
     # @param [SearchLoyaltyAccountsRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
-    # @return [SearchLoyaltyAccountsResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def search_loyalty_accounts(body:)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::POST,
@@ -53,7 +53,7 @@ module Square
     # Retrieves a loyalty account.
     # @param [String] account_id Required parameter: The ID of the [loyalty
     # account](entity:LoyaltyAccount) to retrieve.
-    # @return [RetrieveLoyaltyAccountResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def retrieve_loyalty_account(account_id:)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::GET,
@@ -100,7 +100,7 @@ module Square
     # @param [AccumulateLoyaltyPointsRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
-    # @return [AccumulateLoyaltyPointsResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def accumulate_loyalty_points(account_id:,
                                   body:)
       new_api_call_builder
@@ -131,7 +131,7 @@ module Square
     # @param [AdjustLoyaltyPointsRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
-    # @return [AdjustLoyaltyPointsResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def adjust_loyalty_points(account_id:,
                               body:)
       new_api_call_builder
@@ -163,7 +163,7 @@ module Square
     # @param [SearchLoyaltyEventsRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
-    # @return [SearchLoyaltyEventsResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def search_loyalty_events(body:)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::POST,
@@ -190,7 +190,7 @@ module Square
     # Replaced with
     # [RetrieveLoyaltyProgram](api-endpoint:Loyalty-RetrieveLoyaltyProgram) when
     # used with the keyword `main`.
-    # @return [ListLoyaltyProgramsResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def list_loyalty_programs
       warn 'Endpoint list_loyalty_programs in LoyaltyApi is deprecated'
       new_api_call_builder
@@ -216,7 +216,7 @@ module Square
     # @param [String] program_id Required parameter: The ID of the loyalty
     # program or the keyword `main`. Either value can be used to retrieve the
     # single loyalty program that belongs to the seller.
-    # @return [RetrieveLoyaltyProgramResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def retrieve_loyalty_program(program_id:)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::GET,
@@ -263,7 +263,7 @@ module Square
     # @param [CalculateLoyaltyPointsRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
-    # @return [CalculateLoyaltyPointsResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def calculate_loyalty_points(program_id:,
                                  body:)
       new_api_call_builder
@@ -307,7 +307,7 @@ module Square
     # 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
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def list_loyalty_promotions(program_id:,
                                 status: nil,
                                 cursor: nil,
@@ -347,7 +347,7 @@ module Square
     # @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
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def create_loyalty_promotion(program_id:,
                                  body:)
       new_api_call_builder
@@ -375,7 +375,7 @@ module Square
     # program](entity:LoyaltyProgram). To get the program ID, call
     # [RetrieveLoyaltyProgram](api-endpoint:Loyalty-RetrieveLoyaltyProgram)
     # using the `main` keyword.
-    # @return [RetrieveLoyaltyPromotionResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def retrieve_loyalty_promotion(promotion_id:,
                                    program_id:)
       new_api_call_builder
@@ -408,7 +408,7 @@ module Square
     # that has an `ACTIVE` or `SCHEDULED` status.
     # @param [String] program_id Required parameter: The ID of the base [loyalty
     # program](entity:LoyaltyProgram).
-    # @return [CancelLoyaltyPromotionResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def cancel_loyalty_promotion(promotion_id:,
                                  program_id:)
       new_api_call_builder
@@ -439,7 +439,7 @@ module Square
     # @param [CreateLoyaltyRewardRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
-    # @return [CreateLoyaltyRewardResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def create_loyalty_reward(body:)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::POST,
@@ -467,7 +467,7 @@ module Square
     # @param [SearchLoyaltyRewardsRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
-    # @return [SearchLoyaltyRewardsResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def search_loyalty_rewards(body:)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::POST,
@@ -494,7 +494,7 @@ module Square
     # You cannot delete a reward that has reached the terminal state (REDEEMED).
     # @param [String] reward_id Required parameter: The ID of the [loyalty
     # reward](entity:LoyaltyReward) to delete.
-    # @return [DeleteLoyaltyRewardResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def delete_loyalty_reward(reward_id:)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::DELETE,
@@ -514,7 +514,7 @@ module Square
     # Retrieves a loyalty reward.
     # @param [String] reward_id Required parameter: The ID of the [loyalty
     # reward](entity:LoyaltyReward) to retrieve.
-    # @return [RetrieveLoyaltyRewardResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def retrieve_loyalty_reward(reward_id:)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::GET,
@@ -544,7 +544,7 @@ module Square
     # @param [RedeemLoyaltyRewardRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
-    # @return [RedeemLoyaltyRewardResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def redeem_loyalty_reward(reward_id:,
                               body:)
       new_api_call_builder

data/lib/square/api/merchant_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 [ListMerchantCustomAttributeDefinitionsResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def list_merchant_custom_attribute_definitions(visibility_filter: nil,
                                                    limit: nil,
                                                    cursor: nil)
@@ -59,7 +59,7 @@ module Square
     # @param [CreateMerchantCustomAttributeDefinitionRequest] body Required
     # parameter: An object containing the fields to POST for the request.  See
     # the corresponding object definition for field details.
-    # @return [CreateMerchantCustomAttributeDefinitionResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def create_merchant_custom_attribute_definition(body:)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::POST,
@@ -85,7 +85,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 [DeleteMerchantCustomAttributeDefinitionResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def delete_merchant_custom_attribute_definition(key:)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::DELETE,
@@ -116,7 +116,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 [RetrieveMerchantCustomAttributeDefinitionResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def retrieve_merchant_custom_attribute_definition(key:,
                                                       version: nil)
       new_api_call_builder
@@ -146,7 +146,7 @@ module Square
     # @param [UpdateMerchantCustomAttributeDefinitionRequest] body Required
     # parameter: An object containing the fields to POST for the request.  See
     # the corresponding object definition for field details.
-    # @return [UpdateMerchantCustomAttributeDefinitionResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def update_merchant_custom_attribute_definition(key:,
                                                     body:)
       new_api_call_builder
@@ -175,7 +175,7 @@ module Square
     # @param [BulkDeleteMerchantCustomAttributesRequest] body Required
     # parameter: An object containing the fields to POST for the request.  See
     # the corresponding object definition for field details.
-    # @return [BulkDeleteMerchantCustomAttributesResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def bulk_delete_merchant_custom_attributes(body:)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::POST,
@@ -215,7 +215,7 @@ module Square
     # @param [BulkUpsertMerchantCustomAttributesRequest] body Required
     # parameter: An object containing the fields to POST for the request.  See
     # the corresponding object definition for field details.
-    # @return [BulkUpsertMerchantCustomAttributesResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def bulk_upsert_merchant_custom_attributes(body:)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::POST,
@@ -265,7 +265,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 [ListMerchantCustomAttributesResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def list_merchant_custom_attributes(merchant_id:,
                                         visibility_filter: nil,
                                         limit: nil,
@@ -301,7 +301,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 [DeleteMerchantCustomAttributeResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def delete_merchant_custom_attribute(merchant_id:,
                                          key:)
       new_api_call_builder
@@ -347,7 +347,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 [RetrieveMerchantCustomAttributeResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def retrieve_merchant_custom_attribute(merchant_id:,
                                            key:,
                                            with_definition: false,
@@ -392,7 +392,7 @@ module Square
     # @param [UpsertMerchantCustomAttributeRequest] body Required parameter: An
     # object containing the fields to POST for the request.  See the
     # corresponding object definition for field details.
-    # @return [UpsertMerchantCustomAttributeResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def upsert_merchant_custom_attribute(merchant_id:,
                                          key:,
                                          body:)

data/lib/square/api/merchants_api.rb

@@ -14,7 +14,7 @@ module Square
     # endpoint to retrieve the merchant information.
     # @param [Integer] cursor Optional parameter: The cursor generated by the
     # previous response.
-    # @return [ListMerchantsResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def list_merchants(cursor: nil)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::GET,
@@ -34,7 +34,7 @@ module Square
     # @param [String] merchant_id Required parameter: The ID of the merchant to
     # retrieve. If the string "me" is supplied as the ID, then retrieve the
     # merchant that is currently accessible to this call.
-    # @return [RetrieveMerchantResponse Hash] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def retrieve_merchant(merchant_id:)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::GET,