Skip to main content

Class: PersonsApi

Types.PersonsApi

Hierarchy

Constructors

constructor

new PersonsApi(configuration?)

Parameters

NameTypeDefault value
configurationConfigurationDefaultConfig

Inherited from

BaseAPI.constructor

Methods

postPersonsAnonymous

postPersonsAnonymous(requestParameters, initOverrides?): Promise<PostPersonsAnonymous201Response>

Create a new anonymous person linked to your organization. Unlike regular persons, anonymous persons\' identities are unknown and they do not have any authentication methods. However, it is still possible to persist information associated with this user, including attributes and GDPR consent. Anonymous persons can be created when a user first enters your website or application. If the person eventually signs up, the person type is upgraded to regular. Anonymous persons are inherently temporary and will be deleted after 30 days. Anonymous persons do not count towards billing and account limits, but their creation is rate-limited based on the organization\'s pricing tier. Create new anonymous person

Parameters

NameType
requestParametersPostPersonsAnonymousRequest
initOverrides?RequestInit | InitOverrideFunction

Returns

Promise<PostPersonsAnonymous201Response>


postPersonsAnonymousRaw

postPersonsAnonymousRaw(requestParameters, initOverrides?): Promise<ApiResponse<PostPersonsAnonymous201Response>>

Create a new anonymous person linked to your organization. Unlike regular persons, anonymous persons\' identities are unknown and they do not have any authentication methods. However, it is still possible to persist information associated with this user, including attributes and GDPR consent. Anonymous persons can be created when a user first enters your website or application. If the person eventually signs up, the person type is upgraded to regular. Anonymous persons are inherently temporary and will be deleted after 30 days. Anonymous persons do not count towards billing and account limits, but their creation is rate-limited based on the organization\'s pricing tier. Create new anonymous person

Parameters

NameType
requestParametersPostPersonsAnonymousRequest
initOverrides?RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<PostPersonsAnonymous201Response>>


postPersonsPersonIdImpersonate

postPersonsPersonIdImpersonate(requestParameters, initOverrides?): Promise<PostPersonsPersonIdImpersonate201Response>

This endpoint creates a one-time token to impersonate a specific person. The returned token string must embedded in a URL in the challenges query parameter to let you land on a target page already authenticated as the desired person. Impersonate another person

Parameters

NameType
requestParametersPostPersonsPersonIdImpersonateRequest
initOverrides?RequestInit | InitOverrideFunction

Returns

Promise<PostPersonsPersonIdImpersonate201Response>


postPersonsPersonIdImpersonateRaw

postPersonsPersonIdImpersonateRaw(requestParameters, initOverrides?): Promise<ApiResponse<PostPersonsPersonIdImpersonate201Response>>

This endpoint creates a one-time token to impersonate a specific person. The returned token string must embedded in a URL in the challenges query parameter to let you land on a target page already authenticated as the desired person. Impersonate another person

Parameters

NameType
requestParametersPostPersonsPersonIdImpersonateRequest
initOverrides?RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<PostPersonsPersonIdImpersonate201Response>>


postPersonsPersonIdImpersonateV2

postPersonsPersonIdImpersonateV2(requestParameters, initOverrides?): Promise<PostPersonsPersonIdImpersonate201Response>

This endpoint creates a one-time token to impersonate a specific person. The returned token string must embedded in a URL in the challenges query parameter to let you land on a target page already authenticated as the desired person. Impersonate another person

Parameters

NameType
requestParametersPostPersonsPersonIdImpersonateV2OperationRequest
initOverrides?RequestInit | InitOverrideFunction

Returns

Promise<PostPersonsPersonIdImpersonate201Response>


postPersonsPersonIdImpersonateV2Raw

postPersonsPersonIdImpersonateV2Raw(requestParameters, initOverrides?): Promise<ApiResponse<PostPersonsPersonIdImpersonate201Response>>

This endpoint creates a one-time token to impersonate a specific person. The returned token string must embedded in a URL in the challenges query parameter to let you land on a target page already authenticated as the desired person. Impersonate another person

Parameters

NameType
requestParametersPostPersonsPersonIdImpersonateV2OperationRequest
initOverrides?RequestInit | InitOverrideFunction

Returns

Promise<ApiResponse<PostPersonsPersonIdImpersonate201Response>>


withMiddleware

withMiddleware<T>(this, ...middlewares): T

Type parameters

NameType
Textends BaseAPI<T>

Parameters

NameType
thisT
...middlewaresMiddleware[]

Returns

T

Inherited from

BaseAPI.withMiddleware


withPostMiddleware

withPostMiddleware<T>(this, ...postMiddlewares): T

Type parameters

NameType
Textends BaseAPI<T>

Parameters

NameType
thisT
...postMiddlewares(undefined | (context: ResponseContext) => Promise<void | Response>)[]

Returns

T

Inherited from

BaseAPI.withPostMiddleware


withPreMiddleware

withPreMiddleware<T>(this, ...preMiddlewares): T

Type parameters

NameType
Textends BaseAPI<T>

Parameters

NameType
thisT
...preMiddlewares(undefined | (context: RequestContext) => Promise<void | FetchParams>)[]

Returns

T

Inherited from

BaseAPI.withPreMiddleware