import { SetComponentSettingsRequest as SetComponentSettingsRequest$1, SetComponentSettingsResponse as SetComponentSettingsResponse$1, GetComponentSettingsRequest as GetComponentSettingsRequest$1, GetComponentSettingsResponse as GetComponentSettingsResponse$1, SetGlobalSettingsRequest as SetGlobalSettingsRequest$1, SetGlobalSettingsResponse as SetGlobalSettingsResponse$1, GetGlobalSettingsRequest as GetGlobalSettingsRequest$1, GetGlobalSettingsResponse as GetGlobalSettingsResponse$1 } from './index.typings.js'; import '@wix/sdk-types'; interface AppSettings { /** The state of the component */ state?: StateWithLiterals; /** Where this data is relevant */ host?: HostWithLiterals; /** The app global settings */ settings?: Record | null; /** Translatable textual assets - not using a collection because this type only the get flow (which should return a single value) */ translations?: Record; } /** The state of the settings (Saved or Published) */ declare enum State { /** Not relevant */ NR = "NR", SAVED = "SAVED", PUBLISHED = "PUBLISHED" } /** @enumType */ type StateWithLiterals = State | 'NR' | 'SAVED' | 'PUBLISHED'; /** The host in which the settings are displayed */ declare enum Host { NA = "NA", VIEWER = "VIEWER", BUSINESS_MANAGER = "BUSINESS_MANAGER", ONE_APP = "ONE_APP" } /** @enumType */ type HostWithLiterals = Host | 'NA' | 'VIEWER' | 'BUSINESS_MANAGER' | 'ONE_APP'; interface SetComponentSettingsRequest { /** * The component Id * @maxLength 36 */ componentId: string | null; /** The data we'd like to store for this component */ settings?: Record | null; /** The state to set in. ** THIS IS A DEPRECATED FIELD, PLEASE USE THE "states" FIELD ** */ state?: StateWithLiterals; /** Where this data is relevant */ host?: HostWithLiterals; /** Translatable textual assets (pass empty key as default) */ translations?: TranslatedLanguage[]; /** The states to set in */ states?: StateWithLiterals[]; } /** The translated language that contains the key and its translations */ interface TranslatedLanguage { /** The key of the translations' language */ languageKey?: LanguageKey; /** Key-value pair mapping of textual assets */ translations?: Record; } /** The language key of the saved multilingual data */ interface LanguageKey { /** e.g. en */ languageCode?: string; /** e.g. us */ regionCode?: string; /** default: '' */ scriptVariant?: string; } interface SetComponentSettingsResponse { /** Echo of the component settings */ settings?: Record | null; /** Where this data is relevant */ host?: HostWithLiterals; /** Translatable textual assets (pass empty key as default) */ translations?: TranslatedLanguage[]; /** The states this was set in */ states?: StateWithLiterals[]; } interface SetComponentSettingsForMigrationRequest { /** * The component Id * @maxLength 36 */ componentId?: string | null; /** The data we'd like to store for this component */ settings?: Record | null; /** The state to set in. ** THIS IS A DEPRECATED FIELD, PLEASE USE THE "states" FIELD ** */ state?: StateWithLiterals; /** Where this data is relevant */ host?: HostWithLiterals; /** Translatable textual assets (pass empty key as default) */ translations?: TranslatedLanguage[]; /** The states to set in */ states?: StateWithLiterals[]; /** * The appDefId for migration * @format GUID */ appDefId?: string; /** * The instanceId for migration (msid) * @format GUID */ instanceId?: string; } interface SetComponentSettingsForMigrationResponse { /** Echo of the component settings */ settings?: Record | null; /** Where this data is relevant */ host?: HostWithLiterals; /** Translatable textual assets (pass empty key as default) */ translations?: TranslatedLanguage[]; /** The states this was set in */ states?: StateWithLiterals[]; } interface GetComponentSettingsRequest { /** * The component we want data for. Component ids can be from the site or oneApp * @minLength 1 * @maxLength 36 */ componentId: string | null; /** The state of the component */ state?: StateWithLiterals; /** Where this data is relevant */ host?: HostWithLiterals; /** The language key of the translation (allow filtering translations explicitly) */ languageKey?: LanguageKey; /** Whether it is critical to get Global Settings as well */ includeGlobalSettings?: boolean; } interface GetComponentSettingsResponse { /** Component settings for the requested component id */ settings?: Record | null; /** The data state of the response */ state?: StateWithLiterals; /** Where this data is relevant */ host?: HostWithLiterals; /** based on x-wix-language or fallback */ translations?: Record; /** Optional. The global app settings */ globalSettings?: AppSettings; } interface BulkGetComponentSettingsRequest { /** * The component we want data for. Component ids can be from the site or oneApp * @minLength 1 * @maxLength 36 * @minSize 1 * @maxSize 100 */ componentIds?: string[]; /** The state of the component */ state?: StateWithLiterals; /** Where this data is relevant */ host?: HostWithLiterals; /** The language key of the translation (allow filtering translations explicitly) */ languageKey?: LanguageKey; } interface BulkGetComponentSettingsResponse { componentSettings?: ComponentSettings[]; } interface ComponentSettings { /** * @minLength 1 * @maxLength 36 */ componentId?: string; /** Component settings for the requested component id */ settings?: Record | null; /** The data state of the response */ state?: StateWithLiterals; /** Where this data is relevant */ host?: HostWithLiterals; /** based on x-wix-language or fallback */ translations?: Record; } interface SetGlobalSettingsRequest { /** The global settings for the app */ settings?: Record | null; /** Any components we would like to set */ componentSettings?: SetComponentSettingsItem[]; /** The state this is set in. ** THIS IS A DEPRECATED FIELD, PLEASE USE THE "states" FIELD ** */ state?: StateWithLiterals; /** Where this data is relevant */ host?: HostWithLiterals; /** Translatable textual assets (pass empty key as default) */ translations?: TranslatedLanguage[]; /** The states this was set in */ states?: StateWithLiterals[]; } interface SetComponentSettingsItem { /** The state of the component */ state?: StateWithLiterals; /** Where this data is relevant */ host?: HostWithLiterals; /** * The component we want data for. Component ids can be from the site or oneApp * @minLength 1 * @maxLength 36 */ componentId?: string | null; /** The component settings */ settings?: Record | null; /** Translatable textual assets (pass empty key as default) */ translations?: TranslatedLanguage[]; } interface SetGlobalSettingsResponse { /** The data we have not for the App */ settings?: Record | null; /** The data we have for the components */ componentSettings?: SetComponentSettingsItem[]; /** Where this data is relevant */ host?: HostWithLiterals; /** Translatable textual assets (pass empty key as default) */ translations?: TranslatedLanguage[]; /** The states this was set in */ states?: StateWithLiterals[]; } interface GetGlobalSettingsRequest { /** The requested state, default is published */ state?: StateWithLiterals; /** Allow to filter by host to get only components for that host */ host?: HostWithLiterals; /** If component settings data should also be returned */ includeComponentSettings?: boolean; /** The language key of the translation (allow filtering translations explicitly) */ languageKey?: LanguageKey; } interface GetGlobalSettingsResponse { /** The state of the app */ state?: StateWithLiterals; /** Where this data is relevant */ host?: HostWithLiterals; /** The global app settings */ settings?: Record | null; /** Optional. All components listed. may include components from the site or oneApp */ componentSettings?: GetComponentSettingsItem[]; /** based on x-wix-language or fallback */ translations?: Record; } interface GetComponentSettingsItem { /** The state of the component */ state?: StateWithLiterals; /** Where this data is relevant */ host?: HostWithLiterals; /** * The component we want data for. Component ids can be from the site or oneApp * @minLength 1 * @maxLength 36 */ componentId?: string | null; /** The component settings */ settings?: Record | null; /** Translatable textual assets - not using a collection because this type only the get flow (which should return a single value) */ translations?: Record; } interface SetGlobalSettingsForMigrationRequest { /** The global settings for the app */ settings?: Record | null; /** Any components we would like to set */ componentSettings?: SetComponentSettingsItem[]; /** The state this is set in. ** THIS IS A DEPRECATED FIELD, PLEASE USE THE "states" FIELD ** */ state?: StateWithLiterals; /** Where this data is relevant */ host?: HostWithLiterals; /** Translatable textual assets (pass empty key as default) */ translations?: TranslatedLanguage[]; /** The states this was set in */ states?: StateWithLiterals[]; /** * The appDefId for migration * @format GUID */ appDefId?: string; /** * The instanceId for migration (msid) * @format GUID */ instanceId?: string; } interface SetGlobalSettingsForMigrationResponse { /** The data we have not for the App */ settings?: Record | null; /** The data we have for the components */ componentSettings?: SetComponentSettingsItem[]; /** Where this data is relevant */ host?: HostWithLiterals; /** Translatable textual assets (pass empty key as default) */ translations?: TranslatedLanguage[]; /** The states this was set in */ states?: StateWithLiterals[]; } interface GetGlobalSettingsForMigrationRequest { /** The requested state, default is published */ state?: StateWithLiterals; /** Allow to filter by host to get only components for that host */ host?: HostWithLiterals; /** If component settings data should also be returned */ includeComponentSettings?: boolean; /** The language key of the translation (allow filtering translations explicitly) */ languageKey?: LanguageKey; /** * The appDefId for migration * @format GUID */ appDefId?: string; /** * The instanceId for migration (msid) * @format GUID */ instanceId?: string; } interface GetGlobalSettingsForMigrationResponse { /** The state of the app */ state?: StateWithLiterals; /** Where this data is relevant */ host?: HostWithLiterals; /** The global app settings */ settings?: Record | null; /** Optional. All components listed. may include components from the site or oneApp */ componentSettings?: GetComponentSettingsItem[]; /** Translatable textual assets (returns unfiltered global translations when languageKey is omitted) */ translations?: TranslatedLanguage[]; } interface GetRequest { /** * id of app-scoped settings * @format GUID */ externalAppId?: string | null; /** * id of component-scoped settings * @format GUID */ externalComponentId?: string | null; /** desired fields to retrieve on either GetResponse.app_settings or GetResponse.component_settings */ fields?: string[]; } interface GetResponse { /** app-scoped settings; */ appSettings?: Record | null; /** component-scoped settings; */ componentSettings?: Record | null; } interface SetRequest { /** * id of settings snapshot * @format GUID */ externalId?: string | null; /** scope of settings to store */ scope?: ScopeWithLiterals; /** settings themselves; */ data?: Record | null; } /** scope of settings when creating/updating; */ declare enum Scope { /** multiple instances of a tpa can share same settings; */ APP = "APP", /** scoped to a single component of an app; */ COMPONENT = "COMPONENT" } /** @enumType */ type ScopeWithLiterals = Scope | 'APP' | 'COMPONENT'; interface SetResponse { } interface UpdateRequest { /** * id of settings snapshot * @format GUID */ externalId?: string | null; /** scope of settings to update */ scope?: ScopeWithLiterals; /** changed fields in provided data */ fields?: string[]; /** data itself */ data?: Record | null; } interface UpdateResponse { /** new if of stored settings snapshot */ newExternalId?: string | null; } type __PublicMethodMetaInfo = { getUrl: (context: any) => string; httpMethod: K; path: string; pathParams: M; __requestType: T; __originalRequestType: S; __responseType: Q; __originalResponseType: R; }; declare function setComponentSettings(): __PublicMethodMetaInfo<'PATCH', { componentId: string; }, SetComponentSettingsRequest$1, SetComponentSettingsRequest, SetComponentSettingsResponse$1, SetComponentSettingsResponse>; declare function getComponentSettings(): __PublicMethodMetaInfo<'GET', { componentId: string; }, GetComponentSettingsRequest$1, GetComponentSettingsRequest, GetComponentSettingsResponse$1, GetComponentSettingsResponse>; declare function setGlobalSettings(): __PublicMethodMetaInfo<'PATCH', {}, SetGlobalSettingsRequest$1, SetGlobalSettingsRequest, SetGlobalSettingsResponse$1, SetGlobalSettingsResponse>; declare function getGlobalSettings(): __PublicMethodMetaInfo<'GET', {}, GetGlobalSettingsRequest$1, GetGlobalSettingsRequest, GetGlobalSettingsResponse$1, GetGlobalSettingsResponse>; export { type AppSettings as AppSettingsOriginal, type BulkGetComponentSettingsRequest as BulkGetComponentSettingsRequestOriginal, type BulkGetComponentSettingsResponse as BulkGetComponentSettingsResponseOriginal, type ComponentSettings as ComponentSettingsOriginal, type GetComponentSettingsItem as GetComponentSettingsItemOriginal, type GetComponentSettingsRequest as GetComponentSettingsRequestOriginal, type GetComponentSettingsResponse as GetComponentSettingsResponseOriginal, type GetGlobalSettingsForMigrationRequest as GetGlobalSettingsForMigrationRequestOriginal, type GetGlobalSettingsForMigrationResponse as GetGlobalSettingsForMigrationResponseOriginal, type GetGlobalSettingsRequest as GetGlobalSettingsRequestOriginal, type GetGlobalSettingsResponse as GetGlobalSettingsResponseOriginal, type GetRequest as GetRequestOriginal, type GetResponse as GetResponseOriginal, Host as HostOriginal, type HostWithLiterals as HostWithLiteralsOriginal, type LanguageKey as LanguageKeyOriginal, Scope as ScopeOriginal, type ScopeWithLiterals as ScopeWithLiteralsOriginal, type SetComponentSettingsForMigrationRequest as SetComponentSettingsForMigrationRequestOriginal, type SetComponentSettingsForMigrationResponse as SetComponentSettingsForMigrationResponseOriginal, type SetComponentSettingsItem as SetComponentSettingsItemOriginal, type SetComponentSettingsRequest as SetComponentSettingsRequestOriginal, type SetComponentSettingsResponse as SetComponentSettingsResponseOriginal, type SetGlobalSettingsForMigrationRequest as SetGlobalSettingsForMigrationRequestOriginal, type SetGlobalSettingsForMigrationResponse as SetGlobalSettingsForMigrationResponseOriginal, type SetGlobalSettingsRequest as SetGlobalSettingsRequestOriginal, type SetGlobalSettingsResponse as SetGlobalSettingsResponseOriginal, type SetRequest as SetRequestOriginal, type SetResponse as SetResponseOriginal, State as StateOriginal, type StateWithLiterals as StateWithLiteralsOriginal, type TranslatedLanguage as TranslatedLanguageOriginal, type UpdateRequest as UpdateRequestOriginal, type UpdateResponse as UpdateResponseOriginal, type __PublicMethodMetaInfo, getComponentSettings, getGlobalSettings, setComponentSettings, setGlobalSettings };