@prezly/sdk 11.8.1-cjs → 11.9.0

package/dist/endpoints/ContactsExports/Client.cjs

@@ -0,0 +1,98 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.Client = void 0;
+var _routing = require("../../routing.cjs");
+class Client {
+  constructor(apiClient) {
+    this.apiClient = apiClient;
+  }
+
+  /**
+   * List Contacts Exports with sorting, and pagination.
+   */
+  async list(options) {
+    const {
+      limit,
+      offset,
+      sortOrder
+    } = options;
+    return this.apiClient.get(_routing.routing.contactsExportsUrl, {
+      query: {
+        limit,
+        offset,
+        sort: sortOrder
+      }
+    });
+  }
+
+  /**
+   * List Contacts Exports with sorting, pagination, and filtering.
+   */
+  async search(options) {
+    const {
+      query,
+      limit,
+      offset,
+      sortOrder
+    } = options;
+    const url = `${_routing.routing.contactsExportsUrl}/search`;
+    return this.apiClient.post(url, {
+      payload: {
+        limit,
+        offset,
+        query,
+        sort: sortOrder
+      }
+    });
+  }
+
+  /**
+   * Fetch Contacts Export object by its uuid.
+   */
+  async get(uuid) {
+    const url = `${_routing.routing.contactsExportsUrl}/${uuid}`;
+    const response = await this.apiClient.get(url);
+    return response.export;
+  }
+
+  /**
+   * Request export of the given selection of Contacts.
+   * If the selection size is small enough, it can be processed right away,
+   * returning an export with `status: "done"`.
+   *
+   * Otherwise, returns an export with `status: "new"`,
+   * and will notify the user over email when it's done.
+   */
+  async create(selector) {
+    const {
+      query,
+      scope
+    } = selector;
+    const response = await this.apiClient.post(_routing.routing.contactsExportsUrl, {
+      payload: {
+        contacts: {
+          query,
+          scope
+        }
+      }
+    });
+    return response.export;
+  }
+
+  /**
+   * Fetch a download URL to retrieve the given Contacts Export file.
+   * Only works for exports with status = "done"
+   * Fails with Method Not Allowed (405) error for pending and failed exports.
+   */
+  async download(uuid) {
+    const url = `${_routing.routing.contactsExportsUrl}/${uuid}/download`;
+    const response = await this.apiClient.post(url);
+    return {
+      downloadUrl: response.download_url
+    };
+  }
+}
+exports.Client = Client;

package/dist/endpoints/ContactsExports/Client.js

