@salesforce/b2c-cli 1.10.0 → 1.12.0

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/order/CouponLineItem.d.ts

@@ -0,0 +1,139 @@
+import ExtensibleObject = require('../object/ExtensibleObject');
+import CustomAttributes = require('../object/CustomAttributes');
+import Collection = require('../util/Collection');
+import PriceAdjustment = require('./PriceAdjustment');
+import BonusDiscountLineItem = require('./BonusDiscountLineItem');
+import Promotion = require('../campaign/Promotion');
+
+declare global {
+    module ICustomAttributes {
+        interface CouponLineItem extends CustomAttributes {
+        }
+    }
+}
+
+/**
+ * The CouponLineItem class is used to store redeemed coupons in the Basket.
+ */
+declare class CouponLineItem extends ExtensibleObject<ICustomAttributes.CouponLineItem> {
+    /**
+     * Identifies if the coupon is currently applied in the basket. A coupon
+     * line is applied if there exists at least one price adjustment related
+     * to the coupon line item.
+     */
+    readonly applied: boolean;
+    /**
+     * Returns true if the line item represents a coupon of a campaign. If the coupon line item represents a custom
+     * coupon code, the method returns false.
+     */
+    readonly basedOnCampaign: boolean;
+    /**
+     * Returns the bonus discount line items of the line item container triggered
+     * by this coupon.
+     */
+    readonly bonusDiscountLineItems: Collection<BonusDiscountLineItem>;
+    /**
+     * Returns the coupon code.
+     */
+    readonly couponCode: string;
+    /**
+     * Returns the price adjustments of the line item container triggered
+     * by this coupon.
+     */
+    readonly priceAdjustments: Collection<PriceAdjustment>;
+    /**
+     * Returns the promotion related to the coupon line item.
+     * @deprecated A coupon code and its coupon can be associated with
+     * multiple promotions. Therefore, this method is not
+     * appropriate anymore. For backward-compatibility, the method
+     * returns one of the promotions associated with the coupon
+     * code.
+     */
+    readonly promotion: Promotion;
+    /**
+     * Returns the id of the related promotion.
+     * @deprecated A coupon code and it's coupon can be associated with
+     * multiple promotions. Therefore, this method is not
+     * appropriate anymore. For backward-compatibility, the method
+     * returns the ID of one of the promotions associated with
+     * the coupon code.
+     */
+    readonly promotionID: string;
+    /**
+     * This method provides a detailed error status in case the coupon code of
+     * this coupon line item instance became invalid.
+     */
+    readonly statusCode: string;
+    /**
+     * Allows to check whether the coupon code of this coupon line item instance
+     * is valid. Coupon line item is valid, if status code is one of the following:
+     * 
+     * - dw.campaign.CouponStatusCodes.APPLIED
+     * - dw.campaign.CouponStatusCodes.NO_APPLICABLE_PROMOTION
+     */
+    readonly valid: boolean;
+    private constructor();
+    /**
+     * Associates the specified price adjustment with the coupon line item. This method is only applicable if used for
+     * price adjustments and coupon line items NOT based on B2C Commerce campaigns.
+     */
+    associatePriceAdjustment(priceAdjustment: PriceAdjustment): void;
+    /**
+     * Returns the bonus discount line items of the line item container triggered
+     * by this coupon.
+     */
+    getBonusDiscountLineItems(): Collection<BonusDiscountLineItem>;
+    /**
+     * Returns the coupon code.
+     */
+    getCouponCode(): string;
+    /**
+     * Returns the price adjustments of the line item container triggered
+     * by this coupon.
+     */
+    getPriceAdjustments(): Collection<PriceAdjustment>;
+    /**
+     * Returns the promotion related to the coupon line item.
+     * @deprecated A coupon code and its coupon can be associated with
+     * multiple promotions. Therefore, this method is not
+     * appropriate anymore. For backward-compatibility, the method
+     * returns one of the promotions associated with the coupon
+     * code.
+     */
+    getPromotion(): Promotion;
+    /**
+     * Returns the id of the related promotion.
+     * @deprecated A coupon code and it's coupon can be associated with
+     * multiple promotions. Therefore, this method is not
+     * appropriate anymore. For backward-compatibility, the method
+     * returns the ID of one of the promotions associated with
+     * the coupon code.
+     */
+    getPromotionID(): string;
+    /**
+     * This method provides a detailed error status in case the coupon code of
+     * this coupon line item instance became invalid.
+     */
+    getStatusCode(): string;
+    /**
+     * Identifies if the coupon is currently applied in the basket. A coupon
+     * line is applied if there exists at least one price adjustment related
+     * to the coupon line item.
+     */
+    isApplied(): boolean;
+    /**
+     * Returns true if the line item represents a coupon of a campaign. If the coupon line item represents a custom
+     * coupon code, the method returns false.
+     */
+    isBasedOnCampaign(): boolean;
+    /**
+     * Allows to check whether the coupon code of this coupon line item instance
+     * is valid. Coupon line item is valid, if status code is one of the following:
+     * 
+     * - dw.campaign.CouponStatusCodes.APPLIED
+     * - dw.campaign.CouponStatusCodes.NO_APPLICABLE_PROMOTION
+     */
+    isValid(): boolean;
+}
+
+export = CouponLineItem;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/order/CreateAgentBasketLimitExceededException.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This exception is thrown by BasketMgr.createAgentBasket to indicate that the open agent basket limit for
+ * the current session customer is already reached, and therefore no new agent basket could be created.
+ */
+declare class CreateAgentBasketLimitExceededException {
+    private constructor();
+}
+
+export = CreateAgentBasketLimitExceededException;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/order/CreateBasketFromOrderException.d.ts

