sfcc-dev-mcp 1.0.16 → 1.0.20

package/docs/dw_extensions.payments/SalesforcePaymentsSiteConfiguration.md

@@ -1,95 +0,0 @@
-## Package: dw.extensions.payments
-
-# Class SalesforcePaymentsSiteConfiguration
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.extensions.payments.SalesforcePaymentsSiteConfiguration
-
-## Description
-
-Salesforce Payments representation of a payment site configuration object. See Salesforce Payments documentation for how to gain access and configure it for use on your sites. A payment site configuration contains information about the configuration of the site such as whether the site is activated with Express Checkout, Multi-Step Checkout or both.
-
-## Properties
-
-### cardCaptureAutomatic
-
-**Type:** boolean (Read Only)
-
-Returns true if the capture method is set to automatic for credit card Payment Intents created for this site, or
- false if the capture method is set to manual.
-
-### expressCheckoutEnabled
-
-**Type:** boolean (Read Only)
-
-Returns true if Express Checkout is enabled for the site.
-
-### multiStepCheckoutEnabled
-
-**Type:** boolean (Read Only)
-
-Returns true if Multi-Step Checkout is enabled for the site.
-
-## Constructor Summary
-
-## Method Summary
-
-### isCardCaptureAutomatic
-
-**Signature:** `isCardCaptureAutomatic() : boolean`
-
-Returns true if the capture method is set to automatic for credit card Payment Intents created for this site, or false if the capture method is set to manual.
-
-### isExpressCheckoutEnabled
-
-**Signature:** `isExpressCheckoutEnabled() : boolean`
-
-Returns true if Express Checkout is enabled for the site.
-
-### isMultiStepCheckoutEnabled
-
-**Signature:** `isMultiStepCheckoutEnabled() : boolean`
-
-Returns true if Multi-Step Checkout is enabled for the site.
-
-## Method Detail
-
-## Method Details
-
-### isCardCaptureAutomatic
-
-**Signature:** `isCardCaptureAutomatic() : boolean`
-
-**Description:** Returns true if the capture method is set to automatic for credit card Payment Intents created for this site, or false if the capture method is set to manual.
-
-**Returns:**
-
-true if the credit card capture method is automatic, or false if it is manual
-
----
-
-### isExpressCheckoutEnabled
-
-**Signature:** `isExpressCheckoutEnabled() : boolean`
-
-**Description:** Returns true if Express Checkout is enabled for the site.
-
-**Returns:**
-
-true if Express Checkout is enabled for the site, or false if not
-
----
-
-### isMultiStepCheckoutEnabled
-
-**Signature:** `isMultiStepCheckoutEnabled() : boolean`
-
-**Description:** Returns true if Multi-Step Checkout is enabled for the site.
-
-**Returns:**
-
-true if Multi-Step Checkout is enabled for the site, or false if not
-
----

package/docs/dw_extensions.payments/SalesforceSepaDebitPaymentDetails.md

@@ -1,51 +0,0 @@
-## Package: dw.extensions.payments
-
-# Class SalesforceSepaDebitPaymentDetails
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.extensions.payments.SalesforcePaymentDetails
-  - dw.extensions.payments.SalesforceSepaDebitPaymentDetails
-
-## Description
-
-Details to a Salesforce Payments payment of type SalesforcePaymentMethod.TYPE_SEPA_DEBIT. See Salesforce Payments documentation for how to gain access and configure it for use on your sites.
-
-## Properties
-
-### last4
-
-**Type:** String (Read Only)
-
-The last 4 digits of the account number, or null if not known.
-
-## Constructor Summary
-
-## Method Summary
-
-### getLast4
-
-**Signature:** `getLast4() : String`
-
-Returns the last 4 digits of the account number, or null if not known.
-
-## Method Detail
-
-## Method Details
-
-### getLast4
-
-**Signature:** `getLast4() : String`
-
-**Description:** Returns the last 4 digits of the account number, or null if not known.
-
-**Returns:**
-
-last 4 digits of the account number
-
-**See Also:**
-
-SalesforcePaymentMethod.getLast4()
-
----

package/docs/dw_extensions.payments/SalesforceVenmoPaymentDetails.md

