@compass-labs/api-sdk 2.2.104 → 2.2.105-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 (159) hide show
  1. package/README.md +3 -13
  2. package/codeSamples_typescript.yaml +0 -18
  3. package/dist/commonjs/models/components/index.d.ts +0 -6
  4. package/dist/commonjs/models/components/index.d.ts.map +1 -1
  5. package/dist/commonjs/models/components/index.js +0 -6
  6. package/dist/commonjs/models/components/index.js.map +1 -1
  7. package/dist/commonjs/models/errors/index.d.ts +0 -1
  8. package/dist/commonjs/models/errors/index.d.ts.map +1 -1
  9. package/dist/commonjs/models/errors/index.js +0 -1
  10. package/dist/commonjs/models/errors/index.js.map +1 -1
  11. package/dist/commonjs/models/operations/index.d.ts +0 -1
  12. package/dist/commonjs/models/operations/index.d.ts.map +1 -1
  13. package/dist/commonjs/models/operations/index.js +0 -1
  14. package/dist/commonjs/models/operations/index.js.map +1 -1
  15. package/dist/commonjs/sdk/sdk.d.ts +0 -3
  16. package/dist/commonjs/sdk/sdk.d.ts.map +1 -1
  17. package/dist/commonjs/sdk/sdk.js +0 -4
  18. package/dist/commonjs/sdk/sdk.js.map +1 -1
  19. package/dist/esm/models/components/index.d.ts +0 -6
  20. package/dist/esm/models/components/index.d.ts.map +1 -1
  21. package/dist/esm/models/components/index.js +0 -6
  22. package/dist/esm/models/components/index.js.map +1 -1
  23. package/dist/esm/models/errors/index.d.ts +0 -1
  24. package/dist/esm/models/errors/index.d.ts.map +1 -1
  25. package/dist/esm/models/errors/index.js +0 -1
  26. package/dist/esm/models/errors/index.js.map +1 -1
  27. package/dist/esm/models/operations/index.d.ts +0 -1
  28. package/dist/esm/models/operations/index.d.ts.map +1 -1
  29. package/dist/esm/models/operations/index.js +0 -1
  30. package/dist/esm/models/operations/index.js.map +1 -1
  31. package/dist/esm/sdk/sdk.d.ts +0 -3
  32. package/dist/esm/sdk/sdk.d.ts.map +1 -1
  33. package/dist/esm/sdk/sdk.js +0 -4
  34. package/dist/esm/sdk/sdk.js.map +1 -1
  35. package/openapi_prepped_for_speakeasy.json +0 -539
  36. package/package.json +1 -1
  37. package/src/models/components/index.ts +0 -6
  38. package/src/models/errors/index.ts +0 -1
  39. package/src/models/operations/index.ts +0 -1
  40. package/src/sdk/sdk.ts +0 -6
  41. package/dist/commonjs/funcs/onrampOnrampCreate.d.ts +0 -38
  42. package/dist/commonjs/funcs/onrampOnrampCreate.d.ts.map +0 -1
  43. package/dist/commonjs/funcs/onrampOnrampCreate.js +0 -139
  44. package/dist/commonjs/funcs/onrampOnrampCreate.js.map +0 -1
  45. package/dist/commonjs/funcs/onrampOnrampQuote.d.ts +0 -27
  46. package/dist/commonjs/funcs/onrampOnrampQuote.d.ts.map +0 -1
  47. package/dist/commonjs/funcs/onrampOnrampQuote.js +0 -128
  48. package/dist/commonjs/funcs/onrampOnrampQuote.js.map +0 -1
  49. package/dist/commonjs/funcs/onrampOnrampStatus.d.ts +0 -31
  50. package/dist/commonjs/funcs/onrampOnrampStatus.d.ts.map +0 -1
  51. package/dist/commonjs/funcs/onrampOnrampStatus.js +0 -135
  52. package/dist/commonjs/funcs/onrampOnrampStatus.js.map +0 -1
  53. package/dist/commonjs/models/components/onrampcreate.d.ts +0 -59
  54. package/dist/commonjs/models/components/onrampcreate.d.ts.map +0 -1
  55. package/dist/commonjs/models/components/onrampcreate.js +0 -75
  56. package/dist/commonjs/models/components/onrampcreate.js.map +0 -1
  57. package/dist/commonjs/models/components/onrampcreaterequest.d.ts +0 -40
  58. package/dist/commonjs/models/components/onrampcreaterequest.d.ts.map +0 -1
  59. package/dist/commonjs/models/components/onrampcreaterequest.js +0 -60
  60. package/dist/commonjs/models/components/onrampcreaterequest.js.map +0 -1
  61. package/dist/commonjs/models/components/onrampfees.d.ts +0 -29
  62. package/dist/commonjs/models/components/onrampfees.d.ts.map +0 -1
  63. package/dist/commonjs/models/components/onrampfees.js +0 -59
  64. package/dist/commonjs/models/components/onrampfees.js.map +0 -1
  65. package/dist/commonjs/models/components/onrampquote.d.ts +0 -58
  66. package/dist/commonjs/models/components/onrampquote.d.ts.map +0 -1
  67. package/dist/commonjs/models/components/onrampquote.js +0 -73
  68. package/dist/commonjs/models/components/onrampquote.js.map +0 -1
  69. package/dist/commonjs/models/components/onrampquoterequest.d.ts +0 -34
  70. package/dist/commonjs/models/components/onrampquoterequest.d.ts.map +0 -1
  71. package/dist/commonjs/models/components/onrampquoterequest.js +0 -58
  72. package/dist/commonjs/models/components/onrampquoterequest.js.map +0 -1
  73. package/dist/commonjs/models/components/onrampstatus.d.ts +0 -57
  74. package/dist/commonjs/models/components/onrampstatus.d.ts.map +0 -1
  75. package/dist/commonjs/models/components/onrampstatus.js +0 -75
  76. package/dist/commonjs/models/components/onrampstatus.js.map +0 -1
  77. package/dist/commonjs/models/errors/onramperrorresponse.d.ts +0 -44
  78. package/dist/commonjs/models/errors/onramperrorresponse.d.ts.map +0 -1
  79. package/dist/commonjs/models/errors/onramperrorresponse.js +0 -75
  80. package/dist/commonjs/models/errors/onramperrorresponse.js.map +0 -1
  81. package/dist/commonjs/models/operations/v2onrampstatus.d.ts +0 -15
  82. package/dist/commonjs/models/operations/v2onrampstatus.d.ts.map +0 -1
  83. package/dist/commonjs/models/operations/v2onrampstatus.js +0 -54
  84. package/dist/commonjs/models/operations/v2onrampstatus.js.map +0 -1
  85. package/dist/commonjs/sdk/onramp.d.ts +0 -68
  86. package/dist/commonjs/sdk/onramp.d.ts.map +0 -1
  87. package/dist/commonjs/sdk/onramp.js +0 -83
  88. package/dist/commonjs/sdk/onramp.js.map +0 -1
  89. package/dist/esm/funcs/onrampOnrampCreate.d.ts +0 -38
  90. package/dist/esm/funcs/onrampOnrampCreate.d.ts.map +0 -1
  91. package/dist/esm/funcs/onrampOnrampCreate.js +0 -103
  92. package/dist/esm/funcs/onrampOnrampCreate.js.map +0 -1
  93. package/dist/esm/funcs/onrampOnrampQuote.d.ts +0 -27
  94. package/dist/esm/funcs/onrampOnrampQuote.d.ts.map +0 -1
  95. package/dist/esm/funcs/onrampOnrampQuote.js +0 -92
  96. package/dist/esm/funcs/onrampOnrampQuote.js.map +0 -1
  97. package/dist/esm/funcs/onrampOnrampStatus.d.ts +0 -31
  98. package/dist/esm/funcs/onrampOnrampStatus.d.ts.map +0 -1
  99. package/dist/esm/funcs/onrampOnrampStatus.js +0 -99
  100. package/dist/esm/funcs/onrampOnrampStatus.js.map +0 -1
  101. package/dist/esm/models/components/onrampcreate.d.ts +0 -59
  102. package/dist/esm/models/components/onrampcreate.d.ts.map +0 -1
  103. package/dist/esm/models/components/onrampcreate.js +0 -38
  104. package/dist/esm/models/components/onrampcreate.js.map +0 -1
  105. package/dist/esm/models/components/onrampcreaterequest.d.ts +0 -40
  106. package/dist/esm/models/components/onrampcreaterequest.d.ts.map +0 -1
  107. package/dist/esm/models/components/onrampcreaterequest.js +0 -23
  108. package/dist/esm/models/components/onrampcreaterequest.js.map +0 -1
  109. package/dist/esm/models/components/onrampfees.d.ts +0 -29
  110. package/dist/esm/models/components/onrampfees.d.ts.map +0 -1
  111. package/dist/esm/models/components/onrampfees.js +0 -22
  112. package/dist/esm/models/components/onrampfees.js.map +0 -1
  113. package/dist/esm/models/components/onrampquote.d.ts +0 -58
  114. package/dist/esm/models/components/onrampquote.d.ts.map +0 -1
  115. package/dist/esm/models/components/onrampquote.js +0 -36
  116. package/dist/esm/models/components/onrampquote.js.map +0 -1
  117. package/dist/esm/models/components/onrampquoterequest.d.ts +0 -34
  118. package/dist/esm/models/components/onrampquoterequest.d.ts.map +0 -1
  119. package/dist/esm/models/components/onrampquoterequest.js +0 -21
  120. package/dist/esm/models/components/onrampquoterequest.js.map +0 -1
  121. package/dist/esm/models/components/onrampstatus.d.ts +0 -57
  122. package/dist/esm/models/components/onrampstatus.d.ts.map +0 -1
  123. package/dist/esm/models/components/onrampstatus.js +0 -38
  124. package/dist/esm/models/components/onrampstatus.js.map +0 -1
  125. package/dist/esm/models/errors/onramperrorresponse.d.ts +0 -44
  126. package/dist/esm/models/errors/onramperrorresponse.d.ts.map +0 -1
  127. package/dist/esm/models/errors/onramperrorresponse.js +0 -38
  128. package/dist/esm/models/errors/onramperrorresponse.js.map +0 -1
  129. package/dist/esm/models/operations/v2onrampstatus.d.ts +0 -15
  130. package/dist/esm/models/operations/v2onrampstatus.d.ts.map +0 -1
  131. package/dist/esm/models/operations/v2onrampstatus.js +0 -17
  132. package/dist/esm/models/operations/v2onrampstatus.js.map +0 -1
  133. package/dist/esm/sdk/onramp.d.ts +0 -68
  134. package/dist/esm/sdk/onramp.d.ts.map +0 -1
  135. package/dist/esm/sdk/onramp.js +0 -79
  136. package/dist/esm/sdk/onramp.js.map +0 -1
  137. package/docs/models/components/onrampcreate.md +0 -43
  138. package/docs/models/components/onrampcreaterequest.md +0 -29
  139. package/docs/models/components/onrampcreatestatus.md +0 -17
  140. package/docs/models/components/onrampfees.md +0 -26
  141. package/docs/models/components/onrampquote.md +0 -36
  142. package/docs/models/components/onrampquoterequest.md +0 -27
  143. package/docs/models/components/onrampstatus.md +0 -28
  144. package/docs/models/components/onrampstatusstatus.md +0 -17
  145. package/docs/models/errors/onramperrorresponse.md +0 -21
  146. package/docs/models/operations/v2onrampstatusrequest.md +0 -17
  147. package/docs/sdks/onramp/README.md +0 -283
  148. package/src/funcs/onrampOnrampCreate.ts +0 -192
  149. package/src/funcs/onrampOnrampQuote.ts +0 -181
  150. package/src/funcs/onrampOnrampStatus.ts +0 -189
  151. package/src/models/components/onrampcreate.ts +0 -97
  152. package/src/models/components/onrampcreaterequest.ts +0 -70
  153. package/src/models/components/onrampfees.ts +0 -59
  154. package/src/models/components/onrampquote.ts +0 -101
  155. package/src/models/components/onrampquoterequest.ts +0 -62
  156. package/src/models/components/onrampstatus.ts +0 -96
  157. package/src/models/errors/onramperrorresponse.ts +0 -75
  158. package/src/models/operations/v2onrampstatus.ts +0 -39
  159. package/src/sdk/onramp.ts +0 -105
