@imtbl/generated-clients 2.0.0-alpha.0

package/dist/types/blockchain-data/domain/nft-owners-api.d.ts

@@ -0,0 +1,127 @@
+/**
+ * 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.
+ */
+export type { APIError400 } from '../models';
+export type { APIError404 } from '../models';
+export type { APIError500 } from '../models';
+export type { ListCollectionOwnersResult } from '../models';
+export type { ListNFTOwnersResult } from '../models';
+/**
+ * Request parameters for listAllNFTOwners operation in NftOwnersApi.
+ * @export
+ * @interface ListAllNFTOwnersRequest
+ */
+export interface ListAllNFTOwnersRequestParams {
+    /**
+     * The name of chain
+     * @type {string}
+     * @memberof ListAllNFTOwners
+     */
+    readonly chainName: string;
+    /**
+     * Datetime to use as the oldest updated timestamp
+     * @type {string}
+     * @memberof ListAllNFTOwners
+     */
+    readonly fromUpdatedAt?: string;
+    /**
+     * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
+     * @type {string}
+     * @memberof ListAllNFTOwners
+     */
+    readonly pageCursor?: string;
+    /**
+     * Maximum number of items to return
+     * @type {number}
+     * @memberof ListAllNFTOwners
+     */
+    readonly pageSize?: number;
+}
+/**
+ * Request parameters for listNFTOwners operation in NftOwnersApi.
+ * @export
+ * @interface ListNFTOwnersRequest
+ */
+export interface ListNFTOwnersRequestParams {
+    /**
+     * The address of contract
+     * @type {string}
+     * @memberof ListNFTOwners
+     */
+    readonly contractAddress: string;
+    /**
+     * An `uint256` token id as string
+     * @type {string}
+     * @memberof ListNFTOwners
+     */
+    readonly tokenId: string;
+    /**
+     * The name of chain
+     * @type {string}
+     * @memberof ListNFTOwners
+     */
+    readonly chainName: string;
+    /**
+     * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
+     * @type {string}
+     * @memberof ListNFTOwners
+     */
+    readonly pageCursor?: string;
+    /**
+     * Maximum number of items to return
+     * @type {number}
+     * @memberof ListNFTOwners
+     */
+    readonly pageSize?: number;
+}
+/**
+ * Request parameters for listOwnersByContractAddress operation in NftOwnersApi.
+ * @export
+ * @interface ListOwnersByContractAddressRequest
+ */
+export interface ListOwnersByContractAddressRequestParams {
+    /**
+     * The address of contract
+     * @type {string}
+     * @memberof ListOwnersByContractAddress
+     */
+    readonly contractAddress: string;
+    /**
+     * The name of chain
+     * @type {string}
+     * @memberof ListOwnersByContractAddress
+     */
+    readonly chainName: string;
+    /**
+     * List of account addresses to filter by
+     * @type {Array<string>}
+     * @memberof ListOwnersByContractAddress
+     */
+    readonly accountAddress?: Array<string>;
+    /**
+     * Datetime to use as the oldest updated timestamp
+     * @type {string}
+     * @memberof ListOwnersByContractAddress
+     */
+    readonly fromUpdatedAt?: string;
+    /**
+     * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
+     * @type {string}
+     * @memberof ListOwnersByContractAddress
+     */
+    readonly pageCursor?: string;
+    /**
+     * Maximum number of items to return
+     * @type {number}
+     * @memberof ListOwnersByContractAddress
+     */
+    readonly pageSize?: number;
+}

package/dist/types/blockchain-data/domain/nfts-api.d.ts

