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

package/src/resources/{api/loyalty → loyalty}/rules.ts

@@ -1,8 +1,8 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../../../resource';
-import { isRequestOptions } from '../../../core';
-import * as Core from '../../../core';
+import { APIResource } from '../../resource';
+import { isRequestOptions } from '../../core';
+import * as Core from '../../core';
 
 export class Rules extends APIResource {
   /**
@@ -246,35 +246,41 @@ export interface RuleCreateResponse {
    */
   loyaltyRuleGroupId?: 'no-section' | (string & {}) | null;
 
+  /**
+   * URL of the media to be displayed
+   */
+  mediaUrl?: string | null;
+
   /**
    * Blockchain network where the rule will apply
    */
   network?:
-    | 'mainnet'
-    | 'polygon'
-    | 'polygon_mumbai'
-    | 'optimism'
+    | 'apechain'
     | 'arbitrum'
-    | 'binance'
-    | 'bscTestnet'
     | 'avalanche'
     | 'avalancheFuji'
-    | 'zksync'
-    | 'fantom'
-    | 'fantomTestnet'
     | 'base'
     | 'baseSepolia'
-    | 'skaleNebula'
-    | 'xai'
     | 'berachainArtio'
-    | 'solana'
-    | 'apechain'
-    | 'flowMainnet'
+    | 'binance'
+    | 'bscTestnet'
     | 'campTestnet'
+    | 'fantom'
+    | 'fantomTestnet'
+    | 'flowMainnet'
+    | 'mainnet'
+    | 'optimism'
+    | 'polygon'
+    | 'polygon_mumbai'
+    | 'skaleNebula'
+    | 'solana'
+    | 'sophon'
     | 'sui'
-    | 'vanar'
     | 'superseed'
     | 'superseedSepolia'
+    | 'vanar'
+    | 'xai'
+    | 'zksync'
     | 'sepolia'
     | 'optimism_sepolia'
     | 'arbitrumSepolia'
@@ -335,6 +341,11 @@ export namespace RuleCreateResponse {
      */
     collection?: Array<Metadata.Collection>;
 
+    /**
+     * Conditions for completing the profile.
+     */
+    completeProfileConditions?: Record<string, boolean> | null;
+
     /**
      * Object containing details for the call-to-action.
      */
@@ -370,16 +381,31 @@ export namespace RuleCreateResponse {
      */
     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;
 
+    /**
+     * Flag indicating whether the order source is included.
+     */
+    hasOrderSource?: boolean;
+
     /**
      * Indicates if the full royalty has been paid for items.
      */
@@ -460,6 +486,11 @@ export namespace RuleCreateResponse {
      */
     onlyRewardSingleTokenOwnership?: boolean | null;
 
+    /**
+     * Order source of the order for the token sale
+     */
+    orderSource?: string;
+
     /**
      * Promotional code associated with the rule.
      */
@@ -618,31 +649,32 @@ export namespace RuleCreateResponse {
        * Blockchain network of the collection.
        */
       network?:
-        | 'mainnet'
-        | 'polygon'
-        | 'polygon_mumbai'
-        | 'optimism'
+        | 'apechain'
         | 'arbitrum'
-        | 'binance'
-        | 'bscTestnet'
         | 'avalanche'
         | 'avalancheFuji'
-        | 'zksync'
-        | 'fantom'
-        | 'fantomTestnet'
         | 'base'
         | 'baseSepolia'
-        | 'skaleNebula'
-        | 'xai'
         | 'berachainArtio'
-        | 'solana'
-        | 'apechain'
-        | 'flowMainnet'
+        | 'binance'
+        | 'bscTestnet'
         | 'campTestnet'
+        | 'fantom'
+        | 'fantomTestnet'
+        | 'flowMainnet'
+        | 'mainnet'
+        | 'optimism'
+        | 'polygon'
+        | 'polygon_mumbai'
+        | 'skaleNebula'
+        | 'solana'
+        | 'sophon'
         | 'sui'
-        | 'vanar'
         | 'superseed'
         | 'superseedSepolia'
+        | 'vanar'
+        | 'xai'
+        | 'zksync'
         | 'sepolia'
         | 'optimism_sepolia'
         | 'arbitrumSepolia'
@@ -936,31 +968,32 @@ export namespace RuleCreateResponse {
      * Blockchain network for the collection
      */
     network:
-      | 'mainnet'
-      | 'polygon'
-      | 'polygon_mumbai'
-      | 'optimism'
+      | 'apechain'
       | 'arbitrum'
-      | 'binance'
-      | 'bscTestnet'
       | 'avalanche'
       | 'avalancheFuji'
-      | 'zksync'
-      | 'fantom'
-      | 'fantomTestnet'
       | 'base'
       | 'baseSepolia'
-      | 'skaleNebula'
-      | 'xai'
       | 'berachainArtio'
-      | 'solana'
-      | 'apechain'
-      | 'flowMainnet'
+      | 'binance'
+      | 'bscTestnet'
       | 'campTestnet'
+      | 'fantom'
+      | 'fantomTestnet'
+      | 'flowMainnet'
+      | 'mainnet'
+      | 'optimism'
+      | 'polygon'
+      | 'polygon_mumbai'
+      | 'skaleNebula'
+      | 'solana'
+      | 'sophon'
       | 'sui'
-      | 'vanar'
       | 'superseed'
       | 'superseedSepolia'
+      | 'vanar'
+      | 'xai'
+      | 'zksync'
       | 'sepolia'
       | 'optimism_sepolia'
       | 'arbitrumSepolia'
@@ -1050,6 +1083,11 @@ export interface RuleUpdateResponse {
    */
   loyaltyRuleGroupId?: (string & {}) | 'no-section' | null;
 
+  /**
+   * URL of the media to be displayed
+   */
+  mediaUrl?: string | null;
+
   /**
    * Additional metadata for the loyalty rule
    */
@@ -1059,31 +1097,32 @@ export interface RuleUpdateResponse {
    * Blockchain network where the rule will apply
    */
   network?:
-    | 'mainnet'
-    | 'polygon'
-    | 'polygon_mumbai'
-    | 'optimism'
+    | 'apechain'
     | 'arbitrum'
-    | 'binance'
-    | 'bscTestnet'
     | 'avalanche'
     | 'avalancheFuji'
-    | 'zksync'
-    | 'fantom'
-    | 'fantomTestnet'
     | 'base'
     | 'baseSepolia'
-    | 'skaleNebula'
-    | 'xai'
     | 'berachainArtio'
-    | 'solana'
-    | 'apechain'
-    | 'flowMainnet'
+    | 'binance'
+    | 'bscTestnet'
     | 'campTestnet'
+    | 'fantom'
+    | 'fantomTestnet'
+    | 'flowMainnet'
+    | 'mainnet'
+    | 'optimism'
+    | 'polygon'
+    | 'polygon_mumbai'
+    | 'skaleNebula'
+    | 'solana'
+    | 'sophon'
     | 'sui'
-    | 'vanar'
     | 'superseed'
     | 'superseedSepolia'
+    | 'vanar'
+    | 'xai'
+    | 'zksync'
     | 'sepolia'
     | 'optimism_sepolia'
     | 'arbitrumSepolia'
@@ -1125,31 +1164,32 @@ export namespace RuleUpdateResponse {
      * Blockchain network for the collection
      */
     network:
-      | 'mainnet'
-      | 'polygon'
-      | 'polygon_mumbai'
-      | 'optimism'
+      | 'apechain'
       | 'arbitrum'
-      | 'binance'
-      | 'bscTestnet'
       | 'avalanche'
       | 'avalancheFuji'
-      | 'zksync'
-      | 'fantom'
-      | 'fantomTestnet'
       | 'base'
       | 'baseSepolia'
-      | 'skaleNebula'
-      | 'xai'
       | 'berachainArtio'
-      | 'solana'
-      | 'apechain'
-      | 'flowMainnet'
+      | 'binance'
+      | 'bscTestnet'
       | 'campTestnet'
+      | 'fantom'
+      | 'fantomTestnet'
+      | 'flowMainnet'
+      | 'mainnet'
+      | 'optimism'
+      | 'polygon'
+      | 'polygon_mumbai'
+      | 'skaleNebula'
+      | 'solana'
+      | 'sophon'
       | 'sui'
-      | 'vanar'
       | 'superseed'
       | 'superseedSepolia'
+      | 'vanar'
+      | 'xai'
+      | 'zksync'
       | 'sepolia'
       | 'optimism_sepolia'
       | 'arbitrumSepolia'
@@ -1194,6 +1234,11 @@ export namespace RuleUpdateResponse {
      */
     collection?: Array<Metadata.Collection>;
 
+    /**
+     * Conditions for completing the profile.
+     */
+    completeProfileConditions?: Record<string, boolean> | null;
+
     /**
      * Object containing details for the call-to-action.
      */
@@ -1229,16 +1274,31 @@ export namespace RuleUpdateResponse {
      */
     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;
 
+    /**
+     * Flag indicating whether the order source is included.
+     */
+    hasOrderSource?: boolean;
+
     /**
      * Indicates if the full royalty has been paid for items.
      */
@@ -1319,6 +1379,11 @@ export namespace RuleUpdateResponse {
      */
     onlyRewardSingleTokenOwnership?: boolean | null;
 
+    /**
+     * Order source of the order for the token sale
+     */
+    orderSource?: string;
+
     /**
      * Promotional code associated with the rule.
      */
@@ -1477,31 +1542,32 @@ export namespace RuleUpdateResponse {
        * Blockchain network of the collection.
        */
       network?:
-        | 'mainnet'
-        | 'polygon'
-        | 'polygon_mumbai'
-        | 'optimism'
+        | 'apechain'
         | 'arbitrum'
-        | 'binance'
-        | 'bscTestnet'
         | 'avalanche'
         | 'avalancheFuji'
-        | 'zksync'
-        | 'fantom'
-        | 'fantomTestnet'
         | 'base'
         | 'baseSepolia'
-        | 'skaleNebula'
-        | 'xai'
         | 'berachainArtio'
-        | 'solana'
-        | 'apechain'
-        | 'flowMainnet'
+        | 'binance'
+        | 'bscTestnet'
         | 'campTestnet'
+        | 'fantom'
+        | 'fantomTestnet'
+        | 'flowMainnet'
+        | 'mainnet'
+        | 'optimism'
+        | 'polygon'
+        | 'polygon_mumbai'
+        | 'skaleNebula'
+        | 'solana'
+        | 'sophon'
         | 'sui'
-        | 'vanar'
         | 'superseed'
         | 'superseedSepolia'
+        | 'vanar'
+        | 'xai'
+        | 'zksync'
         | 'sepolia'
         | 'optimism_sepolia'
         | 'arbitrumSepolia'
@@ -2044,35 +2110,41 @@ export interface RuleCreateParams {
    */
   loyaltyRuleGroupId?: 'no-section' | (string & {}) | null;
 
+  /**
+   * URL of the media to be displayed
+   */
+  mediaUrl?: string | null;
+
   /**
    * Blockchain network where the rule will apply
    */
   network?:
-    | 'mainnet'
-    | 'polygon'
-    | 'polygon_mumbai'
-    | 'optimism'
+    | 'apechain'
     | 'arbitrum'
-    | 'binance'
-    | 'bscTestnet'
     | 'avalanche'
     | 'avalancheFuji'
-    | 'zksync'
-    | 'fantom'
-    | 'fantomTestnet'
     | 'base'
     | 'baseSepolia'
-    | 'skaleNebula'
-    | 'xai'
     | 'berachainArtio'
-    | 'solana'
-    | 'apechain'
-    | 'flowMainnet'
+    | 'binance'
+    | 'bscTestnet'
     | 'campTestnet'
+    | 'fantom'
+    | 'fantomTestnet'
+    | 'flowMainnet'
+    | 'mainnet'
+    | 'optimism'
+    | 'polygon'
+    | 'polygon_mumbai'
+    | 'skaleNebula'
+    | 'solana'
+    | 'sophon'
     | 'sui'
-    | 'vanar'
     | 'superseed'
     | 'superseedSepolia'
+    | 'vanar'
+    | 'xai'
+    | 'zksync'
     | 'sepolia'
     | 'optimism_sepolia'
     | 'arbitrumSepolia'
@@ -2133,6 +2205,11 @@ export namespace RuleCreateParams {
      */
     collection?: Array<Metadata.Collection>;
 
+    /**
+     * Conditions for completing the profile.
+     */
+    completeProfileConditions?: Record<string, boolean> | null;
+
     /**
      * Object containing details for the call-to-action.
      */
@@ -2168,16 +2245,31 @@ export namespace RuleCreateParams {
      */
     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;
 
+    /**
+     * Flag indicating whether the order source is included.
+     */
+    hasOrderSource?: boolean;
+
     /**
      * Indicates if the full royalty has been paid for items.
      */
@@ -2258,6 +2350,11 @@ export namespace RuleCreateParams {
      */
     onlyRewardSingleTokenOwnership?: boolean | null;
 
+    /**
+     * Order source of the order for the token sale
+     */
+    orderSource?: string;
+
     /**
      * Promotional code associated with the rule.
      */
@@ -2416,31 +2513,32 @@ export namespace RuleCreateParams {
        * Blockchain network of the collection.
        */
       network?:
-        | 'mainnet'
-        | 'polygon'
-        | 'polygon_mumbai'
-        | 'optimism'
+        | 'apechain'
         | 'arbitrum'
-        | 'binance'
-        | 'bscTestnet'
         | 'avalanche'
         | 'avalancheFuji'
-        | 'zksync'
-        | 'fantom'
-        | 'fantomTestnet'
         | 'base'
         | 'baseSepolia'
-        | 'skaleNebula'
-        | 'xai'
         | 'berachainArtio'
-        | 'solana'
-        | 'apechain'
-        | 'flowMainnet'
+        | 'binance'
+        | 'bscTestnet'
         | 'campTestnet'
+        | 'fantom'
+        | 'fantomTestnet'
+        | 'flowMainnet'
+        | 'mainnet'
+        | 'optimism'
+        | 'polygon'
+        | 'polygon_mumbai'
+        | 'skaleNebula'
+        | 'solana'
+        | 'sophon'
         | 'sui'
-        | 'vanar'
         | 'superseed'
         | 'superseedSepolia'
+        | 'vanar'
+        | 'xai'
+        | 'zksync'
         | 'sepolia'
         | 'optimism_sepolia'
         | 'arbitrumSepolia'
@@ -2734,31 +2832,32 @@ export namespace RuleCreateParams {
      * Blockchain network for the collection
      */
     network:
-      | 'mainnet'
-      | 'polygon'
-      | 'polygon_mumbai'
-      | 'optimism'
+      | 'apechain'
       | 'arbitrum'
-      | 'binance'
-      | 'bscTestnet'
       | 'avalanche'
       | 'avalancheFuji'
-      | 'zksync'
-      | 'fantom'
-      | 'fantomTestnet'
       | 'base'
       | 'baseSepolia'
-      | 'skaleNebula'
-      | 'xai'
       | 'berachainArtio'
-      | 'solana'
-      | 'apechain'
-      | 'flowMainnet'
+      | 'binance'
+      | 'bscTestnet'
       | 'campTestnet'
+      | 'fantom'
+      | 'fantomTestnet'
+      | 'flowMainnet'
+      | 'mainnet'
+      | 'optimism'
+      | 'polygon'
+      | 'polygon_mumbai'
+      | 'skaleNebula'
+      | 'solana'
+      | 'sophon'
       | 'sui'
-      | 'vanar'
       | 'superseed'
       | 'superseedSepolia'
+      | 'vanar'
+      | 'xai'
+      | 'zksync'
       | 'sepolia'
       | 'optimism_sepolia'
       | 'arbitrumSepolia'
@@ -2846,6 +2945,11 @@ export interface RuleUpdateParams {
    */
   loyaltyRuleGroupId?: (string & {}) | 'no-section' | null;
 
+  /**
+   * URL of the media to be displayed
+   */
+  mediaUrl?: string | null;
+
   /**
    * Additional metadata for the loyalty rule
    */
@@ -2855,31 +2959,32 @@ export interface RuleUpdateParams {
    * Blockchain network where the rule will apply
    */
   network?:
-    | 'mainnet'
-    | 'polygon'
-    | 'polygon_mumbai'
-    | 'optimism'
+    | 'apechain'
     | 'arbitrum'
-    | 'binance'
-    | 'bscTestnet'
     | 'avalanche'
     | 'avalancheFuji'
-    | 'zksync'
-    | 'fantom'
-    | 'fantomTestnet'
     | 'base'
     | 'baseSepolia'
-    | 'skaleNebula'
-    | 'xai'
     | 'berachainArtio'
-    | 'solana'
-    | 'apechain'
-    | 'flowMainnet'
+    | 'binance'
+    | 'bscTestnet'
     | 'campTestnet'
+    | 'fantom'
+    | 'fantomTestnet'
+    | 'flowMainnet'
+    | 'mainnet'
+    | 'optimism'
+    | 'polygon'
+    | 'polygon_mumbai'
+    | 'skaleNebula'
+    | 'solana'
+    | 'sophon'
     | 'sui'
-    | 'vanar'
     | 'superseed'
     | 'superseedSepolia'
+    | 'vanar'
+    | 'xai'
+    | 'zksync'
     | 'sepolia'
     | 'optimism_sepolia'
     | 'arbitrumSepolia'
@@ -2921,31 +3026,32 @@ export namespace RuleUpdateParams {
      * Blockchain network for the collection
      */
     network:
-      | 'mainnet'
-      | 'polygon'
-      | 'polygon_mumbai'
-      | 'optimism'
+      | 'apechain'
       | 'arbitrum'
-      | 'binance'
-      | 'bscTestnet'
       | 'avalanche'
       | 'avalancheFuji'
-      | 'zksync'
-      | 'fantom'
-      | 'fantomTestnet'
       | 'base'
       | 'baseSepolia'
-      | 'skaleNebula'
-      | 'xai'
       | 'berachainArtio'
-      | 'solana'
-      | 'apechain'
-      | 'flowMainnet'
+      | 'binance'
+      | 'bscTestnet'
       | 'campTestnet'
+      | 'fantom'
+      | 'fantomTestnet'
+      | 'flowMainnet'
+      | 'mainnet'
+      | 'optimism'
+      | 'polygon'
+      | 'polygon_mumbai'
+      | 'skaleNebula'
+      | 'solana'
+      | 'sophon'
       | 'sui'
-      | 'vanar'
       | 'superseed'
       | 'superseedSepolia'
+      | 'vanar'
+      | 'xai'
+      | 'zksync'
       | 'sepolia'
       | 'optimism_sepolia'
       | 'arbitrumSepolia'
@@ -2990,6 +3096,11 @@ export namespace RuleUpdateParams {
      */
     collection?: Array<Metadata.Collection>;
 
+    /**
+     * Conditions for completing the profile.
+     */
+    completeProfileConditions?: Record<string, boolean> | null;
+
     /**
      * Object containing details for the call-to-action.
      */
@@ -3025,16 +3136,31 @@ export namespace RuleUpdateParams {
      */
     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;
 
+    /**
+     * Flag indicating whether the order source is included.
+     */
+    hasOrderSource?: boolean;
+
     /**
      * Indicates if the full royalty has been paid for items.
      */
@@ -3115,6 +3241,11 @@ export namespace RuleUpdateParams {
      */
     onlyRewardSingleTokenOwnership?: boolean | null;
 
+    /**
+     * Order source of the order for the token sale
+     */
+    orderSource?: string;
+
     /**
      * Promotional code associated with the rule.
      */
@@ -3273,31 +3404,32 @@ export namespace RuleUpdateParams {
        * Blockchain network of the collection.
        */
       network?:
-        | 'mainnet'
-        | 'polygon'
-        | 'polygon_mumbai'
-        | 'optimism'
+        | 'apechain'
         | 'arbitrum'
-        | 'binance'
-        | 'bscTestnet'
         | 'avalanche'
         | 'avalancheFuji'
-        | 'zksync'
-        | 'fantom'
-        | 'fantomTestnet'
         | 'base'
         | 'baseSepolia'
-        | 'skaleNebula'
-        | 'xai'
         | 'berachainArtio'
-        | 'solana'
-        | 'apechain'
-        | 'flowMainnet'
+        | 'binance'
+        | 'bscTestnet'
         | 'campTestnet'
+        | 'fantom'
+        | 'fantomTestnet'
+        | 'flowMainnet'
+        | 'mainnet'
+        | 'optimism'
+        | 'polygon'
+        | 'polygon_mumbai'
+        | 'skaleNebula'
+        | 'solana'
+        | 'sophon'
         | 'sui'
-        | 'vanar'
         | 'superseed'
         | 'superseedSepolia'
+        | 'vanar'
+        | 'xai'
+        | 'zksync'
         | 'sepolia'
         | 'optimism_sepolia'
         | 'arbitrumSepolia'
@@ -3598,6 +3730,11 @@ export interface RuleListParams {
    */
   loyaltyRuleGroupId?: string;
 
+  /**
+   * The IDs of the loyalty rule
+   */
+  loyaltyRuleId?: string | Array<string>;
+
   /**
    * Unique identifier for the organization to filter by
    */
@@ -3615,6 +3752,12 @@ export interface RuleListParams {
 }
 
 export interface RuleCompleteParams {
+  /**
+   * Override amount for the reward (rounded to nearest whole number). This will
+   * override the rule amount and reward the integer passed.
+   */
+  amount?: number | null;
+
   /**
    * Link to the comment made by user
    */