@salesforce/b2c-cli 1.11.0 → 1.12.0

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/extensions/paymentrequest/PaymentRequestHooks.d.ts

@@ -0,0 +1,168 @@
+import PaymentRequestHookResult = require('./PaymentRequestHookResult');
+import Basket = require('../../order/Basket');
+import ShippingMethod = require('../../order/ShippingMethod');
+import Status = require('../../system/Status');
+import Order = require('../../order/Order');
+
+/**
+ * PaymentRequestHooks interface containing extension points for customizing Payment Requests.
+ * 
+ * These hooks are executed in a transaction.
+ * 
+ * The extension points (hook names), and the functions that are called by each extension point. A function must be
+ * defined inside a JavaScript source and must be exported. The script with the exported hook function must be located
+ * inside a site cartridge. Inside the site cartridge a 'package.json' file with a 'hooks' entry must exist.
+ * 
+ * ```
+ * "hooks": "./hooks.json"
+ * ```
+ * 
+ * The hooks entry links to a json file, relative to the 'package.json' file. This file lists all registered hooks
+ * inside the hooks property:
+ * 
+ * ```
+ * "hooks": [
+ * {"name": "dw.extensions.paymentrequest.getPaymentRequest", "script": "./paymentrequest.ds"}
+ * {"name": "dw.extensions.paymentrequest.shippingAddressChange", "script": "./paymentrequest.ds"}
+ * ]
+ * ```
+ * 
+ * A hook entry has a 'name' and a 'script' property.
+ * 
+ * - The 'name' contains the extension point, the hook name.
+ * - The 'script' contains the script relative to the hooks file, with the exported hook function.
+ * @deprecated Salesforce Payments includes support for Google Pay
+ */
+declare interface PaymentRequestHooks {
+    /**
+     * The extension point name extensionPointAbort.
+     */
+    readonly extensionPointAbort: "dw.extensions.paymentrequest.abort";
+    /**
+     * The extension point name extensionPointGetPaymentRequest.
+     */
+    readonly extensionPointGetPaymentRequest: "dw.extensions.paymentrequest.getPaymentRequest";
+    /**
+     * The extension point name extensionPointPaymentAcceptedAuthorizeOrderPayment.
+     */
+    readonly extensionPointPaymentAcceptedAuthorizeOrderPayment: "dw.extensions.paymentrequest.paymentAccepted.authorizeOrderPayment";
+    /**
+     * The extension point name extensionPointPaymentAcceptedPlaceOrder.
+     */
+    readonly extensionPointPaymentAcceptedPlaceOrder: "dw.extensions.paymentrequest.paymentAccepted.placeOrder";
+    /**
+     * The extension point name extensionPointShippingAddressChange.
+     */
+    readonly extensionPointShippingAddressChange: "dw.extensions.paymentrequest.shippingAddressChange";
+    /**
+     * The extension point name extensionPointShippingOptionChange.
+     */
+    readonly extensionPointShippingOptionChange: "dw.extensions.paymentrequest.shippingOptionChange";
+    /**
+     * 
+     * 
+     * Called after the Payment Request user interface was canceled. The given basket is the one that was passed to other
+     * hooks earlier in the Payment Request checkout process.
+     * 
+     * It is not guaranteed that this hook will be executed for all Payment Request user interfaces canceled by shoppers or
+     * otherwise ended without a successful order. Calls to this hook are provided on a best-effort basis.
+     * 
+     * If the returned result includes a redirect URL, the shopper browser will be navigated to that URL if possible. It
+     * is not guaranteed that the response with the hook result will be handled in the shopper browser in all cases.
+     */
+    abort(basket: Basket): PaymentRequestHookResult;
+    /**
+     * 
+     * 
+     * Called after the shopper accepts the Payment Request payment for the given order. Basket customer information,
+     * billing address, and/or shipping address for the default shipment will have already been updated to reflect the
+     * available contact information provided by Payment Request. Any preexisting payment instruments on the basket will
+     * have been removed, and a single `DW_ANDROID_PAY` payment instrument added for the total amount. The
+     * given order will have been created from this updated basket.
+     * 
+     * The purpose of this hook is to authorize the Payment Request payment for the order. If a non-error status is returned
+     * that means that you have successfully authorized the payment with your payment service provider. Your hook
+     * implementation must set the necessary payment status and transaction identifier data on the order as returned by
+     * the provider.
+     * 
+     * Return an error status to indicate a problem, including unsuccessful authorization.
+     * 
+     * See the Payment Request API for more information.
+     */
+    authorizeOrderPayment(order: Order, response: Object): Status;
+    /**
+     * 
+     * 
+     * Called to get the `PaymentRequest` constructor parameters for the given basket. You can
+     * set properties in the given `parameters` object to extend or override default properties set
+     * automatically based on the Google Pay configuration for your site.
+     * 
+     * The `parameters` object will contain the following properties by default:
+     * 
+     * - `methodData` - array containing payment methods the web site accepts
+     * - `details` - information about the transaction that the user is being asked to complete
+     * - `options` - information about what options the web page wishes to use from the payment request system
+     * 
+     * Return a result with an error status to indicate a problem.
+     * 
+     * If the returned result includes a redirect URL, the shopper browser will be navigated to that URL if the Payment
+     * Request user interaction is canceled.
+     * 
+     * See the Payment Request API for more information.
+     */
+    getPaymentRequest(basket: Basket, parameters: Object): PaymentRequestHookResult;
+    /**
+     * 
+     * 
+     * Called after payment has been authorized and the given Payment Request order is ready to be placed. The purpose of
+     * this hook is to place the order, or return a redirect URL that results in the order being placed when the shopper
+     * browser is navigated to it.
+     * 
+     * The default implementation of this hook returns a redirect to `COPlaceOrder-Submit` with URL
+     * parameters `order_id` set to dw.order.Order.getOrderNo and `order_token` set to
+     * dw.order.Order.getOrderToken which corresponds to SiteGenesis-based implementations. Your hook
+     * implementation should return a result with a different redirect URL as necessary to place the order and show an
+     * order confirmation.
+     * 
+     * Alternatively, your hook implementation itself can place the order and return a result with a redirect URL to an
+     * order confirmation page that does not place the order. This is inconsistent with SiteGenesis-based
+     * implementations so is not the default.
+     * 
+     * Return an error status to indicate a problem. If the returned result includes a redirect URL, the shopper browser
+     * will be navigated to that URL if the Payment Request user interface is canceled.
+     */
+    placeOrder(order: Order): PaymentRequestHookResult;
+    /**
+     * 
+     * 
+     * Called after handling the Payment Request `shippingaddresschange` event for the given basket. Basket
+     * customer information and/or shipping address for the default shipment will have already been updated to reflect
+     * the available shipping address information provided by Payment Request. The basket will have already been
+     * calculated before this hook is called.
+     * 
+     * Return a result with an error status to indicate a problem.
+     * 
+     * If the returned result includes a redirect URL, the shopper browser will be navigated to that URL if the Payment
+     * Request user interface is canceled.
+     * 
+     * See the Payment Request API for more information.
+     */
+    shippingAddressChange(basket: Basket, details: Object): PaymentRequestHookResult;
+    /**
+     * 
+     * 
+     * Called after handling the Payment Request `shippingoptionchange` event for the given basket. The given
+     * shipping method will have already been set on the basket. The basket will have already been calculated before
+     * this hook is called.
+     * 
+     * Return a result with an error status to indicate a problem.
+     * 
+     * If the returned result includes a redirect URL, the shopper browser will be navigated to that URL if the
+     * Payment Request user interface is canceled.
+     * 
+     * See the Payment Request API for more information.
+     */
+    shippingOptionChange(basket: Basket, shippingMethod: ShippingMethod, details: Object): PaymentRequestHookResult;
+}
+
+export = PaymentRequestHooks;

