@imtbl/sdk 0.16.0 → 0.17.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,4 +1,86 @@
1
- import { BlockchainDataConfiguration, BlockchainDataModuleConfiguration as BlockchainDataModuleConfiguration$1 } from 'config';
1
+ /**
2
+ * Immutable zkEVM API
3
+ * Immutable Multi Rollup API
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ * Contact: support@immutable.com
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ interface ConfigurationParameters {
13
+ apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
14
+ username?: string;
15
+ password?: string;
16
+ accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
17
+ basePath?: string;
18
+ baseOptions?: any;
19
+ formDataCtor?: new () => any;
20
+ }
21
+ declare class Configuration {
22
+ /**
23
+ * parameter for apiKey security
24
+ * @param name security name
25
+ * @memberof Configuration
26
+ */
27
+ apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
28
+ /**
29
+ * parameter for basic security
30
+ *
31
+ * @type {string}
32
+ * @memberof Configuration
33
+ */
34
+ username?: string;
35
+ /**
36
+ * parameter for basic security
37
+ *
38
+ * @type {string}
39
+ * @memberof Configuration
40
+ */
41
+ password?: string;
42
+ /**
43
+ * parameter for oauth2 security
44
+ * @param name security name
45
+ * @param scopes oauth2 scope
46
+ * @memberof Configuration
47
+ */
48
+ accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
49
+ /**
50
+ * override base path
51
+ *
52
+ * @type {string}
53
+ * @memberof Configuration
54
+ */
55
+ basePath?: string;
56
+ /**
57
+ * base options for axios calls
58
+ *
59
+ * @type {any}
60
+ * @memberof Configuration
61
+ */
62
+ baseOptions?: any;
63
+ /**
64
+ * The FormData constructor that will be used to create multipart form data
65
+ * requests. You can inject this here so that execution environments that
66
+ * do not support the FormData class can still run the generated client.
67
+ *
68
+ * @type {new () => FormData}
69
+ */
70
+ formDataCtor?: new () => any;
71
+ constructor(param?: ConfigurationParameters);
72
+ /**
73
+ * Check if the given MIME is a JSON MIME.
74
+ * JSON MIME examples:
75
+ * application/json
76
+ * application/json; charset=UTF8
77
+ * APPLICATION/JSON
78
+ * application/vnd.company+json
79
+ * @param mime - MIME (Multipurpose Internet Mail Extensions)
80
+ * @return True if the given MIME is JSON, false otherwise.
81
+ */
82
+ isJsonMime(mime: string): boolean;
83
+ }
2
84
 
3
85
  /**
4
86
  * Immutable zkEVM API
@@ -1657,6 +1739,37 @@ interface CollectionsApiListCollectionsRequest {
1657
1739
  */
1658
1740
  readonly pageSize?: number;
1659
1741
  }
1742
+ /**
1743
+ * Request parameters for listCollectionsByNFTOwner operation in CollectionsApi.
1744
+ * @export
1745
+ * @interface CollectionsApiListCollectionsByNFTOwnerRequest
1746
+ */
1747
+ interface CollectionsApiListCollectionsByNFTOwnerRequest {
1748
+ /**
1749
+ * Account address
1750
+ * @type {string}
1751
+ * @memberof CollectionsApiListCollectionsByNFTOwner
1752
+ */
1753
+ readonly accountAddress: string;
1754
+ /**
1755
+ * The name of chain
1756
+ * @type {string}
1757
+ * @memberof CollectionsApiListCollectionsByNFTOwner
1758
+ */
1759
+ readonly chainName: string;
1760
+ /**
1761
+ * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
1762
+ * @type {string}
1763
+ * @memberof CollectionsApiListCollectionsByNFTOwner
1764
+ */
1765
+ readonly pageCursor?: string;
1766
+ /**
1767
+ * Maximum number of items to return
1768
+ * @type {number}
1769
+ * @memberof CollectionsApiListCollectionsByNFTOwner
1770
+ */
1771
+ readonly pageSize?: number;
1772
+ }
1660
1773
 
