@imtbl/generated-clients 2.0.0-alpha.0

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

@@ -0,0 +1,141 @@
+/**
+ * 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 { ActivityType } from '../models';
+export type { APIError400 } from '../models';
+export type { APIError404 } from '../models';
+export type { APIError500 } from '../models';
+export type { ActivityType } from '../models';
+export type { GetActivityResult } from '../models';
+export type { ListActivitiesResult } from '../models';
+/**
+ * Request parameters for getActivity operation in ActivitiesApi.
+ * @export
+ * @interface GetActivityRequest
+ */
+export interface GetActivityRequestParams {
+    /**
+     * The name of chain
+     * @type {string}
+     * @memberof GetActivity
+     */
+    readonly chainName: string;
+    /**
+     * The id of activity
+     * @type {string}
+     * @memberof GetActivity
+     */
+    readonly activityId: string;
+}
+/**
+ * Request parameters for listActivities operation in ActivitiesApi.
+ * @export
+ * @interface ListActivitiesRequest
+ */
+export interface ListActivitiesRequestParams {
+    /**
+     * The name of chain
+     * @type {string}
+     * @memberof ListActivities
+     */
+    readonly chainName: string;
+    /**
+     * The contract address of NFT or ERC20 Token
+     * @type {string}
+     * @memberof ListActivities
+     */
+    readonly contractAddress?: string;
+    /**
+     * An `uint256` token id as string
+     * @type {string}
+     * @memberof ListActivities
+     */
+    readonly tokenId?: string;
+    /**
+     * The account address activity contains
+     * @type {string}
+     * @memberof ListActivities
+     */
+    readonly accountAddress?: string;
+    /**
+     * The activity type
+     * @type {ActivityType}
+     * @memberof ListActivities
+     */
+    readonly activityType?: ActivityType;
+    /**
+     * The transaction hash of activity
+     * @type {string}
+     * @memberof ListActivities
+     */
+    readonly transactionHash?: string;
+    /**
+     * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
+     * @type {string}
+     * @memberof ListActivities
+     */
+    readonly pageCursor?: string;
+    /**
+     * Maximum number of items to return
+     * @type {number}
+     * @memberof ListActivities
+     */
+    readonly pageSize?: number;
+}
+/**
+ * Request parameters for listActivityHistory operation in ActivitiesApi.
+ * @export
+ * @interface ListActivityHistoryRequest
+ */
+export interface ListActivityHistoryRequestParams {
+    /**
+     * The name of chain
+     * @type {string}
+     * @memberof ListActivityHistory
+     */
+    readonly chainName: string;
+    /**
+     * From indexed at including given date
+     * @type {string}
+     * @memberof ListActivityHistory
+     */
+    readonly fromUpdatedAt: string;
+    /**
+     * To indexed at including given date
+     * @type {string}
+     * @memberof ListActivityHistory
+     */
+    readonly toUpdatedAt?: string;
+    /**
+     * The contract address of the collection
+     * @type {string}
+     * @memberof ListActivityHistory
+     */
+    readonly contractAddress?: string;
+    /**
+     * The activity type
+     * @type {ActivityType}
+     * @memberof ListActivityHistory
+     */
+    readonly activityType?: ActivityType;
+    /**
+     * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
+     * @type {string}
+     * @memberof ListActivityHistory
+     */
+    readonly pageCursor?: string;
+    /**
+     * Maximum number of items to return
+     * @type {number}
+     * @memberof ListActivityHistory
+     */
+    readonly pageSize?: number;
+}

package/dist/types/blockchain-data/domain/chains-api.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 type { APIError400 } from '../models';
+export type { APIError404 } from '../models';
+export type { APIError500 } from '../models';
+export type { ListChainsResult } from '../models';
+/**
+ * Request parameters for listChains operation in ChainsApi.
+ * @export
+ * @interface ListChainsRequest
+ */
+export interface ListChainsRequestParams {
+    /**
+     * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
+     * @type {string}
+     * @memberof ListChains
+     */
+    readonly pageCursor?: string;
+    /**
+     * Maximum number of items to return
+     * @type {number}
+     * @memberof ListChains
+     */
+    readonly pageSize?: number;
+}

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

