sfcc-dev-mcp 1.0.16 → 1.0.20

package/dist/docs/dw_extensions.payments/SalesforceAdyenSavedPaymentMethod.md

@@ -0,0 +1,258 @@
+## Package: dw.extensions.payments
+
+# Class SalesforceAdyenSavedPaymentMethod
+
+## Inheritance Hierarchy
+
+- Object
+  - dw.extensions.payments.SalesforceAdyenSavedPaymentMethod
+
+## Description
+
+Salesforce Payments representation of an Adyen saved payment method object. See Salesforce Payments documentation for how to gain access and configure it for use on your sites. An Adyen saved payment method contains information about a credential used by a shopper to attempt payment, such as a payment card or bank account. The available information differs for each type of payment method. It includes only limited information that can be safely presented to a shopper to remind them what credential they used, and specifically not complete card, account, or other numbers that could be used to make future payments.
+
+## Constants
+
+### TYPE_BANCONTACT
+
+**Type:** String = "bancontact"
+
+Represents the Bancontact payment method.
+
+### TYPE_CARD
+
+**Type:** String = "card"
+
+Represents a credit card type of payment method.
+
+### TYPE_IDEAL
+
+**Type:** String = "ideal"
+
+Represents the iDEAL payment method.
+
+### TYPE_SEPA_DEBIT
+
+**Type:** String = "sepa_debit"
+
+Represents the SEPA Debit payment method.
+
+## Properties
+
+### brand
+
+**Type:** String (Read Only)
+
+The brand of this payment method, or null if none is available. Available on
+ TYPE_CARD type methods.
+
+### expiryMonth
+
+**Type:** String (Read Only)
+
+The expiry month of the card for this payment method, or null if none is available.
+ Available on TYPE_CARD and
+ TYPE_BANCONTACT type methods.
+
+### expiryYear
+
+**Type:** String (Read Only)
+
+The expiry year of the card for this payment method, or null if none is available. Available
+ on TYPE_CARD and
+ TYPE_BANCONTACT type methods.
+
+### holderName
+
+**Type:** String (Read Only)
+
+The cardholder name for this payment method, or null if none is available. Available on
+ TYPE_CARD and TYPE_BANCONTACT
+ type methods.
+
+### ID
+
+**Type:** String (Read Only)
+
+The identifier of this payment method.
+
+### last4
+
+**Type:** String (Read Only)
+
+The last 4 digits of the credential for this payment method, or null if none is available.
+ Available on TYPE_CARD and
+ TYPE_BANCONTACT type methods.
+
+### ownerName
+
+**Type:** String (Read Only)
+
+The back account owner name for this payment method, or null if none is available. Available
+ on TYPE_SEPA_DEBIT and
+ TYPE_IDEAL type method.
+
+### type
+
+**Type:** String (Read Only)
+
+The type of this payment method.
+
+## Constructor Summary
+
+## Method Summary
+
+### getBrand
+
+**Signature:** `getBrand() : String`
+
+Returns the brand of this payment method, or null if none is available.
+
+### getExpiryMonth
+
+**Signature:** `getExpiryMonth() : String`
+
+Returns the expiry month of the card for this payment method, or null if none is available.
+
+### getExpiryYear
+
+**Signature:** `getExpiryYear() : String`
+
+Returns the expiry year of the card for this payment method, or null if none is available.
+
+### getHolderName
+
+**Signature:** `getHolderName() : String`
+
+Returns the cardholder name for this payment method, or null if none is available.
+
+### getID
+
+**Signature:** `getID() : String`
+
+Returns the identifier of this payment method.
+
+### getLast4
+
+**Signature:** `getLast4() : String`
+
+Returns the last 4 digits of the credential for this payment method, or null if none is available.
+
+### getOwnerName
+
+**Signature:** `getOwnerName() : String`
+
+Returns the back account owner name for this payment method, or null if none is available.
+
+### getType
+
+**Signature:** `getType() : String`
+
+Returns the type of this payment method.
+
+## Method Detail
+
+## Method Details
+
+### getBrand
+
+**Signature:** `getBrand() : String`
+
+**Description:** Returns the brand of this payment method, or null if none is available. Available on TYPE_CARD type methods.
+
+**Returns:**
+
+payment method brand
+
+---
+
+### getExpiryMonth
+
+**Signature:** `getExpiryMonth() : String`
+
+**Description:** Returns the expiry month of the card for this payment method, or null if none is available. Available on TYPE_CARD and TYPE_BANCONTACT type methods.
+
+**Returns:**
+
+payment method credential expiry month
+
+---
+
+### getExpiryYear
+
+**Signature:** `getExpiryYear() : String`
+
+**Description:** Returns the expiry year of the card for this payment method, or null if none is available. Available on TYPE_CARD and TYPE_BANCONTACT type methods.
+
+**Returns:**
+
+payment method credential expiry year
+
+---
+
+### getHolderName
+
+**Signature:** `getHolderName() : String`
+
+**Description:** Returns the cardholder name for this payment method, or null if none is available. Available on TYPE_CARD and TYPE_BANCONTACT type methods.
+
+**Returns:**
+
+payment method credential cardholder name
+
+---
+
+### getID
+
+**Signature:** `getID() : String`
+
+**Description:** Returns the identifier of this payment method.
+
+**Returns:**
+
+payment method identifier
+
+---
+
+### getLast4
+
+**Signature:** `getLast4() : String`
+
+**Description:** Returns the last 4 digits of the credential for this payment method, or null if none is available. Available on TYPE_CARD and TYPE_BANCONTACT type methods.
+
+**Returns:**
+
+payment method credential last 4 digits
+
+---
+
+### getOwnerName
+
+**Signature:** `getOwnerName() : String`
+
+**Description:** Returns the back account owner name for this payment method, or null if none is available. Available on TYPE_SEPA_DEBIT and TYPE_IDEAL type method.
+
+**Returns:**
+
+payment method credential back account owner name
+
+---
+
+### getType
+
+**Signature:** `getType() : String`
+
+**Description:** Returns the type of this payment method.
+
+**Returns:**
+
+payment method type
+
+**See Also:**
+
+TYPE_BANCONTACT
+TYPE_CARD
+TYPE_IDEAL
+TYPE_SEPA_DEBIT
+
+---

