@newsletterstudio/umbraco 16.0.4 → 17.0.0-rc2
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/backend-api/client/client.gen.d.ts +2 -0
- package/dist/backend-api/client/index.d.ts +8 -0
- package/dist/backend-api/client/types.gen.d.ts +124 -0
- package/dist/backend-api/client/utils.gen.d.ts +33 -0
- package/dist/backend-api/client.gen.d.ts +4 -4
- package/dist/backend-api/core/auth.gen.d.ts +18 -0
- package/dist/backend-api/core/bodySerializer.gen.d.ts +17 -0
- package/dist/backend-api/core/params.gen.d.ts +33 -0
- package/dist/backend-api/core/pathSerializer.gen.d.ts +33 -0
- package/dist/backend-api/core/queryKeySerializer.gen.d.ts +18 -0
- package/dist/backend-api/core/serverSentEvents.gen.d.ts +71 -0
- package/dist/backend-api/core/types.gen.d.ts +78 -0
- package/dist/backend-api/core/utils.gen.d.ts +19 -0
- package/dist/backend-api/sdk.gen.d.ts +77 -77
- package/dist/backend-api/types.gen.d.ts +132 -7
- package/dist/core/components/ns-checkbox-list/ns-checkbox-list.element.d.ts +1 -1
- package/dist/core/components/ns-email-address-collection/ns-email-address-collection.element.d.ts +1 -1
- package/dist/core/components/ns-email-campaign-send/ns-email-campaign-send.element.d.ts +3 -0
- package/dist/core/components/ns-mailing-list-picker/ns-mailing-list-picker.element.d.ts +1 -1
- package/dist/core/components/ns-recipient-list-picker/ns-recipient-list-picker.element.d.ts +1 -1
- package/dist/core/components/ns-select/ns-select.element.d.ts +1 -1
- package/dist/core/components/ns-transactional-email-picker/ns-transactional-email-picker.element.d.ts +1 -1
- package/dist/core/localization.helper.d.ts +5 -0
- package/dist/core/string.helper.d.ts +1 -1
- package/dist/modules/administration/ns-administration-workspace.context.d.ts +3 -3
- package/dist/modules/campaign/content-section/manifest.d.ts +2 -1
- package/dist/modules/campaign/content-section/modal/manifest.d.ts +1 -1
- package/dist/modules/campaign/content-section/modal/ns-document-campaign-modal-context.d.ts +3 -3
- package/dist/modules/campaign/content-section/ns-document-campaign-workspace.context.d.ts +2 -2
- package/dist/modules/campaign/email-section/manifest.d.ts +2 -1
- package/dist/modules/campaign/email-section/modal/manifest.d.ts +1 -1
- package/dist/modules/campaign/email-section/modal/ns-editor-campaign-modal-context.d.ts +2 -2
- package/dist/modules/campaign/manifest.d.ts +1 -1
- package/dist/modules/campaign/report/campaign-report-workspace.context.d.ts +1 -1
- package/dist/modules/email-editor/controls/text/tip-tap/ns-tiptap-toolbar-color-picker.element.d.ts +1 -1
- package/dist/modules/email-editor/controls/text/tip-tap/ns-tiptap-toolbar-merge-fields.element.d.ts +1 -1
- package/dist/modules/email-editor/ns-email-editor-context.d.ts +4 -4
- package/dist/modules/email-editor/ns-email-editor-context.models.d.ts +1 -0
- package/dist/modules/email-editor/ns-email-modal-context-base.d.ts +4 -4
- package/dist/modules/global/newsletter-studio.context.d.ts +1 -1
- package/dist/modules/manifest.d.ts +15 -1
- package/dist/modules/property-editors/mailing-list-picker/ns-mailing-list-picker-property-editor.element.d.ts +2 -2
- package/dist/modules/property-editors/transactional-email-picker/ns-transactional-email-picker-editor.element.d.ts +2 -2
- package/dist/modules/transactional/template/edit/ns-transactional-template-edit.context.d.ts +3 -3
- package/package.json +5 -5
|
@@ -1,6 +1,6 @@
|
|
|
1
|
-
import { type Options as
|
|
2
|
-
import type { CampaignReportGetOverviewData,
|
|
3
|
-
export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> =
|
|
1
|
+
import { type Client, type Options as Options2, type TDataShape } from './client';
|
|
2
|
+
import type { CampaignReportGetOverviewData, CampaignReportGetOverviewErrors, CampaignReportGetOverviewResponses, CampaignReportGetRecipientsData, CampaignReportGetRecipientsErrors, CampaignReportGetRecipientsResponses, CampaignReportGetRecipientTimelineData, CampaignReportGetRecipientTimelineErrors, CampaignReportGetRecipientTimelineResponses, DebugHubDebugMessageData, DebugHubDebugMessageResponses, DebugSignalProgressData, DebugSignalProgressResponses, DocumentCampaignCreateCampaignInvariantData, DocumentCampaignCreateCampaignInvariantErrors, DocumentCampaignCreateCampaignInvariantResponses, DocumentCampaignCreateCampaignWithCultureData, DocumentCampaignCreateCampaignWithCultureErrors, DocumentCampaignCreateCampaignWithCultureResponses, DocumentCampaignGetByKeyData, DocumentCampaignGetByKeyErrors, DocumentCampaignGetByKeyResponses, DocumentCampaignGetOverviewForData, DocumentCampaignGetOverviewForErrors, DocumentCampaignGetOverviewForResponses, DocumentCampaignGetPagedSentCampaignsData, DocumentCampaignGetPagedSentCampaignsErrors, DocumentCampaignGetPagedSentCampaignsResponses, DocumentCampaignSaveAndSendOrScheduleData, DocumentCampaignSaveAndSendOrScheduleErrors, DocumentCampaignSaveAndSendOrScheduleResponses, DocumentCampaignSaveData, DocumentCampaignSaveErrors, DocumentCampaignSaveResponses, DocumentCampaignSendTestEmailData, DocumentCampaignSendTestEmailErrors, DocumentCampaignSendTestEmailResponses, EditorCampaignDeleteData, EditorCampaignDeleteErrors, EditorCampaignDeleteResponses, EditorCampaignDuplicateData, EditorCampaignDuplicateErrors, EditorCampaignDuplicateResponses, EditorCampaignGetByKeyData, EditorCampaignGetByKeyErrors, EditorCampaignGetByKeyResponses, EditorCampaignGetOverviewData, EditorCampaignGetOverviewErrors, EditorCampaignGetOverviewResponses, EditorCampaignGetPagedCampaignListItemsData, EditorCampaignGetPagedCampaignListItemsErrors, EditorCampaignGetPagedCampaignListItemsResponses, EditorCampaignGetRecipientListsData, EditorCampaignGetRecipientListsErrors, EditorCampaignGetRecipientListsResponses, EditorCampaignPocExceptionData, EditorCampaignPocExceptionErrors, EditorCampaignPocExceptionResponses, EditorCampaignPocValidationData, EditorCampaignPocValidationErrors, EditorCampaignPocValidationResponses, EditorCampaignRenderPreviewData, EditorCampaignRenderPreviewErrors, EditorCampaignRenderPreviewResponses, EditorCampaignSaveAndSendOrScheduleData, EditorCampaignSaveAndSendOrScheduleErrors, EditorCampaignSaveAndSendOrScheduleResponses, EditorCampaignSaveData, EditorCampaignSaveErrors, EditorCampaignSaveResponses, EditorCampaignSendTestEmailData, EditorCampaignSendTestEmailErrors, EditorCampaignSendTestEmailResponses, EmailEditorGetImageControlDataData, EmailEditorGetImageControlDataErrors, EmailEditorGetImageControlDataResponses, EmailEditorGetMacrosData, EmailEditorGetMacrosErrors, EmailEditorGetMacrosResponses, ImportRecipientsImportFixedIssueData, ImportRecipientsImportFixedIssueErrors, ImportRecipientsImportFixedIssueResponses, ImportRecipientsPerformFileImportData, ImportRecipientsPerformFileImportErrors, ImportRecipientsPerformFileImportResponses, ImportRecipientsUploadFileAndParseForMappingData, ImportRecipientsUploadFileAndParseForMappingErrors, ImportRecipientsUploadFileAndParseForMappingResponses, ImportRecipientsUploadPastedAndParseForMappingData, ImportRecipientsUploadPastedAndParseForMappingErrors, ImportRecipientsUploadPastedAndParseForMappingResponses, MailingListGetDetailsData, MailingListGetDetailsErrors, MailingListGetDetailsResponses, MailingListGetOverviewData, MailingListGetOverviewErrors, MailingListGetOverviewResponses, MailingListGetPagedSubscribersData, MailingListGetPagedSubscribersErrors, MailingListGetPagedSubscribersResponses, MailingListPickerGetModelData, MailingListPickerGetModelErrors, MailingListPickerGetModelResponses, MailingListRemoveData, MailingListRemoveErrors, MailingListRemoveResponses, MailingListSaveData, MailingListSaveErrors, MailingListSaveResponses, PackageGetMenuTreeData, PackageGetMenuTreeErrors, PackageGetMenuTreeResponses, PackageGetPackageSettingsData, PackageGetPackageSettingsErrors, PackageGetPackageSettingsResponses, RecipientGetDetailsData, RecipientGetDetailsErrors, RecipientGetDetailsResponses, RecipientGetOverviewData, RecipientGetOverviewErrors, RecipientGetOverviewResponses, RecipientGetPagedRecipientsData, RecipientGetPagedRecipientsErrors, RecipientGetPagedRecipientsResponses, RecipientRemoveData, RecipientRemoveErrors, RecipientRemoveResponses, RecipientResetErrorsForRecipientData, RecipientResetErrorsForRecipientErrors, RecipientResetErrorsForRecipientResponses, RecipientSaveData, RecipientSaveErrors, RecipientSaveResponses, RecipientsExportGetDetailsData, RecipientsExportGetDetailsErrors, RecipientsExportGetDetailsResponses, TransactionalCreateData, TransactionalCreateErrors, TransactionalCreateResponses, TransactionalDeleteData, TransactionalDeleteErrors, TransactionalDeleteResponses, TransactionalDuplicateData, TransactionalDuplicateErrors, TransactionalDuplicateResponses, TransactionalGetDetailsData, TransactionalGetDetailsErrors, TransactionalGetDetailsResponses, TransactionalGetFieldsByAliasData, TransactionalGetFieldsByAliasErrors, TransactionalGetFieldsByAliasResponses, TransactionalGetPagedTransactionalListItemsData, TransactionalGetPagedTransactionalListItemsErrors, TransactionalGetPagedTransactionalListItemsResponses, TransactionalGetPagedTransactionalLogItemsData, TransactionalGetPagedTransactionalLogItemsErrors, TransactionalGetPagedTransactionalLogItemsResponses, TransactionalGetTrackingTransactionalData, TransactionalGetTrackingTransactionalErrors, TransactionalGetTrackingTransactionalResponses, TransactionalGetTransactionalActivitiesData, TransactionalGetTransactionalActivitiesErrors, TransactionalGetTransactionalActivitiesResponses, TransactionalGetTransactionalEmailsOverviewData, TransactionalGetTransactionalEmailsOverviewErrors, TransactionalGetTransactionalEmailsOverviewResponses, TransactionalPickerGetModelData, TransactionalPickerGetModelErrors, TransactionalPickerGetModelResponses, TransactionalRenderTrackingTransactionalEmailData, TransactionalRenderTrackingTransactionalEmailErrors, TransactionalRenderTrackingTransactionalEmailResponses, TransactionalRenderTransactionalData, TransactionalRenderTransactionalErrors, TransactionalRenderTransactionalResponses, TransactionalResendData, TransactionalResendErrors, TransactionalResendResponses, TransactionalSaveData, TransactionalSaveErrors, TransactionalSaveResponses, TransactionalSendTestEmailData, TransactionalSendTestEmailErrors, TransactionalSendTestEmailResponses, WorkspaceCreateNewData, WorkspaceCreateNewErrors, WorkspaceCreateNewResponses, WorkspaceGetDashboardOverviewData, WorkspaceGetDashboardOverviewErrors, WorkspaceGetDashboardOverviewResponses, WorkspaceGetDashboardSectionData, WorkspaceGetDashboardSectionErrors, WorkspaceGetDashboardSectionResponses, WorkspaceGetManageData, WorkspaceGetManageErrors, WorkspaceGetManageResponses, WorkspaceGetOverviewData, WorkspaceGetOverviewErrors, WorkspaceGetOverviewResponses, WorkspaceGetSettingsData, WorkspaceGetSettingsErrors, WorkspaceGetSettingsResponses, WorkspaceLicenseConnectData, WorkspaceLicenseConnectErrors, WorkspaceLicenseConnectResponses, WorkspaceLicenseLoginData, WorkspaceLicenseLoginErrors, WorkspaceLicenseLoginResponses, WorkspaceRemoveData, WorkspaceRemoveErrors, WorkspaceRemoveResponses, WorkspaceSaveManageData, WorkspaceSaveManageErrors, WorkspaceSaveManageResponses, WorkspaceSaveSettingsData, WorkspaceSaveSettingsErrors, WorkspaceSaveSettingsResponses, WorkspaceTestPop3ServerData, WorkspaceTestPop3ServerErrors, WorkspaceTestPop3ServerResponses } from './types.gen';
|
|
3
|
+
export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = Options2<TData, ThrowOnError> & {
|
|
4
4
|
/**
|
|
5
5
|
* You can provide a client instance returned by `createClient()` instead of
|
|
6
6
|
* individual options. This might be also useful if you want to implement a
|
|
@@ -14,176 +14,176 @@ export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends
|
|
|
14
14
|
meta?: Record<string, unknown>;
|
|
15
15
|
};
|
|
16
16
|
export declare class CampaignReportResource {
|
|
17
|
-
static getOverview<ThrowOnError extends boolean = true>(options: Options<CampaignReportGetOverviewData, ThrowOnError>): import("
|
|
18
|
-
static getRecipientTimeline<ThrowOnError extends boolean = true>(options: Options<CampaignReportGetRecipientTimelineData, ThrowOnError>): import("
|
|
19
|
-
static getRecipients<ThrowOnError extends boolean = true>(options?: Options<CampaignReportGetRecipientsData, ThrowOnError>): import("
|
|
17
|
+
static getOverview<ThrowOnError extends boolean = true>(options: Options<CampaignReportGetOverviewData, ThrowOnError>): import("./client").RequestResult<CampaignReportGetOverviewResponses, CampaignReportGetOverviewErrors, ThrowOnError, "fields">;
|
|
18
|
+
static getRecipientTimeline<ThrowOnError extends boolean = true>(options: Options<CampaignReportGetRecipientTimelineData, ThrowOnError>): import("./client").RequestResult<CampaignReportGetRecipientTimelineResponses, CampaignReportGetRecipientTimelineErrors, ThrowOnError, "fields">;
|
|
19
|
+
static getRecipients<ThrowOnError extends boolean = true>(options?: Options<CampaignReportGetRecipientsData, ThrowOnError>): import("./client").RequestResult<CampaignReportGetRecipientsResponses, CampaignReportGetRecipientsErrors, ThrowOnError, "fields">;
|
|
20
20
|
}
|
|
21
21
|
export declare class DocumentCampaignResource {
|
|
22
|
-
static getByKey<ThrowOnError extends boolean = true>(options: Options<DocumentCampaignGetByKeyData, ThrowOnError>): import("
|
|
22
|
+
static getByKey<ThrowOnError extends boolean = true>(options: Options<DocumentCampaignGetByKeyData, ThrowOnError>): import("./client").RequestResult<DocumentCampaignGetByKeyResponses, DocumentCampaignGetByKeyErrors, ThrowOnError, "fields">;
|
|
23
23
|
/**
|
|
24
24
|
* Creates a culture-specific document campaign model, used for content that vary by culture
|
|
25
25
|
*/
|
|
26
|
-
static createCampaignWithCulture<ThrowOnError extends boolean = true>(options: Options<DocumentCampaignCreateCampaignWithCultureData, ThrowOnError>): import("
|
|
26
|
+
static createCampaignWithCulture<ThrowOnError extends boolean = true>(options: Options<DocumentCampaignCreateCampaignWithCultureData, ThrowOnError>): import("./client").RequestResult<DocumentCampaignCreateCampaignWithCultureResponses, DocumentCampaignCreateCampaignWithCultureErrors, ThrowOnError, "fields">;
|
|
27
27
|
/**
|
|
28
28
|
* Creates a invariant document campaign model, used for content that does not vary by culture
|
|
29
29
|
*/
|
|
30
|
-
static createCampaignInvariant<ThrowOnError extends boolean = true>(options: Options<DocumentCampaignCreateCampaignInvariantData, ThrowOnError>): import("
|
|
30
|
+
static createCampaignInvariant<ThrowOnError extends boolean = true>(options: Options<DocumentCampaignCreateCampaignInvariantData, ThrowOnError>): import("./client").RequestResult<DocumentCampaignCreateCampaignInvariantResponses, DocumentCampaignCreateCampaignInvariantErrors, ThrowOnError, "fields">;
|
|
31
31
|
/**
|
|
32
32
|
* Returns all emails connected to a given content node based on the content node key
|
|
33
33
|
*/
|
|
34
|
-
static getOverviewFor<ThrowOnError extends boolean = true>(options: Options<DocumentCampaignGetOverviewForData, ThrowOnError>): import("
|
|
34
|
+
static getOverviewFor<ThrowOnError extends boolean = true>(options: Options<DocumentCampaignGetOverviewForData, ThrowOnError>): import("./client").RequestResult<DocumentCampaignGetOverviewForResponses, DocumentCampaignGetOverviewForErrors, ThrowOnError, "fields">;
|
|
35
35
|
/**
|
|
36
36
|
* Provides a paged response to list sent campaigns
|
|
37
37
|
*/
|
|
38
|
-
static getPagedSentCampaigns<ThrowOnError extends boolean = true>(options?: Options<DocumentCampaignGetPagedSentCampaignsData, ThrowOnError>): import("
|
|
39
|
-
static save<ThrowOnError extends boolean = true>(options?: Options<DocumentCampaignSaveData, ThrowOnError>): import("
|
|
40
|
-
static saveAndSendOrSchedule<ThrowOnError extends boolean = true>(options?: Options<DocumentCampaignSaveAndSendOrScheduleData, ThrowOnError>): import("
|
|
41
|
-
static sendTestEmail<ThrowOnError extends boolean = true>(options?: Options<DocumentCampaignSendTestEmailData, ThrowOnError>): import("
|
|
38
|
+
static getPagedSentCampaigns<ThrowOnError extends boolean = true>(options?: Options<DocumentCampaignGetPagedSentCampaignsData, ThrowOnError>): import("./client").RequestResult<DocumentCampaignGetPagedSentCampaignsResponses, DocumentCampaignGetPagedSentCampaignsErrors, ThrowOnError, "fields">;
|
|
39
|
+
static save<ThrowOnError extends boolean = true>(options?: Options<DocumentCampaignSaveData, ThrowOnError>): import("./client").RequestResult<DocumentCampaignSaveResponses, DocumentCampaignSaveErrors, ThrowOnError, "fields">;
|
|
40
|
+
static saveAndSendOrSchedule<ThrowOnError extends boolean = true>(options?: Options<DocumentCampaignSaveAndSendOrScheduleData, ThrowOnError>): import("./client").RequestResult<DocumentCampaignSaveAndSendOrScheduleResponses, DocumentCampaignSaveAndSendOrScheduleErrors, ThrowOnError, "fields">;
|
|
41
|
+
static sendTestEmail<ThrowOnError extends boolean = true>(options?: Options<DocumentCampaignSendTestEmailData, ThrowOnError>): import("./client").RequestResult<DocumentCampaignSendTestEmailResponses, DocumentCampaignSendTestEmailErrors, ThrowOnError, "fields">;
|
|
42
42
|
}
|
|
43
43
|
export declare class EditorCampaignResource {
|
|
44
|
-
static getByKey<ThrowOnError extends boolean = true>(options: Options<EditorCampaignGetByKeyData, ThrowOnError>): import("
|
|
44
|
+
static getByKey<ThrowOnError extends boolean = true>(options: Options<EditorCampaignGetByKeyData, ThrowOnError>): import("./client").RequestResult<EditorCampaignGetByKeyResponses, EditorCampaignGetByKeyErrors, ThrowOnError, "fields">;
|
|
45
45
|
/**
|
|
46
46
|
* Deletes a campaign from the system
|
|
47
47
|
*/
|
|
48
|
-
static delete<ThrowOnError extends boolean = true>(options: Options<EditorCampaignDeleteData, ThrowOnError>): import("
|
|
48
|
+
static delete<ThrowOnError extends boolean = true>(options: Options<EditorCampaignDeleteData, ThrowOnError>): import("./client").RequestResult<EditorCampaignDeleteResponses, EditorCampaignDeleteErrors, ThrowOnError, "fields">;
|
|
49
49
|
/**
|
|
50
50
|
* Duplicates a campaign
|
|
51
51
|
*/
|
|
52
|
-
static duplicate<ThrowOnError extends boolean = true>(options: Options<EditorCampaignDuplicateData, ThrowOnError>): import("
|
|
53
|
-
static getOverview<ThrowOnError extends boolean = true>(options: Options<EditorCampaignGetOverviewData, ThrowOnError>): import("
|
|
54
|
-
static getPagedCampaignListItems<ThrowOnError extends boolean = true>(options?: Options<EditorCampaignGetPagedCampaignListItemsData, ThrowOnError>): import("
|
|
55
|
-
static pocException<ThrowOnError extends boolean = true>(options?: Options<EditorCampaignPocExceptionData, ThrowOnError>): import("
|
|
56
|
-
static pocValidation<ThrowOnError extends boolean = true>(options?: Options<EditorCampaignPocValidationData, ThrowOnError>): import("
|
|
52
|
+
static duplicate<ThrowOnError extends boolean = true>(options: Options<EditorCampaignDuplicateData, ThrowOnError>): import("./client").RequestResult<EditorCampaignDuplicateResponses, EditorCampaignDuplicateErrors, ThrowOnError, "fields">;
|
|
53
|
+
static getOverview<ThrowOnError extends boolean = true>(options: Options<EditorCampaignGetOverviewData, ThrowOnError>): import("./client").RequestResult<EditorCampaignGetOverviewResponses, EditorCampaignGetOverviewErrors, ThrowOnError, "fields">;
|
|
54
|
+
static getPagedCampaignListItems<ThrowOnError extends boolean = true>(options?: Options<EditorCampaignGetPagedCampaignListItemsData, ThrowOnError>): import("./client").RequestResult<EditorCampaignGetPagedCampaignListItemsResponses, EditorCampaignGetPagedCampaignListItemsErrors, ThrowOnError, "fields">;
|
|
55
|
+
static pocException<ThrowOnError extends boolean = true>(options?: Options<EditorCampaignPocExceptionData, ThrowOnError>): import("./client").RequestResult<EditorCampaignPocExceptionResponses, EditorCampaignPocExceptionErrors, ThrowOnError, "fields">;
|
|
56
|
+
static pocValidation<ThrowOnError extends boolean = true>(options?: Options<EditorCampaignPocValidationData, ThrowOnError>): import("./client").RequestResult<EditorCampaignPocValidationResponses, EditorCampaignPocValidationErrors, ThrowOnError, "fields">;
|
|
57
57
|
/**
|
|
58
58
|
* Returns a list of RecipientProviders with it's lists
|
|
59
59
|
*/
|
|
60
|
-
static getRecipientLists<ThrowOnError extends boolean = true>(options: Options<EditorCampaignGetRecipientListsData, ThrowOnError>): import("
|
|
61
|
-
static renderPreview<ThrowOnError extends boolean = true>(options: Options<EditorCampaignRenderPreviewData, ThrowOnError>): import("
|
|
62
|
-
static save<ThrowOnError extends boolean = true>(options?: Options<EditorCampaignSaveData, ThrowOnError>): import("
|
|
63
|
-
static saveAndSendOrSchedule<ThrowOnError extends boolean = true>(options?: Options<EditorCampaignSaveAndSendOrScheduleData, ThrowOnError>): import("
|
|
60
|
+
static getRecipientLists<ThrowOnError extends boolean = true>(options: Options<EditorCampaignGetRecipientListsData, ThrowOnError>): import("./client").RequestResult<EditorCampaignGetRecipientListsResponses, EditorCampaignGetRecipientListsErrors, ThrowOnError, "fields">;
|
|
61
|
+
static renderPreview<ThrowOnError extends boolean = true>(options: Options<EditorCampaignRenderPreviewData, ThrowOnError>): import("./client").RequestResult<EditorCampaignRenderPreviewResponses, EditorCampaignRenderPreviewErrors, ThrowOnError, "fields">;
|
|
62
|
+
static save<ThrowOnError extends boolean = true>(options?: Options<EditorCampaignSaveData, ThrowOnError>): import("./client").RequestResult<EditorCampaignSaveResponses, EditorCampaignSaveErrors, ThrowOnError, "fields">;
|
|
63
|
+
static saveAndSendOrSchedule<ThrowOnError extends boolean = true>(options?: Options<EditorCampaignSaveAndSendOrScheduleData, ThrowOnError>): import("./client").RequestResult<EditorCampaignSaveAndSendOrScheduleResponses, EditorCampaignSaveAndSendOrScheduleErrors, ThrowOnError, "fields">;
|
|
64
64
|
/**
|
|
65
65
|
* Sends a test email from a Campaign that is edited.
|
|
66
66
|
*/
|
|
67
|
-
static sendTestEmail<ThrowOnError extends boolean = true>(options?: Options<EditorCampaignSendTestEmailData, ThrowOnError>): import("
|
|
67
|
+
static sendTestEmail<ThrowOnError extends boolean = true>(options?: Options<EditorCampaignSendTestEmailData, ThrowOnError>): import("./client").RequestResult<EditorCampaignSendTestEmailResponses, EditorCampaignSendTestEmailErrors, ThrowOnError, "fields">;
|
|
68
68
|
}
|
|
69
69
|
export declare class EmailEditorResource {
|
|
70
|
-
static getImageControlData<ThrowOnError extends boolean = true>(options?: Options<EmailEditorGetImageControlDataData, ThrowOnError>): import("
|
|
71
|
-
static getMacros<ThrowOnError extends boolean = true>(options?: Options<EmailEditorGetMacrosData, ThrowOnError>): import("
|
|
70
|
+
static getImageControlData<ThrowOnError extends boolean = true>(options?: Options<EmailEditorGetImageControlDataData, ThrowOnError>): import("./client").RequestResult<EmailEditorGetImageControlDataResponses, EmailEditorGetImageControlDataErrors, ThrowOnError, "fields">;
|
|
71
|
+
static getMacros<ThrowOnError extends boolean = true>(options?: Options<EmailEditorGetMacrosData, ThrowOnError>): import("./client").RequestResult<EmailEditorGetMacrosResponses, EmailEditorGetMacrosErrors, ThrowOnError, "fields">;
|
|
72
72
|
}
|
|
73
73
|
export declare class ImportRecipientsResource {
|
|
74
|
-
static importFixedIssue<ThrowOnError extends boolean = true>(options?: Options<ImportRecipientsImportFixedIssueData, ThrowOnError>): import("
|
|
75
|
-
static performFileImport<ThrowOnError extends boolean = true>(options?: Options<ImportRecipientsPerformFileImportData, ThrowOnError>): import("
|
|
76
|
-
static uploadFileAndParseForMapping<ThrowOnError extends boolean = true>(options?: Options<ImportRecipientsUploadFileAndParseForMappingData, ThrowOnError>): import("
|
|
77
|
-
static uploadPastedAndParseForMapping<ThrowOnError extends boolean = true>(options?: Options<ImportRecipientsUploadPastedAndParseForMappingData, ThrowOnError>): import("
|
|
74
|
+
static importFixedIssue<ThrowOnError extends boolean = true>(options?: Options<ImportRecipientsImportFixedIssueData, ThrowOnError>): import("./client").RequestResult<ImportRecipientsImportFixedIssueResponses, ImportRecipientsImportFixedIssueErrors, ThrowOnError, "fields">;
|
|
75
|
+
static performFileImport<ThrowOnError extends boolean = true>(options?: Options<ImportRecipientsPerformFileImportData, ThrowOnError>): import("./client").RequestResult<ImportRecipientsPerformFileImportResponses, ImportRecipientsPerformFileImportErrors, ThrowOnError, "fields">;
|
|
76
|
+
static uploadFileAndParseForMapping<ThrowOnError extends boolean = true>(options?: Options<ImportRecipientsUploadFileAndParseForMappingData, ThrowOnError>): import("./client").RequestResult<ImportRecipientsUploadFileAndParseForMappingResponses, ImportRecipientsUploadFileAndParseForMappingErrors, ThrowOnError, "fields">;
|
|
77
|
+
static uploadPastedAndParseForMapping<ThrowOnError extends boolean = true>(options?: Options<ImportRecipientsUploadPastedAndParseForMappingData, ThrowOnError>): import("./client").RequestResult<ImportRecipientsUploadPastedAndParseForMappingResponses, ImportRecipientsUploadPastedAndParseForMappingErrors, ThrowOnError, "fields">;
|
|
78
78
|
}
|
|
79
79
|
export declare class MailingListPickerResource {
|
|
80
|
-
static etModel<ThrowOnError extends boolean = true>(options?: Options<MailingListPickerGetModelData, ThrowOnError>): import("
|
|
80
|
+
static etModel<ThrowOnError extends boolean = true>(options?: Options<MailingListPickerGetModelData, ThrowOnError>): import("./client").RequestResult<MailingListPickerGetModelResponses, MailingListPickerGetModelErrors, ThrowOnError, "fields">;
|
|
81
81
|
}
|
|
82
82
|
export declare class MailingListResource {
|
|
83
|
-
static getDetails<ThrowOnError extends boolean = true>(options: Options<MailingListGetDetailsData, ThrowOnError>): import("
|
|
84
|
-
static getOverview<ThrowOnError extends boolean = true>(options: Options<MailingListGetOverviewData, ThrowOnError>): import("
|
|
85
|
-
static getPagedSubscribers<ThrowOnError extends boolean = true>(options: Options<MailingListGetPagedSubscribersData, ThrowOnError>): import("
|
|
86
|
-
static remove<ThrowOnError extends boolean = true>(options: Options<MailingListRemoveData, ThrowOnError>): import("
|
|
87
|
-
static save<ThrowOnError extends boolean = true>(options?: Options<MailingListSaveData, ThrowOnError>): import("
|
|
83
|
+
static getDetails<ThrowOnError extends boolean = true>(options: Options<MailingListGetDetailsData, ThrowOnError>): import("./client").RequestResult<MailingListGetDetailsResponses, MailingListGetDetailsErrors, ThrowOnError, "fields">;
|
|
84
|
+
static getOverview<ThrowOnError extends boolean = true>(options: Options<MailingListGetOverviewData, ThrowOnError>): import("./client").RequestResult<MailingListGetOverviewResponses, MailingListGetOverviewErrors, ThrowOnError, "fields">;
|
|
85
|
+
static getPagedSubscribers<ThrowOnError extends boolean = true>(options: Options<MailingListGetPagedSubscribersData, ThrowOnError>): import("./client").RequestResult<MailingListGetPagedSubscribersResponses, MailingListGetPagedSubscribersErrors, ThrowOnError, "fields">;
|
|
86
|
+
static remove<ThrowOnError extends boolean = true>(options: Options<MailingListRemoveData, ThrowOnError>): import("./client").RequestResult<MailingListRemoveResponses, MailingListRemoveErrors, ThrowOnError, "fields">;
|
|
87
|
+
static save<ThrowOnError extends boolean = true>(options?: Options<MailingListSaveData, ThrowOnError>): import("./client").RequestResult<MailingListSaveResponses, MailingListSaveErrors, ThrowOnError, "fields">;
|
|
88
88
|
}
|
|
89
89
|
export declare class PackageResource {
|
|
90
|
-
static getMenuTree<ThrowOnError extends boolean = true>(options?: Options<PackageGetMenuTreeData, ThrowOnError>): import("
|
|
91
|
-
static getPackageSettings<ThrowOnError extends boolean = true>(options?: Options<PackageGetPackageSettingsData, ThrowOnError>): import("
|
|
90
|
+
static getMenuTree<ThrowOnError extends boolean = true>(options?: Options<PackageGetMenuTreeData, ThrowOnError>): import("./client").RequestResult<PackageGetMenuTreeResponses, PackageGetMenuTreeErrors, ThrowOnError, "fields">;
|
|
91
|
+
static getPackageSettings<ThrowOnError extends boolean = true>(options?: Options<PackageGetPackageSettingsData, ThrowOnError>): import("./client").RequestResult<PackageGetPackageSettingsResponses, PackageGetPackageSettingsErrors, ThrowOnError, "fields">;
|
|
92
92
|
}
|
|
93
93
|
export declare class RecipientResource {
|
|
94
|
-
static getDetails<ThrowOnError extends boolean = true>(options: Options<RecipientGetDetailsData, ThrowOnError>): import("
|
|
95
|
-
static getOverview<ThrowOnError extends boolean = true>(options: Options<RecipientGetOverviewData, ThrowOnError>): import("
|
|
94
|
+
static getDetails<ThrowOnError extends boolean = true>(options: Options<RecipientGetDetailsData, ThrowOnError>): import("./client").RequestResult<RecipientGetDetailsResponses, RecipientGetDetailsErrors, ThrowOnError, "fields">;
|
|
95
|
+
static getOverview<ThrowOnError extends boolean = true>(options: Options<RecipientGetOverviewData, ThrowOnError>): import("./client").RequestResult<RecipientGetOverviewResponses, RecipientGetOverviewErrors, ThrowOnError, "fields">;
|
|
96
96
|
/**
|
|
97
97
|
* Returns a paged list of recipients.
|
|
98
98
|
*/
|
|
99
|
-
static getPagedRecipients<ThrowOnError extends boolean = true>(options: Options<RecipientGetPagedRecipientsData, ThrowOnError>): import("
|
|
100
|
-
static remove<ThrowOnError extends boolean = true>(options: Options<RecipientRemoveData, ThrowOnError>): import("
|
|
101
|
-
static resetErrorsForRecipient<ThrowOnError extends boolean = true>(options: Options<RecipientResetErrorsForRecipientData, ThrowOnError>): import("
|
|
102
|
-
static save<ThrowOnError extends boolean = true>(options?: Options<RecipientSaveData, ThrowOnError>): import("
|
|
99
|
+
static getPagedRecipients<ThrowOnError extends boolean = true>(options: Options<RecipientGetPagedRecipientsData, ThrowOnError>): import("./client").RequestResult<RecipientGetPagedRecipientsResponses, RecipientGetPagedRecipientsErrors, ThrowOnError, "fields">;
|
|
100
|
+
static remove<ThrowOnError extends boolean = true>(options: Options<RecipientRemoveData, ThrowOnError>): import("./client").RequestResult<RecipientRemoveResponses, RecipientRemoveErrors, ThrowOnError, "fields">;
|
|
101
|
+
static resetErrorsForRecipient<ThrowOnError extends boolean = true>(options: Options<RecipientResetErrorsForRecipientData, ThrowOnError>): import("./client").RequestResult<RecipientResetErrorsForRecipientResponses, RecipientResetErrorsForRecipientErrors, ThrowOnError, "fields">;
|
|
102
|
+
static save<ThrowOnError extends boolean = true>(options?: Options<RecipientSaveData, ThrowOnError>): import("./client").RequestResult<RecipientSaveResponses, RecipientSaveErrors, ThrowOnError, "fields">;
|
|
103
103
|
}
|
|
104
104
|
export declare class RecipientsExportResource {
|
|
105
105
|
/**
|
|
106
106
|
* Respond with a CSV file for downloading. Filename information is sent in the response-headers.
|
|
107
107
|
*/
|
|
108
|
-
static getDetails<ThrowOnError extends boolean = true>(options: Options<RecipientsExportGetDetailsData, ThrowOnError>): import("
|
|
108
|
+
static getDetails<ThrowOnError extends boolean = true>(options: Options<RecipientsExportGetDetailsData, ThrowOnError>): import("./client").RequestResult<RecipientsExportGetDetailsResponses, RecipientsExportGetDetailsErrors, ThrowOnError, "fields">;
|
|
109
109
|
}
|
|
110
110
|
export declare class TransactionalPickerResource {
|
|
111
|
-
static getModel<ThrowOnError extends boolean = true>(options?: Options<TransactionalPickerGetModelData, ThrowOnError>): import("
|
|
111
|
+
static getModel<ThrowOnError extends boolean = true>(options?: Options<TransactionalPickerGetModelData, ThrowOnError>): import("./client").RequestResult<TransactionalPickerGetModelResponses, TransactionalPickerGetModelErrors, ThrowOnError, "fields">;
|
|
112
112
|
}
|
|
113
113
|
export declare class TransactionalResource {
|
|
114
|
-
static create<ThrowOnError extends boolean = true>(options?: Options<TransactionalCreateData, ThrowOnError>): import("
|
|
114
|
+
static create<ThrowOnError extends boolean = true>(options?: Options<TransactionalCreateData, ThrowOnError>): import("./client").RequestResult<TransactionalCreateResponses, TransactionalCreateErrors, ThrowOnError, "fields">;
|
|
115
115
|
/**
|
|
116
116
|
* Deletes a transactional email
|
|
117
117
|
*/
|
|
118
|
-
static delete<ThrowOnError extends boolean = true>(options: Options<TransactionalDeleteData, ThrowOnError>): import("
|
|
119
|
-
static getDetails<ThrowOnError extends boolean = true>(options: Options<TransactionalGetDetailsData, ThrowOnError>): import("
|
|
118
|
+
static delete<ThrowOnError extends boolean = true>(options: Options<TransactionalDeleteData, ThrowOnError>): import("./client").RequestResult<TransactionalDeleteResponses, TransactionalDeleteErrors, ThrowOnError, "fields">;
|
|
119
|
+
static getDetails<ThrowOnError extends boolean = true>(options: Options<TransactionalGetDetailsData, ThrowOnError>): import("./client").RequestResult<TransactionalGetDetailsResponses, TransactionalGetDetailsErrors, ThrowOnError, "fields">;
|
|
120
120
|
/**
|
|
121
121
|
* Duplicates a transactional email
|
|
122
122
|
*/
|
|
123
|
-
static duplicate<ThrowOnError extends boolean = true>(options: Options<TransactionalDuplicateData, ThrowOnError>): import("
|
|
124
|
-
static getFieldsByAlias<ThrowOnError extends boolean = true>(options: Options<TransactionalGetFieldsByAliasData, ThrowOnError>): import("
|
|
125
|
-
static getPagedTransactionalListItems<ThrowOnError extends boolean = true>(options?: Options<TransactionalGetPagedTransactionalListItemsData, ThrowOnError>): import("
|
|
126
|
-
static getPagedTransactionalLogItems<ThrowOnError extends boolean = true>(options?: Options<TransactionalGetPagedTransactionalLogItemsData, ThrowOnError>): import("
|
|
123
|
+
static duplicate<ThrowOnError extends boolean = true>(options: Options<TransactionalDuplicateData, ThrowOnError>): import("./client").RequestResult<TransactionalDuplicateResponses, TransactionalDuplicateErrors, ThrowOnError, "fields">;
|
|
124
|
+
static getFieldsByAlias<ThrowOnError extends boolean = true>(options: Options<TransactionalGetFieldsByAliasData, ThrowOnError>): import("./client").RequestResult<TransactionalGetFieldsByAliasResponses, TransactionalGetFieldsByAliasErrors, ThrowOnError, "fields">;
|
|
125
|
+
static getPagedTransactionalListItems<ThrowOnError extends boolean = true>(options?: Options<TransactionalGetPagedTransactionalListItemsData, ThrowOnError>): import("./client").RequestResult<TransactionalGetPagedTransactionalListItemsResponses, TransactionalGetPagedTransactionalListItemsErrors, ThrowOnError, "fields">;
|
|
126
|
+
static getPagedTransactionalLogItems<ThrowOnError extends boolean = true>(options?: Options<TransactionalGetPagedTransactionalLogItemsData, ThrowOnError>): import("./client").RequestResult<TransactionalGetPagedTransactionalLogItemsResponses, TransactionalGetPagedTransactionalLogItemsErrors, ThrowOnError, "fields">;
|
|
127
127
|
/**
|
|
128
128
|
* Renders the content of a "Tracking Transactional" email.
|
|
129
129
|
*/
|
|
130
|
-
static renderTrackingTransactionalEmail<ThrowOnError extends boolean = true>(options: Options<TransactionalRenderTrackingTransactionalEmailData, ThrowOnError>): import("
|
|
131
|
-
static renderTransactional<ThrowOnError extends boolean = true>(options: Options<TransactionalRenderTransactionalData, ThrowOnError>): import("
|
|
132
|
-
static resend<ThrowOnError extends boolean = true>(options?: Options<TransactionalResendData, ThrowOnError>): import("
|
|
133
|
-
static save<ThrowOnError extends boolean = true>(options?: Options<TransactionalSaveData, ThrowOnError>): import("
|
|
130
|
+
static renderTrackingTransactionalEmail<ThrowOnError extends boolean = true>(options: Options<TransactionalRenderTrackingTransactionalEmailData, ThrowOnError>): import("./client").RequestResult<TransactionalRenderTrackingTransactionalEmailResponses, TransactionalRenderTrackingTransactionalEmailErrors, ThrowOnError, "fields">;
|
|
131
|
+
static renderTransactional<ThrowOnError extends boolean = true>(options: Options<TransactionalRenderTransactionalData, ThrowOnError>): import("./client").RequestResult<TransactionalRenderTransactionalResponses, TransactionalRenderTransactionalErrors, ThrowOnError, "fields">;
|
|
132
|
+
static resend<ThrowOnError extends boolean = true>(options?: Options<TransactionalResendData, ThrowOnError>): import("./client").RequestResult<TransactionalResendResponses, TransactionalResendErrors, ThrowOnError, "fields">;
|
|
133
|
+
static save<ThrowOnError extends boolean = true>(options?: Options<TransactionalSaveData, ThrowOnError>): import("./client").RequestResult<TransactionalSaveResponses, TransactionalSaveErrors, ThrowOnError, "fields">;
|
|
134
134
|
/**
|
|
135
135
|
* Sends a test email from a Campaign that is edited.
|
|
136
136
|
*/
|
|
137
|
-
static sendTestEmail<ThrowOnError extends boolean = true>(options?: Options<TransactionalSendTestEmailData, ThrowOnError>): import("
|
|
137
|
+
static sendTestEmail<ThrowOnError extends boolean = true>(options?: Options<TransactionalSendTestEmailData, ThrowOnError>): import("./client").RequestResult<TransactionalSendTestEmailResponses, TransactionalSendTestEmailErrors, ThrowOnError, "fields">;
|
|
138
138
|
/**
|
|
139
139
|
* Returns a NewsletterStudio.Core.Frontend.Transactional.FrontendModels.TrackingTransactionalResponseFrontendModel for the Tracking Transactional detail dialog.
|
|
140
140
|
*/
|
|
141
|
-
static getTrackingTransactional<ThrowOnError extends boolean = true>(options: Options<TransactionalGetTrackingTransactionalData, ThrowOnError>): import("
|
|
141
|
+
static getTrackingTransactional<ThrowOnError extends boolean = true>(options: Options<TransactionalGetTrackingTransactionalData, ThrowOnError>): import("./client").RequestResult<TransactionalGetTrackingTransactionalResponses, TransactionalGetTrackingTransactionalErrors, ThrowOnError, "fields">;
|
|
142
142
|
/**
|
|
143
143
|
* Gets overview for the transactional-section
|
|
144
144
|
*/
|
|
145
|
-
static getTransactionalActivities<ThrowOnError extends boolean = true>(options: Options<TransactionalGetTransactionalActivitiesData, ThrowOnError>): import("
|
|
145
|
+
static getTransactionalActivities<ThrowOnError extends boolean = true>(options: Options<TransactionalGetTransactionalActivitiesData, ThrowOnError>): import("./client").RequestResult<TransactionalGetTransactionalActivitiesResponses, TransactionalGetTransactionalActivitiesErrors, ThrowOnError, "fields">;
|
|
146
146
|
/**
|
|
147
147
|
* Gets overview for email list
|
|
148
148
|
*/
|
|
149
|
-
static getTransactionalEmailsOverview<ThrowOnError extends boolean = true>(options: Options<TransactionalGetTransactionalEmailsOverviewData, ThrowOnError>): import("
|
|
149
|
+
static getTransactionalEmailsOverview<ThrowOnError extends boolean = true>(options: Options<TransactionalGetTransactionalEmailsOverviewData, ThrowOnError>): import("./client").RequestResult<TransactionalGetTransactionalEmailsOverviewResponses, TransactionalGetTransactionalEmailsOverviewErrors, ThrowOnError, "fields">;
|
|
150
150
|
}
|
|
151
151
|
export declare class V1Resource {
|
|
152
|
-
static bugSignalProgress<ThrowOnError extends boolean = true>(options?: Options<DebugSignalProgressData, ThrowOnError>): import("
|
|
153
|
-
static bugHubDebugMessage<ThrowOnError extends boolean = true>(options?: Options<DebugHubDebugMessageData, ThrowOnError>): import("
|
|
152
|
+
static bugSignalProgress<ThrowOnError extends boolean = true>(options?: Options<DebugSignalProgressData, ThrowOnError>): import("./client").RequestResult<DebugSignalProgressResponses, unknown, ThrowOnError, "fields">;
|
|
153
|
+
static bugHubDebugMessage<ThrowOnError extends boolean = true>(options?: Options<DebugHubDebugMessageData, ThrowOnError>): import("./client").RequestResult<DebugHubDebugMessageResponses, unknown, ThrowOnError, "fields">;
|
|
154
154
|
}
|
|
155
155
|
export declare class WorkspaceResource {
|
|
156
156
|
/**
|
|
157
157
|
* Endpoint to create a new workspace
|
|
158
158
|
*/
|
|
159
|
-
static createNew<ThrowOnError extends boolean = true>(options?: Options<WorkspaceCreateNewData, ThrowOnError>): import("
|
|
159
|
+
static createNew<ThrowOnError extends boolean = true>(options?: Options<WorkspaceCreateNewData, ThrowOnError>): import("./client").RequestResult<WorkspaceCreateNewResponses, WorkspaceCreateNewErrors, ThrowOnError, "fields">;
|
|
160
160
|
/**
|
|
161
161
|
* Returns dashboard overview for a given workspace
|
|
162
162
|
*/
|
|
163
|
-
static getDashboardOverview<ThrowOnError extends boolean = true>(options: Options<WorkspaceGetDashboardOverviewData, ThrowOnError>): import("
|
|
163
|
+
static getDashboardOverview<ThrowOnError extends boolean = true>(options: Options<WorkspaceGetDashboardOverviewData, ThrowOnError>): import("./client").RequestResult<WorkspaceGetDashboardOverviewResponses, WorkspaceGetDashboardOverviewErrors, ThrowOnError, "fields">;
|
|
164
164
|
/**
|
|
165
165
|
* Returns dashboard overview for a given workspace
|
|
166
166
|
*/
|
|
167
|
-
static getDashboardSection<ThrowOnError extends boolean = true>(options?: Options<WorkspaceGetDashboardSectionData, ThrowOnError>): import("
|
|
168
|
-
static licenseConnect<ThrowOnError extends boolean = true>(options?: Options<WorkspaceLicenseConnectData, ThrowOnError>): import("
|
|
169
|
-
static licenseLogin<ThrowOnError extends boolean = true>(options?: Options<WorkspaceLicenseLoginData, ThrowOnError>): import("
|
|
167
|
+
static getDashboardSection<ThrowOnError extends boolean = true>(options?: Options<WorkspaceGetDashboardSectionData, ThrowOnError>): import("./client").RequestResult<WorkspaceGetDashboardSectionResponses, WorkspaceGetDashboardSectionErrors, ThrowOnError, "fields">;
|
|
168
|
+
static licenseConnect<ThrowOnError extends boolean = true>(options?: Options<WorkspaceLicenseConnectData, ThrowOnError>): import("./client").RequestResult<WorkspaceLicenseConnectResponses, WorkspaceLicenseConnectErrors, ThrowOnError, "fields">;
|
|
169
|
+
static licenseLogin<ThrowOnError extends boolean = true>(options?: Options<WorkspaceLicenseLoginData, ThrowOnError>): import("./client").RequestResult<WorkspaceLicenseLoginResponses, WorkspaceLicenseLoginErrors, ThrowOnError, "fields">;
|
|
170
170
|
/**
|
|
171
171
|
* Gets manage-model for "Administration-Manage"-view
|
|
172
172
|
*/
|
|
173
|
-
static getManage<ThrowOnError extends boolean = true>(options: Options<WorkspaceGetManageData, ThrowOnError>): import("
|
|
173
|
+
static getManage<ThrowOnError extends boolean = true>(options: Options<WorkspaceGetManageData, ThrowOnError>): import("./client").RequestResult<WorkspaceGetManageResponses, WorkspaceGetManageErrors, ThrowOnError, "fields">;
|
|
174
174
|
/**
|
|
175
175
|
* Gets the all Workspaces for listing in the "Administration"-view
|
|
176
176
|
*/
|
|
177
|
-
static getOverview<ThrowOnError extends boolean = true>(options?: Options<WorkspaceGetOverviewData, ThrowOnError>): import("
|
|
178
|
-
static remove<ThrowOnError extends boolean = true>(options: Options<WorkspaceRemoveData, ThrowOnError>): import("
|
|
177
|
+
static getOverview<ThrowOnError extends boolean = true>(options?: Options<WorkspaceGetOverviewData, ThrowOnError>): import("./client").RequestResult<WorkspaceGetOverviewResponses, WorkspaceGetOverviewErrors, ThrowOnError, "fields">;
|
|
178
|
+
static remove<ThrowOnError extends boolean = true>(options: Options<WorkspaceRemoveData, ThrowOnError>): import("./client").RequestResult<WorkspaceRemoveResponses, WorkspaceRemoveErrors, ThrowOnError, "fields">;
|
|
179
179
|
/**
|
|
180
180
|
* Saves manage-settings for "Administration-Manage"-view
|
|
181
181
|
*/
|
|
182
|
-
static saveManage<ThrowOnError extends boolean = true>(options?: Options<WorkspaceSaveManageData, ThrowOnError>): import("
|
|
183
|
-
static saveSettings<ThrowOnError extends boolean = true>(options?: Options<WorkspaceSaveSettingsData, ThrowOnError>): import("
|
|
182
|
+
static saveManage<ThrowOnError extends boolean = true>(options?: Options<WorkspaceSaveManageData, ThrowOnError>): import("./client").RequestResult<WorkspaceSaveManageResponses, WorkspaceSaveManageErrors, ThrowOnError, "fields">;
|
|
183
|
+
static saveSettings<ThrowOnError extends boolean = true>(options?: Options<WorkspaceSaveSettingsData, ThrowOnError>): import("./client").RequestResult<WorkspaceSaveSettingsResponses, WorkspaceSaveSettingsErrors, ThrowOnError, "fields">;
|
|
184
184
|
/**
|
|
185
185
|
* Gets settings-model for "Workspace-Settings"-view
|
|
186
186
|
*/
|
|
187
|
-
static getSettings<ThrowOnError extends boolean = true>(options: Options<WorkspaceGetSettingsData, ThrowOnError>): import("
|
|
188
|
-
static testPop3Server<ThrowOnError extends boolean = true>(options?: Options<WorkspaceTestPop3ServerData, ThrowOnError>): import("
|
|
187
|
+
static getSettings<ThrowOnError extends boolean = true>(options: Options<WorkspaceGetSettingsData, ThrowOnError>): import("./client").RequestResult<WorkspaceGetSettingsResponses, WorkspaceGetSettingsErrors, ThrowOnError, "fields">;
|
|
188
|
+
static testPop3Server<ThrowOnError extends boolean = true>(options?: Options<WorkspaceTestPop3ServerData, ThrowOnError>): import("./client").RequestResult<WorkspaceTestPop3ServerResponses, WorkspaceTestPop3ServerErrors, ThrowOnError, "fields">;
|
|
189
189
|
}
|
|
@@ -1,3 +1,6 @@
|
|
|
1
|
+
export type ClientOptions = {
|
|
2
|
+
baseUrl: 'http://localhost:14655' | (string & {});
|
|
3
|
+
};
|
|
1
4
|
export type ButtonEmailControlDataModel = {
|
|
2
5
|
/**
|
|
3
6
|
* Contains information for a NewsletterStudio.Core.Editor.Models.IEmailControl to indicate things about it's surrounding column and row.
|
|
@@ -622,6 +625,9 @@ export type LicensesResponseFrontendModel = {
|
|
|
622
625
|
* This will be set if there was a "direct match" for the license
|
|
623
626
|
*/
|
|
624
627
|
details: LicenseDetailsResponseFrontendModel;
|
|
628
|
+
/**
|
|
629
|
+
* This collection will only be populated when there are no "direct match" and the user needs to select a license to use.
|
|
630
|
+
*/
|
|
625
631
|
licenses: Array<LicenseResponseFrontendModel>;
|
|
626
632
|
};
|
|
627
633
|
/**
|
|
@@ -750,7 +756,7 @@ export type MergeFieldModel = {
|
|
|
750
756
|
/**
|
|
751
757
|
* The Text / Label for the Merge Field. If this is set it will be used over any Translation Key.
|
|
752
758
|
*/
|
|
753
|
-
text
|
|
759
|
+
text?: string | null;
|
|
754
760
|
/**
|
|
755
761
|
* If set it will override Text with translated value if translation exists.
|
|
756
762
|
*/
|
|
@@ -758,7 +764,7 @@ export type MergeFieldModel = {
|
|
|
758
764
|
/**
|
|
759
765
|
* If the merge field belongs to a group, use this to indicate the group name
|
|
760
766
|
*/
|
|
761
|
-
groupText
|
|
767
|
+
groupText?: string | null;
|
|
762
768
|
/**
|
|
763
769
|
* If set it will override GroupText with translated value if translation exists.
|
|
764
770
|
*/
|
|
@@ -767,10 +773,15 @@ export type MergeFieldModel = {
|
|
|
767
773
|
* Placeholder to use in html-template
|
|
768
774
|
*/
|
|
769
775
|
placeholder: string;
|
|
776
|
+
/**
|
|
777
|
+
* Defines HTML to be inserted in e.g. the Rich Text Editor. Expected to contain the NewsletterStudio.Core.Rendering.MergeField.Placeholder as well.
|
|
778
|
+
* Use this to e.g. insert a link in the RTE
|
|
779
|
+
*/
|
|
780
|
+
html?: string | null;
|
|
770
781
|
/**
|
|
771
782
|
* Tooltip to show in the UI (optional)
|
|
772
783
|
*/
|
|
773
|
-
tooltip
|
|
784
|
+
tooltip?: string | null;
|
|
774
785
|
};
|
|
775
786
|
export type NotificationHeaderModel = {
|
|
776
787
|
message: string;
|
|
@@ -1445,6 +1456,123 @@ export type WorkspacesOverviewResponseFrontendModel = {
|
|
|
1445
1456
|
licenseDetails: LicenseDetailsResponseFrontendModel;
|
|
1446
1457
|
workspaces: Array<WorkspaceListItemFrontendModel>;
|
|
1447
1458
|
};
|
|
1459
|
+
export type ButtonEmailControlDataModelWritable = {
|
|
1460
|
+
/**
|
|
1461
|
+
* Contains information for a NewsletterStudio.Core.Editor.Models.IEmailControl to indicate things about it's surrounding column and row.
|
|
1462
|
+
*/
|
|
1463
|
+
rowAndColumnInfo: RowAndColumnInfoModel;
|
|
1464
|
+
meta: {
|
|
1465
|
+
[key: string]: unknown;
|
|
1466
|
+
};
|
|
1467
|
+
buttonText: string;
|
|
1468
|
+
/**
|
|
1469
|
+
* Holds value for button link, a udi or a string with http-url.
|
|
1470
|
+
*/
|
|
1471
|
+
buttonLink: string;
|
|
1472
|
+
buttonSize: string;
|
|
1473
|
+
isInverted: boolean;
|
|
1474
|
+
align: string;
|
|
1475
|
+
backgroundColor: string;
|
|
1476
|
+
textColor: string;
|
|
1477
|
+
padding: PaddingModel;
|
|
1478
|
+
/**
|
|
1479
|
+
* Nullable setting for rounded corners. Needs to be nullable to allow email or theme level settings.
|
|
1480
|
+
*/
|
|
1481
|
+
borderRadius?: number | null;
|
|
1482
|
+
};
|
|
1483
|
+
export type CampaignReportOverviewResponseFrontendModelWritable = {
|
|
1484
|
+
campaignId: number;
|
|
1485
|
+
campaignName: string;
|
|
1486
|
+
campaignSenderName: string;
|
|
1487
|
+
campaignSenderEmail: string;
|
|
1488
|
+
campaignSubject: string;
|
|
1489
|
+
campaignSentDate: string;
|
|
1490
|
+
campaignRecipientLists: Array<ListItemIdAndLabelValueFrontendModel>;
|
|
1491
|
+
countTotalRecipients: number;
|
|
1492
|
+
countUniqueOpen: number;
|
|
1493
|
+
countUniqueClick: number;
|
|
1494
|
+
countDeliveryFailed: number;
|
|
1495
|
+
countUnsubscribed: number;
|
|
1496
|
+
timings: {
|
|
1497
|
+
[key: string]: string;
|
|
1498
|
+
};
|
|
1499
|
+
chart: CampaignReportChartFrontendModel;
|
|
1500
|
+
clickSummery: CampaignReportClicksOverviewFrontendModel;
|
|
1501
|
+
};
|
|
1502
|
+
export type CampaignReportsClickDetailsFrontendModelWritable = {
|
|
1503
|
+
url: string;
|
|
1504
|
+
unique: number;
|
|
1505
|
+
total: number;
|
|
1506
|
+
};
|
|
1507
|
+
export type DividerEmailControlDataModelWritable = {
|
|
1508
|
+
/**
|
|
1509
|
+
* Contains information for a NewsletterStudio.Core.Editor.Models.IEmailControl to indicate things about it's surrounding column and row.
|
|
1510
|
+
*/
|
|
1511
|
+
rowAndColumnInfo: RowAndColumnInfoModel;
|
|
1512
|
+
meta: {
|
|
1513
|
+
[key: string]: unknown;
|
|
1514
|
+
};
|
|
1515
|
+
lineThickness?: number | null;
|
|
1516
|
+
lineColor?: string | null;
|
|
1517
|
+
padding: PaddingModel;
|
|
1518
|
+
};
|
|
1519
|
+
export type ImageEmailControlDataModelWritable = {
|
|
1520
|
+
/**
|
|
1521
|
+
* Contains information for a NewsletterStudio.Core.Editor.Models.IEmailControl to indicate things about it's surrounding column and row.
|
|
1522
|
+
*/
|
|
1523
|
+
rowAndColumnInfo: RowAndColumnInfoModel;
|
|
1524
|
+
meta: {
|
|
1525
|
+
[key: string]: unknown;
|
|
1526
|
+
};
|
|
1527
|
+
padding: PaddingModel;
|
|
1528
|
+
imageUdi: string;
|
|
1529
|
+
/**
|
|
1530
|
+
* Alignment for image (default should be center/middle)
|
|
1531
|
+
*/
|
|
1532
|
+
align: string;
|
|
1533
|
+
/**
|
|
1534
|
+
* Stores any link value. Ie a udi for content/media or a url.
|
|
1535
|
+
*/
|
|
1536
|
+
link?: string | null;
|
|
1537
|
+
/**
|
|
1538
|
+
* A number from 1 to 600 (4-columns) or lower that indicates that size of the image. Used to calculate crop.
|
|
1539
|
+
*/
|
|
1540
|
+
imageSize: number;
|
|
1541
|
+
/**
|
|
1542
|
+
* Holds a value for image Height, only applicable when AspectRatio is "custom" otherwise configured aspect ratio will decide height.
|
|
1543
|
+
*/
|
|
1544
|
+
imageHeight: number;
|
|
1545
|
+
/**
|
|
1546
|
+
* Holds selected aspect ratio. (original, 169,43,square or custom)
|
|
1547
|
+
*/
|
|
1548
|
+
aspectRatio: string;
|
|
1549
|
+
};
|
|
1550
|
+
export type MacroEmailControlDataModelWritable = {
|
|
1551
|
+
/**
|
|
1552
|
+
* Contains information for a NewsletterStudio.Core.Editor.Models.IEmailControl to indicate things about it's surrounding column and row.
|
|
1553
|
+
*/
|
|
1554
|
+
rowAndColumnInfo: RowAndColumnInfoModel;
|
|
1555
|
+
meta: {
|
|
1556
|
+
[key: string]: unknown;
|
|
1557
|
+
};
|
|
1558
|
+
padding: PaddingModel;
|
|
1559
|
+
macroPath: string;
|
|
1560
|
+
};
|
|
1561
|
+
export type TextEmailControlDataModelWritable = {
|
|
1562
|
+
/**
|
|
1563
|
+
* Contains information for a NewsletterStudio.Core.Editor.Models.IEmailControl to indicate things about it's surrounding column and row.
|
|
1564
|
+
*/
|
|
1565
|
+
rowAndColumnInfo: RowAndColumnInfoModel;
|
|
1566
|
+
meta: {
|
|
1567
|
+
[key: string]: unknown;
|
|
1568
|
+
};
|
|
1569
|
+
html: string;
|
|
1570
|
+
padding: PaddingModel;
|
|
1571
|
+
textColor: string;
|
|
1572
|
+
linkColor: string;
|
|
1573
|
+
fontSize: string;
|
|
1574
|
+
fontFamily: string;
|
|
1575
|
+
};
|
|
1448
1576
|
export type CampaignReportGetOverviewData = {
|
|
1449
1577
|
body?: never;
|
|
1450
1578
|
path: {
|
|
@@ -2052,7 +2180,7 @@ export type EditorCampaignSendTestEmailResponses = {
|
|
|
2052
2180
|
};
|
|
2053
2181
|
export type EditorCampaignSendTestEmailResponse = EditorCampaignSendTestEmailResponses[keyof EditorCampaignSendTestEmailResponses];
|
|
2054
2182
|
export type EmailEditorGetImageControlDataData = {
|
|
2055
|
-
body?:
|
|
2183
|
+
body?: ImageEmailControlDataModelWritable;
|
|
2056
2184
|
path?: never;
|
|
2057
2185
|
query?: never;
|
|
2058
2186
|
url: '/umbraco/management/api/newsletter-studio/email-editor/get-image-control-data';
|
|
@@ -3350,6 +3478,3 @@ export type WorkspaceTestPop3ServerResponses = {
|
|
|
3350
3478
|
200: boolean;
|
|
3351
3479
|
};
|
|
3352
3480
|
export type WorkspaceTestPop3ServerResponse = WorkspaceTestPop3ServerResponses[keyof WorkspaceTestPop3ServerResponses];
|
|
3353
|
-
export type ClientOptions = {
|
|
3354
|
-
baseUrl: 'http://localhost:14655' | (string & {});
|
|
3355
|
-
};
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import '@newsletterstudio/umbraco/components';
|
|
2
2
|
import { UmbLitElement } from '@umbraco-cms/backoffice/lit-element';
|
|
3
|
-
declare const NsCheckboxListElement_base: import("@umbraco-cms/backoffice/extension-api").HTMLElementConstructor<import("@umbraco-cms/backoffice/validation").UmbFormControlMixinElement<string[]>> & typeof UmbLitElement;
|
|
3
|
+
declare const NsCheckboxListElement_base: import("@umbraco-cms/backoffice/extension-api").HTMLElementConstructor<import("@umbraco-cms/backoffice/validation").UmbFormControlMixinElement<string[] | undefined>> & typeof UmbLitElement;
|
|
4
4
|
/**
|
|
5
5
|
* Provides a list of ns-checkbox elements and keeps the alias of selected items in an array.
|
|
6
6
|
* @element ns-checkbox-list
|
package/dist/core/components/ns-email-address-collection/ns-email-address-collection.element.d.ts
CHANGED
|
@@ -3,7 +3,7 @@ export type NsEmailAddress = {
|
|
|
3
3
|
email: string;
|
|
4
4
|
displayName: string;
|
|
5
5
|
};
|
|
6
|
-
declare const NsEmailAddressCollectionElement_base: import("@umbraco-cms/backoffice/extension-api").HTMLElementConstructor<import("@umbraco-cms/backoffice/element-api").UmbElement> & (new (...args: any[]) => import("@umbraco-ui/uui-base").UUIFormControlMixinElement<NsEmailAddress[]>) & typeof LitElement;
|
|
6
|
+
declare const NsEmailAddressCollectionElement_base: import("@umbraco-cms/backoffice/extension-api").HTMLElementConstructor<import("@umbraco-cms/backoffice/element-api").UmbElement> & (new (...args: any[]) => import("@umbraco-ui/uui-base").UUIFormControlMixinElement<NsEmailAddress[] | undefined>) & typeof LitElement;
|
|
7
7
|
/**
|
|
8
8
|
* ns-email-address-collection description
|
|
9
9
|
* @element ns-email-address-collection
|
|
@@ -12,6 +12,9 @@ export declare class NsEmailCampaignSendElement extends NsEmailCampaignSendEleme
|
|
|
12
12
|
workspaceKey: string;
|
|
13
13
|
sendType?: SendType;
|
|
14
14
|
recipients?: string[];
|
|
15
|
+
/**
|
|
16
|
+
* Scheduled date as UTC
|
|
17
|
+
*/
|
|
15
18
|
scheduledDate?: string | undefined | null;
|
|
16
19
|
validation?: CampaignSendingValidationResultFrontendModel;
|
|
17
20
|
constructor();
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { UmbLitElement } from '@umbraco-cms/backoffice/lit-element';
|
|
2
2
|
import type { MailingListPickerWorkspaceItemFrontendModel, MailingListPropertyEditorSelectionFrontendModel, MailingListPropertyEditorValueModel } from '@newsletterstudio/umbraco/backend';
|
|
3
|
-
declare const NsMailingListPickerElement_base: import("@umbraco-cms/backoffice/extension-api").HTMLElementConstructor<import("@umbraco-cms/backoffice/validation").UmbFormControlMixinElement<MailingListPropertyEditorValueModel[]>> & typeof UmbLitElement;
|
|
3
|
+
declare const NsMailingListPickerElement_base: import("@umbraco-cms/backoffice/extension-api").HTMLElementConstructor<import("@umbraco-cms/backoffice/validation").UmbFormControlMixinElement<MailingListPropertyEditorValueModel[] | undefined>> & typeof UmbLitElement;
|
|
4
4
|
/**
|
|
5
5
|
* ns-mailing-list-picker description
|
|
6
6
|
* @element ns-mailing-list-picker
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { UmbLitElement } from '@umbraco-cms/backoffice/lit-element';
|
|
2
2
|
import type { NsCheckboxListChangedEvent } from '../ns-checkbox-list/ns-checkbox-list.element.js';
|
|
3
3
|
import { type RecipientListProviderResponseFrontendModel } from '@newsletterstudio/umbraco/backend';
|
|
4
|
-
declare const NsRecipientListPickerElement_base: import("@umbraco-cms/backoffice/extension-api").HTMLElementConstructor<import("@umbraco-cms/backoffice/validation").UmbFormControlMixinElement<string[]>> & typeof UmbLitElement;
|
|
4
|
+
declare const NsRecipientListPickerElement_base: import("@umbraco-cms/backoffice/extension-api").HTMLElementConstructor<import("@umbraco-cms/backoffice/validation").UmbFormControlMixinElement<string[] | undefined>> & typeof UmbLitElement;
|
|
5
5
|
/**
|
|
6
6
|
* ns-recipient-list-picker description
|
|
7
7
|
* @element ns-recipient-list-picker
|
|
@@ -3,7 +3,7 @@ export type Option = {
|
|
|
3
3
|
value: string;
|
|
4
4
|
name: string;
|
|
5
5
|
};
|
|
6
|
-
declare const NsSelectElement_base: import("@umbraco-cms/backoffice/extension-api").HTMLElementConstructor<import("@umbraco-cms/backoffice/element-api").UmbElement> & (new (...args: any[]) => import("@umbraco-ui/uui-base").UUIFormControlMixinElement<string>) & typeof LitElement;
|
|
6
|
+
declare const NsSelectElement_base: import("@umbraco-cms/backoffice/extension-api").HTMLElementConstructor<import("@umbraco-cms/backoffice/element-api").UmbElement> & (new (...args: any[]) => import("@umbraco-ui/uui-base").UUIFormControlMixinElement<string | undefined>) & typeof LitElement;
|
|
7
7
|
/**
|
|
8
8
|
* ns-select description
|
|
9
9
|
* @element ns-select
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { UmbLitElement } from '@umbraco-cms/backoffice/lit-element';
|
|
2
2
|
import type { TransactionalEmailPickerWorkspaceFrontendModel, TransactionalEmailPropertyEditorSelectionFrontendModel, TransactionalEmailPropertyEditorValueModel } from '@newsletterstudio/umbraco/backend';
|
|
3
|
-
declare const NsTransactionalEmailPickerElement_base: import("@umbraco-cms/backoffice/extension-api").HTMLElementConstructor<import("@umbraco-cms/backoffice/validation").UmbFormControlMixinElement<TransactionalEmailPropertyEditorValueModel[]>> & typeof UmbLitElement;
|
|
3
|
+
declare const NsTransactionalEmailPickerElement_base: import("@umbraco-cms/backoffice/extension-api").HTMLElementConstructor<import("@umbraco-cms/backoffice/validation").UmbFormControlMixinElement<TransactionalEmailPropertyEditorValueModel[] | undefined>> & typeof UmbLitElement;
|
|
4
4
|
/**
|
|
5
5
|
* ns-transactional-email-picker description
|
|
6
6
|
* @element ns-transactional-email-picker
|