sfcc-dev-mcp 1.0.19 → 1.0.21

package/docs/dw_order/GiftCertificateLineItem.md

@@ -1,324 +0,0 @@
-## Package: dw.order
-
-# Class GiftCertificateLineItem
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.object.PersistentObject
-  - dw.object.ExtensibleObject
-    - dw.order.LineItem
-      - dw.order.GiftCertificateLineItem
-
-## Description
-
-Represents a Gift Certificate line item in the cart. When an order is processed, a Gift Certificate is created based on the information in the Gift Certificate line item.
-
-## Properties
-
-### giftCertificateID
-
-**Type:** String
-
-The ID of the gift certificate that this line item
- was used to create. If this line item has not been used to create
- a Gift Certificate, this method returns null.
-
-### message
-
-**Type:** String
-
-The message to include in the email of the person receiving
- the gift certificate line item.
-
-### productListItem
-
-**Type:** ProductListItem
-
-The associated ProductListItem.
-
-### recipientEmail
-
-**Type:** String
-
-The email address of the person receiving
- the gift certificate line item.
-
-### recipientName
-
-**Type:** String
-
-The name of the person receiving the gift certificate line item.
-
-### senderName
-
-**Type:** String
-
-The name of the person or organization that
- sent the gift certificate line item or null if undefined.
-
-### shipment
-
-**Type:** Shipment
-
-The associated Shipment.
-
-## Constructor Summary
-
-## Method Summary
-
-### getGiftCertificateID
-
-**Signature:** `getGiftCertificateID() : String`
-
-Returns the ID of the gift certificate that this line item was used to create.
-
-### getMessage
-
-**Signature:** `getMessage() : String`
-
-Returns the message to include in the email of the person receiving the gift certificate line item.
-
-### getProductListItem
-
-**Signature:** `getProductListItem() : ProductListItem`
-
-Returns the associated ProductListItem.
-
-### getRecipientEmail
-
-**Signature:** `getRecipientEmail() : String`
-
-Returns the email address of the person receiving the gift certificate line item.
-
-### getRecipientName
-
-**Signature:** `getRecipientName() : String`
-
-Returns the name of the person receiving the gift certificate line item.
-
-### getSenderName
-
-**Signature:** `getSenderName() : String`
-
-Returns the name of the person or organization that sent the gift certificate line item or null if undefined.
-
-### getShipment
-
-**Signature:** `getShipment() : Shipment`
-
-Returns the associated Shipment.
-
-### setGiftCertificateID
-
-**Signature:** `setGiftCertificateID(id : String) : void`
-
-Sets the ID of the gift certificate associated with this line item.
-
-### setMessage
-
-**Signature:** `setMessage(message : String) : void`
-
-Sets the message to include in the email of the person receiving the gift certificate line item.
-
-### setProductListItem
-
-**Signature:** `setProductListItem(productListItem : ProductListItem) : void`
-
-Sets the associated ProductListItem.
-
-### setRecipientEmail
-
-**Signature:** `setRecipientEmail(recipientEmail : String) : void`
-
-Sets the email address of the person receiving the gift certificate line item.
-
-### setRecipientName
-
-**Signature:** `setRecipientName(recipient : String) : void`
-
-Sets the name of the person receiving the gift certificate line item.
-
-### setSenderName
-
-**Signature:** `setSenderName(sender : String) : void`
-
-Sets the name of the person or organization that sent the gift certificate line item.
-
-### setShipment
-
-**Signature:** `setShipment(shipment : Shipment) : void`
-
-Associates the gift certificate line item with the specified shipment.
-
-## Method Detail
-
-## Method Details
-
-### getGiftCertificateID
-
-**Signature:** `getGiftCertificateID() : String`
-
-**Description:** Returns the ID of the gift certificate that this line item was used to create. If this line item has not been used to create a Gift Certificate, this method returns null.
-
-**Returns:**
-
-the ID of the gift certificate or null if undefined.
-
----
-
-### getMessage
-
-**Signature:** `getMessage() : String`
-
-**Description:** Returns the message to include in the email of the person receiving the gift certificate line item.
-
-**Returns:**
-
-the message to include in the email of the person receiving the gift certificate line item.
-
----
-
-### getProductListItem
-
-**Signature:** `getProductListItem() : ProductListItem`
-
-**Description:** Returns the associated ProductListItem.
-
-**Returns:**
-
-item or null.
-
----
-
-### getRecipientEmail
-
-**Signature:** `getRecipientEmail() : String`
-
-**Description:** Returns the email address of the person receiving the gift certificate line item.
-
-**Returns:**
-
-the email address of the person receiving the gift certificate line item.
-
----
-
-### getRecipientName
-
-**Signature:** `getRecipientName() : String`
-
-**Description:** Returns the name of the person receiving the gift certificate line item.
-
-**Returns:**
-
-the name of the person receiving the gift certificate line item.
-
----
-
-### getSenderName
-
-**Signature:** `getSenderName() : String`
-
-**Description:** Returns the name of the person or organization that sent the gift certificate line item or null if undefined.
-
-**Returns:**
-
-the name of the person or organization that sent the gift certificate line item or null if undefined.
-
----
-
-### getShipment
-
-**Signature:** `getShipment() : Shipment`
-
-**Description:** Returns the associated Shipment.
-
-**Returns:**
-
-The shipment of the gift certificate line item
-
----
-
-### setGiftCertificateID
-
-**Signature:** `setGiftCertificateID(id : String) : void`
-
-**Description:** Sets the ID of the gift certificate associated with this line item.
-
-**Parameters:**
-
-- `id`: the ID of the gift certificate associated with this line item.
-
----
-
-### setMessage
-
-**Signature:** `setMessage(message : String) : void`
-
-**Description:** Sets the message to include in the email of the person receiving the gift certificate line item.
-
-**Parameters:**
-
-- `message`: the message to include in the email of the person receiving the gift certificate line item.
-
----
-
-### setProductListItem
-
-**Signature:** `setProductListItem(productListItem : ProductListItem) : void`
-
-**Description:** Sets the associated ProductListItem. The product list item to be set must be of type gift certificate otherwise an exception is thrown.
-
-**Parameters:**
-
-- `productListItem`: the product list item to be associated
-
----
-
-### setRecipientEmail
-
-**Signature:** `setRecipientEmail(recipientEmail : String) : void`
-
-**Description:** Sets the email address of the person receiving the gift certificate line item.
-
-**Parameters:**
-
-- `recipientEmail`: the email address of the person receiving the gift certificate line item.
-
----
-
-### setRecipientName
-
-**Signature:** `setRecipientName(recipient : String) : void`
-
-**Description:** Sets the name of the person receiving the gift certificate line item.
-
-**Parameters:**
-
-- `recipient`: the name of the person receiving the gift certificate line item.
-
----
-
-### setSenderName
-
-**Signature:** `setSenderName(sender : String) : void`
-
-**Description:** Sets the name of the person or organization that sent the gift certificate line item.
-
-**Parameters:**
-
-- `sender`: the name of the person or organization that sent the gift certificate line item.
-
----
-
-### setShipment
-
-**Signature:** `setShipment(shipment : Shipment) : void`
-
-**Description:** Associates the gift certificate line item with the specified shipment. Gift certificate line item and shipment must belong to the same line item ctnr.
-
-**Parameters:**
-
-- `shipment`: The new shipment of the gift certificate line item
-
----

