@prezly/sdk 11.7.1 → 11.8.1-0

package/dist/Client.cjs

@@ -0,0 +1,45 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.createClient = createClient;
+var _index = require("./api/index.cjs");
+var _index2 = require("./endpoints/index.cjs");
+const DEFAULT_BASE_URL = 'https://api.prezly.com';
+function createClient({
+  accessToken,
+  baseUrl = DEFAULT_BASE_URL,
+  headers = {}
+}) {
+  const apiClient = new _index.DeferredJobsApiClient(new _index.ApiClient({
+    accessToken,
+    baseUrl,
+    headers
+  }));
+  return {
+    accounts: new _index2.Accounts.Client(apiClient),
+    billing: new _index2.Billing.Client(apiClient),
+    campaigns: new _index2.Campaigns.Client(apiClient),
+    campaignRecipients: new _index2.CampaignRecipients.Client(apiClient),
+    contactsExports: new _index2.ContactsExports.Client(apiClient),
+    coverage: new _index2.Coverage.Client(apiClient),
+    jobs: new _index2.Jobs.Client(apiClient),
+    licenses: new _index2.Licenses.Client(apiClient),
+    newsrooms: new _index2.Newsrooms.Client(apiClient),
+    newsroomCategories: new _index2.NewsroomCategories.Client(apiClient),
+    newsroomContacts: new _index2.NewsroomContacts.Client(apiClient),
+    newsroomLanguages: new _index2.NewsroomLanguages.Client(apiClient),
+    newsroomThemes: new _index2.NewsroomThemes.Client(apiClient),
+    newsroomWebhooks: new _index2.NewsroomWebhooks.Client(apiClient),
+    newsroomPrivacyRequests: new _index2.NewsroomPrivacyRequests.Client(apiClient),
+    newsroomDomains: new _index2.NewsroomDomains.Client(apiClient),
+    newsroomGalleries: new _index2.NewsroomGalleries.Client(apiClient),
+    senderAddresses: new _index2.SenderAddresses.Client(apiClient),
+    signup: new _index2.Signup.Client(apiClient),
+    stories: new _index2.Stories.Client(apiClient),
+    snippets: new _index2.Snippets.Client(apiClient),
+    subscriptions: new _index2.Subscriptions.Client(apiClient),
+    notificationSubscriptions: new _index2.NotificationSubscriptions.Client(apiClient)
+  };
+}

package/dist/api/ApiClient.cjs

@@ -0,0 +1,95 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.ApiClient = void 0;
+var _index = require("../http/index.cjs");
+var _utils = require("../utils.cjs");
+var _constants = require("./constants.cjs");
+class ApiClient {
+  constructor({
+    accessToken,
+    baseUrl,
+    headers
+  }) {
+    this.baseUrl = baseUrl;
+    this.headers = {
+      authorization: `Bearer ${accessToken}`,
+      'User-Agent': _constants.DEFAULT_USER_AGENT,
+      ...headers
+    };
+  }
+  get(endpointUri, {
+    headers,
+    query
+  } = {}) {
+    return _index.Http.get(this.buildEndpointUrl(endpointUri), {
+      headers: {
+        ...this.headers,
+        ...headers
+      },
+      query
+    });
+  }
+  post(endpointUri, {
+    headers,
+    payload,
+    query
+  } = {}) {
+    return _index.Http.post(this.buildEndpointUrl(endpointUri), {
+      headers: {
+        ...this.headers,
+        ...headers
+      },
+      payload,
+      query
+    });
+  }
+  put(endpointUri, {
+    headers,
+    payload,
+    query
+  } = {}) {
+    return _index.Http.put(this.buildEndpointUrl(endpointUri), {
+      headers: {
+        ...this.headers,
+        ...headers
+      },
+      payload,
+      query
+    });
+  }
+  patch(endpointUri, {
+    headers,
+    payload,
+    query
+  } = {}) {
+    return _index.Http.patch(this.buildEndpointUrl(endpointUri), {
+      headers: {
+        ...this.headers,
+        ...headers
+      },
+      payload,
+      query
+    });
+  }
+  delete(endpointUri, {
+    headers,
+    payload,
+    query
+  } = {}) {
+    return _index.Http.delete(this.buildEndpointUrl(endpointUri), {
+      headers: {
+        ...this.headers,
+        ...headers
+      },
+      payload,
+      query
+    });
+  }
+  buildEndpointUrl(endpointUri) {
+    return `${(0, _utils.stripSlashes)(this.baseUrl)}/${(0, _utils.stripSlashes)(endpointUri)}`;
+  }
+}
+exports.ApiClient = ApiClient;

