@salesforce/b2c-cli 1.10.0 → 1.12.0

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

@@ -0,0 +1,210 @@
+import Profile = require('./Profile');
+import OrderHistory = require('./OrderHistory');
+import Collection = require('../util/Collection');
+import CustomerGroup = require('./CustomerGroup');
+import ProductList = require('./ProductList');
+import CustomerActiveData = require('./CustomerActiveData');
+import CustomerCDPData = require('./CustomerCDPData');
+import AddressBook = require('./AddressBook');
+import ExternalProfile = require('./ExternalProfile');
+
+/**
+ * Represents a customer.
+ */
+declare class Customer {
+    /**
+     * Returns the Salesforce CDP (Customer Data Platform) data for this customer.
+     */
+    readonly CDPData: CustomerCDPData;
+    /**
+     * Returns the unique, system generated ID of the customer.
+     */
+    readonly ID: string;
+    /**
+     * Returns the active data for this customer.
+     */
+    readonly activeData: CustomerActiveData;
+    /**
+     * Returns the address book for the profile of this customer,
+     * or `null` if this customer has no profile, such as for an
+     * anonymous customer.
+     */
+    readonly addressBook: AddressBook | null;
+    /**
+     * Identifies if the customer is anonymous. An anonymous
+     * customer is the opposite of a registered customer.
+     */
+    readonly anonymous: boolean;
+    /**
+     * Identifies if the customer is authenticated. This method checks whether
+     * this customer is the customer associated with the session and than checks
+     * whether the session in an authenticated state.
+     * 
+     * Note: The pipeline debugger will always show 'false' for this value
+     * regardless of whether the customer is authenticated or not.
+     */
+    readonly authenticated: boolean;
+    /**
+     * Returns the customer groups this customer is member of.
+     * 
+     * - Result contains static customer groups in storefront and job session
+     * - Result contains dynamic customer groups in storefront  and job session.
+     * Dynamic customer groups referring session or request data are not available
+     * when processing the customer in a job session, or when this customer is not the customer assigned to the current session.
+     * 
+     * - Result contains system groups 'Everyone', 'Unregistered', 'Registered' for all customers in storefront and job sessions
+     */
+    readonly customerGroups: Collection<CustomerGroup>;
+    /**
+     * Returns a collection of any external profiles the customer may have
+     */
+    readonly externalProfiles: Collection<ExternalProfile>;
+    /**
+     * Identifies if the customer is externally authenticated. An externally
+     * authenticated customer does not have the password stored in our system
+     * but logs in through an external OAuth provider (Google, Facebook, LinkedIn, etc.)
+     */
+    readonly externallyAuthenticated: boolean;
+    /**
+     * Returns the Global Party ID for the customer, if there is one.
+     * Global Party ID is created by Customer 360 and identifies a person across multiple systems.
+     */
+    readonly globalPartyID: string;
+    /**
+     * Returns the note for this customer, or `null` if this customer has no note, such as for an anonymous
+     * customer or when note has 0 length.
+     */
+    note: string | null;
+    /**
+     * Returns the customer order history.
+     */
+    readonly orderHistory: OrderHistory;
+    /**
+     * Returns the customer profile.
+     */
+    readonly profile: Profile;
+    /**
+     * Identifies if the customer is registered. A registered customer
+     * may or may not be authenticated. This method checks whether
+     * the user has a profile.
+     */
+    readonly registered: boolean;
+    private constructor();
+    /**
+     * Creates an externalProfile and attaches it to the list of external profiles for the customer
+     */
+    createExternalProfile(authenticationProviderId: string, externalId: string): ExternalProfile;
+    /**
+     * Returns the active data for this customer.
+     */
+    getActiveData(): CustomerActiveData;
+    /**
+     * Returns the address book for the profile of this customer,
+     * or `null` if this customer has no profile, such as for an
+     * anonymous customer.
+     */
+    getAddressBook(): AddressBook | null;
+    /**
+     * Returns the Salesforce CDP (Customer Data Platform) data for this customer.
+     */
+    getCDPData(): CustomerCDPData;
+    /**
+     * Returns the customer groups this customer is member of.
+     * 
+     * - Result contains static customer groups in storefront and job session
+     * - Result contains dynamic customer groups in storefront  and job session.
+     * Dynamic customer groups referring session or request data are not available
+     * when processing the customer in a job session, or when this customer is not the customer assigned to the current session.
+     * 
+     * - Result contains system groups 'Everyone', 'Unregistered', 'Registered' for all customers in storefront and job sessions
+     */
+    getCustomerGroups(): Collection<CustomerGroup>;
+    /**
+     * A convenience method for finding an external profile among the customer's external profiles collection
+     */
+    getExternalProfile(authenticationProviderId: string, externalId: string): ExternalProfile | null;
+    /**
+     * Returns a collection of any external profiles the customer may have
+     */
+    getExternalProfiles(): Collection<ExternalProfile>;
+    /**
+     * Returns the Global Party ID for the customer, if there is one.
+     * Global Party ID is created by Customer 360 and identifies a person across multiple systems.
+     */
+    getGlobalPartyID(): string;
+    /**
+     * Returns the unique, system generated ID of the customer.
+     */
+    getID(): string;
+    /**
+     * Returns the note for this customer, or `null` if this customer has no note, such as for an anonymous
+     * customer or when note has 0 length.
+     */
+    getNote(): string | null;
+    /**
+     * Returns the customer order history.
+     */
+    getOrderHistory(): OrderHistory;
+    /**
+     * Returns the product lists of the specified type.
+     * @see dw.customer.ProductList
+     */
+    getProductLists(type: number): Collection<ProductList>;
+    /**
+     * Returns the customer profile.
+     */
+    getProfile(): Profile;
+    /**
+     * Identifies if the customer is anonymous. An anonymous
+     * customer is the opposite of a registered customer.
+     */
+    isAnonymous(): boolean;
+    /**
+     * Identifies if the customer is authenticated. This method checks whether
+     * this customer is the customer associated with the session and than checks
+     * whether the session in an authenticated state.
+     * 
+     * Note: The pipeline debugger will always show 'false' for this value
+     * regardless of whether the customer is authenticated or not.
+     */
+    isAuthenticated(): boolean;
+    /**
+     * Identifies if the customer is externally authenticated. An externally
+     * authenticated customer does not have the password stored in our system
+     * but logs in through an external OAuth provider (Google, Facebook, LinkedIn, etc.)
+     */
+    isExternallyAuthenticated(): boolean;
+    /**
+     * Returns true if there exist CustomerGroup for all of the given IDs and the customer is member of at least one of that groups.
+     */
+    isMemberOfAnyCustomerGroup(...groupIDs: string[]): boolean;
+    /**
+     * Returns true if the customer is member of the specified
+     * CustomerGroup.
+     */
+    isMemberOfCustomerGroup(group: CustomerGroup): boolean;
+    /**
+     * Returns true if there is a CustomerGroup with such an ID and the customer is member of that group.
+     */
+    isMemberOfCustomerGroup(groupID: string): boolean;
+    /**
+     * Returns true if there exist CustomerGroup for all of the given IDs and the customer is member of all that groups.
+     */
+    isMemberOfCustomerGroups(...groupIDs: string[]): boolean;
+    /**
+     * Identifies if the customer is registered. A registered customer
+     * may or may not be authenticated. This method checks whether
+     * the user has a profile.
+     */
+    isRegistered(): boolean;
+    /**
+     * Removes an external profile from the customer
+     */
+    removeExternalProfile(externalProfile: ExternalProfile): void;
+    /**
+     * Sets the note for this customer. This is a no-op for an anonymous customer.
+     */
+    setNote(aValue: string): void;
+}
+
+export = Customer;

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

