@prezly/sdk 23.15.0 → 23.17.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.
- package/dist/api/ApiClient.d.ts +4 -4
- package/dist/api/DeferredJobsApiClient.d.ts +4 -4
- package/dist/api/constants.cjs +1 -1
- package/dist/api/constants.js +1 -1
- package/dist/endpoints/Accounts/Client.d.ts +1 -1
- package/dist/endpoints/CampaignRecipients/Client.d.ts +1 -1
- package/dist/endpoints/Campaigns/Client.d.ts +8 -8
- package/dist/endpoints/ContactTags/Client.d.ts +4 -4
- package/dist/endpoints/Contacts/Client.d.ts +6 -6
- package/dist/endpoints/ContactsExports/Client.d.ts +2 -2
- package/dist/endpoints/CoverageIntegrations/Client.d.ts +3 -3
- package/dist/endpoints/NewsroomCategories/Client.d.ts +3 -3
- package/dist/endpoints/NewsroomGalleries/Client.d.ts +1 -1
- package/dist/endpoints/NewsroomLanguages/Client.d.ts +10 -10
- package/dist/endpoints/NewsroomPrivacyRequests/Client.d.ts +2 -2
- package/dist/endpoints/NewsroomThemes/Client.d.ts +1 -1
- package/dist/endpoints/NewsroomWebhooks/Client.d.ts +3 -3
- package/dist/endpoints/SenderAddresses/Client.d.ts +3 -3
- package/dist/endpoints/Stories/Client.d.ts +102 -102
- package/dist/endpoints/Stories/types.d.ts +4 -2
- package/dist/endpoints/Subscriptions/Client.d.ts +2 -2
- package/dist/endpoints/index.cjs +1 -1
- package/dist/http/lib.cjs +1 -1
- package/dist/types/EmailRecipient.cjs +8 -0
- package/dist/types/EmailRecipient.d.ts +10 -0
- package/dist/types/EmailRecipient.js +8 -0
- package/dist/types/Newsroom.d.ts +2 -1
- package/package.json +1 -1
package/dist/api/ApiClient.d.ts
CHANGED
|
@@ -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: <
|
|
10
|
-
put: <
|
|
11
|
-
patch: <
|
|
12
|
-
delete: <
|
|
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: <
|
|
8
|
-
put: <
|
|
9
|
-
patch: <
|
|
10
|
-
delete: <
|
|
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
|
};
|
package/dist/api/constants.cjs
CHANGED
|
@@ -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 = "23.
|
|
7
|
+
const VERSION = "23.16.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})`;
|
package/dist/api/constants.js
CHANGED
|
@@ -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[
|
|
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
|
-
}
|
|
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[
|
|
10
|
-
duplicate: (id: Campaign[
|
|
11
|
-
test: (id: Campaign[
|
|
12
|
-
send: (id: Campaign[
|
|
13
|
-
schedule: (id: Campaign[
|
|
14
|
-
unschedule: (id: 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[
|
|
19
|
-
delete: (id: Campaign[
|
|
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[
|
|
8
|
+
get: (id: ContactTag["id"]) => Promise<ContactTag>;
|
|
9
9
|
create: (payload: CreateRequest, { force }?: CreateOptions) => Promise<CreateResponse>;
|
|
10
|
-
update: (id: Contact[
|
|
10
|
+
update: (id: Contact["id"], payload: UpdateRequest, { force }?: UpdateOptions) => Promise<UpdateResponse>;
|
|
11
11
|
merge: ({ name, tags }: MergeRequest) => Promise<MergeResponse>;
|
|
12
|
-
delete: (id: ContactTag[
|
|
12
|
+
delete: (id: ContactTag["id"]) => Promise<{
|
|
13
13
|
deleted: number[];
|
|
14
14
|
}>;
|
|
15
|
-
deleteMany: (ids: ContactTag[
|
|
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[
|
|
10
|
-
getMany: (ids: 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[
|
|
13
|
-
tag: (id: Contact[
|
|
14
|
-
untag: (id: 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[
|
|
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[
|
|
8
|
+
get: (uuid: ContactsExport["uuid"]) => Promise<ContactsExport>;
|
|
9
9
|
create: (selector: ContactsBulkSelector) => Promise<ContactsExport>;
|
|
10
|
-
download: (uuid: ContactsExport[
|
|
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[
|
|
18
|
-
oldest?: number
|
|
19
|
-
limit?: number
|
|
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[
|
|
8
|
+
get: (newsroomId: NewsroomId, categoryId: Category["id"]) => Promise<Category>;
|
|
9
9
|
create: (newsroomId: NewsroomId, payload: CreateRequest) => Promise<Category>;
|
|
10
|
-
update: (newsroomId: NewsroomId, categoryId: Category[
|
|
11
|
-
delete: (newsroomId: NewsroomId, categoryId: Category[
|
|
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[
|
|
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[
|
|
9
|
-
fallback?:
|
|
8
|
+
get: (newsroomId: NewsroomId, localeCode: CultureRef["code"], { fallback }?: {
|
|
9
|
+
fallback?: true | false;
|
|
10
10
|
}) => Promise<NewsroomLanguageSettings>;
|
|
11
|
-
enable: (newsroomId: NewsroomId, localeCode: CultureRef[
|
|
12
|
-
disable: (newsroomId: NewsroomId, localeCode: CultureRef[
|
|
13
|
-
replacement?:
|
|
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[
|
|
16
|
-
force?: boolean
|
|
15
|
+
update: (newsroomId: NewsroomId, localeCode: CultureRef["code"], payload: SettingsUpdateRequest, options?: {
|
|
16
|
+
force?: boolean;
|
|
17
17
|
}) => Promise<NewsroomLanguageSettings>;
|
|
18
|
-
makeDefault: (newsroomId: NewsroomId, localeCode: CultureRef[
|
|
19
|
-
switchDefaultLanguage: (newsroomId: NewsroomId, localeCode: CultureRef[
|
|
20
|
-
status:
|
|
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[
|
|
7
|
-
confirm: (newsroomId: Newsroom[
|
|
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[
|
|
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[
|
|
10
|
-
update: (newsroomId: NewsroomId, webhookId: NewsroomWebhook[
|
|
11
|
-
delete: (newsroomId: NewsroomId, webhookId: 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>;
|
|
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[
|
|
10
|
-
update: (senderId: SenderAddress[
|
|
11
|
-
delete: (senderId: SenderAddress[
|
|
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
|
};
|
|
@@ -14,110 +14,110 @@ type Exactly<Concrete, Abstract> = Concrete & Record<Exclude<keyof Concrete, key
|
|
|
14
14
|
type InferExtraFields<T> = T extends Required<IncludeOptions<infer I>> ? Pick<Story.ExtraFields, I> : unknown;
|
|
15
15
|
export type Client = ReturnType<typeof createClient>;
|
|
16
16
|
export declare function createClient(api: DeferredJobsApiClient): {
|
|
17
|
-
list: <Options extends ListOptions
|
|
18
|
-
search: <
|
|
17
|
+
list: <Options extends ListOptions>(options?: Exactly<Options, ListOptions>) => Promise<ListResponse<Story & InferExtraFields<Options>>>;
|
|
18
|
+
search: <Options extends SearchOptions>(options?: Exactly<Options, SearchOptions>) => Promise<ListResponse<Story & InferExtraFields<Options>>>;
|
|
19
19
|
get: {
|
|
20
|
-
<
|
|
21
|
-
formats?: Formats
|
|
22
|
-
}>(id: Story[
|
|
23
|
-
formats?: Formats
|
|
24
|
-
}>
|
|
25
|
-
<
|
|
26
|
-
formats?: Formats
|
|
27
|
-
}>(ids: Story[
|
|
28
|
-
formats?: Formats
|
|
29
|
-
}>
|
|
30
|
-
<
|
|
31
|
-
formats?: Formats
|
|
32
|
-
}>(id: Story[
|
|
33
|
-
formats?: Formats
|
|
34
|
-
}>
|
|
35
|
-
<
|
|
36
|
-
formats?: Formats
|
|
37
|
-
}>(ids: Story[
|
|
38
|
-
formats?: Formats
|
|
39
|
-
}>
|
|
20
|
+
<Options extends IncludeOptions & {
|
|
21
|
+
formats?: Formats;
|
|
22
|
+
}>(id: Story["uuid"], options?: Exactly<Options, IncludeOptions & {
|
|
23
|
+
formats?: Formats;
|
|
24
|
+
}>): Promise<ExtendedStory & InferExtraFields<Options>>;
|
|
25
|
+
<Options extends IncludeOptions & {
|
|
26
|
+
formats?: Formats;
|
|
27
|
+
}>(ids: Story["uuid"][], options?: Exactly<Options, IncludeOptions & {
|
|
28
|
+
formats?: Formats;
|
|
29
|
+
}>): Promise<(ExtendedStory & InferExtraFields<Options>)[]>;
|
|
30
|
+
<Options extends IncludeOptions & {
|
|
31
|
+
formats?: Formats;
|
|
32
|
+
}>(id: Story["id"] | Story["uuid"], options?: Exactly<Options, IncludeOptions & {
|
|
33
|
+
formats?: Formats;
|
|
34
|
+
}>): Promise<ExtendedStory & InferExtraFields<Options>>;
|
|
35
|
+
<Options extends IncludeOptions & {
|
|
36
|
+
formats?: Formats;
|
|
37
|
+
}>(ids: Story["id"][], options?: Exactly<Options, IncludeOptions & {
|
|
38
|
+
formats?: Formats;
|
|
39
|
+
}>): Promise<(ExtendedStory & InferExtraFields<Options>)[]>;
|
|
40
40
|
};
|
|
41
|
-
getBySlug: <
|
|
42
|
-
formats?: Formats
|
|
43
|
-
query?: Query
|
|
44
|
-
}>(slug: Story[
|
|
45
|
-
formats?: Formats
|
|
46
|
-
query?: Query
|
|
47
|
-
}>
|
|
48
|
-
create: <
|
|
49
|
-
formats?: Formats
|
|
50
|
-
force?: boolean
|
|
51
|
-
}>(payload: CreateRequest, options?: Exactly<
|
|
52
|
-
formats?: Formats
|
|
53
|
-
force?: boolean
|
|
54
|
-
}>
|
|
55
|
-
duplicate: <
|
|
56
|
-
formats?: Formats
|
|
57
|
-
}>(id: StoryId, options?: Exactly<
|
|
58
|
-
formats?: Formats
|
|
59
|
-
}>
|
|
60
|
-
translate: <
|
|
61
|
-
formats?: Formats
|
|
62
|
-
}>(id: StoryId, payload?: TranslateRequest, options?: Exactly<
|
|
63
|
-
formats?: Formats
|
|
64
|
-
}>
|
|
65
|
-
move: <
|
|
66
|
-
formats?: Formats
|
|
67
|
-
force?: boolean
|
|
68
|
-
}>(id: StoryId, payload: MoveRequest, options?: Exactly<
|
|
69
|
-
formats?: Formats
|
|
70
|
-
force?: boolean
|
|
71
|
-
}>
|
|
72
|
-
update: <
|
|
73
|
-
formats?: Formats
|
|
74
|
-
force?: boolean
|
|
75
|
-
}>(id: StoryId, payload: UpdateRequest, options?: Exactly<
|
|
76
|
-
formats?: Formats
|
|
77
|
-
force?: boolean
|
|
78
|
-
}>
|
|
79
|
-
autosave: <
|
|
80
|
-
formats?: Formats
|
|
81
|
-
}>(id: StoryId, payload: AutosaveRequest, options?: Exactly<
|
|
82
|
-
formats?: Formats
|
|
83
|
-
}>
|
|
84
|
-
revert: <
|
|
85
|
-
formats?: Formats
|
|
86
|
-
}>(id: StoryId, payload?: RevertRequest, options?: Exactly<
|
|
87
|
-
formats?: Formats
|
|
88
|
-
}>
|
|
89
|
-
publish: <
|
|
90
|
-
formats?: Formats
|
|
91
|
-
}>(id: StoryId, payload?: PublishRequest, options?: Exactly<
|
|
92
|
-
formats?: Formats
|
|
93
|
-
}>
|
|
94
|
-
unpublish: <
|
|
95
|
-
formats?: Formats
|
|
96
|
-
}>(id: StoryId, payload?: UnpublishRequest, options?: Exactly<
|
|
97
|
-
formats?: Formats
|
|
98
|
-
}>
|
|
99
|
-
schedule: <
|
|
100
|
-
formats?: Formats
|
|
101
|
-
}>(id: StoryId, payload?: ScheduleRequest, options?: Exactly<
|
|
102
|
-
formats?: Formats
|
|
103
|
-
}>
|
|
104
|
-
unschedule: <
|
|
105
|
-
formats?: Formats
|
|
106
|
-
}>(id: StoryId, payload?: UnscheduleRequest, options?: Exactly<
|
|
107
|
-
formats?: Formats
|
|
108
|
-
}>
|
|
109
|
-
pin: <
|
|
110
|
-
formats?: Formats
|
|
111
|
-
force?: boolean
|
|
112
|
-
}>(id: StoryId, options?: Exactly<
|
|
113
|
-
formats?: Formats
|
|
114
|
-
force?: boolean
|
|
115
|
-
}>
|
|
116
|
-
unpin: <
|
|
117
|
-
formats?: Formats
|
|
118
|
-
}>(id: StoryId, options?: Exactly<
|
|
119
|
-
formats?: Formats
|
|
120
|
-
}>
|
|
41
|
+
getBySlug: <Options extends IncludeOptions & {
|
|
42
|
+
formats?: Formats;
|
|
43
|
+
query?: Query;
|
|
44
|
+
}>(slug: Story["slug"], options?: Exactly<Options, IncludeOptions & {
|
|
45
|
+
formats?: Formats;
|
|
46
|
+
query?: Query;
|
|
47
|
+
}>) => Promise<ExtendedStory & InferExtraFields<Options>>;
|
|
48
|
+
create: <Options extends IncludeOptions & {
|
|
49
|
+
formats?: Formats;
|
|
50
|
+
force?: boolean;
|
|
51
|
+
}>(payload: CreateRequest, options?: Exactly<Options, IncludeOptions & {
|
|
52
|
+
formats?: Formats;
|
|
53
|
+
force?: boolean;
|
|
54
|
+
}>) => Promise<ExtendedStory & InferExtraFields<Options>>;
|
|
55
|
+
duplicate: <Options extends IncludeOptions & {
|
|
56
|
+
formats?: Formats;
|
|
57
|
+
}>(id: StoryId, options?: Exactly<Options, IncludeOptions & {
|
|
58
|
+
formats?: Formats;
|
|
59
|
+
}>) => Promise<ExtendedStory & InferExtraFields<Options>>;
|
|
60
|
+
translate: <Options extends IncludeOptions & {
|
|
61
|
+
formats?: Formats;
|
|
62
|
+
}>(id: StoryId, payload?: TranslateRequest, options?: Exactly<Options, IncludeOptions & {
|
|
63
|
+
formats?: Formats;
|
|
64
|
+
}>) => Promise<ExtendedStory & InferExtraFields<Options>>;
|
|
65
|
+
move: <Options extends IncludeOptions & {
|
|
66
|
+
formats?: Formats;
|
|
67
|
+
force?: boolean;
|
|
68
|
+
}>(id: StoryId, payload: MoveRequest, options?: Exactly<Options, IncludeOptions & {
|
|
69
|
+
formats?: Formats;
|
|
70
|
+
force?: boolean;
|
|
71
|
+
}>) => Promise<ChangeNewsroomSuccessResponse<ExtendedStory & InferExtraFields<Options>> | ChangeNewsroomUnsafeResponse>;
|
|
72
|
+
update: <Options extends IncludeOptions & {
|
|
73
|
+
formats?: Formats;
|
|
74
|
+
force?: boolean;
|
|
75
|
+
}>(id: StoryId, payload: UpdateRequest, options?: Exactly<Options, IncludeOptions & {
|
|
76
|
+
formats?: Formats;
|
|
77
|
+
force?: boolean;
|
|
78
|
+
}>) => Promise<ExtendedStory & InferExtraFields<Options>>;
|
|
79
|
+
autosave: <Options extends IncludeOptions & {
|
|
80
|
+
formats?: Formats;
|
|
81
|
+
}>(id: StoryId, payload: AutosaveRequest, options?: Exactly<Options, IncludeOptions & {
|
|
82
|
+
formats?: Formats;
|
|
83
|
+
}>) => Promise<ExtendedStory & InferExtraFields<Options>>;
|
|
84
|
+
revert: <Options extends IncludeOptions & {
|
|
85
|
+
formats?: Formats;
|
|
86
|
+
}>(id: StoryId, payload?: RevertRequest, options?: Exactly<Options, IncludeOptions & {
|
|
87
|
+
formats?: Formats;
|
|
88
|
+
}>) => Promise<ExtendedStory & InferExtraFields<Options>>;
|
|
89
|
+
publish: <Options extends IncludeOptions & {
|
|
90
|
+
formats?: Formats;
|
|
91
|
+
}>(id: StoryId, payload?: PublishRequest, options?: Exactly<Options, IncludeOptions & {
|
|
92
|
+
formats?: Formats;
|
|
93
|
+
}>) => Promise<ExtendedStory & InferExtraFields<Options>>;
|
|
94
|
+
unpublish: <Options extends IncludeOptions & {
|
|
95
|
+
formats?: Formats;
|
|
96
|
+
}>(id: StoryId, payload?: UnpublishRequest, options?: Exactly<Options, IncludeOptions & {
|
|
97
|
+
formats?: Formats;
|
|
98
|
+
}>) => Promise<ExtendedStory & InferExtraFields<Options>>;
|
|
99
|
+
schedule: <Options extends IncludeOptions & {
|
|
100
|
+
formats?: Formats;
|
|
101
|
+
}>(id: StoryId, payload?: ScheduleRequest, options?: Exactly<Options, IncludeOptions & {
|
|
102
|
+
formats?: Formats;
|
|
103
|
+
}>) => Promise<ExtendedStory & InferExtraFields<Options>>;
|
|
104
|
+
unschedule: <Options extends IncludeOptions & {
|
|
105
|
+
formats?: Formats;
|
|
106
|
+
}>(id: StoryId, payload?: UnscheduleRequest, options?: Exactly<Options, IncludeOptions & {
|
|
107
|
+
formats?: Formats;
|
|
108
|
+
}>) => Promise<ExtendedStory & InferExtraFields<Options>>;
|
|
109
|
+
pin: <Options extends IncludeOptions & {
|
|
110
|
+
formats?: Formats;
|
|
111
|
+
force?: boolean;
|
|
112
|
+
}>(id: StoryId, options?: Exactly<Options, IncludeOptions & {
|
|
113
|
+
formats?: Formats;
|
|
114
|
+
force?: boolean;
|
|
115
|
+
}>) => Promise<ExtendedStory & InferExtraFields<Options>>;
|
|
116
|
+
unpin: <Options extends IncludeOptions & {
|
|
117
|
+
formats?: Formats;
|
|
118
|
+
}>(id: StoryId, options?: Exactly<Options, IncludeOptions & {
|
|
119
|
+
formats?: Formats;
|
|
120
|
+
}>) => Promise<ExtendedStory & InferExtraFields<Options>>;
|
|
121
121
|
delete: (id: StoryId) => Promise<void>;
|
|
122
122
|
preview: (id: StoryId, options?: PreviewOptions) => Promise<PreviewResponse>;
|
|
123
123
|
};
|
|
@@ -254,6 +254,8 @@ export interface ChangeNewsroomUnsafeResponse {
|
|
|
254
254
|
message: string;
|
|
255
255
|
warnings: ChangeNewsroomWarning[];
|
|
256
256
|
}
|
|
257
|
-
|
|
258
|
-
|
|
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[
|
|
11
|
-
updateLicenseUnsubscribeDetails: (subscriptionId: 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 {};
|
package/dist/endpoints/index.cjs
CHANGED
|
@@ -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 &&
|
|
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(
|
|
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'
|
|
@@ -6,6 +6,14 @@ Object.defineProperty(exports, "__esModule", {
|
|
|
6
6
|
exports.EmailRecipient = void 0;
|
|
7
7
|
let EmailRecipient = exports.EmailRecipient = void 0;
|
|
8
8
|
(function (_EmailRecipient) {
|
|
9
|
+
let Problem = /*#__PURE__*/function (Problem) {
|
|
10
|
+
Problem["BOUNCED"] = "bounced";
|
|
11
|
+
Problem["UNSUBSCRIBED"] = "unsubscribed";
|
|
12
|
+
Problem["UNSUBSCRIBED_FROM_ALL_COMMUNICATIONS"] = "unsubscribed_from_all_communications";
|
|
13
|
+
Problem["DUPLICATE"] = "duplicate";
|
|
14
|
+
return Problem;
|
|
15
|
+
}({});
|
|
16
|
+
_EmailRecipient.Problem = Problem;
|
|
9
17
|
let EmailAddressStatus = /*#__PURE__*/function (EmailAddressStatus) {
|
|
10
18
|
EmailAddressStatus["OK"] = "ok";
|
|
11
19
|
EmailAddressStatus["BOUNCED"] = "bounced";
|
|
@@ -26,8 +26,18 @@ export interface EmailRecipient extends EmailRecipientRef {
|
|
|
26
26
|
* List of all contact email addresses with their statuses in context of the current campaign.
|
|
27
27
|
*/
|
|
28
28
|
email_addresses: EmailRecipient.EmailAddressRecord[];
|
|
29
|
+
/**
|
|
30
|
+
* List of known problems detected for the recipient with its currently selected email address.
|
|
31
|
+
*/
|
|
32
|
+
problems: EmailRecipient.Problem[];
|
|
29
33
|
}
|
|
30
34
|
export declare namespace EmailRecipient {
|
|
35
|
+
enum Problem {
|
|
36
|
+
BOUNCED = "bounced",
|
|
37
|
+
UNSUBSCRIBED = "unsubscribed",
|
|
38
|
+
UNSUBSCRIBED_FROM_ALL_COMMUNICATIONS = "unsubscribed_from_all_communications",
|
|
39
|
+
DUPLICATE = "duplicate"
|
|
40
|
+
}
|
|
31
41
|
enum EmailAddressStatus {
|
|
32
42
|
OK = "ok",
|
|
33
43
|
BOUNCED = "bounced",
|
|
@@ -1,5 +1,13 @@
|
|
|
1
1
|
export let EmailRecipient;
|
|
2
2
|
(function (_EmailRecipient) {
|
|
3
|
+
let Problem = /*#__PURE__*/function (Problem) {
|
|
4
|
+
Problem["BOUNCED"] = "bounced";
|
|
5
|
+
Problem["UNSUBSCRIBED"] = "unsubscribed";
|
|
6
|
+
Problem["UNSUBSCRIBED_FROM_ALL_COMMUNICATIONS"] = "unsubscribed_from_all_communications";
|
|
7
|
+
Problem["DUPLICATE"] = "duplicate";
|
|
8
|
+
return Problem;
|
|
9
|
+
}({});
|
|
10
|
+
_EmailRecipient.Problem = Problem;
|
|
3
11
|
let EmailAddressStatus = /*#__PURE__*/function (EmailAddressStatus) {
|
|
4
12
|
EmailAddressStatus["OK"] = "ok";
|
|
5
13
|
EmailAddressStatus["BOUNCED"] = "bounced";
|
package/dist/types/Newsroom.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import type { UploadedImage } from '@prezly/uploads';
|
|
2
2
|
import type { CultureRef } from './Culture';
|
|
3
|
-
import type { NewroomThemeRef } from './NewsroomTheme';
|
|
3
|
+
import type { NewroomThemeRef, NewsroomThemePreset } from './NewsroomTheme';
|
|
4
4
|
export interface NewsroomRef {
|
|
5
5
|
uuid: string;
|
|
6
6
|
/**
|
|
@@ -133,6 +133,7 @@ export interface Newsroom extends NewsroomRef {
|
|
|
133
133
|
visits_last_7_days: number | null;
|
|
134
134
|
visits_last_7_days_previous: number | null;
|
|
135
135
|
};
|
|
136
|
+
active_theme_preset: NewsroomThemePreset;
|
|
136
137
|
}
|
|
137
138
|
export declare namespace Newsroom {
|
|
138
139
|
enum Status {
|