package/dist/docs/dw_extensions.payments/SalesforcePayPalOrder.md

@@ -13,6 +13,18 @@ Salesforce Payments representation of a PayPal order object. See Salesforce Paym
 
 ## Constants
 
+### INTENT_AUTHORIZE
+
+**Type:** String = "AUTHORIZE"
+
+Represents the "AUTHORIZE" intent, meaning manual capture.
+
+### INTENT_CAPTURE
+
+**Type:** String = "CAPTURE"
+
+Represents the "CAPTURE" intent, meaning automatic capture.
+
 ### TYPE_PAYPAL
 
 **Type:** String = "paypal"
@@ -33,6 +45,12 @@ Represents the Venmo funding source.
 
 The amount of this PayPal order.
 
+### authorizationID
+
+**Type:** String (Read Only)
+
+The ID of the authorization against this order, or null if not available.
+
 ### captureID
 
 **Type:** String (Read Only)
@@ -73,6 +91,12 @@ The shipping address for this PayPal order, or null if not known.
 
 Returns the amount of this PayPal order.
 
+### getAuthorizationID
+
+**Signature:** `getAuthorizationID() : String`
+
+Returns the ID of the authorization against this order, or null if not available.
+
 ### getCaptureID
 
 **Signature:** `getCaptureID() : String`
@@ -137,6 +161,18 @@ PayPal order amount
 
 ---
 
+### getAuthorizationID
+
+**Signature:** `getAuthorizationID() : String`
+
+**Description:** Returns the ID of the authorization against this order, or null if not available.
+
+**Returns:**
+
+PayPal order authorization identifier
+
+---
+
 ### getCaptureID
 
 **Signature:** `getCaptureID() : String`

package/dist/docs/dw_extensions.payments/SalesforcePaymentIntent.md

@@ -9,7 +9,7 @@
 
 ## Description
 
-Salesforce Payments representation of a payment intent object. See Salesforce Payments documentation for how to gain access and configure it for use on your sites. A payment intent is automatically created when a shopper is ready to pay for items in their basket. It becomes confirmed when the shopper provides information to the payment provider that is acceptable to authorize payment for a given amount. Once that information has been provided it becomes available as the payment method associated with the payment intent.
+Salesforce Payments representation of a Stripe payment intent object. See Salesforce Payments documentation for how to gain access and configure it for use on your sites. A payment intent is automatically created when a shopper is ready to pay for items in their basket. It becomes confirmed when the shopper provides information to the payment provider that is acceptable to authorize payment for a given amount. Once that information has been provided it becomes available as the payment method associated with the payment intent.
 
 ## Constants
 

package/dist/docs/dw_extensions.payments/SalesforcePaymentsHooks.md

@@ -8,7 +8,7 @@
 
 ## Description
 
