@salesforce/b2c-cli 1.11.0 → 1.12.0

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/order/PaymentMethod.d.ts

@@ -0,0 +1,141 @@
+import ExtensibleObject = require('../object/ExtensibleObject');
+import CustomAttributes = require('../object/CustomAttributes');
+import MarkupText = require('../content/MarkupText');
+import MediaFile = require('../content/MediaFile');
+import Customer = require('../customer/Customer');
+import PaymentProcessor = require('./PaymentProcessor');
+import List = require('../util/List');
+import PaymentCard = require('./PaymentCard');
+
+declare global {
+    module ICustomAttributes {
+        interface PaymentMethod extends CustomAttributes {
+        }
+    }
+}
+
+/**
+ * The PaymentMethod class represents a logical type of payment a customer can
+ * make in the storefront. This class provides methods to access the payment
+ * method attributes, status, and (for card-based payment methods) the related
+ * payment cards.
+ * 
+ * A typical storefront presents the customer a list of payment methods that a
+ * customer can choose from after he has entered his billing address during the
+ * checkout.
+ * dw.order.PaymentMgr.getApplicablePaymentMethods
+ * is used to determine the PaymentMethods that are relevant for the customer
+ * based on the amount of his order, his customer groups, and his shipping
+ * address.
+ */
+declare class PaymentMethod extends ExtensibleObject<ICustomAttributes.PaymentMethod> {
+    /**
+     * Returns the unique ID of the payment method.
+     */
+    readonly ID: string;
+    /**
+     * Returns 'true' if payment method is active (enabled), otherwise 'false' is returned.
+     */
+    readonly active: boolean;
+    /**
+     * Returns enabled payment cards that are assigned to this payment method, regardless
+     * of current customer, country or payment amount restrictions.
+     * The payment cards are sorted as defined in the Business Manager.
+     */
+    readonly activePaymentCards: List<PaymentCard>;
+    /**
+     * Returns the description of the payment method.
+     */
+    readonly description: MarkupText;
+    /**
+     * Returns the reference to the payment method image.
+     */
+    readonly image: MediaFile;
+    /**
+     * Returns the name of the payment method.
+     */
+    readonly name: string;
+    /**
+     * Returns the payment processor associated to this payment method.
+     */
+    readonly paymentProcessor: PaymentProcessor;
+    private constructor();
+    /**
+     * Returns enabled payment cards that are assigned to this payment method, regardless
+     * of current customer, country or payment amount restrictions.
+     * The payment cards are sorted as defined in the Business Manager.
+     */
+    getActivePaymentCards(): List<PaymentCard>;
+    /**
+     * Returns the sorted list of all enabled payment cards of this payment
+     * method applicable for the specified customer, country, payment amount and the session currency
+     * The payment cards are sorted as defined in the Business Manager.
+     * 
+     * A payment card is applicable if
+     * 
+     * -  the card is restricted by customer group, and at least one of
+     * the groups of the specified customer is assigned to the card
+     * -  the card is restricted by billing country, and the specified
+     * country code is assigned to the card
+     * - the card is restricted by payment amount for the session currency,
+     * and the specified payment amount is within the limits of the min/max
+     * payment amount defined for the method and the session currency
+     * -  the card is restricted by currency code, and the specified
+     * currency code matches session currency.
+     * 
+     * All parameters are optional, and if not specified, the respective
+     * restriction won't be validated. For example, if a card is restricted
+     * by billing country, but no country code is specified, this card will
+     * be returned, unless it is filtered out by customer group or payment
+     * amount.
+     */
+    getApplicablePaymentCards(customer: Customer | null, countryCode: string | null, paymentAmount: number): List<PaymentCard>;
+    /**
+     * Returns the description of the payment method.
+     */
+    getDescription(): MarkupText;
+    /**
+     * Returns the unique ID of the payment method.
+     */
+    getID(): string;
+    /**
+     * Returns the reference to the payment method image.
+     */
+    getImage(): MediaFile;
+    /**
+     * Returns the name of the payment method.
+     */
+    getName(): string;
+    /**
+     * Returns the payment processor associated to this payment method.
+     */
+    getPaymentProcessor(): PaymentProcessor;
+    /**
+     * Returns 'true' if payment method is active (enabled), otherwise 'false' is returned.
+     */
+    isActive(): boolean;
+    /**
+     * Returns 'true' if this payment method is applicable for the specified
+     * customer, country and payment amount and the session currency.
+     * 
+     * The payment method is applicable if
+     * 
+     * - the method is restricted by customer group, and at least one of the
+     * groups of the specified customer is assigned to the method
+     * - the method is restricted by billing country, and the specified
+     * country code is assigned to the method
+     * - the method is restricted by payment amount for the session currency,
+     * and the specified payment amount is within the limits of the min/max
+     * payment amount defined for the method and the session currency
+     * - the method is restricted by currency code, and the specified
+     * currency code matches session currency.
+     * 
+     * All parameters are optional, and if not specified, the respective
+     * restriction won't be validated. For example, if a method is restricted by
+     * billing country, but no country code is specified, this method will be
+     * returned, unless it is filtered out by customer group or payment amount.
+     */
+    isApplicable(customer: Customer | null, countryCode: string | null, paymentAmount: number): boolean;
+}
+
+export = PaymentMethod;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/order/PaymentMgr.d.ts

