visualvault-api 1.1.0 → 2.0.0-beta.0

package/{lib/VVRestApi/VVRestApiNodeJs → dist}/config.yml

@@ -1,100 +1,106 @@
-
-
-
-# VisualVault URIs
-ApiUri: /api/v1/{custalias}/{custdbalias}
-FormsApiUri: /api/v1
-DocApiUri: /api/v1
-NotificationsApiUri: /api/v1
-AutheticateUri: /OAuth/Token
-
-# VisualVault endpoints
-ResourceUri:
-  ConfigurationDocApi: /configuration/docapi
-  ConfigurationFormsApi: /configuration/formsapi
-  ConfigurationStudioApi: /configuration/studioapi
-  ConfigurationNotificationApi: /configuration/notificationapi
-  DocumentsPost: /documents
-  DocumentsId: /documents/{id}
-  DocumentsIdCopy: /documents/{id}/copy
-  DocumentsIdMove: /documents/{id}/move
-  DocumentIndexFields: /documents/{id}/indexfields
-  DocumentAlertsId: /documents/{documentId}/alerts/{eventId}
-  DocumentsIdOcr: /documents/{id}/ocr
-  DocumentsIdRelateDocument: /documents/{id}/relateDocument
-  DocumentsIdExpiration: /documents/{id}/expiration
-  Files: /files
-  FilesQuery: /files?q=
-  FilesId: /files/{id}
-  FormTemplates: /formtemplates
-  FormTemplatesImport: /formtemplates/{id}/import
-  Forms: /formtemplates/{id}/forms
-  FormId: /formtemplates/{id}/forms/{formId}
-  FormIdPdf: /formtemplates/{id}/forms/{formId}/pdf
-  FormIdFields: /formtemplates/{id}/fields
-  FormsId: /forms/{id}
-  FormInstance: /forminstance/{id}
-  FormInstanceRelatedDocs: /forminstance/{id}/documents
-  FormInstanceRelatedForms: /forminstance/{id}/forms
-  FormInstanceUpdateOriginator: /forminstance/{id}/updateOriginator
-  FormDesignerFormsTemplatesIdFields: /formdesigner/forms/formtemplates/{id}/fields
-  FormInstanceImage: /FormEntity/{id}/setFieldImage
-  Sites: /sites
-  ChangeUserSite: /sites/changeusersite
-  User: /users
-  Users: /sites/{id}/users
-  UserWebToken: /users/{id}/webToken
-  UsersGetJwt: /users/getjwt
-  UserGroups: /users/{id}/groups
-  UserSupervisors: /users/{id}/supervisors
-  UserSupervisees: /users/{id}/supervisees
-  UserById: /users/{id}
-  UserDelete: /customerdatabase/{databaseId}/deleteuser/{authenticationUserId}
-  UsersPassword: /users/{id}/password
-  UsersIdUserId: /users/{id}/userId
-  GetGroups: /groups
-  Groups: /sites/{id}/groups
-  GroupsUsers: /groups/{id}/users
-  GroupsAddUser: /groups/{groupId}/users/{userId}
-  Folders: /folders
-  FoldersId: /folders/{id}
-  FoldersCopy: /folders/copy
-  FoldersMove: /folders/move
-  FolderIndexFields: /folders/{id}/indexfields
-  FoldersIdIndexFieldsId: /folders/{id}/indexfields/{indexFieldId}
-  FolderAlertsId: /folders/{folderId}/alerts/{eventId}
-  FolderSecurity: /folders/{folderId}/securitymembers
-  FolderSecurityId: /folders/{folderId}/securitymembers/{memberId}
-  Documents: /folders/{id}/documents
-  Emails: /emails
-  ScheduledProcess: /scheduledProcess
-  CustomQuery: /customquery
-  Scripts: /scripts
-  ScriptsCompleteWf: /scripts/CompleteWorkflowScript
-  ProjectAlertsId: /projects/{projectId}/alerts/{eventId}
-  Customers: /customers
-  CustomerInvite: /customers/invite
-  CustomerInviteId: /customers/invite/{inviteCode}
-  CustomerAssignUser: /customer/{customerId}/assignuser
-  CustomerDatabaseAssignUser: /customerdatabase/{databaseId}/assignuser
-  IndexFields: /indexfields
-  OutsideProcesses: /outsideprocesses
-  SecurityMembers: /securitymembers
-  Layout: /layout
-  ReportServerPDF: /ReportServer/{id}/PDF
-  DocApi:
-    GetRevision: /Documents/revisions/{id}
-    OcrStatus: /Documents/ocr/{id}
-    AdvancedSearch: /Search/Advanced
-  FormsApi:
-    FormInstance: /forminstance
-  StudioApi:
-    WorkflowLatestPublished: /workflows/latest/published
-    WorkflowLatestPublishedId: /workflows/latest/published/{id}
-    WorkflowVariables: /workflows/{id}/variables
-    WorkflowRun: /workflows/{id}/revisions/{revision}/run
-    WorkflowTerminate: /workflows/{workflowId}/instances/{instanceId}/complete
-    WorkflowHistoryObject: /workflowhistories/{workflowId}/objects/{objectId}
-    WorkflowHistoryRunningObject: /workflowhistories/{workflowId}/objects/{objectId}/running
-  NotificationsApi:
-    ForceUIRefresh: /Users/{id}/ForceUIRefresh
+# VisualVault URIs
+ApiUri: /api/v1/{custalias}/{custdbalias}
+FormsApiUri: /api/v1
+DocApiUri: /api/v1
+NotificationsApiUri: /api/v1
+AutheticateUri: /OAuth/Token
+
+# VisualVault endpoints
+ResourceUri:
+  ConfigurationDocApi: /configuration/docapi
+  ConfigurationFormsApi: /configuration/formsapi
+  ConfigurationObjectsApi: /configuration/objectsapi
+  ConfigurationStudioApi: /configuration/studioapi
+  ConfigurationNotificationApi: /configuration/notificationapi
+  DocumentsPost: /documents
+  DocumentsId: /documents/{id}
+  DocumentsIdCopy: /documents/{id}/copy
+  DocumentsIdMove: /documents/{id}/move
+  DocumentIndexFields: /documents/{id}/indexfields
+  DocumentAlertsId: /documents/{documentId}/alerts/{eventId}
+  DocumentsIdOcr: /documents/{id}/ocr
+  DocumentsIdRelateDocument: /documents/{id}/relateDocument
+  DocumentsIdExpiration: /documents/{id}/expiration
+  Files: /files
+  FilesQuery: /files?q=
+  FilesId: /files/{id}
+  FormTemplates: /formtemplates
+  FormTemplatesImport: /formtemplates/{id}/import
+  FormTemplatesRelease: /formtemplates/{id}/release
+  Forms: /formtemplates/{id}/forms
+  FormId: /formtemplates/{id}/forms/{formId}
+  FormIdPdf: /formtemplates/{id}/forms/{formId}/pdf
+  FormIdFields: /formtemplates/{id}/fields
+  FormsId: /forms/{id}
+  FormInstance: /forminstance/{id}
+  FormInstanceRelatedDocs: /forminstance/{id}/documents
+  FormInstanceRelatedForms: /forminstance/{id}/forms
+  FormInstanceUpdateOriginator: /forminstance/{id}/updateOriginator
+  FormDesignerFormsTemplatesIdFields: /formdesigner/forms/formtemplates/{id}/fields
+  FormInstanceImage: /FormEntity/{id}/setFieldImage
+  Sites: /sites
+  ChangeUserSite: /sites/changeusersite
+  User: /users
+  Users: /sites/{id}/users
+  UserWebToken: /users/{id}/webToken
+  UsersGetJwt: /users/getjwt
+  UserGroups: /users/{id}/groups
+  UserSupervisors: /users/{id}/supervisors
+  UserSupervisees: /users/{id}/supervisees
+  UserById: /users/{id}
+  UserDelete: /customerdatabase/{databaseId}/deleteuser/{authenticationUserId}
+  UsersPassword: /users/{id}/password
+  UsersIdUserId: /users/{id}/userId
+  UsersMe: /users/me
+  GetGroups: /groups
+  Groups: /sites/{id}/groups
+  GroupsUsers: /groups/{id}/users
+  GroupsAddUser: /groups/{groupId}/users/{userId}
+  Folders: /folders
+  FoldersId: /folders/{id}
+  FoldersCopy: /folders/copy
+  FoldersMove: /folders/move
+  FolderIndexFields: /folders/{id}/indexfields
+  FoldersIdIndexFieldsId: /folders/{id}/indexfields/{indexFieldId}
+  FolderAlertsId: /folders/{folderId}/alerts/{eventId}
+  FolderSecurity: /folders/{folderId}/securitymembers
+  FolderSecurityId: /folders/{folderId}/securitymembers/{memberId}
+  Documents: /folders/{id}/documents
+  Emails: /emails
+  ScheduledProcess: /scheduledProcess
+  CustomQuery: /customquery
+  Scripts: /scripts
+  ScriptsCompleteWf: /scripts/CompleteWorkflowScript
+  ProjectAlertsId: /projects/{projectId}/alerts/{eventId}
+  Customers: /customers
+  CustomerInvite: /customers/invite
+  CustomerInviteId: /customers/invite/{inviteCode}
+  CustomerAssignUser: /customer/{customerId}/assignuser
+  CustomerDatabaseAssignUser: /customerdatabase/{databaseId}/assignuser
+  IndexFields: /indexfields
+  OutsideProcesses: /outsideprocesses
+  SecurityMembers: /securitymembers
+  Layout: /layout
+  ReportServerPDF: /ReportServer/{id}/PDF
+  DocApi:
+    GetRevision: /Documents/revisions/{id}
+    OcrStatus: /Documents/ocr/{id}
+    AdvancedSearch: /Search/Advanced
+  FormsApi:
+    FormInstance: /forminstance
+  ObjectsApi:
+    Models: /models
+    ModelById: /models/{id}
+    Object: /object
+    ObjectById: /object/{id}
+    ObjectSearchByModelId: /object/search/{modelId}
+  StudioApi:
+    WorkflowLatestPublished: /workflows/latest/published
+    WorkflowLatestPublishedId: /workflows/latest/published/{id}
+    WorkflowVariables: /workflows/{id}/variables
+    WorkflowRun: /workflows/{id}/revisions/{revision}/run
+    WorkflowTerminate: /workflows/{workflowId}/instances/{instanceId}/complete
+    WorkflowHistoryObject: /workflowhistories/{workflowId}/objects/{objectId}
+    WorkflowHistoryRunningObject: /workflowhistories/{workflowId}/objects/{objectId}/running
+  NotificationsApi:
+    ForceUIRefresh: /Users/{id}/ForceUIRefresh