1661
1774
  /**
1662
1775
  * Request parameters for listNFTOwners operation in NftOwnersApi.
@@ -1854,6 +1967,35 @@ declare class APIError extends Error {
1854
1967
  constructor({ message, code, details, link, trace_id: traceId, }: OpenAPIError);
1855
1968
  }
1856
1969
 
1970
+ declare enum Environment {
1971
+ PRODUCTION = "production",
1972
+ SANDBOX = "sandbox"
1973
+ }
1974
+ declare class ImmutableConfiguration {
1975
+ readonly environment: Environment;
1976
+ readonly apiKey?: string;
1977
+ constructor(options: {
1978
+ environment: Environment;
1979
+ apiKey?: string;
1980
+ });
1981
+ }
1982
+ interface ModuleConfiguration<T> {
1983
+ baseConfig: ImmutableConfiguration;
1984
+ overrides?: T;
1985
+ }
1986
+
1987
+ interface APIConfigurationParams {
1988
+ basePath: string;
1989
+ headers?: Record<string, string>;
1990
+ }
1991
+ interface BlockchainDataModuleConfiguration extends ModuleConfiguration<APIConfigurationParams> {
1992
+ }
1993
+ declare class BlockchainDataConfiguration {
1994
+ readonly apiConfig: Configuration;
1995
+ readonly baseConfig: ImmutableConfiguration;
1996
+ constructor({ baseConfig, overrides }: BlockchainDataModuleConfiguration);
1997
+ }
1998
+
1857
1999
  declare class BlockchainData {
1858
2000
  readonly config: BlockchainDataConfiguration;
1859
2001
  private readonly activities;
@@ -1862,7 +2004,7 @@ declare class BlockchainData {
1862
2004
  private readonly nfts;
1863
2005
  private readonly nftOwners;
1864
2006
  private readonly tokens;
1865
- constructor(moduleConfig: BlockchainDataModuleConfiguration$1);
2007
+ constructor(moduleConfig: BlockchainDataModuleConfiguration);
1866
2008
  /**
1867
2009
  * List all activities
1868
2010
  * @param request - the request object containing the parameters to be provided in the API request
@@ -1891,6 +2033,13 @@ declare class BlockchainData {
1891
2033
  * @throws {@link index.APIError}
1892
2034
  */
1893
2035
  listCollections(request: CollectionsApiListCollectionsRequest): Promise<ListCollectionsResult>;
2036
+ /**
2037
+ * List collections by NFT owner
2038
+ * @param request - the request object containing the parameters to be provided in the API request
2039
+ * @returns a promise that resolves with a list of collections
2040
+ * @throws {@link index.APIError}
2041
+ */
2042
+ listCollectionsByNFTOwner(request: CollectionsApiListCollectionsByNFTOwnerRequest): Promise<ListCollectionsResult>;
1894
2043
  /**
1895
2044
  * Get collection by contract address
1896
2045
  * @param request - the request object containing the parameters to be provided in the API request
@@ -1942,30 +2091,6 @@ declare class BlockchainData {
1942
2091
  getToken(request: TokensApiGetERC20TokenRequest): Promise<GetTokenResult>;
1943
2092
  }
1944
2093
 
1945
- declare enum Environment {
1946
- PRODUCTION = "production",
1947
- SANDBOX = "sandbox"
1948
- }
1949
- declare class ImmutableConfiguration {
1950
- readonly environment: Environment;
1951
- readonly apiKey?: string;
1952
- constructor(options: {
1953
- environment: Environment;
1954
- apiKey?: string;
1955
- });
1956
- }
1957
- interface ModuleConfiguration<T> {
1958
- baseConfig: ImmutableConfiguration;
1959
- overrides?: T;
1960
- }
1961
-
1962
- interface APIConfigurationParams {
1963
- basePath: string;
1964
- headers?: Record<string, string>;
1965
- }
1966
- interface BlockchainDataModuleConfiguration extends ModuleConfiguration<APIConfigurationParams> {
1967
- }
1968
-
1969
2094
  type ActivityType = ActivityType$1;
1970
2095
 
1971
2096
  export { APIError, ActivityType, BlockchainData, BlockchainDataModuleConfiguration };