@codex-data/sdk 1.0.1 → 1.0.2

package/README.md

@@ -99,6 +99,12 @@ This shows how you could use it in a NextJS project.
 - `bun i`
 - `NEXT_PUBLIC_CODEX_API_KEY=xyz bun run dev`
 
+## Releasing a new version
+
+- Increase version number to what you want in package.json on a branch.
+- Merge that Pr to main
+- Release it with the right version number. 
+
 ## Contributing
 
 Prs open!

package/dist/resources/graphql.d.ts

@@ -125,6 +125,7 @@ export type AddUserAchievementInput = {
     quantity: Scalars['Int']['input'];
     userId: Scalars['String']['input'];
 };
+/** The recurrence of the webhook. Can be `INDEFINITE` or `ONCE`. */
 export declare enum AlertRecurrence {
     Indefinite = "INDEFINITE",
     Once = "ONCE"
@@ -334,19 +335,31 @@ export type CommunityNotesResponse = {
     /** The list of community notes matching the filter parameters. */
     items: Array<CommunityNote>;
 };
+/** Comparison operators. */
 export type ComparisonOperator = {
     __typename?: 'ComparisonOperator';
+    /** Equal to. */
     eq?: Maybe<Scalars['String']['output']>;
+    /** Greater than. */
     gt?: Maybe<Scalars['String']['output']>;
+    /** Greater than or equal to. */
     gte?: Maybe<Scalars['String']['output']>;
+    /** Less than. */
     lt?: Maybe<Scalars['String']['output']>;
+    /** Less than or equal to. */
     lte?: Maybe<Scalars['String']['output']>;
 };
+/** Input for comparison operators. */
 export type ComparisonOperatorInput = {
+    /** Equal to. */
     eq?: InputMaybe<Scalars['String']['input']>;
+    /** Greater than. */
     gt?: InputMaybe<Scalars['String']['input']>;
+    /** Greater than or equal. */
     gte?: InputMaybe<Scalars['String']['input']>;
+    /** Less than. */
     lt?: InputMaybe<Scalars['String']['input']>;
+    /** Less than or equal. */
     lte?: InputMaybe<Scalars['String']['input']>;
 };
 /** Metadata for a contract label. */
@@ -386,81 +399,147 @@ export type CreateApiTokensInput = {
     /** Number of requests allowed per token, represented as a string, default is 5000 */
     requestLimit?: InputMaybe<Scalars['String']['input']>;
 };
+/** Input for creating an NFT event webhook. */
 export type CreateNftEventWebhookArgs = {
+    /** The recurrence of the webhook. Can be `INDEFINITE` or `ONCE`. */
     alertRecurrence: AlertRecurrence;
+    /** 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). */
     bucketId?: InputMaybe<Scalars['String']['input']>;
+    /** 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). */
     bucketSortkey?: InputMaybe<Scalars['String']['input']>;
+    /** The url to which the webhook message should be sent. */
     callbackUrl: Scalars['String']['input'];
+    /** The conditions which must be met in order for the webhook to send a message. */
     conditions: NftEventWebhookConditionInput;
+    /** 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. */
     deduplicate?: InputMaybe<Scalars['Boolean']['input']>;
+    /** 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. */
     groupId?: InputMaybe<Scalars['String']['input']>;
+    /** The name of the webhook (max 128 characters). */
     name: Scalars['String']['input'];
+    /** The type of publishing for the webhook. If not set, it defaults to `SINGLE`. */
     publishingType?: InputMaybe<PublishingType>;
+    /** The settings for retrying failed webhook messages. */
     retrySettings?: InputMaybe<RetrySettingsInput>;
+    /** A string value to hash along with `deduplicationId` using SHA-256. Included in the webhook message for added security. */
     securityToken: Scalars['String']['input'];
 };
+/** Input for creating NFT event webhooks. */
 export type CreateNftEventWebhooksInput = {
+    /** A list of NFT event webhooks to create. */
     webhooks: Array<CreateNftEventWebhookArgs>;
 };
+/** Input for creating a price webhook. */
 export type CreatePriceWebhookArgs = {
+    /** The recurrence of the webhook. Can be `INDEFINITE` or `ONCE`. */
     alertRecurrence: AlertRecurrence;
+    /** 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). */
     bucketId?: InputMaybe<Scalars['String']['input']>;
+    /** 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). */
     bucketSortkey?: InputMaybe<Scalars['String']['input']>;
+    /** The url to which the webhook message should be sent. */
     callbackUrl: Scalars['String']['input'];
+    /** The conditions which must be met in order for the webhook to send a message. */
     conditions: PriceEventWebhookConditionInput;
+    /** 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. */
     deduplicate?: InputMaybe<Scalars['Boolean']['input']>;
+    /** 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. */
     groupId?: InputMaybe<Scalars['String']['input']>;
+    /** The name of the webhook (max 128 characters). */
     name: Scalars['String']['input'];
+    /** The type of publishing for the webhook. If not set, it defaults to `SINGLE`. */
     publishingType?: InputMaybe<PublishingType>;
+    /** The settings for retrying failed webhook messages. */
     retrySettings?: InputMaybe<RetrySettingsInput>;
+    /** A string value to hash along with `deduplicationId` using SHA-256. Included in the webhook message for added security. */
     securityToken: Scalars['String']['input'];
 };
+/** Input for creating price webhooks. */
 export type CreatePriceWebhooksInput = {
+    /** A list of price webhooks to create. */
     webhooks: Array<CreatePriceWebhookArgs>;
 };
+/** Input for creating a Raw Transaction webhook. */
 export type CreateRawTransactionWebhookArgs = {
+    /** The recurrence of the webhook. Can be `INDEFINITE` or `ONCE`. */
     alertRecurrence: AlertRecurrence;
+    /** 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). */
     bucketId?: InputMaybe<Scalars['String']['input']>;
+    /** 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). */
     bucketSortkey?: InputMaybe<Scalars['String']['input']>;
+    /** The url to which the webhook message should be sent. */
     callbackUrl: Scalars['String']['input'];
+    /** The conditions which must be met in order for the webhook to send a message. */
     conditions: RawTransactionWebhookConditionInput;
+    /** 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. */
     deduplicate?: InputMaybe<Scalars['Boolean']['input']>;
+    /** 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. */
     groupId?: InputMaybe<Scalars['String']['input']>;
+    /** The name of the webhook (max 128 characters). */
     name: Scalars['String']['input'];
+    /** The type of publishing for the webhook. If not set, it defaults to `SINGLE`. */
     publishingType?: InputMaybe<PublishingType>;
+    /** The settings for retrying failed webhook messages. */
     retrySettings?: InputMaybe<RetrySettingsInput>;
+    /** A string value to hash along with `deduplicationId` using SHA-256. Included in the webhook message for added security. */
     securityToken: Scalars['String']['input'];
 };
+/** Input for creating Raw Transaction webhooks. */
 export type CreateRawTransactionWebhooksInput = {
+    /** A list of Raw Transaction webhooks to create. */
     webhooks: Array<CreateRawTransactionWebhookArgs>;
 };
+/** Input for creating a token pair event webhook. */
 export type CreateTokenPairEventWebhookArgs = {
+    /** The recurrence of the webhook. Can be `INDEFINITE` or `ONCE`. */
     alertRecurrence: AlertRecurrence;
+    /** 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). */
     bucketId?: InputMaybe<Scalars['String']['input']>;
+    /** 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). */
     bucketSortkey?: InputMaybe<Scalars['String']['input']>;
+    /** The url to which the webhook message should be sent. */
     callbackUrl: Scalars['String']['input'];
+    /** The conditions which must be met in order for the webhook to send a message. */
     conditions: TokenPairEventWebhookConditionInput;
+    /** 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. */
     deduplicate?: InputMaybe<Scalars['Boolean']['input']>;
+    /** 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. */
     groupId?: InputMaybe<Scalars['String']['input']>;
+    /** The name of the webhook (max 128 characters). */
     name: Scalars['String']['input'];
+    /** The type of publishing for the webhook. If not set, it defaults to `SINGLE`. */
     publishingType?: InputMaybe<PublishingType>;
+    /** The settings for retrying failed webhook messages. */
     retrySettings?: InputMaybe<RetrySettingsInput>;
+    /** A string value to hash along with `deduplicationId` using SHA-256. Included in the webhook message for added security. */
     securityToken: Scalars['String']['input'];
 };
+/** Input for creating token pair event webhooks. */
 export type CreateTokenPairEventWebhooksInput = {
+    /** A list of token pair event webhooks to create. */
     webhooks: Array<CreateTokenPairEventWebhookArgs>;
 };
+/** Input for creating webhooks. */
 export type CreateWebhooksInput = {
+    /** Input for creating NFT event webhooks. */
     nftEventWebhooksInput?: InputMaybe<CreateNftEventWebhooksInput>;
+    /** Input for creating price webhooks. */
     priceWebhooksInput?: InputMaybe<CreatePriceWebhooksInput>;
+    /** Input for creating raw transaction webhooks. */
     rawTransactionWebhooksInput?: InputMaybe<CreateRawTransactionWebhooksInput>;
+    /** Input for creating token pair event webhooks. */
     tokenPairEventWebhooksInput?: InputMaybe<CreateTokenPairEventWebhooksInput>;
 };
+/** Result returned by `createWebhooks`. */
 export type CreateWebhooksOutput = {
     __typename?: 'CreateWebhooksOutput';
+    /** The list of NFT event webhooks that were created. */
     nftEventWebhooks: Array<Maybe<Webhook>>;
+    /** The list of price webhooks that were created. */
     priceWebhooks: Array<Maybe<Webhook>>;
+    /** The list of raw transaction webhooks that were created. */
     rawTransactionWebhooks: Array<Maybe<Webhook>>;
+    /** The list of token pair event webhooks that were created. */
     tokenPairEventWebhooks: Array<Maybe<Webhook>>;
 };
 export declare enum CreationContext {
@@ -478,11 +557,15 @@ export type CurrencyBarData = {
     /** Bar chart data in USD. */
     usd: IndividualBarData;
 };
+/** Input for deleting webhooks. */
 export type DeleteWebhooksInput = {
+    /** A list of webhook IDs to delete. */
     webhookIds: Array<Scalars['String']['input']>;
 };
+/** Result returned by `deleteWebhooks`. */
 export type DeleteWebhooksOutput = {
     __typename?: 'DeleteWebhooksOutput';
+    /** The list of webhook IDs that were deleted. */
     deletedIds?: Maybe<Array<Maybe<Scalars['String']['output']>>>;
 };
 /** Detailed stats for an NFT collection. */
@@ -1246,9 +1329,12 @@ export type GetTokensInfoInput = {
     /** The network ID the token is deployed on. */
     networkId: Scalars['Int']['input'];
 };
+/** Response returned by `getWebhooks`. */
 export type GetWebhooksResponse = {
     __typename?: 'GetWebhooksResponse';
+    /** A cursor for use in pagination. */
     cursor?: Maybe<Scalars['String']['output']>;
+    /** A list of webhooks belonging to a user. */
     items?: Maybe<Array<Maybe<Webhook>>>;
 };
 /** The pool variant. */
@@ -1327,11 +1413,15 @@ export type IndividualBarData = {
     /** The volume in the network's base token */
     volumeNativeToken: Scalars['String']['output'];
 };
+/** Integer equals condition. */
 export type IntEqualsCondition = {
     __typename?: 'IntEqualsCondition';
+    /** The integer to equal. */
     eq: Scalars['Int']['output'];
 };
+/** Input for integer equals condition. */
 export type IntEqualsConditionInput = {
+    /** The integer to equal. */
     eq: Scalars['Int']['input'];
 };
 /** Event labels. Can be `sandwich` or `washtrade`. */
@@ -1653,9 +1743,11 @@ export type Mutation = {
     __typename?: 'Mutation';
     /** Create a new set of short-lived api access tokens */
     createApiTokens: Array<ApiToken>;
+    /** Create price, raw transaction, token/pair event, and NFT event webhooks. */
     createWebhooks: CreateWebhooksOutput;
     /** Delete a single short-lived api access token by id */
     deleteApiToken: Scalars['String']['output'];
+    /** Delete multiple webhooks. */
     deleteWebhooks?: Maybe<DeleteWebhooksOutput>;
 };
 export type MutationCreateApiTokensArgs = {
@@ -2767,11 +2859,15 @@ export type NftEvent = {
     /** The index of the transaction within the block. */
     transactionIndex: Scalars['Int']['output'];
 };
+/** NFT marketplaces for a webhook to listen on. */
 export type NftEventFillSourceCondition = {
     __typename?: 'NftEventFillSourceCondition';
+    /** The list of NFT marketplaces. */
     oneOf: Array<WebhookNftEventFillSource>;
 };
+/** Input for NFT event fill source condition. */
 export type NftEventFillSourceConditionInput = {
+    /** The list of NFT marketplace to equal. */
     oneOf: Array<WebhookNftEventFillSource>;
 };
 /** Details for an NFT offered or received as part of an nft trade. */
@@ -2840,34 +2936,58 @@ export declare enum NftEventTradeItemType {
     Nft = "NFT",
     Token = "TOKEN"
 }
+/** An NFT event type for a webhook to listen for. */
 export type NftEventTypeCondition = {
     __typename?: 'NftEventTypeCondition';
+    /** The NFT event type. */
     eq: WebhookNftEventType;
 };
+/** Input for NFT event type. */
 export type NftEventTypeConditionInput = {
+    /** The NFT event type to equal. */
     eq: WebhookNftEventType;
 };
+/** Webhook conditions for an NFT event. */
 export type NftEventWebhookCondition = {
     __typename?: 'NftEventWebhookCondition';
+    /** The NFT collection contract address the webhook is listening for. */
     contractAddress?: Maybe<StringEqualsCondition>;
+    /** The NFT event type the webhook is listening for. */
     eventType?: Maybe<NftEventTypeCondition>;
+    /** The exchange contract address the webhook is listening for. */
     exchangeAddress?: Maybe<StringEqualsCondition>;
+    /** The NFT marketplaces the webhook is listening on. */
     fillSource?: Maybe<NftEventFillSourceCondition>;
+    /** Option to ignore all nft transfer events */
     ignoreTransfers?: Maybe<Scalars['Boolean']['output']>;
+    /** The base token price the webhook is listening for. */
     individualBaseTokenPrice?: Maybe<ComparisonOperator>;
+    /** The maker wallet address the webhook is listening for. */
     maker?: Maybe<StringEqualsCondition>;
+    /** The list of network IDs the webhook is listening on. */
     networkId?: Maybe<OneOfNumberCondition>;
+    /** The token contract address the webhook is listening for. */
     tokenAddress?: Maybe<StringEqualsCondition>;
+    /** The token ID the webhook is listening for. */
     tokenId?: Maybe<StringEqualsCondition>;
 };
+/** Input conditions for an NFT event webhook. */
 export type NftEventWebhookConditionInput = {
+    /** The NFT collection contract address to listen for. */
     contractAddress?: InputMaybe<StringEqualsConditionInput>;
+    /** The NFT event type to listen for. */
     eventType?: InputMaybe<NftEventTypeConditionInput>;
+    /** The exchange contract address to listen for. */
     exchangeAddress?: InputMaybe<StringEqualsConditionInput>;
+    /** The NFT marketplaces to listen for. */
     fillSource?: InputMaybe<NftEventFillSourceConditionInput>;
+    /** Option to ignore all nft transfer events */
     ignoreTransfers?: InputMaybe<Scalars['Boolean']['input']>;
+    /** The maker wallet address to listen for. */
     maker?: InputMaybe<StringEqualsConditionInput>;
+    /** A list of network IDs to listen on. */
     networkId?: InputMaybe<OneOfNumberConditionInput>;
+    /** The token ID to listen for. */
     tokenId?: InputMaybe<StringEqualsConditionInput>;
 };
 /** Response returned by `getNftEvents`. */
@@ -4237,11 +4357,15 @@ export type OnUnconfirmedBarsUpdated = {
     /** The unix timestamp for the new bar. */
     timestamp: Scalars['Int']['output'];
 };
+/** Integer list condition. */
 export type OneOfNumberCondition = {
     __typename?: 'OneOfNumberCondition';
+    /** The list of integers. */
     oneOf: Array<Scalars['Int']['output']>;
 };
+/** Input for integer list condition. */
 export type OneOfNumberConditionInput = {
+    /** The list of integers. */
     oneOf: Array<Scalars['Int']['input']>;
 };
 export declare enum OrderState {
@@ -5006,15 +5130,27 @@ export type Price = {
     /** The unix timestamp for the price. */
     timestamp: Scalars['Int']['output'];
 };
+/** Webhook conditions for a price event. */
 export type PriceEventWebhookCondition = {
     __typename?: 'PriceEventWebhookCondition';
+    /** The network ID the webhook is listening on. */
     networkId: IntEqualsCondition;
+    /** The pair contract address the webhook is listening for. */
+    pairAddress?: Maybe<StringEqualsCondition>;
+    /** The price condition that must be met in order for the webhook to send. */
     priceUsd: ComparisonOperator;
+    /** The token contract address the webhook is listening for. */
     tokenAddress: StringEqualsCondition;
 };
+/** Input conditions for a price event webhook. */
 export type PriceEventWebhookConditionInput = {
+    /** The network ID to listen on. */
     networkId: IntEqualsConditionInput;
+    /** The contract address of the pair to listen for. */
+    pairAddress?: InputMaybe<StringEqualsConditionInput>;
+    /** The price conditions to listen for. */
     priceUsd: ComparisonOperatorInput;
+    /** The contract address of the token to listen for. */
     tokenAddress: StringEqualsConditionInput;
 };
 /** Response returned by `primeHolders`. */
@@ -5583,6 +5719,7 @@ export type Query = {
     getTokensInfo?: Maybe<Array<Maybe<TokenInfo>>>;
     /** Returns tick data for a given Uniswap V3-style pool. */
     getUniV3Ticks?: Maybe<UniV3TickConnection>;
+    /** Returns a user's list of webhooks. */
     getWebhooks?: Maybe<GetWebhooksResponse>;
     /** Returns list of wallets that hold a given token, ordered by holdings descending. Also has the unique count of holders for that token */
     holders: HoldersResponse;
@@ -6050,23 +6187,39 @@ export type RawNftAssetData = {
     /** An optional image field that may or may not be present on the requested NFT asset smart contract. */
     imageUrl?: Maybe<Scalars['String']['output']>;
 };
+/** Webhook conditions for a raw transaction. */
 export type RawTransactionWebhookCondition = {
     __typename?: 'RawTransactionWebhookCondition';
+    /** The from address to listen for. */
     from?: Maybe<StringEqualsCondition>;
+    /** Do not trigger the webhook if the raw transaction is handled by the NftEvent webhook. */
     ignoreNftEvents?: Maybe<Scalars['Boolean']['output']>;
+    /** Do not trigger the webhook if the raw transaction is handled by the TokenPairEvent webhook. */
     ignoreTokenPairEvents?: Maybe<Scalars['Boolean']['output']>;
+    /** Trigger the webhook if the  contains or doesn't contain the specified string. */
     input?: Maybe<StringContainsCondition>;
+    /** A list of network IDs to listen on. */
     networkId?: Maybe<OneOfNumberCondition>;
+    /** The to address to listen for. */
     to?: Maybe<StringEqualsCondition>;
+    /** Trigger the webhook if either the to or the from address matches. */
     toOrFrom?: Maybe<StringEqualsCondition>;
 };
+/** Input conditions for a Raw Transaction webhook. */
 export type RawTransactionWebhookConditionInput = {
+    /** The from address to listen for. */
     from?: InputMaybe<StringEqualsConditionInput>;
+    /** Do not trigger the webhook if the raw transaction is handled by the NftEvent webhook. */
     ignoreNftEvents?: InputMaybe<Scalars['Boolean']['input']>;
+    /** Do not trigger the webhook if the raw transaction is handled by the TokenPairEvent webhook. */
     ignoreTokenPairEvents?: InputMaybe<Scalars['Boolean']['input']>;
+    /** Trigger the webhook if the input contains or doesn't contain the specified string. */
     input?: InputMaybe<StringContainsConditionInput>;
+    /** A list of network IDs to listen on. */
     networkId?: InputMaybe<OneOfNumberConditionInput>;
+    /** The to address to listen for. */
     to?: InputMaybe<StringEqualsConditionInput>;
+    /** Trigger the webhook if either the to or the from address matches. */
     toOrFrom?: InputMaybe<StringEqualsConditionInput>;
 };
 export type ReferralEventData = ReferralsEventPayoutData | ReferralsEventRewardData;
@@ -6126,17 +6279,27 @@ export type ResolutionBarData = {
     /** 12 hour resolution. */
     r720?: Maybe<CurrencyBarData>;
 };
+/** Config for retrying failed webhook messages */
 export type RetrySettings = {
     __typename?: 'RetrySettings';
+    /** The maximum number of times the webhook will retry sending a message */
     maxRetries?: Maybe<Scalars['Int']['output']>;
+    /** The maximum time in seconds that the webhook will wait before retrying a failed message */
     maxRetryDelay?: Maybe<Scalars['Int']['output']>;
+    /** The maximum time in seconds that the webhook will retry sending a message */
     maxTimeElapsed?: Maybe<Scalars['Int']['output']>;
+    /** The minimum time in seconds that the webhook will wait before retrying a failed message */
     minRetryDelay?: Maybe<Scalars['Int']['output']>;
 };
+/** Config input for retrying failed webhook messages */
 export type RetrySettingsInput = {
+    /** The maximum number of times the webhook will retry sending a message */
     maxRetries?: InputMaybe<Scalars['Int']['input']>;
+    /** The maximum time in seconds that the webhook will wait before retrying a failed message */
     maxRetryDelay?: InputMaybe<Scalars['Int']['input']>;
+    /** The maximum time in seconds that the webhook will retry sending a message */
     maxTimeElapsed?: InputMaybe<Scalars['Int']['input']>;
+    /** The minimum time in seconds that the webhook will wait before retrying a failed message */
     minRetryDelay?: InputMaybe<Scalars['Int']['input']>;
 };
 /** Metadata for a sandwich label. */
@@ -6407,20 +6570,30 @@ export type StatsFilter = {
     /** The total value for the previous window. */
     previous?: InputMaybe<NumberFilter>;
 };
+/** String contains condition. */
 export type StringContainsCondition = {
     __typename?: 'StringContainsCondition';
+    /** A list of substrings included within the string. */
     contains?: Maybe<Array<Scalars['String']['output']>>;
+    /** A list of substrings not included within the string. */
     notContains?: Maybe<Array<Scalars['String']['output']>>;
 };
+/** Input for string contains condition. */
 export type StringContainsConditionInput = {
+    /** A list of substrings to be included within the string. */
     contains?: InputMaybe<Array<Scalars['String']['input']>>;
+    /** A list of substrings not to be included within the string. */
     notContains?: InputMaybe<Array<Scalars['String']['input']>>;
 };
+/** String equals condition. */
 export type StringEqualsCondition = {
     __typename?: 'StringEqualsCondition';
+    /** The string to equal. */
     eq: Scalars['String']['output'];
 };
+/** Input for string equals condition. */
 export type StringEqualsConditionInput = {
+    /** The string to equal. */
     eq: Scalars['String']['input'];
 };
 /** Input type of `StringFilter`. */
@@ -7090,6 +7263,7 @@ export declare enum TokenOfInterest {
     Token0 = "token0",
     Token1 = "token1"
 }
+/** Token pair event types. */
 export declare enum TokenPairEventType {
     Burn = "BURN",
     Buy = "BUY",
@@ -7100,30 +7274,50 @@ export declare enum TokenPairEventType {
     Swap = "SWAP",
     Sync = "SYNC"
 }
+/** Webhook condition for token pair event type. */
 export type TokenPairEventTypeCondition = {
     __typename?: 'TokenPairEventTypeCondition';
+    /** The list of token pair event types. */
     oneOf: Array<TokenPairEventType>;
 };
+/** Input for token pair event type condition. */
 export type TokenPairEventTypeConditionInput = {
+    /** The list of token event types to equal. */
     oneOf: Array<TokenPairEventType>;
 };
+/** Webhook conditions for a token pair event. */
 export type TokenPairEventWebhookCondition = {
     __typename?: 'TokenPairEventWebhookCondition';
+    /** The event type the webhook is listening for. */
     eventType?: Maybe<TokenPairEventTypeCondition>;
+    /** The exchange contract address the webhook is listening for. */
     exchangeAddress?: Maybe<StringEqualsCondition>;
+    /** The maker wallet address the webhook is listening for. */
     maker?: Maybe<StringEqualsCondition>;
+    /** The list of network IDs the webhook is listening on. */
     networkId?: Maybe<OneOfNumberCondition>;
+    /** The pair contract address the webhook is listening for. */
     pairAddress?: Maybe<StringEqualsCondition>;
+    /** The swap values the webhook is listening for. */
     swapValue?: Maybe<ComparisonOperator>;
+    /** The token contract address the webhook is listening for. */
     tokenAddress?: Maybe<StringEqualsCondition>;
 };
+/** Input conditions for a token pair event webhook. */
 export type TokenPairEventWebhookConditionInput = {
+    /** The token event type to listen for. */
     eventType?: InputMaybe<TokenPairEventTypeConditionInput>;
+    /** The exchange contract address to listen for. */
     exchangeAddress?: InputMaybe<StringEqualsConditionInput>;
+    /** The maker wallet address to listen for. */
     maker?: InputMaybe<StringEqualsConditionInput>;
+    /** A list of network IDs to listen on. */
     networkId?: InputMaybe<OneOfNumberConditionInput>;
+    /** The pair contract address to listen for. */
     pairAddress?: InputMaybe<StringEqualsConditionInput>;
+    /** The swap values to listen for. */
     swapValue?: InputMaybe<ComparisonOperatorInput>;
+    /** The token contract address to listen for. */
     tokenAddress?: InputMaybe<StringEqualsConditionInput>;
 };
 /** The type of statistics returned. Can be `FILTERED` or `UNFILTERED` */
@@ -7469,23 +7663,39 @@ export type WashtradeLabelForEvent = {
     /** The label type, 'washtrade' */
     label: Scalars['String']['output'];
 };
+/** Metadata for a webhook. */
 export type Webhook = {
     __typename?: 'Webhook';
+    /** The recurrence of the webhook. Can be `INDEFINITE` or `ONCE`. */
     alertRecurrence: AlertRecurrence;
+    /** 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). */
     bucketId?: Maybe<Scalars['String']['output']>;
+    /** 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). */
     bucketSortkey?: Maybe<Scalars['String']['output']>;
+    /** The url to which the webhook message should be sent. */
     callbackUrl: Scalars['String']['output'];
+    /** The conditions which must be met in order for the webhook to send a message. */
     conditions: WebhookCondition;
+    /** The unix timestamp for the time the webhook was created. */
     created: Scalars['Int']['output'];
+    /** The webhook group ID used to group webhooks together for ordered message sending. */
     groupId?: Maybe<Scalars['String']['output']>;
+    /** The ID of the webhook. */
     id: Scalars['String']['output'];
+    /** The given name of the webhook. */
     name: Scalars['String']['output'];
+    /** The type of publishing for the webhook. If not set, it defaults to `SINGLE`. */
     publishingType?: Maybe<PublishingType>;
+    /** The settings for retrying failed webhook messages. */
     retrySettings?: Maybe<RetrySettings>;
+    /** The status of the webhook. Can be `ACTIVE` or `INACTIVE`. */
     status: Scalars['String']['output'];
+    /** The type of webhook. Can be `PRICE_EVENT`, `NFT_EVENT`, or `TOKEN_PAIR_EVENT`. */
     webhookType: WebhookType;
 };
+/** Webhook conditions that must be met for each webhook type. */
 export type WebhookCondition = NftEventWebhookCondition | PriceEventWebhookCondition | RawTransactionWebhookCondition | TokenPairEventWebhookCondition;
+/** NFT marketplace names. */
 export declare enum WebhookNftEventFillSource {
     Blur = "BLUR",
     Coinbase = "COINBASE",
@@ -7503,11 +7713,13 @@ export declare enum WebhookNftEventFillSource {
     Reservoirtools = "RESERVOIRTOOLS",
     Soundxyz = "SOUNDXYZ"
 }
+/** NFT event types. */
 export declare enum WebhookNftEventType {
     Mint = "MINT",
     Sale = "SALE",
     Transfer = "TRANSFER"
 }
+/** The type of webhook. */
 export declare enum WebhookType {
     NftEvent = "NFT_EVENT",
     PriceEvent = "PRICE_EVENT",