Class GDPRApi

Index

Constructors

Methods

purge purgeWithHttpInfo

Constructors

constructor

new GDPRApi(configuration, requestFactory?, responseProcessor?): GDPRApi
Parameters
- configuration: Configuration
- OptionalrequestFactory: GDPRApiRequestFactory
- OptionalresponseProcessor: GDPRApiResponseProcessor
Returns GDPRApi
- Defined in codegen/crm/contacts/types/PromiseAPI.ts:284

Methods

purge

purge(publicGdprDeleteInput, _options?): Promise<void>
Permanently delete a contact and all associated content to follow GDPR. Use optional property 'idProperty' set to 'email' to identify contact by email address. If email address is not found, the email address will be added to a blocklist and prevent it from being used in the future. GDPR DELETE
Parameters
- publicGdprDeleteInput: PublicGdprDeleteInput
- Optional_options: Configuration
Returns Promise<void>
- Defined in codegen/crm/contacts/types/PromiseAPI.ts:307

purgeWithHttpInfo

purgeWithHttpInfo(publicGdprDeleteInput, _options?): Promise<HttpInfo<void>>
Permanently delete a contact and all associated content to follow GDPR. Use optional property 'idProperty' set to 'email' to identify contact by email address. If email address is not found, the email address will be added to a blocklist and prevent it from being used in the future. GDPR DELETE
Parameters
- publicGdprDeleteInput: PublicGdprDeleteInput
- Optional_options: Configuration
Returns Promise<HttpInfo<void>>
- Defined in codegen/crm/contacts/types/PromiseAPI.ts:297