@prezly/sdk 15.21.0 → 16.0.0

package/dist/api/constants.cjs

@@ -4,7 +4,7 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.DEFAULT_USER_AGENT = void 0;
-const VERSION = "15.20.0";
+const VERSION = "15.21.0";
 const URL = 'https://github.com/prezly/javascript-sdk';
 const DEFAULT_USER_AGENT = `prezly-javascript-sdk/${VERSION} (+${URL})`;
 exports.DEFAULT_USER_AGENT = DEFAULT_USER_AGENT;

package/dist/api/constants.js

@@ -1,3 +1,3 @@
-const VERSION = "15.20.0";
+const VERSION = "15.21.0";
 const URL = 'https://github.com/prezly/javascript-sdk';
 export const DEFAULT_USER_AGENT = `prezly-javascript-sdk/${VERSION} (+${URL})`;

package/dist/endpoints/Stories/Client.cjs

@@ -16,9 +16,11 @@ class Client {
       limit,
       offset,
       sortOrder,
-      include
+      include,
+      formats
     } = options ?? {};
     return this.apiClient.get(_routing.routing.storiesUrl, {
+      headers: acceptedFormatsHeader(formats),
       query: {
         limit,
         offset,
@@ -33,9 +35,11 @@ class Client {
       offset,
       sortOrder,
       include,
-      query
+      query,
+      formats
     } = options ?? {};
     return this.apiClient.post(_routing.routing.storiesSearchUrl, {
+      headers: acceptedFormatsHeader(formats),
       payload: {
         query,
         limit,
@@ -54,7 +58,10 @@ class Client {
    * Implementation
    */
   async get(arg, options) {
-    const include = options?.include;
+    const {
+      include,
+      formats
+    } = options ?? {};
     const isArray = Array.isArray(arg);
     if (isArray && arg.length === 0) {
       // No need to call the API.
@@ -70,7 +77,8 @@ class Client {
             $in: arg
           }
         },
-        include
+        include,
+        formats
       });
       return stories;
     }
@@ -84,13 +92,15 @@ class Client {
             $in: arg
           }
         },
-        include
+        include,
+        formats
       });
       return stories;
     }
     const {
       story
     } = await this.apiClient.get(`${_routing.routing.storiesUrl}/${arg}`, {
+      headers: acceptedFormatsHeader(formats),
       query: {
         include: include
       }
@@ -98,10 +108,14 @@ class Client {
     return story;
   }
   async create(payload, options) {
-    const include = options?.include;
+    const {
+      include,
+      formats
+    } = options ?? {};
     const {
       story
     } = await this.apiClient.post(_routing.routing.storiesUrl, {
+      headers: acceptedFormatsHeader(formats),
       payload,
       query: {
         include: include
@@ -110,11 +124,15 @@ class Client {
     return story;
   }
   async duplicate(id, options) {
-    const include = options?.include;
+    const {
+      include,
+      formats
+    } = options ?? {};
     const url = `${_routing.routing.storiesUrl}/${id}/duplicate`;
     const {
       story
     } = await this.apiClient.post(url, {
+      headers: acceptedFormatsHeader(formats),
       query: {
         include: include
       }
@@ -125,11 +143,15 @@ class Client {
     const {
       culture
     } = payload ?? {};
-    const include = options?.include;
+    const {
+      include,
+      formats
+    } = options ?? {};
     const url = `${_routing.routing.storiesUrl}/${id}/translate`;
     const {
       story
     } = await this.apiClient.post(url, {
+      headers: acceptedFormatsHeader(formats),
       query: {
         include: include
       },
@@ -140,13 +162,17 @@ class Client {
     return story;
   }
   async move(id, payload, options) {
-    const include = options?.include;
-    const force = options?.force;
+    const {
+      include,
+      force,
+      formats
+    } = options ?? {};
     const url = `${_routing.routing.storiesUrl}/${id}/move`;
     try {
       const {
         story
       } = await this.apiClient.post(url, {
+        headers: acceptedFormatsHeader(formats),
         query: {
           include: include,
           force
@@ -166,10 +192,14 @@ class Client {
   }
   async update(id, payload, options) {
     const url = `${_routing.routing.storiesUrl}/${id}`;
-    const include = options?.include;
+    const {
+      include,
+      formats
+    } = options ?? {};
     const {
       story
     } = await this.apiClient.patch(url, {
+      headers: acceptedFormatsHeader(formats),
       payload,
       query: {
         include: include
@@ -183,10 +213,14 @@ class Client {
    */
   async autosave(id, payload, options) {
     const url = `${_routing.routing.storiesUrl}/${id}/autosave`;
-    const include = options?.include;
+    const {
+      include,
+      formats
+    } = options ?? {};
     const {
       story
     } = await this.apiClient.patch(url, {
+      headers: acceptedFormatsHeader(formats),
       payload,
       query: {
         include: include
@@ -200,10 +234,14 @@ class Client {
    */
   async revert(id, payload, options) {
     const url = `${_routing.routing.storiesUrl}/${id}/revert`;
-    const include = options?.include;
+    const {
+      include,
+      formats
+    } = options ?? {};
     const {
       story
     } = await this.apiClient.post(url, {
+      headers: acceptedFormatsHeader(formats),
       payload,
       query: {
         include: include
@@ -213,10 +251,14 @@ class Client {
   }
   async publish(id, payload, options) {
     const url = `${_routing.routing.storiesUrl}/${id}/publish`;
-    const include = options?.include;
+    const {
+      include,
+      formats
+    } = options ?? {};
     const {
       story
     } = await this.apiClient.post(url, {
+      headers: acceptedFormatsHeader(formats),
       payload,
       query: {
         include: include
@@ -226,10 +268,14 @@ class Client {
   }
   async unpublish(id, payload, options) {
     const url = `${_routing.routing.storiesUrl}/${id}/unpublish`;
-    const include = options?.include;
+    const {
+      include,
+      formats
+    } = options ?? {};
     const {
       story
     } = await this.apiClient.post(url, {
+      headers: acceptedFormatsHeader(formats),
       payload,
       query: {
         include: include
@@ -239,10 +285,14 @@ class Client {
   }
   async schedule(id, payload, options) {
     const url = `${_routing.routing.storiesUrl}/${id}/schedule`;
-    const include = options?.include;
+    const {
+      include,
+      formats
+    } = options ?? {};
     const {
       story
     } = await this.apiClient.post(url, {
+      headers: acceptedFormatsHeader(formats),
       payload,
       query: {
         include: include
@@ -252,10 +302,14 @@ class Client {
   }
   async unschedule(id, payload, options) {
     const url = `${_routing.routing.storiesUrl}/${id}/unpublish`;
-    const include = options?.include;
+    const {
+      include,
+      formats
+    } = options ?? {};
     const {
       story
     } = await this.apiClient.post(url, {
+      headers: acceptedFormatsHeader(formats),
       payload,
       query: {
         include: include
@@ -265,23 +319,32 @@ class Client {
   }
   async pin(id, options) {
     const url = `${_routing.routing.storiesUrl}/${id}/pin`;
-    const include = options?.include;
+    const {
+      include,
+      force,
+      formats
+    } = options ?? {};
     const {
       story
     } = await this.apiClient.post(url, {
+      headers: acceptedFormatsHeader(formats),
       query: {
         include: include,
-        force: options?.force || undefined
+        force: force || undefined
       }
     });
     return story;
   }
   async unpin(id, options) {
     const url = `${_routing.routing.storiesUrl}/${id}/unpin`;
-    const include = options?.include;
+    const {
+      include,
+      formats
+    } = options ?? {};
     const {
       story
     } = await this.apiClient.post(url, {
+      headers: acceptedFormatsHeader(formats),
       query: {
         include: include
       }
@@ -305,4 +368,12 @@ class Client {
     return preview;
   }
 }
-exports.Client = Client;
+exports.Client = Client;
+function acceptedFormatsHeader(formats = []) {
+  if (formats.length === 0) {
+    return {};
+  }
+  return {
+    Accept: formats.map(format => `application/json; content-format=v${format}`).join(', ')
+  };
+}

package/dist/endpoints/Stories/Client.d.ts

@@ -5,6 +5,7 @@ import type { AutosaveRequest, ChangeNewsroomSuccessResponse, ChangeNewsroomUnsa
  * `uuid` is the preferred way of targeting a Story. Numeric `id` is considered deprecated.
  */
 declare type StoryId = Story['uuid'] | Story['id'];
+declare type Formats = Story.FormatVersion[];
 /**
  * Utility type to forbid arbitrary ad-hoc extensions of generic parameters.
  * @see https://stackoverflow.com/a/69666350
@@ -18,44 +19,76 @@ export declare class Client {
     /**
      * Get story by UUID.
      */
-    get<Include extends readonly (keyof Story.ExtraFields)[], Options extends IncludeOptions<Include>, StoryRecord extends ExtendedStory = Options['include'] extends Include ? ExtendedStory & Pick<Story.ExtraFields, Options['include'][number]> : ExtendedStory>(id: Story['uuid'], options?: Exactly<IncludeOptions<Include>, Options>): Promise<StoryRecord>;
+    get<Include extends readonly (keyof Story.ExtraFields)[], Options extends IncludeOptions<Include>, StoryRecord extends ExtendedStory = Options['include'] extends Include ? ExtendedStory & Pick<Story.ExtraFields, Options['include'][number]> : ExtendedStory>(id: Story['uuid'], options?: Exactly<IncludeOptions<Include>, Options> & {
+        formats?: Formats;
+    }): Promise<StoryRecord>;
     /**
      * Get multiple stories by UUIDs.
      */
-    get<Include extends readonly (keyof Story.ExtraFields)[], Options extends IncludeOptions<Include>, StoryRecord extends ExtendedStory = Options['include'] extends Include ? ExtendedStory & Pick<Story.ExtraFields, Options['include'][number]> : ExtendedStory>(ids: Story['uuid'][], options?: Exactly<IncludeOptions<Include>, Options>): Promise<StoryRecord[]>;
+    get<Include extends readonly (keyof Story.ExtraFields)[], Options extends IncludeOptions<Include>, StoryRecord extends ExtendedStory = Options['include'] extends Include ? ExtendedStory & Pick<Story.ExtraFields, Options['include'][number]> : ExtendedStory>(ids: Story['uuid'][], options?: Exactly<IncludeOptions<Include>, Options> & {
+        formats?: Formats;
+    }): Promise<StoryRecord[]>;
     /**
      * Get story by deprecated numeric ID, or UUID.
      * @deprecated Please use UUID instead.
      */
-    get<Include extends readonly (keyof Story.ExtraFields)[], Options extends IncludeOptions<Include>, StoryRecord extends ExtendedStory = Options['include'] extends Include ? ExtendedStory & Pick<Story.ExtraFields, Options['include'][number]> : ExtendedStory>(id: Story['id'] | Story['uuid'], options?: Exactly<IncludeOptions<Include>, Options>): Promise<StoryRecord>;
+    get<Include extends readonly (keyof Story.ExtraFields)[], Options extends IncludeOptions<Include>, StoryRecord extends ExtendedStory = Options['include'] extends Include ? ExtendedStory & Pick<Story.ExtraFields, Options['include'][number]> : ExtendedStory>(id: Story['id'] | Story['uuid'], options?: Exactly<IncludeOptions<Include>, Options> & {
+        formats?: Formats;
+    }): Promise<StoryRecord>;
     /**
      * Get multiple stories by numeric IDs.
      * @deprecated Please use UUID instead.
      */
-    get<Include extends readonly (keyof Story.ExtraFields)[], Options extends IncludeOptions<Include>, StoryRecord extends ExtendedStory = Options['include'] extends Include ? ExtendedStory & Pick<Story.ExtraFields, Options['include'][number]> : ExtendedStory>(ids: Story['id'][], options?: Exactly<IncludeOptions<Include>, Options>): Promise<StoryRecord[]>;
-    create<Include extends readonly (keyof Story.ExtraFields)[], Options extends IncludeOptions<Include>, StoryRecord extends ExtendedStory = Options['include'] extends Include ? ExtendedStory & Pick<Story.ExtraFields, Options['include'][number]> : ExtendedStory>(payload: CreateRequest, options?: Exactly<IncludeOptions<Include>, Options>): Promise<StoryRecord>;
-    duplicate<Include extends readonly (keyof Story.ExtraFields)[], Options extends IncludeOptions<Include>, StoryRecord extends ExtendedStory = Options['include'] extends Include ? ExtendedStory & Pick<Story.ExtraFields, Options['include'][number]> : ExtendedStory>(id: StoryId, options?: Exactly<IncludeOptions<Include>, Options>): Promise<StoryRecord>;
-    translate<Include extends readonly (keyof Story.ExtraFields)[], Options extends IncludeOptions<Include>, StoryRecord extends ExtendedStory = Options['include'] extends Include ? ExtendedStory & Pick<Story.ExtraFields, Options['include'][number]> : ExtendedStory>(id: StoryId, payload?: TranslateRequest, options?: Exactly<IncludeOptions<Include>, Options>): Promise<StoryRecord>;
+    get<Include extends readonly (keyof Story.ExtraFields)[], Options extends IncludeOptions<Include>, StoryRecord extends ExtendedStory = Options['include'] extends Include ? ExtendedStory & Pick<Story.ExtraFields, Options['include'][number]> : ExtendedStory>(ids: Story['id'][], options?: Exactly<IncludeOptions<Include>, Options> & {
+        formats?: Formats;
+    }): Promise<StoryRecord[]>;
+    create<Include extends readonly (keyof Story.ExtraFields)[], Options extends IncludeOptions<Include>, StoryRecord extends ExtendedStory = Options['include'] extends Include ? ExtendedStory & Pick<Story.ExtraFields, Options['include'][number]> : ExtendedStory>(payload: CreateRequest, options?: Exactly<IncludeOptions<Include>, Options> & {
+        formats?: Formats;
+    }): Promise<StoryRecord>;
+    duplicate<Include extends readonly (keyof Story.ExtraFields)[], Options extends IncludeOptions<Include>, StoryRecord extends ExtendedStory = Options['include'] extends Include ? ExtendedStory & Pick<Story.ExtraFields, Options['include'][number]> : ExtendedStory>(id: StoryId, options?: Exactly<IncludeOptions<Include>, Options> & {
+        formats?: Formats;
+    }): Promise<StoryRecord>;
+    translate<Include extends readonly (keyof Story.ExtraFields)[], Options extends IncludeOptions<Include>, StoryRecord extends ExtendedStory = Options['include'] extends Include ? ExtendedStory & Pick<Story.ExtraFields, Options['include'][number]> : ExtendedStory>(id: StoryId, payload?: TranslateRequest, options?: Exactly<IncludeOptions<Include>, Options> & {
+        formats?: Formats;
+    }): Promise<StoryRecord>;
     move<Include extends readonly (keyof Story.ExtraFields)[], Options extends IncludeOptions<Include>, StoryRecord extends ExtendedStory = Options['include'] extends Include ? ExtendedStory & Pick<Story.ExtraFields, Options['include'][number]> : ExtendedStory>(id: StoryId, payload: MoveRequest, options?: Exactly<IncludeOptions<Include>, Options> & {
         force?: true;
+        formats?: Formats;
     }): Promise<ChangeNewsroomSuccessResponse<StoryRecord> | ChangeNewsroomUnsafeResponse>;
-    update<Include extends readonly (keyof Story.ExtraFields)[], Options extends IncludeOptions<Include>, StoryRecord extends ExtendedStory = Options['include'] extends Include ? ExtendedStory & Pick<Story.ExtraFields, Options['include'][number]> : ExtendedStory>(id: StoryId, payload: UpdateRequest, options?: Exactly<IncludeOptions<Include>, Options>): Promise<StoryRecord>;
+    update<Include extends readonly (keyof Story.ExtraFields)[], Options extends IncludeOptions<Include>, StoryRecord extends ExtendedStory = Options['include'] extends Include ? ExtendedStory & Pick<Story.ExtraFields, Options['include'][number]> : ExtendedStory>(id: StoryId, payload: UpdateRequest, options?: Exactly<IncludeOptions<Include>, Options> & {
+        formats?: Formats;
+    }): Promise<StoryRecord>;
     /**
      * This operation is only allowed for V3 stories
      */
-    autosave<Include extends readonly (keyof Story.ExtraFields)[], Options extends IncludeOptions<Include>, StoryRecord extends ExtendedStory = Options['include'] extends Include ? ExtendedStory & Pick<Story.ExtraFields, Options['include'][number]> : ExtendedStory>(id: StoryId, payload: AutosaveRequest, options?: Exactly<IncludeOptions<Include>, Options>): Promise<StoryRecord>;
+    autosave<Include extends readonly (keyof Story.ExtraFields)[], Options extends IncludeOptions<Include>, StoryRecord extends ExtendedStory = Options['include'] extends Include ? ExtendedStory & Pick<Story.ExtraFields, Options['include'][number]> : ExtendedStory>(id: StoryId, payload: AutosaveRequest, options?: Exactly<IncludeOptions<Include>, Options> & {
+        formats?: Formats;
+    }): Promise<StoryRecord>;
     /**
      * This operation is only allowed for V3 stories
      */
-    revert<Include extends readonly (keyof Story.ExtraFields)[], Options extends IncludeOptions<Include>, StoryRecord extends ExtendedStory = Options['include'] extends Include ? ExtendedStory & Pick<Story.ExtraFields, Options['include'][number]> : ExtendedStory>(id: StoryId, payload?: RevertRequest, options?: Exactly<IncludeOptions<Include>, Options>): Promise<StoryRecord>;
-    publish<Include extends readonly (keyof Story.ExtraFields)[], Options extends IncludeOptions<Include>, StoryRecord extends ExtendedStory = Options['include'] extends Include ? ExtendedStory & Pick<Story.ExtraFields, Options['include'][number]> : ExtendedStory>(id: StoryId, payload?: PublishRequest, options?: Exactly<IncludeOptions<Include>, Options>): Promise<StoryRecord>;
-    unpublish<Include extends readonly (keyof Story.ExtraFields)[], Options extends IncludeOptions<Include>, StoryRecord extends ExtendedStory = Options['include'] extends Include ? ExtendedStory & Pick<Story.ExtraFields, Options['include'][number]> : ExtendedStory>(id: StoryId, payload?: UnpublishRequest, options?: Exactly<IncludeOptions<Include>, Options>): Promise<StoryRecord>;
-    schedule<Include extends readonly (keyof Story.ExtraFields)[], Options extends IncludeOptions<Include>, StoryRecord extends ExtendedStory = Options['include'] extends Include ? ExtendedStory & Pick<Story.ExtraFields, Options['include'][number]> : ExtendedStory>(id: StoryId, payload?: ScheduleRequest, options?: Exactly<IncludeOptions<Include>, Options>): Promise<StoryRecord>;
-    unschedule<Include extends readonly (keyof Story.ExtraFields)[], Options extends IncludeOptions<Include>, StoryRecord extends ExtendedStory = Options['include'] extends Include ? ExtendedStory & Pick<Story.ExtraFields, Options['include'][number]> : ExtendedStory>(id: StoryId, payload?: UnscheduleRequest, options?: Exactly<IncludeOptions<Include>, Options>): Promise<StoryRecord>;
+    revert<Include extends readonly (keyof Story.ExtraFields)[], Options extends IncludeOptions<Include>, StoryRecord extends ExtendedStory = Options['include'] extends Include ? ExtendedStory & Pick<Story.ExtraFields, Options['include'][number]> : ExtendedStory>(id: StoryId, payload?: RevertRequest, options?: Exactly<IncludeOptions<Include>, Options> & {
+        formats?: Formats;
+    }): Promise<StoryRecord>;
+    publish<Include extends readonly (keyof Story.ExtraFields)[], Options extends IncludeOptions<Include>, StoryRecord extends ExtendedStory = Options['include'] extends Include ? ExtendedStory & Pick<Story.ExtraFields, Options['include'][number]> : ExtendedStory>(id: StoryId, payload?: PublishRequest, options?: Exactly<IncludeOptions<Include>, Options> & {
+        formats?: Formats;
+    }): Promise<StoryRecord>;
+    unpublish<Include extends readonly (keyof Story.ExtraFields)[], Options extends IncludeOptions<Include>, StoryRecord extends ExtendedStory = Options['include'] extends Include ? ExtendedStory & Pick<Story.ExtraFields, Options['include'][number]> : ExtendedStory>(id: StoryId, payload?: UnpublishRequest, options?: Exactly<IncludeOptions<Include>, Options> & {
+        formats?: Formats;
+    }): Promise<StoryRecord>;
+    schedule<Include extends readonly (keyof Story.ExtraFields)[], Options extends IncludeOptions<Include>, StoryRecord extends ExtendedStory = Options['include'] extends Include ? ExtendedStory & Pick<Story.ExtraFields, Options['include'][number]> : ExtendedStory>(id: StoryId, payload?: ScheduleRequest, options?: Exactly<IncludeOptions<Include>, Options> & {
+        formats?: Formats;
+    }): Promise<StoryRecord>;
+    unschedule<Include extends readonly (keyof Story.ExtraFields)[], Options extends IncludeOptions<Include>, StoryRecord extends ExtendedStory = Options['include'] extends Include ? ExtendedStory & Pick<Story.ExtraFields, Options['include'][number]> : ExtendedStory>(id: StoryId, payload?: UnscheduleRequest, options?: Exactly<IncludeOptions<Include>, Options> & {
+        formats?: Formats;
+    }): Promise<StoryRecord>;
     pin<Include extends readonly (keyof Story.ExtraFields)[], Options extends IncludeOptions<Include>, StoryRecord extends ExtendedStory = Options['include'] extends Include ? ExtendedStory & Pick<Story.ExtraFields, Options['include'][number]> : ExtendedStory>(id: StoryId, options?: Exactly<IncludeOptions<Include>, Options> & {
         force?: boolean;
+        formats?: Formats;
+    }): Promise<StoryRecord>;
+    unpin<Include extends readonly (keyof Story.ExtraFields)[], Options extends IncludeOptions<Include>, StoryRecord extends ExtendedStory = Options['include'] extends Include ? ExtendedStory & Pick<Story.ExtraFields, Options['include'][number]> : ExtendedStory>(id: StoryId, options?: Exactly<IncludeOptions<Include>, Options> & {
+        formats?: Formats;
     }): Promise<StoryRecord>;
-    unpin<Include extends readonly (keyof Story.ExtraFields)[], Options extends IncludeOptions<Include>, StoryRecord extends ExtendedStory = Options['include'] extends Include ? ExtendedStory & Pick<Story.ExtraFields, Options['include'][number]> : ExtendedStory>(id: StoryId, options?: Exactly<IncludeOptions<Include>, Options>): Promise<StoryRecord>;
     delete(id: StoryId): Promise<void>;
     preview(id: StoryId, options?: PreviewOptions): Promise<PreviewResponse>;
 }

package/dist/endpoints/Stories/Client.js

@@ -10,9 +10,11 @@ export class Client {
       limit,
       offset,
       sortOrder,
-      include
+      include,
+      formats
     } = options ?? {};
     return this.apiClient.get(routing.storiesUrl, {
+      headers: acceptedFormatsHeader(formats),
       query: {
         limit,
         offset,
@@ -27,9 +29,11 @@ export class Client {
       offset,
       sortOrder,
       include,
-      query
+      query,
+      formats
     } = options ?? {};
     return this.apiClient.post(routing.storiesSearchUrl, {
+      headers: acceptedFormatsHeader(formats),
       payload: {
         query,
         limit,
@@ -48,7 +52,10 @@ export class Client {
    * Implementation
    */
   async get(arg, options) {
-    const include = options?.include;
+    const {
+      include,
+      formats
+    } = options ?? {};
     const isArray = Array.isArray(arg);
     if (isArray && arg.length === 0) {
       // No need to call the API.
@@ -64,7 +71,8 @@ export class Client {
             $in: arg
           }
         },
-        include
+        include,
+        formats
       });
       return stories;
     }
@@ -78,13 +86,15 @@ export class Client {
             $in: arg
           }
         },
-        include
+        include,
+        formats
       });
       return stories;
     }
     const {
       story
     } = await this.apiClient.get(`${routing.storiesUrl}/${arg}`, {
+      headers: acceptedFormatsHeader(formats),
       query: {
         include: include
       }
@@ -92,10 +102,14 @@ export class Client {
     return story;
   }
   async create(payload, options) {
-    const include = options?.include;
+    const {
+      include,
+      formats
+    } = options ?? {};
     const {
       story
     } = await this.apiClient.post(routing.storiesUrl, {
+      headers: acceptedFormatsHeader(formats),
       payload,
       query: {
         include: include
@@ -104,11 +118,15 @@ export class Client {
     return story;
   }
   async duplicate(id, options) {
-    const include = options?.include;
+    const {
+      include,
+      formats
+    } = options ?? {};
     const url = `${routing.storiesUrl}/${id}/duplicate`;
     const {
       story
     } = await this.apiClient.post(url, {
+      headers: acceptedFormatsHeader(formats),
       query: {
         include: include
       }
@@ -119,11 +137,15 @@ export class Client {
     const {
       culture
     } = payload ?? {};
-    const include = options?.include;
+    const {
+      include,
+      formats
+    } = options ?? {};
     const url = `${routing.storiesUrl}/${id}/translate`;
     const {
       story
     } = await this.apiClient.post(url, {
+      headers: acceptedFormatsHeader(formats),
       query: {
         include: include
       },
@@ -134,13 +156,17 @@ export class Client {
     return story;
   }
   async move(id, payload, options) {
-    const include = options?.include;
-    const force = options?.force;
+    const {
+      include,
+      force,
+      formats
+    } = options ?? {};
     const url = `${routing.storiesUrl}/${id}/move`;
     try {
       const {
         story
       } = await this.apiClient.post(url, {
+        headers: acceptedFormatsHeader(formats),
         query: {
           include: include,
           force
@@ -160,10 +186,14 @@ export class Client {
   }
   async update(id, payload, options) {
     const url = `${routing.storiesUrl}/${id}`;
-    const include = options?.include;
+    const {
+      include,
+      formats
+    } = options ?? {};
     const {
       story
     } = await this.apiClient.patch(url, {
+      headers: acceptedFormatsHeader(formats),
       payload,
       query: {
         include: include
@@ -177,10 +207,14 @@ export class Client {
    */
   async autosave(id, payload, options) {
     const url = `${routing.storiesUrl}/${id}/autosave`;
-    const include = options?.include;
+    const {
+      include,
+      formats
+    } = options ?? {};
     const {
       story
     } = await this.apiClient.patch(url, {
+      headers: acceptedFormatsHeader(formats),
       payload,
       query: {
         include: include
@@ -194,10 +228,14 @@ export class Client {
    */
   async revert(id, payload, options) {
     const url = `${routing.storiesUrl}/${id}/revert`;
-    const include = options?.include;
+    const {
+      include,
+      formats
+    } = options ?? {};
     const {
       story
     } = await this.apiClient.post(url, {
+      headers: acceptedFormatsHeader(formats),
       payload,
       query: {
         include: include
@@ -207,10 +245,14 @@ export class Client {
   }
   async publish(id, payload, options) {
     const url = `${routing.storiesUrl}/${id}/publish`;
-    const include = options?.include;
+    const {
+      include,
+      formats
+    } = options ?? {};
     const {
       story
     } = await this.apiClient.post(url, {
+      headers: acceptedFormatsHeader(formats),
       payload,
       query: {
         include: include
@@ -220,10 +262,14 @@ export class Client {
   }
   async unpublish(id, payload, options) {
     const url = `${routing.storiesUrl}/${id}/unpublish`;
-    const include = options?.include;
+    const {
+      include,
+      formats
+    } = options ?? {};
     const {
       story
     } = await this.apiClient.post(url, {
+      headers: acceptedFormatsHeader(formats),
       payload,
       query: {
         include: include
@@ -233,10 +279,14 @@ export class Client {
   }
   async schedule(id, payload, options) {
     const url = `${routing.storiesUrl}/${id}/schedule`;
-    const include = options?.include;
+    const {
+      include,
+      formats
+    } = options ?? {};
     const {
       story
     } = await this.apiClient.post(url, {
+      headers: acceptedFormatsHeader(formats),
       payload,
       query: {
         include: include
@@ -246,10 +296,14 @@ export class Client {
   }
   async unschedule(id, payload, options) {
     const url = `${routing.storiesUrl}/${id}/unpublish`;
-    const include = options?.include;
+    const {
+      include,
+      formats
+    } = options ?? {};
     const {
       story
     } = await this.apiClient.post(url, {
+      headers: acceptedFormatsHeader(formats),
       payload,
       query: {
         include: include
@@ -259,23 +313,32 @@ export class Client {
   }
   async pin(id, options) {
     const url = `${routing.storiesUrl}/${id}/pin`;
-    const include = options?.include;
+    const {
+      include,
+      force,
+      formats
+    } = options ?? {};
     const {
       story
     } = await this.apiClient.post(url, {
+      headers: acceptedFormatsHeader(formats),
       query: {
         include: include,
-        force: options?.force || undefined
+        force: force || undefined
       }
     });
     return story;
   }
   async unpin(id, options) {
     const url = `${routing.storiesUrl}/${id}/unpin`;
-    const include = options?.include;
+    const {
+      include,
+      formats
+    } = options ?? {};
     const {
       story
     } = await this.apiClient.post(url, {
+      headers: acceptedFormatsHeader(formats),
       query: {
         include: include
       }
@@ -298,4 +361,12 @@ export class Client {
     });
     return preview;
   }
+}
+function acceptedFormatsHeader(formats = []) {
+  if (formats.length === 0) {
+    return {};
+  }
+  return {
+    Accept: formats.map(format => `application/json; content-format=v${format}`).join(', ')
+  };
 }

package/dist/endpoints/Stories/types.d.ts

@@ -57,6 +57,7 @@ export interface ListOptions<Include extends readonly (keyof Story.ExtraFields)[
     offset?: number;
     sortOrder?: SortOrder | string;
     include?: Include;
+    formats?: Story.FormatVersion[];
 }
 export interface SearchOptions<Include extends readonly (keyof Story.ExtraFields)[]> extends ListOptions<Include> {
     query?: Query;
@@ -69,12 +70,9 @@ export interface ListResponse<S extends Story = Story> {
 }
 interface GenericCreateRequest {
     newsroom?: Newsroom['id'] | Newsroom['uuid'];
-    title?: string;
-    subtitle?: string;
     published_at?: Iso8601DateTime;
     visibility?: Story.Visibility;
     culture?: CultureRef['code'];
-    header_image?: UploadedImage | null;
     preview_image?: UploadedImage | null;
     social_image?: UploadedImage | null;
     social_text?: string;
@@ -83,12 +81,9 @@ interface GenericCreateRequest {
     is_shared_to_prpro?: boolean;
 }
 interface GenericUpdateRequest {
-    title?: string;
-    subtitle?: string;
     published_at?: Iso8601DateTime;
     visibility?: Story.Visibility;
     culture?: CultureRef['code'];
-    header_image?: UploadedImage | null;
     preview_image?: UploadedImage | null;
     social_image?: UploadedImage | null;
     social_text?: string;
@@ -106,6 +101,9 @@ export interface HtmlStoryCreateRequest extends GenericCreateRequest {
      * If format version is omitted, license default editor version will be implied.
      */
     format_version?: Story.FormatVersion.HTML;
+    header_image?: UploadedImage | null;
+    title?: string;
+    subtitle?: string;
     intro?: Html;
     content?: Html;
     attached_attachments_content?: Json;
@@ -114,11 +112,28 @@ export interface HtmlStoryCreateRequest extends GenericCreateRequest {
     attached_gallery_content?: Json;
     attached_videos_content?: Json;
 }
-export interface SlateStoryCreateRequest extends GenericCreateRequest {
+export interface SlateV3StoryCreateRequest extends GenericCreateRequest {
+    /**
+     * If format version is omitted, license default editor version will be implied.
+     */
+    format_version?: Story.FormatVersion.SLATEJS_V3;
+    header_image?: UploadedImage | null;
+    title?: string;
+    subtitle?: string;
+    /**
+     * Intro field is not supported for Prezly Content Format stories.
+     */
+    intro?: never;
+    content?: PrezlyContentFormat;
+}
+export interface SlateV4StoryCreateRequest extends GenericCreateRequest {
     /**
      * If format version is omitted, license default editor version will be implied.
      */
-    format_version?: Story.FormatVersion.SLATEJS;
+    format_version?: Story.FormatVersion.SLATEJS_V4;
+    header_image?: never;
+    title?: never;
+    subtitle?: never;
     /**
      * Intro field is not supported for Prezly Content Format stories.
      */
@@ -126,6 +141,10 @@ export interface SlateStoryCreateRequest extends GenericCreateRequest {
     content?: PrezlyContentFormat;
 }
 export interface HtmlStoryUpdateRequest extends GenericUpdateRequest {
+    format_version?: Story.FormatVersion.HTML;
+    header_image?: UploadedImage | null;
+    title?: string;
+    subtitle?: string;
     intro?: Html;
     content?: Html;
     attached_attachments_content?: Json;
@@ -134,7 +153,24 @@ export interface HtmlStoryUpdateRequest extends GenericUpdateRequest {
     attached_gallery_content?: Json;
     attached_videos_content?: Json;
 }
-export interface SlateStoryUpdateRequest extends GenericUpdateRequest {
+export interface SlateV3StoryUpdateRequest extends GenericUpdateRequest {
+    format_version?: Story.FormatVersion.SLATEJS_V3;
+    header_image?: UploadedImage | null;
+    title?: string;
+    subtitle?: string;
+    /**
+     * Intro field is not supported for Prezly Content Format stories.
+     */
+    intro?: never;
+    content?: PrezlyContentFormat;
+    autosaved_content?: PrezlyContentFormat;
+    content_version?: number;
+}
+export interface SlateV4StoryUpdateRequest extends GenericUpdateRequest {
+    format_version?: Story.FormatVersion.SLATEJS_V4;
+    header_image?: never;
+    title?: never;
+    subtitle?: never;
     /**
      * Intro field is not supported for Prezly Content Format stories.
      */
@@ -155,8 +191,8 @@ export interface PreviewOptions {
 }
 export import Alignment = Campaign.StoryAlignment;
 export import Appearance = Campaign.StoryAppearance;
-export declare type CreateRequest = HtmlStoryCreateRequest | SlateStoryCreateRequest;
-export declare type UpdateRequest = HtmlStoryUpdateRequest | SlateStoryUpdateRequest;
+export declare type CreateRequest = HtmlStoryCreateRequest | SlateV3StoryCreateRequest | SlateV4StoryCreateRequest;
+export declare type UpdateRequest = HtmlStoryUpdateRequest | SlateV3StoryUpdateRequest | SlateV4StoryUpdateRequest;
 export interface AutosaveRequest {
     autosaved_content: PrezlyContentFormat;
     content_version?: number;

package/dist/types/Story.cjs

@@ -11,7 +11,8 @@ exports.Story = Story;
   let FormatVersion;
   (function (FormatVersion) {
     FormatVersion[FormatVersion["HTML"] = 1] = "HTML";
-    FormatVersion[FormatVersion["SLATEJS"] = 3] = "SLATEJS";
+    FormatVersion[FormatVersion["SLATEJS_V3"] = 3] = "SLATEJS_V3";
+    FormatVersion[FormatVersion["SLATEJS_V4"] = 4] = "SLATEJS_V4";
   })(FormatVersion || (FormatVersion = {}));
   _Story.FormatVersion = FormatVersion;
   let Status;
@@ -103,7 +104,21 @@ exports.Story = Story;
     if (typeof arg === 'object' && arg !== null) {
       return isSlateFormat(arg.format_version);
     }
-    return arg === FormatVersion.SLATEJS;
+    return arg === FormatVersion.SLATEJS_V3 || arg === FormatVersion.SLATEJS_V4;
   }
   _Story.isSlateFormat = isSlateFormat;
+  function isSlateV3Format(arg) {
+    if (typeof arg === 'object' && arg !== null) {
+      return arg.format_version === FormatVersion.SLATEJS_V3;
+    }
+    return arg === FormatVersion.SLATEJS_V3;
+  }
+  _Story.isSlateV3Format = isSlateV3Format;
+  function isSlateV4Format(arg) {
+    if (typeof arg === 'object' && arg !== null) {
+      return arg.format_version === FormatVersion.SLATEJS_V4;
+    }
+    return arg === FormatVersion.SLATEJS_V4;
+  }
+  _Story.isSlateV4Format = isSlateV4Format;
 })(Story || (exports.Story = Story = {}));

package/dist/types/Story.d.ts

@@ -138,7 +138,8 @@ export interface Story {
 export declare namespace Story {
     enum FormatVersion {
         HTML = 1,
-        SLATEJS = 3
+        SLATEJS_V3 = 3,
+        SLATEJS_V4 = 4
     }
     enum Status {
         UNINITIALIZED = "uninitialized",
@@ -259,9 +260,17 @@ export declare namespace Story {
     function isLegacyHtmlFormat<T extends Pick<Story, 'format_version'>>(story: T): story is T & {
         format_version: FormatVersion.HTML;
     };
-    function isSlateFormat(format: FormatVersion): format is FormatVersion.SLATEJS;
+    function isSlateFormat(format: FormatVersion): format is FormatVersion.SLATEJS_V3 | FormatVersion.SLATEJS_V4;
     function isSlateFormat<T extends Pick<Story, 'format_version'>>(story: Pick<Story, 'format_version'>): story is T & {
-        format_version: FormatVersion.SLATEJS;
+        format_version: FormatVersion.SLATEJS_V3 | FormatVersion.SLATEJS_V4;
+    };
+    function isSlateV3Format(format: FormatVersion): format is FormatVersion.SLATEJS_V3;
+    function isSlateV3Format<T extends Pick<Story, 'format_version'>>(story: Pick<Story, 'format_version'>): story is T & {
+        format_version: FormatVersion.SLATEJS_V3;
+    };
+    function isSlateV4Format(format: FormatVersion): format is FormatVersion.SLATEJS_V4;
+    function isSlateV4Format<T extends Pick<Story, 'format_version'>>(story: Pick<Story, 'format_version'>): story is T & {
+        format_version: FormatVersion.SLATEJS_V4;
     };
 }
 export interface ExtendedStory extends Story, Pick<Story.ExtraFields, 'thumbnail_image' | 'header_image' | 'preview_image' | 'social_image' | 'social_text' | 'tag_names' | 'content' | 'attached_gallery_content' | 'referenced_entities'> {

package/dist/types/Story.js

@@ -4,7 +4,8 @@ export let Story;
   let FormatVersion;
   (function (FormatVersion) {
     FormatVersion[FormatVersion["HTML"] = 1] = "HTML";
-    FormatVersion[FormatVersion["SLATEJS"] = 3] = "SLATEJS";
+    FormatVersion[FormatVersion["SLATEJS_V3"] = 3] = "SLATEJS_V3";
+    FormatVersion[FormatVersion["SLATEJS_V4"] = 4] = "SLATEJS_V4";
   })(FormatVersion || (FormatVersion = {}));
   _Story.FormatVersion = FormatVersion;
   let Status;
@@ -96,7 +97,21 @@ export let Story;
     if (typeof arg === 'object' && arg !== null) {
       return isSlateFormat(arg.format_version);
     }
-    return arg === FormatVersion.SLATEJS;
+    return arg === FormatVersion.SLATEJS_V3 || arg === FormatVersion.SLATEJS_V4;
   }
   _Story.isSlateFormat = isSlateFormat;
+  function isSlateV3Format(arg) {
+    if (typeof arg === 'object' && arg !== null) {
+      return arg.format_version === FormatVersion.SLATEJS_V3;
+    }
+    return arg === FormatVersion.SLATEJS_V3;
+  }
+  _Story.isSlateV3Format = isSlateV3Format;
+  function isSlateV4Format(arg) {
+    if (typeof arg === 'object' && arg !== null) {
+      return arg.format_version === FormatVersion.SLATEJS_V4;
+    }
+    return arg === FormatVersion.SLATEJS_V4;
+  }
+  _Story.isSlateV4Format = isSlateV4Format;
 })(Story || (Story = {}));

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@prezly/sdk",
-    "version": "15.21.0",
+    "version": "16.0.0",
     "description": "Prezly API SDK",
     "type": "module",
     "main": "dist/index.cjs",