package/docs/dw_order/GiftCertificateMgr.md

@@ -1,197 +0,0 @@
-## Package: dw.order
-
-# Class GiftCertificateMgr
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.order.GiftCertificateMgr
-
-## Description
-
-The GiftCertificateMgr class contains a set of static methods for interacting with GiftCertificates.
-
-## Constants
-
-### GC_ERROR_DISABLED
-
-**Type:** String = "GIFTCERTIFICATE-100"
-
-Indicates that an error occurred because the Gift Certificate is currently disabled.
-
-### GC_ERROR_INSUFFICIENT_BALANCE
-
-**Type:** String = "GIFTCERTIFICATE-110"
-
-Indicates that an error occurred because the Gift Certificate does not have a sufficient balance to perform the requested operation.
-
-### GC_ERROR_INVALID_AMOUNT
-
-**Type:** String = "GIFTCERTIFICATE-140"
-
-Indicates that an error occurred because the Gift Certificate Amount was not valid.
-
-### GC_ERROR_INVALID_CODE
-
-**Type:** String = "GIFTCERTIFICATE-150"
-
-Indicates that an error occurred because the Gift Certificate ID was not valid.
-
-### GC_ERROR_PENDING
-
-**Type:** String = "GIFTCERTIFICATE-130"
-
-Indicates that an error occurred because the Gift Certificate has been fully redeemed.
-
-### GC_ERROR_REDEEMED
-
-**Type:** String = "GIFTCERTIFICATE-120"
-
-Indicates that an error occurred because the Gift Certificate has been fully redeemed.
-
-## Properties
-
-## Constructor Summary
-
-## Method Summary
-
-### createGiftCertificate
-
-**Signature:** `static createGiftCertificate(amount : Number, code : String) : GiftCertificate`
-
-Creates a Gift Certificate.
-
-### createGiftCertificate
-
-**Signature:** `static createGiftCertificate(amount : Number) : GiftCertificate`
-
-Creates a Gift Certificate.
-
-### getGiftCertificate
-
-**Signature:** `static getGiftCertificate(giftCertificateCode : String) : GiftCertificate`
-
-Returns the Gift Certificate identified by the specified gift certificate code.
-
-### getGiftCertificateByCode
-
-**Signature:** `static getGiftCertificateByCode(giftCertificateCode : String) : GiftCertificate`
-
-Returns the Gift Certificate identified by the specified gift certificate code.
-
-### getGiftCertificateByMerchantID
-
-**Signature:** `static getGiftCertificateByMerchantID(merchantID : String) : GiftCertificate`
-
-Returns the Gift Certificate identified by the specified merchant ID.
-
-### redeemGiftCertificate
-
-**Signature:** `static redeemGiftCertificate(paymentInstrument : OrderPaymentInstrument) : Status`
-
-Redeems an amount from a Gift Certificate.
-
-## Method Detail
-
-## Method Details
-
-### createGiftCertificate
-
-**Signature:** `static createGiftCertificate(amount : Number, code : String) : GiftCertificate`
-
-**Description:** Creates a Gift Certificate. If a non-empty Gift Certificate code is specified, the code will be used to create the Gift Certificate. Be aware that this code must be unique for the current site. If it is not unique, the Gift Certificate will not be created.
-
-**Parameters:**
-
-- `amount`: the amount of the gift certificate. Must not be negative or zero.
-- `code`: the code for the new gift certificate. If parameter is null or empty , the system will assign a code to the new gift certificate.
-
-**Returns:**
-
-the newly created Gift Certificate.
-
----
-
-### createGiftCertificate
-
-**Signature:** `static createGiftCertificate(amount : Number) : GiftCertificate`
-
-**Description:** Creates a Gift Certificate. The system will assign a code to the new Gift Certificate.
-
-**Parameters:**
-
-- `amount`: the amount of the gift certificate. Must not be negative or zero.
-
-**Returns:**
-
-the newly created Gift Certificate.
-
----
-
-### getGiftCertificate
-
-**Signature:** `static getGiftCertificate(giftCertificateCode : String) : GiftCertificate`
-
-**Description:** Returns the Gift Certificate identified by the specified gift certificate code.
-
-**Deprecated:**
-
-Use getGiftCertificateByCode(String)
-
-**Parameters:**
-
-- `giftCertificateCode`: to identify the Gift Certificate.
-
-**Returns:**
-
-the Gift Certificate identified by the specified code or null.
-
----
-
-### getGiftCertificateByCode
-
-**Signature:** `static getGiftCertificateByCode(giftCertificateCode : String) : GiftCertificate`
-
-**Description:** Returns the Gift Certificate identified by the specified gift certificate code.
-
-**Parameters:**
-
-- `giftCertificateCode`: to identify the Gift Certificate.
-
-**Returns:**
-
-the Gift Certificate identified by the specified code or null.
-
----
-
-### getGiftCertificateByMerchantID
-
-**Signature:** `static getGiftCertificateByMerchantID(merchantID : String) : GiftCertificate`
-
-**Description:** Returns the Gift Certificate identified by the specified merchant ID.
-
-**Parameters:**
-
-- `merchantID`: to identify the Gift Certificate.
-
-**Returns:**
-
-the Gift Certificate identified by the specified merchant ID or null.
-
----
-
-### redeemGiftCertificate
-
-**Signature:** `static redeemGiftCertificate(paymentInstrument : OrderPaymentInstrument) : Status`
-
-**Description:** Redeems an amount from a Gift Certificate. The Gift Certificate ID is specified in the OrderPaymentInstrument and the amount specified in the PaymentTransaction associated with the OrderPaymentInstrument. If the PaymentTransaction.getTransactionID() is not null, the value returned by this method is used as the 'Order Number' for the redemption transaction. The 'Order Number' is visible via the Business Manager.
-
-**Parameters:**
-
-- `paymentInstrument`: the OrderPaymentInstrument containing the ID of the Gift Certificate to redeem, and the amount of the redemption.
-
-**Returns:**
-
-the status of the redemption operation.
-
----