@@ -0,0 +1,141 @@
+/**
+ * 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';
+import { RefreshCollectionMetadataRequest } from '../models';
+export type { APIError400 } from '../models';
+export type { APIError401 } from '../models';
+export type { APIError403 } from '../models';
+export type { APIError404 } from '../models';
+export type { APIError500 } from '../models';
+export type { AssetVerificationStatus } from '../models';
+export type { GetCollectionResult } from '../models';
+export type { ListCollectionsResult } from '../models';
+export type { RefreshCollectionMetadataRequest } from '../models';
+export type { RefreshCollectionMetadataResult } from '../models';
+/**
+ * Request parameters for getCollection operation in CollectionsApi.
+ * @export
+ * @interface GetCollectionRequest
+ */
+export interface GetCollectionRequestParams {
+    /**
+     * The address contract
+     * @type {string}
+     * @memberof GetCollection
+     */
+    readonly contractAddress: string;
+    /**
+     * The name of chain
+     * @type {string}
+     * @memberof GetCollection
+     */
+    readonly chainName: string;
+}
+/**
+ * Request parameters for listCollections operation in CollectionsApi.
+ * @export
+ * @interface ListCollectionsRequest
+ */
+export interface ListCollectionsRequestParams {
+    /**
+     * The name of chain
+     * @type {string}
+     * @memberof ListCollections
+     */
+    readonly chainName: string;
+    /**
+     * List of contract addresses to filter by
+     * @type {Array<string>}
+     * @memberof ListCollections
+     */
+    readonly contractAddress?: Array<string>;
+    /**
+     * List of verification status to filter by
+     * @type {Array<AssetVerificationStatus>}
+     * @memberof ListCollections
+     */
+    readonly verificationStatus?: Array<AssetVerificationStatus>;
+    /**
+     * Datetime to use as the oldest updated timestamp
+     * @type {string}
+     * @memberof ListCollections
+     */
+    readonly fromUpdatedAt?: string;
+    /**
+     * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
+     * @type {string}
+     * @memberof ListCollections
+     */
+    readonly pageCursor?: string;
+    /**
+     * Maximum number of items to return
+     * @type {number}
+     * @memberof ListCollections
+     */
+    readonly pageSize?: number;
+}
+/**
+ * Request parameters for listCollectionsByNFTOwner operation in CollectionsApi.
+ * @export
+ * @interface ListCollectionsByNFTOwnerRequest
+ */
+export interface ListCollectionsByNFTOwnerRequestParams {
+    /**
+     * Account address
+     * @type {string}
+     * @memberof ListCollectionsByNFTOwner
+     */
+    readonly accountAddress: string;
+    /**
+     * The name of chain
+     * @type {string}
+     * @memberof ListCollectionsByNFTOwner
+     */
+    readonly chainName: string;
+    /**
+     * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
+     * @type {string}
+     * @memberof ListCollectionsByNFTOwner
+     */
+    readonly pageCursor?: string;
+    /**
+     * Maximum number of items to return
+     * @type {number}
+     * @memberof ListCollectionsByNFTOwner
+     */
+    readonly pageSize?: number;
+}
+/**
+ * Request parameters for refreshCollectionMetadata operation in CollectionsApi.
+ * @export
+ * @interface RefreshCollectionMetadataRequest
+ */
+export interface RefreshCollectionMetadataRequestParams {
+    /**
+     * The address contract
+     * @type {string}
+     * @memberof RefreshCollectionMetadata
+     */
+    readonly contractAddress: string;
+    /**
+     * The name of chain
+     * @type {string}
+     * @memberof RefreshCollectionMetadata
+     */
+    readonly chainName: string;
+    /**
+     * The request body
+     * @type {RefreshCollectionMetadataRequest}
+     * @memberof RefreshCollectionMetadata
+     */
+    readonly refreshCollectionMetadataRequest: RefreshCollectionMetadataRequest;
+}

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

@@ -0,0 +1,38 @@
+/**
+ * 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 { SignCraftingRequest } from '../models';
+export type { APIError400 } from '../models';
+export type { APIError401 } from '../models';
+export type { APIError403 } from '../models';
+export type { APIError404 } from '../models';
+export type { APIError500 } from '../models';
+export type { SignCraftingRequest } from '../models';
+export type { SignCraftingResult } from '../models';
+/**
+ * Request parameters for signCraftingPayload operation in CraftingApi.
+ * @export
+ * @interface SignCraftingPayloadRequest
+ */
+export interface SignCraftingPayloadRequestParams {
+    /**
+     * The name of chain
+     * @type {string}
+     * @memberof SignCraftingPayload
+     */
+    readonly chainName: string;
+    /**
+     * The request body
+     * @type {SignCraftingRequest}
+     * @memberof SignCraftingPayload
+     */
+    readonly signCraftingRequest: SignCraftingRequest;
+}

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

