Fixed the other modules jsdoc

Author: cs-raj

lib/organization/teams/index.js

@@ -18,10 +18,16 @@ export function Teams (http, data) {
     this.urlPath = `/organizations/${this.organizationUid}/teams/${this.uid}`
 
     /**
-     * @description The update call on team will allow to update details of team.
+     * @description The update call allows you to update details of a team.
      * @memberof Teams
      * @func update
-     * @returns {Promise<Teams.Teams>} Response Object.
+     * @async
+     * @param {Object} updateData - Team update data.
+     * @prop {string} updateData.name - Team name.
+     * @prop {Array<Object>} updateData.users - Array of user objects with email property.
+     * @prop {string} updateData.organizationRole - Organization role UID.
+     * @prop {Array} updateData.stackRoleMapping - Stack role mappings.
+     * @returns {Promise<Object>} Response Object.
      * @example
      * import * as contentstack from '@contentstack/management'
      * const client = contentstack.client()
@@ -35,7 +41,7 @@ export function Teams (http, data) {
      *    organizationRole: 'blt09e5dfced326aaea',
      *    stackRoleMapping: []
      *   }
-     * client.organization(s'organizationUid').teams('teamUid').update(updateData)
+     * client.organization('organizationUid').teams('teamUid').update(updateData)
      * .then((response) => console.log(response))
      *
      */
@@ -51,10 +57,10 @@ export function Teams (http, data) {
     }
 
     /**
-     * @description The delete call on team will delete the existing team.
+     * @description The delete call deletes an existing team.
      * @memberof Teams
      * @func delete
-     * @returns {Promise<Teams.Teams>} Response Object.
+     * @returns {Promise<Object>} Response Object.
      * @example
      * import * as contentstack from '@contentstack/management'
      * const client = contentstack.client()
@@ -65,10 +71,10 @@ export function Teams (http, data) {
     this.delete = deleteEntity(http)
 
     /**
-     * @description The fetch call on team will delete the existing team.
+     * @description The fetch call fetches the existing team details.
      * @memberof Teams
      * @func fetch
-     * @returns {Promise<Teams.Teams>} Response Object.
+     * @returns {Promise<Teams>} Promise for Teams instance
      * @example
      * import * as contentstack from '@contentstack/management'
      * const client = contentstack.client()
@@ -79,10 +85,10 @@ export function Teams (http, data) {
     this.fetch = fetch(http, 'team')
 
     /**
-     * @description The users call on team will get users details.
+     * @description The teamUsers call returns a TeamUsers instance for managing team users.
      * @memberof Teams
-     * @func users
-     * @returns {Promise<Teams.Teams>} Response Object.
+     * @func teamUsers
+     * @returns {TeamUsers} Instance of TeamUsers.
      * @example
      * import * as contentstack from '@contentstack/management'
      * const client = contentstack.client()
@@ -100,10 +106,10 @@ export function Teams (http, data) {
     }
 
     /**
-     * @description The stackRoleMappings call on team will get the stack role Mapping.
+     * @description The stackRoleMappings call returns a StackRoleMappings instance for managing stack role mappings.
      * @memberof Teams
-     * @func users
-     * @returns {Promise<Teams.Teams>} Response Object.
+     * @func stackRoleMappings
+     * @returns {StackRoleMappings} Instance of StackRoleMappings.
      * @example
      * import * as contentstack from '@contentstack/management'
      * const client = contentstack.client()
@@ -121,10 +127,10 @@ export function Teams (http, data) {
     }
   } else {
     /**
-     * @description The fetch call on team will delete the existing team.
+     * @description The create call creates a new team.
      * @memberof Teams
      * @func create
-     * @returns {Promise<Teams.Teams>} Response Object.
+     * @returns {Promise<Teams>} Promise for Teams instance
      * @example
      * import * as contentstack from '@contentstack/management'
      * const client = contentstack.client()
@@ -142,10 +148,10 @@ export function Teams (http, data) {
     this.create = create({ http })
 
     /**
-     * @description The fetchAll on team will allow to fetch details of all teams.
+     * @description The fetchAll call allows you to fetch details of all teams.
      * @memberof Teams
      * @func fetchAll
-     * @returns {Promise<Teams.Teams>} Response Object.
+     * @returns {Promise<ContentstackCollection>} Promise for ContentstackCollection instance.
      * @example
      * import * as contentstack from '@contentstack/management'
      * const client = contentstack.client()

lib/organization/teams/stackRoleMappings/index.js

@@ -17,7 +17,8 @@ export function StackRoleMappings (http, data) {
      * @description The update stackRoleMappings call is used to update the roles.
      * @memberof StackRoleMappings
      * @func update
-     * @returns {Promise<StackRoleMappings.StackRoleMappings>} Response Object.
+     * @param {Object} updateData - The data to update stack role mappings
+     * @returns {Promise<Object>} Response Object.
      * @example
      * import * as contentstack from '@contentstack/management'
      * const client = contentstack.client()
@@ -45,7 +46,7 @@ export function StackRoleMappings (http, data) {
      * @description The delete stackRoleMappings call is used to delete the roles.
      * @memberof StackRoleMappings
      * @func delete
-     * @returns {Promise<StackRoleMappings.StackRoleMappings>} Response Object.
+     * @returns {Promise<Object>} Response Object.
      * @example
      * import * as contentstack from '@contentstack/management'
      * const client = contentstack.client()
@@ -60,13 +61,13 @@ export function StackRoleMappings (http, data) {
      * @description The add stackRoleMappings call is used to add the roles.
      * @memberof StackRoleMappings
      * @func add
-     * @returns {Promise<StackRoleMappings.StackRoleMappings>} Response Object.
+     * @returns {Promise<Object>} Response Object.
      * @example
      * import * as contentstack from '@contentstack/management'
      * const client = contentstack.client()
      *
      * const addRole = {
-     *  'stackApiKey: 'stackApiKey',
+     *  'stackApiKey': 'stackApiKey',
      *  'roles': [
      *    'role_uid'
      *    ]
@@ -89,12 +90,12 @@ export function StackRoleMappings (http, data) {
      * @description The fetchAll stackRoleMappings call is used to fetchAll the roles.
      * @memberof StackRoleMappings
      * @func fetchAll
-     * @returns {Promise<StackRoleMappings.StackRoleMappings>} Response Object.
+     * @returns {Promise<Object>} Response Object.
      * @example
      * import * as contentstack from '@contentstack/management'
      * const client = contentstack.client()
      *
-     * client.organization('organizationUid').teams('teamUid').stackRoleMappings().fetchAll
+     * client.organization('organizationUid').teams('teamUid').stackRoleMappings().fetchAll()
      * .then((response) => console.log(response))
      */
     this.fetchAll = async () => {

lib/organization/teams/teamUsers/index.js

@@ -16,7 +16,7 @@ export function TeamUsers (http, data) {
      * @description The Remove teamUser call is used to remove an existing user of that team.
      * @memberof TeamUsers
      * @func remove
-     * @returns {Promise<TeamUsers.TeamUsers>} Response Object.
+     * @returns {Promise<Object>} Response Object.
      * @example
      * import * as contentstack from '@contentstack/management'
      * const client = contentstack.client()
@@ -33,7 +33,7 @@ export function TeamUsers (http, data) {
      * @description The Add teamUser call is used to add a user to the team.
      * @memberof TeamUsers
      * @func add
-     * @returns {Promise<TeamUsers.TeamUsers>} Promise for TeamUsers instance
+     * @returns {Promise<Object>} Response Object.
      * @example
      * import * as contentstack from '@contentstack/management'
      * const client = contentstack.client()
@@ -47,10 +47,10 @@ export function TeamUsers (http, data) {
     this.add = create({ http })
 
     /**
-     * @description The fetchAll on teamUser will allow to fetch details of all teamUsers.
+     * @description The fetchAll call allows you to fetch details of all team users.
      * @memberof TeamUsers
      * @func fetchAll
-     * @returns {ContentstackCollection} Instance of ContentstackCollection.
+     * @returns {Promise<ContentstackCollection>} Promise for ContentstackCollection instance.
      * @example
      * import * as contentstack from '@contentstack/management'
      * const client = contentstack.client()

lib/query/index.js

@@ -19,7 +19,8 @@ export default function Query (http, urlPath, param, stackHeaders = null, wrappe
   }
   /**
    * @description This method will fetch content of query on specified module.
-   * @returns {ContentstackCollection} Result collection of content of specified module.
+   * @async
+   * @returns {Promise<ContentstackCollection>} Promise for ContentstackCollection instance.
    * @example All Stack
    * import * as contentstack from '@contentstack/management'
    * const client = contentstack.client()
@@ -52,7 +53,8 @@ export default function Query (http, urlPath, param, stackHeaders = null, wrappe
   }
   /**
    * @description This method will fetch count of content for query on specified module.
-   * @returns {Object} Result is Object of content of specified module.
+   * @async
+   * @returns {Promise<Object>} Promise for count result.
    * @example All Stack
    * import * as contentstack from '@contentstack/management'
    * const client = contentstack.client()
@@ -86,7 +88,8 @@ export default function Query (http, urlPath, param, stackHeaders = null, wrappe
   }
   /**
    * @description This method will fetch content of query on specified module.
-   * @returns {ContentstackCollection} Result content of specified module.
+   * @async
+   * @returns {Promise<ContentstackCollection>} Promise for ContentstackCollection instance.
    * @example Stack
    * import * as contentstack from '@contentstack/management'
    * const client = contentstack.client()

lib/stack/asset/folders/index.js

@@ -25,7 +25,7 @@ export function Folder (http, data = {}) {
      * @description The Update Folder call lets you update the name and description of an existing Folder.
      * @memberof Folder
      * @func update
-     * @returns {Promise<Folder.Folder>} Promise for Folder instance
+     * @returns {Promise<Folder>} Promise for Folder instance
      * @example
      * import * as contentstack from '@contentstack/management'
      * const client = contentstack.client()
@@ -41,10 +41,10 @@ export function Folder (http, data = {}) {
     this.update = update(http, 'asset')
 
     /**
-     * @description The Delete folder call will delete an existing folder from the stack.
+     * @description The Delete folder call deletes an existing folder from the stack.
      * @memberof Folder
      * @func delete
-     * @returns {Object} Response Object.
+     * @returns {Promise<Object>} Response Object.
      * @example
      * import * as contentstack from '@contentstack/management'
      * const client = contentstack.client()
@@ -55,10 +55,10 @@ export function Folder (http, data = {}) {
     this.delete = deleteEntity(http)
 
     /**
-     * @description The fetch an asset call returns comprehensive information about a specific version of an asset of a stack.
+     * @description The fetch folder call returns comprehensive information about a specific folder.
      * @memberof Folder
      * @func fetch
-     * @returns {Promise<Folder.Folder>} Promise for Folder instance
+     * @returns {Promise<Folder>} Promise for Folder instance
      * @example
      * import * as contentstack from '@contentstack/management'
      * const client = contentstack.client()
@@ -70,15 +70,15 @@ export function Folder (http, data = {}) {
     this.fetch = fetch(http, 'asset')
   } else {
     /**
-     * @description The Create a folder into the assets.
+     * @description The Create a folder call creates a new folder in the assets.
      * @memberof Folder
      * @func create
-     * @returns {Promise<Folder.Folder>} Promise for Folder instance
+     * @returns {Promise<Folder>} Promise for Folder instance
      *
      * @example
      * import * as contentstack from '@contentstack/management'
      * const client = contentstack.client()
-     * const asset = {name: 'My New contentType'}
+     * const asset = {name: 'My New Folder'}
      * client.stack().asset().folder().create({ asset })
      * .then((folder) => console.log(folder))
      */

lib/stack/asset/index.js

@@ -31,7 +31,7 @@ export function Asset (http, data = {}) {
      * @description The Update Asset call lets you update the name and description of an existing Asset.
      * @memberof Asset
      * @func update
-     * @returns {Promise<Asset.Asset>} Promise for Asset instance
+     * @returns {Promise<Asset>} Promise for Asset instance
      * @example
      * import * as contentstack from '@contentstack/management'
      * const client = contentstack.client()
@@ -48,10 +48,10 @@ export function Asset (http, data = {}) {
     this.update = update(http, 'asset')
 
     /**
-     * @description The Delete asset call will delete an existing asset from the stack.
+     * @description The Delete asset call deletes an existing asset from the stack.
      * @memberof Asset
      * @func delete
-     * @returns {Object} Response Object.
+     * @returns {Promise<Object>} Response Object.
      * @example
      * import * as contentstack from '@contentstack/management'
      * const client = contentstack.client()
@@ -65,7 +65,7 @@ export function Asset (http, data = {}) {
      * @description The fetch an asset call returns comprehensive information about a specific version of an asset of a stack.
      * @memberof Asset
      * @func fetch
-     * @returns {Promise<Asset.Asset>} Promise for Asset instance
+     * @returns {Promise<Asset>} Promise for Asset instance
      * @example
      * import * as contentstack from '@contentstack/management'
      * const client = contentstack.client()
@@ -80,7 +80,8 @@ export function Asset (http, data = {}) {
      * @description The Replace asset call will replace an existing asset with another file on the stack.
      * @memberof Asset
      * @func replace
-     * @returns {Promise<Asset.Asset>} Promise for Asset instance
+     * @async
+     * @returns {Promise<Asset>} Promise for Asset instance
      * @example
      * import * as contentstack from '@contentstack/management'
      * const client = contentstack.client()
@@ -130,7 +131,7 @@ export function Asset (http, data = {}) {
     this.publish = publish(http, 'asset')
 
     /**
-     * @description The Replace asset call will replace an existing asset with another file on the stack.
+     * @description The Unpublish an asset call is used to unpublish a specific version of an asset from the desired environment either immediately or at a later date/time.
      * @memberof Asset
      * @func unpublish
      * @returns {Promise<Object>} Response Object.
@@ -156,8 +157,9 @@ export function Asset (http, data = {}) {
     /**
      * @description The References function will get all the references for the asset.
      * @memberof Asset
-     * @func references
-     * @returns {Promise<Array>} Array of references.
+     * @func getReferences
+     * @async
+     * @returns {Promise<Object>} Promise for references data.
      * @param {Object} param - Query parameters
      * @example
      * client.stack({ api_key: 'api_key'}).asset('uid').getReferences({ include_publish_details: true })
@@ -183,10 +185,10 @@ export function Asset (http, data = {}) {
     }
   } else {
     /**
-     *  @description The Folder allows to fetch and create folders in assets.
+     *  @description The Folder method allows you to fetch and create folders in assets.
      * @memberof Asset
      * @func folder
-     * @returns {Promise<Folder.Folder>} Promise for Entry instance
+     * @returns {Folder} Instance of Folder.
      *
      * @example
      * import * as contentstack from '@contentstack/management'
@@ -207,7 +209,8 @@ export function Asset (http, data = {}) {
      * @description The Create an asset call creates a new asset.
      * @memberof Asset
      * @func create
-     * @returns {Promise<Asset.Asset>} Promise for Asset instance
+     * @async
+     * @returns {Promise<Asset>} Promise for Asset instance
      *
      * @example
      * import * as contentstack from '@contentstack/management'
@@ -235,12 +238,12 @@ export function Asset (http, data = {}) {
       }
     }
     /**
-     * @description The Query on Asset will allow to fetch details of all or specific Asset.
+     * @description The Query on Asset will allow you to fetch details of all or specific Assets.
      * @memberof Asset
      * @param {Object} params - URI parameters
      * @prop {Object} params.query - Queries that you can use to fetch filtered results.
      * @func query
-     * @returns {Array<Asset>} Array of Asset.
+     * @returns {Object} Query builder object with find(), count(), and findOne() methods.
      *
      * @example
      * import * as contentstack from '@contentstack/management'
@@ -255,7 +258,8 @@ export function Asset (http, data = {}) {
    * @description The Download function will get downloadable file in specified format.
    * @memberof Asset
    * @func download
-   * @returns {Array<AssetResponse>} Array of Asset.
+   * @async
+   * @returns {Promise<Object>} Promise for download response.
    * @param {*} param.url The url for the asset to download
    * @param {*} param.responseType Optional parameter to specify the response type.
    * @example