package/dist/constants.cjs

@@ -0,0 +1,45 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// lib/constants.js
+var constants_exports = {};
+__export(constants_exports, {
+  MemberType: () => MemberType,
+  RoleType: () => RoleType,
+  default: () => constants_default
+});
+module.exports = __toCommonJS(constants_exports);
+var RoleType = Object.freeze({
+  None: 0,
+  Owner: 1,
+  Editor: 2,
+  Publisher: 3,
+  Viewer: 4,
+  Member: 5
+});
+var MemberType = Object.freeze({
+  User: 0,
+  Group: 1
+});
+var constants_default = { RoleType, MemberType };
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  MemberType,
+  RoleType
+});
+//# sourceMappingURL=constants.cjs.map

package/dist/constants.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../lib/constants.js"],"sourcesContent":["/**\r\n * Security role types for folder and document permissions.\r\n * Use these constants when calling security member functions.\r\n *\r\n * @example\r\n * import { RoleType } from 'visualvault-node';\r\n *\r\n * await client.library.putFolderSecurityMember(\r\n *   folderId,\r\n *   memberId,\r\n *   'User',\r\n *   RoleType.Viewer,\r\n *   false\r\n * );\r\n */\r\nexport const RoleType = Object.freeze({\r\n    None: 0,\r\n    Owner: 1,\r\n    Editor: 2,\r\n    Publisher: 3,\r\n    Viewer: 4,\r\n    Member: 5\r\n});\r\n\r\n\r\n/**\r\n * Security member types for folder and document permissions.\r\n * Use these constants when calling security member functions.\r\n *\r\n * @example\r\n * import { RoleType } from 'visualvault-node';\r\n *\r\n * await client.library.putFolderSecurityMember(\r\n *   folderId,\r\n *   memberId,\r\n *   MemberType.User,\r\n *   RoleType.Viewer,\r\n *   false\r\n * );\r\n */\r\nexport const MemberType = Object.freeze({\r\n    User: 0,\r\n    Group: 1\r\n});\r\n\r\nexport default { RoleType, MemberType };\r\n\r\n"],"mappings":";;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAeO,IAAM,WAAW,OAAO,OAAO;AAAA,EAClC,MAAM;AAAA,EACN,OAAO;AAAA,EACP,QAAQ;AAAA,EACR,WAAW;AAAA,EACX,QAAQ;AAAA,EACR,QAAQ;AACZ,CAAC;AAkBM,IAAM,aAAa,OAAO,OAAO;AAAA,EACpC,MAAM;AAAA,EACN,OAAO;AACX,CAAC;AAED,IAAO,oBAAQ,EAAE,UAAU,WAAW;","names":[]}

