@salesforce/b2c-tooling-sdk 0.0.1 → 0.0.3

package/data/script-api/dw.order.GiftCertificateLineItem.md

@@ -0,0 +1,292 @@
+<!-- prettier-ignore-start -->
+# Class GiftCertificateLineItem
+
+- [TopLevel.Object](TopLevel.Object.md)
+  - [dw.object.PersistentObject](dw.object.PersistentObject.md)
+    - [dw.object.ExtensibleObject](dw.object.ExtensibleObject.md)
+      - [dw.order.LineItem](dw.order.LineItem.md)
+        - [dw.order.GiftCertificateLineItem](dw.order.GiftCertificateLineItem.md)
+
+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.
+
+
+
+## Property Summary
+
+| Property | Description |
+| --- | --- |
+| [giftCertificateID](#giftcertificateid): [String](TopLevel.String.md) | Returns the ID of the gift certificate that this line item  was used to create. |
+| [message](#message): [String](TopLevel.String.md) | Returns the message to include in the email of the person receiving  the gift certificate line item. |
+| [productListItem](#productlistitem): [ProductListItem](dw.customer.ProductListItem.md) | Returns the associated ProductListItem. |
+| [recipientEmail](#recipientemail): [String](TopLevel.String.md) | Returns the email address of the person receiving  the gift certificate line item. |
+| [recipientName](#recipientname): [String](TopLevel.String.md) | Returns the name of the person receiving the gift certificate line item. |
+| [senderName](#sendername): [String](TopLevel.String.md) | Returns the name of the person or organization that  sent the gift certificate line item or null if undefined. |
+| [shipment](#shipment): [Shipment](dw.order.Shipment.md) | Returns the associated Shipment. |
+
+## Constructor Summary
+
+This class does not have a constructor, so you cannot create it directly.
+## Method Summary
+
+| Method | Description |
+| --- | --- |
+| [getGiftCertificateID](dw.order.GiftCertificateLineItem.md#getgiftcertificateid)() | Returns the ID of the gift certificate that this line item  was used to create. |
+| [getMessage](dw.order.GiftCertificateLineItem.md#getmessage)() | Returns the message to include in the email of the person receiving  the gift certificate line item. |
+| [getProductListItem](dw.order.GiftCertificateLineItem.md#getproductlistitem)() | Returns the associated ProductListItem. |
+| [getRecipientEmail](dw.order.GiftCertificateLineItem.md#getrecipientemail)() | Returns the email address of the person receiving  the gift certificate line item. |
+| [getRecipientName](dw.order.GiftCertificateLineItem.md#getrecipientname)() | Returns the name of the person receiving the gift certificate line item. |
+| [getSenderName](dw.order.GiftCertificateLineItem.md#getsendername)() | Returns the name of the person or organization that  sent the gift certificate line item or null if undefined. |
+| [getShipment](dw.order.GiftCertificateLineItem.md#getshipment)() | Returns the associated Shipment. |
+| [setGiftCertificateID](dw.order.GiftCertificateLineItem.md#setgiftcertificateidstring)([String](TopLevel.String.md)) | Sets the ID of the gift certificate associated with this line item. |
+| [setMessage](dw.order.GiftCertificateLineItem.md#setmessagestring)([String](TopLevel.String.md)) | Sets the message to include in the email of the person receiving  the gift certificate line item. |
+| [setProductListItem](dw.order.GiftCertificateLineItem.md#setproductlistitemproductlistitem)([ProductListItem](dw.customer.ProductListItem.md)) | Sets the associated ProductListItem. |
+| [setRecipientEmail](dw.order.GiftCertificateLineItem.md#setrecipientemailstring)([String](TopLevel.String.md)) | Sets the email address of the person receiving  the gift certificate line item. |
+| [setRecipientName](dw.order.GiftCertificateLineItem.md#setrecipientnamestring)([String](TopLevel.String.md)) | Sets the name of the person receiving the gift certificate line item. |
+| [setSenderName](dw.order.GiftCertificateLineItem.md#setsendernamestring)([String](TopLevel.String.md)) | Sets the name of the person or organization that  sent the gift certificate line item. |
+| [setShipment](dw.order.GiftCertificateLineItem.md#setshipmentshipment)([Shipment](dw.order.Shipment.md)) | Associates the gift certificate line item with the specified shipment. |
+
+### Methods inherited from class LineItem
+
+[getBasePrice](dw.order.LineItem.md#getbaseprice), [getGrossPrice](dw.order.LineItem.md#getgrossprice), [getLineItemCtnr](dw.order.LineItem.md#getlineitemctnr), [getLineItemText](dw.order.LineItem.md#getlineitemtext), [getNetPrice](dw.order.LineItem.md#getnetprice), [getPrice](dw.order.LineItem.md#getprice), [getPriceValue](dw.order.LineItem.md#getpricevalue), [getTax](dw.order.LineItem.md#gettax), [getTaxBasis](dw.order.LineItem.md#gettaxbasis), [getTaxClassID](dw.order.LineItem.md#gettaxclassid), [getTaxRate](dw.order.LineItem.md#gettaxrate), [setBasePrice](dw.order.LineItem.md#setbasepricemoney), [setGrossPrice](dw.order.LineItem.md#setgrosspricemoney), [setLineItemText](dw.order.LineItem.md#setlineitemtextstring), [setNetPrice](dw.order.LineItem.md#setnetpricemoney), [setPriceValue](dw.order.LineItem.md#setpricevaluenumber), [setTax](dw.order.LineItem.md#settaxmoney), [setTaxClassID](dw.order.LineItem.md#settaxclassidstring), [setTaxRate](dw.order.LineItem.md#settaxratenumber), [updatePrice](dw.order.LineItem.md#updatepricemoney), [updateTax](dw.order.LineItem.md#updatetaxnumber), [updateTax](dw.order.LineItem.md#updatetaxnumber-money), [updateTaxAmount](dw.order.LineItem.md#updatetaxamountmoney)
+### Methods inherited from class ExtensibleObject
+
+[describe](dw.object.ExtensibleObject.md#describe), [getCustom](dw.object.ExtensibleObject.md#getcustom)
+### Methods inherited from class PersistentObject
+
+[getCreationDate](dw.object.PersistentObject.md#getcreationdate), [getLastModified](dw.object.PersistentObject.md#getlastmodified), [getUUID](dw.object.PersistentObject.md#getuuid)
+### Methods inherited from class Object
+
+[assign](TopLevel.Object.md#assignobject-object), [create](TopLevel.Object.md#createobject), [create](TopLevel.Object.md#createobject-object), [defineProperties](TopLevel.Object.md#definepropertiesobject-object), [defineProperty](TopLevel.Object.md#definepropertyobject-object-object), [entries](TopLevel.Object.md#entriesobject), [freeze](TopLevel.Object.md#freezeobject), [fromEntries](TopLevel.Object.md#fromentriesiterable), [getOwnPropertyDescriptor](TopLevel.Object.md#getownpropertydescriptorobject-object), [getOwnPropertyNames](TopLevel.Object.md#getownpropertynamesobject), [getOwnPropertySymbols](TopLevel.Object.md#getownpropertysymbolsobject), [getPrototypeOf](TopLevel.Object.md#getprototypeofobject), [hasOwnProperty](TopLevel.Object.md#hasownpropertystring), [is](TopLevel.Object.md#isobject-object), [isExtensible](TopLevel.Object.md#isextensibleobject), [isFrozen](TopLevel.Object.md#isfrozenobject), [isPrototypeOf](TopLevel.Object.md#isprototypeofobject), [isSealed](TopLevel.Object.md#issealedobject), [keys](TopLevel.Object.md#keysobject), [preventExtensions](TopLevel.Object.md#preventextensionsobject), [propertyIsEnumerable](TopLevel.Object.md#propertyisenumerablestring), [seal](TopLevel.Object.md#sealobject), [setPrototypeOf](TopLevel.Object.md#setprototypeofobject-object), [toLocaleString](TopLevel.Object.md#tolocalestring), [toString](TopLevel.Object.md#tostring), [valueOf](TopLevel.Object.md#valueof), [values](TopLevel.Object.md#valuesobject)
+## Property Details
+
+### giftCertificateID
+- giftCertificateID: [String](TopLevel.String.md)
+  - : 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.
+
+
+
+---
+
+### message
+- message: [String](TopLevel.String.md)
+  - : Returns the message to include in the email of the person receiving
+      the gift certificate line item.
+
+
+
+---
+
+### productListItem
+- productListItem: [ProductListItem](dw.customer.ProductListItem.md)
+  - : Returns the associated ProductListItem.
+
+
+---
+
+### recipientEmail
+- recipientEmail: [String](TopLevel.String.md)
+  - : Returns the email address of the person receiving
+      the gift certificate line item.
+
+
+
+---
+
+### recipientName
+- recipientName: [String](TopLevel.String.md)
+  - : Returns the name of the person receiving the gift certificate line item.
+
+
+---
+
+### senderName
+- senderName: [String](TopLevel.String.md)
+  - : Returns the name of the person or organization that
+      sent the gift certificate line item or null if undefined.
+
+
+
+---
+
+### shipment
+- shipment: [Shipment](dw.order.Shipment.md)
+  - : Returns the associated Shipment.
+
+
+---
+
+## Method Details
+
+### getGiftCertificateID()
+- getGiftCertificateID(): [String](TopLevel.String.md)
+  - : 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()
+- getMessage(): [String](TopLevel.String.md)
+  - : 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()
+- getProductListItem(): [ProductListItem](dw.customer.ProductListItem.md)
+  - : Returns the associated ProductListItem.
+
+    **Returns:**
+    - item or null.
+
+
+---
+
+### getRecipientEmail()
+- getRecipientEmail(): [String](TopLevel.String.md)
+  - : 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()
+- getRecipientName(): [String](TopLevel.String.md)
+  - : 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()
+- getSenderName(): [String](TopLevel.String.md)
+  - : 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()
+- getShipment(): [Shipment](dw.order.Shipment.md)
+  - : Returns the associated Shipment.
+
+    **Returns:**
+    - The shipment of the gift certificate line item
+
+
+---
+
+### setGiftCertificateID(String)
+- setGiftCertificateID(id: [String](TopLevel.String.md)): void
+  - : 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(String)
+- setMessage(message: [String](TopLevel.String.md)): void
+  - : 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(ProductListItem)
+- setProductListItem(productListItem: [ProductListItem](dw.customer.ProductListItem.md)): void
+  - : 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(String)
+- setRecipientEmail(recipientEmail: [String](TopLevel.String.md)): void
+  - : 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(String)
+- setRecipientName(recipient: [String](TopLevel.String.md)): void
+  - : 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(String)
+- setSenderName(sender: [String](TopLevel.String.md)): void
+  - : 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(Shipment)
+- setShipment(shipment: [Shipment](dw.order.Shipment.md)): void
+  - : 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
+
+
+---
+
+<!-- prettier-ignore-end -->

package/data/script-api/dw.order.GiftCertificateMgr.md

@@ -0,0 +1,228 @@
+<!-- prettier-ignore-start -->
+# Class GiftCertificateMgr
+
+- [TopLevel.Object](TopLevel.Object.md)
+  - [dw.order.GiftCertificateMgr](dw.order.GiftCertificateMgr.md)
+
+The GiftCertificateMgr class contains a set of static methods for
+interacting with GiftCertificates.
+
+
+
+## Constant Summary
+
+| Constant | Description |
+| --- | --- |
+| ~~[GC_ERROR_DISABLED](#gc_error_disabled): [String](TopLevel.String.md) = "GIFTCERTIFICATE-100"~~ | Indicates that an error occurred because the Gift Certificate  is currently disabled. |
+| ~~[GC_ERROR_INSUFFICIENT_BALANCE](#gc_error_insufficient_balance): [String](TopLevel.String.md) = "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](#gc_error_invalid_amount): [String](TopLevel.String.md) = "GIFTCERTIFICATE-140"~~ | Indicates that an error occurred because the Gift Certificate  Amount was not valid. |
+| ~~[GC_ERROR_INVALID_CODE](#gc_error_invalid_code): [String](TopLevel.String.md) = "GIFTCERTIFICATE-150"~~ | Indicates that an error occurred because the Gift Certificate  ID was not valid. |
+| ~~[GC_ERROR_PENDING](#gc_error_pending): [String](TopLevel.String.md) = "GIFTCERTIFICATE-130"~~ | Indicates that an error occurred because the Gift Certificate  has been fully redeemed. |
+| ~~[GC_ERROR_REDEEMED](#gc_error_redeemed): [String](TopLevel.String.md) = "GIFTCERTIFICATE-120"~~ | Indicates that an error occurred because the Gift Certificate  has been fully redeemed. |
+
+## Constructor Summary
+
+This class does not have a constructor, so you cannot create it directly.
+## Method Summary
+
+| Method | Description |
+| --- | --- |
+| static [createGiftCertificate](dw.order.GiftCertificateMgr.md#creategiftcertificatenumber)([Number](TopLevel.Number.md)) | Creates a Gift Certificate. |
+| static [createGiftCertificate](dw.order.GiftCertificateMgr.md#creategiftcertificatenumber-string)([Number](TopLevel.Number.md), [String](TopLevel.String.md)) | Creates a Gift Certificate. |
+| ~~static [getGiftCertificate](dw.order.GiftCertificateMgr.md#getgiftcertificatestring)([String](TopLevel.String.md))~~ | Returns the Gift Certificate identified by the specified  gift certificate code. |
+| static [getGiftCertificateByCode](dw.order.GiftCertificateMgr.md#getgiftcertificatebycodestring)([String](TopLevel.String.md)) | Returns the Gift Certificate identified by the specified  gift certificate code. |
+| static [getGiftCertificateByMerchantID](dw.order.GiftCertificateMgr.md#getgiftcertificatebymerchantidstring)([String](TopLevel.String.md)) | Returns the Gift Certificate identified by the specified merchant ID. |
+| static [redeemGiftCertificate](dw.order.GiftCertificateMgr.md#redeemgiftcertificateorderpaymentinstrument)([OrderPaymentInstrument](dw.order.OrderPaymentInstrument.md)) | Redeems an amount from a Gift Certificate. |
+
+### Methods inherited from class Object
+
+[assign](TopLevel.Object.md#assignobject-object), [create](TopLevel.Object.md#createobject), [create](TopLevel.Object.md#createobject-object), [defineProperties](TopLevel.Object.md#definepropertiesobject-object), [defineProperty](TopLevel.Object.md#definepropertyobject-object-object), [entries](TopLevel.Object.md#entriesobject), [freeze](TopLevel.Object.md#freezeobject), [fromEntries](TopLevel.Object.md#fromentriesiterable), [getOwnPropertyDescriptor](TopLevel.Object.md#getownpropertydescriptorobject-object), [getOwnPropertyNames](TopLevel.Object.md#getownpropertynamesobject), [getOwnPropertySymbols](TopLevel.Object.md#getownpropertysymbolsobject), [getPrototypeOf](TopLevel.Object.md#getprototypeofobject), [hasOwnProperty](TopLevel.Object.md#hasownpropertystring), [is](TopLevel.Object.md#isobject-object), [isExtensible](TopLevel.Object.md#isextensibleobject), [isFrozen](TopLevel.Object.md#isfrozenobject), [isPrototypeOf](TopLevel.Object.md#isprototypeofobject), [isSealed](TopLevel.Object.md#issealedobject), [keys](TopLevel.Object.md#keysobject), [preventExtensions](TopLevel.Object.md#preventextensionsobject), [propertyIsEnumerable](TopLevel.Object.md#propertyisenumerablestring), [seal](TopLevel.Object.md#sealobject), [setPrototypeOf](TopLevel.Object.md#setprototypeofobject-object), [toLocaleString](TopLevel.Object.md#tolocalestring), [toString](TopLevel.Object.md#tostring), [valueOf](TopLevel.Object.md#valueof), [values](TopLevel.Object.md#valuesobject)
+## Constant Details
+
+### GC_ERROR_DISABLED
+
+- ~~GC_ERROR_DISABLED: [String](TopLevel.String.md) = "GIFTCERTIFICATE-100"~~
+  - : Indicates that an error occurred because the Gift Certificate
+      is currently disabled.
+
+
+    **Deprecated:**
+:::warning
+Use [GiftCertificateStatusCodes](dw.order.GiftCertificateStatusCodes.md) instead.
+:::
+
+---
+
+### GC_ERROR_INSUFFICIENT_BALANCE
+
+- ~~GC_ERROR_INSUFFICIENT_BALANCE: [String](TopLevel.String.md) = "GIFTCERTIFICATE-110"~~
+  - : Indicates that an error occurred because the Gift Certificate
+      does not have a sufficient balance to perform the requested
+      operation.
+
+
+    **Deprecated:**
+:::warning
+Use [GiftCertificateStatusCodes](dw.order.GiftCertificateStatusCodes.md) instead.
+:::
+
+---
+
+### GC_ERROR_INVALID_AMOUNT
+
+- ~~GC_ERROR_INVALID_AMOUNT: [String](TopLevel.String.md) = "GIFTCERTIFICATE-140"~~
+  - : Indicates that an error occurred because the Gift Certificate
+      Amount was not valid.
+
+
+    **Deprecated:**
+:::warning
+Use [GiftCertificateStatusCodes](dw.order.GiftCertificateStatusCodes.md) instead.
+:::
+
+---
+
+### GC_ERROR_INVALID_CODE
+
+- ~~GC_ERROR_INVALID_CODE: [String](TopLevel.String.md) = "GIFTCERTIFICATE-150"~~
+  - : Indicates that an error occurred because the Gift Certificate
+      ID was not valid.
+
+
+    **Deprecated:**
+:::warning
+Use [GiftCertificateStatusCodes](dw.order.GiftCertificateStatusCodes.md) instead.
+:::
+
+---
+
+### GC_ERROR_PENDING
+
+- ~~GC_ERROR_PENDING: [String](TopLevel.String.md) = "GIFTCERTIFICATE-130"~~
+  - : Indicates that an error occurred because the Gift Certificate
+      has been fully redeemed.
+
+
+    **Deprecated:**
+:::warning
+Use [GiftCertificateStatusCodes](dw.order.GiftCertificateStatusCodes.md) instead.
+:::
+
+---
+
+### GC_ERROR_REDEEMED
+
+- ~~GC_ERROR_REDEEMED: [String](TopLevel.String.md) = "GIFTCERTIFICATE-120"~~
+  - : Indicates that an error occurred because the Gift Certificate
+      has been fully redeemed.
+
+
+    **Deprecated:**
+:::warning
+Use   [GiftCertificateStatusCodes](dw.order.GiftCertificateStatusCodes.md) instead.
+:::
+
+---
+
+## Method Details
+
+### createGiftCertificate(Number)
+- static createGiftCertificate(amount: [Number](TopLevel.Number.md)): [GiftCertificate](dw.order.GiftCertificate.md)
+  - : 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.
+
+
+---
+
+### createGiftCertificate(Number, String)
+- static createGiftCertificate(amount: [Number](TopLevel.Number.md), code: [String](TopLevel.String.md)): [GiftCertificate](dw.order.GiftCertificate.md)
+  - : 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.
+
+
+---
+
+### getGiftCertificate(String)
+- ~~static getGiftCertificate(giftCertificateCode: [String](TopLevel.String.md)): [GiftCertificate](dw.order.GiftCertificate.md)~~
+  - : 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.
+
+    **Deprecated:**
+:::warning
+Use [getGiftCertificateByCode(String)](dw.order.GiftCertificateMgr.md#getgiftcertificatebycodestring)
+:::
+
+---
+
+### getGiftCertificateByCode(String)
+- static getGiftCertificateByCode(giftCertificateCode: [String](TopLevel.String.md)): [GiftCertificate](dw.order.GiftCertificate.md)
+  - : 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(String)
+- static getGiftCertificateByMerchantID(merchantID: [String](TopLevel.String.md)): [GiftCertificate](dw.order.GiftCertificate.md)
+  - : 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(OrderPaymentInstrument)
+- static redeemGiftCertificate(paymentInstrument: [OrderPaymentInstrument](dw.order.OrderPaymentInstrument.md)): [Status](dw.system.Status.md)
+  - : 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.
+
+
+---
+
+<!-- prettier-ignore-end -->

package/data/script-api/dw.order.GiftCertificateStatusCodes.md

@@ -0,0 +1,108 @@
+<!-- prettier-ignore-start -->
+# Class GiftCertificateStatusCodes
+
+- [TopLevel.Object](TopLevel.Object.md)
+  - [dw.order.GiftCertificateStatusCodes](dw.order.GiftCertificateStatusCodes.md)
+
+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.
+
+
+
+## Constant Summary
+
+| Constant | Description |
+| --- | --- |
+| [GIFTCERTIFICATE_CURRENCY_MISMATCH](#giftcertificate_currency_mismatch): [String](TopLevel.String.md) = "GIFTCERTIFICATE_CURRENCY_MISMATCH" | Indicates that an error occurred because the Gift Certificate  was in a different currency than the Basket. |
+| [GIFTCERTIFICATE_DISABLED](#giftcertificate_disabled): [String](TopLevel.String.md) = "GIFTCERTIFICATE_DISABLED" | Indicates that an error occurred because the Gift Certificate  is currently disabled. |
+| [GIFTCERTIFICATE_INSUFFICIENT_BALANCE](#giftcertificate_insufficient_balance): [String](TopLevel.String.md) = "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](#giftcertificate_not_found): [String](TopLevel.String.md) = "GIFTCERTIFICATE_NOT_FOUND" | Indicates that an error occurred because the Gift Certificate  was not found. |
+| [GIFTCERTIFICATE_PENDING](#giftcertificate_pending): [String](TopLevel.String.md) = "GIFTCERTIFICATE_PENDING" | Indicates that an error occurred because the Gift Certificate  is pending and is not available for use. |
+| [GIFTCERTIFICATE_REDEEMED](#giftcertificate_redeemed): [String](TopLevel.String.md) = "GIFTCERTIFICATE_REDEEMED" | Indicates that an error occurred because the Gift Certificate  has been fully redeemed. |
+
+## Constructor Summary
+
+| Constructor | Description |
+| --- | --- |
+| [GiftCertificateStatusCodes](#giftcertificatestatuscodes)() |  |
+
+## Method Summary
+
+### Methods inherited from class Object
+
+[assign](TopLevel.Object.md#assignobject-object), [create](TopLevel.Object.md#createobject), [create](TopLevel.Object.md#createobject-object), [defineProperties](TopLevel.Object.md#definepropertiesobject-object), [defineProperty](TopLevel.Object.md#definepropertyobject-object-object), [entries](TopLevel.Object.md#entriesobject), [freeze](TopLevel.Object.md#freezeobject), [fromEntries](TopLevel.Object.md#fromentriesiterable), [getOwnPropertyDescriptor](TopLevel.Object.md#getownpropertydescriptorobject-object), [getOwnPropertyNames](TopLevel.Object.md#getownpropertynamesobject), [getOwnPropertySymbols](TopLevel.Object.md#getownpropertysymbolsobject), [getPrototypeOf](TopLevel.Object.md#getprototypeofobject), [hasOwnProperty](TopLevel.Object.md#hasownpropertystring), [is](TopLevel.Object.md#isobject-object), [isExtensible](TopLevel.Object.md#isextensibleobject), [isFrozen](TopLevel.Object.md#isfrozenobject), [isPrototypeOf](TopLevel.Object.md#isprototypeofobject), [isSealed](TopLevel.Object.md#issealedobject), [keys](TopLevel.Object.md#keysobject), [preventExtensions](TopLevel.Object.md#preventextensionsobject), [propertyIsEnumerable](TopLevel.Object.md#propertyisenumerablestring), [seal](TopLevel.Object.md#sealobject), [setPrototypeOf](TopLevel.Object.md#setprototypeofobject-object), [toLocaleString](TopLevel.Object.md#tolocalestring), [toString](TopLevel.Object.md#tostring), [valueOf](TopLevel.Object.md#valueof), [values](TopLevel.Object.md#valuesobject)
+## Constant Details
+
+### GIFTCERTIFICATE_CURRENCY_MISMATCH
+
+- GIFTCERTIFICATE_CURRENCY_MISMATCH: [String](TopLevel.String.md) = "GIFTCERTIFICATE_CURRENCY_MISMATCH"
+  - : Indicates that an error occurred because the Gift Certificate
+      was in a different currency than the Basket.
+
+
+
+---
+
+### GIFTCERTIFICATE_DISABLED
+
+- GIFTCERTIFICATE_DISABLED: [String](TopLevel.String.md) = "GIFTCERTIFICATE_DISABLED"
+  - : Indicates that an error occurred because the Gift Certificate
+      is currently disabled.
+
+
+
+---
+
+### GIFTCERTIFICATE_INSUFFICIENT_BALANCE
+
+- GIFTCERTIFICATE_INSUFFICIENT_BALANCE: [String](TopLevel.String.md) = "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
+
+- GIFTCERTIFICATE_NOT_FOUND: [String](TopLevel.String.md) = "GIFTCERTIFICATE_NOT_FOUND"
+  - : Indicates that an error occurred because the Gift Certificate
+      was not found.
+
+
+
+---
+
+### GIFTCERTIFICATE_PENDING
+
+- GIFTCERTIFICATE_PENDING: [String](TopLevel.String.md) = "GIFTCERTIFICATE_PENDING"
+  - : Indicates that an error occurred because the Gift Certificate
+      is pending and is not available for use.
+
+
+
+---
+
+### GIFTCERTIFICATE_REDEEMED
+
+- GIFTCERTIFICATE_REDEEMED: [String](TopLevel.String.md) = "GIFTCERTIFICATE_REDEEMED"
+  - : Indicates that an error occurred because the Gift Certificate
+      has been fully redeemed.
+
+
+
+---
+
+## Constructor Details
+
+### GiftCertificateStatusCodes()
+- GiftCertificateStatusCodes()
+  - : 
+
+
+---
+
+<!-- prettier-ignore-end -->