Class UsersApi

Index

Constructors

Methods

archive archiveWithHttpInfo create createWithHttpInfo getById getByIdWithHttpInfo getPage getPageWithHttpInfo replace replaceWithHttpInfo

Constructors

constructor

new UsersApi(configuration, requestFactory?, responseProcessor?): UsersApi
Parameters
- configuration: Configuration<ObservableMiddleware>
- OptionalrequestFactory: UsersApiRequestFactory
- OptionalresponseProcessor: UsersApiResponseProcessor
Returns UsersApi
- Defined in codegen/settings/users/types/PromiseAPI.ts:139

Methods

archiveWithHttpInfo

archiveWithHttpInfo(userId, idProperty?, _options?): Promise<HttpInfo<void>>
Removes a user identified by userId. userId refers to the user's ID by default, or optionally email as specified by the IdProperty query param. Removes a user
Parameters
- userId: string
  Identifier of user to delete
- OptionalidProperty: "USER_ID" | "EMAIL"
  The name of a property with unique user values. Valid values are `USER_ID`(default) or `EMAIL`
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<void>>
- Defined in codegen/settings/users/types/PromiseAPI.ts:153

create

create(userProvisionRequest, _options?): Promise<PublicUser>
New users will only have minimal permissions, which is contacts-base. A welcome email will prompt them to set a password and log in to HubSpot. Adds a user
Parameters
- userProvisionRequest: UserProvisionRequest
- Optional_options: PromiseConfigurationOptions
Returns Promise<PublicUser>
- Defined in codegen/settings/users/types/PromiseAPI.ts:220

createWithHttpInfo

createWithHttpInfo(userProvisionRequest, _options?): Promise<HttpInfo<PublicUser>>
New users will only have minimal permissions, which is contacts-base. A welcome email will prompt them to set a password and log in to HubSpot. Adds a user
Parameters
- userProvisionRequest: UserProvisionRequest
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<PublicUser>>
- Defined in codegen/settings/users/types/PromiseAPI.ts:198

getById

getById(userId, idProperty?, _options?): Promise<PublicUser>
Retrieves a user identified by userId. userId refers to the user's ID by default, or optionally email as specified by the IdProperty query param. Retrieves a user
Parameters
- userId: string
  Identifier of user to retrieve
- OptionalidProperty: "USER_ID" | "EMAIL"
  The name of a property with unique user values. Valid values are `USER_ID`(default) or `EMAIL`
- Optional_options: PromiseConfigurationOptions
Returns Promise<PublicUser>
- Defined in codegen/settings/users/types/PromiseAPI.ts:266

getByIdWithHttpInfo

getByIdWithHttpInfo(userId, idProperty?, _options?): Promise<HttpInfo<PublicUser>>
Retrieves a user identified by userId. userId refers to the user's ID by default, or optionally email as specified by the IdProperty query param. Retrieves a user
Parameters
- userId: string
  Identifier of user to retrieve
- OptionalidProperty: "USER_ID" | "EMAIL"
  The name of a property with unique user values. Valid values are `USER_ID`(default) or `EMAIL`
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<PublicUser>>
- Defined in codegen/settings/users/types/PromiseAPI.ts:243

getPage

getPage(limit?, after?, _options?): Promise<CollectionResponsePublicUserForwardPaging>
Retrieves a list of users from an account Retrieves a list of users from an account
Parameters
- Optionallimit: number
  The number of users to retrieve
- Optionalafter: string
  Results will display maximum 100 users per page. Additional results will be on the next page.
- Optional_options: PromiseConfigurationOptions
Returns Promise<CollectionResponsePublicUserForwardPaging>
- Defined in codegen/settings/users/types/PromiseAPI.ts:312

getPageWithHttpInfo

getPageWithHttpInfo(limit?, after?, _options?): Promise<HttpInfo<CollectionResponsePublicUserForwardPaging>>
Retrieves a list of users from an account Retrieves a list of users from an account
Parameters
- Optionallimit: number
  The number of users to retrieve
- Optionalafter: string
  Results will display maximum 100 users per page. Additional results will be on the next page.
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<CollectionResponsePublicUserForwardPaging>>
- Defined in codegen/settings/users/types/PromiseAPI.ts:289

replace

replace(userId, publicUserUpdate, idProperty?, _options?): Promise<PublicUser>
Modifies a user identified by userId. userId refers to the user's ID by default, or optionally email as specified by the IdProperty query param. Modifies a user
Parameters
- userId: string
  Identifier of user to retrieve
- publicUserUpdate: PublicUserUpdate
- OptionalidProperty: "USER_ID" | "EMAIL"
  The name of a property with unique user values. Valid values are `USER_ID`(default) or `EMAIL`
- Optional_options: PromiseConfigurationOptions
Returns Promise<PublicUser>
- Defined in codegen/settings/users/types/PromiseAPI.ts:360

replaceWithHttpInfo

replaceWithHttpInfo(userId, publicUserUpdate, idProperty?, _options?): Promise<HttpInfo<PublicUser>>
Modifies a user identified by userId. userId refers to the user's ID by default, or optionally email as specified by the IdProperty query param. Modifies a user
Parameters
- userId: string
  Identifier of user to retrieve
- publicUserUpdate: PublicUserUpdate
- OptionalidProperty: "USER_ID" | "EMAIL"
  The name of a property with unique user values. Valid values are `USER_ID`(default) or `EMAIL`
- Optional_options: PromiseConfigurationOptions
Returns Promise<HttpInfo<PublicUser>>
- Defined in codegen/settings/users/types/PromiseAPI.ts:336

Class UsersApi

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns UsersApi

Methods

archive

Parameters

Returns Promise<void>

archiveWithHttpInfo

Parameters

Returns Promise<HttpInfo<void>>

create

Parameters

Returns Promise<PublicUser>

createWithHttpInfo

Parameters

Returns Promise<HttpInfo<PublicUser>>

getById

Parameters

Returns Promise<PublicUser>

getByIdWithHttpInfo

Parameters

Returns Promise<HttpInfo<PublicUser>>

getPage

Parameters

Returns Promise<CollectionResponsePublicUserForwardPaging>

getPageWithHttpInfo

Parameters

Returns Promise<HttpInfo<CollectionResponsePublicUserForwardPaging>>

replace

Parameters

Returns Promise<PublicUser>

replaceWithHttpInfo

Parameters

Returns Promise<HttpInfo<PublicUser>>

Settings

On This Page