@fiado/type-kit 1.0.11 → 1.0.13

package/bin/account/index.d.ts

@@ -4,3 +4,4 @@ export * from './dtos/AccountCreateResponse';
 export * from './dtos/PocketCreateRequest';
 export * from './dtos/PocketCreateResponse';
 export * from './enums/AccountStatus';
+export * from './interface/IAccountProvider';

package/bin/account/index.js

@@ -22,3 +22,5 @@ __exportStar(require("./dtos/PocketCreateRequest"), exports);
 __exportStar(require("./dtos/PocketCreateResponse"), exports);
 //enums
 __exportStar(require("./enums/AccountStatus"), exports);
+//interfaces
+__exportStar(require("./interface/IAccountProvider"), exports);

package/bin/account/interface/IAccountProvider.d.ts

@@ -0,0 +1,29 @@
+import { AccountCreateRequest } from "../dtos/AccountCreateRequest";
+import { AccountCreateResponse } from "../dtos/AccountCreateResponse";
+import { AccountResponse } from "../dtos/AccountResponse";
+import { PocketCreateRequest } from "../dtos/PocketCreateRequest";
+/**
+ * Interfaz para el servicio de Account
+ */
+export interface IAccountProvider {
+    /**
+     * Obtiene los detalles de la cuenta a partir del ID de directorio.
+     * @path GET /accounts?directoryId={directoryId}
+     * @param directoryId El identificador del directorio asociado a la cuenta.
+     * @returns Los detalles de la cuenta.
+     */
+    getByDirectoryId(directoryId: string): Promise<AccountResponse>;
+    /**
+     * Crea una nueva cuenta.
+     * @path POST /accounts
+     * @param input Los datos necesarios para crear la cuenta.
+     * @returns Los detalles de la cuenta creada.
+     */
+    create(input: AccountCreateRequest): Promise<AccountCreateResponse>;
+    /**
+     * Crea un nuevo pocket para un beneficiario.
+     * @path POST /accounts/pockets
+     * @param input Los datos necesarios para crear el pocket.
+     */
+    createBeneficiaryPocket(input: PocketCreateRequest): Promise<void>;
+}

package/bin/account/interface/IAccountProvider.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/package.json

@@ -1,24 +1,24 @@
 {
-  "name": "@fiado/type-kit",
-  "version": "1.0.11",
-  "description": "",
-  "main": "bin/index.js",
-  "types": "bin/index.d.ts",
-  "scripts": {
-    "test": "jest",
-    "build": "tsc"
-  },
-  "keywords": [],
-  "author": "Fiado Inc",
-  "license": "ISC",
-  "devDependencies": {
-    "@types/node": "^20.11.20",
-    "install": "^0.13.0",
-    "npm": "^10.4.0",
-    "typescript": "^5.3.3"
-  },
-  "dependencies": {
-    "class-transformer": "^0.5.1",
-    "class-validator": "^0.14.1"
-  }
-}
+	"name": "@fiado/type-kit",
+	"version": "1.0.13",
+	"description": "",
+	"main": "bin/index.js",
+	"types": "bin/index.d.ts",
+	"scripts": {
+		"test": "jest",
+		"build": "tsc"
+	},
+	"keywords": [],
+	"author": "Fiado Inc",
+	"license": "ISC",
+	"devDependencies": {
+		"@types/node": "^20.11.20",
+		"install": "^0.13.0",
+		"npm": "^10.4.0",
+		"typescript": "^5.3.3"
+	},
+	"dependencies": {
+		"class-transformer": "^0.5.1",
+		"class-validator": "^0.14.1"
+	}
+}

package/src/account/index.ts

@@ -11,3 +11,7 @@ export * from './dtos/PocketCreateResponse';
 export * from './enums/AccountStatus';
 
 
+//interfaces
+export * from './interface/IAccountProvider';
+
+

package/src/account/interface/IAccountProvider.ts

@@ -0,0 +1,33 @@
+import { AccountCreateRequest } from "../dtos/AccountCreateRequest";
+import { AccountCreateResponse } from "../dtos/AccountCreateResponse";
+import { AccountResponse } from "../dtos/AccountResponse";
+import { PocketCreateRequest } from "../dtos/PocketCreateRequest";
+
+/**
+ * Interfaz para el servicio de Account
+ */
+export interface IAccountProvider {
+
+    /**
+     * Obtiene los detalles de la cuenta a partir del ID de directorio.
+     * @path GET /accounts?directoryId={directoryId}
+     * @param directoryId El identificador del directorio asociado a la cuenta.
+     * @returns Los detalles de la cuenta.
+     */
+    getByDirectoryId(directoryId: string): Promise<AccountResponse>;
+
+    /**
+     * Crea una nueva cuenta.
+     * @path POST /accounts
+     * @param input Los datos necesarios para crear la cuenta.
+     * @returns Los detalles de la cuenta creada.
+     */
+    create(input: AccountCreateRequest): Promise<AccountCreateResponse>;
+
+    /**
+     * Crea un nuevo pocket para un beneficiario.
+     * @path POST /accounts/pockets
+     * @param input Los datos necesarios para crear el pocket.
+     */
+    createBeneficiaryPocket(input: PocketCreateRequest): Promise<void>;
+}