@@ -1,79 +0,0 @@
-## Package: dw.extensions.payments
-
-# Class SalesforceVenmoPaymentDetails
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.extensions.payments.SalesforcePaymentDetails
-  - dw.extensions.payments.SalesforceVenmoPaymentDetails
-
-## Description
-
-Details to a Salesforce Payments payment of type SalesforcePayPalOrder.TYPE_VENMO. See Salesforce Payments documentation for how to gain access and configure it for use on your sites.
-
-## Properties
-
-### captureID
-
-**Type:** String (Read Only)
-
-The ID of the capture against the PayPal Venmo order, or null if not known.
-
-### payerEmailAddress
-
-**Type:** String (Read Only)
-
-The email address of the payer for the PayPal Venmo order, or null if not known.
-
-## Constructor Summary
-
-## Method Summary
-
-### getCaptureID
-
-**Signature:** `getCaptureID() : String`
-
-Returns the ID of the capture against the PayPal Venmo order, or null if not known.
-
-### getPayerEmailAddress
-
-**Signature:** `getPayerEmailAddress() : String`
-
-Returns the email address of the payer for the PayPal Venmo order, or null if not known.
-
-## Method Detail
-
-## Method Details
-
-### getCaptureID
-
-**Signature:** `getCaptureID() : String`
-
-**Description:** Returns the ID of the capture against the PayPal Venmo order, or null if not known.
-
-**Returns:**
-
-PayPal order capture ID
-
-**See Also:**
-
-SalesforcePayPalOrder.getCaptureID()
-
----
-
-### getPayerEmailAddress
-
-**Signature:** `getPayerEmailAddress() : String`
-
-**Description:** Returns the email address of the payer for the PayPal Venmo order, or null if not known.
-
-**Returns:**
-
-payer email address
-
-**See Also:**
-
-SalesforcePayPalOrderPayer.getEmailAddress()
-
----

package/docs/dw_extensions.pinterest/PinterestAvailability.md

@@ -1,86 +0,0 @@
-## Package: dw.extensions.pinterest
-
-# Class PinterestAvailability
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.extensions.pinterest.PinterestAvailability
-
-## Description
-
-Represents a row in the Pinterest availability feed export file.
-
-## Properties
-
-### availability
-
-**Type:** String
-
-The availability of the Pinterest product. Possible values are
- PinterestProduct.AVAILABILITY_IN_STOCK or
- PinterestProduct.AVAILABILITY_OUT_OF_STOCK.
-
-### ID
-
-**Type:** String (Read Only)
-
-The ID of the Pinterest product. This is the same as the ID of the Demandware product.
-
-## Constructor Summary
-
-## Method Summary
-
-### getAvailability
-
-**Signature:** `getAvailability() : String`
-
-Returns the availability of the Pinterest product.
-
-### getID
-
-**Signature:** `getID() : String`
-
-Returns the ID of the Pinterest product.
-
-### setAvailability
-
-**Signature:** `setAvailability(availability : String) : void`
-
-Sets the availability of the Pinterest product.
-
-## Method Detail
-
-## Method Details
-
-### getAvailability
-
-**Signature:** `getAvailability() : String`
-
-**Description:** Returns the availability of the Pinterest product. Possible values are PinterestProduct.AVAILABILITY_IN_STOCK or PinterestProduct.AVAILABILITY_OUT_OF_STOCK.
-
----
-
-### getID
-
-**Signature:** `getID() : String`
-
-**Description:** Returns the ID of the Pinterest product. This is the same as the ID of the Demandware product.
-
-**Returns:**
-
-product ID
-
----
-
-### setAvailability
-
-**Signature:** `setAvailability(availability : String) : void`
-
-**Description:** Sets the availability of the Pinterest product. Possible values are PinterestProduct.AVAILABILITY_IN_STOCK or PinterestProduct.AVAILABILITY_OUT_OF_STOCK.
-
-**Parameters:**
-
-- `availability`: the availability status to set for this product
-
----

package/docs/dw_extensions.pinterest/PinterestFeedHooks.md

