@medusajs/js-sdk 2.6.2-snapshot-20250402185634 → 2.7.0-preview-20250411080918

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (13) hide show
  1. package/dist/admin/draft-order.d.ts +5 -5
  2. package/dist/admin/draft-order.js +5 -5
  3. package/dist/admin/plugin.d.ts +18 -0
  4. package/dist/admin/plugin.d.ts.map +1 -1
  5. package/dist/admin/plugin.js +15 -0
  6. package/dist/admin/plugin.js.map +1 -1
  7. package/dist/esm/admin/draft-order.d.ts +5 -5
  8. package/dist/esm/admin/draft-order.js +5 -5
  9. package/dist/esm/admin/plugin.d.ts +18 -0
  10. package/dist/esm/admin/plugin.d.ts.map +1 -1
  11. package/dist/esm/admin/plugin.js +15 -0
  12. package/dist/esm/admin/plugin.js.map +1 -1
  13. package/package.json +2 -2
package/dist/admin/draft-order.d.ts CHANGED
@@ -24,7 +24,7 @@ export declare class DraftOrder {
24
24
  * To retrieve a draft order by its ID:
25
25
  *
26
26
  * ```ts
27
- * sdk.admin.draftOrder.retrieve("draft_order_123")
27
+ * sdk.admin.draftOrder.retrieve("order_123")
28
28
  * .then(({ draft_order }) => {
29
29
  * console.log(draft_order)
30
30
  * })
@@ -33,7 +33,7 @@ export declare class DraftOrder {
33
33
  * To specify the fields and relations to retrieve:
34
34
  *
35
35
  * ```ts
36
- * sdk.admin.draftOrder.retrieve("draft_order_123", {
36
+ * sdk.admin.draftOrder.retrieve("order_123", {
37
37
  * fields: "id,*items"
38
38
  * })
39
39
  * .then(({ draft_order }) => {
@@ -112,7 +112,7 @@ export declare class DraftOrder {
112
112
  * },
113
113
  * ],
114
114
  * region_id: "region_123",
115
- * sales_channel_id: "sales_channel_123",
115
+ * sales_channel_id: "sc_123",
116
116
  * })
117
117
  * .then(({ draft_order }) => {
118
118
  * console.log(draft_order)
@@ -133,7 +133,7 @@ export declare class DraftOrder {
133
133
  * To update a draft order:
134
134
  *
135
135
  * ```ts
136
- * sdk.admin.draftOrder.update("draft_order_123", {
136
+ * sdk.admin.draftOrder.update("order_123", {
137
137
  * email: "test@test.com",
138
138
  * })
139
139
  * .then(({ draft_order }) => {
@@ -154,7 +154,7 @@ export declare class DraftOrder {
154
154
  * To convert a draft order to an order:
155
155
  *
156
156
  * ```ts
157
- * sdk.admin.draftOrder.convertToOrder("draft_order_123")
157
+ * sdk.admin.draftOrder.convertToOrder("order_123")
158
158
  * .then(({ order }) => {
159
159
  * console.log(order)
160
160
  * })
package/dist/admin/draft-order.js CHANGED
@@ -22,7 +22,7 @@ class DraftOrder {
22
22
  * To retrieve a draft order by its ID:
23
23
  *
24
24
  * ```ts
25
- * sdk.admin.draftOrder.retrieve("draft_order_123")
25
+ * sdk.admin.draftOrder.retrieve("order_123")
26
26
  * .then(({ draft_order }) => {
27
27
  * console.log(draft_order)
28
28
  * })
@@ -31,7 +31,7 @@ class DraftOrder {
31
31
  * To specify the fields and relations to retrieve:
32
32
  *
33
33
  * ```ts
34
- * sdk.admin.draftOrder.retrieve("draft_order_123", {
34
+ * sdk.admin.draftOrder.retrieve("order_123", {
35
35
  * fields: "id,*items"
36
36
  * })
37
37
  * .then(({ draft_order }) => {
@@ -120,7 +120,7 @@ class DraftOrder {
120
120
  * },
121
121
  * ],
122
122
  * region_id: "region_123",
123
- * sales_channel_id: "sales_channel_123",
123
+ * sales_channel_id: "sc_123",
124
124
  * })
125
125
  * .then(({ draft_order }) => {
126
126
  * console.log(draft_order)
@@ -148,7 +148,7 @@ class DraftOrder {
148
148
  * To update a draft order:
149
149
  *
150
150
  * ```ts
151
- * sdk.admin.draftOrder.update("draft_order_123", {
151
+ * sdk.admin.draftOrder.update("order_123", {
152
152
  * email: "test@test.com",
153
153
  * })
154
154
  * .then(({ draft_order }) => {
@@ -176,7 +176,7 @@ class DraftOrder {
176
176
  * To convert a draft order to an order:
177
177
  *
178
178
  * ```ts
179
- * sdk.admin.draftOrder.convertToOrder("draft_order_123")
179
+ * sdk.admin.draftOrder.convertToOrder("order_123")
180
180
  * .then(({ order }) => {
181
181
  * console.log(order)
182
182
  * })
package/dist/admin/plugin.d.ts CHANGED
@@ -2,8 +2,26 @@ import { HttpTypes } from "@medusajs/types";
2
2
  import { Client } from "../client";
3
3
  import { ClientHeaders } from "../types";
4
4
  export declare class Plugin {
5
+ /**
6
+ * @ignore
7
+ */
5
8
  private client;
9
+ /**
10
+ * @ignore
11
+ */
6
12
  constructor(client: Client);
13
+ /**
14
+ * This method retrieves the list of plugins installed in a Medusa application.
15
+ *
16
+ * @param headers - Headers to pass in the request.
17
+ * @returns The list of plugins.
18
+ *
19
+ * @example
20
+ * sdk.admin.plugin.list()
21
+ * .then(({ plugins }) => {
22
+ * console.log(plugins)
23
+ * })
24
+ */
7
25
  list(headers?: ClientHeaders): Promise<HttpTypes.AdminPluginsListResponse>;
8
26
  }
9
27
  //# sourceMappingURL=plugin.d.ts.map
package/dist/admin/plugin.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"plugin.d.ts","sourceRoot":"","sources":["../../src/admin/plugin.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAA;AAC3C,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;AAClC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AAExC,qBAAa,MAAM;IACjB,OAAO,CAAC,MAAM,CAAQ;gBAEV,MAAM,EAAE,MAAM;IAIpB,IAAI,CAAC,OAAO,CAAC,EAAE,aAAa;CASnC"}
1
+ {"version":3,"file":"plugin.d.ts","sourceRoot":"","sources":["../../src/admin/plugin.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAA;AAC3C,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;AAClC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AAExC,qBAAa,MAAM;IACjB;;OAEG;IACH,OAAO,CAAC,MAAM,CAAQ;IAEtB;;OAEG;gBACS,MAAM,EAAE,MAAM;IAI1B;;;;;;;;;;;OAWG;IACG,IAAI,CAAC,OAAO,CAAC,EAAE,aAAa;CASnC"}
package/dist/admin/plugin.js CHANGED
@@ -2,9 +2,24 @@
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.Plugin = void 0;
4
4
  class Plugin {
5
+ /**
6
+ * @ignore
7
+ */
5
8
  constructor(client) {
6
9
  this.client = client;
7
10
  }
11
+ /**
12
+ * This method retrieves the list of plugins installed in a Medusa application.
13
+ *
14
+ * @param headers - Headers to pass in the request.
15
+ * @returns The list of plugins.
16
+ *
17
+ * @example
18
+ * sdk.admin.plugin.list()
19
+ * .then(({ plugins }) => {
20
+ * console.log(plugins)
21
+ * })
22
+ */
8
23
  async list(headers) {
9
24
  return await this.client.fetch(`/admin/plugins`, {
10
25
  headers,
package/dist/admin/plugin.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"plugin.js","sourceRoot":"","sources":["../../src/admin/plugin.ts"],"names":[],"mappings":";;;AAIA,MAAa,MAAM;IAGjB,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED,KAAK,CAAC,IAAI,CAAC,OAAuB;QAChC,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,gBAAgB,EAChB;YACE,OAAO;YACP,KAAK,EAAE,EAAE;SACV,CACF,CAAA;IACH,CAAC;CACF;AAhBD,wBAgBC"}
1
+ {"version":3,"file":"plugin.js","sourceRoot":"","sources":["../../src/admin/plugin.ts"],"names":[],"mappings":";;;AAIA,MAAa,MAAM;IAMjB;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED;;;;;;;;;;;OAWG;IACH,KAAK,CAAC,IAAI,CAAC,OAAuB;QAChC,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,gBAAgB,EAChB;YACE,OAAO;YACP,KAAK,EAAE,EAAE;SACV,CACF,CAAA;IACH,CAAC;CACF;AAlCD,wBAkCC"}
package/dist/esm/admin/draft-order.d.ts CHANGED
@@ -24,7 +24,7 @@ export declare class DraftOrder {
24
24
  * To retrieve a draft order by its ID:
25
25
  *
26
26
  * ```ts
27
- * sdk.admin.draftOrder.retrieve("draft_order_123")
27
+ * sdk.admin.draftOrder.retrieve("order_123")
28
28
  * .then(({ draft_order }) => {
29
29
  * console.log(draft_order)
30
30
  * })
@@ -33,7 +33,7 @@ export declare class DraftOrder {
33
33
  * To specify the fields and relations to retrieve:
34
34
  *
35
35
  * ```ts
36
- * sdk.admin.draftOrder.retrieve("draft_order_123", {
36
+ * sdk.admin.draftOrder.retrieve("order_123", {
37
37
  * fields: "id,*items"
38
38
  * })
39
39
  * .then(({ draft_order }) => {
@@ -112,7 +112,7 @@ export declare class DraftOrder {
112
112
  * },
113
113
  * ],
114
114
  * region_id: "region_123",
115
- * sales_channel_id: "sales_channel_123",
115
+ * sales_channel_id: "sc_123",
116
116
  * })
117
117
  * .then(({ draft_order }) => {
118
118
  * console.log(draft_order)
@@ -133,7 +133,7 @@ export declare class DraftOrder {
133
133
  * To update a draft order:
134
134
  *
135
135
  * ```ts
136
- * sdk.admin.draftOrder.update("draft_order_123", {
136
+ * sdk.admin.draftOrder.update("order_123", {
137
137
  * email: "test@test.com",
138
138
  * })
139
139
  * .then(({ draft_order }) => {
@@ -154,7 +154,7 @@ export declare class DraftOrder {
154
154
  * To convert a draft order to an order:
155
155
  *
156
156
  * ```ts
157
- * sdk.admin.draftOrder.convertToOrder("draft_order_123")
157
+ * sdk.admin.draftOrder.convertToOrder("order_123")
158
158
  * .then(({ order }) => {
159
159
  * console.log(order)
160
160
  * })
package/dist/esm/admin/draft-order.js CHANGED
@@ -28,7 +28,7 @@ export class DraftOrder {
28
28
  * To retrieve a draft order by its ID:
29
29
  *
30
30
  * ```ts
31
- * sdk.admin.draftOrder.retrieve("draft_order_123")
31
+ * sdk.admin.draftOrder.retrieve("order_123")
32
32
  * .then(({ draft_order }) => {
33
33
  * console.log(draft_order)
34
34
  * })
@@ -37,7 +37,7 @@ export class DraftOrder {
37
37
  * To specify the fields and relations to retrieve:
38
38
  *
39
39
  * ```ts
40
- * sdk.admin.draftOrder.retrieve("draft_order_123", {
40
+ * sdk.admin.draftOrder.retrieve("order_123", {
41
41
  * fields: "id,*items"
42
42
  * })
43
43
  * .then(({ draft_order }) => {
@@ -130,7 +130,7 @@ export class DraftOrder {
130
130
  * },
131
131
  * ],
132
132
  * region_id: "region_123",
133
- * sales_channel_id: "sales_channel_123",
133
+ * sales_channel_id: "sc_123",
134
134
  * })
135
135
  * .then(({ draft_order }) => {
136
136
  * console.log(draft_order)
@@ -160,7 +160,7 @@ export class DraftOrder {
160
160
  * To update a draft order:
161
161
  *
162
162
  * ```ts
163
- * sdk.admin.draftOrder.update("draft_order_123", {
163
+ * sdk.admin.draftOrder.update("order_123", {
164
164
  * email: "test@test.com",
165
165
  * })
166
166
  * .then(({ draft_order }) => {
@@ -190,7 +190,7 @@ export class DraftOrder {
190
190
  * To convert a draft order to an order:
191
191
  *
192
192
  * ```ts
193
- * sdk.admin.draftOrder.convertToOrder("draft_order_123")
193
+ * sdk.admin.draftOrder.convertToOrder("order_123")
194
194
  * .then(({ order }) => {
195
195
  * console.log(order)
196
196
  * })
package/dist/esm/admin/plugin.d.ts CHANGED
@@ -2,8 +2,26 @@ import { HttpTypes } from "@medusajs/types";
2
2
  import { Client } from "../client";
3
3
  import { ClientHeaders } from "../types";
4
4
  export declare class Plugin {
5
+ /**
6
+ * @ignore
7
+ */
5
8
  private client;
9
+ /**
10
+ * @ignore
11
+ */
6
12
  constructor(client: Client);
13
+ /**
14
+ * This method retrieves the list of plugins installed in a Medusa application.
15
+ *
16
+ * @param headers - Headers to pass in the request.
17
+ * @returns The list of plugins.
18
+ *
19
+ * @example
20
+ * sdk.admin.plugin.list()
21
+ * .then(({ plugins }) => {
22
+ * console.log(plugins)
23
+ * })
24
+ */
7
25
  list(headers?: ClientHeaders): Promise<HttpTypes.AdminPluginsListResponse>;
8
26
  }
9
27
  //# sourceMappingURL=plugin.d.ts.map
package/dist/esm/admin/plugin.d.ts.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"plugin.d.ts","sourceRoot":"","sources":["../../../src/admin/plugin.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAA;AAC3C,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;AAClC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AAExC,qBAAa,MAAM;IACjB,OAAO,CAAC,MAAM,CAAQ;gBAEV,MAAM,EAAE,MAAM;IAIpB,IAAI,CAAC,OAAO,CAAC,EAAE,aAAa;CASnC"}
1
+ {"version":3,"file":"plugin.d.ts","sourceRoot":"","sources":["../../../src/admin/plugin.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAA;AAC3C,OAAO,EAAE,MAAM,EAAE,MAAM,WAAW,CAAA;AAClC,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAA;AAExC,qBAAa,MAAM;IACjB;;OAEG;IACH,OAAO,CAAC,MAAM,CAAQ;IAEtB;;OAEG;gBACS,MAAM,EAAE,MAAM;IAI1B;;;;;;;;;;;OAWG;IACG,IAAI,CAAC,OAAO,CAAC,EAAE,aAAa;CASnC"}
package/dist/esm/admin/plugin.js CHANGED
@@ -8,9 +8,24 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
8
8
  });
9
9
  };
10
10
  export class Plugin {
11
+ /**
12
+ * @ignore
13
+ */
11
14
  constructor(client) {
12
15
  this.client = client;
13
16
  }
17
+ /**
18
+ * This method retrieves the list of plugins installed in a Medusa application.
19
+ *
20
+ * @param headers - Headers to pass in the request.
21
+ * @returns The list of plugins.
22
+ *
23
+ * @example
24
+ * sdk.admin.plugin.list()
25
+ * .then(({ plugins }) => {
26
+ * console.log(plugins)
27
+ * })
28
+ */
14
29
  list(headers) {
15
30
  return __awaiter(this, void 0, void 0, function* () {
16
31
  return yield this.client.fetch(`/admin/plugins`, {
package/dist/esm/admin/plugin.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"plugin.js","sourceRoot":"","sources":["../../../src/admin/plugin.ts"],"names":[],"mappings":";;;;;;;;;AAIA,MAAM,OAAO,MAAM;IAGjB,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAEK,IAAI,CAAC,OAAuB;;YAChC,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,gBAAgB,EAChB;gBACE,OAAO;gBACP,KAAK,EAAE,EAAE;aACV,CACF,CAAA;QACH,CAAC;KAAA;CACF"}
1
+ {"version":3,"file":"plugin.js","sourceRoot":"","sources":["../../../src/admin/plugin.ts"],"names":[],"mappings":";;;;;;;;;AAIA,MAAM,OAAO,MAAM;IAMjB;;OAEG;IACH,YAAY,MAAc;QACxB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAA;IACtB,CAAC;IAED;;;;;;;;;;;OAWG;IACG,IAAI,CAAC,OAAuB;;YAChC,OAAO,MAAM,IAAI,CAAC,MAAM,CAAC,KAAK,CAC5B,gBAAgB,EAChB;gBACE,OAAO;gBACP,KAAK,EAAE,EAAE;aACV,CACF,CAAA;QACH,CAAC;KAAA;CACF"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@medusajs/js-sdk",
3
- "version": "2.6.2-snapshot-20250402185634",
3
+ "version": "2.7.0-preview-20250411080918",
4
4
  "description": "SDK for the Medusa API",
5
5
  "main": "dist/index.js",
6
6
  "module": "dist/esm/index.js",
@@ -35,7 +35,7 @@
35
35
  "typescript": "^5.6.2"
36
36
  },
37
37
  "dependencies": {
38
- "@medusajs/types": "2.6.2-snapshot-20250402185634",
38
+ "@medusajs/types": "2.7.0-preview-20250411080918",
39
39
  "fetch-event-stream": "^0.1.5",
40
40
  "qs": "^6.12.1"
41
41
  },