@compass-labs/api-sdk 2.2.88 → 2.2.89-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 (55) hide show
  1. package/dist/commonjs/lib/config.d.ts +2 -2
  2. package/dist/commonjs/lib/config.js +2 -2
  3. package/dist/commonjs/models/components/compassapibackendv2modelstokenizedassetsmarketmarket.d.ts +10 -4
  4. package/dist/commonjs/models/components/compassapibackendv2modelstokenizedassetsmarketmarket.d.ts.map +1 -1
  5. package/dist/commonjs/models/components/compassapibackendv2modelstokenizedassetsmarketmarket.js +2 -0
  6. package/dist/commonjs/models/components/compassapibackendv2modelstokenizedassetsmarketmarket.js.map +1 -1
  7. package/dist/commonjs/models/components/compassapibackendv2modelstokenizedassetsreadresponsepositionsposition.d.ts +6 -4
  8. package/dist/commonjs/models/components/compassapibackendv2modelstokenizedassetsreadresponsepositionsposition.d.ts.map +1 -1
  9. package/dist/commonjs/models/components/compassapibackendv2modelstokenizedassetsreadresponsepositionsposition.js.map +1 -1
  10. package/dist/commonjs/models/components/marketdetail.d.ts +10 -4
  11. package/dist/commonjs/models/components/marketdetail.d.ts.map +1 -1
  12. package/dist/commonjs/models/components/marketdetail.js +2 -0
  13. package/dist/commonjs/models/components/marketdetail.js.map +1 -1
  14. package/dist/commonjs/models/components/tokenizedassetclass.d.ts +13 -8
  15. package/dist/commonjs/models/components/tokenizedassetclass.d.ts.map +1 -1
  16. package/dist/commonjs/models/components/tokenizedassetclass.js +7 -4
  17. package/dist/commonjs/models/components/tokenizedassetclass.js.map +1 -1
  18. package/dist/commonjs/models/components/tokenizedassetprovider.d.ts +1 -0
  19. package/dist/commonjs/models/components/tokenizedassetprovider.d.ts.map +1 -1
  20. package/dist/commonjs/models/components/tokenizedassetprovider.js +1 -0
  21. package/dist/commonjs/models/components/tokenizedassetprovider.js.map +1 -1
  22. package/dist/esm/lib/config.d.ts +2 -2
  23. package/dist/esm/lib/config.js +2 -2
  24. package/dist/esm/models/components/compassapibackendv2modelstokenizedassetsmarketmarket.d.ts +10 -4
  25. package/dist/esm/models/components/compassapibackendv2modelstokenizedassetsmarketmarket.d.ts.map +1 -1
  26. package/dist/esm/models/components/compassapibackendv2modelstokenizedassetsmarketmarket.js +2 -0
  27. package/dist/esm/models/components/compassapibackendv2modelstokenizedassetsmarketmarket.js.map +1 -1
  28. package/dist/esm/models/components/compassapibackendv2modelstokenizedassetsreadresponsepositionsposition.d.ts +6 -4
  29. package/dist/esm/models/components/compassapibackendv2modelstokenizedassetsreadresponsepositionsposition.d.ts.map +1 -1
  30. package/dist/esm/models/components/compassapibackendv2modelstokenizedassetsreadresponsepositionsposition.js.map +1 -1
  31. package/dist/esm/models/components/marketdetail.d.ts +10 -4
  32. package/dist/esm/models/components/marketdetail.d.ts.map +1 -1
  33. package/dist/esm/models/components/marketdetail.js +2 -0
  34. package/dist/esm/models/components/marketdetail.js.map +1 -1
  35. package/dist/esm/models/components/tokenizedassetclass.d.ts +13 -8
  36. package/dist/esm/models/components/tokenizedassetclass.d.ts.map +1 -1
  37. package/dist/esm/models/components/tokenizedassetclass.js +7 -4
  38. package/dist/esm/models/components/tokenizedassetclass.js.map +1 -1
  39. package/dist/esm/models/components/tokenizedassetprovider.d.ts +1 -0
  40. package/dist/esm/models/components/tokenizedassetprovider.d.ts.map +1 -1
  41. package/dist/esm/models/components/tokenizedassetprovider.js +1 -0
  42. package/dist/esm/models/components/tokenizedassetprovider.js.map +1 -1
  43. package/docs/models/components/compassapibackendv2modelstokenizedassetsmarketmarket.md +21 -19
  44. package/docs/models/components/compassapibackendv2modelstokenizedassetsreadresponsepositionsposition.md +15 -15
  45. package/docs/models/components/marketdetail.md +33 -31
  46. package/docs/models/components/tokenizedassetclass.md +8 -6
  47. package/docs/models/components/tokenizedassetprovider.md +1 -1
  48. package/openapi_prepped_for_speakeasy.json +23 -3
  49. package/package.json +1 -1
  50. package/src/lib/config.ts +2 -2
  51. package/src/models/components/compassapibackendv2modelstokenizedassetsmarketmarket.ts +12 -4
  52. package/src/models/components/compassapibackendv2modelstokenizedassetsreadresponsepositionsposition.ts +6 -4
  53. package/src/models/components/marketdetail.ts +12 -4
  54. package/src/models/components/tokenizedassetclass.ts +13 -8
  55. package/src/models/components/tokenizedassetprovider.ts +1 -0
