square.rb 9.1.0.20210317 → 12.0.0.20210616

data/lib/square/api/customer_groups_api.rb

@@ -7,10 +7,10 @@ module Square
 
     # Retrieves the list of customer groups of a business.
     # @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 the [Pagination
-    # guide](https://developer.squareup.com/docs/working-with-apis/pagination)
-    # for more information.
+    # a previous call to this endpoint. Provide this cursor to retrieve the next
+    # set of results for your original query.  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)
       # Prepare query url.

data/lib/square/api/customer_segments_api.rb

@@ -7,10 +7,10 @@ module Square
 
     # Retrieves the list of customer segments of a business.
     # @param [String] cursor Optional parameter: A pagination cursor returned by
-    # previous calls to __ListCustomerSegments__. Used to retrieve the next set
-    # of query results.  See the [Pagination
-    # guide](https://developer.squareup.com/docs/working-with-apis/pagination)
-    # for more information.
+    # previous calls to `ListCustomerSegments`. This cursor is used to retrieve
+    # the next set of query results.  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)
       # Prepare query url.

data/lib/square/api/customers_api.rb

@@ -13,14 +13,14 @@ module Square
     # profiles can take closer to one minute or longer, especially during
     # network incidents and outages.
     # @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 the [Pagination
-    # guide](https://developer.squareup.com/docs/working-with-apis/pagination)
-    # for more information.
+    # a previous call to this endpoint. Provide this cursor to retrieve the next
+    # set of results for your original query.  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.  Default: `DEFAULT`.
     # @param [SortOrder] sort_order Optional parameter: Indicates whether
-    # Customers should be sorted in ascending (`ASC`) or descending (`DESC`)
+    # customers should be sorted in ascending (`ASC`) or descending (`DESC`)
     # order.  Default: `ASC`.
     # @return [ListCustomersResponse Hash] response from the API call
     def list_customers(cursor: nil,
@@ -58,10 +58,9 @@ module Square
       )
     end
 
-    # Creates a new customer for a business, which can have associated cards on
-    # file.
-    # You must provide __at least one__ of the following values in your request
-    # to this
+    # Creates a new customer for a business.
+    # You must provide at least one of the following values in your request to
+    # this
     # endpoint:
     # - `given_name`
     # - `family_name`
@@ -145,15 +144,27 @@ module Square
       )
     end
 
-    # Deletes a customer from a business, along with any linked cards on file.
-    # When two profiles
-    # are merged into a single profile, that profile is assigned a new
-    # `customer_id`. You must use the
-    # new `customer_id` to delete merged profiles.
+    # 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
+    # tic-concurrency) control. The value must be set to the current version of
+    # the customer profile.
+    # To delete a customer profile that was created by merging existing
+    # profiles, you must use the ID of the newly created profile.
     # @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
+    # to enable [optimistic
+    # concurrency](https://developer.squareup.com/docs/working-with-apis/optimis
+    # tic-concurrency) control.  For more information, see [Delete a customer
+    # profile](https://developer.squareup.com/docs/customers-api/use-the-api/kee
+    # p-records#delete-customer-profile).
     # @return [DeleteCustomerResponse Hash] response from the API call
-    def delete_customer(customer_id:)
+    def delete_customer(customer_id:,
+                        version: nil)
       # Prepare query url.
       _query_builder = config.get_base_uri
       _query_builder << '/v2/customers/{customer_id}'
@@ -161,6 +172,10 @@ module Square
         _query_builder,
         'customer_id' => { 'value' => customer_id, 'encode' => true }
       )
+      _query_builder = APIHelper.append_url_with_query_parameters(
+        _query_builder,
+        'version' => version
+      )
       _query_url = APIHelper.clean_url _query_builder
 
       # Prepare headers.
@@ -219,16 +234,18 @@ module Square
       )
     end
 
