@dakota-xyz/ts-sdk 1.0.17 → 1.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.
- package/dist/index.d.mts +605 -91
- package/dist/index.d.ts +605 -91
- package/dist/index.js +506 -83
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +506 -84
- package/dist/index.mjs.map +1 -1
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -429,6 +429,73 @@ type components = {
|
|
|
429
429
|
*/
|
|
430
430
|
readonly decimals: number;
|
|
431
431
|
};
|
|
432
|
+
readonly SelfServeCreditsBalanceResponse: {
|
|
433
|
+
/**
|
|
434
|
+
* Format: int64
|
|
435
|
+
* @example 45000
|
|
436
|
+
*/
|
|
437
|
+
readonly balance_cents: number;
|
|
438
|
+
/**
|
|
439
|
+
* Format: int64
|
|
440
|
+
* @example 9000000
|
|
441
|
+
*/
|
|
442
|
+
readonly transfer_capacity_cents: number;
|
|
443
|
+
};
|
|
444
|
+
readonly SelfServeCreditsLedgerEntry: {
|
|
445
|
+
/** @example 34o8dS2h9c7n1V8qLpY2Zx6TwUa */
|
|
446
|
+
readonly id: string;
|
|
447
|
+
/** @enum {string} */
|
|
448
|
+
readonly entry_type: "purchase" | "deduction" | "refund";
|
|
449
|
+
/**
|
|
450
|
+
* Format: int64
|
|
451
|
+
* @example -5000
|
|
452
|
+
*/
|
|
453
|
+
readonly amount_cents: number;
|
|
454
|
+
/**
|
|
455
|
+
* Format: int64
|
|
456
|
+
* @example 45000
|
|
457
|
+
*/
|
|
458
|
+
readonly balance_after_cents: number;
|
|
459
|
+
readonly transaction_id?: string | null;
|
|
460
|
+
/** @example Transfer fee for transaction txn_123 */
|
|
461
|
+
readonly description: string;
|
|
462
|
+
/** Format: date-time */
|
|
463
|
+
readonly created_at: string;
|
|
464
|
+
};
|
|
465
|
+
readonly SelfServeCreditsLedgerResponse: {
|
|
466
|
+
readonly entries: readonly components["schemas"]["SelfServeCreditsLedgerEntry"][];
|
|
467
|
+
/** @example false */
|
|
468
|
+
readonly has_more: boolean;
|
|
469
|
+
};
|
|
470
|
+
readonly SelfServeCreditTier: {
|
|
471
|
+
/**
|
|
472
|
+
* Format: int64
|
|
473
|
+
* @example 10000
|
|
474
|
+
*/
|
|
475
|
+
readonly price_cents: number;
|
|
476
|
+
/**
|
|
477
|
+
* Format: int64
|
|
478
|
+
* @example 2000000
|
|
479
|
+
*/
|
|
480
|
+
readonly transfer_capacity_cents: number;
|
|
481
|
+
};
|
|
482
|
+
readonly SelfServeCreditTiersResponse: {
|
|
483
|
+
readonly tiers: readonly components["schemas"]["SelfServeCreditTier"][];
|
|
484
|
+
};
|
|
485
|
+
readonly SelfServeCreditsPurchaseRequest: {
|
|
486
|
+
/**
|
|
487
|
+
* Format: int64
|
|
488
|
+
* @example 10000
|
|
489
|
+
*/
|
|
490
|
+
readonly tier_price_cents: number;
|
|
491
|
+
};
|
|
492
|
+
readonly SelfServeCreditsPurchaseResponse: {
|
|
493
|
+
/**
|
|
494
|
+
* Format: uri
|
|
495
|
+
* @example https://checkout.stripe.com/c/pay/cs_test_123
|
|
496
|
+
*/
|
|
497
|
+
readonly checkout_url: string;
|
|
498
|
+
};
|
|
432
499
|
/** @description User object representing a user in the system, including all clients they can access. */
|
|
433
500
|
readonly ClientUser: {
|
|
434
501
|
readonly id: components["schemas"]["KSUID"];
|
|
@@ -457,7 +524,7 @@ type components = {
|
|
|
457
524
|
readonly created_at: number;
|
|
458
525
|
};
|
|
459
526
|
/**
|
|
460
|
-
* @description Role that can be assigned to a client user
|
|
527
|
+
* @description Role that can be assigned to a client user. Available roles: `admin` (full access except issuances) and `viewer` (read-only access).
|
|
461
528
|
* @example admin
|
|
462
529
|
* @enum {string}
|
|
463
530
|
*/
|
|
@@ -583,7 +650,7 @@ type components = {
|
|
|
583
650
|
* @example transaction.auto.updated
|
|
584
651
|
* @enum {string}
|
|
585
652
|
*/
|
|
586
|
-
readonly EventType: "user.created" | "user.updated" | "user.deleted" | "api_key.created" | "api_key.deleted" | "customer.created" | "customer.updated" | "customer.kyb_link.created" | "customer.kyb_link.updated" | "customer.kyb_status.created" | "customer.kyb_status.updated" | "auto_account.created" | "auto_account.updated" | "auto_account.deleted" | "transaction.auto.created" | "transaction.auto.updated" | "transaction.one_off.created" | "transaction.one_off.updated" | "recipient.created" | "recipient.updated" | "recipient.deleted" | "destination.created" | "destination.deleted" | "target.created" | "target.updated" | "target.deleted" | "exception.created" | "exception.cleared" | "bvnk.onboarding.created" | "bvnk.onboarding.updated" | "wallet.created" | "wallet.updated" | "wallet.signer_group.created" | "wallet.signer_group.updated" | "wallet.policy.created" | "wallet.policy.updated" | "wallet.transaction.created" | "wallet.transaction.updated" | "wallet.deposit";
|
|
653
|
+
readonly EventType: "user.created" | "user.updated" | "user.deleted" | "api_key.created" | "api_key.deleted" | "customer.created" | "customer.updated" | "customer.kyb_link.created" | "customer.kyb_link.updated" | "customer.kyb_status.created" | "customer.kyb_status.updated" | "customer.kyb_application.submitted" | "auto_account.created" | "auto_account.updated" | "auto_account.deleted" | "transaction.auto.created" | "transaction.auto.updated" | "transaction.one_off.created" | "transaction.one_off.updated" | "recipient.created" | "recipient.updated" | "recipient.deleted" | "destination.created" | "destination.deleted" | "target.created" | "target.updated" | "target.deleted" | "exception.created" | "exception.cleared" | "bvnk.onboarding.created" | "bvnk.onboarding.updated" | "wallet.created" | "wallet.updated" | "wallet.signer_group.created" | "wallet.signer_group.updated" | "wallet.policy.created" | "wallet.policy.updated" | "wallet.transaction.created" | "wallet.transaction.updated" | "wallet.deposit";
|
|
587
654
|
/** @description Request metadata for the original operation that emitted the event, when available. */
|
|
588
655
|
readonly EventRequest: {
|
|
589
656
|
/**
|
|
@@ -637,6 +704,10 @@ type components = {
|
|
|
637
704
|
* @enum {string}
|
|
638
705
|
*/
|
|
639
706
|
readonly NetworkId: "ethereum-mainnet" | "ethereum-sepolia" | "ethereum-goerli" | "ethereum-holesky" | "solana-mainnet" | "solana-devnet" | "solana-testnet" | "base-mainnet" | "base-sepolia" | "arbitrum-mainnet" | "arbitrum-sepolia" | "optimism-mainnet" | "optimism-sepolia" | "polygon-mainnet" | "polygon-amoy";
|
|
707
|
+
readonly CreateApiKeyForClientRequest: {
|
|
708
|
+
/** @description Client ID to create the API key for */
|
|
709
|
+
readonly client_id: components["schemas"]["KSUID"];
|
|
710
|
+
};
|
|
640
711
|
readonly ApiKeyResponse: {
|
|
641
712
|
readonly id: components["schemas"]["KSUID"];
|
|
642
713
|
/**
|
|
@@ -748,6 +819,8 @@ type components = {
|
|
|
748
819
|
* @example external_customer_123
|
|
749
820
|
*/
|
|
750
821
|
readonly external_id?: string;
|
|
822
|
+
/** @description ID of an existing customer to associate this new customer with as a sub-client. The referenced customer must belong to the same client. */
|
|
823
|
+
readonly sub_client_id?: components["schemas"]["KSUID"];
|
|
751
824
|
};
|
|
752
825
|
/** @description Response returned when a customer creation process is successfully initiated. */
|
|
753
826
|
readonly CustomerCreateResponse: {
|
|
@@ -821,13 +894,47 @@ type components = {
|
|
|
821
894
|
* @example 1234567890
|
|
822
895
|
*/
|
|
823
896
|
readonly deleted_at?: number;
|
|
897
|
+
/** @description ID of the sub-client this customer is associated with, if any. */
|
|
898
|
+
readonly sub_client_id?: components["schemas"]["KSUID"];
|
|
899
|
+
/**
|
|
900
|
+
* @description Name of the sub-client this customer is associated with, if any.
|
|
901
|
+
* @example Partner Corp
|
|
902
|
+
*/
|
|
903
|
+
readonly sub_client_name?: string;
|
|
904
|
+
/**
|
|
905
|
+
* @description Whether this customer is acting as a sub-client (has other customers associated with it).
|
|
906
|
+
* @default false
|
|
907
|
+
*/
|
|
908
|
+
readonly is_sub_client: boolean;
|
|
824
909
|
};
|
|
825
910
|
/**
|
|
826
911
|
* @description Overall status of the KYB verification process (e.g., pending, active, restricted).
|
|
827
912
|
* @example pending
|
|
828
913
|
* @enum {string}
|
|
829
914
|
*/
|
|
830
|
-
readonly KybStatus: "active" | "pending" | "partner_review" | "rejected" | "frozen";
|
|
915
|
+
readonly KybStatus: "active" | "pending" | "partner_review" | "rejected" | "frozen" | "auto_declined";
|
|
916
|
+
/** @description Request to update the sub-client association for a customer. Set sub_client_id to associate with a sub-client, or null to disassociate. */
|
|
917
|
+
readonly UpdateCustomerSubClientRequest: {
|
|
918
|
+
/**
|
|
919
|
+
* @description ID of the sub-client to associate with, or null to disassociate.
|
|
920
|
+
* @example 1NFHrqBHb3cTfLVkFSGmHZqdDPi
|
|
921
|
+
*/
|
|
922
|
+
readonly sub_client_id?: string | null;
|
|
923
|
+
};
|
|
924
|
+
/** @description Summary of a sub-client including the count of customers associated with it. */
|
|
925
|
+
readonly SubClientSummary: {
|
|
926
|
+
readonly sub_client_id: components["schemas"]["KSUID"];
|
|
927
|
+
/**
|
|
928
|
+
* @description Name of the customer acting as a sub-client.
|
|
929
|
+
* @example Partner Corp
|
|
930
|
+
*/
|
|
931
|
+
readonly sub_client_name: string;
|
|
932
|
+
/**
|
|
933
|
+
* @description Number of customers associated with this sub-client.
|
|
934
|
+
* @example 15
|
|
935
|
+
*/
|
|
936
|
+
readonly customer_count: number;
|
|
937
|
+
};
|
|
831
938
|
readonly ProviderKybStatus: {
|
|
832
939
|
/**
|
|
833
940
|
* @description ID of the verification provider or service used for a specific check.
|
|
@@ -839,7 +946,7 @@ type components = {
|
|
|
839
946
|
* @example approved
|
|
840
947
|
* @enum {string}
|
|
841
948
|
*/
|
|
842
|
-
readonly status: "not_started" | "in_review" | "approved" | "rejected" | "requires_info" | "frozen";
|
|
949
|
+
readonly status: "not_started" | "in_review" | "approved" | "rejected" | "requires_info" | "auto_declined" | "frozen";
|
|
843
950
|
/** @description Array of endorsements associated with this provider status. */
|
|
844
951
|
readonly endorsements?: readonly string[];
|
|
845
952
|
};
|
|
@@ -918,11 +1025,11 @@ type components = {
|
|
|
918
1025
|
readonly Family: "evm" | "solana";
|
|
919
1026
|
/**
|
|
920
1027
|
* Payment Capability
|
|
921
|
-
* @description Type of payment rail capability supported.
|
|
1028
|
+
* @description Type of payment rail capability supported. For onramp accounts, `us_bank_account` indicates the account accepts both ACH and Wire (Fedwire) deposits interchangeably.
|
|
922
1029
|
* @example ach
|
|
923
1030
|
* @enum {string}
|
|
924
1031
|
*/
|
|
925
|
-
readonly PaymentCapability: "ach" | "fedwire" | "swift" | "sepa";
|
|
1032
|
+
readonly PaymentCapability: "ach" | "fedwire" | "swift" | "sepa" | "us_bank_account";
|
|
926
1033
|
/**
|
|
927
1034
|
* Transaction Status
|
|
928
1035
|
* @description Current status of a transaction.
|
|
@@ -1483,9 +1590,14 @@ type components = {
|
|
|
1483
1590
|
*/
|
|
1484
1591
|
readonly destination_type: "fiat_iban";
|
|
1485
1592
|
};
|
|
1486
|
-
/** @description A unified transaction object representing money movements in the Dakota platform. */
|
|
1593
|
+
/** @description A unified transaction object representing money movements in the Dakota platform. Used for auto-account transactions. */
|
|
1487
1594
|
readonly Transaction: {
|
|
1488
1595
|
readonly id: components["schemas"]["KSUID"];
|
|
1596
|
+
/**
|
|
1597
|
+
* @description Discriminator field. Always "auto_account" for auto-account transactions. (enum property replaced by openapi-typescript)
|
|
1598
|
+
* @enum {string}
|
|
1599
|
+
*/
|
|
1600
|
+
readonly resource_type: "auto_account";
|
|
1489
1601
|
readonly type: components["schemas"]["TransactionType"];
|
|
1490
1602
|
readonly status: components["schemas"]["TransactionStatus"];
|
|
1491
1603
|
/**
|
|
@@ -1815,10 +1927,21 @@ type components = {
|
|
|
1815
1927
|
* @example Invoice payment for services
|
|
1816
1928
|
*/
|
|
1817
1929
|
readonly payment_reference?: string;
|
|
1930
|
+
/**
|
|
1931
|
+
* Format: int32
|
|
1932
|
+
* @description Developer fee in basis points (1 bp = 0.01%). Overrides the default client fee for this transaction.
|
|
1933
|
+
* @example 50
|
|
1934
|
+
*/
|
|
1935
|
+
readonly developer_fee_bps?: number;
|
|
1818
1936
|
};
|
|
1819
|
-
/** @description A one-off transaction response */
|
|
1937
|
+
/** @description A one-off transaction response. Used for single on/off-ramp transactions. */
|
|
1820
1938
|
readonly OneOffTransaction: {
|
|
1821
1939
|
readonly id: components["schemas"]["KSUID"];
|
|
1940
|
+
/**
|
|
1941
|
+
* @description Discriminator field. Always "one_off" for one-off transactions. (enum property replaced by openapi-typescript)
|
|
1942
|
+
* @enum {string}
|
|
1943
|
+
*/
|
|
1944
|
+
readonly resource_type: "one_off";
|
|
1822
1945
|
readonly customer_id: components["schemas"]["KSUID"];
|
|
1823
1946
|
/**
|
|
1824
1947
|
* @description Temporary address where funds should be sent
|
|
@@ -1963,6 +2086,11 @@ type components = {
|
|
|
1963
2086
|
/** @description Transaction details representing a transfer of funds from a crypto wallet. */
|
|
1964
2087
|
readonly WalletTransaction: {
|
|
1965
2088
|
readonly id: components["schemas"]["KSUID"];
|
|
2089
|
+
/**
|
|
2090
|
+
* @description Discriminator field. Always "wallet" for wallet transactions. (enum property replaced by openapi-typescript)
|
|
2091
|
+
* @enum {string}
|
|
2092
|
+
*/
|
|
2093
|
+
readonly resource_type: "wallet";
|
|
1966
2094
|
readonly wallet_id: components["schemas"]["KSUID"];
|
|
1967
2095
|
readonly network_id?: components["schemas"]["NetworkId"];
|
|
1968
2096
|
/** @description The source address */
|
|
@@ -3186,6 +3314,11 @@ type components = {
|
|
|
3186
3314
|
* ]
|
|
3187
3315
|
*/
|
|
3188
3316
|
readonly source_of_wealth?: readonly ("investments" | "employment" | "court_settlement" | "lottery_winnings" | "retirement_income" | "savings" | "sale_of_assets" | "family_funds" | "gambling_winnings" | "gift" | "inheritance" | "insurance_claim" | "loan" | "redundancy_severance" | "benefits")[];
|
|
3317
|
+
/**
|
|
3318
|
+
* @description Social Security Number (only present for US persons, format XXX-XX-XXXX)
|
|
3319
|
+
* @example 123-45-6789
|
|
3320
|
+
*/
|
|
3321
|
+
readonly ssn?: string;
|
|
3189
3322
|
/**
|
|
3190
3323
|
* @description Decision on this individual entity (if made)
|
|
3191
3324
|
* @example approved
|
|
@@ -3549,13 +3682,13 @@ type components = {
|
|
|
3549
3682
|
*/
|
|
3550
3683
|
readonly application_decision?: "approved" | "declined" | "withdrawn" | null;
|
|
3551
3684
|
/** @description The people/businesses being onboarded */
|
|
3552
|
-
readonly entities
|
|
3685
|
+
readonly entities?: components["schemas"]["ApplicationEntities"];
|
|
3553
3686
|
/** @description Enhanced Due Diligence data (if provided) */
|
|
3554
3687
|
readonly edd?: components["schemas"]["EDDResponse"];
|
|
3555
3688
|
/** @description Attestations submitted for this application */
|
|
3556
3689
|
readonly attestations?: components["schemas"]["AttestationData"];
|
|
3557
3690
|
/** @description Validation state computed at retrieval time */
|
|
3558
|
-
readonly validation
|
|
3691
|
+
readonly validation?: components["schemas"]["ApplicationValidation"];
|
|
3559
3692
|
/** @description Risk rating (only present for superadmin users) */
|
|
3560
3693
|
readonly risk_rating?: components["schemas"]["RiskRating"];
|
|
3561
3694
|
};
|
|
@@ -3664,11 +3797,6 @@ type components = {
|
|
|
3664
3797
|
* ]
|
|
3665
3798
|
*/
|
|
3666
3799
|
readonly top_customer_countries?: readonly string[];
|
|
3667
|
-
/**
|
|
3668
|
-
* @description Whether the business screens customers against sanctions lists
|
|
3669
|
-
* @example true
|
|
3670
|
-
*/
|
|
3671
|
-
readonly screens_customers_for_sanctions?: boolean;
|
|
3672
3800
|
/**
|
|
3673
3801
|
* @description Whether the business issues tokens
|
|
3674
3802
|
* @example false
|
|
@@ -4014,6 +4142,10 @@ type CustomerCreateRequest = components['schemas']['CustomerCreateRequest'];
|
|
|
4014
4142
|
type CustomerCreateResponse = components['schemas']['CustomerCreateResponse'];
|
|
4015
4143
|
/** KYB status */
|
|
4016
4144
|
type KybStatus = Customer['kyb_status'];
|
|
4145
|
+
/** Request to update the sub-client association for a customer */
|
|
4146
|
+
type UpdateCustomerSubClientRequest = components['schemas']['UpdateCustomerSubClientRequest'];
|
|
4147
|
+
/** Summary of a sub-client including the count of associated customers */
|
|
4148
|
+
type SubClientSummary = components['schemas']['SubClientSummary'];
|
|
4017
4149
|
/** Recipient response */
|
|
4018
4150
|
type Recipient = components['schemas']['RecipientResponse'];
|
|
4019
4151
|
/** Recipient creation request */
|
|
@@ -4123,6 +4255,36 @@ type AssociatedIndividualRequest = components['schemas']['IndividualRequest'];
|
|
|
4123
4255
|
* This type is kept for forward compatibility if fields are added in the future.
|
|
4124
4256
|
*/
|
|
4125
4257
|
type ApplicationSubmissionRequest = Record<string, unknown>;
|
|
4258
|
+
/** Response after updating business details */
|
|
4259
|
+
type BusinessDetailsResponse = components['schemas']['BusinessDetailsResponse'];
|
|
4260
|
+
/** Response after updating individual details */
|
|
4261
|
+
type IndividualDetailsResponse = components['schemas']['IndividualDetailsResponse'];
|
|
4262
|
+
/** Attestation submission request */
|
|
4263
|
+
type AttestationSubmitRequest = components['schemas']['AttestationSubmitRequest'];
|
|
4264
|
+
/** Attestation type */
|
|
4265
|
+
type AttestationType = components['schemas']['AttestationType'];
|
|
4266
|
+
/** EDD (Enhanced Due Diligence) request */
|
|
4267
|
+
type EDDRequest = components['schemas']['EDDRequest'];
|
|
4268
|
+
/** EDD response with application context */
|
|
4269
|
+
type EDDWithApplicationID = components['schemas']['EDDWithApplicationID'];
|
|
4270
|
+
/** Application document upload request (base64-encoded content) */
|
|
4271
|
+
type ApplicationDocumentUploadRequest = components['schemas']['ApplicationDocumentUploadRequest'];
|
|
4272
|
+
/** Application document upload URL request (presigned URL) */
|
|
4273
|
+
type ApplicationDocumentUploadUrlRequest = components['schemas']['ApplicationDocumentUploadUrlRequest'];
|
|
4274
|
+
/** Document upload response (contains document_id) */
|
|
4275
|
+
type DocumentUploadResponse = components['schemas']['DocumentUploadResponse'];
|
|
4276
|
+
/** Document upload URL response (contains upload_url and upload_id) */
|
|
4277
|
+
type DocumentUploadUrlResponse = components['schemas']['DocumentUploadUrlResponse'];
|
|
4278
|
+
/** Uploaded document metadata (used in list responses) */
|
|
4279
|
+
type UploadedDocumentMetadata = components['schemas']['UploadedDocumentMetadata'];
|
|
4280
|
+
/** Individual document upload request (base64-encoded content) */
|
|
4281
|
+
type IndividualDocumentUploadRequest = components['schemas']['IndividualDocumentUploadRequest'];
|
|
4282
|
+
/** Individual document upload URL request (presigned URL) */
|
|
4283
|
+
type IndividualDocumentUploadUrlRequest = components['schemas']['IndividualDocumentUploadUrlRequest'];
|
|
4284
|
+
/** Application document type */
|
|
4285
|
+
type ApplicationDocumentType = components['schemas']['ApplicationDocumentType'];
|
|
4286
|
+
/** Individual document type */
|
|
4287
|
+
type IndividualDocumentType = components['schemas']['IndividualDocumentType'];
|
|
4126
4288
|
/** Policy */
|
|
4127
4289
|
type Policy = components['schemas']['Policy'];
|
|
4128
4290
|
/** Policy creation request */
|
|
@@ -4159,6 +4321,44 @@ type WebhookTargetCreateRequest = components['schemas']['WebhookTargetCreateRequ
|
|
|
4159
4321
|
type WebhookTargetUpdateRequest = components['schemas']['WebhookTargetUpdateRequest'];
|
|
4160
4322
|
/** Webhook event */
|
|
4161
4323
|
type WebhookEvent = components['schemas']['WebhookDelivery'];
|
|
4324
|
+
/** Webhook history list response (cursor-based pagination) */
|
|
4325
|
+
type WebhookHistoryList = components['schemas']['WebhookHistoryList'];
|
|
4326
|
+
/** Webhook replay response */
|
|
4327
|
+
type WebhookReplayResponse = components['schemas']['WebhookReplayResponse'];
|
|
4328
|
+
/** API key creation request for a specific client (admin only) */
|
|
4329
|
+
type CreateApiKeyForClientRequest = components['schemas']['CreateApiKeyForClientRequest'];
|
|
4330
|
+
/**
|
|
4331
|
+
* Webhook history list parameters.
|
|
4332
|
+
*
|
|
4333
|
+
* Uses cursor-based pagination (not starting_after/has_more_after).
|
|
4334
|
+
*/
|
|
4335
|
+
interface WebhookHistoryListParams {
|
|
4336
|
+
/** Filter by delivery status */
|
|
4337
|
+
status?: 'delivered' | 'failed' | 'pending';
|
|
4338
|
+
/** Filter by event type (e.g. `transaction.completed`) */
|
|
4339
|
+
event_type?: string;
|
|
4340
|
+
/** Filter to deliveries that originated from a sandbox simulation */
|
|
4341
|
+
simulation_id?: string;
|
|
4342
|
+
/** Return only records created at or after this timestamp (ISO 8601) */
|
|
4343
|
+
from?: string;
|
|
4344
|
+
/** Return only records created at or before this timestamp (ISO 8601) */
|
|
4345
|
+
to?: string;
|
|
4346
|
+
/** Maximum number of records to return per page (1-100, default 20) */
|
|
4347
|
+
limit?: number;
|
|
4348
|
+
/** Pagination cursor (event_id of the last item from the previous page) */
|
|
4349
|
+
cursor?: string;
|
|
4350
|
+
}
|
|
4351
|
+
/**
|
|
4352
|
+
* Webhook history response.
|
|
4353
|
+
*
|
|
4354
|
+
* Uses cursor-based pagination with `has_more` and `cursor` instead of the
|
|
4355
|
+
* standard `meta.has_more_after` format.
|
|
4356
|
+
*/
|
|
4357
|
+
interface WebhookHistoryResponse {
|
|
4358
|
+
data: WebhookEvent[];
|
|
4359
|
+
has_more: boolean;
|
|
4360
|
+
cursor?: string | null;
|
|
4361
|
+
}
|
|
4162
4362
|
/** Country info */
|
|
4163
4363
|
type Country = components['schemas']['Country'];
|
|
4164
4364
|
/** Network info - generic structure for network responses */
|
|
@@ -4282,10 +4482,11 @@ interface SimulateOnboardingResponse {
|
|
|
4282
4482
|
/**
|
|
4283
4483
|
* Onboarding simulation types.
|
|
4284
4484
|
*
|
|
4285
|
-
* - `kyb_approve` -
|
|
4485
|
+
* - `kyb_approve` - Fully approve any customer (individual or business). Triggers the complete
|
|
4486
|
+
* onboarding flow including endorsement and recipient creation.
|
|
4286
4487
|
* - `kyb_reject` - Reject a KYB application
|
|
4287
4488
|
* - `kyb_info_request` - Request additional information for KYB
|
|
4288
|
-
* - `kyc_approve` - Approve
|
|
4489
|
+
* - `kyc_approve` - Approve an individual applicant's KYC application status only (no endorsement/recipient)
|
|
4289
4490
|
* - `kyc_reject` - Reject a KYC check
|
|
4290
4491
|
* - `kyc_info_request` - Request additional information for KYC
|
|
4291
4492
|
* - `applicant_activate` - Activate an applicant (triggers provisioning)
|
|
@@ -4413,6 +4614,31 @@ interface SimulationInspection {
|
|
|
4413
4614
|
}
|
|
4414
4615
|
/** Sandbox scenario */
|
|
4415
4616
|
type SandboxScenario = components['schemas']['SandboxScenario'];
|
|
4617
|
+
/** Self-serve credits purchase request */
|
|
4618
|
+
type SelfServeCreditsPurchaseRequest = components['schemas']['SelfServeCreditsPurchaseRequest'];
|
|
4619
|
+
/** Self-serve credits purchase response (contains checkout URL) */
|
|
4620
|
+
type SelfServeCreditsPurchaseResponse = components['schemas']['SelfServeCreditsPurchaseResponse'];
|
|
4621
|
+
/** Self-serve credits balance response */
|
|
4622
|
+
type SelfServeCreditsBalanceResponse = components['schemas']['SelfServeCreditsBalanceResponse'];
|
|
4623
|
+
/** Self-serve credits ledger entry */
|
|
4624
|
+
type SelfServeCreditsLedgerEntry = components['schemas']['SelfServeCreditsLedgerEntry'];
|
|
4625
|
+
/** Self-serve credits ledger response */
|
|
4626
|
+
type SelfServeCreditsLedgerResponse = components['schemas']['SelfServeCreditsLedgerResponse'];
|
|
4627
|
+
/** Self-serve credit tier */
|
|
4628
|
+
type SelfServeCreditTier = components['schemas']['SelfServeCreditTier'];
|
|
4629
|
+
/** Self-serve credit tiers response */
|
|
4630
|
+
type SelfServeCreditTiersResponse = components['schemas']['SelfServeCreditTiersResponse'];
|
|
4631
|
+
/** Ledger entry type filter */
|
|
4632
|
+
type SelfServeCreditsLedgerEntryType = SelfServeCreditsLedgerEntry['entry_type'];
|
|
4633
|
+
/** Parameters for listing self-serve credits ledger entries */
|
|
4634
|
+
interface SelfServeCreditsLedgerParams {
|
|
4635
|
+
/** Cursor for pagination (ISO 8601 datetime) */
|
|
4636
|
+
cursor?: string;
|
|
4637
|
+
/** Number of entries to return (1-100, default 20) */
|
|
4638
|
+
limit?: number;
|
|
4639
|
+
/** Filter by entry type */
|
|
4640
|
+
type?: SelfServeCreditsLedgerEntryType;
|
|
4641
|
+
}
|
|
4416
4642
|
/**
|
|
4417
4643
|
* Options for API requests.
|
|
4418
4644
|
*
|
|
@@ -4455,12 +4681,19 @@ interface CustomerListParams extends ListParams {
|
|
|
4455
4681
|
external_id?: string;
|
|
4456
4682
|
search?: string;
|
|
4457
4683
|
kyb_status?: KybStatus;
|
|
4684
|
+
sub_client_id?: string;
|
|
4685
|
+
is_sub_client?: boolean;
|
|
4458
4686
|
}
|
|
4459
4687
|
/** Transaction list parameters */
|
|
4460
4688
|
interface TransactionListParams extends ListParams {
|
|
4689
|
+
/** Filter by resource family: one_off, wallet, auto_account */
|
|
4690
|
+
transaction_type?: 'one_off' | 'wallet' | 'auto_account';
|
|
4461
4691
|
customer_id?: string;
|
|
4462
|
-
|
|
4692
|
+
destination_id?: string;
|
|
4463
4693
|
status?: TransactionStatus;
|
|
4694
|
+
source_network_id?: string;
|
|
4695
|
+
source_asset?: string;
|
|
4696
|
+
destination_asset?: string;
|
|
4464
4697
|
}
|
|
4465
4698
|
/** Event list parameters */
|
|
4466
4699
|
interface EventListParams extends ListParams {
|
|
@@ -4538,6 +4771,45 @@ declare class CustomersResource extends BaseResource {
|
|
|
4538
4771
|
* ```
|
|
4539
4772
|
*/
|
|
4540
4773
|
get(customerId: string): Promise<Customer>;
|
|
4774
|
+
/**
|
|
4775
|
+
* Update the sub-client association for a customer.
|
|
4776
|
+
*
|
|
4777
|
+
* Associates or disassociates a customer with a sub-client.
|
|
4778
|
+
* Set `sub_client_id` to associate, or set it to `null` to disassociate.
|
|
4779
|
+
*
|
|
4780
|
+
* @param customerId - Customer ID (KSUID)
|
|
4781
|
+
* @param data - Sub-client association data
|
|
4782
|
+
* @param options - Request options (e.g., custom idempotency key)
|
|
4783
|
+
* @returns Updated customer record
|
|
4784
|
+
*
|
|
4785
|
+
* @example
|
|
4786
|
+
* ```typescript
|
|
4787
|
+
* // Associate customer with a sub-client
|
|
4788
|
+
* const customer = await client.customers.updateSubClient('cust_abc123', {
|
|
4789
|
+
* sub_client_id: 'cust_sub456',
|
|
4790
|
+
* });
|
|
4791
|
+
*
|
|
4792
|
+
* // Disassociate customer from sub-client
|
|
4793
|
+
* const customer = await client.customers.updateSubClient('cust_abc123', {
|
|
4794
|
+
* sub_client_id: null,
|
|
4795
|
+
* });
|
|
4796
|
+
* ```
|
|
4797
|
+
*/
|
|
4798
|
+
updateSubClient(customerId: string, data: UpdateCustomerSubClientRequest, options?: RequestOptions): Promise<Customer>;
|
|
4799
|
+
/**
|
|
4800
|
+
* Get a summary of all sub-clients and their associated customer counts.
|
|
4801
|
+
*
|
|
4802
|
+
* @returns Array of sub-client summaries
|
|
4803
|
+
*
|
|
4804
|
+
* @example
|
|
4805
|
+
* ```typescript
|
|
4806
|
+
* const summaries = await client.customers.getSubClientSummary();
|
|
4807
|
+
* for (const summary of summaries) {
|
|
4808
|
+
* console.log(`${summary.sub_client_name}: ${summary.customer_count} customers`);
|
|
4809
|
+
* }
|
|
4810
|
+
* ```
|
|
4811
|
+
*/
|
|
4812
|
+
getSubClientSummary(): Promise<SubClientSummary[]>;
|
|
4541
4813
|
}
|
|
4542
4814
|
|
|
4543
4815
|
/**
|
|
@@ -4607,6 +4879,17 @@ declare class RecipientsResource extends BaseResource {
|
|
|
4607
4879
|
* ```
|
|
4608
4880
|
*/
|
|
4609
4881
|
update(recipientId: string, data: RecipientUpdateRequest, options?: RequestOptions): Promise<Recipient>;
|
|
4882
|
+
/**
|
|
4883
|
+
* Delete a recipient.
|
|
4884
|
+
*
|
|
4885
|
+
* @param recipientId - Recipient ID
|
|
4886
|
+
*
|
|
4887
|
+
* @example
|
|
4888
|
+
* ```typescript
|
|
4889
|
+
* await client.recipients.delete(recipientId);
|
|
4890
|
+
* ```
|
|
4891
|
+
*/
|
|
4892
|
+
delete(recipientId: string): Promise<void>;
|
|
4610
4893
|
}
|
|
4611
4894
|
|
|
4612
4895
|
/**
|
|
@@ -4662,6 +4945,18 @@ declare class DestinationsResource extends BaseResource {
|
|
|
4662
4945
|
* ```
|
|
4663
4946
|
*/
|
|
4664
4947
|
list(recipientId: string, params?: ListParams): PaginatedIterator<Destination>;
|
|
4948
|
+
/**
|
|
4949
|
+
* Delete a destination.
|
|
4950
|
+
*
|
|
4951
|
+
* @param recipientId - Recipient ID
|
|
4952
|
+
* @param destinationId - Destination ID
|
|
4953
|
+
*
|
|
4954
|
+
* @example
|
|
4955
|
+
* ```typescript
|
|
4956
|
+
* await client.destinations.delete(recipientId, destinationId);
|
|
4957
|
+
* ```
|
|
4958
|
+
*/
|
|
4959
|
+
delete(recipientId: string, destinationId: string): Promise<void>;
|
|
4665
4960
|
}
|
|
4666
4961
|
|
|
4667
4962
|
/**
|
|
@@ -4670,8 +4965,14 @@ declare class DestinationsResource extends BaseResource {
|
|
|
4670
4965
|
|
|
4671
4966
|
/** Account list parameters */
|
|
4672
4967
|
interface AccountListParams extends ListParams {
|
|
4968
|
+
/** Account type filter. Required by the API. */
|
|
4969
|
+
account_type: 'onramp' | 'offramp' | 'swap';
|
|
4673
4970
|
customer_id?: string;
|
|
4674
|
-
|
|
4971
|
+
source_network_id?: string;
|
|
4972
|
+
destination_network_id?: string;
|
|
4973
|
+
destination_asset?: string;
|
|
4974
|
+
crypto_destination_id?: string;
|
|
4975
|
+
fiat_destination_id?: string;
|
|
4675
4976
|
}
|
|
4676
4977
|
/**
|
|
4677
4978
|
* Accounts API resource.
|
|
@@ -4761,6 +5062,17 @@ declare class AccountsResource extends BaseResource {
|
|
|
4761
5062
|
* ```
|
|
4762
5063
|
*/
|
|
4763
5064
|
update(accountId: string, data: AccountUpdateRequest, options?: RequestOptions): Promise<Account>;
|
|
5065
|
+
/**
|
|
5066
|
+
* Delete an account.
|
|
5067
|
+
*
|
|
5068
|
+
* @param accountId - Account ID
|
|
5069
|
+
*
|
|
5070
|
+
* @example
|
|
5071
|
+
* ```typescript
|
|
5072
|
+
* await client.accounts.delete(accountId);
|
|
5073
|
+
* ```
|
|
5074
|
+
*/
|
|
5075
|
+
delete(accountId: string): Promise<void>;
|
|
4764
5076
|
}
|
|
4765
5077
|
|
|
4766
5078
|
/**
|
|
@@ -4966,24 +5278,17 @@ declare class EventsResource extends BaseResource {
|
|
|
4966
5278
|
* ```
|
|
4967
5279
|
*/
|
|
4968
5280
|
list(params?: EventListParams): PaginatedIterator<Event>;
|
|
4969
|
-
/**
|
|
4970
|
-
* Get an event by ID.
|
|
4971
|
-
*
|
|
4972
|
-
* @param eventId - Event ID
|
|
4973
|
-
* @returns Event record
|
|
4974
|
-
*
|
|
4975
|
-
* @example
|
|
4976
|
-
* ```typescript
|
|
4977
|
-
* const event = await client.events.get(eventId);
|
|
4978
|
-
* ```
|
|
4979
|
-
*/
|
|
4980
|
-
get(eventId: string): Promise<Event>;
|
|
4981
5281
|
}
|
|
4982
5282
|
|
|
4983
5283
|
/**
|
|
4984
5284
|
* Applications resource (Onboarding/KYB).
|
|
4985
5285
|
*/
|
|
4986
5286
|
|
|
5287
|
+
/** Parameters for listing application documents */
|
|
5288
|
+
interface DocumentListParams extends ListParams {
|
|
5289
|
+
category?: 'business' | 'identity' | 'edd';
|
|
5290
|
+
document_type?: string;
|
|
5291
|
+
}
|
|
4987
5292
|
/**
|
|
4988
5293
|
* Applications API resource for KYB onboarding.
|
|
4989
5294
|
*/
|
|
@@ -5011,38 +5316,45 @@ declare class ApplicationsResource extends BaseResource {
|
|
|
5011
5316
|
*/
|
|
5012
5317
|
submit(applicationId: string, data?: ApplicationSubmissionRequest, options?: RequestOptions): Promise<Application>;
|
|
5013
5318
|
/**
|
|
5014
|
-
*
|
|
5319
|
+
* Update business details for an application.
|
|
5320
|
+
*
|
|
5321
|
+
* Uses PUT (full replace) per the OpenAPI spec.
|
|
5015
5322
|
*
|
|
5016
5323
|
* @param applicationId - Application ID
|
|
5017
|
-
* @param
|
|
5018
|
-
* @returns
|
|
5324
|
+
* @param data - Business details (full BusinessApplicationCreateRequest)
|
|
5325
|
+
* @returns Updated business details with application context
|
|
5019
5326
|
*/
|
|
5020
|
-
|
|
5327
|
+
updateBusinessDetails(applicationId: string, data: BusinessApplicationCreateRequest, options?: RequestOptions): Promise<BusinessDetailsResponse>;
|
|
5021
5328
|
/**
|
|
5022
|
-
*
|
|
5329
|
+
* Update individual details for a non-business application.
|
|
5330
|
+
*
|
|
5331
|
+
* Uses PUT (full replace) per the OpenAPI spec. Only callable when the
|
|
5332
|
+
* application status is 'pending'.
|
|
5023
5333
|
*
|
|
5024
5334
|
* @param applicationId - Application ID
|
|
5025
|
-
* @param data - Individual
|
|
5026
|
-
* @returns
|
|
5335
|
+
* @param data - Individual details (full IndividualRequest)
|
|
5336
|
+
* @returns Updated individual details with application context
|
|
5027
5337
|
*/
|
|
5028
|
-
|
|
5338
|
+
updateIndividualDetails(applicationId: string, data: IndividualRequest, options?: RequestOptions): Promise<IndividualDetailsResponse>;
|
|
5029
5339
|
/**
|
|
5030
|
-
*
|
|
5340
|
+
* Add an associated individual to an application.
|
|
5031
5341
|
*
|
|
5032
5342
|
* @param applicationId - Application ID
|
|
5033
|
-
* @param
|
|
5034
|
-
* @returns
|
|
5343
|
+
* @param data - Individual data
|
|
5344
|
+
* @returns Created individual
|
|
5035
5345
|
*/
|
|
5036
|
-
|
|
5346
|
+
addIndividual(applicationId: string, data: AssociatedIndividualRequest, options?: RequestOptions): Promise<AssociatedIndividual>;
|
|
5037
5347
|
/**
|
|
5038
5348
|
* Update an associated individual.
|
|
5039
5349
|
*
|
|
5350
|
+
* Uses PUT (full replace) per the OpenAPI spec.
|
|
5351
|
+
*
|
|
5040
5352
|
* @param applicationId - Application ID
|
|
5041
5353
|
* @param individualId - Individual ID
|
|
5042
|
-
* @param data -
|
|
5354
|
+
* @param data - Full individual data (replaces existing)
|
|
5043
5355
|
* @returns Updated individual
|
|
5044
5356
|
*/
|
|
5045
|
-
updateIndividual(applicationId: string, individualId: string, data:
|
|
5357
|
+
updateIndividual(applicationId: string, individualId: string, data: AssociatedIndividualRequest, options?: RequestOptions): Promise<AssociatedIndividual>;
|
|
5046
5358
|
/**
|
|
5047
5359
|
* Delete an associated individual.
|
|
5048
5360
|
*
|
|
@@ -5051,27 +5363,114 @@ declare class ApplicationsResource extends BaseResource {
|
|
|
5051
5363
|
*/
|
|
5052
5364
|
deleteIndividual(applicationId: string, individualId: string): Promise<void>;
|
|
5053
5365
|
/**
|
|
5054
|
-
*
|
|
5366
|
+
* Submit an attestation for an application.
|
|
5055
5367
|
*
|
|
5056
5368
|
* @param applicationId - Application ID
|
|
5057
|
-
* @param data -
|
|
5058
|
-
* @returns Updated application
|
|
5369
|
+
* @param data - Attestation data (type, timestamp, applicant_id)
|
|
5059
5370
|
*/
|
|
5060
|
-
|
|
5371
|
+
submitAttestation(applicationId: string, data: AttestationSubmitRequest, options?: RequestOptions): Promise<void>;
|
|
5061
5372
|
/**
|
|
5062
|
-
* Get
|
|
5373
|
+
* Get the EDD record for an application.
|
|
5063
5374
|
*
|
|
5064
5375
|
* @param applicationId - Application ID
|
|
5376
|
+
* @returns EDD record with application context
|
|
5377
|
+
*/
|
|
5378
|
+
getEDD(applicationId: string): Promise<EDDWithApplicationID>;
|
|
5379
|
+
/**
|
|
5380
|
+
* Create or update the EDD record for an application.
|
|
5381
|
+
*
|
|
5382
|
+
* This endpoint is idempotent (uses PUT).
|
|
5383
|
+
*
|
|
5384
|
+
* @param applicationId - Application ID
|
|
5385
|
+
* @param data - EDD data
|
|
5386
|
+
* @returns Updated EDD record with application context
|
|
5387
|
+
*/
|
|
5388
|
+
createOrUpdateEDD(applicationId: string, data: EDDRequest, options?: RequestOptions): Promise<EDDWithApplicationID>;
|
|
5389
|
+
/**
|
|
5390
|
+
* Upload an application document using base64-encoded content.
|
|
5391
|
+
*
|
|
5392
|
+
* For files larger than 20MB, use {@link getDocumentUploadUrl} and upload
|
|
5393
|
+
* directly to cloud storage, then call {@link verifyDocument}.
|
|
5394
|
+
*
|
|
5395
|
+
* @param applicationId - Application ID
|
|
5396
|
+
* @param data - Document data including base64 content
|
|
5397
|
+
* @returns Document upload response with document_id
|
|
5398
|
+
*/
|
|
5399
|
+
createDocument(applicationId: string, data: ApplicationDocumentUploadRequest, options?: RequestOptions): Promise<DocumentUploadResponse>;
|
|
5400
|
+
/**
|
|
5401
|
+
* List documents for an application.
|
|
5402
|
+
*
|
|
5403
|
+
* Supports filtering by category and document type.
|
|
5404
|
+
*
|
|
5405
|
+
* @param applicationId - Application ID
|
|
5406
|
+
* @param params - Pagination and filter parameters
|
|
5407
|
+
* @returns Paginated iterator of document metadata
|
|
5408
|
+
*/
|
|
5409
|
+
listDocuments(applicationId: string, params?: DocumentListParams): PaginatedIterator<UploadedDocumentMetadata>;
|
|
5410
|
+
/**
|
|
5411
|
+
* Download/get a document by ID.
|
|
5412
|
+
*
|
|
5413
|
+
* @param applicationId - Application ID
|
|
5414
|
+
* @param documentId - Document ID
|
|
5415
|
+
* @returns Document content (binary)
|
|
5416
|
+
*/
|
|
5417
|
+
getDocument(applicationId: string, documentId: string): Promise<unknown>;
|
|
5418
|
+
/**
|
|
5419
|
+
* Delete a document from a pending application.
|
|
5420
|
+
*
|
|
5421
|
+
* Only documents from applications in 'pending' status can be deleted.
|
|
5422
|
+
*
|
|
5423
|
+
* @param applicationId - Application ID
|
|
5424
|
+
* @param documentId - Document ID
|
|
5425
|
+
*/
|
|
5426
|
+
deleteDocument(applicationId: string, documentId: string): Promise<void>;
|
|
5427
|
+
/**
|
|
5428
|
+
* Verify a document uploaded via presigned URL.
|
|
5429
|
+
*
|
|
5430
|
+
* After uploading a file to the presigned URL from {@link getDocumentUploadUrl},
|
|
5431
|
+
* call this endpoint to register and verify the upload.
|
|
5432
|
+
*
|
|
5433
|
+
* @param applicationId - Application ID
|
|
5434
|
+
* @param documentId - The upload_id from the presigned URL response
|
|
5435
|
+
* @returns Document upload response with document_id
|
|
5436
|
+
*/
|
|
5437
|
+
verifyDocument(applicationId: string, documentId: string, _data?: Record<string, unknown>, options?: RequestOptions): Promise<DocumentUploadResponse>;
|
|
5438
|
+
/**
|
|
5439
|
+
* Get a presigned upload URL for an application document.
|
|
5440
|
+
*
|
|
5441
|
+
* Use this for files larger than 20MB. Upload the file directly to the
|
|
5442
|
+
* returned URL, then call {@link verifyDocument} to register it.
|
|
5443
|
+
*
|
|
5444
|
+
* @param applicationId - Application ID
|
|
5445
|
+
* @param data - Document metadata
|
|
5446
|
+
* @returns Upload URL and upload ID
|
|
5447
|
+
*/
|
|
5448
|
+
getDocumentUploadUrl(applicationId: string, data: ApplicationDocumentUploadUrlRequest, options?: RequestOptions): Promise<DocumentUploadUrlResponse>;
|
|
5449
|
+
/**
|
|
5450
|
+
* Upload a document for an associated individual using base64-encoded content.
|
|
5451
|
+
*
|
|
5452
|
+
* Supports identity documents (passport, driver's license, residence permit)
|
|
5453
|
+
* and EDD documents (bank statement, etc.). For files larger than 10MB, use
|
|
5454
|
+
* {@link getIndividualDocumentUploadUrl} instead.
|
|
5455
|
+
*
|
|
5456
|
+
* @param applicationId - Application ID
|
|
5457
|
+
* @param individualId - Individual ID
|
|
5458
|
+
* @param data - Document data including base64 content
|
|
5459
|
+
* @returns Document upload response with document_id
|
|
5460
|
+
*/
|
|
5461
|
+
uploadIndividualDocument(applicationId: string, individualId: string, data: IndividualDocumentUploadRequest, options?: RequestOptions): Promise<DocumentUploadResponse>;
|
|
5462
|
+
/**
|
|
5463
|
+
* Get a presigned upload URL for an individual document.
|
|
5464
|
+
*
|
|
5465
|
+
* Use this for files larger than 10MB. Upload the file directly to the
|
|
5466
|
+
* returned URL.
|
|
5467
|
+
*
|
|
5468
|
+
* @param applicationId - Application ID
|
|
5469
|
+
* @param individualId - Individual ID
|
|
5065
5470
|
* @param data - Document metadata
|
|
5066
|
-
* @returns Upload URL and
|
|
5471
|
+
* @returns Upload URL and upload ID
|
|
5067
5472
|
*/
|
|
5068
|
-
|
|
5069
|
-
document_type: string;
|
|
5070
|
-
file_name: string;
|
|
5071
|
-
}, options?: RequestOptions): Promise<{
|
|
5072
|
-
upload_url: string;
|
|
5073
|
-
document_id: string;
|
|
5074
|
-
}>;
|
|
5473
|
+
getIndividualDocumentUploadUrl(applicationId: string, individualId: string, data: IndividualDocumentUploadUrlRequest, options?: RequestOptions): Promise<DocumentUploadUrlResponse>;
|
|
5075
5474
|
}
|
|
5076
5475
|
|
|
5077
5476
|
/**
|
|
@@ -5207,25 +5606,27 @@ declare class SignerGroupsResource extends BaseResource {
|
|
|
5207
5606
|
* @param signerGroupId - Signer group ID
|
|
5208
5607
|
*/
|
|
5209
5608
|
detachFromWallet(walletId: string, signerGroupId: string): Promise<void>;
|
|
5609
|
+
/**
|
|
5610
|
+
* List signer groups attached to a wallet.
|
|
5611
|
+
*
|
|
5612
|
+
* @param walletId - Wallet ID
|
|
5613
|
+
* @param params - Pagination parameters
|
|
5614
|
+
* @returns Async iterator of signer groups
|
|
5615
|
+
*/
|
|
5616
|
+
listForWallet(walletId: string, params?: ListParams): PaginatedIterator<SignerGroup>;
|
|
5210
5617
|
}
|
|
5211
5618
|
/**
|
|
5212
5619
|
* Signers API resource.
|
|
5213
5620
|
*/
|
|
5214
5621
|
declare class SignersResource extends BaseResource {
|
|
5215
5622
|
/**
|
|
5216
|
-
*
|
|
5623
|
+
* Create a new signer.
|
|
5217
5624
|
*
|
|
5218
|
-
* @param
|
|
5219
|
-
* @
|
|
5220
|
-
|
|
5221
|
-
list(params?: ListParams): PaginatedIterator<Signer>;
|
|
5222
|
-
/**
|
|
5223
|
-
* Get a signer by public key.
|
|
5224
|
-
*
|
|
5225
|
-
* @param publicKey - Signer public key
|
|
5226
|
-
* @returns Signer record
|
|
5625
|
+
* @param data - Signer creation data (name, public_key, key_type)
|
|
5626
|
+
* @param options - Request options
|
|
5627
|
+
* @returns Created signer
|
|
5227
5628
|
*/
|
|
5228
|
-
|
|
5629
|
+
create(data: SignerCreateRequest, options?: RequestOptions): Promise<Signer>;
|
|
5229
5630
|
/**
|
|
5230
5631
|
* Delete a signer by public key.
|
|
5231
5632
|
*
|
|
@@ -5250,9 +5651,7 @@ declare class ApiKeysResource extends BaseResource {
|
|
|
5250
5651
|
* @param data - API key creation data
|
|
5251
5652
|
* @returns Created API key (includes secret, only shown once)
|
|
5252
5653
|
*/
|
|
5253
|
-
create(data: ApiKeyCreateRequest, options?: RequestOptions): Promise<
|
|
5254
|
-
secret: string;
|
|
5255
|
-
}>;
|
|
5654
|
+
create(data: ApiKeyCreateRequest, options?: RequestOptions): Promise<ApiKeyResponse>;
|
|
5256
5655
|
/**
|
|
5257
5656
|
* List API keys.
|
|
5258
5657
|
*
|
|
@@ -5266,6 +5665,22 @@ declare class ApiKeysResource extends BaseResource {
|
|
|
5266
5665
|
* @param apiKeyId - API key ID
|
|
5267
5666
|
*/
|
|
5268
5667
|
delete(apiKeyId: string): Promise<void>;
|
|
5668
|
+
/**
|
|
5669
|
+
* Delete all API keys.
|
|
5670
|
+
*
|
|
5671
|
+
* Intended for incident response only.
|
|
5672
|
+
*/
|
|
5673
|
+
deleteAll(): Promise<void>;
|
|
5674
|
+
/**
|
|
5675
|
+
* Create an API key for a specific client (admin only).
|
|
5676
|
+
*
|
|
5677
|
+
* Requires admin access token.
|
|
5678
|
+
*
|
|
5679
|
+
* @param data - Request data containing `client_id`
|
|
5680
|
+
* @param options - Request options
|
|
5681
|
+
* @returns Created API key response (includes key, only shown once)
|
|
5682
|
+
*/
|
|
5683
|
+
createForClient(data: CreateApiKeyForClientRequest, options?: RequestOptions): Promise<ApiKeyResponse>;
|
|
5269
5684
|
}
|
|
5270
5685
|
|
|
5271
5686
|
/**
|
|
@@ -5290,21 +5705,13 @@ declare class UsersResource extends BaseResource {
|
|
|
5290
5705
|
* @returns Async iterator of users
|
|
5291
5706
|
*/
|
|
5292
5707
|
list(params?: ListParams): PaginatedIterator<User>;
|
|
5293
|
-
/**
|
|
5294
|
-
* Get a user by ID.
|
|
5295
|
-
*
|
|
5296
|
-
* @param userId - User ID
|
|
5297
|
-
* @returns User record
|
|
5298
|
-
*/
|
|
5299
|
-
get(userId: string): Promise<User>;
|
|
5300
5708
|
/**
|
|
5301
5709
|
* Update a user.
|
|
5302
5710
|
*
|
|
5303
5711
|
* @param userId - User ID
|
|
5304
|
-
* @param data - Update data
|
|
5305
|
-
* @returns Updated user
|
|
5712
|
+
* @param data - Update data (first_name, last_name, role)
|
|
5306
5713
|
*/
|
|
5307
|
-
update(userId: string, data: UserUpdateRequest, options?: RequestOptions): Promise<
|
|
5714
|
+
update(userId: string, data: UserUpdateRequest, options?: RequestOptions): Promise<void>;
|
|
5308
5715
|
/**
|
|
5309
5716
|
* Delete a user.
|
|
5310
5717
|
*
|
|
@@ -5357,12 +5764,29 @@ declare class WebhooksResource extends BaseResource {
|
|
|
5357
5764
|
*/
|
|
5358
5765
|
deleteTarget(targetId: string): Promise<void>;
|
|
5359
5766
|
/**
|
|
5360
|
-
* List webhook
|
|
5767
|
+
* List webhook delivery history.
|
|
5361
5768
|
*
|
|
5362
|
-
*
|
|
5363
|
-
*
|
|
5769
|
+
* Note: This endpoint uses cursor-based pagination (`cursor`/`has_more`) instead
|
|
5770
|
+
* of the standard `starting_after`/`has_more_after` format. Because of this,
|
|
5771
|
+
* it returns the raw response rather than a `PaginatedIterator`. Use the `cursor`
|
|
5772
|
+
* field from the response to fetch subsequent pages.
|
|
5773
|
+
*
|
|
5774
|
+
* @param params - Webhook history query parameters
|
|
5775
|
+
* @returns Webhook history response with `data`, `has_more`, and `cursor`
|
|
5776
|
+
*
|
|
5777
|
+
* @example
|
|
5778
|
+
* ```typescript
|
|
5779
|
+
* let cursor: string | undefined;
|
|
5780
|
+
* do {
|
|
5781
|
+
* const page = await client.webhooks.listEvents({ limit: 50, cursor });
|
|
5782
|
+
* for (const event of page.data) {
|
|
5783
|
+
* console.log(event);
|
|
5784
|
+
* }
|
|
5785
|
+
* cursor = page.cursor ?? undefined;
|
|
5786
|
+
* } while (page.has_more);
|
|
5787
|
+
* ```
|
|
5364
5788
|
*/
|
|
5365
|
-
listEvents(params?:
|
|
5789
|
+
listEvents(params?: WebhookHistoryListParams): Promise<WebhookHistoryResponse>;
|
|
5366
5790
|
/**
|
|
5367
5791
|
* Get a webhook event by ID.
|
|
5368
5792
|
*
|
|
@@ -5373,9 +5797,13 @@ declare class WebhooksResource extends BaseResource {
|
|
|
5373
5797
|
/**
|
|
5374
5798
|
* Replay a webhook event.
|
|
5375
5799
|
*
|
|
5800
|
+
* Re-queues the webhook for delivery to all configured targets.
|
|
5801
|
+
*
|
|
5376
5802
|
* @param eventId - Webhook event ID
|
|
5803
|
+
* @param options - Request options
|
|
5804
|
+
* @returns Replay response with `webhook_id`, `status`, and `replayed_to_count`
|
|
5377
5805
|
*/
|
|
5378
|
-
replayEvent(eventId: string, options?: RequestOptions): Promise<
|
|
5806
|
+
replayEvent(eventId: string, options?: RequestOptions): Promise<WebhookReplayResponse>;
|
|
5379
5807
|
}
|
|
5380
5808
|
|
|
5381
5809
|
/**
|
|
@@ -5520,9 +5948,10 @@ declare class SandboxResource extends BaseResource {
|
|
|
5520
5948
|
* Drives KYB, KYC, or applicant account status through a sandbox transition
|
|
5521
5949
|
* without waiting for real compliance review.
|
|
5522
5950
|
*
|
|
5523
|
-
* **Important:**
|
|
5524
|
-
*
|
|
5525
|
-
*
|
|
5951
|
+
* **Important:** Use `kyb_approve` to fully approve any customer type (individual or
|
|
5952
|
+
* business). This triggers the complete onboarding flow including endorsement and
|
|
5953
|
+
* recipient creation. The `kyc_*` types only update the individual applicant's KYC
|
|
5954
|
+
* application status without triggering the full onboarding flow.
|
|
5526
5955
|
*
|
|
5527
5956
|
* @param data - Simulation request data
|
|
5528
5957
|
* @returns Simulation response with previous and new state
|
|
@@ -5611,6 +6040,89 @@ declare class SandboxResource extends BaseResource {
|
|
|
5611
6040
|
listScenarios(params?: ListParams): PaginatedIterator<SandboxScenario>;
|
|
5612
6041
|
}
|
|
5613
6042
|
|
|
6043
|
+
/**
|
|
6044
|
+
* Self-Serve Credits resource for managing prepaid transfer credits.
|
|
6045
|
+
*/
|
|
6046
|
+
|
|
6047
|
+
/**
|
|
6048
|
+
* Self-Serve Credits API resource.
|
|
6049
|
+
*
|
|
6050
|
+
* Manage prepaid credits for self-serve transfer capacity.
|
|
6051
|
+
*/
|
|
6052
|
+
declare class SelfServeResource extends BaseResource {
|
|
6053
|
+
/**
|
|
6054
|
+
* Purchase self-serve credits.
|
|
6055
|
+
*
|
|
6056
|
+
* Creates a Stripe checkout session for purchasing credits at the specified tier.
|
|
6057
|
+
*
|
|
6058
|
+
* @param data - Purchase request with the tier price
|
|
6059
|
+
* @param options - Optional request options (e.g., idempotency key)
|
|
6060
|
+
* @returns Response containing the Stripe checkout URL
|
|
6061
|
+
*
|
|
6062
|
+
* @example
|
|
6063
|
+
* ```typescript
|
|
6064
|
+
* const { checkout_url } = await client.selfServe.purchaseCredits({
|
|
6065
|
+
* tier_price_cents: 10000,
|
|
6066
|
+
* });
|
|
6067
|
+
* // Redirect user to checkout_url
|
|
6068
|
+
* ```
|
|
6069
|
+
*/
|
|
6070
|
+
purchaseCredits(data: SelfServeCreditsPurchaseRequest, options?: RequestOptions): Promise<SelfServeCreditsPurchaseResponse>;
|
|
6071
|
+
/**
|
|
6072
|
+
* Get current credits balance.
|
|
6073
|
+
*
|
|
6074
|
+
* @returns The current balance and transfer capacity in cents
|
|
6075
|
+
*
|
|
6076
|
+
* @example
|
|
6077
|
+
* ```typescript
|
|
6078
|
+
* const balance = await client.selfServe.getBalance();
|
|
6079
|
+
* console.log(`Balance: $${balance.balance_cents / 100}`);
|
|
6080
|
+
* console.log(`Transfer capacity: $${balance.transfer_capacity_cents / 100}`);
|
|
6081
|
+
* ```
|
|
6082
|
+
*/
|
|
6083
|
+
getBalance(): Promise<SelfServeCreditsBalanceResponse>;
|
|
6084
|
+
/**
|
|
6085
|
+
* List credits ledger entries.
|
|
6086
|
+
*
|
|
6087
|
+
* Returns a cursor-paginated list of ledger entries (purchases, deductions, refunds).
|
|
6088
|
+
*
|
|
6089
|
+
* @param params - Optional query parameters for filtering and pagination
|
|
6090
|
+
* @returns Ledger response with entries and has_more flag
|
|
6091
|
+
*
|
|
6092
|
+
* @example
|
|
6093
|
+
* ```typescript
|
|
6094
|
+
* // Get recent ledger entries
|
|
6095
|
+
* const ledger = await client.selfServe.listLedger();
|
|
6096
|
+
* for (const entry of ledger.entries) {
|
|
6097
|
+
* console.log(entry.entry_type, entry.amount_cents, entry.description);
|
|
6098
|
+
* }
|
|
6099
|
+
*
|
|
6100
|
+
* // Filter by type with pagination
|
|
6101
|
+
* const purchases = await client.selfServe.listLedger({
|
|
6102
|
+
* type: 'purchase',
|
|
6103
|
+
* limit: 50,
|
|
6104
|
+
* });
|
|
6105
|
+
* ```
|
|
6106
|
+
*/
|
|
6107
|
+
listLedger(params?: SelfServeCreditsLedgerParams): Promise<SelfServeCreditsLedgerResponse>;
|
|
6108
|
+
/**
|
|
6109
|
+
* List available credit tiers.
|
|
6110
|
+
*
|
|
6111
|
+
* Returns all available pricing tiers for purchasing credits.
|
|
6112
|
+
*
|
|
6113
|
+
* @returns Response containing the list of available tiers
|
|
6114
|
+
*
|
|
6115
|
+
* @example
|
|
6116
|
+
* ```typescript
|
|
6117
|
+
* const { tiers } = await client.selfServe.listTiers();
|
|
6118
|
+
* for (const tier of tiers) {
|
|
6119
|
+
* console.log(`$${tier.price_cents / 100} → $${tier.transfer_capacity_cents / 100} capacity`);
|
|
6120
|
+
* }
|
|
6121
|
+
* ```
|
|
6122
|
+
*/
|
|
6123
|
+
listTiers(): Promise<SelfServeCreditTiersResponse>;
|
|
6124
|
+
}
|
|
6125
|
+
|
|
5614
6126
|
/**
|
|
5615
6127
|
* Dakota Platform API Client.
|
|
5616
6128
|
*/
|
|
@@ -5678,6 +6190,8 @@ declare class DakotaClient {
|
|
|
5678
6190
|
readonly info: InfoResource;
|
|
5679
6191
|
/** Sandbox API - testing simulations (sandbox only) */
|
|
5680
6192
|
readonly sandbox: SandboxResource;
|
|
6193
|
+
/** Self-Serve Credits API - manage prepaid transfer credits */
|
|
6194
|
+
readonly selfServe: SelfServeResource;
|
|
5681
6195
|
/**
|
|
5682
6196
|
* Create a new Dakota client.
|
|
5683
6197
|
*
|
|
@@ -5763,4 +6277,4 @@ declare class ConfigurationError extends Error {
|
|
|
5763
6277
|
constructor(message: string);
|
|
5764
6278
|
}
|
|
5765
6279
|
|
|
5766
|
-
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 ApplicationListItem, type ApplicationStatus, type ApplicationSubmissionRequest, ApplicationsResource, type AssociatedIndividual, type AssociatedIndividualRequest, AuthMode, type AutoTransaction, AutoTransactionsResource, type AverageMonthlyRevenue, type BusinessApplicationCreateRequest, type BusinessPurposeOfAccount, type BusinessSourceOfFunds, ConfigurationError, type Country, 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 EmploymentStatus, Environment, type Event, type EventListParams, type EventType, EventsResource, type ExpectedMonthlyDeposit, type Family, type FiatUSDestination, type FiatUSDestinationRequest, 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 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 SwapAccount, type SwapAccountCreateRequest, type TransactionListParams, type TransactionStatus, TransactionsResource, TransportError, type User, type UserCreateRequest, type UserUpdateRequest, UsersResource, type Wallet, type WalletBalance, type WalletBalances, type WalletCreateRequest, type WalletTransaction, type WalletTransactionRequest, WalletsResource, type WebhookEvent, type WebhookTarget, type WebhookTargetCreateRequest, type WebhookTargetUpdateRequest, WebhooksResource, consoleLogger, getEnvironmentURL, noopLogger, paginate };
|
|
6280
|
+
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 BusinessApplicationCreateRequest, type BusinessDetailsResponse, type BusinessPurposeOfAccount, type BusinessSourceOfFunds, 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 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 };
|