@salesforce/b2c-cli 1.10.0 → 1.12.0

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

@@ -0,0 +1,166 @@
+import PaymentInstrument = require('./PaymentInstrument');
+import ExtensibleObject = require('../object/ExtensibleObject');
+import CustomAttributes = require('../object/CustomAttributes');
+import PaymentTransaction = require('./PaymentTransaction');
+import Money = require('../value/Money');
+
+declare global {
+    module ICustomAttributes {
+        interface OrderPaymentInstrument extends ICustomAttributes.PaymentInstrument {
+        }
+    }
+}
+
+/**
+ * Represents any payment instrument used to pay orders, such as credit card
+ * or bank transfer. The object defines standard methods for credit card
+ * payment, and can be extended by attributes appropriate for other
+ * payment methods.
+ */
+declare class OrderPaymentInstrument extends PaymentInstrument<ICustomAttributes.OrderPaymentInstrument> {
+    /**
+     * Returns the driver's license associated with a bank account if the calling
+     * context meets the following criteria:
+     * 
+     * -
+     * If the method call happens in the context of a storefront request and
+     * the current customer is identical to the customer related to the basket
+     * or order, and the current protocol is HTTPS.
+     * 
+     * -
+     * If the method call happens in the context of the business manager and the
+     * current user has permission to the Orders module.
+     * 
+     * Otherwise, the method throws an exception.
+     */
+    readonly bankAccountDriversLicense: string;
+    /**
+     * Returns the account number if the calling context meets
+     * the following criteria:
+     * 
+     * -
+     * If the method call happens in the context of a storefront request and
+     * the current customer is identical to the customer related to the basket
+     * or order, and the current protocol is HTTPS.
+     * 
+     * -
+     * If the method call happens in the context of the business manager and the
+     * current user has permissions to the Orders module.
+     * 
+     * Otherwise, the method throws an exception.
+     */
+    readonly bankAccountNumber: string;
+    /**
+     * Returns the sum of the captured amounts. The captured amounts
+     * are calculated on the fly. Associate a payment capture for an Payment Instrument with an Invoice
+     * using Invoice method addCaptureTransaction.
+     */
+    readonly capturedAmount: Money;
+    /**
+     * Returns the de-crypted creditcard number if the calling context meets
+     * the following criteria:
+     * 
+     * -
+     * If the method call happens in the context of a storefront request and
+     * the current authenticated customer is referenced by the basket or order, and the current protocol is HTTPS.
+     * 
+     * -
+     * If the customer is anonymous, and the order references this customer, and the protocol is secure and
+     * the order status is CREATED.
+     * 
+     * -
+     * If the method call happens in the context of the business manager and the
+     * current user has the permission to manage orders.
+     * 
+     * -
+     * If the payment information has not been masked as a result of the data retention security policy
+     * for the site.
+     * 
+     * Otherwise, the method returns the masked credit card number.
+     */
+    readonly creditCardNumber: string;
+    /**
+     * Returns the Payment Transaction for this Payment Instrument or null.
+     */
+    readonly paymentTransaction: PaymentTransaction | null;
+    /**
+     * Returns the sum of the refunded amounts. The refunded amounts
+     * are calculated on the fly. Associate a payment refund for an Payment Instrument with an Invoice
+     * using Invoice method addRefundTransaction.
+     */
+    readonly refundedAmount: Money;
+    private constructor();
+    /**
+     * Returns the driver's license associated with a bank account if the calling
+     * context meets the following criteria:
+     * 
+     * -
+     * If the method call happens in the context of a storefront request and
+     * the current customer is identical to the customer related to the basket
+     * or order, and the current protocol is HTTPS.
+     * 
+     * -
+     * If the method call happens in the context of the business manager and the
+     * current user has permission to the Orders module.
+     * 
+     * Otherwise, the method throws an exception.
+     */
+    getBankAccountDriversLicense(): string;
+    /**
+     * Returns the account number if the calling context meets
+     * the following criteria:
+     * 
+     * -
+     * If the method call happens in the context of a storefront request and
+     * the current customer is identical to the customer related to the basket
+     * or order, and the current protocol is HTTPS.
+     * 
+     * -
+     * If the method call happens in the context of the business manager and the
+     * current user has permissions to the Orders module.
+     * 
+     * Otherwise, the method throws an exception.
+     */
+    getBankAccountNumber(): string;
+    /**
+     * Returns the sum of the captured amounts. The captured amounts
+     * are calculated on the fly. Associate a payment capture for an Payment Instrument with an Invoice
+     * using Invoice method addCaptureTransaction.
+     */
+    getCapturedAmount(): Money;
+    /**
+     * Returns the de-crypted creditcard number if the calling context meets
+     * the following criteria:
+     * 
+     * -
+     * If the method call happens in the context of a storefront request and
+     * the current authenticated customer is referenced by the basket or order, and the current protocol is HTTPS.
+     * 
+     * -
+     * If the customer is anonymous, and the order references this customer, and the protocol is secure and
+     * the order status is CREATED.
+     * 
+     * -
+     * If the method call happens in the context of the business manager and the
+     * current user has the permission to manage orders.
+     * 
+     * -
+     * If the payment information has not been masked as a result of the data retention security policy
+     * for the site.
+     * 
+     * Otherwise, the method returns the masked credit card number.
+     */
+    getCreditCardNumber(): string;
+    /**
+     * Returns the Payment Transaction for this Payment Instrument or null.
+     */
+    getPaymentTransaction(): PaymentTransaction | null;
+    /**
+     * Returns the sum of the refunded amounts. The refunded amounts
+     * are calculated on the fly. Associate a payment refund for an Payment Instrument with an Invoice
+     * using Invoice method addRefundTransaction.
+     */
+    getRefundedAmount(): Money;
+}
+
+export = OrderPaymentInstrument;

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