-    # Updates the details of an existing customer. When two profiles are merged
-    # into a single profile, that profile is assigned a new `customer_id`. You
-    # must use
-    # the new `customer_id` to update merged profiles.
-    # You cannot edit a customer's cards on file with this endpoint. To make
-    # changes
-    # to a card on file, you must delete the existing card on file with the
-    # [DeleteCustomerCard](#endpoint-Customers-deletecustomercard) endpoint,
-    # then create a new one with the
-    # [CreateCustomerCard](#endpoint-Customers-createcustomercard) endpoint.
+    # Updates a customer profile. To change an attribute, specify the new value.
+    # To remove an attribute, specify the value as an empty string or empty
+    # object.
+    # 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
+    # tic-concurrency) control. The value must be set to the current version of
+    # 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 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
@@ -282,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'
@@ -322,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/devices_api.rb

@@ -9,7 +9,8 @@ module Square
     # @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 [Paginating
-    # results](#paginatingresults) for more information.
+    # results](https://developer.squareup.com/docs/working-with-apis/pagination)
+    # for more information.
     # @param [String] location_id Optional parameter: If specified, only returns
     # DeviceCodes of the specified location. Returns DeviceCodes of all
     # locations if empty.

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,91 +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](https://developer.squareup.com/docs/reference/square/disp
-    # utes-api/submit-evidence).
-    # @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
 
@@ -264,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 }
@@ -325,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 }
@@ -355,14 +279,99 @@ 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
     # using the
-    # [CreateDisputeEvidenceFile](https://developer.squareup.com/docs/reference/
-    # square/disputes-api/create-dispute-evidence-file) and
-    # [CreateDisputeEvidenceText](https://developer.squareup.com/docs/reference/
-    # square/disputes-api/create-dispute-evidence-text) endpoints and
+    # [CreateDisputeEvidenceFile]($e/Disputes/CreateDisputeEvidenceFile) and
+    # [CreateDisputeEvidenceText]($e/Disputes/CreateDisputeEvidenceText)
+    # endpoints and
     # evidence automatically provided by Square, when available.
     # @param [String] dispute_id Required parameter: The ID of the dispute that
     # you want to submit evidence for.

data/lib/square/api/gift_card_activities_api.rb

@@ -0,0 +1,127 @@
+module Square
+  # GiftCardActivitiesApi
+  class GiftCardActivitiesApi < BaseApi
+    def initialize(config, http_call_back: nil)
+      super(config, http_call_back: http_call_back)
+    end
+
+    # Lists gift card activities. By default, you get gift card activities for
+    # all
+    # gift cards in the seller's account. You can optionally specify query
+    # parameters to
+    # filter the list. For example, you can get a list of gift card activities
+    # 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] 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.
+    # @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.
+    # @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.
+    # @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).
+    # @return [ListGiftCardActivitiesResponse Hash] response from the API call
+    def list_gift_card_activities(gift_card_id: nil,
+                                  type: nil,
+                                  location_id: nil,
+                                  begin_time: nil,
+                                  end_time: nil,
+                                  limit: nil,
+                                  cursor: nil,
+                                  sort_order: nil)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/gift-cards/activities'
+      _query_builder = APIHelper.append_url_with_query_parameters(
+        _query_builder,
+        'gift_card_id' => gift_card_id,
+        'type' => type,
+        'location_id' => location_id,
+        'begin_time' => begin_time,
+        'end_time' => end_time,
+        'limit' => limit,
+        'cursor' => cursor,
+        '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
+
+    # Creates a gift card activity. For more information, see
+    # [GiftCardActivity](https://developer.squareup.com/docs/gift-cards/using-gi
+    # ft-cards-api#giftcardactivity) and
+    # [Using activated gift
+    # cards](https://developer.squareup.com/docs/gift-cards/using-gift-cards-api
+    # #using-activated-gift-cards).
+    # @param [CreateGiftCardActivityRequest] body Required parameter: An object
+    # containing the fields to POST for the request.  See the corresponding
+    # object definition for field details.
+    # @return [CreateGiftCardActivityResponse Hash] response from the API call
+    def create_gift_card_activity(body:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/gift-cards/activities'
+      _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
+  end
+end