@salesforce/b2c-cli 1.10.0 → 1.12.0

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/extensions/payments/SalesforcePaymentsZone.d.ts

@@ -0,0 +1,166 @@
+import Collection = require('../../util/Collection');
+import Money = require('../../value/Money');
+
+/**
+ * 
+ * 
+ * Salesforce Payments representation of a payments zone. See Salesforce Payments documentation for how to gain access
+ * and configure payment zones and assign them to sites.
+ * 
+ * A payments zone contains information about the payment zone for a site and country.
+ */
+declare class SalesforcePaymentsZone {
+    /**
+     * Returns `true` if Afterpay Clearpay presentment is enabled, or `false` if not.
+     */
+    readonly afterpayClearpayEnabled: boolean;
+    /**
+     * Returns `true` if Apple Pay presentment is enabled, or `false` if not.
+     */
+    readonly applePayEnabled: boolean;
+    /**
+     * Returns `true` if Bancontact presentment is enabled, or `false` if not. Note: For Adyen
+     * merchant accounts, this setting refers to the "Bancontact Card" payment method.
+     */
+    readonly bancontactEnabled: boolean;
+    /**
+     * Returns `true` if Bancontact Mobile presentment is enabled, or `false` if not. Note: This
+     * setting is only applicable for Adyen Merchant Accounts
+     */
+    readonly bancontactMobileEnabled: boolean;
+    /**
+     * Returns `true` if credit card presentment is enabled, or `false` if not.
+     */
+    readonly cardEnabled: boolean;
+    /**
+     * Returns `true` if EPS presentment is enabled, or `false` if not.
+     */
+    readonly epsEnabled: boolean;
+    /**
+     * Returns `true` if iDEAL presentment is enabled, or `false` if not.
+     */
+    readonly idealEnabled: boolean;
+    /**
+     * Returns `true` if Klarna presentment is enabled, or `false` if not. Note: For Adyen
+     * merchant accounts, this setting applies to the Klarna Pay Later payment method.
+     */
+    readonly klarnaEnabled: boolean;
+    /**
+     * Returns `true` if Klarna Pay in Installments presentment is enabled, or `false` if not.
+     * Note: This setting is only applicable for Adyen Merchant Accounts.
+     */
+    readonly klarnaPayInInstallmentsEnabled: boolean;
+    /**
+     * Returns `true` if Klarna Pay Now presentment is enabled, or `false` if not. Note: This
+     * setting is only applicable for Adyen Merchant Accounts.
+     */
+    readonly klarnaPayNowEnabled: boolean;
+    /**
+     * Returns `true` if PayPal multi-step checkout presentment is enabled, or `false` if not.
+     */
+    readonly payPalEnabled: boolean;
+    /**
+     * Returns `true` if PayPal express checkout presentment is enabled, or `false` if not.
+     */
+    readonly payPalExpressEnabled: boolean;
+    /**
+     * Returns `true` if W3C Payment Request API button presentment is enabled, or `false` if not.
+     */
+    readonly paymentRequestEnabled: boolean;
+    /**
+     * Returns `true` if SEPA Debit presentment is enabled, or `false` if not.
+     */
+    readonly sepaDebitEnabled: boolean;
+    /**
+     * Returns `true` if Venmo multi-step checkout presentment is enabled, or `false` if not.
+     */
+    readonly venmoEnabled: boolean;
+    /**
+     * Returns `true` if Venmo express checkout presentment is enabled, or `false` if not.
+     */
+    readonly venmoExpressEnabled: boolean;
+    /**
+     * Returns the id of the payments zone.
+     */
+    readonly zoneId: string;
+    private constructor();
+    /**
+     * Returns a collection containing the merchant account payment methods to be presented for this payments zone.
+     */
+    getPaymentMethods(countryCode: string, amount: Money): Collection<any>;
+    /**
+     * Returns the id of the payments zone.
+     */
+    getZoneId(): string;
+    /**
+     * Returns `true` if Afterpay Clearpay presentment is enabled, or `false` if not.
+     */
+    isAfterpayClearpayEnabled(): boolean;
+    /**
+     * Returns `true` if Apple Pay presentment is enabled, or `false` if not.
+     */
+    isApplePayEnabled(): boolean;
+    /**
+     * Returns `true` if Bancontact presentment is enabled, or `false` if not. Note: For Adyen
+     * merchant accounts, this setting refers to the "Bancontact Card" payment method.
+     */
+    isBancontactEnabled(): boolean;
+    /**
+     * Returns `true` if Bancontact Mobile presentment is enabled, or `false` if not. Note: This
+     * setting is only applicable for Adyen Merchant Accounts
+     */
+    isBancontactMobileEnabled(): boolean;
+    /**
+     * Returns `true` if credit card presentment is enabled, or `false` if not.
+     */
+    isCardEnabled(): boolean;
+    /**
+     * Returns `true` if EPS presentment is enabled, or `false` if not.
+     */
+    isEpsEnabled(): boolean;
+    /**
+     * Returns `true` if iDEAL presentment is enabled, or `false` if not.
+     */
+    isIdealEnabled(): boolean;
+    /**
+     * Returns `true` if Klarna presentment is enabled, or `false` if not. Note: For Adyen
+     * merchant accounts, this setting applies to the Klarna Pay Later payment method.
+     */
+    isKlarnaEnabled(): boolean;
+    /**
+     * Returns `true` if Klarna Pay in Installments presentment is enabled, or `false` if not.
+     * Note: This setting is only applicable for Adyen Merchant Accounts.
+     */
+    isKlarnaPayInInstallmentsEnabled(): boolean;
+    /**
+     * Returns `true` if Klarna Pay Now presentment is enabled, or `false` if not. Note: This
+     * setting is only applicable for Adyen Merchant Accounts.
+     */
+    isKlarnaPayNowEnabled(): boolean;
+    /**
+     * Returns `true` if PayPal multi-step checkout presentment is enabled, or `false` if not.
+     */
+    isPayPalEnabled(): boolean;
+    /**
+     * Returns `true` if PayPal express checkout presentment is enabled, or `false` if not.
+     */
+    isPayPalExpressEnabled(): boolean;
+    /**
+     * Returns `true` if W3C Payment Request API button presentment is enabled, or `false` if not.
+     */
+    isPaymentRequestEnabled(): boolean;
+    /**
+     * Returns `true` if SEPA Debit presentment is enabled, or `false` if not.
+     */
+    isSepaDebitEnabled(): boolean;
+    /**
+     * Returns `true` if Venmo multi-step checkout presentment is enabled, or `false` if not.
+     */
+    isVenmoEnabled(): boolean;
+    /**
+     * Returns `true` if Venmo express checkout presentment is enabled, or `false` if not.
+     */
+    isVenmoExpressEnabled(): boolean;
+}
+
+export = SalesforcePaymentsZone;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/extensions/payments/SalesforceSepaDebitPaymentDetails.d.ts

