@imtbl/generated-clients 2.0.0-alpha.0

package/dist/types/blockchain-data/models/sign-crafting-result.d.ts

@@ -0,0 +1,30 @@
+/**
+ * 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 SignCraftingResult
+ */
+export interface SignCraftingResult {
+    /**
+     * An Ethereum address
+     * @type {string}
+     * @memberof SignCraftingResult
+     */
+    'signer_address': string;
+    /**
+     * The signature of the request
+     * @type {string}
+     * @memberof SignCraftingResult
+     */
+    'signature': string;
+}

package/dist/types/blockchain-data/models/stack-bundle.d.ts

@@ -0,0 +1,52 @@
+/**
+ * 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 { Bid } from './bid';
+import { Listing } from './listing';
+import { Market } from './market';
+import { Stack } from './stack';
+/**
+ * Stack bundle includes stacks, markets and listings
+ * @export
+ * @interface StackBundle
+ */
+export interface StackBundle {
+    /**
+     *
+     * @type {Stack}
+     * @memberof StackBundle
+     */
+    'stack': Stack;
+    /**
+     * Total count of NFTs in the stack matching the filter params
+     * @type {number}
+     * @memberof StackBundle
+     */
+    'stack_count': number;
+    /**
+     *
+     * @type {Market}
+     * @memberof StackBundle
+     */
+    'market': Market | null;
+    /**
+     * List of open listings for the stack.
+     * @type {Array<Listing>}
+     * @memberof StackBundle
+     */
+    'listings': Array<Listing>;
+    /**
+     * List of open bids for the stack.
+     * @type {Array<Bid>}
+     * @memberof StackBundle
+     */
+    'bids': Array<Bid>;
+}

package/dist/types/blockchain-data/models/stack-quote-result.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 { Chain } from './chain';
+import { Market } from './market';
+/**
+ * Stack quote result
+ * @export
+ * @interface StackQuoteResult
+ */
+export interface StackQuoteResult {
+    /**
+     *
+     * @type {Chain}
+     * @memberof StackQuoteResult
+     */
+    'chain': Chain;
+    /**
+     *
+     * @type {string}
+     * @memberof StackQuoteResult
+     */
+    'stack_id': string;
+    /**
+     *
+     * @type {Market}
+     * @memberof StackQuoteResult
+     */
+    'market_stack': Market;
+    /**
+     *
+     * @type {Market}
+     * @memberof StackQuoteResult
+     */
+    'market_collection': Market;
+}

package/dist/types/blockchain-data/models/stack.d.ts

@@ -0,0 +1,99 @@
+/**
+ * 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 { Chain } from './chain';
+import { MarketplaceContractType } from './marketplace-contract-type';
+import { NFTMetadataAttribute } from './nftmetadata-attribute';
+/**
+ * Stack
+ * @export
+ * @interface Stack
+ */
+export interface Stack {
+    /**
+     * Stack ID
+     * @type {string}
+     * @memberof Stack
+     */
+    'stack_id': string;
+    /**
+     *
+     * @type {Chain}
+     * @memberof Stack
+     */
+    'chain': Chain;
+    /**
+     * Contract address
+     * @type {string}
+     * @memberof Stack
+     */
+    'contract_address': string;
+    /**
+     *
+     * @type {MarketplaceContractType}
+     * @memberof Stack
+     */
+    'contract_type': MarketplaceContractType;
+    /**
+     * When the metadata was created
+     * @type {string}
+     * @memberof Stack
+     */
+    'created_at': string;
+    /**
+     * When the metadata was last updated
+     * @type {string}
+     * @memberof Stack
+     */
+    'updated_at': string;
+    /**
+     * The name of the NFT
+     * @type {string}
+     * @memberof Stack
+     */
+    'name': string | null;
+    /**
+     * The description of the NFT
+     * @type {string}
+     * @memberof Stack
+     */
+    'description': string | null;
+    /**
+     * The image url of the NFT
+     * @type {string}
+     * @memberof Stack
+     */
+    'image': string | null;
+    /**
+     * The external website link of NFT
+     * @type {string}
+     * @memberof Stack
+     */
+    'external_url': string | null;
+    /**
+     * The animation url of the NFT
+     * @type {string}
+     * @memberof Stack
+     */
+    'animation_url': string | null;
+    /**
+     * The youtube URL of NFT
+     * @type {string}
+     * @memberof Stack
+     */
+    'youtube_url': string | null;
+    /**
+     * List of Metadata attributes
+     * @type {Array<NFTMetadataAttribute>}
+     * @memberof Stack
+     */
+    'attributes': Array<NFTMetadataAttribute> | null;
+}

package/dist/types/blockchain-data/models/token-contract-type.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.
+ */
+/**
+ * The contract type for a token
+ * @export
+ * @enum {string}
+ */
+export declare enum TokenContractType {
+    Erc20 = "ERC20"
+}

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

