contentful-management 11.60.3 → 12.0.0-beta.10

package/dist/typings/entities/tag.d.ts

@@ -1,51 +0,0 @@
-import type { DefaultElements, GetTagParams, MakeRequest, MetaSysProps, SysLink } from '../common-types';
-export type TagVisibility = 'private' | 'public';
-export type TagSysProps = Pick<MetaSysProps, 'id' | 'version' | 'createdAt' | 'createdBy' | 'updatedAt' | 'updatedBy'> & {
-    type: 'Tag';
-    visibility: TagVisibility;
-    space: SysLink;
-    environment: SysLink;
-};
-export type TagProps = {
-    sys: TagSysProps;
-    name: string;
-};
-export type CreateTagProps = Omit<TagProps, 'sys'> & {
-    sys: Pick<TagSysProps, 'visibility'>;
-};
-export type UpdateTagProps = Omit<TagProps, 'sys'> & {
-    sys: Pick<TagSysProps, 'version'>;
-};
-export type DeleteTagParams = GetTagParams & {
-    version: number;
-};
-export type TagCollectionProps = {
-    sys: {
-        type: 'Array';
-    };
-    items: TagProps[];
-    total: number;
-};
-export interface TagCollection {
-    items: Tag[];
-    total: number;
-}
-type TagApi = {
-    update(): Promise<Tag>;
-    delete(): Promise<void>;
-};
-export interface Tag extends TagProps, DefaultElements<TagProps>, TagApi {
-}
-/**
- * @private
- */
-export default function createTagApi(makeRequest: MakeRequest): TagApi;
-/**
- * @private
- */
-export declare function wrapTag(makeRequest: MakeRequest, data: TagProps): Tag;
-/**
- * @private
- */
-export declare const wrapTagCollection: (makeRequest: MakeRequest, data: import("../common-types").CollectionProp<TagProps>) => import("../common-types").Collection<Tag, TagProps>;
-export {};

package/dist/typings/entities/task.d.ts

@@ -1,43 +0,0 @@
-import type { BasicMetaSysProps, DefaultElements, GetEntryParams, GetTaskParams, Link, MakeRequest, SysLink } from '../common-types';
-export type TaskStatus = 'active' | 'resolved';
-export type TaskSysProps = Pick<BasicMetaSysProps, 'id' | 'version' | 'createdAt' | 'createdBy' | 'updatedAt' | 'updatedBy'> & {
-    type: 'Task';
-    space: SysLink;
-    environment: SysLink;
-    parentEntity: Link<'Entry'>;
-};
-export type TaskProps = {
-    sys: TaskSysProps;
-    body: string;
-    assignedTo: Link<'User' | 'Team'>;
-    status: TaskStatus;
-    dueDate?: string;
-};
-export type CreateTaskProps = Omit<TaskProps, 'sys'>;
-export type UpdateTaskProps = Omit<TaskProps, 'sys'> & {
-    sys: Pick<TaskSysProps, 'version'>;
-};
-export type CreateTaskParams = GetEntryParams;
-export type UpdateTaskParams = GetTaskParams;
-export type DeleteTaskParams = GetTaskParams & {
-    version: number;
-};
-type TaskApi = {
-    update(): Promise<Task>;
-    delete(): Promise<void>;
-};
-export interface Task extends TaskProps, DefaultElements<TaskProps>, TaskApi {
-}
-/**
- * @private
- */
-export default function createTaskApi(makeRequest: MakeRequest): TaskApi;
-/**
- * @private
- */
-export declare function wrapTask(makeRequest: MakeRequest, data: TaskProps): Task;
-/**
- * @private
- */
-export declare const wrapTaskCollection: (makeRequest: MakeRequest, data: import("../common-types").CollectionProp<TaskProps>) => import("../common-types").Collection<Task, TaskProps>;
-export {};

package/dist/typings/entities/team-membership.d.ts

