@spritz-finance/api-client 0.0.3

package/README.md

@@ -0,0 +1,105 @@
+# @spritz-finance/api-client
+
+A Typescript library for interacting with the Spritz Finance API
+
+[![NPM](https://img.shields.io/npm/v/@spritz-finance/api-client.svg)](https://www.npmjs.com/package/@spritz-finance/api-client)
+
+## Installation
+
+### Using npm
+
+```bash
+ npm install --save @spritz-finance/api-client
+```
+
+### Using yarn
+
+```bash
+ yarn add @spritz-finance/api-client
+```
+
+## Usage
+
+```typescript
+import { SpritzApiClient, Environment } from '@spritz-finance/api-client'
+
+const client = SpritzApiClient.initialize(Environment.Staging, 'YOUR_API_KEY_HERE')
+```
+
+## Bank Accounts
+
+### List user bank accounts
+
+```typescript
+const bankAccounts = await client.bankAccounts.list()
+```
+
+#### Example response
+
+The bank accounts endpoint returns a standard response comprising an array of all the user-added bank accounts that are available for making payments. This array provides all the necessary information to both display the account details in a user interface and process payments to the respective accounts.
+
+```typescript
+const bankAccounts = [{
+	id: "62d17d3b377dab6c1342136e",
+	name: "Precious Savings",
+	type: "BankAccount",
+	bankAccountType: "USBankAccount",
+	bankAccountSubType: "Checking",
+	userId: "62d17d3b377dab6c1342136e",
+	accountNumber: "1234567",
+	bankAccountDetails: {
+		routingNumber: "00000123",
+	}
+	country: "US",
+	currency: "USD",
+	email: "bilbo@shiremail.net",
+	holder: "Bilbo Baggins",
+	institution: {
+		id: "62d27d4b277dab3c1342126e",
+		name: "Shire Bank",
+		logo: "https://tinyurl.com/shire-bank-logo",
+	},
+	ownedByUser: true,
+	createdAt: "2023-05-03T11:25:02.401Z",
+}];
+```
+
+### Add US bank account
+
+```typescript
+export interface USBankAccountInput {
+    accountNumber: string
+    email: string
+    holder: string
+    name: string
+    ownedByUser?: boolean | null
+    routingNumber: string
+    subType: BankAccountSubType
+}
+```
+
+```typescript
+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,
+})
+```
+
+### Rename a bank account
+
+```typescript
+const updateAccount = await client.bankAccounts.rename('62d17d3b377dab6c1342136e', 'My new account')
+```
+
+### Delete a bank account
+
+```typescript
+await client.bankAccounts.delete('62d17d3b377dab6c1342136e')
+```

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

@@ -0,0 +1,500 @@
+import { AxiosInstance } from 'axios';
+import { DocumentNode } from 'graphql';
+
+declare enum Environment {
+    Staging = "staging",
+    Production = "production"
+}
+
+interface QueryParams<V = any> {
+    query: DocumentNode;
+    variables?: V;
+}
+declare class GraphClient {
+    client: AxiosInstance;
+    constructor(environment: Environment, apiKey: string);
+    query<Q = any, V = any>({ query, variables }: QueryParams<V>): Promise<Q>;
+}
+
+declare class AccountsService {
+    private client;
+    constructor(client: GraphClient);
+}
+
+declare enum BankAccountSubType {
+    Business = "Business",
+    Checking = "Checking",
+    Savings = "Savings"
+}
+declare enum BankAccountType {
+    USBankAccount = "USBankAccount"
+}
+declare enum ModuleStatus {
+    ACTIVE = "ACTIVE",
+    FAILED = "FAILED",
+    INITIALIZED = "INITIALIZED",
+    LOADING = "LOADING",
+    UNAVAILABLE = "UNAVAILABLE",
+    UNINITIALIZED = "UNINITIALIZED"
+}
+declare enum PayableAccountType {
+    BankAccount = "BankAccount",
+    Bill = "Bill",
+    DebitCard = "DebitCard"
+}
+interface USBankAccountInput {
+    accountNumber: string;
+    email: string;
+    holder: string;
+    name: string;
+    ownedByUser?: boolean | null;
+    routingNumber: string;
+    subType: BankAccountSubType;
+}
+
+interface DeleteBankAccount_deletePayableAccount_Bill {
+    __typename: 'Bill';
+}
+interface DeleteBankAccount_deletePayableAccount_BankAccount_bankAccountDetails_CanadianBankAccountDetails {
+    __typename: 'CanadianBankAccountDetails';
+}
+interface DeleteBankAccount_deletePayableAccount_BankAccount_bankAccountDetails_USBankAccountDetails {
+    __typename: 'USBankAccountDetails';
+    routingNumber: string;
+}
+type DeleteBankAccount_deletePayableAccount_BankAccount_bankAccountDetails = DeleteBankAccount_deletePayableAccount_BankAccount_bankAccountDetails_CanadianBankAccountDetails | DeleteBankAccount_deletePayableAccount_BankAccount_bankAccountDetails_USBankAccountDetails;
+interface DeleteBankAccount_deletePayableAccount_BankAccount_institution {
+    __typename: 'BankAccountInstitution' | 'BillInstitution';
+    id: string;
+    name: string;
+    logo: string;
+    country: string;
+    currency: string;
+}
+interface DeleteBankAccount_deletePayableAccount_BankAccount {
+    __typename: 'BankAccount';
+    id: string;
+    name: string | null;
+    userId: string;
+    country: string;
+    currency: string;
+    createdAt: any;
+    type: PayableAccountType;
+    accountNumber: string;
+    bankAccountType: BankAccountType;
+    bankAccountSubType: BankAccountSubType;
+    holder: string;
+    email: string;
+    ownedByUser: boolean;
+    bankAccountDetails: DeleteBankAccount_deletePayableAccount_BankAccount_bankAccountDetails;
+    institution: DeleteBankAccount_deletePayableAccount_BankAccount_institution | null;
+}
+type DeleteBankAccount_deletePayableAccount = DeleteBankAccount_deletePayableAccount_Bill | DeleteBankAccount_deletePayableAccount_BankAccount;
+
+interface RenameBankAccount_renamePayableAccount_Bill {
+    __typename: 'Bill';
+}
+interface RenameBankAccount_renamePayableAccount_BankAccount_bankAccountDetails_CanadianBankAccountDetails {
+    __typename: 'CanadianBankAccountDetails';
+}
+interface RenameBankAccount_renamePayableAccount_BankAccount_bankAccountDetails_USBankAccountDetails {
+    __typename: 'USBankAccountDetails';
+    routingNumber: string;
+}
+type RenameBankAccount_renamePayableAccount_BankAccount_bankAccountDetails = RenameBankAccount_renamePayableAccount_BankAccount_bankAccountDetails_CanadianBankAccountDetails | RenameBankAccount_renamePayableAccount_BankAccount_bankAccountDetails_USBankAccountDetails;
+interface RenameBankAccount_renamePayableAccount_BankAccount_institution {
+    __typename: 'BankAccountInstitution' | 'BillInstitution';
+    id: string;
+    name: string;
+    logo: string;
+    country: string;
+    currency: string;
+}
+interface RenameBankAccount_renamePayableAccount_BankAccount {
+    __typename: 'BankAccount';
+    id: string;
+    name: string | null;
+    userId: string;
+    country: string;
+    currency: string;
+    createdAt: any;
+    type: PayableAccountType;
+    accountNumber: string;
+    bankAccountType: BankAccountType;
+    bankAccountSubType: BankAccountSubType;
+    holder: string;
+    email: string;
+    ownedByUser: boolean;
+    bankAccountDetails: RenameBankAccount_renamePayableAccount_BankAccount_bankAccountDetails;
+    institution: RenameBankAccount_renamePayableAccount_BankAccount_institution | null;
+}
+type RenameBankAccount_renamePayableAccount = RenameBankAccount_renamePayableAccount_Bill | RenameBankAccount_renamePayableAccount_BankAccount;
+
+interface BankAccountFragment_bankAccountDetails_CanadianBankAccountDetails {
+    __typename: 'CanadianBankAccountDetails';
+}
+interface BankAccountFragment_bankAccountDetails_USBankAccountDetails {
+    __typename: 'USBankAccountDetails';
+    routingNumber: string;
+}
+type BankAccountFragment_bankAccountDetails = BankAccountFragment_bankAccountDetails_CanadianBankAccountDetails | BankAccountFragment_bankAccountDetails_USBankAccountDetails;
+interface BankAccountFragment_institution {
+    __typename: 'BankAccountInstitution' | 'BillInstitution';
+    id: string;
+    name: string;
+    logo: string;
+    country: string;
+    currency: string;
+}
+interface BankAccountFragment {
+    __typename: 'BankAccount';
+    id: string;
+    name: string | null;
+    userId: string;
+    country: string;
+    currency: string;
+    createdAt: any;
+    type: PayableAccountType;
+    accountNumber: string;
+    bankAccountType: BankAccountType;
+    bankAccountSubType: BankAccountSubType;
+    holder: string;
+    email: string;
+    ownedByUser: boolean;
+    bankAccountDetails: BankAccountFragment_bankAccountDetails;
+    institution: BankAccountFragment_institution | null;
+}
+
+interface CurrentUser_me {
+    __typename: 'User';
+    id: string;
+    sub: string;
+    email: string;
+    firstName: string | null;
+    lastName: string | null;
+    picture: string | null;
+    phone: string | null;
+    createdAt: any;
+    timezone: string;
+}
+interface CurrentUser {
+    me: CurrentUser_me;
+}
+
+interface PayableAccountFragment_Bill_institution {
+    __typename: 'BankAccountInstitution' | 'BillInstitution';
+    id: string;
+    name: string;
+    logo: string;
+    country: string;
+    currency: string;
+}
+interface PayableAccountFragment_Bill {
+    __typename: 'Bill';
+    id: string;
+    name: string | null;
+    userId: string;
+    country: string;
+    currency: string;
+    createdAt: any;
+    type: PayableAccountType;
+    institution: PayableAccountFragment_Bill_institution | null;
+}
+interface PayableAccountFragment_BankAccount_bankAccountDetails_CanadianBankAccountDetails {
+    __typename: 'CanadianBankAccountDetails';
+}
+interface PayableAccountFragment_BankAccount_bankAccountDetails_USBankAccountDetails {
+    __typename: 'USBankAccountDetails';
+    routingNumber: string;
+}
+type PayableAccountFragment_BankAccount_bankAccountDetails = PayableAccountFragment_BankAccount_bankAccountDetails_CanadianBankAccountDetails | PayableAccountFragment_BankAccount_bankAccountDetails_USBankAccountDetails;
+interface PayableAccountFragment_BankAccount_institution {
+    __typename: 'BankAccountInstitution' | 'BillInstitution';
+    id: string;
+    name: string;
+    logo: string;
+    country: string;
+    currency: string;
+}
+interface PayableAccountFragment_BankAccount {
+    __typename: 'BankAccount';
+    id: string;
+    name: string | null;
+    userId: string;
+    country: string;
+    currency: string;
+    createdAt: any;
+    type: PayableAccountType;
+    accountNumber: string;
+    bankAccountType: BankAccountType;
+    bankAccountSubType: BankAccountSubType;
+    holder: string;
+    email: string;
+    ownedByUser: boolean;
+    bankAccountDetails: PayableAccountFragment_BankAccount_bankAccountDetails;
+    institution: PayableAccountFragment_BankAccount_institution | null;
+}
+type PayableAccountFragment = PayableAccountFragment_Bill | PayableAccountFragment_BankAccount;
+
+interface TokenBalanceFragment {
+    __typename: 'TokenBalance';
+    /**
+     * Token contract address
+     */
+    address: string;
+    /**
+     * Controlling wallet address
+     */
+    walletAddress: string;
+    symbol: string;
+    network: string;
+    /**
+     * ERC20 decimals
+     */
+    decimals: number;
+    balance: number;
+    balanceRaw: string;
+    balanceUSD: number;
+    price: number;
+    tokenImageUrl: string;
+}
+
+interface UserBankAccounts_userBankAccounts_bankAccountDetails_CanadianBankAccountDetails {
+    __typename: 'CanadianBankAccountDetails';
+}
+interface UserBankAccounts_userBankAccounts_bankAccountDetails_USBankAccountDetails {
+    __typename: 'USBankAccountDetails';
+    routingNumber: string;
+}
+type UserBankAccounts_userBankAccounts_bankAccountDetails = UserBankAccounts_userBankAccounts_bankAccountDetails_CanadianBankAccountDetails | UserBankAccounts_userBankAccounts_bankAccountDetails_USBankAccountDetails;
+interface UserBankAccounts_userBankAccounts_institution {
+    __typename: 'BankAccountInstitution' | 'BillInstitution';
+    id: string;
+    name: string;
+    logo: string;
+    country: string;
+    currency: string;
+}
+interface UserBankAccounts_userBankAccounts {
+    __typename: 'BankAccount';
+    id: string;
+    name: string | null;
+    userId: string;
+    country: string;
+    currency: string;
+    createdAt: any;
+    type: PayableAccountType;
+    accountNumber: string;
+    bankAccountType: BankAccountType;
+    bankAccountSubType: BankAccountSubType;
+    holder: string;
+    email: string;
+    ownedByUser: boolean;
+    bankAccountDetails: UserBankAccounts_userBankAccounts_bankAccountDetails;
+    institution: UserBankAccounts_userBankAccounts_institution | null;
+}
+interface UserBankAccounts {
+    userBankAccounts: UserBankAccounts_userBankAccounts[];
+}
+
+interface UserFragment {
+    __typename: 'User';
+    id: string;
+    sub: string;
+    email: string;
+    firstName: string | null;
+    lastName: string | null;
+    picture: string | null;
+    phone: string | null;
+    createdAt: any;
+    timezone: string;
+}
+
+interface UserPayableAccounts_payableAccounts_Bill_institution {
+    __typename: 'BankAccountInstitution' | 'BillInstitution';
+    id: string;
+    name: string;
+    logo: string;
+    country: string;
+    currency: string;
+}
+interface UserPayableAccounts_payableAccounts_Bill {
+    __typename: 'Bill';
+    id: string;
+    name: string | null;
+    userId: string;
+    country: string;
+    currency: string;
+    createdAt: any;
+    type: PayableAccountType;
+    institution: UserPayableAccounts_payableAccounts_Bill_institution | null;
+}
+interface UserPayableAccounts_payableAccounts_BankAccount_institution {
+    __typename: 'BankAccountInstitution' | 'BillInstitution';
+    id: string;
+    name: string;
+    logo: string;
+    country: string;
+    currency: string;
+}
+interface UserPayableAccounts_payableAccounts_BankAccount_bankAccountDetails_CanadianBankAccountDetails {
+    __typename: 'CanadianBankAccountDetails';
+}
+interface UserPayableAccounts_payableAccounts_BankAccount_bankAccountDetails_USBankAccountDetails {
+    __typename: 'USBankAccountDetails';
+    routingNumber: string;
+}
+type UserPayableAccounts_payableAccounts_BankAccount_bankAccountDetails = UserPayableAccounts_payableAccounts_BankAccount_bankAccountDetails_CanadianBankAccountDetails | UserPayableAccounts_payableAccounts_BankAccount_bankAccountDetails_USBankAccountDetails;
+interface UserPayableAccounts_payableAccounts_BankAccount {
+    __typename: 'BankAccount';
+    id: string;
+    name: string | null;
+    userId: string;
+    country: string;
+    currency: string;
+    createdAt: any;
+    type: PayableAccountType;
+    institution: UserPayableAccounts_payableAccounts_BankAccount_institution | null;
+    accountNumber: string;
+    bankAccountType: BankAccountType;
+    bankAccountSubType: BankAccountSubType;
+    holder: string;
+    email: string;
+    ownedByUser: boolean;
+    bankAccountDetails: UserPayableAccounts_payableAccounts_BankAccount_bankAccountDetails;
+}
+type UserPayableAccounts_payableAccounts = UserPayableAccounts_payableAccounts_Bill | UserPayableAccounts_payableAccounts_BankAccount;
+interface UserPayableAccounts {
+    payableAccounts: UserPayableAccounts_payableAccounts[];
+}
+
+interface UserVerification_verification_identity_user {
+    __typename: 'UserIdentity';
+    firstName: string;
+    lastName: string;
+    email: string;
+    completedAt: string;
+}
+interface UserVerification_verification_identity {
+    __typename: 'IdentityModule';
+    status: ModuleStatus;
+    country: string;
+    verificationUrl: string | null;
+    user: UserVerification_verification_identity_user;
+}
+interface UserVerification_verification {
+    __typename: 'Verification';
+    userId: any;
+    identity: UserVerification_verification_identity;
+}
+interface UserVerification {
+    verification: UserVerification_verification;
+}
+
+interface WalletTokenBalances_tokenBalances {
+    __typename: 'TokenBalance';
+    /**
+     * Token contract address
+     */
+    address: string;
+    /**
+     * Controlling wallet address
+     */
+    walletAddress: string;
+    symbol: string;
+    network: string;
+    /**
+     * ERC20 decimals
+     */
+    decimals: number;
+    balance: number;
+    balanceRaw: string;
+    balanceUSD: number;
+    price: number;
+    tokenImageUrl: string;
+}
+interface WalletTokenBalances {
+    tokenBalances: WalletTokenBalances_tokenBalances[];
+}
+interface WalletTokenBalancesVariables {
+    address: string;
+    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_institution {
+    __typename: 'BankAccountInstitution' | 'BillInstitution';
+    id: string;
+    name: string;
+    logo: string;
+    country: string;
+    currency: string;
+}
+interface CreateUSBankAccount_createUSBankAccount {
+    __typename: 'BankAccount';
+    id: string;
+    name: string | null;
+    userId: string;
+    country: string;
+    currency: string;
+    createdAt: any;
+    type: PayableAccountType;
+    accountNumber: string;
+    bankAccountType: BankAccountType;
+    bankAccountSubType: BankAccountSubType;
+    holder: string;
+    email: string;
+    ownedByUser: boolean;
+    bankAccountDetails: CreateUSBankAccount_createUSBankAccount_bankAccountDetails;
+    institution: CreateUSBankAccount_createUSBankAccount_institution | null;
+}
+interface CreateUSBankAccount {
+    createUSBankAccount: CreateUSBankAccount_createUSBankAccount;
+}
+interface CreateUSBankAccountVariables {
+    createUSAccountInput: USBankAccountInput;
+}
+
+type CreateInputMapping = {
+    [BankAccountType.USBankAccount]: USBankAccountInput;
+};
+type CreateMutationMapping = {
+    [BankAccountType.USBankAccount]: {
+        query: CreateUSBankAccount;
+        variables: CreateUSBankAccountVariables;
+        response: keyof CreateUSBankAccount;
+    };
+};
+declare class BankAccountsService {
+    private client;
+    constructor(client: GraphClient);
+    list(): Promise<UserBankAccounts_userBankAccounts[]>;
+    rename(accountId: string, name: string): Promise<RenameBankAccount_renamePayableAccount>;
+    delete(accountId: string): Promise<DeleteBankAccount_deletePayableAccount>;
+    create<T extends BankAccountType>(type: T, input: CreateInputMapping[T]): Promise<NonNullable<CreateMutationMapping[T]["query"][keyof CreateMutationMapping[T]["query"]]> | null>;
+}
+
+declare class UserService {
+    private client;
+    constructor(client: GraphClient);
+    getCurrentUser(): Promise<CurrentUser_me>;
+    getUserVerification(): Promise<UserVerification_verification>;
+}
+
+declare class SpritzApiClient {
+    private client;
+    accounts: AccountsService;
+    user: UserService;
+    bankAccounts: BankAccountsService;
+    static initialize(environment: Environment, apiKey: string): SpritzApiClient;
+    private init;
+}
+
+export { BankAccountFragment, BankAccountFragment_bankAccountDetails, BankAccountFragment_bankAccountDetails_CanadianBankAccountDetails, BankAccountFragment_bankAccountDetails_USBankAccountDetails, BankAccountFragment_institution, BankAccountSubType, BankAccountType, CurrentUser, CurrentUser_me, Environment, ModuleStatus, PayableAccountFragment, PayableAccountFragment_BankAccount, PayableAccountFragment_BankAccount_bankAccountDetails, PayableAccountFragment_BankAccount_bankAccountDetails_CanadianBankAccountDetails, PayableAccountFragment_BankAccount_bankAccountDetails_USBankAccountDetails, PayableAccountFragment_BankAccount_institution, PayableAccountFragment_Bill, PayableAccountFragment_Bill_institution, PayableAccountType, SpritzApiClient, TokenBalanceFragment, 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 };