@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.
package/dist/index.d.ts CHANGED
@@ -11828,19 +11828,43 @@ interface CollectionMetadata$1 {
11828
11828
  * https://openapi-generator.tech
11829
11829
  * Do not edit the class manually.
11830
11830
  */
11831
+ /**
11832
+ * @type NFTMetadataAttributeValue
11833
+ * The metadata trait value
11834
+ * @export
11835
+ */
11836
+ type NFTMetadataAttributeValue$1 = boolean | number | string;
11831
11837
 
11832
11838
  /**
11833
- * Single activity
11839
+ * Immutable zkEVM API
11840
+ * Immutable Multi Rollup API
11841
+ *
11842
+ * The version of the OpenAPI document: 1.0.0
11843
+ * Contact: support@immutable.com
11844
+ *
11845
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11846
+ * https://openapi-generator.tech
11847
+ * Do not edit the class manually.
11848
+ */
11849
+
11850
+ /**
11851
+ *
11834
11852
  * @export
11835
- * @interface GetActivityResult
11853
+ * @interface NFTMetadataAttribute
11836
11854
  */
11837
- interface GetActivityResult$1 {
11855
+ interface NFTMetadataAttribute$1 {
11856
+ /**
11857
+ * The metadata trait type
11858
+ * @type {string}
11859
+ * @memberof NFTMetadataAttribute
11860
+ */
11861
+ 'trait_type': string;
11838
11862
  /**
11839
11863
  *
11840
- * @type {Activity}
11841
- * @memberof GetActivityResult
11864
+ * @type {NFTMetadataAttributeValue}
11865
+ * @memberof NFTMetadataAttribute
11842
11866
  */
11843
- 'result': Activity$1;
11867
+ 'value': NFTMetadataAttributeValue$1;
11844
11868
  }
11845
11869
 
11846
11870
  /**
@@ -11856,17 +11880,53 @@ interface GetActivityResult$1 {
11856
11880
  */
11857
11881
 
11858
11882
  /**
11859
- * Single Collection
11883
+ *
11860
11884
  * @export
11861
- * @interface GetCollectionResult
11885
+ * @interface NFTMetadataRequest
11862
11886
  */
11863
- interface GetCollectionResult$1 {
11887
+ interface NFTMetadataRequest$1 {
11864
11888
  /**
11865
- *
11866
- * @type {Collection}
11867
- * @memberof GetCollectionResult
11889
+ * The name of the NFT
11890
+ * @type {string}
11891
+ * @memberof NFTMetadataRequest
11868
11892
  */
11869
- 'result': Collection$2;
11893
+ 'name'?: string | null;
11894
+ /**
11895
+ * The description of the NFT
11896
+ * @type {string}
11897
+ * @memberof NFTMetadataRequest
11898
+ */
11899
+ 'description'?: string | null;
11900
+ /**
11901
+ * The image url of the NFT
11902
+ * @type {string}
11903
+ * @memberof NFTMetadataRequest
11904
+ */
11905
+ 'image'?: string | null;
11906
+ /**
11907
+ * The external link of the NFT
11908
+ * @type {string}
11909
+ * @memberof NFTMetadataRequest
11910
+ */
11911
+ 'external_url'?: string | null;
11912
+ /**
11913
+ * The animation url of the NFT
11914
+ * @type {string}
11915
+ * @memberof NFTMetadataRequest
11916
+ */
11917
+ 'animation_url'?: string | null;
11918
+ /**
11919
+ * The youtube link of the NFT
11920
+ * @type {string}
11921
+ * @memberof NFTMetadataRequest
11922
+ */
11923
+ 'youtube_url'?: string | null;
11924
+ /**
11925
+ * List of Metadata attributes
11926
+ * @type {Array<NFTMetadataAttribute>}
11927
+ * @memberof NFTMetadataRequest
11928
+ */
11929
+ 'attributes'?: Array<NFTMetadataAttribute$1> | null;
11870
11930
  }
11871
11931
 
11872
11932
  /**
@@ -11880,12 +11940,32 @@ interface GetCollectionResult$1 {
11880
11940
  * https://openapi-generator.tech
11881
11941
  * Do not edit the class manually.
11882
11942
  */
11943
+
11883
11944
  /**
11884
- * @type NFTMetadataAttributeValue
11885
- * The metadata trait value
11945
+ *
11886
11946
  * @export
11947
+ * @interface MintAsset
11887
11948
  */
11888
- type NFTMetadataAttributeValue$1 = boolean | number | string;
11949
+ interface MintAsset$1 {
11950
+ /**
11951
+ * The ID of this asset in the system that originates the mint request
11952
+ * @type {string}
11953
+ * @memberof MintAsset
11954
+ */
11955
+ 'reference_id': string;
11956
+ /**
11957
+ * The address of the receiver
11958
+ * @type {string}
11959
+ * @memberof MintAsset
11960
+ */
11961
+ 'owner_address': string;
11962
+ /**
11963
+ *
11964
+ * @type {NFTMetadataRequest}
11965
+ * @memberof MintAsset
11966
+ */
11967
+ 'metadata'?: NFTMetadataRequest$1;
11968
+ }
11889
11969
 
11890
11970
  /**
11891
11971
  * Immutable zkEVM API
@@ -11902,21 +11982,110 @@ type NFTMetadataAttributeValue$1 = boolean | number | string;
11902
11982
  /**
11903
11983
  *
11904
11984
  * @export
11905
- * @interface NFTMetadataAttribute
11985
+ * @interface CreateMintRequestRequest
11906
11986
  */
11907
- interface NFTMetadataAttribute$1 {
11987
+ interface CreateMintRequestRequest$1 {
11908
11988
  /**
11909
- * The metadata trait type
11989
+ * List of nft to be minted
11990
+ * @type {Array<MintAsset>}
11991
+ * @memberof CreateMintRequestRequest
11992
+ */
11993
+ 'assets': Array<MintAsset$1>;
11994
+ }
11995
+
11996
+ /**
11997
+ * Immutable zkEVM API
11998
+ * Immutable Multi Rollup API
11999
+ *
12000
+ * The version of the OpenAPI document: 1.0.0
12001
+ * Contact: support@immutable.com
12002
+ *
12003
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12004
+ * https://openapi-generator.tech
12005
+ * Do not edit the class manually.
12006
+ */
12007
+ /**
12008
+ *
12009
+ * @export
12010
+ * @interface CreateMintRequestResult
12011
+ */
12012
+ interface CreateMintRequestResult$1 {
12013
+ /**
12014
+ *
11910
12015
  * @type {string}
11911
- * @memberof NFTMetadataAttribute
12016
+ * @memberof CreateMintRequestResult
11912
12017
  */
11913
- 'trait_type': string;
12018
+ 'imx_mint_requests_limit': string;
11914
12019
  /**
11915
12020
  *
11916
- * @type {NFTMetadataAttributeValue}
11917
- * @memberof NFTMetadataAttribute
12021
+ * @type {string}
12022
+ * @memberof CreateMintRequestResult
11918
12023
  */
11919
- 'value': NFTMetadataAttributeValue$1;
12024
+ 'imx_mint_requests_limit_reset': string;
12025
+ /**
12026
+ *
12027
+ * @type {string}
12028
+ * @memberof CreateMintRequestResult
12029
+ */
12030
+ 'imx_remaining_mint_requests': string;
12031
+ /**
12032
+ *
12033
+ * @type {string}
12034
+ * @memberof CreateMintRequestResult
12035
+ */
12036
+ 'imx_mint_requests_retry_after': string;
12037
+ }
12038
+
12039
+ /**
12040
+ * Immutable zkEVM API
12041
+ * Immutable Multi Rollup API
12042
+ *
12043
+ * The version of the OpenAPI document: 1.0.0
12044
+ * Contact: support@immutable.com
12045
+ *
12046
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12047
+ * https://openapi-generator.tech
12048
+ * Do not edit the class manually.
12049
+ */
12050
+
12051
+ /**
12052
+ * Single activity
12053
+ * @export
12054
+ * @interface GetActivityResult
12055
+ */
12056
+ interface GetActivityResult$1 {
12057
+ /**
12058
+ *
12059
+ * @type {Activity}
12060
+ * @memberof GetActivityResult
12061
+ */
12062
+ 'result': Activity$1;
12063
+ }
12064
+
12065
+ /**
12066
+ * Immutable zkEVM API
12067
+ * Immutable Multi Rollup API
12068
+ *
12069
+ * The version of the OpenAPI document: 1.0.0
12070
+ * Contact: support@immutable.com
12071
+ *
12072
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12073
+ * https://openapi-generator.tech
12074
+ * Do not edit the class manually.
12075
+ */
12076
+
12077
+ /**
12078
+ * Single Collection
12079
+ * @export
12080
+ * @interface GetCollectionResult
12081
+ */
12082
+ interface GetCollectionResult$1 {
12083
+ /**
12084
+ *
12085
+ * @type {Collection}
12086
+ * @memberof GetCollectionResult
12087
+ */
12088
+ 'result': Collection$2;
11920
12089
  }
11921
12090
 
11922
12091
  /**
@@ -12037,6 +12206,140 @@ interface GetMetadataResult$1 {
12037
12206
  'result': Metadata$1;
12038
12207
  }
12039
12208
 
12209
+ /**
12210
+ * Immutable zkEVM API
12211
+ * Immutable Multi Rollup API
12212
+ *
12213
+ * The version of the OpenAPI document: 1.0.0
12214
+ * Contact: support@immutable.com
12215
+ *
12216
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12217
+ * https://openapi-generator.tech
12218
+ * Do not edit the class manually.
12219
+ */
12220
+ /**
12221
+ *
12222
+ * @export
12223
+ * @interface MintRequestErrorMessage
12224
+ */
12225
+ interface MintRequestErrorMessage$1 {
12226
+ /**
12227
+ * An error message in case the mint request fails
12228
+ * @type {string}
12229
+ * @memberof MintRequestErrorMessage
12230
+ */
12231
+ 'message'?: string;
12232
+ }
12233
+
12234
+ /**
12235
+ * Immutable zkEVM API
12236
+ * Immutable Multi Rollup API
12237
+ *
12238
+ * The version of the OpenAPI document: 1.0.0
12239
+ * Contact: support@immutable.com
12240
+ *
12241
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12242
+ * https://openapi-generator.tech
12243
+ * Do not edit the class manually.
12244
+ */
12245
+ /**
12246
+ * The status of the mint request
12247
+ * @export
12248
+ * @enum {string}
12249
+ */
12250
+ declare const MintRequestStatus$1: {
12251
+ readonly Pending: "pending";
12252
+ readonly Succeeded: "succeeded";
12253
+ readonly Failed: "failed";
12254
+ };
12255
+ type MintRequestStatus$1 = typeof MintRequestStatus$1[keyof typeof MintRequestStatus$1];
12256
+
12257
+ /**
12258
+ * Immutable zkEVM API
12259
+ * Immutable Multi Rollup API
12260
+ *
12261
+ * The version of the OpenAPI document: 1.0.0
12262
+ * Contact: support@immutable.com
12263
+ *
12264
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12265
+ * https://openapi-generator.tech
12266
+ * Do not edit the class manually.
12267
+ */
12268
+
12269
+ /**
12270
+ *
12271
+ * @export
12272
+ * @interface GetMintRequestResult
12273
+ */
12274
+ interface GetMintRequestResult$1 {
12275
+ /**
12276
+ *
12277
+ * @type {Chain}
12278
+ * @memberof GetMintRequestResult
12279
+ */
12280
+ 'chain': Chain$2;
12281
+ /**
12282
+ * The address of the contract
12283
+ * @type {string}
12284
+ * @memberof GetMintRequestResult
12285
+ */
12286
+ 'collection_address': string;
12287
+ /**
12288
+ * The reference ID of this mint request
12289
+ * @type {string}
12290
+ * @memberof GetMintRequestResult
12291
+ */
12292
+ 'reference_id': string;
12293
+ /**
12294
+ * The address of the owner of the NFT
12295
+ * @type {string}
12296
+ * @memberof GetMintRequestResult
12297
+ */
12298
+ 'owner_address': string;
12299
+ /**
12300
+ * An `uint256` token id as string. Only available when the mint request succeeds
12301
+ * @type {string}
12302
+ * @memberof GetMintRequestResult
12303
+ */
12304
+ 'token_id': string | null;
12305
+ /**
12306
+ * The id of the mint activity associated with this mint request
12307
+ * @type {string}
12308
+ * @memberof GetMintRequestResult
12309
+ */
12310
+ 'activity_id'?: string | null;
12311
+ /**
12312
+ * The transaction hash of the activity
12313
+ * @type {string}
12314
+ * @memberof GetMintRequestResult
12315
+ */
12316
+ 'transaction_hash': string | null;
12317
+ /**
12318
+ * When the mint request was created
12319
+ * @type {string}
12320
+ * @memberof GetMintRequestResult
12321
+ */
12322
+ 'created_at': string;
12323
+ /**
12324
+ * When the mint request was last updated
12325
+ * @type {string}
12326
+ * @memberof GetMintRequestResult
12327
+ */
12328
+ 'updated_at': string;
12329
+ /**
12330
+ *
12331
+ * @type {MintRequestErrorMessage}
12332
+ * @memberof GetMintRequestResult
12333
+ */
12334
+ 'error': MintRequestErrorMessage$1 | null;
12335
+ /**
12336
+ *
12337
+ * @type {MintRequestStatus}
12338
+ * @memberof GetMintRequestResult
12339
+ */
12340
+ 'status': MintRequestStatus$1;
12341
+ }
12342
+
12040
12343
  /**
12041
12344
  * Immutable zkEVM API
12042
12345
  * Immutable Multi Rollup API
@@ -12420,6 +12723,38 @@ interface ListMetadataResult$1 {
12420
12723
  'page': Page$3;
12421
12724
  }
12422
12725
 
12726
+ /**
12727
+ * Immutable zkEVM API
12728
+ * Immutable Multi Rollup API
12729
+ *
12730
+ * The version of the OpenAPI document: 1.0.0
12731
+ * Contact: support@immutable.com
12732
+ *
12733
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12734
+ * https://openapi-generator.tech
12735
+ * Do not edit the class manually.
12736
+ */
12737
+
12738
+ /**
12739
+ * List mint requests
12740
+ * @export
12741
+ * @interface ListMintRequestsResult
12742
+ */
12743
+ interface ListMintRequestsResult$1 {
12744
+ /**
12745
+ * List of mint requests
12746
+ * @type {Array<GetMintRequestResult>}
12747
+ * @memberof ListMintRequestsResult
12748
+ */
12749
+ 'result': Array<GetMintRequestResult$1>;
12750
+ /**
12751
+ *
12752
+ * @type {Page}
12753
+ * @memberof ListMintRequestsResult
12754
+ */
12755
+ 'page': Page$3;
12756
+ }
12757
+
12423
12758
  /**
12424
12759
  * Immutable zkEVM API
12425
12760
  * Immutable Multi Rollup API
@@ -12615,68 +12950,6 @@ interface MetadataRefreshRateLimitResult$1 {
12615
12950
  'retry_after': string;
12616
12951
  }
12617
12952
 
12618
- /**
12619
- * Immutable zkEVM API
12620
- * Immutable Multi Rollup API
12621
- *
12622
- * The version of the OpenAPI document: 1.0.0
12623
- * Contact: support@immutable.com
12624
- *
12625
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12626
- * https://openapi-generator.tech
12627
- * Do not edit the class manually.
12628
- */
12629
-
12630
- /**
12631
- *
12632
- * @export
12633
- * @interface NFTMetadataRequest
12634
- */
12635
- interface NFTMetadataRequest$1 {
12636
- /**
12637
- * The name of the NFT
12638
- * @type {string}
12639
- * @memberof NFTMetadataRequest
12640
- */
12641
- 'name'?: string | null;
12642
- /**
12643
- * The description of the NFT
12644
- * @type {string}
12645
- * @memberof NFTMetadataRequest
12646
- */
12647
- 'description'?: string | null;
12648
- /**
12649
- * The image url of the NFT
12650
- * @type {string}
12651
- * @memberof NFTMetadataRequest
12652
- */
12653
- 'image'?: string | null;
12654
- /**
12655
- * The external link of the NFT
12656
- * @type {string}
12657
- * @memberof NFTMetadataRequest
12658
- */
12659
- 'external_url'?: string | null;
12660
- /**
12661
- * The animation url of the NFT
12662
- * @type {string}
12663
- * @memberof NFTMetadataRequest
12664
- */
12665
- 'animation_url'?: string | null;
12666
- /**
12667
- * The youtube link of the NFT
12668
- * @type {string}
12669
- * @memberof NFTMetadataRequest
12670
- */
12671
- 'youtube_url'?: string | null;
12672
- /**
12673
- * List of Metadata attributes
12674
- * @type {Array<NFTMetadataAttribute>}
12675
- * @memberof NFTMetadataRequest
12676
- */
12677
- 'attributes'?: Array<NFTMetadataAttribute$1> | null;
12678
- }
12679
-
12680
12953
  /**
12681
12954
  * Immutable zkEVM API
12682
12955
  * Immutable Multi Rollup API
@@ -13327,46 +13600,96 @@ interface NftOwnersApiListNFTOwnersRequest {
13327
13600
  * @type {number}
13328
13601
  * @memberof NftOwnersApiListNFTOwners
13329
13602
  */
13330
- readonly pageSize?: number;
13603
+ readonly pageSize?: number;
13604
+ }
13605
+ /**
13606
+ * Request parameters for listOwnersByContractAddress operation in NftOwnersApi.
13607
+ * @export
13608
+ * @interface NftOwnersApiListOwnersByContractAddressRequest
13609
+ */
13610
+ interface NftOwnersApiListOwnersByContractAddressRequest {
13611
+ /**
13612
+ * The address of contract
13613
+ * @type {string}
13614
+ * @memberof NftOwnersApiListOwnersByContractAddress
13615
+ */
13616
+ readonly contractAddress: string;
13617
+ /**
13618
+ * The name of chain
13619
+ * @type {string}
13620
+ * @memberof NftOwnersApiListOwnersByContractAddress
13621
+ */
13622
+ readonly chainName: string;
13623
+ /**
13624
+ * Datetime to use as the oldest updated timestamp
13625
+ * @type {string}
13626
+ * @memberof NftOwnersApiListOwnersByContractAddress
13627
+ */
13628
+ readonly fromUpdatedAt?: string;
13629
+ /**
13630
+ * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
13631
+ * @type {string}
13632
+ * @memberof NftOwnersApiListOwnersByContractAddress
13633
+ */
13634
+ readonly pageCursor?: string;
13635
+ /**
13636
+ * Maximum number of items to return
13637
+ * @type {number}
13638
+ * @memberof NftOwnersApiListOwnersByContractAddress
13639
+ */
13640
+ readonly pageSize?: number;
13641
+ }
13642
+
13643
+ /**
13644
+ * Request parameters for createMintRequest operation in NftsApi.
13645
+ * @export
13646
+ * @interface NftsApiCreateMintRequestRequest
13647
+ */
13648
+ interface NftsApiCreateMintRequestRequest {
13649
+ /**
13650
+ * The address of contract
13651
+ * @type {string}
13652
+ * @memberof NftsApiCreateMintRequest
13653
+ */
13654
+ readonly contractAddress: string;
13655
+ /**
13656
+ * The name of chain
13657
+ * @type {string}
13658
+ * @memberof NftsApiCreateMintRequest
13659
+ */
13660
+ readonly chainName: string;
13661
+ /**
13662
+ * the request body
13663
+ * @type {CreateMintRequestRequest}
13664
+ * @memberof NftsApiCreateMintRequest
13665
+ */
13666
+ readonly createMintRequestRequest: CreateMintRequestRequest$1;
13331
13667
  }
13332
13668
  /**
13333
- * Request parameters for listOwnersByContractAddress operation in NftOwnersApi.
13669
+ * Request parameters for getMintRequest operation in NftsApi.
13334
13670
  * @export
13335
- * @interface NftOwnersApiListOwnersByContractAddressRequest
13671
+ * @interface NftsApiGetMintRequestRequest
13336
13672
  */
13337
- interface NftOwnersApiListOwnersByContractAddressRequest {
13673
+ interface NftsApiGetMintRequestRequest {
13338
13674
  /**
13339
13675
  * The address of contract
13340
13676
  * @type {string}
13341
- * @memberof NftOwnersApiListOwnersByContractAddress
13677
+ * @memberof NftsApiGetMintRequest
13342
13678
  */
13343
13679
  readonly contractAddress: string;
13344
13680
  /**
13345
13681
  * The name of chain
13346
13682
  * @type {string}
13347
- * @memberof NftOwnersApiListOwnersByContractAddress
13683
+ * @memberof NftsApiGetMintRequest
13348
13684
  */
13349
13685
  readonly chainName: string;
13350
13686
  /**
13351
- * Datetime to use as the oldest updated timestamp
13352
- * @type {string}
13353
- * @memberof NftOwnersApiListOwnersByContractAddress
13354
- */
13355
- readonly fromUpdatedAt?: string;
13356
- /**
13357
- * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
13687
+ * The ID of the mint request
13358
13688
  * @type {string}
13359
- * @memberof NftOwnersApiListOwnersByContractAddress
13360
- */
13361
- readonly pageCursor?: string;
13362
- /**
13363
- * Maximum number of items to return
13364
- * @type {number}
13365
- * @memberof NftOwnersApiListOwnersByContractAddress
13689
+ * @memberof NftsApiGetMintRequest
13366
13690
  */
13367
- readonly pageSize?: number;
13691
+ readonly referenceId: string;
13368
13692
  }
13369
-
13370
13693
  /**
13371
13694
  * Request parameters for getNFT operation in NftsApi.
13372
13695
  * @export
@@ -13423,6 +13746,43 @@ interface NftsApiListAllNFTsRequest {
13423
13746
  */
13424
13747
  readonly pageSize?: number;
13425
13748
  }
13749
+ /**
13750
+ * Request parameters for listMintRequests operation in NftsApi.
13751
+ * @export
13752
+ * @interface NftsApiListMintRequestsRequest
13753
+ */
13754
+ interface NftsApiListMintRequestsRequest {
13755
+ /**
13756
+ * The address of contract
13757
+ * @type {string}
13758
+ * @memberof NftsApiListMintRequests
13759
+ */
13760
+ readonly contractAddress: string;
13761
+ /**
13762
+ * The name of chain
13763
+ * @type {string}
13764
+ * @memberof NftsApiListMintRequests
13765
+ */
13766
+ readonly chainName: string;
13767
+ /**
13768
+ * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
13769
+ * @type {string}
13770
+ * @memberof NftsApiListMintRequests
13771
+ */
13772
+ readonly pageCursor?: string;
13773
+ /**
13774
+ * Maximum number of items to return
13775
+ * @type {number}
13776
+ * @memberof NftsApiListMintRequests
13777
+ */
13778
+ readonly pageSize?: number;
13779
+ /**
13780
+ * The status of the mint request
13781
+ * @type {MintRequestStatus}
13782
+ * @memberof NftsApiListMintRequests
13783
+ */
13784
+ readonly status?: MintRequestStatus$1;
13785
+ }
13426
13786
  /**
13427
13787
  * Request parameters for listNFTs operation in NftsApi.
13428
13788
  * @export
@@ -14913,17 +15273,236 @@ interface CollectionMetadata {
14913
15273
  */
14914
15274
  'external_link': string | null;
14915
15275
  /**
14916
- * The uri for the metadata of the collection
15276
+ * The uri for the metadata of the collection
15277
+ * @type {string}
15278
+ * @memberof CollectionMetadata
15279
+ */
15280
+ 'contract_uri': string | null;
15281
+ /**
15282
+ * The metadata uri for nft
15283
+ * @type {string}
15284
+ * @memberof CollectionMetadata
15285
+ */
15286
+ 'base_uri': string | null;
15287
+ }
15288
+
15289
+ /**
15290
+ * Immutable zkEVM API
15291
+ * Immutable Multi Rollup API
15292
+ *
15293
+ * The version of the OpenAPI document: 1.0.0
15294
+ * Contact: support@immutable.com
15295
+ *
15296
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
15297
+ * https://openapi-generator.tech
15298
+ * Do not edit the class manually.
15299
+ */
15300
+ /**
15301
+ * @type NFTMetadataAttributeValue
15302
+ * The metadata trait value
15303
+ * @export
15304
+ */
15305
+ type NFTMetadataAttributeValue = boolean | number | string;
15306
+
15307
+ /**
15308
+ * Immutable zkEVM API
15309
+ * Immutable Multi Rollup API
15310
+ *
15311
+ * The version of the OpenAPI document: 1.0.0
15312
+ * Contact: support@immutable.com
15313
+ *
15314
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
15315
+ * https://openapi-generator.tech
15316
+ * Do not edit the class manually.
15317
+ */
15318
+
15319
+ /**
15320
+ *
15321
+ * @export
15322
+ * @interface NFTMetadataAttribute
15323
+ */
15324
+ interface NFTMetadataAttribute {
15325
+ /**
15326
+ * The metadata trait type
15327
+ * @type {string}
15328
+ * @memberof NFTMetadataAttribute
15329
+ */
15330
+ 'trait_type': string;
15331
+ /**
15332
+ *
15333
+ * @type {NFTMetadataAttributeValue}
15334
+ * @memberof NFTMetadataAttribute
15335
+ */
15336
+ 'value': NFTMetadataAttributeValue;
15337
+ }
15338
+
15339
+ /**
15340
+ * Immutable zkEVM API
15341
+ * Immutable Multi Rollup API
15342
+ *
15343
+ * The version of the OpenAPI document: 1.0.0
15344
+ * Contact: support@immutable.com
15345
+ *
15346
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
15347
+ * https://openapi-generator.tech
15348
+ * Do not edit the class manually.
15349
+ */
15350
+
15351
+ /**
15352
+ *
15353
+ * @export
15354
+ * @interface NFTMetadataRequest
15355
+ */
15356
+ interface NFTMetadataRequest {
15357
+ /**
15358
+ * The name of the NFT
15359
+ * @type {string}
15360
+ * @memberof NFTMetadataRequest
15361
+ */
15362
+ 'name'?: string | null;
15363
+ /**
15364
+ * The description of the NFT
15365
+ * @type {string}
15366
+ * @memberof NFTMetadataRequest
15367
+ */
15368
+ 'description'?: string | null;
15369
+ /**
15370
+ * The image url of the NFT
15371
+ * @type {string}
15372
+ * @memberof NFTMetadataRequest
15373
+ */
15374
+ 'image'?: string | null;
15375
+ /**
15376
+ * The external link of the NFT
15377
+ * @type {string}
15378
+ * @memberof NFTMetadataRequest
15379
+ */
15380
+ 'external_url'?: string | null;
15381
+ /**
15382
+ * The animation url of the NFT
15383
+ * @type {string}
15384
+ * @memberof NFTMetadataRequest
15385
+ */
15386
+ 'animation_url'?: string | null;
15387
+ /**
15388
+ * The youtube link of the NFT
15389
+ * @type {string}
15390
+ * @memberof NFTMetadataRequest
15391
+ */
15392
+ 'youtube_url'?: string | null;
15393
+ /**
15394
+ * List of Metadata attributes
15395
+ * @type {Array<NFTMetadataAttribute>}
15396
+ * @memberof NFTMetadataRequest
15397
+ */
15398
+ 'attributes'?: Array<NFTMetadataAttribute> | null;
15399
+ }
15400
+
15401
+ /**
15402
+ * Immutable zkEVM API
15403
+ * Immutable Multi Rollup API
15404
+ *
15405
+ * The version of the OpenAPI document: 1.0.0
15406
+ * Contact: support@immutable.com
15407
+ *
15408
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
15409
+ * https://openapi-generator.tech
15410
+ * Do not edit the class manually.
15411
+ */
15412
+
15413
+ /**
15414
+ *
15415
+ * @export
15416
+ * @interface MintAsset
15417
+ */
15418
+ interface MintAsset {
15419
+ /**
15420
+ * The ID of this asset in the system that originates the mint request
15421
+ * @type {string}
15422
+ * @memberof MintAsset
15423
+ */
15424
+ 'reference_id': string;
15425
+ /**
15426
+ * The address of the receiver
15427
+ * @type {string}
15428
+ * @memberof MintAsset
15429
+ */
15430
+ 'owner_address': string;
15431
+ /**
15432
+ *
15433
+ * @type {NFTMetadataRequest}
15434
+ * @memberof MintAsset
15435
+ */
15436
+ 'metadata'?: NFTMetadataRequest;
15437
+ }
15438
+
15439
+ /**
15440
+ * Immutable zkEVM API
15441
+ * Immutable Multi Rollup API
15442
+ *
15443
+ * The version of the OpenAPI document: 1.0.0
15444
+ * Contact: support@immutable.com
15445
+ *
15446
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
15447
+ * https://openapi-generator.tech
15448
+ * Do not edit the class manually.
15449
+ */
15450
+
15451
+ /**
15452
+ *
15453
+ * @export
15454
+ * @interface CreateMintRequestRequest
15455
+ */
15456
+ interface CreateMintRequestRequest {
15457
+ /**
15458
+ * List of nft to be minted
15459
+ * @type {Array<MintAsset>}
15460
+ * @memberof CreateMintRequestRequest
15461
+ */
15462
+ 'assets': Array<MintAsset>;
15463
+ }
15464
+
15465
+ /**
15466
+ * Immutable zkEVM API
15467
+ * Immutable Multi Rollup API
15468
+ *
15469
+ * The version of the OpenAPI document: 1.0.0
15470
+ * Contact: support@immutable.com
15471
+ *
15472
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
15473
+ * https://openapi-generator.tech
15474
+ * Do not edit the class manually.
15475
+ */
15476
+ /**
15477
+ *
15478
+ * @export
15479
+ * @interface CreateMintRequestResult
15480
+ */
15481
+ interface CreateMintRequestResult {
15482
+ /**
15483
+ *
15484
+ * @type {string}
15485
+ * @memberof CreateMintRequestResult
15486
+ */
15487
+ 'imx_mint_requests_limit': string;
15488
+ /**
15489
+ *
15490
+ * @type {string}
15491
+ * @memberof CreateMintRequestResult
15492
+ */
15493
+ 'imx_mint_requests_limit_reset': string;
15494
+ /**
15495
+ *
14917
15496
  * @type {string}
14918
- * @memberof CollectionMetadata
15497
+ * @memberof CreateMintRequestResult
14919
15498
  */
14920
- 'contract_uri': string | null;
15499
+ 'imx_remaining_mint_requests': string;
14921
15500
  /**
14922
- * The metadata uri for nft
15501
+ *
14923
15502
  * @type {string}
14924
- * @memberof CollectionMetadata
15503
+ * @memberof CreateMintRequestResult
14925
15504
  */
14926
- 'base_uri': string | null;
15505
+ 'imx_mint_requests_retry_after': string;
14927
15506
  }
14928
15507
 
14929
15508
  /**
@@ -15116,56 +15695,6 @@ interface GetCollectionResult {
15116
15695
  'result': Collection$1;
15117
15696
  }
15118
15697
 
15119
- /**
15120
- * Immutable zkEVM API
15121
- * Immutable Multi Rollup API
15122
- *
15123
- * The version of the OpenAPI document: 1.0.0
15124
- * Contact: support@immutable.com
15125
- *
15126
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
15127
- * https://openapi-generator.tech
15128
- * Do not edit the class manually.
15129
- */
15130
- /**
15131
- * @type NFTMetadataAttributeValue
15132
- * The metadata trait value
15133
- * @export
15134
- */
15135
- type NFTMetadataAttributeValue = boolean | number | string;
15136
-
15137
- /**
15138
- * Immutable zkEVM API
15139
- * Immutable Multi Rollup API
15140
- *
15141
- * The version of the OpenAPI document: 1.0.0
15142
- * Contact: support@immutable.com
15143
- *
15144
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
15145
- * https://openapi-generator.tech
15146
- * Do not edit the class manually.
15147
- */
15148
-
15149
- /**
15150
- *
15151
- * @export
15152
- * @interface NFTMetadataAttribute
15153
- */
15154
- interface NFTMetadataAttribute {
15155
- /**
15156
- * The metadata trait type
15157
- * @type {string}
15158
- * @memberof NFTMetadataAttribute
15159
- */
15160
- 'trait_type': string;
15161
- /**
15162
- *
15163
- * @type {NFTMetadataAttributeValue}
15164
- * @memberof NFTMetadataAttribute
15165
- */
15166
- 'value': NFTMetadataAttributeValue;
15167
- }
15168
-
15169
15698
  /**
15170
15699
  * Immutable zkEVM API
15171
15700
  * Immutable Multi Rollup API
@@ -15955,6 +16484,38 @@ interface ListMetadataResult {
15955
16484
  'page': Page$2;
15956
16485
  }
15957
16486
 
16487
+ /**
16488
+ * Immutable zkEVM API
16489
+ * Immutable Multi Rollup API
16490
+ *
16491
+ * The version of the OpenAPI document: 1.0.0
16492
+ * Contact: support@immutable.com
16493
+ *
16494
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
16495
+ * https://openapi-generator.tech
16496
+ * Do not edit the class manually.
16497
+ */
16498
+
16499
+ /**
16500
+ * List mint requests
16501
+ * @export
16502
+ * @interface ListMintRequestsResult
16503
+ */
16504
+ interface ListMintRequestsResult {
16505
+ /**
16506
+ * List of mint requests
16507
+ * @type {Array<GetMintRequestResult>}
16508
+ * @memberof ListMintRequestsResult
16509
+ */
16510
+ 'result': Array<GetMintRequestResult>;
16511
+ /**
16512
+ *
16513
+ * @type {Page}
16514
+ * @memberof ListMintRequestsResult
16515
+ */
16516
+ 'page': Page$2;
16517
+ }
16518
+
15958
16519
  /**
15959
16520
  * Immutable zkEVM API
15960
16521
  * Immutable Multi Rollup API
@@ -16298,106 +16859,6 @@ interface MetadataRefreshRateLimitResult {
16298
16859
  'retry_after': string;
16299
16860
  }
16300
16861
 
16301
- /**
16302
- * Immutable zkEVM API
16303
- * Immutable Multi Rollup API
16304
- *
16305
- * The version of the OpenAPI document: 1.0.0
16306
- * Contact: support@immutable.com
16307
- *
16308
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
16309
- * https://openapi-generator.tech
16310
- * Do not edit the class manually.
16311
- */
16312
-
16313
- /**
16314
- *
16315
- * @export
16316
- * @interface NFTMetadataRequest
16317
- */
16318
- interface NFTMetadataRequest {
16319
- /**
16320
- * The name of the NFT
16321
- * @type {string}
16322
- * @memberof NFTMetadataRequest
16323
- */
16324
- 'name'?: string | null;
16325
- /**
16326
- * The description of the NFT
16327
- * @type {string}
16328
- * @memberof NFTMetadataRequest
16329
- */
16330
- 'description'?: string | null;
16331
- /**
16332
- * The image url of the NFT
16333
- * @type {string}
16334
- * @memberof NFTMetadataRequest
16335
- */
16336
- 'image'?: string | null;
16337
- /**
16338
- * The external link of the NFT
16339
- * @type {string}
16340
- * @memberof NFTMetadataRequest
16341
- */
16342
- 'external_url'?: string | null;
16343
- /**
16344
- * The animation url of the NFT
16345
- * @type {string}
16346
- * @memberof NFTMetadataRequest
16347
- */
16348
- 'animation_url'?: string | null;
16349
- /**
16350
- * The youtube link of the NFT
16351
- * @type {string}
16352
- * @memberof NFTMetadataRequest
16353
- */
16354
- 'youtube_url'?: string | null;
16355
- /**
16356
- * List of Metadata attributes
16357
- * @type {Array<NFTMetadataAttribute>}
16358
- * @memberof NFTMetadataRequest
16359
- */
16360
- 'attributes'?: Array<NFTMetadataAttribute> | null;
16361
- }
16362
-
16363
- /**
16364
- * Immutable zkEVM API
16365
- * Immutable Multi Rollup API
16366
- *
16367
- * The version of the OpenAPI document: 1.0.0
16368
- * Contact: support@immutable.com
16369
- *
16370
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
16371
- * https://openapi-generator.tech
16372
- * Do not edit the class manually.
16373
- */
16374
-
16375
- /**
16376
- *
16377
- * @export
16378
- * @interface MintAsset
16379
- */
16380
- interface MintAsset {
16381
- /**
16382
- * The ID of this asset in the system that originates the mint request
16383
- * @type {string}
16384
- * @memberof MintAsset
16385
- */
16386
- 'reference_id': string;
16387
- /**
16388
- * The address of the receiver
16389
- * @type {string}
16390
- * @memberof MintAsset
16391
- */
16392
- 'owner_address': string;
16393
- /**
16394
- *
16395
- * @type {NFTMetadataRequest}
16396
- * @memberof MintAsset
16397
- */
16398
- 'metadata'?: NFTMetadataRequest;
16399
- }
16400
-
16401
16862
  /**
16402
16863
  * Immutable zkEVM API
16403
16864
  * Immutable Multi Rollup API
@@ -17191,6 +17652,56 @@ interface ListOwnersByContractAddressRequestParams {
17191
17652
  * Do not edit the class manually.
17192
17653
  */
17193
17654
 
17655
+ /**
17656
+ * Request parameters for createMintRequest operation in NftsApi.
17657
+ * @export
17658
+ * @interface CreateMintRequestRequest
17659
+ */
17660
+ interface CreateMintRequestRequestParams {
17661
+ /**
17662
+ * The address of contract
17663
+ * @type {string}
17664
+ * @memberof CreateMintRequest
17665
+ */
17666
+ readonly contractAddress: string;
17667
+ /**
17668
+ * The name of chain
17669
+ * @type {string}
17670
+ * @memberof CreateMintRequest
17671
+ */
17672
+ readonly chainName: string;
17673
+ /**
17674
+ * the request body
17675
+ * @type {CreateMintRequestRequest}
17676
+ * @memberof CreateMintRequest
17677
+ */
17678
+ readonly createMintRequestRequest: CreateMintRequestRequest;
17679
+ }
17680
+ /**
17681
+ * Request parameters for getMintRequest operation in NftsApi.
17682
+ * @export
17683
+ * @interface GetMintRequestRequest
17684
+ */
17685
+ interface GetMintRequestRequestParams {
17686
+ /**
17687
+ * The address of contract
17688
+ * @type {string}
17689
+ * @memberof GetMintRequest
17690
+ */
17691
+ readonly contractAddress: string;
17692
+ /**
17693
+ * The name of chain
17694
+ * @type {string}
17695
+ * @memberof GetMintRequest
17696
+ */
17697
+ readonly chainName: string;
17698
+ /**
17699
+ * The ID of the mint request
17700
+ * @type {string}
17701
+ * @memberof GetMintRequest
17702
+ */
17703
+ readonly referenceId: string;
17704
+ }
17194
17705
  /**
17195
17706
  * Request parameters for getNFT operation in NftsApi.
17196
17707
  * @export
@@ -17247,6 +17758,43 @@ interface ListAllNFTsRequestParams {
17247
17758
  */
17248
17759
  readonly pageSize?: number;
17249
17760
  }
17761
+ /**
17762
+ * Request parameters for listMintRequests operation in NftsApi.
17763
+ * @export
17764
+ * @interface ListMintRequestsRequest
17765
+ */
17766
+ interface ListMintRequestsRequestParams {
17767
+ /**
17768
+ * The address of contract
17769
+ * @type {string}
17770
+ * @memberof ListMintRequests
17771
+ */
17772
+ readonly contractAddress: string;
17773
+ /**
17774
+ * The name of chain
17775
+ * @type {string}
17776
+ * @memberof ListMintRequests
17777
+ */
17778
+ readonly chainName: string;
17779
+ /**
17780
+ * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
17781
+ * @type {string}
17782
+ * @memberof ListMintRequests
17783
+ */
17784
+ readonly pageCursor?: string;
17785
+ /**
17786
+ * Maximum number of items to return
17787
+ * @type {number}
17788
+ * @memberof ListMintRequests
17789
+ */
17790
+ readonly pageSize?: number;
17791
+ /**
17792
+ * The status of the mint request
17793
+ * @type {MintRequestStatus}
17794
+ * @memberof ListMintRequests
17795
+ */
17796
+ readonly status?: MintRequestStatus;
17797
+ }
17250
17798
  /**
17251
17799
  * Request parameters for listNFTs operation in NftsApi.
17252
17800
  * @export
@@ -17447,6 +17995,9 @@ type index_d_ChainWithDetailsAllOf = ChainWithDetailsAllOf;
17447
17995
  type index_d_CollectionContractType = CollectionContractType;
17448
17996
  declare const index_d_CollectionContractType: typeof CollectionContractType;
17449
17997
  type index_d_CollectionMetadata = CollectionMetadata;
17998
+ type index_d_CreateMintRequestRequest = CreateMintRequestRequest;
17999
+ type index_d_CreateMintRequestRequestParams = CreateMintRequestRequestParams;
18000
+ type index_d_CreateMintRequestResult = CreateMintRequestResult;
17450
18001
  type index_d_ERC1155ItemTypeEnum = ERC1155ItemTypeEnum;
17451
18002
  declare const index_d_ERC1155ItemTypeEnum: typeof ERC1155ItemTypeEnum;
17452
18003
  type index_d_ERC20ItemTypeEnum = ERC20ItemTypeEnum;
@@ -17460,6 +18011,7 @@ type index_d_GetCollectionResult = GetCollectionResult;
17460
18011
  type index_d_GetERC20TokenRequestParams = GetERC20TokenRequestParams;
17461
18012
  type index_d_GetMetadataRequestParams = GetMetadataRequestParams;
17462
18013
  type index_d_GetMetadataResult = GetMetadataResult;
18014
+ type index_d_GetMintRequestRequestParams = GetMintRequestRequestParams;
17463
18015
  type index_d_GetMintRequestResult = GetMintRequestResult;
17464
18016
  type index_d_GetNFTRequestParams = GetNFTRequestParams;
17465
18017
  type index_d_GetNFTResult = GetNFTResult;
@@ -17479,6 +18031,8 @@ type index_d_ListERC20TokensRequestParams = ListERC20TokensRequestParams;
17479
18031
  type index_d_ListMetadataForChainRequestParams = ListMetadataForChainRequestParams;
17480
18032
  type index_d_ListMetadataRequestParams = ListMetadataRequestParams;
17481
18033
  type index_d_ListMetadataResult = ListMetadataResult;
18034
+ type index_d_ListMintRequestsRequestParams = ListMintRequestsRequestParams;
18035
+ type index_d_ListMintRequestsResult = ListMintRequestsResult;
17482
18036
  type index_d_ListNFTOwnersRequestParams = ListNFTOwnersRequestParams;
17483
18037
  type index_d_ListNFTOwnersResult = ListNFTOwnersResult;
17484
18038
  type index_d_ListNFTsByAccountAddressRequestParams = ListNFTsByAccountAddressRequestParams;
@@ -17565,6 +18119,9 @@ declare namespace index_d {
17565
18119
  Collection$1 as Collection,
17566
18120
  index_d_CollectionContractType as CollectionContractType,
17567
18121
  index_d_CollectionMetadata as CollectionMetadata,
18122
+ index_d_CreateMintRequestRequest as CreateMintRequestRequest,
18123
+ index_d_CreateMintRequestRequestParams as CreateMintRequestRequestParams,
18124
+ index_d_CreateMintRequestResult as CreateMintRequestResult,
17568
18125
  Deposit$1 as Deposit,
17569
18126
  ERC1155Item$1 as ERC1155Item,
17570
18127
  index_d_ERC1155ItemTypeEnum as ERC1155ItemTypeEnum,
@@ -17579,6 +18136,7 @@ declare namespace index_d {
17579
18136
  index_d_GetERC20TokenRequestParams as GetERC20TokenRequestParams,
17580
18137
  index_d_GetMetadataRequestParams as GetMetadataRequestParams,
17581
18138
  index_d_GetMetadataResult as GetMetadataResult,
18139
+ index_d_GetMintRequestRequestParams as GetMintRequestRequestParams,
17582
18140
  index_d_GetMintRequestResult as GetMintRequestResult,
17583
18141
  index_d_GetNFTRequestParams as GetNFTRequestParams,
17584
18142
  index_d_GetNFTResult as GetNFTResult,
@@ -17599,6 +18157,8 @@ declare namespace index_d {
17599
18157
  index_d_ListMetadataForChainRequestParams as ListMetadataForChainRequestParams,
17600
18158
  index_d_ListMetadataRequestParams as ListMetadataRequestParams,
17601
18159
  index_d_ListMetadataResult as ListMetadataResult,
18160
+ index_d_ListMintRequestsRequestParams as ListMintRequestsRequestParams,
18161
+ index_d_ListMintRequestsResult as ListMintRequestsResult,
17602
18162
  index_d_ListNFTOwnersRequestParams as ListNFTOwnersRequestParams,
17603
18163
  index_d_ListNFTOwnersResult as ListNFTOwnersResult,
17604
18164
  index_d_ListNFTsByAccountAddressRequestParams as ListNFTsByAccountAddressRequestParams,
@@ -17794,6 +18354,30 @@ declare class BlockchainData {
17794
18354
  * @throws {@link index.APIError}
17795
18355
  */
17796
18356
  listAllNFTs(request: NftsApiListAllNFTsRequest): Promise<ListNFTsResult$1>;
18357
+ /**
18358
+ * Create a mint request to mint a set of NFTs for a given collection
18359
+ * @experimental
18360
+ * @param request - the request object containing the parameters to be provided in the API request
18361
+ * @returns a promise that resolves with the remaining rate limits
18362
+ * @throws {@link index.APIError}
18363
+ */
18364
+ createMintRequest(request: NftsApiCreateMintRequestRequest): Promise<CreateMintRequestResult$1>;
18365
+ /**
18366
+ * List all mint requests for a given contract address
18367
+ * @experimental
18368
+ * @param request - the request object containing the parameters to be provided in the API request
18369
+ * @returns a promise that resolves with a list of mint requests
18370
+ * @throws {@link index.APIError}
18371
+ */
18372
+ listMintRequests(request: NftsApiListMintRequestsRequest): Promise<ListMintRequestsResult$1>;
18373
+ /**
18374
+ * Retrieve the status of a single mint request identified by its reference ID
18375
+ * @experimental
18376
+ * @param request - the request object containing the parameters to be provided in the API request
18377
+ * @returns a promise that resolves with a single mint request
18378
+ * @throws {@link index.APIError}
18379
+ */
18380
+ getMintRequest(request: NftsApiGetMintRequestRequest): Promise<ListMintRequestsResult$1>;
17797
18381
  /**
17798
18382
  * List NFT owners by token ID
17799
18383
  * @param request - the request object containing the parameters to be provided in the API request