square.rb 12.0.0.20210616 → 14.1.0.20210915

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2899ef8f7b608c506ec04abc840c1c80f24109063086e5f756049544919e7d6e
-  data.tar.gz: 5835b5bc55af2f9cd9618dc5d09cdc47b1d197c23cf45d8293c4f59e90521c33
+  metadata.gz: cb09b4404e4f7f5cb0923e135ada308b9a9c3482106b0ab8cc2e80eee63f8de0
+  data.tar.gz: fc7d73e6a5d955857fe4bfb4341a75cdd80764f3cced0e19afbbb37cdca4d9bb
 SHA512:
-  metadata.gz: 3352454a34c03eeaebff9db1e805f8c12bf929deaf045c4b0a258caf917c5b4dad010bfd18741881c99057a254890d5f8ef4887f53360430915a3c746b3e7311
-  data.tar.gz: ff8762e1244f9a074599fbb05b2441fbc2f16c715bfc466f8ab3c49b53d88b3664eee9622d9b44e0f8b4c5209b8eeedebaaaf284495bdd620e72f698dfcefab2
+  metadata.gz: fcf0ff7ca1313121f98083f32cdf8201c30be1814a7f7f6aac89c09e752e129a92ba1f5117f9049559d835846a3e49abfc1d83c906a59c362b8fd05e2c31fbf6
+  data.tar.gz: 2870c75eef04c8798e3699c17a4e88296bfe144400b81c7bf4463c0d3bcface04ef151cae4a0b0349266890d16485a4257d5aa4756d4985684dceb789021b0eb

data/README.md

@@ -8,6 +8,10 @@
 
 Use this gem to integrate Square payments into your app and grow your business with Square APIs including Catalog, Customers, Employees, Inventory, Labor, Locations, and Orders.
 
+## Requirements
+
+We support Ruby 2.5.x, 2.6.x, and 2.7.x.
+
 ## Installation
 
 Install the gem from the command line:
@@ -33,6 +37,9 @@ gem 'square.rb'
 * [Disputes]
 * [Checkout]
 * [Apple Pay]
+* [Cards]
+
+### Terminal
 * [Terminal]
 
 ### Orders
@@ -56,6 +63,10 @@ gem 'square.rb'
 ### Loyalty
 * [Loyalty]
 
+### Gift Cards
+* [Gift Cards]
+* [Gift Card Activities]
+
 ### Bookings
 * [Bookings]
 
@@ -63,12 +74,11 @@ gem 'square.rb'
 * [Merchants]
 * [Locations]
 * [Devices]
+* [Cash Drawers]
 
 ### Team
 * [Team]
-* [Employees]
 * [Labor]
-* [Cash Drawers]
 
 ### Financials
 * [Bank Accounts]
@@ -82,6 +92,7 @@ gem 'square.rb'
 * [OAuth]
 
 ### Deprecated APIs
+* [Employees]
 * [V1 Employees]
 * [V1 Transactions]
 * [V1 Items]