-This interface represents all script hooks that can be registered to customize the Salesforce Payments functionality. See Salesforce Payments documentation for how to gain access and configure it for use on your sites. It contains 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.payments.asyncPaymentSucceeded", "script": "./payments.js"} ] 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.
+This interface represents all script hooks that can be registered to customize the Salesforce Payments functionality. See Salesforce Payments documentation for how to gain access and configure it for use on your sites. It contains 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.payments.asyncPaymentSucceeded", "script": "./payments.js"}, {"name": "dw.extensions.payments.adyenNotification", "script": "./payments.js"}, {"name": "dw.extensions.payments.sendOrderConfirmationEmail", "script": "./emails.js"} ] 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
 
@@ -18,16 +18,50 @@ This interface represents all script hooks that can be registered to customize t
 
 ## Method Summary
 
+### adyenNotification
+
+**Signature:** `adyenNotification(order : Order) : Status`
+
+Called when an Adyen webhook notification is received for the given order.
+
 ### asyncPaymentSucceeded
 
 **Signature:** `asyncPaymentSucceeded(order : Order) : Status`
 
 Called when asynchronous payment succeeded for the given order.
 
+### sendOrderConfirmationEmail
+
+**Signature:** `sendOrderConfirmationEmail(order : Order) : Status`
+
+Called to send order confirmation email after successful payment processing.
+
+### stripePaymentEvent
+
+**Signature:** `stripePaymentEvent(eventName : String, order : Order) : Status`
+
+Called when a Stripe payment event is received for the given order.
+
 ## Method Detail
 
 ## Method Details
 
+### adyenNotification
+
+**Signature:** `adyenNotification(order : Order) : Status`
+
+**Description:** Called when an Adyen webhook notification is received for the given order.
+
+**Parameters:**
+
+- `order`: the order for which the notification was received
+
+**Returns:**
+
+a non-null result ends the hook execution, and is ignored
+
+---
+
 ### asyncPaymentSucceeded
 
 **Signature:** `asyncPaymentSucceeded(order : Order) : Status`
@@ -42,4 +76,37 @@ Called when asynchronous payment succeeded for the given order.
 
 a non-null result ends the hook execution, and is ignored
 
+---
+
+### sendOrderConfirmationEmail
+
+**Signature:** `sendOrderConfirmationEmail(order : Order) : Status`
+
+**Description:** Called to send order confirmation email after successful payment processing.
+
+**Parameters:**
+
+- `order`: the order for which to send confirmation email
+
+**Returns:**
+
+a non-null result ends the hook execution
+
+---
+
+### stripePaymentEvent
+
+**Signature:** `stripePaymentEvent(eventName : String, order : Order) : Status`
+
+**Description:** Called when a Stripe payment event is received for the given order.
+
+**Parameters:**
+
+- `eventName`: the Stripe event name, such as "payment_intent.succeeded"
+- `order`: the order for which the event was received
+
+**Returns:**
+
+a non-null result ends the hook execution, and is ignored
+
 ---

package/dist/docs/dw_extensions.payments/SalesforcePaymentsMerchantAccount.md