@@ -0,0 +1,58 @@
+/**
+ * Contains constants representing different status codes
+ * for interacting with an order, such as cancelling
+ * or editing an order.
+ */
+declare class OrderProcessStatusCodes {
+    /**
+     * Indicates that a coupon in the order is not valid.
+     */
+    static readonly COUPON_INVALID = "COUPON_INVALID";
+    /**
+     * Indicates that no inventory could be reserved for the order.
+     */
+    static readonly INVENTORY_RESERVATION_FAILED = "INVENTORY_RESERVATION_FAILED";
+    /**
+     * Indicates that the order could not be used because
+     * it has already been cancelled.
+     */
+    static readonly ORDER_ALREADY_CANCELLED = "ORDER_CANCELLED";
+    /**
+     * Indicates that the order could not be used because it
+     * has already been exported.
+     */
+    static readonly ORDER_ALREADY_EXPORTED = "ORDER_EXPORTED";
+    /**
+     * Indicates that the order could not be used because
+     * it has already been failed.
+     */
+    static readonly ORDER_ALREADY_FAILED = "ORDER_FAILED";
+    /**
+     * Indicates that the order could not be used because
+     * it has already been replaced.
+     */
+    static readonly ORDER_ALREADY_REPLACED = "ORDER_REPLACED";
+    /**
+     * Indicates that the order could not be used because it
+     * contains gift certificates.
+     */
+    static readonly ORDER_CONTAINS_GC = "CANCEL_ORDER_GC";
+    /**
+     * Indicates that the order could not be used because
+     * it is not cancelled.
+     */
+    static readonly ORDER_NOT_CANCELLED = "ORDER_NOT_CANCELLED";
+    /**
+     * Indicates that the order could not be used because
+     * it has not been failed.
+     */
+    static readonly ORDER_NOT_FAILED = "ORDER_NOT_FAILED";
+    /**
+     * Indicates that the order could not be used because
+     * it has not been placed.
+     */
+    static readonly ORDER_NOT_PLACED = "ORDER_NOT_PLACED";
+    private constructor();
+}
+
+export = OrderProcessStatusCodes;

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

