@sixtyninecommerce/admin 0.10.0 → 0.12.0

package/dist/stored-value/index.d.ts

@@ -20,7 +20,11 @@ export interface StoredValueAccount {
     expiresAt: string | null;
     /** The last day (`YYYY-MM-DD`, store zone) the value is valid through; refund lots never expire. */
     expiresOn: string | null;
-    status: 'active' | 'blocked';
+    /**
+     * `voided`: a gift card a void blocked for good (`giftCards.void`); it is never blocked or
+     * unblocked again. Treat any other value this version does not know as not spendable.
+     */
+    status: 'active' | 'blocked' | 'voided';
     balance: number;
     /** What can be spent now: the balance less expired value the daily job has not booked yet. */
     spendable: number;
@@ -29,7 +33,12 @@ export interface StoredValueEntry {
     id: string;
     createdAt: string;
     occurredAt: string;
-    entryType: 'issue' | 'redeem' | 'reversal' | 'adjustment' | 'expiry' | 'forfeit';
+    /**
+     * `payout`: store credit moved from an order, paid back to the payment it came from
+     * (`payOut`); a payout whose refund did not happen comes back as a `reversal` with
+     * `sourceType: 'payout_refund'`. Treat a value you do not know as a movement you do not report.
+     */
+    entryType: 'issue' | 'redeem' | 'reversal' | 'adjustment' | 'expiry' | 'forfeit' | 'payout';
     /** Signed: credits positive, debits negative. */
     amount: number;
     balanceAfter: number;
@@ -44,6 +53,31 @@ export interface StoredValueEntry {
     onBehalfOfRef: string | null;
     deviceRef: string | null;
     reason: string | null;
+    /**
+     * Store credit moved from an order (`sourceType: 'order_credit'`): the decision that moved it,
+     * `return`, `correction`, `order_edit`, `surcharge`, `fulfillment_cancel`, `cancel`,
+     * `overpayment` or `till_return` (a value you do not know is another decision). Null otherwise,
+     * and on an engine before incentives sprint 8.
+     */
+    origin: string | null;
+    /**
+     * The record of that decision, when it has one: the return's id (`return`), the credit note's
+     * (`correction`), the surcharge's, the fulfillment's, or the till return's. Null otherwise.
+     */
+    originRef: string | null;
+    /**
+     * The lot (an `order_credit` entry's id) a `payout` pays back, or its `payout_refund` restore
+     * gives back to. Null otherwise, and on an engine before payouts.
+     */
+    lotId: string | null;
+    /**
+     * Store credit moved from an order: whether the customer expressly agreed to store credit
+     * instead of a refund to their payment (EU consumer law), as the staff member who chose it
+     * recorded, a till return's included (`pos.returns.create`'s `customerAgreed`). Null when nobody
+     * said (the door was not told, a till that did not ask, a move recorded before the field), on
+     * every other entry, and on an engine before it. A record, never a condition.
+     */
+    customerAgreed: boolean | null;
 }
 export interface StoredValueStatement {
     account: StoredValueAccount;
@@ -52,17 +86,34 @@ export interface StoredValueStatement {
     entries: StoredValueEntry[];
     totalItems: number;
 }
-/** `outstanding = issued − redeemed + reversed + adjusted − expired − forfeited`. */
+/**
+ * `outstanding = issued − redeemed + reversed + adjusted − expired − forfeited − paidOut`, where
+ * `paidOut` is store credit paid back to money (`payOut`), net of the payouts whose refund did not
+ * happen. On an engine before incentives sprint 8 the split of `issued` and `paidOut` are null
+ * (it serves neither; nothing was paid out there).
+ */
 export interface StoredValueLiability {
     unit: string;
     kind: string;
     accounts: number;
     issued: number;
+    /** Of `issued`: created by staff without payment (goodwill, a staff gift card). */
+    issuedGoodwill: number | null;
+    /** Of `issued`: an order's money moved to store credit instead of a refund. */
+    issuedFromOrders: number | null;
+    /** Of `issued`: store credit for goods a till took back that no order payment paid for. */
+    issuedFromReturns: number | null;
     redeemed: number;
+    /**
+     * Value given back by refunds and cancelled payments. A payout's restore (a `reversal` with
+     * `sourceType: 'payout_refund'`) is NOT here: the engine nets it in `paidOut`.
+     */
     reversed: number;
     adjusted: number;
     expired: number;
     forfeited: number;
+    /** Paid back to money (`payOut`), net of the payouts whose refund did not happen. */
+    paidOut: number | null;
     outstanding: number;
 }
 export interface IssueStoredValueInput {
@@ -75,6 +126,37 @@ export interface IssueStoredValueInput {
     reason: string;
     /** Sets the account's expiry: valid through this day (`YYYY-MM-DD`) in the store's time zone. */
     expiresOn?: string;
+    /**
+     * Goodwill FOR this order of the store: linked on the statement; it moves none of the order's
+     * money. Another store's order is not found; an account takes goodwill only for its owner's
+     * order (`STORED_VALUE_OWNER_MISMATCH`). Needs an engine that knows the field (incentives
+     * sprint 8): an older one refuses the whole call.
+     */
+    orderId?: string;
+}
+/**
+ * Whether the store may put an order's money in its customers' store-credit wallets instead of
+ * refunding it (incentives sprint 8).
+ */
+export interface StoreCreditSettings {
+    /** The store's switch. Off until the store turns it on. */
+    refundToCredit: boolean;
+    /**
+     * Where the store keeps what it owes its customers now: `AR` (its own accounts receivable, which
+     * then holds every customer credit), `STORE_CREDIT` (a wallet each: the Stored Value grant, the
+     * switch on, a stored-value method enabled) or `NONE` (neither). Treat any other value as no
+     * store credit.
+     */
+    book: 'AR' | 'STORE_CREDIT' | 'NONE' | (string & {});
+    /** Usable now: the book is `STORE_CREDIT`. */
+    available: boolean;
+    /**
+     * Why the book is not `STORE_CREDIT` (null exactly when it is):
+     * `STORE_CREDIT_STORE_KEEPS_ACCOUNTS`, `STORE_CREDIT_NOT_GRANTED`, `STORE_CREDIT_NOT_ENABLED` or
+     * `STORE_CREDIT_METHOD_REQUIRED`.
+     */
+    code: string | null;
+    message: string | null;
 }
 export interface RedeemStoredValueInput {
     orderId: string;
@@ -84,6 +166,25 @@ export interface RedeemStoredValueInput {
     /** The code of the store's payment method on the `stored-value` handler. */
     method: string;
 }
+export interface PayOutStoreCreditInput {
+    /** The lot: an `order_credit` entry of the customer's store credit (`StoredValueEntry.id`). */
+    entryId: string;
+    /** Minor units of the store credit's currency. Omitted: everything the lot can pay back. */
+    amount?: number;
+    /** Free text, on the Refund and the order note. */
+    reason?: string;
+}
+/** The refund a payout made, of the payment the store credit came from. */
+export interface StoreCreditPayoutRefund {
+    id: string;
+    /** Minor units. */
+    total: number;
+    /** `Settled`, or `Pending` while the payment provider has not confirmed it. */
+    state: string;
+    method: string;
+    transactionId: string | null;
+    reason: string | null;
+}
 export interface StoredValueModule {
     accounts(filter?: {
         customerId?: string;
@@ -108,9 +209,17 @@ export interface StoredValueModule {
         kind?: string;
         locationId?: string;
     }, options?: Call): Promise<StoredValueLiability[]>;
-    /** Requires ManageStoredValue. Send an `idempotencyKey`: a repeat returns the first result. */
+    /**
+     * Requires ManageStoredValue. Send an `idempotencyKey`: a repeat returns the first result. A
+     * gift card sold on an order is never credited (`STORED_VALUE_GIFT_CARD_CREDIT_NOT_ALLOWED`),
+     * nor is a voided one (`STORED_VALUE_GIFT_CARD_VOIDED`).
+     */
     issue(input: IssueStoredValueInput, options?: Call): Promise<StoredValueAccount>;
-    /** Requires ManageStoredValue. Signed; a debit may not take the balance below zero. */
+    /**
+     * Requires ManageStoredValue. Signed; a debit may not take the balance below zero. A voided gift
+     * card takes no credit and no `expiresOn` (`STORED_VALUE_GIFT_CARD_VOIDED`); a plain debit of it
+     * is allowed.
+     */
     adjust(input: {
         accountId: string;
         amount: number;
@@ -120,18 +229,194 @@ export interface StoredValueModule {
     /**
      * Requires ManageStoredValue. The account's value is valid through `expiresOn` (`YYYY-MM-DD`,
      * store zone); `null` clears it. A day already over is refused (`STORED_VALUE_EXPIRY_INVALID`);
-     * value the job already booked as expired stays booked.
+     * value the job already booked as expired stays booked. A voided gift card's expiry never changes
+     * (`STORED_VALUE_GIFT_CARD_VOIDED`).
      */
     setExpiry(id: string, expiresOn: string | null, reason: string, options?: Call): Promise<StoredValueAccount>;
+    /** A voided gift card is refused (`STORED_VALUE_GIFT_CARD_VOIDED`): it is blocked for good. */
     block(id: string, reason: string, options?: Call): Promise<StoredValueAccount>;
+    /** A voided gift card is refused (`STORED_VALUE_GIFT_CARD_VOIDED`): it is blocked for good. */
     unblock(id: string, reason: string, options?: Call): Promise<StoredValueAccount>;
     /**
      * Pay part (or all) of an order from an account (`redeemStoredValue`), through the platform's
-     * payment position: the order lock, the outstanding bound and the store's deposit policy apply,
-     * and the ledger is debited in the payment's own transaction. Requires UpdateOrder. Answers the
-     * payment the SERVER recorded for this call; a repeat under the same key answers the same one.
+     * payment position: the order lock and the outstanding bound apply, and the ledger is debited in
+     * the payment's own transaction. Requires UpdateOrder. Answers the payment the SERVER recorded
+     * for this call; a repeat under the same key answers the same one.
+     *
+     * Stored value may pay PART of an order still arranging payment whatever the store's deposit
+     * policy (split tender, not a deposit): the order is placed only once its money covers it, so the
+     * rest is paid by another method, and cancelling the payment gives the part back to the account.
+     * On a parked or placed order a part is a deposit, refused `DEPOSITS_NOT_ENABLED` on a store
+     * without deposits.
      */
     redeem(input: RedeemStoredValueInput, options?: Call): Promise<StoredValueRedemption>;
+    /**
+     * Requires UpdateOrder AND ManageStoredValue (no Stored Value grant: it pays the customer's own
+     * money back; a blocked wallet may be paid out). Pay store credit moved from an order back to the
+     * payment it came from (`payOutStoreCredit`): a refund of that payment, the last step. Only an
+     * `order_credit` lot (`STORE_CREDIT_PAYOUT_NOT_PAYABLE`); at most what it still holds and what
+     * the customer can spend (`STORE_CREDIT_PAYOUT_EXCEEDED`; the thrown error's
+     * `extensions.storeCredit.payable` says how much may go); and
+     * the refund's own refusals (`REFUND_REFUSED`, …), after which the store credit is given back to
+     * its lot (a `reversal` of `sourceType: 'payout_refund'`). Send an
+     * `idempotencyKey`: a provider answer that is unknown answers `IDEMPOTENCY_OUTCOME_UNKNOWN`, the
+     * store credit stays paid out until `reconcileRefundOutcome`, and a repeat of the key replays the
+     * refund (MADE) or runs again (NOT_MADE). Needs an engine that serves it (incentives sprint 8).
+     */
+    payOut(input: PayOutStoreCreditInput, options?: Call): Promise<StoreCreditPayoutRefund>;
+    /**
+     * Requires ReadStoredValue. The store's refund-to-credit switch and whether it is usable now.
+     * Needs an engine that serves `storeCreditSettings` (incentives sprint 8).
+     */
+    storeCreditSettings(options?: Call): Promise<StoreCreditSettings>;
+    /**
+     * Requires ManageStoredValue. Switch refund to store credit on or off: whether "credit the
+     * customer" may put an order's money in the customer's store-credit wallet instead of refunding
+     * it. Turning it on is refused `STORE_CREDIT_STORE_KEEPS_ACCOUNTS` (the store keeps its
+     * customers' balances on their accounts), `STORE_CREDIT_NOT_GRANTED` (no Stored Value grant)
+     * and `STORE_CREDIT_METHOD_REQUIRED` (no enabled stored-value payment method); turning it off
+     * always works. A setting written whole: no key.
+     */
+    updateStoreCreditSettings(input: {
+        refundToCredit: boolean;
+    }, options?: Call): Promise<StoreCreditSettings>;
+    /** Gift cards: sold on orders, one per paid unit, or issued by staff; each its own account. */
+    giftCards: GiftCardModule;
+}
+/**
+ * A gift card. Its code is never readable: the card is found by id, by order, or by the code
+ * itself (`byCode`, which answers it masked).
+ */
+export interface GiftCard {
+    /** The card's account id. */
+    id: string;
+    createdAt: string;
+    account: StoredValueAccount;
+    /**
+     * `sale`: sold on an order, one card per paid unit. `staff`: issued by staff with no sale
+     * (`giftCards.issue`), on no order.
+     */
+    origin: 'sale' | 'staff';
+    orderId: string | null;
+    orderLineId: string | null;
+    /** The 0-based unit of the order line this card was issued for. */
+    unitIndex: number | null;
+    productVariantId: string | null;
+    /** What the unit was paid, or what staff issued, minor units of the account's unit. */
+    faceValue: number;
+    /** The code's last four characters behind a mask. */
+    maskedCode: string;
+    /** A void blocked the card for good (its account `status` is `voided`); see `void`. */
+    voided: boolean;
+}
+/**
+ * A gift card and the code it was just given. `code` (`XXXX-XXXX-XXXX-XXXX`) is shown ONCE: it is
+ * null when the code went to the buyer by email, and on a repeat under the same `idempotencyKey`
+ * (the server keeps the card's id, never the code).
+ */
+export interface IssuedGiftCard {
+    giftCard: GiftCard;
+    code: string | null;
+}
+/** A gift card staff issue with no sale (`giftCards.issue`). */
+export interface IssueGiftCardInput {
+    /** Minor units, greater than zero. */
+    amount: number;
+    /** An ISO 4217 currency the store sells. */
+    currencyCode: string;
+    reason: string;
+    /** Valid through this day (`YYYY-MM-DD`) in the store's time zone; omitted or null: never expires. */
+    expiresOn?: string | null;
+}
+/** A variant this store sells as a gift card. */
+export interface GiftCardVariant {
+    productVariantId: string;
+    /** A sold card is valid this many calendar months from its issue day; null: never expires. */
+    validityMonths: number | null;
+    createdAt: string;
+}
+export interface GiftCardModule {
+    /** Requires ReadStoredValue. Newest first; `orderId` lists the cards an order sold. */
+    list(filter?: {
+        orderId?: string;
+        origin?: 'sale' | 'staff';
+        take?: number;
+        skip?: number;
+    }, options?: Call): Promise<{
+        items: GiftCard[];
+        totalItems: number;
+    }>;
+    get(id: string, options?: Call): Promise<GiftCard | null>;
+    /**
+     * Requires ReadStoredValue. This store's card for a code, masked, or null: an unknown,
+     * malformed or other store's code answers the same null. Sent as a POST (a code never goes in a
+     * URL), one lookup per request, and budgeted per token: past the budget it is refused
+     * `RATE_LIMITED` with a wait.
+     */
+    byCode(code: string, options?: Call): Promise<GiftCard | null>;
+    /** Requires ReadStoredValue. Which of these variants the store sells as gift cards. */
+    variants(productVariantIds: string[], options?: Call): Promise<GiftCardVariant[]>;
+    /**
+     * Requires ReadStoredValue. How many of this store's orders would issue a gift card of the
+     * variant once paid in full, and so issue none once it is switched off: what the "stop selling"
+     * confirmation names. The engine's issuing rule: an order of this store alone, not cancelled and
+     * not imported, with a unit of the variant priced above zero that has no card yet, and not paid
+     * in full (no settled payment yet, or its settled money below what it bills). Carts, drafts and
+     * placed orders not yet paid in full count alike. `null` when the store does not sell the
+     * variant as a gift card. Read now, without a lock.
+     *
+     * Its own document rather than a field of {@link variants}, so the tab's read pays for no count
+     * and a release of this SDK reading an older engine fails only this call. Needs an engine that
+     * serves `GiftCardVariant.unpaidOrders`.
+     */
+    variantUnpaidOrders(productVariantId: string, options?: Call): Promise<number | null>;
+    /**
+     * Requires ManageStoredValue. Sell a variant as a gift card (or stop: `enabled: false` answers
+     * null). Turning it on is refused once the variant has sold as an ordinary product.
+     * `validityMonths` omitted keeps the validity already set; `null` means no expiry.
+     */
+    setVariant(productVariantId: string, enabled: boolean, validityMonths?: number | null, options?: Call): Promise<GiftCardVariant | null>;
+    /**
+     * Requires ManageStoredValue, or no Stored Value grant at all for a card the store sold. The
+     * step before refunding a gift card's sale: blocks the card for good (status `voided`) and
+     * withdraws what it can still spend, which releases that much of its order's money for a refund (never what the card spent,
+     * never value past its expiry). A second void takes only what became spendable since (a refund
+     * credited back to the card). Send an `idempotencyKey`: a
+     * repeat answers the card as it is then and voids nothing again. A card of another store is not
+     * found; a voided card is never unblocked (`STORED_VALUE_GIFT_CARD_VOIDED`).
+     */
+    void(id: string, reason: string, options?: Call): Promise<GiftCard>;
+    /**
+     * Requires ManageStoredValue (an app installation is refused). A new code for a live gift card:
+     * the old code stops working at once; the balance, expiry, statement and status stay. The code
+     * goes to ONE place:
+     * - `notify: true` emails it to the buyer of a card sold on an order, and `code` is null. A card
+     *   no email can reach (issued with no sale, no email delivery, a buyer whose address cannot
+     *   receive it) is refused `STORED_VALUE_GIFT_CARD_NOT_MAILABLE`, nothing changed;
+     * - `notify: false` answers it in `code`, once, for staff to hand over.
+     *
+     * Send an `idempotencyKey`: a repeat answers the card with `code: null` and changes nothing
+     * again. The first answer is the only copy of a code it shows: a lost one is replaced by another
+     * reissue under a NEW key. A voided card is refused (`STORED_VALUE_GIFT_CARD_VOIDED`); a card of
+     * another store is not found.
+     */
+    reissueCode(id: string, input: {
+        reason: string;
+        notify: boolean;
+    }, options?: Call): Promise<IssuedGiftCard>;
+    /**
+     * Requires ManageStoredValue (an app installation is refused). A bearer gift card with no sale
+     * (goodwill): value created without payment, booked as liability with `origin: 'staff'`. No email
+     * is sent: `code` is in the answer ONCE, for staff to hand over.
+     *
+     * Send an `idempotencyKey`: a repeat answers the card with `code: null` and issues nothing again.
+     * The first answer is the only copy of the code: a lost one is replaced by `reissueCode` on the
+     * card (`notify: false`). Refusals: `STORED_VALUE_ROOT_CHANNEL_NOT_ALLOWED`,
+     * `STORED_VALUE_REASON_REQUIRED`, `STORED_VALUE_AMOUNT_INVALID`, `STORED_VALUE_UNIT_INVALID` (a
+     * currency the store does not sell), `STORED_VALUE_GIFT_CARD_NOT_CONFIGURED`,
+     * `STORED_VALUE_EXPIRY_INVALID` (not a day, or a day already over), `STORED_VALUE_POSTING_CONFLICT`.
+     */
+    issue(input: IssueGiftCardInput, options?: Call): Promise<IssuedGiftCard>;
 }
 /** What a redemption recorded: the order, the payment this call created, the account and amount. */
 export interface StoredValueRedemption {
@@ -143,12 +428,28 @@ export interface StoredValueRedemption {
 }
 export declare const STORED_VALUE_ACCOUNTS_QUERY = "\n  query StoredValueAccounts($customerId: ID, $kind: String, $take: Int, $skip: Int) {\n    storedValueAccounts(customerId: $customerId, kind: $kind, take: $take, skip: $skip) {\n      items { \n  id\n  createdAt\n  updatedAt\n  kind\n  unit\n  customerId\n  codeLast4\n  expiresAt\n  expiresOn\n  status\n  balance\n  spendable\n }\n      totalItems\n    }\n  }\n";
 export declare const STORED_VALUE_ACCOUNT_QUERY = "\n  query StoredValueAccount($id: ID!) {\n    storedValueAccount(id: $id) { \n  id\n  createdAt\n  updatedAt\n  kind\n  unit\n  customerId\n  codeLast4\n  expiresAt\n  expiresOn\n  status\n  balance\n  spendable\n }\n  }\n";
-export declare const STORED_VALUE_STATEMENT_QUERY = "\n  query StoredValueStatement($accountId: ID!, $from: DateTime, $to: DateTime, $take: Int, $skip: Int) {\n    storedValueStatement(accountId: $accountId, from: $from, to: $to, take: $take, skip: $skip) {\n      account { \n  id\n  createdAt\n  updatedAt\n  kind\n  unit\n  customerId\n  codeLast4\n  expiresAt\n  expiresOn\n  status\n  balance\n  spendable\n }\n      openingBalance\n      closingBalance\n      totalItems\n      entries {\n        id createdAt occurredAt entryType amount balanceAfter unit sourceType sourceId paymentId\n        orderId locationId actorType actorId onBehalfOfRef deviceRef reason\n      }\n    }\n  }\n";
-export declare const STORED_VALUE_LIABILITY_QUERY = "\n  query StoredValueLiability($at: DateTime, $kind: String, $locationId: ID) {\n    storedValueLiability(at: $at, kind: $kind, locationId: $locationId) {\n      unit kind accounts issued redeemed reversed adjusted expired forfeited outstanding\n    }\n  }\n";
+export declare const STORED_VALUE_STATEMENT_QUERY = "\n  query StoredValueStatement($accountId: ID!, $from: DateTime, $to: DateTime, $take: Int, $skip: Int) {\n    storedValueStatement(accountId: $accountId, from: $from, to: $to, take: $take, skip: $skip) {\n      account { \n  id\n  createdAt\n  updatedAt\n  kind\n  unit\n  customerId\n  codeLast4\n  expiresAt\n  expiresOn\n  status\n  balance\n  spendable\n }\n      openingBalance\n      closingBalance\n      totalItems\n      entries {\n        id createdAt occurredAt entryType amount balanceAfter unit sourceType sourceId paymentId\n        orderId locationId actorType actorId onBehalfOfRef deviceRef reason origin originRef lotId\n        customerAgreed\n      }\n    }\n  }\n";
+export declare const STORED_VALUE_LIABILITY_QUERY = "\n  query StoredValueLiability($at: DateTime, $kind: String, $locationId: ID) {\n    storedValueLiability(at: $at, kind: $kind, locationId: $locationId) {\n      unit kind accounts issued issuedGoodwill issuedFromOrders issuedFromReturns redeemed\n      reversed adjusted expired forfeited paidOut outstanding\n    }\n  }\n";
+/** `document` without the fields above: what an engine before them accepts. */
+export declare function withoutWalletFields(document: string): string;
+/** `document` without the consent field: what an engine of sprint 8 before PR 6a accepts. */
+export declare function withoutConsentField(document: string): string;
 export declare const ISSUE_STORED_VALUE_MUTATION = "\n  mutation IssueStoredValue($input: IssueStoredValueInput!, $idempotencyKey: String) {\n    issueStoredValue(input: $input, idempotencyKey: $idempotencyKey) { \n  id\n  createdAt\n  updatedAt\n  kind\n  unit\n  customerId\n  codeLast4\n  expiresAt\n  expiresOn\n  status\n  balance\n  spendable\n }\n  }\n";
 export declare const ADJUST_STORED_VALUE_MUTATION = "\n  mutation AdjustStoredValue($input: AdjustStoredValueInput!, $idempotencyKey: String) {\n    adjustStoredValue(input: $input, idempotencyKey: $idempotencyKey) { \n  id\n  createdAt\n  updatedAt\n  kind\n  unit\n  customerId\n  codeLast4\n  expiresAt\n  expiresOn\n  status\n  balance\n  spendable\n }\n  }\n";
 export declare const BLOCK_STORED_VALUE_MUTATION = "\n  mutation BlockStoredValueAccount($id: ID!, $reason: String!) {\n    blockStoredValueAccount(id: $id, reason: $reason) { \n  id\n  createdAt\n  updatedAt\n  kind\n  unit\n  customerId\n  codeLast4\n  expiresAt\n  expiresOn\n  status\n  balance\n  spendable\n }\n  }\n";
 export declare const UNBLOCK_STORED_VALUE_MUTATION = "\n  mutation UnblockStoredValueAccount($id: ID!, $reason: String!) {\n    unblockStoredValueAccount(id: $id, reason: $reason) { \n  id\n  createdAt\n  updatedAt\n  kind\n  unit\n  customerId\n  codeLast4\n  expiresAt\n  expiresOn\n  status\n  balance\n  spendable\n }\n  }\n";
 export declare const SET_STORED_VALUE_EXPIRY_MUTATION = "\n  mutation SetStoredValueAccountExpiry(\n    $id: ID!\n    $expiresOn: String\n    $reason: String!\n    $idempotencyKey: String\n  ) {\n    setStoredValueAccountExpiry(\n      id: $id\n      expiresOn: $expiresOn\n      reason: $reason\n      idempotencyKey: $idempotencyKey\n    ) { \n  id\n  createdAt\n  updatedAt\n  kind\n  unit\n  customerId\n  codeLast4\n  expiresAt\n  expiresOn\n  status\n  balance\n  spendable\n }\n  }\n";
+export declare const PAY_OUT_STORE_CREDIT_MUTATION = "\n  mutation PayOutStoreCredit($input: PayOutStoreCreditInput!, $idempotencyKey: String) {\n    payOutStoreCredit(input: $input, idempotencyKey: $idempotencyKey) {\n      id\n      total\n      state\n      method\n      transactionId\n      reason\n    }\n  }\n";
 export declare const REDEEM_STORED_VALUE_MUTATION = "\n  mutation RedeemStoredValue($input: RedeemStoredValueInput!, $idempotencyKey: String) {\n    redeemStoredValue(input: $input, idempotencyKey: $idempotencyKey) {\n      orderId\n      paymentId\n      accountId\n      amount\n    }\n  }\n";
+export declare const STORE_CREDIT_SETTINGS_QUERY = "\n  query StoreCreditSettings {\n    storeCreditSettings { \n  refundToCredit\n  book\n  available\n  code\n  message\n }\n  }\n";
+export declare const UPDATE_STORE_CREDIT_SETTINGS_MUTATION = "\n  mutation UpdateStoreCreditSettings($input: UpdateStoreCreditSettingsInput!) {\n    updateStoreCreditSettings(input: $input) { \n  refundToCredit\n  book\n  available\n  code\n  message\n }\n  }\n";
+export declare const GIFT_CARDS_QUERY = "\n  query GiftCards($orderId: ID, $origin: String, $take: Int, $skip: Int) {\n    giftCards(orderId: $orderId, origin: $origin, take: $take, skip: $skip) {\n      items { \n  id\n  createdAt\n  account { \n  id\n  createdAt\n  updatedAt\n  kind\n  unit\n  customerId\n  codeLast4\n  expiresAt\n  expiresOn\n  status\n  balance\n  spendable\n }\n  origin\n  orderId\n  orderLineId\n  unitIndex\n  productVariantId\n  faceValue\n  maskedCode\n  voided\n }\n      totalItems\n    }\n  }\n";
+export declare const GIFT_CARD_QUERY = "\n  query GiftCard($id: ID!) {\n    giftCard(id: $id) { \n  id\n  createdAt\n  account { \n  id\n  createdAt\n  updatedAt\n  kind\n  unit\n  customerId\n  codeLast4\n  expiresAt\n  expiresOn\n  status\n  balance\n  spendable\n }\n  origin\n  orderId\n  orderLineId\n  unitIndex\n  productVariantId\n  faceValue\n  maskedCode\n  voided\n }\n  }\n";
+export declare const GIFT_CARD_BY_CODE_QUERY = "\n  query GiftCardByCode($code: String!) {\n    giftCardByCode(code: $code) { \n  id\n  createdAt\n  account { \n  id\n  createdAt\n  updatedAt\n  kind\n  unit\n  customerId\n  codeLast4\n  expiresAt\n  expiresOn\n  status\n  balance\n  spendable\n }\n  origin\n  orderId\n  orderLineId\n  unitIndex\n  productVariantId\n  faceValue\n  maskedCode\n  voided\n }\n  }\n";
+export declare const GIFT_CARD_VARIANTS_QUERY = "\n  query GiftCardVariants($productVariantIds: [ID!]!) {\n    giftCardVariants(productVariantIds: $productVariantIds) {\n      productVariantId\n      validityMonths\n      createdAt\n    }\n  }\n";
+export declare const GIFT_CARD_VARIANT_UNPAID_ORDERS_QUERY = "\n  query GiftCardVariantUnpaidOrders($productVariantIds: [ID!]!) {\n    giftCardVariants(productVariantIds: $productVariantIds) {\n      productVariantId\n      unpaidOrders\n    }\n  }\n";
+export declare const SET_GIFT_CARD_VARIANT_MUTATION = "\n  mutation SetGiftCardVariant($productVariantId: ID!, $enabled: Boolean!, $validityMonths: Int) {\n    setGiftCardVariant(\n      productVariantId: $productVariantId\n      enabled: $enabled\n      validityMonths: $validityMonths\n    ) {\n      productVariantId\n      validityMonths\n      createdAt\n    }\n  }\n";
+export declare const VOID_GIFT_CARD_MUTATION = "\n  mutation VoidGiftCard($id: ID!, $reason: String!, $idempotencyKey: String) {\n    voidGiftCard(id: $id, reason: $reason, idempotencyKey: $idempotencyKey) { \n  id\n  createdAt\n  account { \n  id\n  createdAt\n  updatedAt\n  kind\n  unit\n  customerId\n  codeLast4\n  expiresAt\n  expiresOn\n  status\n  balance\n  spendable\n }\n  origin\n  orderId\n  orderLineId\n  unitIndex\n  productVariantId\n  faceValue\n  maskedCode\n  voided\n }\n  }\n";
+export declare const REISSUE_GIFT_CARD_CODE_MUTATION = "\n  mutation ReissueGiftCardCode(\n    $id: ID!\n    $reason: String!\n    $notify: Boolean!\n    $idempotencyKey: String\n  ) {\n    reissueGiftCardCode(\n      id: $id\n      reason: $reason\n      notify: $notify\n      idempotencyKey: $idempotencyKey\n    ) {\n      giftCard { \n  id\n  createdAt\n  account { \n  id\n  createdAt\n  updatedAt\n  kind\n  unit\n  customerId\n  codeLast4\n  expiresAt\n  expiresOn\n  status\n  balance\n  spendable\n }\n  origin\n  orderId\n  orderLineId\n  unitIndex\n  productVariantId\n  faceValue\n  maskedCode\n  voided\n }\n      code\n    }\n  }\n";
+export declare const ISSUE_GIFT_CARD_MUTATION = "\n  mutation IssueGiftCard($input: IssueGiftCardInput!, $idempotencyKey: String) {\n    issueGiftCard(input: $input, idempotencyKey: $idempotencyKey) {\n      giftCard { \n  id\n  createdAt\n  account { \n  id\n  createdAt\n  updatedAt\n  kind\n  unit\n  customerId\n  codeLast4\n  expiresAt\n  expiresOn\n  status\n  balance\n  spendable\n }\n  origin\n  orderId\n  orderLineId\n  unitIndex\n  productVariantId\n  faceValue\n  maskedCode\n  voided\n }\n      code\n    }\n  }\n";
 export declare function createStoredValueModule(transport: Transport): StoredValueModule;