@compass-labs/api-sdk 2.2.45 → 2.2.46-rc.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.
Files changed (142) hide show
  1. package/README.md +18 -20
  2. package/codeSamples_typescript.yaml +0 -6
  3. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsCreateAccount.d.ts +1 -1
  4. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsCreateAccount.js +1 -1
  5. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsMarkets.d.ts +1 -1
  6. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsMarkets.js +1 -1
  7. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsMarketsSymbol.d.ts +7 -1
  8. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsMarketsSymbol.d.ts.map +1 -1
  9. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsMarketsSymbol.js +13 -2
  10. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsMarketsSymbol.js.map +1 -1
  11. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsOrder.d.ts +1 -1
  12. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsOrder.js +1 -1
  13. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHash.d.ts +1 -1
  14. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHash.js +1 -1
  15. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHashCancel.d.ts +1 -1
  16. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHashCancel.js +1 -1
  17. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsOrderSubmit.d.ts +1 -1
  18. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsOrderSubmit.js +1 -1
  19. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsPositions.d.ts +1 -1
  20. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsPositions.js +1 -1
  21. package/dist/commonjs/models/components/index.d.ts +2 -1
  22. package/dist/commonjs/models/components/index.d.ts.map +1 -1
  23. package/dist/commonjs/models/components/index.js +2 -1
  24. package/dist/commonjs/models/components/index.js.map +1 -1
  25. package/dist/commonjs/models/components/marketdetail.d.ts +5 -0
  26. package/dist/commonjs/models/components/marketdetail.d.ts.map +1 -1
  27. package/dist/commonjs/models/components/marketdetail.js +2 -0
  28. package/dist/commonjs/models/components/marketdetail.js.map +1 -1
  29. package/dist/commonjs/models/components/tokenizedassetsohlcinterval.d.ts +15 -0
  30. package/dist/commonjs/models/components/tokenizedassetsohlcinterval.d.ts.map +1 -0
  31. package/dist/commonjs/models/components/{tokenizedassetsohlcresponse.js → tokenizedassetsohlcinterval.js} +12 -13
  32. package/dist/commonjs/models/components/tokenizedassetsohlcinterval.js.map +1 -0
  33. package/dist/commonjs/models/components/tokenizedassetsohlcrange.d.ts +14 -0
  34. package/dist/commonjs/models/components/tokenizedassetsohlcrange.d.ts.map +1 -0
  35. package/dist/commonjs/models/{operations/v2tokenizedassetsmarketssymbolohlc.js → components/tokenizedassetsohlcrange.js} +2 -29
  36. package/dist/commonjs/models/components/tokenizedassetsohlcrange.js.map +1 -0
  37. package/dist/commonjs/models/operations/index.d.ts +0 -1
  38. package/dist/commonjs/models/operations/index.d.ts.map +1 -1
  39. package/dist/commonjs/models/operations/index.js +0 -1
  40. package/dist/commonjs/models/operations/index.js.map +1 -1
  41. package/dist/commonjs/models/operations/v2tokenizedassetsmarketssymbol.d.ts +11 -0
  42. package/dist/commonjs/models/operations/v2tokenizedassetsmarketssymbol.d.ts.map +1 -1
  43. package/dist/commonjs/models/operations/v2tokenizedassetsmarketssymbol.js +5 -0
  44. package/dist/commonjs/models/operations/v2tokenizedassetsmarketssymbol.js.map +1 -1
  45. package/dist/commonjs/sdk/tokenizedassets.d.ts +13 -17
  46. package/dist/commonjs/sdk/tokenizedassets.d.ts.map +1 -1
  47. package/dist/commonjs/sdk/tokenizedassets.js +14 -21
  48. package/dist/commonjs/sdk/tokenizedassets.js.map +1 -1
  49. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsCreateAccount.d.ts +1 -1
  50. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsCreateAccount.js +1 -1
  51. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsMarkets.d.ts +1 -1
  52. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsMarkets.js +1 -1
  53. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsMarketsSymbol.d.ts +7 -1
  54. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsMarketsSymbol.d.ts.map +1 -1
  55. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsMarketsSymbol.js +14 -3
  56. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsMarketsSymbol.js.map +1 -1
  57. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsOrder.d.ts +1 -1
  58. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsOrder.js +1 -1
  59. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHash.d.ts +1 -1
  60. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHash.js +1 -1
  61. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHashCancel.d.ts +1 -1
  62. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHashCancel.js +1 -1
  63. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsOrderSubmit.d.ts +1 -1
  64. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsOrderSubmit.js +1 -1
  65. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsPositions.d.ts +1 -1
  66. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsPositions.js +1 -1
  67. package/dist/esm/models/components/index.d.ts +2 -1
  68. package/dist/esm/models/components/index.d.ts.map +1 -1
  69. package/dist/esm/models/components/index.js +2 -1
  70. package/dist/esm/models/components/index.js.map +1 -1
  71. package/dist/esm/models/components/marketdetail.d.ts +5 -0
  72. package/dist/esm/models/components/marketdetail.d.ts.map +1 -1
  73. package/dist/esm/models/components/marketdetail.js +2 -0
  74. package/dist/esm/models/components/marketdetail.js.map +1 -1
  75. package/dist/esm/models/components/tokenizedassetsohlcinterval.d.ts +15 -0
  76. package/dist/esm/models/components/tokenizedassetsohlcinterval.d.ts.map +1 -0
  77. package/dist/esm/models/components/tokenizedassetsohlcinterval.js +16 -0
  78. package/dist/esm/models/components/tokenizedassetsohlcinterval.js.map +1 -0
  79. package/dist/esm/models/components/tokenizedassetsohlcrange.d.ts +14 -0
  80. package/dist/esm/models/components/tokenizedassetsohlcrange.d.ts.map +1 -0
  81. package/dist/esm/models/components/tokenizedassetsohlcrange.js +15 -0
  82. package/dist/esm/models/components/tokenizedassetsohlcrange.js.map +1 -0
  83. package/dist/esm/models/operations/index.d.ts +0 -1
  84. package/dist/esm/models/operations/index.d.ts.map +1 -1
  85. package/dist/esm/models/operations/index.js +0 -1
  86. package/dist/esm/models/operations/index.js.map +1 -1
  87. package/dist/esm/models/operations/v2tokenizedassetsmarketssymbol.d.ts +11 -0
  88. package/dist/esm/models/operations/v2tokenizedassetsmarketssymbol.d.ts.map +1 -1
  89. package/dist/esm/models/operations/v2tokenizedassetsmarketssymbol.js +5 -0
  90. package/dist/esm/models/operations/v2tokenizedassetsmarketssymbol.js.map +1 -1
  91. package/dist/esm/sdk/tokenizedassets.d.ts +13 -17
  92. package/dist/esm/sdk/tokenizedassets.d.ts.map +1 -1
  93. package/dist/esm/sdk/tokenizedassets.js +14 -21
  94. package/dist/esm/sdk/tokenizedassets.js.map +1 -1
  95. package/docs/models/components/marketdetail.md +24 -23
  96. package/docs/models/{operations → components}/tokenizedassetsohlcinterval.md +2 -4
  97. package/docs/models/{operations → components}/tokenizedassetsohlcrange.md +2 -4
  98. package/docs/models/operations/v2tokenizedassetsmarketssymbolrequest.md +5 -3
  99. package/docs/sdks/tokenizedassets/README.md +14 -92
  100. package/package.json +1 -1
  101. package/src/funcs/tokenizedAssetsTokenizedAssetsCreateAccount.ts +1 -1
  102. package/src/funcs/tokenizedAssetsTokenizedAssetsMarkets.ts +1 -1
  103. package/src/funcs/tokenizedAssetsTokenizedAssetsMarketsSymbol.ts +15 -3
  104. package/src/funcs/tokenizedAssetsTokenizedAssetsOrder.ts +1 -1
  105. package/src/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHash.ts +1 -1
  106. package/src/funcs/tokenizedAssetsTokenizedAssetsOrderOrderHashCancel.ts +1 -1
  107. package/src/funcs/tokenizedAssetsTokenizedAssetsOrderSubmit.ts +1 -1
  108. package/src/funcs/tokenizedAssetsTokenizedAssetsPositions.ts +1 -1
  109. package/src/models/components/index.ts +2 -1
  110. package/src/models/components/marketdetail.ts +6 -0
  111. package/src/models/components/tokenizedassetsohlcinterval.ts +24 -0
  112. package/src/models/components/tokenizedassetsohlcrange.ts +23 -0
  113. package/src/models/operations/index.ts +0 -1
  114. package/src/models/operations/v2tokenizedassetsmarketssymbol.ts +15 -0
  115. package/src/sdk/tokenizedassets.ts +14 -29
  116. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsMarketsSymbolOhlc.d.ts +0 -22
  117. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsMarketsSymbolOhlc.d.ts.map +0 -1
  118. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsMarketsSymbolOhlc.js +0 -133
  119. package/dist/commonjs/funcs/tokenizedAssetsTokenizedAssetsMarketsSymbolOhlc.js.map +0 -1
  120. package/dist/commonjs/models/components/tokenizedassetsohlcresponse.d.ts +0 -25
  121. package/dist/commonjs/models/components/tokenizedassetsohlcresponse.d.ts.map +0 -1
  122. package/dist/commonjs/models/components/tokenizedassetsohlcresponse.js.map +0 -1
  123. package/dist/commonjs/models/operations/v2tokenizedassetsmarketssymbolohlc.d.ts +0 -58
  124. package/dist/commonjs/models/operations/v2tokenizedassetsmarketssymbolohlc.d.ts.map +0 -1
  125. package/dist/commonjs/models/operations/v2tokenizedassetsmarketssymbolohlc.js.map +0 -1
  126. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsMarketsSymbolOhlc.d.ts +0 -22
  127. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsMarketsSymbolOhlc.d.ts.map +0 -1
  128. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsMarketsSymbolOhlc.js +0 -97
  129. package/dist/esm/funcs/tokenizedAssetsTokenizedAssetsMarketsSymbolOhlc.js.map +0 -1
  130. package/dist/esm/models/components/tokenizedassetsohlcresponse.d.ts +0 -25
  131. package/dist/esm/models/components/tokenizedassetsohlcresponse.d.ts.map +0 -1
  132. package/dist/esm/models/components/tokenizedassetsohlcresponse.js +0 -16
  133. package/dist/esm/models/components/tokenizedassetsohlcresponse.js.map +0 -1
  134. package/dist/esm/models/operations/v2tokenizedassetsmarketssymbolohlc.d.ts +0 -58
  135. package/dist/esm/models/operations/v2tokenizedassetsmarketssymbolohlc.d.ts.map +0 -1
  136. package/dist/esm/models/operations/v2tokenizedassetsmarketssymbolohlc.js +0 -41
  137. package/dist/esm/models/operations/v2tokenizedassetsmarketssymbolohlc.js.map +0 -1
  138. package/docs/models/components/tokenizedassetsohlcresponse.md +0 -31
  139. package/docs/models/operations/v2tokenizedassetsmarketssymbolohlcrequest.md +0 -21
  140. package/src/funcs/tokenizedAssetsTokenizedAssetsMarketsSymbolOhlc.ts +0 -196
  141. package/src/models/components/tokenizedassetsohlcresponse.ts +0 -48
  142. package/src/models/operations/v2tokenizedassetsmarketssymbolohlc.ts +0 -95