@@ -0,0 +1,112 @@
+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 Status = require('../system/Status');
+
+declare global {
+    module ICustomAttributes {
+        interface PaymentCard extends CustomAttributes {
+        }
+    }
+}
+
+/**
+ * Represents payment cards and provides methods to access the payment card
+ * attributes and status.
+ * 
+ * Note: this class handles sensitive financial and card holder data.
+ * Pay special attention to PCI DSS v3. requirements 1, 3, 7, and 9.
+ */
+declare class PaymentCard extends ExtensibleObject<ICustomAttributes.PaymentCard> {
+    /**
+     * Returns 'true' if payment card is active (enabled), otherwise 'false' is returned.
+     */
+    readonly active: boolean;
+    /**
+     * Returns the unique card type of the payment card.
+     */
+    readonly cardType: string;
+    /**
+     * Returns the description of the payment card.
+     */
+    readonly description: MarkupText;
+    /**
+     * Returns the reference to the payment card image.
+     */
+    readonly image: MediaFile;
+    /**
+     * Returns the name of the payment card.
+     */
+    readonly name: string;
+    private constructor();
+    /**
+     * Returns the unique card type of the payment card.
+     */
+    getCardType(): string;
+    /**
+     * Returns the description of the payment card.
+     */
+    getDescription(): MarkupText;
+    /**
+     * Returns the reference to the payment card image.
+     */
+    getImage(): MediaFile;
+    /**
+     * Returns the name of the payment card.
+     */
+    getName(): string;
+    /**
+     * Returns 'true' if payment card is active (enabled), otherwise 'false' is returned.
+     */
+    isActive(): boolean;
+    /**
+     * Returns 'true' if this payment card is applicable for the specified
+     * customer, country and payment amount and the session currency.
+     * 
+     * The 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 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 session currency, and the session
+     * currency code is assigned to the method
+     * 
+     * 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.
+     */
+    isApplicable(customer: Customer | null, countryCode: string | null, paymentAmount: number): boolean;
+    /**
+     * Verify the card against the provided values. This method is equivalent to
+     * verify but omits verification of the
+     * card security code. If the verification fails the resulting
+     * dw.system.Status will hold up to 2 error items each with a code:
+     * 
+     * - dw.order.PaymentStatusCodes.CREDITCARD_INVALID_EXPIRATION_DATE - the expiresMonth and expiresYear do not describe a
+     * month in the future, or describe an invalid month outside the range 1-12.
+     * - dw.order.PaymentStatusCodes.CREDITCARD_INVALID_CARD_NUMBER - the cardNumber does not verify against one or more configured
+     * checks, which may include the Luhn checksum, accepted number lengths, or accepted number prefixes.
+     */
+    verify(expiresMonth: number, expiresYear: number, cardNumber: string): Status;
+    /**
+     * Verify the card against the provided values. If the verification fails the resulting
+     * dw.system.Status will hold up to 3 error items with these codes:
+     * 
+     * - dw.order.PaymentStatusCodes.CREDITCARD_INVALID_EXPIRATION_DATE  - the expiresMonth and expiresYear do not describe a
+     * month in the future, or describe an invalid month outside the range 1-12.
+     * - dw.order.PaymentStatusCodes.CREDITCARD_INVALID_CARD_NUMBER - the cardNumber does not verify against one or more configured
+     * checks, which may include the Luhn checksum, accepted number lengths, or accepted number prefixes.
+     * - dw.order.PaymentStatusCodes.CREDITCARD_INVALID_SECURITY_CODE - the card security code does not verify against the configured
+     * accepted length.
+     */
+    verify(expiresMonth: number, expiresYear: number, cardNumber: string, csc: string): Status;
+}
+
+export = PaymentCard;