square.rb 13.0.0.20210721 → 16.0.0.20211117

data/lib/square/api/gift_card_activities_api.rb

@@ -13,29 +13,35 @@ module Square
     # for a gift card,
     # for all gift cards in a specific region, or for activities within a time
     # window.
-    # @param [String] gift_card_id Optional parameter: If you provide a gift
-    # card ID, the endpoint returns activities that belong  to the specified
-    # gift card. Otherwise, the endpoint returns all gift card activities for 
-    # the seller.
-    # @param [String] type Optional parameter: If you provide a type, the
-    # endpoint returns gift card activities of this type.  Otherwise, the
-    # endpoint returns all types of gift card activities.
-    # @param [String] location_id Optional parameter: If you provide a location
-    # ID, the endpoint returns gift card activities for that location. 
-    # Otherwise, the endpoint returns gift card activities for all locations.
+    # @param [String] gift_card_id Optional parameter: If a gift card ID is
+    # provided, the endpoint returns activities related  to the specified gift
+    # card. Otherwise, the endpoint returns all gift card activities for  the
+    # seller.
+    # @param [String] type Optional parameter: If a
+    # [type]($m/GiftCardActivityType) is provided, the endpoint returns gift
+    # card activities of the specified type.  Otherwise, the endpoint returns
+    # all types of gift card activities.
+    # @param [String] location_id Optional parameter: If a location ID is
+    # provided, the endpoint returns gift card activities for the specified
+    # location.  Otherwise, the endpoint returns gift card activities for all
+    # locations.
     # @param [String] begin_time Optional parameter: The timestamp for the
-    # beginning of the reporting period, in RFC 3339 format. Inclusive. Default:
-    # The current time minus one year.
+    # beginning of the reporting period, in RFC 3339 format. This start time is
+    # inclusive. The default value is the current time minus one year.
     # @param [String] end_time Optional parameter: The timestamp for the end of
-    # the reporting period, in RFC 3339 format. Inclusive. Default: The current
-    # time.
-    # @param [Integer] limit Optional parameter: If you provide a limit value,
-    # the endpoint returns the specified number  of results (or less) per page.
-    # A maximum value is 100. The default value is 50.
+    # the reporting period, in RFC 3339 format. This end time is inclusive. The
+    # default value is the current time.
+    # @param [Integer] limit Optional parameter: If a limit is provided, the
+    # endpoint returns the specified number  of results (or fewer) per page. The
+    # maximum value is 100. The default value is 50. For more information, see
+    # [Pagination](https://developer.squareup.com/docs/working-with-apis/paginat
+    # ion).
     # @param [String] cursor Optional parameter: A pagination cursor returned by
     # a previous call to this endpoint. Provide this cursor to retrieve the next
-    # set of results for the original query. If you do not provide the cursor,
-    # the call returns the first page of the results.
+    # set of results for the original query. If a cursor is not provided, the
+    # endpoint returns the first page of the results. For more information, see
+    # [Pagination](https://developer.squareup.com/docs/working-with-apis/paginat
+    # ion).
     # @param [String] sort_order Optional parameter: The order in which the
     # endpoint returns the activities, based on `created_at`. - `ASC` - Oldest
     # to newest. - `DESC` - Newest to oldest (default).
@@ -104,7 +110,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/gift_cards_api.rb

@@ -7,24 +7,26 @@ module Square
 
     # Lists all gift cards. You can specify optional filters to retrieve
     # a subset of the gift cards.
