@story-protocol/ipkit 0.4.0-beta.9

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.
Files changed (189) hide show
  1. package/dist/components/Accordion/Accordion.d.ts +8 -0
  2. package/dist/components/Accordion/Accordion.d.ts.map +1 -0
  3. package/dist/components/Accordion/__docs__/Accordion.stories.d.ts +18 -0
  4. package/dist/components/Accordion/__docs__/Accordion.stories.d.ts.map +1 -0
  5. package/dist/components/Accordion/index.d.ts +2 -0
  6. package/dist/components/Accordion/index.d.ts.map +1 -0
  7. package/dist/components/Button/Button.d.ts +13 -0
  8. package/dist/components/Button/Button.d.ts.map +1 -0
  9. package/dist/components/Button/__docs__/Button.stories.d.ts +23 -0
  10. package/dist/components/Button/__docs__/Button.stories.d.ts.map +1 -0
  11. package/dist/components/Button/index.d.ts +2 -0
  12. package/dist/components/Button/index.d.ts.map +1 -0
  13. package/dist/components/Calendar/Calendar.d.ts +9 -0
  14. package/dist/components/Calendar/Calendar.d.ts.map +1 -0
  15. package/dist/components/Calendar/index.d.ts +1 -0
  16. package/dist/components/Calendar/index.d.ts.map +1 -0
  17. package/dist/components/Checkbox/Checkbox.d.ts +9 -0
  18. package/dist/components/Checkbox/Checkbox.d.ts.map +1 -0
  19. package/dist/components/Checkbox/__docs__/Checkbox.stories.d.ts +17 -0
  20. package/dist/components/Checkbox/__docs__/Checkbox.stories.d.ts.map +1 -0
  21. package/dist/components/Checkbox/index.d.ts +2 -0
  22. package/dist/components/Checkbox/index.d.ts.map +1 -0
  23. package/dist/components/DateInputPicker/DateInputPicker.d.ts +23 -0
  24. package/dist/components/DateInputPicker/DateInputPicker.d.ts.map +1 -0
  25. package/dist/components/DateInputPicker/__docs__/DateInputPicker.stories.d.ts +31 -0
  26. package/dist/components/DateInputPicker/__docs__/DateInputPicker.stories.d.ts.map +1 -0
  27. package/dist/components/DateInputPicker/dateUtils.d.ts +18 -0
  28. package/dist/components/DateInputPicker/dateUtils.d.ts.map +1 -0
  29. package/dist/components/DateInputPicker/index.d.ts +2 -0
  30. package/dist/components/DateInputPicker/index.d.ts.map +1 -0
  31. package/dist/components/Input/Input.d.ts +13 -0
  32. package/dist/components/Input/Input.d.ts.map +1 -0
  33. package/dist/components/Input/__docs__/Input.stories.d.ts +26 -0
  34. package/dist/components/Input/__docs__/Input.stories.d.ts.map +1 -0
  35. package/dist/components/Input/index.d.ts +2 -0
  36. package/dist/components/Input/index.d.ts.map +1 -0
  37. package/dist/components/Popover/Popover.d.ts +7 -0
  38. package/dist/components/Popover/Popover.d.ts.map +1 -0
  39. package/dist/components/Popover/__docs__/Popover.stories.d.ts +17 -0
  40. package/dist/components/Popover/__docs__/Popover.stories.d.ts.map +1 -0
  41. package/dist/components/Popover/index.d.ts +2 -0
  42. package/dist/components/Popover/index.d.ts.map +1 -0
  43. package/dist/components/RadioGroup/RadioGroup.d.ts +14 -0
  44. package/dist/components/RadioGroup/RadioGroup.d.ts.map +1 -0
  45. package/dist/components/RadioGroup/__docs__/RadioGroup.stories.d.ts +31 -0
  46. package/dist/components/RadioGroup/__docs__/RadioGroup.stories.d.ts.map +1 -0
  47. package/dist/components/RadioGroup/index.d.ts +2 -0
  48. package/dist/components/RadioGroup/index.d.ts.map +1 -0
  49. package/dist/components/index.d.ts +2 -0
  50. package/dist/components/index.d.ts.map +1 -0
  51. package/dist/components/utility/If.d.ts +9 -0
  52. package/dist/components/utility/If.d.ts.map +1 -0
  53. package/dist/components/utility/context.d.ts +12 -0
  54. package/dist/components/utility/context.d.ts.map +1 -0
  55. package/dist/constants/api.d.ts +5 -0
  56. package/dist/constants/api.d.ts.map +1 -0
  57. package/dist/constants/chains.d.ts +10 -0
  58. package/dist/constants/chains.d.ts.map +1 -0
  59. package/dist/constants/index.d.ts +3 -0
  60. package/dist/constants/index.d.ts.map +1 -0
  61. package/dist/constants/pil-flavors.d.ts +7 -0
  62. package/dist/constants/pil-flavors.d.ts.map +1 -0
  63. package/dist/hooks/index.d.ts +15 -0
  64. package/dist/hooks/index.d.ts.map +1 -0
  65. package/dist/hooks/stories/(components)/CopyText.d.ts +8 -0
  66. package/dist/hooks/stories/(components)/CopyText.d.ts.map +1 -0
  67. package/dist/hooks/stories/(components)/DataTable.d.ts +8 -0
  68. package/dist/hooks/stories/(components)/DataTable.d.ts.map +1 -0
  69. package/dist/hooks/stories/useCollection.stories.d.ts +20 -0
  70. package/dist/hooks/stories/useCollection.stories.d.ts.map +1 -0
  71. package/dist/hooks/stories/useCollections.stories.d.ts +28 -0
  72. package/dist/hooks/stories/useCollections.stories.d.ts.map +1 -0
  73. package/dist/hooks/stories/useDispute.stories.d.ts +20 -0
  74. package/dist/hooks/stories/useDispute.stories.d.ts.map +1 -0
  75. package/dist/hooks/stories/useDisputes.stories.d.ts +37 -0
  76. package/dist/hooks/stories/useDisputes.stories.d.ts.map +1 -0
  77. package/dist/hooks/stories/useIpAsset.stories.d.ts +21 -0
  78. package/dist/hooks/stories/useIpAsset.stories.d.ts.map +1 -0
  79. package/dist/hooks/stories/useIpAssetChildren.stories.d.ts +28 -0
  80. package/dist/hooks/stories/useIpAssetChildren.stories.d.ts.map +1 -0
  81. package/dist/hooks/stories/useIpAssetEdges.stories.d.ts +27 -0
  82. package/dist/hooks/stories/useIpAssetEdges.stories.d.ts.map +1 -0
  83. package/dist/hooks/stories/useIpAssetLicenses.stories.d.ts +20 -0
  84. package/dist/hooks/stories/useIpAssetLicenses.stories.d.ts.map +1 -0
  85. package/dist/hooks/stories/useIpAssetParents.stories.d.ts +28 -0
  86. package/dist/hooks/stories/useIpAssetParents.stories.d.ts.map +1 -0
  87. package/dist/hooks/stories/useIpAssets.stories.d.ts +38 -0
  88. package/dist/hooks/stories/useIpAssets.stories.d.ts.map +1 -0
  89. package/dist/hooks/stories/useIpAssetsByOwner.stories.d.ts +30 -0
  90. package/dist/hooks/stories/useIpAssetsByOwner.stories.d.ts.map +1 -0
  91. package/dist/hooks/stories/useSearch.stories.d.ts +19 -0
  92. package/dist/hooks/stories/useSearch.stories.d.ts.map +1 -0
  93. package/dist/hooks/stories/useTransaction.stories.d.ts +20 -0
  94. package/dist/hooks/stories/useTransaction.stories.d.ts.map +1 -0
  95. package/dist/hooks/stories/useTransactions.stories.d.ts +30 -0
  96. package/dist/hooks/stories/useTransactions.stories.d.ts.map +1 -0
  97. package/dist/hooks/useCollection.d.ts +10 -0
  98. package/dist/hooks/useCollection.d.ts.map +1 -0
  99. package/dist/hooks/useCollections.d.ts +11 -0
  100. package/dist/hooks/useCollections.d.ts.map +1 -0
  101. package/dist/hooks/useDispute.d.ts +8 -0
  102. package/dist/hooks/useDispute.d.ts.map +1 -0
  103. package/dist/hooks/useDisputes.d.ts +12 -0
  104. package/dist/hooks/useDisputes.d.ts.map +1 -0
  105. package/dist/hooks/useIpAsset.d.ts +11 -0
  106. package/dist/hooks/useIpAsset.d.ts.map +1 -0
  107. package/dist/hooks/useIpAssetChildren.d.ts +11 -0
  108. package/dist/hooks/useIpAssetChildren.d.ts.map +1 -0
  109. package/dist/hooks/useIpAssetEdges.d.ts +12 -0
  110. package/dist/hooks/useIpAssetEdges.d.ts.map +1 -0
  111. package/dist/hooks/useIpAssetLicenses.d.ts +10 -0
  112. package/dist/hooks/useIpAssetLicenses.d.ts.map +1 -0
  113. package/dist/hooks/useIpAssetParents.d.ts +11 -0
  114. package/dist/hooks/useIpAssetParents.d.ts.map +1 -0
  115. package/dist/hooks/useIpAssets.d.ts +14 -0
  116. package/dist/hooks/useIpAssets.d.ts.map +1 -0
  117. package/dist/hooks/useIpAssetsByOwner.d.ts +13 -0
  118. package/dist/hooks/useIpAssetsByOwner.d.ts.map +1 -0
  119. package/dist/hooks/useSearch.d.ts +10 -0
  120. package/dist/hooks/useSearch.d.ts.map +1 -0
  121. package/dist/hooks/useTransaction.d.ts +9 -0
  122. package/dist/hooks/useTransaction.d.ts.map +1 -0
  123. package/dist/hooks/useTransactions.d.ts +14 -0
  124. package/dist/hooks/useTransactions.d.ts.map +1 -0
  125. package/dist/index.d.ts +7 -0
  126. package/dist/index.d.ts.map +1 -0
  127. package/dist/lib/api/apiClient.d.ts +7 -0
  128. package/dist/lib/api/apiClient.d.ts.map +1 -0
  129. package/dist/lib/api/getCollections.d.ts +346 -0
  130. package/dist/lib/api/getCollections.d.ts.map +1 -0
  131. package/dist/lib/api/getDispute.d.ts +134 -0
  132. package/dist/lib/api/getDispute.d.ts.map +1 -0
  133. package/dist/lib/api/getDisputes.d.ts +320 -0
  134. package/dist/lib/api/getDisputes.d.ts.map +1 -0
  135. package/dist/lib/api/getIpAssetEdges.d.ts +292 -0
  136. package/dist/lib/api/getIpAssetEdges.d.ts.map +1 -0
  137. package/dist/lib/api/getIpAssets.d.ts +675 -0
  138. package/dist/lib/api/getIpAssets.d.ts.map +1 -0
  139. package/dist/lib/api/getQuery.d.ts +18 -0
  140. package/dist/lib/api/getQuery.d.ts.map +1 -0
  141. package/dist/lib/api/getSearch.d.ts +246 -0
  142. package/dist/lib/api/getSearch.d.ts.map +1 -0
  143. package/dist/lib/api/getTransactions.d.ts +292 -0
  144. package/dist/lib/api/getTransactions.d.ts.map +1 -0
  145. package/dist/lib/api/index.d.ts +9 -0
  146. package/dist/lib/api/index.d.ts.map +1 -0
  147. package/dist/lib/api/listQuery.d.ts +16 -0
  148. package/dist/lib/api/listQuery.d.ts.map +1 -0
  149. package/dist/lib/functions/convertLicenseTermObject.d.ts +6 -0
  150. package/dist/lib/functions/convertLicenseTermObject.d.ts.map +1 -0
  151. package/dist/lib/index.d.ts +4 -0
  152. package/dist/lib/index.d.ts.map +1 -0
  153. package/dist/lib/utils.d.ts +12 -0
  154. package/dist/lib/utils.d.ts.map +1 -0
  155. package/dist/providers/IpKitProvider/IpKitProvider.d.ts +25 -0
  156. package/dist/providers/IpKitProvider/IpKitProvider.d.ts.map +1 -0
  157. package/dist/providers/IpKitProvider/__docs__/Example.d.ts +11 -0
  158. package/dist/providers/IpKitProvider/__docs__/Example.d.ts.map +1 -0
  159. package/dist/providers/IpKitProvider/__docs__/IpKitProvider.stories.d.ts +37 -0
  160. package/dist/providers/IpKitProvider/__docs__/IpKitProvider.stories.d.ts.map +1 -0
  161. package/dist/providers/IpKitProvider/index.d.ts +2 -0
  162. package/dist/providers/IpKitProvider/index.d.ts.map +1 -0
  163. package/dist/providers/index.d.ts +2 -0
  164. package/dist/providers/index.d.ts.map +1 -0
  165. package/dist/server-types.d.ts +3494 -0
  166. package/dist/server.cjs.js +2 -0
  167. package/dist/server.cjs.js.map +1 -0
  168. package/dist/server.d.ts +4 -0
  169. package/dist/server.d.ts.map +1 -0
  170. package/dist/server.esm.js +2 -0
  171. package/dist/server.esm.js.map +1 -0
  172. package/dist/stories/data/index.d.ts +9 -0
  173. package/dist/stories/data/index.d.ts.map +1 -0
  174. package/dist/storyprotocol-storykit.cjs.js +2 -0
  175. package/dist/storyprotocol-storykit.cjs.js.map +1 -0
  176. package/dist/storyprotocol-storykit.esm.js +2 -0
  177. package/dist/storyprotocol-storykit.esm.js.map +1 -0
  178. package/dist/types/assets.d.ts +58 -0
  179. package/dist/types/assets.d.ts.map +1 -0
  180. package/dist/types/chains.d.ts +25 -0
  181. package/dist/types/chains.d.ts.map +1 -0
  182. package/dist/types/index.d.ts +4 -0
  183. package/dist/types/index.d.ts.map +1 -0
  184. package/dist/types/openapi.d.ts +30 -0
  185. package/dist/types/openapi.d.ts.map +1 -0
  186. package/dist/types/schema.d.ts +1065 -0
  187. package/dist/types/schema.d.ts.map +1 -0
  188. package/dist/types.d.ts +3622 -0
  189. package/package.json +132 -0
