square.rb 33.0.0.20231018 → 42.1.0.20250416

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)
@@ -28,9 +28,9 @@ module Square
                    .header_param(new_parameter('application/json', key: 'accept'))
                    .auth(Single.new('global')))
         .response(new_response_handler
-                   .deserializer(APIHelper.method(:json_deserialize))
-                   .is_api_response(true)
-                   .convertor(ApiResponse.method(:create)))
+                    .deserializer(APIHelper.method(:json_deserialize))
+                    .is_api_response(true)
+                    .convertor(ApiResponse.method(:create)))
         .execute
     end
 
@@ -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,
@@ -54,9 +54,9 @@ module Square
                    .body_serializer(proc do |param| param.to_json unless param.nil? end)
                    .auth(Single.new('global')))
         .response(new_response_handler
-                   .deserializer(APIHelper.method(:json_deserialize))
-                   .is_api_response(true)
-                   .convertor(ApiResponse.method(:create)))
+                    .deserializer(APIHelper.method(:json_deserialize))
+                    .is_api_response(true)
+                    .convertor(ApiResponse.method(:create)))
         .execute
     end
 
@@ -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,
@@ -82,9 +82,9 @@ module Square
                    .body_serializer(proc do |param| param.to_json unless param.nil? end)
                    .auth(Single.new('global')))
         .response(new_response_handler
-                   .deserializer(APIHelper.method(:json_deserialize))
-                   .is_api_response(true)
-                   .convertor(ApiResponse.method(:create)))
+                    .deserializer(APIHelper.method(:json_deserialize))
+                    .is_api_response(true)
+                    .convertor(ApiResponse.method(:create)))
         .execute
     end
 
@@ -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
@@ -111,16 +111,16 @@ module Square
                    .header_param(new_parameter('application/json', key: 'accept'))
                    .auth(Single.new('global')))
         .response(new_response_handler
-                   .deserializer(APIHelper.method(:json_deserialize))
-                   .is_api_response(true)
-                   .convertor(ApiResponse.method(:create)))
+                    .deserializer(APIHelper.method(:json_deserialize))
+                    .is_api_response(true)
+                    .convertor(ApiResponse.method(:create)))
         .execute
     end
 
     # 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,
@@ -131,26 +131,25 @@ module Square
                    .header_param(new_parameter('application/json', key: 'accept'))
                    .auth(Single.new('global')))
         .response(new_response_handler
-                   .deserializer(APIHelper.method(:json_deserialize))
-                   .is_api_response(true)
-                   .convertor(ApiResponse.method(:create)))
+                    .deserializer(APIHelper.method(:json_deserialize))
+                    .is_api_response(true)
+                    .convertor(ApiResponse.method(:create)))
         .execute
     end
 
-    # Updates an invoice by modifying fields, clearing fields, or both. For most
-    # updates, you can use a sparse
-    # `Invoice` object to add fields or change values and use the
-    # `fields_to_clear` field to specify fields to clear.
-    # However, some restrictions apply. For example, you cannot change the
-    # `order_id` or `location_id` field and you
-    # must provide the complete `custom_fields` list to update a custom field.
-    # Published invoices have additional restrictions.
+    # Updates an invoice. This endpoint supports sparse updates, so you only
+    # need
+    # to specify the fields you want to change along with the required `version`
+    # field.
+    # Some restrictions apply to updating invoices. For example, you cannot
+    # change the
+    # `order_id` or `location_id` field.
     # @param [String] invoice_id Required parameter: The ID of the invoice to
     # update.
     # @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
