contentful-management 11.60.3 → 12.0.0-beta.10

package/dist/typings/entities/app-bundle.d.ts

@@ -1,86 +0,0 @@
-import type { Except } from 'type-fest';
-import type { BasicMetaSysProps, DefaultElements, MakeRequest, SysLink } from '../common-types';
-type AppBundleSys = Except<BasicMetaSysProps, 'version'> & {
-    appDefinition: SysLink;
-    organization: SysLink;
-};
-interface ActionManifestProps {
-    id?: string;
-    name: string;
-    description: string;
-    category: string;
-    path: string;
-    allowNetworks?: string[];
-}
-interface FunctionManifestProps {
-    id: string;
-    name: string;
-    description: string;
-    path: string;
-    accepts?: string[];
-    allowNetworks?: string[];
-}
-export type AppBundleFile = {
-    name: string;
-    size: number;
-    md5: string;
-};
-export type CreateAppBundleProps = {
-    appUploadId: string;
-    comment?: string;
-    actions?: ActionManifestProps[];
-    functions?: FunctionManifestProps[];
-};
-export type AppBundleProps = {
-    /**
-     * System metadata
-     */
-    sys: AppBundleSys;
-    /**
-     * List of all the files that are in this bundle
-     */
-    files: AppBundleFile[];
-    /**
-     * A comment that describes this bundle
-     */
-    comment?: string;
-    /**
-     * List of all functions in the bundle
-     */
-    functions?: FunctionManifestProps[];
-};
-export interface AppBundle extends AppBundleProps, DefaultElements<AppBundleProps> {
-    /**
-     * 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('<org_id>')
-     * .then((org) => org.getAppDefinition('<app_def_id>'))
-     * .then((appDefinition) => appDefinition.getAppBundle('<app-bundle-id>'))
-     * .then((appBundle) => appBundle.delete())
-     * .catch(console.error)
-     * ```
-     */
-    delete(): Promise<void>;
-}
-/**
- * @private
- * @param makeRequest - function to make requests via an adapter
- * @param data - Raw App Bundle data
- * @return Wrapped App Bundle data
- */
-export declare function wrapAppBundle(makeRequest: MakeRequest, data: AppBundleProps): AppBundle;
-/**
- * @private
- * @param makeRequest - function to make requests via an adapter
- * @param data - Raw App Bundle collection data
- * @return Wrapped App Bundle collection data
- */
-export declare const wrapAppBundleCollection: (makeRequest: MakeRequest, data: import("../common-types").CollectionProp<AppBundleProps>) => import("../common-types").Collection<AppBundle, AppBundleProps>;
-export {};

package/dist/typings/entities/app-definition.d.ts

@@ -1,82 +0,0 @@
-import type { DefaultElements, BasicMetaSysProps, SysLink, MakeRequest, Link } from '../common-types';
-import type { ContentfulAppDefinitionAPI } from '../create-app-definition-api';
-import type { SetOptional, Except } from 'type-fest';
-import type { FieldType } from './field-type';
-import type { InstallationParameterType, ParameterDefinition } from './widget-parameters';
-import type { AppInstallationProps } from './app-installation';
-import type { EnvironmentProps } from './environment';
-export interface NavigationItem {
-    name: string;
-    path: string;
-}
-type LocationType = 'app-config' | 'entry-sidebar' | 'entry-editor' | 'dialog' | 'page' | 'home';
-export interface SimpleLocation {
-    location: LocationType;
-}
-export interface EntryFieldLocation {
-    location: 'entry-field';
-    fieldTypes: FieldType[];
-}
-export interface PageLocation {
-    location: 'page';
-    navigationItem?: NavigationItem;
-}
-export type AppLocation = SimpleLocation | EntryFieldLocation | PageLocation;
-export type AppDefinitionProps = {
-    /**
-     * System metadata
-     */
-    sys: BasicMetaSysProps & {
-        organization: SysLink;
-        shared: boolean;
-    };
-    /**
-     * App name
-     */
-    name: string;
-    /**
-     * URL where the root HTML document of the app can be found
-     */
-    src?: string;
-    /**
-     * Link to an AppBundle
-     */
-    bundle?: Link<'AppBundle'>;
-    /**
-     * Locations where the app can be installed
-     */
-    locations?: AppLocation[];
-    /**
-     * Instance parameter definitions
-     */
-    parameters?: {
-        instance?: ParameterDefinition[];
-        installation?: ParameterDefinition<InstallationParameterType>[];
-    };
-};
-export type CreateAppDefinitionProps = SetOptional<Except<AppDefinitionProps, 'sys' | 'bundle'>, 'src' | 'locations'>;
-export type AppDefinition = ContentfulAppDefinitionAPI & AppDefinitionProps & DefaultElements<AppDefinitionProps>;
-export type AppInstallationsForOrganizationProps = {
-    sys: {
-        type: 'Array';
-    };
-    items: AppInstallationProps[];
-    includes: {
-        Environment: EnvironmentProps[];
-    };
-};
-/**
- * @private
- * @param makeRequest - function to make requests via an adapter
- * @param data - Raw App Definition data
- * @return Wrapped App Definition data
- */
-export declare function wrapAppDefinition(makeRequest: MakeRequest, data: AppDefinitionProps): AppDefinition;
-/**
- * @private
- * @param makeRequest - function to make requests via an adapter
- * @param data - Raw App Definition collection data
- * @return Wrapped App Definition collection data
- */
-export declare const wrapAppDefinitionCollection: (makeRequest: MakeRequest, data: import("../common-types").CollectionProp<AppDefinitionProps>) => import("../common-types").Collection<AppDefinition, AppDefinitionProps>;
-export {};