@@ -0,0 +1,187 @@
+/**
+ * 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 { RefreshMetadataByIDRequest } from '../models';
+import { RefreshNFTMetadataByTokenIDRequest } from '../models';
+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 { GetMetadataResult } from '../models';
+export type { ListMetadataResult } from '../models';
+export type { MetadataRefreshRateLimitResult } from '../models';
+export type { RefreshMetadataByIDRequest } from '../models';
+export type { RefreshNFTMetadataByTokenIDRequest } from '../models';
+export type { StackBundle } from '../models';
+/**
+ * Request parameters for getMetadata operation in MetadataApi.
+ * @export
+ * @interface GetMetadataRequest
+ */
+export interface GetMetadataRequestParams {
+    /**
+     * The name of chain
+     * @type {string}
+     * @memberof GetMetadata
+     */
+    readonly chainName: string;
+    /**
+     * The address of metadata contract
+     * @type {string}
+     * @memberof GetMetadata
+     */
+    readonly contractAddress: string;
+    /**
+     * The id of the metadata
+     * @type {string}
+     * @memberof GetMetadata
+     */
+    readonly metadataId: string;
+}
+/**
+ * Request parameters for listMetadata operation in MetadataApi.
+ * @export
+ * @interface ListMetadataRequest
+ */
+export interface ListMetadataRequestParams {
+    /**
+     * The name of chain
+     * @type {string}
+     * @memberof ListMetadata
+     */
+    readonly chainName: string;
+    /**
+     * The address of metadata contract
+     * @type {string}
+     * @memberof ListMetadata
+     */
+    readonly contractAddress: string;
+    /**
+     * Datetime to use as the oldest updated timestamp
+     * @type {string}
+     * @memberof ListMetadata
+     */
+    readonly fromUpdatedAt?: string;
+    /**
+     * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
+     * @type {string}
+     * @memberof ListMetadata
+     */
+    readonly pageCursor?: string;
+    /**
+     * Maximum number of items to return
+     * @type {number}
+     * @memberof ListMetadata
+     */
+    readonly pageSize?: number;
+}
+/**
+ * Request parameters for listMetadataForChain operation in MetadataApi.
+ * @export
+ * @interface ListMetadataForChainRequest
+ */
+export interface ListMetadataForChainRequestParams {
+    /**
+     * The name of chain
+     * @type {string}
+     * @memberof ListMetadataForChain
+     */
+    readonly chainName: string;
+    /**
+     * Datetime to use as the oldest updated timestamp
+     * @type {string}
+     * @memberof ListMetadataForChain
+     */
+    readonly fromUpdatedAt?: string;
+    /**
+     * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
+     * @type {string}
+     * @memberof ListMetadataForChain
+     */
+    readonly pageCursor?: string;
+    /**
+     * Maximum number of items to return
+     * @type {number}
+     * @memberof ListMetadataForChain
+     */
+    readonly pageSize?: number;
+}
+/**
+ * Request parameters for listStacks operation in MetadataApi.
+ * @export
+ * @interface ListStacksRequest
+ */
+export interface ListStacksRequestParams {
+    /**
+     * The name of chain
+     * @type {string}
+     * @memberof ListStacks
+     */
+    readonly chainName: string;
+    /**
+     * List of stack_id to filter by
+     * @type {Array<string>}
+     * @memberof ListStacks
+     */
+    readonly stackId: Array<string>;
+}
+/**
+ * Request parameters for refreshMetadataByID operation in MetadataApi.
+ * @export
+ * @interface RefreshMetadataByIDRequest
+ */
+export interface RefreshMetadataByIDRequestParams {
+    /**
+     * The name of chain
+     * @type {string}
+     * @memberof RefreshMetadataByID
+     */
+    readonly chainName: string;
+    /**
+     * Contract address
+     * @type {string}
+     * @memberof RefreshMetadataByID
+     */
+    readonly contractAddress: string;
+    /**
+     * NFT Metadata Refresh Request
+     * @type {RefreshMetadataByIDRequest}
+     * @memberof RefreshMetadataByID
+     */
+    readonly refreshMetadataByIDRequest: RefreshMetadataByIDRequest;
+}
+/**
+ * Request parameters for refreshNFTMetadataByTokenID operation in MetadataApi.
+ * @export
+ * @interface RefreshNFTMetadataByTokenIDRequest
+ */
+export interface RefreshNFTMetadataByTokenIDRequestParams {
+    /**
+     * The address of contract
+     * @type {string}
+     * @memberof RefreshNFTMetadataByTokenID
+     */
+    readonly contractAddress: string;
+    /**
+     * The name of chain
+     * @type {string}
+     * @memberof RefreshNFTMetadataByTokenID
+     */
+    readonly chainName: string;
+    /**
+     * the request body
+     * @type {RefreshNFTMetadataByTokenIDRequest}
+     * @memberof RefreshNFTMetadataByTokenID
+     */
+    readonly refreshNFTMetadataByTokenIDRequest: RefreshNFTMetadataByTokenIDRequest;
+}

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

