contentful-management 11.60.3 → 12.0.0-beta.10

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

@@ -0,0 +1,54 @@
+import type { Except } from 'type-fest';
+import type { BasicMetaSysProps, DefaultElements, Link, MakeRequest } from '../common-types.js';
+type AppDetailsSys = Except<BasicMetaSysProps, 'version' | 'id'> & {
+    appDefinition: Link<'AppDefinition'>;
+    organization: Link<'Organization'>;
+};
+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/types/entities/app-details.js

@@ -0,0 +1,37 @@
+import copy from 'fast-copy';
+import { toPlainObject } from 'contentful-sdk-core';
+import enhanceWithMethods from '../enhance-with-methods.js';
+
+/**
+ * @private
+ * @param makeRequest - function to make requests via an adapter
+ * @return Wrapped App Details data
+ */
+function createAppDetailsApi(makeRequest) {
+    const getParams = (data) => ({
+        organizationId: data.sys.organization.sys.id,
+        appDefinitionId: data.sys.appDefinition.sys.id,
+    });
+    return {
+        delete: function del() {
+            const self = this;
+            return makeRequest({
+                entityType: 'AppDetails',
+                action: 'delete',
+                params: getParams(self),
+            });
+        },
+    };
+}
+/**
+ * @private
+ * @param http - HTTP client instance
+ * @param data - Raw AppDetails data
+ * @return Wrapped AppDetails data
+ */
+function wrapAppDetails(makeRequest, data) {
+    const appDetails = toPlainObject(copy(data));
+    return enhanceWithMethods(appDetails, createAppDetailsApi(makeRequest));
+}
+
+export { wrapAppDetails };

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

@@ -0,0 +1,50 @@
+import type { Except } from 'type-fest';
+import type { BasicMetaSysProps, DefaultElements, Link, MakeRequest } from '../common-types.js';
+type AppEventSubscriptionSys = Except<BasicMetaSysProps, 'version' | 'id'> & {
+    appDefinition: Link<'AppDefinition'>;
+    organization: Link<'Organization'>;
+};
+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/types/entities/app-event-subscription.js

@@ -0,0 +1,32 @@
+import copy from 'fast-copy';
+import { toPlainObject } from 'contentful-sdk-core';
+import enhanceWithMethods from '../enhance-with-methods.js';
+
+function createEventSubscriptionApi(makeRequest) {
+    const getParams = (data) => ({
+        organizationId: data.sys.organization.sys.id,
+        appDefinitionId: data.sys.appDefinition.sys.id,
+    });
+    return {
+        delete: function del() {
+            const self = this;
+            return makeRequest({
+                entityType: 'AppEventSubscription',
+                action: 'delete',
+                params: getParams(self),
+            });
+        },
+    };
+}
+/**
+ * @private
+ * @param http - HTTP client instance
+ * @param data - Raw AppEventSubscription data
+ * @return Wrapped AppEventSubscription data
+ */
+function wrapAppEventSubscription(makeRequest, data) {
+    const eventSubscription = toPlainObject(copy(data));
+    return enhanceWithMethods(eventSubscription, createEventSubscriptionApi(makeRequest));
+}
+
+export { wrapAppEventSubscription };

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

