op-client-api-proof-of-concept/lib/nSwagApi/clientApi.d.ts

OP Client API Proof of concept

export declare class Client {
    private http;
    private baseUrl;
    protected jsonParseReviver: ((key: string, value: any) => any) | undefined;
    constructor(baseUrl?: string, http?: {
        fetch(url: RequestInfo, init?: RequestInit): Promise<Response>;
    });
    /**
     * Creates a new act from the request body data.
     * @param includeRelated (optional)
     * @param body (optional)
     * @return Success
     */
    createAct(options: {
        includeRelated: string | undefined;
        body: ActInputExtended | undefined;
    }): Promise<ActExtended>;
    protected processCreateAct(response: Response): Promise<ActExtended>;
    /**
     * Updates the specified act with the request body data.
     * @param entityID (optional)
     * @param actCode (optional)
     * @param barcodeCode (optional)
     * @param includeRelated (optional)
     * @param body (optional)
     * @return Success
     */
    updateAct(entityID: string | undefined, actCode: string | undefined, barcodeCode: string | undefined, includeRelated: string | undefined, body: ActInputExtended | undefined): Promise<ActExtended>;
    protected processUpdateAct(response: Response): Promise<ActExtended>;
    /**
     * Cancels the specified act.
     * @param entityID (optional)
     * @param actCode (optional)
     * @param barcodeCode (optional)
     * @return Success
     */
    cancelAct(entityID: string | undefined, actCode: string | undefined, barcodeCode: string | undefined): Promise<void>;
    protected processCancelAct(response: Response): Promise<void>;
    /**
     * Gets all acts from the database using paging filters.
     * @param pageSize (optional)
     * @param page (optional)
     * @param includePropertySets (optional)
     * @param includeRelated (optional)
     * @param includeCancelled (optional)
     * @return Success
     */
    getAllActs(pageSize: number | undefined, page: number | undefined, includePropertySets: string | undefined, includeRelated: string | undefined, includeCancelled: boolean | undefined): Promise<ActExtended[]>;
    protected processGetAllActs(response: Response): Promise<ActExtended[]>;
    /**
     * Gets the specified act.
     * @param entityID (optional)
     * @param actCode (optional)
     * @param barcodeCode (optional)
     * @param includePropertySets (optional)
     * @param includeRelated (optional)
     * @param includeCancelled (optional)
     * @return Success
     */
    getAct(entityID: string | undefined, actCode: string | undefined, barcodeCode: string | undefined, includePropertySets: string | undefined, includeRelated: string | undefined, includeCancelled: boolean | undefined): Promise<ActExtended>;
    protected processGetAct(response: Response): Promise<ActExtended>;
    /**
     * Gets acts filtered by the oData query.
     * @param includePropertySets (optional)
     * @param includeRelated (optional)
     * @param includeCancelled (optional)
     * @return Success
     */
    searchActs(oDataQuery: string, includePropertySets: string | undefined, includeRelated: string | undefined, includeCancelled: boolean | undefined): Promise<ActExtended[]>;
    protected processSearchActs(response: Response): Promise<ActExtended[]>;
    /**
     * Adds the specified act to the specified case.
     * @param includeRelated (optional)
     * @return Success
     */
    addActToCase(actIdentifier: string, caseIdentifier: string, includeRelated: string | undefined): Promise<CaseExtended>;
    protected processAddActToCase(response: Response): Promise<CaseExtended>;
    /**
     * Sets the owner of the specified act.
     * @param includeRelated (optional)
     * @param body (optional)
     * @return Success
     */
    setActOwner(actIdentifier: string, includeRelated: string | undefined, body: PrincipalIdentifier | undefined): Promise<ActExtended>;
    protected processSetActOwner(response: Response): Promise<ActExtended>;
    /**
     * Adds the solvers to the specified act.
     * @param includeRelated (optional)
     * @param body (optional)
     * @return Success
     */
    addActSolvers(actIdentifier: string, includeRelated: string | undefined, body: PrincipalIdentifier[] | undefined): Promise<ActExtended>;
    protected processAddActSolvers(response: Response): Promise<ActExtended>;
    /**
     * Gets the solvers of the specified act.
     * @param includeRelated (optional)
     * @return Success
     */
    getActSolvers(actIdentifier: string, includeRelated: string | undefined): Promise<SolverRelationExtended[]>;
    protected processGetActSolvers(response: Response): Promise<SolverRelationExtended[]>;
    /**
     * Adds the readers to the specified act.
     * @param includeRelated (optional)
     * @param body (optional)
     * @return Success
     */
    addActReaders(actIdentifier: string, includeRelated: string | undefined, body: PrincipalIdentifier[] | undefined): Promise<ActExtended>;
    protected processAddActReaders(response: Response): Promise<ActExtended>;
    /**
     * Gets the readers of the specified act.
     * @param includeRelated (optional)
     * @return Success
     */
    getActReaders(actIdentifier: string, includeRelated: string | undefined): Promise<SolverRelationExtended[]>;
    protected processGetActReaders(response: Response): Promise<SolverRelationExtended[]>;
    /**
     * Removes a solvers from the specified act.
     * @param includeRelated (optional)
     * @return Success
     */
    removeActSolver(actIdentifier: string, solverRelationEntityID: string, includeRelated: string | undefined): Promise<ActExtended>;
    protected processRemoveActSolver(response: Response): Promise<ActExtended>;
    /**
     * Removes a reader from the specified act.
     * @param includeRelated (optional)
     * @return Success
     */
    removeActReader(actIdentifier: string, solverRelationEntityID: string, includeRelated: string | undefined): Promise<ActExtended>;
    protected processRemoveActReader(response: Response): Promise<ActExtended>;
    /**
     * Adds an act document to the specified act.
     * @param includeRelated (optional)
     * @param body (optional)
     * @return Success
     */
    addActDocument(actIdentifier: string, includeRelated: string | undefined, body: ActDocumentInput | undefined): Promise<ActExtended>;
    protected processAddActDocument(response: Response): Promise<ActExtended>;
    /**
     * Gets the act document of the specified act.
     * @param includeRelated (optional)
     * @return Success
     */
    getActDocument(actIdentifier: string, includeRelated: string | undefined): Promise<OfficePointDocumentExtended>;
    protected processGetActDocument(response: Response): Promise<OfficePointDocumentExtended>;
    /**
     * Adds an attachment to the specified act.
     * @param includeRelated (optional)
     * @param body (optional)
     * @return Success
     */
    addActAttachment(actIdentifier: string, includeRelated: string | undefined, body: AttachmentInput | undefined): Promise<ActExtended>;
    protected processAddActAttachment(response: Response): Promise<ActExtended>;
    /**
     * Gets the attachments of the specified act.
     * @param includeRelated (optional)
     * @return Success
     */
    getActAttachments(actIdentifier: string, includeRelated: string | undefined): Promise<AttachmentExtended[]>;
    protected processGetActAttachments(response: Response): Promise<AttachmentExtended[]>;
    /**
     * Adds related acts to the specified act.
     * @param includeRelated (optional)
     * @param body (optional)
     * @return Success
     */
    addRelatedActs(actIdentifier: string, includeRelated: string | undefined, body: ActIdentifier[] | undefined): Promise<ActExtended>;
    protected processAddRelatedActs(response: Response): Promise<ActExtended>;
    /**
     * Gets the related acts of the specified act.
     * @param includeRelated (optional)
     * @return Success
     */
    getActRelatedActs(actIdentifier: string, includeRelated: string | undefined): Promise<ActExtended[]>;
    protected processGetActRelatedActs(response: Response): Promise<ActExtended[]>;
    /**
     * Gets the creator person of the specified act.
     * @param includeRelated (optional)
     * @return Success
     */
    getActCreator(actIdentifier: string, includeRelated: string | undefined): Promise<PersonExtended>;
    protected processGetActCreator(response: Response): Promise<PersonExtended>;
    /**
     * Gets the 'modified by' person of the specified act.
     * @param includeRelated (optional)
     * @return Success
     */
    getActModifiedBy(actIdentifier: string, includeRelated: string | undefined): Promise<PersonExtended>;
    protected processGetActModifiedBy(response: Response): Promise<PersonExtended>;
    /**
     * Gets the class of the specified act.
     * @param includeRelated (optional)
     * @return Success
     */
    getActClass(actIdentifier: string, includeRelated: string | undefined): Promise<ClassExtended>;
    protected processGetActClass(response: Response): Promise<ClassExtended>;
    /**
     * Convenience endpoint only for internal use by ES GUI. Not supported for any other use.
     * @return Success
     */
    getActDocumentVersionsOverAllBinaries(actIdentifier: string): Promise<ActDocumentVersionOverAllBinaries[]>;
    protected processGetActDocumentVersionsOverAllBinaries(response: Response): Promise<ActDocumentVersionOverAllBinaries[]>;
    /**
     * Gets the subjects of the specified act.
     * @param includeRelated (optional)
     * @return Success
     */
    getActSubjects(actIdentifier: string, includeRelated: string | undefined): Promise<SubjectRelationExtended[]>;
    protected processGetActSubjects(response: Response): Promise<SubjectRelationExtended[]>;
    /**
     * Gets the primary subject of the specified act.
     * @param includeRelated (optional)
     * @return Success
     */
    getActPrimarySubject(actIdentifier: string, includeRelated: string | undefined): Promise<SubjectRelationExtended>;
    protected processGetActPrimarySubject(response: Response): Promise<SubjectRelationExtended>;
    /**
     * Gets the author subject of the specified act.
     * @param includeRelated (optional)
     * @return Success
     */
    getActAuthorSubject(actIdentifier: string, includeRelated: string | undefined): Promise<SubjectExtended>;
    protected processGetActAuthorSubject(response: Response): Promise<SubjectExtended>;
    /**
     * Gets the author person of the specified act.
     * @param includeRelated (optional)
     * @return Success
     */
    getActAuthorPerson(actIdentifier: string, includeRelated: string | undefined): Promise<PersonExtended>;
    protected processGetActAuthorPerson(response: Response): Promise<PersonExtended>;
    /**
     * Gets the author organisational unit of the specified act.
     * @param includeRelated (optional)
     * @return Success
     */
    getActAuthorOrganisationalUnit(actIdentifier: string, includeRelated: string | undefined): Promise<OrganisationalUnitExtended>;
    protected processGetActAuthorOrganisationalUnit(response: Response): Promise<OrganisationalUnitExtended>;
    /**
     * Gets the author role of the specified act.
     * @param includeRelated (optional)
     * @return Success
     */
    getActAuthorRole(actIdentifier: string, includeRelated: string | undefined): Promise<RoleExtended>;
    protected processGetActAuthorRole(response: Response): Promise<RoleExtended>;
    /**
     * Gets the owner person of the specified act.
     * @param includeRelated (optional)
     * @return Success
     */
    getActOwnerPerson(actIdentifier: string, includeRelated: string | undefined): Promise<PersonExtended>;
    protected processGetActOwnerPerson(response: Response): Promise<PersonExtended>;
    /**
     * Gets the owner organisational unit of the specified act.
     * @param includeRelated (optional)
     * @return Success
     */
    getActOwnerOrganisationalUnit(actIdentifier: string, includeRelated: string | undefined): Promise<OrganisationalUnitExtended>;
    protected processGetActOwnerOrganisationalUnit(response: Response): Promise<OrganisationalUnitExtended>;
    /**
     * Gets the owner role of the specified act.
     * @param includeRelated (optional)
     * @return Success
     */
    getActOwnerRole(actIdentifier: string, includeRelated: string | undefined): Promise<RoleExtended>;
    protected processGetActOwnerRole(response: Response): Promise<RoleExtended>;
    /**
     * Gets the location of the specified act.
     * @param includeRelated (optional)
     * @return Success
     */
    getActLocation(actIdentifier: string, includeRelated: string | undefined): Promise<LocationExtended>;
    protected processGetActLocation(response: Response): Promise<LocationExtended>;
    /**
     * Gets the internal shipment of the specified act.
     * @param includeRelated (optional)
     * @return Success
     */
    getActInternalShipment(actIdentifier: string, includeRelated: string | undefined): Promise<InternalShipmentExtended>;
    protected processGetActInternalShipment(response: Response): Promise<InternalShipmentExtended>;
    /**
     * Gets the internal shipment item of the specified act.
     * @param includeRelated (optional)
     * @return Success
     */
    getActInternalShipmentItem(actIdentifier: string, includeRelated: string | undefined): Promise<InternalShipmentItemExtended>;
    protected processGetActInternalShipmentItem(response: Response): Promise<InternalShipmentItemExtended>;
    /**
     * Removes the specified act from the internal shipment.
     * @param includeRelated (optional)
     * @return Success
     */
    removeActFromInternalShipment(actIdentifier: string, includeRelated: string | undefined): Promise<InternalShipmentExtended>;
    protected processRemoveActFromInternalShipment(response: Response): Promise<InternalShipmentExtended>;
    /**
     * Gets the confidentiality of the specified act.
     * @return Success
     */
    getActConfidentiality(actIdentifier: string): Promise<Confidentiality>;
    protected processGetActConfidentiality(response: Response): Promise<Confidentiality>;
    /**
     * Gets the state transfer history of the specified act.
     * @return Success
     */
    getActStateHistory(actIdentifier: string): Promise<StateTransferHistory[]>;
    protected processGetActStateHistory(response: Response): Promise<StateTransferHistory[]>;
    /**
     * Gets the comments of the specified act.
     * @return Success
     */
    getActComments(actIdentifier: string): Promise<Comment[]>;
    protected processGetActComments(response: Response): Promise<Comment[]>;
    /**
     * Adds the comments to the specified act.
     * @param includeRelated (optional)
     * @param body (optional)
     * @return Success
     */
    addActComments(actIdentifier: string, includeRelated: string | undefined, body: CommentInput[] | undefined): Promise<ActExtended>;
    protected processAddActComments(response: Response): Promise<ActExtended>;
    /**
     * Gets the index data of the specified act.
     * @param includeCancelled (optional)
     * @return Success
     */
    getActIndexData(actIdentifier: string, includeCancelled: boolean | undefined): Promise<string>;
    protected processGetActIndexData(response: Response): Promise<string>;
    /**
     * Gets the entity versions of the specified act.
     * @param includeRelated (optional)
     * @return Success
     */
    getActEntityVersioning(actIdentifier: string, includeRelated: string | undefined): Promise<EntityVersionExtended[]>;
    protected processGetActEntityVersioning(response: Response): Promise<EntityVersionExtended[]>;
    /**
     * Gets the activity audit of the act specified with the actIdentifier.
     * @param includeRelated (optional)
     * @return Success
     */
    getActActivityAudit(actIdentifier: string, includeRelated: string | undefined): Promise<AuditItemExtended[]>;
    protected processGetActActivityAudit(response: Response): Promise<AuditItemExtended[]>;
    /**
     * Gets the archived container of the act specified with the actIdentifier.
     * @param includeRelated (optional)
     * @return Success
     */
    getActArchivedContainer(actIdentifier: string, includeRelated: string | undefined): Promise<ContainerExtended>;
    protected processGetActArchivedContainer(response: Response): Promise<ContainerExtended>;
    /**
     * Gets the record office history of the act specified with the actIdentifier.
     * @param includeRelated (optional)
     * @return Success
     */
    getActRecordOfficeHistory(actIdentifier: string, includeRelated: string | undefined): Promise<RecordOfficeReceiptExtended[]>;
    protected processGetActRecordOfficeHistory(response: Response): Promise<RecordOfficeReceiptExtended[]>;
    /**
     * Gets the specified act retention policy.
     * @param includeRelated (optional)
     * @return Success
     */
    getActRetentionPolicy(actIdentifier: string, includeRelated: string | undefined): Promise<RetentionPolicyExtended>;
    protected processGetActRetentionPolicy(response: Response): Promise<RetentionPolicyExtended>;
    /**
     * Gets the internal dispatch history of the act specified with the actIdentifier.
     * @param includeRelated (optional)
     * @return Success
     */
    getActInternalDispatchHistory(actIdentifier: string, includeRelated: string | undefined): Promise<InternalShipmentItemExtended[]>;
    protected processGetActInternalDispatchHistory(response: Response): Promise<InternalShipmentItemExtended[]>;
    /**
     * Gets the act specified by the actIdentifier from the record office.
     * @param includeRelated (optional)
     * @param body (optional)
     * @return Success
     */
    getActFromRecordOffice(actIdentifier: string, includeRelated: string | undefined, body: GetActFromRecordOfficeInput | undefined): Promise<ActExtended>;
    protected processGetActFromRecordOffice(response: Response): Promise<ActExtended>;
    /**
     * This method will archive the Act by creating a ContainerItem object with the specified parameters, and assigning it to the specified container. If a ContainerItem already exists, the Act will only be moved to a different Container, and if the Container is the same, only the RecordOfficeHistory will be updated.
     * @param includeRelated (optional)
     * @param body (optional)
     * @return Success
     */
    sendActToRecordOffice(actIdentifier: string, includeRelated: string | undefined, body: SendActToRecordOfficeInput | undefined): Promise<ActExtended>;
    protected processSendActToRecordOffice(response: Response): Promise<ActExtended>;
    /**
     * Sends the act specified by the actIdentifier to the record office.
     * @param includeRelated (optional)
     * @param body (optional)
     * @return Success
     */
    sendActToPassiveRecordOffice(actIdentifier: string, includeRelated: string | undefined, body: SendToPassiveRecordOfficeInput | undefined): Promise<ActExtended>;
    protected processSendActToPassiveRecordOffice(response: Response): Promise<ActExtended>;
    /**
     * Returns true if the specified act is in receivable status, false otherwise.
     * @return Success
     */
    actIsInReceivableStatus(actIdentifier: string): Promise<boolean>;
    protected processActIsInReceivableStatus(response: Response): Promise<boolean>;
    /**
     * Returns true if the act is in received status, false otherwise.
     * @return Success
     */
    actIsInReceivedStatus(actIdentifier: string): Promise<boolean>;
    protected processActIsInReceivedStatus(response: Response): Promise<boolean>;
    /**
     * Returns active LegalHold entities, related to specified Act
     * @param includeRelated (optional)
     * @return Success
     */
    getActActiveLegalHolds(actIdentifier: string, includeRelated: string | undefined): Promise<LegalHoldExtended[]>;
    protected processGetActActiveLegalHolds(response: Response): Promise<LegalHoldExtended[]>;
    /**
     * Deactivate all LegalHold entities, related to specified Act
     * @param includeRelated (optional)
     * @param body (optional)
     * @return Success
     */
    deactivateAllActLegalHolds(actIdentifier: string, includeRelated: string | undefined, body: DeactivateAllLegalHoldsOnEntityInput | undefined): Promise<LegalHoldExtended[]>;
    protected processDeactivateAllActLegalHolds(response: Response): Promise<LegalHoldExtended[]>;
    /**
     * Create new LegalHold entity, related to specified Act
     * @param includeRelated (optional)
     * @param body (optional)
     * @return Success
     */
    setActLegalHold(actIdentifier: string, includeRelated: string | undefined, body: CreateLegalHoldInput | undefined): Promise<LegalHoldExtended>;
    protected processSetActLegalHold(response: Response): Promise<LegalHoldExtended>;
    /**
     * Resets the grace period on specifed Act to 0
     * @return Success
     */
    resetActGracePeriod(actIdentifier: string): Promise<void>;
    protected processResetActGracePeriod(response: Response): Promise<void>;
    /**
     * Gets all active act types in a flat data structure.
     * @return Success
     */
    flat(): Promise<ActTypeTreeItem[]>;
    protected processFlat(response: Response): Promise<ActTypeTreeItem[]>;
    /**
     * Gets all active act types in a treelike data structure with parent-child relations.
     * @return Success
     */
    tree(): Promise<TreeItem[]>;
    protected processTree(response: Response): Promise<TreeItem[]>;
    /**
     * Gets act types filtered by the oData query.
     * @param includePropertySets (optional)
     * @param includeRelated (optional)
     * @param includeCancelled (optional)
     * @return Success
     */
    searchActTypes(oDataQuery: string, includePropertySets: string | undefined, includeRelated: string | undefined, includeCancelled: boolean | undefined): Promise<ActTypeExtended[]>;
    protected processSearchActTypes(response: Response): Promise<ActTypeExtended[]>;
    /**
     * Gets the descendants of the specified act type in a flat data structure.
     * @param includeAllDescendants (optional)
     * @param includeRelated (optional)
     * @param includeInactive (optional)
     * @return Success
     */
    getActTypeDescendants(actTypeIdentifier: string, includeAllDescendants: boolean | undefined, includeRelated: string | undefined, includeInactive: boolean | undefined): Promise<ActTypeExtended[]>;
    protected processGetActTypeDescendants(response: Response): Promise<ActTypeExtended[]>;
    /**
     * Checks if the specified barcode is available for assignment.
     * @return Success
     */
    checkBarcodeAvailabilityForAssignment(entityDefinitionName: string, barcodeCodeToAssign: string): Promise<BarcodeAvailability>;
    protected processCheckBarcodeAvailabilityForAssignment(response: Response): Promise<BarcodeAvailability>;
    /**
     * Gets the books filtered with the provided ODataQuery.
     * @param includePropertySets (optional)
     * @param includeRelated (optional)
     * @param includeInactive (optional)
     * @return Success
     */
    searchBooks(oDataQuery: string, includePropertySets: string | undefined, includeRelated: string | undefined, includeInactive: boolean | undefined): Promise<BookExtended[]>;
    protected processSearchBooks(response: Response): Promise<BookExtended[]>;
    /**
     * Get all books from the database using paging filters.
     * @param pageSize (optional)
     * @param page (optional)
     * @param includePropertySets (optional)
     * @param includeRelated (optional)
     * @param includeInactive (optional)
     * @return Success
     */
    getAllBooks(pageSize: number | undefined, page: number | undefined, includePropertySets: string | undefined, includeRelated: string | undefined, includeInactive: boolean | undefined): Promise<BookExtended[]>;
    protected processGetAllBooks(response: Response): Promise<BookExtended[]>;
    /**
     * Gets a single book speficied with a unique identifier.
     * @param entityID (optional)
     * @param bookCode (optional)
     * @param includePropertySets (optional)
     * @param includeRelated (optional)
     * @return Success
     */
    getBook(entityID: string | undefined, bookCode: string | undefined, includePropertySets: string | undefined, includeRelated: string | undefined): Promise<BookExtended>;
    protected processGetBook(response: Response): Promise<BookExtended>;
    /**
     * Gets a default book.
     * @param includePropertySets (optional)
     * @param includeRelated (optional)
     * @return Success
     */
    getDefaultBook(includePropertySets: string | undefined, includeRelated: string | undefined): Promise<BookExtended>;
    protected processGetDefaultBook(response: Response): Promise<BookExtended>;
    /**
     * Creates a new case from the request body data.
     * @param includeRelated (optional)
     * @param body (optional)
     * @return Success
     */
    createCase(includeRelated: string | undefined, body: CaseInputExtended | undefined): Promise<CaseExtended>;
    protected processCreateCase(response: Response): Promise<CaseExtended>;
    /**
     * Updates the specified case with the request body data.
     * @param entityID (optional)
     * @param caseCode (optional)
     * @param barcodeCode (optional)
     * @param includeRelated (optional)
     * @param body (optional)
     * @return Success
     */
    updateCase(entityID: string | undefined, caseCode: string | undefined, barcodeCode: string | undefined, includeRelated: string | undefined, body: CaseInputExtended | undefined): Promise<CaseExtended>;
    protected processUpdateCase(response: Response): Promise<CaseExtended>;
    /**
     * Cancels the specified case.
     * @param entityID (optional)
     * @param caseCode (optional)
     * @param barcodeCode (optional)
     * @return Success
     */
    cancelCase(entityID: string | undefined, caseCode: string | undefined, barcodeCode: string | undefined): Promise<void>;
    protected processCancelCase(response: Response): Promise<void>;
    /**
     * Gets all cases from the database using paging filters.
     * @param pageSize (optional)
     * @param page (optional)
     * @param includePropertySets (optional)
     * @param includeRelated (optional)
     * @param includeCancelled (optional)
     * @return Success
     */
    getAllCases(pageSize: number | undefined, page: number | undefined, includePropertySets: string | undefined, includeRelated: string | undefined, includeCancelled: boolean | undefined): Promise<CaseExtended[]>;
    protected processGetAllCases(response: Response): Promise<CaseExtended[]>;
    /**
     * Gets the specified case.
     * @param entityID (optional)
     * @param caseCode (optional)
     * @param barcodeCode (optional)
     * @param includePropertySets (optional)
     * @param includeRelated (optional)
     * @param includeCancelled (optional)
     * @return Success
     */
    getCase(entityID: string | undefined, caseCode: string | undefined, barcodeCode: string | undefined, includePropertySets: string | undefined, includeRelated: string | undefined, includeCancelled: boolean | undefined): Promise<CaseExtended>;
    protected processGetCase(response: Response): Promise<CaseExtended>;
    /**
     * Gets cases filtered by the oData query.
     * @param includePropertySets (optional)
     * @param includeRelated (optional)
     * @param includeCancelled (optional)
     * @return Success
     */
    searchCases(oDataQuery: string, includePropertySets: string | undefined, includeRelated: string | undefined, includeCancelled: boolean | undefined): Promise<CaseExtended[]>;
    protected processSearchCases(response: Response): Promise<CaseExtended[]>;
    /**
     * Adds the specified act to the specified case.
     * @param includeRelated (optional)
     * @return Success
     */
    caseAddAct(caseIdentifier: string, actIdentifier: string, includeRelated: string | undefined): Promise<CaseExtended>;
    protected processCaseAddAct(response: Response): Promise<CaseExtended>;
    /**
     * Sets the owner of the specified case.
     * @param includeRelated (optional)
     * @param body (optional)
     * @return Success
     */
    setCaseOwner(caseIdentifier: string, includeRelated: string | undefined, body: PrincipalIdentifier | undefined): Promise<CaseExtended>;
    protected processSetCaseOwner(response: Response): Promise<CaseExtended>;
    /**
     * Adds the solvers to the specified case.
     * @param includeRelated (optional)
     * @param body (optional)
     * @return Success
     */
    addCaseSolvers(caseIdentifier: string, includeRelated: string | undefined, body: PrincipalIdentifier[] | undefined): Promise<CaseExtended>;
    protected processAddCaseSolvers(response: Response): Promise<CaseExtended>;
    /**
     * Gets the solvers of the specified case.
     * @param includeRelated (optional)
     * @return Success
     */
    getCaseSolvers(caseIdentifier: string, includeRelated: string | undefined): Promise<SolverRelationExtended[]>;
    protected processGetCaseSolvers(response: Response): Promise<SolverRelationExtended[]>;
    /**
     * Adds the readers to the specified case.
     * @param includeRelated (optional)
     * @param body (optional)
     * @return Success
     */
    addCaseReaders(caseIdentifier: string, includeRelated: string | undefined, body: PrincipalIdentifier[] | undefined): Promise<CaseExtended>;
    protected processAddCaseReaders(response: Response): Promise<CaseExtended>;
    /**
     * Gets the readers of the specified case.
     * @param includeRelated (optional)
     * @return Success
     */
    getCaseReaders(caseIdentifier: string, includeRelated: string | undefined): Promise<SolverRelationExtended[]>;
    protected processGetCaseReaders(response: Response): Promise<SolverRelationExtended[]>;
    /**
     * Removes a solver from the specified case.
     * @param includeRelated (optional)
     * @return Success
     */
    removeCaseSolver(caseIdentifier: string, solverRelationEntityID: string, includeRelated: string | undefined): Promise<CaseExtended>;
    protected processRemoveCaseSolver(response: Response): Promise<CaseExtended>;
    /**
     * Removes a reader from the specified case.
     * @param includeRelated (optional)
     * @return Success
     */
    removeCaseReader(caseIdentifier: string, solverRelationEntityID: string, includeRelated: string | undefined): Promise<CaseExtended>;
    protected processRemoveCaseReader(response: Response): Promise<CaseExtended>;
    /**
     * Adds the related cases to the specified case.
     * @param includeRelated (optional)
     * @param body (optional)
     * @return Success
     */
    addRelatedCases(caseIdentifier: string, includeRelated: string | undefined, body: CaseIdentifier[] | undefined): Promise<CaseExtended>;
    protected processAddRelatedCases(response: Response): Promise<CaseExtended>;
    /**
     * Gets the related cases of the specified case.
     * @param includeRelated (optional)
     * @return Success
     */
    getCaseRelatedCases(caseIdentifier: string, includeRelated: string | undefined): Promise<CaseExtended[]>;
    protected processGetCaseRelatedCases(response: Response): Promise<CaseExtended[]>;
    /**
     * Removes the relation between the case specified with the caseIdentifier and the case specified with the relatedCaseIdentifier
     * @return Success
     */
    removeCaseRelation(caseIdentifier: string, relatedCaseIdentifier: string): Promise<void>;
    protected processRemoveCaseRelation(response: Response): Promise<void>;
    /**
     * Gets the index data of the specified case.
     * @param includeCancelled (optional)
     * @return Success
     */
    getCaseIndexData(caseIdentifier: string, includeCancelled: boolean | undefined): Promise<string>;
    protected processGetCaseIndexData(response: Response): Promise<string>;
    /**
     * Gets the comments of the specified case.
     * @return Success
     */
    getCaseComments(caseIdentifier: string): Promise<Comment[]>;
    protected processGetCaseComments(response: Response): Promise<Comment[]>;
    /**
     * Adds the comments to the specified case.
     * @param includeRelated (optional)
     * @param body (optional)
     * @return Success
     */
    addCaseComments(caseIdentifier: string, includeRelated: string | undefined, body: CommentInput[] | undefined): Promise<CaseExtended>;
    protected processAddCaseComments(response: Response): Promise<CaseExtended>;
    /**
     * Gets the case specified by the caseIdentifier from the record office.
     * @param includeRelated (optional)
     * @param body (optional)
     * @return Success
     */
    getCaseFromRecordOffice(caseIdentifier: string, includeRelated: string | undefined, body: GetCaseFromRecordOfficeInput | undefined): Promise<CaseExtended>;
    protected processGetCaseFromRecordOffice(response: Response): Promise<CaseExtended>;
    /**
     * Archives the Case by creating a ContainerItem object with the specified parameters, and assigning it to the specified container.If a ContainerItem already exists, the Case will only be moved to a different Container, and if the Container is the same, only the RecordOfficeHistory will be updated.In addition, all the Acts in the Case will go throught the same workflow as the Case if the includeAllActs bool is set to true.
     * @param includeRelated (optional)
     * @param body (optional)
     * @return Success
     */
    sendCaseToRecordOffice(caseIdentifier: string, includeRelated: string | undefined, body: SendCaseToRecordOfficeInput | undefined): Promise<CaseExtended>;
    protected processSendCaseToRecordOffice(response: Response): Promise<CaseExtended>;
    /**
     * Sends the case specified by the caseIdentifier to the record office.
     * @param includeRelated (optional)
     * @param body (optional)
     * @return Success
     */
    sendCaseToPassiveRecordOffice(caseIdentifier: string, includeRelated: string | undefined, body: SendToPassiveRecordOfficeInput | undefined): Promise<CaseExtended>;
    protected processSendCaseToPassiveRecordOffice(response: Response): Promise<CaseExtended>;
    /**
     * Gets the creator person of the specified case.
     * @param includeRelated (optional)
     * @return Success
     */
    getCaseCreator(caseIdentifier: string, includeRelated: string | undefined): Promise<PersonExtended>;
    protected processGetCaseCreator(response: Response): Promise<PersonExtended>;
    /**
     * Gets the 'modified by' person of the specified case.
     * @param includeRelated (optional)
     * @return Success
     */
    getCaseModifiedBy(caseIdentifier: string, includeRelated: string | undefined): Promise<PersonExtended>;
    protected processGetCaseModifiedBy(response: Response): Promise<PersonExtended>;
    /**
     * Gets the case type of the specified case.
     * @param includeRelated (optional)
     * @return Success
     */
    getCaseType(caseIdentifier: string, includeRelated: string | undefined): Promise<CaseTypeExtended>;
    protected processGetCaseType(response: Response): Promise<CaseTypeExtended>;
    /**
     * Gets the dossier of the specified case.
     * @param includeRelated (optional)
     * @return Success
     */
    getCaseDossier(caseIdentifier: string, includeRelated: string | undefined): Promise<DossierExtended>;
    protected processGetCaseDossier(response: Response): Promise<DossierExtended>;
    /**
     * Gets the book of the specified case.
     * @param includeRelated (optional)
     * @return Success
     */
    getCaseBook(caseIdentifier: string, includeRelated: string | undefined): Promise<BookExtended>;
    protected processGetCaseBook(response: Response): Promise<BookExtended>;
    /**
     * Gets the owner person of the specified case.
     * @param includeRelated (optional)
     * @return Success
     */
    getCaseOwnerPerson(caseIdentifier: string, includeRelated: string | undefined): Promise<PersonExtended>;
    protected processGetCaseOwnerPerson(response: Response): Promise<PersonExtended>;
    /**
     * Gets the owner organisational unit of the specified case.
     * @param includeRelated (optional)
     * @return Success
     */
    getCaseOwnerOrganisationalUnit(caseIdentifier: string, includeRelated: string | undefined): Promise<OrganisationalUnitExtended>;
    protected processGetCaseOwnerOrganisationalUnit(response: Response): Promise<OrganisationalUnitExtended>;
    /**
     * Gets the owner role of the specified case.
     * @param includeRelated (optional)
     * @return Success
     */
    getCaseOwnerRole(caseIdentifier: string, includeRelated: string | undefined): Promise<RoleExtended>;
    protected processGetCaseOwnerRole(response: Response): Promise<RoleExtended>;
    /**
     * Gets the location of the specified case.
     * @param includeRelated (optional)
     * @return Success
     */
    getCaseLocation(caseIdentifier: string, includeRelated: string | undefined): Promise<LocationExtended>;
    protected processGetCaseLocation(response: Response): Promise<LocationExtended>;
    /**
     * Gets the primary subject of the specified case.
     * @param includeRelated (optional)
     * @return Success
     */
    getCasePrimarySubject(caseIdentifier: string, includeRelated: string | undefined): Promise<SubjectRelationExtended>;
    protected processGetCasePrimarySubject(response: Response): Promise<SubjectRelationExtended>;
    /**
     * Gets the internal shipment parent of the specified case.
     * @param includeRelated (optional)
     * @return Success
     */
    getCaseInternalShipmentParent(caseIdentifier: string, includeRelated: string | undefined): Promise<InternalShipmentExtended>;
    protected processGetCaseInternalShipmentParent(response: Response): Promise<InternalShipmentExtended>;
    /**
     * Gets the intenral shipment item of the specified case.
     * @param includeRelated (optional)
     * @return Success
     */
    getCaseInternalShipmentItem(caseIdentifier: string, includeRelated: string | undefined): Promise<InternalShipmentItemExtended>;
    protected processGetCaseInternalShipmentItem(response: Response): Promise<InternalShipmentItemExtended>;
    /**
     * Removes the specified case from the internal shipment.
     * @param includeRelated (optional)
     * @return Success
     */
    removeCaseFromInternalShipment(caseIdentifier: string, includeRelated: string | undefined): Promise<InternalShipmentExtended>;
    protected processRemoveCaseFromInternalShipment(response: Response): Promise<InternalShipmentExtended>;
    /**
     * Gets the confidentiality of the specified case.
     * @return Success
     */
    getCaseConfidentiality(caseIdentifier: string): Promise<Confidentiality>;
    protected processGetCaseConfidentiality(response: Response): Promise<Confidentiality>;
    /**
     * Gets the acts of the specified case.
     * @param includeRelated (optional)
     * @return Success
     */
    getCaseActs(caseIdentifier: string, includeRelated: string | undefined): Promise<ActExtended[]>;
    protected processGetCaseActs(response: Response): Promise<ActExtended[]>;
    /**
     * Gets the subjects of the specified case.
     * @param includeRelated (optional)
     * @return Success
     */
    getCaseSubjects(caseIdentifier: string, includeRelated: string | undefined): Promise<SubjectRelationExtended[]>;
    protected processGetCaseSubjects(response: Response): Promise<SubjectRelationExtended[]>;
    /**
     * Gets the state history of the specified case.
     * @return Success
     */
    getCaseStateHistory(caseIdentifier: string): Promise<StateTransferHistory[]>;
    protected processGetCaseStateHistory(response: Response): Promise<StateTransferHistory[]>;
    /**
     * Gets the entity versions of the specified case.
     * @param includeRelated (optional)
     * @return Success
     */
    getCaseEntityVersioning(caseIdentifier: string, includeRelated: string | undefined): Promise<EntityVersionExtended[]>;
    protected processGetCaseEntityVersioning(response: Response): Promise<EntityVersionExtended[]>;
    /**
     * Gets the activity audit of the case specified with the caseIdentifier.
     * @param includeRelated (optional)
     * @return Success
     */
    getCaseActivityAudit(caseIdentifier: string, includeRelated: string | undefined): Promise<AuditItemExtended[]>;
    protected processGetCaseActivityAudit(response: Response): Promise<AuditItemExtended[]>;
    /**
     * Gets the archived container of the case specified with the caseIdentifier.
     * @param includeRelated (optional)
     * @return Success
     */
    getCaseArchivedContainer(caseIdentifier: string, includeRelated: string | undefined): Promise<ContainerExtended>;
    protected processGetCaseArchivedContainer(response: Response): Promise<ContainerExtended>;
    /**
     * Gets the container item of the case specified with the caseIdentifier.
     * @param includeRelated (optional)
     * @return Success
     */
    getCaseContainerItem(caseIdentifier: string, includeRelated: string | undefined): Promise<ContainerItemExtended>;
    protected processGetCaseContainerItem(response: Response): Promise<ContainerItemExtended>;
    /**
     * Gets the record office history of the case specified with the caseIdentifier.
     * @param includeRelated (optional)
     * @return Success
     */
    getCaseRecordOfficeHistory(caseIdentifier: string, includeRelated: string | undefined): Promise<RecordOfficeReceiptExtended[]>;
    protected processGetCaseRecordOfficeHistory(response: Response): Promise<RecordOfficeReceiptExtended[]>;
    /**
     * Gets the specified case retention policy.
     * @param includeRelated (optional)
     * @return Success
     */
    getCaseRetentionPolicy(caseIdentifier: string, includeRelated: string | undefined): Promise<RetentionPolicyExtended>;
    protected processGetCaseRetentionPolicy(response: Response): Promise<RetentionPolicyExtended>;
    /**
     * Gets the internal dispatch history of the case specified with the caseIdentifier.
     * @param includeRelated (optional)
     * @return Success
     */
    getCaseInternalDispatchHistory(caseIdentifier: string, includeRelated: string | undefined): Promise<InternalShipmentItemExtended[]>;
    protected processGetCaseInternalDispatchHistory(response: Response): Promise<InternalShipmentItemExtended[]>;
    /**
     * Returns true if the case is in receivable status, false otherwise.
     * @return Success
     */
    caseIsInReceivableStatus(caseIdentifier: string): Promise<boolean>;
    protected processCaseIsInReceivableStatus(response: Response): Promise<boolean>;
    /**
     * Returns true if the case is in received status, false otherwise.
     * @return Success
     */
    caseIsInReceivedStatus(caseIdentifier: string): Promise<boolean>;
    protected processCaseIsInReceivedStatus(response: Response): Promise<boolean>;
    /**
     * Returns active LegalHold entities, related to specified Case
     * @param includeRelated (optional)
     * @return Success
     */
    getCaseActiveLegalHolds(caseIdentifier: string, includeRelated: string | undefined): Promise<LegalHoldExtended[]>;
    protected processGetCaseActiveLegalHolds(response: Response): Promise<LegalHoldExtended[]>;
    /**
     * Deactivate all LegalHold entities, related to specified Case
     * @param includeRelated (optional)
     * @param body (optional)
     * @return Success
     */
    deactivateAllCaseLegalHolds(caseIdentifier: string, includeRelated: string | undefined, body: DeactivateAllLegalHoldsOnEntityInput | undefined): Promise<LegalHoldExtended[]>;
    protected processDeactivateAllCaseLegalHolds(response: Response): Promise<LegalHoldExtended[]>;
    /**
     * Create new LegalHold entity, related to specified Case
     * @param includeRelated (optional)
     * @param body (optional)
     * @return Success
     */
    setCaseLegalHold(caseIdentifier: string, includeRelated: string | undefined, body: CreateLegalHoldInput | undefined): Promise<LegalHoldExtended>;
    protected processSetCaseLegalHold(response: Response): Promise<LegalHoldExtended>;
    /**
     * Resets the Grace period on specifed Case to 0. Optionally, also reset grace period on all child Acts of that Case
     * @param resetChildActsGracePeriod (optional)
     * @return Success
     */
    resetCaseGracePeriod(caseIdentifier: string, resetChildActsGracePeriod: boolean | undefined): Promise<void>;
    protected processResetCaseGracePeriod(response: Response): Promise<void>;
    /**
     * Gets all case types from the database using paging filters.
     * @param pageSize (optional)
     * @param page (optional)
     * @param includePropertySets (optional)
     * @param includeRelated (optional)
     * @param includeCancelled (optional)
     * @return Success
     */
    getAllCaseTypes(pageSize: number | undefined, page: number | undefined, includePropertySets: string | undefined, includeRelated: string | undefined, includeCancelled: boolean | undefined): Promise<CaseTypeExtended[]>;
    protected processGetAllCaseTypes(response: Response): Promise<CaseTypeExtended[]>;
    /**
     * Gets case types filtered by the oData query.
     * @param includePropertySets (optional)
     * @param includeRelated (optional)
     * @param includeCancelled (optional)
     * @return Success
     */
    searchCaseTypes(oDataQuery: string, includePropertySets: string | undefined, includeRelated: string | undefined, includeCancelled: boolean | undefined): Promise<CaseTypeExtended[]>;
    protected processSearchCaseTypes(response: Response): Promise<CaseTypeExtended[]>;
    /**
     * Gets the descendants of the specified case type.
     * @param includeAllDescendants (optional)
     * @param includeRelated (optional)
     * @param includeInactive (optional)
     * @return Success
     */
    getCaseTypeDescendants(caseTypeIdentifier: string, includeAllDescendants: boolean | undefined, includeRelated: string | undefined, includeInactive: boolean | undefined): Promise<CaseTypeExtended[]>;
    protected processGetCaseTypeDescendants(response: Response): Promise<CaseTypeExtended[]>;
    /**
     * Gets the content type relations of the specified case type.
     * @param includeRelated (optional)
     * @return Success
     */
    getCaseTypeActTypeRelations(caseTypeIdentifier: string, includeRelated: string | undefined): Promise<CaseActRelationExtended[]>;
    protected processGetCaseTypeActTypeRelations(response: Response): Promise<CaseActRelationExtended[]>;
    /**
     * Gets the container items filtered with the provided ODataQuery.
     * @param includePropertySets (optional)
     * @param includeRelated (optional)
     * @return Success
     */
    searchContainerItems(oDataQuery: string, includePropertySets: string | undefined, includeRelated: string | undefined): Promise<ContainerItemExtended[]>;
    protected processSearchContainerItems(response: Response): Promise<ContainerItemExtended[]>;
    /**
     * Creates a new container from the request body data.
     * @param includeRelated (optional)
     * @param body (optional)
     * @return Success
     */
    createContainer(includeRelated: string | undefined, body: ContainerInput | undefined): Promise<ContainerExtended>;
    protected processCreateContainer(response: Response): Promise<ContainerExtended>;
    /**
     * Updates the specified container with the request body data.
     * @param containerID (optional)
     * @param barcodeCode (optional)
     * @param includeRelated (optional)
     * @param body (optional)
     * @return Success
     */
    updateContainer(containerID: string | undefined, barcodeCode: string | undefined, includeRelated: string | undefined, body: ContainerInput | undefined): Promise<ContainerExtended>;
    protected processUpdateContainer(response: Response): Promise<ContainerExtended>;
    /**
     * Gets a single container speficied with a unique identifier.
     * @param containerID (optional)
     * @param barcodeCode (optional)
     * @param includePropertySets (optional)
     * @param includeRelated (optional)
     * @return Success
     */
    getContainer(containerID: string | undefined, barcodeCode: string | undefined, includePropertySets: string | undefined, includeRelated: string | undefined): Promise<ContainerExtended>;
    protected processGetContainer(response: Response): Promise<ContainerExtended>;
    /**
     * Gets the containers filtered with the provided ODataQuery.
     * @param includePropertySets (optional)
     * @param includeRelated (optional)
     * @param includeCancelled (optional)
     * @return Success
     */
    searchContainers(oDataQuery: string, includePropertySets: string | undefined, includeRelated: string | undefined, includeCancelled: boolean | undefined): Promise<ContainerExtended[]>;
    protected processSearchContainers(response: R