package/dist/api/DeferredJobsApiClient.cjs

@@ -0,0 +1,99 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.DeferredJobsApiClient = void 0;
+var _progressPromise = require("@prezly/progress-promise");
+var _index = require("../http/index.cjs");
+var _routing = require("../routing.cjs");
+var _index2 = require("../types/index.cjs");
+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 === _index.HttpCodes.ACCEPTED && (0, _index.isDeferredJobResponse)(response.payload)) {
+    return new _progressPromise.ProgressPromise(async function (resolve, reject, progress) {
+      do {
+        const response = await _index.Http.get(_routing.routing.jobsUrl);
+        const {
+          job
+        } = response.payload;
+        if (job.status === _index2.JobStatus.RESOLVED) {
+          resolve(job.value);
+          return;
+        }
+        if (job.status === _index2.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.ProgressPromise.resolve(response.payload);
+}
+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
+    }));
+  }
+}
+exports.DeferredJobsApiClient = DeferredJobsApiClient;

package/dist/api/constants.cjs

@@ -0,0 +1,10 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.DEFAULT_USER_AGENT = void 0;
+const VERSION = "11.8.0";
+const URL = 'https://github.com/prezly/javascript-sdk';
+const DEFAULT_USER_AGENT = `prezly-javascript-sdk/${VERSION} (+${URL})`;
+exports.DEFAULT_USER_AGENT = DEFAULT_USER_AGENT;

package/dist/api/constants.js

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

package/dist/api/index.cjs

@@ -0,0 +1,19 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+Object.defineProperty(exports, "ApiClient", {
+  enumerable: true,
+  get: function () {
+    return _ApiClient.ApiClient;
+  }
+});
+Object.defineProperty(exports, "DeferredJobsApiClient", {
+  enumerable: true,
+  get: function () {
+    return _DeferredJobsApiClient.DeferredJobsApiClient;
+  }
+});
+var _ApiClient = require("./ApiClient.cjs");
+var _DeferredJobsApiClient = require("./DeferredJobsApiClient.cjs");

package/dist/endpoints/Accounts/Client.cjs

@@ -0,0 +1,29 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.Client = void 0;
+var _routing = require("../../routing.cjs");
+class Client {
+  constructor(apiClient) {
+    this.apiClient = apiClient;
+  }
+  async list() {
+    const url = _routing.routing.accounts;
+    return this.apiClient.get(url);
+  }
+  async create(payload) {
+    const url = _routing.routing.accounts;
+    return this.apiClient.post(url, {
+      payload
+    });
+  }
+  async update(id, payload) {
+    const url = `${_routing.routing.accounts}/${id}`;
+    return this.apiClient.patch(url, {
+      payload
+    });
+  }
+}
+exports.Client = Client;

package/dist/endpoints/Accounts/index.cjs

@@ -0,0 +1,25 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+var _Client = require("./Client.cjs");
+Object.keys(_Client).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _Client[key];
+    }
+  });
+});
+var _types = require("./types.cjs");
+Object.keys(_types).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _types[key];
+    }
+  });
+});

package/dist/endpoints/Accounts/types.cjs

@@ -0,0 +1 @@
+"use strict";