@@ -8577,218 +8577,6 @@
8577
8577
  },
8578
8578
  "x-speakeasy-name-override": "tokenized_assets_transact_sell"
8579
8579
  }
8580
- },
8581
- "/v2/onramp/quote": {
8582
- "post": {
8583
- "tags": [
8584
- "Onramp"
8585
- ],
8586
- "summary": "Get a fiat on-ramp quote (card -> USDC on Ethereum)",
8587
- "description": "Get an indicative quote for buying USDC on Ethereum with a card.\n\nReturns the estimated USDC the user will receive for a given fiat amount,\nthe exchange rate, fee breakdown (`business_fees` is `0`), and the provider\nmin/max limits. The output is always **USDC on Ethereum** delivered to the\n`destination_address` \u2014 this is a non-custodial on-ramp, so Compass never\nholds the funds.\n\nThis quote is indicative and may expire (`expires_at`). To actually start a\npayment, call `POST /v2/onramp/create`.",
8588
- "operationId": "v2_onramp_quote",
8589
- "requestBody": {
8590
- "content": {
8591
- "application/json": {
8592
- "schema": {
8593
- "$ref": "#/components/schemas/OnrampQuoteRequest"
8594
- }
8595
- }
8596
- },
8597
- "required": true
8598
- },
8599
- "responses": {
8600
- "200": {
8601
- "description": "Successful Response",
8602
- "content": {
8603
- "application/json": {
8604
- "schema": {
8605
- "$ref": "#/components/schemas/OnrampQuote"
8606
- }
8607
- }
8608
- }
8609
- },
8610
- "400": {
8611
- "description": "`INVALID_ONRAMP_REQUEST` \u2014 bad fiat amount or unsupported currency.",
8612
- "content": {
8613
- "application/json": {
8614
- "schema": {
8615
- "$ref": "#/components/schemas/OnrampErrorResponse"
8616
- }
8617
- }
8618
- }
8619
- },
8620
- "422": {
8621
- "description": "`UNSUPPORTED_ONRAMP_OUTPUT` \u2014 delivery is limited to USDC on Ethereum.",
8622
- "content": {
8623
- "application/json": {
8624
- "schema": {
8625
- "$ref": "#/components/schemas/OnrampErrorResponse"
8626
- }
8627
- }
8628
- }
8629
- },
8630
- "502": {
8631
- "description": "`HALLIDAY_API_UNAVAILABLE` \u2014 the on-ramp provider is unavailable.",
8632
- "content": {
8633
- "application/json": {
8634
- "schema": {
8635
- "$ref": "#/components/schemas/OnrampErrorResponse"
8636
- }
8637
- }
8638
- }
8639
- }
8640
- },
8641
- "x-speakeasy-name-override": "onramp_quote"
8642
- }
8643
- },
8644
- "/v2/onramp/create": {
8645
- "post": {
8646
- "tags": [
8647
- "Onramp"
8648
- ],
8649
- "summary": "Create a fiat on-ramp payment + get the checkout link",
8650
- "description": "Create a fiat on-ramp payment and return the browser-checkout handoff.\n\nA fiat card + identity-verification flow can only render in a browser, so\nthis endpoint returns a **`checkout_url`** (a Compass-hosted page) together\nwith `payment_id`, the one-time-wallet `deposit_address`, an initial\n`status`, and a `user_instructions` string.\n\n**How to drive this (CLI / MCP agent / UI):**\n\n1. **Present `checkout_url` to the user and open it in a browser.** It\n renders the card payment + identity verification and delivers USDC on\n Ethereum to the destination wallet. (An MCP agent cannot open a browser\n itself \u2014 show the link and ask the user to open it.)\n2. **Poll `GET /v2/onramp/status?payment_id=...`** until `status` becomes\n `delivered` (or `failed`). `pending` = awaiting payment, `processing` =\n payment received and bridging/swapping to USDC.\n3. Once `delivered`, the USDC is in the user's own wallet \u2014 continue with\n the tokenized buy.\n\nFunds are never held by Compass: the `deposit_address` is a one-time wallet\nowned solely by the user's wallet.",
8651
- "operationId": "v2_onramp_create",
8652
- "requestBody": {
8653
- "content": {
8654
- "application/json": {
8655
- "schema": {
8656
- "$ref": "#/components/schemas/OnrampCreateRequest"
8657
- }
8658
- }
8659
- },
8660
- "required": true
8661
- },
8662
- "responses": {
8663
- "200": {
8664
- "description": "Successful Response",
8665
- "content": {
8666
- "application/json": {
8667
- "schema": {
8668
- "$ref": "#/components/schemas/OnrampCreate"
8669
- }
8670
- }
8671
- }
8672
- },
8673
- "400": {
8674
- "description": "`INVALID_ONRAMP_REQUEST` \u2014 bad fiat amount or unsupported currency.",
8675
- "content": {
8676
- "application/json": {
8677
- "schema": {
8678
- "$ref": "#/components/schemas/OnrampErrorResponse"
8679
- }
8680
- }
8681
- }
8682
- },
8683
- "402": {
8684
- "description": "`KYC_REQUIRED` \u2014 identity verification is required; complete it in the hosted checkout (`checkout_url`).",
8685
- "content": {
8686
- "application/json": {
8687
- "schema": {
8688
- "$ref": "#/components/schemas/OnrampErrorResponse"
8689
- }
8690
- }
8691
- }
8692
- },
8693
- "410": {
8694
- "description": "`QUOTE_EXPIRED` \u2014 the quote is stale; re-quote and retry.",
8695
- "content": {
8696
- "application/json": {
8697
- "schema": {
8698
- "$ref": "#/components/schemas/OnrampErrorResponse"
8699
- }
8700
- }
8701
- }
8702
- },
8703
- "422": {
8704
- "description": "`UNSUPPORTED_ONRAMP_OUTPUT` \u2014 delivery is limited to USDC on Ethereum.",
8705
- "content": {
8706
- "application/json": {
8707
- "schema": {
8708
- "$ref": "#/components/schemas/OnrampErrorResponse"
8709
- }
8710
- }
8711
- }
8712
- },
8713
- "502": {
8714
- "description": "`HALLIDAY_API_UNAVAILABLE` \u2014 the on-ramp provider is unavailable.",
8715
- "content": {
8716
- "application/json": {
8717
- "schema": {
8718
- "$ref": "#/components/schemas/OnrampErrorResponse"
8719
- }
8720
- }
8721
- }
8722
- }
8723
- },
8724
- "x-speakeasy-name-override": "onramp_create"
8725
- }
8726
- },
8727
- "/v2/onramp/status": {
8728
- "get": {
8729
- "tags": [
8730
- "Onramp"
8731
- ],
8732
- "summary": "Get the status of a fiat on-ramp payment",
8733
- "description": "Get the current status of a fiat on-ramp payment.\n\nPoll this after `create` until `status` is `delivered`. The `status` field\nis one of:\n\n- `pending` \u2014 awaiting the card payment in the hosted checkout.\n- `processing` \u2014 payment received; bridging/swapping the proceeds to USDC.\n- `delivered` \u2014 USDC has been delivered to the destination wallet\n (`delivery_tx_hash` and `output_amount_delivered` are populated).\n- `failed` \u2014 the payment failed, expired, or was refunded.\n\nState is re-read live from the on-ramp provider on every call \u2014 Compass\nstores nothing of its own.",
8734
- "operationId": "v2_onramp_status",
8735
- "parameters": [
8736
- {
8737
- "name": "payment_id",
8738
- "in": "query",
8739
- "required": true,
8740
- "schema": {
8741
- "type": "string",
8742
- "description": "The `payment_id` returned by `POST /v2/onramp/create`.",
8743
- "title": "Payment Id"
8744
- },
8745
- "description": "The `payment_id` returned by `POST /v2/onramp/create`."
8746
- }
8747
- ],
8748
- "responses": {
8749
- "200": {
8750
- "description": "Successful Response",
8751
- "content": {
8752
- "application/json": {
8753
- "schema": {
8754
- "$ref": "#/components/schemas/OnrampStatus"
8755
- }
8756
- }
8757
- }
8758
- },
8759
- "404": {
8760
- "description": "`PAYMENT_NOT_FOUND` \u2014 no payment matches the provided id.",
8761
- "content": {
8762
- "application/json": {
8763
- "schema": {
8764
- "$ref": "#/components/schemas/OnrampErrorResponse"
8765
- }
8766
- }
8767
- }
8768
- },
8769
- "422": {
8770
- "description": "`UNSUPPORTED_ONRAMP_OUTPUT` \u2014 delivery is limited to USDC on Ethereum.",
8771
- "content": {
8772
- "application/json": {
8773
- "schema": {
8774
- "$ref": "#/components/schemas/OnrampErrorResponse"
8775
- }
8776
- }
8777
- }
8778
- },
8779
- "502": {
8780
- "description": "`HALLIDAY_API_UNAVAILABLE` \u2014 the on-ramp provider is unavailable.",
8781
- "content": {
8782
- "application/json": {
8783
- "schema": {
8784
- "$ref": "#/components/schemas/OnrampErrorResponse"
8785
- }
8786
- }
8787
- }
8788
- }
8789
- },
8790
- "x-speakeasy-name-override": "onramp_status"
8791
- }
8792
8580
  }
