@wix/email-subscriptions 1.0.13 → 1.0.16

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

@@ -0,0 +1,479 @@
+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.
+     *
+     * - `NOT_SET`: No status specified. This is the default, initial value before any info about the email address is known.
+     * - `PENDING`: Subscription confirmation was requested,
+     * but recipient hasn't confirmed yet.
+     * - `SUBSCRIBED`: Recipient has opted in to marketing emails.
+     * - `UNSUBSCRIBED`: Recipient has opted out of marketing emails.
+     *
+     * Defaults to `NOT_SET`.
+     */
+    subscriptionStatus?: SubscriptionEnumStatus;
+    /**
+     * Indicates last reported status of sent emails.
+     *
+     * - `NOT_SET`: No status specified. This is the default, initial value before any info about the email address is known.
+     * - `VALID`: Emails to this email address are being delivered successfully.
+     * - `BOUNCED`: The last email to the recipient bounced or was rejected.
+     * - `SPAM_COMPLAINT`: The recipient registered a spam complaint
+     * with their email provider.
+     * - `INACTIVE`: 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.
+     *
+     * Defaults to `NOT_SET`.
+     */
+    deliverabilityStatus?: Status;
+    /**
+     * Date and time the email subscription was created.
+     * @readonly
+     */
+    _createdDate?: Date;
+    /**
+     * Date and time the email subscription was last updated.
+     * @readonly
+     */
+    _updatedDate?: Date;
+}
+declare enum SubscriptionEnumStatus {
+    UNKNOWN = "UNKNOWN",
+    /** No Subscription exists */
+    NOT_SET = "NOT_SET",
+    /** Pending Subscription */
+    PENDING = "PENDING",
+    /** Subscribed */
+    SUBSCRIBED = "SUBSCRIBED",
+    /** UnSubscribed */
+    UNSUBSCRIBED = "UNSUBSCRIBED"
+}
+declare enum Status {
+    NOT_SET = "NOT_SET",
+    /** valid/deferral */
+    VALID = "VALID",
+    /** bounced/rejected/invalid */
+    BOUNCED = "BOUNCED",
+    /** spam/complaint */
+    SPAM_COMPLAINT = "SPAM_COMPLAINT",
+    /** valid, but no activity reported */
+    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. */
+    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 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 QueryEmailSubscriptionsResponseNonNullableFields {
+    subscriptions: {
+        email: string;
+        subscriptionStatus: SubscriptionEnumStatus;
+        deliverabilityStatus: Status;
+    }[];
+}
+interface UpsertEmailSubscriptionResponseNonNullableFields {
+    subscription?: {
+        email: string;
+        subscriptionStatus: SubscriptionEnumStatus;
+        deliverabilityStatus: Status;
+    };
+}
+interface BulkUpsertEmailSubscriptionResponseNonNullableFields {
+    results: {
+        originalIndex: number;
+        emailSubscription?: {
+            email: string;
+            subscriptionStatus: SubscriptionEnumStatus;
+            deliverabilityStatus: Status;
+        };
+        error?: {
+            errorCode: string;
+            message: string;
+        };
+    }[];
+    metadata?: {
+        totalSuccess: number;
+        totalFailure: number;
+    };
+}
+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;
+}
+
+interface HttpClient {
+    request<TResponse, TData = any>(req: RequestOptionsFactory<TResponse, TData>): Promise<HttpResponse<TResponse>>;
+}
+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 EventDefinition<Payload = unknown, Type extends string = string> = {
+    __type: 'event-definition';
+    type: Type;
+    isDomainEvent?: boolean;
+    transformations?: unknown;
+    __payload: Payload;
+};
+declare function EventDefinition<Type extends string>(type: Type, isDomainEvent?: boolean, _transformations?: unknown): <Payload = unknown>() => EventDefinition<Payload, Type>;
+
+declare const __metadata: {
+    PACKAGE_NAME: string;
+};
+declare function queryEmailSubscriptions(httpClient: HttpClient): (filter: Record<string, any> | null, options?: QueryEmailSubscriptionsOptions) => Promise<QueryEmailSubscriptionsResponse & QueryEmailSubscriptionsResponseNonNullableFields>;
+declare function upsertEmailSubscription(httpClient: HttpClient): (options?: UpsertEmailSubscriptionOptions) => Promise<UpsertEmailSubscriptionResponse & UpsertEmailSubscriptionResponseNonNullableFields>;
+declare function bulkUpsertEmailSubscription(httpClient: HttpClient): (subscriptions: EmailSubscription[]) => Promise<BulkUpsertEmailSubscriptionResponse & BulkUpsertEmailSubscriptionResponseNonNullableFields>;
+declare function generateUnsubscribeLink(httpClient: HttpClient): (emailAddress: string, options?: GenerateUnsubscribeLinkOptions) => Promise<GenerateUnsubscribeLinkResponse & GenerateUnsubscribeLinkResponseNonNullableFields>;
+declare const onEmailsubscriptionEmailSubscriptionChanged: EventDefinition<EmailsubscriptionEmailSubscriptionChangedEnvelope, "com.wixpress.emailsubscriptions.v1.EmailSubscriptionChanged">;
+
+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_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;
+declare const index_d___metadata: typeof __metadata;
+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, 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, index_d___metadata as __metadata, index_d_bulkUpsertEmailSubscription as bulkUpsertEmailSubscription, index_d_generateUnsubscribeLink as generateUnsubscribeLink, index_d_onEmailsubscriptionEmailSubscriptionChanged as onEmailsubscriptionEmailSubscriptionChanged, index_d_queryEmailSubscriptions as queryEmailSubscriptions, index_d_upsertEmailSubscription as upsertEmailSubscription };
+}
+
+export { index_d as emailSubscriptions };