@nationalarchives/tdr-generated-graphql 1.0.568 → 1.0.570

package/index.d.ts

@@ -0,0 +1,603 @@
+/** Internal type. DO NOT USE DIRECTLY. */
+type Exact<T extends {
+    [key: string]: unknown;
+}> = {
+    [K in keyof T]: T[K];
+};
+/** Internal type. DO NOT USE DIRECTLY. */
+export type Incremental<T> = T | {
+    [P in keyof T]?: P extends ' $fragmentName' | '__typename' ? T[P] : never;
+};
+import type * as Types from './schema-types';
+export * from './schema-types';
+export type AddBulkAntivirusMetadataMutationVariables = Exact<{
+    input: Types.AddAntivirusMetadataInput;
+}>;
+export type AddBulkAntivirusMetadataMutation = {
+    addBulkAntivirusMetadata: Array<{
+        fileId: string;
+        software: string;
+        softwareVersion: string;
+        databaseVersion: string;
+        result: string;
+        datetime: number;
+    }>;
+};
+export type AddBulkFfidMetadataMutationVariables = Exact<{
+    addBulkFFIDMetadataInput: Types.FfidMetadataInput;
+}>;
+export type AddBulkFfidMetadataMutation = {
+    addBulkFFIDMetadata: Array<{
+        fileId: string;
+    }>;
+};
+export type AddConsignmentMutationVariables = Exact<{
+    addConsignmentInput: Types.AddConsignmentInput;
+}>;
+export type AddConsignmentMutation = {
+    addConsignment: {
+        consignmentid: string | null;
+        seriesid: string | null;
+        consignmentReference: string;
+    };
+};
+export type AddConsignmentStatusMutationVariables = Exact<{
+    addConsignmentStatusInput: Types.ConsignmentStatusInput;
+}>;
+export type AddConsignmentStatusMutation = {
+    addConsignmentStatus: {
+        consignmentStatusId: string;
+        consignmentId: string;
+        statusType: string;
+        value: string;
+        createdDatetime: string;
+        modifiedDatetime: string | null;
+    };
+};
+export type AddFilesAndMetadataMutationVariables = Exact<{
+    input: Types.AddFileAndMetadataInput;
+}>;
+export type AddFilesAndMetadataMutation = {
+    addFilesAndMetadata: Array<{
+        fileId: string;
+        matchId: string;
+    }>;
+};
+export type AddFinalTransferConfirmationMutationVariables = Exact<{
+    input: Types.AddFinalTransferConfirmationInput;
+}>;
+export type AddFinalTransferConfirmationMutation = {
+    addFinalTransferConfirmation: {
+        consignmentId: string;
+        legalCustodyTransferConfirmed: boolean;
+    };
+};
+export type AddMultipleFileMetadataMutationVariables = Exact<{
+    addMultipleFileMetadataInput: Types.AddFileMetadataWithFileIdInput;
+}>;
+export type AddMultipleFileMetadataMutation = {
+    addMultipleFileMetadata: Array<{
+        fileId: string;
+        value: string;
+    }>;
+};
+export type AddMultipleFileStatusesMutationVariables = Exact<{
+    addMultipleFileStatusesInput: Types.AddMultipleFileStatusesInput;
+}>;
+export type AddMultipleFileStatusesMutation = {
+    addMultipleFileStatuses: Array<{
+        fileId: string;
+        statusType: string;
+        statusValue: string;
+    }>;
+};
+export type AddOrUpdateBulkFileMetadataMutationVariables = Exact<{
+    addOrUpdateBulkFileMetadataInput: Types.AddOrUpdateBulkFileMetadataInput;
+}>;
+export type AddOrUpdateBulkFileMetadataMutation = {
+    addOrUpdateBulkFileMetadata: Array<{
+        filePropertyName: string;
+        fileId: string;
+        value: string;
+    }>;
+};
+export type AddOrUpdateConsignmentMetadataMutationVariables = Exact<{
+    addOrUpdateConsignmentMetadataInput: Types.AddOrUpdateConsignmentMetadataInput;
+}>;
+export type AddOrUpdateConsignmentMetadataMutation = {
+    addOrUpdateConsignmentMetadata: Array<{
+        consignmentId: string;
+        propertyName: string;
+        value: string;
+    }>;
+};
+export type AddTransferAgreementComplianceMutationVariables = Exact<{
+    input: Types.AddTransferAgreementComplianceInput;
+}>;
+export type AddTransferAgreementComplianceMutation = {
+    addTransferAgreementCompliance: {
+        consignmentId: string;
+        appraisalSelectionSignedOff: boolean;
+        sensitivityReviewSignedOff: boolean;
+        initialOpenRecords: boolean | null;
+    };
+};
+export type AddTransferAgreementPrivateBetaMutationVariables = Exact<{
+    input: Types.AddTransferAgreementPrivateBetaInput;
+}>;
+export type AddTransferAgreementPrivateBetaMutation = {
+    addTransferAgreementPrivateBeta: {
+        consignmentId: string;
+        allPublicRecords: boolean;
+    };
+};
+export type GetConsignmentQueryVariables = Exact<{
+    consignmentId: string;
+}>;
+export type GetConsignmentQuery = {
+    getConsignment: {
+        userid: string;
+        seriesid: string | null;
+        parentFolder: string | null;
+        consignmentReference: string;
+        parentFolderId: string | null;
+        clientSideDraftMetadataFileName: string | null;
+        transferringBodyName: string | null;
+        consignmentStatuses: Array<{
+            statusType: string;
+            value: string;
+        }>;
+    } | null;
+};
+export type GetConsignmentDetailsForMetadataReviewQueryVariables = Exact<{
+    consignmentId: string;
+}>;
+export type GetConsignmentDetailsForMetadataReviewQuery = {
+    getConsignment: {
+        consignmentReference: string;
+        seriesName: string | null;
+        transferringBodyName: string | null;
+        userid: string;
+        totalClosedRecords: number;
+        includeTopLevelFolder: boolean | null;
+        totalFiles: number;
+        consignmentMetadata: Array<{
+            propertyName: string;
+            value: string;
+        }>;
+        metadataReviewLogs: Array<{
+            metadataReviewLogId: string;
+            consignmentId: string;
+            userId: string;
+            action: string;
+            eventTime: string;
+            metadataReviewNotes: string | null;
+        }>;
+    } | null;
+};
+export type GetConsignmentForExportQueryVariables = Exact<{
+    consignmentId: string;
+}>;
+export type GetConsignmentForExportQuery = {
+    getConsignment: {
+        userid: string;
+        createdDatetime: string | null;
+        transferInitiatedDatetime: string | null;
+        exportDatetime: string | null;
+        consignmentReference: string;
+        consignmentType: string | null;
+        includeTopLevelFolder: boolean | null;
+        seriesName: string | null;
+        transferringBodyName: string | null;
+        metadataSchemaLibraryVersion: string | null;
+        files: Array<{
+            fileId: string;
+            fileType: string | null;
+            fileName: string | null;
+            fileReference: string | null;
+            parentReference: string | null;
+            originalFilePath: string | null;
+            fileMetadata: Array<{
+                name: string;
+                value: string;
+            }>;
+            ffidMetadata: {
+                software: string;
+                softwareVersion: string;
+                binarySignatureFileVersion: string;
+                containerSignatureFileVersion: string;
+                method: string;
+                matches: Array<{
+                    extension: string | null;
+                    identificationBasis: string;
+                    puid: string | null;
+                    fileExtensionMismatch: boolean | null;
+                    formatName: string | null;
+                }>;
+            } | null;
+            antivirusMetadata: {
+                software: string;
+                softwareVersion: string;
+            } | null;
+        }>;
+        consignmentMetadata: Array<{
+            propertyName: string;
+            value: string;
+        }>;
+    } | null;
+};
+export type GetConsignmentFilesQueryVariables = Exact<{
+    consignmentId: string;
+}>;
+export type GetConsignmentFilesQuery = {
+    getConsignment: {
+        files: Array<{
+            fileId: string;
+            fileName: string | null;
+            fileType: string | null;
+            parentId: string | null;
+            metadata: {
+                clientSideOriginalFilePath: string | null;
+            };
+            fileStatuses: Array<{
+                statusType: string;
+                statusValue: string;
+            }>;
+        }>;
+    } | null;
+};
+export type GetConsignmentFilesMetadataQueryVariables = Exact<{
+    consignmentId: string;
+    fileFiltersInput?: Types.FileFilters | null | undefined;
+}>;
+export type GetConsignmentFilesMetadataQuery = {
+    getConsignment: {
+        consignmentReference: string;
+        files: Array<{
+            fileId: string;
+            fileName: string | null;
+            fileMetadata: Array<{
+                name: string;
+                value: string;
+            }>;
+        }>;
+        metadataReviewLogs: Array<{
+            metadataReviewLogId: string;
+            consignmentId: string;
+            userId: string;
+            action: string;
+            eventTime: string;
+        }>;
+    } | null;
+};
+export type GetConsignmentFolderDetailsQueryVariables = Exact<{
+    consignmentId: string;
+}>;
+export type GetConsignmentFolderDetailsQuery = {
+    getConsignment: {
+        totalFiles: number;
+        parentFolder: string | null;
+    } | null;
+};
+export type GetConsignmentMetadataQueryVariables = Exact<{
+    consignmentId: string;
+    consignmentMetadataFiltersInput?: Types.ConsignmentMetadataFilter | null | undefined;
+}>;
+export type GetConsignmentMetadataQuery = {
+    getConsignment: {
+        consignmentReference: string;
+        consignmentMetadata: Array<{
+            propertyName: string;
+            value: string;
+        }>;
+    } | null;
+};
+export type GetConsignmentPaginatedFilesQueryVariables = Exact<{
+    consignmentId: string;
+    paginatedInput?: Types.PaginationInput | null | undefined;
+}>;
+export type GetConsignmentPaginatedFilesQuery = {
+    getConsignment: {
+        parentFolder: string | null;
+        parentFolderId: string | null;
+        paginatedFiles: {
+            totalPages: number | null;
+            totalItems: number | null;
+            pageInfo: {
+                startCursor: string | null;
+                endCursor: string | null;
+                hasNextPage: boolean;
+                hasPreviousPage: boolean;
+            };
+            edges: Array<{
+                node: {
+                    fileId: string;
+                    fileName: string | null;
+                    fileType: string | null;
+                    parentId: string | null;
+                };
+            } | null> | null;
+        };
+    } | null;
+};
+export type GetConsignmentReferenceQueryVariables = Exact<{
+    consignmentId: string;
+}>;
+export type GetConsignmentReferenceQuery = {
+    getConsignment: {
+        consignmentReference: string;
+    } | null;
+};
+export type GetConsignmentReviewDetailsQueryVariables = Exact<{
+    statusFilter?: string | null | undefined;
+}>;
+export type GetConsignmentReviewDetailsQuery = {
+    getConsignmentReviewDetails: Array<{
+        consignmentId: string;
+        consignmentReference: string;
+        reviewStatus: string;
+        transferringBodyName: string | null;
+        seriesName: string | null;
+        lastUpdated: string;
+    }>;
+};
+export type GetConsignmentStatusQueryVariables = Exact<{
+    consignmentId: string;
+}>;
+export type GetConsignmentStatusQuery = {
+    getConsignment: {
+        seriesid: string | null;
+        seriesName: string | null;
+        consignmentStatuses: Array<{
+            consignmentStatusId: string;
+            consignmentId: string;
+            statusType: string;
+            value: string;
+            createdDatetime: string;
+            modifiedDatetime: string | null;
+        }>;
+    } | null;
+};
+export type GetConsignmentSummaryQueryVariables = Exact<{
+    consignmentId: string;
+}>;
+export type GetConsignmentSummaryQuery = {
+    getConsignment: {
+        seriesName: string | null;
+        transferringBodyName: string | null;
+        totalFiles: number;
+        consignmentReference: string;
+    } | null;
+};
+export type GetConsignmentTypeQueryVariables = Exact<{
+    consignmentId: string;
+}>;
+export type GetConsignmentTypeQuery = {
+    getConsignment: {
+        consignmentType: string | null;
+    } | null;
+};
+export type GetConsignmentsQueryVariables = Exact<{
+    limit: number;
+    currentCursor?: string | null | undefined;
+    currentPage?: number | null | undefined;
+    consignmentFiltersInput?: Types.ConsignmentFilters | null | undefined;
+    orderBy?: Types.ConsignmentOrderBy | null | undefined;
+}>;
+export type GetConsignmentsQuery = {
+    consignments: {
+        totalPages: number | null;
+        edges: Array<{
+            cursor: string;
+            node: {
+                consignmentid: string | null;
+                consignmentReference: string;
+                consignmentType: string | null;
+                exportDatetime: string | null;
+                createdDatetime: string | null;
+                totalFiles: number;
+                consignmentStatuses: Array<{
+                    consignmentStatusId: string;
+                    consignmentId: string;
+                    statusType: string;
+                    value: string;
+                    createdDatetime: string;
+                    modifiedDatetime: string | null;
+                }>;
+            };
+        } | null> | null;
+        pageInfo: {
+            hasNextPage: boolean;
+            endCursor: string | null;
+        };
+    };
+};
+export type GetConsignmentsForMetadataReviewQueryVariables = Exact<{
+    [key: string]: never;
+}>;
+export type GetConsignmentsForMetadataReviewQuery = {
+    getConsignmentsForMetadataReview: Array<{
+        consignmentid: string | null;
+        consignmentReference: string;
+        seriesName: string | null;
+        transferringBodyName: string | null;
+        consignmentStatuses: Array<{
+            statusType: string;
+            value: string;
+            createdDatetime: string;
+            modifiedDatetime: string | null;
+        }>;
+    }>;
+};
+export type GetConsignmentForMetadataReviewRequestQueryVariables = Exact<{
+    consignmentId: string;
+}>;
+export type GetConsignmentForMetadataReviewRequestQuery = {
+    getConsignment: {
+        userid: string;
+        consignmentReference: string;
+        seriesName: string | null;
+        transferringBodyName: string | null;
+        totalClosedRecords: number;
+        totalFiles: number;
+    } | null;
+};
+export type GetFileCheckProgressQueryVariables = Exact<{
+    consignmentId: string;
+}>;
+export type GetFileCheckProgressQuery = {
+    getConsignment: {
+        allChecksSucceeded: boolean;
+        parentFolder: string | null;
+        totalFiles: number;
+        files: Array<{
+            fileStatus: string | null;
+        }>;
+        fileChecks: {
+            antivirusProgress: {
+                filesProcessed: number;
+            };
+            checksumProgress: {
+                filesProcessed: number;
+            };
+            ffidProgress: {
+                filesProcessed: number;
+            };
+        };
+    } | null;
+};
+export type GetFileCheckProgressSummaryQueryVariables = Exact<{
+    consignmentId: string;
+}>;
+export type GetFileCheckProgressSummaryQuery = {
+    getConsignment: {
+        totalFiles: number;
+        fileChecks: {
+            antivirusProgress: {
+                filesProcessed: number;
+            };
+            checksumProgress: {
+                filesProcessed: number;
+            };
+            ffidProgress: {
+                filesProcessed: number;
+            };
+        };
+    } | null;
+};
+export type GetFilesWithUniqueAssetIdKeyQueryVariables = Exact<{
+    consignmentId: string;
+    fileFiltersInput: Types.FileFilters;
+}>;
+export type GetFilesWithUniqueAssetIdKeyQuery = {
+    getConsignment: {
+        files: Array<{
+            fileId: string;
+            fileName: string | null;
+            metadata: {
+                clientSideOriginalFilePath: string | null;
+                clientSideLastModifiedDate: string | null;
+            };
+        }>;
+    } | null;
+};
+export type GetSeriesQueryVariables = Exact<{
+    body: string;
+}>;
+export type GetSeriesQuery = {
+    getSeries: Array<{
+        seriesid: string;
+        bodyid: string;
+        name: string;
+        code: string;
+        description: string | null;
+    }>;
+};
+export type StartUploadMutationVariables = Exact<{
+    input: Types.StartUploadInput;
+}>;
+export type StartUploadMutation = {
+    startUpload: string;
+};
+export type UpdateClientSideDraftMetadataFileNameMutationVariables = Exact<{
+    updateClientSideDraftMetadataFileNameInput: Types.UpdateClientSideDraftMetadataFileNameInput;
+}>;
+export type UpdateClientSideDraftMetadataFileNameMutation = {
+    updateClientSideDraftMetadataFileName: number | null;
+};
+export type UpdateConsignmentMetadataSchemaLibraryVersionMutationVariables = Exact<{
+    updateMetadataSchemaLibraryVersionInput: Types.UpdateMetadataSchemaLibraryVersionInput;
+}>;
+export type UpdateConsignmentMetadataSchemaLibraryVersionMutation = {
+    updateConsignmentMetadataSchemaLibraryVersion: number | null;
+};
+export type UpdateConsignmentSeriesIdMutationVariables = Exact<{
+    updateConsginmentSeriesIdInput: Types.UpdateConsignmentSeriesIdInput;
+}>;
+export type UpdateConsignmentSeriesIdMutation = {
+    updateConsignmentSeriesId: number | null;
+};
+export type UpdateConsignmentStatusMutationVariables = Exact<{
+    updateConsignmentStatusInput: Types.ConsignmentStatusInput;
+}>;
+export type UpdateConsignmentStatusMutation = {
+    updateConsignmentStatus: number | null;
+};
+export type UpdateExportDataMutationVariables = Exact<{
+    updateExportDataInput: Types.UpdateExportDataInput;
+}>;
+export type UpdateExportDataMutation = {
+    updateExportData: number | null;
+};
+export type UpdateParentFolderMutationVariables = Exact<{
+    updateParentFolderInput: Types.UpdateParentFolderInput;
+}>;
+export type UpdateParentFolderMutation = {
+    updateParentFolder: number | null;
+};
+export type UpdateTransferInitiatedMutationVariables = Exact<{
+    consignmentId: string;
+}>;
+export type UpdateTransferInitiatedMutation = {
+    updateTransferInitiated: number | null;
+};
+export declare const AddBulkAntivirusMetadata: import("graphql/language/ast").DocumentNode;
+export declare const AddBulkFfidMetadata: import("graphql/language/ast").DocumentNode;
+export declare const AddConsignment: import("graphql/language/ast").DocumentNode;
+export declare const AddConsignmentStatus: import("graphql/language/ast").DocumentNode;
+export declare const AddFilesAndMetadata: import("graphql/language/ast").DocumentNode;
+export declare const AddFinalTransferConfirmation: import("graphql/language/ast").DocumentNode;
+export declare const AddMultipleFileMetadata: import("graphql/language/ast").DocumentNode;
+export declare const AddMultipleFileStatuses: import("graphql/language/ast").DocumentNode;
+export declare const AddOrUpdateBulkFileMetadata: import("graphql/language/ast").DocumentNode;
+export declare const AddOrUpdateConsignmentMetadata: import("graphql/language/ast").DocumentNode;
+export declare const AddTransferAgreementCompliance: import("graphql/language/ast").DocumentNode;
+export declare const AddTransferAgreementPrivateBeta: import("graphql/language/ast").DocumentNode;
+export declare const GetConsignment: import("graphql/language/ast").DocumentNode;
+export declare const GetConsignmentDetailsForMetadataReview: import("graphql/language/ast").DocumentNode;
+export declare const GetConsignmentForExport: import("graphql/language/ast").DocumentNode;
+export declare const GetConsignmentFiles: import("graphql/language/ast").DocumentNode;
+export declare const GetConsignmentFilesMetadata: import("graphql/language/ast").DocumentNode;
+export declare const GetConsignmentFolderDetails: import("graphql/language/ast").DocumentNode;
+export declare const GetConsignmentMetadata: import("graphql/language/ast").DocumentNode;
+export declare const GetConsignmentPaginatedFiles: import("graphql/language/ast").DocumentNode;
+export declare const GetConsignmentReference: import("graphql/language/ast").DocumentNode;
+export declare const GetConsignmentReviewDetails: import("graphql/language/ast").DocumentNode;
+export declare const GetConsignmentStatus: import("graphql/language/ast").DocumentNode;
+export declare const GetConsignmentSummary: import("graphql/language/ast").DocumentNode;
+export declare const GetConsignmentType: import("graphql/language/ast").DocumentNode;
+export declare const GetConsignments: import("graphql/language/ast").DocumentNode;
+export declare const GetConsignmentsForMetadataReview: import("graphql/language/ast").DocumentNode;
+export declare const GetConsignmentForMetadataReviewRequest: import("graphql/language/ast").DocumentNode;
+export declare const GetFileCheckProgress: import("graphql/language/ast").DocumentNode;
+export declare const GetFileCheckProgressSummary: import("graphql/language/ast").DocumentNode;
+export declare const GetFilesWithUniqueAssetIdKey: import("graphql/language/ast").DocumentNode;
+export declare const GetSeries: import("graphql/language/ast").DocumentNode;
+export declare const StartUpload: import("graphql/language/ast").DocumentNode;
+export declare const UpdateClientSideDraftMetadataFileName: import("graphql/language/ast").DocumentNode;
+export declare const UpdateConsignmentMetadataSchemaLibraryVersion: import("graphql/language/ast").DocumentNode;
+export declare const UpdateConsignmentSeriesId: import("graphql/language/ast").DocumentNode;
+export declare const UpdateConsignmentStatus: import("graphql/language/ast").DocumentNode;
+export declare const UpdateExportData: import("graphql/language/ast").DocumentNode;
+export declare const UpdateParentFolder: import("graphql/language/ast").DocumentNode;
+export declare const UpdateTransferInitiated: import("graphql/language/ast").DocumentNode;