@@ -1,78 +0,0 @@
-import type { DefaultElements, MetaSysProps, MetaLinkProps, MakeRequest } from '../common-types';
-export type TeamMembershipProps = {
-    /**
-     * System metadata
-     */
-    sys: MetaSysProps & {
-        team: {
-            sys: MetaLinkProps;
-        };
-        organization: {
-            sys: MetaLinkProps;
-        };
-        organizationMembership: {
-            sys: MetaLinkProps;
-        };
-    };
-    /**
-     * Is admin
-     */
-    admin: boolean;
-    /**
-     * Organization membership id
-     */
-    organizationMembershipId: string;
-};
-export type CreateTeamMembershipProps = Omit<TeamMembershipProps, 'sys'>;
-export interface TeamMembership extends TeamMembershipProps, DefaultElements<TeamMembershipProps> {
-    /**
-     * Deletes this object on the server.
-     * @return Promise for the deletion. It contains no data, but the Promise error case should be handled.
-     * @example ```javascript
-     * const contentful = require('contentful-management')
-     *
-     * const client = contentful.createClient({
-     *   accessToken: '<content_management_api_key>'
-     * })
-     *
-     * client.getOrganization('organizationId')
-     * .then(org => org.getTeamMembership('teamId', 'teamMembershipId'))
-     * .then((teamMembership) => {
-     *  teamMembership.delete();
-     * })
-     * .catch(console.error)
-     * ```
-     */
-    delete(): Promise<void>;
-    /**
-     * Sends an update to the server with any changes made to the object's properties
-     * @return Object returned from the server with updated changes.
-     * @example ```javascript
-     * const contentful = require('contentful-management')
-     *
-     * const client = contentful.createClient({
-     *   accessToken: '<content_management_api_key>'
-     * })
-     *
-     * client.getOrganization('organizationId')
-     * .then(org => org.getTeamMembership('teamId', 'teamMembershipId'))
-     * .then((teamMembership) => {
-     *  teamMembership.admin = true;
-     *  teamMembership.update();
-     * })
-     * .catch(console.error)
-     * ```
-     */
-    update(): Promise<TeamMembership>;
-}
-/**
- * @private
- * @param makeRequest - function to make requests via an adapter
- * @param data - Raw team membership data
- * @return Wrapped team membership data
- */
-export declare function wrapTeamMembership(makeRequest: MakeRequest, data: TeamMembershipProps): TeamMembership;
-/**
- * @private
- */
-export declare const wrapTeamMembershipCollection: (makeRequest: MakeRequest, data: import("../common-types").CollectionProp<TeamMembershipProps>) => import("../common-types").Collection<TeamMembership, TeamMembershipProps>;

package/dist/typings/entities/team-space-membership.d.ts

@@ -1,88 +0,0 @@
-import type { DefaultElements, MakeRequest, MetaLinkProps, MetaSysProps, QueryOptions } from '../common-types';
-export interface Options {
-    teamId?: string;
-    query?: QueryOptions;
-}
-export type TeamSpaceMembershipProps = {
-    /**
-     * System metadata
-     */
-    sys: MetaSysProps & {
-        team: {
-            sys: MetaLinkProps;
-        };
-        space: {
-            sys: MetaLinkProps;
-        };
-    };
-    /**
-     * Is admin
-     */
-    admin: boolean;
-    /**
-     * Roles
-     */
-    roles: {
-        sys: MetaLinkProps;
-    }[];
-};
-export type CreateTeamSpaceMembershipProps = Omit<TeamSpaceMembershipProps, 'sys'>;
-export interface TeamSpaceMembership extends TeamSpaceMembershipProps, DefaultElements<TeamSpaceMembershipProps> {
-    /**
-     * Deletes this object on the server.
-     * @return Promise for the deletion. It contains no data, but the Promise error case should be handled.
-     * @example ```javascript
-     * const contentful = require('contentful-management')
-     *
-     * const client = contentful.createClient({
-     *   accessToken: '<content_management_api_key>'
-     * })
-     *
-     * client.getSpace('<space_id>')
-     * .then((space) => space.getTeamSpaceMembership('<team_space_membership_id>'))
-     * .then((teamSpaceMembership) => teamSpaceMembership.delete())
-     * .then(() => console.log(`spaceMembership deleted.`))
-     * .catch(console.error)
-     * ```
-     */
-    delete(): Promise<void>;
-    /**
-     * Sends an update to the server with any changes made to the object's properties
-     * @return Object returned from the server with updated changes.
-     * @example ```javascript
-     * const contentful = require('contentful-management')
-     *
-     * const client = contentful.createClient({
-     *   accessToken: '<content_management_api_key>'
-     * })
-     *
-     * client.getSpace('<space_id>')
-     *  .then((space) => space.getTeamSpaceMembership('team_space_membership_id'))
-     *  .then((teamSpaceMembership) => {
-     *    item.roles = [
-     *      {
-     *        sys: {
-     *          type: 'Link',
-     *          linkType: 'Role',
-     *          id: 'role_id'
-     *        }
-     *      }
-     *    ]
-     *  })
-     *  .then((spaceMembership) => console.log(`spaceMembership ${spaceMembership.sys.id} updated.`))
-     *  .catch(console.error)
-     *  ```
-     */
-    update(): Promise<TeamSpaceMembership>;
-}
-/**
- * @private
- * @param makeRequest - function to make requests via an adapter
- * @param data - Raw space membership data
- * @return Wrapped team space membership data
- */
-export declare function wrapTeamSpaceMembership(makeRequest: MakeRequest, data: TeamSpaceMembershipProps): TeamSpaceMembership;
-/**
- * @private
- */
-export declare const wrapTeamSpaceMembershipCollection: (makeRequest: MakeRequest, data: import("../common-types").CollectionProp<TeamSpaceMembershipProps>) => import("../common-types").Collection<TeamSpaceMembership, TeamSpaceMembershipProps>;

