@salesforce/b2c-cli 1.10.0 → 1.12.0

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/customer/CustomerPaymentInstrument.d.ts

@@ -0,0 +1,118 @@
+import PaymentInstrument = require('../order/PaymentInstrument');
+import ExtensibleObject = require('../object/ExtensibleObject');
+import CustomAttributes = require('../object/CustomAttributes');
+
+declare global {
+    module ICustomAttributes {
+        interface CustomerPaymentInstrument extends ICustomAttributes.PaymentInstrument {
+        }
+    }
+}
+
+/**
+ * Represents any payment instrument stored in the customers profile, such as
+ * credit card or bank transfer. The object defines standard methods for credit
+ * card payment, and can be extended by attributes appropriate for other
+ * payment methods.
+ */
+declare class CustomerPaymentInstrument extends PaymentInstrument<ICustomAttributes.CustomerPaymentInstrument> {
+    /**
+     * Returns the driver's license number of the bank account number
+     * if the calling context meets the following criteria:
+     * 
+     * -
+     * If the method call happens in the context of a storefront request and
+     * the current customer is registered and authenticated, and the payment
+     * instrument is associated to the profile of the current customer, and
+     * the current protocol is HTTPS
+     * 
+     * Otherwise, the method returns the masked driver's license number of the bank account.
+     * 
+     * Note: this method handles sensitive financial and card holder data.
+     * Pay special attention to PCI DSS v3. requirements 1, 3, 7, and 9.
+     */
+    readonly bankAccountDriversLicense: string;
+    /**
+     * Returns the bank account number if the calling context meets
+     * the following criteria:
+     * 
+     * -
+     * If the method call happens in the context of a storefront request,
+     * the current customer is registered and authenticated, the payment
+     * instrument is associated to the profile of the current customer, and
+     * the current protocol is HTTPS
+     * 
+     * Otherwise, the method returns the masked bank account number.
+     * 
+     * Note: this method handles sensitive financial and card holder data.
+     * Pay special attention to PCI DSS v3. requirements 1, 3, 7, and 9.
+     */
+    readonly bankAccountNumber: string;
+    /**
+     * Returns the decrypted credit card number if the calling context meets
+     * the following criteria:
+     * 
+     * -
+     * If the method call happens in the context of a storefront request,
+     * the current customer is registered and authenticated, the payment
+     * instrument is associated to the profile of the current customer, and
+     * the current protocol is HTTPS.
+     * 
+     * Otherwise, the method returns the masked credit card number.
+     * 
+     * Note: this method handles sensitive financial and card holder data.
+     * Pay special attention to PCI DSS v3. requirements 1, 3, 7, and 9.
+     */
+    readonly creditCardNumber: string;
+    private constructor();
+    /**
+     * Returns the driver's license number of the bank account number
+     * if the calling context meets the following criteria:
+     * 
+     * -
+     * If the method call happens in the context of a storefront request and
+     * the current customer is registered and authenticated, and the payment
+     * instrument is associated to the profile of the current customer, and
+     * the current protocol is HTTPS
+     * 
+     * Otherwise, the method returns the masked driver's license number of the bank account.
+     * 
+     * Note: this method handles sensitive financial and card holder data.
+     * Pay special attention to PCI DSS v3. requirements 1, 3, 7, and 9.
+     */
+    getBankAccountDriversLicense(): string;
+    /**
+     * Returns the bank account number if the calling context meets
+     * the following criteria:
+     * 
+     * -
+     * If the method call happens in the context of a storefront request,
+     * the current customer is registered and authenticated, the payment
+     * instrument is associated to the profile of the current customer, and
+     * the current protocol is HTTPS
+     * 
+     * Otherwise, the method returns the masked bank account number.
+     * 
+     * Note: this method handles sensitive financial and card holder data.
+     * Pay special attention to PCI DSS v3. requirements 1, 3, 7, and 9.
+     */
+    getBankAccountNumber(): string;
+    /**
+     * Returns the decrypted credit card number if the calling context meets
+     * the following criteria:
+     * 
+     * -
+     * If the method call happens in the context of a storefront request,
+     * the current customer is registered and authenticated, the payment
+     * instrument is associated to the profile of the current customer, and
+     * the current protocol is HTTPS.
+     * 
+     * Otherwise, the method returns the masked credit card number.
+     * 
+     * Note: this method handles sensitive financial and card holder data.
+     * Pay special attention to PCI DSS v3. requirements 1, 3, 7, and 9.
+     */
+    getCreditCardNumber(): string;
+}
+
+export = CustomerPaymentInstrument;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/customer/CustomerStatusCodes.d.ts

