Merge pull request #10 from contentstack/doc-Hotfix3.5.1

Folder rename

Author: rohitmishra209

LICENSE.txt

@@ -1,6 +1,6 @@
 {
     "opts": {
-        "template": "csio-templates",
+        "template": "contentstack-templates",
         "encoding": "utf8",
         "destination": "./js-sdk-reference/",
         "recurse": true
@@ -19,6 +19,7 @@
         ]
     },
     "tags": {
-        "dictionaries": ["jsdoc", "closure"]
+        "dictionaries": ["jsdoc", "closure"],
+        "allowUnknownTags": true
     }
 }

config.js

@@ -24,7 +24,7 @@ class ContentstackDemo {
      */
     getEntries(contentTypeUid) {
         contentTypeUid = contentTypeUid || 'source'
-        return this.Stack.ContentType(contentTypeUid).Query().toJSON().find()
+        return this.Stack.ContentType(contentTypeUid).Query().includeReference('secondary_section.reference.reference').find()
     }
 
 
@@ -38,7 +38,7 @@ class ContentstackDemo {
     getEntry(contentTypeUid, entryUid) {
             contentTypeUid = contentTypeUid || 'source'
             entryUid = entryUid || 'blt123something'
-            return this.Stack.ContentType(contentTypeUid).Entry(entryUid).fetch()
+            return this.Stack.ContentType(contentTypeUid).Entry(entryUid).language('ja-jp').fetch()
         }
 
         /**

csio-templates/LICENSE renamed to contentstack-templates/LICENSE

@@ -1,16 +1,19 @@
 import Stack from "./stack";
 import CacheProvider from './cache-provider/index';
 
-/**
- * @method Contentstack
- * @description Creates an instance of `Contentstack`.
- * @api public
- */
+
+ /**
+ * @class 
+  Contentstack 
+* @description Creates an instance of `Contentstack`.
+* @instance
+*/
+
 class Contentstack {
 
 	constructor(){
 		/**
-		 * @constant CachePolicy
+		 * @memberOf Contentstack
 		 * @description CachePolicy contains different cache policies constants.
 		 * @example
 		 * Contentstack.CachePolicy.IGNORE_CACHE
@@ -21,22 +24,10 @@ class Contentstack {
 		 */
 		this.CachePolicy = CacheProvider.policies;
 	}
+/**
 
-	/**
-	 * @method Stack
-	 * @description Initialize an instance of ‘Stack’
-	 * @api public
-	 * @example
-	 *var Stack = Contentstack.Stack('api_key', 'delivery_token', 'environment');
-                 OR
-	 *var Stack = Contentstack.Stack({
-	 *    'api_key':'stack_api_key',
-	 *   'access_token':'stack_delivery_token',
-	 *    'environment':'environment_name'
-	 * });
-	 *
-	 * @returns {Stack}
-	 */
+* @memberOf Contentstack
+*/
 	Stack(...stack_arguments){
 		return new Stack(...stack_arguments);
 	}

csio-templates/README.md renamed to contentstack-templates/README.md

@@ -3,28 +3,64 @@ import Stack from '../stack';
 import Query from './query';
 
 /**
- * @summary Creates an instance of 'Assets'.
- * @description An initializer is responsible for creating Asset object.
- * @param {String} uid - uid of the asset
- * @example
- * let Assets = Contentstack.Stack().Assets('bltsomething123');
- * @returns {Assets}
- * @ignore
- */
+ * @class 
+  Assets  
+* @summary Creates an instance of `Assets`.
+* @description Retrieves the asset based on the specified UID
+* @param {String} uid - uid of asset you want to retrieve
+* @example 
+* let data = Stack.Assets('bltsomething123').toJSON().fetch()
+*      data
+*      .then(function(result) {
+*           // ‘result’ is a single asset object of specified uid       
+*      }, function(error) {
+*           // error function
+*      })
+* @returns {Assets}
+* @instance
+*/
+
 export default class Assets {
     constructor() {
         this._query = {};        
         this.only = Utils.transform('only');
         return this;
     }
 
-    
+ /**
+   * Converts your response into plain JavasScript object
+   * @memberOf Assets
+   * @example var Query = Stack.ContentType('blog').Query()
+    Query   
+         .toJSON()
+         .find()
+         .then(function (result) {
+             // 'result' is an object which content the data in json object form
+          },function (error) {
+             // error function
+     })
+   * @returns {Assets}
+   * @instance
+   */
+  
     toJSON() {
         this.tojson = true;
         return this;
     }
 
-
+/**
+   * Includes query parameters in your queries.
+   * @memberOf Assets
+   * @example var data = Stack.Assets(assetUid).addParam('include_dimension', 'true').toJSON().fetch()
+     *      data.then(function (result) {
+     *          // 'result' is an object which content the data including count in json object form
+     *       },function (error) {
+     *          // error function
+     *      })
+     * @returns {Assets}
+     * @instance
+   */
+  
     addParam(key, value) {
         if (key && typeof key === 'string' && value && typeof value === 'string') {        
             this._query[key] = value;
@@ -34,7 +70,15 @@ export default class Assets {
         }
     }
 
-   
+
+/**
+   * Fetches a particular asset based on the provided asset UID.
+   * @memberOf Assets
+   * @example
+   * Stack.Assets('assets_uid').toJSON().fetch()
+   * @returns {promise}
+   * @instance
+   */
 
     fetch() {
         if (this.asset_uid) {
@@ -47,7 +91,6 @@ export default class Assets {
                     query: this._query
                 }
             }
-
             return Utils.sendRequest(this);
         } else {
             console.error("Kindly provide an asset uid. e.g. .Assets('bltsomething123')");