@spritz-finance/api-client 0.0.3 → 0.0.4

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

@@ -6,21 +6,10 @@ declare enum Environment {
     Production = "production"
 }
 
-interface QueryParams<V = any> {
-    query: DocumentNode;
-    variables?: V;
+declare enum AccountProvider {
+    CHECKBOOK = "CHECKBOOK",
+    METHOD_FI = "METHOD_FI"
 }
-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",
@@ -29,6 +18,16 @@ declare enum BankAccountSubType {
 declare enum BankAccountType {
     USBankAccount = "USBankAccount"
 }
+declare enum DirectPaymentStatus {
+    COMPLETED = "COMPLETED",
+    CONFIRMED = "CONFIRMED",
+    CREATED = "CREATED",
+    FAILED = "FAILED",
+    PENDING = "PENDING",
+    REFUNDED = "REFUNDED",
+    TRANSACTION_FAILED = "TRANSACTION_FAILED",
+    TRANSACTION_PENDING = "TRANSACTION_PENDING"
+}
 declare enum ModuleStatus {
     ACTIVE = "ACTIVE",
     FAILED = "FAILED",
@@ -42,6 +41,16 @@ declare enum PayableAccountType {
     Bill = "Bill",
     DebitCard = "DebitCard"
 }
+interface CreateDirectPaymentInput {
+    accountId: string;
+    amount: number;
+    network?: string | null;
+    provider?: AccountProvider | null;
+    rewardsAmount?: number | null;
+    subscriptionId?: string | null;
+    testPayment?: boolean | null;
+    tokenAddress?: string | null;
+}
 interface USBankAccountInput {
     accountNumber: string;
     email: string;
@@ -181,6 +190,25 @@ interface CurrentUser {
     me: CurrentUser_me;
 }
 
+interface GetSpritzPayParams_spritzPayParams {
+    __typename: 'PaymentParams';
+    contractAddress: string;
+    method: string;
+    calldata: string;
+    value: string | null;
+    requiredTokenInput: string;
+    suggestedGasLimit: string | null;
+}
+interface GetSpritzPayParams {
+    spritzPayParams: GetSpritzPayParams_spritzPayParams;
+}
+interface GetSpritzPayParamsVariables {
+    tokenAddress: string;
+    amount: number;
+    reference: string;
+    network: string;
+}
+
 interface PayableAccountFragment_Bill_institution {
     __typename: 'BankAccountInstitution' | 'BillInstitution';
     id: string;
@@ -236,6 +264,17 @@ interface PayableAccountFragment_BankAccount {
 }
 type PayableAccountFragment = PayableAccountFragment_Bill | PayableAccountFragment_BankAccount;
 
+interface PaymentRequestFragment {
+    __typename: 'DirectPayment';
+    id: string;
+    userId: any;
+    accountId: any;
+    status: DirectPaymentStatus;
+    amount: number;
+    network: string;
+    createdAt: any;
+}
+
 interface TokenBalanceFragment {
     __typename: 'TokenBalance';
     /**
@@ -462,6 +501,16 @@ interface CreateUSBankAccountVariables {
     createUSAccountInput: USBankAccountInput;
 }
 
+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>;
+}
+
 type CreateInputMapping = {
     [BankAccountType.USBankAccount]: USBankAccountInput;
 };
@@ -472,7 +521,7 @@ type CreateMutationMapping = {
         response: keyof CreateUSBankAccount;
     };
 };
-declare class BankAccountsService {
+declare class BankAccountService {
     private client;
     constructor(client: GraphClient);
     list(): Promise<UserBankAccounts_userBankAccounts[]>;
@@ -481,6 +530,61 @@ declare class BankAccountsService {
     create<T extends BankAccountType>(type: T, input: CreateInputMapping[T]): Promise<NonNullable<CreateMutationMapping[T]["query"][keyof CreateMutationMapping[T]["query"]]> | null>;
 }
 
+interface CreatePaymentRequest_createDirectPayment {
+    __typename: 'DirectPayment';
+    id: string;
+    userId: any;
+    accountId: any;
+    status: DirectPaymentStatus;
+    amount: number;
+    network: string;
+    createdAt: any;
+}
+
+declare enum PaymentNetwork {
+    Ethereum = "ethereum",
+    Polygon = "polygon",
+    Optimism = "optimism",
+    Arbitrum = "arbitrum",
+    Binance = "binance-smart-chain",
+    Avalanche = "avalanche",
+    Bitcoin = "bitcoin",
+    BitcoinTestnet = "bitcoin-testnet",
+    Dash = "dash",
+    DashTestnet = "dash-testnet"
+}
+interface CreatePaymentRequestInput {
+    accountId: string;
+    amount: number;
+    network: PaymentNetwork;
+}
+
+declare class PaymentRequestService {
+    private client;
+    constructor(client: GraphClient);
+    create(input: CreatePaymentRequestInput): Promise<CreatePaymentRequest_createDirectPayment>;
+    /**
+     * Retrieves the Web3 payment parameters for a specified payment request.
+     *
+     * @async
+     * @param {Object} input - The input object containing payment request details.
+     * @param {string} input.paymentRequestId - The unique identifier for the payment request.
+     * @param {number} input.amount - The amount to be paid in the transaction, decimals in USD (eg. 12.45)
+     * @param {PaymentNetwork} input.network - The Ethereum network to be used for the transaction
+     * @param {string} input.paymentTokenAddress - The Ethereum address of the ERC20 token used for payment.
+     * @param {boolean} [validateChecksum=false] - Optional flag to validate the EIP-55 checksum of the paymentTokenAddress.
+     * If set to true, the function will throw an error if the checksum is invalid. Default is false.
+     * @returns {Promise<Object>} A Promise that resolves to an object containing the Web3 payment parameters.
+     * @throws {Error} If the validateChecksum flag is true and the paymentTokenAddress has an invalid EIP-55 checksum.
+     */
+    getWeb3PaymentParams(input: {
+        paymentRequestId: string;
+        amount: number;
+        network: PaymentNetwork;
+        paymentTokenAddress: string;
+    }, validateChecksum?: boolean): Promise<GetSpritzPayParams_spritzPayParams>;
+}
+
 declare class UserService {
     private client;
     constructor(client: GraphClient);
@@ -490,11 +594,11 @@ declare class UserService {
 
 declare class SpritzApiClient {
     private client;
-    accounts: AccountsService;
     user: UserService;
-    bankAccounts: BankAccountsService;
+    bankAccount: BankAccountService;
+    paymentRequest: PaymentRequestService;
     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 };
+export { 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, PaymentNetwork, PaymentRequestFragment, 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 };