Docs update

Author: uttamukkoji

lib/contentstackCollection.js

@@ -1,3 +1,6 @@
+/**
+ * @namespace ContentstackCollection
+ */
 export default class ContentstackCollection {
   constructor (response, http, stackHeaders = null, wrapperCollection) {
     const data = response.data || {}

lib/stack/deliveryToken/index.js

@@ -1,8 +1,10 @@
 import cloneDeep from 'lodash/cloneDeep'
 import { create, update, deleteEntity, fetch, query } from '../../entity'
-// import ContentstackCollection from '../../contentstackCollection'
-// import error from '../../core/contentstackError'
 
+/**
+ * Delivery tokens provide read-only access to the associated environments. Read more about <a href='https://www.contentstack.com/docs/developers/create-tokens/about-delivery-tokens'>DeliveryToken</a>.
+ * @namespace DeliveryToken
+ */
 export function DeliveryToken (http, data = {}) {
   this.stackHeaders = data.stackHeaders
   this.urlPath = `/stacks/delivery_tokens`

lib/stack/environment/index.js

@@ -1,6 +1,11 @@
 import cloneDeep from 'lodash/cloneDeep'
 import { create, update, deleteEntity, fetch, query } from '../../entity'
 
+/**
+ * A publishing environment corresponds to one or more deployment servers or a content delivery destination where the entries need to be published. Read more about <a href='https://www.contentstack.com/docs/developers/set-up-environments'>Environment</a>.
+ * @namespace Environment
+ *  */
+
 export function Environment (http, data = {}) {
   this.stackHeaders = data.stackHeaders
   this.urlPath = `/environments`

lib/stack/index.js

@@ -73,7 +73,7 @@ export function Stack (http, data) {
     /**
      * @description Content type defines the structure or schema of a page or a section of your web or mobile property.
      * @param {String} uid The UID of the ContentType you want to get details.
-     * @returns {ContenType} Instace of ContentType.
+     * @returns {ContentType} Instance of ContentType.
      * @example
      * import * as contentstack from '@contentstack/management'
      * const client = contentstack.client()
@@ -95,7 +95,7 @@ export function Stack (http, data) {
     /**
      * @description Locale allows you to create and publish entries in any language.
      * @param {String} uid The UID of the Locale you want to get details.
-     * @returns {Locale} Instace of Locale.
+     * @returns {Locale} Instance of Locale.
      * @example
      * import * as contentstack from '@contentstack/management'
      * const client = contentstack.client()
@@ -117,7 +117,7 @@ export function Stack (http, data) {
     /**
      * @description Assets refer to all the media files (images, videos, PDFs, audio files, and so on) uploaded in your Contentstack repository for future use.
      * @param {String} uid The UID of the Asset you want to get details.
-     * @returns {Asset} Instace of Asset.
+     * @returns {Asset} Instance of Asset.
      * @example
      * import * as contentstack from '@contentstack/management'
      * const client = contentstack.client()
@@ -138,7 +138,7 @@ export function Stack (http, data) {
     /**
      * @description Global field defines the structure or schema of a page or a section of your web or mobile property.
      * @param {String} uid The UID of the Global field you want to get details.
-     * @returns {ContenType} Instace of Global field.
+     * @returns {GlobalField} Instance of Global field.
      * @example
      * import * as contentstack from '@contentstack/management'
      * const client = contentstack.client()
@@ -160,16 +160,16 @@ export function Stack (http, data) {
     /**
      * @description Environment corresponds to one or more deployment servers or a content delivery destination where the entries need to be published.
      * @param {String} uid The UID of the Environment you want to get details.
-     * @returns {Environment} Instace of Environment.
+     * @returns {Environment} Instance of Environment.
      * @example
      * import * as contentstack from '@contentstack/management'
      * const client = contentstack.client()
      *
-     * client.stack({ api_key: 'api_key'}).globalField().create()
-     * .then((globalField) => console.log(globalField))
+     * client.stack({ api_key: 'api_key'}).environment().create()
+     * .then((environment) => console.log(environment))
      *
-     * client.stack({ api_key: 'api_key'}).globalField('globalField_uid').fetch()
-     * .then((globalField) => console.log(globalField))
+     * client.stack({ api_key: 'api_key'}).environment('environment_uid').fetch()
+     * .then((environment) => console.log(environment))
      */
     this.environment = (environmentUid = null) => {
       const data = { stackHeaders: this.stackHeaders }
@@ -181,7 +181,7 @@ export function Stack (http, data) {
     /**
      * @description Delivery Tokens provide read-only access to the associated environments.
      * @param {String} deliveryTokenUid The UID of the Delivery Token field you want to get details.
-     * @returns {DeliveryToken} Instace of DeliveryToken.
+     * @returns {DeliveryToken} Instance of DeliveryToken.
      * @example
      * import * as contentstack from '@contentstack/management'
      * const client = contentstack.client()
@@ -203,7 +203,7 @@ export function Stack (http, data) {
     /**
      * @description Extensions let you create custom fields and custom widgets that lets you customize Contentstack's default UI and behavior.
      * @param {String} extensionUid The UID of the Extension you want to get details.
-     * @returns {Extension} Instace of Extension.
+     * @returns {Extension} Instance of Extension.
      * @example
      * import * as contentstack from '@contentstack/management'
      * const client = contentstack.client()
@@ -226,7 +226,7 @@ export function Stack (http, data) {
     /**
      * @description  Workflow is a tool that allows you to streamline the process of content creation and publishing, and lets you manage the content lifecycle of your project smoothly.
      * @param {String} workflowUid The UID of the Workflow you want to get details.
-     * @returns {Workflow} Instace of Workflow.
+     * @returns {Workflow} Instance of Workflow.
      * @example
      * import * as contentstack from '@contentstack/management'
      * const client = contentstack.client()
@@ -248,7 +248,7 @@ export function Stack (http, data) {
     /**
      * @description  Webhooks allow you to specify a URL to which you would like Contentstack to post data when an event happens.
      * @param {String} webhookUid The UID of the Webhook you want to get details.
-     * @returns {Webhook} Instace of Webhook.
+     * @returns {Webhook} Instance of Webhook.
      * @example
      * import * as contentstack from '@contentstack/management'
      * const client = contentstack.client()
@@ -270,7 +270,7 @@ export function Stack (http, data) {
     /**
      * @description Labels allow you to group a collection of content within a stack. Using labels you can group content types that need to work together
      * @param {String} uid The UID of the Label you want to get details.
-     * @returns {Label} Instace of Label.
+     * @returns {Label} Instance of Label.
      * @example
      * import * as contentstack from '@contentstack/management'
      * const client = contentstack.client()