@wix/data-extension-schema 1.0.0

package/type-bundles/context.bundle.d.ts

@@ -0,0 +1,1075 @@
+type HostModule<T, H extends Host> = {
+    __type: 'host';
+    create(host: H): T;
+};
+type HostModuleAPI<T extends HostModule<any, any>> = T extends HostModule<infer U, any> ? U : never;
+type Host<Environment = unknown> = {
+    channel: {
+        observeState(callback: (props: unknown, environment: Environment) => unknown): {
+            disconnect: () => void;
+        } | Promise<{
+            disconnect: () => void;
+        }>;
+    };
+    environment?: Environment;
+    /**
+     * Optional name of the environment, use for logging
+     */
+    name?: string;
+    /**
+     * Optional bast url to use for API requests, for example `www.wixapis.com`
+     */
+    apiBaseUrl?: string;
+    /**
+     * Possible data to be provided by every host, for cross cutting concerns
+     * like internationalization, billing, etc.
+     */
+    essentials?: {
+        /**
+         * The language of the currently viewed session
+         */
+        language?: string;
+        /**
+         * The locale of the currently viewed session
+         */
+        locale?: string;
+        /**
+         * Any headers that should be passed through to the API requests
+         */
+        passThroughHeaders?: Record<string, string>;
+    };
+};
+
+type RESTFunctionDescriptor<T extends (...args: any[]) => any = (...args: any[]) => any> = (httpClient: HttpClient) => T;
+interface HttpClient {
+    request<TResponse, TData = any>(req: RequestOptionsFactory<TResponse, TData>): Promise<HttpResponse<TResponse>>;
+    fetchWithAuth: typeof fetch;
+    wixAPIFetch: (relativeUrl: string, options: RequestInit) => Promise<Response>;
+    getActiveToken?: () => string | undefined;
+}
+type RequestOptionsFactory<TResponse = any, TData = any> = (context: any) => RequestOptions<TResponse, TData>;
+type HttpResponse<T = any> = {
+    data: T;
+    status: number;
+    statusText: string;
+    headers: any;
+    request?: any;
+};
+type RequestOptions<_TResponse = any, Data = any> = {
+    method: 'POST' | 'GET' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
+    url: string;
+    data?: Data;
+    params?: URLSearchParams;
+} & APIMetadata;
+type APIMetadata = {
+    methodFqn?: string;
+    entityFqdn?: string;
+    packageName?: string;
+};
+type BuildRESTFunction<T extends RESTFunctionDescriptor> = T extends RESTFunctionDescriptor<infer U> ? U : never;
+type EventDefinition<Payload = unknown, Type extends string = string> = {
+    __type: 'event-definition';
+    type: Type;
+    isDomainEvent?: boolean;
+    transformations?: (envelope: unknown) => Payload;
+    __payload: Payload;
+};
+declare function EventDefinition<Type extends string>(type: Type, isDomainEvent?: boolean, transformations?: (envelope: any) => unknown): <Payload = unknown>() => EventDefinition<Payload, Type>;
+type EventHandler<T extends EventDefinition> = (payload: T['__payload']) => void | Promise<void>;
+type BuildEventDefinition<T extends EventDefinition<any, string>> = (handler: EventHandler<T>) => void;
+
+type ServicePluginMethodInput = {
+    request: any;
+    metadata: any;
+};
+type ServicePluginContract = Record<string, (payload: ServicePluginMethodInput) => unknown | Promise<unknown>>;
+type ServicePluginMethodMetadata = {
+    name: string;
+    primaryHttpMappingPath: string;
+    transformations: {
+        fromREST: (...args: unknown[]) => ServicePluginMethodInput;
+        toREST: (...args: unknown[]) => unknown;
+    };
+};
+type ServicePluginDefinition<Contract extends ServicePluginContract> = {
+    __type: 'service-plugin-definition';
+    componentType: string;
+    methods: ServicePluginMethodMetadata[];
+    __contract: Contract;
+};
+declare function ServicePluginDefinition<Contract extends ServicePluginContract>(componentType: string, methods: ServicePluginMethodMetadata[]): ServicePluginDefinition<Contract>;
+type BuildServicePluginDefinition<T extends ServicePluginDefinition<any>> = (implementation: T['__contract']) => void;
+declare const SERVICE_PLUGIN_ERROR_TYPE = "wix_spi_error";
+
+type RequestContext = {
+    isSSR: boolean;
+    host: string;
+    protocol?: string;
+};
+type ResponseTransformer = (data: any, headers?: any) => any;
+/**
+ * Ambassador request options types are copied mostly from AxiosRequestConfig.
+ * They are copied and not imported to reduce the amount of dependencies (to reduce install time).
+ * https://github.com/axios/axios/blob/3f53eb6960f05a1f88409c4b731a40de595cb825/index.d.ts#L307-L315
+ */
+type Method = 'get' | 'GET' | 'delete' | 'DELETE' | 'head' | 'HEAD' | 'options' | 'OPTIONS' | 'post' | 'POST' | 'put' | 'PUT' | 'patch' | 'PATCH' | 'purge' | 'PURGE' | 'link' | 'LINK' | 'unlink' | 'UNLINK';
+type AmbassadorRequestOptions<T = any> = {
+    _?: T;
+    url?: string;
+    method?: Method;
+    params?: any;
+    data?: any;
+    transformResponse?: ResponseTransformer | ResponseTransformer[];
+};
+type AmbassadorFactory<Request, Response> = (payload: Request) => ((context: RequestContext) => AmbassadorRequestOptions<Response>) & {
+    __isAmbassador: boolean;
+};
+type AmbassadorFunctionDescriptor<Request = any, Response = any> = AmbassadorFactory<Request, Response>;
+type BuildAmbassadorFunction<T extends AmbassadorFunctionDescriptor> = T extends AmbassadorFunctionDescriptor<infer Request, infer Response> ? (req: Request) => Promise<Response> : never;
+
+declare global {
+	// eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
+	interface SymbolConstructor {
+		readonly observable: symbol;
+	}
+}
+
+declare const emptyObjectSymbol: unique symbol;
+
+/**
+Represents a strictly empty plain object, the `{}` value.
+
+When you annotate something as the type `{}`, it can be anything except `null` and `undefined`. This means that you cannot use `{}` to represent an empty plain object ([read more](https://stackoverflow.com/questions/47339869/typescript-empty-object-and-any-difference/52193484#52193484)).
+
+@example
+```
+import type {EmptyObject} from 'type-fest';
+
+// The following illustrates the problem with `{}`.
+const foo1: {} = {}; // Pass
+const foo2: {} = []; // Pass
+const foo3: {} = 42; // Pass
+const foo4: {} = {a: 1}; // Pass
+
+// With `EmptyObject` only the first case is valid.
+const bar1: EmptyObject = {}; // Pass
+const bar2: EmptyObject = 42; // Fail
+const bar3: EmptyObject = []; // Fail
+const bar4: EmptyObject = {a: 1}; // Fail
+```
+
+Unfortunately, `Record<string, never>`, `Record<keyof any, never>` and `Record<never, never>` do not work. See {@link https://github.com/sindresorhus/type-fest/issues/395 #395}.
+
+@category Object
+*/
+type EmptyObject = {[emptyObjectSymbol]?: never};
+
+/**
+Returns a boolean for whether the two given types are equal.
+
+@link https://github.com/microsoft/TypeScript/issues/27024#issuecomment-421529650
+@link https://stackoverflow.com/questions/68961864/how-does-the-equals-work-in-typescript/68963796#68963796
+
+Use-cases:
+- If you want to make a conditional branch based on the result of a comparison of two types.
+
+@example
+```
+import type {IsEqual} from 'type-fest';
+
+// This type returns a boolean for whether the given array includes the given item.
+// `IsEqual` is used to compare the given array at position 0 and the given item and then return true if they are equal.
+type Includes<Value extends readonly any[], Item> =
+	Value extends readonly [Value[0], ...infer rest]
+		? IsEqual<Value[0], Item> extends true
+			? true
+			: Includes<rest, Item>
+		: false;
+```
+
+@category Type Guard
+@category Utilities
+*/
+type IsEqual<A, B> =
+	(<G>() => G extends A ? 1 : 2) extends
+	(<G>() => G extends B ? 1 : 2)
+		? true
+		: false;
+
+/**
+Filter out keys from an object.
+
+Returns `never` if `Exclude` is strictly equal to `Key`.
+Returns `never` if `Key` extends `Exclude`.
+Returns `Key` otherwise.
+
+@example
+```
+type Filtered = Filter<'foo', 'foo'>;
+//=> never
+```
+
+@example
+```
+type Filtered = Filter<'bar', string>;
+//=> never
+```
+
+@example
+```
+type Filtered = Filter<'bar', 'foo'>;
+//=> 'bar'
+```
+
+@see {Except}
+*/
+type Filter<KeyType, ExcludeType> = IsEqual<KeyType, ExcludeType> extends true ? never : (KeyType extends ExcludeType ? never : KeyType);
+
+type ExceptOptions = {
+	/**
+	Disallow assigning non-specified properties.
+
+	Note that any omitted properties in the resulting type will be present in autocomplete as `undefined`.
+
+	@default false
+	*/
+	requireExactProps?: boolean;
+};
+
+/**
+Create a type from an object type without certain keys.
+
+We recommend setting the `requireExactProps` option to `true`.
+
+This type is a stricter version of [`Omit`](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-3-5.html#the-omit-helper-type). The `Omit` type does not restrict the omitted keys to be keys present on the given type, while `Except` does. The benefits of a stricter type are avoiding typos and allowing the compiler to pick up on rename refactors automatically.
+
+This type was proposed to the TypeScript team, which declined it, saying they prefer that libraries implement stricter versions of the built-in types ([microsoft/TypeScript#30825](https://github.com/microsoft/TypeScript/issues/30825#issuecomment-523668235)).
+
+@example
+```
+import type {Except} from 'type-fest';
+
+type Foo = {
+	a: number;
+	b: string;
+};
+
+type FooWithoutA = Except<Foo, 'a'>;
+//=> {b: string}
+
+const fooWithoutA: FooWithoutA = {a: 1, b: '2'};
+//=> errors: 'a' does not exist in type '{ b: string; }'
+
+type FooWithoutB = Except<Foo, 'b', {requireExactProps: true}>;
+//=> {a: number} & Partial<Record<"b", never>>
+
+const fooWithoutB: FooWithoutB = {a: 1, b: '2'};
+//=> errors at 'b': Type 'string' is not assignable to type 'undefined'.
+```
+
+@category Object
+*/
+type Except<ObjectType, KeysType extends keyof ObjectType, Options extends ExceptOptions = {requireExactProps: false}> = {
+	[KeyType in keyof ObjectType as Filter<KeyType, KeysType>]: ObjectType[KeyType];
+} & (Options['requireExactProps'] extends true
+	? Partial<Record<KeysType, never>>
+	: {});
+
+/**
+Returns a boolean for whether the given type is `never`.
+
+@link https://github.com/microsoft/TypeScript/issues/31751#issuecomment-498526919
+@link https://stackoverflow.com/a/53984913/10292952
+@link https://www.zhenghao.io/posts/ts-never
+
+Useful in type utilities, such as checking if something does not occur.
+
+@example
+```
+import type {IsNever, And} from 'type-fest';
+
+// https://github.com/andnp/SimplyTyped/blob/master/src/types/strings.ts
+type AreStringsEqual<A extends string, B extends string> =
+	And<
+		IsNever<Exclude<A, B>> extends true ? true : false,
+		IsNever<Exclude<B, A>> extends true ? true : false
+	>;
+
+type EndIfEqual<I extends string, O extends string> =
+	AreStringsEqual<I, O> extends true
+		? never
+		: void;
+
+function endIfEqual<I extends string, O extends string>(input: I, output: O): EndIfEqual<I, O> {
+	if (input === output) {
+		process.exit(0);
+	}
+}
+
+endIfEqual('abc', 'abc');
+//=> never
+
+endIfEqual('abc', '123');
+//=> void
+```
+
+@category Type Guard
+@category Utilities
+*/
+type IsNever<T> = [T] extends [never] ? true : false;
+
+/**
+An if-else-like type that resolves depending on whether the given type is `never`.
+
+@see {@link IsNever}
+
+@example
+```
+import type {IfNever} from 'type-fest';
+
+type ShouldBeTrue = IfNever<never>;
+//=> true
+
+type ShouldBeBar = IfNever<'not never', 'foo', 'bar'>;
+//=> 'bar'
+```
+
+@category Type Guard
+@category Utilities
+*/
+type IfNever<T, TypeIfNever = true, TypeIfNotNever = false> = (
+	IsNever<T> extends true ? TypeIfNever : TypeIfNotNever
+);
+
+/**
+Extract the keys from a type where the value type of the key extends the given `Condition`.
+
+Internally this is used for the `ConditionalPick` and `ConditionalExcept` types.
+
+@example
+```
+import type {ConditionalKeys} from 'type-fest';
+
+interface Example {
+	a: string;
+	b: string | number;
+	c?: string;
+	d: {};
+}
+
+type StringKeysOnly = ConditionalKeys<Example, string>;
+//=> 'a'
+```
+
+To support partial types, make sure your `Condition` is a union of undefined (for example, `string | undefined`) as demonstrated below.
+
+@example
+```
+import type {ConditionalKeys} from 'type-fest';
+
+type StringKeysAndUndefined = ConditionalKeys<Example, string | undefined>;
+//=> 'a' | 'c'
+```
+
+@category Object
+*/
+type ConditionalKeys<Base, Condition> =
+{
+	// Map through all the keys of the given base type.
+	[Key in keyof Base]-?:
+	// Pick only keys with types extending the given `Condition` type.
+	Base[Key] extends Condition
+	// Retain this key
+	// If the value for the key extends never, only include it if `Condition` also extends never
+		? IfNever<Base[Key], IfNever<Condition, Key, never>, Key>
+	// Discard this key since the condition fails.
+		: never;
+	// Convert the produced object into a union type of the keys which passed the conditional test.
+}[keyof Base];
+
+/**
+Exclude keys from a shape that matches the given `Condition`.
+
+This is useful when you want to create a new type with a specific set of keys from a shape. For example, you might want to exclude all the primitive properties from a class and form a new shape containing everything but the primitive properties.
+
+@example
+```
+import type {Primitive, ConditionalExcept} from 'type-fest';
+
+class Awesome {
+	name: string;
+	successes: number;
+	failures: bigint;
+
+	run() {}
+}
+
+type ExceptPrimitivesFromAwesome = ConditionalExcept<Awesome, Primitive>;
+//=> {run: () => void}
+```
+
+@example
+```
+import type {ConditionalExcept} from 'type-fest';
+
+interface Example {
+	a: string;
+	b: string | number;
+	c: () => void;
+	d: {};
+}
+
+type NonStringKeysOnly = ConditionalExcept<Example, string>;
+//=> {b: string | number; c: () => void; d: {}}
+```
+
+@category Object
+*/
+type ConditionalExcept<Base, Condition> = Except<
+Base,
+ConditionalKeys<Base, Condition>
+>;
+
+/**
+ * Descriptors are objects that describe the API of a module, and the module
+ * can either be a REST module or a host module.
+ * This type is recursive, so it can describe nested modules.
+ */
+type Descriptors = RESTFunctionDescriptor | AmbassadorFunctionDescriptor | HostModule<any, any> | EventDefinition<any> | ServicePluginDefinition<any> | {
+    [key: string]: Descriptors | PublicMetadata | any;
+};
+/**
+ * This type takes in a descriptors object of a certain Host (including an `unknown` host)
+ * and returns an object with the same structure, but with all descriptors replaced with their API.
+ * Any non-descriptor properties are removed from the returned object, including descriptors that
+ * do not match the given host (as they will not work with the given host).
+ */
+type BuildDescriptors<T extends Descriptors, H extends Host<any> | undefined, Depth extends number = 5> = {
+    done: T;
+    recurse: T extends {
+        __type: typeof SERVICE_PLUGIN_ERROR_TYPE;
+    } ? never : T extends AmbassadorFunctionDescriptor ? BuildAmbassadorFunction<T> : T extends RESTFunctionDescriptor ? BuildRESTFunction<T> : T extends EventDefinition<any> ? BuildEventDefinition<T> : T extends ServicePluginDefinition<any> ? BuildServicePluginDefinition<T> : T extends HostModule<any, any> ? HostModuleAPI<T> : ConditionalExcept<{
+        [Key in keyof T]: T[Key] extends Descriptors ? BuildDescriptors<T[Key], H, [
+            -1,
+            0,
+            1,
+            2,
+            3,
+            4,
+            5
+        ][Depth]> : never;
+    }, EmptyObject>;
+}[Depth extends -1 ? 'done' : 'recurse'];
+type PublicMetadata = {
+    PACKAGE_NAME?: string;
+};
+
+declare global {
+    interface ContextualClient {
+    }
+}
+/**
+ * A type used to create concerete types from SDK descriptors in
+ * case a contextual client is available.
+ */
+type MaybeContext<T extends Descriptors> = globalThis.ContextualClient extends {
+    host: Host;
+} ? BuildDescriptors<T, globalThis.ContextualClient['host']> : T;
+
+interface DataExtensionSchema {
+    /**
+     * Schema ID.
+     * @readonly
+     */
+    _id?: string | null;
+    /** FQDN of the entity this schema extends. */
+    fqdn?: string | null;
+    /**
+     * Namespace for this schema. For example, an app creating schemas might use their app name as a namespace.
+     * When a site owner creates a user-defined schema, the namespace is: `_user_fields`.
+     */
+    namespace?: string | null;
+    /**
+     * Schema definition in [JSON schema format](https://dev.wix.com/docs/build-apps/develop-your-app/extensions/backend-extensions/schema-plugins/the-json-schema) with the following [vocab](https://docs.json-everything.net/schema/vocabs/) extension:
+     * ```
+     * {
+     * "$schema": "https://json-schema.org/draft/2020-12/schema",
+     * "$id": "https://wixapis.com/v1/json-schema/extensions",
+     * "$vocabulary": {
+     * "https://wixapis.com/v1/json-schema/extensions/vocab/data-extensions": true
+     * },
+     * "$dynamicAnchor": "meta",
+     * "title": "Wix' data-extensions vocabulary meta schema",
+     * "type": [
+     * "object",
+     * "boolean"
+     * ],
+     * "properties": {
+     * "x-wix-permissions": {
+     * "type": "object",
+     * "description": "list of identity types that are allowed reading schema properties",
+     * "properties": {
+     * "read": {
+     * "type": "array",
+     * "items": {
+     * "type": "string",
+     * "enum": [
+     * "apps",
+     * "owning-app",
+     * "users",
+     * "users-of-users"
+     * ]
+     * }
+     * },
+     * "write": {
+     * "type": "array",
+     * "items": {
+     * "type": "string",
+     * "enum": [
+     * "apps",
+     * "owning-app",
+     * "users",
+     * "users-of-users"
+     * ]
+     * }
+     * }
+     * }
+     * },
+     * "x-wix-display": {
+     * "type": "object",
+     * "description": "field display properties",
+     * "schema": {
+     * "properties": {
+     * "placeholder": {
+     * "type": "string",
+     * "maxLength": 255,
+     * "description": "placeholder text for input fields"
+     * },
+     * "label": {
+     * "type": "string",
+     * "maxLength": 255,
+     * "description": "label of the input fields"
+     * },
+     * "hint": {
+     * "type": "string",
+     * "maxLength": 255,
+     * "description": "a short explanation that appears next to the input field"
+     * }
+     * }
+     * }
+     * }
+     * }
+     * }
+     * ```
+     */
+    jsonSchema?: Record<string, any> | null;
+    /**
+     * Date and time the schema was last updated.
+     * @readonly
+     */
+    _updatedDate?: Date;
+    /**
+     * Date and time the schema was created.
+     * @readonly
+     */
+    _createdDate?: Date;
+    /**
+     * Revision number, which increments by 1 each time the schema is updated. To prevent conflicting changes, the existing revision must be used when updating a schema.
+     * @readonly
+     */
+    revision?: string | null;
+    /**
+     * Maximum allowed schema size in bytes.
+     * @readonly
+     */
+    maxLimitBytes?: number | null;
+    /**
+     * Current schema size in bytes.
+     * @readonly
+     */
+    currentSizeBytes?: number | null;
+    /** Name of the specific entity field this schema is extending, or `"ROOT"` for extensions for the entire entity. Default: `"ROOT"`. */
+    extensionPoint?: string;
+}
+interface ReindexEvent {
+    /** fqdn of the dext schema that needs reindexing */
+    fqdn?: string;
+    /** List of fields that needs reindexing */
+    fields?: ReindexField[];
+}
+interface ReindexField {
+    /** path of field that needs reindexing */
+    fieldPath?: string;
+    /** only reindex records updated after this timestamp */
+    reindexSince?: Date;
+}
+interface CreateDataExtensionSchemaRequest {
+    /** Schema to create. */
+    dataExtensionSchema: DataExtensionSchema;
+}
+interface CreateDataExtensionSchemaResponse {
+    /** Created schema. */
+    dataExtensionSchema?: DataExtensionSchema;
+}
+interface UpdateDataExtensionSchemaRequest {
+    /** Schema to update. */
+    dataExtensionSchema?: DataExtensionSchema;
+}
+interface UpdateDataExtensionSchemaResponse {
+    /** Updated schema. */
+    dataExtensionSchema?: DataExtensionSchema;
+}
+interface ListDataExtensionSchemasRequest {
+    /** [Fully qualified domain name](https://dev.wix.com/docs/rest/articles/getting-started/fqdns). */
+    fqdn: string;
+    /** Namespaces within the given entity. */
+    namespaces?: string[];
+    /** Additional fields that are hidden by default. For example, fields with `"x-wix-archived": true`. */
+    fields?: RequestedField[];
+}
+declare enum RequestedField {
+    /** Doesn't do anything */
+    UNKNOWN_REQUESTED_FIELD = "UNKNOWN_REQUESTED_FIELD",
+    /** Returns `x-wix-archived` fields in `DataExtensionSchema.json_schema`. */
+    ARCHIVED = "ARCHIVED"
+}
+interface ListDataExtensionSchemasResponse {
+    /** Requested schemas. */
+    dataExtensionSchemas?: DataExtensionSchema[];
+}
+interface ListAllDataExtensionSchemasRequest {
+    /** [Fully qualified domain name](https://dev.wix.com/docs/rest/articles/getting-started/fqdns). */
+    fqdn?: string;
+    /** Namespaces within the given entity. */
+    namespaces?: string[];
+    /** Additional fields that are hidden by default. For example, fields with `"x-wix-archived": true`. */
+    fields?: RequestedField[];
+}
+interface ListAllDataExtensionSchemasResponse {
+    /** Requested schemas. */
+    dataExtensionSchemas?: DataExtensionSchema[];
+}
+interface UpsertDataExtensionGlobalSchemaRequest {
+    /** the upsert to create */
+    dataExtensionSchema?: DataExtensionSchema;
+}
+interface UpsertDataExtensionGlobalSchemaResponse {
+    /** the upsert schema */
+    dataExtensionSchema?: DataExtensionSchema;
+}
+interface DeleteDemoDataExtensionSchemaRequest {
+    /** Schema ID. */
+    dataExtensionSchemaId?: string;
+}
+interface DeleteDemoDataExtensionSchemaResponse {
+}
+interface DeleteGlobalExtensionSchemaRequest {
+    /** fqdn */
+    fqdn?: string;
+    /** namespace */
+    namespace?: string;
+}
+interface DeleteGlobalExtensionSchemaResponse {
+}
+interface DeleteByWhiteListedMetaSiteRequest {
+    /** Meta site id */
+    metaSiteId: string;
+}
+interface DeleteByWhiteListedMetaSiteResponse {
+    /** has more */
+    hasMore?: boolean;
+}
+interface DomainEvent extends DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+    /**
+     * Unique event ID.
+     * Allows clients to ignore duplicate webhooks.
+     */
+    _id?: string;
+    /**
+     * Assumes actions are also always typed to an entity_type
+     * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
+     */
+    entityFqdn?: string;
+    /**
+     * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
+     * This is although the created/updated/deleted notion is duplication of the oneof types
+     * 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;
+    /**
+     * 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 defining the order of updates to the underlying entity.
+     * For example, given that some entity was updated at 16:00 and than again at 16:01,
+     * it is guaranteed that the sequence number of the second update is strictly higher than the first.
+     * As the consumer, you can use this value to ensure that you handle messages in the correct order.
+     * To do so, you will need to persist this number on your end, and compare the sequence number from the
+     * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
+     */
+    entityEventSequence?: string | null;
+}
+/** @oneof */
+interface DomainEventBodyOneOf {
+    createdEvent?: EntityCreatedEvent;
+    updatedEvent?: EntityUpdatedEvent;
+    deletedEvent?: EntityDeletedEvent;
+    actionEvent?: ActionEvent;
+}
+interface EntityCreatedEvent {
+    entity?: string;
+}
+interface RestoreInfo {
+    deletedDate?: Date;
+}
+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 Empty {
+}
+/** payload for kafka event for this version on app submit */
+interface AppVersionStateChanged extends AppVersionStateChangedStateOneOf {
+    created?: AppVersionCreated;
+    submitted?: AppVersionSubmitted;
+    published?: AppVersionPublished;
+    declined?: AppVersionDeclined;
+    released?: AppVersionReleased;
+    approved?: AppVersionApproved;
+    draftChanged?: AppVersionDraftChanged;
+    archived?: AppVersionArchived;
+    appId?: string;
+    /** @readonly */
+    version?: string;
+    previousState?: VersionStatus;
+}
+/** @oneof */
+interface AppVersionStateChangedStateOneOf {
+    created?: AppVersionCreated;
+    submitted?: AppVersionSubmitted;
+    published?: AppVersionPublished;
+    declined?: AppVersionDeclined;
+    released?: AppVersionReleased;
+    approved?: AppVersionApproved;
+    draftChanged?: AppVersionDraftChanged;
+    archived?: AppVersionArchived;
+}
+interface AppVersionCreated {
+}
+interface AppVersionSubmitted {
+}
+interface AppVersionPublished {
+}
+interface AppVersionDeclined {
+}
+interface AppVersionReleased {
+}
+interface AppVersionApproved {
+}
+interface AppVersionDraftChanged {
+}
+interface AppVersionArchived {
+}
+declare enum VersionStatus {
+    /** default, internal use status. do not use */
+    NONE_STATUS = "NONE_STATUS",
+    /** a version which was created in the dev center and has not started the approval process yet */
+    DRAFT = "DRAFT",
+    /** the version was submitted for review by the developer */
+    SUBMITTED = "SUBMITTED",
+    /** the version is being reviewed by the app market team in cactus */
+    IN_REVIEW = "IN_REVIEW",
+    /** our team approved the version */
+    APPROVED = "APPROVED",
+    /** this version is published - only one version can be published at any given time; if this app was already published, the previously published version's status is now ARCHIVED */
+    PUBLISHED = "PUBLISHED",
+    /** our team did not accept this version of the app */
+    DECLINED = "DECLINED",
+    /** the status for versions that are no longer relevant */
+    ARCHIVED = "ARCHIVED",
+    /** status for versions with no significant changes, e.g. for test app. for questions contact our team */
+    HIDDEN = "HIDDEN",
+    /** mark apps as RELEASED, without adding to the apps cache, and allow users to install */
+    RELEASED = "RELEASED"
+}
+interface MessageEnvelope {
+    /** App instance ID. */
+    instanceId?: string | null;
+    /** Event type. */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+    /** Stringify payload. */
+    data?: string;
+}
+interface IdentificationData extends IdentificationDataIdOneOf {
+    /** ID of a site visitor that has not logged in to the site. */
+    anonymousVisitorId?: string;
+    /** ID of a site visitor that has logged in to the site. */
+    memberId?: string;
+    /** ID of a Wix user (site owner, contributor, etc.). */
+    wixUserId?: string;
+    /** ID of an app. */
+    appId?: string;
+    /** @readonly */
+    identityType?: WebhookIdentityType;
+}
+/** @oneof */
+interface IdentificationDataIdOneOf {
+    /** ID of a site visitor that has not logged in to the site. */
+    anonymousVisitorId?: string;
+    /** ID of a site visitor that has logged in to the site. */
+    memberId?: string;
+    /** ID of a Wix user (site owner, contributor, etc.). */
+    wixUserId?: string;
+    /** ID of an app. */
+    appId?: string;
+}
+declare enum WebhookIdentityType {
+    UNKNOWN = "UNKNOWN",
+    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
+    MEMBER = "MEMBER",
+    WIX_USER = "WIX_USER",
+    APP = "APP"
+}
+interface DataExtensionSchemaNonNullableFields {
+    extensionPoint: string;
+}
+interface CreateDataExtensionSchemaResponseNonNullableFields {
+    dataExtensionSchema?: DataExtensionSchemaNonNullableFields;
+}
+interface UpdateDataExtensionSchemaResponseNonNullableFields {
+    dataExtensionSchema?: DataExtensionSchemaNonNullableFields;
+}
+interface ListDataExtensionSchemasResponseNonNullableFields {
+    dataExtensionSchemas: DataExtensionSchemaNonNullableFields[];
+}
+interface DeleteByWhiteListedMetaSiteResponseNonNullableFields {
+    hasMore: boolean;
+}
+interface BaseEventMetadata {
+    /** App instance ID. */
+    instanceId?: string | null;
+    /** Event type. */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+}
+interface EventMetadata extends BaseEventMetadata {
+    /**
+     * Unique event ID.
+     * Allows clients to ignore duplicate webhooks.
+     */
+    _id?: string;
+    /**
+     * Assumes actions are also always typed to an entity_type
+     * Example: wix.stores.catalog.product, wix.bookings.session, wix.payments.transaction
+     */
+    entityFqdn?: string;
+    /**
+     * This is top level to ease client code dispatching of messages (switch on entity_fqdn+slug)
+     * This is although the created/updated/deleted notion is duplication of the oneof types
+     * 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;
+    /**
+     * 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 defining the order of updates to the underlying entity.
+     * For example, given that some entity was updated at 16:00 and than again at 16:01,
+     * it is guaranteed that the sequence number of the second update is strictly higher than the first.
+     * As the consumer, you can use this value to ensure that you handle messages in the correct order.
+     * To do so, you will need to persist this number on your end, and compare the sequence number from the
+     * message against the one you have stored. Given that the stored number is higher, you should ignore the message.
+     */
+    entityEventSequence?: string | null;
+}
+interface DataExtensionSchemaCreatedEnvelope {
+    entity: DataExtensionSchema;
+    metadata: EventMetadata;
+}
+interface DataExtensionSchemaUpdatedEnvelope {
+    entity: DataExtensionSchema;
+    metadata: EventMetadata;
+}
+interface DataExtensionSchemaDeletedEnvelope {
+    metadata: EventMetadata;
+}
+interface UpdateDataExtensionSchemaOptions {
+    /** Schema to update. */
+    dataExtensionSchema?: DataExtensionSchema;
+}
+interface ListDataExtensionSchemasOptions {
+    /** Namespaces within the given entity. */
+    namespaces?: string[];
+    /** Additional fields that are hidden by default. For example, fields with `"x-wix-archived": true`. */
+    fields?: RequestedField[];
+}
+
+declare function createDataExtensionSchema$1(httpClient: HttpClient): CreateDataExtensionSchemaSignature;
+interface CreateDataExtensionSchemaSignature {
+    /**
+     * Creates a user-defined data extension schema.
+     * @param - Schema to create.
+     * @returns Created schema.
+     */
+    (dataExtensionSchema: DataExtensionSchema): Promise<DataExtensionSchema & DataExtensionSchemaNonNullableFields>;
+}
+declare function updateDataExtensionSchema$1(httpClient: HttpClient): UpdateDataExtensionSchemaSignature;
+interface UpdateDataExtensionSchemaSignature {
+    /**
+     * Updates a user-defined data extension schema, overriding the existing data.
+     * @param - Field options. The following fields **must** be passed: `_id`, `jsonSchema`, `revision`.
+     */
+    (options?: UpdateDataExtensionSchemaOptions | undefined): Promise<UpdateDataExtensionSchemaResponse & UpdateDataExtensionSchemaResponseNonNullableFields>;
+}
+declare function listDataExtensionSchemas$1(httpClient: HttpClient): ListDataExtensionSchemasSignature;
+interface ListDataExtensionSchemasSignature {
+    /**
+     * Retrieves a list of global and user-defined data extension schemas for a given FQDN.
+     * @param - [Fully qualified domain name](https://dev.wix.com/docs/rest/articles/getting-started/fqdns).
+     */
+    (fqdn: string, options?: ListDataExtensionSchemasOptions | undefined): Promise<ListDataExtensionSchemasResponse & ListDataExtensionSchemasResponseNonNullableFields>;
+}
+declare function deleteByWhiteListedMetaSite$1(httpClient: HttpClient): DeleteByWhiteListedMetaSiteSignature;
+interface DeleteByWhiteListedMetaSiteSignature {
+    /**
+     * Deletes schemas of whitelisted metasite ids
+     * @param - Meta site id
+     */
+    (metaSiteId: string): Promise<DeleteByWhiteListedMetaSiteResponse & DeleteByWhiteListedMetaSiteResponseNonNullableFields>;
+}
+declare const onDataExtensionSchemaCreated$1: EventDefinition<DataExtensionSchemaCreatedEnvelope, "wix.data_extensions.v1.data_extension_schema_created">;
+declare const onDataExtensionSchemaUpdated$1: EventDefinition<DataExtensionSchemaUpdatedEnvelope, "wix.data_extensions.v1.data_extension_schema_updated">;
+declare const onDataExtensionSchemaDeleted$1: EventDefinition<DataExtensionSchemaDeletedEnvelope, "wix.data_extensions.v1.data_extension_schema_deleted">;
+
+declare function createEventModule<T extends EventDefinition<any, string>>(eventDefinition: T): BuildEventDefinition<T> & T;
+
+declare const createDataExtensionSchema: MaybeContext<BuildRESTFunction<typeof createDataExtensionSchema$1> & typeof createDataExtensionSchema$1>;
+declare const updateDataExtensionSchema: MaybeContext<BuildRESTFunction<typeof updateDataExtensionSchema$1> & typeof updateDataExtensionSchema$1>;
+declare const listDataExtensionSchemas: MaybeContext<BuildRESTFunction<typeof listDataExtensionSchemas$1> & typeof listDataExtensionSchemas$1>;
+declare const deleteByWhiteListedMetaSite: MaybeContext<BuildRESTFunction<typeof deleteByWhiteListedMetaSite$1> & typeof deleteByWhiteListedMetaSite$1>;
+
+type _publicOnDataExtensionSchemaCreatedType = typeof onDataExtensionSchemaCreated$1;
+/**
+ * Triggered when a data extension schema is created.
+ */
+declare const onDataExtensionSchemaCreated: ReturnType<typeof createEventModule<_publicOnDataExtensionSchemaCreatedType>>;
+
+type _publicOnDataExtensionSchemaUpdatedType = typeof onDataExtensionSchemaUpdated$1;
+/**
+ * Triggered when a data extension schema is updated.
+ */
+declare const onDataExtensionSchemaUpdated: ReturnType<typeof createEventModule<_publicOnDataExtensionSchemaUpdatedType>>;
+
+type _publicOnDataExtensionSchemaDeletedType = typeof onDataExtensionSchemaDeleted$1;
+/**
+ * Triggered when a data extension schema is deleted.
+ */
+declare const onDataExtensionSchemaDeleted: ReturnType<typeof createEventModule<_publicOnDataExtensionSchemaDeletedType>>;
+
+type context_ActionEvent = ActionEvent;
+type context_AppVersionApproved = AppVersionApproved;
+type context_AppVersionArchived = AppVersionArchived;
+type context_AppVersionCreated = AppVersionCreated;
+type context_AppVersionDeclined = AppVersionDeclined;
+type context_AppVersionDraftChanged = AppVersionDraftChanged;
+type context_AppVersionPublished = AppVersionPublished;
+type context_AppVersionReleased = AppVersionReleased;
+type context_AppVersionStateChanged = AppVersionStateChanged;
+type context_AppVersionStateChangedStateOneOf = AppVersionStateChangedStateOneOf;
+type context_AppVersionSubmitted = AppVersionSubmitted;
+type context_BaseEventMetadata = BaseEventMetadata;
+type context_CreateDataExtensionSchemaRequest = CreateDataExtensionSchemaRequest;
+type context_CreateDataExtensionSchemaResponse = CreateDataExtensionSchemaResponse;
+type context_CreateDataExtensionSchemaResponseNonNullableFields = CreateDataExtensionSchemaResponseNonNullableFields;
+type context_DataExtensionSchema = DataExtensionSchema;
+type context_DataExtensionSchemaCreatedEnvelope = DataExtensionSchemaCreatedEnvelope;
+type context_DataExtensionSchemaDeletedEnvelope = DataExtensionSchemaDeletedEnvelope;
+type context_DataExtensionSchemaNonNullableFields = DataExtensionSchemaNonNullableFields;
+type context_DataExtensionSchemaUpdatedEnvelope = DataExtensionSchemaUpdatedEnvelope;
+type context_DeleteByWhiteListedMetaSiteRequest = DeleteByWhiteListedMetaSiteRequest;
+type context_DeleteByWhiteListedMetaSiteResponse = DeleteByWhiteListedMetaSiteResponse;
+type context_DeleteByWhiteListedMetaSiteResponseNonNullableFields = DeleteByWhiteListedMetaSiteResponseNonNullableFields;
+type context_DeleteDemoDataExtensionSchemaRequest = DeleteDemoDataExtensionSchemaRequest;
+type context_DeleteDemoDataExtensionSchemaResponse = DeleteDemoDataExtensionSchemaResponse;
+type context_DeleteGlobalExtensionSchemaRequest = DeleteGlobalExtensionSchemaRequest;
+type context_DeleteGlobalExtensionSchemaResponse = DeleteGlobalExtensionSchemaResponse;
+type context_DomainEvent = DomainEvent;
+type context_DomainEventBodyOneOf = DomainEventBodyOneOf;
+type context_Empty = Empty;
+type context_EntityCreatedEvent = EntityCreatedEvent;
+type context_EntityDeletedEvent = EntityDeletedEvent;
+type context_EntityUpdatedEvent = EntityUpdatedEvent;
+type context_EventMetadata = EventMetadata;
+type context_IdentificationData = IdentificationData;
+type context_IdentificationDataIdOneOf = IdentificationDataIdOneOf;
+type context_ListAllDataExtensionSchemasRequest = ListAllDataExtensionSchemasRequest;
+type context_ListAllDataExtensionSchemasResponse = ListAllDataExtensionSchemasResponse;
+type context_ListDataExtensionSchemasOptions = ListDataExtensionSchemasOptions;
+type context_ListDataExtensionSchemasRequest = ListDataExtensionSchemasRequest;
+type context_ListDataExtensionSchemasResponse = ListDataExtensionSchemasResponse;
+type context_ListDataExtensionSchemasResponseNonNullableFields = ListDataExtensionSchemasResponseNonNullableFields;
+type context_MessageEnvelope = MessageEnvelope;
+type context_ReindexEvent = ReindexEvent;
+type context_ReindexField = ReindexField;
+type context_RequestedField = RequestedField;
+declare const context_RequestedField: typeof RequestedField;
+type context_RestoreInfo = RestoreInfo;
+type context_UpdateDataExtensionSchemaOptions = UpdateDataExtensionSchemaOptions;
+type context_UpdateDataExtensionSchemaRequest = UpdateDataExtensionSchemaRequest;
+type context_UpdateDataExtensionSchemaResponse = UpdateDataExtensionSchemaResponse;
+type context_UpdateDataExtensionSchemaResponseNonNullableFields = UpdateDataExtensionSchemaResponseNonNullableFields;
+type context_UpsertDataExtensionGlobalSchemaRequest = UpsertDataExtensionGlobalSchemaRequest;
+type context_UpsertDataExtensionGlobalSchemaResponse = UpsertDataExtensionGlobalSchemaResponse;
+type context_VersionStatus = VersionStatus;
+declare const context_VersionStatus: typeof VersionStatus;
+type context_WebhookIdentityType = WebhookIdentityType;
+declare const context_WebhookIdentityType: typeof WebhookIdentityType;
+type context__publicOnDataExtensionSchemaCreatedType = _publicOnDataExtensionSchemaCreatedType;
+type context__publicOnDataExtensionSchemaDeletedType = _publicOnDataExtensionSchemaDeletedType;
+type context__publicOnDataExtensionSchemaUpdatedType = _publicOnDataExtensionSchemaUpdatedType;
+declare const context_createDataExtensionSchema: typeof createDataExtensionSchema;
+declare const context_deleteByWhiteListedMetaSite: typeof deleteByWhiteListedMetaSite;
+declare const context_listDataExtensionSchemas: typeof listDataExtensionSchemas;
+declare const context_onDataExtensionSchemaCreated: typeof onDataExtensionSchemaCreated;
+declare const context_onDataExtensionSchemaDeleted: typeof onDataExtensionSchemaDeleted;
+declare const context_onDataExtensionSchemaUpdated: typeof onDataExtensionSchemaUpdated;
+declare const context_updateDataExtensionSchema: typeof updateDataExtensionSchema;
+declare namespace context {
+  export { type context_ActionEvent as ActionEvent, type context_AppVersionApproved as AppVersionApproved, type context_AppVersionArchived as AppVersionArchived, type context_AppVersionCreated as AppVersionCreated, type context_AppVersionDeclined as AppVersionDeclined, type context_AppVersionDraftChanged as AppVersionDraftChanged, type context_AppVersionPublished as AppVersionPublished, type context_AppVersionReleased as AppVersionReleased, type context_AppVersionStateChanged as AppVersionStateChanged, type context_AppVersionStateChangedStateOneOf as AppVersionStateChangedStateOneOf, type context_AppVersionSubmitted as AppVersionSubmitted, type context_BaseEventMetadata as BaseEventMetadata, type context_CreateDataExtensionSchemaRequest as CreateDataExtensionSchemaRequest, type context_CreateDataExtensionSchemaResponse as CreateDataExtensionSchemaResponse, type context_CreateDataExtensionSchemaResponseNonNullableFields as CreateDataExtensionSchemaResponseNonNullableFields, type context_DataExtensionSchema as DataExtensionSchema, type context_DataExtensionSchemaCreatedEnvelope as DataExtensionSchemaCreatedEnvelope, type context_DataExtensionSchemaDeletedEnvelope as DataExtensionSchemaDeletedEnvelope, type context_DataExtensionSchemaNonNullableFields as DataExtensionSchemaNonNullableFields, type context_DataExtensionSchemaUpdatedEnvelope as DataExtensionSchemaUpdatedEnvelope, type context_DeleteByWhiteListedMetaSiteRequest as DeleteByWhiteListedMetaSiteRequest, type context_DeleteByWhiteListedMetaSiteResponse as DeleteByWhiteListedMetaSiteResponse, type context_DeleteByWhiteListedMetaSiteResponseNonNullableFields as DeleteByWhiteListedMetaSiteResponseNonNullableFields, type context_DeleteDemoDataExtensionSchemaRequest as DeleteDemoDataExtensionSchemaRequest, type context_DeleteDemoDataExtensionSchemaResponse as DeleteDemoDataExtensionSchemaResponse, type context_DeleteGlobalExtensionSchemaRequest as DeleteGlobalExtensionSchemaRequest, type context_DeleteGlobalExtensionSchemaResponse as DeleteGlobalExtensionSchemaResponse, type context_DomainEvent as DomainEvent, type context_DomainEventBodyOneOf as DomainEventBodyOneOf, type context_Empty as Empty, type context_EntityCreatedEvent as EntityCreatedEvent, type context_EntityDeletedEvent as EntityDeletedEvent, type context_EntityUpdatedEvent as EntityUpdatedEvent, type context_EventMetadata as EventMetadata, type context_IdentificationData as IdentificationData, type context_IdentificationDataIdOneOf as IdentificationDataIdOneOf, type context_ListAllDataExtensionSchemasRequest as ListAllDataExtensionSchemasRequest, type context_ListAllDataExtensionSchemasResponse as ListAllDataExtensionSchemasResponse, type context_ListDataExtensionSchemasOptions as ListDataExtensionSchemasOptions, type context_ListDataExtensionSchemasRequest as ListDataExtensionSchemasRequest, type context_ListDataExtensionSchemasResponse as ListDataExtensionSchemasResponse, type context_ListDataExtensionSchemasResponseNonNullableFields as ListDataExtensionSchemasResponseNonNullableFields, type context_MessageEnvelope as MessageEnvelope, type context_ReindexEvent as ReindexEvent, type context_ReindexField as ReindexField, context_RequestedField as RequestedField, type context_RestoreInfo as RestoreInfo, type context_UpdateDataExtensionSchemaOptions as UpdateDataExtensionSchemaOptions, type context_UpdateDataExtensionSchemaRequest as UpdateDataExtensionSchemaRequest, type context_UpdateDataExtensionSchemaResponse as UpdateDataExtensionSchemaResponse, type context_UpdateDataExtensionSchemaResponseNonNullableFields as UpdateDataExtensionSchemaResponseNonNullableFields, type context_UpsertDataExtensionGlobalSchemaRequest as UpsertDataExtensionGlobalSchemaRequest, type context_UpsertDataExtensionGlobalSchemaResponse as UpsertDataExtensionGlobalSchemaResponse, context_VersionStatus as VersionStatus, context_WebhookIdentityType as WebhookIdentityType, type context__publicOnDataExtensionSchemaCreatedType as _publicOnDataExtensionSchemaCreatedType, type context__publicOnDataExtensionSchemaDeletedType as _publicOnDataExtensionSchemaDeletedType, type context__publicOnDataExtensionSchemaUpdatedType as _publicOnDataExtensionSchemaUpdatedType, context_createDataExtensionSchema as createDataExtensionSchema, context_deleteByWhiteListedMetaSite as deleteByWhiteListedMetaSite, context_listDataExtensionSchemas as listDataExtensionSchemas, context_onDataExtensionSchemaCreated as onDataExtensionSchemaCreated, context_onDataExtensionSchemaDeleted as onDataExtensionSchemaDeleted, context_onDataExtensionSchemaUpdated as onDataExtensionSchemaUpdated, onDataExtensionSchemaCreated$1 as publicOnDataExtensionSchemaCreated, onDataExtensionSchemaDeleted$1 as publicOnDataExtensionSchemaDeleted, onDataExtensionSchemaUpdated$1 as publicOnDataExtensionSchemaUpdated, context_updateDataExtensionSchema as updateDataExtensionSchema };
+}
+
+export { context as schemas };