@oumla/sdk 0.0.1

package/dist/index.d.ts

@@ -0,0 +1,690 @@
+import { z } from 'zod';
+
+declare const NetworkSchema: z.ZodEnum<["BTC", "ETH"]>;
+declare const ProfileTypeSchema: z.ZodEnum<["User", "Department", "Merchant"]>;
+declare const GetWalletsSchema: z.ZodObject<{
+    reference: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    reference: string;
+}, {
+    reference: string;
+}>;
+declare const GetProfileWalletsSchema: z.ZodObject<{
+    reference: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    reference: string;
+}, {
+    reference: string;
+}>;
+declare const GenerateWalletSchema: z.ZodObject<{
+    network: z.ZodEnum<["BTC", "ETH"]>;
+    reference: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    reference: string;
+    network: "BTC" | "ETH";
+}, {
+    reference: string;
+    network: "BTC" | "ETH";
+}>;
+declare const GetTransactionsByAddressSchema: z.ZodObject<{
+    baseUrl: z.ZodString;
+    address: z.ZodString;
+    apiKey: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    baseUrl: string;
+    address: string;
+    apiKey: string;
+}, {
+    baseUrl: string;
+    address: string;
+    apiKey: string;
+}>;
+declare const GetTransactionsByWalletSchema: z.ZodObject<{
+    baseUrl: z.ZodString;
+    wallet: z.ZodString;
+    apiKey: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    baseUrl: string;
+    apiKey: string;
+    wallet: string;
+}, {
+    baseUrl: string;
+    apiKey: string;
+    wallet: string;
+}>;
+declare const GetTransactionsByReferenceSchema: z.ZodObject<{
+    baseUrl: z.ZodString;
+    reference: z.ZodString;
+    apiKey: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    reference: string;
+    baseUrl: string;
+    apiKey: string;
+}, {
+    reference: string;
+    baseUrl: string;
+    apiKey: string;
+}>;
+declare const GetTransactionsSchema: z.ZodObject<{
+    address: z.ZodOptional<z.ZodString>;
+    wallet: z.ZodOptional<z.ZodString>;
+    reference: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    address?: string | undefined;
+    wallet?: string | undefined;
+    reference?: string | undefined;
+}, {
+    address?: string | undefined;
+    wallet?: string | undefined;
+    reference?: string | undefined;
+}>;
+declare const GenerateAddressSchema: z.ZodObject<{
+    network: z.ZodEnum<["BTC", "ETH"]>;
+    reference: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    reference: string;
+    network: "BTC" | "ETH";
+}, {
+    reference: string;
+    network: "BTC" | "ETH";
+}>;
+declare const GetAddressesSchema: z.ZodObject<{
+    baseUrl: z.ZodString;
+    apiKey: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    baseUrl: string;
+    apiKey: string;
+}, {
+    baseUrl: string;
+    apiKey: string;
+}>;
+declare const GetProfileAddressesSchema: z.ZodObject<{
+    reference: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    reference: string;
+}, {
+    reference: string;
+}>;
+declare const GetAddressSchema: z.ZodObject<{
+    reference: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    reference: string;
+}, {
+    reference: string;
+}>;
+declare const CreateProfileSchema: z.ZodObject<{
+    reference: z.ZodString;
+    type: z.ZodEnum<["User", "Department", "Merchant"]>;
+}, "strip", z.ZodTypeAny, {
+    reference: string;
+    type: "User" | "Department" | "Merchant";
+}, {
+    reference: string;
+    type: "User" | "Department" | "Merchant";
+}>;
+declare const GetProfilesSchema: z.ZodObject<{
+    baseUrl: z.ZodString;
+    apiKey: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    baseUrl: string;
+    apiKey: string;
+}, {
+    baseUrl: string;
+    apiKey: string;
+}>;
+declare const GetVolumeSchema: z.ZodObject<{
+    baseUrl: z.ZodString;
+    apiKey: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    baseUrl: string;
+    apiKey: string;
+}, {
+    baseUrl: string;
+    apiKey: string;
+}>;
+declare const GetInsightsSchema: z.ZodObject<{
+    baseUrl: z.ZodString;
+    apiKey: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    baseUrl: string;
+    apiKey: string;
+}, {
+    baseUrl: string;
+    apiKey: string;
+}>;
+declare const CreateTransactionSchema: z.ZodObject<{
+    to: z.ZodString;
+    amount: z.ZodNumber;
+    from: z.ZodArray<z.ZodString, "many">;
+    network: z.ZodEnum<["BTC", "ETH"]>;
+}, "strip", z.ZodTypeAny, {
+    network: "BTC" | "ETH";
+    to: string;
+    amount: number;
+    from: string[];
+}, {
+    network: "BTC" | "ETH";
+    to: string;
+    amount: number;
+    from: string[];
+}>;
+declare const GetOrganizationSchema: z.ZodObject<{
+    baseUrl: z.ZodString;
+    apiKey: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    baseUrl: string;
+    apiKey: string;
+}, {
+    baseUrl: string;
+    apiKey: string;
+}>;
+declare const GetOrganizationDashboardSchema: z.ZodObject<{
+    baseUrl: z.ZodString;
+    apiKey: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    baseUrl: string;
+    apiKey: string;
+}, {
+    baseUrl: string;
+    apiKey: string;
+}>;
+
+type TBaseConfigs = {
+    apiKey: string;
+    baseUrl?: string;
+    env?: EnvType;
+};
+type THttpRequestArgs = {
+    path: string;
+    method?: 'GET' | 'POST' | 'PUT' | 'DELETE';
+    body?: Record<string, unknown>;
+    schema?: z.Schema<unknown>;
+    pagination?: TPagination;
+};
+type TPagination = {
+    totalElements?: number;
+    totalPages?: number;
+    skip?: number;
+    take?: number;
+};
+type THttpError = {
+    status?: number;
+    message: string;
+    success?: boolean;
+    path: string;
+};
+declare enum ProfileType {
+    User = "User",
+    Department = "Department",
+    Merchant = "Merchant"
+}
+declare enum Network {
+    BTC = "BTC",
+    ETH = "ETH"
+}
+type PaymentType = 'Withdraw' | 'Deposit';
+type PaymentStatus = 'Pending' | 'Confirmed';
+type AssetType = 'Token' | 'NFT';
+type TransactionType = 'withdraw' | 'deposit';
+type TransactionStatus = 'pending' | 'confirmed';
+type Tags = {
+    name: string;
+    address: Address[];
+};
+type Organization = {
+    name: string;
+    email: string;
+};
+type Profile = {
+    reference: string;
+    userIndex: number;
+    currentIndex: number;
+    organizationId: string;
+    type: ProfileType;
+    label?: string;
+};
+type MiniWallet = {
+    date: Date;
+    organizationId: string;
+    reference: string;
+    index: number;
+    currentDeepIndex: number;
+    address: Address[];
+    transaction: Transaction[];
+    type: ProfileType;
+    WalletCoinType: Network;
+};
+type Address = {
+    address: string;
+    date: Date;
+    index: number;
+    label?: string;
+    Transaction: Transaction[];
+    Tags: Tags[];
+    network: Network;
+    balance: number;
+    reference: string;
+};
+type Transaction = {
+    date: Date;
+    amount: number;
+    txid: string;
+    addressTo?: string;
+    addressFrom?: string;
+    type: PaymentType;
+    isSpent: boolean;
+    isMempool: boolean;
+    status: PaymentStatus;
+    organizationId?: string;
+    addressId: string;
+};
+type Insights = {
+    totalVolume: number;
+    organizationId: string;
+    volumeByDay: VolumeByDay[];
+};
+type VolumeByDay = {
+    totalVolume: number;
+    organizationId: string;
+    insightsId?: string;
+};
+type TGetWalletsResponse = {
+    wallets: {
+        type: z.infer<typeof ProfileTypeSchema>;
+        date: Date;
+        reference: string;
+        organizationId: string;
+        WalletCoinType: z.infer<typeof NetworkSchema>;
+        currentDeepIndex: number;
+        index: number;
+        label: string | null;
+        profile: {
+            createdAt: Date;
+            updated_at: Date;
+            isActive: boolean;
+            reference: string;
+            userIndex: number;
+            currentIndex: number;
+            organizationId: string;
+            bitcoin_balance: {
+                id: string;
+                balance: number;
+                organizationId: string;
+                reference: string;
+                createdAt: Date;
+                updatedAt: Date;
+            };
+        };
+    }[];
+} & TPagination;
+type Wallet = {
+    id: string;
+    date: Date;
+    organizationId: string;
+    reference: string;
+    index: number;
+    currentDeepIndex: number;
+    type: z.infer<typeof ProfileTypeSchema>;
+    WalletCoinType: z.infer<typeof NetworkSchema>;
+    createdAt: Date;
+    updatedAt: Date;
+};
+type TGetProfileWalletsResponse = {
+    reference: string;
+};
+type TGenerateAddressResponse = {
+    address?: string;
+    message: string;
+};
+type TGetAddressesResponse = {
+    addresses: {
+        id: string;
+        date: Date;
+        address: string;
+        label: string | null;
+        network: z.infer<typeof NetworkSchema>;
+        balance: number;
+    }[];
+} & TPagination;
+type TGetOrganizationResponse = {
+    id: string;
+    name: string;
+    email: string;
+};
+type TCreateProfileResponse = {
+    message: string;
+    profile: {
+        reference: string;
+        type: string;
+    };
+};
+type TGetProfilesResponse = {
+    profiles: {
+        organizationId: string;
+        reference: string;
+        type: z.infer<typeof ProfileTypeSchema>;
+        createdAt: Date;
+        updated_at: Date;
+        label: string | null;
+        bitcoin_balance: {
+            balance: number;
+        } | null;
+        miniWallets: {
+            date: Date;
+            organizationId: string;
+            reference: string;
+            type: z.infer<typeof ProfileTypeSchema>;
+            WalletCoinType: z.infer<typeof NetworkSchema>;
+            currentDeepIndex: number;
+            index: number;
+        }[];
+    }[];
+} & TPagination;
+type TGetVolumeResponse = {
+    createdAt: Date;
+    updatedAt: Date;
+    totalVolume: number;
+    organizationId: string;
+    insightsId: string | null;
+}[];
+type TGetInsightsResponse = {
+    volumeByDay: {
+        createdAt: Date;
+        totalVolume: number;
+    }[];
+    totalVolume: number;
+} | null;
+type TGetTransactionsResponse = {
+    id: string;
+    date: Date;
+    type: TransactionType;
+    status: TransactionStatus;
+    amount: number;
+    txid: string;
+    addressTo: string | null;
+    addressFrom: string | null;
+    isSpent: boolean;
+    isMempool: boolean;
+}[] & TPagination;
+type TTransferResponse = {
+    id: string;
+    status: string;
+};
+type TGenerateWalletResponse = {
+    id: string;
+    date: Date;
+    organizationId: string;
+    reference: string;
+    index: number;
+    currentDeepIndex: number;
+    type: z.infer<typeof ProfileTypeSchema>;
+    WalletCoinType: z.infer<typeof NetworkSchema>;
+    createdAt: Date;
+    updatedAt: Date;
+};
+type TGenerateWalletArgs = z.infer<typeof GenerateWalletSchema>;
+type TGetProfileWalletsArgs = z.infer<typeof GetProfileWalletsSchema>;
+type TGetTransactionsByAddressArgs = z.infer<typeof GetTransactionsByAddressSchema>;
+type TGetTransactionsByReferenceArgs = z.infer<typeof GetTransactionsByReferenceSchema>;
+type TGetTransactionsByWalletArgs = z.infer<typeof GetTransactionsByWalletSchema>;
+type TGetTransactionsArgs = z.infer<typeof GetTransactionsSchema>;
+type TGenerateAddressArgs = z.infer<typeof GenerateAddressSchema>;
+type TGetAddressesArgs = z.infer<typeof GetAddressesSchema>;
+type TGetProfileAddressesArgs = z.infer<typeof GetProfileAddressesSchema>;
+type TGetAddresses = z.infer<typeof GetAddressSchema>;
+type TCreateProfileArgs = z.infer<typeof CreateProfileSchema>;
+type TGetProfilesArgs = z.infer<typeof GetProfilesSchema>;
+type TGetVolumeArgs = z.infer<typeof GetVolumeSchema>;
+type TGetInsightsArgs = z.infer<typeof GetInsightsSchema>;
+type TCreateTransactionArgs = z.infer<typeof CreateTransactionSchema>;
+type TGetOrganizationArgs = z.infer<typeof GetOrganizationSchema>;
+type TGetOrganizationDashboardArgs = z.infer<typeof GetOrganizationDashboardSchema>;
+type TGetWallets = z.infer<typeof GetWalletsSchema>;
+type EnvType = 'testnet' | 'mainnet';
+
+declare abstract class Base {
+    protected apiKey: string;
+    protected baseUrl: string;
+    protected env: string;
+    constructor(configs: TBaseConfigs);
+    /**
+     *
+     * A generic method to make requests to the Oumla API.
+     * Keep it simple for now, could be enhanced later.
+     *
+     */
+    protected httpRequest<T>(args: THttpRequestArgs): Promise<T>;
+    private parseInput;
+}
+
+/**
+ * Oumla SDK
+ * @param apiKey - Your API key
+ * @param baseUrl - The base URL of the API
+ * @param env - The environment of the API
+ * @example
+ * ```ts
+ *
+ * const client = new Oumla({
+ *  apiKey: 'YOUR_API_KEY',
+ *  baseUrl: 'https://sandbox.oumla.com',
+ *  env: 'testnet',
+ * })
+ * ```
+ */
+declare class Oumla extends Base {
+    constructor(configs: TBaseConfigs);
+    /**
+     *
+     * Generate a wallet for a profile
+     *
+     * @param {string} args.reference - The reference of the profile
+     * @param {string} args.network - The network to generate a wallet for
+     *
+     * @example
+     * ``` ts
+     *
+     * const wallet = await client.generateWallet({
+     * reference: 'PROFILE_REFERENCE',
+     * network: 'BTC',
+     * });
+     *
+     * ```
+     *
+     * @returns {Types.TGenerateWalletResponse} - The generated wallet or an error
+     *
+     */
+    generateWallet(args: TGenerateWalletArgs): Promise<TGenerateWalletResponse>;
+    /**
+     *
+     * Get wallets for an organization
+     *
+     * @param {string} args.reference - The reference of the profile
+     * @param {Types.TPagination} [pagination] - Pagination options
+     *
+     * @example
+     * ``` ts
+     *
+     * const wallets = await client.getWallets({
+     * skip: 0,
+     * take: 3,
+     * });
+     *
+     * ```
+     *
+     * @returns {Types.TGetWalletsResponse} - The wallets for the organization
+     *
+     */
+    getWallets(args?: TGetWallets, pagination?: TPagination): Promise<TGetWalletsResponse>;
+    /**
+     *
+     * Generate an address for a profile
+     *
+     * @param {string} args.reference - The reference of the profile
+     * @param {string} args.network - The network to generate an address for
+     *
+     * @example
+     * ``` ts
+     *
+     * const address = await client.generateAddress({
+     * reference: 'PROFILE_REFERENCE',
+     * network: 'BTC',
+     * });
+     *
+     * ```
+     *
+     * @returns {Types.TGenerateAddressResponse} - The generated address
+     */
+    generateAddress(args: TGenerateAddressArgs): Promise<TGenerateAddressResponse>;
+    /**
+     *
+     * Get addresses
+     *
+     * @param {string} args.reference - The reference of the profile, Optional
+     * @param {Types.TPagination} [pagination] - Pagination options
+     * @example
+     * ``` ts
+     *
+     * const addresses = await client.getAddresses({
+     * reference: 'PROFILE_REFERENCE',
+     * },
+     *  {
+     * skip: 0,
+     * take: 3,
+     * }
+     * );
+     *
+     * ```
+     *
+     * @returns {Types.TGetProfileAddressesResponse} - The addresses for the profile
+     */
+    getAddresses(args?: TGetAddresses, pagination?: TPagination): Promise<TGetAddressesResponse>;
+    /**
+     *
+     * Get the organization's information
+     *
+     * @example
+     * ``` ts
+     *
+     * const organization = await client.getOrganization();
+     *
+     * ```
+     *
+     * @returns {Types.TGetOrganizationResponse} - The organization's information
+     */
+    getOrganization(): Promise<TGetOrganizationResponse>;
+    /**
+     *
+     * Create a profile
+     *
+     * @param {string} args.reference - The reference of the profile
+     * @param {Types.TCreateProfileArgs['type']} args.type - The type of the profile
+     *
+     * @example
+     * ``` ts
+     *
+     * const profile = await client.createProfile({
+     * reference: 'PROFILE_REFERENCE',
+     * type: 'User',
+     * });
+     *
+     * ```
+     *
+     * @returns {Types.TCreateProfileResponse} - The created profile
+     */
+    createProfile(args: TCreateProfileArgs): Promise<TCreateProfileResponse>;
+    /**
+     *
+     *  Get the profiles for an organization
+     *
+     * @param {Types.TPagination} [pagination] - Pagination options
+     *
+     * @example
+     * ``` ts
+     *
+     * const profiles = await client.getProfiles({
+     * skip: 0,
+     * take: 3,
+     * });
+     *
+     * ```
+     *
+     * @returns {Types.TGetProfilesResponse} - The profiles for the organization
+     */
+    getProfiles(pagination?: TPagination): Promise<TGetProfilesResponse>;
+    /**
+     *
+     * Get the volume for an organization
+     *
+     * @example
+     * ``` ts
+     *
+     * const volume = await client.getVolume();
+     *
+     * ```
+     *
+     * @returns {Types.TGetVolumeResponse} - The volume of the organization
+     */
+    getVolume(): Promise<TGetVolumeResponse>;
+    /**
+     *
+     * Get the insights for an organization
+     *
+     * @example
+     * ``` ts
+     *
+     * const insights = await client.getInsights();
+     *
+     * ```
+     *
+     * @returns {Types.TGetInsightsResponse} - The insights of the organization
+     */
+    getInsights(): Promise<TGetInsightsResponse>;
+    /**
+     *
+     * Get the all the transactions or transactions for an address, wallet or reference
+     *
+     * By providing more than one option, only one will be used.
+     *
+     * @param {string} [args.address] - The address to get transactions for
+     * @param {string} [args.wallet] - The wallet to get transactions for
+     * @param {string} [args.reference] - The reference to get transactions for
+     * @param {Types.TPagination} [pagination] - Pagination options
+     *
+     * @example
+     * ``` ts
+     *
+     * const transactionsByAddress = await client.getTransactions({
+     * address: 'ADDRESS',
+     * });
+     *
+     * ```
+     *
+     * @returns {Types.TGetTransactionsResponse} - The transactions
+     *
+     */
+    getTransactions(args?: TGetTransactionsArgs, pagination?: TPagination): Promise<TGetTransactionsResponse>;
+    /**
+     * create transaction
+     *
+     * @param  args.from - the address or addresses to transfer from
+     * @param  args.to - The desired address to transfer to
+     * @param  args.amount - The amount to transfer
+     *
+     * @example
+     *
+     * ``` ts
+     *
+     * const transfer = await client.transfer({
+     * from: '0x...',
+     * to: '0x...',
+     * reference: '0x...',
+     * amount: 100,
+     * });
+     *
+     * ```
+     */
+    createTransaction(args: TCreateTransactionArgs): Promise<TTransferResponse>;
+}
+
+export { Address, AssetType, EnvType, Insights, MiniWallet, Network, Organization, Oumla, PaymentStatus, PaymentType, Profile, ProfileType, TBaseConfigs, TCreateProfileArgs, TCreateProfileResponse, TCreateTransactionArgs, TGenerateAddressArgs, TGenerateAddressResponse, TGenerateWalletArgs, TGenerateWalletResponse, TGetAddresses, TGetAddressesArgs, TGetAddressesResponse, TGetInsightsArgs, TGetInsightsResponse, TGetOrganizationArgs, TGetOrganizationDashboardArgs, TGetOrganizationResponse, TGetProfileAddressesArgs, TGetProfileWalletsArgs, TGetProfileWalletsResponse, TGetProfilesArgs, TGetProfilesResponse, TGetTransactionsArgs, TGetTransactionsByAddressArgs, TGetTransactionsByReferenceArgs, TGetTransactionsByWalletArgs, TGetTransactionsResponse, TGetVolumeArgs, TGetVolumeResponse, TGetWallets, TGetWalletsResponse, THttpError, THttpRequestArgs, TPagination, TTransferResponse, Tags, Transaction, TransactionStatus, TransactionType, VolumeByDay, Wallet };