@@ -0,0 +1,17 @@
+/**
+ * This APIException is thrown by method dw.order.BasketMgr.createBasketFromOrder
+ * to indicate no Basket could be created from the Order.
+ */
+declare class CreateBasketFromOrderException {
+    /**
+     * Indicates reason why dw.order.BasketMgr.createBasketFromOrder failed.
+     */
+    readonly errorCode: string;
+    private constructor();
+    /**
+     * Indicates reason why dw.order.BasketMgr.createBasketFromOrder failed.
+     */
+    getErrorCode(): string;
+}
+
+export = CreateBasketFromOrderException;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/order/CreateCouponLineItemException.d.ts

@@ -0,0 +1,29 @@
+/**
+ * This exception could be thrown by LineItemCtnr.createCouponLineItem
+ * when the provided coupon code is invalid.
+ * 
+ * 'errorCode' property is set to one of the following values:
+ * 
+ * - dw.campaign.CouponStatusCodes.COUPON_CODE_ALREADY_IN_BASKET = Indicates that coupon code has already been added to basket.
+ * - dw.campaign.CouponStatusCodes.COUPON_ALREADY_IN_BASKET = Indicates that another code of the same MultiCode/System coupon has already been added to basket.
+ * - dw.campaign.CouponStatusCodes.COUPON_CODE_ALREADY_REDEEMED = Indicates that code of MultiCode/System coupon has already been redeemed.
+ * - dw.campaign.CouponStatusCodes.COUPON_CODE_UNKNOWN = Indicates that coupon not found for given coupon code or that the code itself was not found.
+ * - dw.campaign.CouponStatusCodes.COUPON_DISABLED = Indicates that coupon is not enabled.
+ * - dw.campaign.CouponStatusCodes.REDEMPTION_LIMIT_EXCEEDED = Indicates that number of redemptions per code exceeded.
+ * - dw.campaign.CouponStatusCodes.CUSTOMER_REDEMPTION_LIMIT_EXCEEDED = Indicates that number of redemptions per code and customer exceeded.
+ * - dw.campaign.CouponStatusCodes.TIMEFRAME_REDEMPTION_LIMIT_EXCEEDED = Indicates that number of redemptions per code, customer and time exceeded.
+ * - dw.campaign.CouponStatusCodes.NO_ACTIVE_PROMOTION = Indicates that coupon is not assigned to an active promotion.
+ */
+declare class CreateCouponLineItemException {
+    /**
+     * Returns one of the error codes listed in the class doc.
+     */
+    readonly errorCode: string;
+    private constructor();
+    /**
+     * Returns one of the error codes listed in the class doc.
+     */
+    getErrorCode(): string;
+}
+
+export = CreateCouponLineItemException;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/order/CreateOrderException.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This APIException is thrown by method dw.order.OrderMgr.createOrder
+ * to indicate no Order could be created from the Basket.
+ */
+declare class CreateOrderException {
+    private constructor();
+}
+
+export = CreateOrderException;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/order/CreateTemporaryBasketLimitExceededException.d.ts

