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

docs: generate JS SDK reference with fixes (#12161)

Browse Source
This commit is contained in:
Shahed Nasser
2025-04-11 16:42:09 +03:00
committed by GitHub
parent 90f9149735
commit 734f4fecbc
26 changed files with 6189 additions and 6130 deletions
Download Patch File Download Diff File Expand all files Collapse all files

48
www/apps/resources/generated/edit-dates.mjs
View File

@@ -2176,7 +2176,7 @@ export const generatedEditDates = {
"app/js-sdk/page.mdx": "2025-03-28T09:50:07.617Z",
"references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.apiKey/page.mdx": "2025-04-11T09:04:55.016Z",
"references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.campaign/page.mdx": "2025-04-11T09:04:55.081Z",
"references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.claim/page.mdx": "2025-04-11T09:04:54.863Z",
"references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.claim/page.mdx": "2025-04-11T13:17:47.098Z",
"references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.currency/page.mdx": "2025-01-13T18:05:58.402Z",
"references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.customer/page.mdx": "2025-04-11T09:04:54.414Z",
"references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.customerGroup/page.mdx": "2025-04-11T09:04:55.047Z",
@@ -2186,8 +2186,8 @@ export const generatedEditDates = {
"references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.fulfillmentSet/page.mdx": "2025-01-13T18:05:58.243Z",
"references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.inventoryItem/page.mdx": "2025-01-27T11:43:57.620Z",
"references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.notification/page.mdx": "2025-01-13T18:05:58.273Z",
"references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.invite/page.mdx": "2025-04-11T09:04:54.389Z",
"references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.order/page.mdx": "2025-04-11T09:04:54.699Z",
"references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.invite/page.mdx": "2025-04-11T13:17:46.905Z",
"references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.order/page.mdx": "2025-04-11T13:17:47.030Z",
"references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.orderEdit/page.mdx": "2025-04-11T09:04:54.766Z",
"references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.payment/page.mdx": "2025-01-13T18:05:58.444Z",
"references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.paymentCollection/page.mdx": "2024-12-26T11:37:18.123Z",
@@ -2234,7 +2234,7 @@ export const generatedEditDates = {
"references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.addInboundShipping/page.mdx": "2025-04-11T09:04:53.801Z",
"references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.addItems/page.mdx": "2025-04-11T09:04:53.776Z",
"references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.addOutboundItems/page.mdx": "2025-04-11T09:04:53.810Z",
"references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.addOutboundShipping/page.mdx": "2025-04-11T09:04:53.819Z",
"references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.addOutboundShipping/page.mdx": "2025-04-11T13:17:46.664Z",
"references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.cancel/page.mdx": "2024-12-09T13:21:57.036Z",
"references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.cancelRequest/page.mdx": "2024-12-09T13:21:57.096Z",
"references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.create/page.mdx": "2025-04-11T09:04:53.769Z",
@@ -2328,7 +2328,7 @@ export const generatedEditDates = {
"references/js_sdk/admin/InventoryItem/methods/js_sdk.admin.InventoryItem.update/page.mdx": "2024-12-09T13:21:58.260Z",
"references/js_sdk/admin/InventoryItem/methods/js_sdk.admin.InventoryItem.updateLevel/page.mdx": "2025-01-17T16:43:31.717Z",
"references/js_sdk/admin/InventoryItem/properties/js_sdk.admin.InventoryItem.client/page.mdx": "2025-02-24T10:48:45.102Z",
"references/js_sdk/admin/Invite/methods/js_sdk.admin.Invite.accept/page.mdx": "2025-04-11T09:04:55.207Z",
"references/js_sdk/admin/Invite/methods/js_sdk.admin.Invite.accept/page.mdx": "2025-04-11T13:17:47.236Z",
"references/js_sdk/admin/Invite/methods/js_sdk.admin.Invite.create/page.mdx": "2024-12-10T14:55:10.090Z",
"references/js_sdk/admin/Invite/methods/js_sdk.admin.Invite.delete/page.mdx": "2024-12-09T13:21:58.332Z",
"references/js_sdk/admin/Invite/methods/js_sdk.admin.Invite.list/page.mdx": "2024-12-09T13:21:58.328Z",
@@ -5926,15 +5926,15 @@ export const generatedEditDates = {
"app/recipes/erp/page.mdx": "2025-02-25T11:11:02.259Z",
"app/recipes/erp/odoo/page.mdx": "2025-02-25T11:10:05.938Z",
"app/commerce-modules/product/selling-products/page.mdx": "2025-02-13T13:27:09.270Z",
"references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.draftOrder/page.mdx": "2025-04-11T09:04:54.745Z",
"references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.draftOrder/page.mdx": "2025-04-11T13:17:47.049Z",
"references/js_sdk/admin/Client/methods/js_sdk.admin.Client.throwError_/page.mdx": "2025-02-24T10:48:47.018Z",
"references/js_sdk/admin/CustomStorage/methods/js_sdk.admin.CustomStorage.getItem/page.mdx": "2025-02-24T10:48:47.069Z",
"references/js_sdk/admin/CustomStorage/methods/js_sdk.admin.CustomStorage.removeItem/page.mdx": "2025-02-24T10:48:47.072Z",
"references/js_sdk/admin/CustomStorage/methods/js_sdk.admin.CustomStorage.setItem/page.mdx": "2025-02-24T10:48:47.071Z",
"references/js_sdk/admin/DraftOrder/methods/js_sdk.admin.DraftOrder.create/page.mdx": "2025-04-11T09:04:54.075Z",
"references/js_sdk/admin/DraftOrder/methods/js_sdk.admin.DraftOrder.create/page.mdx": "2025-04-11T13:17:46.773Z",
"references/js_sdk/admin/DraftOrder/methods/js_sdk.admin.DraftOrder.list/page.mdx": "2025-04-11T09:04:54.071Z",
"references/js_sdk/admin/DraftOrder/methods/js_sdk.admin.DraftOrder.retrieve/page.mdx": "2025-04-11T09:04:54.068Z",
"references/js_sdk/admin/DraftOrder/methods/js_sdk.admin.DraftOrder.update/page.mdx": "2025-04-11T09:04:54.079Z",
"references/js_sdk/admin/DraftOrder/methods/js_sdk.admin.DraftOrder.update/page.mdx": "2025-04-11T13:17:46.774Z",
"references/js_sdk/admin/DraftOrder/properties/js_sdk.admin.DraftOrder.client/page.mdx": "2025-02-24T10:48:44.111Z",
"references/js_sdk/admin/classes/js_sdk.admin.DraftOrder/page.mdx": "2025-04-11T09:04:54.020Z",
"references/js_sdk/admin/interfaces/js_sdk.admin.CustomStorage/page.mdx": "2025-02-24T10:48:47.068Z",
@@ -6079,22 +6079,22 @@ export const generatedEditDates = {
"references/js_sdk/admin/Customer/methods/js_sdk.admin.Customer.listAddresses/page.mdx": "2025-04-11T09:04:54.019Z",
"references/js_sdk/admin/Customer/methods/js_sdk.admin.Customer.retrieveAddress/page.mdx": "2025-04-11T09:04:54.017Z",
"references/js_sdk/admin/Customer/methods/js_sdk.admin.Customer.updateAddress/page.mdx": "2025-04-11T09:04:54.013Z",
"references/js_sdk/admin/DraftOrder/methods/js_sdk.admin.DraftOrder.addItems/page.mdx": "2025-04-11T09:04:54.084Z",
"references/js_sdk/admin/DraftOrder/methods/js_sdk.admin.DraftOrder.addPromotions/page.mdx": "2025-04-11T09:04:54.095Z",
"references/js_sdk/admin/DraftOrder/methods/js_sdk.admin.DraftOrder.addShippingMethod/page.mdx": "2025-04-11T09:04:54.100Z",
"references/js_sdk/admin/DraftOrder/methods/js_sdk.admin.DraftOrder.beginEdit/page.mdx": "2025-04-11T09:04:54.111Z",
"references/js_sdk/admin/DraftOrder/methods/js_sdk.admin.DraftOrder.cancelEdit/page.mdx": "2025-04-11T09:04:54.113Z",
"references/js_sdk/admin/DraftOrder/methods/js_sdk.admin.DraftOrder.confirmEdit/page.mdx": "2025-04-11T09:04:54.119Z",
"references/js_sdk/admin/DraftOrder/methods/js_sdk.admin.DraftOrder.convertToOrder/page.mdx": "2025-04-11T09:04:54.082Z",
"references/js_sdk/admin/DraftOrder/methods/js_sdk.admin.DraftOrder.removeActionItem/page.mdx": "2025-04-11T09:04:54.090Z",
"references/js_sdk/admin/DraftOrder/methods/js_sdk.admin.DraftOrder.removeActionShippingMethod/page.mdx": "2025-04-11T09:04:54.106Z",
"references/js_sdk/admin/DraftOrder/methods/js_sdk.admin.DraftOrder.removePromotions/page.mdx": "2025-04-11T09:04:54.097Z",
"references/js_sdk/admin/DraftOrder/methods/js_sdk.admin.DraftOrder.requestEdit/page.mdx": "2025-04-11T09:04:54.117Z",
"references/js_sdk/admin/DraftOrder/methods/js_sdk.admin.DraftOrder.updateActionItem/page.mdx": "2025-04-11T09:04:54.087Z",
"references/js_sdk/admin/DraftOrder/methods/js_sdk.admin.DraftOrder.updateActionShippingMethod/page.mdx": "2025-04-11T09:04:54.103Z",
"references/js_sdk/admin/DraftOrder/methods/js_sdk.admin.DraftOrder.updateItem/page.mdx": "2025-04-11T09:04:54.092Z",
"references/js_sdk/admin/DraftOrder/methods/js_sdk.admin.DraftOrder.updateShippingMethod/page.mdx": "2025-04-11T09:04:54.108Z",
"references/js_sdk/admin/Order/methods/js_sdk.admin.Order.createCreditLine/page.mdx": "2025-04-11T09:04:55.418Z",
"references/js_sdk/admin/DraftOrder/methods/js_sdk.admin.DraftOrder.addItems/page.mdx": "2025-04-11T13:17:46.776Z",
"references/js_sdk/admin/DraftOrder/methods/js_sdk.admin.DraftOrder.addPromotions/page.mdx": "2025-04-11T13:17:46.782Z",
"references/js_sdk/admin/DraftOrder/methods/js_sdk.admin.DraftOrder.addShippingMethod/page.mdx": "2025-04-11T13:17:46.784Z",
"references/js_sdk/admin/DraftOrder/methods/js_sdk.admin.DraftOrder.beginEdit/page.mdx": "2025-04-11T13:17:46.789Z",
"references/js_sdk/admin/DraftOrder/methods/js_sdk.admin.DraftOrder.cancelEdit/page.mdx": "2025-04-11T13:17:46.790Z",
"references/js_sdk/admin/DraftOrder/methods/js_sdk.admin.DraftOrder.confirmEdit/page.mdx": "2025-04-11T13:17:46.792Z",
"references/js_sdk/admin/DraftOrder/methods/js_sdk.admin.DraftOrder.convertToOrder/page.mdx": "2025-04-11T13:17:46.775Z",
"references/js_sdk/admin/DraftOrder/methods/js_sdk.admin.DraftOrder.removeActionItem/page.mdx": "2025-04-11T13:17:46.779Z",
"references/js_sdk/admin/DraftOrder/methods/js_sdk.admin.DraftOrder.removeActionShippingMethod/page.mdx": "2025-04-11T13:17:46.786Z",
"references/js_sdk/admin/DraftOrder/methods/js_sdk.admin.DraftOrder.removePromotions/page.mdx": "2025-04-11T13:17:46.783Z",
"references/js_sdk/admin/DraftOrder/methods/js_sdk.admin.DraftOrder.requestEdit/page.mdx": "2025-04-11T13:17:46.791Z",
"references/js_sdk/admin/DraftOrder/methods/js_sdk.admin.DraftOrder.updateActionItem/page.mdx": "2025-04-11T13:17:46.778Z",
"references/js_sdk/admin/DraftOrder/methods/js_sdk.admin.DraftOrder.updateActionShippingMethod/page.mdx": "2025-04-11T13:17:46.785Z",
"references/js_sdk/admin/DraftOrder/methods/js_sdk.admin.DraftOrder.updateItem/page.mdx": "2025-04-11T13:17:46.780Z",
"references/js_sdk/admin/DraftOrder/methods/js_sdk.admin.DraftOrder.updateShippingMethod/page.mdx": "2025-04-11T13:17:46.788Z",
"references/js_sdk/admin/Order/methods/js_sdk.admin.Order.createCreditLine/page.mdx": "2025-04-11T13:17:47.326Z",
"references/js_sdk/admin/Plugin/methods/js_sdk.admin.Plugin.list/page.mdx": "2025-04-11T09:04:55.576Z",
"references/js_sdk/admin/Plugin/properties/js_sdk.admin.Plugin.client/page.mdx": "2025-04-11T09:04:55.574Z",
"references/js_sdk/admin/classes/js_sdk.admin.Plugin/page.mdx": "2025-04-11T09:04:55.529Z",

2
www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.claim/page.mdx
View File

@@ -561,7 +561,7 @@ API route.
### Example
```ts
* sdk.admin.claim.addOutboundShipping(
sdk.admin.claim.addOutboundShipping(
"claim_123",
{
shipping_option_id: "so_123",

53
www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.draftOrder/page.mdx
View File

File diff suppressed because one or more lines are too long

11
www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.invite/page.mdx
View File

@@ -25,25 +25,20 @@ API route.
### Example
```ts
const token = await sdk.auth.register("user", "emailpass", {
await sdk.auth.register("user", "emailpass", {
email: "user@gmail.com",
password: "supersecret"
})
sdk.admin.invite.accept(
// all subsequent requests will use the token in the header
const { user } = await sdk.admin.invite.accept(
{
email: "user@gmail.com",
first_name: "John",
last_name: "Smith",
invite_token: "12345..."
},
{
Authorization: `Bearer ${token}`
}
)
.then(({ user }) => {
console.log(user)
})
```
### Parameters

23
www/apps/resources/references/js_sdk/admin/Admin/properties/js_sdk.admin.Admin.order/page.mdx
View File

File diff suppressed because one or more lines are too long

2
www/apps/resources/references/js_sdk/admin/Claim/methods/js_sdk.admin.Claim.addOutboundShipping/page.mdx
View File

@@ -12,7 +12,7 @@ API route.
## Example
```ts
* sdk.admin.claim.addOutboundShipping(
sdk.admin.claim.addOutboundShipping(
"claim_123",
{
shipping_option_id: "so_123",

2
www/apps/resources/references/js_sdk/admin/DraftOrder/methods/js_sdk.admin.DraftOrder.addItems/page.mdx
View File

@@ -7,8 +7,6 @@ This method adds items to a draft order. It sends a request to the
## Example
To add items to a draft order:
```ts
sdk.admin.draftOrder.addItems("order_123", {
items: [

2
www/apps/resources/references/js_sdk/admin/DraftOrder/methods/js_sdk.admin.DraftOrder.addPromotions/page.mdx
View File

@@ -7,8 +7,6 @@ This method adds promotions to a draft order. It sends a request to the
## Example
To add promotions to a draft order:
```ts
sdk.admin.draftOrder.addPromotions("order_123", {
promo_codes: ["PROMO_CODE_1", "PROMO_CODE_2"],

2
www/apps/resources/references/js_sdk/admin/DraftOrder/methods/js_sdk.admin.DraftOrder.addShippingMethod/page.mdx
View File

@@ -7,8 +7,6 @@ This method adds a shipping method to a draft order. It sends a request to the
## Example
To add a shipping method to a draft order:
```ts
sdk.admin.draftOrder.addShippingMethod("order_123", {
shipping_option_id: "shipping_option_123",

2
www/apps/resources/references/js_sdk/admin/DraftOrder/methods/js_sdk.admin.DraftOrder.beginEdit/page.mdx
View File

@@ -7,8 +7,6 @@ This method begins an edit to a draft order. It sends a request to the
## Example
To begin an edit to a draft order:
```ts
sdk.admin.draftOrder.beginEdit("order_123")
.then(({ draft_order_preview }) => {

2
www/apps/resources/references/js_sdk/admin/DraftOrder/methods/js_sdk.admin.DraftOrder.cancelEdit/page.mdx
View File

@@ -7,8 +7,6 @@ This method cancels an edit to a draft order. It sends a request to the
## Example
To cancel an edit to a draft order:
```ts
sdk.admin.draftOrder.cancelEdit("order_123")
.then(({ id, object, deleted }) => {

2
www/apps/resources/references/js_sdk/admin/DraftOrder/methods/js_sdk.admin.DraftOrder.confirmEdit/page.mdx
View File

@@ -7,8 +7,6 @@ This method confirms an edit to a draft order. It sends a request to the
## Example
To confirm an edit to a draft order:
```ts
sdk.admin.draftOrder.confirmEdit("order_123")
.then(({ draft_order_preview }) => {

3
www/apps/resources/references/js_sdk/admin/DraftOrder/methods/js_sdk.admin.DraftOrder.convertToOrder/page.mdx
View File

@@ -7,13 +7,12 @@ This method converts a draft order to an order. It sends a request to the
## Example
To convert a draft order to an order:
```ts
sdk.admin.draftOrder.convertToOrder("order_123")
.then(({ order }) => {
console.log(order)
})
```
## Parameters

2
www/apps/resources/references/js_sdk/admin/DraftOrder/methods/js_sdk.admin.DraftOrder.create/page.mdx
View File

@@ -7,8 +7,6 @@ This method creates a draft order. It sends a request to the
## Example
To create a draft order:
```ts
sdk.admin.draftOrder.create({
email: "test@test.com",

2
www/apps/resources/references/js_sdk/admin/DraftOrder/methods/js_sdk.admin.DraftOrder.removeActionItem/page.mdx
View File

@@ -7,8 +7,6 @@ This method removes an item that is part of an action in a draft order. It sends
## Example
To remove an item that is part of an action in a draft order:
```ts
sdk.admin.draftOrder.removeActionItem("order_123", "action_123")
.then(({ draft_order_preview }) => {

2
www/apps/resources/references/js_sdk/admin/DraftOrder/methods/js_sdk.admin.DraftOrder.removeActionShippingMethod/page.mdx
View File

@@ -7,8 +7,6 @@ This method removes a shipping method from a draft order. It sends a request to
## Example
To remove a shipping method from a draft order:
```ts
sdk.admin.draftOrder.removeShippingMethod("order_123", "action_123")
.then(({ draft_order_preview }) => {

2
www/apps/resources/references/js_sdk/admin/DraftOrder/methods/js_sdk.admin.DraftOrder.removePromotions/page.mdx
View File

@@ -7,8 +7,6 @@ This method removes promotions from a draft order. It sends a request to the
## Example
To remove promotions from a draft order:
```ts
sdk.admin.draftOrder.removePromotions("order_123", {
promo_codes: ["PROMO_CODE_1", "PROMO_CODE_2"],

2
www/apps/resources/references/js_sdk/admin/DraftOrder/methods/js_sdk.admin.DraftOrder.requestEdit/page.mdx
View File

@@ -7,8 +7,6 @@ This method requests an edit to a draft order. It sends a request to the
## Example
To request an edit to a draft order:
```ts
sdk.admin.draftOrder.requestEdit("order_123")
.then(({ draft_order_preview }) => {

2
www/apps/resources/references/js_sdk/admin/DraftOrder/methods/js_sdk.admin.DraftOrder.update/page.mdx
View File

@@ -7,8 +7,6 @@ This method updates a draft order. It sends a request to the
## Example
To update a draft order:
```ts
sdk.admin.draftOrder.update("order_123", {
email: "test@test.com",

2
www/apps/resources/references/js_sdk/admin/DraftOrder/methods/js_sdk.admin.DraftOrder.updateActionItem/page.mdx
View File

@@ -7,8 +7,6 @@ This method updates an item that is part of an action in a draft order. It sends
## Example
To update an item that is part of an action in a draft order:
```ts
sdk.admin.draftOrder.updateActionItem("order_123", "action_123", {
quantity: 2,

2
www/apps/resources/references/js_sdk/admin/DraftOrder/methods/js_sdk.admin.DraftOrder.updateActionShippingMethod/page.mdx
View File

@@ -7,8 +7,6 @@ This method updates a shipping method in a draft order. It sends a request to th
## Example
To update a shipping method in a draft order:
```ts
sdk.admin.draftOrder.updateShippingMethod("order_123", "action_123", {
shipping_option_id: "shipping_option_123",

4
www/apps/resources/references/js_sdk/admin/DraftOrder/methods/js_sdk.admin.DraftOrder.updateItem/page.mdx
View File

File diff suppressed because one or more lines are too long

18
www/apps/resources/references/js_sdk/admin/DraftOrder/methods/js_sdk.admin.DraftOrder.updateShippingMethod/page.mdx
View File

File diff suppressed because one or more lines are too long

11
www/apps/resources/references/js_sdk/admin/Invite/methods/js_sdk.admin.Invite.accept/page.mdx
View File

@@ -12,25 +12,20 @@ API route.
## Example
```ts
const token = await sdk.auth.register("user", "emailpass", {
await sdk.auth.register("user", "emailpass", {
email: "user@gmail.com",
password: "supersecret"
})
sdk.admin.invite.accept(
// all subsequent requests will use the token in the header
const { user } = await sdk.admin.invite.accept(
{
email: "user@gmail.com",
first_name: "John",
last_name: "Smith",
invite_token: "12345..."
},
{
Authorization: `Bearer ${token}`
}
)
.then(({ user }) => {
console.log(user)
})
```
## Parameters

23
www/apps/resources/references/js_sdk/admin/Order/methods/js_sdk.admin.Order.createCreditLine/page.mdx
View File

File diff suppressed because one or more lines are too long

12093
www/utils/generated/typedoc-json-output/js-sdk.json
View File

File diff suppressed because it is too large Load Diff