interface TemplateSettings$1 { /** * Auto generated ID. * @readonly */ id?: string | null; /** Wix app definition ID. */ appSlug?: string | null; /** The type of the template. */ templateType?: string | null; /** The id of the template. */ 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) */ externalId?: string | null; /** * Date settings were created. * @readonly */ createdDate?: Date; /** * Date settings were updated. * @readonly */ updatedDate?: Date; settingGroups?: SettingsGroup$1[]; /** Paper size */ paperSize?: PaperSize$1; } interface TextSetting$1 { /** Font family class name */ fontFamily?: string | null; /** Font style class names */ fontStyle?: string[]; /** Text alignment class name */ textAlignment?: string | null; /** Text color hex code */ textColor?: string | null; /** Font size */ fontSize?: number | null; /** Text content setting */ textContent?: TextContent$1[]; } interface TextContent$1 { id?: string; value?: string | null; visible?: boolean; } interface ImageSetting$1 { /** Wix media Image */ image?: Image; /** Image resizing mode */ resize?: ResizeOption$1; } interface Image { /** WixMedia image ID. */ id?: string; /** Image URL. */ url?: string; /** * Original image height. * @readonly */ height?: number; /** * Original image width. * @readonly */ width?: number; /** Image alt text. */ altText?: string | null; /** * Image filename. * @readonly */ filename?: string | null; } declare enum ResizeOption$1 { /** Automatically resizes full image to fit image field */ FIT = "FIT", /** Enables user to manually crop image to fit image field */ CROP = "CROP" } interface SelectSetting$1 { /** Selected value */ value?: string | null; /** Color hex code */ primaryColor?: string | null; /** Color hex code */ secondaryColor?: string | null; /** Size */ size?: number | null; } interface BackgroundSetting$1 { /** Color of the background hex code */ color?: string | null; /** Wix media Image */ image?: Image; } interface SettingsGroup$1 { /** Id of the control group */ groupId?: string; /** Display settings. */ display?: Record; /** Texts settings. */ texts?: Record; /** Images settings. */ images?: Record; /** Select option settings. */ selects?: Record; /** Backgrounds settings. */ backgrounds?: Record; } declare enum PaperSize$1 { A4_PORTRAIT = "A4_PORTRAIT", A4_LANDSCAPE = "A4_LANDSCAPE" } interface UpsertTemplateSettingsRequest$1 { /** Settings to be upserted. */ settings?: TemplateSettings$1; } interface UpsertTemplateSettingsResponse$1 { /** Upserted settings. */ settings?: TemplateSettings$1; } interface QueryTemplateSettingsRequest$1 { /** Generic query object. */ query: QueryV2$1; } interface QueryV2$1 extends QueryV2PagingMethodOneOf$1 { /** Paging options to limit and skip the number of items. */ paging?: Paging$1; /** 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$1; /** * Filter object in the following format: * `"filter" : { * "fieldName1": "value1", * "fieldName2":{"$operator":"value2"} * }` * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains` */ filter?: Record | null; /** * Sort object in the following format: * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]` */ sort?: Sorting$1[]; /** 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$1 { /** Paging options to limit and skip the number of items. */ paging?: Paging$1; /** 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$1; } interface Sorting$1 { /** Name of the field to sort by. */ fieldName?: string; /** Sort order. */ order?: SortOrder$1; } declare enum SortOrder$1 { ASC = "ASC", DESC = "DESC" } interface Paging$1 { /** Number of items to load. */ limit?: number | null; /** Number of items to skip in the current sort order. */ offset?: number | null; } interface CursorPaging$1 { /** Maximum number of items to return in the results. */ 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. */ cursor?: string | null; } interface QueryTemplateSettingsResponse$1 { /** Template settings results. */ settings?: TemplateSettings$1[]; /** Query result's metadata. */ metadata?: PagingMetadataV2$1; } interface PagingMetadataV2$1 { /** 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$1; } interface Cursors$1 { /** Cursor string pointing to the next page in the list of results. */ next?: string | null; /** Cursor pointing to the previous page in the list of results. */ prev?: string | null; } interface ResolveTemplateSettingsRequest$1 { /** The id of the settings. */ templateSettingsId?: string | null; /** External ID. */ templateSettingsExternalId?: string | null; /** The type of the template. Used to resolve default settings. */ templateType: string | null; /** Wix app slug. */ appSlug: string | null; /** The id of template. */ templateId?: string | null; } interface ResolveTemplateSettingsResponse$1 { /** Retrieved settings. */ settings?: TemplateSettings$1; } interface SettingsGroupNonNullableFields$1 { groupId: string; } interface TemplateSettingsNonNullableFields$1 { settingGroups: SettingsGroupNonNullableFields$1[]; paperSize: PaperSize$1; } interface UpsertTemplateSettingsResponseNonNullableFields$1 { settings?: TemplateSettingsNonNullableFields$1; } interface QueryTemplateSettingsResponseNonNullableFields$1 { settings: TemplateSettingsNonNullableFields$1[]; } interface ResolveTemplateSettingsResponseNonNullableFields$1 { settings?: TemplateSettingsNonNullableFields$1; } interface TemplateSettings { /** * Auto generated ID. * @readonly */ _id?: string | null; /** Wix app definition ID. */ appSlug?: string | null; /** The type of the template. */ templateType?: string | null; /** The id of the template. */ 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) */ externalId?: string | null; /** * Date settings were created. * @readonly */ _createdDate?: Date; /** * Date settings were updated. * @readonly */ _updatedDate?: Date; settingGroups?: SettingsGroup[]; /** Paper size */ paperSize?: PaperSize; } interface TextSetting { /** Font family class name */ fontFamily?: string | null; /** Font style class names */ fontStyle?: string[]; /** Text alignment class name */ textAlignment?: string | null; /** Text color hex code */ textColor?: string | null; /** Font size */ fontSize?: number | null; /** Text content setting */ textContent?: TextContent[]; } interface TextContent { _id?: string; value?: string | null; visible?: boolean; } interface ImageSetting { /** Wix media Image */ image?: string; /** Image resizing mode */ resize?: ResizeOption; } 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" } interface SelectSetting { /** Selected value */ value?: string | null; /** Color hex code */ primaryColor?: string | null; /** Color hex code */ secondaryColor?: string | null; /** Size */ size?: number | null; } interface BackgroundSetting { /** Color of the background hex code */ color?: string | null; /** Wix media Image */ image?: string; } interface SettingsGroup { /** Id of the control group */ groupId?: string; /** Display settings. */ display?: Record; /** Texts settings. */ texts?: Record; /** Images settings. */ images?: Record; /** Select option settings. */ selects?: Record; /** Backgrounds settings. */ backgrounds?: Record; } declare enum PaperSize { A4_PORTRAIT = "A4_PORTRAIT", A4_LANDSCAPE = "A4_LANDSCAPE" } interface UpsertTemplateSettingsRequest { /** Settings to be upserted. */ settings?: TemplateSettings; } interface UpsertTemplateSettingsResponse { /** Upserted settings. */ settings?: TemplateSettings; } interface QueryTemplateSettingsRequest { /** Generic query object. */ query: QueryV2; } interface QueryV2 extends QueryV2PagingMethodOneOf { /** Paging options to limit and skip 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 in the following format: * `"filter" : { * "fieldName1": "value1", * "fieldName2":{"$operator":"value2"} * }` * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains` */ filter?: Record | null; /** * Sort object in the following format: * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]` */ 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 skip 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. */ fieldName?: string; /** Sort order. */ order?: SortOrder; } declare enum SortOrder { ASC = "ASC", DESC = "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. */ 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. */ 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. */ next?: string | null; /** Cursor pointing to the previous page in the list of results. */ prev?: string | null; } interface ResolveTemplateSettingsRequest { /** The id of the settings. */ templateSettingsId?: string | null; /** External ID. */ templateSettingsExternalId?: string | null; /** The type of the template. Used to resolve default settings. */ templateType: string | null; /** Wix app slug. */ appSlug: string | null; /** The id of template. */ templateId?: string | null; } interface ResolveTemplateSettingsResponse { /** Retrieved settings. */ settings?: TemplateSettings; } interface SettingsGroupNonNullableFields { groupId: string; } interface TemplateSettingsNonNullableFields { settingGroups: SettingsGroupNonNullableFields[]; paperSize: PaperSize; } interface UpsertTemplateSettingsResponseNonNullableFields { settings?: TemplateSettingsNonNullableFields; } interface QueryTemplateSettingsResponseNonNullableFields { settings: TemplateSettingsNonNullableFields[]; } interface ResolveTemplateSettingsResponseNonNullableFields { settings?: TemplateSettingsNonNullableFields; } type __PublicMethodMetaInfo = { getUrl: (context: any) => string; httpMethod: K; path: string; pathParams: M; __requestType: T; __originalRequestType: S; __responseType: Q; __originalResponseType: R; }; declare function upsertTemplateSettings(): __PublicMethodMetaInfo<'POST', {}, UpsertTemplateSettingsRequest, UpsertTemplateSettingsRequest$1, UpsertTemplateSettingsResponse & UpsertTemplateSettingsResponseNonNullableFields, UpsertTemplateSettingsResponse$1 & UpsertTemplateSettingsResponseNonNullableFields$1>; declare function queryTemplateSettings(): __PublicMethodMetaInfo<'POST', {}, QueryTemplateSettingsRequest, QueryTemplateSettingsRequest$1, QueryTemplateSettingsResponse & QueryTemplateSettingsResponseNonNullableFields, QueryTemplateSettingsResponse$1 & QueryTemplateSettingsResponseNonNullableFields$1>; declare function resolveTemplateSettings(): __PublicMethodMetaInfo<'GET', {}, ResolveTemplateSettingsRequest, ResolveTemplateSettingsRequest$1, ResolveTemplateSettingsResponse & ResolveTemplateSettingsResponseNonNullableFields, ResolveTemplateSettingsResponse$1 & ResolveTemplateSettingsResponseNonNullableFields$1>; export { type __PublicMethodMetaInfo, queryTemplateSettings, resolveTemplateSettings, upsertTemplateSettings };