@@ -0,0 +1,70 @@
+import PaymentMethod = require('./PaymentMethod');
+import List = require('../util/List');
+import Customer = require('../customer/Customer');
+import PaymentCard = require('./PaymentCard');
+
+/**
+ * dw.order.PaymentMgr is used to access payment methods and payment
+ * cards of the current site.
+ * 
+ * To access payment methods and payment cards explicitly, use methods
+ * getPaymentMethod and getPaymentCard.
+ * 
+ * To access active payment methods use method getActivePaymentMethods.
+ * 
+ * To access applicable payment methods for a customer, country and/or payment
+ * amount use method getApplicablePaymentMethods.
+ */
+declare class PaymentMgr {
+    /**
+     * Returns the sorted list of all enabled payment methods of the current
+     * site, regardless of any customer group, country, payment amount or currency
+     * restrictions. The payment methods are sorted as defined in the Business
+     * Manager.
+     */
+    static readonly activePaymentMethods: List<PaymentMethod>;
+    private constructor();
+    /**
+     * Returns the sorted list of all enabled payment methods of the current
+     * site, regardless of any customer group, country, payment amount or currency
+     * restrictions. The payment methods are sorted as defined in the Business
+     * Manager.
+     */
+    static getActivePaymentMethods(): List<PaymentMethod>;
+    /**
+     * Returns the sorted list of all enabled payment methods of the current
+     * site applicable for the session currency, specified customer, country and payment amount.
+     * The payment methods are sorted as defined in the Business Manager.
+     * 
+     * A payment method is applicable if
+     * 
+     * -  the method is restricted by customer group, and at least one of
+     * the groups of the specified customer is assigned to the method
+     * -  the method is restricted by billing country, and the specified
+     * country code is assigned to the method
+     * - the method is restricted by payment amount for the session currency,
+     * and the specified payment amount is within the limits of the min/max
+     * payment amount defined for the method and the session currency
+     * -  the method is restricted by currency code, and the specified
+     * currency code matches session currency.
+     * 
+     * All parameters are optional, and if not specified, the respective
+     * restriction won't be validated. For example, if a method is restricted
+     * by billing country, but no country code is specified, this method will
+     * be returned, unless it is filtered out by customer group or payment
+     * amount.
+     */
+    static getApplicablePaymentMethods(customer: Customer | null, countryCode: string | null, paymentAmount: number): List<PaymentMethod>;
+    /**
+     * Returns the payment card for the specified cardType or null if no such
+     * card exists in the current site.
+     */
+    static getPaymentCard(cardType: string): PaymentCard | null;
+    /**
+     * Returns the payment method for the specified ID or null if no such method
+     * exists in the current site.
+     */
+    static getPaymentMethod(id: string): PaymentMethod | null;
+}
+
+export = PaymentMgr;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/order/PaymentProcessor.d.ts

