Class IssueRedaction

Index

Constructors

Methods

getRedactionStatus redact

Constructors

constructor

new IssueRedaction(client: Client): IssueRedaction
Parameters
- client: Client
Returns IssueRedaction
- Defined in src/version2/issueRedaction.ts:8

Methods

getRedactionStatus

getRedactionStatus<T = Version2Models.RedactionJobStatusResponse>(
parameters: Version2Parameters.GetRedactionStatus,
callback: Callback<T>,
): Promise<void>
Retrieves the current status of a redaction job ID.

The jobStatus will be one of the following:
- IN_PROGRESS - The redaction job is currently in progress
- COMPLETED - The redaction job has completed successfully.
- PENDING - The redaction job has not started yet
Type Parameters
- T = Version2Models.RedactionJobStatusResponse
Parameters
- parameters: Version2Parameters.GetRedactionStatus
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version2/issueRedaction.ts:45
getRedactionStatus<T = Version2Models.RedactionJobStatusResponse>(
parameters: Version2Parameters.GetRedactionStatus,
callback?: undefined,
): Promise<T>
Retrieves the current status of a redaction job ID.

The jobStatus will be one of the following:
- IN_PROGRESS - The redaction job is currently in progress
- COMPLETED - The redaction job has completed successfully.
- PENDING - The redaction job has not started yet
Type Parameters
- T = Version2Models.RedactionJobStatusResponse
Parameters
- parameters: Version2Parameters.GetRedactionStatus
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version2/issueRedaction.ts:58

redact

redact<T = string>(
parameters: Version2Models.BulkRedactionRequest,
callback: Callback<T>,
): Promise<void>
Submit a job to redact issue field data. This will trigger the redaction of the data in the specified fields asynchronously.

The redaction status can be polled using the job id.
Type Parameters
- T = string
Parameters
- parameters: Version2Models.BulkRedactionRequest
- callback: Callback<T>
Returns Promise<void>
- Defined in src/version2/issueRedaction.ts:16
redact<T = string>(
parameters: Version2Models.BulkRedactionRequest,
callback?: undefined,
): Promise<T>
Submit a job to redact issue field data. This will trigger the redaction of the data in the specified fields asynchronously.

The redaction status can be polled using the job id.
Type Parameters
- T = string
Parameters
- parameters: Version2Models.BulkRedactionRequest
- Optionalcallback: undefined
Returns Promise<T>
- Defined in src/version2/issueRedaction.ts:23