square.rb 9.1.0.20210317 → 12.0.0.20210616

data/lib/square/api/gift_cards_api.rb

@@ -0,0 +1,291 @@
+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. You must activate the gift card before
+    # it can be used. 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

data/lib/square/api/inventory_api.rb

@@ -5,10 +5,10 @@ module Square
       super(config, http_call_back: http_call_back)
     end
 
-    # Returns the [InventoryAdjustment](#type-inventoryadjustment) object
+    # Returns the [InventoryAdjustment]($m/InventoryAdjustment) object
     # with the provided `adjustment_id`.
     # @param [String] adjustment_id Required parameter: ID of the
-    # [InventoryAdjustment](#type-inventoryadjustment) to retrieve.
+    # [InventoryAdjustment]($m/InventoryAdjustment) to retrieve.
     # @return [RetrieveInventoryAdjustmentResponse Hash] response from the API call
     def retrieve_inventory_adjustment(adjustment_id:)
       # Prepare query url.
@@ -118,8 +118,8 @@ module Square
     end
 
     # Returns current counts for the provided
-    # [CatalogObject](#type-catalogobject)s at the requested
-    # [Location](#type-location)s.
+    # [CatalogObject]($m/CatalogObject)s at the requested
+    # [Location]($m/Location)s.
     # Results are paginated and sorted in descending order according to their
     # `calculated_at` timestamp (newest first).
     # When `updated_after` is specified, only counts that have changed since
@@ -160,10 +160,10 @@ module Square
       )
     end
 
-    # Returns the [InventoryPhysicalCount](#type-inventoryphysicalcount)
+    # Returns the [InventoryPhysicalCount]($m/InventoryPhysicalCount)
     # object with the provided `physical_count_id`.
     # @param [String] physical_count_id Required parameter: ID of the
-    # [InventoryPhysicalCount](#type-inventoryphysicalcount) to retrieve.
+    # [InventoryPhysicalCount]($m/InventoryPhysicalCount) to retrieve.
     # @return [RetrieveInventoryPhysicalCountResponse Hash] response from the API call
     def retrieve_inventory_physical_count(physical_count_id:)
       # Prepare query url.
@@ -197,14 +197,14 @@ module Square
     end
 
     # Retrieves the current calculated stock count for a given
-    # [CatalogObject](#type-catalogobject) at a given set of
-    # [Location](#type-location)s. Responses are paginated and unsorted.
+    # [CatalogObject]($m/CatalogObject) at a given set of
+    # [Location]($m/Location)s. Responses are paginated and unsorted.
     # For more sophisticated queries, use a batch endpoint.
     # @param [String] catalog_object_id Required parameter: ID of the
-    # [CatalogObject](#type-catalogobject) to retrieve.
+    # [CatalogObject]($m/CatalogObject) to retrieve.
     # @param [String] location_ids Optional parameter: The
-    # [Location](#type-location) IDs to look up as a comma-separated list. An
-    # empty list queries all locations.
+    # [Location]($m/Location) IDs to look up as a comma-separated list. An empty
+    # list queries all locations.
     # @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.  See the
@@ -250,8 +250,8 @@ module Square
     end
 
     # Returns a set of physical counts and inventory adjustments for the
-    # provided [CatalogObject](#type-catalogobject) at the requested
-    # [Location](#type-location)s.
+    # provided [CatalogObject]($m/CatalogObject) at the requested
+    # [Location]($m/Location)s.
     # Results are paginated and sorted in descending order according to their
     # `occurred_at` timestamp (newest first).
     # There are no limits on how far back the caller can page. This endpoint can
@@ -259,10 +259,10 @@ module Square
     # used to display recent changes for a specific item. For more
     # sophisticated queries, use a batch endpoint.
     # @param [String] catalog_object_id Required parameter: ID of the
-    # [CatalogObject](#type-catalogobject) to retrieve.
+    # [CatalogObject]($m/CatalogObject) to retrieve.
     # @param [String] location_ids Optional parameter: The
-    # [Location](#type-location) IDs to look up as a comma-separated list. An
-    # empty list queries all locations.
+    # [Location]($m/Location) IDs to look up as a comma-separated list. An empty
+    # list queries all locations.
     # @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.  See the

data/lib/square/api/invoices_api.rb

@@ -7,7 +7,7 @@ module Square
 
     # Returns a list of invoices for a given location. The response
     # is paginated. If truncated, the response includes a `cursor` that you
