square.rb 6.3.0.20200826 → 17.1.0.20220120

data/lib/square/api/disputes_api.rb

@@ -5,20 +5,19 @@ module Square
       super(config, http_call_back: http_call_back)
     end
 
-    # Returns a list of disputes associated
-    # with a particular account.
+    # Returns a list of disputes associated with a particular account.
     # @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 the original query. For more information, see
-    # [Paginating](https://developer.squareup.com/docs/basics/api101/pagination)
+    # 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)
     # .
     # @param [DisputeState] states Optional parameter: The dispute states to
     # filter the result. If not specified, the endpoint returns all open
-    # disputes (dispute status is not `INQUIRY_CLOSED`, `WON`, or `LOST`).
+    # disputes (the dispute status is not `INQUIRY_CLOSED`, `WON`, or `LOST`).
     # @param [String] location_id Optional parameter: The ID of the location for
-    # which to return  a list of disputes. If not specified, the endpoint
-    # returns all open disputes (dispute status is not `INQUIRY_CLOSED`, `WON`,
-    # or  `LOST`) associated with all locations.
+    # which to return a list of disputes. If not specified, the endpoint returns
+    # all open disputes (the dispute status is not `INQUIRY_CLOSED`, `WON`, or
+    # `LOST`) associated with all locations.
     # @return [ListDisputesResponse Hash] response from the API call
     def list_disputes(cursor: nil,
                       states: nil,
@@ -50,10 +49,12 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
     end
 
-    # Returns details of a specific dispute.
+    # Returns details about a specific dispute.
     # @param [String] dispute_id Required parameter: The ID of the dispute you
     # want more details about.
     # @return [RetrieveDisputeResponse Hash] response from the API call
@@ -63,7 +64,7 @@ module Square
       _query_builder << '/v2/disputes/{dispute_id}'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'dispute_id' => dispute_id
+        'dispute_id' => { 'value' => dispute_id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -83,20 +84,19 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
     end
 
-    # Accepts loss on a dispute. Square returns
-    # the disputed amount to the cardholder and updates the
-    # dispute state to ACCEPTED.
-    # Square debits the disputed amount from the seller’s Square
-    # account. If the Square account balance does not have
-    # sufficient funds, Square debits the associated bank account.
-    # For an overview of the Disputes API, see
-    # [Overview](https://developer.squareup.com/docs/docs/disputes-api/overview)
-    # .
-    # @param [String] dispute_id Required parameter: ID of the dispute you want
-    # to accept.
+    # Accepts the loss on a dispute. Square returns the disputed amount to the
+    # cardholder and
+    # updates the dispute state to ACCEPTED.
+    # Square debits the disputed amount from the seller’s Square account. If the
+    # Square account
+    # does not have sufficient funds, Square debits the associated bank account.
+    # @param [String] dispute_id Required parameter: The ID of the dispute you
+    # want to accept.
     # @return [AcceptDisputeResponse Hash] response from the API call
     def accept_dispute(dispute_id:)
       # Prepare query url.
@@ -104,7 +104,7 @@ module Square
       _query_builder << '/v2/disputes/{dispute_id}/accept'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'dispute_id' => dispute_id
+        'dispute_id' => { 'value' => dispute_id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -124,19 +124,31 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
     end
 
     # 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'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'dispute_id' => dispute_id
+        'dispute_id' => { 'value' => dispute_id, 'encode' => true }
+      )
+      _query_builder = APIHelper.append_url_with_query_parameters(
+        _query_builder,
+        'cursor' => cursor
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -156,41 +168,64 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _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).
+    # Uploads a file to use as evidence in a dispute challenge. The endpoint
+    # accepts HTTP
+    # multipart/form-data file uploads in HEIC, HEIF, JPEG, PDF, PNG, and TIFF
+    # formats.
     # @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:)
+    # want to upload evidence for.
+    # @param [CreateDisputeEvidenceFileRequest] request Optional parameter:
+    # Defines the parameters for a `CreateDisputeEvidenceFile` request.
+    # @param [File | UploadIO] image_file Optional parameter: Example:
+    # @return [CreateDisputeEvidenceFileResponse Hash] response from the API call
+    def create_dispute_evidence_file(dispute_id:,
+                                     request: nil,
+                                     image_file: nil)
       # Prepare query url.
       _query_builder = config.get_base_uri
-      _query_builder << '/v2/disputes/{dispute_id}/evidence/{evidence_id}'
+      _query_builder << '/v2/disputes/{dispute_id}/evidence-files'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'dispute_id' => dispute_id,
-        'evidence_id' => evidence_id
+        'dispute_id' => { 'value' => dispute_id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
+      if image_file.is_a? FileWrapper
+        image_file_wrapper = image_file.file
+        image_file_content_type = image_file.content_type
+      else
+        image_file_wrapper = image_file
+        image_file_content_type = 'image/jpeg'
+      end
+
       # Prepare headers.
       _headers = {
         'accept' => 'application/json'
       }
 
+      # Prepare form parameters.
+      _parameters = {
+        'request' => Faraday::UploadIO.new(
+          StringIO.new(request.to_json),
+          'application/json'
+        ),
+        'image_file' => Faraday::UploadIO.new(
+          image_file_wrapper,
+          image_file_content_type
+        )
+      }
+      _parameters = APIHelper.form_encode_parameters(_parameters)
+
       # Prepare and execute HttpRequest.
-      _request = config.http_client.delete(
+      _request = config.http_client.post(
         _query_url,
-        headers: _headers
+        headers: _headers,
+        parameters: _parameters
       )
       OAuth2.apply(config, _request)
       _response = execute_request(_request)
@@ -198,39 +233,40 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _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:)
+    # Uploads text to use as evidence for a dispute challenge.
+    # @param [String] dispute_id Required parameter: The ID of the dispute you
+    # want to upload evidence for.
+    # @param [CreateDisputeEvidenceTextRequest] body Required parameter: An
+    # object containing the fields to POST for the request.  See the
+    # corresponding object definition for field details.
+    # @return [CreateDisputeEvidenceTextResponse Hash] response from the API call
+    def create_dispute_evidence_text(dispute_id:,
+                                     body:)
       # Prepare query url.
       _query_builder = config.get_base_uri
-      _query_builder << '/v2/disputes/{dispute_id}/evidence/{evidence_id}'
+      _query_builder << '/v2/disputes/{dispute_id}/evidence-text'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'dispute_id' => dispute_id,
-        'evidence_id' => evidence_id
+        'dispute_id' => { 'value' => dispute_id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
       # Prepare headers.
       _headers = {
-        'accept' => 'application/json'
+        'accept' => 'application/json',
+        'Content-Type' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
-      _request = config.http_client.get(
+      _request = config.http_client.post(
         _query_url,
-        headers: _headers
+        headers: _headers,
+        parameters: body.to_json
       )
       OAuth2.apply(config, _request)
       _response = execute_request(_request)
@@ -238,65 +274,42 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
     end
 
-    # Uploads a file to use as evidence in a dispute challenge. The endpoint
-    # accepts
-    # HTTP multipart/form-data file uploads in HEIC, HEIF, JPEG, PDF, PNG,
-    # and TIFF formats.
-    # For more information, see [Challenge a
-    # Dispute](https://developer.squareup.com/docs/docs/disputes-api/process-dis
-    # putes#challenge-a-dispute).
-    # @param [String] dispute_id Required parameter: ID of the dispute you want
-    # to upload evidence for.
-    # @param [CreateDisputeEvidenceFileRequest] request Optional parameter:
-    # Defines parameters for a CreateDisputeEvidenceFile request.
-    # @param [File | UploadIO] image_file Optional parameter: Example:
-    # @return [CreateDisputeEvidenceFileResponse Hash] response from the API call
-    def create_dispute_evidence_file(dispute_id:,
-                                     request: nil,
-                                     image_file: nil)
+    # 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_file'
+      _query_builder << '/v2/disputes/{dispute_id}/evidence/{evidence_id}'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'dispute_id' => dispute_id
+        'dispute_id' => { 'value' => dispute_id, 'encode' => true },
+        'evidence_id' => { 'value' => evidence_id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
-      if image_file.is_a? FileWrapper
-        image_file_wrapper = image_file.file
-        image_file_content_type = image_file.content_type
-      else
-        image_file_wrapper = image_file
-        image_file_content_type = 'image/jpeg'
-      end
-
       # Prepare headers.
       _headers = {
         'accept' => 'application/json'
       }
 
-      # Prepare form parameters.
-      _parameters = {
-        'request' => Faraday::UploadIO.new(
-          StringIO.new(request.to_json),
-          'application/json'
-        ),
-        'image_file' => Faraday::UploadIO.new(
-          image_file_wrapper,
-          image_file_content_type
-        )
-      }
-      _parameters = APIHelper.form_encode_parameters(_parameters)
-
       # Prepare and execute HttpRequest.
-      _request = config.http_client.post(
+      _request = config.http_client.delete(
         _query_url,
-        headers: _headers,
-        parameters: _parameters
+        headers: _headers
       )
       OAuth2.apply(config, _request)
       _response = execute_request(_request)
@@ -304,42 +317,42 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
     end
 
-    # Uploads text to use as evidence for a dispute challenge. For more
-    # information, see
-    # [Challenge a
-    # Dispute](https://developer.squareup.com/docs/docs/disputes-api/process-dis
-    # putes#challenge-a-dispute).
-    # @param [String] dispute_id Required parameter: The ID of the dispute you
-    # want to upload evidence for.
-    # @param [CreateDisputeEvidenceTextRequest] body Required parameter: An
-    # object containing the fields to POST for the request.  See the
-    # corresponding object definition for field details.
-    # @return [CreateDisputeEvidenceTextResponse Hash] response from the API call
-    def create_dispute_evidence_text(dispute_id:,
-                                     body:)
+    # 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_text'
+      _query_builder << '/v2/disputes/{dispute_id}/evidence/{evidence_id}'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'dispute_id' => dispute_id
+        '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',
-        'content-type' => 'application/json; charset=utf-8'
+        'accept' => 'application/json'
       }
 
       # Prepare and execute HttpRequest.
-      _request = config.http_client.post(
+      _request = config.http_client.get(
         _query_url,
-        headers: _headers,
-        parameters: body.to_json
+        headers: _headers
       )
       OAuth2.apply(config, _request)
       _response = execute_request(_request)
@@ -347,24 +360,21 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _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 evidence automatically provided by Square, when
-    # available. For more information, see
-    # [Challenge a
-    # Dispute](https://developer.squareup.com/docs/docs/disputes-api/process-dis
-    # putes#challenge-a-dispute).
-    # @param [String] dispute_id Required parameter: The ID of the dispute you
-    # want to submit evidence for.
+    # includes evidence uploaded
+    # using the
+    # [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.
     # @return [SubmitEvidenceResponse Hash] response from the API call
     def submit_evidence(dispute_id:)
       # Prepare query url.
@@ -372,7 +382,7 @@ module Square
       _query_builder << '/v2/disputes/{dispute_id}/submit-evidence'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'dispute_id' => dispute_id
+        'dispute_id' => { 'value' => dispute_id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -392,7 +402,9 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
     end
   end
 end

data/lib/square/api/employees_api.rb

@@ -47,7 +47,9 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
     end
 
     # RetrieveEmployee
@@ -61,7 +63,7 @@ module Square
       _query_builder << '/v2/employees/{id}'
       _query_builder = APIHelper.append_url_with_template_parameters(
         _query_builder,
-        'id' => id
+        'id' => { 'value' => id, 'encode' => true }
       )
       _query_url = APIHelper.clean_url _query_builder
 
@@ -81,7 +83,9 @@ module Square
       # Return appropriate response type.
       decoded = APIHelper.json_deserialize(_response.raw_body)
       _errors = APIHelper.map_response(decoded, ['errors'])
-      ApiResponse.new(_response, data: decoded, errors: _errors)
+      ApiResponse.new(
+        _response, data: decoded, errors: _errors
+      )
     end
   end
 end

data/lib/square/api/gift_card_activities_api.rb

@@ -0,0 +1,133 @@
+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 a gift card ID is
+    # provided, the endpoint returns activities related  to the specified gift
+    # card. Otherwise, the endpoint returns all gift card activities for  the
+    # seller.
+    # @param [String] type Optional parameter: If a
+    # [type]($m/GiftCardActivityType) is provided, the endpoint returns gift
+    # card activities of the specified type.  Otherwise, the endpoint returns
+    # all types of gift card activities.
+    # @param [String] location_id Optional parameter: If a location ID is
+    # provided, the endpoint returns gift card activities for the specified
+    # location.  Otherwise, the endpoint returns gift card activities for all
+    # locations.
+    # @param [String] begin_time Optional parameter: The timestamp for the
+    # beginning of the reporting period, in RFC 3339 format. This start time is
+    # inclusive. The default value is the current time minus one year.
+    # @param [String] end_time Optional parameter: The timestamp for the end of
+    # the reporting period, in RFC 3339 format. This end time is inclusive. The
+    # default value is the current time.
+    # @param [Integer] limit Optional parameter: If a limit is provided, the
+    # endpoint returns the specified number  of results (or fewer) per page. The
+    # maximum value is 100. The default value is 50. For more information, see
+    # [Pagination](https://developer.squareup.com/docs/working-with-apis/paginat
+    # ion).
+    # @param [String] cursor Optional parameter: A pagination cursor returned by
+    # a previous call to this endpoint. Provide this cursor to retrieve the next
+    # set of results for the original query. If a cursor is not provided, the
+    # endpoint returns the first page of the results. For more information, see
+    # [Pagination](https://developer.squareup.com/docs/working-with-apis/paginat
+    # ion).
+    # @param [String] sort_order Optional parameter: The order in which the
+    # endpoint returns the activities, based on `created_at`. - `ASC` - Oldest
+    # to newest. - `DESC` - Newest to oldest (default).
+    # @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'
+      }
+
+      # 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