@salesforce/b2c-cli 1.11.0 → 1.12.0

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

@@ -0,0 +1,420 @@
+import EncryptedObject = require('./EncryptedObject');
+import ExtensibleObject = require('../object/ExtensibleObject');
+import CustomAttributes = require('../object/CustomAttributes');
+import Customer = require('./Customer');
+import AddressBook = require('./AddressBook');
+import Wallet = require('./Wallet');
+import Credentials = require('./Credentials');
+import EnumValue = require('../value/EnumValue');
+
+declare global {
+    module ICustomAttributes {
+        interface Profile extends ICustomAttributes.EncryptedObject {
+        }
+    }
+}
+
+/**
+ * The class represents a customer profile. It also provides access to the
+ * customers address book and credentials.
+ * 
+ * Note: this class handles sensitive security-related data.
+ * Pay special attention to PCI DSS v3. requirements 2, 4, and 12.
+ */
+declare class Profile extends EncryptedObject<ICustomAttributes.Profile> {
+    /**
+     * Returns the customer's address book.
+     */
+    readonly addressBook: AddressBook;
+    /**
+     * Returns the customer's birthday as a date.
+     */
+    birthday: Date;
+    /**
+     * Returns the customer's company name.
+     */
+    companyName: string;
+    /**
+     * Returns the customer's credentials.
+     */
+    readonly credentials: Credentials;
+    /**
+     * Returns the customer object related to this profile.
+     */
+    readonly customer: Customer;
+    /**
+     * Returns the customer's number, which is a number used to identify the Customer.
+     */
+    readonly customerNo: string;
+    /**
+     * Returns the customer's email address.
+     */
+    email: string;
+    /**
+     * Returns whether the customer's email has been verified.
+     * 
+     * This is a read-only field. The field value cannot be set externally and will be set in platform based on
+     * following rules:
+     * 
+     * - If the Email Verification Site Preference under LoginPreferences is disabled: the value for this field will
+     * always be NULL;
+     * - If the Email Verification Site Preference under LoginPreferences is enabled:
+     * 
+     * - If the incoming email value is the same as existing email and email was previously verified, the value for
+     * this field will remain unchanged as TRUE;
+     * - If the incoming email value is the same as existing email and email was not previously verified, the value
+     * for this field will remain unchanged as FALSE;
+     * - If the incoming email value is not the same as existing email, the value for this field will be set to FALSE
+     * no matter the previous state;
+     */
+    readonly emailVerified: boolean;
+    /**
+     * Returns the fax number to use for the customer.
+     * The length is restricted to 32 characters.
+     */
+    fax: string;
+    /**
+     * Indicates that the customer is female when set to true.
+     */
+    readonly female: boolean;
+    /**
+     * Returns the customer's first name.
+     */
+    firstName: string;
+    /**
+     * Returns the customer's gender.
+     */
+    gender: EnumValue;
+    /**
+     * Returns the customer's job title.
+     */
+    jobTitle: string;
+    /**
+     * Returns the last login time of the customer.
+     */
+    readonly lastLoginTime: Date;
+    /**
+     * Returns the customer's last name.
+     */
+    lastName: string;
+    /**
+     * Returns the last visit time of the customer.
+     */
+    readonly lastVisitTime: Date;
+    /**
+     * Indicates that the customer is male when set to true.
+     */
+    readonly male: boolean;
+    /**
+     * Returns the upcoming customer's birthday as a date.
+     * If the customer already had birthday this year the method returns the birthday of the next year.
+     * Otherwise its birthday in this year.
+     * If the customer has not set a birthday this method returns null.
+     */
+    readonly nextBirthday: Date;
+    /**
+     * Returns the business phone number to use for the customer.
+     */
+    phoneBusiness: string;
+    /**
+     * Returns the phone number to use for the customer.
+     */
+    phoneHome: string;
+    /**
+     * Returns the mobile phone number to use for the customer.
+     */
+    phoneMobile: string;
+    /**
+     * Returns the customer's preferred locale.
+     */
+    preferredLocale: string;
+    /**
+     * Returns the time the customer logged in prior to the current login.
+     */
+    readonly previousLoginTime: Date;
+    /**
+     * Returns the time the customer visited the store prior to the current visit.
+     */
+    readonly previousVisitTime: Date;
+    /**
+     * Returns the salutation to use for the customer.
+     */
+    salutation: string;
+    /**
+     * Returns the customer's second name.
+     */
+    secondName: string;
+    /**
+     * Returns the customer's suffix, such as "Jr." or "Sr.".
+     */
+    suffix: string;
+    /**
+     * Returns the tax ID value. The value is returned either plain
+     * text if the current context allows plain text access, or
+     * if it's not allowed, the ID value will be returned masked.
+     * The following criteria must be met in order to have plain text access:
+     * 
+     * - the method call must happen in the context of a storefront request;
+     * - the current customer must be registered and authenticated;
+     * - it is the profile of the current customer;
+     * - and the current protocol is HTTPS.
+     */
+    taxID: string;
+    /**
+     * Returns the masked value of the tax ID.
+     */
+    readonly taxIDMasked: string;
+    /**
+     * Returns the tax ID type.
+     */
+    taxIDType: EnumValue;
+    /**
+     * Returns the customer's title, such as "Mrs" or "Mr".
+     */
+    title: string;
+    /**
+     * Returns the wallet of this customer.
+     */
+    readonly wallet: Wallet;
+    private constructor();
+    /**
+     * Returns the customer's address book.
+     */
+    getAddressBook(): AddressBook;
+    /**
+     * Returns the customer's birthday as a date.
+     */
+    getBirthday(): Date;
+    /**
+     * Returns the customer's company name.
+     */
+    getCompanyName(): string;
+    /**
+     * Returns the customer's credentials.
+     */
+    getCredentials(): Credentials;
+    /**
+     * Returns the customer object related to this profile.
+     */
+    getCustomer(): Customer;
+    /**
+     * Returns the customer's number, which is a number used to identify the Customer.
+     */
+    getCustomerNo(): string;
+    /**
+     * Returns the customer's email address.
+     */
+    getEmail(): string;
+    /**
+     * Returns the fax number to use for the customer.
+     * The length is restricted to 32 characters.
+     */
+    getFax(): string;
+    /**
+     * Returns the customer's first name.
+     */
+    getFirstName(): string;
+    /**
+     * Returns the customer's gender.
+     */
+    getGender(): EnumValue;
+    /**
+     * Returns the customer's job title.
+     */
+    getJobTitle(): string;
+    /**
+     * Returns the last login time of the customer.
+     */
+    getLastLoginTime(): Date;
+    /**
+     * Returns the customer's last name.
+     */
+    getLastName(): string;
+    /**
+     * Returns the last visit time of the customer.
+     */
+    getLastVisitTime(): Date;
+    /**
+     * Returns the upcoming customer's birthday as a date.
+     * If the customer already had birthday this year the method returns the birthday of the next year.
+     * Otherwise its birthday in this year.
+     * If the customer has not set a birthday this method returns null.
+     */
+    getNextBirthday(): Date;
+    /**
+     * Returns the business phone number to use for the customer.
+     */
+    getPhoneBusiness(): string;
+    /**
+     * Returns the phone number to use for the customer.
+     */
+    getPhoneHome(): string;
+    /**
+     * Returns the mobile phone number to use for the customer.
+     */
+    getPhoneMobile(): string;
+    /**
+     * Returns the customer's preferred locale.
+     */
+    getPreferredLocale(): string;
+    /**
+     * Returns the time the customer logged in prior to the current login.
+     */
+    getPreviousLoginTime(): Date;
+    /**
+     * Returns the time the customer visited the store prior to the current visit.
+     */
+    getPreviousVisitTime(): Date;
+    /**
+     * Returns the salutation to use for the customer.
+     */
+    getSalutation(): string;
+    /**
+     * Returns the customer's second name.
+     */
+    getSecondName(): string;
+    /**
+     * Returns the customer's suffix, such as "Jr." or "Sr.".
+     */
+    getSuffix(): string;
+    /**
+     * Returns the tax ID value. The value is returned either plain
+     * text if the current context allows plain text access, or
+     * if it's not allowed, the ID value will be returned masked.
+     * The following criteria must be met in order to have plain text access:
+     * 
+     * - the method call must happen in the context of a storefront request;
+     * - the current customer must be registered and authenticated;
+     * - it is the profile of the current customer;
+     * - and the current protocol is HTTPS.
+     */
+    getTaxID(): string;
+    /**
+     * Returns the masked value of the tax ID.
+     */
+    getTaxIDMasked(): string;
+    /**
+     * Returns the tax ID type.
+     */
+    getTaxIDType(): EnumValue;
+    /**
+     * Returns the customer's title, such as "Mrs" or "Mr".
+     */
+    getTitle(): string;
+    /**
+     * Returns the wallet of this customer.
+     */
+    getWallet(): Wallet;
+    /**
+     * Returns whether the customer's email has been verified.
+     * 
+     * This is a read-only field. The field value cannot be set externally and will be set in platform based on
+     * following rules:
+     * 
+     * - If the Email Verification Site Preference under LoginPreferences is disabled: the value for this field will
+     * always be NULL;
+     * - If the Email Verification Site Preference under LoginPreferences is enabled:
+     * 
+     * - If the incoming email value is the same as existing email and email was previously verified, the value for
+     * this field will remain unchanged as TRUE;
+     * - If the incoming email value is the same as existing email and email was not previously verified, the value
+     * for this field will remain unchanged as FALSE;
+     * - If the incoming email value is not the same as existing email, the value for this field will be set to FALSE
+     * no matter the previous state;
+     */
+    isEmailVerified(): boolean;
+    /**
+     * Indicates that the customer is female when set to true.
+     */
+    isFemale(): boolean;
+    /**
+     * Indicates that the customer is male when set to true.
+     */
+    isMale(): boolean;
+    /**
+     * Sets the customer's birthday as a date.
+     */
+    setBirthday(aValue: Date): void;
+    /**
+     * Sets the customer's company name.
+     */
+    setCompanyName(aValue: string): void;
+    /**
+     * Sets the customer's email address.
+     */
+    setEmail(aValue: string): void;
+    /**
+     * Sets the fax number to use for the customer.
+     * The length is restricted to 32 characters.
+     */
+    setFax(number: string): void;
+    /**
+     * Sets the customer's first name.
+     */
+    setFirstName(aValue: string): void;
+    /**
+     * Sets the customer's gender.
+     */
+    setGender(aValue: number): void;
+    /**
+     * Sets the customer's job title.
+     */
+    setJobTitle(aValue: string): void;
+    /**
+     * Sets the customer's last name.
+     */
+    setLastName(aValue: string): void;
+    /**
+     * Sets the business phone number to use for the customer.
+     * The length is restricted to 32 characters.
+     */
+    setPhoneBusiness(number: string): void;
+    /**
+     * Sets the phone number to use for the customer.
+     * The length is restricted to 32 characters.
+     */
+    setPhoneHome(number: string): void;
+    /**
+     * Sets the mobile phone number to use for the customer.
+     * The length is restricted to 32 characters.
+     */
+    setPhoneMobile(number: string): void;
+    /**
+     * Sets the customer's preferred locale.
+     */
+    setPreferredLocale(aValue: string): void;
+    /**
+     * Sets the salutation to use for the customer.
+     * @deprecated Use setSalutation
+     */
+    setSaluation(salutation: string): void;
+    /**
+     * Sets the salutation to use for the customer.
+     */
+    setSalutation(salutation: string): void;
+    /**
+     * Sets the customer's second name.
+     */
+    setSecondName(aValue: string): void;
+    /**
+     * Sets the the customer's suffix.
+     */
+    setSuffix(aValue: string): void;
+    /**
+     * Sets the tax ID value. The value can be set if the current context
+     * allows write access.
+     * The current context allows write access if the currently
+     * logged in user owns this profile and the connection is secured.
+     */
+    setTaxID(taxID: string): void;
+    /**
+     * Sets the tax ID type.
+     */
+    setTaxIDType(taxIdType: string): void;
+    /**
+     * Sets the customer's title.
+     */
+    setTitle(aValue: string): void;
+}
+
+export = Profile;

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

