visualvault-api 2.0.0-beta.2 → 2.0.0

package/dist/config.yml

@@ -1,5 +1,6 @@
 # VisualVault URIs
 ApiUri: /api/v1/{custalias}/{custdbalias}
+BaseApiUri: /api/v1
 FormsApiUri: /api/v1
 DocApiUri: /api/v1
 NotificationsApiUri: /api/v1
@@ -55,9 +56,34 @@ ResourceUri:
   UsersIdUserId: /users/{id}/userId
   UsersMe: /users/me
   GetGroups: /groups
+  GroupById: /groups/{id}
+  AddGroup: /groups
+  UpdateGroup: /groups/{id}
+  DeleteGroup: /groups/{id}
   Groups: /sites/{id}/groups
+  SiteGroupById: /sites/{siteId}/groups/{groupId}
   GroupsUsers: /groups/{id}/users
   GroupsAddUser: /groups/{groupId}/users/{userId}
+  SiteById: /sites/{id}
+  ChangeGroupSite: /sites/changegroupsite
+  LanguageAreas: /resource/area
+  Languages: /resource/language
+  ExportLanguages: /resource/customerLocalization/exportCsv
+  ImportLanguages: /resource/customerLocalization/importCsv
+  Reports: /reports
+  DropDownLists: /lists
+  DropDownListsId: /lists/{id}
+  DropDownListsIdItems: /lists/{id}/items
+  DocumentTypes: /documenttypes
+  SavedSearches: /savedsearches
+  DocumentFields: /documentfields
+  SavedSearchIndexFields: /savedSearchIndexFields
+  LastDocuments: /lastdocuments
+  FrequentDocuments: /frequentdocuments
+  SavedSearchDocuments: /savedsearchdocuments/{savedSearchId}
+  DocumentDefaultAction: /documentDefaultAction/{documentId}
+  CreateDocumentZipFile: /documents/CreateDocumentZipFile
+  GetDocumentZipFileStatus: /documents/GetDocumentZipFileStatus
   Folders: /folders
   FoldersId: /folders/{id}
   FoldersCopy: /folders/copy
@@ -80,14 +106,17 @@ ResourceUri:
   CustomerAssignUser: /customer/{customerId}/assignuser
   CustomerDatabaseAssignUser: /customerdatabase/{databaseId}/assignuser
   IndexFields: /indexfields
+  IndexFieldsFolder: /indexfields/{id}/folders/{folderId}
   OutsideProcesses: /outsideprocesses
   SecurityMembers: /securitymembers
   Layout: /layout
   ReportServerPDF: /ReportServer/{id}/PDF
-  DocApi:
-    GetRevision: /Documents/revisions/{id}
-    OcrStatus: /Documents/ocr/{id}
-    AdvancedSearch: /Search/Advanced
+  DocApi:
+    CreateDocument: /Documents
+    GetRevision: /Documents/revisions/{id}
+    OcrStatus: /Documents/ocr/{id}
+    UpdateDocument: /Documents/{id}
+    AdvancedSearch: /Search/Advanced
   FormsApi:
     FormInstance: /forminstance
   ObjectsApi:

package/dist/index.cjs

