@prezly/sdk 7.12.0 → 9.0.0

package/dist/endpoints/Campaigns/Client.js

@@ -0,0 +1,85 @@
+import { routing } from "../../routing.js";
+import { Query } from "../../types/index.js";
+import { toIso8601 } from "../../utils.js";
+export class Client {
+  constructor(apiClient) {
+    this.apiClient = apiClient;
+  }
+  async list(options) {
+    const {
+      query,
+      limit,
+      offset,
+      sortOrder
+    } = options;
+    return this.apiClient.get(routing.campaignsUrl, {
+      query: {
+        limit,
+        offset,
+        query: Query.stringify(query),
+        sort: sortOrder
+      }
+    });
+  }
+  async search(options) {
+    const {
+      query,
+      limit,
+      offset,
+      sortOrder
+    } = options;
+    return this.apiClient.post(routing.campaignsUrl, {
+      payload: {
+        limit,
+        offset,
+        query,
+        sort: sortOrder
+      }
+    });
+  }
+  async get(id) {
+    return this.apiClient.get(`${routing.campaignsUrl}/${id}`);
+  }
+  async duplicate(id) {
+    return this.apiClient.post(`${routing.campaignsUrl}/${id}/duplicate`);
+  }
+  async delete(id) {
+    return this.apiClient.delete(`${routing.campaignsUrl}/${id}`);
+  }
+  async test(id, emails) {
+    return this.apiClient.post(`${routing.campaignsUrl}/${id}/test`, {
+      payload: {
+        emails
+      }
+    });
+  }
+  async send(id) {
+    return this.apiClient.post(`${routing.campaignsUrl}/${id}/send`);
+  }
+  async schedule(id, sendAt) {
+    const {
+      campaign
+    } = await this.apiClient.post(`${routing.campaignsUrl}/${id}/schedule`, {
+      payload: {
+        schedule_at: toIso8601(sendAt)
+      }
+    });
+    return campaign;
+  }
+  async unschedule(id) {
+    const {
+      campaign
+    } = await this.apiClient.post(`${routing.campaignsUrl}/${id}/unschedule`);
+    return campaign;
+  }
+  async create(payload) {
+    return this.apiClient.post(routing.campaignsUrl, {
+      payload
+    });
+  }
+  async update(id, payload) {
+    return this.apiClient.patch(`${routing.campaignsUrl}/${id}`, {
+      payload
+    });
+  }
+}

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

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

package/dist/endpoints/Campaigns/index.js

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

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