@@ -0,0 +1,56 @@
+import CustomerPaymentInstrument = require('./CustomerPaymentInstrument');
+import Collection = require('../util/Collection');
+
+/**
+ * Represents a set of payment instruments associated with a registered customer.
+ * 
+ * Note: this class allows access to sensitive personal and private
+ * information. Pay attention to appropriate legal and regulatory requirements
+ * when developing.
+ */
+declare class Wallet {
+    /**
+     * Returns the default payment instrument associated with the related customer. If not available, returns the first
+     * payment instrument or null if no payment instruments are associated with the customer.
+     */
+    readonly defaultPaymentInstrument: CustomerPaymentInstrument | null;
+    /**
+     * Returns a collection of all payment instruments associated with the
+     * related customer.
+     */
+    readonly paymentInstruments: Collection<any>;
+    private constructor();
+    /**
+     * Creates a new, empty payment instrument object associated with the
+     * related customer for the given payment method.
+     * @throws NullArgumentException If passed 'paymentMethodId' is null.
+     */
+    createPaymentInstrument(paymentMethodId: string): CustomerPaymentInstrument;
+    /**
+     * Returns the default payment instrument associated with the related customer. If not available, returns the first
+     * payment instrument or null if no payment instruments are associated with the customer.
+     */
+    getDefaultPaymentInstrument(): CustomerPaymentInstrument | null;
+    /**
+     * Returns a collection of all payment instruments associated with the
+     * related customer.
+     */
+    getPaymentInstruments(): Collection<any>;
+    /**
+     * Returns a collection of all payment instruments associated with the
+     * related customer filtered by the given payment method id. If
+     * `null` is passed as payment method id all payment instruments
+     * of the customer will be retrieved. If for the given payment method id no
+     * payment instrument is associated with the customer an empty collection
+     * will be returned.
+     */
+    getPaymentInstruments(paymentMethodID: string): Collection<any>;
+    /**
+     * Removes a payment instrument associated with the customer.
+     * @throws NullArgumentException If passed 'instrument' is null.
+     * @throws IllegalArgumentException If passed 'instrument' belongs to an other customer
+     */
+    removePaymentInstrument(instrument: CustomerPaymentInstrument): void;
+}
+
+export = Wallet;

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

