@salesforce/b2c-cli 1.11.0 → 1.12.1

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

@@ -0,0 +1,280 @@
+import ExtensibleObject = require('../object/ExtensibleObject');
+import CustomAttributes = require('../object/CustomAttributes');
+import EnumValue = require('../value/EnumValue');
+
+declare global {
+    module ICustomAttributes {
+        interface CustomerAddress extends CustomAttributes {
+        }
+    }
+}
+
+/**
+ * The Address class represents a customer's address.
+ * 
+ * Note: this class allows access to sensitive personal and private information.
+ * Pay attention to appropriate legal and regulatory requirements.
+ */
+declare class CustomerAddress extends ExtensibleObject<ICustomAttributes.CustomerAddress> {
+    /**
+     * Returns the name of the address.
+     */
+    ID: string;
+    /**
+     * Returns the customer's first address.
+     */
+    address1: string;
+    /**
+     * Returns the customer's second address value.
+     */
+    address2: string;
+    /**
+     * Returns the customer's city.
+     */
+    city: string;
+    /**
+     * Returns the customer's company name.
+     */
+    companyName: string;
+    /**
+     * Returns the customer's country code. Commerce Cloud Digital supports two-character
+     * country codes per ISO 3166-1 alpha-2. See
+     * http://www.iso.org/iso/country_codes/iso_3166-faqs/iso_3166_faqs_general.htm
+     * for additional information.
+     */
+    countryCode: EnumValue;
+    /**
+     * Returns the customer's first name.
+     */
+    firstName: string;
+    /**
+     * Returns a concatenation of the customer's first, middle,
+     * and last names and its suffix.
+     */
+    readonly fullName: string;
+    /**
+     * Returns the customer's job title.
+     */
+    jobTitle: string;
+    /**
+     * Returns the customer's last name.
+     */
+    lastName: string;
+    /**
+     * Returns the customer's phone number.
+     */
+    phone: string;
+    /**
+     * Returns the customer's post box.
+     */
+    postBox: string;
+    /**
+     * Returns the customer's postal code.
+     */
+    postalCode: string;
+    /**
+     * Returns the customer's salutation.
+     */
+    salutation: string;
+    /**
+     * Returns the customer's second name.
+     */
+    secondName: string;
+    /**
+     * Returns the customer's state.
+     */
+    stateCode: string;
+    /**
+     * Returns the customer's suffix.
+     */
+    suffix: string;
+    /**
+     * Returns the customer's suite.
+     */
+    suite: string;
+    /**
+     * Returns the customer's title.
+     */
+    title: string;
+    private constructor();
+    /**
+     * Returns the customer's first address.
+     */
+    getAddress1(): string;
+    /**
+     * Returns the customer's second address value.
+     */
+    getAddress2(): string;
+    /**
+     * Returns the customer's city.
+     */
+    getCity(): string;
+    /**
+     * Returns the customer's company name.
+     */
+    getCompanyName(): string;
+    /**
+     * Returns the customer's country code. Commerce Cloud Digital supports two-character
+     * country codes per ISO 3166-1 alpha-2. See
+     * http://www.iso.org/iso/country_codes/iso_3166-faqs/iso_3166_faqs_general.htm
+     * for additional information.
+     */
+    getCountryCode(): EnumValue;
+    /**
+     * Returns the customer's first name.
+     */
+    getFirstName(): string;
+    /**
+     * Returns a concatenation of the customer's first, middle,
+     * and last names and its suffix.
+     */
+    getFullName(): string;
+    /**
+     * Returns the name of the address.
+     */
+    getID(): string;
+    /**
+     * Returns the customer's job title.
+     */
+    getJobTitle(): string;
+    /**
+     * Returns the customer's last name.
+     */
+    getLastName(): string;
+    /**
+     * Returns the customer's phone number.
+     */
+    getPhone(): string;
+    /**
+     * Returns the customer's post box.
+     */
+    getPostBox(): string;
+    /**
+     * Returns the customer's postal code.
+     */
+    getPostalCode(): string;
+    /**
+     * Returns the customer's salutation.
+     */
+    getSalutation(): string;
+    /**
+     * Returns the customer's second name.
+     */
+    getSecondName(): string;
+    /**
+     * Returns the customer's state.
+     */
+    getStateCode(): string;
+    /**
+     * Returns the customer's suffix.
+     */
+    getSuffix(): string;
+    /**
+     * Returns the customer's suite.
+     */
+    getSuite(): string;
+    /**
+     * Returns the customer's title.
+     */
+    getTitle(): string;
+    /**
+     * Returns true if the specified address is equivalent to
+     * this address. An equivalent address is an address whose
+     * core attributes contain the same values. The core attributes
+     * are:
+     * 
+     * - address1
+     * - address2
+     * - city
+     * - companyName
+     * - countryCode
+     * - firstName
+     * - lastName
+     * - postalCode
+     * - postBox
+     * - stateCode
+     */
+    isEquivalentAddress(address: any): boolean;
+    /**
+     * Sets the value of the customer's first address.
+     */
+    setAddress1(value: string): void;
+    /**
+     * Sets the customer's second address value.
+     */
+    setAddress2(value: string): void;
+    /**
+     * Sets the customer's city.
+     */
+    setCity(city: string): void;
+    /**
+     * Sets the customer's company name.
+     */
+    setCompanyName(companyName: string): void;
+    /**
+     * Sets the customer's country code. Commerce Cloud Digital supports two-character
+     * country codes per ISO 3166-1 alpha-2. See
+     * http://www.iso.org/iso/country_codes/iso_3166-faqs/iso_3166_faqs_general.htm
+     * for additional information.
+     */
+    setCountryCode(countryCode: string): void;
+    /**
+     * Sets the customer's first name.
+     */
+    setFirstName(firstName: string): void;
+    /**
+     * Sets the address name.
+     */
+    setID(value: string): void;
+    /**
+     * Sets the customer's job title.
+     */
+    setJobTitle(jobTitle: string): void;
+    /**
+     * Sets the customer's last name.
+     */
+    setLastName(lastName: string): void;
+    /**
+     * Sets the customer's phone number. The length is restricted to 32 characters.
+     */
+    setPhone(phoneNumber: string): void;
+    /**
+     * Sets the customer's post box.
+     */
+    setPostBox(postBox: string): void;
+    /**
+     * Sets the customer's postal code.
+     */
+    setPostalCode(postalCode: string): void;
+    /**
+     * Sets the customer's salutation.
+     * @deprecated Use setSalutation
+     */
+    setSaluation(value: string): void;
+    /**
+     * Sets the customer's salutation.
+     */
+    setSalutation(value: string): void;
+    /**
+     * Sets the customer's second name.
+     */
+    setSecondName(secondName: string): void;
+    /**
+     * Sets the customer's state.
+     */
+    setStateCode(state: string): void;
+    /**
+     * Sets the customer's suffix.
+     */
+    setSuffix(suffix: string): void;
+    /**
+     * Sets the customer's suite. The length is restricted to 32 characters.
+     */
+    setSuite(value: string): void;
+    /**
+     * Sets the customer's title.
+     */
+    setTitle(title: string): void;
+}
+
+export = CustomerAddress;

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