-    # @param [String] type Optional parameter: If a type is provided, gift cards
-    # of this type are returned  (see [GiftCardType]($m/GiftCardType)). If no
-    # type is provided, it returns gift cards of all types.
-    # @param [String] state Optional parameter: If the state is provided, it
-    # returns the gift cards in the specified state  (see
-    # [GiftCardStatus]($m/GiftCardStatus)). Otherwise, it returns the gift cards
-    # of all states.
-    # @param [Integer] limit Optional parameter: If a value is provided, it
-    # returns only that number of results per page. The maximum number of
-    # results allowed per page is 50. The default value is 30.
+    # @param [String] type Optional parameter: If a [type]($m/GiftCardType) is
+    # provided, the endpoint returns gift cards of the specified type.
+    # Otherwise, the endpoint returns gift cards of all types.
+    # @param [String] state Optional parameter: If a [state]($m/GiftCardStatus)
+    # is provided, the endpoint returns the gift cards in the specified state.
+    # Otherwise, the endpoint returns the gift cards of all states.
+    # @param [Integer] limit Optional parameter: If a limit is provided, the
+    # endpoint returns only the specified number of results per page. The
+    # maximum value is 50. The default value is 30. For more information, see
+    # [Pagination](https://developer.squareup.com/docs/working-with-apis/paginat
+    # ion).
     # @param [String] cursor Optional parameter: A pagination cursor returned by
     # a previous call to this endpoint. Provide this cursor to retrieve the next
-    # set of results for the original query. If a cursor is not provided, it
-    # returns the first page of the results.  For more information, see
+    # set of results for the original query. If a cursor is not provided, the
+    # endpoint returns the first page of the results.  For more information, see
     # [Pagination](https://developer.squareup.com/docs/working-with-apis/paginat
     # ion).
-    # @param [String] customer_id Optional parameter: If a value is provided,
-    # returns only the gift cards linked to the specified customer
+    # @param [String] customer_id Optional parameter: If a customer ID is
+    # provided, the endpoint returns only the gift cards linked to the specified
+    # customer.
     # @return [ListGiftCardsResponse Hash] response from the API call
     def list_gift_cards(type: nil,
                         state: nil,
@@ -65,8 +67,9 @@ module Square
       )
     end
 
-    # Creates a digital gift card. You must activate the gift card before
-    # it can be used. For more information, see
+    # Creates a digital gift card or registers a physical (plastic) gift card.
+    # You must activate the gift card before
+    # it can be used for payment. For more information, see
     # [Selling gift
     # cards](https://developer.squareup.com/docs/gift-cards/using-gift-cards-api
     # #selling-square-gift-cards).
@@ -83,7 +86,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
@@ -117,7 +120,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
@@ -137,7 +140,7 @@ module Square
       )
     end
 
-    # Retrieves a gift card using a nonce (a secure token) that represents the
+    # Retrieves a gift card using a secure payment token that represents the
     # gift card.
     # @param [RetrieveGiftCardFromNonceRequest] body Required parameter: An
     # object containing the fields to POST for the request.  See the
@@ -152,7 +155,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
@@ -172,9 +175,10 @@ module Square
       )
     end
 
-    # Links a customer to a gift card
+    # Links a customer to a gift card, which is also referred to as adding a
+    # card on file.
     # @param [String] gift_card_id Required parameter: The ID of the gift card
-    # to link.
+    # to be linked.
     # @param [LinkCustomerToGiftCardRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
@@ -193,7 +197,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
@@ -213,8 +217,10 @@ module Square
       )
     end
 
-    # Unlinks a customer from a gift card
-    # @param [String] gift_card_id Required parameter: Example:
+    # Unlinks a customer from a gift card, which is also referred to as removing
+    # a card on file.
+    # @param [String] gift_card_id Required parameter: The ID of the gift card
+    # to be unlinked.
     # @param [UnlinkCustomerFromGiftCardRequest] body Required parameter: An
     # object containing the fields to POST for the request.  See the
     # corresponding object definition for field details.
@@ -233,7 +239,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/inventory_api.rb

@@ -100,7 +100,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
@@ -139,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.
@@ -178,7 +178,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
@@ -215,7 +215,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
@@ -254,7 +254,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
@@ -297,7 +297,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/invoices_api.rb

@@ -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.
@@ -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.
@@ -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.
@@ -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.
@@ -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

@@ -51,7 +51,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
@@ -130,7 +130,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.