import type { BaseClientOptions, BaseRequestOptions } from "../../../../BaseClient"; import { type NormalizedClientOptionsWithAuth } from "../../../../BaseClient"; import * as core from "../../../../core"; import type * as Square from "../../../index"; import { ActivitiesClient } from "../resources/activities/client/Client"; export declare namespace GiftCardsClient { type Options = BaseClientOptions; interface RequestOptions extends BaseRequestOptions { } } export declare class GiftCardsClient { protected readonly _options: NormalizedClientOptionsWithAuth; protected _activities: ActivitiesClient | undefined; constructor(options?: GiftCardsClient.Options); get activities(): ActivitiesClient; /** * Lists all gift cards. You can specify optional filters to retrieve * a subset of the gift cards. Results are sorted by `created_at` in ascending order. * * @param {Square.ListGiftCardsRequest} request * @param {GiftCardsClient.RequestOptions} requestOptions - Request-specific configuration. * * @example * await client.giftCards.list({ * type: "type", * state: "state", * limit: 1, * cursor: "cursor", * customerId: "customer_id" * }) */ list(request?: Square.ListGiftCardsRequest, requestOptions?: GiftCardsClient.RequestOptions): Promise>; /** * Creates a digital gift card or registers a physical (plastic) gift card. The resulting gift card * has a `PENDING` state. To activate a gift card so that it can be redeemed for purchases, call * [CreateGiftCardActivity](api-endpoint:GiftCardActivities-CreateGiftCardActivity) and create an `ACTIVATE` * activity with the initial balance. Alternatively, you can use [RefundPayment](api-endpoint:Refunds-RefundPayment) * to refund a payment to the new gift card. * * @param {Square.CreateGiftCardRequest} request * @param {GiftCardsClient.RequestOptions} requestOptions - Request-specific configuration. * * @example * await client.giftCards.create({ * idempotencyKey: "NC9Tm69EjbjtConu", * locationId: "81FN9BNFZTKS4", * giftCard: { * type: "DIGITAL" * } * }) */ create(request: Square.CreateGiftCardRequest, requestOptions?: GiftCardsClient.RequestOptions): core.HttpResponsePromise; private __create; /** * Retrieves a gift card using the gift card account number (GAN). * * @param {Square.GetGiftCardFromGanRequest} request * @param {GiftCardsClient.RequestOptions} requestOptions - Request-specific configuration. * * @example * await client.giftCards.getFromGan({ * gan: "7783320001001635" * }) */ getFromGan(request: Square.GetGiftCardFromGanRequest, requestOptions?: GiftCardsClient.RequestOptions): core.HttpResponsePromise; private __getFromGan; /** * Retrieves a gift card using a secure payment token that represents the gift card. * * @param {Square.GetGiftCardFromNonceRequest} request * @param {GiftCardsClient.RequestOptions} requestOptions - Request-specific configuration. * * @example * await client.giftCards.getFromNonce({ * nonce: "cnon:7783322135245171" * }) */ getFromNonce(request: Square.GetGiftCardFromNonceRequest, requestOptions?: GiftCardsClient.RequestOptions): core.HttpResponsePromise; private __getFromNonce; /** * Links a customer to a gift card, which is also referred to as adding a card on file. * * @param {Square.LinkCustomerToGiftCardRequest} request * @param {GiftCardsClient.RequestOptions} requestOptions - Request-specific configuration. * * @example * await client.giftCards.linkCustomer({ * giftCardId: "gift_card_id", * customerId: "GKY0FZ3V717AH8Q2D821PNT2ZW" * }) */ linkCustomer(request: Square.LinkCustomerToGiftCardRequest, requestOptions?: GiftCardsClient.RequestOptions): core.HttpResponsePromise; private __linkCustomer; /** * Unlinks a customer from a gift card, which is also referred to as removing a card on file. * * @param {Square.UnlinkCustomerFromGiftCardRequest} request * @param {GiftCardsClient.RequestOptions} requestOptions - Request-specific configuration. * * @example * await client.giftCards.unlinkCustomer({ * giftCardId: "gift_card_id", * customerId: "GKY0FZ3V717AH8Q2D821PNT2ZW" * }) */ unlinkCustomer(request: Square.UnlinkCustomerFromGiftCardRequest, requestOptions?: GiftCardsClient.RequestOptions): core.HttpResponsePromise; private __unlinkCustomer; /** * Retrieves a gift card using the gift card ID. * * @param {Square.GetGiftCardsRequest} request * @param {GiftCardsClient.RequestOptions} requestOptions - Request-specific configuration. * * @example * await client.giftCards.get({ * id: "id" * }) */ get(request: Square.GetGiftCardsRequest, requestOptions?: GiftCardsClient.RequestOptions): core.HttpResponsePromise; private __get; }