8793
8581
  },
8794
8582
  "components": {
@@ -19990,333 +19778,6 @@
19990
19778
  "title": "OneInchSwapParams",
19991
19779
  "description": "Parameters for 1inch swap operations."
19992
19780
  },
19993
- "OnrampCreate": {
19994
- "properties": {
19995
- "payment_id": {
19996
- "type": "string",
19997
- "title": "Payment Id",
19998
- "description": "Halliday's payment id. Use it to poll status."
19999
- },
20000
- "deposit_address": {
20001
- "type": "string",
20002
- "title": "Deposit Address",
20003
- "description": "The one-time-wallet (OTW) deposit address for this payment, owned solely by the user's wallet (non-custodial)."
20004
- },
20005
- "checkout_url": {
20006
- "type": "string",
20007
- "title": "Checkout Url",
20008
- "description": "Compass-hosted checkout page to open in a browser. It renders the card + identity-verification flow and delivers USDC to the destination wallet."
20009
- },
20010
- "user_instructions": {
20011
- "type": "string",
20012
- "title": "User Instructions",
20013
- "description": "Short, agent-actionable guidance: open the checkout link, pay, then poll status until delivered."
20014
- },
20015
- "status": {
20016
- "type": "string",
20017
- "enum": [
20018
- "pending",
20019
- "processing",
20020
- "delivered",
20021
- "failed"
20022
- ],
20023
- "title": "Status",
20024
- "description": "Initial lifecycle state (typically `pending`)."
20025
- },
20026
- "quote": {
20027
- "$ref": "#/components/schemas/OnrampQuote",
20028
- "description": "The resolved quote this payment was created against."
20029
- }
20030
- },
20031
- "type": "object",
20032
- "required": [
20033
- "payment_id",
20034
- "deposit_address",
20035
- "checkout_url",
20036
- "user_instructions",
20037
- "status",
20038
- "quote"
20039
- ],
20040
- "title": "OnrampCreate",
20041
- "description": "A created on-ramp payment, with the browser-handoff affordances.\n\nThe caller (CLI / MCP agent / UI) presents ``checkout_url`` to the user to\npay by card and complete identity verification, then polls\n``GET /v2/onramp/status`` until ``status`` is ``delivered``."
20042
- },
20043
- "OnrampCreateRequest": {
20044
- "properties": {
20045
- "fiat_amount": {
20046
- "type": "string",
20047
- "title": "Fiat Amount",
20048
- "description": "Amount of fiat to spend, as a decimal string (e.g. `100`)."
20049
- },
20050
- "fiat_currency": {
20051
- "type": "string",
20052
- "title": "Fiat Currency",
20053
- "description": "ISO-4217 fiat currency code. Defaults to `USD`.",
20054
- "example": "USD"
20055
- },
20056
- "destination_address": {
20057
- "type": "string",
20058
- "title": "Destination Address",
20059
- "description": "The wallet that will receive the USDC on Ethereum. Funds are delivered here directly \u2014 Compass never holds them."
20060
- },
20061
- "quote_id": {
20062
- "anyOf": [
20063
- {
20064
- "type": "string"
20065
- },
20066
- {
20067
- "type": "null"
20068
- }
20069
- ],
20070
- "title": "Quote Id",
20071
- "description": "Optional Halliday quote handle to confirm against. Omit to confirm against a fresh quote derived from the amount and currency."
20072
- }
20073
- },
20074
- "type": "object",
20075
- "required": [
20076
- "fiat_amount",
20077
- "destination_address"
20078
- ],
20079
- "title": "OnrampCreateRequest",
20080
- "description": "Create a fiat on-ramp payment delivering USDC on Ethereum.\n\nCarries the same fields as the quote (a quote is implicit \u2014 we do not\npersist a quote handle). ``quote_id`` is optional and only echoed upstream\nif Halliday's ``/payments/confirm`` requires a previously-issued quote\nhandle; omit it to confirm against a fresh quote."
20081
- },
20082
- "OnrampErrorResponse": {
20083
- "properties": {
20084
- "error": {
20085
- "type": "string",
20086
- "title": "Error",
20087
- "description": "Short human-readable error label (e.g. `Payment not found.`, `On-ramp provider unavailable`, `Identity verification required`)."
20088
- },
20089
- "message": {
20090
- "type": "string",
20091
- "title": "Message",
20092
- "description": "Human-readable explanation."
20093
- }
20094
- },
20095
- "type": "object",
20096
- "required": [
20097
- "error",
20098
- "message"
20099
- ],
20100
- "title": "OnrampErrorResponse",
20101
- "description": "Standard error envelope returned by every non-2xx on-ramp response.\n\nSurfaced in OpenAPI ``responses`` declarations so SDK consumers can decode\nfailures uniformly without inspecting per-status-code shapes."
20102
- },
20103
- "OnrampFees": {
20104
- "properties": {
20105
- "provider_fee": {
20106
- "type": "string",
20107
- "title": "Provider Fee",
20108
- "description": "Fee charged by the on-ramp provider, in fiat."
20109
- },
20110
- "network_fee": {
20111
- "type": "string",
20112
- "title": "Network Fee",
20113
- "description": "Estimated network/gas fee, in fiat."
20114
- },
20115
- "business_fees": {
20116
- "type": "string",
20117
- "title": "Business Fees",
20118
- "description": "Compass business fee, in fiat. Always `0` for now.",
20119
- "example": "0"
20120
- }
20121
- },
20122
- "type": "object",
20123
- "required": [
20124
- "provider_fee",
20125
- "network_fee"
20126
- ],
20127
- "title": "OnrampFees",
20128
- "description": "Fee breakdown for an on-ramp quote.\n\n``business_fees`` is a fixed ``\"0\"`` for now \u2014 monetization is a single\nfuture lever and is intentionally not charged."
20129
- },
20130
- "OnrampQuote": {
20131
- "properties": {
20132
- "fiat_amount": {
20133
- "type": "string",
20134
- "title": "Fiat Amount",
20135
- "description": "Fiat amount to spend."
20136
- },
20137
- "fiat_currency": {
20138
- "type": "string",
20139
- "title": "Fiat Currency",
20140
- "description": "ISO-4217 fiat currency code."
20141
- },
20142
- "output_amount": {
20143
- "type": "string",
20144
- "title": "Output Amount",
20145
- "description": "Estimated USDC delivered, human-readable (6-decimal token)."
20146
- },
20147
- "output_asset": {
20148
- "type": "string",
20149
- "const": "USDC",
20150
- "title": "Output Asset",
20151
- "description": "Delivered asset. Always USDC for this on-ramp.",
20152
- "example": "USDC"
20153
- },
20154
- "output_chain": {
20155
- "type": "string",
20156
- "const": "ethereum",
20157
- "title": "Output Chain",
20158
- "description": "Delivery chain. Always Ethereum for this on-ramp.",
20159
- "example": "ethereum"
20160
- },
20161
- "exchange_rate": {
20162
- "type": "string",
20163
- "title": "Exchange Rate",
20164
- "description": "USDC received per unit of fiat."
20165
- },
20166
- "fees": {
20167
- "$ref": "#/components/schemas/OnrampFees",
20168
- "description": "Fee breakdown."
20169
- },
20170
- "min_amount": {
20171
- "anyOf": [
20172
- {
20173
- "type": "string"
20174
- },
20175
- {
20176
- "type": "null"
20177
- }
20178
- ],
20179
- "title": "Min Amount",
20180
- "description": "Minimum fiat amount accepted, if advertised by the provider."
20181
- },
20182
- "max_amount": {
20183
- "anyOf": [
20184
- {
20185
- "type": "string"
20186
- },
20187
- {
20188
- "type": "null"
20189
- }
20190
- ],
20191
- "title": "Max Amount",
20192
- "description": "Maximum fiat amount accepted, if advertised by the provider."
20193
- },
20194
- "expires_at": {
20195
- "anyOf": [
20196
- {
20197
- "type": "string"
20198
- },
20199
- {
20200
- "type": "null"
20201
- }
20202
- ],
20203
- "title": "Expires At",
20204
- "description": "ISO-8601 timestamp after which this quote is stale, if any."
20205
- }
20206
- },
20207
- "type": "object",
20208
- "required": [
20209
- "fiat_amount",
20210
- "fiat_currency",
20211
- "output_amount",
20212
- "exchange_rate",
20213
- "fees"
20214
- ],
20215
- "title": "OnrampQuote",
20216
- "description": "An indicative fiat -> USDC-on-Ethereum quote."
20217
- },
20218
- "OnrampQuoteRequest": {
20219
- "properties": {
20220
- "fiat_amount": {
20221
- "type": "string",
20222
- "title": "Fiat Amount",
20223
- "description": "Amount of fiat to spend, as a decimal string (e.g. `100`)."
20224
- },
20225
- "fiat_currency": {
20226
- "type": "string",
20227
- "title": "Fiat Currency",
20228
- "description": "ISO-4217 fiat currency code. Defaults to `USD`.",
20229
- "example": "USD"
20230
- },
20231
- "destination_address": {
20232
- "type": "string",
20233
- "title": "Destination Address",
20234
- "description": "The wallet that will receive the USDC on Ethereum. Funds are delivered here directly \u2014 Compass never holds them."
20235
- }
20236
- },
20237
- "type": "object",
20238
- "required": [
20239
- "fiat_amount",
20240
- "destination_address"
20241
- ],
20242
- "title": "OnrampQuoteRequest",
20243
- "description": "An indicative fiat -> USDC-on-Ethereum quote request.\n\nThe output asset and chain are fixed to USDC on Ethereum and are not\nuser-supplied \u2014 this product group delivers only USDC to the user's own\nwallet (non-custodial)."
20244
- },
20245
- "OnrampStatus": {
20246
- "properties": {
20247
- "payment_id": {
20248
- "type": "string",
20249
- "title": "Payment Id",
20250
- "description": "Halliday's payment id, echoed straight through."
20251
- },
20252
- "status": {
20253
- "type": "string",
20254
- "enum": [
20255
- "pending",
20256
- "processing",
20257
- "delivered",
20258
- "failed"
20259
- ],
20260
- "title": "Status",
20261
- "description": "Lifecycle state: `pending` (awaiting card payment), `processing` (payment received, bridging/swapping to USDC), `delivered` (USDC received in the destination wallet), or `failed`."
20262
- },
20263
- "output_amount_delivered": {
20264
- "anyOf": [
20265
- {
20266
- "type": "string"
20267
- },
20268
- {
20269
- "type": "null"
20270
- }
20271
- ],
20272
- "title": "Output Amount Delivered",
20273
- "description": "USDC delivered so far, human-readable. Set once delivered."
20274
- },
20275
- "delivery_tx_hash": {
20276
- "anyOf": [
20277
- {
20278
- "type": "string"
20279
- },
20280
- {
20281
- "type": "null"
20282
- }
20283
- ],
20284
- "title": "Delivery Tx Hash",
20285
- "description": "Ethereum tx hash of the USDC delivery, once available."
20286
- },
20287
- "destination_address": {
20288
- "anyOf": [
20289
- {
20290
- "type": "string"
20291
- },
20292
- {
20293
- "type": "null"
20294
- }
20295
- ],
20296
- "title": "Destination Address",
20297
- "description": "The wallet the USDC is delivered to."
20298
- },
20299
- "updated_at": {
20300
- "anyOf": [
20301
- {
20302
- "type": "string"
20303
- },
20304
- {
20305
- "type": "null"
20306
- }
20307
- ],
20308
- "title": "Updated At",
20309
- "description": "ISO-8601 timestamp of the last status change, if provided."
20310
- }
20311
- },
20312
- "type": "object",
20313
- "required": [
20314
- "payment_id",
20315
- "status"
20316
- ],
20317
- "title": "OnrampStatus",
20318
- "description": "Current state of a fiat on-ramp payment.\n\nRe-read on demand from Halliday (the system of record) \u2014 Compass holds no\nstate of its own."
20319
- },
20320
19781
  "OpenPosition": {
20321
19782
  "properties": {
20322
19783
  "marketId": {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@compass-labs/api-sdk",
3
- "version": "2.2.104",
3
+ "version": "2.2.105-rc.0",
4
4
  "author": "royalnine",
5
5
  "type": "module",
6
6
  "tshy": {
@@ -208,12 +208,6 @@ export * from "./odosswaprequest.js";
208
208
  export * from "./odostransactionresponse.js";
209
209
  export * from "./ohlccandle.js";
210
210
  export * from "./oneinchswapparams.js";
211
- export * from "./onrampcreate.js";
212
- export * from "./onrampcreaterequest.js";
213
- export * from "./onrampfees.js";
214
- export * from "./onrampquote.js";
215
- export * from "./onrampquoterequest.js";
216
- export * from "./onrampstatus.js";
217
211
  export * from "./openposition.js";
218
212
  export * from "./operationtype.js";
219
213
  export * from "./orderstatus.js";
@@ -7,7 +7,6 @@ export * from "./compassapisdkerror.js";
7
7
  export * from "./httpclienterrors.js";
8
8
  export * from "./httpvalidationerror.js";
9
9
  export * from "./mintpreparenotfoundresponseerror.js";
10
- export * from "./onramperrorresponse.js";
11
10
  export * from "./responsevalidationerror.js";
12
11
  export * from "./sdkvalidationerror.js";
13
12
  export * from "./tokenizedassetserrorresponse.js";
@@ -53,7 +53,6 @@ export * from "./v2earnpositions.js";
53
53
  export * from "./v2earnpositionsall.js";
54
54
  export * from "./v2earnswapquote.js";
55
55
  export * from "./v2earnvaults.js";
56
- export * from "./v2onrampstatus.js";
57
56
  export * from "./v2perpetualtradingactivity.js";
58
57
  export * from "./v2perpetualtradingcandles.js";
59
58
  export * from "./v2perpetualtradingopportunities.js";
package/src/sdk/sdk.ts CHANGED
@@ -12,7 +12,6 @@ import { Erc4626Vaults } from "./erc4626vaults.js";
12
12
  import { Ethena } from "./ethena.js";
13
13
  import { GasSponsorship } from "./gassponsorship.js";
14
14
  import { Morpho } from "./morpho.js";
15
- import { Onramp } from "./onramp.js";
16
15
  import { Pendle } from "./pendle.js";
17
16
  import { PerpetualTrading } from "./perpetualtrading.js";
18
17
  import { Sky } from "./sky.js";
@@ -127,9 +126,4 @@ export class CompassApiSDK extends ClientSDK {
127
126
  get tokenizedAssets(): TokenizedAssets {
128
127
  return (this._tokenizedAssets ??= new TokenizedAssets(this._options));
129
128
  }
130
-
131
- private _onramp?: Onramp;
132
- get onramp(): Onramp {
133
- return (this._onramp ??= new Onramp(this._options));
134
- }
135
129
  }
@@ -1,38 +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 { APIPromise } from "../types/async.js";
10
- import { Result } from "../types/fp.js";
11
- /**
12
- * Create a fiat on-ramp payment + get the checkout link
13
- *
14
- * @remarks
15
- * Create a fiat on-ramp payment and return the browser-checkout handoff.
16
- *
17
- * A fiat card + identity-verification flow can only render in a browser, so
18
- * this endpoint returns a **`checkout_url`** (a Compass-hosted page) together
19
- * with `payment_id`, the one-time-wallet `deposit_address`, an initial
20
- * `status`, and a `user_instructions` string.
21
- *
22
- * **How to drive this (CLI / MCP agent / UI):**
23
- *
24
- * 1. **Present `checkout_url` to the user and open it in a browser.** It
25
- * renders the card payment + identity verification and delivers USDC on
26
- * Ethereum to the destination wallet. (An MCP agent cannot open a browser
27
- * itself — show the link and ask the user to open it.)
28
- * 2. **Poll `GET /v2/onramp/status?payment_id=...`** until `status` becomes
29
- * `delivered` (or `failed`). `pending` = awaiting payment, `processing` =
30
- * payment received and bridging/swapping to USDC.
31
- * 3. Once `delivered`, the USDC is in the user's own wallet — continue with
32
- * the tokenized buy.
33
- *
34
- * Funds are never held by Compass: the `deposit_address` is a one-time wallet
35
- * owned solely by the user's wallet.
36
- */
37
- export declare function onrampOnrampCreate(client: CompassApiSDKCore, request: components.OnrampCreateRequest, options?: RequestOptions): APIPromise<Result<components.OnrampCreate, errors.OnrampErrorResponse | CompassAPISDKError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError>>;
38
- //# sourceMappingURL=onrampOnrampCreate.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"onrampOnrampCreate.d.ts","sourceRoot":"","sources":["../../../src/funcs/onrampOnrampCreate.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,EAAW,UAAU,EAAE,MAAM,mBAAmB,CAAC;AACxD,OAAO,EAAE,MAAM,EAAE,MAAM,gBAAgB,CAAC;AAExC;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,wBAAgB,kBAAkB,CAChC,MAAM,EAAE,iBAAiB,EACzB,OAAO,EAAE,UAAU,CAAC,mBAAmB,EACvC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CACX,MAAM,CACJ,UAAU,CAAC,YAAY,EACrB,MAAM,CAAC,mBAAmB,GAC1B,kBAAkB,GAClB,uBAAuB,GACvB,eAAe,GACf,mBAAmB,GACnB,mBAAmB,GACnB,mBAAmB,GACnB,qBAAqB,GACrB,kBAAkB,CACrB,CACF,CAMA"}