Documentation

Class

UserContactInfos

UserContactInfos(client, userId)

Class corresponding to Aworks project related part of the UserContactInfos Endpoints
Constructor

# new UserContactInfos(client, userId)

Endpoint constructor
Parameters:
Name Type Description
client Client
userId String The id of the user.
See:
  • [UserContactInfos in Awork API Docs](https://openapi.awork.com/#/UserContactInfos)

View Source endpoints/UserContactInfos.js, line 10

Classes

UserContactInfos

Methods

# async create(userContactInfoCreateModel) → {Promise.<UserContactInfo>}

Creates a new contact info for the user with the specified id.
Parameters:
Name Type Description
userContactInfoCreateModel UserContactInfoCreateModel The model to create a user contact information.

View Source endpoints/UserContactInfos.js, line 90

Promise.<UserContactInfo>

# async delete(contactInfoId) → {Promise.<void>}

Deletes the contact info of the user with the specified id.
Parameters:
Name Type Description
contactInfoId String The id of the contact info.

View Source endpoints/UserContactInfos.js, line 117

Promise.<void>

# async get(contactInfoId) → {Promise.<UserContactInfo>}

Returns the contact infos of the user with the specified id.
Parameters:
Name Type Description
contactInfoId String The id of the contact info.

View Source endpoints/UserContactInfos.js, line 29

Promise.<UserContactInfo>

# async list(options) → {Promise.<Array.<UserContactInfo>>}

Returns the contact infos of the user with the specified id.
Parameters:
Name Type Description
options ListOptions Pagination and filtering options

View Source endpoints/UserContactInfos.js, line 40

Promise.<Array.<UserContactInfo>>

# async update(contactInfoId, userContactInfoUpdateModel)

Updates the contact info of the user with the specified id.
Parameters:
Name Type Description
contactInfoId String The id of the contact info.
userContactInfoUpdateModel UserContactInfoUpdateModel The model to update a user contact information.

View Source endpoints/UserContactInfos.js, line 106