@metarisc/metarisc-js 0.0.1-alpha.20 → 0.0.1-alpha.21

package/src/api/PEIAPI.ts

@@ -0,0 +1,103 @@
+import { Core, MetariscConfig } from "../core";
+import Utils from "../utils";
+import type { AxiosResponse } from "axios";
+import { Client } from "../client";
+import { Collection } from "../collection";
+import { PEI } from '../model/PEI';
+import { Contact } from '../model/Contact';
+import { DescriptifTechnique } from '../model/DescriptifTechnique';
+import { PieceJointe } from '../model/PieceJointe';
+
+export class PEIAPI extends Core {
+    constructor(config: MetariscConfig, client?: Client) {
+        super(config, client);
+    }
+    
+    /**
+     * Récupération de l'ensemble des données d'un PEI.
+     * @param peiId Identifiant unique du PEI
+     */
+    async getPei(peiId: string): Promise<AxiosResponse<PEI>>
+    {
+        const pathVariable = { 'pei_id': peiId };
+        return this.request({
+            method: 'GET',
+            endpoint: Utils.constructPath(pathVariable, '/pei/{pei_id}'),
+            headers: {  },
+            params: {  },
+            body: {}
+        });
+    }
+    
+    /**
+     * Récupération de la liste des Points d'Eau Incendie (PEI) selon des critères de recherche.
+     * @param page Numéro de page
+     * @param perPage Nombre de résultats demandé
+     */
+    paginatePei(page?: number, perPage?: number): Collection<PEI>
+    {
+        const pathVariable = {  };
+        return this.collect<PEI>({
+            method: 'GET',
+            endpoint: Utils.constructPath(pathVariable, '/pei'),
+            headers: {  },
+            params: { 'page': page?.toString(), 'per_page': perPage?.toString() },
+            body: {}
+        });
+    }
+    
+    /**
+     * Récupération de la liste des contacts d'un Point d'Eau Incendie.
+     * @param peiId Identifiant unique du PEI
+     * @param page Numéro de page
+     * @param perPage Nombre de résultats demandé
+     */
+    paginatePeiContacts(peiId: string, page?: number, perPage?: number): Collection<Contact>
+    {
+        const pathVariable = { 'pei_id': peiId };
+        return this.collect<Contact>({
+            method: 'GET',
+            endpoint: Utils.constructPath(pathVariable, '/pei/{pei_id}/contacts'),
+            headers: {  },
+            params: { 'page': page?.toString(), 'per_page': perPage?.toString() },
+            body: {}
+        });
+    }
+    
+    /**
+     * Récupération de l'historique d'un POI.
+     * @param peiId Identifiant unique du PEI
+     * @param page Numéro de page
+     * @param perPage Nombre de résultats demandé
+     */
+    paginatePeiHistorique(peiId: string, page?: number, perPage?: number): Collection<DescriptifTechnique>
+    {
+        const pathVariable = { 'pei_id': peiId };
+        return this.collect<DescriptifTechnique>({
+            method: 'GET',
+            endpoint: Utils.constructPath(pathVariable, '/pei/{pei_id}/historique'),
+            headers: {  },
+            params: { 'page': page?.toString(), 'per_page': perPage?.toString() },
+            body: {}
+        });
+    }
+    
+    /**
+     * Récupération de la liste des pièces jointes d'un Point d'Eau Incendie.
+     * @param peiId Identifiant unique du PEI
+     * @param page Numéro de page
+     * @param perPage Nombre de résultats demandé
+     */
+    paginatePeiPiecesJointes(peiId: string, page?: number, perPage?: number): Collection<PieceJointe>
+    {
+        const pathVariable = { 'pei_id': peiId };
+        return this.collect<PieceJointe>({
+            method: 'GET',
+            endpoint: Utils.constructPath(pathVariable, '/pei/{pei_id}/pieces_jointes'),
+            headers: {  },
+            params: { 'page': page?.toString(), 'per_page': perPage?.toString() },
+            body: {}
+        });
+    }
+    
+}

