Class: PersonConsentsApi
Types.PersonConsentsApi
Hierarchy
↳
PersonConsentsApi
Constructors
constructor
• new PersonConsentsApi(configuration?)
Parameters
| Name | Type | Default value |
|---|---|---|
configuration | Configuration | DefaultConfig |
Inherited from
Methods
deleteConsentGdpr
▸ deleteConsentGdpr(requestParameters?, initOverrides?): Promise<void>
Removes the specified GDPR consent, or all consents. Remove GDPR consent of current user
Parameters
| Name | Type |
|---|---|
requestParameters | DeleteConsentGdprRequest |
initOverrides? | RequestInit | InitOverrideFunction |
Returns
Promise<void>
deleteConsentGdprRaw
▸ deleteConsentGdprRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>
Removes the specified GDPR consent, or all consents. Remove GDPR consent of current user
Parameters
| Name | Type |
|---|---|
requestParameters | DeleteConsentGdprRequest |
initOverrides? | RequestInit | InitOverrideFunction |
Returns
Promise<ApiResponse<void>>
getConsentGdpr
▸ getConsentGdpr(requestParameters?, initOverrides?): Promise<GetConsentGdpr200Response>
Returns the GDPR consent levels and timestamp for current person, if it exists. Get GDPR consent of current user
Parameters
| Name | Type |
|---|---|
requestParameters | GetConsentGdprRequest |
initOverrides? | RequestInit | InitOverrideFunction |
Returns
Promise<GetConsentGdpr200Response>
getConsentGdprRaw
▸ getConsentGdprRaw(requestParameters, initOverrides?): Promise<ApiResponse<GetConsentGdpr200Response>>
Returns the GDPR consent levels and timestamp for current person, if it exists. Get GDPR consent of current user
Parameters
| Name | Type |
|---|---|
requestParameters | GetConsentGdprRequest |
initOverrides? | RequestInit | InitOverrideFunction |
Returns
Promise<ApiResponse<GetConsentGdpr200Response>>
postConsentGdpr
▸ postConsentGdpr(requestParameters, initOverrides?): Promise<PutConsentGdpr200Response>
Stores the GDPR consent levels and timestamp. Returns the consent levels and the timestamp at which the consent information was received. This will overwrite existing GDPR consent levels for the specified person. The consent levels indicate the types of data classes the person has allowed during their use of your services, in accordance with GDPR. Store GDPR consent of current user
Parameters
| Name | Type |
|---|---|
requestParameters | PostConsentGdprRequest |
initOverrides? | RequestInit | InitOverrideFunction |
Returns
Promise<PutConsentGdpr200Response>
postConsentGdprRaw
▸ postConsentGdprRaw(requestParameters, initOverrides?): Promise<ApiResponse<PutConsentGdpr200Response>>
Stores the GDPR consent levels and timestamp. Returns the consent levels and the timestamp at which the consent information was received. This will overwrite existing GDPR consent levels for the specified person. The consent levels indicate the types of data classes the person has allowed during their use of your services, in accordance with GDPR. Store GDPR consent of current user
Parameters
| Name | Type |
|---|---|
requestParameters | PostConsentGdprRequest |
initOverrides? | RequestInit | InitOverrideFunction |
Returns
Promise<ApiResponse<PutConsentGdpr200Response>>
putConsentGdpr
▸ putConsentGdpr(requestParameters, initOverrides?): Promise<PutConsentGdpr200Response>
Stores the GDPR consent levels and timestamp. Returns the consent levels and the timestamp at which the consent information was received. This will overwrite existing GDPR consent levels for the specified person. The consent levels indicate the types of data classes the person has allowed during their use of your services, in accordance with GDPR. Set GDPR consent of current user
Parameters
| Name | Type |
|---|---|
requestParameters | PutConsentGdprRequest |
initOverrides? | RequestInit | InitOverrideFunction |
Returns
Promise<PutConsentGdpr200Response>
putConsentGdprRaw
▸ putConsentGdprRaw(requestParameters, initOverrides?): Promise<ApiResponse<PutConsentGdpr200Response>>
Stores the GDPR consent levels and timestamp. Returns the consent levels and the timestamp at which the consent information was received. This will overwrite existing GDPR consent levels for the specified person. The consent levels indicate the types of data classes the person has allowed during their use of your services, in accordance with GDPR. Set GDPR consent of current user
Parameters
| Name | Type |
|---|---|
requestParameters | PutConsentGdprRequest |
initOverrides? | RequestInit | InitOverrideFunction |
Returns
Promise<ApiResponse<PutConsentGdpr200Response>>
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