@prezly/sdk 26.1.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.
- 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.cjs +11 -1
- package/dist/endpoints/NewsroomThemes/Client.d.ts +2 -1
- package/dist/endpoints/NewsroomThemes/Client.js +11 -1
- package/dist/endpoints/NewsroomWebhooks/Client.d.ts +3 -3
- package/dist/endpoints/Newsrooms/Client.d.ts +11 -11
- 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 +34 -2
- package/dist/endpoints/Subscriptions/Client.d.ts +2 -2
- 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 = "26.
|
|
7
|
+
const VERSION = "26.2.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,17 +6,17 @@ 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"], options?: DuplicateOptions) => 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
|
bulkDelete: (payload: BulkDeletePayload) => ProgressPromise<{
|
|
21
21
|
records_deleted_number: number;
|
|
22
22
|
}>;
|
|
@@ -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
|
};
|
|
@@ -36,10 +36,20 @@ function createClient(api) {
|
|
|
36
36
|
} = await api.get(url);
|
|
37
37
|
return themes;
|
|
38
38
|
}
|
|
39
|
+
async function update(newsroomId, themeId, settings) {
|
|
40
|
+
const url = _routing.routing.newsroomThemesUrl.replace(':newsroom_id', String(newsroomId));
|
|
41
|
+
const {
|
|
42
|
+
theme
|
|
43
|
+
} = await api.patch(`${url}/${themeId}`, {
|
|
44
|
+
payload: settings
|
|
45
|
+
});
|
|
46
|
+
return theme;
|
|
47
|
+
}
|
|
39
48
|
return {
|
|
40
49
|
apply,
|
|
41
50
|
get,
|
|
42
51
|
getActive,
|
|
43
|
-
list
|
|
52
|
+
list,
|
|
53
|
+
update
|
|
44
54
|
};
|
|
45
55
|
}
|
|
@@ -4,9 +4,10 @@ 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[]>;
|
|
11
|
+
update: (newsroomId: NewsroomId, themeId: NewsroomThemeId, settings: NewsroomThemePreset["settings"]) => Promise<NewsroomThemePreset>;
|
|
11
12
|
};
|
|
12
13
|
export {};
|
|
@@ -30,10 +30,20 @@ export function createClient(api) {
|
|
|
30
30
|
} = await api.get(url);
|
|
31
31
|
return themes;
|
|
32
32
|
}
|
|
33
|
+
async function update(newsroomId, themeId, settings) {
|
|
34
|
+
const url = routing.newsroomThemesUrl.replace(':newsroom_id', String(newsroomId));
|
|
35
|
+
const {
|
|
36
|
+
theme
|
|
37
|
+
} = await api.patch(`${url}/${themeId}`, {
|
|
38
|
+
payload: settings
|
|
39
|
+
});
|
|
40
|
+
return theme;
|
|
41
|
+
}
|
|
33
42
|
return {
|
|
34
43
|
apply,
|
|
35
44
|
get,
|
|
36
45
|
getActive,
|
|
37
|
-
list
|
|
46
|
+
list,
|
|
47
|
+
update
|
|
38
48
|
};
|
|
39
49
|
}
|
|
@@ -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 {};
|
|
@@ -9,16 +9,16 @@ type Exactly<Concrete, Abstract> = Concrete & Record<Exclude<keyof Concrete, key
|
|
|
9
9
|
type InferExtraFields<T> = T extends Required<IncludeOptions<infer I>> ? Pick<Newsroom.ExtraFields, I> : unknown;
|
|
10
10
|
export type Client = ReturnType<typeof createClient>;
|
|
11
11
|
export declare function createClient(api: DeferredJobsApiClient): {
|
|
12
|
-
list: <Options extends ListOptions
|
|
13
|
-
search: <
|
|
14
|
-
get: <
|
|
15
|
-
create: <
|
|
16
|
-
update: <
|
|
17
|
-
archive: <
|
|
18
|
-
unarchive: <
|
|
19
|
-
delete: (id: Newsroom[
|
|
20
|
-
takeOnline: <
|
|
21
|
-
takeOffline: <
|
|
22
|
-
convertToHub: <
|
|
12
|
+
list: <Options extends ListOptions>(options?: Exactly<Options, ListOptions>) => Promise<ListResponse<Newsroom & InferExtraFields<Options>>>;
|
|
13
|
+
search: <Options extends SearchOptions>(options?: Exactly<Options, SearchOptions>) => Promise<ListResponse<Newsroom & InferExtraFields<Options>>>;
|
|
14
|
+
get: <Options extends IncludeOptions>(id: Newsroom["uuid"] | Newsroom["id"], options?: Exactly<Options, IncludeOptions>) => Promise<Newsroom & InferExtraFields<Options>>;
|
|
15
|
+
create: <Options extends IncludeOptions>(payload: CreateRequest, options?: Exactly<Options, IncludeOptions>) => Promise<Newsroom & InferExtraFields<Options>>;
|
|
16
|
+
update: <Options extends IncludeOptions>(id: Newsroom["uuid"] | Newsroom["id"], payload: UpdateRequest, options?: Exactly<Options, IncludeOptions>) => Promise<Newsroom & InferExtraFields<Options>>;
|
|
17
|
+
archive: <Options extends IncludeOptions>(id: Newsroom["uuid"] | Newsroom["id"], options?: Exactly<Options, IncludeOptions>) => Promise<Newsroom & InferExtraFields<Options>>;
|
|
18
|
+
unarchive: <Options extends IncludeOptions>(id: Newsroom["uuid"] | Newsroom["id"], options?: Exactly<Options, IncludeOptions>) => Promise<Newsroom & InferExtraFields<Options>>;
|
|
19
|
+
delete: (id: Newsroom["uuid"] | Newsroom["id"]) => Promise<void>;
|
|
20
|
+
takeOnline: <Options extends IncludeOptions>(id: Newsroom["uuid"] | Newsroom["id"], options?: Exactly<Options, IncludeOptions>) => Promise<Newsroom & InferExtraFields<Options>>;
|
|
21
|
+
takeOffline: <Options extends IncludeOptions>(id: Newsroom["uuid"] | Newsroom["id"], options?: Exactly<Options, IncludeOptions>) => Promise<Newsroom & InferExtraFields<Options>>;
|
|
22
|
+
convertToHub: <Options extends IncludeOptions>(id: Newsroom["uuid"] | Newsroom["id"], options?: Exactly<Options, IncludeOptions>) => Promise<Newsroom & InferExtraFields<Options>>;
|
|
23
23
|
};
|
|
24
24
|
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
|
};
|
|
@@ -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
|
|
19
|
-
search: <
|
|
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
|
-
<
|
|
22
|
-
formats?: Formats
|
|
23
|
-
}>(id: Story[
|
|
24
|
-
formats?: Formats
|
|
25
|
-
}>
|
|
26
|
-
<
|
|
27
|
-
formats?: Formats
|
|
28
|
-
}>(ids: Story[
|
|
29
|
-
formats?: Formats
|
|
30
|
-
}>
|
|
31
|
-
<
|
|
32
|
-
formats?: Formats
|
|
33
|
-
}>(id: Story[
|
|
34
|
-
formats?: Formats
|
|
35
|
-
}>
|
|
36
|
-
<
|
|
37
|
-
formats?: Formats
|
|
38
|
-
}>(ids: Story[
|
|
39
|
-
formats?: Formats
|
|
40
|
-
}>
|
|
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: <
|
|
43
|
-
formats?: Formats
|
|
44
|
-
query?: Query
|
|
45
|
-
}>(slug: Story[
|
|
46
|
-
formats?: Formats
|
|
47
|
-
query?: Query
|
|
48
|
-
}>
|
|
49
|
-
create: <
|
|
50
|
-
formats?: Formats
|
|
51
|
-
force?: boolean
|
|
52
|
-
}>(payload: CreateRequest, options?: Exactly<
|
|
53
|
-
formats?: Formats
|
|
54
|
-
force?: boolean
|
|
55
|
-
}>
|
|
56
|
-
duplicate: <
|
|
57
|
-
formats?: Formats
|
|
58
|
-
}>(id: StoryId, options?: Exactly<
|
|
59
|
-
formats?: Formats
|
|
60
|
-
}>
|
|
61
|
-
translate: <
|
|
62
|
-
formats?: Formats
|
|
63
|
-
}>(id: StoryId, payload?: TranslateRequest, options?: Exactly<
|
|
64
|
-
formats?: Formats
|
|
65
|
-
}>
|
|
66
|
-
move: <
|
|
67
|
-
formats?: Formats
|
|
68
|
-
force?: boolean
|
|
69
|
-
}>(id: StoryId, payload: MoveRequest, options?: Exactly<
|
|
70
|
-
formats?: Formats
|
|
71
|
-
force?: boolean
|
|
72
|
-
}>
|
|
73
|
-
update: <
|
|
74
|
-
formats?: Formats
|
|
75
|
-
force?: boolean
|
|
76
|
-
}>(id: StoryId, payload: UpdateRequest, options?: Exactly<
|
|
77
|
-
formats?: Formats
|
|
78
|
-
force?: boolean
|
|
79
|
-
}>
|
|
80
|
-
autosave: <
|
|
81
|
-
formats?: Formats
|
|
82
|
-
}>(id: StoryId, payload: AutosaveRequest, options?: Exactly<
|
|
83
|
-
formats?: Formats
|
|
84
|
-
}>
|
|
85
|
-
revert: <
|
|
86
|
-
formats?: Formats
|
|
87
|
-
}>(id: StoryId, payload?: RevertRequest, options?: Exactly<
|
|
88
|
-
formats?: Formats
|
|
89
|
-
}>
|
|
90
|
-
publish: <
|
|
91
|
-
formats?: Formats
|
|
92
|
-
}>(id: StoryId, payload?: PublishRequest, options?: Exactly<
|
|
93
|
-
formats?: Formats
|
|
94
|
-
}>
|
|
95
|
-
unpublish: <
|
|
96
|
-
formats?: Formats
|
|
97
|
-
}>(id: StoryId, payload?: UnpublishRequest, options?: Exactly<
|
|
98
|
-
formats?: Formats
|
|
99
|
-
}>
|
|
100
|
-
schedule: <
|
|
101
|
-
formats?: Formats
|
|
102
|
-
}>(id: StoryId, payload?: ScheduleRequest, options?: Exactly<
|
|
103
|
-
formats?: Formats
|
|
104
|
-
}>
|
|
105
|
-
unschedule: <
|
|
106
|
-
formats?: Formats
|
|
107
|
-
}>(id: StoryId, payload?: UnscheduleRequest, options?: Exactly<
|
|
108
|
-
formats?: Formats
|
|
109
|
-
}>
|
|
110
|
-
pin: <
|
|
111
|
-
formats?: Formats
|
|
112
|
-
force?: boolean
|
|
113
|
-
}>(id: StoryId, options?: Exactly<
|
|
114
|
-
formats?: Formats
|
|
115
|
-
force?: boolean
|
|
116
|
-
}>
|
|
117
|
-
unpin: <
|
|
118
|
-
formats?: Formats
|
|
119
|
-
}>(id: StoryId, options?: Exactly<
|
|
120
|
-
formats?: Formats
|
|
121
|
-
}>
|
|
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;
|
|
@@ -254,6 +254,38 @@ export interface ChangeNewsroomUnsafeResponse {
|
|
|
254
254
|
message: string;
|
|
255
255
|
warnings: ChangeNewsroomWarning[];
|
|
256
256
|
}
|
|
257
|
-
|
|
258
|
-
|
|
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 {};
|
|
@@ -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 {};
|