@prezly/sdk 26.0.0 → 26.2.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 (111) hide show
  1. package/dist/api/ApiClient.d.ts +4 -4
  2. package/dist/api/DeferredJobsApiClient.d.ts +4 -4
  3. package/dist/api/constants.cjs +1 -1
  4. package/dist/api/constants.js +1 -1
  5. package/dist/endpoints/Accounts/Client.d.ts +1 -1
  6. package/dist/endpoints/Billing/types.cjs +6 -6
  7. package/dist/endpoints/Billing/types.js +6 -6
  8. package/dist/endpoints/CampaignRecipients/Client.d.ts +1 -1
  9. package/dist/endpoints/Campaigns/Client.d.ts +8 -8
  10. package/dist/endpoints/ContactTagGroups/types.cjs +3 -3
  11. package/dist/endpoints/ContactTagGroups/types.js +3 -3
  12. package/dist/endpoints/ContactTags/Client.d.ts +4 -4
  13. package/dist/endpoints/Contacts/Client.d.ts +6 -6
  14. package/dist/endpoints/ContactsExports/Client.d.ts +2 -2
  15. package/dist/endpoints/CoverageIntegrations/Client.d.ts +3 -3
  16. package/dist/endpoints/CoverageIntegrations/types.cjs +1 -2
  17. package/dist/endpoints/CoverageIntegrations/types.js +1 -2
  18. package/dist/endpoints/NewsroomCategories/Client.d.ts +3 -3
  19. package/dist/endpoints/NewsroomGalleries/Client.d.ts +1 -1
  20. package/dist/endpoints/NewsroomLanguages/Client.d.ts +10 -10
  21. package/dist/endpoints/NewsroomPrivacyRequests/Client.d.ts +2 -2
  22. package/dist/endpoints/NewsroomThemes/Client.cjs +11 -1
  23. package/dist/endpoints/NewsroomThemes/Client.d.ts +2 -1
  24. package/dist/endpoints/NewsroomThemes/Client.js +11 -1
  25. package/dist/endpoints/NewsroomWebhooks/Client.d.ts +3 -3
  26. package/dist/endpoints/Newsrooms/Client.d.ts +11 -11
  27. package/dist/endpoints/PricingTables/types.cjs +12 -12
  28. package/dist/endpoints/PricingTables/types.js +12 -12
  29. package/dist/endpoints/SenderAddresses/Client.d.ts +3 -3
  30. package/dist/endpoints/Stories/Client.d.ts +102 -102
  31. package/dist/endpoints/Stories/types.cjs +4 -5
  32. package/dist/endpoints/Stories/types.d.ts +34 -2
  33. package/dist/endpoints/Stories/types.js +4 -5
  34. package/dist/endpoints/Subscriptions/Client.d.ts +2 -2
  35. package/dist/endpoints/Subscriptions/types.cjs +3 -3
  36. package/dist/endpoints/Subscriptions/types.js +3 -3
  37. package/dist/endpoints/index.cjs +1 -2
  38. package/dist/http/lib.cjs +1 -1
  39. package/dist/http/types.cjs +6 -6
  40. package/dist/http/types.js +6 -6
  41. package/dist/types/BillingCycle.cjs +3 -3
  42. package/dist/types/BillingCycle.js +3 -3
  43. package/dist/types/Campaign.cjs +18 -18
  44. package/dist/types/Campaign.js +18 -18
  45. package/dist/types/Category.cjs +0 -1
  46. package/dist/types/Category.js +0 -1
  47. package/dist/types/Contact.cjs +18 -18
  48. package/dist/types/Contact.js +18 -18
  49. package/dist/types/ContactDuplicateSuggestion.cjs +3 -3
  50. package/dist/types/ContactDuplicateSuggestion.js +3 -4
  51. package/dist/types/ContactTag.cjs +1 -2
  52. package/dist/types/ContactTag.js +1 -2
  53. package/dist/types/ContactsExport.cjs +3 -3
  54. package/dist/types/ContactsExport.js +3 -3
  55. package/dist/types/ContactsScope.cjs +3 -3
  56. package/dist/types/ContactsScope.js +3 -3
  57. package/dist/types/CoverageEntry.cjs +9 -9
  58. package/dist/types/CoverageEntry.js +9 -9
  59. package/dist/types/CoverageIntegration.cjs +3 -3
  60. package/dist/types/CoverageIntegration.js +3 -3
  61. package/dist/types/CoverageIntegrationRun.cjs +3 -3
  62. package/dist/types/CoverageIntegrationRun.js +3 -3
  63. package/dist/types/Culture.cjs +3 -3
  64. package/dist/types/Culture.js +3 -3
  65. package/dist/types/Currency.cjs +3 -3
  66. package/dist/types/Currency.js +3 -3
  67. package/dist/types/EmailRecipient.cjs +6 -6
  68. package/dist/types/EmailRecipient.js +6 -6
  69. package/dist/types/JobState.cjs +3 -3
  70. package/dist/types/JobState.js +3 -3
  71. package/dist/types/License.cjs +12 -12
  72. package/dist/types/License.js +12 -12
  73. package/dist/types/Newsroom.cjs +20 -12
  74. package/dist/types/Newsroom.js +20 -12
  75. package/dist/types/NewsroomDomain.cjs +6 -6
  76. package/dist/types/NewsroomDomain.js +6 -6
  77. package/dist/types/NewsroomGallery.cjs +6 -6
  78. package/dist/types/NewsroomGallery.js +6 -6
  79. package/dist/types/NewsroomTheme.cjs +10 -9
  80. package/dist/types/NewsroomTheme.js +10 -9
  81. package/dist/types/NewsroomWebhook.cjs +3 -3
  82. package/dist/types/NewsroomWebhook.js +3 -3
  83. package/dist/types/NotificationSubscription.cjs +3 -3
  84. package/dist/types/NotificationSubscription.js +3 -3
  85. package/dist/types/Permissions.cjs +3 -3
  86. package/dist/types/Permissions.js +3 -3
  87. package/dist/types/Plan.cjs +10 -10
  88. package/dist/types/Plan.js +11 -11
  89. package/dist/types/Price.cjs +6 -6
  90. package/dist/types/Price.js +6 -6
  91. package/dist/types/PrivacyRequest.cjs +6 -6
  92. package/dist/types/PrivacyRequest.js +6 -6
  93. package/dist/types/SenderAddress.cjs +3 -3
  94. package/dist/types/SenderAddress.js +3 -3
  95. package/dist/types/SenderDomain.cjs +3 -3
  96. package/dist/types/SenderDomain.js +3 -3
  97. package/dist/types/SortOrder.cjs +3 -3
  98. package/dist/types/SortOrder.js +3 -3
  99. package/dist/types/Story.cjs +12 -12
  100. package/dist/types/Story.d.ts +4 -0
  101. package/dist/types/Story.js +12 -12
  102. package/dist/types/User.cjs +6 -6
  103. package/dist/types/User.js +6 -6
  104. package/dist/types/common/Notification.cjs +3 -3
  105. package/dist/types/common/Notification.js +3 -3
  106. package/dist/types/common/OEmbedInfo.cjs +3 -3
  107. package/dist/types/common/OEmbedInfo.js +3 -3
  108. package/dist/types/common/Pagination.cjs +3 -3
  109. package/dist/types/common/Pagination.js +3 -3
  110. package/dist/types/common/Query.js +0 -1
  111. package/package.json +5 -5
