@spritz-finance/api-client 0.0.6 → 0.0.8

package/README.md

@@ -20,13 +20,93 @@ A Typescript library for interacting with the Spritz Finance API
 
 ## Usage
 
+Your integration key is provided by Spritz and must always be provided.
+The api key is specific to each user, 
+and is returned once the user is created. Leave the api key blank if you haven't created the user yet. 
+
 ```typescript
 import { SpritzApiClient, Environment } from '@spritz-finance/api-client'
 
 const client = SpritzApiClient.initialize({
-	environment: Environment.Staging, 
-	apiKey: 'YOUR_API_KEY_HERE'
+  environment: Environment.Staging,
+  apiKey: 'YOUR_USER_API_KEY_HERE', 
+  integrationKey: 'YOUR_INTEGRATION_KEY_HERE',
+})
+```
+
+## User Creation
+
+You start the process by transmitting the user's email address.
+
+```typescript
+// Fetch all bank accounts for the user
+const user = await client.user.create({
+  email: "bilbo@shiremail.net"
 })
+
+// user = {
+//  email: "bilbo@shiremail.net"
+//  userId: "62d17d3b377dab6c1342136e",
+//  apiKey: "ak_ZTBGDcjfdTg3NmYtZDJlZC00ZjYyLThlMDMtZmYwNDJiZDRlMWZm"
+// }
+
+
+```
+
+Once the user is created, set the api client to use the user's api key:
+
+```typescript
+client.setApiKey(user.apiKey)
+```
+
+Now you're ready to issue requests on behalf of the user.
+
+## Basic User Data
+
+Use this to fetch the user's basic data
+
+```typescript
+const userData = await client.user.getCurrentUser()
+```
+
+## User Verification
+
+Use this to get a URL for the user to pass verification, and track the user's verification status.
+You will need to direct the user's browser to go to the provided URL.
+
+```typescript
+const verificationData = await client.user.getUserVerification()
+```
+
+## Basic payment flow
+
+```typescript
+// Fetch all bank accounts for the user
+const bankAccounts = await client.bankAccounts.list()
+
+// Choose a bank account to use for the payment request
+const account = bankAccounts[0]
+
+// Create a payment request for the selected bank account
+const paymentRequest = await client.paymentRequest.create({
+  amount: 100,
+  accountId: account.id,
+  network: PaymentNetwork.Ethereum,
+})
+
+// Retrieve the transaction data required to issue a blockchain transaction
+const transactionData = await client.paymentRequest.getWeb3PaymentParams({
+  paymentRequest,
+  paymentTokenAddress: '0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48', // USDC on mainnet
+})
+
+/**
+ * Issue blockchain transaction with the transaction data
+ * and wait for confirmation
+ **/
+
+// Retrieve the payment issued for the payment request to check the payment status and confirmation
+const payment = await client.payment.getForPaymentRequest(paymentRequest.id)
 ```
 
 ## Bank Accounts
@@ -68,7 +148,7 @@ const bankAccounts = [{
   },
   ownedByUser: true,
   createdAt: "2023-05-03T11:25:02.401Z",
-}];
+}]
 ```
 
 ### Add US bank account
@@ -79,13 +159,13 @@ At present, you can only add US bank accounts to a user's account. To add a US b
 // Input arguments for creating a US bank account
 
 export interface USBankAccountInput {
-    accountNumber: string
-    email: string
-    holder: string
-    name: string
-    ownedByUser?: boolean | null
-    routingNumber: string
-    subType: BankAccountSubType
+  accountNumber: string
+  email: string
+  holder: string
+  name: string
+  ownedByUser?: boolean | null
+  routingNumber: string
+  subType: BankAccountSubType
 }
 ```
 
