feat(invites): resource (#792)

* feat(invites): resource

* feat(invites): +JsDoc on invites

---------

Co-authored-by: Danny Gauthier <[email protected]>
Co-authored-by: Felix <[email protected]>

src/resources/Invites/Invites.model.ts

@@ -0,0 +1,23 @@
+export interface AuthInviteModel {
+    /**
+     * Invite ID.
+     */
+    id: string;
+    /**
+     * Invite group name.
+     */
+    displayName: string;
+    /**
+     * Organizations array will always have only one item.
+     */
+    organizations: Array<{
+        /**
+         * Org ID where the user is invited in a group.
+         */
+        id: string;
+        /**
+         * Org ID where the user is invited in a group.
+         */
+        displayName: string;
+    }>;
+}

src/resources/Invites/Invites.ts

@@ -0,0 +1,12 @@
+import Resource from '../Resource.js';
+import {AuthInviteModel} from './Invites.model.js';
+
+export default class Invites extends Resource {
+    static baseUrl = '/rest/invites';
+    /**
+     * Lists groups current user is invited too.
+     */
+    list() {
+        return this.api.get<AuthInviteModel[]>(Invites.baseUrl);
+    }
+}

src/resources/Invites/index.ts

@@ -0,0 +1,2 @@
+export * from './Invites.model.js';
+export * from './Invites.js';

src/resources/Invites/tests/Invites.spec.ts

@@ -0,0 +1,26 @@
+import API from '../../../APICore.js';
+import Invites from '../Invites.js';
+jest.mock('../../../APICore.js');
+
+const APIMock: jest.Mock<API> = API as any;
+
+describe('Invites', () => {
+    let invites: Invites;
+
+    const api = new APIMock() as jest.Mocked<API>;
+    const serverlessApi = new APIMock() as jest.Mocked<API>;
+
+    beforeEach(() => {
+        jest.clearAllMocks();
+        invites = new Invites(api, serverlessApi);
+    });
+
+    describe('list', () => {
+        it('should make a GET call with all parameters', () => {
+            invites.list();
+
+            expect(api.get).toHaveBeenCalledTimes(1);
+            expect(api.get).toHaveBeenCalledWith(Invites.baseUrl);
+        });
+    });
+});

src/resources/PlatformResources.ts

@@ -18,6 +18,7 @@ import Index from './Indexes/Indexes.js';
 import InProductExperiences from './InProductExperiences/InProductExperiences.js';
 import InsightPanelConfig from './InsightPanelConfigs/InsightPanelConfig.js';
 import InsightPanelInterface from './InsightPanelInterfaces/InsightPanelInterface.js';
+import Invites from './Invites/Invites.js';
 import IPXInterface from './IPXInterfaces/IPXInterface.js';
 import License from './License/License.js';
 import Limits from './Limits/Limits.js';
@@ -71,6 +72,7 @@ const resourcesMap: Array<{key: string; resource: typeof Resource}> = [
     {key: 'index', resource: Index},
     {key: 'insightPanelConfig', resource: InsightPanelConfig},
     {key: 'insightPanelInterface', resource: InsightPanelInterface},
+    {key: 'invites', resource: Invites},
     {key: 'ipx', resource: InProductExperiences},
     {key: 'ipxInterface', resource: IPXInterface},
     {key: 'license', resource: License},
@@ -130,6 +132,7 @@ class PlatformResources {
     index: Index;
     insightPanelConfig: InsightPanelConfig;
     insightPanelInterface: InsightPanelInterface;
+    invites: Invites;
     ipx: InProductExperiences;
     ipxInterface: IPXInterface;
     license: License;

src/resources/index.ts

@@ -21,6 +21,7 @@ export * from './Indexes/index.js';
 export * from './InProductExperiences/index.js';
 export * from './InsightPanelConfigs/index.js';
 export * from './InsightPanelInterfaces/index.js';
+export * from './Invites/index.js';
 export * from './IPXInterfaces/index.js';
 export * from './License/index.js';
 export * from './Limits/index.js';