@@ -15,110 +15,110 @@ type Exactly<Concrete, Abstract> = Concrete & Record<Exclude<keyof Concrete, key
15
15
  type InferExtraFields<T> = T extends Required<IncludeOptions<infer I>> ? Pick<Story.ExtraFields, I> : unknown;
16
16
  export type Client = ReturnType<typeof createClient>;
17
17
  export declare function createClient(api: DeferredJobsApiClient): {
18
- list: <Options extends ListOptions<keyof Story.ExtraFields>>(options?: Exactly<Options, ListOptions<keyof Story.ExtraFields>> | undefined) => Promise<ListResponse<Story & InferExtraFields<Options>>>;
19
- search: <Options_1 extends SearchOptions<keyof Story.ExtraFields>>(options?: Exactly<Options_1, SearchOptions<keyof Story.ExtraFields>> | undefined) => Promise<ListResponse<Story & InferExtraFields<Options_1>>>;
18
+ list: <Options extends ListOptions>(options?: Exactly<Options, ListOptions>) => Promise<ListResponse<Story & InferExtraFields<Options>>>;
19
+ search: <Options extends SearchOptions>(options?: Exactly<Options, SearchOptions>) => Promise<ListResponse<Story & InferExtraFields<Options>>>;
20
20
  get: {
21
- <Options_2 extends IncludeOptions<keyof Story.ExtraFields> & {
22
- formats?: Formats | undefined;
23
- }>(id: Story['uuid'], options?: Exactly<Options_2, IncludeOptions<keyof Story.ExtraFields> & {
24
- formats?: Formats | undefined;
25
- }> | undefined): Promise<ExtendedStory & InferExtraFields<Options_2>>;
26
- <Options_3 extends IncludeOptions<keyof Story.ExtraFields> & {
27
- formats?: Formats | undefined;
28
- }>(ids: Story['uuid'][], options?: Exactly<Options_3, IncludeOptions<keyof Story.ExtraFields> & {
29
- formats?: Formats | undefined;
30
- }> | undefined): Promise<(ExtendedStory & InferExtraFields<Options_3>)[]>;
31
- <Options_4 extends IncludeOptions<keyof Story.ExtraFields> & {
32
- formats?: Formats | undefined;
33
- }>(id: Story['id'] | Story['uuid'], options?: Exactly<Options_4, IncludeOptions<keyof Story.ExtraFields> & {
34
- formats?: Formats | undefined;
35
- }> | undefined): Promise<ExtendedStory & InferExtraFields<Options_4>>;
36
- <Options_5 extends IncludeOptions<keyof Story.ExtraFields> & {
37
- formats?: Formats | undefined;
38
- }>(ids: Story['id'][], options?: Exactly<Options_5, IncludeOptions<keyof Story.ExtraFields> & {
39
- formats?: Formats | undefined;
40
- }> | undefined): Promise<(ExtendedStory & InferExtraFields<Options_5>)[]>;
21
+ <Options extends IncludeOptions & {
22
+ formats?: Formats;
23
+ }>(id: Story["uuid"], options?: Exactly<Options, IncludeOptions & {
24
+ formats?: Formats;
25
+ }>): Promise<ExtendedStory & InferExtraFields<Options>>;
26
+ <Options extends IncludeOptions & {
27
+ formats?: Formats;
28
+ }>(ids: Story["uuid"][], options?: Exactly<Options, IncludeOptions & {
29
+ formats?: Formats;
30
+ }>): Promise<(ExtendedStory & InferExtraFields<Options>)[]>;
31
+ <Options extends IncludeOptions & {
32
+ formats?: Formats;
33
+ }>(id: Story["id"] | Story["uuid"], options?: Exactly<Options, IncludeOptions & {
34
+ formats?: Formats;
35
+ }>): Promise<ExtendedStory & InferExtraFields<Options>>;
36
+ <Options extends IncludeOptions & {
37
+ formats?: Formats;
38
+ }>(ids: Story["id"][], options?: Exactly<Options, IncludeOptions & {
39
+ formats?: Formats;
40
+ }>): Promise<(ExtendedStory & InferExtraFields<Options>)[]>;
41
41
  };
42
- getBySlug: <Options_6 extends IncludeOptions<keyof Story.ExtraFields> & {
43
- formats?: Formats | undefined;
44
- query?: Query | undefined;
45
- }>(slug: Story['slug'], options?: Exactly<Options_6, IncludeOptions<keyof Story.ExtraFields> & {
46
- formats?: Formats | undefined;
47
- query?: Query | undefined;
48
- }> | undefined) => Promise<ExtendedStory & InferExtraFields<Options_6>>;
49
- create: <Options_7 extends IncludeOptions<keyof Story.ExtraFields> & {
50
- formats?: Formats | undefined;
51
- force?: boolean | undefined;
52
- }>(payload: CreateRequest, options?: Exactly<Options_7, IncludeOptions<keyof Story.ExtraFields> & {
53
- formats?: Formats | undefined;
54
- force?: boolean | undefined;
55
- }> | undefined) => Promise<ExtendedStory & InferExtraFields<Options_7>>;
56
- duplicate: <Options_8 extends IncludeOptions<keyof Story.ExtraFields> & {
57
- formats?: Formats | undefined;
58
- }>(id: StoryId, options?: Exactly<Options_8, IncludeOptions<keyof Story.ExtraFields> & {
59
- formats?: Formats | undefined;
60
- }> | undefined) => Promise<ExtendedStory & InferExtraFields<Options_8>>;
61
- translate: <Options_9 extends IncludeOptions<keyof Story.ExtraFields> & {
62
- formats?: Formats | undefined;
63
- }>(id: StoryId, payload?: TranslateRequest, options?: Exactly<Options_9, IncludeOptions<keyof Story.ExtraFields> & {
64
- formats?: Formats | undefined;
65
- }> | undefined) => Promise<ExtendedStory & InferExtraFields<Options_9>>;
66
- move: <Options_10 extends IncludeOptions<keyof Story.ExtraFields> & {
67
- formats?: Formats | undefined;
68
- force?: boolean | undefined;
69
- }>(id: StoryId, payload: MoveRequest, options?: Exactly<Options_10, IncludeOptions<keyof Story.ExtraFields> & {
70
- formats?: Formats | undefined;
71
- force?: boolean | undefined;
72
- }> | undefined) => Promise<ChangeNewsroomUnsafeResponse | ChangeNewsroomSuccessResponse<ExtendedStory & InferExtraFields<Options_10>>>;
73
- update: <Options_11 extends IncludeOptions<keyof Story.ExtraFields> & {
74
- formats?: Formats | undefined;
75
- force?: boolean | undefined;
76
- }>(id: StoryId, payload: UpdateRequest, options?: Exactly<Options_11, IncludeOptions<keyof Story.ExtraFields> & {
77
- formats?: Formats | undefined;
78
- force?: boolean | undefined;
79
- }> | undefined) => Promise<ExtendedStory & InferExtraFields<Options_11>>;
80
- autosave: <Options_12 extends IncludeOptions<keyof Story.ExtraFields> & {
81
- formats?: Formats | undefined;
82
- }>(id: StoryId, payload: AutosaveRequest, options?: Exactly<Options_12, IncludeOptions<keyof Story.ExtraFields> & {
83
- formats?: Formats | undefined;
84
- }> | undefined) => Promise<ExtendedStory & InferExtraFields<Options_12>>;
85
- revert: <Options_13 extends IncludeOptions<keyof Story.ExtraFields> & {
86
- formats?: Formats | undefined;
87
- }>(id: StoryId, payload?: RevertRequest, options?: Exactly<Options_13, IncludeOptions<keyof Story.ExtraFields> & {
88
- formats?: Formats | undefined;
89
- }> | undefined) => Promise<ExtendedStory & InferExtraFields<Options_13>>;
90
- publish: <Options_14 extends IncludeOptions<keyof Story.ExtraFields> & {
91
- formats?: Formats | undefined;
92
- }>(id: StoryId, payload?: PublishRequest, options?: Exactly<Options_14, IncludeOptions<keyof Story.ExtraFields> & {
93
- formats?: Formats | undefined;
94
- }> | undefined) => Promise<ExtendedStory & InferExtraFields<Options_14>>;
95
- unpublish: <Options_15 extends IncludeOptions<keyof Story.ExtraFields> & {
96
- formats?: Formats | undefined;
97
- }>(id: StoryId, payload?: UnpublishRequest, options?: Exactly<Options_15, IncludeOptions<keyof Story.ExtraFields> & {
98
- formats?: Formats | undefined;
99
- }> | undefined) => Promise<ExtendedStory & InferExtraFields<Options_15>>;
100
- schedule: <Options_16 extends IncludeOptions<keyof Story.ExtraFields> & {
101
- formats?: Formats | undefined;
102
- }>(id: StoryId, payload?: ScheduleRequest, options?: Exactly<Options_16, IncludeOptions<keyof Story.ExtraFields> & {
103
- formats?: Formats | undefined;
104
- }> | undefined) => Promise<ExtendedStory & InferExtraFields<Options_16>>;
105
- unschedule: <Options_17 extends IncludeOptions<keyof Story.ExtraFields> & {
106
- formats?: Formats | undefined;
107
- }>(id: StoryId, payload?: UnscheduleRequest, options?: Exactly<Options_17, IncludeOptions<keyof Story.ExtraFields> & {
108
- formats?: Formats | undefined;
109
- }> | undefined) => Promise<ExtendedStory & InferExtraFields<Options_17>>;
110
- pin: <Options_18 extends IncludeOptions<keyof Story.ExtraFields> & {
111
- formats?: Formats | undefined;
112
- force?: boolean | undefined;
113
- }>(id: StoryId, options?: Exactly<Options_18, IncludeOptions<keyof Story.ExtraFields> & {
114
- formats?: Formats | undefined;
115
- force?: boolean | undefined;
116
- }> | undefined) => Promise<ExtendedStory & InferExtraFields<Options_18>>;
117
- unpin: <Options_19 extends IncludeOptions<keyof Story.ExtraFields> & {
118
- formats?: Formats | undefined;
119
- }>(id: StoryId, options?: Exactly<Options_19, IncludeOptions<keyof Story.ExtraFields> & {
120
- formats?: Formats | undefined;
121
- }> | undefined) => Promise<ExtendedStory & InferExtraFields<Options_19>>;
42
+ getBySlug: <Options extends IncludeOptions & {
43
+ formats?: Formats;
44
+ query?: Query;
45
+ }>(slug: Story["slug"], options?: Exactly<Options, IncludeOptions & {
46
+ formats?: Formats;
47
+ query?: Query;
48
+ }>) => Promise<ExtendedStory & InferExtraFields<Options>>;
49
+ create: <Options extends IncludeOptions & {
50
+ formats?: Formats;
51
+ force?: boolean;
52
+ }>(payload: CreateRequest, options?: Exactly<Options, IncludeOptions & {
53
+ formats?: Formats;
54
+ force?: boolean;
55
+ }>) => Promise<ExtendedStory & InferExtraFields<Options>>;
56
+ duplicate: <Options extends IncludeOptions & {
57
+ formats?: Formats;
58
+ }>(id: StoryId, options?: Exactly<Options, IncludeOptions & {
59
+ formats?: Formats;
60
+ }>) => Promise<ExtendedStory & InferExtraFields<Options>>;
61
+ translate: <Options extends IncludeOptions & {
62
+ formats?: Formats;
63
+ }>(id: StoryId, payload?: TranslateRequest, options?: Exactly<Options, IncludeOptions & {
64
+ formats?: Formats;
65
+ }>) => Promise<ExtendedStory & InferExtraFields<Options>>;
66
+ move: <Options extends IncludeOptions & {
67
+ formats?: Formats;
68
+ force?: boolean;
69
+ }>(id: StoryId, payload: MoveRequest, options?: Exactly<Options, IncludeOptions & {
70
+ formats?: Formats;
71
+ force?: boolean;
72
+ }>) => Promise<ChangeNewsroomSuccessResponse<ExtendedStory & InferExtraFields<Options>> | ChangeNewsroomUnsafeResponse>;
73
+ update: <Options extends IncludeOptions & {
74
+ formats?: Formats;
75
+ force?: boolean;
76
+ }>(id: StoryId, payload: UpdateRequest, options?: Exactly<Options, IncludeOptions & {
77
+ formats?: Formats;
78
+ force?: boolean;
79
+ }>) => Promise<ExtendedStory & InferExtraFields<Options>>;
80
+ autosave: <Options extends IncludeOptions & {
81
+ formats?: Formats;
82
+ }>(id: StoryId, payload: AutosaveRequest, options?: Exactly<Options, IncludeOptions & {
83
+ formats?: Formats;
84
+ }>) => Promise<ExtendedStory & InferExtraFields<Options>>;
85
+ revert: <Options extends IncludeOptions & {
86
+ formats?: Formats;
87
+ }>(id: StoryId, payload?: RevertRequest, options?: Exactly<Options, IncludeOptions & {
88
+ formats?: Formats;
89
+ }>) => Promise<ExtendedStory & InferExtraFields<Options>>;
90
+ publish: <Options extends IncludeOptions & {
91
+ formats?: Formats;
92
+ }>(id: StoryId, payload?: PublishRequest, options?: Exactly<Options, IncludeOptions & {
93
+ formats?: Formats;
94
+ }>) => Promise<ExtendedStory & InferExtraFields<Options>>;
95
+ unpublish: <Options extends IncludeOptions & {
96
+ formats?: Formats;
97
+ }>(id: StoryId, payload?: UnpublishRequest, options?: Exactly<Options, IncludeOptions & {
98
+ formats?: Formats;
99
+ }>) => Promise<ExtendedStory & InferExtraFields<Options>>;
100
+ schedule: <Options extends IncludeOptions & {
101
+ formats?: Formats;
102
+ }>(id: StoryId, payload?: ScheduleRequest, options?: Exactly<Options, IncludeOptions & {
103
+ formats?: Formats;
104
+ }>) => Promise<ExtendedStory & InferExtraFields<Options>>;
105
+ unschedule: <Options extends IncludeOptions & {
106
+ formats?: Formats;
107
+ }>(id: StoryId, payload?: UnscheduleRequest, options?: Exactly<Options, IncludeOptions & {
108
+ formats?: Formats;
109
+ }>) => Promise<ExtendedStory & InferExtraFields<Options>>;
110
+ pin: <Options extends IncludeOptions & {
111
+ formats?: Formats;
112
+ force?: boolean;
113
+ }>(id: StoryId, options?: Exactly<Options, IncludeOptions & {
114
+ formats?: Formats;
115
+ force?: boolean;
116
+ }>) => Promise<ExtendedStory & InferExtraFields<Options>>;
117
+ unpin: <Options extends IncludeOptions & {
118
+ formats?: Formats;
119
+ }>(id: StoryId, options?: Exactly<Options, IncludeOptions & {
120
+ formats?: Formats;
121
+ }>) => Promise<ExtendedStory & InferExtraFields<Options>>;
122
122
  delete: (id: StoryId) => Promise<void>;
123
123
  bulkDelete: (payload: BulkDeletePayload) => ProgressPromise<{
124
124
  records_deleted_number: number;
@@ -34,8 +34,7 @@ const EXTENDED_STORY_INCLUDED_EXTRA_FIELDS_SHAPE = {
34
34
  content: true,
35
35
  attached_gallery_content: true,
36
36
  referenced_entities: true
37
- }; // satisfies Record<keyof Omit<ExtendedStory, keyof Story>, boolean>; // TODO: Use Typescript `satisfies` operator, when it's out of beta
38
-
37
+ };
39
38
  const ALL_EXTRA_FIELDS_SHAPE = {
40
39
  thumbnail_image: true,
41
40
  header_image: true,
@@ -54,8 +53,8 @@ const ALL_EXTRA_FIELDS_SHAPE = {
54
53
  attached_contacts_content: true,
55
54
  referenced_entities: true,
56
55
  'campaigns.count': true,
57
- 'pitches.count': true
58
- }; // satisfies Record<keyof Story.OnDemandFields, boolean>; // TODO: Use Typescript `satisfies` operator, when it's out of beta
59
-
56
+ 'pitches.count': true,
57
+ 'coverage.count': true
58
+ };
60
59
  const ALL_EXTRA_FIELDS = exports.ALL_EXTRA_FIELDS = Object.keys(ALL_EXTRA_FIELDS_SHAPE);
61
60
  const EXTENDED_STORY_INCLUDED_EXTRA_FIELDS = exports.EXTENDED_STORY_INCLUDED_EXTRA_FIELDS = Object.keys(EXTENDED_STORY_INCLUDED_EXTRA_FIELDS_SHAPE);
@@ -254,6 +254,38 @@ export interface ChangeNewsroomUnsafeResponse {
254
254
  message: string;
255
255
  warnings: ChangeNewsroomWarning[];
256
256
  }
257
- export declare const ALL_EXTRA_FIELDS: (keyof Story.ExtraFields)[];
258
- export declare const EXTENDED_STORY_INCLUDED_EXTRA_FIELDS: ("content" | "preview_image" | "thumbnail_image" | "header_image" | "social_image" | "social_text" | "tag_names" | "attached_gallery_content" | "referenced_entities")[];
257
+ declare const EXTENDED_STORY_INCLUDED_EXTRA_FIELDS_SHAPE: {
258
+ thumbnail_image: true;
259
+ header_image: true;
260
+ preview_image: true;
261
+ social_image: true;
262
+ social_text: true;
263
+ tag_names: true;
264
+ content: true;
265
+ attached_gallery_content: true;
266
+ referenced_entities: true;
267
+ };
268
+ declare const ALL_EXTRA_FIELDS_SHAPE: {
269
+ thumbnail_image: true;
270
+ header_image: true;
271
+ preview_image: true;
272
+ social_image: true;
273
+ social_text: true;
274
+ tag_names: true;
275
+ content: true;
276
+ autosaved_content: true;
277
+ content_version: true;
278
+ last_modifying_user: true;
279
+ attached_gallery_content: true;
280
+ attached_videos_content: true;
281
+ attached_bookmarks_content: true;
282
+ attached_attachments_content: true;
283
+ attached_contacts_content: true;
284
+ referenced_entities: true;
285
+ 'campaigns.count': true;
286
+ 'pitches.count': true;
287
+ 'coverage.count': true;
288
+ };
289
+ export declare const ALL_EXTRA_FIELDS: (keyof typeof ALL_EXTRA_FIELDS_SHAPE)[];
290
+ export declare const EXTENDED_STORY_INCLUDED_EXTRA_FIELDS: (keyof typeof EXTENDED_STORY_INCLUDED_EXTRA_FIELDS_SHAPE)[];
259
291
  export {};
@@ -24,8 +24,7 @@ const EXTENDED_STORY_INCLUDED_EXTRA_FIELDS_SHAPE = {
24
24
  content: true,
25
25
  attached_gallery_content: true,
26
26
  referenced_entities: true
27
- }; // satisfies Record<keyof Omit<ExtendedStory, keyof Story>, boolean>; // TODO: Use Typescript `satisfies` operator, when it's out of beta
28
-
27
+ };
29
28
  const ALL_EXTRA_FIELDS_SHAPE = {
30
29
  thumbnail_image: true,
31
30
  header_image: true,
@@ -44,8 +43,8 @@ const ALL_EXTRA_FIELDS_SHAPE = {
44
43
  attached_contacts_content: true,
45
44
  referenced_entities: true,
46
45
  'campaigns.count': true,
47
- 'pitches.count': true
48
- }; // satisfies Record<keyof Story.OnDemandFields, boolean>; // TODO: Use Typescript `satisfies` operator, when it's out of beta
49
-
46
+ 'pitches.count': true,
47
+ 'coverage.count': true
48
+ };
50
49
  export const ALL_EXTRA_FIELDS = Object.keys(ALL_EXTRA_FIELDS_SHAPE);
