@oumla/sdk 0.0.3 → 0.0.4

package/README.md

@@ -7,9 +7,9 @@ an example on how to create a wallet
 ```ts
 import { Oumla } from '@oumla/sdk';
 
-const wallet = client.generateWallet({
+const wallet = client.wallets.generate({
     reference: '0d2fcf49-36ce-4160-bbea-ead3887e1b26',
-    network: 'BTC',
+    network: 'ETH',
 });
 ```
 

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 import { z } from 'zod';
 
-declare const NetworkSchema: z.ZodEnum<["BTC", "ETH"]>;
+declare const NetworkSchema: z.ZodEnum<["BTC", "ETH", "tBTC", "tETH"]>;
 declare const ProfileTypeSchema: z.ZodEnum<["User", "Department", "Merchant"]>;
 declare const GetWalletsSchema: z.ZodObject<{
     reference: z.ZodString;
@@ -17,14 +17,14 @@ declare const GetProfileWalletsSchema: z.ZodObject<{
     reference: string;
 }>;
 declare const GenerateWalletSchema: z.ZodObject<{
-    network: z.ZodEnum<["BTC", "ETH"]>;
+    network: z.ZodEnum<["BTC", "ETH", "tBTC", "tETH"]>;
     reference: z.ZodString;
 }, "strip", z.ZodTypeAny, {
     reference: string;
-    network: "BTC" | "ETH";
+    network: "BTC" | "ETH" | "tBTC" | "tETH";
 }, {
     reference: string;
-    network: "BTC" | "ETH";
+    network: "BTC" | "ETH" | "tBTC" | "tETH";
 }>;
 declare const GetTransactionsByAddressSchema: z.ZodObject<{
     baseUrl: z.ZodString;
@@ -79,14 +79,17 @@ declare const GetTransactionsSchema: z.ZodObject<{
     reference?: string | undefined;
 }>;
 declare const GenerateAddressSchema: z.ZodObject<{
-    network: z.ZodEnum<["BTC", "ETH"]>;
+    network: z.ZodEnum<["BTC", "ETH", "tBTC", "tETH"]>;
     reference: z.ZodString;
+    clientShare: z.ZodString;
 }, "strip", z.ZodTypeAny, {
     reference: string;
-    network: "BTC" | "ETH";
+    network: "BTC" | "ETH" | "tBTC" | "tETH";
+    clientShare: string;
 }, {
     reference: string;
-    network: "BTC" | "ETH";
+    network: "BTC" | "ETH" | "tBTC" | "tETH";
+    clientShare: string;
 }>;
 declare const GetAddressesSchema: z.ZodObject<{
     baseUrl: z.ZodString;
@@ -156,14 +159,17 @@ declare const CreateTransactionSchema: z.ZodObject<{
     to: z.ZodString;
     amount: z.ZodNumber;
     from: z.ZodArray<z.ZodString, "many">;
-    network: z.ZodEnum<["BTC", "ETH"]>;
+    network: z.ZodEnum<["BTC", "ETH", "tBTC", "tETH"]>;
+    clientShare: z.ZodString;
 }, "strip", z.ZodTypeAny, {
-    network: "BTC" | "ETH";
+    network: "BTC" | "ETH" | "tBTC" | "tETH";
+    clientShare: string;
     to: string;
     amount: number;
     from: string[];
 }, {
-    network: "BTC" | "ETH";
+    network: "BTC" | "ETH" | "tBTC" | "tETH";
+    clientShare: string;
     to: string;
     amount: number;
     from: string[];
@@ -200,6 +206,7 @@ type THttpRequestArgs = {
     body?: Record<string, unknown>;
     schema?: z.Schema<unknown>;
     pagination?: TPagination;
+    headers?: Record<string, string>;
 };
 type TPagination = {
     totalElements?: number;
@@ -289,34 +296,16 @@ type VolumeByDay = {
     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;
+    createdAt: Date;
+    updated_at: Date;
+    isActive: boolean;
+    isVerified: boolean;
+    reference: string;
+    currentIndex: number;
+    type: ProfileType;
+    label: string | null;
+    miniWallets: MiniWallet[];
+}[];
 type Wallet = {
     id: string;
     date: Date;
@@ -333,53 +322,50 @@ type TGetProfileWalletsResponse = {
     reference: string;
 };
 type TGenerateAddressResponse = {
-    address?: string;
+    data: string;
     message: string;
+    success: boolean;
+    status: number;
 };
 type TGetAddressesResponse = {
-    addresses: {
-        id: string;
-        date: Date;
-        address: string;
-        label: string | null;
-        network: z.infer<typeof NetworkSchema>;
-        balance: number;
-    }[];
-} & TPagination;
+    address: string;
+    date: Date;
+    label: string | null;
+    sub: string;
+    network: Network;
+    balance: number;
+    reference: string;
+}[];
 type TGetOrganizationResponse = {
     id: string;
     name: string;
     email: string;
 };
+type TGetOumlaResponse<T> = {
+    data: T;
+    success: boolean;
+    status: number;
+    pagination: TPagination;
+};
 type TCreateProfileResponse = {
     message: string;
-    profile: {
+    data: {
         reference: string;
         type: string;
     };
+    success: boolean;
+    status: number;
 };
 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;
+    createdAt: Date;
+    updated_at: Date;
+    organizationId: string;
+    type: ProfileType;
+    label: string | null;
+    reference: string;
+    miniWallets: MiniWallet[];
+    addressesCount: number;
+}[];
 type TGetVolumeResponse = {
     createdAt: Date;
     updatedAt: Date;
@@ -405,22 +391,16 @@ type TGetTransactionsResponse = {
     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;
+    network: Network;
+    type: ProfileType;
+    date: Date;
 };
 type TGenerateWalletArgs = z.infer<typeof GenerateWalletSchema>;
 type TGetProfileWalletsArgs = z.infer<typeof GetProfileWalletsSchema>;
@@ -447,244 +427,45 @@ declare abstract class Base {
     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 getCustomHeaders(): Record<string, string>;
     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',
- * })
- * ```
- */
+type OumlaOptions = {
+    apiKey: string;
+    baseUrl?: string;
+    env?: 'testnet' | 'mainnet';
+};
 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>;
+    private static readonly CURRENT_VERSION;
+    private lastUpdateCheck;
+    private readonly UPDATE_CHECK_INTERVAL;
+    constructor(opts: OumlaOptions);
+    private initialize;
+    protected getCustomHeaders(): Record<string, string>;
+    private checkForUpdates;
+    wallets: {
+        generate: (args: TGenerateWalletArgs) => Promise<TGetOumlaResponse<TGenerateWalletResponse>>;
+        get: (args?: TGetWallets, pagination?: TPagination) => Promise<TGetOumlaResponse<TGetWalletsResponse>>;
+    };
+    addresses: {
+        generate: (args: TGenerateAddressArgs) => Promise<TGenerateAddressResponse>;
+        get: (args?: TGetAddresses, pagination?: TPagination) => Promise<TGetOumlaResponse<TGetAddressesResponse>>;
+    };
+    profiles: {
+        create: (args: TCreateProfileArgs) => Promise<TCreateProfileResponse>;
+        get: (pagination?: TPagination) => Promise<TGetOumlaResponse<TGetProfilesResponse>>;
+    };
+    organization: {
+        get: () => Promise<TGetOumlaResponse<TGetOrganizationResponse>>;
+        volume: () => Promise<TGetOumlaResponse<TGetVolumeResponse>>;
+        insights: () => Promise<TGetOumlaResponse<TGetInsightsResponse>>;
+    };
+    transactions: {
+        create: (args: TCreateTransactionArgs) => Promise<TTransferResponse>;
+        get: (args?: TGetTransactionsArgs, pagination?: TPagination) => Promise<TGetOumlaResponse<TGetTransactionsResponse>>;
+    };
 }
 
-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 };
+export { Address, AssetType, EnvType, Insights, MiniWallet, Network, Organization, Oumla, OumlaOptions, PaymentStatus, PaymentType, Profile, ProfileType, TBaseConfigs, TCreateProfileArgs, TCreateProfileResponse, TCreateTransactionArgs, TGenerateAddressArgs, TGenerateAddressResponse, TGenerateWalletArgs, TGenerateWalletResponse, TGetAddresses, TGetAddressesArgs, TGetAddressesResponse, TGetInsightsArgs, TGetInsightsResponse, TGetOrganizationArgs, TGetOrganizationDashboardArgs, TGetOrganizationResponse, TGetOumlaResponse, TGetProfileAddressesArgs, TGetProfileWalletsArgs, TGetProfileWalletsResponse, TGetProfilesArgs, TGetProfilesResponse, TGetTransactionsArgs, TGetTransactionsByAddressArgs, TGetTransactionsByReferenceArgs, TGetTransactionsByWalletArgs, TGetTransactionsResponse, TGetVolumeArgs, TGetVolumeResponse, TGetWallets, TGetWalletsResponse, THttpError, THttpRequestArgs, TPagination, TTransferResponse, Tags, Transaction, TransactionStatus, TransactionType, VolumeByDay, Wallet };