@@ -93,13 +173,13 @@ export interface USBankAccountInput {
 import { BankAccountType, BankAccountSubType } from '@spritz-finance/api-client'
 
 const bankAccounts = await client.bankAccounts.create(BankAccountType.USBankAccount, {
-    accountNumber: '123456789',
-    routingNumber: '987654321',
-    email: 'bilbo@shiremail.net',
-    holder: 'Bilbo Baggins',
-    name: 'Precious Savings',
-    ownedByUser: true,
-    subType: BankAccountSubType.Savings,
+  accountNumber: '123456789',
+  routingNumber: '987654321',
+  email: 'bilbo@shiremail.net',
+  holder: 'Bilbo Baggins',
+  name: 'Precious Savings',
+  ownedByUser: true,
+  subType: BankAccountSubType.Savings,
 })
 ```
 
@@ -215,15 +295,15 @@ const payment = await client.payment.getForPaymentRequest(paymentRequest.id);
 
 // Example response
 
- {
-    id: '6368e3a3ec516e9572bbd23b',
-    userId: '63d12d3B577fab6c6382136e',
-    status: 'PENDING',
-    accountId: '6322445f10d3f4d19c4d72fe',
-    amount: 100,
-    feeAmount: null,
-    createdAt: '2022-11-07T10:53:23.998Z'
-  }
+{
+  id: '6368e3a3ec516e9572bbd23b',
+  userId: '63d12d3B577fab6c6382136e',
+  status: 'PENDING',
+  accountId: '6322445f10d3f4d19c4d72fe',
+  amount: 100,
+  feeAmount: null,
+  createdAt: '2022-11-07T10:53:23.998Z'
+}
 
 ```
 

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

@@ -573,6 +573,7 @@ interface QueryParams<V = any> {
 }
 declare class GraphClient {
     client: AxiosInstance;
+    baseClient: AxiosInstance;
     constructor(environment: Environment, apiKey: string, integrationKey?: string);
     query<Q = any, V = any>({ query, variables }: QueryParams<V>): Promise<Q>;
 }
@@ -647,9 +648,15 @@ declare class PaymentRequestService {
     }): Promise<Web3PaymentParams>;
 }
 
+interface CreateUserResponse {
+    userId: string;
+    email: string;
+    apiKey: string;
+}
 declare class UserService {
     private client;
     constructor(client: GraphClient);
+    createUser(email: string): Promise<CreateUserResponse>;
     getCurrentUser(): Promise<CurrentUser_me>;
     getUserVerification(): Promise<UserVerification_verification>;
 }
@@ -660,13 +667,18 @@ type ClientParams = {
     integrationKey?: string;
 };
 declare class SpritzApiClient {
+    private apiKey;
+    private integrationKey;
+    private environment;
     private client;
     user: UserService;
     bankAccount: BankAccountService;
     paymentRequest: PaymentRequestService;
     payment: PaymentService;
+    constructor(apiKey: string, integrationKey: string, environment: Environment);
     static initialize({ environment, apiKey, integrationKey }: ClientParams): SpritzApiClient;
     private init;
+    setApiKey(_apiKey: string): this;
 }
 
 export { AccountPayments, AccountPaymentsVariables, AccountPayments_paymentsForAccount, AccountProvider, BankAccountFragment, BankAccountFragment_bankAccountDetails, BankAccountFragment_bankAccountDetails_CanadianBankAccountDetails, BankAccountFragment_bankAccountDetails_USBankAccountDetails, BankAccountFragment_institution, BankAccountSubType, BankAccountType, CreateDirectPaymentInput, CreatePaymentRequestInput, CurrentUser, CurrentUser_me, DirectPaymentStatus, Environment, GetSpritzPayParams, GetSpritzPayParamsVariables, GetSpritzPayParams_spritzPayParams, ModuleStatus, PayableAccountFragment, PayableAccountFragment_BankAccount, PayableAccountFragment_BankAccount_bankAccountDetails, PayableAccountFragment_BankAccount_bankAccountDetails_CanadianBankAccountDetails, PayableAccountFragment_BankAccount_bankAccountDetails_USBankAccountDetails, PayableAccountFragment_BankAccount_institution, PayableAccountFragment_Bill, PayableAccountFragment_Bill_institution, PayableAccountType, PaymentFragment, PaymentNetwork, PaymentRequestFragment, PaymentRequestPayment, PaymentRequestPaymentVariables, PaymentRequestPayment_paymentForPaymentRequest, PaymentStatus, SpritzApiClient, TokenBalanceFragment, TransactionPrice, TransactionPriceVariables, USBankAccountInput, UserBankAccounts, UserBankAccounts_userBankAccounts, UserBankAccounts_userBankAccounts_bankAccountDetails, UserBankAccounts_userBankAccounts_bankAccountDetails_CanadianBankAccountDetails, UserBankAccounts_userBankAccounts_bankAccountDetails_USBankAccountDetails, UserBankAccounts_userBankAccounts_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_institution, UserPayableAccounts_payableAccounts_Bill, UserPayableAccounts_payableAccounts_Bill_institution, UserVerification, UserVerification_verification, UserVerification_verification_identity, UserVerification_verification_identity_user, WalletTokenBalances, WalletTokenBalancesVariables, WalletTokenBalances_tokenBalances };