package/dist/endpoints/Billing/Client.cjs

@@ -0,0 +1,19 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.Client = void 0;
+var _routing = require("../../routing.cjs");
+class Client {
+  constructor(apiClient) {
+    this.apiClient = apiClient;
+  }
+  async signup(payload) {
+    const url = `${_routing.routing.billing}/signup`;
+    return this.apiClient.post(url, {
+      payload
+    });
+  }
+}
+exports.Client = Client;

package/dist/endpoints/Billing/index.cjs

@@ -0,0 +1,25 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+var _Client = require("./Client.cjs");
+Object.keys(_Client).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _Client[key];
+    }
+  });
+});
+var _types = require("./types.cjs");
+Object.keys(_types).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _types[key];
+    }
+  });
+});

package/dist/endpoints/Billing/types.cjs

@@ -0,0 +1,25 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.SignupBillingCycle = exports.SignupCurrency = exports.SignupPlan = void 0;
+let SignupPlan;
+exports.SignupPlan = SignupPlan;
+(function (SignupPlan) {
+  SignupPlan["STARTER"] = "starter";
+  SignupPlan["CORE"] = "core";
+  SignupPlan["PREMIUM"] = "premium";
+})(SignupPlan || (exports.SignupPlan = SignupPlan = {}));
+let SignupCurrency;
+exports.SignupCurrency = SignupCurrency;
+(function (SignupCurrency) {
+  SignupCurrency["EUR"] = "eur";
+  SignupCurrency["USD"] = "usd";
+})(SignupCurrency || (exports.SignupCurrency = SignupCurrency = {}));
+let SignupBillingCycle;
+exports.SignupBillingCycle = SignupBillingCycle;
+(function (SignupBillingCycle) {
+  SignupBillingCycle["YEAR"] = "year";
+  SignupBillingCycle["MONTH"] = "month";
+})(SignupBillingCycle || (exports.SignupBillingCycle = SignupBillingCycle = {}));

package/dist/endpoints/CampaignRecipients/Client.cjs

@@ -0,0 +1,85 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.Client = void 0;
+var _routing = require("../../routing.cjs");
+var _index = require("../../types/index.cjs");
+class Client {
+  constructor(apiClient) {
+    this.apiClient = apiClient;
+  }
+  async list(campaignId, options) {
+    const {
+      limit,
+      offset,
+      sortOrder
+    } = options;
+    const url = _routing.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.routing.campaignRecipientsUrl.replace(':campaign_id', String(campaignId));
+    // TODO: Introduce dedicated Search POST API
+    return this.apiClient.get(url, {
+      query: {
+        query: _index.Query.stringify(query),
+        sort: sortOrder,
+        limit,
+        offset
+      }
+    });
+  }
+  async get(campaignId, recipientId) {
+    const url = _routing.routing.campaignRecipientsUrl.replace(':campaign_id', String(campaignId));
+    const {
+      recipient
+    } = await this.apiClient.get(`${url}/${recipientId}`);
+    return recipient;
+  }
+  async addContact(campaignId, contact) {
+    const url = _routing.routing.campaignRecipientsUrl.replace(':campaign_id', String(campaignId));
+    return this.apiClient.post(url, {
+      payload: {
+        contact
+      }
+    });
+  }
+  async addContacts(campaignId, contacts) {
+    const url = _routing.routing.campaignRecipientsUrl.replace(':campaign_id', String(campaignId));
+    return this.apiClient.post(url, {
+      payload: {
+        contacts
+      }
+    });
+  }
+  async removeRecipient(campaignId, recipientId) {
+    const url = _routing.routing.campaignRecipientsUrl.replace(':campaign_id', String(campaignId));
+    return this.apiClient.delete(`${url}/${recipientId}`);
+  }
+  async removeRecipients(campaignId, params) {
+    const {
+      query
+    } = params || {};
+    const url = _routing.routing.campaignRecipientsUrl.replace(':campaign_id', String(campaignId));
+    return this.apiClient.delete(url, {
+      payload: {
+        query
+      }
+    });
+  }
+}
+exports.Client = Client;

