@prezly/sdk 25.0.0 → 25.1.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 (32) 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/CampaignRecipients/Client.d.ts +1 -1
  7. package/dist/endpoints/Campaigns/Client.d.ts +8 -8
  8. package/dist/endpoints/ContactTags/Client.d.ts +4 -4
  9. package/dist/endpoints/Contacts/Client.d.ts +6 -6
  10. package/dist/endpoints/ContactsExports/Client.d.ts +2 -2
  11. package/dist/endpoints/CoverageIntegrations/Client.d.ts +3 -3
  12. package/dist/endpoints/NewsroomCategories/Client.d.ts +3 -3
  13. package/dist/endpoints/NewsroomGalleries/Client.d.ts +1 -1
  14. package/dist/endpoints/NewsroomLanguages/Client.d.ts +10 -10
  15. package/dist/endpoints/NewsroomPrivacyRequests/Client.d.ts +2 -2
  16. package/dist/endpoints/NewsroomThemes/Client.d.ts +1 -1
  17. package/dist/endpoints/NewsroomWebhooks/Client.d.ts +3 -3
  18. package/dist/endpoints/SenderAddresses/Client.d.ts +3 -3
  19. package/dist/endpoints/Stories/Client.cjs +11 -0
  20. package/dist/endpoints/Stories/Client.d.ts +107 -103
  21. package/dist/endpoints/Stories/Client.js +11 -0
  22. package/dist/endpoints/Stories/types.d.ts +4 -2
  23. package/dist/endpoints/Subscriptions/Client.d.ts +2 -2
  24. package/dist/endpoints/index.cjs +1 -1
  25. package/dist/http/lib.cjs +1 -1
  26. package/dist/types/StoriesBulkSelector.cjs +1 -0
  27. package/dist/types/StoriesBulkSelector.d.ts +4 -0
  28. package/dist/types/StoriesBulkSelector.js +1 -0
  29. package/dist/types/index.cjs +11 -0
  30. package/dist/types/index.d.ts +1 -0
  31. package/dist/types/index.js +1 -0
  32. package/package.json +1 -1
@@ -6,8 +6,8 @@ export interface Options {
6
6
  export type ApiClient = ReturnType<typeof createApiClient>;
7
7
  export declare function createApiClient(http: HttpClient, { accessToken, headers }: Options): {
8
8
  get: <V = any>(url: string, { headers, query }?: Params) => Promise<ApiResponse<V>>;
9
- post: <V_1 = any>(url: string, { headers, payload, query }?: ParamsWithPayload) => Promise<ApiResponse<V_1>>;
10
- put: <V_2 = any>(url: string, { headers, payload, query }?: ParamsWithPayload) => Promise<ApiResponse<V_2>>;
11
- patch: <V_3 = any>(url: string, { headers, payload, query }?: ParamsWithPayload) => Promise<ApiResponse<V_3>>;
12
- delete: <V_4 = any>(url: string, { headers, payload, query }?: ParamsWithPayload) => Promise<ApiResponse<V_4>>;
9
+ post: <V = any>(url: string, { headers, payload, query }?: ParamsWithPayload) => Promise<ApiResponse<V>>;
10
+ put: <V = any>(url: string, { headers, payload, query }?: ParamsWithPayload) => Promise<ApiResponse<V>>;
11
+ patch: <V = any>(url: string, { headers, payload, query }?: ParamsWithPayload) => Promise<ApiResponse<V>>;
12
+ delete: <V = any>(url: string, { headers, payload, query }?: ParamsWithPayload) => Promise<ApiResponse<V>>;
13
13
  };
@@ -4,8 +4,8 @@ import type { ApiClient } from './ApiClient';
4
4
  export type DeferredJobsApiClient = ReturnType<typeof createDeferredJobsApiClient>;
5
5
  export declare function createDeferredJobsApiClient(api: ApiClient): {
6
6
  get: <V = any, P = any>(url: string, { headers, query }?: Params) => ProgressPromise<V, P>;
7
- post: <V_1 = any, P_1 = any>(url: string, { headers, payload, query }?: ParamsWithPayload) => ProgressPromise<V_1, P_1>;
8
- put: <V_2 = any, P_2 = any>(url: string, { headers, payload, query }?: ParamsWithPayload) => ProgressPromise<V_2, P_2>;
9
- patch: <V_3 = any, P_3 = any>(url: string, { headers, payload, query }?: ParamsWithPayload) => ProgressPromise<V_3, P_3>;
10
- delete: <V_4 = any, P_4 = any>(url: string, { headers, payload, query }?: ParamsWithPayload) => ProgressPromise<V_4, P_4>;
7
+ post: <V = any, P = any>(url: string, { headers, payload, query }?: ParamsWithPayload) => ProgressPromise<V, P>;
8
+ put: <V = any, P = any>(url: string, { headers, payload, query }?: ParamsWithPayload) => ProgressPromise<V, P>;
9
+ patch: <V = any, P = any>(url: string, { headers, payload, query }?: ParamsWithPayload) => ProgressPromise<V, P>;
10
+ delete: <V = any, P = any>(url: string, { headers, payload, query }?: ParamsWithPayload) => ProgressPromise<V, P>;
11
11
  };
@@ -4,6 +4,6 @@ Object.defineProperty(exports, "__esModule", {
4
4
  value: true
5
5
  });
6
6
  exports.DEFAULT_USER_AGENT = void 0;
7
- const VERSION = "24.1.1";
7
+ const VERSION = "25.0.0";
8
8
  const URL = 'https://github.com/prezly/javascript-sdk';
9
9
  const DEFAULT_USER_AGENT = exports.DEFAULT_USER_AGENT = `prezly-javascript-sdk/${VERSION} (+${URL})`;
@@ -1,3 +1,3 @@
1
- const VERSION = "24.1.1";
1
+ const VERSION = "25.0.0";
2
2
  const URL = 'https://github.com/prezly/javascript-sdk';
3
3
  export const DEFAULT_USER_AGENT = `prezly-javascript-sdk/${VERSION} (+${URL})`;
@@ -5,5 +5,5 @@ export type Client = ReturnType<typeof createClient>;
5
5
  export declare function createClient(api: DeferredJobsApiClient): {
6
6
  list: () => Promise<ListResponse>;
7
7
  create: (payload: CreateRequest) => Promise<CreateResponse>;
8
- update: (id: UserAccount['id'], payload: UpdateRequest) => Promise<UpdateResponse>;
8
+ update: (id: UserAccount["id"], payload: UpdateRequest) => Promise<UpdateResponse>;
9
9
  };
@@ -22,6 +22,6 @@ export declare function createClient(api: DeferredJobsApiClient): {
22
22
  removeRecipient: (campaignId: CampaignId, recipientId: EmailRecipientId) => Promise<RecipientsOperationResponse>;
23
23
  removeRecipients: (campaignId: CampaignId, params?: {
24
24
  query: Query;
25
- } | undefined) => Promise<RecipientsOperationResponse>;
25
+ }) => Promise<RecipientsOperationResponse>;
26
26
  };