@@ -1,11 +1,5 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.Client = void 0;
-var _routing = require("../../routing.js");
-class Client {
+import { routing } from "../../routing.js";
+export class Client {
   constructor(apiClient) {
     this.apiClient = apiClient;
   }
@@ -19,7 +13,7 @@ class Client {
       offset,
       sortOrder
     } = options;
-    return this.apiClient.get(_routing.routing.contactsExportsUrl, {
+    return this.apiClient.get(routing.contactsExportsUrl, {
       query: {
         limit,
         offset,
@@ -38,7 +32,7 @@ class Client {
       offset,
       sortOrder
     } = options;
-    const url = `${_routing.routing.contactsExportsUrl}/search`;
+    const url = `${routing.contactsExportsUrl}/search`;
     return this.apiClient.post(url, {
       payload: {
         limit,
@@ -53,7 +47,7 @@ class Client {
    * Fetch Contacts Export object by its uuid.
    */
   async get(uuid) {
-    const url = `${_routing.routing.contactsExportsUrl}/${uuid}`;
+    const url = `${routing.contactsExportsUrl}/${uuid}`;
     const response = await this.apiClient.get(url);
     return response.export;
   }
@@ -71,7 +65,7 @@ class Client {
       query,
       scope
     } = selector;
-    const response = await this.apiClient.post(_routing.routing.contactsExportsUrl, {
+    const response = await this.apiClient.post(routing.contactsExportsUrl, {
       payload: {
         contacts: {
           query,
@@ -88,11 +82,10 @@ class Client {
    * Fails with Method Not Allowed (405) error for pending and failed exports.
    */
   async download(uuid) {
-    const url = `${_routing.routing.contactsExportsUrl}/${uuid}/download`;
+    const url = `${routing.contactsExportsUrl}/${uuid}/download`;
     const response = await this.apiClient.post(url);
     return {
       downloadUrl: response.download_url
     };
   }
-}
-exports.Client = Client;
+}

package/dist/endpoints/ContactsExports/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/ContactsExports/index.js

@@ -1,37 +1,3 @@
-"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.js");
-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.js");
-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.js");
+export * from "./Client.js";
+export * from "./types.js";
+export { ContactsScope } from "../../types/index.js"; // convenience shortcut

package/dist/endpoints/ContactsExports/types.cjs

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

package/dist/endpoints/ContactsExports/types.js

@@ -1 +1 @@
-"use strict";
+export {};

package/dist/endpoints/Coverage/Client.cjs

@@ -0,0 +1,109 @@
+"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(options = {}, scope) {
+    const {
+      includeDeleted,
+      limit,
+      offset,
+      sortOrder
+    } = options;
+    // TODO: Switch to `scope` API parameter
+    const url = scope?.story ? _routing.routing.storyCoverageUrl.replace(':story_id', String(scope.story)) : _routing.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.routing.storyCoverageUrl.replace(':story_id', String(scope.story)) : _routing.routing.coverageUrl;
+    // TODO: Introduce dedicated Search POST API
+    return this.apiClient.get(url, {
+      query: {
+        include_deleted: includeDeleted ? 'on' : undefined,
+        query: _index.Query.stringify(query),
+        limit,
+        offset,
+        sort: sortOrder
+      }
+    });
+  }
+  async get(id, includeDeleted = false) {
+    const url = `${_routing.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.routing.coverageUrl, {
+      payload
+    });
+    return coverage;
+  }
+  async update(id, payload) {
+    const {
+      coverage
+    } = await this.apiClient.patch(`${_routing.routing.coverageUrl}/${id}`, {
+      payload
+    });
+    return coverage;
+  }
+  async remove(id) {
+    return this.apiClient.delete(`${_routing.routing.coverageUrl}/${id}`);
+  }
+  async bulkRemove(options) {
+    const {
+      selection,
+      query
+    } = options;
+    return this.apiClient.delete(_routing.routing.coverageUrl, {
+      payload: {
+        selection,
+        query
+      }
+    });
+  }
+}
+exports.Client = Client;

package/dist/endpoints/Coverage/Client.js

@@ -1,12 +1,6 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.Client = void 0;
-var _routing = require("../../routing.js");
-var _index = require("../../types/index.js");
-class Client {
+import { routing } from "../../routing.js";
+import { Query } from "../../types/index.js";
+export class Client {
   constructor(apiClient) {
     this.apiClient = apiClient;
   }
@@ -18,7 +12,7 @@ class Client {
       sortOrder
     } = options;
     // TODO: Switch to `scope` API parameter
-    const url = scope?.story ? _routing.routing.storyCoverageUrl.replace(':story_id', String(scope.story)) : _routing.routing.coverageUrl;
+    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,
@@ -37,12 +31,12 @@ class Client {
       sortOrder
     } = options;
     // TODO: Switch to `scope` API parameter
-    const url = scope?.story ? _routing.routing.storyCoverageUrl.replace(':story_id', String(scope.story)) : _routing.routing.coverageUrl;
+    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: _index.Query.stringify(query),
+        query: Query.stringify(query),
         limit,
         offset,
         sort: sortOrder
@@ -50,7 +44,7 @@ class Client {
     });
   }
   async get(id, includeDeleted = false) {
-    const url = `${_routing.routing.coverageUrl}/${id}`;
+    const url = `${routing.coverageUrl}/${id}`;
     const {
       coverage
     } = await this.apiClient.get(url, {
@@ -77,7 +71,7 @@ class Client {
   async create(payload) {
     const {
       coverage
-    } = await this.apiClient.post(_routing.routing.coverageUrl, {
+    } = await this.apiClient.post(routing.coverageUrl, {
       payload
     });
     return coverage;
@@ -85,25 +79,24 @@ class Client {
   async update(id, payload) {
     const {
       coverage
-    } = await this.apiClient.patch(`${_routing.routing.coverageUrl}/${id}`, {
+    } = await this.apiClient.patch(`${routing.coverageUrl}/${id}`, {
       payload
     });
     return coverage;
   }
   async remove(id) {
-    return this.apiClient.delete(`${_routing.routing.coverageUrl}/${id}`);
+    return this.apiClient.delete(`${routing.coverageUrl}/${id}`);
   }
   async bulkRemove(options) {
     const {
       selection,
       query
     } = options;
-    return this.apiClient.delete(_routing.routing.coverageUrl, {
+    return this.apiClient.delete(routing.coverageUrl, {
       payload: {
         selection,
         query
       }
     });
   }
-}
-exports.Client = Client;
+}

package/dist/endpoints/Coverage/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/Coverage/index.js

@@ -1,25 +1,2 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-var _Client = require("./Client.js");
-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.js");
-Object.keys(_types).forEach(function (key) {
-  if (key === "default" || key === "__esModule") return;
-  Object.defineProperty(exports, key, {
-    enumerable: true,
-    get: function () {
-      return _types[key];
-    }
-  });
-});
+export * from "./Client.js";
+export * from "./types.js";

package/dist/endpoints/Coverage/types.cjs

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

package/dist/endpoints/Coverage/types.js

@@ -1 +1 @@
-"use strict";
+export {};

package/dist/endpoints/Jobs/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 get(id) {
+    const {
+      job
+    } = await this.apiClient.get(`${_routing.routing.jobsUrl}/${id}`);
+    return job.state;
+  }
+}
+exports.Client = Client;

package/dist/endpoints/Jobs/Client.js

@@ -1,19 +1,12 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.Client = void 0;
-var _routing = require("../../routing.js");
-class Client {
+import { routing } from "../../routing.js";
+export class Client {
   constructor(apiClient) {
     this.apiClient = apiClient;
   }
   async get(id) {
     const {
       job
-    } = await this.apiClient.get(`${_routing.routing.jobsUrl}/${id}`);
+    } = await this.apiClient.get(`${routing.jobsUrl}/${id}`);
     return job.state;
   }
-}
-exports.Client = Client;
+}

package/dist/endpoints/Jobs/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/Jobs/index.js

@@ -1,25 +1,2 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-var _Client = require("./Client.js");
-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.js");
-Object.keys(_types).forEach(function (key) {
-  if (key === "default" || key === "__esModule") return;
-  Object.defineProperty(exports, key, {
-    enumerable: true,
-    get: function () {
-      return _types[key];
-    }
-  });
-});
+export * from "./Client.js";
+export * from "./types.js";

package/dist/endpoints/Jobs/types.cjs

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

package/dist/endpoints/Jobs/types.js

@@ -1 +1 @@
-"use strict";
+export {};

package/dist/endpoints/Licenses/Client.cjs

@@ -0,0 +1,20 @@
+"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 get() {
+    const url = _routing.routing.licenseUrl;
+    const {
+      license
+    } = await this.apiClient.get(`${url}/self`);
+    return license;
+  }
+}
+exports.Client = Client;

package/dist/endpoints/Licenses/Client.js

@@ -1,20 +1,13 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.Client = void 0;
-var _routing = require("../../routing.js");
-class Client {
+import { routing } from "../../routing.js";
+export class Client {
   constructor(apiClient) {
     this.apiClient = apiClient;
   }
   async get() {
-    const url = _routing.routing.licenseUrl;
+    const url = routing.licenseUrl;
     const {
       license
     } = await this.apiClient.get(`${url}/self`);
     return license;
   }
-}
-exports.Client = Client;
+}

package/dist/endpoints/Licenses/index.cjs

@@ -0,0 +1,15 @@
+"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];
+    }
+  });
+});