@@ -0,0 +1,60 @@
+import ExtensibleObject = require('../object/ExtensibleObject');
+import CustomAttributes = require('../object/CustomAttributes');
+
+declare global {
+    module ICustomAttributes {
+        interface PaymentProcessor extends CustomAttributes {
+        }
+    }
+}
+
+/**
+ * A PaymentProcessor represents an entity that processes payments of one or more types. In the B2C Commerce system, a
+ * payment processor is just a container for configuration values, which describe, for example, the parameters (URL,
+ * merchant ID, password, etc) required for connecting to a payment gateway.
+ * 
+ * The system has several built in PaymentProcessors. These are:
+ * 
+ * - BASIC_CREDIT
+ * - BASIC_GIFT_CERTIFICATE
+ * - CYBERSOURCE_CREDIT
+ * - CYBERSOURCE_BML
+ * - PAYPAL_CREDIT
+ * - PAYPAL_EXPRESS
+ * - VERISIGN_CREDIT
+ * 
+ * The first two of these are merely placeholders with no associated preference values. The remaining system payment
+ * processors define preference values which are maintained in the Business Manager and are used in conjunction with
+ * built-in B2C Commerce payment integrations. Preferences of system PaymentProcessors are not intended to be read
+ * programmatically.
+ * 
+ * Merchants may also define custom payment processors. This is done by defining a payment processor with an arbitrary
+ * ID in the Business Manager, and then configuring an attribute group with the same ID on the
+ * dw.system.SitePreferences system object. Attributes added to the group will be considered preferences of the
+ * payment processor and will be readable through getPreferenceValue. Merchants can design their
+ * checkout process to read these preferences at run time for connecting to their payment gateways.
+ * 
+ * Every dw.order.PaymentMethod in the system is associated with at most one PaymentProcessor. This basically
+ * represents the physical payment gateway which processes the (logical) payment method. Each payment processor may be
+ * associated with an arbitrary number of payment methods. Also, each payment transaction has one PaymentProcessor which
+ * is set by custom code during the checkout process.
+ */
+declare class PaymentProcessor extends ExtensibleObject<ICustomAttributes.PaymentProcessor> {
+    /**
+     * Returns the 'ID' of this processor.
+     */
+    readonly ID: string;
+    private constructor();
+    /**
+     * Returns the 'ID' of this processor.
+     */
+    getID(): string;
+    /**
+     * Returns the value of the specified preference for this payment processor.
+     * If the preference name is invalid (or null) or no preference value is
+     * defined for this payment processor, null is returned.
+     */
+    getPreferenceValue(name: string): any | null;
+}
+
+export = PaymentProcessor;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/order/PaymentStatusCodes.d.ts

@@ -0,0 +1,25 @@
+/**
+ * Helper class containing status codes for the various errors that can occur
+ * when validating a payment card. One of these codes is returned as part of a
+ * Status object when a unsuccessful call to the `VerifyPaymentCard`
+ * or `VerifyCreditCard` pipelet is made. The same codes are used
+ * when calling dw.order.PaymentCard.verify or
+ * dw.order.PaymentCard.verify.
+ */
+declare class PaymentStatusCodes {
+    /**
+     * The code indicates that the credit card number is incorrect.
+     */
+    static readonly CREDITCARD_INVALID_CARD_NUMBER = "CREDITCARD_INVALID_CARD_NUMBER";
+    /**
+     * The code indicates that the credit card is expired.
+     */
+    static readonly CREDITCARD_INVALID_EXPIRATION_DATE = "CREDITCARD_INVALID_EXPIRATION_DATE";
+    /**
+     * The code indicates that the credit card security code length is invalid.
+     */
+    static readonly CREDITCARD_INVALID_SECURITY_CODE = "CREDITCARD_INVALID_SECURITY_CODE";
+    private constructor();
+}
+
+export = PaymentStatusCodes;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/order/PaymentTransaction.d.ts

