@prezly/sdk 11.7.1 → 11.8.1-0

package/dist/endpoints/SenderAddresses/Client.cjs

@@ -0,0 +1,44 @@
+"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 {
+      senders
+    } = await this.apiClient.get(_routing.routing.senderAddressesUrl);
+    return senders;
+  }
+  async create(payload) {
+    const {
+      sender
+    } = await this.apiClient.post(_routing.routing.senderAddressesUrl, {
+      payload
+    });
+    return sender;
+  }
+  async get(senderId) {
+    const {
+      sender
+    } = await this.apiClient.get(`${_routing.routing.senderAddressesUrl}/${senderId}`);
+    return sender;
+  }
+  async update(senderId, payload) {
+    const {
+      sender
+    } = await this.apiClient.patch(`${_routing.routing.senderAddressesUrl}/${senderId}`, {
+      payload
+    });
+    return sender;
+  }
+  async remove(senderId) {
+    return this.apiClient.delete(`${_routing.routing.senderAddressesUrl}/${senderId}`);
+  }
+}
+exports.Client = Client;

package/dist/endpoints/SenderAddresses/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/SenderAddresses/types.cjs

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

package/dist/endpoints/Signup/Client.cjs

@@ -0,0 +1,21 @@
+"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 checkEmailAvailability(email) {
+    const url = `${_routing.routing.signup}/check-availability`;
+    return this.apiClient.post(url, {
+      payload: {
+        email
+      }
+    });
+  }
+}
+exports.Client = Client;

package/dist/endpoints/Signup/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/Signup/types.cjs

@@ -0,0 +1,12 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.EmailAvailability = void 0;
+let EmailAvailability;
+exports.EmailAvailability = EmailAvailability;
+(function (EmailAvailability) {
+  EmailAvailability["AVAILABLE"] = "available";
+  EmailAvailability["TAKEN"] = "taken";
+})(EmailAvailability || (exports.EmailAvailability = EmailAvailability = {}));

package/dist/endpoints/Snippets/Client.cjs

@@ -0,0 +1,49 @@
+"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.snippetsUrl;
+    const {
+      snippets
+    } = await this.apiClient.get(url);
+    return snippets;
+  }
+  async get(snippetId) {
+    const url = _routing.routing.snippetsUrl;
+    const {
+      snippet
+    } = await this.apiClient.get(`${url}/${snippetId}`);
+    return snippet;
+  }
+  async create(payload) {
+    const url = _routing.routing.snippetsUrl;
+    const {
+      snippet
+    } = await this.apiClient.post(url, {
+      payload
+    });
+    return snippet;
+  }
+  async update(snippetId, payload) {
+    const url = _routing.routing.snippetsUrl;
+    const {
+      snippet
+    } = await this.apiClient.patch(`${url}/${snippetId}`, {
+      payload
+    });
+    return snippet;
+  }
+  async remove(snippetId) {
+    const url = _routing.routing.snippetsUrl;
+    return this.apiClient.delete(`${url}/${snippetId}`);
+  }
+}
+exports.Client = Client;

package/dist/endpoints/Snippets/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/Snippets/types.cjs

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

package/dist/endpoints/Stories/Client.cjs

