@wix/domains 1.0.18 → 1.0.19

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

@@ -20,7 +20,7 @@ interface ConnectedDomain {
      */
     connectionType?: ConnectionType$1;
     /**
-     * Information about the site to which the domain is assigned to and whether
+     * Information about the site to which the domain is assigned, and whether
      * it's the primary domain or a redirect.
      */
     siteInfo?: SiteInfo$1;
@@ -56,20 +56,20 @@ declare enum ConnectionType$1 {
 }
 interface SiteInfo$1 extends SiteInfoAssignmentInfoOneOf$1 {
     /**
-     * Extra details in case assignment type is redirect.
+     * Redirect information, relevant when `assignmentType` = `REDIRECT`.
      * @readonly
      */
     redirectInfo?: RedirectAssignmentInfo$1;
     /**
-     * ID of the site the domain is assigned to, will be taken from context.
+     * ID of the site to which the domain is assigned.
      * @readonly
      */
     _id?: string | null;
     /**
-     * The assignment type the relationship will be based on:
-     * + `"UNKNOWN_ASSIGNMENT_TYPE"`: There is no information about the domain assignment type
-     * + `"PRIMARY"`: There can only be one primary domain per site, the result of this assignment type is that the domain will lead directly to a site.
-     * + `"REDIRECT"`: There can be multiple redirect domains. the result of this assignment type is that the redirects will lead to the primary domain
+     * The relationship assigned for this domain to the site:
+     * + `"UNKNOWN_ASSIGNMENT_TYPE"`: There is no information about the domain assignment type.
+     * + `"PRIMARY"`: The singular primary domain for a site. When this type is assigned, this domain will lead directly to the site.
+     * + `"REDIRECT"`: A redirect domain for a site. Each site can have multiple redirect domains. When this type is assigned, this domain will redirect to the primary domain.
      * Read more about [primary and redirected domains](https://support.wix.com/en/article/switching-your-primary-and-redirected-domains).
      */
     assignmentType?: AssignmentType$1;
@@ -77,7 +77,7 @@ interface SiteInfo$1 extends SiteInfoAssignmentInfoOneOf$1 {
 /** @oneof */
 interface SiteInfoAssignmentInfoOneOf$1 {
     /**
-     * Extra details in case assignment type is redirect.
+     * Redirect information, relevant when `assignmentType` = `REDIRECT`.
      * @readonly
      */
     redirectInfo?: RedirectAssignmentInfo$1;
@@ -89,7 +89,7 @@ declare enum AssignmentType$1 {
 }
 interface RedirectAssignmentInfo$1 {
     /**
-     * Primary domain the redirect points to.
+     * Primary domain to which this domain will redirect.
      * @readonly
      */
     primaryDomain?: string;
@@ -329,56 +329,6 @@ interface ListConnectedDomainsResponseNonNullableFields {
         dnsPropagationStatus: DnsPropagationStatus$1;
     }[];
 }
-interface BaseEventMetadata {
-    /** App instance ID. */
-    instanceId?: string | null;
-    /** Event type. */
-    eventType?: string;
-    /** The identification type and identity data. */
-    identity?: IdentificationData$2;
-}
-interface EventMetadata extends BaseEventMetadata {
-    /**
-     * 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;
-}
-interface ConnectedDomainRemovedEnvelope {
-    data: DomainRemovedEvent$1;
-    metadata: EventMetadata;
-}
 interface ListConnectedDomainsOptions {
     /** Cursor paging options. */
     paging?: CursorPaging$2;
@@ -408,14 +358,6 @@ type APIMetadata = {
     entityFqdn?: string;
     packageName?: string;
 };
-type EventDefinition<Payload = unknown, Type extends string = string> = {
-    __type: 'event-definition';
-    type: Type;
-    isDomainEvent?: boolean;
-    transformations?: (envelope: unknown) => Payload;
-    __payload: Payload;
-};
-declare function EventDefinition<Type extends string>(type: Type, isDomainEvent?: boolean, transformations?: (envelope: any) => unknown): <Payload = unknown>() => EventDefinition<Payload, Type>;
 
 declare global {
 	// eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
@@ -455,17 +397,13 @@ declare function getConnectedDomain(httpClient: HttpClient): (connectedDomainId:
 }>;
 declare function deleteConnectedDomain(httpClient: HttpClient): (connectedDomainId: string) => Promise<void>;
 declare function listConnectedDomains(httpClient: HttpClient): (options?: ListConnectedDomainsOptions) => Promise<ListConnectedDomainsResponse & ListConnectedDomainsResponseNonNullableFields>;
-declare const onConnectedDomainRemoved: EventDefinition<ConnectedDomainRemovedEnvelope, "wix.premium.domains.v1.connected_domain_removed">;
 
-type index_d$5_BaseEventMetadata = BaseEventMetadata;
 type index_d$5_ConnectedDomain = ConnectedDomain;
-type index_d$5_ConnectedDomainRemovedEnvelope = ConnectedDomainRemovedEnvelope;
 type index_d$5_CreateConnectedDomainRequest = CreateConnectedDomainRequest;
 type index_d$5_CreateConnectedDomainResponse = CreateConnectedDomainResponse;
 type index_d$5_CreateConnectedDomainResponseNonNullableFields = CreateConnectedDomainResponseNonNullableFields;
 type index_d$5_DeleteConnectedDomainRequest = DeleteConnectedDomainRequest;
 type index_d$5_DeleteConnectedDomainResponse = DeleteConnectedDomainResponse;
-type index_d$5_EventMetadata = EventMetadata;
 type index_d$5_GetConnectedDomainRequest = GetConnectedDomainRequest;
 type index_d$5_GetConnectedDomainResponse = GetConnectedDomainResponse;
 type index_d$5_GetConnectedDomainResponseNonNullableFields = GetConnectedDomainResponseNonNullableFields;
@@ -477,9 +415,8 @@ declare const index_d$5_createConnectedDomain: typeof createConnectedDomain;
 declare const index_d$5_deleteConnectedDomain: typeof deleteConnectedDomain;
 declare const index_d$5_getConnectedDomain: typeof getConnectedDomain;
 declare const index_d$5_listConnectedDomains: typeof listConnectedDomains;
-declare const index_d$5_onConnectedDomainRemoved: typeof onConnectedDomainRemoved;
 declare namespace index_d$5 {
-  export { type ActionEvent$2 as ActionEvent, AssignmentType$1 as AssignmentType, type index_d$5_BaseEventMetadata as BaseEventMetadata, type index_d$5_ConnectedDomain as ConnectedDomain, type index_d$5_ConnectedDomainRemovedEnvelope as ConnectedDomainRemovedEnvelope, ConnectionType$1 as ConnectionType, type index_d$5_CreateConnectedDomainRequest as CreateConnectedDomainRequest, type index_d$5_CreateConnectedDomainResponse as CreateConnectedDomainResponse, type index_d$5_CreateConnectedDomainResponseNonNullableFields as CreateConnectedDomainResponseNonNullableFields, type CursorPaging$2 as CursorPaging, type CursorPagingMetadata$2 as CursorPagingMetadata, type Cursors$2 as Cursors, type index_d$5_DeleteConnectedDomainRequest as DeleteConnectedDomainRequest, type index_d$5_DeleteConnectedDomainResponse as DeleteConnectedDomainResponse, DnsPropagationStatus$1 as DnsPropagationStatus, type DomainEvent$2 as DomainEvent, type DomainEventBodyOneOf$2 as DomainEventBodyOneOf, type DomainRemovedEvent$1 as DomainRemovedEvent, type EntityCreatedEvent$2 as EntityCreatedEvent, type EntityDeletedEvent$2 as EntityDeletedEvent, type EntityUpdatedEvent$2 as EntityUpdatedEvent, type index_d$5_EventMetadata as EventMetadata, type index_d$5_GetConnectedDomainRequest as GetConnectedDomainRequest, type index_d$5_GetConnectedDomainResponse as GetConnectedDomainResponse, type index_d$5_GetConnectedDomainResponseNonNullableFields as GetConnectedDomainResponseNonNullableFields, type IdentificationData$2 as IdentificationData, type IdentificationDataIdOneOf$2 as IdentificationDataIdOneOf, type index_d$5_ListConnectedDomainsOptions as ListConnectedDomainsOptions, type index_d$5_ListConnectedDomainsRequest as ListConnectedDomainsRequest, type index_d$5_ListConnectedDomainsResponse as ListConnectedDomainsResponse, type index_d$5_ListConnectedDomainsResponseNonNullableFields as ListConnectedDomainsResponseNonNullableFields, type MessageEnvelope$2 as MessageEnvelope, type RedirectAssignmentInfo$1 as RedirectAssignmentInfo, type RestoreInfo$1 as RestoreInfo, type SiteInfo$1 as SiteInfo, type SiteInfoAssignmentInfoOneOf$1 as SiteInfoAssignmentInfoOneOf, WebhookIdentityType$2 as WebhookIdentityType, __metadata$5 as __metadata, index_d$5_createConnectedDomain as createConnectedDomain, index_d$5_deleteConnectedDomain as deleteConnectedDomain, index_d$5_getConnectedDomain as getConnectedDomain, index_d$5_listConnectedDomains as listConnectedDomains, index_d$5_onConnectedDomainRemoved as onConnectedDomainRemoved };
+  export { type ActionEvent$2 as ActionEvent, AssignmentType$1 as AssignmentType, type index_d$5_ConnectedDomain as ConnectedDomain, ConnectionType$1 as ConnectionType, type index_d$5_CreateConnectedDomainRequest as CreateConnectedDomainRequest, type index_d$5_CreateConnectedDomainResponse as CreateConnectedDomainResponse, type index_d$5_CreateConnectedDomainResponseNonNullableFields as CreateConnectedDomainResponseNonNullableFields, type CursorPaging$2 as CursorPaging, type CursorPagingMetadata$2 as CursorPagingMetadata, type Cursors$2 as Cursors, type index_d$5_DeleteConnectedDomainRequest as DeleteConnectedDomainRequest, type index_d$5_DeleteConnectedDomainResponse as DeleteConnectedDomainResponse, DnsPropagationStatus$1 as DnsPropagationStatus, type DomainEvent$2 as DomainEvent, type DomainEventBodyOneOf$2 as DomainEventBodyOneOf, type DomainRemovedEvent$1 as DomainRemovedEvent, type EntityCreatedEvent$2 as EntityCreatedEvent, type EntityDeletedEvent$2 as EntityDeletedEvent, type EntityUpdatedEvent$2 as EntityUpdatedEvent, type index_d$5_GetConnectedDomainRequest as GetConnectedDomainRequest, type index_d$5_GetConnectedDomainResponse as GetConnectedDomainResponse, type index_d$5_GetConnectedDomainResponseNonNullableFields as GetConnectedDomainResponseNonNullableFields, type IdentificationData$2 as IdentificationData, type IdentificationDataIdOneOf$2 as IdentificationDataIdOneOf, type index_d$5_ListConnectedDomainsOptions as ListConnectedDomainsOptions, type index_d$5_ListConnectedDomainsRequest as ListConnectedDomainsRequest, type index_d$5_ListConnectedDomainsResponse as ListConnectedDomainsResponse, type index_d$5_ListConnectedDomainsResponseNonNullableFields as ListConnectedDomainsResponseNonNullableFields, type MessageEnvelope$2 as MessageEnvelope, type RedirectAssignmentInfo$1 as RedirectAssignmentInfo, type RestoreInfo$1 as RestoreInfo, type SiteInfo$1 as SiteInfo, type SiteInfoAssignmentInfoOneOf$1 as SiteInfoAssignmentInfoOneOf, WebhookIdentityType$2 as WebhookIdentityType, __metadata$5 as __metadata, index_d$5_createConnectedDomain as createConnectedDomain, index_d$5_deleteConnectedDomain as deleteConnectedDomain, index_d$5_getConnectedDomain as getConnectedDomain, index_d$5_listConnectedDomains as listConnectedDomains };
 }
 
 /**

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

@@ -20,7 +20,7 @@ interface ConnectedDomain$1 {
      */
     connectionType?: ConnectionType$1;
     /**
-     * Information about the site to which the domain is assigned to and whether
+     * Information about the site to which the domain is assigned, and whether
      * it's the primary domain or a redirect.
      */
     siteInfo?: SiteInfo$3;
@@ -56,20 +56,20 @@ declare enum ConnectionType$1 {
 }
 interface SiteInfo$3 extends SiteInfoAssignmentInfoOneOf$3 {
     /**
-     * Extra details in case assignment type is redirect.
+     * Redirect information, relevant when `assignmentType` = `REDIRECT`.
      * @readonly
      */
     redirectInfo?: RedirectAssignmentInfo$3;
     /**
-     * ID of the site the domain is assigned to, will be taken from context.
+     * ID of the site to which the domain is assigned.
      * @readonly
      */
     id?: string | null;
     /**
-     * The assignment type the relationship will be based on:
-     * + `"UNKNOWN_ASSIGNMENT_TYPE"`: There is no information about the domain assignment type
-     * + `"PRIMARY"`: There can only be one primary domain per site, the result of this assignment type is that the domain will lead directly to a site.
-     * + `"REDIRECT"`: There can be multiple redirect domains. the result of this assignment type is that the redirects will lead to the primary domain
+     * The relationship assigned for this domain to the site:
+     * + `"UNKNOWN_ASSIGNMENT_TYPE"`: There is no information about the domain assignment type.
+     * + `"PRIMARY"`: The singular primary domain for a site. When this type is assigned, this domain will lead directly to the site.
+     * + `"REDIRECT"`: A redirect domain for a site. Each site can have multiple redirect domains. When this type is assigned, this domain will redirect to the primary domain.
      * Read more about [primary and redirected domains](https://support.wix.com/en/article/switching-your-primary-and-redirected-domains).
      */
     assignmentType?: AssignmentType$3;
@@ -77,7 +77,7 @@ interface SiteInfo$3 extends SiteInfoAssignmentInfoOneOf$3 {
 /** @oneof */
 interface SiteInfoAssignmentInfoOneOf$3 {
     /**
-     * Extra details in case assignment type is redirect.
+     * Redirect information, relevant when `assignmentType` = `REDIRECT`.
      * @readonly
      */
     redirectInfo?: RedirectAssignmentInfo$3;
@@ -89,7 +89,7 @@ declare enum AssignmentType$3 {
 }
 interface RedirectAssignmentInfo$3 {
     /**
-     * Primary domain the redirect points to.
+     * Primary domain to which this domain will redirect.
      * @readonly
      */
     primaryDomain?: string;
@@ -235,7 +235,7 @@ interface ConnectedDomain {
      */
     connectionType?: ConnectionType;
     /**
-     * Information about the site to which the domain is assigned to and whether
+     * Information about the site to which the domain is assigned, and whether
      * it's the primary domain or a redirect.
      */
     siteInfo?: SiteInfo$2;
@@ -271,20 +271,20 @@ declare enum ConnectionType {
 }
 interface SiteInfo$2 extends SiteInfoAssignmentInfoOneOf$2 {
     /**
-     * Extra details in case assignment type is redirect.
+     * Redirect information, relevant when `assignmentType` = `REDIRECT`.
      * @readonly
      */
     redirectInfo?: RedirectAssignmentInfo$2;
     /**
-     * ID of the site the domain is assigned to, will be taken from context.
+     * ID of the site to which the domain is assigned.
      * @readonly
      */
     _id?: string | null;
     /**
-     * The assignment type the relationship will be based on:
-     * + `"UNKNOWN_ASSIGNMENT_TYPE"`: There is no information about the domain assignment type
-     * + `"PRIMARY"`: There can only be one primary domain per site, the result of this assignment type is that the domain will lead directly to a site.
-     * + `"REDIRECT"`: There can be multiple redirect domains. the result of this assignment type is that the redirects will lead to the primary domain
+     * The relationship assigned for this domain to the site:
+     * + `"UNKNOWN_ASSIGNMENT_TYPE"`: There is no information about the domain assignment type.
+     * + `"PRIMARY"`: The singular primary domain for a site. When this type is assigned, this domain will lead directly to the site.
+     * + `"REDIRECT"`: A redirect domain for a site. Each site can have multiple redirect domains. When this type is assigned, this domain will redirect to the primary domain.
      * Read more about [primary and redirected domains](https://support.wix.com/en/article/switching-your-primary-and-redirected-domains).
      */
     assignmentType?: AssignmentType$2;
@@ -292,7 +292,7 @@ interface SiteInfo$2 extends SiteInfoAssignmentInfoOneOf$2 {
 /** @oneof */
 interface SiteInfoAssignmentInfoOneOf$2 {
     /**
-     * Extra details in case assignment type is redirect.
+     * Redirect information, relevant when `assignmentType` = `REDIRECT`.
      * @readonly
      */
     redirectInfo?: RedirectAssignmentInfo$2;
@@ -304,7 +304,7 @@ declare enum AssignmentType$2 {
 }
 interface RedirectAssignmentInfo$2 {
     /**
-     * Primary domain the redirect points to.
+     * Primary domain to which this domain will redirect.
      * @readonly
      */
     primaryDomain?: string;