@@ -0,0 +1,35 @@
+/**
+ * Represents the consent status for a specific channel and contact point.
+ * 
+ * This class provides information about the shopper's consent status (OPT_IN, OPT_OUT)
+ * for a particular marketing communication channel.
+ */
+declare class ConsentStatusEntry {
+    /**
+     * Returns the channel type for this consent status entry.
+     */
+    readonly channel: string;
+    /**
+     * Returns the contact point value (email address or phone number) for this consent entry.
+     */
+    readonly contactPointValue: string;
+    /**
+     * Returns the consent status.
+     */
+    readonly status: string;
+    private constructor();
+    /**
+     * Returns the channel type for this consent status entry.
+     */
+    getChannel(): string;
+    /**
+     * Returns the contact point value (email address or phone number) for this consent entry.
+     */
+    getContactPointValue(): string;
+    /**
+     * Returns the consent status.
+     */
+    getStatus(): string;
+}
+
+export = ConsentStatusEntry;

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

@@ -0,0 +1,110 @@
+import Collection = require('../../util/Collection');
+import ConsentStatusEntry = require('./ConsentStatusEntry');
+
+/**
+ * Represents a marketing consent subscription for a shopper.
+ * 
+ * A marketing consent subscription defines a communication preference category (e.g., "Newsletter", "Product Updates")
+ * with associated channels (EMAIL, SMS, WHATSAPP) through which the shopper can receive marketing communications.
+ * 
+ * Example usage:
+ * @example
+ * `
+ * var subscriptions = dw.customer.consent.ShopperConsentMgr.getSubscriptions();
+ * for each (var sub in subscriptions) {
+ * trace('Subscription: ' + sub.subscriptionId + ' - ' + sub.title);
+ * trace('Channels: ' + sub.channels);
+ * }
+ * `
+ */
+declare class MarketingConsentSubscription {
+    /**
+     * Returns the available channels for this subscription.
+     * 
+     * Channels represent the communication methods (EMAIL, SMS, WHATSAPP) available for this subscription.
+     */
+    readonly channels: string[];
+    /**
+     * Returns whether consent is required for this subscription.
+     */
+    readonly consentRequired: boolean;
+    /**
+     * Returns the consent status entries for this subscription.
+     * 
+     * This is only populated when the 'includeConsentStatus' parameter is true in the getSubscriptions call, and the
+     * customer is authenticated.
+     */
+    readonly consentStatus: Collection<ConsentStatusEntry> | null;
+    /**
+     * Returns the consent type for this subscription.
+     */
+    readonly consentType: string;
+    /**
+     * Returns the default consent status for this subscription.
+     */
+    readonly defaultStatus: string;
+    /**
+     * Returns the unique identifier for this subscription.
+     */
+    readonly subscriptionId: string;
+    /**
+     * Returns the localized subtitle of this subscription.
+     */
+    readonly subtitle: string;
+    /**
+     * Returns the tags associated with this subscription.
+     * 
+     * Tags can be used to categorize and filter subscriptions.
+     */
+    readonly tags: string[];
+    /**
+     * Returns the localized title of this subscription.
+     */
+    readonly title: string;
+    private constructor();
+    /**
+     * Returns the available channels for this subscription.
+     * 
+     * Channels represent the communication methods (EMAIL, SMS, WHATSAPP) available for this subscription.
+     */
+    getChannels(): string[];
+    /**
+     * Returns whether consent is required for this subscription.
+     */
+    getConsentRequired(): boolean;
+    /**
+     * Returns the consent status entries for this subscription.
+     * 
+     * This is only populated when the 'includeConsentStatus' parameter is true in the getSubscriptions call, and the
+     * customer is authenticated.
+     */
+    getConsentStatus(): Collection<ConsentStatusEntry> | null;
+    /**
+     * Returns the consent type for this subscription.
+     */
+    getConsentType(): string;
+    /**
+     * Returns the default consent status for this subscription.
+     */
+    getDefaultStatus(): string;
+    /**
+     * Returns the unique identifier for this subscription.
+     */
+    getSubscriptionId(): string;
+    /**
+     * Returns the localized subtitle of this subscription.
+     */
+    getSubtitle(): string;
+    /**
+     * Returns the tags associated with this subscription.
+     * 
+     * Tags can be used to categorize and filter subscriptions.
+     */
+    getTags(): string[];
+    /**
+     * Returns the localized title of this subscription.
+     */
+    getTitle(): string;
+}
+
+export = MarketingConsentSubscription;

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