package/dist/typings/entities/app-details.d.ts

@@ -1,54 +0,0 @@
-import type { Except } from 'type-fest';
-import type { BasicMetaSysProps, DefaultElements, MakeRequest, SysLink } from '../common-types';
-type AppDetailsSys = Except<BasicMetaSysProps, 'version' | 'id'> & {
-    appDefinition: SysLink;
-    organization: SysLink;
-};
-export type IconType = 'base64';
-export interface AppIcon {
-    value: string;
-    type: IconType;
-}
-export type AppDetailsProps = {
-    /**
-     * System metadata
-     */
-    sys: AppDetailsSys;
-    /**
-     * An Icon that represents the App
-     */
-    icon?: AppIcon;
-};
-export type CreateAppDetailsProps = {
-    /**
-     * An Icon that represents the App
-     */
-    icon?: AppIcon;
-};
-export interface AppDetails extends AppDetailsProps, DefaultElements<AppDetailsProps> {
-    /**
-     * 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((organization) => organization.getAppDetails(<app-id>))
-     * .then((appDetails) => appDetails.delete())
-     * .then(() => console.log('appDetails deleted'))
-     * .catch(console.error)
-     * ```
-     */
-    delete(): Promise<void>;
-}
-/**
- * @private
- * @param http - HTTP client instance
- * @param data - Raw AppDetails data
- * @return Wrapped AppDetails data
- */
-export declare function wrapAppDetails(makeRequest: MakeRequest, data: AppDetailsProps): AppDetails;
-export {};

package/dist/typings/entities/app-event-subscription.d.ts

@@ -1,50 +0,0 @@
-import type { Except } from 'type-fest';
-import type { BasicMetaSysProps, DefaultElements, Link, MakeRequest, SysLink } from '../common-types';
-type AppEventSubscriptionSys = Except<BasicMetaSysProps, 'version' | 'id'> & {
-    appDefinition: SysLink;
-    organization: SysLink;
-};
-export type AppEventSubscriptionProps = {
-    /**
-     * System metadata
-     */
-    sys: AppEventSubscriptionSys;
-    /** Subscription url that will receive events */
-    targetUrl?: string;
-    /** List of topics to subscribe to */
-    topics: string[];
-    /** Optional filter, transformation, or handler function */
-    functions?: {
-        filter?: Link<'Function'>;
-        transformation?: Link<'Function'>;
-        handler?: Link<'Function'>;
-    };
-};
-export type CreateAppEventSubscriptionProps = Except<AppEventSubscriptionProps, 'sys'>;
-export interface AppEventSubscription extends AppEventSubscriptionProps, DefaultElements<AppEventSubscriptionProps> {
-    /**
-     * 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((organization) => organization.getAppEventSubscription(<app-definition-id>))
-     * .then((eventSubscription) => eventSubscription.delete())
-     * .then(() => console.log('eventSubscription deleted'))
-     * .catch(console.error)
-     * ```
-     */
-    delete(): Promise<void>;
-}
-/**
- * @private
- * @param http - HTTP client instance
- * @param data - Raw AppEventSubscription data
- * @return Wrapped AppEventSubscription data
- */
-export declare function wrapAppEventSubscription(makeRequest: MakeRequest, data: AppEventSubscriptionProps): AppEventSubscription;
-export {};

package/dist/typings/entities/app-installation.d.ts

