square.rb 11.0.0.20210513 → 12.0.0.20210616

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5bd47b45ea9eca98fd3703e49daddc69b4b2ff2dea6d7badf813f75712ef1a41
-  data.tar.gz: a26991adca5e6f459a2467678cce0f61e244b2a997aa60750ed2d3a17f183aec
+  metadata.gz: 2899ef8f7b608c506ec04abc840c1c80f24109063086e5f756049544919e7d6e
+  data.tar.gz: 5835b5bc55af2f9cd9618dc5d09cdc47b1d197c23cf45d8293c4f59e90521c33
 SHA512:
-  metadata.gz: 4923c144ec01aade0ca6386fef939d257213eac3f55565fcf29f34c9876e032c9ff47004e04d36453b70028d00b04573911c59434654cd500f655b3a718df04b
-  data.tar.gz: 9b2539e8da3c4d0e613c76e27a0ae82c64accac2008e7db8ca324cb48e19cfe663e65f1b86118ba56f133daeaf813e98dad05f1bd75144c198494c07fe61457d
+  metadata.gz: 3352454a34c03eeaebff9db1e805f8c12bf929deaf045c4b0a258caf917c5b4dad010bfd18741881c99057a254890d5f8ef4887f53360430915a3c746b3e7311
+  data.tar.gz: ff8762e1244f9a074599fbb05b2441fbc2f16c715bfc466f8ab3c49b53d88b3664eee9622d9b44e0f8b4c5209b8eeedebaaaf284495bdd620e72f698dfcefab2

data/lib/square.rb

@@ -36,6 +36,7 @@ require_relative 'square/api/v1_transactions_api.rb'
 require_relative 'square/api/apple_pay_api.rb'
 require_relative 'square/api/bank_accounts_api.rb'
 require_relative 'square/api/bookings_api.rb'
+require_relative 'square/api/cards_api.rb'
 require_relative 'square/api/cash_drawers_api.rb'
 require_relative 'square/api/catalog_api.rb'
 require_relative 'square/api/customers_api.rb'
@@ -44,6 +45,8 @@ require_relative 'square/api/customer_segments_api.rb'
 require_relative 'square/api/devices_api.rb'
 require_relative 'square/api/disputes_api.rb'
 require_relative 'square/api/employees_api.rb'
+require_relative 'square/api/gift_cards_api.rb'
+require_relative 'square/api/gift_card_activities_api.rb'
 require_relative 'square/api/inventory_api.rb'
 require_relative 'square/api/invoices_api.rb'
 require_relative 'square/api/labor_api.rb'

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/11.0.0.20210513',
+        'user-agent' => 'Square-Ruby-SDK/12.0.0.20210616',
         'Square-Version' => config.square_version
       }
     end

data/lib/square/api/cards_api.rb

