@wix/email-subscriptions 1.0.23 → 1.0.25

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

@@ -1,975 +0,0 @@
-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 EmailSubscription {
-    /**
-     * Email subscription ID.
-     * @readonly
-     */
-    _id?: string | null;
-    /** Email address. */
-    email?: string;
-    /**
-     * Indicates the recipient's opt-in or opt-out status
-     * for marketing emails.
-     *
-     * Default: `NOT_SET`.
-     */
-    subscriptionStatus?: SubscriptionEnumStatus;
-    /**
-     * Indicates last reported status of sent emails.
-     *
-     * Default: `NOT_SET`.
-     */
-    deliverabilityStatus?: Status;
-    /**
-     * Date and time the email subscription was created.
-     * @readonly
-     */
-    _createdDate?: Date | null;
-    /**
-     * Date and time the email subscription was last updated.
-     * @readonly
-     */
-    _updatedDate?: Date | null;
-}
-declare enum SubscriptionEnumStatus {
-    /** Undefined status. */
-    UNKNOWN = "UNKNOWN",
-    /** No status specified. This is the default, initial value before any info about the email address is known. */
-    NOT_SET = "NOT_SET",
-    /** Subscription confirmation was requested, but recipient hasn't confirmed yet. */
-    PENDING = "PENDING",
-    /** Recipient has opted in to marketing emails. */
-    SUBSCRIBED = "SUBSCRIBED",
-    /** Recipient has opted out of marketing emails. */
-    UNSUBSCRIBED = "UNSUBSCRIBED"
-}
-declare enum Status {
-    /** No status specified. This is the initial default value before any info about the email address is known. */
-    NOT_SET = "NOT_SET",
-    /** Emails to this email address are being delivered successfully. */
-    VALID = "VALID",
-    /** The last email to the recipient bounced or was rejected. */
-    BOUNCED = "BOUNCED",
-    /** The recipient registered a spam complaint with their email provider. */
-    SPAM_COMPLAINT = "SPAM_COMPLAINT",
-    /** Multiple campaigns have been delivered to this address without any engagement from the recipient. (No emails were opened and no content was clicked.) This status might impact subsequent emails sent to this address. */
-    INACTIVE = "INACTIVE"
-}
-interface V1RenderUnsubscribePageRequest {
-    /** Payload */
-    payload?: string;
-    /** Language */
-    language?: string | null;
-}
-interface RawHttpResponse {
-    body?: Uint8Array;
-    statusCode?: number | null;
-    headers?: HeadersEntry[];
-}
-interface HeadersEntry {
-    key?: string;
-    value?: string;
-}
-interface V1ConfirmUnsubscribeActionRequest {
-    /** Payload */
-    payload?: string;
-}
-interface Empty {
-}
-interface EmailSubscriptionChanged {
-    /** subscription */
-    subscription?: EmailSubscription;
-}
-interface GetEmailSubscriptionRequest {
-    _id?: string;
-}
-interface GetEmailSubscriptionResponse {
-    /** Returned email subscription */
-    emailSubscription?: EmailSubscription;
-}
-interface UpdateEmailSubscriptionRequest {
-    /** Email subscription to update */
-    subscription?: EmailSubscription;
-}
-interface UpdateEmailSubscriptionResponse {
-    /** Updated email subscription */
-    subscription?: EmailSubscription;
-}
-interface QueryEmailSubscriptionsRequest {
-    /**
-     * Filter options.
-     * Currently, querying is supported on the `email` field
-     * with the `$in` array filter.
-     */
-    filter: Record<string, any> | null;
-    /**
-     * Pagination options. For more information, see
-     * [Pagination](https://dev.wix.com/api/rest/getting-started/pagination).
-     */
-    paging?: Paging;
-}
-interface Paging {
-    /** Number of items to load. */
-    limit?: number | null;
-    /** Number of items to skip in the current sort order. */
-    offset?: number | null;
-}
-interface QueryEmailSubscriptionsResponse {
-    /** List of subscribed emails that matched the query options. */
-    subscriptions?: EmailSubscription[];
-    /** Metadata for the paginated results. */
-    metadata?: PagingMetadata;
-}
-interface PagingMetadata {
-    /** 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. */
-    total?: number | null;
-    /** Flag that indicates the server failed to calculate the `total` field. */
-    tooManyToCount?: boolean | null;
-}
-interface UpsertEmailSubscriptionRequest {
-    /** Email subscription to update or create. */
-    subscription?: EmailSubscription;
-}
-interface UpsertEmailSubscriptionResponse {
-    /** Updated or created email subscription. */
-    subscription?: EmailSubscription;
-}
-interface BulkUpsertEmailSubscriptionRequest {
-    /** List of email subscriptions to update or create. */
-    subscriptions: EmailSubscription[];
-}
-interface BulkUpsertEmailSubscriptionResponse {
-    /** List of updated or created email subscriptions. */
-    results?: BulkUpsertEmailSubscriptionResult[];
-    /** Numbers of successful and failed actions. */
-    metadata?: Metadata;
-}
-interface BulkUpsertEmailSubscriptionResult {
-    /** Position of the requested email subscription in the bulk array. */
-    originalIndex?: number;
-    /** New or updated email subscription. */
-    emailSubscription?: EmailSubscription;
-    /**
-     * Error information if the action failed.
-     * Omitted from successful actions.
-     */
-    error?: Error;
-}
-interface Error {
-    /** Error code. */
-    errorCode?: string;
-    /** Message that contains details about the error. */
-    message?: string;
-}
-interface Metadata {
-    /** Number of successful actions. */
-    totalSuccess?: number;
-    /** Number of failed actions. */
-    totalFailure?: number;
-}
-interface GenerateUnsubscribeLinkRequest {
-    /** Email address the unsubscribe link is for. */
-    emailAddress: string;
-    /** Arbitrary parameters for closing-the-loop. */
-    metadata?: Record<string, string>;
-    /** Language for displaying unsubscribe confirmation page (optional - default EN). */
-    language?: string | null;
-}
-interface GenerateUnsubscribeLinkResponse {
-    /** The unsubscribe link. */
-    link?: string;
-}
-interface RenderUnsubscribePageRequest {
-    /** Payload */
-    payload?: string;
-    /** Language */
-    language?: string | null;
-}
-interface ConfirmUnsubscribeActionRequest {
-    /** Payload */
-    payload?: string;
-}
-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 | 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 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 | 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. */
-    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 EmailSubscriptionNonNullableFields {
-    email: string;
-    subscriptionStatus: SubscriptionEnumStatus;
-    deliverabilityStatus: Status;
-}
-interface QueryEmailSubscriptionsResponseNonNullableFields {
-    subscriptions: EmailSubscriptionNonNullableFields[];
-}
-interface UpsertEmailSubscriptionResponseNonNullableFields {
-    subscription?: EmailSubscriptionNonNullableFields;
-}
-interface ErrorNonNullableFields {
-    errorCode: string;
-    message: string;
-}
-interface BulkUpsertEmailSubscriptionResultNonNullableFields {
-    originalIndex: number;
-    emailSubscription?: EmailSubscriptionNonNullableFields;
-    error?: ErrorNonNullableFields;
-}
-interface MetadataNonNullableFields {
-    totalSuccess: number;
-    totalFailure: number;
-}
-interface BulkUpsertEmailSubscriptionResponseNonNullableFields {
-    results: BulkUpsertEmailSubscriptionResultNonNullableFields[];
-    metadata?: MetadataNonNullableFields;
-}
-interface GenerateUnsubscribeLinkResponseNonNullableFields {
-    link: string;
-}
-interface BaseEventMetadata {
-    /** App instance ID. */
-    instanceId?: string | null;
-    /** Event type. */
-    eventType?: string;
-    /** The identification type and identity data. */
-    identity?: IdentificationData;
-}
-interface EmailsubscriptionEmailSubscriptionChangedEnvelope {
-    data: EmailSubscriptionChanged;
-    metadata: BaseEventMetadata;
-}
-interface QueryEmailSubscriptionsOptions {
-    /**
-     * Pagination options. For more information, see
-     * [Pagination](https://dev.wix.com/api/rest/getting-started/pagination).
-     */
-    paging?: Paging;
-}
-interface UpsertEmailSubscriptionOptions {
-    /** Email subscription to update or create. */
-    subscription?: EmailSubscription;
-}
-interface GenerateUnsubscribeLinkOptions {
-    /** Arbitrary parameters for closing-the-loop. */
-    metadata?: Record<string, string>;
-    /** Language for displaying unsubscribe confirmation page (optional - default EN). */
-    language?: string | null;
-}
-
-declare function queryEmailSubscriptions$1(httpClient: HttpClient): QueryEmailSubscriptionsSignature;
-interface QueryEmailSubscriptionsSignature {
-    /**
-     * Retrieves email subscriptions,
-     * given the provided paging, filtering, and sorting.
-     *
-     * Currently, querying is supported on the `email` field
-     * with the `$in` array filter.
-     * For example, to query for emails "me@my.com" and "you@your.org",
-     * the filter should be formed like this:
-     *
-     * ```json
-     * { "filter": {
-     * "email": {
-     * "$in": ["me@my.com", "you@your.org"]
-     * }
-     * }
-     * }
-     * ```
-     *
-     * To learn how to query email subscriptions, see
-     * [API Query Language](https://dev.wix.com/api/rest/getting-started/api-query-language).
-     * @param - Filter options.
-     * Currently, querying is supported on the `email` field
-     * with the `$in` array filter.
-     */
-    (filter: Record<string, any> | null, options?: QueryEmailSubscriptionsOptions | undefined): Promise<QueryEmailSubscriptionsResponse & QueryEmailSubscriptionsResponseNonNullableFields>;
-}
-declare function upsertEmailSubscription$1(httpClient: HttpClient): UpsertEmailSubscriptionSignature;
-interface UpsertEmailSubscriptionSignature {
-    /**
-     * Updates or creates an email subscription for the requested email.
-     *
-     * An email subscription is always returned in the response,
-     * regardless of whether it was updated or created.
-     */
-    (options?: UpsertEmailSubscriptionOptions | undefined): Promise<UpsertEmailSubscriptionResponse & UpsertEmailSubscriptionResponseNonNullableFields>;
-}
-declare function bulkUpsertEmailSubscription$1(httpClient: HttpClient): BulkUpsertEmailSubscriptionSignature;
-interface BulkUpsertEmailSubscriptionSignature {
-    /**
-     * Updates or creates multiple email subscriptions.
-     * @param - List of email subscriptions to update or create.
-     */
-    (subscriptions: EmailSubscription[]): Promise<BulkUpsertEmailSubscriptionResponse & BulkUpsertEmailSubscriptionResponseNonNullableFields>;
-}
-declare function generateUnsubscribeLink$1(httpClient: HttpClient): GenerateUnsubscribeLinkSignature;
-interface GenerateUnsubscribeLinkSignature {
-    /**
-     * Creates an unsubscribe link to be shared with the relevant recipient.
-     *
-     * If someone clicks the **Unsubscribe** button on the confirmation page,
-     * the recipient's `subscriptionStatus` is changed to `UNSUBSCRIBED`.
-     * @param - Email address the unsubscribe link is for.
-     */
-    (emailAddress: string, options?: GenerateUnsubscribeLinkOptions | undefined): Promise<GenerateUnsubscribeLinkResponse & GenerateUnsubscribeLinkResponseNonNullableFields>;
-}
-declare const onEmailsubscriptionEmailSubscriptionChanged$1: EventDefinition<EmailsubscriptionEmailSubscriptionChangedEnvelope, "com.wixpress.emailsubscriptions.v1.EmailSubscriptionChanged">;
-
-declare function createEventModule<T extends EventDefinition<any, string>>(eventDefinition: T): BuildEventDefinition<T> & T;
-
-declare const queryEmailSubscriptions: MaybeContext<BuildRESTFunction<typeof queryEmailSubscriptions$1> & typeof queryEmailSubscriptions$1>;
-declare const upsertEmailSubscription: MaybeContext<BuildRESTFunction<typeof upsertEmailSubscription$1> & typeof upsertEmailSubscription$1>;
-declare const bulkUpsertEmailSubscription: MaybeContext<BuildRESTFunction<typeof bulkUpsertEmailSubscription$1> & typeof bulkUpsertEmailSubscription$1>;
-declare const generateUnsubscribeLink: MaybeContext<BuildRESTFunction<typeof generateUnsubscribeLink$1> & typeof generateUnsubscribeLink$1>;
-
-type _publicOnEmailsubscriptionEmailSubscriptionChangedType = typeof onEmailsubscriptionEmailSubscriptionChanged$1;
-/** */
-declare const onEmailsubscriptionEmailSubscriptionChanged: ReturnType<typeof createEventModule<_publicOnEmailsubscriptionEmailSubscriptionChangedType>>;
-
-type index_d_ActionEvent = ActionEvent;
-type index_d_BaseEventMetadata = BaseEventMetadata;
-type index_d_BulkUpsertEmailSubscriptionRequest = BulkUpsertEmailSubscriptionRequest;
-type index_d_BulkUpsertEmailSubscriptionResponse = BulkUpsertEmailSubscriptionResponse;
-type index_d_BulkUpsertEmailSubscriptionResponseNonNullableFields = BulkUpsertEmailSubscriptionResponseNonNullableFields;
-type index_d_BulkUpsertEmailSubscriptionResult = BulkUpsertEmailSubscriptionResult;
-type index_d_ConfirmUnsubscribeActionRequest = ConfirmUnsubscribeActionRequest;
-type index_d_DomainEvent = DomainEvent;
-type index_d_DomainEventBodyOneOf = DomainEventBodyOneOf;
-type index_d_EmailSubscription = EmailSubscription;
-type index_d_EmailSubscriptionChanged = EmailSubscriptionChanged;
-type index_d_EmailsubscriptionEmailSubscriptionChangedEnvelope = EmailsubscriptionEmailSubscriptionChangedEnvelope;
-type index_d_Empty = Empty;
-type index_d_EntityCreatedEvent = EntityCreatedEvent;
-type index_d_EntityDeletedEvent = EntityDeletedEvent;
-type index_d_EntityUpdatedEvent = EntityUpdatedEvent;
-type index_d_Error = Error;
-type index_d_GenerateUnsubscribeLinkOptions = GenerateUnsubscribeLinkOptions;
-type index_d_GenerateUnsubscribeLinkRequest = GenerateUnsubscribeLinkRequest;
-type index_d_GenerateUnsubscribeLinkResponse = GenerateUnsubscribeLinkResponse;
-type index_d_GenerateUnsubscribeLinkResponseNonNullableFields = GenerateUnsubscribeLinkResponseNonNullableFields;
-type index_d_GetEmailSubscriptionRequest = GetEmailSubscriptionRequest;
-type index_d_GetEmailSubscriptionResponse = GetEmailSubscriptionResponse;
-type index_d_HeadersEntry = HeadersEntry;
-type index_d_IdentificationData = IdentificationData;
-type index_d_IdentificationDataIdOneOf = IdentificationDataIdOneOf;
-type index_d_MessageEnvelope = MessageEnvelope;
-type index_d_Metadata = Metadata;
-type index_d_Paging = Paging;
-type index_d_PagingMetadata = PagingMetadata;
-type index_d_QueryEmailSubscriptionsOptions = QueryEmailSubscriptionsOptions;
-type index_d_QueryEmailSubscriptionsRequest = QueryEmailSubscriptionsRequest;
-type index_d_QueryEmailSubscriptionsResponse = QueryEmailSubscriptionsResponse;
-type index_d_QueryEmailSubscriptionsResponseNonNullableFields = QueryEmailSubscriptionsResponseNonNullableFields;
-type index_d_RawHttpResponse = RawHttpResponse;
-type index_d_RenderUnsubscribePageRequest = RenderUnsubscribePageRequest;
-type index_d_RestoreInfo = RestoreInfo;
-type index_d_Status = Status;
-declare const index_d_Status: typeof Status;
-type index_d_SubscriptionEnumStatus = SubscriptionEnumStatus;
-declare const index_d_SubscriptionEnumStatus: typeof SubscriptionEnumStatus;
-type index_d_UpdateEmailSubscriptionRequest = UpdateEmailSubscriptionRequest;
-type index_d_UpdateEmailSubscriptionResponse = UpdateEmailSubscriptionResponse;
-type index_d_UpsertEmailSubscriptionOptions = UpsertEmailSubscriptionOptions;
-type index_d_UpsertEmailSubscriptionRequest = UpsertEmailSubscriptionRequest;
-type index_d_UpsertEmailSubscriptionResponse = UpsertEmailSubscriptionResponse;
-type index_d_UpsertEmailSubscriptionResponseNonNullableFields = UpsertEmailSubscriptionResponseNonNullableFields;
-type index_d_V1ConfirmUnsubscribeActionRequest = V1ConfirmUnsubscribeActionRequest;
-type index_d_V1RenderUnsubscribePageRequest = V1RenderUnsubscribePageRequest;
-type index_d_WebhookIdentityType = WebhookIdentityType;
-declare const index_d_WebhookIdentityType: typeof WebhookIdentityType;
-type index_d__publicOnEmailsubscriptionEmailSubscriptionChangedType = _publicOnEmailsubscriptionEmailSubscriptionChangedType;
-declare const index_d_bulkUpsertEmailSubscription: typeof bulkUpsertEmailSubscription;
-declare const index_d_generateUnsubscribeLink: typeof generateUnsubscribeLink;
-declare const index_d_onEmailsubscriptionEmailSubscriptionChanged: typeof onEmailsubscriptionEmailSubscriptionChanged;
-declare const index_d_queryEmailSubscriptions: typeof queryEmailSubscriptions;
-declare const index_d_upsertEmailSubscription: typeof upsertEmailSubscription;
-declare namespace index_d {
-  export { type index_d_ActionEvent as ActionEvent, type index_d_BaseEventMetadata as BaseEventMetadata, type index_d_BulkUpsertEmailSubscriptionRequest as BulkUpsertEmailSubscriptionRequest, type index_d_BulkUpsertEmailSubscriptionResponse as BulkUpsertEmailSubscriptionResponse, type index_d_BulkUpsertEmailSubscriptionResponseNonNullableFields as BulkUpsertEmailSubscriptionResponseNonNullableFields, type index_d_BulkUpsertEmailSubscriptionResult as BulkUpsertEmailSubscriptionResult, type index_d_ConfirmUnsubscribeActionRequest as ConfirmUnsubscribeActionRequest, type index_d_DomainEvent as DomainEvent, type index_d_DomainEventBodyOneOf as DomainEventBodyOneOf, type index_d_EmailSubscription as EmailSubscription, type index_d_EmailSubscriptionChanged as EmailSubscriptionChanged, type index_d_EmailsubscriptionEmailSubscriptionChangedEnvelope as EmailsubscriptionEmailSubscriptionChangedEnvelope, type index_d_Empty as Empty, type index_d_EntityCreatedEvent as EntityCreatedEvent, type index_d_EntityDeletedEvent as EntityDeletedEvent, type index_d_EntityUpdatedEvent as EntityUpdatedEvent, type index_d_Error as Error, type index_d_GenerateUnsubscribeLinkOptions as GenerateUnsubscribeLinkOptions, type index_d_GenerateUnsubscribeLinkRequest as GenerateUnsubscribeLinkRequest, type index_d_GenerateUnsubscribeLinkResponse as GenerateUnsubscribeLinkResponse, type index_d_GenerateUnsubscribeLinkResponseNonNullableFields as GenerateUnsubscribeLinkResponseNonNullableFields, type index_d_GetEmailSubscriptionRequest as GetEmailSubscriptionRequest, type index_d_GetEmailSubscriptionResponse as GetEmailSubscriptionResponse, type index_d_HeadersEntry as HeadersEntry, type index_d_IdentificationData as IdentificationData, type index_d_IdentificationDataIdOneOf as IdentificationDataIdOneOf, type index_d_MessageEnvelope as MessageEnvelope, type index_d_Metadata as Metadata, type index_d_Paging as Paging, type index_d_PagingMetadata as PagingMetadata, type index_d_QueryEmailSubscriptionsOptions as QueryEmailSubscriptionsOptions, type index_d_QueryEmailSubscriptionsRequest as QueryEmailSubscriptionsRequest, type index_d_QueryEmailSubscriptionsResponse as QueryEmailSubscriptionsResponse, type index_d_QueryEmailSubscriptionsResponseNonNullableFields as QueryEmailSubscriptionsResponseNonNullableFields, type index_d_RawHttpResponse as RawHttpResponse, type index_d_RenderUnsubscribePageRequest as RenderUnsubscribePageRequest, type index_d_RestoreInfo as RestoreInfo, index_d_Status as Status, index_d_SubscriptionEnumStatus as SubscriptionEnumStatus, type index_d_UpdateEmailSubscriptionRequest as UpdateEmailSubscriptionRequest, type index_d_UpdateEmailSubscriptionResponse as UpdateEmailSubscriptionResponse, type index_d_UpsertEmailSubscriptionOptions as UpsertEmailSubscriptionOptions, type index_d_UpsertEmailSubscriptionRequest as UpsertEmailSubscriptionRequest, type index_d_UpsertEmailSubscriptionResponse as UpsertEmailSubscriptionResponse, type index_d_UpsertEmailSubscriptionResponseNonNullableFields as UpsertEmailSubscriptionResponseNonNullableFields, type index_d_V1ConfirmUnsubscribeActionRequest as V1ConfirmUnsubscribeActionRequest, type index_d_V1RenderUnsubscribePageRequest as V1RenderUnsubscribePageRequest, index_d_WebhookIdentityType as WebhookIdentityType, type index_d__publicOnEmailsubscriptionEmailSubscriptionChangedType as _publicOnEmailsubscriptionEmailSubscriptionChangedType, index_d_bulkUpsertEmailSubscription as bulkUpsertEmailSubscription, index_d_generateUnsubscribeLink as generateUnsubscribeLink, index_d_onEmailsubscriptionEmailSubscriptionChanged as onEmailsubscriptionEmailSubscriptionChanged, onEmailsubscriptionEmailSubscriptionChanged$1 as publicOnEmailsubscriptionEmailSubscriptionChanged, index_d_queryEmailSubscriptions as queryEmailSubscriptions, index_d_upsertEmailSubscription as upsertEmailSubscription };
-}
-
-export { index_d as emailSubscriptions };