@salesforce/b2c-cli 1.10.0 → 1.12.0

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/extensions/payments/SalesforcePayPalOrderPayer.d.ts

@@ -0,0 +1,43 @@
+/**
+ * 
+ * 
+ * Salesforce Payments representation of a PayPal order's payer object. See Salesforce Payments documentation
+ * for how to gain access and configure it for use on your sites.
+ */
+declare class SalesforcePayPalOrderPayer {
+    /**
+     * Returns the payer's email address.
+     */
+    readonly emailAddress: string;
+    /**
+     * Returns the payer's given name.
+     */
+    readonly givenName: string;
+    /**
+     * Returns the payer's national phone number.
+     */
+    readonly phone: string;
+    /**
+     * Returns the payer's surname.
+     */
+    readonly surname: string;
+    private constructor();
+    /**
+     * Returns the payer's email address.
+     */
+    getEmailAddress(): string;
+    /**
+     * Returns the payer's given name.
+     */
+    getGivenName(): string;
+    /**
+     * Returns the payer's national phone number.
+     */
+    getPhone(): string;
+    /**
+     * Returns the payer's surname.
+     */
+    getSurname(): string;
+}
+
+export = SalesforcePayPalOrderPayer;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/extensions/payments/SalesforcePayPalPaymentDetails.d.ts

@@ -0,0 +1,33 @@
+import SalesforcePaymentDetails = require('./SalesforcePaymentDetails');
+
+/**
+ * 
+ * 
+ * Details to a Salesforce Payments payment of type SalesforcePayPalOrder.TYPE_PAYPAL. See Salesforce Payments
+ * documentation for how to gain access and configure it for use on your sites.
+ */
+declare class SalesforcePayPalPaymentDetails extends SalesforcePaymentDetails {
+    /**
+     * Returns the ID of the capture against the PayPal order, or `null` if not known.
+     * @see SalesforcePayPalOrder.getCaptureID
+     */
+    readonly captureID: string | null;
+    /**
+     * Returns the email address of the payer for the PayPal order, or `null` if not known.
+     * @see SalesforcePayPalOrderPayer.getEmailAddress
+     */
+    readonly payerEmailAddress: string | null;
+    private constructor();
+    /**
+     * Returns the ID of the capture against the PayPal order, or `null` if not known.
+     * @see SalesforcePayPalOrder.getCaptureID
+     */
+    getCaptureID(): string | null;
+    /**
+     * Returns the email address of the payer for the PayPal order, or `null` if not known.
+     * @see SalesforcePayPalOrderPayer.getEmailAddress
+     */
+    getPayerEmailAddress(): string | null;
+}
+
+export = SalesforcePayPalPaymentDetails;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/extensions/payments/SalesforcePaymentDetails.d.ts

@@ -0,0 +1,39 @@
+/**
+ * 
+ * 
+ * Base class details to a Salesforce Payments payment. See Salesforce Payments documentation for how to gain access and
+ * configure it for use on your sites.
+ * 
+ * Some payment types like SalesforcePaymentMethod.TYPE_CARD contain additional details like the card brand, or
+ * the last 4 digits of the card number. Details to those payments will be of a specific subclass of this class like
+ * SalesforceCardPaymentDetails. Other payment types have no additional information so their details are
+ * represented by an object of this base type.
+ */
+declare class SalesforcePaymentDetails {
+    /**
+     * Returns the payment type.
+     * @see SalesforcePaymentMethod.TYPE_BANCONTACT
+     * @see SalesforcePaymentMethod.TYPE_CARD
+     * @see SalesforcePaymentMethod.TYPE_EPS
+     * @see SalesforcePaymentMethod.TYPE_IDEAL
+     * @see SalesforcePaymentMethod.TYPE_KLARNA
+     * @see SalesforcePaymentMethod.TYPE_SEPA_DEBIT
+     * @see SalesforcePayPalOrder.TYPE_PAYPAL
+     * @see SalesforcePayPalOrder.TYPE_VENMO
+     */
+    readonly type: string;
+    /**
+     * Returns the payment type.
+     * @see SalesforcePaymentMethod.TYPE_BANCONTACT
+     * @see SalesforcePaymentMethod.TYPE_CARD
+     * @see SalesforcePaymentMethod.TYPE_EPS
+     * @see SalesforcePaymentMethod.TYPE_IDEAL
+     * @see SalesforcePaymentMethod.TYPE_KLARNA
+     * @see SalesforcePaymentMethod.TYPE_SEPA_DEBIT
+     * @see SalesforcePayPalOrder.TYPE_PAYPAL
+     * @see SalesforcePayPalOrder.TYPE_VENMO
+     */
+    getType(): string;
+}
+
+export = SalesforcePaymentDetails;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/extensions/payments/SalesforcePaymentIntent.d.ts