@@ -0,0 +1,170 @@
+module Square
+  # CardsApi
+  class CardsApi < BaseApi
+    def initialize(config, http_call_back: nil)
+      super(config, http_call_back: http_call_back)
+    end
+
+    # Retrieves a list of cards owned by the account making the request.
+    # A max of 25 cards will be returned.
+    # @param [String] cursor Optional parameter: A pagination cursor returned by
+    # a previous call to this endpoint. Provide this to retrieve the next set of
+    # results for your original query.  See
+    # [Pagination](https://developer.squareup.com/docs/basics/api101/pagination)
+    # for more information.
+    # @param [String] customer_id Optional parameter: Limit results to cards
+    # associated with the customer supplied. By default, all cards owned by the
+    # merchant are returned.
+    # @param [Boolean] include_disabled Optional parameter: Includes disabled
+    # cards. By default, all enabled cards owned by the merchant are returned.
+    # @param [String] reference_id Optional parameter: Limit results to cards
+    # associated with the reference_id supplied.
+    # @param [SortOrder] sort_order Optional parameter: Sorts the returned list
+    # by when the card was created with the specified order. This field defaults
+    # to ASC.
+    # @return [ListCardsResponse Hash] response from the API call
+    def list_cards(cursor: nil,
+                   customer_id: nil,
+                   include_disabled: false,
+                   reference_id: nil,
+                   sort_order: nil)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/cards'
+      _query_builder = APIHelper.append_url_with_query_parameters(
+        _query_builder,
+        'cursor' => cursor,
+        'customer_id' => customer_id,
+        'include_disabled' => include_disabled,
+        'reference_id' => reference_id,
+        'sort_order' => sort_order
+      )
+      _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
+
+    # Adds a card on file to an existing merchant.
+    # @param [CreateCardRequest] body Required parameter: An object containing
+    # the fields to POST for the request.  See the corresponding object
+    # definition for field details.
+    # @return [CreateCardResponse Hash] response from the API call
+    def create_card(body:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/cards'
+      _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
+
+    # Retrieves details for a specific Card.
+    # @param [String] card_id Required parameter: Unique ID for the desired
+    # Card.
+    # @return [RetrieveCardResponse Hash] response from the API call
+    def retrieve_card(card_id:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/cards/{card_id}'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'card_id' => { 'value' => card_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
+
+    # Disables the card, preventing any further updates or charges.
+    # Disabling an already disabled card is allowed but has no effect.
+    # @param [String] card_id Required parameter: Unique ID for the desired
+    # Card.
+    # @return [DisableCardResponse Hash] response from the API call
+    def disable_card(card_id:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/cards/{card_id}/disable'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'card_id' => { 'value' => card_id, 'encode' => true }
+      )
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json'
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.post(
+        _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
+  end
+end

data/lib/square/api/catalog_api.rb

@@ -246,10 +246,12 @@ module Square
     # [Pagination](https://developer.squareup.com/docs/basics/api101/pagination)
     # for more information.
     # @param [String] types Optional parameter: An optional case-insensitive,
-    # comma-separated list of object types to retrieve, for example
-    # `ITEM,ITEM_VARIATION,CATEGORY,IMAGE`.  The legal values are taken from the
-    # CatalogObjectType enum: `ITEM`, `ITEM_VARIATION`, `CATEGORY`, `DISCOUNT`,
-    # `TAX`, `MODIFIER`, `MODIFIER_LIST`, or `IMAGE`.
+    # comma-separated list of object types to retrieve.  The valid values are
+    # defined in the [CatalogObjectType]($m/CatalogObjectType) enum, including
+    # `ITEM`, `ITEM_VARIATION`, `CATEGORY`, `DISCOUNT`, `TAX`, `MODIFIER`,
+    # `MODIFIER_LIST`, or `IMAGE`.  If this is unspecified, the operation
+    # returns objects of all the types at the version of the Square API used to
+    # make the request.
     # @param [Long] catalog_version Optional parameter: The specific version of
     # the catalog objects to be included in the response.  This allows you to
     # retrieve historical versions of objects. The specified version value is

data/lib/square/api/customers_api.rb

@@ -58,8 +58,7 @@ module Square
       )
     end
 
-    # Creates a new customer for a business, which can have associated cards on
-    # file.
+    # Creates a new customer for a business.
     # You must provide at least one of the following values in your request to
     # this
     # endpoint:
@@ -145,8 +144,8 @@ module Square
       )
     end
 
-    # Deletes a customer profile from a business, including any linked cards on
-    # file.
+    # Deletes a customer profile from a business. This operation also unlinks
+    # any associated cards on file.
     # As a best practice, you should include the `version` field in the request
     # to enable [optimistic
     # concurrency](https://developer.squareup.com/docs/working-with-apis/optimis
@@ -245,11 +244,8 @@ module Square
     # the customer profile.
     # To update a customer profile that was created by merging existing
     # profiles, you must use the ID of the newly created profile.
-    # You cannot use this endpoint to change cards on file. To change a card on
-    # file, call [DeleteCustomerCard]($e/Customers/DeleteCustomerCard) to delete
-    # the existing card and then call
-    # [CreateCustomerCard]($e/Customers/CreateCustomerCard) to create a new
-    # card.
+    # You cannot use this endpoint to change cards on file. To make changes, use
+    # the [Cards API]($e/Cards) or [Gift Cards API]($e/GiftCards).
     # @param [String] customer_id Required parameter: The ID of the customer to
     # update.
     # @param [UpdateCustomerRequest] body Required parameter: An object
@@ -303,6 +299,7 @@ module Square
     # @return [CreateCustomerCardResponse Hash] response from the API call
     def create_customer_card(customer_id:,
                              body:)
+      warn 'Endpoint create_customer_card in CustomersApi is deprecated'
       # Prepare query url.
       _query_builder = config.get_base_uri
       _query_builder << '/v2/customers/{customer_id}/cards'
@@ -343,6 +340,7 @@ module Square
     # @return [DeleteCustomerCardResponse Hash] response from the API call
     def delete_customer_card(customer_id:,
                              card_id:)
+      warn 'Endpoint delete_customer_card in CustomersApi is deprecated'
       # Prepare query url.
       _query_builder = config.get_base_uri
       _query_builder << '/v2/customers/{customer_id}/cards/{card_id}'

data/lib/square/api/disputes_api.rb

@@ -131,8 +131,14 @@ module Square
 
     # Returns a list of evidence associated with a dispute.
     # @param [String] dispute_id Required parameter: The ID of the dispute.
+    # @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. For more information, see
+    # [Pagination](https://developer.squareup.com/docs/basics/api101/pagination)
+    # .
     # @return [ListDisputeEvidenceResponse Hash] response from the API call
-    def list_dispute_evidence(dispute_id:)
+    def list_dispute_evidence(dispute_id:,
+                              cursor: nil)
       # Prepare query url.
       _query_builder = config.get_base_uri
       _query_builder << '/v2/disputes/{dispute_id}/evidence'
@@ -140,90 +146,9 @@ module Square
         _query_builder,
         'dispute_id' => { 'value' => dispute_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
-
-    # Removes specified evidence from a dispute.
-    # Square does not send the bank any evidence that is removed. Also, you
-    # cannot remove evidence after
-    # submitting it to the bank using
-    # [SubmitEvidence]($e/Disputes/SubmitEvidence).
-    # @param [String] dispute_id Required parameter: The ID of the dispute you
-    # want to remove evidence from.
-    # @param [String] evidence_id Required parameter: The ID of the evidence you
-    # want to remove.
-    # @return [RemoveDisputeEvidenceResponse Hash] response from the API call
-    def remove_dispute_evidence(dispute_id:,
-                                evidence_id:)
-      # Prepare query url.
-      _query_builder = config.get_base_uri
-      _query_builder << '/v2/disputes/{dispute_id}/evidence/{evidence_id}'
-      _query_builder = APIHelper.append_url_with_template_parameters(
-        _query_builder,
-        'dispute_id' => { 'value' => dispute_id, 'encode' => true },
-        'evidence_id' => { 'value' => evidence_id, 'encode' => true }
-      )
-      _query_url = APIHelper.clean_url _query_builder
-
-      # Prepare headers.
-      _headers = {
-        'accept' => 'application/json'
-      }
-
-      # Prepare and execute HttpRequest.
-      _request = config.http_client.delete(
-        _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 specific evidence metadata associated with a specific dispute.
-    # You must maintain a copy of the evidence you upload if you want to
-    # reference it later. You cannot
-    # download the evidence after you upload it.
-    # @param [String] dispute_id Required parameter: The ID of the dispute that
-    # you want to retrieve evidence from.
-    # @param [String] evidence_id Required parameter: The ID of the evidence to
-    # retrieve.
-    # @return [RetrieveDisputeEvidenceResponse Hash] response from the API call
-    def retrieve_dispute_evidence(dispute_id:,
-                                  evidence_id:)
-      # Prepare query url.
-      _query_builder = config.get_base_uri
-      _query_builder << '/v2/disputes/{dispute_id}/evidence/{evidence_id}'
-      _query_builder = APIHelper.append_url_with_template_parameters(
+      _query_builder = APIHelper.append_url_with_query_parameters(
         _query_builder,
-        'dispute_id' => { 'value' => dispute_id, 'encode' => true },
-        'evidence_id' => { 'value' => evidence_id, 'encode' => true }
+        'cursor' => cursor
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -263,7 +188,7 @@ module Square
                                      image_file: nil)
       # Prepare query url.
       _query_builder = config.get_base_uri
-      _query_builder << '/v2/disputes/{dispute_id}/evidence_file'
+      _query_builder << '/v2/disputes/{dispute_id}/evidence-files'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
         'dispute_id' => { 'value' => dispute_id, 'encode' => true }
@@ -324,7 +249,7 @@ module Square
                                      body:)
       # Prepare query url.
       _query_builder = config.get_base_uri
-      _query_builder << '/v2/disputes/{dispute_id}/evidence_text'
+      _query_builder << '/v2/disputes/{dispute_id}/evidence-text'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
         'dispute_id' => { 'value' => dispute_id, 'encode' => true }
@@ -354,6 +279,92 @@ module Square
       )
     end
 
+    # Removes specified evidence from a dispute.
+    # Square does not send the bank any evidence that is removed. Also, you
+    # cannot remove evidence after
+    # submitting it to the bank using
+    # [SubmitEvidence]($e/Disputes/SubmitEvidence).
+    # @param [String] dispute_id Required parameter: The ID of the dispute you
+    # want to remove evidence from.
+    # @param [String] evidence_id Required parameter: The ID of the evidence you
+    # want to remove.
+    # @return [DeleteDisputeEvidenceResponse Hash] response from the API call
+    def delete_dispute_evidence(dispute_id:,
+                                evidence_id:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/disputes/{dispute_id}/evidence/{evidence_id}'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'dispute_id' => { 'value' => dispute_id, 'encode' => true },
+        'evidence_id' => { 'value' => evidence_id, 'encode' => true }
+      )
+      _query_url = APIHelper.clean_url _query_builder
+
+      # Prepare headers.
+      _headers = {
+        'accept' => 'application/json'
+      }
+
+      # Prepare and execute HttpRequest.
+      _request = config.http_client.delete(
+        _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 evidence metadata specified by the evidence ID in the request
+    # URL path
+    # You must maintain a copy of the evidence you upload if you want to
+    # reference it later. You cannot
+    # download the evidence after you upload it.
+    # @param [String] dispute_id Required parameter: The ID of the dispute that
+    # you want to retrieve evidence from.
+    # @param [String] evidence_id Required parameter: The ID of the evidence to
+    # retrieve.
+    # @return [RetrieveDisputeEvidenceResponse Hash] response from the API call
+    def retrieve_dispute_evidence(dispute_id:,
+                                  evidence_id:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/disputes/{dispute_id}/evidence/{evidence_id}'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'dispute_id' => { 'value' => dispute_id, 'encode' => true },
+        'evidence_id' => { 'value' => evidence_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
+
     # Submits evidence to the cardholder's bank.
     # Before submitting evidence, Square compiles all available evidence. This
     # includes evidence uploaded