@fiado/type-kit 1.0.10 → 1.0.12

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (4) hide show
  1. package/bin/account/interface/IAccountProvider.d.ts +29 -0
  2. package/bin/account/interface/IAccountProvider.js +2 -0
  3. package/package.json +23 -23
  4. package/src/account/interface/IAccountProvider.ts +33 -0
package/bin/account/interface/IAccountProvider.d.ts ADDED
@@ -0,0 +1,29 @@
1
+ import { AccountCreateRequest } from "../dtos/AccountCreateRequest";
2
+ import { AccountCreateResponse } from "../dtos/AccountCreateResponse";
3
+ import { AccountResponse } from "../dtos/AccountResponse";
4
+ import { PocketCreateRequest } from "../dtos/PocketCreateRequest";
5
+ /**
6
+ * Interfaz para el servicio de Account
7
+ */
8
+ export interface IAccountProvider {
9
+ /**
10
+ * Obtiene los detalles de la cuenta a partir del ID de directorio.
11
+ * @path GET /accounts?directoryId={directoryId}
12
+ * @param directoryId El identificador del directorio asociado a la cuenta.
13
+ * @returns Los detalles de la cuenta.
14
+ */
15
+ getByDirectoryId(directoryId: string): Promise<AccountResponse>;
16
+ /**
17
+ * Crea una nueva cuenta.
18
+ * @path POST /accounts
19
+ * @param input Los datos necesarios para crear la cuenta.
20
+ * @returns Los detalles de la cuenta creada.
21
+ */
22
+ create(input: AccountCreateRequest): Promise<AccountCreateResponse>;
23
+ /**
24
+ * Crea un nuevo pocket para un beneficiario.
25
+ * @path POST /accounts/pockets
26
+ * @param input Los datos necesarios para crear el pocket.
27
+ */
28
+ createBeneficiaryPocket(input: PocketCreateRequest): Promise<void>;
29
+ }
package/bin/account/interface/IAccountProvider.js ADDED
@@ -0,0 +1,2 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
package/package.json CHANGED
@@ -1,24 +1,24 @@
1
1
  {
2
- "name": "@fiado/type-kit",
3
- "version": "1.0.10",
4
- "description": "",
5
- "main": "bin/index.js",
6
- "types": "bin/index.d.ts",
7
- "scripts": {
8
- "test": "jest",
9
- "build": "tsc"
10
- },
11
- "keywords": [],
12
- "author": "Fiado Inc",
13
- "license": "ISC",
14
- "devDependencies": {
15
- "@types/node": "^20.11.20",
16
- "install": "^0.13.0",
17
- "npm": "^10.4.0",
18
- "typescript": "^5.3.3"
19
- },
20
- "dependencies": {
21
- "class-transformer": "^0.5.1",
22
- "class-validator": "^0.14.1"
23
- }
24
- }
2
+ "name": "@fiado/type-kit",
3
+ "version": "1.0.12",
4
+ "description": "",
5
+ "main": "bin/index.js",
6
+ "types": "bin/index.d.ts",
7
+ "scripts": {
8
+ "test": "jest",
9
+ "build": "tsc"
10
+ },
11
+ "keywords": [],
12
+ "author": "Fiado Inc",
13
+ "license": "ISC",
14
+ "devDependencies": {
15
+ "@types/node": "^20.11.20",
16
+ "install": "^0.13.0",
17
+ "npm": "^10.4.0",
18
+ "typescript": "^5.3.3"
19
+ },
20
+ "dependencies": {
21
+ "class-transformer": "^0.5.1",
22
+ "class-validator": "^0.14.1"
23
+ }
24
+ }
package/src/account/interface/IAccountProvider.ts ADDED
@@ -0,0 +1,33 @@
1
+ import { AccountCreateRequest } from "../dtos/AccountCreateRequest";
2
+ import { AccountCreateResponse } from "../dtos/AccountCreateResponse";
3
+ import { AccountResponse } from "../dtos/AccountResponse";
4
+ import { PocketCreateRequest } from "../dtos/PocketCreateRequest";
5
+
6
+ /**
7
+ * Interfaz para el servicio de Account
8
+ */
9
+ export interface IAccountProvider {
10
+
11
+ /**
12
+ * Obtiene los detalles de la cuenta a partir del ID de directorio.
13
+ * @path GET /accounts?directoryId={directoryId}
14
+ * @param directoryId El identificador del directorio asociado a la cuenta.
15
+ * @returns Los detalles de la cuenta.
16
+ */
17
+ getByDirectoryId(directoryId: string): Promise<AccountResponse>;
18
+
19
+ /**
20
+ * Crea una nueva cuenta.
21
+ * @path POST /accounts
22
+ * @param input Los datos necesarios para crear la cuenta.
23
+ * @returns Los detalles de la cuenta creada.
24
+ */
25
+ create(input: AccountCreateRequest): Promise<AccountCreateResponse>;
26
+
27
+ /**
28
+ * Crea un nuevo pocket para un beneficiario.
29
+ * @path POST /accounts/pockets
30
+ * @param input Los datos necesarios para crear el pocket.
31
+ */
32
+ createBeneficiaryPocket(input: PocketCreateRequest): Promise<void>;
33
+ }