@wix/auto_sdk_ecom_delivery-profile 1.0.0

package/build/internal/es/src/ecom-v1-delivery-profile-delivery-profile.types.d.ts

@@ -0,0 +1,1053 @@
+/**
+ * A DeliveryProfile is a ...
+ * You can ...
+ * Read more about DeliveryProfiles
+ * in this [article](<LINK_TO_KB_ARTICLE>).
+ */
+export interface DeliveryProfile {
+    /**
+     * DeliveryProfile ID.
+     * @readonly
+     */
+    id?: string | null;
+    /** DeliveryProfile name. */
+    name?: string | null;
+    /**
+     * Flags this DeliveryProfile as the default DeliveryProfile.
+     * @readonly
+     */
+    default?: boolean | null;
+    /** A list of DeliveryProfile regions. */
+    deliveryRegions?: DeliveryRegion[];
+    /** ID of the delivery profile's creator. */
+    createdBy?: CreatedBy;
+    /**
+     * DeliveryProfile revision.
+     * @readonly
+     */
+    revision?: string | null;
+    /**
+     * Date and time the DeliveryProfile was created.
+     * @readonly
+     */
+    createdDate?: Date | null;
+    /**
+     * Date and time the DeliveryProfile was last updated.
+     * @readonly
+     */
+    updatedDate?: Date | null;
+    /** [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields ) must be configured in the app dashboard before they can be accessed with API calls. */
+    extendedFields?: ExtendedFields;
+}
+/** DeliveryRegion can be used to config a Delivery Destinations with its providers */
+export interface DeliveryRegion {
+    /**
+     * The delivery region id.
+     * @readonly
+     */
+    id?: string | null;
+    /** Optional name of the rule, for example: "Domestic". */
+    name?: string | null;
+    /** Indicates that this rule is active, default value is true. */
+    active?: boolean | null;
+    /**
+     * The spi implementers id of shipping-rates spi, assigned to this rule.
+     * @readonly
+     */
+    deliveryCarriers?: DeliveryCarrier[];
+    /** The operation region of this rule, if empty than it is global. */
+    destinations?: Destination[];
+    /**
+     * Represents the time this Profile was created
+     * @readonly
+     */
+    createdDate?: Date | null;
+}
+export interface DeliveryCarrier {
+    /** AppDefId of the provider as it is registered in the [app dashboard](https://dev.wix.com/dc3/my-apps/). Can be fetched by listDeliveryProvider api. */
+    appId?: string;
+    /** Backup rate to be used in case the cost returned by the provider is empty. */
+    backupRate?: BackupRate;
+    /** Additional charges to add to the delivery rate for this carrier */
+    additionalCharges?: AdditionalCharge[];
+}
+export interface BackupRate {
+    /** Default rate prefix that will concatenate to the delivery options the provider will offer. */
+    prefix?: string | null;
+    /** Default rate price for all delivery options that the provider will offer. */
+    rate?: string | null;
+    /** Should the default rate be used. Default value is false. */
+    enabled?: boolean | null;
+}
+export interface AdditionalCharge {
+    /** Additional charge type. */
+    type?: ChargeType;
+    /** Description of the additional charge. For example, `"Handling fee of $5 applied for gift wrapping"`. */
+    description?: string | null;
+    /** Cost of additional charge. For example, `12.5`. */
+    price?: string;
+}
+export declare enum ChargeType {
+    HANDLING_FEE = "HANDLING_FEE"
+}
+/** Defines the area inside one country that is relevant for this rule. */
+export interface Destination {
+    /** 2-letters code represents the country of the delivery destinations */
+    countryCode?: string;
+    /**
+     * subdivisions - Usually a state, region, prefecture, or province code, according to [ISO 3166-2](https://en.wikipedia.org/wiki/ISO_3166-2).
+     * If empty, the rule applies to the entire country.
+     */
+    subdivisions?: string[];
+}
+export interface CreatedBy extends CreatedByIdOneOf {
+    /** App ID - when the delivery profile was created by an external application or Wix service. */
+    appId?: string | null;
+    /** User ID - when the delivery profile was created by a Wix user. */
+    userId?: string | null;
+}
+/** @oneof */
+export interface CreatedByIdOneOf {
+    /** App ID - when the delivery profile was created by an external application or Wix service. */
+    appId?: string | null;
+    /** User ID - when the delivery profile was created by a Wix user. */
+    userId?: string | null;
+}
+export interface ExtendedFields {
+    /**
+     * Extended field data. Each key corresponds to the namespace of the app that created the extended fields.
+     * The value of each key is structured according to the schema defined when the extended fields were configured.
+     *
+     * You can only access fields for which you have the appropriate permissions.
+     *
+     * Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields).
+     */
+    namespaces?: Record<string, Record<string, any>>;
+}
+export interface DeliveryRegionAdded {
+    /** The DeliveryProfile owns this region. */
+    deliveryProfileId?: string;
+    /**
+     * The delivery region id.
+     * @readonly
+     */
+    deliveryRegionId?: string | null;
+    /** Optional name of the rule, for example: "Domestic". */
+    name?: string | null;
+    /** Indicates that this rule is active, default value is true. */
+    active?: boolean | null;
+    /**
+     * The spi implementers id of shipping-rates spi, assigned to this rule.
+     * @readonly
+     */
+    deliveryCarriers?: DeliveryCarrier[];
+    /** The operation region of this rule, if empty than it is global. */
+    destinations?: Destination[];
+    /**
+     * Represents the time this Profile was created
+     * @readonly
+     */
+    createdDate?: Date | null;
+}
+export interface DeliveryRegionRemoved {
+    /** The DeliveryProfile owns this region. */
+    deliveryProfileId?: string;
+    /** The removed DeliveryRegion id. */
+    deliveryRegionId?: string;
+}
+export interface DeliveryRegionUpdated {
+    /** The DeliveryProfile owns this DeliveryRegion. */
+    deliveryProfileId?: string;
+    /**
+     * The delivery region id.
+     * @readonly
+     */
+    deliveryRegionId?: string | null;
+    /** Optional name of the rule, for example: "Domestic". */
+    name?: string | null;
+    /** Indicates that this rule is active, default value is true. */
+    active?: boolean | null;
+    /**
+     * The spi implementers id of shipping-rates spi, assigned to this rule.
+     * @readonly
+     */
+    deliveryCarriers?: DeliveryCarrier[];
+    /** The operation region of this rule, if empty than it is global. */
+    destinations?: Destination[];
+    /**
+     * Represents the time this Profile was created
+     * @readonly
+     */
+    createdDate?: Date | null;
+}
+export interface CreateDeliveryProfileRequest {
+    /** DeliveryProfile to be created. */
+    deliveryProfile: DeliveryProfile;
+}
+export interface CreateDeliveryProfileResponse {
+    /** The created DeliveryProfile. */
+    deliveryProfile?: DeliveryProfile;
+}
+export interface GetDeliveryProfileRequest {
+    /** ID of the DeliveryProfile to retrieve. */
+    deliveryProfileId: string;
+}
+export interface GetDeliveryProfileResponse {
+    /** The requested DeliveryProfile. */
+    deliveryProfile?: DeliveryProfile;
+}
+export interface UpdateDeliveryProfileRequest {
+    /** DeliveryProfile to be updated, may be partial. */
+    deliveryProfile: DeliveryProfile;
+}
+export interface UpdateDeliveryProfileResponse {
+    /** Updated DeliveryProfile. */
+    deliveryProfile?: DeliveryProfile;
+}
+export interface DeleteDeliveryProfileRequest {
+    /** Id of the DeliveryProfile to delete. */
+    deliveryProfileId: string;
+}
+export interface DeleteDeliveryProfileResponse {
+}
+export interface QueryDeliveryProfilesRequest {
+    /** WQL expression. */
+    query?: CursorQuery;
+}
+export interface CursorQuery extends CursorQueryPagingMethodOneOf {
+    /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
+    cursorPaging?: CursorPaging;
+    /**
+     * Filter object in the following format:
+     * `"filter" : {
+     * "fieldName1": "value1",
+     * "fieldName2":{"$operator":"value2"}
+     * }`
+     * Example of operators: `$eq`, `$ne`, `$lt`, `$lte`, `$gt`, `$gte`, `$in`, `$hasSome`, `$hasAll`, `$startsWith`, `$contains`
+     */
+    filter?: Record<string, any> | null;
+    /**
+     * Sort object in the following format:
+     * `[{"fieldName":"sortField1","order":"ASC"},{"fieldName":"sortField2","order":"DESC"}]`
+     */
+    sort?: Sorting[];
+}
+/** @oneof */
+export interface CursorQueryPagingMethodOneOf {
+    /** Cursor token pointing to a page of results. Not used in the first request. Following requests use the cursor token and not `filter` or `sort`. */
+    cursorPaging?: CursorPaging;
+}
+export interface Sorting {
+    /** Name of the field to sort by. */
+    fieldName?: string;
+    /** Sort order. */
+    order?: SortOrder;
+}
+export declare enum SortOrder {
+    ASC = "ASC",
+    DESC = "DESC"
+}
+export interface CursorPaging {
+    /** Maximum number of items to return in the results. */
+    limit?: number | null;
+    /**
+     * Pointer to the next or previous page in the list of results.
+     *
+     * Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response.
+     * Not relevant for the first request.
+     */
+    cursor?: string | null;
+}
+export interface QueryDeliveryProfilesResponse {
+    /** List of DeliveryProfiles. */
+    deliveryProfiles?: DeliveryProfile[];
+    /** Paging metadata */
+    pagingMetadata?: CursorPagingMetadata;
+}
+export interface CursorPagingMetadata {
+    /** Number of items returned in the response. */
+    count?: number | null;
+    /** Cursor strings that point to the next page, previous page, or both. */
+    cursors?: Cursors;
+    /**
+     * Whether there are more pages to retrieve following the current page.
+     *
+     * + `true`: Another page of results can be retrieved.
+     * + `false`: This is the last page.
+     */
+    hasNext?: boolean | null;
+}
+export interface Cursors {
+    /** Cursor string pointing to the next page in the list of results. */
+    next?: string | null;
+    /** Cursor pointing to the previous page in the list of results. */
+    prev?: string | null;
+}
+export interface AddDeliveryRegionRequest {
+    /** delivery profile id to associated with the DeliveryRegion */
+    deliveryProfileId: string;
+    /** DeliveryRegion to be created */
+    deliveryRegion: DeliveryRegion;
+    /**
+     * DeliveryProfile revision.
+     * @readonly
+     */
+    revision?: string | null;
+}
+export interface AddDeliveryRegionResponse {
+    /** The updated DeliveryProfile with the new DeliveryRegion */
+    deliveryProfile?: DeliveryProfile;
+}
+export interface UpdateDeliveryRegionRequest {
+    /** DeliveryProfile id that owns the DeliveryRegion */
+    deliveryProfileId: string;
+    /** DeliveryRegion to be updated, may be partial */
+    deliveryRegion: DeliveryRegion;
+    /**
+     * DeliveryProfile revision.
+     * @readonly
+     */
+    revision?: string | null;
+}
+export interface UpdateDeliveryRegionResponse {
+    /** The updated DeliveryProfile with the updated DeliveryRegion */
+    deliveryProfile?: DeliveryProfile;
+}
+export interface RemoveDeliveryRegionRequest {
+    /** DeliveryProfile id that owns the DeliveryRegion */
+    deliveryProfileId: string;
+    /** Id of the DeliveryRegion to delete */
+    deliveryRegionId: string;
+    /**
+     * DeliveryProfile revision.
+     * @readonly
+     */
+    revision?: string | null;
+}
+export interface RemoveDeliveryRegionResponse {
+    /** The updated DeliveryProfile without DeliveryRegion */
+    deliveryProfile?: DeliveryProfile;
+}
+export interface AddDeliveryCarrierRequest {
+    /** delivery_region id to associated with the delivery_carrier. */
+    deliveryRegionId: string;
+    /** delivery_carrier to be added. */
+    deliveryCarrier: DeliveryCarrier;
+}
+export interface AddDeliveryCarrierResponse {
+    /** The updated DeliveryProfile */
+    deliveryProfile?: DeliveryProfile;
+}
+export interface RemoveDeliveryCarrierRequest {
+    /** Id of the DeliveryRegion */
+    deliveryRegionId: string;
+    /** DeliveryCarrier app id to be removed. */
+    appId: string;
+}
+export interface RemoveDeliveryCarrierResponse {
+    /** The updated DeliveryProfile */
+    deliveryProfile?: DeliveryProfile;
+}
+export interface UpdateDeliveryCarrierRequest {
+    /** DeliveryRegion id */
+    deliveryRegionId: string;
+    /** Updated delivery_carrier */
+    deliveryCarrier?: DeliveryCarrier;
+}
+export interface UpdateDeliveryCarrierResponse {
+    /** The updated DeliveryProfile with the updated DeliveryCarrier */
+    deliveryProfile?: DeliveryProfile;
+}
+export interface ListDeliveryCarrierDetailsRequest {
+}
+export interface ListDeliveryCarrierDetailsResponse {
+    /** The list of carrier or multi-carrier services that has implemented the spi and installed on the current context(site) */
+    deliveryCarrierDetails?: DeliveryCarrierDetails[];
+}
+export interface DeliveryCarrierDetails {
+    /** The id of the provider. */
+    id?: string;
+    /** The name of the Provider. */
+    displayName?: string;
+    /** Provider's description. */
+    description?: string | null;
+    /** A link to learn more about the provider. */
+    learnMoreUrl?: string | null;
+    /** Dashboard URL for the provider. */
+    dashboardUrl?: string | null;
+    /** If the provider fallback definition is mandatory. */
+    fallbackDefinitionMandatory?: boolean | null;
+    /** Thumbnail image for provider. */
+    thumbnailUrl?: string | null;
+    /** feature toggle initialized with default value = false. should be true if implemented by spi provider */
+    toggleGetCarrierSettingsEnabled?: boolean;
+    /** feature toggle initialized with default value = false. should be true if implemented by spi provider */
+    toggleUpdateCarrierActiveStatusEnabled?: boolean;
+}
+export interface ListInstalledDeliveryCarriersRequest {
+}
+export interface ListInstalledDeliveryCarriersResponse {
+    /** The list of carrier or multi-carrier services that has implemented the spi and installed on the current context(site) */
+    installedDeliveryCarriers?: InstalledDeliveryCarrier[];
+}
+export interface InstalledDeliveryCarrier {
+    /** The id of the provider. */
+    id?: string;
+    /** The name of the Provider. */
+    displayName?: string;
+    /** Provider's description. */
+    description?: string | null;
+    /** A link to learn more about the provider. */
+    learnMoreUrl?: string | null;
+    /** Dashboard URL for the provider. */
+    dashboardUrl?: string | null;
+    /** If the provider fallback definition is mandatory. */
+    fallbackDefinitionMandatory?: boolean | null;
+    /** Thumbnail image for provider. */
+    thumbnailUrl?: string | null;
+    /** feature toggle initialized with default value = false. should be true if implemented by spi provider */
+    toggleGetCarrierSettingsEnabled?: boolean;
+}
+export interface ListDeliveryDestinationsRequest {
+}
+export interface ListDeliveryDestinationsResponse {
+    /** Scope of destinations, when worldwide is selected, the destinations list will be empty. */
+    destinationScope?: DestinationScope;
+    /** The list of destinations */
+    destinations?: Destination[];
+}
+export declare enum DestinationScope {
+    /** No additional destinations are requested */
+    SPECIFIC_DESTINATIONS = "SPECIFIC_DESTINATIONS",
+    /** All Destinations */
+    WORLDWIDE = "WORLDWIDE"
+}
+export interface ListDeliveryCarriersRequest {
+    /** Delivery profile id. */
+    deliveryProfileId: string;
+    /** Delivery app ids to get settings for. */
+    appIds?: string[];
+}
+export interface ListDeliveryCarriersResponse {
+    /** The list of delivery settings for the given requests */
+    results?: ListDeliveryCarriersResult[];
+    /** Bulk action metadata. */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+export interface ListDeliveryCarriersResult {
+    /** Information about successful action or error for failure. */
+    deliveryCarrierMetadata?: ItemMetadata;
+    /** The delivery carrier details */
+    deliveryCarrierDetails?: DeliveryCarrierDetails;
+    /** The delivery settings for the delivery profile and delivery region. */
+    deliveryCarrierRegionalSettings?: DeliveryCarrierRegionalSettings[];
+}
+export interface ItemMetadata {
+    /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
+    id?: string | null;
+    /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
+    success?: boolean;
+    /** Details about the error in case of failure. */
+    error?: ApplicationError;
+}
+export interface ApplicationError {
+    /** Error code. */
+    code?: string;
+    /** Description of the error. */
+    description?: string;
+    /** Data related to the error. */
+    data?: Record<string, any> | null;
+}
+export interface DeliveryCarrierRegionalSettings {
+    /** The delivery rule id. */
+    deliveryRegionId?: string;
+    /** The shipping table values that are associated with the delivery rule. Can be multiple if the provider is an aggregator of multiple carriers. */
+    dashboardTables?: DashboardTable[];
+}
+export interface DashboardTable {
+    /** The title of the delivery settings that will be displayed in the UI. */
+    title?: string;
+    /** The columns of the delivery settings that will be displayed in the UI. */
+    columns?: Column[];
+    /** The content of the delivery settings. Each row is a map of column name to value. */
+    rows?: Row[];
+}
+export interface Column {
+    /** The name of the column. This is used to get the data from the row. */
+    key?: string;
+    /** The title of the column that will be displayed in the UI. */
+    name?: string;
+}
+export interface Row {
+    /** The external key of the data presented in a row. This is used to identify the row in the UI for editing. */
+    key?: string;
+    /**
+     * The data presented in the row. The key is the column `name` and the value is the data in the specific row and column.
+     * Data will be in JSON format.
+     */
+    data?: Record<string, any> | null;
+    /** The configuration's status of the current row. */
+    active?: boolean;
+}
+export interface BulkActionMetadata {
+    /** Number of items that were successfully processed. */
+    totalSuccesses?: number;
+    /** Number of items that couldn't be processed. */
+    totalFailures?: number;
+    /** Number of failures without details because detailed failure threshold was exceeded. */
+    undetailedFailures?: number;
+}
+export interface UpdateCarrierSettingsRequest {
+    /** Carrier id. */
+    carrierId: string;
+    /** Row id triggered the change */
+    rowId: string;
+    /** New status */
+    active: boolean | null;
+}
+export interface UpdateCarrierSettingsResponse {
+}
+export interface UpdateExtendedFieldsRequest {
+    /** ID of the entity to update. */
+    id: string;
+    /** Identifier for the app whose extended fields are being updated. */
+    namespace: string;
+    /** Data to update. Structured according to the [schema](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields#json-schema-for-extended-fields) defined when the extended fields were configured. */
+    namespaceData: Record<string, any> | null;
+}
+export interface UpdateExtendedFieldsResponse {
+    /** Updated DeliveryProfile. */
+    deliveryProfile?: DeliveryProfile;
+}
+export interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
+    /** Emitted on a meta site creation. */
+    siteCreated?: SiteCreated;
+    /** Emitted on a meta site transfer completion. */
+    siteTransferred?: SiteTransferred;
+    /** Emitted on a meta site deletion. */
+    siteDeleted?: SiteDeleted;
+    /** Emitted on a meta site restoration. */
+    siteUndeleted?: SiteUndeleted;
+    /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
+    sitePublished?: SitePublished;
+    /** Emitted on a meta site unpublish. */
+    siteUnpublished?: SiteUnpublished;
+    /** Emitted when meta site is marked as template. */
+    siteMarkedAsTemplate?: SiteMarkedAsTemplate;
+    /** Emitted when meta site is marked as a WixSite. */
+    siteMarkedAsWixSite?: SiteMarkedAsWixSite;
+    /** Emitted when an application is provisioned (installed). */
+    serviceProvisioned?: ServiceProvisioned;
+    /** Emitted when an application is removed (uninstalled). */
+    serviceRemoved?: ServiceRemoved;
+    /** Emitted when meta site name (URL slug) is changed. */
+    siteRenamedPayload?: SiteRenamed;
+    /** Emitted when meta site was permanently deleted. */
+    hardDeleted?: SiteHardDeleted;
+    /** Emitted on a namespace change. */
+    namespaceChanged?: NamespaceChanged;
+    /** Emitted when Studio is attached. */
+    studioAssigned?: StudioAssigned;
+    /** Emitted when Studio is detached. */
+    studioUnassigned?: StudioUnassigned;
+    /** A meta site id. */
+    metaSiteId?: string;
+    /** A meta site version. Monotonically increasing. */
+    version?: string;
+    /** A timestamp of the event. */
+    timestamp?: string;
+    /**
+     * TODO(meta-site): Change validation once validations are disabled for consumers
+     * More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
+     */
+    assets?: Asset[];
+}
+/** @oneof */
+export interface MetaSiteSpecialEventPayloadOneOf {
+    /** Emitted on a meta site creation. */
+    siteCreated?: SiteCreated;
+    /** Emitted on a meta site transfer completion. */
+    siteTransferred?: SiteTransferred;
+    /** Emitted on a meta site deletion. */
+    siteDeleted?: SiteDeleted;
+    /** Emitted on a meta site restoration. */
+    siteUndeleted?: SiteUndeleted;
+    /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
+    sitePublished?: SitePublished;
+    /** Emitted on a meta site unpublish. */
+    siteUnpublished?: SiteUnpublished;
+    /** Emitted when meta site is marked as template. */
+    siteMarkedAsTemplate?: SiteMarkedAsTemplate;
+    /** Emitted when meta site is marked as a WixSite. */
+    siteMarkedAsWixSite?: SiteMarkedAsWixSite;
+    /** Emitted when an application is provisioned (installed). */
+    serviceProvisioned?: ServiceProvisioned;
+    /** Emitted when an application is removed (uninstalled). */
+    serviceRemoved?: ServiceRemoved;
+    /** Emitted when meta site name (URL slug) is changed. */
+    siteRenamedPayload?: SiteRenamed;
+    /** Emitted when meta site was permanently deleted. */
+    hardDeleted?: SiteHardDeleted;
+    /** Emitted on a namespace change. */
+    namespaceChanged?: NamespaceChanged;
+    /** Emitted when Studio is attached. */
+    studioAssigned?: StudioAssigned;
+    /** Emitted when Studio is detached. */
+    studioUnassigned?: StudioUnassigned;
+}
+export interface Asset {
+    /** An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum). */
+    appDefId?: string;
+    /** An instance id. For legacy reasons may be UUID or a string. */
+    instanceId?: string;
+    /** An application state. */
+    state?: State;
+}
+export declare enum State {
+    UNKNOWN = "UNKNOWN",
+    ENABLED = "ENABLED",
+    DISABLED = "DISABLED",
+    PENDING = "PENDING",
+    DEMO = "DEMO"
+}
+export interface SiteCreated {
+    /** A template identifier (empty if not created from a template). */
+    originTemplateId?: string;
+    /** An account id of the owner. */
+    ownerId?: string;
+    /** A context in which meta site was created. */
+    context?: SiteCreatedContext;
+    /**
+     * A meta site id from which this site was created.
+     *
+     * In case of a creation from a template it's a template id.
+     * In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
+     */
+    originMetaSiteId?: string | null;
+    /** A meta site name (URL slug). */
+    siteName?: string;
+    /** A namespace. */
+    namespace?: Namespace;
+}
+export declare enum SiteCreatedContext {
+    /** A valid option, we don't expose all reasons why site might be created. */
+    OTHER = "OTHER",
+    /** A meta site was created from template. */
+    FROM_TEMPLATE = "FROM_TEMPLATE",
+    /** A meta site was created by copying of the transfferred meta site. */
+    DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER",
+    /** A copy of existing meta site. */
+    DUPLICATE = "DUPLICATE",
+    /** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */
+    OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER",
+    /** deprecated A meta site was created for Flash editor. */
+    FLASH = "FLASH"
+}
+export declare enum Namespace {
+    UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
+    /** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
+    WIX = "WIX",
+    /** ShoutOut stand alone product. These are siteless (no actual Wix site, no HtmlWeb). MetaSites with this namespace will *not* be shown in a user's site list by default. */
+    SHOUT_OUT = "SHOUT_OUT",
+    /** MetaSites created by the Albums product, they appear as part of the Albums app. MetaSites with this namespace will *not* be shown in a user's site list by default. */
+    ALBUMS = "ALBUMS",
+    /** Part of the WixStores migration flow, a user tries to migrate and gets this site to view and if the user likes it then stores removes this namespace and deletes the old site with the old stores. MetaSites with this namespace will *not* be shown in a user's site list by default. */
+    WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
+    /** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
+    HOTELS = "HOTELS",
+    /** Clubs siteless MetaSites, a club without a wix website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
+    CLUBS = "CLUBS",
+    /** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
+    ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
+    /** AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default. */
+    DEV_SITE = "DEV_SITE",
+    /** LogoMaker websites offered to the user after logo purchase. MetaSites with this namespace will *not* be shown in a user's site list by default. */
+    LOGOS = "LOGOS",
+    /** VideoMaker websites offered to the user after video purchase. MetaSites with this namespace will *not* be shown in a user's site list by default. */
+    VIDEO_MAKER = "VIDEO_MAKER",
+    /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
+    PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
+    /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
+    DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
+    /**
+     * A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.
+     *
+     * Meta site with this namespace will *not* be shown in a user's site list by default.
+     */
+    HTML_DRAFT = "HTML_DRAFT",
+    /**
+     * the user-journey for Fitness users who want to start from managing their business instead of designing their website.
+     * Will be accessible from Site List and will not have a website app.
+     * Once the user attaches a site, the site will become a regular wixsite.
+     */
+    SITELESS_BUSINESS = "SITELESS_BUSINESS",
+    /** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
+    CREATOR_ECONOMY = "CREATOR_ECONOMY",
+    /** It is to be used in the Business First efforts. */
+    DASHBOARD_FIRST = "DASHBOARD_FIRST",
+    /** Bookings business flow with no site. */
+    ANYWHERE = "ANYWHERE",
+    /** Namespace for Headless Backoffice with no editor */
+    HEADLESS = "HEADLESS",
+    /**
+     * Namespace for master site that will exist in parent account that will be referenced by subaccounts
+     * The site will be used for account level CSM feature for enterprise
+     */
+    ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS",
+    /** Rise.ai Siteless account management for Gift Cards and Store Credit. */
+    RISE = "RISE",
+    /**
+     * As part of the branded app new funnel, users now can create a meta site that will be branded app first.
+     * There's a blank site behind the scene but it's blank).
+     * The Mobile company will be the owner of this namespace.
+     */
+    BRANDED_FIRST = "BRANDED_FIRST",
+    /** Nownia.com Siteless account management for Ai Scheduling Assistant. */
+    NOWNIA = "NOWNIA",
+    /**
+     * UGC Templates are templates that are created by users for personal use and to sale to other users.
+     * The Partners company owns this namespace.
+     */
+    UGC_TEMPLATE = "UGC_TEMPLATE",
+    /** Codux Headless Sites */
+    CODUX = "CODUX",
+    /** Bobb - AI Design Creator. */
+    MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR",
+    /**
+     * Shared Blog Site is a unique single site across Enterprise account,
+     * This site will hold all Blog posts related to the Marketing product.
+     */
+    SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE"
+}
+/** Site transferred to another user. */
+export interface SiteTransferred {
+    /** A previous owner id (user that transfers meta site). */
+    oldOwnerId?: string;
+    /** A new owner id (user that accepts meta site). */
+    newOwnerId?: string;
+}
+/** Soft deletion of the meta site. Could be restored. */
+export interface SiteDeleted {
+    /** A deletion context. */
+    deleteContext?: DeleteContext;
+}
+export interface DeleteContext {
+    /** When the meta site was deleted. */
+    dateDeleted?: Date | null;
+    /** A status. */
+    deleteStatus?: DeleteStatus;
+    /** A reason (flow). */
+    deleteOrigin?: string;
+    /** A service that deleted it. */
+    initiatorId?: string | null;
+}
+export declare enum DeleteStatus {
+    UNKNOWN = "UNKNOWN",
+    TRASH = "TRASH",
+    DELETED = "DELETED",
+    PENDING_PURGE = "PENDING_PURGE"
+}
+/** Restoration of the meta site. */
+export interface SiteUndeleted {
+}
+/** First publish of a meta site. Or subsequent publish after unpublish. */
+export interface SitePublished {
+}
+export interface SiteUnpublished {
+    /** A list of URLs previously associated with the meta site. */
+    urls?: string[];
+}
+export interface SiteMarkedAsTemplate {
+}
+export interface SiteMarkedAsWixSite {
+}
+/**
+ * Represents a service provisioned a site.
+ *
+ * Note on `origin_instance_id`:
+ * There is no guarantee that you will be able to find a meta site using `origin_instance_id`.
+ * This is because of the following scenario:
+ *
+ * Imagine you have a template where a third-party application (TPA) includes some stub data,
+ * such as a product catalog. When you create a site from this template, you inherit this
+ * default product catalog. However, if the template's product catalog is modified,
+ * your site will retain the catalog as it was at the time of site creation. This ensures that
+ * your site remains consistent with what you initially received and does not include any
+ * changes made to the original template afterward.
+ * To ensure this, the TPA on the template gets a new instance_id.
+ */
+export interface ServiceProvisioned {
+    /** Either UUID or EmbeddedServiceType. */
+    appDefId?: string;
+    /** Not only UUID. Something here could be something weird. */
+    instanceId?: string;
+    /** An instance id from which this instance is originated. */
+    originInstanceId?: string;
+    /** A version. */
+    version?: string | null;
+    /** The origin meta site id */
+    originMetaSiteId?: string | null;
+}
+export interface ServiceRemoved {
+    /** Either UUID or EmbeddedServiceType. */
+    appDefId?: string;
+    /** Not only UUID. Something here could be something weird. */
+    instanceId?: string;
+    /** A version. */
+    version?: string | null;
+}
+/** Rename of the site. Meaning, free public url has been changed as well. */
+export interface SiteRenamed {
+    /** A new meta site name (URL slug). */
+    newSiteName?: string;
+    /** A previous meta site name (URL slug). */
+    oldSiteName?: string;
+}
+/**
+ * Hard deletion of the meta site.
+ *
+ * Could not be restored. Therefore it's desirable to cleanup data.
+ */
+export interface SiteHardDeleted {
+    /** A deletion context. */
+    deleteContext?: DeleteContext;
+}
+export interface NamespaceChanged {
+    /** A previous namespace. */
+    oldNamespace?: Namespace;
+    /** A new namespace. */
+    newNamespace?: Namespace;
+}
+/** Assigned Studio editor */
+export interface StudioAssigned {
+}
+/** Unassigned Studio editor */
+export interface StudioUnassigned {
+}
+export interface Empty {
+}
+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 AdditionalChargeNonNullableFields {
+    type: ChargeType;
+    price: string;
+}
+interface DeliveryCarrierNonNullableFields {
+    appId: string;
+    additionalCharges: AdditionalChargeNonNullableFields[];
+}
+interface DestinationNonNullableFields {
+    countryCode: string;
+    subdivisions: string[];
+}
+interface DeliveryRegionNonNullableFields {
+    deliveryCarriers: DeliveryCarrierNonNullableFields[];
+    destinations: DestinationNonNullableFields[];
+}
+interface DeliveryProfileNonNullableFields {
+    deliveryRegions: DeliveryRegionNonNullableFields[];
+}
+export interface CreateDeliveryProfileResponseNonNullableFields {
+    deliveryProfile?: DeliveryProfileNonNullableFields;
+}
+export interface GetDeliveryProfileResponseNonNullableFields {
+    deliveryProfile?: DeliveryProfileNonNullableFields;
+}
+export interface UpdateDeliveryProfileResponseNonNullableFields {
+    deliveryProfile?: DeliveryProfileNonNullableFields;
+}
+export interface QueryDeliveryProfilesResponseNonNullableFields {
+    deliveryProfiles: DeliveryProfileNonNullableFields[];
+}
+export interface AddDeliveryRegionResponseNonNullableFields {
+    deliveryProfile?: DeliveryProfileNonNullableFields;
+}
+export interface UpdateDeliveryRegionResponseNonNullableFields {
+    deliveryProfile?: DeliveryProfileNonNullableFields;
+}
+export interface RemoveDeliveryRegionResponseNonNullableFields {
+    deliveryProfile?: DeliveryProfileNonNullableFields;
+}
+export interface AddDeliveryCarrierResponseNonNullableFields {
+    deliveryProfile?: DeliveryProfileNonNullableFields;
+}
+export interface RemoveDeliveryCarrierResponseNonNullableFields {
+    deliveryProfile?: DeliveryProfileNonNullableFields;
+}
+export interface UpdateDeliveryCarrierResponseNonNullableFields {
+    deliveryProfile?: DeliveryProfileNonNullableFields;
+}
+interface DeliveryCarrierDetailsNonNullableFields {
+    id: string;
+    displayName: string;
+    toggleGetCarrierSettingsEnabled: boolean;
+    toggleUpdateCarrierActiveStatusEnabled: boolean;
+}
+export interface ListDeliveryCarrierDetailsResponseNonNullableFields {
+    deliveryCarrierDetails: DeliveryCarrierDetailsNonNullableFields[];
+}
+interface InstalledDeliveryCarrierNonNullableFields {
+    id: string;
+    displayName: string;
+    toggleGetCarrierSettingsEnabled: boolean;
+}
+export interface ListInstalledDeliveryCarriersResponseNonNullableFields {
+    installedDeliveryCarriers: InstalledDeliveryCarrierNonNullableFields[];
+}
+export interface ListDeliveryDestinationsResponseNonNullableFields {
+    destinationScope: DestinationScope;
+    destinations: DestinationNonNullableFields[];
+}
+interface ApplicationErrorNonNullableFields {
+    code: string;
+    description: string;
+}
+interface ItemMetadataNonNullableFields {
+    success: boolean;
+    error?: ApplicationErrorNonNullableFields;
+}
+interface ColumnNonNullableFields {
+    key: string;
+    name: string;
+}
+interface RowNonNullableFields {
+    key: string;
+    active: boolean;
+}
+interface DashboardTableNonNullableFields {
+    title: string;
+    columns: ColumnNonNullableFields[];
+    rows: RowNonNullableFields[];
+}
+interface DeliveryCarrierRegionalSettingsNonNullableFields {
+    deliveryRegionId: string;
+    dashboardTables: DashboardTableNonNullableFields[];
+}
+interface ListDeliveryCarriersResultNonNullableFields {
+    deliveryCarrierMetadata?: ItemMetadataNonNullableFields;
+    deliveryCarrierDetails?: DeliveryCarrierDetailsNonNullableFields;
+    deliveryCarrierRegionalSettings: DeliveryCarrierRegionalSettingsNonNullableFields[];
+}
+interface BulkActionMetadataNonNullableFields {
+    totalSuccesses: number;
+    totalFailures: number;
+    undetailedFailures: number;
+}
+export interface ListDeliveryCarriersResponseNonNullableFields {
+    results: ListDeliveryCarriersResultNonNullableFields[];
+    bulkActionMetadata?: BulkActionMetadataNonNullableFields;
+}
+export interface UpdateExtendedFieldsResponseNonNullableFields {
+    deliveryProfile?: DeliveryProfileNonNullableFields;
+}
+export {};