package/docs/dw_order/GiftCertificateStatusCodes.md

@@ -1,60 +0,0 @@
-## Package: dw.order
-
-# Class GiftCertificateStatusCodes
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.order.GiftCertificateStatusCodes
-
-## Description
-
-Helper class containing status codes for the various errors that can occur when redeeming a gift certificate. One of these codes is returned as part of a Status object when a unsuccessful call to the RedeemGiftCertificate pipelet is made.
-
-## Constants
-
-### GIFTCERTIFICATE_CURRENCY_MISMATCH
-
-**Type:** String = "GIFTCERTIFICATE_CURRENCY_MISMATCH"
-
-Indicates that an error occurred because the Gift Certificate was in a different currency than the Basket.
-
-### GIFTCERTIFICATE_DISABLED
-
-**Type:** String = "GIFTCERTIFICATE_DISABLED"
-
-Indicates that an error occurred because the Gift Certificate is currently disabled.
-
-### GIFTCERTIFICATE_INSUFFICIENT_BALANCE
-
-**Type:** String = "GIFTCERTIFICATE_INSUFFICIENT_BALANCE"
-
-Indicates that an error occurred because the Gift Certificate does not have a sufficient balance to perform the requested operation.
-
-### GIFTCERTIFICATE_NOT_FOUND
-
-**Type:** String = "GIFTCERTIFICATE_NOT_FOUND"
-
-Indicates that an error occurred because the Gift Certificate was not found.
-
-### GIFTCERTIFICATE_PENDING
-
-**Type:** String = "GIFTCERTIFICATE_PENDING"
-
-Indicates that an error occurred because the Gift Certificate is pending and is not available for use.
-
-### GIFTCERTIFICATE_REDEEMED
-
-**Type:** String = "GIFTCERTIFICATE_REDEEMED"
-
-Indicates that an error occurred because the Gift Certificate has been fully redeemed.
-
-## Properties
-
-## Constructor Summary
-
-GiftCertificateStatusCodes()
-
-## Method Summary
-
-## Constructor Detail