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

docs: TSDoc + reference of fulfillment service (#5761)

Browse Source
This commit is contained in:
Shahed Nasser
2023-11-29 11:58:08 +00:00
committed by GitHub
parent 8f25ed8a10
commit f802e2460f
1479 changed files with 30259 additions and 16135 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
www/apps/docs/content/references/js-client/classes/AdminCustomResource.mdx
View File

@@ -12,11 +12,11 @@ are available in the JS Client under the `medusa.admin.custom` property.
## Methods
#### delete
### delete
Send a `DELETE` request to a custom API Route. The method accepts a type parameters `TResponse` indicating the type of response, which defaults to `any`.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -27,7 +27,7 @@ medusa.admin.custom.delete(`/blog/posts/${postId}`).then(() => {
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -78,7 +78,7 @@ medusa.admin.custom.delete(`/blog/posts/${postId}`).then(() => {
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -104,12 +104,12 @@ medusa.admin.custom.delete(`/blog/posts/${postId}`).then(() => {
___
#### get
### get
Send a `GET` request to a custom API Route. The method accepts a tuple of type parameters: the first `TQuery` is the type of accepted query parameters,
which defaults to `Record<string, any>`; the second `TResponse` is the type of response, which defaults to `any`.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -126,7 +126,7 @@ medusa.admin.custom.get<Record<string, any>, PostsResponse>(
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -186,7 +186,7 @@ medusa.admin.custom.get<Record<string, any>, PostsResponse>(
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{
@@ -212,12 +212,12 @@ medusa.admin.custom.get<Record<string, any>, PostsResponse>(
___
#### post
### post
Send a `POST` request to a custom API Route. The method accepts a tuple of type parameters: the first `TPayload` is the type of accepted body parameters,
which defaults to `Record<string, any>`; the second `TResponse` is the type of response, which defaults to `any`.
##### Example
#### Example
```ts
import Medusa from "@medusajs/medusa-js"
@@ -240,7 +240,7 @@ medusa.admin.custom.post<PostRequest, PostResponse>(
})
```
##### Parameters
#### Parameters
<ParameterTypes parameters={[
{
@@ -300,7 +300,7 @@ medusa.admin.custom.post<PostRequest, PostResponse>(
}
]} />
##### Returns
#### Returns
<ParameterTypes parameters={[
{