Response message change from string to object

Author: uttamukkoji

README.md

@@ -29,7 +29,7 @@ contentstackClient = contentstack.client(axios, {})
 ```
 
 ### Authentication
-To use this SDK you need to authenticate using the user Authtoken, creadentials, or Management Token (stack-level token).
+To use this SDK you need to authenticate using the user Authtoken, credentials, or Management Token (stack-level token).
 ### Authtoken
 An **Authtoken** is a read-write token used to make authorized CMA requests, and it is a **user-specific** token.
 ```
@@ -40,7 +40,7 @@ contentstackClient = contentstack.client(axios, { authtoken: 'AUTHTOKEN' })
 To Login to Contentstack using credentials:
 ```
 contentstackClient.login({ email: 'EMAIL', password: 'PASSWORD'})
-..then((response) => {
+.then((response) => {
 	console.log(response.notice)
 	console.log(response.user)
 })
@@ -92,7 +92,7 @@ The following code snippet is use to create Asset into Stack using this SDK:
 ```
 var  asset  = {
 	upload: 'path/to/file',
-	tit;e: 'Asset Title'
+	title: 'Asset Title'
 }
 
 contentstackClient.stack('API_KEY').asset().create({ asset })

lib/contentstackClient.js

@@ -1,5 +1,5 @@
 /**
- * @namespace ContentstackClientAPI
+ * @namespace ContentstackClient
  */
 import { Stack } from './stack/index.js'
 import { Organization } from './organization/index'
