@codex-data/sdk 1.0.1 → 1.0.2

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.
@@ -97,6 +97,7 @@ input AddUserAchievementInput {
97
97
  quantity: Int!
98
98
  }
99
99
 
100
+ """The recurrence of the webhook. Can be `INDEFINITE` or `ONCE`."""
100
101
  enum AlertRecurrence {
101
102
  INDEFINITE
102
103
  ONCE
@@ -391,19 +392,39 @@ enum CommunityNoteType {
391
392
  LOGO
392
393
  }
393
394
 
395
+ """Comparison operators."""
394
396
  type ComparisonOperator {
397
+ """Greater than."""
395
398
  gt: String
399
+
400
+ """Greater than or equal to."""
396
401
  gte: String
402
+
403
+ """Less than."""
397
404
  lt: String
405
+
406
+ """Less than or equal to."""
398
407
  lte: String
408
+
409
+ """Equal to."""
399
410
  eq: String
400
411
  }
401
412
 
413
+ """Input for comparison operators."""
402
414
  input ComparisonOperatorInput {
415
+ """Greater than."""
403
416
  gt: String
417
+
418
+ """Greater than or equal."""
404
419
  gte: String
420
+
421
+ """Less than."""
405
422
  lt: String
423
+
424
+ """Less than or equal."""
406
425
  lte: String
426
+
427
+ """Equal to."""
407
428
  eq: String
408
429
  }
409
430
 
@@ -457,89 +478,257 @@ input CreateApiTokensInput {
457
478
  expiresIn: Int
458
479
  }
459
480
 
481
+ """Input for creating an NFT event webhook."""
460
482
  input CreateNftEventWebhookArgs {
483
+ """The name of the webhook (max 128 characters)."""
461
484
  name: String!
485
+
486
+ """The url to which the webhook message should be sent."""
462
487
  callbackUrl: String!
488
+
489
+ """
490
+ A string value to hash along with `deduplicationId` using SHA-256. Included in the webhook message for added security.
491
+ """
463
492
  securityToken: String!
493
+
494
+ """The recurrence of the webhook. Can be `INDEFINITE` or `ONCE`."""
464
495
  alertRecurrence: AlertRecurrence!
496
+
497
+ """
498
+ A webhook group ID (max 64 characters). Can be used to group webhooks so that their messages are kept in order as a group rather than by individual webhook.
499
+ """
465
500
  groupId: String
501
+
502
+ """
503
+ The conditions which must be met in order for the webhook to send a message.
504
+ """
466
505
  conditions: NftEventWebhookConditionInput!
506
+
507
+ """The settings for retrying failed webhook messages."""
467
508
  retrySettings: RetrySettingsInput
509
+
510
+ """
511
+ An optional bucket ID (max 64 characters). Can be used to query for subgroups of webhooks (useful if you have a large number of webhooks).
512
+ """
468
513
  bucketId: String
514
+
515
+ """
516
+ An optional bucket sort key (max 64 characters). Can be used to query for subgroups of webhooks (useful if you have a large number of webhooks).
517
+ """
469
518
  bucketSortkey: String
519
+
520
+ """
521
+ The type of publishing for the webhook. If not set, it defaults to `SINGLE`.
522
+ """
470
523
  publishingType: PublishingType
524
+
525
+ """
526
+ If enabled, new webhooks won't be created if a webhook with the same parameters already exists. If callbackUrl, conditions, publishingType, and alertRecurrence all match, then we return the existing webhook.
527
+ """
471
528
  deduplicate: Boolean
472
529
  }
473
530
 
531
+ """Input for creating NFT event webhooks."""
474
532
  input CreateNftEventWebhooksInput {
533
+ """A list of NFT event webhooks to create."""
475
534
  webhooks: [CreateNftEventWebhookArgs!]!
476
535
  }
477
536
 
537
+ """Input for creating a price webhook."""
478
538
  input CreatePriceWebhookArgs {
539
+ """The name of the webhook (max 128 characters)."""
479
540
  name: String!
541
+
542
+ """The url to which the webhook message should be sent."""
480
543
  callbackUrl: String!
544
+
545
+ """
546
+ A string value to hash along with `deduplicationId` using SHA-256. Included in the webhook message for added security.
547
+ """
481
548
  securityToken: String!
549
+
550
+ """The recurrence of the webhook. Can be `INDEFINITE` or `ONCE`."""
482
551
  alertRecurrence: AlertRecurrence!
552
+
553
+ """
554
+ A webhook group ID (max 64 characters). Can be used to group webhooks so that their messages are kept in order as a group rather than by individual webhook.
555
+ """
483
556
  groupId: String
557
+
558
+ """
559
+ The conditions which must be met in order for the webhook to send a message.
560
+ """
484
561
  conditions: PriceEventWebhookConditionInput!
562
+
563
+ """The settings for retrying failed webhook messages."""
485
564
  retrySettings: RetrySettingsInput
565
+
566
+ """
567
+ An optional bucket ID (max 64 characters). Can be used to query for subgroups of webhooks (useful if you have a large number of webhooks).
568
+ """
486
569
  bucketId: String
570
+
571
+ """
572
+ An optional bucket sort key (max 64 characters). Can be used to query for subgroups of webhooks (useful if you have a large number of webhooks).
573
+ """
487
574
  bucketSortkey: String
575
+
576
+ """
577
+ The type of publishing for the webhook. If not set, it defaults to `SINGLE`.
578
+ """
488
579
  publishingType: PublishingType
580
+
581
+ """
582
+ If enabled, new webhooks won't be created if a webhook with the same parameters already exists. If callbackUrl, conditions, publishingType, and alertRecurrence all match, then we return the existing webhook.
583
+ """
489
584
  deduplicate: Boolean
490
585
  }
491
586
 
587
+ """Input for creating price webhooks."""
492
588
  input CreatePriceWebhooksInput {
589
+ """A list of price webhooks to create."""
493
590
  webhooks: [CreatePriceWebhookArgs!]!
494
591
  }
495
592
 
593
+ """Input for creating a Raw Transaction webhook."""
496
594
  input CreateRawTransactionWebhookArgs {
595
+ """The name of the webhook (max 128 characters)."""
497
596
  name: String!
597
+
598
+ """The url to which the webhook message should be sent."""
498
599
  callbackUrl: String!
600
+
601
+ """
602
+ A string value to hash along with `deduplicationId` using SHA-256. Included in the webhook message for added security.
603
+ """
499
604
  securityToken: String!
605
+
606
+ """The recurrence of the webhook. Can be `INDEFINITE` or `ONCE`."""
500
607
  alertRecurrence: AlertRecurrence!
608
+
609
+ """
610
+ A webhook group ID (max 64 characters). Can be used to group webhooks so that their messages are kept in order as a group rather than by individual webhook.
611
+ """
501
612
  groupId: String
613
+
614
+ """
615
+ The conditions which must be met in order for the webhook to send a message.
616
+ """
502
617
  conditions: RawTransactionWebhookConditionInput!
618
+
619
+ """The settings for retrying failed webhook messages."""
503
620
  retrySettings: RetrySettingsInput
621
+
622
+ """
623
+ An optional bucket ID (max 64 characters). Can be used to query for subgroups of webhooks (useful if you have a large number of webhooks).
624
+ """
504
625
  bucketId: String
626
+
627
+ """
628
+ An optional bucket sort key (max 64 characters). Can be used to query for subgroups of webhooks (useful if you have a large number of webhooks).
629
+ """
505
630
  bucketSortkey: String
631
+
632
+ """
633
+ The type of publishing for the webhook. If not set, it defaults to `SINGLE`.
634
+ """
506
635
  publishingType: PublishingType
636
+
637
+ """
638
+ If enabled, new webhooks won't be created if a webhook with the same parameters already exists. If callbackUrl, conditions, publishingType, and alertRecurrence all match, then we return the existing webhook.
639
+ """
507
640
  deduplicate: Boolean
508
641
  }
509
642
 
643
+ """Input for creating Raw Transaction webhooks."""
510
644
  input CreateRawTransactionWebhooksInput {
645
+ """A list of Raw Transaction webhooks to create."""
511
646
  webhooks: [CreateRawTransactionWebhookArgs!]!
512
647
  }
513
648
 
649
+ """Input for creating a token pair event webhook."""
514
650
  input CreateTokenPairEventWebhookArgs {
651
+ """The name of the webhook (max 128 characters)."""
515
652
  name: String!
653
+
654
+ """The url to which the webhook message should be sent."""
516
655
  callbackUrl: String!
656
+
657
+ """
658
+ A string value to hash along with `deduplicationId` using SHA-256. Included in the webhook message for added security.
659
+ """
517
660
  securityToken: String!
661
+
662
+ """The recurrence of the webhook. Can be `INDEFINITE` or `ONCE`."""
518
663
  alertRecurrence: AlertRecurrence!
664
+
665
+ """
666
+ A webhook group ID (max 64 characters). Can be used to group webhooks so that their messages are kept in order as a group rather than by individual webhook.
667
+ """
519
668
  groupId: String
669
+
670
+ """
671
+ The conditions which must be met in order for the webhook to send a message.
672
+ """
520
673
  conditions: TokenPairEventWebhookConditionInput!
674
+
675
+ """The settings for retrying failed webhook messages."""
521
676
  retrySettings: RetrySettingsInput
677
+
678
+ """
679
+ An optional bucket ID (max 64 characters). Can be used to query for subgroups of webhooks (useful if you have a large number of webhooks).
680
+ """
522
681
  bucketId: String
682
+
683
+ """
684
+ An optional bucket sort key (max 64 characters). Can be used to query for subgroups of webhooks (useful if you have a large number of webhooks).
685
+ """
523
686
  bucketSortkey: String
687
+
688
+ """
689
+ The type of publishing for the webhook. If not set, it defaults to `SINGLE`.
690
+ """
524
691
  publishingType: PublishingType
692
+
693
+ """
694
+ If enabled, new webhooks won't be created if a webhook with the same parameters already exists. If callbackUrl, conditions, publishingType, and alertRecurrence all match, then we return the existing webhook.
695
+ """
525
696
  deduplicate: Boolean
526
697
  }
527
698
 
699
+ """Input for creating token pair event webhooks."""
528
700
  input CreateTokenPairEventWebhooksInput {
701
+ """A list of token pair event webhooks to create."""
529
702
  webhooks: [CreateTokenPairEventWebhookArgs!]!
530
703
  }
531
704
 
705
+ """Input for creating webhooks."""
532
706
  input CreateWebhooksInput {
707
+ """Input for creating price webhooks."""
533
708
  priceWebhooksInput: CreatePriceWebhooksInput
709
+
710
+ """Input for creating token pair event webhooks."""
534
711
  tokenPairEventWebhooksInput: CreateTokenPairEventWebhooksInput
712
+
713
+ """Input for creating NFT event webhooks."""
535
714
  nftEventWebhooksInput: CreateNftEventWebhooksInput
715
+
716
+ """Input for creating raw transaction webhooks."""
536
717
  rawTransactionWebhooksInput: CreateRawTransactionWebhooksInput
537
718
  }
538
719
 
720
+ """Result returned by `createWebhooks`."""
539
721
  type CreateWebhooksOutput {
722
+ """The list of price webhooks that were created."""
540
723
  priceWebhooks: [Webhook]!
724
+
725
+ """The list of token pair event webhooks that were created."""
541
726
  tokenPairEventWebhooks: [Webhook]!
727
+
728
+ """The list of NFT event webhooks that were created."""
542
729
  nftEventWebhooks: [Webhook]!
730
+
731
+ """The list of raw transaction webhooks that were created."""
543
732
  rawTransactionWebhooks: [Webhook]!
544
733
  }
545
734
 
@@ -561,11 +750,15 @@ type CurrencyBarData {
561
750
  token: IndividualBarData!
562
751
  }
563
752
 
753
+ """Input for deleting webhooks."""
564
754
  input DeleteWebhooksInput {
755
+ """A list of webhook IDs to delete."""
565
756
  webhookIds: [String!]!
566
757
  }
567
758
 
759
+ """Result returned by `deleteWebhooks`."""
568
760
  type DeleteWebhooksOutput {
761
+ """The list of webhook IDs that were deleted."""
569
762
  deletedIds: [String]
570
763
  }
571
764
 
@@ -1573,8 +1766,12 @@ input GetTokensInfoInput {
1573
1766
  networkId: Int!
1574
1767
  }
1575
1768
 
1769
+ """Response returned by `getWebhooks`."""
1576
1770
  type GetWebhooksResponse {
1771
+ """A list of webhooks belonging to a user."""
1577
1772
  items: [Webhook]
1773
+
1774
+ """A cursor for use in pagination."""
1578
1775
  cursor: String
1579
1776
  }
1580
1777
 
@@ -1683,11 +1880,15 @@ type IndividualBarData {
1683
1880
  transactions: Int!
1684
1881
  }
1685
1882
 
1883
+ """Integer equals condition."""
1686
1884
  type IntEqualsCondition {
1885
+ """The integer to equal."""
1687
1886
  eq: Int!
1688
1887
  }
1689
1888
 
1889
+ """Input for integer equals condition."""
1690
1890
  input IntEqualsConditionInput {
1891
+ """The integer to equal."""
1691
1892
  eq: Int!
1692
1893
  }
1693
1894
 
@@ -2167,8 +2368,20 @@ type Mutation {
2167
2368
 
2168
2369
  """Delete a single short-lived api access token by id"""
2169
2370
  deleteApiToken(id: String!): String!
2170
- createWebhooks(input: CreateWebhooksInput!): CreateWebhooksOutput!
2171
- deleteWebhooks(input: DeleteWebhooksInput!): DeleteWebhooksOutput
2371
+
2372
+ """
2373
+ Create price, raw transaction, token/pair event, and NFT event webhooks.
2374
+ """
2375
+ createWebhooks(
2376
+ """input: Input for creating webhooks."""
2377
+ input: CreateWebhooksInput!
2378
+ ): CreateWebhooksOutput!
2379
+
2380
+ """Delete multiple webhooks."""
2381
+ deleteWebhooks(
2382
+ """input: Input for deleting webhooks."""
2383
+ input: DeleteWebhooksInput!
2384
+ ): DeleteWebhooksOutput
2172
2385
  }
2173
2386
 
2174
2387
  """A network supported on Defined."""
@@ -3511,11 +3724,15 @@ type NftEvent {
3511
3724
  orderDirection: NftEventOrderDirection
3512
3725
  }
3513
3726
 
3727
+ """NFT marketplaces for a webhook to listen on."""
3514
3728
  type NftEventFillSourceCondition {
3729
+ """The list of NFT marketplaces."""
3515
3730
  oneOf: [WebhookNftEventFillSource!]!
3516
3731
  }
3517
3732
 
3733
+ """Input for NFT event fill source condition."""
3518
3734
  input NftEventFillSourceConditionInput {
3735
+ """The list of NFT marketplace to equal."""
3519
3736
  oneOf: [WebhookNftEventFillSource!]!
3520
3737
  }
3521
3738
 
@@ -3628,35 +3845,75 @@ enum NftEventTradeItemType {
3628
3845
  TOKEN
3629
3846
  }
3630
3847
 
3848
+ """An NFT event type for a webhook to listen for."""
3631
3849
  type NftEventTypeCondition {
3850
+ """The NFT event type."""
3632
3851
  eq: WebhookNftEventType!
3633
3852
  }
3634
3853
 
3854
+ """Input for NFT event type."""
3635
3855
  input NftEventTypeConditionInput {
3856
+ """The NFT event type to equal."""
3636
3857
  eq: WebhookNftEventType!
3637
3858
  }
3638
3859
 
3860
+ """Webhook conditions for an NFT event."""
3639
3861
  type NftEventWebhookCondition {
3862
+ """The list of network IDs the webhook is listening on."""
3640
3863
  networkId: OneOfNumberCondition
3864
+
3865
+ """The maker wallet address the webhook is listening for."""
3641
3866
  maker: StringEqualsCondition
3867
+
3868
+ """The NFT collection contract address the webhook is listening for."""
3642
3869
  contractAddress: StringEqualsCondition
3870
+
3871
+ """The exchange contract address the webhook is listening for."""
3643
3872
  exchangeAddress: StringEqualsCondition
3873
+
3874
+ """The token ID the webhook is listening for."""
3644
3875
  tokenId: StringEqualsCondition
3876
+
3877
+ """The token contract address the webhook is listening for."""
3645
3878
  tokenAddress: StringEqualsCondition
3879
+
3880
+ """The base token price the webhook is listening for."""
3646
3881
  individualBaseTokenPrice: ComparisonOperator
3882
+
3883
+ """The NFT event type the webhook is listening for."""
3647
3884
  eventType: NftEventTypeCondition
3885
+
3886
+ """The NFT marketplaces the webhook is listening on."""
3648
3887
  fillSource: NftEventFillSourceCondition
3888
+
3889
+ """Option to ignore all nft transfer events"""
3649
3890
  ignoreTransfers: Boolean
3650
3891
  }
3651
3892
 
3893
+ """Input conditions for an NFT event webhook."""
3652
3894
  input NftEventWebhookConditionInput {
3895
+ """A list of network IDs to listen on."""
3653
3896
  networkId: OneOfNumberConditionInput
3897
+
3898
+ """The maker wallet address to listen for."""
3654
3899
  maker: StringEqualsConditionInput
3900
+
3901
+ """The NFT collection contract address to listen for."""
3655
3902
  contractAddress: StringEqualsConditionInput
3903
+
3904
+ """The exchange contract address to listen for."""
3656
3905
  exchangeAddress: StringEqualsConditionInput
3906
+
3907
+ """The token ID to listen for."""
3657
3908
  tokenId: StringEqualsConditionInput
3909
+
3910
+ """The NFT event type to listen for."""
3658
3911
  eventType: NftEventTypeConditionInput
3912
+
3913
+ """The NFT marketplaces to listen for."""
3659
3914
  fillSource: NftEventFillSourceConditionInput
3915
+
3916
+ """Option to ignore all nft transfer events"""
3660
3917
  ignoreTransfers: Boolean
3661
3918
  }
3662
3919
 
@@ -5695,11 +5952,15 @@ type OnBarsUpdatedResponse {
5695
5952
  quoteTokenAddress: String!
5696
5953
  }
5697
5954
 
5955
+ """Integer list condition."""
5698
5956
  type OneOfNumberCondition {
5957
+ """The list of integers."""
5699
5958
  oneOf: [Int!]!
5700
5959
  }
5701
5960
 
5961
+ """Input for integer list condition."""
5702
5962
  input OneOfNumberConditionInput {
5963
+ """The list of integers."""
5703
5964
  oneOf: [Int!]!
5704
5965
  }
5705
5966
 
@@ -6826,16 +7087,34 @@ type Price {
6826
7087
  confidence: Float
6827
7088
  }
6828
7089
 
7090
+ """Webhook conditions for a price event."""
6829
7091
  type PriceEventWebhookCondition {
7092
+ """The token contract address the webhook is listening for."""
6830
7093
  tokenAddress: StringEqualsCondition!
7094
+
7095
+ """The network ID the webhook is listening on."""
6831
7096
  networkId: IntEqualsCondition!
7097
+
7098
+ """The price condition that must be met in order for the webhook to send."""
6832
7099
  priceUsd: ComparisonOperator!
7100
+
7101
+ """The pair contract address the webhook is listening for."""
7102
+ pairAddress: StringEqualsCondition
6833
7103
  }
6834
7104
 
7105
+ """Input conditions for a price event webhook."""
6835
7106
  input PriceEventWebhookConditionInput {
7107
+ """The contract address of the token to listen for."""
6836
7108
  tokenAddress: StringEqualsConditionInput!
7109
+
7110
+ """The network ID to listen on."""
6837
7111
  networkId: IntEqualsConditionInput!
7112
+
7113
+ """The price conditions to listen for."""
6838
7114
  priceUsd: ComparisonOperatorInput!
7115
+
7116
+ """The contract address of the pair to listen for."""
7117
+ pairAddress: StringEqualsConditionInput
6839
7118
  }
6840
7119
 
6841
7120
  """Response returned by `primeHolders`."""
@@ -7528,7 +7807,26 @@ type Query {
7528
7807
  """The list of network IDs."""
7529
7808
  networkIds: [Int!]!
7530
7809
  ): [MetadataResponse!]
7531
- getWebhooks(cursor: String, webhookId: String, bucketId: String, bucketSortkey: String, limit: Int): GetWebhooksResponse
7810
+
7811
+ """Returns a user's list of webhooks."""
7812
+ getWebhooks(
7813
+ """The cursor to use for pagination."""
7814
+ cursor: String
7815
+
7816
+ """webhookId: The id of the webhook you want to retrieve."""
7817
+ webhookId: String
7818
+
7819
+ """
7820
+ bucketId: The bucketId of the webhooks you want to retrieve. Note that bucketId and webhookId are mutually exclusive, do not send both.
7821
+ """
7822
+ bucketId: String
7823
+
7824
+ """bucketSortkey: The bucketSortkey of the webhooks you want to retrieve."""
7825
+ bucketSortkey: String
7826
+
7827
+ """limit: The maximum number of webhooks to return."""
7828
+ limit: Int
7829
+ ): GetWebhooksResponse
7532
7830
 
7533
7831
  """Returns an NFT pool."""
7534
7832
  getNftPool(
@@ -8545,23 +8843,63 @@ type RawNftAssetData {
8545
8843
  externalUrl: String
8546
8844
  }
8547
8845
 
8846
+ """Webhook conditions for a raw transaction."""
8548
8847
  type RawTransactionWebhookCondition {
8848
+ """A list of network IDs to listen on."""
8549
8849
  networkId: OneOfNumberCondition
8850
+
8851
+ """The to address to listen for."""
8550
8852
  to: StringEqualsCondition
8853
+
8854
+ """The from address to listen for."""
8551
8855
  from: StringEqualsCondition
8856
+
8857
+ """Trigger the webhook if either the to or the from address matches."""
8552
8858
  toOrFrom: StringEqualsCondition
8859
+
8860
+ """
8861
+ Trigger the webhook if the contains or doesn't contain the specified string.
8862
+ """
8553
8863
  input: StringContainsCondition
8864
+
8865
+ """
8866
+ Do not trigger the webhook if the raw transaction is handled by the TokenPairEvent webhook.
8867
+ """
8554
8868
  ignoreTokenPairEvents: Boolean
8869
+
8870
+ """
8871
+ Do not trigger the webhook if the raw transaction is handled by the NftEvent webhook.
8872
+ """
8555
8873
  ignoreNftEvents: Boolean
8556
8874
  }
8557
8875
 
8876
+ """Input conditions for a Raw Transaction webhook."""
8558
8877
  input RawTransactionWebhookConditionInput {
8878
+ """A list of network IDs to listen on."""
8559
8879
  networkId: OneOfNumberConditionInput
8880
+
8881
+ """The to address to listen for."""
8560
8882
  to: StringEqualsConditionInput
8883
+
8884
+ """The from address to listen for."""
8561
8885
  from: StringEqualsConditionInput
8886
+
8887
+ """Trigger the webhook if either the to or the from address matches."""
8562
8888
  toOrFrom: StringEqualsConditionInput
8889
+
8890
+ """
8891
+ Trigger the webhook if the input contains or doesn't contain the specified string.
8892
+ """
8563
8893
  input: StringContainsConditionInput
8894
+
8895
+ """
8896
+ Do not trigger the webhook if the raw transaction is handled by the TokenPairEvent webhook.
8897
+ """
8564
8898
  ignoreTokenPairEvents: Boolean
8899
+
8900
+ """
8901
+ Do not trigger the webhook if the raw transaction is handled by the NftEvent webhook.
8902
+ """
8565
8903
  ignoreNftEvents: Boolean
8566
8904
  }
8567
8905
 
@@ -8636,17 +8974,45 @@ type ResolutionBarData {
8636
8974
  r7D: CurrencyBarData
8637
8975
  }
8638
8976
 
8977
+ """Config for retrying failed webhook messages"""
8639
8978
  type RetrySettings {
8979
+ """
8980
+ The maximum time in seconds that the webhook will retry sending a message
8981
+ """
8640
8982
  maxTimeElapsed: Int
8983
+
8984
+ """
8985
+ The minimum time in seconds that the webhook will wait before retrying a failed message
8986
+ """
8641
8987
  minRetryDelay: Int
8988
+
8989
+ """
8990
+ The maximum time in seconds that the webhook will wait before retrying a failed message
8991
+ """
8642
8992
  maxRetryDelay: Int
8993
+
8994
+ """The maximum number of times the webhook will retry sending a message"""
8643
8995
  maxRetries: Int
8644
8996
  }
8645
8997
 
8998
+ """Config input for retrying failed webhook messages"""
8646
8999
  input RetrySettingsInput {
9000
+ """
9001
+ The maximum time in seconds that the webhook will retry sending a message
9002
+ """
8647
9003
  maxTimeElapsed: Int
9004
+
9005
+ """
9006
+ The minimum time in seconds that the webhook will wait before retrying a failed message
9007
+ """
8648
9008
  minRetryDelay: Int
9009
+
9010
+ """
9011
+ The maximum time in seconds that the webhook will wait before retrying a failed message
9012
+ """
8649
9013
  maxRetryDelay: Int
9014
+
9015
+ """The maximum number of times the webhook will retry sending a message"""
8650
9016
  maxRetries: Int
8651
9017
  }
8652
9018
 
@@ -9004,21 +9370,33 @@ input statsNonCurrency {
9004
9370
  uniqueMinters: StatsFilter
9005
9371
  }
9006
9372
 
9373
+ """String contains condition."""
9007
9374
  type StringContainsCondition {
9375
+ """A list of substrings included within the string."""
9008
9376
  contains: [String!]
9377
+
9378
+ """A list of substrings not included within the string."""
9009
9379
  notContains: [String!]
9010
9380
  }
9011
9381
 
9382
+ """Input for string contains condition."""
9012
9383
  input StringContainsConditionInput {
9384
+ """A list of substrings to be included within the string."""
9013
9385
  contains: [String!]
9386
+
9387
+ """A list of substrings not to be included within the string."""
9014
9388
  notContains: [String!]
9015
9389
  }
9016
9390
 
9391
+ """String equals condition."""
9017
9392
  type StringEqualsCondition {
9393
+ """The string to equal."""
9018
9394
  eq: String!
9019
9395
  }
9020
9396
 
9397
+ """Input for string equals condition."""
9021
9398
  input StringEqualsConditionInput {
9399
+ """The string to equal."""
9022
9400
  eq: String!
9023
9401
  }
9024
9402
 
@@ -10032,6 +10410,7 @@ enum TokenOfInterest {
10032
10410
  token1
10033
10411
  }
10034
10412
 
10413
+ """Token pair event types."""
10035
10414
  enum TokenPairEventType {
10036
10415
  SWAP
10037
10416
  MINT
@@ -10043,31 +10422,63 @@ enum TokenPairEventType {
10043
10422
  COLLECT_PROTOCOL
10044
10423
  }
10045
10424
 
10425
+ """Webhook condition for token pair event type."""
10046
10426
  type TokenPairEventTypeCondition {
10427
+ """The list of token pair event types."""
10047
10428
  oneOf: [TokenPairEventType!]!
10048
10429
  }
10049
10430
 
10431
+ """Input for token pair event type condition."""
10050
10432
  input TokenPairEventTypeConditionInput {
10433
+ """The list of token event types to equal."""
10051
10434
  oneOf: [TokenPairEventType!]!
10052
10435
  }
10053
10436
 
10437
+ """Webhook conditions for a token pair event."""
10054
10438
  type TokenPairEventWebhookCondition {
10439
+ """The token contract address the webhook is listening for."""
10055
10440
  tokenAddress: StringEqualsCondition
10441
+
10442
+ """The list of network IDs the webhook is listening on."""
10056
10443
  networkId: OneOfNumberCondition
10444
+
10445
+ """The swap values the webhook is listening for."""
10057
10446
  swapValue: ComparisonOperator
10447
+
10448
+ """The maker wallet address the webhook is listening for."""
10058
10449
  maker: StringEqualsCondition
10450
+
10451
+ """The pair contract address the webhook is listening for."""
10059
10452
  pairAddress: StringEqualsCondition
10453
+
10454
+ """The exchange contract address the webhook is listening for."""
10060
10455
  exchangeAddress: StringEqualsCondition
10456
+
10457
+ """The event type the webhook is listening for."""
10061
10458
  eventType: TokenPairEventTypeCondition
10062
10459
  }
10063
10460
 
10461
+ """Input conditions for a token pair event webhook."""
10064
10462
  input TokenPairEventWebhookConditionInput {
10463
+ """A list of network IDs to listen on."""
10065
10464
  networkId: OneOfNumberConditionInput
10465
+
10466
+ """The maker wallet address to listen for."""
10066
10467
  maker: StringEqualsConditionInput
10468
+
10469
+ """The pair contract address to listen for."""
10067
10470
  pairAddress: StringEqualsConditionInput
10471
+
10472
+ """The exchange contract address to listen for."""
10068
10473
  exchangeAddress: StringEqualsConditionInput
10474
+
10475
+ """The token contract address to listen for."""
10069
10476
  tokenAddress: StringEqualsConditionInput
10477
+
10478
+ """The swap values to listen for."""
10070
10479
  swapValue: ComparisonOperatorInput
10480
+
10481
+ """The token event type to listen for."""
10071
10482
  eventType: TokenPairEventTypeConditionInput
10072
10483
  }
10073
10484
 
@@ -10546,24 +10957,64 @@ type WashtradeLabelForEvent {
10546
10957
  label: String!
10547
10958
  }
10548
10959
 
10960
+ """Metadata for a webhook."""
10549
10961
  type Webhook {
10962
+ """The ID of the webhook."""
10550
10963
  id: String!
10964
+
10965
+ """
10966
+ The type of webhook. Can be `PRICE_EVENT`, `NFT_EVENT`, or `TOKEN_PAIR_EVENT`.
10967
+ """
10551
10968
  webhookType: WebhookType!
10969
+
10970
+ """The given name of the webhook."""
10552
10971
  name: String!
10972
+
10973
+ """The unix timestamp for the time the webhook was created."""
10553
10974
  created: Int!
10975
+
10976
+ """The recurrence of the webhook. Can be `INDEFINITE` or `ONCE`."""
10554
10977
  alertRecurrence: AlertRecurrence!
10978
+
10979
+ """The url to which the webhook message should be sent."""
10555
10980
  callbackUrl: String!
10981
+
10982
+ """The status of the webhook. Can be `ACTIVE` or `INACTIVE`."""
10556
10983
  status: String!
10984
+
10985
+ """
10986
+ The webhook group ID used to group webhooks together for ordered message sending.
10987
+ """
10557
10988
  groupId: String
10989
+
10990
+ """
10991
+ The conditions which must be met in order for the webhook to send a message.
10992
+ """
10558
10993
  conditions: WebhookCondition!
10994
+
10995
+ """The settings for retrying failed webhook messages."""
10559
10996
  retrySettings: RetrySettings
10997
+
10998
+ """
10999
+ An optional bucket ID (max 64 characters). Can be used to query for subgroups of webhooks (useful if you have a large number of webhooks).
11000
+ """
10560
11001
  bucketId: String
11002
+
11003
+ """
11004
+ An optional bucket sort key (max 64 characters). Can be used to query for subgroups of webhooks (useful if you have a large number of webhooks).
11005
+ """
10561
11006
  bucketSortkey: String
11007
+
11008
+ """
11009
+ The type of publishing for the webhook. If not set, it defaults to `SINGLE`.
11010
+ """
10562
11011
  publishingType: PublishingType
10563
11012
  }
10564
11013
 
11014
+ """Webhook conditions that must be met for each webhook type."""
10565
11015
  union WebhookCondition = PriceEventWebhookCondition | TokenPairEventWebhookCondition | NftEventWebhookCondition | RawTransactionWebhookCondition
10566
11016
 
11017
+ """NFT marketplace names."""
10567
11018
  enum WebhookNftEventFillSource {
10568
11019
  GEM
10569
11020
  ENSVISION
@@ -10582,12 +11033,14 @@ enum WebhookNftEventFillSource {
10582
11033
  GENIE
10583
11034
  }
10584
11035
 
11036
+ """NFT event types."""
10585
11037
  enum WebhookNftEventType {
10586
11038
  MINT
10587
11039
  SALE
10588
11040
  TRANSFER
10589
11041
  }
10590
11042
 
11043
+ """The type of webhook."""
10591
11044
  enum WebhookType {
10592
11045
  PRICE_EVENT
10593
11046
  NFT_EVENT