contentful-management 11.39.2 → 11.40.0

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

@@ -16,6 +16,9 @@ export const getMany = (http, params, headers) => raw.get(http, getBaseUrl(param
   headers,
   params: params.query
 });
+export const get = (http, params, headers) => raw.get(http, getWorkflowUrl(params), {
+  headers
+});
 export const create = (http, params, rawData, headers) => {
   const data = copy(rawData);
   return raw.post(http, getBaseUrl(params), data, {

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

@@ -46,7 +46,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.39.2"}`, params.application, params.integration, params.feature);
+  `${sdkMain}/${"11.40.0"}`, params.application, params.integration, params.feature);
   const adapter = createAdapter(_objectSpread(_objectSpread({}, params), {}, {
     userAgent
   }));

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

@@ -26,6 +26,14 @@ export default function createWorkflowApi(makeRequest) {
         payload: raw
       }).then(data => wrapWorkflow(makeRequest, data));
     },
+    get: function () {
+      const raw = this.toPlainObject();
+      return makeRequest({
+        entityType: 'Workflow',
+        action: 'get',
+        params: getParams(raw)
+      }).then(data => wrapWorkflow(makeRequest, data));
+    },
     delete: function () {
       const raw = this.toPlainObject();
       return makeRequest({

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

@@ -504,6 +504,7 @@ export const createPlainClient = (makeRequest, defaults) => {
       delete: wrap(wrapParams, 'WorkflowDefinition', 'delete')
     },
     workflow: {
+      get: wrap(wrapParams, 'Workflow', 'get'),
       getMany: wrap(wrapParams, 'Workflow', 'getMany'),
       create: wrap(wrapParams, 'Workflow', 'create'),
       update: wrap(wrapParams, 'Workflow', 'update'),

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

@@ -1,5 +1,6 @@
 import type { RestEndpoint } from '../types';
 export declare const getMany: RestEndpoint<'Workflow', 'getMany'>;
+export declare const get: RestEndpoint<'Workflow', 'get'>;
 export declare const create: RestEndpoint<'Workflow', 'create'>;
 export declare const update: RestEndpoint<'Workflow', 'update'>;
 export declare const del: RestEndpoint<'Workflow', 'delete'>;

package/dist/typings/common-types.d.ts

@@ -500,6 +500,7 @@ type MRInternal<UA extends boolean> = {
     (opts: MROpts<'WorkflowDefinition', 'create', UA>): MRReturn<'WorkflowDefinition', 'create'>;
     (opts: MROpts<'WorkflowDefinition', 'update', UA>): MRReturn<'WorkflowDefinition', 'update'>;
     (opts: MROpts<'WorkflowDefinition', 'delete', UA>): MRReturn<'WorkflowDefinition', 'delete'>;
+    (opts: MROpts<'Workflow', 'get', UA>): MRReturn<'Workflow', 'get'>;
     (opts: MROpts<'Workflow', 'getMany', UA>): MRReturn<'Workflow', 'getMany'>;
     (opts: MROpts<'Workflow', 'create', UA>): MRReturn<'Workflow', 'create'>;
     (opts: MROpts<'Workflow', 'update', UA>): MRReturn<'Workflow', 'update'>;
@@ -2227,6 +2228,11 @@ export type MRActions = {
         };
     };
     Workflow: {
+        get: {
+            params: GetWorkflowParams;
+            headers?: RawAxiosRequestHeaders;
+            return: WorkflowProps;
+        };
         getMany: {
             params: GetSpaceEnvironmentParams & {
                 query?: WorkflowQueryOptions;

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

@@ -29,6 +29,7 @@ export type DeleteWorkflowParams = GetWorkflowParams & {
 export type CompleteWorkflowParams = DeleteWorkflowParams;
 type WorkflowApi = {
     update(): Promise<Workflow>;
+    get(): Promise<Workflow>;
     delete(): Promise<void>;
     complete(): Promise<void>;
 };

package/dist/typings/plain/entities/workflow.d.ts

@@ -1,8 +1,23 @@
 import type { RawAxiosRequestHeaders } from 'axios';
-import type { GetSpaceEnvironmentParams, CollectionProp } from '../../common-types';
+import type { GetSpaceEnvironmentParams, CollectionProp, GetWorkflowParams } from '../../common-types';
 import type { CreateWorkflowParams, UpdateWorkflowParams, CompleteWorkflowParams, WorkflowQueryOptions, WorkflowProps, CreateWorkflowProps, UpdateWorkflowProps, DeleteWorkflowParams } from '../../entities/workflow';
 import type { OptionalDefaults } from '../wrappers/wrap';
 export type WorkflowPlainClientAPI = {
+    /**
+     * Get Workflow by ID
+     * @param params entity IDs to identify the Space/Environment
+     * @returns an object containing the Workflow
+     * @throws if the request fails, or the Space/Environment is not found
+     * @example
+     * ```javascript
+     * const workflow = await client.workflow.get({
+     *   spaceId: '<space_id>',
+     *   environmentId: '<environment_id>',
+     *   workflowId: '<workflow_id>',
+     * });
+     * ```
+     */
+    get(params: OptionalDefaults<GetWorkflowParams>, headers?: RawAxiosRequestHeaders): Promise<WorkflowProps>;
     /**
      * Query Workflows with certain filters
      * @param params entity IDs to identify the Space/Environment, optional query parameters to filter returned Workflows
@@ -66,7 +81,9 @@ export type WorkflowPlainClientAPI = {
      *   workflowId: '<workflow_id>',
      * }, {
      *   stepId: '<step_id>'
-     * });
+     *   sys: {
+     *        version: <current_version>
+     * }});
      * ```
      */
     update(params: OptionalDefaults<UpdateWorkflowParams>, rawData: UpdateWorkflowProps, headers?: RawAxiosRequestHeaders): Promise<WorkflowProps>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "contentful-management",
-  "version": "11.39.2",
+  "version": "11.40.0",
   "description": "Client for Contentful's Content Management API",
   "homepage": "https://www.contentful.com/developers/documentation/content-management-api/",
   "main": "./dist/contentful-management.node.js",