@prezly/sdk 23.20.0 → 24.1.0

package/dist/api/ApiClient.d.ts

@@ -6,8 +6,8 @@ export interface Options {
 export type ApiClient = ReturnType<typeof createApiClient>;
 export declare function createApiClient(http: HttpClient, { accessToken, headers }: Options): {
     get: <V = any>(url: string, { headers, query }?: Params) => Promise<ApiResponse<V>>;
-    post: <V_1 = any>(url: string, { headers, payload, query }?: ParamsWithPayload) => Promise<ApiResponse<V_1>>;
-    put: <V_2 = any>(url: string, { headers, payload, query }?: ParamsWithPayload) => Promise<ApiResponse<V_2>>;
-    patch: <V_3 = any>(url: string, { headers, payload, query }?: ParamsWithPayload) => Promise<ApiResponse<V_3>>;
-    delete: <V_4 = any>(url: string, { headers, payload, query }?: ParamsWithPayload) => Promise<ApiResponse<V_4>>;
+    post: <V = any>(url: string, { headers, payload, query }?: ParamsWithPayload) => Promise<ApiResponse<V>>;
+    put: <V = any>(url: string, { headers, payload, query }?: ParamsWithPayload) => Promise<ApiResponse<V>>;
+    patch: <V = any>(url: string, { headers, payload, query }?: ParamsWithPayload) => Promise<ApiResponse<V>>;
+    delete: <V = any>(url: string, { headers, payload, query }?: ParamsWithPayload) => Promise<ApiResponse<V>>;
 };

package/dist/api/DeferredJobsApiClient.d.ts

@@ -4,8 +4,8 @@ import type { ApiClient } from './ApiClient';
 export type DeferredJobsApiClient = ReturnType<typeof createDeferredJobsApiClient>;
 export declare function createDeferredJobsApiClient(api: ApiClient): {
     get: <V = any, P = any>(url: string, { headers, query }?: Params) => ProgressPromise<V, P>;
-    post: <V_1 = any, P_1 = any>(url: string, { headers, payload, query }?: ParamsWithPayload) => ProgressPromise<V_1, P_1>;
-    put: <V_2 = any, P_2 = any>(url: string, { headers, payload, query }?: ParamsWithPayload) => ProgressPromise<V_2, P_2>;
-    patch: <V_3 = any, P_3 = any>(url: string, { headers, payload, query }?: ParamsWithPayload) => ProgressPromise<V_3, P_3>;
-    delete: <V_4 = any, P_4 = any>(url: string, { headers, payload, query }?: ParamsWithPayload) => ProgressPromise<V_4, P_4>;
+    post: <V = any, P = any>(url: string, { headers, payload, query }?: ParamsWithPayload) => ProgressPromise<V, P>;
+    put: <V = any, P = any>(url: string, { headers, payload, query }?: ParamsWithPayload) => ProgressPromise<V, P>;
+    patch: <V = any, P = any>(url: string, { headers, payload, query }?: ParamsWithPayload) => ProgressPromise<V, P>;
+    delete: <V = any, P = any>(url: string, { headers, payload, query }?: ParamsWithPayload) => ProgressPromise<V, P>;
 };

package/dist/api/constants.cjs

@@ -4,6 +4,6 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.DEFAULT_USER_AGENT = void 0;
-const VERSION = "23.19.0";
+const VERSION = "24.0.0";
 const URL = 'https://github.com/prezly/javascript-sdk';
 const DEFAULT_USER_AGENT = exports.DEFAULT_USER_AGENT = `prezly-javascript-sdk/${VERSION} (+${URL})`;

package/dist/api/constants.js

@@ -1,3 +1,3 @@
-const VERSION = "23.19.0";
+const VERSION = "24.0.0";
 const URL = 'https://github.com/prezly/javascript-sdk';
 export const DEFAULT_USER_AGENT = `prezly-javascript-sdk/${VERSION} (+${URL})`;

package/dist/endpoints/Accounts/Client.d.ts

@@ -5,5 +5,5 @@ export type Client = ReturnType<typeof createClient>;
 export declare function createClient(api: DeferredJobsApiClient): {
     list: () => Promise<ListResponse>;
     create: (payload: CreateRequest) => Promise<CreateResponse>;
-    update: (id: UserAccount['id'], payload: UpdateRequest) => Promise<UpdateResponse>;
+    update: (id: UserAccount["id"], payload: UpdateRequest) => Promise<UpdateResponse>;
 };

package/dist/endpoints/CampaignRecipients/Client.d.ts

@@ -22,6 +22,6 @@ export declare function createClient(api: DeferredJobsApiClient): {
     removeRecipient: (campaignId: CampaignId, recipientId: EmailRecipientId) => Promise<RecipientsOperationResponse>;
     removeRecipients: (campaignId: CampaignId, params?: {
         query: Query;
-    } | undefined) => Promise<RecipientsOperationResponse>;
+    }) => Promise<RecipientsOperationResponse>;
 };
 export {};