package/dist/script-types/node_modules/@salesforce/b2c-script-types/types/dw/extensions/paymentrequest/index.d.ts

@@ -0,0 +1,7 @@
+import PaymentRequestHookResult = require('./PaymentRequestHookResult');
+import PaymentRequestHooks = require('./PaymentRequestHooks');
+
+export {
+    PaymentRequestHookResult,
+    PaymentRequestHooks
+};

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

@@ -0,0 +1,53 @@
+import OrderPaymentInstrument = require('../../order/OrderPaymentInstrument');
+import Basket = require('../../order/Basket');
+import Order = require('../../order/Order');
+
+/**
+ * 
+ * 
+ * Salesforce Payments representation of an Adyen payment intent object. See Salesforce Payments documentation for how
+ * to gain access and configure it for use on your sites.
+ */
+declare class SalesforceAdyenPaymentIntent {
+    /**
+     * Returns the identifier of this payment intent.
+     */
+    readonly ID: string;
+    /**
+     * Returns the payment action for this payment intent.
+     */
+    readonly action: Object;
+    /**
+     * Returns the Adyen result code for this payment intent.
+     */
+    readonly resultCode: string;
+    private constructor();
+    /**
+     * Returns the payment action for this payment intent.
+     */
+    getAction(): Object;
+    /**
+     * 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 Adyen result code for this payment intent.
+     */
+    getResultCode(): string;
+    /**
+     * Returns `true` if this payment intent has an action, or `false` if not.
+     */
+    hasAction(): boolean;
+}
+
+export = SalesforceAdyenPaymentIntent;

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