@@ -0,0 +1,23 @@
+import SalesforcePaymentDetails = require('./SalesforcePaymentDetails');
+
+/**
+ * 
+ * 
+ * Details to a Salesforce Payments payment of type SalesforcePaymentMethod.TYPE_SEPA_DEBIT. See Salesforce Payments
+ * documentation for how to gain access and configure it for use on your sites.
+ */
+declare class SalesforceSepaDebitPaymentDetails extends SalesforcePaymentDetails {
+    /**
+     * Returns the last 4 digits of the account number, or `null` if not known.
+     * @see SalesforcePaymentMethod.getLast4
+     */
+    readonly last4: string | null;
+    private constructor();
+    /**
+     * Returns the last 4 digits of the account number, or `null` if not known.
+     * @see SalesforcePaymentMethod.getLast4
+     */
+    getLast4(): string | null;
+}
+
+export = SalesforceSepaDebitPaymentDetails;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/extensions/payments/SalesforceVenmoPaymentDetails.d.ts

@@ -0,0 +1,33 @@
+import SalesforcePaymentDetails = require('./SalesforcePaymentDetails');
+
+/**
+ * 
+ * 
+ * Details to a Salesforce Payments payment of type SalesforcePayPalOrder.TYPE_VENMO. See Salesforce Payments
+ * documentation for how to gain access and configure it for use on your sites.
+ */
+declare class SalesforceVenmoPaymentDetails extends SalesforcePaymentDetails {
+    /**
+     * Returns the ID of the capture against the PayPal Venmo order, or `null` if not known.
+     * @see SalesforcePayPalOrder.getCaptureID
+     */
+    readonly captureID: string | null;
+    /**
+     * Returns the email address of the payer for the PayPal Venmo order, or `null` if not known.
+     * @see SalesforcePayPalOrderPayer.getEmailAddress
+     */
+    readonly payerEmailAddress: string | null;
+    private constructor();
+    /**
+     * Returns the ID of the capture against the PayPal Venmo order, or `null` if not known.
+     * @see SalesforcePayPalOrder.getCaptureID
+     */
+    getCaptureID(): string | null;
+    /**
+     * Returns the email address of the payer for the PayPal Venmo order, or `null` if not known.
+     * @see SalesforcePayPalOrderPayer.getEmailAddress
+     */
+    getPayerEmailAddress(): string | null;
+}
+
+export = SalesforceVenmoPaymentDetails;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/extensions/payments/index.d.ts