@@ -125,17 +125,27 @@ export default function contentstackClient ({ http }) {
   /**
    * @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.
+    * @param {String} authtoken - Authtoken to logout from.
+   * @func logout
+   * @returns {Object} Response object.
    *
    * @example
    * import * as contentstack from 'contentstack'
    * const client = contentstack.client({})
    * const notice = client.logout()
    *
    */
-  function logout () {
+  function logout (authtoken) {
+    if (authtoken !== undefined) {
+      return http.delete('/user-session', {
+        headers: {
+          authtoken: authtoken
+        }
+      })
+        .then((response) => {
+          return response.data
+        }, error)
+    }
     return http.delete('/user-session')
       .then((response) => {
         if (http.defaults.headers.common) {

lib/entity.js

@@ -43,7 +43,7 @@ export const publishUnpublish = async (http, url, httpBody, headers, locale = nu
   try {
     const response = await http.post(url, httpBody, headers)
     if (response.data) {
-      return response.data.notice
+      return response.data
     } else {
       throw error(response)
     }
@@ -160,7 +160,7 @@ export const deleteEntity = (http) => {
 
       const response = await http.delete(this.urlPath, headers)
       if (response.data) {
-        return response.data.notice
+        return response.data
       } else {
         throw error(response)
       }

lib/organization/index.js

@@ -70,7 +70,7 @@ export function Organization (http, data) {
        * @memberof Organization
        * @func transferOwnership
        * @param {String} email The email address of the user to whom you wish to transfer the ownership of the organization.
-       * @returns {String} Success message of transfer ownership.
+       * @returns {Object} Response Object.
        * @example
        * import * as contentstack from 'contentstack'
        * const client = contentstack.client({})
@@ -83,7 +83,7 @@ export function Organization (http, data) {
         try {
           const response = await http.post(`${this.urlPath}/transfer_ownership`, { transfer_to: email })
           if (response.data) {
-            return response.data.notice
+            return response.data
           } else {
             return error(response)
           }
@@ -121,13 +121,13 @@ export function Organization (http, data) {
       /**
        * @description The Get all organization invitations call gives you a list of all the Organization invitations.
        * @memberof Organization
-       * @func resendInvitition
+       * @func getInvitations
        * @returns {String} Success message of invitation send.
        * @example
        * import * as contentstack from 'contentstack'
        * const client = contentstack.client({})
        *
-       * client.organization('organization_uid).resendInvitition('invitition_uid')
+       * client.organization('organization_uid).getInvitations()
        * .then((notice) => console.log(notice))
        *
        */
@@ -148,7 +148,7 @@ export function Organization (http, data) {
        * @description The Resend pending organization invitation call allows you to resend Organization invitations to users who have not yet accepted the earlier invitation.
        * @memberof Organization
        * @func resendInvitition
-       * @returns {String} Success message of invitation send.
+       * @returns {Object} Response Object.
        * @example
        * import * as contentstack from 'contentstack'
        * const client = contentstack.client({})
@@ -161,7 +161,7 @@ export function Organization (http, data) {
         try {
           const response = await http.get(`${this.urlPath}/${invitationUid}/resend_invitation`)
           if (response.data) {
-            return response.data.notice
+            return response.data
           } else {
             return error(response)
           }

lib/stack/asset/index.js

@@ -51,7 +51,7 @@ export function Asset (http, data = {}) {
      * @description The Delete asset call will delete an existing asset from the stack.
      * @memberof Asset
      * @func delete
-     * @returns {String} Success message.
+     * @returns {Object} Response Object.
      * @example
      * import * as contentstack from 'contentstack'
      * const client = contentstack.client({})
@@ -109,7 +109,7 @@ export function Asset (http, data = {}) {
      * @description The Publish an asset call is used to publish a specific version of an asset on the desired environment either immediately or at a later date/time.
      * @memberof Asset
      * @func publish
-     * @returns {Promise<String>} Notice for success message.
+     * @returns {Promise<Object>} Response Object.
      * @example
      * import * as contentstack from 'contentstack'
      * const client = contentstack.client({})
@@ -133,7 +133,7 @@ export function Asset (http, data = {}) {
      * @description The Replace asset call will replace an existing asset with another file on the stack.
      * @memberof Asset
      * @func unpublish
-     * @returns {Promise<String>} Notice for success message.
+     * @returns {Promise<Object>} Response Object.
      * @example
      * import * as contentstack from 'contentstack'
      * const client = contentstack.client({})

lib/stack/bulkOperation/index.js

@@ -12,7 +12,7 @@ export function BulkOperation (http, data = {}) {
    * The Publish entries and assets in bulk request allows you to publish multiple entries and assets at the same time.
    * @memberof BulkOperation
    * @func publish
-   * @returns {Promise<String>} Success message
+   * @returns {Promise<Object>} Response Object.
    * @param {Boolean} params.details - Set this with details containing 'entries', 'assets', 'locales', and 'environments' to which you want to publish the entries or assets.
    * @param {Boolean} params.skip_workflow_stage_check Set this to 'true' to publish the entries that are at a workflow stage where they satisfy the applied publish rules.
    * @param {Boolean} params.approvals Set this to 'true' to publish the entries that do not require an approval to be published.
@@ -66,7 +66,7 @@ export function BulkOperation (http, data = {}) {
    * The Unpublish entries and assets in bulk request allows you to unpublish multiple entries and assets at the same time.
    * @memberof BulkOperation
    * @func unpublish
-   * @returns {Promise<String>} Success message
+   * @returns {Promise<Object>} Response Object.
    * @param {Boolean} params.details - Set this with details containing 'entries', 'assets', 'locales', and 'environments' to which you want to unpublish the entries or assets. If you do not specify a source locale, the entries or assets will be unpublished in the master locale automatically.
    * @param {Boolean} params.skip_workflow_stage_check Set this to 'true' to publish the entries that are at a workflow stage where they satisfy the applied publish rules.
    * @param {Boolean} params.approvals Set this to 'true' to publish the entries that do not require an approval to be published.

lib/stack/contentType/index.js

@@ -44,7 +44,7 @@ export function ContentType (http, data = {}) {
      * @description The Delete ContentType call is used to delete an existing ContentType permanently from your Stack.
      * @memberof ContentType
      * @func delete
-     * @returns {String} Success message.
+     * @returns {Object} Response Object.
      * @example
      * import * as contentstack from 'contentstack'
      * const client = contentstack.client({})

lib/stack/deliveryToken/index.js

@@ -33,7 +33,7 @@ export function DeliveryToken (http, data = {}) {
      * @description The Delete DeliveryToken call is used to delete an existing DeliveryToken permanently from your Stack.
      * @memberof DeliveryToken
      * @func delete
-     * @returns {String} Success message.
+     * @returns {Object} Response Object.
      * @example
      * import * as contentstack from 'contentstack'
      * const client = contentstack.client({})

lib/stack/environment/index.js

@@ -31,7 +31,7 @@ export function Environment (http, data = {}) {
        * @description The Delete Environment call is used to delete an existing Environment permanently from your Stack.
        * @memberof Environment
        * @func delete
-       * @returns {String} Success message.
+       * @returns {Object} Response Object.
        * @example
        * import * as contentstack from 'contentstack'
        * const client = contentstack.client({})

lib/stack/extension/index.js

@@ -37,7 +37,7 @@ export function Extension (http, data) {
      * @description The Delete Extension call is used to delete an existing Extension permanently from your Stack.
      * @memberof Extension
      * @func delete
-     * @returns {String} Success message.
+     * @returns {Object} Response Object.
      * @example
      * import * as contentstack from 'contentstack'
      * const client = contentstack.client({})