square.rb 8.1.0.20210121 → 18.1.0.20220316

data/lib/square/api/invoices_api.rb

@@ -7,7 +7,7 @@ module Square
 
     # Returns a list of invoices for a given location. The response
     # is paginated. If truncated, the response includes a `cursor` that you
-    # use in a subsequent request to fetch the next set of invoices.
+    # use in a subsequent request to retrieve the next set of invoices.
     # @param [String] location_id Required parameter: The ID of the location for
     # which to list invoices.
     # @param [String] cursor Optional parameter: A pagination cursor returned by
@@ -16,7 +16,7 @@ module Square
     # [Pagination](https://developer.squareup.com/docs/working-with-apis/paginat
     # ion).
     # @param [Integer] limit Optional parameter: The maximum number of invoices
-    # to return (200 is the maximum `limit`).  If not provided, the server  uses
+    # 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
     def list_invoices(location_id:,
@@ -54,7 +54,7 @@ module Square
       )
     end
 
-    # Creates a draft [invoice](#type-invoice)
+    # Creates a draft [invoice]($m/Invoice)
     # for an order created using the Orders API.
     # A draft invoice remains in your account and no action is taken.
     # You must publish the invoice before Square can process it (send it to the
@@ -72,7 +72,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
@@ -98,7 +98,7 @@ module Square
     # location and
     # optionally one customer.
     # The response is paginated. If truncated, the response includes a `cursor`
-    # that you use in a subsequent request to fetch the next set of invoices.
+    # that you use in a subsequent request to retrieve the next set of invoices.
     # @param [SearchInvoicesRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
@@ -112,7 +112,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
@@ -133,15 +133,15 @@ module Square
     end
 
     # Deletes the specified invoice. When an invoice is deleted, the
-    # associated Order status changes to CANCELED. You can only delete a draft
+    # associated order status changes to CANCELED. You can only delete a draft
     # invoice (you cannot delete a published invoice, including one that is
     # scheduled for processing).
     # @param [String] invoice_id Required parameter: The ID of the invoice to
     # delete.
     # @param [Integer] version Optional parameter: The version of the
-    # [invoice](#type-invoice) to delete. If you do not know the version, you
-    # can call [GetInvoice](#endpoint-Invoices-GetInvoice) or 
-    # [ListInvoices](#endpoint-Invoices-ListInvoices).
+    # [invoice]($m/Invoice) to delete. If you do not know the version, you can
+    # call [GetInvoice]($e/Invoices/GetInvoice) or 
+    # [ListInvoices]($e/Invoices/ListInvoices).
     # @return [DeleteInvoiceResponse Hash] response from the API call
     def delete_invoice(invoice_id:,
                        version: nil)
@@ -180,7 +180,7 @@ module Square
     end
 
     # Retrieves an invoice by invoice ID.
-    # @param [String] invoice_id Required parameter: The id of the invoice to
+    # @param [String] invoice_id Required parameter: The ID of the invoice to
     # retrieve.
     # @return [GetInvoiceResponse Hash] response from the API call
     def get_invoice(invoice_id:)
@@ -216,10 +216,10 @@ module Square
 
     # 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
+    # `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
+    # `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.
     # @param [String] invoice_id Required parameter: The ID of the invoice to
@@ -242,7 +242,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
@@ -267,7 +267,7 @@ module Square
     # You cannot cancel an invoice in the `DRAFT` state or in a terminal state:
     # `PAID`, `REFUNDED`, `CANCELED`, or `FAILED`.
     # @param [String] invoice_id Required parameter: The ID of the
-    # [invoice](#type-invoice) to cancel.
+    # [invoice]($m/Invoice) to cancel.
     # @param [CancelInvoiceRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
@@ -286,7 +286,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
@@ -318,8 +318,8 @@ module Square
     # `UNPAID` if
     # Square emails the invoice or `PARTIALLY_PAID` if Square charge a card on
     # file for a portion of the
-    # invoice amount).
-    # @param [String] invoice_id Required parameter: The id of the invoice to
+    # invoice amount.
+    # @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
@@ -339,7 +339,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.

data/lib/square/api/labor_api.rb

@@ -6,13 +6,14 @@ module Square
     end
 
     # Returns a paginated list of `BreakType` instances for a business.
