@paxosglobal/sdk 0.0.0-stage → 0.1.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 (212) hide show
  1. package/AGENTS.md +268 -0
  2. package/CHANGELOG.md +35 -0
  3. package/LICENSE +191 -0
  4. package/README.md +445 -2
  5. package/dist/auth.d.ts +60 -0
  6. package/dist/auth.js +248 -0
  7. package/dist/auth.js.map +1 -0
  8. package/dist/client.d.ts +353 -0
  9. package/dist/client.js +967 -0
  10. package/dist/client.js.map +1 -0
  11. package/dist/constants.d.ts +16 -0
  12. package/dist/constants.js +17 -0
  13. package/dist/constants.js.map +1 -0
  14. package/dist/decimal-fields.d.ts +16 -0
  15. package/dist/decimal-fields.js +570 -0
  16. package/dist/decimal-fields.js.map +1 -0
  17. package/dist/decimal.d.ts +25 -0
  18. package/dist/decimal.js +93 -0
  19. package/dist/decimal.js.map +1 -0
  20. package/dist/decode.d.ts +34 -0
  21. package/dist/decode.js +118 -0
  22. package/dist/decode.js.map +1 -0
  23. package/dist/enums.d.ts +1080 -0
  24. package/dist/enums.js +1031 -0
  25. package/dist/enums.js.map +1 -0
  26. package/dist/errors.d.ts +142 -0
  27. package/dist/errors.js +261 -0
  28. package/dist/errors.js.map +1 -0
  29. package/dist/generated-types.d.ts +13629 -0
  30. package/dist/generated-types.js +3 -0
  31. package/dist/generated-types.js.map +1 -0
  32. package/dist/index.d.ts +32 -0
  33. package/dist/index.js +31 -0
  34. package/dist/index.js.map +1 -0
  35. package/dist/models.d.ts +299 -0
  36. package/dist/models.js +3 -0
  37. package/dist/models.js.map +1 -0
  38. package/dist/paxos-client.d.ts +107 -0
  39. package/dist/paxos-client.js +157 -0
  40. package/dist/paxos-client.js.map +1 -0
  41. package/dist/query-keys.d.ts +1 -0
  42. package/dist/query-keys.js +31 -0
  43. package/dist/query-keys.js.map +1 -0
  44. package/dist/response-defaults.d.ts +2 -0
  45. package/dist/response-defaults.js +109 -0
  46. package/dist/response-defaults.js.map +1 -0
  47. package/dist/services/account-members.d.ts +32 -0
  48. package/dist/services/account-members.js +46 -0
  49. package/dist/services/account-members.js.map +1 -0
  50. package/dist/services/accounts.d.ts +74 -0
  51. package/dist/services/accounts.js +71 -0
  52. package/dist/services/accounts.js.map +1 -0
  53. package/dist/services/address-verification.d.ts +72 -0
  54. package/dist/services/address-verification.js +64 -0
  55. package/dist/services/address-verification.js.map +1 -0
  56. package/dist/services/api-credentials.d.ts +44 -0
  57. package/dist/services/api-credentials.js +42 -0
  58. package/dist/services/api-credentials.js.map +1 -0
  59. package/dist/services/claims.d.ts +68 -0
  60. package/dist/services/claims.js +67 -0
  61. package/dist/services/claims.js.map +1 -0
  62. package/dist/services/cross-chain-transfer.d.ts +71 -0
  63. package/dist/services/cross-chain-transfer.js +68 -0
  64. package/dist/services/cross-chain-transfer.js.map +1 -0
  65. package/dist/services/crypto-deposits.d.ts +30 -0
  66. package/dist/services/crypto-deposits.js +39 -0
  67. package/dist/services/crypto-deposits.js.map +1 -0
  68. package/dist/services/crypto-withdrawals.d.ts +60 -0
  69. package/dist/services/crypto-withdrawals.js +42 -0
  70. package/dist/services/crypto-withdrawals.js.map +1 -0
  71. package/dist/services/deposit-addresses.d.ts +54 -0
  72. package/dist/services/deposit-addresses.js +36 -0
  73. package/dist/services/deposit-addresses.js.map +1 -0
  74. package/dist/services/events.d.ts +53 -0
  75. package/dist/services/events.js +39 -0
  76. package/dist/services/events.js.map +1 -0
  77. package/dist/services/exchange.d.ts +52 -0
  78. package/dist/services/exchange.js +30 -0
  79. package/dist/services/exchange.js.map +1 -0
  80. package/dist/services/fees.d.ts +15 -0
  81. package/dist/services/fees.js +24 -0
  82. package/dist/services/fees.js.map +1 -0
  83. package/dist/services/fiat-transfers.d.ts +133 -0
  84. package/dist/services/fiat-transfers.js +127 -0
  85. package/dist/services/fiat-transfers.js.map +1 -0
  86. package/dist/services/identity-controls.d.ts +43 -0
  87. package/dist/services/identity-controls.js +42 -0
  88. package/dist/services/identity-controls.js.map +1 -0
  89. package/dist/services/identity-documents.d.ts +45 -0
  90. package/dist/services/identity-documents.js +50 -0
  91. package/dist/services/identity-documents.js.map +1 -0
  92. package/dist/services/identity.d.ts +122 -0
  93. package/dist/services/identity.js +66 -0
  94. package/dist/services/identity.js.map +1 -0
  95. package/dist/services/index.d.ts +89 -0
  96. package/dist/services/index.js +55 -0
  97. package/dist/services/index.js.map +1 -0
  98. package/dist/services/institution-members.d.ts +30 -0
  99. package/dist/services/institution-members.js +44 -0
  100. package/dist/services/institution-members.js.map +1 -0
  101. package/dist/services/internal-transfers.d.ts +15 -0
  102. package/dist/services/internal-transfers.js +26 -0
  103. package/dist/services/internal-transfers.js.map +1 -0
  104. package/dist/services/issuer-quotes.d.ts +72 -0
  105. package/dist/services/issuer-quotes.js +66 -0
  106. package/dist/services/issuer-quotes.js.map +1 -0
  107. package/dist/services/limits.d.ts +20 -0
  108. package/dist/services/limits.js +23 -0
  109. package/dist/services/limits.js.map +1 -0
  110. package/dist/services/market-data.d.ts +15 -0
  111. package/dist/services/market-data.js +23 -0
  112. package/dist/services/market-data.js.map +1 -0
  113. package/dist/services/monitoring-addresses.d.ts +64 -0
  114. package/dist/services/monitoring-addresses.js +68 -0
  115. package/dist/services/monitoring-addresses.js.map +1 -0
  116. package/dist/services/orchestration-rules.d.ts +53 -0
  117. package/dist/services/orchestration-rules.js +47 -0
  118. package/dist/services/orchestration-rules.js.map +1 -0
  119. package/dist/services/orchestrations.d.ts +70 -0
  120. package/dist/services/orchestrations.js +45 -0
  121. package/dist/services/orchestrations.js.map +1 -0
  122. package/dist/services/orders.d.ts +86 -0
  123. package/dist/services/orders.js +67 -0
  124. package/dist/services/orders.js.map +1 -0
  125. package/dist/services/paxos-transfers.d.ts +24 -0
  126. package/dist/services/paxos-transfers.js +35 -0
  127. package/dist/services/paxos-transfers.js.map +1 -0
  128. package/dist/services/payments.d.ts +46 -0
  129. package/dist/services/payments.js +35 -0
  130. package/dist/services/payments.js.map +1 -0
  131. package/dist/services/payout-groups.d.ts +59 -0
  132. package/dist/services/payout-groups.js +59 -0
  133. package/dist/services/payout-groups.js.map +1 -0
  134. package/dist/services/pricing.d.ts +67 -0
  135. package/dist/services/pricing.js +42 -0
  136. package/dist/services/pricing.js.map +1 -0
  137. package/dist/services/profiles.d.ts +106 -0
  138. package/dist/services/profiles.js +84 -0
  139. package/dist/services/profiles.js.map +1 -0
  140. package/dist/services/quote-executions.d.ts +51 -0
  141. package/dist/services/quote-executions.js +41 -0
  142. package/dist/services/quote-executions.js.map +1 -0
  143. package/dist/services/quotes.d.ts +44 -0
  144. package/dist/services/quotes.js +48 -0
  145. package/dist/services/quotes.js.map +1 -0
  146. package/dist/services/reward-addresses.d.ts +80 -0
  147. package/dist/services/reward-addresses.js +79 -0
  148. package/dist/services/reward-addresses.js.map +1 -0
  149. package/dist/services/rewards-statements.d.ts +35 -0
  150. package/dist/services/rewards-statements.js +32 -0
  151. package/dist/services/rewards-statements.js.map +1 -0
  152. package/dist/services/rewards.d.ts +34 -0
  153. package/dist/services/rewards.js +37 -0
  154. package/dist/services/rewards.js.map +1 -0
  155. package/dist/services/sandbox-deposits.d.ts +15 -0
  156. package/dist/services/sandbox-deposits.js +22 -0
  157. package/dist/services/sandbox-deposits.js.map +1 -0
  158. package/dist/services/sandbox-fiat-transfers.d.ts +15 -0
  159. package/dist/services/sandbox-fiat-transfers.js +24 -0
  160. package/dist/services/sandbox-fiat-transfers.js.map +1 -0
  161. package/dist/services/sandbox-identity.d.ts +39 -0
  162. package/dist/services/sandbox-identity.js +60 -0
  163. package/dist/services/sandbox-identity.js.map +1 -0
  164. package/dist/services/settlement.d.ts +76 -0
  165. package/dist/services/settlement.js +79 -0
  166. package/dist/services/settlement.js.map +1 -0
  167. package/dist/services/stablecoin-conversion.d.ts +70 -0
  168. package/dist/services/stablecoin-conversion.js +65 -0
  169. package/dist/services/stablecoin-conversion.js.map +1 -0
  170. package/dist/services/statements.d.ts +44 -0
  171. package/dist/services/statements.js +35 -0
  172. package/dist/services/statements.js.map +1 -0
  173. package/dist/services/tax-documentation.d.ts +21 -0
  174. package/dist/services/tax-documentation.js +33 -0
  175. package/dist/services/tax-documentation.js.map +1 -0
  176. package/dist/services/tax-forms.d.ts +45 -0
  177. package/dist/services/tax-forms.js +38 -0
  178. package/dist/services/tax-forms.js.map +1 -0
  179. package/dist/services/transfers.d.ts +96 -0
  180. package/dist/services/transfers.js +37 -0
  181. package/dist/services/transfers.js.map +1 -0
  182. package/dist/services/travel-rule.d.ts +32 -0
  183. package/dist/services/travel-rule.js +30 -0
  184. package/dist/services/travel-rule.js.map +1 -0
  185. package/dist/services/user-audit-logs.d.ts +45 -0
  186. package/dist/services/user-audit-logs.js +27 -0
  187. package/dist/services/user-audit-logs.js.map +1 -0
  188. package/dist/services/webhooks.d.ts +58 -0
  189. package/dist/services/webhooks.js +42 -0
  190. package/dist/services/webhooks.js.map +1 -0
  191. package/dist/signing.d.ts +33 -0
  192. package/dist/signing.js +186 -0
  193. package/dist/signing.js.map +1 -0
  194. package/dist/testing/fixtures.d.ts +40 -0
  195. package/dist/testing/fixtures.js +131 -0
  196. package/dist/testing/fixtures.js.map +1 -0
  197. package/dist/testing/index.d.ts +28 -0
  198. package/dist/testing/index.js +28 -0
  199. package/dist/testing/index.js.map +1 -0
  200. package/dist/testing/mock-server.d.ts +121 -0
  201. package/dist/testing/mock-server.js +276 -0
  202. package/dist/testing/mock-server.js.map +1 -0
  203. package/dist/timeouts.d.ts +13 -0
  204. package/dist/timeouts.js +71 -0
  205. package/dist/timeouts.js.map +1 -0
  206. package/dist/types.d.ts +6 -0
  207. package/dist/types.js +7 -0
  208. package/dist/types.js.map +1 -0
  209. package/dist/version.d.ts +1 -0
  210. package/dist/version.js +2 -0
  211. package/dist/version.js.map +1 -0
  212. package/package.json +67 -4