@@ -1,69 +0,0 @@
-## Package: dw.extensions.pinterest
-
-# Class PinterestFeedHooks
-
-## Inheritance Hierarchy
-
-- dw.extensions.pinterest.PinterestFeedHooks
-
-## Description
-
-PinterestFeedHooks interface containing extension points for customizing Pinterest export feeds. These hooks are not executed in a transaction. The extension points (hook names), and the functions that are called by each extension point. A function must be defined inside a JavaScript source and must be exported. The script with the exported hook function must be located inside a site cartridge. Inside the site cartridge a 'package.json' file with a 'hooks' entry must exist. "hooks": "./hooks.json" The hooks entry links to a json file, relative to the 'package.json' file. This file lists all registered hooks inside the hooks property: "hooks": [ {"name": "dw.extensions.pinterest.feed.transformProduct", "script": "./hooks.ds"} ] A hook entry has a 'name' and a 'script' property. The 'name' contains the extension point, the hook name. The 'script' contains the script relative to the hooks file, with the exported hook function.
-
-## Constants
-
-## Properties
-
-## Constructor Summary
-
-## Method Summary
-
-### transformAvailability
-
-**Signature:** `transformAvailability(product : Product, pinterestAvailability : PinterestAvailability) : Status`
-
-Called after default transformation of given Demandware product to Pinterest availability as part of the availability feed export.
-
-### transformProduct
-
-**Signature:** `transformProduct(product : Product, pinterestProduct : PinterestProduct) : Status`
-
-Called after default transformation of given Demandware product to Pinterest product as part of the catalog feed export.
-
-## Method Detail
-
-## Method Details
-
-### transformAvailability
-
-**Signature:** `transformAvailability(product : Product, pinterestAvailability : PinterestAvailability) : Status`
-
-**Description:** Called after default transformation of given Demandware product to Pinterest availability as part of the availability feed export.
-
-**Parameters:**
-
-- `product`: the Demandware product
-- `pinterestAvailability`: the Pinterest representation of the product availability
-
-**Returns:**
-
-a non-null Status ends the hook execution
-
----
-
-### transformProduct
-
-**Signature:** `transformProduct(product : Product, pinterestProduct : PinterestProduct) : Status`
-
-**Description:** Called after default transformation of given Demandware product to Pinterest product as part of the catalog feed export.
-
-**Parameters:**
-
-- `product`: the Demandware product
-- `pinterestProduct`: the Pinterest representation of the product
-
-**Returns:**
-
-a non-null Status ends the hook execution
-
----

package/docs/dw_extensions.pinterest/PinterestOrder.md