@@ -0,0 +1,126 @@
+/**
+ * 
+ * 
+ * Salesforce Payments representation of an Adyen saved payment method object. See Salesforce Payments documentation for
+ * how to gain access and configure it for use on your sites.
+ * 
+ * An Adyen saved 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 SalesforceAdyenSavedPaymentMethod {
+    /**
+     * 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 iDEAL payment method.
+     */
+    static readonly TYPE_IDEAL = "ideal";
+    /**
+     * 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 brand of this payment method, or `null` if none is available. Available on
+     * SalesforceAdyenSavedPaymentMethod.TYPE_CARD type methods.
+     */
+    readonly brand: string | null;
+    /**
+     * Returns the expiry month of the card for this payment method, or `null` if none is available.
+     * Available on SalesforceAdyenSavedPaymentMethod.TYPE_CARD and
+     * SalesforceAdyenSavedPaymentMethod.TYPE_BANCONTACT type methods.
+     */
+    readonly expiryMonth: string | null;
+    /**
+     * Returns the expiry year of the card for this payment method, or `null` if none is available. Available
+     * on SalesforceAdyenSavedPaymentMethod.TYPE_CARD and
+     * SalesforceAdyenSavedPaymentMethod.TYPE_BANCONTACT type methods.
+     */
+    readonly expiryYear: string | null;
+    /**
+     * Returns the cardholder name for this payment method, or `null` if none is available. Available on
+     * SalesforceAdyenSavedPaymentMethod.TYPE_CARD and SalesforceAdyenSavedPaymentMethod.TYPE_BANCONTACT
+     * type methods.
+     */
+    readonly holderName: string | null;
+    /**
+     * Returns the last 4 digits of the credential for this payment method, or `null` if none is available.
+     * Available on SalesforceAdyenSavedPaymentMethod.TYPE_CARD and
+     * SalesforceAdyenSavedPaymentMethod.TYPE_BANCONTACT type methods.
+     */
+    readonly last4: string | null;
+    /**
+     * Returns the back account owner name for this payment method, or `null` if none is available. Available
+     * on SalesforceAdyenSavedPaymentMethod.TYPE_SEPA_DEBIT and
+     * SalesforceAdyenSavedPaymentMethod.TYPE_IDEAL type method.
+     */
+    readonly ownerName: string | null;
+    /**
+     * Returns the type of this payment method.
+     * @see SalesforceAdyenSavedPaymentMethod.TYPE_BANCONTACT
+     * @see SalesforceAdyenSavedPaymentMethod.TYPE_CARD
+     * @see SalesforceAdyenSavedPaymentMethod.TYPE_IDEAL
+     * @see SalesforceAdyenSavedPaymentMethod.TYPE_SEPA_DEBIT
+     */
+    readonly type: string;
+    private constructor();
+    /**
+     * Returns the brand of this payment method, or `null` if none is available. Available on
+     * SalesforceAdyenSavedPaymentMethod.TYPE_CARD type methods.
+     */
+    getBrand(): string | null;
+    /**
+     * Returns the expiry month of the card for this payment method, or `null` if none is available.
+     * Available on SalesforceAdyenSavedPaymentMethod.TYPE_CARD and
+     * SalesforceAdyenSavedPaymentMethod.TYPE_BANCONTACT type methods.
+     */
+    getExpiryMonth(): string | null;
+    /**
+     * Returns the expiry year of the card for this payment method, or `null` if none is available. Available
+     * on SalesforceAdyenSavedPaymentMethod.TYPE_CARD and
+     * SalesforceAdyenSavedPaymentMethod.TYPE_BANCONTACT type methods.
+     */
+    getExpiryYear(): string | null;
+    /**
+     * Returns the cardholder name for this payment method, or `null` if none is available. Available on
+     * SalesforceAdyenSavedPaymentMethod.TYPE_CARD and SalesforceAdyenSavedPaymentMethod.TYPE_BANCONTACT
+     * type methods.
+     */
+    getHolderName(): 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 SalesforceAdyenSavedPaymentMethod.TYPE_CARD and
+     * SalesforceAdyenSavedPaymentMethod.TYPE_BANCONTACT type methods.
+     */
+    getLast4(): string | null;
+    /**
+     * Returns the back account owner name for this payment method, or `null` if none is available. Available
+     * on SalesforceAdyenSavedPaymentMethod.TYPE_SEPA_DEBIT and
+     * SalesforceAdyenSavedPaymentMethod.TYPE_IDEAL type method.
+     */
+    getOwnerName(): string | null;
+    /**
+     * Returns the type of this payment method.
+     * @see SalesforceAdyenSavedPaymentMethod.TYPE_BANCONTACT
+     * @see SalesforceAdyenSavedPaymentMethod.TYPE_CARD
+     * @see SalesforceAdyenSavedPaymentMethod.TYPE_IDEAL
+     * @see SalesforceAdyenSavedPaymentMethod.TYPE_SEPA_DEBIT
+     */
+    getType(): string;
+}
+
+export = SalesforceAdyenSavedPaymentMethod;

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

