@dakota-xyz/ts-sdk 1.2.0 → 1.3.1
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.
- package/dist/index.d.mts +175 -19
- package/dist/index.d.ts +175 -19
- package/dist/index.js +68 -0
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +68 -0
- package/dist/index.mjs.map +1 -1
- package/package.json +11 -11
package/dist/index.d.ts
CHANGED
|
@@ -569,7 +569,7 @@ type components = {
|
|
|
569
569
|
*/
|
|
570
570
|
readonly wireFeeCents: number;
|
|
571
571
|
/**
|
|
572
|
-
* @description Per-
|
|
572
|
+
* @description Per-SEPA transaction fee in cents
|
|
573
573
|
* @example 150
|
|
574
574
|
*/
|
|
575
575
|
readonly sepaFeeCents: number;
|
|
@@ -743,7 +743,7 @@ type components = {
|
|
|
743
743
|
readonly idempotency_key?: string | null;
|
|
744
744
|
};
|
|
745
745
|
readonly EventData: {
|
|
746
|
-
/** @description Event resource snapshot after provider-field sanitization. */
|
|
746
|
+
/** @description Event resource snapshot after provider-field sanitization. The shape varies by event type; see the `GET /events` example responses for representative payloads. */
|
|
747
747
|
readonly object: {
|
|
748
748
|
readonly [key: string]: unknown;
|
|
749
749
|
};
|
|
@@ -980,6 +980,18 @@ type components = {
|
|
|
980
980
|
readonly provider_statuses?: readonly components["schemas"]["ProviderKybStatus"][];
|
|
981
981
|
/** @description ID of the KYB application associated with this customer */
|
|
982
982
|
readonly application_id?: components["schemas"]["KSUID"];
|
|
983
|
+
/**
|
|
984
|
+
* @description Current lifecycle state of the customer's onboarding application
|
|
985
|
+
* (e.g. `pending`, `submitted`, `under_review`, `approved`,
|
|
986
|
+
* `declined`). Omitted when the customer has no application.
|
|
987
|
+
*
|
|
988
|
+
* Use this field to drive workflow UI — it tracks where the
|
|
989
|
+
* customer is in the onboarding flow. For the orthogonal questions
|
|
990
|
+
* "is this customer cleared to transact?" and "what's the
|
|
991
|
+
* provider-agnostic KYC verdict?", see `kyb_status` and
|
|
992
|
+
* `kyc_status` respectively.
|
|
993
|
+
*/
|
|
994
|
+
readonly application_status?: components["schemas"]["ApplicationStatus"];
|
|
983
995
|
/**
|
|
984
996
|
* @description Application decision status
|
|
985
997
|
* @example approved
|
|
@@ -1131,10 +1143,15 @@ type components = {
|
|
|
1131
1143
|
* - `approved` - Application approved
|
|
1132
1144
|
* - `declined` - Application declined
|
|
1133
1145
|
* - `completed` - Legacy status (deprecated, use approved/declined instead)
|
|
1146
|
+
* - `compliance_review` - Application is awaiting compliance review of a Proof of Address
|
|
1147
|
+
* document. Set when an individual applicant uploads a PoA-equivalent document
|
|
1148
|
+
* (proof_of_address, bank_statement, or utility_bill) after their application has
|
|
1149
|
+
* already been approved or completed. The customer remains active but is subject to
|
|
1150
|
+
* the $3,000 USD-equivalent rolling 7-day transaction limit until the review concludes.
|
|
1134
1151
|
* @example submitted
|
|
1135
1152
|
* @enum {string}
|
|
1136
1153
|
*/
|
|
1137
|
-
readonly ApplicationStatus: "pending" | "submitted" | "under_review" | "request_for_information" | "admin_revision" | "approved" | "declined" | "completed";
|
|
1154
|
+
readonly ApplicationStatus: "pending" | "submitted" | "under_review" | "request_for_information" | "admin_revision" | "approved" | "declined" | "completed" | "compliance_review";
|
|
1138
1155
|
/**
|
|
1139
1156
|
* Family
|
|
1140
1157
|
* @description Blockchain family for the crypto account.
|
|
@@ -1148,7 +1165,7 @@ type components = {
|
|
|
1148
1165
|
* @example ach
|
|
1149
1166
|
* @enum {string}
|
|
1150
1167
|
*/
|
|
1151
|
-
readonly PaymentCapability: "ach" | "fedwire" | "swift" | "us_bank_account";
|
|
1168
|
+
readonly PaymentCapability: "ach" | "fedwire" | "swift" | "sepa" | "us_bank_account";
|
|
1152
1169
|
/**
|
|
1153
1170
|
* Transaction Status
|
|
1154
1171
|
* @description Current status of a transaction.
|
|
@@ -1429,7 +1446,7 @@ type components = {
|
|
|
1429
1446
|
};
|
|
1430
1447
|
/**
|
|
1431
1448
|
* IBAN Fiat Destination Request
|
|
1432
|
-
* @description Request for creating or updating an IBAN bank account destination (for SWIFT and
|
|
1449
|
+
* @description Request for creating or updating an IBAN bank account destination (for SWIFT and SEPA transfers).
|
|
1433
1450
|
*/
|
|
1434
1451
|
readonly FiatIBANDestinationRequest: Omit<components["schemas"]["DestinationRequest"], "destination_type"> & {
|
|
1435
1452
|
/**
|
|
@@ -1450,7 +1467,7 @@ type components = {
|
|
|
1450
1467
|
*/
|
|
1451
1468
|
readonly iban: string;
|
|
1452
1469
|
/**
|
|
1453
|
-
* @description BIC/SWIFT code for the international bank account (optional for required for SWIFT).
|
|
1470
|
+
* @description BIC/SWIFT code for the international bank account (optional for SEPA, required for SWIFT).
|
|
1454
1471
|
* @example DEUTDEFFXXX
|
|
1455
1472
|
*/
|
|
1456
1473
|
readonly bic?: string;
|
|
@@ -1655,7 +1672,7 @@ type components = {
|
|
|
1655
1672
|
};
|
|
1656
1673
|
/**
|
|
1657
1674
|
* IBAN Fiat Destination Response
|
|
1658
|
-
* @description Response for an IBAN bank account destination (for SWIFT and
|
|
1675
|
+
* @description Response for an IBAN bank account destination (for SWIFT and SEPA transfers).
|
|
1659
1676
|
*/
|
|
1660
1677
|
readonly FiatIBANDestinationResponse: Omit<components["schemas"]["DestinationResponse"], "destination_type"> & {
|
|
1661
1678
|
/**
|
|
@@ -1674,7 +1691,7 @@ type components = {
|
|
|
1674
1691
|
*/
|
|
1675
1692
|
readonly iban: string;
|
|
1676
1693
|
/**
|
|
1677
|
-
* @description BIC/SWIFT code for the international bank account (optional for required for SWIFT).
|
|
1694
|
+
* @description BIC/SWIFT code for the international bank account (optional for SEPA, required for SWIFT).
|
|
1678
1695
|
* @example DEUTDEFFXXX
|
|
1679
1696
|
*/
|
|
1680
1697
|
readonly bic?: string;
|
|
@@ -2101,20 +2118,59 @@ type components = {
|
|
|
2101
2118
|
readonly PaginatedAutoTransactionResponse: components["schemas"]["PaginatedListResponse"] & {
|
|
2102
2119
|
readonly data?: readonly components["schemas"]["AutoAccountTransaction"][];
|
|
2103
2120
|
};
|
|
2121
|
+
/** @description Slim reference to a policy attached to a wallet (id + name only). */
|
|
2122
|
+
readonly AttachedPolicy: {
|
|
2123
|
+
/**
|
|
2124
|
+
* @description Policy id.
|
|
2125
|
+
* @example pol_2N4YkKpKu7M3mKpGYmF8kcJ8oZT
|
|
2126
|
+
*/
|
|
2127
|
+
readonly id: string;
|
|
2128
|
+
/**
|
|
2129
|
+
* @description Policy name.
|
|
2130
|
+
* @example High Value Transaction Policy
|
|
2131
|
+
*/
|
|
2132
|
+
readonly name: string;
|
|
2133
|
+
};
|
|
2134
|
+
/** @description Slim reference to a wallet attached to a policy or signer group (id + name + family). */
|
|
2135
|
+
readonly AttachedWallet: {
|
|
2136
|
+
readonly id: components["schemas"]["KSUID"];
|
|
2137
|
+
/**
|
|
2138
|
+
* @description Wallet name.
|
|
2139
|
+
* @example Treasury Wallet
|
|
2140
|
+
*/
|
|
2141
|
+
readonly name: string;
|
|
2142
|
+
readonly family: components["schemas"]["Family"];
|
|
2143
|
+
};
|
|
2104
2144
|
/**
|
|
2105
2145
|
* @description Transaction type for one-off transaction creation.
|
|
2106
2146
|
* @example one_off
|
|
2107
2147
|
* @enum {string}
|
|
2108
2148
|
*/
|
|
2109
2149
|
readonly OneOffTransactionType: "one_off";
|
|
2110
|
-
/**
|
|
2150
|
+
/**
|
|
2151
|
+
* @description Request to create a one-off transfer. The transfer type is determined by
|
|
2152
|
+
* the destination type referenced by `destination_id`:
|
|
2153
|
+
* - **Offramp** when the destination is a fiat bank account (fiat_us or
|
|
2154
|
+
* fiat_iban). `destination_payment_rail` is honored; `destination_network_id`
|
|
2155
|
+
* is ignored.
|
|
2156
|
+
* - **Swap** when the destination is a crypto address.
|
|
2157
|
+
* `destination_network_id` is required and selects the destination
|
|
2158
|
+
* chain.
|
|
2159
|
+
*
|
|
2160
|
+
* The platform generates a single-use deposit address and finalizes the
|
|
2161
|
+
* transfer once the source-asset deposit arrives.
|
|
2162
|
+
*/
|
|
2111
2163
|
readonly OneOffTransactionRequest: {
|
|
2112
2164
|
readonly transaction_type?: components["schemas"]["OneOffTransactionType"];
|
|
2113
2165
|
/**
|
|
2114
|
-
* @description
|
|
2166
|
+
* @description Optional expected destination amount as a decimal string. When
|
|
2167
|
+
* omitted, the resulting transaction's destination amount is
|
|
2168
|
+
* populated from the actual deposit once funds arrive. When
|
|
2169
|
+
* provided, must be at least 0.01 and is enforced by sandbox
|
|
2170
|
+
* amount caps where applicable.
|
|
2115
2171
|
* @example 1.23
|
|
2116
2172
|
*/
|
|
2117
|
-
readonly amount
|
|
2173
|
+
readonly amount?: string;
|
|
2118
2174
|
readonly customer_id: components["schemas"]["KSUID"];
|
|
2119
2175
|
readonly source_network_id: components["schemas"]["NetworkId"];
|
|
2120
2176
|
/**
|
|
@@ -2125,14 +2181,14 @@ type components = {
|
|
|
2125
2181
|
readonly destination_id: components["schemas"]["KSUID"];
|
|
2126
2182
|
readonly destination_network_id?: components["schemas"]["NetworkId"];
|
|
2127
2183
|
/**
|
|
2128
|
-
* @description Destination fiat currency
|
|
2184
|
+
* @description Destination asset symbol. For offramps this is a fiat currency (e.g. `USD`, `EUR`). For swaps this is the destination stablecoin (e.g. `USDC`, `DKUSD`).
|
|
2129
2185
|
* @example USD
|
|
2130
2186
|
*/
|
|
2131
2187
|
readonly destination_asset: string;
|
|
2132
|
-
/** @description Optional preferred payment rail for bank transfers. If not specified, the system will automatically select the most appropriate rail based on the destination's supported methods. */
|
|
2188
|
+
/** @description Optional preferred payment rail for bank transfers (offramp). Ignored when the destination is a crypto address. If not specified, the system will automatically select the most appropriate rail based on the destination's supported methods. */
|
|
2133
2189
|
readonly destination_payment_rail?: components["schemas"]["PaymentCapability"];
|
|
2134
2190
|
/**
|
|
2135
|
-
* @description Optional payment reference message for bank transfers. Length limits: ACH (1-10 chars), Wire (1-140 chars) (6-140 chars), SWIFT (1-140 chars, max 4 lines of 35 chars each)
|
|
2191
|
+
* @description Optional payment reference message for bank transfers. Length limits: ACH (1-10 chars), Wire (1-140 chars), SEPA (6-140 chars), SWIFT (1-140 chars, max 4 lines of 35 chars each)
|
|
2136
2192
|
* @example Invoice payment for services
|
|
2137
2193
|
*/
|
|
2138
2194
|
readonly payment_reference?: string;
|
|
@@ -2143,7 +2199,7 @@ type components = {
|
|
|
2143
2199
|
*/
|
|
2144
2200
|
readonly developer_fee_bps?: number;
|
|
2145
2201
|
};
|
|
2146
|
-
/** @description A one-off transaction response. Used for single
|
|
2202
|
+
/** @description A one-off transaction response. Used for single-use offramp (crypto-to-fiat) and swap (crypto-to-crypto) transfers; the destination type determines which. */
|
|
2147
2203
|
readonly OneOffTransaction: {
|
|
2148
2204
|
readonly id: components["schemas"]["KSUID"];
|
|
2149
2205
|
/**
|
|
@@ -2180,6 +2236,7 @@ type components = {
|
|
|
2180
2236
|
readonly failure_reason?: string;
|
|
2181
2237
|
readonly receipt?: components["schemas"]["TransactionReceipt"];
|
|
2182
2238
|
readonly crypto_details?: components["schemas"]["TransactionCryptoDetails"];
|
|
2239
|
+
readonly sender_details?: components["schemas"]["SenderDetails"];
|
|
2183
2240
|
/**
|
|
2184
2241
|
* @description Unix timestamp when the transaction was created
|
|
2185
2242
|
* @example 1234567890
|
|
@@ -2197,7 +2254,7 @@ type components = {
|
|
|
2197
2254
|
readonly completed_at?: number;
|
|
2198
2255
|
/** @description The payment rail that was selected for this transaction */
|
|
2199
2256
|
readonly destination_payment_rail?: components["schemas"]["PaymentCapability"];
|
|
2200
|
-
/** @description Payment reference message for bank transfers (e.g. wire message, SWIFT reference) */
|
|
2257
|
+
/** @description Payment reference message for bank transfers (e.g. wire message, SWIFT or SEPA reference) */
|
|
2201
2258
|
readonly payment_reference?: string | null;
|
|
2202
2259
|
/**
|
|
2203
2260
|
* @description Name of the destination bank
|
|
@@ -2279,6 +2336,8 @@ type components = {
|
|
|
2279
2336
|
readonly id: components["schemas"]["KSUID"];
|
|
2280
2337
|
readonly client_id: components["schemas"]["KSUID"];
|
|
2281
2338
|
readonly customer_id?: components["schemas"]["KSUID"];
|
|
2339
|
+
/** @description Customer name joined server-side. Populated on GET responses; omitted from create responses. */
|
|
2340
|
+
readonly customer_name?: string | null;
|
|
2282
2341
|
readonly family: components["schemas"]["Family"];
|
|
2283
2342
|
/**
|
|
2284
2343
|
* @description The wallet address, same across all networks within the same family
|
|
@@ -2290,6 +2349,8 @@ type components = {
|
|
|
2290
2349
|
* @example My Wallet
|
|
2291
2350
|
*/
|
|
2292
2351
|
readonly name: string;
|
|
2352
|
+
/** @description Created-at unix timestamp. Populated on GET responses. */
|
|
2353
|
+
readonly created_at?: number;
|
|
2293
2354
|
};
|
|
2294
2355
|
/** @description Request to create a new non-custodial wallet */
|
|
2295
2356
|
readonly WalletCreateRequest: {
|
|
@@ -2556,6 +2617,21 @@ type components = {
|
|
|
2556
2617
|
readonly operation: components["schemas"]["TransactionOperation"];
|
|
2557
2618
|
/** @description A unique key to ensure idempotency of the request */
|
|
2558
2619
|
readonly idempotency_key: string;
|
|
2620
|
+
/**
|
|
2621
|
+
* @description Optional opaque SHA-256d digest (base64-encoded) of an upstream
|
|
2622
|
+
* operator-meaningful context envelope produced by the originating
|
|
2623
|
+
* service (e.g. financial-account).
|
|
2624
|
+
*
|
|
2625
|
+
* Neither platform nor policy-engine interprets the semantic
|
|
2626
|
+
* content. Policy-engine includes the field in canonical hashing
|
|
2627
|
+
* so the WebAuthn signature commits to it; beyond that the digest
|
|
2628
|
+
* is never read, validated, or logged. The pre-image is persisted
|
|
2629
|
+
* upstream and exists for forensic / non-repudiation purposes
|
|
2630
|
+
* (see ENG-1962).
|
|
2631
|
+
*
|
|
2632
|
+
* Intents predating this field validate as today (empty / omitted).
|
|
2633
|
+
*/
|
|
2634
|
+
readonly context_digest?: string;
|
|
2559
2635
|
};
|
|
2560
2636
|
readonly TransactionOperation: {
|
|
2561
2637
|
/** @description Transaction type: transfer or contract call */
|
|
@@ -2564,7 +2640,12 @@ type components = {
|
|
|
2564
2640
|
readonly from: string;
|
|
2565
2641
|
/** @description The recipient address of the transaction */
|
|
2566
2642
|
readonly to: string;
|
|
2567
|
-
/**
|
|
2643
|
+
/**
|
|
2644
|
+
* @description Amount to be transferred as a non-negative decimal string. Required for
|
|
2645
|
+
* transfer operations; optional for contract calls (defaults to zero).
|
|
2646
|
+
* Leading zeros, signs, commas, and non-finite values are rejected.
|
|
2647
|
+
* For transfer operations the handler additionally requires the value to be greater than zero.
|
|
2648
|
+
*/
|
|
2568
2649
|
readonly amount?: string;
|
|
2569
2650
|
/**
|
|
2570
2651
|
* @description Crypto asset symbol for the transfer or contract call.
|
|
@@ -3172,7 +3253,7 @@ type components = {
|
|
|
3172
3253
|
*/
|
|
3173
3254
|
readonly uploaded_at: string;
|
|
3174
3255
|
};
|
|
3175
|
-
/** @description Information about a
|
|
3256
|
+
/** @description Information about a missing document the applicant has not yet uploaded. Includes both required documents (whose absence blocks readiness) and optional ones (e.g. Proof of Address for individuals when the PoA-optional flow is enabled — surfaced so the UI can render an upload affordance without gating submission). */
|
|
3176
3257
|
readonly MissingDocument: {
|
|
3177
3258
|
/**
|
|
3178
3259
|
* @description The purpose this document serves in the onboarding requirements
|
|
@@ -3192,6 +3273,11 @@ type components = {
|
|
|
3192
3273
|
* @example Articles of Incorporation or equivalent formation document
|
|
3193
3274
|
*/
|
|
3194
3275
|
readonly description: string;
|
|
3276
|
+
/**
|
|
3277
|
+
* @description Whether this document must be uploaded for the application to be ready for review. When false, the document is optional — typically because an alternative gating mechanism applies (e.g. the post-onboarding $3,000 / 7-day rolling-window threshold for Proof of Address on individual applications under the PoA-optional flow).
|
|
3278
|
+
* @example true
|
|
3279
|
+
*/
|
|
3280
|
+
readonly required?: boolean;
|
|
3195
3281
|
};
|
|
3196
3282
|
/** @description Document status information for an applicant entity */
|
|
3197
3283
|
readonly DocumentInfo: {
|
|
@@ -3963,6 +4049,24 @@ type components = {
|
|
|
3963
4049
|
readonly validation?: components["schemas"]["ApplicationValidation"];
|
|
3964
4050
|
/** @description Risk rating (only present for superadmin users) */
|
|
3965
4051
|
readonly risk_rating?: components["schemas"]["RiskRating"];
|
|
4052
|
+
/**
|
|
4053
|
+
* @description Tracks the review state of the Proof of Address for individual applications.
|
|
4054
|
+
* Null for business applications and for non-primary-individual rows.
|
|
4055
|
+
*
|
|
4056
|
+
* - `missing` — No Proof of Address has been submitted. The individual is subject
|
|
4057
|
+
* to the $3,000 USD-equivalent rolling 7-day transaction limit.
|
|
4058
|
+
* - `submitted_pending_review` — A PoA-equivalent document (proof_of_address,
|
|
4059
|
+
* bank_statement, or utility_bill) has been uploaded and is awaiting compliance
|
|
4060
|
+
* review. The individual remains subject to the transaction limit until the review
|
|
4061
|
+
* concludes.
|
|
4062
|
+
* - `approved` — The Proof of Address has been reviewed and approved. The individual
|
|
4063
|
+
* is exempt from the $3,000 / 7-day rolling transaction threshold.
|
|
4064
|
+
* - `rejected` — The submitted Proof of Address was rejected. The individual
|
|
4065
|
+
* remains subject to the transaction limit and may re-upload a new document.
|
|
4066
|
+
* @example missing
|
|
4067
|
+
* @enum {string|null}
|
|
4068
|
+
*/
|
|
4069
|
+
readonly poa_status?: "missing" | "submitted_pending_review" | "approved" | "rejected" | null;
|
|
3966
4070
|
};
|
|
3967
4071
|
/** @description Lightweight business info for list views */
|
|
3968
4072
|
readonly BusinessListItem: {
|
|
@@ -4550,6 +4654,10 @@ type WalletBalances = components['schemas']['WalletBalances'];
|
|
|
4550
4654
|
type WalletTransactionRequest = components['schemas']['SendTransactionIntent'];
|
|
4551
4655
|
/** Wallet transaction response */
|
|
4552
4656
|
type WalletTransaction = components['schemas']['WalletTransaction'];
|
|
4657
|
+
/** Slim reference to a policy attached to a wallet (id + name) */
|
|
4658
|
+
type AttachedPolicy = components['schemas']['AttachedPolicy'];
|
|
4659
|
+
/** Slim reference to a wallet attached to a policy or signer group (id + name + family) */
|
|
4660
|
+
type AttachedWallet = components['schemas']['AttachedWallet'];
|
|
4553
4661
|
/** Event */
|
|
4554
4662
|
type Event = components['schemas']['Event'];
|
|
4555
4663
|
/** Event type */
|
|
@@ -5594,6 +5702,36 @@ declare class WalletsResource extends BaseResource {
|
|
|
5594
5702
|
* ```
|
|
5595
5703
|
*/
|
|
5596
5704
|
create(data: WalletCreateRequest, options?: RequestOptions): Promise<Wallet>;
|
|
5705
|
+
/**
|
|
5706
|
+
* Get a single wallet by ID.
|
|
5707
|
+
*
|
|
5708
|
+
* @param walletId - Wallet ID
|
|
5709
|
+
* @returns Wallet record (includes `customer_name` and `created_at`)
|
|
5710
|
+
*
|
|
5711
|
+
* @example
|
|
5712
|
+
* ```typescript
|
|
5713
|
+
* const wallet = await client.wallets.get(walletId);
|
|
5714
|
+
* console.log(wallet.address, wallet.customer_name);
|
|
5715
|
+
* ```
|
|
5716
|
+
*/
|
|
5717
|
+
get(walletId: string): Promise<Wallet>;
|
|
5718
|
+
/**
|
|
5719
|
+
* Get policies attached to a wallet.
|
|
5720
|
+
*
|
|
5721
|
+
* Returns slim references (id + name) for the policies currently attached to the wallet.
|
|
5722
|
+
*
|
|
5723
|
+
* @param walletId - Wallet ID
|
|
5724
|
+
* @returns Array of attached policies
|
|
5725
|
+
*
|
|
5726
|
+
* @example
|
|
5727
|
+
* ```typescript
|
|
5728
|
+
* const policies = await client.wallets.getPolicies(walletId);
|
|
5729
|
+
* for (const policy of policies) {
|
|
5730
|
+
* console.log(policy.id, policy.name);
|
|
5731
|
+
* }
|
|
5732
|
+
* ```
|
|
5733
|
+
*/
|
|
5734
|
+
getPolicies(walletId: string): Promise<AttachedPolicy[]>;
|
|
5597
5735
|
/**
|
|
5598
5736
|
* Get wallet balances.
|
|
5599
5737
|
*
|
|
@@ -5912,6 +6050,15 @@ declare class PoliciesResource extends BaseResource {
|
|
|
5912
6050
|
* @param ruleId - Rule ID
|
|
5913
6051
|
*/
|
|
5914
6052
|
deleteRule(policyId: string, ruleId: string): Promise<void>;
|
|
6053
|
+
/**
|
|
6054
|
+
* Get wallets attached to a policy.
|
|
6055
|
+
*
|
|
6056
|
+
* Returns slim references (id + name + family) for the wallets the policy is currently attached to.
|
|
6057
|
+
*
|
|
6058
|
+
* @param policyId - Policy ID
|
|
6059
|
+
* @returns Array of attached wallets
|
|
6060
|
+
*/
|
|
6061
|
+
getWallets(policyId: string): Promise<AttachedWallet[]>;
|
|
5915
6062
|
/**
|
|
5916
6063
|
* Attach a policy to a wallet.
|
|
5917
6064
|
*
|
|
@@ -5972,6 +6119,15 @@ declare class SignerGroupsResource extends BaseResource {
|
|
|
5972
6119
|
* @param signerId - Signer ID
|
|
5973
6120
|
*/
|
|
5974
6121
|
removeSigner(signerGroupId: string, signerId: string): Promise<void>;
|
|
6122
|
+
/**
|
|
6123
|
+
* Get wallets attached to a signer group.
|
|
6124
|
+
*
|
|
6125
|
+
* Returns slim references (id + name + family) for the wallets the signer group is currently attached to.
|
|
6126
|
+
*
|
|
6127
|
+
* @param signerGroupId - Signer group ID
|
|
6128
|
+
* @returns Array of attached wallets
|
|
6129
|
+
*/
|
|
6130
|
+
getWallets(signerGroupId: string): Promise<AttachedWallet[]>;
|
|
5975
6131
|
/**
|
|
5976
6132
|
* Attach a signer group to a wallet.
|
|
5977
6133
|
*
|
|
@@ -6673,4 +6829,4 @@ declare class ConfigurationError extends Error {
|
|
|
6673
6829
|
constructor(message: string);
|
|
6674
6830
|
}
|
|
6675
6831
|
|
|
6676
|
-
export { APIError, type Account, type AccountCreateRequest, type AccountListParams, type AccountUpdateRequest, AccountsResource, type Address, type AdvanceSimulationRequest, type AdvanceSimulationResult, type ApiKey, type ApiKeyCreateRequest, type ApiKeyResponse, ApiKeysResource, type Application, type ApplicationDocumentType, type ApplicationDocumentUploadRequest, type ApplicationDocumentUploadUrlRequest, type ApplicationListItem, type ApplicationStatus, type ApplicationSubmissionRequest, ApplicationsResource, type AssociatedIndividual, type AssociatedIndividualRequest, type AttestationSubmitRequest, type AttestationType, AuthMode, type AutoTransaction, AutoTransactionsResource, type AverageMonthlyRevenue, type BulkImportSumsubTokensRequest, type BulkImportSumsubTokensResponse, type BulkImportSumsubTokensResult, type BusinessApplicationCreateRequest, type BusinessDetailsResponse, type BusinessPurposeOfAccount, type BusinessSourceOfFunds, type ClientPricingConfig, ConfigurationError, type Country, type CreateApiKeyForClientRequest, type CryptoDestination, type CryptoDestinationRequest, type CursorExtractor, type Customer, type CustomerCreateRequest, type CustomerCreateResponse, type CustomerListParams, CustomersResource, DEFAULT_RETRY_POLICY, DakotaClient, type DakotaClientConfig, type Destination, type DestinationRequest, DestinationsResource, type DocumentUploadResponse, type DocumentUploadUrlResponse, type EDDRequest, type EDDWithApplicationID, type EmploymentStatus, Environment, type Event, type EventListParams, type EventType, EventsResource, type ExpectedMonthlyDeposit, type Family, type FiatUSDestination, type FiatUSDestinationRequest, type IndividualDetailsResponse, type IndividualDocumentType, type IndividualDocumentUploadRequest, type IndividualDocumentUploadUrlRequest, type IndividualRequest, type IndividualRole, type IndividualTitle, InfoResource, type KSUID, type KybStatus, type LegalStructure, type ListParams, type Logger, type Meta, type Network, type NetworkId, type OfframpAccount, type OfframpAccountCreateRequest, type OneOffTransaction, type OneOffTransactionRequest, type OnrampAccount, type OnrampAccountCreateRequest, type PageFetcher, PaginatedIterator, type PaginatedResponse, type PaginationMeta, type PaginationParams, type PaymentCapability, type PersonName, PoliciesResource, type Policy, type PolicyCreateRequest, type PolicyRule, type PolicyRuleCreateRequest, type Recipient, type RecipientRequest, type RecipientUpdateRequest, RecipientsResource, type RequestOptions, type ResolvedConfig, type RetryPolicy, SandboxResource, type SandboxScenario, type SelfServeCreditTier, type SelfServeCreditTiersResponse, type SelfServeCreditsBalanceResponse, type SelfServeCreditsLedgerEntry, type SelfServeCreditsLedgerEntryType, type SelfServeCreditsLedgerParams, type SelfServeCreditsLedgerResponse, type SelfServeCreditsPricingResponse, type SelfServeCreditsPurchaseRequest, type SelfServeCreditsPurchaseResponse, SelfServeResource, type Signer, type SignerCreateRequest, type SignerGroup, type SignerGroupCreateRequest, SignerGroupsResource, SignersResource, type SimulateInboundRequest, type SimulateInboundType, type SimulateOnboardingRequest, type SimulateOnboardingResponse, type SimulateOnboardingType, type SimulationCallbackRecord, type SimulationInspection, type SimulationResponse, type SubClientSummary, type SwapAccount, type SwapAccountCreateRequest, type TransactionListParams, type TransactionStatus, TransactionsResource, TransportError, type UpdateCustomerSubClientRequest, type UploadedDocumentMetadata, type User, type UserCreateRequest, type UserUpdateRequest, UsersResource, type Wallet, type WalletBalance, type WalletBalances, type WalletCreateRequest, type WalletTransaction, type WalletTransactionRequest, WalletsResource, type WebhookEvent, type WebhookHistoryList, type WebhookHistoryListParams, type WebhookHistoryResponse, type WebhookReplayResponse, type WebhookTarget, type WebhookTargetCreateRequest, type WebhookTargetUpdateRequest, WebhooksResource, consoleLogger, getEnvironmentURL, noopLogger, paginate };
|
|
6832
|
+
export { APIError, type Account, type AccountCreateRequest, type AccountListParams, type AccountUpdateRequest, AccountsResource, type Address, type AdvanceSimulationRequest, type AdvanceSimulationResult, type ApiKey, type ApiKeyCreateRequest, type ApiKeyResponse, ApiKeysResource, type Application, type ApplicationDocumentType, type ApplicationDocumentUploadRequest, type ApplicationDocumentUploadUrlRequest, type ApplicationListItem, type ApplicationStatus, type ApplicationSubmissionRequest, ApplicationsResource, type AssociatedIndividual, type AssociatedIndividualRequest, type AttachedPolicy, type AttachedWallet, type AttestationSubmitRequest, type AttestationType, AuthMode, type AutoTransaction, AutoTransactionsResource, type AverageMonthlyRevenue, type BulkImportSumsubTokensRequest, type BulkImportSumsubTokensResponse, type BulkImportSumsubTokensResult, type BusinessApplicationCreateRequest, type BusinessDetailsResponse, type BusinessPurposeOfAccount, type BusinessSourceOfFunds, type ClientPricingConfig, ConfigurationError, type Country, type CreateApiKeyForClientRequest, type CryptoDestination, type CryptoDestinationRequest, type CursorExtractor, type Customer, type CustomerCreateRequest, type CustomerCreateResponse, type CustomerListParams, CustomersResource, DEFAULT_RETRY_POLICY, DakotaClient, type DakotaClientConfig, type Destination, type DestinationRequest, DestinationsResource, type DocumentUploadResponse, type DocumentUploadUrlResponse, type EDDRequest, type EDDWithApplicationID, type EmploymentStatus, Environment, type Event, type EventListParams, type EventType, EventsResource, type ExpectedMonthlyDeposit, type Family, type FiatUSDestination, type FiatUSDestinationRequest, type IndividualDetailsResponse, type IndividualDocumentType, type IndividualDocumentUploadRequest, type IndividualDocumentUploadUrlRequest, type IndividualRequest, type IndividualRole, type IndividualTitle, InfoResource, type KSUID, type KybStatus, type LegalStructure, type ListParams, type Logger, type Meta, type Network, type NetworkId, type OfframpAccount, type OfframpAccountCreateRequest, type OneOffTransaction, type OneOffTransactionRequest, type OnrampAccount, type OnrampAccountCreateRequest, type PageFetcher, PaginatedIterator, type PaginatedResponse, type PaginationMeta, type PaginationParams, type PaymentCapability, type PersonName, PoliciesResource, type Policy, type PolicyCreateRequest, type PolicyRule, type PolicyRuleCreateRequest, type Recipient, type RecipientRequest, type RecipientUpdateRequest, RecipientsResource, type RequestOptions, type ResolvedConfig, type RetryPolicy, SandboxResource, type SandboxScenario, type SelfServeCreditTier, type SelfServeCreditTiersResponse, type SelfServeCreditsBalanceResponse, type SelfServeCreditsLedgerEntry, type SelfServeCreditsLedgerEntryType, type SelfServeCreditsLedgerParams, type SelfServeCreditsLedgerResponse, type SelfServeCreditsPricingResponse, type SelfServeCreditsPurchaseRequest, type SelfServeCreditsPurchaseResponse, SelfServeResource, type Signer, type SignerCreateRequest, type SignerGroup, type SignerGroupCreateRequest, SignerGroupsResource, SignersResource, type SimulateInboundRequest, type SimulateInboundType, type SimulateOnboardingRequest, type SimulateOnboardingResponse, type SimulateOnboardingType, type SimulationCallbackRecord, type SimulationInspection, type SimulationResponse, type SubClientSummary, type SwapAccount, type SwapAccountCreateRequest, type TransactionListParams, type TransactionStatus, TransactionsResource, TransportError, type UpdateCustomerSubClientRequest, type UploadedDocumentMetadata, type User, type UserCreateRequest, type UserUpdateRequest, UsersResource, type Wallet, type WalletBalance, type WalletBalances, type WalletCreateRequest, type WalletTransaction, type WalletTransactionRequest, WalletsResource, type WebhookEvent, type WebhookHistoryList, type WebhookHistoryListParams, type WebhookHistoryResponse, type WebhookReplayResponse, type WebhookTarget, type WebhookTargetCreateRequest, type WebhookTargetUpdateRequest, WebhooksResource, consoleLogger, getEnvironmentURL, noopLogger, paginate };
|
package/dist/index.js
CHANGED
|
@@ -1212,6 +1212,46 @@ var WalletsResource = class extends BaseResource {
|
|
|
1212
1212
|
idempotencyKey: options?.idempotencyKey
|
|
1213
1213
|
});
|
|
1214
1214
|
}
|
|
1215
|
+
/**
|
|
1216
|
+
* Get a single wallet by ID.
|
|
1217
|
+
*
|
|
1218
|
+
* @param walletId - Wallet ID
|
|
1219
|
+
* @returns Wallet record (includes `customer_name` and `created_at`)
|
|
1220
|
+
*
|
|
1221
|
+
* @example
|
|
1222
|
+
* ```typescript
|
|
1223
|
+
* const wallet = await client.wallets.get(walletId);
|
|
1224
|
+
* console.log(wallet.address, wallet.customer_name);
|
|
1225
|
+
* ```
|
|
1226
|
+
*/
|
|
1227
|
+
async get(walletId) {
|
|
1228
|
+
return this.transport.request({
|
|
1229
|
+
method: "GET",
|
|
1230
|
+
path: `/wallets/${walletId}`
|
|
1231
|
+
});
|
|
1232
|
+
}
|
|
1233
|
+
/**
|
|
1234
|
+
* Get policies attached to a wallet.
|
|
1235
|
+
*
|
|
1236
|
+
* Returns slim references (id + name) for the policies currently attached to the wallet.
|
|
1237
|
+
*
|
|
1238
|
+
* @param walletId - Wallet ID
|
|
1239
|
+
* @returns Array of attached policies
|
|
1240
|
+
*
|
|
1241
|
+
* @example
|
|
1242
|
+
* ```typescript
|
|
1243
|
+
* const policies = await client.wallets.getPolicies(walletId);
|
|
1244
|
+
* for (const policy of policies) {
|
|
1245
|
+
* console.log(policy.id, policy.name);
|
|
1246
|
+
* }
|
|
1247
|
+
* ```
|
|
1248
|
+
*/
|
|
1249
|
+
async getPolicies(walletId) {
|
|
1250
|
+
return this.transport.request({
|
|
1251
|
+
method: "GET",
|
|
1252
|
+
path: `/wallets/${walletId}/policies`
|
|
1253
|
+
});
|
|
1254
|
+
}
|
|
1215
1255
|
/**
|
|
1216
1256
|
* Get wallet balances.
|
|
1217
1257
|
*
|
|
@@ -1697,6 +1737,20 @@ var PoliciesResource = class extends BaseResource {
|
|
|
1697
1737
|
path: `/policies/${policyId}/rules/${ruleId}`
|
|
1698
1738
|
});
|
|
1699
1739
|
}
|
|
1740
|
+
/**
|
|
1741
|
+
* Get wallets attached to a policy.
|
|
1742
|
+
*
|
|
1743
|
+
* Returns slim references (id + name + family) for the wallets the policy is currently attached to.
|
|
1744
|
+
*
|
|
1745
|
+
* @param policyId - Policy ID
|
|
1746
|
+
* @returns Array of attached wallets
|
|
1747
|
+
*/
|
|
1748
|
+
async getWallets(policyId) {
|
|
1749
|
+
return this.transport.request({
|
|
1750
|
+
method: "GET",
|
|
1751
|
+
path: `/policies/${policyId}/wallets`
|
|
1752
|
+
});
|
|
1753
|
+
}
|
|
1700
1754
|
/**
|
|
1701
1755
|
* Attach a policy to a wallet.
|
|
1702
1756
|
*
|
|
@@ -1788,6 +1842,20 @@ var SignerGroupsResource = class extends BaseResource {
|
|
|
1788
1842
|
path: `/signer-groups/${signerGroupId}/signers/${signerId}`
|
|
1789
1843
|
});
|
|
1790
1844
|
}
|
|
1845
|
+
/**
|
|
1846
|
+
* Get wallets attached to a signer group.
|
|
1847
|
+
*
|
|
1848
|
+
* Returns slim references (id + name + family) for the wallets the signer group is currently attached to.
|
|
1849
|
+
*
|
|
1850
|
+
* @param signerGroupId - Signer group ID
|
|
1851
|
+
* @returns Array of attached wallets
|
|
1852
|
+
*/
|
|
1853
|
+
async getWallets(signerGroupId) {
|
|
1854
|
+
return this.transport.request({
|
|
1855
|
+
method: "GET",
|
|
1856
|
+
path: `/signer-groups/${signerGroupId}/wallets`
|
|
1857
|
+
});
|
|
1858
|
+
}
|
|
1791
1859
|
/**
|
|
1792
1860
|
* Attach a signer group to a wallet.
|
|
1793
1861
|
*
|