Class RecordsManagementClient

Implements

IRecordsManagementClient

Constructors

constructor

new RecordsManagementClient(
baseUrl?: string,
http?: { fetch(url: RequestInfo, init?: RequestInit): Promise<Response> },
): RecordsManagementClient
Parameters
- OptionalbaseUrl: string
- Optionalhttp: { fetch(url: RequestInfo, init?: RequestInit): Promise<Response> }
Returns RecordsManagementClient
- Defined in packages/lf-repository-api-client-v2/index.ts:11128

Properties

`Protected`jsonParseReviver

jsonParseReviver: undefined | (key: string, value: any) => any = undefined

Methods

createRecordSeries

createRecordSeries(
    args: {
        parentEntryId: number;
        repositoryId: string;
        request: CreateRecordSeriesRequest;
    },
): Promise<Entry>
- A record series provides cascading retention defaults for the file plan beneath it.
- The parent must be the file-plan root or another record series; creating one under a normal folder is rejected.
- Deleting a record series uses the existing Delete Entry endpoint (a record series is an entry).
- Required OAuth scope: repository.Write
Parameters
- args: {
      parentEntryId: number;
      repositoryId: string;
      request: CreateRecordSeriesRequest;
  }
  - parentEntryId: number
    The parent the record series is created under. A record series belongs to the record file plan, so the parent must be the repository's file-plan root or an existing record series — it cannot be a normal folder (the server returns an error if it is).
  - repositoryId: string
    The requested repository ID.
  - request: CreateRecordSeriesRequest
    The new record series' name and code.
Returns Promise<Entry>
Successfully created the record series. Returned the created entry.
Implementation of IRecordsManagementClient.createRecordSeries
- Defined in packages/lf-repository-api-client-v2/index.ts:11951

getAltRetentionEvents

getAltRetentionEvents(
args: { entryId: number; repositoryId: string; select?: null | string },
): Promise<AltRetentionEventCollection>
Parameters
- args: { entryId: number; repositoryId: string; select?: null | string }
  - entryId: number
  - repositoryId: string
  - Optionalselect?: null | string
    (optional) Limits the properties returned in the result.
Returns Promise<AltRetentionEventCollection>
Successfully returned the record folder's alternate-retention trigger events.
Implementation of IRecordsManagementClient.getAltRetentionEvents
- Defined in packages/lf-repository-api-client-v2/index.ts:11497

getEligibleRecords

getEligibleRecords(
    args: {
        eligibleFor?: null | EligibleRecordsAction;
        entryId: number;
        repositoryId: string;
        select?: null | string;
    },
): Promise<RecordEntryIdCollection>
Parameters
- args: {
      eligibleFor?: null | EligibleRecordsAction;
      entryId: number;
      repositoryId: string;
      select?: null | string;
  }
  - OptionaleligibleFor?: null | EligibleRecordsAction
    (optional)
  - entryId: number
  - repositoryId: string
  - Optionalselect?: null | string
    (optional) Limits the properties returned in the result.
Returns Promise<RecordEntryIdCollection>
Successfully returned the ids of the records eligible for the requested action.
Implementation of IRecordsManagementClient.getEligibleRecords
- Defined in packages/lf-repository-api-client-v2/index.ts:11317

getEntryRecordsManagementProperties

getEntryRecordsManagementProperties(
args: { entryId: number; repositoryId: string; select?: null | string },
): Promise<RecordsManagementProperties>
Parameters
- args: { entryId: number; repositoryId: string; select?: null | string }
  - entryId: number
  - repositoryId: string
  - Optionalselect?: null | string
    (optional) Limits the properties returned in the result.
Returns Promise<RecordsManagementProperties>
Successfully returned the entry's records management properties.
Implementation of IRecordsManagementClient.getEntryRecordsManagementProperties
- Defined in packages/lf-repository-api-client-v2/index.ts:11137

getIndependentRecords

getIndependentRecords(
args: { entryId: number; repositoryId: string; select?: null | string },
): Promise<RecordEntryIdCollection>
Parameters
- args: { entryId: number; repositoryId: string; select?: null | string }
  - entryId: number
  - repositoryId: string
  - Optionalselect?: null | string
    (optional) Limits the properties returned in the result.
Returns Promise<RecordEntryIdCollection>
Successfully returned the ids of the independent records under the record folder.
Implementation of IRecordsManagementClient.getIndependentRecords
- Defined in packages/lf-repository-api-client-v2/index.ts:11408

