feat(groups): add createGroupNotification

AFFECTS PACKAGES: @esri/arcgis-rest-groups
Esri · Sep 10, 2018 · 4baab64 · 4baab64
1 parent 40bc5c1
commit 4baab64
Show file tree

Hide file tree

Showing 3 changed files with 77 additions and 2 deletions.
diff --git a/packages/arcgis-rest-groups/src/groups.ts b/packages/arcgis-rest-groups/src/groups.ts
@@ -24,6 +24,16 @@ export interface IGroupIdRequestOptions extends IRequestOptions {
   id: string;
 }
 
+export interface IGroupNotificationRequestOptions
+  extends IGroupIdRequestOptions {
+  subject?: string;
+  message: string | object;
+  users?: string[];
+  notificationChannelType: string;
+  clientId?: string;
+  silentNotification?: boolean;
+}
+
 export interface IGroupAddRequestOptions extends IRequestOptions {
   group: IGroupAdd;
 }
@@ -270,3 +280,32 @@ function serializeGroup(group: IGroupAdd | IItemUpdate | IGroup): any {
   clone.tags = clone.tags.join(", ");
   return clone;
 }
+
+/**
+ * Create a group notification.
+ * @param requestOptions - Options for the request
+ * @returns A Promise that will resolve with the success/failure status of the request
+ */
+// see http://mediawikidev.esri.com/index.php/ArcGIS.com/User_Notifications
+export function createGroupNotification(
+  requestOptions: IGroupNotificationRequestOptions
+): Promise<any> {
+  const url = `${getPortalUrl(requestOptions)}/community/groups/${
+    requestOptions.id
+  }/createNotification`;
+
+  const options: IGroupNotificationRequestOptions = {
+    params: {
+      subject: requestOptions.subject,
+      message: requestOptions.message,
+      users: requestOptions.users,
+      notificationChannelType: requestOptions.notificationChannelType,
+      clientId: requestOptions.clientId,
+      silentNotification: requestOptions.silentNotification,
+      notifyAll: !requestOptions.users || requestOptions.users.length === 0,
+      ...requestOptions.params
+    },
+    ...requestOptions
+  };
+  return request(url, options);
+}
diff --git a/packages/arcgis-rest-groups/test/groups.test.ts b/packages/arcgis-rest-groups/test/groups.test.ts
@@ -10,16 +10,19 @@ import {
   updateGroup,
   removeGroup,
   protectGroup,
-  unprotectGroup
+  unprotectGroup,
+  createGroupNotification
 } from "../src/index";
 
 import {
   GroupSearchResponse,
   GroupEditResponse,
   GroupResponse,
   GroupContentResponse,
-  GroupUsersResponse
+  GroupUsersResponse,
+  GroupNotificationResponse
 } from "./mocks/responses";
+
 import { encodeParam } from "@esri/arcgis-rest-request";
 import * as fetchMock from "fetch-mock";
 
@@ -278,6 +281,35 @@ describe("groups", () => {
           fail(e);
         });
     });
+    it("should create a group notification", done => {
+      fetchMock.once("*", GroupNotificationResponse);
+
+      const opts = {
+        id: "3ef",
+        subject: "string",
+        message: "string | object",
+        notificationChannelType: "email",
+        ...MOCK_REQOPTS
+      };
+
+      createGroupNotification(opts)
+        .then(response => {
+          expect(fetchMock.called()).toEqual(true);
+          const [url, options]: [string, RequestInit] = fetchMock.lastCall("*");
+          expect(url).toEqual(
+            "https://myorg.maps.arcgis.com/sharing/rest/community/groups/3ef/createNotification"
+          );
+          expect(options.method).toBe("POST");
+          expect(options.body).toContain(encodeParam("f", "json"));
+          expect(options.body).toContain(encodeParam("token", "fake-token"));
+          expect(options.body).toContain(encodeParam("notifyAll", true));
+          expect(response.success).toEqual(true);
+          done();
+        })
+        .catch(e => {
+          fail(e);
+        });
+    });
     // it('should make authenticated call to get the group content', done => {})
   });
 });
diff --git a/packages/arcgis-rest-groups/test/mocks/responses.ts b/packages/arcgis-rest-groups/test/mocks/responses.ts
@@ -138,3 +138,7 @@ export const GroupContentResponse: IGroupContentResult = {
     }
   ]
 };
+
+export const GroupNotificationResponse: any = {
+  success: true
+};