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

chore(docs): Generated JS Client Reference (#5334)

Browse Source 
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action

Co-authored-by: Shahed Nasser <27354907+shahednasser@users.noreply.github.com>
This commit is contained in:
github-actions[bot]
2023-10-10 17:47:07 +00:00
committed by GitHub
co-authored by Shahed Nasser
parent 378ca1b36e
commit daea35fe73
1091 changed files with 140791 additions and 25954 deletions
Download Patch File Download Diff File Expand all files Collapse all files
www/apps/docs/content/references/js-client/modules/internal-11.md
+66 -19
View File
@@ -1,34 +1,81 @@
# Namespace: internal
---
displayed_sidebar: jsClientSidebar
---
## Classes
- [AdminGetNotesParams](../classes/internal-11.AdminGetNotesParams.md)
- [AdminPostNotesNoteReq](../classes/internal-11.AdminPostNotesNoteReq.md)
- [AdminPostNotesReq](../classes/internal-11.AdminPostNotesReq.md)
- [Note](../classes/internal-11.Note.md)
# Module: internal
## Type Aliases
### AdminNotesListRes
### AdminCreateUserPayload
Ƭ **AdminNotesListRes**: [`PaginatedResponse`](internal-2.md#paginatedresponse) & { `notes`: [`Note`](../classes/internal-11.Note.md)[] }
Ƭ **AdminCreateUserPayload**: [`Omit`](internal-1.md#omit)<[`AdminCreateUserRequest`](../classes/internal-8.internal.AdminCreateUserRequest.md), ``"role"``\> \| { `role?`: [`CreateUserRoles`](internal-11.md#createuserroles) }
#### Defined in
medusa/dist/api/routes/admin/notes/index.d.ts:10
[packages/medusa-js/src/typings.ts:31](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/typings.ts#L31)
___
### AdminNotesRes
### AdminUpdateUserPayload
Ƭ **AdminNotesRes**: `Object`
#### Type declaration
| Name | Type |
| :------ | :------ |
| `note` | [`Note`](../classes/internal-11.Note.md) |
Ƭ **AdminUpdateUserPayload**: [`Omit`](internal-1.md#omit)<[`AdminUpdateUserRequest`](../classes/internal-8.internal.AdminUpdateUserRequest.md), ``"role"``\> & { `role?`: [`UpdateUserRoles`](internal-11.md#updateuserroles) }
#### Defined in
medusa/dist/api/routes/admin/notes/index.d.ts:6
[packages/medusa-js/src/typings.ts:41](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/typings.ts#L41)
___
### CreateUserRoles
Ƭ **CreateUserRoles**: \`${CreateUserRolesEnum}\`
#### Defined in
[packages/medusa-js/src/typings.ts:28](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/typings.ts#L28)
___
### CreateUserRolesEnum
Ƭ **CreateUserRolesEnum**: [`NoUndefined`](internal-11.md#noundefined)<[`AdminCreateUserRequest`](../classes/internal-8.internal.AdminCreateUserRequest.md)[``"role"``]\>
#### Defined in
[packages/medusa-js/src/typings.ts:25](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/typings.ts#L25)
___
### NoUndefined
Ƭ **NoUndefined**<`T`\>: `T` extends `undefined` ? `never` : `T`
#### Type parameters
| Name |
| :------ |
| `T` |
#### Defined in
[packages/medusa-js/src/typings.ts:23](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/typings.ts#L23)
___
### UpdateUserRoles
Ƭ **UpdateUserRoles**: \`${UpdateUserRolesEnum}\`
#### Defined in
[packages/medusa-js/src/typings.ts:39](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/typings.ts#L39)
___
### UpdateUserRolesEnum
Ƭ **UpdateUserRolesEnum**: [`NoUndefined`](internal-11.md#noundefined)<[`AdminUpdateUserRequest`](../classes/internal-8.internal.AdminUpdateUserRequest.md)[``"role"``]\>
#### Defined in
[packages/medusa-js/src/typings.ts:37](https://github.com/medusajs/medusa/blob/c4ac5e6959/packages/medusa-js/src/typings.ts#L37)