@wix/email-subscriptions 1.0.22 → 1.0.24

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

@@ -1,401 +0,0 @@
-interface EmailSubscription$1 {
-    /**
-     * 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$1;
-    /**
-     * 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$1;
-    /**
-     * 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$1 {
-    UNKNOWN = "UNKNOWN",
-    /** No Subscription exists */
-    NOT_SET = "NOT_SET",
-    /** Pending Subscription */
-    PENDING = "PENDING",
-    /** Subscribed */
-    SUBSCRIBED = "SUBSCRIBED",
-    /** UnSubscribed */
-    UNSUBSCRIBED = "UNSUBSCRIBED"
-}
-declare enum Status$1 {
-    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 QueryEmailSubscriptionsRequest$1 {
-    /**
-     * 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$1;
-}
-interface Paging$1 {
-    /** Number of items to load. */
-    limit?: number | null;
-    /** Number of items to skip in the current sort order. */
-    offset?: number | null;
-}
-interface QueryEmailSubscriptionsResponse$1 {
-    /** List of subscribed emails that matched the query options. */
-    subscriptions?: EmailSubscription$1[];
-    /** Metadata for the paginated results. */
-    metadata?: PagingMetadata$1;
-}
-interface PagingMetadata$1 {
-    /** Number of items returned in the response. */
-    count?: number | null;
-    /** Offset that was requested. */
-    offset?: number | null;
-    /** Total number of items that match the query. */
-    total?: number | null;
-    /** Flag that indicates the server failed to calculate the `total` field. */
-    tooManyToCount?: boolean | null;
-}
-interface UpsertEmailSubscriptionRequest$1 {
-    /** Email subscription to update or create. */
-    subscription?: EmailSubscription$1;
-}
-interface UpsertEmailSubscriptionResponse$1 {
-    /** Updated or created email subscription. */
-    subscription?: EmailSubscription$1;
-}
-interface BulkUpsertEmailSubscriptionRequest$1 {
-    /** List of email subscriptions to update or create. */
-    subscriptions: EmailSubscription$1[];
-}
-interface BulkUpsertEmailSubscriptionResponse$1 {
-    /** List of updated or created email subscriptions. */
-    results?: BulkUpsertEmailSubscriptionResult$1[];
-    /** Numbers of successful and failed actions. */
-    metadata?: Metadata$1;
-}
-interface BulkUpsertEmailSubscriptionResult$1 {
-    /** Position of the requested email subscription in the bulk array. */
-    originalIndex?: number;
-    /** New or updated email subscription. */
-    emailSubscription?: EmailSubscription$1;
-    /**
-     * Error information if the action failed.
-     * Omitted from successful actions.
-     */
-    error?: Error$1;
-}
-interface Error$1 {
-    /** Error code. */
-    errorCode?: string;
-    /** Message that contains details about the error. */
-    message?: string;
-}
-interface Metadata$1 {
-    /** Number of successful actions. */
-    totalSuccess?: number;
-    /** Number of failed actions. */
-    totalFailure?: number;
-}
-interface GenerateUnsubscribeLinkRequest$1 {
-    /** 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$1 {
-    /** The unsubscribe link. */
-    link?: string;
-}
-interface EmailSubscriptionNonNullableFields$1 {
-    email: string;
-    subscriptionStatus: SubscriptionEnumStatus$1;
-    deliverabilityStatus: Status$1;
-}
-interface QueryEmailSubscriptionsResponseNonNullableFields$1 {
-    subscriptions: EmailSubscriptionNonNullableFields$1[];
-}
-interface UpsertEmailSubscriptionResponseNonNullableFields$1 {
-    subscription?: EmailSubscriptionNonNullableFields$1;
-}
-interface ErrorNonNullableFields$1 {
-    errorCode: string;
-    message: string;
-}
-interface BulkUpsertEmailSubscriptionResultNonNullableFields$1 {
-    originalIndex: number;
-    emailSubscription?: EmailSubscriptionNonNullableFields$1;
-    error?: ErrorNonNullableFields$1;
-}
-interface MetadataNonNullableFields$1 {
-    totalSuccess: number;
-    totalFailure: number;
-}
-interface BulkUpsertEmailSubscriptionResponseNonNullableFields$1 {
-    results: BulkUpsertEmailSubscriptionResultNonNullableFields$1[];
-    metadata?: MetadataNonNullableFields$1;
-}
-interface GenerateUnsubscribeLinkResponseNonNullableFields$1 {
-    link: string;
-}
-
-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 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 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;
-}
-
-type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
-    getUrl: (context: any) => string;
-    httpMethod: K;
-    path: string;
-    pathParams: M;
-    __requestType: T;
-    __originalRequestType: S;
-    __responseType: Q;
-    __originalResponseType: R;
-};
-declare function queryEmailSubscriptions(): __PublicMethodMetaInfo<'POST', {}, QueryEmailSubscriptionsRequest, QueryEmailSubscriptionsRequest$1, QueryEmailSubscriptionsResponse & QueryEmailSubscriptionsResponseNonNullableFields, QueryEmailSubscriptionsResponse$1 & QueryEmailSubscriptionsResponseNonNullableFields$1>;
-declare function upsertEmailSubscription(): __PublicMethodMetaInfo<'POST', {}, UpsertEmailSubscriptionRequest, UpsertEmailSubscriptionRequest$1, UpsertEmailSubscriptionResponse & UpsertEmailSubscriptionResponseNonNullableFields, UpsertEmailSubscriptionResponse$1 & UpsertEmailSubscriptionResponseNonNullableFields$1>;
-declare function bulkUpsertEmailSubscription(): __PublicMethodMetaInfo<'POST', {}, BulkUpsertEmailSubscriptionRequest, BulkUpsertEmailSubscriptionRequest$1, BulkUpsertEmailSubscriptionResponse & BulkUpsertEmailSubscriptionResponseNonNullableFields, BulkUpsertEmailSubscriptionResponse$1 & BulkUpsertEmailSubscriptionResponseNonNullableFields$1>;
-declare function generateUnsubscribeLink(): __PublicMethodMetaInfo<'POST', {}, GenerateUnsubscribeLinkRequest, GenerateUnsubscribeLinkRequest$1, GenerateUnsubscribeLinkResponse & GenerateUnsubscribeLinkResponseNonNullableFields, GenerateUnsubscribeLinkResponse$1 & GenerateUnsubscribeLinkResponseNonNullableFields$1>;
-
-type meta___PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = __PublicMethodMetaInfo<K, M, T, S, Q, R>;
-declare const meta_bulkUpsertEmailSubscription: typeof bulkUpsertEmailSubscription;
-declare const meta_generateUnsubscribeLink: typeof generateUnsubscribeLink;
-declare const meta_queryEmailSubscriptions: typeof queryEmailSubscriptions;
-declare const meta_upsertEmailSubscription: typeof upsertEmailSubscription;
-declare namespace meta {
-  export { type meta___PublicMethodMetaInfo as __PublicMethodMetaInfo, meta_bulkUpsertEmailSubscription as bulkUpsertEmailSubscription, meta_generateUnsubscribeLink as generateUnsubscribeLink, meta_queryEmailSubscriptions as queryEmailSubscriptions, meta_upsertEmailSubscription as upsertEmailSubscription };
-}
-
-export { meta as emailSubscriptions };