@imtbl/sdk 1.26.2-alpha.2 → 1.26.3

package/dist/index.d.ts

@@ -4980,12 +4980,6 @@ interface GetPrimarySaleOKBody {
  * @interface Project
  */
 interface Project {
-    /**
-     * API key for the project. This is only for zkevm project. This API is not for increasing rate limit yet.
-     * @type {string}
-     * @memberof Project
-     */
-    'api_key'?: string;
     /**
      * The project ChainType
      * @type {string}
@@ -4993,73 +4987,13 @@ interface Project {
      */
     'chain_type'?: string;
     /**
-     * The current period expiry date for collection limit
-     * @type {string}
-     * @memberof Project
-     */
-    'collection_limit_expires_at': string;
-    /**
-     * The total monthly collection limit
-     * @type {number}
-     * @memberof Project
-     */
-    'collection_monthly_limit': number;
-    /**
-     * The number of collection remaining in the current period
-     * @type {number}
-     * @memberof Project
-     */
-    'collection_remaining': number;
-    /**
-     * The company name
-     * @type {string}
-     * @memberof Project
-     */
-    'company_name': string;
-    /**
-     * The project contact email (must be registered as a developer account with Immutable at https://hub.immutable.com)
+     * The project group ID
      * @type {string}
      * @memberof Project
      */
-    'contact_email': string;
-    /**
-     * The environment ID
-     * @type {string}
-     * @memberof Project
-     */
-    'environment_id'?: string;
-    /**
-     * The user environment name correlating to this project
-     * @type {string}
-     * @memberof Project
-     */
-    'environment_name'?: string;
-    /**
-     * The project ID
-     * @type {number}
-     * @memberof Project
-     */
-    'id': number;
-    /**
-     * The current period expiry date for mint operation limit
-     * @type {string}
-     * @memberof Project
-     */
-    'mint_limit_expires_at': string;
-    /**
-     * The total monthly mint operation limit
-     * @type {number}
-     * @memberof Project
-     */
-    'mint_monthly_limit': number;
-    /**
-     * The number of mint operation remaining in the current period
-     * @type {number}
-     * @memberof Project
-     */
-    'mint_remaining': number;
+    'id': string;
     /**
-     * The project name
+     * The project group name
      * @type {string}
      * @memberof Project
      */
@@ -5070,24 +5004,6 @@ interface Project {
      * @memberof Project
      */
     'org_id'?: string;
-    /**
-     * Project group id
-     * @type {string}
-     * @memberof Project
-     */
-    'project_group_id'?: string;
-    /**
-     * The public publishable_key for the project
-     * @type {string}
-     * @memberof Project
-     */
-    'publishable_key'?: string;
-    /**
-     * The public publishable_key created time
-     * @type {string}
-     * @memberof Project
-     */
-    'publishable_key_created_at'?: string;
 }
 
 /**
@@ -6510,7 +6426,7 @@ interface GetSignableWithdrawalResponseV2 {
      */
     'asset_id': string;
     /**
-     * Token in request to match in SDK implementation
+     * Expiration timestamp for this withdrawal
      * @type {number}
      * @memberof GetSignableWithdrawalResponseV2
      */
@@ -6811,6 +6727,25 @@ interface ListDepositsResponse {
  */
 type MintToken = Token$2;
 
+/**
+ * Immutable X API
+ * Immutable X API
+ *
+ * The version of the OpenAPI document: 3.0.0
+ * Contact: support@immutable.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+/**
+ * @type MintTokenOAIGen
+ * Details of the asset which has been minted
+ * @export
+ */
+type MintTokenOAIGen = MintToken;
+
 /**
  * Immutable X API
  * Immutable X API
@@ -6849,10 +6784,10 @@ interface Mint$2 {
     'timestamp': string;
     /**
      *
-     * @type {MintToken}
+     * @type {MintTokenOAIGen}
      * @memberof Mint
      */
-    'token': MintToken;
+    'token': MintTokenOAIGen;
     /**
      * Sequential ID of transaction in Immutable X
      * @type {number}
@@ -12504,8 +12439,8 @@ interface WithdrawalsApiListWithdrawalsRequest$1 {
  */
 declare class WithdrawalsApi$1 extends BaseAPI {
     /**
-     * Creates a withdrawal. Use https://docs.x.immutable.com/reference#/operations/getSignableWithdrawal to get request body params.
-     * @summary Creates a withdrawal of a token
+     * Creates a withdrawal. Use https://docs.x.immutable.com/reference/#/operations/getSignableWithdrawal to get request body params. This endpoint will be deprecated once StarkEx contract gets upgraded to v4, check https://docs.immutable.com/x/reference/#/operations/createWithdrawalV2.
+     * @summary Creates a withdrawal
      * @param {WithdrawalsApiCreateWithdrawalRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -12513,8 +12448,8 @@ declare class WithdrawalsApi$1 extends BaseAPI {
      */
     createWithdrawal(requestParameters: WithdrawalsApiCreateWithdrawalRequest, options?: AxiosRequestConfig): Promise<AxiosResponse<CreateWithdrawalResponse, any>>;
     /**
-     * Creates a withdrawal. Use https://docs.x.immutable.com/reference#/operations/getSignableWithdrawal to get request body params.
-     * @summary Creates a withdrawal of a token for starkex contracts that are higher than v3
+     * Creates a withdrawal. Use https://docs.immutable.com/x/reference/#/operations/getSignableWithdrawalV2 to get request body params.
+     * @summary Creates a withdrawal of a token for when StarkEx contract that is higher than v3
      * @param {WithdrawalsApiCreateWithdrawalV2Request} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -12522,7 +12457,7 @@ declare class WithdrawalsApi$1 extends BaseAPI {
      */
     createWithdrawalV2(requestParameters: WithdrawalsApiCreateWithdrawalV2Request, options?: AxiosRequestConfig): Promise<AxiosResponse<CreateWithdrawalResponse, any>>;
     /**
-     * Gets details of a signable withdrawal
+     * Gets details of a signable withdrawal. This endpoint will be deprecated once StarkEx contract gets upgraded to v4, check https://docs.immutable.com/x/reference/#/operations/getSignableWithdrawalV2.
      * @summary Gets details of a signable withdrawal
      * @param {WithdrawalsApiGetSignableWithdrawalRequest} requestParameters Request parameters.
      * @param {*} [options] Override http request option.
@@ -13368,6 +13303,31 @@ interface Activity$1 {
     'blockchain_metadata': BlockchainMetadata$1 | null;
 }
 
+/**
+ * Immutable zkEVM API
+ * Immutable Multi Rollup API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * Contact: support@immutable.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * The verification status for a given contract
+ * @export
+ * @enum {string}
+ */
+declare const AssetVerificationStatus: {
+    readonly Pending: "pending";
+    readonly Verified: "verified";
+    readonly Unverified: "unverified";
+    readonly Spam: "spam";
+    readonly Inactive: "inactive";
+};
+type AssetVerificationStatus = typeof AssetVerificationStatus[keyof typeof AssetVerificationStatus];
+
 /**
  * Immutable zkEVM API
  * Immutable Multi Rollup API
@@ -13511,6 +13471,12 @@ interface Collection$1 {
      * @memberof Collection
      */
     'base_uri': string | null;
+    /**
+     *
+     * @type {AssetVerificationStatus}
+     * @memberof Collection
+     */
+    'verification_status': AssetVerificationStatus;
     /**
      * When the collection was first indexed
      * @type {string}
@@ -13735,7 +13701,7 @@ interface MintAsset$1 {
      */
     'owner_address': string;
     /**
-     * An `uint256` token id as string. Including token_id is currently only possible on Testnet
+     * An optional `uint256` token id as string. It is recommended to omit token_id for more efficient minting
      * @type {string}
      * @memberof MintAsset
      */
@@ -14323,6 +14289,12 @@ interface Token$1 {
      * @memberof Token
      */
     'name': string | null;
+    /**
+     *
+     * @type {AssetVerificationStatus}
+     * @memberof Token
+     */
+    'verification_status': AssetVerificationStatus;
     /**
      * When the collection was last updated
      * @type {string}
@@ -14591,11 +14563,18 @@ interface NFTOwner$1 {
      */
     'account_address': string;
     /**
-     * The quantity of owned tokens (uint256 as string)
+     * (deprecated - use balance instead) The quantity of owned tokens (uint256 as string)
      * @type {string}
      * @memberof NFTOwner
+     * @deprecated
      */
     'quantity': string;
+    /**
+     * The amount of owned tokens (uint256 as string)
+     * @type {string}
+     * @memberof NFTOwner
+     */
+    'balance': string;
     /**
      * When the NFT owner was last updated
      * @type {string}
@@ -15144,6 +15123,12 @@ interface CollectionsApiListCollectionsRequest$1 {
      * @memberof CollectionsApiListCollections
      */
     readonly contractAddress?: Array<string>;
+    /**
+     * List of verification status to filter by
+     * @type {Array<AssetVerificationStatus>}
+     * @memberof CollectionsApiListCollections
+     */
+    readonly verificationStatus?: Array<AssetVerificationStatus>;
     /**
      * Datetime to use as the oldest updated timestamp
      * @type {string}
@@ -15700,6 +15685,12 @@ interface TokensApiListERC20TokensRequest {
      * @memberof TokensApiListERC20Tokens
      */
     readonly fromUpdatedAt?: string;
+    /**
+     * List of verification status to filter by
+     * @type {Array<AssetVerificationStatus>}
+     * @memberof TokensApiListERC20Tokens
+     */
+    readonly verificationStatus?: Array<AssetVerificationStatus>;
     /**
      * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
      * @type {string}