index.js

import cloneDeep from 'lodash/cloneDeep'
import error from '../core/contentstackError'
import { fetch, fetchAll } from '../entity'
import ContentstackCollection from '../contentstackCollection'
import { RoleCollection } from '../stack/roles'
import { StackCollection } from '../stack'
import { UserCollection } from '../user'
import { Teams } from './teams'
/**
 * Organization is the top-level entity in the hierarchy of Contentstack, consisting of stacks and stack resources, and users. Organization allows easy management of projects as well as users within the Organization. Read more about <a href='https://www.contentstack.com/docs/guide/organization'>Organizations.</a>.
 * @namespace Organization
 */
export function Organization (http, data) {
  this.urlPath = '/organizations'

  if (data && data.organization) {
    Object.assign(this, cloneDeep(data.organization))
    this.urlPath = `/organizations/${this.uid}`

    /**
     * @description The teams call fetches teams details.
     * @memberof Organization
     * @func teams
     * @returns {Teams} Instance of Teams.
     * @example
     * import * as contentstack from '@contentstack/management'
     * const client = contentstack.client()
     *
     * client.organization('organization_uid').teams('teamsUid').fetch()
     * .then((team) => console.log(team))
     *
     */
    this.teams = (teamUid = null) => {
      data.organizationUid = this.uid
      if (teamUid) {
        data.uid = teamUid
      }
      return new Teams(http, data)
    }
    /**
     * @description The fetch Organization call fetches Organization details.
     * @memberof Organization
     * @func fetch
     * @param {Boolean} 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/management'
     * const client = contentstack.client()
     *
     * client.organization('organization_uid').fetch()
     * .then((organization) => console.log(organization))
     *
     */
    this.fetch = fetch(http, 'organization')
    /**
       * @description The Get all stacks in an organization call fetches the list of all stacks in an Organization.
       * @memberof Organization
       * @func stacks
       * @async
       * @param {Object=} param - Query parameters.
       * @prop {Number=} param.limit - The limit parameter will return a specific number of stacks in the output.
       * @prop {Number=} param.skip - The skip parameter will skip a specific number of stacks in the output.
       * @prop {String=} param.asc - When fetching stacks, you can sort them in the ascending order with respect to the value of a specific field in the response body.
       * @prop {String=} param.desc - When fetching stacks, you can sort them in descending order with respect to the value of a specific field in the response body.
       * @prop {Boolean=} param.include_count - To retrieve the count of stack.
       * @prop {String=} param.typeahead - The typeahead contains value to be included in search.
       * @returns {Promise<ContentstackCollection>} Promise for ContentstackCollection instance.
       * @example
       * import * as contentstack from '@contentstack/management'
       * const client = contentstack.client()
       *
       * client.organization('organization_uid').stacks({ include_count: true })
       * .then((collection) => console.log(collection))
       *
       */
    this.stacks = async (param) => {
      try {
        const response = await http.get(`${this.urlPath}/stacks`, { params: param })
        if (response.data) {
          return new ContentstackCollection(response, http, null, StackCollection)
        } else {
          return error(response)
        }
      } catch (err) {
        return error(err)
      }
    }

    /**
       * @description The Transfer organization ownership call transfers the ownership of an Organization to another user.
       * @memberof Organization
       * @func transferOwnership
       * @async
       * @param {String} email The email address of the user to whom you wish to transfer the ownership of the organization.
       * @returns {Promise<Object>} Response Object.
       * @example
       * import * as contentstack from '@contentstack/management'
       * const client = contentstack.client()
       *
       * client.organization('organization_uid').transferOwnership('emailId')
       * .then((response) => console.log(response.notice))
       *
       */
    this.transferOwnership = async (email) => {
      try {
        const response = await http.post(`${this.urlPath}/transfer-ownership`, { transfer_to: email })
        if (response.data) {
          return response.data
        } else {
          return error(response)
        }
      } catch (err) {
        return error(err)
      }
    }

    /**
       * @description The Add users to organization call allows you to send invitations to add users to your organization. Only the owner or the admin of the organization can add users.
       * @memberof Organization
       * @func addUser
       * @async
       * @returns {Promise<ContentstackCollection>} Promise for ContentstackCollection instance.
       * @example
       * 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' ] } } })
       * .then((response) => console.log(response))
       *
       */
    this.addUser = async (data) => {
      try {
        const response = await http.post(`${this.urlPath}/share`, { share: { ...data } })
        if (response.data) {
          return new ContentstackCollection(response, http, null, UserCollection)
        } else {
          return error(response)
        }
      } catch (err) {
        return error(err)
      }
    }

    /**
       * @description The Get all organization invitations call gives you a list of all the Organization invitations.
       * @memberof Organization
       * @func getInvitations
       * @async
       * @returns {Promise<ContentstackCollection>} Promise for ContentstackCollection instance.
       * @example
       * import * as contentstack from '@contentstack/management'
       * const client = contentstack.client()
       *
       * client.organization('organization_uid').getInvitations()
       * .then((response) => console.log(response.notice))
       *
       */
    this.getInvitations = async (param) => {
      try {
        const response = await http.get(`${this.urlPath}/share`, { params: param })
        if (response.data) {
          return new ContentstackCollection(response, http, null, UserCollection)
        } else {
          return error(response)
        }
      } catch (err) {
        return error(err)
      }
    }

    /**
       * @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 resendInvitation
       * @async
       * @returns {Promise<Object>} Response Object.
       * @example
       * import * as contentstack from '@contentstack/management'
       * const client = contentstack.client()
       *
       * client.organization('organization_uid').resendInvitation('invitation_uid')
       * .then((response) => console.log(response.notice))
       *
       */
    this.resendInvitation = async (invitationUid) => {
      try {
        const response = await http.get(`${this.urlPath}/${invitationUid}/resend_invitation`)
        if (response.data) {
          return response.data
        } else {
          return error(response)
        }
      } catch (err) {
        return error(err)
      }
    }

    /**
       * @description A role is a collection of permissions that will be applicable to all the users who are assigned this role.
       * @memberof Organization
       * @func roles
       * @async
       * @param {Object=} param - Query parameters.
       * @prop {Number=} param.limit - The limit parameter will return a specific number of roles in the output.
       * @prop {Number=} param.skip - The skip parameter will skip a specific number of roles in the output.
       * @prop {String=} param.asc - When fetching roles, you can sort them in the ascending order with respect to the value of a specific field in the response body.
       * @prop {String=} param.desc - When fetching roles, you can sort them in descending order with respect to the value of a specific field in the response body.
       * @prop {Boolean=} param.include_count - To retrieve the count of roles.
       * @prop {Boolean=} param.include_stack_roles - The Include stack roles will return stack details in roles.
       * @returns {Promise<ContentstackCollection>} Promise for ContentstackCollection instance.
       * @example
       * import * as contentstack from '@contentstack/management'
       * const client = contentstack.client()
       *
       * client.organization('organization_uid').roles()
       * .then((roles) => console.log(roles))
       *
       */
    this.roles = async (param) => {
      try {
        const response = await http.get(`${this.urlPath}/roles`, { params: param })
        if (response.data) {
          return new ContentstackCollection(response, http, null, RoleCollection)
        } else {
          return error(response)
        }
      } catch (err) {
        return error(err)
      }
    }
  } else {
    /**
     * @description The Get all organizations call lists all organizations related to the system user in the order that they were created.
     * @memberof Organization
     * @func fetchAll
     * @param {Number} limit - The 'limit' parameter will return a specific number of organizations in the output.
     * @param {Number} skip - The 'skip' parameter will skip a specific number of organizations in the output.
     * @param {String} asc - The 'asc' parameter allows you to sort the list of organizations in the ascending order with respect to the value of a specific field.
     * @param {String} desc - The 'desc' parameter allows you to sort the list of Organizations in descending order with respect to the value of a specific field.
     * @param {Boolean} include_count - The 'include_count' parameter returns the total number of organizations related to the user.
     * @param {String} typeahead The typeahead parameter is a type of filter that allows you to perform a name-based search on all organizations based on the value provided.
     * @returns {Promise<ContentstackCollection>} Promise for ContentstackCollection instance.
     * @example
     * import * as contentstack from '@contentstack/management'
     * const client = contentstack.client()
     *
     * client.organization().fetchAll()
     * .then((collection) => console.log(collection))
     *
     */
    this.fetchAll = fetchAll(http, OrganizationCollection)
  }
}

export function OrganizationCollection (http, data) {
  const obj = cloneDeep(data.organizations || [])
  return obj.map((userdata) => {
    return new Organization(http, { organization: userdata })
  })
}