falconhub-apilibrary 1.2.0 → 1.2.1-dev.66

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.
package/dist/index.d.mts CHANGED
@@ -40,11 +40,11 @@ declare class CryptoService {
40
40
  */
41
41
  sha256(text: string): string;
42
42
  /**
43
- * Genera un identificador único basado en timestamp y random
44
- * (útil para request IDs)
45
- *
46
- * @returns ID único
47
- */
43
+ * Genera un identificador único basado en timestamp y random
44
+ * (útil para request IDs)
45
+ *
46
+ * @returns ID único
47
+ */
48
48
  generateUniqueId(): string;
49
49
  }
50
50
 
@@ -256,26 +256,6 @@ interface ValidateSessionResponse {
256
256
  isRemembered: boolean;
257
257
  }
258
258
 
259
- interface ConfirmEmailRequest {
260
- email: string;
261
- expiresAt: string;
262
- }
263
-
264
- interface SendOtpRequest {
265
- email: string;
266
- }
267
-
268
- interface ValidateOtpRequest {
269
- email: string;
270
- otp: string;
271
- }
272
-
273
- interface ChangePasswordRequest {
274
- email: string;
275
- oldPassword: string;
276
- newPassword: string;
277
- }
278
-
279
259
  declare class AuthService {
280
260
  private api;
281
261
  private crytpoService;
@@ -304,26 +284,6 @@ declare class AuthService {
304
284
  * Cierra sesión: notifica al servidor y limpia tokens
305
285
  */
306
286
  logout(): Promise<ResponseModel>;
307
- /**
308
- * Confirma el correo electrónico de un usuario.
309
- * @param request - Email y expiresAt
310
- */
311
- confirmEmail(request: ConfirmEmailRequest): Promise<ResponseModel>;
312
- /**
313
- * Envía un código OTP al correo electrónico.
314
- * @param request - Email del usuario
315
- */
316
- sendOtp(request: SendOtpRequest): Promise<ResponseModel>;
317
- /**
318
- * Valida un código OTP.
319
- * @param request - Email y código OTP
320
- */
321
- validateOtp(request: ValidateOtpRequest): Promise<ResponseModel>;
322
- /**
323
- * Cambia la contraseña del usuario (flujo público, sin sesión).
324
- * @param request - Email, contraseña actual y nueva contraseña
325
- */
326
- changePassword(request: ChangePasswordRequest): Promise<ResponseModel>;
327
287
  /**
328
288
  * Verifica si el usuario está autenticado
329
289
  */
@@ -396,61 +356,11 @@ interface UserBasicResponse {
396
356
  securityLevel: number;
397
357
  }
398
358
 
399
- interface UserAdminRequest {
400
- username: string;
401
- firstName: string;
402
- lastName: string;
403
- email: string;
404
- phone: string;
405
- areaCodeId: number;
406
- birthday: string;
407
- genderId: number;
408
- roleId: number;
409
- userTypeId: number;
410
- }
411
-
412
- interface UserAuthAdminRequest {
413
- userId: number;
414
- securityLevel: number;
415
- clientId: string;
416
- requireEmailConfirmation?: boolean;
417
- }
418
-
419
- interface ChangePasswordAdminRequest {
420
- newPassword: string;
421
- }
422
-
423
- interface UserAdminFilter {
424
- Search?: string;
425
- Username?: string;
426
- FirstName?: string;
427
- LastName?: string;
428
- Email?: string;
429
- Phone?: string;
430
- RoleId?: number;
431
- UserTypeId?: number;
432
- IsActive?: boolean;
433
- }
434
-
435
- interface UserAdminUpdateRequest {
436
- username: string;
437
- firstName: string;
438
- lastName: string;
439
- email: string;
440
- phone: string;
441
- areaCodeId: number;
442
- birthday?: string;
443
- genderId: number;
444
- roleId: number;
445
- userTypeId: number;
446
- }
447
-
448
- interface UserAuthUpdateRequest {
449
- securityLevel: number;
450
- clientId: string;
451
- isTwoFactorEnabled?: boolean;
452
- emailVerified?: boolean;
453
- phoneVerified?: boolean;
359
+ declare class UserService {
360
+ private api;
361
+ constructor(api: API);
362
+ me(): Promise<ResponseModel<UserBasicResponse>>;
363
+ profile(): Promise<ResponseModel<UserProfileResponse>>;
454
364
  }
455
365
 
456
366
  /**
@@ -458,7 +368,7 @@ interface UserAuthUpdateRequest {
458
368
  *
459
369
  * @example
460
370
  * ```typescript
461
- * const filter: EndpointsFilter = { HttpMethod: 'GET', IsActive: true };
371
+ * const filter: SYS_EndpointsFilter = { HttpMethod: 'GET', IsActive: true };
462
372
  * const queryString = FilterBuilder.toQueryString(filter);
463
373
  * // Result: "HttpMethod=GET&IsActive=true"
464
374
  * ```
@@ -567,70 +477,10 @@ interface FilterGroup {
567
477
  */
568
478
  type FilterGroupsModel = FilterGroup[];
569
479
 
570
- declare class UserService {
571
- private api;
572
- private readonly BASE_PATH;
573
- constructor(api: API);
574
- me(): Promise<ResponseModel<UserBasicResponse>>;
575
- profile(): Promise<ResponseModel<UserProfileResponse>>;
576
- /**
577
- * Crea un nuevo usuario administrador.
578
- * @param request - Datos del nuevo administrador
579
- */
580
- newAdminUser(request: UserAdminRequest): Promise<ResponseModel>;
581
- /**
582
- * Crea la autenticación para un usuario.
583
- * @param request - Datos de autenticación del usuario
584
- */
585
- createUserAuthentication(request: UserAuthAdminRequest): Promise<ResponseModel>;
586
- /**
587
- * Cambia la contraseña de un administrador.
588
- * @param id - ID del usuario
589
- * @param request - Nueva contraseña
590
- */
591
- changePasswordAdmin(id: number, request: ChangePasswordAdminRequest): Promise<ResponseModel>;
592
- /**
593
- * Obtiene todos los administradores con filtros opcionales.
594
- * @param filter - Filtros opcionales para la búsqueda
595
- */
596
- getAllAdmins(filter?: UserAdminFilter): Promise<ResponseModel>;
597
- /**
598
- * Obtiene el modelo de filtros disponibles para administradores.
599
- */
600
- getAdminFiltersModel(): Promise<ResponseModel<FilterGroupsModel>>;
601
- /**
602
- * Obtiene un administrador por su ID.
603
- * @param id - ID del administrador
604
- */
605
- getAdminById(id: number): Promise<ResponseModel>;
606
- /**
607
- * Obtiene la autenticación de un administrador.
608
- * @param id - ID del usuario
609
- */
610
- getAdminAuthentication(id: number): Promise<ResponseModel>;
611
- /**
612
- * Actualiza un administrador existente.
613
- * @param id - ID del administrador
614
- * @param request - Nuevos datos del administrador
615
- */
616
- updateAdmin(id: number, request: UserAdminUpdateRequest): Promise<ResponseModel>;
617
- /**
618
- * Activa o desactiva un administrador.
619
- * @param id - ID del administrador
620
- */
621
- toggleAdminStatus(id: number): Promise<ResponseModel>;
622
- /**
623
- * Actualiza la autenticación de un administrador.
624
- * @param id - ID del usuario
625
- * @param request - Nuevos datos de autenticación
626
- */
627
- updateAdminAuthentication(id: number, request: UserAuthUpdateRequest): Promise<ResponseModel>;
628
- }
629
-
630
480
  /**
631
481
  * Interfaz que representa un módulo del sistema.
632
482
  */
633
- interface Module {
483
+ interface System_Module {
634
484
  moduleId: number;
635
485
  module: string;
636
486
  description: string;
@@ -642,7 +492,7 @@ interface Module {
642
492
  /**
643
493
  * Request para crear o actualizar un módulo.
644
494
  */
645
- interface ModuleRequest {
495
+ interface System_ModuleRequest {
646
496
  module: string;
647
497
  description: string;
648
498
  isActive?: boolean;
@@ -651,7 +501,7 @@ interface ModuleRequest {
651
501
  * Filtros disponibles para buscar módulos.
652
502
  * Todos los campos son opcionales.
653
503
  */
654
- interface ModulesFilter {
504
+ interface System_ModulesFilter {
655
505
  /** Búsqueda general (busca en Module y Description) */
656
506
  Search?: string;
657
507
  /** Filtro por nombre del módulo (búsqueda parcial) */
@@ -665,7 +515,7 @@ interface ModulesFilter {
665
515
  /**
666
516
  * Interfaz que representa un endpoint del sistema.
667
517
  */
668
- interface Endpoint {
518
+ interface System_Endpoint {
669
519
  endpointId: number;
670
520
  endpoint: string;
671
521
  httpMethod: string;
@@ -684,7 +534,7 @@ interface Endpoint {
684
534
  /**
685
535
  * Request para crear o actualizar un endpoint.
686
536
  */
687
- interface EndpointRequest {
537
+ interface System_EndpointRequest {
688
538
  endpoint: string;
689
539
  httpMethod: string;
690
540
  path: string;
@@ -704,7 +554,7 @@ type HttpMethodType = 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH';
704
554
  * Filtros disponibles para buscar endpoints.
705
555
  * Todos los campos son opcionales.
706
556
  */
707
- interface EndpointsFilter {
557
+ interface System_EndpointsFilter {
708
558
  /** Búsqueda general (busca en Endpoint, Path y Description) */
709
559
  Search?: string;
710
560
  /** Filtro por nombre del endpoint (búsqueda parcial) */
@@ -730,7 +580,7 @@ interface EndpointsFilter {
730
580
  /**
731
581
  * Interfaz que representa una ruta de UI del sistema.
732
582
  */
733
- interface UIRoute {
583
+ interface System_UIRoute {
734
584
  uiRouteId: number;
735
585
  uiRoute: string;
736
586
  path: string;
@@ -743,7 +593,7 @@ interface UIRoute {
743
593
  /**
744
594
  * Request para crear o actualizar una ruta de UI.
745
595
  */
746
- interface UIRouteRequest {
596
+ interface System_UIRouteRequest {
747
597
  uiRoute: string;
748
598
  path: string;
749
599
  description: string;
@@ -753,7 +603,7 @@ interface UIRouteRequest {
753
603
  * Filtros disponibles para buscar rutas de UI.
754
604
  * Todos los campos son opcionales.
755
605
  */
756
- interface UIRoutesFilter {
606
+ interface System_UIRoutesFilter {
757
607
  /** Búsqueda general (busca en UIRoute, Path y Description) */
758
608
  Search?: string;
759
609
  /** Filtro por nombre de la ruta (búsqueda parcial) */
@@ -777,7 +627,7 @@ declare class SystemService {
777
627
  * Obtiene todos los módulos con filtros opcionales.
778
628
  * @param filter - Filtros opcionales para la búsqueda
779
629
  */
780
- getModules(filter?: ModulesFilter): Promise<ResponseModel<Module[]>>;
630
+ getModules(filter?: System_ModulesFilter): Promise<ResponseModel<System_Module[]>>;
781
631
  /**
782
632
  * Obtiene el modelo de filtros disponibles para módulos.
783
633
  */
@@ -786,23 +636,23 @@ declare class SystemService {
786
636
  * Obtiene un módulo por su ID.
787
637
  * @param id - ID del módulo
788
638
  */
789
- getModuleById(id: number): Promise<ResponseModel<Module>>;
639
+ getModuleById(id: number): Promise<ResponseModel<System_Module>>;
790
640
  /**
791
641
  * Crea un nuevo módulo.
792
642
  * @param request - Datos del módulo a crear
793
643
  */
794
- createModule(request: ModuleRequest): Promise<ResponseModel<Module>>;
644
+ createModule(request: System_ModuleRequest): Promise<ResponseModel<System_Module>>;
795
645
  /**
796
646
  * Actualiza un módulo existente.
797
647
  * @param id - ID del módulo a actualizar
798
648
  * @param request - Nuevos datos del módulo
799
649
  */
800
- updateModule(id: number, request: ModuleRequest): Promise<ResponseModel<Module>>;
650
+ updateModule(id: number, request: System_ModuleRequest): Promise<ResponseModel<System_Module>>;
801
651
  /**
802
652
  * Activa o desactiva un módulo.
803
653
  * @param id - ID del módulo
804
654
  */
805
- toggleModuleStatus(id: number): Promise<ResponseModel<Module>>;
655
+ toggleModuleStatus(id: number): Promise<ResponseModel<System_Module>>;
806
656
  /**
807
657
  * Elimina un módulo.
808
658
  * @param id - ID del módulo a eliminar
@@ -812,7 +662,7 @@ declare class SystemService {
812
662
  * Obtiene todos los endpoints con filtros opcionales.
813
663
  * @param filter - Filtros opcionales para la búsqueda
814
664
  */
815
- getEndpoints(filter?: EndpointsFilter): Promise<ResponseModel<Endpoint[]>>;
665
+ getEndpoints(filter?: System_EndpointsFilter): Promise<ResponseModel<System_Endpoint[]>>;
816
666
  /**
817
667
  * Obtiene el modelo de filtros disponibles para endpoints.
818
668
  */
@@ -821,23 +671,23 @@ declare class SystemService {
821
671
  * Obtiene un endpoint por su ID.
822
672
  * @param id - ID del endpoint
823
673
  */
824
- getEndpointById(id: number): Promise<ResponseModel<Endpoint>>;
674
+ getEndpointById(id: number): Promise<ResponseModel<System_Endpoint>>;
825
675
  /**
826
676
  * Crea un nuevo endpoint.
827
677
  * @param request - Datos del endpoint a crear
828
678
  */
829
- createEndpoint(request: EndpointRequest): Promise<ResponseModel<Endpoint>>;
679
+ createEndpoint(request: System_EndpointRequest): Promise<ResponseModel<System_Endpoint>>;
830
680
  /**
831
681
  * Actualiza un endpoint existente.
832
682
  * @param id - ID del endpoint a actualizar
833
683
  * @param request - Nuevos datos del endpoint
834
684
  */
835
- updateEndpoint(id: number, request: EndpointRequest): Promise<ResponseModel<Endpoint>>;
685
+ updateEndpoint(id: number, request: System_EndpointRequest): Promise<ResponseModel<System_Endpoint>>;
836
686
  /**
837
687
  * Activa o desactiva un endpoint.
838
688
  * @param id - ID del endpoint
839
689
  */
840
- toggleEndpointStatus(id: number): Promise<ResponseModel<Endpoint>>;
690
+ toggleEndpointStatus(id: number): Promise<ResponseModel<System_Endpoint>>;
841
691
  /**
842
692
  * Elimina un endpoint.
843
693
  * @param id - ID del endpoint a eliminar
@@ -847,7 +697,7 @@ declare class SystemService {
847
697
  * Obtiene todas las rutas de UI con filtros opcionales.
848
698
  * @param filter - Filtros opcionales para la búsqueda
849
699
  */
850
- getUIRoutes(filter?: UIRoutesFilter): Promise<ResponseModel<UIRoute[]>>;
700
+ getUIRoutes(filter?: System_UIRoutesFilter): Promise<ResponseModel<System_UIRoute[]>>;
851
701
  /**
852
702
  * Obtiene el modelo de filtros disponibles para rutas de UI.
853
703
  */
@@ -856,23 +706,23 @@ declare class SystemService {
856
706
  * Obtiene una ruta de UI por su ID.
857
707
  * @param id - ID de la ruta
858
708
  */
859
- getUIRouteById(id: number): Promise<ResponseModel<UIRoute>>;
709
+ getUIRouteById(id: number): Promise<ResponseModel<System_UIRoute>>;
860
710
  /**
861
711
  * Crea una nueva ruta de UI.
862
712
  * @param request - Datos de la ruta a crear
863
713
  */
864
- createUIRoute(request: UIRouteRequest): Promise<ResponseModel<UIRoute>>;
714
+ createUIRoute(request: System_UIRouteRequest): Promise<ResponseModel<System_UIRoute>>;
865
715
  /**
866
716
  * Actualiza una ruta de UI existente.
867
717
  * @param id - ID de la ruta a actualizar
868
718
  * @param request - Nuevos datos de la ruta
869
719
  */
870
- updateUIRoute(id: number, request: UIRouteRequest): Promise<ResponseModel<UIRoute>>;
720
+ updateUIRoute(id: number, request: System_UIRouteRequest): Promise<ResponseModel<System_UIRoute>>;
871
721
  /**
872
722
  * Activa o desactiva una ruta de UI.
873
723
  * @param id - ID de la ruta
874
724
  */
875
- toggleUIRouteStatus(id: number): Promise<ResponseModel<UIRoute>>;
725
+ toggleUIRouteStatus(id: number): Promise<ResponseModel<System_UIRoute>>;
876
726
  /**
877
727
  * Elimina una ruta de UI.
878
728
  * @param id - ID de la ruta a eliminar
@@ -880,121 +730,6 @@ declare class SystemService {
880
730
  deleteUIRoute(id: number): Promise<ResponseModel<void>>;
881
731
  }
882
732
 
883
- interface LocationsRequest {
884
- locationName: string;
885
- address1: string;
886
- address2?: string;
887
- city: string;
888
- state: string;
889
- country: string;
890
- postalCode: string;
891
- contactName: string;
892
- contactPhone: string;
893
- contactEmail: string;
894
- isActive?: boolean;
895
- }
896
- interface LocationsFilter {
897
- Search?: string;
898
- LocationName?: string;
899
- City?: string;
900
- State?: string;
901
- Country?: string;
902
- IsActive?: boolean;
903
- }
904
-
905
- interface InventoryStatusRequest {
906
- inventoryStatusId?: number;
907
- inventoryStatus: string;
908
- description: string;
909
- createdAt?: string;
910
- updatedAt?: string;
911
- deleted?: boolean;
912
- }
913
- interface InventoryStatusesFilter {
914
- Search?: string;
915
- InventoryStatus?: string;
916
- Description?: string;
917
- }
918
-
919
- /**
920
- * Servicio para gestionar inventario: ubicaciones y estatus.
921
- */
922
- declare class InventoryService {
923
- private api;
924
- private readonly BASE_PATH;
925
- constructor(api: API);
926
- /**
927
- * Obtiene todas las ubicaciones con filtros opcionales.
928
- * @param filter - Filtros opcionales para la búsqueda
929
- */
930
- getLocations(filter?: LocationsFilter): Promise<ResponseModel>;
931
- /**
932
- * Obtiene el modelo de filtros disponibles para ubicaciones.
933
- */
934
- getLocationFiltersModel(): Promise<ResponseModel<FilterGroupsModel>>;
935
- /**
936
- * Obtiene una ubicación por su ID.
937
- * @param id - ID de la ubicación
938
- */
939
- getLocationById(id: number): Promise<ResponseModel>;
940
- /**
941
- * Crea una nueva ubicación.
942
- * @param request - Datos de la ubicación a crear
943
- */
944
- createLocation(request: LocationsRequest): Promise<ResponseModel>;
945
- /**
946
- * Actualiza una ubicación existente.
947
- * @param id - ID de la ubicación a actualizar
948
- * @param request - Nuevos datos de la ubicación
949
- */
950
- updateLocation(id: number, request: LocationsRequest): Promise<ResponseModel>;
951
- /**
952
- * Activa o desactiva una ubicación.
953
- * @param id - ID de la ubicación
954
- */
955
- toggleLocationStatus(id: number): Promise<ResponseModel>;
956
- /**
957
- * Elimina una ubicación.
958
- * @param id - ID de la ubicación a eliminar
959
- */
960
- deleteLocation(id: number): Promise<ResponseModel<void>>;
961
- /**
962
- * Obtiene todos los estatus de inventario con filtros opcionales.
963
- * @param filter - Filtros opcionales para la búsqueda
964
- */
965
- getStatuses(filter?: InventoryStatusesFilter): Promise<ResponseModel>;
966
- /**
967
- * Obtiene el modelo de filtros disponibles para estatus de inventario.
968
- */
969
- getStatusFiltersModel(): Promise<ResponseModel<FilterGroupsModel>>;
970
- /**
971
- * Obtiene un estatus de inventario por su ID.
972
- * @param id - ID del estatus
973
- */
974
- getStatusById(id: number): Promise<ResponseModel>;
975
- /**
976
- * Crea un nuevo estatus de inventario.
977
- * @param request - Datos del estatus a crear
978
- */
979
- createStatus(request: InventoryStatusRequest): Promise<ResponseModel>;
980
- /**
981
- * Actualiza un estatus de inventario existente.
982
- * @param id - ID del estatus a actualizar
983
- * @param request - Nuevos datos del estatus
984
- */
985
- updateStatus(id: number, request: InventoryStatusRequest): Promise<ResponseModel>;
986
- /**
987
- * Activa o desactiva un estatus de inventario.
988
- * @param id - ID del estatus
989
- */
990
- toggleStatusActive(id: number): Promise<ResponseModel>;
991
- /**
992
- * Elimina un estatus de inventario.
993
- * @param id - ID del estatus a eliminar
994
- */
995
- deleteStatus(id: number): Promise<ResponseModel<void>>;
996
- }
997
-
998
733
  /**
999
734
  * SDK principal de FalconHUB
1000
735
  */
@@ -1002,7 +737,6 @@ declare class FalconHUBSDK {
1002
737
  auth: AuthService;
1003
738
  user: UserService;
1004
739
  system: SystemService;
1005
- inventory: InventoryService;
1006
740
  private serviceProperties;
1007
741
  private cryptoService;
1008
742
  private tokenManager;
@@ -1033,6 +767,4 @@ declare class FalconHUBSDK {
1033
767
  getTimeUntilExpiry(): number | null;
1034
768
  }
1035
769
 
1036
- declare function decrypt(encryptedBase64: string, secret: string, timestamp: string): string;
1037
-
1038
- export { API, AuthInterceptor, type AuthInterceptorConfig, AuthService, type ChangePasswordAdminRequest, type ChangePasswordRequest, type ConfirmEmailRequest, CryptoService, type Endpoint, type EndpointRequest, type EndpointsFilter, ErrorResponse, FalconHUBSDK, FilterBuilder, type FilterFieldMetadata, type FilterGroup, type FilterGroupOption, type FilterGroupsModel, type FilterMetadataModel, type FilterModel, type HttpMethodType, type InterceptorContext, InventoryService, type InventoryStatusRequest, type InventoryStatusesFilter, type LocationsFilter, type LocationsRequest, type LoginRequest, type LoginResponse, type MethodTypes, type Module, type ModuleRequest, type ModulesFilter, type RefreshTokenRequest, type RefreshTokenResponse, type RequestConfig, type RequestInterceptor, type RequestOptions, type ResponseModel, type SendOtpRequest, type ServiceProperties, SystemService, type TokenData, TokenManager, type UIRoute, type UIRouteRequest, type UIRoutesFilter, type UserAdminFilter, type UserAdminRequest, type UserAdminUpdateRequest, type UserAuthAdminRequest, type UserAuthUpdateRequest, type UserBasicResponse, type UserProfileResponse, UserService, type ValidateOtpRequest, type ValidateSessionRenewedResponse, type ValidateSessionResponse, decrypt };
770
+ export { API, AuthInterceptor, type AuthInterceptorConfig, AuthService, CryptoService, ErrorResponse, FalconHUBSDK, FilterBuilder, type FilterFieldMetadata, type FilterGroup, type FilterGroupOption, type FilterGroupsModel, type FilterMetadataModel, type FilterModel, type HttpMethodType, type InterceptorContext, type LoginRequest, type LoginResponse, type MethodTypes, type RefreshTokenRequest, type RefreshTokenResponse, type RequestConfig, type RequestInterceptor, type RequestOptions, type ResponseModel, type ServiceProperties, SystemService, type System_Endpoint, type System_EndpointRequest, type System_EndpointsFilter, type System_Module, type System_ModuleRequest, type System_ModulesFilter, type System_UIRoute, type System_UIRouteRequest, type System_UIRoutesFilter, type TokenData, TokenManager, type UserBasicResponse, type UserProfileResponse, UserService, type ValidateSessionRenewedResponse, type ValidateSessionResponse };