@bloque/sdk-accounts 0.0.6 → 0.0.10

package/README.md

@@ -5,6 +5,7 @@ Financial accounts and payment methods client for the [Bloque](https://www.bloqu
 ## Features
 
 - **Virtual Cards**: Create virtual cards instantly
+- **Bancolombia Accounts**: Create Bancolombia accounts with reference codes
 - **TypeScript First**: Built with TypeScript for complete type safety
 - **Simple API**: Minimal input required - just URN and optional name
 - **Fully Async**: Promise-based API for modern JavaScript workflows
@@ -46,6 +47,17 @@ console.log('Card created:', card.urn);
 console.log('Last four digits:', card.lastFour);
 console.log('Card details URL:', card.detailsUrl);
 console.log('Status:', card.status);
+
+// Create a Bancolombia account
+const bancolombiaAccount = await bloque.accounts.bancolombia.create({
+  urn: 'did:bloque:user:123',
+  name: 'Main Account', // Optional
+  cardUrn: card.urn, // Optional - link with existing card
+});
+
+console.log('Bancolombia account created:', bancolombiaAccount.urn);
+console.log('Reference code:', bancolombiaAccount.referenceCode);
+console.log('Status:', bancolombiaAccount.status);
 ```
 
 ## API Reference
@@ -99,6 +111,64 @@ interface CardAccount {
 }
 ```
 
+### Bancolombia Accounts
+
+Create Bancolombia accounts with reference codes for local payments.
+
+#### `bancolombia.create(params)`
+
+```typescript
+const account = await bloque.accounts.bancolombia.create({
+  urn: 'did:bloque:user:123',
+  name: 'Main Account', // Optional
+  cardUrn: 'did:bloque:card:456', // Optional - link with existing card
+});
+```
+
+**Parameters**:
+
+```typescript
+interface CreateBancolombiaAccountParams {
+  /**
+   * URN of the account holder (user or organization)
+   * @example "did:bloque:user:123e4567"
+   */
+  urn: string;
+
+  /**
+   * Display name for the account (optional)
+   */
+  name?: string;
+
+  /**
+   * URN of an existing card to link with the Bancolombia account (optional)
+   * @example "did:bloque:card:123e4567"
+   */
+  cardUrn?: string;
+
+  /**
+   * Custom metadata to attach to the Bancolombia account (optional)
+   */
+  metadata?: Record<string, unknown>;
+}
+```
+
+**Returns**:
+
+```typescript
+interface BancolombiaAccount {
+  urn: string;                    // Unique resource name
+  id: string;                     // Account ID
+  referenceCode: string;          // Reference code for payments
+  status: 'active' | 'disabled' | 'frozen' | 'deleted' | 'creation_in_progress' | 'creation_failed';
+  ownerUrn: string;               // Owner URN
+  webhookUrl: string | null;      // Webhook URL (if configured)
+  metadata?: Record<string, unknown>; // Custom metadata
+  createdAt: string;              // Creation timestamp (ISO 8601)
+  updatedAt: string;              // Last update timestamp (ISO 8601)
+}
+```
+
 ## Complete Examples
 
 ### Basic Card Creation
@@ -199,6 +269,81 @@ try {
 }
 ```
 
+### Basic Bancolombia Account Creation
+
+```typescript
+import { SDK } from '@bloque/sdk';
+
+const bloque = new SDK({
+  apiKey: process.env.BLOQUE_API_KEY!,
+  mode: 'production',
+});
+
+// Create a Bancolombia account with just URN
+const account = await bloque.accounts.bancolombia.create({
+  urn: 'did:bloque:user:123e4567',
+});
+
+console.log('Account created:', account.urn);
+console.log('Reference code:', account.referenceCode);
+console.log('Status:', account.status);
+```
+
+### Bancolombia Account with Card Link
+
+```typescript
+import { SDK } from '@bloque/sdk';
+
+const bloque = new SDK({
+  apiKey: process.env.BLOQUE_API_KEY!,
+  mode: 'production',
+});
+
+const userUrn = 'did:bloque:user:123e4567';
+
+// Create a card first
+const card = await bloque.accounts.card.create({
+  urn: userUrn,
+  name: 'My Card',
+});
+
+// Create Bancolombia account and link it to the card
+const account = await bloque.accounts.bancolombia.create({
+  urn: userUrn,
+  name: 'Main Account',
+  cardUrn: card.urn, // Link to existing card
+});
+
+console.log('Card URN:', card.urn);
+console.log('Account URN:', account.urn);
+console.log('Reference code for payments:', account.referenceCode);
+```
+
+### Bancolombia Account with Metadata
+
+```typescript
+import { SDK } from '@bloque/sdk';
+
+const bloque = new SDK({
+  apiKey: process.env.BLOQUE_API_KEY!,
+  mode: 'production',
+});
+
+// Create Bancolombia account with custom metadata
+const account = await bloque.accounts.bancolombia.create({
+  urn: 'did:bloque:user:123e4567',
+  name: 'Business Account',
+  metadata: {
+    purpose: 'business-payments',
+    department: 'sales',
+    customField: 'custom-value',
+  },
+});
+
+console.log('Account created with metadata:', account.metadata);
+console.log('Reference code:', account.referenceCode);
+```
+
 ## TypeScript Support
 
 This package is written in TypeScript and includes complete type definitions:
@@ -207,32 +352,47 @@ This package is written in TypeScript and includes complete type definitions:
 import type {
   CardAccount,
   CreateCardParams,
+  BancolombiaAccount,
+  CreateBancolombiaAccountParams,
 } from '@bloque/sdk-accounts';
 
 // Type-safe card creation
-const params: CreateCardParams = {
+const cardParams: CreateCardParams = {
   urn: 'did:bloque:user:123e4567',
   name: 'My Card', // Optional
 };
 
-const card: CardAccount = await bloque.accounts.card.create(params);
+const card: CardAccount = await bloque.accounts.card.create(cardParams);
 
 // TypeScript infers all card properties with full type safety
 console.log(card.lastFour); // string
 console.log(card.status);   // 'active' | 'disabled' | 'frozen' | 'deleted' | 'creation_in_progress' | 'creation_failed'
 console.log(card.cardType); // 'VIRTUAL' | 'PHYSICAL'
+
+// Type-safe Bancolombia account creation
+const accountParams: CreateBancolombiaAccountParams = {
+  urn: 'did:bloque:user:123e4567',
+  name: 'Main Account', // Optional
+  cardUrn: card.urn, // Optional
+};
+
+const account: BancolombiaAccount = await bloque.accounts.bancolombia.create(accountParams);
+
+// TypeScript infers all account properties with full type safety
+console.log(account.referenceCode); // string
+console.log(account.status);        // 'active' | 'disabled' | 'frozen' | 'deleted' | 'creation_in_progress' | 'creation_failed'
 ```
 
-## Card Status
+## Account Status
 
-Cards have a status field indicating their current state:
+Both cards and Bancolombia accounts have a status field indicating their current state:
 
-- `creation_in_progress`: Card is being created
-- `creation_failed`: Card creation failed
-- `active`: Card is active and ready to use
-- `disabled`: Card has been disabled
-- `frozen`: Card has been temporarily frozen
-- `deleted`: Card has been deleted
+- `creation_in_progress`: Account/card is being created
+- `creation_failed`: Account/card creation failed
+- `active`: Account/card is active and ready to use
+- `disabled`: Account/card has been disabled
+- `frozen`: Account/card has been temporarily frozen
+- `deleted`: Account/card has been deleted
 
 ## Requirements
 

package/dist/api-types.d.ts

@@ -42,4 +42,10 @@ export type CardDetails = {
     card_type: CardType;
     user_id: string;
 };
+export type BancolombiaDetails = {
+    id: string;
+    reference_code: string;
+    payment_agreement_code: string;
+    network: string[];
+};
 export {};

package/dist/bancolombia/client.d.ts

@@ -0,0 +1,21 @@
+import type { HttpClient } from '@bloque/sdk-core';
+import type { BancolombiaAccount, CreateBancolombiaAccountParams } from './types';
+export declare class BancolombiaClient {
+    private readonly httpClient;
+    constructor(httpClient: HttpClient);
+    /**
+     * Create a new Bancolombia account
+     *
+     * @param params - Bancolombia account creation parameters
+     * @returns Promise resolving to the created Bancolombia account
+     *
+     * @example
+     * ```typescript
+     * const account = await bloque.accounts.bancolombia.create({
+     *   urn: 'did:bloque:user:123',
+     *   name: 'Main Account'
+     * });
+     * ```
+     */
+    create(params: CreateBancolombiaAccountParams): Promise<BancolombiaAccount>;
+}

package/dist/bancolombia/types.d.ts

@@ -0,0 +1,63 @@
+export interface CreateBancolombiaAccountParams {
+    /**
+     * URN of the account holder (user or organization)
+     *
+     * @example "did:bloque:user:123e4567"
+     */
+    urn: string;
+    /**
+     * Display name for the card
+     */
+    name?: string;
+    /**
+     * URN of an existing card to link with the Bancolombia account
+     *
+     * @example "did:bloque:card:123e4567"
+     */
+    cardUrn?: string;
+    /**
+     * Custom metadata to attach to the Bancolombia account
+     */
+    metadata?: Record<string, unknown>;
+}
+/**
+ * Bancolombia account response
+ */
+export interface BancolombiaAccount {
+    /**
+     * Unique resource name for the Bancolombia account
+     */
+    urn: string;
+    /**
+     * Account ID
+     */
+    id: string;
+    /**
+     * Reference code for the Bancolombia account
+     */
+    referenceCode: string;
+    /**
+     * Account status
+     */
+    status: 'creation_in_progress' | 'active' | 'disabled' | 'frozen' | 'deleted' | 'creation_failed';
+    /**
+     * Owner URN
+     */
+    ownerUrn: string;
+    /**
+     * Webhook URL (if configured)
+     */
+    webhookUrl: string | null;
+    /**
+     * Custom metadata
+     */
+    metadata?: Record<string, unknown>;
+    /**
+     * Creation timestamp
+     */
+    createdAt: string;
+    /**
+     * Last update timestamp
+     */
+    updatedAt: string;
+}

package/dist/card/types.d.ts

@@ -10,6 +10,10 @@ export interface CreateCardParams {
      * Display name for the card
      */
     name?: string;
+    /**
+     * Custom metadata to associate with the card
+     */
+    metadata?: Record<string, unknown>;
 }
 export interface CardAccount {
     /**

package/dist/client.d.ts

@@ -1,4 +1,5 @@
 import type { HttpClient } from '@bloque/sdk-core';
+import { BancolombiaClient } from './bancolombia/client';
 import { CardClient } from './card/client';
 /**
  * Accounts client for managing financial accounts and payment methods
@@ -12,6 +13,7 @@ import { CardClient } from './card/client';
  */
 export declare class AccountsClient {
     private readonly httpClient;
+    readonly bancolombia: BancolombiaClient;
     readonly card: CardClient;
     constructor(httpClient: HttpClient);
 }

package/dist/index.cjs

@@ -25,8 +25,44 @@ var __webpack_exports__ = {};
 __webpack_require__.r(__webpack_exports__);
 __webpack_require__.d(__webpack_exports__, {
     AccountsClient: ()=>AccountsClient,
-    CardClient: ()=>CardClient
+    CardClient: ()=>CardClient,
+    BancolombiaClient: ()=>BancolombiaClient
 });
+class BancolombiaClient {
+    httpClient;
+    constructor(httpClient){
+        this.httpClient = httpClient;
+    }
+    async create(params) {
+        const request = {
+            holder_urn: params.urn,
+            input: {},
+            metadata: {
+                source: "sdk-typescript",
+                name: params.name,
+                card_urn: params.cardUrn,
+                ...params.metadata
+            }
+        };
+        const response = await this.httpClient.request({
+            method: 'POST',
+            path: '/api/mediums/bancolombia',
+            body: request
+        });
+        const account = response.result.account;
+        return {
+            urn: account.urn,
+            id: account.id,
+            referenceCode: account.details.reference_code,
+            status: account.status,
+            ownerUrn: account.owner_urn,
+            webhookUrl: account.webhook_url,
+            metadata: account.metadata,
+            createdAt: account.created_at,
+            updatedAt: account.updated_at
+        };
+    }
+}
 class CardClient {
     httpClient;
     constructor(httpClient){
@@ -42,7 +78,8 @@ class CardClient {
             },
             metadata: {
                 source: "sdk-typescript",
-                name: params.name
+                name: params.name,
+                ...params.metadata
             }
         };
         const response = await this.httpClient.request({
@@ -69,16 +106,20 @@ class CardClient {
 }
 class AccountsClient {
     httpClient;
+    bancolombia;
     card;
     constructor(httpClient){
         this.httpClient = httpClient;
+        this.bancolombia = new BancolombiaClient(this.httpClient);
         this.card = new CardClient(this.httpClient);
     }
 }
 exports.AccountsClient = __webpack_exports__.AccountsClient;
+exports.BancolombiaClient = __webpack_exports__.BancolombiaClient;
 exports.CardClient = __webpack_exports__.CardClient;
 for(var __rspack_i in __webpack_exports__)if (-1 === [
     "AccountsClient",
+    "BancolombiaClient",
     "CardClient"
 ].indexOf(__rspack_i)) exports[__rspack_i] = __webpack_exports__[__rspack_i];
 Object.defineProperty(exports, '__esModule', {

package/dist/index.d.ts

@@ -1,3 +1,5 @@
+export * from './bancolombia/client';
+export * from './bancolombia/types';
 export * from './card/client';
 export * from './card/types';
 export * from './client';

package/dist/index.js

@@ -1,3 +1,38 @@
+class BancolombiaClient {
+    httpClient;
+    constructor(httpClient){
+        this.httpClient = httpClient;
+    }
+    async create(params) {
+        const request = {
+            holder_urn: params.urn,
+            input: {},
+            metadata: {
+                source: "sdk-typescript",
+                name: params.name,
+                card_urn: params.cardUrn,
+                ...params.metadata
+            }
+        };
+        const response = await this.httpClient.request({
+            method: 'POST',
+            path: '/api/mediums/bancolombia',
+            body: request
+        });
+        const account = response.result.account;
+        return {
+            urn: account.urn,
+            id: account.id,
+            referenceCode: account.details.reference_code,
+            status: account.status,
+            ownerUrn: account.owner_urn,
+            webhookUrl: account.webhook_url,
+            metadata: account.metadata,
+            createdAt: account.created_at,
+            updatedAt: account.updated_at
+        };
+    }
+}
 class CardClient {
     httpClient;
     constructor(httpClient){
@@ -13,7 +48,8 @@ class CardClient {
             },
             metadata: {
                 source: "sdk-typescript",
-                name: params.name
+                name: params.name,
+                ...params.metadata
             }
         };
         const response = await this.httpClient.request({
@@ -40,10 +76,12 @@ class CardClient {
 }
 class AccountsClient {
     httpClient;
+    bancolombia;
     card;
     constructor(httpClient){
         this.httpClient = httpClient;
+        this.bancolombia = new BancolombiaClient(this.httpClient);
         this.card = new CardClient(this.httpClient);
     }
 }
-export { AccountsClient, CardClient };
+export { AccountsClient, BancolombiaClient, CardClient };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bloque/sdk-accounts",
-  "version": "0.0.6",
+  "version": "0.0.10",
   "type": "module",
   "keywords": [
     "bloque",
@@ -36,7 +36,7 @@
     "node": ">=22"
   },
   "scripts": {
-    "publish": "bun publish",
+    "release": "bun publish",
     "build": "rslib build",
     "dev": "rslib build --watch",
     "clean": "rm -rf node_modules && rm -rf dist",