@wix/domains 1.0.0

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

@@ -0,0 +1,1041 @@
+/**
+ * A registered domain is a domain that Wix has registered on behalf of a customer
+ * with an external registar.
+ */
+interface RegisteredDomain extends RegisteredDomainStatusInfoOneOf {
+    /**
+     * Information about a domain that hasn't been successfully registered
+     * yet. Includes the timestamp of the latest registration attempt.
+     * @readonly
+     */
+    pendingRegistrationInfo?: PendingRegistrationInfo;
+    /**
+     * Information about a domain that couldn't be registered. Includes
+     * failure code and message.
+     * @readonly
+     */
+    failedRegistrationInfo?: FailedRegistrationInfo;
+    /**
+     * Domain ID. Identical to `domain`.
+     * @readonly
+     */
+    _id?: string;
+    /**
+     * Name of the domain including TLD.
+     * Subdomains aren't supported. You can only register a root domain.
+     * Domain name and TLD must be separated by a dot. For example,
+     * `my-new-domain.com`. Only alphanumeric characters, hyphens, and dots are
+     * supported.
+     *
+     * Min: 3 characters
+     * Max: 63 characters
+     */
+    domain?: string;
+    /**
+     * ID of the product instance from the
+     * [Resellers API](https://dev.wix.com/docs/rest/api-reference/account-level-apis/resellers/packages-and-product-instances/packages-object)
+     * that belongs to the `registeredDomain` object.
+     * Your account must own a product that supports the chosen TLD, regardless of
+     * whether you want to assign the domain to a site or keep it floating. If
+     * you want to assign the domain to a site, the relevant site must also
+     * own a Premium plan. Contact the [Wix B2B team](mailto:bizdev@wix.com)
+     * for more information about how to become a reseller and a list of available
+     * product IDs.
+     */
+    productInstanceId?: string;
+    /**
+     * Date and time the `registeredDomain` object was created in
+     * `YYYY-MM-DDThh:mm:ss.sssZ` format.
+     * @readonly
+     */
+    _createdDate?: Date;
+    /**
+     * Date and time the `registeredDomain` object was last updated in
+     * `YYYY-MM-DDThh:mm:ss.sssZ` format.
+     * @readonly
+     */
+    _updatedDate?: Date;
+    /**
+     * Revision number, which increments by 1 each time the registered domain
+     * is updated. To prevent conflicting changes, the current revision must be
+     * passed when updating the registered domain.
+     *
+     * Ignored when creating a registered domain.
+     */
+    revision?: string | null;
+    /**
+     * Information about the Wix site the domain is connected to and whether the
+     * domain is assigned as the primary domain or a redirect.
+     */
+    siteInfo?: SiteInfo;
+    /**
+     * Contact details for the registrant, admin, and tech support of the registered domain.
+     * You can read more about which
+     * [Contact Field Validations](https://https://dev.wix.com/api/rest/account-level-apis/registered-domains/contact-field-validations)
+     * are implemented.
+     */
+    contacts?: Contacts;
+    /**
+     * Status of the registered domain.
+     *
+     * + `"UNKNOWN_STATUS"`: There's no information about the status of the registered domain.
+     * + `"PENDING_REGISTRATION"`: Wix has started the domain registration process, but the domain hasn't been successfully registered yet.
+     * + `"ACTIVE"`: The domain has been registered successfully and is active.
+     * + `"FAILED_REGISTRATION"`: Wix has tried to register the domain, but has stopped the process due to too many failed attempts. Contact the [Wix B2B team](mailto:bizdev@wix.com) for more information.
+     * + `"CANCELED"`: The domain has been canceled and isn't active any longer.
+     * @readonly
+     */
+    status?: Status;
+    /**
+     * ICANN confirmation status.
+     *
+     * + `"UNKNOWN_ICANN_CONFIRMATION_STATUS"`: There's no information about the status of the ICANN confirmation process.
+     * + `"PENDING"`: Wix has started the ICANN confirmation process, but not all contacts have confirmed the domain yet.
+     * + `"CONFIRMED_BY_ALL"`: The domain has been successfully confirmed by all contacts.
+     * + `"EXPIRED"`: The domain hasn't been confirmed by all contacts before the ICANN confirmation process expired. The domain isn't active and a new confirmation process must be started. Contact the [Wix B2B team](mailto:bizdev@wix.com) for more information.
+     * @readonly
+     */
+    icannConfirmationStatus?: ICANNConfirmationStatus;
+    /**
+     * Details about the ICANN confirmation status.
+     * @readonly
+     */
+    icannConfirmationStatusInfo?: ICANNConfirmationStatusInfo;
+    /**
+     * DNS propagation status.
+     *
+     * + `"UNKNOWN_DNS_PROPAGATION_STATUS"`: There's no information about the domain's DNS propagation status.
+     * + `"IN_PROGRESS"`: The domain's DNS propagation process has started but hasn't successfully completed yet.
+     * + `"COMPLETED"`: The domain's DNS propagation process has successfully finished.
+     * + `"FAILED"`: The domain's DNS propagation process has failed.
+     * @readonly
+     */
+    dnsPropagationStatus?: DnsPropagationStatus;
+    /**
+     * Expiration date of the registered domain in `YYYY-MM-DDThh:mm:ss.sssZ`
+     * format.
+     * @readonly
+     */
+    expirationDate?: Date;
+}
+/** @oneof */
+interface RegisteredDomainStatusInfoOneOf {
+    /**
+     * Information about a domain that hasn't been successfully registered
+     * yet. Includes the timestamp of the latest registration attempt.
+     * @readonly
+     */
+    pendingRegistrationInfo?: PendingRegistrationInfo;
+    /**
+     * Information about a domain that couldn't be registered. Includes
+     * failure code and message.
+     * @readonly
+     */
+    failedRegistrationInfo?: FailedRegistrationInfo;
+}
+interface SiteInfo extends SiteInfoAssignmentInfoOneOf {
+    /**
+     * Extra details if `{"assignmentType": `"REDIRECT"}`.
+     * @readonly
+     */
+    redirectInfo?: RedirectAssignmentInfo;
+    /**
+     * ID of the site to which the domain is assigned.
+     * @readonly
+     */
+    _id?: string | null;
+    /**
+     * Whether the domain is assigned as the primary domain or a redirect.
+     * Read more about [primary and redirected domains](https://support.wix.com/en/article/switching-your-primary-and-redirected-domains).
+     * __Note:__ When you connect a domain or subdomain, you can't pass `"UNKNOWN_ASSIGNMENT_TYPE"`
+     * in the request of the Create Registered Domain call.
+     *
+     * + `"UNKNOWN_ASSIGNMENT_TYPE"`: There's no information about the assignment type.
+     * + `"PRIMARY"`: The domain is assigned as the primary domain to the Wix site.
+     * + `"REDIRECT"`: The domain is assigned as a redirect to the Wix site.
+     */
+    assignmentType?: AssignmentType;
+}
+/** @oneof */
+interface SiteInfoAssignmentInfoOneOf {
+    /**
+     * Extra details if `{"assignmentType": `"REDIRECT"}`.
+     * @readonly
+     */
+    redirectInfo?: RedirectAssignmentInfo;
+}
+declare enum AssignmentType {
+    UNKNOWN_ASSIGNMENT_TYPE = "UNKNOWN_ASSIGNMENT_TYPE",
+    PRIMARY = "PRIMARY",
+    REDIRECT = "REDIRECT"
+}
+interface RedirectAssignmentInfo {
+    /**
+     * Primary domain the redirect points to.
+     * @readonly
+     */
+    primaryDomain?: string;
+}
+interface Contacts {
+    /** Contact information for the domain registrant. */
+    registrant?: ContactData;
+    /** Contact information for the domain admin. */
+    admin?: ContactData;
+    /** Contact information for the tech support of the domain. */
+    tech?: ContactData;
+}
+interface ContactData {
+    /**
+     * First name. Only
+     * [alphanumerical characters](https://en.wikipedia.org/wiki/Alphanumericals)
+     * are supported.
+     *
+     * Min: 2 characters
+     * Max: 64 characters
+     */
+    firstName?: string;
+    /**
+     * Last name. Only
+     * [alphanumerical characters](https://en.wikipedia.org/wiki/Alphanumericals)
+     * are supported.
+     *
+     * Min: 2 characters
+     * Max: 64 characters
+     */
+    lastName?: string;
+    /**
+     * Email address.  Only
+     * [alphanumerical characters](https://en.wikipedia.org/wiki/Alphanumericals)
+     * and a single `@` are supported. Wix doesn't validate that the email address
+     * exists.
+     *
+     * Min: 3 characters
+     * Max: 64 characters before the `@` and 63 after
+     */
+    email?: string;
+    /**
+     * Address details, including street name and house number. Only
+     * [alphanumerical characters](https://en.wikipedia.org/wiki/Alphanumericals)
+     * are supported.
+     *
+     * Min: 2 characters
+     * Max: 64 characters
+     */
+    address?: string;
+    /**
+     * City. Only
+     * [alphanumerical characters](https://en.wikipedia.org/wiki/Alphanumericals)
+     * are supported.
+     *
+     * Min: 2 characters
+     * Max: 64 characters
+     */
+    city?: string;
+    /**
+     * Subdivision code in
+     * [ISO-3166 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements)
+     * format. Only
+     * [alphanumerical characters](https://en.wikipedia.org/wiki/Alphanumericals)
+     * are supported.
+     * __Required__ for these countries:
+     * `”AE"`, `"AR"`, `"AT"`, `"AU"`, `"BE"`, `"BR"`, `"CA"`, `"CH"`, `"CL"`,
+     * `"CO"`, `"CR"`, `"CZ"`, `"DE"`, `"DK"`, `"ES"`, `"FI"`, `"FR"`, `"GR"`,
+     * `"IE"`, `"IN"`, `"IT"`, `"JP"`, `"KR"`, `"MX"`, `"MY"`, `"NL"`, `"NO"`,
+     * `"NZ"`, `"PE"`, `"PL"`, `"PT"`, `"RU"`, `"SE"`, `"SG"`, `"TH"`, `"TR"`,
+     * `"TW"`, `"UA"`, `"US"`, `”ZA”`.
+     *
+     * Min: 2 characters
+     * Max: 2 characters
+     */
+    subdivisionCode?: string | null;
+    /**
+     * Postal code. Only
+     * [alphanumerical characters](https://en.wikipedia.org/wiki/Alphanumericals)
+     * are supported.
+     *
+     * Min: 2 characters
+     * Max: 16 characters
+     */
+    postalCode?: string | null;
+    /**
+     * Country code in
+     * [ISO-3166 alpha-1](https://en.wikipedia.org/wiki/ISO_3166-2#Subdivisions_included_in_ISO_3166-1)
+     * format. Only
+     * [alphanumerical characters](https://en.wikipedia.org/wiki/Alphanumericals)
+     * are supported. Wix doesn't validate that the postal code is valid for the
+     * given country.
+     *
+     * Min: 2 characters
+     * Max: 2 characters
+     */
+    countryCode?: string;
+    /**
+     * Phone number. Only
+     * [alphanumerical characters](https://en.wikipedia.org/wiki/Alphanumericals)
+     * are supported. For example, `+15551234567`. Wix doesn't validate that the
+     * phone number belongs to the specified country.
+     *
+     * Min: 2 characters
+     * Max: 20 characters
+     */
+    phone?: string;
+    /**
+     * Company name. Only
+     * [alphanumerical characters](https://en.wikipedia.org/wiki/Alphanumericals)
+     * are supported.
+     *
+     * Max: 2 characters
+     * Max: 64 characters
+     */
+    company?: string | null;
+}
+declare enum Status {
+    UNKNOWN_STATUS = "UNKNOWN_STATUS",
+    PENDING_REGISTRATION = "PENDING_REGISTRATION",
+    ACTIVE = "ACTIVE",
+    FAILED_REGISTRATION = "FAILED_REGISTRATION",
+    CANCELED = "CANCELED"
+}
+interface PendingRegistrationInfo {
+    /**
+     * Information about the latest attempt to register
+     * the domain. Wix tries to register the domain several times if the
+     * first attempt is unsuccessful. You can contact the
+     * [Wix B2B team](mailto:bizdev@wix.com)
+     * for more information about the number of attempts and their timing.
+     * @readonly
+     */
+    latestAttempt?: LatestAttempt;
+}
+interface LatestAttempt {
+    /**
+     * Number of the latest attempt to register the domain.
+     * @readonly
+     */
+    number?: number;
+    /**
+     * Date and time of the latest domain registration attempt in
+     * `YYYY-MM-DDThh:mm:ss.sssZ` format.
+     * @readonly
+     */
+    timestamp?: Date;
+}
+interface FailedRegistrationInfo {
+    /**
+     * Failure code.
+     *
+     * + `"UNKNOWN_FAILURE_CODE"`: There's no information about the failure code.
+     * + `"OTHER"`: There was a failure, but none of the listed failure codes applies.
+     * @readonly
+     */
+    code?: FailureCode;
+    /**
+     * Failure message.
+     * @readonly
+     */
+    message?: string;
+}
+declare enum FailureCode {
+    UNKNOWN_FAILURE_CODE = "UNKNOWN_FAILURE_CODE",
+    OTHER = "OTHER"
+}
+/**
+ * he confirmation status types, a record:
+ * starts at pending
+ * ends either at confirmed_by_all or expired
+ */
+declare enum ICANNConfirmationStatus {
+    UNKNOWN_ICANN_CONFIRMATION_STATUS = "UNKNOWN_ICANN_CONFIRMATION_STATUS",
+    PENDING = "PENDING",
+    CONFIRMED_BY_ALL = "CONFIRMED_BY_ALL",
+    EXPIRED = "EXPIRED"
+}
+interface ICANNConfirmationStatusInfo extends ICANNConfirmationStatusInfoStatusOneOf {
+    /** Details about domains with `"PENDING"` ICANN confirmation status. */
+    pending?: Pending;
+    /** Details about domains with `"EXPIRED"` ICANN confirmation status. */
+    expired?: Expired;
+}
+/** @oneof */
+interface ICANNConfirmationStatusInfoStatusOneOf {
+    /** Details about domains with `"PENDING"` ICANN confirmation status. */
+    pending?: Pending;
+    /** Details about domains with `"EXPIRED"` ICANN confirmation status. */
+    expired?: Expired;
+}
+interface Pending {
+    /**
+     * Expiration date of the ICANN confirmation process in
+     * `YYYY-MM-DDThh:mm:ss.sssZ` format. All contacts must confirm the domain
+     * before this date or the domain won't be active.
+     */
+    expirationDate?: Date;
+    /**
+     * Email addresses of the contacts who haven't confirmed the domain with ICANN
+     * yet.
+     */
+    notConfirmedBy?: string[];
+}
+interface Expired {
+    /**
+     * Email addresses of the contacts who haven't confirmed the domain with ICANN
+     * in time.
+     */
+    notConfirmedBy?: string[];
+}
+declare enum DnsPropagationStatus {
+    UNKNOWN_DNS_PROPAGATION_STATUS = "UNKNOWN_DNS_PROPAGATION_STATUS",
+    COMPLETED = "COMPLETED",
+    FAILED = "FAILED",
+    IN_PROGRESS = "IN_PROGRESS"
+}
+interface CreateRegisteredDomainRequest {
+    /** Information about the domain to register including contact details. */
+    registeredDomain: RegisteredDomain;
+}
+interface CreateRegisteredDomainResponse {
+    /** Created registered domain. */
+    registeredDomain?: RegisteredDomain;
+}
+interface GetRegisteredDomainRequest {
+    /** ID of the registered domain to retrieve. */
+    registeredDomainId: string;
+}
+interface GetRegisteredDomainResponse {
+    /** Retrieved registered domain. */
+    registeredDomain?: RegisteredDomain;
+}
+interface ListRegisteredDomainsRequest {
+    /** Cursor paging options. */
+    paging?: CursorPaging;
+}
+interface CursorPaging {
+    /**
+     * Number of domains to load.
+     *
+     * Min: `0`
+     * Max: `100`
+     */
+    limit?: number | null;
+    /**
+     * Pointer to the next or previous page in the list of results.
+     *
+     * You can get the relevant cursor token
+     * from the `pagingMetadata` object in the previous call's response.
+     * Not relevant for the first request.
+     */
+    cursor?: string | null;
+}
+interface ListRegisteredDomainsResponse {
+    /** Metadata about the returned list of registered domains. */
+    pagingMetadata?: CursorPagingMetadata;
+    /** Retrieved registered domains. */
+    registeredDomains?: RegisteredDomain[];
+}
+interface CursorPagingMetadata {
+    /** Number of domains returned in the response. */
+    count?: number | null;
+    /** Offset that was requested. */
+    cursors?: Cursors;
+    /**
+     * Indicates if there are more results after the current page.
+     * If `true`, another page of results can be retrieved.
+     * If `false`, this is the last page.
+     */
+    hasNext?: boolean | null;
+}
+interface Cursors {
+    /** Cursor pointing to next page in the list of results. */
+    next?: string | null;
+    /** Cursor pointing to previous page in the list of results. */
+    prev?: string | null;
+}
+interface DeleteRegisteredDomainByIdRequest {
+    /** ID of the registered domain to delete. */
+    registeredDomainId?: string;
+}
+interface DeleteRegisteredDomainByIdResponse {
+}
+interface RedeemRegisteredDomainRequest {
+    /**
+     * ID of the registered domain to redeem. Identical to the domain name
+     * including TLD.
+     */
+    registeredDomainId: string;
+}
+interface RedeemRegisteredDomainResponse {
+    /** Registered domain to redeem. */
+    registeredDomain?: RegisteredDomain;
+}
+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 CreateRegisteredDomainResponseNonNullableFields {
+    registeredDomain?: {
+        pendingRegistrationInfo?: {
+            latestAttempt?: {
+                number: number;
+            };
+        };
+        failedRegistrationInfo?: {
+            code: FailureCode;
+            message: string;
+        };
+        _id: string;
+        domain: string;
+        productInstanceId: string;
+        siteInfo?: {
+            redirectInfo?: {
+                primaryDomain: string;
+            };
+            assignmentType: AssignmentType;
+        };
+        contacts?: {
+            registrant?: {
+                firstName: string;
+                lastName: string;
+                email: string;
+                address: string;
+                city: string;
+                countryCode: string;
+                phone: string;
+            };
+            admin?: {
+                firstName: string;
+                lastName: string;
+                email: string;
+                address: string;
+                city: string;
+                countryCode: string;
+                phone: string;
+            };
+            tech?: {
+                firstName: string;
+                lastName: string;
+                email: string;
+                address: string;
+                city: string;
+                countryCode: string;
+                phone: string;
+            };
+        };
+        status: Status;
+        icannConfirmationStatus: ICANNConfirmationStatus;
+        icannConfirmationStatusInfo?: {
+            pending?: {
+                notConfirmedBy: string[];
+            };
+            expired?: {
+                notConfirmedBy: string[];
+            };
+        };
+        dnsPropagationStatus: DnsPropagationStatus;
+    };
+}
+interface GetRegisteredDomainResponseNonNullableFields {
+    registeredDomain?: {
+        pendingRegistrationInfo?: {
+            latestAttempt?: {
+                number: number;
+            };
+        };
+        failedRegistrationInfo?: {
+            code: FailureCode;
+            message: string;
+        };
+        _id: string;
+        domain: string;
+        productInstanceId: string;
+        siteInfo?: {
+            redirectInfo?: {
+                primaryDomain: string;
+            };
+            assignmentType: AssignmentType;
+        };
+        contacts?: {
+            registrant?: {
+                firstName: string;
+                lastName: string;
+                email: string;
+                address: string;
+                city: string;
+                countryCode: string;
+                phone: string;
+            };
+            admin?: {
+                firstName: string;
+                lastName: string;
+                email: string;
+                address: string;
+                city: string;
+                countryCode: string;
+                phone: string;
+            };
+            tech?: {
+                firstName: string;
+                lastName: string;
+                email: string;
+                address: string;
+                city: string;
+                countryCode: string;
+                phone: string;
+            };
+        };
+        status: Status;
+        icannConfirmationStatus: ICANNConfirmationStatus;
+        icannConfirmationStatusInfo?: {
+            pending?: {
+                notConfirmedBy: string[];
+            };
+            expired?: {
+                notConfirmedBy: string[];
+            };
+        };
+        dnsPropagationStatus: DnsPropagationStatus;
+    };
+}
+interface ListRegisteredDomainsResponseNonNullableFields {
+    registeredDomains: {
+        pendingRegistrationInfo?: {
+            latestAttempt?: {
+                number: number;
+            };
+        };
+        failedRegistrationInfo?: {
+            code: FailureCode;
+            message: string;
+        };
+        _id: string;
+        domain: string;
+        productInstanceId: string;
+        siteInfo?: {
+            redirectInfo?: {
+                primaryDomain: string;
+            };
+            assignmentType: AssignmentType;
+        };
+        contacts?: {
+            registrant?: {
+                firstName: string;
+                lastName: string;
+                email: string;
+                address: string;
+                city: string;
+                countryCode: string;
+                phone: string;
+            };
+            admin?: {
+                firstName: string;
+                lastName: string;
+                email: string;
+                address: string;
+                city: string;
+                countryCode: string;
+                phone: string;
+            };
+            tech?: {
+                firstName: string;
+                lastName: string;
+                email: string;
+                address: string;
+                city: string;
+                countryCode: string;
+                phone: string;
+            };
+        };
+        status: Status;
+        icannConfirmationStatus: ICANNConfirmationStatus;
+        icannConfirmationStatusInfo?: {
+            pending?: {
+                notConfirmedBy: string[];
+            };
+            expired?: {
+                notConfirmedBy: string[];
+            };
+        };
+        dnsPropagationStatus: DnsPropagationStatus;
+    }[];
+}
+interface RedeemRegisteredDomainResponseNonNullableFields {
+    registeredDomain?: {
+        pendingRegistrationInfo?: {
+            latestAttempt?: {
+                number: number;
+            };
+        };
+        failedRegistrationInfo?: {
+            code: FailureCode;
+            message: string;
+        };
+        _id: string;
+        domain: string;
+        productInstanceId: string;
+        siteInfo?: {
+            redirectInfo?: {
+                primaryDomain: string;
+            };
+            assignmentType: AssignmentType;
+        };
+        contacts?: {
+            registrant?: {
+                firstName: string;
+                lastName: string;
+                email: string;
+                address: string;
+                city: string;
+                countryCode: string;
+                phone: string;
+            };
+            admin?: {
+                firstName: string;
+                lastName: string;
+                email: string;
+                address: string;
+                city: string;
+                countryCode: string;
+                phone: string;
+            };
+            tech?: {
+                firstName: string;
+                lastName: string;
+                email: string;
+                address: string;
+                city: string;
+                countryCode: string;
+                phone: string;
+            };
+        };
+        status: Status;
+        icannConfirmationStatus: ICANNConfirmationStatus;
+        icannConfirmationStatusInfo?: {
+            pending?: {
+                notConfirmedBy: string[];
+            };
+            expired?: {
+                notConfirmedBy: string[];
+            };
+        };
+        dnsPropagationStatus: DnsPropagationStatus;
+    };
+}
+interface ListRegisteredDomainsOptions {
+    /** Cursor paging options. */
+    paging?: CursorPaging;
+}
+
+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;
+};
+
+declare const __metadata: {
+    PACKAGE_NAME: string;
+};
+declare function createRegisteredDomain(httpClient: HttpClient): (registeredDomain: RegisteredDomain) => Promise<RegisteredDomain & {
+    pendingRegistrationInfo?: {
+        latestAttempt?: {
+            number: number;
+        } | undefined;
+    } | undefined;
+    failedRegistrationInfo?: {
+        code: FailureCode;
+        message: string;
+    } | undefined;
+    _id: string;
+    domain: string;
+    productInstanceId: string;
+    siteInfo?: {
+        redirectInfo?: {
+            primaryDomain: string;
+        } | undefined;
+        assignmentType: AssignmentType;
+    } | undefined;
+    contacts?: {
+        registrant?: {
+            firstName: string;
+            lastName: string;
+            email: string;
+            address: string;
+            city: string;
+            countryCode: string;
+            phone: string;
+        } | undefined;
+        admin?: {
+            firstName: string;
+            lastName: string;
+            email: string;
+            address: string;
+            city: string;
+            countryCode: string;
+            phone: string;
+        } | undefined;
+        tech?: {
+            firstName: string;
+            lastName: string;
+            email: string;
+            address: string;
+            city: string;
+            countryCode: string;
+            phone: string;
+        } | undefined;
+    } | undefined;
+    status: Status;
+    icannConfirmationStatus: ICANNConfirmationStatus;
+    icannConfirmationStatusInfo?: {
+        pending?: {
+            notConfirmedBy: string[];
+        } | undefined;
+        expired?: {
+            notConfirmedBy: string[];
+        } | undefined;
+    } | undefined;
+    dnsPropagationStatus: DnsPropagationStatus;
+}>;
+declare function getRegisteredDomain(httpClient: HttpClient): (registeredDomainId: string) => Promise<RegisteredDomain & {
+    pendingRegistrationInfo?: {
+        latestAttempt?: {
+            number: number;
+        } | undefined;
+    } | undefined;
+    failedRegistrationInfo?: {
+        code: FailureCode;
+        message: string;
+    } | undefined;
+    _id: string;
+    domain: string;
+    productInstanceId: string;
+    siteInfo?: {
+        redirectInfo?: {
+            primaryDomain: string;
+        } | undefined;
+        assignmentType: AssignmentType;
+    } | undefined;
+    contacts?: {
+        registrant?: {
+            firstName: string;
+            lastName: string;
+            email: string;
+            address: string;
+            city: string;
+            countryCode: string;
+            phone: string;
+        } | undefined;
+        admin?: {
+            firstName: string;
+            lastName: string;
+            email: string;
+            address: string;
+            city: string;
+            countryCode: string;
+            phone: string;
+        } | undefined;
+        tech?: {
+            firstName: string;
+            lastName: string;
+            email: string;
+            address: string;
+            city: string;
+            countryCode: string;
+            phone: string;
+        } | undefined;
+    } | undefined;
+    status: Status;
+    icannConfirmationStatus: ICANNConfirmationStatus;
+    icannConfirmationStatusInfo?: {
+        pending?: {
+            notConfirmedBy: string[];
+        } | undefined;
+        expired?: {
+            notConfirmedBy: string[];
+        } | undefined;
+    } | undefined;
+    dnsPropagationStatus: DnsPropagationStatus;
+}>;
+declare function listRegisteredDomains(httpClient: HttpClient): (options?: ListRegisteredDomainsOptions) => Promise<ListRegisteredDomainsResponse & ListRegisteredDomainsResponseNonNullableFields>;
+declare function redeemRegisteredDomain(httpClient: HttpClient): (registeredDomainId: string) => Promise<RedeemRegisteredDomainResponse & RedeemRegisteredDomainResponseNonNullableFields>;
+
+type index_d_ActionEvent = ActionEvent;
+type index_d_AssignmentType = AssignmentType;
+declare const index_d_AssignmentType: typeof AssignmentType;
+type index_d_ContactData = ContactData;
+type index_d_Contacts = Contacts;
+type index_d_CreateRegisteredDomainRequest = CreateRegisteredDomainRequest;
+type index_d_CreateRegisteredDomainResponse = CreateRegisteredDomainResponse;
+type index_d_CreateRegisteredDomainResponseNonNullableFields = CreateRegisteredDomainResponseNonNullableFields;
+type index_d_CursorPaging = CursorPaging;
+type index_d_CursorPagingMetadata = CursorPagingMetadata;
+type index_d_Cursors = Cursors;
+type index_d_DeleteRegisteredDomainByIdRequest = DeleteRegisteredDomainByIdRequest;
+type index_d_DeleteRegisteredDomainByIdResponse = DeleteRegisteredDomainByIdResponse;
+type index_d_DnsPropagationStatus = DnsPropagationStatus;
+declare const index_d_DnsPropagationStatus: typeof DnsPropagationStatus;
+type index_d_DomainEvent = DomainEvent;
+type index_d_DomainEventBodyOneOf = DomainEventBodyOneOf;
+type index_d_EntityCreatedEvent = EntityCreatedEvent;
+type index_d_EntityDeletedEvent = EntityDeletedEvent;
+type index_d_EntityUpdatedEvent = EntityUpdatedEvent;
+type index_d_Expired = Expired;
+type index_d_FailedRegistrationInfo = FailedRegistrationInfo;
+type index_d_FailureCode = FailureCode;
+declare const index_d_FailureCode: typeof FailureCode;
+type index_d_GetRegisteredDomainRequest = GetRegisteredDomainRequest;
+type index_d_GetRegisteredDomainResponse = GetRegisteredDomainResponse;
+type index_d_GetRegisteredDomainResponseNonNullableFields = GetRegisteredDomainResponseNonNullableFields;
+type index_d_ICANNConfirmationStatus = ICANNConfirmationStatus;
+declare const index_d_ICANNConfirmationStatus: typeof ICANNConfirmationStatus;
+type index_d_ICANNConfirmationStatusInfo = ICANNConfirmationStatusInfo;
+type index_d_ICANNConfirmationStatusInfoStatusOneOf = ICANNConfirmationStatusInfoStatusOneOf;
+type index_d_IdentificationData = IdentificationData;
+type index_d_IdentificationDataIdOneOf = IdentificationDataIdOneOf;
+type index_d_LatestAttempt = LatestAttempt;
+type index_d_ListRegisteredDomainsOptions = ListRegisteredDomainsOptions;
+type index_d_ListRegisteredDomainsRequest = ListRegisteredDomainsRequest;
+type index_d_ListRegisteredDomainsResponse = ListRegisteredDomainsResponse;
+type index_d_ListRegisteredDomainsResponseNonNullableFields = ListRegisteredDomainsResponseNonNullableFields;
+type index_d_MessageEnvelope = MessageEnvelope;
+type index_d_Pending = Pending;
+type index_d_PendingRegistrationInfo = PendingRegistrationInfo;
+type index_d_RedeemRegisteredDomainRequest = RedeemRegisteredDomainRequest;
+type index_d_RedeemRegisteredDomainResponse = RedeemRegisteredDomainResponse;
+type index_d_RedeemRegisteredDomainResponseNonNullableFields = RedeemRegisteredDomainResponseNonNullableFields;
+type index_d_RedirectAssignmentInfo = RedirectAssignmentInfo;
+type index_d_RegisteredDomain = RegisteredDomain;
+type index_d_RegisteredDomainStatusInfoOneOf = RegisteredDomainStatusInfoOneOf;
+type index_d_SiteInfo = SiteInfo;
+type index_d_SiteInfoAssignmentInfoOneOf = SiteInfoAssignmentInfoOneOf;
+type index_d_Status = Status;
+declare const index_d_Status: typeof Status;
+type index_d_WebhookIdentityType = WebhookIdentityType;
+declare const index_d_WebhookIdentityType: typeof WebhookIdentityType;
+declare const index_d___metadata: typeof __metadata;
+declare const index_d_createRegisteredDomain: typeof createRegisteredDomain;
+declare const index_d_getRegisteredDomain: typeof getRegisteredDomain;
+declare const index_d_listRegisteredDomains: typeof listRegisteredDomains;
+declare const index_d_redeemRegisteredDomain: typeof redeemRegisteredDomain;
+declare namespace index_d {
+  export { type index_d_ActionEvent as ActionEvent, index_d_AssignmentType as AssignmentType, type index_d_ContactData as ContactData, type index_d_Contacts as Contacts, type index_d_CreateRegisteredDomainRequest as CreateRegisteredDomainRequest, type index_d_CreateRegisteredDomainResponse as CreateRegisteredDomainResponse, type index_d_CreateRegisteredDomainResponseNonNullableFields as CreateRegisteredDomainResponseNonNullableFields, type index_d_CursorPaging as CursorPaging, type index_d_CursorPagingMetadata as CursorPagingMetadata, type index_d_Cursors as Cursors, type index_d_DeleteRegisteredDomainByIdRequest as DeleteRegisteredDomainByIdRequest, type index_d_DeleteRegisteredDomainByIdResponse as DeleteRegisteredDomainByIdResponse, index_d_DnsPropagationStatus as DnsPropagationStatus, type index_d_DomainEvent as DomainEvent, type index_d_DomainEventBodyOneOf as DomainEventBodyOneOf, type index_d_EntityCreatedEvent as EntityCreatedEvent, type index_d_EntityDeletedEvent as EntityDeletedEvent, type index_d_EntityUpdatedEvent as EntityUpdatedEvent, type index_d_Expired as Expired, type index_d_FailedRegistrationInfo as FailedRegistrationInfo, index_d_FailureCode as FailureCode, type index_d_GetRegisteredDomainRequest as GetRegisteredDomainRequest, type index_d_GetRegisteredDomainResponse as GetRegisteredDomainResponse, type index_d_GetRegisteredDomainResponseNonNullableFields as GetRegisteredDomainResponseNonNullableFields, index_d_ICANNConfirmationStatus as ICANNConfirmationStatus, type index_d_ICANNConfirmationStatusInfo as ICANNConfirmationStatusInfo, type index_d_ICANNConfirmationStatusInfoStatusOneOf as ICANNConfirmationStatusInfoStatusOneOf, type index_d_IdentificationData as IdentificationData, type index_d_IdentificationDataIdOneOf as IdentificationDataIdOneOf, type index_d_LatestAttempt as LatestAttempt, type index_d_ListRegisteredDomainsOptions as ListRegisteredDomainsOptions, type index_d_ListRegisteredDomainsRequest as ListRegisteredDomainsRequest, type index_d_ListRegisteredDomainsResponse as ListRegisteredDomainsResponse, type index_d_ListRegisteredDomainsResponseNonNullableFields as ListRegisteredDomainsResponseNonNullableFields, type index_d_MessageEnvelope as MessageEnvelope, type index_d_Pending as Pending, type index_d_PendingRegistrationInfo as PendingRegistrationInfo, type index_d_RedeemRegisteredDomainRequest as RedeemRegisteredDomainRequest, type index_d_RedeemRegisteredDomainResponse as RedeemRegisteredDomainResponse, type index_d_RedeemRegisteredDomainResponseNonNullableFields as RedeemRegisteredDomainResponseNonNullableFields, type index_d_RedirectAssignmentInfo as RedirectAssignmentInfo, type index_d_RegisteredDomain as RegisteredDomain, type index_d_RegisteredDomainStatusInfoOneOf as RegisteredDomainStatusInfoOneOf, type index_d_SiteInfo as SiteInfo, type index_d_SiteInfoAssignmentInfoOneOf as SiteInfoAssignmentInfoOneOf, index_d_Status as Status, index_d_WebhookIdentityType as WebhookIdentityType, index_d___metadata as __metadata, index_d_createRegisteredDomain as createRegisteredDomain, index_d_getRegisteredDomain as getRegisteredDomain, index_d_listRegisteredDomains as listRegisteredDomains, index_d_redeemRegisteredDomain as redeemRegisteredDomain };
+}
+
+export { index_d as registeredDomains };