@imtbl/generated-clients 2.0.0-alpha.0

package/dist/types/multi-rollup/domain/tokens-api.d.ts

@@ -0,0 +1,183 @@
+/**
+ * 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 type { Configuration } from '../configuration';
+import type { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
+import { RequestArgs, BaseAPI } from '../base';
+import { AssetVerificationStatus } from '../models';
+import { GetTokenResult } from '../models';
+import { ListTokensResult } from '../models';
+/**
+ * TokensApi - axios parameter creator
+ * @export
+ */
+export declare const TokensApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Get single ERC20 token
+     * @summary Get single ERC20 token
+     * @param {string} contractAddress The address of contract
+     * @param {string} chainName The name of chain
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getERC20Token: (contractAddress: string, chainName: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * List ERC20 tokens
+     * @summary List ERC20 tokens
+     * @param {string} chainName The name of chain
+     * @param {string} [fromUpdatedAt] Datetime to use as the oldest updated timestamp
+     * @param {Array<AssetVerificationStatus>} [verificationStatus] List of verification status to filter by
+     * @param {boolean} [isCanonical] [Experimental - Canonical token data may be updated] Filter by canonical or non-canonical tokens.
+     * @param {string} [pageCursor] Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
+     * @param {number} [pageSize] Maximum number of items to return
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listERC20Tokens: (chainName: string, fromUpdatedAt?: string, verificationStatus?: Array<AssetVerificationStatus>, isCanonical?: boolean, pageCursor?: string, pageSize?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * TokensApi - functional programming interface
+ * @export
+ */
+export declare const TokensApiFp: (configuration?: Configuration) => {
+    /**
+     * Get single ERC20 token
+     * @summary Get single ERC20 token
+     * @param {string} contractAddress The address of contract
+     * @param {string} chainName The name of chain
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getERC20Token(contractAddress: string, chainName: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetTokenResult>>;
+    /**
+     * List ERC20 tokens
+     * @summary List ERC20 tokens
+     * @param {string} chainName The name of chain
+     * @param {string} [fromUpdatedAt] Datetime to use as the oldest updated timestamp
+     * @param {Array<AssetVerificationStatus>} [verificationStatus] List of verification status to filter by
+     * @param {boolean} [isCanonical] [Experimental - Canonical token data may be updated] Filter by canonical or non-canonical tokens.
+     * @param {string} [pageCursor] Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
+     * @param {number} [pageSize] Maximum number of items to return
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listERC20Tokens(chainName: string, fromUpdatedAt?: string, verificationStatus?: Array<AssetVerificationStatus>, isCanonical?: boolean, pageCursor?: string, pageSize?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListTokensResult>>;
+};
+/**
+ * TokensApi - factory interface
+ * @export
+ */
+export declare const TokensApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Get single ERC20 token
+     * @summary Get single ERC20 token
+     * @param {TokensApiGetERC20TokenRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getERC20Token(requestParameters: TokensApiGetERC20TokenRequest, options?: AxiosRequestConfig): AxiosPromise<GetTokenResult>;
+    /**
+     * List ERC20 tokens
+     * @summary List ERC20 tokens
+     * @param {TokensApiListERC20TokensRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listERC20Tokens(requestParameters: TokensApiListERC20TokensRequest, options?: AxiosRequestConfig): AxiosPromise<ListTokensResult>;
+};
+/**
+ * Request parameters for getERC20Token operation in TokensApi.
+ * @export
+ * @interface TokensApiGetERC20TokenRequest
+ */
+export interface TokensApiGetERC20TokenRequest {
+    /**
+     * The address of contract
+     * @type {string}
+     * @memberof TokensApiGetERC20Token
+     */
+    readonly contractAddress: string;
+    /**
+     * The name of chain
+     * @type {string}
+     * @memberof TokensApiGetERC20Token
+     */
+    readonly chainName: string;
+}
+/**
+ * Request parameters for listERC20Tokens operation in TokensApi.
+ * @export
+ * @interface TokensApiListERC20TokensRequest
+ */
+export interface TokensApiListERC20TokensRequest {
+    /**
+     * The name of chain
+     * @type {string}
+     * @memberof TokensApiListERC20Tokens
+     */
+    readonly chainName: string;
+    /**
+     * Datetime to use as the oldest updated timestamp
+     * @type {string}
+     * @memberof TokensApiListERC20Tokens
+     */
+    readonly fromUpdatedAt?: string;
+    /**
+     * List of verification status to filter by
+     * @type {Array<AssetVerificationStatus>}
+     * @memberof TokensApiListERC20Tokens
+     */
+    readonly verificationStatus?: Array<AssetVerificationStatus>;
+    /**
+     * [Experimental - Canonical token data may be updated] Filter by canonical or non-canonical tokens.
+     * @type {boolean}
+     * @memberof TokensApiListERC20Tokens
+     */
+    readonly isCanonical?: boolean;
+    /**
+     * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
+     * @type {string}
+     * @memberof TokensApiListERC20Tokens
+     */
+    readonly pageCursor?: string;
+    /**
+     * Maximum number of items to return
+     * @type {number}
+     * @memberof TokensApiListERC20Tokens
+     */
+    readonly pageSize?: number;
+}
+/**
+ * TokensApi - object-oriented interface
+ * @export
+ * @class TokensApi
+ * @extends {BaseAPI}
+ */
+export declare class TokensApi extends BaseAPI {
+    /**
+     * Get single ERC20 token
+     * @summary Get single ERC20 token
+     * @param {TokensApiGetERC20TokenRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof TokensApi
+     */
+    getERC20Token(requestParameters: TokensApiGetERC20TokenRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetTokenResult, any>>;
+    /**
+     * List ERC20 tokens
+     * @summary List ERC20 tokens
+     * @param {TokensApiListERC20TokensRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof TokensApi
+     */
+    listERC20Tokens(requestParameters: TokensApiListERC20TokensRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListTokensResult, any>>;
+}

package/dist/types/multi-rollup/index.d.ts

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

package/dist/types/multi-rollup/models/active-order-status.d.ts

@@ -0,0 +1,28 @@
+/**
+ * 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 ActiveOrderStatus
+ */
+export interface ActiveOrderStatus {
+    /**
+     * The order status that indicates an order can be fulfilled.
+     * @type {string}
+     * @memberof ActiveOrderStatus
+     */
+    'name': ActiveOrderStatusNameEnum;
+}
+export declare const ActiveOrderStatusNameEnum: {
+    readonly Active: "ACTIVE";
+};
+export type ActiveOrderStatusNameEnum = typeof ActiveOrderStatusNameEnum[keyof typeof ActiveOrderStatusNameEnum];

package/dist/types/multi-rollup/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/multi-rollup/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/multi-rollup/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/multi-rollup/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;
+}

package/dist/types/multi-rollup/models/activity-token.d.ts

@@ -0,0 +1,31 @@
+/**
+ * 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 { TokenContractType } from './token-contract-type';
+/**
+ *
+ * @export
+ * @interface ActivityToken
+ */
+export interface ActivityToken {
+    /**
+     *
+     * @type {TokenContractType}
+     * @memberof ActivityToken
+     */
+    'contract_type': TokenContractType;
+    /**
+     * The contract address
+     * @type {string}
+     * @memberof ActivityToken
+     */
+    'contract_address': string;
+}

package/dist/types/multi-rollup/models/activity-type.d.ts

@@ -0,0 +1,25 @@
+/**
+ * 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 activity type
+ * @export
+ * @enum {string}
+ */
+export declare const ActivityType: {
+    readonly Mint: "mint";
+    readonly Burn: "burn";
+    readonly Transfer: "transfer";
+    readonly Sale: "sale";
+    readonly Deposit: "deposit";
+    readonly Withdrawal: "withdrawal";
+};
+export type ActivityType = typeof ActivityType[keyof typeof ActivityType];

package/dist/types/multi-rollup/models/activity.d.ts

@@ -0,0 +1,64 @@
+/**
+ * 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 { ActivityDetails } from './activity-details';
+import { ActivityType } from './activity-type';
+import { BlockchainMetadata } from './blockchain-metadata';
+import { Chain } from './chain';
+/**
+ *
+ * @export
+ * @interface Activity
+ */
+export interface Activity {
+    /**
+     * Activity id in UUIDv4 format
+     * @type {string}
+     * @memberof Activity
+     */
+    'id': string;
+    /**
+     *
+     * @type {Chain}
+     * @memberof Activity
+     */
+    'chain': Chain;
+    /**
+     *
+     * @type {ActivityType}
+     * @memberof Activity
+     */
+    'type': ActivityType;
+    /**
+     *
+     * @type {ActivityDetails}
+     * @memberof Activity
+     */
+    'details': ActivityDetails;
+    /**
+     * The time activity was updated at
+     * @type {string}
+     * @memberof Activity
+     */
+    'updated_at': string;
+    /**
+     * The time activity was indexed
+     * @type {string}
+     * @memberof Activity
+     */
+    'indexed_at': string;
+    /**
+     *
+     * @type {BlockchainMetadata}
+     * @memberof Activity
+     */
+    'blockchain_metadata': BlockchainMetadata | null;
+}

package/dist/types/multi-rollup/models/analysis.d.ts

@@ -0,0 +1,37 @@
+/**
+ * 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 { Severity } from './severity';
+/**
+ * Contains a recommended action and warnings pertaining to the simulated transaction, such as interactions with known malicious addresses
+ * @export
+ * @interface Analysis
+ */
+export interface Analysis {
+    /**
+     *
+     * @type {Severity}
+     * @memberof Analysis
+     */
+    'severity': Severity;
+    /**
+     * description of the analysis
+     * @type {string}
+     * @memberof Analysis
+     */
+    'description': string;
+    /**
+     * address of related analysis
+     * @type {string}
+     * @memberof Analysis
+     */
+    'address'?: string;
+}

package/dist/types/multi-rollup/models/apierror400-all-of.d.ts

@@ -0,0 +1,34 @@
+/**
+ * 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 APIError400AllOf
+ */
+export interface APIError400AllOf {
+    /**
+     * Error Code
+     * @type {string}
+     * @memberof APIError400AllOf
+     */
+    'code': APIError400AllOfCodeEnum;
+    /**
+     * Additional details to help resolve the error
+     * @type {object}
+     * @memberof APIError400AllOf
+     */
+    'details': object | null;
+}
+export declare const APIError400AllOfCodeEnum: {
+    readonly ValidationError: "VALIDATION_ERROR";
+};
+export type APIError400AllOfCodeEnum = typeof APIError400AllOfCodeEnum[keyof typeof APIError400AllOfCodeEnum];

package/dist/types/multi-rollup/models/apierror400.d.ts

@@ -0,0 +1,18 @@
+/**
+ * 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 { APIError400AllOf } from './apierror400-all-of';
+import { BasicAPIError } from './basic-apierror';
+/**
+ * @type APIError400
+ * @export
+ */
+export type APIError400 = APIError400AllOf & BasicAPIError;

package/dist/types/multi-rollup/models/apierror401-all-of.d.ts

@@ -0,0 +1,34 @@
+/**
+ * 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 APIError401AllOf
+ */
+export interface APIError401AllOf {
+    /**
+     * Error Code
+     * @type {string}
+     * @memberof APIError401AllOf
+     */
+    'code': APIError401AllOfCodeEnum;
+    /**
+     * Additional details to help resolve the error
+     * @type {object}
+     * @memberof APIError401AllOf
+     */
+    'details': object | null;
+}
+export declare const APIError401AllOfCodeEnum: {
+    readonly UnauthorisedRequest: "UNAUTHORISED_REQUEST";
+};
+export type APIError401AllOfCodeEnum = typeof APIError401AllOfCodeEnum[keyof typeof APIError401AllOfCodeEnum];

package/dist/types/multi-rollup/models/apierror401.d.ts

@@ -0,0 +1,18 @@
+/**
+ * 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 { APIError401AllOf } from './apierror401-all-of';
+import { BasicAPIError } from './basic-apierror';
+/**
+ * @type APIError401
+ * @export
+ */
+export type APIError401 = APIError401AllOf & BasicAPIError;

package/dist/types/multi-rollup/models/apierror403-all-of.d.ts

@@ -0,0 +1,34 @@
+/**
+ * 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 APIError403AllOf
+ */
+export interface APIError403AllOf {
+    /**
+     * Error Code
+     * @type {string}
+     * @memberof APIError403AllOf
+     */
+    'code': APIError403AllOfCodeEnum;
+    /**
+     * Additional details to help resolve the error
+     * @type {object}
+     * @memberof APIError403AllOf
+     */
+    'details': object | null;
+}
+export declare const APIError403AllOfCodeEnum: {
+    readonly AuthenticationError: "AUTHENTICATION_ERROR";
+};
+export type APIError403AllOfCodeEnum = typeof APIError403AllOfCodeEnum[keyof typeof APIError403AllOfCodeEnum];

package/dist/types/multi-rollup/models/apierror403.d.ts

@@ -0,0 +1,18 @@
+/**
+ * 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 { APIError403AllOf } from './apierror403-all-of';
+import { BasicAPIError } from './basic-apierror';
+/**
+ * @type APIError403
+ * @export
+ */
+export type APIError403 = APIError403AllOf & BasicAPIError;