@@ -333,3 +344,6 @@ You can also use the Square API to create applications or services that work wit
 [Transactions]: doc/api/transactions.md
 [Sites]: doc/api/sites.md
 [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

data/lib/square/api/base_api.rb

@@ -8,21 +8,19 @@ module Square
       @http_call_back = http_call_back
 
       @global_headers = {
-        'user-agent' => 'Square-Ruby-SDK/12.0.0.20210616',
+        'user-agent' => 'Square-Ruby-SDK/14.1.0.20210915',
         'Square-Version' => config.square_version
       }
     end
 
     def validate_parameters(args)
       args.each do |_name, value|
-        if value.nil?
-          raise ArgumentError, "Required parameter #{_name} cannot be nil."
-        end
+        raise ArgumentError, "Required parameter #{_name} cannot be nil." if value.nil?
       end
     end
 
     def execute_request(request, binary: false)
-      @http_call_back.on_before_request(request) if @http_call_back
+      @http_call_back&.on_before_request(request)
 
       APIHelper.clean_hash(request.headers)
       request.headers.merge!(@global_headers)
@@ -35,7 +33,7 @@ module Square
                  else
                    config.http_client.execute_as_string(request)
                  end
-      @http_call_back.on_after_response(response) if @http_call_back
+      @http_call_back&.on_after_response(response)
 
       response
     end

data/lib/square/api/catalog_api.rb

@@ -435,7 +435,7 @@ module Square
     # Searches for [CatalogObject]($m/CatalogObject) of any type by matching
     # supported search attribute values,
     # excluding custom attribute values on items or item variations, against one
-    # or more of the specified query expressions.
+    # or more of the specified query filters.
     # This (`SearchCatalogObjects`) endpoint differs from the
     # [SearchCatalogItems]($e/Catalog/SearchCatalogItems)
     # endpoint in the following aspects:
@@ -485,7 +485,7 @@ module Square
     # Searches for catalog items or item variations by matching supported search
     # attribute values, including
     # custom attribute values, against one or more of the specified query
-    # expressions.
+    # filters.
     # This (`SearchCatalogItems`) endpoint differs from the
     # [SearchCatalogObjects]($e/Catalog/SearchCatalogObjects)
     # endpoint in the following aspects:

data/lib/square/api/customer_groups_api.rb

@@ -11,14 +11,22 @@ module Square
     # set of results for your original query.  For more information, see
     # [Pagination](https://developer.squareup.com/docs/working-with-apis/paginat
     # ion).
+    # @param [Integer] limit Optional parameter: The maximum number of results
+    # to return in a single page. This limit is advisory. The response might
+    # contain more or fewer results.  The limit is ignored if it is less than 1
+    # or greater than 50. The default value is 50.  For more information, see
+    # [Pagination](https://developer.squareup.com/docs/working-with-apis/paginat
+    # ion).
     # @return [ListCustomerGroupsResponse Hash] response from the API call
-    def list_customer_groups(cursor: nil)
+    def list_customer_groups(cursor: nil,
+                             limit: nil)
       # Prepare query url.
       _query_builder = config.get_base_uri
       _query_builder << '/v2/customers/groups'
       _query_builder = APIHelper.append_url_with_query_parameters(
         _query_builder,
-        'cursor' => cursor
+        'cursor' => cursor,
+        'limit' => limit
       )
       _query_url = APIHelper.clean_url _query_builder
 

data/lib/square/api/customer_segments_api.rb

@@ -11,14 +11,22 @@ module Square
     # the next set of query results.  For more information, see
     # [Pagination](https://developer.squareup.com/docs/working-with-apis/paginat
     # ion).
+    # @param [Integer] limit Optional parameter: The maximum number of results
+    # to return in a single page. This limit is advisory. The response might
+    # contain more or fewer results.  The limit is ignored if it is less than 1
+    # or greater than 50. The default value is 50.  For more information, see
+    # [Pagination](https://developer.squareup.com/docs/working-with-apis/paginat
+    # ion).
     # @return [ListCustomerSegmentsResponse Hash] response from the API call
-    def list_customer_segments(cursor: nil)
+    def list_customer_segments(cursor: nil,
+                               limit: nil)
       # Prepare query url.
       _query_builder = config.get_base_uri
       _query_builder << '/v2/customers/segments'
       _query_builder = APIHelper.append_url_with_query_parameters(
         _query_builder,
-        'cursor' => cursor
+        'cursor' => cursor,
+        'limit' => limit
       )
       _query_url = APIHelper.clean_url _query_builder
 

data/lib/square/api/customers_api.rb

@@ -17,13 +17,20 @@ module Square
     # set of results for your original query.  For more information, see
     # [Pagination](https://developer.squareup.com/docs/working-with-apis/paginat
     # ion).
+    # @param [Integer] limit Optional parameter: The maximum number of results
+    # to return in a single page. This limit is advisory. The response might
+    # contain more or fewer results.  The limit is ignored if it is less than 1
+    # or greater than 100. The default value is 100.  For more information, see
+    # [Pagination](https://developer.squareup.com/docs/working-with-apis/paginat
+    # ion).
     # @param [CustomerSortField] sort_field Optional parameter: Indicates how
-    # customers should be sorted.  Default: `DEFAULT`.
+    # customers should be sorted.  The default value is `DEFAULT`.
     # @param [SortOrder] sort_order Optional parameter: Indicates whether
     # customers should be sorted in ascending (`ASC`) or descending (`DESC`)
-    # order.  Default: `ASC`.
+    # order.  The default value is `ASC`.
     # @return [ListCustomersResponse Hash] response from the API call
     def list_customers(cursor: nil,
+                       limit: nil,
                        sort_field: nil,
                        sort_order: nil)
       # Prepare query url.
@@ -32,6 +39,7 @@ module Square
       _query_builder = APIHelper.append_url_with_query_parameters(
         _query_builder,
         'cursor' => cursor,
+        'limit' => limit,
         'sort_field' => sort_field,
         'sort_order' => sort_order
       )
@@ -156,7 +164,7 @@ module Square
     # @param [String] customer_id Required parameter: The ID of the customer to
     # delete.
     # @param [Long] version Optional parameter: The current version of the
-    # customer profile.   As a best practice, you should include this parameter
+    # customer profile.  As a best practice, you should include this parameter
     # to enable [optimistic
     # concurrency](https://developer.squareup.com/docs/working-with-apis/optimis
     # tic-concurrency) control.  For more information, see [Delete a customer

data/lib/square/api/gift_cards_api.rb

@@ -65,8 +65,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).