-    # @param [String] location_id Optional parameter: Filter Break Types
-    # returned to only those that are associated with the specified location.
-    # @param [Integer] limit Optional parameter: Maximum number of Break Types
-    # to return per page. Can range between 1 and 200. The default is the
-    # maximum at 200.
-    # @param [String] cursor Optional parameter: Pointer to the next page of
-    # Break Type results to fetch.
+    # @param [String] location_id Optional parameter: Filter the returned
+    # `BreakType` results to only those that are associated with the specified
+    # location.
+    # @param [Integer] limit Optional parameter: The maximum number of
+    # `BreakType` results to return per page. The number can range between 1 and
+    # 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
     def list_break_types(location_id: nil,
                          limit: nil,
@@ -57,8 +58,8 @@ module Square
     # - `break_name`
     # - `expected_duration`
     # - `is_paid`
-    # You can only have 3 `BreakType` instances per location. If you attempt to
-    # add a 4th
+    # You can only have three `BreakType` instances per location. If you attempt
+    # to add a fourth
     # `BreakType` for a location, an `INVALID_REQUEST_ERROR` "Exceeded limit of
     # 3 breaks per location."
     # is returned.
@@ -75,7 +76,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
@@ -97,7 +98,7 @@ module Square
 
     # Deletes an existing `BreakType`.
     # A `BreakType` can be deleted even if it is referenced from a `Shift`.
-    # @param [String] id Required parameter: UUID for the `BreakType` being
+    # @param [String] id Required parameter: The UUID for the `BreakType` being
     # deleted.
     # @return [DeleteBreakTypeResponse Hash] response from the API call
     def delete_break_type(id:)
@@ -131,8 +132,8 @@ module Square
       )
     end
 
-    # Returns a single `BreakType` specified by id.
-    # @param [String] id Required parameter: UUID for the `BreakType` being
+    # 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
     def get_break_type(id:)
@@ -167,7 +168,7 @@ module Square
     end
 
     # Updates an existing `BreakType`.
-    # @param [String] id Required parameter: UUID for the `BreakType` being
+    # @param [String] id Required parameter: The UUID for the `BreakType` being
     # updated.
     # @param [UpdateBreakTypeRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
@@ -187,7 +188,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
@@ -208,13 +209,13 @@ module Square
     end
 
     # Returns a paginated list of `EmployeeWage` instances for a business.
-    # @param [String] employee_id Optional parameter: Filter wages returned to
-    # only those that are associated with the specified employee.
-    # @param [Integer] limit Optional parameter: Maximum number of Employee
-    # Wages to return per page. Can range between 1 and 200. The default is the
-    # maximum at 200.
-    # @param [String] cursor Optional parameter: Pointer to the next page of
-    # Employee Wage results to fetch.
+    # @param [String] employee_id Optional parameter: Filter the returned wages
+    # to only those that are associated with the specified employee.
+    # @param [Integer] limit Optional parameter: The maximum number of
+    # `EmployeeWage` results to return per page. The number can range between 1
+    # 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
     def list_employee_wages(employee_id: nil,
                             limit: nil,
@@ -252,9 +253,9 @@ module Square
       )
     end
 
-    # Returns a single `EmployeeWage` specified by id.
-    # @param [String] id Required parameter: UUID for the `EmployeeWage` being
-    # retrieved.
+    # 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
     def get_employee_wage(id:)
       warn 'Endpoint get_employee_wage in LaborApi is deprecated'
@@ -289,7 +290,7 @@ module Square
     end
 
     # Creates a new `Shift`.
-    # A `Shift` represents a complete work day for a single employee.
+    # A `Shift` represents a complete workday for a single employee.
     # You must provide the following values in your request to this
     # endpoint:
     # - `location_id`
@@ -299,12 +300,12 @@ module Square
     # when:
     # - The `status` of the new `Shift` is `OPEN` and the employee has another
     # shift with an `OPEN` status.
-    # - The `start_at` date is in the future
-    # - the `start_at` or `end_at` overlaps another shift for the same employee
-    # - If `Break`s are set in the request, a break `start_at`
-    # must not be before the `Shift.start_at`. A break `end_at` must not be
-    # after
-    # the `Shift.end_at`
+    # - The `start_at` date is in the future.
+    # - The `start_at` or `end_at` date overlaps another shift for the same
+    # employee.
+    # - 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.
@@ -318,7 +319,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
@@ -340,17 +341,17 @@ module Square
 
     # Returns a paginated list of `Shift` records for a business.
     # The list to be returned can be filtered by:
-    # - Location IDs **and**
-    # - employee IDs **and**
-    # - shift status (`OPEN`, `CLOSED`) **and**
-    # - shift start **and**
-    # - shift end **and**
-    # - work day details
+    # - Location IDs.
+    # - Employee IDs.
+    # - Shift status (`OPEN` and `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.
@@ -364,7 +365,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
@@ -385,7 +386,7 @@ module Square
     end
 
     # Deletes a `Shift`.
-    # @param [String] id Required parameter: UUID for the `Shift` being
+    # @param [String] id Required parameter: The UUID for the `Shift` being
     # deleted.
     # @return [DeleteShiftResponse Hash] response from the API call
     def delete_shift(id:)
@@ -419,8 +420,8 @@ module Square
       )
     end
 
-    # Returns a single `Shift` specified by id.
-    # @param [String] id Required parameter: UUID for the `Shift` being
+    # 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
     def get_shift(id:)
@@ -455,13 +456,14 @@ module Square
     end
 
     # Updates an existing `Shift`.
-    # When adding a `Break` to a `Shift`, any earlier `Breaks` in the `Shift`
-    # have
+    # When adding a `Break` to a `Shift`, any earlier `Break` instances in the
+    # `Shift` have
     # the `end_at` property set to a valid RFC-3339 datetime string.
