contentful-management 12.0.0-new-beta.1 → 12.0.0-new-beta.3

package/dist/types/plain/entities/task.d.ts

@@ -1,114 +0,0 @@
-import type { RawAxiosRequestHeaders } from 'axios';
-import type { GetTaskParams, GetEntryParams, QueryParams, CollectionProp } from '../../common-types';
-import type { CreateTaskParams, UpdateTaskParams, DeleteTaskParams, TaskProps, CreateTaskProps, UpdateTaskProps } from '../../entities/task';
-import type { OptionalDefaults } from '../wrappers/wrap';
-export type TaskPlainClientAPI = {
-    /** Fetches a task
-     *
-     * @param params Space ID, Entry ID, Environment ID, and Task ID
-     * @returns the task
-     * @throws if the request fails or the task is not found
-     * @example
-     * ```javascript
-     * const task = await client.task.get({
-     *   spaceId: '<space_id>',
-     *   entryId: '<entry_id>',
-     *   environmentId: '<environment_id>',
-     *   taskId: '<task_id>',
-     * });
-     * ```
-     */
-    get(params: OptionalDefaults<GetTaskParams>): Promise<TaskProps>;
-    /** Fetches all tasks for a given entry
-     *
-     * @param params Space ID, Entry ID, Environment ID, and query parameters
-     * @returns a collection of tasks
-     * @throws if the request fails or the tasks are not found
-     * @example
-     * ```javascript
-     * const tasks = await client.task.getMany({
-     *   spaceId: '<space_id>',
-     *   entryId: '<entry_id>',
-     *   environmentId: '<environment_id>',
-     *   query: {
-     *    limit: 100,
-     *   }
-     * });
-     * ```
-     */
-    getMany(params: OptionalDefaults<GetEntryParams & QueryParams>): Promise<CollectionProp<TaskProps>>;
-    /** Creates a task
-     *
-     * @param params Space ID, Entry ID, Environment ID
-     * @param rawData the task to create
-     * @returns the created task
-     * @throws if the request fails or or the payload is malformed
-     * @example
-     * ```javascript
-     * const task = await client.task.create(
-     *   {
-     *     spaceId: '<space_id>',
-     *     entryId: '<entry_id>',
-     *     environmentId: '<environment_id>',
-     *   },
-     *   {
-     *     body: "Review Translation",
-     *     status: "active",
-     *     assignedTo: {
-     *       sys: {
-     *         type: "Link",
-     *          linkType: "User",
-     *          id: <user_id>
-     *       }
-     *     }
-     *   }
-     * );
-     * ```
-     */
-    create(params: OptionalDefaults<CreateTaskParams>, rawData: CreateTaskProps, headers?: RawAxiosRequestHeaders): Promise<TaskProps>;
-    /** Updates a task
-     *
-     * @param params Space ID, Entry ID, Environment ID, and Task ID
-     * @param rawData the task update
-     * @returns the updated task
-     * @throws if the request fails, the task is not found, or the payload is malformed
-     * @example
-     * ```javascript
-     * const task = await client.task.update(
-     *   {
-     *     spaceId: '<space_id>',
-     *     entryId: '<entry_id>',
-     *     environmentId: '<environment_id>',
-     *     taskId: '<task_id>',
-     *   },
-     *   {
-     *     body: "Review Translation",
-     *     status: "active",
-     *     assignedTo: {
-     *       sys: {
-     *         type: "Link",
-     *          linkType: "User",
-     *          id: <user_id>
-     *       }
-     *     }
-     *   }
-     * );
-     * ```
-     */
-    update(params: OptionalDefaults<UpdateTaskParams>, rawData: UpdateTaskProps, headers?: RawAxiosRequestHeaders): Promise<TaskProps>;
-    /** Deletes a task
-     *
-     * @param params Space ID, Entry ID, Environment ID, and Task ID
-     * @throws if the request fails or the task is not found
-     * @example
-     * ```javascript
-     * await client.task.delete({
-     *   spaceId: '<space_id>',
-     *   entryId: '<entry_id>',
-     *   environmentId: '<environment_id>',
-     *   taskId: '<task_id>',
-     * });
-     * ```
-     */
-    delete(params: OptionalDefaults<DeleteTaskParams>): Promise<void>;
-};

