Skip to content

archives.md

Latest commit

 

History

History
139 lines (89 loc) · 3.48 KB

archives.md

File metadata and controls

139 lines (89 loc) · 3.48 KB

ArchivesManager

List archives

Retrieves archives for an enterprise.

To learn more about the archive APIs, see the Archive API Guide.

This operation is performed by calling function getArchivesV2025R0.

See the endpoint docs at API Reference.

await client.archives.getArchivesV2025R0({
  limit: 100,
} satisfies GetArchivesV2025R0QueryParams);

Arguments

  • queryParams GetArchivesV2025R0QueryParams
    • Query parameters of getArchivesV2025R0 method
  • headersInput GetArchivesV2025R0HeadersInput
    • Headers of getArchivesV2025R0 method
  • cancellationToken undefined | CancellationToken
    • Token used for request cancellation.

Returns

This function returns a value of type ArchivesV2025R0.

Returns a list of archives in the enterprise.

Create archive

Creates an archive.

To learn more about the archive APIs, see the Archive API Guide.

This operation is performed by calling function createArchiveV2025R0.

See the endpoint docs at API Reference.

await client.archives.createArchiveV2025R0({
  name: archiveName,
  description: archiveDescription,
} satisfies CreateArchiveV2025R0RequestBody);

Arguments

  • requestBody CreateArchiveV2025R0RequestBody
    • Request body of createArchiveV2025R0 method
  • optionalsInput CreateArchiveV2025R0OptionalsInput

Returns

This function returns a value of type ArchiveV2025R0.

Returns a new archive object.

Delete archive

Permanently deletes an archive.

To learn more about the archive APIs, see the Archive API Guide.

This endpoint is currently unavailable. Please contact support for assistance.

This operation is performed by calling function deleteArchiveByIdV2025R0.

See the endpoint docs at API Reference.

await client.archives.deleteArchiveByIdV2025R0(archive.id);

Arguments

  • archiveId string
    • The ID of the archive. Example: "982312"
  • optionalsInput DeleteArchiveByIdV2025R0OptionalsInput

Returns

This function returns a value of type undefined.

Returns an empty response when the archive has been deleted.

Update archive

Updates an archive.

To learn more about the archive APIs, see the Archive API Guide.

This operation is performed by calling function updateArchiveByIdV2025R0.

See the endpoint docs at API Reference.

await client.archives.updateArchiveByIdV2025R0(archive.id, {
  requestBody: {
    name: newArchiveName,
    description: newArchiveDescription,
  } satisfies UpdateArchiveByIdV2025R0RequestBody,
} satisfies UpdateArchiveByIdV2025R0OptionalsInput);

Arguments

  • archiveId string
    • The ID of the archive. Example: "982312"
  • optionalsInput UpdateArchiveByIdV2025R0OptionalsInput

Returns

This function returns a value of type ArchiveV2025R0.

Returns the updated archive object.