-    # When closing a `Shift`, all `Break` instances in the shift must be
+    # When closing a `Shift`, all `Break` instances in the `Shift` must be
     # complete with `end_at`
     # set on each `Break`.
-    # @param [String] id Required parameter: ID of the object being updated.
+    # @param [String] id Required parameter: The ID of the object being
+    # updated.
     # @param [UpdateShiftRequest] body Required parameter: An object containing
     # the fields to POST for the request.  See the corresponding object
     # definition for field details.
@@ -480,7 +482,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
@@ -501,13 +503,13 @@ module Square
     end
 
     # Returns a paginated list of `TeamMemberWage` instances for a business.
-    # @param [String] team_member_id Optional parameter: Filter wages returned
-    # to only those that are associated with the specified team member.
-    # @param [Integer] limit Optional parameter: Maximum number of Team Member
-    # Wages to return per page. Can range between 1 and 200. The default is the
-    # maximum at 200.
-    # @param [String] cursor Optional parameter: Pointer to the next page of
-    # Employee Wage results to fetch.
+    # @param [String] team_member_id Optional parameter: Filter the returned
+    # wages to only those that are associated with the specified team member.
+    # @param [Integer] limit Optional parameter: The maximum number of
+    # `TeamMemberWage` results to return per page. The number can range between
+    # 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
     def list_team_member_wages(team_member_id: nil,
                                limit: nil,
@@ -544,9 +546,9 @@ module Square
       )
     end
 
-    # Returns a single `TeamMemberWage` specified by id.
-    # @param [String] id Required parameter: UUID for the `TeamMemberWage` being
-    # retrieved.
+    # 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
     def get_team_member_wage(id:)
       # Prepare query url.
@@ -580,10 +582,10 @@ module Square
     end
 
     # Returns a list of `WorkweekConfig` instances for a business.
-    # @param [Integer] limit Optional parameter: Maximum number of Workweek
-    # Configs to return per page.
-    # @param [String] cursor Optional parameter: Pointer to the next page of
-    # Workweek Config results to fetch.
+    # @param [Integer] limit Optional parameter: The maximum number of
+    # `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
     def list_workweek_configs(limit: nil,
                               cursor: nil)
@@ -619,7 +621,7 @@ module Square
     end
 
     # Updates a `WorkweekConfig`.
-    # @param [String] id Required parameter: UUID for the `WorkweekConfig`
+    # @param [String] id Required parameter: The UUID for the `WorkweekConfig`
     # object being updated.
     # @param [UpdateWorkweekConfigRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
@@ -639,7 +641,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.

data/lib/square/api/locations_api.rb

@@ -5,11 +5,9 @@ module Square
       super(config, http_call_back: http_call_back)
     end
 
-    # Provides information of all locations of a business.
-    # Many Square API endpoints require a `location_id` parameter.
-    # The `id` field of the [`Location`](#type-location) objects returned by
-    # this
-    # endpoint correspond to that `location_id` parameter.
+    # Provides details about all of the seller's
+    # [locations](https://developer.squareup.com/docs/locations-api),
+    # including those with an inactive status.
     # @return [ListLocationsResponse Hash] response from the API call
     def list_locations
       # Prepare query url.
@@ -38,7 +36,17 @@ module Square
       )
     end
 
-    # Creates a location.
+    # Creates a [location](https://developer.squareup.com/docs/locations-api).
+    # Creating new locations allows for separate configuration of receipt
+    # layouts, item prices,
+    # and sales reports. Developers can use locations to separate sales activity
+    # via applications
+    # that integrate with Square from sales activity elsewhere in a seller's
+    # account.
+    # Locations created programmatically with the Locations API will last
+    # forever and
+    # are visible to the seller for their own management, so ensure that
+    # each location has a sensible and unique name.
     # @param [CreateLocationRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
@@ -52,7 +60,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
@@ -72,12 +80,12 @@ module Square
       )
     end
 
-    # Retrieves details of a location. You can specify "main"
-    # as the location ID to retrieve details of the
-    # main location.
+    # Retrieves details of a single location. Specify "main"
+    # as the location ID to retrieve details of the [main
+    # location](https://developer.squareup.com/docs/locations-api#about-the-main
+    # -location).
     # @param [String] location_id Required parameter: The ID of the location to
-    # retrieve. If you specify the string "main", then the endpoint returns the
-    # main location.
+    # retrieve. Specify the string "main" to return the main location.
     # @return [RetrieveLocationResponse Hash] response from the API call
     def retrieve_location(location_id:)
       # Prepare query url.
@@ -110,7 +118,7 @@ module Square
       )
     end
 
-    # Updates a location.
+    # Updates a [location](https://developer.squareup.com/docs/locations-api).
     # @param [String] location_id Required parameter: The ID of the location to
     # update.
     # @param [UpdateLocationRequest] body Required parameter: An object
@@ -131,7 +139,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.