@@ -1,13 +1,11 @@
1
1
  # TokenizedAssetsOhlcRange
2
2
 
3
- Lookback window. Must form a valid pair with `interval`.
4
-
5
3
  ## Example Usage
6
4
 
7
5
  ```typescript
8
- import { TokenizedAssetsOhlcRange } from "@compass-labs/api-sdk/models/operations";
6
+ import { TokenizedAssetsOhlcRange } from "@compass-labs/api-sdk/models/components";
9
7
 
10
- let value: TokenizedAssetsOhlcRange = "1month";
8
+ let value: TokenizedAssetsOhlcRange = "6month";
11
9
  ```
12
10
 
13
11
  ## Values
@@ -12,6 +12,8 @@ let value: V2TokenizedAssetsMarketsSymbolRequest = {
12
12
 
13
13
  ## Fields
14
14
 
15
- | Field | Type | Required | Description |
16
- | ------------------ | ------------------ | ------------------ | ------------------ |
17
- | `symbol` | *string* | :heavy_check_mark: | N/A |
15
+ | Field | Type | Required | Description |
16
+ | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
17
+ | `symbol` | *string* | :heavy_check_mark: | N/A |
18
+ | `interval` | [components.TokenizedAssetsOhlcInterval](../../models/components/tokenizedassetsohlcinterval.md) | :heavy_minus_sign: | Optional candle interval. Must be paired with `range` and form a valid `(interval, range)` pair to include OHLC candles in the response. |
19
+ | `range` | [components.TokenizedAssetsOhlcRange](../../models/components/tokenizedassetsohlcrange.md) | :heavy_minus_sign: | Optional lookback window. Must be paired with `interval` and form a valid `(interval, range)` pair to include OHLC candles in the response. |
@@ -4,15 +4,14 @@
4
4
 
5
5
  ### Available Operations
6
6
 
7
- * [tokenizedAssetsMarkets](#tokenizedassetsmarkets) - List tokenized equity markets
8
- * [tokenizedAssetsMarketsSymbol](#tokenizedassetsmarketssymbol) - Get a single tokenized market
9
- * [tokenizedAssetsMarketsSymbolOhlc](#tokenizedassetsmarketssymbolohlc) - Get OHLC candles for a market
10
- * [tokenizedAssetsPositions](#tokenizedassetspositions) - Get on-chain tokenized-asset positions for a wallet
11
- * [tokenizedAssetsOrderOrderHash](#tokenizedassetsorderorderhash) - Get tokenized-asset order status
12
- * [tokenizedAssetsCreateAccount](#tokenizedassetscreateaccount) - Create tokenized assets account
13
- * [tokenizedAssetsOrder](#tokenizedassetsorder) - Build a tokenized-asset buy/sell order
14
- * [tokenizedAssetsOrderSubmit](#tokenizedassetsordersubmit) - Submit a signed tokenized-asset order to 1inch Fusion
15
- * [tokenizedAssetsOrderOrderHashCancel](#tokenizedassetsorderorderhashcancel) - Cancel an unfilled tokenized-asset order
7
+ * [tokenizedAssetsMarkets](#tokenizedassetsmarkets) - List equity markets
8
+ * [tokenizedAssetsMarketsSymbol](#tokenizedassetsmarketssymbol) - Get a single market
9
+ * [tokenizedAssetsPositions](#tokenizedassetspositions) - Get on-chain positions for a wallet
10
+ * [tokenizedAssetsOrderOrderHash](#tokenizedassetsorderorderhash) - Get order status
11
+ * [tokenizedAssetsCreateAccount](#tokenizedassetscreateaccount) - Create account
12
+ * [tokenizedAssetsOrder](#tokenizedassetsorder) - Build a buy/sell order
13
+ * [tokenizedAssetsOrderSubmit](#tokenizedassetsordersubmit) - Submit a signed order to 1inch Fusion
14
+ * [tokenizedAssetsOrderOrderHashCancel](#tokenizedassetsorderorderhashcancel) - Cancel an unfilled order
16
15
 
17
16
  ## tokenizedAssetsMarkets
18
17
 
@@ -92,6 +91,12 @@ run();
92
91
 
93
92
  Single-market detail for the on-chain Ondo symbol (e.g. `TSLAon`).
94
93
 
94
+ OHLC candles are opt-in via `interval` + `range`:
95
+
96
+ - Both omitted: 200 with `candles` absent.
97
+ - Both supplied and forming a valid Ondo pair: 200 with `candles` populated.
98
+ - Exactly one supplied, or both supplied with an invalid pair: 400.
99
+
95
100
  ### Example Usage
96
101
 
97
102
  <!-- UsageSnippet language="typescript" operationID="v2_tokenized_assets_markets_{symbol}" method="get" path="/v2/tokenized_assets/markets/{symbol}" -->
@@ -157,89 +162,6 @@ run();
157
162
 
158
163
  ### Errors
159
164
 
160
- | Error Type | Status Code | Content Type |
161
- | ----------------------------------- | ----------------------------------- | ----------------------------------- |
162
- | errors.TokenizedAssetsErrorResponse | 404 | application/json |
163
- | errors.HTTPValidationError | 422 | application/json |
164
- | errors.TokenizedAssetsErrorResponse | 502 | application/json |
165
- | errors.APIError | 4XX, 5XX | \*/\* |
166
-
167
- ## tokenizedAssetsMarketsSymbolOhlc
168
-
169
- OHLC candles for the given Ondo symbol.
170
-
171
- `interval` + `range` must form one of the closed Ondo pairs (see request
172
- model docstring); invalid pairs return 400.
173
-
174
- ### Example Usage
175
-
176
- <!-- UsageSnippet language="typescript" operationID="v2_tokenized_assets_markets_{symbol}_ohlc" method="get" path="/v2/tokenized_assets/markets/{symbol}/ohlc" -->
177
- ```typescript
178
- import { CompassApiSDK } from "@compass-labs/api-sdk";
179
-
180
- const compassApiSDK = new CompassApiSDK({
181
- apiKeyAuth: "<YOUR_API_KEY_HERE>",
182
- });
183
-
184
- async function run() {
185
- const result = await compassApiSDK.tokenizedAssets.tokenizedAssetsMarketsSymbolOhlc({
186
- symbol: "<value>",
187
- interval: "1hour",
188
- range: "1month",
189
- });
190
-
191
- console.log(result);
192
- }
193
-
194
- run();
195
- ```
196
-
197
- ### Standalone function
198
-
199
- The standalone function version of this method:
200
-
201
- ```typescript
202
- import { CompassApiSDKCore } from "@compass-labs/api-sdk/core.js";
203
- import { tokenizedAssetsTokenizedAssetsMarketsSymbolOhlc } from "@compass-labs/api-sdk/funcs/tokenizedAssetsTokenizedAssetsMarketsSymbolOhlc.js";
204
-
205
- // Use `CompassApiSDKCore` for best tree-shaking performance.
206
- // You can create one instance of it to use across an application.
207
- const compassApiSDK = new CompassApiSDKCore({
208
- apiKeyAuth: "<YOUR_API_KEY_HERE>",
209
- });
210
-
211
- async function run() {
212
- const res = await tokenizedAssetsTokenizedAssetsMarketsSymbolOhlc(compassApiSDK, {
213
- symbol: "<value>",
214
- interval: "1hour",
215
- range: "1month",
216
- });
217
- if (res.ok) {
218
- const { value: result } = res;
219
- console.log(result);
220
- } else {
221
- console.log("tokenizedAssetsTokenizedAssetsMarketsSymbolOhlc failed:", res.error);
222
- }
223
- }
224
-
225
- run();
226
- ```
227
-
228
- ### Parameters
229
-
230
- | Parameter | Type | Required | Description |
231
- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
232
- | `request` | [operations.V2TokenizedAssetsMarketsSymbolOhlcRequest](../../models/operations/v2tokenizedassetsmarketssymbolohlcrequest.md) | :heavy_check_mark: | The request object to use for the request. |
233
- | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. |
234
- | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
235
- | `options.retries` | [RetryConfig](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. |
236
-
237
- ### Response
238
-
239
- **Promise\<[components.TokenizedAssetsOhlcResponse](../../models/components/tokenizedassetsohlcresponse.md)\>**
240
-
241
- ### Errors
242
-
243
165
  | Error Type | Status Code | Content Type |
244
166
  | ----------------------------------- | ----------------------------------- | ----------------------------------- |
245
167
  | errors.TokenizedAssetsErrorResponse | 400, 404 | application/json |
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@compass-labs/api-sdk",
3
- "version": "2.2.45",
3
+ "version": "2.2.46-rc.0",
4
4
  "author": "royalnine",
5
5
  "type": "module",
6
6
  "tshy": {
@@ -27,7 +27,7 @@ import { APICall, APIPromise } from "../types/async.js";
27
27
  import { Result } from "../types/fp.js";
28
28
 
29
29
  /**
30
- * Create tokenized assets account
30
+ * Create account
31
31
  *
32
32
  * @remarks
33
33
  * Create a Tokenized Assets Account for a wallet address.
@@ -28,7 +28,7 @@ import { APICall, APIPromise } from "../types/async.js";
28
28
  import { Result } from "../types/fp.js";
29
29
 
30
30
  /**
31
- * List tokenized equity markets
31
+ * List equity markets
32
32
  *
33
33
  * @remarks
34
34
  * List tokenized equities surfaced on Ethereum.
@@ -3,7 +3,7 @@
3
3
  */
4
4
 
5
5
  import { CompassApiSDKCore } from "../core.js";
6
- import { encodeSimple } from "../lib/encodings.js";
6
+ import { encodeFormQuery, encodeSimple } from "../lib/encodings.js";
7
7
  import { matchStatusCode } from "../lib/http.js";
8
8
  import * as M from "../lib/matchers.js";
9
9
  import { compactMap } from "../lib/primitives.js";
@@ -28,10 +28,16 @@ import { APICall, APIPromise } from "../types/async.js";
28
28
  import { Result } from "../types/fp.js";
29
29
 
30
30
  /**
31
- * Get a single tokenized market
31
+ * Get a single market
32
32
  *
33
33
  * @remarks
34
34
  * Single-market detail for the on-chain Ondo symbol (e.g. `TSLAon`).
35
+ *
36
+ * OHLC candles are opt-in via `interval` + `range`:
37
+ *
38
+ * - Both omitted: 200 with `candles` absent.
39
+ * - Both supplied and forming a valid Ondo pair: 200 with `candles` populated.
40
+ * - Exactly one supplied, or both supplied with an invalid pair: 400.
35
41
  */
36
42
  export function tokenizedAssetsTokenizedAssetsMarketsSymbol(
37
43
  client: CompassApiSDKCore,
@@ -103,6 +109,11 @@ async function $do(
103
109
  };
104
110
  const path = pathToFunc("/v2/tokenized_assets/markets/{symbol}")(pathParams);
105
111
 
112
+ const query = encodeFormQuery({
113
+ "interval": payload.interval,
114
+ "range": payload.range,
115
+ });
116
+
106
117
  const headers = new Headers(compactMap({
107
118
  Accept: "application/json",
108
119
  }));
@@ -132,6 +143,7 @@ async function $do(
132
143
  baseURL: options?.serverURL,
133
144
  path: path,
134
145
  headers: headers,
146
+ query: query,
135
147
  body: body,
136
148
  userAgent: client._options.userAgent,
137
149
  timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1,
@@ -171,7 +183,7 @@ async function $do(
171
183
  | SDKValidationError
172
184
  >(
173
185
  M.json(200, components.MarketDetail$inboundSchema),
174
- M.jsonErr(404, errors.TokenizedAssetsErrorResponse$inboundSchema),
186
+ M.jsonErr([400, 404], errors.TokenizedAssetsErrorResponse$inboundSchema),
175
187
  M.jsonErr(422, errors.HTTPValidationError$inboundSchema),
176
188
  M.jsonErr(502, errors.TokenizedAssetsErrorResponse$inboundSchema),
177
189
  M.fail("4XX"),
@@ -27,7 +27,7 @@ import { APICall, APIPromise } from "../types/async.js";
27
27
  import { Result } from "../types/fp.js";
28
28
 
29
29
  /**
30
- * Build a tokenized-asset buy/sell order
30
+ * Build a buy/sell order
31
31
  *
32
32
  * @remarks
33
33
  * Build a quote, optional approve SafeTx, and SafeMessage EIP-712 to sign.
@@ -28,7 +28,7 @@ import { APICall, APIPromise } from "../types/async.js";
28
28
  import { Result } from "../types/fp.js";
29
29
 
30
30
  /**
31
- * Get tokenized-asset order status
31
+ * Get order status
32
32
  *
33
33
  * @remarks
34
34
  * Status of a relayed Fusion order — `pending` / `filled` / `expired` / `cancelled`.
@@ -28,7 +28,7 @@ import { APICall, APIPromise } from "../types/async.js";
28
28
  import { Result } from "../types/fp.js";
29
29
 
30
30
  /**
31
- * Cancel an unfilled tokenized-asset order
31
+ * Cancel an unfilled order
32
32
  *
33
33
  * @remarks
34
34
  * Build a SafeTx EIP-712 wrapping the on-chain cancel for a Fusion order.
@@ -27,7 +27,7 @@ import { APICall, APIPromise } from "../types/async.js";
27
27
  import { Result } from "../types/fp.js";
28
28
 
29
29
  /**
30
- * Submit a signed tokenized-asset order to 1inch Fusion
30
+ * Submit a signed order to 1inch Fusion
31
31
  *
32
32
  * @remarks
33
33
  * Relay an owner-signed Fusion order to the 1inch relayer.
@@ -28,7 +28,7 @@ import { APICall, APIPromise } from "../types/async.js";
28
28
  import { Result } from "../types/fp.js";
29
29
 
30
30
  /**
31
- * Get on-chain tokenized-asset positions for a wallet
31
+ * Get on-chain positions for a wallet
32
32
  *
33
33
  * @remarks
34
34
  * On-chain ERC-20 balance reads for a wallet across all listed Ondo GM tokens.
@@ -257,7 +257,8 @@ export * from "./tokenizedassetsbuildorderresponse.js";
257
257
  export * from "./tokenizedassetscancelorderrequest.js";
258
258
  export * from "./tokenizedassetscancelorderresponse.js";
259
259
  export * from "./tokenizedassetsmarketslistresponse.js";
260
- export * from "./tokenizedassetsohlcresponse.js";
260
+ export * from "./tokenizedassetsohlcinterval.js";
261
+ export * from "./tokenizedassetsohlcrange.js";
261
262
  export * from "./tokenizedassetspositionsresponse.js";
262
263
  export * from "./tokenizedassetssubmitorderrequest.js";
263
264
  export * from "./tokenizedassetssubmitorderresponse.js";
@@ -8,6 +8,7 @@ import { safeParse } from "../../lib/schemas.js";
8
8
  import { ClosedEnum } from "../../types/enums.js";
9
9
  import { Result as SafeParseResult } from "../../types/fp.js";
10
10
  import { SDKValidationError } from "../errors/sdkvalidationerror.js";
11
+ import { OhlcCandle, OhlcCandle$inboundSchema } from "./ohlccandle.js";
11
12
  import { PricePoint, PricePoint$inboundSchema } from "./pricepoint.js";
12
13
 
13
14
  /**
@@ -109,6 +110,10 @@ export type MarketDetail = {
109
110
  * Shares-multiplier ratio (= 1 if no recent split / corporate action).
110
111
  */
111
112
  sharesMultiplier?: string | null | undefined;
113
+ /**
114
+ * OHLC candles. Present only when both `interval` and `range` query params are provided and form a valid pair; omitted otherwise.
115
+ */
116
+ candles?: Array<OhlcCandle> | null | undefined;
112
117
  };
113
118
 
114
119
  /** @internal */
@@ -143,6 +148,7 @@ export const MarketDetail$inboundSchema: z.ZodType<
143
148
  total_holders: z.nullable(z.number().int()).optional(),
144
149
  tradable_sessions: z.array(z.string()).optional(),
145
150
  shares_multiplier: z.nullable(z.string()).optional(),
151
+ candles: z.nullable(z.array(OhlcCandle$inboundSchema)).optional(),
146
152
  }).transform((v) => {
147
153
  return remap$(v, {
148
154
  "underlying_ticker": "underlyingTicker",
@@ -0,0 +1,24 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import * as z from "zod/v3";
6
+ import { ClosedEnum } from "../../types/enums.js";
7
+
8
+ export const TokenizedAssetsOhlcInterval = {
9
+ Onemin: "1min",
10
+ Fivemin: "5min",
11
+ Fifteenmin: "15min",
12
+ Onehour: "1hour",
13
+ Fourhour: "4hour",
14
+ Twelvehour: "12hour",
15
+ Oneday: "1day",
16
+ } as const;
17
+ export type TokenizedAssetsOhlcInterval = ClosedEnum<
18
+ typeof TokenizedAssetsOhlcInterval
19
+ >;
20
+
21
+ /** @internal */
22
+ export const TokenizedAssetsOhlcInterval$outboundSchema: z.ZodNativeEnum<
23
+ typeof TokenizedAssetsOhlcInterval
24
+ > = z.nativeEnum(TokenizedAssetsOhlcInterval);
@@ -0,0 +1,23 @@
1
+ /*
2
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
3
+ */
4
+
5
+ import * as z from "zod/v3";
6
+ import { ClosedEnum } from "../../types/enums.js";
7
+
8
+ export const TokenizedAssetsOhlcRange = {
9
+ Oneday: "1day",
10
+ Onemonth: "1month",
11
+ Threemonth: "3month",
12
+ Sixmonth: "6month",
13
+ Oneyear: "1year",
14
+ All: "all",
15
+ } as const;
16
+ export type TokenizedAssetsOhlcRange = ClosedEnum<
17
+ typeof TokenizedAssetsOhlcRange
18
+ >;
19
+
20
+ /** @internal */
21
+ export const TokenizedAssetsOhlcRange$outboundSchema: z.ZodNativeEnum<
22
+ typeof TokenizedAssetsOhlcRange
23
+ > = z.nativeEnum(TokenizedAssetsOhlcRange);
@@ -51,7 +51,6 @@ export * from "./v2earnpositionsall.js";
51
51
  export * from "./v2earnvaults.js";
52
52
  export * from "./v2tokenizedassetsmarkets.js";
53
53
  export * from "./v2tokenizedassetsmarketssymbol.js";
54
- export * from "./v2tokenizedassetsmarketssymbolohlc.js";
55
54
  export * from "./v2tokenizedassetsorderorderhash.js";
56
55
  export * from "./v2tokenizedassetsorderorderhashcancel.js";
57
56
  export * from "./v2tokenizedassetspositions.js";
@@ -3,14 +3,25 @@
3
3
  */
4
4
 
5
5
  import * as z from "zod/v3";
6
+ import * as components from "../components/index.js";
6
7
 
7
8
  export type V2TokenizedAssetsMarketsSymbolRequest = {
8
9
  symbol: string;
10
+ /**
11
+ * Optional candle interval. Must be paired with `range` and form a valid `(interval, range)` pair to include OHLC candles in the response.
12
+ */
13
+ interval?: components.TokenizedAssetsOhlcInterval | null | undefined;
14
+ /**
15
+ * Optional lookback window. Must be paired with `interval` and form a valid `(interval, range)` pair to include OHLC candles in the response.
16
+ */
17
+ range?: components.TokenizedAssetsOhlcRange | null | undefined;
9
18
  };
10
19
 
11
20
  /** @internal */
12
21
  export type V2TokenizedAssetsMarketsSymbolRequest$Outbound = {
13
22
  symbol: string;
23
+ interval?: string | null | undefined;
24
+ range?: string | null | undefined;
14
25
  };
15
26
 
16
27
  /** @internal */
@@ -20,6 +31,10 @@ export const V2TokenizedAssetsMarketsSymbolRequest$outboundSchema: z.ZodType<
20
31
  V2TokenizedAssetsMarketsSymbolRequest
21
32
  > = z.object({
22
33
  symbol: z.string(),
34
+ interval: z.nullable(components.TokenizedAssetsOhlcInterval$outboundSchema)
35
+ .optional(),
36
+ range: z.nullable(components.TokenizedAssetsOhlcRange$outboundSchema)
37
+ .optional(),
23
38
  });
24
39
 
25
40
  export function v2TokenizedAssetsMarketsSymbolRequestToJSON(
@@ -5,7 +5,6 @@
5
5
  import { tokenizedAssetsTokenizedAssetsCreateAccount } from "../funcs/tokenizedAssetsTokenizedAssetsCreateAccount.js";
6
6
  import { tokenizedAssetsTokenizedAssetsMarkets } from "../funcs/tokenizedAssetsTokenizedAssetsMarkets.js";
7
7
  import { tokenizedAssetsTokenizedAssetsMarketsSymbol } from "../funcs/tokenizedAssetsTokenizedAssetsMarketsSymbol.js";
8
- import { tokenizedAssetsTokenizedAssetsMarketsSymbolOhlc } from "../funcs/tokenizedAssetsTokenizedAssetsMarketsSymbolOhlc.js";
9
8
  import { tokenizedAssetsTokenizedAssetsOrder } from "../funcs/tokenizedAssetsTokenizedAssetsOrder.js";
10
9
  import { tokenizedAssetsTokenizedAssetsOrderOrderHash } from "../funcs/tokenizedAssetsTokenizedAssetsOrderOrderHash.js";
11
10
  import { tokenizedAssetsTokenizedAssetsOrderOrderHashCancel } from "../funcs/tokenizedAssetsTokenizedAssetsOrderOrderHashCancel.js";
@@ -18,7 +17,7 @@ import { unwrapAsync } from "../types/fp.js";
18
17
 
19
18
  export class TokenizedAssets extends ClientSDK {
20
19
  /**
21
- * List tokenized equity markets
20
+ * List equity markets
22
21
  *
23
22
  * @remarks
24
23
  * List tokenized equities surfaced on Ethereum.
@@ -38,10 +37,16 @@ export class TokenizedAssets extends ClientSDK {
38
37
  }
39
38
 
40
39
  /**
41
- * Get a single tokenized market
40
+ * Get a single market
42
41
  *
43
42
  * @remarks
44
43
  * Single-market detail for the on-chain Ondo symbol (e.g. `TSLAon`).
44
+ *
45
+ * OHLC candles are opt-in via `interval` + `range`:
46
+ *
47
+ * - Both omitted: 200 with `candles` absent.
48
+ * - Both supplied and forming a valid Ondo pair: 200 with `candles` populated.
49
+ * - Exactly one supplied, or both supplied with an invalid pair: 400.
45
50
  */
46
51
  async tokenizedAssetsMarketsSymbol(
47
52
  request: operations.V2TokenizedAssetsMarketsSymbolRequest,
@@ -55,27 +60,7 @@ export class TokenizedAssets extends ClientSDK {
55
60
  }
56
61
 
57
62
  /**
58
- * Get OHLC candles for a market
59
- *
60
- * @remarks
61
- * OHLC candles for the given Ondo symbol.
62
- *
63
- * `interval` + `range` must form one of the closed Ondo pairs (see request
64
- * model docstring); invalid pairs return 400.
65
- */
66
- async tokenizedAssetsMarketsSymbolOhlc(
67
- request: operations.V2TokenizedAssetsMarketsSymbolOhlcRequest,
68
- options?: RequestOptions,
69
- ): Promise<components.TokenizedAssetsOhlcResponse> {
70
- return unwrapAsync(tokenizedAssetsTokenizedAssetsMarketsSymbolOhlc(
71
- this,
72
- request,
73
- options,
74
- ));
75
- }
76
-
77
- /**
78
- * Get on-chain tokenized-asset positions for a wallet
63
+ * Get on-chain positions for a wallet
79
64
  *
80
65
  * @remarks
81
66
  * On-chain ERC-20 balance reads for a wallet across all listed Ondo GM tokens.
@@ -96,7 +81,7 @@ export class TokenizedAssets extends ClientSDK {
96
81
  }
97
82
 
98
83
  /**
99
- * Get tokenized-asset order status
84
+ * Get order status
100
85
  *
101
86
  * @remarks
102
87
  * Status of a relayed Fusion order — `pending` / `filled` / `expired` / `cancelled`.
@@ -117,7 +102,7 @@ export class TokenizedAssets extends ClientSDK {
117
102
  }
118
103
 
119
104
  /**
120
- * Create tokenized assets account
105
+ * Create account
121
106
  *
122
107
  * @remarks
123
108
  * Create a Tokenized Assets Account for a wallet address.
@@ -146,7 +131,7 @@ export class TokenizedAssets extends ClientSDK {
146
131
  }
147
132
 
148
133
  /**
149
- * Build a tokenized-asset buy/sell order
134
+ * Build a buy/sell order
150
135
  *
151
136
  * @remarks
152
137
  * Build a quote, optional approve SafeTx, and SafeMessage EIP-712 to sign.
@@ -180,7 +165,7 @@ export class TokenizedAssets extends ClientSDK {
180
165
  }
181
166
 
182
167
  /**
183
- * Submit a signed tokenized-asset order to 1inch Fusion
168
+ * Submit a signed order to 1inch Fusion
184
169
  *
185
170
  * @remarks
186
171
  * Relay an owner-signed Fusion order to the 1inch relayer.
@@ -208,7 +193,7 @@ export class TokenizedAssets extends ClientSDK {
208
193
  }
209
194
 
210
195
  /**
211
- * Cancel an unfilled tokenized-asset order
196
+ * Cancel an unfilled order
212
197
  *
213
198
  * @remarks
214
199
  * Build a SafeTx EIP-712 wrapping the on-chain cancel for a Fusion order.
@@ -1,22 +0,0 @@
1
- import { CompassApiSDKCore } from "../core.js";
2
- import { RequestOptions } from "../lib/sdks.js";
3
- import * as components from "../models/components/index.js";
4
- import { CompassAPISDKError } from "../models/errors/compassapisdkerror.js";
5
- import { ConnectionError, InvalidRequestError, RequestAbortedError, RequestTimeoutError, UnexpectedClientError } from "../models/errors/httpclienterrors.js";
6
- import * as errors from "../models/errors/index.js";
7
- import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
8
- import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
9
- import * as operations from "../models/operations/index.js";
10
- import { APIPromise } from "../types/async.js";
11
- import { Result } from "../types/fp.js";
12
- /**
13
- * Get OHLC candles for a market
14
- *
15
- * @remarks
16
- * OHLC candles for the given Ondo symbol.
17
- *
18
- * `interval` + `range` must form one of the closed Ondo pairs (see request
19
- * model docstring); invalid pairs return 400.
20
- */
21
- export declare function tokenizedAssetsTokenizedAssetsMarketsSymbolOhlc(client: CompassApiSDKCore, request: operations.V2TokenizedAssetsMarketsSymbolOhlcRequest, options?: RequestOptions): APIPromise<Result<components.TokenizedAssetsOhlcResponse, errors.TokenizedAssetsErrorResponse | errors.HTTPValidationError | CompassAPISDKError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
22
- //# sourceMappingURL=tokenizedAssetsTokenizedAssetsMarketsSymbolOhlc.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"tokenizedAssetsTokenizedAssetsMarketsSymbolOhlc.d.ts","sourceRoot":"","sources":["../../../src/funcs/tokenizedAssetsTokenizedAssetsMarketsSymbolOhlc.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,iBAAiB,EAAE,MAAM,YAAY,CAAC;AAM/C,OAAO,EAAE,cAAc,EAAE,MAAM,gBAAgB,CAAC;AAGhD,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAC5D,OAAO,EAAE,kBAAkB,EAAE,MAAM,wCAAwC,CAAC;AAC5E,OAAO,EACL,eAAe,EACf,mBAAmB,EACnB,mBAAmB,EACnB,mBAAmB,EACnB,qBAAqB,EACtB,MAAM,sCAAsC,CAAC;AAC9C,OAAO,KAAK,MAAM,MAAM,2BAA2B,CAAC;AACpD,OAAO,EAAE,uBAAuB,EAAE,MAAM,6CAA6C,CAAC;AACtF,OAAO,EAAE,kBAAkB,EAAE,MAAM,wCAAwC,CAAC;AAC5E,OAAO,KAAK,UAAU,MAAM,+BAA+B,CAAC;AAC5D,OAAO,EAAW,UAAU,EAAE,MAAM,mBAAmB,CAAC;AACxD,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAExC;;;;;;;;GAQG;AACH,wBAAgB,+CAA+C,CAC7D,MAAM,EAAE,iBAAiB,EACzB,OAAO,EAAE,UAAU,CAAC,yCAAyC,EAC7D,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CACX,MAAM,CACJ,UAAU,CAAC,2BAA2B,EACpC,MAAM,CAAC,4BAA4B,GACnC,MAAM,CAAC,mBAAmB,GAC1B,kBAAkB,GAClB,uBAAuB,GACvB,eAAe,GACf,mBAAmB,GACnB,mBAAmB,GACnB,mBAAmB,GACnB,qBAAqB,GACrB,kBAAkB,CACrB,CACF,CAMA"}