@@ -0,0 +1,9 @@
+/**
+ * This exception is thrown by BasketMgr.createTemporaryBasket to indicate that the open temporary basket
+ * limit for the current session customer is already reached, and therefore no new temporary basket could be created.
+ */
+declare class CreateTemporaryBasketLimitExceededException {
+    private constructor();
+}
+
+export = CreateTemporaryBasketLimitExceededException;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/order/GiftCertificate.d.ts

@@ -0,0 +1,220 @@
+import ExtensibleObject = require('../object/ExtensibleObject');
+import CustomAttributes = require('../object/CustomAttributes');
+import Money = require('../value/Money');
+
+declare global {
+    module ICustomAttributes {
+        interface GiftCertificate extends CustomAttributes {
+        }
+    }
+}
+
+/**
+ * Represents a Gift Certificate that can be used to purchase
+ * products.
+ */
+declare class GiftCertificate extends ExtensibleObject<ICustomAttributes.GiftCertificate> {
+    /**
+     * Represents a status of 'issued', which indicates that the Gift Certificate
+     * has been created and that it can be used to purchase products.
+     */
+    static readonly STATUS_ISSUED = 1;
+    /**
+     * Represents a status of 'partially redeemed', which indicates that the Gift Certificate
+     * has been used to purchase products, but that there is still a balance on
+     * the gift certificate.
+     */
+    static readonly STATUS_PARTIALLY_REDEEMED = 2;
+    /**
+     * Represents a status of 'pending', which indicates that the Gift Certificate
+     * has been created but that it cannot be used yet.
+     */
+    static readonly STATUS_PENDING = 0;
+    /**
+     * Represents a status of 'redeemed', which indicates that the Gift Certificate
+     * has been used and no longer contains a balance.
+     */
+    static readonly STATUS_REDEEMED = 3;
+    /**
+     * Returns the code of the gift certificate. This redemption code is send to
+     * gift certificate recipient.
+     * @deprecated Use getGiftCertificateCode
+     */
+    readonly ID: string;
+    /**
+     * Returns the original amount on the gift certificate.
+     */
+    readonly amount: Money;
+    /**
+     * Returns the balance on the gift certificate.
+     */
+    readonly balance: Money;
+    /**
+     * Returns the description string.
+     */
+    description: string;
+    /**
+     * Returns true if the Gift Certificate is enabled, false otherwise.
+     */
+    enabled: boolean;
+    /**
+     * Returns the code of the gift certificate. This redemption code is send to
+     * gift certificate recipient.
+     */
+    readonly giftCertificateCode: string;
+    /**
+     * Returns the masked gift certificate code with
+     * all but the last 4 characters replaced with a '*' character.
+     */
+    readonly maskedGiftCertificateCode: string;
+    /**
+     * Returns the merchant ID of the gift certificate.
+     */
+    readonly merchantID: string;
+    /**
+     * Returns the message to include in the email of the person receiving
+     * the gift certificate.
+     */
+    message: string;
+    /**
+     * Returns the order number
+     */
+    orderNo: string;
+    /**
+     * Returns the email address of the person receiving
+     * the gift certificate.
+     */
+    recipientEmail: string;
+    /**
+     * Returns the name of the person receiving
+     * the gift certificate.
+     */
+    recipientName: string;
+    /**
+     * Returns the name of the person or organization that
+     * sent the gift certificate or null if undefined.
+     */
+    senderName: string | null;
+    /**
+     * Returns the status where the possible values are
+     * STATUS_PENDING, STATUS_ISSUED, STATUS_PARTIALLY_REDEEMED
+     * or STATUS_REDEEMED.
+     */
+    status: number;
+    private constructor();
+    /**
+     * Returns the original amount on the gift certificate.
+     */
+    getAmount(): Money;
+    /**
+     * Returns the balance on the gift certificate.
+     */
+    getBalance(): Money;
+    /**
+     * Returns the description string.
+     */
+    getDescription(): string;
+    /**
+     * Returns the code of the gift certificate. This redemption code is send to
+     * gift certificate recipient.
+     */
+    getGiftCertificateCode(): string;
+    /**
+     * Returns the code of the gift certificate. This redemption code is send to
+     * gift certificate recipient.
+     * @deprecated Use getGiftCertificateCode
+     */
+    getID(): string;
+    /**
+     * Returns the masked gift certificate code with
+     * all but the last 4 characters replaced with a '*' character.
+     */
+    getMaskedGiftCertificateCode(): string;
+    /**
+     * Returns the masked gift certificate code with
+     * all but the specified number of characters replaced with a '*' character.
+     * @throws IllegalArgumentException if ignore is negative.
+     */
+    getMaskedGiftCertificateCode(ignore: number): string;
+    /**
+     * Returns the merchant ID of the gift certificate.
+     */
+    getMerchantID(): string;
+    /**
+     * Returns the message to include in the email of the person receiving
+     * the gift certificate.
+     */
+    getMessage(): string;
+    /**
+     * Returns the order number
+     */
+    getOrderNo(): string;
+    /**
+     * Returns the email address of the person receiving
+     * the gift certificate.
+     */
+    getRecipientEmail(): string;
+    /**
+     * Returns the name of the person receiving
+     * the gift certificate.
+     */
+    getRecipientName(): string;
+    /**
+     * Returns the name of the person or organization that
+     * sent the gift certificate or null if undefined.
+     */
+    getSenderName(): string | null;
+    /**
+     * Returns the status where the possible values are
+     * STATUS_PENDING, STATUS_ISSUED, STATUS_PARTIALLY_REDEEMED
+     * or STATUS_REDEEMED.
+     */
+    getStatus(): number;
+    /**
+     * Returns true if the Gift Certificate is enabled, false otherwise.
+     */
+    isEnabled(): boolean;
+    /**
+     * An optional description that you can use to categorize the
+     * gift certificate.
+     */
+    setDescription(description: string): void;
+    /**
+     * Controls if the Gift Certificate is enabled.
+     */
+    setEnabled(enabled: boolean): void;
+    /**
+     * Sets the message to include in the email of the person receiving
+     * the gift certificate.
+     */
+    setMessage(message: string): void;
+    /**
+     * Sets the order number
+     */
+    setOrderNo(orderNo: string): void;
+    /**
+     * Sets the email address of the person receiving
+     * the gift certificate.
+     */
+    setRecipientEmail(recipientEmail: string): void;
+    /**
+     * Sets the name of the person receiving
+     * the gift certificate.
+     */
+    setRecipientName(recipient: string): void;
+    /**
+     * Sets the name of the person or organization that
+     * sent the gift certificate.
+     */
+    setSenderName(sender: string): void;
+    /**
+     * Sets the status of the gift certificate.
+     * 
+     * Possible values are: STATUS_ISSUED,
+     * STATUS_PENDING, STATUS_PARTIALLY_REDEEMED
+     * and STATUS_REDEEMED.
+     */
+    setStatus(status: number): void;
+}
+
+export = GiftCertificate;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/order/GiftCertificateLineItem.d.ts

