refactor: ♻️ changes users in teams to teamUsers

Author: harshithad0703

lib/organization/teams/index.js

@@ -86,11 +86,11 @@ export function Teams (http, data) {
      * @example
      * import * as contentstack from '@contentstack/management'
      * const client = contentstack.client()
-     * client.organization('organizationUid').teams('teamUid').users().fetchAll()
+     * client.organization('organizationUid').teams('teamUid').teamUsers().fetchAll()
      *  .then((response) => console.log(response))
      *
      */
-    this.users = (userId = null) => {
+    this.teamUsers = (userId = null) => {
       data.organizationUid = this.organizationUid
       data.teamUid = this.uid
       if (userId) {

lib/organization/teams/teamUsers/index.js

@@ -21,7 +21,7 @@ export function TeamUsers (http, data) {
      * import * as contentstack from '@contentstack/management'
      * const client = contentstack.client()
      *
-     * client.organization('organizationUid').teams('teamUid').users('userId').remove()
+     * client.organization('organizationUid').teams('teamUid').teamUsers('userId').remove()
      * .then((response) => console.log(response))
      *
      */
@@ -40,7 +40,7 @@ export function TeamUsers (http, data) {
      * const usersMail = {
      *    emails: ['emailId1','emailId2' ]
      * }
-     * client.organization('organizationUid').teams('teamUid').users('userId').add(usersMail)
+     * client.organization('organizationUid').teams('teamUid').teamUsers('userId').add(usersMail)
      * .then((response) => console.log(response))
      *
      */
@@ -56,15 +56,15 @@ export function TeamUsers (http, data) {
      * const client = contentstack.client()
      * const usersMail = {
      * emails: ['emailId1','emailId2' ]}
-     * client.organization('organizationUid').teams('teamUid').users('userId').query().find()
+     * client.organization('organizationUid').teams('teamUid').teamUsers('userId').query().find()
      * .then((response) => console.log(response))
      *
      */
     this.fetchAll = fetchAll(http, UsersCollection)
   }
 }
 export function UsersCollection (http, data) {
-  const obj = cloneDeep(data.users) || []
+  const obj = cloneDeep(data.teamUsers) || []
   const usersCollection = obj.map((user) => {
     return new TeamUsers(http, { userId: user })
   })

test/api/team-users-test.js

@@ -43,5 +43,5 @@ describe('Teams Users API Test', () => {
 })
 
 function makeUsers (organizationUid, teamUid, userId = null) {
-  return client.organization(organizationUid).teams(teamUid).users(userId)
+  return client.organization(organizationUid).teams(teamUid).teamUsers(userId)
 }

test/typescript/teamUsers.ts

@@ -8,22 +8,22 @@ export function testTeamUsers (organization: Organization) {
       const usersMail = {
         emails: ['email@email.com']
       }
-        organization.teams(teamUid).users().add(usersMail).then((response) => {
+        organization.teams(teamUid).teamUsers().add(usersMail).then((response) => {
         expect(response.status).to.be.eql(201)
         done()
       })
         .catch(done)
     })
     test('should remove the user when uid is passed', done => {
       const user_id = 'user_id'
-      organization.teams(teamUid).users(user_id).remove().then((response) => {
+      organization.teams(teamUid).teamUsers(user_id).remove().then((response) => {
         expect(response.status).to.be.equal(204)
         done()
       })
         .catch(done)
     })
     test('should fetch all users', done => {
-      organization.teams(teamUid).users()
+      organization.teams(teamUid).teamUsers()
       .fetchAll()
         .then((response) => {
           expect(response.items[0]).not.to.be.equal(undefined)

test/unit/team-test.js

@@ -76,7 +76,7 @@ describe('Contentstack Team test', () => {
   it('should fetch all users', done => {
     var mock = new MockAdapter(Axios)
     mock.onGet(`/organizations/organization_uid/teams/UID/users`).reply(200, teamUsersMock)
-    makeTeams({ ...systemUidMock }).users().fetchAll()
+    makeTeams({ ...systemUidMock }).teamUsers().fetchAll()
       .then((users) => {
         users.items.forEach((user) => {
           expect(user.uidId).to.be.not.equal(null)

types/teams/index.d.ts

@@ -6,8 +6,8 @@ import { StackRoleMapping, StackRoleMappings, StackRoleMappingData } from "./sta
 
 export interface Team extends TeamData {
     update(data: TeamData, param?: { includeUserDetails?: boolean}): Promise<AnyProperty>
-    users(): TeamUsers
-    users(uid: string): TeamUser
+    teamUsers(): TeamUsers
+    teamUsers(uid: string): TeamUser
     stackRoleMappings(): StackRoleMappings
     stackRoleMappings(stackApiKey: string): StackRoleMapping
     fetch(): Promise<Team>