@spritz-finance/api-client 0.4.6 → 0.4.8
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/README.md +107 -3
- package/dist/spritz-api-client.cjs +125 -67
- package/dist/spritz-api-client.d.ts +125 -3
- package/dist/spritz-api-client.mjs +125 -67
- package/package.json +1 -1
|
@@ -33,6 +33,10 @@ declare enum BillType {
|
|
|
33
33
|
Unknown = "Unknown",
|
|
34
34
|
Utility = "Utility"
|
|
35
35
|
}
|
|
36
|
+
declare enum DebitCardNetwork {
|
|
37
|
+
Mastercard = "Mastercard",
|
|
38
|
+
Visa = "Visa"
|
|
39
|
+
}
|
|
36
40
|
declare enum DirectPaymentStatus {
|
|
37
41
|
COMPLETED = "COMPLETED",
|
|
38
42
|
CONFIRMED = "CONFIRMED",
|
|
@@ -135,6 +139,11 @@ interface CreateOnrampPaymentInput {
|
|
|
135
139
|
token: string;
|
|
136
140
|
paymentMethod: string;
|
|
137
141
|
}
|
|
142
|
+
interface DebitCardInput {
|
|
143
|
+
name?: string | null;
|
|
144
|
+
cardNumber: string;
|
|
145
|
+
expirationDate: string;
|
|
146
|
+
}
|
|
138
147
|
|
|
139
148
|
interface CreateBankAccount_createBankAccount_bankAccountDetails_CanadianBankAccountDetails {
|
|
140
149
|
__typename: 'CanadianBankAccountDetails' | 'UKBankAccountDetails' | 'IBANBankAccountDetails';
|
|
@@ -313,6 +322,24 @@ interface CurrentUser {
|
|
|
313
322
|
verification: CurrentUser_verification | null;
|
|
314
323
|
}
|
|
315
324
|
|
|
325
|
+
interface DebitCardFragment {
|
|
326
|
+
__typename: 'DebitCard';
|
|
327
|
+
id: string;
|
|
328
|
+
type: PayableAccountType;
|
|
329
|
+
name: string | null;
|
|
330
|
+
userId: string;
|
|
331
|
+
country: string;
|
|
332
|
+
currency: string;
|
|
333
|
+
payable: boolean;
|
|
334
|
+
debitCardNetwork: DebitCardNetwork;
|
|
335
|
+
expirationDate: string;
|
|
336
|
+
cardNumber: string;
|
|
337
|
+
mask: string | null;
|
|
338
|
+
createdAt: any;
|
|
339
|
+
paymentCount: number;
|
|
340
|
+
externalId: string | null;
|
|
341
|
+
}
|
|
342
|
+
|
|
316
343
|
interface GetSolanaPayParams_solanaParams {
|
|
317
344
|
__typename: 'SolanaParamsResponse';
|
|
318
345
|
transactionSerialized: string;
|
|
@@ -790,6 +817,27 @@ interface UserBills {
|
|
|
790
817
|
bills: UserBills_bills[];
|
|
791
818
|
}
|
|
792
819
|
|
|
820
|
+
interface UserDebitCards_debitCards {
|
|
821
|
+
__typename: 'DebitCard';
|
|
822
|
+
id: string;
|
|
823
|
+
type: PayableAccountType;
|
|
824
|
+
name: string | null;
|
|
825
|
+
userId: string;
|
|
826
|
+
country: string;
|
|
827
|
+
currency: string;
|
|
828
|
+
payable: boolean;
|
|
829
|
+
debitCardNetwork: DebitCardNetwork;
|
|
830
|
+
expirationDate: string;
|
|
831
|
+
cardNumber: string;
|
|
832
|
+
mask: string | null;
|
|
833
|
+
createdAt: any;
|
|
834
|
+
paymentCount: number;
|
|
835
|
+
externalId: string | null;
|
|
836
|
+
}
|
|
837
|
+
interface UserDebitCards {
|
|
838
|
+
debitCards: UserDebitCards_debitCards[];
|
|
839
|
+
}
|
|
840
|
+
|
|
793
841
|
interface UserFragment {
|
|
794
842
|
__typename: 'User';
|
|
795
843
|
id: string;
|
|
@@ -1104,6 +1152,31 @@ interface WalletTokenBalancesVariables {
|
|
|
1104
1152
|
network?: string | null;
|
|
1105
1153
|
}
|
|
1106
1154
|
|
|
1155
|
+
interface DeletePayableAccount_deletePayableAccount_DebitCard_dataSync {
|
|
1156
|
+
__typename: 'AccountDataSync';
|
|
1157
|
+
lastSync: any | null;
|
|
1158
|
+
syncStatus: AccountSyncStatus | null;
|
|
1159
|
+
}
|
|
1160
|
+
interface DeletePayableAccount_deletePayableAccount_DebitCard_institution {
|
|
1161
|
+
__typename: 'BankAccountInstitution' | 'BillInstitution';
|
|
1162
|
+
id: string;
|
|
1163
|
+
name: string;
|
|
1164
|
+
logo: string | null;
|
|
1165
|
+
}
|
|
1166
|
+
interface DeletePayableAccount_deletePayableAccount_DebitCard {
|
|
1167
|
+
__typename: 'DebitCard' | 'DigitalAccount';
|
|
1168
|
+
id: string;
|
|
1169
|
+
name: string | null;
|
|
1170
|
+
userId: string;
|
|
1171
|
+
country: string;
|
|
1172
|
+
currency: string;
|
|
1173
|
+
payable: boolean;
|
|
1174
|
+
originator: PayableAccountOriginator;
|
|
1175
|
+
type: PayableAccountType;
|
|
1176
|
+
createdAt: any;
|
|
1177
|
+
dataSync: DeletePayableAccount_deletePayableAccount_DebitCard_dataSync | null;
|
|
1178
|
+
institution: DeletePayableAccount_deletePayableAccount_DebitCard_institution | null;
|
|
1179
|
+
}
|
|
1107
1180
|
interface DeletePayableAccount_deletePayableAccount_BankAccount_dataSync {
|
|
1108
1181
|
__typename: 'AccountDataSync';
|
|
1109
1182
|
lastSync: any | null;
|
|
@@ -1369,6 +1442,51 @@ declare class BillService {
|
|
|
1369
1442
|
add(institutionId: string, accountNumber: string, type?: BillType): Promise<CreateUSBill_addUSBill>;
|
|
1370
1443
|
}
|
|
1371
1444
|
|
|
1445
|
+
interface CreateDebitCard_createDebitCard {
|
|
1446
|
+
__typename: 'DebitCard';
|
|
1447
|
+
id: string;
|
|
1448
|
+
type: PayableAccountType;
|
|
1449
|
+
name: string | null;
|
|
1450
|
+
userId: string;
|
|
1451
|
+
country: string;
|
|
1452
|
+
currency: string;
|
|
1453
|
+
payable: boolean;
|
|
1454
|
+
debitCardNetwork: DebitCardNetwork;
|
|
1455
|
+
expirationDate: string;
|
|
1456
|
+
cardNumber: string;
|
|
1457
|
+
mask: string | null;
|
|
1458
|
+
createdAt: any;
|
|
1459
|
+
paymentCount: number;
|
|
1460
|
+
externalId: string | null;
|
|
1461
|
+
}
|
|
1462
|
+
|
|
1463
|
+
interface RenameDebitCard_renamePayableAccount_DebitCard {
|
|
1464
|
+
__typename: 'DebitCard';
|
|
1465
|
+
id: string;
|
|
1466
|
+
type: PayableAccountType;
|
|
1467
|
+
name: string | null;
|
|
1468
|
+
userId: string;
|
|
1469
|
+
country: string;
|
|
1470
|
+
currency: string;
|
|
1471
|
+
payable: boolean;
|
|
1472
|
+
debitCardNetwork: DebitCardNetwork;
|
|
1473
|
+
expirationDate: string;
|
|
1474
|
+
cardNumber: string;
|
|
1475
|
+
mask: string | null;
|
|
1476
|
+
createdAt: any;
|
|
1477
|
+
paymentCount: number;
|
|
1478
|
+
externalId: string | null;
|
|
1479
|
+
}
|
|
1480
|
+
|
|
1481
|
+
declare class DebitCardService {
|
|
1482
|
+
private client;
|
|
1483
|
+
constructor(client: SpritzClient);
|
|
1484
|
+
list(): Promise<UserDebitCards_debitCards[]>;
|
|
1485
|
+
rename(accountId: string, name: string): Promise<RenameDebitCard_renamePayableAccount_DebitCard>;
|
|
1486
|
+
delete(accountId: string): Promise<DeletePayableAccount_deletePayableAccount_DebitCard>;
|
|
1487
|
+
create(input: DebitCardInput): Promise<CreateDebitCard_createDebitCard>;
|
|
1488
|
+
}
|
|
1489
|
+
|
|
1372
1490
|
declare class InstitutionService {
|
|
1373
1491
|
private client;
|
|
1374
1492
|
constructor(client: SpritzClient);
|
|
@@ -1580,7 +1698,7 @@ declare class VirtualCardService {
|
|
|
1580
1698
|
create<T extends VirtualCardType>(type: T, input?: CreateInputMapping[T]): Promise<NonNullable<CreateMutationMapping[T]["query"][keyof CreateMutationMapping[T]["query"]]> | null>;
|
|
1581
1699
|
}
|
|
1582
1700
|
|
|
1583
|
-
type WebhookEvent = 'account.created' | 'account.updated' | 'account.deleted' | 'payment.created' | 'payment.updated' | 'payment.completed' | 'payment.refunded';
|
|
1701
|
+
type WebhookEvent = 'account.created' | 'account.updated' | 'account.deleted' | 'payment.created' | 'payment.updated' | 'payment.completed' | 'payment.refunded' | 'verification.status.updated';
|
|
1584
1702
|
type IntegratorWebhook = {
|
|
1585
1703
|
id: string;
|
|
1586
1704
|
integratorId: string;
|
|
@@ -1597,6 +1715,9 @@ declare class WebhookService {
|
|
|
1597
1715
|
private client;
|
|
1598
1716
|
constructor(client: SpritzClient);
|
|
1599
1717
|
create(args: CreateWebhookParams): Promise<IntegratorWebhook>;
|
|
1718
|
+
updateWebhookSecret(secret: string): Promise<{
|
|
1719
|
+
success: boolean;
|
|
1720
|
+
}>;
|
|
1600
1721
|
}
|
|
1601
1722
|
|
|
1602
1723
|
type ClientOptions = {
|
|
@@ -1630,6 +1751,7 @@ declare class SpritzApiClient {
|
|
|
1630
1751
|
private client;
|
|
1631
1752
|
user: UserService;
|
|
1632
1753
|
bankAccount: BankAccountService;
|
|
1754
|
+
debitCard: DebitCardService;
|
|
1633
1755
|
paymentRequest: PaymentRequestService;
|
|
1634
1756
|
payment: PaymentService;
|
|
1635
1757
|
onrampPayment: OnrampPaymentService;
|
|
@@ -1643,5 +1765,5 @@ declare class SpritzApiClient {
|
|
|
1643
1765
|
setApiKey(_apiKey: string): this;
|
|
1644
1766
|
}
|
|
1645
1767
|
|
|
1646
|
-
export { BankAccountSubType, BankAccountType, BillType, Environment, PayableAccountType, PaymentNetwork, DirectPaymentStatus as PaymentRequestStatus, PaymentStatus, SpritzApiClient, VirtualCardType };
|
|
1647
|
-
export type { AccountPayments, AccountPaymentsVariables, AccountPayments_paymentsForAccount, BankAccountFragment, BankAccountFragment_bankAccountDetails, BankAccountFragment_bankAccountDetails_CanadianBankAccountDetails, BankAccountFragment_bankAccountDetails_USBankAccountDetails, BankAccountFragment_institution, BankAccountFragment_paymentAddresses, BankAccountInput, BillFragment, BillFragment_billAccountDetails, BillFragment_dataSync, BillFragment_institution, BillFragment_paymentAddresses, ClientOptions, CreateDirectPaymentInput, CreateOnrampPaymentInput, CreatePaymentRequestInput, CurrentUser, CurrentUser_me, CurrentUser_verification, CurrentUser_verification_identity, GetSolanaPayParams, GetSolanaPayParamsVariables, GetSolanaPayParams_solanaParams, GetSpritzPayParams, GetSpritzPayParamsVariables, GetSpritzPayParams_spritzPayParams, OnrampPaymentFragment, OnrampPaymentFragment_depositInstructions, OnrampPayments, OnrampPayments_onrampPayments, OnrampPayments_onrampPayments_depositInstructions, PayableAccountFragment, PayableAccountFragment_BankAccount, PayableAccountFragment_BankAccount_bankAccountDetails, PayableAccountFragment_BankAccount_bankAccountDetails_CanadianBankAccountDetails, PayableAccountFragment_BankAccount_bankAccountDetails_USBankAccountDetails, PayableAccountFragment_BankAccount_dataSync, PayableAccountFragment_BankAccount_institution, PayableAccountFragment_Bill, PayableAccountFragment_Bill_billAccountDetails, PayableAccountFragment_Bill_dataSync, PayableAccountFragment_Bill_institution, PayableAccountFragment_DebitCard, PayableAccountFragment_DebitCard_dataSync, PayableAccountFragment_DebitCard_institution, PayableAccountFragment_VirtualCard, PayableAccountFragment_VirtualCard_billingInfo, PayableAccountFragment_VirtualCard_billingInfo_address, PayableAccountFragment_VirtualCard_dataSync, PayableAccountFragment_VirtualCard_institution, PayableAccountInstitutionFragment, Payment, PaymentFragment, PaymentRequestFragment, PaymentRequestPayment, PaymentRequestPaymentVariables, PaymentRequestPayment_paymentForPaymentRequest, PaymentVariables, Payment_payment, PopularBillInstitutions, PopularBillInstitutionsVariables, PopularBillInstitutions_popularUSBillInstitutions, SearchUSBillInstitutions, SearchUSBillInstitutionsVariables, SearchUSBillInstitutions_searchUSBillInstitutions, TokenBalanceFragment, UserBankAccounts, UserBankAccounts_bankAccounts, UserBankAccounts_bankAccounts_bankAccountDetails, UserBankAccounts_bankAccounts_bankAccountDetails_CanadianBankAccountDetails, UserBankAccounts_bankAccounts_bankAccountDetails_USBankAccountDetails, UserBankAccounts_bankAccounts_institution, UserBankAccounts_bankAccounts_paymentAddresses, UserBills, UserBills_bills, UserBills_bills_billAccountDetails, UserBills_bills_dataSync, UserBills_bills_institution, UserBills_bills_paymentAddresses, UserFragment, UserPayableAccounts, UserPayableAccounts_payableAccounts, UserPayableAccounts_payableAccounts_BankAccount, UserPayableAccounts_payableAccounts_BankAccount_bankAccountDetails, UserPayableAccounts_payableAccounts_BankAccount_bankAccountDetails_CanadianBankAccountDetails, UserPayableAccounts_payableAccounts_BankAccount_bankAccountDetails_USBankAccountDetails, UserPayableAccounts_payableAccounts_BankAccount_dataSync, UserPayableAccounts_payableAccounts_BankAccount_institution, UserPayableAccounts_payableAccounts_Bill, UserPayableAccounts_payableAccounts_Bill_billAccountDetails, UserPayableAccounts_payableAccounts_Bill_dataSync, UserPayableAccounts_payableAccounts_Bill_institution, UserPayableAccounts_payableAccounts_DebitCard, UserPayableAccounts_payableAccounts_DebitCard_dataSync, UserPayableAccounts_payableAccounts_DebitCard_institution, UserPayableAccounts_payableAccounts_VirtualCard, UserPayableAccounts_payableAccounts_VirtualCard_billingInfo, UserPayableAccounts_payableAccounts_VirtualCard_billingInfo_address, UserPayableAccounts_payableAccounts_VirtualCard_dataSync, UserPayableAccounts_payableAccounts_VirtualCard_institution, UserVerification, UserVerification_verification, UserVerification_verification_identity, UserVerification_verification_identity_user, UserVirtualDebitCard, UserVirtualDebitCard_virtualDebitCard, UserVirtualDebitCard_virtualDebitCard_billingInfo, UserVirtualDebitCard_virtualDebitCard_billingInfo_address, UserVirtualDebitCard_virtualDebitCard_paymentAddresses, VerificationFragment, VerificationFragment_identity, VirtualDebitCardFragment, VirtualDebitCardFragment_billingInfo, VirtualDebitCardFragment_billingInfo_address, VirtualDebitCardFragment_paymentAddresses, WalletTokenBalances, WalletTokenBalancesVariables, WalletTokenBalances_tokenBalances };
|
|
1768
|
+
export { BankAccountSubType, BankAccountType, BillType, DebitCardNetwork, Environment, PayableAccountType, PaymentNetwork, DirectPaymentStatus as PaymentRequestStatus, PaymentStatus, SpritzApiClient, VirtualCardType };
|
|
1769
|
+
export type { AccountPayments, AccountPaymentsVariables, AccountPayments_paymentsForAccount, BankAccountFragment, BankAccountFragment_bankAccountDetails, BankAccountFragment_bankAccountDetails_CanadianBankAccountDetails, BankAccountFragment_bankAccountDetails_USBankAccountDetails, BankAccountFragment_institution, BankAccountFragment_paymentAddresses, BankAccountInput, BillFragment, BillFragment_billAccountDetails, BillFragment_dataSync, BillFragment_institution, BillFragment_paymentAddresses, ClientOptions, CreateDirectPaymentInput, CreateOnrampPaymentInput, CreatePaymentRequestInput, CurrentUser, CurrentUser_me, CurrentUser_verification, CurrentUser_verification_identity, DebitCardFragment, DebitCardInput, GetSolanaPayParams, GetSolanaPayParamsVariables, GetSolanaPayParams_solanaParams, GetSpritzPayParams, GetSpritzPayParamsVariables, GetSpritzPayParams_spritzPayParams, OnrampPaymentFragment, OnrampPaymentFragment_depositInstructions, OnrampPayments, OnrampPayments_onrampPayments, OnrampPayments_onrampPayments_depositInstructions, PayableAccountFragment, PayableAccountFragment_BankAccount, PayableAccountFragment_BankAccount_bankAccountDetails, PayableAccountFragment_BankAccount_bankAccountDetails_CanadianBankAccountDetails, PayableAccountFragment_BankAccount_bankAccountDetails_USBankAccountDetails, PayableAccountFragment_BankAccount_dataSync, PayableAccountFragment_BankAccount_institution, PayableAccountFragment_Bill, PayableAccountFragment_Bill_billAccountDetails, PayableAccountFragment_Bill_dataSync, PayableAccountFragment_Bill_institution, PayableAccountFragment_DebitCard, PayableAccountFragment_DebitCard_dataSync, PayableAccountFragment_DebitCard_institution, PayableAccountFragment_VirtualCard, PayableAccountFragment_VirtualCard_billingInfo, PayableAccountFragment_VirtualCard_billingInfo_address, PayableAccountFragment_VirtualCard_dataSync, PayableAccountFragment_VirtualCard_institution, PayableAccountInstitutionFragment, Payment, PaymentFragment, PaymentRequestFragment, PaymentRequestPayment, PaymentRequestPaymentVariables, PaymentRequestPayment_paymentForPaymentRequest, PaymentVariables, Payment_payment, PopularBillInstitutions, PopularBillInstitutionsVariables, PopularBillInstitutions_popularUSBillInstitutions, SearchUSBillInstitutions, SearchUSBillInstitutionsVariables, SearchUSBillInstitutions_searchUSBillInstitutions, TokenBalanceFragment, UserBankAccounts, UserBankAccounts_bankAccounts, UserBankAccounts_bankAccounts_bankAccountDetails, UserBankAccounts_bankAccounts_bankAccountDetails_CanadianBankAccountDetails, UserBankAccounts_bankAccounts_bankAccountDetails_USBankAccountDetails, UserBankAccounts_bankAccounts_institution, UserBankAccounts_bankAccounts_paymentAddresses, UserBills, UserBills_bills, UserBills_bills_billAccountDetails, UserBills_bills_dataSync, UserBills_bills_institution, UserBills_bills_paymentAddresses, UserDebitCards, UserDebitCards_debitCards, UserFragment, UserPayableAccounts, UserPayableAccounts_payableAccounts, UserPayableAccounts_payableAccounts_BankAccount, UserPayableAccounts_payableAccounts_BankAccount_bankAccountDetails, UserPayableAccounts_payableAccounts_BankAccount_bankAccountDetails_CanadianBankAccountDetails, UserPayableAccounts_payableAccounts_BankAccount_bankAccountDetails_USBankAccountDetails, UserPayableAccounts_payableAccounts_BankAccount_dataSync, UserPayableAccounts_payableAccounts_BankAccount_institution, UserPayableAccounts_payableAccounts_Bill, UserPayableAccounts_payableAccounts_Bill_billAccountDetails, UserPayableAccounts_payableAccounts_Bill_dataSync, UserPayableAccounts_payableAccounts_Bill_institution, UserPayableAccounts_payableAccounts_DebitCard, UserPayableAccounts_payableAccounts_DebitCard_dataSync, UserPayableAccounts_payableAccounts_DebitCard_institution, UserPayableAccounts_payableAccounts_VirtualCard, UserPayableAccounts_payableAccounts_VirtualCard_billingInfo, UserPayableAccounts_payableAccounts_VirtualCard_billingInfo_address, UserPayableAccounts_payableAccounts_VirtualCard_dataSync, UserPayableAccounts_payableAccounts_VirtualCard_institution, UserVerification, UserVerification_verification, UserVerification_verification_identity, UserVerification_verification_identity_user, UserVirtualDebitCard, UserVirtualDebitCard_virtualDebitCard, UserVirtualDebitCard_virtualDebitCard_billingInfo, UserVirtualDebitCard_virtualDebitCard_billingInfo_address, UserVirtualDebitCard_virtualDebitCard_paymentAddresses, VerificationFragment, VerificationFragment_identity, VirtualDebitCardFragment, VirtualDebitCardFragment_billingInfo, VirtualDebitCardFragment_billingInfo_address, VirtualDebitCardFragment_paymentAddresses, WalletTokenBalances, WalletTokenBalancesVariables, WalletTokenBalances_tokenBalances };
|