contentful-management 11.63.2-dx-542-update-to-gha.1 → 11.64.0-new-beta.2

package/dist/typings/entities/scheduled-action.d.ts

@@ -1,112 +0,0 @@
-import type { DefaultElements, ISO8601Timestamp, MetaLinkProps, Link, MakeRequest, SysLink, ScheduledActionReferenceFilters, BasicCursorPaginationOptions, CollectionProp } from '../common-types';
-/**
- * Represents that state of the scheduled action
- */
-export declare enum ScheduledActionStatus {
-    /** action is pending execution */
-    scheduled = "scheduled",
-    /** action has been started and pending completion */
-    inProgress = "inProgress",
-    /** action was completed successfully (terminal state) */
-    succeeded = "succeeded",
-    /** action failed to complete (terminal state) */
-    failed = "failed",
-    /** action was canceled by a user (terminal state) */
-    canceled = "canceled"
-}
-type SchedulableEntityType = 'Entry' | 'Asset' | 'Release';
-type SchedulableActionType = 'publish' | 'unpublish';
-type ErrorDetail = {
-    error: any;
-};
-interface ScheduledActionFailedError {
-    sys: {
-        type: 'Error';
-        id: string;
-    };
-    message?: string;
-    details?: {
-        errors: ErrorDetail[];
-    };
-}
-export interface CursorPaginatedCollectionProp<TObj> extends Omit<CollectionProp<TObj>, 'total' | 'skip'> {
-    pages?: BasicCursorPaginationOptions;
-}
-export type ScheduledActionSysProps = {
-    id: string;
-    type: 'ScheduledAction';
-    version: number;
-    space: SysLink;
-    status: ScheduledActionStatus;
-    createdAt: ISO8601Timestamp;
-    createdBy: Link<'User'> | Link<'AppDefinition'>;
-    /** an ISO8601 date string representing when an action was moved to canceled */
-    canceledAt?: ISO8601Timestamp;
-    canceledBy?: Link<'User'> | Link<'AppDefinition'>;
-    /** an ISO8601 date string representing when an action was updated */
-    updatedAt: ISO8601Timestamp;
-    updatedBy: Link<'User'> | Link<'AppDefinition'>;
-};
-export type ScheduledActionPayloadProps = {
-    withReferences?: Record<ScheduledActionReferenceFilters, string[]>;
-};
-export type ScheduledActionProps = {
-    sys: ScheduledActionSysProps;
-    action: SchedulableActionType;
-    entity: Link<SchedulableEntityType>;
-    environment?: {
-        sys: MetaLinkProps;
-    };
-    scheduledFor: {
-        datetime: ISO8601Timestamp;
-        /**
-         * A valid IANA timezone Olson identifier
-         *
-         * @see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
-         * @example 'Asia/Kolkata'
-         */
-        timezone?: string;
-    };
-    /**
-     * The Contentful-style error that occurred during execution if sys.status is failed
-     *
-     * @example
-     * {
-     *   sys: {
-     *     type: 'Error',
-     *     id: 'InvalidEntry'
-     *   },
-     *   message: 'Entry is invalid',
-     *   details: {
-     *     errors: [...]
-     *   }
-     * }
-     */
-    error?: ScheduledActionFailedError;
-    payload?: ScheduledActionPayloadProps;
-};
-export type CreateUpdateScheduledActionProps = Pick<ScheduledActionProps, 'action' | 'entity' | 'environment' | 'scheduledFor' | 'payload'>;
-export type ScheduledActionCollection = CursorPaginatedCollectionProp<ScheduledActionProps>;
-export interface ScheduledActionQueryOptions {
-    'environment.sys.id': string;
-    [key: string]: any;
-    limit?: number;
-    next?: string;
-    prev?: string;
-}
-export type ScheduledActionApi = {
-    delete(): Promise<ScheduledAction>;
-    update(): Promise<ScheduledAction>;
-};
-export interface ScheduledAction extends ScheduledActionProps, DefaultElements<ScheduledActionProps>, ScheduledActionApi {
-}
-export default function getInstanceMethods(makeRequest: MakeRequest): ScheduledActionApi;
-/**
- * @private
- */
-export declare function wrapScheduledAction(makeRequest: MakeRequest, data: ScheduledActionProps): ScheduledAction;
-/**
- * @private
- */
-export declare const wrapScheduledActionCollection: (makeRequest: MakeRequest, data: CollectionProp<ScheduledActionProps>) => import("../common-types").Collection<ScheduledAction, ScheduledActionProps>;
-export {};

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