@@ -0,0 +1,3622 @@
1
+ import * as openapi_fetch from 'openapi-fetch';
2
+ import { Client } from 'openapi-fetch';
3
+ import { Address } from 'viem';
4
+ import React from 'react';
5
+ import { ClassValue } from 'clsx';
6
+ import { UseQueryResult } from '@tanstack/react-query';
7
+
8
+ interface paths {
9
+ "/assets": {
10
+ parameters: {
11
+ query?: never;
12
+ header?: never;
13
+ path?: never;
14
+ cookie?: never;
15
+ };
16
+ get?: never;
17
+ put?: never;
18
+ /**
19
+ * List IP Assets
20
+ * @description Retrieve a list of IP assets with pagination and filtering options. The 'where' field is optional and should only be provided when filtering by specific IP IDs, owner address, or token contract address. This endpoint can also be used to fetch a single asset by passing its ID in the ipIds filter.
21
+ */
22
+ post: operations["listIPAssetsV4"];
23
+ delete?: never;
24
+ options?: never;
25
+ head?: never;
26
+ patch?: never;
27
+ trace?: never;
28
+ };
29
+ "/assets/edges": {
30
+ parameters: {
31
+ query?: never;
32
+ header?: never;
33
+ path?: never;
34
+ cookie?: never;
35
+ };
36
+ get?: never;
37
+ put?: never;
38
+ /**
39
+ * List IP Asset Edges
40
+ * @description Retrieve a list of edges (derivative registered events) that represent relationships between IP assets. These edges show parent-child relationships formed through licensing.
41
+ */
42
+ post: operations["listEdgesV4"];
43
+ delete?: never;
44
+ options?: never;
45
+ head?: never;
46
+ patch?: never;
47
+ trace?: never;
48
+ };
49
+ "/collections": {
50
+ parameters: {
51
+ query?: never;
52
+ header?: never;
53
+ path?: never;
54
+ cookie?: never;
55
+ };
56
+ get?: never;
57
+ put?: never;
58
+ /**
59
+ * List Collections
60
+ * @description Retrieve a list of collections with pagination and filtering options. Collections are ordered by most recent or least recent updated time only. Collections are automatically enriched with metadata. The 'where' field is optional and should only be provided when filtering by specific collection addresses or asset counts. This endpoint can also be used to fetch a single collection by passing its address in the collectionAddresses filter. Collections that don't exist in Alchemy or encounter errors will return with empty metadata instead of failing the entire request.
61
+ */
62
+ post: operations["listCollectionsV4"];
63
+ delete?: never;
64
+ options?: never;
65
+ head?: never;
66
+ patch?: never;
67
+ trace?: never;
68
+ };
69
+ "/disputes": {
70
+ parameters: {
71
+ query?: never;
72
+ header?: never;
73
+ path?: never;
74
+ cookie?: never;
75
+ };
76
+ get?: never;
77
+ put?: never;
78
+ /**
79
+ * List Disputes
80
+ * @description Retrieve a paginated, filtered list of disputes from the SOS database.
81
+ * This endpoint supports various filtering options including:
82
+ * - Filter by dispute ID, target IP ID, initiator address, or status
83
+ * - Filter by block number ranges (blockNumber, blockNumberLte, blockNumberGte)
84
+ * - Sort by block number, dispute timestamp, or ID
85
+ * - Pagination with configurable limit and offset
86
+ *
87
+ * Key v4 Enhancements:
88
+ * - Flattened request structure: Query parameters are directly in the request body, not nested in an "options" object
89
+ * - Offset-based pagination: Unlike v3, this endpoint supports both limit and offset parameters for flexible pagination
90
+ * - Block number range filtering: Added blockNumberGte for greater-than-or-equal filtering (complements existing blockNumberLte)
91
+ * - Pagination metadata in response: Returns total count and hasMore flag
92
+ *
93
+ * The response format is aligned with v3 for compatibility, using big integers for numeric fields and hex strings for data fields.
94
+ */
95
+ post: operations["listDisputesV4"];
96
+ delete?: never;
97
+ options?: never;
98
+ head?: never;
99
+ patch?: never;
100
+ trace?: never;
101
+ };
102
+ "/disputes/{disputeId}": {
103
+ parameters: {
104
+ query?: never;
105
+ header?: never;
106
+ path?: never;
107
+ cookie?: never;
108
+ };
109
+ /**
110
+ * Get a Dispute
111
+ * @description Retrieve a single dispute by its ID from the SOS database. This endpoint provides detailed information about a specific dispute including its status, involved parties, and related metadata.
112
+ */
113
+ get: operations["getDisputeV4"];
114
+ put?: never;
115
+ post?: never;
116
+ delete?: never;
117
+ options?: never;
118
+ head?: never;
119
+ patch?: never;
120
+ trace?: never;
121
+ };
122
+ "/search": {
123
+ parameters: {
124
+ query?: never;
125
+ header?: never;
126
+ path?: never;
127
+ cookie?: never;
128
+ };
129
+ get?: never;
130
+ put?: never;
131
+ /**
132
+ * Search IP Assets
133
+ * @description Perform vector search for IP assets based on query text and optional media type filter. This endpoint uses AI-powered search to find relevant assets by semantic similarity.
134
+ */
135
+ post: operations["searchV4"];
136
+ delete?: never;
137
+ options?: never;
138
+ head?: never;
139
+ patch?: never;
140
+ trace?: never;
141
+ };
142
+ "/transactions": {
143
+ parameters: {
144
+ query?: never;
145
+ header?: never;
146
+ path?: never;
147
+ cookie?: never;
148
+ };
149
+ get?: never;
150
+ put?: never;
151
+ /**
152
+ * List IP Transactions
153
+ * @description Retrieve a list of IP transactions with pagination and filtering options. The 'where' field is optional and should only be provided when filtering by specific transaction hashes, event types, or block ranges. This endpoint can also be used to fetch specific transactions by passing their hashes in the txHashes filter.
154
+ */
155
+ post: operations["listTransactionsV4"];
156
+ delete?: never;
157
+ options?: never;
158
+ head?: never;
159
+ patch?: never;
160
+ trace?: never;
161
+ };
162
+ }
163
+ interface components {
164
+ schemas: {
165
+ CollectionsRequestBodyHuma: {
166
+ /**
167
+ * Format: uri
168
+ * @description A URL to the JSON Schema for this object.
169
+ */
170
+ readonly $schema?: string;
171
+ /**
172
+ * @description Field to order results by (only updatedAt is supported)
173
+ * @default updatedAt
174
+ * @enum {string}
175
+ */
176
+ orderBy: "updatedAt";
177
+ /**
178
+ * @description Order direction: asc for least recent, desc for most recent
179
+ * @default desc
180
+ * @enum {string}
181
+ */
182
+ orderDirection: "asc" | "desc";
183
+ /** @description Pagination configuration */
184
+ pagination?: components["schemas"]["PaginationOptionsHuma"];
185
+ /** @description Optional filter options for collections */
186
+ where?: components["schemas"]["CollectionsWhereOptionsHuma"];
187
+ };
188
+ CollectionsResponseBodyHuma: {
189
+ /**
190
+ * Format: uri
191
+ * @description A URL to the JSON Schema for this object.
192
+ */
193
+ readonly $schema?: string;
194
+ /** @description List of enriched collections */
195
+ data: components["schemas"]["EnrichedCollection"][] | null;
196
+ /** @description Pagination metadata */
197
+ pagination?: components["schemas"]["PaginationMetadataHuma"];
198
+ };
199
+ CollectionsWhereOptionsHuma: {
200
+ /** @description List of collection addresses to filter by (max 200) */
201
+ collectionAddresses?: string[] | null;
202
+ /**
203
+ * Format: int64
204
+ * @description Maximum asset count threshold
205
+ */
206
+ maxAssetCount?: number;
207
+ /**
208
+ * Format: int64
209
+ * @description Minimum asset count threshold
210
+ */
211
+ minAssetCount?: number;
212
+ };
213
+ ContractMetadata: {
214
+ address: string;
215
+ chain: string;
216
+ contractDeployer: string;
217
+ /** Format: int64 */
218
+ deployedBlockNumber: number;
219
+ name: string;
220
+ openSeaMetadata: components["schemas"]["ContractMetadataOpenSeaMetadataStruct"];
221
+ symbol: string;
222
+ tokenType: string;
223
+ totalSupply: string;
224
+ };
225
+ ContractMetadataByAddressResponse: {
226
+ address: string;
227
+ chain: string;
228
+ contractDeployer: string;
229
+ /** Format: int64 */
230
+ deployedBlockNumber: number;
231
+ name: string;
232
+ openSeaMetadata: components["schemas"]["ContractMetadataByAddressResponseOpenSeaMetadataStruct"];
233
+ symbol: string;
234
+ tokenType: string;
235
+ totalSupply: string;
236
+ };
237
+ ContractMetadataByAddressResponseOpenSeaMetadataStruct: {
238
+ bannerImageUrl: string;
239
+ collectionName: string;
240
+ collectionSlug: string;
241
+ description: string;
242
+ discordUrl: string;
243
+ externalUrl: string | null;
244
+ /** Format: double */
245
+ floorPrice: number;
246
+ imageUrl: string;
247
+ /** Format: date-time */
248
+ lastIngestedAt: string;
249
+ safelistRequestStatus: string;
250
+ twitterUsername: string;
251
+ };
252
+ ContractMetadataOpenSeaMetadataStruct: {
253
+ bannerImageUrl: string;
254
+ collectionName: string;
255
+ collectionSlug: string;
256
+ description: string;
257
+ discordUrl: string;
258
+ externalUrl: string | null;
259
+ /** Format: double */
260
+ floorPrice: number;
261
+ imageUrl: string;
262
+ /** Format: date-time */
263
+ lastIngestedAt: string;
264
+ safelistRequestStatus: string;
265
+ twitterUsername: string;
266
+ };
267
+ DerivativeRegisteredEvent: {
268
+ /** Format: int64 */
269
+ blockNumber: number;
270
+ /** Format: date-time */
271
+ blockTimestamp: string;
272
+ caller: string;
273
+ childIpId: string;
274
+ /** Format: int64 */
275
+ id: number;
276
+ licenseTemplate: string;
277
+ licenseTermsId: string;
278
+ licenseTokenId: string;
279
+ /** Format: int64 */
280
+ logIndex: number;
281
+ parentIpId: string;
282
+ /** Format: date-time */
283
+ processedAt: string;
284
+ txHash: string;
285
+ };
286
+ Dispute: {
287
+ arbitrationPolicy: string;
288
+ blockNumber: string | null;
289
+ blockTimestamp?: string;
290
+ counterEvidenceHash: string;
291
+ currentTag: string;
292
+ data: string;
293
+ deletedAt?: string;
294
+ disputeTimestamp: string | null;
295
+ evidenceHash: string;
296
+ id: string | null;
297
+ initiator: string;
298
+ liveness: string | null;
299
+ logIndex?: string;
300
+ status: string;
301
+ targetIpId: string;
302
+ targetTag: string;
303
+ transactionHash: string;
304
+ umaLink?: string;
305
+ };
306
+ DisputePaginationHuma: {
307
+ /**
308
+ * Format: int64
309
+ * @description Number of items to return (max: 200)
310
+ * @default 100
311
+ */
312
+ limit: number;
313
+ /**
314
+ * Format: int64
315
+ * @description Number of items to skip for pagination (v4 enhancement)
316
+ * @default 0
317
+ */
318
+ offset: number;
319
+ };
320
+ DisputePaginationMetadataHuma: {
321
+ /** @description Whether there are more disputes */
322
+ hasMore: boolean;
323
+ /**
324
+ * Format: int64
325
+ * @description Current limit
326
+ */
327
+ limit: number;
328
+ /**
329
+ * Format: int64
330
+ * @description Current offset
331
+ */
332
+ offset: number;
333
+ /**
334
+ * Format: int64
335
+ * @description Total count of disputes
336
+ */
337
+ total?: number;
338
+ };
339
+ DisputeWhereHuma: {
340
+ /** @description Filter by exact block number */
341
+ blockNumber?: string;
342
+ /** @description Filter by block number >= this value (v4 enhancement) */
343
+ blockNumberGte?: string;
344
+ /** @description Filter by block number <= this value */
345
+ blockNumberLte?: string;
346
+ /** @description Dispute ID to filter by */
347
+ id?: string;
348
+ /** @description Initiator wallet address to filter by */
349
+ initiator?: string;
350
+ /** @description Target IP ID to filter by */
351
+ targetIpId?: string;
352
+ };
353
+ DisputesRequestBodyHuma: {
354
+ /**
355
+ * Format: uri
356
+ * @description A URL to the JSON Schema for this object.
357
+ */
358
+ readonly $schema?: string;
359
+ /** @description Field to order results by (must be blockNumber or empty) */
360
+ orderBy?: string;
361
+ /** @description Order direction for results (asc or desc) */
362
+ orderDirection?: string;
363
+ /** @description Pagination configuration */
364
+ pagination?: components["schemas"]["DisputePaginationHuma"];
365
+ /** @description Filter options for disputes */
366
+ where?: components["schemas"]["DisputeWhereHuma"];
367
+ };
368
+ EdgesRequestBodyHuma: {
369
+ /**
370
+ * Format: uri
371
+ * @description A URL to the JSON Schema for this object.
372
+ */
373
+ readonly $schema?: string;
374
+ /**
375
+ * @description Field to order results by (currently only blockNumber is supported)
376
+ * @enum {string}
377
+ */
378
+ orderBy?: "blockNumber";
379
+ /**
380
+ * @description Order direction for results
381
+ * @default desc
382
+ * @enum {string}
383
+ */
384
+ orderDirection: "asc" | "desc";
385
+ /** @description Pagination configuration */
386
+ pagination?: components["schemas"]["PaginationOptionsHuma"];
387
+ /** @description Filter options for edges */
388
+ where?: components["schemas"]["EdgesWhereOptionsHuma"];
389
+ };
390
+ EdgesResponseHumaBody: {
391
+ /**
392
+ * Format: uri
393
+ * @description A URL to the JSON Schema for this object.
394
+ */
395
+ readonly $schema?: string;
396
+ /** @description List of derivative registered events (edges) */
397
+ data: components["schemas"]["DerivativeRegisteredEvent"][] | null;
398
+ /** @description Pagination metadata */
399
+ pagination?: components["schemas"]["PaginationMetadataHuma"];
400
+ };
401
+ EdgesWhereOptionsHuma: {
402
+ /**
403
+ * Format: int64
404
+ * @description Block number to filter by
405
+ */
406
+ blockNumber?: number;
407
+ /** @description Child IP ID to filter by */
408
+ childIpId?: string;
409
+ /** @description Parent IP ID to filter by */
410
+ parentIpId?: string;
411
+ /** @description Transaction hash to filter by */
412
+ txHash?: string;
413
+ };
414
+ EnrichedCollection: {
415
+ /** Format: int64 */
416
+ assetCount: number;
417
+ /** Format: int64 */
418
+ cancelledDisputeCount: number;
419
+ collectionAddress: string;
420
+ collectionMetadata?: components["schemas"]["ContractMetadataByAddressResponse"];
421
+ /** Format: date-time */
422
+ createdAt: string;
423
+ /** Format: int64 */
424
+ judgedDisputeCount: number;
425
+ /** Format: int64 */
426
+ licensesCount: number;
427
+ /** Format: int64 */
428
+ raisedDisputeCount: number;
429
+ /** Format: int64 */
430
+ resolvedDisputeCount: number;
431
+ /** Format: date-time */
432
+ updatedAt: string;
433
+ };
434
+ EnrichedIPAsset: {
435
+ /** Format: int64 */
436
+ ancestorsCount: number;
437
+ /** Format: int64 */
438
+ blockNumber: number;
439
+ chainId: string;
440
+ /** Format: int64 */
441
+ childrenCount: number;
442
+ /** Format: date-time */
443
+ createdAt: string;
444
+ /** Format: int64 */
445
+ descendantsCount: number;
446
+ description: string;
447
+ infringementStatus?: components["schemas"]["InfringementStatus"][] | null;
448
+ ipId: string;
449
+ ipaMetadataUri?: string;
450
+ isInGroup: boolean;
451
+ /** Format: date-time */
452
+ lastUpdatedAt: string;
453
+ licenses?: components["schemas"]["License"][] | null;
454
+ /** Format: int64 */
455
+ logIndex: number;
456
+ moderationStatus?: components["schemas"]["ModerationStatus"];
457
+ name: string;
458
+ nftMetadata?: components["schemas"]["NFTMetadata"];
459
+ ownerAddress: string;
460
+ /** Format: int64 */
461
+ parentsCount: number;
462
+ registrationDate: string;
463
+ rootIPs: string[] | null;
464
+ title: string;
465
+ tokenContract: string;
466
+ tokenId: string;
467
+ txHash: string;
468
+ uri: string;
469
+ };
470
+ ErrorDetail: {
471
+ /** @description Where the error occurred, e.g. 'body.items[3].tags' or 'path.thing-id' */
472
+ location?: string;
473
+ /** @description Error message text */
474
+ message?: string;
475
+ /** @description The value at the given location */
476
+ value?: unknown;
477
+ };
478
+ ErrorModel: {
479
+ /**
480
+ * Format: uri
481
+ * @description A URL to the JSON Schema for this object.
482
+ */
483
+ readonly $schema?: string;
484
+ /** @description A human-readable explanation specific to this occurrence of the problem. */
485
+ detail?: string;
486
+ /** @description Optional list of individual error details */
487
+ errors?: components["schemas"]["ErrorDetail"][] | null;
488
+ /**
489
+ * Format: uri
490
+ * @description A URI reference that identifies the specific occurrence of the problem.
491
+ */
492
+ instance?: string;
493
+ /**
494
+ * Format: int64
495
+ * @description HTTP status code
496
+ */
497
+ status?: number;
498
+ /** @description A short, human-readable summary of the problem type. This value should not change between occurrences of the error. */
499
+ title?: string;
500
+ /**
501
+ * Format: uri
502
+ * @description A URI reference to human-readable documentation for the error.
503
+ * @default about:blank
504
+ */
505
+ type: string;
506
+ };
507
+ GetDisputeResponseHumaBody: {
508
+ /**
509
+ * Format: uri
510
+ * @description A URL to the JSON Schema for this object.
511
+ */
512
+ readonly $schema?: string;
513
+ /** @description Dispute information */
514
+ data: components["schemas"]["Dispute"];
515
+ };
516
+ IPAssetsRequestBodyHuma: {
517
+ /**
518
+ * Format: uri
519
+ * @description A URL to the JSON Schema for this object.
520
+ */
521
+ readonly $schema?: string;
522
+ /** @description Include license information in response */
523
+ includeLicenses?: boolean;
524
+ /** @description Filter for moderated content only */
525
+ moderated?: boolean;
526
+ /**
527
+ * @description Field to order results by
528
+ * @default blockNumber
529
+ * @enum {string}
530
+ */
531
+ orderBy: "descendantCount" | "blockNumber" | "createdAt";
532
+ /**
533
+ * @description Order direction for results
534
+ * @default desc
535
+ * @enum {string}
536
+ */
537
+ orderDirection: "asc" | "desc";
538
+ /** @description Pagination configuration */
539
+ pagination?: components["schemas"]["PaginationOptionsHuma"];
540
+ /** @description Optional filter options for IP assets */
541
+ where?: components["schemas"]["IPAssetsWhereOptionsHuma"];
542
+ };
543
+ IPAssetsResponseHumaBody: {
544
+ /**
545
+ * Format: uri
546
+ * @description A URL to the JSON Schema for this object.
547
+ */
548
+ readonly $schema?: string;
549
+ /** @description List of enriched IP assets */
550
+ data: components["schemas"]["EnrichedIPAsset"][] | null;
551
+ /** @description Pagination metadata */
552
+ pagination?: components["schemas"]["PaginationMetadataHuma"];
553
+ };
554
+ IPAssetsWhereOptionsHuma: {
555
+ /** @description List of IP asset IDs to filter by (max 200) */
556
+ ipIds?: string[] | null;
557
+ /** @description Owner wallet address to filter by */
558
+ ownerAddress?: string;
559
+ /** @description Token contract address to filter by */
560
+ tokenContract?: string;
561
+ };
562
+ IPSearchResult: {
563
+ description: string;
564
+ ipId: string;
565
+ mediaType: string;
566
+ /** Format: double */
567
+ score: number;
568
+ /** Format: double */
569
+ similarity: number;
570
+ title: string;
571
+ };
572
+ IPTransaction: {
573
+ /** Format: int64 */
574
+ blockNumber: number;
575
+ /** Format: date-time */
576
+ createdAt: string;
577
+ eventType: string;
578
+ /** Format: int64 */
579
+ id: number;
580
+ initiator: string;
581
+ ipId: string;
582
+ /** Format: int64 */
583
+ logIndex: number;
584
+ txHash: string;
585
+ };
586
+ InfringementStatus: {
587
+ /** Format: date-time */
588
+ createdAt: string;
589
+ customData: string;
590
+ infringementDetails: string;
591
+ isInfringing: boolean;
592
+ providerName: string;
593
+ providerURL: string;
594
+ /** Format: date-time */
595
+ responseTime: string;
596
+ status: string;
597
+ /** Format: date-time */
598
+ updatedAt: string;
599
+ };
600
+ License: {
601
+ /** Format: date-time */
602
+ createdAt: string;
603
+ licenseTemplateId: string;
604
+ licenseTermsId: string;
605
+ licensingConfig: components["schemas"]["LicensingConfig"];
606
+ templateMetadataUri: string;
607
+ templateName: string;
608
+ terms: components["schemas"]["LicenseTerms"];
609
+ /** Format: date-time */
610
+ updatedAt: string;
611
+ };
612
+ LicenseTerms: {
613
+ commercialAttribution: boolean;
614
+ commercialRevCeiling: string;
615
+ /** Format: int64 */
616
+ commercialRevShare: number;
617
+ commercialUse: boolean;
618
+ commercializerChecker: string;
619
+ commercializerCheckerData: string;
620
+ currency: string;
621
+ defaultMintingFee: string;
622
+ derivativeRevCeiling: string;
623
+ derivativesAllowed: boolean;
624
+ derivativesApproval: boolean;
625
+ derivativesAttribution: boolean;
626
+ derivativesReciprocal: boolean;
627
+ expiration: string;
628
+ royaltyPolicy: string;
629
+ transferable: boolean;
630
+ uri: string;
631
+ };
632
+ LicensingConfig: {
633
+ /** Format: int64 */
634
+ commercialRevShare: number;
635
+ disabled: boolean;
636
+ expectGroupRewardPool: string;
637
+ /** Format: int64 */
638
+ expectMinimumGroupRewardShare: number;
639
+ hookData: string;
640
+ isSet: boolean;
641
+ licensingHook: string;
642
+ /** Format: int64 */
643
+ mintingFee: number;
644
+ };
645
+ ListDisputesResponseHumaBody: {
646
+ /**
647
+ * Format: uri
648
+ * @description A URL to the JSON Schema for this object.
649
+ */
650
+ readonly $schema?: string;
651
+ /** @description List of disputes */
652
+ data: components["schemas"]["Dispute"][] | null;
653
+ /** @description Pagination metadata (v4 enhancement, not in v3) */
654
+ pagination?: components["schemas"]["DisputePaginationMetadataHuma"];
655
+ };
656
+ ModerationStatus: {
657
+ adult: string;
658
+ medical: string;
659
+ racy: string;
660
+ spoof: string;
661
+ violence: string;
662
+ };
663
+ NFTMetadata: {
664
+ animation: components["schemas"]["NFTMetadataAnimationStruct"];
665
+ collection: components["schemas"]["NFTMetadataCollectionStruct"];
666
+ contract: components["schemas"]["ContractMetadata"];
667
+ contract_address: string;
668
+ description: string | null;
669
+ image: components["schemas"]["NFTMetadataImageStruct"];
670
+ mint: components["schemas"]["NFTMetadataMintStruct"];
671
+ name: string;
672
+ nft_id: string;
673
+ raw: unknown;
674
+ /** Format: date-time */
675
+ timeLastUpdated: string;
676
+ tokenId: string;
677
+ tokenType: string;
678
+ tokenUri: string;
679
+ };
680
+ NFTMetadataAnimationStruct: {
681
+ cachedUrl: string;
682
+ contentType: string;
683
+ originalUrl: string;
684
+ /** Format: int64 */
685
+ size: number;
686
+ };
687
+ NFTMetadataCollectionStruct: {
688
+ bannerImageUrl: string;
689
+ externalUrl: string | null;
690
+ name: string;
691
+ slug: string;
692
+ };
693
+ NFTMetadataImageStruct: {
694
+ cachedUrl: string;
695
+ contentType: string;
696
+ originalUrl: string;
697
+ pngUrl: string;
698
+ /** Format: int64 */
699
+ size: number;
700
+ thumbnailUrl: string;
701
+ };
702
+ NFTMetadataMintStruct: {
703
+ /** Format: int64 */
704
+ blockNumber: number | null;
705
+ mintAddress: string | null;
706
+ timestamp: string | null;
707
+ transactionHash: string | null;
708
+ };
709
+ PaginationMetadataHuma: {
710
+ /** @description Whether there are more items */
711
+ hasMore: boolean;
712
+ /**
713
+ * Format: int64
714
+ * @description Current limit
715
+ */
716
+ limit: number;
717
+ /**
718
+ * Format: int64
719
+ * @description Current offset
720
+ */
721
+ offset: number;
722
+ /**
723
+ * Format: int64
724
+ * @description Total count of items
725
+ */
726
+ total?: number;
727
+ };
728
+ PaginationOptionsHuma: {
729
+ /**
730
+ * Format: int64
731
+ * @description Number of items to return
732
+ * @default 20
733
+ */
734
+ limit: number;
735
+ /**
736
+ * Format: int64
737
+ * @description Number of items to skip
738
+ * @default 0
739
+ */
740
+ offset: number;
741
+ };
742
+ SearchRequestBodyHuma: {
743
+ /**
744
+ * Format: uri
745
+ * @description A URL to the JSON Schema for this object.
746
+ */
747
+ readonly $schema?: string;
748
+ /**
749
+ * @description Optional media type filter - must be 'audio', 'video', or 'image'. Leave empty to search all media types
750
+ * @enum {string}
751
+ */
752
+ mediaType?: "audio" | "video" | "image";
753
+ /** @description Pagination configuration */
754
+ pagination?: components["schemas"]["PaginationOptionsHuma"];
755
+ /** @description The search query string */
756
+ query: string;
757
+ };
758
+ SearchResponseBodyHuma: {
759
+ /**
760
+ * Format: uri
761
+ * @description A URL to the JSON Schema for this object.
762
+ */
763
+ readonly $schema?: string;
764
+ /** @description List of IP asset search results */
765
+ data: components["schemas"]["IPSearchResult"][] | null;
766
+ /** @description Pagination information */
767
+ pagination?: components["schemas"]["PaginationMetadataHuma"];
768
+ /**
769
+ * Format: int64
770
+ * @description Total number of search results found
771
+ */
772
+ total: number;
773
+ };
774
+ TransactionsRequestBodyHuma: {
775
+ /**
776
+ * Format: uri
777
+ * @description A URL to the JSON Schema for this object.
778
+ */
779
+ readonly $schema?: string;
780
+ /**
781
+ * @description Field to order results by
782
+ * @default blockNumber
783
+ * @enum {string}
784
+ */
785
+ orderBy: "blockNumber" | "createdAt" | "eventType" | "txHash" | "ipId" | "initiator";
786
+ /**
787
+ * @description Order direction for results
788
+ * @default desc
789
+ * @enum {string}
790
+ */
791
+ orderDirection: "asc" | "desc";
792
+ /** @description Pagination configuration */
793
+ pagination?: components["schemas"]["PaginationOptionsHuma"];
794
+ /** @description Optional filter options for transactions */
795
+ where?: components["schemas"]["TransactionsWhereOptionsHuma"];
796
+ };
797
+ TransactionsResponseBodyHuma: {
798
+ /**
799
+ * Format: uri
800
+ * @description A URL to the JSON Schema for this object.
801
+ */
802
+ readonly $schema?: string;
803
+ /** @description List of IP transactions */
804
+ data: components["schemas"]["IPTransaction"][] | null;
805
+ /** @description Pagination information */
806
+ pagination?: components["schemas"]["PaginationMetadataHuma"];
807
+ };
808
+ TransactionsWhereOptionsHuma: {
809
+ /**
810
+ * Format: int64
811
+ * @description Filter transactions from this block number (inclusive)
812
+ */
813
+ blockGte?: number;
814
+ /**
815
+ * Format: int64
816
+ * @description Filter transactions up to this block number (inclusive)
817
+ */
818
+ blockLte?: number;
819
+ /** @description List of event types to filter by (max 50) */
820
+ eventTypes?: string[] | null;
821
+ /** @description List of initiator addresses to filter by (max 200) */
822
+ initiators?: string[] | null;
823
+ /** @description List of IP asset IDs to filter by (max 200) */
824
+ ipIds?: string[] | null;
825
+ /** @description List of transaction hashes to filter by (max 200) */
826
+ txHashes?: string[] | null;
827
+ };
828
+ };
829
+ responses: never;
830
+ parameters: never;
831
+ requestBodies: never;
832
+ headers: never;
833
+ pathItems: never;
834
+ }
835
+ interface operations {
836
+ listIPAssetsV4: {
837
+ parameters: {
838
+ query?: never;
839
+ header?: never;
840
+ path?: never;
841
+ cookie?: never;
842
+ };
843
+ requestBody: {
844
+ content: {
845
+ "application/json": components["schemas"]["IPAssetsRequestBodyHuma"];
846
+ };
847
+ };
848
+ responses: {
849
+ /** @description OK */
850
+ 200: {
851
+ headers: {
852
+ [name: string]: unknown;
853
+ };
854
+ content: {
855
+ "application/json": components["schemas"]["IPAssetsResponseHumaBody"];
856
+ };
857
+ };
858
+ /** @description Error */
859
+ default: {
860
+ headers: {
861
+ [name: string]: unknown;
862
+ };
863
+ content: {
864
+ "application/problem+json": components["schemas"]["ErrorModel"];
865
+ };
866
+ };
867
+ };
868
+ };
869
+ listEdgesV4: {
870
+ parameters: {
871
+ query?: never;
872
+ header?: never;
873
+ path?: never;
874
+ cookie?: never;
875
+ };
876
+ requestBody: {
877
+ content: {
878
+ "application/json": components["schemas"]["EdgesRequestBodyHuma"];
879
+ };
880
+ };
881
+ responses: {
882
+ /** @description OK */
883
+ 200: {
884
+ headers: {
885
+ [name: string]: unknown;
886
+ };
887
+ content: {
888
+ "application/json": components["schemas"]["EdgesResponseHumaBody"];
889
+ };
890
+ };
891
+ /** @description Error */
892
+ default: {
893
+ headers: {
894
+ [name: string]: unknown;
895
+ };
896
+ content: {
897
+ "application/problem+json": components["schemas"]["ErrorModel"];
898
+ };
899
+ };
900
+ };
901
+ };
902
+ listCollectionsV4: {
903
+ parameters: {
904
+ query?: never;
905
+ header?: never;
906
+ path?: never;
907
+ cookie?: never;
908
+ };
909
+ requestBody: {
910
+ content: {
911
+ "application/json": components["schemas"]["CollectionsRequestBodyHuma"];
912
+ };
913
+ };
914
+ responses: {
915
+ /** @description OK */
916
+ 200: {
917
+ headers: {
918
+ [name: string]: unknown;
919
+ };
920
+ content: {
921
+ "application/json": components["schemas"]["CollectionsResponseBodyHuma"];
922
+ };
923
+ };
924
+ /** @description Error */
925
+ default: {
926
+ headers: {
927
+ [name: string]: unknown;
928
+ };
929
+ content: {
930
+ "application/problem+json": components["schemas"]["ErrorModel"];
931
+ };
932
+ };
933
+ };
934
+ };
935
+ listDisputesV4: {
936
+ parameters: {
937
+ query?: never;
938
+ header?: never;
939
+ path?: never;
940
+ cookie?: never;
941
+ };
942
+ requestBody: {
943
+ content: {
944
+ "application/json": components["schemas"]["DisputesRequestBodyHuma"];
945
+ };
946
+ };
947
+ responses: {
948
+ /** @description OK */
949
+ 200: {
950
+ headers: {
951
+ [name: string]: unknown;
952
+ };
953
+ content: {
954
+ "application/json": components["schemas"]["ListDisputesResponseHumaBody"];
955
+ };
956
+ };
957
+ /** @description Error */
958
+ default: {
959
+ headers: {
960
+ [name: string]: unknown;
961
+ };
962
+ content: {
963
+ "application/problem+json": components["schemas"]["ErrorModel"];
964
+ };
965
+ };
966
+ };
967
+ };
968
+ getDisputeV4: {
969
+ parameters: {
970
+ query?: never;
971
+ header?: never;
972
+ path: {
973
+ /**
974
+ * @description Dispute ID to retrieve
975
+ * @example 123
976
+ */
977
+ disputeId: string;
978
+ };
979
+ cookie?: never;
980
+ };
981
+ requestBody?: never;
982
+ responses: {
983
+ /** @description OK */
984
+ 200: {
985
+ headers: {
986
+ [name: string]: unknown;
987
+ };
988
+ content: {
989
+ "application/json": components["schemas"]["GetDisputeResponseHumaBody"];
990
+ };
991
+ };
992
+ /** @description Error */
993
+ default: {
994
+ headers: {
995
+ [name: string]: unknown;
996
+ };
997
+ content: {
998
+ "application/problem+json": components["schemas"]["ErrorModel"];
999
+ };
1000
+ };
1001
+ };
1002
+ };
1003
+ searchV4: {
1004
+ parameters: {
1005
+ query?: never;
1006
+ header?: never;
1007
+ path?: never;
1008
+ cookie?: never;
1009
+ };
1010
+ requestBody: {
1011
+ content: {
1012
+ "application/json": components["schemas"]["SearchRequestBodyHuma"];
1013
+ };
1014
+ };
1015
+ responses: {
1016
+ /** @description OK */
1017
+ 200: {
1018
+ headers: {
1019
+ [name: string]: unknown;
1020
+ };
1021
+ content: {
1022
+ "application/json": components["schemas"]["SearchResponseBodyHuma"];
1023
+ };
1024
+ };
1025
+ /** @description Error */
1026
+ default: {
1027
+ headers: {
1028
+ [name: string]: unknown;
1029
+ };
1030
+ content: {
1031
+ "application/problem+json": components["schemas"]["ErrorModel"];
1032
+ };
1033
+ };
1034
+ };
1035
+ };
1036
+ listTransactionsV4: {
1037
+ parameters: {
1038
+ query?: never;
1039
+ header?: never;
1040
+ path?: never;
1041
+ cookie?: never;
1042
+ };
1043
+ requestBody: {
1044
+ content: {
1045
+ "application/json": components["schemas"]["TransactionsRequestBodyHuma"];
1046
+ };
1047
+ };
1048
+ responses: {
1049
+ /** @description OK */
1050
+ 200: {
1051
+ headers: {
1052
+ [name: string]: unknown;
1053
+ };
1054
+ content: {
1055
+ "application/json": components["schemas"]["TransactionsResponseBodyHuma"];
1056
+ };
1057
+ };
1058
+ /** @description Error */
1059
+ default: {
1060
+ headers: {
1061
+ [name: string]: unknown;
1062
+ };
1063
+ content: {
1064
+ "application/problem+json": components["schemas"]["ErrorModel"];
1065
+ };
1066
+ };
1067
+ };
1068
+ };
1069
+ }
1070
+
1071
+ type ApiClient = Client<paths>;
1072
+ declare const createApiClient: (baseUrl: string) => Client<paths>;
1073
+ declare const stagingClient: Client<paths, `${string}/${string}`>;
1074
+ declare const prodClient: Client<paths, `${string}/${string}`>;
1075
+
1076
+ declare const STORY_AENEID: ChainConfig;
1077
+ declare const STORY_MAINNET: ChainConfig;
1078
+ declare const CHAINS: {
1079
+ [x: string]: ChainConfig;
1080
+ };
1081
+ declare const CHAINID_TO_CHAINNAME: {
1082
+ [key: number]: string;
1083
+ };
1084
+
1085
+ type ERC20Token = {
1086
+ name: string;
1087
+ address: Address;
1088
+ symbol: string;
1089
+ decimals?: number;
1090
+ };
1091
+ type ChainConfig = {
1092
+ id: number;
1093
+ name: string;
1094
+ displayName: string;
1095
+ rpcUrl: string;
1096
+ blockExplorerUrl: string;
1097
+ protocolExplorerUrl: string;
1098
+ apiVersion: string;
1099
+ defaultCurrency?: ERC20Token;
1100
+ };
1101
+ type SupportedChainConfig = typeof STORY_AENEID | typeof STORY_MAINNET;
1102
+ declare enum IPKIT_SUPPORTED_CHAIN {
1103
+ AENEID_TESTNET = "story-aeneid",
1104
+ STORY_MAINNET = "story"
1105
+ }
1106
+ declare const WRAPPED_IP: ERC20Token;
1107
+
1108
+ type Mode = "light" | "dark" | undefined;
1109
+ type Theme = "default" | "story" | string;
1110
+ interface IpKitProviderOptions {
1111
+ apiKey: string;
1112
+ appId?: string;
1113
+ children: React.ReactNode;
1114
+ isTestnet?: boolean;
1115
+ mode?: Mode;
1116
+ theme?: Theme;
1117
+ }
1118
+ declare const IpKitProvider: ({ apiKey, appId, children, isTestnet, mode, theme, }: IpKitProviderOptions) => React.JSX.Element;
1119
+ declare const useIpKit: () => {
1120
+ apiBaseUrl: string;
1121
+ apiClient: ApiClient;
1122
+ apiKey: string;
1123
+ appId: string | undefined;
1124
+ chain: ChainConfig;
1125
+ mode: Mode;
1126
+ theme: Theme;
1127
+ themeClass: string;
1128
+ };
1129
+
1130
+ type QueryKey = ReadonlyArray<unknown>;
1131
+ interface QueryObserverOptions<TQueryFnData = unknown, TError = Error, // eslint-disable-line @typescript-eslint/no-unused-vars
1132
+ TData = TQueryFnData, // eslint-disable-line @typescript-eslint/no-unused-vars
1133
+ TQueryData = TQueryFnData, // eslint-disable-line @typescript-eslint/no-unused-vars
1134
+ TQueryKey extends QueryKey = QueryKey, TPageParam = never> {
1135
+ queryKey?: TQueryKey;
1136
+ queryFn?: TQueryFnData;
1137
+ enabled?: boolean;
1138
+ refetchInterval?: number;
1139
+ }
1140
+
1141
+ type IpQueryOptions = Partial<QueryObserverOptions<any, any, any, any>>;
1142
+ type IPAsset = components["schemas"]["EnrichedIPAsset"];
1143
+ type IPAssetEdge = components["schemas"]["DerivativeRegisteredEvent"];
1144
+ type IPTransaction = components["schemas"]["IPTransaction"];
1145
+ type IPSearchResult = components["schemas"]["IPSearchResult"];
1146
+ type Collection = components["schemas"]["EnrichedCollection"];
1147
+ type CollectionMetadata = components["schemas"]["ContractMetadataByAddressResponse"];
1148
+ type License = components["schemas"]["License"];
1149
+ type LicenseTerms$1 = components["schemas"]["LicenseTerms"];
1150
+ type LicensingConfig = components["schemas"]["LicensingConfig"];
1151
+ type NFTMetadata = components["schemas"]["NFTMetadata"];
1152
+ type InfringementStatus = components["schemas"]["InfringementStatus"];
1153
+ type ModerationStatus = components["schemas"]["ModerationStatus"];
1154
+ type ContractMetadata = components["schemas"]["ContractMetadata"];
1155
+ type Dispute = components["schemas"]["Dispute"];
1156
+ type PILTerms = LicenseTerms$1;
1157
+ type TransactionEventType = "IPRegistered" | "LicenseTermsAttached" | "DerivativeRegistered" | "DisputeRaised" | "DisputeResolved" | "DisputeCancelled" | "DisputeJudgementSet" | "RoyaltyPaid";
1158
+
1159
+ declare enum PIL_FLAVOR {
1160
+ NON_COMMERCIAL_SOCIAL_REMIXING = "Non-Commercial Social Remixing",
1161
+ COMMERCIAL_USE = "Commercial Use",
1162
+ COMMERCIAL_REMIX = "Commercial Remix",
1163
+ CUSTOM = "Custom",
1164
+ OPEN_USE = "Open Use"
1165
+ }
1166
+ type PilFlavor = PIL_FLAVOR.NON_COMMERCIAL_SOCIAL_REMIXING | PIL_FLAVOR.COMMERCIAL_USE | PIL_FLAVOR.COMMERCIAL_REMIX | PIL_FLAVOR.CUSTOM | PIL_FLAVOR.OPEN_USE;
1167
+ interface Trait {
1168
+ trait_type: string;
1169
+ value: string | number;
1170
+ max_value?: number;
1171
+ }
1172
+ interface LicenseOffChainData {
1173
+ aiLearningModels?: boolean;
1174
+ }
1175
+ interface PILTermsWithOffChainData extends PILTerms {
1176
+ offChainData: LicenseOffChainData | undefined;
1177
+ }
1178
+ interface LicenseWithOffChainData extends Omit<License, "terms"> {
1179
+ terms: PILTermsWithOffChainData;
1180
+ }
1181
+ interface LicenseTermsWithOffChainData extends LicenseWithOffChainData {
1182
+ }
1183
+ type SocialMedia = {
1184
+ platform?: string;
1185
+ url?: string;
1186
+ };
1187
+ type Creator = {
1188
+ name?: string;
1189
+ address?: Address;
1190
+ description?: string;
1191
+ contributionPercent?: number;
1192
+ socialMedia?: SocialMedia[];
1193
+ };
1194
+ interface IPMetadata {
1195
+ title?: string;
1196
+ description?: string;
1197
+ ipType?: string;
1198
+ creators?: Creator[];
1199
+ appInfo?: {
1200
+ id?: string;
1201
+ name?: string;
1202
+ website?: string;
1203
+ }[];
1204
+ relationships?: {
1205
+ parentIpId?: Address;
1206
+ type?: string;
1207
+ }[];
1208
+ robotTerms?: {
1209
+ userAgent?: string;
1210
+ allow?: string;
1211
+ };
1212
+ [key: string]: any;
1213
+ }
1214
+
1215
+ declare function cn(...inputs: ClassValue[]): string;
1216
+ declare function shortenAddress(address: string, length?: number): string;
1217
+ declare function camelize(str: string): string;
1218
+ declare function getPilFlavorByLicenseTerms(pilTerms: PILTerms): PilFlavor;
1219
+ declare function getImageUrlFromIpfsUrl(ipfsUrl: string): Promise<string>;
1220
+ declare function convertIpfsUriToUrl(ipfsUri: string): string;
1221
+ declare function getMetadataFromIpfs(ipfsUrl: string): Promise<any>;
1222
+ declare function fetchLicenseOffChainData(uri: string): Promise<any>;
1223
+
1224
+ type LicenseTerms = Partial<PILTerms>;
1225
+ declare function convertLicenseTermObject(licenseTerms: Trait[]): LicenseTerms;
1226
+
1227
+ type CollectionsResponse = paths["/collections"]["post"]["responses"][200]["content"]["application/json"];
1228
+ type CollectionsOptions = Partial<paths["/collections"]["post"]["requestBody"]["content"]["application/json"]>;
1229
+ type GetCollectionsOptions = {
1230
+ apiClient: ApiClient;
1231
+ collectionAddresses?: Address[];
1232
+ options?: CollectionsOptions;
1233
+ apiKey: string;
1234
+ };
1235
+ declare function getCollections({ collectionAddresses, apiClient, options, apiKey }: GetCollectionsOptions): Promise<openapi_fetch.FetchResponse<{
1236
+ parameters: {
1237
+ query?: undefined;
1238
+ header?: undefined;
1239
+ path?: undefined;
1240
+ cookie?: undefined;
1241
+ };
1242
+ requestBody: {
1243
+ content: {
1244
+ "application/json": {
1245
+ readonly $schema?: string | undefined;
1246
+ orderBy: "updatedAt";
1247
+ orderDirection: "asc" | "desc";
1248
+ pagination?: {
1249
+ limit: number;
1250
+ offset: number;
1251
+ } | undefined;
1252
+ where?: {
1253
+ collectionAddresses?: string[] | null | undefined;
1254
+ maxAssetCount?: number | undefined;
1255
+ minAssetCount?: number | undefined;
1256
+ } | undefined;
1257
+ };
1258
+ };
1259
+ };
1260
+ responses: {
1261
+ 200: {
1262
+ headers: {
1263
+ [name: string]: unknown;
1264
+ };
1265
+ content: {
1266
+ "application/json": {
1267
+ readonly $schema?: string | undefined;
1268
+ data: {
1269
+ assetCount: number;
1270
+ cancelledDisputeCount: number;
1271
+ collectionAddress: string;
1272
+ collectionMetadata?: {
1273
+ address: string;
1274
+ chain: string;
1275
+ contractDeployer: string;
1276
+ deployedBlockNumber: number;
1277
+ name: string;
1278
+ openSeaMetadata: {
1279
+ bannerImageUrl: string;
1280
+ collectionName: string;
1281
+ collectionSlug: string;
1282
+ description: string;
1283
+ discordUrl: string;
1284
+ externalUrl: string | null;
1285
+ floorPrice: number;
1286
+ imageUrl: string;
1287
+ lastIngestedAt: string;
1288
+ safelistRequestStatus: string;
1289
+ twitterUsername: string;
1290
+ };
1291
+ symbol: string;
1292
+ tokenType: string;
1293
+ totalSupply: string;
1294
+ } | undefined;
1295
+ createdAt: string;
1296
+ judgedDisputeCount: number;
1297
+ licensesCount: number;
1298
+ raisedDisputeCount: number;
1299
+ resolvedDisputeCount: number;
1300
+ updatedAt: string;
1301
+ }[] | null;
1302
+ pagination?: {
1303
+ hasMore: boolean;
1304
+ limit: number;
1305
+ offset: number;
1306
+ total?: number | undefined;
1307
+ } | undefined;
1308
+ };
1309
+ };
1310
+ };
1311
+ default: {
1312
+ headers: {
1313
+ [name: string]: unknown;
1314
+ };
1315
+ content: {
1316
+ "application/problem+json": {
1317
+ readonly $schema?: string | undefined;
1318
+ detail?: string | undefined;
1319
+ errors?: {
1320
+ location?: string | undefined;
1321
+ message?: string | undefined;
1322
+ value?: unknown;
1323
+ }[] | null | undefined;
1324
+ instance?: string | undefined;
1325
+ status?: number | undefined;
1326
+ title?: string | undefined;
1327
+ type: string;
1328
+ };
1329
+ };
1330
+ };
1331
+ };
1332
+ }, {
1333
+ params?: {
1334
+ query?: undefined;
1335
+ header?: undefined;
1336
+ path?: undefined;
1337
+ cookie?: undefined;
1338
+ } | undefined;
1339
+ } & {
1340
+ body: {
1341
+ readonly $schema?: string | undefined;
1342
+ orderBy: "updatedAt";
1343
+ orderDirection: "asc" | "desc";
1344
+ pagination?: {
1345
+ limit: number;
1346
+ offset: number;
1347
+ } | undefined;
1348
+ where?: {
1349
+ collectionAddresses?: string[] | null | undefined;
1350
+ maxAssetCount?: number | undefined;
1351
+ minAssetCount?: number | undefined;
1352
+ } | undefined;
1353
+ };
1354
+ } & {
1355
+ baseUrl?: string | undefined;
1356
+ querySerializer?: openapi_fetch.QuerySerializerOptions | openapi_fetch.QuerySerializer<{
1357
+ parameters: {
1358
+ query?: undefined;
1359
+ header?: undefined;
1360
+ path?: undefined;
1361
+ cookie?: undefined;
1362
+ };
1363
+ requestBody: {
1364
+ content: {
1365
+ "application/json": {
1366
+ readonly $schema?: string | undefined;
1367
+ orderBy: "updatedAt";
1368
+ orderDirection: "asc" | "desc";
1369
+ pagination?: {
1370
+ limit: number;
1371
+ offset: number;
1372
+ } | undefined;
1373
+ where?: {
1374
+ collectionAddresses?: string[] | null | undefined;
1375
+ maxAssetCount?: number | undefined;
1376
+ minAssetCount?: number | undefined;
1377
+ } | undefined;
1378
+ };
1379
+ };
1380
+ };
1381
+ responses: {
1382
+ 200: {
1383
+ headers: {
1384
+ [name: string]: unknown;
1385
+ };
1386
+ content: {
1387
+ "application/json": {
1388
+ readonly $schema?: string | undefined;
1389
+ data: {
1390
+ assetCount: number;
1391
+ cancelledDisputeCount: number;
1392
+ collectionAddress: string;
1393
+ collectionMetadata?: {
1394
+ address: string;
1395
+ chain: string;
1396
+ contractDeployer: string;
1397
+ deployedBlockNumber: number;
1398
+ name: string;
1399
+ openSeaMetadata: {
1400
+ bannerImageUrl: string;
1401
+ collectionName: string;
1402
+ collectionSlug: string;
1403
+ description: string;
1404
+ discordUrl: string;
1405
+ externalUrl: string | null;
1406
+ floorPrice: number;
1407
+ imageUrl: string;
1408
+ lastIngestedAt: string;
1409
+ safelistRequestStatus: string;
1410
+ twitterUsername: string;
1411
+ };
1412
+ symbol: string;
1413
+ tokenType: string;
1414
+ totalSupply: string;
1415
+ } | undefined;
1416
+ createdAt: string;
1417
+ judgedDisputeCount: number;
1418
+ licensesCount: number;
1419
+ raisedDisputeCount: number;
1420
+ resolvedDisputeCount: number;
1421
+ updatedAt: string;
1422
+ }[] | null;
1423
+ pagination?: {
1424
+ hasMore: boolean;
1425
+ limit: number;
1426
+ offset: number;
1427
+ total?: number | undefined;
1428
+ } | undefined;
1429
+ };
1430
+ };
1431
+ };
1432
+ default: {
1433
+ headers: {
1434
+ [name: string]: unknown;
1435
+ };
1436
+ content: {
1437
+ "application/problem+json": {
1438
+ readonly $schema?: string | undefined;
1439
+ detail?: string | undefined;
1440
+ errors?: {
1441
+ location?: string | undefined;
1442
+ message?: string | undefined;
1443
+ value?: unknown;
1444
+ }[] | null | undefined;
1445
+ instance?: string | undefined;
1446
+ status?: number | undefined;
1447
+ title?: string | undefined;
1448
+ type: string;
1449
+ };
1450
+ };
1451
+ };
1452
+ };
1453
+ }> | undefined;
1454
+ bodySerializer?: openapi_fetch.BodySerializer<{
1455
+ parameters: {
1456
+ query?: undefined;
1457
+ header?: undefined;
1458
+ path?: undefined;
1459
+ cookie?: undefined;
1460
+ };
1461
+ requestBody: {
1462
+ content: {
1463
+ "application/json": {
1464
+ readonly $schema?: string | undefined;
1465
+ orderBy: "updatedAt";
1466
+ orderDirection: "asc" | "desc";
1467
+ pagination?: {
1468
+ limit: number;
1469
+ offset: number;
1470
+ } | undefined;
1471
+ where?: {
1472
+ collectionAddresses?: string[] | null | undefined;
1473
+ maxAssetCount?: number | undefined;
1474
+ minAssetCount?: number | undefined;
1475
+ } | undefined;
1476
+ };
1477
+ };
1478
+ };
1479
+ responses: {
1480
+ 200: {
1481
+ headers: {
1482
+ [name: string]: unknown;
1483
+ };
1484
+ content: {
1485
+ "application/json": {
1486
+ readonly $schema?: string | undefined;
1487
+ data: {
1488
+ assetCount: number;
1489
+ cancelledDisputeCount: number;
1490
+ collectionAddress: string;
1491
+ collectionMetadata?: {
1492
+ address: string;
1493
+ chain: string;
1494
+ contractDeployer: string;
1495
+ deployedBlockNumber: number;
1496
+ name: string;
1497
+ openSeaMetadata: {
1498
+ bannerImageUrl: string;
1499
+ collectionName: string;
1500
+ collectionSlug: string;
1501
+ description: string;
1502
+ discordUrl: string;
1503
+ externalUrl: string | null;
1504
+ floorPrice: number;
1505
+ imageUrl: string;
1506
+ lastIngestedAt: string;
1507
+ safelistRequestStatus: string;
1508
+ twitterUsername: string;
1509
+ };
1510
+ symbol: string;
1511
+ tokenType: string;
1512
+ totalSupply: string;
1513
+ } | undefined;
1514
+ createdAt: string;
1515
+ judgedDisputeCount: number;
1516
+ licensesCount: number;
1517
+ raisedDisputeCount: number;
1518
+ resolvedDisputeCount: number;
1519
+ updatedAt: string;
1520
+ }[] | null;
1521
+ pagination?: {
1522
+ hasMore: boolean;
1523
+ limit: number;
1524
+ offset: number;
1525
+ total?: number | undefined;
1526
+ } | undefined;
1527
+ };
1528
+ };
1529
+ };
1530
+ default: {
1531
+ headers: {
1532
+ [name: string]: unknown;
1533
+ };
1534
+ content: {
1535
+ "application/problem+json": {
1536
+ readonly $schema?: string | undefined;
1537
+ detail?: string | undefined;
1538
+ errors?: {
1539
+ location?: string | undefined;
1540
+ message?: string | undefined;
1541
+ value?: unknown;
1542
+ }[] | null | undefined;
1543
+ instance?: string | undefined;
1544
+ status?: number | undefined;
1545
+ title?: string | undefined;
1546
+ type: string;
1547
+ };
1548
+ };
1549
+ };
1550
+ };
1551
+ }> | undefined;
1552
+ parseAs?: keyof openapi_fetch.BodyType<unknown> | undefined;
1553
+ fetch?: ((input: Request) => Promise<Response>) | undefined;
1554
+ headers?: openapi_fetch.HeadersOptions | undefined;
1555
+ } & Omit<RequestInit, "headers" | "body"> & {
1556
+ readonly $schema?: string | undefined;
1557
+ orderBy: "updatedAt";
1558
+ orderDirection: "asc" | "desc";
1559
+ pagination?: {
1560
+ limit: number;
1561
+ offset: number;
1562
+ } | undefined;
1563
+ where?: {
1564
+ collectionAddresses?: string[] | null | undefined;
1565
+ maxAssetCount?: number | undefined;
1566
+ minAssetCount?: number | undefined;
1567
+ } | undefined;
1568
+ }, `${string}/${string}`>>;
1569
+
1570
+ type DisputeResponse = paths["/disputes/{disputeId}"]["get"]["responses"][200]["content"]["application/json"];
1571
+ type GetDisputeOptions = {
1572
+ apiClient: ApiClient;
1573
+ disputeId: string;
1574
+ apiKey: string;
1575
+ };
1576
+ declare function getDispute({ apiClient, disputeId, apiKey }: GetDisputeOptions): Promise<openapi_fetch.FetchResponse<{
1577
+ parameters: {
1578
+ query?: undefined;
1579
+ header?: undefined;
1580
+ path: {
1581
+ disputeId: string;
1582
+ };
1583
+ cookie?: undefined;
1584
+ };
1585
+ requestBody?: undefined;
1586
+ responses: {
1587
+ 200: {
1588
+ headers: {
1589
+ [name: string]: unknown;
1590
+ };
1591
+ content: {
1592
+ "application/json": {
1593
+ readonly $schema?: string | undefined;
1594
+ data: {
1595
+ arbitrationPolicy: string;
1596
+ blockNumber: string | null;
1597
+ blockTimestamp?: string | undefined;
1598
+ counterEvidenceHash: string;
1599
+ currentTag: string;
1600
+ data: string;
1601
+ deletedAt?: string | undefined;
1602
+ disputeTimestamp: string | null;
1603
+ evidenceHash: string;
1604
+ id: string | null;
1605
+ initiator: string;
1606
+ liveness: string | null;
1607
+ logIndex?: string | undefined;
1608
+ status: string;
1609
+ targetIpId: string;
1610
+ targetTag: string;
1611
+ transactionHash: string;
1612
+ umaLink?: string | undefined;
1613
+ };
1614
+ };
1615
+ };
1616
+ };
1617
+ default: {
1618
+ headers: {
1619
+ [name: string]: unknown;
1620
+ };
1621
+ content: {
1622
+ "application/problem+json": {
1623
+ readonly $schema?: string | undefined;
1624
+ detail?: string | undefined;
1625
+ errors?: {
1626
+ location?: string | undefined;
1627
+ message?: string | undefined;
1628
+ value?: unknown;
1629
+ }[] | null | undefined;
1630
+ instance?: string | undefined;
1631
+ status?: number | undefined;
1632
+ title?: string | undefined;
1633
+ type: string;
1634
+ };
1635
+ };
1636
+ };
1637
+ };
1638
+ }, openapi_fetch.FetchOptions<{
1639
+ parameters: {
1640
+ query?: undefined;
1641
+ header?: undefined;
1642
+ path: {
1643
+ disputeId: string;
1644
+ };
1645
+ cookie?: undefined;
1646
+ };
1647
+ requestBody?: undefined;
1648
+ responses: {
1649
+ 200: {
1650
+ headers: {
1651
+ [name: string]: unknown;
1652
+ };
1653
+ content: {
1654
+ "application/json": {
1655
+ readonly $schema?: string | undefined;
1656
+ data: {
1657
+ arbitrationPolicy: string;
1658
+ blockNumber: string | null;
1659
+ blockTimestamp?: string | undefined;
1660
+ counterEvidenceHash: string;
1661
+ currentTag: string;
1662
+ data: string;
1663
+ deletedAt?: string | undefined;
1664
+ disputeTimestamp: string | null;
1665
+ evidenceHash: string;
1666
+ id: string | null;
1667
+ initiator: string;
1668
+ liveness: string | null;
1669
+ logIndex?: string | undefined;
1670
+ status: string;
1671
+ targetIpId: string;
1672
+ targetTag: string;
1673
+ transactionHash: string;
1674
+ umaLink?: string | undefined;
1675
+ };
1676
+ };
1677
+ };
1678
+ };
1679
+ default: {
1680
+ headers: {
1681
+ [name: string]: unknown;
1682
+ };
1683
+ content: {
1684
+ "application/problem+json": {
1685
+ readonly $schema?: string | undefined;
1686
+ detail?: string | undefined;
1687
+ errors?: {
1688
+ location?: string | undefined;
1689
+ message?: string | undefined;
1690
+ value?: unknown;
1691
+ }[] | null | undefined;
1692
+ instance?: string | undefined;
1693
+ status?: number | undefined;
1694
+ title?: string | undefined;
1695
+ type: string;
1696
+ };
1697
+ };
1698
+ };
1699
+ };
1700
+ }>, `${string}/${string}`>>;
1701
+
1702
+ type DisputesResponse = paths["/disputes"]["post"]["responses"][200]["content"]["application/json"];
1703
+ type DisputesOptions = Partial<paths["/disputes"]["post"]["requestBody"]["content"]["application/json"]>;
1704
+ type GetDisputesOptions = {
1705
+ apiClient: ApiClient;
1706
+ options?: DisputesOptions;
1707
+ apiKey: string;
1708
+ initiator?: Address;
1709
+ targetIpId?: Address;
1710
+ };
1711
+ declare function getDisputes({ apiClient, initiator, targetIpId, options, apiKey }: GetDisputesOptions): Promise<openapi_fetch.FetchResponse<{
1712
+ parameters: {
1713
+ query?: undefined;
1714
+ header?: undefined;
1715
+ path?: undefined;
1716
+ cookie?: undefined;
1717
+ };
1718
+ requestBody: {
1719
+ content: {
1720
+ "application/json": {
1721
+ readonly $schema?: string | undefined;
1722
+ orderBy?: string | undefined;
1723
+ orderDirection?: string | undefined;
1724
+ pagination?: {
1725
+ limit: number;
1726
+ offset: number;
1727
+ } | undefined;
1728
+ where?: {
1729
+ blockNumber?: string | undefined;
1730
+ blockNumberGte?: string | undefined;
1731
+ blockNumberLte?: string | undefined;
1732
+ id?: string | undefined;
1733
+ initiator?: string | undefined;
1734
+ targetIpId?: string | undefined;
1735
+ } | undefined;
1736
+ };
1737
+ };
1738
+ };
1739
+ responses: {
1740
+ 200: {
1741
+ headers: {
1742
+ [name: string]: unknown;
1743
+ };
1744
+ content: {
1745
+ "application/json": {
1746
+ readonly $schema?: string | undefined;
1747
+ data: {
1748
+ arbitrationPolicy: string;
1749
+ blockNumber: string | null;
1750
+ blockTimestamp?: string | undefined;
1751
+ counterEvidenceHash: string;
1752
+ currentTag: string;
1753
+ data: string;
1754
+ deletedAt?: string | undefined;
1755
+ disputeTimestamp: string | null;
1756
+ evidenceHash: string;
1757
+ id: string | null;
1758
+ initiator: string;
1759
+ liveness: string | null;
1760
+ logIndex?: string | undefined;
1761
+ status: string;
1762
+ targetIpId: string;
1763
+ targetTag: string;
1764
+ transactionHash: string;
1765
+ umaLink?: string | undefined;
1766
+ }[] | null;
1767
+ pagination?: {
1768
+ hasMore: boolean;
1769
+ limit: number;
1770
+ offset: number;
1771
+ total?: number | undefined;
1772
+ } | undefined;
1773
+ };
1774
+ };
1775
+ };
1776
+ default: {
1777
+ headers: {
1778
+ [name: string]: unknown;
1779
+ };
1780
+ content: {
1781
+ "application/problem+json": {
1782
+ readonly $schema?: string | undefined;
1783
+ detail?: string | undefined;
1784
+ errors?: {
1785
+ location?: string | undefined;
1786
+ message?: string | undefined;
1787
+ value?: unknown;
1788
+ }[] | null | undefined;
1789
+ instance?: string | undefined;
1790
+ status?: number | undefined;
1791
+ title?: string | undefined;
1792
+ type: string;
1793
+ };
1794
+ };
1795
+ };
1796
+ };
1797
+ }, {
1798
+ params?: {
1799
+ query?: undefined;
1800
+ header?: undefined;
1801
+ path?: undefined;
1802
+ cookie?: undefined;
1803
+ } | undefined;
1804
+ } & {
1805
+ body: {
1806
+ readonly $schema?: string | undefined;
1807
+ orderBy?: string | undefined;
1808
+ orderDirection?: string | undefined;
1809
+ pagination?: {
1810
+ limit: number;
1811
+ offset: number;
1812
+ } | undefined;
1813
+ where?: {
1814
+ blockNumber?: string | undefined;
1815
+ blockNumberGte?: string | undefined;
1816
+ blockNumberLte?: string | undefined;
1817
+ id?: string | undefined;
1818
+ initiator?: string | undefined;
1819
+ targetIpId?: string | undefined;
1820
+ } | undefined;
1821
+ };
1822
+ } & {
1823
+ baseUrl?: string | undefined;
1824
+ querySerializer?: openapi_fetch.QuerySerializerOptions | openapi_fetch.QuerySerializer<{
1825
+ parameters: {
1826
+ query?: undefined;
1827
+ header?: undefined;
1828
+ path?: undefined;
1829
+ cookie?: undefined;
1830
+ };
1831
+ requestBody: {
1832
+ content: {
1833
+ "application/json": {
1834
+ readonly $schema?: string | undefined;
1835
+ orderBy?: string | undefined;
1836
+ orderDirection?: string | undefined;
1837
+ pagination?: {
1838
+ limit: number;
1839
+ offset: number;
1840
+ } | undefined;
1841
+ where?: {
1842
+ blockNumber?: string | undefined;
1843
+ blockNumberGte?: string | undefined;
1844
+ blockNumberLte?: string | undefined;
1845
+ id?: string | undefined;
1846
+ initiator?: string | undefined;
1847
+ targetIpId?: string | undefined;
1848
+ } | undefined;
1849
+ };
1850
+ };
1851
+ };
1852
+ responses: {
1853
+ 200: {
1854
+ headers: {
1855
+ [name: string]: unknown;
1856
+ };
1857
+ content: {
1858
+ "application/json": {
1859
+ readonly $schema?: string | undefined;
1860
+ data: {
1861
+ arbitrationPolicy: string;
1862
+ blockNumber: string | null;
1863
+ blockTimestamp?: string | undefined;
1864
+ counterEvidenceHash: string;
1865
+ currentTag: string;
1866
+ data: string;
1867
+ deletedAt?: string | undefined;
1868
+ disputeTimestamp: string | null;
1869
+ evidenceHash: string;
1870
+ id: string | null;
1871
+ initiator: string;
1872
+ liveness: string | null;
1873
+ logIndex?: string | undefined;
1874
+ status: string;
1875
+ targetIpId: string;
1876
+ targetTag: string;
1877
+ transactionHash: string;
1878
+ umaLink?: string | undefined;
1879
+ }[] | null;
1880
+ pagination?: {
1881
+ hasMore: boolean;
1882
+ limit: number;
1883
+ offset: number;
1884
+ total?: number | undefined;
1885
+ } | undefined;
1886
+ };
1887
+ };
1888
+ };
1889
+ default: {
1890
+ headers: {
1891
+ [name: string]: unknown;
1892
+ };
1893
+ content: {
1894
+ "application/problem+json": {
1895
+ readonly $schema?: string | undefined;
1896
+ detail?: string | undefined;
1897
+ errors?: {
1898
+ location?: string | undefined;
1899
+ message?: string | undefined;
1900
+ value?: unknown;
1901
+ }[] | null | undefined;
1902
+ instance?: string | undefined;
1903
+ status?: number | undefined;
1904
+ title?: string | undefined;
1905
+ type: string;
1906
+ };
1907
+ };
1908
+ };
1909
+ };
1910
+ }> | undefined;
1911
+ bodySerializer?: openapi_fetch.BodySerializer<{
1912
+ parameters: {
1913
+ query?: undefined;
1914
+ header?: undefined;
1915
+ path?: undefined;
1916
+ cookie?: undefined;
1917
+ };
1918
+ requestBody: {
1919
+ content: {
1920
+ "application/json": {
1921
+ readonly $schema?: string | undefined;
1922
+ orderBy?: string | undefined;
1923
+ orderDirection?: string | undefined;
1924
+ pagination?: {
1925
+ limit: number;
1926
+ offset: number;
1927
+ } | undefined;
1928
+ where?: {
1929
+ blockNumber?: string | undefined;
1930
+ blockNumberGte?: string | undefined;
1931
+ blockNumberLte?: string | undefined;
1932
+ id?: string | undefined;
1933
+ initiator?: string | undefined;
1934
+ targetIpId?: string | undefined;
1935
+ } | undefined;
1936
+ };
1937
+ };
1938
+ };
1939
+ responses: {
1940
+ 200: {
1941
+ headers: {
1942
+ [name: string]: unknown;
1943
+ };
1944
+ content: {
1945
+ "application/json": {
1946
+ readonly $schema?: string | undefined;
1947
+ data: {
1948
+ arbitrationPolicy: string;
1949
+ blockNumber: string | null;
1950
+ blockTimestamp?: string | undefined;
1951
+ counterEvidenceHash: string;
1952
+ currentTag: string;
1953
+ data: string;
1954
+ deletedAt?: string | undefined;
1955
+ disputeTimestamp: string | null;
1956
+ evidenceHash: string;
1957
+ id: string | null;
1958
+ initiator: string;
1959
+ liveness: string | null;
1960
+ logIndex?: string | undefined;
1961
+ status: string;
1962
+ targetIpId: string;
1963
+ targetTag: string;
1964
+ transactionHash: string;
1965
+ umaLink?: string | undefined;
1966
+ }[] | null;
1967
+ pagination?: {
1968
+ hasMore: boolean;
1969
+ limit: number;
1970
+ offset: number;
1971
+ total?: number | undefined;
1972
+ } | undefined;
1973
+ };
1974
+ };
1975
+ };
1976
+ default: {
1977
+ headers: {
1978
+ [name: string]: unknown;
1979
+ };
1980
+ content: {
1981
+ "application/problem+json": {
1982
+ readonly $schema?: string | undefined;
1983
+ detail?: string | undefined;
1984
+ errors?: {
1985
+ location?: string | undefined;
1986
+ message?: string | undefined;
1987
+ value?: unknown;
1988
+ }[] | null | undefined;
1989
+ instance?: string | undefined;
1990
+ status?: number | undefined;
1991
+ title?: string | undefined;
1992
+ type: string;
1993
+ };
1994
+ };
1995
+ };
1996
+ };
1997
+ }> | undefined;
1998
+ parseAs?: keyof openapi_fetch.BodyType<unknown> | undefined;
1999
+ fetch?: ((input: Request) => Promise<Response>) | undefined;
2000
+ headers?: openapi_fetch.HeadersOptions | undefined;
2001
+ } & Omit<RequestInit, "headers" | "body"> & {
2002
+ readonly $schema?: string | undefined;
2003
+ orderBy?: string | undefined;
2004
+ orderDirection?: string | undefined;
2005
+ pagination?: {
2006
+ limit: number;
2007
+ offset: number;
2008
+ } | undefined;
2009
+ where?: {
2010
+ blockNumber?: string | undefined;
2011
+ blockNumberGte?: string | undefined;
2012
+ blockNumberLte?: string | undefined;
2013
+ id?: string | undefined;
2014
+ initiator?: string | undefined;
2015
+ targetIpId?: string | undefined;
2016
+ } | undefined;
2017
+ }, `${string}/${string}`>>;
2018
+
2019
+ type IpAssetEdgesResponse = paths["/assets/edges"]["post"]["responses"][200]["content"]["application/json"];
2020
+ type IpAssetEdgesOptions = Partial<paths["/assets/edges"]["post"]["requestBody"]["content"]["application/json"]>;
2021
+ type GetIpAssetEdgesOptions = {
2022
+ apiClient: ApiClient;
2023
+ ipId?: Address;
2024
+ parentIpId?: Address;
2025
+ options?: IpAssetEdgesOptions;
2026
+ apiKey: string;
2027
+ };
2028
+ declare function getIpAssetEdges({ apiClient, ipId, parentIpId, options, apiKey }: GetIpAssetEdgesOptions): Promise<openapi_fetch.FetchResponse<{
2029
+ parameters: {
2030
+ query?: undefined;
2031
+ header?: undefined;
2032
+ path?: undefined;
2033
+ cookie?: undefined;
2034
+ };
2035
+ requestBody: {
2036
+ content: {
2037
+ "application/json": {
2038
+ readonly $schema?: string | undefined;
2039
+ orderBy?: "blockNumber" | undefined;
2040
+ orderDirection: "asc" | "desc";
2041
+ pagination?: {
2042
+ limit: number;
2043
+ offset: number;
2044
+ } | undefined;
2045
+ where?: {
2046
+ blockNumber?: number | undefined;
2047
+ childIpId?: string | undefined;
2048
+ parentIpId?: string | undefined;
2049
+ txHash?: string | undefined;
2050
+ } | undefined;
2051
+ };
2052
+ };
2053
+ };
2054
+ responses: {
2055
+ 200: {
2056
+ headers: {
2057
+ [name: string]: unknown;
2058
+ };
2059
+ content: {
2060
+ "application/json": {
2061
+ readonly $schema?: string | undefined;
2062
+ data: {
2063
+ blockNumber: number;
2064
+ blockTimestamp: string;
2065
+ caller: string;
2066
+ childIpId: string;
2067
+ id: number;
2068
+ licenseTemplate: string;
2069
+ licenseTermsId: string;
2070
+ licenseTokenId: string;
2071
+ logIndex: number;
2072
+ parentIpId: string;
2073
+ processedAt: string;
2074
+ txHash: string;
2075
+ }[] | null;
2076
+ pagination?: {
2077
+ hasMore: boolean;
2078
+ limit: number;
2079
+ offset: number;
2080
+ total?: number | undefined;
2081
+ } | undefined;
2082
+ };
2083
+ };
2084
+ };
2085
+ default: {
2086
+ headers: {
2087
+ [name: string]: unknown;
2088
+ };
2089
+ content: {
2090
+ "application/problem+json": {
2091
+ readonly $schema?: string | undefined;
2092
+ detail?: string | undefined;
2093
+ errors?: {
2094
+ location?: string | undefined;
2095
+ message?: string | undefined;
2096
+ value?: unknown;
2097
+ }[] | null | undefined;
2098
+ instance?: string | undefined;
2099
+ status?: number | undefined;
2100
+ title?: string | undefined;
2101
+ type: string;
2102
+ };
2103
+ };
2104
+ };
2105
+ };
2106
+ }, {
2107
+ params?: {
2108
+ query?: undefined;
2109
+ header?: undefined;
2110
+ path?: undefined;
2111
+ cookie?: undefined;
2112
+ } | undefined;
2113
+ } & {
2114
+ body: {
2115
+ readonly $schema?: string | undefined;
2116
+ orderBy?: "blockNumber" | undefined;
2117
+ orderDirection: "asc" | "desc";
2118
+ pagination?: {
2119
+ limit: number;
2120
+ offset: number;
2121
+ } | undefined;
2122
+ where?: {
2123
+ blockNumber?: number | undefined;
2124
+ childIpId?: string | undefined;
2125
+ parentIpId?: string | undefined;
2126
+ txHash?: string | undefined;
2127
+ } | undefined;
2128
+ };
2129
+ } & {
2130
+ baseUrl?: string | undefined;
2131
+ querySerializer?: openapi_fetch.QuerySerializerOptions | openapi_fetch.QuerySerializer<{
2132
+ parameters: {
2133
+ query?: undefined;
2134
+ header?: undefined;
2135
+ path?: undefined;
2136
+ cookie?: undefined;
2137
+ };
2138
+ requestBody: {
2139
+ content: {
2140
+ "application/json": {
2141
+ readonly $schema?: string | undefined;
2142
+ orderBy?: "blockNumber" | undefined;
2143
+ orderDirection: "asc" | "desc";
2144
+ pagination?: {
2145
+ limit: number;
2146
+ offset: number;
2147
+ } | undefined;
2148
+ where?: {
2149
+ blockNumber?: number | undefined;
2150
+ childIpId?: string | undefined;
2151
+ parentIpId?: string | undefined;
2152
+ txHash?: string | undefined;
2153
+ } | undefined;
2154
+ };
2155
+ };
2156
+ };
2157
+ responses: {
2158
+ 200: {
2159
+ headers: {
2160
+ [name: string]: unknown;
2161
+ };
2162
+ content: {
2163
+ "application/json": {
2164
+ readonly $schema?: string | undefined;
2165
+ data: {
2166
+ blockNumber: number;
2167
+ blockTimestamp: string;
2168
+ caller: string;
2169
+ childIpId: string;
2170
+ id: number;
2171
+ licenseTemplate: string;
2172
+ licenseTermsId: string;
2173
+ licenseTokenId: string;
2174
+ logIndex: number;
2175
+ parentIpId: string;
2176
+ processedAt: string;
2177
+ txHash: string;
2178
+ }[] | null;
2179
+ pagination?: {
2180
+ hasMore: boolean;
2181
+ limit: number;
2182
+ offset: number;
2183
+ total?: number | undefined;
2184
+ } | undefined;
2185
+ };
2186
+ };
2187
+ };
2188
+ default: {
2189
+ headers: {
2190
+ [name: string]: unknown;
2191
+ };
2192
+ content: {
2193
+ "application/problem+json": {
2194
+ readonly $schema?: string | undefined;
2195
+ detail?: string | undefined;
2196
+ errors?: {
2197
+ location?: string | undefined;
2198
+ message?: string | undefined;
2199
+ value?: unknown;
2200
+ }[] | null | undefined;
2201
+ instance?: string | undefined;
2202
+ status?: number | undefined;
2203
+ title?: string | undefined;
2204
+ type: string;
2205
+ };
2206
+ };
2207
+ };
2208
+ };
2209
+ }> | undefined;
2210
+ bodySerializer?: openapi_fetch.BodySerializer<{
2211
+ parameters: {
2212
+ query?: undefined;
2213
+ header?: undefined;
2214
+ path?: undefined;
2215
+ cookie?: undefined;
2216
+ };
2217
+ requestBody: {
2218
+ content: {
2219
+ "application/json": {
2220
+ readonly $schema?: string | undefined;
2221
+ orderBy?: "blockNumber" | undefined;
2222
+ orderDirection: "asc" | "desc";
2223
+ pagination?: {
2224
+ limit: number;
2225
+ offset: number;
2226
+ } | undefined;
2227
+ where?: {
2228
+ blockNumber?: number | undefined;
2229
+ childIpId?: string | undefined;
2230
+ parentIpId?: string | undefined;
2231
+ txHash?: string | undefined;
2232
+ } | undefined;
2233
+ };
2234
+ };
2235
+ };
2236
+ responses: {
2237
+ 200: {
2238
+ headers: {
2239
+ [name: string]: unknown;
2240
+ };
2241
+ content: {
2242
+ "application/json": {
2243
+ readonly $schema?: string | undefined;
2244
+ data: {
2245
+ blockNumber: number;
2246
+ blockTimestamp: string;
2247
+ caller: string;
2248
+ childIpId: string;
2249
+ id: number;
2250
+ licenseTemplate: string;
2251
+ licenseTermsId: string;
2252
+ licenseTokenId: string;
2253
+ logIndex: number;
2254
+ parentIpId: string;
2255
+ processedAt: string;
2256
+ txHash: string;
2257
+ }[] | null;
2258
+ pagination?: {
2259
+ hasMore: boolean;
2260
+ limit: number;
2261
+ offset: number;
2262
+ total?: number | undefined;
2263
+ } | undefined;
2264
+ };
2265
+ };
2266
+ };
2267
+ default: {
2268
+ headers: {
2269
+ [name: string]: unknown;
2270
+ };
2271
+ content: {
2272
+ "application/problem+json": {
2273
+ readonly $schema?: string | undefined;
2274
+ detail?: string | undefined;
2275
+ errors?: {
2276
+ location?: string | undefined;
2277
+ message?: string | undefined;
2278
+ value?: unknown;
2279
+ }[] | null | undefined;
2280
+ instance?: string | undefined;
2281
+ status?: number | undefined;
2282
+ title?: string | undefined;
2283
+ type: string;
2284
+ };
2285
+ };
2286
+ };
2287
+ };
2288
+ }> | undefined;
2289
+ parseAs?: keyof openapi_fetch.BodyType<unknown> | undefined;
2290
+ fetch?: ((input: Request) => Promise<Response>) | undefined;
2291
+ headers?: openapi_fetch.HeadersOptions | undefined;
2292
+ } & Omit<RequestInit, "headers" | "body"> & {
2293
+ readonly $schema?: string | undefined;
2294
+ orderBy?: "blockNumber" | undefined;
2295
+ orderDirection: "asc" | "desc";
2296
+ pagination?: {
2297
+ limit: number;
2298
+ offset: number;
2299
+ } | undefined;
2300
+ where?: {
2301
+ blockNumber?: number | undefined;
2302
+ childIpId?: string | undefined;
2303
+ parentIpId?: string | undefined;
2304
+ txHash?: string | undefined;
2305
+ } | undefined;
2306
+ }, `${string}/${string}`>>;
2307
+
2308
+ type IpAssetsResponse = paths["/assets"]["post"]["responses"][200]["content"]["application/json"];
2309
+ type IpAssetsOptions = Partial<paths["/assets"]["post"]["requestBody"]["content"]["application/json"]>;
2310
+ type GetIpAssetsOptions = {
2311
+ apiClient: ApiClient;
2312
+ ownerAddress?: Address;
2313
+ tokenContract?: Address;
2314
+ includeLicenses?: boolean;
2315
+ moderated?: boolean;
2316
+ ipIds?: Address[];
2317
+ options?: IpAssetsOptions;
2318
+ apiKey: string;
2319
+ };
2320
+ declare function getIpAssets({ apiClient, ownerAddress, tokenContract, includeLicenses, moderated, ipIds, options, apiKey, }: GetIpAssetsOptions): Promise<openapi_fetch.FetchResponse<{
2321
+ parameters: {
2322
+ query?: undefined;
2323
+ header?: undefined;
2324
+ path?: undefined;
2325
+ cookie?: undefined;
2326
+ };
2327
+ requestBody: {
2328
+ content: {
2329
+ "application/json": {
2330
+ readonly $schema?: string | undefined;
2331
+ includeLicenses?: boolean | undefined;
2332
+ moderated?: boolean | undefined;
2333
+ orderBy: "blockNumber" | "descendantCount" | "createdAt";
2334
+ orderDirection: "asc" | "desc";
2335
+ pagination?: {
2336
+ limit: number;
2337
+ offset: number;
2338
+ } | undefined;
2339
+ where?: {
2340
+ ipIds?: string[] | null | undefined;
2341
+ ownerAddress?: string | undefined;
2342
+ tokenContract?: string | undefined;
2343
+ } | undefined;
2344
+ };
2345
+ };
2346
+ };
2347
+ responses: {
2348
+ 200: {
2349
+ headers: {
2350
+ [name: string]: unknown;
2351
+ };
2352
+ content: {
2353
+ "application/json": {
2354
+ readonly $schema?: string | undefined;
2355
+ data: {
2356
+ ancestorsCount: number;
2357
+ blockNumber: number;
2358
+ chainId: string;
2359
+ childrenCount: number;
2360
+ createdAt: string;
2361
+ descendantsCount: number;
2362
+ description: string;
2363
+ infringementStatus?: {
2364
+ createdAt: string;
2365
+ customData: string;
2366
+ infringementDetails: string;
2367
+ isInfringing: boolean;
2368
+ providerName: string;
2369
+ providerURL: string;
2370
+ responseTime: string;
2371
+ status: string;
2372
+ updatedAt: string;
2373
+ }[] | null | undefined;
2374
+ ipId: string;
2375
+ ipaMetadataUri?: string | undefined;
2376
+ isInGroup: boolean;
2377
+ lastUpdatedAt: string;
2378
+ licenses?: {
2379
+ createdAt: string;
2380
+ licenseTemplateId: string;
2381
+ licenseTermsId: string;
2382
+ licensingConfig: {
2383
+ commercialRevShare: number;
2384
+ disabled: boolean;
2385
+ expectGroupRewardPool: string;
2386
+ expectMinimumGroupRewardShare: number;
2387
+ hookData: string;
2388
+ isSet: boolean;
2389
+ licensingHook: string;
2390
+ mintingFee: number;
2391
+ };
2392
+ templateMetadataUri: string;
2393
+ templateName: string;
2394
+ terms: {
2395
+ commercialAttribution: boolean;
2396
+ commercialRevCeiling: string;
2397
+ commercialRevShare: number;
2398
+ commercialUse: boolean;
2399
+ commercializerChecker: string;
2400
+ commercializerCheckerData: string;
2401
+ currency: string;
2402
+ defaultMintingFee: string;
2403
+ derivativeRevCeiling: string;
2404
+ derivativesAllowed: boolean;
2405
+ derivativesApproval: boolean;
2406
+ derivativesAttribution: boolean;
2407
+ derivativesReciprocal: boolean;
2408
+ expiration: string;
2409
+ royaltyPolicy: string;
2410
+ transferable: boolean;
2411
+ uri: string;
2412
+ };
2413
+ updatedAt: string;
2414
+ }[] | null | undefined;
2415
+ logIndex: number;
2416
+ moderationStatus?: {
2417
+ adult: string;
2418
+ medical: string;
2419
+ racy: string;
2420
+ spoof: string;
2421
+ violence: string;
2422
+ } | undefined;
2423
+ name: string;
2424
+ nftMetadata?: {
2425
+ animation: {
2426
+ cachedUrl: string;
2427
+ contentType: string;
2428
+ originalUrl: string;
2429
+ size: number;
2430
+ };
2431
+ collection: {
2432
+ bannerImageUrl: string;
2433
+ externalUrl: string | null;
2434
+ name: string;
2435
+ slug: string;
2436
+ };
2437
+ contract: {
2438
+ address: string;
2439
+ chain: string;
2440
+ contractDeployer: string;
2441
+ deployedBlockNumber: number;
2442
+ name: string;
2443
+ openSeaMetadata: {
2444
+ bannerImageUrl: string;
2445
+ collectionName: string;
2446
+ collectionSlug: string;
2447
+ description: string;
2448
+ discordUrl: string;
2449
+ externalUrl: string | null;
2450
+ floorPrice: number;
2451
+ imageUrl: string;
2452
+ lastIngestedAt: string;
2453
+ safelistRequestStatus: string;
2454
+ twitterUsername: string;
2455
+ };
2456
+ symbol: string;
2457
+ tokenType: string;
2458
+ totalSupply: string;
2459
+ };
2460
+ contract_address: string;
2461
+ description: string | null;
2462
+ image: {
2463
+ cachedUrl: string;
2464
+ contentType: string;
2465
+ originalUrl: string;
2466
+ pngUrl: string;
2467
+ size: number;
2468
+ thumbnailUrl: string;
2469
+ };
2470
+ mint: {
2471
+ blockNumber: number | null;
2472
+ mintAddress: string | null;
2473
+ timestamp: string | null;
2474
+ transactionHash: string | null;
2475
+ };
2476
+ name: string;
2477
+ nft_id: string;
2478
+ raw: unknown;
2479
+ timeLastUpdated: string;
2480
+ tokenId: string;
2481
+ tokenType: string;
2482
+ tokenUri: string;
2483
+ } | undefined;
2484
+ ownerAddress: string;
2485
+ parentsCount: number;
2486
+ registrationDate: string;
2487
+ rootIPs: string[] | null;
2488
+ title: string;
2489
+ tokenContract: string;
2490
+ tokenId: string;
2491
+ txHash: string;
2492
+ uri: string;
2493
+ }[] | null;
2494
+ pagination?: {
2495
+ hasMore: boolean;
2496
+ limit: number;
2497
+ offset: number;
2498
+ total?: number | undefined;
2499
+ } | undefined;
2500
+ };
2501
+ };
2502
+ };
2503
+ default: {
2504
+ headers: {
2505
+ [name: string]: unknown;
2506
+ };
2507
+ content: {
2508
+ "application/problem+json": {
2509
+ readonly $schema?: string | undefined;
2510
+ detail?: string | undefined;
2511
+ errors?: {
2512
+ location?: string | undefined;
2513
+ message?: string | undefined;
2514
+ value?: unknown;
2515
+ }[] | null | undefined;
2516
+ instance?: string | undefined;
2517
+ status?: number | undefined;
2518
+ title?: string | undefined;
2519
+ type: string;
2520
+ };
2521
+ };
2522
+ };
2523
+ };
2524
+ }, {
2525
+ params?: {
2526
+ query?: undefined;
2527
+ header?: undefined;
2528
+ path?: undefined;
2529
+ cookie?: undefined;
2530
+ } | undefined;
2531
+ } & {
2532
+ body: {
2533
+ readonly $schema?: string | undefined;
2534
+ includeLicenses?: boolean | undefined;
2535
+ moderated?: boolean | undefined;
2536
+ orderBy: "blockNumber" | "descendantCount" | "createdAt";
2537
+ orderDirection: "asc" | "desc";
2538
+ pagination?: {
2539
+ limit: number;
2540
+ offset: number;
2541
+ } | undefined;
2542
+ where?: {
2543
+ ipIds?: string[] | null | undefined;
2544
+ ownerAddress?: string | undefined;
2545
+ tokenContract?: string | undefined;
2546
+ } | undefined;
2547
+ };
2548
+ } & {
2549
+ baseUrl?: string | undefined;
2550
+ querySerializer?: openapi_fetch.QuerySerializerOptions | openapi_fetch.QuerySerializer<{
2551
+ parameters: {
2552
+ query?: undefined;
2553
+ header?: undefined;
2554
+ path?: undefined;
2555
+ cookie?: undefined;
2556
+ };
2557
+ requestBody: {
2558
+ content: {
2559
+ "application/json": {
2560
+ readonly $schema?: string | undefined;
2561
+ includeLicenses?: boolean | undefined;
2562
+ moderated?: boolean | undefined;
2563
+ orderBy: "blockNumber" | "descendantCount" | "createdAt";
2564
+ orderDirection: "asc" | "desc";
2565
+ pagination?: {
2566
+ limit: number;
2567
+ offset: number;
2568
+ } | undefined;
2569
+ where?: {
2570
+ ipIds?: string[] | null | undefined;
2571
+ ownerAddress?: string | undefined;
2572
+ tokenContract?: string | undefined;
2573
+ } | undefined;
2574
+ };
2575
+ };
2576
+ };
2577
+ responses: {
2578
+ 200: {
2579
+ headers: {
2580
+ [name: string]: unknown;
2581
+ };
2582
+ content: {
2583
+ "application/json": {
2584
+ readonly $schema?: string | undefined;
2585
+ data: {
2586
+ ancestorsCount: number;
2587
+ blockNumber: number;
2588
+ chainId: string;
2589
+ childrenCount: number;
2590
+ createdAt: string;
2591
+ descendantsCount: number;
2592
+ description: string;
2593
+ infringementStatus?: {
2594
+ createdAt: string;
2595
+ customData: string;
2596
+ infringementDetails: string;
2597
+ isInfringing: boolean;
2598
+ providerName: string;
2599
+ providerURL: string;
2600
+ responseTime: string;
2601
+ status: string;
2602
+ updatedAt: string;
2603
+ }[] | null | undefined;
2604
+ ipId: string;
2605
+ ipaMetadataUri?: string | undefined;
2606
+ isInGroup: boolean;
2607
+ lastUpdatedAt: string;
2608
+ licenses?: {
2609
+ createdAt: string;
2610
+ licenseTemplateId: string;
2611
+ licenseTermsId: string;
2612
+ licensingConfig: {
2613
+ commercialRevShare: number;
2614
+ disabled: boolean;
2615
+ expectGroupRewardPool: string;
2616
+ expectMinimumGroupRewardShare: number;
2617
+ hookData: string;
2618
+ isSet: boolean;
2619
+ licensingHook: string;
2620
+ mintingFee: number;
2621
+ };
2622
+ templateMetadataUri: string;
2623
+ templateName: string;
2624
+ terms: {
2625
+ commercialAttribution: boolean;
2626
+ commercialRevCeiling: string;
2627
+ commercialRevShare: number;
2628
+ commercialUse: boolean;
2629
+ commercializerChecker: string;
2630
+ commercializerCheckerData: string;
2631
+ currency: string;
2632
+ defaultMintingFee: string;
2633
+ derivativeRevCeiling: string;
2634
+ derivativesAllowed: boolean;
2635
+ derivativesApproval: boolean;
2636
+ derivativesAttribution: boolean;
2637
+ derivativesReciprocal: boolean;
2638
+ expiration: string;
2639
+ royaltyPolicy: string;
2640
+ transferable: boolean;
2641
+ uri: string;
2642
+ };
2643
+ updatedAt: string;
2644
+ }[] | null | undefined;
2645
+ logIndex: number;
2646
+ moderationStatus?: {
2647
+ adult: string;
2648
+ medical: string;
2649
+ racy: string;
2650
+ spoof: string;
2651
+ violence: string;
2652
+ } | undefined;
2653
+ name: string;
2654
+ nftMetadata?: {
2655
+ animation: {
2656
+ cachedUrl: string;
2657
+ contentType: string;
2658
+ originalUrl: string;
2659
+ size: number;
2660
+ };
2661
+ collection: {
2662
+ bannerImageUrl: string;
2663
+ externalUrl: string | null;
2664
+ name: string;
2665
+ slug: string;
2666
+ };
2667
+ contract: {
2668
+ address: string;
2669
+ chain: string;
2670
+ contractDeployer: string;
2671
+ deployedBlockNumber: number;
2672
+ name: string;
2673
+ openSeaMetadata: {
2674
+ bannerImageUrl: string;
2675
+ collectionName: string;
2676
+ collectionSlug: string;
2677
+ description: string;
2678
+ discordUrl: string;
2679
+ externalUrl: string | null;
2680
+ floorPrice: number;
2681
+ imageUrl: string;
2682
+ lastIngestedAt: string;
2683
+ safelistRequestStatus: string;
2684
+ twitterUsername: string;
2685
+ };
2686
+ symbol: string;
2687
+ tokenType: string;
2688
+ totalSupply: string;
2689
+ };
2690
+ contract_address: string;
2691
+ description: string | null;
2692
+ image: {
2693
+ cachedUrl: string;
2694
+ contentType: string;
2695
+ originalUrl: string;
2696
+ pngUrl: string;
2697
+ size: number;
2698
+ thumbnailUrl: string;
2699
+ };
2700
+ mint: {
2701
+ blockNumber: number | null;
2702
+ mintAddress: string | null;
2703
+ timestamp: string | null;
2704
+ transactionHash: string | null;
2705
+ };
2706
+ name: string;
2707
+ nft_id: string;
2708
+ raw: unknown;
2709
+ timeLastUpdated: string;
2710
+ tokenId: string;
2711
+ tokenType: string;
2712
+ tokenUri: string;
2713
+ } | undefined;
2714
+ ownerAddress: string;
2715
+ parentsCount: number;
2716
+ registrationDate: string;
2717
+ rootIPs: string[] | null;
2718
+ title: string;
2719
+ tokenContract: string;
2720
+ tokenId: string;
2721
+ txHash: string;
2722
+ uri: string;
2723
+ }[] | null;
2724
+ pagination?: {
2725
+ hasMore: boolean;
2726
+ limit: number;
2727
+ offset: number;
2728
+ total?: number | undefined;
2729
+ } | undefined;
2730
+ };
2731
+ };
2732
+ };
2733
+ default: {
2734
+ headers: {
2735
+ [name: string]: unknown;
2736
+ };
2737
+ content: {
2738
+ "application/problem+json": {
2739
+ readonly $schema?: string | undefined;
2740
+ detail?: string | undefined;
2741
+ errors?: {
2742
+ location?: string | undefined;
2743
+ message?: string | undefined;
2744
+ value?: unknown;
2745
+ }[] | null | undefined;
2746
+ instance?: string | undefined;
2747
+ status?: number | undefined;
2748
+ title?: string | undefined;
2749
+ type: string;
2750
+ };
2751
+ };
2752
+ };
2753
+ };
2754
+ }> | undefined;
2755
+ bodySerializer?: openapi_fetch.BodySerializer<{
2756
+ parameters: {
2757
+ query?: undefined;
2758
+ header?: undefined;
2759
+ path?: undefined;
2760
+ cookie?: undefined;
2761
+ };
2762
+ requestBody: {
2763
+ content: {
2764
+ "application/json": {
2765
+ readonly $schema?: string | undefined;
2766
+ includeLicenses?: boolean | undefined;
2767
+ moderated?: boolean | undefined;
2768
+ orderBy: "blockNumber" | "descendantCount" | "createdAt";
2769
+ orderDirection: "asc" | "desc";
2770
+ pagination?: {
2771
+ limit: number;
2772
+ offset: number;
2773
+ } | undefined;
2774
+ where?: {
2775
+ ipIds?: string[] | null | undefined;
2776
+ ownerAddress?: string | undefined;
2777
+ tokenContract?: string | undefined;
2778
+ } | undefined;
2779
+ };
2780
+ };
2781
+ };
2782
+ responses: {
2783
+ 200: {
2784
+ headers: {
2785
+ [name: string]: unknown;
2786
+ };
2787
+ content: {
2788
+ "application/json": {
2789
+ readonly $schema?: string | undefined;
2790
+ data: {
2791
+ ancestorsCount: number;
2792
+ blockNumber: number;
2793
+ chainId: string;
2794
+ childrenCount: number;
2795
+ createdAt: string;
2796
+ descendantsCount: number;
2797
+ description: string;
2798
+ infringementStatus?: {
2799
+ createdAt: string;
2800
+ customData: string;
2801
+ infringementDetails: string;
2802
+ isInfringing: boolean;
2803
+ providerName: string;
2804
+ providerURL: string;
2805
+ responseTime: string;
2806
+ status: string;
2807
+ updatedAt: string;
2808
+ }[] | null | undefined;
2809
+ ipId: string;
2810
+ ipaMetadataUri?: string | undefined;
2811
+ isInGroup: boolean;
2812
+ lastUpdatedAt: string;
2813
+ licenses?: {
2814
+ createdAt: string;
2815
+ licenseTemplateId: string;
2816
+ licenseTermsId: string;
2817
+ licensingConfig: {
2818
+ commercialRevShare: number;
2819
+ disabled: boolean;
2820
+ expectGroupRewardPool: string;
2821
+ expectMinimumGroupRewardShare: number;
2822
+ hookData: string;
2823
+ isSet: boolean;
2824
+ licensingHook: string;
2825
+ mintingFee: number;
2826
+ };
2827
+ templateMetadataUri: string;
2828
+ templateName: string;
2829
+ terms: {
2830
+ commercialAttribution: boolean;
2831
+ commercialRevCeiling: string;
2832
+ commercialRevShare: number;
2833
+ commercialUse: boolean;
2834
+ commercializerChecker: string;
2835
+ commercializerCheckerData: string;
2836
+ currency: string;
2837
+ defaultMintingFee: string;
2838
+ derivativeRevCeiling: string;
2839
+ derivativesAllowed: boolean;
2840
+ derivativesApproval: boolean;
2841
+ derivativesAttribution: boolean;
2842
+ derivativesReciprocal: boolean;
2843
+ expiration: string;
2844
+ royaltyPolicy: string;
2845
+ transferable: boolean;
2846
+ uri: string;
2847
+ };
2848
+ updatedAt: string;
2849
+ }[] | null | undefined;
2850
+ logIndex: number;
2851
+ moderationStatus?: {
2852
+ adult: string;
2853
+ medical: string;
2854
+ racy: string;
2855
+ spoof: string;
2856
+ violence: string;
2857
+ } | undefined;
2858
+ name: string;
2859
+ nftMetadata?: {
2860
+ animation: {
2861
+ cachedUrl: string;
2862
+ contentType: string;
2863
+ originalUrl: string;
2864
+ size: number;
2865
+ };
2866
+ collection: {
2867
+ bannerImageUrl: string;
2868
+ externalUrl: string | null;
2869
+ name: string;
2870
+ slug: string;
2871
+ };
2872
+ contract: {
2873
+ address: string;
2874
+ chain: string;
2875
+ contractDeployer: string;
2876
+ deployedBlockNumber: number;
2877
+ name: string;
2878
+ openSeaMetadata: {
2879
+ bannerImageUrl: string;
2880
+ collectionName: string;
2881
+ collectionSlug: string;
2882
+ description: string;
2883
+ discordUrl: string;
2884
+ externalUrl: string | null;
2885
+ floorPrice: number;
2886
+ imageUrl: string;
2887
+ lastIngestedAt: string;
2888
+ safelistRequestStatus: string;
2889
+ twitterUsername: string;
2890
+ };
2891
+ symbol: string;
2892
+ tokenType: string;
2893
+ totalSupply: string;
2894
+ };
2895
+ contract_address: string;
2896
+ description: string | null;
2897
+ image: {
2898
+ cachedUrl: string;
2899
+ contentType: string;
2900
+ originalUrl: string;
2901
+ pngUrl: string;
2902
+ size: number;
2903
+ thumbnailUrl: string;
2904
+ };
2905
+ mint: {
2906
+ blockNumber: number | null;
2907
+ mintAddress: string | null;
2908
+ timestamp: string | null;
2909
+ transactionHash: string | null;
2910
+ };
2911
+ name: string;
2912
+ nft_id: string;
2913
+ raw: unknown;
2914
+ timeLastUpdated: string;
2915
+ tokenId: string;
2916
+ tokenType: string;
2917
+ tokenUri: string;
2918
+ } | undefined;
2919
+ ownerAddress: string;
2920
+ parentsCount: number;
2921
+ registrationDate: string;
2922
+ rootIPs: string[] | null;
2923
+ title: string;
2924
+ tokenContract: string;
2925
+ tokenId: string;
2926
+ txHash: string;
2927
+ uri: string;
2928
+ }[] | null;
2929
+ pagination?: {
2930
+ hasMore: boolean;
2931
+ limit: number;
2932
+ offset: number;
2933
+ total?: number | undefined;
2934
+ } | undefined;
2935
+ };
2936
+ };
2937
+ };
2938
+ default: {
2939
+ headers: {
2940
+ [name: string]: unknown;
2941
+ };
2942
+ content: {
2943
+ "application/problem+json": {
2944
+ readonly $schema?: string | undefined;
2945
+ detail?: string | undefined;
2946
+ errors?: {
2947
+ location?: string | undefined;
2948
+ message?: string | undefined;
2949
+ value?: unknown;
2950
+ }[] | null | undefined;
2951
+ instance?: string | undefined;
2952
+ status?: number | undefined;
2953
+ title?: string | undefined;
2954
+ type: string;
2955
+ };
2956
+ };
2957
+ };
2958
+ };
2959
+ }> | undefined;
2960
+ parseAs?: keyof openapi_fetch.BodyType<unknown> | undefined;
2961
+ fetch?: ((input: Request) => Promise<Response>) | undefined;
2962
+ headers?: openapi_fetch.HeadersOptions | undefined;
2963
+ } & Omit<RequestInit, "headers" | "body"> & {
2964
+ readonly $schema?: string | undefined;
2965
+ includeLicenses?: boolean | undefined;
2966
+ moderated?: boolean | undefined;
2967
+ orderBy: "blockNumber" | "descendantCount" | "createdAt";
2968
+ orderDirection: "asc" | "desc";
2969
+ pagination?: {
2970
+ limit: number;
2971
+ offset: number;
2972
+ } | undefined;
2973
+ where?: {
2974
+ ipIds?: string[] | null | undefined;
2975
+ ownerAddress?: string | undefined;
2976
+ tokenContract?: string | undefined;
2977
+ } | undefined;
2978
+ }, `${string}/${string}`>>;
2979
+
2980
+ type SearchResponse = paths["/search"]["post"]["responses"][200]["content"]["application/json"];
2981
+ type SearchOptions = Partial<paths["/search"]["post"]["requestBody"]["content"]["application/json"]>;
2982
+ type GetSearchOptions = {
2983
+ apiClient: ApiClient;
2984
+ query: string;
2985
+ mediaType?: "audio" | "video" | "image";
2986
+ options?: SearchOptions;
2987
+ apiKey: string;
2988
+ };
2989
+ declare function getSearch({ apiClient, query, mediaType, options, apiKey }: GetSearchOptions): Promise<openapi_fetch.FetchResponse<{
2990
+ parameters: {
2991
+ query?: undefined;
2992
+ header?: undefined;
2993
+ path?: undefined;
2994
+ cookie?: undefined;
2995
+ };
2996
+ requestBody: {
2997
+ content: {
2998
+ "application/json": {
2999
+ readonly $schema?: string | undefined;
3000
+ mediaType?: "audio" | "video" | "image" | undefined;
3001
+ pagination?: {
3002
+ limit: number;
3003
+ offset: number;
3004
+ } | undefined;
3005
+ query: string;
3006
+ };
3007
+ };
3008
+ };
3009
+ responses: {
3010
+ 200: {
3011
+ headers: {
3012
+ [name: string]: unknown;
3013
+ };
3014
+ content: {
3015
+ "application/json": {
3016
+ readonly $schema?: string | undefined;
3017
+ data: {
3018
+ description: string;
3019
+ ipId: string;
3020
+ mediaType: string;
3021
+ score: number;
3022
+ similarity: number;
3023
+ title: string;
3024
+ }[] | null;
3025
+ pagination?: {
3026
+ hasMore: boolean;
3027
+ limit: number;
3028
+ offset: number;
3029
+ total?: number | undefined;
3030
+ } | undefined;
3031
+ total: number;
3032
+ };
3033
+ };
3034
+ };
3035
+ default: {
3036
+ headers: {
3037
+ [name: string]: unknown;
3038
+ };
3039
+ content: {
3040
+ "application/problem+json": {
3041
+ readonly $schema?: string | undefined;
3042
+ detail?: string | undefined;
3043
+ errors?: {
3044
+ location?: string | undefined;
3045
+ message?: string | undefined;
3046
+ value?: unknown;
3047
+ }[] | null | undefined;
3048
+ instance?: string | undefined;
3049
+ status?: number | undefined;
3050
+ title?: string | undefined;
3051
+ type: string;
3052
+ };
3053
+ };
3054
+ };
3055
+ };
3056
+ }, {
3057
+ params?: {
3058
+ query?: undefined;
3059
+ header?: undefined;
3060
+ path?: undefined;
3061
+ cookie?: undefined;
3062
+ } | undefined;
3063
+ } & {
3064
+ body: {
3065
+ readonly $schema?: string | undefined;
3066
+ mediaType?: "audio" | "video" | "image" | undefined;
3067
+ pagination?: {
3068
+ limit: number;
3069
+ offset: number;
3070
+ } | undefined;
3071
+ query: string;
3072
+ };
3073
+ } & {
3074
+ baseUrl?: string | undefined;
3075
+ querySerializer?: openapi_fetch.QuerySerializerOptions | openapi_fetch.QuerySerializer<{
3076
+ parameters: {
3077
+ query?: undefined;
3078
+ header?: undefined;
3079
+ path?: undefined;
3080
+ cookie?: undefined;
3081
+ };
3082
+ requestBody: {
3083
+ content: {
3084
+ "application/json": {
3085
+ readonly $schema?: string | undefined;
3086
+ mediaType?: "audio" | "video" | "image" | undefined;
3087
+ pagination?: {
3088
+ limit: number;
3089
+ offset: number;
3090
+ } | undefined;
3091
+ query: string;
3092
+ };
3093
+ };
3094
+ };
3095
+ responses: {
3096
+ 200: {
3097
+ headers: {
3098
+ [name: string]: unknown;
3099
+ };
3100
+ content: {
3101
+ "application/json": {
3102
+ readonly $schema?: string | undefined;
3103
+ data: {
3104
+ description: string;
3105
+ ipId: string;
3106
+ mediaType: string;
3107
+ score: number;
3108
+ similarity: number;
3109
+ title: string;
3110
+ }[] | null;
3111
+ pagination?: {
3112
+ hasMore: boolean;
3113
+ limit: number;
3114
+ offset: number;
3115
+ total?: number | undefined;
3116
+ } | undefined;
3117
+ total: number;
3118
+ };
3119
+ };
3120
+ };
3121
+ default: {
3122
+ headers: {
3123
+ [name: string]: unknown;
3124
+ };
3125
+ content: {
3126
+ "application/problem+json": {
3127
+ readonly $schema?: string | undefined;
3128
+ detail?: string | undefined;
3129
+ errors?: {
3130
+ location?: string | undefined;
3131
+ message?: string | undefined;
3132
+ value?: unknown;
3133
+ }[] | null | undefined;
3134
+ instance?: string | undefined;
3135
+ status?: number | undefined;
3136
+ title?: string | undefined;
3137
+ type: string;
3138
+ };
3139
+ };
3140
+ };
3141
+ };
3142
+ }> | undefined;
3143
+ bodySerializer?: openapi_fetch.BodySerializer<{
3144
+ parameters: {
3145
+ query?: undefined;
3146
+ header?: undefined;
3147
+ path?: undefined;
3148
+ cookie?: undefined;
3149
+ };
3150
+ requestBody: {
3151
+ content: {
3152
+ "application/json": {
3153
+ readonly $schema?: string | undefined;
3154
+ mediaType?: "audio" | "video" | "image" | undefined;
3155
+ pagination?: {
3156
+ limit: number;
3157
+ offset: number;
3158
+ } | undefined;
3159
+ query: string;
3160
+ };
3161
+ };
3162
+ };
3163
+ responses: {
3164
+ 200: {
3165
+ headers: {
3166
+ [name: string]: unknown;
3167
+ };
3168
+ content: {
3169
+ "application/json": {
3170
+ readonly $schema?: string | undefined;
3171
+ data: {
3172
+ description: string;
3173
+ ipId: string;
3174
+ mediaType: string;
3175
+ score: number;
3176
+ similarity: number;
3177
+ title: string;
3178
+ }[] | null;
3179
+ pagination?: {
3180
+ hasMore: boolean;
3181
+ limit: number;
3182
+ offset: number;
3183
+ total?: number | undefined;
3184
+ } | undefined;
3185
+ total: number;
3186
+ };
3187
+ };
3188
+ };
3189
+ default: {
3190
+ headers: {
3191
+ [name: string]: unknown;
3192
+ };
3193
+ content: {
3194
+ "application/problem+json": {
3195
+ readonly $schema?: string | undefined;
3196
+ detail?: string | undefined;
3197
+ errors?: {
3198
+ location?: string | undefined;
3199
+ message?: string | undefined;
3200
+ value?: unknown;
3201
+ }[] | null | undefined;
3202
+ instance?: string | undefined;
3203
+ status?: number | undefined;
3204
+ title?: string | undefined;
3205
+ type: string;
3206
+ };
3207
+ };
3208
+ };
3209
+ };
3210
+ }> | undefined;
3211
+ parseAs?: keyof openapi_fetch.BodyType<unknown> | undefined;
3212
+ fetch?: ((input: Request) => Promise<Response>) | undefined;
3213
+ headers?: openapi_fetch.HeadersOptions | undefined;
3214
+ } & Omit<RequestInit, "headers" | "body"> & {
3215
+ readonly $schema?: string | undefined;
3216
+ mediaType?: "audio" | "video" | "image" | undefined;
3217
+ pagination?: {
3218
+ limit: number;
3219
+ offset: number;
3220
+ } | undefined;
3221
+ query: string;
3222
+ }, `${string}/${string}`>>;
3223
+
3224
+ type TransactionsResponse = paths["/transactions"]["post"]["responses"][200]["content"]["application/json"];
3225
+ type TransactionsOptions = Partial<paths["/transactions"]["post"]["requestBody"]["content"]["application/json"]>;
3226
+ type GetTransactionsOptions = {
3227
+ apiClient: ApiClient;
3228
+ txHashes?: Address[];
3229
+ ipIds?: Address[];
3230
+ initiators?: Address[];
3231
+ eventTypes?: string[];
3232
+ options?: TransactionsOptions;
3233
+ apiKey: string;
3234
+ };
3235
+ declare function getTransactions({ apiClient, txHashes, ipIds, initiators, eventTypes, options, apiKey, }: GetTransactionsOptions): Promise<openapi_fetch.FetchResponse<{
3236
+ parameters: {
3237
+ query?: undefined;
3238
+ header?: undefined;
3239
+ path?: undefined;
3240
+ cookie?: undefined;
3241
+ };
3242
+ requestBody: {
3243
+ content: {
3244
+ "application/json": {
3245
+ readonly $schema?: string | undefined;
3246
+ orderBy: "blockNumber" | "createdAt" | "eventType" | "txHash" | "ipId" | "initiator";
3247
+ orderDirection: "asc" | "desc";
3248
+ pagination?: {
3249
+ limit: number;
3250
+ offset: number;
3251
+ } | undefined;
3252
+ where?: {
3253
+ blockGte?: number | undefined;
3254
+ blockLte?: number | undefined;
3255
+ eventTypes?: string[] | null | undefined;
3256
+ initiators?: string[] | null | undefined;
3257
+ ipIds?: string[] | null | undefined;
3258
+ txHashes?: string[] | null | undefined;
3259
+ } | undefined;
3260
+ };
3261
+ };
3262
+ };
3263
+ responses: {
3264
+ 200: {
3265
+ headers: {
3266
+ [name: string]: unknown;
3267
+ };
3268
+ content: {
3269
+ "application/json": {
3270
+ readonly $schema?: string | undefined;
3271
+ data: {
3272
+ blockNumber: number;
3273
+ createdAt: string;
3274
+ eventType: string;
3275
+ id: number;
3276
+ initiator: string;
3277
+ ipId: string;
3278
+ logIndex: number;
3279
+ txHash: string;
3280
+ }[] | null;
3281
+ pagination?: {
3282
+ hasMore: boolean;
3283
+ limit: number;
3284
+ offset: number;
3285
+ total?: number | undefined;
3286
+ } | undefined;
3287
+ };
3288
+ };
3289
+ };
3290
+ default: {
3291
+ headers: {
3292
+ [name: string]: unknown;
3293
+ };
3294
+ content: {
3295
+ "application/problem+json": {
3296
+ readonly $schema?: string | undefined;
3297
+ detail?: string | undefined;
3298
+ errors?: {
3299
+ location?: string | undefined;
3300
+ message?: string | undefined;
3301
+ value?: unknown;
3302
+ }[] | null | undefined;
3303
+ instance?: string | undefined;
3304
+ status?: number | undefined;
3305
+ title?: string | undefined;
3306
+ type: string;
3307
+ };
3308
+ };
3309
+ };
3310
+ };
3311
+ }, {
3312
+ params?: {
3313
+ query?: undefined;
3314
+ header?: undefined;
3315
+ path?: undefined;
3316
+ cookie?: undefined;
3317
+ } | undefined;
3318
+ } & {
3319
+ body: {
3320
+ readonly $schema?: string | undefined;
3321
+ orderBy: "blockNumber" | "createdAt" | "eventType" | "txHash" | "ipId" | "initiator";
3322
+ orderDirection: "asc" | "desc";
3323
+ pagination?: {
3324
+ limit: number;
3325
+ offset: number;
3326
+ } | undefined;
3327
+ where?: {
3328
+ blockGte?: number | undefined;
3329
+ blockLte?: number | undefined;
3330
+ eventTypes?: string[] | null | undefined;
3331
+ initiators?: string[] | null | undefined;
3332
+ ipIds?: string[] | null | undefined;
3333
+ txHashes?: string[] | null | undefined;
3334
+ } | undefined;
3335
+ };
3336
+ } & {
3337
+ baseUrl?: string | undefined;
3338
+ querySerializer?: openapi_fetch.QuerySerializerOptions | openapi_fetch.QuerySerializer<{
3339
+ parameters: {
3340
+ query?: undefined;
3341
+ header?: undefined;
3342
+ path?: undefined;
3343
+ cookie?: undefined;
3344
+ };
3345
+ requestBody: {
3346
+ content: {
3347
+ "application/json": {
3348
+ readonly $schema?: string | undefined;
3349
+ orderBy: "blockNumber" | "createdAt" | "eventType" | "txHash" | "ipId" | "initiator";
3350
+ orderDirection: "asc" | "desc";
3351
+ pagination?: {
3352
+ limit: number;
3353
+ offset: number;
3354
+ } | undefined;
3355
+ where?: {
3356
+ blockGte?: number | undefined;
3357
+ blockLte?: number | undefined;
3358
+ eventTypes?: string[] | null | undefined;
3359
+ initiators?: string[] | null | undefined;
3360
+ ipIds?: string[] | null | undefined;
3361
+ txHashes?: string[] | null | undefined;
3362
+ } | undefined;
3363
+ };
3364
+ };
3365
+ };
3366
+ responses: {
3367
+ 200: {
3368
+ headers: {
3369
+ [name: string]: unknown;
3370
+ };
3371
+ content: {
3372
+ "application/json": {
3373
+ readonly $schema?: string | undefined;
3374
+ data: {
3375
+ blockNumber: number;
3376
+ createdAt: string;
3377
+ eventType: string;
3378
+ id: number;
3379
+ initiator: string;
3380
+ ipId: string;
3381
+ logIndex: number;
3382
+ txHash: string;
3383
+ }[] | null;
3384
+ pagination?: {
3385
+ hasMore: boolean;
3386
+ limit: number;
3387
+ offset: number;
3388
+ total?: number | undefined;
3389
+ } | undefined;
3390
+ };
3391
+ };
3392
+ };
3393
+ default: {
3394
+ headers: {
3395
+ [name: string]: unknown;
3396
+ };
3397
+ content: {
3398
+ "application/problem+json": {
3399
+ readonly $schema?: string | undefined;
3400
+ detail?: string | undefined;
3401
+ errors?: {
3402
+ location?: string | undefined;
3403
+ message?: string | undefined;
3404
+ value?: unknown;
3405
+ }[] | null | undefined;
3406
+ instance?: string | undefined;
3407
+ status?: number | undefined;
3408
+ title?: string | undefined;
3409
+ type: string;
3410
+ };
3411
+ };
3412
+ };
3413
+ };
3414
+ }> | undefined;
3415
+ bodySerializer?: openapi_fetch.BodySerializer<{
3416
+ parameters: {
3417
+ query?: undefined;
3418
+ header?: undefined;
3419
+ path?: undefined;
3420
+ cookie?: undefined;
3421
+ };
3422
+ requestBody: {
3423
+ content: {
3424
+ "application/json": {
3425
+ readonly $schema?: string | undefined;
3426
+ orderBy: "blockNumber" | "createdAt" | "eventType" | "txHash" | "ipId" | "initiator";
3427
+ orderDirection: "asc" | "desc";
3428
+ pagination?: {
3429
+ limit: number;
3430
+ offset: number;
3431
+ } | undefined;
3432
+ where?: {
3433
+ blockGte?: number | undefined;
3434
+ blockLte?: number | undefined;
3435
+ eventTypes?: string[] | null | undefined;
3436
+ initiators?: string[] | null | undefined;
3437
+ ipIds?: string[] | null | undefined;
3438
+ txHashes?: string[] | null | undefined;
3439
+ } | undefined;
3440
+ };
3441
+ };
3442
+ };
3443
+ responses: {
3444
+ 200: {
3445
+ headers: {
3446
+ [name: string]: unknown;
3447
+ };
3448
+ content: {
3449
+ "application/json": {
3450
+ readonly $schema?: string | undefined;
3451
+ data: {
3452
+ blockNumber: number;
3453
+ createdAt: string;
3454
+ eventType: string;
3455
+ id: number;
3456
+ initiator: string;
3457
+ ipId: string;
3458
+ logIndex: number;
3459
+ txHash: string;
3460
+ }[] | null;
3461
+ pagination?: {
3462
+ hasMore: boolean;
3463
+ limit: number;
3464
+ offset: number;
3465
+ total?: number | undefined;
3466
+ } | undefined;
3467
+ };
3468
+ };
3469
+ };
3470
+ default: {
3471
+ headers: {
3472
+ [name: string]: unknown;
3473
+ };
3474
+ content: {
3475
+ "application/problem+json": {
3476
+ readonly $schema?: string | undefined;
3477
+ detail?: string | undefined;
3478
+ errors?: {
3479
+ location?: string | undefined;
3480
+ message?: string | undefined;
3481
+ value?: unknown;
3482
+ }[] | null | undefined;
3483
+ instance?: string | undefined;
3484
+ status?: number | undefined;
3485
+ title?: string | undefined;
3486
+ type: string;
3487
+ };
3488
+ };
3489
+ };
3490
+ };
3491
+ }> | undefined;
3492
+ parseAs?: keyof openapi_fetch.BodyType<unknown> | undefined;
3493
+ fetch?: ((input: Request) => Promise<Response>) | undefined;
3494
+ headers?: openapi_fetch.HeadersOptions | undefined;
3495
+ } & Omit<RequestInit, "headers" | "body"> & {
3496
+ readonly $schema?: string | undefined;
3497
+ orderBy: "blockNumber" | "createdAt" | "eventType" | "txHash" | "ipId" | "initiator";
3498
+ orderDirection: "asc" | "desc";
3499
+ pagination?: {
3500
+ limit: number;
3501
+ offset: number;
3502
+ } | undefined;
3503
+ where?: {
3504
+ blockGte?: number | undefined;
3505
+ blockLte?: number | undefined;
3506
+ eventTypes?: string[] | null | undefined;
3507
+ initiators?: string[] | null | undefined;
3508
+ ipIds?: string[] | null | undefined;
3509
+ txHashes?: string[] | null | undefined;
3510
+ } | undefined;
3511
+ }, `${string}/${string}`>>;
3512
+
3513
+ declare enum API_URL {
3514
+ STAGING = "https://staging-api.storyprotocol.net/api/v4",
3515
+ PRODUCTION = "https://api.storyapis.com/api/v4"
3516
+ }
3517
+
3518
+ type UseCollectionOptions = {
3519
+ collectionAddress: Address;
3520
+ queryOptions?: IpQueryOptions;
3521
+ };
3522
+ declare function useCollection({ collectionAddress, queryOptions, }: UseCollectionOptions): UseQueryResult<Collection | null>;
3523
+
3524
+ type UseCollectionsOptions = {
3525
+ collectionAddresses?: Address[];
3526
+ options?: CollectionsOptions;
3527
+ queryOptions?: IpQueryOptions;
3528
+ };
3529
+ declare function useCollections({ collectionAddresses, options, queryOptions, }?: UseCollectionsOptions): UseQueryResult<CollectionsResponse>;
3530
+
3531
+ type UseDisputeOptions = {
3532
+ disputeId: string;
3533
+ queryOptions?: IpQueryOptions;
3534
+ };
3535
+ declare function useDispute({ disputeId, queryOptions }: UseDisputeOptions): UseQueryResult<Dispute | null>;
3536
+
3537
+ type UseDisputesOptions = {
3538
+ options?: DisputesOptions;
3539
+ queryOptions?: IpQueryOptions;
3540
+ initiator?: Address;
3541
+ targetIpId?: Address;
3542
+ };
3543
+ declare function useDisputes({ initiator, targetIpId, options, queryOptions, }?: UseDisputesOptions): UseQueryResult<DisputesResponse>;
3544
+
3545
+ type UseIpAssetOptions = {
3546
+ ipId: Address;
3547
+ includeLicenses?: boolean;
3548
+ queryOptions?: IpQueryOptions;
3549
+ };
3550
+ declare function useIpAsset({ ipId, includeLicenses, queryOptions }: UseIpAssetOptions): UseQueryResult<IPAsset | null>;
3551
+
3552
+ type UseIpAssetChildrenOptions = {
3553
+ ipId?: Address;
3554
+ options?: IpAssetEdgesOptions;
3555
+ queryOptions?: IpQueryOptions;
3556
+ };
3557
+ declare function useIpAssetChildren({ ipId, options, queryOptions, }?: UseIpAssetChildrenOptions): UseQueryResult<IpAssetEdgesResponse>;
3558
+
3559
+ type UseIpAssetEdgesOptions = {
3560
+ ipId?: Address;
3561
+ parentIpId?: Address;
3562
+ options?: IpAssetEdgesOptions;
3563
+ queryOptions?: IpQueryOptions;
3564
+ };
3565
+ declare function useIpAssetEdges({ ipId, parentIpId, options, queryOptions, }?: UseIpAssetEdgesOptions): UseQueryResult<IpAssetEdgesResponse>;
3566
+
3567
+ type UseIpAssetLicensesOptions = {
3568
+ ipId: Address;
3569
+ queryOptions?: IpQueryOptions;
3570
+ };
3571
+ declare function useIpAssetLicenses({ ipId, queryOptions, }: UseIpAssetLicensesOptions): UseQueryResult<License[] | null>;
3572
+
3573
+ type UseIpAssetParentsOptions = {
3574
+ ipId?: Address;
3575
+ options?: IpAssetEdgesOptions;
3576
+ queryOptions?: IpQueryOptions;
3577
+ };
3578
+ declare function useIpAssetParents({ ipId, options, queryOptions, }?: UseIpAssetParentsOptions): UseQueryResult<IpAssetEdgesResponse>;
3579
+
3580
+ type UseIpAssetsOptions = {
3581
+ ipIds?: Address[];
3582
+ tokenContract?: Address;
3583
+ includeLicenses?: boolean;
3584
+ moderated?: boolean;
3585
+ options?: IpAssetsOptions;
3586
+ queryOptions?: IpQueryOptions;
3587
+ };
3588
+ declare function useIpAssets({ ipIds, tokenContract, includeLicenses, moderated, options, queryOptions, }?: UseIpAssetsOptions): UseQueryResult<IpAssetsResponse>;
3589
+
3590
+ type UseIpAssetsByOwnerOptions = {
3591
+ ownerAddress?: Address;
3592
+ includeLicenses?: boolean;
3593
+ moderated?: boolean;
3594
+ options?: IpAssetsOptions;
3595
+ queryOptions?: IpQueryOptions;
3596
+ };
3597
+ declare function useIpAssetsByOwner({ ownerAddress, includeLicenses, moderated, options, queryOptions, }?: UseIpAssetsByOwnerOptions): UseQueryResult<IpAssetsResponse>;
3598
+
3599
+ type UseSearchOptions = {
3600
+ query: string;
3601
+ mediaType?: "audio" | "video" | "image";
3602
+ queryOptions?: IpQueryOptions;
3603
+ };
3604
+ declare function useSearch({ query, mediaType, queryOptions }: UseSearchOptions): UseQueryResult<SearchResponse>;
3605
+
3606
+ type UseTransactionOptions = {
3607
+ txHash: Address;
3608
+ queryOptions?: IpQueryOptions;
3609
+ };
3610
+ declare function useTransaction({ txHash, queryOptions }: UseTransactionOptions): UseQueryResult<IPTransaction | null>;
3611
+
3612
+ type UseTransactionsOptions = {
3613
+ txHashes?: Address[];
3614
+ ipIds?: Address[];
3615
+ initiators?: Address[];
3616
+ eventTypes?: string[];
3617
+ options?: TransactionsOptions;
3618
+ queryOptions?: IpQueryOptions;
3619
+ };
3620
+ declare function useTransactions({ txHashes, ipIds, initiators, eventTypes, options, queryOptions, }?: UseTransactionsOptions): UseQueryResult<TransactionsResponse>;
3621
+
3622
+ export { API_URL, type ApiClient, CHAINID_TO_CHAINNAME, CHAINS, type ChainConfig, type Collection, type CollectionMetadata, type CollectionsOptions, type CollectionsResponse, type ContractMetadata, type Creator, type Dispute, type DisputeResponse, type DisputesOptions, type DisputesResponse, type ERC20Token, type GetCollectionsOptions, type GetDisputeOptions, type GetDisputesOptions, type GetIpAssetEdgesOptions, type GetIpAssetsOptions, type GetSearchOptions, type GetTransactionsOptions, type IPAsset, type IPAssetEdge, IPKIT_SUPPORTED_CHAIN, type IPMetadata, type IPSearchResult, type IPTransaction, type InfringementStatus, type IpAssetEdgesOptions, type IpAssetEdgesResponse, type IpAssetsOptions, type IpAssetsResponse, IpKitProvider, type IpKitProviderOptions, type IpQueryOptions, type License, type LicenseOffChainData, type LicenseTerms$1 as LicenseTerms, type LicenseTermsWithOffChainData, type LicenseWithOffChainData, type LicensingConfig, type Mode, type ModerationStatus, type NFTMetadata, type PILTerms, type PILTermsWithOffChainData, PIL_FLAVOR, type PilFlavor, STORY_AENEID, STORY_MAINNET, type SearchOptions, type SearchResponse, type SocialMedia, type SupportedChainConfig, type Theme, type Trait, type TransactionEventType, type TransactionsOptions, type TransactionsResponse, type UseCollectionOptions, type UseCollectionsOptions, type UseDisputeOptions, type UseDisputesOptions, type UseIpAssetChildrenOptions, type UseIpAssetEdgesOptions, type UseIpAssetLicensesOptions, type UseIpAssetOptions, type UseIpAssetParentsOptions, type UseIpAssetsByOwnerOptions, type UseIpAssetsOptions, type UseSearchOptions, type UseTransactionOptions, type UseTransactionsOptions, WRAPPED_IP, camelize, cn, type components, convertIpfsUriToUrl, convertLicenseTermObject, createApiClient, fetchLicenseOffChainData, getCollections, getDispute, getDisputes, getImageUrlFromIpfsUrl, getIpAssetEdges, getIpAssets, getMetadataFromIpfs, getPilFlavorByLicenseTerms, getSearch, getTransactions, type operations, type paths, prodClient, shortenAddress, stagingClient, useCollection, useCollections, useDispute, useDisputes, useIpAsset, useIpAssetChildren, useIpAssetEdges, useIpAssetLicenses, useIpAssetParents, useIpAssets, useIpAssetsByOwner, useIpKit, useSearch, useTransaction, useTransactions };