@imtbl/sdk 0.16.0-alpha.1 → 0.17.0

package/dist/blockchain_data.d.ts

@@ -1,4 +1,86 @@
-import { BlockchainDataConfiguration, BlockchainDataModuleConfiguration as BlockchainDataModuleConfiguration$1 } from 'config';
+/**
+ * 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.
+ */
+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;
+}
+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;
+}
 
 /**
  * Immutable zkEVM API
@@ -1657,6 +1739,37 @@ interface CollectionsApiListCollectionsRequest {
      */
     readonly pageSize?: number;
 }
+/**
+ * Request parameters for listCollectionsByNFTOwner operation in CollectionsApi.
+ * @export
+ * @interface CollectionsApiListCollectionsByNFTOwnerRequest
+ */
+interface CollectionsApiListCollectionsByNFTOwnerRequest {
+    /**
+     * Account address
+     * @type {string}
+     * @memberof CollectionsApiListCollectionsByNFTOwner
+     */
+    readonly accountAddress: string;
+    /**
+     * The name of chain
+     * @type {string}
+     * @memberof CollectionsApiListCollectionsByNFTOwner
+     */
+    readonly chainName: string;
+    /**
+     * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
+     * @type {string}
+     * @memberof CollectionsApiListCollectionsByNFTOwner
+     */
+    readonly pageCursor?: string;
+    /**
+     * Maximum number of items to return
+     * @type {number}
+     * @memberof CollectionsApiListCollectionsByNFTOwner
+     */
+    readonly pageSize?: number;
+}
 
 /**
  * Request parameters for listNFTOwners operation in NftOwnersApi.
@@ -1854,6 +1967,35 @@ declare class APIError extends Error {
     constructor({ message, code, details, link, trace_id: traceId, }: OpenAPIError);
 }
 
+declare enum Environment {
+    PRODUCTION = "production",
+    SANDBOX = "sandbox"
+}
+declare class ImmutableConfiguration {
+    readonly environment: Environment;
+    readonly apiKey?: string;
+    constructor(options: {
+        environment: Environment;
+        apiKey?: string;
+    });
+}
+interface ModuleConfiguration<T> {
+    baseConfig: ImmutableConfiguration;
+    overrides?: T;
+}
+
+interface APIConfigurationParams {
+    basePath: string;
+    headers?: Record<string, string>;
+}
+interface BlockchainDataModuleConfiguration extends ModuleConfiguration<APIConfigurationParams> {
+}
+declare class BlockchainDataConfiguration {
+    readonly apiConfig: Configuration;
+    readonly baseConfig: ImmutableConfiguration;
+    constructor({ baseConfig, overrides }: BlockchainDataModuleConfiguration);
+}
+
 declare class BlockchainData {
     readonly config: BlockchainDataConfiguration;
     private readonly activities;
@@ -1862,7 +2004,7 @@ declare class BlockchainData {
     private readonly nfts;
     private readonly nftOwners;
     private readonly tokens;
-    constructor(moduleConfig: BlockchainDataModuleConfiguration$1);
+    constructor(moduleConfig: BlockchainDataModuleConfiguration);
     /**
      * List all activities
      * @param request - the request object containing the parameters to be provided in the API request
@@ -1891,6 +2033,13 @@ declare class BlockchainData {
      * @throws {@link index.APIError}
      */
     listCollections(request: CollectionsApiListCollectionsRequest): Promise<ListCollectionsResult>;