package/dist/typings/entities/team.d.ts

@@ -1,73 +0,0 @@
-import type { DefaultElements, MetaSysProps, MetaLinkProps, MakeRequest } from '../common-types';
-export type TeamProps = {
-    /**
-     * System metadata
-     */
-    sys: MetaSysProps & {
-        memberCount: number;
-        organization: {
-            sys: MetaLinkProps;
-        };
-    };
-    /**
-     * Name of the team
-     */
-    name: string;
-    /**
-     * Description of the team
-     */
-    description: string;
-};
-export type CreateTeamProps = Omit<TeamProps, 'sys'>;
-export interface Team extends TeamProps, DefaultElements<TeamProps> {
-    /**
-     * Deletes this object on the server.
-     * @return Promise for the deletion. It contains no data, but the Promise error case should be handled.
-     * @example ```javascript
-     * const contentful = require('contentful-management')
-     *
-     * const client = contentful.createClient({
-     *   accessToken: '<content_management_api_key>'
-     * })
-     *
-     * client.getOrganization('organization_id')
-     * .then(org => org.getOrganizationMembership('organizationMembership_id'))
-     * .then((team) => {
-     *  team.delete();
-     * })
-     * .catch(console.error)
-     * ```
-     */
-    delete(): Promise<void>;
-    /**
-     * Sends an update to the server with any changes made to the object's properties
-     * @return Object returned from the server with updated changes.
-     * @example ```javascript
-     * const contentful = require('contentful-management')
-     *
-     * const client = contentful.createClient({
-     *   accessToken: '<content_management_api_key>'
-     * })
-     *
-     * client.getOrganization('organization_id')
-     * .then(org => org.getTeam('team_id'))
-     * .then((team) => {
-     *  team.description = 'new description';
-     *  team.update();
-     * })
-     * .catch(console.error)
-     * ```
-     */
-    update(): Promise<Team>;
-}
-/**
- * @private
- * @param makeRequest - function to make requests via an adapter
- * @param data - Raw team data
- * @return Wrapped team data
- */
-export declare function wrapTeam(makeRequest: MakeRequest, data: TeamProps): Team;
-/**
- * @private
- */
-export declare const wrapTeamCollection: (makeRequest: MakeRequest, data: import("../common-types").CollectionProp<TeamProps>) => import("../common-types").Collection<Team, TeamProps>;

package/dist/typings/entities/ui-config.d.ts

@@ -1,59 +0,0 @@
-import type { BasicMetaSysProps, DefaultElements, MakeRequest, SysLink } from '../common-types';
-export type UIConfigProps = {
-    /**
-     * System metadata
-     */
-    sys: UIConfigSysProps;
-    assetListViews: ViewFolder[];
-    entryListViews: ViewFolder[];
-    homeViews: HomeView[];
-    livePreview?: {
-        previewMode: 'livePreview' | 'legacyPreview';
-    };
-    publish?: {
-        publishMode: 'entryPublishing' | 'localePublishing';
-    };
-};
-export interface UIConfigSysProps extends BasicMetaSysProps {
-    space: SysLink;
-    environment: SysLink;
-}
-interface HomeView {
-    widgetId: string;
-    widgetNamespace: string;
-}
-interface ViewFolder {
-    id: string;
-    title: string;
-    views: View[];
-}
-interface View {
-    id: string;
-    title: string;
-    order?: {
-        fieldId: string;
-        direction: 'ascending' | 'descending';
-    };
-    displayedFieldIds?: string[];
-    contentTypeId?: string | null;
-    contentTypeIds?: string[];
-    searchText?: string;
-    searchFilters?: [string, string, string][];
-    roles?: string[];
-}
-export interface UIConfig extends UIConfigProps, DefaultElements<UIConfigProps> {
-}
-/**
- * @private
- * @param makeRequest - function to make requests via an adapter
- * @param data - Raw data
- * @return Wrapped UIConfig
- */
-export declare function wrapUIConfig(makeRequest: MakeRequest, data: UIConfigProps): {
-    update: () => Promise<any & UIConfigProps & {
-        toPlainObject(): UIConfigProps;
-    }>;
-} & UIConfigProps & {
-    toPlainObject(): UIConfigProps;
-};
-export {};