@@ -165,9 +164,74 @@ module Square
                    .body_serializer(proc do |param| param.to_json unless param.nil? end)
                    .auth(Single.new('global')))
         .response(new_response_handler
-                   .deserializer(APIHelper.method(:json_deserialize))
-                   .is_api_response(true)
-                   .convertor(ApiResponse.method(:create)))
+                    .deserializer(APIHelper.method(:json_deserialize))
+                    .is_api_response(true)
+                    .convertor(ApiResponse.method(:create)))
+        .execute
+    end
+
+    # Uploads a file and attaches it to an invoice. This endpoint accepts HTTP
+    # multipart/form-data file uploads
+    # with a JSON `request` part and a `file` part. The `file` part must be a
+    # `readable stream` that contains a file
+    # in a supported format: GIF, JPEG, PNG, TIFF, BMP, or PDF.
+    # Invoices can have up to 10 attachments with a total file size of 25 MB.
+    # Attachments can be added only to invoices
+    # in the `DRAFT`, `SCHEDULED`, `UNPAID`, or `PARTIALLY_PAID` state.
+    # @param [String] invoice_id Required parameter: The ID of the
+    # [invoice](entity:Invoice) to attach the file to.
+    # @param [CreateInvoiceAttachmentRequest] request Optional parameter:
+    # Represents a
+    # [CreateInvoiceAttachment]($e/Invoices/CreateInvoiceAttachment) request.
+    # @param [File | UploadIO] image_file Optional parameter: Example:
+    # @return [ApiResponse]  the complete http response with raw body and status code.
+    def create_invoice_attachment(invoice_id:,
+                                  request: nil,
+                                  image_file: nil)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/v2/invoices/{invoice_id}/attachments',
+                                     'default')
+                   .template_param(new_parameter(invoice_id, key: 'invoice_id')
+                                    .should_encode(true))
+                   .multipart_param(new_parameter(StringIO.new(request.to_json), key: 'request')
+                                     .default_content_type('application/json; charset=utf-8'))
+                   .multipart_param(new_parameter(image_file, key: 'image_file')
+                                     .default_content_type('image/jpeg'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('global')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:json_deserialize))
+                    .is_api_response(true)
+                    .convertor(ApiResponse.method(:create)))
+        .execute
+    end
+
+    # Removes an attachment from an invoice and permanently deletes the file.
+    # Attachments can be removed only
+    # from invoices in the `DRAFT`, `SCHEDULED`, `UNPAID`, or `PARTIALLY_PAID`
+    # state.
+    # @param [String] invoice_id Required parameter: The ID of the
+    # [invoice](entity:Invoice) to delete the attachment from.
+    # @param [String] attachment_id Required parameter: The ID of the
+    # [attachment](entity:InvoiceAttachment) to delete.
+    # @return [ApiResponse]  the complete http response with raw body and status code.
+    def delete_invoice_attachment(invoice_id:,
+                                  attachment_id:)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::DELETE,
+                                     '/v2/invoices/{invoice_id}/attachments/{attachment_id}',
+                                     'default')
+                   .template_param(new_parameter(invoice_id, key: 'invoice_id')
+                                    .should_encode(true))
+                   .template_param(new_parameter(attachment_id, key: 'attachment_id')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('global')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:json_deserialize))
+                    .is_api_response(true)
+                    .convertor(ApiResponse.method(:create)))
         .execute
     end
 
@@ -180,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
@@ -195,9 +259,9 @@ module Square
                    .body_serializer(proc do |param| param.to_json unless param.nil? end)
                    .auth(Single.new('global')))
         .response(new_response_handler
-                   .deserializer(APIHelper.method(:json_deserialize))
-                   .is_api_response(true)
-                   .convertor(ApiResponse.method(:create)))
+                    .deserializer(APIHelper.method(:json_deserialize))
+                    .is_api_response(true)
+                    .convertor(ApiResponse.method(:create)))
         .execute
     end
 
@@ -211,15 +275,19 @@ module Square
     # The invoice `status` also changes from `DRAFT` to a status
     # based on the invoice configuration. For example, the status changes to
     # `UNPAID` if
-    # Square emails the invoice or `PARTIALLY_PAID` if Square charge a card on
+    # Square emails the invoice or `PARTIALLY_PAID` if Square charges a card on
     # file for a portion of the
     # invoice amount.
+    # In addition to the required `ORDERS_WRITE` and `INVOICES_WRITE`
+    # permissions, `CUSTOMERS_READ`
+    # and `PAYMENTS_WRITE` are required when publishing invoices configured for
+    # card-on-file payments.
     # @param [String] invoice_id Required parameter: The ID of the invoice to
     # publish.
     # @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
@@ -234,9 +302,9 @@ module Square
                    .body_serializer(proc do |param| param.to_json unless param.nil? end)
                    .auth(Single.new('global')))
         .response(new_response_handler
-                   .deserializer(APIHelper.method(:json_deserialize))
-                   .is_api_response(true)
-                   .convertor(ApiResponse.method(:create)))
+                    .deserializer(APIHelper.method(:json_deserialize))
+                    .is_api_response(true)
+                    .convertor(ApiResponse.method(:create)))
         .execute
     end
   end

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)
@@ -24,9 +24,9 @@ module Square
                    .header_param(new_parameter('application/json', key: 'accept'))
                    .auth(Single.new('global')))
         .response(new_response_handler
-                   .deserializer(APIHelper.method(:json_deserialize))
-                   .is_api_response(true)
-                   .convertor(ApiResponse.method(:create)))
+                    .deserializer(APIHelper.method(:json_deserialize))
+                    .is_api_response(true)
+                    .convertor(ApiResponse.method(:create)))
         .execute
     end
 
@@ -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,
@@ -58,9 +58,9 @@ module Square
                    .body_serializer(proc do |param| param.to_json unless param.nil? end)
                    .auth(Single.new('global')))
         .response(new_response_handler
-                   .deserializer(APIHelper.method(:json_deserialize))
-                   .is_api_response(true)
-                   .convertor(ApiResponse.method(:create)))
+                    .deserializer(APIHelper.method(:json_deserialize))
+                    .is_api_response(true)
+                    .convertor(ApiResponse.method(:create)))
         .execute
     end
 