@@ -0,0 +1,33 @@
+import SalesforcePaymentDetails = require('./SalesforcePaymentDetails');
+
+/**
+ * 
+ * 
+ * Details to a Salesforce Payments payment of type SalesforcePaymentMethod.TYPE_BANCONTACT. See Salesforce Payments
+ * documentation for how to gain access and configure it for use on your sites.
+ */
+declare class SalesforceBancontactPaymentDetails extends SalesforcePaymentDetails {
+    /**
+     * Returns the bank name, or `null` if not known.
+     * @see SalesforcePaymentMethod.getBankName
+     */
+    readonly bankName: string | null;
+    /**
+     * Returns the last 4 digits of the account number, or `null` if not known.
+     * @see SalesforcePaymentMethod.getLast4
+     */
+    readonly last4: string | null;
+    private constructor();
+    /**
+     * Returns the bank name, or `null` if not known.
+     * @see SalesforcePaymentMethod.getBankName
+     */
+    getBankName(): string | null;
+    /**
+     * Returns the last 4 digits of the account number, or `null` if not known.
+     * @see SalesforcePaymentMethod.getLast4
+     */
+    getLast4(): string | null;
+}
+
+export = SalesforceBancontactPaymentDetails;

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

@@ -0,0 +1,41 @@
+import SalesforcePaymentDetails = require('./SalesforcePaymentDetails');
+
+/**
+ * 
+ * 
+ * Details to a Salesforce Payments payment of type SalesforcePaymentMethod.TYPE_CARD. See Salesforce Payments
+ * documentation for how to gain access and configure it for use on your sites.
+ */
+declare class SalesforceCardPaymentDetails extends SalesforcePaymentDetails {
+    /**
+     * Returns the card brand, or `null` if not known.
+     * @see SalesforcePaymentMethod.getBrand
+     */
+    readonly brand: string | null;
+    /**
+     * Returns the last 4 digits of the card number, or `null` if not known.
+     * @see SalesforcePaymentMethod.getLast4
+     */
+    readonly last4: string | null;
+    /**
+     * Returns the type of wallet used to make the card payment, or `null` if not known.
+     */
+    readonly walletType: string | null;
+    private constructor();
+    /**
+     * Returns the card brand, or `null` if not known.
+     * @see SalesforcePaymentMethod.getBrand
+     */
+    getBrand(): string | null;
+    /**
+     * Returns the last 4 digits of the card number, or `null` if not known.
+     * @see SalesforcePaymentMethod.getLast4
+     */
+    getLast4(): string | null;
+    /**
+     * Returns the type of wallet used to make the card payment, or `null` if not known.
+     */
+    getWalletType(): string | null;
+}
+
+export = SalesforceCardPaymentDetails;

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