package/dist/endpoints/Campaigns/Client.d.ts

@@ -6,15 +6,15 @@ export type Client = ReturnType<typeof createClient>;
 export declare function createClient(api: DeferredJobsApiClient): {
     list: (options: SearchOptions) => Promise<ListResponse>;
     search: (options: SearchOptions) => Promise<ListResponse>;
-    get: (id: Campaign['id']) => Promise<CampaignResponse>;
-    duplicate: (id: Campaign['id']) => Promise<CampaignResponse>;
-    test: (id: Campaign['id'], emails: string[]) => Promise<void>;
-    send: (id: Campaign['id']) => Promise<void>;
-    schedule: (id: Campaign['id'], sendAt: Date) => Promise<Campaign>;
-    unschedule: (id: Campaign['id']) => Promise<Campaign>;
+    get: (id: Campaign["id"]) => Promise<CampaignResponse>;
+    duplicate: (id: Campaign["id"]) => Promise<CampaignResponse>;
+    test: (id: Campaign["id"], emails: string[]) => Promise<void>;
+    send: (id: Campaign["id"]) => Promise<void>;
+    schedule: (id: Campaign["id"], sendAt: Date) => Promise<Campaign>;
+    unschedule: (id: Campaign["id"]) => Promise<Campaign>;
     create: (payload: CreateRequest) => ProgressPromise<RecipientsOperationResponse, {
         recipients_number: number;
     }>;
-    update: (id: Campaign['id'], payload: UpdateRequest) => Promise<CampaignResponse>;
-    delete: (id: Campaign['id']) => Promise<void>;
+    update: (id: Campaign["id"], payload: UpdateRequest) => Promise<CampaignResponse>;
+    delete: (id: Campaign["id"]) => Promise<void>;
 };

package/dist/endpoints/ContactTags/Client.d.ts