@@ -0,0 +1,262 @@
+/**
+ * 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.
+ */
+import { CreateMintRequestRequest } from '../models';
+import { MintRequestStatus } from '../models';
+export type { APIError400 } from '../models';
+export type { APIError401 } from '../models';
+export type { APIError403 } from '../models';
+export type { APIError404 } from '../models';
+export type { APIError409 } from '../models';
+export type { APIError429 } from '../models';
+export type { APIError500 } from '../models';
+export type { CreateMintRequestRequest } from '../models';
+export type { CreateMintRequestResult } from '../models';
+export type { GetNFTResult } from '../models';
+export type { ListMintRequestsResult } from '../models';
+export type { ListNFTsByOwnerResult } from '../models';
+export type { ListNFTsResult } from '../models';
+export type { MintRequestStatus } from '../models';
+/**
+ * Request parameters for createMintRequest operation in NftsApi.
+ * @export
+ * @interface CreateMintRequestRequest
+ */
+export interface CreateMintRequestRequestParams {
+    /**
+     * The address of contract
+     * @type {string}
+     * @memberof CreateMintRequest
+     */
+    readonly contractAddress: string;
+    /**
+     * The name of chain
+     * @type {string}
+     * @memberof CreateMintRequest
+     */
+    readonly chainName: string;
+    /**
+     * Create Mint Request Body
+     * @type {CreateMintRequestRequest}
+     * @memberof CreateMintRequest
+     */
+    readonly createMintRequestRequest: CreateMintRequestRequest;
+}
+/**
+ * Request parameters for getMintRequest operation in NftsApi.
+ * @export
+ * @interface GetMintRequestRequest
+ */
+export interface GetMintRequestRequestParams {
+    /**
+     * The address of contract
+     * @type {string}
+     * @memberof GetMintRequest
+     */
+    readonly contractAddress: string;
+    /**
+     * The name of chain
+     * @type {string}
+     * @memberof GetMintRequest
+     */
+    readonly chainName: string;
+    /**
+     * The id of the mint request
+     * @type {string}
+     * @memberof GetMintRequest
+     */
+    readonly referenceId: string;
+}
+/**
+ * Request parameters for getNFT operation in NftsApi.
+ * @export
+ * @interface GetNFTRequest
+ */
+export interface GetNFTRequestParams {
+    /**
+     * The address of NFT contract
+     * @type {string}
+     * @memberof GetNFT
+     */
+    readonly contractAddress: string;
+    /**
+     * An `uint256` token id as string
+     * @type {string}
+     * @memberof GetNFT
+     */
+    readonly tokenId: string;
+    /**
+     * The name of chain
+     * @type {string}
+     * @memberof GetNFT
+     */
+    readonly chainName: string;
+}
+/**
+ * Request parameters for listAllNFTs operation in NftsApi.
+ * @export
+ * @interface ListAllNFTsRequest
+ */
+export interface ListAllNFTsRequestParams {
+    /**
+     * The name of chain
+     * @type {string}
+     * @memberof ListAllNFTs
+     */
+    readonly chainName: string;
+    /**
+     * Datetime to use as the oldest updated timestamp
+     * @type {string}
+     * @memberof ListAllNFTs
+     */
+    readonly fromUpdatedAt?: string;
+    /**
+     * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
+     * @type {string}
+     * @memberof ListAllNFTs
+     */
+    readonly pageCursor?: string;
+    /**
+     * Maximum number of items to return
+     * @type {number}
+     * @memberof ListAllNFTs
+     */
+    readonly pageSize?: number;
+}
+/**
+ * Request parameters for listMintRequests operation in NftsApi.
+ * @export
+ * @interface ListMintRequestsRequest
+ */
+export interface ListMintRequestsRequestParams {
+    /**
+     * The address of contract
+     * @type {string}
+     * @memberof ListMintRequests
+     */
+    readonly contractAddress: string;
+    /**
+     * The name of chain
+     * @type {string}
+     * @memberof ListMintRequests
+     */
+    readonly chainName: string;
+    /**
+     * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
+     * @type {string}
+     * @memberof ListMintRequests
+     */
+    readonly pageCursor?: string;
+    /**
+     * Maximum number of items to return
+     * @type {number}
+     * @memberof ListMintRequests
+     */
+    readonly pageSize?: number;
+    /**
+     * The status of the mint request
+     * @type {MintRequestStatus}
+     * @memberof ListMintRequests
+     */
+    readonly status?: MintRequestStatus;
+}
+/**
+ * Request parameters for listNFTs operation in NftsApi.
+ * @export
+ * @interface ListNFTsRequest
+ */
+export interface ListNFTsRequestParams {
+    /**
+     * Contract address
+     * @type {string}
+     * @memberof ListNFTs
+     */
+    readonly contractAddress: string;
+    /**
+     * The name of chain
+     * @type {string}
+     * @memberof ListNFTs
+     */
+    readonly chainName: string;
+    /**
+     * List of token IDs to filter by
+     * @type {Array<string>}
+     * @memberof ListNFTs
+     */
+    readonly tokenId?: Array<string>;
+    /**
+     * Datetime to use as the oldest updated timestamp
+     * @type {string}
+     * @memberof ListNFTs
+     */
+    readonly fromUpdatedAt?: string;
+    /**
+     * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
+     * @type {string}
+     * @memberof ListNFTs
+     */
+    readonly pageCursor?: string;
+    /**
+     * Maximum number of items to return
+     * @type {number}
+     * @memberof ListNFTs
+     */
+    readonly pageSize?: number;
+}
+/**
+ * Request parameters for listNFTsByAccountAddress operation in NftsApi.
+ * @export
+ * @interface ListNFTsByAccountAddressRequest
+ */
+export interface ListNFTsByAccountAddressRequestParams {
+    /**
+     * Account address
+     * @type {string}
+     * @memberof ListNFTsByAccountAddress
+     */
+    readonly accountAddress: string;
+    /**
+     * The name of chain
+     * @type {string}
+     * @memberof ListNFTsByAccountAddress
+     */
+    readonly chainName: string;
+    /**
+     * The address of contract
+     * @type {string}
+     * @memberof ListNFTsByAccountAddress
+     */
+    readonly contractAddress?: string;
+    /**
+     * List of token IDs to filter by
+     * @type {Array<string>}
+     * @memberof ListNFTsByAccountAddress
+     */
+    readonly tokenId?: Array<string>;
+    /**
+     * Datetime to use as the oldest updated timestamp
+     * @type {string}
+     * @memberof ListNFTsByAccountAddress
+     */
+    readonly fromUpdatedAt?: string;
+    /**
+     * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
+     * @type {string}
+     * @memberof ListNFTsByAccountAddress
+     */
+    readonly pageCursor?: string;
+    /**
+     * Maximum number of items to return
+     * @type {number}
+     * @memberof ListNFTsByAccountAddress
+     */
+    readonly pageSize?: number;
+}