@@ -0,0 +1,291 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.Client = void 0;
+var _index = require("../../http/index.cjs");
+var _ApiError = require("../../http/ApiError.cjs");
+var _routing = require("../../routing.cjs");
+class Client {
+  constructor(apiClient) {
+    this.apiClient = apiClient;
+  }
+  async list(options) {
+    const {
+      limit,
+      offset,
+      sortOrder,
+      include
+    } = options ?? {};
+    return this.apiClient.get(_routing.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.routing.storiesSearchUrl, {
+      payload: {
+        query,
+        limit,
+        offset,
+        sort: sortOrder,
+        include: include ? include.join(',') : undefined
+      }
+    });
+  }
+
+  /**
+   * Get story by UUID.
+   */
+
+  /**
+   * Implementation
+   */
+  async get(arg, options) {
+    const include = options?.include;
+    const isArray = Array.isArray(arg);
+    if (isArray && arg.length === 0) {
+      // No need to call the API.
+      return [];
+    }
+    if (isArray && typeof arg[0] === 'number') {
+      const {
+        stories
+      } = await this.search({
+        limit: arg.length,
+        query: {
+          id: {
+            $in: arg
+          }
+        },
+        include
+      });
+      return stories;
+    }
+    if (isArray && typeof arg[0] === 'string') {
+      const {
+        stories
+      } = await this.search({
+        limit: arg.length,
+        query: {
+          uuid: {
+            $in: arg
+          }
+        },
+        include
+      });
+      return stories;
+    }
+    const {
+      story
+    } = await this.apiClient.get(`${_routing.routing.storiesUrl}/${arg}`, {
+      query: {
+        include: include
+      }
+    });
+    return story;
+  }
+  async create(payload, options) {
+    const include = options?.include;
+    const {
+      story
+    } = await this.apiClient.post(_routing.routing.storiesUrl, {
+      payload,
+      query: {
+        include: include
+      }
+    });
+    return story;
+  }
+  async duplicate(id, options) {
+    const include = options?.include;
+    const url = `${_routing.routing.storiesUrl}/${id}/duplicate`;
+    const {
+      story
+    } = await this.apiClient.post(url, {
+      query: {
+        include: include
+      }
+    });
+    return story;
+  }
+  async translate(id, payload, options) {
+    const include = options?.include;
+    const url = `${_routing.routing.storiesUrl}/${id}/translate`;
+    const {
+      story
+    } = await this.apiClient.post(url, {
+      query: {
+        include: include
+      },
+      payload
+    });
+    return story;
+  }
+  async move(id, payload, options) {
+    const include = options?.include;
+    const force = options?.force;
+    const url = `${_routing.routing.storiesUrl}/${id}/move`;
+    try {
+      const {
+        story
+      } = await this.apiClient.post(url, {
+        query: {
+          include: include,
+          force
+        },
+        payload
+      });
+      return {
+        status: 'success',
+        story
+      };
+    } catch (error) {
+      if (error instanceof _ApiError.ApiError && error.status === _index.HttpCodes.CONFLICT) {
+        return error.payload;
+      }
+      throw error;
+    }
+  }
+  async update(id, payload, options) {
+    const url = `${_routing.routing.storiesUrl}/${id}`;
+    const include = options?.include;
+    const {
+      story
+    } = await this.apiClient.patch(url, {
+      payload,
+      query: {
+        include: include
+      }
+    });
+    return story;
+  }
+
+  /**
+   * This operation is only allowed for V3 stories
+   */
+  async autosave(id, payload, options) {
+    const url = `${_routing.routing.storiesUrl}/${id}/autosave`;
+    const include = options?.include;
+    const {
+      story
+    } = await this.apiClient.patch(url, {
+      payload,
+      query: {
+        include: include
+      }
+    });
+    return story;
+  }
+
+  /**
+   * This operation is only allowed for V3 stories
+   */
+  async revert(id, payload, options) {
+    const url = `${_routing.routing.storiesUrl}/${id}/revert`;
+    const include = options?.include;
+    const {
+      story
+    } = await this.apiClient.post(url, {
+      payload,
+      query: {
+        include: include
+      }
+    });
+    return story;
+  }
+  async publish(id, payload, options) {
+    const url = `${_routing.routing.storiesUrl}/${id}/publish`;
+    const include = options?.include;
+    const {
+      story
+    } = await this.apiClient.post(url, {
+      payload,
+      query: {
+        include: include
+      }
+    });
+    return story;
+  }
+  async unpublish(id, payload, options) {
+    const url = `${_routing.routing.storiesUrl}/${id}/unpublish`;
+    const include = options?.include;
+    const {
+      story
+    } = await this.apiClient.post(url, {
+      payload,
+      query: {
+        include: include
+      }
+    });
+    return story;
+  }
+  async schedule(id, payload, options) {
+    const url = `${_routing.routing.storiesUrl}/${id}/schedule`;
+    const include = options?.include;
+    const {
+      story
+    } = await this.apiClient.post(url, {
+      payload,
+      query: {
+        include: include
+      }
+    });
+    return story;
+  }
+  async unschedule(id, payload, options) {
+    const url = `${_routing.routing.storiesUrl}/${id}/unpublish`;
+    const include = options?.include;
+    const {
+      story
+    } = await this.apiClient.post(url, {
+      payload,
+      query: {
+        include: include
+      }
+    });
+    return story;
+  }
+  async pin(id, options) {
+    const url = `${_routing.routing.storiesUrl}/${id}/pin`;
+    const include = options?.include;
+    const {
+      story
+    } = await this.apiClient.post(url, {
+      query: {
+        include: include,
+        force: options?.force || undefined
+      }
+    });
+    return story;
+  }
+  async unpin(id, options) {
+    const url = `${_routing.routing.storiesUrl}/${id}/unpin`;
+    const include = options?.include;
+    const {
+      story
+    } = await this.apiClient.post(url, {
+      query: {
+        include: include
+      }
+    });
+    return story;
+  }
+  async delete(id) {
+    const url = `${_routing.routing.storiesUrl}/${id}`;
+    await this.apiClient.delete(url);
+  }
+}
+exports.Client = Client;