@@ -0,0 +1,70 @@
+import type { DefaultElements, BasicMetaSysProps, MakeRequest, Link } from '../common-types.js';
+import type { Except } from 'type-fest';
+import type { FreeFormParameters } from './widget-parameters.js';
+export type AppInstallationProps = {
+    sys: Omit<BasicMetaSysProps, 'id'> & {
+        appDefinition: Link<'AppDefinition'>;
+        environment: Link<'Environment'>;
+        space: Link<'Space'>;
+        organization: Link<'Organization'>;
+    };
+    /**
+     * 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.js").CollectionProp<AppInstallationProps>) => import("../common-types.js").Collection<AppInstallation, AppInstallationProps>;

package/dist/types/entities/app-installation.js

@@ -0,0 +1,52 @@
+import { toPlainObject, freezeSys } from 'contentful-sdk-core';
+import copy from 'fast-copy';
+import enhanceWithMethods from '../enhance-with-methods.js';
+import { wrapCollection } from '../common-utils.js';
+
+/**
+ * @private
+ */
+function createAppInstallationApi(makeRequest) {
+    const getParams = (data) => ({
+        spaceId: data.sys.space.sys.id,
+        environmentId: data.sys.environment.sys.id,
+        appDefinitionId: data.sys.appDefinition.sys.id,
+    });
+    return {
+        update: function update() {
+            const data = this.toPlainObject();
+            return makeRequest({
+                entityType: 'AppInstallation',
+                action: 'upsert',
+                params: getParams(data),
+                headers: {},
+                payload: data,
+            }).then((data) => wrapAppInstallation(makeRequest, data));
+        },
+        delete: function del() {
+            const data = this.toPlainObject();
+            return makeRequest({
+                entityType: 'AppInstallation',
+                action: 'delete',
+                params: getParams(data),
+            });
+        },
+    };
+}
+/**
+ * @private
+ * @param makeRequest - function to make requests via an adapter
+ * @param data - Raw App Installation data
+ * @return Wrapped App installation data
+ */
+function wrapAppInstallation(makeRequest, data) {
+    const appInstallation = toPlainObject(copy(data));
+    const appInstallationWithMethods = enhanceWithMethods(appInstallation, createAppInstallationApi(makeRequest));
+    return freezeSys(appInstallationWithMethods);
+}
+/**
+ * @private
+ */
+const wrapAppInstallationCollection = wrapCollection(wrapAppInstallation);
+
+export { wrapAppInstallation, wrapAppInstallationCollection };

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

@@ -0,0 +1,77 @@
+import type { Except } from 'type-fest';
+import type { BasicMetaSysProps, DefaultElements, Link, MakeRequest } from '../common-types.js';
+type AppKeySys = Except<BasicMetaSysProps, 'version'> & {
+    appDefinition: Link<'AppDefinition'>;
+    organization: Link<'Organization'>;
+};
+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.js").CollectionProp<AppKeyProps>) => import("../common-types.js").Collection<AppKey, AppKeyProps>;
+export {};

package/dist/types/entities/app-key.js

@@ -0,0 +1,41 @@
+import copy from 'fast-copy';
+import { toPlainObject } from 'contentful-sdk-core';
+import enhanceWithMethods from '../enhance-with-methods.js';
+import { wrapCollection } from '../common-utils.js';
+
+function createKeyApi(makeRequest) {
+    const getParams = (data) => ({
+        organizationId: data.sys.organization.sys.id,
+        appDefinitionId: data.sys.appDefinition.sys.id,
+        fingerprint: data.sys.id,
+    });
+    return {
+        delete: function del() {
+            const self = this;
+            return makeRequest({
+                entityType: 'AppKey',
+                action: 'delete',
+                params: getParams(self),
+            });
+        },
+    };
+}
+/**
+ * @private
+ * @param http - HTTP client instance
+ * @param data - Raw AppKey data
+ * @return Wrapped AppKey data
+ */
+function wrapAppKey(makeRequest, data) {
+    const key = toPlainObject(copy(data));
+    return enhanceWithMethods(key, createKeyApi(makeRequest));
+}
+/**
+ * @private
+ * @param makeRequest - function to make requests via an adapter
+ * @param data - Raw App Key collection data
+ * @return Wrapped App Key collection data
+ */
+const wrapAppKeyCollection = wrapCollection(wrapAppKey);
+
+export { wrapAppKey, wrapAppKeyCollection };

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

@@ -0,0 +1,42 @@
+import type { Except } from 'type-fest';
+import type { BasicMetaSysProps, DefaultElements, Link, MakeRequest } from '../common-types.js';
+type AppSignedRequestSys = Except<BasicMetaSysProps, 'version' | 'id'> & {
+    appDefinition: Link<'AppDefinition'>;
+    space: Link<'Space'>;
+    environment: Link<'Environment'>;
+};
+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/types/entities/app-signed-request.js

@@ -0,0 +1,15 @@
+import copy from 'fast-copy';
+import { toPlainObject } from 'contentful-sdk-core';
+
+/**
+ * @private
+ * @param http - HTTP client instance
+ * @param data - Raw AppSignedRequest data
+ * @return Wrapped AppSignedRequest data
+ */
+function wrapAppSignedRequest(_makeRequest, data) {
+    const signedRequest = toPlainObject(copy(data));
+    return signedRequest;
+}
+
+export { wrapAppSignedRequest };

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

@@ -0,0 +1,45 @@
+import type { Except } from 'type-fest';
+import type { BasicMetaSysProps, DefaultElements, Link, MakeRequest } from '../common-types.js';
+type AppSigningSecretSys = Except<BasicMetaSysProps, 'version' | 'id'> & {
+    appDefinition: Link<'AppDefinition'>;
+    organization: Link<'Organization'>;
+};
+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/types/entities/app-signing-secret.js

@@ -0,0 +1,32 @@
+import copy from 'fast-copy';
+import { toPlainObject } from 'contentful-sdk-core';
+import enhanceWithMethods from '../enhance-with-methods.js';
+
+function createSigningSecretApi(makeRequest) {
+    const getParams = (data) => ({
+        organizationId: data.sys.organization.sys.id,
+        appDefinitionId: data.sys.appDefinition.sys.id,
+    });
+    return {
+        delete: function del() {
+            const self = this;
+            return makeRequest({
+                entityType: 'AppSigningSecret',
+                action: 'delete',
+                params: getParams(self),
+            });
+        },
+    };
+}
+/**
+ * @private
+ * @param http - HTTP client instance
+ * @param data - Raw AppSigningSecret data
+ * @return Wrapped AppSigningSecret data
+ */
+function wrapAppSigningSecret(makeRequest, data) {
+    const signingSecret = toPlainObject(copy(data));
+    return enhanceWithMethods(signingSecret, createSigningSecretApi(makeRequest));
+}
+
+export { wrapAppSigningSecret };

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

@@ -0,0 +1,44 @@
+import type { Except } from 'type-fest';
+import type { BasicMetaSysProps, DefaultElements, MakeRequest, Link } from '../common-types.js';
+type AppUploadSys = Except<BasicMetaSysProps, 'version'>;
+export type AppUploadProps = {
+    sys: AppUploadSys & {
+        expiresAt: string;
+        organization: Link<'Organization'>;
+    };
+};
+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.js").CollectionProp<AppUploadProps>) => import("../common-types.js").Collection<AppUpload, AppUploadProps>;
+export {};

package/dist/types/entities/app-upload.js

@@ -0,0 +1,36 @@
+import { toPlainObject, freezeSys } from 'contentful-sdk-core';
+import copy from 'fast-copy';
+import enhanceWithMethods from '../enhance-with-methods.js';
+
+/**
+ * @private
+ */
+function createAppUploadApi(makeRequest) {
+    const getParams = (data) => ({
+        organizationId: data.sys.organization.sys.id,
+        appUploadId: data.sys.id,
+    });
+    return {
+        delete: function del() {
+            const data = this.toPlainObject();
+            return makeRequest({
+                entityType: 'AppUpload',
+                action: 'delete',
+                params: getParams(data),
+            });
+        },
+    };
+}
+/**
+ * @private
+ * @param makeRequest - function to make requests via an adapter
+ * @param data - Raw App Upload data
+ * @return Wrapped App Upload data
+ */
+function wrapAppUpload(makeRequest, data) {
+    const appUpload = toPlainObject(copy(data));
+    const appUploadWithMethods = enhanceWithMethods(appUpload, createAppUploadApi(makeRequest));
+    return freezeSys(appUploadWithMethods);
+}
+
+export { wrapAppUpload };

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

@@ -0,0 +1,20 @@
+import type { DefaultElements, MakeRequest } from '../common-types.js';
+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;

package/dist/types/entities/asset-key.js

@@ -0,0 +1,15 @@
+import copy from 'fast-copy';
+import { toPlainObject } from 'contentful-sdk-core';
+
+/**
+ * @private
+ * @param http - HTTP client instance
+ * @param data - Raw asset key data
+ * @return Wrapped asset key data
+ */
+function wrapAssetKey(_makeRequest, data) {
+    const assetKey = toPlainObject(copy(data));
+    return assetKey;
+}
+
+export { wrapAssetKey };