package/dist/types/plain/entities/team-membership.d.ts

@@ -1,110 +0,0 @@
-import type { RawAxiosRequestHeaders } from 'axios';
-import type { GetTeamMembershipParams, GetOrganizationParams, QueryParams, CollectionProp, GetTeamParams } from '../../common-types';
-import type { TeamMembershipProps, CreateTeamMembershipProps } from '../../export-types';
-import type { OptionalDefaults } from '../wrappers/wrap';
-export type TeamMembershipPlainClientAPI = {
-    /**
-     * Fetch a single team membership by its ID
-     * @param params the team, team-membership, and organization IDs
-     * @returns the requested team membership
-     * @throws if the request fails, or the team membership or organization are not found
-     * @example
-     * ```javascript
-     * const teamMembership = await client.teamMembership.get({
-     *   organizationId: '<organization_id>',
-     *   teamMembershipId: '<team_membership_id>'
-     * })
-     * ```
-     */
-    get(params: OptionalDefaults<GetTeamMembershipParams>): Promise<TeamMembershipProps>;
-    /**
-     * Fetch all team memberships for a given organization
-     * @param params the organization ID and optional pagination query parameters
-     * @returns A collection of team memberships
-     * @throws if the request fails, or the organization is not found
-     * @example
-     * ```javascript
-     * const teamMemberships = await client.teamMembership.getMany({
-     *   organizationId: '<organization_id>',
-     *   query: {
-     *     limit: 10,
-     *   }
-     * })
-     * ```
-     */
-    getManyForOrganization(params: OptionalDefaults<GetOrganizationParams & QueryParams>): Promise<CollectionProp<TeamMembershipProps>>;
-    /**
-     * Fetch all team memberships for a given team
-     * @param params the organization and team IDs and optional pagination query parameters
-     * @returns A collection of team memberships
-     * @throws if the request fails, or the organization or team are not found
-     * @example
-     * ```javascript
-     * const teamMemberships = await client.teamMembership.getManyForTeam({
-     *   organizationId: '<organization_id>',
-     *   teamId: '<team_id>',
-     *   query: {
-     *     limit: 10,
-     *   }
-     * })
-     * ```
-     */
-    getManyForTeam(params: OptionalDefaults<GetTeamParams & QueryParams>): Promise<CollectionProp<TeamMembershipProps>>;
-    /**
-     * Create a new team membership
-     * @param params the organization and team IDs
-     * @param rawData the organization membership ID and a flag indicating whether or not the user is an admin
-     * @returns the created team membership
-     * @throws if the request fails, or the organization or team are not found
-     * @example
-     * ```javascript
-     * const teamMembership = await client.teamMembership.create({
-     *   organizationId: '<organization_id>',
-     *   teamId: '<team_id>',
-     * }, {
-     *   admin: false,
-     *   organizationMembershipId: '<organization_membership_id>',
-     * })
-     * ```
-     */
-    create(params: OptionalDefaults<GetTeamParams>, rawData: CreateTeamMembershipProps, headers?: RawAxiosRequestHeaders): Promise<TeamMembershipProps>;
-    /**
-     * Update a team membership
-     * @param params the team, team-membership, and organization IDs
-     * @param rawData the team membership data
-     * @returns the updated team membership
-     * @throws if the request fails, or the organization, team, or team membership are not found
-     * @example
-     * ```javascript
-     * let teamMembership = await client.teamMembership.get({
-     *   organizationId: '<organization_id>',
-     *   teamId: '<team_id>',
-     *   teamMembershipId: '<team_membership_id>',
-     * })
-     *
-     * teamMembership = await client.teamMembership.update({
-     *   organizationId: '<organization_id>',
-     *   teamId: '<team_id>',
-     *   teamMembershipId: '<team_membership_id>',
-     * }, {
-     *   ...teamMembership,
-     *   admin: true,
-     * })
-     * ```
-     */
-    update(params: OptionalDefaults<GetTeamMembershipParams>, rawData: TeamMembershipProps, headers?: RawAxiosRequestHeaders): Promise<TeamMembershipProps>;
-    /**
-     * Delete a team membership
-     * @param params the team, team-membership, and organization IDs
-     * @throws if the request fails, or the organization, team, or team membership are not found
-     * @example
-     * ```javascript
-     * await client.teamMembership.delete({
-     *   organizationId: '<organization_id>',
-     *   teamId: '<team_id>',
-     *   teamMembershipId: '<team_membership_id>',
-     * })
-     * ```
-     */
-    delete(params: OptionalDefaults<GetTeamMembershipParams>): Promise<void>;
-};