@@ -1,232 +0,0 @@
-## Package: dw.extensions.pinterest
-
-# Class PinterestOrder
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.extensions.pinterest.PinterestOrder
-
-## Description
-
-An order that was placed through Pinterest.
-
-## Constants
-
-### PAYMENT_STATUS_NOT_PAID
-
-**Type:** String = "NOT_PAID"
-
-Indicates that payment has not been made.
-
-### PAYMENT_STATUS_PAID
-
-**Type:** String = "PAID"
-
-Indicates that payment is complete.
-
-### PAYMENT_STATUS_PART_PAID
-
-**Type:** String = "PART_PAID"
-
-Indicates that payment is incomplete.
-
-### STATUS_BACKORDER
-
-**Type:** String = "BACKORDER"
-
-Indicates an order on backorder.
-
-### STATUS_CANCELLED
-
-**Type:** String = "CANCELLED"
-
-Indicates an order that has been canceled.
-
-### STATUS_DELIVERED
-
-**Type:** String = "DELIVERED"
-
-Indicates an order that has been delivered.
-
-### STATUS_IN_PROGRESS
-
-**Type:** String = "IN_PROGRESS"
-
-Indicates an order in progress.
-
-### STATUS_NEW
-
-**Type:** String = "NEW"
-
-Indicates a new order.
-
-### STATUS_RETURNED
-
-**Type:** String = "RETURNED"
-
-Indicates an order that has been returned.
-
-### STATUS_SHIPPED
-
-**Type:** String = "SHIPPED"
-
-Indicates an order that has shipped.
-
-## Properties
-
-### itemId
-
-**Type:** String
-
-The item ID for this Pinterest order.
-
-### orderNo
-
-**Type:** String (Read Only)
-
-The order number for this Pinterest order. This is the same as the order number of the Demandware order.
-
-### paymentStatus
-
-**Type:** String
-
-The status of this Pinterest order. Possible values are
- PAYMENT_STATUS_PAID,
- PAYMENT_STATUS_NOT_PAID,
- or PAYMENT_STATUS_PART_PAID.
-
-### status
-
-**Type:** String
-
-The status of this Pinterest order. Possible values are
- STATUS_NEW,
- STATUS_IN_PROGRESS,
- STATUS_SHIPPED,
- STATUS_BACKORDER,
- STATUS_CANCELLED,
- STATUS_DELIVERED,
- or STATUS_RETURNED.
-
-## Constructor Summary
-
-## Method Summary
-
-### getItemId
-
-**Signature:** `getItemId() : String`
-
-Returns the item ID for this Pinterest order.
-
-### getOrderNo
-
-**Signature:** `getOrderNo() : String`
-
-Returns the order number for this Pinterest order.
-
-### getPaymentStatus
-
-**Signature:** `getPaymentStatus() : String`
-
-Returns the status of this Pinterest order.
-
-### getStatus
-
-**Signature:** `getStatus() : String`
-
-Returns the status of this Pinterest order.
-
-### setItemId
-
-**Signature:** `setItemId(itemId : String) : void`
-
-Sets the item ID for this Pinterest order.
-
-### setPaymentStatus
-
-**Signature:** `setPaymentStatus(status : String) : void`
-
-Sets the status of this Pinterest order.
-
-### setStatus
-
-**Signature:** `setStatus(status : String) : void`
-
-Sets the status of this Pinterest order.
-
-## Method Detail
-
-## Method Details
-
-### getItemId
-
-**Signature:** `getItemId() : String`
-
-**Description:** Returns the item ID for this Pinterest order.
-
----
-
-### getOrderNo
-
-**Signature:** `getOrderNo() : String`
-
-**Description:** Returns the order number for this Pinterest order. This is the same as the order number of the Demandware order.
-
-**Returns:**
-
-order number
-
----
-
-### getPaymentStatus
-
-**Signature:** `getPaymentStatus() : String`
-
-**Description:** Returns the status of this Pinterest order. Possible values are PAYMENT_STATUS_PAID, PAYMENT_STATUS_NOT_PAID, or PAYMENT_STATUS_PART_PAID.
-
----
-
-### getStatus
-
-**Signature:** `getStatus() : String`
-
-**Description:** Returns the status of this Pinterest order. Possible values are STATUS_NEW, STATUS_IN_PROGRESS, STATUS_SHIPPED, STATUS_BACKORDER, STATUS_CANCELLED, STATUS_DELIVERED, or STATUS_RETURNED.
-
----
-
-### setItemId
-
-**Signature:** `setItemId(itemId : String) : void`
-
-**Description:** Sets the item ID for this Pinterest order.
-
-**Parameters:**
-
-- `itemId`: item ID
-
----
-
-### setPaymentStatus
-
-**Signature:** `setPaymentStatus(status : String) : void`
-
-**Description:** Sets the status of this Pinterest order. Possible values are PAYMENT_STATUS_PAID, PAYMENT_STATUS_NOT_PAID, or PAYMENT_STATUS_PART_PAID.
-
-**Parameters:**
-
-- `status`: the status to set for this order
-
----
-
-### setStatus
-
-**Signature:** `setStatus(status : String) : void`
-
-**Description:** Sets the status of this Pinterest order. Possible values are STATUS_NEW, STATUS_IN_PROGRESS, STATUS_SHIPPED, STATUS_BACKORDER, STATUS_CANCELLED, STATUS_DELIVERED, or STATUS_RETURNED.
-
-**Parameters:**
-
-- `status`: the status to set for this order
-
----

package/docs/dw_extensions.pinterest/PinterestOrderHooks.md

@@ -1,45 +0,0 @@
-## Package: dw.extensions.pinterest
-
-# Class PinterestOrderHooks
-
-## Inheritance Hierarchy
-
-- dw.extensions.pinterest.PinterestOrderHooks
-
-## Description
-
-PinterestOrderHooks interface containing extension points for customizing Pinterest order status. These hooks are not executed in a transaction. The extension points (hook names), and the functions that are called by each extension point. A function must be defined inside a JavaScript source and must be exported. The script with the exported hook function must be located inside a site cartridge. Inside the site cartridge a 'package.json' file with a 'hooks' entry must exist. "hooks": "./hooks.json" The hooks entry links to a json file, relative to the 'package.json' file. This file lists all registered hooks inside the hooks property: "hooks": [ {"name": "dw.extensions.pinterest.order.getStatus", "script": "./hooks.ds"} ] A hook entry has a 'name' and a 'script' property. The 'name' contains the extension point, the hook name. The 'script' contains the script relative to the hooks file, with the exported hook function.
-
-## Constants
-
-## Properties
-
-## Constructor Summary
-
-## Method Summary
-
-### getStatus
-
-**Signature:** `getStatus(order : PinterestOrder) : Status`
-
-Called to retrieve status for the given order.
-
-## Method Detail
-
-## Method Details
-
-### getStatus
-
-**Signature:** `getStatus(order : PinterestOrder) : Status`
-
-**Description:** Called to retrieve status for the given order. Return a null status for unknown orders.
-
-**Parameters:**
-
-- `order`: the Pinterest order
-
-**Returns:**
-
-a non-null Status ends the hook execution
-
----