@prezly/sdk 10.3.0 → 11.0.0

package/dist/api/constants.js

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

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

@@ -1,9 +1,9 @@
 import type { DeferredJobsApiClient } from '../../api';
 import type { NotificationSubscription } from '../../types';
-import type { NotificationSubscriptionsUpdateRequest } from './types';
+import type { UpdateRequest } from './types';
 export declare class Client {
     private readonly apiClient;
     constructor(apiClient: DeferredJobsApiClient);
     list(): Promise<NotificationSubscription[]>;
-    update(payload: NotificationSubscriptionsUpdateRequest): Promise<NotificationSubscription[]>;
+    update(payload: UpdateRequest): Promise<NotificationSubscription[]>;
 }

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

@@ -1,6 +1,4 @@
-export interface NotificationSubscriptionsUpdateRequest {
-    subscriptions: {
-        notification_type: string;
-        is_email_subscribed: boolean;
-    }[];
+import type { NotificationSubscription } from '../../types';
+export interface UpdateRequest {
+    subscriptions: Pick<NotificationSubscription, 'notification_type' | 'is_email_subscribed'>[];
 }

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

@@ -1,6 +1,6 @@
 import type { DeferredJobsApiClient } from '../../api';
 import type { ExtendedStory, Story } from '../../types';
-import type { AutosaveRequest, CreateRequest, IncludeOptions, ListOptions, ListResponse, PublishRequest, RevertRequest, ScheduleRequest, SearchOptions, UnpublishRequest, UnscheduleRequest, UpdateRequest } from './types';
+import type { AutosaveRequest, ChangeNewsroomSuccessResponse, ChangeNewsroomUnsafeResponse, CreateRequest, IncludeOptions, ListOptions, ListResponse, MoveRequest, PublishRequest, RevertRequest, ScheduleRequest, SearchOptions, UnpublishRequest, UnscheduleRequest, UpdateRequest } from './types';
 /**
  * `uuid` is the preferred way of targeting a Story. Numeric `id` is considered deprecated.
  */
@@ -30,6 +30,9 @@ export declare class Client {
     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?: 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?: 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?: Options): Promise<StoryRecord>;
+    move<Include extends readonly (keyof Story.ExtraFields)[], Options extends IncludeOptions<Include> & {
+        force?: true;
+    }, StoryRecord extends ExtendedStory = Options['include'] extends Include ? ExtendedStory & Pick<Story.ExtraFields, Options['include'][number]> : ExtendedStory>(id: StoryId, payload: MoveRequest, options?: Options): 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?: Options): Promise<StoryRecord>;
     /**
      * This operation is only allowed for V3 stories

package/dist/endpoints/Stories/Client.js

@@ -1,3 +1,5 @@
+import { HttpCodes } from "../../http/index.js";
+import { ApiError } from "../../http/ApiError.js";
 import { routing } from "../../routing.js";
 export class Client {
   constructor(apiClient) {
@@ -113,6 +115,31 @@ export class Client {
     });
     return story;
   }
+  async move(id, payload, options) {
+    const include = options?.include;
+    const force = options?.force;
+    const url = `${routing.storiesUrl}/${id}/move`;
+    try {
+      const {
+        story
+      } = await this.apiClient.post(url, {
+        query: {
+          include: include,
+          force
+        },
+        payload
+      });
+      return {
+        status: 'success',
+        story
+      };
+    } catch (error) {
+      if (error instanceof ApiError && error.status === HttpCodes.CONFLICT) {
+        return error.payload;
+      }
+      throw error;
+    }
+  }
   async update(id, payload, options) {
     const url = `${routing.storiesUrl}/${id}`;
     const include = options?.include;

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

@@ -1,4 +1,4 @@
-import type { Category, CultureRef, Newsroom, Pagination, Query, Story } from '../../types';
+import type { Category, CategoryRef, CultureRef, ExtendedStory, Newsroom, NewsroomContactRef, Pagination, Query, Story, Warning as BaseWarning } from '../../types';
 /**
  * Uploadcare image JSON string.
  */