@@ -0,0 +1,17 @@
+/**
+ * CustomerStatusCodes contains constants representing
+ * status codes that can be used with a Status object to
+ * indicate the success or failure of an operation.
+ * @see dw.system.Status
+ */
+declare class CustomerStatusCodes {
+    /**
+     * Indicates that an error occurred when trying to perform
+     * an operation on an address that is currently associated
+     * with a product list.
+     */
+    static readonly CUSTOMER_ADDRESS_REFERENCED_BY_PRODUCT_LIST = "CUSTOMER_ADDRESS_REFERENCED_BY_PRODUCT_LIST";
+    private constructor();
+}
+
+export = CustomerStatusCodes;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/customer/EncryptedObject.d.ts

@@ -0,0 +1,21 @@
+import ExtensibleObject = require('../object/ExtensibleObject');
+import CustomAttributes = require('../object/CustomAttributes');
+
+declare global {
+    module ICustomAttributes {
+        interface EncryptedObject extends CustomAttributes {
+        }
+    }
+}
+
+/**
+ * Defines a API base class for classes containing
+ * encrypted attributes like credit cards.
+ * 
+ * Note: this method handles sensitive financial and card holder data.
+ * Pay special attention to PCI DSS v3. requirements 1, 3, 7, and 9.
+ */
+declare abstract class EncryptedObject<T extends ICustomAttributes.EncryptedObject = ICustomAttributes.EncryptedObject> extends ExtensibleObject<T> {
+}
+
+export = EncryptedObject;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/customer/ExternalProfile.d.ts

@@ -0,0 +1,70 @@
+import Customer = require('./Customer');
+
+/**
+ * Represents the credentials of a customer.
+ * 
+ * Since 13.6 it is possible to have customers who are not authenticated through a
+ * login and password but through an external authentication provider via the OAuth2 protocol.
+ * 
+ * In such cases, the AuthenticationProviderID will point to an OAuth provider configured in the system
+ * and the ExternalID will be the unique identifier of the customer on the Authentication Provider's system.
+ * 
+ * For example, if an authentication provider with ID "Google123" is configured pointing to Google
+ * and the customer has a logged in into Google in the past and has created a profile there, Google
+ * assigns a unique number identifier to that customer. If the storefront is configured to allow
+ * authentication through Google and a new customer logs into the storefront using Google,
+ * the AuthenticationProviderID property of his Credentials will contain "Google123" and
+ * the ExternalID property will contain whatever unique identifier Google has assigned to him.
+ * 
+ * Note: this class handles sensitive security-related data.
+ * Pay special attention to PCI DSS v3. requirements 2, 4, and 12.
+ */
+declare class ExternalProfile {
+    /**
+     * Returns the authentication provider ID.
+     */
+    readonly authenticationProviderID: string;
+    /**
+     * Returns the customer object related to this profile.
+     */
+    readonly customer: Customer;
+    /**
+     * Returns the customer's email address.
+     */
+    email: string;
+    /**
+     * Returns the external ID.
+     */
+    readonly externalID: string;
+    /**
+     * Returns the last login time of the customer through the external provider
+     */
+    readonly lastLoginTime: Date;
+    private constructor();
+    /**
+     * Returns the authentication provider ID.
+     */
+    getAuthenticationProviderID(): string;
+    /**
+     * Returns the customer object related to this profile.
+     */
+    getCustomer(): Customer;
+    /**
+     * Returns the customer's email address.
+     */
+    getEmail(): string;
+    /**
+     * Returns the external ID.
+     */
+    getExternalID(): string;
+    /**
+     * Returns the last login time of the customer through the external provider
+     */
+    getLastLoginTime(): Date;
+    /**
+     * Sets the customer's email address.
+     */
+    setEmail(email: string): void;
+}
+
+export = ExternalProfile;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/customer/OrderHistory.d.ts

