square.rb 10.0.0.202104217 → 13.1.0.20210818

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

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

data/lib/square/api/gift_cards_api.rb

@@ -0,0 +1,292 @@
+module Square
+  # GiftCardsApi
+  class GiftCardsApi < BaseApi
+    def initialize(config, http_call_back: nil)
+      super(config, http_call_back: http_call_back)
+    end
+
+    # 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] 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
+    # [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
+    # @return [ListGiftCardsResponse Hash] response from the API call
+    def list_gift_cards(type: nil,
+                        state: nil,
+                        limit: nil,
+                        cursor: nil,
+                        customer_id: nil)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/gift-cards'
+      _query_builder = APIHelper.append_url_with_query_parameters(
+        _query_builder,
+        'type' => type,
+        'state' => state,
+        'limit' => limit,
+        'cursor' => cursor,
+        'customer_id' => customer_id
+      )
+      _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 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).
+    # @param [CreateGiftCardRequest] body Required parameter: An object
+    # containing the fields to POST for the request.  See the corresponding
+    # object definition for field details.
+    # @return [CreateGiftCardResponse Hash] response from the API call
+    def create_gift_card(body:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/gift-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 a gift card using the gift card account number (GAN).
+    # @param [RetrieveGiftCardFromGANRequest] body Required parameter: An object
+    # containing the fields to POST for the request.  See the corresponding
+    # object definition for field details.
+    # @return [RetrieveGiftCardFromGANResponse Hash] response from the API call
+    def retrieve_gift_card_from_gan(body:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/gift-cards/from-gan'
+      _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 a gift card using a nonce (a secure token) that represents the
+    # gift card.
+    # @param [RetrieveGiftCardFromNonceRequest] body Required parameter: An
+    # object containing the fields to POST for the request.  See the
+    # corresponding object definition for field details.
+    # @return [RetrieveGiftCardFromNonceResponse Hash] response from the API call
+    def retrieve_gift_card_from_nonce(body:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/gift-cards/from-nonce'
+      _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
+
+    # Links a customer to a gift card
+    # @param [String] gift_card_id Required parameter: The ID of the gift card
+    # to link.
+    # @param [LinkCustomerToGiftCardRequest] body Required parameter: An object
+    # containing the fields to POST for the request.  See the corresponding
+    # object definition for field details.
+    # @return [LinkCustomerToGiftCardResponse Hash] response from the API call
+    def link_customer_to_gift_card(gift_card_id:,
+                                   body:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/gift-cards/{gift_card_id}/link-customer'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'gift_card_id' => { 'value' => gift_card_id, 'encode' => true }
+      )
+      _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
+
+    # Unlinks a customer from a gift card
+    # @param [String] gift_card_id Required parameter: Example:
+    # @param [UnlinkCustomerFromGiftCardRequest] body Required parameter: An
+    # object containing the fields to POST for the request.  See the
+    # corresponding object definition for field details.
+    # @return [UnlinkCustomerFromGiftCardResponse Hash] response from the API call
+    def unlink_customer_from_gift_card(gift_card_id:,
+                                       body:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/gift-cards/{gift_card_id}/unlink-customer'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'gift_card_id' => { 'value' => gift_card_id, 'encode' => true }
+      )
+      _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 a gift card using its ID.
+    # @param [String] id Required parameter: The ID of the gift card to
+    # retrieve.
+    # @return [RetrieveGiftCardResponse Hash] response from the API call
+    def retrieve_gift_card(id:)
+      # Prepare query url.
+      _query_builder = config.get_base_uri
+      _query_builder << '/v2/gift-cards/{id}'
+      _query_builder = APIHelper.append_url_with_template_parameters(
+        _query_builder,
+        'id' => { 'value' => 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
+  end
+end