import { NonNullablePaths } from '@wix/sdk-types'; /** * An account can be active or in some state of suspension (warned/suspended/banned). * If a user is in a state of suspension they must visit their email marketing account in the dashboard and follow the instructions. */ interface AccountDetails { /** Account status. */ status?: EnumWithLiterals; /** Current premium package information. */ package?: Package; /** Quota period and usage. */ quotaPeriod?: QuotaPeriod; /** Max number of recipients for an email marketing campaign. Exceeding this limit may lead to campaigns being rejected. */ maxCampaignAudienceSize?: number; } declare enum Enum { /** Able to use email marketing normally. */ ACTIVE = "ACTIVE", /** Must explicitly agree to terms of use to activate the account. */ WARNED = "WARNED", /** Must fill out compliance questionnaire, unable to use email marketing. */ SUSPENDED = "SUSPENDED", /** Must fill out compliance questionnaire, unable to use email marketing. */ BANNED = "BANNED", /** Must fill out compliance questionnaire to activate the account. */ SUSPENDED_AUTOLIFT = "SUSPENDED_AUTOLIFT" } /** @enumType */ type EnumWithLiterals = Enum | 'ACTIVE' | 'WARNED' | 'SUSPENDED' | 'BANNED' | 'SUSPENDED_AUTOLIFT'; interface Package { /** Package ID. */ _id?: string; /** Package group. */ group?: string; /** Allocated quota per month. */ monthlyQuotaAllocation?: Quota; } interface Quota { /** Number of allocated marketing campaigns per month (-1 means unlimited). */ campaigns?: number; /** Number of allocated individual emails per month. */ emails?: number; } declare enum BillingCycle { UNKNOWN = "UNKNOWN", TWO_YEARS = "TWO_YEARS", YEARLY = "YEARLY", MONTHLY = "MONTHLY" } /** @enumType */ type BillingCycleWithLiterals = BillingCycle | 'UNKNOWN' | 'TWO_YEARS' | 'YEARLY' | 'MONTHLY'; interface QuotaPeriod { /** Current quota period start date. */ dateFrom?: Date | null; /** Current quota period end date - after which quota will roll over. */ dateTo?: Date | null; /** Information about allocated quota already used in this period. */ quotaUsage?: Quota; } interface Features { multipleSenderDetails?: boolean; removeWixBranding?: boolean; scheduling?: boolean; } declare enum Rank { /** No reputation has been established (new site or didn't have enough traffic in the recent time period). */ NEW = "NEW", /** Has traffic and it's quality is good. */ GOOD = "GOOD", /** Has traffic but it's quality is bad. */ BAD = "BAD" } /** @enumType */ type RankWithLiterals = Rank | 'NEW' | 'GOOD' | 'BAD'; interface GetAccountDetailsRequest { } interface GetAccountDetailsResponse { /** Current account details. */ accountDetails?: AccountDetails; } interface GetComplianceDetailsRequest { } interface GetComplianceDetailsResponse { /** Current compliance details. */ complianceDetails?: ComplianceDetails; } interface ComplianceDetails extends ComplianceDetailsProductOptionsOneOf { emailMarketingOptions?: EmailMarketingOptions; automationOptions?: AutomationOptions; /** Account status. */ status?: EnumWithLiterals; /** * Suspension reasons. * @maxSize 10 * @maxLength 100 */ suspensionReasons?: string[]; /** * Support ticket id. * @format GUID */ supportTicketId?: string | null; /** product */ product?: ProductWithLiterals; /** * reasons for the restriction action * @maxSize 10 */ restrictionReasons?: RestrictionReason[]; } /** @oneof */ interface ComplianceDetailsProductOptionsOneOf { emailMarketingOptions?: EmailMarketingOptions; automationOptions?: AutomationOptions; } declare enum Product { UNSPECIFIED = "UNSPECIFIED", EMAIL_MARKETING = "EMAIL_MARKETING", AUTOMATION = "AUTOMATION" } /** @enumType */ type ProductWithLiterals = Product | 'UNSPECIFIED' | 'EMAIL_MARKETING' | 'AUTOMATION'; interface EmailMarketingOptions { /** @format GUID */ campaignId?: string | null; } interface AutomationOptions { /** @format GUID */ automationId?: string | null; /** @format GUID */ campaignId?: string | null; } interface RestrictionReason extends RestrictionReasonTypeOneOf { content?: ContentWithLiterals; senderReputation?: SenderReputationWithLiterals; statistics?: StatisticsWithLiterals; value?: string | null; } /** @oneof */ interface RestrictionReasonTypeOneOf { content?: ContentWithLiterals; senderReputation?: SenderReputationWithLiterals; statistics?: StatisticsWithLiterals; } declare enum Content { TEXT = "TEXT", LINK = "LINK", IMAGE = "IMAGE", EMAIL_SUBJECT = "EMAIL_SUBJECT", SENDER_NAME = "SENDER_NAME", SENDER_EMAIL = "SENDER_EMAIL" } /** @enumType */ type ContentWithLiterals = Content | 'TEXT' | 'LINK' | 'IMAGE' | 'EMAIL_SUBJECT' | 'SENDER_NAME' | 'SENDER_EMAIL'; declare enum SenderReputation { DOMAIN_BLOCKLISTED = "DOMAIN_BLOCKLISTED", SENDER_EMAIL_PATTERN = "SENDER_EMAIL_PATTERN", SENDER_EMAIL_DISPOSABLE = "SENDER_EMAIL_DISPOSABLE", SENDER_EMAIL_UNDELIVERABLE = "SENDER_EMAIL_UNDELIVERABLE", DNS_RECORDS_INCOMPLETE = "DNS_RECORDS_INCOMPLETE", OTHER = "OTHER" } /** @enumType */ type SenderReputationWithLiterals = SenderReputation | 'DOMAIN_BLOCKLISTED' | 'SENDER_EMAIL_PATTERN' | 'SENDER_EMAIL_DISPOSABLE' | 'SENDER_EMAIL_UNDELIVERABLE' | 'DNS_RECORDS_INCOMPLETE' | 'OTHER'; declare enum Statistics { SPAM_COMPLAINTS = "SPAM_COMPLAINTS", BOUNCES = "BOUNCES", LOW_ENGAGEMENT = "LOW_ENGAGEMENT", SPAM_TRAPS = "SPAM_TRAPS" } /** @enumType */ type StatisticsWithLiterals = Statistics | 'SPAM_COMPLAINTS' | 'BOUNCES' | 'LOW_ENGAGEMENT' | 'SPAM_TRAPS'; interface RespondRequest { action?: ActionWithLiterals; supportTicketData?: SupportTicketData; } declare enum Action { AGREE_TO_TERMS = "AGREE_TO_TERMS", OPEN_TICKET = "OPEN_TICKET", FILL_FORM = "FILL_FORM", ANSWER_QUESTIONS = "ANSWER_QUESTIONS", FILL_AUTOLIFT_FORM = "FILL_AUTOLIFT_FORM", FILL_SHORT_FORM = "FILL_SHORT_FORM", FILL_SHORT_AUTOLIFT_FORM = "FILL_SHORT_AUTOLIFT_FORM" } /** @enumType */ type ActionWithLiterals = Action | 'AGREE_TO_TERMS' | 'OPEN_TICKET' | 'FILL_FORM' | 'ANSWER_QUESTIONS' | 'FILL_AUTOLIFT_FORM' | 'FILL_SHORT_FORM' | 'FILL_SHORT_AUTOLIFT_FORM'; interface SupportTicketData { /** @maxLength 200 */ subject?: string; /** @maxLength 20000 */ body?: string; /** @maxLength 20000 */ agentReplyBody?: string | null; } interface RespondResponse { /** * ID of the support ticket created (optional). * @format GUID */ supportTicketId?: string | null; } /** * Retrieves email marketing account details. * @public * @permissionId Shoutout.Manage * @applicableIdentity APP * @fqn wix.emailmarketing.api.v1.AccountDetailsService.Get */ declare function getAccountDetails(): Promise>; export { type AccountDetails, Action, type ActionWithLiterals, type AutomationOptions, BillingCycle, type BillingCycleWithLiterals, type ComplianceDetails, type ComplianceDetailsProductOptionsOneOf, Content, type ContentWithLiterals, type EmailMarketingOptions, Enum, type EnumWithLiterals, type Features, type GetAccountDetailsRequest, type GetAccountDetailsResponse, type GetComplianceDetailsRequest, type GetComplianceDetailsResponse, type Package, Product, type ProductWithLiterals, type Quota, type QuotaPeriod, Rank, type RankWithLiterals, type RespondRequest, type RespondResponse, type RestrictionReason, type RestrictionReasonTypeOneOf, SenderReputation, type SenderReputationWithLiterals, Statistics, type StatisticsWithLiterals, type SupportTicketData, getAccountDetails };