@@ -0,0 +1,116 @@
+import Money = require('../../value/Money');
+import SalesforcePaymentMethod = require('./SalesforcePaymentMethod');
+import OrderPaymentInstrument = require('../../order/OrderPaymentInstrument');
+import Basket = require('../../order/Basket');
+import Order = require('../../order/Order');
+
+/**
+ * 
+ * 
+ * Salesforce Payments representation of a Stripe payment intent object. See Salesforce Payments documentation for how
+ * to gain access and configure it for use on your sites.
+ * 
+ * A payment intent is automatically created when a shopper is ready to pay for items in their basket. It becomes
+ * confirmed when the shopper provides information to the payment provider that is acceptable to authorize payment for a
+ * given amount. Once that information has been provided it becomes available as the payment method associated with the
+ * payment intent.
+ */
+declare class SalesforcePaymentIntent {
+    /**
+     * Represents the payment method setup future usage is off session.
+     */
+    static readonly SETUP_FUTURE_USAGE_OFF_SESSION = "off_session";
+    /**
+     * Represents the payment method setup future usage is on session.
+     */
+    static readonly SETUP_FUTURE_USAGE_ON_SESSION = "on_session";
+    /**
+     * Returns the identifier of this payment intent.
+     */
+    readonly ID: string;
+    /**
+     * Returns the amount of this payment intent.
+     */
+    readonly amount: Money;
+    /**
+     * Returns `true` if this payment intent has a status which indicates it can be canceled,
+     * or `false` if its status does not indicate it can be canceled.
+     */
+    readonly cancelable: boolean;
+    /**
+     * Returns the client secret of this payment intent.
+     */
+    readonly clientSecret: string;
+    /**
+     * Returns `true` if this payment intent has been confirmed, or `false` if not.
+     */
+    readonly confirmed: boolean;
+    /**
+     * Returns the payment method for this payment intent, or `null` if none has been established.
+     */
+    readonly paymentMethod: SalesforcePaymentMethod | null;
+    /**
+     * Returns `true` if this payment intent has a status and other state which indicate it can be refunded,
+     * or `false` if it cannot be refunded.
+     */
+    readonly refundable: boolean;
+    /**
+     * Returns SETUP_FUTURE_USAGE_OFF_SESSION or SETUP_FUTURE_USAGE_ON_SESSION to indicate how the payment
+     * intent can be used in the future or returns `null` if future usage is not set up.
+     * @see SalesforcePaymentRequest.setSetupFutureUsage
+     * @see SalesforcePaymentIntent.SETUP_FUTURE_USAGE_OFF_SESSION
+     * @see SalesforcePaymentIntent.SETUP_FUTURE_USAGE_ON_SESSION
+     */
+    readonly setupFutureUsage: string | null;
+    private constructor();
+    /**
+     * Returns the amount of this payment intent.
+     */
+    getAmount(): Money;
+    /**
+     * Returns the client secret of this payment intent.
+     */
+    getClientSecret(): string;
+    /**
+     * Returns the identifier of this payment intent.
+     */
+    getID(): string;
+    /**
+     * Returns the payment instrument for this payment intent in the given basket, or `null` if the given
+     * basket has none.
+     */
+    getPaymentInstrument(basket: Basket): OrderPaymentInstrument | null;
+    /**
+     * Returns the payment instrument for this payment intent in the given order, or `null` if the given
+     * order has none.
+     */
+    getPaymentInstrument(order: Order): OrderPaymentInstrument | null;
+    /**
+     * Returns the payment method for this payment intent, or `null` if none has been established.
+     */
+    getPaymentMethod(): SalesforcePaymentMethod | null;
+    /**
+     * Returns SETUP_FUTURE_USAGE_OFF_SESSION or SETUP_FUTURE_USAGE_ON_SESSION to indicate how the payment
+     * intent can be used in the future or returns `null` if future usage is not set up.
+     * @see SalesforcePaymentRequest.setSetupFutureUsage
+     * @see SalesforcePaymentIntent.SETUP_FUTURE_USAGE_OFF_SESSION
+     * @see SalesforcePaymentIntent.SETUP_FUTURE_USAGE_ON_SESSION
+     */
+    getSetupFutureUsage(): string | null;
+    /**
+     * Returns `true` if this payment intent has a status which indicates it can be canceled,
+     * or `false` if its status does not indicate it can be canceled.
+     */
+    isCancelable(): boolean;
+    /**
+     * Returns `true` if this payment intent has been confirmed, or `false` if not.
+     */
+    isConfirmed(): boolean;
+    /**
+     * Returns `true` if this payment intent has a status and other state which indicate it can be refunded,
+     * or `false` if it cannot be refunded.
+     */
+    isRefundable(): boolean;
+}
+
+export = SalesforcePaymentIntent;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/extensions/payments/SalesforcePaymentMethod.d.ts

