@medusajs/types 1.12.0-snapshot-20240405070935 → 1.12.0-snapshot-20240405154416

package/dist/payment/mutations.d.ts

@@ -9,7 +9,7 @@ export interface CreatePaymentCollectionDTO {
      */
     region_id: string;
     /**
-     * The currency code of the payment collection.
+     * The ISO 3 character currency code of the payment collection.
      */
     currency_code: string;
     /**
@@ -30,20 +30,50 @@ export interface UpdatePaymentCollectionDTO extends Partial<CreatePaymentCollect
      */
     id: string;
 }
+/**
+ * The attributes in the payment collection to be created or updated.
+ */
 export interface UpsertPaymentCollectionDTO {
+    /**
+     * The ID of the payment collection.
+     */
     id?: string;
+    /**
+     * The associated region's ID.
+     */
     region_id?: string;
+    /**
+     * The ISO 3 character currency code of the payment collection.
+     */
     currency_code?: string;
+    /**
+     * The amount of the payment collection.
+     */
     amount?: number;
+    /**
+     * Holds custom data in key-value pairs.
+     */
     metadata?: Record<string, unknown>;
 }
 /**
  * The attributes to update in the payment collection.
  */
 export interface PaymentCollectionUpdatableFields {
+    /**
+     * The associated region's ID.
+     */
     region_id?: string;
+    /**
+     * {The ISO 3 character currency code of the payment collection.
+     */
     currency_code?: string;
+    /**
+     * The amount of the payment collection.
+     */
     amount?: number;
+    /**
+     * Holds custom data in key-value pairs.
+     */
     metadata?: Record<string, unknown>;
 }
 /**
@@ -55,7 +85,7 @@ export interface CreatePaymentDTO {
      */
     amount: number;
     /**
-     * The currency code of the payment.
+     * The ISO 3 character currency code of the payment.
      */
     currency_code: string;
     /**
@@ -63,11 +93,11 @@ export interface CreatePaymentDTO {
      */
     provider_id: string;
     /**
-     * The data of the payment.
+     * The data necessary for the associated payment provider to process the payment.
      */
     data: Record<string, unknown>;
     /**
-     * The associated payment session's ID.
+     * The ID of the payment session this payment was created from.
      */
     payment_session_id: string;
     /**
@@ -129,7 +159,8 @@ export interface CreateCaptureDTO {
      */
     payment_id: string;
     /**
-     * The captured by of the capture.
+     * Who captured the payment. For example,
+     * a user's ID.
      */
     captured_by?: string;
 }
@@ -146,7 +177,8 @@ export interface CreateRefundDTO {
      */
     payment_id: string;
     /**
-     * The created by of the refund.
+     * Who refunded the payment. For example,
+     * a user's ID.
      */
     created_by?: string;
 }
@@ -159,19 +191,19 @@ export interface CreatePaymentSessionDTO {
      */
     provider_id: string;
     /**
-     * The selected currency code.
+     * The ISO 3 character currency code of the payment session.
      */
     currency_code: string;
     /**
-     * The payment's amount.
+     * The amount to be authorized.
      */
     amount: number;
     /**
-     * The value of the payment session's `data` field.
+     * Necessary data for the associated payment provider to process the payment.
      */
     data: Record<string, unknown>;
     /**
-     * The payment session's context.
+     * Necessary context data for the associated payment provider.
      */
     context?: PaymentProviderContext;
 }
@@ -184,19 +216,19 @@ export interface UpdatePaymentSessionDTO {
      */
     id: string;
     /**
-     * The value of the payment session's `data` field.
+     * Necessary data for the associated payment provider to process the payment.
      */
     data: Record<string, unknown>;
     /**
-     * The selected currency code.
+     * The ISO 3 character currency code.
      */
     currency_code: string;
     /**
-     * The payment's amount.
+     * The amount to be authorized.
      */
     amount: number;
     /**
-     * The payment session's context.
+     * Necessary context data for the associated payment provider.
      */
     context?: PaymentProviderContext;
 }
@@ -214,19 +246,28 @@ export interface CreatePaymentProviderDTO {
     is_enabled?: boolean;
 }
 /**
- * Webhook
+ * The details of the webhook event payload.
  */
 export interface ProviderWebhookPayload {
+    /**
+     * The ID of the provider to pass the webhook event payload to.
+     */
     provider: string;
+    /**
+     * The webhook event payload passed to the specified provider.
+     */
     payload: {
         /**
-         * Parsed webhook body
+         * The parsed webhook body.
          */
         data: Record<string, unknown>;
         /**
-         * Raw request body
+         * The raw webhook request body.
          */
         rawData: string | Buffer;
+        /**
+         * The headers of the webhook request.
+         */
         headers: Record<string, unknown>;
     };
 }

