@fiado/type-kit 3.339.0 → 3.340.0

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.
@@ -3,7 +3,13 @@ import { CashInNetworkEnum } from '../enums/CashInNetworkEnum';
3
3
  import { CashInProviderEnum } from '../enums/CashInProviderEnum';
4
4
  import { EstablishmentBrandEnum } from '../enums/EstablishmentBrandEnum';
5
5
  /**
6
- * Establecimiento (punto de cash-in) servido desde el cache de HERE.
6
+ * Establecimiento (punto de cash-in).
7
+ *
8
+ * Es la forma ÚNICA con la que la app ve un punto de cash-in, sin importar de dónde salió:
9
+ * del cache de HERE (búsqueda por marca) o del directorio en vivo de un proveedor de fondeo.
10
+ * Quien decide la fuente es la config del lambda, y el cliente no se enfrenta a dos shapes:
11
+ * los campos que una fuente no puede llenar simplemente vienen ausentes.
12
+ *
7
13
  * Response DTO — sin decoradores de validación.
8
14
  */
9
15
  export declare class EstablishmentDto {
@@ -25,4 +31,22 @@ export declare class EstablishmentDto {
25
31
  country?: CountryId;
26
32
  /** Red Passport (OXXO/SUPERMERCADO/TIENDITA). En US no aplica. */
27
33
  network?: CashInNetworkEnum;
34
+ /**
35
+ * Comisión que el CLIENTE paga EN LA CAJA, encima de su depósito. No es la de Fiado.
36
+ *
37
+ * Va en la respuesta para que la app la muestre en el pin ANTES de mandar al cliente a
38
+ * la tienda: enterarse en el mostrador es la peor forma de enterarse.
39
+ */
40
+ cashInFrontFee?: number | null;
41
+ /** Tope por operación que acepta esa caja. Junto con la comisión, decide si el punto sirve. */
42
+ maxDepositAmount?: number | null;
43
+ /** Horario de atención en formato HH:mm, tal como lo informa el proveedor. */
44
+ openingTime?: string | null;
45
+ closingTime?: string | null;
46
+ /** Teléfono del punto. Muchos proveedores no lo informan. */
47
+ phone?: string | null;
48
+ /** Logo del comercio, para el pin o el carrusel. */
49
+ imageUrl?: string | null;
50
+ /** Imagen de ejemplo del código que el cajero escanea. */
51
+ sampleQr?: string | null;
28
52
  }
@@ -2,7 +2,13 @@
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.EstablishmentDto = void 0;
4
4
  /**
5
- * Establecimiento (punto de cash-in) servido desde el cache de HERE.
5
+ * Establecimiento (punto de cash-in).
6
+ *
7
+ * Es la forma ÚNICA con la que la app ve un punto de cash-in, sin importar de dónde salió:
8
+ * del cache de HERE (búsqueda por marca) o del directorio en vivo de un proveedor de fondeo.
9
+ * Quien decide la fuente es la config del lambda, y el cliente no se enfrenta a dos shapes:
10
+ * los campos que una fuente no puede llenar simplemente vienen ausentes.
11
+ *
6
12
  * Response DTO — sin decoradores de validación.
7
13
  */
8
14
  class EstablishmentDto {
@@ -1,13 +1,16 @@
1
1
  import { EstablishmentDto } from './EstablishmentDto';
2
2
  import { OfficeDto } from '../../offices/dtos/OfficeDto';
3
- import { FundingStoreItem } from '../../walletFunding/dtos/FundingStoreItem';
4
3
  /**
5
4
  * Respuesta de la búsqueda unificada. Solo se incluyen los tipos pedidos en `types`.
5
+ *
6
+ * Un campo por tipo de lugar, y el campo NO cambia según de dónde salió el dato: si
7
+ * `cashInMx` se resuelve contra el cache de HERE o contra el directorio en vivo de un
8
+ * proveedor de fondeo, la app lee el mismo campo con el mismo shape. El ruteo es una
9
+ * decisión del lambda, no algo que el cliente tenga que interpretar.
6
10
  */
7
11
  export declare class GetNearbyPlacesResponse {
8
12
  cashInUs?: EstablishmentDto[];
9
13
  cashInMx?: EstablishmentDto[];
10
- cashInMxStores?: FundingStoreItem[];
11
14
  officeFiado?: OfficeDto[];
12
15
  storeFiado?: OfficeDto[];
13
16
  }
@@ -3,6 +3,11 @@ Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.GetNearbyPlacesResponse = void 0;
4
4
  /**
5
5
  * Respuesta de la búsqueda unificada. Solo se incluyen los tipos pedidos en `types`.
6
+ *
7
+ * Un campo por tipo de lugar, y el campo NO cambia según de dónde salió el dato: si
8
+ * `cashInMx` se resuelve contra el cache de HERE o contra el directorio en vivo de un
9
+ * proveedor de fondeo, la app lee el mismo campo con el mismo shape. El ruteo es una
10
+ * decisión del lambda, no algo que el cliente tenga que interpretar.
6
11
  */
7
12
  class GetNearbyPlacesResponse {
8
13
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@fiado/type-kit",
3
- "version": "3.339.0",
3
+ "version": "3.340.0",
4
4
  "description": "",
5
5
  "main": "bin/index.js",
6
6
  "types": "bin/index.d.ts",
@@ -4,7 +4,13 @@ import { CashInProviderEnum } from '../enums/CashInProviderEnum';
4
4
  import { EstablishmentBrandEnum } from '../enums/EstablishmentBrandEnum';
5
5
 
6
6
  /**
7
- * Establecimiento (punto de cash-in) servido desde el cache de HERE.
7
+ * Establecimiento (punto de cash-in).
8
+ *
9
+ * Es la forma ÚNICA con la que la app ve un punto de cash-in, sin importar de dónde salió:
10
+ * del cache de HERE (búsqueda por marca) o del directorio en vivo de un proveedor de fondeo.
11
+ * Quien decide la fuente es la config del lambda, y el cliente no se enfrenta a dos shapes:
12
+ * los campos que una fuente no puede llenar simplemente vienen ausentes.
13
+ *
8
14
  * Response DTO — sin decoradores de validación.
9
15
  */
10
16
  export class EstablishmentDto {
@@ -27,4 +33,29 @@ export class EstablishmentDto {
27
33
  country?: CountryId;
28
34
  /** Red Passport (OXXO/SUPERMERCADO/TIENDITA). En US no aplica. */
29
35
  network?: CashInNetworkEnum;
36
+
37
+ // ─────────────────────────────────────────────────────────────────────────
38
+ // Datos que sólo informa un directorio en vivo del proveedor (aditivos, opcionales).
39
+ // El cache de HERE no los tiene: HERE sabe dónde está una tienda, no qué cobra.
40
+ // `null` = el proveedor los expone pero no informó valor; ausente = la fuente ni los maneja.
41
+ // ─────────────────────────────────────────────────────────────────────────
42
+
43
+ /**
44
+ * Comisión que el CLIENTE paga EN LA CAJA, encima de su depósito. No es la de Fiado.
45
+ *
46
+ * Va en la respuesta para que la app la muestre en el pin ANTES de mandar al cliente a
47
+ * la tienda: enterarse en el mostrador es la peor forma de enterarse.
48
+ */
49
+ cashInFrontFee?: number | null;
50
+ /** Tope por operación que acepta esa caja. Junto con la comisión, decide si el punto sirve. */
51
+ maxDepositAmount?: number | null;
52
+ /** Horario de atención en formato HH:mm, tal como lo informa el proveedor. */
53
+ openingTime?: string | null;
54
+ closingTime?: string | null;
55
+ /** Teléfono del punto. Muchos proveedores no lo informan. */
56
+ phone?: string | null;
57
+ /** Logo del comercio, para el pin o el carrusel. */
58
+ imageUrl?: string | null;
59
+ /** Imagen de ejemplo del código que el cajero escanea. */
60
+ sampleQr?: string | null;
30
61
  }
@@ -1,14 +1,17 @@
1
1
  import { EstablishmentDto } from './EstablishmentDto';
2
2
  import { OfficeDto } from '../../offices/dtos/OfficeDto';
3
- import { FundingStoreItem } from '../../walletFunding/dtos/FundingStoreItem';
4
3
 
5
4
  /**
6
5
  * Respuesta de la búsqueda unificada. Solo se incluyen los tipos pedidos en `types`.
6
+ *
7
+ * Un campo por tipo de lugar, y el campo NO cambia según de dónde salió el dato: si
8
+ * `cashInMx` se resuelve contra el cache de HERE o contra el directorio en vivo de un
9
+ * proveedor de fondeo, la app lee el mismo campo con el mismo shape. El ruteo es una
10
+ * decisión del lambda, no algo que el cliente tenga que interpretar.
7
11
  */
8
12
  export class GetNearbyPlacesResponse {
9
13
  cashInUs?: EstablishmentDto[];
10
14
  cashInMx?: EstablishmentDto[];
11
- cashInMxStores?: FundingStoreItem[];
12
15
  officeFiado?: OfficeDto[];
13
16
  storeFiado?: OfficeDto[];
14
17
  }