@imtbl/generated-clients 2.0.0-alpha.9 → 2.0.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.
@@ -53,13 +53,14 @@ export declare const MetadataSearchApiAxiosParamCreator: (configuration?: Config
53
53
  * @param {boolean} [onlyIfHasActiveListings] Filters results to include only stacks that have a current active listing. False and \'null\' return all unfiltered stacks.
54
54
  * @param {string} [traits] JSON encoded traits to filter by. e.g. encodeURIComponent(JSON.stringify({\"rarity\": {\"values\": [\"common\", \"rare\"], \"condition\": \"eq\"}}))
55
55
  * @param {string} [keyword] Keyword to search NFT name and description. Alphanumeric characters only.
56
+ * @param {string} [paymentToken] Filters the active listings, bids, floor listing and top bid by the specified payment token, either the address of the payment token contract or \'NATIVE\'
56
57
  * @param {SearchStacksSortByEnum} [sortBy] Sort results in a specific order
57
58
  * @param {number} [pageSize] Number of results to return per page
58
59
  * @param {string} [pageCursor] Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
59
60
  * @param {*} [options] Override http request option.
60
61
  * @throws {RequiredError}
61
62
  */
62
- searchStacks: (chainName: string, contractAddress: Array<string>, accountAddress?: string, onlyIncludeOwnerListings?: boolean, onlyIfHasActiveListings?: boolean, traits?: string, keyword?: string, sortBy?: SearchStacksSortByEnum, pageSize?: number, pageCursor?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
63
+ searchStacks: (chainName: string, contractAddress: Array<string>, accountAddress?: string, onlyIncludeOwnerListings?: boolean, onlyIfHasActiveListings?: boolean, traits?: string, keyword?: string, paymentToken?: string, sortBy?: SearchStacksSortByEnum, pageSize?: number, pageCursor?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
63
64
  };
64
65
  /**
65
66
  * MetadataSearchApi - functional programming interface
@@ -99,13 +100,14 @@ export declare const MetadataSearchApiFp: (configuration?: Configuration) => {
99
100
  * @param {boolean} [onlyIfHasActiveListings] Filters results to include only stacks that have a current active listing. False and \&#39;null\&#39; return all unfiltered stacks.
100
101
  * @param {string} [traits] 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;}}))
101
102
  * @param {string} [keyword] Keyword to search NFT name and description. Alphanumeric characters only.
103
+ * @param {string} [paymentToken] Filters the active listings, bids, floor listing and top bid by the specified payment token, either the address of the payment token contract or \&#39;NATIVE\&#39;
102
104
  * @param {SearchStacksSortByEnum} [sortBy] Sort results in a specific order
103
105
  * @param {number} [pageSize] Number of results to return per page
104
106
  * @param {string} [pageCursor] Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
105
107
  * @param {*} [options] Override http request option.
106
108
  * @throws {RequiredError}
107
109
  */
108
- searchStacks(chainName: string, contractAddress: Array<string>, accountAddress?: string, onlyIncludeOwnerListings?: boolean, onlyIfHasActiveListings?: boolean, traits?: string, keyword?: string, sortBy?: SearchStacksSortByEnum, pageSize?: number, pageCursor?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SearchStacksResult>>;
110
+ searchStacks(chainName: string, contractAddress: Array<string>, accountAddress?: string, onlyIncludeOwnerListings?: boolean, onlyIfHasActiveListings?: boolean, traits?: string, keyword?: string, paymentToken?: string, sortBy?: SearchStacksSortByEnum, pageSize?: number, pageCursor?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SearchStacksResult>>;
109
111
  };
110
112
  /**
111
113
  * MetadataSearchApi - factory interface
@@ -253,6 +255,12 @@ export interface MetadataSearchApiSearchStacksRequest {
253
255
  * @memberof MetadataSearchApiSearchStacks
254
256
  */
255
257
  readonly keyword?: string;
258
+ /**
259
+ * Filters the active listings, bids, floor listing and top bid by the specified payment token, either the address of the payment token contract or \&#39;NATIVE\&#39;
260
+ * @type {string}
261
+ * @memberof MetadataSearchApiSearchStacks
262
+ */
263
+ readonly paymentToken?: string;
256
264
  /**
257
265
  * Sort results in a specific order
258
266
  * @type {'cheapest_first'}
@@ -16,6 +16,7 @@ import { CreateCounterfactualAddressRequest } from '../models';
16
16
  import { CreateCounterfactualAddressRes } from '../models';
17
17
  import { GetLinkedAddressesRes } from '../models';
18
18
  import { GetLinkedAddressesResDeprecated } from '../models';
19
+ import { GetPassportMetadataRes } from '../models';
19
20
  import { GetTransactionMetadataRequest } from '../models';
20
21
  import { GetTransactionMetadataRes } from '../models';
21
22
  import { GetTypedDataMetadataRequest } from '../models';
@@ -71,6 +72,14 @@ export declare const PassportApiAxiosParamCreator: (configuration?: Configuratio
71
72
  * @throws {RequiredError}
72
73
  */
73
74
  getTypedDataMetadata: (chainName: string, getTypedDataMetadataRequest: GetTypedDataMetadataRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
75
+ /**
76
+ * Get passport metadata related to a user
77
+ * @summary Get passport metadata related to a user
78
+ * @param {string} userId The user\&#39;s userId
79
+ * @param {*} [options] Override http request option.
80
+ * @throws {RequiredError}
81
+ */
82
+ getUserMetadata: (userId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
74
83
  };
75
84
  /**
76
85
  * PassportApi - functional programming interface
@@ -123,6 +132,14 @@ export declare const PassportApiFp: (configuration?: Configuration) => {
123
132
  * @throws {RequiredError}
124
133
  */
125
134
  getTypedDataMetadata(chainName: string, getTypedDataMetadataRequest: GetTypedDataMetadataRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetTypedDataMetadataRes>>;
135
+ /**
136
+ * Get passport metadata related to a user
137
+ * @summary Get passport metadata related to a user
138
+ * @param {string} userId The user\&#39;s userId
139
+ * @param {*} [options] Override http request option.
140
+ * @throws {RequiredError}
141
+ */
142
+ getUserMetadata(userId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetPassportMetadataRes>>;
126
143
  };
127
144
  /**
128
145
  * PassportApi - factory interface
@@ -171,6 +188,14 @@ export declare const PassportApiFactory: (configuration?: Configuration, basePat
171
188
  * @throws {RequiredError}
172
189
  */
173
190
  getTypedDataMetadata(requestParameters: PassportApiGetTypedDataMetadataRequest, options?: AxiosRequestConfig): AxiosPromise<GetTypedDataMetadataRes>;
191
+ /**
192
+ * Get passport metadata related to a user
193
+ * @summary Get passport metadata related to a user
194
+ * @param {PassportApiGetUserMetadataRequest} requestParameters Request parameters.
195
+ * @param {*} [options] Override http request option.
196
+ * @throws {RequiredError}
197
+ */
198
+ getUserMetadata(requestParameters: PassportApiGetUserMetadataRequest, options?: AxiosRequestConfig): AxiosPromise<GetPassportMetadataRes>;
174
199
  };
175
200
  /**
176
201
  * Request parameters for createCounterfactualAddressV2 operation in PassportApi.
@@ -261,6 +286,19 @@ export interface PassportApiGetTypedDataMetadataRequest {
261
286
  */
262
287
  readonly getTypedDataMetadataRequest: GetTypedDataMetadataRequest;
263
288
  }
289
+ /**
290
+ * Request parameters for getUserMetadata operation in PassportApi.
291
+ * @export
292
+ * @interface PassportApiGetUserMetadataRequest
293
+ */
294
+ export interface PassportApiGetUserMetadataRequest {
295
+ /**
296
+ * The user\&#39;s userId
297
+ * @type {string}
298
+ * @memberof PassportApiGetUserMetadata
299
+ */
300
+ readonly userId: string;
301
+ }
264
302
  /**
265
303
  * PassportApi - object-oriented interface
266
304
  * @export
@@ -315,4 +353,13 @@ export declare class PassportApi extends BaseAPI {
315
353
  * @memberof PassportApi
316
354
  */
317
355
  getTypedDataMetadata(requestParameters: PassportApiGetTypedDataMetadataRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetTypedDataMetadataRes, any>>;
356
+ /**
357
+ * Get passport metadata related to a user
358
+ * @summary Get passport metadata related to a user
359
+ * @param {PassportApiGetUserMetadataRequest} requestParameters Request parameters.
360
+ * @param {*} [options] Override http request option.
361
+ * @throws {RequiredError}
362
+ * @memberof PassportApi
363
+ */
364
+ getUserMetadata(requestParameters: PassportApiGetUserMetadataRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPassportMetadataRes, any>>;
318
365
  }
@@ -25,22 +25,24 @@ export declare const PricingApiAxiosParamCreator: (configuration?: Configuration
25
25
  * @param {string} chainName The name of chain
26
26
  * @param {string} contractAddress Contract address for collection that these token ids are on
27
27
  * @param {Array<string>} tokenId List of token ids to get pricing data for
28
+ * @param {string} [paymentToken] Filters the active listings, bids, floor listing and top bid by the specified payment token, either the address of the payment token contract or \&#39;NATIVE\&#39;.
28
29
  * @param {string} [pageCursor] Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
29
30
  * @param {*} [options] Override http request option.
30
31
  * @throws {RequiredError}
31
32
  */
32
- quotesForNFTs: (chainName: string, contractAddress: string, tokenId: Array<string>, pageCursor?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
33
+ quotesForNFTs: (chainName: string, contractAddress: string, tokenId: Array<string>, paymentToken?: string, pageCursor?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
33
34
  /**
34
35
  * Get pricing data for a list of stack ids
35
36
  * @summary Get pricing data for a list of stack ids
36
37
  * @param {string} chainName The name of chain
37
38
  * @param {string} contractAddress Contract address for collection that these stacks are on
38
39
  * @param {Array<string>} stackId List of stack ids to get pricing data for
40
+ * @param {string} [paymentToken] Filters the active listings, bids, floor listing and top bid by the specified payment token, either the address of the payment token contract or \&#39;NATIVE\&#39;.
39
41
  * @param {string} [pageCursor] Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
40
42
  * @param {*} [options] Override http request option.
41
43
  * @throws {RequiredError}
42
44
  */
43
- quotesForStacks: (chainName: string, contractAddress: string, stackId: Array<string>, pageCursor?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
45
+ quotesForStacks: (chainName: string, contractAddress: string, stackId: Array<string>, paymentToken?: string, pageCursor?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
44
46
  };
45
47
  /**
46
48
  * PricingApi - functional programming interface
@@ -53,22 +55,24 @@ export declare const PricingApiFp: (configuration?: Configuration) => {
53
55
  * @param {string} chainName The name of chain
54
56
  * @param {string} contractAddress Contract address for collection that these token ids are on
55
57
  * @param {Array<string>} tokenId List of token ids to get pricing data for
58
+ * @param {string} [paymentToken] Filters the active listings, bids, floor listing and top bid by the specified payment token, either the address of the payment token contract or \&#39;NATIVE\&#39;.
56
59
  * @param {string} [pageCursor] Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
57
60
  * @param {*} [options] Override http request option.
58
61
  * @throws {RequiredError}
59
62
  */
60
- quotesForNFTs(chainName: string, contractAddress: string, tokenId: Array<string>, pageCursor?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QuotesForNFTsResult>>;
63
+ quotesForNFTs(chainName: string, contractAddress: string, tokenId: Array<string>, paymentToken?: string, pageCursor?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QuotesForNFTsResult>>;
61
64
  /**
62
65
  * Get pricing data for a list of stack ids
63
66
  * @summary Get pricing data for a list of stack ids
64
67
  * @param {string} chainName The name of chain
65
68
  * @param {string} contractAddress Contract address for collection that these stacks are on
66
69
  * @param {Array<string>} stackId List of stack ids to get pricing data for
70
+ * @param {string} [paymentToken] Filters the active listings, bids, floor listing and top bid by the specified payment token, either the address of the payment token contract or \&#39;NATIVE\&#39;.
67
71
  * @param {string} [pageCursor] Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
68
72
  * @param {*} [options] Override http request option.
69
73
  * @throws {RequiredError}
70
74
  */
71
- quotesForStacks(chainName: string, contractAddress: string, stackId: Array<string>, pageCursor?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QuotesForStacksResult>>;
75
+ quotesForStacks(chainName: string, contractAddress: string, stackId: Array<string>, paymentToken?: string, pageCursor?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<QuotesForStacksResult>>;
72
76
  };
73
77
  /**
74
78
  * PricingApi - factory interface
@@ -116,6 +120,12 @@ export interface PricingApiQuotesForNFTsRequest {
116
120
  * @memberof PricingApiQuotesForNFTs
117
121
  */
118
122
  readonly tokenId: Array<string>;
123
+ /**
124
+ * Filters the active listings, bids, floor listing and top bid by the specified payment token, either the address of the payment token contract or \&#39;NATIVE\&#39;.
125
+ * @type {string}
126
+ * @memberof PricingApiQuotesForNFTs
127
+ */
128
+ readonly paymentToken?: string;
119
129
  /**
120
130
  * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
121
131
  * @type {string}
@@ -147,6 +157,12 @@ export interface PricingApiQuotesForStacksRequest {
147
157
  * @memberof PricingApiQuotesForStacks
148
158
  */
149
159
  readonly stackId: Array<string>;
160
+ /**
161
+ * Filters the active listings, bids, floor listing and top bid by the specified payment token, either the address of the payment token contract or \&#39;NATIVE\&#39;.
162
+ * @type {string}
163
+ * @memberof PricingApiQuotesForStacks
164
+ */
165
+ readonly paymentToken?: string;
150
166
  /**
151
167
  * Encoded page cursor to retrieve previous or next page. Use the value returned in the response.
152
168
  * @type {string}
@@ -0,0 +1,16 @@
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
+ /**
13
+ * @type DomainTypeChainId
14
+ * @export
15
+ */
16
+ export type DomainTypeChainId = number | string;
@@ -9,40 +9,41 @@
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
+ import { DomainTypeChainId } from './domain-type-chain-id';
12
13
  /**
13
14
  *
14
15
  * @export
15
- * @interface EIP712MessageDomain
16
+ * @interface DomainType
16
17
  */
17
- export interface EIP712MessageDomain {
18
+ export interface DomainType {
18
19
  /**
19
20
  *
20
21
  * @type {string}
21
- * @memberof EIP712MessageDomain
22
+ * @memberof DomainType
22
23
  */
23
24
  'name'?: string;
24
25
  /**
25
26
  *
26
27
  * @type {string}
27
- * @memberof EIP712MessageDomain
28
+ * @memberof DomainType
28
29
  */
29
30
  'version'?: string;
30
31
  /**
31
32
  *
32
- * @type {string}
33
- * @memberof EIP712MessageDomain
33
+ * @type {DomainTypeChainId}
34
+ * @memberof DomainType
34
35
  */
35
- 'chainId'?: string;
36
+ 'chainId'?: DomainTypeChainId;
36
37
  /**
37
38
  *
38
39
  * @type {string}
39
- * @memberof EIP712MessageDomain
40
+ * @memberof DomainType
40
41
  */
41
42
  'verifyingContract'?: string;
42
43
  /**
43
44
  *
44
45
  * @type {string}
45
- * @memberof EIP712MessageDomain
46
+ * @memberof DomainType
46
47
  */
47
48
  'salt'?: string;
48
49
  }
@@ -9,7 +9,7 @@
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
- import { EIP712MessageDomain } from './eip712-message-domain';
12
+ import { DomainType } from './domain-type';
13
13
  import { EIP712MessageTypes } from './eip712-message-types';
14
14
  /**
15
15
  *
@@ -31,10 +31,10 @@ export interface EIP712Message {
31
31
  'primaryType': string;
32
32
  /**
33
33
  *
34
- * @type {EIP712MessageDomain}
34
+ * @type {DomainType}
35
35
  * @memberof EIP712Message
36
36
  */
37
- 'domain': EIP712MessageDomain;
37
+ 'domain': DomainType;
38
38
  /**
39
39
  *
40
40
  * @type {object}
@@ -0,0 +1,42 @@
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
+ /**
13
+ * The user\'s passport metadata
14
+ * @export
15
+ * @interface GetPassportMetadataResPassportMetadataInner
16
+ */
17
+ export interface GetPassportMetadataResPassportMetadataInner {
18
+ /**
19
+ * The chain id (eg: eip155:1)
20
+ * @type {string}
21
+ * @memberof GetPassportMetadataResPassportMetadataInner
22
+ */
23
+ 'chain_id'?: string;
24
+ /**
25
+ * The chain key
26
+ * @type {string}
27
+ * @memberof GetPassportMetadataResPassportMetadataInner
28
+ */
29
+ 'chain_key'?: string;
30
+ /**
31
+ * The user admin key
32
+ * @type {string}
33
+ * @memberof GetPassportMetadataResPassportMetadataInner
34
+ */
35
+ 'user_admin_key'?: string;
36
+ /**
37
+ * The counterfactual address
38
+ * @type {string}
39
+ * @memberof GetPassportMetadataResPassportMetadataInner
40
+ */
41
+ 'counterfactual_address'?: string;
42
+ }
@@ -0,0 +1,25 @@
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
+ import { GetPassportMetadataResPassportMetadataInner } from './get-passport-metadata-res-passport-metadata-inner';
13
+ /**
14
+ *
15
+ * @export
16
+ * @interface GetPassportMetadataRes
17
+ */
18
+ export interface GetPassportMetadataRes {
19
+ /**
20
+ * The user\'s passport metadata
21
+ * @type {Array<GetPassportMetadataResPassportMetadataInner>}
22
+ * @memberof GetPassportMetadataRes
23
+ */
24
+ 'passport_metadata': Array<GetPassportMetadataResPassportMetadataInner>;
25
+ }
@@ -50,8 +50,9 @@ export * from './create-listing-request-body';
50
50
  export * from './create-mint-request-request';
51
51
  export * from './create-mint-request-result';
52
52
  export * from './deposit';
53
+ export * from './domain-type';
54
+ export * from './domain-type-chain-id';
53
55
  export * from './eip712-message';
54
- export * from './eip712-message-domain';
55
56
  export * from './eip712-message-types';
56
57
  export * from './eip712-message-types-eip712-domain-inner';
57
58
  export * from './erc1155-collection-item';
@@ -88,6 +89,8 @@ export * from './get-linked-addresses-res-deprecated';
88
89
  export * from './get-metadata-result';
89
90
  export * from './get-mint-request-result';
90
91
  export * from './get-nftresult';
92
+ export * from './get-passport-metadata-res';
93
+ export * from './get-passport-metadata-res-passport-metadata-inner';
91
94
  export * from './get-token-result';
92
95
  export * from './get-transaction-metadata-request';
93
96
  export * from './get-transaction-metadata-res';
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@imtbl/generated-clients",
3
3
  "description": "Generated Immutable API clients",
4
- "version": "2.0.0-alpha.9",
4
+ "version": "2.0.0",
5
5
  "author": "Immutable",
6
6
  "bugs": "https://github.com/immutable/ts-immutable-sdk/issues",
7
7
  "dependencies": {
@@ -52,6 +52,7 @@
52
52
  "build": "pnpm transpile && pnpm typegen",
53
53
  "transpile": "tsup src/index.ts --config ../../../tsup.config.js",
54
54
  "typegen": "tsc --customConditions default --emitDeclarationOnly --outDir dist/types",
55
+ "pack:root": "pnpm pack --pack-destination $(dirname $(pnpm root -w))",
55
56
  "test": "jest",
56
57
  "test:watch": "jest --watch",
57
58
  "typecheck": "tsc --customConditions default --noEmit --jsx preserve",