@@ -614,6 +614,12 @@ var DocumentManager = class {
   constructor(httpHelper) {
     this._httpHelper = httpHelper;
   }
+  async createDocument(data) {
+    const resourceUri = this._httpHelper._config.ResourceUri.DocApi.CreateDocument;
+    const url = this._httpHelper.getUrl(resourceUri);
+    const opts = { method: "POST" };
+    return this._httpHelper.doVvClientRequest(url, opts, null, data);
+  }
   async GetRevision(documentRevisionId) {
     let resourceUri = this._httpHelper._config.ResourceUri.DocApi.GetRevision;
     resourceUri = resourceUri.replace("{id}", documentRevisionId);
@@ -635,6 +641,13 @@ var DocumentManager = class {
     const opts = { method: "PUT" };
     return this._httpHelper.doVvClientRequest(url, opts, null, data);
   }
+  async updateDocument(documentId, data) {
+    let resourceUri = this._httpHelper._config.ResourceUri.DocApi.UpdateDocument;
+    resourceUri = resourceUri.replace("{id}", documentId);
+    const url = this._httpHelper.getUrl(resourceUri);
+    const opts = { method: "PUT" };
+    return this._httpHelper.doVvClientRequest(url, opts, null, data);
+  }
   async search(criteriaList, searchFolders, excludeFolders, sortBy, sortDirection = "desc", page = 0, take = 15, archiveType = 0, roleSecurity = false) {
     const url = this._httpHelper.getUrl(this._httpHelper._config.ResourceUri.DocApi.AdvancedSearch);
     const data = {
@@ -1533,6 +1546,30 @@ var GroupsManager = class {
     const opts = { method: "GET" };
     return this._httpHelper.doVvClientRequest(url, opts, params, null);
   }
+  getGroupById(params, groupId) {
+    const resourceUri = this._httpHelper._config.ResourceUri.GroupById.replace("{id}", groupId);
+    const url = this._httpHelper.getUrl(resourceUri);
+    const opts = { method: "GET" };
+    return this._httpHelper.doVvClientRequest(url, opts, params, null);
+  }
+  addGroup(params, formData) {
+    const resourceUri = this._httpHelper._config.ResourceUri.AddGroup;
+    const url = this._httpHelper.getUrl(resourceUri);
+    const opts = { method: "POST" };
+    return this._httpHelper.doVvClientRequest(url, opts, params, formData);
+  }
+  updateGroup(params, groupId, formData) {
+    const resourceUri = this._httpHelper._config.ResourceUri.UpdateGroup.replace("{id}", groupId);
+    const url = this._httpHelper.getUrl(resourceUri);
+    const opts = { method: "PUT" };
+    return this._httpHelper.doVvClientRequest(url, opts, params, formData);
+  }
+  deleteGroup(params, groupId) {
+    const resourceUri = this._httpHelper._config.ResourceUri.DeleteGroup.replace("{id}", groupId);
+    const url = this._httpHelper.getUrl(resourceUri);
+    const opts = { method: "DELETE" };
+    return this._httpHelper.doVvClientRequest(url, opts, params, null);
+  }
   getGroupsUsers(params, groupId) {
     const resourceUri = this._httpHelper._config.ResourceUri.GroupsUsers.replace("{id}", groupId);
     const url = this._httpHelper.getUrl(resourceUri);
@@ -1603,6 +1640,12 @@ var LibraryManager = class {
     const opts = { method: "GET" };
     return this._httpHelper.doVvClientRequest(url, opts, params, null);
   }
+  getFolderByPath(params, folderPath) {
+    const resourceUri = this._httpHelper._config.ResourceUri.Folders + "?folderpath=" + encodeURIComponent(folderPath);
+    const url = this._httpHelper.getUrl(resourceUri);
+    const opts = { method: "GET" };
+    return this._httpHelper.doVvClientRequest(url, opts, params, null);
+  }
   updateFolderIndexFieldOverrideSettings(folderId, fieldId, queryId, displayField, valueField, dropDownListId, required, defaultValue) {
     const data = {
       queryId,
@@ -1687,8 +1730,8 @@ var SitesManager = class {
     return this._httpHelper.doVvClientRequest(url, opts, params, data);
   }
   putSites(params, data, siteId) {
-    const resourceUri = this._httpHelper._config.ResourceUri.Sites;
-    const url = this._httpHelper.getUrl(resourceUri + "/" + siteId);
+    const resourceUri = this._httpHelper._config.ResourceUri.SiteById.replace("{id}", siteId);
+    const url = this._httpHelper.getUrl(resourceUri);
     const opts = { method: "PUT" };
     return this._httpHelper.doVvClientRequest(url, opts, params, data);
   }
@@ -1705,8 +1748,8 @@ var SitesManager = class {
     return this._httpHelper.doVvClientRequest(url, opts, params, data);
   }
   putGroups(params, data, siteId, grId) {
-    const resourceUri = this._httpHelper._config.ResourceUri.Groups.replace("{id}", siteId);
-    const url = this._httpHelper.getUrl(resourceUri + "/" + grId);
+    const resourceUri = this._httpHelper._config.ResourceUri.SiteGroupById.replace("{siteId}", siteId).replace("{groupId}", grId);
+    const url = this._httpHelper.getUrl(resourceUri);
     const opts = { method: "PUT" };
     return this._httpHelper.doVvClientRequest(url, opts, params, data);
   }
@@ -1720,6 +1763,28 @@ var SitesManager = class {
     };
     return this._httpHelper.doVvClientRequest(url, opts, null, data);
   }
+  getSiteById(params, siteId) {
+    const resourceUri = this._httpHelper._config.ResourceUri.SiteById.replace("{id}", siteId);
+    const url = this._httpHelper.getUrl(resourceUri);
+    const opts = { method: "GET" };
+    return this._httpHelper.doVvClientRequest(url, opts, params, null);
+  }
+  deleteSite(params, siteId) {
+    const resourceUri = this._httpHelper._config.ResourceUri.SiteById.replace("{id}", siteId);
+    const url = this._httpHelper.getUrl(resourceUri);
+    const opts = { method: "DELETE" };
+    return this._httpHelper.doVvClientRequest(url, opts, params, null);
+  }
+  changeGroupSite(params, groupId, newSiteId) {
+    const resourceUri = this._httpHelper._config.ResourceUri.ChangeGroupSite;
+    const data = {
+      groupId,
+      newSiteId
+    };
+    const url = this._httpHelper.getUrl(resourceUri);
+    const opts = { method: "PUT" };
+    return this._httpHelper.doVvClientRequest(url, opts, params, data);
+  }
 };
 
 // lib/vvRestApi/usersManager.js
@@ -2108,6 +2173,81 @@ var DocumentsManager = class {
     const opts = { method: "GET" };
     return this._httpHelper.doVvClientRequest(url, opts, null, null);
   }
+  createDocumentZipFile(params, documentIds) {
+    const resourceUri = this._httpHelper._config.ResourceUri.CreateDocumentZipFile;
+    const url = this._httpHelper.getUrl(resourceUri);
+    const opts = { method: "POST" };
+    const data = { documentDhIds: documentIds };
+    return this._httpHelper.doVvClientRequest(url, opts, params, data);
+  }
+  getDocumentZipFileStatus(params, downloadKey) {
+    const resourceUri = this._httpHelper._config.ResourceUri.GetDocumentZipFileStatus + `?downloadKey=${encodeURIComponent(downloadKey)}`;
+    const url = this._httpHelper.getUrl(resourceUri);
+    const opts = { method: "GET" };
+    return this._httpHelper.doVvClientRequest(url, opts, params, null);
+  }
+  getDocumentIndexFields(params, documentId) {
+    const resourceUri = this._httpHelper._config.ResourceUri.DocumentIndexFields.replace("{id}", documentId);
+    const url = this._httpHelper.getUrl(resourceUri);
+    const opts = { method: "GET" };
+    return this._httpHelper.doVvClientRequest(url, opts, params, null);
+  }
+  getDocumentTypes(params) {
+    const resourceUri = this._httpHelper._config.ResourceUri.DocumentTypes;
+    const url = this._httpHelper.getUrl(resourceUri);
+    const opts = { method: "GET" };
+    return this._httpHelper.doVvClientRequest(url, opts, params, null);
+  }
+  createDocumentType(params, name) {
+    const resourceUri = this._httpHelper._config.ResourceUri.DocumentTypes;
+    const url = this._httpHelper.getUrl(resourceUri);
+    const opts = { method: "POST" };
+    const data = { documentTypeName: name };
+    return this._httpHelper.doVvClientRequest(url, opts, params, data);
+  }
+  getSavedSearches(params) {
+    const resourceUri = this._httpHelper._config.ResourceUri.SavedSearches;
+    const url = this._httpHelper.getUrl(resourceUri);
+    const opts = { method: "GET" };
+    return this._httpHelper.doVvClientRequest(url, opts, params, null);
+  }
+  getDocumentFields(params) {
+    const resourceUri = this._httpHelper._config.ResourceUri.DocumentFields;
+    const url = this._httpHelper.getUrl(resourceUri);
+    const opts = { method: "GET" };
+    return this._httpHelper.doVvClientRequest(url, opts, params, null);
+  }
+  getSavedSearchIndexFields(params, savedSearchId) {
+    const resourceUri = this._httpHelper._config.ResourceUri.SavedSearchIndexFields;
+    const url = this._httpHelper.getUrl(resourceUri);
+    const opts = { method: "GET" };
+    const mergedParams = { ...params, savedSearchId };
+    return this._httpHelper.doVvClientRequest(url, opts, mergedParams, null);
+  }
+  getLastDocuments(params) {
+    const resourceUri = this._httpHelper._config.ResourceUri.LastDocuments;
+    const url = this._httpHelper.getUrl(resourceUri);
+    const opts = { method: "GET" };
+    return this._httpHelper.doVvClientRequest(url, opts, params, null);
+  }
+  getFrequentDocuments(params) {
+    const resourceUri = this._httpHelper._config.ResourceUri.FrequentDocuments;
+    const url = this._httpHelper.getUrl(resourceUri);
+    const opts = { method: "GET" };
+    return this._httpHelper.doVvClientRequest(url, opts, params, null);
+  }
+  getSavedSearchDocuments(params, savedSearchId) {
+    const resourceUri = this._httpHelper._config.ResourceUri.SavedSearchDocuments.replace("{savedSearchId}", savedSearchId);
+    const url = this._httpHelper.getUrl(resourceUri);
+    const opts = { method: "GET" };
+    return this._httpHelper.doVvClientRequest(url, opts, params, null);
+  }
+  getDocumentDefaultLink(params, documentId) {
+    const resourceUri = this._httpHelper._config.ResourceUri.DocumentDefaultAction.replace("{documentId}", documentId);
+    const url = this._httpHelper.getUrl(resourceUri);
+    const opts = { method: "GET" };
+    return this._httpHelper.doVvClientRequest(url, opts, params, null);
+  }
 };
 
 // lib/vvRestApi/projectsManager.js
@@ -2148,6 +2288,70 @@ var IndexFieldsManager = class {
     const opts = { method: "GET" };
     return this._httpHelper.doVvClientRequest(url, opts, params, null);
   }
+  getIndexField(params, id) {
+    const resourceUri = this._httpHelper._config.ResourceUri.IndexFields + "/" + id;
+    const url = this._httpHelper.getUrl(resourceUri);
+    const opts = { method: "GET" };
+    return this._httpHelper.doVvClientRequest(url, opts, params, null);
+  }
+  /**
+   * Payload for creating/updating index fields.
+   * @typedef {Object} IndexFieldData
+   * @property {string} fieldType
+   * @property {string} label
+   * @property {string} [description]
+   * @property {boolean} [required]
+   * @property {?string} [connectionId]
+   * @property {?string} [queryId]
+   * @property {?string} [queryDisplayField]
+   * @property {?string} [queryValueField]
+   * @property {?string} [dropDownListId]
+   * @property {?string} [defaultValue]
+   */
+  /**
+   * Create an index field
+   * @param {Object} params - Query parameters
+   * @param {IndexFieldData} data - Request body
+   * @returns {Promise<string>}
+   */
+  createIndexField(params, data) {
+    const resourceUri = this._httpHelper._config.ResourceUri.IndexFields;
+    const url = this._httpHelper.getUrl(resourceUri);
+    const opts = { method: "POST" };
+    return this._httpHelper.doVvClientRequest(url, opts, params, data);
+  }
+  /**
+   * Update an index field
+   * @param {Object} params - Query parameters
+   * @param {string} id - Index field id
+   * @param {IndexFieldData} data - Request body
+   * @returns {Promise<string>}
+   */
+  updateIndexField(params, id, data) {
+    const resourceUri = this._httpHelper._config.ResourceUri.IndexFields + "/" + id;
+    const url = this._httpHelper.getUrl(resourceUri);
+    const opts = { method: "PUT" };
+    return this._httpHelper.doVvClientRequest(url, opts, params, data);
+  }
+  deleteIndexField(params, id) {
+    const resourceUri = this._httpHelper._config.ResourceUri.IndexFields + "/" + id;
+    const url = this._httpHelper.getUrl(resourceUri);
+    const opts = { method: "DELETE" };
+    return this._httpHelper.doVvClientRequest(url, opts, params, null);
+  }
+  moveIndexFieldAfter(params, sourceFieldId, destinationFieldId) {
+    const resourceUri = this._httpHelper._config.ResourceUri.IndexFields + "/MoveIndexFieldAfter";
+    const url = this._httpHelper.getUrl(resourceUri);
+    const opts = { method: "POST" };
+    const data = { sourceFieldId, destinationFieldId };
+    return this._httpHelper.doVvClientRequest(url, opts, params, data);
+  }
+  addIndexFieldToFolder(indexFieldId, folderId) {
+    const resourceUri = this._httpHelper._config.ResourceUri.IndexFieldsFolder.replace("{id}", indexFieldId).replace("{folderId}", folderId);
+    const url = this._httpHelper.getUrl(resourceUri);
+    const opts = { method: "PUT" };
+    return this._httpHelper.doVvClientRequest(url, opts, null, null);
+  }
 };
 
 // lib/vvRestApi/outsideProcessesManager.js
@@ -2234,6 +2438,12 @@ var ReportsManager = class {
   constructor(httpHelper) {
     this._httpHelper = httpHelper;
   }
+  getReports(params) {
+    const resourceUri = this._httpHelper._config.ResourceUri.Reports;
+    const url = this._httpHelper.getUrl(resourceUri);
+    const opts = { method: "GET" };
+    return this._httpHelper.doVvClientRequest(url, opts, params, null);
+  }
   getReportPDF(reportId, params) {
     const resourceUri = this._httpHelper._config.ResourceUri.ReportServerPDF.replace("{id}", reportId);
     const url = this._httpHelper.getUrl(resourceUri);
@@ -2242,6 +2452,102 @@ var ReportsManager = class {
   }
 };
 
+// lib/vvRestApi/languageResourcesManager.js
+init_cjs_shims();
+var LanguageResourcesManager = class {
+  constructor(httpHelper, baseUrl) {
+    this._httpHelper = httpHelper;
+    this._baseUrl = baseUrl;
+    this._apiUrl = httpHelper._config.BaseApiUri;
+  }
+  getLanguageAreas(params) {
+    const resourceUri = this._httpHelper._config.ResourceUri.LanguageAreas;
+    const url = this._baseUrl + this._apiUrl + resourceUri;
+    const opts = { method: "GET" };
+    return this._httpHelper.doVvClientRequest(url, opts, params, null);
+  }
+  getLanguages(params) {
+    const resourceUri = this._httpHelper._config.ResourceUri.Languages;
+    const url = this._baseUrl + this._apiUrl + resourceUri;
+    const opts = { method: "GET" };
+    return this._httpHelper.doVvClientRequest(url, opts, params, null);
+  }
+  exportLanguages(params) {
+    const resourceUri = this._httpHelper._config.ResourceUri.ExportLanguages;
+    const url = this._httpHelper.getUrl(resourceUri);
+    const opts = { method: "GETSTREAM" };
+    return this._httpHelper.doVvClientRequest(url, opts, params, null);
+  }
+  importLanguages(params, fileData, fileName) {
+    const resourceUri = this._httpHelper._config.ResourceUri.ImportLanguages;
+    const url = this._httpHelper.getUrl(resourceUri) + `?area=${params.area}&lang=${params.lang}`;
+    const opts = { method: "POSTSTREAM" };
+    const data = { fileName };
+    return this._httpHelper.doVvClientRequest(url, opts, null, data, fileData);
+  }
+};
+
+// lib/vvRestApi/dropdownListsManager.js
+init_cjs_shims();
+var DropdownListsManager = class {
+  constructor(httpHelper) {
+    this._httpHelper = httpHelper;
+  }
+  getDropDownLists(params) {
+    const resourceUri = this._httpHelper._config.ResourceUri.DropDownLists;
+    const url = this._httpHelper.getUrl(resourceUri);
+    const opts = { method: "GET" };
+    return this._httpHelper.doVvClientRequest(url, opts, params, null);
+  }
+  getDropDownListById(params, listId) {
+    const resourceUri = this._httpHelper._config.ResourceUri.DropDownListsId.replace("{id}", listId);
+    const url = this._httpHelper.getUrl(resourceUri);
+    const opts = { method: "GET" };
+    return this._httpHelper.doVvClientRequest(url, opts, params, null);
+  }
+  getDropDownListItemsById(params, listId) {
+    const resourceUri = this._httpHelper._config.ResourceUri.DropDownListsIdItems.replace("{id}", listId);
+    const url = this._httpHelper.getUrl(resourceUri);
+    const opts = { method: "GET" };
+    return this._httpHelper.doVvClientRequest(url, opts, params, null);
+  }
+  addDropDownList(params, ddName, ddDescription, ddItems) {
+    const resourceUri = this._httpHelper._config.ResourceUri.DropDownLists;
+    const url = this._httpHelper.getUrl(resourceUri);
+    const opts = { method: "POST" };
+    const data = {
+      Name: ddName,
+      Description: ddDescription,
+      Items: ddItems
+    };
+    return this._httpHelper.doVvClientRequest(url, opts, params, data);
+  }
+  deleteDropDownList(params, listId) {
+    const resourceUri = this._httpHelper._config.ResourceUri.DropDownListsId.replace("{id}", listId);
+    const url = this._httpHelper.getUrl(resourceUri);
+    const opts = { method: "DELETE" };
+    return this._httpHelper.doVvClientRequest(url, opts, params, null);
+  }
+  updateDropDownList(params, listId, ddName, ddDescription, items) {
+    const resourceUri = this._httpHelper._config.ResourceUri.DropDownListsId.replace("{id}", listId);
+    const url = this._httpHelper.getUrl(resourceUri);
+    const opts = { method: "PUT" };
+    const data = {
+      Name: ddName,
+      Description: ddDescription,
+      Items: items
+    };
+    return this._httpHelper.doVvClientRequest(url, opts, params, data);
+  }
+  deleteDropDownListItem(params, listId, itemIds) {
+    const resourceUri = this._httpHelper._config.ResourceUri.DropDownListsIdItems.replace("{id}", listId);
+    const url = this._httpHelper.getUrl(resourceUri);
+    const opts = { method: "DELETE" };
+    const mergedParams = { ...params, itemIds };
+    return this._httpHelper.doVvClientRequest(url, opts, mergedParams, null);
+  }
+};
+
 // lib/VVRestApi.js
 var debug5 = (0, import_debug5.default)("visualvault:api");
 var __filename7 = (0, import_url6.fileURLToPath)(importMetaUrl);
@@ -2289,6 +2595,10 @@ var VVClient = class {
   layouts;
   /** @type {*} */
   reports;
+  /** @type {*} */
+  languageResources;
+  /** @type {*} */
+  dropdownLists;
   /**
    * @param {*} sessionToken - Session token from authentication
    */
@@ -2317,6 +2627,8 @@ var VVClient = class {
     this.securityMembers = new SecurityMembersManager(this._httpHelper);
     this.layouts = new LayoutsManager(this._httpHelper);
     this.reports = new ReportsManager(this._httpHelper);
+    this.languageResources = new LanguageResourcesManager(this._httpHelper, sessionToken.baseUrl);
+    this.dropdownLists = new DropdownListsManager(this._httpHelper);
     this.docApi = null;
     this.formsApi = null;
     this.objectsApi = null;