@@ -0,0 +1,276 @@
+import ActiveData = require('../object/ActiveData');
+import ExtensibleObject = require('../object/ExtensibleObject');
+import CustomAttributes = require('../object/CustomAttributes');
+
+declare global {
+    module ICustomAttributes {
+        interface CustomerActiveData extends ICustomAttributes.ActiveData {
+        }
+    }
+}
+
+/**
+ * Represents the active data for a dw.customer.Customer in Commerce Cloud Digital.
+ * 
+ * Note: this class allows access to sensitive personal and private information.
+ * Pay attention to appropriate legal and regulatory requirements when developing.
+ */
+declare class CustomerActiveData extends ActiveData<ICustomAttributes.CustomerActiveData> {
+    /**
+     * Returns the average order value of the customer, or `null`
+     * if none has been set or the value is no longer valid.
+     */
+    readonly avgOrderValue: number;
+    /**
+     * Returns the discount value resulting from coupons, that has been applied
+     * to orders of the customer, or `null` if none has been set or
+     * the value is no longer valid.
+     */
+    readonly discountValueWithCoupon: number;
+    /**
+     * Returns the discount value resulting from promotions other than coupons,
+     * that has been applied to orders of the customer, or `null`
+     * if none has been set or the value is no longer valid.
+     */
+    readonly discountValueWithoutCoupon: number;
+    /**
+     * Returns the number of orders for the Customer that contained at least
+     * one product unit marked as a gift, or `null` if none has been
+     * set or the value is no longer valid.
+     */
+    readonly giftOrders: number;
+    /**
+     * Returns the number of product units in orders for the customer
+     * that were marked as a gift, or `null` if none has been set
+     * or the value is no longer valid.
+     */
+    readonly giftUnits: number;
+    /**
+     * Returns the date of the last order for the customer, or `null`
+     * if there are no orders for the customer.
+     */
+    readonly lastOrderDate: Date | null;
+    /**
+     * Returns the lifetime order value of the customer, or `null`
+     * if none has been set or the value is no longer valid.
+     */
+    readonly orderValue: number;
+    /**
+     * Returns the order value of the customer, over the most recent 30 days,
+     * or `null` if none has been set or the value is no longer valid.
+     */
+    readonly orderValueMonth: number;
+    /**
+     * Returns the orders of the customer, or `null` if none
+     * has been set or the value is no longer valid.
+     */
+    readonly orders: number;
+    /**
+     * Returns an array containing the master product SKUs of variation products
+     * in orders for the customer, or an empty collection if no SKUs have been
+     * set or the collection of SKUs is no longer valid. There is no specific
+     * limit on the number of SKUs that will be returned in the collection, but
+     * there is also no guarantee that it will contain the SKUs for all products
+     * ordered by the customer.
+     */
+    readonly productMastersOrdered: string[];
+    /**
+     * Returns an array containing the SKUs of products in baskets abandoned
+     * by the customer in the last 30 days, or an empty collection if no SKUs
+     * have been set or the collection is no longer valid.  There is no specific
+     * limit on the number of SKUs that will be returned in the collection, but
+     * there is also no guarantee that it will contain the SKUs for all products
+     * in baskets abandoned by the customer.
+     */
+    readonly productsAbandonedMonth: string[];
+    /**
+     * Returns an array containing the SKUs of products in orders
+     * for the customer, or an empty collection if no SKUs have been set or the
+     * collection of SKUs is no longer valid.  There is no specific limit on the
+     * number of SKUs that will be returned in the collection, but there is also
+     * no guarantee that it will contain the SKUs for all products ordered by
+     * the customer.
+     */
+    readonly productsOrdered: string[];
+    /**
+     * Returns an array containing the SKUs of products viewed by the
+     * customer in the last 30 days, or an empty collection if no SKUs have been
+     * set or the collection is no longer valid.  There is no specific limit on
+     * the number of SKUs that will be returned in the collection, but there is
+     * also no guarantee that it will contain the SKUs for all products viewed
+     * by the customer.
+     */
+    readonly productsViewedMonth: string[];
+    /**
+     * Returns the returned revenue of the customer, or `null`
+     * if none has been set or the value is no longer valid.
+     */
+    readonly returnValue: number;
+    /**
+     * Returns the number of returns of the customer, or `null`
+     * if none has been set or the value is no longer valid.
+     */
+    readonly returns: number;
+    /**
+     * Returns the number of orders for the customer where a source code was
+     * in effect, or `null` if none has been set or the value
+     * is no longer valid.
+     */
+    readonly sourceCodeOrders: number;
+    /**
+     * Returns an array containing the IDs of up to the top 20 categories for
+     * customer orders, or an empty list if no categories have been set or the
+     * list of categories is no longer valid. The top category is the one for
+     * which the most orders for the customer contained at least one product
+     * found in that category.
+     */
+    readonly topCategoriesOrdered: string[];
+    /**
+     * Returns the visits of the customer, over the most recent 30 days,
+     * or `null` if none has been set or the value
+     * is no longer valid.
+     */
+    readonly visitsMonth: number;
+    /**
+     * Returns the visits of the customer, over the most recent 7 days,
+     * or `null` if none has been set or the value
+     * is no longer valid.
+     */
+    readonly visitsWeek: number;
+    /**
+     * Returns the visits of the customer, over the most recent 365 days,
+     * or `null` if none has been set or the value
+     * is no longer valid.
+     */
+    readonly visitsYear: number;
+    private constructor();
+    /**
+     * Returns the average order value of the customer, or `null`
+     * if none has been set or the value is no longer valid.
+     */
+    getAvgOrderValue(): number;
+    /**
+     * Returns the discount value resulting from coupons, that has been applied
+     * to orders of the customer, or `null` if none has been set or
+     * the value is no longer valid.
+     */
+    getDiscountValueWithCoupon(): number;
+    /**
+     * Returns the discount value resulting from promotions other than coupons,
+     * that has been applied to orders of the customer, or `null`
+     * if none has been set or the value is no longer valid.
+     */
+    getDiscountValueWithoutCoupon(): number;
+    /**
+     * Returns the number of orders for the Customer that contained at least
+     * one product unit marked as a gift, or `null` if none has been
+     * set or the value is no longer valid.
+     */
+    getGiftOrders(): number;
+    /**
+     * Returns the number of product units in orders for the customer
+     * that were marked as a gift, or `null` if none has been set
+     * or the value is no longer valid.
+     */
+    getGiftUnits(): number;
+    /**
+     * Returns the date of the last order for the customer, or `null`
+     * if there are no orders for the customer.
+     */
+    getLastOrderDate(): Date | null;
+    /**
+     * Returns the lifetime order value of the customer, or `null`
+     * if none has been set or the value is no longer valid.
+     */
+    getOrderValue(): number;
+    /**
+     * Returns the order value of the customer, over the most recent 30 days,
+     * or `null` if none has been set or the value is no longer valid.
+     */
+    getOrderValueMonth(): number;
+    /**
+     * Returns the orders of the customer, or `null` if none
+     * has been set or the value is no longer valid.
+     */
+    getOrders(): number;
+    /**
+     * Returns an array containing the master product SKUs of variation products
+     * in orders for the customer, or an empty collection if no SKUs have been
+     * set or the collection of SKUs is no longer valid. There is no specific
+     * limit on the number of SKUs that will be returned in the collection, but
+     * there is also no guarantee that it will contain the SKUs for all products
+     * ordered by the customer.
+     */
+    getProductMastersOrdered(): string[];
+    /**
+     * Returns an array containing the SKUs of products in baskets abandoned
+     * by the customer in the last 30 days, or an empty collection if no SKUs
+     * have been set or the collection is no longer valid.  There is no specific
+     * limit on the number of SKUs that will be returned in the collection, but
+     * there is also no guarantee that it will contain the SKUs for all products
+     * in baskets abandoned by the customer.
+     */
+    getProductsAbandonedMonth(): string[];
+    /**
+     * Returns an array containing the SKUs of products in orders
+     * for the customer, or an empty collection if no SKUs have been set or the
+     * collection of SKUs is no longer valid.  There is no specific limit on the
+     * number of SKUs that will be returned in the collection, but there is also
+     * no guarantee that it will contain the SKUs for all products ordered by
+     * the customer.
+     */
+    getProductsOrdered(): string[];
+    /**
+     * Returns an array containing the SKUs of products viewed by the
+     * customer in the last 30 days, or an empty collection if no SKUs have been
+     * set or the collection is no longer valid.  There is no specific limit on
+     * the number of SKUs that will be returned in the collection, but there is
+     * also no guarantee that it will contain the SKUs for all products viewed
+     * by the customer.
+     */
+    getProductsViewedMonth(): string[];
+    /**
+     * Returns the returned revenue of the customer, or `null`
+     * if none has been set or the value is no longer valid.
+     */
+    getReturnValue(): number;
+    /**
+     * Returns the number of returns of the customer, or `null`
+     * if none has been set or the value is no longer valid.
+     */
+    getReturns(): number;
+    /**
+     * Returns the number of orders for the customer where a source code was
+     * in effect, or `null` if none has been set or the value
+     * is no longer valid.
+     */
+    getSourceCodeOrders(): number;
+    /**
+     * Returns an array containing the IDs of up to the top 20 categories for
+     * customer orders, or an empty list if no categories have been set or the
+     * list of categories is no longer valid. The top category is the one for
+     * which the most orders for the customer contained at least one product
+     * found in that category.
+     */
+    getTopCategoriesOrdered(): string[];
+    /**
+     * Returns the visits of the customer, over the most recent 30 days,
+     * or `null` if none has been set or the value
+     * is no longer valid.
+     */
+    getVisitsMonth(): number;
+    /**
+     * Returns the visits of the customer, over the most recent 7 days,
+     * or `null` if none has been set or the value
+     * is no longer valid.
+     */
+    getVisitsWeek(): number;
+    /**
+     * Returns the visits of the customer, over the most recent 365 days,
+     * or `null` if none has been set or the value
+     * is no longer valid.
+     */
+    getVisitsYear(): number;
+}
+
+export = CustomerActiveData;