27
27
  export {};
@@ -6,15 +6,15 @@ export type Client = ReturnType<typeof createClient>;
6
6
  export declare function createClient(api: DeferredJobsApiClient): {
7
7
  list: (options: SearchOptions) => Promise<ListResponse>;
8
8
  search: (options: SearchOptions) => Promise<ListResponse>;
9
- get: (id: Campaign['id']) => Promise<CampaignResponse>;
10
- duplicate: (id: Campaign['id']) => Promise<CampaignResponse>;
11
- test: (id: Campaign['id'], emails: string[]) => Promise<void>;
12
- send: (id: Campaign['id']) => Promise<void>;
13
- schedule: (id: Campaign['id'], sendAt: Date) => Promise<Campaign>;
14
- unschedule: (id: Campaign['id']) => Promise<Campaign>;
9
+ get: (id: Campaign["id"]) => Promise<CampaignResponse>;
10
+ duplicate: (id: Campaign["id"]) => Promise<CampaignResponse>;
11
+ test: (id: Campaign["id"], emails: string[]) => Promise<void>;
12
+ send: (id: Campaign["id"]) => Promise<void>;
13
+ schedule: (id: Campaign["id"], sendAt: Date) => Promise<Campaign>;
14
+ unschedule: (id: Campaign["id"]) => Promise<Campaign>;
15
15
  create: (payload: CreateRequest) => ProgressPromise<RecipientsOperationResponse, {
16
16
  recipients_number: number;
17
17
  }>;
18
- update: (id: Campaign['id'], payload: UpdateRequest) => Promise<CampaignResponse>;
19
- delete: (id: Campaign['id']) => Promise<void>;
18
+ update: (id: Campaign["id"], payload: UpdateRequest) => Promise<CampaignResponse>;
19
+ delete: (id: Campaign["id"]) => Promise<void>;
20
20
  };