@@ -0,0 +1,72 @@
1
+ import type { RequestOptions, PageIterator, WithRaw } from "../client.js";
2
+ import type { KnownOrderBy, KnownSortOrder, KnownVerificationMethod, KnownVerificationStatus } from "../enums.js";
3
+ import type { CreateVerificationRequest, SubmitSignatureRequest, Verification } from "../models.js";
4
+ export interface ListVerificationsParams {
5
+ verification_method?: KnownVerificationMethod | (string & {});
6
+ status?: KnownVerificationStatus | (string & {});
7
+ limit?: number;
8
+ order?: KnownSortOrder | (string & {});
9
+ order_by?: KnownOrderBy | (string & {});
10
+ /** Include timestamps strictly less than lt. RFC3339 format, like `2006-01-02T15:04:05Z`. */
11
+ created_at_lt?: string;
12
+ /** Include timestamps less than or equal to lte. RFC3339 format, like `2006-01-02T15:04:05Z`. */
13
+ created_at_lte?: string;
14
+ /** Include timestamps exactly equal to eq. RFC3339 format, like `2006-01-02T15:04:05Z`. */
15
+ created_at_eq?: string;
16
+ /** Include timestamps greater than or equal to gte. RFC3339 format, like `2006-01-02T15:04:05Z`. */
17
+ created_at_gte?: string;
18
+ /** Include timestamps strictly greater than gt. RFC3339 format, like `2006-01-02T15:04:05Z`. */
19
+ created_at_gt?: string;
20
+ deposit_address?: string;
21
+ network?: string;
22
+ address?: string;
23
+ /** Include timestamps strictly less than lt. RFC3339 format, like `2006-01-02T15:04:05Z`. */
24
+ updated_at_lt?: string;
25
+ /** Include timestamps less than or equal to lte. RFC3339 format, like `2006-01-02T15:04:05Z`. */
26
+ updated_at_lte?: string;
27
+ /** Include timestamps exactly equal to eq. RFC3339 format, like `2006-01-02T15:04:05Z`. */
28
+ updated_at_eq?: string;
29
+ /** Include timestamps greater than or equal to gte. RFC3339 format, like `2006-01-02T15:04:05Z`. */
30
+ updated_at_gte?: string;
31
+ /** Include timestamps strictly greater than gt. RFC3339 format, like `2006-01-02T15:04:05Z`. */
32
+ updated_at_gt?: string;
33
+ /** Resume from a cursor previously returned as a page's `nextCursor`. */
34
+ page_cursor?: string;
35
+ }
36
+ /**
37
+ * AddressVerificationService provides access to AddressVerification API operations.
38
+ * Access via `client.addressVerification`.
39
+ */
40
+ export declare class AddressVerificationService {
41
+ private readonly client;
42
+ /**
43
+ * List address verifications
44
+ *
45
+ * Requires scope: address:read_ownership_proofs
46
+ */
47
+ listVerifications(params?: ListVerificationsParams, opts?: RequestOptions): PageIterator<WithRaw<Verification>>;
48
+ /**
49
+ * Create address verification
50
+ *
51
+ * Requires scope: address:write_ownership_proofs
52
+ */
53
+ createVerification(request: CreateVerificationRequest, opts?: RequestOptions): Promise<WithRaw<Verification>>;
54
+ /**
55
+ * Submit address verification signature
56
+ *
57
+ * Requires scope: address:write_ownership_proofs
58
+ */
59
+ submitSignature(request: SubmitSignatureRequest, opts?: RequestOptions): Promise<WithRaw<Verification>>;
60
+ /**
61
+ * Get address verification
62
+ *
63
+ * Requires scope: address:read_ownership_proofs
64
+ */
65
+ getVerification(id: string, opts?: RequestOptions): Promise<WithRaw<Verification>>;
66
+ /**
67
+ * Cancel address verification
68
+ *
69
+ * Requires scope: address:write_ownership_proofs
70
+ */
71
+ cancelVerification(id: string, opts?: RequestOptions): Promise<WithRaw<Verification>>;
72
+ }
@@ -0,0 +1,64 @@
1
+ // Code generated from the Paxos OpenAPI specification. DO NOT EDIT.
2
+ import { buildPath } from "../client.js";
3
+ /**
4
+ * AddressVerificationService provides access to AddressVerification API operations.
5
+ * Access via `client.addressVerification`.
6
+ */
7
+ export class AddressVerificationService {
8
+ client;
9
+ /** @internal */
10
+ constructor(client) {
11
+ this.client = client;
12
+ }
13
+ /**
14
+ * List address verifications
15
+ *
16
+ * Requires scope: address:read_ownership_proofs
17
+ */
18
+ listVerifications(params, opts) {
19
+ return this.client.paginate("/addresses/verifications", "items", params, opts, {
20
+ responseSchema: "ListVerificationsResponse",
21
+ });
22
+ }
23
+ /**
24
+ * Create address verification
25
+ *
26
+ * Requires scope: address:write_ownership_proofs
27
+ */
28
+ async createVerification(request, opts) {
29
+ const body = { ...request, ref_id: request.ref_id || globalThis.crypto.randomUUID() };
30
+ return this.client.post("/addresses/verifications", body, opts, {
31
+ responseSchema: "Verification",
32
+ requestSchema: "CreateVerificationRequest",
33
+ replayProtected: true,
34
+ });
35
+ }
36
+ /**
37
+ * Submit address verification signature
38
+ *
39
+ * Requires scope: address:write_ownership_proofs
40
+ */
41
+ async submitSignature(request, opts) {
42
+ return this.client.post("/addresses/verifications/signature", request, opts, {
43
+ responseSchema: "Verification",
44
+ requestSchema: "SubmitSignatureRequest",
45
+ });
46
+ }
47
+ /**
48
+ * Get address verification
49
+ *
50
+ * Requires scope: address:read_ownership_proofs
51
+ */
52
+ async getVerification(id, opts) {
53
+ return this.client.get(buildPath("/addresses/verifications/{id}", { id: id }), undefined, opts, { responseSchema: "Verification" });
54
+ }
55
+ /**
56
+ * Cancel address verification
57
+ *
58
+ * Requires scope: address:write_ownership_proofs
59
+ */
60
+ async cancelVerification(id, opts) {
61
+ return this.client.post(buildPath("/addresses/verifications/{id}/cancel", { id: id }), undefined, opts, { responseSchema: "Verification" });
62
+ }
63
+ }
64
+ //# sourceMappingURL=address-verification.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"address-verification.js","sourceRoot":"","sources":["../../src/services/address-verification.ts"],"names":[],"mappings":"AAAA,oEAAoE;AAEpE,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAsCzC;;;GAGG;AACH,MAAM,OAAO,0BAA0B;IAER;IAD7B,gBAAgB;IAChB,YAA6B,MAAkB;QAAlB,WAAM,GAAN,MAAM,CAAY;IAAG,CAAC;IAEnD;;;;OAIG;IACH,iBAAiB,CAAC,MAAgC,EAAE,IAAqB;QACvE,OAAO,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAwB,0BAA0B,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE;YACpG,cAAc,EAAE,2BAA2B;SAC5C,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,kBAAkB,CAAC,OAAkC,EAAE,IAAqB;QAChF,MAAM,IAAI,GAAG,EAAE,GAAG,OAAO,EAAE,MAAM,EAAE,OAAO,CAAC,MAAM,IAAI,UAAU,CAAC,MAAM,CAAC,UAAU,EAAE,EAAE,CAAC;QACtF,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAwB,0BAA0B,EAAE,IAAI,EAAE,IAAI,EAAE;YACrF,cAAc,EAAE,cAAc;YAC9B,aAAa,EAAE,2BAA2B;YAC1C,eAAe,EAAE,IAAI;SACtB,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,eAAe,CAAC,OAA+B,EAAE,IAAqB;QAC1E,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAwB,oCAAoC,EAAE,OAAO,EAAE,IAAI,EAAE;YAClG,cAAc,EAAE,cAAc;YAC9B,aAAa,EAAE,wBAAwB;SACxC,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,eAAe,CAAC,EAAU,EAAE,IAAqB;QACrD,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CACpB,SAAS,CAAC,+BAA+B,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,EACtD,SAAS,EACT,IAAI,EACJ,EAAE,cAAc,EAAE,cAAc,EAAE,CACnC,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,kBAAkB,CAAC,EAAU,EAAE,IAAqB;QACxD,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CACrB,SAAS,CAAC,sCAAsC,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,EAC7D,SAAS,EACT,IAAI,EACJ,EAAE,cAAc,EAAE,cAAc,EAAE,CACnC,CAAC;IACJ,CAAC;CACF","sourcesContent":["// Code generated from the Paxos OpenAPI specification. DO NOT EDIT.\n\nimport { buildPath } from \"../client.js\";\nimport type { HttpClient, RequestOptions, PageIterator, WithRaw } from \"../client.js\";\nimport type { KnownOrderBy, KnownSortOrder, KnownVerificationMethod, KnownVerificationStatus } from \"../enums.js\";\nimport type { CreateVerificationRequest, SubmitSignatureRequest, Verification } from \"../models.js\";\n\nexport interface ListVerificationsParams {\n verification_method?: KnownVerificationMethod | (string & {});\n status?: KnownVerificationStatus | (string & {});\n limit?: number;\n order?: KnownSortOrder | (string & {});\n order_by?: KnownOrderBy | (string & {});\n /** Include timestamps strictly less than lt. RFC3339 format, like `2006-01-02T15:04:05Z`. */\n created_at_lt?: string;\n /** Include timestamps less than or equal to lte. RFC3339 format, like `2006-01-02T15:04:05Z`. */\n created_at_lte?: string;\n /** Include timestamps exactly equal to eq. RFC3339 format, like `2006-01-02T15:04:05Z`. */\n created_at_eq?: string;\n /** Include timestamps greater than or equal to gte. RFC3339 format, like `2006-01-02T15:04:05Z`. */\n created_at_gte?: string;\n /** Include timestamps strictly greater than gt. RFC3339 format, like `2006-01-02T15:04:05Z`. */\n created_at_gt?: string;\n deposit_address?: string;\n network?: string;\n address?: string;\n /** Include timestamps strictly less than lt. RFC3339 format, like `2006-01-02T15:04:05Z`. */\n updated_at_lt?: string;\n /** Include timestamps less than or equal to lte. RFC3339 format, like `2006-01-02T15:04:05Z`. */\n updated_at_lte?: string;\n /** Include timestamps exactly equal to eq. RFC3339 format, like `2006-01-02T15:04:05Z`. */\n updated_at_eq?: string;\n /** Include timestamps greater than or equal to gte. RFC3339 format, like `2006-01-02T15:04:05Z`. */\n updated_at_gte?: string;\n /** Include timestamps strictly greater than gt. RFC3339 format, like `2006-01-02T15:04:05Z`. */\n updated_at_gt?: string;\n /** Resume from a cursor previously returned as a page's `nextCursor`. */\n page_cursor?: string;\n}\n\n/**\n * AddressVerificationService provides access to AddressVerification API operations.\n * Access via `client.addressVerification`.\n */\nexport class AddressVerificationService {\n /** @internal */\n constructor(private readonly client: HttpClient) {}\n\n /**\n * List address verifications\n *\n * Requires scope: address:read_ownership_proofs\n */\n listVerifications(params?: ListVerificationsParams, opts?: RequestOptions): PageIterator<WithRaw<Verification>> {\n return this.client.paginate<WithRaw<Verification>>(\"/addresses/verifications\", \"items\", params, opts, {\n responseSchema: \"ListVerificationsResponse\",\n });\n }\n\n /**\n * Create address verification\n *\n * Requires scope: address:write_ownership_proofs\n */\n async createVerification(request: CreateVerificationRequest, opts?: RequestOptions): Promise<WithRaw<Verification>> {\n const body = { ...request, ref_id: request.ref_id || globalThis.crypto.randomUUID() };\n return this.client.post<WithRaw<Verification>>(\"/addresses/verifications\", body, opts, {\n responseSchema: \"Verification\",\n requestSchema: \"CreateVerificationRequest\",\n replayProtected: true,\n });\n }\n\n /**\n * Submit address verification signature\n *\n * Requires scope: address:write_ownership_proofs\n */\n async submitSignature(request: SubmitSignatureRequest, opts?: RequestOptions): Promise<WithRaw<Verification>> {\n return this.client.post<WithRaw<Verification>>(\"/addresses/verifications/signature\", request, opts, {\n responseSchema: \"Verification\",\n requestSchema: \"SubmitSignatureRequest\",\n });\n }\n\n /**\n * Get address verification\n *\n * Requires scope: address:read_ownership_proofs\n */\n async getVerification(id: string, opts?: RequestOptions): Promise<WithRaw<Verification>> {\n return this.client.get<WithRaw<Verification>>(\n buildPath(\"/addresses/verifications/{id}\", { id: id }),\n undefined,\n opts,\n { responseSchema: \"Verification\" },\n );\n }\n\n /**\n * Cancel address verification\n *\n * Requires scope: address:write_ownership_proofs\n */\n async cancelVerification(id: string, opts?: RequestOptions): Promise<WithRaw<Verification>> {\n return this.client.post<WithRaw<Verification>>(\n buildPath(\"/addresses/verifications/{id}/cancel\", { id: id }),\n undefined,\n opts,\n { responseSchema: \"Verification\" },\n );\n }\n}\n"]}
@@ -0,0 +1,44 @@
1
+ import type { RequestOptions, PageIterator, WithRaw } from "../client.js";
2
+ import type { KnownFirstPartyClientStatus, KnownOrderBy, KnownSortOrder } from "../enums.js";
3
+ import type { DeleteApiCredentialsResponse, FirstPartyClient } from "../models.js";
4
+ export interface ListApiCredentialsParams {
5
+ /** Determines whether the items are returned in ascending (ASC), or descending (DESC) order. Defaults to DESC. */
6
+ order?: KnownSortOrder | (string & {});
7
+ /** The specific field by which the returned results will be ordered. Defaults to CREATED_AT. */
8
+ order_by?: KnownOrderBy | (string & {});
9
+ /** The maximum number of items to return. Defaults to 0 (return all records). Max value is 1000. */
10
+ limit?: number;
11
+ /** Filter for credentials with a set of statuses. Defaults to [APPROVED]. */
12
+ statuses?: (KnownFirstPartyClientStatus | (string & {}))[];
13
+ /** Optionally filter by the UUIDs of the credentials. Limit 100. */
14
+ ids?: string[];
15
+ /** Optionally filter by the client IDs of the credentials. Limit 100. */
16
+ client_ids?: string[];
17
+ /** Resume from a cursor previously returned as a page's `nextCursor`. */
18
+ page_cursor?: string;
19
+ }
20
+ /**
21
+ * ApiCredentialsService — API credentials allow programmatic access to Paxos
22
+ * APIs. These endpoints enable you to manage and view your API credentials.
23
+ *
24
+ * Access via `client.apiCredentials`.
25
+ */
26
+ export declare class ApiCredentialsService {
27
+ private readonly client;
28
+ /**
29
+ * List API Credentials
30
+ *
31
+ * Requires scope: api_creds:read_credentials
32
+ */
33
+ listApiCredentials(params?: ListApiCredentialsParams, opts?: RequestOptions): PageIterator<WithRaw<FirstPartyClient>>;
34
+ /**
35
+ * GetApiCredentialsSelf
36
+ */
37
+ getApiCredentialsSelf(opts?: RequestOptions): Promise<WithRaw<FirstPartyClient>>;
38
+ /**
39
+ * Delete API Credentials
40
+ *
41
+ * Requires scope: api_creds:delete_credentials
42
+ */
43
+ deleteApiCredentials(clientId: string, opts?: RequestOptions): Promise<WithRaw<DeleteApiCredentialsResponse>>;
44
+ }
@@ -0,0 +1,42 @@
1
+ // Code generated from the Paxos OpenAPI specification. DO NOT EDIT.
2
+ import { buildPath } from "../client.js";
3
+ /**
4
+ * ApiCredentialsService — API credentials allow programmatic access to Paxos
5
+ * APIs. These endpoints enable you to manage and view your API credentials.
6
+ *
7
+ * Access via `client.apiCredentials`.
8
+ */
9
+ export class ApiCredentialsService {
10
+ client;
11
+ /** @internal */
12
+ constructor(client) {
13
+ this.client = client;
14
+ }
15
+ /**
16
+ * List API Credentials
17
+ *
18
+ * Requires scope: api_creds:read_credentials
19
+ */
20
+ listApiCredentials(params, opts) {
21
+ return this.client.paginate("/api-creds/credentials", "items", params, opts, {
22
+ responseSchema: "ListApiCredentialsResponse",
23
+ });
24
+ }
25
+ /**
26
+ * GetApiCredentialsSelf
27
+ */
28
+ async getApiCredentialsSelf(opts) {
29
+ return this.client.get("/api-creds/credentials/self", undefined, opts, {
30
+ responseSchema: "FirstPartyClient",
31
+ });
32
+ }
33
+ /**
34
+ * Delete API Credentials
35
+ *
36
+ * Requires scope: api_creds:delete_credentials
37
+ */
38
+ async deleteApiCredentials(clientId, opts) {
39
+ return this.client.delete(buildPath("/api-creds/credentials/{client_id}", { client_id: clientId }), undefined, opts, { responseSchema: "DeleteApiCredentialsResponse" });
40
+ }
41
+ }
42
+ //# sourceMappingURL=api-credentials.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"api-credentials.js","sourceRoot":"","sources":["../../src/services/api-credentials.ts"],"names":[],"mappings":"AAAA,oEAAoE;AAEpE,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAsBzC;;;;;GAKG;AACH,MAAM,OAAO,qBAAqB;IAEH;IAD7B,gBAAgB;IAChB,YAA6B,MAAkB;QAAlB,WAAM,GAAN,MAAM,CAAY;IAAG,CAAC;IAEnD;;;;OAIG;IACH,kBAAkB,CAChB,MAAiC,EACjC,IAAqB;QAErB,OAAO,IAAI,CAAC,MAAM,CAAC,QAAQ,CAA4B,wBAAwB,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE;YACtG,cAAc,EAAE,4BAA4B;SAC7C,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,qBAAqB,CAAC,IAAqB;QAC/C,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAA4B,6BAA6B,EAAE,SAAS,EAAE,IAAI,EAAE;YAChG,cAAc,EAAE,kBAAkB;SACnC,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,oBAAoB,CAAC,QAAgB,EAAE,IAAqB;QAChE,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CACvB,SAAS,CAAC,oCAAoC,EAAE,EAAE,SAAS,EAAE,QAAQ,EAAE,CAAC,EACxE,SAAS,EACT,IAAI,EACJ,EAAE,cAAc,EAAE,8BAA8B,EAAE,CACnD,CAAC;IACJ,CAAC;CACF","sourcesContent":["// Code generated from the Paxos OpenAPI specification. DO NOT EDIT.\n\nimport { buildPath } from \"../client.js\";\nimport type { HttpClient, RequestOptions, PageIterator, WithRaw } from \"../client.js\";\nimport type { KnownFirstPartyClientStatus, KnownOrderBy, KnownSortOrder } from \"../enums.js\";\nimport type { DeleteApiCredentialsResponse, FirstPartyClient } from \"../models.js\";\n\nexport interface ListApiCredentialsParams {\n /** Determines whether the items are returned in ascending (ASC), or descending (DESC) order. Defaults to DESC. */\n order?: KnownSortOrder | (string & {});\n /** The specific field by which the returned results will be ordered. Defaults to CREATED_AT. */\n order_by?: KnownOrderBy | (string & {});\n /** The maximum number of items to return. Defaults to 0 (return all records). Max value is 1000. */\n limit?: number;\n /** Filter for credentials with a set of statuses. Defaults to [APPROVED]. */\n statuses?: (KnownFirstPartyClientStatus | (string & {}))[];\n /** Optionally filter by the UUIDs of the credentials. Limit 100. */\n ids?: string[];\n /** Optionally filter by the client IDs of the credentials. Limit 100. */\n client_ids?: string[];\n /** Resume from a cursor previously returned as a page's `nextCursor`. */\n page_cursor?: string;\n}\n\n/**\n * ApiCredentialsService — API credentials allow programmatic access to Paxos\n * APIs. These endpoints enable you to manage and view your API credentials.\n *\n * Access via `client.apiCredentials`.\n */\nexport class ApiCredentialsService {\n /** @internal */\n constructor(private readonly client: HttpClient) {}\n\n /**\n * List API Credentials\n *\n * Requires scope: api_creds:read_credentials\n */\n listApiCredentials(\n params?: ListApiCredentialsParams,\n opts?: RequestOptions,\n ): PageIterator<WithRaw<FirstPartyClient>> {\n return this.client.paginate<WithRaw<FirstPartyClient>>(\"/api-creds/credentials\", \"items\", params, opts, {\n responseSchema: \"ListApiCredentialsResponse\",\n });\n }\n\n /**\n * GetApiCredentialsSelf\n */\n async getApiCredentialsSelf(opts?: RequestOptions): Promise<WithRaw<FirstPartyClient>> {\n return this.client.get<WithRaw<FirstPartyClient>>(\"/api-creds/credentials/self\", undefined, opts, {\n responseSchema: \"FirstPartyClient\",\n });\n }\n\n /**\n * Delete API Credentials\n *\n * Requires scope: api_creds:delete_credentials\n */\n async deleteApiCredentials(clientId: string, opts?: RequestOptions): Promise<WithRaw<DeleteApiCredentialsResponse>> {\n return this.client.delete(\n buildPath(\"/api-creds/credentials/{client_id}\", { client_id: clientId }),\n undefined,\n opts,\n { responseSchema: \"DeleteApiCredentialsResponse\" },\n );\n }\n}\n"]}
@@ -0,0 +1,68 @@
1
+ import type { RequestOptions, PageIterator, WithRaw } from "../client.js";
2
+ import type { KnownClaimOnchainStatus } from "../enums.js";
3
+ import type { Claim, ClaimSchedule, CreateClaimScheduleRequest, CreateClaimScheduleResponse, DeleteClaimScheduleResponse, UpdateClaimScheduleRequest, UpdateClaimScheduleResponse } from "../models.js";
4
+ export interface ListClaimSchedulesParams {
5
+ /** Optionally filter by payout_group */
6
+ payout_group_id?: string;
7
+ /** Number of results to return. Defaults to 100. Maximum 1000. */
8
+ limit?: number;
9
+ /** Resume from a cursor previously returned as a page's `nextCursor`. */
10
+ page_cursor?: string;
11
+ }
12
+ export interface ListClaimsParams {
13
+ /** Optional filters */
14
+ payout_group_id?: string;
15
+ statuses?: (KnownClaimOnchainStatus | (string & {}))[];
16
+ chain?: string;
17
+ jurisdiction?: string;
18
+ /** Start and end times - Inclusive */
19
+ start_time?: string;
20
+ end_time?: string;
21
+ /** When set, only claims for this asset type (e.g. "USDG", "PYUSD") are returned. */
22
+ asset_type?: string;
23
+ /** Pagination */
24
+ limit?: number;
25
+ /** Resume from a cursor previously returned as a page's `nextCursor`. */
26
+ page_cursor?: string;
27
+ }
28
+ /**
29
+ * ClaimsService — Claims represent rewards paid out on-chain. Use claim
30
+ * schedules to automate daily reward claims.
31
+ *
32
+ * *These endpoints are only relevant for whitelisted Rewards partners.*
33
+ *
34
+ * Access via `client.claims`.
35
+ */
36
+ export declare class ClaimsService {
37
+ private readonly client;
38
+ /**
39
+ * List claim schedules
40
+ *
41
+ * Requires scope: rewards:read_claims_schedule
42
+ */
43
+ listClaimSchedules(params?: ListClaimSchedulesParams, opts?: RequestOptions): PageIterator<WithRaw<ClaimSchedule>>;
44
+ /**
45
+ * Create a claim schedule
46
+ *
47
+ * Requires scope: rewards:write_claims_schedule
48
+ */
49
+ createClaimSchedule(request: CreateClaimScheduleRequest, opts?: RequestOptions): Promise<WithRaw<CreateClaimScheduleResponse>>;
50
+ /**
51
+ * Delete a claim schedule
52
+ *
53
+ * Requires scope: rewards:write_claims_schedule
54
+ */
55
+ deleteClaimSchedule(id: string, opts?: RequestOptions): Promise<WithRaw<DeleteClaimScheduleResponse>>;
56
+ /**
57
+ * Update a claim schedule
58
+ *
59
+ * Requires scope: rewards:write_claims_schedule
60
+ */
61
+ updateClaimSchedule(id: string, request: UpdateClaimScheduleRequest, opts?: RequestOptions): Promise<WithRaw<UpdateClaimScheduleResponse>>;
62
+ /**
63
+ * List claims
64
+ *
65
+ * Requires scope: rewards:read_claims
66
+ */
67
+ listClaims(params?: ListClaimsParams, opts?: RequestOptions): PageIterator<WithRaw<Claim>>;
68
+ }
@@ -0,0 +1,67 @@
1
+ // Code generated from the Paxos OpenAPI specification. DO NOT EDIT.
2
+ import { buildPath } from "../client.js";
3
+ /**
4
+ * ClaimsService — Claims represent rewards paid out on-chain. Use claim
5
+ * schedules to automate daily reward claims.
6
+ *
7
+ * *These endpoints are only relevant for whitelisted Rewards partners.*
8
+ *
9
+ * Access via `client.claims`.
10
+ */
11
+ export class ClaimsService {
12
+ client;
13
+ /** @internal */
14
+ constructor(client) {
15
+ this.client = client;
16
+ }
17
+ /**
18
+ * List claim schedules
19
+ *
20
+ * Requires scope: rewards:read_claims_schedule
21
+ */
22
+ listClaimSchedules(params, opts) {
23
+ return this.client.paginate("/rewards/claim-schedules", "items", params, opts, {
24
+ responseSchema: "ListClaimSchedulesResponse",
25
+ });
26
+ }
27
+ /**
28
+ * Create a claim schedule
29
+ *
30
+ * Requires scope: rewards:write_claims_schedule
31
+ */
32
+ async createClaimSchedule(request, opts) {
33
+ return this.client.post("/rewards/claim-schedules", request, opts, {
34
+ responseSchema: "CreateClaimScheduleResponse",
35
+ requestSchema: "CreateClaimScheduleRequest",
36
+ });
37
+ }
38
+ /**
39
+ * Delete a claim schedule
40
+ *
41
+ * Requires scope: rewards:write_claims_schedule
42
+ */
43
+ async deleteClaimSchedule(id, opts) {
44
+ return this.client.delete(buildPath("/rewards/claim-schedules/{id}", { id: id }), undefined, opts, {
45
+ responseSchema: "DeleteClaimScheduleResponse",
46
+ });
47
+ }
48
+ /**
49
+ * Update a claim schedule
50
+ *
51
+ * Requires scope: rewards:write_claims_schedule
52
+ */
53
+ async updateClaimSchedule(id, request, opts) {
54
+ return this.client.put(buildPath("/rewards/claim-schedules/{id}", { id: id }), request, opts, { responseSchema: "UpdateClaimScheduleResponse", requestSchema: "UpdateClaimScheduleRequest" });
55
+ }
56
+ /**
57
+ * List claims
58
+ *
59
+ * Requires scope: rewards:read_claims
60
+ */
61
+ listClaims(params, opts) {
62
+ return this.client.paginate("/rewards/claims", "items", params, opts, {
63
+ responseSchema: "ListClaimsResponse",
64
+ });
65
+ }
66
+ }
67
+ //# sourceMappingURL=claims.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"claims.js","sourceRoot":"","sources":["../../src/services/claims.ts"],"names":[],"mappings":"AAAA,oEAAoE;AAEpE,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAuCzC;;;;;;;GAOG;AACH,MAAM,OAAO,aAAa;IAEK;IAD7B,gBAAgB;IAChB,YAA6B,MAAkB;QAAlB,WAAM,GAAN,MAAM,CAAY;IAAG,CAAC;IAEnD;;;;OAIG;IACH,kBAAkB,CAAC,MAAiC,EAAE,IAAqB;QACzE,OAAO,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAyB,0BAA0B,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE;YACrG,cAAc,EAAE,4BAA4B;SAC7C,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,mBAAmB,CACvB,OAAmC,EACnC,IAAqB;QAErB,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CAAuC,0BAA0B,EAAE,OAAO,EAAE,IAAI,EAAE;YACvG,cAAc,EAAE,6BAA6B;YAC7C,aAAa,EAAE,4BAA4B;SAC5C,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,mBAAmB,CAAC,EAAU,EAAE,IAAqB;QACzD,OAAO,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,+BAA+B,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,SAAS,EAAE,IAAI,EAAE;YACjG,cAAc,EAAE,6BAA6B;SAC9C,CAAC,CAAC;IACL,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,mBAAmB,CACvB,EAAU,EACV,OAAmC,EACnC,IAAqB;QAErB,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CACpB,SAAS,CAAC,+BAA+B,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,EACtD,OAAO,EACP,IAAI,EACJ,EAAE,cAAc,EAAE,6BAA6B,EAAE,aAAa,EAAE,4BAA4B,EAAE,CAC/F,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,UAAU,CAAC,MAAyB,EAAE,IAAqB;QACzD,OAAO,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAiB,iBAAiB,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE;YACpF,cAAc,EAAE,oBAAoB;SACrC,CAAC,CAAC;IACL,CAAC;CACF","sourcesContent":["// Code generated from the Paxos OpenAPI specification. DO NOT EDIT.\n\nimport { buildPath } from \"../client.js\";\nimport type { HttpClient, RequestOptions, PageIterator, WithRaw } from \"../client.js\";\nimport type { KnownClaimOnchainStatus } from \"../enums.js\";\nimport type {\n Claim,\n ClaimSchedule,\n CreateClaimScheduleRequest,\n CreateClaimScheduleResponse,\n DeleteClaimScheduleResponse,\n UpdateClaimScheduleRequest,\n UpdateClaimScheduleResponse,\n} from \"../models.js\";\n\nexport interface ListClaimSchedulesParams {\n /** Optionally filter by payout_group */\n payout_group_id?: string;\n /** Number of results to return. Defaults to 100. Maximum 1000. */\n limit?: number;\n /** Resume from a cursor previously returned as a page's `nextCursor`. */\n page_cursor?: string;\n}\n\nexport interface ListClaimsParams {\n /** Optional filters */\n payout_group_id?: string;\n statuses?: (KnownClaimOnchainStatus | (string & {}))[];\n chain?: string;\n jurisdiction?: string;\n /** Start and end times - Inclusive */\n start_time?: string;\n end_time?: string;\n /** When set, only claims for this asset type (e.g. \"USDG\", \"PYUSD\") are returned. */\n asset_type?: string;\n /** Pagination */\n limit?: number;\n /** Resume from a cursor previously returned as a page's `nextCursor`. */\n page_cursor?: string;\n}\n\n/**\n * ClaimsService — Claims represent rewards paid out on-chain. Use claim\n * schedules to automate daily reward claims.\n *\n * *These endpoints are only relevant for whitelisted Rewards partners.*\n *\n * Access via `client.claims`.\n */\nexport class ClaimsService {\n /** @internal */\n constructor(private readonly client: HttpClient) {}\n\n /**\n * List claim schedules\n *\n * Requires scope: rewards:read_claims_schedule\n */\n listClaimSchedules(params?: ListClaimSchedulesParams, opts?: RequestOptions): PageIterator<WithRaw<ClaimSchedule>> {\n return this.client.paginate<WithRaw<ClaimSchedule>>(\"/rewards/claim-schedules\", \"items\", params, opts, {\n responseSchema: \"ListClaimSchedulesResponse\",\n });\n }\n\n /**\n * Create a claim schedule\n *\n * Requires scope: rewards:write_claims_schedule\n */\n async createClaimSchedule(\n request: CreateClaimScheduleRequest,\n opts?: RequestOptions,\n ): Promise<WithRaw<CreateClaimScheduleResponse>> {\n return this.client.post<WithRaw<CreateClaimScheduleResponse>>(\"/rewards/claim-schedules\", request, opts, {\n responseSchema: \"CreateClaimScheduleResponse\",\n requestSchema: \"CreateClaimScheduleRequest\",\n });\n }\n\n /**\n * Delete a claim schedule\n *\n * Requires scope: rewards:write_claims_schedule\n */\n async deleteClaimSchedule(id: string, opts?: RequestOptions): Promise<WithRaw<DeleteClaimScheduleResponse>> {\n return this.client.delete(buildPath(\"/rewards/claim-schedules/{id}\", { id: id }), undefined, opts, {\n responseSchema: \"DeleteClaimScheduleResponse\",\n });\n }\n\n /**\n * Update a claim schedule\n *\n * Requires scope: rewards:write_claims_schedule\n */\n async updateClaimSchedule(\n id: string,\n request: UpdateClaimScheduleRequest,\n opts?: RequestOptions,\n ): Promise<WithRaw<UpdateClaimScheduleResponse>> {\n return this.client.put<WithRaw<UpdateClaimScheduleResponse>>(\n buildPath(\"/rewards/claim-schedules/{id}\", { id: id }),\n request,\n opts,\n { responseSchema: \"UpdateClaimScheduleResponse\", requestSchema: \"UpdateClaimScheduleRequest\" },\n );\n }\n\n /**\n * List claims\n *\n * Requires scope: rewards:read_claims\n */\n listClaims(params?: ListClaimsParams, opts?: RequestOptions): PageIterator<WithRaw<Claim>> {\n return this.client.paginate<WithRaw<Claim>>(\"/rewards/claims\", \"items\", params, opts, {\n responseSchema: \"ListClaimsResponse\",\n });\n }\n}\n"]}
@@ -0,0 +1,71 @@
1
+ import type { RequestOptions, PageIterator, WithRaw } from "../client.js";
2
+ import type { KnownCryptoNetwork } from "../enums.js";
3
+ import type { CrossChainAttestation, CrossChainFees, CrossChainTransfer, ListCrossChainAttestationsResponse } from "../models.js";
4
+ export interface ListCrossChainAttestationsParams {
5
+ /** Required. Must be a PATH network. */
6
+ source_network: KnownCryptoNetwork | (string & {});
7
+ /** Required. Source transaction hash in the network's native encoding
8
+ (0x-hex for EVM, base58 for Solana). */
9
+ tx_hash: string;
10
+ }
11
+ export interface GetCrossChainFeesParams {
12
+ /** Required. Must be a PATH network. */
13
+ destination_network: KnownCryptoNetwork | (string & {});
14
+ /** Required. Paxos asset symbol; case-insensitive. */
15
+ asset: string;
16
+ }
17
+ export interface ListCrossChainTransfersParams {
18
+ /** Defaults to 50. Values above 100 are rejected with 400. */
19
+ limit?: number;
20
+ /** Resume from a cursor previously returned as a page's `nextCursor`. */
21
+ page_cursor?: string;
22
+ }
23
+ /**
24
+ * CrossChainTransferService — Look up the status of a cross-chain transfer
25
+ * after burning on the source network, and the fees that apply to a
26
+ * destination network and asset. Each burn is identified by its receipt. Use
27
+ * {@link CrossChainTransferService.getCrossChainAttestation | Get Cross-Chain Attestation}
28
+ * to look up a single burn by receipt, or
29
+ * {@link CrossChainTransferService.listCrossChainAttestations | List Cross-Chain Attestations}
30
+ * to look up the burns in a source transaction by `source_network` and
31
+ * `tx_hash`.
32
+ * {@link CrossChainTransferService.listCrossChainTransfers | List Cross-Chain Transfers}
33
+ * lists the burns a wallet submitted, newest first.
34
+ * {@link CrossChainTransferService.getCrossChainFees | Get Cross-Chain Fees}
35
+ * returns the `transfer_fee` and `forwarding_fee` for a `destination_network`
36
+ * and `asset`.
37
+ *
38
+ * These endpoints do not require authentication. Responses omit fields at
39
+ * their default value (`0`, `false`, `""`, empty list). They are rate limited
40
+ * per IP; on `429`, back off before retrying, for the `Retry-After` seconds
41
+ * when that header is present.
42
+ *
43
+ * A burn is `PENDING` until it is verified and signed, then `SIGNED` with an
44
+ * `authorization` to mint on the destination network. `COMPLETED`, `EXPIRED`
45
+ * and `FAILED` are terminal states, so stop polling when a burn reaches one of
46
+ * them. An `EXPIRED` burn was not redeemed before its authorization's
47
+ * `expires_at`. A receipt that has not been observed yet returns `404`, and a
48
+ * transaction that has not been observed yet returns no `items`, so retry for
49
+ * a bounded time before treating either as an error.
50
+ *
51
+ * Access via `client.crossChainTransfer`.
52
+ */
53
+ export declare class CrossChainTransferService {
54
+ private readonly client;
55
+ /**
56
+ * List Cross-Chain Attestations
57
+ */
58
+ listCrossChainAttestations(params?: ListCrossChainAttestationsParams, opts?: RequestOptions): Promise<WithRaw<ListCrossChainAttestationsResponse>>;
59
+ /**
60
+ * Get Cross-Chain Attestation
61
+ */
62
+ getCrossChainAttestation(receipt: string, opts?: RequestOptions): Promise<WithRaw<CrossChainAttestation>>;
63
+ /**
64
+ * Get Cross-Chain Fees
65
+ */
66
+ getCrossChainFees(params?: GetCrossChainFeesParams, opts?: RequestOptions): Promise<WithRaw<CrossChainFees>>;
67
+ /**
68
+ * List Cross-Chain Transfers
69
+ */
70
+ listCrossChainTransfers(address: string, params?: ListCrossChainTransfersParams, opts?: RequestOptions): PageIterator<WithRaw<CrossChainTransfer>>;
71
+ }
@@ -0,0 +1,68 @@
1
+ // Code generated from the Paxos OpenAPI specification. DO NOT EDIT.
2
+ import { buildPath } from "../client.js";
3
+ /**
4
+ * CrossChainTransferService — Look up the status of a cross-chain transfer
5
+ * after burning on the source network, and the fees that apply to a
6
+ * destination network and asset. Each burn is identified by its receipt. Use
7
+ * {@link CrossChainTransferService.getCrossChainAttestation | Get Cross-Chain Attestation}
8
+ * to look up a single burn by receipt, or
9
+ * {@link CrossChainTransferService.listCrossChainAttestations | List Cross-Chain Attestations}
10
+ * to look up the burns in a source transaction by `source_network` and
11
+ * `tx_hash`.
12
+ * {@link CrossChainTransferService.listCrossChainTransfers | List Cross-Chain Transfers}
13
+ * lists the burns a wallet submitted, newest first.
14
+ * {@link CrossChainTransferService.getCrossChainFees | Get Cross-Chain Fees}
15
+ * returns the `transfer_fee` and `forwarding_fee` for a `destination_network`
16
+ * and `asset`.
17
+ *
18
+ * These endpoints do not require authentication. Responses omit fields at
19
+ * their default value (`0`, `false`, `""`, empty list). They are rate limited
20
+ * per IP; on `429`, back off before retrying, for the `Retry-After` seconds
21
+ * when that header is present.
22
+ *
23
+ * A burn is `PENDING` until it is verified and signed, then `SIGNED` with an
24
+ * `authorization` to mint on the destination network. `COMPLETED`, `EXPIRED`
25
+ * and `FAILED` are terminal states, so stop polling when a burn reaches one of
26
+ * them. An `EXPIRED` burn was not redeemed before its authorization's
27
+ * `expires_at`. A receipt that has not been observed yet returns `404`, and a
28
+ * transaction that has not been observed yet returns no `items`, so retry for
29
+ * a bounded time before treating either as an error.
30
+ *
31
+ * Access via `client.crossChainTransfer`.
32
+ */
33
+ export class CrossChainTransferService {
34
+ client;
35
+ /** @internal */
36
+ constructor(client) {
37
+ this.client = client;
38
+ }
39
+ /**
40
+ * List Cross-Chain Attestations
41
+ */
42
+ async listCrossChainAttestations(params, opts) {
43
+ return this.client.get("/cross-chain/attestations", params, opts, {
44
+ responseSchema: "ListCrossChainAttestationsResponse",
45
+ });
46
+ }
47
+ /**
48
+ * Get Cross-Chain Attestation
49
+ */
50
+ async getCrossChainAttestation(receipt, opts) {
51
+ return this.client.get(buildPath("/cross-chain/attestations/{receipt}", { receipt: receipt }), undefined, opts, { responseSchema: "CrossChainAttestation" });
52
+ }
53
+ /**
54
+ * Get Cross-Chain Fees
55
+ */
56
+ async getCrossChainFees(params, opts) {
57
+ return this.client.get("/cross-chain/fees", params, opts, {
58
+ responseSchema: "CrossChainFees",
59
+ });
60
+ }
61
+ /**
62
+ * List Cross-Chain Transfers
63
+ */
64
+ listCrossChainTransfers(address, params, opts) {
65
+ return this.client.paginate(buildPath("/cross-chain/transfers/{address}", { address: address }), "items", params, opts, { responseSchema: "ListCrossChainTransfersResponse" });
66
+ }
67
+ }
68
+ //# sourceMappingURL=cross-chain-transfer.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"cross-chain-transfer.js","sourceRoot":"","sources":["../../src/services/cross-chain-transfer.ts"],"names":[],"mappings":"AAAA,oEAAoE;AAEpE,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AAgCzC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA6BG;AACH,MAAM,OAAO,yBAAyB;IAEP;IAD7B,gBAAgB;IAChB,YAA6B,MAAkB;QAAlB,WAAM,GAAN,MAAM,CAAY;IAAG,CAAC;IAEnD;;OAEG;IACH,KAAK,CAAC,0BAA0B,CAC9B,MAAyC,EACzC,IAAqB;QAErB,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAA8C,2BAA2B,EAAE,MAAM,EAAE,IAAI,EAAE;YAC7G,cAAc,EAAE,oCAAoC;SACrD,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,wBAAwB,CAAC,OAAe,EAAE,IAAqB;QACnE,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CACpB,SAAS,CAAC,qCAAqC,EAAE,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,EACtE,SAAS,EACT,IAAI,EACJ,EAAE,cAAc,EAAE,uBAAuB,EAAE,CAC5C,CAAC;IACJ,CAAC;IAED;;OAEG;IACH,KAAK,CAAC,iBAAiB,CAAC,MAAgC,EAAE,IAAqB;QAC7E,OAAO,IAAI,CAAC,MAAM,CAAC,GAAG,CAA0B,mBAAmB,EAAE,MAAM,EAAE,IAAI,EAAE;YACjF,cAAc,EAAE,gBAAgB;SACjC,CAAC,CAAC;IACL,CAAC;IAED;;OAEG;IACH,uBAAuB,CACrB,OAAe,EACf,MAAsC,EACtC,IAAqB;QAErB,OAAO,IAAI,CAAC,MAAM,CAAC,QAAQ,CACzB,SAAS,CAAC,kCAAkC,EAAE,EAAE,OAAO,EAAE,OAAO,EAAE,CAAC,EACnE,OAAO,EACP,MAAM,EACN,IAAI,EACJ,EAAE,cAAc,EAAE,iCAAiC,EAAE,CACtD,CAAC;IACJ,CAAC;CACF","sourcesContent":["// Code generated from the Paxos OpenAPI specification. DO NOT EDIT.\n\nimport { buildPath } from \"../client.js\";\nimport type { HttpClient, RequestOptions, PageIterator, WithRaw } from \"../client.js\";\nimport type { KnownCryptoNetwork } from \"../enums.js\";\nimport type {\n CrossChainAttestation,\n CrossChainFees,\n CrossChainTransfer,\n ListCrossChainAttestationsResponse,\n} from \"../models.js\";\n\nexport interface ListCrossChainAttestationsParams {\n /** Required. Must be a PATH network. */\n source_network: KnownCryptoNetwork | (string & {});\n /** Required. Source transaction hash in the network's native encoding\n(0x-hex for EVM, base58 for Solana). */\n tx_hash: string;\n}\n\nexport interface GetCrossChainFeesParams {\n /** Required. Must be a PATH network. */\n destination_network: KnownCryptoNetwork | (string & {});\n /** Required. Paxos asset symbol; case-insensitive. */\n asset: string;\n}\n\nexport interface ListCrossChainTransfersParams {\n /** Defaults to 50. Values above 100 are rejected with 400. */\n limit?: number;\n /** Resume from a cursor previously returned as a page's `nextCursor`. */\n page_cursor?: string;\n}\n\n/**\n * CrossChainTransferService — Look up the status of a cross-chain transfer\n * after burning on the source network, and the fees that apply to a\n * destination network and asset. Each burn is identified by its receipt. Use\n * {@link CrossChainTransferService.getCrossChainAttestation | Get Cross-Chain Attestation}\n * to look up a single burn by receipt, or\n * {@link CrossChainTransferService.listCrossChainAttestations | List Cross-Chain Attestations}\n * to look up the burns in a source transaction by `source_network` and\n * `tx_hash`.\n * {@link CrossChainTransferService.listCrossChainTransfers | List Cross-Chain Transfers}\n * lists the burns a wallet submitted, newest first.\n * {@link CrossChainTransferService.getCrossChainFees | Get Cross-Chain Fees}\n * returns the `transfer_fee` and `forwarding_fee` for a `destination_network`\n * and `asset`.\n *\n * These endpoints do not require authentication. Responses omit fields at\n * their default value (`0`, `false`, `\"\"`, empty list). They are rate limited\n * per IP; on `429`, back off before retrying, for the `Retry-After` seconds\n * when that header is present.\n *\n * A burn is `PENDING` until it is verified and signed, then `SIGNED` with an\n * `authorization` to mint on the destination network. `COMPLETED`, `EXPIRED`\n * and `FAILED` are terminal states, so stop polling when a burn reaches one of\n * them. An `EXPIRED` burn was not redeemed before its authorization's\n * `expires_at`. A receipt that has not been observed yet returns `404`, and a\n * transaction that has not been observed yet returns no `items`, so retry for\n * a bounded time before treating either as an error.\n *\n * Access via `client.crossChainTransfer`.\n */\nexport class CrossChainTransferService {\n /** @internal */\n constructor(private readonly client: HttpClient) {}\n\n /**\n * List Cross-Chain Attestations\n */\n async listCrossChainAttestations(\n params?: ListCrossChainAttestationsParams,\n opts?: RequestOptions,\n ): Promise<WithRaw<ListCrossChainAttestationsResponse>> {\n return this.client.get<WithRaw<ListCrossChainAttestationsResponse>>(\"/cross-chain/attestations\", params, opts, {\n responseSchema: \"ListCrossChainAttestationsResponse\",\n });\n }\n\n /**\n * Get Cross-Chain Attestation\n */\n async getCrossChainAttestation(receipt: string, opts?: RequestOptions): Promise<WithRaw<CrossChainAttestation>> {\n return this.client.get<WithRaw<CrossChainAttestation>>(\n buildPath(\"/cross-chain/attestations/{receipt}\", { receipt: receipt }),\n undefined,\n opts,\n { responseSchema: \"CrossChainAttestation\" },\n );\n }\n\n /**\n * Get Cross-Chain Fees\n */\n async getCrossChainFees(params?: GetCrossChainFeesParams, opts?: RequestOptions): Promise<WithRaw<CrossChainFees>> {\n return this.client.get<WithRaw<CrossChainFees>>(\"/cross-chain/fees\", params, opts, {\n responseSchema: \"CrossChainFees\",\n });\n }\n\n /**\n * List Cross-Chain Transfers\n */\n listCrossChainTransfers(\n address: string,\n params?: ListCrossChainTransfersParams,\n opts?: RequestOptions,\n ): PageIterator<WithRaw<CrossChainTransfer>> {\n return this.client.paginate<WithRaw<CrossChainTransfer>>(\n buildPath(\"/cross-chain/transfers/{address}\", { address: address }),\n \"items\",\n params,\n opts,\n { responseSchema: \"ListCrossChainTransfersResponse\" },\n );\n }\n}\n"]}
@@ -0,0 +1,30 @@
1
+ import type { RequestOptions, WithRaw } from "../client.js";
2
+ import type { RejectCryptoDepositRequest, RejectCryptoDepositResponse, UpdateCryptoDepositRequest, UpdateCryptoDepositResponse } from "../models.js";
3
+ /**
4
+ * CryptoDepositsService — For Paxos Global PTE Ltd users, update or reject a
5
+ * crypto deposit that does not contain the required travel rule information.
6
+ * Deposits with the `NEEDS_INFO` status require additional sender information
7
+ * before they can be processed.
8
+ *
9
+ * - For individuals, both first and last name are required.
10
+ * - For institutions, the institution name is required.
11
+ *
12
+ * If a deposit is rejected, the funds will no longer be available.
13
+ *
14
+ * Access via `client.cryptoDeposits`.
15
+ */
16
+ export declare class CryptoDepositsService {
17
+ private readonly client;
18
+ /**
19
+ * Reject Crypto Deposit
20
+ *
21
+ * Requires scope: transfer:reject_crypto_deposit
22
+ */
23
+ rejectCryptoDeposit(id: string, request: RejectCryptoDepositRequest, opts?: RequestOptions): Promise<WithRaw<RejectCryptoDepositResponse>>;
24
+ /**
25
+ * Update Crypto Deposit
26
+ *
27
+ * Requires scope: transfer:update_crypto_deposit
28
+ */
29
+ updateCryptoDeposit(id: string, request: UpdateCryptoDepositRequest, opts?: RequestOptions): Promise<WithRaw<UpdateCryptoDepositResponse>>;
30
+ }
@@ -0,0 +1,39 @@
1
+ // Code generated from the Paxos OpenAPI specification. DO NOT EDIT.
2
+ import { buildPath } from "../client.js";
3
+ /**
4
+ * CryptoDepositsService — For Paxos Global PTE Ltd users, update or reject a
5
+ * crypto deposit that does not contain the required travel rule information.
6
+ * Deposits with the `NEEDS_INFO` status require additional sender information
7
+ * before they can be processed.
8
+ *
9
+ * - For individuals, both first and last name are required.
10
+ * - For institutions, the institution name is required.
11
+ *
12
+ * If a deposit is rejected, the funds will no longer be available.
13
+ *
14
+ * Access via `client.cryptoDeposits`.
15
+ */
16
+ export class CryptoDepositsService {
17
+ client;
18
+ /** @internal */
19
+ constructor(client) {
20
+ this.client = client;
21
+ }
22
+ /**
23
+ * Reject Crypto Deposit
24
+ *
25
+ * Requires scope: transfer:reject_crypto_deposit
26
+ */
27
+ async rejectCryptoDeposit(id, request, opts) {
28
+ return this.client.post(buildPath("/transfer/crypto-deposits/{id}/reject", { id: id }), request, opts, { responseSchema: "RejectCryptoDepositResponse", requestSchema: "RejectCryptoDepositRequest" });
29
+ }
30
+ /**
31
+ * Update Crypto Deposit
32
+ *
33
+ * Requires scope: transfer:update_crypto_deposit
34
+ */
35
+ async updateCryptoDeposit(id, request, opts) {
36
+ return this.client.post(buildPath("/transfer/crypto-deposits/{id}/update", { id: id }), request, opts, { responseSchema: "UpdateCryptoDepositResponse", requestSchema: "UpdateCryptoDepositRequest" });
37
+ }
38
+ }
39
+ //# sourceMappingURL=crypto-deposits.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"crypto-deposits.js","sourceRoot":"","sources":["../../src/services/crypto-deposits.ts"],"names":[],"mappings":"AAAA,oEAAoE;AAEpE,OAAO,EAAE,SAAS,EAAE,MAAM,cAAc,CAAC;AASzC;;;;;;;;;;;;GAYG;AACH,MAAM,OAAO,qBAAqB;IAEH;IAD7B,gBAAgB;IAChB,YAA6B,MAAkB;QAAlB,WAAM,GAAN,MAAM,CAAY;IAAG,CAAC;IAEnD;;;;OAIG;IACH,KAAK,CAAC,mBAAmB,CACvB,EAAU,EACV,OAAmC,EACnC,IAAqB;QAErB,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CACrB,SAAS,CAAC,uCAAuC,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,EAC9D,OAAO,EACP,IAAI,EACJ,EAAE,cAAc,EAAE,6BAA6B,EAAE,aAAa,EAAE,4BAA4B,EAAE,CAC/F,CAAC;IACJ,CAAC;IAED;;;;OAIG;IACH,KAAK,CAAC,mBAAmB,CACvB,EAAU,EACV,OAAmC,EACnC,IAAqB;QAErB,OAAO,IAAI,CAAC,MAAM,CAAC,IAAI,CACrB,SAAS,CAAC,uCAAuC,EAAE,EAAE,EAAE,EAAE,EAAE,EAAE,CAAC,EAC9D,OAAO,EACP,IAAI,EACJ,EAAE,cAAc,EAAE,6BAA6B,EAAE,aAAa,EAAE,4BAA4B,EAAE,CAC/F,CAAC;IACJ,CAAC;CACF","sourcesContent":["// Code generated from the Paxos OpenAPI specification. DO NOT EDIT.\n\nimport { buildPath } from \"../client.js\";\nimport type { HttpClient, RequestOptions, WithRaw } from \"../client.js\";\nimport type {\n RejectCryptoDepositRequest,\n RejectCryptoDepositResponse,\n UpdateCryptoDepositRequest,\n UpdateCryptoDepositResponse,\n} from \"../models.js\";\n\n/**\n * CryptoDepositsService — For Paxos Global PTE Ltd users, update or reject a\n * crypto deposit that does not contain the required travel rule information.\n * Deposits with the `NEEDS_INFO` status require additional sender information\n * before they can be processed.\n *\n * - For individuals, both first and last name are required.\n * - For institutions, the institution name is required.\n *\n * If a deposit is rejected, the funds will no longer be available.\n *\n * Access via `client.cryptoDeposits`.\n */\nexport class CryptoDepositsService {\n /** @internal */\n constructor(private readonly client: HttpClient) {}\n\n /**\n * Reject Crypto Deposit\n *\n * Requires scope: transfer:reject_crypto_deposit\n */\n async rejectCryptoDeposit(\n id: string,\n request: RejectCryptoDepositRequest,\n opts?: RequestOptions,\n ): Promise<WithRaw<RejectCryptoDepositResponse>> {\n return this.client.post<WithRaw<RejectCryptoDepositResponse>>(\n buildPath(\"/transfer/crypto-deposits/{id}/reject\", { id: id }),\n request,\n opts,\n { responseSchema: \"RejectCryptoDepositResponse\", requestSchema: \"RejectCryptoDepositRequest\" },\n );\n }\n\n /**\n * Update Crypto Deposit\n *\n * Requires scope: transfer:update_crypto_deposit\n */\n async updateCryptoDeposit(\n id: string,\n request: UpdateCryptoDepositRequest,\n opts?: RequestOptions,\n ): Promise<WithRaw<UpdateCryptoDepositResponse>> {\n return this.client.post<WithRaw<UpdateCryptoDepositResponse>>(\n buildPath(\"/transfer/crypto-deposits/{id}/update\", { id: id }),\n request,\n opts,\n { responseSchema: \"UpdateCryptoDepositResponse\", requestSchema: \"UpdateCryptoDepositRequest\" },\n );\n }\n}\n"]}