sfcc-dev-mcp 1.0.19 → 1.0.21

package/docs/dw_extensions.payments/SalesforcePaymentIntent.md

@@ -1,281 +0,0 @@
-## Package: dw.extensions.payments
-
-# Class SalesforcePaymentIntent
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.extensions.payments.SalesforcePaymentIntent
-
-## 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.
-
-## Constants
-
-### SETUP_FUTURE_USAGE_OFF_SESSION
-
-**Type:** String = "off_session"
-
-Represents the payment method setup future usage is off session.
-
-### SETUP_FUTURE_USAGE_ON_SESSION
-
-**Type:** String = "on_session"
-
-Represents the payment method setup future usage is on session.
-
-## Properties
-
-### amount
-
-**Type:** Money (Read Only)
-
-The amount of this payment intent.
-
-### cancelable
-
-**Type:** boolean (Read Only)
-
-Returns true if this payment intent has a status which indicates it can be canceled,
- or false if its status does not indicate it can be canceled.
-
-### clientSecret
-
-**Type:** String (Read Only)
-
-The client secret of this payment intent.
-
-### confirmed
-
-**Type:** boolean (Read Only)
-
-Returns true if this payment intent has been confirmed, or false if not.
-
-### ID
-
-**Type:** String (Read Only)
-
-The identifier of this payment intent.
-
-### paymentMethod
-
-**Type:** SalesforcePaymentMethod (Read Only)
-
-The payment method for this payment intent, or null if none has been established.
-
-### refundable
-
-**Type:** boolean (Read Only)
-
-Returns true if this payment intent has a status and other state which indicate it can be refunded,
- or false if it cannot be refunded.
-
-### setupFutureUsage
-
-**Type:** String (Read Only)
-
-Returns SETUP_FUTURE_USAGE_OFF_SESSION or SETUP_FUTURE_USAGE_ON_SESSION to indicate how the payment
- intent can be used in the future or returns null if future usage is not set up.
-
-## Constructor Summary
-
-## Method Summary
-
-### getAmount
-
-**Signature:** `getAmount() : Money`
-
-Returns the amount of this payment intent.
-
-### getClientSecret
-
-**Signature:** `getClientSecret() : String`
-
-Returns the client secret of this payment intent.
-
-### getID
-
-**Signature:** `getID() : String`
-
-Returns the identifier of this payment intent.
-
-### getPaymentInstrument
-
-**Signature:** `getPaymentInstrument(basket : Basket) : OrderPaymentInstrument`
-
-Returns the payment instrument for this payment intent in the given basket, or null if the given basket has none.
-
-### getPaymentInstrument
-
-**Signature:** `getPaymentInstrument(order : Order) : OrderPaymentInstrument`
-
-Returns the payment instrument for this payment intent in the given order, or null if the given order has none.
-
-### getPaymentMethod
-
-**Signature:** `getPaymentMethod() : SalesforcePaymentMethod`
-
-Returns the payment method for this payment intent, or null if none has been established.
-
-### getSetupFutureUsage
-
-**Signature:** `getSetupFutureUsage() : String`
-
-Returns SETUP_FUTURE_USAGE_OFF_SESSION or SETUP_FUTURE_USAGE_ON_SESSION to indicate how the payment intent can be used in the future or returns null if future usage is not set up.
-
-### isCancelable
-
-**Signature:** `isCancelable() : boolean`
-
-Returns true if this payment intent has a status which indicates it can be canceled, or false if its status does not indicate it can be canceled.
-
-### isConfirmed
-
-**Signature:** `isConfirmed() : boolean`
-
-Returns true if this payment intent has been confirmed, or false if not.
-
-### isRefundable
-
-**Signature:** `isRefundable() : boolean`
-
-Returns true if this payment intent has a status and other state which indicate it can be refunded, or false if it cannot be refunded.
-
-## Method Detail
-
-## Method Details
-
-### getAmount
-
-**Signature:** `getAmount() : Money`
-
-**Description:** Returns the amount of this payment intent.
-
-**Returns:**
-
-payment intent amount
-
----
-
-### getClientSecret
-
-**Signature:** `getClientSecret() : String`
-
-**Description:** Returns the client secret of this payment intent.
-
-**Returns:**
-
-payment intent client secret
-
----
-
-### getID
-
-**Signature:** `getID() : String`
-
-**Description:** Returns the identifier of this payment intent.
-
-**Returns:**
-
-payment intent identifier
-
----
-
-### getPaymentInstrument
-
-**Signature:** `getPaymentInstrument(basket : Basket) : OrderPaymentInstrument`
-
-**Description:** Returns the payment instrument for this payment intent in the given basket, or null if the given basket has none.
-
-**Parameters:**
-
-- `basket`: basket
-
-**Returns:**
-
-basket payment instrument
-
----
-
-### getPaymentInstrument
-
-**Signature:** `getPaymentInstrument(order : Order) : OrderPaymentInstrument`
-
-**Description:** Returns the payment instrument for this payment intent in the given order, or null if the given order has none.
-
-**Parameters:**
-
-- `order`: order
-
-**Returns:**
-
-order payment instrument
-
----
-
-### getPaymentMethod
-
-**Signature:** `getPaymentMethod() : SalesforcePaymentMethod`
-
-**Description:** Returns the payment method for this payment intent, or null if none has been established.
-
-**Returns:**
-
-payment method
-
----
-
-### getSetupFutureUsage
-
-**Signature:** `getSetupFutureUsage() : String`
-
-**Description:** Returns SETUP_FUTURE_USAGE_OFF_SESSION or SETUP_FUTURE_USAGE_ON_SESSION to indicate how the payment intent can be used in the future or returns null if future usage is not set up.
-
-**Returns:**
-
-setup future usage or null if future usage is not set up
-
-**See Also:**
-
-SalesforcePaymentRequest.setSetupFutureUsage(Boolean)
-SETUP_FUTURE_USAGE_OFF_SESSION
-SETUP_FUTURE_USAGE_ON_SESSION
-
----
-
-### isCancelable
-
-**Signature:** `isCancelable() : boolean`
-
-**Description:** Returns true if this payment intent has a status which indicates it can be canceled, or false if its status does not indicate it can be canceled.
-
-**Returns:**
-
-true if this payment intent has a status which indicates it can be canceled
-
----
-
-### isConfirmed
-
-**Signature:** `isConfirmed() : boolean`
-
-**Description:** Returns true if this payment intent has been confirmed, or false if not.
-
-**Returns:**
-
-true if this payment intent has been confirmed
-
----
-
-### isRefundable
-
-**Signature:** `isRefundable() : boolean`
-
-**Description:** Returns true if this payment intent has a status and other state which indicate it can be refunded, or false if it cannot be refunded.
-
-**Returns:**
-
-true if this payment intent has a status and other state which indicate it can be refunded
-
----