@@ -74,10 +74,12 @@ export type MarketDetail = {
74
74
  * @remarks
75
75
  *
76
76
  * `EQUITY` trades via the order endpoints (build/submit/cancel); the RWA
77
- * yield classes (`T_BILLS`, `BASIS_TRADE`, `BTC_YIELD`) and `MANAGED_VAULT`
78
- * trade via the swap-based `transact/buy` and `transact/sell` endpoints.
79
- * `MANAGED_VAULT` (IXS ERC-4626 vaults) is special in that a sell is an
80
- * *asynchronous* redemption request settled off-chain by the vault operator.
77
+ * yield classes (`T_BILLS`, `BASIS_TRADE`, `BTC_YIELD`), `MANAGED_VAULT`, and
78
+ * `DERWA` trade via the swap-based `transact/buy` and `transact/sell`
79
+ * endpoints. `MANAGED_VAULT` (IXS ERC-4626 vaults) is special in that a sell
80
+ * is an *asynchronous* redemption request settled off-chain by the vault
81
+ * operator. `DERWA` (Centrifuge freely-transferable RWA wrappers) settles
82
+ * each buy/sell as a single instant DEX swap.
81
83
  */
82
84
  assetClass: TokenizedAssetClass;
83
85
  /**
@@ -100,6 +102,10 @@ export type MarketDetail = {
100
102
  * Live tradability: whether this market can be traded right now, and if not, why (and when it reopens). Equities follow US market sessions (some are 24-7 via an off-hours track); RWA yield / vault assets trade continuously unless the issuer pauses. Null if status is unavailable.
101
103
  */
102
104
  status?: TradingStatus | null | undefined;
105
+ /**
106
+ * ISO country codes where this asset must not be offered (e.g. ['US']). Regulation-S instruments (Centrifuge deRWA) restrict US persons; the API surfaces the restriction for integrators to enforce — it does not itself geo-gate. Empty for unrestricted assets (Ondo/Midas/IXS).
107
+ */
108
+ restrictedJurisdictions?: Array<string> | undefined;
103
109
  /**
104
110
  * 24h price sparkline as `(timestamp, price)` samples in chronological order.
105
111
  */
@@ -169,6 +175,7 @@ export const MarketDetail$inboundSchema: z.ZodType<
169
175
  apy_30d: z.nullable(z.string()).optional(),
170
176
  tvl_usd: z.nullable(z.string()).optional(),
171
177
  status: z.nullable(TradingStatus$inboundSchema).optional(),
178
+ restricted_jurisdictions: z.array(z.string()).optional(),
172
179
  price_history_24h: z.array(PricePoint$inboundSchema).optional(),
173
180
  price_high_52w: z.nullable(z.string()).optional(),
174
181
  price_low_52w: z.nullable(z.string()).optional(),
@@ -192,6 +199,7 @@ export const MarketDetail$inboundSchema: z.ZodType<
192
199
  "apy_7d": "apy7d",
193
200
  "apy_30d": "apy30d",
194
201
  "tvl_usd": "tvlUsd",
202
+ "restricted_jurisdictions": "restrictedJurisdictions",
195
203
  "price_history_24h": "priceHistory24h",
196
204
  "price_high_52w": "priceHigh52w",
197
205
  "price_low_52w": "priceLow52w",
@@ -11,10 +11,12 @@ import { ClosedEnum } from "../../types/enums.js";
11
11
  * @remarks
12
12
  *
13
13
  * `EQUITY` trades via the order endpoints (build/submit/cancel); the RWA
14
- * yield classes (`T_BILLS`, `BASIS_TRADE`, `BTC_YIELD`) and `MANAGED_VAULT`
15
- * trade via the swap-based `transact/buy` and `transact/sell` endpoints.
16
- * `MANAGED_VAULT` (IXS ERC-4626 vaults) is special in that a sell is an
17
- * *asynchronous* redemption request settled off-chain by the vault operator.
14
+ * yield classes (`T_BILLS`, `BASIS_TRADE`, `BTC_YIELD`), `MANAGED_VAULT`, and
15
+ * `DERWA` trade via the swap-based `transact/buy` and `transact/sell`
16
+ * endpoints. `MANAGED_VAULT` (IXS ERC-4626 vaults) is special in that a sell
17
+ * is an *asynchronous* redemption request settled off-chain by the vault
18
+ * operator. `DERWA` (Centrifuge freely-transferable RWA wrappers) settles
19
+ * each buy/sell as a single instant DEX swap.
18
20
  */
19
21
  export const TokenizedAssetClass = {
20
22
  Equity: "EQUITY",
@@ -22,6 +24,7 @@ export const TokenizedAssetClass = {
22
24
  BasisTrade: "BASIS_TRADE",
23
25
  BtcYield: "BTC_YIELD",
24
26
  ManagedVault: "MANAGED_VAULT",
27
+ Derwa: "DERWA",
25
28
  } as const;
26
29
  /**
27
30
  * Asset class of a tokenized asset.
@@ -29,10 +32,12 @@ export const TokenizedAssetClass = {
29
32
  * @remarks
30
33
  *
31
34
  * `EQUITY` trades via the order endpoints (build/submit/cancel); the RWA
32
- * yield classes (`T_BILLS`, `BASIS_TRADE`, `BTC_YIELD`) and `MANAGED_VAULT`
33
- * trade via the swap-based `transact/buy` and `transact/sell` endpoints.
34
- * `MANAGED_VAULT` (IXS ERC-4626 vaults) is special in that a sell is an
35
- * *asynchronous* redemption request settled off-chain by the vault operator.
35
+ * yield classes (`T_BILLS`, `BASIS_TRADE`, `BTC_YIELD`), `MANAGED_VAULT`, and
36
+ * `DERWA` trade via the swap-based `transact/buy` and `transact/sell`
37
+ * endpoints. `MANAGED_VAULT` (IXS ERC-4626 vaults) is special in that a sell
38
+ * is an *asynchronous* redemption request settled off-chain by the vault
39
+ * operator. `DERWA` (Centrifuge freely-transferable RWA wrappers) settles
40
+ * each buy/sell as a single instant DEX swap.
36
41
  */
37
42
  export type TokenizedAssetClass = ClosedEnum<typeof TokenizedAssetClass>;
38
43
 
@@ -12,6 +12,7 @@ export const TokenizedAssetProvider = {
12
12
  Ondo: "ondo",
13
13
  Midas: "midas",
14
14
  Ixs: "ixs",
15
+ Centrifuge: "centrifuge",
15
16
  } as const;
16
17
  /**
17
18
  * Issuer/provider of a tokenized asset.