package/dist/types/plain/entities/team-space-membership.d.ts

@@ -1,127 +0,0 @@
-import type { RawAxiosRequestHeaders } from 'axios';
-import type { GetTeamSpaceMembershipParams, GetSpaceParams, QueryParams, CollectionProp, GetOrganizationParams } from '../../common-types';
-import type { TeamSpaceMembershipProps, CreateTeamSpaceMembershipProps } from '../../export-types';
-import type { OptionalDefaults } from '../wrappers/wrap';
-export type TeamSpaceMembershipPlainClientAPI = {
-    /**
-     * Fetch a single team space membership by its ID
-     * @param params the team and space IDs
-     * @returns the requested team space membership
-     * @throws if the request fails, or the team space membership or space are not found
-     * @example
-     * ```javascript
-     * const teamSpaceMembership = await client.teamSpaceMembership.get({
-     *   spaceId: '<space_id>',
-     *   teamSpaceMembershipId: '<team_space_membership_id>'
-     * })
-     * ```
-     */
-    get(params: OptionalDefaults<GetTeamSpaceMembershipParams>): Promise<TeamSpaceMembershipProps>;
-    /**
-     * Fetch all team space memberships for a given space
-     * @param params the space ID and optional pagination query parameters
-     * @returns A collection of team space memberships
-     * @throws if the request fails, or the space is not found
-     * @example
-     * ```javascript
-     * const teamSpaceMemberships = await client.teamSpaceMembership.getMany({
-     *   spaceId: '<space_id>',
-     *   query: {
-     *     limit: 10,
-     *   }
-     * })
-     * ```
-     */
-    getMany(params: OptionalDefaults<GetSpaceParams & QueryParams>): Promise<CollectionProp<TeamSpaceMembershipProps>>;
-    /**
-     * Fetch a team space membership for a given organization
-     * @param params the space ID and optional pagination query parameters
-     * @returns A collection of team space memberships
-     * @throws if the request fails, or the space is not found
-     * @example
-     * ```javascript
-     * const teamSpaceMembership = await client.teamSpaceMembership.getForOrganization({
-     *   organizationId: '<organization_id>',
-     *   teamSpaceMembershipId: '<team_space_membership_id>'
-     * })
-     * ```
-     */
-    getForOrganization(params: OptionalDefaults<GetOrganizationParams & {
-        teamSpaceMembershipId: string;
-    }>): Promise<TeamSpaceMembershipProps>;
-    /**
-     * Fetch all team space memberships for a given organization
-     * @param params the organization ID and optional filter and pagination query parameters
-     * @returns A collection of team space memberships
-     * @throws if the request fails, or the organization is not found
-     * @example
-     * ```javascript
-     * const teamSpaceMemberships = await client.teamSpaceMembership.getManyForOrganization({
-     *   organizationId: '<organization_id>',
-     *   query: {
-     *     teamId: '<team_id>',
-     *     limit: 10,
-     *   }
-     * })
-     * ```
-     */
-    getManyForOrganization(params: OptionalDefaults<GetOrganizationParams & QueryParams & {
-        teamId?: string;
-    }>): Promise<CollectionProp<TeamSpaceMembershipProps>>;
-    /**
-     * Create a new team space membership
-     * @param params the space and team IDs
-     * @param rawData the role links and a flag indicating whether or not the user is an admin
-     * @returns the created team space membership
-     * @throws if the request fails, or the organization or team are not found
-     * @example
-     * ```javascript
-     * const teamSpaceMembership = await client.teamSpaceMembership.create({
-     *   organizationId: '<organization_id>',
-     *   teamId: '<team_id>',
-     * }, {
-     *   admin: false,
-     *   roles: []
-     * })
-     * ```
-     */
-    create(params: OptionalDefaults<GetSpaceParams & {
-        teamId: string;
-    }>, rawData: CreateTeamSpaceMembershipProps, headers?: RawAxiosRequestHeaders): Promise<TeamSpaceMembershipProps>;
-    /**
-     * Update a team space membership
-     * @param params the space and team space membership IDs
-     * @param rawData the team space membership data
-     * @returns the updated team space membership
-     * @throws if the request fails, or the space or team space membership are not found
-     * @example
-     * ```javascript
-     * let teamSpaceMembership = await client.teamSpaceMembership.get({
-     *   spaceId: '<space_id>',
-     *   teamSpaceMembershipId: '<team_space_membership_id>'
-     * })
-     *
-     * teamMembership = await client.teamMembership.update({
-     *   spaceId: '<space_id>',
-     *   teamSpaceMembershipId: '<team_space_membership_id>'
-     * }, {
-     *   ...teamSpaceMembership,
-     *   admin: true,
-     * })
-     * ```
-     */
-    update(params: OptionalDefaults<GetTeamSpaceMembershipParams>, rawData: TeamSpaceMembershipProps, headers?: RawAxiosRequestHeaders): Promise<TeamSpaceMembershipProps>;
-    /**
-     * Delete a team space membership
-     * @param params the space and team space membership IDs
-     * @throws if the request fails, or the space or team space membership are not found
-     * @example
-     * ```javascript
-     * await client.teamSpaceMembership.delete({
-     *   spaceId: '<space_id>',
-     *   teamSpaceMembershipId: '<team_space_membership_id>'
-     * })
-     * ```
-     */
-    delete(params: OptionalDefaults<GetTeamSpaceMembershipParams>): Promise<void>;
-};