51
50
  export const EXTENDED_STORY_INCLUDED_EXTRA_FIELDS = Object.keys(EXTENDED_STORY_INCLUDED_EXTRA_FIELDS_SHAPE);
@@ -7,7 +7,7 @@ export declare function createClient(api: DeferredJobsApiClient): {
7
7
  subscribeToNewsroom: <Type extends Contact.Type>(newsroomId: NewsroomId, payload: SubscribeRequest<Type>) => Promise<EmailSubscription>;
8
8
  unsubscribeFromNewsroom: (newsroomId: NewsroomId, payload: UnsubscribeRequest) => Promise<EmailSubscription>;
9
9
  unsubscribeFromLicense: (payload: UnsubscribeRequest) => Promise<EmailSubscription>;
10
- updateNewsroomUnsubscribeDetails: (newsroomId: NewsroomId, subscriptionId: EmailSubscription['id'], payload: UpdateUnsubscribeDetailsRequest) => Promise<EmailSubscription>;
11
- updateLicenseUnsubscribeDetails: (subscriptionId: EmailSubscription['id'], payload: UpdateUnsubscribeDetailsRequest) => Promise<EmailSubscription>;
10
+ updateNewsroomUnsubscribeDetails: (newsroomId: NewsroomId, subscriptionId: EmailSubscription["id"], payload: UpdateUnsubscribeDetailsRequest) => Promise<EmailSubscription>;
11
+ updateLicenseUnsubscribeDetails: (subscriptionId: EmailSubscription["id"], payload: UpdateUnsubscribeDetailsRequest) => Promise<EmailSubscription>;
12
12
  };