@@ -0,0 +1,124 @@
+import LineItem = require('./LineItem');
+import ExtensibleObject = require('../object/ExtensibleObject');
+import CustomAttributes = require('../object/CustomAttributes');
+import Shipment = require('./Shipment');
+import ProductListItem = require('../customer/ProductListItem');
+
+declare global {
+    module ICustomAttributes {
+        interface GiftCertificateLineItem extends ICustomAttributes.LineItem {
+        }
+    }
+}
+
+/**
+ * Represents a Gift Certificate line item in the cart. When an order is
+ * processed, a Gift Certificate is created based on the information in
+ * the Gift Certificate line item.
+ */
+declare class GiftCertificateLineItem extends LineItem<ICustomAttributes.GiftCertificateLineItem> {
+    /**
+     * Returns the ID of the gift certificate that this line item
+     * was used to create. If this line item has not been used to create
+     * a Gift Certificate, this method returns null.
+     */
+    giftCertificateID: string | null;
+    /**
+     * Returns the message to include in the email of the person receiving
+     * the gift certificate line item.
+     */
+    message: string;
+    /**
+     * Returns the associated ProductListItem.
+     */
+    productListItem: ProductListItem | null;
+    /**
+     * Returns the email address of the person receiving
+     * the gift certificate line item.
+     */
+    recipientEmail: string;
+    /**
+     * Returns the name of the person receiving the gift certificate line item.
+     */
+    recipientName: string;
+    /**
+     * Returns the name of the person or organization that
+     * sent the gift certificate line item or null if undefined.
+     */
+    senderName: string | null;
+    /**
+     * Returns the associated Shipment.
+     */
+    shipment: Shipment;
+    private constructor();
+    /**
+     * Returns the ID of the gift certificate that this line item
+     * was used to create. If this line item has not been used to create
+     * a Gift Certificate, this method returns null.
+     */
+    getGiftCertificateID(): string | null;
+    /**
+     * Returns the message to include in the email of the person receiving
+     * the gift certificate line item.
+     */
+    getMessage(): string;
+    /**
+     * Returns the associated ProductListItem.
+     */
+    getProductListItem(): ProductListItem | null;
+    /**
+     * Returns the email address of the person receiving
+     * the gift certificate line item.
+     */
+    getRecipientEmail(): string;
+    /**
+     * Returns the name of the person receiving the gift certificate line item.
+     */
+    getRecipientName(): string;
+    /**
+     * Returns the name of the person or organization that
+     * sent the gift certificate line item or null if undefined.
+     */
+    getSenderName(): string | null;
+    /**
+     * Returns the associated Shipment.
+     */
+    getShipment(): Shipment;
+    /**
+     * Sets the ID of the gift certificate associated with this line item.
+     */
+    setGiftCertificateID(id: string): void;
+    /**
+     * Sets the message to include in the email of the person receiving
+     * the gift certificate line item.
+     */
+    setMessage(message: string): void;
+    /**
+     * Sets the associated ProductListItem.
+     * 
+     * The product list item to be set must be of type gift certificate otherwise an exception is thrown.
+     */
+    setProductListItem(productListItem: ProductListItem): void;
+    /**
+     * Sets the email address of the person receiving
+     * the gift certificate line item.
+     */
+    setRecipientEmail(recipientEmail: string): void;
+    /**
+     * Sets the name of the person receiving the gift certificate line item.
+     */
+    setRecipientName(recipient: string): void;
+    /**
+     * Sets the name of the person or organization that
+     * sent the gift certificate line item.
+     */
+    setSenderName(sender: string): void;
+    /**
+     * Associates the gift certificate line item with the specified shipment.
+     * 
+     * Gift certificate line item and shipment must belong to the same line item ctnr.
+     */
+    setShipment(shipment: Shipment): void;
+}
+
+export = GiftCertificateLineItem;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/order/GiftCertificateMgr.d.ts