package/dist/types/plain/entities/team.d.ts

@@ -1,105 +0,0 @@
-import type { RawAxiosRequestHeaders } from 'axios';
-import type { GetTeamParams, GetOrganizationParams, QueryParams, CollectionProp, GetSpaceParams } from '../../common-types';
-import type { TeamProps, CreateTeamProps } from '../../export-types';
-import type { OptionalDefaults } from '../wrappers/wrap';
-export type TeamPlainClientAPI = {
-    /**
-     * Fetch a single team by its ID
-     * @param params the team and organization IDs
-     * @returns the requested team
-     * @throws if the request fails, or the team or organization is not found
-     * @example
-     * ```javascript
-     * const team = await client.team.get({
-     *   organizationId: '<organization_id>',
-     *   teamId: '<team_id>'
-     * })
-     * ```
-     */
-    get(params: OptionalDefaults<GetTeamParams>): Promise<TeamProps>;
-    /**
-     * Fetch all teams for a given organization
-     * @param params the organization ID and optional pagination query parameters
-     * @returns A collection of teams
-     * @throws if the request fails, or the organization is not found
-     * @example
-     * ```javascript
-     * const teams = await client.team.getMany({
-     *   organizationId: '<organization_id>',
-     *   query: {
-     *     limit: 10,
-     *   }
-     * })
-     * ```
-     */
-    getMany(params: OptionalDefaults<GetOrganizationParams & QueryParams>): Promise<CollectionProp<TeamProps>>;
-    /**
-     * Fetch all teams for a given space
-     * @param params the space ID and optional pagination query parameters
-     * @returns A collection of teams
-     * @throws if the request fails, or the space is not found
-     * @example
-     * ```javascript
-     * const teams = await client.team.getManyForSpace({
-     *   spaceId: '<space_id>',
-     *   query: {
-     *     limit: 10,
-     *   }
-     * })
-     * ```
-     */
-    getManyForSpace(params: OptionalDefaults<GetSpaceParams & QueryParams>): Promise<CollectionProp<TeamProps>>;
-    /**
-     * Create a new team
-     * @param params the organization ID
-     * @param rawData the team name and description
-     * @returns the created team
-     * @throws if the request fails, or the organization is not found
-     * @example
-     * ```javascript
-     * const team = await client.team.create({
-     *   organizationId: '<organization_id>',
-     * }, {
-     *   name: 'My Team',
-     *   description: 'A team for my organization',
-     * })
-     * ```
-     */
-    create(params: OptionalDefaults<GetOrganizationParams>, rawData: CreateTeamProps, headers?: RawAxiosRequestHeaders): Promise<any>;
-    /**
-     * Update a team
-     * @param params the organization and team IDs
-     * @param rawData the team data
-     * @returns the updated team
-     * @throws if the request fails, or the organization or team are not found
-     * @example
-     * ```javascript
-     * let team = await client.team.get({
-     *   organizationId: '<organization_id>',
-     *   teamId: '<team_id>'
-     * })
-     *
-     * team = await client.team.update({
-     *   organizationId: '<organization_id>',
-     *   teamId: '<team_id>'
-     * }, {
-     *   ...team,
-     *   name: 'New team name',
-     * })
-     * ```
-     */
-    update(params: OptionalDefaults<GetTeamParams>, rawData: TeamProps, headers?: RawAxiosRequestHeaders): Promise<TeamProps>;
-    /**
-     * Delete a team
-     * @param params the organization and team IDs
-     * @throws if the request fails, or the organization or team are not found
-     * @example
-     * ```javascript
-     * await client.team.delete({
-     *   organizationId: '<organization_id>',
-     *   teamId: '<team_id>'
-     * })
-     * ```
-     */
-    delete(params: OptionalDefaults<GetTeamParams>): Promise<void>;
-};