package/dist/types/blockchain-data/domain/pricing-api.d.ts

@@ -0,0 +1,81 @@
+/**
+ * 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.
+ */
+export type { APIError400 } from '../models';
+export type { APIError401 } from '../models';
+export type { APIError403 } from '../models';
+export type { APIError404 } from '../models';
+export type { APIError429 } from '../models';
+export type { APIError500 } from '../models';
+export type { QuotesForNFTsResult } from '../models';
+export type { QuotesForStacksResult } from '../models';
+/**
+ * Request parameters for quotesForNFTs operation in PricingApi.
+ * @export
+ * @interface QuotesForNFTsRequest
+ */
+export interface QuotesForNFTsRequestParams {
+    /**
+     * The name of chain
+     * @type {string}
+     * @memberof QuotesForNFTs
+     */
+    readonly chainName: string;
+    /**
+     * Contract address for collection that these token ids are on
+     * @type {string}
+     * @memberof QuotesForNFTs
+     */
+    readonly contractAddress: string;
+    /**
+     * List of token ids to get pricing data for
+     * @type {Array<string>}
+     * @memberof QuotesForNFTs
+     */
+    readonly tokenId: Array<string>;
+    /**
+     * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
+     * @type {string}
+     * @memberof QuotesForNFTs
+     */
+    readonly pageCursor?: string;
+}
+/**
+ * Request parameters for quotesForStacks operation in PricingApi.
+ * @export
+ * @interface QuotesForStacksRequest
+ */
+export interface QuotesForStacksRequestParams {
+    /**
+     * The name of chain
+     * @type {string}
+     * @memberof QuotesForStacks
+     */
+    readonly chainName: string;
+    /**
+     * Contract address for collection that these stacks are on
+     * @type {string}
+     * @memberof QuotesForStacks
+     */
+    readonly contractAddress: string;
+    /**
+     * List of stack ids to get pricing data for
+     * @type {Array<string>}
+     * @memberof QuotesForStacks
+     */
+    readonly stackId: Array<string>;
+    /**
+     * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
+     * @type {string}
+     * @memberof QuotesForStacks
+     */
+    readonly pageCursor?: string;
+}

package/dist/types/blockchain-data/domain/tokens-api.d.ts