@@ -0,0 +1,23 @@
+import SalesforcePaymentDetails = require('./SalesforcePaymentDetails');
+
+/**
+ * 
+ * 
+ * Details to a Salesforce Payments payment of type SalesforcePaymentMethod.TYPE_EPS. See Salesforce Payments
+ * documentation for how to gain access and configure it for use on your sites.
+ */
+declare class SalesforceEpsPaymentDetails extends SalesforcePaymentDetails {
+    /**
+     * Returns the bank used for the payment, or `null` if not known.
+     * @see SalesforcePaymentMethod.getBank
+     */
+    readonly bank: string | null;
+    private constructor();
+    /**
+     * Returns the bank used for the payment, or `null` if not known.
+     * @see SalesforcePaymentMethod.getBank
+     */
+    getBank(): string | null;
+}
+
+export = SalesforceEpsPaymentDetails;

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

@@ -0,0 +1,23 @@
+import SalesforcePaymentDetails = require('./SalesforcePaymentDetails');
+
+/**
+ * 
+ * 
+ * Details to a Salesforce Payments payment of type SalesforcePaymentMethod.TYPE_IDEAL. See Salesforce Payments
+ * documentation for how to gain access and configure it for use on your sites.
+ */
+declare class SalesforceIdealPaymentDetails extends SalesforcePaymentDetails {
+    /**
+     * Returns the bank used for the payment, or `null` if not known.
+     * @see SalesforcePaymentMethod.getBank
+     */
+    readonly bank: string | null;
+    private constructor();
+    /**
+     * Returns the bank used for the payment, or `null` if not known.
+     * @see SalesforcePaymentMethod.getBank
+     */
+    getBank(): string | null;
+}
+
+export = SalesforceIdealPaymentDetails;

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

@@ -0,0 +1,23 @@
+import SalesforcePaymentDetails = require('./SalesforcePaymentDetails');
+
+/**
+ * 
+ * 
+ * Details to a Salesforce Payments payment of type SalesforcePaymentMethod.TYPE_KLARNA. See Salesforce Payments
+ * documentation for how to gain access and configure it for use on your sites.
+ */
+declare class SalesforceKlarnaPaymentDetails extends SalesforcePaymentDetails {
+    /**
+     * Returns the payment method category used for the payment, or `null` if not known.
+     * @see SalesforcePaymentMethod.getPaymentMethodCategory
+     */
+    readonly paymentMethodCategory: string | null;
+    private constructor();
+    /**
+     * Returns the payment method category used for the payment, or `null` if not known.
+     * @see SalesforcePaymentMethod.getPaymentMethodCategory
+     */
+    getPaymentMethodCategory(): string | null;
+}
+
+export = SalesforceKlarnaPaymentDetails;

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

