@prezly/sdk 18.2.2 → 19.0.0

package/dist/endpoints/SenderAddresses/index.cjs

@@ -6,6 +6,7 @@ Object.defineProperty(exports, "__esModule", {
 var _Client = require("./Client.cjs");
 Object.keys(_Client).forEach(function (key) {
   if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _Client[key]) return;
   Object.defineProperty(exports, key, {
     enumerable: true,
     get: function () {
@@ -16,6 +17,7 @@ Object.keys(_Client).forEach(function (key) {
 var _types = require("./types.cjs");
 Object.keys(_types).forEach(function (key) {
   if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _types[key]) return;
   Object.defineProperty(exports, key, {
     enumerable: true,
     get: function () {

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

@@ -1,7 +1,7 @@
 import type { DeferredJobsApiClient } from '../../api';
 import type { Snippet } from '../../types';
 import type { CreateRequest, UpdateRequest } from './types';
-declare type SnippetId = Snippet['uuid'] | Snippet['id'];
+type SnippetId = Snippet['uuid'] | Snippet['id'];
 export declare class Client {
     private readonly apiClient;
     constructor(apiClient: DeferredJobsApiClient);

package/dist/endpoints/Snippets/index.cjs

@@ -6,6 +6,7 @@ Object.defineProperty(exports, "__esModule", {
 var _Client = require("./Client.cjs");
 Object.keys(_Client).forEach(function (key) {
   if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _Client[key]) return;
   Object.defineProperty(exports, key, {
     enumerable: true,
     get: function () {
@@ -16,6 +17,7 @@ Object.keys(_Client).forEach(function (key) {
 var _types = require("./types.cjs");
 Object.keys(_types).forEach(function (key) {
   if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _types[key]) return;
   Object.defineProperty(exports, key, {
     enumerable: true,
     get: function () {

package/dist/endpoints/Stories/Client.cjs

@@ -8,6 +8,15 @@ var _index = require("../../http/index.cjs");
 var _routing = require("../../routing.cjs");
 var _index2 = require("../../types/index.cjs");
 var _types = require("./types.cjs");
+/**
+ * `uuid` is the preferred way of targeting a Story. Numeric `id` is considered deprecated.
+ */
+
+/**
+ * Utility type to forbid arbitrary ad-hoc extensions of generic parameters.
+ * @see https://stackoverflow.com/a/69666350
+ */
+
 class Client {
   constructor(apiClient) {
     this.apiClient = apiClient;
@@ -59,6 +68,20 @@ class Client {
    * Get story by UUID.
    */
 
+  /**
+   * Get multiple stories by UUIDs.
+   */
+
+  /**
+   * Get story by deprecated numeric ID, or UUID.
+   * @deprecated Please use UUID instead.
+   */
+
+  /**
+   * Get multiple stories by numeric IDs.
+   * @deprecated Please use UUID instead.
+   */
+
   /**
    * Implementation
    */
@@ -112,22 +135,46 @@ class Client {
     });
     return story;
   }
-  async create(payload, options) {
+  async getBySlug(slug, options) {
+    if (slug.includes('/') || slug.includes('\\')) {
+      throw new Error('Story slugs cannot contain slashes.');
+    }
     const {
       include,
+      query,
       formats
     } = options ?? {};
     const {
       story
-    } = await this.apiClient.post(_routing.routing.storiesUrl, {
+    } = await this.apiClient.post(`${_routing.routing.storiesUrl}/by-slug/${slug}`, {
       headers: acceptedFormatsHeader(formats),
-      payload,
       query: {
         include
+      },
+      payload: {
+        query
       }
     });
     return story;
   }
+  async create(payload, options) {
+    const {
+      include,
+      formats,
+      force = false
+    } = options ?? {};
+    const {
+      story
+    } = await this.apiClient.post(_routing.routing.storiesUrl, {
+      headers: acceptedFormatsHeader(formats),
+      query: {
+        include,
+        force: force || undefined // only pass it if it's true
+      },
+      payload
+    });
+    return story;
+  }
   async duplicate(id, options) {
     const {
       include,
@@ -169,8 +216,8 @@ class Client {
   async move(id, payload, options) {
     const {
       include,
-      force,
-      formats
+      formats,
+      force = false
     } = options ?? {};
     const url = `${_routing.routing.storiesUrl}/${id}/move`;
     try {
@@ -179,8 +226,8 @@ class Client {
       } = await this.apiClient.post(url, {
         headers: acceptedFormatsHeader(formats),
         query: {
-          include: include,
-          force
+          include,
+          force: force || undefined // only pass it if it's true
         },
         payload
       });
@@ -199,16 +246,18 @@ class Client {
     const url = `${_routing.routing.storiesUrl}/${id}`;
     const {
       include,
-      formats
+      formats,
+      force = false
     } = options ?? {};
     const {
       story
     } = await this.apiClient.patch(url, {
       headers: acceptedFormatsHeader(formats),
-      payload,
       query: {
-        include: include
-      }
+        include,
+        force: force || undefined // only pass it if it's true
+      },
+      payload
     });
     return story;
   }
@@ -228,7 +277,7 @@ class Client {
       headers: acceptedFormatsHeader(formats),
       payload,
       query: {
-        include: include
+        include
       }
     });
     return story;
@@ -249,7 +298,7 @@ class Client {
       headers: acceptedFormatsHeader(formats),
       payload,
       query: {
-        include: include
+        include
       }
     });
     return story;
@@ -266,7 +315,7 @@ class Client {
       headers: acceptedFormatsHeader(formats),
       payload,
       query: {
-        include: include
+        include
       }
     });
     return story;
@@ -283,7 +332,7 @@ class Client {
       headers: acceptedFormatsHeader(formats),
       payload,
       query: {
-        include: include
+        include
       }
     });
     return story;
@@ -300,7 +349,7 @@ class Client {
       headers: acceptedFormatsHeader(formats),
       payload,
       query: {
-        include: include
+        include
       }
     });
     return story;
@@ -317,7 +366,7 @@ class Client {
       headers: acceptedFormatsHeader(formats),
       payload,
       query: {
-        include: include
+        include
       }
     });
     return story;
@@ -326,8 +375,8 @@ class Client {
     const url = `${_routing.routing.storiesUrl}/${id}/pin`;
     const {
       include,
-      force,
-      formats
+      formats,
+      force = false
     } = options ?? {};
     const {
       story
@@ -335,7 +384,7 @@ class Client {
       headers: acceptedFormatsHeader(formats),
       query: {
         include: include,
-        force: force || undefined
+        force: force || undefined // only pass it if it's true
       }
     });
     return story;

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

@@ -1,17 +1,17 @@
 import type { DeferredJobsApiClient } from '../../api';
-import type { ExtendedStory, Story } from '../../types';
+import type { ExtendedStory, Query, Story } from '../../types';
 import type { AutosaveRequest, ChangeNewsroomSuccessResponse, ChangeNewsroomUnsafeResponse, CreateRequest, IncludeOptions, ListOptions, ListResponse, MoveRequest, PreviewResponse, PreviewOptions, PublishRequest, RevertRequest, ScheduleRequest, SearchOptions, TranslateRequest, UnpublishRequest, UnscheduleRequest, UpdateRequest } from './types';
 /**
  * `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[];
+type StoryId = Story['uuid'] | Story['id'];
+type Formats = Story.FormatVersion[];
 /**
  * Utility type to forbid arbitrary ad-hoc extensions of generic parameters.
  * @see https://stackoverflow.com/a/69666350
  */
-declare type Exactly<Concrete, Abstract> = Concrete & Record<Exclude<keyof Concrete, keyof Abstract>, never>;
-declare type InferExtraFields<T> = T extends Required<IncludeOptions<infer I>> ? Pick<Story.ExtraFields, I> : unknown;
+type Exactly<Concrete, Abstract> = Concrete & Record<Exclude<keyof Concrete, keyof Abstract>, never>;
+type InferExtraFields<T> = T extends Required<IncludeOptions<infer I>> ? Pick<Story.ExtraFields, I> : unknown;
 export declare class Client {
     private readonly apiClient;
     constructor(apiClient: DeferredJobsApiClient);
@@ -51,10 +51,19 @@ export declare class Client {
     }>(ids: Story['id'][], options?: Exactly<Options, IncludeOptions & {
         formats?: Formats;
     }>): Promise<(ExtendedStory & InferExtraFields<Options>)[]>;
+    getBySlug<Options extends IncludeOptions & {
+        formats?: Formats;
+        query?: Query;
+    }>(slug: Story['slug'], options?: Exactly<Options, IncludeOptions & {
+        formats?: Formats;
+        query?: Query;
+    }>): Promise<ExtendedStory & InferExtraFields<Options>>;
     create<Options extends IncludeOptions & {
         formats?: Formats;
+        force?: boolean;
     }>(payload: CreateRequest, options?: Exactly<Options, IncludeOptions & {
         formats?: Formats;
+        force?: boolean;
     }>): Promise<ExtendedStory & InferExtraFields<Options>>;
     duplicate<Options extends IncludeOptions & {
         formats?: Formats;
@@ -67,16 +76,18 @@ export declare class Client {
         formats?: Formats;
     }>): Promise<ExtendedStory & InferExtraFields<Options>>;
     move<Options extends IncludeOptions & {
-        force?: true;
         formats?: Formats;
+        force?: boolean;
     }>(id: StoryId, payload: MoveRequest, options?: Exactly<Options, IncludeOptions & {
-        force?: true;
         formats?: Formats;
+        force?: boolean;
     }>): Promise<ChangeNewsroomSuccessResponse<ExtendedStory & InferExtraFields<Options>> | ChangeNewsroomUnsafeResponse>;
     update<Options extends IncludeOptions & {
         formats?: Formats;
+        force?: boolean;
     }>(id: StoryId, payload: UpdateRequest, options?: Exactly<Options, IncludeOptions & {
         formats?: Formats;
+        force?: boolean;
     }>): Promise<ExtendedStory & InferExtraFields<Options>>;
     /**
      * This operation is only allowed for V3 stories
@@ -115,11 +126,11 @@ export declare class Client {
         formats?: Formats;
     }>): Promise<ExtendedStory & InferExtraFields<Options>>;
     pin<Options extends IncludeOptions & {
-        force?: boolean;
         formats?: Formats;
-    }>(id: StoryId, options?: Exactly<Options, IncludeOptions & {
         force?: boolean;
+    }>(id: StoryId, options?: Exactly<Options, IncludeOptions & {
         formats?: Formats;
+        force?: boolean;
     }>): Promise<ExtendedStory & InferExtraFields<Options>>;
     unpin<Options extends IncludeOptions & {
         formats?: Formats;

package/dist/endpoints/Stories/Client.js

@@ -1,9 +1,14 @@
 import { ApiError, HttpCodes } from "../../http/index.js";
 import { routing } from "../../routing.js";
 import { SortOrder } from "../../types/index.js";
-import { EXTENDED_STORY_INCLUDED_EXTRA_FIELDS } from "./types.js"; /**
-                                                                    * `uuid` is the preferred way of targeting a Story. Numeric `id` is considered deprecated.
-                                                                    */
+import { EXTENDED_STORY_INCLUDED_EXTRA_FIELDS } from "./types.js";
+/**
+ * `uuid` is the preferred way of targeting a Story. Numeric `id` is considered deprecated.
+ */
+/**
+ * Utility type to forbid arbitrary ad-hoc extensions of generic parameters.
+ * @see https://stackoverflow.com/a/69666350
+ */
 export class Client {
   constructor(apiClient) {
     this.apiClient = apiClient;
@@ -55,6 +60,20 @@ export class Client {
    * Get story by UUID.
    */
 
+  /**
+   * Get multiple stories by UUIDs.
+   */
+
+  /**
+   * Get story by deprecated numeric ID, or UUID.
+   * @deprecated Please use UUID instead.
+   */
+
+  /**
+   * Get multiple stories by numeric IDs.
+   * @deprecated Please use UUID instead.
+   */
+
   /**
    * Implementation
    */
@@ -108,22 +127,46 @@ export class Client {
     });
     return story;
   }
-  async create(payload, options) {
+  async getBySlug(slug, options) {
+    if (slug.includes('/') || slug.includes('\\')) {
+      throw new Error('Story slugs cannot contain slashes.');
+    }
     const {
       include,
+      query,
       formats
     } = options ?? {};
     const {
       story
-    } = await this.apiClient.post(routing.storiesUrl, {
+    } = await this.apiClient.post(`${routing.storiesUrl}/by-slug/${slug}`, {
       headers: acceptedFormatsHeader(formats),
-      payload,
       query: {
         include
+      },
+      payload: {
+        query
       }
     });
     return story;
   }
+  async create(payload, options) {
+    const {
+      include,
+      formats,
+      force = false
+    } = options ?? {};
+    const {
+      story
+    } = await this.apiClient.post(routing.storiesUrl, {
+      headers: acceptedFormatsHeader(formats),
+      query: {
+        include,
+        force: force || undefined // only pass it if it's true
+      },
+      payload
+    });
+    return story;
+  }
   async duplicate(id, options) {
     const {
       include,
@@ -165,8 +208,8 @@ export class Client {
   async move(id, payload, options) {
     const {
       include,
-      force,
-      formats
+      formats,
+      force = false
     } = options ?? {};
     const url = `${routing.storiesUrl}/${id}/move`;
     try {
@@ -175,8 +218,8 @@ export class Client {
       } = await this.apiClient.post(url, {
         headers: acceptedFormatsHeader(formats),
         query: {
-          include: include,
-          force
+          include,
+          force: force || undefined // only pass it if it's true
         },
         payload
       });
@@ -195,16 +238,18 @@ export class Client {
     const url = `${routing.storiesUrl}/${id}`;
     const {
       include,
-      formats
+      formats,
+      force = false
     } = options ?? {};
     const {
       story
     } = await this.apiClient.patch(url, {
       headers: acceptedFormatsHeader(formats),
-      payload,
       query: {
-        include: include
-      }
+        include,
+        force: force || undefined // only pass it if it's true
+      },
+      payload
     });
     return story;
   }
@@ -224,7 +269,7 @@ export class Client {
       headers: acceptedFormatsHeader(formats),
       payload,
       query: {
-        include: include
+        include
       }
     });
     return story;
@@ -245,7 +290,7 @@ export class Client {
       headers: acceptedFormatsHeader(formats),
       payload,
       query: {
-        include: include
+        include
       }
     });
     return story;
@@ -262,7 +307,7 @@ export class Client {
       headers: acceptedFormatsHeader(formats),
       payload,
       query: {
-        include: include
+        include
       }
     });
     return story;
@@ -279,7 +324,7 @@ export class Client {
       headers: acceptedFormatsHeader(formats),
       payload,
       query: {
-        include: include
+        include
       }
     });
     return story;
@@ -296,7 +341,7 @@ export class Client {
       headers: acceptedFormatsHeader(formats),
       payload,
       query: {
-        include: include
+        include
       }
     });
     return story;
@@ -313,7 +358,7 @@ export class Client {
       headers: acceptedFormatsHeader(formats),
       payload,
       query: {
-        include: include
+        include
       }
     });
     return story;
@@ -322,8 +367,8 @@ export class Client {
     const url = `${routing.storiesUrl}/${id}/pin`;
     const {
       include,
-      force,
-      formats
+      formats,
+      force = false
     } = options ?? {};
     const {
       story
@@ -331,7 +376,7 @@ export class Client {
       headers: acceptedFormatsHeader(formats),
       query: {
         include: include,
-        force: force || undefined
+        force: force || undefined // only pass it if it's true
       }
     });
     return story;

package/dist/endpoints/Stories/index.cjs

@@ -6,6 +6,7 @@ Object.defineProperty(exports, "__esModule", {
 var _Client = require("./Client.cjs");
 Object.keys(_Client).forEach(function (key) {
   if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _Client[key]) return;
   Object.defineProperty(exports, key, {
     enumerable: true,
     get: function () {
@@ -16,6 +17,7 @@ Object.keys(_Client).forEach(function (key) {
 var _types = require("./types.cjs");
 Object.keys(_types).forEach(function (key) {
   if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _types[key]) return;
   Object.defineProperty(exports, key, {
     enumerable: true,
     get: function () {
@@ -26,6 +28,7 @@ Object.keys(_types).forEach(function (key) {
 var _scopes = require("./scopes.cjs");
 Object.keys(_scopes).forEach(function (key) {
   if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _scopes[key]) return;
   Object.defineProperty(exports, key, {
     enumerable: true,
     get: function () {

package/dist/endpoints/Stories/scopes.cjs

@@ -5,11 +5,10 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.Scope = void 0;
 var _index = require("../../types/index.cjs");
-const Scope = {
+const Scope = exports.Scope = {
   EXCLUDE_ARCHIVED_NEWSROOMS: {
     'newsroom.status': {
       $nin: [_index.Newsroom.Status.ARCHIVED]
     }
   }
-};
-exports.Scope = Scope;
+};

package/dist/endpoints/Stories/types.cjs

@@ -5,6 +5,18 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.EXTENDED_STORY_INCLUDED_EXTRA_FIELDS = exports.ALL_EXTRA_FIELDS = void 0;
 var _index = require("../../types/index.cjs");
+/**
+ * Uploadcare image JSON string.
+ */
+/**
+ * Raw HTML string.
+ */
+/**
+ * String-serialized JSON object.
+ */
+/**
+ * String containing Prezly Content Format JSON structure.
+ */
 var Alignment = _index.Campaign.StoryAlignment;
 var Appearance = _index.Campaign.StoryAppearance;
 const EXTENDED_STORY_INCLUDED_EXTRA_FIELDS_SHAPE = {
@@ -40,7 +52,5 @@ const ALL_EXTRA_FIELDS_SHAPE = {
   'pitches.count': true
 }; // satisfies Record<keyof Story.OnDemandFields, boolean>; // TODO: Use Typescript `satisfies` operator, when it's out of beta
 
-const ALL_EXTRA_FIELDS = Object.keys(ALL_EXTRA_FIELDS_SHAPE);
-exports.ALL_EXTRA_FIELDS = ALL_EXTRA_FIELDS;
-const EXTENDED_STORY_INCLUDED_EXTRA_FIELDS = Object.keys(EXTENDED_STORY_INCLUDED_EXTRA_FIELDS_SHAPE);
-exports.EXTENDED_STORY_INCLUDED_EXTRA_FIELDS = EXTENDED_STORY_INCLUDED_EXTRA_FIELDS;
+const ALL_EXTRA_FIELDS = exports.ALL_EXTRA_FIELDS = Object.keys(ALL_EXTRA_FIELDS_SHAPE);
+const EXTENDED_STORY_INCLUDED_EXTRA_FIELDS = exports.EXTENDED_STORY_INCLUDED_EXTRA_FIELDS = Object.keys(EXTENDED_STORY_INCLUDED_EXTRA_FIELDS_SHAPE);

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

@@ -3,20 +3,20 @@ import { Campaign } from '../../types';
 /**
  * Uploadcare image JSON string.
  */
-declare type UploadedImage = string;
-declare type Iso8601DateTime = string;
+type UploadedImage = string;
+type Iso8601DateTime = string;
 /**
  * Raw HTML string.
  */
-declare type Html = string;
+type Html = string;
 /**
  * String-serialized JSON object.
  */
-declare type Json = string;
+type Json = string;
 /**
  * String containing Prezly Content Format JSON structure.
  */
-declare type PrezlyContentFormat = string;
+type PrezlyContentFormat = string;
 interface BaseWarning {
     text: string;
     scope: string;
@@ -48,7 +48,7 @@ interface StoryEmbeddedContactsWillBeRemovedWarning extends BaseWarning {
     field: 'room_contacts';
     value: NewsroomContactRef[];
 }
-export declare type ChangeNewsroomWarning = ChangingNewsroomUnsafeOperationWarning | DestinationNewsroomMissingCategoriesWarning | DestinationNewsroomMissingCulturesWarning | StoryEmbeddedContactsWillBeRemovedWarning | StoryTranslationsWillMoveWarning;
+export type ChangeNewsroomWarning = ChangingNewsroomUnsafeOperationWarning | DestinationNewsroomMissingCategoriesWarning | DestinationNewsroomMissingCulturesWarning | StoryEmbeddedContactsWillBeRemovedWarning | StoryTranslationsWillMoveWarning;
 export interface IncludeOptions<Include extends keyof Story.ExtraFields = keyof Story.ExtraFields> {
     include?: Include[];
 }
@@ -70,6 +70,15 @@ export interface ListResponse<S extends Story = Story> {
     sort: string;
 }
 interface GenericCreateRequest {
+    /**
+     * Set a custom slug for a Story.
+     *
+     * - If there is another story with exactly the same slug value, the Create request will throw [HTTP 409 Conflict].
+     *
+     * - Conflicts can be force-resolved by passing `?force` GET parameter.
+     *   This will update other conflicting stories slugs to something else (i.e. adding random suffix).
+     */
+    slug?: Story['slug'];
     newsroom?: Newsroom['id'] | Newsroom['uuid'];
     published_at?: Iso8601DateTime;
     visibility?: Story.Visibility;
@@ -82,6 +91,16 @@ interface GenericCreateRequest {
     is_shared_to_prpro?: boolean;
 }
 interface GenericUpdateRequest {
+    /**
+     * Set a custom slug for a Story.
+     * Updating it to `null` will revert back to automatically generated slugs.
+     *
+     * - If there is another story with exactly the same slug value, the Update request will throw [HTTP 409 Conflict].
+     *
+     * - Conflicts can be force-resolved by passing `?force` GET parameter.
+     *   This will update other conflicting stories slugs to something else (i.e. adding random suffix).
+     */
+    slug?: Story['slug'] | null;
     published_at?: Iso8601DateTime;
     visibility?: Story.Visibility;
     culture?: CultureRef['code'];
@@ -201,8 +220,8 @@ export interface PreviewOptions {
 }
 export import Alignment = Campaign.StoryAlignment;
 export import Appearance = Campaign.StoryAppearance;
-export declare type CreateRequest = HtmlStoryCreateRequest | SlateV3StoryCreateRequest | SlateV4StoryCreateRequest | SlateV5StoryCreateRequest;
-export declare type UpdateRequest = HtmlStoryUpdateRequest | SlateV3StoryUpdateRequest | SlateV4StoryUpdateRequest | SlateV5StoryUpdateRequest;
+export type CreateRequest = HtmlStoryCreateRequest | SlateV3StoryCreateRequest | SlateV4StoryCreateRequest | SlateV5StoryCreateRequest;
+export type UpdateRequest = HtmlStoryUpdateRequest | SlateV3StoryUpdateRequest | SlateV4StoryUpdateRequest | SlateV5StoryUpdateRequest;
 export interface AutosaveRequest {
     autosaved_content: PrezlyContentFormat;
     content_version?: number;
@@ -221,7 +240,7 @@ export interface ScheduleRequest {
     publish_at: Iso8601DateTime;
     visibility?: Story.Visibility.PUBLIC | Story.Visibility.EMBARGO;
 }
-export declare type UnscheduleRequest = UnpublishRequest;
+export type UnscheduleRequest = UnpublishRequest;
 export interface TranslateRequest {
     culture?: CultureRef['code'];
 }