/** DNS zones hold information about the records that map a domain's URL to an IP address. */ export interface DnsZone { /** Domain name including the TLD. Both root domains and subdomains are supported. */ domainName?: string; /** * DNS records. You can only set up a single `record` object per DNS record * type. If you want to specify multiple values for the same record type, you * must save them in the `values` for the relevant type. * * Min: 2 DNS record - a DNS zone file has to have at least two required DNS records: NS and SOA records * Max: 5000 DNS records */ records?: DnsRecord[]; /** * ID of the Dns Zone. Identical to the domain name including TLD. * @readonly */ id?: string; /** * Whether [DNS Security Extensions (DNSSEC)](https://en.wikipedia.org/wiki/Domain_Name_System_Security_Extensions) * are enabled. * * Default: `false` */ dnssecEnabled?: boolean; /** * Information about [DNSSEC](https://en.wikipedia.org/wiki/Domain_Name_System_Security_Extensions). * Available only if `{"dnssecEnabled": true}`. * @readonly */ dnssecInfo?: DnssecInfo; } export interface DnsRecord { /** [DNS record type](https://en.wikipedia.org/wiki/List_of_DNS_record_types). */ type?: RecordType; /** * Host name. Can be a subdomain. For example, `domain.com` or * `mail.domain.com`. Equal to the domain name, except for `CNAME` records. */ hostName?: string; /** [Time to live](https://en.wikipedia.org/wiki/Time_to_live) in seconds. */ ttl?: number; /** * DNS record values. Wix limits DNS records to 50 values per type. External * providers may support a different maximum number of DNS records for a * specific type, Wix doesn't validate that you don't exceed these external * limits. * * Max: 50 records */ values?: string[]; } export declare enum RecordType { /** Default value. Used in case the record type isn't known. You can't set a record type to `UNKNOWN`. */ UNKNOWN = "UNKNOWN", /** Address record. Most fundamental type of DNS record that indicates the IP address of a given domain. */ A = "A", /** Address record in [IPv6 format](https://en.wikipedia.org/wiki/IPv6). */ AAAA = "AAAA", /** Name server record. Describes which server contains the actual DNS record. */ NS = "NS", /** [Start of authority record](https://en.wikipedia.org/wiki/SOA_record). Holds administrative information about the zone. */ SOA = "SOA", /** [CNAME record](https://en.wikipedia.org/wiki/CNAME_record). Maps an alias name to the canonical domain name. */ CNAME = "CNAME", /** MX record. Directs emails to mail servers. */ MX = "MX", /** [TXT record](https://en.wikipedia.org/wiki/TXT_record). Used by domain admins to add human-readable descriptions. */ TXT = "TXT", /** SPF record. Used for email authentication. */ SPF = "SPF", /** [Service record](https://en.wikipedia.org/wiki/SRV_record). Defines the server location. */ SRV = "SRV", /** Pointer record. Specifies which host is supported for a given IP address. */ PTR = "PTR", /** [Name Authority Pointer record](https://en.wikipedia.org/wiki/NAPTR_record). Used by Internet telephony applications. */ NAPTR = "NAPTR" } export interface DnssecInfo { /** * Unique 16-bit identifier for a [DNSKEY](https://cloud.google.com/dns/docs/reference/rest/v1/dnsKeys) * record that allows efficient DNSSEC validation in zones with multiple keys. */ keyTag?: number; /** * Cryptographic hash of the [DNSKEY](https://cloud.google.com/dns/docs/reference/rest/v1/dnsKeys) * record that's included in the delegation signer (DS) record and ensures secure * DNSSEC validation. */ digest?: string; } export interface DnsRecordsChangedEvent { domainName?: string; changeTime?: Date | null; } export interface DomainRemovedEvent { /** * Domain name including TLD. * Both root domains and subdomains are supported. */ domain?: string; } export interface CreateDnsZoneRequest { /** DNS zone to create. */ dnsZone: DnsZone; } export interface CreateDnsZoneResponse { /** Created DNS zone. */ dnsZone?: DnsZone; } export interface GetDnsZoneRequest { /** Domain to retrieve the DNS zone for. */ domainName: string; } export interface GetDnsZoneResponse { /** Retrieved DNS zone. */ dnsZone?: DnsZone; } export interface UpdateDnsZoneRequest { /** Domain to update the DNS zone for. Must include the TLD. */ domainName: string; /** * DNS records to add to the DNS zone. * * Max: 10 additions */ additions?: DnsRecord[]; /** * DNS records to remove from the DNS zone. * * Max: 10 deletions */ deletions?: DnsRecord[]; /** Whether you want to enable or disable [DNS Security Extensions (DNSSEC)](https://en.wikipedia.org/wiki/Domain_Name_System_Security_Extensions). */ dnssecEnabled?: boolean | null; } export interface UpdateDnsZoneResponse { /** Updated DNS zone. */ dnsZone?: DnsZone; } export interface DeleteDnsZoneRequest { /** Domain name to delete the DNS zone for. */ domainName: string; } export interface DeleteDnsZoneResponse { } export interface PreviewDnsZoneRequest { /** Domain name to generate a DNS zone preview for. */ domainName: string; } export interface PreviewDnsZoneResponse { /** * DNS zone preview. * * Includes calculated `A`, `CNAME`, `NS` and `SOA` records. */ dnsZone?: DnsZone; } export 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 */ export interface DomainEventBodyOneOf { createdEvent?: EntityCreatedEvent; updatedEvent?: EntityUpdatedEvent; deletedEvent?: EntityDeletedEvent; actionEvent?: ActionEvent; } export interface EntityCreatedEvent { entityAsJson?: string; /** Indicates the event was triggered by a restore-from-trashbin operation for a previously deleted entity */ restoreInfo?: RestoreInfo; } export interface RestoreInfo { deletedDate?: Date | null; } export 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. */ currentEntityAsJson?: string; } export interface EntityDeletedEvent { /** Entity that was deleted */ deletedEntityAsJson?: string | null; } export interface ActionEvent { bodyAsJson?: string; } export interface MessageEnvelope { /** App instance ID. */ instanceId?: string | null; /** Event type. */ eventType?: string; /** The identification type and identity data. */ identity?: IdentificationData; /** Stringify payload. */ data?: string; } export 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 */ export 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; } export declare enum WebhookIdentityType { UNKNOWN = "UNKNOWN", ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR", MEMBER = "MEMBER", WIX_USER = "WIX_USER", APP = "APP" } interface DnsRecordNonNullableFields { type: RecordType; hostName: string; ttl: number; values: string[]; } interface DnssecInfoNonNullableFields { keyTag: number; digest: string; } interface DnsZoneNonNullableFields { domainName: string; records: DnsRecordNonNullableFields[]; id: string; dnssecEnabled: boolean; dnssecInfo?: DnssecInfoNonNullableFields; } export interface CreateDnsZoneResponseNonNullableFields { dnsZone?: DnsZoneNonNullableFields; } export interface GetDnsZoneResponseNonNullableFields { dnsZone?: DnsZoneNonNullableFields; } export interface UpdateDnsZoneResponseNonNullableFields { dnsZone?: DnsZoneNonNullableFields; } export interface PreviewDnsZoneResponseNonNullableFields { dnsZone?: DnsZoneNonNullableFields; } export {};