package/src/api/UtilisateursAPI.ts

@@ -4,7 +4,6 @@ import type { AxiosResponse } from "axios";
 import { Client } from "../client";
 import { Collection } from "../collection";
 import { Utilisateur } from '../model/Utilisateur';
-
 import { Email } from '../model/Email';
 
 export class UtilisateursAPI extends Core {
@@ -16,21 +15,6 @@ export class UtilisateursAPI extends Core {
      * L'utilisateur connecté retourné par ce point de terminaison utilise le token d'accès généré par le service OpenID Connect afin de le lier à une identité connue de Metarisc. Si l'utilisateur est inconnu une erreur est retournée.
      */
     async getUtilisateursMoi(): Promise<AxiosResponse<Utilisateur>>
-    {
-        const pathVariable = {  };
-        return this.request({
-            method: 'GET',
-            endpoint: Utils.constructPath(pathVariable, '/@moi'),
-            headers: {  },
-            params: {  },
-            body: {}
-        });
-    }
-    
-    /**
-     * L'utilisateur connecté retourné par ce point de terminaison utilise le token d'accès généré par le service OpenID Connect afin de le lier à une identité connue de Metarisc. Si l'utilisateur est inconnu une erreur est retournée.
-     */
-    async getUtilisateursMoi1(): Promise<AxiosResponse<Utilisateur>>
     {
         const pathVariable = {  };
         return this.request({
@@ -48,30 +32,13 @@ export class UtilisateursAPI extends Core {
      * @param perPage Nombre de résultats demandé
      */
     paginateMoiEmails(page?: number, perPage?: number): Collection<Email>
-    {
-        const pathVariable = {  };
-        return this.collect<Email>({
-            method: 'GET',
-            endpoint: Utils.constructPath(pathVariable, '/@moi/emails'),
-            headers: {  },
-            params: { 'page': page.toString(), 'per_page': perPage.toString() },
-            body: {}
-        });
-    }
-    
-    /**
-     * Liste toutes les adresses mail de l'utilisateur connecté, y compris les adresses non publiquement accessibles.
-     * @param page Numéro de page
-     * @param perPage Nombre de résultats demandé
-     */
-    paginateMoiEmails1(page?: number, perPage?: number): Collection<Email>
     {
         const pathVariable = {  };
         return this.collect<Email>({
             method: 'GET',
             endpoint: Utils.constructPath(pathVariable, '/utilisateurs/@moi/emails'),
             headers: {  },
-            params: { 'page': page.toString(), 'per_page': perPage.toString() },
+            params: { 'page': page?.toString(), 'per_page': perPage?.toString() },
             body: {}
         });
     }

package/src/index.ts

@@ -2,7 +2,7 @@ export { Metarisc } from "./metarisc";
 export { OAuth2 } from "./auth/oauth2";
 export { Core } from "./core";
 export { Collection } from "./collection";
-export { PaginationResults, PaginationData } from "./collection"
+export { PaginationResults } from "./collection"
 export { AuthMethod } from "./client";
 export { Client } from "./client";
 export { Tus } from "./tus";
@@ -13,12 +13,10 @@ export { EvenementsAPI } from './api/EvenementsAPI';
 
 export { NotificationsAPI } from './api/NotificationsAPI';
 
-export { OrganisationAPI } from './api/OrganisationAPI';
+export { OrganisationsAPI } from './api/OrganisationsAPI';
 
-export { POIAPI } from './api/POIAPI';
+export { PEIAPI } from './api/PEIAPI';
 
 export { PingAPI } from './api/PingAPI';
 
-export { SupportAPI } from './api/SupportAPI';
-
 export { UtilisateursAPI } from './api/UtilisateursAPI';

package/src/metarisc.ts

@@ -8,34 +8,30 @@ import { EvenementsAPI } from './api/EvenementsAPI';
 
 import { NotificationsAPI } from './api/NotificationsAPI';
 
-import { OrganisationAPI } from './api/OrganisationAPI';
+import { OrganisationsAPI } from './api/OrganisationsAPI';
 
-import { POIAPI } from './api/POIAPI';
+import { PEIAPI } from './api/PEIAPI';
 
 import { PingAPI } from './api/PingAPI';
 
-import { SupportAPI } from './api/SupportAPI';
-
 import { UtilisateursAPI } from './api/UtilisateursAPI';
 
 export class Metarisc extends Core
 {
     
-    public dossiers?: DossiersAPI;
-    
-    public evenements?: EvenementsAPI;
+    public utilisateurs?: UtilisateursAPI;
     
-    public notifications?: NotificationsAPI;
+    public dossiers?: DossiersAPI;
     
-    public organisations?: OrganisationAPI;
+    public organisations?: OrganisationsAPI;
     
-    public poi?: POIAPI;
+    public pei?: PEIAPI;
     
     public ping?: PingAPI;
     
-    public support?: SupportAPI;
+    public evenements?: EvenementsAPI;
     
-    public utilisateurs?: UtilisateursAPI;
+    public notifications?: NotificationsAPI;
     
     public tus?: Tus;
 
@@ -48,29 +44,26 @@ export class Metarisc extends Core
             get: function(metarisc, name, receiver) {
                 switch(name) {
                     
+                    case 'utilisateurs':
+                        return new UtilisateursAPI(config, tmpClient);
+                    
                     case 'dossiers':
                         return new DossiersAPI(config, tmpClient);
                     
-                    case 'evenements':
-                        return new EvenementsAPI(config, tmpClient);
-                    
-                    case 'notifications':
-                        return new NotificationsAPI(config, tmpClient);
-                    
                     case 'organisations':
-                        return new OrganisationAPI(config, tmpClient);
+                        return new OrganisationsAPI(config, tmpClient);
                     
-                    case 'poi':
-                        return new POIAPI(config, tmpClient);
+                    case 'pei':
+                        return new PEIAPI(config, tmpClient);
                     
                     case 'ping':
                         return new PingAPI(config, tmpClient);
                     
-                    case 'support':
-                        return new SupportAPI(config, tmpClient);
+                    case 'evenements':
+                        return new EvenementsAPI(config, tmpClient);
                     
-                    case 'utilisateurs':
-                        return new UtilisateursAPI(config, tmpClient);
+                    case 'notifications':
+                        return new NotificationsAPI(config, tmpClient);
                     
                     case 'tus':
                         return new Tus(config, tmpClient);

package/src/model/GetEvenementDetails404Response.ts

@@ -0,0 +1,6 @@
+export type GetEvenementDetails404Response = {
+    'status_code'?: number;
+    'type'?: string;
+    'title'?: string;
+    'detail'?: string;
+};

package/src/model/PEI.ts

@@ -0,0 +1,14 @@
+import { AdressePostale } from '../../src/model/AdressePostale';
+import { DescriptifTechnique } from '../../src/model/DescriptifTechnique';
+import { PEIReferencesExterieuresInner } from '../../src/model/PEIReferencesExterieuresInner';
+
+export type PEI = {
+    'id'?: string;
+    'date_de_realisation'?: Date;
+    'date_de_derniere_mise_a_jour'?: Date;
+    'statut'?: string;
+    'references_exterieures'?: Array<PEIReferencesExterieuresInner>;
+    'descriptif_technique'?: DescriptifTechnique;
+    'geometrie'?: string;
+    'adresse_postale'?: AdressePostale;
+};

package/src/model/PEIReferencesExterieuresInner.ts

@@ -0,0 +1,4 @@
+export type PEIReferencesExterieuresInner = {
+    'titre'?: string;
+    'valeur'?: string;
+};