data/lib/square/api/inventory_api.rb

@@ -5,6 +5,46 @@ module Square
       super(config, http_call_back: http_call_back)
     end
 
+    # Deprecated version of
+    # [RetrieveInventoryAdjustment]($e/Inventory/RetrieveInventoryAdjustment)
+    # after the endpoint URL
+    # is updated to conform to the standard convention.
+    # @param [String] adjustment_id Required parameter: ID of the
+    # [InventoryAdjustment]($m/InventoryAdjustment) to retrieve.
+    # @return [RetrieveInventoryAdjustmentResponse Hash] response from the API call
+    def deprecated_retrieve_inventory_adjustment(adjustment_id:)
+      warn 'Endpoint deprecated_retrieve_inventory_adjustment in InventoryApi '\
+           'is deprecated'
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/inventory/adjustment/{adjustment_id}'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'adjustment_id' => { 'value' => adjustment_id, 'encode' => true }
+      )
+      _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
+
     # Returns the [InventoryAdjustment]($m/InventoryAdjustment) object
     # with the provided `adjustment_id`.
     # @param [String] adjustment_id Required parameter: ID of the
@@ -13,7 +53,7 @@ module Square
     def retrieve_inventory_adjustment(adjustment_id:)
       # Prepare query url.
       _query_builder = config.get_base_uri
-      _query_builder << '/v2/inventory/adjustment/{adjustment_id}'
+      _query_builder << '/v2/inventory/adjustments/{adjustment_id}'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
         'adjustment_id' => { 'value' => adjustment_id, 'encode' => true }
@@ -41,6 +81,123 @@ module Square
       )
     end
 
+    # Deprecated version of
+    # [BatchChangeInventory]($e/Inventory/BatchChangeInventory) after the
+    # endpoint URL
+    # is updated to conform to the standard convention.
+    # @param [BatchChangeInventoryRequest] body Required parameter: An object
+    # containing the fields to POST for the request.  See the corresponding
+    # object definition for field details.
+    # @return [BatchChangeInventoryResponse Hash] response from the API call
+    def deprecated_batch_change_inventory(body:)
+      warn 'Endpoint deprecated_batch_change_inventory in InventoryApi is depr'\
+           'ecated'
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/inventory/batch-change'
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json',
+        'content-type' => 'application/json; charset=utf-8'
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.post(
+        _query_url,
+        headers: _headers,
+        parameters: body.to_json
+      )
+      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
+
+    # Deprecated version of
+    # [BatchRetrieveInventoryChanges]($e/Inventory/BatchRetrieveInventoryChanges
+    # ) after the endpoint URL
+    # is updated to conform to the standard convention.
+    # @param [BatchRetrieveInventoryChangesRequest] body Required parameter: An
+    # object containing the fields to POST for the request.  See the
+    # corresponding object definition for field details.
+    # @return [BatchRetrieveInventoryChangesResponse Hash] response from the API call
+    def deprecated_batch_retrieve_inventory_changes(body:)
+      warn 'Endpoint deprecated_batch_retrieve_inventory_changes in InventoryA'\
+           'pi is deprecated'
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/inventory/batch-retrieve-changes'
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json',
+        'content-type' => 'application/json; charset=utf-8'
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.post(
+        _query_url,
+        headers: _headers,
+        parameters: body.to_json
+      )
+      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
+
+    # Deprecated version of
+    # [BatchRetrieveInventoryCounts]($e/Inventory/BatchRetrieveInventoryCounts)
+    # after the endpoint URL
+    # is updated to conform to the standard convention.
+    # @param [BatchRetrieveInventoryCountsRequest] body Required parameter: An
+    # object containing the fields to POST for the request.  See the
+    # corresponding object definition for field details.
+    # @return [BatchRetrieveInventoryCountsResponse Hash] response from the API call
+    def deprecated_batch_retrieve_inventory_counts(body:)
+      warn 'Endpoint deprecated_batch_retrieve_inventory_counts in InventoryAp'\
+           'i is deprecated'
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/inventory/batch-retrieve-counts'
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json',
+        'content-type' => 'application/json; charset=utf-8'
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.post(
+        _query_url,
+        headers: _headers,
+        parameters: body.to_json
+      )
+      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
+
     # Applies adjustments and counts to the provided item quantities.
     # On success: returns the current calculated counts for all objects
     # referenced in the request.