@@ -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,
@@ -79,16 +79,16 @@ module Square
                    .header_param(new_parameter('application/json', key: 'accept'))
                    .auth(Single.new('global')))
         .response(new_response_handler
-                   .deserializer(APIHelper.method(:json_deserialize))
-                   .is_api_response(true)
-                   .convertor(ApiResponse.method(:create)))
+                    .deserializer(APIHelper.method(:json_deserialize))
+                    .is_api_response(true)
+                    .convertor(ApiResponse.method(:create)))
         .execute
     end
 
     # 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,
@@ -99,9 +99,9 @@ module Square
                    .header_param(new_parameter('application/json', key: 'accept'))
                    .auth(Single.new('global')))
         .response(new_response_handler
-                   .deserializer(APIHelper.method(:json_deserialize))
-                   .is_api_response(true)
-                   .convertor(ApiResponse.method(:create)))
+                    .deserializer(APIHelper.method(:json_deserialize))
+                    .is_api_response(true)
+                    .convertor(ApiResponse.method(:create)))
         .execute
     end
 
@@ -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
@@ -126,9 +126,9 @@ module Square
                    .body_serializer(proc do |param| param.to_json unless param.nil? end)
                    .auth(Single.new('global')))
         .response(new_response_handler
-                   .deserializer(APIHelper.method(:json_deserialize))
-                   .is_api_response(true)
-                   .convertor(ApiResponse.method(:create)))
+                    .deserializer(APIHelper.method(:json_deserialize))
+                    .is_api_response(true)
+                    .convertor(ApiResponse.method(:create)))
         .execute
     end
 
@@ -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)
@@ -155,16 +155,16 @@ module Square
                    .header_param(new_parameter('application/json', key: 'accept'))
                    .auth(Single.new('global')))
         .response(new_response_handler
-                   .deserializer(APIHelper.method(:json_deserialize))
-                   .is_api_response(true)
-                   .convertor(ApiResponse.method(:create)))
+                    .deserializer(APIHelper.method(:json_deserialize))
+                    .is_api_response(true)
+                    .convertor(ApiResponse.method(:create)))
         .execute
     end
 
     # 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
@@ -176,33 +176,34 @@ module Square
                    .header_param(new_parameter('application/json', key: 'accept'))
                    .auth(Single.new('global')))
         .response(new_response_handler
-                   .deserializer(APIHelper.method(:json_deserialize))
-                   .is_api_response(true)
-                   .convertor(ApiResponse.method(:create)))
+                    .deserializer(APIHelper.method(:json_deserialize))
+                    .is_api_response(true)
+                    .convertor(ApiResponse.method(:create)))
         .execute
     end
 
     # Creates a new `Shift`.
-    # A `Shift` represents a complete workday for a single employee.
+    # A `Shift` represents a complete workday for a single team member.
     # You must provide the following values in your request to this
     # endpoint:
     # - `location_id`
-    # - `employee_id`
+    # - `team_member_id`
     # - `start_at`
     # An attempt to create a new `Shift` can result in a `BAD_REQUEST` error
     # when:
-    # - The `status` of the new `Shift` is `OPEN` and the employee has another
+    # - The `status` of the new `Shift` is `OPEN` and the team member has
+    # another
     # shift with an `OPEN` status.
     # - The `start_at` date is in the future.
-    # - The `start_at` or `end_at` date overlaps another shift for the same
-    # employee.
+    # - The `start_at` or `end_at` date overlaps another shift for the same team
+    # member.
     # - The `Break` instances are set in the request and a break `start_at`
     # is before the `Shift.start_at`, a break `end_at` is after
     # the `Shift.end_at`, or both.
     # @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,
@@ -214,29 +215,29 @@ module Square
                    .body_serializer(proc do |param| param.to_json unless param.nil? end)
                    .auth(Single.new('global')))
         .response(new_response_handler
-                   .deserializer(APIHelper.method(:json_deserialize))
-                   .is_api_response(true)
-                   .convertor(ApiResponse.method(:create)))
+                    .deserializer(APIHelper.method(:json_deserialize))
+                    .is_api_response(true)
+                    .convertor(ApiResponse.method(:create)))
         .execute
     end
 
     # Returns a paginated list of `Shift` records for a business.
     # The list to be returned can be filtered by:
-    # - Location IDs.
-    # - Employee IDs.
-    # - Shift status (`OPEN` and `CLOSED`).
-    # - Shift start.
-    # - Shift end.
-    # - Workday details.
+    # - Location IDs
+    # - Team member IDs
+    # - Shift status (`OPEN` or `CLOSED`)
+    # - Shift start
+    # - Shift end
+    # - Workday details
     # The list can be sorted by:
-    # - `start_at`.
-    # - `end_at`.
-    # - `created_at`.
-    # - `updated_at`.
+    # - `START_AT`
+    # - `END_AT`
+    # - `CREATED_AT`
+    # - `UPDATED_AT`
     # @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,
@@ -248,16 +249,16 @@ module Square
                    .body_serializer(proc do |param| param.to_json unless param.nil? end)
                    .auth(Single.new('global')))
         .response(new_response_handler
-                   .deserializer(APIHelper.method(:json_deserialize))
-                   .is_api_response(true)
-                   .convertor(ApiResponse.method(:create)))
+                    .deserializer(APIHelper.method(:json_deserialize))
+                    .is_api_response(true)
+                    .convertor(ApiResponse.method(:create)))
         .execute
     end
 
     # 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,
@@ -268,16 +269,16 @@ module Square
                    .header_param(new_parameter('application/json', key: 'accept'))
                    .auth(Single.new('global')))
         .response(new_response_handler
-                   .deserializer(APIHelper.method(:json_deserialize))
-                   .is_api_response(true)
-                   .convertor(ApiResponse.method(:create)))
+                    .deserializer(APIHelper.method(:json_deserialize))
+                    .is_api_response(true)
+                    .convertor(ApiResponse.method(:create)))
         .execute
     end
 
     # 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,
@@ -288,9 +289,9 @@ module Square
                    .header_param(new_parameter('application/json', key: 'accept'))
                    .auth(Single.new('global')))
         .response(new_response_handler
-                   .deserializer(APIHelper.method(:json_deserialize))
-                   .is_api_response(true)
-                   .convertor(ApiResponse.method(:create)))
+                    .deserializer(APIHelper.method(:json_deserialize))
+                    .is_api_response(true)
+                    .convertor(ApiResponse.method(:create)))
         .execute
     end
 
@@ -306,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
@@ -321,9 +322,9 @@ module Square
                    .body_serializer(proc do |param| param.to_json unless param.nil? end)
                    .auth(Single.new('global')))
         .response(new_response_handler
-                   .deserializer(APIHelper.method(:json_deserialize))
-                   .is_api_response(true)
-                   .convertor(ApiResponse.method(:create)))
+                    .deserializer(APIHelper.method(:json_deserialize))
+                    .is_api_response(true)
+                    .convertor(ApiResponse.method(:create)))
         .execute
     end
 
@@ -335,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)
@@ -349,16 +350,16 @@ module Square
                    .header_param(new_parameter('application/json', key: 'accept'))
                    .auth(Single.new('global')))
         .response(new_response_handler
-                   .deserializer(APIHelper.method(:json_deserialize))
-                   .is_api_response(true)
-                   .convertor(ApiResponse.method(:create)))
+                    .deserializer(APIHelper.method(:json_deserialize))
+                    .is_api_response(true)
+                    .convertor(ApiResponse.method(:create)))
         .execute
     end
 
-    # Returns a single `TeamMemberWage` specified by `id `.
+    # 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,
@@ -369,9 +370,9 @@ module Square
                    .header_param(new_parameter('application/json', key: 'accept'))
                    .auth(Single.new('global')))
         .response(new_response_handler
-                   .deserializer(APIHelper.method(:json_deserialize))
-                   .is_api_response(true)
-                   .convertor(ApiResponse.method(:create)))
+                    .deserializer(APIHelper.method(:json_deserialize))
+                    .is_api_response(true)
+                    .convertor(ApiResponse.method(:create)))
         .execute
     end
 
@@ -380,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
@@ -392,9 +393,9 @@ module Square
                    .header_param(new_parameter('application/json', key: 'accept'))
                    .auth(Single.new('global')))
         .response(new_response_handler
-                   .deserializer(APIHelper.method(:json_deserialize))
-                   .is_api_response(true)
-                   .convertor(ApiResponse.method(:create)))
+                    .deserializer(APIHelper.method(:json_deserialize))
+                    .is_api_response(true)
+                    .convertor(ApiResponse.method(:create)))
         .execute
     end
 
@@ -404,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
@@ -419,9 +420,9 @@ module Square
                    .body_serializer(proc do |param| param.to_json unless param.nil? end)
                    .auth(Single.new('global')))
         .response(new_response_handler
-                   .deserializer(APIHelper.method(:json_deserialize))
-                   .is_api_response(true)
-                   .convertor(ApiResponse.method(:create)))
+                    .deserializer(APIHelper.method(:json_deserialize))
+                    .is_api_response(true)
+                    .convertor(ApiResponse.method(:create)))
         .execute
     end
   end