package/dist/constants.d.cts

@@ -0,0 +1,48 @@
+/**
+ * Security role types for folder and document permissions.
+ * Use these constants when calling security member functions.
+ *
+ * @example
+ * import { RoleType } from 'visualvault-node';
+ *
+ * await client.library.putFolderSecurityMember(
+ *   folderId,
+ *   memberId,
+ *   'User',
+ *   RoleType.Viewer,
+ *   false
+ * );
+ */
+declare const RoleType: Readonly<{
+    None: 0;
+    Owner: 1;
+    Editor: 2;
+    Publisher: 3;
+    Viewer: 4;
+    Member: 5;
+}>;
+/**
+ * Security member types for folder and document permissions.
+ * Use these constants when calling security member functions.
+ *
+ * @example
+ * import { RoleType } from 'visualvault-node';
+ *
+ * await client.library.putFolderSecurityMember(
+ *   folderId,
+ *   memberId,
+ *   MemberType.User,
+ *   RoleType.Viewer,
+ *   false
+ * );
+ */
+declare const MemberType: Readonly<{
+    User: 0;
+    Group: 1;
+}>;
+declare namespace _default {
+    export { RoleType };
+    export { MemberType };
+}
+
+export { MemberType, RoleType, _default as default };

package/dist/constants.d.ts