@@ -52,7 +209,7 @@ module Square
     def batch_change_inventory(body:)
       # Prepare query url.
       _query_builder = config.get_base_uri
-      _query_builder << '/v2/inventory/batch-change'
+      _query_builder << '/v2/inventory/changes/batch-create'
       _query_url = APIHelper.clean_url _query_builder
 
       # Prepare headers.
@@ -91,7 +248,7 @@ module Square
     def batch_retrieve_inventory_changes(body:)
       # Prepare query url.
       _query_builder = config.get_base_uri
-      _query_builder << '/v2/inventory/batch-retrieve-changes'
+      _query_builder << '/v2/inventory/changes/batch-retrieve'
       _query_url = APIHelper.clean_url _query_builder
 
       # Prepare headers.
@@ -134,7 +291,7 @@ module Square
     def batch_retrieve_inventory_counts(body:)
       # Prepare query url.
       _query_builder = config.get_base_uri
-      _query_builder << '/v2/inventory/batch-retrieve-counts'
+      _query_builder << '/v2/inventory/counts/batch-retrieve'
       _query_url = APIHelper.clean_url _query_builder
 
       # Prepare headers.
@@ -160,6 +317,46 @@ module Square
       )
     end
 
+    # Deprecated version of
+    # [RetrieveInventoryPhysicalCount]($e/Inventory/RetrieveInventoryPhysicalCou
+    # nt) after the endpoint URL
+    # is updated to conform to the standard convention.
+    # @param [String] physical_count_id Required parameter: ID of the
+    # [InventoryPhysicalCount]($m/InventoryPhysicalCount) to retrieve.
+    # @return [RetrieveInventoryPhysicalCountResponse Hash] response from the API call
+    def deprecated_retrieve_inventory_physical_count(physical_count_id:)
+      warn 'Endpoint deprecated_retrieve_inventory_physical_count in Inventory'\
+           'Api is deprecated'
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/inventory/physical-count/{physical_count_id}'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'physical_count_id' => { 'value' => physical_count_id, 'encode' => true }
+      )
+      _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
+
     # Returns the [InventoryPhysicalCount]($m/InventoryPhysicalCount)
     # object with the provided `physical_count_id`.
     # @param [String] physical_count_id Required parameter: ID of the
@@ -168,7 +365,7 @@ module Square
     def retrieve_inventory_physical_count(physical_count_id:)
       # Prepare query url.
       _query_builder = config.get_base_uri
-      _query_builder << '/v2/inventory/physical-count/{physical_count_id}'
+      _query_builder << '/v2/inventory/physical-counts/{physical_count_id}'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
         'physical_count_id' => { 'value' => physical_count_id, 'encode' => true }
@@ -196,6 +393,42 @@ module Square
       )
     end
 
+    # Returns the [InventoryTransfer]($m/InventoryTransfer) object
+    # with the provided `transfer_id`.
+    # @param [String] transfer_id Required parameter: ID of the
+    # [InventoryTransfer]($m/InventoryTransfer) to retrieve.
+    # @return [RetrieveInventoryTransferResponse Hash] response from the API call
+    def retrieve_inventory_transfer(transfer_id:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/inventory/transfers/{transfer_id}'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'transfer_id' => { 'value' => transfer_id, 'encode' => true }
+      )
+      _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
+
     # Retrieves the current calculated stock count for a given
     # [CatalogObject]($m/CatalogObject) at a given set of
     # [Location]($m/Location)s. Responses are paginated and unsorted.
@@ -252,6 +485,11 @@ module Square
     # Returns a set of physical counts and inventory adjustments for the
     # provided [CatalogObject]($m/CatalogObject) at the requested
     # [Location]($m/Location)s.
+    # You can achieve the same result by calling
+    # [BatchRetrieveInventoryChanges]($e/Inventory/BatchRetrieveInventoryChanges
+    # )
+    # and having the `catalog_object_ids` list contain a single element of the
+    # `CatalogObject` ID.
     # Results are paginated and sorted in descending order according to their
     # `occurred_at` timestamp (newest first).
     # There are no limits on how far back the caller can page. This endpoint can
@@ -272,6 +510,7 @@ module Square
     def retrieve_inventory_changes(catalog_object_id:,
                                    location_ids: nil,
                                    cursor: nil)
+      warn 'Endpoint retrieve_inventory_changes in InventoryApi is deprecated'
       # Prepare query url.
       _query_builder = config.get_base_uri
       _query_builder << '/v2/inventory/{catalog_object_id}/changes'