13
13
  export {};
@@ -4,11 +4,11 @@ Object.defineProperty(exports, "__esModule", {
4
4
  value: true
5
5
  });
6
6
  exports.UnsubscribeReason = void 0;
7
- let UnsubscribeReason = exports.UnsubscribeReason = void 0;
8
- (function (UnsubscribeReason) {
7
+ let UnsubscribeReason = exports.UnsubscribeReason = /*#__PURE__*/function (UnsubscribeReason) {
9
8
  UnsubscribeReason["UNKNOWN"] = "unknown";
10
9
  UnsubscribeReason["UNWANTED"] = "unwanted";
11
10
  UnsubscribeReason["SPAM"] = "spam";
12
11
  UnsubscribeReason["NEVER_SIGNED_UP"] = "never_signed_up";
13
12
  UnsubscribeReason["OTHER"] = "other";
14
- })(UnsubscribeReason || (exports.UnsubscribeReason = UnsubscribeReason = {}));
13
+ return UnsubscribeReason;
14
+ }({});
@@ -1,8 +1,8 @@
1
- export let UnsubscribeReason;
2
- (function (UnsubscribeReason) {
1
+ export let UnsubscribeReason = /*#__PURE__*/function (UnsubscribeReason) {
3
2
  UnsubscribeReason["UNKNOWN"] = "unknown";
4
3
  UnsubscribeReason["UNWANTED"] = "unwanted";
5
4
  UnsubscribeReason["SPAM"] = "spam";
6
5
  UnsubscribeReason["NEVER_SIGNED_UP"] = "never_signed_up";
7
6
  UnsubscribeReason["OTHER"] = "other";
8
- })(UnsubscribeReason || (UnsubscribeReason = {}));
7
+ return UnsubscribeReason;
8
+ }({});
@@ -64,5 +64,4 @@ var _Templates = _interopRequireWildcard(require("./Templates/index.cjs"));
64
64
  exports.Templates = _Templates;
