chore(js-sdk, types): add TSDocs for plugin methods in JS SDK (#12106)
* chore(js-sdk, types): add TSDocs for plugin methods in JS SDK * tsdocs for draft orders
This commit is contained in:
@@ -29,7 +29,7 @@ export class DraftOrder {
|
||||
* To retrieve a draft order by its ID:
|
||||
*
|
||||
* ```ts
|
||||
* sdk.admin.draftOrder.retrieve("draft_order_123")
|
||||
* sdk.admin.draftOrder.retrieve("order_123")
|
||||
* .then(({ draft_order }) => {
|
||||
* console.log(draft_order)
|
||||
* })
|
||||
@@ -38,7 +38,7 @@ export class DraftOrder {
|
||||
* To specify the fields and relations to retrieve:
|
||||
*
|
||||
* ```ts
|
||||
* sdk.admin.draftOrder.retrieve("draft_order_123", {
|
||||
* sdk.admin.draftOrder.retrieve("order_123", {
|
||||
* fields: "id,*items"
|
||||
* })
|
||||
* .then(({ draft_order }) => {
|
||||
@@ -142,7 +142,7 @@ export class DraftOrder {
|
||||
* },
|
||||
* ],
|
||||
* region_id: "region_123",
|
||||
* sales_channel_id: "sales_channel_123",
|
||||
* sales_channel_id: "sc_123",
|
||||
* })
|
||||
* .then(({ draft_order }) => {
|
||||
* console.log(draft_order)
|
||||
@@ -178,7 +178,7 @@ export class DraftOrder {
|
||||
* To update a draft order:
|
||||
*
|
||||
* ```ts
|
||||
* sdk.admin.draftOrder.update("draft_order_123", {
|
||||
* sdk.admin.draftOrder.update("order_123", {
|
||||
* email: "test@test.com",
|
||||
* })
|
||||
* .then(({ draft_order }) => {
|
||||
@@ -215,7 +215,7 @@ export class DraftOrder {
|
||||
* To convert a draft order to an order:
|
||||
*
|
||||
* ```ts
|
||||
* sdk.admin.draftOrder.convertToOrder("draft_order_123")
|
||||
* sdk.admin.draftOrder.convertToOrder("order_123")
|
||||
* .then(({ order }) => {
|
||||
* console.log(order)
|
||||
* })
|
||||
|
||||
@@ -3,12 +3,30 @@ import { Client } from "../client"
|
||||
import { ClientHeaders } from "../types"
|
||||
|
||||
export class Plugin {
|
||||
/**
|
||||
* @ignore
|
||||
*/
|
||||
private client: Client
|
||||
|
||||
/**
|
||||
* @ignore
|
||||
*/
|
||||
constructor(client: Client) {
|
||||
this.client = client
|
||||
}
|
||||
|
||||
/**
|
||||
* This method retrieves the list of plugins installed in a Medusa application.
|
||||
*
|
||||
* @param headers - Headers to pass in the request.
|
||||
* @returns The list of plugins.
|
||||
*
|
||||
* @example
|
||||
* sdk.admin.plugin.list()
|
||||
* .then(({ plugins }) => {
|
||||
* console.log(plugins)
|
||||
* })
|
||||
*/
|
||||
async list(headers?: ClientHeaders) {
|
||||
return await this.client.fetch<HttpTypes.AdminPluginsListResponse>(
|
||||
`/admin/plugins`,
|
||||
|
||||
Reference in New Issue
Block a user