@@ -0,0 +1,49 @@
+import SalesforceAdyenPaymentIntent = require('./SalesforceAdyenPaymentIntent');
+import SalesforceAdyenSavedPaymentMethod = require('./SalesforceAdyenSavedPaymentMethod');
+import SalesforceBancontactPaymentDetails = require('./SalesforceBancontactPaymentDetails');
+import SalesforceCardPaymentDetails = require('./SalesforceCardPaymentDetails');
+import SalesforceEpsPaymentDetails = require('./SalesforceEpsPaymentDetails');
+import SalesforceIdealPaymentDetails = require('./SalesforceIdealPaymentDetails');
+import SalesforceKlarnaPaymentDetails = require('./SalesforceKlarnaPaymentDetails');
+import SalesforcePayPalOrder = require('./SalesforcePayPalOrder');
+import SalesforcePayPalOrderAddress = require('./SalesforcePayPalOrderAddress');
+import SalesforcePayPalOrderPayer = require('./SalesforcePayPalOrderPayer');
+import SalesforcePayPalPaymentDetails = require('./SalesforcePayPalPaymentDetails');
+import SalesforcePaymentDetails = require('./SalesforcePaymentDetails');
+import SalesforcePaymentIntent = require('./SalesforcePaymentIntent');
+import SalesforcePaymentMethod = require('./SalesforcePaymentMethod');
+import SalesforcePaymentRequest = require('./SalesforcePaymentRequest');
+import SalesforcePaymentsHooks = require('./SalesforcePaymentsHooks');
+import SalesforcePaymentsMerchantAccount = require('./SalesforcePaymentsMerchantAccount');
+import SalesforcePaymentsMerchantAccountPaymentMethod = require('./SalesforcePaymentsMerchantAccountPaymentMethod');
+import SalesforcePaymentsMgr = require('./SalesforcePaymentsMgr');
+import SalesforcePaymentsSiteConfiguration = require('./SalesforcePaymentsSiteConfiguration');
+import SalesforcePaymentsZone = require('./SalesforcePaymentsZone');
+import SalesforceSepaDebitPaymentDetails = require('./SalesforceSepaDebitPaymentDetails');
+import SalesforceVenmoPaymentDetails = require('./SalesforceVenmoPaymentDetails');
+
+export {
+    SalesforceAdyenPaymentIntent,
+    SalesforceAdyenSavedPaymentMethod,
+    SalesforceBancontactPaymentDetails,
+    SalesforceCardPaymentDetails,
+    SalesforceEpsPaymentDetails,
+    SalesforceIdealPaymentDetails,
+    SalesforceKlarnaPaymentDetails,
+    SalesforcePayPalOrder,
+    SalesforcePayPalOrderAddress,
+    SalesforcePayPalOrderPayer,
+    SalesforcePayPalPaymentDetails,
+    SalesforcePaymentDetails,
+    SalesforcePaymentIntent,
+    SalesforcePaymentMethod,
+    SalesforcePaymentRequest,
+    SalesforcePaymentsHooks,
+    SalesforcePaymentsMerchantAccount,
+    SalesforcePaymentsMerchantAccountPaymentMethod,
+    SalesforcePaymentsMgr,
+    SalesforcePaymentsSiteConfiguration,
+    SalesforcePaymentsZone,
+    SalesforceSepaDebitPaymentDetails,
+    SalesforceVenmoPaymentDetails
+};

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/extensions/pinterest/PinterestAvailability.d.ts

