square.rb 15.0.0.20211020 → 16.0.0.20211117

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 25322287d3387bc053e23f58c5a3b74476789df2145f9648f46b330517aa7574
-  data.tar.gz: a5476f517732ce5df169b402fded9909cefa155e02c90d9af5996e4dc087a887
+  metadata.gz: 25ab6d01177792b1eb326af1a782a12ab26eff2678b44666aac14954907740e2
+  data.tar.gz: 1ba81bfd71af7fd3124015de59166e33401f0e230301d4ea45e6c70438380741
 SHA512:
-  metadata.gz: 2d30c67ff2493a1dded81c4078d3549c0c195f092f9826735cd1f98bb6749153bd45d6614419f95f6d6fb32ed505459abc11ab0508b3fa51f0ad089f8a0cce51
-  data.tar.gz: 2b4a9e0bdb771a3658ec3a46b9838421c154ff1b280da9d27e589111dbb010c2d3c5672ae38d5b22e52ae26f864ae6d8cd76e53effc65e65fdefafcf0b949aa4
+  metadata.gz: c0fa97ef6d70db8247d6a14cb946a942f9327faa37e881ce8628cd8f68e38bb6c91238cf10419dc915597701b69c73ecb0f1813d45be4d6f37eaa837c1646364
+  data.tar.gz: a9337cd596b733099e84765048134f4edc183f548ac6638da50257bfb0d3b0529271d17c509a1f9b34342abe9e7184d56ec4fe1f292ea1fa2ad36036228384d1

data/README.md

@@ -349,4 +349,4 @@ You can also use the Square API to create applications or services that work wit
 [Snippets]: doc/api/snippets.md
 [Cards]: doc/api/cards.md
 [Gift Cards]: doc/api/gift-cards.md
-[Gift Card Activities]: doc/api/gift-card-activities.md
+[Gift Card Activities]: doc/api/gift-card-activities.md

data/lib/square/api/apple_pay_api.rb

@@ -30,7 +30,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/base_api.rb

@@ -8,7 +8,7 @@ module Square
       @http_call_back = http_call_back
 
       @global_headers = {
-        'user-agent' => 'Square-Ruby-SDK/15.0.0.20211020',
+        'user-agent' => 'Square-Ruby-SDK/16.0.0.20211117',
         'Square-Version' => config.square_version
       }
     end

data/lib/square/api/bookings_api.rb

@@ -5,6 +5,66 @@ module Square
       super(config, http_call_back: http_call_back)
     end
 
+    # Retrieve a collection of bookings.
+    # @param [Integer] limit Optional parameter: The maximum number of results
+    # per page to return in a paged response.
+    # @param [String] cursor Optional parameter: The pagination cursor from the
+    # preceding response to return the next page of the results. Do not set this
+    # when retrieving the first page of the results.
+    # @param [String] team_member_id Optional parameter: The team member for
+    # whom to retrieve bookings. If this is not set, bookings of all members are
+    # retrieved.
+    # @param [String] location_id Optional parameter: The location for which to
+    # retrieve bookings. If this is not set, all locations' bookings are
+    # retrieved.
+    # @param [String] start_at_min Optional parameter: The RFC 3339 timestamp
+    # specifying the earliest of the start time. If this is not set, the current
+    # time is used.
+    # @param [String] start_at_max Optional parameter: The RFC 3339 timestamp
+    # specifying the latest of the start time. If this is not set, the time of
+    # 31 days after `start_at_min` is used.
+    # @return [ListBookingsResponse Hash] response from the API call
+    def list_bookings(limit: nil,
+                      cursor: nil,
+                      team_member_id: nil,
+                      location_id: nil,
+                      start_at_min: nil,
+                      start_at_max: nil)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/bookings'
+      _query_builder = APIHelper.append_url_with_query_parameters(
+        _query_builder,
+        'limit' => limit,
+        'cursor' => cursor,
+        'team_member_id' => team_member_id,
+        'location_id' => location_id,
+        'start_at_min' => start_at_min,
+        'start_at_max' => start_at_max
+      )
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json'
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.get(
+        _query_url,
+        headers: _headers
+      )
+      OAuth2.apply(config, _request)
+      _response = execute_request(_request)
+
+      # Return appropriate response type.
+      decoded = APIHelper.json_deserialize(_response.raw_body)
+      _errors = APIHelper.map_response(decoded, ['errors'])
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
+    end
+
     # Creates a booking.
     # @param [CreateBookingRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
@@ -19,7 +79,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
@@ -53,7 +113,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 +302,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
@@ -283,7 +343,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/cards_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.

data/lib/square/api/catalog_api.rb

@@ -29,7 +29,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
@@ -68,7 +68,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
@@ -115,7 +115,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
@@ -307,7 +307,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
@@ -462,7 +462,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
@@ -512,7 +512,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
@@ -548,7 +548,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
@@ -584,7 +584,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/checkout_api.rb

@@ -28,7 +28,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/customer_groups_api.rb

@@ -66,7 +66,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
@@ -177,7 +177,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/customers_api.rb

@@ -88,7 +88,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
@@ -132,7 +132,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
@@ -274,7 +274,7 @@ module Square
       # Prepare headers.
       _headers = {
         'accept' => 'application/json',
-        'content-type' => 'application/json; charset=utf-8'
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
@@ -320,7 +320,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/devices_api.rb

@@ -74,7 +74,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/disputes_api.rb

@@ -259,7 +259,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_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.