@@ -1,24 +0,0 @@
-import type { MetaSysProps, DefaultElements, MakeRequest } from '../common-types';
-export type SnapshotProps<T> = {
-    sys: MetaSysProps & {
-        snapshotType: string;
-        snapshotEntityType: string;
-    };
-    snapshot: T;
-};
-export interface Snapshot<T> extends SnapshotProps<T>, DefaultElements<SnapshotProps<T>> {
-}
-/**
- * @private
- * @param makeRequest - function to make requests via an adapter
- * @param data - Raw snapshot data
- * @return Wrapped snapshot data
- */
-export declare function wrapSnapshot<T>(_makeRequest: MakeRequest, data: SnapshotProps<T>): Snapshot<T>;
-/**
- * @private
- * @param makeRequest - function to make requests via an adapter
- * @param data - Raw snapshot collection data
- * @return Wrapped snapshot collection data
- */
-export declare const wrapSnapshotCollection: <T>(makeRequest: MakeRequest, data: import("../common-types").CollectionProp<SnapshotProps<T>>) => import("../common-types").Collection<Snapshot<T>, SnapshotProps<T>>;

package/dist/typings/entities/space-member.d.ts

@@ -1,31 +0,0 @@
-import type { DefaultElements, MakeRequest, MetaLinkProps, MetaSysProps } from '../common-types';
-export type SpaceMemberProps = {
-    sys: MetaSysProps;
-    /**
-     * User is an admin
-     */
-    admin: boolean;
-    /**
-     * Array of Role Links
-     */
-    roles: {
-        sys: MetaLinkProps;
-    }[];
-};
-export interface SpaceMember extends SpaceMemberProps, DefaultElements<SpaceMemberProps> {
-}
-/**
- * @private
- * @param makeRequest - function to make requests via an adapter
- * @param data - Raw space member data
- * @return Wrapped space member data
- */
-export declare function wrapSpaceMember(_makeRequest: MakeRequest, data: SpaceMemberProps): SpaceMemberProps & {
-    toPlainObject(): SpaceMemberProps;
-};
-/**
- * @private
- */
-export declare const wrapSpaceMemberCollection: (makeRequest: MakeRequest, data: import("../common-types").CollectionProp<SpaceMemberProps>) => import("../common-types").Collection<SpaceMemberProps & {
-    toPlainObject(): SpaceMemberProps;
-}, SpaceMemberProps>;

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

@@ -1,64 +0,0 @@
-import type { SysLink, MetaSysProps, DefaultElements, MakeRequest } from '../common-types';
-export type SpaceMembershipProps = {
-    sys: MetaSysProps & {
-        space: SysLink;
-        user: SysLink;
-    };
-    user: SysLink;
-    admin: boolean;
-    roles: SysLink[];
-};
-export type CreateSpaceMembershipProps = Omit<SpaceMembershipProps, 'sys' | 'user'> & {
-    email: string;
-};
-export interface SpaceMembership extends SpaceMembershipProps, DefaultElements<SpaceMembershipProps> {
-    /**
-     * 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.getSpaceMembership('<spaceMembership_id>'))
-     * .then((spaceMembership) => spaceMembership.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.getSpaceMembership('<spaceMembership_id>'))
-     * .then((spaceMembership) => {
-     *  spaceMembership.name = 'new space membership name'
-     * })
-     * .then((spaceMembership) => console.log(`spaceMembership ${spaceMembership.sys.id} updated.`))
-     * .catch(console.error)
-     * ```
-     */
-    update(): Promise<SpaceMembership>;
-}
-/**
- * @private
- * @param makeRequest - function to make requests via an adapter
- * @param data - Raw space membership data
- * @return Wrapped space membership data
- */
-export declare function wrapSpaceMembership(makeRequest: MakeRequest, data: SpaceMembershipProps): SpaceMembership;
-/**
- * @private
- */
-export declare const wrapSpaceMembershipCollection: (makeRequest: MakeRequest, data: import("../common-types").CollectionProp<SpaceMembershipProps>) => import("../common-types").Collection<SpaceMembership, SpaceMembershipProps>;

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

@@ -1,31 +0,0 @@
-import type { BasicMetaSysProps, DefaultElements, MakeRequest } from '../common-types';
-import type { ContentfulSpaceAPI } from '../create-space-api';
-export type SpaceProps = {
-    sys: BasicMetaSysProps & {
-        organization: {
-            sys: {
-                id: string;
-            };
-        };
-        archivedAt?: string;
-    };
-    name: string;
-};
-export type Space = SpaceProps & DefaultElements<SpaceProps> & ContentfulSpaceAPI;
-/**
- * This method creates the API for the given space with all the methods for
- * reading and creating other entities. It also passes down a clone of the
- * http client with a space id, so the base path for requests now has the
- * space id already set.
- * @private
- * @param makeRequest - function to make requests via an adapter
- * @param data - API response for a Space
- * @return {Space}
- */
-export declare function wrapSpace(makeRequest: MakeRequest, data: SpaceProps): Space;
-/**
- * This method wraps each space in a collection with the space API. See wrapSpace
- * above for more details.
- * @private
- */
-export declare const wrapSpaceCollection: (makeRequest: MakeRequest, data: import("../common-types").CollectionProp<SpaceProps>) => import("../common-types").Collection<Space, SpaceProps>;

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/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>;