@prezly/sdk 7.12.0 → 9.0.0

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

@@ -0,0 +1,15 @@
+import type { NewsroomWebhook } from '../../types';
+export interface CreateRequest {
+    name: string;
+    url: string;
+    events?: NewsroomWebhook.Event[];
+    secret?: string | null;
+    is_active?: boolean;
+}
+export interface UpdateRequest {
+    name?: string;
+    url?: string;
+    events?: NewsroomWebhook.Event[];
+    secret?: string | null;
+    is_active?: boolean;
+}

package/dist/endpoints/NewsroomWebhooks/types.js

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

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

@@ -0,0 +1,19 @@
+import type { DeferredJobsApiClient } from '../../api';
+import type { Newsroom } from '../../types';
+import type { CreateRequest, ListOptions, ListResponse, SearchOptions, UpdateRequest } from './types';
+declare type NewsroomId = Newsroom['uuid'] | Newsroom['id'];
+export declare class Client {
+    private readonly apiClient;
+    constructor(apiClient: DeferredJobsApiClient);
+    list({ limit, offset, search, sortOrder }?: ListOptions): Promise<ListResponse>;
+    search(options?: SearchOptions): Promise<ListResponse>;
+    get(id: NewsroomId): Promise<Newsroom>;
+    create(payload: CreateRequest): Promise<Newsroom>;
+    update(id: NewsroomId, payload: UpdateRequest): Promise<Newsroom>;
+    archive(id: NewsroomId): Promise<Newsroom>;
+    unarchive(id: NewsroomId): Promise<Newsroom>;
+    remove(id: NewsroomId): Promise<void>;
+    takeOffline(id: NewsroomId): Promise<Newsroom>;
+    takeOnline(id: NewsroomId): Promise<Newsroom>;
+}
+export {};

package/dist/endpoints/Newsrooms/Client.js

@@ -0,0 +1,90 @@
+import { routing } from "../../routing.js";
+import { Query } from "../../types/index.js";
+export class Client {
+  constructor(apiClient) {
+    this.apiClient = apiClient;
+  }
+  async list({
+    limit,
+    offset,
+    search,
+    sortOrder
+  } = {}) {
+    return this.apiClient.get(routing.newsroomsUrl, {
+      query: {
+        limit,
+        offset,
+        search,
+        sort: sortOrder
+      }
+    });
+  }
+  async search(options = {}) {
+    const {
+      query,
+      limit,
+      offset,
+      search,
+      sortOrder
+    } = options;
+    // TODO: Introduce dedicated Search POST API
+    return this.apiClient.get(routing.newsroomsUrl, {
+      query: {
+        query: Query.stringify(query),
+        limit,
+        offset,
+        search,
+        sort: sortOrder
+      }
+    });
+  }
+  async get(id) {
+    const {
+      newsroom
+    } = await this.apiClient.get(`${routing.newsroomsUrl}/${id}`);
+    return newsroom;
+  }
+  async create(payload) {
+    const {
+      newsroom
+    } = await this.apiClient.post(routing.newsroomsUrl, {
+      payload
+    });
+    return newsroom;
+  }
+  async update(id, payload) {
+    const {
+      newsroom
+    } = await this.apiClient.patch(`${routing.newsroomsUrl}/${id}`, {
+      payload
+    });
+    return newsroom;
+  }
+  async archive(id) {
+    const {
+      newsroom
+    } = await this.apiClient.post(`${routing.newsroomsUrl}/${id}/archive`);
+    return newsroom;
+  }
+  async unarchive(id) {
+    const {
+      newsroom
+    } = await this.apiClient.post(`${routing.newsroomsUrl}/${id}/unarchive`);
+    return newsroom;
+  }
+  async remove(id) {
+    return this.apiClient.delete(`${routing.newsroomsUrl}/${id}`);
+  }
+  async takeOffline(id) {
+    const {
+      newsroom
+    } = await this.apiClient.post(`${routing.newsroomsUrl}/${id}/offline`);
+    return newsroom;
+  }
+  async takeOnline(id) {
+    const {
+      newsroom
+    } = await this.apiClient.post(`${routing.newsroomsUrl}/${id}/online`);
+    return newsroom;
+  }
+}

