@wix/auto_sdk_loyalty_earning-rules 1.0.4 → 1.0.6

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

@@ -1,902 +0,0 @@
-/**
- * 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?: Status;
-    /**
-     * 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"
-}
-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?: LoyaltyEarningRuleTypeTagType;
-}
-export declare enum LoyaltyEarningRuleTypeTagType {
-    /** Type is unknown or not specified. */
-    UNKNOWN_TYPE = "UNKNOWN_TYPE",
-    /** Earning rule for a customer's birthday. */
-    BIRTHDAY = "BIRTHDAY"
-}
-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: Type;
-    /** 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"
-}
-/** 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;
-    /**
-     * 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 {
-    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 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?: WebhookIdentityType;
-}
-/** @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"
-}
-interface FixedAmountConfigNonNullableFields {
-    points: number;
-}
-interface FixedAmountNonNullableFields {
-    configs: FixedAmountConfigNonNullableFields[];
-}
-interface ConversionRateConfigNonNullableFields {
-    moneyAmount: number;
-    points: number;
-}
-interface ConversionRateNonNullableFields {
-    configs: ConversionRateConfigNonNullableFields[];
-}
-interface LoyaltyEarningRuleTypeTagNonNullableFields {
-    ruleType: LoyaltyEarningRuleTypeTagType;
-}
-interface MetadataNonNullableFields {
-    canBeDeleted: boolean;
-    /** @internal */
-    ruleTypeTag?: LoyaltyEarningRuleTypeTagNonNullableFields;
-}
-export interface LoyaltyEarningRuleNonNullableFields {
-    fixedAmount?: FixedAmountNonNullableFields;
-    conversionRate?: ConversionRateNonNullableFields;
-    sourceAppId: string;
-    triggerAppId: string;
-    triggerActivityType: string;
-    title: string;
-    status: Status;
-    metadata?: MetadataNonNullableFields;
-}
-export interface CreateLoyaltyEarningRuleResponseNonNullableFields {
-    earningRule?: LoyaltyEarningRuleNonNullableFields;
-}
-interface ApplicationErrorNonNullableFields {
-    code: string;
-    description: string;
-}
-interface ItemMetadataNonNullableFields {
-    originalIndex: number;
-    success: boolean;
-    error?: ApplicationErrorNonNullableFields;
-}
-interface BulkLoyaltyEarningRuleResultNonNullableFields {
-    itemMetadata?: ItemMetadataNonNullableFields;
-    item?: LoyaltyEarningRuleNonNullableFields;
-}
-interface BulkActionMetadataNonNullableFields {
-    totalSuccesses: number;
-    totalFailures: number;
-    undetailedFailures: number;
-}
-export interface BulkCreateLoyaltyEarningRulesResponseNonNullableFields {
-    results: BulkLoyaltyEarningRuleResultNonNullableFields[];
-    bulkActionMetadata?: BulkActionMetadataNonNullableFields;
-}
-export interface CreateCustomLoyaltyEarningRuleResponseNonNullableFields {
-    earningRule?: LoyaltyEarningRuleNonNullableFields;
-}
-export interface GetLoyaltyEarningRuleResponseNonNullableFields {
-    earningRule?: LoyaltyEarningRuleNonNullableFields;
-}
-export interface UpdateLoyaltyEarningRuleResponseNonNullableFields {
-    earningRule?: LoyaltyEarningRuleNonNullableFields;
-}
-export interface ListEarningRulesResponseNonNullableFields {
-    earningRules: LoyaltyEarningRuleNonNullableFields[];
-}
-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 {
-    /**
-     * 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;
-}
-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;
-/**
- * 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: LoyaltyEarningRule): Promise<LoyaltyEarningRule & LoyaltyEarningRuleNonNullableFields>;
-/**
- * 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: LoyaltyEarningRule[]): Promise<BulkCreateLoyaltyEarningRulesResponse & BulkCreateLoyaltyEarningRulesResponseNonNullableFields>;
-/**
- * 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: Type, options?: CreateCustomLoyaltyEarningRuleOptions): Promise<CreateCustomLoyaltyEarningRuleResponse & CreateCustomLoyaltyEarningRuleResponseNonNullableFields>;
-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<LoyaltyEarningRule & LoyaltyEarningRuleNonNullableFields>;
-/**
- * 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 | null, earningRule: UpdateLoyaltyEarningRule): Promise<UpdateLoyaltyEarningRuleResponse & UpdateLoyaltyEarningRuleResponseNonNullableFields>;
-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?: Status;
-    /**
-     * 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<ListEarningRulesResponse & ListEarningRulesResponseNonNullableFields>;
-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 {};