@verdocs/js-sdk 2.0.8 → 2.0.9

package/Organizations/Groups.d.ts

@@ -18,7 +18,17 @@ import { VerdocsEndpoint } from '../VerdocsEndpoint';
  * const groups = await Groups.getGroups(ORGID);
  * ```
  */
-export declare const getGroups: (endpoint: VerdocsEndpoint, organizationId: string, name?: string) => Promise<IGroup[]>;
+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<IGroup>;
 /**
  * Get the details for a group.
  *

package/Organizations/Groups.js

@@ -16,7 +16,21 @@
  * const groups = await Groups.getGroups(ORGID);
  * ```
  */
-export var getGroups = function (endpoint, organizationId, name) {
+export var getGroups = function (endpoint, organizationId) {
+    return endpoint.api //
+        .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; });

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[];

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@verdocs/js-sdk",
-  "version": "2.0.8",
+  "version": "2.0.9",
   "private": false,
   "homepage": "https://github.com/Verdocs/js-sdk",
   "description": "Verdocs JS SDK",