@@ -12,6 +12,32 @@ declare type Html = string;
  * String containing Prezly Content Format JSON structure.
  */
 declare type PrezlyContentFormat = string;
+interface ChangingNewsroomUnsafeOperationWarning extends BaseWarning {
+    scope: 'room_id';
+    field: 'room_id';
+    value: Newsroom['id'];
+}
+interface DestinationNewsroomMissingCategoriesWarning extends BaseWarning {
+    scope: 'room_id';
+    field: 'categories';
+    value: CategoryRef[];
+}
+interface DestinationNewsroomMissingCulturesWarning extends BaseWarning {
+    scope: 'room_id';
+    field: 'cultures';
+    value: CultureRef[];
+}
+interface StoryTranslationsWillMoveWarning extends BaseWarning {
+    scope: 'room_id';
+    field: 'translations';
+    value: CultureRef[];
+}
+interface StoryEmbeddedContactsWillBeRemovedWarning extends BaseWarning {
+    scope: 'room_id';
+    field: 'room_contacts';
+    value: NewsroomContactRef[];
+}
+export declare type ChangeNewsroomWarning = ChangingNewsroomUnsafeOperationWarning | DestinationNewsroomMissingCategoriesWarning | DestinationNewsroomMissingCulturesWarning | StoryEmbeddedContactsWillBeRemovedWarning | StoryTranslationsWillMoveWarning;
 export interface IncludeOptions<Include extends readonly (keyof Story.ExtraFields)[]> {
     include?: Include;
 }
@@ -120,6 +146,19 @@ export interface ScheduleRequest {
     visibility?: Story.Visibility.PUBLIC | Story.Visibility.EMBARGO;
 }
 export declare type UnscheduleRequest = UnpublishRequest;
+export interface MoveRequest {
+    newsroom: Newsroom['uuid'] | Newsroom['id'];
+}
+export interface ChangeNewsroomSuccessResponse<T extends ExtendedStory> {
+    status: 'success';
+    story: T;
+}
+export interface ChangeNewsroomUnsafeResponse {
+    status: 'error';
+    code: 'unsafe';
+    message: string;
+    warnings: ChangeNewsroomWarning[];
+}
 export declare const ALL_EXTRA_FIELDS: (keyof Story.ExtraFields)[];
 export declare const EXTENDED_STORY_INCLUDED_EXTRA_FIELDS: ("content" | "thumbnail_image" | "header_image" | "preview_image" | "social_image" | "social_text" | "tag_names" | "attached_gallery_content" | "referenced_entities")[];
 export {};

package/dist/http/types.d.ts

@@ -2,6 +2,7 @@ export declare enum HttpCodes {
     ACCEPTED = 202,
     NO_CONTENT = 204,
     NOT_FOUND = 404,
+    CONFLICT = 409,
     GONE = 410,
     PRECONDITION_FAILED = 412
 }

package/dist/http/types.js

@@ -3,6 +3,7 @@ export let HttpCodes;
   HttpCodes[HttpCodes["ACCEPTED"] = 202] = "ACCEPTED";
   HttpCodes[HttpCodes["NO_CONTENT"] = 204] = "NO_CONTENT";
   HttpCodes[HttpCodes["NOT_FOUND"] = 404] = "NOT_FOUND";
+  HttpCodes[HttpCodes["CONFLICT"] = 409] = "CONFLICT";
   HttpCodes[HttpCodes["GONE"] = 410] = "GONE";
   HttpCodes[HttpCodes["PRECONDITION_FAILED"] = 412] = "PRECONDITION_FAILED";
 })(HttpCodes || (HttpCodes = {}));

package/dist/types/Category.d.ts

@@ -1,5 +1,5 @@
 import type { CultureRef } from './Culture';