package/dist/types/plain/entities/ui-config.d.ts

@@ -1,44 +0,0 @@
-import type { GetUIConfigParams } from '../../common-types';
-import type { UIConfigProps } from '../../entities/ui-config';
-import type { OptionalDefaults } from '../wrappers/wrap';
-export type UIConfigPlainClientAPI = {
-    /**
-     * Fetch the UI Config for a given Space and Environment
-     * @param params entity IDs to identify the UI Config
-     * @returns the UI Config
-     * @throws if the request fails, or the UI Config is not found
-     * @example
-     * ```javascript
-     * const uiConfig = await client.uiConfig.get({
-     *   spaceId: "<space_id>",
-     *   environmentId: "<environment_id>",
-     * });
-     * ```
-     */
-    get(params: OptionalDefaults<GetUIConfigParams>): Promise<UIConfigProps>;
-    /**
-     * Update the UI Config for a given Space and Environment
-     * @param params entity IDs to identify the UI Config
-     * @param rawData the UI Config update
-     * @returns the updated UI Config
-     * @throws if the request fails, the UI Config is not found, or the update payload is malformed
-     * @example
-     * ```javascript
-     * await client.uiConfig.update({
-     *   spaceId: "<space_id>",
-     *   environmentId: "<environment_id>",
-     * }, {
-     *   ...currentUIConfig,
-     *   entryListViews: [
-     *     ...currentUIConfig.entryListViews,
-     *     {
-     *       id: 'newFolder',
-     *       title: 'New Folder',
-     *       views: []
-     *     }
-     *   ],
-     * });
-     * ```
-     */
-    update(params: OptionalDefaults<GetUIConfigParams>, rawData: UIConfigProps): Promise<UIConfigProps>;
-};

package/dist/types/plain/entities/upload-credential.d.ts

@@ -1,38 +0,0 @@
-import type { GetSpaceEnvironmentParams, MetaSysProps } from '../../common-types';
-import type { OptionalDefaults } from '../wrappers/wrap';
-export type UploadCredential = {
-    /**
-     * System metadata
-     */
-    sys: MetaSysProps & {
-        type: 'UploadCredential';
-    };
-    /**
-     * upload credentials
-     */
-    uploadCredentials: {
-        policy: string;
-        signature: string;
-        expiresAt: string;
-        createdAt: string;
-    };
-};
-export type UploadCredentialAPI = {
-    /** Creates a Space Environment UploadCredential for Filestack Upload
-     *
-     * @param params Space Id and Environment Id to identify the Space Environment
-     * @param data the Space Environment Upload
-     * @returns the Space Environment Upload
-     * @throws if the request fails, or the Space Environment is not found
-     * @example
-     * ```javascript
-     * const credential = await client.uploadCredential.create(
-     *   {
-     *     spaceId: '<space_id>',
-     *     environmentId: '<environment_id>',
-     *   }
-     * );
-     * ```
-     */
-    create(params: OptionalDefaults<GetSpaceEnvironmentParams>): Promise<UploadCredential>;
-};