@@ -0,0 +1,92 @@
+/**
+ * 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 './asset-verification-status';
+import { Chain } from './chain';
+/**
+ *
+ * @export
+ * @interface Token
+ */
+export interface Token {
+    /**
+     *
+     * @type {Chain}
+     * @memberof Token
+     */
+    'chain': Chain;
+    /**
+     * The address of token contract
+     * @type {string}
+     * @memberof Token
+     */
+    'contract_address': string;
+    /**
+     * The address of root token contract
+     * @type {string}
+     * @memberof Token
+     */
+    'root_contract_address': string | null;
+    /**
+     * The id of the root chain for a bridged token
+     * @type {string}
+     * @memberof Token
+     */
+    'root_chain_id'?: string | null;
+    /**
+     * The name of the bridge, for bridged tokens only
+     * @type {string}
+     * @memberof Token
+     */
+    'bridge_used'?: string | null;
+    /**
+     * The symbol of token
+     * @type {string}
+     * @memberof Token
+     */
+    'symbol': string | null;
+    /**
+     * The decimals of token
+     * @type {number}
+     * @memberof Token
+     */
+    'decimals': number | null;
+    /**
+     * The image url of token
+     * @type {string}
+     * @memberof Token
+     */
+    'image_url': string | null;
+    /**
+     * The name of token
+     * @type {string}
+     * @memberof Token
+     */
+    'name': string | null;
+    /**
+     *
+     * @type {AssetVerificationStatus}
+     * @memberof Token
+     */
+    'verification_status': AssetVerificationStatus;
+    /**
+     * When the collection was last updated
+     * @type {string}
+     * @memberof Token
+     */
+    'updated_at': string;
+    /**
+     * Indicates whether the token is canonical or not
+     * @type {boolean}
+     * @memberof Token
+     */
+    'is_canonical': boolean;
+}

package/dist/types/blockchain-data/models/transfer.d.ts

@@ -0,0 +1,43 @@
+/**
+ * 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 { ActivityAsset } from './activity-asset';
+/**
+ * The transfer activity details
+ * @export
+ * @interface Transfer
+ */
+export interface Transfer {
+    /**
+     * The account address the asset was transferred from
+     * @type {string}
+     * @memberof Transfer
+     */
+    'from': string;
+    /**
+     * The account address the asset was transferred to
+     * @type {string}
+     * @memberof Transfer
+     */
+    'to': string;
+    /**
+     * The amount of assets transferred
+     * @type {string}
+     * @memberof Transfer
+     */
+    'amount': string;
+    /**
+     *
+     * @type {ActivityAsset}
+     * @memberof Transfer
+     */
+    'asset': ActivityAsset;
+}

package/dist/types/blockchain-data/models/withdrawal.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 { ActivityAsset } from './activity-asset';
+/**
+ * The withdrawal activity details
+ * @export
+ * @interface Withdrawal
+ */
+export interface Withdrawal {
+    /**
+     * The account address the asset was withdrawn from
+     * @type {string}
+     * @memberof Withdrawal
+     */
+    'from': string;
+    /**
+     * The amount of assets withdrawn
+     * @type {string}
+     * @memberof Withdrawal
+     */
+    'amount': string;
+    /**
+     *
+     * @type {ActivityAsset}
+     * @memberof Withdrawal
+     */
+    'asset': ActivityAsset;
+}

package/dist/types/config/config.d.ts

@@ -0,0 +1,32 @@
+import { Configuration as APIConfiguration } from '../imx';
+/**
+ * Configuration for generated clients
+ */
+export type ImmutableAPIConfiguration = APIConfiguration;
+interface Environment {
+    basePath: string;
+    headers?: Record<string, string>;
+}
+export declare const createConfig: ({ basePath, headers, }: Environment) => ImmutableAPIConfiguration;
+/**
+ * Creates a Configuration for the specified environment
+ * @returns an ImmutableAPIConfiguration
+ */
+export declare const imxApiConfig: {
+    getProduction: () => APIConfiguration;
+    getSandbox: () => APIConfiguration;
+};
+export type MultiRollupAPIConfiguration = {
+    indexer: ImmutableAPIConfiguration;
+    orderBook: ImmutableAPIConfiguration;
+    passport: ImmutableAPIConfiguration;
+};
+/**
+ * Creates a Configuration for the specified environment
+ * @returns an MultiRollupAPIConfiguration
+ */
+export declare const multiRollupConfig: {
+    getProduction: () => MultiRollupAPIConfiguration;
+    getSandbox: () => MultiRollupAPIConfiguration;
+};
+export {};

package/dist/types/config/config.test.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/types/config/index.d.ts

@@ -0,0 +1 @@
+export * from './config';

package/dist/types/imx/api.d.ts

@@ -0,0 +1,28 @@
+/**
+ * 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.
+ */
+export * from './domain/assets-api';
+export * from './domain/balances-api';
+export * from './domain/collections-api';
+export * from './domain/deposits-api';
+export * from './domain/encoding-api';
+export * from './domain/exchanges-api';
+export * from './domain/metadata-api';
+export * from './domain/metadata-refreshes-api';
+export * from './domain/mints-api';
+export * from './domain/nft-checkout-primary-api';
+export * from './domain/orders-api';
+export * from './domain/projects-api';
+export * from './domain/tokens-api';
+export * from './domain/trades-api';
+export * from './domain/transfers-api';
+export * from './domain/users-api';
+export * from './domain/withdrawals-api';