+    /**
+     * List collections by NFT owner
+     * @param request - the request object containing the parameters to be provided in the API request
+     * @returns a promise that resolves with a list of collections
+     * @throws {@link index.APIError}
+     */
+    listCollectionsByNFTOwner(request: CollectionsApiListCollectionsByNFTOwnerRequest): Promise<ListCollectionsResult>;
     /**
      * Get collection by contract address
      * @param request - the request object containing the parameters to be provided in the API request
@@ -1942,30 +2091,6 @@ declare class BlockchainData {
     getToken(request: TokensApiGetERC20TokenRequest): Promise<GetTokenResult>;
 }
 
-declare enum Environment {
-    PRODUCTION = "production",
-    SANDBOX = "sandbox"
-}
-declare class ImmutableConfiguration {
-    readonly environment: Environment;
-    readonly apiKey?: string;
-    constructor(options: {
-        environment: Environment;
-        apiKey?: string;
-    });
-}
-interface ModuleConfiguration<T> {
-    baseConfig: ImmutableConfiguration;
-    overrides?: T;
-}
-
-interface APIConfigurationParams {
-    basePath: string;
-    headers?: Record<string, string>;
-}
-interface BlockchainDataModuleConfiguration extends ModuleConfiguration<APIConfigurationParams> {
-}
-
 type ActivityType = ActivityType$1;
 
 export { APIError, ActivityType, BlockchainData, BlockchainDataModuleConfiguration };

package/dist/blockchain_data.js

@@ -585,6 +585,47 @@ const CollectionsApiAxiosParamCreator = function (configuration) {
                 options: localVarRequestOptions,
             };
         },
+        /**
+         * List collections by NFT owner account address
+         * @summary List collections by NFT owner
+         * @param {string} accountAddress Account address
+         * @param {string} chainName The name of chain
+         * @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}
+         */
+        listCollectionsByNFTOwner: async (accountAddress, chainName, pageCursor, pageSize, options = {}) => {
+            // verify required parameter 'accountAddress' is not null or undefined
+            assertParamExists('listCollectionsByNFTOwner', 'accountAddress', accountAddress);
+            // verify required parameter 'chainName' is not null or undefined
+            assertParamExists('listCollectionsByNFTOwner', 'chainName', chainName);
+            const localVarPath = `/v1/chains/{chain_name}/accounts/{account_address}/collections`
+                .replace(`{${"account_address"}}`, encodeURIComponent(String(accountAddress)))
+                .replace(`{${"chain_name"}}`, encodeURIComponent(String(chainName)));
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            if (pageCursor !== undefined) {
+                localVarQueryParameter['page_cursor'] = pageCursor;
+            }
+            if (pageSize !== undefined) {
+                localVarQueryParameter['page_size'] = pageSize;
+            }
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = { ...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers };
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
     };
 };
 /**
@@ -619,6 +660,20 @@ const CollectionsApiFp = function (configuration) {
             const localVarAxiosArgs = await localVarAxiosParamCreator.listCollections(chainName, pageCursor, pageSize, options);
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
+        /**
+         * List collections by NFT owner account address
+         * @summary List collections by NFT owner
+         * @param {string} accountAddress Account address
+         * @param {string} chainName The name of chain
+         * @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}
+         */
+        async listCollectionsByNFTOwner(accountAddress, chainName, pageCursor, pageSize, options) {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.listCollectionsByNFTOwner(accountAddress, chainName, pageCursor, pageSize, options);
+            return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
+        },
     };
 };
 /**
@@ -651,6 +706,19 @@ const CollectionsApiFactory = function (configuration, basePath, axios) {
         listCollections(chainName, pageCursor, pageSize, options) {
             return localVarFp.listCollections(chainName, pageCursor, pageSize, options).then((request) => request(axios, basePath));
         },
+        /**
+         * List collections by NFT owner account address
+         * @summary List collections by NFT owner
+         * @param {string} accountAddress Account address
+         * @param {string} chainName The name of chain
+         * @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}
+         */
+        listCollectionsByNFTOwner(accountAddress, chainName, pageCursor, pageSize, options) {
+            return localVarFp.listCollectionsByNFTOwner(accountAddress, chainName, pageCursor, pageSize, options).then((request) => request(axios, basePath));
+        },
     };
 };
 /**
@@ -682,6 +750,17 @@ class CollectionsApi extends BaseAPI {
     listCollections(requestParameters, options) {
         return CollectionsApiFp(this.configuration).listCollections(requestParameters.chainName, requestParameters.pageCursor, requestParameters.pageSize, options).then((request) => request(this.axios, this.basePath));
     }
+    /**
+     * List collections by NFT owner account address
+     * @summary List collections by NFT owner
+     * @param {CollectionsApiListCollectionsByNFTOwnerRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof CollectionsApi
+     */
+    listCollectionsByNFTOwner(requestParameters, options) {
+        return CollectionsApiFp(this.configuration).listCollectionsByNFTOwner(requestParameters.accountAddress, requestParameters.chainName, requestParameters.pageCursor, requestParameters.pageSize, options).then((request) => request(this.axios, this.basePath));
+    }
 }
 
 /* tslint:disable */
