@bloque/sdk-accounts 0.0.22 → 0.0.24

package/dist/virtual/types.d.ts

@@ -0,0 +1,104 @@
+/**
+ * Parameters for creating a virtual account
+ */
+export interface CreateVirtualAccountParams {
+    /**
+     * URN of the account holder (user or organization)
+     *
+     * @example "did:bloque:user:123e4567"
+     */
+    holderUrn?: string;
+    /**
+     * Account holder's first name
+     *
+     * @example "John"
+     */
+    firstName: string;
+    /**
+     * Account holder's last name
+     *
+     * @example "Doe"
+     */
+    lastName: string;
+    /**
+     * Ledger account ID to associate with the virtual account
+     * If not provided, a new ledger account will be created automatically
+     */
+    ledgerId?: string;
+    /**
+     * Webhook URL to receive account events
+     */
+    webhookUrl?: string;
+    /**
+     * Custom metadata to attach to the virtual account
+     * Must be a Record<string, string> (all values must be strings)
+     */
+    metadata?: Record<string, string>;
+}
+/**
+ * Parameters for updating virtual account metadata
+ */
+export interface UpdateVirtualMetadataParams {
+    /**
+     * URN of the virtual account to update
+     *
+     * @example "did:bloque:mediums:virtual:account:123e4567"
+     */
+    urn: string;
+    /**
+     * Metadata to update
+     * Note: 'source' is a reserved field and cannot be modified
+     */
+    metadata: Record<string, string> & {
+        source?: never;
+    };
+}
+/**
+ * Virtual account response
+ */
+export interface VirtualAccount {
+    /**
+     * Unique resource name for the virtual account
+     */
+    urn: string;
+    /**
+     * Account ID
+     */
+    id: string;
+    /**
+     * Account holder's first name
+     */
+    firstName: string;
+    /**
+     * Account holder's last name
+     */
+    lastName: string;
+    /**
+     * Account status
+     */
+    status: 'creation_in_progress' | 'active' | 'disabled' | 'frozen' | 'deleted' | 'creation_failed';
+    /**
+     * Owner URN
+     */
+    ownerUrn: string;
+    /**
+     * Ledger account ID associated with the virtual account
+     */
+    ledgerId: string;
+    /**
+     * Webhook URL (if configured)
+     */
+    webhookUrl: string | null;
+    /**
+     * Custom metadata
+     */
+    metadata?: Record<string, string>;
+    /**
+     * Creation timestamp
+     */
+    createdAt: string;
+    /**
+     * Last update timestamp
+     */
+    updatedAt: string;
+}

package/dist/virtual/virtual-client.d.ts

@@ -0,0 +1,90 @@
+import { BaseClient } from '@bloque/sdk-core';
+import type { CreateVirtualAccountParams, UpdateVirtualMetadataParams, VirtualAccount } from './types';
+export declare class VirtualClient extends BaseClient {
+    /**
+     * Create a new virtual account
+     *
+     * Virtual accounts are simple testing accounts requiring only basic personal information.
+     * They're useful for development and testing purposes.
+     *
+     * @param params - Virtual account creation parameters
+     * @returns Promise resolving to the created virtual account
+     *
+     * @example
+     * ```typescript
+     * const account = await bloque.accounts.virtual.create({
+     *   firstName: 'John',
+     *   lastName: 'Doe'
+     * });
+     * ```
+     */
+    create(params: CreateVirtualAccountParams): Promise<VirtualAccount>;
+    /**
+     * Update virtual account metadata
+     *
+     * @param params - Metadata update parameters
+     * @returns Promise resolving to the updated virtual account
+     *
+     * @example
+     * ```typescript
+     * const account = await bloque.accounts.virtual.updateMetadata({
+     *   urn: 'did:bloque:mediums:virtual:account:123',
+     *   metadata: {
+     *     updated_by: 'admin',
+     *     update_reason: 'testing_update'
+     *   }
+     * });
+     * ```
+     */
+    updateMetadata(params: UpdateVirtualMetadataParams): Promise<VirtualAccount>;
+    /**
+     * Activate a virtual account
+     *
+     * @param urn - Virtual account URN
+     * @returns Promise resolving to the updated virtual account
+     *
+     * @example
+     * ```typescript
+     * const account = await bloque.accounts.virtual.activate(
+     *   'did:bloque:mediums:virtual:account:123'
+     * );
+     * ```
+     */
+    activate(urn: string): Promise<VirtualAccount>;
+    /**
+     * Freeze a virtual account
+     *
+     * @param urn - Virtual account URN
+     * @returns Promise resolving to the updated virtual account
+     *
+     * @example
+     * ```typescript
+     * const account = await bloque.accounts.virtual.freeze(
+     *   'did:bloque:mediums:virtual:account:123'
+     * );
+     * ```
+     */
+    freeze(urn: string): Promise<VirtualAccount>;
+    /**
+     * Disable a virtual account
+     *
+     * @param urn - Virtual account URN
+     * @returns Promise resolving to the updated virtual account
+     *
+     * @example
+     * ```typescript
+     * const account = await bloque.accounts.virtual.disable(
+     *   'did:bloque:mediums:virtual:account:123'
+     * );
+     * ```
+     */
+    disable(urn: string): Promise<VirtualAccount>;
+    /**
+     * Private method to update virtual account status
+     */
+    private _updateStatus;
+    /**
+     * Private method to map API response to VirtualAccount
+     */
+    private _mapAccountResponse;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bloque/sdk-accounts",
-  "version": "0.0.22",
+  "version": "0.0.24",
   "type": "module",
   "keywords": [
     "bloque",
@@ -36,6 +36,6 @@
     "node": ">=22"
   },
   "dependencies": {
-    "@bloque/sdk-core": "0.0.22"
+    "@bloque/sdk-core": "0.0.24"
   }
 }