@@ -0,0 +1,123 @@
+import ExtensibleObject = require('../object/ExtensibleObject');
+import CustomAttributes = require('../object/CustomAttributes');
+import OrderPaymentInstrument = require('./OrderPaymentInstrument');
+import PaymentProcessor = require('./PaymentProcessor');
+import Money = require('../value/Money');
+import EnumValue = require('../value/EnumValue');
+
+declare global {
+    module ICustomAttributes {
+        interface PaymentTransaction extends CustomAttributes {
+        }
+    }
+}
+
+/**
+ * The PaymentTransaction class represents a payment transaction.
+ */
+declare class PaymentTransaction extends ExtensibleObject<ICustomAttributes.PaymentTransaction> {
+    /**
+     * Constant representing the authorization type of payment transaction.
+     */
+    static readonly TYPE_AUTH = "AUTH";
+    /**
+     * Constant representing the authorization reversal type of payment transaction.
+     */
+    static readonly TYPE_AUTH_REVERSAL = "AUTH_REVERSAL";
+    /**
+     * Constant representing the capture type of payment transaction.
+     */
+    static readonly TYPE_CAPTURE = "CAPTURE";
+    /**
+     * Constant representing the credit type of payment transaction.
+     */
+    static readonly TYPE_CREDIT = "CREDIT";
+    /**
+     * Returns the payment service-specific account id.
+     */
+    accountID: string;
+    /**
+     * Returns the payment service-specific account type.
+     */
+    accountType: string;
+    /**
+     * Returns the amount of the transaction.
+     */
+    amount: Money;
+    /**
+     * Returns the payment instrument related to this payment transaction.
+     */
+    readonly paymentInstrument: OrderPaymentInstrument;
+    /**
+     * Returns the payment processor related to this payment transaction.
+     */
+    paymentProcessor: PaymentProcessor;
+    /**
+     * Returns the payment service-specific transaction id.
+     */
+    transactionID: string;
+    /**
+     * Returns the value of the transaction type where the
+     * value is one of TYPE_AUTH, TYPE_AUTH_REVERSAL, TYPE_CAPTURE
+     * or TYPE_CREDIT.
+     */
+    type: EnumValue;
+    private constructor();
+    /**
+     * Returns the payment service-specific account id.
+     */
+    getAccountID(): string;
+    /**
+     * Returns the payment service-specific account type.
+     */
+    getAccountType(): string;
+    /**
+     * Returns the amount of the transaction.
+     */
+    getAmount(): Money;
+    /**
+     * Returns the payment instrument related to this payment transaction.
+     */
+    getPaymentInstrument(): OrderPaymentInstrument;
+    /**
+     * Returns the payment processor related to this payment transaction.
+     */
+    getPaymentProcessor(): PaymentProcessor;
+    /**
+     * Returns the payment service-specific transaction id.
+     */
+    getTransactionID(): string;
+    /**
+     * Returns the value of the transaction type where the
+     * value is one of TYPE_AUTH, TYPE_AUTH_REVERSAL, TYPE_CAPTURE
+     * or TYPE_CREDIT.
+     */
+    getType(): EnumValue;
+    /**
+     * Sets the payment service-specific account id.
+     */
+    setAccountID(accountID: string): void;
+    /**
+     * Sets the payment service-specific account type.
+     */
+    setAccountType(accountType: string): void;
+    /**
+     * Sets the amount of the transaction.
+     */
+    setAmount(amount: Money): void;
+    /**
+     * Sets the payment processor related to this payment transaction.
+     */
+    setPaymentProcessor(paymentProcessor: PaymentProcessor): void;
+    /**
+     * Sets the payment service-specific transaction id.
+     */
+    setTransactionID(transactionID: string): void;
+    /**
+     * Sets the value of the transaction type where permissible
+     * values are TYPE_AUTH, TYPE_AUTH_REVERSAL, TYPE_CAPTURE or TYPE_CREDIT.
+     */
+    setType(type: string): void;
+}
+
+export = PaymentTransaction;