chore: use since instead of version tag in TSDocs (#13126)
This commit is contained in:
@@ -136,7 +136,7 @@ export interface MedusaRequest<
|
|||||||
/**
|
/**
|
||||||
* An object containing fields and variables to be used with the remoteQuery
|
* An object containing fields and variables to be used with the remoteQuery
|
||||||
*
|
*
|
||||||
* @version 2.2.0
|
* @since 2.2.0
|
||||||
*/
|
*/
|
||||||
queryConfig: {
|
queryConfig: {
|
||||||
fields: string[]
|
fields: string[]
|
||||||
|
|||||||
@@ -41,7 +41,7 @@ declare module "@medusajs/types" {
|
|||||||
*/
|
*/
|
||||||
[ContainerRegistrationKeys.REMOTE_LINK]: Link
|
[ContainerRegistrationKeys.REMOTE_LINK]: Link
|
||||||
/**
|
/**
|
||||||
* @version 2.2.0
|
* @since 2.2.0
|
||||||
*/
|
*/
|
||||||
[ContainerRegistrationKeys.LINK]: Link
|
[ContainerRegistrationKeys.LINK]: Link
|
||||||
[ContainerRegistrationKeys.CONFIG_MODULE]: ConfigModule
|
[ContainerRegistrationKeys.CONFIG_MODULE]: ConfigModule
|
||||||
|
|||||||
@@ -66,7 +66,7 @@ export class Product {
|
|||||||
* [Create Product Import](https://docs.medusajs.com/api/admin#products_postproductsimports)
|
* [Create Product Import](https://docs.medusajs.com/api/admin#products_postproductsimports)
|
||||||
* API route.
|
* API route.
|
||||||
*
|
*
|
||||||
* @version 2.8.5
|
* @since 2.8.5
|
||||||
*
|
*
|
||||||
* @param body - The import's details.
|
* @param body - The import's details.
|
||||||
* @param query - Query parameters to pass to the request.
|
* @param query - Query parameters to pass to the request.
|
||||||
@@ -172,7 +172,7 @@ export class Product {
|
|||||||
* [Confirm Product Import](https://docs.medusajs.com/api/admin#products_postproductsimporttransaction_idconfirm)
|
* [Confirm Product Import](https://docs.medusajs.com/api/admin#products_postproductsimporttransaction_idconfirm)
|
||||||
* API route.
|
* API route.
|
||||||
*
|
*
|
||||||
* @version 2.8.5
|
* @since 2.8.5
|
||||||
*
|
*
|
||||||
* @param transactionId - The ID of the transaction of the created product import. This is returned
|
* @param transactionId - The ID of the transaction of the created product import. This is returned
|
||||||
* by the API route used to create the product import.
|
* by the API route used to create the product import.
|
||||||
|
|||||||
@@ -21,7 +21,7 @@ export class TaxProvider {
|
|||||||
* [List Tax Providers](https://docs.medusajs.com/api/admin#tax-providers_gettaxproviders)
|
* [List Tax Providers](https://docs.medusajs.com/api/admin#tax-providers_gettaxproviders)
|
||||||
* API route.
|
* API route.
|
||||||
*
|
*
|
||||||
* @version 2.8.0
|
* @since 2.8.0
|
||||||
*
|
*
|
||||||
* @param query - Filters and pagination configurations.
|
* @param query - Filters and pagination configurations.
|
||||||
* @param headers - Headers to pass in the request.
|
* @param headers - Headers to pass in the request.
|
||||||
|
|||||||
@@ -67,7 +67,7 @@ export class TaxRegion {
|
|||||||
* [Update Tax Region](https://docs.medusajs.com/api/admin#tax-regions_posttaxregionsid)
|
* [Update Tax Region](https://docs.medusajs.com/api/admin#tax-regions_posttaxregionsid)
|
||||||
* API route.
|
* API route.
|
||||||
*
|
*
|
||||||
* @version 2.8.0
|
* @since 2.8.0
|
||||||
*
|
*
|
||||||
* @param id - The ID of the tax region to update.
|
* @param id - The ID of the tax region to update.
|
||||||
* @param body - The details of the tax region to update.
|
* @param body - The details of the tax region to update.
|
||||||
|
|||||||
@@ -176,7 +176,7 @@ export interface IFileModuleService extends IModuleService {
|
|||||||
* This method retrieves a file by its ID and returns a stream to download the file. Under the hood, it will use the
|
* This method retrieves a file by its ID and returns a stream to download the file. Under the hood, it will use the
|
||||||
* file provider that was used to upload the file to retrievethe stream.
|
* file provider that was used to upload the file to retrievethe stream.
|
||||||
*
|
*
|
||||||
* @version 2.8.0
|
* @since 2.8.0
|
||||||
*
|
*
|
||||||
* @param {string} id - The ID of the file.
|
* @param {string} id - The ID of the file.
|
||||||
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
||||||
@@ -192,7 +192,7 @@ export interface IFileModuleService extends IModuleService {
|
|||||||
* This method retrieves a file by its ID and returns the file contents as a buffer. Under the hood, it will use the
|
* This method retrieves a file by its ID and returns the file contents as a buffer. Under the hood, it will use the
|
||||||
* file provider that was used to upload the file to retrieve the buffer.
|
* file provider that was used to upload the file to retrieve the buffer.
|
||||||
*
|
*
|
||||||
* @version 2.8.0
|
* @since 2.8.0
|
||||||
*
|
*
|
||||||
* @param {string} id - The ID of the file.
|
* @param {string} id - The ID of the file.
|
||||||
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
* @param {Context} sharedContext - A context used to share resources, such as transaction manager, between the application and the module.
|
||||||
|
|||||||
@@ -42,7 +42,7 @@ export type PaginatedResponse<T> = {
|
|||||||
* The estimated count retrieved from the PostgreSQL query planner, which may be inaccurate.
|
* The estimated count retrieved from the PostgreSQL query planner, which may be inaccurate.
|
||||||
*
|
*
|
||||||
* @featureFlag index_engine
|
* @featureFlag index_engine
|
||||||
* @version 2.8.0
|
* @since 2.8.0
|
||||||
*/
|
*/
|
||||||
estimate_count?: number
|
estimate_count?: number
|
||||||
} & T
|
} & T
|
||||||
|
|||||||
@@ -71,7 +71,7 @@ export type QueryFunctionReturnPagination = {
|
|||||||
take: number
|
take: number
|
||||||
/**
|
/**
|
||||||
* @featureFlag index_engine
|
* @featureFlag index_engine
|
||||||
* @version 2.8.0
|
* @since 2.8.0
|
||||||
*/
|
*/
|
||||||
estimate_count: number
|
estimate_count: number
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -419,7 +419,7 @@ export interface IPaymentProvider {
|
|||||||
* @param data - Input data including the details of the account holder to create.
|
* @param data - Input data including the details of the account holder to create.
|
||||||
* @returns The result of creating the account holder. If an error occurs, throw it.
|
* @returns The result of creating the account holder. If an error occurs, throw it.
|
||||||
*
|
*
|
||||||
* @version 2.5.0
|
* @since 2.5.0
|
||||||
*
|
*
|
||||||
* @example
|
* @example
|
||||||
* import { MedusaError } from "@medusajs/framework/utils"
|
* import { MedusaError } from "@medusajs/framework/utils"
|
||||||
@@ -467,7 +467,7 @@ export interface IPaymentProvider {
|
|||||||
* @param data - Input data including the details of the account holder to update.
|
* @param data - Input data including the details of the account holder to update.
|
||||||
* @returns The result of updating the account holder. If an error occurs, throw it.
|
* @returns The result of updating the account holder. If an error occurs, throw it.
|
||||||
*
|
*
|
||||||
* @version 2.5.1
|
* @since 2.5.1
|
||||||
*
|
*
|
||||||
* @example
|
* @example
|
||||||
* import { MedusaError } from "@medusajs/framework/utils"
|
* import { MedusaError } from "@medusajs/framework/utils"
|
||||||
@@ -508,7 +508,7 @@ export interface IPaymentProvider {
|
|||||||
* @param data - Input data including the details of the account holder to delete.
|
* @param data - Input data including the details of the account holder to delete.
|
||||||
* @returns The result of deleting the account holder. If an error occurs, throw it.
|
* @returns The result of deleting the account holder. If an error occurs, throw it.
|
||||||
*
|
*
|
||||||
* @version 2.5.0
|
* @since 2.5.0
|
||||||
*
|
*
|
||||||
* @example
|
* @example
|
||||||
* import { MedusaError } from "@medusajs/framework/utils"
|
* import { MedusaError } from "@medusajs/framework/utils"
|
||||||
@@ -544,7 +544,7 @@ export interface IPaymentProvider {
|
|||||||
* in the third-party payment provider. A payment provider that supports saving payment methods
|
* in the third-party payment provider. A payment provider that supports saving payment methods
|
||||||
* must implement this method.
|
* must implement this method.
|
||||||
*
|
*
|
||||||
* @version 2.5.0
|
* @since 2.5.0
|
||||||
*
|
*
|
||||||
* @param data - Input data including the details of the account holder to list payment methods for.
|
* @param data - Input data including the details of the account holder to list payment methods for.
|
||||||
* @returns The list of payment methods saved for the account holder. If an error occurs, throw it.
|
* @returns The list of payment methods saved for the account holder. If an error occurs, throw it.
|
||||||
@@ -587,7 +587,7 @@ export interface IPaymentProvider {
|
|||||||
* third-party payment provider. A payment provider that supports saving payment methods
|
* third-party payment provider. A payment provider that supports saving payment methods
|
||||||
* must implement this method.
|
* must implement this method.
|
||||||
*
|
*
|
||||||
* @version 2.5.0
|
* @since 2.5.0
|
||||||
*
|
*
|
||||||
* @param data - The details of the payment method to save.
|
* @param data - The details of the payment method to save.
|
||||||
* @returns The result of saving the payment method. If an error occurs, throw it.
|
* @returns The result of saving the payment method. If an error occurs, throw it.
|
||||||
|
|||||||
@@ -585,7 +585,7 @@ export interface ITaxModuleService extends IModuleService {
|
|||||||
/**
|
/**
|
||||||
* This method retrieves a paginated list of tax providers based on optional filters and configuration.
|
* This method retrieves a paginated list of tax providers based on optional filters and configuration.
|
||||||
*
|
*
|
||||||
* @version 2.8.0
|
* @since 2.8.0
|
||||||
*
|
*
|
||||||
* @param {FilterableTaxProviderProps} filters - The filters to apply on the retrieved tax providers.
|
* @param {FilterableTaxProviderProps} filters - The filters to apply on the retrieved tax providers.
|
||||||
* @param {FindConfig<TaxProviderDTO>} config - The configurations determining how the tax provider is retrieved. Its properties, such as `select` or `relations`, accept the
|
* @param {FindConfig<TaxProviderDTO>} config - The configurations determining how the tax provider is retrieved. Its properties, such as `select` or `relations`, accept the
|
||||||
|
|||||||
@@ -10,7 +10,7 @@ export const ContainerRegistrationKeys = {
|
|||||||
*/
|
*/
|
||||||
REMOTE_LINK: "remoteLink",
|
REMOTE_LINK: "remoteLink",
|
||||||
/**
|
/**
|
||||||
* @version 2.2.0
|
* @since 2.2.0
|
||||||
*/
|
*/
|
||||||
LINK: "link",
|
LINK: "link",
|
||||||
FEATURE_FLAG_ROUTER: "featureFlagRouter",
|
FEATURE_FLAG_ROUTER: "featureFlagRouter",
|
||||||
|
|||||||
@@ -52,7 +52,7 @@ export const CartWorkflowEvents = {
|
|||||||
/**
|
/**
|
||||||
* Emitted when the customer in the cart is transferred.
|
* Emitted when the customer in the cart is transferred.
|
||||||
*
|
*
|
||||||
* @version 2.8.0
|
* @since 2.8.0
|
||||||
*
|
*
|
||||||
* @eventPayload
|
* @eventPayload
|
||||||
* ```ts
|
* ```ts
|
||||||
@@ -269,7 +269,7 @@ export const OrderEditWorkflowEvents = {
|
|||||||
/**
|
/**
|
||||||
* Emitted when an order edit is requested.
|
* Emitted when an order edit is requested.
|
||||||
*
|
*
|
||||||
* @version 2.8.0
|
* @since 2.8.0
|
||||||
*
|
*
|
||||||
* @eventPayload
|
* @eventPayload
|
||||||
* ```ts
|
* ```ts
|
||||||
@@ -283,7 +283,7 @@ export const OrderEditWorkflowEvents = {
|
|||||||
/**
|
/**
|
||||||
* Emitted when an order edit request is confirmed.
|
* Emitted when an order edit request is confirmed.
|
||||||
*
|
*
|
||||||
* @version 2.8.0
|
* @since 2.8.0
|
||||||
*
|
*
|
||||||
* @eventPayload
|
* @eventPayload
|
||||||
* ```ts
|
* ```ts
|
||||||
@@ -297,7 +297,7 @@ export const OrderEditWorkflowEvents = {
|
|||||||
/**
|
/**
|
||||||
* Emitted when an order edit request is canceled.
|
* Emitted when an order edit request is canceled.
|
||||||
*
|
*
|
||||||
* @version 2.8.0
|
* @since 2.8.0
|
||||||
*
|
*
|
||||||
* @eventPayload
|
* @eventPayload
|
||||||
* ```ts
|
* ```ts
|
||||||
|
|||||||
@@ -242,7 +242,7 @@ export class EntityBuilder {
|
|||||||
* This method defines a float property that allows for
|
* This method defines a float property that allows for
|
||||||
* values with decimal places
|
* values with decimal places
|
||||||
*
|
*
|
||||||
* @version 2.1.2
|
* @since 2.1.2
|
||||||
*
|
*
|
||||||
* @example
|
* @example
|
||||||
* import { model } from "@medusajs/framework/utils"
|
* import { model } from "@medusajs/framework/utils"
|
||||||
|
|||||||
@@ -192,7 +192,7 @@ export class AbstractFileProviderService implements IFileProvider {
|
|||||||
* @param {FileTypes.ProviderGetFileDTO} fileData - The details of the file to get its stream.
|
* @param {FileTypes.ProviderGetFileDTO} fileData - The details of the file to get its stream.
|
||||||
* @returns {Promise<Readable>} The file's stream.
|
* @returns {Promise<Readable>} The file's stream.
|
||||||
*
|
*
|
||||||
* @version 2.8.0
|
* @since 2.8.0
|
||||||
*
|
*
|
||||||
* @example
|
* @example
|
||||||
* class MyFileProviderService extends AbstractFileProviderService {
|
* class MyFileProviderService extends AbstractFileProviderService {
|
||||||
@@ -217,7 +217,7 @@ export class AbstractFileProviderService implements IFileProvider {
|
|||||||
* @param {FileTypes.ProviderGetFileDTO} fileData - The details of the file to get its buffer.
|
* @param {FileTypes.ProviderGetFileDTO} fileData - The details of the file to get its buffer.
|
||||||
* @returns {Promise<Buffer>} The file's buffer.
|
* @returns {Promise<Buffer>} The file's buffer.
|
||||||
*
|
*
|
||||||
* @version 2.8.0
|
* @since 2.8.0
|
||||||
*
|
*
|
||||||
* @example
|
* @example
|
||||||
* class MyFileProviderService extends AbstractFileProviderService {
|
* class MyFileProviderService extends AbstractFileProviderService {
|
||||||
|
|||||||
@@ -57,7 +57,7 @@ export const POST = async (
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @version 2.8.4
|
* @since 2.8.4
|
||||||
*/
|
*/
|
||||||
export const DELETE = async (
|
export const DELETE = async (
|
||||||
req: AuthenticatedMedusaRequest,
|
req: AuthenticatedMedusaRequest,
|
||||||
|
|||||||
@@ -12,7 +12,7 @@ import { Modules, TransactionHandlerType } from "@medusajs/framework/utils"
|
|||||||
import { StepResponse } from "@medusajs/framework/workflows-sdk"
|
import { StepResponse } from "@medusajs/framework/workflows-sdk"
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @version 2.8.5
|
* @since 2.8.5
|
||||||
*/
|
*/
|
||||||
export const POST = async (
|
export const POST = async (
|
||||||
req: AuthenticatedMedusaRequest,
|
req: AuthenticatedMedusaRequest,
|
||||||
|
|||||||
@@ -7,7 +7,7 @@ import type { AdminImportProductsType } from "../validators"
|
|||||||
import { importProductsAsChunksWorkflow } from "@medusajs/core-flows"
|
import { importProductsAsChunksWorkflow } from "@medusajs/core-flows"
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @version 2.8.5
|
* @since 2.8.5
|
||||||
*/
|
*/
|
||||||
export const POST = async (
|
export const POST = async (
|
||||||
req: AuthenticatedMedusaRequest<AdminImportProductsType>,
|
req: AuthenticatedMedusaRequest<AdminImportProductsType>,
|
||||||
|
|||||||
@@ -7,7 +7,7 @@ import {
|
|||||||
import { HttpTypes } from "@medusajs/framework/types"
|
import { HttpTypes } from "@medusajs/framework/types"
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @version 2.8.0
|
* @since 2.8.0
|
||||||
*/
|
*/
|
||||||
export const GET = async (
|
export const GET = async (
|
||||||
req: AuthenticatedMedusaRequest<HttpTypes.AdminGetTaxProvidersParams>,
|
req: AuthenticatedMedusaRequest<HttpTypes.AdminGetTaxProvidersParams>,
|
||||||
|
|||||||
@@ -3,7 +3,7 @@ import { MedusaRequest, MedusaResponse } from "@medusajs/framework/http"
|
|||||||
import { HttpTypes } from "@medusajs/framework/types"
|
import { HttpTypes } from "@medusajs/framework/types"
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @version 2.8.0
|
* @since 2.8.0
|
||||||
*/
|
*/
|
||||||
export const POST = async (
|
export const POST = async (
|
||||||
req: MedusaRequest<HttpTypes.StoreCreateReturn>,
|
req: MedusaRequest<HttpTypes.StoreCreateReturn>,
|
||||||
|
|||||||
Reference in New Issue
Block a user