package/dist/api-types.d.ts

@@ -1,65 +0,0 @@
-export type AccountStatus = 'active' | 'disabled' | 'frozen' | 'deleted' | 'creation_in_progress' | 'creation_failed';
-interface Account<TDetails = unknown> {
-    id: string;
-    urn: string;
-    medium: 'bancolombia' | 'card';
-    details: TDetails;
-    ledger_account_id: string;
-    status: AccountStatus;
-    owner_urn: string;
-    created_at: string;
-    updated_at: string;
-    webhook_url: string | null;
-    metadata?: Record<string, unknown>;
-}
-export type CardType = 'VIRTUAL' | 'PHYSICAL';
-export interface CreateAccountRequest<TInput = unknown> {
-    holder_urn: string;
-    ledger_account_id?: string;
-    input: TInput;
-    metadata?: Record<string, unknown>;
-    webhook_url?: string;
-}
-export type CreateCardAccountInput = {
-    create: {
-        card_type: CardType;
-    };
-};
-export interface CreateAccountResponse<TDetails = unknown> {
-    result: {
-        account: Account<TDetails>;
-    };
-    req_id: string;
-}
-export type CardDetails = {
-    id: string;
-    email: string;
-    operational_country: 'COL';
-    client_id: string;
-    card_id: string;
-    card_last_four: string;
-    card_provider: 'VISA';
-    card_product_type: 'CREDIT';
-    card_status: 'ACTIVE';
-    card_url_details: string;
-    card_type: CardType;
-    user_id: string;
-};
-export type BancolombiaDetails = {
-    id: string;
-    reference_code: string;
-    payment_agreement_code: string;
-    network: string[];
-};
-export interface UpdateAccountRequest<TInput = unknown> {
-    input?: TInput;
-    metadata?: Record<string, unknown>;
-    status?: AccountStatus;
-}
-export interface UpdateAccountResponse<TDetails = unknown> {
-    result: {
-        account: Account<TDetails>;
-    };
-    req_id: string;
-}
-export {};

package/dist/client.d.ts

@@ -1,19 +0,0 @@
-import type { HttpClient } from '@bloque/sdk-core';
-import { BaseClient } from '@bloque/sdk-core';
-import { BancolombiaClient } from './bancolombia/client';
-import { CardClient } from './card/client';
-/**
- * Accounts client for managing financial accounts and payment methods
- *
- * Provides access to various account types through specialized sub-clients:
- * - card: Credit/debit cards
- * - virtual: Virtual accounts
- * - bancolombia: Bancolombia accounts
- * - us: US bank accounts
- * - polygon: Polygon wallets
- */
-export declare class AccountsClient extends BaseClient {
-    readonly bancolombia: BancolombiaClient;
-    readonly card: CardClient;
-    constructor(httpClient: HttpClient);
-}