@@ -0,0 +1,34 @@
+/**
+ * Represents a row in the Pinterest availability feed export file.
+ */
+declare class PinterestAvailability {
+    /**
+     * Returns the ID of the Pinterest product. This is the same as the ID of the Demandware product.
+     */
+    readonly ID: string;
+    /**
+     * Returns the availability of the Pinterest product. Possible values are
+     * dw.extensions.pinterest.PinterestProduct.AVAILABILITY_IN_STOCK or
+     * dw.extensions.pinterest.PinterestProduct.AVAILABILITY_OUT_OF_STOCK.
+     */
+    availability: string;
+    private constructor();
+    /**
+     * Returns the availability of the Pinterest product. Possible values are
+     * dw.extensions.pinterest.PinterestProduct.AVAILABILITY_IN_STOCK or
+     * dw.extensions.pinterest.PinterestProduct.AVAILABILITY_OUT_OF_STOCK.
+     */
+    getAvailability(): string;
+    /**
+     * Returns the ID of the Pinterest product. This is the same as the ID of the Demandware product.
+     */
+    getID(): string;
+    /**
+     * Sets the availability of the Pinterest product. Possible values are
+     * dw.extensions.pinterest.PinterestProduct.AVAILABILITY_IN_STOCK or
+     * dw.extensions.pinterest.PinterestProduct.AVAILABILITY_OUT_OF_STOCK.
+     */
+    setAvailability(availability: string): void;
+}
+
+export = PinterestAvailability;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/extensions/pinterest/PinterestFeedHooks.d.ts

@@ -0,0 +1,54 @@
+import Status = require('../../system/Status');
+import Product = require('../../catalog/Product');
+import PinterestProduct = require('./PinterestProduct');
+import PinterestAvailability = require('./PinterestAvailability');
+
+/**
+ * PinterestFeedHooks interface containing extension points for customizing Pinterest export feeds.
+ * 
+ * These hooks are not executed in a transaction.
+ * 
+ * The extension points (hook names), and the functions that are called by each extension point. A function must be
+ * defined inside a JavaScript source and must be exported. The script with the exported hook function must be located
+ * inside a site cartridge. Inside the site cartridge a 'package.json' file with a 'hooks' entry must exist.
+ * 
+ * ```
+ * "hooks": "./hooks.json"
+ * ```
+ * 
+ * The hooks entry links to a json file, relative to the 'package.json' file. This file lists all registered hooks
+ * inside the hooks property:
+ * 
+ * ```
+ * "hooks": [
+ * {"name": "dw.extensions.pinterest.feed.transformProduct", "script": "./hooks.ds"}
+ * ]
+ * ```
+ * 
+ * A hook entry has a 'name' and a 'script' property.
+ * 
+ * - The 'name' contains the extension point, the hook name.
+ * - The 'script' contains the script relative to the hooks file, with the exported hook function.
+ */
+declare interface PinterestFeedHooks {
+    /**
+     * The extension point name extensionPointTransformAvailability.
+     */
+    readonly extensionPointTransformAvailability: "dw.extensions.pinterest.feed.transformAvailability";
+    /**
+     * The extension point name extensionPointTransformProduct.
+     */
+    readonly extensionPointTransformProduct: "dw.extensions.pinterest.feed.transformProduct";
+    /**
+     * Called after default transformation of given Demandware product to Pinterest availability as part of the
+     * availability feed export.
+     */
+    transformAvailability(product: Product<any>, pinterestAvailability: PinterestAvailability): Status;
+    /**
+     * Called after default transformation of given Demandware product to Pinterest product as part of the catalog feed
+     * export.
+     */
+    transformProduct(product: Product<any>, pinterestProduct: PinterestProduct): Status;
+}
+
+export = PinterestFeedHooks;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/extensions/pinterest/PinterestOrder.d.ts