@@ -0,0 +1,80 @@
+/**
+ * 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.
+ */
+import { AssetVerificationStatus } from '../models';
+export type { APIError400 } from '../models';
+export type { APIError404 } from '../models';
+export type { APIError500 } from '../models';
+export type { AssetVerificationStatus } from '../models';
+export type { GetTokenResult } from '../models';
+export type { ListTokensResult } from '../models';
+/**
+ * Request parameters for getERC20Token operation in TokensApi.
+ * @export
+ * @interface GetERC20TokenRequest
+ */
+export interface GetERC20TokenRequestParams {
+    /**
+     * The address of contract
+     * @type {string}
+     * @memberof GetERC20Token
+     */
+    readonly contractAddress: string;
+    /**
+     * The name of chain
+     * @type {string}
+     * @memberof GetERC20Token
+     */
+    readonly chainName: string;
+}
+/**
+ * Request parameters for listERC20Tokens operation in TokensApi.
+ * @export
+ * @interface ListERC20TokensRequest
+ */
+export interface ListERC20TokensRequestParams {
+    /**
+     * The name of chain
+     * @type {string}
+     * @memberof ListERC20Tokens
+     */
+    readonly chainName: string;
+    /**
+     * Datetime to use as the oldest updated timestamp
+     * @type {string}
+     * @memberof ListERC20Tokens
+     */
+    readonly fromUpdatedAt?: string;
+    /**
+     * List of verification status to filter by
+     * @type {Array<AssetVerificationStatus>}
+     * @memberof ListERC20Tokens
+     */
+    readonly verificationStatus?: Array<AssetVerificationStatus>;
+    /**
+     * [Experimental - Canonical token data may be updated] Filter by canonical or non-canonical tokens.
+     * @type {boolean}
+     * @memberof ListERC20Tokens
+     */
+    readonly isCanonical?: boolean;
+    /**
+     * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
+     * @type {string}
+     * @memberof ListERC20Tokens
+     */
+    readonly pageCursor?: string;
+    /**
+     * Maximum number of items to return
+     * @type {number}
+     * @memberof ListERC20Tokens
+     */
+    readonly pageSize?: number;
+}

package/dist/types/blockchain-data/index.d.ts

@@ -0,0 +1,13 @@
+/**
+ * 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.
+ */
+export * from "./api";
+export * from "./models";

package/dist/types/blockchain-data/models/activity-asset.d.ts

@@ -0,0 +1,19 @@
+/**
+ * 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.
+ */
+import { ActivityNFT } from './activity-nft';
+import { ActivityToken } from './activity-token';
+/**
+ * @type ActivityAsset
+ * The contract and asset details for this activity
+ * @export
+ */
+export type ActivityAsset = ActivityNFT | ActivityToken;

package/dist/types/blockchain-data/models/activity-details.d.ts

@@ -0,0 +1,23 @@
+/**
+ * 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.
+ */
+import { Burn } from './burn';
+import { Deposit } from './deposit';
+import { Mint } from './mint';
+import { NFTSale } from './nftsale';
+import { Transfer } from './transfer';
+import { Withdrawal } from './withdrawal';
+/**
+ * @type ActivityDetails
+ * The activity details
+ * @export
+ */
+export type ActivityDetails = Burn | Deposit | Mint | NFTSale | Transfer | Withdrawal;

package/dist/types/blockchain-data/models/activity-native-token.d.ts

@@ -0,0 +1,24 @@
+/**
+ * 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.
+ */
+/**
+ *
+ * @export
+ * @interface ActivityNativeToken
+ */
+export interface ActivityNativeToken {
+    /**
+     * The token symbol
+     * @type {string}
+     * @memberof ActivityNativeToken
+     */
+    'symbol': string;
+}

package/dist/types/blockchain-data/models/activity-nft.d.ts

@@ -0,0 +1,44 @@
+/**
+ * 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.
+ */
+import { NFTContractType } from './nftcontract-type';
+/**
+ *
+ * @export
+ * @interface ActivityNFT
+ */
+export interface ActivityNFT {
+    /**
+     *
+     * @type {NFTContractType}
+     * @memberof ActivityNFT
+     */
+    'contract_type': NFTContractType;
+    /**
+     * The token contract address
+     * @type {string}
+     * @memberof ActivityNFT
+     */
+    'contract_address': string;
+    /**
+     * An `uint256` token id as string
+     * @type {string}
+     * @memberof ActivityNFT
+     */
+    'token_id': string;
+    /**
+     * (deprecated - will never be filled, use amount on Activity instead) The amount of tokens exchanged
+     * @type {string}
+     * @memberof ActivityNFT
+     * @deprecated
+     */
+    'amount': string;
+}