sfcc-dev-mcp 1.0.16 → 1.0.20

package/docs/dw_order/OrderPaymentInstrument.md

@@ -1,220 +0,0 @@
-## Package: dw.order
-
-# Class OrderPaymentInstrument
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.object.PersistentObject
-  - dw.object.ExtensibleObject
-    - dw.customer.EncryptedObject
-      - dw.order.PaymentInstrument
-      - dw.order.OrderPaymentInstrument
-
-## Description
-
-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.
-
-## Properties
-
-### bankAccountDriversLicense
-
-**Type:** String (Read Only)
-
-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.
-
-### bankAccountNumber
-
-**Type:** String (Read Only)
-
-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.
-
-### capturedAmount
-
-**Type:** Money (Read Only)
-
-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.
-
-### creditCardNumber
-
-**Type:** String (Read Only)
-
-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.
-
-### paymentTransaction
-
-**Type:** PaymentTransaction (Read Only)
-
-The Payment Transaction for this Payment Instrument or null.
-
-### refundedAmount
-
-**Type:** Money (Read Only)
-
-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.
-
-## Constructor Summary
-
-## Method Summary
-
-### getBankAccountDriversLicense
-
-**Signature:** `getBankAccountDriversLicense() : String`
-
-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.
-
-### getBankAccountNumber
-
-**Signature:** `getBankAccountNumber() : 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.
-
-### getCapturedAmount
-
-**Signature:** `getCapturedAmount() : Money`
-
-Returns the sum of the captured amounts.
-
-### getCreditCardNumber
-
-**Signature:** `getCreditCardNumber() : String`
-
-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.
-
-### getPaymentTransaction
-
-**Signature:** `getPaymentTransaction() : PaymentTransaction`
-
-Returns the Payment Transaction for this Payment Instrument or null.
-
-### getRefundedAmount
-
-**Signature:** `getRefundedAmount() : Money`
-
-Returns the sum of the refunded amounts.
-
-## Method Detail
-
-## Method Details
-
-### getBankAccountDriversLicense
-
-**Signature:** `getBankAccountDriversLicense() : String`
-
-**Description:** 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.
-
-**Returns:**
-
-the driver's license number if the calling context meets the necessary criteria.
-
----
-
-### getBankAccountNumber
-
-**Signature:** `getBankAccountNumber() : String`
-
-**Description:** 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.
-
-**Returns:**
-
-the account number if the calling context meets the necessary criteria.
-
----
-
-### getCapturedAmount
-
-**Signature:** `getCapturedAmount() : Money`
-
-**Description:** 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.
-
-**Returns:**
-
-sum of captured amounts
-
----
-
-### getCreditCardNumber
-
-**Signature:** `getCreditCardNumber() : String`
-
-**Description:** 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.
-
-**Returns:**
-
-the de-crypted creditcard number if the calling context meets the necessary criteria.
-
----
-
-### getPaymentTransaction
-
-**Signature:** `getPaymentTransaction() : PaymentTransaction`
-
-**Description:** Returns the Payment Transaction for this Payment Instrument or null.
-
-**Returns:**
-
-the Payment Transaction for this Payment Instrument or null.
-
----
-
-### getRefundedAmount
-
-**Signature:** `getRefundedAmount() : Money`
-
-**Description:** 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.
-
-**Returns:**
-
-sum of refunded amounts
-
----

package/docs/dw_order/OrderProcessStatusCodes.md

@@ -1,84 +0,0 @@
-## Package: dw.order
-
-# Class OrderProcessStatusCodes
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.order.OrderProcessStatusCodes
-
-## Description
-
-Contains constants representing different status codes for interacting with an order, such as cancelling or editing an order.
-
-## Constants
-
-### COUPON_INVALID
-
-**Type:** String = "COUPON_INVALID"
-
-Indicates that a coupon in the order is not valid.
-
-### INVENTORY_RESERVATION_FAILED
-
-**Type:** String = "INVENTORY_RESERVATION_FAILED"
-
-Indicates that no inventory could be reserved for the order.
-
-### ORDER_ALREADY_CANCELLED
-
-**Type:** String = "ORDER_CANCELLED"
-
-Indicates that the order could not be used because it has already been cancelled.
-
-### ORDER_ALREADY_EXPORTED
-
-**Type:** String = "ORDER_EXPORTED"
-
-Indicates that the order could not be used because it has already been exported.
-
-### ORDER_ALREADY_FAILED
-
-**Type:** String = "ORDER_FAILED"
-
-Indicates that the order could not be used because it has already been failed.
-
-### ORDER_ALREADY_REPLACED
-
-**Type:** String = "ORDER_REPLACED"
-
-Indicates that the order could not be used because it has already been replaced.
-
-### ORDER_CONTAINS_GC
-
-**Type:** String = "CANCEL_ORDER_GC"
-
-Indicates that the order could not be used because it contains gift certificates.
-
-### ORDER_NOT_CANCELLED
-
-**Type:** String = "ORDER_NOT_CANCELLED"
-
-Indicates that the order could not be used because it is not cancelled.
-
-### ORDER_NOT_FAILED
-
-**Type:** String = "ORDER_NOT_FAILED"
-
-Indicates that the order could not be used because it has not been failed.
-
-### ORDER_NOT_PLACED
-
-**Type:** String = "ORDER_NOT_PLACED"
-
-Indicates that the order could not be used because it has not been placed.
-
-## Properties
-
-## Constructor Summary
-
-OrderProcessStatusCodes()
-
-## Method Summary
-
-## Constructor Detail

package/docs/dw_order/PaymentCard.md

@@ -1,217 +0,0 @@
-## Package: dw.order
-
-# Class PaymentCard
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.object.PersistentObject
-  - dw.object.ExtensibleObject
-    - dw.order.PaymentCard
-
-## Description
-
-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.
-
-## Properties
-
-### active
-
-**Type:** boolean (Read Only)
-
-Returns 'true' if payment card is active (enabled), otherwise 'false' is returned.
-
-### cardType
-
-**Type:** String (Read Only)
-
-The unique card type of the payment card.
-
-### description
-
-**Type:** MarkupText (Read Only)
-
-The description of the payment card.
-
-### image
-
-**Type:** MediaFile (Read Only)
-
-The reference to the payment card image.
-
-### name
-
-**Type:** String (Read Only)
-
-The name of the payment card.
-
-## Constructor Summary
-
-## Method Summary
-
-### getCardType
-
-**Signature:** `getCardType() : String`
-
-Returns the unique card type of the payment card.
-
-### getDescription
-
-**Signature:** `getDescription() : MarkupText`
-
-Returns the description of the payment card.
-
-### getImage
-
-**Signature:** `getImage() : MediaFile`
-
-Returns the reference to the payment card image.
-
-### getName
-
-**Signature:** `getName() : String`
-
-Returns the name of the payment card.
-
-### isActive
-
-**Signature:** `isActive() : boolean`
-
-Returns 'true' if payment card is active (enabled), otherwise 'false' is returned.
-
-### isApplicable
-
-**Signature:** `isApplicable(customer : Customer, countryCode : String, paymentAmount : Number) : boolean`
-
-Returns 'true' if this payment card is applicable for the specified customer, country and payment amount and the session currency.
-
-### verify
-
-**Signature:** `verify(expiresMonth : Number, expiresYear : Number, cardNumber : String) : Status`
-
-Verify the card against the provided values.
-
-### verify
-
-**Signature:** `verify(expiresMonth : Number, expiresYear : Number, cardNumber : String, csc : String) : Status`
-
-Verify the card against the provided values.
-
-## Method Detail
-
-## Method Details
-
-### getCardType
-
-**Signature:** `getCardType() : String`
-
-**Description:** Returns the unique card type of the payment card.
-
-**Returns:**
-
-cardType of the payment card.
-
----
-
-### getDescription
-
-**Signature:** `getDescription() : MarkupText`
-
-**Description:** Returns the description of the payment card.
-
-**Returns:**
-
-Description of the payment card.
-
----
-
-### getImage
-
-**Signature:** `getImage() : MediaFile`
-
-**Description:** Returns the reference to the payment card image.
-
-**Returns:**
-
-Image of the payment card.
-
----
-
-### getName
-
-**Signature:** `getName() : String`
-
-**Description:** Returns the name of the payment card.
-
-**Returns:**
-
-Name of the payment card.
-
----
-
-### isActive
-
-**Signature:** `isActive() : boolean`
-
-**Description:** Returns 'true' if payment card is active (enabled), otherwise 'false' is returned.
-
-**Returns:**
-
-true if payment card is active, otherwise false.
-
----
-
-### isApplicable
-
-**Signature:** `isApplicable(customer : Customer, countryCode : String, paymentAmount : Number) : boolean`
-
-**Description:** 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.
-
-**Parameters:**
-
-- `customer`: Customer or null
-- `countryCode`: Billing country code or null
-- `paymentAmount`: Payment amount or null
-
-**Returns:**
-
-true if payment card is applicable, false otherwise
-
----
-
-### verify
-
-**Signature:** `verify(expiresMonth : Number, expiresYear : Number, cardNumber : String) : Status`
-
-**Description:** Verify the card against the provided values. This method is equivalent to verify(Number, Number, String, String) but omits verification of the card security code. If the verification fails the resulting Status will hold up to 2 error items each with a code: 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. 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.
-
-**Parameters:**
-
-- `expiresMonth`: expiration month as integer, 1 (January) to 12 (December)
-- `expiresYear`: expiration year as integer, e.g. 2025
-- `cardNumber`: card number, a string containing digital characters
-
-**Returns:**
-
-status indicating result
-
----
-
-### verify
-
-**Signature:** `verify(expiresMonth : Number, expiresYear : Number, cardNumber : String, csc : String) : Status`
-
-**Description:** Verify the card against the provided values. If the verification fails the resulting Status will hold up to 3 error items with these codes: 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. 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. PaymentStatusCodes.CREDITCARD_INVALID_SECURITY_CODE - the card security code does not verify against the configured accepted length.
-
-**Parameters:**
-
-- `expiresMonth`: expiration month as integer, 1 (January) to 12 (December)
-- `expiresYear`: expiration year as integer, e.g. 2025
-- `cardNumber`: card number, a string containing digital characters
-- `csc`: card security code, a string containing digital characters
-
-**Returns:**
-
-status indicating result
-
----