-    # use in a subsequent request to fetch the next set of invoices.
+    # use in a subsequent request to retrieve the next set of invoices.
     # @param [String] location_id Required parameter: The ID of the location for
     # which to list invoices.
     # @param [String] cursor Optional parameter: A pagination cursor returned by
@@ -16,7 +16,7 @@ module Square
     # [Pagination](https://developer.squareup.com/docs/working-with-apis/paginat
     # ion).
     # @param [Integer] limit Optional parameter: The maximum number of invoices
-    # to return (200 is the maximum `limit`).  If not provided, the server  uses
+    # to return (200 is the maximum `limit`).  If not provided, the server uses
     # a default limit of 100 invoices.
     # @return [ListInvoicesResponse Hash] response from the API call
     def list_invoices(location_id:,
@@ -54,7 +54,7 @@ module Square
       )
     end
 
-    # Creates a draft [invoice](#type-invoice)
+    # Creates a draft [invoice]($m/Invoice)
     # for an order created using the Orders API.
     # A draft invoice remains in your account and no action is taken.
     # You must publish the invoice before Square can process it (send it to the
@@ -98,7 +98,7 @@ module Square
     # location and
     # optionally one customer.
     # The response is paginated. If truncated, the response includes a `cursor`
-    # that you use in a subsequent request to fetch the next set of invoices.
+    # that you use in a subsequent request to retrieve the next set of invoices.
     # @param [SearchInvoicesRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
@@ -133,15 +133,15 @@ module Square
     end
 
     # Deletes the specified invoice. When an invoice is deleted, the
-    # associated Order status changes to CANCELED. You can only delete a draft
+    # associated order status changes to CANCELED. You can only delete a draft
     # invoice (you cannot delete a published invoice, including one that is
     # scheduled for processing).
     # @param [String] invoice_id Required parameter: The ID of the invoice to
     # delete.
     # @param [Integer] version Optional parameter: The version of the
-    # [invoice](#type-invoice) to delete. If you do not know the version, you
-    # can call [GetInvoice](#endpoint-Invoices-GetInvoice) or 
-    # [ListInvoices](#endpoint-Invoices-ListInvoices).
+    # [invoice]($m/Invoice) to delete. If you do not know the version, you can
+    # call [GetInvoice]($e/Invoices/GetInvoice) or 
+    # [ListInvoices]($e/Invoices/ListInvoices).
     # @return [DeleteInvoiceResponse Hash] response from the API call
     def delete_invoice(invoice_id:,
                        version: nil)
@@ -180,7 +180,7 @@ module Square
     end
 
     # Retrieves an invoice by invoice ID.
-    # @param [String] invoice_id Required parameter: The id of the invoice to
+    # @param [String] invoice_id Required parameter: The ID of the invoice to
     # retrieve.
     # @return [GetInvoiceResponse Hash] response from the API call
     def get_invoice(invoice_id:)
@@ -216,10 +216,10 @@ module Square
 
     # Updates an invoice by modifying fields, clearing fields, or both. For most
     # updates, you can use a sparse
-    # `Invoice` object to add fields or change values, and use the
+    # `Invoice` object to add fields or change values and use the
     # `fields_to_clear` field to specify fields to clear.
     # However, some restrictions apply. For example, you cannot change the
-    # `order_id` or `location_id` field, and you
+    # `order_id` or `location_id` field and you
     # must provide the complete `custom_fields` list to update a custom field.
     # Published invoices have additional restrictions.
     # @param [String] invoice_id Required parameter: The ID of the invoice to
@@ -267,7 +267,7 @@ module Square
     # You cannot cancel an invoice in the `DRAFT` state or in a terminal state:
     # `PAID`, `REFUNDED`, `CANCELED`, or `FAILED`.
     # @param [String] invoice_id Required parameter: The ID of the
-    # [invoice](#type-invoice) to cancel.
+    # [invoice]($m/Invoice) to cancel.
     # @param [CancelInvoiceRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding
     # object definition for field details.
@@ -318,8 +318,8 @@ module Square
     # `UNPAID` if
     # Square emails the invoice or `PARTIALLY_PAID` if Square charge a card on
     # file for a portion of the
-    # invoice amount).
-    # @param [String] invoice_id Required parameter: The id of the invoice to
+    # invoice amount.
+    # @param [String] invoice_id Required parameter: The ID of the invoice to
     # publish.
     # @param [PublishInvoiceRequest] body Required parameter: An object
     # containing the fields to POST for the request.  See the corresponding