@spritz-finance/api-client 0.2.2 → 0.2.4

package/README.md

@@ -26,6 +26,7 @@ A Typescript library for interacting with the Spritz Finance API
 - [Usage](#usage)
 - [Creating a user](#creating-a-user-1)
   - [Setting the User API Key](#setting-the-user-api-key)
+- [Reauthorizing a user](#reauthorizing-a-user)
 - [Basic User Data](#basic-user-data)
 - [User Verification](#user-verification)
   - [Overview](#overview)
@@ -40,6 +41,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)
@@ -136,6 +138,19 @@ client.setApiKey(user.apiKey)
 
 Now you're ready to issue requests on behalf of the user.
 
+## Reauthorizing a user
+
+There is a scenrio where you may need to get access to a users API key again. This can happen if you are trying to sign in a user that already has a Spritz account, or if you have lost access to their API key. In this case, you can reauthorize the user by providing their email. The process is that we will send the user an OTP code to their email, and then the user must pass that code on to you to confirm that they are allowing you to interact with their account on their behalf.
+
+```typescript
+const { success } = await client.user.requestApiKey('bilbo@shiremail.net')
+
+const { apiKey, userId, email } = await client.user.authorizeApiKeyWithOTP({
+  email: 'bilbo@shiremail.net',
+  otp: '123456',
+})
+```
+
 ## Basic User Data
 
 Use this to fetch the user's basic data
@@ -286,6 +301,7 @@ const bankAccounts = [{
   },
   ownedByUser: true,
   createdAt: "2023-05-03T11:25:02.401Z",
+  deliveryMethods: ['STANDARD', 'INSTANT']
 }]
 ```
 
@@ -314,7 +330,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 +420,7 @@ const bills = [
       logo: 'https://tinyurl.com/shire-bank-logo',
     },
     createdAt: '2023-05-03T11:25:02.401Z',
+    deliveryMethods: ['STANDARD']
   },
 ]
 ```
@@ -523,6 +573,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

@@ -63,6 +63,10 @@ declare enum PayableAccountType {
     Bill = "Bill",
     VirtualCard = "VirtualCard"
 }
+declare enum PaymentDeliveryMethod {
+    INSTANT = "INSTANT",
+    STANDARD = "STANDARD"
+}
 declare enum PaymentStatus {
     CANCELLED = "CANCELLED",
     COMPLETED = "COMPLETED",
@@ -91,6 +95,7 @@ interface BankAccountInput {
 interface CreateDirectPaymentInput {
     accountId: string;
     amount: number;
+    deliveryMethod?: PaymentDeliveryMethod | null;
     network?: string | null;
     provider?: AccountProvider | null;
     rewardsAmount?: number | null;
@@ -133,7 +138,7 @@ interface CreateBankAccount_createBankAccount {
     bankAccountType: BankAccountType;
     bankAccountSubType: BankAccountSubType;
     holder: string;
-    email: string;
+    email: string | null;
     ownedByUser: boolean;
     bankAccountDetails: CreateBankAccount_createBankAccount_bankAccountDetails;
     dataSync: CreateBankAccount_createBankAccount_dataSync | null;
@@ -149,6 +154,8 @@ interface AccountPayments_paymentsForAccount {
     amount: number | null;
     feeAmount: number | null;
     createdAt: any;
+    deliveryMethod: PaymentDeliveryMethod | null;
+    paymentRequestId: string | null;
 }
 interface AccountPayments {
     paymentsForAccount: AccountPayments_paymentsForAccount[];
@@ -186,9 +193,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;
 }
 
@@ -301,7 +309,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;
@@ -413,6 +421,8 @@ interface PaymentFragment {
     amount: number | null;
     feeAmount: number | null;
     createdAt: any;
+    deliveryMethod: PaymentDeliveryMethod | null;
+    paymentRequestId: string | null;
 }
 
 interface PaymentRequestFragment {
@@ -426,6 +436,7 @@ interface PaymentRequestFragment {
     amountDue: number;
     network: string;
     createdAt: any;
+    deliveryMethod: string | null;
 }
 
 interface PaymentRequestPayment_paymentForPaymentRequest {
@@ -437,6 +448,8 @@ interface PaymentRequestPayment_paymentForPaymentRequest {
     amount: number | null;
     feeAmount: number | null;
     createdAt: any;
+    deliveryMethod: PaymentDeliveryMethod | null;
+    paymentRequestId: string | null;
 }
 interface PaymentRequestPayment {
     paymentForPaymentRequest: PaymentRequestPayment_paymentForPaymentRequest | null;
@@ -535,9 +548,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 {
@@ -636,7 +650,7 @@ interface UserPayableAccounts_payableAccounts_BankAccount {
     bankAccountType: BankAccountType;
     bankAccountSubType: BankAccountSubType;
     holder: string;
-    email: string;
+    email: string | null;
     ownedByUser: boolean;
     bankAccountDetails: UserPayableAccounts_payableAccounts_BankAccount_bankAccountDetails;
 }
@@ -887,7 +901,7 @@ interface DeletePayableAccount_deletePayableAccount_BankAccount {
     bankAccountType: BankAccountType;
     bankAccountSubType: BankAccountSubType;
     holder: string;
-    email: string;
+    email: string | null;
     ownedByUser: boolean;
     bankAccountDetails: DeletePayableAccount_deletePayableAccount_BankAccount_bankAccountDetails;
 }
@@ -964,9 +978,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;
 }
 
@@ -1122,6 +1137,7 @@ interface CreatePaymentRequest_createDirectPayment {
     amountDue: number;
     network: string;
     createdAt: any;
+    deliveryMethod: string | null;
 }
 
 declare enum PaymentNetwork {
@@ -1159,14 +1175,28 @@ interface CreateUserResponse {
     email: string;
     apiKey: string;
 }
+interface RequestApiKeyResponse {
+    success: boolean;
+}
 interface CreateUserParams {
     email: string;
 }
+interface AuthorizeApiKeyResponse {
+    apiKey: string;
+    userId: any;
+    email: string;
+}
+interface AuthorizeApiKeyParams {
+    otp: any;
+    email: string;
+}
 declare class UserService {
     private client;
     constructor(client: SpritzClient);
     createUser(args: CreateUserParams): Promise<CreateUserResponse>;
     create(args: CreateUserParams): Promise<CreateUserResponse>;
+    requestApiKey(email: string): Promise<RequestApiKeyResponse>;
+    authorizeApiKeyWithOTP(args: AuthorizeApiKeyParams): Promise<AuthorizeApiKeyResponse>;
     getCurrentUser(): Promise<CurrentUser_me>;
     getUserVerification(): Promise<UserVerification_verification | null>;
 }