@wix/auto_sdk_loyalty_earning-rules 1.0.6 → 1.0.8

package/build/internal/meta.d.ts

@@ -1,322 +0,0 @@
-import { k as CreateLoyaltyEarningRuleRequest$1, l as CreateLoyaltyEarningRuleResponse$1, m as BulkCreateLoyaltyEarningRulesRequest$1, B as BulkCreateLoyaltyEarningRulesResponse$1, p as CreateCustomLoyaltyEarningRuleRequest$1, a as CreateCustomLoyaltyEarningRuleResponse$1, G as GetLoyaltyEarningRuleRequest$1, s as GetLoyaltyEarningRuleResponse$1, t as UpdateLoyaltyEarningRuleRequest$1, b as UpdateLoyaltyEarningRuleResponse$1, u as DeleteLoyaltyEarningRuleRequest$1, v as DeleteLoyaltyEarningRuleResponse$1, w as DeleteAutomationEarningRuleRequest$1, x as DeleteAutomationEarningRuleResponse$1, y as ListEarningRulesRequest$1, d as ListEarningRulesResponse$1 } from './loyalty-v1-loyalty-earning-rule-earning-rules.universal-DOjaPKYu.js';
-
-/**
- * A loyalty earning rule defines how customers earn points in a loyalty program.
- * You can create rules for different activities, such as making purchases.
- */
-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 */
-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. */
-interface FixedAmount {
-    /**
-     * Fixed amount configurations for each tier.
-     * @maxSize 21
-     */
-    configs?: FixedAmountConfig[];
-}
-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.
- */
-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;
-}
-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;
-}
-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"
-}
-interface Metadata {
-    /** Whether the earning rule can be deleted. */
-    canBeDeleted?: boolean;
-}
-interface CreateLoyaltyEarningRuleRequest {
-    /** Earning rule to create. */
-    earningRule: LoyaltyEarningRule;
-}
-interface CreateLoyaltyEarningRuleResponse {
-    /** Created earning rule. */
-    earningRule?: LoyaltyEarningRule;
-}
-interface BulkCreateLoyaltyEarningRulesRequest {
-    /**
-     * Earning rules to create.
-     * @minSize 1
-     * @maxSize 100
-     */
-    earningRules: LoyaltyEarningRule[];
-}
-interface BulkCreateLoyaltyEarningRulesResponse {
-    /** Created earning rules. */
-    results?: BulkLoyaltyEarningRuleResult[];
-    /** Additional metadata for the created earning rules. */
-    bulkActionMetadata?: BulkActionMetadata;
-}
-interface BulkLoyaltyEarningRuleResult {
-    /** Additional metadata for the created earning rules. */
-    itemMetadata?: ItemMetadata;
-    /** Created earning rule. */
-    item?: LoyaltyEarningRule;
-}
-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;
-}
-interface ApplicationError {
-    /** Error code. */
-    code?: string;
-    /** Description of the error. */
-    description?: string;
-    /** Data related to the error. */
-    data?: Record<string, any> | null;
-}
-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;
-}
-interface CreateCustomLoyaltyEarningRuleRequest {
-    /** Type of the custom earning rule. */
-    type: Type;
-    /** Custom earning rule to create. */
-    earningRule?: CustomLoyaltyEarningRule;
-}
-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 */
-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 */
-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;
-}
-interface CreateCustomLoyaltyEarningRuleResponse {
-    /** Created earning rule. */
-    earningRule?: LoyaltyEarningRule;
-}
-interface GetLoyaltyEarningRuleRequest {
-    /**
-     * ID of the earning rule to retrieve.
-     * @format GUID
-     */
-    id: string;
-}
-interface GetLoyaltyEarningRuleResponse {
-    /** Retrieved earning rule. */
-    earningRule?: LoyaltyEarningRule;
-}
-interface UpdateLoyaltyEarningRuleRequest {
-    /** Earning rule to update. */
-    earningRule: LoyaltyEarningRule;
-}
-interface UpdateLoyaltyEarningRuleResponse {
-    /** The updated earning rule. */
-    earningRule?: LoyaltyEarningRule;
-}
-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;
-}
-interface DeleteLoyaltyEarningRuleResponse {
-}
-interface DeleteAutomationEarningRuleRequest {
-    /**
-     * ID of the earning rule to delete.
-     * @format GUID
-     */
-    id: string;
-}
-interface DeleteAutomationEarningRuleResponse {
-}
-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;
-}
-interface ListEarningRulesResponse {
-    /** Retrieved earning rules. */
-    earningRules?: LoyaltyEarningRule[];
-}
-
-type __PublicMethodMetaInfo<K = string, M = unknown, T = unknown, S = unknown, Q = unknown, R = unknown> = {
-    getUrl: (context: any) => string;
-    httpMethod: K;
-    path: string;
-    pathParams: M;
-    __requestType: T;
-    __originalRequestType: S;
-    __responseType: Q;
-    __originalResponseType: R;
-};
-declare function createLoyaltyEarningRule(): __PublicMethodMetaInfo<'POST', {}, CreateLoyaltyEarningRuleRequest$1, CreateLoyaltyEarningRuleRequest, CreateLoyaltyEarningRuleResponse$1, CreateLoyaltyEarningRuleResponse>;
-declare function bulkCreateLoyaltyEarningRules(): __PublicMethodMetaInfo<'POST', {}, BulkCreateLoyaltyEarningRulesRequest$1, BulkCreateLoyaltyEarningRulesRequest, BulkCreateLoyaltyEarningRulesResponse$1, BulkCreateLoyaltyEarningRulesResponse>;
-declare function createCustomLoyaltyEarningRule(): __PublicMethodMetaInfo<'POST', {}, CreateCustomLoyaltyEarningRuleRequest$1, CreateCustomLoyaltyEarningRuleRequest, CreateCustomLoyaltyEarningRuleResponse$1, CreateCustomLoyaltyEarningRuleResponse>;
-declare function getLoyaltyEarningRule(): __PublicMethodMetaInfo<'GET', {
-    id: string;
-}, GetLoyaltyEarningRuleRequest$1, GetLoyaltyEarningRuleRequest, GetLoyaltyEarningRuleResponse$1, GetLoyaltyEarningRuleResponse>;
-declare function updateLoyaltyEarningRule(): __PublicMethodMetaInfo<'PUT', {
-    earningRuleId: string;
-}, UpdateLoyaltyEarningRuleRequest$1, UpdateLoyaltyEarningRuleRequest, UpdateLoyaltyEarningRuleResponse$1, UpdateLoyaltyEarningRuleResponse>;
-declare function deleteLoyaltyEarningRule(): __PublicMethodMetaInfo<'DELETE', {
-    id: string;
-}, DeleteLoyaltyEarningRuleRequest$1, DeleteLoyaltyEarningRuleRequest, DeleteLoyaltyEarningRuleResponse$1, DeleteLoyaltyEarningRuleResponse>;
-declare function deleteAutomationEarningRule(): __PublicMethodMetaInfo<'DELETE', {
-    id: string;
-}, DeleteAutomationEarningRuleRequest$1, DeleteAutomationEarningRuleRequest, DeleteAutomationEarningRuleResponse$1, DeleteAutomationEarningRuleResponse>;
-declare function listEarningRules(): __PublicMethodMetaInfo<'GET', {}, ListEarningRulesRequest$1, ListEarningRulesRequest, ListEarningRulesResponse$1, ListEarningRulesResponse>;
-
-export { type __PublicMethodMetaInfo, bulkCreateLoyaltyEarningRules, createCustomLoyaltyEarningRule, createLoyaltyEarningRule, deleteAutomationEarningRule, deleteLoyaltyEarningRule, getLoyaltyEarningRule, listEarningRules, updateLoyaltyEarningRule };