package/dist/types/imx/base.d.ts

@@ -0,0 +1,55 @@
+/**
+ * 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.
+ */
+import { Configuration } from "./configuration";
+import { AxiosInstance, AxiosRequestConfig } from 'axios';
+export declare const BASE_PATH: string;
+/**
+ *
+ * @export
+ */
+export declare const COLLECTION_FORMATS: {
+    csv: string;
+    ssv: string;
+    tsv: string;
+    pipes: string;
+};
+/**
+ *
+ * @export
+ * @interface RequestArgs
+ */
+export interface RequestArgs {
+    url: string;
+    options: AxiosRequestConfig;
+}
+/**
+ *
+ * @export
+ * @class BaseAPI
+ */
+export declare class BaseAPI {
+    protected basePath: string;
+    protected axios: AxiosInstance;
+    protected configuration: Configuration | undefined;
+    constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
+}
+/**
+ *
+ * @export
+ * @class RequiredError
+ * @extends {Error}
+ */
+export declare class RequiredError extends Error {
+    field: string;
+    name: "RequiredError";
+    constructor(field: string, msg?: string);
+}

package/dist/types/imx/common.d.ts

@@ -0,0 +1,65 @@
+/**
+ * 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.
+ */
+import { Configuration } from "./configuration";
+import { RequestArgs } from "./base";
+import { AxiosInstance, AxiosResponse } from 'axios';
+/**
+ *
+ * @export
+ */
+export declare const DUMMY_BASE_URL = "https://example.com";
+/**
+ *
+ * @throws {RequiredError}
+ * @export
+ */
+export declare const assertParamExists: (functionName: string, paramName: string, paramValue: unknown) => void;
+/**
+ *
+ * @export
+ */
+export declare const setApiKeyToObject: (object: any, keyParamName: string, configuration?: Configuration) => Promise<void>;
+/**
+ *
+ * @export
+ */
+export declare const setBasicAuthToObject: (object: any, configuration?: Configuration) => void;
+/**
+ *
+ * @export
+ */
+export declare const setBearerAuthToObject: (object: any, configuration?: Configuration) => Promise<void>;
+/**
+ *
+ * @export
+ */
+export declare const setOAuthToObject: (object: any, name: string, scopes: string[], configuration?: Configuration) => Promise<void>;
+/**
+ *
+ * @export
+ */
+export declare const setSearchParams: (url: URL, ...objects: any[]) => void;
+/**
+ *
+ * @export
+ */
+export declare const serializeDataIfNeeded: (value: any, requestOptions: any, configuration?: Configuration) => any;
+/**
+ *
+ * @export
+ */
+export declare const toPathString: (url: URL) => string;
+/**
+ *
+ * @export
+ */
+export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) => <T = unknown, R = AxiosResponse<T, any>>(axios?: AxiosInstance, basePath?: string) => Promise<R>;

package/dist/types/imx/configuration.d.ts

@@ -0,0 +1,83 @@
+/**
+ * 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.
+ */
+export interface ConfigurationParameters {
+    apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
+    username?: string;
+    password?: string;
+    accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
+    basePath?: string;
+    baseOptions?: any;
+    formDataCtor?: new () => any;
+}
+export declare class Configuration {
+    /**
+     * parameter for apiKey security
+     * @param name security name
+     * @memberof Configuration
+     */
+    apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
+    /**
+     * parameter for basic security
+     *
+     * @type {string}
+     * @memberof Configuration
+     */
+    username?: string;
+    /**
+     * parameter for basic security
+     *
+     * @type {string}
+     * @memberof Configuration
+     */
+    password?: string;
+    /**
+     * parameter for oauth2 security
+     * @param name security name
+     * @param scopes oauth2 scope
+     * @memberof Configuration
+     */
+    accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
+    /**
+     * override base path
+     *
+     * @type {string}
+     * @memberof Configuration
+     */
+    basePath?: string;
+    /**
+     * base options for axios calls
+     *
+     * @type {any}
+     * @memberof Configuration
+     */
+    baseOptions?: any;
+    /**
+     * The FormData constructor that will be used to create multipart form data
+     * requests. You can inject this here so that execution environments that
+     * do not support the FormData class can still run the generated client.
+     *
+     * @type {new () => FormData}
+     */
+    formDataCtor?: new () => any;
+    constructor(param?: ConfigurationParameters);
+    /**
+     * Check if the given MIME is a JSON MIME.
+     * JSON MIME examples:
+     *   application/json
+     *   application/json; charset=UTF8
+     *   APPLICATION/JSON
+     *   application/vnd.company+json
+     * @param mime - MIME (Multipurpose Internet Mail Extensions)
+     * @return True if the given MIME is JSON, false otherwise.
+     */
+    isJsonMime(mime: string): boolean;
+}