docs: updated js client reference (#2414)

* docs: updated js client reference * docs: fixed link
2022-10-11 16:32:41 +03:00
parent b3ebc78b95
commit 8ca9354c50
384 changed files with 5705 additions and 4184 deletions
@@ -2,36 +2,115 @@

 ## Classes

- [StorePostAuthReq](../classes/internal-29.StorePostAuthReq.md)
+- [AdminCreateUserRequest](../classes/internal-29.AdminCreateUserRequest.md)
+- [AdminResetPasswordRequest](../classes/internal-29.AdminResetPasswordRequest.md)
+- [AdminResetPasswordTokenRequest](../classes/internal-29.AdminResetPasswordTokenRequest.md)
+- [AdminUpdateUserRequest](../classes/internal-29.AdminUpdateUserRequest.md)

 ## Type Aliases

-### StoreAuthRes
+### AdminCreateUserPayload

-Ƭ **StoreAuthRes**: `Object`
-
-#### Type declaration
-
-| Name | Type |
-| :------ | :------ |
-| `customer` | [`Customer`](../classes/internal.Customer.md) |
+Ƭ **AdminCreateUserPayload**: `Omit`<[`AdminCreateUserRequest`](../classes/internal-29.AdminCreateUserRequest.md), ``"role"``\> \| { `role?`: [`CreateUserRoles`](internal-29.md#createuserroles)  }

 #### Defined in

-medusa/dist/api/routes/store/auth/index.d.ts:4
+[medusa-js/src/typings.ts:31](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/typings.ts#L31)

 ___

-### StoreGetAuthEmailRes
+### AdminUpdateUserPayload

-Ƭ **StoreGetAuthEmailRes**: `Object`
+Ƭ **AdminUpdateUserPayload**: `Omit`<[`AdminUpdateUserRequest`](../classes/internal-29.AdminUpdateUserRequest.md), ``"role"``\> & { `role?`: [`UpdateUserRoles`](internal-29.md#updateuserroles)  }
+
+#### Defined in
+
+[medusa-js/src/typings.ts:41](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/typings.ts#L41)
+
+___
+
+### AdminUserRes
+
+Ƭ **AdminUserRes**: `Object`

 #### Type declaration

 | Name | Type |
 | :------ | :------ |
-| `exists` | `boolean` |
+| `user` | `Omit`<[`User`](../classes/internal-1.User.md), ``"password_hash"``\> |

 #### Defined in

-medusa/dist/api/routes/store/auth/index.d.ts:7
+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/53e34d33d/packages/medusa-js/src/typings.ts#L28)
+
+___
+
+### CreateUserRolesEnum
+
+Ƭ **CreateUserRolesEnum**: [`NoUndefined`](internal-29.md#noundefined)<[`AdminCreateUserRequest`](../classes/internal-29.AdminCreateUserRequest.md)[``"role"``]\>
+
+#### Defined in
+
+[medusa-js/src/typings.ts:25](https://github.com/medusajs/medusa/blob/53e34d33d/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/53e34d33d/packages/medusa-js/src/typings.ts#L23)
+
+___
+
+### UpdateUserRoles
+
+Ƭ **UpdateUserRoles**: \`${UpdateUserRolesEnum}\`
+
+#### Defined in
+
+[medusa-js/src/typings.ts:39](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/typings.ts#L39)
+
+___
+
+### UpdateUserRolesEnum
+
+Ƭ **UpdateUserRolesEnum**: [`NoUndefined`](internal-29.md#noundefined)<[`AdminUpdateUserRequest`](../classes/internal-29.AdminUpdateUserRequest.md)[``"role"``]\>
+
+#### Defined in
+
+[medusa-js/src/typings.ts:37](https://github.com/medusajs/medusa/blob/53e34d33d/packages/medusa-js/src/typings.ts#L37)