acquia-dam-sdk

---

acquia-dam-sdk / Components / UsersApi

Class: UsersApi

Constructors

new UsersApi()

new UsersApi(client): UsersApi

Create an instance of the UsersApi class

Query for information about users

Parameters

client

ApiClient

Provide an instance of ApiClient.

Returns

UsersApi

See

• https://docs.acquia.com/acquia-dam/api-v2#tag/Users
• https://docs.acquia.com/acquia-dam/api-v1#tag/Users-and-Contacts

Defined in

src/apis/users/api.ts:16

Methods

getContact()

getContact(): Promise<GetContactResult>

Return the calling user's contact. The UUID field may be used as a recipient to create an order.

Returns

Promise<GetContactResult>

Promise containing the calling user's contact information

See

https://docs.acquia.com/acquia-dam/api-v1#tag/Users-and-Contacts/operation/getUserAddress

Defined in

src/apis/users/api.ts:45

---

getUser()

getUser(id?): Promise<GetUserResult>

Returns information about a user

Parameters

id?

string

Retrieve a specific user's information. If omitted, information for the user associated with the provided access token will be returned.

Returns

Promise<GetUserResult>

Promise containing the requested user information

See

https://docs.acquia.com/acquia-dam/api-v2#tag/Users/operation/getUserById

Defined in

src/apis/users/api.ts:26