getRecordSeriesProperties

getRecordSeriesProperties(
args: { entryId: number; repositoryId: string; select?: null | string },
): Promise<RecordSeriesProperties>
Parameters
- args: { entryId: number; repositoryId: string; select?: null | string }
  - entryId: number
  - repositoryId: string
  - Optionalselect?: null | string
    (optional) Limits the properties returned in the result.
Returns Promise<RecordSeriesProperties>
Successfully returned the record series properties.
Implementation of IRecordsManagementClient.getRecordSeriesProperties
- Defined in packages/lf-repository-api-client-v2/index.ts:11586

`Protected`processCreateRecordSeries

processCreateRecordSeries(response: Response): Promise<Entry>
Parameters
- response: Response
Returns Promise<Entry>
- Defined in packages/lf-repository-api-client-v2/index.ts:11978

`Protected`processGetAltRetentionEvents

processGetAltRetentionEvents(
response: Response,
): Promise<AltRetentionEventCollection>
Parameters
- response: Response
Returns Promise<AltRetentionEventCollection>
- Defined in packages/lf-repository-api-client-v2/index.ts:11522

`Protected`processGetEligibleRecords

processGetEligibleRecords(response: Response): Promise<RecordEntryIdCollection>
Parameters
- response: Response
Returns Promise<RecordEntryIdCollection>
- Defined in packages/lf-repository-api-client-v2/index.ts:11344

`Protected`processGetEntryRecordsManagementProperties

processGetEntryRecordsManagementProperties(
response: Response,
): Promise<RecordsManagementProperties>
Parameters
- response: Response
Returns Promise<RecordsManagementProperties>
- Defined in packages/lf-repository-api-client-v2/index.ts:11162

`Protected`processGetIndependentRecords

processGetIndependentRecords(
response: Response,
): Promise<RecordEntryIdCollection>
Parameters
- response: Response
Returns Promise<RecordEntryIdCollection>
- Defined in packages/lf-repository-api-client-v2/index.ts:11433

`Protected`processGetRecordSeriesProperties

processGetRecordSeriesProperties(
response: Response,
): Promise<RecordSeriesProperties>
Parameters
- response: Response
Returns Promise<RecordSeriesProperties>
- Defined in packages/lf-repository-api-client-v2/index.ts:11611

`Protected`processRemoveRecordEvent

processRemoveRecordEvent(
response: Response,
): Promise<RecordsManagementProperties>
Parameters
- response: Response
Returns Promise<RecordsManagementProperties>
- Defined in packages/lf-repository-api-client-v2/index.ts:11881

`Protected`processSetRecordEvent

processSetRecordEvent(response: Response): Promise<RecordsManagementProperties>
Parameters
- response: Response
Returns Promise<RecordsManagementProperties>
- Defined in packages/lf-repository-api-client-v2/index.ts:11791

`Protected`processUpdateEntryRecordsManagementProperties

processUpdateEntryRecordsManagementProperties(
response: Response,
): Promise<RecordsManagementProperties>
Parameters
- response: Response
Returns Promise<RecordsManagementProperties>
- Defined in packages/lf-repository-api-client-v2/index.ts:11252

`Protected`processUpdateRecordSeriesProperties

processUpdateRecordSeriesProperties(
response: Response,
): Promise<RecordSeriesProperties>
Parameters
- response: Response
Returns Promise<RecordSeriesProperties>
- Defined in packages/lf-repository-api-client-v2/index.ts:11701

removeRecordEvent

removeRecordEvent(
    args: {
        entryId: number;
        repositoryId: string;
        request: RemoveRecordEventRequest;
    },
): Promise<RecordsManagementProperties>
Parameters
- args: { entryId: number; repositoryId: string; request: RemoveRecordEventRequest }
Returns Promise<RecordsManagementProperties>
Successfully removed the record event date. Returned the updated records management properties.
Implementation of IRecordsManagementClient.removeRecordEvent
- Defined in packages/lf-repository-api-client-v2/index.ts:11854

setRecordEvent

setRecordEvent(
    args: {
        entryId: number;
        repositoryId: string;
        request: SetRecordEventRequest;
    },
): Promise<RecordsManagementProperties>
Parameters
- args: { entryId: number; repositoryId: string; request: SetRecordEventRequest }
Returns Promise<RecordsManagementProperties>
Successfully set the record event date. Returned the updated records management properties.
Implementation of IRecordsManagementClient.setRecordEvent
- Defined in packages/lf-repository-api-client-v2/index.ts:11764