-export interface Category {
+export interface CategoryRef {
     id: number;
     display_name: string;
     display_description: string | null;
@@ -13,3 +13,6 @@ export interface Category {
     };
     stories_number: number;
 }
+export interface Category extends CategoryRef {
+    stories_number: number;
+}

package/dist/types/NewsroomContact.d.ts

@@ -1,6 +1,6 @@
 import type { UploadedImage } from '@prezly/uploads';
 import type { CultureRef } from './Culture';
-export interface NewsroomContact {
+export interface NewsroomContactRef {
     uuid: string;
     /**
      * @deprecated Please use `uuid` as identifier.
@@ -16,6 +16,9 @@ export interface NewsroomContact {
     website: string | null;
     twitter: string | null;
     facebook: string | null;
+    avatar_url: string | null;
+}
+export interface NewsroomContact extends Omit<NewsroomContactRef, 'avatar_url'> {
     avatar_image: UploadedImage | null;
     /**
      * Featured contacts are listed on the newsroom homepage.

package/dist/types/NotificationSubscription.d.ts

@@ -1,8 +1,20 @@
-import type { NotificationType } from './NotificationType';
 export interface NotificationSubscription {
-    notification_type: NotificationType;
+    notification_type: NotificationSubscription.Type;
     is_email_subscribed: boolean;
     is_receiving: boolean;
     missing_permissions: string[];
     missing_features: string[];
 }
+export declare namespace NotificationSubscription {
+    interface Type {
+        id: string;
+        title: string;
+        description: string | null;
+        area: Area;
+    }
+    enum Area {
+        CAMPAIGNS = "Campaigns",
+        CONTACTS = "Contacts",
+        BILLING_AND_LEGAL = "Billing & Legal"
+    }
+}

package/dist/types/NotificationSubscription.js

@@ -1 +1,10 @@
-export {};
+export let NotificationSubscription;
+(function (_NotificationSubscription) {
+  let Area;
+  (function (Area) {
+    Area["CAMPAIGNS"] = "Campaigns";
+    Area["CONTACTS"] = "Contacts";
+    Area["BILLING_AND_LEGAL"] = "Billing & Legal";
+  })(Area || (Area = {}));
+  _NotificationSubscription.Area = Area;
+})(NotificationSubscription || (NotificationSubscription = {}));

package/dist/types/index.d.ts

@@ -28,5 +28,3 @@ export * from './Story';
 export * from './User';
 export * from './UserAccount';
 export * from './NotificationSubscription';
-export * from './NotificationType';
-export * from './NotificationTypeArea';

package/dist/types/index.js

@@ -28,6 +28,4 @@ export * from "./Snippet.js";
 export * from "./Story.js";
 export * from "./User.js";
 export * from "./UserAccount.js";
-export * from "./NotificationSubscription.js";
-export * from "./NotificationType.js";
-export * from "./NotificationTypeArea.js";
+export * from "./NotificationSubscription.js";

package/package.json

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

package/dist/types/NotificationType.d.ts

@@ -1,7 +0,0 @@
-import type { NotificationTypeArea } from './NotificationTypeArea';
-export interface NotificationType {
-    id: string;
-    title: string;
-    description: string | null;
-    area: NotificationTypeArea;
-}

package/dist/types/NotificationType.js

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

package/dist/types/NotificationTypeArea.d.ts

@@ -1,5 +0,0 @@
-export declare enum NotificationTypeArea {
-    CAMPAIGNS = "Campaigns",
-    CONTACTS = "Contacts",
-    BILLING_AND_LEGAL = "Billing & Legal"
-}

package/dist/types/NotificationTypeArea.js

@@ -1,6 +0,0 @@
-export let NotificationTypeArea;
-(function (NotificationTypeArea) {
-  NotificationTypeArea["CAMPAIGNS"] = "Campaigns";
-  NotificationTypeArea["CONTACTS"] = "Contacts";
-  NotificationTypeArea["BILLING_AND_LEGAL"] = "Billing & Legal";
-})(NotificationTypeArea || (NotificationTypeArea = {}));