mongodb-atlas-api-client 2.29.0 → 2.32.0

package/README.md

@@ -5,6 +5,8 @@ A mongdb atlas api client for nodejs.
 [![Known Vulnerabilities](https://snyk.io/test/github/montumodi/mongodb-atlas-api-client/badge.svg)](https://snyk.io/test/github/montumodi/mongodb-atlas-api-client)
 [![Coverage Status](https://coveralls.io/repos/github/montumodi/mongodb-atlas-api-client/badge.svg?branch=master)](https://coveralls.io/github/montumodi/mongodb-atlas-api-client?branch=master)
 [![Build Status](https://travis-ci.com/montumodi/mongodb-atlas-api-client.svg?branch=master)](https://travis-ci.com/montumodi/mongodb-atlas-api-client)
+![NPM Publish](https://github.com/montumodi/mongodb-atlas-api-client/actions/workflows/.github/workflows/npmpublish.yml/badge.svg)
+
 [![Deps](https://david-dm.org/montumodi/mongodb-atlas-api-client.svg)](https://david-dm.org/montumodi/mongodb-atlas-api-client#info=dependencies)
 [![devDependency Status](https://david-dm.org/montumodi/mongodb-atlas-api-client/dev-status.svg)](https://david-dm.org/montumodi/mongodb-atlas-api-client#info=devDependencies)
 
@@ -572,6 +574,23 @@ Function - Renames the organization
 
 More details - https://docs.atlas.mongodb.com/reference/api/organization-rename/
 
+### organization.invite(organizationId, body, [options]) ⇒ <code>Promise</code>
+Function - Sends an invitation to the given email (username) to join the Organization
+
+**Returns**: <code>Promise</code> - - promise which resolves on success and rejects on error  
+
+| Param | Type | Default | Description |
+| --- | --- | --- | --- |
+| organizationId | <code>String</code> |  | Id of the organization for which needs to be renamed |
+| body | <code>Object</code> |  | Organization invitation details 
+| body.roles | <code>string[]</code> |  | Atlas roles to assign to the invited user. If the user accepts the invitation, Atlas assigns these roles to them. |
+| body.teamIds | <code>string[]</code> |  | *(Optional)* Unique 24-hexadecimal digit strings that identify the teams that you invite the user to join. 
+| body.username | <code>string</code> |  | Email address of the invited user. This is the address to which Atlas sends the invite. 
+| [options] | <code>Object</code> | <code>{}</code> | Optional object containing extra query strings which will be passed to atlas api |
+
+More details - https://docs.atlas.mongodb.com/reference/api/organization-create-one-invitation/
+
+
 ### organization.delete(organizationId, [options]) ⇒ <code>Promise</code>
 Function - Deletes the project id passed.
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mongodb-atlas-api-client",
-  "version": "2.29.0",
+  "version": "2.32.0",
   "description": "A mongodb atlas api client for nodejs.",
   "main": "src/index.js",
   "scripts": {

package/src/organization.d.ts

@@ -17,6 +17,24 @@ export interface RenameOrganizationRequest {
      */
     name: string;
 }
+
+export interface InviteOneToOrganizationRequest {
+    roles: string[],
+    teamIds?: string[],
+    username: string,
+}
+
+export interface InviteOneToOrganizationResponse {
+    createdAt: string,
+    expiresAt: string,
+    id: string,
+    inviterUsername: string,
+    orgId: string,
+    orgName: string,
+    roles: string[],
+    teamIds: string[],
+    username: string,
+}
 export type RenameOrganizationResponse = GetOrganizationResponse;
 export interface Organization {
     getById(organizationId: OrganizationId, options?: AtlasClientOptions): Promise<GetOrganizationResponse | AtlasError>;
@@ -25,4 +43,5 @@ export interface Organization {
     getAll(options?: AtlasClientOptions): Promise<GetAllOrganizationsResponse | AtlasError>;
     delete(organizationId: OrganizationId, options?: AtlasClientOptions): Promise<void | AtlasError>;
     rename(organizationId: OrganizationId, organization: RenameOrganizationRequest, options?: AtlasClientOptions): Promise<RenameOrganizationResponse | AtlasError>;
+    invite(organizationId: OrganizationId, organization: InviteOneToOrganizationRequest, options?: AtlasClientOptions): Promise<InviteOneToOrganizationResponse | AtlasError>;
 }

package/src/organization.js

@@ -62,6 +62,19 @@ class Organization {
     ).json();
     return response;
   }
+
+  async invite(organizationId, body, options) {
+    const urlparams = new URLSearchParams(options);
+    const queryString = urlparams.toString();
+    const response = (
+      await this.client_.fetch(`${this.baseUrl_}/orgs/${organizationId}/invites?${queryString}`, {
+        "method": "POST",
+        "body": JSON.stringify(body),
+        "headers": {"Content-Type": "application/json"}
+      })
+    ).json();
+    return response;
+  }
 }
 
 module.exports = Organization;

package/test/organization.test.js

@@ -21,6 +21,7 @@ describe("Mongo Atlas Api Client - Organization", () => {
       expect(client.organization.rename).to.be.function();
       expect(client.organization.getAllUsersForOrganization).to.be.function();
       expect(client.organization.getAllProjectsForOrganization).to.be.function();
+      expect(client.organization.invite).to.be.function();
     });
   });
 
@@ -89,4 +90,15 @@ describe("Mongo Atlas Api Client - Organization", () => {
       expect(expectedRequest.isDone()).to.be.true();
     });
   });
+
+  describe("When invite is called with querystring parameters", () => {
+    it("should return response", async () => {
+      const expectedRequest = nock(baseUrl)
+        .post("/orgs/orgId/invites?key1=value1&key2=value2")
+        .reply(200, [{"organization": "name"}]);
+      const result = await client.organization.invite("orgId", {"body": "value"}, {"key1": "value1", "key2": "value2"});
+      expect(result).to.equal([{"organization": "name"}]);
+      expect(expectedRequest.isDone()).to.be.true();
+    });
+  });
 });