Logout functionality added

Author: uttamukkoji

lib/contentstackClient.js

@@ -10,7 +10,7 @@ import error from './core/contentstackError'
 export default function contentstackClient ({ http }) {
   /**
    * @description The Log in to your account request is used to sign in to your Contentstack account and obtain the authtoken.
-   * @memberof ContentstackClientAPI
+   * @memberof ContentstackClient
    * @func login
    * @param {Object} parameters - login parameters
    * @prop {string} paramters.email - email id for user to login
@@ -39,7 +39,7 @@ export default function contentstackClient ({ http }) {
   /**
    * @description The Get user call returns comprehensive information of an existing user account.
    * The information returned includes details of the stacks owned by and shared with the specified user account.
-   * @memberof ContentstackClientAPI
+   * @memberof ContentstackClient
    * @func getUser
    * @returns {Promise}
    * @example
@@ -58,7 +58,7 @@ export default function contentstackClient ({ http }) {
   }
   /**
    * @description Get Stack instance. A stack is a space that stores the content of a project.
-   * @memberof ContentstackClientAPI
+   * @memberof ContentstackClient
    * @func stack
    * @param {String} api_key - Stack API Key
    * @returns {Stack} Instance of Stack
@@ -97,8 +97,8 @@ export default function contentstackClient ({ http }) {
   }
 
   /**
-   * @description Get Stack instance. A stack is a space that stores the content of a project.
-   * @memberof ContentstackClientAPI
+   * @description Organization is the top-level entity in the hierarchy of Contentstack, consisting of stacks and stack resources, and users.
+   * @memberof ContentstackClient
    * @func organization
    * @param {String} uid - Organization UID.
    * @returns {Organization} Instance of Organization.
@@ -122,8 +122,35 @@ export default function contentstackClient ({ http }) {
     return new Organization(http, uid !== null ? { organization: { uid: uid } } : null)
   }
 
+  /**
+   * @description The Log out of your account call is used to sign out the user of Contentstack account.
+   * @memberof ContentstackClient
+   * @func organization
+   * @param {String} uid - Organization UID.
+   * @returns {String} Success message.
+   *
+   * @example
+   * import * as contentstack from 'contentstack'
+   * const client = contentstack.client({})
+   * const notice = client.logout()
+   *
+   */
+  function logout () {
+    return http.delete('/user-session')
+      .then((response) => {
+        if (http.defaults.headers.common) {
+          delete http.defaults.headers.common.authtoken
+        }
+        delete http.defaults.headers.authtoken
+        delete http.httpClientParams.authtoken
+        delete http.httpClientParams.headers.authtoken
+        return response.data
+      }, error)
+  }
+
   return {
     login: login,
+    logout: logout,
     getUser: getUser,
     stack: stack,
     organization: organization