@@ -1320,6 +1399,7 @@ const OrdersApiAxiosParamCreator = function (configuration) {
          * List all trades
          * @summary List all trades
          * @param {string} chainName
+         * @param {string} [accountAddress]
          * @param {number} [pageSize] Maximum number of trades to return per page
          * @param {'created_at'} [sortBy] Trade field to sort by
          * @param {'asc' | 'desc'} [sortDirection] Ascending or descending direction for sort
@@ -1327,7 +1407,7 @@ const OrdersApiAxiosParamCreator = function (configuration) {
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        listTrades: async (chainName, pageSize, sortBy, sortDirection, pageCursor, options = {}) => {
+        listTrades: async (chainName, accountAddress, pageSize, sortBy, sortDirection, pageCursor, options = {}) => {
             // verify required parameter 'chainName' is not null or undefined
             assertParamExists('listTrades', 'chainName', chainName);
             const localVarPath = `/v1/chains/{chain_name}/trades`
@@ -1341,6 +1421,9 @@ const OrdersApiAxiosParamCreator = function (configuration) {
             const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options };
             const localVarHeaderParameter = {};
             const localVarQueryParameter = {};
+            if (accountAddress !== undefined) {
+                localVarQueryParameter['account_address'] = accountAddress;
+            }
             if (pageSize !== undefined) {
                 localVarQueryParameter['page_size'] = pageSize;
             }
@@ -1441,6 +1524,7 @@ const OrdersApiFp = function (configuration) {
          * List all trades
          * @summary List all trades
          * @param {string} chainName
+         * @param {string} [accountAddress]
          * @param {number} [pageSize] Maximum number of trades to return per page
          * @param {'created_at'} [sortBy] Trade field to sort by
          * @param {'asc' | 'desc'} [sortDirection] Ascending or descending direction for sort
@@ -1448,8 +1532,8 @@ const OrdersApiFp = function (configuration) {
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        async listTrades(chainName, pageSize, sortBy, sortDirection, pageCursor, options) {
-            const localVarAxiosArgs = await localVarAxiosParamCreator.listTrades(chainName, pageSize, sortBy, sortDirection, pageCursor, options);
+        async listTrades(chainName, accountAddress, pageSize, sortBy, sortDirection, pageCursor, options) {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.listTrades(chainName, accountAddress, pageSize, sortBy, sortDirection, pageCursor, options);
             return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
         },
     };
@@ -1527,6 +1611,7 @@ const OrdersApiFactory = function (configuration, basePath, axios) {
          * List all trades
          * @summary List all trades
          * @param {string} chainName
+         * @param {string} [accountAddress]
          * @param {number} [pageSize] Maximum number of trades to return per page
          * @param {'created_at'} [sortBy] Trade field to sort by
          * @param {'asc' | 'desc'} [sortDirection] Ascending or descending direction for sort
@@ -1534,8 +1619,8 @@ const OrdersApiFactory = function (configuration, basePath, axios) {
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        listTrades(chainName, pageSize, sortBy, sortDirection, pageCursor, options) {
-            return localVarFp.listTrades(chainName, pageSize, sortBy, sortDirection, pageCursor, options).then((request) => request(axios, basePath));
+        listTrades(chainName, accountAddress, pageSize, sortBy, sortDirection, pageCursor, options) {
+            return localVarFp.listTrades(chainName, accountAddress, pageSize, sortBy, sortDirection, pageCursor, options).then((request) => request(axios, basePath));
         },
     };
 };
@@ -1610,7 +1695,7 @@ class OrdersApi extends BaseAPI {
      * @memberof OrdersApi
      */
     listTrades(requestParameters, options) {
-        return OrdersApiFp(this.configuration).listTrades(requestParameters.chainName, requestParameters.pageSize, requestParameters.sortBy, requestParameters.sortDirection, requestParameters.pageCursor, options).then((request) => request(this.axios, this.basePath));
+        return OrdersApiFp(this.configuration).listTrades(requestParameters.chainName, requestParameters.accountAddress, requestParameters.pageSize, requestParameters.sortBy, requestParameters.sortDirection, requestParameters.pageCursor, options).then((request) => request(this.axios, this.basePath));
     }
 }
 
@@ -2487,7 +2572,7 @@ class APIError extends Error {
 
 /* eslint-disable implicit-arrow-linebreak */
 const defaultHeaders = {
-    sdkVersion: 'ts-immutable-sdk-multi-rollup-api-client-0.16.0-alpha.1',
+    sdkVersion: 'ts-immutable-sdk-multi-rollup-api-client-0.0.0',
 };
 /**
  * createAPIConfiguration to create a custom Configuration
@@ -2644,6 +2729,20 @@ class BlockchainData {
             throw formatError(err);
         });
     }
+    /**
+     * List collections by NFT owner
+     * @param request - the request object containing the parameters to be provided in the API request
+     * @returns a promise that resolves with a list of collections
+     * @throws {@link index.APIError}
+     */
+    async listCollectionsByNFTOwner(request) {
+        return await this.collections
+            .listCollectionsByNFTOwner(request)
+            .then((res) => res.data)
+            .catch((err) => {
+            throw formatError(err);
+        });
+    }
     /**
      * Get collection by contract address
      * @param request - the request object containing the parameters to be provided in the API request