@prezly/sdk 19.8.0 → 19.9.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (92) hide show
  1. package/dist/Client.cjs +1 -0
  2. package/dist/Client.d.ts +2 -1
  3. package/dist/Client.js +2 -1
  4. package/dist/api/DeferredJobsApiClient.cjs +0 -1
  5. package/dist/api/DeferredJobsApiClient.js +0 -1
  6. package/dist/api/constants.cjs +2 -3
  7. package/dist/api/constants.js +1 -1
  8. package/dist/endpoints/Accounts/index.cjs +2 -0
  9. package/dist/endpoints/Billing/index.cjs +2 -0
  10. package/dist/endpoints/Billing/types.cjs +3 -5
  11. package/dist/endpoints/CampaignRecipients/index.cjs +2 -0
  12. package/dist/endpoints/Campaigns/index.cjs +2 -0
  13. package/dist/endpoints/Contacts/index.cjs +2 -0
  14. package/dist/endpoints/Contacts/types.d.ts +5 -0
  15. package/dist/endpoints/ContactsExports/index.cjs +2 -0
  16. package/dist/endpoints/Coverage/index.cjs +2 -0
  17. package/dist/endpoints/Jobs/index.cjs +2 -0
  18. package/dist/endpoints/Licenses/index.cjs +1 -0
  19. package/dist/endpoints/NewsroomCategories/index.cjs +2 -0
  20. package/dist/endpoints/NewsroomContacts/index.cjs +2 -0
  21. package/dist/endpoints/NewsroomDomains/index.cjs +2 -0
  22. package/dist/endpoints/NewsroomGalleries/index.cjs +2 -0
  23. package/dist/endpoints/NewsroomHub/index.cjs +2 -0
  24. package/dist/endpoints/NewsroomLanguages/index.cjs +2 -0
  25. package/dist/endpoints/NewsroomPrivacyRequests/index.cjs +2 -0
  26. package/dist/endpoints/NewsroomSubscriptions/Client.cjs +4 -3
  27. package/dist/endpoints/NewsroomSubscriptions/Client.d.ts +3 -3
  28. package/dist/endpoints/NewsroomSubscriptions/Client.js +4 -3
  29. package/dist/endpoints/NewsroomSubscriptions/index.cjs +2 -0
  30. package/dist/endpoints/NewsroomThemes/index.cjs +1 -0
  31. package/dist/endpoints/NewsroomWebhooks/index.cjs +2 -0
  32. package/dist/endpoints/Newsrooms/index.cjs +2 -0
  33. package/dist/endpoints/NotificationSubscriptions/index.cjs +2 -0
  34. package/dist/endpoints/PricingTables/index.cjs +2 -0
  35. package/dist/endpoints/PricingTables/types.cjs +5 -9
  36. package/dist/endpoints/SenderAddresses/index.cjs +2 -0
  37. package/dist/endpoints/Snippets/index.cjs +2 -0
  38. package/dist/endpoints/Stories/Client.cjs +23 -4
  39. package/dist/endpoints/Stories/Client.js +22 -7
  40. package/dist/endpoints/Stories/index.cjs +3 -0
  41. package/dist/endpoints/Stories/scopes.cjs +2 -3
  42. package/dist/endpoints/Stories/types.cjs +14 -4
  43. package/dist/endpoints/Stories/types.js +13 -3
  44. package/dist/endpoints/Subscriptions/index.cjs +2 -0
  45. package/dist/endpoints/Subscriptions/types.cjs +1 -2
  46. package/dist/endpoints/index.cjs +3 -3
  47. package/dist/http/constants.cjs +3 -6
  48. package/dist/http/index.cjs +8 -8
  49. package/dist/http/types.cjs +2 -4
  50. package/dist/index.cjs +7 -4
  51. package/dist/routing.cjs +2 -3
  52. package/dist/types/BillingCycle.cjs +1 -2
  53. package/dist/types/Campaign.cjs +1 -2
  54. package/dist/types/Category.cjs +6 -4
  55. package/dist/types/Category.d.ts +15 -7
  56. package/dist/types/Category.js +4 -1
  57. package/dist/types/Contact.cjs +1 -2
  58. package/dist/types/ContactDuplicateSuggestion.cjs +2 -2
  59. package/dist/types/ContactsExport.cjs +1 -2
  60. package/dist/types/ContactsScope.cjs +1 -2
  61. package/dist/types/CoverageEntry.cjs +1 -2
  62. package/dist/types/Culture.cjs +7 -2
  63. package/dist/types/Culture.js +6 -0
  64. package/dist/types/Currency.cjs +1 -2
  65. package/dist/types/EmailRecipient.cjs +1 -2
  66. package/dist/types/EmailSubscription.d.ts +5 -1
  67. package/dist/types/JobState.cjs +1 -2
  68. package/dist/types/License.cjs +1 -2
  69. package/dist/types/Newsroom.cjs +4 -2
  70. package/dist/types/Newsroom.js +3 -0
  71. package/dist/types/NewsroomDomain.cjs +1 -2
  72. package/dist/types/NewsroomGallery.cjs +1 -2
  73. package/dist/types/NewsroomTheme.cjs +3 -5
  74. package/dist/types/NewsroomTheme.js +1 -1
  75. package/dist/types/NewsroomWebhook.cjs +1 -2
  76. package/dist/types/NotificationSubscription.cjs +1 -2
  77. package/dist/types/Permissions.cjs +1 -2
  78. package/dist/types/Plan.cjs +3 -4
  79. package/dist/types/PrivacyRequest.cjs +1 -2
  80. package/dist/types/SenderAddress.cjs +1 -2
  81. package/dist/types/SenderDomain.cjs +1 -2
  82. package/dist/types/SortOrder.cjs +1 -2
  83. package/dist/types/Story.cjs +17 -6
  84. package/dist/types/Story.js +16 -4
  85. package/dist/types/User.cjs +1 -2
  86. package/dist/types/common/Notification.cjs +1 -2
  87. package/dist/types/common/OEmbedInfo.cjs +1 -2
  88. package/dist/types/common/Pagination.cjs +2 -2
  89. package/dist/types/common/Query.cjs +1 -2
  90. package/dist/types/common/index.cjs +6 -0
  91. package/dist/types/index.cjs +37 -0
  92. package/package.json +1 -1