package/dist/endpoints/Newsrooms/index.d.ts

@@ -0,0 +1,2 @@
+export * from './Client';
+export * from './types';

package/dist/endpoints/Newsrooms/index.js

@@ -0,0 +1,2 @@
+export * from "./Client.js";
+export * from "./types.js";

package/dist/{Sdk → endpoints}/Newsrooms/types.d.ts

@@ -1,5 +1,5 @@
-import { CultureRef, EmailBranding, EmailBrandingMode, Newsroom, NewsroomStatus, Pagination } from '../../types';
-export interface NewsroomListRequest {
+import type { CultureRef, Newsroom, Pagination, Query } from '../../types';
+export interface ListOptions {
     limit?: number;
     offset?: number;
     /**
@@ -8,18 +8,18 @@ export interface NewsroomListRequest {
     search?: string;
     sortOrder?: string;
 }
-export interface NewsroomSearchRequest extends NewsroomListRequest {
+export interface SearchOptions extends ListOptions {
     /**
      * Filter query using Prezly JSON Query Language
      */
-    jsonQuery?: string;
+    query?: Query;
 }
-export interface NewsroomListResponse {
+export interface ListResponse {
     newsrooms: Newsroom[];
     pagination: Pagination;
     sort: string;
 }
-export interface NewsroomCreateRequest {
+export interface CreateRequest {
     name: string;
     /**
      * Subdomain to be used for the newsroom.
@@ -40,9 +40,9 @@ export interface NewsroomCreateRequest {
      * Theme ID or codename
      */
     active_theme?: string;
-    status?: NewsroomStatus.ACTIVE | NewsroomStatus.INACTIVE;
+    status?: Newsroom.Status.ACTIVE | Newsroom.Status.INACTIVE;
 }
-export interface NewsroomUpdateRequest {
+export interface UpdateRequest {
     name?: string;
     /**
      * Subdomain to be used for the newsroom.
@@ -79,8 +79,8 @@ export interface NewsroomUpdateRequest {
      * Timezone name in the ICANN tz database.
      */
     timezone?: string;
-    email_branding_mode?: EmailBrandingMode;
-    email_branding?: EmailBranding;
+    email_branding_mode?: Newsroom.EmailBrandingMode;
+    email_branding?: Newsroom.EmailBranding;
     is_privacy_portal_enabled?: boolean;
     /**
      * Available only when license has
@@ -97,5 +97,5 @@ export interface NewsroomUpdateRequest {
      * "subscription_form" feature flag
      */
     is_subscription_form_enabled?: boolean;
-    status?: NewsroomStatus.ACTIVE | NewsroomStatus.INACTIVE;
+    status?: Newsroom.Status.ACTIVE | Newsroom.Status.INACTIVE;
 }

package/dist/endpoints/Newsrooms/types.js

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

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

@@ -0,0 +1,12 @@
+import type { DeferredJobsApiClient } from '../../api';
+import type { SenderAddress } from '../../types';
+import type { CreateRequest, UpdateRequest } from './types';
+export declare class Client {
+    private readonly apiClient;
+    constructor(apiClient: DeferredJobsApiClient);
+    list(): Promise<SenderAddress[]>;
+    create(payload: CreateRequest): Promise<SenderAddress>;
+    get(senderId: SenderAddress['id']): Promise<SenderAddress>;
+    update(senderId: SenderAddress['id'], payload: UpdateRequest): Promise<SenderAddress>;
+    remove(senderId: SenderAddress['id']): Promise<void>;
+}

package/dist/endpoints/SenderAddresses/Client.js

@@ -0,0 +1,37 @@
+import { routing } from "../../routing.js";
+export class Client {
+  constructor(apiClient) {
+    this.apiClient = apiClient;
+  }
+  async list() {
+    const {
+      senders
+    } = await this.apiClient.get(routing.senderAddressesUrl);
+    return senders;
+  }
+  async create(payload) {
+    const {
+      sender
+    } = await this.apiClient.post(routing.senderAddressesUrl, {
+      payload
+    });
+    return sender;
+  }
+  async get(senderId) {
+    const {
+      sender
+    } = await this.apiClient.get(`${routing.senderAddressesUrl}/${senderId}`);
+    return sender;
+  }
+  async update(senderId, payload) {
+    const {
+      sender
+    } = await this.apiClient.patch(`${routing.senderAddressesUrl}/${senderId}`, {
+      payload
+    });
+    return sender;
+  }
+  async remove(senderId) {
+    return this.apiClient.delete(`${routing.senderAddressesUrl}/${senderId}`);
+  }
+}

package/dist/endpoints/SenderAddresses/index.d.ts

@@ -0,0 +1,2 @@
+export * from './Client';
+export * from './types';

package/dist/endpoints/SenderAddresses/index.js

@@ -0,0 +1,2 @@
+export * from "./Client.js";
+export * from "./types.js";

package/dist/{Sdk → endpoints}/SenderAddresses/types.d.ts

@@ -1,9 +1,9 @@
-export interface SenderAddressCreateRequest {
+export interface CreateRequest {
     sender_name: string;
     sender_email: string;
     is_default?: boolean;
 }
-export interface SenderAddressUpdateRequest {
+export interface UpdateRequest {
     sender_name?: string;
     is_default?: true;
 }

package/dist/endpoints/SenderAddresses/types.js

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

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

@@ -0,0 +1,14 @@
+import type { DeferredJobsApiClient } from '../../api';
+import type { Snippet } from '../../types';
+import type { CreateRequest, UpdateRequest } from './types';
+declare type SnippetId = Snippet['uuid'] | Snippet['id'];
+export declare class Client {
+    private readonly apiClient;
+    constructor(apiClient: DeferredJobsApiClient);
+    list(): Promise<Snippet[]>;
+    get(snippetId: SnippetId): Promise<Snippet>;
+    create(payload: CreateRequest): Promise<Snippet>;
+    update(snippetId: SnippetId, payload: UpdateRequest): Promise<Snippet>;
+    remove(snippetId: SnippetId): Promise<void>;
+}
+export {};

package/dist/endpoints/Snippets/Client.js

@@ -0,0 +1,42 @@
+import { routing } from "../../routing.js";
+export class Client {
+  constructor(apiClient) {
+    this.apiClient = apiClient;
+  }
+  async list() {
+    const url = routing.snippetsUrl;
+    const {
+      snippets
+    } = await this.apiClient.get(url);
+    return snippets;
+  }
+  async get(snippetId) {
+    const url = routing.snippetsUrl;
+    const {
+      snippet
+    } = await this.apiClient.get(`${url}/${snippetId}`);
+    return snippet;
+  }
+  async create(payload) {
+    const url = routing.snippetsUrl;
+    const {
+      snippet
+    } = await this.apiClient.post(url, {
+      payload
+    });
+    return snippet;
+  }
+  async update(snippetId, payload) {
+    const url = routing.snippetsUrl;
+    const {
+      snippet
+    } = await this.apiClient.patch(`${url}/${snippetId}`, {
+      payload
+    });
+    return snippet;
+  }
+  async remove(snippetId) {
+    const url = routing.snippetsUrl;
+    return this.apiClient.delete(`${url}/${snippetId}`);
+  }
+}

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

@@ -0,0 +1,2 @@
+export * from './Client';
+export * from './types';

package/dist/endpoints/Snippets/index.js

@@ -0,0 +1,2 @@
+export * from "./Client.js";
+export * from "./types.js";

package/dist/{Sdk → endpoints}/Snippets/types.d.ts

@@ -1,8 +1,8 @@
-export interface SnippetCreateRequest {
+export interface CreateRequest {
     title: string;
     content: string;
 }
-export interface SnippetUpdateRequest {
+export interface UpdateRequest {
     title?: string;
     content?: string;
 }

package/dist/endpoints/Snippets/types.js

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

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

@@ -0,0 +1,17 @@
+import type { DeferredJobsApiClient } from '../../api';
+import type { ExtendedStory, Story } from '../../types';
+import type { ListOptions, ListResponse, SearchOptions, CreateRequest, UpdateRequest } from './types';
+/**
+ * `uuid` is the preferred way of targeting a Story. Numeric `id` is considered deprecated.
+ */
+declare type StoryId = Story['uuid'] | Story['id'];
+export declare class Client {
+    private readonly apiClient;
+    constructor(apiClient: DeferredJobsApiClient);
+    list<Include extends readonly (keyof Story.ExtraFields)[], Options extends ListOptions<Include>, StoryRecord extends Story = Options['include'] extends Include ? Story & Pick<Story.ExtraFields, Options['include'][number]> : Story>(options?: Options): Promise<ListResponse<StoryRecord>>;
+    search<Include extends readonly (keyof Story.ExtraFields)[], Options extends ListOptions<Include>, StoryRecord extends Story = Options['include'] extends Include ? Story & Pick<Story.ExtraFields, Options['include'][number]> : Story>(options: SearchOptions<Include>): Promise<ListResponse<StoryRecord>>;
+    get(id: StoryId): Promise<ExtendedStory>;
+    create(payload: CreateRequest): Promise<ExtendedStory>;
+    update(id: StoryId, payload: UpdateRequest): Promise<ExtendedStory>;
+}
+export {};

package/dist/endpoints/Stories/Client.js

@@ -0,0 +1,63 @@
+import { routing } from "../../routing.js";
+export class Client {
+  constructor(apiClient) {
+    this.apiClient = apiClient;
+  }
+  async list(options) {
+    const {
+      limit,
+      offset,
+      sortOrder,
+      include
+    } = options ?? {};
+    return this.apiClient.get(routing.storiesUrl, {
+      query: {
+        limit,
+        offset,
+        sort: sortOrder,
+        include: include ? include.join(',') : undefined
+      }
+    });
+  }
+  async search(options) {
+    const {
+      limit,
+      offset,
+      sortOrder,
+      include,
+      query
+    } = options ?? {};
+    return this.apiClient.post(routing.storiesSearchUrl, {
+      payload: {
+        query,
+        limit,
+        offset,
+        sort: sortOrder,
+        include: include ? include.join(',') : undefined
+      }
+    });
+  }
+  async get(id) {
+    const {
+      story
+    } = await this.apiClient.get(`${routing.storiesUrl}/${id}`);
+    return story;
+  }
+  async create(payload) {
+    const {
+      story
+    } = await this.apiClient.post(routing.storiesUrl, {
+      payload
+    });
+    return story;
+  }
+  async update(id, payload) {
+    const url = `${routing.storiesUrl}/${id}`;
+    const {
+      story
+    } = await this.apiClient.patch(url, {
+      payload
+    });
+    return story;
+  }
+}

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

@@ -0,0 +1,2 @@
+export * from './Client';
+export * from './types';

package/dist/endpoints/Stories/index.js

@@ -0,0 +1,2 @@
+export * from "./Client.js";
+export * from "./types.js";

package/dist/{Sdk → endpoints}/Stories/types.d.ts

@@ -1,4 +1,4 @@
-import { Category, CultureRef, ExtraStoryFields, NewsroomRef, Pagination, Story, StoryFormatVersion, StoryVisibility } from '../../types';
+import type { Category, CultureRef, NewsroomRef, Pagination, Query, Story } from '../../types';
 /**
  * Uploadcare image JSON string.
  */
@@ -12,25 +12,26 @@ declare type Html = string;
  * String containing Prezly Content Format JSON structure.
  */
 declare type PrezlyContentFormat = string;
-export declare type StoriesSearchRequest<Include extends readonly (keyof ExtraStoryFields)[]> = {
-    jsonQuery?: string;
+export interface ListOptions<Include extends readonly (keyof Story.ExtraFields)[]> {
     limit?: number;
     offset?: number;
     sortOrder?: string;
     include?: Include;
-};
-export declare type StoriesListRequest<Include extends readonly (keyof ExtraStoryFields)[]> = Omit<StoriesSearchRequest<Include>, 'jsonQuery'>;
-export interface StoriesListResponse<S extends Story = Story> {
+}
+export interface SearchOptions<Include extends readonly (keyof Story.ExtraFields)[]> extends ListOptions<Include> {
+    query?: Query;
+}
+export interface ListResponse<S extends Story = Story> {
     stories: S[];
     pagination: Pagination;
     sort: string;
 }
-interface GenericStoryCreateRequest {
+interface GenericCreateRequest {
     newsroom?: NewsroomRef['id'];
     title?: string;
     subtitle?: string;
     published_at?: Iso8601DateTime;
-    visibility?: StoryVisibility;
+    visibility?: Story.Visibility;
     culture?: CultureRef['code'];
     header_image?: UploadedImage;
     preview_image?: UploadedImage;
@@ -39,11 +40,11 @@ interface GenericStoryCreateRequest {
     categories?: Category['id'][];
     tags?: string[];
 }
-interface GenericStoryUpdateRequest {
+interface GenericUpdateRequest {
     title?: string;
     subtitle?: string;
     published_at?: Iso8601DateTime;
-    visibility?: StoryVisibility;
+    visibility?: Story.Visibility;
     culture?: CultureRef['code'];
     header_image?: UploadedImage;
     preview_image?: UploadedImage;
@@ -52,11 +53,11 @@ interface GenericStoryUpdateRequest {
     categories?: Category['id'][];
     tags?: string[];
 }
-export interface HtmlStoryCreateRequest extends GenericStoryCreateRequest {
+export interface HtmlStoryCreateRequest extends GenericCreateRequest {
     /**
      * If format version is omitted, license default editor version will be implied.
      */
-    format_version?: StoryFormatVersion.HTML;
+    format_version?: Story.FormatVersion.HTML;
     intro: Html;
     content: Html;
     /**
@@ -64,18 +65,18 @@ export interface HtmlStoryCreateRequest extends GenericStoryCreateRequest {
      */
     attached_gallery_content?: string;
 }
-export interface SlateStoryCreateRequest extends GenericStoryCreateRequest {
+export interface SlateStoryCreateRequest extends GenericCreateRequest {
     /**
      * If format version is omitted, license default editor version will be implied.
      */
-    format_version?: StoryFormatVersion.SLATEJS;
+    format_version?: Story.FormatVersion.SLATEJS;
     /**
      * Intro field is not supported for Prezly Content Format stories.
      */
     intro: never;
     content: PrezlyContentFormat;
 }
-export interface HtmlStoryUpdateRequest extends GenericStoryUpdateRequest {
+export interface HtmlStoryUpdateRequest extends GenericUpdateRequest {
     intro: Html;
     content: Html;
     /**
@@ -83,13 +84,13 @@ export interface HtmlStoryUpdateRequest extends GenericStoryUpdateRequest {
      */
     attached_gallery_content?: string;
 }
-export interface SlateStoryUpdateRequest extends GenericStoryUpdateRequest {
+export interface SlateStoryUpdateRequest extends GenericUpdateRequest {
     /**
      * Intro field is not supported for Prezly Content Format stories.
      */
     intro: never;
     content: PrezlyContentFormat;
 }
-export declare type StoryCreateRequest = HtmlStoryCreateRequest | SlateStoryCreateRequest;
-export declare type StoryUpdateRequest = HtmlStoryUpdateRequest | SlateStoryUpdateRequest;
+export declare type CreateRequest = HtmlStoryCreateRequest | SlateStoryCreateRequest;
+export declare type UpdateRequest = HtmlStoryUpdateRequest | SlateStoryUpdateRequest;
 export {};

package/dist/endpoints/Stories/types.js

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

package/dist/{Sdk/Subscriptions/Subscriptions.d.ts → endpoints/Subscriptions/Client.d.ts}

@@ -1,13 +1,11 @@
-import { ContactType, EmailSubscription, Newsroom } from '../../types';
-import DeferredJobsApiClient from '../DeferredJobsApiClient';
-import { SubscribeRequest, UnsubscribeRequest, UpdateUnsubscribeDetailsRequest } from './types';
+import type { DeferredJobsApiClient } from '../../api';
+import type { Contact, EmailSubscription, Newsroom } from '../../types';
+import type { SubscribeRequest, UnsubscribeRequest, UpdateUnsubscribeDetailsRequest } from './types';
 declare type NewsroomId = Newsroom['uuid'] | Newsroom['id'];
-export default class Subscriptions {
+export declare class Client {
     private readonly apiClient;
-    constructor({ apiClient }: {
-        apiClient: DeferredJobsApiClient;
-    });
-    subscribeToNewsroom<Type extends ContactType>(newsroomId: NewsroomId, payload: SubscribeRequest<Type>): Promise<EmailSubscription>;
+    constructor(apiClient: DeferredJobsApiClient);
+    subscribeToNewsroom<Type extends Contact.Type>(newsroomId: NewsroomId, payload: SubscribeRequest<Type>): Promise<EmailSubscription>;
     unsubscribeFromNewsroom(newsroomId: NewsroomId, payload: UnsubscribeRequest): Promise<EmailSubscription>;
     updateNewsroomUnsubscribeDetails(newsroomId: NewsroomId, subscriptionId: EmailSubscription['id'], payload: UpdateUnsubscribeDetailsRequest): Promise<EmailSubscription>;
     unsubscribeFromLicense(payload: UnsubscribeRequest): Promise<EmailSubscription>;

package/dist/endpoints/Subscriptions/Client.js

@@ -0,0 +1,51 @@
+import { routing } from "../../routing.js";
+export class Client {
+  constructor(apiClient) {
+    this.apiClient = apiClient;
+  }
+  async subscribeToNewsroom(newsroomId, payload) {
+    const url = routing.newsroomSubscribeUrl.replace(':newsroom_id', String(newsroomId));
+    const {
+      subscription
+    } = await this.apiClient.post(url, {
+      payload
+    });
+    return subscription;
+  }
+  async unsubscribeFromNewsroom(newsroomId, payload) {
+    const url = routing.newsroomUnsubscribeUrl.replace(':newsroom_id', String(newsroomId));
+    const {
+      subscription
+    } = await this.apiClient.post(url, {
+      payload
+    });
+    return subscription;
+  }
+  async updateNewsroomUnsubscribeDetails(newsroomId, subscriptionId, payload) {
+    const url = routing.newsroomUnsubscribeUrl.replace(':newsroom_id', String(newsroomId));
+    const {
+      subscription
+    } = await this.apiClient.patch(`${url}/${subscriptionId}`, {
+      payload
+    });
+    return subscription;
+  }
+  async unsubscribeFromLicense(payload) {
+    const url = routing.licenseUnsubscribeUrl;
+    const {
+      subscription
+    } = await this.apiClient.post(url, {
+      payload
+    });
+    return subscription;
+  }
+  async updateLicenseUnsubscribeDetails(subscriptionId, payload) {
+    const url = routing.licenseUnsubscribeUrl;
+    const {
+      subscription
+    } = await this.apiClient.patch(`${url}/${subscriptionId}`, {
+      payload
+    });
+    return subscription;
+  }
+}

package/dist/endpoints/Subscriptions/index.d.ts

@@ -0,0 +1,2 @@
+export * from './Client';
+export * from './types';

package/dist/endpoints/Subscriptions/index.js

@@ -0,0 +1,2 @@
+export * from "./Client.js";
+export * from "./types.js";