@wix/auto_sdk_ecom_delivery-profile 1.0.87 → 1.0.89

package/build/internal/es/index.typings.d.mts

@@ -1644,6 +1644,178 @@ type UpdateCarrierSettingsApplicationErrors = {
     description?: string;
     data?: Record<string, any>;
 };
+interface BaseEventMetadata {
+    /**
+     * App instance ID.
+     * @format GUID
+     */
+    instanceId?: string | null;
+    /**
+     * Event type.
+     * @maxLength 150
+     */
+    eventType?: string;
+    /** The identification type and identity data. */
+    identity?: IdentificationData;
+}
+interface EventMetadata extends BaseEventMetadata {
+    /** Event ID. With this ID you can easily spot duplicated events and ignore them. */
+    _id?: string;
+    /**
+     * Fully Qualified Domain Name of an entity. This is a unique identifier assigned to the API main business entities.
+     * For example, `wix.stores.catalog.product`, `wix.bookings.session`, `wix.payments.transaction`.
+     */
+    entityFqdn?: string;
+    /**
+     * Event action name, placed at the top level to make it easier for users to dispatch messages.
+     * For 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 that indicates the order of updates to an entity. For example, if an entity was updated at 16:00 and then again at 16:01, the second update will always have a higher sequence number.
+     * You can use this number to make sure you're handling updates in the right order. Just save the latest sequence number on your end and compare it to the one in each new message. If the new message has an older (lower) number, you can safely ignore it.
+     */
+    entityEventSequence?: string | null;
+}
+interface DeliveryProfileCreatedEnvelope {
+    entity: DeliveryProfile;
+    metadata: EventMetadata;
+}
+/** @permissionScope Manage Stores - all permissions
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
+ * @permissionScope Manage Stores
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
+ * @permissionScope Read eCommerce - all read permissions
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
+ * @permissionScope Wix Multilingual - Nile Wrapper Domain Events Read
+ * @permissionScopeId SCOPE.MULTILINGUAL.NILE_WRAPPER_DOMAIN_EVENTS_READ
+ * @permissionScope Manage eCommerce - all permissions
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
+ * @permissionId ECOM.DELIVERY_PROFILE_READ
+ * @webhook
+ * @eventType wix.ecom.v1.delivery_profile_created
+ * @slug created
+ * @documentationMaturity preview
+ */
+declare function onDeliveryProfileCreated(handler: (event: DeliveryProfileCreatedEnvelope) => void | Promise<void>): void;
+interface DeliveryProfileDeletedEnvelope {
+    entity: DeliveryProfile;
+    metadata: EventMetadata;
+}
+/** @permissionScope Manage Stores - all permissions
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
+ * @permissionScope Manage Stores
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
+ * @permissionScope Read eCommerce - all read permissions
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
+ * @permissionScope Wix Multilingual - Nile Wrapper Domain Events Read
+ * @permissionScopeId SCOPE.MULTILINGUAL.NILE_WRAPPER_DOMAIN_EVENTS_READ
+ * @permissionScope Manage eCommerce - all permissions
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
+ * @permissionId ECOM.DELIVERY_PROFILE_READ
+ * @webhook
+ * @eventType wix.ecom.v1.delivery_profile_deleted
+ * @slug deleted
+ * @documentationMaturity preview
+ */
+declare function onDeliveryProfileDeleted(handler: (event: DeliveryProfileDeletedEnvelope) => void | Promise<void>): void;
+interface DeliveryProfileRegionAddedEnvelope {
+    data: DeliveryRegionAdded;
+    metadata: EventMetadata;
+}
+/** @permissionScope Manage Stores - all permissions
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
+ * @permissionScope Manage Stores
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
+ * @permissionScope Read eCommerce - all read permissions
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
+ * @permissionScope Wix Multilingual - Nile Wrapper Domain Events Read
+ * @permissionScopeId SCOPE.MULTILINGUAL.NILE_WRAPPER_DOMAIN_EVENTS_READ
+ * @permissionScope Manage eCommerce - all permissions
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
+ * @permissionId ECOM.DELIVERY_PROFILE_READ
+ * @webhook
+ * @eventType wix.ecom.v1.delivery_profile_region_added
+ * @slug region_added
+ * @documentationMaturity preview
+ */
+declare function onDeliveryProfileRegionAdded(handler: (event: DeliveryProfileRegionAddedEnvelope) => void | Promise<void>): void;
+interface DeliveryProfileRegionRemovedEnvelope {
+    data: DeliveryRegionRemoved;
+    metadata: EventMetadata;
+}
+/** @permissionScope Manage Stores - all permissions
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
+ * @permissionScope Manage Stores
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
+ * @permissionScope Read eCommerce - all read permissions
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
+ * @permissionScope Wix Multilingual - Nile Wrapper Domain Events Read
+ * @permissionScopeId SCOPE.MULTILINGUAL.NILE_WRAPPER_DOMAIN_EVENTS_READ
+ * @permissionScope Manage eCommerce - all permissions
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
+ * @permissionId ECOM.DELIVERY_PROFILE_READ
+ * @webhook
+ * @eventType wix.ecom.v1.delivery_profile_region_removed
+ * @slug region_removed
+ * @documentationMaturity preview
+ */
+declare function onDeliveryProfileRegionRemoved(handler: (event: DeliveryProfileRegionRemovedEnvelope) => void | Promise<void>): void;
+interface DeliveryProfileRegionUpdatedEnvelope {
+    data: DeliveryRegionUpdated;
+    metadata: EventMetadata;
+}
+/** @permissionScope Manage Stores - all permissions
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
+ * @permissionScope Manage Stores
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
+ * @permissionScope Read eCommerce - all read permissions
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
+ * @permissionScope Wix Multilingual - Nile Wrapper Domain Events Read
+ * @permissionScopeId SCOPE.MULTILINGUAL.NILE_WRAPPER_DOMAIN_EVENTS_READ
+ * @permissionScope Manage eCommerce - all permissions
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
+ * @permissionId ECOM.DELIVERY_PROFILE_READ
+ * @webhook
+ * @eventType wix.ecom.v1.delivery_profile_region_updated
+ * @slug region_updated
+ * @documentationMaturity preview
+ */
+declare function onDeliveryProfileRegionUpdated(handler: (event: DeliveryProfileRegionUpdatedEnvelope) => void | Promise<void>): void;
+interface DeliveryProfileUpdatedEnvelope {
+    entity: DeliveryProfile;
+    metadata: EventMetadata;
+    /** @hidden */
+    modifiedFields: Record<string, any>;
+}
+/** @permissionScope Manage Stores - all permissions
+ * @permissionScopeId SCOPE.DC-STORES-MEGA.MANAGE-STORES
+ * @permissionScope Manage Stores
+ * @permissionScopeId SCOPE.STORES.MANAGE-STORES
+ * @permissionScope Read eCommerce - all read permissions
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.READ-ECOM
+ * @permissionScope Wix Multilingual - Nile Wrapper Domain Events Read
+ * @permissionScopeId SCOPE.MULTILINGUAL.NILE_WRAPPER_DOMAIN_EVENTS_READ
+ * @permissionScope Manage eCommerce - all permissions
+ * @permissionScopeId SCOPE.DC-ECOM-MEGA.MANAGE-ECOM
+ * @permissionId ECOM.DELIVERY_PROFILE_READ
+ * @webhook
+ * @eventType wix.ecom.v1.delivery_profile_updated
+ * @slug updated
+ * @documentationMaturity preview
+ */
+declare function onDeliveryProfileUpdated(handler: (event: DeliveryProfileUpdatedEnvelope) => void | Promise<void>): void;
 /**
  * Creates a DeliveryProfile.
  *
@@ -2231,4 +2403,4 @@ interface UpdateExtendedFieldsOptions {
     namespaceData: Record<string, any> | null;
 }
 
-export { type ActionEvent, type AddDeliveryCarrierApplicationErrors, type AddDeliveryCarrierOptions, type AddDeliveryCarrierRequest, type AddDeliveryCarrierResponse, type AddDeliveryCarrierValidationErrors, type AddDeliveryRegionApplicationErrors, type AddDeliveryRegionOptions, type AddDeliveryRegionRequest, type AddDeliveryRegionResponse, type AddDeliveryRegionValidationErrors, type AdditionalCharge, type ApplicationError, type Asset, type BackupRate, type BulkActionMetadata, ChargeType, type ChargeTypeWithLiterals, type Column, type CommonQueryWithEntityContext, type CountryDeliveryProperties, type CreateDeliveryProfileApplicationErrors, type CreateDeliveryProfileRequest, type CreateDeliveryProfileResponse, type CreatedBy, type CreatedByIdOneOf, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type DashboardTable, type DeleteContext, type DeleteDefaultDeliveryProfileRequest, type DeleteDefaultDeliveryProfileResponse, type DeleteDeliveryProfileRequest, type DeleteDeliveryProfileResponse, DeleteStatus, type DeleteStatusWithLiterals, type DeliveryCarrier, type DeliveryCarrierDetails, type DeliveryCarrierRegionalSettings, type DeliveryDestinationProperties, type DeliveryProfile, type DeliveryProfileQuery, type DeliveryProfileQuerySpec, type DeliveryProfilesQueryBuilder, type DeliveryProfilesQueryResult, type DeliveryRegion, type DeliveryRegionAdded, type DeliveryRegionRemoved, type DeliveryRegionUpdated, type Destination, DestinationScope, type DestinationScopeWithLiterals, type DomainEvent, type DomainEventBodyOneOf, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type ExtendedFields, type GetDeliveryDestinationPropertiesRequest, type GetDeliveryDestinationPropertiesResponse, type GetDeliveryProfileByDeliveryRegionIdApplicationErrors, type GetDeliveryProfileByDeliveryRegionIdRequest, type GetDeliveryProfileByDeliveryRegionIdResponse, type GetDeliveryProfileRequest, type GetDeliveryProfileResponse, type IdentificationData, type IdentificationDataIdOneOf, type InstalledDeliveryCarrier, type ItemMetadata, type ListDeliveryCarriersApplicationErrors, type ListDeliveryCarriersOptions, type ListDeliveryCarriersRequest, type ListDeliveryCarriersResponse, type ListDeliveryCarriersResult, type ListDeliveryDestinationsRequest, type ListDeliveryDestinationsResponse, type ListInstalledDeliveryCarriersRequest, type ListInstalledDeliveryCarriersResponse, type MessageEnvelope, type MetaSiteSpecialEvent, type MetaSiteSpecialEventPayloadOneOf, Namespace, type NamespaceChanged, type NamespaceWithLiterals, type OdeditorAssigned, type OdeditorUnassigned, type PicassoAssigned, type PicassoUnassigned, type QueryDeliveryProfilesRequest, type QueryDeliveryProfilesResponse, type RemoveDeliveryCarrierApplicationErrors, type RemoveDeliveryCarrierOptions, type RemoveDeliveryCarrierRequest, type RemoveDeliveryCarrierResponse, type RemoveDeliveryRegionApplicationErrors, type RemoveDeliveryRegionIdentifiers, type RemoveDeliveryRegionOptions, type RemoveDeliveryRegionRequest, type RemoveDeliveryRegionResponse, type RequiredZipcodeRequest, type RequiredZipcodeResponse, type RestoreInfo, type Row, type ServiceProvisioned, type ServiceRemoved, type SiteCreated, SiteCreatedContext, type SiteCreatedContextWithLiterals, type SiteDeleted, type SiteHardDeleted, type SiteMarkedAsTemplate, type SiteMarkedAsWixSite, type SitePublished, type SitePurgedExternally, type SiteRenamed, type SiteTransferred, type SiteUndeleted, type SiteUnpublished, type SiteUrlChanged, SortOrder, type SortOrderWithLiterals, type Sorting, State, type StateWithLiterals, type StudioAssigned, type StudioTwoAssigned, type StudioTwoUnassigned, type StudioUnassigned, type SubdivisionDeliveryProperties, type UpdateCarrierSettingsApplicationErrors, type UpdateCarrierSettingsOptions, type UpdateCarrierSettingsRequest, type UpdateCarrierSettingsResponse, type UpdateDeliveryCarrierApplicationErrors, type UpdateDeliveryCarrierOptions, type UpdateDeliveryCarrierRequest, type UpdateDeliveryCarrierResponse, type UpdateDeliveryProfile, type UpdateDeliveryProfileApplicationErrors, type UpdateDeliveryProfileRequest, type UpdateDeliveryProfileResponse, type UpdateDeliveryRegion, type UpdateDeliveryRegionApplicationErrors, type UpdateDeliveryRegionIdentifiers, type UpdateDeliveryRegionOptions, type UpdateDeliveryRegionRequest, type UpdateDeliveryRegionResponse, type UpdateDeliveryRegionValidationErrors, type UpdateExtendedFieldsOptions, type UpdateExtendedFieldsRequest, type UpdateExtendedFieldsResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, type WixelAssigned, type WixelUnassigned, addDeliveryCarrier, addDeliveryRegion, createDeliveryProfile, deleteDeliveryProfile, getDeliveryDestinationProperties, getDeliveryProfile, getDeliveryProfileByDeliveryRegionId, listDeliveryCarriers, listInstalledDeliveryCarriers, queryDeliveryProfiles, removeDeliveryCarrier, removeDeliveryRegion, typedQueryDeliveryProfiles, updateCarrierSettings, updateDeliveryCarrier, updateDeliveryProfile, updateDeliveryRegion, updateExtendedFields };
+export { type ActionEvent, type AddDeliveryCarrierApplicationErrors, type AddDeliveryCarrierOptions, type AddDeliveryCarrierRequest, type AddDeliveryCarrierResponse, type AddDeliveryCarrierValidationErrors, type AddDeliveryRegionApplicationErrors, type AddDeliveryRegionOptions, type AddDeliveryRegionRequest, type AddDeliveryRegionResponse, type AddDeliveryRegionValidationErrors, type AdditionalCharge, type ApplicationError, type Asset, type BackupRate, type BaseEventMetadata, type BulkActionMetadata, ChargeType, type ChargeTypeWithLiterals, type Column, type CommonQueryWithEntityContext, type CountryDeliveryProperties, type CreateDeliveryProfileApplicationErrors, type CreateDeliveryProfileRequest, type CreateDeliveryProfileResponse, type CreatedBy, type CreatedByIdOneOf, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type DashboardTable, type DeleteContext, type DeleteDefaultDeliveryProfileRequest, type DeleteDefaultDeliveryProfileResponse, type DeleteDeliveryProfileRequest, type DeleteDeliveryProfileResponse, DeleteStatus, type DeleteStatusWithLiterals, type DeliveryCarrier, type DeliveryCarrierDetails, type DeliveryCarrierRegionalSettings, type DeliveryDestinationProperties, type DeliveryProfile, type DeliveryProfileCreatedEnvelope, type DeliveryProfileDeletedEnvelope, type DeliveryProfileQuery, type DeliveryProfileQuerySpec, type DeliveryProfileRegionAddedEnvelope, type DeliveryProfileRegionRemovedEnvelope, type DeliveryProfileRegionUpdatedEnvelope, type DeliveryProfileUpdatedEnvelope, type DeliveryProfilesQueryBuilder, type DeliveryProfilesQueryResult, type DeliveryRegion, type DeliveryRegionAdded, type DeliveryRegionRemoved, type DeliveryRegionUpdated, type Destination, DestinationScope, type DestinationScopeWithLiterals, type DomainEvent, type DomainEventBodyOneOf, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type EventMetadata, type ExtendedFields, type GetDeliveryDestinationPropertiesRequest, type GetDeliveryDestinationPropertiesResponse, type GetDeliveryProfileByDeliveryRegionIdApplicationErrors, type GetDeliveryProfileByDeliveryRegionIdRequest, type GetDeliveryProfileByDeliveryRegionIdResponse, type GetDeliveryProfileRequest, type GetDeliveryProfileResponse, type IdentificationData, type IdentificationDataIdOneOf, type InstalledDeliveryCarrier, type ItemMetadata, type ListDeliveryCarriersApplicationErrors, type ListDeliveryCarriersOptions, type ListDeliveryCarriersRequest, type ListDeliveryCarriersResponse, type ListDeliveryCarriersResult, type ListDeliveryDestinationsRequest, type ListDeliveryDestinationsResponse, type ListInstalledDeliveryCarriersRequest, type ListInstalledDeliveryCarriersResponse, type MessageEnvelope, type MetaSiteSpecialEvent, type MetaSiteSpecialEventPayloadOneOf, Namespace, type NamespaceChanged, type NamespaceWithLiterals, type OdeditorAssigned, type OdeditorUnassigned, type PicassoAssigned, type PicassoUnassigned, type QueryDeliveryProfilesRequest, type QueryDeliveryProfilesResponse, type RemoveDeliveryCarrierApplicationErrors, type RemoveDeliveryCarrierOptions, type RemoveDeliveryCarrierRequest, type RemoveDeliveryCarrierResponse, type RemoveDeliveryRegionApplicationErrors, type RemoveDeliveryRegionIdentifiers, type RemoveDeliveryRegionOptions, type RemoveDeliveryRegionRequest, type RemoveDeliveryRegionResponse, type RequiredZipcodeRequest, type RequiredZipcodeResponse, type RestoreInfo, type Row, type ServiceProvisioned, type ServiceRemoved, type SiteCreated, SiteCreatedContext, type SiteCreatedContextWithLiterals, type SiteDeleted, type SiteHardDeleted, type SiteMarkedAsTemplate, type SiteMarkedAsWixSite, type SitePublished, type SitePurgedExternally, type SiteRenamed, type SiteTransferred, type SiteUndeleted, type SiteUnpublished, type SiteUrlChanged, SortOrder, type SortOrderWithLiterals, type Sorting, State, type StateWithLiterals, type StudioAssigned, type StudioTwoAssigned, type StudioTwoUnassigned, type StudioUnassigned, type SubdivisionDeliveryProperties, type UpdateCarrierSettingsApplicationErrors, type UpdateCarrierSettingsOptions, type UpdateCarrierSettingsRequest, type UpdateCarrierSettingsResponse, type UpdateDeliveryCarrierApplicationErrors, type UpdateDeliveryCarrierOptions, type UpdateDeliveryCarrierRequest, type UpdateDeliveryCarrierResponse, type UpdateDeliveryProfile, type UpdateDeliveryProfileApplicationErrors, type UpdateDeliveryProfileRequest, type UpdateDeliveryProfileResponse, type UpdateDeliveryRegion, type UpdateDeliveryRegionApplicationErrors, type UpdateDeliveryRegionIdentifiers, type UpdateDeliveryRegionOptions, type UpdateDeliveryRegionRequest, type UpdateDeliveryRegionResponse, type UpdateDeliveryRegionValidationErrors, type UpdateExtendedFieldsOptions, type UpdateExtendedFieldsRequest, type UpdateExtendedFieldsResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, type WixelAssigned, type WixelUnassigned, addDeliveryCarrier, addDeliveryRegion, createDeliveryProfile, deleteDeliveryProfile, getDeliveryDestinationProperties, getDeliveryProfile, getDeliveryProfileByDeliveryRegionId, listDeliveryCarriers, listInstalledDeliveryCarriers, onDeliveryProfileCreated, onDeliveryProfileDeleted, onDeliveryProfileRegionAdded, onDeliveryProfileRegionRemoved, onDeliveryProfileRegionUpdated, onDeliveryProfileUpdated, queryDeliveryProfiles, removeDeliveryCarrier, removeDeliveryRegion, typedQueryDeliveryProfiles, updateCarrierSettings, updateDeliveryCarrier, updateDeliveryProfile, updateDeliveryRegion, updateExtendedFields };