sfcc-dev-mcp 1.0.19 → 1.0.21

package/docs/dw_order/PaymentMethod.md

@@ -1,242 +0,0 @@
-## Package: dw.order
-
-# Class PaymentMethod
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.object.PersistentObject
-  - dw.object.ExtensibleObject
-    - dw.order.PaymentMethod
-
-## Description
-
-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. PaymentMgr.getApplicablePaymentMethods(Customer, String, Number) 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.
-
-## Properties
-
-### active
-
-**Type:** boolean (Read Only)
-
-Returns 'true' if payment method is active (enabled), otherwise 'false' is returned.
-
-### activePaymentCards
-
-**Type:** List (Read Only)
-
-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.
-
-### description
-
-**Type:** MarkupText (Read Only)
-
-The description of the payment method.
-
-### ID
-
-**Type:** String (Read Only)
-
-The unique ID of the payment method.
-
-### image
-
-**Type:** MediaFile (Read Only)
-
-The reference to the payment method image.
-
-### name
-
-**Type:** String (Read Only)
-
-The name of the payment method.
-
-### paymentProcessor
-
-**Type:** PaymentProcessor (Read Only)
-
-The payment processor associated to this payment method.
-
-## Constructor Summary
-
-## Method Summary
-
-### getActivePaymentCards
-
-**Signature:** `getActivePaymentCards() : List`
-
-Returns enabled payment cards that are assigned to this payment method, regardless of current customer, country or payment amount restrictions.
-
-### getApplicablePaymentCards
-
-**Signature:** `getApplicablePaymentCards(customer : Customer, countryCode : String, paymentAmount : Number) : List`
-
-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.
-
-### getDescription
-
-**Signature:** `getDescription() : MarkupText`
-
-Returns the description of the payment method.
-
-### getID
-
-**Signature:** `getID() : String`
-
-Returns the unique ID of the payment method.
-
-### getImage
-
-**Signature:** `getImage() : MediaFile`
-
-Returns the reference to the payment method image.
-
-### getName
-
-**Signature:** `getName() : String`
-
-Returns the name of the payment method.
-
-### getPaymentProcessor
-
-**Signature:** `getPaymentProcessor() : PaymentProcessor`
-
-Returns the payment processor associated to this payment method.
-
-### isActive
-
-**Signature:** `isActive() : boolean`
-
-Returns 'true' if payment method is active (enabled), otherwise 'false' is returned.
-
-### isApplicable
-
-**Signature:** `isApplicable(customer : Customer, countryCode : String, paymentAmount : Number) : boolean`
-
-Returns 'true' if this payment method is applicable for the specified customer, country and payment amount and the session currency.
-
-## Method Detail
-
-## Method Details
-
-### getActivePaymentCards
-
-**Signature:** `getActivePaymentCards() : List`
-
-**Description:** 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.
-
-**Returns:**
-
-List of enabled payment cards of current site
-
----
-
-### getApplicablePaymentCards
-
-**Signature:** `getApplicablePaymentCards(customer : Customer, countryCode : String, paymentAmount : Number) : List`
-
-**Description:** 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.
-
-**Parameters:**
-
-- `customer`: Customer or null
-- `countryCode`: Billing country code or null
-- `paymentAmount`: Payment amount or null
-
-**Returns:**
-
-List of applicable payment cards of this payment method
-
----
-
-### getDescription
-
-**Signature:** `getDescription() : MarkupText`
-
-**Description:** Returns the description of the payment method.
-
-**Returns:**
-
-Description of the payment method.
-
----
-
-### getID
-
-**Signature:** `getID() : String`
-
-**Description:** Returns the unique ID of the payment method.
-
-**Returns:**
-
-ID of the payment method.
-
----
-
-### getImage
-
-**Signature:** `getImage() : MediaFile`
-
-**Description:** Returns the reference to the payment method image.
-
-**Returns:**
-
-Image of the payment method.
-
----
-
-### getName
-
-**Signature:** `getName() : String`
-
-**Description:** Returns the name of the payment method.
-
-**Returns:**
-
-Name of the payment method.
-
----
-
-### getPaymentProcessor
-
-**Signature:** `getPaymentProcessor() : PaymentProcessor`
-
-**Description:** Returns the payment processor associated to this payment method.
-
-**Returns:**
-
-the payment processor associated to this payment method.
-
----
-
-### isActive
-
-**Signature:** `isActive() : boolean`
-
-**Description:** Returns 'true' if payment method is active (enabled), otherwise 'false' is returned.
-
-**Returns:**
-
-true if payment method is active, otherwise false.
-
----
-
-### isApplicable
-
-**Signature:** `isApplicable(customer : Customer, countryCode : String, paymentAmount : Number) : boolean`
-
-**Description:** 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.
-
-**Parameters:**
-
-- `customer`: Customer or null
-- `countryCode`: Billing country code or null
-- `paymentAmount`: Payment amount or null
-
-**Returns:**
-
-true if payment method is applicable, false otherwise
-
----

package/docs/dw_order/PaymentMgr.md

