visualvault-api 1.1.0 → 2.0.0-beta.0

package/dist/VVRestApi.d.ts

@@ -0,0 +1,375 @@
+declare class HttpHelper {
+    constructor(sessionToken: any, yamlConfig: any);
+    _sessionToken: any;
+    _config: any;
+    _maxRetries: number;
+    doVvClientRequest(url: any, options: any, params: any, data: any, buffer: any): Promise<any>;
+    __doVvClientCallRequest(url: any, options: any, params: any, data: any, buffer: any, retries?: number): any;
+    __makeRequest(url: any, options: any): Promise<string>;
+    __makePostStreamRequest(url: any, options: any, buffer: any): Promise<string>;
+    httpGet(url: any, params: any): Promise<string>;
+    httpGetStream(url: any, params: any): Promise<any>;
+    httpPost(url: any, params: any, data: any): Promise<string>;
+    httpPostStream(url: any, params: any, data: any, buffer: any): Promise<string>;
+    httpPut(url: any, params: any, data: any): Promise<string>;
+    httpPutStream(url: any, params: any, data: any, buffer: any): Promise<string>;
+    httpDelete(url: any, params: any): Promise<string>;
+    __acquireRefreshToken(): Promise<void>;
+    request(httpVerb: any, url: any, params: any, data: any): Promise<any>;
+    getUrl(resourceUrl: any): any;
+    __getRetryDelay(retryTime: any): number;
+}
+
+declare class SessionToken {
+    isAuthenticated: boolean;
+    apiUrl: any;
+    baseUrl: any;
+    authenticationUrl: any;
+    customerAlias: any;
+    databaseAlias: any;
+    expirationDate: Date;
+    accessToken: any;
+    tokenType: string;
+    refreshToken: any;
+    expiresIn: number;
+    clientId: any;
+    clientSecret: any;
+    userId: any;
+    password: any;
+    audience: any;
+    createCopy(): SessionToken;
+    convertToJwt(jwt: any): void;
+}
+
+declare class Authorize$1 {
+    jsyaml: any;
+    fs: any;
+    acquireSecurityToken(clientId: any, clientSecret: any, userId: any, password: any, audience: any, baseUrl: any, apiUrl: any, customerAlias: any, databaseAlias: any, authenticationUrl: any): Promise<SessionToken>;
+    acquireJwt(jwt: any, baseUrl: any, apiUrl: any, authenticationUrl: any, customerAlias: any, databaseAlias: any): Promise<SessionToken>;
+    reacquireSecurityToken(sessionToken: any): Promise<SessionToken>;
+    acquireRefreshToken(sessionToken: any): Promise<any>;
+    __getToken(clientId: any, clientSecret: any, userId: any, password: any, audience: any, baseUrl: any, customerAlias: any, databaseAlias: any, authenticationUrl: any): Promise<SessionToken>;
+    __getJwt(jwt: any, baseUrl: any, customerAlias: any, databaseAlias: any, authenticationUrl: any): Promise<SessionToken>;
+    endsWith(source: any, suffix: any): boolean;
+}
+
+declare class CurrentUserManager {
+    constructor(httpHelper: any);
+    _httpHelper: any;
+    /**
+     * Gets the currently authenticated user's information.
+     * @param {Object} [params] - Optional query parameters.
+     * @returns {Promise<string>} A promise that resolves with the current user's information as a JSON string.
+     */
+    getCurrentUser(params?: any): Promise<string>;
+}
+
+declare class DocumentInstanceManager {
+    constructor(httpHelper: any);
+    _httpHelper: any;
+    GetRevision(documentRevisionId: any): Promise<any>;
+    getDocumentOcrStatus(documentRevisionId: any): Promise<any>;
+    updateDocumentOcrStatus(documentRevisionId: any, data: any): Promise<any>;
+    search(criteriaList: any, searchFolders: any, excludeFolders: any, sortBy: any, sortDirection?: string, page?: number, take?: number, archiveType?: number, roleSecurity?: boolean): Promise<any>;
+}
+
+declare class DocApi {
+    constructor(sessionToken: any, docApiConfig: any);
+    _httpHelper: HttpHelper;
+    isEnabled: any;
+    baseUrl: any;
+    roleSecurity: any;
+    documentInstances: DocumentInstanceManager;
+}
+
+declare class FormInstanceManager {
+    constructor(httpHelper: any);
+    _httpHelper: any;
+    postForm(params: any, data: any, formTemplateRevisionId: any): Promise<any>;
+    postFormRevision(params: any, data: any, formTemplateRevisionId: any, formId: any): Promise<any>;
+}
+
+declare class FormsApi {
+    constructor(sessionToken: any, formsApiConfig: any);
+    _httpHelper: HttpHelper;
+    isEnabled: any;
+    baseUrl: any;
+    formInstances: FormInstanceManager;
+}
+
+declare class ModelsManager {
+    constructor(httpHelper: any);
+    _httpHelper: any;
+    /**
+     * Retrieves a list of available models
+     * @param {object} params - Optional URL parameters to include in the request
+     */
+    getModels(params: object): Promise<any>;
+    /**
+     * Retrieves a specific model by its ID
+     * @param {string} modelId - The ID (Guid) for the requested model
+     * @param {object} params - Optional URL parameters to include in the request
+     */
+    getModelById(modelId: string, params: object): Promise<any>;
+}
+
+declare class ObjectsManager {
+    constructor(httpHelper: any);
+    _httpHelper: any;
+    /**
+     * Retrieves a specific object by its ID
+     * @param {string} objectId - The ID (Guid) for the requested object
+     * @param {object} params - Optional URL parameters to include in the request
+     */
+    getObject(objectId: string, params: object): Promise<any>;
+    /**
+     * Retrieves a paged list of objects associated with a given model
+     * @param {string} modelId - The ID (Guid) for the requested model to search
+     * @param {object} data - Data to send in the request body
+     * @param {object} params - Optional URL parameters to include in the request
+     */
+    getObjectsByModelId(modelId: string, data: object, params: object): Promise<any>;
+    /**
+     * Creates a new object adhering to a given model
+     * @param {string} modelId - The ID (Guid) used to create a new object for that model
+     * @param {object} data - Data to send in the request body
+     * @param {object} params - Optional URL parameters to include in the request
+     */
+    createObject(modelId: string, data: object, params: object): Promise<any>;
+    /**
+     * Updates an existing object by its ID (Guid) and revision ID (Guid)
+     * @param {string} objectId - The ID (Guid) for the requested object to update
+     * @param {string} objectRevisionId - The revision ID (Guid) for the requested object to update
+     * @param {object} data - Data to send in the request body
+     * @param {object} params - Optional URL parameters to include in the request
+     */
+    updateObject(objectId: string, objectRevisionId: string, data: object, params: object): Promise<any>;
+    /**
+     * Deletes an existing object by its ID (Guid)
+     * @param {string} objectId - The ID (Guid) for the requested object to delete
+     * @param {object} params - Optional URL parameters to include in the request
+     */
+    deleteObject(objectId: string, params: object): Promise<any>;
+}
+
+declare class ObjectsApi {
+    constructor(sessionToken: any, objectsApiConfig: any);
+    _httpHelper: HttpHelper;
+    isEnabled: any;
+    baseUrl: any;
+    models: ModelsManager;
+    objects: ObjectsManager;
+}
+
+declare class WorkflowManager {
+    constructor(httpHelper: any);
+    _httpHelper: any;
+    getWorkflow(workflowId: any): Promise<any>;
+    getWorkflowByName(workflowName: any): Promise<any>;
+    getWorkflowVariables(params: any, workflowId: any): Promise<any>;
+    /**
+     * Triggers workflow
+     * @param {string} workflowId
+     * @param {number} workflowRevision
+     * @param {string} objectId
+     * @param {object[]} workflowVariables - workflow values to be submitted to the workflow
+     * * @param {string} workflowVariables[].name = name of variable
+     * * @param {*} workflowVariables[].value - value to be passed
+     * * @param {number} workflowVariables[].dataType - Text: 1, Number: 2, Date: 3, Boolean: 4
+     */
+    triggerWorkflow(workflowId: string, workflowRevision: number, objectId: string, workflowVariables: {
+        name: string;
+        value: any;
+        dataType: number;
+    }): Promise<any>;
+    /**
+     * Terminates the workflow instance
+     * @param {string} workflowId
+     * @param {string} instanceId
+     * @returns
+     */
+    terminateWorkflow(workflowId: string, instanceId: string): Promise<any>;
+    /**
+         * Returns workflow history for an object under the provided workflow
+         * @param {string} workflowId
+         * @param {string} objectId
+         * @returns
+         */
+    GetWorkflowHistoryForObject(objectId: string, workflowId: string): Promise<any>;
+    /**
+     * Returns the running workflow, if any, for an object under the provided workflow
+     * @param {string} workflowId
+     * @param {string} objectId
+     * @returns
+     */
+    GetRunningWorkflowForObject(objectId: string, workflowId: string): Promise<any>;
+}
+
+declare class StudioApi {
+    constructor(sessionToken: any, studioApiConfig: any);
+    _httpHelper: HttpHelper;
+    isEnabled: any;
+    baseUrl: any;
+    workflow: WorkflowManager;
+}
+
+declare class UserNotificationsManager {
+    constructor(httpHelper: any);
+    _httpHelper: any;
+    forceUIRefresh(userGuid: any): Promise<any>;
+}
+
+declare class NotificationsApi {
+    constructor(sessionToken: any, notificationsApiConfig: any);
+    _httpHelper: HttpHelper;
+    isEnabled: any;
+    baseUrl: any;
+    users: UserNotificationsManager;
+}
+
+/**
+ * Helper class for form field return values
+ */
+declare class ReturnField {
+    /**
+     * @param {string} id - Field ID
+     * @param {string} name - Field name
+     * @param {*} value - Field value
+     * @param {boolean} isError - Whether field has an error
+     * @param {string} errorMessage - Error message if any
+     */
+    constructor(id: string, name: string, value: any, isError: boolean, errorMessage: string);
+    /** @type {string} */ id: string;
+    /** @type {string} */ name: string;
+    /** @type {*} */ value: any;
+    /** @type {boolean} */ isError: boolean;
+    /** @type {string} */ errorMessage: string;
+}
+/**
+ * Helper class for managing form field collections
+ */
+declare class FormFieldCollection {
+    /**
+     * @param {Array<*>} ffColl - Array of form fields
+     */
+    constructor(ffColl: Array<any>);
+    _ffColl: any[];
+    /**
+     * Get a form field by name
+     * @param {string} name - Field name to search for
+     * @returns {*} The field or null if not found
+     */
+    getFormFieldByName(name: string): any;
+    /**
+     * Get a form field by ID
+     * @param {string} id - Field ID to search for
+     * @returns {*} The field or null if not found
+     */
+    getFormFieldById(id: string): any;
+    /**
+     * Get the array of all form fields
+     * @returns {Array<*>} Array of form fields
+     */
+    getFieldArray(): Array<any>;
+}
+
+/**
+ * Main VisualVault API client providing access to all API managers.
+ */
+declare class VVClient {
+    /**
+     * @param {*} sessionToken - Session token from authentication
+     */
+    constructor(sessionToken: any);
+    /** @type {*} */ constants: any;
+    /** @type {*} */ configuration: any;
+    /** @type {*} */ customQuery: any;
+    /** @type {*} */ documents: any;
+    /** @type {*} */ email: any;
+    /** @type {*} */ files: any;
+    /** @type {*} */ forms: any;
+    /** @type {*} */ groups: any;
+    /** @type {*} */ library: any;
+    /** @type {*} */ sites: any;
+    /** @type {*} */ users: any;
+    /** @type {*} */ scheduledProcess: any;
+    /** @type {*} */ scripts: any;
+    /** @type {*} */ projects: any;
+    /** @type {*} */ customer: any;
+    /** @type {*} */ customerDatabase: any;
+    /** @type {*} */ indexFields: any;
+    /** @type {*} */ outsideProcesses: any;
+    /** @type {*} */ securityMembers: any;
+    /** @type {*} */ layouts: any;
+    /** @type {*} */ reports: any;
+    yamlConfig: any;
+    _httpHelper: HttpHelper;
+    currentUser: CurrentUserManager;
+    _docApi: DocApi;
+    _formsApi: FormsApi;
+    _objectsApi: ObjectsApi;
+    _studioApi: StudioApi;
+    _notificationsApi: NotificationsApi;
+    createDocApi(sessionToken: any): Promise<void>;
+    createFormsApi(sessionToken: any): Promise<void>;
+    createObjectsApi(sessionToken: any): Promise<void>;
+    createStudioApi(sessionToken: any): Promise<void>;
+    createNotificationsApi(sessionToken: any): Promise<void>;
+    _convertToJwt(sessionToken: any): Promise<void>;
+    endsWith(source: any, suffix: any): boolean;
+    /**
+     * Get the current security token
+     * @returns {string} The access token
+     */
+    getSecurityToken(): string;
+    /**
+     * Check if the client is authenticated
+     * @returns {boolean} True if authenticated
+     */
+    isAuthenticated(): boolean;
+    /**
+     * Get the base URL
+     * @returns {string} The base URL
+     */
+    getBaseUrl(): string;
+}
+declare const Authorize_base: typeof Authorize$1;
+/**
+ * Authentication class for obtaining VaultApi client instances.
+ */
+declare class Authorize extends Authorize_base {
+    /**
+     * Authenticate and get a VaultApi client instance
+     * @param {string} clientId - OAuth client ID
+     * @param {string} clientSecret - OAuth client secret
+     * @param {string} userId - User username
+     * @param {string} password - User password
+     * @param {string} audience - OAuth audience
+     * @param {string} baseVaultUrl - VisualVault base URL
+     * @param {string} customerAlias - Customer alias
+     * @param {string} databaseAlias - Database alias
+     * @returns {Promise<VVClient>} Authenticated client instance
+     */
+    getVaultApi(clientId: string, clientSecret: string, userId: string, password: string, audience: string, baseVaultUrl: string, customerAlias: string, databaseAlias: string): Promise<VVClient>;
+    /**
+     * Get a VaultApi client from an existing JWT token
+     * @param {string} jwt - JWT authentication token
+     * @param {string} baseVaultUrl - VisualVault base URL
+     * @param {string} customerAlias - Customer alias
+     * @param {string} databaseAlias - Database alias
+     * @param {Date} expirationDate - Token expiration date
+     * @returns {Promise<VVClient>} Authenticated client instance
+     */
+    getVaultApiFromJwt(jwt: string, baseVaultUrl: string, customerAlias: string, databaseAlias: string, expirationDate: Date): Promise<VVClient>;
+}
+declare namespace forms {
+    export { ReturnField as returnField };
+    export { FormFieldCollection as formFieldCollection };
+}
+declare namespace _default {
+    export { VVClient as vvClient };
+    export { Authorize as authorize };
+    export { forms };
+}
+
+export { Authorize, VVClient, _default as default, forms };