@@ -0,0 +1,85 @@
+import GiftCertificate = require('./GiftCertificate');
+import Status = require('../system/Status');
+import OrderPaymentInstrument = require('./OrderPaymentInstrument');
+
+/**
+ * The GiftCertificateMgr class contains a set of static methods for
+ * interacting with GiftCertificates.
+ */
+declare class GiftCertificateMgr {
+    /**
+     * Indicates that an error occurred because the Gift Certificate
+     * is currently disabled.
+     * @deprecated Use dw.order.GiftCertificateStatusCodes instead.
+     */
+    static readonly GC_ERROR_DISABLED = "GIFTCERTIFICATE-100";
+    /**
+     * Indicates that an error occurred because the Gift Certificate
+     * does not have a sufficient balance to perform the requested
+     * operation.
+     * @deprecated Use dw.order.GiftCertificateStatusCodes instead.
+     */
+    static readonly GC_ERROR_INSUFFICIENT_BALANCE = "GIFTCERTIFICATE-110";
+    /**
+     * Indicates that an error occurred because the Gift Certificate
+     * Amount was not valid.
+     * @deprecated Use dw.order.GiftCertificateStatusCodes instead.
+     */
+    static readonly GC_ERROR_INVALID_AMOUNT = "GIFTCERTIFICATE-140";
+    /**
+     * Indicates that an error occurred because the Gift Certificate
+     * ID was not valid.
+     * @deprecated Use dw.order.GiftCertificateStatusCodes instead.
+     */
+    static readonly GC_ERROR_INVALID_CODE = "GIFTCERTIFICATE-150";
+    /**
+     * Indicates that an error occurred because the Gift Certificate
+     * has been fully redeemed.
+     * @deprecated Use dw.order.GiftCertificateStatusCodes instead.
+     */
+    static readonly GC_ERROR_PENDING = "GIFTCERTIFICATE-130";
+    /**
+     * Indicates that an error occurred because the Gift Certificate
+     * has been fully redeemed.
+     * @deprecated Use   dw.order.GiftCertificateStatusCodes instead.
+     */
+    static readonly GC_ERROR_REDEEMED = "GIFTCERTIFICATE-120";
+    private constructor();
+    /**
+     * Creates a Gift Certificate. If a non-empty Gift Certificate code is specified, the code will be used to create
+     * the Gift Certificate. Be aware that this code must be unique for the current site. If it is not unique, the Gift
+     * Certificate will not be created.
+     */
+    static createGiftCertificate(amount: number, code: string | null): GiftCertificate;
+    /**
+     * Creates a Gift Certificate. The system will assign a code to the new Gift Certificate.
+     */
+    static createGiftCertificate(amount: number): GiftCertificate;
+    /**
+     * Returns the Gift Certificate identified by the specified
+     * gift certificate code.
+     * @deprecated Use getGiftCertificateByCode
+     */
+    static getGiftCertificate(giftCertificateCode: string): GiftCertificate | null;
+    /**
+     * Returns the Gift Certificate identified by the specified
+     * gift certificate code.
+     */
+    static getGiftCertificateByCode(giftCertificateCode: string): GiftCertificate | null;
+    /**
+     * Returns the Gift Certificate identified by the specified merchant ID.
+     */
+    static getGiftCertificateByMerchantID(merchantID: string): GiftCertificate | null;
+    /**
+     * Redeems an amount from a Gift Certificate. The Gift Certificate ID
+     * is specified in the OrderPaymentInstrument and the amount
+     * specified in the PaymentTransaction associated with the
+     * OrderPaymentInstrument. If the PaymentTransaction.getTransactionID()
+     * is not null, the value returned by this method is used as the
+     * 'Order Number' for the redemption transaction. The 'Order Number' is
+     * visible via the Business Manager.
+     */
+    static redeemGiftCertificate(paymentInstrument: OrderPaymentInstrument): Status;
+}
+
+export = GiftCertificateMgr;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/order/GiftCertificateStatusCodes.d.ts

