asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

chore: update links to v2 docs in source code and comments (#9732)

Browse Source
This commit is contained in:
Shahed Nasser
2024-10-24 15:18:38 +03:00
committed by GitHub
parent 6617f81640
commit 92bbd7953b
39 changed files with 225 additions and 229 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
packages/core/utils/src/auth/abstract-auth-provider.ts
View File

@@ -134,7 +134,7 @@ export abstract class AbstractAuthModuleProvider implements IAuthProvider {
* The authentication happens either by directly authenticating or returning a redirect URL to continue
* the authentication with a third party provider.
*
* Related Read: [Learn about the different authentication flows in Medusa](https://docs.medusajs.com/v2/resources/commerce-modules/auth/authentication-route).
* Related Read: [Learn about the different authentication flows in Medusa](https://docs.medusajs.com/resources/commerce-modules/auth/authentication-route).
*
* @param {AuthenticationInput} data - The details of the authentication request.
* @param {AuthIdentityProviderService} authIdentityProviderService - The service used to retrieve or
@@ -239,7 +239,7 @@ export abstract class AbstractAuthModuleProvider implements IAuthProvider {
* This method is only used in a basic authentication flow, such as when using an email and password
* to register and authenticate a user.
*
* Related Read: [Learn about the different authentication flows in Medusa](https://docs.medusajs.com/v2/resources/commerce-modules/auth/authentication-route).
* Related Read: [Learn about the different authentication flows in Medusa](https://docs.medusajs.com/resources/commerce-modules/auth/authentication-route).
*
* @param {AuthenticationInput} data - The details of the authentication request.
* @param {AuthIdentityProviderService} authIdentityProviderService - The service used to retrieve or
@@ -372,7 +372,7 @@ export abstract class AbstractAuthModuleProvider implements IAuthProvider {
* - `user_metadata`: Store metadata of the user's details. For example, if the third-party service returns the user's information such as email
* or name, you store this data in this property.
*
* Related Guide: [Learn about the different authentication flows in Medusa](https://docs.medusajs.com/v2/resources/commerce-modules/auth/authentication-route).
* Related Guide: [Learn about the different authentication flows in Medusa](https://docs.medusajs.com/resources/commerce-modules/auth/authentication-route).
*
* @param {AuthenticationInput} data - The details of the authentication request.
* @param {AuthIdentityProviderService} authIdentityProviderService - The service used to retrieve or

6
packages/core/utils/src/payment/abstract-payment-provider.ts
View File

@@ -144,7 +144,7 @@ export abstract class AbstractPaymentProvider<TConfig = Record<string, unknown>>
*
* - The {@link authorizePayment} method returns the status `captured`, which automatically executed this method 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/v2/resources/commerce-modules/payment/webhook-events).
* - 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/resources/commerce-modules/payment/webhook-events).
*
* In this method, use the third-party provider to capture the payment.
*
@@ -194,7 +194,7 @@ export abstract class AbstractPaymentProvider<TConfig = Record<string, unknown>>
* This method authorizes a payment session. When authorized successfully, a payment is created by the Payment
* Module which can be later captured using the {@link capturePayment} method.
*
* Refer to [this guide](https://docs.medusajs.com/v2/resources/commerce-modules/payment/payment-flow#3-authorize-payment-session)
* Refer to [this guide](https://docs.medusajs.com/resources/commerce-modules/payment/payment-flow#3-authorize-payment-session)
* to learn more about how this fits into the payment flow and how to handle required actions.
*
* To automatically capture the payment after authorization, return the status `captured`.
@@ -619,7 +619,7 @@ export abstract class AbstractPaymentProvider<TConfig = Record<string, unknown>>
* This method is executed when a webhook event is received from the third-party payment provider. Use it
* to process the action of the payment provider.
*
* Learn more in [this documentation](https://docs.medusajs.com/v2/resources/commerce-modules/payment/webhook-events)
* Learn more in [this documentation](https://docs.medusajs.com/resources/commerce-modules/payment/webhook-events)
*
* @param data - The webhook event's data
* @returns The webhook result. If the `action`'s value is `captured`, the payment is captured within Medusa as well.