@spritz-finance/api-client - npm Package Compare versions

Comparing version 0.2.2 to 0.2.3

dist/spritz-api-client.d.ts

@@ -66,2 +66,6 @@ import { DocumentNode } from 'graphql';
 }
+declare enum PaymentDeliveryMethod {
+    INSTANT = "INSTANT",
+    STANDARD = "STANDARD"
+}
 declare enum PaymentStatus {
@@ -95,2 +99,3 @@ CANCELLED = "CANCELLED",
     amount: number;
+    deliveryMethod?: PaymentDeliveryMethod | null;
     network?: string | null;
@@ -138,3 +143,3 @@ provider?: AccountProvider | null;
     holder: string;
-    email: string;
+    email: string | null;
     ownedByUser: boolean;
@@ -155,2 +160,3 @@ bankAccountDetails: CreateBankAccount_createBankAccount_bankAccountDetails;
     createdAt: any;
+    deliveryMethod: PaymentDeliveryMethod | null;
 }
@@ -193,5 +199,6 @@ interface AccountPayments {
     holder: string;
-    email: string;
+    email: string | null;
     ownedByUser: boolean;
     bankAccountDetails: BankAccountFragment_bankAccountDetails;
+    deliveryMethods: PaymentDeliveryMethod[];
     institution: BankAccountFragment_institution | null;
@@ -309,3 +316,3 @@ }
     holder: string;
-    email: string;
+    email: string | null;
     ownedByUser: boolean;
@@ -422,2 +429,3 @@ bankAccountDetails: PayableAccountFragment_BankAccount_bankAccountDetails;
     createdAt: any;
+    deliveryMethod: PaymentDeliveryMethod | null;
 }
@@ -436,2 +444,3 @@
     createdAt: any;
+    deliveryMethod: string | null;
 }
@@ -448,2 +457,3 @@
     createdAt: any;
+    deliveryMethod: PaymentDeliveryMethod | null;
 }
@@ -547,5 +557,6 @@ interface PaymentRequestPayment {
     holder: string;
-    email: string;
+    email: string | null;
     ownedByUser: boolean;
     bankAccountDetails: UserBankAccounts_bankAccounts_bankAccountDetails;
+    deliveryMethods: PaymentDeliveryMethod[];
     institution: UserBankAccounts_bankAccounts_institution | null;
@@ -649,3 +660,3 @@ }
     holder: string;
-    email: string;
+    email: string | null;
     ownedByUser: boolean;
@@ -901,3 +912,3 @@ bankAccountDetails: UserPayableAccounts_payableAccounts_BankAccount_bankAccountDetails;
     holder: string;
-    email: string;
+    email: string | null;
     ownedByUser: boolean;
@@ -979,5 +990,6 @@ bankAccountDetails: DeletePayableAccount_deletePayableAccount_BankAccount_bankAccountDetails;
     holder: string;
-    email: string;
+    email: string | null;
     ownedByUser: boolean;
     bankAccountDetails: RenameBankAccount_renamePayableAccount_BankAccount_bankAccountDetails;
+    deliveryMethods: PaymentDeliveryMethod[];
     institution: RenameBankAccount_renamePayableAccount_BankAccount_institution | null;
@@ -1138,2 +1150,3 @@ }
     createdAt: any;
+    deliveryMethod: string | null;
 }
@@ -1140,0 +1153,0 @@

package.json

 {
     "name": "@spritz-finance/api-client",
-    "version": "0.2.2",
+    "version": "0.2.3",
     "description": "Typescript library for interacting with the Spritz Finance API",
@@ -5,0 +5,0 @@ "main": "dist/spritz-api-client.js",

README.md

@@ -43,2 +43,3 @@ # @spritz-finance/api-client
     - [Add US bank account](#add-us-bank-account)
+    - [Add Canadian bank account](#add-canadian-bank-account)
   - [Bills](#bills)
@@ -290,2 +291,3 @@ - [List user bills](#list-user-bills)
   createdAt: "2023-05-03T11:25:02.401Z",
+  deliveryMethods: ['STANDARD', 'INSTANT']
 }]
@@ -319,3 +321,2 @@ ```
   routingNumber: '987654321',
-  email: '[e-mail]',
   holder: 'Bilbo Baggins',
@@ -328,2 +329,36 @@ name: 'Precious 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,
+  subType: BankAccountSubType.Savings,
+})
+```
+
 ### Bills
@@ -378,2 +413,3 @@
     createdAt: '2023-05-03T11:25:02.401Z',
+    deliveryMethods: ['STANDARD']
   },
@@ -531,2 +567,3 @@ ]
 	network: PaymentNetwork.Ethereum,
+  deliveryMethod: 'INSTANT'
 });
@@ -533,0 +570,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

394598

increased by0.58%

Lines of code

3125

increased by0.61%

Number of lines in readme file

722

increased by5.4%

No dependency changes