@salesforce/b2c-tooling-sdk 1.19.1 → 1.20.0

package/data/script-api/dw.extensions.payments.SalesforcePaymentsHooks.md

@@ -1,190 +0,0 @@
-<!-- prettier-ignore-start -->
-# Class SalesforcePaymentsHooks
-
-- [TopLevel.Object](TopLevel.Object.md)
-  - [dw.extensions.payments.SalesforcePaymentsHooks](dw.extensions.payments.SalesforcePaymentsHooks.md)
-
-
-
-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.adyenFailureNotification", "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.
-
-
-
-## Constant Summary
-
-| Constant | Description |
-| --- | --- |
-| [extensionPointAdyenFailureNotification](#extensionpointadyenfailurenotification): [String](TopLevel.String.md) = "dw.extensions.payments.adyenFailureNotification" | The extension point name dw.extensions.payments.adyenFailureNotification. |
-| [extensionPointAdyenNotification](#extensionpointadyennotification): [String](TopLevel.String.md) = "dw.extensions.payments.adyenNotification" | The extension point name dw.extensions.payments.adyenNotification. |
-| [extensionPointAsyncPaymentSucceeded](#extensionpointasyncpaymentsucceeded): [String](TopLevel.String.md) = "dw.extensions.payments.asyncPaymentSucceeded" | The extension point name dw.extensions.payments.asyncPaymentSucceeded. |
-| [extensionPointSendOrderConfirmationEmail](#extensionpointsendorderconfirmationemail): [String](TopLevel.String.md) = "dw.extensions.payments.sendOrderConfirmationEmail" | The extension point name dw.extensions.payments.sendOrderConfirmationEmail. |
-| [extensionPointStripePaymentEvent](#extensionpointstripepaymentevent): [String](TopLevel.String.md) = "dw.extensions.payments.stripePaymentEvent" | The extension point name dw.extensions.payments.stripePaymentEvent. |
-
-## Constructor Summary
-
-This class does not have a constructor, so you cannot create it directly.
-## Method Summary
-
-| Method | Description |
-| --- | --- |
-| [adyenFailureNotification](dw.extensions.payments.SalesforcePaymentsHooks.md#adyenfailurenotificationorder)([Order](dw.order.Order.md)) | Called when an Adyen webhook notification with a failed payment is received for the given order. |
-| [adyenNotification](dw.extensions.payments.SalesforcePaymentsHooks.md#adyennotificationorder)([Order](dw.order.Order.md)) | Called when an Adyen webhook notification is received for the given order. |
-| [asyncPaymentSucceeded](dw.extensions.payments.SalesforcePaymentsHooks.md#asyncpaymentsucceededorder)([Order](dw.order.Order.md)) | Called when asynchronous payment succeeded for the given order. |
-| [sendOrderConfirmationEmail](dw.extensions.payments.SalesforcePaymentsHooks.md#sendorderconfirmationemailorder)([Order](dw.order.Order.md)) | Called to send order confirmation email after successful payment processing. |
-| [stripePaymentEvent](dw.extensions.payments.SalesforcePaymentsHooks.md#stripepaymenteventstring-order)([String](TopLevel.String.md), [Order](dw.order.Order.md)) | Called when a Stripe payment event is received for the given order. |
-
-### 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
-
-### extensionPointAdyenFailureNotification
-
-- extensionPointAdyenFailureNotification: [String](TopLevel.String.md) = "dw.extensions.payments.adyenFailureNotification"
-  - : The extension point name dw.extensions.payments.adyenFailureNotification.
-
-
----
-
-### extensionPointAdyenNotification
-
-- extensionPointAdyenNotification: [String](TopLevel.String.md) = "dw.extensions.payments.adyenNotification"
-  - : The extension point name dw.extensions.payments.adyenNotification.
-
-
----
-
-### extensionPointAsyncPaymentSucceeded
-
-- extensionPointAsyncPaymentSucceeded: [String](TopLevel.String.md) = "dw.extensions.payments.asyncPaymentSucceeded"
-  - : The extension point name dw.extensions.payments.asyncPaymentSucceeded.
-
-
----
-
-### extensionPointSendOrderConfirmationEmail
-
-- extensionPointSendOrderConfirmationEmail: [String](TopLevel.String.md) = "dw.extensions.payments.sendOrderConfirmationEmail"
-  - : The extension point name dw.extensions.payments.sendOrderConfirmationEmail.
-
-
----
-
-### extensionPointStripePaymentEvent
-
-- extensionPointStripePaymentEvent: [String](TopLevel.String.md) = "dw.extensions.payments.stripePaymentEvent"
-  - : The extension point name dw.extensions.payments.stripePaymentEvent.
-
-
----
-
-## Method Details
-
-### adyenFailureNotification(Order)
-- adyenFailureNotification(order: [Order](dw.order.Order.md)): [Status](dw.system.Status.md)
-  - : Called when an Adyen webhook notification with a failed payment is received for the given order.
-
-    **Parameters:**
-    - order - the order for which the failure notification was received
-
-    **Returns:**
-    - a non-null result ends the hook execution, and is ignored
-
-
----
-
-### adyenNotification(Order)
-- adyenNotification(order: [Order](dw.order.Order.md)): [Status](dw.system.Status.md)
-  - : 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(Order)
-- asyncPaymentSucceeded(order: [Order](dw.order.Order.md)): [Status](dw.system.Status.md)
-  - : Called when asynchronous payment succeeded for the given order.
-
-    **Parameters:**
-    - order - the order whose asynchronous payment succeeded
-
-    **Returns:**
-    - a non-null result ends the hook execution, and is ignored
-
-
----
-
-### sendOrderConfirmationEmail(Order)
-- sendOrderConfirmationEmail(order: [Order](dw.order.Order.md)): [Status](dw.system.Status.md)
-  - : 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(String, Order)
-- stripePaymentEvent(eventName: [String](TopLevel.String.md), order: [Order](dw.order.Order.md)): [Status](dw.system.Status.md)
-  - : 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
-
-
----
-
-<!-- prettier-ignore-end -->

package/data/script-api/dw.extensions.payments.SalesforcePaymentsMerchantAccount.md

@@ -1,151 +0,0 @@
-<!-- prettier-ignore-start -->
-# Class SalesforcePaymentsMerchantAccount
-
-- [TopLevel.Object](TopLevel.Object.md)
-  - [dw.extensions.payments.SalesforcePaymentsMerchantAccount](dw.extensions.payments.SalesforcePaymentsMerchantAccount.md)
-
-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.
-
-
-
-## Property Summary
-
-| Property | Description |
-| --- | --- |
-| [accountId](#accountid): [String](TopLevel.String.md) `(read-only)` | Returns the ID of the Salesforce Payments merchant account. |
-| [accountType](#accounttype): [String](TopLevel.String.md) `(read-only)` | Returns the type of the Salesforce Payments merchant account and environment, such as `"STRIPE_TEST"`  or `"ADYEN_LIVE"`. |
-| [config](#config): [Object](TopLevel.Object.md) `(read-only)` | Returns an opaque configuration object containing gateway-specific information. |
-| [live](#live): [Boolean](TopLevel.Boolean.md) `(read-only)` | Returns `true` if the account takes live payments, or `false` if it takes test payments. |
-| [vendor](#vendor): [String](TopLevel.String.md) `(read-only)` | Returns the name of the gateway vendor, such as `"Stripe"` or `"Adyen"`. |
-
-## Constructor Summary
-
-This class does not have a constructor, so you cannot create it directly.
-## Method Summary
-
-| Method | Description |
-| --- | --- |
-| [getAccountId](dw.extensions.payments.SalesforcePaymentsMerchantAccount.md#getaccountid)() | Returns the ID of the Salesforce Payments merchant account. |
-| [getAccountType](dw.extensions.payments.SalesforcePaymentsMerchantAccount.md#getaccounttype)() | Returns the type of the Salesforce Payments merchant account and environment, such as `"STRIPE_TEST"`  or `"ADYEN_LIVE"`. |
-| [getConfig](dw.extensions.payments.SalesforcePaymentsMerchantAccount.md#getconfig)() | Returns an opaque configuration object containing gateway-specific information. |
-| [getVendor](dw.extensions.payments.SalesforcePaymentsMerchantAccount.md#getvendor)() | Returns the name of the gateway vendor, such as `"Stripe"` or `"Adyen"`. |
-| [isLive](dw.extensions.payments.SalesforcePaymentsMerchantAccount.md#islive)() | Returns `true` if the account takes live payments, or `false` if it takes test payments. |
-
-### 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
-
-### accountId
-- accountId: [String](TopLevel.String.md) `(read-only)`
-  - : Returns the ID of the Salesforce Payments merchant account.
-
-    **See Also:**
-    - [PaymentTransaction.setAccountID(String)](dw.order.PaymentTransaction.md#setaccountidstring)
-    - [PaymentTransaction.getAccountID()](dw.order.PaymentTransaction.md#getaccountid)
-
-
----
-
-### accountType
-- accountType: [String](TopLevel.String.md) `(read-only)`
-  - : Returns the type of the Salesforce Payments merchant account and environment, such as `"STRIPE_TEST"`
-      or `"ADYEN_LIVE"`.
-
-
-    **See Also:**
-    - [PaymentTransaction.setAccountType(String)](dw.order.PaymentTransaction.md#setaccounttypestring)
-    - [PaymentTransaction.getAccountType()](dw.order.PaymentTransaction.md#getaccounttype)
-
-
----
-
-### config
-- config: [Object](TopLevel.Object.md) `(read-only)`
-  - : 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.
-
-
-
----
-
-### live
-- live: [Boolean](TopLevel.Boolean.md) `(read-only)`
-  - : Returns `true` if the account takes live payments, or `false` if it takes test payments.
-
-
----
-
-### vendor
-- vendor: [String](TopLevel.String.md) `(read-only)`
-  - : Returns the name of the gateway vendor, such as `"Stripe"` or `"Adyen"`.
-
-
----
-
-## Method Details
-
-### getAccountId()
-- getAccountId(): [String](TopLevel.String.md)
-  - : Returns the ID of the Salesforce Payments merchant account.
-
-    **Returns:**
-    - merchant account ID
-
-    **See Also:**
-    - [PaymentTransaction.setAccountID(String)](dw.order.PaymentTransaction.md#setaccountidstring)
-    - [PaymentTransaction.getAccountID()](dw.order.PaymentTransaction.md#getaccountid)
-
-
----
-
-### getAccountType()
-- getAccountType(): [String](TopLevel.String.md)
-  - : 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)](dw.order.PaymentTransaction.md#setaccounttypestring)
-    - [PaymentTransaction.getAccountType()](dw.order.PaymentTransaction.md#getaccounttype)
-
-
----
-
-### getConfig()
-- getConfig(): [Object](TopLevel.Object.md)
-  - : 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()
-- getVendor(): [String](TopLevel.String.md)
-  - : Returns the name of the gateway vendor, such as `"Stripe"` or `"Adyen"`.
-
-    **Returns:**
-    - gateway vendor name
-
-
----
-
-### isLive()
-- isLive(): [Boolean](TopLevel.Boolean.md)
-  - : Returns `true` if the account takes live payments, or `false` if it takes test payments.
-
-    **Returns:**
-    - `true` if the account takes live payments
-
-
----
-
-<!-- prettier-ignore-end -->

package/data/script-api/dw.extensions.payments.SalesforcePaymentsMerchantAccountPaymentMethod.md

@@ -1,98 +0,0 @@
-<!-- prettier-ignore-start -->
-# Class SalesforcePaymentsMerchantAccountPaymentMethod
-
-- [TopLevel.Object](TopLevel.Object.md)
-  - [dw.extensions.payments.SalesforcePaymentsMerchantAccountPaymentMethod](dw.extensions.payments.SalesforcePaymentsMerchantAccountPaymentMethod.md)
-
-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.
-
-
-
-## Property Summary
-
-| Property | Description |
-| --- | --- |
-| [merchantAccount](#merchantaccount): [SalesforcePaymentsMerchantAccount](dw.extensions.payments.SalesforcePaymentsMerchantAccount.md) `(read-only)` | Returns the merchant account configured for this payment method. |
-| [paymentMethodType](#paymentmethodtype): [String](TopLevel.String.md) `(read-only)` | Returns the constant indicating the type of payment method to be presented, such as  [SalesforcePaymentMethod.TYPE_CARD](dw.extensions.payments.SalesforcePaymentMethod.md#type_card). |
-| [paymentModes](#paymentmodes): [Collection](dw.util.Collection.md) `(read-only)` | Returns a collection containing the payment modes for which this payment method is to be presented, such as  `"Express"`. |
-
-## Constructor Summary
-
-This class does not have a constructor, so you cannot create it directly.
-## Method Summary
-
-| Method | Description |
-| --- | --- |
-| [getMerchantAccount](dw.extensions.payments.SalesforcePaymentsMerchantAccountPaymentMethod.md#getmerchantaccount)() | Returns the merchant account configured for this payment method. |
-| [getPaymentMethodType](dw.extensions.payments.SalesforcePaymentsMerchantAccountPaymentMethod.md#getpaymentmethodtype)() | Returns the constant indicating the type of payment method to be presented, such as  [SalesforcePaymentMethod.TYPE_CARD](dw.extensions.payments.SalesforcePaymentMethod.md#type_card). |
-| [getPaymentModes](dw.extensions.payments.SalesforcePaymentsMerchantAccountPaymentMethod.md#getpaymentmodes)() | Returns a collection containing the payment modes for which this payment method is to be presented, such as  `"Express"`. |
-
-### 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
-
-### merchantAccount
-- merchantAccount: [SalesforcePaymentsMerchantAccount](dw.extensions.payments.SalesforcePaymentsMerchantAccount.md) `(read-only)`
-  - : Returns the merchant account configured for this payment method.
-
-
----
-
-### paymentMethodType
-- paymentMethodType: [String](TopLevel.String.md) `(read-only)`
-  - : Returns the constant indicating the type of payment method to be presented, such as
-      [SalesforcePaymentMethod.TYPE_CARD](dw.extensions.payments.SalesforcePaymentMethod.md#type_card).
-
-
-
----
-
-### paymentModes
-- paymentModes: [Collection](dw.util.Collection.md) `(read-only)`
-  - : Returns a collection containing the payment modes for which this payment method is to be presented, such as
-      `"Express"`.
-
-
-
----
-
-## Method Details
-
-### getMerchantAccount()
-- getMerchantAccount(): [SalesforcePaymentsMerchantAccount](dw.extensions.payments.SalesforcePaymentsMerchantAccount.md)
-  - : Returns the merchant account configured for this payment method.
-
-    **Returns:**
-    - merchant account
-
-
----
-
-### getPaymentMethodType()
-- getPaymentMethodType(): [String](TopLevel.String.md)
-  - : Returns the constant indicating the type of payment method to be presented, such as
-      [SalesforcePaymentMethod.TYPE_CARD](dw.extensions.payments.SalesforcePaymentMethod.md#type_card).
-
-
-    **Returns:**
-    - payment method type
-
-
----
-
-### getPaymentModes()
-- getPaymentModes(): [Collection](dw.util.Collection.md)
-  - : Returns a collection containing the payment modes for which this payment method is to be presented, such as
-      `"Express"`.
-
-
-    **Returns:**
-    - collection of payment modes
-
-
----
-
-<!-- prettier-ignore-end -->