package/dist/payment/mutations.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"mutations.d.ts","sourceRoot":"","sources":["../../src/payment/mutations.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,sBAAsB,EAAE,MAAM,YAAY,CAAA;AAEnD;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAA;IAEjB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAA;IAErB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAA;IAEd;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACnC;AAED;;GAEG;AACH,MAAM,WAAW,0BACf,SAAQ,OAAO,CAAC,0BAA0B,CAAC;IAC3C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;CACX;AAED,MAAM,WAAW,0BAA0B;IACzC,EAAE,CAAC,EAAE,MAAM,CAAA;IACX,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACnC;AAED;;GAEG;AACH,MAAM,WAAW,gCAAgC;IAC/C,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACnC;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAA;IAEd;;OAEG;IACH,aAAa,EAAE,MAAM,CAAA;IAErB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;IAEnB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAE7B;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAA;IAE1B;;OAEG;IACH,qBAAqB,EAAE,MAAM,CAAA;IAE7B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAEhB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IAEjB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IAEtB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAEhB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IAEjB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IAEtB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IAEf;;OAEG;IACH,UAAU,EAAE,MAAM,CAAA;IAElB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IAEf;;OAEG;IACH,UAAU,EAAE,MAAM,CAAA;IAElB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;IACnB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAA;IACrB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAA;IACd;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAC7B;;OAEG;IACH,OAAO,CAAC,EAAE,sBAAsB,CAAA;CACjC;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IACV;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAC7B;;OAEG;IACH,aAAa,EAAE,MAAM,CAAA;IACrB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAA;IACd;;OAEG;IACH,OAAO,CAAC,EAAE,sBAAsB,CAAA;CACjC;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IACV;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAA;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,EAAE;QACP;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;QAC7B;;WAEG;QACH,OAAO,EAAE,MAAM,GAAG,MAAM,CAAA;QACxB,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;KACjC,CAAA;CACF"}
+{"version":3,"file":"mutations.d.ts","sourceRoot":"","sources":["../../src/payment/mutations.ts"],"names":[],"mappings":";AAAA,OAAO,EAAE,sBAAsB,EAAE,MAAM,YAAY,CAAA;AAEnD;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,SAAS,EAAE,MAAM,CAAA;IAEjB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAA;IAErB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAA;IAEd;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACnC;AAED;;GAEG;AACH,MAAM,WAAW,0BACf,SAAQ,OAAO,CAAC,0BAA0B,CAAC;IAC3C;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;CACX;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,EAAE,CAAC,EAAE,MAAM,CAAA;IAEX;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAElB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IAEtB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IAEf;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACnC;AAED;;GAEG;AACH,MAAM,WAAW,gCAAgC;IAC/C;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAElB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IAEtB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IAEf;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CACnC;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAA;IAEd;;OAEG;IACH,aAAa,EAAE,MAAM,CAAA;IAErB;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;IAEnB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAE7B;;OAEG;IACH,kBAAkB,EAAE,MAAM,CAAA;IAE1B;;OAEG;IACH,qBAAqB,EAAE,MAAM,CAAA;IAE7B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAEhB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IAEjB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IAEtB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAEhB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAA;IAEjB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IAEtB;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IAEf;;OAEG;IACH,UAAU,EAAE,MAAM,CAAA;IAElB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAA;IAEf;;OAEG;IACH,UAAU,EAAE,MAAM,CAAA;IAElB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;IAEnB;;OAEG;IACH,aAAa,EAAE,MAAM,CAAA;IAErB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAA;IAEd;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAE7B;;OAEG;IACH,OAAO,CAAC,EAAE,sBAAsB,CAAA;CACjC;AAED;;GAEG;AACH,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAE7B;;OAEG;IACH,aAAa,EAAE,MAAM,CAAA;IAErB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAA;IAEd;;OAEG;IACH,OAAO,CAAC,EAAE,sBAAsB,CAAA;CACjC;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAA;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAEhB;;OAEG;IACH,OAAO,EAAE;QACP;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;QAE7B;;WAEG;QACH,OAAO,EAAE,MAAM,GAAG,MAAM,CAAA;QAExB;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;KACjC,CAAA;CACF"}