@@ -0,0 +1,109 @@
+import Money = require('../../value/Money');
+import SalesforcePayPalOrderPayer = require('./SalesforcePayPalOrderPayer');
+import SalesforcePayPalOrderAddress = require('./SalesforcePayPalOrderAddress');
+import OrderPaymentInstrument = require('../../order/OrderPaymentInstrument');
+import Basket = require('../../order/Basket');
+import Order = require('../../order/Order');
+import SalesforcePaymentDetails = require('./SalesforcePaymentDetails');
+
+/**
+ * 
+ * 
+ * Salesforce Payments representation of a PayPal order object. See Salesforce Payments documentation for how
+ * to gain access and configure it for use on your sites.
+ * 
+ * A PayPal order is automatically created when a shopper is ready to pay for items in their basket. It becomes
+ * completed when the shopper provides information to the payment provider that is acceptable to authorize payment for a
+ * given amount.
+ */
+declare class SalesforcePayPalOrder {
+    /**
+     * Represents the `"AUTHORIZE"` intent, meaning manual capture.
+     */
+    static readonly INTENT_AUTHORIZE = "AUTHORIZE";
+    /**
+     * Represents the `"CAPTURE"` intent, meaning automatic capture.
+     */
+    static readonly INTENT_CAPTURE = "CAPTURE";
+    /**
+     * Represents the PayPal funding source.
+     */
+    static readonly TYPE_PAYPAL = "paypal";
+    /**
+     * Represents the Venmo funding source.
+     */
+    static readonly TYPE_VENMO = "venmo";
+    /**
+     * Returns the identifier of this PayPal order.
+     */
+    readonly ID: string;
+    /**
+     * Returns the amount of this PayPal order.
+     */
+    readonly amount: Money;
+    /**
+     * Returns the ID of the authorization against this order, or `null` if not available.
+     */
+    readonly authorizationID: string | null;
+    /**
+     * Returns the ID of the capture against this order, or `null` if not available.
+     */
+    readonly captureID: string | null;
+    /**
+     * Returns `true` if this PayPal order has been completed, or `false` if not.
+     */
+    readonly completed: boolean;
+    /**
+     * Returns the payer information for this PayPal order, or `null` if not known.
+     */
+    readonly payer: SalesforcePayPalOrderPayer | null;
+    /**
+     * Returns the shipping address for this PayPal order, or `null` if not known.
+     */
+    readonly shipping: SalesforcePayPalOrderAddress | null;
+    private constructor();
+    /**
+     * Returns the amount of this PayPal order.
+     */
+    getAmount(): Money;
+    /**
+     * Returns the ID of the authorization against this order, or `null` if not available.
+     */
+    getAuthorizationID(): string | null;
+    /**
+     * Returns the ID of the capture against this order, or `null` if not available.
+     */
+    getCaptureID(): string | null;
+    /**
+     * Returns the identifier of this PayPal order.
+     */
+    getID(): string;
+    /**
+     * Returns the payer information for this PayPal order, or `null` if not known.
+     */
+    getPayer(): SalesforcePayPalOrderPayer | null;
+    /**
+     * Returns the details to the Salesforce Payments payment for this PayPal order, using the given payment instrument.
+     */
+    getPaymentDetails(paymentInstrument: OrderPaymentInstrument): SalesforcePaymentDetails;
+    /**
+     * Returns the payment instrument for this PayPal order in the given basket, or `null` if the given
+     * basket has none.
+     */
+    getPaymentInstrument(basket: Basket): OrderPaymentInstrument | null;
+    /**
+     * Returns the payment instrument for this PayPal order in the given order, or `null` if the given
+     * order has none.
+     */
+    getPaymentInstrument(order: Order): OrderPaymentInstrument | null;
+    /**
+     * Returns the shipping address for this PayPal order, or `null` if not known.
+     */
+    getShipping(): SalesforcePayPalOrderAddress | null;
+    /**
+     * Returns `true` if this PayPal order has been completed, or `false` if not.
+     */
+    isCompleted(): boolean;
+}
+
+export = SalesforcePayPalOrder;

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

@@ -0,0 +1,69 @@
+/**
+ * 
+ * 
+ * Salesforce Payments representation of a PayPal order address object. See Salesforce Payments documentation
+ * for how to gain access and configure it for use on your sites.
+ */
+declare class SalesforcePayPalOrderAddress {
+    /**
+     * Returns the address line 1.
+     */
+    readonly addressLine1: string;
+    /**
+     * Returns the address line 2.
+     */
+    readonly addressLine2: string;
+    /**
+     * Returns the address highest level sub-division in a country, which is usually a province, state, or ISO-3166-2
+     * subdivision.
+     */
+    readonly adminArea1: string;
+    /**
+     * Returns the address city, town, or village.
+     */
+    readonly adminArea2: string;
+    /**
+     * Returns the address two-character ISO 3166-1 code that identifies the country or region.
+     */
+    readonly countryCode: string;
+    /**
+     * Returns the address full name.
+     */
+    readonly fullName: string;
+    /**
+     * Returns the address postal code.
+     */
+    readonly postalCode: string;
+    private constructor();
+    /**
+     * Returns the address line 1.
+     */
+    getAddressLine1(): string;
+    /**
+     * Returns the address line 2.
+     */
+    getAddressLine2(): string;
+    /**
+     * Returns the address highest level sub-division in a country, which is usually a province, state, or ISO-3166-2
+     * subdivision.
+     */
+    getAdminArea1(): string;
+    /**
+     * Returns the address city, town, or village.
+     */
+    getAdminArea2(): string;
+    /**
+     * Returns the address two-character ISO 3166-1 code that identifies the country or region.
+     */
+    getCountryCode(): string;
+    /**
+     * Returns the address full name.
+     */
+    getFullName(): string;
+    /**
+     * Returns the address postal code.
+     */
+    getPostalCode(): string;
+}
+
+export = SalesforcePayPalOrderAddress;