@@ -0,0 +1,122 @@
+/**
+ * An order that was placed through Pinterest.
+ */
+declare class PinterestOrder {
+    /**
+     * Indicates that payment has not been made.
+     */
+    static readonly PAYMENT_STATUS_NOT_PAID: string;
+    /**
+     * Indicates that payment is complete.
+     */
+    static readonly PAYMENT_STATUS_PAID: string;
+    /**
+     * Indicates that payment is incomplete.
+     */
+    static readonly PAYMENT_STATUS_PART_PAID: string;
+    /**
+     * Indicates an order on backorder.
+     */
+    static readonly STATUS_BACKORDER: string;
+    /**
+     * Indicates an order that has been canceled.
+     */
+    static readonly STATUS_CANCELLED: string;
+    /**
+     * Indicates an order that has been delivered.
+     */
+    static readonly STATUS_DELIVERED: string;
+    /**
+     * Indicates an order in progress.
+     */
+    static readonly STATUS_IN_PROGRESS: string;
+    /**
+     * Indicates a new order.
+     */
+    static readonly STATUS_NEW: string;
+    /**
+     * Indicates an order that has been returned.
+     */
+    static readonly STATUS_RETURNED: string;
+    /**
+     * Indicates an order that has shipped.
+     */
+    static readonly STATUS_SHIPPED: string;
+    /**
+     * Returns the item ID for this Pinterest order.
+     */
+    itemId: string;
+    /**
+     * Returns the order number for this Pinterest order. This is the same as the order number of the Demandware order.
+     */
+    readonly orderNo: string;
+    /**
+     * Returns the status of this Pinterest order. Possible values are
+     * dw.extensions.pinterest.PinterestOrder.PAYMENT_STATUS_PAID,
+     * dw.extensions.pinterest.PinterestOrder.PAYMENT_STATUS_NOT_PAID,
+     * or dw.extensions.pinterest.PinterestOrder.PAYMENT_STATUS_PART_PAID.
+     */
+    paymentStatus: string;
+    /**
+     * Returns the status of this Pinterest order. Possible values are
+     * dw.extensions.pinterest.PinterestOrder.STATUS_NEW,
+     * dw.extensions.pinterest.PinterestOrder.STATUS_IN_PROGRESS,
+     * dw.extensions.pinterest.PinterestOrder.STATUS_SHIPPED,
+     * dw.extensions.pinterest.PinterestOrder.STATUS_BACKORDER,
+     * dw.extensions.pinterest.PinterestOrder.STATUS_CANCELLED,
+     * dw.extensions.pinterest.PinterestOrder.STATUS_DELIVERED,
+     * or dw.extensions.pinterest.PinterestOrder.STATUS_RETURNED.
+     */
+    status: string;
+    private constructor();
+    /**
+     * Returns the item ID for this Pinterest order.
+     */
+    getItemId(): string;
+    /**
+     * Returns the order number for this Pinterest order. This is the same as the order number of the Demandware order.
+     */
+    getOrderNo(): string;
+    /**
+     * Returns the status of this Pinterest order. Possible values are
+     * dw.extensions.pinterest.PinterestOrder.PAYMENT_STATUS_PAID,
+     * dw.extensions.pinterest.PinterestOrder.PAYMENT_STATUS_NOT_PAID,
+     * or dw.extensions.pinterest.PinterestOrder.PAYMENT_STATUS_PART_PAID.
+     */
+    getPaymentStatus(): string;
+    /**
+     * Returns the status of this Pinterest order. Possible values are
+     * dw.extensions.pinterest.PinterestOrder.STATUS_NEW,
+     * dw.extensions.pinterest.PinterestOrder.STATUS_IN_PROGRESS,
+     * dw.extensions.pinterest.PinterestOrder.STATUS_SHIPPED,
+     * dw.extensions.pinterest.PinterestOrder.STATUS_BACKORDER,
+     * dw.extensions.pinterest.PinterestOrder.STATUS_CANCELLED,
+     * dw.extensions.pinterest.PinterestOrder.STATUS_DELIVERED,
+     * or dw.extensions.pinterest.PinterestOrder.STATUS_RETURNED.
+     */
+    getStatus(): string;
+    /**
+     * Sets the item ID for this Pinterest order.
+     */
+    setItemId(itemId: string): void;
+    /**
+     * Sets the status of this Pinterest order. Possible values are
+     * dw.extensions.pinterest.PinterestOrder.PAYMENT_STATUS_PAID,
+     * dw.extensions.pinterest.PinterestOrder.PAYMENT_STATUS_NOT_PAID,
+     * or dw.extensions.pinterest.PinterestOrder.PAYMENT_STATUS_PART_PAID.
+     */
+    setPaymentStatus(status: string): void;
+    /**
+     * Sets the status of this Pinterest order. Possible values are
+     * dw.extensions.pinterest.PinterestOrder.STATUS_NEW,
+     * dw.extensions.pinterest.PinterestOrder.STATUS_IN_PROGRESS,
+     * dw.extensions.pinterest.PinterestOrder.STATUS_SHIPPED,
+     * dw.extensions.pinterest.PinterestOrder.STATUS_BACKORDER,
+     * dw.extensions.pinterest.PinterestOrder.STATUS_CANCELLED,
+     * dw.extensions.pinterest.PinterestOrder.STATUS_DELIVERED,
+     * or dw.extensions.pinterest.PinterestOrder.STATUS_RETURNED.
+     */
+    setStatus(status: string): void;
+}
+
+export = PinterestOrder;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/extensions/pinterest/PinterestOrderHooks.d.ts