package/dist/endpoints/Stories/index.cjs

@@ -0,0 +1,35 @@
+"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];
+    }
+  });
+});
+var _scopes = require("./scopes.cjs");
+Object.keys(_scopes).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _scopes[key];
+    }
+  });
+});

package/dist/endpoints/Stories/scopes.cjs

@@ -0,0 +1,15 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.Scope = void 0;
+var _index = require("../../types/index.cjs");
+const Scope = {
+  EXCLUDE_ARCHIVED_NEWSROOMS: {
+    'newsroom.status': {
+      $nin: [_index.Newsroom.Status.ARCHIVED]
+    }
+  }
+};
+exports.Scope = Scope;

package/dist/endpoints/Stories/types.cjs

@@ -0,0 +1,51 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.EXTENDED_STORY_INCLUDED_EXTRA_FIELDS = exports.ALL_EXTRA_FIELDS = void 0;
+/**
+ * Uploadcare image JSON string.
+ */
+
+/**
+ * Raw HTML string.
+ */
+
+/**
+ * String containing Prezly Content Format JSON structure.
+ */
+
+const EXTENDED_STORY_INCLUDED_EXTRA_FIELDS_SHAPE = {
+  thumbnail_image: true,
+  header_image: true,
+  preview_image: true,
+  social_image: true,
+  social_text: true,
+  tag_names: true,
+  content: true,
+  attached_gallery_content: true,
+  referenced_entities: true
+}; // satisfies Record<keyof Omit<ExtendedStory, keyof Story>, boolean>; // TODO: Use Typescript `satisfies` operator, when it's out of beta
+
+const ALL_EXTRA_FIELDS_SHAPE = {
+  thumbnail_image: true,
+  header_image: true,
+  preview_image: true,
+  social_image: true,
+  social_text: true,
+  tag_names: true,
+  content: true,
+  autosaved_content: true,
+  content_version: true,
+  last_modifying_user: true,
+  attached_gallery_content: true,
+  referenced_entities: true,
+  'campaigns.count': true,
+  'pitches.count': true
+}; // satisfies Record<keyof Story.OnDemandFields, boolean>; // TODO: Use Typescript `satisfies` operator, when it's out of beta
+
+const ALL_EXTRA_FIELDS = Object.keys(ALL_EXTRA_FIELDS_SHAPE);
+exports.ALL_EXTRA_FIELDS = ALL_EXTRA_FIELDS;
+const EXTENDED_STORY_INCLUDED_EXTRA_FIELDS = Object.keys(EXTENDED_STORY_INCLUDED_EXTRA_FIELDS_SHAPE);
+exports.EXTENDED_STORY_INCLUDED_EXTRA_FIELDS = EXTENDED_STORY_INCLUDED_EXTRA_FIELDS;

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

@@ -90,6 +90,11 @@ interface GenericUpdateRequest {
     categories?: Category['id'][];
     tags?: string[];
     is_shared_to_prpro?: boolean;
+    seo_settings?: {
+        meta_title?: string | null;
+        meta_description?: string | null;
+        canonical_url?: string | null;
+    };
 }
 export interface HtmlStoryCreateRequest extends GenericCreateRequest {
     /**

package/dist/endpoints/Subscriptions/Client.cjs

@@ -0,0 +1,58 @@
+"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 subscribeToNewsroom(newsroomId, payload) {
+    const url = _routing.routing.newsroomSubscribeUrl.replace(':newsroom_id', String(newsroomId));
+    const {
+      subscription
+    } = await this.apiClient.post(url, {
+      payload
+    });
+    return subscription;
+  }
+  async unsubscribeFromNewsroom(newsroomId, payload) {
+    const url = _routing.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.routing.newsroomUnsubscribeUrl.replace(':newsroom_id', String(newsroomId));
+    const {
+      subscription
+    } = await this.apiClient.patch(`${url}/${subscriptionId}`, {
+      payload
+    });
+    return subscription;
+  }
+  async unsubscribeFromLicense(payload) {
+    const url = _routing.routing.licenseUnsubscribeUrl;
+    const {
+      subscription
+    } = await this.apiClient.post(url, {
+      payload
+    });
+    return subscription;
+  }
+  async updateLicenseUnsubscribeDetails(subscriptionId, payload) {
+    const url = _routing.routing.licenseUnsubscribeUrl;
+    const {
+      subscription
+    } = await this.apiClient.patch(`${url}/${subscriptionId}`, {
+      payload
+    });
+    return subscription;
+  }
+}
+exports.Client = Client;

package/dist/endpoints/Subscriptions/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];
+    }
+  });
+});