package/docs/dw_extensions.payments/SalesforcePaymentMethod.md

@@ -1,346 +0,0 @@
-## Package: dw.extensions.payments
-
-# Class SalesforcePaymentMethod
-
-## Inheritance Hierarchy
-
-- Object
-  - dw.extensions.payments.SalesforcePaymentMethod
-
-## Description
-
-Salesforce Payments representation of a payment method object. See Salesforce Payments documentation for how to gain access and configure it for use on your sites. A 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_AFTERPAY_CLEARPAY
-
-**Type:** String = "afterpay_clearpay"
-
-Represents the Afterpay Clearpay payment method.
-
-### TYPE_BANCONTACT
-
-**Type:** String = "bancontact"
-
-Represents the Bancontact payment method.
-
-### TYPE_CARD
-
-**Type:** String = "card"
-
-Represents a credit card type of payment method.
-
-### TYPE_EPS
-
-**Type:** String = "eps"
-
-Represents the EPS (Electronic Payment Standard) payment method.
-
-### TYPE_IDEAL
-
-**Type:** String = "ideal"
-
-Represents the iDEAL payment method.
-
-### TYPE_KLARNA
-
-**Type:** String = "klarna"
-
-Represents the Klarna payment method.
-
-### TYPE_SEPA_DEBIT
-
-**Type:** String = "sepa_debit"
-
-Represents the SEPA Debit payment method.
-
-## Properties
-
-### bank
-
-**Type:** String (Read Only)
-
-The bank of this payment method, or null if none is available. Available on
- TYPE_IDEAL and TYPE_EPS type methods.
-
-### bankCode
-
-**Type:** String (Read Only)
-
-The bank code of this payment method, or null if none is available. Available on
- TYPE_SEPA_DEBIT and TYPE_BANCONTACT type methods.
-
-### bankName
-
-**Type:** String (Read Only)
-
-The bank name of this payment method, or null if none is available. Available on
- TYPE_BANCONTACT type methods.
-
-### branchCode
-
-**Type:** String (Read Only)
-
-The bank branch code of this payment method, or null if none is available. Available on
- TYPE_SEPA_DEBIT type methods.
-
-### brand
-
-**Type:** String (Read Only)
-
-The brand of this payment method, or null if none is available. Available on
- TYPE_CARD type methods.
-
-### country
-
-**Type:** String (Read Only)
-
-The country of this payment method, or null if none is available. Available on
- TYPE_SEPA_DEBIT 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, TYPE_SEPA_DEBIT, and
- TYPE_BANCONTACT type methods.
-
-### paymentMethodCategory
-
-**Type:** String (Read Only)
-
-The payment method category of this payment method, or null if none is available. Available
- on TYPE_KLARNA type methods.
-
-### type
-
-**Type:** String (Read Only)
-
-The type of this payment method.
-
-## Constructor Summary
-
-## Method Summary
-
-### getBank
-
-**Signature:** `getBank() : String`
-
-Returns the bank of this payment method, or null if none is available.
-
-### getBankCode
-
-**Signature:** `getBankCode() : String`
-
-Returns the bank code of this payment method, or null if none is available.
-
-### getBankName
-
-**Signature:** `getBankName() : String`
-
-Returns the bank name of this payment method, or null if none is available.
-
-### getBranchCode
-
-**Signature:** `getBranchCode() : String`
-
-Returns the bank branch code of this payment method, or null if none is available.
-
-### getBrand
-
-**Signature:** `getBrand() : String`
-
-Returns the brand of this payment method, or null if none is available.
-
-### getCountry
-
-**Signature:** `getCountry() : String`
-
-Returns the country of 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.
-
-### getPaymentDetails
-
-**Signature:** `getPaymentDetails(paymentInstrument : OrderPaymentInstrument) : SalesforcePaymentDetails`
-
-Returns the details to the Salesforce Payments payment for this payment method, using the given payment instrument.
-
-### getPaymentMethodCategory
-
-**Signature:** `getPaymentMethodCategory() : String`
-
-Returns the payment method category of this payment method, or null if none is available.
-
-### getType
-
-**Signature:** `getType() : String`
-
-Returns the type of this payment method.
-
-## Method Detail
-
-## Method Details
-
-### getBank
-
-**Signature:** `getBank() : String`
-
-**Description:** Returns the bank of this payment method, or null if none is available. Available on TYPE_IDEAL and TYPE_EPS type methods.
-
-**Returns:**
-
-payment method bank
-
----
-
-### getBankCode
-
-**Signature:** `getBankCode() : String`
-
-**Description:** Returns the bank code of this payment method, or null if none is available. Available on TYPE_SEPA_DEBIT and TYPE_BANCONTACT type methods.
-
-**Returns:**
-
-payment method bank code
-
----
-
-### getBankName
-
-**Signature:** `getBankName() : String`
-
-**Description:** Returns the bank name of this payment method, or null if none is available. Available on TYPE_BANCONTACT type methods.
-
-**Returns:**
-
-payment method bank name
-
----
-
-### getBranchCode
-
-**Signature:** `getBranchCode() : String`
-
-**Description:** Returns the bank branch code of this payment method, or null if none is available. Available on TYPE_SEPA_DEBIT type methods.
-
-**Returns:**
-
-payment method bank branch code
-
----
-
-### 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
-
----
-
-### getCountry
-
-**Signature:** `getCountry() : String`
-
-**Description:** Returns the country of this payment method, or null if none is available. Available on TYPE_SEPA_DEBIT type methods.
-
-**Returns:**
-
-payment method country
-
----
-
-### 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, TYPE_SEPA_DEBIT, and TYPE_BANCONTACT type methods.
-
-**Returns:**
-
-payment method credential last 4 digits
-
----
-
-### getPaymentDetails
-
-**Signature:** `getPaymentDetails(paymentInstrument : OrderPaymentInstrument) : SalesforcePaymentDetails`
-
-**Description:** Returns the details to the Salesforce Payments payment for this payment method, using the given payment instrument.
-
-**Parameters:**
-
-- `paymentInstrument`: payment instrument
-
-**Returns:**
-
-The payment details
-
----
-
-### getPaymentMethodCategory
-
-**Signature:** `getPaymentMethodCategory() : String`
-
-**Description:** Returns the payment method category of this payment method, or null if none is available. Available on TYPE_KLARNA type methods.
-
-**Returns:**
-
-payment method category
-
----
-
-### getType
-
-**Signature:** `getType() : String`
-
-**Description:** Returns the type of this payment method.
-
-**Returns:**
-
-payment method type
-
-**See Also:**
-
-TYPE_BANCONTACT
-TYPE_CARD
-TYPE_EPS
-TYPE_AFTERPAY_CLEARPAY
-TYPE_IDEAL
-TYPE_SEPA_DEBIT
-
----