docs: update Typedoc and regenerate references (#1994)
* generated new services reference * changed from automatic push to automated pull request * updated typedoc, regenerated JS Client reference * regenerated the reference after updating typedoc * added action for js client
This commit is contained in:
116
docs/content/references/js-client/modules/internal-27.md
Normal file
116
docs/content/references/js-client/modules/internal-27.md
Normal file
@@ -0,0 +1,116 @@
|
||||
# Namespace: internal
|
||||
|
||||
## Classes
|
||||
|
||||
- [AdminCreateUserRequest](../classes/internal-27.AdminCreateUserRequest.md)
|
||||
- [AdminResetPasswordRequest](../classes/internal-27.AdminResetPasswordRequest.md)
|
||||
- [AdminResetPasswordTokenRequest](../classes/internal-27.AdminResetPasswordTokenRequest.md)
|
||||
- [AdminUpdateUserRequest](../classes/internal-27.AdminUpdateUserRequest.md)
|
||||
|
||||
## Type Aliases
|
||||
|
||||
### AdminCreateUserPayload
|
||||
|
||||
Ƭ **AdminCreateUserPayload**: `Omit`<[`AdminCreateUserRequest`](../classes/internal-27.AdminCreateUserRequest.md), ``"role"``\> \| { `role?`: [`CreateUserRoles`](internal-27.md#createuserroles) }
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa-js/src/typings.ts:31](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/typings.ts#L31)
|
||||
|
||||
___
|
||||
|
||||
### AdminUpdateUserPayload
|
||||
|
||||
Ƭ **AdminUpdateUserPayload**: `Omit`<[`AdminUpdateUserRequest`](../classes/internal-27.AdminUpdateUserRequest.md), ``"role"``\> & { `role?`: [`UpdateUserRoles`](internal-27.md#updateuserroles) }
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa-js/src/typings.ts:41](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/typings.ts#L41)
|
||||
|
||||
___
|
||||
|
||||
### AdminUserRes
|
||||
|
||||
Ƭ **AdminUserRes**: `Object`
|
||||
|
||||
#### Type declaration
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `user` | `Omit`<[`User`](../classes/internal-1.User.md), ``"password_hash"``\> |
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/users/index.d.ts:6
|
||||
|
||||
___
|
||||
|
||||
### AdminUsersListRes
|
||||
|
||||
Ƭ **AdminUsersListRes**: `Object`
|
||||
|
||||
#### Type declaration
|
||||
|
||||
| Name | Type |
|
||||
| :------ | :------ |
|
||||
| `users` | `Omit`<[`User`](../classes/internal-1.User.md), ``"password_hash"``\>[] |
|
||||
|
||||
#### Defined in
|
||||
|
||||
medusa/dist/api/routes/admin/users/index.d.ts:9
|
||||
|
||||
___
|
||||
|
||||
### CreateUserRoles
|
||||
|
||||
Ƭ **CreateUserRoles**: \`${CreateUserRolesEnum}\`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa-js/src/typings.ts:28](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/typings.ts#L28)
|
||||
|
||||
___
|
||||
|
||||
### CreateUserRolesEnum
|
||||
|
||||
Ƭ **CreateUserRolesEnum**: [`NoUndefined`](internal-27.md#noundefined)<[`AdminCreateUserRequest`](../classes/internal-27.AdminCreateUserRequest.md)[``"role"``]\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa-js/src/typings.ts:25](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/typings.ts#L25)
|
||||
|
||||
___
|
||||
|
||||
### NoUndefined
|
||||
|
||||
Ƭ **NoUndefined**<`T`\>: `T` extends `undefined` ? `never` : `T`
|
||||
|
||||
#### Type parameters
|
||||
|
||||
| Name |
|
||||
| :------ |
|
||||
| `T` |
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa-js/src/typings.ts:23](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/typings.ts#L23)
|
||||
|
||||
___
|
||||
|
||||
### UpdateUserRoles
|
||||
|
||||
Ƭ **UpdateUserRoles**: \`${UpdateUserRolesEnum}\`
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa-js/src/typings.ts:39](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/typings.ts#L39)
|
||||
|
||||
___
|
||||
|
||||
### UpdateUserRolesEnum
|
||||
|
||||
Ƭ **UpdateUserRolesEnum**: [`NoUndefined`](internal-27.md#noundefined)<[`AdminUpdateUserRequest`](../classes/internal-27.AdminUpdateUserRequest.md)[``"role"``]\>
|
||||
|
||||
#### Defined in
|
||||
|
||||
[medusa-js/src/typings.ts:37](https://github.com/medusajs/medusa/blob/e38dd7f6/packages/medusa-js/src/typings.ts#L37)
|
||||
Reference in New Issue
Block a user