package/dist/payment/provider.d.ts

@@ -2,7 +2,13 @@ import { AddressDTO } from "../address";
 import { CustomerDTO } from "../customer";
 import { PaymentSessionStatus } from "./common";
 import { ProviderWebhookPayload } from "./mutations";
+/**
+ * The address of the payment.
+ */
 export type PaymentAddressDTO = Partial<AddressDTO>;
+/**
+ * The customer associated with the payment.
+ */
 export type PaymentCustomerDTO = Partial<CustomerDTO>;
 /**
  * Normalized events from payment provider to internal payment module events.
@@ -28,7 +34,7 @@ export declare enum PaymentActions {
 /**
  * @interface
  *
- * A payment's context.
+ * Context data provided to the payment provider when authorizing a payment session.
  */
 export type PaymentProviderContext = {
     /**
@@ -36,11 +42,11 @@ export type PaymentProviderContext = {
      */
     billing_address?: PaymentAddressDTO;
     /**
-     * The customer's email.
+     * The associated customer's email.
      */
     email?: string;
     /**
-     * The ID of the resource the payment is associated with i.e. the ID of the PaymentSession in Medusa
+     * The ID of the resource the payment is associated with. For example, the ID of the payment session.
      */
     resource_id?: string;
     /**
@@ -52,15 +58,47 @@ export type PaymentProviderContext = {
      */
     extra?: Record<string, unknown>;
 };
+/**
+ * @interface
+ *
+ * The data used initiate a payment in a provider when a payment
+ * session is created.
+ */
 export type CreatePaymentProviderSession = {
+    /**
+     * A context necessary for the payment provider.
+     */
     context: PaymentProviderContext;
+    /**
+     * The amount to be authorized.
+     */
     amount: number;
+    /**
+     * The ISO 3 character currency code.
+     */
     currency_code: string;
 };
+/**
+ * @interface
+ *
+ * The attributes to update a payment related to a payment session in a provider.
+ */
 export type UpdatePaymentProviderSession = {
+    /**
+     * A payment's context.
+     */
     context: PaymentProviderContext;
+    /**
+     * The `data` field of the payment session.
+     */
     data: Record<string, unknown>;
+    /**
+     * The payment session's amount.
+     */
     amount: number;
+    /**
+     * The ISO 3 character code of the payment session.
+     */
     currency_code: string;
 };
 /**
@@ -75,6 +113,11 @@ export type PaymentProviderSessionResponse = {
      */
     data: Record<string, unknown>;
 };
+/**
+ * @interface
+ *
+ * The successful result of authorizing a payment session using a payment provider.
+ */
 export type PaymentProviderAuthorizeResponse = {
     /**
      * The status of the payment, which will be stored in the payment session's `status` field.
@@ -85,8 +128,20 @@ export type PaymentProviderAuthorizeResponse = {
      */
     data: PaymentProviderSessionResponse["data"];
 };
+/**
+ * @interface
+ *
+ * The details of which payment provider to use to perform an action, and what
+ * data to be passed to that provider.
+ */
 export type PaymentProviderDataInput = {
+    /**
+     * The ID of the provider to be used to perform an action.
+     */
     provider_id: string;
+    /**
+     * The data to be passed to the provider.
+     */
     data: Record<string, unknown>;
 };
 /**
@@ -106,14 +161,40 @@ export interface PaymentProviderError {
      */
     detail?: any;
 }
+/**
+ * @interface
+ *
+ * The details of an action to be performed as a result of a received webhook event.
+ */
 export type WebhookActionData = {
+    /**
+     * The associated resource's ID. For example,
+     * a payment session's ID.
+     */
     resource_id: string;
+    /**
+     * The amount to be captured or authorized (based on the action's type.)
+     */
     amount: number;
 };