@@ -1,70 +0,0 @@
-import type { DefaultElements, BasicMetaSysProps, SysLink, MakeRequest } from '../common-types';
-import type { Except } from 'type-fest';
-import type { FreeFormParameters } from './widget-parameters';
-export type AppInstallationProps = {
-    sys: Omit<BasicMetaSysProps, 'id'> & {
-        appDefinition: SysLink;
-        environment: SysLink;
-        space: SysLink;
-        organization: SysLink;
-    };
-    /**
-     * Free-form installation parameters (API limits stringified length to 32KB)
-     */
-    parameters?: FreeFormParameters;
-};
-export type CreateAppInstallationProps = Except<AppInstallationProps, 'sys'>;
-export interface AppInstallation extends AppInstallationProps, DefaultElements<AppInstallationProps> {
-    /**
-     * 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.getEnvironment('<environment_id>'))
-     * .then((environment) => environment.getAppInstallation('<app_definition_id>'))
-     * .then((appInstallation) => {
-     *    appInstallation.parameters.someParameter = 'New Value'
-     *    return appInstallation.update()
-     * })
-     * .then((appInstallation) => console.log(`App installation ${appInstallation.sys.id} was updated`))
-     * .catch(console.error)
-     * ```
-     */
-    update(): Promise<AppInstallation>;
-    /**
-     * 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.getEnvironment('<environment_id>'))
-     * .then((environment) => environment.getAppInstallation('<app_definition_id>'))
-     * .then((appInstallation) => appInstallation.delete())
-     * .then(() => console.log(`App installation deleted.`))
-     * .catch(console.error)
-     * ```
-     */
-    delete(): Promise<void>;
-}
-/**
- * @private
- * @param makeRequest - function to make requests via an adapter
- * @param data - Raw App Installation data
- * @return Wrapped App installation data
- */
-export declare function wrapAppInstallation(makeRequest: MakeRequest, data: AppInstallationProps): AppInstallation;
-/**
- * @private
- */
-export declare const wrapAppInstallationCollection: (makeRequest: MakeRequest, data: import("../common-types").CollectionProp<AppInstallationProps>) => import("../common-types").Collection<AppInstallation, AppInstallationProps>;

package/dist/typings/entities/app-key.d.ts

@@ -1,77 +0,0 @@
-import type { Except } from 'type-fest';
-import type { BasicMetaSysProps, DefaultElements, MakeRequest, SysLink } from '../common-types';
-type AppKeySys = Except<BasicMetaSysProps, 'version'> & {
-    appDefinition: SysLink;
-    organization: SysLink;
-};
-export interface JWK {
-    alg: 'RS256';
-    kty: 'RSA';
-    use: 'sig';
-    x5c: [string];
-    kid: string;
-    x5t: string;
-}
-export type AppKeyProps = {
-    /**
-     * System metadata
-     */
-    sys: AppKeySys;
-    /**
-     * JSON Web Key
-     */
-    jwk: JWK;
-    /**
-     * If generated, private key is returned
-     */
-    generated?: {
-        /**
-         * Base64 PEM
-         */
-        privateKey: string;
-    };
-};
-export type CreateAppKeyProps = {
-    /**
-     * Toggle for automatic private key generation
-     */
-    generate?: boolean;
-    /**
-     * JSON Web Key, required if generate is falsy
-     */
-    jwk?: JWK;
-};
-export interface AppKey extends AppKeyProps, DefaultElements<AppKeyProps> {
-    /**
-     * 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((organization) => organization.getAppKey(<api-key-id>))
-     * .then((signingSecret) => signingSecret.delete())
-     * .then(() => console.log('signingSecret deleted'))
-     * .catch(console.error)
-     * ```
-     */
-    delete(): Promise<void>;
-}
-/**
- * @private
- * @param http - HTTP client instance
- * @param data - Raw AppKey data
- * @return Wrapped AppKey data
- */
-export declare function wrapAppKey(makeRequest: MakeRequest, data: AppKeyProps): AppKey;
-/**
- * @private
- * @param makeRequest - function to make requests via an adapter
- * @param data - Raw App Key collection data
- * @return Wrapped App Key collection data
- */
-export declare const wrapAppKeyCollection: (makeRequest: MakeRequest, data: import("../common-types").CollectionProp<AppKeyProps>) => import("../common-types").Collection<AppKey, AppKeyProps>;
-export {};

package/dist/typings/entities/app-signed-request.d.ts