@@ -5,14 +5,14 @@ export type Client = ReturnType<typeof createClient>;
 export declare function createClient(api: DeferredJobsApiClient): {
     list: (options?: ListOptions) => Promise<ListResponse>;
     search: (options?: SearchOptions) => Promise<SearchResponse>;
-    get: (id: ContactTag['id']) => Promise<ContactTag>;
+    get: (id: ContactTag["id"]) => Promise<ContactTag>;
     create: (payload: CreateRequest, { force }?: CreateOptions) => Promise<CreateResponse>;
-    update: (id: Contact['id'], payload: UpdateRequest, { force }?: UpdateOptions) => Promise<UpdateResponse>;
+    update: (id: Contact["id"], payload: UpdateRequest, { force }?: UpdateOptions) => Promise<UpdateResponse>;
     merge: ({ name, tags }: MergeRequest) => Promise<MergeResponse>;
-    delete: (id: ContactTag['id']) => Promise<{
+    delete: (id: ContactTag["id"]) => Promise<{
         deleted: number[];
     }>;
-    deleteMany: (ids: ContactTag['id'][]) => Promise<{
+    deleteMany: (ids: ContactTag["id"][]) => Promise<{
         deleted: number[];
     }>;
     deleteUnused: () => Promise<{

package/dist/endpoints/Contacts/Client.d.ts

@@ -6,14 +6,14 @@ export type Client = ReturnType<typeof createClient>;
 export declare function createClient(api: DeferredJobsApiClient): {
     list: (options?: ListOptions) => Promise<ListResponse>;
     search: (options?: SearchOptions) => Promise<SearchResponse>;
-    get: (id: Contact['id']) => Promise<Contact>;
-    getMany: (ids: Contact['id'][]) => Promise<Contact[]>;
+    get: (id: Contact["id"]) => Promise<Contact>;
+    getMany: (ids: Contact["id"][]) => Promise<Contact[]>;
     create: (payload: CreateRequest) => Promise<Contact>;
-    update: (id: Contact['id'], payload: UpdateRequest) => Promise<Contact>;
-    tag: (id: Contact['id'], tags: ContactTag.Identifier[]) => Promise<Contact>;
-    untag: (id: Contact['id'], tags: ContactTag.Identifier[]) => Promise<Contact>;
+    update: (id: Contact["id"], payload: UpdateRequest) => Promise<Contact>;
+    tag: (id: Contact["id"], tags: ContactTag.Identifier[]) => Promise<Contact>;
+    untag: (id: Contact["id"], tags: ContactTag.Identifier[]) => Promise<Contact>;
     bulkTag: (selector: BulkSelector, tags: ContactTag.Identifier[]) => ProgressPromise<undefined>;
     bulkUntag: (selector: BulkSelector, tags: ContactTag.Identifier[]) => ProgressPromise<undefined>;
-    delete: (id: Contact['id']) => Promise<void>;
+    delete: (id: Contact["id"]) => Promise<void>;
     bulkDelete: (selector: BulkSelector) => Promise<BulkDeleteResponse>;
 };

package/dist/endpoints/ContactsExports/Client.d.ts

@@ -5,9 +5,9 @@ export type Client = ReturnType<typeof createClient>;
 export declare function createClient(api: DeferredJobsApiClient): {
     list: (options: ListOptions) => Promise<ListResponse>;
     search: (options: SearchOptions) => Promise<ListResponse>;
-    get: (uuid: ContactsExport['uuid']) => Promise<ContactsExport>;
+    get: (uuid: ContactsExport["uuid"]) => Promise<ContactsExport>;
     create: (selector: ContactsBulkSelector) => Promise<ContactsExport>;
-    download: (uuid: ContactsExport['uuid']) => Promise<{
+    download: (uuid: ContactsExport["uuid"]) => Promise<{
         downloadUrl: string;
     }>;
 };

package/dist/endpoints/CoverageIntegrations/Client.d.ts

@@ -14,9 +14,9 @@ export declare function createClient(api: DeferredJobsApiClient): {
     delete: (integrationId: IntegrationId) => Promise<void>;
     listRuns: (integrationId: IntegrationId, options?: ListRunsOptions) => Promise<ListRunsResponse>;
     preview: (provider: CoverageEntry.Provider, options: {
-        input: CoverageIntegration['input'];
-        oldest?: number | undefined;
-        limit?: number | undefined;
+        input: CoverageIntegration["input"];
+        oldest?: number;
+        limit?: number;
     }) => Promise<PreviewResponse>;
 };
 export {};

package/dist/endpoints/NewsroomCategories/Client.d.ts

@@ -5,9 +5,9 @@ type NewsroomId = Newsroom['uuid'] | Newsroom['id'];
 export type Client = ReturnType<typeof createClient>;
 export declare function createClient(api: DeferredJobsApiClient): {
     list: (newsroomId: NewsroomId, { sortOrder }?: ListOptions) => Promise<Category[]>;
-    get: (newsroomId: NewsroomId, categoryId: Category['id']) => Promise<Category>;
+    get: (newsroomId: NewsroomId, categoryId: Category["id"]) => Promise<Category>;
     create: (newsroomId: NewsroomId, payload: CreateRequest) => Promise<Category>;
-    update: (newsroomId: NewsroomId, categoryId: Category['id'], payload: UpdateRequest) => Promise<Category>;
-    delete: (newsroomId: NewsroomId, categoryId: Category['id']) => Promise<void>;
+    update: (newsroomId: NewsroomId, categoryId: Category["id"], payload: UpdateRequest) => Promise<Category>;
+    delete: (newsroomId: NewsroomId, categoryId: Category["id"]) => Promise<void>;
 };
 export {};

package/dist/endpoints/NewsroomGalleries/Client.d.ts

@@ -5,7 +5,7 @@ type NewsroomId = Newsroom['uuid'] | Newsroom['id'];
 type GalleryId = NewsroomGallery['uuid'] | NewsroomGallery['id'];
 export type Client = ReturnType<typeof createClient>;
 export declare function createClient(api: DeferredJobsApiClient): {
-    get: (newsroomId: NewsroomId, id: NewsroomGallery['uuid']) => Promise<NewsroomGallery>;
+    get: (newsroomId: NewsroomId, id: NewsroomGallery["uuid"]) => Promise<NewsroomGallery>;
     list: (newsroomId: NewsroomId, options?: ListOptions) => Promise<ListResponse>;
     search: (newsroomId: NewsroomId, options?: SearchOptions) => Promise<ListResponse>;
     order: (newsroomId: NewsroomId, payload: ReorderRequest) => Promise<void>;

package/dist/endpoints/NewsroomLanguages/Client.d.ts

@@ -5,19 +5,19 @@ type NewsroomId = Newsroom['uuid'] | Newsroom['id'];
 export type Client = ReturnType<typeof createClient>;
 export declare function createClient(api: DeferredJobsApiClient): {
     list: (newsroomId: NewsroomId, { sortOrder }?: ListOptions) => Promise<ListResponse>;
-    get: (newsroomId: NewsroomId, localeCode: CultureRef['code'], { fallback }?: {
-        fallback?: boolean | undefined;
+    get: (newsroomId: NewsroomId, localeCode: CultureRef["code"], { fallback }?: {
+        fallback?: true | false;
     }) => Promise<NewsroomLanguageSettings>;
-    enable: (newsroomId: NewsroomId, localeCode: CultureRef['code'], payload?: SettingsUpdateRequest) => Promise<NewsroomLanguageSettings>;
-    disable: (newsroomId: NewsroomId, localeCode: CultureRef['code'], { replacement }: {
-        replacement?: import("../../types").Culture.Code | undefined;
+    enable: (newsroomId: NewsroomId, localeCode: CultureRef["code"], payload?: SettingsUpdateRequest) => Promise<NewsroomLanguageSettings>;
+    disable: (newsroomId: NewsroomId, localeCode: CultureRef["code"], { replacement }: {
+        replacement?: CultureRef["code"];
     }) => Promise<void>;
-    update: (newsroomId: NewsroomId, localeCode: CultureRef['code'], payload: SettingsUpdateRequest, options?: {
-        force?: boolean | undefined;
+    update: (newsroomId: NewsroomId, localeCode: CultureRef["code"], payload: SettingsUpdateRequest, options?: {
+        force?: boolean;
     }) => Promise<NewsroomLanguageSettings>;
-    makeDefault: (newsroomId: NewsroomId, localeCode: CultureRef['code']) => Promise<NewsroomLanguageSettings>;
-    switchDefaultLanguage: (newsroomId: NewsroomId, localeCode: CultureRef['code'], newLocaleCode: CultureRef['code'], forceUnsafeOperation?: boolean) => Promise<{
-        status: 'success';
+    makeDefault: (newsroomId: NewsroomId, localeCode: CultureRef["code"]) => Promise<NewsroomLanguageSettings>;
+    switchDefaultLanguage: (newsroomId: NewsroomId, localeCode: CultureRef["code"], newLocaleCode: CultureRef["code"], forceUnsafeOperation?: boolean) => Promise<{
+        status: "success";
         language: NewsroomLanguageSettings;
     } | UnsafeUpdateErrorResponse>;
 };

package/dist/endpoints/NewsroomPrivacyRequests/Client.d.ts

@@ -3,6 +3,6 @@ import type { Newsroom, PrivacyRequest } from '../../types';
 import type { DeletePrivacyRequestCreateRequest, ExportPrivacyRequestCreateRequest, CorrectPrivacyRequestCreateRequest, OtherPrivacyRequestCreateRequest } from './types';
 export type Client = ReturnType<typeof createClient>;
 export declare function createClient(api: DeferredJobsApiClient): {
-    create: (newsroomId: Newsroom['uuid'], payload: DeletePrivacyRequestCreateRequest | ExportPrivacyRequestCreateRequest | CorrectPrivacyRequestCreateRequest | OtherPrivacyRequestCreateRequest) => Promise<PrivacyRequest>;
-    confirm: (newsroomId: Newsroom['uuid'], privacyRequestId: PrivacyRequest['id']) => Promise<PrivacyRequest>;
+    create: (newsroomId: Newsroom["uuid"], payload: DeletePrivacyRequestCreateRequest | ExportPrivacyRequestCreateRequest | CorrectPrivacyRequestCreateRequest | OtherPrivacyRequestCreateRequest) => Promise<PrivacyRequest>;
+    confirm: (newsroomId: Newsroom["uuid"], privacyRequestId: PrivacyRequest["id"]) => Promise<PrivacyRequest>;
 };

package/dist/endpoints/NewsroomThemes/Client.d.ts

@@ -4,7 +4,7 @@ type NewsroomId = Newsroom['uuid'] | Newsroom['id'];
 type NewsroomThemeId = NewsroomTheme['id'];
 export type Client = ReturnType<typeof createClient>;
 export declare function createClient(api: DeferredJobsApiClient): {
-    apply: (newsroomId: NewsroomId, themeId: NewsroomThemeId, settings: NewsroomThemePreset['settings']) => Promise<NewsroomThemePreset>;
+    apply: (newsroomId: NewsroomId, themeId: NewsroomThemeId, settings: NewsroomThemePreset["settings"]) => Promise<NewsroomThemePreset>;
     get: (newsroomId: NewsroomId, themeId: NewsroomThemeId) => Promise<NewsroomThemePreset>;
     getActive: (newsroomId: NewsroomId) => Promise<NewsroomThemePreset>;
     list: (newsroomId: NewsroomId) => Promise<NewsroomThemePreset[]>;

package/dist/endpoints/NewsroomWebhooks/Client.d.ts

@@ -6,8 +6,8 @@ export type Client = ReturnType<typeof createClient>;
 export declare function createClient(api: DeferredJobsApiClient): {
     list: (newsroomId: NewsroomId) => Promise<NewsroomWebhook[]>;
     create: (newsroomId: NewsroomId, payload: CreateRequest) => Promise<NewsroomWebhook>;
-    get: (newsroomId: NewsroomId, webhookId: NewsroomWebhook['id']) => Promise<NewsroomWebhook>;
-    update: (newsroomId: NewsroomId, webhookId: NewsroomWebhook['id'], payload: UpdateRequest) => Promise<NewsroomWebhook>;
-    delete: (newsroomId: NewsroomId, webhookId: NewsroomWebhook['id']) => Promise<void>;
+    get: (newsroomId: NewsroomId, webhookId: NewsroomWebhook["id"]) => Promise<NewsroomWebhook>;
+    update: (newsroomId: NewsroomId, webhookId: NewsroomWebhook["id"], payload: UpdateRequest) => Promise<NewsroomWebhook>;
+    delete: (newsroomId: NewsroomId, webhookId: NewsroomWebhook["id"]) => Promise<void>;
 };
 export {};

package/dist/endpoints/Newsrooms/types.d.ts

@@ -16,7 +16,7 @@ export interface SearchOptions extends ListOptions {
     query?: Query;
 }
 export interface ListResponse {
-    newsrooms: Newsroom[];
+    newsrooms: Omit<Newsroom, 'policies'>[];
     pagination: Pagination;
     sort: string;
 }

package/dist/endpoints/SenderAddresses/Client.d.ts

@@ -6,7 +6,7 @@ export type Client = ReturnType<typeof createClient>;
 export declare function createClient(api: DeferredJobsApiClient): {
     list: (scope?: Query) => Promise<SenderAddress[]>;
     create: (payload: CreateRequest) => Promise<SenderAddress>;
-    get: (senderId: SenderAddress['id']) => Promise<SenderAddress>;
-    update: (senderId: SenderAddress['id'], payload: UpdateRequest) => Promise<SenderAddress>;
-    delete: (senderId: SenderAddress['id']) => Promise<void>;
+    get: (senderId: SenderAddress["id"]) => Promise<SenderAddress>;
+    update: (senderId: SenderAddress["id"], payload: UpdateRequest) => Promise<SenderAddress>;
+    delete: (senderId: SenderAddress["id"]) => Promise<void>;
 };

package/dist/endpoints/Stories/Client.d.ts

@@ -14,110 +14,110 @@ type Exactly<Concrete, Abstract> = Concrete & Record<Exclude<keyof Concrete, key
 type InferExtraFields<T> = T extends Required<IncludeOptions<infer I>> ? Pick<Story.ExtraFields, I> : unknown;
 export type Client = ReturnType<typeof createClient>;
 export declare function createClient(api: DeferredJobsApiClient): {
-    list: <Options extends ListOptions<keyof Story.ExtraFields>>(options?: Exactly<Options, ListOptions<keyof Story.ExtraFields>> | undefined) => Promise<ListResponse<Story & InferExtraFields<Options>>>;
-    search: <Options_1 extends SearchOptions<keyof Story.ExtraFields>>(options?: Exactly<Options_1, SearchOptions<keyof Story.ExtraFields>> | undefined) => Promise<ListResponse<Story & InferExtraFields<Options_1>>>;
+    list: <Options extends ListOptions>(options?: Exactly<Options, ListOptions>) => Promise<ListResponse<Story & InferExtraFields<Options>>>;
+    search: <Options extends SearchOptions>(options?: Exactly<Options, SearchOptions>) => Promise<ListResponse<Story & InferExtraFields<Options>>>;
     get: {
-        <Options_2 extends IncludeOptions<keyof Story.ExtraFields> & {
-            formats?: Formats | undefined;
-        }>(id: Story['uuid'], options?: Exactly<Options_2, IncludeOptions<keyof Story.ExtraFields> & {
-            formats?: Formats | undefined;
-        }> | undefined): Promise<ExtendedStory & InferExtraFields<Options_2>>;
-        <Options_3 extends IncludeOptions<keyof Story.ExtraFields> & {
-            formats?: Formats | undefined;
-        }>(ids: Story['uuid'][], options?: Exactly<Options_3, IncludeOptions<keyof Story.ExtraFields> & {
-            formats?: Formats | undefined;
-        }> | undefined): Promise<(ExtendedStory & InferExtraFields<Options_3>)[]>;
-        <Options_4 extends IncludeOptions<keyof Story.ExtraFields> & {
-            formats?: Formats | undefined;
-        }>(id: Story['id'] | Story['uuid'], options?: Exactly<Options_4, IncludeOptions<keyof Story.ExtraFields> & {
-            formats?: Formats | undefined;
-        }> | undefined): Promise<ExtendedStory & InferExtraFields<Options_4>>;
-        <Options_5 extends IncludeOptions<keyof Story.ExtraFields> & {
-            formats?: Formats | undefined;
-        }>(ids: Story['id'][], options?: Exactly<Options_5, IncludeOptions<keyof Story.ExtraFields> & {
-            formats?: Formats | undefined;
-        }> | undefined): Promise<(ExtendedStory & InferExtraFields<Options_5>)[]>;
+        <Options extends IncludeOptions & {
+            formats?: Formats;
+        }>(id: Story["uuid"], options?: Exactly<Options, IncludeOptions & {
+            formats?: Formats;
+        }>): Promise<ExtendedStory & InferExtraFields<Options>>;
+        <Options extends IncludeOptions & {
+            formats?: Formats;
+        }>(ids: Story["uuid"][], options?: Exactly<Options, IncludeOptions & {
+            formats?: Formats;
+        }>): Promise<(ExtendedStory & InferExtraFields<Options>)[]>;
+        <Options extends IncludeOptions & {
+            formats?: Formats;
+        }>(id: Story["id"] | Story["uuid"], options?: Exactly<Options, IncludeOptions & {
+            formats?: Formats;
+        }>): Promise<ExtendedStory & InferExtraFields<Options>>;
+        <Options extends IncludeOptions & {
+            formats?: Formats;
+        }>(ids: Story["id"][], options?: Exactly<Options, IncludeOptions & {
+            formats?: Formats;
+        }>): Promise<(ExtendedStory & InferExtraFields<Options>)[]>;
     };
-    getBySlug: <Options_6 extends IncludeOptions<keyof Story.ExtraFields> & {
-        formats?: Formats | undefined;
-        query?: Query | undefined;
-    }>(slug: Story['slug'], options?: Exactly<Options_6, IncludeOptions<keyof Story.ExtraFields> & {
-        formats?: Formats | undefined;
-        query?: Query | undefined;
-    }> | undefined) => Promise<ExtendedStory & InferExtraFields<Options_6>>;
-    create: <Options_7 extends IncludeOptions<keyof Story.ExtraFields> & {
-        formats?: Formats | undefined;
-        force?: boolean | undefined;
-    }>(payload: CreateRequest, options?: Exactly<Options_7, IncludeOptions<keyof Story.ExtraFields> & {
-        formats?: Formats | undefined;
-        force?: boolean | undefined;
-    }> | undefined) => Promise<ExtendedStory & InferExtraFields<Options_7>>;
-    duplicate: <Options_8 extends IncludeOptions<keyof Story.ExtraFields> & {
-        formats?: Formats | undefined;
-    }>(id: StoryId, options?: Exactly<Options_8, IncludeOptions<keyof Story.ExtraFields> & {
-        formats?: Formats | undefined;
-    }> | undefined) => Promise<ExtendedStory & InferExtraFields<Options_8>>;
-    translate: <Options_9 extends IncludeOptions<keyof Story.ExtraFields> & {
-        formats?: Formats | undefined;
-    }>(id: StoryId, payload?: TranslateRequest, options?: Exactly<Options_9, IncludeOptions<keyof Story.ExtraFields> & {
-        formats?: Formats | undefined;
-    }> | undefined) => Promise<ExtendedStory & InferExtraFields<Options_9>>;
-    move: <Options_10 extends IncludeOptions<keyof Story.ExtraFields> & {
-        formats?: Formats | undefined;
-        force?: boolean | undefined;
-    }>(id: StoryId, payload: MoveRequest, options?: Exactly<Options_10, IncludeOptions<keyof Story.ExtraFields> & {
-        formats?: Formats | undefined;
-        force?: boolean | undefined;
-    }> | undefined) => Promise<ChangeNewsroomUnsafeResponse | ChangeNewsroomSuccessResponse<ExtendedStory & InferExtraFields<Options_10>>>;
-    update: <Options_11 extends IncludeOptions<keyof Story.ExtraFields> & {
-        formats?: Formats | undefined;
-        force?: boolean | undefined;
-    }>(id: StoryId, payload: UpdateRequest, options?: Exactly<Options_11, IncludeOptions<keyof Story.ExtraFields> & {
-        formats?: Formats | undefined;
-        force?: boolean | undefined;
-    }> | undefined) => Promise<ExtendedStory & InferExtraFields<Options_11>>;
-    autosave: <Options_12 extends IncludeOptions<keyof Story.ExtraFields> & {
-        formats?: Formats | undefined;
-    }>(id: StoryId, payload: AutosaveRequest, options?: Exactly<Options_12, IncludeOptions<keyof Story.ExtraFields> & {
-        formats?: Formats | undefined;
-    }> | undefined) => Promise<ExtendedStory & InferExtraFields<Options_12>>;
-    revert: <Options_13 extends IncludeOptions<keyof Story.ExtraFields> & {
-        formats?: Formats | undefined;
-    }>(id: StoryId, payload?: RevertRequest, options?: Exactly<Options_13, IncludeOptions<keyof Story.ExtraFields> & {
-        formats?: Formats | undefined;
-    }> | undefined) => Promise<ExtendedStory & InferExtraFields<Options_13>>;
-    publish: <Options_14 extends IncludeOptions<keyof Story.ExtraFields> & {
-        formats?: Formats | undefined;
-    }>(id: StoryId, payload?: PublishRequest, options?: Exactly<Options_14, IncludeOptions<keyof Story.ExtraFields> & {
-        formats?: Formats | undefined;
-    }> | undefined) => Promise<ExtendedStory & InferExtraFields<Options_14>>;
-    unpublish: <Options_15 extends IncludeOptions<keyof Story.ExtraFields> & {
-        formats?: Formats | undefined;
-    }>(id: StoryId, payload?: UnpublishRequest, options?: Exactly<Options_15, IncludeOptions<keyof Story.ExtraFields> & {
-        formats?: Formats | undefined;
-    }> | undefined) => Promise<ExtendedStory & InferExtraFields<Options_15>>;
-    schedule: <Options_16 extends IncludeOptions<keyof Story.ExtraFields> & {
-        formats?: Formats | undefined;
-    }>(id: StoryId, payload?: ScheduleRequest, options?: Exactly<Options_16, IncludeOptions<keyof Story.ExtraFields> & {
-        formats?: Formats | undefined;
-    }> | undefined) => Promise<ExtendedStory & InferExtraFields<Options_16>>;
-    unschedule: <Options_17 extends IncludeOptions<keyof Story.ExtraFields> & {
-        formats?: Formats | undefined;
-    }>(id: StoryId, payload?: UnscheduleRequest, options?: Exactly<Options_17, IncludeOptions<keyof Story.ExtraFields> & {
-        formats?: Formats | undefined;
-    }> | undefined) => Promise<ExtendedStory & InferExtraFields<Options_17>>;
-    pin: <Options_18 extends IncludeOptions<keyof Story.ExtraFields> & {
-        formats?: Formats | undefined;
-        force?: boolean | undefined;
-    }>(id: StoryId, options?: Exactly<Options_18, IncludeOptions<keyof Story.ExtraFields> & {
-        formats?: Formats | undefined;
-        force?: boolean | undefined;
-    }> | undefined) => Promise<ExtendedStory & InferExtraFields<Options_18>>;
-    unpin: <Options_19 extends IncludeOptions<keyof Story.ExtraFields> & {
-        formats?: Formats | undefined;
-    }>(id: StoryId, options?: Exactly<Options_19, IncludeOptions<keyof Story.ExtraFields> & {
-        formats?: Formats | undefined;
-    }> | undefined) => Promise<ExtendedStory & InferExtraFields<Options_19>>;
+    getBySlug: <Options extends IncludeOptions & {
+        formats?: Formats;
+        query?: Query;
+    }>(slug: Story["slug"], options?: Exactly<Options, IncludeOptions & {
+        formats?: Formats;
+        query?: Query;
+    }>) => Promise<ExtendedStory & InferExtraFields<Options>>;
+    create: <Options extends IncludeOptions & {
+        formats?: Formats;
+        force?: boolean;
+    }>(payload: CreateRequest, options?: Exactly<Options, IncludeOptions & {
+        formats?: Formats;
+        force?: boolean;
+    }>) => Promise<ExtendedStory & InferExtraFields<Options>>;
+    duplicate: <Options extends IncludeOptions & {
+        formats?: Formats;
+    }>(id: StoryId, options?: Exactly<Options, IncludeOptions & {
+        formats?: Formats;
+    }>) => Promise<ExtendedStory & InferExtraFields<Options>>;
+    translate: <Options extends IncludeOptions & {
+        formats?: Formats;
+    }>(id: StoryId, payload?: TranslateRequest, options?: Exactly<Options, IncludeOptions & {
+        formats?: Formats;
+    }>) => Promise<ExtendedStory & InferExtraFields<Options>>;
+    move: <Options extends IncludeOptions & {
+        formats?: Formats;
+        force?: boolean;
+    }>(id: StoryId, payload: MoveRequest, options?: Exactly<Options, IncludeOptions & {
+        formats?: Formats;
+        force?: boolean;
+    }>) => Promise<ChangeNewsroomSuccessResponse<ExtendedStory & InferExtraFields<Options>> | ChangeNewsroomUnsafeResponse>;
+    update: <Options extends IncludeOptions & {
+        formats?: Formats;
+        force?: boolean;
+    }>(id: StoryId, payload: UpdateRequest, options?: Exactly<Options, IncludeOptions & {
+        formats?: Formats;
+        force?: boolean;
+    }>) => Promise<ExtendedStory & InferExtraFields<Options>>;
+    autosave: <Options extends IncludeOptions & {
+        formats?: Formats;
+    }>(id: StoryId, payload: AutosaveRequest, options?: Exactly<Options, IncludeOptions & {
+        formats?: Formats;
+    }>) => Promise<ExtendedStory & InferExtraFields<Options>>;
+    revert: <Options extends IncludeOptions & {
+        formats?: Formats;
+    }>(id: StoryId, payload?: RevertRequest, options?: Exactly<Options, IncludeOptions & {
+        formats?: Formats;
+    }>) => Promise<ExtendedStory & InferExtraFields<Options>>;
+    publish: <Options extends IncludeOptions & {
+        formats?: Formats;
+    }>(id: StoryId, payload?: PublishRequest, options?: Exactly<Options, IncludeOptions & {
+        formats?: Formats;
+    }>) => Promise<ExtendedStory & InferExtraFields<Options>>;
+    unpublish: <Options extends IncludeOptions & {
+        formats?: Formats;
+    }>(id: StoryId, payload?: UnpublishRequest, options?: Exactly<Options, IncludeOptions & {
+        formats?: Formats;
+    }>) => Promise<ExtendedStory & InferExtraFields<Options>>;
+    schedule: <Options extends IncludeOptions & {
+        formats?: Formats;
+    }>(id: StoryId, payload?: ScheduleRequest, options?: Exactly<Options, IncludeOptions & {
+        formats?: Formats;
+    }>) => Promise<ExtendedStory & InferExtraFields<Options>>;
+    unschedule: <Options extends IncludeOptions & {
+        formats?: Formats;
+    }>(id: StoryId, payload?: UnscheduleRequest, options?: Exactly<Options, IncludeOptions & {
+        formats?: Formats;
+    }>) => Promise<ExtendedStory & InferExtraFields<Options>>;
+    pin: <Options extends IncludeOptions & {
+        formats?: Formats;
+        force?: boolean;
+    }>(id: StoryId, options?: Exactly<Options, IncludeOptions & {
+        formats?: Formats;
+        force?: boolean;
+    }>) => Promise<ExtendedStory & InferExtraFields<Options>>;
+    unpin: <Options extends IncludeOptions & {
+        formats?: Formats;
+    }>(id: StoryId, options?: Exactly<Options, IncludeOptions & {
+        formats?: Formats;
+    }>) => Promise<ExtendedStory & InferExtraFields<Options>>;
     delete: (id: StoryId) => Promise<void>;
     preview: (id: StoryId, options?: PreviewOptions) => Promise<PreviewResponse>;
 };

package/dist/endpoints/Stories/types.d.ts

@@ -254,6 +254,8 @@ export interface ChangeNewsroomUnsafeResponse {
     message: string;
     warnings: ChangeNewsroomWarning[];
 }
-export declare const ALL_EXTRA_FIELDS: (keyof Story.ExtraFields)[];
-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")[];
+declare const EXTENDED_STORY_INCLUDED_EXTRA_FIELDS_SHAPE: Record<keyof Omit<ExtendedStory, keyof Story>, boolean>;
+declare const ALL_EXTRA_FIELDS_SHAPE: Record<keyof Story.ExtraFields, boolean>;
+export declare const ALL_EXTRA_FIELDS: (keyof typeof ALL_EXTRA_FIELDS_SHAPE)[];
+export declare const EXTENDED_STORY_INCLUDED_EXTRA_FIELDS: (keyof typeof EXTENDED_STORY_INCLUDED_EXTRA_FIELDS_SHAPE)[];
 export {};

package/dist/endpoints/Subscriptions/Client.d.ts

@@ -7,7 +7,7 @@ export declare function createClient(api: DeferredJobsApiClient): {
     subscribeToNewsroom: <Type extends Contact.Type>(newsroomId: NewsroomId, payload: SubscribeRequest<Type>) => Promise<EmailSubscription>;
     unsubscribeFromNewsroom: (newsroomId: NewsroomId, payload: UnsubscribeRequest) => Promise<EmailSubscription>;
     unsubscribeFromLicense: (payload: UnsubscribeRequest) => Promise<EmailSubscription>;
-    updateNewsroomUnsubscribeDetails: (newsroomId: NewsroomId, subscriptionId: EmailSubscription['id'], payload: UpdateUnsubscribeDetailsRequest) => Promise<EmailSubscription>;
-    updateLicenseUnsubscribeDetails: (subscriptionId: EmailSubscription['id'], payload: UpdateUnsubscribeDetailsRequest) => Promise<EmailSubscription>;
+    updateNewsroomUnsubscribeDetails: (newsroomId: NewsroomId, subscriptionId: EmailSubscription["id"], payload: UpdateUnsubscribeDetailsRequest) => Promise<EmailSubscription>;
+    updateLicenseUnsubscribeDetails: (subscriptionId: EmailSubscription["id"], payload: UpdateUnsubscribeDetailsRequest) => Promise<EmailSubscription>;
 };
 export {};

package/dist/endpoints/index.cjs

@@ -63,4 +63,4 @@ exports.Subscriptions = _Subscriptions;
 var _NotificationSubscriptions = _interopRequireWildcard(require("./NotificationSubscriptions/index.cjs"));
 exports.NotificationSubscriptions = _NotificationSubscriptions;
 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); }
-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; }
+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

@@ -6,7 +6,7 @@ Object.defineProperty(exports, "__esModule", {
 exports.createUrlWithQuery = createUrlWithQuery;
 exports.isDeferredJobResponse = isDeferredJobResponse;
 var _queryString = _interopRequireDefault(require("query-string"));
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
 function parseUrlParams(query) {
   return _queryString.default.parse(query, {
     arrayFormat: 'bracket'

package/dist/types/License.d.ts

@@ -44,6 +44,7 @@ export interface License extends LicenseRef {
      * At the end of this period, a new invoice will be created.
      */
     current_period_end: string | null;
+    demo_at: string | null;
     demo_content_created_at: string | null;
     demo_content_deleted_at: string | null;
     display_name: string;

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@prezly/sdk",
-    "version": "23.20.0",
+    "version": "24.1.0",
     "description": "Prezly API SDK",
     "type": "module",
     "main": "dist/index.cjs",