@@ -5,14 +5,14 @@ export type Client = ReturnType<typeof createClient>;
5
5
  export declare function createClient(api: DeferredJobsApiClient): {
6
6
  list: (options?: ListOptions) => Promise<ListResponse>;
7
7
  search: (options?: SearchOptions) => Promise<SearchResponse>;
8
- get: (id: ContactTag['id']) => Promise<ContactTag>;
8
+ get: (id: ContactTag["id"]) => Promise<ContactTag>;
9
9
  create: (payload: CreateRequest, { force }?: CreateOptions) => Promise<CreateResponse>;
10
- update: (id: Contact['id'], payload: UpdateRequest, { force }?: UpdateOptions) => Promise<UpdateResponse>;
10
+ update: (id: Contact["id"], payload: UpdateRequest, { force }?: UpdateOptions) => Promise<UpdateResponse>;
11
11
  merge: ({ name, tags }: MergeRequest) => Promise<MergeResponse>;
12
- delete: (id: ContactTag['id']) => Promise<{
12
+ delete: (id: ContactTag["id"]) => Promise<{
13
13
  deleted: number[];
14
14
  }>;
15
- deleteMany: (ids: ContactTag['id'][]) => Promise<{
15
+ deleteMany: (ids: ContactTag["id"][]) => Promise<{
16
16
  deleted: number[];
17
17
  }>;
18
18
  deleteUnused: () => Promise<{
@@ -6,14 +6,14 @@ export type Client = ReturnType<typeof createClient>;
6
6
  export declare function createClient(api: DeferredJobsApiClient): {
7
7
  list: (options?: ListOptions) => Promise<ListResponse>;
8
8
  search: (options?: SearchOptions) => Promise<SearchResponse>;
9
- get: (id: Contact['id']) => Promise<Contact>;
10
- getMany: (ids: Contact['id'][]) => Promise<Contact[]>;
9
+ get: (id: Contact["id"]) => Promise<Contact>;
10
+ getMany: (ids: Contact["id"][]) => Promise<Contact[]>;
11
11
  create: (payload: CreateRequest) => Promise<Contact>;
12
- update: (id: Contact['id'], payload: UpdateRequest) => Promise<Contact>;
13
- tag: (id: Contact['id'], tags: ContactTag.Identifier[]) => Promise<Contact>;
14
- untag: (id: Contact['id'], tags: ContactTag.Identifier[]) => Promise<Contact>;
12
+ update: (id: Contact["id"], payload: UpdateRequest) => Promise<Contact>;
13
+ tag: (id: Contact["id"], tags: ContactTag.Identifier[]) => Promise<Contact>;
14
+ untag: (id: Contact["id"], tags: ContactTag.Identifier[]) => Promise<Contact>;
15
15
  bulkTag: (selector: BulkSelector, tags: ContactTag.Identifier[]) => ProgressPromise<undefined>;
16
16
  bulkUntag: (selector: BulkSelector, tags: ContactTag.Identifier[]) => ProgressPromise<undefined>;
17
- delete: (id: Contact['id']) => Promise<void>;
17
+ delete: (id: Contact["id"]) => Promise<void>;
18
18
  bulkDelete: (selector: BulkSelector) => Promise<BulkDeleteResponse>;
19
19
  };
@@ -5,9 +5,9 @@ export type Client = ReturnType<typeof createClient>;
5
5
  export declare function createClient(api: DeferredJobsApiClient): {
6
6
  list: (options: ListOptions) => Promise<ListResponse>;
7
7
  search: (options: SearchOptions) => Promise<ListResponse>;
8
- get: (uuid: ContactsExport['uuid']) => Promise<ContactsExport>;
8
+ get: (uuid: ContactsExport["uuid"]) => Promise<ContactsExport>;
9
9
  create: (selector: ContactsBulkSelector) => Promise<ContactsExport>;
10
- download: (uuid: ContactsExport['uuid']) => Promise<{
10
+ download: (uuid: ContactsExport["uuid"]) => Promise<{
11
11
  downloadUrl: string;
12
12
  }>;
13
13
  };
@@ -14,9 +14,9 @@ export declare function createClient(api: DeferredJobsApiClient): {
14
14
  delete: (integrationId: IntegrationId) => Promise<void>;
15
15
  listRuns: (integrationId: IntegrationId, options?: ListRunsOptions) => Promise<ListRunsResponse>;
16
16
  preview: (provider: CoverageEntry.Provider, options: {
17
- input: CoverageIntegration['input'];
18
- oldest?: number | undefined;
19
- limit?: number | undefined;
17
+ input: CoverageIntegration["input"];
18
+ oldest?: number;
19
+ limit?: number;
20
20
  }) => Promise<PreviewResponse>;
21
21
  };
22
22
  export {};
@@ -5,9 +5,9 @@ type NewsroomId = Newsroom['uuid'] | Newsroom['id'];
5
5
  export type Client = ReturnType<typeof createClient>;
6
6
  export declare function createClient(api: DeferredJobsApiClient): {
7
7
  list: (newsroomId: NewsroomId, { sortOrder }?: ListOptions) => Promise<Category[]>;
8
- get: (newsroomId: NewsroomId, categoryId: Category['id']) => Promise<Category>;
8
+ get: (newsroomId: NewsroomId, categoryId: Category["id"]) => Promise<Category>;
9
9
  create: (newsroomId: NewsroomId, payload: CreateRequest) => Promise<Category>;
10
- update: (newsroomId: NewsroomId, categoryId: Category['id'], payload: UpdateRequest) => Promise<Category>;
11
- delete: (newsroomId: NewsroomId, categoryId: Category['id']) => Promise<void>;
10
+ update: (newsroomId: NewsroomId, categoryId: Category["id"], payload: UpdateRequest) => Promise<Category>;
11
+ delete: (newsroomId: NewsroomId, categoryId: Category["id"]) => Promise<void>;
12
12
  };
13
13
  export {};
@@ -5,7 +5,7 @@ type NewsroomId = Newsroom['uuid'] | Newsroom['id'];
5
5
  type GalleryId = NewsroomGallery['uuid'] | NewsroomGallery['id'];
6
6
  export type Client = ReturnType<typeof createClient>;
7
7
  export declare function createClient(api: DeferredJobsApiClient): {
8
- get: (newsroomId: NewsroomId, id: NewsroomGallery['uuid']) => Promise<NewsroomGallery>;
8
+ get: (newsroomId: NewsroomId, id: NewsroomGallery["uuid"]) => Promise<NewsroomGallery>;
9
9
  list: (newsroomId: NewsroomId, options?: ListOptions) => Promise<ListResponse>;
10
10
  search: (newsroomId: NewsroomId, options?: SearchOptions) => Promise<ListResponse>;
11
11
  order: (newsroomId: NewsroomId, payload: ReorderRequest) => Promise<void>;
@@ -5,19 +5,19 @@ type NewsroomId = Newsroom['uuid'] | Newsroom['id'];
5
5
  export type Client = ReturnType<typeof createClient>;
6
6
  export declare function createClient(api: DeferredJobsApiClient): {
7
7
  list: (newsroomId: NewsroomId, { sortOrder }?: ListOptions) => Promise<ListResponse>;
8
- get: (newsroomId: NewsroomId, localeCode: CultureRef['code'], { fallback }?: {
9
- fallback?: boolean | undefined;
8
+ get: (newsroomId: NewsroomId, localeCode: CultureRef["code"], { fallback }?: {
9
+ fallback?: true | false;
10
10
  }) => Promise<NewsroomLanguageSettings>;
11
- enable: (newsroomId: NewsroomId, localeCode: CultureRef['code'], payload?: SettingsUpdateRequest) => Promise<NewsroomLanguageSettings>;
12
- disable: (newsroomId: NewsroomId, localeCode: CultureRef['code'], { replacement }: {
13
- replacement?: import("../../types").Culture.Code | undefined;
11
+ enable: (newsroomId: NewsroomId, localeCode: CultureRef["code"], payload?: SettingsUpdateRequest) => Promise<NewsroomLanguageSettings>;
12
+ disable: (newsroomId: NewsroomId, localeCode: CultureRef["code"], { replacement }: {
13
+ replacement?: CultureRef["code"];
14
14
  }) => Promise<void>;
15
- update: (newsroomId: NewsroomId, localeCode: CultureRef['code'], payload: SettingsUpdateRequest, options?: {
16
- force?: boolean | undefined;
15
+ update: (newsroomId: NewsroomId, localeCode: CultureRef["code"], payload: SettingsUpdateRequest, options?: {
16
+ force?: boolean;
17
17
  }) => Promise<NewsroomLanguageSettings>;
18
- makeDefault: (newsroomId: NewsroomId, localeCode: CultureRef['code']) => Promise<NewsroomLanguageSettings>;
19
- switchDefaultLanguage: (newsroomId: NewsroomId, localeCode: CultureRef['code'], newLocaleCode: CultureRef['code'], forceUnsafeOperation?: boolean) => Promise<{
20
- status: 'success';
18
+ makeDefault: (newsroomId: NewsroomId, localeCode: CultureRef["code"]) => Promise<NewsroomLanguageSettings>;
19
+ switchDefaultLanguage: (newsroomId: NewsroomId, localeCode: CultureRef["code"], newLocaleCode: CultureRef["code"], forceUnsafeOperation?: boolean) => Promise<{
20
+ status: "success";
21
21
  language: NewsroomLanguageSettings;
22
22
  } | UnsafeUpdateErrorResponse>;
23
23
  };
@@ -3,6 +3,6 @@ import type { Newsroom, PrivacyRequest } from '../../types';
3
3
  import type { DeletePrivacyRequestCreateRequest, ExportPrivacyRequestCreateRequest, CorrectPrivacyRequestCreateRequest, OtherPrivacyRequestCreateRequest } from './types';
4
4
  export type Client = ReturnType<typeof createClient>;
5
5
  export declare function createClient(api: DeferredJobsApiClient): {
6
- create: (newsroomId: Newsroom['uuid'], payload: DeletePrivacyRequestCreateRequest | ExportPrivacyRequestCreateRequest | CorrectPrivacyRequestCreateRequest | OtherPrivacyRequestCreateRequest) => Promise<PrivacyRequest>;
7
- confirm: (newsroomId: Newsroom['uuid'], privacyRequestId: PrivacyRequest['id']) => Promise<PrivacyRequest>;
6
+ create: (newsroomId: Newsroom["uuid"], payload: DeletePrivacyRequestCreateRequest | ExportPrivacyRequestCreateRequest | CorrectPrivacyRequestCreateRequest | OtherPrivacyRequestCreateRequest) => Promise<PrivacyRequest>;
7
+ confirm: (newsroomId: Newsroom["uuid"], privacyRequestId: PrivacyRequest["id"]) => Promise<PrivacyRequest>;
8
8
  };
@@ -4,7 +4,7 @@ type NewsroomId = Newsroom['uuid'] | Newsroom['id'];
4
4
  type NewsroomThemeId = NewsroomTheme['id'];
5
5
  export type Client = ReturnType<typeof createClient>;
6
6
  export declare function createClient(api: DeferredJobsApiClient): {
7
- apply: (newsroomId: NewsroomId, themeId: NewsroomThemeId, settings: NewsroomThemePreset['settings']) => Promise<NewsroomThemePreset>;
7
+ apply: (newsroomId: NewsroomId, themeId: NewsroomThemeId, settings: NewsroomThemePreset["settings"]) => Promise<NewsroomThemePreset>;
8
8
  get: (newsroomId: NewsroomId, themeId: NewsroomThemeId) => Promise<NewsroomThemePreset>;
9
9
  getActive: (newsroomId: NewsroomId) => Promise<NewsroomThemePreset>;
10
10
  list: (newsroomId: NewsroomId) => Promise<NewsroomThemePreset[]>;
@@ -6,8 +6,8 @@ export type Client = ReturnType<typeof createClient>;
6
6
  export declare function createClient(api: DeferredJobsApiClient): {
7
7
  list: (newsroomId: NewsroomId) => Promise<NewsroomWebhook[]>;
8
8
  create: (newsroomId: NewsroomId, payload: CreateRequest) => Promise<NewsroomWebhook>;
9
- get: (newsroomId: NewsroomId, webhookId: NewsroomWebhook['id']) => Promise<NewsroomWebhook>;
10
- update: (newsroomId: NewsroomId, webhookId: NewsroomWebhook['id'], payload: UpdateRequest) => Promise<NewsroomWebhook>;
11
- delete: (newsroomId: NewsroomId, webhookId: NewsroomWebhook['id']) => Promise<void>;
9
+ get: (newsroomId: NewsroomId, webhookId: NewsroomWebhook["id"]) => Promise<NewsroomWebhook>;
10
+ update: (newsroomId: NewsroomId, webhookId: NewsroomWebhook["id"], payload: UpdateRequest) => Promise<NewsroomWebhook>;
11
+ delete: (newsroomId: NewsroomId, webhookId: NewsroomWebhook["id"]) => Promise<void>;
12
12
  };
13
13
  export {};
@@ -6,7 +6,7 @@ export type Client = ReturnType<typeof createClient>;
6
6
  export declare function createClient(api: DeferredJobsApiClient): {
7
7
  list: (scope?: Query) => Promise<SenderAddress[]>;
8
8
  create: (payload: CreateRequest) => Promise<SenderAddress>;
9
- get: (senderId: SenderAddress['id']) => Promise<SenderAddress>;
10
- update: (senderId: SenderAddress['id'], payload: UpdateRequest) => Promise<SenderAddress>;
11
- delete: (senderId: SenderAddress['id']) => Promise<void>;
9
+ get: (senderId: SenderAddress["id"]) => Promise<SenderAddress>;
10
+ update: (senderId: SenderAddress["id"], payload: UpdateRequest) => Promise<SenderAddress>;
11
+ delete: (senderId: SenderAddress["id"]) => Promise<void>;
12
12
  };
@@ -408,6 +408,16 @@ function createClient(api) {
408
408
  const url = `${_routing.routing.storiesUrl}/${id}`;
409
409
  await api.delete(url);
410
410
  }
411
+ async function bulkDelete(selector) {
412
+ const {
413
+ query
414
+ } = selector;
415
+ return api.delete(_routing.routing.storiesUrl, {
416
+ payload: {
417
+ query
418
+ }
419
+ });
420
+ }
411
421
  async function preview(id, options) {
412
422
  const url = `${_routing.routing.storiesUrl}/${id}/preview`;
413
423
  const {
@@ -440,6 +450,7 @@ function createClient(api) {
440
450
  pin,
441
451
  unpin,
442
452
  delete: doDelete,
453
+ bulkDelete,
443
454
  preview
444
455
  };
445
456
  }
@@ -1,5 +1,6 @@
1
+ import type { ProgressPromise } from '@prezly/progress-promise';
1
2
  import type { DeferredJobsApiClient } from '../../api';
2
- import type { ExtendedStory, Query, Story } from '../../types';
3
+ import type { ExtendedStory, Query, Story, StoriesBulkSelector } from '../../types';
3
4
  import type { AutosaveRequest, ChangeNewsroomSuccessResponse, ChangeNewsroomUnsafeResponse, CreateRequest, IncludeOptions, ListOptions, ListResponse, MoveRequest, PreviewResponse, PreviewOptions, PublishRequest, RevertRequest, ScheduleRequest, SearchOptions, TranslateRequest, UnpublishRequest, UnscheduleRequest, UpdateRequest } from './types';
4
5
  /**
5
6
  * `uuid` is the preferred way of targeting a Story. Numeric `id` is considered deprecated.
@@ -14,111 +15,114 @@ type Exactly<Concrete, Abstract> = Concrete & Record<Exclude<keyof Concrete, key
14
15
  type InferExtraFields<T> = T extends Required<IncludeOptions<infer I>> ? Pick<Story.ExtraFields, I> : unknown;
15
16
  export type Client = ReturnType<typeof createClient>;
16
17
  export declare function createClient(api: DeferredJobsApiClient): {
17
- list: <Options extends ListOptions<keyof Story.ExtraFields>>(options?: Exactly<Options, ListOptions<keyof Story.ExtraFields>> | undefined) => Promise<ListResponse<Story & InferExtraFields<Options>>>;
18
- 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>>>;
19
20
  get: {
20
- <Options_2 extends IncludeOptions<keyof Story.ExtraFields> & {
21
- formats?: Formats | undefined;
22
- }>(id: Story['uuid'], options?: Exactly<Options_2, IncludeOptions<keyof Story.ExtraFields> & {
23
- formats?: Formats | undefined;
24
- }> | undefined): Promise<ExtendedStory & InferExtraFields<Options_2>>;
25
- <Options_3 extends IncludeOptions<keyof Story.ExtraFields> & {
26
- formats?: Formats | undefined;
27
- }>(ids: Story['uuid'][], options?: Exactly<Options_3, IncludeOptions<keyof Story.ExtraFields> & {
28
- formats?: Formats | undefined;
29
- }> | undefined): Promise<(ExtendedStory & InferExtraFields<Options_3>)[]>;
30
- <Options_4 extends IncludeOptions<keyof Story.ExtraFields> & {
31
- formats?: Formats | undefined;
32
- }>(id: Story['id'] | Story['uuid'], options?: Exactly<Options_4, IncludeOptions<keyof Story.ExtraFields> & {
33
- formats?: Formats | undefined;
34
- }> | undefined): Promise<ExtendedStory & InferExtraFields<Options_4>>;
35
- <Options_5 extends IncludeOptions<keyof Story.ExtraFields> & {
36
- formats?: Formats | undefined;
37
- }>(ids: Story['id'][], options?: Exactly<Options_5, IncludeOptions<keyof Story.ExtraFields> & {
38
- formats?: Formats | undefined;
39
- }> | 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>)[]>;
40
41
  };
41
- getBySlug: <Options_6 extends IncludeOptions<keyof Story.ExtraFields> & {
42
- formats?: Formats | undefined;
43
- query?: Query | undefined;
44
- }>(slug: Story['slug'], options?: Exactly<Options_6, IncludeOptions<keyof Story.ExtraFields> & {
45
- formats?: Formats | undefined;
46
- query?: Query | undefined;
47
- }> | undefined) => Promise<ExtendedStory & InferExtraFields<Options_6>>;
48
- create: <Options_7 extends IncludeOptions<keyof Story.ExtraFields> & {
49
- formats?: Formats | undefined;
50
- force?: boolean | undefined;
51
- }>(payload: CreateRequest, options?: Exactly<Options_7, IncludeOptions<keyof Story.ExtraFields> & {
52
- formats?: Formats | undefined;
53
- force?: boolean | undefined;
54
- }> | undefined) => Promise<ExtendedStory & InferExtraFields<Options_7>>;
55
- duplicate: <Options_8 extends IncludeOptions<keyof Story.ExtraFields> & {
56
- formats?: Formats | undefined;
57
- }>(id: StoryId, options?: Exactly<Options_8, IncludeOptions<keyof Story.ExtraFields> & {
58
- formats?: Formats | undefined;
59
- }> | undefined) => Promise<ExtendedStory & InferExtraFields<Options_8>>;
60
- translate: <Options_9 extends IncludeOptions<keyof Story.ExtraFields> & {
61
- formats?: Formats | undefined;
62
- }>(id: StoryId, payload?: TranslateRequest, options?: Exactly<Options_9, IncludeOptions<keyof Story.ExtraFields> & {
63
- formats?: Formats | undefined;
64
- }> | undefined) => Promise<ExtendedStory & InferExtraFields<Options_9>>;
65
- move: <Options_10 extends IncludeOptions<keyof Story.ExtraFields> & {
66
- formats?: Formats | undefined;
67
- force?: boolean | undefined;
68
- }>(id: StoryId, payload: MoveRequest, options?: Exactly<Options_10, IncludeOptions<keyof Story.ExtraFields> & {
69
- formats?: Formats | undefined;
70
- force?: boolean | undefined;
71
- }> | undefined) => Promise<ChangeNewsroomUnsafeResponse | ChangeNewsroomSuccessResponse<ExtendedStory & InferExtraFields<Options_10>>>;
72
- update: <Options_11 extends IncludeOptions<keyof Story.ExtraFields> & {
73
- formats?: Formats | undefined;
74
- force?: boolean | undefined;
75
- }>(id: StoryId, payload: UpdateRequest, options?: Exactly<Options_11, IncludeOptions<keyof Story.ExtraFields> & {
76
- formats?: Formats | undefined;
77
- force?: boolean | undefined;
78
- }> | undefined) => Promise<ExtendedStory & InferExtraFields<Options_11>>;
79
- autosave: <Options_12 extends IncludeOptions<keyof Story.ExtraFields> & {
80
- formats?: Formats | undefined;
81
- }>(id: StoryId, payload: AutosaveRequest, options?: Exactly<Options_12, IncludeOptions<keyof Story.ExtraFields> & {
82
- formats?: Formats | undefined;
83
- }> | undefined) => Promise<ExtendedStory & InferExtraFields<Options_12>>;
84
- revert: <Options_13 extends IncludeOptions<keyof Story.ExtraFields> & {
85
- formats?: Formats | undefined;
86
- }>(id: StoryId, payload?: RevertRequest, options?: Exactly<Options_13, IncludeOptions<keyof Story.ExtraFields> & {
87
- formats?: Formats | undefined;
88
- }> | undefined) => Promise<ExtendedStory & InferExtraFields<Options_13>>;
89
- publish: <Options_14 extends IncludeOptions<keyof Story.ExtraFields> & {
90
- formats?: Formats | undefined;
91
- }>(id: StoryId, payload?: PublishRequest, options?: Exactly<Options_14, IncludeOptions<keyof Story.ExtraFields> & {
92
- formats?: Formats | undefined;
93
- }> | undefined) => Promise<ExtendedStory & InferExtraFields<Options_14>>;
94
- unpublish: <Options_15 extends IncludeOptions<keyof Story.ExtraFields> & {
95
- formats?: Formats | undefined;
96
- }>(id: StoryId, payload?: UnpublishRequest, options?: Exactly<Options_15, IncludeOptions<keyof Story.ExtraFields> & {
97
- formats?: Formats | undefined;
98
- }> | undefined) => Promise<ExtendedStory & InferExtraFields<Options_15>>;
99
- schedule: <Options_16 extends IncludeOptions<keyof Story.ExtraFields> & {
100
- formats?: Formats | undefined;
101
- }>(id: StoryId, payload?: ScheduleRequest, options?: Exactly<Options_16, IncludeOptions<keyof Story.ExtraFields> & {
102
- formats?: Formats | undefined;
103
- }> | undefined) => Promise<ExtendedStory & InferExtraFields<Options_16>>;
104
- unschedule: <Options_17 extends IncludeOptions<keyof Story.ExtraFields> & {
105
- formats?: Formats | undefined;
106
- }>(id: StoryId, payload?: UnscheduleRequest, options?: Exactly<Options_17, IncludeOptions<keyof Story.ExtraFields> & {
107
- formats?: Formats | undefined;
108
- }> | undefined) => Promise<ExtendedStory & InferExtraFields<Options_17>>;
109
- pin: <Options_18 extends IncludeOptions<keyof Story.ExtraFields> & {
110
- formats?: Formats | undefined;
111
- force?: boolean | undefined;
112
- }>(id: StoryId, options?: Exactly<Options_18, IncludeOptions<keyof Story.ExtraFields> & {
113
- formats?: Formats | undefined;
114
- force?: boolean | undefined;
115
- }> | undefined) => Promise<ExtendedStory & InferExtraFields<Options_18>>;
116
- unpin: <Options_19 extends IncludeOptions<keyof Story.ExtraFields> & {
117
- formats?: Formats | undefined;
118
- }>(id: StoryId, options?: Exactly<Options_19, IncludeOptions<keyof Story.ExtraFields> & {
119
- formats?: Formats | undefined;
120
- }> | 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>>;
121
122
  delete: (id: StoryId) => Promise<void>;
123
+ bulkDelete: (selector: StoriesBulkSelector) => ProgressPromise<{
124
+ records_deleted_number: number;
125
+ }>;
122
126
  preview: (id: StoryId, options?: PreviewOptions) => Promise<PreviewResponse>;
123
127
  };
124
128
  export {};
@@ -400,6 +400,16 @@ export function createClient(api) {
400
400
  const url = `${routing.storiesUrl}/${id}`;
401
401
  await api.delete(url);
402
402
  }
403
+ async function bulkDelete(selector) {
404
+ const {
405
+ query
406
+ } = selector;
407
+ return api.delete(routing.storiesUrl, {
408
+ payload: {
409
+ query
410
+ }
411
+ });
412
+ }
403
413
  async function preview(id, options) {
404
414
  const url = `${routing.storiesUrl}/${id}/preview`;
405
415
  const {
@@ -432,6 +442,7 @@ export function createClient(api) {
432
442
  pin,
433
443
  unpin,
434
444
  delete: doDelete,
445
+ bulkDelete,
435
446
  preview
436
447
  };
437
448
  }
@@ -254,6 +254,8 @@ 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: Record<keyof Omit<ExtendedStory, keyof Story>, boolean>;
258
+ declare const ALL_EXTRA_FIELDS_SHAPE: Record<keyof Story.ExtraFields, boolean>;
259
+ export declare const ALL_EXTRA_FIELDS: (keyof typeof ALL_EXTRA_FIELDS_SHAPE)[];
260
+ export declare const EXTENDED_STORY_INCLUDED_EXTRA_FIELDS: (keyof typeof EXTENDED_STORY_INCLUDED_EXTRA_FIELDS_SHAPE)[];
259
261
  export {};
@@ -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 {};
@@ -63,4 +63,4 @@ exports.Subscriptions = _Subscriptions;
63
63
  var _NotificationSubscriptions = _interopRequireWildcard(require("./NotificationSubscriptions/index.cjs"));
64
64
  exports.NotificationSubscriptions = _NotificationSubscriptions;
65
65
  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); }
66
- 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; }
66
+ 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 && {}.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; }
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'
@@ -0,0 +1 @@
1
+ "use strict";
@@ -0,0 +1,4 @@
1
+ import type { Query } from './common';
2
+ export interface StoriesBulkSelector {
3
+ query: Query;
4
+ }
@@ -0,0 +1 @@
1
+ export {};
@@ -432,6 +432,17 @@ Object.keys(_SortOrder).forEach(function (key) {
432
432
  }
433
433
  });
434
434
  });
435
+ var _StoriesBulkSelector = require("./StoriesBulkSelector.cjs");
436
+ Object.keys(_StoriesBulkSelector).forEach(function (key) {
437
+ if (key === "default" || key === "__esModule") return;
438
+ if (key in exports && exports[key] === _StoriesBulkSelector[key]) return;
439
+ Object.defineProperty(exports, key, {
440
+ enumerable: true,
441
+ get: function () {
442
+ return _StoriesBulkSelector[key];
443
+ }
444
+ });
445
+ });
435
446
  var _Story = require("./Story.cjs");
436
447
  Object.keys(_Story).forEach(function (key) {
437
448
  if (key === "default" || key === "__esModule") return;
@@ -37,6 +37,7 @@ export * from './SenderAddress';
37
37
  export * from './SenderDomain';
38
38
  export * from './Snippet';
39
39
  export * from './SortOrder';
40
+ export * from './StoriesBulkSelector';
40
41
  export * from './Story';
41
42
  export * from './User';
42
43
  export * from './UserAccount';
@@ -38,6 +38,7 @@ export * from "./SenderAddress.js";
38
38
  export * from "./SenderDomain.js";
39
39
  export * from "./Snippet.js";
40
40
  export * from "./SortOrder.js";
41
+ export * from "./StoriesBulkSelector.js";
41
42
  export * from "./Story.js";
42
43
  export * from "./User.js";
43
44
  export * from "./UserAccount.js";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@prezly/sdk",
3
- "version": "25.0.0",
3
+ "version": "25.1.0",
4
4
  "description": "Prezly API SDK",
5
5
  "type": "module",
6
6
  "main": "dist/index.cjs",