package/dist/types/plain/entities/upload.d.ts

@@ -1,56 +0,0 @@
-import type { OptionalDefaults } from '../wrappers/wrap';
-import type { GetSpaceEnvironmentParams, GetSpaceEnvironmentUploadParams } from '../../common-types';
-export type UploadPlainClientAPI = {
-    /** Fetches the Space Environment Upload
-     *
-     * @param params Upload Id, Space Id and Environment Id to identify the Space Environment Upload
-     * @returns the Space Environment Upload
-     * @throws if the request fails, or the Space Environment Upload is not found
-     * @example
-     * ```javascript
-     * const upload = await client.upload.get({
-     *   spaceId: '<space_id>',
-     *   environmentId: '<environment_id>',
-     *   uploadId: '<upload_id>',
-     * });
-     * ```
-     */
-    get(params: OptionalDefaults<GetSpaceEnvironmentUploadParams>): Promise<any>;
-    /** Creates a Space Environment Upload
-     *
-     * @param params Space Id and Environment Id to identify the Space Environment
-     * @param data the Space Environment Upload
-     * @returns the Space Environment Upload
-     * @throws if the request fails, or the Space Environment is not found
-     * @example
-     * ```javascript
-     * const file = fs.readFileSync('<path_to_file>');
-     * const upload = await client.upload.create(
-     *   {
-     *     spaceId: '<space_id>',
-     *     environmentId: '<environment_id>',
-     *   },
-     *   {
-     *     file: new ArrayBuffer(file.length),
-     *   }
-     * );
-     * ```
-     */
-    create(params: OptionalDefaults<GetSpaceEnvironmentParams>, data: {
-        file: string | ArrayBuffer | ReadableStream;
-    }): Promise<any>;
-    /** Deletes the Space Environment Upload
-     *
-     * @param params Space Id, Environment Id and Upload Id to identify the Space Environment Upload
-     * @throws if the request fails, or the Space Environment Upload is not found
-     * @example
-     * ```javascript
-     * await client.upload.delete({
-     *   spaceId: '<space_id>',
-     *   environmentId: '<environment_id>',
-     *   uploadId: '<upload_id>',
-     * });
-     * ```
-     */
-    delete(params: OptionalDefaults<GetSpaceEnvironmentUploadParams>): Promise<any>;
-};

package/dist/types/plain/entities/usage.d.ts

@@ -1,49 +0,0 @@
-import type { CollectionProp, QueryParams } from '../../common-types';
-import type { UsageProps } from '../../export-types';
-import type { OptionalDefaults } from '../wrappers/wrap';
-export type UsagePlainClientAPI = {
-    /** Fetches all of an organization's usage data by space
-     *
-     * @param params organization ID and query parameters
-     * @returns a collection of an organization's usage data
-     * @throws if the request fails or the usage data is not found
-     * @example
-     * ```javascript
-     * const usage = await client.usage.getManyForSpace({
-     *   organizationId: '<organization_id>',
-     *   {
-     *        skip: 0,
-     *        limit: 10,
-     *        'metric[in]': 'cda,gql',
-     *        'dateRange.startAt': '2020-01-05',
-     *        'dateRange.endAt': '2020-01-20'
-     *    }
-     * });
-     * ```
-     */
-    getManyForSpace(params: OptionalDefaults<{
-        organizationId: string;
-    } & QueryParams>): Promise<CollectionProp<UsageProps>>;
-    /** Fetches all an organization's usage data by organization
-     *
-     * @param params organization ID and query parameters
-     * @returns a collection of an organization's usage data
-     * @throws if the request fails or the usage data is not found
-     * @example
-     * ```javascript
-     * const usage = await client.usage.getManyForOrganization({
-     *   organizationId: '<organization_id>',
-     *   {
-     *        skip: 0,
-     *        limit: 10,
-     *        'metric[in]': 'cda,gql',
-     *        'dateRange.startAt': '2020-01-05',
-     *        'dateRange.endAt': '2020-01-20'
-     *    }
-     * });
-     * ```
-     */
-    getManyForOrganization(params: OptionalDefaults<{
-        organizationId: string;
-    } & QueryParams>): Promise<CollectionProp<UsageProps>>;
-};