@@ -0,0 +1,81 @@
+import SeekableIterator = require('../util/SeekableIterator');
+import Order = require('../order/Order');
+
+/**
+ * The class provides access to past orders of the customer.
+ * 
+ * Note: This class allows access to sensitive financial and cardholder data. Pay special attention to PCI DSS
+ * v3. requirements 1, 3, 7, and 9. It also allows access to sensitive personal and private information. Pay attention
+ * to appropriate legal and regulatory requirements related to this data.
+ * Note: The following methods do not work with Salesforce Order Management orders.
+ */
+declare class OrderHistory {
+    /**
+     * Returns the number of orders the customer has placed in the store.
+     * 
+     * If the customer is anonymous, this method always returns zero. If an active data record is available for this
+     * customer, the orders count is retrieved from that record, otherwise a real-time query is used to get the count.
+     */
+    readonly orderCount: number;
+    /**
+     * Retrieves the order history for the customer in the current storefront site.
+     * 
+     * If the result exceeds 1000 orders, only the first 1000 orders are retrieved. Same as
+     * 
+     * ```
+     * orderHistory.getOrders( null, "creationDate DESC" )
+     * ```
+     * 
+     * It is strongly recommended to call `dw.util.SeekableIterator.close` on the returned
+     * SeekableIterator if not all of its elements are being retrieved. This will ensure the proper cleanup of system
+     * resources.
+     * @see getOrders
+     */
+    readonly orders: SeekableIterator<Order>;
+    private constructor();
+    /**
+     * Returns the number of orders the customer has placed in the store.
+     * 
+     * If the customer is anonymous, this method always returns zero. If an active data record is available for this
+     * customer, the orders count is retrieved from that record, otherwise a real-time query is used to get the count.
+     */
+    getOrderCount(): number;
+    /**
+     * Retrieves the order history for the customer in the current storefront site.
+     * 
+     * If the result exceeds 1000 orders, only the first 1000 orders are retrieved. Same as
+     * 
+     * ```
+     * orderHistory.getOrders( null, "creationDate DESC" )
+     * ```
+     * 
+     * It is strongly recommended to call `dw.util.SeekableIterator.close` on the returned
+     * SeekableIterator if not all of its elements are being retrieved. This will ensure the proper cleanup of system
+     * resources.
+     * @see getOrders
+     */
+    getOrders(): SeekableIterator<Order>;
+    /**
+     * Retrieves the order history for the customer in the current storefront site.
+     * 
+     * If the result exceeds 1000 orders, only the first 1000 orders are retrieved. Optionally, you can retrieve a subset
+     * of the orders by specifying a query. At maximum 3 expressions are allowed to be specified and no custom attribute
+     * expressions are allowed.
+     * 
+     * It is strongly recommended to call `dw.util.SeekableIterator.close` on the returned
+     * SeekableIterator if not all of its elements are being retrieved. This will ensure the proper cleanup of system
+     * resources.
+     * 
+     * Example:
+     * @example
+     * var orderHistory : dw.customer.OrderHistory = customer.getOrderHistory();
+     * var orders = orderHistory.getOrders("status = {0}", "creationDate DESC", dw.order.Order.ORDER_STATUS_NEW);
+     * for each (var order : dw.order.Order in orders) {
+     * // ... process orders
+     * }
+     * orders.close();
+     */
+    getOrders(query: string, sortString: string, ...params: any[]): SeekableIterator<Order>;
+}
+
+export = OrderHistory;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/customer/ProductList.d.ts

