@verdocs/js-sdk 2.0.7 → 2.0.10

package/Documents/Documents.d.ts

@@ -8,9 +8,17 @@ export declare type TRecipientType = 'signer' | 'cc' | 'approver';
 export interface IDocumentsSearchResultEntry {
     id: string;
     canceled_at: string;
+    certificate_document_id: string;
     created_at: string;
+    envelope_document_id: string;
+    histories: IHistory[];
+    indexed_at: string;
     name: string;
+    no_contact: boolean;
+    organization_id: string;
     profile_id: string;
+    recipients: string;
+    reminder_id: string | null;
     status: TDocumentStatus;
     next_recipient: {
         claimed: boolean;

package/Organizations/Groups.d.ts

@@ -19,6 +19,16 @@ import { VerdocsEndpoint } from '../VerdocsEndpoint';
  * ```
  */
 export declare const getGroups: (endpoint: VerdocsEndpoint, organizationId: string) => Promise<IGroup[]>;
+/**
+ * Get a single group by name. Returns a detail record.
+ *
+ * ```typescript
+ * import {Groups} from '@verdocs/js-sdk/Organizations';
+ *
+ * const groups = await Groups.getGroups(ORGID);
+ * ```
+ */
+export declare const getGroupByName: (endpoint: VerdocsEndpoint, organizationId: string, name?: string) => Promise<IGroupDetail>;
 /**
  * Get the details for a group.
  *

package/Organizations/Groups.js

@@ -21,6 +21,20 @@ export var getGroups = function (endpoint, organizationId) {
         .get("/organizations/".concat(organizationId, "/groups"))
         .then(function (r) { return r.data; });
 };
+/**
+ * Get a single group by name. Returns a detail record.
+ *
+ * ```typescript
+ * import {Groups} from '@verdocs/js-sdk/Organizations';
+ *
+ * const groups = await Groups.getGroups(ORGID);
+ * ```
+ */
+export var getGroupByName = function (endpoint, organizationId, name) {
+    return endpoint.api //
+        .get("/organizations/".concat(organizationId, "/groups"), { params: { name: name } })
+        .then(function (r) { return r.data; });
+};
 /**
  * Get the details for a group.
  *

package/Organizations/Types.d.ts

@@ -41,6 +41,8 @@ export interface IGroup {
     name: string;
     organization_id: string;
     /** For future expansion. In the future, Verdocs may support group hierarchies. Until then this field is always null. */
+    parent: IGroup | null;
+    /** For future expansion. In the future, Verdocs may support group hierarchies. Until then this field is always null. */
     parent_id: string | null;
     /** Some operations will additionally return a list of permissions. */
     permissions?: TPermission[];
@@ -49,8 +51,25 @@ export interface IGroup {
     /** Some operations will additionally return a list of profiles. */
     profiles?: IProfile[];
 }
-export interface IGroupDetail extends IGroup {
-    permissions: TPermission[];
-    roles: TRole[];
+export interface IPermissionDetail {
+    id: string;
+    name: string;
+    client_id: string;
+}
+export interface IRoleDetail {
+    id: string;
+    name: string;
+    client_id: string;
+}
+export interface IGroupDetail {
+    id: string;
+    name: string;
+    organization_id: string;
+    permissions: IPermissionDetail[];
+    roles: IRoleDetail[];
     profiles: IProfile[];
+    /** For future expansion. In the future, Verdocs may support group hierarchies. Until then this field is always null. */
+    parent: IGroup | null;
+    /** For future expansion. In the future, Verdocs may support group hierarchies. Until then this field is always null. */
+    parent_id: string | null;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@verdocs/js-sdk",
-  "version": "2.0.7",
+  "version": "2.0.10",
   "private": false,
   "homepage": "https://github.com/Verdocs/js-sdk",
   "description": "Verdocs JS SDK",
@@ -53,13 +53,13 @@
   "devDependencies": {
     "@jest/globals": "^28.1.2",
     "@types/jest": "^28.1.4",
-    "axios-mock-adapter": "^1.21.1",
+    "axios-mock-adapter": "^1.21.2",
     "jest": "^28.1.2",
     "prettier": "^2.7.1",
-    "ts-jest": "^28.0.5",
+    "ts-jest": "^28.0.8",
     "tslint": "^6.1.3",
     "tslint-config-prettier": "^1.18.0",
-    "typedoc": "^0.23.9",
+    "typedoc": "^0.23.11",
     "typedoc-plugin-markdown": "^3.13.4",
     "typescript": "^4.7.4"
   }