Class: PersonsApi
Types.PersonsApi
Hierarchy
↳
PersonsApi
Constructors
constructor
• new PersonsApi(configuration?)
Parameters
| Name | Type | Default value |
|---|---|---|
configuration | Configuration | DefaultConfig |
Inherited from
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
| Name | Type |
|---|---|
requestParameters | PostPersonsAnonymousRequest |
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
| Name | Type |
|---|---|
requestParameters | PostPersonsAnonymousRequest |
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
| Name | Type |
|---|---|
requestParameters | PostPersonsPersonIdImpersonateRequest |
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
| Name | Type |
|---|---|
requestParameters | PostPersonsPersonIdImpersonateRequest |
initOverrides? | RequestInit | InitOverrideFunction |
Returns
Promise<ApiResponse<PostPersonsPersonIdImpersonate201Response>>
withMiddleware
▸ withMiddleware<T>(this, ...middlewares): T
Type parameters
| Name | Type |
|---|---|
T | extends BaseAPI<T> |
Parameters
| Name | Type |
|---|---|
this | T |
...middlewares | Middleware[] |
Returns
T
Inherited from
withPostMiddleware
▸ withPostMiddleware<T>(this, ...postMiddlewares): T
Type parameters
| Name | Type |
|---|---|
T | extends BaseAPI<T> |
Parameters
| Name | Type |
|---|---|
this | T |
...postMiddlewares | (undefined | (context: ResponseContext) => Promise<void | Response>)[] |
Returns
T
Inherited from
withPreMiddleware
▸ withPreMiddleware<T>(this, ...preMiddlewares): T
Type parameters
| Name | Type |
|---|---|
T | extends BaseAPI<T> |
Parameters
| Name | Type |
|---|---|
this | T |
...preMiddlewares | (undefined | (context: RequestContext) => Promise<void | FetchParams>)[] |
Returns
T