@snagsolutions/sdk 0.1.0-alpha.16 → 0.1.0-alpha.160

package/src/resources/loyalty/rules.ts

@@ -7,6 +7,24 @@ import * as Core from '../../core';
 export 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> {
     return this._client.post('/api/loyalty/rules', { body, ...options });
@@ -14,6 +32,18 @@ export class Rules extends APIResource {
 
   /**
    * 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,
@@ -25,6 +55,11 @@ export class Rules extends APIResource {
 
   /**
    * 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>;
@@ -40,9 +75,30 @@ export class Rules extends APIResource {
 
   /**
    * Delete an existing Loyalty Rule
+   *
+   * @example
+   * ```ts
+   * const rule = await client.loyalty.rules.delete(
+   *   '182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e',
+   * );
+   * ```
    */
-  delete(id: string, options?: Core.RequestOptions): Core.APIPromise<RuleDeleteResponse> {
-    return this._client.delete(`/api/loyalty/rules/${id}`, options);
+  delete(
+    id: string,
+    params?: RuleDeleteParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<RuleDeleteResponse>;
+  delete(id: string, options?: Core.RequestOptions): Core.APIPromise<RuleDeleteResponse>;
+  delete(
+    id: string,
+    params: RuleDeleteParams | Core.RequestOptions = {},
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<RuleDeleteResponse> {
+    if (isRequestOptions(params)) {
+      return this.delete(id, {}, params);
+    }
+    const { debitLoyaltyPoints } = params;
+    return this._client.delete(`/api/loyalty/rules/${id}`, { query: { debitLoyaltyPoints }, ...options });
   }
 
   /**
@@ -50,7 +106,15 @@ export class Rules extends APIResource {
    * 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, DiscordMessages
+   * 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,
@@ -71,11 +135,24 @@ export class Rules extends APIResource {
 
   /**
    * This will return the processing status of quests for a specific user
+   *
+   * @example
+   * ```ts
+   * const response = await client.loyalty.rules.getStatus();
+   * ```
    */
   getStatus(
-    query: RuleGetStatusParams,
+    query?: RuleGetStatusParams,
+    options?: Core.RequestOptions,
+  ): Core.APIPromise<RuleGetStatusResponse>;
+  getStatus(options?: Core.RequestOptions): Core.APIPromise<RuleGetStatusResponse>;
+  getStatus(
+    query: RuleGetStatusParams | Core.RequestOptions = {},
     options?: Core.RequestOptions,
   ): Core.APIPromise<RuleGetStatusResponse> {
+    if (isRequestOptions(query)) {
+      return this.getStatus({}, query);
+    }
     return this._client.get('/api/loyalty/rules/status', { query, ...options });
   }
 }
@@ -189,7 +266,20 @@ export interface RuleCreateResponse {
     | 'twitter_like'
     | 'twitter_post_hashtag'
     | 'quiz'
-    | 'poll';
+    | 'poll'
+    | 'steam_wishlist'
+    | 'liquidity_uniswap_v2'
+    | 'liquidity_uniswap_v3'
+    | 'points_airdrop'
+    | 'youtube_subscribers'
+    | 'youtube_comment'
+    | 'shopify_spend'
+    | 'swap'
+    | 'tiktok_post'
+    | 'post_impressions'
+    | 'discord_join'
+    | 'connected_youtube'
+    | 'connected_tiktok';
 
   /**
    * Unique identifier for the associated website
@@ -201,6 +291,11 @@ export interface RuleCreateResponse {
    */
   backgroundAssetUrl?: string;
 
+  /**
+   * The type of claim for the reward
+   */
+  claimType?: 'manual' | 'auto' | null;
+
   /**
    * Blockchain address of the associated collection
    */
@@ -226,6 +321,13 @@ export interface RuleCreateResponse {
    */
   description?: string;
 
+  duplicatedFromId?: string | null;
+
+  /**
+   * ID of the external integration
+   */
+  externalIntegrationId?: string | null;
+
   /**
    * Whether to hide this rule in the user interface
    */
@@ -234,18 +336,40 @@ export interface RuleCreateResponse {
   /**
    * Interval between rule executions
    */
-  interval?: 'daily' | 'weekly' | 'monthly' | 'once' | 'custom' | 'every_message' | null;
+  interval?: 'daily' | 'weekly' | 'monthly' | 'once' | 'custom' | 'every_message' | 'unlimited' | 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
    */
@@ -255,13 +379,17 @@ export interface RuleCreateResponse {
    * Blockchain network where the rule will apply
    */
   network?:
+    | 'abstract'
+    | 'abstractTestnet'
     | 'apechain'
     | 'arbitrum'
     | 'avalanche'
     | 'avalancheFuji'
     | 'base'
     | 'baseSepolia'
+    | 'berachain'
     | 'berachainArtio'
+    | 'berachainBepolia'
     | 'binance'
     | 'bscTestnet'
     | 'campTestnet'
@@ -269,18 +397,28 @@ export interface RuleCreateResponse {
     | 'fantomTestnet'
     | 'flowMainnet'
     | 'mainnet'
+    | 'nexusTestnet'
     | 'optimism'
     | 'polygon'
     | 'polygon_mumbai'
     | 'skaleNebula'
     | 'solana'
     | 'sophon'
+    | 'sophonTestnet'
     | 'sui'
     | 'superseed'
     | 'superseedSepolia'
     | 'vanar'
     | 'xai'
     | 'zksync'
+    | 'coti'
+    | 'cotiTestnet'
+    | 'morph'
+    | 'morphTestnet'
+    | 'morphHolesky'
+    | 'ultra'
+    | 'ultraTestnet'
+    | 'nitrograph'
     | 'sepolia'
     | 'optimism_sepolia'
     | 'arbitrumSepolia'
@@ -288,22 +426,37 @@ export interface RuleCreateResponse {
     | 'optimism_goerli'
     | 'arbitrumGoerli'
     | 'basecamp'
-    | 'abstract';
+    | 'somnia';
 
   /**
    * OAuth credentials associated with the rule
    */
   oauthCredentialsId?: string | null;
 
+  /**
+   * The lifetime of the reward
+   */
+  rewardLifetime?: 'permanent' | 'dynamic' | null;
+
   /**
    * Type of reward issued by the rule
    */
-  rewardType?: 'points' | 'multiplier';
+  rewardType?: 'points' | 'multiplier' | 'badge';
+
+  /**
+   * URL of the Shopify store
+   */
+  shopifyStoreUrl?: string | null;
+
+  /**
+   * Whether to show this rule before the start time
+   */
+  showBeforeStart?: boolean;
 
   /**
-   * Identifier for associated subscriptions
+   * Optional subscription id for the rule
    */
-  subscriptionIdentifier?: string | null;
+  subscriptionId?: string | null;
 }
 
 export namespace RuleCreateResponse {
@@ -311,6 +464,11 @@ export namespace RuleCreateResponse {
    * Additional metadata for the loyalty rule
    */
   export interface Metadata {
+    /**
+     * Number of tokens per batch.
+     */
+    batchSize?: number | null;
+
     /**
      * Text displayed on the action button.
      */
@@ -334,7 +492,7 @@ export namespace RuleCreateResponse {
     /**
      * Text to check in the Twitter post, username, or bio.
      */
-    checkText?: string | null;
+    checkText?: string | Array<string> | null;
 
     /**
      * Array of collections associated with the rule.
@@ -344,7 +502,12 @@ export namespace RuleCreateResponse {
     /**
      * Conditions for completing the profile.
      */
-    completeProfileConditions?: Record<string, boolean> | null;
+    completeProfileConditions?: { [key: string]: boolean } | null;
+
+    /**
+     * Description of the external rule condition (only for external rules)
+     */
+    conditionDescription?: string;
 
     /**
      * Object containing details for the call-to-action.
@@ -356,6 +519,11 @@ export namespace RuleCreateResponse {
      */
     customRewardsApiKey?: string;
 
+    /**
+     * Flag indicating if the rule should use direct RPC to get the balance of tokens.
+     */
+    directRpc?: boolean;
+
     /**
      * Array of Discord servers, channels, and roles to join.
      */
@@ -401,11 +569,6 @@ export namespace RuleCreateResponse {
      */
     hasNeverSold?: boolean;
 
-    /**
-     * Flag indicating whether the order source is included.
-     */
-    hasOrderSource?: boolean;
-
     /**
      * Indicates if the full royalty has been paid for items.
      */
@@ -426,11 +589,21 @@ export namespace RuleCreateResponse {
      */
     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.
      */
@@ -446,6 +619,11 @@ export namespace RuleCreateResponse {
      */
     link?: string | null;
 
+    /**
+     * Liquidity pool details.
+     */
+    liquidity?: Metadata.Liquidity;
+
     /**
      * Maximum quantity constraint for token holding.
      */
@@ -487,14 +665,24 @@ export namespace RuleCreateResponse {
     onlyRewardSingleTokenOwnership?: boolean | null;
 
     /**
-     * Order source of the order for the token sale
+     * Promotional code associated with the rule.
      */
-    orderSource?: string;
+    promoCode?: string;
 
     /**
-     * Promotional code associated with the rule.
+     * URL of the CSV file containing promo codes.
      */
-    promoCode?: string;
+    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.
@@ -511,11 +699,62 @@ export namespace RuleCreateResponse {
      */
     referrerReward?: number | null;
 
+    /**
+     * Loyalty currency ID of the referrer reward.
+     */
+    referrerRewardLoyaltyCurrencyId?: string | null;
+
+    /**
+     * Flag indicating if the post link is required.
+     */
+    requirePostLink?: boolean | null;
+
+    /**
+     * Flag indicating if media metadata is required.
+     */
+    requirePostMediaLink?: boolean | 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;
+
+    /**
+     * Criteria to evaluate the reward.
+     */
+    rewardCriteria?: 'IMPRESSIONS_COUNT' | 'ELIGIBLE_POST' | null;
+
+    /**
+     * Flag indicating if the reward is rewarded per action.
+     */
+    rewardPerAction?: 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;
+
+    /**
+     * Wallet address of the user can only be used if userId is not provided
+     */
+    royaltyAddress?: string;
+
+    /**
+     * Royalty percentage of the item.
+     */
+    royaltyPercentage?: number;
+
     /**
      * Currency associated with sales.
      */
@@ -555,6 +794,7 @@ export namespace RuleCreateResponse {
       | 'Twitch'
       | 'X(Twitter)'
       | 'YouTube'
+      | 'Google'
       | null;
 
     /**
@@ -567,11 +807,21 @@ export namespace RuleCreateResponse {
      */
     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.
      */
@@ -587,6 +837,12 @@ export namespace RuleCreateResponse {
      */
     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.
      */
@@ -630,7 +886,17 @@ export namespace RuleCreateResponse {
     /**
      * Type of wallet associated with the rule.
      */
-    walletType?: 'evm' | 'solana' | 'imx' | 'sui' | 'ton' | null;
+    walletType?: 'evm' | 'solana' | 'imx' | 'sui' | 'ton' | 'cosmos' | 'ultra' | 'agw' | null;
+
+    /**
+     * ID of the Youtube channel.
+     */
+    youtubeChannelId?: string | null;
+
+    /**
+     * ID of the Youtube video.
+     */
+    youtubeVideoId?: string | null;
   }
 
   export namespace Metadata {
@@ -649,13 +915,17 @@ export namespace RuleCreateResponse {
        * Blockchain network of the collection.
        */
       network?:
+        | 'abstract'
+        | 'abstractTestnet'
         | 'apechain'
         | 'arbitrum'
         | 'avalanche'
         | 'avalancheFuji'
         | 'base'
         | 'baseSepolia'
+        | 'berachain'
         | 'berachainArtio'
+        | 'berachainBepolia'
         | 'binance'
         | 'bscTestnet'
         | 'campTestnet'
@@ -663,18 +933,28 @@ export namespace RuleCreateResponse {
         | 'fantomTestnet'
         | 'flowMainnet'
         | 'mainnet'
+        | 'nexusTestnet'
         | 'optimism'
         | 'polygon'
         | 'polygon_mumbai'
         | 'skaleNebula'
         | 'solana'
         | 'sophon'
+        | 'sophonTestnet'
         | 'sui'
         | 'superseed'
         | 'superseedSepolia'
         | 'vanar'
         | 'xai'
         | 'zksync'
+        | 'coti'
+        | 'cotiTestnet'
+        | 'morph'
+        | 'morphTestnet'
+        | 'morphHolesky'
+        | 'ultra'
+        | 'ultraTestnet'
+        | 'nitrograph'
         | 'sepolia'
         | 'optimism_sepolia'
         | 'arbitrumSepolia'
@@ -682,7 +962,7 @@ export namespace RuleCreateResponse {
         | 'optimism_goerli'
         | 'arbitrumGoerli'
         | 'basecamp'
-        | 'abstract';
+        | 'somnia';
     }
 
     /**
@@ -759,6 +1039,105 @@ export namespace RuleCreateResponse {
       id: string;
     }
 
+    /**
+     * Liquidity pool details.
+     */
+    export 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'
+        | 'nexusTestnet'
+        | 'optimism'
+        | 'polygon'
+        | 'polygon_mumbai'
+        | 'skaleNebula'
+        | 'solana'
+        | 'sophon'
+        | 'sophonTestnet'
+        | 'sui'
+        | 'superseed'
+        | 'superseedSepolia'
+        | 'vanar'
+        | 'xai'
+        | 'zksync'
+        | 'coti'
+        | 'cotiTestnet'
+        | 'morph'
+        | 'morphTestnet'
+        | 'morphHolesky'
+        | 'ultra'
+        | 'ultraTestnet'
+        | 'nitrograph'
+        | 'sepolia'
+        | 'optimism_sepolia'
+        | 'arbitrumSepolia'
+        | 'goerli'
+        | 'optimism_goerli'
+        | 'arbitrumGoerli'
+        | 'basecamp'
+        | 'somnia';
+
+      /**
+       * 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;
+    }
+
+    export namespace Liquidity {
+      export interface Pool {
+        /**
+         * Unique identifier of the liquidity pool.
+         */
+        id: string;
+      }
+    }
+
     export interface Range {
       /**
        * Reward amount for this range.
@@ -774,6 +1153,16 @@ export 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;
     }
 
     /**
@@ -826,20 +1215,15 @@ export namespace RuleCreateResponse {
      * Object containing details of the associated smart contract.
      */
     export interface SmartContract {
-      /**
-       * ABI of the smart contract.
-       */
-      abi?: string | null;
-
       /**
        * Mapping of addresses for the smart contract.
        */
       addressMapping?: string | null;
 
       /**
-       * Array of bonus details applied to the rule.
+       * Object containing details of the amount multiplier from the event.
        */
-      bonus?: Array<SmartContract.Bonus> | null;
+      amountMultiplier?: SmartContract.AmountMultiplier | null;
 
       /**
        * ID of the smart contract.
@@ -851,68 +1235,31 @@ export namespace RuleCreateResponse {
        */
       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;
 
       /**
-       * Flag indicating if a bonus is applied.
+       * Type of the smart contract interaction.
        */
-      withBonus?: boolean | null;
-
-      /**
-       * Flag indicating if a custom range is applied.
-       */
-      withCustomRange?: boolean | null;
-
-      /**
-       * Flag indicating if a maximum limit is applied.
-       */
-      withMax?: boolean | null;
+      type?: 'function' | 'event' | null;
     }
 
     export namespace SmartContract {
-      export 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.
+       * Object containing details of the amount multiplier from the event.
        */
-      export interface CustomRange {
-        /**
-         * End time of the custom range.
-         */
-        endsAt?: string | null;
-
+      export interface AmountMultiplier {
         /**
-         * Start time of the custom range.
+         * Mapping of the value for the smart contract.
          */
-        startsAt?: string | null;
+        valueMapping?: string | null;
       }
 
       export interface Param {
@@ -956,6 +1303,33 @@ export namespace RuleCreateResponse {
        */
       streakMilestone: number;
     }
+
+    /**
+     * Metadata for swap loyalty rules
+     */
+    export interface Swap {
+      provider?: 'any' | 'relay' | 'lifi';
+
+      relayReferrerId?: string;
+
+      requireCrossChainSwap?: boolean;
+
+      swappedToChain?: 'any' | number | string;
+
+      swappedToTokens?: Array<Swap.SwappedToToken>;
+
+      tokenMode?: 'any' | 'specific';
+
+      trackTokenAmount?: boolean;
+    }
+
+    export namespace Swap {
+      export interface SwappedToToken {
+        address: string;
+
+        chainId: string;
+      }
+    }
   }
 
   export interface Collection {
@@ -968,13 +1342,17 @@ export namespace RuleCreateResponse {
      * Blockchain network for the collection
      */
     network:
+      | 'abstract'
+      | 'abstractTestnet'
       | 'apechain'
       | 'arbitrum'
       | 'avalanche'
       | 'avalancheFuji'
       | 'base'
       | 'baseSepolia'
+      | 'berachain'
       | 'berachainArtio'
+      | 'berachainBepolia'
       | 'binance'
       | 'bscTestnet'
       | 'campTestnet'
@@ -982,18 +1360,28 @@ export namespace RuleCreateResponse {
       | 'fantomTestnet'
       | 'flowMainnet'
       | 'mainnet'
+      | 'nexusTestnet'
       | 'optimism'
       | 'polygon'
       | 'polygon_mumbai'
       | 'skaleNebula'
       | 'solana'
       | 'sophon'
+      | 'sophonTestnet'
       | 'sui'
       | 'superseed'
       | 'superseedSepolia'
       | 'vanar'
       | 'xai'
       | 'zksync'
+      | 'coti'
+      | 'cotiTestnet'
+      | 'morph'
+      | 'morphTestnet'
+      | 'morphHolesky'
+      | 'ultra'
+      | 'ultraTestnet'
+      | 'nitrograph'
       | 'sepolia'
       | 'optimism_sepolia'
       | 'arbitrumSepolia'
@@ -1001,7 +1389,12 @@ export namespace RuleCreateResponse {
       | 'optimism_goerli'
       | 'arbitrumGoerli'
       | 'basecamp'
-      | 'abstract';
+      | 'somnia';
+
+    /**
+     * Symbol of the collection.
+     */
+    symbol?: string;
   }
 }
 
@@ -1023,6 +1416,11 @@ export interface RuleUpdateResponse {
    */
   name: string;
 
+  /**
+   * The type of claim for the reward
+   */
+  claimType?: 'manual' | 'auto' | null;
+
   /**
    * Blockchain address of the associated collection
    */
@@ -1058,6 +1456,11 @@ export interface RuleUpdateResponse {
    */
   effectiveStartTime?: string | null;
 
+  /**
+   * ID of the external integration
+   */
+  externalIntegrationId?: string | null;
+
   /**
    * Frequency of the rule execution
    */
@@ -1071,7 +1474,7 @@ export interface RuleUpdateResponse {
   /**
    * Time interval for recurring rule execution
    */
-  interval?: 'daily' | 'weekly' | 'monthly' | 'once' | 'custom' | 'every_message' | null;
+  interval?: 'daily' | 'weekly' | 'monthly' | 'once' | 'custom' | 'every_message' | 'unlimited' | null;
 
   /**
    * Whether this rule is required for participation
@@ -1083,6 +1486,18 @@ export interface RuleUpdateResponse {
    */
   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
    */
@@ -1097,13 +1512,17 @@ export interface RuleUpdateResponse {
    * Blockchain network where the rule will apply
    */
   network?:
+    | 'abstract'
+    | 'abstractTestnet'
     | 'apechain'
     | 'arbitrum'
     | 'avalanche'
     | 'avalancheFuji'
     | 'base'
     | 'baseSepolia'
+    | 'berachain'
     | 'berachainArtio'
+    | 'berachainBepolia'
     | 'binance'
     | 'bscTestnet'
     | 'campTestnet'
@@ -1111,18 +1530,28 @@ export interface RuleUpdateResponse {
     | 'fantomTestnet'
     | 'flowMainnet'
     | 'mainnet'
+    | 'nexusTestnet'
     | 'optimism'
     | 'polygon'
     | 'polygon_mumbai'
     | 'skaleNebula'
     | 'solana'
     | 'sophon'
+    | 'sophonTestnet'
     | 'sui'
     | 'superseed'
     | 'superseedSepolia'
     | 'vanar'
     | 'xai'
     | 'zksync'
+    | 'coti'
+    | 'cotiTestnet'
+    | 'morph'
+    | 'morphTestnet'
+    | 'morphHolesky'
+    | 'ultra'
+    | 'ultraTestnet'
+    | 'nitrograph'
     | 'sepolia'
     | 'optimism_sepolia'
     | 'arbitrumSepolia'
@@ -1130,17 +1559,32 @@ export interface RuleUpdateResponse {
     | 'optimism_goerli'
     | 'arbitrumGoerli'
     | 'basecamp'
-    | 'abstract';
+    | 'somnia';
 
   /**
    * ID for associated OAuth credentials
    */
   oauthCredentialsId?: string | null;
 
+  /**
+   * The lifetime of the reward
+   */
+  rewardLifetime?: 'permanent' | 'dynamic' | null;
+
   /**
    * Type of reward issued by this rule
    */
-  rewardType?: 'points' | 'multiplier';
+  rewardType?: 'points' | 'multiplier' | 'badge';
+
+  /**
+   * URL of the Shopify store
+   */
+  shopifyStoreUrl?: string | null;
+
+  /**
+   * Whether to show this rule before the start time
+   */
+  showBeforeStart?: boolean;
 
   /**
    * Start time for the loyalty rule
@@ -1148,9 +1592,9 @@ export interface RuleUpdateResponse {
   startTime?: string | null;
 
   /**
-   * Optional subscription identifier for the rule
+   * Optional subscription id for the rule
    */
-  subscriptionIdentifier?: string | null;
+  subscriptionId?: string | null;
 }
 
 export namespace RuleUpdateResponse {
@@ -1164,13 +1608,17 @@ export namespace RuleUpdateResponse {
      * Blockchain network for the collection
      */
     network:
+      | 'abstract'
+      | 'abstractTestnet'
       | 'apechain'
       | 'arbitrum'
       | 'avalanche'
       | 'avalancheFuji'
       | 'base'
       | 'baseSepolia'
+      | 'berachain'
       | 'berachainArtio'
+      | 'berachainBepolia'
       | 'binance'
       | 'bscTestnet'
       | 'campTestnet'
@@ -1178,18 +1626,28 @@ export namespace RuleUpdateResponse {
       | 'fantomTestnet'
       | 'flowMainnet'
       | 'mainnet'
+      | 'nexusTestnet'
       | 'optimism'
       | 'polygon'
       | 'polygon_mumbai'
       | 'skaleNebula'
       | 'solana'
       | 'sophon'
+      | 'sophonTestnet'
       | 'sui'
       | 'superseed'
       | 'superseedSepolia'
       | 'vanar'
       | 'xai'
       | 'zksync'
+      | 'coti'
+      | 'cotiTestnet'
+      | 'morph'
+      | 'morphTestnet'
+      | 'morphHolesky'
+      | 'ultra'
+      | 'ultraTestnet'
+      | 'nitrograph'
       | 'sepolia'
       | 'optimism_sepolia'
       | 'arbitrumSepolia'
@@ -1197,13 +1655,23 @@ export namespace RuleUpdateResponse {
       | 'optimism_goerli'
       | 'arbitrumGoerli'
       | 'basecamp'
-      | 'abstract';
+      | 'somnia';
+
+    /**
+     * Symbol of the collection.
+     */
+    symbol?: string;
   }
 
   /**
    * Additional metadata for the loyalty rule
    */
   export interface Metadata {
+    /**
+     * Number of tokens per batch.
+     */
+    batchSize?: number | null;
+
     /**
      * Text displayed on the action button.
      */
@@ -1227,7 +1695,7 @@ export namespace RuleUpdateResponse {
     /**
      * Text to check in the Twitter post, username, or bio.
      */
-    checkText?: string | null;
+    checkText?: string | Array<string> | null;
 
     /**
      * Array of collections associated with the rule.
@@ -1237,7 +1705,12 @@ export namespace RuleUpdateResponse {
     /**
      * Conditions for completing the profile.
      */
-    completeProfileConditions?: Record<string, boolean> | null;
+    completeProfileConditions?: { [key: string]: boolean } | null;
+
+    /**
+     * Description of the external rule condition (only for external rules)
+     */
+    conditionDescription?: string;
 
     /**
      * Object containing details for the call-to-action.
@@ -1249,6 +1722,11 @@ export namespace RuleUpdateResponse {
      */
     customRewardsApiKey?: string;
 
+    /**
+     * Flag indicating if the rule should use direct RPC to get the balance of tokens.
+     */
+    directRpc?: boolean;
+
     /**
      * Array of Discord servers, channels, and roles to join.
      */
@@ -1294,11 +1772,6 @@ export namespace RuleUpdateResponse {
      */
     hasNeverSold?: boolean;
 
-    /**
-     * Flag indicating whether the order source is included.
-     */
-    hasOrderSource?: boolean;
-
     /**
      * Indicates if the full royalty has been paid for items.
      */
@@ -1319,11 +1792,21 @@ export namespace RuleUpdateResponse {
      */
     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.
      */
@@ -1339,6 +1822,11 @@ export namespace RuleUpdateResponse {
      */
     link?: string | null;
 
+    /**
+     * Liquidity pool details.
+     */
+    liquidity?: Metadata.Liquidity;
+
     /**
      * Maximum quantity constraint for token holding.
      */
@@ -1380,14 +1868,24 @@ export namespace RuleUpdateResponse {
     onlyRewardSingleTokenOwnership?: boolean | null;
 
     /**
-     * Order source of the order for the token sale
+     * Promotional code associated with the rule.
+     */
+    promoCode?: string;
+
+    /**
+     * URL of the CSV file containing promo codes.
      */
-    orderSource?: string;
+    promoCodeCsvUrl?: string;
 
     /**
-     * Promotional code associated with the rule.
+     * Numbers of the promotional code to be generated.
      */
-    promoCode?: string;
+    promoCodeLength?: number | null;
+
+    /**
+     * Type of the promotional code.
+     */
+    promoCodeType?: 'code' | 'csv' | 'generate';
 
     /**
      * Array defining ranges and corresponding rewards.
@@ -1404,11 +1902,62 @@ export namespace RuleUpdateResponse {
      */
     referrerReward?: number | null;
 
+    /**
+     * Loyalty currency ID of the referrer reward.
+     */
+    referrerRewardLoyaltyCurrencyId?: string | null;
+
+    /**
+     * Flag indicating if the post link is required.
+     */
+    requirePostLink?: boolean | null;
+
+    /**
+     * Flag indicating if media metadata is required.
+     */
+    requirePostMediaLink?: boolean | 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;
+
+    /**
+     * Criteria to evaluate the reward.
+     */
+    rewardCriteria?: 'IMPRESSIONS_COUNT' | 'ELIGIBLE_POST' | null;
+
+    /**
+     * Flag indicating if the reward is rewarded per action.
+     */
+    rewardPerAction?: 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;
+
+    /**
+     * Wallet address of the user can only be used if userId is not provided
+     */
+    royaltyAddress?: string;
+
+    /**
+     * Royalty percentage of the item.
+     */
+    royaltyPercentage?: number;
+
     /**
      * Currency associated with sales.
      */
@@ -1448,6 +1997,7 @@ export namespace RuleUpdateResponse {
       | 'Twitch'
       | 'X(Twitter)'
       | 'YouTube'
+      | 'Google'
       | null;
 
     /**
@@ -1460,11 +2010,21 @@ export namespace RuleUpdateResponse {
      */
     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.
      */
@@ -1480,6 +2040,12 @@ export namespace RuleUpdateResponse {
      */
     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.
      */
@@ -1523,7 +2089,17 @@ export namespace RuleUpdateResponse {
     /**
      * Type of wallet associated with the rule.
      */
-    walletType?: 'evm' | 'solana' | 'imx' | 'sui' | 'ton' | null;
+    walletType?: 'evm' | 'solana' | 'imx' | 'sui' | 'ton' | 'cosmos' | 'ultra' | 'agw' | null;
+
+    /**
+     * ID of the Youtube channel.
+     */
+    youtubeChannelId?: string | null;
+
+    /**
+     * ID of the Youtube video.
+     */
+    youtubeVideoId?: string | null;
   }
 
   export namespace Metadata {
@@ -1542,13 +2118,17 @@ export namespace RuleUpdateResponse {
        * Blockchain network of the collection.
        */
       network?:
+        | 'abstract'
+        | 'abstractTestnet'
         | 'apechain'
         | 'arbitrum'
         | 'avalanche'
         | 'avalancheFuji'
         | 'base'
         | 'baseSepolia'
+        | 'berachain'
         | 'berachainArtio'
+        | 'berachainBepolia'
         | 'binance'
         | 'bscTestnet'
         | 'campTestnet'
@@ -1556,18 +2136,28 @@ export namespace RuleUpdateResponse {
         | 'fantomTestnet'
         | 'flowMainnet'
         | 'mainnet'
+        | 'nexusTestnet'
         | 'optimism'
         | 'polygon'
         | 'polygon_mumbai'
         | 'skaleNebula'
         | 'solana'
         | 'sophon'
+        | 'sophonTestnet'
         | 'sui'
         | 'superseed'
         | 'superseedSepolia'
         | 'vanar'
         | 'xai'
         | 'zksync'
+        | 'coti'
+        | 'cotiTestnet'
+        | 'morph'
+        | 'morphTestnet'
+        | 'morphHolesky'
+        | 'ultra'
+        | 'ultraTestnet'
+        | 'nitrograph'
         | 'sepolia'
         | 'optimism_sepolia'
         | 'arbitrumSepolia'
@@ -1575,7 +2165,7 @@ export namespace RuleUpdateResponse {
         | 'optimism_goerli'
         | 'arbitrumGoerli'
         | 'basecamp'
-        | 'abstract';
+        | 'somnia';
     }
 
     /**
@@ -1652,6 +2242,105 @@ export namespace RuleUpdateResponse {
       id: string;
     }
 
+    /**
+     * Liquidity pool details.
+     */
+    export 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'
+        | 'nexusTestnet'
+        | 'optimism'
+        | 'polygon'
+        | 'polygon_mumbai'
+        | 'skaleNebula'
+        | 'solana'
+        | 'sophon'
+        | 'sophonTestnet'
+        | 'sui'
+        | 'superseed'
+        | 'superseedSepolia'
+        | 'vanar'
+        | 'xai'
+        | 'zksync'
+        | 'coti'
+        | 'cotiTestnet'
+        | 'morph'
+        | 'morphTestnet'
+        | 'morphHolesky'
+        | 'ultra'
+        | 'ultraTestnet'
+        | 'nitrograph'
+        | 'sepolia'
+        | 'optimism_sepolia'
+        | 'arbitrumSepolia'
+        | 'goerli'
+        | 'optimism_goerli'
+        | 'arbitrumGoerli'
+        | 'basecamp'
+        | 'somnia';
+
+      /**
+       * 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;
+    }
+
+    export namespace Liquidity {
+      export interface Pool {
+        /**
+         * Unique identifier of the liquidity pool.
+         */
+        id: string;
+      }
+    }
+
     export interface Range {
       /**
        * Reward amount for this range.
@@ -1667,6 +2356,16 @@ export 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;
     }
 
     /**
@@ -1719,20 +2418,15 @@ export namespace RuleUpdateResponse {
      * Object containing details of the associated smart contract.
      */
     export interface SmartContract {
-      /**
-       * ABI of the smart contract.
-       */
-      abi?: string | null;
-
       /**
        * Mapping of addresses for the smart contract.
        */
       addressMapping?: string | null;
 
       /**
-       * Array of bonus details applied to the rule.
+       * Object containing details of the amount multiplier from the event.
        */
-      bonus?: Array<SmartContract.Bonus> | null;
+      amountMultiplier?: SmartContract.AmountMultiplier | null;
 
       /**
        * ID of the smart contract.
@@ -1744,68 +2438,31 @@ export namespace RuleUpdateResponse {
        */
       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;
 
       /**
-       * Flag indicating if a bonus is applied.
-       */
-      withBonus?: boolean | null;
-
-      /**
-       * Flag indicating if a custom range is applied.
+       * Type of the smart contract interaction.
        */
-      withCustomRange?: boolean | null;
-
-      /**
-       * Flag indicating if a maximum limit is applied.
-       */
-      withMax?: boolean | null;
+      type?: 'function' | 'event' | null;
     }
 
     export namespace SmartContract {
-      export 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.
+       * Object containing details of the amount multiplier from the event.
        */
-      export interface CustomRange {
-        /**
-         * End time of the custom range.
-         */
-        endsAt?: string | null;
-
+      export interface AmountMultiplier {
         /**
-         * Start time of the custom range.
+         * Mapping of the value for the smart contract.
          */
-        startsAt?: string | null;
+        valueMapping?: string | null;
       }
 
       export interface Param {
@@ -1849,6 +2506,33 @@ export namespace RuleUpdateResponse {
        */
       streakMilestone: number;
     }
+
+    /**
+     * Metadata for swap loyalty rules
+     */
+    export interface Swap {
+      provider?: 'any' | 'relay' | 'lifi';
+
+      relayReferrerId?: string;
+
+      requireCrossChainSwap?: boolean;
+
+      swappedToChain?: 'any' | number | string;
+
+      swappedToTokens?: Array<Swap.SwappedToToken>;
+
+      tokenMode?: 'any' | 'specific';
+
+      trackTokenAmount?: boolean;
+    }
+
+    export namespace Swap {
+      export interface SwappedToToken {
+        address: string;
+
+        chainId: string;
+      }
+    }
   }
 }
 
@@ -1859,9 +2543,6 @@ export interface RuleListResponse {
 }
 
 export namespace RuleListResponse {
-  /**
-   * Schema for a loyalty rule
-   */
   export interface Data {
     /**
      * Unique identifier for the loyalty rule
@@ -1878,45 +2559,1051 @@ export namespace RuleListResponse {
      */
     createdAt: string;
 
-    /**
-     * Timestamp when the loyalty rule was deleted (if applicable)
-     */
-    deletedAt: string | null;
+    /**
+     * 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
+     */
+    type: string;
+
+    /**
+     * Timestamp when the loyalty rule was last updated
+     */
+    updatedAt: string;
+
+    /**
+     * Unique identifier for the website
+     */
+    websiteId: string;
+
+    /**
+     * 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?: { [key: string]: Data.Metadata };
+  }
+
+  export namespace Data {
+    export 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;
+    }
+
+    export namespace LoyaltyRuleChain {
+      export 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';
+      }
+
+      export namespace LoyaltyCondition {
+        export 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;
+        }
+
+        export namespace Association {
+          export interface LoyaltyRule {
+            /**
+             * Name of the loyalty rule
+             */
+            name: string;
+          }
+        }
+      }
+    }
+
+    export 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 | Array<string> | null;
+
+      /**
+       * Array of collections associated with the rule.
+       */
+      collection?: Array<Metadata.Collection>;
+
+      /**
+       * Conditions for completing the profile.
+       */
+      completeProfileConditions?: { [key: string]: boolean } | null;
+
+      /**
+       * Description of the external rule condition (only for external rules)
+       */
+      conditionDescription?: string;
+
+      /**
+       * Object containing details for the call-to-action.
+       */
+      cta?: Metadata.Cta | null;
+
+      /**
+       * API key for custom rewards integration.
+       */
+      customRewardsApiKey?: string;
+
+      /**
+       * Flag indicating if the rule should use direct RPC to get the balance of tokens.
+       */
+      directRpc?: boolean;
+
+      /**
+       * 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 post link is required.
+       */
+      requirePostLink?: boolean | null;
+
+      /**
+       * Flag indicating if media metadata is required.
+       */
+      requirePostMediaLink?: boolean | 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;
+
+      /**
+       * Criteria to evaluate the reward.
+       */
+      rewardCriteria?: 'IMPRESSIONS_COUNT' | 'ELIGIBLE_POST' | null;
+
+      /**
+       * Flag indicating if the reward is rewarded per action.
+       */
+      rewardPerAction?: 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;
+
+      /**
+       * Wallet address of the user can only be used if userId is not provided
+       */
+      royaltyAddress?: string;
+
+      /**
+       * Royalty percentage of the item.
+       */
+      royaltyPercentage?: number;
+
+      /**
+       * 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' | 'agw' | null;
+
+      /**
+       * ID of the Youtube channel.
+       */
+      youtubeChannelId?: string | null;
+
+      /**
+       * ID of the Youtube video.
+       */
+      youtubeVideoId?: string | null;
+    }
+
+    export namespace Metadata {
+      export 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'
+          | 'nexusTestnet'
+          | 'optimism'
+          | 'polygon'
+          | 'polygon_mumbai'
+          | 'skaleNebula'
+          | 'solana'
+          | 'sophon'
+          | 'sophonTestnet'
+          | 'sui'
+          | 'superseed'
+          | 'superseedSepolia'
+          | 'vanar'
+          | 'xai'
+          | 'zksync'
+          | 'coti'
+          | 'cotiTestnet'
+          | 'morph'
+          | 'morphTestnet'
+          | 'morphHolesky'
+          | 'ultra'
+          | 'ultraTestnet'
+          | 'nitrograph'
+          | 'sepolia'
+          | 'optimism_sepolia'
+          | 'arbitrumSepolia'
+          | 'goerli'
+          | 'optimism_goerli'
+          | 'arbitrumGoerli'
+          | 'basecamp'
+          | 'somnia';
+      }
+
+      /**
+       * Object containing details for the call-to-action.
+       */
+      export interface Cta {
+        /**
+         * Link for the call-to-action.
+         */
+        href?: string | null;
+
+        /**
+         * Label for the call-to-action.
+         */
+        label?: string | null;
+      }
+
+      export 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>;
+      }
+
+      export namespace DiscordServersToJoin {
+        export 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;
+        }
+
+        export namespace Channel {
+          export interface Emoji {
+            /**
+             * ID of the emoji used in the channel.
+             */
+            id?: string;
+          }
+        }
+
+        export interface Role {
+          /**
+           * ID of the role in the Discord server.
+           */
+          id: string;
+        }
+      }
+
+      export interface DripQuestsToComplete {
+        /**
+         * ID of the drip quest to complete.
+         */
+        id: string;
+      }
+
+      /**
+       * Liquidity pool details.
+       */
+      export 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'
+          | 'nexusTestnet'
+          | 'optimism'
+          | 'polygon'
+          | 'polygon_mumbai'
+          | 'skaleNebula'
+          | 'solana'
+          | 'sophon'
+          | 'sophonTestnet'
+          | 'sui'
+          | 'superseed'
+          | 'superseedSepolia'
+          | 'vanar'
+          | 'xai'
+          | 'zksync'
+          | 'coti'
+          | 'cotiTestnet'
+          | 'morph'
+          | 'morphTestnet'
+          | 'morphHolesky'
+          | 'ultra'
+          | 'ultraTestnet'
+          | 'nitrograph'
+          | 'sepolia'
+          | 'optimism_sepolia'
+          | 'arbitrumSepolia'
+          | 'goerli'
+          | 'optimism_goerli'
+          | 'arbitrumGoerli'
+          | 'basecamp'
+          | 'somnia';
+
+        /**
+         * 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;
+      }
+
+      export namespace Liquidity {
+        export interface Pool {
+          /**
+           * Unique identifier of the liquidity pool.
+           */
+          id: string;
+        }
+      }
+
+      export 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.
+       */
+      export 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;
+      }
+
+      export namespace ReferralRequirements {
+        export 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.
+       */
+      export 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;
+
+        /**
+         * ID of the smart contract.
+         */
+        contractId?: string | null;
+
+        /**
+         * Criteria to evaluate the smart contract event.
+         */
+        criteria?: 'everyEvent' | 'byParameter' | null;
+
+        /**
+         * Event emitted by the smart contract.
+         */
+        event?: string | null;
+
+        /**
+         * Array of parameters for the smart contract.
+         */
+        params?: Array<SmartContract.Param> | null;
+
+        /**
+         * Type of the smart contract interaction.
+         */
+        type?: 'function' | 'event' | null;
+      }
+
+      export namespace SmartContract {
+        /**
+         * Object containing details of the amount multiplier from the event.
+         */
+        export interface AmountMultiplier {
+          /**
+           * Mapping of the value for the smart contract.
+           */
+          valueMapping?: string | null;
+        }
+
+        export 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;
+        }
+      }
+
+      export interface SnapshotProposal {
+        /**
+         * ID of the snapshot proposal.
+         */
+        id: string;
+
+        /**
+         * Space associated with the snapshot proposal.
+         */
+        space: string;
+      }
+
+      export interface StreakArray {
+        /**
+         * Reward amount for achieving the streak milestone.
+         */
+        streakAmount: number;
+
+        /**
+         * Milestone required to achieve the streak.
+         */
+        streakMilestone: number;
+      }
+
+      /**
+       * Metadata for swap loyalty rules
+       */
+      export interface Swap {
+        provider?: 'any' | 'relay' | 'lifi';
 
-    /**
-     * Frequency of the loyalty rule
-     */
-    frequency: string;
+        relayReferrerId?: string;
 
-    /**
-     * Unique identifier for the organization
-     */
-    organizationId: string;
+        requireCrossChainSwap?: boolean;
 
-    /**
-     * Type of the loyalty rule
-     */
-    type: string;
+        swappedToChain?: 'any' | number | string;
 
-    /**
-     * Timestamp when the loyalty rule was last updated
-     */
-    updatedAt: string;
+        swappedToTokens?: Array<Swap.SwappedToToken>;
 
-    /**
-     * Unique identifier for the website
-     */
-    websiteId: string;
+        tokenMode?: 'any' | 'specific';
 
-    /**
-     * Optional address of the collection
-     */
-    collectionAddress?: string;
+        trackTokenAmount?: boolean;
+      }
 
-    /**
-     * Optional metadata for the loyalty rule
-     */
-    metadata?: Record<string, unknown>;
+      export namespace Swap {
+        export interface SwappedToToken {
+          address: string;
+
+          chainId: string;
+        }
+      }
+    }
   }
 }
 
@@ -1927,7 +3614,9 @@ export interface RuleDeleteResponse {
 }
 
 export interface RuleCompleteResponse {
-  message: string;
+  message:
+    | 'Completion request added to queue'
+    | 'Link click being verified, come back later to check the status';
 }
 
 export interface RuleGetStatusResponse {
@@ -1938,11 +3627,99 @@ export namespace RuleGetStatusResponse {
   export interface Data {
     loyaltyRuleId: string;
 
-    status: 'pending' | 'processing' | 'completed' | 'failed';
-
     userId: string;
 
+    /**
+     * Categorized examples of messages that may be returned for a loyalty rule's
+     * processing result.
+     *
+     * User Onboarding
+     *
+     * - Check In: "Streak successful"
+     * - Complete Profile Details: "Profile not complete"
+     *
+     * Connect Accounts
+     *
+     * - Connect TikTok: "TikTok not connected"
+     * - Connect Discord: "Discord not connected", "Discord request timeout"
+     * - Connect X: "Twitter not connected", "Twitter not connected or content url is
+     *   required"
+     * - Connect Email: "Email address not connected"
+     * - Connect Telegram: "Telegram not connected", "user has not setup telegram (no
+     *   telegramUsername), please setup username in telegram and reconnect.",
+     *   "Telegram request rate-limited"
+     * - Connect Steam: "Steam not connected"
+     * - Connect Youtube: "Youtube not connected"
+     *
+     *       Social Quests
+     *
+     * - Join Telegram Group: "Telegram Channel not joined", "Telegram Channel joined
+     *   successfully"
+     * - Post on TikTok: "TikTok post not verified"
+     * - Comment on an X Post: "Quest Completed: You have commented on the tweet",
+     *   "Quest Not Completed: Comment not found for the specified tweet"
+     * - Repost an X Post: "Quest Completed: You have retweeted the tweet", "Quest Not
+     *   Completed: Retweet not found for the specified tweet", "Quest Completed: You
+     *   have retweeted and commented on the tweet", "Quest Not Completed: You have not
+     *   retweeted or commented on the tweet"
+     * - Follow an X Account: "Missing required parameters: twitterUserId,
+     *   targetUsername", "Quest Completed: You are a follower of
+     *   @${targetUsername}", "Quest Not Completed: Please follow @${targetUsername}
+     *   and try again in few minutes"
+     * - React to an X Post: "Missing required parameters: texts, twitterUserId,
+     *   userTweetId", "No text provided", "Quest Completed: You have posted {tweetId}
+     *   a tweet with the text {text}", "Quest Not Completed: Your all previous {COUNT}
+     *   posts are already claimed. Please post a new tweet and try again in a few
+     *   minutes.", "Tweet is already claimed", "Tweet does not belong to the user",
+     *   "Text not found in tweet", "Tweet is before the quest start time", "Tweet does
+     *   not have media", "Text found in tweet"
+     * - Add Text to X Bio: "Missing required parameters: texts, twitterUserId", "User
+     *   not found", "Text found in bio", "Text not found in bio"
+     * - Add Text to X Username: "Missing required parameters: texts, twitterUserId",
+     *   "User not found", "Text found in username", "Text not found in username"
+     * - Comment on an X Post with Text: "Missing required parameters: texts,
+     *   twitterUserId", "Comment is already claimed", "Text found in comment", "Text
+     *   not found in comment", "Tweet not found or could not be retrieved"
+     * - Comment on a YouTube Video: "Youtube comment added", "Youtube comment not
+     *   added"
+     * - Subscribe to a YouTube Channel: "Youtube channel subscribed", "Quest failed,
+     *   please make sure you have made your subscriptions public in youtube"
+     * - Get X post impressions: "You've already claimed the reward for this impression
+     *   range."
+     * - Add an Item to Steam Wishlist: "Steam Wishlist item added", "Steam Wishlist
+     *   item not added"
+     *
+     * Complex Onchain Logic
+     *
+     * - Token Swap: "Swap rewards calculated successfully", "Swap rule failed"
+     *
+     * Other
+     *
+     * - Answer a Quiz: "Quiz question not configured", "No question response found",
+     *   "Incorrect answer", "Correct answer"
+     * - Answer a Poll: "Poll question not configured", "Poll response recorded"
+     * - Spend in Shopify Store: "Shopify not connected"
+     * - Points Airdrop: "Seems like you're not eligible for this points airdrop."
+     *
+     *       General / Unmatched
+     *
+     * - "Quest already completed"
+     * - "Quest already completed using the same social account (${socialAccountName}),
+     *   with the different user."
+     * - "You've already claimed the reward for this quest."
+     * - "Quest not achieved, please try again."
+     * - "Rule is not setup"
+     * - "Request aborted due to timeout"
+     * - "Google account not connected"
+     * - "Claim failed: Multiplier is already active"
+     */
     message?: string;
+
+    /**
+     * Status of the queued job, this is only returned if the job is queued and being
+     * processed, this wil be retained for 10 minutes after the job is completed
+     */
+    status?: 'pending' | 'processing' | 'completed' | 'failed';
   }
 }
 
@@ -2053,7 +3830,20 @@ export interface RuleCreateParams {
     | 'twitter_like'
     | 'twitter_post_hashtag'
     | 'quiz'
-    | 'poll';
+    | 'poll'
+    | 'steam_wishlist'
+    | 'liquidity_uniswap_v2'
+    | 'liquidity_uniswap_v3'
+    | 'points_airdrop'
+    | 'youtube_subscribers'
+    | 'youtube_comment'
+    | 'shopify_spend'
+    | 'swap'
+    | 'tiktok_post'
+    | 'post_impressions'
+    | 'discord_join'
+    | 'connected_youtube'
+    | 'connected_tiktok';
 
   /**
    * Unique identifier for the associated website
@@ -2065,6 +3855,11 @@ export interface RuleCreateParams {
    */
   backgroundAssetUrl?: string;
 
+  /**
+   * The type of claim for the reward
+   */
+  claimType?: 'manual' | 'auto' | null;
+
   /**
    * Blockchain address of the associated collection
    */
@@ -2090,6 +3885,13 @@ export interface RuleCreateParams {
    */
   description?: string;
 
+  duplicatedFromId?: string | null;
+
+  /**
+   * ID of the external integration
+   */
+  externalIntegrationId?: string | null;
+
   /**
    * Whether to hide this rule in the user interface
    */
@@ -2098,18 +3900,40 @@ export interface RuleCreateParams {
   /**
    * Interval between rule executions
    */
-  interval?: 'daily' | 'weekly' | 'monthly' | 'once' | 'custom' | 'every_message' | null;
+  interval?: 'daily' | 'weekly' | 'monthly' | 'once' | 'custom' | 'every_message' | 'unlimited' | 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
    */
@@ -2119,13 +3943,17 @@ export interface RuleCreateParams {
    * Blockchain network where the rule will apply
    */
   network?:
+    | 'abstract'
+    | 'abstractTestnet'
     | 'apechain'
     | 'arbitrum'
     | 'avalanche'
     | 'avalancheFuji'
     | 'base'
     | 'baseSepolia'
+    | 'berachain'
     | 'berachainArtio'
+    | 'berachainBepolia'
     | 'binance'
     | 'bscTestnet'
     | 'campTestnet'
@@ -2133,18 +3961,28 @@ export interface RuleCreateParams {
     | 'fantomTestnet'
     | 'flowMainnet'
     | 'mainnet'
+    | 'nexusTestnet'
     | 'optimism'
     | 'polygon'
     | 'polygon_mumbai'
     | 'skaleNebula'
     | 'solana'
     | 'sophon'
+    | 'sophonTestnet'
     | 'sui'
     | 'superseed'
     | 'superseedSepolia'
     | 'vanar'
     | 'xai'
     | 'zksync'
+    | 'coti'
+    | 'cotiTestnet'
+    | 'morph'
+    | 'morphTestnet'
+    | 'morphHolesky'
+    | 'ultra'
+    | 'ultraTestnet'
+    | 'nitrograph'
     | 'sepolia'
     | 'optimism_sepolia'
     | 'arbitrumSepolia'
@@ -2152,22 +3990,37 @@ export interface RuleCreateParams {
     | 'optimism_goerli'
     | 'arbitrumGoerli'
     | 'basecamp'
-    | 'abstract';
+    | 'somnia';
 
   /**
    * OAuth credentials associated with the rule
    */
   oauthCredentialsId?: string | null;
 
+  /**
+   * The lifetime of the reward
+   */
+  rewardLifetime?: 'permanent' | 'dynamic' | null;
+
   /**
    * Type of reward issued by the rule
    */
-  rewardType?: 'points' | 'multiplier';
+  rewardType?: 'points' | 'multiplier' | 'badge';
+
+  /**
+   * URL of the Shopify store
+   */
+  shopifyStoreUrl?: string | null;
+
+  /**
+   * Whether to show this rule before the start time
+   */
+  showBeforeStart?: boolean;
 
   /**
-   * Identifier for associated subscriptions
+   * Optional subscription id for the rule
    */
-  subscriptionIdentifier?: string | null;
+  subscriptionId?: string | null;
 }
 
 export namespace RuleCreateParams {
@@ -2175,6 +4028,11 @@ export namespace RuleCreateParams {
    * Additional metadata for the loyalty rule
    */
   export interface Metadata {
+    /**
+     * Number of tokens per batch.
+     */
+    batchSize?: number | null;
+
     /**
      * Text displayed on the action button.
      */
@@ -2198,7 +4056,7 @@ export namespace RuleCreateParams {
     /**
      * Text to check in the Twitter post, username, or bio.
      */
-    checkText?: string | null;
+    checkText?: string | Array<string> | null;
 
     /**
      * Array of collections associated with the rule.
@@ -2208,7 +4066,12 @@ export namespace RuleCreateParams {
     /**
      * Conditions for completing the profile.
      */
-    completeProfileConditions?: Record<string, boolean> | null;
+    completeProfileConditions?: { [key: string]: boolean } | null;
+
+    /**
+     * Description of the external rule condition (only for external rules)
+     */
+    conditionDescription?: string;
 
     /**
      * Object containing details for the call-to-action.
@@ -2220,6 +4083,11 @@ export namespace RuleCreateParams {
      */
     customRewardsApiKey?: string;
 
+    /**
+     * Flag indicating if the rule should use direct RPC to get the balance of tokens.
+     */
+    directRpc?: boolean;
+
     /**
      * Array of Discord servers, channels, and roles to join.
      */
@@ -2265,11 +4133,6 @@ export namespace RuleCreateParams {
      */
     hasNeverSold?: boolean;
 
-    /**
-     * Flag indicating whether the order source is included.
-     */
-    hasOrderSource?: boolean;
-
     /**
      * Indicates if the full royalty has been paid for items.
      */
@@ -2290,11 +4153,21 @@ export namespace RuleCreateParams {
      */
     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.
      */
@@ -2310,6 +4183,11 @@ export namespace RuleCreateParams {
      */
     link?: string | null;
 
+    /**
+     * Liquidity pool details.
+     */
+    liquidity?: Metadata.Liquidity;
+
     /**
      * Maximum quantity constraint for token holding.
      */
@@ -2351,14 +4229,24 @@ export namespace RuleCreateParams {
     onlyRewardSingleTokenOwnership?: boolean | null;
 
     /**
-     * Order source of the order for the token sale
+     * Promotional code associated with the rule.
+     */
+    promoCode?: string;
+
+    /**
+     * URL of the CSV file containing promo codes.
      */
-    orderSource?: string;
+    promoCodeCsvUrl?: string;
 
     /**
-     * Promotional code associated with the rule.
+     * Numbers of the promotional code to be generated.
      */
-    promoCode?: string;
+    promoCodeLength?: number | null;
+
+    /**
+     * Type of the promotional code.
+     */
+    promoCodeType?: 'code' | 'csv' | 'generate';
 
     /**
      * Array defining ranges and corresponding rewards.
@@ -2375,11 +4263,62 @@ export namespace RuleCreateParams {
      */
     referrerReward?: number | null;
 
+    /**
+     * Loyalty currency ID of the referrer reward.
+     */
+    referrerRewardLoyaltyCurrencyId?: string | null;
+
+    /**
+     * Flag indicating if the post link is required.
+     */
+    requirePostLink?: boolean | null;
+
+    /**
+     * Flag indicating if media metadata is required.
+     */
+    requirePostMediaLink?: boolean | 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;
+
+    /**
+     * Criteria to evaluate the reward.
+     */
+    rewardCriteria?: 'IMPRESSIONS_COUNT' | 'ELIGIBLE_POST' | null;
+
+    /**
+     * Flag indicating if the reward is rewarded per action.
+     */
+    rewardPerAction?: 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;
+
+    /**
+     * Wallet address of the user can only be used if userId is not provided
+     */
+    royaltyAddress?: string;
+
+    /**
+     * Royalty percentage of the item.
+     */
+    royaltyPercentage?: number;
+
     /**
      * Currency associated with sales.
      */
@@ -2419,6 +4358,7 @@ export namespace RuleCreateParams {
       | 'Twitch'
       | 'X(Twitter)'
       | 'YouTube'
+      | 'Google'
       | null;
 
     /**
@@ -2431,11 +4371,21 @@ export namespace RuleCreateParams {
      */
     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.
      */
@@ -2451,6 +4401,12 @@ export namespace RuleCreateParams {
      */
     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.
      */
@@ -2494,7 +4450,17 @@ export namespace RuleCreateParams {
     /**
      * Type of wallet associated with the rule.
      */
-    walletType?: 'evm' | 'solana' | 'imx' | 'sui' | 'ton' | null;
+    walletType?: 'evm' | 'solana' | 'imx' | 'sui' | 'ton' | 'cosmos' | 'ultra' | 'agw' | null;
+
+    /**
+     * ID of the Youtube channel.
+     */
+    youtubeChannelId?: string | null;
+
+    /**
+     * ID of the Youtube video.
+     */
+    youtubeVideoId?: string | null;
   }
 
   export namespace Metadata {
@@ -2513,13 +4479,17 @@ export namespace RuleCreateParams {
        * Blockchain network of the collection.
        */
       network?:
+        | 'abstract'
+        | 'abstractTestnet'
         | 'apechain'
         | 'arbitrum'
         | 'avalanche'
         | 'avalancheFuji'
         | 'base'
         | 'baseSepolia'
+        | 'berachain'
         | 'berachainArtio'
+        | 'berachainBepolia'
         | 'binance'
         | 'bscTestnet'
         | 'campTestnet'
@@ -2527,18 +4497,28 @@ export namespace RuleCreateParams {
         | 'fantomTestnet'
         | 'flowMainnet'
         | 'mainnet'
+        | 'nexusTestnet'
         | 'optimism'
         | 'polygon'
         | 'polygon_mumbai'
         | 'skaleNebula'
         | 'solana'
         | 'sophon'
+        | 'sophonTestnet'
         | 'sui'
         | 'superseed'
         | 'superseedSepolia'
         | 'vanar'
         | 'xai'
         | 'zksync'
+        | 'coti'
+        | 'cotiTestnet'
+        | 'morph'
+        | 'morphTestnet'
+        | 'morphHolesky'
+        | 'ultra'
+        | 'ultraTestnet'
+        | 'nitrograph'
         | 'sepolia'
         | 'optimism_sepolia'
         | 'arbitrumSepolia'
@@ -2546,7 +4526,7 @@ export namespace RuleCreateParams {
         | 'optimism_goerli'
         | 'arbitrumGoerli'
         | 'basecamp'
-        | 'abstract';
+        | 'somnia';
     }
 
     /**
@@ -2623,6 +4603,105 @@ export namespace RuleCreateParams {
       id: string;
     }
 
+    /**
+     * Liquidity pool details.
+     */
+    export 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'
+        | 'nexusTestnet'
+        | 'optimism'
+        | 'polygon'
+        | 'polygon_mumbai'
+        | 'skaleNebula'
+        | 'solana'
+        | 'sophon'
+        | 'sophonTestnet'
+        | 'sui'
+        | 'superseed'
+        | 'superseedSepolia'
+        | 'vanar'
+        | 'xai'
+        | 'zksync'
+        | 'coti'
+        | 'cotiTestnet'
+        | 'morph'
+        | 'morphTestnet'
+        | 'morphHolesky'
+        | 'ultra'
+        | 'ultraTestnet'
+        | 'nitrograph'
+        | 'sepolia'
+        | 'optimism_sepolia'
+        | 'arbitrumSepolia'
+        | 'goerli'
+        | 'optimism_goerli'
+        | 'arbitrumGoerli'
+        | 'basecamp'
+        | 'somnia';
+
+      /**
+       * 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;
+    }
+
+    export namespace Liquidity {
+      export interface Pool {
+        /**
+         * Unique identifier of the liquidity pool.
+         */
+        id: string;
+      }
+    }
+
     export interface Range {
       /**
        * Reward amount for this range.
@@ -2638,6 +4717,16 @@ export 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;
     }
 
     /**
@@ -2690,20 +4779,15 @@ export namespace RuleCreateParams {
      * Object containing details of the associated smart contract.
      */
     export interface SmartContract {
-      /**
-       * ABI of the smart contract.
-       */
-      abi?: string | null;
-
       /**
        * Mapping of addresses for the smart contract.
        */
       addressMapping?: string | null;
 
       /**
-       * Array of bonus details applied to the rule.
+       * Object containing details of the amount multiplier from the event.
        */
-      bonus?: Array<SmartContract.Bonus> | null;
+      amountMultiplier?: SmartContract.AmountMultiplier | null;
 
       /**
        * ID of the smart contract.
@@ -2715,68 +4799,31 @@ export namespace RuleCreateParams {
        */
       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;
 
       /**
-       * Flag indicating if a bonus is applied.
-       */
-      withBonus?: boolean | null;
-
-      /**
-       * Flag indicating if a custom range is applied.
-       */
-      withCustomRange?: boolean | null;
-
-      /**
-       * Flag indicating if a maximum limit is applied.
+       * Type of the smart contract interaction.
        */
-      withMax?: boolean | null;
+      type?: 'function' | 'event' | null;
     }
 
     export namespace SmartContract {
-      export 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.
+       * Object containing details of the amount multiplier from the event.
        */
-      export interface CustomRange {
-        /**
-         * End time of the custom range.
-         */
-        endsAt?: string | null;
-
+      export interface AmountMultiplier {
         /**
-         * Start time of the custom range.
+         * Mapping of the value for the smart contract.
          */
-        startsAt?: string | null;
+        valueMapping?: string | null;
       }
 
       export interface Param {
@@ -2820,6 +4867,33 @@ export namespace RuleCreateParams {
        */
       streakMilestone: number;
     }
+
+    /**
+     * Metadata for swap loyalty rules
+     */
+    export interface Swap {
+      provider?: 'any' | 'relay' | 'lifi';
+
+      relayReferrerId?: string;
+
+      requireCrossChainSwap?: boolean;
+
+      swappedToChain?: 'any' | number | string;
+
+      swappedToTokens?: Array<Swap.SwappedToToken>;
+
+      tokenMode?: 'any' | 'specific';
+
+      trackTokenAmount?: boolean;
+    }
+
+    export namespace Swap {
+      export interface SwappedToToken {
+        address: string;
+
+        chainId: string;
+      }
+    }
   }
 
   export interface Collection {
@@ -2832,13 +4906,17 @@ export namespace RuleCreateParams {
      * Blockchain network for the collection
      */
     network:
+      | 'abstract'
+      | 'abstractTestnet'
       | 'apechain'
       | 'arbitrum'
       | 'avalanche'
       | 'avalancheFuji'
       | 'base'
       | 'baseSepolia'
+      | 'berachain'
       | 'berachainArtio'
+      | 'berachainBepolia'
       | 'binance'
       | 'bscTestnet'
       | 'campTestnet'
@@ -2846,18 +4924,28 @@ export namespace RuleCreateParams {
       | 'fantomTestnet'
       | 'flowMainnet'
       | 'mainnet'
+      | 'nexusTestnet'
       | 'optimism'
       | 'polygon'
       | 'polygon_mumbai'
       | 'skaleNebula'
       | 'solana'
       | 'sophon'
+      | 'sophonTestnet'
       | 'sui'
       | 'superseed'
       | 'superseedSepolia'
       | 'vanar'
       | 'xai'
       | 'zksync'
+      | 'coti'
+      | 'cotiTestnet'
+      | 'morph'
+      | 'morphTestnet'
+      | 'morphHolesky'
+      | 'ultra'
+      | 'ultraTestnet'
+      | 'nitrograph'
       | 'sepolia'
       | 'optimism_sepolia'
       | 'arbitrumSepolia'
@@ -2865,7 +4953,12 @@ export namespace RuleCreateParams {
       | 'optimism_goerli'
       | 'arbitrumGoerli'
       | 'basecamp'
-      | 'abstract';
+      | 'somnia';
+
+    /**
+     * Symbol of the collection.
+     */
+    symbol?: string;
   }
 }
 
@@ -2885,6 +4978,11 @@ export interface RuleUpdateParams {
    */
   name: string;
 
+  /**
+   * The type of claim for the reward
+   */
+  claimType?: 'manual' | 'auto' | null;
+
   /**
    * Blockchain address of the associated collection
    */
@@ -2920,6 +5018,11 @@ export interface RuleUpdateParams {
    */
   effectiveStartTime?: string | null;
 
+  /**
+   * ID of the external integration
+   */
+  externalIntegrationId?: string | null;
+
   /**
    * Frequency of the rule execution
    */
@@ -2933,7 +5036,7 @@ export interface RuleUpdateParams {
   /**
    * Time interval for recurring rule execution
    */
-  interval?: 'daily' | 'weekly' | 'monthly' | 'once' | 'custom' | 'every_message' | null;
+  interval?: 'daily' | 'weekly' | 'monthly' | 'once' | 'custom' | 'every_message' | 'unlimited' | null;
 
   /**
    * Whether this rule is required for participation
@@ -2945,6 +5048,18 @@ export interface RuleUpdateParams {
    */
   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
    */
@@ -2959,13 +5074,17 @@ export interface RuleUpdateParams {
    * Blockchain network where the rule will apply
    */
   network?:
+    | 'abstract'
+    | 'abstractTestnet'
     | 'apechain'
     | 'arbitrum'
     | 'avalanche'
     | 'avalancheFuji'
     | 'base'
     | 'baseSepolia'
+    | 'berachain'
     | 'berachainArtio'
+    | 'berachainBepolia'
     | 'binance'
     | 'bscTestnet'
     | 'campTestnet'
@@ -2973,18 +5092,28 @@ export interface RuleUpdateParams {
     | 'fantomTestnet'
     | 'flowMainnet'
     | 'mainnet'
+    | 'nexusTestnet'
     | 'optimism'
     | 'polygon'
     | 'polygon_mumbai'
     | 'skaleNebula'
     | 'solana'
     | 'sophon'
+    | 'sophonTestnet'
     | 'sui'
     | 'superseed'
     | 'superseedSepolia'
     | 'vanar'
     | 'xai'
     | 'zksync'
+    | 'coti'
+    | 'cotiTestnet'
+    | 'morph'
+    | 'morphTestnet'
+    | 'morphHolesky'
+    | 'ultra'
+    | 'ultraTestnet'
+    | 'nitrograph'
     | 'sepolia'
     | 'optimism_sepolia'
     | 'arbitrumSepolia'
@@ -2992,17 +5121,32 @@ export interface RuleUpdateParams {
     | 'optimism_goerli'
     | 'arbitrumGoerli'
     | 'basecamp'
-    | 'abstract';
+    | 'somnia';
 
   /**
    * ID for associated OAuth credentials
    */
   oauthCredentialsId?: string | null;
 
+  /**
+   * The lifetime of the reward
+   */
+  rewardLifetime?: 'permanent' | 'dynamic' | null;
+
   /**
    * Type of reward issued by this rule
    */
-  rewardType?: 'points' | 'multiplier';
+  rewardType?: 'points' | 'multiplier' | 'badge';
+
+  /**
+   * URL of the Shopify store
+   */
+  shopifyStoreUrl?: string | null;
+
+  /**
+   * Whether to show this rule before the start time
+   */
+  showBeforeStart?: boolean;
 
   /**
    * Start time for the loyalty rule
@@ -3010,9 +5154,9 @@ export interface RuleUpdateParams {
   startTime?: string | null;
 
   /**
-   * Optional subscription identifier for the rule
+   * Optional subscription id for the rule
    */
-  subscriptionIdentifier?: string | null;
+  subscriptionId?: string | null;
 }
 
 export namespace RuleUpdateParams {
@@ -3026,13 +5170,17 @@ export namespace RuleUpdateParams {
      * Blockchain network for the collection
      */
     network:
+      | 'abstract'
+      | 'abstractTestnet'
       | 'apechain'
       | 'arbitrum'
       | 'avalanche'
       | 'avalancheFuji'
       | 'base'
       | 'baseSepolia'
+      | 'berachain'
       | 'berachainArtio'
+      | 'berachainBepolia'
       | 'binance'
       | 'bscTestnet'
       | 'campTestnet'
@@ -3040,18 +5188,28 @@ export namespace RuleUpdateParams {
       | 'fantomTestnet'
       | 'flowMainnet'
       | 'mainnet'
+      | 'nexusTestnet'
       | 'optimism'
       | 'polygon'
       | 'polygon_mumbai'
       | 'skaleNebula'
       | 'solana'
       | 'sophon'
+      | 'sophonTestnet'
       | 'sui'
       | 'superseed'
       | 'superseedSepolia'
       | 'vanar'
       | 'xai'
       | 'zksync'
+      | 'coti'
+      | 'cotiTestnet'
+      | 'morph'
+      | 'morphTestnet'
+      | 'morphHolesky'
+      | 'ultra'
+      | 'ultraTestnet'
+      | 'nitrograph'
       | 'sepolia'
       | 'optimism_sepolia'
       | 'arbitrumSepolia'
@@ -3059,13 +5217,23 @@ export namespace RuleUpdateParams {
       | 'optimism_goerli'
       | 'arbitrumGoerli'
       | 'basecamp'
-      | 'abstract';
+      | 'somnia';
+
+    /**
+     * Symbol of the collection.
+     */
+    symbol?: string;
   }
 
   /**
    * Additional metadata for the loyalty rule
    */
   export interface Metadata {
+    /**
+     * Number of tokens per batch.
+     */
+    batchSize?: number | null;
+
     /**
      * Text displayed on the action button.
      */
@@ -3089,7 +5257,7 @@ export namespace RuleUpdateParams {
     /**
      * Text to check in the Twitter post, username, or bio.
      */
-    checkText?: string | null;
+    checkText?: string | Array<string> | null;
 
     /**
      * Array of collections associated with the rule.
@@ -3099,7 +5267,12 @@ export namespace RuleUpdateParams {
     /**
      * Conditions for completing the profile.
      */
-    completeProfileConditions?: Record<string, boolean> | null;
+    completeProfileConditions?: { [key: string]: boolean } | null;
+
+    /**
+     * Description of the external rule condition (only for external rules)
+     */
+    conditionDescription?: string;
 
     /**
      * Object containing details for the call-to-action.
@@ -3111,6 +5284,11 @@ export namespace RuleUpdateParams {
      */
     customRewardsApiKey?: string;
 
+    /**
+     * Flag indicating if the rule should use direct RPC to get the balance of tokens.
+     */
+    directRpc?: boolean;
+
     /**
      * Array of Discord servers, channels, and roles to join.
      */
@@ -3156,11 +5334,6 @@ export namespace RuleUpdateParams {
      */
     hasNeverSold?: boolean;
 
-    /**
-     * Flag indicating whether the order source is included.
-     */
-    hasOrderSource?: boolean;
-
     /**
      * Indicates if the full royalty has been paid for items.
      */
@@ -3181,11 +5354,21 @@ export namespace RuleUpdateParams {
      */
     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.
      */
@@ -3201,6 +5384,11 @@ export namespace RuleUpdateParams {
      */
     link?: string | null;
 
+    /**
+     * Liquidity pool details.
+     */
+    liquidity?: Metadata.Liquidity;
+
     /**
      * Maximum quantity constraint for token holding.
      */
@@ -3242,14 +5430,24 @@ export namespace RuleUpdateParams {
     onlyRewardSingleTokenOwnership?: boolean | null;
 
     /**
-     * Order source of the order for the token sale
+     * Promotional code associated with the rule.
      */
-    orderSource?: string;
+    promoCode?: string;
 
     /**
-     * Promotional code associated with the rule.
+     * URL of the CSV file containing promo codes.
      */
-    promoCode?: string;
+    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.
@@ -3266,11 +5464,62 @@ export namespace RuleUpdateParams {
      */
     referrerReward?: number | null;
 
+    /**
+     * Loyalty currency ID of the referrer reward.
+     */
+    referrerRewardLoyaltyCurrencyId?: string | null;
+
+    /**
+     * Flag indicating if the post link is required.
+     */
+    requirePostLink?: boolean | null;
+
+    /**
+     * Flag indicating if media metadata is required.
+     */
+    requirePostMediaLink?: boolean | 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;
+
+    /**
+     * Criteria to evaluate the reward.
+     */
+    rewardCriteria?: 'IMPRESSIONS_COUNT' | 'ELIGIBLE_POST' | null;
+
+    /**
+     * Flag indicating if the reward is rewarded per action.
+     */
+    rewardPerAction?: 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;
+
+    /**
+     * Wallet address of the user can only be used if userId is not provided
+     */
+    royaltyAddress?: string;
+
+    /**
+     * Royalty percentage of the item.
+     */
+    royaltyPercentage?: number;
+
     /**
      * Currency associated with sales.
      */
@@ -3310,6 +5559,7 @@ export namespace RuleUpdateParams {
       | 'Twitch'
       | 'X(Twitter)'
       | 'YouTube'
+      | 'Google'
       | null;
 
     /**
@@ -3322,11 +5572,21 @@ export namespace RuleUpdateParams {
      */
     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.
      */
@@ -3342,6 +5602,12 @@ export namespace RuleUpdateParams {
      */
     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.
      */
@@ -3385,7 +5651,17 @@ export namespace RuleUpdateParams {
     /**
      * Type of wallet associated with the rule.
      */
-    walletType?: 'evm' | 'solana' | 'imx' | 'sui' | 'ton' | null;
+    walletType?: 'evm' | 'solana' | 'imx' | 'sui' | 'ton' | 'cosmos' | 'ultra' | 'agw' | null;
+
+    /**
+     * ID of the Youtube channel.
+     */
+    youtubeChannelId?: string | null;
+
+    /**
+     * ID of the Youtube video.
+     */
+    youtubeVideoId?: string | null;
   }
 
   export namespace Metadata {
@@ -3404,13 +5680,17 @@ export namespace RuleUpdateParams {
        * Blockchain network of the collection.
        */
       network?:
+        | 'abstract'
+        | 'abstractTestnet'
         | 'apechain'
         | 'arbitrum'
         | 'avalanche'
         | 'avalancheFuji'
         | 'base'
         | 'baseSepolia'
+        | 'berachain'
         | 'berachainArtio'
+        | 'berachainBepolia'
         | 'binance'
         | 'bscTestnet'
         | 'campTestnet'
@@ -3418,18 +5698,28 @@ export namespace RuleUpdateParams {
         | 'fantomTestnet'
         | 'flowMainnet'
         | 'mainnet'
+        | 'nexusTestnet'
         | 'optimism'
         | 'polygon'
         | 'polygon_mumbai'
         | 'skaleNebula'
         | 'solana'
         | 'sophon'
+        | 'sophonTestnet'
         | 'sui'
         | 'superseed'
         | 'superseedSepolia'
         | 'vanar'
         | 'xai'
         | 'zksync'
+        | 'coti'
+        | 'cotiTestnet'
+        | 'morph'
+        | 'morphTestnet'
+        | 'morphHolesky'
+        | 'ultra'
+        | 'ultraTestnet'
+        | 'nitrograph'
         | 'sepolia'
         | 'optimism_sepolia'
         | 'arbitrumSepolia'
@@ -3437,7 +5727,7 @@ export namespace RuleUpdateParams {
         | 'optimism_goerli'
         | 'arbitrumGoerli'
         | 'basecamp'
-        | 'abstract';
+        | 'somnia';
     }
 
     /**
@@ -3514,6 +5804,105 @@ export namespace RuleUpdateParams {
       id: string;
     }
 
+    /**
+     * Liquidity pool details.
+     */
+    export 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'
+        | 'nexusTestnet'
+        | 'optimism'
+        | 'polygon'
+        | 'polygon_mumbai'
+        | 'skaleNebula'
+        | 'solana'
+        | 'sophon'
+        | 'sophonTestnet'
+        | 'sui'
+        | 'superseed'
+        | 'superseedSepolia'
+        | 'vanar'
+        | 'xai'
+        | 'zksync'
+        | 'coti'
+        | 'cotiTestnet'
+        | 'morph'
+        | 'morphTestnet'
+        | 'morphHolesky'
+        | 'ultra'
+        | 'ultraTestnet'
+        | 'nitrograph'
+        | 'sepolia'
+        | 'optimism_sepolia'
+        | 'arbitrumSepolia'
+        | 'goerli'
+        | 'optimism_goerli'
+        | 'arbitrumGoerli'
+        | 'basecamp'
+        | 'somnia';
+
+      /**
+       * 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;
+    }
+
+    export namespace Liquidity {
+      export interface Pool {
+        /**
+         * Unique identifier of the liquidity pool.
+         */
+        id: string;
+      }
+    }
+
     export interface Range {
       /**
        * Reward amount for this range.
@@ -3529,6 +5918,16 @@ export 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;
     }
 
     /**
@@ -3581,20 +5980,15 @@ export namespace RuleUpdateParams {
      * Object containing details of the associated smart contract.
      */
     export interface SmartContract {
-      /**
-       * ABI of the smart contract.
-       */
-      abi?: string | null;
-
       /**
        * Mapping of addresses for the smart contract.
        */
       addressMapping?: string | null;
 
       /**
-       * Array of bonus details applied to the rule.
+       * Object containing details of the amount multiplier from the event.
        */
-      bonus?: Array<SmartContract.Bonus> | null;
+      amountMultiplier?: SmartContract.AmountMultiplier | null;
 
       /**
        * ID of the smart contract.
@@ -3606,68 +6000,31 @@ export namespace RuleUpdateParams {
        */
       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;
 
       /**
-       * Flag indicating if a bonus is applied.
-       */
-      withBonus?: boolean | null;
-
-      /**
-       * Flag indicating if a custom range is applied.
+       * Type of the smart contract interaction.
        */
-      withCustomRange?: boolean | null;
-
-      /**
-       * Flag indicating if a maximum limit is applied.
-       */
-      withMax?: boolean | null;
+      type?: 'function' | 'event' | null;
     }
 
     export namespace SmartContract {
-      export 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.
+       * Object containing details of the amount multiplier from the event.
        */
-      export interface CustomRange {
-        /**
-         * End time of the custom range.
-         */
-        endsAt?: string | null;
-
+      export interface AmountMultiplier {
         /**
-         * Start time of the custom range.
+         * Mapping of the value for the smart contract.
          */
-        startsAt?: string | null;
+        valueMapping?: string | null;
       }
 
       export interface Param {
@@ -3711,17 +6068,66 @@ export namespace RuleUpdateParams {
        */
       streakMilestone: number;
     }
+
+    /**
+     * Metadata for swap loyalty rules
+     */
+    export interface Swap {
+      provider?: 'any' | 'relay' | 'lifi';
+
+      relayReferrerId?: string;
+
+      requireCrossChainSwap?: boolean;
+
+      swappedToChain?: 'any' | number | string;
+
+      swappedToTokens?: Array<Swap.SwappedToToken>;
+
+      tokenMode?: 'any' | 'specific';
+
+      trackTokenAmount?: boolean;
+    }
+
+    export namespace Swap {
+      export 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;
 
   /**
-   * Maximum number of records to return (max 1000)
+   * 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';
+
+  /**
+   * If true this will only return special rules, special rules are the rules that
+   * are used for anti sybil as honey pot
+   */
+  isSpecial?: 'true' | 'false';
+
+  /**
+   * Maximum number of records to return (max 100)
    */
   limit?: number;
 
@@ -3751,6 +6157,13 @@ 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
@@ -3759,15 +6172,25 @@ export interface RuleCompleteParams {
   amount?: number | null;
 
   /**
-   * Link to the comment made by user
+   * Link to the post/comment made by user
    */
-  commentLink?: string;
+  contentUrl?: string;
+
+  /**
+   * Unique key to ensure idempotent requests.
+   */
+  idempotencyKey?: string;
 
   /**
    * ID of the choice selected by the user
    */
   loyaltyQuestionChoiceId?: string;
 
+  /**
+   * Value to compare with the range
+   */
+  rangeValue?: number | null;
+
   /**
    * Unique identifier for the user
    */
@@ -3780,7 +6203,7 @@ export interface RuleCompleteParams {
 
   /**
    * Flag indicating if only verification is required, this will not create a
-   * transaction and reward the user
+   * transaction and reward the user.
    */
   verifyOnly?: string;
 
@@ -3791,11 +6214,30 @@ export interface RuleCompleteParams {
 }
 
 export interface RuleGetStatusParams {
-  organizationId: string;
+  /**
+   * Number of items to return
+   */
+  limit?: number | null;
 
-  websiteId: string;
+  /**
+   * Unique identifier for the loyalty rule[s]
+   */
+  loyaltyRuleId?: string | Array<string>;
+
+  organizationId?: string;
+
+  /**
+   * Starting after item
+   */
+  startingAfter?: string;
+
+  userGroupId?: string;
 
   userId?: string;
+
+  walletAddress?: string;
+
+  websiteId?: string;
 }
 
 export declare namespace Rules {
@@ -3809,6 +6251,7 @@ export declare namespace Rules {
     type RuleCreateParams as RuleCreateParams,
     type RuleUpdateParams as RuleUpdateParams,
     type RuleListParams as RuleListParams,
+    type RuleDeleteParams as RuleDeleteParams,
     type RuleCompleteParams as RuleCompleteParams,
     type RuleGetStatusParams as RuleGetStatusParams,
   };