@@ -0,0 +1,25 @@
+/**
+ * Represents the read-only Customer's Salesforce CDP (Customer Data Platform) data for a dw.customer.Customer in Commerce
+ * Cloud. Please see Salesforce CDP enablement documentation
+ */
+declare class CustomerCDPData {
+    /**
+     * Return true if the CDPData is empty (has no meaningful data)
+     */
+    readonly empty: boolean;
+    /**
+     * Returns an array containing the CDP segments for the customer, or an empty array if no segments found
+     */
+    readonly segments: string[];
+    private constructor();
+    /**
+     * Returns an array containing the CDP segments for the customer, or an empty array if no segments found
+     */
+    getSegments(): string[];
+    /**
+     * Return true if the CDPData is empty (has no meaningful data)
+     */
+    isEmpty(): boolean;
+}
+
+export = CustomerCDPData;

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

@@ -0,0 +1,21 @@
+/**
+ * Provides helper methods for managing customer context, such as the Effective Time for which the customer is shopping
+ * at
+ */
+declare class CustomerContextMgr {
+    /**
+     * Get the effective time associated with the customer. By default, the effective time is null.
+     */
+    static effectiveTime: Date | null;
+    private constructor();
+    /**
+     * Get the effective time associated with the customer. By default, the effective time is null.
+     */
+    static getEffectiveTime(): Date | null;
+    /**
+     * Set the effective time for the customer. Null is allowed to remove effective time from the customer.
+     */
+    static setEffectiveTime(effectiveTime: Date): void;
+}
+
+export = CustomerContextMgr;

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

