@spritz-finance/api-client 0.2.1 → 0.2.3

package/README.md

@@ -40,6 +40,7 @@ A Typescript library for interacting with the Spritz Finance API
   - [Bank Accounts](#bank-accounts)
     - [List user bank accounts](#list-user-bank-accounts)
     - [Add US bank account](#add-us-bank-account)
+    - [Add Canadian bank account](#add-canadian-bank-account)
   - [Bills](#bills)
     - [List user bills](#list-user-bills)
     - [Add US bill account](#add-us-bill-account)
@@ -286,6 +287,7 @@ const bankAccounts = [{
   },
   ownedByUser: true,
   createdAt: "2023-05-03T11:25:02.401Z",
+  deliveryMethods: ['STANDARD', 'INSTANT']
 }]
 ```
 
@@ -314,7 +316,40 @@ import { BankAccountType, BankAccountSubType } from '@spritz-finance/api-client'
 const bankAccounts = await client.bankAccount.create(BankAccountType.USBankAccount, {
   accountNumber: '123456789',
   routingNumber: '987654321',
-  email: 'bilbo@shiremail.net',
+  holder: 'Bilbo Baggins',
+  name: 'Precious Savings',
+  ownedByUser: true,
+  subType: BankAccountSubType.Savings,
+})
+```
+
+#### Add Canadian bank account
+
+Currently, Spritz supports the addition of Canadian bank accounts:
+
+The input structure for adding a Canadian bank account is defined as:
+
+```typescript
+// Input arguments for creating a Canadian bank account
+export interface CABankAccountInput {
+  accountNumber: string
+  email?: string
+  holder: string
+  name: string
+  ownedByUser?: boolean | null
+  transitNumber: string
+  institutionNumber: string
+  subType: BankAccountSubType
+}
+```
+
+```typescript
+import { BankAccountType, BankAccountSubType } from '@spritz-finance/api-client'
+
+const bankAccounts = await client.bankAccount.create(BankAccountType.CABankAccount, {
+  accountNumber: '123456789',
+  transitNumber: '12345',
+  institutionNumber: '123',
   holder: 'Bilbo Baggins',
   name: 'Precious Savings',
   ownedByUser: true,
@@ -371,6 +406,7 @@ const bills = [
       logo: 'https://tinyurl.com/shire-bank-logo',
     },
     createdAt: '2023-05-03T11:25:02.401Z',
+    deliveryMethods: ['STANDARD']
   },
 ]
 ```
@@ -523,6 +559,7 @@ const paymentRequest = await client.paymentRequest.create({
 	amount: 100,
 	accountId: account.id,
 	network: PaymentNetwork.Ethereum,
+  deliveryMethod: 'INSTANT'
 });
 
 // Example response

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

@@ -21,6 +21,7 @@ declare enum BankAccountSubType {
     Savings = "Savings"
 }
 declare enum BankAccountType {
+    CABankAccount = "CABankAccount",
     USBankAccount = "USBankAccount"
 }
 declare enum BillType {
@@ -62,6 +63,10 @@ declare enum PayableAccountType {
     Bill = "Bill",
     VirtualCard = "VirtualCard"
 }
+declare enum PaymentDeliveryMethod {
+    INSTANT = "INSTANT",
+    STANDARD = "STANDARD"
+}
 declare enum PaymentStatus {
     CANCELLED = "CANCELLED",
     COMPLETED = "COMPLETED",
@@ -77,9 +82,20 @@ declare enum PaymentStatus {
 declare enum VirtualCardType {
     USVirtualDebitCard = "USVirtualDebitCard"
 }
+interface BankAccountInput {
+    accountNumber: string;
+    details?: any | null;
+    email?: string | null;
+    holder?: string | null;
+    name: string;
+    ownedByUser?: boolean | null;
+    subType: BankAccountSubType;
+    type: BankAccountType;
+}
 interface CreateDirectPaymentInput {
     accountId: string;
     amount: number;
+    deliveryMethod?: PaymentDeliveryMethod | null;
     network?: string | null;
     provider?: AccountProvider | null;
     rewardsAmount?: number | null;
@@ -87,14 +103,46 @@ interface CreateDirectPaymentInput {
     testPayment?: boolean | null;
     tokenAddress?: string | null;
 }
-interface USBankAccountInput {
+
+interface CreateBankAccount_createBankAccount_bankAccountDetails_CanadianBankAccountDetails {
+    __typename: 'CanadianBankAccountDetails';
+}
+interface CreateBankAccount_createBankAccount_bankAccountDetails_USBankAccountDetails {
+    __typename: 'USBankAccountDetails';
+    routingNumber: string;
+}
+type CreateBankAccount_createBankAccount_bankAccountDetails = CreateBankAccount_createBankAccount_bankAccountDetails_CanadianBankAccountDetails | CreateBankAccount_createBankAccount_bankAccountDetails_USBankAccountDetails;
+interface CreateBankAccount_createBankAccount_dataSync {
+    __typename: 'AccountDataSync';
+    lastSync: any | null;
+    syncStatus: AccountSyncStatus | null;
+}
+interface CreateBankAccount_createBankAccount_institution {
+    __typename: 'BankAccountInstitution' | 'BillInstitution';
+    id: string;
+    name: string;
+    logo: string | null;
+}
+interface CreateBankAccount_createBankAccount {
+    __typename: 'BankAccount';
+    id: string;
+    name: string | null;
+    userId: string;
+    country: string;
+    currency: string;
+    payable: boolean;
+    originator: PayableAccountOriginator;
+    type: PayableAccountType;
+    createdAt: any;
     accountNumber: string;
-    email: string;
+    bankAccountType: BankAccountType;
+    bankAccountSubType: BankAccountSubType;
     holder: string;
-    name: string;
-    ownedByUser?: boolean | null;
-    routingNumber: string;
-    subType: BankAccountSubType;
+    email: string | null;
+    ownedByUser: boolean;
+    bankAccountDetails: CreateBankAccount_createBankAccount_bankAccountDetails;
+    dataSync: CreateBankAccount_createBankAccount_dataSync | null;
+    institution: CreateBankAccount_createBankAccount_institution | null;
 }
 
 interface AccountPayments_paymentsForAccount {
@@ -102,10 +150,11 @@ interface AccountPayments_paymentsForAccount {
     id: string;
     userId: any;
     status: PaymentStatus;
-    accountId: any | null;
+    accountId: any;
     amount: number | null;
     feeAmount: number | null;
     createdAt: any;
+    deliveryMethod: PaymentDeliveryMethod | null;
 }
 interface AccountPayments {
     paymentsForAccount: AccountPayments_paymentsForAccount[];
@@ -143,9 +192,10 @@ interface BankAccountFragment {
     bankAccountType: BankAccountType;
     bankAccountSubType: BankAccountSubType;
     holder: string;
-    email: string;
+    email: string | null;
     ownedByUser: boolean;
     bankAccountDetails: BankAccountFragment_bankAccountDetails;
+    deliveryMethods: PaymentDeliveryMethod[];
     institution: BankAccountFragment_institution | null;
 }
 
@@ -258,7 +308,7 @@ interface PayableAccountFragment_BankAccount {
     bankAccountType: BankAccountType;
     bankAccountSubType: BankAccountSubType;
     holder: string;
-    email: string;
+    email: string | null;
     ownedByUser: boolean;
     bankAccountDetails: PayableAccountFragment_BankAccount_bankAccountDetails;
     dataSync: PayableAccountFragment_BankAccount_dataSync | null;
@@ -357,7 +407,6 @@ interface PayableAccountInstitutionFragment {
     id: string;
     country: string;
     currency: string;
-    createdAt: any;
     name: string;
     logo: string | null;
 }
@@ -367,10 +416,11 @@ interface PaymentFragment {
     id: string;
     userId: any;
     status: PaymentStatus;
-    accountId: any | null;
+    accountId: any;
     amount: number | null;
     feeAmount: number | null;
     createdAt: any;
+    deliveryMethod: PaymentDeliveryMethod | null;
 }
 
 interface PaymentRequestFragment {
@@ -384,6 +434,7 @@ interface PaymentRequestFragment {
     amountDue: number;
     network: string;
     createdAt: any;
+    deliveryMethod: string | null;
 }
 
 interface PaymentRequestPayment_paymentForPaymentRequest {
@@ -391,10 +442,11 @@ interface PaymentRequestPayment_paymentForPaymentRequest {
     id: string;
     userId: any;
     status: PaymentStatus;
-    accountId: any | null;
+    accountId: any;
     amount: number | null;
     feeAmount: number | null;
     createdAt: any;
+    deliveryMethod: PaymentDeliveryMethod | null;
 }
 interface PaymentRequestPayment {
     paymentForPaymentRequest: PaymentRequestPayment_paymentForPaymentRequest | null;
@@ -408,7 +460,6 @@ interface PopularBillInstitutions_popularUSBillInstitutions {
     id: string;
     country: string;
     currency: string;
-    createdAt: any;
     name: string;
     logo: string | null;
 }
@@ -424,7 +475,6 @@ interface SearchUSBillInstitutions_searchUSBillInstitutions {
     id: string;
     country: string;
     currency: string;
-    createdAt: any;
     name: string;
     logo: string | null;
 }
@@ -495,9 +545,10 @@ interface UserBankAccounts_bankAccounts {
     bankAccountType: BankAccountType;
     bankAccountSubType: BankAccountSubType;
     holder: string;
-    email: string;
+    email: string | null;
     ownedByUser: boolean;
     bankAccountDetails: UserBankAccounts_bankAccounts_bankAccountDetails;
+    deliveryMethods: PaymentDeliveryMethod[];
     institution: UserBankAccounts_bankAccounts_institution | null;
 }
 interface UserBankAccounts {
@@ -596,7 +647,7 @@ interface UserPayableAccounts_payableAccounts_BankAccount {
     bankAccountType: BankAccountType;
     bankAccountSubType: BankAccountSubType;
     holder: string;
-    email: string;
+    email: string | null;
     ownedByUser: boolean;
     bankAccountDetails: UserPayableAccounts_payableAccounts_BankAccount_bankAccountDetails;
 }
@@ -811,53 +862,6 @@ interface WalletTokenBalancesVariables {
     network?: string | null;
 }
 
-interface CreateUSBankAccount_createUSBankAccount_bankAccountDetails_CanadianBankAccountDetails {
-    __typename: 'CanadianBankAccountDetails';
-}
-interface CreateUSBankAccount_createUSBankAccount_bankAccountDetails_USBankAccountDetails {
-    __typename: 'USBankAccountDetails';
-    routingNumber: string;
-}
-type CreateUSBankAccount_createUSBankAccount_bankAccountDetails = CreateUSBankAccount_createUSBankAccount_bankAccountDetails_CanadianBankAccountDetails | CreateUSBankAccount_createUSBankAccount_bankAccountDetails_USBankAccountDetails;
-interface CreateUSBankAccount_createUSBankAccount_dataSync {
-    __typename: 'AccountDataSync';
-    lastSync: any | null;
-    syncStatus: AccountSyncStatus | null;
-}
-interface CreateUSBankAccount_createUSBankAccount_institution {
-    __typename: 'BankAccountInstitution' | 'BillInstitution';
-    id: string;
-    name: string;
-    logo: string | null;
-}
-interface CreateUSBankAccount_createUSBankAccount {
-    __typename: 'BankAccount';
-    id: string;
-    name: string | null;
-    userId: string;
-    country: string;
-    currency: string;
-    payable: boolean;
-    originator: PayableAccountOriginator;
-    type: PayableAccountType;
-    createdAt: any;
-    accountNumber: string;
-    bankAccountType: BankAccountType;
-    bankAccountSubType: BankAccountSubType;
-    holder: string;
-    email: string;
-    ownedByUser: boolean;
-    bankAccountDetails: CreateUSBankAccount_createUSBankAccount_bankAccountDetails;
-    dataSync: CreateUSBankAccount_createUSBankAccount_dataSync | null;
-    institution: CreateUSBankAccount_createUSBankAccount_institution | null;
-}
-interface CreateUSBankAccount {
-    createUSBankAccount: CreateUSBankAccount_createUSBankAccount;
-}
-interface CreateUSBankAccountVariables {
-    createUSAccountInput: USBankAccountInput;
-}
-
 interface DeletePayableAccount_deletePayableAccount_BankAccount_dataSync {
     __typename: 'AccountDataSync';
     lastSync: any | null;
@@ -894,7 +898,7 @@ interface DeletePayableAccount_deletePayableAccount_BankAccount {
     bankAccountType: BankAccountType;
     bankAccountSubType: BankAccountSubType;
     holder: string;
-    email: string;
+    email: string | null;
     ownedByUser: boolean;
     bankAccountDetails: DeletePayableAccount_deletePayableAccount_BankAccount_bankAccountDetails;
 }
@@ -971,9 +975,10 @@ interface RenameBankAccount_renamePayableAccount_BankAccount {
     bankAccountType: BankAccountType;
     bankAccountSubType: BankAccountSubType;
     holder: string;
-    email: string;
+    email: string | null;
     ownedByUser: boolean;
     bankAccountDetails: RenameBankAccount_renamePayableAccount_BankAccount_bankAccountDetails;
+    deliveryMethods: PaymentDeliveryMethod[];
     institution: RenameBankAccount_renamePayableAccount_BankAccount_institution | null;
 }
 
@@ -1034,15 +1039,17 @@ declare class SpritzClient {
     private makeStatusError;
 }
 
-type CreateInputMapping$1 = {
-    [BankAccountType.USBankAccount]: USBankAccountInput;
+type BaseBankAccountInput = Omit<BankAccountInput, 'details' | 'type'>;
+type UsBankAccountInput = BaseBankAccountInput & {
+    routingNumber: string;
 };
-type CreateMutationMapping$1 = {
-    [BankAccountType.USBankAccount]: {
-        query: CreateUSBankAccount;
-        variables: CreateUSBankAccountVariables;
-        response: keyof CreateUSBankAccount;
-    };
+type CaBankAccountInput = BaseBankAccountInput & {
+    transitNumber: string;
+    institutionNumber: string;
+};
+type CreateInputMapping$1 = {
+    [BankAccountType.USBankAccount]: UsBankAccountInput;
+    [BankAccountType.CABankAccount]: CaBankAccountInput;
 };
 declare class BankAccountService {
     private client;
@@ -1050,7 +1057,7 @@ declare class BankAccountService {
     list(): Promise<UserBankAccounts_bankAccounts[]>;
     rename(accountId: string, name: string): Promise<RenameBankAccount_renamePayableAccount_BankAccount>;
     delete(accountId: string): Promise<DeletePayableAccount_deletePayableAccount_BankAccount>;
-    create<T extends BankAccountType>(type: T, input: CreateInputMapping$1[T]): Promise<NonNullable<CreateMutationMapping$1[T]["query"][keyof CreateMutationMapping$1[T]["query"]]> | null>;
+    create<T extends BankAccountType>(type: T, input: CreateInputMapping$1[T]): Promise<CreateBankAccount_createBankAccount>;
 }
 
 interface CreateUSBill_addUSBill_billAccountDetails {
@@ -1127,6 +1134,7 @@ interface CreatePaymentRequest_createDirectPayment {
     amountDue: number;
     network: string;
     createdAt: any;
+    deliveryMethod: string | null;
 }
 
 declare enum PaymentNetwork {
@@ -1291,4 +1299,4 @@ declare class SpritzApiClient {
     setApiKey(_apiKey: string): this;
 }
 
-export { AccountPayments, AccountPaymentsVariables, AccountPayments_paymentsForAccount, BankAccountFragment, BankAccountFragment_bankAccountDetails, BankAccountFragment_bankAccountDetails_CanadianBankAccountDetails, BankAccountFragment_bankAccountDetails_USBankAccountDetails, BankAccountFragment_institution, BankAccountSubType, BankAccountType, BillFragment, BillFragment_billAccountDetails, BillFragment_dataSync, BillFragment_institution, BillType, CreateDirectPaymentInput, CreatePaymentRequestInput, CurrentUser, CurrentUser_me, Environment, GetSpritzPayParams, GetSpritzPayParamsVariables, GetSpritzPayParams_spritzPayParams, 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_VirtualCard, PayableAccountFragment_VirtualCard_billingInfo, PayableAccountFragment_VirtualCard_billingInfo_address, PayableAccountFragment_VirtualCard_dataSync, PayableAccountFragment_VirtualCard_institution, PayableAccountInstitutionFragment, PayableAccountType, PaymentFragment, PaymentNetwork, PaymentRequestFragment, PaymentRequestPayment, PaymentRequestPaymentVariables, PaymentRequestPayment_paymentForPaymentRequest, DirectPaymentStatus as PaymentRequestStatus, PaymentStatus, PopularBillInstitutions, PopularBillInstitutionsVariables, PopularBillInstitutions_popularUSBillInstitutions, SearchUSBillInstitutions, SearchUSBillInstitutionsVariables, SearchUSBillInstitutions_searchUSBillInstitutions, SpritzApiClient, TokenBalanceFragment, TransactionPrice, TransactionPriceVariables, USBankAccountInput, UserBankAccounts, UserBankAccounts_bankAccounts, UserBankAccounts_bankAccounts_bankAccountDetails, UserBankAccounts_bankAccounts_bankAccountDetails_CanadianBankAccountDetails, UserBankAccounts_bankAccounts_bankAccountDetails_USBankAccountDetails, UserBankAccounts_bankAccounts_institution, UserBills, UserBills_bills, UserBills_bills_billAccountDetails, UserBills_bills_dataSync, UserBills_bills_institution, 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_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, VirtualCardType, VirtualDebitCardFragment, VirtualDebitCardFragment_billingInfo, VirtualDebitCardFragment_billingInfo_address, WalletTokenBalances, WalletTokenBalancesVariables, WalletTokenBalances_tokenBalances };
+export { AccountPayments, AccountPaymentsVariables, AccountPayments_paymentsForAccount, BankAccountFragment, BankAccountFragment_bankAccountDetails, BankAccountFragment_bankAccountDetails_CanadianBankAccountDetails, BankAccountFragment_bankAccountDetails_USBankAccountDetails, BankAccountFragment_institution, BankAccountInput, BankAccountSubType, BankAccountType, BillFragment, BillFragment_billAccountDetails, BillFragment_dataSync, BillFragment_institution, BillType, CreateDirectPaymentInput, CreatePaymentRequestInput, CurrentUser, CurrentUser_me, Environment, GetSpritzPayParams, GetSpritzPayParamsVariables, GetSpritzPayParams_spritzPayParams, 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_VirtualCard, PayableAccountFragment_VirtualCard_billingInfo, PayableAccountFragment_VirtualCard_billingInfo_address, PayableAccountFragment_VirtualCard_dataSync, PayableAccountFragment_VirtualCard_institution, PayableAccountInstitutionFragment, PayableAccountType, PaymentFragment, PaymentNetwork, PaymentRequestFragment, PaymentRequestPayment, PaymentRequestPaymentVariables, PaymentRequestPayment_paymentForPaymentRequest, DirectPaymentStatus as PaymentRequestStatus, PaymentStatus, PopularBillInstitutions, PopularBillInstitutionsVariables, PopularBillInstitutions_popularUSBillInstitutions, SearchUSBillInstitutions, SearchUSBillInstitutionsVariables, SearchUSBillInstitutions_searchUSBillInstitutions, SpritzApiClient, TokenBalanceFragment, TransactionPrice, TransactionPriceVariables, UserBankAccounts, UserBankAccounts_bankAccounts, UserBankAccounts_bankAccounts_bankAccountDetails, UserBankAccounts_bankAccounts_bankAccountDetails_CanadianBankAccountDetails, UserBankAccounts_bankAccounts_bankAccountDetails_USBankAccountDetails, UserBankAccounts_bankAccounts_institution, UserBills, UserBills_bills, UserBills_bills_billAccountDetails, UserBills_bills_dataSync, UserBills_bills_institution, 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_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, VirtualCardType, VirtualDebitCardFragment, VirtualDebitCardFragment_billingInfo, VirtualDebitCardFragment_billingInfo_address, WalletTokenBalances, WalletTokenBalancesVariables, WalletTokenBalances_tokenBalances };