@@ -0,0 +1,162 @@
+/**
+ * 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 { ListFiltersResult } from '../models';
+export type { SearchNFTsResult } from '../models';
+export type { SearchStacksResult } from '../models';
+/**
+ * Request parameters for listFilters operation in MetadataSearchApi.
+ * @export
+ * @interface ListFiltersRequest
+ */
+export interface ListFiltersRequestParams {
+    /**
+     * The name of chain
+     * @type {string}
+     * @memberof ListFilters
+     */
+    readonly chainName: string;
+    /**
+     * Contract addresses for collection
+     * @type {string}
+     * @memberof ListFilters
+     */
+    readonly contractAddress: string;
+}
+/**
+ * Request parameters for searchNFTs operation in MetadataSearchApi.
+ * @export
+ * @interface SearchNFTsRequest
+ */
+export interface SearchNFTsRequestParams {
+    /**
+     * The name of chain
+     * @type {string}
+     * @memberof SearchNFTs
+     */
+    readonly chainName: string;
+    /**
+     * List of contract addresses to filter by
+     * @type {Array<string>}
+     * @memberof SearchNFTs
+     */
+    readonly contractAddress: Array<string>;
+    /**
+     * Account address to filter by
+     * @type {string}
+     * @memberof SearchNFTs
+     */
+    readonly accountAddress?: string;
+    /**
+     * Filters NFTs that belong to any of these stacks
+     * @type {Array<string>}
+     * @memberof SearchNFTs
+     */
+    readonly stackId?: Array<string>;
+    /**
+     * Whether the listings should include only the owner created listings
+     * @type {boolean}
+     * @memberof SearchNFTs
+     */
+    readonly onlyIncludeOwnerListings?: boolean;
+    /**
+     * Number of results to return per page
+     * @type {number}
+     * @memberof SearchNFTs
+     */
+    readonly pageSize?: number;
+    /**
+     * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
+     * @type {string}
+     * @memberof SearchNFTs
+     */
+    readonly pageCursor?: string;
+}
+/**
+ * Request parameters for searchStacks operation in MetadataSearchApi.
+ * @export
+ * @interface SearchStacksRequest
+ */
+export interface SearchStacksRequestParams {
+    /**
+     * The name of chain
+     * @type {string}
+     * @memberof SearchStacks
+     */
+    readonly chainName: string;
+    /**
+     * List of contract addresses to filter by
+     * @type {Array<string>}
+     * @memberof SearchStacks
+     */
+    readonly contractAddress: Array<string>;
+    /**
+     * Account address to filter by
+     * @type {string}
+     * @memberof SearchStacks
+     */
+    readonly accountAddress?: string;
+    /**
+     * Whether to the listings should include only the owner created listings
+     * @type {boolean}
+     * @memberof SearchStacks
+     */
+    readonly onlyIncludeOwnerListings?: boolean;
+    /**
+     * Filters results to include only stacks that have a current active listing. False and \&#39;null\&#39; return all unfiltered stacks.
+     * @type {boolean}
+     * @memberof SearchStacks
+     */
+    readonly onlyIfHasActiveListings?: boolean;
+    /**
+     * JSON encoded traits to filter by. e.g. encodeURIComponent(JSON.stringify({\&quot;rarity\&quot;: {\&quot;values\&quot;: [\&quot;common\&quot;, \&quot;rare\&quot;], \&quot;condition\&quot;: \&quot;eq\&quot;}}))
+     * @type {string}
+     * @memberof SearchStacks
+     */
+    readonly traits?: string;
+    /**
+     * Keyword to search NFT name and description. Alphanumeric characters only.
+     * @type {string}
+     * @memberof SearchStacks
+     */
+    readonly keyword?: string;
+    /**
+     * Sort results in a specific order
+     * @type {'cheapest_first'}
+     * @memberof SearchStacks
+     */
+    readonly sortBy?: SearchStacksSortByEnum;
+    /**
+     * Number of results to return per page
+     * @type {number}
+     * @memberof SearchStacks
+     */
+    readonly pageSize?: number;
+    /**
+     * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
+     * @type {string}
+     * @memberof SearchStacks
+     */
+    readonly pageCursor?: string;
+}
+/**
+  * @export
+  * @enum {string}
+  */
+export declare enum SearchStacksSortByEnum {
+    CheapestFirst = "cheapest_first"
+}