@@ -0,0 +1,76 @@
+import ExtensibleObject = require('../object/ExtensibleObject');
+import CustomAttributes = require('../object/CustomAttributes');
+import Customer = require('./Customer');
+
+declare global {
+    module ICustomAttributes {
+        interface CustomerGroup extends CustomAttributes {
+        }
+    }
+}
+
+/**
+ * CustomerGroups provide a means to segment customers by various criteria. A
+ * merchant can then provide different site experiences (e.g. promotions,
+ * prices, sorting rules) to each customer segment. Customer groups can consist
+ * of either an explicit list of customers or a business rule that dynamically
+ * determines whether a customer is a member. The former type is called
+ * "explicit" and the latter type is called "dynamic".
+ * 
+ * - Explicit customer group: Consists of an explicit list of
+ * customers. Only registered customers can be member of such a group.
+ * isRuleBased==false.
+ * - Dynamic customer group: Memberships are evaluated by a business
+ * rule that is attached to the customer group. Registered as well as anonymous
+ * customers can be member of such a group. isRuleBased==true.
+ * 
+ * Note: this class might allow access to sensitive personal and private
+ * information, depending on how you segment your customers and the names given to
+ * your custoemer groups. Pay attention to appropriate legal and regulatory requirements
+ * when developing with this data.
+ */
+declare class CustomerGroup extends ExtensibleObject<ICustomAttributes.CustomerGroup> {
+    /**
+     * Returns the unique ID of the customer group.
+     */
+    readonly ID: string;
+    /**
+     * Gets the value of the description of the customer group.
+     */
+    readonly description: string;
+    /**
+     * Returns true if the group determines the membership of customers
+     * based on rules. Returns false if the group provides explicit assignement
+     * of customers.
+     */
+    readonly ruleBased: boolean;
+    private constructor();
+    /**
+     * Assigns the specified customer to this group.
+     * 
+     * The customer must be registered and the group must not be rule-based.
+     */
+    assignCustomer(customer: Customer): void;
+    /**
+     * Gets the value of the description of the customer group.
+     */
+    getDescription(): string;
+    /**
+     * Returns the unique ID of the customer group.
+     */
+    getID(): string;
+    /**
+     * Returns true if the group determines the membership of customers
+     * based on rules. Returns false if the group provides explicit assignement
+     * of customers.
+     */
+    isRuleBased(): boolean;
+    /**
+     * Unassigns the specified customer from this group.
+     * 
+     * The customer must be registered and the group must not be rule-based.
+     */
+    unassignCustomer(customer: Customer): void;
+}
+
+export = CustomerGroup;

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

@@ -0,0 +1,29 @@
+/**
+ * Object representing the collection of customers who are registered
+ * for a given site. In Commerce Cloud Digital, every site has exactly
+ * one assigned customer list but multiple sites may share a customer
+ * list.
+ */
+declare class CustomerList {
+    /**
+     * Get the ID of the customer list.  For customer lists that were created automatically
+     * for a given site, this is equal to the ID of the site itself.
+     */
+    readonly ID: string;
+    /**
+     * Get the optional description of the customer list.
+     */
+    readonly description: string;
+    private constructor();
+    /**
+     * Get the optional description of the customer list.
+     */
+    getDescription(): string;
+    /**
+     * Get the ID of the customer list.  For customer lists that were created automatically
+     * for a given site, this is equal to the ID of the site itself.
+     */
+    getID(): string;
+}
+
+export = CustomerList;