@imtbl/generated-clients 2.0.0-alpha.0

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

@@ -0,0 +1,54 @@
+/**
+ * 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 { 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;
+    constructor(field: string, msg?: string);
+}

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

@@ -0,0 +1,65 @@
+/**
+ * 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 { RequestArgs } from "./base";
+import type { 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/multi-rollup/configuration.d.ts

@@ -0,0 +1,83 @@
+/**
+ * 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 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;
+}

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

@@ -0,0 +1,293 @@
+/**
+ * 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 { ActivityType } from '../models';
+import { GetActivityResult } from '../models';
+import { ListActivitiesResult } from '../models';
+/**
+ * ActivitiesApi - axios parameter creator
+ * @export
+ */
+export declare const ActivitiesApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Get a single activity by ID
+     * @summary Get a single activity by ID
+     * @param {string} chainName The name of chain
+     * @param {string} activityId The id of activity
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getActivity: (chainName: string, activityId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * List all activities
+     * @summary List all activities
+     * @param {string} chainName The name of chain
+     * @param {string} [contractAddress] The contract address of NFT or ERC20 Token
+     * @param {string} [tokenId] An &#x60;uint256&#x60; token id as string
+     * @param {string} [accountAddress] The account address activity contains
+     * @param {ActivityType} [activityType] The activity type
+     * @param {string} [transactionHash] The transaction hash of activity
+     * @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}
+     */
+    listActivities: (chainName: string, contractAddress?: string, tokenId?: string, accountAddress?: string, activityType?: ActivityType, transactionHash?: string, pageCursor?: string, pageSize?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * List activities sorted by updated_at timestamp ascending, useful for time based data replication
+     * @summary List history of activities
+     * @param {string} chainName The name of chain
+     * @param {string} fromUpdatedAt From indexed at including given date
+     * @param {string} [toUpdatedAt] To indexed at including given date
+     * @param {string} [contractAddress] The contract address of the collection
+     * @param {ActivityType} [activityType] The activity type
+     * @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}
+     */
+    listActivityHistory: (chainName: string, fromUpdatedAt: string, toUpdatedAt?: string, contractAddress?: string, activityType?: ActivityType, pageCursor?: string, pageSize?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * ActivitiesApi - functional programming interface
+ * @export
+ */
+export declare const ActivitiesApiFp: (configuration?: Configuration) => {
+    /**
+     * Get a single activity by ID
+     * @summary Get a single activity by ID
+     * @param {string} chainName The name of chain
+     * @param {string} activityId The id of activity
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getActivity(chainName: string, activityId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetActivityResult>>;
+    /**
+     * List all activities
+     * @summary List all activities
+     * @param {string} chainName The name of chain
+     * @param {string} [contractAddress] The contract address of NFT or ERC20 Token
+     * @param {string} [tokenId] An &#x60;uint256&#x60; token id as string
+     * @param {string} [accountAddress] The account address activity contains
+     * @param {ActivityType} [activityType] The activity type
+     * @param {string} [transactionHash] The transaction hash of activity
+     * @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}
+     */
+    listActivities(chainName: string, contractAddress?: string, tokenId?: string, accountAddress?: string, activityType?: ActivityType, transactionHash?: string, pageCursor?: string, pageSize?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListActivitiesResult>>;
+    /**
+     * List activities sorted by updated_at timestamp ascending, useful for time based data replication
+     * @summary List history of activities
+     * @param {string} chainName The name of chain
+     * @param {string} fromUpdatedAt From indexed at including given date
+     * @param {string} [toUpdatedAt] To indexed at including given date
+     * @param {string} [contractAddress] The contract address of the collection
+     * @param {ActivityType} [activityType] The activity type
+     * @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}
+     */
+    listActivityHistory(chainName: string, fromUpdatedAt: string, toUpdatedAt?: string, contractAddress?: string, activityType?: ActivityType, pageCursor?: string, pageSize?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListActivitiesResult>>;
+};
+/**
+ * ActivitiesApi - factory interface
+ * @export
+ */
+export declare const ActivitiesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Get a single activity by ID
+     * @summary Get a single activity by ID
+     * @param {ActivitiesApiGetActivityRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getActivity(requestParameters: ActivitiesApiGetActivityRequest, options?: AxiosRequestConfig): AxiosPromise<GetActivityResult>;
+    /**
+     * List all activities
+     * @summary List all activities
+     * @param {ActivitiesApiListActivitiesRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listActivities(requestParameters: ActivitiesApiListActivitiesRequest, options?: AxiosRequestConfig): AxiosPromise<ListActivitiesResult>;
+    /**
+     * List activities sorted by updated_at timestamp ascending, useful for time based data replication
+     * @summary List history of activities
+     * @param {ActivitiesApiListActivityHistoryRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listActivityHistory(requestParameters: ActivitiesApiListActivityHistoryRequest, options?: AxiosRequestConfig): AxiosPromise<ListActivitiesResult>;
+};
+/**
+ * Request parameters for getActivity operation in ActivitiesApi.
+ * @export
+ * @interface ActivitiesApiGetActivityRequest
+ */
+export interface ActivitiesApiGetActivityRequest {
+    /**
+     * The name of chain
+     * @type {string}
+     * @memberof ActivitiesApiGetActivity
+     */
+    readonly chainName: string;
+    /**
+     * The id of activity
+     * @type {string}
+     * @memberof ActivitiesApiGetActivity
+     */
+    readonly activityId: string;
+}
+/**
+ * Request parameters for listActivities operation in ActivitiesApi.
+ * @export
+ * @interface ActivitiesApiListActivitiesRequest
+ */
+export interface ActivitiesApiListActivitiesRequest {
+    /**
+     * The name of chain
+     * @type {string}
+     * @memberof ActivitiesApiListActivities
+     */
+    readonly chainName: string;
+    /**
+     * The contract address of NFT or ERC20 Token
+     * @type {string}
+     * @memberof ActivitiesApiListActivities
+     */
+    readonly contractAddress?: string;
+    /**
+     * An &#x60;uint256&#x60; token id as string
+     * @type {string}
+     * @memberof ActivitiesApiListActivities
+     */
+    readonly tokenId?: string;
+    /**
+     * The account address activity contains
+     * @type {string}
+     * @memberof ActivitiesApiListActivities
+     */
+    readonly accountAddress?: string;
+    /**
+     * The activity type
+     * @type {ActivityType}
+     * @memberof ActivitiesApiListActivities
+     */
+    readonly activityType?: ActivityType;
+    /**
+     * The transaction hash of activity
+     * @type {string}
+     * @memberof ActivitiesApiListActivities
+     */
+    readonly transactionHash?: string;
+    /**
+     * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
+     * @type {string}
+     * @memberof ActivitiesApiListActivities
+     */
+    readonly pageCursor?: string;
+    /**
+     * Maximum number of items to return
+     * @type {number}
+     * @memberof ActivitiesApiListActivities
+     */
+    readonly pageSize?: number;
+}
+/**
+ * Request parameters for listActivityHistory operation in ActivitiesApi.
+ * @export
+ * @interface ActivitiesApiListActivityHistoryRequest
+ */
+export interface ActivitiesApiListActivityHistoryRequest {
+    /**
+     * The name of chain
+     * @type {string}
+     * @memberof ActivitiesApiListActivityHistory
+     */
+    readonly chainName: string;
+    /**
+     * From indexed at including given date
+     * @type {string}
+     * @memberof ActivitiesApiListActivityHistory
+     */
+    readonly fromUpdatedAt: string;
+    /**
+     * To indexed at including given date
+     * @type {string}
+     * @memberof ActivitiesApiListActivityHistory
+     */
+    readonly toUpdatedAt?: string;
+    /**
+     * The contract address of the collection
+     * @type {string}
+     * @memberof ActivitiesApiListActivityHistory
+     */
+    readonly contractAddress?: string;
+    /**
+     * The activity type
+     * @type {ActivityType}
+     * @memberof ActivitiesApiListActivityHistory
+     */
+    readonly activityType?: ActivityType;
+    /**
+     * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
+     * @type {string}
+     * @memberof ActivitiesApiListActivityHistory
+     */
+    readonly pageCursor?: string;
+    /**
+     * Maximum number of items to return
+     * @type {number}
+     * @memberof ActivitiesApiListActivityHistory
+     */
+    readonly pageSize?: number;
+}
+/**
+ * ActivitiesApi - object-oriented interface
+ * @export
+ * @class ActivitiesApi
+ * @extends {BaseAPI}
+ */
+export declare class ActivitiesApi extends BaseAPI {
+    /**
+     * Get a single activity by ID
+     * @summary Get a single activity by ID
+     * @param {ActivitiesApiGetActivityRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ActivitiesApi
+     */
+    getActivity(requestParameters: ActivitiesApiGetActivityRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetActivityResult, any>>;
+    /**
+     * List all activities
+     * @summary List all activities
+     * @param {ActivitiesApiListActivitiesRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ActivitiesApi
+     */
+    listActivities(requestParameters: ActivitiesApiListActivitiesRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListActivitiesResult, any>>;
+    /**
+     * List activities sorted by updated_at timestamp ascending, useful for time based data replication
+     * @summary List history of activities
+     * @param {ActivitiesApiListActivityHistoryRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ActivitiesApi
+     */
+    listActivityHistory(requestParameters: ActivitiesApiListActivityHistoryRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListActivitiesResult, any>>;
+}

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

@@ -0,0 +1,95 @@
+/**
+ * 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 { ListChainsResult } from '../models';
+/**
+ * ChainsApi - axios parameter creator
+ * @export
+ */
+export declare const ChainsApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * List supported chains
+     * @summary List supported chains
+     * @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}
+     */
+    listChains: (pageCursor?: string, pageSize?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * ChainsApi - functional programming interface
+ * @export
+ */
+export declare const ChainsApiFp: (configuration?: Configuration) => {
+    /**
+     * List supported chains
+     * @summary List supported chains
+     * @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}
+     */
+    listChains(pageCursor?: string, pageSize?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ListChainsResult>>;
+};
+/**
+ * ChainsApi - factory interface
+ * @export
+ */
+export declare const ChainsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * List supported chains
+     * @summary List supported chains
+     * @param {ChainsApiListChainsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listChains(requestParameters?: ChainsApiListChainsRequest, options?: AxiosRequestConfig): AxiosPromise<ListChainsResult>;
+};
+/**
+ * Request parameters for listChains operation in ChainsApi.
+ * @export
+ * @interface ChainsApiListChainsRequest
+ */
+export interface ChainsApiListChainsRequest {
+    /**
+     * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
+     * @type {string}
+     * @memberof ChainsApiListChains
+     */
+    readonly pageCursor?: string;
+    /**
+     * Maximum number of items to return
+     * @type {number}
+     * @memberof ChainsApiListChains
+     */
+    readonly pageSize?: number;
+}
+/**
+ * ChainsApi - object-oriented interface
+ * @export
+ * @class ChainsApi
+ * @extends {BaseAPI}
+ */
+export declare class ChainsApi extends BaseAPI {
+    /**
+     * List supported chains
+     * @summary List supported chains
+     * @param {ChainsApiListChainsRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ChainsApi
+     */
+    listChains(requestParameters?: ChainsApiListChainsRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ListChainsResult, any>>;
+}