square.rb 14.1.0.20210915 → 17.0.0.20211215

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,
@@ -84,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.
@@ -118,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.
@@ -138,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
@@ -153,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.
@@ -173,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.
@@ -194,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.
@@ -214,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.
@@ -234,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

@@ -76,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.
@@ -188,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.
@@ -319,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.
@@ -365,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.
@@ -482,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.
@@ -641,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,10 +5,8 @@ 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`]($m/Location) objects returned by this
-    # endpoint correspond to that `location_id` parameter.
+    # Provides details about all of the seller's locations,
+    # including those with an inactive status.
     # @return [ListLocationsResponse Hash] response from the API call
     def list_locations
       # Prepare query url.
@@ -37,7 +35,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.
@@ -51,7 +59,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
@@ -71,12 +79,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.
@@ -130,7 +138,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/loyalty_api.rb

@@ -20,7 +20,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
@@ -58,7 +58,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
@@ -150,7 +150,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
@@ -195,7 +195,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
@@ -236,7 +236,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
@@ -372,7 +372,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
@@ -413,7 +413,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
@@ -452,7 +452,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
@@ -576,7 +576,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/mobile_authorization_api.rb

@@ -6,9 +6,9 @@ module Square
     end
 
     # Generates code to authorize a mobile application to connect to a Square
-    # card reader
-    # Authorization codes are one-time-use and expire __60 minutes__ after being
-    # issued.
+    # card reader.
+    # Authorization codes are one-time-use codes and expire 60 minutes after
+    # being issued.
     # __Important:__ The `Authorization` header you provide to this endpoint
     # must have the following format:
     # ```
@@ -31,7 +31,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/o_auth_api.rb

@@ -12,11 +12,11 @@ module Square
     # okens).
     # Renews an OAuth access token before it expires.
     # OAuth access tokens besides your application's personal access token
-    # expire after __30 days__.
-    # You can also renew expired tokens within __15 days__ of their expiration.
+    # expire after 30 days.
+    # You can also renew expired tokens within 15 days of their expiration.
     # You cannot renew an access token that has been expired for more than 15
     # days.
-    # Instead, the associated user must re-complete the OAuth flow from the
+    # Instead, the associated user must recomplete the OAuth flow from the
     # beginning.
     # __Important:__ The `Authorization` header for this endpoint must have the
     # following format:
@@ -25,10 +25,10 @@ module Square
     # ```
     # Replace `APPLICATION_SECRET` with the application secret on the
     # Credentials
-    # page in the [developer dashboard](https://developer.squareup.com/apps).
-    # @param [String] client_id Required parameter: Your application ID,
-    # available from the OAuth page for your  application on the Developer
-    # Dashboard.
+    # page in the [Developer Dashboard](https://developer.squareup.com/apps).
+    # @param [String] client_id Required parameter: Your application ID, which
+    # is available in the OAuth page in the [Developer
+    # Dashboard](https://developer.squareup.com/apps).
     # @param [RenewTokenRequest] body Required parameter: An object containing
     # the fields to POST for the request.  See the corresponding object
     # definition for field details.
@@ -51,7 +51,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8',
+        'Content-Type' => 'application/json',
         'Authorization' => authorization
       }
 
@@ -101,7 +101,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8',
+        'Content-Type' => 'application/json',
         'Authorization' => authorization
       }
 
@@ -150,7 +150,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/orders_api.rb

@@ -26,7 +26,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
@@ -62,7 +62,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
@@ -96,7 +96,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,7 +133,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
@@ -183,7 +183,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
@@ -276,7 +276,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
@@ -335,7 +335,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.