@@ -1,117 +0,0 @@
-## Package: dw.order
-
-# Class PaymentMgr
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.order.PaymentMgr
-
-## Description
-
-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(String) and getPaymentCard(String). To access active payment methods use method getActivePaymentMethods(). To access applicable payment methods for a customer, country and/or payment amount use method getApplicablePaymentMethods(Customer, String, Number).
-
-## Properties
-
-### activePaymentMethods
-
-**Type:** List (Read Only)
-
-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.
-
-## Constructor Summary
-
-## Method Summary
-
-### getActivePaymentMethods
-
-**Signature:** `static getActivePaymentMethods() : List`
-
-Returns the sorted list of all enabled payment methods of the current site, regardless of any customer group, country, payment amount or currency restrictions.
-
-### getApplicablePaymentMethods
-
-**Signature:** `static getApplicablePaymentMethods(customer : Customer, countryCode : String, paymentAmount : Number) : List`
-
-Returns the sorted list of all enabled payment methods of the current site applicable for the session currency, specified customer, country and payment amount.
-
-### getPaymentCard
-
-**Signature:** `static getPaymentCard(cardType : String) : PaymentCard`
-
-Returns the payment card for the specified cardType or null if no such card exists in the current site.
-
-### getPaymentMethod
-
-**Signature:** `static getPaymentMethod(id : String) : PaymentMethod`
-
-Returns the payment method for the specified ID or null if no such method exists in the current site.
-
-## Method Detail
-
-## Method Details
-
-### getActivePaymentMethods
-
-**Signature:** `static getActivePaymentMethods() : List`
-
-**Description:** 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.
-
-**Returns:**
-
-List of enabled payment methods of current site
-
----
-
-### getApplicablePaymentMethods
-
-**Signature:** `static getApplicablePaymentMethods(customer : Customer, countryCode : String, paymentAmount : Number) : List`
-
-**Description:** 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.
-
-**Parameters:**
-
-- `customer`: Customer or null
-- `countryCode`: Billing country code or null
-- `paymentAmount`: Payment amount or null
-
-**Returns:**
-
-List of applicable payment methods of current site
-
----
-
-### getPaymentCard
-
-**Signature:** `static getPaymentCard(cardType : String) : PaymentCard`
-
-**Description:** Returns the payment card for the specified cardType or null if no such card exists in the current site.
-
-**Parameters:**
-
-- `cardType`: PaymentCard type
-
-**Returns:**
-
-PaymentCard or null
-
----
-
-### getPaymentMethod
-
-**Signature:** `static getPaymentMethod(id : String) : PaymentMethod`
-
-**Description:** Returns the payment method for the specified ID or null if no such method exists in the current site.
-
-**Parameters:**
-
-- `id`: PaymentMethod ID
-
-**Returns:**
-
-PaymentMethod or null
-
----

package/docs/dw_order/PaymentProcessor.md

@@ -1,70 +0,0 @@
-## Package: dw.order
-
-# Class PaymentProcessor
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.object.PersistentObject
-  - dw.object.ExtensibleObject
-    - dw.order.PaymentProcessor
-
-## Description
-
-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 SitePreferences system object. Attributes added to the group will be considered preferences of the payment processor and will be readable through getPreferenceValue(String). Merchants can design their checkout process to read these preferences at run time for connecting to their payment gateways. Every 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.
-
-## Properties
-
-### ID
-
-**Type:** String (Read Only)
-
-The 'ID' of this processor.
-
-## Constructor Summary
-
-## Method Summary
-
-### getID
-
-**Signature:** `getID() : String`
-
-Returns the 'ID' of this processor.
-
-### getPreferenceValue
-
-**Signature:** `getPreferenceValue(name : String) : Object`
-
-Returns the value of the specified preference for this payment processor.
-
-## Method Detail
-
-## Method Details
-
-### getID
-
-**Signature:** `getID() : String`
-
-**Description:** Returns the 'ID' of this processor.
-
-**Returns:**
-
-the 'ID' of this processor, e.g. "BASIC_CREDIT".
-
----
-
-### getPreferenceValue
-
-**Signature:** `getPreferenceValue(name : String) : Object`
-
-**Description:** 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.
-
-**Parameters:**
-
-- `name`: preference name. Typically an attribute defined on SitePreferences contained in an attribute group whose name is the same as this.ID.
-
-**Returns:**
-
-preference value, or null.
-
----

package/docs/dw_order/PaymentStatusCodes.md

@@ -1,42 +0,0 @@
-## Package: dw.order
-
-# Class PaymentStatusCodes
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.order.PaymentStatusCodes
-
-## Description
-
-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 PaymentCard.verify(Number, Number, String) or PaymentCard.verify(Number, Number, String, String).
-
-## Constants
-
-### CREDITCARD_INVALID_CARD_NUMBER
-
-**Type:** String = "CREDITCARD_INVALID_CARD_NUMBER"
-
-The code indicates that the credit card number is incorrect.
-
-### CREDITCARD_INVALID_EXPIRATION_DATE
-
-**Type:** String = "CREDITCARD_INVALID_EXPIRATION_DATE"
-
-The code indicates that the credit card is expired.
-
-### CREDITCARD_INVALID_SECURITY_CODE
-
-**Type:** String = "CREDITCARD_INVALID_SECURITY_CODE"
-
-The code indicates that the credit card security code length is invalid.
-
-## Properties
-
-## Constructor Summary
-
-PaymentStatusCodes()
-
-## Method Summary
-
-## Constructor Detail