@wix/auto_sdk_papyrus_templates 1.0.0

package/build/cjs/index.typings.d.ts

@@ -0,0 +1,1102 @@
+import * as _wix_sdk_types from '@wix/sdk-types';
+import { QuerySpec, Query } from '@wix/sdk-types';
+
+interface TemplateSettings {
+    /**
+     * Auto generated ID.
+     * @format GUID
+     * @readonly
+     */
+    _id?: string | null;
+    /**
+     * Wix app definition ID.
+     * @minLength 1
+     * @maxLength 20
+     */
+    appSlug?: string | null;
+    /**
+     * The type of the template.
+     * @minLength 1
+     * @maxLength 20
+     */
+    templateType?: string | null;
+    /**
+     * The id of the template.
+     * @minLength 1
+     * @maxLength 20
+     */
+    templateId?: string | null;
+    /**
+     * Template settings external ID. For example ticket definition ID.
+     * Must be unique per tenant where tenant is taken from authorization (wix_app_id + meta_site_id)
+     * @minLength 1
+     * @maxLength 100
+     */
+    externalId?: string | null;
+    /**
+     * Date settings were created.
+     * @readonly
+     */
+    _createdDate?: Date | null;
+    /**
+     * Date settings were updated.
+     * @readonly
+     */
+    _updatedDate?: Date | null;
+    /** @maxSize 10 */
+    settingGroups?: SettingsGroup[];
+    /** Paper size */
+    paperSize?: PaperSizeWithLiterals;
+    pageOverflow?: PageOverflowWithLiterals;
+}
+interface TextSetting {
+    /**
+     * Font family class name
+     * @maxLength 20
+     */
+    fontFamily?: string | null;
+    /**
+     * Font style class names
+     * @maxSize 10
+     * @maxLength 20
+     */
+    fontStyle?: string[];
+    /**
+     * Text alignment class name
+     * @maxLength 20
+     */
+    textAlignment?: string | null;
+    /**
+     * Text color hex code
+     * @minLength 7
+     * @maxLength 7
+     */
+    textColor?: string | null;
+    /**
+     * Font size
+     * @min 1
+     */
+    fontSize?: number | null;
+    /** Text content setting */
+    textContent?: TextContent[];
+}
+interface TextContent {
+    /**
+     * @minLength 3
+     * @maxLength 50
+     */
+    _id?: string;
+    /** @maxLength 500 */
+    value?: string | null;
+    visible?: boolean;
+}
+interface ImageSetting {
+    /** Wix media Image */
+    image?: string;
+    /** Image resizing mode */
+    resize?: ResizeOptionWithLiterals;
+}
+interface FocalPoint {
+    /** X-coordinate of the focal point. */
+    x?: number;
+    /** Y-coordinate of the focal point. */
+    y?: number;
+    /** crop by height */
+    height?: number | null;
+    /** crop by width */
+    width?: number | null;
+}
+declare enum ResizeOption {
+    /** Automatically resizes full image to fit image field */
+    FIT = "FIT",
+    /** Enables user to manually crop image to fit image field */
+    CROP = "CROP"
+}
+/** @enumType */
+type ResizeOptionWithLiterals = ResizeOption | 'FIT' | 'CROP';
+interface SelectSetting {
+    /** Selected value */
+    value?: string | null;
+    /**
+     * Color hex code
+     * @minLength 7
+     * @maxLength 7
+     */
+    primaryColor?: string | null;
+    /**
+     * Color hex code
+     * @minLength 7
+     * @maxLength 7
+     */
+    secondaryColor?: string | null;
+    /** Size */
+    size?: number | null;
+}
+interface BackgroundSetting {
+    /**
+     * Color of the background hex code
+     * @minLength 7
+     * @maxLength 9
+     */
+    color?: string | null;
+    /** Wix media Image */
+    image?: string;
+}
+interface SettingsGroup {
+    /**
+     * Id of the control group
+     * @minLength 5
+     * @maxLength 50
+     */
+    groupId?: string;
+    /**
+     * Display settings.
+     * @maxSize 20
+     */
+    display?: Record<string, boolean>;
+    /**
+     * Texts settings.
+     * @maxSize 20
+     */
+    texts?: Record<string, TextSetting>;
+    /**
+     * Images settings.
+     * @maxSize 10
+     */
+    images?: Record<string, ImageSetting>;
+    /**
+     * Select option settings.
+     * @maxSize 20
+     */
+    selects?: Record<string, SelectSetting>;
+    /**
+     * Backgrounds settings.
+     * @maxSize 20
+     */
+    backgrounds?: Record<string, BackgroundSetting>;
+}
+declare enum PaperSize {
+    A4_PORTRAIT = "A4_PORTRAIT",
+    A4_LANDSCAPE = "A4_LANDSCAPE"
+}
+/** @enumType */
+type PaperSizeWithLiterals = PaperSize | 'A4_PORTRAIT' | 'A4_LANDSCAPE';
+declare enum PageOverflow {
+    CONTENT_HIDDEN = "CONTENT_HIDDEN",
+    CONTENT_BREAK = "CONTENT_BREAK"
+}
+/** @enumType */
+type PageOverflowWithLiterals = PageOverflow | 'CONTENT_HIDDEN' | 'CONTENT_BREAK';
+interface CreateTemplateSettingsRequest {
+    /** Settings to be created. */
+    settings?: TemplateSettings;
+}
+interface CreateTemplateSettingsResponse {
+    /** Created settings. */
+    settings?: TemplateSettings;
+}
+interface BulkCreateTemplateSettingsRequest {
+    /**
+     * Settings to be created.
+     * @minSize 1
+     * @maxSize 100
+     */
+    settings?: TemplateSettings[];
+}
+interface BulkCreateTemplateSettingsResponse {
+    /** Created settings */
+    settings?: TemplateSettings[];
+}
+interface UpsertTemplateSettingsRequest {
+    /** Settings to be upserted. */
+    settings?: TemplateSettings;
+}
+interface UpsertTemplateSettingsResponse {
+    /** Upserted settings. */
+    settings?: TemplateSettings;
+}
+interface GetTemplateSettingsRequest {
+    /**
+     * Settings ID.
+     * @format GUID
+     */
+    templateSettingsId?: string;
+}
+interface GetTemplateSettingsResponse {
+    /** Retrieved settings. */
+    settings?: TemplateSettings;
+}
+interface UpdateTemplateSettingsRequest {
+    /** Template Settings to be updated. */
+    settings?: TemplateSettings;
+}
+interface UpdateTemplateSettingsResponse {
+    /** Updated settings. */
+    settings?: TemplateSettings;
+}
+interface DeleteTemplateSettingsRequest {
+    /**
+     * Settings ID.
+     * @format GUID
+     */
+    templateSettingsId?: string;
+}
+interface DeleteTemplateSettingsResponse {
+    /** Deleted settings. */
+    settings?: TemplateSettings;
+}
+interface QueryTemplateSettingsRequest {
+    /** Generic query object. */
+    query: QueryV2;
+}
+interface QueryV2 extends QueryV2PagingMethodOneOf {
+    /** Paging options to limit and offset the number of items. */
+    paging?: Paging;
+    /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
+    cursorPaging?: CursorPaging;
+    /**
+     * Filter object.
+     *
+     * Learn more about [filtering](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#filters).
+     */
+    filter?: Record<string, any> | null;
+    /**
+     * Sort object.
+     *
+     * Learn more about [sorting](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#sorting).
+     */
+    sort?: Sorting[];
+    /** Array of projected fields. A list of specific field names to return. If `fieldsets` are also specified, the union of `fieldsets` and `fields` is returned. */
+    fields?: string[];
+    /** Array of named, predefined sets of projected fields. A array of predefined named sets of fields to be returned. Specifying multiple `fieldsets` will return the union of fields from all sets. If `fields` are also specified, the union of `fieldsets` and `fields` is returned. */
+    fieldsets?: string[];
+}
+/** @oneof */
+interface QueryV2PagingMethodOneOf {
+    /** Paging options to limit and offset the number of items. */
+    paging?: Paging;
+    /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
+    cursorPaging?: CursorPaging;
+}
+interface Sorting {
+    /**
+     * Name of the field to sort by.
+     * @maxLength 512
+     */
+    fieldName?: string;
+    /** Sort order. */
+    order?: SortOrderWithLiterals;
+}
+declare enum SortOrder {
+    ASC = "ASC",
+    DESC = "DESC"
+}
+/** @enumType */
+type SortOrderWithLiterals = SortOrder | 'ASC' | 'DESC';
+interface Paging {
+    /** Number of items to load. */
+    limit?: number | null;
+    /** Number of items to skip in the current sort order. */
+    offset?: number | null;
+}
+interface CursorPaging {
+    /**
+     * Maximum number of items to return in the results.
+     * @max 100
+     */
+    limit?: number | null;
+    /**
+     * Pointer to the next or previous page in the list of results.
+     *
+     * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
+     * Not relevant for the first request.
+     * @maxLength 16000
+     */
+    cursor?: string | null;
+}
+interface QueryTemplateSettingsResponse {
+    /** Template settings results. */
+    settings?: TemplateSettings[];
+    /** Query result's metadata. */
+    metadata?: PagingMetadataV2;
+}
+interface PagingMetadataV2 {
+    /** Number of items returned in the response. */
+    count?: number | null;
+    /** Offset that was requested. */
+    offset?: number | null;
+    /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
+    total?: number | null;
+    /** Flag that indicates the server failed to calculate the `total` field. */
+    tooManyToCount?: boolean | null;
+    /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
+    cursors?: Cursors;
+}
+interface Cursors {
+    /**
+     * Cursor string pointing to the next page in the list of results.
+     * @maxLength 16000
+     */
+    next?: string | null;
+    /**
+     * Cursor pointing to the previous page in the list of results.
+     * @maxLength 16000
+     */
+    prev?: string | null;
+}
+interface ResolveTemplateSettingsRequest {
+    /**
+     * The id of the settings.
+     * @format GUID
+     */
+    templateSettingsId?: string | null;
+    /**
+     * External ID.
+     * @maxLength 100
+     */
+    templateSettingsExternalId?: string | null;
+    /**
+     * The type of the template. Used to resolve default settings.
+     * @minLength 1
+     * @maxLength 20
+     */
+    templateType: string | null;
+    /**
+     * Wix app slug.
+     * @minLength 1
+     * @maxLength 20
+     */
+    appSlug: string | null;
+    /**
+     * The id of template.
+     * @minLength 1
+     * @maxLength 20
+     */
+    templateId?: string | null;
+}
+interface ResolveTemplateSettingsResponse {
+    /** Retrieved settings. */
+    settings?: TemplateSettings;
+}
+interface GetTemplateControlsRequest {
+}
+interface GetTemplateControlsResponse {
+    templateControls?: TemplateControls;
+}
+interface TemplateControls {
+    /**
+     * The name of the template
+     * @maxLength 50
+     */
+    templateName?: string;
+    /**
+     * The controls groups configuration
+     * @minSize 1
+     * @maxSize 10
+     */
+    controlGroups?: ControlGroup[];
+}
+/** Represents control groups on the left side of the UI */
+interface ControlGroup {
+    /**
+     * @minLength 3
+     * @maxLength 50
+     */
+    groupId?: string;
+    /**
+     * @minLength 3
+     * @maxLength 50
+     */
+    icon?: string;
+    /**
+     * @minLength 3
+     * @maxLength 100
+     */
+    labelKey?: string;
+    /**
+     * @minLength 3
+     * @maxLength 100
+     */
+    titleKey?: string;
+    /**
+     * @minLength 3
+     * @maxLength 100
+     */
+    descriptionKey?: string;
+    /** @maxLength 100 */
+    linkKey?: string | null;
+    /** @maxLength 50 */
+    linkUrl?: string | null;
+    /** @maxLength 100 */
+    tooltipKey?: string | null;
+    /**
+     * Display controls
+     * @maxSize 20
+     */
+    display?: DisplayControl[];
+    /**
+     * Text controls
+     * @maxSize 20
+     */
+    texts?: TextControl[];
+    /**
+     * Image controls
+     * @maxSize 10
+     */
+    images?: ImageControl[];
+    /**
+     * Select controls
+     * @maxSize 20
+     */
+    selects?: SelectControl[];
+    /**
+     * Background controls
+     * @maxSize 20
+     */
+    backgrounds?: BackgroundControl[];
+}
+interface DisplayControl {
+    /**
+     * The id of the setting
+     * @maxLength 50
+     */
+    _id?: string;
+    /**
+     * Optional label key for translations
+     * @maxLength 100
+     */
+    labelKey?: string | null;
+    /** Default setting for this control */
+    default?: boolean;
+}
+interface TextControl {
+    /**
+     * The id of the setting
+     * @maxLength 50
+     */
+    _id?: string;
+    /**
+     * Optional label key for translations
+     * @maxLength 100
+     */
+    labelKey?: string | null;
+    /** Default setting for this control */
+    default?: TextSetting;
+    /**
+     * Text properties
+     * @maxSize 5
+     */
+    textProperties?: TextPropertyControl[];
+    /** @maxSize 10 */
+    textContent?: TextContentControl[];
+}
+interface TextPropertyControl {
+    /**
+     * One of "fontFamily", "fontStyle", "fontSize", "textAlignment"
+     * @maxLength 15
+     */
+    type?: string;
+    /**
+     * Optional label key for translations
+     * @maxLength 100
+     */
+    labelKey?: string | null;
+    /**
+     * List of possible options. Used for "fontFamily", "fontStyle", "textAlignment"
+     * @maxSize 50
+     */
+    options?: ValueOption[];
+    /** Optional range of the value. Used for "fontSize" */
+    range?: Range;
+}
+interface ValueOption {
+    /**
+     * The label key for translations
+     * @maxLength 100
+     */
+    labelKey?: string;
+    /**
+     * The value
+     * @maxLength 20
+     */
+    value?: string;
+}
+interface Range {
+    /** Minimum value. */
+    min?: number | null;
+    /** Maximum value. */
+    max?: number | null;
+}
+interface TextContentControl {
+    /**
+     * @minLength 3
+     * @maxLength 50
+     */
+    _id?: string;
+    /**
+     * @minLength 3
+     * @maxLength 100
+     */
+    labelKey?: string | null;
+    /** @max 1000 */
+    maxLength?: number | null;
+}
+interface ImageControl {
+    /**
+     * The id of the setting
+     * @maxLength 50
+     */
+    _id?: string;
+    /**
+     * Optional label key for translations
+     * @maxLength 100
+     */
+    labelKey?: string | null;
+    /** Default setting for this control */
+    default?: ImageSetting;
+    /**
+     * Optional description key for translations
+     * @maxLength 100
+     */
+    descriptionKey?: string | null;
+    /** Enable logo builder support */
+    showLogoBuilder?: boolean;
+}
+interface SelectControl {
+    /**
+     * The id of the setting
+     * @maxLength 50
+     */
+    _id?: string;
+    /**
+     * Optional label key for translations
+     * @maxLength 100
+     */
+    labelKey?: string | null;
+    /** Default setting for this control */
+    default?: SelectSetting;
+    /**
+     * List of possible options
+     * @minSize 1
+     * @maxSize 20
+     */
+    options?: ValueOption[];
+    /** Allows to use primary colour setting from template designer */
+    showPrimaryColorPicker?: boolean;
+    /** Allows to use secondary colour setting from template designer */
+    showSecondaryColorPicker?: boolean;
+    /** Allows to use size setting from template designer. */
+    showSize?: boolean;
+    /** Optional range of the size value. */
+    sizeRange?: Range;
+}
+interface BackgroundControl {
+    /**
+     * The id of the setting
+     * @maxLength 50
+     */
+    _id?: string;
+    /**
+     * Optional label key for translations
+     * @maxLength 100
+     */
+    labelKey?: string | null;
+    /** Default setting for this control */
+    default?: BackgroundSetting;
+    /** Allows to use colour setting from template designer */
+    showColorPicker?: boolean;
+    /** Allows to use image setting from template designer */
+    showImagePicker?: boolean;
+    /** Enables background opacity control */
+    opacityEnabled?: boolean | null;
+    /** Enables background image opacity control */
+    imageOpacityEnabled?: boolean | null;
+    /**
+     * Default media manager folder with background images
+     * @maxLength 256
+     */
+    mediaRootFolder?: string | null;
+}
+interface GetTemplateRegistryRequest {
+}
+interface GetTemplateRegistryResponse {
+    templateRegistry?: TemplateRegistry;
+}
+interface TemplateRegistry {
+    /**
+     * Templates.
+     * @minSize 1
+     * @maxSize 1000
+     */
+    templates?: WixAppTemplate[];
+}
+/** Defines a template and it's styles. */
+interface WixAppTemplate {
+    /** Wix App Id */
+    wixAppId?: string;
+    /** App Slug */
+    appSlug?: string;
+    /**
+     * Template type.
+     * @minLength 1
+     * @maxLength 20
+     */
+    templateType?: string;
+    /**
+     * Templates
+     * @minSize 1
+     * @maxSize 1000
+     */
+    templates?: TemplateStyle[];
+    /**
+     * Short artifact name (key from template-statics-config.json.erb)
+     * @minLength 3
+     * @maxLength 64
+     * @format SYSTEM_SLUG
+     */
+    templateArtifactName?: string | null;
+    /**
+     * Local path
+     * @minLength 1
+     * @maxLength 200
+     * @readonly
+     */
+    localPath?: string | null;
+    /**
+     * Statics URL
+     * @minLength 1
+     * @maxLength 200
+     * @readonly
+     */
+    staticsUrl?: string | null;
+}
+/**
+ * Defines a template style.
+ *
+ * Path to TemplateControls json file:
+ * papyrus-templates-lib/
+ * src/
+ * templates/
+ * {app_slug}/
+ * {template_type}/
+ * {id}/
+ * controls.json
+ */
+interface TemplateStyle {
+    /**
+     * The id of the template.
+     * @minLength 1
+     * @maxLength 20
+     */
+    _id?: string;
+    /**
+     * Determines which template should be used if user did not choose it yet.
+     * Only single template per wix_app_id can be default.
+     */
+    default?: boolean;
+    /** Determines if template cannot be selected for a new entity. */
+    inactive?: boolean;
+    /** Paper size */
+    paperSize?: PaperSizeWithLiterals;
+    pageOverflow?: PageOverflowWithLiterals;
+}
+interface DomainEvent extends DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+    /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
+    _id?: string;
+    /**
+     * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
+     * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
+     */
+    entityFqdn?: string;
+    /**
+     * Event action name, placed at the top level to make it easier for users to dispatch messages.
+     * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
+     */
+    slug?: string;
+    /** ID of the entity associated with the event. */
+    entityId?: string;
+    /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
+    eventTime?: Date | null;
+    /**
+     * Whether the event was triggered as a result of a privacy regulation application
+     * (for example, GDPR).
+     */
+    triggeredByAnonymizeRequest?: boolean | null;
+    /** If present, indicates the action that triggered the event. */
+    originatedFrom?: string | null;
+    /**
+     * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
+     * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
+     */
+    entityEventSequence?: string | null;
+}
+/** @oneof */
+interface DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+}
+interface EntityCreatedEvent {
+    entity?: string;
+}
+interface RestoreInfo {
+    deletedDate?: Date | null;
+}
+interface EntityUpdatedEvent {
+    /**
+     * Since platformized APIs only expose PATCH and not PUT we can't assume that the fields sent from the client are the actual diff.
+     * This means that to generate a list of changed fields (as opposed to sent fields) one needs to traverse both objects.
+     * We don't want to impose this on all developers and so we leave this traversal to the notification recipients which need it.
+     */
+    currentEntity?: string;
+}
+interface EntityDeletedEvent {
+    /** Entity that was deleted. */
+    deletedEntity?: string | null;
+}
+interface ActionEvent {
+    body?: string;
+}
+interface MessageEnvelope {
+    /**
+     * App instance ID.
+     * @format GUID
+     */
+    instanceId?: string | null;
+    /**
+     * Event type.
+     * @maxLength 150
+     */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+    /** Stringify payload. */
+    data?: string;
+    /** Details related to the account */
+    accountInfo?: AccountInfo;
+}
+interface IdentificationData extends IdentificationDataIdOneOf {
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
+    anonymousVisitorId?: string;
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
+    wixUserId?: string;
+    /**
+     * ID of an app.
+     * @format GUID
+     */
+    appId?: string;
+    /** @readonly */
+    identityType?: WebhookIdentityTypeWithLiterals;
+}
+/** @oneof */
+interface IdentificationDataIdOneOf {
+    /**
+     * ID of a site visitor that has not logged in to the site.
+     * @format GUID
+     */
+    anonymousVisitorId?: string;
+    /**
+     * ID of a site visitor that has logged in to the site.
+     * @format GUID
+     */
+    memberId?: string;
+    /**
+     * ID of a Wix user (site owner, contributor, etc.).
+     * @format GUID
+     */
+    wixUserId?: string;
+    /**
+     * ID of an app.
+     * @format GUID
+     */
+    appId?: string;
+}
+declare enum WebhookIdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+/** @enumType */
+type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
+interface AccountInfo {
+    /**
+     * ID of the Wix account associated with the event.
+     * @format GUID
+     */
+    accountId?: string | null;
+    /**
+     * ID of the parent Wix account. Only included when accountId belongs to a child account.
+     * @format GUID
+     */
+    parentAccountId?: string | null;
+    /**
+     * ID of the Wix site associated with the event. Only included when the event is tied to a specific site.
+     * @format GUID
+     */
+    siteId?: string | null;
+}
+/** @docsIgnore */
+type UpsertTemplateSettingsApplicationErrors = {
+    code?: 'INVALID_TEMPLATE_SETTINGS';
+    description?: string;
+    data?: Record<string, any>;
+};
+/** @docsIgnore */
+type ResolveTemplateSettingsApplicationErrors = {
+    code?: 'TEMPLATE_NOT_FOUND';
+    description?: string;
+    data?: Record<string, any>;
+};
+interface BaseEventMetadata {
+    /**
+     * App instance ID.
+     * @format GUID
+     */
+    instanceId?: string | null;
+    /**
+     * Event type.
+     * @maxLength 150
+     */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+    /** Details related to the account */
+    accountInfo?: AccountInfo;
+}
+interface EventMetadata extends BaseEventMetadata {
+    /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
+    _id?: string;
+    /**
+     * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
+     * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
+     */
+    entityFqdn?: string;
+    /**
+     * Event action name, placed at the top level to make it easier for users to dispatch messages.
+     * For example: `created`/`updated`/`deleted`/`started`/`completed`/`email_opened`.
+     */
+    slug?: string;
+    /** ID of the entity associated with the event. */
+    entityId?: string;
+    /** Event timestamp in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601) format and UTC time. For example, `2020-04-26T13:57:50.699Z`. */
+    eventTime?: Date | null;
+    /**
+     * Whether the event was triggered as a result of a privacy regulation application
+     * (for example, GDPR).
+     */
+    triggeredByAnonymizeRequest?: boolean | null;
+    /** If present, indicates the action that triggered the event. */
+    originatedFrom?: string | null;
+    /**
+     * A sequence number that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
+     * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
+     */
+    entityEventSequence?: string | null;
+    accountInfo?: AccountInfoMetadata;
+}
+interface AccountInfoMetadata {
+    /** ID of the Wix account associated with the event */
+    accountId: string;
+    /** ID of the Wix site associated with the event. Only included when the event is tied to a specific site. */
+    siteId?: string;
+    /** ID of the parent Wix account. Only included when 'accountId' belongs to a child account. */
+    parentAccountId?: string;
+}
+interface TemplateSettingsCreatedEnvelope {
+    entity: TemplateSettings;
+    metadata: EventMetadata;
+}
+/** @webhook
+ * @eventType wix.papyrus.v1.template_settings_created
+ * @serviceIdentifier wix.papyrus.v1.TemplateSettingsService
+ * @slug created
+ * @documentationMaturity preview
+ */
+declare function onTemplateSettingsCreated(handler: (event: TemplateSettingsCreatedEnvelope) => void | Promise<void>): void;
+interface TemplateSettingsUpdatedEnvelope {
+    entity: TemplateSettings;
+    metadata: EventMetadata;
+}
+/** @webhook
+ * @eventType wix.papyrus.v1.template_settings_updated
+ * @serviceIdentifier wix.papyrus.v1.TemplateSettingsService
+ * @slug updated
+ * @documentationMaturity preview
+ */
+declare function onTemplateSettingsUpdated(handler: (event: TemplateSettingsUpdatedEnvelope) => void | Promise<void>): void;
+/**
+ * Upsert Template Settings.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField options.settings.appSlug
+ * @requiredField options.settings.externalId
+ * @requiredField options.settings.templateId
+ * @requiredField options.settings.templateType
+ * @permissionId PAPYRUS.MANAGE_TEMPLATE_SETTINGS
+ * @applicableIdentity APP
+ * @fqn wix.papyrus.v1.TemplateSettingsService.UpsertTemplateSettings
+ */
+declare function upsertTemplateSettings(options?: UpsertTemplateSettingsOptions): Promise<UpsertTemplateSettingsResponse & {
+    __applicationErrorsType?: UpsertTemplateSettingsApplicationErrors;
+}>;
+interface UpsertTemplateSettingsOptions {
+    /** Settings to be upserted. */
+    settings?: TemplateSettings;
+}
+/**
+ * Lists Template Settings.
+ * @public
+ * @documentationMaturity preview
+ * @permissionId PAPYRUS.READ_TEMPLATE_SETTINGS
+ * @applicableIdentity APP
+ * @fqn wix.papyrus.v1.TemplateSettingsService.QueryTemplateSettings
+ */
+declare function queryTemplateSettings(): SettingsQueryBuilder;
+interface QueryCursorResult {
+    cursors: Cursors;
+    hasNext: () => boolean;
+    hasPrev: () => boolean;
+    length: number;
+    pageSize: number;
+}
+interface SettingsQueryResult extends QueryCursorResult {
+    items: TemplateSettings[];
+    query: SettingsQueryBuilder;
+    next: () => Promise<SettingsQueryResult>;
+    prev: () => Promise<SettingsQueryResult>;
+}
+interface SettingsQueryBuilder {
+    /** @param limit - Number of items to return, which is also the `pageSize` of the results object.
+     * @documentationMaturity preview
+     */
+    limit: (limit: number) => SettingsQueryBuilder;
+    /** @param cursor - A pointer to specific record
+     * @documentationMaturity preview
+     */
+    skipTo: (cursor: string) => SettingsQueryBuilder;
+    /** @documentationMaturity preview */
+    find: () => Promise<SettingsQueryResult>;
+}
+/**
+ * @hidden
+ * @fqn wix.papyrus.v1.TemplateSettingsService.QueryTemplateSettings
+ * @requiredField query
+ */
+declare function typedQueryTemplateSettings(query: TemplateSettingsQuery): Promise<QueryTemplateSettingsResponse>;
+interface TemplateSettingsQuerySpec extends QuerySpec {
+    paging: 'cursor';
+    wql: [];
+}
+type CommonQueryWithEntityContext = Query<TemplateSettings, TemplateSettingsQuerySpec>;
+type TemplateSettingsQuery = {
+    /**
+    Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`.
+    */
+    cursorPaging?: {
+        /**
+      Maximum number of items to return in the results.
+      @max: 100
+      */
+        limit?: NonNullable<CommonQueryWithEntityContext['cursorPaging']>['limit'] | null;
+        /**
+      Pointer to the next or previous page in the list of results.
+    
+      Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
+      Not relevant for the first request.
+      @maxLength: 16000
+      */
+        cursor?: NonNullable<CommonQueryWithEntityContext['cursorPaging']>['cursor'] | null;
+    };
+    /**
+    Filter object.
+  
+    Learn more about [filtering](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#filters).
+    */
+    filter?: CommonQueryWithEntityContext['filter'] | null;
+    /**
+    Sort object.
+  
+    Learn more about [sorting](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language#sorting).
+    */
+    sort?: {
+        /**
+      Name of the field to sort by.
+      @maxLength: 512
+      */
+        fieldName?: NonNullable<CommonQueryWithEntityContext['sort']>[number]['fieldName'];
+        /**
+      Sort order.
+      */
+        order?: NonNullable<CommonQueryWithEntityContext['sort']>[number]['order'];
+    }[];
+};
+declare const utils: {
+    query: {
+        QueryBuilder: () => _wix_sdk_types.QueryBuilder<TemplateSettings, TemplateSettingsQuerySpec, TemplateSettingsQuery>;
+        Filter: _wix_sdk_types.FilterFactory<TemplateSettings, TemplateSettingsQuerySpec>;
+        Sort: _wix_sdk_types.SortFactory<TemplateSettingsQuerySpec>;
+    };
+};
+/**
+ * Resolve Template Settings. Returns default Template Settings if it does not exist.
+ * @public
+ * @documentationMaturity preview
+ * @requiredField options.appSlug
+ * @requiredField options.templateType
+ * @permissionId PAPYRUS.READ_TEMPLATE_SETTINGS
+ * @applicableIdentity APP
+ * @fqn wix.papyrus.v1.TemplateSettingsService.ResolveTemplateSettings
+ */
+declare function resolveTemplateSettings(options?: ResolveTemplateSettingsOptions): Promise<ResolveTemplateSettingsResponse & {
+    __applicationErrorsType?: ResolveTemplateSettingsApplicationErrors;
+}>;
+interface ResolveTemplateSettingsOptions {
+    /**
+     * The id of the settings.
+     * @format GUID
+     */
+    templateSettingsId?: string | null;
+    /**
+     * External ID.
+     * @maxLength 100
+     */
+    templateSettingsExternalId?: string | null;
+    /**
+     * The type of the template. Used to resolve default settings.
+     * @minLength 1
+     * @maxLength 20
+     */
+    templateType: string | null;
+    /**
+     * Wix app slug.
+     * @minLength 1
+     * @maxLength 20
+     */
+    appSlug: string | null;
+    /**
+     * The id of template.
+     * @minLength 1
+     * @maxLength 20
+     */
+    templateId?: string | null;
+}
+
+export { type AccountInfo, type AccountInfoMetadata, type ActionEvent, type BackgroundControl, type BackgroundSetting, type BaseEventMetadata, type BulkCreateTemplateSettingsRequest, type BulkCreateTemplateSettingsResponse, type CommonQueryWithEntityContext, type ControlGroup, type CreateTemplateSettingsRequest, type CreateTemplateSettingsResponse, type CursorPaging, type Cursors, type DeleteTemplateSettingsRequest, type DeleteTemplateSettingsResponse, type DisplayControl, type DomainEvent, type DomainEventBodyOneOf, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, type FocalPoint, type GetTemplateControlsRequest, type GetTemplateControlsResponse, type GetTemplateRegistryRequest, type GetTemplateRegistryResponse, type GetTemplateSettingsRequest, type GetTemplateSettingsResponse, type IdentificationData, type IdentificationDataIdOneOf, type ImageControl, type ImageSetting, type MessageEnvelope, PageOverflow, type PageOverflowWithLiterals, type Paging, type PagingMetadataV2, PaperSize, type PaperSizeWithLiterals, type QueryTemplateSettingsRequest, type QueryTemplateSettingsResponse, type QueryV2, type QueryV2PagingMethodOneOf, type Range, ResizeOption, type ResizeOptionWithLiterals, type ResolveTemplateSettingsApplicationErrors, type ResolveTemplateSettingsOptions, type ResolveTemplateSettingsRequest, type ResolveTemplateSettingsResponse, type RestoreInfo, type SelectControl, type SelectSetting, type SettingsGroup, type SettingsQueryBuilder, type SettingsQueryResult, SortOrder, type SortOrderWithLiterals, type Sorting, type TemplateControls, type TemplateRegistry, type TemplateSettings, type TemplateSettingsCreatedEnvelope, type TemplateSettingsQuery, type TemplateSettingsQuerySpec, type TemplateSettingsUpdatedEnvelope, type TemplateStyle, type TextContent, type TextContentControl, type TextControl, type TextPropertyControl, type TextSetting, type UpdateTemplateSettingsRequest, type UpdateTemplateSettingsResponse, type UpsertTemplateSettingsApplicationErrors, type UpsertTemplateSettingsOptions, type UpsertTemplateSettingsRequest, type UpsertTemplateSettingsResponse, type ValueOption, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, type WixAppTemplate, onTemplateSettingsCreated, onTemplateSettingsUpdated, queryTemplateSettings, resolveTemplateSettings, typedQueryTemplateSettings, upsertTemplateSettings, utils };