package/dist/endpoints/CampaignRecipients/index.cjs

@@ -0,0 +1,37 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+var _exportNames = {
+  ContactsScope: true
+};
+Object.defineProperty(exports, "ContactsScope", {
+  enumerable: true,
+  get: function () {
+    return _index.ContactsScope;
+  }
+});
+var _Client = require("./Client.cjs");
+Object.keys(_Client).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _Client[key];
+    }
+  });
+});
+var _types = require("./types.cjs");
+Object.keys(_types).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _types[key];
+    }
+  });
+});
+var _index = require("../../types/index.cjs");

package/dist/endpoints/CampaignRecipients/types.cjs

@@ -0,0 +1 @@
+"use strict";

package/dist/endpoints/Campaigns/Client.cjs

@@ -0,0 +1,92 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.Client = void 0;
+var _routing = require("../../routing.cjs");
+var _index = require("../../types/index.cjs");
+var _utils = require("../../utils.cjs");
+class Client {
+  constructor(apiClient) {
+    this.apiClient = apiClient;
+  }
+  async list(options) {
+    const {
+      query,
+      limit,
+      offset,
+      sortOrder
+    } = options;
+    return this.apiClient.get(_routing.routing.campaignsUrl, {
+      query: {
+        limit,
+        offset,
+        query: _index.Query.stringify(query),
+        sort: sortOrder
+      }
+    });
+  }
+  async search(options) {
+    const {
+      query,
+      limit,
+      offset,
+      sortOrder
+    } = options;
+    return this.apiClient.post(_routing.routing.campaignsUrl, {
+      payload: {
+        limit,
+        offset,
+        query,
+        sort: sortOrder
+      }
+    });
+  }
+  async get(id) {
+    return this.apiClient.get(`${_routing.routing.campaignsUrl}/${id}`);
+  }
+  async duplicate(id) {
+    return this.apiClient.post(`${_routing.routing.campaignsUrl}/${id}/duplicate`);
+  }
+  async delete(id) {
+    return this.apiClient.delete(`${_routing.routing.campaignsUrl}/${id}`);
+  }
+  async test(id, emails) {
+    return this.apiClient.post(`${_routing.routing.campaignsUrl}/${id}/test`, {
+      payload: {
+        emails
+      }
+    });
+  }
+  async send(id) {
+    return this.apiClient.post(`${_routing.routing.campaignsUrl}/${id}/send`);
+  }
+  async schedule(id, sendAt) {
+    const {
+      campaign
+    } = await this.apiClient.post(`${_routing.routing.campaignsUrl}/${id}/schedule`, {
+      payload: {
+        schedule_at: (0, _utils.toIso8601)(sendAt)
+      }
+    });
+    return campaign;
+  }
+  async unschedule(id) {
+    const {
+      campaign
+    } = await this.apiClient.post(`${_routing.routing.campaignsUrl}/${id}/unschedule`);
+    return campaign;
+  }
+  async create(payload) {
+    return this.apiClient.post(_routing.routing.campaignsUrl, {
+      payload
+    });
+  }
+  async update(id, payload) {
+    return this.apiClient.patch(`${_routing.routing.campaignsUrl}/${id}`, {
+      payload
+    });
+  }
+}
+exports.Client = Client;

package/dist/endpoints/Campaigns/index.cjs

@@ -0,0 +1,25 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+var _Client = require("./Client.cjs");
+Object.keys(_Client).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _Client[key];
+    }
+  });
+});
+var _types = require("./types.cjs");
+Object.keys(_types).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _types[key];
+    }
+  });
+});

package/dist/endpoints/Campaigns/types.cjs

@@ -0,0 +1 @@
+"use strict";