package/dist/typings/entities/upload-credential.d.ts

@@ -1,43 +0,0 @@
-import type { DefaultElements, MakeRequest, MetaSysProps, SysLink } from '../common-types';
-export type UploadCredentialProps = {
-    /**
-     * System metadata
-     */
-    sys: MetaSysProps & {
-        space: SysLink;
-        environment?: SysLink;
-    };
-};
-export interface UploadCredential extends UploadCredentialProps, DefaultElements<UploadCredentialProps> {
-    /**
-     * creates the upload credentials.
-     * @return upload credentials for file uploads
-     * @example
-     * const contentful = require('contentful-management')
-     *
-     * const client = contentful.createClient({
-     *   accessToken: '<content_management_api_key>'
-     * })
-     *
-     * try {
-     *   const space = await client.getSpace('<space_id>')
-     *   const environment = await space.getEnvironment('<environment_id>')
-     *
-     *   const upload = await client.uploadCredential.create({
-     *     spaceId: space.sys.id,
-     *     environmentId: environment.sys.id
-     *   })
-     * } catch (error) {
-     *  console.error(error)
-     * }
-     *
-     */
-    create(): Promise<UploadCredentialProps>;
-}
-/**
- * @private
- * @param {function} makeRequest - function to make requests via an adapter
- * @param {object} data - Raw upload credential data
- * @return {UploadCredential} Wrapped upload credential data
- */
-export declare function wrapUploadCredential(makeRequest: MakeRequest, data: UploadCredentialProps): UploadCredential;

package/dist/typings/entities/upload.d.ts

@@ -1,41 +0,0 @@
-import type { DefaultElements, MakeRequest, MetaSysProps, SysLink } from '../common-types';
-export type UploadProps = {
-    /**
-     * System metadata
-     */
-    sys: MetaSysProps & {
-        space: SysLink;
-        environment?: SysLink;
-    };
-};
-export interface Upload extends UploadProps, DefaultElements<UploadProps> {
-    /**
-     * Deletes this object on the server.
-     * @return Promise for the deletion. It contains no data, but the Promise error case should be handled.
-     * @example
-     * const contentful = require('contentful-management')
-     *
-     * const client = contentful.createClient({
-     *   accessToken: '<content_management_api_key>'
-     * })
-     *
-     * client.getSpace('<space_id>')
-     * .then((space) => space.getEnvironment('<environment_id>'))
-     * .then((environment) => environment.getUpload('<upload_id>'))
-     * .then((upload) => upload.delete())
-     * .then((upload) => console.log(`upload ${upload.sys.id} updated.`))
-     * .catch(console.error)
-     */
-    delete(): Promise<void>;
-}
-/**
- * @private
- * @param {function} makeRequest - function to make requests via an adapter
- * @param {object} data - Raw upload data
- * @return {Upload} Wrapped upload data
- */
-export declare function wrapUpload(makeRequest: MakeRequest, data: UploadProps): {
-    delete: () => Promise<void>;
-} & UploadProps & {
-    toPlainObject(): UploadProps;
-};

package/dist/typings/entities/usage.d.ts