65
65
  var _NotificationSubscriptions = _interopRequireWildcard(require("./NotificationSubscriptions/index.cjs"));
66
66
  exports.NotificationSubscriptions = _NotificationSubscriptions;
67
- function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function (e) { return e ? t : r; })(e); }
68
- function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != typeof e && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && Object.prototype.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
67
+ function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r = new WeakMap(), n = new WeakMap(); return (_interopRequireWildcard = function (e, t) { if (!t && e && e.__esModule) return e; var o, i, f = { __proto__: null, default: e }; if (null === e || "object" != typeof e && "function" != typeof e) return f; if (o = t ? n : r) { if (o.has(e)) return o.get(e); o.set(e, f); } for (const t in e) "default" !== t && {}.hasOwnProperty.call(e, t) && ((i = (o = Object.defineProperty) && Object.getOwnPropertyDescriptor(e, t)) && (i.get || i.set) ? o(f, t, i) : f[t] = e[t]); return f; })(e, t); }
package/dist/http/lib.cjs CHANGED
@@ -6,7 +6,7 @@ Object.defineProperty(exports, "__esModule", {
6
6
  exports.createUrlWithQuery = createUrlWithQuery;
7
7
  exports.isDeferredJobResponse = isDeferredJobResponse;
8
8
  var _queryString = _interopRequireDefault(require("query-string"));
9
- function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
9
+ function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
10
10
  function parseUrlParams(query) {
11
11
  return _queryString.default.parse(query, {
12
12
  arrayFormat: 'bracket'
@@ -4,20 +4,20 @@ Object.defineProperty(exports, "__esModule", {
4
4
  value: true
5
5
  });
6
6
  exports.Method = exports.HttpCodes = void 0;
7
- let HttpCodes = exports.HttpCodes = void 0;
8
- (function (HttpCodes) {
7
+ let HttpCodes = exports.HttpCodes = /*#__PURE__*/function (HttpCodes) {
9
8
  HttpCodes[HttpCodes["ACCEPTED"] = 202] = "ACCEPTED";
10
9
  HttpCodes[HttpCodes["NO_CONTENT"] = 204] = "NO_CONTENT";
11
10
  HttpCodes[HttpCodes["NOT_FOUND"] = 404] = "NOT_FOUND";
12
11
  HttpCodes[HttpCodes["CONFLICT"] = 409] = "CONFLICT";
13
12
  HttpCodes[HttpCodes["GONE"] = 410] = "GONE";
14
13
  HttpCodes[HttpCodes["PRECONDITION_FAILED"] = 412] = "PRECONDITION_FAILED";
15
- })(HttpCodes || (exports.HttpCodes = HttpCodes = {}));
16
- let Method = exports.Method = void 0;
17
- (function (Method) {
14
+ return HttpCodes;
15
+ }({});
16
+ let Method = exports.Method = /*#__PURE__*/function (Method) {
18
17
  Method["DELETE"] = "DELETE";
19
18
  Method["GET"] = "GET";
20
19
  Method["PATCH"] = "PATCH";
21
20
  Method["POST"] = "POST";
22
21
  Method["PUT"] = "PUT";
23
- })(Method || (exports.Method = Method = {}));
22
+ return Method;
23
+ }({});
@@ -1,17 +1,17 @@
1
- export let HttpCodes;
2
- (function (HttpCodes) {
1
+ export let HttpCodes = /*#__PURE__*/function (HttpCodes) {
3
2
  HttpCodes[HttpCodes["ACCEPTED"] = 202] = "ACCEPTED";
4
3
  HttpCodes[HttpCodes["NO_CONTENT"] = 204] = "NO_CONTENT";
5
4
  HttpCodes[HttpCodes["NOT_FOUND"] = 404] = "NOT_FOUND";
6
5
  HttpCodes[HttpCodes["CONFLICT"] = 409] = "CONFLICT";
7
6
  HttpCodes[HttpCodes["GONE"] = 410] = "GONE";
8
7
  HttpCodes[HttpCodes["PRECONDITION_FAILED"] = 412] = "PRECONDITION_FAILED";
9
- })(HttpCodes || (HttpCodes = {}));
10
- export let Method;
11
- (function (Method) {
8
+ return HttpCodes;
9
+ }({});
10
+ export let Method = /*#__PURE__*/function (Method) {
12
11
  Method["DELETE"] = "DELETE";
13
12
  Method["GET"] = "GET";
14
13
  Method["PATCH"] = "PATCH";
15
14
  Method["POST"] = "POST";
16
15
  Method["PUT"] = "PUT";
17
- })(Method || (Method = {}));
16
+ return Method;
17
+ }({});
@@ -4,8 +4,8 @@ Object.defineProperty(exports, "__esModule", {
4
4
  value: true
5
5
  });
6
6
  exports.BillingCycle = void 0;
7
- let BillingCycle = exports.BillingCycle = void 0;
8
- (function (BillingCycle) {
7
+ let BillingCycle = exports.BillingCycle = /*#__PURE__*/function (BillingCycle) {
9
8
  BillingCycle["YEAR"] = "year";
10
9
  BillingCycle["MONTH"] = "month";
11
- })(BillingCycle || (exports.BillingCycle = BillingCycle = {}));
10
+ return BillingCycle;
11
+ }({});
@@ -1,5 +1,5 @@
1
- export let BillingCycle;
2
- (function (BillingCycle) {
1
+ export let BillingCycle = /*#__PURE__*/function (BillingCycle) {
3
2
  BillingCycle["YEAR"] = "year";
4
3
  BillingCycle["MONTH"] = "month";
5
- })(BillingCycle || (BillingCycle = {}));
4
+ return BillingCycle;
5
+ }({});
@@ -8,48 +8,48 @@ var _SenderDomain = require("./SenderDomain.cjs");
8
8
  let Campaign = exports.Campaign = void 0;
9
9
  (function (_Campaign) {
10
10
  const SenderDomainVerificationFlow = _Campaign.SenderDomainVerificationFlow = _SenderDomain.SenderDomain.VerificationFlowVersion;
11
- let LifecycleStatus;
12
- (function (LifecycleStatus) {
11
+ let LifecycleStatus = /*#__PURE__*/function (LifecycleStatus) {
13
12
  LifecycleStatus["DRAFT"] = "draft";
14
13
  LifecycleStatus["SCHEDULED"] = "scheduled";
15
14
  LifecycleStatus["PENDING"] = "pending";
16
15
  LifecycleStatus["SENT"] = "sent";
17
- })(LifecycleStatus || (LifecycleStatus = {}));
16
+ return LifecycleStatus;
17
+ }({});
18
18
  _Campaign.LifecycleStatus = LifecycleStatus;
19
- let StoryAlignment;
20
- (function (StoryAlignment) {
19
+ let StoryAlignment = /*#__PURE__*/function (StoryAlignment) {
21
20
  StoryAlignment["CENTER"] = "center";
22
21
  StoryAlignment["LEFT"] = "left";
23
22
  StoryAlignment["RIGHT"] = "right";
24
- })(StoryAlignment || (StoryAlignment = {}));
23
+ return StoryAlignment;
24
+ }({});
25
25
  _Campaign.StoryAlignment = StoryAlignment;
26
- let StoryAppearance;
27
- (function (StoryAppearance) {
26
+ let StoryAppearance = /*#__PURE__*/function (StoryAppearance) {
28
27
  StoryAppearance["INTRO"] = "intro";
29
28
  StoryAppearance["FULL"] = "full";
30
- })(StoryAppearance || (StoryAppearance = {}));
29
+ return StoryAppearance;
30
+ }({});
31
31
  _Campaign.StoryAppearance = StoryAppearance;
32
- let StoryHeaderFooter;
33
- (function (StoryHeaderFooter) {
32
+ let StoryHeaderFooter = /*#__PURE__*/function (StoryHeaderFooter) {
34
33
  StoryHeaderFooter["NONE"] = "none";
35
34
  StoryHeaderFooter["STANDARD"] = "standard";
36
35
  StoryHeaderFooter["FULL"] = "full";
37
- })(StoryHeaderFooter || (StoryHeaderFooter = {}));
36
+ return StoryHeaderFooter;
37
+ }({});
38
38
  _Campaign.StoryHeaderFooter = StoryHeaderFooter;
39
- let SenderDomainVerificationStatus;
40
- (function (SenderDomainVerificationStatus) {
39
+ let SenderDomainVerificationStatus = /*#__PURE__*/function (SenderDomainVerificationStatus) {
41
40
  SenderDomainVerificationStatus["UNKNOWN"] = "unknown";
42
41
  SenderDomainVerificationStatus["VALID"] = "valid";
43
42
  SenderDomainVerificationStatus["INVALID"] = "invalid";
44
43
  SenderDomainVerificationStatus["NOT_APPLICABLE"] = "not-applicable";
45
- })(SenderDomainVerificationStatus || (SenderDomainVerificationStatus = {}));
44
+ return SenderDomainVerificationStatus;
45
+ }({});
46
46
  _Campaign.SenderDomainVerificationStatus = SenderDomainVerificationStatus;
47
- let ClickTrackingVersion;
48
- (function (ClickTrackingVersion) {
47
+ let ClickTrackingVersion = /*#__PURE__*/function (ClickTrackingVersion) {
49
48
  ClickTrackingVersion[ClickTrackingVersion["DEPRECATED"] = 1] = "DEPRECATED";
50
49
  ClickTrackingVersion[ClickTrackingVersion["ENHANCED"] = 2] = "ENHANCED";
51
50
  ClickTrackingVersion[ClickTrackingVersion["INHOUSE"] = 3] = "INHOUSE";
52
- })(ClickTrackingVersion || (ClickTrackingVersion = {}));
51
+ return ClickTrackingVersion;
52
+ }({});
53
53
  _Campaign.ClickTrackingVersion = ClickTrackingVersion;
54
54
  function isDraft(arg) {
55
55
  if (typeof arg === 'object') {
@@ -2,48 +2,48 @@ import { SenderDomain } from "./SenderDomain.js";
2
2
  export let Campaign;
3
3
  (function (_Campaign) {
4
4
  const SenderDomainVerificationFlow = _Campaign.SenderDomainVerificationFlow = SenderDomain.VerificationFlowVersion;
5
- let LifecycleStatus;
6
- (function (LifecycleStatus) {
5
+ let LifecycleStatus = /*#__PURE__*/function (LifecycleStatus) {
7
6
  LifecycleStatus["DRAFT"] = "draft";
8
7
  LifecycleStatus["SCHEDULED"] = "scheduled";
9
8
  LifecycleStatus["PENDING"] = "pending";
10
9
  LifecycleStatus["SENT"] = "sent";
11
- })(LifecycleStatus || (LifecycleStatus = {}));
10
+ return LifecycleStatus;
11
+ }({});
12
12
  _Campaign.LifecycleStatus = LifecycleStatus;
13
- let StoryAlignment;
14
- (function (StoryAlignment) {
13
+ let StoryAlignment = /*#__PURE__*/function (StoryAlignment) {
15
14
  StoryAlignment["CENTER"] = "center";
16
15
  StoryAlignment["LEFT"] = "left";
17
16
  StoryAlignment["RIGHT"] = "right";
18
- })(StoryAlignment || (StoryAlignment = {}));
17
+ return StoryAlignment;
18
+ }({});
19
19
  _Campaign.StoryAlignment = StoryAlignment;
20
- let StoryAppearance;
21
- (function (StoryAppearance) {
20
+ let StoryAppearance = /*#__PURE__*/function (StoryAppearance) {
22
21
  StoryAppearance["INTRO"] = "intro";
23
22
  StoryAppearance["FULL"] = "full";
24
- })(StoryAppearance || (StoryAppearance = {}));
23
+ return StoryAppearance;
24
+ }({});
25
25
  _Campaign.StoryAppearance = StoryAppearance;
26
- let StoryHeaderFooter;
27
- (function (StoryHeaderFooter) {
26
+ let StoryHeaderFooter = /*#__PURE__*/function (StoryHeaderFooter) {
28
27
  StoryHeaderFooter["NONE"] = "none";
29
28
  StoryHeaderFooter["STANDARD"] = "standard";
30
29
  StoryHeaderFooter["FULL"] = "full";
31
- })(StoryHeaderFooter || (StoryHeaderFooter = {}));
30
+ return StoryHeaderFooter;
31
+ }({});
32
32
  _Campaign.StoryHeaderFooter = StoryHeaderFooter;
33
- let SenderDomainVerificationStatus;
34
- (function (SenderDomainVerificationStatus) {
33
+ let SenderDomainVerificationStatus = /*#__PURE__*/function (SenderDomainVerificationStatus) {
35
34
  SenderDomainVerificationStatus["UNKNOWN"] = "unknown";
36
35
  SenderDomainVerificationStatus["VALID"] = "valid";
37
36
  SenderDomainVerificationStatus["INVALID"] = "invalid";
38
37
  SenderDomainVerificationStatus["NOT_APPLICABLE"] = "not-applicable";
39
- })(SenderDomainVerificationStatus || (SenderDomainVerificationStatus = {}));
38
+ return SenderDomainVerificationStatus;
39
+ }({});
40
40
  _Campaign.SenderDomainVerificationStatus = SenderDomainVerificationStatus;
41
- let ClickTrackingVersion;
42
- (function (ClickTrackingVersion) {
41
+ let ClickTrackingVersion = /*#__PURE__*/function (ClickTrackingVersion) {
43
42
  ClickTrackingVersion[ClickTrackingVersion["DEPRECATED"] = 1] = "DEPRECATED";
44
43
  ClickTrackingVersion[ClickTrackingVersion["ENHANCED"] = 2] = "ENHANCED";
45
44
  ClickTrackingVersion[ClickTrackingVersion["INHOUSE"] = 3] = "INHOUSE";
46
- })(ClickTrackingVersion || (ClickTrackingVersion = {}));
45
+ return ClickTrackingVersion;
46
+ }({});
47
47
  _Campaign.ClickTrackingVersion = ClickTrackingVersion;
48
48
  function isDraft(arg) {
49
49
  if (typeof arg === 'object') {
@@ -5,7 +5,6 @@ Object.defineProperty(exports, "__esModule", {
5
5
  });
6
6
  exports.CategoryRef = exports.Category = void 0;
7
7
  let CategoryRef = exports.CategoryRef = void 0;
8
- (function (_CategoryRef) {})(CategoryRef || (exports.CategoryRef = CategoryRef = {}));
9
8
  let Category = exports.Category = void 0;
10
9
  (function (_Category) {
11
10
  function isTranslated(category, locale) {
@@ -1,5 +1,4 @@
1
1
  export let CategoryRef;
2
- (function (_CategoryRef) {})(CategoryRef || (CategoryRef = {}));
3
2
  export let Category;
4
3
  (function (_Category) {
5
4
  function isTranslated(category, locale) {