Class ConsentControllerApi

Hierarchy

BaseAPI
- ConsentControllerApi

Index

Constructors

Properties

Methods

checkSendingConsentForEmailAddress checkSendingConsentForEmailAddressRaw getOptInIdentities getOptInIdentitiesRaw request revokeOptInConsentForEmailAddress revokeOptInConsentForEmailAddressRaw sendOptInConsentForEmailAddress sendOptInConsentForEmailAddressRaw withMiddleware withPostMiddleware withPreMiddleware

Constructors

constructor

new ConsentControllerApi(configuration?: Configuration): ConsentControllerApi
Parameters
- configuration: Configuration = ...
Returns ConsentControllerApi

Inherited from BaseAPI.constructor

Properties

`Protected` configuration

configuration: Configuration = ...

Methods

checkSendingConsentForEmailAddress

checkSendingConsentForEmailAddress(requestParameters: CheckSendingConsentForEmailAddressRequest, initOverrides?: RequestInit): Promise<OptInSendingConsentDto>
Parameters
- requestParameters: CheckSendingConsentForEmailAddressRequest
- Optional initOverrides: RequestInit
Returns Promise<OptInSendingConsentDto>

checkSendingConsentForEmailAddressRaw

checkSendingConsentForEmailAddressRaw(requestParameters: CheckSendingConsentForEmailAddressRequest, initOverrides?: RequestInit): Promise<ApiResponse<OptInSendingConsentDto>>
Parameters
- requestParameters: CheckSendingConsentForEmailAddressRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<OptInSendingConsentDto>>

getOptInIdentities

getOptInIdentities(requestParameters: GetOptInIdentitiesRequest, initOverrides?: RequestInit): Promise<PageOptInIdentityProjection>
Parameters
- requestParameters: GetOptInIdentitiesRequest
- Optional initOverrides: RequestInit
Returns Promise<PageOptInIdentityProjection>

getOptInIdentitiesRaw

getOptInIdentitiesRaw(requestParameters: GetOptInIdentitiesRequest, initOverrides?: RequestInit): Promise<ApiResponse<PageOptInIdentityProjection>>
Parameters
- requestParameters: GetOptInIdentitiesRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<PageOptInIdentityProjection>>

`Protected` request

request(context: RequestOpts, initOverrides?: RequestInit): Promise<Response>
Parameters
- context: RequestOpts
- Optional initOverrides: RequestInit
Returns Promise<Response>

Inherited from BaseAPI.request

revokeOptInConsentForEmailAddress

revokeOptInConsentForEmailAddress(requestParameters: RevokeOptInConsentForEmailAddressRequest, initOverrides?: RequestInit): Promise<OptInSendingConsentDto>
Parameters
- requestParameters: RevokeOptInConsentForEmailAddressRequest
- Optional initOverrides: RequestInit
Returns Promise<OptInSendingConsentDto>

revokeOptInConsentForEmailAddressRaw

revokeOptInConsentForEmailAddressRaw(requestParameters: RevokeOptInConsentForEmailAddressRequest, initOverrides?: RequestInit): Promise<ApiResponse<OptInSendingConsentDto>>
Parameters
- requestParameters: RevokeOptInConsentForEmailAddressRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<OptInSendingConsentDto>>

sendOptInConsentForEmailAddress

sendOptInConsentForEmailAddress(requestParameters: SendOptInConsentForEmailAddressRequest, initOverrides?: RequestInit): Promise<OptInConsentSendResult>
Send double-opt in consent for an email address Send a verification code to a user once they have explicitly submitted their email address
Parameters
- requestParameters: SendOptInConsentForEmailAddressRequest
- Optional initOverrides: RequestInit
Returns Promise<OptInConsentSendResult>

sendOptInConsentForEmailAddressRaw

sendOptInConsentForEmailAddressRaw(requestParameters: SendOptInConsentForEmailAddressRequest, initOverrides?: RequestInit): Promise<ApiResponse<OptInConsentSendResult>>
Send double-opt in consent for an email address Send a verification code to a user once they have explicitly submitted their email address
Parameters
- requestParameters: SendOptInConsentForEmailAddressRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<OptInConsentSendResult>>

withMiddleware

withMiddleware<T>(this: T, ...middlewares: Middleware[]): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...middlewares: Middleware[]
Returns T

Inherited from BaseAPI.withMiddleware

withPostMiddleware

withPostMiddleware<T>(this: T, ...postMiddlewares: ((context: ResponseContext) => Promise<void | Response>)[]): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...postMiddlewares: ((context: ResponseContext) => Promise<void | Response>)[]
Returns T

Inherited from BaseAPI.withPostMiddleware

withPreMiddleware

withPreMiddleware<T>(this: T, ...preMiddlewares: ((context: RequestContext) => Promise<void | FetchParams>)[]): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...preMiddlewares: ((context: RequestContext) => Promise<void | FetchParams>)[]
Returns T

Inherited from BaseAPI.withPreMiddleware

Class ConsentControllerApi

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

configuration: Configuration = ...

Returns ConsentControllerApi

Properties

Protected configuration

Methods

checkSendingConsentForEmailAddress

Parameters

requestParameters: CheckSendingConsentForEmailAddressRequest

Optional initOverrides: RequestInit

Returns Promise<OptInSendingConsentDto>

checkSendingConsentForEmailAddressRaw

Parameters

requestParameters: CheckSendingConsentForEmailAddressRequest

Optional initOverrides: RequestInit

Returns Promise<ApiResponse<OptInSendingConsentDto>>

getOptInIdentities

Parameters

requestParameters: GetOptInIdentitiesRequest

Optional initOverrides: RequestInit

Returns Promise<PageOptInIdentityProjection>

getOptInIdentitiesRaw

Parameters

requestParameters: GetOptInIdentitiesRequest

Optional initOverrides: RequestInit

Returns Promise<ApiResponse<PageOptInIdentityProjection>>

Protected request

Parameters

context: RequestOpts

Optional initOverrides: RequestInit

Returns Promise<Response>

revokeOptInConsentForEmailAddress

Parameters

requestParameters: RevokeOptInConsentForEmailAddressRequest

Optional initOverrides: RequestInit

Returns Promise<OptInSendingConsentDto>

revokeOptInConsentForEmailAddressRaw

Parameters

requestParameters: RevokeOptInConsentForEmailAddressRequest

Optional initOverrides: RequestInit

Returns Promise<ApiResponse<OptInSendingConsentDto>>

sendOptInConsentForEmailAddress

Parameters

requestParameters: SendOptInConsentForEmailAddressRequest

Optional initOverrides: RequestInit

Returns Promise<OptInConsentSendResult>

sendOptInConsentForEmailAddressRaw

Parameters

requestParameters: SendOptInConsentForEmailAddressRequest

Optional initOverrides: RequestInit

Returns Promise<ApiResponse<OptInConsentSendResult>>

withMiddleware

Type Parameters

T extends BaseAPI<T>

Parameters

this: T

Rest ...middlewares: Middleware[]

Returns T

withPostMiddleware

Type Parameters

T extends BaseAPI<T>

Parameters

this: T

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

Returns T

withPreMiddleware

Type Parameters

T extends BaseAPI<T>

Parameters

this: T

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

Returns T

`Protected` configuration

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Protected` request

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Rest` ...middlewares: Middleware[]

`Rest` ...postMiddlewares: ((context: ResponseContext) => Promise<void | Response>)[]

`Rest` ...preMiddlewares: ((context: RequestContext) => Promise<void | FetchParams>)[]