@vulog/aima-user 1.2.8 → 1.2.10

package/dist/index.d.mts

@@ -75,6 +75,7 @@ type AccountStatus = (typeof accountStatus)[number];
 type User = {
     fleetId: string;
     id: string;
+    registrationDate: string;
     accountStatus?: AccountStatus;
     locale: string;
     agreements: UserAgreement[];
@@ -89,6 +90,9 @@ type User = {
     profilingConsentUpdateDate: string;
     membershipNumber: string;
 };
+type UserStatus = Exclude<User, 'agreements' | 'profiles'> & {
+    profiles: ProfileServiceRegistration[];
+};
 type UserUpdateBody = Partial<Omit<User, 'id' | 'fleetId' | 'agreements' | 'profiles' | 'surveyConsentUpdateDate' | 'shareDataConsentUpdateDate' | 'profilingConsentUpdateDate'>>;
 declare const personalInformationUserTypes: readonly ["IDENTITY", "USERNAME", "BIRTH", "NATIONALITY", "NOTES", "GENDER", "PERSONAL_COMPANY", "FISCAL", "ADDRESS", "MEMBERSHIP"];
 declare const personalInformationUserPaths: readonly ["/identity/firstName", "/identity/lastName", "/identity/middleName", "/identity/preferredName", "/birth/birthDate", "/birth/countryBirth", "/birth/provinceBirth", "/birth/cityBirth", "/nationality", "/notes", "/gender", "/personalCompany/companyName", "/personalCompany/companyVat", "/personalCompany/companyAddress/streetName", "/personalCompany/companyAddress/city", "/personalCompany/companyAddress/postalCode", "/personalCompany/companyAddress/region", "/personalCompany/companyAddress/country", "/personalCompany/companyAddress/number", "/personalCompany/companyAddress/addressAdditionalInformation", "/fiscalInformation/fiscal", "/fiscalInformation/personalVatNumber", "/fiscalInformation/sdi", "/fiscalInformation/pecAddress", "/fiscalInformation/marketReference", "/address/streetName", "/address/city", "/address/postalCode", "/address/region", "/address/country", "/address/number", "/address/addressAdditionalInformation", "/membership"];
@@ -276,4 +280,22 @@ declare const getFleetBillingGroups: (client: Client, options?: PaginableOptions
 
 declare const getUsersByIds: (client: Client, ids: string[]) => Promise<User[]>;
 
-export { type AccountStatus, type Address, type BillingGroup, type CreateBusinessProfile, type CreateUser, type CreateUserOptions, type Entity, type FiscalInformation, type IndividualBusiness, type Label, type PersonalCompany, type PersonalInformationBirth, type PersonalInformationIdentity, type PersonalInformationProfile, type PersonalInformationProfileType, type PersonalInformationUser, type PersonalInformationUserType, type Profile, type ProfilePaths, type ProfileServiceRegistration, type ProfileStatus, type ProfileType, type ResponseFind, type SearchType, type ServiceRegistrationWithReason, type ServiceStatus, type ServicesRegistrationList, type ServicesUpdate, type User, type UserAgreement, type UserFull, type UserPaths, type UserProfile, type UserServiceRegistration, type UserUpdateBody, acceptTAndC, accountStatus, addLabelForUser, assignBillingGroup, createBusinessProfile, createUser, findUser, getEntity, getFleetBillingGroups, getLabelsForUser, getProfilePersonalInfoById, getRegistrationOverview, getUserById, getUserPersonalInfoById, getUsersByIds, getUsersPIByIds, personalInformationProfileTypeSchema, personalInformationProfileTypes, personalInformationUserPaths, personalInformationUserTypeSchema, personalInformationUserTypes, registerUserToService, removeLabelForUser, setServicesStatus, updateProfilePersonalInfo, updateUser, updateUserPersonalInfo };
+declare const userFiltersSchema: z.ZodObject<{
+    status: z.ZodOptional<z.ZodEnum<["PENDING", "INCOMPLETE", "SUSPENDED", "REJECTED", "APPROVED"]>>;
+    profileType: z.ZodOptional<z.ZodEnum<["Single", "Business"]>>;
+    serviceId: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    status?: "PENDING" | "APPROVED" | "REJECTED" | "SUSPENDED" | "INCOMPLETE" | undefined;
+    serviceId?: string | undefined;
+    profileType?: "Single" | "Business" | undefined;
+}, {
+    status?: "PENDING" | "APPROVED" | "REJECTED" | "SUSPENDED" | "INCOMPLETE" | undefined;
+    serviceId?: string | undefined;
+    profileType?: "Single" | "Business" | undefined;
+}>;
+declare const sortSchema: z.ZodEnum<["registrationDate", "userName", "firstName", "lastName", "updateDate"]>;
+type UserSort = z.infer<typeof sortSchema>;
+type UserFilters = z.infer<typeof userFiltersSchema>;
+declare const getUsers: (client: Client, options?: PaginableOptions<UserFilters, UserSort>) => Promise<PaginableResponse<UserStatus>>;
+
+export { type AccountStatus, type Address, type BillingGroup, type CreateBusinessProfile, type CreateUser, type CreateUserOptions, type Entity, type FiscalInformation, type IndividualBusiness, type Label, type PersonalCompany, type PersonalInformationBirth, type PersonalInformationIdentity, type PersonalInformationProfile, type PersonalInformationProfileType, type PersonalInformationUser, type PersonalInformationUserType, type Profile, type ProfilePaths, type ProfileServiceRegistration, type ProfileStatus, type ProfileType, type ResponseFind, type SearchType, type ServiceRegistrationWithReason, type ServiceStatus, type ServicesRegistrationList, type ServicesUpdate, type User, type UserAgreement, type UserFilters, type UserFull, type UserPaths, type UserProfile, type UserServiceRegistration, type UserSort, type UserStatus, type UserUpdateBody, acceptTAndC, accountStatus, addLabelForUser, assignBillingGroup, createBusinessProfile, createUser, findUser, getEntity, getFleetBillingGroups, getLabelsForUser, getProfilePersonalInfoById, getRegistrationOverview, getUserById, getUserPersonalInfoById, getUsers, getUsersByIds, getUsersPIByIds, personalInformationProfileTypeSchema, personalInformationProfileTypes, personalInformationUserPaths, personalInformationUserTypeSchema, personalInformationUserTypes, registerUserToService, removeLabelForUser, setServicesStatus, updateProfilePersonalInfo, updateUser, updateUserPersonalInfo };

package/dist/index.d.ts

@@ -75,6 +75,7 @@ type AccountStatus = (typeof accountStatus)[number];
 type User = {
     fleetId: string;
     id: string;
+    registrationDate: string;
     accountStatus?: AccountStatus;
     locale: string;
     agreements: UserAgreement[];
@@ -89,6 +90,9 @@ type User = {
     profilingConsentUpdateDate: string;
     membershipNumber: string;
 };
+type UserStatus = Exclude<User, 'agreements' | 'profiles'> & {
+    profiles: ProfileServiceRegistration[];
+};
 type UserUpdateBody = Partial<Omit<User, 'id' | 'fleetId' | 'agreements' | 'profiles' | 'surveyConsentUpdateDate' | 'shareDataConsentUpdateDate' | 'profilingConsentUpdateDate'>>;
 declare const personalInformationUserTypes: readonly ["IDENTITY", "USERNAME", "BIRTH", "NATIONALITY", "NOTES", "GENDER", "PERSONAL_COMPANY", "FISCAL", "ADDRESS", "MEMBERSHIP"];
 declare const personalInformationUserPaths: readonly ["/identity/firstName", "/identity/lastName", "/identity/middleName", "/identity/preferredName", "/birth/birthDate", "/birth/countryBirth", "/birth/provinceBirth", "/birth/cityBirth", "/nationality", "/notes", "/gender", "/personalCompany/companyName", "/personalCompany/companyVat", "/personalCompany/companyAddress/streetName", "/personalCompany/companyAddress/city", "/personalCompany/companyAddress/postalCode", "/personalCompany/companyAddress/region", "/personalCompany/companyAddress/country", "/personalCompany/companyAddress/number", "/personalCompany/companyAddress/addressAdditionalInformation", "/fiscalInformation/fiscal", "/fiscalInformation/personalVatNumber", "/fiscalInformation/sdi", "/fiscalInformation/pecAddress", "/fiscalInformation/marketReference", "/address/streetName", "/address/city", "/address/postalCode", "/address/region", "/address/country", "/address/number", "/address/addressAdditionalInformation", "/membership"];
@@ -276,4 +280,22 @@ declare const getFleetBillingGroups: (client: Client, options?: PaginableOptions
 
 declare const getUsersByIds: (client: Client, ids: string[]) => Promise<User[]>;
 
-export { type AccountStatus, type Address, type BillingGroup, type CreateBusinessProfile, type CreateUser, type CreateUserOptions, type Entity, type FiscalInformation, type IndividualBusiness, type Label, type PersonalCompany, type PersonalInformationBirth, type PersonalInformationIdentity, type PersonalInformationProfile, type PersonalInformationProfileType, type PersonalInformationUser, type PersonalInformationUserType, type Profile, type ProfilePaths, type ProfileServiceRegistration, type ProfileStatus, type ProfileType, type ResponseFind, type SearchType, type ServiceRegistrationWithReason, type ServiceStatus, type ServicesRegistrationList, type ServicesUpdate, type User, type UserAgreement, type UserFull, type UserPaths, type UserProfile, type UserServiceRegistration, type UserUpdateBody, acceptTAndC, accountStatus, addLabelForUser, assignBillingGroup, createBusinessProfile, createUser, findUser, getEntity, getFleetBillingGroups, getLabelsForUser, getProfilePersonalInfoById, getRegistrationOverview, getUserById, getUserPersonalInfoById, getUsersByIds, getUsersPIByIds, personalInformationProfileTypeSchema, personalInformationProfileTypes, personalInformationUserPaths, personalInformationUserTypeSchema, personalInformationUserTypes, registerUserToService, removeLabelForUser, setServicesStatus, updateProfilePersonalInfo, updateUser, updateUserPersonalInfo };
+declare const userFiltersSchema: z.ZodObject<{
+    status: z.ZodOptional<z.ZodEnum<["PENDING", "INCOMPLETE", "SUSPENDED", "REJECTED", "APPROVED"]>>;
+    profileType: z.ZodOptional<z.ZodEnum<["Single", "Business"]>>;
+    serviceId: z.ZodOptional<z.ZodString>;
+}, "strip", z.ZodTypeAny, {
+    status?: "PENDING" | "APPROVED" | "REJECTED" | "SUSPENDED" | "INCOMPLETE" | undefined;
+    serviceId?: string | undefined;
+    profileType?: "Single" | "Business" | undefined;
+}, {
+    status?: "PENDING" | "APPROVED" | "REJECTED" | "SUSPENDED" | "INCOMPLETE" | undefined;
+    serviceId?: string | undefined;
+    profileType?: "Single" | "Business" | undefined;
+}>;
+declare const sortSchema: z.ZodEnum<["registrationDate", "userName", "firstName", "lastName", "updateDate"]>;
+type UserSort = z.infer<typeof sortSchema>;
+type UserFilters = z.infer<typeof userFiltersSchema>;
+declare const getUsers: (client: Client, options?: PaginableOptions<UserFilters, UserSort>) => Promise<PaginableResponse<UserStatus>>;
+
+export { type AccountStatus, type Address, type BillingGroup, type CreateBusinessProfile, type CreateUser, type CreateUserOptions, type Entity, type FiscalInformation, type IndividualBusiness, type Label, type PersonalCompany, type PersonalInformationBirth, type PersonalInformationIdentity, type PersonalInformationProfile, type PersonalInformationProfileType, type PersonalInformationUser, type PersonalInformationUserType, type Profile, type ProfilePaths, type ProfileServiceRegistration, type ProfileStatus, type ProfileType, type ResponseFind, type SearchType, type ServiceRegistrationWithReason, type ServiceStatus, type ServicesRegistrationList, type ServicesUpdate, type User, type UserAgreement, type UserFilters, type UserFull, type UserPaths, type UserProfile, type UserServiceRegistration, type UserSort, type UserStatus, type UserUpdateBody, acceptTAndC, accountStatus, addLabelForUser, assignBillingGroup, createBusinessProfile, createUser, findUser, getEntity, getFleetBillingGroups, getLabelsForUser, getProfilePersonalInfoById, getRegistrationOverview, getUserById, getUserPersonalInfoById, getUsers, getUsersByIds, getUsersPIByIds, personalInformationProfileTypeSchema, personalInformationProfileTypes, personalInformationUserPaths, personalInformationUserTypeSchema, personalInformationUserTypes, registerUserToService, removeLabelForUser, setServicesStatus, updateProfilePersonalInfo, updateUser, updateUserPersonalInfo };

package/dist/index.js

@@ -34,6 +34,7 @@ __export(index_exports, {
   getRegistrationOverview: () => getRegistrationOverview,
   getUserById: () => getUserById,
   getUserPersonalInfoById: () => getUserPersonalInfoById,
+  getUsers: () => getUsers,
   getUsersByIds: () => getUsersByIds,
   getUsersPIByIds: () => getUsersPIByIds,
   personalInformationProfileTypeSchema: () => personalInformationProfileTypeSchema,
@@ -570,6 +571,50 @@ var getUsersByIds = async (client, ids) => {
   }
   return client.post(`/boapi/proxy/user/fleets/${client.clientOptions.fleetId}/users/list`, result.data.ids).then(({ data }) => data);
 };
+
+// src/getUsers.ts
+var import_aima_core2 = require("@vulog/aima-core");
+var import_zod20 = require("zod");
+var statusSchema = import_zod20.z.enum(["PENDING", "INCOMPLETE", "SUSPENDED", "REJECTED", "APPROVED"]);
+var profileTypeSchema = import_zod20.z.enum(["Single", "Business"]);
+var userFiltersSchema = import_zod20.z.object({
+  status: statusSchema.optional(),
+  profileType: profileTypeSchema.optional(),
+  serviceId: import_zod20.z.string().uuid().optional()
+});
+var sortSchema = import_zod20.z.enum(["registrationDate", "userName", "firstName", "lastName", "updateDate"]);
+var getUsers = async (client, options) => {
+  const paginableOptionsSchema = (0, import_aima_core2.createPaginableOptionsSchema)(
+    userFiltersSchema.default({}),
+    sortSchema.optional().default("registrationDate")
+  ).default({});
+  const resultOptions = paginableOptionsSchema.safeParse(options);
+  if (!resultOptions.success) {
+    throw new TypeError("Invalid options", {
+      cause: resultOptions.error.issues
+    });
+  }
+  const finalOptions = resultOptions.data;
+  const searchParams = new URLSearchParams();
+  searchParams.append("page", finalOptions.page.toString());
+  searchParams.append("pageSize", finalOptions.pageSize.toString());
+  searchParams.append("sort", `${finalOptions.sort.toString()},${finalOptions.sortDirection.toString()}`);
+  Object.entries(finalOptions.filters).forEach(([key, value]) => {
+    if (value === void 0) {
+      return;
+    }
+    searchParams.append(key, value);
+  });
+  return client.get(`/boapi/proxy/user/fleets/${client.clientOptions.fleetId}/users?${searchParams.toString()}`).then(({ data, headers }) => {
+    return {
+      data,
+      page: headers.number,
+      pageSize: headers.size,
+      total: headers.totalelements,
+      totalPages: headers.totalpages
+    };
+  });
+};
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   acceptTAndC,
@@ -586,6 +631,7 @@ var getUsersByIds = async (client, ids) => {
   getRegistrationOverview,
   getUserById,
   getUserPersonalInfoById,
+  getUsers,
   getUsersByIds,
   getUsersPIByIds,
   personalInformationProfileTypeSchema,

package/dist/index.mjs

@@ -518,6 +518,50 @@ var getUsersByIds = async (client, ids) => {
   }
   return client.post(`/boapi/proxy/user/fleets/${client.clientOptions.fleetId}/users/list`, result.data.ids).then(({ data }) => data);
 };
+
+// src/getUsers.ts
+import { createPaginableOptionsSchema as createPaginableOptionsSchema2 } from "@vulog/aima-core";
+import { z as z20 } from "zod";
+var statusSchema = z20.enum(["PENDING", "INCOMPLETE", "SUSPENDED", "REJECTED", "APPROVED"]);
+var profileTypeSchema = z20.enum(["Single", "Business"]);
+var userFiltersSchema = z20.object({
+  status: statusSchema.optional(),
+  profileType: profileTypeSchema.optional(),
+  serviceId: z20.string().uuid().optional()
+});
+var sortSchema = z20.enum(["registrationDate", "userName", "firstName", "lastName", "updateDate"]);
+var getUsers = async (client, options) => {
+  const paginableOptionsSchema = createPaginableOptionsSchema2(
+    userFiltersSchema.default({}),
+    sortSchema.optional().default("registrationDate")
+  ).default({});
+  const resultOptions = paginableOptionsSchema.safeParse(options);
+  if (!resultOptions.success) {
+    throw new TypeError("Invalid options", {
+      cause: resultOptions.error.issues
+    });
+  }
+  const finalOptions = resultOptions.data;
+  const searchParams = new URLSearchParams();
+  searchParams.append("page", finalOptions.page.toString());
+  searchParams.append("pageSize", finalOptions.pageSize.toString());
+  searchParams.append("sort", `${finalOptions.sort.toString()},${finalOptions.sortDirection.toString()}`);
+  Object.entries(finalOptions.filters).forEach(([key, value]) => {
+    if (value === void 0) {
+      return;
+    }
+    searchParams.append(key, value);
+  });
+  return client.get(`/boapi/proxy/user/fleets/${client.clientOptions.fleetId}/users?${searchParams.toString()}`).then(({ data, headers }) => {
+    return {
+      data,
+      page: headers.number,
+      pageSize: headers.size,
+      total: headers.totalelements,
+      totalPages: headers.totalpages
+    };
+  });
+};
 export {
   acceptTAndC,
   accountStatus,
@@ -533,6 +577,7 @@ export {
   getRegistrationOverview,
   getUserById,
   getUserPersonalInfoById,
+  getUsers,
   getUsersByIds,
   getUsersPIByIds,
   personalInformationProfileTypeSchema,

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@vulog/aima-user",
-    "version": "1.2.8",
+    "version": "1.2.10",
     "main": "dist/index.js",
     "module": "dist/index.mjs",
     "types": "dist/index.d.ts",
@@ -19,9 +19,9 @@
     "author": "Vulog",
     "license": "MIT",
     "dependencies": {
-        "@vulog/aima-client": "1.2.8",
-        "@vulog/aima-config": "1.2.8",
-        "@vulog/aima-core": "1.2.8"
+        "@vulog/aima-client": "1.2.10",
+        "@vulog/aima-config": "1.2.10",
+        "@vulog/aima-core": "1.2.10"
     },
     "peerDependencies": {
         "zod": "^3.25.76"

package/src/getUsers.ts

@@ -0,0 +1,63 @@
+import { Client } from '@vulog/aima-client';
+import { createPaginableOptionsSchema, PaginableOptions, PaginableResponse } from '@vulog/aima-core';
+import { z } from 'zod';
+
+import { UserStatus } from './types';
+
+// /users?page=0&size=50&sort=registrationDate%2CDESC&status=PENDING&profileType=Single&startDate=&endDate=&service=
+
+const statusSchema = z.enum(['PENDING', 'INCOMPLETE', 'SUSPENDED', 'REJECTED', 'APPROVED']);
+const profileTypeSchema = z.enum(['Single', 'Business']);
+const userFiltersSchema = z.object({
+    status: statusSchema.optional(),
+    profileType: profileTypeSchema.optional(),
+    serviceId: z.string().uuid().optional(),
+});
+
+const sortSchema = z.enum(['registrationDate', 'userName', 'firstName', 'lastName', 'updateDate']);
+export type UserSort = z.infer<typeof sortSchema>;
+
+export type UserFilters = z.infer<typeof userFiltersSchema>;
+
+export const getUsers = async (
+    client: Client,
+    options?: PaginableOptions<UserFilters, UserSort>
+): Promise<PaginableResponse<UserStatus>> => {
+    const paginableOptionsSchema = createPaginableOptionsSchema(
+        userFiltersSchema.default({}),
+        sortSchema.optional().default('registrationDate')
+    ).default({});
+
+    const resultOptions = paginableOptionsSchema.safeParse(options);
+    if (!resultOptions.success) {
+        throw new TypeError('Invalid options', {
+            cause: resultOptions.error.issues,
+        });
+    }
+
+    const finalOptions = resultOptions.data;
+
+    const searchParams = new URLSearchParams();
+    searchParams.append('page', finalOptions.page!.toString());
+    searchParams.append('pageSize', finalOptions.pageSize!.toString());
+    searchParams.append('sort', `${finalOptions.sort!.toString()},${finalOptions.sortDirection!.toString()}`);
+
+    Object.entries(finalOptions.filters!).forEach(([key, value]) => {
+        if (value === undefined) {
+            return;
+        }
+        searchParams.append(key, value as string);
+    });
+
+    return client
+        .get<UserStatus[]>(`/boapi/proxy/user/fleets/${client.clientOptions.fleetId}/users?${searchParams.toString()}`)
+        .then(({ data, headers }) => {
+            return {
+                data,
+                page: headers.number,
+                pageSize: headers.size,
+                total: headers.totalelements,
+                totalPages: headers.totalpages,
+            };
+        });
+};

package/src/index.ts

@@ -18,3 +18,4 @@ export * from './updateUserPersonalInfo';
 export * from './getEntity';
 export * from './getFleetBillingGroups';
 export * from './getUsersByIds';
+export * from './getUsers';

package/src/types.ts

@@ -87,6 +87,7 @@ export type AccountStatus = (typeof accountStatus)[number];
 export type User = {
     fleetId: string;
     id: string;
+    registrationDate: string;
     accountStatus?: AccountStatus;
     locale: string;
     agreements: UserAgreement[];
@@ -102,6 +103,10 @@ export type User = {
     membershipNumber: string;
 };
 
+export type UserStatus = Exclude<User, 'agreements' | 'profiles'> & {
+    profiles: ProfileServiceRegistration[];
+};
+
 export type UserUpdateBody = Partial<
     Omit<
         User,