@@ -1,5 +1,5 @@
-import { Campaign, Pagination, Query, SenderAddress, Story, Warning } from '../../types';
-export interface CampaignCreateRequest {
+import type { Campaign, Pagination, Query, SenderAddress, Story, Warning } from '../../types';
+export interface CreateRequest {
     subject?: Campaign['subject'];
     sender?: SenderAddress['id'];
     content?: Campaign['content'];
@@ -10,7 +10,7 @@ export interface CampaignCreateRequest {
         query: Query;
     };
 }
-export interface CampaignUpdateRequest {
+export interface UpdateRequest {
     subject?: Campaign['subject'];
     sender?: SenderAddress['id'];
     content?: Campaign['content'];
@@ -18,7 +18,7 @@ export interface CampaignUpdateRequest {
     story_alignment?: Campaign['story_alignment'];
     story_appearance?: Campaign['story_appearance'];
 }
-export interface CampaignRecipientsOperationResponse {
+export interface RecipientsOperationResponse {
     campaign: Campaign;
     warnings: Warning[];
     message: string;
@@ -28,13 +28,15 @@ export interface CampaignResponse {
     campaign: Campaign;
     warnings: Warning[];
 }
-export interface CampaignsSearchOptions {
-    jsonQuery?: Query;
-    page?: number;
-    pageSize?: number;
+export interface ListOptions {
+    limit?: number;
+    offset?: number;
     sortOrder?: string;
 }
-export interface CampaignsListResponse {
+export interface SearchOptions extends ListOptions {
+    query?: Query;
+}
+export interface ListResponse {
     campaigns: Campaign[];
     pagination: Pagination;
     sort: string;

package/dist/endpoints/Campaigns/types.js

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

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

@@ -0,0 +1,23 @@
+import type { ProgressPromise } from '@prezly/progress-promise';
+import type { DeferredJobsApiClient } from '../../api';
+import type { CoverageEntry, SelectionValue } from '../../types';
+import type { CreateRequest, ListOptions, ListResponse, Scope, SearchOptions, UpdateRequest } from './types';
+declare type CoverageId = CoverageEntry['uuid'] | CoverageEntry['id'];
+export declare class Client {
+    private readonly apiClient;
+    constructor(apiClient: DeferredJobsApiClient);
+    list(options?: ListOptions, scope?: Scope): Promise<ListResponse>;
+    search(options?: SearchOptions, scope?: Scope): Promise<ListResponse>;
+    get(id: CoverageId, includeDeleted?: boolean): Promise<CoverageEntry>;
+    getByExternalReferenceId(externalReferenceId: string): Promise<CoverageEntry | null>;
+    create(payload: CreateRequest): Promise<CoverageEntry>;
+    update(id: CoverageId, payload: UpdateRequest): Promise<CoverageEntry>;
+    remove(id: CoverageId): Promise<void>;
+    bulkRemove(options: Partial<{
+        selection: SelectionValue;
+        query: string;
+    }>): ProgressPromise<{
+        records_deleted_number: number;
+    }>;
+}
+export {};

package/dist/endpoints/Coverage/Client.js

@@ -0,0 +1,102 @@
+import { routing } from "../../routing.js";
+import { Query } from "../../types/index.js";
+export class Client {
+  constructor(apiClient) {
+    this.apiClient = apiClient;
+  }
+  async list(options = {}, scope) {
+    const {
+      includeDeleted,
+      limit,
+      offset,
+      sortOrder
+    } = options;
+    // TODO: Switch to `scope` API parameter
+    const url = scope?.story ? routing.storyCoverageUrl.replace(':story_id', String(scope.story)) : routing.coverageUrl;
+    return this.apiClient.get(url, {
+      query: {
+        include_deleted: includeDeleted ? 'on' : undefined,
+        limit,
+        offset,
+        sort: sortOrder
+      }
+    });
+  }
+  async search(options = {}, scope) {
+    const {
+      includeDeleted,
+      query,
+      limit,
+      offset,
+      sortOrder
+    } = options;
+    // TODO: Switch to `scope` API parameter
+    const url = scope?.story ? routing.storyCoverageUrl.replace(':story_id', String(scope.story)) : routing.coverageUrl;
+    // TODO: Introduce dedicated Search POST API
+    return this.apiClient.get(url, {
+      query: {
+        include_deleted: includeDeleted ? 'on' : undefined,
+        query: Query.stringify(query),
+        limit,
+        offset,
+        sort: sortOrder
+      }
+    });
+  }
+  async get(id, includeDeleted = false) {
+    const url = `${routing.coverageUrl}/${id}`;
+    const {
+      coverage
+    } = await this.apiClient.get(url, {
+      query: {
+        include_deleted: includeDeleted ? 'on' : undefined
+      }
+    });
+    return coverage;
+  }
+  async getByExternalReferenceId(externalReferenceId) {
+    const query = JSON.stringify({
+      external_reference_id: {
+        $in: [externalReferenceId]
+      }
+    });
+    const {
+      coverage
+    } = await this.search({
+      includeDeleted: true,
+      query
+    });
+    return coverage[0] || null;
+  }
+  async create(payload) {
+    const {
+      coverage
+    } = await this.apiClient.post(routing.coverageUrl, {
+      payload
+    });
+    return coverage;
+  }
+  async update(id, payload) {
+    const {
+      coverage
+    } = await this.apiClient.patch(`${routing.coverageUrl}/${id}`, {
+      payload
+    });
+    return coverage;
+  }
+  async remove(id) {
+    return this.apiClient.delete(`${routing.coverageUrl}/${id}`);
+  }
+  async bulkRemove(options) {
+    const {
+      selection,
+      query
+    } = options;
+    return this.apiClient.delete(routing.coverageUrl, {
+      payload: {
+        selection,
+        query
+      }
+    });
+  }
+}

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

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

package/dist/endpoints/Coverage/index.js

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

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

@@ -1,8 +1,8 @@
-import { CoverageType, CoverageProvider, CultureRef, CountryRef, Contact, Coverage, NewsroomRef, OEmbedInfo, Pagination, Story } from '../../types';
-export declare type CoverageScope = {
+import type { CultureRef, CountryRef, Contact, CoverageEntry, NewsroomRef, OEmbedInfo, Pagination, Story, Query } from '../../types';
+export declare type Scope = {
     story: Story['id'];
 } | null;
-export interface CoverageUpdateRequest {
+export interface UpdateRequest {
     attachment_oembed?: OEmbedInfo | null;
     attachment_plaintext_content?: string | null;
     attachment?: string | null;
@@ -25,11 +25,11 @@ export interface CoverageUpdateRequest {
      * Automatic calculation will be dropped in future when it starts being
      * required in coverage create requests.
      */
-    type?: CoverageType;
+    type?: CoverageEntry.Type;
     culture?: CultureRef['code'] | null;
     country?: CountryRef['code'] | null;
     management_url?: string | null;
-    provider?: CoverageProvider | null;
+    provider?: CoverageEntry.Provider | null;
     /**
      * For tv/radio types. Fragment duration in seconds.
      */
@@ -47,17 +47,19 @@ export interface CoverageUpdateRequest {
      */
     page?: number | null;
 }
-export interface CoverageCreateRequest extends CoverageUpdateRequest {
+export interface CreateRequest extends UpdateRequest {
 }
-export interface CoverageSearchOptions {
+export interface ListOptions {
     includeDeleted?: boolean;
-    jsonQuery?: string;
-    page?: number;
-    pageSize?: number;
+    limit?: number;
+    offset?: number;
     sortOrder?: string;
 }
-export interface CoverageListResponse {
-    coverage: Coverage[];
+export interface SearchOptions extends ListOptions {
+    query?: Query;
+}
+export interface ListResponse {
+    coverage: CoverageEntry[];
     pagination: Pagination;
     sort: string;
 }

package/dist/endpoints/Coverage/types.js

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

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

@@ -0,0 +1,7 @@
+import type { DeferredJobsApiClient } from '../../api';
+import type { JobState } from '../../types';
+export declare class Client {
+    private readonly apiClient;
+    constructor(apiClient: DeferredJobsApiClient);
+    get(id: string): Promise<JobState>;
+}

package/dist/endpoints/Jobs/Client.js

@@ -0,0 +1,12 @@
+import { routing } from "../../routing.js";
+export class Client {
+  constructor(apiClient) {
+    this.apiClient = apiClient;
+  }
+  async get(id) {
+    const {
+      job
+    } = await this.apiClient.get(`${routing.jobsUrl}/${id}`);
+    return job.state;
+  }
+}

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

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

package/dist/endpoints/Jobs/index.js

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

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

@@ -0,0 +1,7 @@
+import type { JobState } from '../../types';
+export interface StatusResponse {
+    job: {
+        id: string;
+        state: JobState;
+    };
+}

package/dist/endpoints/Jobs/types.js

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

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

@@ -0,0 +1,7 @@
+import type { DeferredJobsApiClient } from '../../api';
+import type { License } from '../../types';
+export declare class Client {
+    private readonly apiClient;
+    constructor(apiClient: DeferredJobsApiClient);
+    get(): Promise<License>;
+}

package/dist/endpoints/Licenses/Client.js

@@ -0,0 +1,13 @@
+import { routing } from "../../routing.js";
+export class Client {
+  constructor(apiClient) {
+    this.apiClient = apiClient;
+  }
+  async get() {
+    const url = routing.licenseUrl;
+    const {
+      license
+    } = await this.apiClient.get(`${url}/self`);
+    return license;
+  }
+}

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

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

package/dist/endpoints/Licenses/index.js

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

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

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

package/dist/endpoints/NewsroomCategories/Client.js

@@ -0,0 +1,48 @@
+import { routing } from "../../routing.js";
+export class Client {
+  constructor(apiClient) {
+    this.apiClient = apiClient;
+  }
+  async list(newsroomId, {
+    sortOrder
+  } = {}) {
+    const url = routing.newsroomCategoriesUrl.replace(':newsroom_id', String(newsroomId));
+    const {
+      categories
+    } = await this.apiClient.get(url, {
+      query: {
+        sort: sortOrder
+      }
+    });
+    return categories;
+  }
+  async get(newsroomId, categoryId) {
+    const url = routing.newsroomCategoriesUrl.replace(':newsroom_id', String(newsroomId));
+    const {
+      category
+    } = await this.apiClient.get(`${url}/${categoryId}`);
+    return category;
+  }
+  async create(newsroomId, payload) {
+    const url = routing.newsroomCategoriesUrl.replace(':newsroom_id', String(newsroomId));
+    const {
+      category
+    } = await this.apiClient.post(url, {
+      payload
+    });
+    return category;
+  }
+  async update(newsroomId, categoryId, payload) {
+    const url = routing.newsroomCategoriesUrl.replace(':newsroom_id', String(newsroomId));
+    const {
+      category
+    } = await this.apiClient.patch(`${url}/${categoryId}`, {
+      payload
+    });
+    return category;
+  }
+  async remove(newsroomId, categoryId) {
+    const url = routing.newsroomCategoriesUrl.replace(':newsroom_id', String(newsroomId));
+    return this.apiClient.delete(`${url}/${categoryId}`);
+  }
+}

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

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

package/dist/endpoints/NewsroomCategories/index.js

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

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

@@ -1,4 +1,4 @@
-export interface NewsroomCategoriesListOptions {
+export interface ListOptions {
     /**
      * Supported sort columns:
      * - `id`
@@ -8,7 +8,7 @@ export interface NewsroomCategoriesListOptions {
      */
     sortOrder?: string;
 }
-export interface NewsroomCategoryCreateRequest {
+export interface CreateRequest {
     i18n: {
         [localCode: string]: {
             name: string;
@@ -16,7 +16,7 @@ export interface NewsroomCategoryCreateRequest {
         };
     };
 }
-export interface NewsroomCategoryUpdateRequest {
+export interface UpdateRequest {
     i18n: {
         /**
          * Pass `null` to erase category translation.

package/dist/endpoints/NewsroomCategories/types.js

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

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

@@ -0,0 +1,16 @@
+import type { DeferredJobsApiClient } from '../../api';
+import type { Newsroom, NewsroomContact } from '../../types';
+import type { ListOptions, SearchOptions, CreateRequest, UpdateRequest } from './types';
+declare type NewsroomId = Newsroom['uuid'] | Newsroom['id'];
+declare type NewsroomContactId = NewsroomContact['uuid'] | NewsroomContact['id'];
+export declare class Client {
+    private readonly apiClient;
+    constructor(apiClient: DeferredJobsApiClient);
+    list(newsroomId: NewsroomId, { search }?: ListOptions): Promise<NewsroomContact[]>;
+    get(newsroomId: NewsroomId, contactId: NewsroomContactId): Promise<NewsroomContact>;
+    search(newsroomId: NewsroomId, { search, query }?: SearchOptions): Promise<NewsroomContact[]>;
+    create(newsroomId: NewsroomId, payload: CreateRequest): Promise<NewsroomContact>;
+    update(newsroomId: NewsroomId, contactId: NewsroomContactId, payload: UpdateRequest): Promise<NewsroomContact>;
+    remove(newsroomId: NewsroomId, contactId: NewsroomContactId, force?: boolean): Promise<void>;
+}
+export {};

package/dist/endpoints/NewsroomContacts/Client.js

@@ -0,0 +1,69 @@
+import { routing } from "../../routing.js";
+import { Query } from "../../types/index.js";
+export class Client {
+  constructor(apiClient) {
+    this.apiClient = apiClient;
+  }
+  async list(newsroomId, {
+    search
+  } = {}) {
+    const url = routing.newsroomContactsUrl.replace(':newsroom_id', String(newsroomId));
+    const {
+      contacts
+    } = await this.apiClient.get(url, {
+      query: {
+        search
+      }
+    });
+    return contacts;
+  }
+  async get(newsroomId, contactId) {
+    const url = routing.newsroomContactsUrl.replace(':newsroom_id', String(newsroomId));
+    const {
+      contact
+    } = await this.apiClient.get(`${url}/${contactId}`);
+    return contact;
+  }
+  async search(newsroomId, {
+    search,
+    query
+  } = {}) {
+    const url = routing.newsroomContactsUrl.replace(':newsroom_id', String(newsroomId));
+    const {
+      contacts
+    } = await this.apiClient.get(url, {
+      query: {
+        search,
+        query: Query.stringify(query)
+      }
+    });
+    return contacts;
+  }
+  async create(newsroomId, payload) {
+    const url = routing.newsroomContactsUrl.replace(':newsroom_id', String(newsroomId));
+    const {
+      contact
+    } = await this.apiClient.post(url, {
+      payload
+    });
+    return contact;
+  }
+  async update(newsroomId, contactId, payload) {
+    const url = routing.newsroomContactsUrl.replace(':newsroom_id', String(newsroomId));
+    const {
+      contact
+    } = await this.apiClient.patch(`${url}/${contactId}`, {
+      payload
+    });
+    return contact;
+  }
+  async remove(newsroomId, contactId, force = false) {
+    const url = routing.newsroomContactsUrl.replace(':newsroom_id', String(newsroomId));
+    const query = force ? {
+      force: true
+    } : {};
+    return this.apiClient.delete(`${url}/${contactId}`, {
+      query
+    });
+  }
+}

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

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

package/dist/endpoints/NewsroomContacts/index.js

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

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

@@ -1,22 +1,18 @@
-import { UploadedImage } from '@prezly/uploads';
-import { CultureRef } from '../../types';
-export interface NewsroomContactsListRequestOptions {
+import type { UploadedImage } from '@prezly/uploads';
+import type { CultureRef, Query } from '../../types';
+export interface ListOptions {
     /**
      * Keyword search term
      */
     search?: string;
 }
-export interface NewsroomContactsSearchRequestOptions {
-    /**
-     * Keyword search term
-     */
-    search?: string;
+export interface SearchOptions extends ListOptions {
     /**
      * Prezly Query Language expression to filter contacts by.
      */
-    query?: string;
+    query?: Query;
 }
-export interface NewsroomContactCreateRequest {
+export interface CreateRequest {
     name: string;
     email?: string | null;
     phone?: string | null;
@@ -30,4 +26,4 @@ export interface NewsroomContactCreateRequest {
     is_featured?: boolean;
     display_locales?: CultureRef['code'][];
 }
-export declare type NewsroomContactUpdateRequest = Partial<NewsroomContactCreateRequest>;
+export declare type UpdateRequest = Partial<CreateRequest>;

package/dist/endpoints/NewsroomContacts/types.js

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

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

@@ -0,0 +1,15 @@
+import type { DeferredJobsApiClient } from '../../api';
+import type { NewsroomDomain, Newsroom } from '../../types';
+import type { LinkRequest } from './types';
+declare type NewsroomId = Newsroom['uuid'] | Newsroom['id'];
+export declare class Client {
+    private readonly apiClient;
+    constructor(apiClient: DeferredJobsApiClient);
+    get(newsroomId: NewsroomId, domain: string): Promise<NewsroomDomain>;
+    list(newsroomId: NewsroomId): Promise<NewsroomDomain[]>;
+    link(newsroomId: NewsroomId, payload: LinkRequest): Promise<NewsroomDomain>;
+    unlink(newsroomId: NewsroomId, domain: string): Promise<void>;
+    check(newsroomId: NewsroomId, domain: string): Promise<NewsroomDomain>;
+    shareDnsInstructions(newsroomId: NewsroomId, domain: string): Promise<NewsroomDomain.ShareInstructions>;
+}
+export {};