Class UserService

Index

Constructors

Properties

Methods

getUser updateUser

Constructors

constructor

new UserService(adapter: AuthenticatedAdapter): UserService
Parameters
- adapter: AuthenticatedAdapter
Returns UserService
- Defined in src/services/UserService.ts:5

Properties

`Protected` `Readonly`adapter

adapter: AuthenticatedAdapter

Methods

getUser

getUser(summary: false): Promise<User>
Get the full user profile
Parameters
- summary: false
Returns Promise<User>
See
https://devdocs.magento.com/marketplace/eqp/v1/users.html#profile-data
Example
```
eqp.getUser();
```
- Defined in src/services/UserService.ts:12
getUser(summary: true): Promise<UserSummary>
Get a summarized version of the user profile
Parameters
- summary: true
Returns Promise<UserSummary>
See
https://devdocs.magento.com/marketplace/eqp/v1/users.html#profile-data
Example
```
eqp.getUser(true);
```
- Defined in src/services/UserService.ts:19

updateUser

updateUser(data: Partial<User & { action?: "submit" | "draft" }>): Promise<User>
Update the profile of the authenticated user.
Parameters
- data: Partial<User & { action?: "submit" | "draft" }>
Returns Promise<User>
See
https://devdocs.magento.com/marketplace/eqp/v1/users.html#update-profile-data
Example
```
eqp.updateUser({ action: 'submit', personal_profile: { bio: 'Changed with netresearch/node-magento-eqp' } })
```
- Defined in src/services/UserService.ts:30