@@ -4,8 +4,7 @@ Object.defineProperty(exports, "__esModule", {
4
4
  value: true
5
5
  });
6
6
  exports.License = void 0;
7
- let License;
8
- exports.License = License;
7
+ let License = exports.License = void 0;
9
8
  (function (_License) {
10
9
  let Type;
11
10
  (function (Type) {
@@ -4,8 +4,7 @@ Object.defineProperty(exports, "__esModule", {
4
4
  value: true
5
5
  });
6
6
  exports.Newsroom = void 0;
7
- let Newsroom;
8
- exports.Newsroom = Newsroom;
7
+ let Newsroom = exports.Newsroom = void 0;
9
8
  (function (_Newsroom) {
10
9
  let Status;
11
10
  (function (Status) {
@@ -34,6 +33,9 @@ exports.Newsroom = Newsroom;
34
33
  EmailLogoAlignment["RIGHT"] = "right";
35
34
  })(EmailLogoAlignment || (EmailLogoAlignment = {}));
36
35
  _Newsroom.EmailLogoAlignment = EmailLogoAlignment;
36
+ /*
37
+ * Status checks
38
+ */
37
39
  function isActive(arg) {
38
40
  if (typeof arg === 'object' && arg !== null) {
39
41
  return isActive(arg.status);
@@ -27,6 +27,9 @@ export let Newsroom;
27
27
  EmailLogoAlignment["RIGHT"] = "right";
28
28
  })(EmailLogoAlignment || (EmailLogoAlignment = {}));
29
29
  _Newsroom.EmailLogoAlignment = EmailLogoAlignment;
30
+ /*
31
+ * Status checks
32
+ */
30
33
  function isActive(arg) {
31
34
  if (typeof arg === 'object' && arg !== null) {
32
35
  return isActive(arg.status);
@@ -4,8 +4,7 @@ Object.defineProperty(exports, "__esModule", {
4
4
  value: true
5
5
  });
6
6
  exports.NewsroomDomain = void 0;
7
- let NewsroomDomain;
8
- exports.NewsroomDomain = NewsroomDomain;
7
+ let NewsroomDomain = exports.NewsroomDomain = void 0;
9
8
  (function (_NewsroomDomain) {
10
9
  let Type;
11
10
  (function (Type) {
@@ -4,8 +4,7 @@ Object.defineProperty(exports, "__esModule", {
4
4
  value: true
5
5
  });
6
6
  exports.NewsroomGallery = void 0;
7
- let NewsroomGallery;
8
- exports.NewsroomGallery = NewsroomGallery;
7
+ let NewsroomGallery = exports.NewsroomGallery = void 0;
9
8
  (function (_NewsroomGallery) {
10
9
  let Status;
11
10
  (function (Status) {
@@ -4,8 +4,7 @@ Object.defineProperty(exports, "__esModule", {
4
4
  value: true
5
5
  });
6
6
  exports.NewsroomThemePreset = exports.NewsroomTheme = void 0;
7
- let NewsroomTheme;
8
- exports.NewsroomTheme = NewsroomTheme;
7
+ let NewsroomTheme = exports.NewsroomTheme = void 0;
9
8
  (function (_NewsroomTheme) {
10
9
  let Status;
11
10
  (function (Status) {
@@ -13,7 +12,7 @@ exports.NewsroomTheme = NewsroomTheme;
13
12
  Status["STABLE"] = "stable";
14
13
  })(Status || (Status = {}));
15
14
  _NewsroomTheme.Status = Status;
16
- let Feature;
15
+ let Feature; // DEV-11475
17
16
  (function (Feature) {
18
17
  Feature["CATEGORIES"] = "categories";
19
18
  Feature["SEARCH"] = "search";
@@ -37,6 +36,5 @@ exports.NewsroomTheme = NewsroomTheme;
37
36
  }
38
37
  _NewsroomTheme.isFeatureSupported = isFeatureSupported;
39
38
  })(NewsroomTheme || (exports.NewsroomTheme = NewsroomTheme = {}));
40
- let NewsroomThemePreset;
41
- exports.NewsroomThemePreset = NewsroomThemePreset;
39
+ let NewsroomThemePreset = exports.NewsroomThemePreset = void 0;
42
40
  (function (_NewsroomThemePreset) {})(NewsroomThemePreset || (exports.NewsroomThemePreset = NewsroomThemePreset = {}));
@@ -6,7 +6,7 @@ export let NewsroomTheme;
6
6
  Status["STABLE"] = "stable";
7
7
  })(Status || (Status = {}));
8
8
  _NewsroomTheme.Status = Status;
9
- let Feature;
9
+ let Feature; // DEV-11475
10
10
  (function (Feature) {
11
11
  Feature["CATEGORIES"] = "categories";
12
12
  Feature["SEARCH"] = "search";
@@ -4,8 +4,7 @@ Object.defineProperty(exports, "__esModule", {
4
4
  value: true
5
5
  });
6
6
  exports.NewsroomWebhook = void 0;
7
- let NewsroomWebhook;
8
- exports.NewsroomWebhook = NewsroomWebhook;
7
+ let NewsroomWebhook = exports.NewsroomWebhook = void 0;
9
8
  (function (_NewsroomWebhook) {
10
9
  let Event;
11
10
  (function (Event) {
@@ -4,8 +4,7 @@ Object.defineProperty(exports, "__esModule", {
4
4
  value: true
5
5
  });
6
6
  exports.NotificationSubscription = void 0;
7
- let NotificationSubscription;
8
- exports.NotificationSubscription = NotificationSubscription;
7
+ let NotificationSubscription = exports.NotificationSubscription = void 0;
9
8
  (function (_NotificationSubscription) {
10
9
  let Area;
11
10
  (function (Area) {
@@ -4,8 +4,7 @@ Object.defineProperty(exports, "__esModule", {
4
4
  value: true
5
5
  });
6
6
  exports.Permission = void 0;
7
- let Permission;
8
- exports.Permission = Permission;
7
+ let Permission = exports.Permission = void 0;
9
8
  (function (Permission) {
10
9
  Permission["CREATE_NEWSROOM"] = "create_newsroom";
11
10
  Permission["EXPORT_CONTACTS"] = "export_contacts";
@@ -4,15 +4,14 @@ Object.defineProperty(exports, "__esModule", {
4
4
  value: true
5
5
  });
6
6
  exports.PlanLevel = exports.ChangeType = void 0;
7
- let ChangeType; /** @deprecated Will be dropped in future */
8
- exports.ChangeType = ChangeType;
7
+ let ChangeType = exports.ChangeType = void 0;
8
+ /** @deprecated Will be dropped in future */
9
9
  (function (ChangeType) {
10
10
  ChangeType["ACTIVATION"] = "activation";
11
11
  ChangeType["UPGRADE"] = "upgrade";
12
12
  ChangeType["DOWNGRADE"] = "downgrade";
13
13
  })(ChangeType || (exports.ChangeType = ChangeType = {}));
14
- let PlanLevel;
15
- exports.PlanLevel = PlanLevel;
14
+ let PlanLevel = exports.PlanLevel = void 0;
16
15
  (function (PlanLevel) {
17
16
  PlanLevel["BASIC"] = "basic";
18
17
  PlanLevel["CORE"] = "core";
@@ -4,8 +4,7 @@ Object.defineProperty(exports, "__esModule", {
4
4
  value: true
5
5
  });
6
6
  exports.PrivacyRequest = void 0;
7
- let PrivacyRequest;
8
- exports.PrivacyRequest = PrivacyRequest;
7
+ let PrivacyRequest = exports.PrivacyRequest = void 0;
9
8
  (function (_PrivacyRequest) {
10
9
  let Type;
11
10
  (function (Type) {
@@ -4,8 +4,7 @@ Object.defineProperty(exports, "__esModule", {
4
4
  value: true
5
5
  });
6
6
  exports.SenderAddress = void 0;
7
- let SenderAddress;
8
- exports.SenderAddress = SenderAddress;
7
+ let SenderAddress = exports.SenderAddress = void 0;
9
8
  (function (_SenderAddress) {
10
9
  let Type;
11
10
  (function (Type) {
@@ -4,8 +4,7 @@ Object.defineProperty(exports, "__esModule", {
4
4
  value: true
5
5
  });
6
6
  exports.SenderDomain = void 0;
7
- let SenderDomain;
8
- exports.SenderDomain = SenderDomain;
7
+ let SenderDomain = exports.SenderDomain = void 0;
9
8
  (function (_SenderDomain) {
10
9
  let VerificationFlowVersion;
11
10
  (function (VerificationFlowVersion) {
@@ -4,8 +4,7 @@ Object.defineProperty(exports, "__esModule", {
4
4
  value: true
5
5
  });
6
6
  exports.SortOrder = void 0;
7
- let SortOrder;
8
- exports.SortOrder = SortOrder;
7
+ let SortOrder = exports.SortOrder = void 0;
9
8
  (function (_SortOrder) {
10
9
  let Direction;
11
10
  (function (Direction) {
@@ -5,8 +5,7 @@ Object.defineProperty(exports, "__esModule", {
5
5
  });
6
6
  exports.Story = void 0;
7
7
  var _Newsroom = require("./Newsroom.cjs");
8
- let Story;
9
- exports.Story = Story;
8
+ let Story = exports.Story = void 0;
10
9
  (function (_Story) {
11
10
  let FormatVersion;
12
11
  (function (FormatVersion) {
@@ -28,10 +27,12 @@ exports.Story = Story;
28
27
  /**
29
28
  * @deprecated Please use `Status` instead.
30
29
  * @see Status
31
- */var LifecycleStatus = Status; /**
32
- * @deprecated Please use `Status` instead.
33
- * @see Status
34
- */
30
+ */
31
+ var LifecycleStatus = Status;
32
+ /**
33
+ * @deprecated Please use `Status` instead.
34
+ * @see Status
35
+ */
35
36
  let PublicationStatus;
36
37
  (function (PublicationStatus) {
37
38
  PublicationStatus["NEW"] = "new";
@@ -47,6 +48,10 @@ exports.Story = Story;
47
48
  Visibility["CONFIDENTIAL"] = "confidential";
48
49
  })(Visibility || (Visibility = {}));
49
50
  _Story.Visibility = Visibility;
51
+ /*
52
+ * Newsroom status checks
53
+ */
54
+
50
55
  function isActiveNewsroom(story) {
51
56
  return _Newsroom.Newsroom.isActive(story.newsroom);
52
57
  }
@@ -59,6 +64,9 @@ exports.Story = Story;
59
64
  return _Newsroom.Newsroom.isArchived(story.newsroom);
60
65
  }
61
66
  _Story.isArchivedNewsroom = isArchivedNewsroom;
67
+ /*
68
+ * Lifecycle status checks
69
+ */
62
70
  function isUninitialized(arg) {
63
71
  if (typeof arg === 'object' && arg !== null) {
64
72
  return isUninitialized(arg.status);
@@ -101,6 +109,9 @@ exports.Story = Story;
101
109
  return arg === Status.PUBLISHED;
102
110
  }
103
111
  _Story.isPublished = isPublished;
112
+ /*
113
+ * Format version checks
114
+ */
104
115
  function isLegacyHtmlFormat(arg) {
105
116
  if (typeof arg === 'object' && arg !== null) {
106
117
  return isLegacyHtmlFormat(arg.format_version);
@@ -21,10 +21,12 @@ export let Story;
21
21
  /**
22
22
  * @deprecated Please use `Status` instead.
23
23
  * @see Status
24
- */var LifecycleStatus = Status; /**
25
- * @deprecated Please use `Status` instead.
26
- * @see Status
27
- */
24
+ */
25
+ var LifecycleStatus = Status;
26
+ /**
27
+ * @deprecated Please use `Status` instead.
28
+ * @see Status
29
+ */
28
30
  let PublicationStatus;
29
31
  (function (PublicationStatus) {
30
32
  PublicationStatus["NEW"] = "new";
@@ -40,6 +42,10 @@ export let Story;
40
42
  Visibility["CONFIDENTIAL"] = "confidential";
41
43
  })(Visibility || (Visibility = {}));
42
44
  _Story.Visibility = Visibility;
45
+ /*
46
+ * Newsroom status checks
47
+ */
48
+
43
49
  function isActiveNewsroom(story) {
44
50
  return Newsroom.isActive(story.newsroom);
45
51
  }
@@ -52,6 +58,9 @@ export let Story;
52
58
  return Newsroom.isArchived(story.newsroom);
53
59
  }
54
60
  _Story.isArchivedNewsroom = isArchivedNewsroom;
61
+ /*
62
+ * Lifecycle status checks
63
+ */
55
64
  function isUninitialized(arg) {
56
65
  if (typeof arg === 'object' && arg !== null) {
57
66
  return isUninitialized(arg.status);
@@ -94,6 +103,9 @@ export let Story;
94
103
  return arg === Status.PUBLISHED;
95
104
  }
96
105
  _Story.isPublished = isPublished;
106
+ /*
107
+ * Format version checks
108
+ */
97
109
  function isLegacyHtmlFormat(arg) {
98
110
  if (typeof arg === 'object' && arg !== null) {
99
111
  return isLegacyHtmlFormat(arg.format_version);
@@ -4,8 +4,7 @@ Object.defineProperty(exports, "__esModule", {
4
4
  value: true
5
5
  });
6
6
  exports.User = void 0;
7
- let User;
8
- exports.User = User;
7
+ let User = exports.User = void 0;
9
8
  (function (_User) {
10
9
  let SignInFlow;
11
10
  (function (SignInFlow) {
@@ -4,8 +4,7 @@ Object.defineProperty(exports, "__esModule", {
4
4
  value: true
5
5
  });
6
6
  exports.Notification = void 0;
7
- let Notification;
8
- exports.Notification = Notification;
7
+ let Notification = exports.Notification = void 0;
9
8
  (function (_Notification) {
10
9
  let Style;
11
10
  (function (Style) {
@@ -4,8 +4,7 @@ Object.defineProperty(exports, "__esModule", {
4
4
  value: true
5
5
  });
6
6
  exports.OEmbedInfo = void 0;
7
- let OEmbedInfo;
8
- exports.OEmbedInfo = OEmbedInfo;
7
+ let OEmbedInfo = exports.OEmbedInfo = void 0;
9
8
  (function (_OEmbedInfo) {
10
9
  let Type;
11
10
  (function (Type) {
@@ -6,8 +6,8 @@ Object.defineProperty(exports, "__esModule", {
6
6
  exports.SelectionMode = void 0;
7
7
  /**
8
8
  * @see https://api.prezly.com/v2/common/schema.json#/definitions/Pagination
9
- */let SelectionMode;
10
- exports.SelectionMode = SelectionMode;
9
+ */
10
+ let SelectionMode = exports.SelectionMode = void 0;
11
11
  (function (SelectionMode) {
12
12
  SelectionMode["ALL"] = "all";
13
13
  SelectionMode["IN"] = "in";
@@ -8,8 +8,7 @@ exports.Query = void 0;
8
8
  /**
9
9
  * @see https://developers.prezly.com/docs/api/docs/06-prezly-query-language.md
10
10
  */
11
- let Query;
12
- exports.Query = Query;
11
+ let Query = exports.Query = void 0;
13
12
  (function (_Query) {
14
13
  function stringify(query) {
15
14
  if (!query) {
@@ -6,6 +6,7 @@ Object.defineProperty(exports, "__esModule", {
6
6
  var _Notification = require("./Notification.cjs");
7
7
  Object.keys(_Notification).forEach(function (key) {
8
8
  if (key === "default" || key === "__esModule") return;
9
+ if (key in exports && exports[key] === _Notification[key]) return;
9
10
  Object.defineProperty(exports, key, {
10
11
  enumerable: true,
11
12
  get: function () {
@@ -16,6 +17,7 @@ Object.keys(_Notification).forEach(function (key) {
16
17
  var _OEmbedInfo = require("./OEmbedInfo.cjs");
17
18
  Object.keys(_OEmbedInfo).forEach(function (key) {
18
19
  if (key === "default" || key === "__esModule") return;
20
+ if (key in exports && exports[key] === _OEmbedInfo[key]) return;
19
21
  Object.defineProperty(exports, key, {
20
22
  enumerable: true,
21
23
  get: function () {
@@ -26,6 +28,7 @@ Object.keys(_OEmbedInfo).forEach(function (key) {
26
28
  var _Pagination = require("./Pagination.cjs");
27
29
  Object.keys(_Pagination).forEach(function (key) {
28
30
  if (key === "default" || key === "__esModule") return;
31
+ if (key in exports && exports[key] === _Pagination[key]) return;
29
32
  Object.defineProperty(exports, key, {
30
33
  enumerable: true,
31
34
  get: function () {
@@ -36,6 +39,7 @@ Object.keys(_Pagination).forEach(function (key) {
36
39
  var _Query = require("./Query.cjs");
37
40
  Object.keys(_Query).forEach(function (key) {
38
41
  if (key === "default" || key === "__esModule") return;
42
+ if (key in exports && exports[key] === _Query[key]) return;
39
43
  Object.defineProperty(exports, key, {
40
44
  enumerable: true,
41
45
  get: function () {
@@ -46,6 +50,7 @@ Object.keys(_Query).forEach(function (key) {
46
50
  var _Utm = require("./Utm.cjs");
47
51
  Object.keys(_Utm).forEach(function (key) {
48
52
  if (key === "default" || key === "__esModule") return;
53
+ if (key in exports && exports[key] === _Utm[key]) return;
49
54
  Object.defineProperty(exports, key, {
50
55
  enumerable: true,
51
56
  get: function () {
@@ -56,6 +61,7 @@ Object.keys(_Utm).forEach(function (key) {
56
61
  var _Warning = require("./Warning.cjs");
57
62
  Object.keys(_Warning).forEach(function (key) {
58
63
  if (key === "default" || key === "__esModule") return;
64
+ if (key in exports && exports[key] === _Warning[key]) return;
59
65
  Object.defineProperty(exports, key, {
60
66
  enumerable: true,
61
67
  get: function () {