Package name and create function sample update

Author: uttamukkoji

CHANGELOG.md

@@ -0,0 +1,4 @@
+# Changelog
+
+## [v1.0.0](https://github.com/contentstack/contentstack-management-javascript/tree/v1.0.0) (2020-07-11)
+ - Initial release for Contentstack CMA base JS management SDK

README.md

@@ -16,11 +16,11 @@ You need Node.js version 10 or above installed on your machine to use the Conten
 #### Node
 Install it via npm:
 ```bash
-npm i contentstack-management
+npm i @contentstack/management
 ```
 To import the SDK, use the following command:
 ```
-import contentstack from ‘@contentstack/contentstack-management’
+import contentstack from ‘@contentstack/management’
 ```
 To initialize the SDK, you will need to pass ```axios``` instance as follows:
 ```
@@ -59,7 +59,7 @@ contentstackClient.stack('API_KEY', 'MANAGEMENT_TOKEN')
 #### Initializing Your SDK:
 To use the JavaScript CMA SDK, you need to first initialize it. To do this, use the following code:
 ```
-import contentstack from ‘@contentstack/contentstack-management’
+import contentstack from ‘@contentstack/management’
 import axios from 'axios'
 
 var contentstackClient = contentstack.client(axios, { authtoken: 'AUTHTOKEN' })

lib/contentstack.js

@@ -23,7 +23,7 @@ import packages from '../package.json'
  * @prop {string} params.integration - Integration name and version e.g react/version
  * @returns Contentstack.Client
  * @example
- * import * as contentstack from 'contentstack'
+ * import * as contentstack from '@contentstack/management'
  * const client = contentstack.client({
  *
  * })

lib/contentstackClient.js

