@prezly/sdk 7.12.0 → 9.0.0

package/README.md

@@ -13,9 +13,9 @@ yarn add @prezly/sdk
 Using ES Modules:
 
 ```js
-import PrezlySdk from '@prezly/sdk';
+import { createPrezlyClient } from '@prezly/sdk';
 
-const prezlySdk = new PrezlySdk({
+const prezlyClient = createPrezlyClient({
     accessToken: 'your-access-token',
 });
 ```
@@ -23,9 +23,9 @@ const prezlySdk = new PrezlySdk({
 Or Using CommonJS:
 
 ```js
-const PrezlySdk = require('@prezly/sdk').default;
+const { createPrezlyClient } = require('@prezly/sdk').default;
 
-const prezlySdk = new PrezlySdk({
+const prezlyClient = createPrezlyClient({
     accessToken: 'your-access-token',
 });
 ```
@@ -53,7 +53,7 @@ yarn add whatwg-fetch
 ```js
 import 'whatwg-fetch';
 // ...
-import PrezlySdk from '@prezly/sdk';
+import { createPrezlyClient } from '@prezly/sdk';
 ```
 
 We recommend referring to the [official `whatwg-fetch` module documentation](https://www.npmjs.com/package/whatwg-fetch) for more information.
@@ -69,7 +69,7 @@ yarn add node-fetch
 ```js
 global.fetch = require('node-fetch');
 // ...
-const PrezlySdk = require('@prezly/sdk').default;
+const { createPrezlyClient } = require('@prezly/sdk');
 ```
 
 We recommend referring to the [official `node-fetch` module documentation](https://www.npmjs.com/package/node-fetch) for more information.
@@ -87,7 +87,7 @@ Using ES Modules:
 ```js
 import 'cross-fetch/polyfill';
 // ...
-import PrezlySdk from '@prezly/sdk';
+import { createPrezlyClient } from '@prezly/sdk';
 ```
 
 Or Using CommonJS:
@@ -95,7 +95,7 @@ Or Using CommonJS:
 ```js
 require('cross-fetch/polyfill');
 // ...
-const PrezlySdk = require('@prezly/sdk').default;
+const { createPrezlyClient } = require('@prezly/sdk');
 ```
 
 We recommend referring to the [official `cross-fetch` module documentation](https://www.npmjs.com/package/cross-fetch) for more information.

package/dist/Client.d.ts

@@ -0,0 +1,29 @@
+import { Accounts, Campaigns, CampaignRecipients, Coverage, Jobs, Licenses, Newsrooms, NewsroomCategories, NewsroomContacts, NewsroomLanguages, NewsroomThemes, NewsroomWebhooks, NewsroomPrivacyRequests, NewsroomDomains, NewsroomGalleries, SenderAddresses, Stories, Snippets, Subscriptions } from './endpoints';
+import type { HeadersMap } from './http';
+export interface ClientOptions {
+    accessToken: string;
+    baseUrl?: string;
+    headers?: HeadersMap;
+}
+export interface Client {
+    accounts: Accounts.Client;
+    campaigns: Campaigns.Client;
+    campaignRecipients: CampaignRecipients.Client;
+    coverage: Coverage.Client;
+    jobs: Jobs.Client;
+    licenses: Licenses.Client;
+    newsrooms: Newsrooms.Client;
+    newsroomCategories: NewsroomCategories.Client;
+    newsroomContacts: NewsroomContacts.Client;
+    newsroomLanguages: NewsroomLanguages.Client;
+    newsroomThemes: NewsroomThemes.Client;
+    newsroomWebhooks: NewsroomWebhooks.Client;
+    newsroomPrivacyRequests: NewsroomPrivacyRequests.Client;
+    newsroomDomains: NewsroomDomains.Client;
+    newsroomGalleries: NewsroomGalleries.Client;
+    senderAddresses: SenderAddresses.Client;
+    stories: Stories.Client;
+    snippets: Snippets.Client;
+    subscriptions: Subscriptions.Client;
+}
+export declare function createClient({ accessToken, baseUrl, headers, }: ClientOptions): Client;

package/dist/Client.js

@@ -0,0 +1,35 @@
+import { ApiClient, DeferredJobsApiClient } from "./api/index.js";
+import { Accounts, Campaigns, CampaignRecipients, Coverage, Jobs, Licenses, Newsrooms, NewsroomCategories, NewsroomContacts, NewsroomLanguages, NewsroomThemes, NewsroomWebhooks, NewsroomPrivacyRequests, NewsroomDomains, NewsroomGalleries, SenderAddresses, Stories, Snippets, Subscriptions } from "./endpoints/index.js";
+const DEFAULT_BASE_URL = 'https://api.prezly.com';
+export function createClient({
+  accessToken,
+  baseUrl = DEFAULT_BASE_URL,
+  headers = {}
+}) {
+  const apiClient = new DeferredJobsApiClient(new ApiClient({
+    accessToken,
+    baseUrl,
+    headers
+  }));
+  return {
+    accounts: new Accounts.Client(apiClient),
+    campaigns: new Campaigns.Client(apiClient),
+    campaignRecipients: new CampaignRecipients.Client(apiClient),
+    coverage: new Coverage.Client(apiClient),
+    jobs: new Jobs.Client(apiClient),
+    licenses: new Licenses.Client(apiClient),
+    newsrooms: new Newsrooms.Client(apiClient),
+    newsroomCategories: new NewsroomCategories.Client(apiClient),
+    newsroomContacts: new NewsroomContacts.Client(apiClient),
+    newsroomLanguages: new NewsroomLanguages.Client(apiClient),
+    newsroomThemes: new NewsroomThemes.Client(apiClient),
+    newsroomWebhooks: new NewsroomWebhooks.Client(apiClient),
+    newsroomPrivacyRequests: new NewsroomPrivacyRequests.Client(apiClient),
+    newsroomDomains: new NewsroomDomains.Client(apiClient),
+    newsroomGalleries: new NewsroomGalleries.Client(apiClient),
+    senderAddresses: new SenderAddresses.Client(apiClient),
+    stories: new Stories.Client(apiClient),
+    snippets: new Snippets.Client(apiClient),
+    subscriptions: new Subscriptions.Client(apiClient)
+  };
+}

package/dist/{Sdk → api}/ApiClient.d.ts

@@ -1,10 +1,10 @@
-import { ApiResponse, HeadersMap, Params, ParamsWithPayload } from '../Api';
+import type { ApiResponse, HeadersMap, Params, ParamsWithPayload } from '../http';
 export interface Options {
     accessToken: string;
     baseUrl: string;
     headers: HeadersMap;
 }
-export default class ApiClient {
+export declare class ApiClient {
     private readonly baseUrl;
     private readonly headers;
     constructor({ accessToken, baseUrl, headers }: Options);

package/dist/api/ApiClient.js

@@ -0,0 +1,88 @@
+import { Http } from "../http/index.js";
+import { stripSlashes } from "../utils.js";
+import { DEFAULT_USER_AGENT } from "./constants.js";
+export class ApiClient {
+  constructor({
+    accessToken,
+    baseUrl,
+    headers
+  }) {
+    this.baseUrl = baseUrl;
+    this.headers = {
+      authorization: `Bearer ${accessToken}`,
+      'User-Agent': DEFAULT_USER_AGENT,
+      ...headers
+    };
+  }
+  get(endpointUri, {
+    headers,
+    query
+  } = {}) {
+    return Http.get(this.buildEndpointUrl(endpointUri), {
+      headers: {
+        ...this.headers,
+        ...headers
+      },
+      query
+    });
+  }
+  post(endpointUri, {
+    headers,
+    payload,
+    query
+  } = {}) {
+    return Http.post(this.buildEndpointUrl(endpointUri), {
+      headers: {
+        ...this.headers,
+        ...headers
+      },
+      payload,
+      query
+    });
+  }
+  put(endpointUri, {
+    headers,
+    payload,
+    query
+  } = {}) {
+    return Http.put(this.buildEndpointUrl(endpointUri), {
+      headers: {
+        ...this.headers,
+        ...headers
+      },
+      payload,
+      query
+    });
+  }
+  patch(endpointUri, {
+    headers,
+    payload,
+    query
+  } = {}) {
+    return Http.patch(this.buildEndpointUrl(endpointUri), {
+      headers: {
+        ...this.headers,
+        ...headers
+      },
+      payload,
+      query
+    });
+  }
+  delete(endpointUri, {
+    headers,
+    payload,
+    query
+  } = {}) {
+    return Http.delete(this.buildEndpointUrl(endpointUri), {
+      headers: {
+        ...this.headers,
+        ...headers
+      },
+      payload,
+      query
+    });
+  }
+  buildEndpointUrl(endpointUri) {
+    return `${stripSlashes(this.baseUrl)}/${stripSlashes(endpointUri)}`;
+  }
+}

package/dist/{Sdk → api}/DeferredJobsApiClient.d.ts

@@ -1,7 +1,7 @@
 import { ProgressPromise } from '@prezly/progress-promise';
-import { Params, ParamsWithPayload } from '../Api';
-import ApiClient from './ApiClient';
-export default class DeferredJobsApiClient {
+import type { Params, ParamsWithPayload } from '../http';
+import type { ApiClient } from './ApiClient';
+export declare class DeferredJobsApiClient {
     private readonly apiClient;
     constructor(apiClient: ApiClient);
     get<V = any, P = any>(endpointUri: string, { headers, query }?: Params): ProgressPromise<V, P>;

package/dist/api/DeferredJobsApiClient.js

@@ -0,0 +1,92 @@
+import { ProgressPromise } from '@prezly/progress-promise';
+import { Http, HttpCodes, isDeferredJobResponse } from "../http/index.js";
+import { routing } from "../routing.js";
+import { JobStatus } from "../types/index.js";
+const JOB_STATUS_POLLING_INTERVAL = 2000; // ms
+
+async function sleep(milliseconds) {
+  return new Promise(resolve => setTimeout(resolve, milliseconds));
+}
+async function handleDeferredJob(request) {
+  const response = await request;
+  if (response.status === HttpCodes.ACCEPTED && isDeferredJobResponse(response.payload)) {
+    return new ProgressPromise(async function (resolve, reject, progress) {
+      do {
+        const response = await Http.get(routing.jobsUrl);
+        const {
+          job
+        } = response.payload;
+        if (job.status === JobStatus.RESOLVED) {
+          resolve(job.value);
+          return;
+        }
+        if (job.status === JobStatus.REJECTED) {
+          reject(job.value);
+          return;
+        }
+        progress(job.progress, job.value);
+        await sleep(JOB_STATUS_POLLING_INTERVAL);
+      } while (true); // eslint-disable-line no-constant-condition
+    });
+  }
+
+  return ProgressPromise.resolve(response.payload);
+}
+export class DeferredJobsApiClient {
+  constructor(apiClient) {
+    this.apiClient = apiClient;
+  }
+  get(endpointUri, {
+    headers,
+    query
+  } = {}) {
+    return handleDeferredJob(this.apiClient.get(endpointUri, {
+      headers,
+      query
+    }));
+  }
+  post(endpointUri, {
+    headers,
+    payload,
+    query
+  } = {}) {
+    return handleDeferredJob(this.apiClient.post(endpointUri, {
+      headers,
+      payload,
+      query
+    }));
+  }
+  put(endpointUri, {
+    headers,
+    payload,
+    query
+  } = {}) {
+    return handleDeferredJob(this.apiClient.put(endpointUri, {
+      headers,
+      payload,
+      query
+    }));
+  }
+  patch(endpointUri, {
+    headers,
+    payload,
+    query
+  } = {}) {
+    return handleDeferredJob(this.apiClient.patch(endpointUri, {
+      headers,
+      payload,
+      query
+    }));
+  }
+  delete(endpointUri, {
+    headers,
+    payload,
+    query
+  } = {}) {
+    return handleDeferredJob(this.apiClient.delete(endpointUri, {
+      headers,
+      payload,
+      query
+    }));
+  }
+}

package/dist/api/constants.js

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

package/dist/api/index.d.ts

@@ -0,0 +1,2 @@
+export { ApiClient } from './ApiClient';
+export { DeferredJobsApiClient } from './DeferredJobsApiClient';

package/dist/api/index.js

@@ -0,0 +1,2 @@
+export { ApiClient } from "./ApiClient.js";
+export { DeferredJobsApiClient } from "./DeferredJobsApiClient.js";

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

@@ -0,0 +1,10 @@
+import type { DeferredJobsApiClient } from '../../api';
+import type { UserAccount } from '../../types';
+import type { CreateRequest, CreateResponse, ListResponse, UpdateRequest, UpdateResponse } from './types';
+export declare class Client {
+    private readonly apiClient;
+    constructor(apiClient: DeferredJobsApiClient);
+    list(): Promise<ListResponse>;
+    create(payload: CreateRequest): Promise<CreateResponse>;
+    update(id: UserAccount['id'], payload: UpdateRequest): Promise<UpdateResponse>;
+}

package/dist/endpoints/Accounts/Client.js

@@ -0,0 +1,22 @@
+import { routing } from "../../routing.js";
+export class Client {
+  constructor(apiClient) {
+    this.apiClient = apiClient;
+  }
+  async list() {
+    const url = routing.accounts;
+    return this.apiClient.get(url);
+  }
+  async create(payload) {
+    const url = routing.accounts;
+    return this.apiClient.post(url, {
+      payload
+    });
+  }
+  async update(id, payload) {
+    const url = `${routing.accounts}/${id}`;
+    return this.apiClient.patch(url, {
+      payload
+    });
+  }
+}

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

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

package/dist/endpoints/Accounts/index.js

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

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

@@ -0,0 +1,16 @@
+import type { UserAccount } from '../../types';
+export interface ListResponse {
+    accounts: UserAccount[];
+}
+export interface CreateRequest {
+    company_name: string;
+}
+export interface CreateResponse {
+    activation_url: string;
+}
+export interface UpdateRequest {
+    show_in_menu: boolean;
+}
+export interface UpdateResponse {
+    account: UserAccount;
+}

package/dist/endpoints/Accounts/types.js

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

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

@@ -0,0 +1,29 @@
+import type { DeferredJobsApiClient } from '../../api';
+import type { Campaign, Contact, EmailRecipient } from '../../types';
+import { Query } from '../../types';
+import type { RecipientsOperationResponse } from '../Campaigns';
+import type { ContactsScope } from './scopes';
+import type { ListOptions, ListResponse, SearchOptions } from './types';
+declare type CampaignId = Campaign['id'];
+declare type ContactId = Contact['id'];
+declare type EmailRecipientId = EmailRecipient['id'];
+export declare class Client {
+    private readonly apiClient;
+    constructor(apiClient: DeferredJobsApiClient);
+    list(campaignId: CampaignId, options: ListOptions): Promise<ListResponse>;
+    search(campaignId: CampaignId, options: SearchOptions): Promise<ListResponse>;
+    get(campaignId: CampaignId, recipientId: EmailRecipientId): Promise<EmailRecipient>;
+    addContact(campaignId: CampaignId, contact: {
+        id: ContactId;
+        emailAddress?: string;
+    }): Promise<RecipientsOperationResponse>;
+    addContacts(campaignId: CampaignId, contacts: {
+        query?: Query;
+        scope?: ContactsScope;
+    }): Promise<RecipientsOperationResponse>;
+    removeRecipient(campaignId: CampaignId, recipientId: EmailRecipientId): Promise<RecipientsOperationResponse>;
+    removeRecipients(campaignId: CampaignId, params?: {
+        query: Query;
+    }): Promise<RecipientsOperationResponse>;
+}
+export {};

package/dist/endpoints/CampaignRecipients/Client.js

@@ -0,0 +1,78 @@
+import { routing } from "../../routing.js";
+import { Query } from "../../types/index.js";
+export class Client {
+  constructor(apiClient) {
+    this.apiClient = apiClient;
+  }
+  async list(campaignId, options) {
+    const {
+      limit,
+      offset,
+      sortOrder
+    } = options;
+    const url = routing.campaignRecipientsUrl.replace(':campaign_id', String(campaignId));
+    return this.apiClient.get(url, {
+      query: {
+        limit,
+        offset,
+        sort: sortOrder
+      }
+    });
+  }
+  async search(campaignId, options) {
+    const {
+      limit,
+      offset,
+      sortOrder,
+      query
+    } = options;
+    const url = routing.campaignRecipientsUrl.replace(':campaign_id', String(campaignId));
+    // TODO: Introduce dedicated Search POST API
+    return this.apiClient.get(url, {
+      query: {
+        query: Query.stringify(query),
+        sort: sortOrder,
+        limit,
+        offset
+      }
+    });
+  }
+  async get(campaignId, recipientId) {
+    const url = routing.campaignRecipientsUrl.replace(':campaign_id', String(campaignId));
+    const {
+      recipient
+    } = await this.apiClient.get(`${url}/${recipientId}`);
+    return recipient;
+  }
+  async addContact(campaignId, contact) {
+    const url = routing.campaignRecipientsUrl.replace(':campaign_id', String(campaignId));
+    return this.apiClient.post(url, {
+      payload: {
+        contact
+      }
+    });
+  }
+  async addContacts(campaignId, contacts) {
+    const url = routing.campaignRecipientsUrl.replace(':campaign_id', String(campaignId));
+    return this.apiClient.post(url, {
+      payload: {
+        contacts
+      }
+    });
+  }
+  async removeRecipient(campaignId, recipientId) {
+    const url = routing.campaignRecipientsUrl.replace(':campaign_id', String(campaignId));
+    return this.apiClient.delete(`${url}/${recipientId}`);
+  }
+  async removeRecipients(campaignId, params) {
+    const {
+      query
+    } = params || {};
+    const url = routing.campaignRecipientsUrl.replace(':campaign_id', String(campaignId));
+    return this.apiClient.delete(url, {
+      payload: {
+        query
+      }
+    });
+  }
+}

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

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

package/dist/endpoints/CampaignRecipients/index.js

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

package/dist/endpoints/CampaignRecipients/scopes.d.ts

@@ -0,0 +1,27 @@
+import type { Campaign, Contact, EmailRecipient, SelectionValue } from '../../types';
+export interface AllContactsScope {
+    type: 'scope:contacts';
+    selection?: SelectionValue<Contact['id']>;
+}
+export interface ContactOrganisationsScope {
+    type: 'scope:contact_organisations';
+    contact_id: Contact['id'];
+    selection?: SelectionValue<Contact['id']>;
+}
+export interface ContactEmployeesScope {
+    type: 'scope:contact_organisations';
+    contact_id: Contact['id'];
+    selection?: SelectionValue<Contact['id']>;
+}
+export interface CampaignRecipientsScope {
+    type: 'scope:campaign_recipients';
+    campaign_id: Campaign['id'];
+    selection?: SelectionValue<EmailRecipient['id']>;
+}
+export interface CampaignReportScope {
+    type: 'scope:campaign_recipients';
+    campaign_id: Campaign['id'];
+    report: 'recipients' | 'sent' | 'clicked' | 'opened' | 'unopened' | 'undelivered' | 'unsubscribed';
+    selection?: SelectionValue<Contact['id']>;
+}
+export declare type ContactsScope = AllContactsScope | ContactOrganisationsScope | ContactEmployeesScope | CampaignRecipientsScope | CampaignReportScope;

package/dist/endpoints/CampaignRecipients/scopes.js

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

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

@@ -0,0 +1,14 @@
+import type { EmailRecipient, Pagination, Query } from '../../types';
+export interface ListOptions {
+    limit?: number;
+    offset?: number;
+    sortOrder?: string;
+}
+export interface SearchOptions extends ListOptions {
+    query?: Query;
+}
+export interface ListResponse {
+    recipients: EmailRecipient[];
+    pagination: Pagination;
+    sort: string;
+}

package/dist/endpoints/CampaignRecipients/types.js

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

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

@@ -0,0 +1,21 @@
+import type { ProgressPromise } from '@prezly/progress-promise';
+import type { DeferredJobsApiClient } from '../../api';
+import type { Campaign } from '../../types';
+import type { CreateRequest, RecipientsOperationResponse, CampaignResponse, UpdateRequest, ListResponse, SearchOptions } from './types';
+export declare class Client {
+    private readonly apiClient;
+    constructor(apiClient: DeferredJobsApiClient);
+    list(options: SearchOptions): Promise<ListResponse>;
+    search(options: SearchOptions): Promise<ListResponse>;
+    get(id: Campaign['id']): Promise<CampaignResponse>;
+    duplicate(id: Campaign['id']): Promise<CampaignResponse>;
+    delete(id: Campaign['id']): Promise<void>;
+    test(id: Campaign['id'], emails: string[]): Promise<void>;
+    send(id: Campaign['id']): Promise<void>;
+    schedule(id: Campaign['id'], sendAt: Date): Promise<Campaign>;
+    unschedule(id: Campaign['id']): Promise<Campaign>;
+    create(payload: CreateRequest): ProgressPromise<RecipientsOperationResponse, {
+        recipients_number: number;
+    }>;
+    update(id: Campaign['id'], payload: UpdateRequest): Promise<CampaignResponse>;
+}