@@ -0,0 +1,42 @@
+/**
+ * Helper class containing status codes for the various errors that can occur
+ * when redeeming a gift certificate. One of these codes is returned as part of
+ * a Status object when a unsuccessful call to the
+ * `RedeemGiftCertificate` pipelet is made.
+ */
+declare class GiftCertificateStatusCodes {
+    /**
+     * Indicates that an error occurred because the Gift Certificate
+     * was in a different currency than the Basket.
+     */
+    static readonly GIFTCERTIFICATE_CURRENCY_MISMATCH = "GIFTCERTIFICATE_CURRENCY_MISMATCH";
+    /**
+     * Indicates that an error occurred because the Gift Certificate
+     * is currently disabled.
+     */
+    static readonly GIFTCERTIFICATE_DISABLED = "GIFTCERTIFICATE_DISABLED";
+    /**
+     * Indicates that an error occurred because the Gift Certificate
+     * does not have a sufficient balance to perform the requested
+     * operation.
+     */
+    static readonly GIFTCERTIFICATE_INSUFFICIENT_BALANCE = "GIFTCERTIFICATE_INSUFFICIENT_BALANCE";
+    /**
+     * Indicates that an error occurred because the Gift Certificate
+     * was not found.
+     */
+    static readonly GIFTCERTIFICATE_NOT_FOUND = "GIFTCERTIFICATE_NOT_FOUND";
+    /**
+     * Indicates that an error occurred because the Gift Certificate
+     * is pending and is not available for use.
+     */
+    static readonly GIFTCERTIFICATE_PENDING = "GIFTCERTIFICATE_PENDING";
+    /**
+     * Indicates that an error occurred because the Gift Certificate
+     * has been fully redeemed.
+     */
+    static readonly GIFTCERTIFICATE_REDEEMED = "GIFTCERTIFICATE_REDEEMED";
+    private constructor();
+}
+
+export = GiftCertificateStatusCodes;