@spritz-finance/api-client 0.4.14 → 0.4.16

package/dist/spritz-api-client.d.ts

@@ -101,7 +101,21 @@ declare enum PaymentStatus {
     SCHEDULED = "SCHEDULED",
     SENT = "SENT"
 }
+/**
+ * The reason for a verification failure
+ */
+declare enum VerificationFailureReason {
+    AddressInvalid = "AddressInvalid",
+    DocumentVerification = "DocumentVerification",
+    DuplicateIdentity = "DuplicateIdentity",
+    KycCheck = "KycCheck",
+    RiskCheck = "RiskCheck",
+    SelfieCheck = "SelfieCheck",
+    VerifySms = "VerifySms",
+    WatchlistScreening = "WatchlistScreening"
+}
 declare enum VirtualCardType {
+    USPhysicalDebitCard = "USPhysicalDebitCard",
     USVirtualDebitCard = "USVirtualDebitCard"
 }
 interface BankAccountAddressInput {
@@ -317,12 +331,22 @@ interface CurrentUser_me {
     createdAt: any;
     timezone: string | null;
 }
+interface CurrentUser_verification_identity_verificationMetadata_details {
+    __typename: 'VerificationMetadataDetails';
+    matchedEmail: string | null;
+}
+interface CurrentUser_verification_identity_verificationMetadata {
+    __typename: 'VerificationMetadata';
+    failureReason: VerificationFailureReason | null;
+    details: CurrentUser_verification_identity_verificationMetadata_details | null;
+}
 interface CurrentUser_verification_identity {
     __typename: 'IdentityModule';
     canRetry: boolean;
     status: ModuleStatus;
     country: string | null;
     verificationUrl: string | null;
+    verificationMetadata: CurrentUser_verification_identity_verificationMetadata | null;
 }
 interface CurrentUser_verification {
     __typename: 'Verification';
@@ -1049,12 +1073,22 @@ interface UserVerification_verification_identity_user {
     email: string | null;
     completedAt: string | null;
 }
+interface UserVerification_verification_identity_verificationMetadata_details {
+    __typename: 'VerificationMetadataDetails';
+    matchedEmail: string | null;
+}
+interface UserVerification_verification_identity_verificationMetadata {
+    __typename: 'VerificationMetadata';
+    failureReason: VerificationFailureReason | null;
+    details: UserVerification_verification_identity_verificationMetadata_details | null;
+}
 interface UserVerification_verification_identity {
     __typename: 'IdentityModule';
     status: ModuleStatus;
     country: string | null;
     verificationUrl: string | null;
     user: UserVerification_verification_identity_user | null;
+    verificationMetadata: UserVerification_verification_identity_verificationMetadata | null;
 }
 interface UserVerification_verification {
     __typename: 'Verification';
@@ -1106,12 +1140,22 @@ interface UserVirtualDebitCard {
     virtualDebitCard: UserVirtualDebitCard_virtualDebitCard | null;
 }
 
+interface VerificationFragment_identity_verificationMetadata_details {
+    __typename: 'VerificationMetadataDetails';
+    matchedEmail: string | null;
+}
+interface VerificationFragment_identity_verificationMetadata {
+    __typename: 'VerificationMetadata';
+    failureReason: VerificationFailureReason | null;
+    details: VerificationFragment_identity_verificationMetadata_details | null;
+}
 interface VerificationFragment_identity {
     __typename: 'IdentityModule';
     canRetry: boolean;
     status: ModuleStatus;
     country: string | null;
     verificationUrl: string | null;
+    verificationMetadata: VerificationFragment_identity_verificationMetadata | null;
 }
 interface VerificationFragment {
     __typename: 'Verification';
@@ -1670,12 +1714,24 @@ declare class UserService {
         verificationUrl: string | null;
         verifiedCountry: string | null;
         canRetryVerification: boolean;
+        verificationMetadata: {
+            failureReason: VerificationFailureReason.DuplicateIdentity;
+            details: {
+                matchedEmail: string | null;
+            };
+        } | null;
     }) | null>;
     retryFailedVerification(): Promise<(CurrentUser_me & {
         verificationStatus: VerificationStatus;
         verificationUrl: string | null;
         verifiedCountry: string | null;
         canRetryVerification: boolean;
+        verificationMetadata: {
+            failureReason: VerificationFailureReason.DuplicateIdentity;
+            details: {
+                matchedEmail: string | null;
+            };
+        } | null;
     }) | null>;
     getVerificationToken(): Promise<string>;
 }
@@ -1735,7 +1791,7 @@ declare class VirtualCardService {
     private client;
     constructor(client: SpritzClient);
     fetch(): Promise<UserVirtualDebitCard_virtualDebitCard | null>;
-    create<T extends VirtualCardType>(type: T, input?: CreateInputMapping[T]): Promise<NonNullable<CreateMutationMapping[T]["query"][keyof CreateMutationMapping[T]["query"]]> | null>;
+    create<T extends VirtualCardType>(type: T, input?: CreateInputMapping[T]): Promise<NonNullable<NonNullable<Awaited<CreateMutationMapping[T]["query"]>>[keyof CreateMutationMapping[T]["query"]]> | null>;
 }
 
 type WebhookEvent = 'account.created' | 'account.updated' | 'account.deleted' | 'payment.created' | 'payment.updated' | 'payment.completed' | 'payment.refunded' | 'verification.status.updated';
@@ -1758,6 +1814,8 @@ declare class WebhookService {
     updateWebhookSecret(secret: string): Promise<{
         success: boolean;
     }>;
+    list(): Promise<IntegratorWebhook[]>;
+    delete(webhookId: string): Promise<IntegratorWebhook>;
 }
 
 type ClientOptions = {
@@ -1806,4 +1864,4 @@ declare class SpritzApiClient {
 }
 
 export { AmountMode, BankAccountSubType, BankAccountType, BillType, DebitCardNetwork, Environment, PayableAccountType, PaymentDeliveryMethod, PaymentNetwork, DirectPaymentStatus as PaymentRequestStatus, PaymentStatus, SpritzApiClient, VirtualCardType };
-export type { AccountPayments, AccountPaymentsVariables, AccountPayments_paymentsForAccount, AccountPayments_paymentsForAccount_transaction, 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, PaymentFragment_transaction, PaymentRequestFragment, PaymentRequestPayment, PaymentRequestPaymentVariables, PaymentRequestPayment_paymentForPaymentRequest, PaymentRequestPayment_paymentForPaymentRequest_transaction, PaymentVariables, Payment_payment, Payment_payment_transaction, 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 };
+export type { AccountPayments, AccountPaymentsVariables, AccountPayments_paymentsForAccount, AccountPayments_paymentsForAccount_transaction, 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, CurrentUser_verification_identity_verificationMetadata, CurrentUser_verification_identity_verificationMetadata_details, 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, PaymentFragment_transaction, PaymentRequestFragment, PaymentRequestPayment, PaymentRequestPaymentVariables, PaymentRequestPayment_paymentForPaymentRequest, PaymentRequestPayment_paymentForPaymentRequest_transaction, PaymentVariables, Payment_payment, Payment_payment_transaction, 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, UserVerification_verification_identity_verificationMetadata, UserVerification_verification_identity_verificationMetadata_details, UserVirtualDebitCard, UserVirtualDebitCard_virtualDebitCard, UserVirtualDebitCard_virtualDebitCard_billingInfo, UserVirtualDebitCard_virtualDebitCard_billingInfo_address, UserVirtualDebitCard_virtualDebitCard_paymentAddresses, VerificationFragment, VerificationFragment_identity, VerificationFragment_identity_verificationMetadata, VerificationFragment_identity_verificationMetadata_details, VirtualDebitCardFragment, VirtualDebitCardFragment_billingInfo, VirtualDebitCardFragment_billingInfo_address, VirtualDebitCardFragment_paymentAddresses, WalletTokenBalances, WalletTokenBalancesVariables, WalletTokenBalances_tokenBalances };