updateEntryRecordsManagementProperties

updateEntryRecordsManagementProperties(
    args: {
        entryId: number;
        repositoryId: string;
        request: UpdateRecordsManagementPropertiesRequest;
    },
): Promise<RecordsManagementProperties>
Parameters
- args: {
      entryId: number;
      repositoryId: string;
      request: UpdateRecordsManagementPropertiesRequest;
  }
Returns Promise<RecordsManagementProperties>
Successfully updated the entry's records management properties. Returned the updated properties.
Implementation of IRecordsManagementClient.updateEntryRecordsManagementProperties
- Defined in packages/lf-repository-api-client-v2/index.ts:11225

updateRecordSeriesProperties

updateRecordSeriesProperties(
    args: {
        entryId: number;
        repositoryId: string;
        request: UpdateRecordSeriesPropertiesRequest;
    },
): Promise<RecordSeriesProperties>
Parameters
- args: {
      entryId: number;
      repositoryId: string;
      request: UpdateRecordSeriesPropertiesRequest;
  }
Returns Promise<RecordSeriesProperties>
Successfully updated the record series properties. Returned the updated properties.
Implementation of IRecordsManagementClient.updateRecordSeriesProperties
- Defined in packages/lf-repository-api-client-v2/index.ts:11674

Class RecordsManagementClient

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns RecordsManagementClient

Properties

ProtectedjsonParseReviver

Methods

createRecordSeries

Parameters

parentEntryId: number

repositoryId: string

request: CreateRecordSeriesRequest

Returns Promise<Entry>

getAltRetentionEvents

Parameters

entryId: number

repositoryId: string

Optionalselect?: null | string

Returns Promise<AltRetentionEventCollection>

getEligibleRecords

Parameters

OptionaleligibleFor?: null | EligibleRecordsAction

entryId: number

repositoryId: string

Optionalselect?: null | string

Returns Promise<RecordEntryIdCollection>

getEntryRecordsManagementProperties

Parameters

entryId: number

repositoryId: string

Optionalselect?: null | string

Returns Promise<RecordsManagementProperties>

getIndependentRecords

Parameters

entryId: number

repositoryId: string

Optionalselect?: null | string

Returns Promise<RecordEntryIdCollection>

getRecordSeriesProperties

Parameters

entryId: number

repositoryId: string

Optionalselect?: null | string

Returns Promise<RecordSeriesProperties>

ProtectedprocessCreateRecordSeries

Parameters

Returns Promise<Entry>

ProtectedprocessGetAltRetentionEvents

Parameters

Returns Promise<AltRetentionEventCollection>

ProtectedprocessGetEligibleRecords

Parameters

Returns Promise<RecordEntryIdCollection>

ProtectedprocessGetEntryRecordsManagementProperties

Parameters

Returns Promise<RecordsManagementProperties>

ProtectedprocessGetIndependentRecords

Parameters

Returns Promise<RecordEntryIdCollection>

ProtectedprocessGetRecordSeriesProperties

Parameters

Returns Promise<RecordSeriesProperties>

ProtectedprocessRemoveRecordEvent

Parameters

Returns Promise<RecordsManagementProperties>

ProtectedprocessSetRecordEvent

Parameters

Returns Promise<RecordsManagementProperties>

ProtectedprocessUpdateEntryRecordsManagementProperties

Parameters

Returns Promise<RecordsManagementProperties>

ProtectedprocessUpdateRecordSeriesProperties

Parameters

Returns Promise<RecordSeriesProperties>

`Protected`jsonParseReviver

`Optional`select?: null | string

`Optional`eligibleFor?: null | EligibleRecordsAction

`Optional`select?: null | string

`Optional`select?: null | string

`Optional`select?: null | string

`Optional`select?: null | string

`Protected`processCreateRecordSeries

`Protected`processGetAltRetentionEvents

`Protected`processGetEligibleRecords

`Protected`processGetEntryRecordsManagementProperties

`Protected`processGetIndependentRecords

`Protected`processGetRecordSeriesProperties

`Protected`processRemoveRecordEvent

`Protected`processSetRecordEvent

`Protected`processUpdateEntryRecordsManagementProperties

`Protected`processUpdateRecordSeriesProperties