@@ -0,0 +1,30 @@
+/**
+ * Error codes for ShopperConsentException.
+ * 
+ * These error codes indicate the reason why a shopper consent operation failed.
+ */
+declare class ShopperConsentErrorCodes {
+    /**
+     * Indicates that the customer is not authenticated.
+     */
+    static readonly CUSTOMER_NOT_AUTHENTICATED = "CUSTOMER_NOT_AUTHENTICATED";
+    /**
+     * Indicates that the Marketing Consent feature is not enabled.
+     */
+    static readonly FEATURE_DISABLED = "FEATURE_DISABLED";
+    /**
+     * Indicates that an internal error occurred.
+     */
+    static readonly INTERNAL_ERROR = "INTERNAL_ERROR";
+    /**
+     * Indicates that an error occurred while retrieving consent subscriptions.
+     */
+    static readonly RETRIEVAL_ERROR = "RETRIEVAL_ERROR";
+    /**
+     * Indicates that an error occurred while updating consent subscriptions.
+     */
+    static readonly UPDATE_ERROR = "UPDATE_ERROR";
+    private constructor();
+}
+
+export = ShopperConsentErrorCodes;

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

@@ -0,0 +1,29 @@
+/**
+ * This exception is thrown by ShopperConsentMgr methods when an error occurs
+ * during consent subscription operations.
+ * 
+ * The 'errorCode' property is set to one of the following values:
+ * 
+ * - ShopperConsentErrorCodes.FEATURE_DISABLED - Indicates that the Marketing Consent
+ * feature is not enabled.
+ * - ShopperConsentErrorCodes.RETRIEVAL_ERROR - Indicates that an error occurred while
+ * retrieving consent subscriptions.
+ * - ShopperConsentErrorCodes.UPDATE_ERROR - Indicates that an error occurred while
+ * updating consent subscriptions.
+ * - ShopperConsentErrorCodes.CUSTOMER_NOT_AUTHENTICATED - Indicates that the customer
+ * is not authenticated (required for consent status retrieval).
+ * - ShopperConsentErrorCodes.INTERNAL_ERROR - Indicates that an internal error occurred.
+ */
+declare class ShopperConsentException {
+    /**
+     * Returns the error code indicating the reason for the failure.
+     */
+    readonly errorCode: string;
+    private constructor();
+    /**
+     * Returns the error code indicating the reason for the failure.
+     */
+    getErrorCode(): string;
+}
+
+export = ShopperConsentException;