@@ -1,42 +0,0 @@
-import type { Except } from 'type-fest';
-import type { BasicMetaSysProps, DefaultElements, MakeRequest, SysLink } from '../common-types';
-type AppSignedRequestSys = Except<BasicMetaSysProps, 'version' | 'id'> & {
-    appDefinition: SysLink;
-    space: SysLink;
-    environment: SysLink;
-};
-export type AppSignedRequestProps = {
-    /**
-     * System metadata
-     */
-    sys: AppSignedRequestSys;
-    /** new headers to be included in the request */
-    additionalHeaders: {
-        'x-contentful-signature': string;
-        'x-contentful-signed-headers': string;
-        'x-contentful-timestamp': string;
-        'x-contentful-space-id': string;
-        'x-contentful-environment-id': string;
-        'x-contentful-user-id': string;
-    };
-};
-export type CreateAppSignedRequestProps = {
-    /** the request method */
-    method: 'GET' | 'PUT' | 'POST' | 'DELETE' | 'PATCH' | 'HEAD';
-    /** the path of the request method */
-    path: string;
-    /** optional stringified body of the request */
-    body?: string;
-    /** optional headers of the request */
-    headers?: Record<string, string>;
-};
-export interface AppSignedRequest extends AppSignedRequestProps, DefaultElements<AppSignedRequestProps> {
-}
-/**
- * @private
- * @param http - HTTP client instance
- * @param data - Raw AppSignedRequest data
- * @return Wrapped AppSignedRequest data
- */
-export declare function wrapAppSignedRequest(_makeRequest: MakeRequest, data: AppSignedRequestProps): AppSignedRequest;
-export {};

package/dist/typings/entities/app-signing-secret.d.ts

@@ -1,45 +0,0 @@
-import type { Except } from 'type-fest';
-import type { BasicMetaSysProps, DefaultElements, MakeRequest, SysLink } from '../common-types';
-type AppSigningSecretSys = Except<BasicMetaSysProps, 'version' | 'id'> & {
-    appDefinition: SysLink;
-    organization: SysLink;
-};
-export type AppSigningSecretProps = {
-    /**
-     * System metadata
-     */
-    sys: AppSigningSecretSys;
-    /** The last four characters of the signing secret */
-    redactedValue: string;
-};
-export type CreateAppSigningSecretProps = {
-    /** A 64 character matching the regular expression /^[0-9a-zA-Z+/=_-]+$/  */
-    value: string;
-};
-export interface AppSigningSecret extends AppSigningSecretProps, DefaultElements<AppSigningSecretProps> {
-    /**
-     * 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((organization) => organization.getAppSigningSecret(<api-key-id>))
-     * .then((signingSecret) => signingSecret.delete())
-     * .then(() => console.log('signingSecret deleted'))
-     * .catch(console.error)
-     * ```
-     */
-    delete(): Promise<void>;
-}
-/**
- * @private
- * @param http - HTTP client instance
- * @param data - Raw AppSigningSecret data
- * @return Wrapped AppSigningSecret data
- */
-export declare function wrapAppSigningSecret(makeRequest: MakeRequest, data: AppSigningSecretProps): AppSigningSecret;
-export {};

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

@@ -1,44 +0,0 @@
-import type { Except } from 'type-fest';
-import type { BasicMetaSysProps, SysLink, DefaultElements, MakeRequest } from '../common-types';
-type AppUploadSys = Except<BasicMetaSysProps, 'version'>;
-export type AppUploadProps = {
-    sys: AppUploadSys & {
-        expiresAt: string;
-        organization: SysLink;
-    };
-};
-export interface AppUpload extends AppUploadProps, DefaultElements<AppUploadProps> {
-    /**
-     * 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('<org_id>')
-     * .then((org) => org.getAppUpload('<app_upload_id>'))
-     * .then((appUpload) => appUpload.delete())
-     * .then(() => console.log(`App Upload deleted.`))
-     * .catch(console.error)
-     * ```
-     */
-    delete(): Promise<void>;
-}
-/**
- * @private
- * @param makeRequest - function to make requests via an adapter
- * @param data - Raw App Upload data
- * @return Wrapped App Upload data
- */
-export declare function wrapAppUpload(makeRequest: MakeRequest, data: AppUploadProps): AppUpload;
-/**
- * @private
- * @param makeRequest - function to make requests via an adapter
- * @param data - Raw App Upload collection data
- * @return Wrapped App Upload collection data
- */
-export declare const wrapAppUploadCollection: (makeRequest: MakeRequest, data: import("../common-types").CollectionProp<AppUploadProps>) => import("../common-types").Collection<AppUpload, AppUploadProps>;
-export {};

package/dist/typings/entities/asset-key.d.ts

@@ -1,20 +0,0 @@
-import type { DefaultElements, MakeRequest } from '../common-types';
-export type AssetKeyProps = {
-    /** A JWT describing a policy; needs to be attached to signed URLs */
-    policy: string;
-    /** A secret key to be used for signing URLs */
-    secret: string;
-};
-export type CreateAssetKeyProps = {
-    /** (required) UNIX timestamp in the future (but not more than 48 hours from now) */
-    expiresAt: number;
-};
-export interface AssetKey extends AssetKeyProps, DefaultElements<AssetKeyProps> {
-}
-/**
- * @private
- * @param http - HTTP client instance
- * @param data - Raw asset key data
- * @return Wrapped asset key data
- */
-export declare function wrapAssetKey(_makeRequest: MakeRequest, data: AssetKeyProps): AssetKey;