@snagsolutions/sdk 0.1.0-alpha.10 → 0.1.0-alpha.101

package/resources/loyalty/rules.d.ts

@@ -3,34 +3,91 @@ import * as Core from "../../core.js";
 export declare class Rules extends APIResource {
     /**
      * Create a new Loyalty Rule
+     *
+     * @example
+     * ```ts
+     * const rule = await client.loyalty.rules.create({
+     *   amount: '10.5',
+     *   effectiveEndTime: '2024-12-31T23:59:00Z',
+     *   effectiveStartTime: '2024-01-01T00:00:00Z',
+     *   endTime: '2024-12-31T23:59:00Z',
+     *   frequency: 'daily',
+     *   loyaltyCurrencyId: '456e1234-e89b-12d3-a456-426614174003',
+     *   metadata: {},
+     *   name: 'Referral Bonus Rule',
+     *   organizationId: '123e4567-e89b-12d3-a456-426614174001',
+     *   startTime: '2024-01-01T00:00:00Z',
+     *   type: 'Bonus',
+     *   websiteId: '123e4567-e89b-12d3-a456-426614174002',
+     * });
+     * ```
      */
     create(body: RuleCreateParams, options?: Core.RequestOptions): Core.APIPromise<RuleCreateResponse>;
     /**
      * Update an existing Loyalty Rule
+     *
+     * @example
+     * ```ts
+     * const rule = await client.loyalty.rules.update(
+     *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     *   {
+     *     amount: '10.5',
+     *     endTime: '2024-12-31T23:59:00Z',
+     *     name: 'Daily Rewards Program',
+     *   },
+     * );
+     * ```
      */
     update(id: string, body: RuleUpdateParams, options?: Core.RequestOptions): Core.APIPromise<RuleUpdateResponse>;
     /**
      * Retrieve configured loyalty rules with optional pagination and filters
+     *
+     * @example
+     * ```ts
+     * const rules = await client.loyalty.rules.list();
+     * ```
      */
     list(query?: RuleListParams, options?: Core.RequestOptions): Core.APIPromise<RuleListResponse>;
     list(options?: Core.RequestOptions): Core.APIPromise<RuleListResponse>;
     /**
      * Delete an existing Loyalty Rule
-     */
+     *
+     * @example
+     * ```ts
+     * const rule = await client.loyalty.rules.delete(
+     *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     * );
+     * ```
+     */
+    delete(id: string, params?: RuleDeleteParams, options?: Core.RequestOptions): Core.APIPromise<RuleDeleteResponse>;
     delete(id: string, options?: Core.RequestOptions): Core.APIPromise<RuleDeleteResponse>;
     /**
      * Verify a loyalty rule based on user action and reward them if applicable. This
-     * endpoint currenlty onlu supports following rule types code_entry, text_input,
+     * endpoint currently only supports following rule types code_entry, text_input,
      * link_click, discord_member, connect_wallet, check_in, external_rule,
      * drip_x_follow, drip_x_new_tweet, drip_x_text_in_bio, drip_x_text_in_name,
-     * drip_x_text_in_comment, drip_x_tweet, telegram_join
+     * drip_x_text_in_comment, drip_x_tweet, telegram_join, DiscordMessages,
+     * youtube_subscribers, youtube_comment, steam_wishlist
+     *
+     * @example
+     * ```ts
+     * const response = await client.loyalty.rules.complete(
+     *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+     * );
+     * ```
      */
     complete(id: string, body?: RuleCompleteParams, options?: Core.RequestOptions): Core.APIPromise<RuleCompleteResponse>;
     complete(id: string, options?: Core.RequestOptions): Core.APIPromise<RuleCompleteResponse>;
     /**
      * This will return the processing status of quests for a specific user
-     */
-    status(query: RuleStatusParams, options?: Core.RequestOptions): Core.APIPromise<RuleStatusResponse>;
+     *
+     * @example
+     * ```ts
+     * const response = await client.loyalty.rules.getStatus();
+     * ```
+     */
+    getStatus(query?: RuleGetStatusParams, options?: Core.RequestOptions): Core.APIPromise<RuleGetStatusResponse>;
+    getStatus(options?: Core.RequestOptions): Core.APIPromise<RuleGetStatusResponse>;
 }
 export interface RuleCreateResponse {
     id: string;
@@ -77,7 +134,7 @@ export interface RuleCreateResponse {
     /**
      * Type of loyalty rule being created
      */
-    type: 'Bonus' | 'BoughtOn' | 'BoughtWithRoyalties' | 'DiscordMessages' | 'Listing' | 'Lodging' | 'MintOn' | 'PoapClaim' | 'SnagSocialsConnected' | 'SnapshotFullset' | 'SnapshotHold' | 'SoldOn' | 'SoldWithRoyalties' | 'TokenHold' | 'TwitterBio' | 'TwitterHashTagPost' | 'Retweet' | 'check_in' | 'code_entry' | 'connect_wallet' | 'connected_discord' | 'connected_email' | 'connected_epic' | 'connected_steam' | 'connected_telegram' | 'connected_twitter' | 'create_partner_account' | 'discord_member' | 'drip_x_follow' | 'drip_x_new_tweet' | 'drip_x_text_in_bio' | 'drip_x_text_in_comment' | 'drip_x_text_in_name' | 'drip_x_tweet' | 'external_rule' | 'link_click' | 'manual_upload' | 'profile_completed' | 'referred_user' | 'smart_contract_event' | 'snapshot_governance' | 'telegram_join' | 'telegram_messages' | 'text_input' | 'token_hold_erc20' | 'tweet_liked_by_project' | 'twitter_comment' | 'twitter_follow' | 'twitter_followers' | 'twitter_like' | 'twitter_post_hashtag';
+    type: 'Bonus' | 'BoughtOn' | 'BoughtWithRoyalties' | 'DiscordMessages' | 'Listing' | 'Lodging' | 'MintOn' | 'PoapClaim' | 'SnagSocialsConnected' | 'SnapshotFullset' | 'SnapshotHold' | 'SoldOn' | 'SoldWithRoyalties' | 'TokenHold' | 'TwitterBio' | 'TwitterHashTagPost' | 'Retweet' | 'check_in' | 'code_entry' | 'connect_wallet' | 'connected_discord' | 'connected_email' | 'connected_epic' | 'connected_steam' | 'connected_telegram' | 'connected_twitter' | 'create_partner_account' | 'discord_member' | 'drip_x_follow' | 'drip_x_new_tweet' | 'drip_x_text_in_bio' | 'drip_x_text_in_comment' | 'drip_x_text_in_name' | 'drip_x_tweet' | 'external_rule' | 'link_click' | 'manual_upload' | 'profile_completed' | 'referred_user' | 'smart_contract_event' | 'snapshot_governance' | 'telegram_join' | 'telegram_messages' | 'text_input' | 'token_hold_erc20' | 'tweet_liked_by_project' | 'twitter_comment' | 'twitter_follow' | 'twitter_followers' | 'twitter_like' | 'twitter_post_hashtag' | 'quiz' | 'poll' | 'steam_wishlist' | 'liquidity_uniswap_v2' | 'liquidity_uniswap_v3' | 'points_airdrop' | 'youtube_subscribers' | 'youtube_comment' | 'shopify_spend' | 'swap' | 'tiktok_post';
     /**
      * Unique identifier for the associated website
      */
@@ -106,6 +163,10 @@ export interface RuleCreateResponse {
      * Optional detailed description of the rule
      */
     description?: string;
+    /**
+     * ID of the external integration
+     */
+    externalIntegrationId?: string | null;
     /**
      * Whether to hide this rule in the user interface
      */
@@ -113,19 +174,41 @@ export interface RuleCreateResponse {
     /**
      * Interval between rule executions
      */
-    interval?: 'daily' | 'weekly' | 'monthly' | 'once' | null;
+    interval?: 'daily' | 'weekly' | 'monthly' | 'once' | 'custom' | 'every_message' | null;
     /**
      * Whether this rule is mandatory
      */
     isRequired?: boolean;
+    /**
+     * Unique identifier for the loyalty badge
+     */
+    loyaltyBadgeId?: string | null;
     /**
      * Unique identifier for the loyalty rule group
      */
     loyaltyRuleGroupId?: 'no-section' | (string & {}) | null;
+    /**
+     * URL for uploading loyalty user allotment via CSV
+     */
+    loyaltyUserAllotmentCsvUrl?: string;
+    /**
+     * The interval for the max amount. Available for the smart contract and external
+     * rules.
+     */
+    maxAmountInterval?: 'daily' | 'weekly' | 'monthly' | 'lifetime' | null;
+    /**
+     * The maximum amount of points a user can earn per interval. Available for the
+     * smart contract and external rules.
+     */
+    maxAmountPerInterval?: number | null;
+    /**
+     * URL of the media to be displayed
+     */
+    mediaUrl?: string | null;
     /**
      * Blockchain network where the rule will apply
      */
-    network?: 'mainnet' | 'polygon' | 'polygon_mumbai' | 'optimism' | 'arbitrum' | 'binance' | 'bscTestnet' | 'avalanche' | 'avalancheFuji' | 'zksync' | 'fantom' | 'fantomTestnet' | 'base' | 'baseSepolia' | 'skaleNebula' | 'xai' | 'berachainArtio' | 'solana' | 'apechain' | 'flowMainnet' | 'campTestnet' | 'sui' | 'vanar' | 'sepolia' | 'optimism_sepolia' | 'arbitrumSepolia' | 'goerli' | 'optimism_goerli' | 'arbitrumGoerli';
+    network?: 'abstract' | 'abstractTestnet' | 'apechain' | 'arbitrum' | 'avalanche' | 'avalancheFuji' | 'base' | 'baseSepolia' | 'berachain' | 'berachainArtio' | 'berachainBepolia' | 'binance' | 'bscTestnet' | 'campTestnet' | 'fantom' | 'fantomTestnet' | 'flowMainnet' | 'mainnet' | 'optimism' | 'polygon' | 'polygon_mumbai' | 'skaleNebula' | 'solana' | 'sophon' | 'sophonTestnet' | 'sui' | 'superseed' | 'superseedSepolia' | 'vanar' | 'xai' | 'zksync' | 'coti' | 'cotiTestnet' | 'morph' | 'morphTestnet' | 'morphHolesky' | 'sepolia' | 'optimism_sepolia' | 'arbitrumSepolia' | 'goerli' | 'optimism_goerli' | 'arbitrumGoerli' | 'basecamp';
     /**
      * OAuth credentials associated with the rule
      */
@@ -133,17 +216,25 @@ export interface RuleCreateResponse {
     /**
      * Type of reward issued by the rule
      */
-    rewardType?: 'points' | 'multiplier';
+    rewardType?: 'points' | 'multiplier' | 'badge';
+    /**
+     * URL of the Shopify store
+     */
+    shopifyStoreUrl?: string | null;
     /**
-     * Identifier for associated subscriptions
+     * Optional subscription id for the rule
      */
-    subscriptionIdentifier?: string | null;
+    subscriptionId?: string | null;
 }
 export declare namespace RuleCreateResponse {
     /**
      * Additional metadata for the loyalty rule
      */
     interface Metadata {
+        /**
+         * Number of tokens per batch.
+         */
+        batchSize?: number | null;
         /**
          * Text displayed on the action button.
          */
@@ -168,6 +259,12 @@ export declare namespace RuleCreateResponse {
          * Array of collections associated with the rule.
          */
         collection?: Array<Metadata.Collection>;
+        /**
+         * Conditions for completing the profile.
+         */
+        completeProfileConditions?: {
+            [key: string]: boolean;
+        } | null;
         /**
          * Object containing details for the call-to-action.
          */
@@ -196,10 +293,18 @@ export declare namespace RuleCreateResponse {
          * Flag indicating whether the verified multiplier is enabled.
          */
         enableVerifiedMultiplier?: boolean;
+        /**
+         * Fill source of the order for the token sale
+         */
+        fillSource?: string;
         /**
          * Percentage reward given to a user for their first referral.
          */
         firstReferralReward?: number | null;
+        /**
+         * Flag indicating whether the fill source is included.
+         */
+        hasFillSource?: boolean;
         /**
          * Indicates if the item has never been sold.
          */
@@ -220,10 +325,18 @@ export declare namespace RuleCreateResponse {
          * URL of the image associated with the rule.
          */
         imageUrl?: string | null;
+        /**
+         * If enabled, the first transaction done on the platform will complete this rule
+         */
+        isCheckInOnEveryTxn?: boolean;
         /**
          * Indicates if the multiplier has been applied to rewards.
          */
         isMultiplierApplied?: boolean;
+        /**
+         * Flag indicating if the rule is restricted to new users.
+         */
+        isRestrictedToNewUsers?: boolean;
         /**
          * Flag indicating if rewards are applied retroactively.
          */
@@ -236,6 +349,10 @@ export declare namespace RuleCreateResponse {
          * Optional link associated with the metadata.
          */
         link?: string | null;
+        /**
+         * Liquidity pool details.
+         */
+        liquidity?: Metadata.Liquidity;
         /**
          * Maximum quantity constraint for token holding.
          */
@@ -260,10 +377,30 @@ export declare namespace RuleCreateResponse {
          * Flag indicating whether to include only non-listed items.
          */
         onlyNonListed?: boolean;
+        /**
+         * Indicates if only existing users are rewarded.
+         */
+        onlyRewardExistingUser?: boolean;
+        /**
+         * give points for only one token ownership per contract
+         */
+        onlyRewardSingleTokenOwnership?: boolean | null;
         /**
          * Promotional code associated with the rule.
          */
         promoCode?: string;
+        /**
+         * URL of the CSV file containing promo codes.
+         */
+        promoCodeCsvUrl?: string;
+        /**
+         * Numbers of the promotional code to be generated.
+         */
+        promoCodeLength?: number | null;
+        /**
+         * Type of the promotional code.
+         */
+        promoCodeType?: 'code' | 'csv' | 'generate';
         /**
          * Array defining ranges and corresponding rewards.
          */
@@ -276,10 +413,27 @@ export declare namespace RuleCreateResponse {
          * Lump sum reward given to a referrer.
          */
         referrerReward?: number | null;
+        /**
+         * Loyalty currency ID of the referrer reward.
+         */
+        referrerRewardLoyaltyCurrencyId?: string | null;
+        /**
+         * Flag indicating if the rule can also reward badges per range.
+         */
+        rewardBadgePerRange?: boolean;
+        /**
+         * Flag indicating if the reward is rewarded by batch.
+         */
+        rewardByBatch?: boolean | null;
         /**
          * Flag indicating if rewards are given per impression.
          */
         rewardPerImpression?: boolean | null;
+        /**
+         * Flag indicating if the rule should reward based on value of traded tokens
+         * instead of count.
+         */
+        rewardPerValue?: boolean;
         /**
          * Currency associated with sales.
          */
@@ -288,6 +442,10 @@ export declare namespace RuleCreateResponse {
          * Percentage reward given for a second-level referral.
          */
         secondReferralReward?: number | null;
+        /**
+         * Flag indicating if the multiplier is skipped.
+         */
+        skipMultiplier?: boolean | null;
         /**
          * Object containing details of the associated smart contract.
          */
@@ -299,7 +457,7 @@ export declare namespace RuleCreateResponse {
         /**
          * Social media platform associated with the rule.
          */
-        socialPlatform?: 'Twitch' | 'TikTok' | 'X(Twitter)' | 'Instagram' | 'EpicGames' | 'YouTube' | 'Discord' | 'Custom' | null;
+        socialPlatform?: 'Custom' | 'Discord' | 'EpicGames' | 'Instagram' | 'Steam' | 'Telegram' | 'TikTok' | 'Twitch' | 'X(Twitter)' | 'YouTube' | 'Google' | null;
         /**
          * URL of the social platform's logo.
          */
@@ -308,10 +466,18 @@ export declare namespace RuleCreateResponse {
          * Name of the social platform.
          */
         socialPlatformName?: string | null;
+        /**
+         * ID of the Steam app.
+         */
+        steamAppId?: string | null;
         /**
          * Array of streak milestones and corresponding rewards.
          */
         streakArray?: Array<Metadata.StreakArray> | null;
+        /**
+         * Metadata for swap loyalty rules
+         */
+        swap?: Metadata.Swap;
         /**
          * ID of the Telegram channel.
          */
@@ -324,6 +490,11 @@ export declare namespace RuleCreateResponse {
          * Flag indicating if all contracts are tracked.
          */
         trackAllContracts?: boolean | null;
+        /**
+         * Flag indicating if the progress is tracked. If enabled, the rule can only be
+         * completed once the progress is 100%.
+         */
+        trackProgress?: boolean | null;
         /**
          * URL of the associated Twitter account.
          */
@@ -359,7 +530,15 @@ export declare namespace RuleCreateResponse {
         /**
          * Type of wallet associated with the rule.
          */
-        walletType?: 'evm' | 'solana' | 'imx' | 'sui' | 'ton' | null;
+        walletType?: 'evm' | 'solana' | 'imx' | 'sui' | 'ton' | 'cosmos' | 'ultra' | null;
+        /**
+         * ID of the Youtube channel.
+         */
+        youtubeChannelId?: string | null;
+        /**
+         * ID of the Youtube video.
+         */
+        youtubeVideoId?: string | null;
     }
     namespace Metadata {
         interface Collection {
@@ -374,7 +553,7 @@ export declare namespace RuleCreateResponse {
             /**
              * Blockchain network of the collection.
              */
-            network?: 'mainnet' | 'polygon' | 'polygon_mumbai' | 'optimism' | 'arbitrum' | 'binance' | 'bscTestnet' | 'avalanche' | 'avalancheFuji' | 'zksync' | 'fantom' | 'fantomTestnet' | 'base' | 'baseSepolia' | 'skaleNebula' | 'xai' | 'berachainArtio' | 'solana' | 'apechain' | 'flowMainnet' | 'campTestnet' | 'sui' | 'vanar' | 'sepolia' | 'optimism_sepolia' | 'arbitrumSepolia' | 'goerli' | 'optimism_goerli' | 'arbitrumGoerli';
+            network?: 'abstract' | 'abstractTestnet' | 'apechain' | 'arbitrum' | 'avalanche' | 'avalancheFuji' | 'base' | 'baseSepolia' | 'berachain' | 'berachainArtio' | 'berachainBepolia' | 'binance' | 'bscTestnet' | 'campTestnet' | 'fantom' | 'fantomTestnet' | 'flowMainnet' | 'mainnet' | 'optimism' | 'polygon' | 'polygon_mumbai' | 'skaleNebula' | 'solana' | 'sophon' | 'sophonTestnet' | 'sui' | 'superseed' | 'superseedSepolia' | 'vanar' | 'xai' | 'zksync' | 'coti' | 'cotiTestnet' | 'morph' | 'morphTestnet' | 'morphHolesky' | 'sepolia' | 'optimism_sepolia' | 'arbitrumSepolia' | 'goerli' | 'optimism_goerli' | 'arbitrumGoerli' | 'basecamp';
         }
         /**
          * Object containing details for the call-to-action.
@@ -413,6 +592,10 @@ export declare namespace RuleCreateResponse {
                  * Array of emojis used in the channel.
                  */
                 emojis?: Array<Channel.Emoji>;
+                /**
+                 * Phrase of text to be present in the discord message
+                 */
+                text?: string;
             }
             namespace Channel {
                 interface Emoji {
@@ -435,6 +618,49 @@ export declare namespace RuleCreateResponse {
              */
             id: string;
         }
+        /**
+         * Liquidity pool details.
+         */
+        interface Liquidity {
+            /**
+             * Calculation type of the liquidity pool.
+             */
+            calculationType?: 'fixed' | 'custom';
+            /**
+             * Custom function to calculate the the reward amount based on the liquidity
+             * provided per day. X is the reward amount, Y is the liquidity provided per day in
+             * USD.
+             */
+            customFunction?: string;
+            /**
+             * Liquidity provided per day in USD
+             */
+            liquidityPerDay?: number;
+            /**
+             * Blockchain network of the liquidity pool.
+             */
+            network?: 'abstract' | 'abstractTestnet' | 'apechain' | 'arbitrum' | 'avalanche' | 'avalancheFuji' | 'base' | 'baseSepolia' | 'berachain' | 'berachainArtio' | 'berachainBepolia' | 'binance' | 'bscTestnet' | 'campTestnet' | 'fantom' | 'fantomTestnet' | 'flowMainnet' | 'mainnet' | 'optimism' | 'polygon' | 'polygon_mumbai' | 'skaleNebula' | 'solana' | 'sophon' | 'sophonTestnet' | 'sui' | 'superseed' | 'superseedSepolia' | 'vanar' | 'xai' | 'zksync' | 'coti' | 'cotiTestnet' | 'morph' | 'morphTestnet' | 'morphHolesky' | 'sepolia' | 'optimism_sepolia' | 'arbitrumSepolia' | 'goerli' | 'optimism_goerli' | 'arbitrumGoerli' | 'basecamp';
+            /**
+             * Indicates if only in-range liquidity is rewarded.
+             */
+            onlyRewardInRangeLiquidity?: boolean;
+            /**
+             * Array of liquidity pools associated with the rule.
+             */
+            pools?: Array<Liquidity.Pool>;
+            /**
+             * Protocol of the liquidity pool.
+             */
+            protocol?: string;
+        }
+        namespace Liquidity {
+            interface Pool {
+                /**
+                 * Unique identifier of the liquidity pool.
+                 */
+                id: string;
+            }
+        }
         interface Range {
             /**
              * Reward amount for this range.
@@ -448,6 +674,14 @@ export declare namespace RuleCreateResponse {
              * Start value of the range.
              */
             startRange: number;
+            /**
+             * ID of the loyalty badge for this range.
+             */
+            loyaltyBadgeId?: string;
+            /**
+             * Amount of the loyalty multiplier for this range.
+             */
+            loyaltyMultiplierAmount?: number;
         }
         /**
          * Object defining referral requirements.
@@ -491,14 +725,14 @@ export declare namespace RuleCreateResponse {
          * Object containing details of the associated smart contract.
          */
         interface SmartContract {
-            /**
-             * ABI of the smart contract.
-             */
-            abi?: string | null;
             /**
              * Mapping of addresses for the smart contract.
              */
             addressMapping?: string | null;
+            /**
+             * Object containing details of the amount multiplier from the event.
+             */
+            amountMultiplier?: SmartContract.AmountMultiplier | null;
             /**
              * Array of bonus details applied to the rule.
              */
@@ -527,6 +761,10 @@ export declare namespace RuleCreateResponse {
              * Array of parameters for the smart contract.
              */
             params?: Array<SmartContract.Param> | null;
+            /**
+             * Type of the smart contract interaction.
+             */
+            type?: 'function' | 'event' | null;
             /**
              * Flag indicating if a bonus is applied.
              */
@@ -535,12 +773,17 @@ export declare namespace RuleCreateResponse {
              * Flag indicating if a custom range is applied.
              */
             withCustomRange?: boolean | null;
-            /**
-             * Flag indicating if a maximum limit is applied.
-             */
-            withMax?: boolean | null;
         }
         namespace SmartContract {
+            /**
+             * Object containing details of the amount multiplier from the event.
+             */
+            interface AmountMultiplier {
+                /**
+                 * Mapping of the value for the smart contract.
+                 */
+                valueMapping?: string | null;
+            }
             interface Bonus {
                 /**
                  * Amount of the bonus.
@@ -599,6 +842,24 @@ export declare namespace RuleCreateResponse {
              */
             streakMilestone: number;
         }
+        /**
+         * Metadata for swap loyalty rules
+         */
+        interface Swap {
+            provider?: 'any' | 'relay' | 'lifi';
+            relayReferrerId?: string;
+            requireCrossChainSwap?: boolean;
+            swappedToChain?: 'any' | number | string;
+            swappedToTokens?: Array<Swap.SwappedToToken>;
+            tokenMode?: 'any' | 'specific';
+            trackTokenAmount?: boolean;
+        }
+        namespace Swap {
+            interface SwappedToToken {
+                address: string;
+                chainId: string;
+            }
+        }
     }
     interface Collection {
         /**
@@ -608,7 +869,7 @@ export declare namespace RuleCreateResponse {
         /**
          * Blockchain network for the collection
          */
-        network: 'mainnet' | 'polygon' | 'polygon_mumbai' | 'optimism' | 'arbitrum' | 'binance' | 'bscTestnet' | 'avalanche' | 'avalancheFuji' | 'zksync' | 'fantom' | 'fantomTestnet' | 'base' | 'baseSepolia' | 'skaleNebula' | 'xai' | 'berachainArtio' | 'solana' | 'apechain' | 'flowMainnet' | 'campTestnet' | 'sui' | 'vanar' | 'sepolia' | 'optimism_sepolia' | 'arbitrumSepolia' | 'goerli' | 'optimism_goerli' | 'arbitrumGoerli';
+        network: 'abstract' | 'abstractTestnet' | 'apechain' | 'arbitrum' | 'avalanche' | 'avalancheFuji' | 'base' | 'baseSepolia' | 'berachain' | 'berachainArtio' | 'berachainBepolia' | 'binance' | 'bscTestnet' | 'campTestnet' | 'fantom' | 'fantomTestnet' | 'flowMainnet' | 'mainnet' | 'optimism' | 'polygon' | 'polygon_mumbai' | 'skaleNebula' | 'solana' | 'sophon' | 'sophonTestnet' | 'sui' | 'superseed' | 'superseedSepolia' | 'vanar' | 'xai' | 'zksync' | 'coti' | 'cotiTestnet' | 'morph' | 'morphTestnet' | 'morphHolesky' | 'sepolia' | 'optimism_sepolia' | 'arbitrumSepolia' | 'goerli' | 'optimism_goerli' | 'arbitrumGoerli' | 'basecamp';
     }
 }
 export interface RuleUpdateResponse {
@@ -617,34 +878,14 @@ export interface RuleUpdateResponse {
      * Reward amount for the loyalty rule
      */
     amount: unknown;
-    /**
-     * Effective end time of the rule
-     */
-    effectiveEndTime: string | null;
-    /**
-     * Effective start time of the rule
-     */
-    effectiveStartTime: string | null;
     /**
      * End time for the loyalty rule
      */
     endTime: string | null;
-    /**
-     * Frequency of the rule execution
-     */
-    frequency: 'none' | 'once' | 'daily' | 'weekly' | 'monthly' | 'immediately';
-    /**
-     * Additional metadata for the loyalty rule
-     */
-    metadata: RuleUpdateResponse.Metadata;
     /**
      * Name of the loyalty rule
      */
     name: string;
-    /**
-     * Start time for the loyalty rule
-     */
-    startTime: string | null;
     /**
      * Blockchain address of the associated collection
      */
@@ -665,6 +906,22 @@ export interface RuleUpdateResponse {
      * Optional description of the loyalty rule
      */
     description?: string;
+    /**
+     * Effective end time of the rule
+     */
+    effectiveEndTime?: string | null;
+    /**
+     * Effective start time of the rule
+     */
+    effectiveStartTime?: string | null;
+    /**
+     * ID of the external integration
+     */
+    externalIntegrationId?: string | null;
+    /**
+     * Frequency of the rule execution
+     */
+    frequency?: 'none' | 'once' | 'daily' | 'weekly' | 'monthly' | 'immediately';
     /**
      * Whether to hide this rule in the user interface
      */
@@ -672,7 +929,7 @@ export interface RuleUpdateResponse {
     /**
      * Time interval for recurring rule execution
      */
-    interval?: 'daily' | 'weekly' | 'monthly' | 'once' | null;
+    interval?: 'daily' | 'weekly' | 'monthly' | 'once' | 'custom' | 'every_message' | null;
     /**
      * Whether this rule is required for participation
      */
@@ -681,10 +938,28 @@ export interface RuleUpdateResponse {
      * ID of the rule group section to associate with the rule
      */
     loyaltyRuleGroupId?: (string & {}) | 'no-section' | null;
+    /**
+     * The interval for the max amount. Available for the smart contract and external
+     * rules.
+     */
+    maxAmountInterval?: 'daily' | 'weekly' | 'monthly' | 'lifetime' | null;
+    /**
+     * The maximum amount of points a user can earn per interval. Available for the
+     * smart contract and external rules.
+     */
+    maxAmountPerInterval?: number | null;
+    /**
+     * URL of the media to be displayed
+     */
+    mediaUrl?: string | null;
+    /**
+     * Additional metadata for the loyalty rule
+     */
+    metadata?: RuleUpdateResponse.Metadata;
     /**
      * Blockchain network where the rule will apply
      */
-    network?: 'mainnet' | 'polygon' | 'polygon_mumbai' | 'optimism' | 'arbitrum' | 'binance' | 'bscTestnet' | 'avalanche' | 'avalancheFuji' | 'zksync' | 'fantom' | 'fantomTestnet' | 'base' | 'baseSepolia' | 'skaleNebula' | 'xai' | 'berachainArtio' | 'solana' | 'apechain' | 'flowMainnet' | 'campTestnet' | 'sui' | 'vanar' | 'sepolia' | 'optimism_sepolia' | 'arbitrumSepolia' | 'goerli' | 'optimism_goerli' | 'arbitrumGoerli';
+    network?: 'abstract' | 'abstractTestnet' | 'apechain' | 'arbitrum' | 'avalanche' | 'avalancheFuji' | 'base' | 'baseSepolia' | 'berachain' | 'berachainArtio' | 'berachainBepolia' | 'binance' | 'bscTestnet' | 'campTestnet' | 'fantom' | 'fantomTestnet' | 'flowMainnet' | 'mainnet' | 'optimism' | 'polygon' | 'polygon_mumbai' | 'skaleNebula' | 'solana' | 'sophon' | 'sophonTestnet' | 'sui' | 'superseed' | 'superseedSepolia' | 'vanar' | 'xai' | 'zksync' | 'coti' | 'cotiTestnet' | 'morph' | 'morphTestnet' | 'morphHolesky' | 'sepolia' | 'optimism_sepolia' | 'arbitrumSepolia' | 'goerli' | 'optimism_goerli' | 'arbitrumGoerli' | 'basecamp';
     /**
      * ID for associated OAuth credentials
      */
@@ -692,17 +967,39 @@ export interface RuleUpdateResponse {
     /**
      * Type of reward issued by this rule
      */
-    rewardType?: 'points' | 'multiplier';
+    rewardType?: 'points' | 'multiplier' | 'badge';
+    /**
+     * URL of the Shopify store
+     */
+    shopifyStoreUrl?: string | null;
+    /**
+     * Start time for the loyalty rule
+     */
+    startTime?: string | null;
     /**
-     * Optional subscription identifier for the rule
+     * Optional subscription id for the rule
      */
-    subscriptionIdentifier?: string | null;
+    subscriptionId?: string | null;
 }
 export declare namespace RuleUpdateResponse {
+    interface Collection {
+        /**
+         * Blockchain address of the collection
+         */
+        address: string;
+        /**
+         * Blockchain network for the collection
+         */
+        network: 'abstract' | 'abstractTestnet' | 'apechain' | 'arbitrum' | 'avalanche' | 'avalancheFuji' | 'base' | 'baseSepolia' | 'berachain' | 'berachainArtio' | 'berachainBepolia' | 'binance' | 'bscTestnet' | 'campTestnet' | 'fantom' | 'fantomTestnet' | 'flowMainnet' | 'mainnet' | 'optimism' | 'polygon' | 'polygon_mumbai' | 'skaleNebula' | 'solana' | 'sophon' | 'sophonTestnet' | 'sui' | 'superseed' | 'superseedSepolia' | 'vanar' | 'xai' | 'zksync' | 'coti' | 'cotiTestnet' | 'morph' | 'morphTestnet' | 'morphHolesky' | 'sepolia' | 'optimism_sepolia' | 'arbitrumSepolia' | 'goerli' | 'optimism_goerli' | 'arbitrumGoerli' | 'basecamp';
+    }
     /**
      * Additional metadata for the loyalty rule
      */
     interface Metadata {
+        /**
+         * Number of tokens per batch.
+         */
+        batchSize?: number | null;
         /**
          * Text displayed on the action button.
          */
@@ -727,6 +1024,12 @@ export declare namespace RuleUpdateResponse {
          * Array of collections associated with the rule.
          */
         collection?: Array<Metadata.Collection>;
+        /**
+         * Conditions for completing the profile.
+         */
+        completeProfileConditions?: {
+            [key: string]: boolean;
+        } | null;
         /**
          * Object containing details for the call-to-action.
          */
@@ -755,10 +1058,18 @@ export declare namespace RuleUpdateResponse {
          * Flag indicating whether the verified multiplier is enabled.
          */
         enableVerifiedMultiplier?: boolean;
+        /**
+         * Fill source of the order for the token sale
+         */
+        fillSource?: string;
         /**
          * Percentage reward given to a user for their first referral.
          */
         firstReferralReward?: number | null;
+        /**
+         * Flag indicating whether the fill source is included.
+         */
+        hasFillSource?: boolean;
         /**
          * Indicates if the item has never been sold.
          */
@@ -779,10 +1090,18 @@ export declare namespace RuleUpdateResponse {
          * URL of the image associated with the rule.
          */
         imageUrl?: string | null;
+        /**
+         * If enabled, the first transaction done on the platform will complete this rule
+         */
+        isCheckInOnEveryTxn?: boolean;
         /**
          * Indicates if the multiplier has been applied to rewards.
          */
         isMultiplierApplied?: boolean;
+        /**
+         * Flag indicating if the rule is restricted to new users.
+         */
+        isRestrictedToNewUsers?: boolean;
         /**
          * Flag indicating if rewards are applied retroactively.
          */
@@ -795,6 +1114,10 @@ export declare namespace RuleUpdateResponse {
          * Optional link associated with the metadata.
          */
         link?: string | null;
+        /**
+         * Liquidity pool details.
+         */
+        liquidity?: Metadata.Liquidity;
         /**
          * Maximum quantity constraint for token holding.
          */
@@ -819,10 +1142,30 @@ export declare namespace RuleUpdateResponse {
          * Flag indicating whether to include only non-listed items.
          */
         onlyNonListed?: boolean;
+        /**
+         * Indicates if only existing users are rewarded.
+         */
+        onlyRewardExistingUser?: boolean;
+        /**
+         * give points for only one token ownership per contract
+         */
+        onlyRewardSingleTokenOwnership?: boolean | null;
         /**
          * Promotional code associated with the rule.
          */
         promoCode?: string;
+        /**
+         * URL of the CSV file containing promo codes.
+         */
+        promoCodeCsvUrl?: string;
+        /**
+         * Numbers of the promotional code to be generated.
+         */
+        promoCodeLength?: number | null;
+        /**
+         * Type of the promotional code.
+         */
+        promoCodeType?: 'code' | 'csv' | 'generate';
         /**
          * Array defining ranges and corresponding rewards.
          */
@@ -835,10 +1178,27 @@ export declare namespace RuleUpdateResponse {
          * Lump sum reward given to a referrer.
          */
         referrerReward?: number | null;
+        /**
+         * Loyalty currency ID of the referrer reward.
+         */
+        referrerRewardLoyaltyCurrencyId?: string | null;
+        /**
+         * Flag indicating if the rule can also reward badges per range.
+         */
+        rewardBadgePerRange?: boolean;
+        /**
+         * Flag indicating if the reward is rewarded by batch.
+         */
+        rewardByBatch?: boolean | null;
         /**
          * Flag indicating if rewards are given per impression.
          */
         rewardPerImpression?: boolean | null;
+        /**
+         * Flag indicating if the rule should reward based on value of traded tokens
+         * instead of count.
+         */
+        rewardPerValue?: boolean;
         /**
          * Currency associated with sales.
          */
@@ -847,6 +1207,10 @@ export declare namespace RuleUpdateResponse {
          * Percentage reward given for a second-level referral.
          */
         secondReferralReward?: number | null;
+        /**
+         * Flag indicating if the multiplier is skipped.
+         */
+        skipMultiplier?: boolean | null;
         /**
          * Object containing details of the associated smart contract.
          */
@@ -858,7 +1222,7 @@ export declare namespace RuleUpdateResponse {
         /**
          * Social media platform associated with the rule.
          */
-        socialPlatform?: 'Twitch' | 'TikTok' | 'X(Twitter)' | 'Instagram' | 'EpicGames' | 'YouTube' | 'Discord' | 'Custom' | null;
+        socialPlatform?: 'Custom' | 'Discord' | 'EpicGames' | 'Instagram' | 'Steam' | 'Telegram' | 'TikTok' | 'Twitch' | 'X(Twitter)' | 'YouTube' | 'Google' | null;
         /**
          * URL of the social platform's logo.
          */
@@ -867,10 +1231,18 @@ export declare namespace RuleUpdateResponse {
          * Name of the social platform.
          */
         socialPlatformName?: string | null;
+        /**
+         * ID of the Steam app.
+         */
+        steamAppId?: string | null;
         /**
          * Array of streak milestones and corresponding rewards.
          */
         streakArray?: Array<Metadata.StreakArray> | null;
+        /**
+         * Metadata for swap loyalty rules
+         */
+        swap?: Metadata.Swap;
         /**
          * ID of the Telegram channel.
          */
@@ -883,6 +1255,11 @@ export declare namespace RuleUpdateResponse {
          * Flag indicating if all contracts are tracked.
          */
         trackAllContracts?: boolean | null;
+        /**
+         * Flag indicating if the progress is tracked. If enabled, the rule can only be
+         * completed once the progress is 100%.
+         */
+        trackProgress?: boolean | null;
         /**
          * URL of the associated Twitter account.
          */
@@ -918,7 +1295,15 @@ export declare namespace RuleUpdateResponse {
         /**
          * Type of wallet associated with the rule.
          */
-        walletType?: 'evm' | 'solana' | 'imx' | 'sui' | 'ton' | null;
+        walletType?: 'evm' | 'solana' | 'imx' | 'sui' | 'ton' | 'cosmos' | 'ultra' | null;
+        /**
+         * ID of the Youtube channel.
+         */
+        youtubeChannelId?: string | null;
+        /**
+         * ID of the Youtube video.
+         */
+        youtubeVideoId?: string | null;
     }
     namespace Metadata {
         interface Collection {
@@ -933,7 +1318,7 @@ export declare namespace RuleUpdateResponse {
             /**
              * Blockchain network of the collection.
              */
-            network?: 'mainnet' | 'polygon' | 'polygon_mumbai' | 'optimism' | 'arbitrum' | 'binance' | 'bscTestnet' | 'avalanche' | 'avalancheFuji' | 'zksync' | 'fantom' | 'fantomTestnet' | 'base' | 'baseSepolia' | 'skaleNebula' | 'xai' | 'berachainArtio' | 'solana' | 'apechain' | 'flowMainnet' | 'campTestnet' | 'sui' | 'vanar' | 'sepolia' | 'optimism_sepolia' | 'arbitrumSepolia' | 'goerli' | 'optimism_goerli' | 'arbitrumGoerli';
+            network?: 'abstract' | 'abstractTestnet' | 'apechain' | 'arbitrum' | 'avalanche' | 'avalancheFuji' | 'base' | 'baseSepolia' | 'berachain' | 'berachainArtio' | 'berachainBepolia' | 'binance' | 'bscTestnet' | 'campTestnet' | 'fantom' | 'fantomTestnet' | 'flowMainnet' | 'mainnet' | 'optimism' | 'polygon' | 'polygon_mumbai' | 'skaleNebula' | 'solana' | 'sophon' | 'sophonTestnet' | 'sui' | 'superseed' | 'superseedSepolia' | 'vanar' | 'xai' | 'zksync' | 'coti' | 'cotiTestnet' | 'morph' | 'morphTestnet' | 'morphHolesky' | 'sepolia' | 'optimism_sepolia' | 'arbitrumSepolia' | 'goerli' | 'optimism_goerli' | 'arbitrumGoerli' | 'basecamp';
         }
         /**
          * Object containing details for the call-to-action.
@@ -972,6 +1357,10 @@ export declare namespace RuleUpdateResponse {
                  * Array of emojis used in the channel.
                  */
                 emojis?: Array<Channel.Emoji>;
+                /**
+                 * Phrase of text to be present in the discord message
+                 */
+                text?: string;
             }
             namespace Channel {
                 interface Emoji {
@@ -994,6 +1383,49 @@ export declare namespace RuleUpdateResponse {
              */
             id: string;
         }
+        /**
+         * Liquidity pool details.
+         */
+        interface Liquidity {
+            /**
+             * Calculation type of the liquidity pool.
+             */
+            calculationType?: 'fixed' | 'custom';
+            /**
+             * Custom function to calculate the the reward amount based on the liquidity
+             * provided per day. X is the reward amount, Y is the liquidity provided per day in
+             * USD.
+             */
+            customFunction?: string;
+            /**
+             * Liquidity provided per day in USD
+             */
+            liquidityPerDay?: number;
+            /**
+             * Blockchain network of the liquidity pool.
+             */
+            network?: 'abstract' | 'abstractTestnet' | 'apechain' | 'arbitrum' | 'avalanche' | 'avalancheFuji' | 'base' | 'baseSepolia' | 'berachain' | 'berachainArtio' | 'berachainBepolia' | 'binance' | 'bscTestnet' | 'campTestnet' | 'fantom' | 'fantomTestnet' | 'flowMainnet' | 'mainnet' | 'optimism' | 'polygon' | 'polygon_mumbai' | 'skaleNebula' | 'solana' | 'sophon' | 'sophonTestnet' | 'sui' | 'superseed' | 'superseedSepolia' | 'vanar' | 'xai' | 'zksync' | 'coti' | 'cotiTestnet' | 'morph' | 'morphTestnet' | 'morphHolesky' | 'sepolia' | 'optimism_sepolia' | 'arbitrumSepolia' | 'goerli' | 'optimism_goerli' | 'arbitrumGoerli' | 'basecamp';
+            /**
+             * Indicates if only in-range liquidity is rewarded.
+             */
+            onlyRewardInRangeLiquidity?: boolean;
+            /**
+             * Array of liquidity pools associated with the rule.
+             */
+            pools?: Array<Liquidity.Pool>;
+            /**
+             * Protocol of the liquidity pool.
+             */
+            protocol?: string;
+        }
+        namespace Liquidity {
+            interface Pool {
+                /**
+                 * Unique identifier of the liquidity pool.
+                 */
+                id: string;
+            }
+        }
         interface Range {
             /**
              * Reward amount for this range.
@@ -1007,6 +1439,14 @@ export declare namespace RuleUpdateResponse {
              * Start value of the range.
              */
             startRange: number;
+            /**
+             * ID of the loyalty badge for this range.
+             */
+            loyaltyBadgeId?: string;
+            /**
+             * Amount of the loyalty multiplier for this range.
+             */
+            loyaltyMultiplierAmount?: number;
         }
         /**
          * Object defining referral requirements.
@@ -1050,14 +1490,14 @@ export declare namespace RuleUpdateResponse {
          * Object containing details of the associated smart contract.
          */
         interface SmartContract {
-            /**
-             * ABI of the smart contract.
-             */
-            abi?: string | null;
             /**
              * Mapping of addresses for the smart contract.
              */
             addressMapping?: string | null;
+            /**
+             * Object containing details of the amount multiplier from the event.
+             */
+            amountMultiplier?: SmartContract.AmountMultiplier | null;
             /**
              * Array of bonus details applied to the rule.
              */
@@ -1086,6 +1526,10 @@ export declare namespace RuleUpdateResponse {
              * Array of parameters for the smart contract.
              */
             params?: Array<SmartContract.Param> | null;
+            /**
+             * Type of the smart contract interaction.
+             */
+            type?: 'function' | 'event' | null;
             /**
              * Flag indicating if a bonus is applied.
              */
@@ -1094,12 +1538,17 @@ export declare namespace RuleUpdateResponse {
              * Flag indicating if a custom range is applied.
              */
             withCustomRange?: boolean | null;
-            /**
-             * Flag indicating if a maximum limit is applied.
-             */
-            withMax?: boolean | null;
         }
         namespace SmartContract {
+            /**
+             * Object containing details of the amount multiplier from the event.
+             */
+            interface AmountMultiplier {
+                /**
+                 * Mapping of the value for the smart contract.
+                 */
+                valueMapping?: string | null;
+            }
             interface Bonus {
                 /**
                  * Amount of the bonus.
@@ -1158,16 +1607,24 @@ export declare namespace RuleUpdateResponse {
              */
             streakMilestone: number;
         }
-    }
-    interface Collection {
-        /**
-         * Blockchain address of the collection
-         */
-        address: string;
         /**
-         * Blockchain network for the collection
+         * Metadata for swap loyalty rules
          */
-        network: 'mainnet' | 'polygon' | 'polygon_mumbai' | 'optimism' | 'arbitrum' | 'binance' | 'bscTestnet' | 'avalanche' | 'avalancheFuji' | 'zksync' | 'fantom' | 'fantomTestnet' | 'base' | 'baseSepolia' | 'skaleNebula' | 'xai' | 'berachainArtio' | 'solana' | 'apechain' | 'flowMainnet' | 'campTestnet' | 'sui' | 'vanar' | 'sepolia' | 'optimism_sepolia' | 'arbitrumSepolia' | 'goerli' | 'optimism_goerli' | 'arbitrumGoerli';
+        interface Swap {
+            provider?: 'any' | 'relay' | 'lifi';
+            relayReferrerId?: string;
+            requireCrossChainSwap?: boolean;
+            swappedToChain?: 'any' | number | string;
+            swappedToTokens?: Array<Swap.SwappedToToken>;
+            tokenMode?: 'any' | 'specific';
+            trackTokenAmount?: boolean;
+        }
+        namespace Swap {
+            interface SwappedToToken {
+                address: string;
+                chainId: string;
+            }
+        }
     }
 }
 export interface RuleListResponse {
@@ -1175,9 +1632,6 @@ export interface RuleListResponse {
     hasNextPage: boolean;
 }
 export declare namespace RuleListResponse {
-    /**
-     * Schema for a loyalty rule
-     */
     interface Data {
         /**
          * Unique identifier for the loyalty rule
@@ -1195,14 +1649,38 @@ export declare namespace RuleListResponse {
          * Timestamp when the loyalty rule was deleted (if applicable)
          */
         deletedAt: string | null;
+        /**
+         * Description of the loyalty rule
+         */
+        description: string;
+        /**
+         * End time of the loyalty rule
+         */
+        endTime: string;
         /**
          * Frequency of the loyalty rule
          */
         frequency: string;
+        /**
+         * Chains attached to the loyalty rule
+         */
+        loyaltyRuleChain: Array<Data.LoyaltyRuleChain>;
+        /**
+         * Name of the loyalty rule
+         */
+        name: string;
         /**
          * Unique identifier for the organization
          */
         organizationId: string;
+        /**
+         * Type of the reward
+         */
+        rewardType: 'points' | 'multiplier' | 'badge';
+        /**
+         * Start time of the loyalty rule
+         */
+        startTime: string;
         /**
          * Type of the loyalty rule
          */
@@ -1219,10 +1697,730 @@ export declare namespace RuleListResponse {
          * Optional address of the collection
          */
         collectionAddress?: string;
+        /**
+         * URL of the media associated with the loyalty rule
+         */
+        mediaUrl?: string | null;
         /**
          * Optional metadata for the loyalty rule
          */
-        metadata?: Record<string, unknown>;
+        metadata?: {
+            [key: string]: Data.Metadata;
+        };
+    }
+    namespace Data {
+        interface LoyaltyRuleChain {
+            /**
+             * Unique identifier for the rule chain
+             */
+            id: string;
+            loyaltyConditions: Array<LoyaltyRuleChain.LoyaltyCondition>;
+            /**
+             * Unique identifier for the loyalty rule
+             */
+            loyaltyRuleId: string;
+            /**
+             * Name of the rule chain
+             */
+            name: string;
+        }
+        namespace LoyaltyRuleChain {
+            interface LoyaltyCondition {
+                /**
+                 * Unique identifier for the condition
+                 */
+                id: string;
+                /**
+                 * Amount of the condition
+                 */
+                amount: number | null;
+                association: Array<LoyaltyCondition.Association>;
+                /**
+                 * URL of the CSV file
+                 */
+                csvUrl: string | null;
+                /**
+                 * Description of the condition
+                 */
+                description: string | null;
+                /**
+                 * Number of times the condition must be met
+                 */
+                repeatCount: number | null;
+                /**
+                 * Number of times the condition must be met
+                 */
+                requiredCount: number | null;
+                /**
+                 * Type of the condition
+                 */
+                type: 'rule' | 'rules' | 'points' | 'section' | 'level' | 'api' | 'badge' | 'badges' | 'csv';
+            }
+            namespace LoyaltyCondition {
+                interface Association {
+                    /**
+                     * Unique identifier for the association
+                     */
+                    id: string;
+                    /**
+                     * Unique identifier for the loyalty badge
+                     */
+                    loyaltyBadgeId: string | null;
+                    /**
+                     * Unique identifier for the loyalty currency
+                     */
+                    loyaltyCurrencyId: string | null;
+                    loyaltyRule: Association.LoyaltyRule | null;
+                    /**
+                     * Unique identifier for the loyalty rule group
+                     */
+                    loyaltyRuleGroupId: string | null;
+                    /**
+                     * Unique identifier for the loyalty rule
+                     */
+                    loyaltyRuleId: string | null;
+                }
+                namespace Association {
+                    interface LoyaltyRule {
+                        /**
+                         * Name of the loyalty rule
+                         */
+                        name: string;
+                    }
+                }
+            }
+        }
+        interface Metadata {
+            /**
+             * Number of tokens per batch.
+             */
+            batchSize?: number | null;
+            /**
+             * Text displayed on the action button.
+             */
+            buttonText?: string | null;
+            /**
+             * Flag indicating if commenting is required.
+             */
+            checkComment?: boolean | null;
+            /**
+             * Flag indicating if liking the post is required.
+             */
+            checkLike?: boolean | null;
+            /**
+             * Flag indicating if reposting is required.
+             */
+            checkRepost?: boolean | null;
+            /**
+             * Text to check in the Twitter post, username, or bio.
+             */
+            checkText?: string | null;
+            /**
+             * Array of collections associated with the rule.
+             */
+            collection?: Array<Metadata.Collection>;
+            /**
+             * Conditions for completing the profile.
+             */
+            completeProfileConditions?: {
+                [key: string]: boolean;
+            } | null;
+            /**
+             * Object containing details for the call-to-action.
+             */
+            cta?: Metadata.Cta | null;
+            /**
+             * API key for custom rewards integration.
+             */
+            customRewardsApiKey?: string;
+            /**
+             * Array of Discord servers, channels, and roles to join.
+             */
+            discordServersToJoin?: Array<Metadata.DiscordServersToJoin> | null;
+            /**
+             * Array of drip quests required to complete the rule.
+             */
+            dripQuestsToComplete?: Array<Metadata.DripQuestsToComplete> | null;
+            /**
+             * Flag indicating whether joining Discord servers is required.
+             */
+            enableJoinDiscordServers?: boolean | null;
+            /**
+             * Flag indicating whether streaks are enabled.
+             */
+            enableStreaks?: boolean | null;
+            /**
+             * Flag indicating whether the verified multiplier is enabled.
+             */
+            enableVerifiedMultiplier?: boolean;
+            /**
+             * Fill source of the order for the token sale
+             */
+            fillSource?: string;
+            /**
+             * Percentage reward given to a user for their first referral.
+             */
+            firstReferralReward?: number | null;
+            /**
+             * Flag indicating whether the fill source is included.
+             */
+            hasFillSource?: boolean;
+            /**
+             * Indicates if the item has never been sold.
+             */
+            hasNeverSold?: boolean;
+            /**
+             * Indicates if the full royalty has been paid for items.
+             */
+            hasPaidFullRoyalty?: boolean;
+            /**
+             * Flag indicating if the sale currency is included.
+             */
+            hasSaleCurrency?: boolean;
+            /**
+             * Indicates if the user has a verified Twitter account.
+             */
+            hasVerifiedTwitter?: boolean;
+            /**
+             * URL of the image associated with the rule.
+             */
+            imageUrl?: string | null;
+            /**
+             * If enabled, the first transaction done on the platform will complete this rule
+             */
+            isCheckInOnEveryTxn?: boolean;
+            /**
+             * Indicates if the multiplier has been applied to rewards.
+             */
+            isMultiplierApplied?: boolean;
+            /**
+             * Flag indicating if the rule is restricted to new users.
+             */
+            isRestrictedToNewUsers?: boolean;
+            /**
+             * Flag indicating if rewards are applied retroactively.
+             */
+            isRetroactive?: boolean | null;
+            /**
+             * Flag indicating if the token hold multiplier is applied.
+             */
+            isTokenHoldMultiplier?: boolean;
+            /**
+             * Optional link associated with the metadata.
+             */
+            link?: string | null;
+            /**
+             * Liquidity pool details.
+             */
+            liquidity?: Metadata.Liquidity;
+            /**
+             * Maximum quantity constraint for token holding.
+             */
+            maxQty?: number | null;
+            /**
+             * Minimum quantity constraint for token holding.
+             */
+            minQty?: number | null;
+            /**
+             * Array of loyalty currency IDs used for multipliers.
+             */
+            multiplierLoyaltyCurrencyIds?: Array<string> | null;
+            /**
+             * Flag indicating whether to include only known users.
+             */
+            onlyKnownUsers?: boolean;
+            /**
+             * Flag indicating whether to include only native tokens.
+             */
+            onlyNative?: boolean;
+            /**
+             * Flag indicating whether to include only non-listed items.
+             */
+            onlyNonListed?: boolean;
+            /**
+             * Indicates if only existing users are rewarded.
+             */
+            onlyRewardExistingUser?: boolean;
+            /**
+             * give points for only one token ownership per contract
+             */
+            onlyRewardSingleTokenOwnership?: boolean | null;
+            /**
+             * Promotional code associated with the rule.
+             */
+            promoCode?: string;
+            /**
+             * URL of the CSV file containing promo codes.
+             */
+            promoCodeCsvUrl?: string;
+            /**
+             * Numbers of the promotional code to be generated.
+             */
+            promoCodeLength?: number | null;
+            /**
+             * Type of the promotional code.
+             */
+            promoCodeType?: 'code' | 'csv' | 'generate';
+            /**
+             * Array defining ranges and corresponding rewards.
+             */
+            range?: Array<Metadata.Range>;
+            /**
+             * Object defining referral requirements.
+             */
+            referralRequirements?: Metadata.ReferralRequirements | null;
+            /**
+             * Lump sum reward given to a referrer.
+             */
+            referrerReward?: number | null;
+            /**
+             * Loyalty currency ID of the referrer reward.
+             */
+            referrerRewardLoyaltyCurrencyId?: string | null;
+            /**
+             * Flag indicating if the rule can also reward badges per range.
+             */
+            rewardBadgePerRange?: boolean;
+            /**
+             * Flag indicating if the reward is rewarded by batch.
+             */
+            rewardByBatch?: boolean | null;
+            /**
+             * Flag indicating if rewards are given per impression.
+             */
+            rewardPerImpression?: boolean | null;
+            /**
+             * Flag indicating if the rule should reward based on value of traded tokens
+             * instead of count.
+             */
+            rewardPerValue?: boolean;
+            /**
+             * Currency associated with sales.
+             */
+            saleCurrency?: string;
+            /**
+             * Percentage reward given for a second-level referral.
+             */
+            secondReferralReward?: number | null;
+            /**
+             * Flag indicating if the multiplier is skipped.
+             */
+            skipMultiplier?: boolean | null;
+            /**
+             * Object containing details of the associated smart contract.
+             */
+            smartContract?: Metadata.SmartContract;
+            /**
+             * Array of snapshot proposals for the rule.
+             */
+            snapshotProposals?: Array<Metadata.SnapshotProposal> | null;
+            /**
+             * Social media platform associated with the rule.
+             */
+            socialPlatform?: 'Custom' | 'Discord' | 'EpicGames' | 'Instagram' | 'Steam' | 'Telegram' | 'TikTok' | 'Twitch' | 'X(Twitter)' | 'YouTube' | 'Google' | null;
+            /**
+             * URL of the social platform's logo.
+             */
+            socialPlatformLogo?: string | null;
+            /**
+             * Name of the social platform.
+             */
+            socialPlatformName?: string | null;
+            /**
+             * ID of the Steam app.
+             */
+            steamAppId?: string | null;
+            /**
+             * Array of streak milestones and corresponding rewards.
+             */
+            streakArray?: Array<Metadata.StreakArray> | null;
+            /**
+             * Metadata for swap loyalty rules
+             */
+            swap?: Metadata.Swap;
+            /**
+             * ID of the Telegram channel.
+             */
+            telegramChannelId?: string | null;
+            /**
+             * Time delay in seconds to verify actions.
+             */
+            timeDelayToVerifySeconds?: string | number | null;
+            /**
+             * Flag indicating if all contracts are tracked.
+             */
+            trackAllContracts?: boolean | null;
+            /**
+             * Flag indicating if the progress is tracked. If enabled, the rule can only be
+             * completed once the progress is 100%.
+             */
+            trackProgress?: boolean | null;
+            /**
+             * URL of the associated Twitter account.
+             */
+            twitterAccountUrl?: string;
+            /**
+             * Hashtag associated with the Twitter post.
+             */
+            twitterHashtag?: string;
+            /**
+             * URL of the associated Twitter post.
+             */
+            twitterPostUrl?: string;
+            /**
+             * Unique identifier of the Twitter user.
+             */
+            twitterUserId?: string;
+            /**
+             * Twitter username of the user.
+             */
+            twitterUsername?: string;
+            /**
+             * Minimum length of the verification text.
+             */
+            verificationTextMinimumLength?: number | null;
+            /**
+             * Multiplier applied to rewards for verified users.
+             */
+            verifiedMultiplier?: number | null;
+            /**
+             * Placeholder text for verification input fields.
+             */
+            verifyPlaceHolderText?: string | null;
+            /**
+             * Type of wallet associated with the rule.
+             */
+            walletType?: 'evm' | 'solana' | 'imx' | 'sui' | 'ton' | 'cosmos' | 'ultra' | null;
+            /**
+             * ID of the Youtube channel.
+             */
+            youtubeChannelId?: string | null;
+            /**
+             * ID of the Youtube video.
+             */
+            youtubeVideoId?: string | null;
+        }
+        namespace Metadata {
+            interface Collection {
+                /**
+                 * Blockchain address of the collection.
+                 */
+                address?: string;
+                /**
+                 * Multiplier applied to the rewards for this collection.
+                 */
+                multiplier?: number;
+                /**
+                 * Blockchain network of the collection.
+                 */
+                network?: 'abstract' | 'abstractTestnet' | 'apechain' | 'arbitrum' | 'avalanche' | 'avalancheFuji' | 'base' | 'baseSepolia' | 'berachain' | 'berachainArtio' | 'berachainBepolia' | 'binance' | 'bscTestnet' | 'campTestnet' | 'fantom' | 'fantomTestnet' | 'flowMainnet' | 'mainnet' | 'optimism' | 'polygon' | 'polygon_mumbai' | 'skaleNebula' | 'solana' | 'sophon' | 'sophonTestnet' | 'sui' | 'superseed' | 'superseedSepolia' | 'vanar' | 'xai' | 'zksync' | 'coti' | 'cotiTestnet' | 'morph' | 'morphTestnet' | 'morphHolesky' | 'sepolia' | 'optimism_sepolia' | 'arbitrumSepolia' | 'goerli' | 'optimism_goerli' | 'arbitrumGoerli' | 'basecamp';
+            }
+            /**
+             * Object containing details for the call-to-action.
+             */
+            interface Cta {
+                /**
+                 * Link for the call-to-action.
+                 */
+                href?: string | null;
+                /**
+                 * Label for the call-to-action.
+                 */
+                label?: string | null;
+            }
+            interface DiscordServersToJoin {
+                /**
+                 * ID of the Discord server to join.
+                 */
+                id?: string;
+                /**
+                 * Array of Discord channels to join.
+                 */
+                channels?: Array<DiscordServersToJoin.Channel>;
+                /**
+                 * Array of roles to assign in the Discord server.
+                 */
+                roles?: Array<DiscordServersToJoin.Role>;
+            }
+            namespace DiscordServersToJoin {
+                interface Channel {
+                    /**
+                     * ID of the Discord channel.
+                     */
+                    id?: string;
+                    /**
+                     * Array of emojis used in the channel.
+                     */
+                    emojis?: Array<Channel.Emoji>;
+                    /**
+                     * Phrase of text to be present in the discord message
+                     */
+                    text?: string;
+                }
+                namespace Channel {
+                    interface Emoji {
+                        /**
+                         * ID of the emoji used in the channel.
+                         */
+                        id?: string;
+                    }
+                }
+                interface Role {
+                    /**
+                     * ID of the role in the Discord server.
+                     */
+                    id: string;
+                }
+            }
+            interface DripQuestsToComplete {
+                /**
+                 * ID of the drip quest to complete.
+                 */
+                id: string;
+            }
+            /**
+             * Liquidity pool details.
+             */
+            interface Liquidity {
+                /**
+                 * Calculation type of the liquidity pool.
+                 */
+                calculationType?: 'fixed' | 'custom';
+                /**
+                 * Custom function to calculate the the reward amount based on the liquidity
+                 * provided per day. X is the reward amount, Y is the liquidity provided per day in
+                 * USD.
+                 */
+                customFunction?: string;
+                /**
+                 * Liquidity provided per day in USD
+                 */
+                liquidityPerDay?: number;
+                /**
+                 * Blockchain network of the liquidity pool.
+                 */
+                network?: 'abstract' | 'abstractTestnet' | 'apechain' | 'arbitrum' | 'avalanche' | 'avalancheFuji' | 'base' | 'baseSepolia' | 'berachain' | 'berachainArtio' | 'berachainBepolia' | 'binance' | 'bscTestnet' | 'campTestnet' | 'fantom' | 'fantomTestnet' | 'flowMainnet' | 'mainnet' | 'optimism' | 'polygon' | 'polygon_mumbai' | 'skaleNebula' | 'solana' | 'sophon' | 'sophonTestnet' | 'sui' | 'superseed' | 'superseedSepolia' | 'vanar' | 'xai' | 'zksync' | 'coti' | 'cotiTestnet' | 'morph' | 'morphTestnet' | 'morphHolesky' | 'sepolia' | 'optimism_sepolia' | 'arbitrumSepolia' | 'goerli' | 'optimism_goerli' | 'arbitrumGoerli' | 'basecamp';
+                /**
+                 * Indicates if only in-range liquidity is rewarded.
+                 */
+                onlyRewardInRangeLiquidity?: boolean;
+                /**
+                 * Array of liquidity pools associated with the rule.
+                 */
+                pools?: Array<Liquidity.Pool>;
+                /**
+                 * Protocol of the liquidity pool.
+                 */
+                protocol?: string;
+            }
+            namespace Liquidity {
+                interface Pool {
+                    /**
+                     * Unique identifier of the liquidity pool.
+                     */
+                    id: string;
+                }
+            }
+            interface Range {
+                /**
+                 * Reward amount for this range.
+                 */
+                amount: number;
+                /**
+                 * End value of the range.
+                 */
+                endRange: number;
+                /**
+                 * Start value of the range.
+                 */
+                startRange: number;
+                /**
+                 * ID of the loyalty badge for this range.
+                 */
+                loyaltyBadgeId?: string;
+                /**
+                 * Amount of the loyalty multiplier for this range.
+                 */
+                loyaltyMultiplierAmount?: number;
+            }
+            /**
+             * Object defining referral requirements.
+             */
+            interface ReferralRequirements {
+                /**
+                 * Flag indicating if achieving points is required.
+                 */
+                achievePoints?: boolean | null;
+                /**
+                 * Flag indicating if completing the profile is required.
+                 */
+                completeProfile?: boolean | null;
+                /**
+                 * Flag indicating if connecting Discord is required.
+                 */
+                connectDiscord?: boolean | null;
+                /**
+                 * Flag indicating if connecting email is required.
+                 */
+                connectEmail?: boolean | null;
+                /**
+                 * Flag indicating if connecting Twitter is required.
+                 */
+                connectTwitter?: boolean | null;
+                points?: ReferralRequirements.Points | null;
+            }
+            namespace ReferralRequirements {
+                interface Points {
+                    /**
+                     * Points required for referral.
+                     */
+                    amount?: number | null;
+                    /**
+                     * ID of the loyalty currency for referral.
+                     */
+                    loyaltyCurrecyId?: string | null;
+                }
+            }
+            /**
+             * Object containing details of the associated smart contract.
+             */
+            interface SmartContract {
+                /**
+                 * Mapping of addresses for the smart contract.
+                 */
+                addressMapping?: string | null;
+                /**
+                 * Object containing details of the amount multiplier from the event.
+                 */
+                amountMultiplier?: SmartContract.AmountMultiplier | null;
+                /**
+                 * Array of bonus details applied to the rule.
+                 */
+                bonus?: Array<SmartContract.Bonus> | null;
+                /**
+                 * ID of the smart contract.
+                 */
+                contractId?: string | null;
+                /**
+                 * Criteria to evaluate the smart contract event.
+                 */
+                criteria?: 'everyEvent' | 'byParameter' | null;
+                /**
+                 * Time range applied to the rule.
+                 */
+                customRange?: SmartContract.CustomRange | null;
+                /**
+                 * Event emitted by the smart contract.
+                 */
+                event?: string | null;
+                /**
+                 * Maximum value allowed for the parameter.
+                 */
+                max?: number | null;
+                /**
+                 * Array of parameters for the smart contract.
+                 */
+                params?: Array<SmartContract.Param> | null;
+                /**
+                 * Type of the smart contract interaction.
+                 */
+                type?: 'function' | 'event' | null;
+                /**
+                 * Flag indicating if a bonus is applied.
+                 */
+                withBonus?: boolean | null;
+                /**
+                 * Flag indicating if a custom range is applied.
+                 */
+                withCustomRange?: boolean | null;
+            }
+            namespace SmartContract {
+                /**
+                 * Object containing details of the amount multiplier from the event.
+                 */
+                interface AmountMultiplier {
+                    /**
+                     * Mapping of the value for the smart contract.
+                     */
+                    valueMapping?: string | null;
+                }
+                interface Bonus {
+                    /**
+                     * Amount of the bonus.
+                     */
+                    amount?: number | null;
+                    /**
+                     * Number of times the bonus is applied.
+                     */
+                    count?: number | null;
+                }
+                /**
+                 * Time range applied to the rule.
+                 */
+                interface CustomRange {
+                    /**
+                     * End time of the custom range.
+                     */
+                    endsAt?: string | null;
+                    /**
+                     * Start time of the custom range.
+                     */
+                    startsAt?: string | null;
+                }
+                interface Param {
+                    /**
+                     * Condition to check for the parameter.
+                     */
+                    condition?: string | null;
+                    /**
+                     * Name of the smart contract parameter.
+                     */
+                    name?: string | null;
+                    /**
+                     * Value of the parameter.
+                     */
+                    value?: string | null;
+                }
+            }
+            interface SnapshotProposal {
+                /**
+                 * ID of the snapshot proposal.
+                 */
+                id: string;
+                /**
+                 * Space associated with the snapshot proposal.
+                 */
+                space: string;
+            }
+            interface StreakArray {
+                /**
+                 * Reward amount for achieving the streak milestone.
+                 */
+                streakAmount: number;
+                /**
+                 * Milestone required to achieve the streak.
+                 */
+                streakMilestone: number;
+            }
+            /**
+             * Metadata for swap loyalty rules
+             */
+            interface Swap {
+                provider?: 'any' | 'relay' | 'lifi';
+                relayReferrerId?: string;
+                requireCrossChainSwap?: boolean;
+                swappedToChain?: 'any' | number | string;
+                swappedToTokens?: Array<Swap.SwappedToToken>;
+                tokenMode?: 'any' | 'specific';
+                trackTokenAmount?: boolean;
+            }
+            namespace Swap {
+                interface SwappedToToken {
+                    address: string;
+                    chainId: string;
+                }
+            }
+        }
     }
 }
 export interface RuleDeleteResponse {
@@ -1230,12 +2428,12 @@ export interface RuleDeleteResponse {
     deletedAt: string;
 }
 export interface RuleCompleteResponse {
-    message: string;
+    message: 'Completion request added to queue' | 'Link click being verified, come back later to check the status';
 }
-export interface RuleStatusResponse {
-    data: Array<RuleStatusResponse.Data>;
+export interface RuleGetStatusResponse {
+    data: Array<RuleGetStatusResponse.Data>;
 }
-export declare namespace RuleStatusResponse {
+export declare namespace RuleGetStatusResponse {
     interface Data {
         loyaltyRuleId: string;
         status: 'pending' | 'processing' | 'completed' | 'failed';
@@ -1287,7 +2485,7 @@ export interface RuleCreateParams {
     /**
      * Type of loyalty rule being created
      */
-    type: 'Bonus' | 'BoughtOn' | 'BoughtWithRoyalties' | 'DiscordMessages' | 'Listing' | 'Lodging' | 'MintOn' | 'PoapClaim' | 'SnagSocialsConnected' | 'SnapshotFullset' | 'SnapshotHold' | 'SoldOn' | 'SoldWithRoyalties' | 'TokenHold' | 'TwitterBio' | 'TwitterHashTagPost' | 'Retweet' | 'check_in' | 'code_entry' | 'connect_wallet' | 'connected_discord' | 'connected_email' | 'connected_epic' | 'connected_steam' | 'connected_telegram' | 'connected_twitter' | 'create_partner_account' | 'discord_member' | 'drip_x_follow' | 'drip_x_new_tweet' | 'drip_x_text_in_bio' | 'drip_x_text_in_comment' | 'drip_x_text_in_name' | 'drip_x_tweet' | 'external_rule' | 'link_click' | 'manual_upload' | 'profile_completed' | 'referred_user' | 'smart_contract_event' | 'snapshot_governance' | 'telegram_join' | 'telegram_messages' | 'text_input' | 'token_hold_erc20' | 'tweet_liked_by_project' | 'twitter_comment' | 'twitter_follow' | 'twitter_followers' | 'twitter_like' | 'twitter_post_hashtag';
+    type: 'Bonus' | 'BoughtOn' | 'BoughtWithRoyalties' | 'DiscordMessages' | 'Listing' | 'Lodging' | 'MintOn' | 'PoapClaim' | 'SnagSocialsConnected' | 'SnapshotFullset' | 'SnapshotHold' | 'SoldOn' | 'SoldWithRoyalties' | 'TokenHold' | 'TwitterBio' | 'TwitterHashTagPost' | 'Retweet' | 'check_in' | 'code_entry' | 'connect_wallet' | 'connected_discord' | 'connected_email' | 'connected_epic' | 'connected_steam' | 'connected_telegram' | 'connected_twitter' | 'create_partner_account' | 'discord_member' | 'drip_x_follow' | 'drip_x_new_tweet' | 'drip_x_text_in_bio' | 'drip_x_text_in_comment' | 'drip_x_text_in_name' | 'drip_x_tweet' | 'external_rule' | 'link_click' | 'manual_upload' | 'profile_completed' | 'referred_user' | 'smart_contract_event' | 'snapshot_governance' | 'telegram_join' | 'telegram_messages' | 'text_input' | 'token_hold_erc20' | 'tweet_liked_by_project' | 'twitter_comment' | 'twitter_follow' | 'twitter_followers' | 'twitter_like' | 'twitter_post_hashtag' | 'quiz' | 'poll' | 'steam_wishlist' | 'liquidity_uniswap_v2' | 'liquidity_uniswap_v3' | 'points_airdrop' | 'youtube_subscribers' | 'youtube_comment' | 'shopify_spend' | 'swap' | 'tiktok_post';
     /**
      * Unique identifier for the associated website
      */
@@ -1316,6 +2514,10 @@ export interface RuleCreateParams {
      * Optional detailed description of the rule
      */
     description?: string;
+    /**
+     * ID of the external integration
+     */
+    externalIntegrationId?: string | null;
     /**
      * Whether to hide this rule in the user interface
      */
@@ -1323,19 +2525,41 @@ export interface RuleCreateParams {
     /**
      * Interval between rule executions
      */
-    interval?: 'daily' | 'weekly' | 'monthly' | 'once' | null;
+    interval?: 'daily' | 'weekly' | 'monthly' | 'once' | 'custom' | 'every_message' | null;
     /**
      * Whether this rule is mandatory
      */
     isRequired?: boolean;
+    /**
+     * Unique identifier for the loyalty badge
+     */
+    loyaltyBadgeId?: string | null;
     /**
      * Unique identifier for the loyalty rule group
      */
     loyaltyRuleGroupId?: 'no-section' | (string & {}) | null;
+    /**
+     * URL for uploading loyalty user allotment via CSV
+     */
+    loyaltyUserAllotmentCsvUrl?: string;
+    /**
+     * The interval for the max amount. Available for the smart contract and external
+     * rules.
+     */
+    maxAmountInterval?: 'daily' | 'weekly' | 'monthly' | 'lifetime' | null;
+    /**
+     * The maximum amount of points a user can earn per interval. Available for the
+     * smart contract and external rules.
+     */
+    maxAmountPerInterval?: number | null;
+    /**
+     * URL of the media to be displayed
+     */
+    mediaUrl?: string | null;
     /**
      * Blockchain network where the rule will apply
      */
-    network?: 'mainnet' | 'polygon' | 'polygon_mumbai' | 'optimism' | 'arbitrum' | 'binance' | 'bscTestnet' | 'avalanche' | 'avalancheFuji' | 'zksync' | 'fantom' | 'fantomTestnet' | 'base' | 'baseSepolia' | 'skaleNebula' | 'xai' | 'berachainArtio' | 'solana' | 'apechain' | 'flowMainnet' | 'campTestnet' | 'sui' | 'vanar' | 'sepolia' | 'optimism_sepolia' | 'arbitrumSepolia' | 'goerli' | 'optimism_goerli' | 'arbitrumGoerli';
+    network?: 'abstract' | 'abstractTestnet' | 'apechain' | 'arbitrum' | 'avalanche' | 'avalancheFuji' | 'base' | 'baseSepolia' | 'berachain' | 'berachainArtio' | 'berachainBepolia' | 'binance' | 'bscTestnet' | 'campTestnet' | 'fantom' | 'fantomTestnet' | 'flowMainnet' | 'mainnet' | 'optimism' | 'polygon' | 'polygon_mumbai' | 'skaleNebula' | 'solana' | 'sophon' | 'sophonTestnet' | 'sui' | 'superseed' | 'superseedSepolia' | 'vanar' | 'xai' | 'zksync' | 'coti' | 'cotiTestnet' | 'morph' | 'morphTestnet' | 'morphHolesky' | 'sepolia' | 'optimism_sepolia' | 'arbitrumSepolia' | 'goerli' | 'optimism_goerli' | 'arbitrumGoerli' | 'basecamp';
     /**
      * OAuth credentials associated with the rule
      */
@@ -1343,17 +2567,25 @@ export interface RuleCreateParams {
     /**
      * Type of reward issued by the rule
      */
-    rewardType?: 'points' | 'multiplier';
+    rewardType?: 'points' | 'multiplier' | 'badge';
     /**
-     * Identifier for associated subscriptions
+     * URL of the Shopify store
      */
-    subscriptionIdentifier?: string | null;
+    shopifyStoreUrl?: string | null;
+    /**
+     * Optional subscription id for the rule
+     */
+    subscriptionId?: string | null;
 }
 export declare namespace RuleCreateParams {
     /**
      * Additional metadata for the loyalty rule
      */
     interface Metadata {
+        /**
+         * Number of tokens per batch.
+         */
+        batchSize?: number | null;
         /**
          * Text displayed on the action button.
          */
@@ -1378,6 +2610,12 @@ export declare namespace RuleCreateParams {
          * Array of collections associated with the rule.
          */
         collection?: Array<Metadata.Collection>;
+        /**
+         * Conditions for completing the profile.
+         */
+        completeProfileConditions?: {
+            [key: string]: boolean;
+        } | null;
         /**
          * Object containing details for the call-to-action.
          */
@@ -1406,10 +2644,18 @@ export declare namespace RuleCreateParams {
          * Flag indicating whether the verified multiplier is enabled.
          */
         enableVerifiedMultiplier?: boolean;
+        /**
+         * Fill source of the order for the token sale
+         */
+        fillSource?: string;
         /**
          * Percentage reward given to a user for their first referral.
          */
         firstReferralReward?: number | null;
+        /**
+         * Flag indicating whether the fill source is included.
+         */
+        hasFillSource?: boolean;
         /**
          * Indicates if the item has never been sold.
          */
@@ -1430,10 +2676,18 @@ export declare namespace RuleCreateParams {
          * URL of the image associated with the rule.
          */
         imageUrl?: string | null;
+        /**
+         * If enabled, the first transaction done on the platform will complete this rule
+         */
+        isCheckInOnEveryTxn?: boolean;
         /**
          * Indicates if the multiplier has been applied to rewards.
          */
         isMultiplierApplied?: boolean;
+        /**
+         * Flag indicating if the rule is restricted to new users.
+         */
+        isRestrictedToNewUsers?: boolean;
         /**
          * Flag indicating if rewards are applied retroactively.
          */
@@ -1446,6 +2700,10 @@ export declare namespace RuleCreateParams {
          * Optional link associated with the metadata.
          */
         link?: string | null;
+        /**
+         * Liquidity pool details.
+         */
+        liquidity?: Metadata.Liquidity;
         /**
          * Maximum quantity constraint for token holding.
          */
@@ -1470,10 +2728,30 @@ export declare namespace RuleCreateParams {
          * Flag indicating whether to include only non-listed items.
          */
         onlyNonListed?: boolean;
+        /**
+         * Indicates if only existing users are rewarded.
+         */
+        onlyRewardExistingUser?: boolean;
+        /**
+         * give points for only one token ownership per contract
+         */
+        onlyRewardSingleTokenOwnership?: boolean | null;
         /**
          * Promotional code associated with the rule.
          */
         promoCode?: string;
+        /**
+         * URL of the CSV file containing promo codes.
+         */
+        promoCodeCsvUrl?: string;
+        /**
+         * Numbers of the promotional code to be generated.
+         */
+        promoCodeLength?: number | null;
+        /**
+         * Type of the promotional code.
+         */
+        promoCodeType?: 'code' | 'csv' | 'generate';
         /**
          * Array defining ranges and corresponding rewards.
          */
@@ -1486,10 +2764,27 @@ export declare namespace RuleCreateParams {
          * Lump sum reward given to a referrer.
          */
         referrerReward?: number | null;
+        /**
+         * Loyalty currency ID of the referrer reward.
+         */
+        referrerRewardLoyaltyCurrencyId?: string | null;
+        /**
+         * Flag indicating if the rule can also reward badges per range.
+         */
+        rewardBadgePerRange?: boolean;
+        /**
+         * Flag indicating if the reward is rewarded by batch.
+         */
+        rewardByBatch?: boolean | null;
         /**
          * Flag indicating if rewards are given per impression.
          */
         rewardPerImpression?: boolean | null;
+        /**
+         * Flag indicating if the rule should reward based on value of traded tokens
+         * instead of count.
+         */
+        rewardPerValue?: boolean;
         /**
          * Currency associated with sales.
          */
@@ -1498,6 +2793,10 @@ export declare namespace RuleCreateParams {
          * Percentage reward given for a second-level referral.
          */
         secondReferralReward?: number | null;
+        /**
+         * Flag indicating if the multiplier is skipped.
+         */
+        skipMultiplier?: boolean | null;
         /**
          * Object containing details of the associated smart contract.
          */
@@ -1509,7 +2808,7 @@ export declare namespace RuleCreateParams {
         /**
          * Social media platform associated with the rule.
          */
-        socialPlatform?: 'Twitch' | 'TikTok' | 'X(Twitter)' | 'Instagram' | 'EpicGames' | 'YouTube' | 'Discord' | 'Custom' | null;
+        socialPlatform?: 'Custom' | 'Discord' | 'EpicGames' | 'Instagram' | 'Steam' | 'Telegram' | 'TikTok' | 'Twitch' | 'X(Twitter)' | 'YouTube' | 'Google' | null;
         /**
          * URL of the social platform's logo.
          */
@@ -1518,10 +2817,18 @@ export declare namespace RuleCreateParams {
          * Name of the social platform.
          */
         socialPlatformName?: string | null;
+        /**
+         * ID of the Steam app.
+         */
+        steamAppId?: string | null;
         /**
          * Array of streak milestones and corresponding rewards.
          */
         streakArray?: Array<Metadata.StreakArray> | null;
+        /**
+         * Metadata for swap loyalty rules
+         */
+        swap?: Metadata.Swap;
         /**
          * ID of the Telegram channel.
          */
@@ -1534,6 +2841,11 @@ export declare namespace RuleCreateParams {
          * Flag indicating if all contracts are tracked.
          */
         trackAllContracts?: boolean | null;
+        /**
+         * Flag indicating if the progress is tracked. If enabled, the rule can only be
+         * completed once the progress is 100%.
+         */
+        trackProgress?: boolean | null;
         /**
          * URL of the associated Twitter account.
          */
@@ -1569,7 +2881,15 @@ export declare namespace RuleCreateParams {
         /**
          * Type of wallet associated with the rule.
          */
-        walletType?: 'evm' | 'solana' | 'imx' | 'sui' | 'ton' | null;
+        walletType?: 'evm' | 'solana' | 'imx' | 'sui' | 'ton' | 'cosmos' | 'ultra' | null;
+        /**
+         * ID of the Youtube channel.
+         */
+        youtubeChannelId?: string | null;
+        /**
+         * ID of the Youtube video.
+         */
+        youtubeVideoId?: string | null;
     }
     namespace Metadata {
         interface Collection {
@@ -1584,7 +2904,7 @@ export declare namespace RuleCreateParams {
             /**
              * Blockchain network of the collection.
              */
-            network?: 'mainnet' | 'polygon' | 'polygon_mumbai' | 'optimism' | 'arbitrum' | 'binance' | 'bscTestnet' | 'avalanche' | 'avalancheFuji' | 'zksync' | 'fantom' | 'fantomTestnet' | 'base' | 'baseSepolia' | 'skaleNebula' | 'xai' | 'berachainArtio' | 'solana' | 'apechain' | 'flowMainnet' | 'campTestnet' | 'sui' | 'vanar' | 'sepolia' | 'optimism_sepolia' | 'arbitrumSepolia' | 'goerli' | 'optimism_goerli' | 'arbitrumGoerli';
+            network?: 'abstract' | 'abstractTestnet' | 'apechain' | 'arbitrum' | 'avalanche' | 'avalancheFuji' | 'base' | 'baseSepolia' | 'berachain' | 'berachainArtio' | 'berachainBepolia' | 'binance' | 'bscTestnet' | 'campTestnet' | 'fantom' | 'fantomTestnet' | 'flowMainnet' | 'mainnet' | 'optimism' | 'polygon' | 'polygon_mumbai' | 'skaleNebula' | 'solana' | 'sophon' | 'sophonTestnet' | 'sui' | 'superseed' | 'superseedSepolia' | 'vanar' | 'xai' | 'zksync' | 'coti' | 'cotiTestnet' | 'morph' | 'morphTestnet' | 'morphHolesky' | 'sepolia' | 'optimism_sepolia' | 'arbitrumSepolia' | 'goerli' | 'optimism_goerli' | 'arbitrumGoerli' | 'basecamp';
         }
         /**
          * Object containing details for the call-to-action.
@@ -1623,6 +2943,10 @@ export declare namespace RuleCreateParams {
                  * Array of emojis used in the channel.
                  */
                 emojis?: Array<Channel.Emoji>;
+                /**
+                 * Phrase of text to be present in the discord message
+                 */
+                text?: string;
             }
             namespace Channel {
                 interface Emoji {
@@ -1645,6 +2969,49 @@ export declare namespace RuleCreateParams {
              */
             id: string;
         }
+        /**
+         * Liquidity pool details.
+         */
+        interface Liquidity {
+            /**
+             * Calculation type of the liquidity pool.
+             */
+            calculationType?: 'fixed' | 'custom';
+            /**
+             * Custom function to calculate the the reward amount based on the liquidity
+             * provided per day. X is the reward amount, Y is the liquidity provided per day in
+             * USD.
+             */
+            customFunction?: string;
+            /**
+             * Liquidity provided per day in USD
+             */
+            liquidityPerDay?: number;
+            /**
+             * Blockchain network of the liquidity pool.
+             */
+            network?: 'abstract' | 'abstractTestnet' | 'apechain' | 'arbitrum' | 'avalanche' | 'avalancheFuji' | 'base' | 'baseSepolia' | 'berachain' | 'berachainArtio' | 'berachainBepolia' | 'binance' | 'bscTestnet' | 'campTestnet' | 'fantom' | 'fantomTestnet' | 'flowMainnet' | 'mainnet' | 'optimism' | 'polygon' | 'polygon_mumbai' | 'skaleNebula' | 'solana' | 'sophon' | 'sophonTestnet' | 'sui' | 'superseed' | 'superseedSepolia' | 'vanar' | 'xai' | 'zksync' | 'coti' | 'cotiTestnet' | 'morph' | 'morphTestnet' | 'morphHolesky' | 'sepolia' | 'optimism_sepolia' | 'arbitrumSepolia' | 'goerli' | 'optimism_goerli' | 'arbitrumGoerli' | 'basecamp';
+            /**
+             * Indicates if only in-range liquidity is rewarded.
+             */
+            onlyRewardInRangeLiquidity?: boolean;
+            /**
+             * Array of liquidity pools associated with the rule.
+             */
+            pools?: Array<Liquidity.Pool>;
+            /**
+             * Protocol of the liquidity pool.
+             */
+            protocol?: string;
+        }
+        namespace Liquidity {
+            interface Pool {
+                /**
+                 * Unique identifier of the liquidity pool.
+                 */
+                id: string;
+            }
+        }
         interface Range {
             /**
              * Reward amount for this range.
@@ -1658,6 +3025,14 @@ export declare namespace RuleCreateParams {
              * Start value of the range.
              */
             startRange: number;
+            /**
+             * ID of the loyalty badge for this range.
+             */
+            loyaltyBadgeId?: string;
+            /**
+             * Amount of the loyalty multiplier for this range.
+             */
+            loyaltyMultiplierAmount?: number;
         }
         /**
          * Object defining referral requirements.
@@ -1701,14 +3076,14 @@ export declare namespace RuleCreateParams {
          * Object containing details of the associated smart contract.
          */
         interface SmartContract {
-            /**
-             * ABI of the smart contract.
-             */
-            abi?: string | null;
             /**
              * Mapping of addresses for the smart contract.
              */
             addressMapping?: string | null;
+            /**
+             * Object containing details of the amount multiplier from the event.
+             */
+            amountMultiplier?: SmartContract.AmountMultiplier | null;
             /**
              * Array of bonus details applied to the rule.
              */
@@ -1737,6 +3112,10 @@ export declare namespace RuleCreateParams {
              * Array of parameters for the smart contract.
              */
             params?: Array<SmartContract.Param> | null;
+            /**
+             * Type of the smart contract interaction.
+             */
+            type?: 'function' | 'event' | null;
             /**
              * Flag indicating if a bonus is applied.
              */
@@ -1745,12 +3124,17 @@ export declare namespace RuleCreateParams {
              * Flag indicating if a custom range is applied.
              */
             withCustomRange?: boolean | null;
-            /**
-             * Flag indicating if a maximum limit is applied.
-             */
-            withMax?: boolean | null;
         }
         namespace SmartContract {
+            /**
+             * Object containing details of the amount multiplier from the event.
+             */
+            interface AmountMultiplier {
+                /**
+                 * Mapping of the value for the smart contract.
+                 */
+                valueMapping?: string | null;
+            }
             interface Bonus {
                 /**
                  * Amount of the bonus.
@@ -1809,6 +3193,24 @@ export declare namespace RuleCreateParams {
              */
             streakMilestone: number;
         }
+        /**
+         * Metadata for swap loyalty rules
+         */
+        interface Swap {
+            provider?: 'any' | 'relay' | 'lifi';
+            relayReferrerId?: string;
+            requireCrossChainSwap?: boolean;
+            swappedToChain?: 'any' | number | string;
+            swappedToTokens?: Array<Swap.SwappedToToken>;
+            tokenMode?: 'any' | 'specific';
+            trackTokenAmount?: boolean;
+        }
+        namespace Swap {
+            interface SwappedToToken {
+                address: string;
+                chainId: string;
+            }
+        }
     }
     interface Collection {
         /**
@@ -1818,7 +3220,7 @@ export declare namespace RuleCreateParams {
         /**
          * Blockchain network for the collection
          */
-        network: 'mainnet' | 'polygon' | 'polygon_mumbai' | 'optimism' | 'arbitrum' | 'binance' | 'bscTestnet' | 'avalanche' | 'avalancheFuji' | 'zksync' | 'fantom' | 'fantomTestnet' | 'base' | 'baseSepolia' | 'skaleNebula' | 'xai' | 'berachainArtio' | 'solana' | 'apechain' | 'flowMainnet' | 'campTestnet' | 'sui' | 'vanar' | 'sepolia' | 'optimism_sepolia' | 'arbitrumSepolia' | 'goerli' | 'optimism_goerli' | 'arbitrumGoerli';
+        network: 'abstract' | 'abstractTestnet' | 'apechain' | 'arbitrum' | 'avalanche' | 'avalancheFuji' | 'base' | 'baseSepolia' | 'berachain' | 'berachainArtio' | 'berachainBepolia' | 'binance' | 'bscTestnet' | 'campTestnet' | 'fantom' | 'fantomTestnet' | 'flowMainnet' | 'mainnet' | 'optimism' | 'polygon' | 'polygon_mumbai' | 'skaleNebula' | 'solana' | 'sophon' | 'sophonTestnet' | 'sui' | 'superseed' | 'superseedSepolia' | 'vanar' | 'xai' | 'zksync' | 'coti' | 'cotiTestnet' | 'morph' | 'morphTestnet' | 'morphHolesky' | 'sepolia' | 'optimism_sepolia' | 'arbitrumSepolia' | 'goerli' | 'optimism_goerli' | 'arbitrumGoerli' | 'basecamp';
     }
 }
 export interface RuleUpdateParams {
@@ -1826,34 +3228,14 @@ export interface RuleUpdateParams {
      * Reward amount for the loyalty rule
      */
     amount: unknown;
-    /**
-     * Effective end time of the rule
-     */
-    effectiveEndTime: string | null;
-    /**
-     * Effective start time of the rule
-     */
-    effectiveStartTime: string | null;
     /**
      * End time for the loyalty rule
      */
     endTime: string | null;
-    /**
-     * Frequency of the rule execution
-     */
-    frequency: 'none' | 'once' | 'daily' | 'weekly' | 'monthly' | 'immediately';
-    /**
-     * Additional metadata for the loyalty rule
-     */
-    metadata: RuleUpdateParams.Metadata;
     /**
      * Name of the loyalty rule
      */
     name: string;
-    /**
-     * Start time for the loyalty rule
-     */
-    startTime: string | null;
     /**
      * Blockchain address of the associated collection
      */
@@ -1874,6 +3256,22 @@ export interface RuleUpdateParams {
      * Optional description of the loyalty rule
      */
     description?: string;
+    /**
+     * Effective end time of the rule
+     */
+    effectiveEndTime?: string | null;
+    /**
+     * Effective start time of the rule
+     */
+    effectiveStartTime?: string | null;
+    /**
+     * ID of the external integration
+     */
+    externalIntegrationId?: string | null;
+    /**
+     * Frequency of the rule execution
+     */
+    frequency?: 'none' | 'once' | 'daily' | 'weekly' | 'monthly' | 'immediately';
     /**
      * Whether to hide this rule in the user interface
      */
@@ -1881,7 +3279,7 @@ export interface RuleUpdateParams {
     /**
      * Time interval for recurring rule execution
      */
-    interval?: 'daily' | 'weekly' | 'monthly' | 'once' | null;
+    interval?: 'daily' | 'weekly' | 'monthly' | 'once' | 'custom' | 'every_message' | null;
     /**
      * Whether this rule is required for participation
      */
@@ -1890,10 +3288,28 @@ export interface RuleUpdateParams {
      * ID of the rule group section to associate with the rule
      */
     loyaltyRuleGroupId?: (string & {}) | 'no-section' | null;
+    /**
+     * The interval for the max amount. Available for the smart contract and external
+     * rules.
+     */
+    maxAmountInterval?: 'daily' | 'weekly' | 'monthly' | 'lifetime' | null;
+    /**
+     * The maximum amount of points a user can earn per interval. Available for the
+     * smart contract and external rules.
+     */
+    maxAmountPerInterval?: number | null;
+    /**
+     * URL of the media to be displayed
+     */
+    mediaUrl?: string | null;
+    /**
+     * Additional metadata for the loyalty rule
+     */
+    metadata?: RuleUpdateParams.Metadata;
     /**
      * Blockchain network where the rule will apply
      */
-    network?: 'mainnet' | 'polygon' | 'polygon_mumbai' | 'optimism' | 'arbitrum' | 'binance' | 'bscTestnet' | 'avalanche' | 'avalancheFuji' | 'zksync' | 'fantom' | 'fantomTestnet' | 'base' | 'baseSepolia' | 'skaleNebula' | 'xai' | 'berachainArtio' | 'solana' | 'apechain' | 'flowMainnet' | 'campTestnet' | 'sui' | 'vanar' | 'sepolia' | 'optimism_sepolia' | 'arbitrumSepolia' | 'goerli' | 'optimism_goerli' | 'arbitrumGoerli';
+    network?: 'abstract' | 'abstractTestnet' | 'apechain' | 'arbitrum' | 'avalanche' | 'avalancheFuji' | 'base' | 'baseSepolia' | 'berachain' | 'berachainArtio' | 'berachainBepolia' | 'binance' | 'bscTestnet' | 'campTestnet' | 'fantom' | 'fantomTestnet' | 'flowMainnet' | 'mainnet' | 'optimism' | 'polygon' | 'polygon_mumbai' | 'skaleNebula' | 'solana' | 'sophon' | 'sophonTestnet' | 'sui' | 'superseed' | 'superseedSepolia' | 'vanar' | 'xai' | 'zksync' | 'coti' | 'cotiTestnet' | 'morph' | 'morphTestnet' | 'morphHolesky' | 'sepolia' | 'optimism_sepolia' | 'arbitrumSepolia' | 'goerli' | 'optimism_goerli' | 'arbitrumGoerli' | 'basecamp';
     /**
      * ID for associated OAuth credentials
      */
@@ -1901,17 +3317,39 @@ export interface RuleUpdateParams {
     /**
      * Type of reward issued by this rule
      */
-    rewardType?: 'points' | 'multiplier';
+    rewardType?: 'points' | 'multiplier' | 'badge';
+    /**
+     * URL of the Shopify store
+     */
+    shopifyStoreUrl?: string | null;
+    /**
+     * Start time for the loyalty rule
+     */
+    startTime?: string | null;
     /**
-     * Optional subscription identifier for the rule
+     * Optional subscription id for the rule
      */
-    subscriptionIdentifier?: string | null;
+    subscriptionId?: string | null;
 }
 export declare namespace RuleUpdateParams {
+    interface Collection {
+        /**
+         * Blockchain address of the collection
+         */
+        address: string;
+        /**
+         * Blockchain network for the collection
+         */
+        network: 'abstract' | 'abstractTestnet' | 'apechain' | 'arbitrum' | 'avalanche' | 'avalancheFuji' | 'base' | 'baseSepolia' | 'berachain' | 'berachainArtio' | 'berachainBepolia' | 'binance' | 'bscTestnet' | 'campTestnet' | 'fantom' | 'fantomTestnet' | 'flowMainnet' | 'mainnet' | 'optimism' | 'polygon' | 'polygon_mumbai' | 'skaleNebula' | 'solana' | 'sophon' | 'sophonTestnet' | 'sui' | 'superseed' | 'superseedSepolia' | 'vanar' | 'xai' | 'zksync' | 'coti' | 'cotiTestnet' | 'morph' | 'morphTestnet' | 'morphHolesky' | 'sepolia' | 'optimism_sepolia' | 'arbitrumSepolia' | 'goerli' | 'optimism_goerli' | 'arbitrumGoerli' | 'basecamp';
+    }
     /**
      * Additional metadata for the loyalty rule
      */
     interface Metadata {
+        /**
+         * Number of tokens per batch.
+         */
+        batchSize?: number | null;
         /**
          * Text displayed on the action button.
          */
@@ -1936,6 +3374,12 @@ export declare namespace RuleUpdateParams {
          * Array of collections associated with the rule.
          */
         collection?: Array<Metadata.Collection>;
+        /**
+         * Conditions for completing the profile.
+         */
+        completeProfileConditions?: {
+            [key: string]: boolean;
+        } | null;
         /**
          * Object containing details for the call-to-action.
          */
@@ -1964,10 +3408,18 @@ export declare namespace RuleUpdateParams {
          * Flag indicating whether the verified multiplier is enabled.
          */
         enableVerifiedMultiplier?: boolean;
+        /**
+         * Fill source of the order for the token sale
+         */
+        fillSource?: string;
         /**
          * Percentage reward given to a user for their first referral.
          */
         firstReferralReward?: number | null;
+        /**
+         * Flag indicating whether the fill source is included.
+         */
+        hasFillSource?: boolean;
         /**
          * Indicates if the item has never been sold.
          */
@@ -1988,10 +3440,18 @@ export declare namespace RuleUpdateParams {
          * URL of the image associated with the rule.
          */
         imageUrl?: string | null;
+        /**
+         * If enabled, the first transaction done on the platform will complete this rule
+         */
+        isCheckInOnEveryTxn?: boolean;
         /**
          * Indicates if the multiplier has been applied to rewards.
          */
         isMultiplierApplied?: boolean;
+        /**
+         * Flag indicating if the rule is restricted to new users.
+         */
+        isRestrictedToNewUsers?: boolean;
         /**
          * Flag indicating if rewards are applied retroactively.
          */
@@ -2004,6 +3464,10 @@ export declare namespace RuleUpdateParams {
          * Optional link associated with the metadata.
          */
         link?: string | null;
+        /**
+         * Liquidity pool details.
+         */
+        liquidity?: Metadata.Liquidity;
         /**
          * Maximum quantity constraint for token holding.
          */
@@ -2028,10 +3492,30 @@ export declare namespace RuleUpdateParams {
          * Flag indicating whether to include only non-listed items.
          */
         onlyNonListed?: boolean;
+        /**
+         * Indicates if only existing users are rewarded.
+         */
+        onlyRewardExistingUser?: boolean;
+        /**
+         * give points for only one token ownership per contract
+         */
+        onlyRewardSingleTokenOwnership?: boolean | null;
         /**
          * Promotional code associated with the rule.
          */
         promoCode?: string;
+        /**
+         * URL of the CSV file containing promo codes.
+         */
+        promoCodeCsvUrl?: string;
+        /**
+         * Numbers of the promotional code to be generated.
+         */
+        promoCodeLength?: number | null;
+        /**
+         * Type of the promotional code.
+         */
+        promoCodeType?: 'code' | 'csv' | 'generate';
         /**
          * Array defining ranges and corresponding rewards.
          */
@@ -2044,10 +3528,27 @@ export declare namespace RuleUpdateParams {
          * Lump sum reward given to a referrer.
          */
         referrerReward?: number | null;
+        /**
+         * Loyalty currency ID of the referrer reward.
+         */
+        referrerRewardLoyaltyCurrencyId?: string | null;
+        /**
+         * Flag indicating if the rule can also reward badges per range.
+         */
+        rewardBadgePerRange?: boolean;
+        /**
+         * Flag indicating if the reward is rewarded by batch.
+         */
+        rewardByBatch?: boolean | null;
         /**
          * Flag indicating if rewards are given per impression.
          */
         rewardPerImpression?: boolean | null;
+        /**
+         * Flag indicating if the rule should reward based on value of traded tokens
+         * instead of count.
+         */
+        rewardPerValue?: boolean;
         /**
          * Currency associated with sales.
          */
@@ -2056,6 +3557,10 @@ export declare namespace RuleUpdateParams {
          * Percentage reward given for a second-level referral.
          */
         secondReferralReward?: number | null;
+        /**
+         * Flag indicating if the multiplier is skipped.
+         */
+        skipMultiplier?: boolean | null;
         /**
          * Object containing details of the associated smart contract.
          */
@@ -2067,7 +3572,7 @@ export declare namespace RuleUpdateParams {
         /**
          * Social media platform associated with the rule.
          */
-        socialPlatform?: 'Twitch' | 'TikTok' | 'X(Twitter)' | 'Instagram' | 'EpicGames' | 'YouTube' | 'Discord' | 'Custom' | null;
+        socialPlatform?: 'Custom' | 'Discord' | 'EpicGames' | 'Instagram' | 'Steam' | 'Telegram' | 'TikTok' | 'Twitch' | 'X(Twitter)' | 'YouTube' | 'Google' | null;
         /**
          * URL of the social platform's logo.
          */
@@ -2076,10 +3581,18 @@ export declare namespace RuleUpdateParams {
          * Name of the social platform.
          */
         socialPlatformName?: string | null;
+        /**
+         * ID of the Steam app.
+         */
+        steamAppId?: string | null;
         /**
          * Array of streak milestones and corresponding rewards.
          */
         streakArray?: Array<Metadata.StreakArray> | null;
+        /**
+         * Metadata for swap loyalty rules
+         */
+        swap?: Metadata.Swap;
         /**
          * ID of the Telegram channel.
          */
@@ -2092,6 +3605,11 @@ export declare namespace RuleUpdateParams {
          * Flag indicating if all contracts are tracked.
          */
         trackAllContracts?: boolean | null;
+        /**
+         * Flag indicating if the progress is tracked. If enabled, the rule can only be
+         * completed once the progress is 100%.
+         */
+        trackProgress?: boolean | null;
         /**
          * URL of the associated Twitter account.
          */
@@ -2127,7 +3645,15 @@ export declare namespace RuleUpdateParams {
         /**
          * Type of wallet associated with the rule.
          */
-        walletType?: 'evm' | 'solana' | 'imx' | 'sui' | 'ton' | null;
+        walletType?: 'evm' | 'solana' | 'imx' | 'sui' | 'ton' | 'cosmos' | 'ultra' | null;
+        /**
+         * ID of the Youtube channel.
+         */
+        youtubeChannelId?: string | null;
+        /**
+         * ID of the Youtube video.
+         */
+        youtubeVideoId?: string | null;
     }
     namespace Metadata {
         interface Collection {
@@ -2142,7 +3668,7 @@ export declare namespace RuleUpdateParams {
             /**
              * Blockchain network of the collection.
              */
-            network?: 'mainnet' | 'polygon' | 'polygon_mumbai' | 'optimism' | 'arbitrum' | 'binance' | 'bscTestnet' | 'avalanche' | 'avalancheFuji' | 'zksync' | 'fantom' | 'fantomTestnet' | 'base' | 'baseSepolia' | 'skaleNebula' | 'xai' | 'berachainArtio' | 'solana' | 'apechain' | 'flowMainnet' | 'campTestnet' | 'sui' | 'vanar' | 'sepolia' | 'optimism_sepolia' | 'arbitrumSepolia' | 'goerli' | 'optimism_goerli' | 'arbitrumGoerli';
+            network?: 'abstract' | 'abstractTestnet' | 'apechain' | 'arbitrum' | 'avalanche' | 'avalancheFuji' | 'base' | 'baseSepolia' | 'berachain' | 'berachainArtio' | 'berachainBepolia' | 'binance' | 'bscTestnet' | 'campTestnet' | 'fantom' | 'fantomTestnet' | 'flowMainnet' | 'mainnet' | 'optimism' | 'polygon' | 'polygon_mumbai' | 'skaleNebula' | 'solana' | 'sophon' | 'sophonTestnet' | 'sui' | 'superseed' | 'superseedSepolia' | 'vanar' | 'xai' | 'zksync' | 'coti' | 'cotiTestnet' | 'morph' | 'morphTestnet' | 'morphHolesky' | 'sepolia' | 'optimism_sepolia' | 'arbitrumSepolia' | 'goerli' | 'optimism_goerli' | 'arbitrumGoerli' | 'basecamp';
         }
         /**
          * Object containing details for the call-to-action.
@@ -2181,6 +3707,10 @@ export declare namespace RuleUpdateParams {
                  * Array of emojis used in the channel.
                  */
                 emojis?: Array<Channel.Emoji>;
+                /**
+                 * Phrase of text to be present in the discord message
+                 */
+                text?: string;
             }
             namespace Channel {
                 interface Emoji {
@@ -2203,6 +3733,49 @@ export declare namespace RuleUpdateParams {
              */
             id: string;
         }
+        /**
+         * Liquidity pool details.
+         */
+        interface Liquidity {
+            /**
+             * Calculation type of the liquidity pool.
+             */
+            calculationType?: 'fixed' | 'custom';
+            /**
+             * Custom function to calculate the the reward amount based on the liquidity
+             * provided per day. X is the reward amount, Y is the liquidity provided per day in
+             * USD.
+             */
+            customFunction?: string;
+            /**
+             * Liquidity provided per day in USD
+             */
+            liquidityPerDay?: number;
+            /**
+             * Blockchain network of the liquidity pool.
+             */
+            network?: 'abstract' | 'abstractTestnet' | 'apechain' | 'arbitrum' | 'avalanche' | 'avalancheFuji' | 'base' | 'baseSepolia' | 'berachain' | 'berachainArtio' | 'berachainBepolia' | 'binance' | 'bscTestnet' | 'campTestnet' | 'fantom' | 'fantomTestnet' | 'flowMainnet' | 'mainnet' | 'optimism' | 'polygon' | 'polygon_mumbai' | 'skaleNebula' | 'solana' | 'sophon' | 'sophonTestnet' | 'sui' | 'superseed' | 'superseedSepolia' | 'vanar' | 'xai' | 'zksync' | 'coti' | 'cotiTestnet' | 'morph' | 'morphTestnet' | 'morphHolesky' | 'sepolia' | 'optimism_sepolia' | 'arbitrumSepolia' | 'goerli' | 'optimism_goerli' | 'arbitrumGoerli' | 'basecamp';
+            /**
+             * Indicates if only in-range liquidity is rewarded.
+             */
+            onlyRewardInRangeLiquidity?: boolean;
+            /**
+             * Array of liquidity pools associated with the rule.
+             */
+            pools?: Array<Liquidity.Pool>;
+            /**
+             * Protocol of the liquidity pool.
+             */
+            protocol?: string;
+        }
+        namespace Liquidity {
+            interface Pool {
+                /**
+                 * Unique identifier of the liquidity pool.
+                 */
+                id: string;
+            }
+        }
         interface Range {
             /**
              * Reward amount for this range.
@@ -2216,6 +3789,14 @@ export declare namespace RuleUpdateParams {
              * Start value of the range.
              */
             startRange: number;
+            /**
+             * ID of the loyalty badge for this range.
+             */
+            loyaltyBadgeId?: string;
+            /**
+             * Amount of the loyalty multiplier for this range.
+             */
+            loyaltyMultiplierAmount?: number;
         }
         /**
          * Object defining referral requirements.
@@ -2259,14 +3840,14 @@ export declare namespace RuleUpdateParams {
          * Object containing details of the associated smart contract.
          */
         interface SmartContract {
-            /**
-             * ABI of the smart contract.
-             */
-            abi?: string | null;
             /**
              * Mapping of addresses for the smart contract.
              */
             addressMapping?: string | null;
+            /**
+             * Object containing details of the amount multiplier from the event.
+             */
+            amountMultiplier?: SmartContract.AmountMultiplier | null;
             /**
              * Array of bonus details applied to the rule.
              */
@@ -2295,6 +3876,10 @@ export declare namespace RuleUpdateParams {
              * Array of parameters for the smart contract.
              */
             params?: Array<SmartContract.Param> | null;
+            /**
+             * Type of the smart contract interaction.
+             */
+            type?: 'function' | 'event' | null;
             /**
              * Flag indicating if a bonus is applied.
              */
@@ -2303,12 +3888,17 @@ export declare namespace RuleUpdateParams {
              * Flag indicating if a custom range is applied.
              */
             withCustomRange?: boolean | null;
-            /**
-             * Flag indicating if a maximum limit is applied.
-             */
-            withMax?: boolean | null;
         }
         namespace SmartContract {
+            /**
+             * Object containing details of the amount multiplier from the event.
+             */
+            interface AmountMultiplier {
+                /**
+                 * Mapping of the value for the smart contract.
+                 */
+                valueMapping?: string | null;
+            }
             interface Bonus {
                 /**
                  * Amount of the bonus.
@@ -2367,27 +3957,60 @@ export declare namespace RuleUpdateParams {
              */
             streakMilestone: number;
         }
-    }
-    interface Collection {
-        /**
-         * Blockchain address of the collection
-         */
-        address: string;
         /**
-         * Blockchain network for the collection
+         * Metadata for swap loyalty rules
          */
-        network: 'mainnet' | 'polygon' | 'polygon_mumbai' | 'optimism' | 'arbitrum' | 'binance' | 'bscTestnet' | 'avalanche' | 'avalancheFuji' | 'zksync' | 'fantom' | 'fantomTestnet' | 'base' | 'baseSepolia' | 'skaleNebula' | 'xai' | 'berachainArtio' | 'solana' | 'apechain' | 'flowMainnet' | 'campTestnet' | 'sui' | 'vanar' | 'sepolia' | 'optimism_sepolia' | 'arbitrumSepolia' | 'goerli' | 'optimism_goerli' | 'arbitrumGoerli';
+        interface Swap {
+            provider?: 'any' | 'relay' | 'lifi';
+            relayReferrerId?: string;
+            requireCrossChainSwap?: boolean;
+            swappedToChain?: 'any' | number | string;
+            swappedToTokens?: Array<Swap.SwappedToToken>;
+            tokenMode?: 'any' | 'specific';
+            trackTokenAmount?: boolean;
+        }
+        namespace Swap {
+            interface SwappedToToken {
+                address: string;
+                chainId: string;
+            }
+        }
     }
 }
 export interface RuleListParams {
+    /**
+     * IDs of the users to filter results by
+     */
+    allotedToUserId?: string | Array<string>;
+    /**
+     * ID of the user group to filter results by
+     */
+    allotedUserGroupId?: string;
     /**
      * Address of the collection to filter by
      */
     collectionAddress?: string;
+    /**
+     * If true this will only return loyalty rule chains
+     */
+    includeLoyaltyRuleChains?: 'true' | 'false';
+    /**
+     * If true this will only return active rules, the rules for which the startTime is
+     * in the past and the endTime is in the future
+     */
+    isActive?: 'true' | 'false';
     /**
      * Maximum number of records to return (max 1000)
      */
     limit?: number;
+    /**
+     * ID of the loyalty rule group to filter results
+     */
+    loyaltyRuleGroupId?: string;
+    /**
+     * The IDs of the loyalty rule
+     */
+    loyaltyRuleId?: string | Array<string>;
     /**
      * Unique identifier for the organization to filter by
      */
@@ -2401,11 +4024,30 @@ export interface RuleListParams {
      */
     websiteId?: string;
 }
+export interface RuleDeleteParams {
+    /**
+     * Whether to debit loyalty points
+     */
+    debitLoyaltyPoints?: string;
+}
 export interface RuleCompleteParams {
+    /**
+     * Override amount for the reward (rounded to nearest whole number). This will
+     * override the rule amount and reward the integer passed.
+     */
+    amount?: number | null;
     /**
      * Link to the comment made by user
      */
     commentLink?: string;
+    /**
+     * Unique key to ensure idempotent requests
+     */
+    idempotencyKey?: string;
+    /**
+     * ID of the choice selected by the user
+     */
+    loyaltyQuestionChoiceId?: string;
     /**
      * Unique identifier for the user
      */
@@ -2414,17 +4056,23 @@ export interface RuleCompleteParams {
      * Optional verification code for completing the loyalty rule
      */
     verificationCode?: string;
+    /**
+     * Flag indicating if only verification is required, this will not create a
+     * transaction and reward the user
+     */
+    verifyOnly?: string;
     /**
      * Wallet address of the user can only be used if userId is not provided
      */
     walletAddress?: string;
 }
-export interface RuleStatusParams {
-    organizationId: string;
-    websiteId: string;
+export interface RuleGetStatusParams {
+    organizationId?: string;
     userId?: string;
+    walletAddress?: string;
+    websiteId?: string;
 }
 export declare namespace Rules {
-    export { type RuleCreateResponse as RuleCreateResponse, type RuleUpdateResponse as RuleUpdateResponse, type RuleListResponse as RuleListResponse, type RuleDeleteResponse as RuleDeleteResponse, type RuleCompleteResponse as RuleCompleteResponse, type RuleStatusResponse as RuleStatusResponse, type RuleCreateParams as RuleCreateParams, type RuleUpdateParams as RuleUpdateParams, type RuleListParams as RuleListParams, type RuleCompleteParams as RuleCompleteParams, type RuleStatusParams as RuleStatusParams, };
+    export { type RuleCreateResponse as RuleCreateResponse, type RuleUpdateResponse as RuleUpdateResponse, type RuleListResponse as RuleListResponse, type RuleDeleteResponse as RuleDeleteResponse, type RuleCompleteResponse as RuleCompleteResponse, type RuleGetStatusResponse as RuleGetStatusResponse, type RuleCreateParams as RuleCreateParams, type RuleUpdateParams as RuleUpdateParams, type RuleListParams as RuleListParams, type RuleDeleteParams as RuleDeleteParams, type RuleCompleteParams as RuleCompleteParams, type RuleGetStatusParams as RuleGetStatusParams, };
 }
 //# sourceMappingURL=rules.d.ts.map