@@ -0,0 +1,154 @@
+## Package: dw.extensions.payments
+
+# Class SalesforcePaymentsMerchantAccount
+
+## Inheritance Hierarchy
+
+- Object
+  - dw.extensions.payments.SalesforcePaymentsMerchantAccount
+
+## Description
+
+Contains information about a merchant account configured for use with Salesforce Payments. See Salesforce Payments documentation for how to gain access and configure it for use on your sites.
+
+## Properties
+
+### accountId
+
+**Type:** String (Read Only)
+
+The ID of the Salesforce Payments merchant account.
+
+### accountType
+
+**Type:** String (Read Only)
+
+The type of the Salesforce Payments merchant account and environment, such as "STRIPE_TEST"
+ or "ADYEN_LIVE".
+
+### config
+
+**Type:** Object (Read Only)
+
+An opaque configuration object containing gateway-specific information. Do not depend on the structure or
+ contents of this object as they may change at any time.
+
+### live
+
+**Type:** boolean (Read Only)
+
+Returns true if the account takes live payments, or false if it takes test payments.
+
+### vendor
+
+**Type:** String (Read Only)
+
+The name of the gateway vendor, such as "Stripe" or "Adyen".
+
+## Constructor Summary
+
+## Method Summary
+
+### getAccountId
+
+**Signature:** `getAccountId() : String`
+
+Returns the ID of the Salesforce Payments merchant account.
+
+### getAccountType
+
+**Signature:** `getAccountType() : String`
+
+Returns the type of the Salesforce Payments merchant account and environment, such as "STRIPE_TEST" or "ADYEN_LIVE".
+
+### getConfig
+
+**Signature:** `getConfig() : Object`
+
+Returns an opaque configuration object containing gateway-specific information.
+
+### getVendor
+
+**Signature:** `getVendor() : String`
+
+Returns the name of the gateway vendor, such as "Stripe" or "Adyen".
+
+### isLive
+
+**Signature:** `isLive() : boolean`
+
+Returns true if the account takes live payments, or false if it takes test payments.
+
+## Method Detail
+
+## Method Details
+
+### getAccountId
+
+**Signature:** `getAccountId() : String`
+
+**Description:** Returns the ID of the Salesforce Payments merchant account.
+
+**Returns:**
+
+merchant account ID
+
+**See Also:**
+
+PaymentTransaction.setAccountID(String)
+PaymentTransaction.getAccountID()
+
+---
+
+### getAccountType
+
+**Signature:** `getAccountType() : String`
+
+**Description:** Returns the type of the Salesforce Payments merchant account and environment, such as "STRIPE_TEST" or "ADYEN_LIVE".
+
+**Returns:**
+
+merchant account type
+
+**See Also:**
+
+PaymentTransaction.setAccountType(String)
+PaymentTransaction.getAccountType()
+
+---
+
+### getConfig
+
+**Signature:** `getConfig() : Object`
+
+**Description:** Returns an opaque configuration object containing gateway-specific information. Do not depend on the structure or contents of this object as they may change at any time.
+
+**Returns:**
+
+opaque configuration object
+
+---
+
+### getVendor
+
+**Signature:** `getVendor() : String`
+
+**Description:** Returns the name of the gateway vendor, such as "Stripe" or "Adyen".
+
+**Returns:**
+
+gateway vendor name
+
+---
+
+### isLive
+
+**Signature:** `isLive() : boolean`
+
+**Description:** Returns true if the account takes live payments, or false if it takes test payments.
+
+**Returns:**
+
+true if the account takes live payments
+
+---

package/dist/docs/dw_extensions.payments/SalesforcePaymentsMerchantAccountPaymentMethod.md

@@ -0,0 +1,96 @@
+## Package: dw.extensions.payments
+
+# Class SalesforcePaymentsMerchantAccountPaymentMethod
+
+## Inheritance Hierarchy
+
+- Object
+  - dw.extensions.payments.SalesforcePaymentsMerchantAccountPaymentMethod
+
+## Description
+
+Contains information about a payment method to be presented to a payer, as configured for a Salesforce Payments merchant account. See Salesforce Payments documentation for how to gain access and configure it for use on your sites.
+
+## Properties
+
+### merchantAccount
+
+**Type:** SalesforcePaymentsMerchantAccount (Read Only)
+
+The merchant account configured for this payment method.
+
+### paymentMethodType
+
+**Type:** String (Read Only)
+
+The constant indicating the type of payment method to be presented, such as
+ SalesforcePaymentMethod.TYPE_CARD.
+
+### paymentModes
+
+**Type:** Collection (Read Only)
+
+A collection containing the payment modes for which this payment method is to be presented, such as
+ "Express".
+
+## Constructor Summary
+
+## Method Summary
+
+### getMerchantAccount
+
+**Signature:** `getMerchantAccount() : SalesforcePaymentsMerchantAccount`
+
+Returns the merchant account configured for this payment method.
+
+### getPaymentMethodType
+
+**Signature:** `getPaymentMethodType() : String`
+
+Returns the constant indicating the type of payment method to be presented, such as SalesforcePaymentMethod.TYPE_CARD.
+
+### getPaymentModes
+
+**Signature:** `getPaymentModes() : Collection`
+
+Returns a collection containing the payment modes for which this payment method is to be presented, such as "Express".
+
+## Method Detail
+
+## Method Details
+
+### getMerchantAccount
+
+**Signature:** `getMerchantAccount() : SalesforcePaymentsMerchantAccount`
+
+**Description:** Returns the merchant account configured for this payment method.
+
+**Returns:**
+
+merchant account
+
+---
+
+### getPaymentMethodType
+
+**Signature:** `getPaymentMethodType() : String`
+
+**Description:** Returns the constant indicating the type of payment method to be presented, such as SalesforcePaymentMethod.TYPE_CARD.
+
+**Returns:**
+
+payment method type
+
+---
+
+### getPaymentModes
+
+**Signature:** `getPaymentModes() : Collection`
+
+**Description:** Returns a collection containing the payment modes for which this payment method is to be presented, such as "Express".
+
+**Returns:**
+
+collection of payment modes
+
+---