@imtbl/sdk 1.10.0-alpha.1 → 1.11.0

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.
@@ -1041,19 +1041,43 @@ interface CollectionMetadata$1 {
1041
1041
  * https://openapi-generator.tech
1042
1042
  * Do not edit the class manually.
1043
1043
  */
1044
+ /**
1045
+ * @type NFTMetadataAttributeValue
1046
+ * The metadata trait value
1047
+ * @export
1048
+ */
1049
+ type NFTMetadataAttributeValue$1 = boolean | number | string;
1044
1050
 
1045
1051
  /**
1046
- * Single activity
1052
+ * Immutable zkEVM API
1053
+ * Immutable Multi Rollup API
1054
+ *
1055
+ * The version of the OpenAPI document: 1.0.0
1056
+ * Contact: support@immutable.com
1057
+ *
1058
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1059
+ * https://openapi-generator.tech
1060
+ * Do not edit the class manually.
1061
+ */
1062
+
1063
+ /**
1064
+ *
1047
1065
  * @export
1048
- * @interface GetActivityResult
1066
+ * @interface NFTMetadataAttribute
1049
1067
  */
1050
- interface GetActivityResult$1 {
1068
+ interface NFTMetadataAttribute$1 {
1069
+ /**
1070
+ * The metadata trait type
1071
+ * @type {string}
1072
+ * @memberof NFTMetadataAttribute
1073
+ */
1074
+ 'trait_type': string;
1051
1075
  /**
1052
1076
  *
1053
- * @type {Activity}
1054
- * @memberof GetActivityResult
1077
+ * @type {NFTMetadataAttributeValue}
1078
+ * @memberof NFTMetadataAttribute
1055
1079
  */
1056
- 'result': Activity$1;
1080
+ 'value': NFTMetadataAttributeValue$1;
1057
1081
  }
1058
1082
 
1059
1083
  /**
@@ -1069,17 +1093,53 @@ interface GetActivityResult$1 {
1069
1093
  */
1070
1094
 
1071
1095
  /**
1072
- * Single Collection
1096
+ *
1073
1097
  * @export
1074
- * @interface GetCollectionResult
1098
+ * @interface NFTMetadataRequest
1075
1099
  */
1076
- interface GetCollectionResult$1 {
1100
+ interface NFTMetadataRequest$1 {
1077
1101
  /**
1078
- *
1079
- * @type {Collection}
1080
- * @memberof GetCollectionResult
1102
+ * The name of the NFT
1103
+ * @type {string}
1104
+ * @memberof NFTMetadataRequest
1081
1105
  */
1082
- 'result': Collection$1;
1106
+ 'name'?: string | null;
1107
+ /**
1108
+ * The description of the NFT
1109
+ * @type {string}
1110
+ * @memberof NFTMetadataRequest
1111
+ */
1112
+ 'description'?: string | null;
1113
+ /**
1114
+ * The image url of the NFT
1115
+ * @type {string}
1116
+ * @memberof NFTMetadataRequest
1117
+ */
1118
+ 'image'?: string | null;
1119
+ /**
1120
+ * The external link of the NFT
1121
+ * @type {string}
1122
+ * @memberof NFTMetadataRequest
1123
+ */
1124
+ 'external_url'?: string | null;
1125
+ /**
1126
+ * The animation url of the NFT
1127
+ * @type {string}
1128
+ * @memberof NFTMetadataRequest
1129
+ */
1130
+ 'animation_url'?: string | null;
1131
+ /**
1132
+ * The youtube link of the NFT
1133
+ * @type {string}
1134
+ * @memberof NFTMetadataRequest
1135
+ */
1136
+ 'youtube_url'?: string | null;
1137
+ /**
1138
+ * List of Metadata attributes
1139
+ * @type {Array<NFTMetadataAttribute>}
1140
+ * @memberof NFTMetadataRequest
1141
+ */
1142
+ 'attributes'?: Array<NFTMetadataAttribute$1> | null;
1083
1143
  }
1084
1144
 
1085
1145
  /**
@@ -1093,12 +1153,32 @@ interface GetCollectionResult$1 {
1093
1153
  * https://openapi-generator.tech
1094
1154
  * Do not edit the class manually.
1095
1155
  */
1156
+
1096
1157
  /**
1097
- * @type NFTMetadataAttributeValue
1098
- * The metadata trait value
1158
+ *
1099
1159
  * @export
1160
+ * @interface MintAsset
1100
1161
  */
1101
- type NFTMetadataAttributeValue$1 = boolean | number | string;
1162
+ interface MintAsset$1 {
1163
+ /**
1164
+ * The ID of this asset in the system that originates the mint request
1165
+ * @type {string}
1166
+ * @memberof MintAsset
1167
+ */
1168
+ 'reference_id': string;
1169
+ /**
1170
+ * The address of the receiver
1171
+ * @type {string}
1172
+ * @memberof MintAsset
1173
+ */
1174
+ 'owner_address': string;
1175
+ /**
1176
+ *
1177
+ * @type {NFTMetadataRequest}
1178
+ * @memberof MintAsset
1179
+ */
1180
+ 'metadata'?: NFTMetadataRequest$1;
1181
+ }
1102
1182
 
1103
1183
  /**
1104
1184
  * Immutable zkEVM API
@@ -1115,21 +1195,110 @@ type NFTMetadataAttributeValue$1 = boolean | number | string;
1115
1195
  /**
1116
1196
  *
1117
1197
  * @export
1118
- * @interface NFTMetadataAttribute
1198
+ * @interface CreateMintRequestRequest
1119
1199
  */
1120
- interface NFTMetadataAttribute$1 {
1200
+ interface CreateMintRequestRequest$1 {
1121
1201
  /**
1122
- * The metadata trait type
1202
+ * List of nft to be minted
1203
+ * @type {Array<MintAsset>}
1204
+ * @memberof CreateMintRequestRequest
1205
+ */
1206
+ 'assets': Array<MintAsset$1>;
1207
+ }
1208
+
1209
+ /**
1210
+ * Immutable zkEVM API
1211
+ * Immutable Multi Rollup API
1212
+ *
1213
+ * The version of the OpenAPI document: 1.0.0
1214
+ * Contact: support@immutable.com
1215
+ *
1216
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1217
+ * https://openapi-generator.tech
1218
+ * Do not edit the class manually.
1219
+ */
1220
+ /**
1221
+ *
1222
+ * @export
1223
+ * @interface CreateMintRequestResult
1224
+ */
1225
+ interface CreateMintRequestResult$1 {
1226
+ /**
1227
+ *
1123
1228
  * @type {string}
1124
- * @memberof NFTMetadataAttribute
1229
+ * @memberof CreateMintRequestResult
1125
1230
  */
1126
- 'trait_type': string;
1231
+ 'imx_mint_requests_limit': string;
1127
1232
  /**
1128
1233
  *
1129
- * @type {NFTMetadataAttributeValue}
1130
- * @memberof NFTMetadataAttribute
1234
+ * @type {string}
1235
+ * @memberof CreateMintRequestResult
1131
1236
  */
1132
- 'value': NFTMetadataAttributeValue$1;
1237
+ 'imx_mint_requests_limit_reset': string;
1238
+ /**
1239
+ *
1240
+ * @type {string}
1241
+ * @memberof CreateMintRequestResult
1242
+ */
1243
+ 'imx_remaining_mint_requests': string;
1244
+ /**
1245
+ *
1246
+ * @type {string}
1247
+ * @memberof CreateMintRequestResult
1248
+ */
1249
+ 'imx_mint_requests_retry_after': string;
1250
+ }
1251
+
1252
+ /**
1253
+ * Immutable zkEVM API
1254
+ * Immutable Multi Rollup API
1255
+ *
1256
+ * The version of the OpenAPI document: 1.0.0
1257
+ * Contact: support@immutable.com
1258
+ *
1259
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1260
+ * https://openapi-generator.tech
1261
+ * Do not edit the class manually.
1262
+ */
1263
+
1264
+ /**
1265
+ * Single activity
1266
+ * @export
1267
+ * @interface GetActivityResult
1268
+ */
1269
+ interface GetActivityResult$1 {
1270
+ /**
1271
+ *
1272
+ * @type {Activity}
1273
+ * @memberof GetActivityResult
1274
+ */
1275
+ 'result': Activity$1;
1276
+ }
1277
+
1278
+ /**
1279
+ * Immutable zkEVM API
1280
+ * Immutable Multi Rollup API
1281
+ *
1282
+ * The version of the OpenAPI document: 1.0.0
1283
+ * Contact: support@immutable.com
1284
+ *
1285
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1286
+ * https://openapi-generator.tech
1287
+ * Do not edit the class manually.
1288
+ */
1289
+
1290
+ /**
1291
+ * Single Collection
1292
+ * @export
1293
+ * @interface GetCollectionResult
1294
+ */
1295
+ interface GetCollectionResult$1 {
1296
+ /**
1297
+ *
1298
+ * @type {Collection}
1299
+ * @memberof GetCollectionResult
1300
+ */
1301
+ 'result': Collection$1;
1133
1302
  }
1134
1303
 
1135
1304
  /**
@@ -1250,6 +1419,140 @@ interface GetMetadataResult$1 {
1250
1419
  'result': Metadata$1;
1251
1420
  }
1252
1421
 
1422
+ /**
1423
+ * Immutable zkEVM API
1424
+ * Immutable Multi Rollup API
1425
+ *
1426
+ * The version of the OpenAPI document: 1.0.0
1427
+ * Contact: support@immutable.com
1428
+ *
1429
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1430
+ * https://openapi-generator.tech
1431
+ * Do not edit the class manually.
1432
+ */
1433
+ /**
1434
+ *
1435
+ * @export
1436
+ * @interface MintRequestErrorMessage
1437
+ */
1438
+ interface MintRequestErrorMessage$1 {
1439
+ /**
1440
+ * An error message in case the mint request fails
1441
+ * @type {string}
1442
+ * @memberof MintRequestErrorMessage
1443
+ */
1444
+ 'message'?: string;
1445
+ }
1446
+
1447
+ /**
1448
+ * Immutable zkEVM API
1449
+ * Immutable Multi Rollup API
1450
+ *
1451
+ * The version of the OpenAPI document: 1.0.0
1452
+ * Contact: support@immutable.com
1453
+ *
1454
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1455
+ * https://openapi-generator.tech
1456
+ * Do not edit the class manually.
1457
+ */
1458
+ /**
1459
+ * The status of the mint request
1460
+ * @export
1461
+ * @enum {string}
1462
+ */
1463
+ declare const MintRequestStatus$1: {
1464
+ readonly Pending: "pending";
1465
+ readonly Succeeded: "succeeded";
1466
+ readonly Failed: "failed";
1467
+ };
1468
+ type MintRequestStatus$1 = typeof MintRequestStatus$1[keyof typeof MintRequestStatus$1];
1469
+
1470
+ /**
1471
+ * Immutable zkEVM API
1472
+ * Immutable Multi Rollup API
1473
+ *
1474
+ * The version of the OpenAPI document: 1.0.0
1475
+ * Contact: support@immutable.com
1476
+ *
1477
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1478
+ * https://openapi-generator.tech
1479
+ * Do not edit the class manually.
1480
+ */
1481
+
1482
+ /**
1483
+ *
1484
+ * @export
1485
+ * @interface GetMintRequestResult
1486
+ */
1487
+ interface GetMintRequestResult$1 {
1488
+ /**
1489
+ *
1490
+ * @type {Chain}
1491
+ * @memberof GetMintRequestResult
1492
+ */
1493
+ 'chain': Chain$1;
1494
+ /**
1495
+ * The address of the contract
1496
+ * @type {string}
1497
+ * @memberof GetMintRequestResult
1498
+ */
1499
+ 'collection_address': string;
1500
+ /**
1501
+ * The reference ID of this mint request
1502
+ * @type {string}
1503
+ * @memberof GetMintRequestResult
1504
+ */
1505
+ 'reference_id': string;
1506
+ /**
1507
+ * The address of the owner of the NFT
1508
+ * @type {string}
1509
+ * @memberof GetMintRequestResult
1510
+ */
1511
+ 'owner_address': string;
1512
+ /**
1513
+ * An `uint256` token id as string. Only available when the mint request succeeds
1514
+ * @type {string}
1515
+ * @memberof GetMintRequestResult
1516
+ */
1517
+ 'token_id': string | null;
1518
+ /**
1519
+ * The id of the mint activity associated with this mint request
1520
+ * @type {string}
1521
+ * @memberof GetMintRequestResult
1522
+ */
1523
+ 'activity_id'?: string | null;
1524
+ /**
1525
+ * The transaction hash of the activity
1526
+ * @type {string}
1527
+ * @memberof GetMintRequestResult
1528
+ */
1529
+ 'transaction_hash': string | null;
1530
+ /**
1531
+ * When the mint request was created
1532
+ * @type {string}
1533
+ * @memberof GetMintRequestResult
1534
+ */
1535
+ 'created_at': string;
1536
+ /**
1537
+ * When the mint request was last updated
1538
+ * @type {string}
1539
+ * @memberof GetMintRequestResult
1540
+ */
1541
+ 'updated_at': string;
1542
+ /**
1543
+ *
1544
+ * @type {MintRequestErrorMessage}
1545
+ * @memberof GetMintRequestResult
1546
+ */
1547
+ 'error': MintRequestErrorMessage$1 | null;
1548
+ /**
1549
+ *
1550
+ * @type {MintRequestStatus}
1551
+ * @memberof GetMintRequestResult
1552
+ */
1553
+ 'status': MintRequestStatus$1;
1554
+ }
1555
+
1253
1556
  /**
1254
1557
  * Immutable zkEVM API
1255
1558
  * Immutable Multi Rollup API
@@ -1633,6 +1936,38 @@ interface ListMetadataResult$1 {
1633
1936
  'page': Page$1;
1634
1937
  }
1635
1938
 
1939
+ /**
1940
+ * Immutable zkEVM API
1941
+ * Immutable Multi Rollup API
1942
+ *
1943
+ * The version of the OpenAPI document: 1.0.0
1944
+ * Contact: support@immutable.com
1945
+ *
1946
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1947
+ * https://openapi-generator.tech
1948
+ * Do not edit the class manually.
1949
+ */
1950
+
1951
+ /**
1952
+ * List mint requests
1953
+ * @export
1954
+ * @interface ListMintRequestsResult
1955
+ */
1956
+ interface ListMintRequestsResult$1 {
1957
+ /**
1958
+ * List of mint requests
1959
+ * @type {Array<GetMintRequestResult>}
1960
+ * @memberof ListMintRequestsResult
1961
+ */
1962
+ 'result': Array<GetMintRequestResult$1>;
1963
+ /**
1964
+ *
1965
+ * @type {Page}
1966
+ * @memberof ListMintRequestsResult
1967
+ */
1968
+ 'page': Page$1;
1969
+ }
1970
+
1636
1971
  /**
1637
1972
  * Immutable zkEVM API
1638
1973
  * Immutable Multi Rollup API
@@ -1828,68 +2163,6 @@ interface MetadataRefreshRateLimitResult$1 {
1828
2163
  'retry_after': string;
1829
2164
  }
1830
2165
 
1831
- /**
1832
- * Immutable zkEVM API
1833
- * Immutable Multi Rollup API
1834
- *
1835
- * The version of the OpenAPI document: 1.0.0
1836
- * Contact: support@immutable.com
1837
- *
1838
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
1839
- * https://openapi-generator.tech
1840
- * Do not edit the class manually.
1841
- */
1842
-
1843
- /**
1844
- *
1845
- * @export
1846
- * @interface NFTMetadataRequest
1847
- */
1848
- interface NFTMetadataRequest$1 {
1849
- /**
1850
- * The name of the NFT
1851
- * @type {string}
1852
- * @memberof NFTMetadataRequest
1853
- */
1854
- 'name'?: string | null;
1855
- /**
1856
- * The description of the NFT
1857
- * @type {string}
1858
- * @memberof NFTMetadataRequest
1859
- */
1860
- 'description'?: string | null;
1861
- /**
1862
- * The image url of the NFT
1863
- * @type {string}
1864
- * @memberof NFTMetadataRequest
1865
- */
1866
- 'image'?: string | null;
1867
- /**
1868
- * The external link of the NFT
1869
- * @type {string}
1870
- * @memberof NFTMetadataRequest
1871
- */
1872
- 'external_url'?: string | null;
1873
- /**
1874
- * The animation url of the NFT
1875
- * @type {string}
1876
- * @memberof NFTMetadataRequest
1877
- */
1878
- 'animation_url'?: string | null;
1879
- /**
1880
- * The youtube link of the NFT
1881
- * @type {string}
1882
- * @memberof NFTMetadataRequest
1883
- */
1884
- 'youtube_url'?: string | null;
1885
- /**
1886
- * List of Metadata attributes
1887
- * @type {Array<NFTMetadataAttribute>}
1888
- * @memberof NFTMetadataRequest
1889
- */
1890
- 'attributes'?: Array<NFTMetadataAttribute$1> | null;
1891
- }
1892
-
1893
2166
  /**
1894
2167
  * Immutable zkEVM API
1895
2168
  * Immutable Multi Rollup API
@@ -2540,46 +2813,96 @@ interface NftOwnersApiListNFTOwnersRequest {
2540
2813
  * @type {number}
2541
2814
  * @memberof NftOwnersApiListNFTOwners
2542
2815
  */
2543
- readonly pageSize?: number;
2816
+ readonly pageSize?: number;
2817
+ }
2818
+ /**
2819
+ * Request parameters for listOwnersByContractAddress operation in NftOwnersApi.
2820
+ * @export
2821
+ * @interface NftOwnersApiListOwnersByContractAddressRequest
2822
+ */
2823
+ interface NftOwnersApiListOwnersByContractAddressRequest {
2824
+ /**
2825
+ * The address of contract
2826
+ * @type {string}
2827
+ * @memberof NftOwnersApiListOwnersByContractAddress
2828
+ */
2829
+ readonly contractAddress: string;
2830
+ /**
2831
+ * The name of chain
2832
+ * @type {string}
2833
+ * @memberof NftOwnersApiListOwnersByContractAddress
2834
+ */
2835
+ readonly chainName: string;
2836
+ /**
2837
+ * Datetime to use as the oldest updated timestamp
2838
+ * @type {string}
2839
+ * @memberof NftOwnersApiListOwnersByContractAddress
2840
+ */
2841
+ readonly fromUpdatedAt?: string;
2842
+ /**
2843
+ * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
2844
+ * @type {string}
2845
+ * @memberof NftOwnersApiListOwnersByContractAddress
2846
+ */
2847
+ readonly pageCursor?: string;
2848
+ /**
2849
+ * Maximum number of items to return
2850
+ * @type {number}
2851
+ * @memberof NftOwnersApiListOwnersByContractAddress
2852
+ */
2853
+ readonly pageSize?: number;
2854
+ }
2855
+
2856
+ /**
2857
+ * Request parameters for createMintRequest operation in NftsApi.
2858
+ * @export
2859
+ * @interface NftsApiCreateMintRequestRequest
2860
+ */
2861
+ interface NftsApiCreateMintRequestRequest {
2862
+ /**
2863
+ * The address of contract
2864
+ * @type {string}
2865
+ * @memberof NftsApiCreateMintRequest
2866
+ */
2867
+ readonly contractAddress: string;
2868
+ /**
2869
+ * The name of chain
2870
+ * @type {string}
2871
+ * @memberof NftsApiCreateMintRequest
2872
+ */
2873
+ readonly chainName: string;
2874
+ /**
2875
+ * the request body
2876
+ * @type {CreateMintRequestRequest}
2877
+ * @memberof NftsApiCreateMintRequest
2878
+ */
2879
+ readonly createMintRequestRequest: CreateMintRequestRequest$1;
2544
2880
  }
2545
2881
  /**
2546
- * Request parameters for listOwnersByContractAddress operation in NftOwnersApi.
2882
+ * Request parameters for getMintRequest operation in NftsApi.
2547
2883
  * @export
2548
- * @interface NftOwnersApiListOwnersByContractAddressRequest
2884
+ * @interface NftsApiGetMintRequestRequest
2549
2885
  */
2550
- interface NftOwnersApiListOwnersByContractAddressRequest {
2886
+ interface NftsApiGetMintRequestRequest {
2551
2887
  /**
2552
2888
  * The address of contract
2553
2889
  * @type {string}
2554
- * @memberof NftOwnersApiListOwnersByContractAddress
2890
+ * @memberof NftsApiGetMintRequest
2555
2891
  */
2556
2892
  readonly contractAddress: string;
2557
2893
  /**
2558
2894
  * The name of chain
2559
2895
  * @type {string}
2560
- * @memberof NftOwnersApiListOwnersByContractAddress
2896
+ * @memberof NftsApiGetMintRequest
2561
2897
  */
2562
2898
  readonly chainName: string;
2563
2899
  /**
2564
- * Datetime to use as the oldest updated timestamp
2565
- * @type {string}
2566
- * @memberof NftOwnersApiListOwnersByContractAddress
2567
- */
2568
- readonly fromUpdatedAt?: string;
2569
- /**
2570
- * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
2900
+ * The ID of the mint request
2571
2901
  * @type {string}
2572
- * @memberof NftOwnersApiListOwnersByContractAddress
2573
- */
2574
- readonly pageCursor?: string;
2575
- /**
2576
- * Maximum number of items to return
2577
- * @type {number}
2578
- * @memberof NftOwnersApiListOwnersByContractAddress
2902
+ * @memberof NftsApiGetMintRequest
2579
2903
  */
2580
- readonly pageSize?: number;
2904
+ readonly referenceId: string;
2581
2905
  }
2582
-
2583
2906
  /**
2584
2907
  * Request parameters for getNFT operation in NftsApi.
2585
2908
  * @export
@@ -2636,6 +2959,43 @@ interface NftsApiListAllNFTsRequest {
2636
2959
  */
2637
2960
  readonly pageSize?: number;
2638
2961
  }
2962
+ /**
2963
+ * Request parameters for listMintRequests operation in NftsApi.
2964
+ * @export
2965
+ * @interface NftsApiListMintRequestsRequest
2966
+ */
2967
+ interface NftsApiListMintRequestsRequest {
2968
+ /**
2969
+ * The address of contract
2970
+ * @type {string}
2971
+ * @memberof NftsApiListMintRequests
2972
+ */
2973
+ readonly contractAddress: string;
2974
+ /**
2975
+ * The name of chain
2976
+ * @type {string}
2977
+ * @memberof NftsApiListMintRequests
2978
+ */
2979
+ readonly chainName: string;
2980
+ /**
2981
+ * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
2982
+ * @type {string}
2983
+ * @memberof NftsApiListMintRequests
2984
+ */
2985
+ readonly pageCursor?: string;
2986
+ /**
2987
+ * Maximum number of items to return
2988
+ * @type {number}
2989
+ * @memberof NftsApiListMintRequests
2990
+ */
2991
+ readonly pageSize?: number;
2992
+ /**
2993
+ * The status of the mint request
2994
+ * @type {MintRequestStatus}
2995
+ * @memberof NftsApiListMintRequests
2996
+ */
2997
+ readonly status?: MintRequestStatus$1;
2998
+ }
2639
2999
  /**
2640
3000
  * Request parameters for listNFTs operation in NftsApi.
2641
3001
  * @export
@@ -4126,17 +4486,236 @@ interface CollectionMetadata {
4126
4486
  */
4127
4487
  'external_link': string | null;
4128
4488
  /**
4129
- * The uri for the metadata of the collection
4489
+ * The uri for the metadata of the collection
4490
+ * @type {string}
4491
+ * @memberof CollectionMetadata
4492
+ */
4493
+ 'contract_uri': string | null;
4494
+ /**
4495
+ * The metadata uri for nft
4496
+ * @type {string}
4497
+ * @memberof CollectionMetadata
4498
+ */
4499
+ 'base_uri': string | null;
4500
+ }
4501
+
4502
+ /**
4503
+ * Immutable zkEVM API
4504
+ * Immutable Multi Rollup API
4505
+ *
4506
+ * The version of the OpenAPI document: 1.0.0
4507
+ * Contact: support@immutable.com
4508
+ *
4509
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
4510
+ * https://openapi-generator.tech
4511
+ * Do not edit the class manually.
4512
+ */
4513
+ /**
4514
+ * @type NFTMetadataAttributeValue
4515
+ * The metadata trait value
4516
+ * @export
4517
+ */
4518
+ type NFTMetadataAttributeValue = boolean | number | string;
4519
+
4520
+ /**
4521
+ * Immutable zkEVM API
4522
+ * Immutable Multi Rollup API
4523
+ *
4524
+ * The version of the OpenAPI document: 1.0.0
4525
+ * Contact: support@immutable.com
4526
+ *
4527
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
4528
+ * https://openapi-generator.tech
4529
+ * Do not edit the class manually.
4530
+ */
4531
+
4532
+ /**
4533
+ *
4534
+ * @export
4535
+ * @interface NFTMetadataAttribute
4536
+ */
4537
+ interface NFTMetadataAttribute {
4538
+ /**
4539
+ * The metadata trait type
4540
+ * @type {string}
4541
+ * @memberof NFTMetadataAttribute
4542
+ */
4543
+ 'trait_type': string;
4544
+ /**
4545
+ *
4546
+ * @type {NFTMetadataAttributeValue}
4547
+ * @memberof NFTMetadataAttribute
4548
+ */
4549
+ 'value': NFTMetadataAttributeValue;
4550
+ }
4551
+
4552
+ /**
4553
+ * Immutable zkEVM API
4554
+ * Immutable Multi Rollup API
4555
+ *
4556
+ * The version of the OpenAPI document: 1.0.0
4557
+ * Contact: support@immutable.com
4558
+ *
4559
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
4560
+ * https://openapi-generator.tech
4561
+ * Do not edit the class manually.
4562
+ */
4563
+
4564
+ /**
4565
+ *
4566
+ * @export
4567
+ * @interface NFTMetadataRequest
4568
+ */
4569
+ interface NFTMetadataRequest {
4570
+ /**
4571
+ * The name of the NFT
4572
+ * @type {string}
4573
+ * @memberof NFTMetadataRequest
4574
+ */
4575
+ 'name'?: string | null;
4576
+ /**
4577
+ * The description of the NFT
4578
+ * @type {string}
4579
+ * @memberof NFTMetadataRequest
4580
+ */
4581
+ 'description'?: string | null;
4582
+ /**
4583
+ * The image url of the NFT
4584
+ * @type {string}
4585
+ * @memberof NFTMetadataRequest
4586
+ */
4587
+ 'image'?: string | null;
4588
+ /**
4589
+ * The external link of the NFT
4590
+ * @type {string}
4591
+ * @memberof NFTMetadataRequest
4592
+ */
4593
+ 'external_url'?: string | null;
4594
+ /**
4595
+ * The animation url of the NFT
4596
+ * @type {string}
4597
+ * @memberof NFTMetadataRequest
4598
+ */
4599
+ 'animation_url'?: string | null;
4600
+ /**
4601
+ * The youtube link of the NFT
4602
+ * @type {string}
4603
+ * @memberof NFTMetadataRequest
4604
+ */
4605
+ 'youtube_url'?: string | null;
4606
+ /**
4607
+ * List of Metadata attributes
4608
+ * @type {Array<NFTMetadataAttribute>}
4609
+ * @memberof NFTMetadataRequest
4610
+ */
4611
+ 'attributes'?: Array<NFTMetadataAttribute> | null;
4612
+ }
4613
+
4614
+ /**
4615
+ * Immutable zkEVM API
4616
+ * Immutable Multi Rollup API
4617
+ *
4618
+ * The version of the OpenAPI document: 1.0.0
4619
+ * Contact: support@immutable.com
4620
+ *
4621
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
4622
+ * https://openapi-generator.tech
4623
+ * Do not edit the class manually.
4624
+ */
4625
+
4626
+ /**
4627
+ *
4628
+ * @export
4629
+ * @interface MintAsset
4630
+ */
4631
+ interface MintAsset {
4632
+ /**
4633
+ * The ID of this asset in the system that originates the mint request
4634
+ * @type {string}
4635
+ * @memberof MintAsset
4636
+ */
4637
+ 'reference_id': string;
4638
+ /**
4639
+ * The address of the receiver
4640
+ * @type {string}
4641
+ * @memberof MintAsset
4642
+ */
4643
+ 'owner_address': string;
4644
+ /**
4645
+ *
4646
+ * @type {NFTMetadataRequest}
4647
+ * @memberof MintAsset
4648
+ */
4649
+ 'metadata'?: NFTMetadataRequest;
4650
+ }
4651
+
4652
+ /**
4653
+ * Immutable zkEVM API
4654
+ * Immutable Multi Rollup API
4655
+ *
4656
+ * The version of the OpenAPI document: 1.0.0
4657
+ * Contact: support@immutable.com
4658
+ *
4659
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
4660
+ * https://openapi-generator.tech
4661
+ * Do not edit the class manually.
4662
+ */
4663
+
4664
+ /**
4665
+ *
4666
+ * @export
4667
+ * @interface CreateMintRequestRequest
4668
+ */
4669
+ interface CreateMintRequestRequest {
4670
+ /**
4671
+ * List of nft to be minted
4672
+ * @type {Array<MintAsset>}
4673
+ * @memberof CreateMintRequestRequest
4674
+ */
4675
+ 'assets': Array<MintAsset>;
4676
+ }
4677
+
4678
+ /**
4679
+ * Immutable zkEVM API
4680
+ * Immutable Multi Rollup API
4681
+ *
4682
+ * The version of the OpenAPI document: 1.0.0
4683
+ * Contact: support@immutable.com
4684
+ *
4685
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
4686
+ * https://openapi-generator.tech
4687
+ * Do not edit the class manually.
4688
+ */
4689
+ /**
4690
+ *
4691
+ * @export
4692
+ * @interface CreateMintRequestResult
4693
+ */
4694
+ interface CreateMintRequestResult {
4695
+ /**
4696
+ *
4697
+ * @type {string}
4698
+ * @memberof CreateMintRequestResult
4699
+ */
4700
+ 'imx_mint_requests_limit': string;
4701
+ /**
4702
+ *
4703
+ * @type {string}
4704
+ * @memberof CreateMintRequestResult
4705
+ */
4706
+ 'imx_mint_requests_limit_reset': string;
4707
+ /**
4708
+ *
4130
4709
  * @type {string}
4131
- * @memberof CollectionMetadata
4710
+ * @memberof CreateMintRequestResult
4132
4711
  */
4133
- 'contract_uri': string | null;
4712
+ 'imx_remaining_mint_requests': string;
4134
4713
  /**
4135
- * The metadata uri for nft
4714
+ *
4136
4715
  * @type {string}
4137
- * @memberof CollectionMetadata
4716
+ * @memberof CreateMintRequestResult
4138
4717
  */
4139
- 'base_uri': string | null;
4718
+ 'imx_mint_requests_retry_after': string;
4140
4719
  }
4141
4720
 
4142
4721
  /**
@@ -4329,56 +4908,6 @@ interface GetCollectionResult {
4329
4908
  'result': Collection;
4330
4909
  }
4331
4910
 
4332
- /**
4333
- * Immutable zkEVM API
4334
- * Immutable Multi Rollup API
4335
- *
4336
- * The version of the OpenAPI document: 1.0.0
4337
- * Contact: support@immutable.com
4338
- *
4339
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
4340
- * https://openapi-generator.tech
4341
- * Do not edit the class manually.
4342
- */
4343
- /**
4344
- * @type NFTMetadataAttributeValue
4345
- * The metadata trait value
4346
- * @export
4347
- */
4348
- type NFTMetadataAttributeValue = boolean | number | string;
4349
-
4350
- /**
4351
- * Immutable zkEVM API
4352
- * Immutable Multi Rollup API
4353
- *
4354
- * The version of the OpenAPI document: 1.0.0
4355
- * Contact: support@immutable.com
4356
- *
4357
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
4358
- * https://openapi-generator.tech
4359
- * Do not edit the class manually.
4360
- */
4361
-
4362
- /**
4363
- *
4364
- * @export
4365
- * @interface NFTMetadataAttribute
4366
- */
4367
- interface NFTMetadataAttribute {
4368
- /**
4369
- * The metadata trait type
4370
- * @type {string}
4371
- * @memberof NFTMetadataAttribute
4372
- */
4373
- 'trait_type': string;
4374
- /**
4375
- *
4376
- * @type {NFTMetadataAttributeValue}
4377
- * @memberof NFTMetadataAttribute
4378
- */
4379
- 'value': NFTMetadataAttributeValue;
4380
- }
4381
-
4382
4911
  /**
4383
4912
  * Immutable zkEVM API
4384
4913
  * Immutable Multi Rollup API
@@ -5168,6 +5697,38 @@ interface ListMetadataResult {
5168
5697
  'page': Page;
5169
5698
  }
5170
5699
 
5700
+ /**
5701
+ * Immutable zkEVM API
5702
+ * Immutable Multi Rollup API
5703
+ *
5704
+ * The version of the OpenAPI document: 1.0.0
5705
+ * Contact: support@immutable.com
5706
+ *
5707
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
5708
+ * https://openapi-generator.tech
5709
+ * Do not edit the class manually.
5710
+ */
5711
+
5712
+ /**
5713
+ * List mint requests
5714
+ * @export
5715
+ * @interface ListMintRequestsResult
5716
+ */
5717
+ interface ListMintRequestsResult {
5718
+ /**
5719
+ * List of mint requests
5720
+ * @type {Array<GetMintRequestResult>}
5721
+ * @memberof ListMintRequestsResult
5722
+ */
5723
+ 'result': Array<GetMintRequestResult>;
5724
+ /**
5725
+ *
5726
+ * @type {Page}
5727
+ * @memberof ListMintRequestsResult
5728
+ */
5729
+ 'page': Page;
5730
+ }
5731
+
5171
5732
  /**
5172
5733
  * Immutable zkEVM API
5173
5734
  * Immutable Multi Rollup API
@@ -5511,106 +6072,6 @@ interface MetadataRefreshRateLimitResult {
5511
6072
  'retry_after': string;
5512
6073
  }
5513
6074
 
5514
- /**
5515
- * Immutable zkEVM API
5516
- * Immutable Multi Rollup API
5517
- *
5518
- * The version of the OpenAPI document: 1.0.0
5519
- * Contact: support@immutable.com
5520
- *
5521
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
5522
- * https://openapi-generator.tech
5523
- * Do not edit the class manually.
5524
- */
5525
-
5526
- /**
5527
- *
5528
- * @export
5529
- * @interface NFTMetadataRequest
5530
- */
5531
- interface NFTMetadataRequest {
5532
- /**
5533
- * The name of the NFT
5534
- * @type {string}
5535
- * @memberof NFTMetadataRequest
5536
- */
5537
- 'name'?: string | null;
5538
- /**
5539
- * The description of the NFT
5540
- * @type {string}
5541
- * @memberof NFTMetadataRequest
5542
- */
5543
- 'description'?: string | null;
5544
- /**
5545
- * The image url of the NFT
5546
- * @type {string}
5547
- * @memberof NFTMetadataRequest
5548
- */
5549
- 'image'?: string | null;
5550
- /**
5551
- * The external link of the NFT
5552
- * @type {string}
5553
- * @memberof NFTMetadataRequest
5554
- */
5555
- 'external_url'?: string | null;
5556
- /**
5557
- * The animation url of the NFT
5558
- * @type {string}
5559
- * @memberof NFTMetadataRequest
5560
- */
5561
- 'animation_url'?: string | null;
5562
- /**
5563
- * The youtube link of the NFT
5564
- * @type {string}
5565
- * @memberof NFTMetadataRequest
5566
- */
5567
- 'youtube_url'?: string | null;
5568
- /**
5569
- * List of Metadata attributes
5570
- * @type {Array<NFTMetadataAttribute>}
5571
- * @memberof NFTMetadataRequest
5572
- */
5573
- 'attributes'?: Array<NFTMetadataAttribute> | null;
5574
- }
5575
-
5576
- /**
5577
- * Immutable zkEVM API
5578
- * Immutable Multi Rollup API
5579
- *
5580
- * The version of the OpenAPI document: 1.0.0
5581
- * Contact: support@immutable.com
5582
- *
5583
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
5584
- * https://openapi-generator.tech
5585
- * Do not edit the class manually.
5586
- */
5587
-
5588
- /**
5589
- *
5590
- * @export
5591
- * @interface MintAsset
5592
- */
5593
- interface MintAsset {
5594
- /**
5595
- * The ID of this asset in the system that originates the mint request
5596
- * @type {string}
5597
- * @memberof MintAsset
5598
- */
5599
- 'reference_id': string;
5600
- /**
5601
- * The address of the receiver
5602
- * @type {string}
5603
- * @memberof MintAsset
5604
- */
5605
- 'owner_address': string;
5606
- /**
5607
- *
5608
- * @type {NFTMetadataRequest}
5609
- * @memberof MintAsset
5610
- */
5611
- 'metadata'?: NFTMetadataRequest;
5612
- }
5613
-
5614
6075
  /**
5615
6076
  * Immutable zkEVM API
5616
6077
  * Immutable Multi Rollup API
@@ -6404,6 +6865,56 @@ interface ListOwnersByContractAddressRequestParams {
6404
6865
  * Do not edit the class manually.
6405
6866
  */
6406
6867
 
6868
+ /**
6869
+ * Request parameters for createMintRequest operation in NftsApi.
6870
+ * @export
6871
+ * @interface CreateMintRequestRequest
6872
+ */
6873
+ interface CreateMintRequestRequestParams {
6874
+ /**
6875
+ * The address of contract
6876
+ * @type {string}
6877
+ * @memberof CreateMintRequest
6878
+ */
6879
+ readonly contractAddress: string;
6880
+ /**
6881
+ * The name of chain
6882
+ * @type {string}
6883
+ * @memberof CreateMintRequest
6884
+ */
6885
+ readonly chainName: string;
6886
+ /**
6887
+ * the request body
6888
+ * @type {CreateMintRequestRequest}
6889
+ * @memberof CreateMintRequest
6890
+ */
6891
+ readonly createMintRequestRequest: CreateMintRequestRequest;
6892
+ }
6893
+ /**
6894
+ * Request parameters for getMintRequest operation in NftsApi.
6895
+ * @export
6896
+ * @interface GetMintRequestRequest
6897
+ */
6898
+ interface GetMintRequestRequestParams {
6899
+ /**
6900
+ * The address of contract
6901
+ * @type {string}
6902
+ * @memberof GetMintRequest
6903
+ */
6904
+ readonly contractAddress: string;
6905
+ /**
6906
+ * The name of chain
6907
+ * @type {string}
6908
+ * @memberof GetMintRequest
6909
+ */
6910
+ readonly chainName: string;
6911
+ /**
6912
+ * The ID of the mint request
6913
+ * @type {string}
6914
+ * @memberof GetMintRequest
6915
+ */
6916
+ readonly referenceId: string;
6917
+ }
6407
6918
  /**
6408
6919
  * Request parameters for getNFT operation in NftsApi.
6409
6920
  * @export
@@ -6460,6 +6971,43 @@ interface ListAllNFTsRequestParams {
6460
6971
  */
6461
6972
  readonly pageSize?: number;
6462
6973
  }
6974
+ /**
6975
+ * Request parameters for listMintRequests operation in NftsApi.
6976
+ * @export
6977
+ * @interface ListMintRequestsRequest
6978
+ */
6979
+ interface ListMintRequestsRequestParams {
6980
+ /**
6981
+ * The address of contract
6982
+ * @type {string}
6983
+ * @memberof ListMintRequests
6984
+ */
6985
+ readonly contractAddress: string;
6986
+ /**
6987
+ * The name of chain
6988
+ * @type {string}
6989
+ * @memberof ListMintRequests
6990
+ */
6991
+ readonly chainName: string;
6992
+ /**
6993
+ * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
6994
+ * @type {string}
6995
+ * @memberof ListMintRequests
6996
+ */
6997
+ readonly pageCursor?: string;
6998
+ /**
6999
+ * Maximum number of items to return
7000
+ * @type {number}
7001
+ * @memberof ListMintRequests
7002
+ */
7003
+ readonly pageSize?: number;
7004
+ /**
7005
+ * The status of the mint request
7006
+ * @type {MintRequestStatus}
7007
+ * @memberof ListMintRequests
7008
+ */
7009
+ readonly status?: MintRequestStatus;
7010
+ }
6463
7011
  /**
6464
7012
  * Request parameters for listNFTs operation in NftsApi.
6465
7013
  * @export
@@ -6663,6 +7211,9 @@ type index_d_Collection = Collection;
6663
7211
  type index_d_CollectionContractType = CollectionContractType;
6664
7212
  declare const index_d_CollectionContractType: typeof CollectionContractType;
6665
7213
  type index_d_CollectionMetadata = CollectionMetadata;
7214
+ type index_d_CreateMintRequestRequest = CreateMintRequestRequest;
7215
+ type index_d_CreateMintRequestRequestParams = CreateMintRequestRequestParams;
7216
+ type index_d_CreateMintRequestResult = CreateMintRequestResult;
6666
7217
  type index_d_Deposit = Deposit;
6667
7218
  type index_d_ERC1155Item = ERC1155Item;
6668
7219
  type index_d_ERC1155ItemTypeEnum = ERC1155ItemTypeEnum;
@@ -6680,6 +7231,7 @@ type index_d_GetCollectionResult = GetCollectionResult;
6680
7231
  type index_d_GetERC20TokenRequestParams = GetERC20TokenRequestParams;
6681
7232
  type index_d_GetMetadataRequestParams = GetMetadataRequestParams;
6682
7233
  type index_d_GetMetadataResult = GetMetadataResult;
7234
+ type index_d_GetMintRequestRequestParams = GetMintRequestRequestParams;
6683
7235
  type index_d_GetMintRequestResult = GetMintRequestResult;
6684
7236
  type index_d_GetNFTRequestParams = GetNFTRequestParams;
6685
7237
  type index_d_GetNFTResult = GetNFTResult;
@@ -6700,6 +7252,8 @@ type index_d_ListERC20TokensRequestParams = ListERC20TokensRequestParams;
6700
7252
  type index_d_ListMetadataForChainRequestParams = ListMetadataForChainRequestParams;
6701
7253
  type index_d_ListMetadataRequestParams = ListMetadataRequestParams;
6702
7254
  type index_d_ListMetadataResult = ListMetadataResult;
7255
+ type index_d_ListMintRequestsRequestParams = ListMintRequestsRequestParams;
7256
+ type index_d_ListMintRequestsResult = ListMintRequestsResult;
6703
7257
  type index_d_ListNFTOwnersRequestParams = ListNFTOwnersRequestParams;
6704
7258
  type index_d_ListNFTOwnersResult = ListNFTOwnersResult;
6705
7259
  type index_d_ListNFTsByAccountAddressRequestParams = ListNFTsByAccountAddressRequestParams;
@@ -6792,6 +7346,9 @@ declare namespace index_d {
6792
7346
  index_d_Collection as Collection,
6793
7347
  index_d_CollectionContractType as CollectionContractType,
6794
7348
  index_d_CollectionMetadata as CollectionMetadata,
7349
+ index_d_CreateMintRequestRequest as CreateMintRequestRequest,
7350
+ index_d_CreateMintRequestRequestParams as CreateMintRequestRequestParams,
7351
+ index_d_CreateMintRequestResult as CreateMintRequestResult,
6795
7352
  index_d_Deposit as Deposit,
6796
7353
  index_d_ERC1155Item as ERC1155Item,
6797
7354
  index_d_ERC1155ItemTypeEnum as ERC1155ItemTypeEnum,
@@ -6806,6 +7363,7 @@ declare namespace index_d {
6806
7363
  index_d_GetERC20TokenRequestParams as GetERC20TokenRequestParams,
6807
7364
  index_d_GetMetadataRequestParams as GetMetadataRequestParams,
6808
7365
  index_d_GetMetadataResult as GetMetadataResult,
7366
+ index_d_GetMintRequestRequestParams as GetMintRequestRequestParams,
6809
7367
  index_d_GetMintRequestResult as GetMintRequestResult,
6810
7368
  index_d_GetNFTRequestParams as GetNFTRequestParams,
6811
7369
  index_d_GetNFTResult as GetNFTResult,
@@ -6826,6 +7384,8 @@ declare namespace index_d {
6826
7384
  index_d_ListMetadataForChainRequestParams as ListMetadataForChainRequestParams,
6827
7385
  index_d_ListMetadataRequestParams as ListMetadataRequestParams,
6828
7386
  index_d_ListMetadataResult as ListMetadataResult,
7387
+ index_d_ListMintRequestsRequestParams as ListMintRequestsRequestParams,
7388
+ index_d_ListMintRequestsResult as ListMintRequestsResult,
6829
7389
  index_d_ListNFTOwnersRequestParams as ListNFTOwnersRequestParams,
6830
7390
  index_d_ListNFTOwnersResult as ListNFTOwnersResult,
6831
7391
  index_d_ListNFTsByAccountAddressRequestParams as ListNFTsByAccountAddressRequestParams,
@@ -7024,6 +7584,30 @@ declare class BlockchainData {
7024
7584
  * @throws {@link index.APIError}
7025
7585
  */
7026
7586
  listAllNFTs(request: NftsApiListAllNFTsRequest): Promise<ListNFTsResult$1>;
7587
+ /**
7588
+ * Create a mint request to mint a set of NFTs for a given collection
7589
+ * @experimental
7590
+ * @param request - the request object containing the parameters to be provided in the API request
7591
+ * @returns a promise that resolves with the remaining rate limits
7592
+ * @throws {@link index.APIError}
7593
+ */
7594
+ createMintRequest(request: NftsApiCreateMintRequestRequest): Promise<CreateMintRequestResult$1>;
7595
+ /**
7596
+ * List all mint requests for a given contract address
7597
+ * @experimental
7598
+ * @param request - the request object containing the parameters to be provided in the API request
7599
+ * @returns a promise that resolves with a list of mint requests
7600
+ * @throws {@link index.APIError}
7601
+ */
7602
+ listMintRequests(request: NftsApiListMintRequestsRequest): Promise<ListMintRequestsResult$1>;
7603
+ /**
7604
+ * Retrieve the status of a single mint request identified by its reference ID
7605
+ * @experimental
7606
+ * @param request - the request object containing the parameters to be provided in the API request
7607
+ * @returns a promise that resolves with a single mint request
7608
+ * @throws {@link index.APIError}
7609
+ */
7610
+ getMintRequest(request: NftsApiGetMintRequestRequest): Promise<ListMintRequestsResult$1>;
7027
7611
  /**
7028
7612
  * List NFT owners by token ID
7029
7613
  * @param request - the request object containing the parameters to be provided in the API request