@wix/auto_sdk_loyalty_earning-rules 1.0.11 → 1.0.12

package/build/internal/es/src/loyalty-v1-loyalty-earning-rule-earning-rules.universal.d.ts

@@ -1,1299 +0,0 @@
-import { NonNullablePaths } from '@wix/sdk-types';
-/**
- * A loyalty earning rule defines how customers earn points in a loyalty program.
- * You can create rules for different activities, such as making purchases.
- */
-export interface LoyaltyEarningRule extends LoyaltyEarningRuleTypeOneOf {
-    /** Fixed amount of points awarded for each qualifying activity. */
-    fixedAmount?: FixedAmount;
-    /** Points awarded based on a conversion rate formula: `(amount spent) / (money_amount * points)`. */
-    conversionRate?: ConversionRate;
-    /**
-     * Loyalty earning rule ID.
-     * @format GUID
-     * @readonly
-     */
-    _id?: string | null;
-    /**
-     * ID of the app managing the earning rule. Can be a loyalty app ID or a Wix automations app ID.
-     * @format GUID
-     */
-    sourceAppId?: string;
-    /**
-     * ID of the app that triggers point assignment. Examples: Wix Stores, Wix Bookings, Wix Events.
-     * @minLength 1
-     * @maxLength 80
-     */
-    triggerAppId?: string;
-    /**
-     * Type of activity that triggers point assignment. For example, `wix-restaurants/orderSubmitted` or `birthday`.
-     * @minLength 1
-     * @maxLength 80
-     */
-    triggerActivityType?: string;
-    /**
-     * Name of the earning rule.
-     * @minLength 1
-     * @maxLength 50
-     */
-    title?: string;
-    /** Current status of the earning rule. */
-    status?: StatusWithLiterals;
-    /**
-     * Revision number, incremented by 1 each time the earning rule is updated.
-     * Pass the latest revision when updating to prevent conflicting changes.
-     */
-    revision?: string | null;
-    /**
-     * Date and time the earning rule was created.
-     * @readonly
-     */
-    _createdDate?: Date | null;
-    /**
-     * Date and time the earning rule was last updated.
-     * @readonly
-     */
-    _updatedDate?: Date | null;
-    /**
-     * Additional metadata about the earning rule.
-     * @readonly
-     */
-    metadata?: Metadata;
-}
-/** @oneof */
-export interface LoyaltyEarningRuleTypeOneOf {
-    /** Fixed amount of points awarded for each qualifying activity. */
-    fixedAmount?: FixedAmount;
-    /** Points awarded based on a conversion rate formula: `(amount spent) / (money_amount * points)`. */
-    conversionRate?: ConversionRate;
-}
-/** Fixed amount type of earning rule. */
-export interface FixedAmount {
-    /**
-     * Fixed amount configurations for each tier.
-     * @maxSize 21
-     */
-    configs?: FixedAmountConfig[];
-}
-export interface FixedAmountConfig {
-    /**
-     * Tier ID. If empty, the [base tier](https://dev.wix.com/docs/rest/crm/loyalty-program/tiers/introduction#terminology) is used.
-     * @format GUID
-     * @readonly
-     */
-    tierId?: string | null;
-    /** Number of points to award. */
-    points?: number;
-}
-/**
- * Conversion rate type of earning rule.
- * Customers earn points based on the amount spent.
- * For example, for every $10 spent, a customer might earn 1 point.
- */
-export interface ConversionRate {
-    /**
-     * Conversion rate configurations for each tier.
-     *
-     * Points are awarded proportionally to the amount spent.
-     *
-     * Formula: `(amount spent) / (money_amount * points)`.
-     * @maxSize 21
-     */
-    configs?: ConversionRateConfig[];
-    /**
-     * Specifies which field in the Wix automations trigger payload [REST](https://dev.wix.com/docs/rest/business-management/automations/introduction#how-do-automations-work)|[SDK](https://dev.wix.com/docs/sdk/backend-modules/automations/triggered-events/reporting-and-canceling-events) to use for calculating points in conversion rate rules.
-     * For example, if set to "priceSummary.totalAmount", the rule uses the total order amount to calculate loyalty points to be awarded.
-     * This field is only applicable for automated earning rules.
-     */
-    field?: string | null;
-}
-export interface ConversionRateConfig {
-    /**
-     * Tier ID. If empty, the [base tier](https://dev.wix.com/docs/rest/crm/loyalty-program/tiers/introduction) is used.
-     * @format GUID
-     * @readonly
-     */
-    tierId?: string | null;
-    /**
-     * The amount of money used as a reference for point calculation.
-     * Points are awarded proportionally to the amount spent.
-     *
-     * For example, if set to 10, 1 point is awarded for every 10 units of currency spent (assuming `points` is set to 1).
-     *
-     * Formula for points is: `(amount spent) / (money_amount * points)`.
-     */
-    moneyAmount?: number;
-    /**
-     * Points given for the specified `money_amount`.
-     * Works in conjunction with `money_amount` to define the earning rule.
-     *
-     * For example: If `money_amount` is 20 and `points` is 10:
-     * - Spending 10 units of currency earns 5 points
-     * - Spending 20 units of currency earns 10 points
-     * - Spending 30 units of currency earns 15 points
-     */
-    points?: number;
-}
-export declare enum Status {
-    /** Status is unknown or not specified. */
-    UNKNOWN = "UNKNOWN",
-    /** Earning rule is active and can assign points. */
-    ACTIVE = "ACTIVE",
-    /** Earning rule is paused and can't assign points. */
-    PAUSED = "PAUSED"
-}
-/** @enumType */
-export type StatusWithLiterals = Status | 'UNKNOWN' | 'ACTIVE' | 'PAUSED';
-export interface Metadata {
-    /** Whether the earning rule can be deleted. */
-    canBeDeleted?: boolean;
-    /**
-     * Information about the type of custom earning rule.
-     * @internal
-     */
-    ruleTypeTag?: LoyaltyEarningRuleTypeTag;
-}
-export interface LoyaltyEarningRuleTypeTag {
-    /** Type of custom earning rule. */
-    ruleType?: LoyaltyEarningRuleTypeTagTypeWithLiterals;
-}
-export declare enum LoyaltyEarningRuleTypeTagType {
-    /** Type is unknown or not specified. */
-    UNKNOWN_TYPE = "UNKNOWN_TYPE",
-    /** Earning rule for a customer's birthday. */
-    BIRTHDAY = "BIRTHDAY"
-}
-/** @enumType */
-export type LoyaltyEarningRuleTypeTagTypeWithLiterals = LoyaltyEarningRuleTypeTagType | 'UNKNOWN_TYPE' | 'BIRTHDAY';
-export interface CacheInvalidated {
-}
-export interface EarningRuleDisabled {
-}
-export interface CreateLoyaltyEarningRuleRequest {
-    /** Earning rule to create. */
-    earningRule: LoyaltyEarningRule;
-}
-export interface CreateLoyaltyEarningRuleResponse {
-    /** Created earning rule. */
-    earningRule?: LoyaltyEarningRule;
-}
-export interface BulkCreateLoyaltyEarningRulesRequest {
-    /**
-     * Earning rules to create.
-     * @minSize 1
-     * @maxSize 100
-     */
-    earningRules: LoyaltyEarningRule[];
-}
-export interface BulkCreateLoyaltyEarningRulesResponse {
-    /** Created earning rules. */
-    results?: BulkLoyaltyEarningRuleResult[];
-    /** Additional metadata for the created earning rules. */
-    bulkActionMetadata?: BulkActionMetadata;
-}
-export interface BulkLoyaltyEarningRuleResult {
-    /** Additional metadata for the created earning rules. */
-    itemMetadata?: ItemMetadata;
-    /** Created earning rule. */
-    item?: LoyaltyEarningRule;
-}
-export interface ItemMetadata {
-    /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
-    _id?: string | null;
-    /** Index of the item within the request array. Allows for correlation between request and response items. */
-    originalIndex?: number;
-    /** 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 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 CreateCustomLoyaltyEarningRuleRequest {
-    /** Type of the custom earning rule. */
-    type: TypeWithLiterals;
-    /** Custom earning rule to create. */
-    earningRule?: CustomLoyaltyEarningRule;
-}
-export declare enum Type {
-    /** Unknown type. This value is not used. */
-    UNKNOWN_TYPE = "UNKNOWN_TYPE",
-    /** Earning rule for social media. */
-    SOCIAL_MEDIA = "SOCIAL_MEDIA",
-    /** Earning rule for birthdays. */
-    BIRTHDAY = "BIRTHDAY"
-}
-/** @enumType */
-export type TypeWithLiterals = Type | 'UNKNOWN_TYPE' | 'SOCIAL_MEDIA' | 'BIRTHDAY';
-/** Used in CreateCustomLoyaltyEarningRuleRequest */
-export interface CustomLoyaltyEarningRule extends CustomLoyaltyEarningRuleTypeOneOf {
-    /** Fixed amount of points awarded for each qualifying activity. */
-    fixedAmount?: FixedAmount;
-    /** Points awarded based on a conversion rate formula: `(amount spent) / (money_amount * points)`. */
-    conversionRate?: ConversionRate;
-    /**
-     * Name of the earning rule.
-     * @minLength 1
-     * @maxLength 50
-     */
-    title?: string;
-}
-/** @oneof */
-export interface CustomLoyaltyEarningRuleTypeOneOf {
-    /** Fixed amount of points awarded for each qualifying activity. */
-    fixedAmount?: FixedAmount;
-    /** Points awarded based on a conversion rate formula: `(amount spent) / (money_amount * points)`. */
-    conversionRate?: ConversionRate;
-}
-export interface CreateCustomLoyaltyEarningRuleResponse {
-    /** Created earning rule. */
-    earningRule?: LoyaltyEarningRule;
-}
-export interface GetLoyaltyEarningRuleRequest {
-    /**
-     * ID of the earning rule to retrieve.
-     * @format GUID
-     */
-    _id: string;
-}
-export interface GetLoyaltyEarningRuleResponse {
-    /** Retrieved earning rule. */
-    earningRule?: LoyaltyEarningRule;
-}
-export interface UpdateLoyaltyEarningRuleRequest {
-    /** Earning rule to update. */
-    earningRule: LoyaltyEarningRule;
-}
-export interface UpdateLoyaltyEarningRuleResponse {
-    /** The updated earning rule. */
-    earningRule?: LoyaltyEarningRule;
-}
-export interface DeleteLoyaltyEarningRuleRequest {
-    /**
-     * ID of the earning rule to delete.
-     * @format GUID
-     */
-    _id: string;
-    /**
-     * Revision of the earning rule. Incremented by 1 each time the earning rule is updated.
-     * Pass the latest revision when updating to prevent conflicting changes.
-     */
-    revision?: string;
-}
-export interface DeleteLoyaltyEarningRuleResponse {
-}
-export interface DeleteAutomationEarningRuleRequest {
-    /**
-     * ID of the earning rule to delete.
-     * @format GUID
-     */
-    _id: string;
-}
-export interface DeleteAutomationEarningRuleResponse {
-}
-export interface ListEarningRulesRequest {
-    /** App ID that triggers the point assignment. For example, `9a5d83fd-8570-482e-81ab-cfa88942ee60`. */
-    triggerAppId?: string | null;
-    /** Type of activity that triggers the point assignment. For example, `restaurants-order-is-pending`. */
-    triggerActivityType?: string | null;
-}
-export interface ListEarningRulesResponse {
-    /** Retrieved earning rules. */
-    earningRules?: LoyaltyEarningRule[];
-}
-export interface ListEarningRulesInTierRequest {
-    /**
-     * ID of the tier for which the earning rules will be returned.
-     * @format GUID
-     */
-    tierId?: string | null;
-    /** Pagination options. */
-    paging?: CursorPaging;
-}
-export interface CursorPaging {
-    /**
-     * Maximum number of items to return in the results.
-     * @max 100
-     */
-    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.
-     * @maxLength 16000
-     */
-    cursor?: string | null;
-}
-export interface ListEarningRulesInTierResponse {
-    /** Retrieved earning rules. */
-    earningRules?: LoyaltyEarningRule[];
-    /** Details on the paged set of results returned. */
-    pagingMetadata?: PagingMetadataV2;
-}
-export interface PagingMetadataV2 {
-    /** Number of items returned in the response. */
-    count?: number | null;
-    /** Offset that was requested. */
-    offset?: number | null;
-    /** Total number of items that match the query. Returned if offset paging is used and the `tooManyToCount` flag is not set. */
-    total?: number | null;
-    /** Flag that indicates the server failed to calculate the `total` field. */
-    tooManyToCount?: boolean | null;
-    /** Cursors to navigate through the result pages using `next` and `prev`. Returned if cursor paging is used. */
-    cursors?: Cursors;
-}
-export interface Cursors {
-    /**
-     * Cursor string pointing to the next page in the list of results.
-     * @maxLength 16000
-     */
-    next?: string | null;
-    /**
-     * Cursor pointing to the previous page in the list of results.
-     * @maxLength 16000
-     */
-    prev?: string | null;
-}
-export interface DomainEvent extends DomainEventBodyOneOf {
-    createdEvent?: EntityCreatedEvent;
-    updatedEvent?: EntityUpdatedEvent;
-    deletedEvent?: EntityDeletedEvent;
-    actionEvent?: ActionEvent;
-    /** 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;
-}
-/** @oneof */
-export interface DomainEventBodyOneOf {
-    createdEvent?: EntityCreatedEvent;
-    updatedEvent?: EntityUpdatedEvent;
-    deletedEvent?: EntityDeletedEvent;
-    actionEvent?: ActionEvent;
-}
-export interface EntityCreatedEvent {
-    entity?: string;
-}
-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.
-     */
-    currentEntity?: string;
-}
-export interface EntityDeletedEvent {
-    /** Entity that was deleted. */
-    deletedEntity?: string | null;
-}
-export interface ActionEvent {
-    body?: string;
-}
-export interface Empty {
-}
-export interface InvalidateEarningRuleCacheRequest {
-}
-export interface InvalidateEarningRuleCacheResponse {
-}
-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;
-    /**
-     * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
-     * the actual URL.
-     *
-     * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
-     * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
-     */
-    urlChanged?: SiteUrlChanged;
-    /** Site is marked as PurgedExternally */
-    sitePurgedExternally?: SitePurgedExternally;
-    /** Emitted when Odeditor is attached. */
-    odeditorAssigned?: OdeditorAssigned;
-    /** Emitted when Odeditor is detached. */
-    odeditorUnassigned?: OdeditorUnassigned;
-    /** Emitted when Picasso is attached. */
-    picassoAssigned?: PicassoAssigned;
-    /** Emitted when Picasso is detached. */
-    picassoUnassigned?: PicassoUnassigned;
-    /**
-     * A meta site id.
-     * @format GUID
-     */
-    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
-     * @maxSize 4000
-     */
-    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;
-    /**
-     * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
-     * the actual URL.
-     *
-     * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
-     * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
-     */
-    urlChanged?: SiteUrlChanged;
-    /** Site is marked as PurgedExternally */
-    sitePurgedExternally?: SitePurgedExternally;
-    /** Emitted when Odeditor is attached. */
-    odeditorAssigned?: OdeditorAssigned;
-    /** Emitted when Odeditor is detached. */
-    odeditorUnassigned?: OdeditorUnassigned;
-    /** Emitted when Picasso is attached. */
-    picassoAssigned?: PicassoAssigned;
-    /** Emitted when Picasso is detached. */
-    picassoUnassigned?: PicassoUnassigned;
-}
-export interface Asset {
-    /**
-     * An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
-     * @maxLength 36
-     */
-    appDefId?: string;
-    /**
-     * An instance id. For legacy reasons may be UUID or a string.
-     * @maxLength 200
-     */
-    instanceId?: string;
-    /** An application state. */
-    state?: StateWithLiterals;
-}
-export declare enum State {
-    UNKNOWN = "UNKNOWN",
-    ENABLED = "ENABLED",
-    DISABLED = "DISABLED",
-    PENDING = "PENDING",
-    DEMO = "DEMO"
-}
-/** @enumType */
-export type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'PENDING' | 'DEMO';
-export interface SiteCreated {
-    /**
-     * A template identifier (empty if not created from a template).
-     * @maxLength 36
-     */
-    originTemplateId?: string;
-    /**
-     * An account id of the owner.
-     * @format GUID
-     */
-    ownerId?: string;
-    /** A context in which meta site was created. */
-    context?: SiteCreatedContextWithLiterals;
-    /**
-     * 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.
-     * @format GUID
-     */
-    originMetaSiteId?: string | null;
-    /**
-     * A meta site name (URL slug).
-     * @maxLength 20
-     */
-    siteName?: string;
-    /** A namespace. */
-    namespace?: NamespaceWithLiterals;
-}
-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"
-}
-/** @enumType */
-export type SiteCreatedContextWithLiterals = SiteCreatedContext | 'OTHER' | 'FROM_TEMPLATE' | 'DUPLICATE_BY_SITE_TRANSFER' | 'DUPLICATE' | 'OLD_SITE_TRANSFER' | '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",
-    /** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
-    STANDALONE_FORMS = "STANDALONE_FORMS",
-    /** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
-    STANDALONE_EVENTS = "STANDALONE_EVENTS",
-    /** MIMIR - Siteless account for MIMIR Ai Job runner. */
-    MIMIR = "MIMIR"
-}
-/** @enumType */
-export type NamespaceWithLiterals = Namespace | 'UNKNOWN_NAMESPACE' | 'WIX' | 'SHOUT_OUT' | 'ALBUMS' | 'WIX_STORES_TEST_DRIVE' | 'HOTELS' | 'CLUBS' | 'ONBOARDING_DRAFT' | 'DEV_SITE' | 'LOGOS' | 'VIDEO_MAKER' | 'PARTNER_DASHBOARD' | 'DEV_CENTER_COMPANY' | 'HTML_DRAFT' | 'SITELESS_BUSINESS' | 'CREATOR_ECONOMY' | 'DASHBOARD_FIRST' | 'ANYWHERE' | 'HEADLESS' | 'ACCOUNT_MASTER_CMS' | 'RISE' | 'BRANDED_FIRST' | 'NOWNIA' | 'UGC_TEMPLATE' | 'CODUX' | 'MEDIA_DESIGN_CREATOR' | 'SHARED_BLOG_ENTERPRISE' | 'STANDALONE_FORMS' | 'STANDALONE_EVENTS' | 'MIMIR';
-/** Site transferred to another user. */
-export interface SiteTransferred {
-    /**
-     * A previous owner id (user that transfers meta site).
-     * @format GUID
-     */
-    oldOwnerId?: string;
-    /**
-     * A new owner id (user that accepts meta site).
-     * @format GUID
-     */
-    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?: DeleteStatusWithLiterals;
-    /**
-     * A reason (flow).
-     * @maxLength 255
-     */
-    deleteOrigin?: string;
-    /**
-     * A service that deleted it.
-     * @maxLength 255
-     */
-    initiatorId?: string | null;
-}
-export declare enum DeleteStatus {
-    UNKNOWN = "UNKNOWN",
-    TRASH = "TRASH",
-    DELETED = "DELETED",
-    PENDING_PURGE = "PENDING_PURGE",
-    PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
-}
-/** @enumType */
-export type DeleteStatusWithLiterals = DeleteStatus | 'UNKNOWN' | 'TRASH' | 'DELETED' | 'PENDING_PURGE' | 'PURGED_EXTERNALLY';
-/** 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.
-     * @maxLength 4000
-     * @maxSize 10000
-     */
-    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.
-     * @maxLength 36
-     */
-    appDefId?: string;
-    /**
-     * Not only UUID. Something here could be something weird.
-     * @maxLength 36
-     */
-    instanceId?: string;
-    /**
-     * An instance id from which this instance is originated.
-     * @maxLength 36
-     */
-    originInstanceId?: string;
-    /**
-     * A version.
-     * @maxLength 500
-     */
-    version?: string | null;
-    /**
-     * The origin meta site id
-     * @format GUID
-     */
-    originMetaSiteId?: string | null;
-}
-export interface ServiceRemoved {
-    /**
-     * Either UUID or EmbeddedServiceType.
-     * @maxLength 36
-     */
-    appDefId?: string;
-    /**
-     * Not only UUID. Something here could be something weird.
-     * @maxLength 36
-     */
-    instanceId?: string;
-    /**
-     * A version.
-     * @maxLength 500
-     */
-    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).
-     * @maxLength 20
-     */
-    newSiteName?: string;
-    /**
-     * A previous meta site name (URL slug).
-     * @maxLength 255
-     */
-    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?: NamespaceWithLiterals;
-    /** A new namespace. */
-    newNamespace?: NamespaceWithLiterals;
-}
-/** Assigned Studio editor */
-export interface StudioAssigned {
-}
-/** Unassigned Studio editor */
-export interface StudioUnassigned {
-}
-/**
- * Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
- *
- * This is an internal event, it's not propagated in special events, because it's non-actionable. If you need to keep up
- * with sites and its urls, you need to listen to another topic/event. Read about it:
- *
- * https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
- */
-export interface SiteUrlChanged {
-}
-/**
- * Used at the end of the deletion flow for both draft sites and when a user deletes a site.
- * Consumed by other teams to remove relevant data.
- */
-export interface SitePurgedExternally {
-    /**
-     * @maxLength 2048
-     * @maxSize 100
-     * @deprecated
-     * @targetRemovalDate 2025-04-15
-     */
-    appDefId?: string[];
-}
-/** Assigned Odeditor */
-export interface OdeditorAssigned {
-}
-/** Unassigned Odeditor */
-export interface OdeditorUnassigned {
-}
-/** Assigned Picasso editor */
-export interface PicassoAssigned {
-}
-/** Unassigned Picasso */
-export interface PicassoUnassigned {
-}
-export interface MessageEnvelope {
-    /**
-     * App instance ID.
-     * @format GUID
-     */
-    instanceId?: string | null;
-    /**
-     * Event type.
-     * @maxLength 150
-     */
-    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.
-     * @format GUID
-     */
-    anonymousVisitorId?: string;
-    /**
-     * ID of a site visitor that has logged in to the site.
-     * @format GUID
-     */
-    memberId?: string;
-    /**
-     * ID of a Wix user (site owner, contributor, etc.).
-     * @format GUID
-     */
-    wixUserId?: string;
-    /**
-     * ID of an app.
-     * @format GUID
-     */
-    appId?: string;
-    /** @readonly */
-    identityType?: WebhookIdentityTypeWithLiterals;
-}
-/** @oneof */
-export interface IdentificationDataIdOneOf {
-    /**
-     * ID of a site visitor that has not logged in to the site.
-     * @format GUID
-     */
-    anonymousVisitorId?: string;
-    /**
-     * ID of a site visitor that has logged in to the site.
-     * @format GUID
-     */
-    memberId?: string;
-    /**
-     * ID of a Wix user (site owner, contributor, etc.).
-     * @format GUID
-     */
-    wixUserId?: string;
-    /**
-     * ID of an app.
-     * @format GUID
-     */
-    appId?: string;
-}
-export declare enum WebhookIdentityType {
-    UNKNOWN = "UNKNOWN",
-    ANONYMOUS_VISITOR = "ANONYMOUS_VISITOR",
-    MEMBER = "MEMBER",
-    WIX_USER = "WIX_USER",
-    APP = "APP"
-}
-/** @enumType */
-export type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
-export interface BaseEventMetadata {
-    /**
-     * App instance ID.
-     * @format GUID
-     */
-    instanceId?: string | null;
-    /**
-     * Event type.
-     * @maxLength 150
-     */
-    eventType?: string;
-    /** The identification type and identity data. */
-    identity?: IdentificationData;
-}
-export 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;
-}
-export interface LoyaltyEarningRuleCreatedEnvelope {
-    entity: LoyaltyEarningRule;
-    metadata: EventMetadata;
-}
-/**
- * Triggered when an earning rule is created.
- * @permissionScope Read Loyalty
- * @permissionScopeId SCOPE.DC-LOYALTY.READ-LOYALTY
- * @permissionScope Manage Loyalty
- * @permissionScopeId SCOPE.DC-LOYALTY.MANAGE-LOYALTY
- * @permissionScope Manage Restaurants - all permissions
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
- * @permissionId LOYALTY.READ_EARNING_RULES
- * @webhook
- * @eventType wix.loyalty.v1.loyalty_earning_rule_created
- * @slug created
- */
-export declare function onLoyaltyEarningRuleCreated(handler: (event: LoyaltyEarningRuleCreatedEnvelope) => void | Promise<void>): void;
-export interface LoyaltyEarningRuleDeletedEnvelope {
-    metadata: EventMetadata;
-}
-/**
- * Triggered when an earning rule is deleted.
- * @permissionScope Read Loyalty
- * @permissionScopeId SCOPE.DC-LOYALTY.READ-LOYALTY
- * @permissionScope Manage Loyalty
- * @permissionScopeId SCOPE.DC-LOYALTY.MANAGE-LOYALTY
- * @permissionScope Manage Restaurants - all permissions
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
- * @permissionId LOYALTY.READ_EARNING_RULES
- * @webhook
- * @eventType wix.loyalty.v1.loyalty_earning_rule_deleted
- * @slug deleted
- */
-export declare function onLoyaltyEarningRuleDeleted(handler: (event: LoyaltyEarningRuleDeletedEnvelope) => void | Promise<void>): void;
-export interface LoyaltyEarningRuleUpdatedEnvelope {
-    entity: LoyaltyEarningRule;
-    metadata: EventMetadata;
-}
-/**
- * Triggered when an earning rule is updated.
- * @permissionScope Read Loyalty
- * @permissionScopeId SCOPE.DC-LOYALTY.READ-LOYALTY
- * @permissionScope Manage Loyalty
- * @permissionScopeId SCOPE.DC-LOYALTY.MANAGE-LOYALTY
- * @permissionScope Manage Restaurants - all permissions
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
- * @permissionId LOYALTY.READ_EARNING_RULES
- * @webhook
- * @eventType wix.loyalty.v1.loyalty_earning_rule_updated
- * @slug updated
- */
-export declare function onLoyaltyEarningRuleUpdated(handler: (event: LoyaltyEarningRuleUpdatedEnvelope) => void | Promise<void>): void;
-type LoyaltyEarningRuleNonNullablePaths = `fixedAmount.configs` | `fixedAmount.configs.${number}.points` | `conversionRate.configs` | `conversionRate.configs.${number}.moneyAmount` | `conversionRate.configs.${number}.points` | `sourceAppId` | `triggerAppId` | `triggerActivityType` | `title` | `status` | `metadata.canBeDeleted`;
-/**
- * Creates a non-automated earning rule.
- *
- * >**Note**: You can only create non-automated earning rules from a supported list.
- * For the supported list of services, see the introduction.
- * @param earningRule - Earning rule to create.
- * @public
- * @requiredField earningRule
- * @requiredField earningRule.sourceAppId
- * @requiredField earningRule.status
- * @requiredField earningRule.title
- * @requiredField earningRule.triggerActivityType
- * @requiredField earningRule.triggerAppId
- * @requiredField earningRule.type
- * @permissionId LOYALTY.MANAGE_EARNING_RULES
- * @permissionScope Manage Loyalty
- * @permissionScopeId SCOPE.DC-LOYALTY.MANAGE-LOYALTY
- * @permissionScope Manage Restaurants - all permissions
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
- * @applicableIdentity APP
- * @returns Created earning rule.
- * @fqn com.wixpress.loyalty.earningrule.LoyaltyEarningRules.CreateLoyaltyEarningRule
- */
-export declare function createLoyaltyEarningRule(earningRule: NonNullablePaths<LoyaltyEarningRule, `sourceAppId` | `status` | `title` | `triggerActivityType` | `triggerAppId`>): Promise<NonNullablePaths<LoyaltyEarningRule, LoyaltyEarningRuleNonNullablePaths>>;
-/**
- * Creates multiple non-automated earning rules.
- *
- * >**Note**: You can only create non-automated earning rules from a supported list.
- * For the supported list of services, see the introduction.
- * @param earningRules - Earning rules to create.
- * @public
- * @requiredField earningRules
- * @requiredField earningRules.sourceAppId
- * @requiredField earningRules.status
- * @requiredField earningRules.title
- * @requiredField earningRules.triggerActivityType
- * @requiredField earningRules.triggerAppId
- * @requiredField earningRules.type
- * @permissionId LOYALTY.MANAGE_EARNING_RULES
- * @permissionScope Manage Loyalty
- * @permissionScopeId SCOPE.DC-LOYALTY.MANAGE-LOYALTY
- * @permissionScope Manage Restaurants - all permissions
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
- * @applicableIdentity APP
- * @fqn com.wixpress.loyalty.earningrule.LoyaltyEarningRules.BulkCreateLoyaltyEarningRules
- */
-export declare function bulkCreateLoyaltyEarningRules(earningRules: NonNullablePaths<LoyaltyEarningRule, `sourceAppId` | `status` | `title` | `triggerActivityType` | `triggerAppId`>[]): Promise<NonNullablePaths<BulkCreateLoyaltyEarningRulesResponse, `results` | `results.${number}.itemMetadata.originalIndex` | `results.${number}.itemMetadata.success` | `results.${number}.itemMetadata.error.code` | `results.${number}.itemMetadata.error.description` | {
-    [P in LoyaltyEarningRuleNonNullablePaths]: `results.${number}.item.${P}`;
-}[LoyaltyEarningRuleNonNullablePaths] | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`>>;
-/**
- * Creates a custom automated earning rule.
- *
- * To learn more about the automated rules, read the introduction.
- * @param type - Type of the custom earning rule.
- * @public
- * @requiredField type
- * @permissionId LOYALTY.MANAGE_EARNING_RULES
- * @permissionScope Manage Loyalty
- * @permissionScopeId SCOPE.DC-LOYALTY.MANAGE-LOYALTY
- * @permissionScope Manage Restaurants - all permissions
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
- * @applicableIdentity APP
- * @fqn com.wixpress.loyalty.earningrule.LoyaltyEarningRules.CreateCustomLoyaltyEarningRule
- */
-export declare function createCustomLoyaltyEarningRule(type: TypeWithLiterals, options?: CreateCustomLoyaltyEarningRuleOptions): Promise<NonNullablePaths<CreateCustomLoyaltyEarningRuleResponse, {
-    [P in LoyaltyEarningRuleNonNullablePaths]: `earningRule.${P}`;
-}[LoyaltyEarningRuleNonNullablePaths]>>;
-export interface CreateCustomLoyaltyEarningRuleOptions {
-    /** Custom earning rule to create. */
-    earningRule?: CustomLoyaltyEarningRule;
-}
-/**
- * Retrieves a specified non-automated earning rule.
- * @param _id - ID of the earning rule to retrieve.
- * @public
- * @requiredField _id
- * @permissionId LOYALTY.READ_EARNING_RULES
- * @permissionScope Read Loyalty
- * @permissionScopeId SCOPE.DC-LOYALTY.READ-LOYALTY
- * @permissionScope Manage Loyalty
- * @permissionScopeId SCOPE.DC-LOYALTY.MANAGE-LOYALTY
- * @permissionScope Manage Restaurants - all permissions
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
- * @applicableIdentity APP
- * @applicableIdentity VISITOR
- * @returns Retrieved earning rule.
- * @fqn com.wixpress.loyalty.earningrule.LoyaltyEarningRules.GetLoyaltyEarningRule
- */
-export declare function getLoyaltyEarningRule(_id: string): Promise<NonNullablePaths<LoyaltyEarningRule, LoyaltyEarningRuleNonNullablePaths>>;
-/**
- * Updates an earning rule.
- *
- * Supports partial updates.
- *
- * Revision number, which increments by 1 each time the earning rule is updated. To prevent conflicting changes,
- * the current revision must be passed when updating the earning rule.
- * @param _id - Loyalty earning rule ID.
- * @public
- * @requiredField _id
- * @requiredField earningRule
- * @permissionId LOYALTY.MANAGE_EARNING_RULES
- * @permissionScope Manage Loyalty
- * @permissionScopeId SCOPE.DC-LOYALTY.MANAGE-LOYALTY
- * @permissionScope Manage Restaurants - all permissions
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
- * @applicableIdentity APP
- * @fqn com.wixpress.loyalty.earningrule.LoyaltyEarningRules.UpdateLoyaltyEarningRule
- */
-export declare function updateLoyaltyEarningRule(_id: string, earningRule: UpdateLoyaltyEarningRule): Promise<NonNullablePaths<UpdateLoyaltyEarningRuleResponse, {
-    [P in LoyaltyEarningRuleNonNullablePaths]: `earningRule.${P}`;
-}[LoyaltyEarningRuleNonNullablePaths]>>;
-export interface UpdateLoyaltyEarningRule {
-    /** Fixed amount of points awarded for each qualifying activity. */
-    fixedAmount?: FixedAmount;
-    /** Points awarded based on a conversion rate formula: `(amount spent) / (money_amount * points)`. */
-    conversionRate?: ConversionRate;
-    /**
-     * Loyalty earning rule ID.
-     * @format GUID
-     * @readonly
-     */
-    _id?: string | null;
-    /**
-     * ID of the app managing the earning rule. Can be a loyalty app ID or a Wix automations app ID.
-     * @format GUID
-     */
-    sourceAppId?: string;
-    /**
-     * ID of the app that triggers point assignment. Examples: Wix Stores, Wix Bookings, Wix Events.
-     * @minLength 1
-     * @maxLength 80
-     */
-    triggerAppId?: string;
-    /**
-     * Type of activity that triggers point assignment. For example, `wix-restaurants/orderSubmitted` or `birthday`.
-     * @minLength 1
-     * @maxLength 80
-     */
-    triggerActivityType?: string;
-    /**
-     * Name of the earning rule.
-     * @minLength 1
-     * @maxLength 50
-     */
-    title?: string;
-    /** Current status of the earning rule. */
-    status?: StatusWithLiterals;
-    /**
-     * Revision number, incremented by 1 each time the earning rule is updated.
-     * Pass the latest revision when updating to prevent conflicting changes.
-     */
-    revision?: string | null;
-    /**
-     * Date and time the earning rule was created.
-     * @readonly
-     */
-    _createdDate?: Date | null;
-    /**
-     * Date and time the earning rule was last updated.
-     * @readonly
-     */
-    _updatedDate?: Date | null;
-    /**
-     * Additional metadata about the earning rule.
-     * @readonly
-     */
-    metadata?: Metadata;
-}
-/**
- * Deletes a non-automated earning rule.
- * @param _id - ID of the earning rule to delete.
- * @public
- * @requiredField _id
- * @permissionId LOYALTY.MANAGE_EARNING_RULES
- * @permissionScope Manage Loyalty
- * @permissionScopeId SCOPE.DC-LOYALTY.MANAGE-LOYALTY
- * @permissionScope Manage Restaurants - all permissions
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
- * @applicableIdentity APP
- * @fqn com.wixpress.loyalty.earningrule.LoyaltyEarningRules.DeleteLoyaltyEarningRule
- */
-export declare function deleteLoyaltyEarningRule(_id: string, options?: DeleteLoyaltyEarningRuleOptions): Promise<void>;
-export interface DeleteLoyaltyEarningRuleOptions {
-    /**
-     * Revision of the earning rule. Incremented by 1 each time the earning rule is updated.
-     * Pass the latest revision when updating to prevent conflicting changes.
-     */
-    revision?: string;
-}
-/**
- * Deletes a custom automated earning rule.
- *
- * > **Note:** Pre-installed automated rules can only be paused, not deleted.
- * @param _id - ID of the earning rule to delete.
- * @public
- * @requiredField _id
- * @permissionId LOYALTY.MANAGE_EARNING_RULES
- * @permissionScope Manage Loyalty
- * @permissionScopeId SCOPE.DC-LOYALTY.MANAGE-LOYALTY
- * @permissionScope Manage Restaurants - all permissions
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
- * @applicableIdentity APP
- * @fqn com.wixpress.loyalty.earningrule.LoyaltyEarningRules.DeleteAutomationEarningRule
- */
-export declare function deleteAutomationEarningRule(_id: string): Promise<void>;
-/**
- * Retrieves a list of earning rules.
- *
- * Returns both automated and non-automated earning rules.
- *
- * You can filter the results by `triggerAppId` or `triggerActivityType`.
- * @public
- * @permissionId LOYALTY.READ_EARNING_RULES
- * @permissionScope Read Loyalty
- * @permissionScopeId SCOPE.DC-LOYALTY.READ-LOYALTY
- * @permissionScope Manage Loyalty
- * @permissionScopeId SCOPE.DC-LOYALTY.MANAGE-LOYALTY
- * @permissionScope Manage Restaurants - all permissions
- * @permissionScopeId SCOPE.RESTAURANTS.MEGA-SCOPES
- * @applicableIdentity APP
- * @applicableIdentity VISITOR
- * @fqn com.wixpress.loyalty.earningrule.LoyaltyEarningRules.ListEarningRules
- */
-export declare function listEarningRules(options?: ListEarningRulesOptions): Promise<NonNullablePaths<ListEarningRulesResponse, {
-    [P in LoyaltyEarningRuleNonNullablePaths]: `earningRules.${number}.${P}`;
-}[LoyaltyEarningRuleNonNullablePaths]>>;
-export interface ListEarningRulesOptions {
-    /** App ID that triggers the point assignment. For example, `9a5d83fd-8570-482e-81ab-cfa88942ee60`. */
-    triggerAppId?: string | null;
-    /** Type of activity that triggers the point assignment. For example, `restaurants-order-is-pending`. */
-    triggerActivityType?: string | null;
-}
-export {};