contentful-management 11.49.0-beta.1 → 11.49.0

package/dist/es-modules/adapters/REST/endpoints/ai-action-invocation.js

@@ -0,0 +1,6 @@
+import * as raw from './raw';
+export const get = (http, params, headers) => {
+  return raw.get(http, `/spaces/${params.spaceId}/environments/${params.environmentId}/ai/actions/${params.aiActionId}/invocations/${params.invocationId}`, {
+    headers
+  });
+};

package/dist/es-modules/adapters/REST/endpoints/ai-action.js

@@ -0,0 +1,61 @@
+const _excluded = ["sys"];
+function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
+function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+function _defineProperty(e, r, t) { return (r = _toPropertyKey(r)) in e ? Object.defineProperty(e, r, { value: t, enumerable: !0, configurable: !0, writable: !0 }) : e[r] = t, e; }
+function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == typeof i ? i : i + ""; }
+function _toPrimitive(t, r) { if ("object" != typeof t || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != typeof i) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
+function _objectWithoutProperties(e, t) { if (null == e) return {}; var o, r, i = _objectWithoutPropertiesLoose(e, t); if (Object.getOwnPropertySymbols) { var n = Object.getOwnPropertySymbols(e); for (r = 0; r < n.length; r++) o = n[r], -1 === t.indexOf(o) && {}.propertyIsEnumerable.call(e, o) && (i[o] = e[o]); } return i; }
+function _objectWithoutPropertiesLoose(r, e) { if (null == r) return {}; var t = {}; for (var n in r) if ({}.hasOwnProperty.call(r, n)) { if (-1 !== e.indexOf(n)) continue; t[n] = r[n]; } return t; }
+import copy from 'fast-copy';
+import * as raw from './raw';
+export const get = (http, params, headers) => {
+  return raw.get(http, `/spaces/${params.spaceId}/ai/actions/${params.aiActionId}`, {
+    headers
+  });
+};
+export const getMany = (http, params, headers) => {
+  return raw.get(http, `/spaces/${params.spaceId}/ai/actions`, {
+    params: params.query,
+    headers
+  });
+};
+export const create = (http, params, data, headers) => {
+  return raw.post(http, `/spaces/${params.spaceId}/ai/actions`, data, {
+    headers
+  });
+};
+export const update = (http, params, rawData, headers) => {
+  var _rawData$sys$version;
+  const data = copy(rawData);
+  const {
+      sys
+    } = data,
+    payload = _objectWithoutProperties(data, _excluded);
+  return raw.put(http, `/spaces/${params.spaceId}/ai/actions/${params.aiActionId}`, payload, {
+    headers: _objectSpread({
+      'X-Contentful-Version': (_rawData$sys$version = rawData.sys.version) !== null && _rawData$sys$version !== void 0 ? _rawData$sys$version : 0
+    }, headers)
+  });
+};
+export const del = (http, params, headers) => {
+  return raw.del(http, `/spaces/${params.spaceId}/ai/actions/${params.aiActionId}`, {
+    headers
+  });
+};
+export const publish = (http, params, rawData, headers) => {
+  return raw.put(http, `/spaces/${params.spaceId}/ai/actions/${params.aiActionId}/published`, null, {
+    headers: _objectSpread({
+      'X-Contentful-Version': rawData.sys.version
+    }, headers)
+  });
+};
+export const unpublish = (http, params, headers) => {
+  return raw.del(http, `/spaces/${params.spaceId}/ai/actions/${params.aiActionId}/published`, {
+    headers
+  });
+};
+export const invoke = (http, params, data, headers) => {
+  return raw.post(http, `/spaces/${params.spaceId}/environments/${params.environmentId}/ai/actions/${params.aiActionId}/invoke`, data, {
+    headers
+  });
+};

package/dist/es-modules/adapters/REST/endpoints/index.js

@@ -1,3 +1,5 @@
+import * as AiAction from './ai-action';
+import * as AiActionInvocation from './ai-action-invocation';
 import * as AccessToken from './access-token';
 import * as ApiKey from './api-key';
 import * as AppAccessToken from './app-access-token';
@@ -63,6 +65,8 @@ import * as Workflow from './workflow';
 import * as WorkflowDefinition from './workflow-definition';
 import * as WorkflowsChangelog from './workflows-changelog';
 export default {
+  AiAction,
+  AiActionInvocation,
   ApiKey,
   AppAction,
   AppActionCall,

package/dist/es-modules/adapters/REST/make-request.js

@@ -22,11 +22,7 @@ export const makeRequest = async ({
   if (endpoint === undefined) {
     throw new Error('Unknown endpoint');
   }
-  const response = await endpoint(axiosInstance, params, payload, _objectSpread(_objectSpread({}, headers), userAgent ? {
+  return await endpoint(axiosInstance, params, payload, _objectSpread(_objectSpread({}, headers), userAgent ? {
     'X-Contentful-User-Agent': userAgent
   } : {}));
-  if (response instanceof ReadableStream) {
-    return await new Response(response).json();
-  }
-  return response;
 };

package/dist/es-modules/contentful-management.js

@@ -47,7 +47,7 @@ function createClient(params, opts = {}) {
   const sdkMain = opts.type === 'plain' ? 'contentful-management-plain.js' : 'contentful-management.js';
   const userAgent = getUserAgentHeader(
   // @ts-expect-error
-  `${sdkMain}/${"11.49.0-beta.1"}`, params.application, params.integration, params.feature);
+  `${sdkMain}/${"11.49.0"}`, params.application, params.integration, params.feature);
   const adapter = createAdapter(_objectSpread(_objectSpread({}, params), {}, {
     userAgent
   }));

package/dist/es-modules/create-environment-api.js

@@ -16,6 +16,7 @@ import { wrapUserUIConfig } from './entities/user-ui-config';
 import { wrapEnvironmentTemplateInstallationCollection } from './entities/environment-template-installation';
 import { wrapFunctionCollection } from './entities/function';
 import { wrapFunctionLog, wrapFunctionLogCollection } from './entities/function-log';
+import { wrapAiActionInvocation } from './entities/ai-action-invocation';
 
 /**
  * @private
@@ -2459,6 +2460,66 @@ export default function createEnvironmentApi(makeRequest) {
           resourceTypeId
         }
       }).then(data => wrapResourceCollection(makeRequest, data));
+    },
+    /**
+     * Invokes an AI Action.
+     * @param aiActionId - The ID of the AI Action to invoke.
+     * @param payload - The invocation payload.
+     * @returns Promise for an AI Action Invocation.
+     * @example ```javascript
+     * client.getSpace('<space_id>')
+     *   .then(space => space.getEnvironment('<environment_id>'))
+     *   .then(environment => environment.invokeAiAction('<ai_action_id>', {
+     *     variables: [  ...  ],
+     *     outputFormat: 'RichText'
+     *   }))
+     *   .then(invocation => console.log(invocation))
+     *   .catch(console.error)
+     * ```
+     */
+    invokeAiAction(aiActionId, payload) {
+      const raw = this.toPlainObject();
+      return makeRequest({
+        entityType: 'AiAction',
+        action: 'invoke',
+        params: {
+          spaceId: raw.sys.space.sys.id,
+          environmentId: raw.sys.id,
+          aiActionId
+        },
+        payload
+      }).then(data => wrapAiActionInvocation(makeRequest, data));
+    },
+    /**
+     * Retrieves an AI Action Invocation.
+     * @param params - Object containing the AI Action ID and the Invocation ID.
+     * @returns Promise for an AI Action Invocation.
+     * @example ```javascript
+     * client.getSpace('<space_id>')
+     *   .then(space => space.getEnvironment('<environment_id>'))
+     *   .then(environment => environment.getAiActionInvocation({
+     *      aiActionId: '<ai_action_id>',
+     *      invocationId: '<invocation_id>'
+     *   }))
+     *   .then(invocation => console.log(invocation))
+     *   .catch(console.error)
+     * ```
+     */
+    getAiActionInvocation({
+      aiActionId,
+      invocationId
+    }) {
+      const raw = this.toPlainObject();
+      return makeRequest({
+        entityType: 'AiActionInvocation',
+        action: 'get',
+        params: {
+          spaceId: raw.sys.space.sys.id,
+          environmentId: raw.sys.id,
+          aiActionId,
+          invocationId
+        }
+      }).then(data => wrapAiActionInvocation(makeRequest, data));
     }
   };
 }

package/dist/es-modules/create-space-api.js

@@ -67,6 +67,14 @@ export default function createSpaceApi(makeRequest) {
     wrapScheduledAction,
     wrapScheduledActionCollection
   } = entities.scheduledAction;
+  const {
+    wrapAiAction,
+    wrapAiActionCollection
+  } = entities.aiAction;
+  const {
+    wrapAiActionInvocation,
+    wrapAiActionInvocationCollection
+  } = entities.aiActionInvocation;
   return {
     /**
      * Deletes the space
@@ -1560,6 +1568,184 @@ export default function createSpaceApi(makeRequest) {
           scheduledActionId
         }
       }).then(response => wrapScheduledAction(makeRequest, response));
+    },
+    /**
+     * Gets a single AI Action.
+     * @param aiActionId - AI Action ID
+     * @return Promise for an AI Action
+     * @example
+     * ```javascript
+     * client.getSpace('<space_id>')
+     *   .then((space) => space.getAiAction('<ai_action_id>'))
+     *   .then((aiAction) => console.log(aiAction))
+     *   .catch(console.error)
+     * ```
+     */
+    getAiAction(aiActionId) {
+      const raw = this.toPlainObject();
+      return makeRequest({
+        entityType: 'AiAction',
+        action: 'get',
+        params: {
+          spaceId: raw.sys.id,
+          aiActionId
+        }
+      }).then(data => wrapAiAction(makeRequest, data));
+    },
+    /**
+     * Gets a collection of AI Actions.
+     * @param query - Object with search parameters.
+     * @return Promise for a collection of AI Actions
+     * @example
+     * ```javascript
+     * client.getSpace('<space_id>')
+     *   .then((space) => space.getAiActions({ limit: 10 }))
+     *   .then((response) => console.log(response.items))
+     *   .catch(console.error)
+     * ```
+     */
+    getAiActions(query = {}) {
+      const raw = this.toPlainObject();
+      return makeRequest({
+        entityType: 'AiAction',
+        action: 'getMany',
+        params: {
+          spaceId: raw.sys.id,
+          query
+        }
+      }).then(data => wrapAiActionCollection(makeRequest, data));
+    },
+    /**
+     * Creates an AI Action.
+     * @param data - Object representation of the AI Action to be created
+     * @return Promise for the newly created AI Action
+     * @example
+     * ```javascript
+     * client.getSpace('<space_id>')
+     *   .then((space) => space.createAiAction({
+     *     name: 'My AI Action',
+     *     description: 'Description here',
+     *     configuration: { modelType: 'model-x', modelTemperature: 0.7 },
+     *     instruction: { template: 'Do something: {{var.input}}', variables: [], conditions: [] },
+     *     testCases: []
+     *   }))
+     *   .then((aiAction) => console.log(aiAction))
+     *   .catch(console.error)
+     * ```
+     */
+    createAiAction(data) {
+      const raw = this.toPlainObject();
+      return makeRequest({
+        entityType: 'AiAction',
+        action: 'create',
+        params: {
+          spaceId: raw.sys.id
+        },
+        payload: data
+      }).then(response => wrapAiAction(makeRequest, response));
+    },
+    /**
+     * Updates an AI Action.
+     * @param aiActionId - AI Action ID
+     * @param data - Object representation of the AI Action update
+     * @return Promise for the updated AI Action
+     * @example
+     * ```javascript
+     * client.getSpace('<space_id>')
+     *   .then((space) => space.updateAiAction('<ai_action_id>', { name: 'New Name', ... }))
+     *   .then((aiAction) => console.log(aiAction))
+     *   .catch(console.error)
+     * ```
+     */
+    updateAiAction(aiActionId, data) {
+      var _data$sys$version;
+      const raw = this.toPlainObject();
+      return makeRequest({
+        entityType: 'AiAction',
+        action: 'update',
+        params: {
+          spaceId: raw.sys.id,
+          aiActionId
+        },
+        payload: data,
+        headers: {
+          'X-Contentful-Version': (_data$sys$version = data.sys.version) !== null && _data$sys$version !== void 0 ? _data$sys$version : 0
+        }
+      }).then(response => wrapAiAction(makeRequest, response));
+    },
+    /**
+     * Publishes an AI Action.
+     * @param aiActionId - AI Action ID
+     * @param data - Object representation of the AI Action to be published
+     * @return Promise for the published AI Action
+     * @example
+     * ```javascript
+     * client.getSpace('<space_id>')
+     *   .then((space) => space.publishAiAction('<ai_action_id>', { ... }))
+     *   .then((aiAction) => console.log(aiAction))
+     *   .catch(console.error)
+     * ```
+     */
+    publishAiAction(aiActionId, data) {
+      const raw = this.toPlainObject();
+      return makeRequest({
+        entityType: 'AiAction',
+        action: 'publish',
+        params: {
+          spaceId: raw.sys.id,
+          aiActionId
+        },
+        payload: data,
+        headers: {
+          'X-Contentful-Version': data.sys.version
+        }
+      }).then(response => wrapAiAction(makeRequest, response));
+    },
+    /**
+     * Unpublishes an AI Action.
+     * @param aiActionId - AI Action ID
+     * @return Promise for the unpublished AI Action
+     * @example
+     * ```javascript
+     * client.getSpace('<space_id>')
+     *   .then((space) => space.unpublishAiAction('<ai_action_id>'))
+     *   .then((aiAction) => console.log(aiAction))
+     *   .catch(console.error)
+     * ```
+     */
+    unpublishAiAction(aiActionId) {
+      const raw = this.toPlainObject();
+      return makeRequest({
+        entityType: 'AiAction',
+        action: 'unpublish',
+        params: {
+          spaceId: raw.sys.id,
+          aiActionId
+        }
+      }).then(response => wrapAiAction(makeRequest, response));
+    },
+    /**
+     * Deletes an AI Action.
+     * @param aiActionId - AI Action ID
+     * @return Promise for deletion (void)
+     * @example
+     * ```javascript
+     * client.getSpace('<space_id>')
+     *   .then((space) => space.deleteAiAction('<ai_action_id>'))
+     *   .then(() => console.log('AI Action deleted'))
+     *   .catch(console.error)
+     * ```
+     */
+    deleteAiAction(aiActionId) {
+      const raw = this.toPlainObject();
+      return makeRequest({
+        entityType: 'AiAction',
+        action: 'delete',
+        params: {
+          spaceId: raw.sys.id,
+          aiActionId
+        }
+      });
     }
   };
 }

package/dist/es-modules/entities/ai-action-invocation.js

@@ -0,0 +1,46 @@
+import { freezeSys, toPlainObject } from 'contentful-sdk-core';
+import copy from 'fast-copy';
+import { wrapCollection } from '../common-utils';
+export let InvocationStatus = /*#__PURE__*/function (InvocationStatus) {
+  InvocationStatus["Scheduled"] = "SCHEDULED";
+  InvocationStatus["InProgress"] = "IN_PROGRESS";
+  InvocationStatus["Failed"] = "FAILED";
+  InvocationStatus["Completed"] = "COMPLETED";
+  InvocationStatus["Cancelled"] = "CANCELLED";
+  return InvocationStatus;
+}({});
+export let InvocationResultType = /*#__PURE__*/function (InvocationResultType) {
+  InvocationResultType["Text"] = "text";
+  return InvocationResultType;
+}({});
+export const AiActionOutputFormat = {
+  RichText: 'RichText',
+  Markdown: 'Markdown',
+  PlainText: 'PlainText'
+};
+
+/**
+ * The AI Action Invocation entity.
+ * This entity is read-only and primarily used to inspect the result of an AI action invocation.
+ */
+
+/**
+ * Wraps raw AI Action Invocation data with SDK helper methods.
+ *
+ * @param makeRequest - Function to make API requests.
+ * @param data - Raw AI Action Invocation data.
+ * @returns The AI Action Invocation entity.
+ */
+export function wrapAiActionInvocation(makeRequest, data) {
+  const invocation = toPlainObject(copy(data));
+  return freezeSys(invocation);
+}
+
+/**
+ * Wraps a collection of raw AI Action Invocation data.
+ *
+ * @param makeRequest - Function to make API requests.
+ * @param data - Raw collection data.
+ * @returns A collection of AI Action Invocation entities.
+ */
+export const wrapAiActionInvocationCollection = wrapCollection(wrapAiActionInvocation);

package/dist/es-modules/entities/ai-action.js

@@ -0,0 +1,85 @@
+import { freezeSys, toPlainObject } from 'contentful-sdk-core';
+import copy from 'fast-copy';
+import { wrapCollection } from '../common-utils';
+import enhanceWithMethods from '../enhance-with-methods';
+import { wrapAiActionInvocation } from './ai-action-invocation';
+export let StatusFilter = /*#__PURE__*/function (StatusFilter) {
+  StatusFilter["ALL"] = "all";
+  StatusFilter["PUBLISHED"] = "published";
+  return StatusFilter;
+}({});
+export let VariableType = /*#__PURE__*/function (VariableType) {
+  VariableType["RESOURCE_LINK"] = "ResourceLink";
+  VariableType["TEXT"] = "Text";
+  VariableType["STANDARD_INPUT"] = "StandardInput";
+  VariableType["LOCALE"] = "Locale";
+  VariableType["MEDIA_REFERENCE"] = "MediaReference";
+  VariableType["REFERENCE"] = "Reference";
+  VariableType["SMART_CONTEXT"] = "SmartContext";
+  return VariableType;
+}({});
+export let EntityTypeEntry = /*#__PURE__*/function (EntityTypeEntry) {
+  EntityTypeEntry["ENTRY"] = "Entry";
+  return EntityTypeEntry;
+}({});
+function createAiActionApi(makeRequest) {
+  const getParams = data => ({
+    spaceId: data.sys.space.sys.id,
+    aiActionId: data.sys.id
+  });
+  return {
+    update: function update() {
+      const self = this;
+      return makeRequest({
+        entityType: 'AiAction',
+        action: 'update',
+        params: getParams(self),
+        payload: self
+      }).then(data => wrapAiAction(makeRequest, data));
+    },
+    delete: function del() {
+      const self = this;
+      return makeRequest({
+        entityType: 'AiAction',
+        action: 'delete',
+        params: getParams(self)
+      });
+    },
+    publish: function publish() {
+      const self = this;
+      return makeRequest({
+        entityType: 'AiAction',
+        action: 'publish',
+        params: getParams(self),
+        payload: self
+      }).then(data => wrapAiAction(makeRequest, data));
+    },
+    unpublish: function unpublish() {
+      const self = this;
+      return makeRequest({
+        entityType: 'AiAction',
+        action: 'unpublish',
+        params: getParams(self)
+      }).then(data => wrapAiAction(makeRequest, data));
+    },
+    invoke: function invoke(environmentId, payload) {
+      const self = this;
+      return makeRequest({
+        entityType: 'AiAction',
+        action: 'invoke',
+        params: {
+          spaceId: self.sys.space.sys.id,
+          environmentId,
+          aiActionId: self.sys.id
+        },
+        payload
+      }).then(data => wrapAiActionInvocation(makeRequest, data));
+    }
+  };
+}
+export function wrapAiAction(makeRequest, data) {
+  const aiAction = toPlainObject(copy(data));
+  const aiActionWithMethods = enhanceWithMethods(aiAction, createAiActionApi(makeRequest));
+  return freezeSys(aiActionWithMethods);
+}
+export const wrapAiActionCollection = wrapCollection(wrapAiAction);

package/dist/es-modules/entities/index.js

@@ -1,3 +1,5 @@
+import * as aiAction from './ai-action';
+import * as aiActionInvocation from './ai-action-invocation';
 import * as apiKey from './api-key';
 import * as appAction from './app-action';
 import * as appActionCall from './app-action-call';
@@ -59,6 +61,8 @@ import * as resourceProvider from './resource-provider';
 import * as resourceType from './resource-type';
 import * as resource from './resource';
 export default {
+  aiAction,
+  aiActionInvocation,
   accessToken,
   appAction,
   appActionCall,

package/dist/es-modules/plain/entities/ai-action-invocation.js

@@ -0,0 +1 @@
+export {};

package/dist/es-modules/plain/entities/ai-action.js

@@ -0,0 +1 @@
+export {};

package/dist/es-modules/plain/plain-client.js

@@ -68,6 +68,19 @@ export const createPlainClient = (makeRequest, defaults) => {
         }
       })
     },
+    aiAction: {
+      get: wrap(wrapParams, 'AiAction', 'get'),
+      getMany: wrap(wrapParams, 'AiAction', 'getMany'),
+      create: wrap(wrapParams, 'AiAction', 'create'),
+      update: wrap(wrapParams, 'AiAction', 'update'),
+      delete: wrap(wrapParams, 'AiAction', 'delete'),
+      publish: wrap(wrapParams, 'AiAction', 'publish'),
+      unpublish: wrap(wrapParams, 'AiAction', 'unpublish'),
+      invoke: wrap(wrapParams, 'AiAction', 'invoke')
+    },
+    aiActionInvocation: {
+      get: wrap(wrapParams, 'AiActionInvocation', 'get')
+    },
     appAction: {
       get: wrap(wrapParams, 'AppAction', 'get'),
       getMany: wrap(wrapParams, 'AppAction', 'getMany'),

package/dist/typings/adapters/REST/endpoints/ai-action-invocation.d.ts

@@ -0,0 +1,2 @@
+import type { RestEndpoint } from '../types';
+export declare const get: RestEndpoint<'AiActionInvocation', 'get'>;

package/dist/typings/adapters/REST/endpoints/ai-action.d.ts

@@ -0,0 +1,9 @@
+import type { RestEndpoint } from '../types';
+export declare const get: RestEndpoint<'AiAction', 'get'>;
+export declare const getMany: RestEndpoint<'AiAction', 'getMany'>;
+export declare const create: RestEndpoint<'AiAction', 'create'>;
+export declare const update: RestEndpoint<'AiAction', 'update'>;
+export declare const del: RestEndpoint<'AiAction', 'delete'>;
+export declare const publish: RestEndpoint<'AiAction', 'publish'>;
+export declare const unpublish: RestEndpoint<'AiAction', 'unpublish'>;
+export declare const invoke: RestEndpoint<'AiAction', 'invoke'>;

package/dist/typings/adapters/REST/endpoints/index.d.ts

@@ -1,3 +1,5 @@
+import * as AiAction from './ai-action';
+import * as AiActionInvocation from './ai-action-invocation';
 import * as AccessToken from './access-token';
 import * as ApiKey from './api-key';
 import * as AppAccessToken from './app-access-token';
@@ -63,6 +65,8 @@ import * as Workflow from './workflow';
 import * as WorkflowDefinition from './workflow-definition';
 import * as WorkflowsChangelog from './workflows-changelog';
 declare const _default: {
+    AiAction: typeof AiAction;
+    AiActionInvocation: typeof AiActionInvocation;
     ApiKey: typeof ApiKey;
     AppAction: typeof AppAction;
     AppActionCall: typeof AppActionCall;