contentful-management/dist/types/entities/organization.d.ts

Client for Contentful's Content Management API

import type { ContentfulOrganizationAPI } from '../create-organization-api';
import type { MetaSysProps, DefaultElements, MakeRequest } from '../common-types';
export type Organization = DefaultElements<OrganizationProps> & OrganizationProps & ContentfulOrganizationAPI;
export type OrganizationProps = {
    /**
     * System metadata
     */
    sys: MetaSysProps;
    /**
     * Name
     */
    name: string;
    /**
     * Default language used in the interface and email communications.
     * Users can override this setting in their profile settings.
     * If not set, the default value is `en-US`.
     */
    defaultUserLanguage: string;
};
/**
 * @deprecated Use `OrganizationProps` instead.
 */
export type OrganizationProp = OrganizationProps;
/**
 * This method creates the API for the given organization with all the methods for
 * reading and creating other entities. It also passes down a clone of the
 * http client with an organization id, so the base path for requests now has the
 * organization id already set.
 * @internal
 * @param makeRequest - function to make requests via an adapter
 * @param data - API response for an Organization
 * @returns {Organization}
 */
export declare function wrapOrganization(makeRequest: MakeRequest, data: OrganizationProps): Organization;
/**
 * This method normalizes each organization in a collection.
 * @internal
 */
export declare const wrapOrganizationCollection: (makeRequest: MakeRequest, data: import("..").CollectionProp<OrganizationProps>) => import("..").Collection<Organization, OrganizationProps>;