@@ -18,7 +18,7 @@ export default function contentstackClient ({ http }) {
    * @prop {string} paramters.token - token for user to login
    * @returns {Promise}
    * @example
-   * import * as contentstack from 'contentstack'
+   * import * as contentstack from '@contentstack/management'
    * const client = contentstack.client({})
    *
    * client.login({ email: <emailid>, password: <password> })
@@ -43,7 +43,7 @@ export default function contentstackClient ({ http }) {
    * @func getUser
    * @returns {Promise}
    * @example
-   * import * as contentstack from 'contentstack'
+   * import * as contentstack from '@contentstack/management'
    * const client = contentstack.client({})
    *
    * client.getUser()
@@ -64,34 +64,34 @@ export default function contentstackClient ({ http }) {
    * @returns {Stack} Instance of Stack
    *
    * @example
-   * import * as contentstack from 'contentstack'
+   * import * as contentstack from '@contentstack/management'
    * const client = contentstack.client({})
-   *
-   * client.stack().create({name: 'My New Stack'}, { organization_uid: 'org_uid' })
+   * const stack = {name: 'My New Stack'}
+   * client.stack().create({ stack }, { organization_uid: 'org_uid' })
    * .then((stack) => console.log(stack))
    *
    * @example
-   * import * as contentstack from 'contentstack'
+   * import * as contentstack from '@contentstack/management'
    * const client = contentstack.client({})
    *
    * client.stack('api_key').fetch()
    * .then((stack) => console.log(stack))
    *
    * @example
-   * import * as contentstack from 'contentstack'
+   * import * as contentstack from '@contentstack/management'
    * const client = contentstack.client({})
    *
    * client.stack('api_key', 'management_token').fetch()
    * .then((stack) => console.log(stack))
    *
    */
-  function stack (apiKey = null, managmentToken = null) {
+  function stack (apiKey = null, managementToken = null) {
     var stack = {}
     if (apiKey && apiKey !== undefined) {
       stack.api_key = apiKey
     }
-    if (managmentToken && managmentToken !== undefined) {
-      stack.authorization = managmentToken
+    if (managementToken && managementToken !== undefined) {
+      stack.authorization = managementToken
     }
     return new Stack(http, { stack })
   }
@@ -104,14 +104,14 @@ export default function contentstackClient ({ http }) {
    * @returns {Organization} Instance of Organization.
    *
    * @example
-   * import * as contentstack from 'contentstack'
+   * import * as contentstack from '@contentstack/management'
    * const client = contentstack.client({})
    *
    * client.organization().query().find()
    * .then((organization) => console.log(organization))
    *
    * @example
-   * import * as contentstack from 'contentstack'
+   * import * as contentstack from '@contentstack/management'
    * const client = contentstack.client({})
    *
    * client.organization('org_uid').fetch()
@@ -130,7 +130,7 @@ export default function contentstackClient ({ http }) {
    * @returns {Object} Response object.
    *
    * @example
-   * import * as contentstack from 'contentstack'
+   * import * as contentstack from '@contentstack/management'
    * const client = contentstack.client({})
    * const notice = client.logout()
    *

lib/organization/index.js

@@ -23,7 +23,7 @@ export function Organization (http, data) {
      * @param {Int} include_plan The include_plan parameter includes the details of the plan that the organization has subscribed to.
      * @returns {Promise<Organization.Organization>} Promise for Organization instance
      * @example
-     * import * as contentstack from 'contentstack'
+     * import * as contentstack from '@contentstack/management'
      * const client = contentstack.client({})
      *
      * client.organization('organization_uid).fetch()
@@ -45,7 +45,7 @@ export function Organization (http, data) {
        * @param {String} typeahead The type head contains value to be included in search.
        * @returns {ContentstackCollection} Instance of ContentstackCollection.
        * @example
-       * import * as contentstack from 'contentstack'
+       * import * as contentstack from '@contentstack/management'
        * const client = contentstack.client({})
        *
        * client.organization('organization_uid).stacks({ include_count: true })
@@ -72,7 +72,7 @@ export function Organization (http, data) {
        * @param {String} email The email address of the user to whom you wish to transfer the ownership of the organization.
        * @returns {Object} Response Object.
        * @example
-       * import * as contentstack from 'contentstack'
+       * import * as contentstack from '@contentstack/management'
        * const client = contentstack.client({})
        *
        * client.stack('api_key').transferOwnership('emailId')
@@ -98,7 +98,7 @@ export function Organization (http, data) {
        * @func addUser
        * @returns {ContentstackCollection} ContentstackCollection of instance.
        * @example
-       * import * as contentstack from 'contentstack'
+       * import * as contentstack from '@contentstack/management'
        * const client = contentstack.client({})
        *
        * client.organization('organization_uid).addUser({ users: { 'abc@test.com': ['org_uid1', 'org_uid2' ]}, stacks: { 'abc@test.com': { 'api_key1': [ 'stack_role_id' ] } } })
@@ -124,7 +124,7 @@ export function Organization (http, data) {
        * @func getInvitations
        * @returns {String} Success message of invitation send.
        * @example
-       * import * as contentstack from 'contentstack'
+       * import * as contentstack from '@contentstack/management'
        * const client = contentstack.client({})
        *
        * client.organization('organization_uid).getInvitations()
@@ -150,7 +150,7 @@ export function Organization (http, data) {
        * @func resendInvitition
        * @returns {Object} Response Object.
        * @example
-       * import * as contentstack from 'contentstack'
+       * import * as contentstack from '@contentstack/management'
        * const client = contentstack.client({})
        *
        * client.organization('organization_uid).resendInvitition('invitation_uid')
@@ -182,7 +182,7 @@ export function Organization (http, data) {
        * @param {Boolean} include_stack_roles The Include stack roles will return stack details in roles.
        * @returns {Array<Role>} Array of Role instance
        * @example
-       * import * as contentstack from 'contentstack'
+       * import * as contentstack from '@contentstack/management'
        * const client = contentstack.client({})
        *
        * client.organization('organization_uid).roles()
@@ -215,7 +215,7 @@ export function Organization (http, data) {
      * @param {String} typeahead The type head contains value to be included in search.
      * @returns {ContentstackCollection} Result collection of content of specified module.
      * @example
-     * import * as contentstack from 'contentstack'
+     * import * as contentstack from '@contentstack/management'
      * const client = contentstack.client({})
      *
      * client.organization().fetchAll()

lib/query/index.js

@@ -16,14 +16,14 @@ 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.
    * @example All Stack
-   * import * as contentstack from 'contentstack'
+   * import * as contentstack from '@contentstack/management'
    * const client = contentstack.client({})
    *
    * client.stack().query().find()
    * .then((collection) => console.log(collection))
    *
    * @example Query on stack
-   * import * as contentstack from 'contentstack'
+   * import * as contentstack from '@contentstack/management'
    * const client = contentstack.client({})
    *
    * client.stack().query( { query: { name: 'Stack name' } }).find()
@@ -46,14 +46,14 @@ 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.
    * @example All Stack
-   * import * as contentstack from 'contentstack'
+   * import * as contentstack from '@contentstack/management'
    * const client = contentstack.client({})
    *
    * client.stack().query().count()
    * .then((response) => console.log(response))
    *
    * @example Query on Asset
-   * import * as contentstack from 'contentstack'
+   * import * as contentstack from '@contentstack/management'
    * const client = contentstack.client({})
    *
    * client.stack('api_key').query({ query: { title: 'Stack name' } }).count()
@@ -80,14 +80,14 @@ 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.
    * @example Stack
-   * import * as contentstack from 'contentstack'
+   * import * as contentstack from '@contentstack/management'
    * const client = contentstack.client({})
    *
    * client.stack().query().findOne()
    * .then((collection) => console.log(collection))
    *
    * @example Query on stack
-   * import * as contentstack from 'contentstack'
+   * import * as contentstack from '@contentstack/management'
    * const client = contentstack.client({})
    *
    * client.stack().query({ query: { title: 'Stack name' } }).findOne()

lib/stack/asset/folders/index.js

@@ -21,10 +21,10 @@ export function Folder (http, data = {}) {
    * @returns {Promise<Folder.Folder>} Promise for Folder instance
    *
    * @example
-   * import * as contentstack from 'contentstack'
+   * import * as contentstack from '@contentstack/management'
    * const client = contentstack.client({})
-   *
-   * client.stack().asset().folders().create({name: 'My New contentType'})
+   * const asset = {name: 'My New contentType'}
+   * client.stack().asset().folders().create({ asset })
    * .then((folder) => console.log(folder))
    */
     this.create = create({ http: http })

lib/stack/asset/index.js

@@ -33,7 +33,7 @@ export function Asset (http, data = {}) {
      * @func update
      * @returns {Promise<Asset.Asset>} Promise for Asset instance
      * @example
-     * import * as contentstack from 'contentstack'
+     * import * as contentstack from '@contentstack/management'
      * const client = contentstack.client({})
      *
      * client.stack('api_key').asset('uid').fetch()
@@ -53,7 +53,7 @@ export function Asset (http, data = {}) {
      * @func delete
      * @returns {Object} Response Object.
      * @example
-     * import * as contentstack from 'contentstack'
+     * import * as contentstack from '@contentstack/management'
      * const client = contentstack.client({})
      *
      * client.stack('api_key').asset('uid').delete()
@@ -67,7 +67,7 @@ export function Asset (http, data = {}) {
      * @func fetch
      * @returns {Promise<Asset.Asset>} Promise for Asset instance
      * @example
-     * import * as contentstack from 'contentstack'
+     * import * as contentstack from '@contentstack/management'
      * const client = contentstack.client({})
      *
      * client.stack('api_key').asset('uid').fetch()
@@ -82,7 +82,7 @@ export function Asset (http, data = {}) {
      * @func fetch
      * @returns {Promise<Asset.Asset>} Promise for Asset instance
      * @example
-     * import * as contentstack from 'contentstack'
+     * import * as contentstack from '@contentstack/management'
      * const client = contentstack.client({})
      *
      * const asset = {
@@ -111,7 +111,7 @@ export function Asset (http, data = {}) {
      * @func publish
      * @returns {Promise<Object>} Response Object.
      * @example
-     * import * as contentstack from 'contentstack'
+     * import * as contentstack from '@contentstack/management'
      * const client = contentstack.client({})
      *
      * const asset = {
@@ -135,7 +135,7 @@ export function Asset (http, data = {}) {
      * @func unpublish
      * @returns {Promise<Object>} Response Object.
      * @example
-     * import * as contentstack from 'contentstack'
+     * import * as contentstack from '@contentstack/management'
      * const client = contentstack.client({})
      *
      * const asset = {
@@ -160,7 +160,7 @@ export function Asset (http, data = {}) {
    * @returns {Promise<Folder.Folder>} Promise for Entry instance
    *
    * @example
-   * import * as contentstack from 'contentstack'
+   * import * as contentstack from '@contentstack/management'
    * const client = contentstack.client({})
     */
     this.folder = () => {
@@ -175,7 +175,7 @@ export function Asset (http, data = {}) {
      * @returns {Promise<Asset.Asset>} Promise for Asset instance
      *
      * @example
-     * import * as contentstack from 'contentstack'
+     * import * as contentstack from '@contentstack/management'
      * const client = contentstack.client({})
      *
      * const asset = {
@@ -184,7 +184,7 @@ export function Asset (http, data = {}) {
      *  description: 'Desc'
      * }
      *
-     * client.stack('api_key').asset().create(asset)
+     * client.stack('api_key').asset().create({ asset })
      * .then((asset) => console.log(asset))
      */
     this.create = async function (data, params) {
@@ -208,7 +208,7 @@ export function Asset (http, data = {}) {
    * @returns {Array<Asset>} Array of Asset.
    *
    * @example
-   * import * as contentstack from 'contentstack'
+   * import * as contentstack from '@contentstack/management'
    * const client = contentstack.client({})
    *
    * client.stack().asset().query({ query: { filename: 'Asset Name' } }).find()

lib/stack/bulkOperation/index.js

@@ -17,7 +17,7 @@ export function BulkOperation (http, data = {}) {
    * @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.
    * @example
-   * import * as contentstack from 'contentstack'
+   * import * as contentstack from '@contentstack/management'
    * const client = contentstack.client({})
    *
    * const publishDetails = {
@@ -71,7 +71,7 @@ export function BulkOperation (http, data = {}) {
    * @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.
    * @example
-   * import * as contentstack from 'contentstack'
+   * import * as contentstack from '@contentstack/management'
    * const client = contentstack.client({})
    *
    * const publishDetails = {
@@ -123,7 +123,7 @@ export function BulkOperation (http, data = {}) {
    * @returns {Promise<String>} Success message
    * @param {Boolean} params.details - Set this with details specifing the content type UIDs, entry UIDs or asset UIDs, and locales of which the entries or assets you want to delete.
    * @example
-   * import * as contentstack from 'contentstack'
+   * import * as contentstack from '@contentstack/management'
    * const client = contentstack.client({})
    *
    * const publishDetails = {