@@ -0,0 +1,48 @@
+/**
+ * Security role types for folder and document permissions.
+ * Use these constants when calling security member functions.
+ *
+ * @example
+ * import { RoleType } from 'visualvault-node';
+ *
+ * await client.library.putFolderSecurityMember(
+ *   folderId,
+ *   memberId,
+ *   'User',
+ *   RoleType.Viewer,
+ *   false
+ * );
+ */
+declare const RoleType: Readonly<{
+    None: 0;
+    Owner: 1;
+    Editor: 2;
+    Publisher: 3;
+    Viewer: 4;
+    Member: 5;
+}>;
+/**
+ * Security member types for folder and document permissions.
+ * Use these constants when calling security member functions.
+ *
+ * @example
+ * import { RoleType } from 'visualvault-node';
+ *
+ * await client.library.putFolderSecurityMember(
+ *   folderId,
+ *   memberId,
+ *   MemberType.User,
+ *   RoleType.Viewer,
+ *   false
+ * );
+ */
+declare const MemberType: Readonly<{
+    User: 0;
+    Group: 1;
+}>;
+declare namespace _default {
+    export { RoleType };
+    export { MemberType };
+}
+
+export { MemberType, RoleType, _default as default };

package/dist/constants.js

@@ -0,0 +1,20 @@
+// lib/constants.js
+var RoleType = Object.freeze({
+  None: 0,
+  Owner: 1,
+  Editor: 2,
+  Publisher: 3,
+  Viewer: 4,
+  Member: 5
+});
+var MemberType = Object.freeze({
+  User: 0,
+  Group: 1
+});
+var constants_default = { RoleType, MemberType };
+export {
+  MemberType,
+  RoleType,
+  constants_default as default
+};
+//# sourceMappingURL=constants.js.map

package/dist/constants.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../lib/constants.js"],"sourcesContent":["/**\r\n * Security role types for folder and document permissions.\r\n * Use these constants when calling security member functions.\r\n *\r\n * @example\r\n * import { RoleType } from 'visualvault-node';\r\n *\r\n * await client.library.putFolderSecurityMember(\r\n *   folderId,\r\n *   memberId,\r\n *   'User',\r\n *   RoleType.Viewer,\r\n *   false\r\n * );\r\n */\r\nexport const RoleType = Object.freeze({\r\n    None: 0,\r\n    Owner: 1,\r\n    Editor: 2,\r\n    Publisher: 3,\r\n    Viewer: 4,\r\n    Member: 5\r\n});\r\n\r\n\r\n/**\r\n * Security member types for folder and document permissions.\r\n * Use these constants when calling security member functions.\r\n *\r\n * @example\r\n * import { RoleType } from 'visualvault-node';\r\n *\r\n * await client.library.putFolderSecurityMember(\r\n *   folderId,\r\n *   memberId,\r\n *   MemberType.User,\r\n *   RoleType.Viewer,\r\n *   false\r\n * );\r\n */\r\nexport const MemberType = Object.freeze({\r\n    User: 0,\r\n    Group: 1\r\n});\r\n\r\nexport default { RoleType, MemberType };\r\n\r\n"],"mappings":";AAeO,IAAM,WAAW,OAAO,OAAO;AAAA,EAClC,MAAM;AAAA,EACN,OAAO;AAAA,EACP,QAAQ;AAAA,EACR,WAAW;AAAA,EACX,QAAQ;AAAA,EACR,QAAQ;AACZ,CAAC;AAkBM,IAAM,aAAa,OAAO,OAAO;AAAA,EACpC,MAAM;AAAA,EACN,OAAO;AACX,CAAC;AAED,IAAO,oBAAQ,EAAE,UAAU,WAAW;","names":[]}