asyavee/medusa-store
1
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity
Files
cdd42dbdcd9e4609dd784dcdccf1785be39032f2
medusa-store/www/apps/docs/content/references/js-client/classes/AdminNotesResource.mdx
github-actions[bot] cdd42dbdcd chore(docs): Generated References (#5743) 
Generated the following references:
- `entities`
- `inventory`
- `js-client`
- `pricing`
- `product`
- `services`
- `stock-location`
- `workflows`

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
2023-11-27 18:58:52 +00:00

888 lines
26 KiB
Plaintext
Raw Blame History

---
displayed_sidebar: jsClientSidebar
slug: /references/js-client/AdminNotesResource
---
import ParameterTypes from "@site/src/components/ParameterTypes"
# AdminNotesResource
This class is used to send requests to [Admin Note API Routes](https://docs.medusajs.com/api/admin#notes). All its method
are available in the JS Client under the `medusa.admin.notes` property.
All methods in this class require [user authentication](AdminAuthResource.mdx#createsession).
Notes are created by admins and can be associated with any resource. For example, an admin can add a note to an order for additional details or remarks.
## Methods
#### create
Create a Note which can be associated with any resource.
##### Example
```ts
import Medusa from "@medusajs/medusa-js"
const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
// must be previously logged in or use api token
medusa.admin.notes
.create({
resource_id,
resource_type: "order",
value: "We delivered this order",
})
.then(({ note }) => {
console.log(note.id)
})
```
##### Parameters
<ParameterTypes parameters={[
{
"name": "payload",
"type": "[AdminPostNotesReq](../internal/classes/internal.AdminPostNotesReq.mdx)",
"description": "The note to be created.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "resource_id",
"type": "`string`",
"description": "The ID of the resource which the Note relates to. For example, an order ID.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "resource_type",
"type": "`string`",
"description": "The type of resource which the Note relates to. For example, `order`.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "value",
"type": "`string`",
"description": "The content of the Note to create.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "customHeaders",
"type": "`Record<string, any>`",
"description": "Custom headers to attach to the request.",
"optional": false,
"defaultValue": "{}",
"expandable": false,
"children": []
}
]} />
##### Returns
<ParameterTypes parameters={[
{
"name": "ResponsePromise",
"type": "[ResponsePromise](../internal/types/internal.ResponsePromise.mdx)&#60;[AdminNotesRes](../internal/types/internal.AdminNotesRes.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "Resolves to the note's details.",
"expandable": false,
"children": [
{
"name": "AdminNotesRes",
"type": "`object`",
"description": "The note's details.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "note",
"type": "[Note](../internal/classes/internal.Note.mdx)",
"description": "Note details.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "author",
"type": "[User](../internal/classes/internal.User.mdx)",
"description": "The details of the user that created the note.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "author_id",
"type": "`string`",
"description": "The ID of the user that created the note.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "created_at",
"type": "`Date`",
"description": "The date with timezone at which the resource was created.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "deleted_at",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "id",
"type": "`string`",
"description": "The note's ID",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "metadata",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "resource_id",
"type": "`string`",
"description": "The ID of the resource that the Note refers to.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "resource_type",
"type": "`string`",
"description": "The type of resource that the Note refers to.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "updated_at",
"type": "`Date`",
"description": "The date with timezone at which the resource was updated.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "value",
"type": "`string`",
"description": "The contents of the note.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
}
]
}
]
}
]} />
___
#### delete
Delete a Note.
##### Example
```ts
import Medusa from "@medusajs/medusa-js"
const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
// must be previously logged in or use api token
medusa.admin.notes.delete(noteId).then(({ id, object, deleted }) => {
console.log(id)
})
```
##### Parameters
<ParameterTypes parameters={[
{
"name": "id",
"type": "`string`",
"description": "The note's ID.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "customHeaders",
"type": "`Record<string, any>`",
"description": "Custom headers to attach to the request.",
"optional": false,
"defaultValue": "{}",
"expandable": false,
"children": []
}
]} />
##### Returns
<ParameterTypes parameters={[
{
"name": "ResponsePromise",
"type": "[ResponsePromise](../internal/types/internal.ResponsePromise.mdx)&#60;[DeleteResponse](../internal/interfaces/internal.DeleteResponse.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "Resolves to the deletion operation's details.",
"expandable": false,
"children": [
{
"name": "deleted",
"type": "`boolean`",
"description": "Whether the item was deleted successfully.",
"optional": false,
"defaultValue": "true",
"expandable": false,
"children": []
},
{
"name": "id",
"type": "`string`",
"description": "The ID of the deleted item.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "object",
"type": "`string`",
"description": "The type of the deleted item.",
"optional": false,
"defaultValue": "product-collection",
"expandable": false,
"children": []
}
]
}
]} />
___
#### list
Retrieve a list of notes. The notes can be filtered by fields such as `resource_id` passed in the `query` parameter. The notes can also be paginated.
##### Example
To list notes:
```ts
import Medusa from "@medusajs/medusa-js"
const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
// must be previously logged in or use api token
medusa.admin.notes.list().then(({ notes, limit, offset, count }) => {
console.log(notes.length)
})
```
By default, only the first `50` records are retrieved. You can control pagination by specifying the `limit` and `offset` properties:
```ts
import Medusa from "@medusajs/medusa-js"
const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
// must be previously logged in or use api token
medusa.admin.notes
.list({
limit,
offset,
})
.then(({ notes, limit, offset, count }) => {
console.log(notes.length)
})
```
##### Parameters
<ParameterTypes parameters={[
{
"name": "query",
"type": "[AdminGetNotesParams](../internal/classes/internal.AdminGetNotesParams.mdx)",
"description": "Filters and pagination configurations applied on retrieved notes.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "limit",
"type": "`number`",
"description": "Limit the number of items returned in the list.",
"optional": false,
"defaultValue": "50",
"expandable": false,
"children": []
},
{
"name": "offset",
"type": "`number`",
"description": "The number of items to skip when retrieving a list.",
"optional": false,
"defaultValue": "0",
"expandable": false,
"children": []
},
{
"name": "resource_id",
"type": "`string`",
"description": "Resource ID to filter notes by.",
"optional": true,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "customHeaders",
"type": "`Record<string, any>`",
"description": "Custom headers to attach to the request.",
"optional": false,
"defaultValue": "{}",
"expandable": false,
"children": []
}
]} />
##### Returns
<ParameterTypes parameters={[
{
"name": "ResponsePromise",
"type": "[ResponsePromise](../internal/types/internal.ResponsePromise.mdx)&#60;[AdminNotesListRes](../internal/types/internal.AdminNotesListRes.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "Resolves to the list of notes with pagination fields.",
"expandable": false,
"children": [
{
"name": "AdminNotesListRes",
"type": "[PaginatedResponse](../internal/interfaces/internal.PaginatedResponse.mdx) & ``{ notes: [Note](../internal/classes/internal.Note.mdx)[] }``",
"description": "The list of notes with pagination fields.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "count",
"type": "`number`",
"description": "The total number of items available.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "limit",
"type": "`number`",
"description": "The maximum number of items that can be returned in the list.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "offset",
"type": "`number`",
"description": "The number of items skipped before the returned items in the list.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "notes",
"type": "[Note](../internal/classes/internal.Note.mdx)[]",
"description": "An array of notes",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "author",
"type": "[User](../internal/classes/internal.User.mdx)",
"description": "The details of the user that created the note.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "author_id",
"type": "`string`",
"description": "The ID of the user that created the note.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "created_at",
"type": "`Date`",
"description": "The date with timezone at which the resource was created.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "deleted_at",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "id",
"type": "`string`",
"description": "The note's ID",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "metadata",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "resource_id",
"type": "`string`",
"description": "The ID of the resource that the Note refers to.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "resource_type",
"type": "`string`",
"description": "The type of resource that the Note refers to.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "updated_at",
"type": "`Date`",
"description": "The date with timezone at which the resource was updated.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "value",
"type": "`string`",
"description": "The contents of the note.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
}
]
}
]
}
]} />
___
#### retrieve
Retrieve a note's details.
##### Example
```ts
import Medusa from "@medusajs/medusa-js"
const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
// must be previously logged in or use api token
medusa.admin.notes.retrieve(noteId).then(({ note }) => {
console.log(note.id)
})
```
##### Parameters
<ParameterTypes parameters={[
{
"name": "id",
"type": "`string`",
"description": "The note's ID.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "customHeaders",
"type": "`Record<string, any>`",
"description": "Custom headers to attach to the request.",
"optional": false,
"defaultValue": "{}",
"expandable": false,
"children": []
}
]} />
##### Returns
<ParameterTypes parameters={[
{
"name": "ResponsePromise",
"type": "[ResponsePromise](../internal/types/internal.ResponsePromise.mdx)&#60;[AdminNotesRes](../internal/types/internal.AdminNotesRes.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "Resolves to the note's details.",
"expandable": false,
"children": [
{
"name": "AdminNotesRes",
"type": "`object`",
"description": "The note's details.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "note",
"type": "[Note](../internal/classes/internal.Note.mdx)",
"description": "Note details.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "author",
"type": "[User](../internal/classes/internal.User.mdx)",
"description": "The details of the user that created the note.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "author_id",
"type": "`string`",
"description": "The ID of the user that created the note.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "created_at",
"type": "`Date`",
"description": "The date with timezone at which the resource was created.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "deleted_at",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "id",
"type": "`string`",
"description": "The note's ID",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "metadata",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "resource_id",
"type": "`string`",
"description": "The ID of the resource that the Note refers to.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "resource_type",
"type": "`string`",
"description": "The type of resource that the Note refers to.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "updated_at",
"type": "`Date`",
"description": "The date with timezone at which the resource was updated.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "value",
"type": "`string`",
"description": "The contents of the note.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
}
]
}
]
}
]} />
___
#### update
Update a Note's details.
##### Example
```ts
import Medusa from "@medusajs/medusa-js"
const medusa = new Medusa({ baseUrl: MEDUSA_BACKEND_URL, maxRetries: 3 })
// must be previously logged in or use api token
medusa.admin.notes
.update(noteId, {
value: "We delivered this order",
})
.then(({ note }) => {
console.log(note.id)
})
```
##### Parameters
<ParameterTypes parameters={[
{
"name": "id",
"type": "`string`",
"description": "The note's ID.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "payload",
"type": "[AdminPostNotesNoteReq](../internal/classes/internal.AdminPostNotesNoteReq.mdx)",
"description": "The attributes to update in the note.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "value",
"type": "`string`",
"description": "The description of the Note.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
},
{
"name": "customHeaders",
"type": "`Record<string, any>`",
"description": "Custom headers to attach to the request.",
"optional": false,
"defaultValue": "{}",
"expandable": false,
"children": []
}
]} />
##### Returns
<ParameterTypes parameters={[
{
"name": "ResponsePromise",
"type": "[ResponsePromise](../internal/types/internal.ResponsePromise.mdx)&#60;[AdminNotesRes](../internal/types/internal.AdminNotesRes.mdx)&#62;",
"optional": false,
"defaultValue": "",
"description": "Resolves to the note's details.",
"expandable": false,
"children": [
{
"name": "AdminNotesRes",
"type": "`object`",
"description": "The note's details.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "note",
"type": "[Note](../internal/classes/internal.Note.mdx)",
"description": "Note details.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": [
{
"name": "author",
"type": "[User](../internal/classes/internal.User.mdx)",
"description": "The details of the user that created the note.",
"optional": false,
"defaultValue": "",
"expandable": true,
"children": []
},
{
"name": "author_id",
"type": "`string`",
"description": "The ID of the user that created the note.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "created_at",
"type": "`Date`",
"description": "The date with timezone at which the resource was created.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "deleted_at",
"type": "`null` \\| `Date`",
"description": "The date with timezone at which the resource was deleted.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "id",
"type": "`string`",
"description": "The note's ID",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "metadata",
"type": "`Record<string, unknown>`",
"description": "An optional key-value map with additional details",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "resource_id",
"type": "`string`",
"description": "The ID of the resource that the Note refers to.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "resource_type",
"type": "`string`",
"description": "The type of resource that the Note refers to.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "updated_at",
"type": "`Date`",
"description": "The date with timezone at which the resource was updated.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
},
{
"name": "value",
"type": "`string`",
"description": "The contents of the note.",
"optional": false,
"defaultValue": "",
"expandable": false,
"children": []
}
]
}
]
}
]
}
]} />
Reference in New Issue View Git Blame Copy Permalink