@snagsolutions/sdk 0.1.0-alpha.48 → 0.1.0-alpha.50

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -198,7 +198,9 @@ export interface RuleCreateResponse {
198
198
  | 'twitter_post_hashtag'
199
199
  | 'quiz'
200
200
  | 'poll'
201
- | 'steam_wishlist';
201
+ | 'steam_wishlist'
202
+ | 'liquidity_uniswap_v2'
203
+ | 'liquidity_uniswap_v3';
202
204
 
203
205
  /**
204
206
  * Unique identifier for the associated website
@@ -321,6 +323,11 @@ export namespace RuleCreateResponse {
321
323
  * Additional metadata for the loyalty rule
322
324
  */
323
325
  export interface Metadata {
326
+ /**
327
+ * Number of tokens per batch.
328
+ */
329
+ batchSize?: number | null;
330
+
324
331
  /**
325
332
  * Text displayed on the action button.
326
333
  */
@@ -461,6 +468,11 @@ export namespace RuleCreateResponse {
461
468
  */
462
469
  link?: string | null;
463
470
 
471
+ /**
472
+ * Liquidity pool details.
473
+ */
474
+ liquidity?: Metadata.Liquidity;
475
+
464
476
  /**
465
477
  * Maximum quantity constraint for token holding.
466
478
  */
@@ -526,6 +538,11 @@ export namespace RuleCreateResponse {
526
538
  */
527
539
  referrerReward?: number | null;
528
540
 
541
+ /**
542
+ * Flag indicating if the reward is rewarded by batch.
543
+ */
544
+ rewardByBatch?: boolean | null;
545
+
529
546
  /**
530
547
  * Flag indicating if rewards are given per impression.
531
548
  */
@@ -786,6 +803,90 @@ export namespace RuleCreateResponse {
786
803
  id: string;
787
804
  }
788
805
 
806
+ /**
807
+ * Liquidity pool details.
808
+ */
809
+ export interface Liquidity {
810
+ /**
811
+ * Calculation type of the liquidity pool.
812
+ */
813
+ calculationType?: 'fixed' | 'custom';
814
+
815
+ /**
816
+ * Blockchain network of the liquidity pool.
817
+ */
818
+ chain?:
819
+ | 'abstract'
820
+ | 'abstractTestnet'
821
+ | 'apechain'
822
+ | 'arbitrum'
823
+ | 'avalanche'
824
+ | 'avalancheFuji'
825
+ | 'base'
826
+ | 'baseSepolia'
827
+ | 'berachainArtio'
828
+ | 'binance'
829
+ | 'bscTestnet'
830
+ | 'campTestnet'
831
+ | 'fantom'
832
+ | 'fantomTestnet'
833
+ | 'flowMainnet'
834
+ | 'mainnet'
835
+ | 'optimism'
836
+ | 'polygon'
837
+ | 'polygon_mumbai'
838
+ | 'skaleNebula'
839
+ | 'solana'
840
+ | 'sophon'
841
+ | 'sui'
842
+ | 'superseed'
843
+ | 'superseedSepolia'
844
+ | 'vanar'
845
+ | 'xai'
846
+ | 'zksync'
847
+ | 'sepolia'
848
+ | 'optimism_sepolia'
849
+ | 'arbitrumSepolia'
850
+ | 'goerli'
851
+ | 'optimism_goerli'
852
+ | 'arbitrumGoerli'
853
+ | 'basecamp';
854
+
855
+ /**
856
+ * Custom function to calculate the liquidity provided per hour
857
+ */
858
+ customFunction?: string;
859
+
860
+ /**
861
+ * Liquidity provided per hour
862
+ */
863
+ liquidityPerHour?: number;
864
+
865
+ /**
866
+ * Indicates if only in-range liquidity is rewarded.
867
+ */
868
+ onlyRewardInRangeLiquidity?: boolean;
869
+
870
+ /**
871
+ * Array of liquidity pools associated with the rule.
872
+ */
873
+ pools?: Array<Liquidity.Pool>;
874
+
875
+ /**
876
+ * Protocol of the liquidity pool.
877
+ */
878
+ protocol?: string;
879
+ }
880
+
881
+ export namespace Liquidity {
882
+ export interface Pool {
883
+ /**
884
+ * Unique identifier of the liquidity pool.
885
+ */
886
+ id?: string;
887
+ }
888
+ }
889
+
789
890
  export interface Range {
790
891
  /**
791
892
  * Reward amount for this range.
@@ -1234,6 +1335,11 @@ export namespace RuleUpdateResponse {
1234
1335
  * Additional metadata for the loyalty rule
1235
1336
  */
1236
1337
  export interface Metadata {
1338
+ /**
1339
+ * Number of tokens per batch.
1340
+ */
1341
+ batchSize?: number | null;
1342
+
1237
1343
  /**
1238
1344
  * Text displayed on the action button.
1239
1345
  */
@@ -1374,6 +1480,11 @@ export namespace RuleUpdateResponse {
1374
1480
  */
1375
1481
  link?: string | null;
1376
1482
 
1483
+ /**
1484
+ * Liquidity pool details.
1485
+ */
1486
+ liquidity?: Metadata.Liquidity;
1487
+
1377
1488
  /**
1378
1489
  * Maximum quantity constraint for token holding.
1379
1490
  */
@@ -1439,6 +1550,11 @@ export namespace RuleUpdateResponse {
1439
1550
  */
1440
1551
  referrerReward?: number | null;
1441
1552
 
1553
+ /**
1554
+ * Flag indicating if the reward is rewarded by batch.
1555
+ */
1556
+ rewardByBatch?: boolean | null;
1557
+
1442
1558
  /**
1443
1559
  * Flag indicating if rewards are given per impression.
1444
1560
  */
@@ -1699,6 +1815,90 @@ export namespace RuleUpdateResponse {
1699
1815
  id: string;
1700
1816
  }
1701
1817
 
1818
+ /**
1819
+ * Liquidity pool details.
1820
+ */
1821
+ export interface Liquidity {
1822
+ /**
1823
+ * Calculation type of the liquidity pool.
1824
+ */
1825
+ calculationType?: 'fixed' | 'custom';
1826
+
1827
+ /**
1828
+ * Blockchain network of the liquidity pool.
1829
+ */
1830
+ chain?:
1831
+ | 'abstract'
1832
+ | 'abstractTestnet'
1833
+ | 'apechain'
1834
+ | 'arbitrum'
1835
+ | 'avalanche'
1836
+ | 'avalancheFuji'
1837
+ | 'base'
1838
+ | 'baseSepolia'
1839
+ | 'berachainArtio'
1840
+ | 'binance'
1841
+ | 'bscTestnet'
1842
+ | 'campTestnet'
1843
+ | 'fantom'
1844
+ | 'fantomTestnet'
1845
+ | 'flowMainnet'
1846
+ | 'mainnet'
1847
+ | 'optimism'
1848
+ | 'polygon'
1849
+ | 'polygon_mumbai'
1850
+ | 'skaleNebula'
1851
+ | 'solana'
1852
+ | 'sophon'
1853
+ | 'sui'
1854
+ | 'superseed'
1855
+ | 'superseedSepolia'
1856
+ | 'vanar'
1857
+ | 'xai'
1858
+ | 'zksync'
1859
+ | 'sepolia'
1860
+ | 'optimism_sepolia'
1861
+ | 'arbitrumSepolia'
1862
+ | 'goerli'
1863
+ | 'optimism_goerli'
1864
+ | 'arbitrumGoerli'
1865
+ | 'basecamp';
1866
+
1867
+ /**
1868
+ * Custom function to calculate the liquidity provided per hour
1869
+ */
1870
+ customFunction?: string;
1871
+
1872
+ /**
1873
+ * Liquidity provided per hour
1874
+ */
1875
+ liquidityPerHour?: number;
1876
+
1877
+ /**
1878
+ * Indicates if only in-range liquidity is rewarded.
1879
+ */
1880
+ onlyRewardInRangeLiquidity?: boolean;
1881
+
1882
+ /**
1883
+ * Array of liquidity pools associated with the rule.
1884
+ */
1885
+ pools?: Array<Liquidity.Pool>;
1886
+
1887
+ /**
1888
+ * Protocol of the liquidity pool.
1889
+ */
1890
+ protocol?: string;
1891
+ }
1892
+
1893
+ export namespace Liquidity {
1894
+ export interface Pool {
1895
+ /**
1896
+ * Unique identifier of the liquidity pool.
1897
+ */
1898
+ id?: string;
1899
+ }
1900
+ }
1901
+
1702
1902
  export interface Range {
1703
1903
  /**
1704
1904
  * Reward amount for this range.
@@ -1998,6 +2198,11 @@ export namespace RuleListResponse {
1998
2198
 
1999
2199
  export namespace Data {
2000
2200
  export interface Metadata {
2201
+ /**
2202
+ * Number of tokens per batch.
2203
+ */
2204
+ batchSize?: number | null;
2205
+
2001
2206
  /**
2002
2207
  * Text displayed on the action button.
2003
2208
  */
@@ -2138,6 +2343,11 @@ export namespace RuleListResponse {
2138
2343
  */
2139
2344
  link?: string | null;
2140
2345
 
2346
+ /**
2347
+ * Liquidity pool details.
2348
+ */
2349
+ liquidity?: Metadata.Liquidity;
2350
+
2141
2351
  /**
2142
2352
  * Maximum quantity constraint for token holding.
2143
2353
  */
@@ -2203,6 +2413,11 @@ export namespace RuleListResponse {
2203
2413
  */
2204
2414
  referrerReward?: number | null;
2205
2415
 
2416
+ /**
2417
+ * Flag indicating if the reward is rewarded by batch.
2418
+ */
2419
+ rewardByBatch?: boolean | null;
2420
+
2206
2421
  /**
2207
2422
  * Flag indicating if rewards are given per impression.
2208
2423
  */
@@ -2463,6 +2678,90 @@ export namespace RuleListResponse {
2463
2678
  id: string;
2464
2679
  }
2465
2680
 
2681
+ /**
2682
+ * Liquidity pool details.
2683
+ */
2684
+ export interface Liquidity {
2685
+ /**
2686
+ * Calculation type of the liquidity pool.
2687
+ */
2688
+ calculationType?: 'fixed' | 'custom';
2689
+
2690
+ /**
2691
+ * Blockchain network of the liquidity pool.
2692
+ */
2693
+ chain?:
2694
+ | 'abstract'
2695
+ | 'abstractTestnet'
2696
+ | 'apechain'
2697
+ | 'arbitrum'
2698
+ | 'avalanche'
2699
+ | 'avalancheFuji'
2700
+ | 'base'
2701
+ | 'baseSepolia'
2702
+ | 'berachainArtio'
2703
+ | 'binance'
2704
+ | 'bscTestnet'
2705
+ | 'campTestnet'
2706
+ | 'fantom'
2707
+ | 'fantomTestnet'
2708
+ | 'flowMainnet'
2709
+ | 'mainnet'
2710
+ | 'optimism'
2711
+ | 'polygon'
2712
+ | 'polygon_mumbai'
2713
+ | 'skaleNebula'
2714
+ | 'solana'
2715
+ | 'sophon'
2716
+ | 'sui'
2717
+ | 'superseed'
2718
+ | 'superseedSepolia'
2719
+ | 'vanar'
2720
+ | 'xai'
2721
+ | 'zksync'
2722
+ | 'sepolia'
2723
+ | 'optimism_sepolia'
2724
+ | 'arbitrumSepolia'
2725
+ | 'goerli'
2726
+ | 'optimism_goerli'
2727
+ | 'arbitrumGoerli'
2728
+ | 'basecamp';
2729
+
2730
+ /**
2731
+ * Custom function to calculate the liquidity provided per hour
2732
+ */
2733
+ customFunction?: string;
2734
+
2735
+ /**
2736
+ * Liquidity provided per hour
2737
+ */
2738
+ liquidityPerHour?: number;
2739
+
2740
+ /**
2741
+ * Indicates if only in-range liquidity is rewarded.
2742
+ */
2743
+ onlyRewardInRangeLiquidity?: boolean;
2744
+
2745
+ /**
2746
+ * Array of liquidity pools associated with the rule.
2747
+ */
2748
+ pools?: Array<Liquidity.Pool>;
2749
+
2750
+ /**
2751
+ * Protocol of the liquidity pool.
2752
+ */
2753
+ protocol?: string;
2754
+ }
2755
+
2756
+ export namespace Liquidity {
2757
+ export interface Pool {
2758
+ /**
2759
+ * Unique identifier of the liquidity pool.
2760
+ */
2761
+ id?: string;
2762
+ }
2763
+ }
2764
+
2466
2765
  export interface Range {
2467
2766
  /**
2468
2767
  * Reward amount for this range.
@@ -2798,7 +3097,9 @@ export interface RuleCreateParams {
2798
3097
  | 'twitter_post_hashtag'
2799
3098
  | 'quiz'
2800
3099
  | 'poll'
2801
- | 'steam_wishlist';
3100
+ | 'steam_wishlist'
3101
+ | 'liquidity_uniswap_v2'
3102
+ | 'liquidity_uniswap_v3';
2802
3103
 
2803
3104
  /**
2804
3105
  * Unique identifier for the associated website
@@ -2921,6 +3222,11 @@ export namespace RuleCreateParams {
2921
3222
  * Additional metadata for the loyalty rule
2922
3223
  */
2923
3224
  export interface Metadata {
3225
+ /**
3226
+ * Number of tokens per batch.
3227
+ */
3228
+ batchSize?: number | null;
3229
+
2924
3230
  /**
2925
3231
  * Text displayed on the action button.
2926
3232
  */
@@ -3061,6 +3367,11 @@ export namespace RuleCreateParams {
3061
3367
  */
3062
3368
  link?: string | null;
3063
3369
 
3370
+ /**
3371
+ * Liquidity pool details.
3372
+ */
3373
+ liquidity?: Metadata.Liquidity;
3374
+
3064
3375
  /**
3065
3376
  * Maximum quantity constraint for token holding.
3066
3377
  */
@@ -3126,6 +3437,11 @@ export namespace RuleCreateParams {
3126
3437
  */
3127
3438
  referrerReward?: number | null;
3128
3439
 
3440
+ /**
3441
+ * Flag indicating if the reward is rewarded by batch.
3442
+ */
3443
+ rewardByBatch?: boolean | null;
3444
+
3129
3445
  /**
3130
3446
  * Flag indicating if rewards are given per impression.
3131
3447
  */
@@ -3386,6 +3702,90 @@ export namespace RuleCreateParams {
3386
3702
  id: string;
3387
3703
  }
3388
3704
 
3705
+ /**
3706
+ * Liquidity pool details.
3707
+ */
3708
+ export interface Liquidity {
3709
+ /**
3710
+ * Calculation type of the liquidity pool.
3711
+ */
3712
+ calculationType?: 'fixed' | 'custom';
3713
+
3714
+ /**
3715
+ * Blockchain network of the liquidity pool.
3716
+ */
3717
+ chain?:
3718
+ | 'abstract'
3719
+ | 'abstractTestnet'
3720
+ | 'apechain'
3721
+ | 'arbitrum'
3722
+ | 'avalanche'
3723
+ | 'avalancheFuji'
3724
+ | 'base'
3725
+ | 'baseSepolia'
3726
+ | 'berachainArtio'
3727
+ | 'binance'
3728
+ | 'bscTestnet'
3729
+ | 'campTestnet'
3730
+ | 'fantom'
3731
+ | 'fantomTestnet'
3732
+ | 'flowMainnet'
3733
+ | 'mainnet'
3734
+ | 'optimism'
3735
+ | 'polygon'
3736
+ | 'polygon_mumbai'
3737
+ | 'skaleNebula'
3738
+ | 'solana'
3739
+ | 'sophon'
3740
+ | 'sui'
3741
+ | 'superseed'
3742
+ | 'superseedSepolia'
3743
+ | 'vanar'
3744
+ | 'xai'
3745
+ | 'zksync'
3746
+ | 'sepolia'
3747
+ | 'optimism_sepolia'
3748
+ | 'arbitrumSepolia'
3749
+ | 'goerli'
3750
+ | 'optimism_goerli'
3751
+ | 'arbitrumGoerli'
3752
+ | 'basecamp';
3753
+
3754
+ /**
3755
+ * Custom function to calculate the liquidity provided per hour
3756
+ */
3757
+ customFunction?: string;
3758
+
3759
+ /**
3760
+ * Liquidity provided per hour
3761
+ */
3762
+ liquidityPerHour?: number;
3763
+
3764
+ /**
3765
+ * Indicates if only in-range liquidity is rewarded.
3766
+ */
3767
+ onlyRewardInRangeLiquidity?: boolean;
3768
+
3769
+ /**
3770
+ * Array of liquidity pools associated with the rule.
3771
+ */
3772
+ pools?: Array<Liquidity.Pool>;
3773
+
3774
+ /**
3775
+ * Protocol of the liquidity pool.
3776
+ */
3777
+ protocol?: string;
3778
+ }
3779
+
3780
+ export namespace Liquidity {
3781
+ export interface Pool {
3782
+ /**
3783
+ * Unique identifier of the liquidity pool.
3784
+ */
3785
+ id?: string;
3786
+ }
3787
+ }
3788
+
3389
3789
  export interface Range {
3390
3790
  /**
3391
3791
  * Reward amount for this range.
@@ -3832,6 +4232,11 @@ export namespace RuleUpdateParams {
3832
4232
  * Additional metadata for the loyalty rule
3833
4233
  */
3834
4234
  export interface Metadata {
4235
+ /**
4236
+ * Number of tokens per batch.
4237
+ */
4238
+ batchSize?: number | null;
4239
+
3835
4240
  /**
3836
4241
  * Text displayed on the action button.
3837
4242
  */
@@ -3972,6 +4377,11 @@ export namespace RuleUpdateParams {
3972
4377
  */
3973
4378
  link?: string | null;
3974
4379
 
4380
+ /**
4381
+ * Liquidity pool details.
4382
+ */
4383
+ liquidity?: Metadata.Liquidity;
4384
+
3975
4385
  /**
3976
4386
  * Maximum quantity constraint for token holding.
3977
4387
  */
@@ -4037,6 +4447,11 @@ export namespace RuleUpdateParams {
4037
4447
  */
4038
4448
  referrerReward?: number | null;
4039
4449
 
4450
+ /**
4451
+ * Flag indicating if the reward is rewarded by batch.
4452
+ */
4453
+ rewardByBatch?: boolean | null;
4454
+
4040
4455
  /**
4041
4456
  * Flag indicating if rewards are given per impression.
4042
4457
  */
@@ -4297,6 +4712,90 @@ export namespace RuleUpdateParams {
4297
4712
  id: string;
4298
4713
  }
4299
4714
 
4715
+ /**
4716
+ * Liquidity pool details.
4717
+ */
4718
+ export interface Liquidity {
4719
+ /**
4720
+ * Calculation type of the liquidity pool.
4721
+ */
4722
+ calculationType?: 'fixed' | 'custom';
4723
+
4724
+ /**
4725
+ * Blockchain network of the liquidity pool.
4726
+ */
4727
+ chain?:
4728
+ | 'abstract'
4729
+ | 'abstractTestnet'
4730
+ | 'apechain'
4731
+ | 'arbitrum'
4732
+ | 'avalanche'
4733
+ | 'avalancheFuji'
4734
+ | 'base'
4735
+ | 'baseSepolia'
4736
+ | 'berachainArtio'
4737
+ | 'binance'
4738
+ | 'bscTestnet'
4739
+ | 'campTestnet'
4740
+ | 'fantom'
4741
+ | 'fantomTestnet'
4742
+ | 'flowMainnet'
4743
+ | 'mainnet'
4744
+ | 'optimism'
4745
+ | 'polygon'
4746
+ | 'polygon_mumbai'
4747
+ | 'skaleNebula'
4748
+ | 'solana'
4749
+ | 'sophon'
4750
+ | 'sui'
4751
+ | 'superseed'
4752
+ | 'superseedSepolia'
4753
+ | 'vanar'
4754
+ | 'xai'
4755
+ | 'zksync'
4756
+ | 'sepolia'
4757
+ | 'optimism_sepolia'
4758
+ | 'arbitrumSepolia'
4759
+ | 'goerli'
4760
+ | 'optimism_goerli'
4761
+ | 'arbitrumGoerli'
4762
+ | 'basecamp';
4763
+
4764
+ /**
4765
+ * Custom function to calculate the liquidity provided per hour
4766
+ */
4767
+ customFunction?: string;
4768
+
4769
+ /**
4770
+ * Liquidity provided per hour
4771
+ */
4772
+ liquidityPerHour?: number;
4773
+
4774
+ /**
4775
+ * Indicates if only in-range liquidity is rewarded.
4776
+ */
4777
+ onlyRewardInRangeLiquidity?: boolean;
4778
+
4779
+ /**
4780
+ * Array of liquidity pools associated with the rule.
4781
+ */
4782
+ pools?: Array<Liquidity.Pool>;
4783
+
4784
+ /**
4785
+ * Protocol of the liquidity pool.
4786
+ */
4787
+ protocol?: string;
4788
+ }
4789
+
4790
+ export namespace Liquidity {
4791
+ export interface Pool {
4792
+ /**
4793
+ * Unique identifier of the liquidity pool.
4794
+ */
4795
+ id?: string;
4796
+ }
4797
+ }
4798
+
4300
4799
  export interface Range {
4301
4800
  /**
4302
4801
  * Reward amount for this range.
@@ -192,6 +192,8 @@ export namespace TransactionGetTransactionEntriesResponse {
192
192
  */
193
193
  description?: string;
194
194
 
195
+ loyaltyRuleGroupItem?: LoyaltyRule.LoyaltyRuleGroupItem;
196
+
195
197
  /**
196
198
  * Optional metadata for the loyalty rule
197
199
  */
@@ -202,6 +204,12 @@ export namespace TransactionGetTransactionEntriesResponse {
202
204
  */
203
205
  name?: string;
204
206
  }
207
+
208
+ export namespace LoyaltyRule {
209
+ export interface LoyaltyRuleGroupItem {
210
+ loyaltyRuleGroupId: string;
211
+ }
212
+ }
205
213
  }
206
214
  }
207
215
  }
@@ -351,6 +359,8 @@ export interface TransactionGetTransactionEntriesParams {
351
359
  | 'quiz'
352
360
  | 'poll'
353
361
  | 'steam_wishlist'
362
+ | 'liquidity_uniswap_v2'
363
+ | 'liquidity_uniswap_v3'
354
364
  | Array<
355
365
  | 'Bonus'
356
366
  | 'BoughtOn'
@@ -406,6 +416,8 @@ export interface TransactionGetTransactionEntriesParams {
406
416
  | 'quiz'
407
417
  | 'poll'
408
418
  | 'steam_wishlist'
419
+ | 'liquidity_uniswap_v2'
420
+ | 'liquidity_uniswap_v3'
409
421
  >;
410
422
 
411
423
  /**
@@ -42,12 +42,27 @@ export namespace UserListResponse {
42
42
  export interface ReferralCode {
43
43
  id: string;
44
44
 
45
+ /**
46
+ * This will only return data for earnings after 2025-04-24
47
+ */
48
+ amount: number;
49
+
45
50
  createdAt: string;
46
51
 
47
52
  deletedAt: string | null;
48
53
 
49
54
  referralCode: string;
50
55
 
56
+ /**
57
+ * This will only return data for earnings after 2025-04-24
58
+ */
59
+ tier1Amount: number;
60
+
61
+ /**
62
+ * This will only return data for earnings after 2025-04-24
63
+ */
64
+ tier2Amount: number;
65
+
51
66
  updatedAt: string;
52
67
 
53
68
  userId: string;
@@ -135,6 +135,8 @@ export interface MetadataCreateParams {
135
135
 
136
136
  externalIdentifier?: string | null;
137
137
 
138
+ externalLoyaltyScore?: string | null;
139
+
138
140
  isBlocked?: boolean;
139
141
 
140
142
  logoUrl?: string | null;