@@ -0,0 +1,376 @@
+import ExtensibleObject = require('../object/ExtensibleObject');
+import CustomAttributes = require('../object/CustomAttributes');
+import EnumValue = require('../value/EnumValue');
+import ProductListItem = require('./ProductListItem');
+import Collection = require('../util/Collection');
+import Product = require('../catalog/Product');
+import ProductListRegistrant = require('./ProductListRegistrant');
+import CustomerAddress = require('./CustomerAddress');
+import ProductListItemPurchase = require('./ProductListItemPurchase');
+import Customer = require('./Customer');
+
+declare global {
+    module ICustomAttributes {
+        interface ProductList extends CustomAttributes {
+        }
+    }
+}
+
+/**
+ * Represents a list of products (and optionally a gift certificate) that is
+ * typically maintained by a customer.  This class can be used to implement
+ * a number of different storefront features, e.g. shopping list, wish list and gift registry.
+ * A product list is always owned by a customer. The owner can be anonymous or a registered customer.
+ * The owner can be the person for which items from that list will be purchased (wish list).
+ * Or it can be a person who maintains the list, for example a gift registry, on behalf of the bridal couple.
+ * Each product list can have a registrant and a co-registrant. A registrant is typically associated with an event related product list
+ * such as a gift registry. It holds information about a person associated with the
+ * event such as a bride or groom.
+ * A shipping address can be associated with this product list to ship the items,
+ * e.g. to an event location. A post-event shipping address can be associated to
+ * ship items to which could not be delivered on event date.
+ * The product list can also hold information about the event date and event location.
+ */
+declare class ProductList extends ExtensibleObject<ICustomAttributes.ProductList> {
+    /**
+     * Constant for when Export Status is Exported
+     */
+    static readonly EXPORT_STATUS_EXPORTED: number;
+    /**
+     * Constant for when Export Status is Not Exported
+     */
+    static readonly EXPORT_STATUS_NOTEXPORTED: number;
+    /**
+     * Constant representing a custom list type attribute.
+     */
+    static readonly TYPE_CUSTOM_1: number;
+    /**
+     * Constant representing a custom list type attribute.
+     */
+    static readonly TYPE_CUSTOM_2: number;
+    /**
+     * Constant representing a custom list type attribute.
+     */
+    static readonly TYPE_CUSTOM_3: number;
+    /**
+     * Constant representing the gift registry type attribute.
+     */
+    static readonly TYPE_GIFT_REGISTRY: number;
+    /**
+     * Constant representing the shopping list type attribute.
+     */
+    static readonly TYPE_SHOPPING_LIST: number;
+    /**
+     * Constant representing the wish list registry type attribute.
+     */
+    static readonly TYPE_WISH_LIST: number;
+    /**
+     * Returns the unique system generated ID of the object.
+     */
+    readonly ID: string;
+    /**
+     * Returns true if this product list is owned by an anonymous customer.
+     */
+    readonly anonymous: boolean;
+    /**
+     * Returns the ProductListRegistrant assigned to the coRegistrant attribute or null
+     * if this list has no co-registrant.
+     */
+    readonly coRegistrant: ProductListRegistrant | null;
+    /**
+     * This is a helper method typically used with an event related list.
+     * It provides the appropriate shipping address based on the eventDate.
+     * If the current date is after the eventDate, then the postEventShippingAddress
+     * is returned, otherwise the shippingAddress is returned.  If the eventDate
+     * is null, then null is returned.
+     */
+    readonly currentShippingAddress: CustomerAddress | null;
+    /**
+     * Returns a description text that, for example, explains the purpose of this product list.
+     */
+    description: string;
+    /**
+     * For event related uses (e.g. gift registry), this holds the event city.
+     */
+    eventCity: string;
+    /**
+     * For event related uses (e.g. gift registry), this holds the event country.
+     */
+    eventCountry: string;
+    /**
+     * For event related uses (e.g. gift registry), this holds the date
+     * of the event.
+     */
+    eventDate: Date;
+    /**
+     * For event related uses (e.g. gift registry), this holds the event state.
+     */
+    eventState: string;
+    /**
+     * For event related uses (e.g. gift registry), this holds the type
+     * of event, e.g. Wedding, Baby Shower.
+     */
+    eventType: string;
+    /**
+     * Returns the export status of the product list.
+     * 
+     * Possible values are: EXPORT_STATUS_NOTEXPORTED,
+     * EXPORT_STATUS_EXPORTED.
+     */
+    readonly exportStatus: EnumValue;
+    /**
+     * Returns the item in the list that represents a gift certificate.
+     */
+    readonly giftCertificateItem: ProductListItem | null;
+    /**
+     * Returns a collection containing all items in the list.
+     */
+    readonly items: Collection<ProductListItem>;
+    /**
+     * Returns the date where this product list has been exported successfully
+     * the last time.
+     */
+    readonly lastExportTime: Date | null;
+    /**
+     * Returns the name of this product list given by its owner.
+     */
+    name: string;
+    /**
+     * Returns the customer that created and owns the product list.
+     */
+    readonly owner: Customer;
+    /**
+     * Returns the shipping address for purchases made after the event date.
+     */
+    postEventShippingAddress: CustomerAddress | null;
+    /**
+     * Returns a collection containing all items in the list that reference products.
+     */
+    readonly productItems: Collection<ProductListItem>;
+    /**
+     * A flag, typically used to determine if the object is searchable
+     * by other customers.
+     */
+    public: boolean;
+    /**
+     * Returns a collection containing all items in the list that are flagged as public.
+     */
+    readonly publicItems: Collection<ProductListItem>;
+    /**
+     * Returns the aggregated purchases from all the individual items.
+     */
+    readonly purchases: Collection<ProductListItemPurchase>;
+    /**
+     * Returns the ProductListRegistrant assigned to the registrant attribute or null
+     * if this list has no registrant.
+     */
+    readonly registrant: ProductListRegistrant | null;
+    /**
+     * Return the address that should be used as the shipping address for purchases
+     * made from the list.
+     */
+    shippingAddress: CustomerAddress | null;
+    /**
+     * Returns an int representing the type of object (e.g. wish list,
+     * gift registry). This is set at object creation time.
+     */
+    readonly type: number;
+    private constructor();
+    /**
+     * Create a ProductListRegistrant and assign it to the coRegistrant attribute
+     * of the list.  An exception is thrown if the list already has a coRegistrant
+     * assigned to it.
+     * @throws CreateException if one already exists
+     */
+    createCoRegistrant(): ProductListRegistrant;
+    /**
+     * Create an item in the list that represents a gift certificate.
+     * A list may only contain a single gift certificate, so an exception
+     * is thrown if one already exists in the list.
+     * @throws CreateException if a gift certificate item already exists in the list.
+     */
+    createGiftCertificateItem(): ProductListItem;
+    /**
+     * Create an item in the list that references the specified product.
+     */
+    createProductItem(product: Product<any>): ProductListItem;
+    /**
+     * Create a ProductListRegistrant and assign it to the registrant attribute
+     * of the list.  An exception is thrown if the list already has a registrant
+     * assigned to it.
+     * @throws CreateException if one already exists
+     */
+    createRegistrant(): ProductListRegistrant;
+    /**
+     * Returns the ProductListRegistrant assigned to the coRegistrant attribute or null
+     * if this list has no co-registrant.
+     */
+    getCoRegistrant(): ProductListRegistrant | null;
+    /**
+     * This is a helper method typically used with an event related list.
+     * It provides the appropriate shipping address based on the eventDate.
+     * If the current date is after the eventDate, then the postEventShippingAddress
+     * is returned, otherwise the shippingAddress is returned.  If the eventDate
+     * is null, then null is returned.
+     */
+    getCurrentShippingAddress(): CustomerAddress | null;
+    /**
+     * Returns a description text that, for example, explains the purpose of this product list.
+     */
+    getDescription(): string;
+    /**
+     * For event related uses (e.g. gift registry), this holds the event city.
+     */
+    getEventCity(): string;
+    /**
+     * For event related uses (e.g. gift registry), this holds the event country.
+     */
+    getEventCountry(): string;
+    /**
+     * For event related uses (e.g. gift registry), this holds the date
+     * of the event.
+     */
+    getEventDate(): Date;
+    /**
+     * For event related uses (e.g. gift registry), this holds the event state.
+     */
+    getEventState(): string;
+    /**
+     * For event related uses (e.g. gift registry), this holds the type
+     * of event, e.g. Wedding, Baby Shower.
+     */
+    getEventType(): string;
+    /**
+     * Returns the export status of the product list.
+     * 
+     * Possible values are: EXPORT_STATUS_NOTEXPORTED,
+     * EXPORT_STATUS_EXPORTED.
+     */
+    getExportStatus(): EnumValue;
+    /**
+     * Returns the item in the list that represents a gift certificate.
+     */
+    getGiftCertificateItem(): ProductListItem | null;
+    /**
+     * Returns the unique system generated ID of the object.
+     */
+    getID(): string;
+    /**
+     * Returns the item from the list that has the specified ID.
+     */
+    getItem(ID: string): ProductListItem | null;
+    /**
+     * Returns a collection containing all items in the list.
+     */
+    getItems(): Collection<ProductListItem>;
+    /**
+     * Returns the date where this product list has been exported successfully
+     * the last time.
+     */
+    getLastExportTime(): Date | null;
+    /**
+     * Returns the name of this product list given by its owner.
+     */
+    getName(): string;
+    /**
+     * Returns the customer that created and owns the product list.
+     */
+    getOwner(): Customer;
+    /**
+     * Returns the shipping address for purchases made after the event date.
+     */
+    getPostEventShippingAddress(): CustomerAddress | null;
+    /**
+     * Returns a collection containing all items in the list that reference products.
+     */
+    getProductItems(): Collection<ProductListItem>;
+    /**
+     * Returns a collection containing all items in the list that are flagged as public.
+     */
+    getPublicItems(): Collection<ProductListItem>;
+    /**
+     * Returns the aggregated purchases from all the individual items.
+     */
+    getPurchases(): Collection<ProductListItemPurchase>;
+    /**
+     * Returns the ProductListRegistrant assigned to the registrant attribute or null
+     * if this list has no registrant.
+     */
+    getRegistrant(): ProductListRegistrant | null;
+    /**
+     * Return the address that should be used as the shipping address for purchases
+     * made from the list.
+     */
+    getShippingAddress(): CustomerAddress | null;
+    /**
+     * Returns an int representing the type of object (e.g. wish list,
+     * gift registry). This is set at object creation time.
+     */
+    getType(): number;
+    /**
+     * Returns true if this product list is owned by an anonymous customer.
+     */
+    isAnonymous(): boolean;
+    /**
+     * A flag, typically used to determine if the object is searchable
+     * by other customers.
+     */
+    isPublic(): boolean;
+    /**
+     * Removes the ProductListRegistrant assigned to the coRegistrant attribute.
+     */
+    removeCoRegistrant(): void;
+    /**
+     * Removes the specified item from the list.  This will also cause
+     * all purchase information associated with that item to be removed.
+     */
+    removeItem(item: ProductListItem): void;
+    /**
+     * Removes the ProductListRegistrant assigned to the registrant attribute.
+     */
+    removeRegistrant(): void;
+    /**
+     * Set the description of this product list.
+     */
+    setDescription(description: string): void;
+    /**
+     * Set the event city to which this product list is related.
+     */
+    setEventCity(eventCity: string): void;
+    /**
+     * Set the event country to which this product list is related.
+     */
+    setEventCountry(eventCountry: string): void;
+    /**
+     * Set the date of the event to which this product list is related.
+     */
+    setEventDate(eventDate: Date | null): void;
+    /**
+     * Set the event state to which this product list is related.
+     */
+    setEventState(eventState: string): void;
+    /**
+     * Set the event type for which this product list was created by the owner.
+     */
+    setEventType(eventType: string): void;
+    /**
+     * Set the name of this product list.
+     */
+    setName(name: string): void;
+    /**
+     * This is typically used by an event related list (e.g. gift registry) to
+     * specify a shipping address for purchases made after the event date.
+     */
+    setPostEventShippingAddress(address: CustomerAddress): void;
+    /**
+     * Makes this product list visible to other customers or hides it.
+     */
+    setPublic(flag: boolean): void;
+    /**
+     * Associate an address, used as the shipping address for purchases
+     * made from the list.
+     */
+    setShippingAddress(address: CustomerAddress): void;
+}
+
+export = ProductList;