@@ -0,0 +1,162 @@
+import SalesforcePaymentDetails = require('./SalesforcePaymentDetails');
+import OrderPaymentInstrument = require('../../order/OrderPaymentInstrument');
+
+/**
+ * 
+ * 
+ * Salesforce Payments representation of a payment method object. See Salesforce Payments documentation for how
+ * to gain access and configure it for use on your sites.
+ * 
+ * A payment method contains information about a credential used by a shopper to attempt payment, such as a payment card
+ * or bank account. The available information differs for each type of payment method. It includes only limited
+ * information that can be safely presented to a shopper to remind them what credential they used, and specifically not
+ * complete card, account, or other numbers that could be used to make future payments.
+ */
+declare class SalesforcePaymentMethod {
+    /**
+     * Represents the Afterpay Clearpay payment method.
+     */
+    static readonly TYPE_AFTERPAY_CLEARPAY = "afterpay_clearpay";
+    /**
+     * Represents the Bancontact payment method.
+     */
+    static readonly TYPE_BANCONTACT = "bancontact";
+    /**
+     * Represents a credit card type of payment method.
+     */
+    static readonly TYPE_CARD = "card";
+    /**
+     * Represents the EPS (Electronic Payment Standard) payment method.
+     */
+    static readonly TYPE_EPS = "eps";
+    /**
+     * Represents the iDEAL payment method.
+     */
+    static readonly TYPE_IDEAL = "ideal";
+    /**
+     * Represents the Klarna payment method.
+     */
+    static readonly TYPE_KLARNA = "klarna";
+    /**
+     * Represents the SEPA Debit payment method.
+     */
+    static readonly TYPE_SEPA_DEBIT = "sepa_debit";
+    /**
+     * Returns the identifier of this payment method.
+     */
+    readonly ID: string;
+    /**
+     * Returns the bank of this payment method, or `null` if none is available. Available on
+     * SalesforcePaymentMethod.TYPE_IDEAL and SalesforcePaymentMethod.TYPE_EPS type methods.
+     */
+    readonly bank: string | null;
+    /**
+     * Returns the bank code of this payment method, or `null` if none is available. Available on
+     * SalesforcePaymentMethod.TYPE_SEPA_DEBIT and SalesforcePaymentMethod.TYPE_BANCONTACT type methods.
+     */
+    readonly bankCode: string | null;
+    /**
+     * Returns the bank name of this payment method, or `null` if none is available. Available on
+     * SalesforcePaymentMethod.TYPE_BANCONTACT type methods.
+     */
+    readonly bankName: string | null;
+    /**
+     * Returns the bank branch code of this payment method, or `null` if none is available. Available on
+     * SalesforcePaymentMethod.TYPE_SEPA_DEBIT type methods.
+     */
+    readonly branchCode: string | null;
+    /**
+     * Returns the brand of this payment method, or `null` if none is available. Available on
+     * SalesforcePaymentMethod.TYPE_CARD type methods.
+     */
+    readonly brand: string | null;
+    /**
+     * Returns the country of this payment method, or `null` if none is available. Available on
+     * SalesforcePaymentMethod.TYPE_SEPA_DEBIT type methods.
+     */
+    readonly country: string | null;
+    /**
+     * Returns the last 4 digits of the credential for this payment method, or `null` if none is available.
+     * Available on SalesforcePaymentMethod.TYPE_CARD, SalesforcePaymentMethod.TYPE_SEPA_DEBIT, and
+     * SalesforcePaymentMethod.TYPE_BANCONTACT type methods.
+     */
+    readonly last4: string | null;
+    /**
+     * Returns the payment method category of this payment method, or `null` if none is available. Available
+     * on SalesforcePaymentMethod.TYPE_KLARNA type methods.
+     */
+    readonly paymentMethodCategory: string | null;
+    /**
+     * Returns the type of this payment method.
+     * @see SalesforcePaymentMethod.TYPE_BANCONTACT
+     * @see SalesforcePaymentMethod.TYPE_CARD
+     * @see SalesforcePaymentMethod.TYPE_EPS
+     * @see SalesforcePaymentMethod.TYPE_AFTERPAY_CLEARPAY
+     * @see SalesforcePaymentMethod.TYPE_IDEAL
+     * @see SalesforcePaymentMethod.TYPE_SEPA_DEBIT
+     */
+    readonly type: string;
+    private constructor();
+    /**
+     * Returns the bank of this payment method, or `null` if none is available. Available on
+     * SalesforcePaymentMethod.TYPE_IDEAL and SalesforcePaymentMethod.TYPE_EPS type methods.
+     */
+    getBank(): string | null;
+    /**
+     * Returns the bank code of this payment method, or `null` if none is available. Available on
+     * SalesforcePaymentMethod.TYPE_SEPA_DEBIT and SalesforcePaymentMethod.TYPE_BANCONTACT type methods.
+     */
+    getBankCode(): string | null;
+    /**
+     * Returns the bank name of this payment method, or `null` if none is available. Available on
+     * SalesforcePaymentMethod.TYPE_BANCONTACT type methods.
+     */
+    getBankName(): string | null;
+    /**
+     * Returns the bank branch code of this payment method, or `null` if none is available. Available on
+     * SalesforcePaymentMethod.TYPE_SEPA_DEBIT type methods.
+     */
+    getBranchCode(): string | null;
+    /**
+     * Returns the brand of this payment method, or `null` if none is available. Available on
+     * SalesforcePaymentMethod.TYPE_CARD type methods.
+     */
+    getBrand(): string | null;
+    /**
+     * Returns the country of this payment method, or `null` if none is available. Available on
+     * SalesforcePaymentMethod.TYPE_SEPA_DEBIT type methods.
+     */
+    getCountry(): string | null;
+    /**
+     * Returns the identifier of this payment method.
+     */
+    getID(): string;
+    /**
+     * Returns the last 4 digits of the credential for this payment method, or `null` if none is available.
+     * Available on SalesforcePaymentMethod.TYPE_CARD, SalesforcePaymentMethod.TYPE_SEPA_DEBIT, and
+     * SalesforcePaymentMethod.TYPE_BANCONTACT type methods.
+     */
+    getLast4(): string | null;
+    /**
+     * Returns the details to the Salesforce Payments payment for this payment method, using the given payment
+     * instrument.
+     */
+    getPaymentDetails(paymentInstrument: OrderPaymentInstrument): SalesforcePaymentDetails;
+    /**
+     * Returns the payment method category of this payment method, or `null` if none is available. Available
+     * on SalesforcePaymentMethod.TYPE_KLARNA type methods.
+     */
+    getPaymentMethodCategory(): string | null;
+    /**
+     * Returns the type of this payment method.
+     * @see SalesforcePaymentMethod.TYPE_BANCONTACT
+     * @see SalesforcePaymentMethod.TYPE_CARD
+     * @see SalesforcePaymentMethod.TYPE_EPS
+     * @see SalesforcePaymentMethod.TYPE_AFTERPAY_CLEARPAY
+     * @see SalesforcePaymentMethod.TYPE_IDEAL
+     * @see SalesforcePaymentMethod.TYPE_SEPA_DEBIT
+     */
+    getType(): string;
+}
+
+export = SalesforcePaymentMethod;