@@ -0,0 +1,42 @@
+import Status = require('../../system/Status');
+import PinterestOrder = require('./PinterestOrder');
+
+/**
+ * PinterestOrderHooks interface containing extension points for customizing Pinterest order status.
+ * 
+ * These hooks are not executed in a transaction.
+ * 
+ * The extension points (hook names), and the functions that are called by each extension point. A function must be
+ * defined inside a JavaScript source and must be exported. The script with the exported hook function must be located
+ * inside a site cartridge. Inside the site cartridge a 'package.json' file with a 'hooks' entry must exist.
+ * 
+ * ```
+ * "hooks": "./hooks.json"
+ * ```
+ * 
+ * The hooks entry links to a json file, relative to the 'package.json' file. This file lists all registered hooks
+ * inside the hooks property:
+ * 
+ * ```
+ * "hooks": [
+ * {"name": "dw.extensions.pinterest.order.getStatus", "script": "./hooks.ds"}
+ * ]
+ * ```
+ * 
+ * A hook entry has a 'name' and a 'script' property.
+ * 
+ * - The 'name' contains the extension point, the hook name.
+ * - The 'script' contains the script relative to the hooks file, with the exported hook function.
+ */
+declare interface PinterestOrderHooks {
+    /**
+     * The extension point name extensionPointGetStatus.
+     */
+    readonly extensionPointGetStatus: "dw.extensions.pinterest.order.getStatus";
+    /**
+     * Called to retrieve status for the given order. Return a `null` status for unknown orders.
+     */
+    getStatus(order: PinterestOrder): Status;
+}
+
+export = PinterestOrderHooks;