+/**
+ * @interface
+ *
+ * The actions that the payment provider informs the Payment Module to perform.
+ */
 export type WebhookActionResult = {
+    /**
+     * Received an event that is not processable.
+     */
     action: PaymentActions.NOT_SUPPORTED;
 } | {
+    /**
+     * Normalized events from payment provider to internal payment module events.
+     */
     action: PaymentActions;
+    /**
+     * The webhook action's details.
+     */
     data: WebhookActionData;
 };
 export interface IPaymentProvider {
@@ -124,96 +205,100 @@ export interface IPaymentProvider {
      */
     getIdentifier(): string;
     /**
-     * Make calls to the third-party provider to initialize the payment. For example, in Stripe this method is used to create a Payment Intent for the customer.
+     * This methods sends a request to the third-party provider to initialize the payment. It's called when the payment session is created.
+     *
+     * For example, in the Stripe provider, this method is used to create a Payment Intent for the customer.
      *
-     * @param {CreatePaymentProviderSession} context
-     * @returns {Promise<PaymentProviderError | PaymentProviderSessionResponse>} Either the payment's data or an error object.
+     * @param {CreatePaymentProviderSession} data - The data necessary to initiate the payment.
+     * @returns {Promise<PaymentProviderError | PaymentProviderSessionResponse>} Either the payment's data, which is stored in the `data` field
+     * of the payment session, or an error object.
      */
     initiatePayment(data: CreatePaymentProviderSession): Promise<PaymentProviderError | PaymentProviderSessionResponse>;
     /**
-     * This method is used to update the payment session.
+     * This method is used to update a payment associated with a session in the third-party provider.
      *
-     * @param {UpdatePaymentProviderSession} context
+     * @param {UpdatePaymentProviderSession} context - The data related to the update.
      * @returns {Promise<PaymentProviderError | PaymentProviderSessionResponse | void>} Either the payment's data or an error object.
      */
     updatePayment(context: UpdatePaymentProviderSession): Promise<PaymentProviderError | PaymentProviderSessionResponse>;
     /**
-     * This method is used to perform any actions necessary before a Payment Session is deleted. The Payment Session is deleted in one of the following cases:
+     * This method is called before a payment session is deleted. It's used to perform any actions necessary before the deletion.
      *
      * @param {Record<string, unknown>} paymentSessionData - The `data` field of the Payment Session.
-     * @returns Either an error object or an empty object.
+     * @returns {Promise<PaymentProviderError | PaymentProviderSessionResponse["data"]>} Either an error object or an empty object.
      */
     deletePayment(paymentSessionData: Record<string, unknown>): Promise<PaymentProviderError | PaymentProviderSessionResponse["data"]>;
     /**
-     * This method is used to authorize payment using the Payment Session.
-     * You can interact with a third-party provider and perform any actions necessary to authorize the payment.
-     *
-     * The payment authorization might require additional action from the customer before it is declared authorized. Once that additional action is performed,
-     * the `authorizePayment` method will be called again to validate that the payment is now fully authorized. So, make sure to implement it for this case as well, if necessary.
-     *
-     * :::note
+     * This method is called when a payment session should be authorized.
+     * You can interact with a third-party provider and perform the necessary actions to authorize the payment.
      *
-     * The payment authorization status is determined using the {@link getPaymentStatus} method. If the status is `requires_more`, then it means additional actions are required
-     * from the customer.
-     *
-     * :::
+     * Refer to [this guide](https://docs.medusajs.com/experimental/payment/payment-flow/#3-authorize-payment-session)
+     * to learn more about how this fits into the payment flow and how to handle required actions.
      *
      * @param {Record<string, unknown>} paymentSessionData - The `data` field of the payment session.
      * @param {Record<string, unknown>} context - The context of the authorization.
-     * @returns The authorization details or an error object.
+     * @returns {Promise<PaymentProviderError | PaymentProviderAuthorizeResponse>} The authorization details or an error object. If
+     * the authorization details are returned, the `data` and `status` field are set in the associated payment session.
      */
     authorizePayment(paymentSessionData: Record<string, unknown>, context: Record<string, unknown>): Promise<PaymentProviderError | PaymentProviderAuthorizeResponse>;
     /**
-     * This method is used to capture the payment amount. This is typically triggered manually by the store operator from the admin.
+     * This method is called when a payment should be captured. The payment is captured in one of the following scenarios:
+     *
+     * - The payment provider supports automatically capturing the payment after authorization.
+     * - The merchant requests to capture the payment after its associated payment session was authorized.
+     * - A webhook event occurred that instructs the payment provider to capture the payment session. Learn more about handing webhook events in [this guide](https://docs.medusajs.com/experimental/payment/webhook-events/)
      *
-     * You can utilize this method to interact with the third-party provider and perform any actions necessary to capture the payment.
+     * In this method, you can interact with the third-party provider and perform any actions necessary to capture the payment.
      *
-     * @param {Record<string, unknown>} paymentSessionData - The `data` field of the Payment for its first parameter.
-     * @returns Either an error object or a value that's stored in the `data` field of the Payment.
+     * @param {Record<string, unknown>} paymentSessionData - The `data` field of the payment.
+     * @returns {Promise<PaymentProviderError | PaymentProviderSessionResponse["data"]>} Either an error object or a value that's stored in the `data` field of the payment.
      */
     capturePayment(paymentSessionData: Record<string, unknown>): Promise<PaymentProviderError | PaymentProviderSessionResponse["data"]>;
     /**
-     * This method is used to refund a payment. This is typically triggered manually by the store operator from the admin. The refund amount might be the total amount or part of it.
+     * This method is called when a payment should be refunded. This is typically triggered manually by the merchant.
      *
-     * You can utilize this method to interact with the third-party provider and perform any actions necessary to refund the payment.
+     * In this method, you can interact with the third-party provider and perform any actions necessary to refund the payment.
      *
      * @param {Record<string, unknown>} paymentSessionData - The `data` field of a Payment.
-     * @param {number} refundAmount - the amount to refund.
-     * @returns Either an error object or a value that's stored in the `data` field of the Payment.
+     * @param {number} refundAmount - The amount to refund.
+     * @returns {Promise<PaymentProviderError | PaymentProviderSessionResponse["data"]>} Either an error object or an object that's stored in the `data` field of the payment.
      */
     refundPayment(paymentSessionData: Record<string, unknown>, refundAmount: number): Promise<PaymentProviderError | PaymentProviderSessionResponse["data"]>;
     /**
      * This method is used to provide a uniform way of retrieving the payment information from the third-party provider.
-     * For example, in Stripe’s Payment Provider this method is used to retrieve the payment intent details from Stripe.
+     *
+     * For example, in Stripe’s payment provider this method is used to retrieve the payment intent details from Stripe.
      *
      * @param {Record<string, unknown>} paymentSessionData -
-     * The `data` field of a Payment Session. Make sure to store in the `data` field any necessary data that would allow you to retrieve the payment data from the third-party provider.
-     * @returns {Promise<PaymentProviderError | PaymentProviderSessionResponse["session_data"]>} The payment's data, typically retrieved from a third-party provider.
+     * The `data` field of a payment session. Make sure to store in the `data` field any necessary data that would allow you to retrieve the payment data from the third-party provider.
+     * @returns {Promise<PaymentProviderError | PaymentProviderSessionResponse["session_data"]>} Either an error object or the payment's data retrieved from a third-party provider.
      */
     retrievePayment(paymentSessionData: Record<string, unknown>): Promise<PaymentProviderError | PaymentProviderSessionResponse["data"]>;
     /**
-     * This method is used to cancel a payment. This method is typically triggered by one of the following situations:
+     * This method is called when a payment is canceled.
      *
-     * You can utilize this method to interact with the third-party provider and perform any actions necessary to cancel the payment.
+     * In this method, you can interact with the third-party provider and perform any actions necessary to cancel the payment.
      *
-     * @param {Record<string, unknown>} paymentSessionData - The `data` field of the Payment.
-     * @returns Either an error object or a value that's stored in the `data` field of the Payment.
+     * @param {Record<string, unknown>} paymentSessionData - The `data` field of the payment.
+     * @returns {Promise<PaymentProviderError | PaymentProviderSessionResponse["data"]>} Either an error object or a value that's stored in the `data` field of the payment.
      */
     cancelPayment(paymentSessionData: Record<string, unknown>): Promise<PaymentProviderError | PaymentProviderSessionResponse["data"]>;
     /**
-     * This method is used to get the status of a Payment or a Payment Session.
+     * This method is used to get the status of a payment or a payment session.
      *
      * @param {Record<string, unknown>} paymentSessionData -
-     * The `data` field of a Payment as a parameter. You can use this data to interact with the third-party provider to check the status of the payment if necessary.
-     * @returns {Promise<PaymentSessionStatus>} The status of the Payment or Payment Session.
+     * The `data` field of a payment as a parameter. You can use this data to interact with the third-party provider to check the status of the payment if necessary.
+     * @returns {Promise<PaymentSessionStatus>} The status of the payment or payment session.
      */
     getPaymentStatus(paymentSessionData: Record<string, unknown>): Promise<PaymentSessionStatus>;
     /**
-     * The method is called when å webhook call for this particular provider is received.
+     * The method is called when a webhook event is received for this provider.
+     *
+     * The method is responsible for normalizing the received event and inform the Payment Module of actions to perform, such as authorize or capture payment.
      *
-     * The method is responsible for normalizing the received event and provide
+     * Learn more about handling webhook events in [this guide](https://docs.medusajs.com/experimental/payment/webhook-events/)
      *
-     * @param data - object containing provider id and data from the provider
+     * @param data - The webhook event's details.
      */
     getWebhookActionAndData(data: ProviderWebhookPayload["payload"]): Promise<WebhookActionResult>;
 }

package/dist/payment/provider.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"provider.d.ts","sourceRoot":"","sources":["../../src/payment/provider.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,YAAY,CAAA;AACvC,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAA;AACzC,OAAO,EAAE,oBAAoB,EAAE,MAAM,UAAU,CAAA;AAC/C,OAAO,EAAE,sBAAsB,EAAE,MAAM,aAAa,CAAA;AAEpD,MAAM,MAAM,iBAAiB,GAAG,OAAO,CAAC,UAAU,CAAC,CAAA;AAEnD,MAAM,MAAM,kBAAkB,GAAG,OAAO,CAAC,WAAW,CAAC,CAAA;AAErD;;GAEG;AACH,oBAAY,cAAc;IACxB;;OAEG;IACH,UAAU,eAAe;IACzB;;OAEG;IACH,UAAU,aAAa;IACvB;;OAEG;IACH,MAAM,WAAW;IACjB;;OAEG;IACH,aAAa,kBAAkB;CAChC;AAED;;;;GAIG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC;;OAEG;IACH,eAAe,CAAC,EAAE,iBAAiB,CAAA;IACnC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IACd;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB;;OAEG;IACH,QAAQ,CAAC,EAAE,kBAAkB,CAAA;IAC7B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAChC,CAAA;AAED,MAAM,MAAM,4BAA4B,GAAG;IACzC,OAAO,EAAE,sBAAsB,CAAA;IAC/B,MAAM,EAAE,MAAM,CAAA;IACd,aAAa,EAAE,MAAM,CAAA;CACtB,CAAA;AAED,MAAM,MAAM,4BAA4B,GAAG;IACzC,OAAO,EAAE,sBAAsB,CAAA;IAC/B,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAC7B,MAAM,EAAE,MAAM,CAAA;IACd,aAAa,EAAE,MAAM,CAAA;CACtB,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,8BAA8B,GAAG;IAC3C;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAC9B,CAAA;AAED,MAAM,MAAM,gCAAgC,GAAG;IAC7C;;OAEG;IACH,MAAM,EAAE,oBAAoB,CAAA;IAC5B;;OAEG;IACH,IAAI,EAAE,8BAA8B,CAAC,MAAM,CAAC,CAAA;CAC7C,CAAA;AAED,MAAM,MAAM,wBAAwB,GAAG;IACrC,WAAW,EAAE,MAAM,CAAA;IACnB,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAC9B,CAAA;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IACb;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IACb;;OAEG;IACH,MAAM,CAAC,EAAE,GAAG,CAAA;CACb;AAED,MAAM,MAAM,iBAAiB,GAAG;IAC9B,WAAW,EAAE,MAAM,CAAA;IACnB,MAAM,EAAE,MAAM,CAAA;CACf,CAAA;AAED,MAAM,MAAM,mBAAmB,GAC3B;IACE,MAAM,EAAE,cAAc,CAAC,aAAa,CAAA;CACrC,GACD;IACE,MAAM,EAAE,cAAc,CAAA;IACtB,IAAI,EAAE,iBAAiB,CAAA;CACxB,CAAA;AAEL,MAAM,WAAW,gBAAgB;IAC/B;;;;OAIG;IACH,aAAa,IAAI,MAAM,CAAA;IAEvB;;;;;OAKG;IACH,eAAe,CACb,IAAI,EAAE,4BAA4B,GACjC,OAAO,CAAC,oBAAoB,GAAG,8BAA8B,CAAC,CAAA;IAEjE;;;;;OAKG;IACH,aAAa,CACX,OAAO,EAAE,4BAA4B,GACpC,OAAO,CAAC,oBAAoB,GAAG,8BAA8B,CAAC,CAAA;IAEjE;;;;;OAKG;IACH,aAAa,CACX,kBAAkB,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC1C,OAAO,CAAC,oBAAoB,GAAG,8BAA8B,CAAC,MAAM,CAAC,CAAC,CAAA;IAEzE;;;;;;;;;;;;;;;;;OAiBG;IACH,gBAAgB,CACd,kBAAkB,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC3C,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC/B,OAAO,CAAC,oBAAoB,GAAG,gCAAgC,CAAC,CAAA;IAEnE;;;;;;;OAOG;IACH,cAAc,CACZ,kBAAkB,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC1C,OAAO,CAAC,oBAAoB,GAAG,8BAA8B,CAAC,MAAM,CAAC,CAAC,CAAA;IAEzE;;;;;;;;OAQG;IACH,aAAa,CACX,kBAAkB,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC3C,YAAY,EAAE,MAAM,GACnB,OAAO,CAAC,oBAAoB,GAAG,8BAA8B,CAAC,MAAM,CAAC,CAAC,CAAA;IAEzE;;;;;;;OAOG;IACH,eAAe,CACb,kBAAkB,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC1C,OAAO,CAAC,oBAAoB,GAAG,8BAA8B,CAAC,MAAM,CAAC,CAAC,CAAA;IAEzE;;;;;;;OAOG;IACH,aAAa,CACX,kBAAkB,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC1C,OAAO,CAAC,oBAAoB,GAAG,8BAA8B,CAAC,MAAM,CAAC,CAAC,CAAA;IAEzE;;;;;;OAMG;IACH,gBAAgB,CACd,kBAAkB,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC1C,OAAO,CAAC,oBAAoB,CAAC,CAAA;IAEhC;;;;;;OAMG;IACH,uBAAuB,CACrB,IAAI,EAAE,sBAAsB,CAAC,SAAS,CAAC,GACtC,OAAO,CAAC,mBAAmB,CAAC,CAAA;CAChC"}
+{"version":3,"file":"provider.d.ts","sourceRoot":"","sources":["../../src/payment/provider.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,YAAY,CAAA;AACvC,OAAO,EAAE,WAAW,EAAE,MAAM,aAAa,CAAA;AACzC,OAAO,EAAE,oBAAoB,EAAE,MAAM,UAAU,CAAA;AAC/C,OAAO,EAAE,sBAAsB,EAAE,MAAM,aAAa,CAAA;AAEpD;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG,OAAO,CAAC,UAAU,CAAC,CAAA;AAEnD;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG,OAAO,CAAC,WAAW,CAAC,CAAA;AAErD;;GAEG;AACH,oBAAY,cAAc;IACxB;;OAEG;IACH,UAAU,eAAe;IAEzB;;OAEG;IACH,UAAU,aAAa;IAEvB;;OAEG;IACH,MAAM,WAAW;IAEjB;;OAEG;IACH,aAAa,kBAAkB;CAChC;AAED;;;;GAIG;AACH,MAAM,MAAM,sBAAsB,GAAG;IACnC;;OAEG;IACH,eAAe,CAAC,EAAE,iBAAiB,CAAA;IAEnC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;IAEd;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAA;IAEpB;;OAEG;IACH,QAAQ,CAAC,EAAE,kBAAkB,CAAA;IAE7B;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAChC,CAAA;AAED;;;;;GAKG;AACH,MAAM,MAAM,4BAA4B,GAAG;IACzC;;OAEG;IACH,OAAO,EAAE,sBAAsB,CAAA;IAE/B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAA;IAEd;;OAEG;IACH,aAAa,EAAE,MAAM,CAAA;CACtB,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,4BAA4B,GAAG;IACzC;;OAEG;IACH,OAAO,EAAE,sBAAsB,CAAA;IAE/B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IAE7B;;OAEG;IACH,MAAM,EAAE,MAAM,CAAA;IAEd;;OAEG;IACH,aAAa,EAAE,MAAM,CAAA;CACtB,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,8BAA8B,GAAG;IAC3C;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAC9B,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,gCAAgC,GAAG;IAC7C;;OAEG;IACH,MAAM,EAAE,oBAAoB,CAAA;IAE5B;;OAEG;IACH,IAAI,EAAE,8BAA8B,CAAC,MAAM,CAAC,CAAA;CAC7C,CAAA;AAED;;;;;GAKG;AACH,MAAM,MAAM,wBAAwB,GAAG;IACrC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAA;IAEnB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;CAC9B,CAAA;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,KAAK,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,MAAM,CAAC,EAAE,GAAG,CAAA;CACb;AAED;;;;GAIG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC9B;;;OAGG;IACH,WAAW,EAAE,MAAM,CAAA;IAEnB;;OAEG;IACH,MAAM,EAAE,MAAM,CAAA;CACf,CAAA;AAED;;;;GAIG;AACH,MAAM,MAAM,mBAAmB,GAC3B;IACE;;OAEG;IACH,MAAM,EAAE,cAAc,CAAC,aAAa,CAAA;CACrC,GACD;IACE;;OAEG;IACH,MAAM,EAAE,cAAc,CAAA;IAEtB;;OAEG;IACH,IAAI,EAAE,iBAAiB,CAAA;CACxB,CAAA;AAEL,MAAM,WAAW,gBAAgB;IAC/B;;;;OAIG;IACH,aAAa,IAAI,MAAM,CAAA;IAEvB;;;;;;;;OAQG;IACH,eAAe,CACb,IAAI,EAAE,4BAA4B,GACjC,OAAO,CAAC,oBAAoB,GAAG,8BAA8B,CAAC,CAAA;IAEjE;;;;;OAKG;IACH,aAAa,CACX,OAAO,EAAE,4BAA4B,GACpC,OAAO,CAAC,oBAAoB,GAAG,8BAA8B,CAAC,CAAA;IAEjE;;;;;OAKG;IACH,aAAa,CACX,kBAAkB,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC1C,OAAO,CAAC,oBAAoB,GAAG,8BAA8B,CAAC,MAAM,CAAC,CAAC,CAAA;IAEzE;;;;;;;;;;;OAWG;IACH,gBAAgB,CACd,kBAAkB,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC3C,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC/B,OAAO,CAAC,oBAAoB,GAAG,gCAAgC,CAAC,CAAA;IAEnE;;;;;;;;;;;OAWG;IACH,cAAc,CACZ,kBAAkB,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC1C,OAAO,CAAC,oBAAoB,GAAG,8BAA8B,CAAC,MAAM,CAAC,CAAC,CAAA;IAEzE;;;;;;;;OAQG;IACH,aAAa,CACX,kBAAkB,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EAC3C,YAAY,EAAE,MAAM,GACnB,OAAO,CAAC,oBAAoB,GAAG,8BAA8B,CAAC,MAAM,CAAC,CAAC,CAAA;IAEzE;;;;;;;;OAQG;IACH,eAAe,CACb,kBAAkB,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC1C,OAAO,CAAC,oBAAoB,GAAG,8BAA8B,CAAC,MAAM,CAAC,CAAC,CAAA;IAEzE;;;;;;;OAOG;IACH,aAAa,CACX,kBAAkB,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC1C,OAAO,CAAC,oBAAoB,GAAG,8BAA8B,CAAC,MAAM,CAAC,CAAC,CAAA;IAEzE;;;;;;OAMG;IACH,gBAAgB,CACd,kBAAkB,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,GAC1C,OAAO,CAAC,oBAAoB,CAAC,CAAA;IAEhC;;;;;;;;OAQG;IACH,uBAAuB,CACrB,IAAI,EAAE,sBAAsB,CAAC,SAAS,CAAC,GACtC,OAAO,CAAC,mBAAmB,CAAC,CAAA;CAChC"}

package/dist/payment/provider.js.map

@@ -1 +1 @@
-{"version":3,"file":"provider.js","sourceRoot":"","sources":["../../src/payment/provider.ts"],"names":[],"mappings":";;;AASA;;GAEG;AACH,IAAY,cAiBX;AAjBD,WAAY,cAAc;IACxB;;OAEG;IACH,2CAAyB,CAAA;IACzB;;OAEG;IACH,yCAAuB,CAAA;IACvB;;OAEG;IACH,mCAAiB,CAAA;IACjB;;OAEG;IACH,iDAA+B,CAAA;AACjC,CAAC,EAjBW,cAAc,8BAAd,cAAc,QAiBzB"}
+{"version":3,"file":"provider.js","sourceRoot":"","sources":["../../src/payment/provider.ts"],"names":[],"mappings":";;;AAeA;;GAEG;AACH,IAAY,cAoBX;AApBD,WAAY,cAAc;IACxB;;OAEG;IACH,2CAAyB,CAAA;IAEzB;;OAEG;IACH,yCAAuB,CAAA;IAEvB;;OAEG;IACH,mCAAiB,CAAA;IAEjB;;OAEG;IACH,iDAA+B,CAAA;AACjC,CAAC,EApBW,cAAc,8BAAd,cAAc,QAoBzB"}