@@ -1,55 +0,0 @@
-import type { DefaultElements, MakeRequest, MetaLinkProps, MetaSysProps, QueryOptions } from '../common-types';
-export type UsageMetricEnum = 'cda' | 'cma' | 'cpa' | 'gql';
-export interface UsageQuery extends QueryOptions {
-    'metric[in]'?: string;
-    'dateRange.startAt'?: string;
-    'dateRange.endAt'?: string;
-}
-export type UsageProps = {
-    /**
-     * System metadata
-     */
-    sys: MetaSysProps & {
-        organization?: {
-            sys: MetaLinkProps;
-        };
-    };
-    /**
-     * Type of usage
-     */
-    metric: UsageMetricEnum;
-    /**
-     * Unit of usage metric
-     */
-    unitOfMeasure: string;
-    /**
-     * Range of usage
-     */
-    dateRange: {
-        startAt: string;
-        endAt: string;
-    };
-    /**
-     * Value of the usage
-     */
-    usage: number;
-    /**
-     * Usage per day
-     */
-    usagePerDay: {
-        [key: string]: number;
-    };
-};
-export interface Usage extends UsageProps, DefaultElements<UsageProps> {
-}
-/**
- * @private
- * @param makeRequest - function to make requests via an adapter
- * @param data - Raw data
- * @return Normalized usage
- */
-export declare function wrapUsage(_makeRequest: MakeRequest, data: UsageProps): Usage;
-/**
- * @private
- */
-export declare const wrapUsageCollection: (makeRequest: MakeRequest, data: import("../common-types").CollectionProp<UsageProps>) => import("../common-types").Collection<Usage, UsageProps>;

package/dist/typings/entities/user-ui-config.d.ts

@@ -1,46 +0,0 @@
-import type { BasicMetaSysProps, DefaultElements, MakeRequest, SysLink } from '../common-types';
-export type UserUIConfigProps = {
-    /**
-     * System metadata
-     */
-    sys: UserUIConfigSysProps;
-    assetListViews: ViewFolder[];
-    entryListViews: ViewFolder[];
-};
-export interface UserUIConfigSysProps extends BasicMetaSysProps {
-    space: SysLink;
-    environment: SysLink;
-}
-interface ViewFolder {
-    id: string;
-    title: string;
-    views: View[];
-}
-interface View {
-    id: string;
-    title: string;
-    order?: {
-        fieldId: string;
-        direction: 'ascending' | 'descending';
-    };
-    displayedFieldIds?: string[];
-    contentTypeId: string | null;
-    searchText?: string;
-    searchFilters?: [string, string, string][];
-}
-export interface UserUIConfig extends UserUIConfigProps, DefaultElements<UserUIConfigProps> {
-}
-/**
- * @private
- * @param makeRequest - function to make requests via an adapter
- * @param data - Raw data
- * @return Wrapped UserUIConfig
- */
-export declare function wrapUserUIConfig(makeRequest: MakeRequest, data: UserUIConfigProps): {
-    update: () => Promise<any & UserUIConfigProps & {
-        toPlainObject(): UserUIConfigProps;
-    }>;
-} & UserUIConfigProps & {
-    toPlainObject(): UserUIConfigProps;
-};
-export {};

package/dist/typings/entities/user.d.ts

@@ -1,57 +0,0 @@
-import type { DefaultElements, BasicMetaSysProps, MakeRequest } from '../common-types';
-export type UserProps = {
-    /**
-     * System metadata
-     */
-    sys: BasicMetaSysProps;
-    /**
-     * First name of the user
-     */
-    firstName: string;
-    /**
-     * Last name of the user
-     */
-    lastName: string;
-    /**
-     * Url to the users avatar
-     */
-    avatarUrl: string;
-    /**
-     * Email address of the user
-     */
-    email: string;
-    /**
-     * Activation flag
-     */
-    activated: boolean;
-    /**
-     * Number of sign ins
-     */
-    signInCount: number;
-    /**
-     * User confirmation flag
-     */
-    confirmed: boolean;
-    '2faEnabled': boolean;
-    cookieConsentData: string;
-};
-export interface User extends UserProps, DefaultElements<UserProps> {
-}
-/**
- * @private
- * @param makeRequest - function to make requests via an adapter
- * @param data - Raw data
- * @return Normalized user
- */
-export declare function wrapUser<T = UserProps>(_makeRequest: MakeRequest, data: T): T & {
-    toPlainObject(): T;
-};
-/**
- * @private
- * @param makeRequest - function to make requests via an adapter
- * @param data - Raw data collection
- * @return Normalized user collection
- */
-export declare const wrapUserCollection: <T = UserProps>(makeRequest: MakeRequest, data: import("../common-types").CollectionProp<T>) => import("../common-types").Collection<T & {
-    toPlainObject(): T;
-}, T>;