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

package/src/metarisc.ts

@@ -1,63 +1,76 @@
-import axios, { AxiosInstance, AxiosResponse } from "axios";
+import { Core, MetariscConfig } from "./core";
+import { Tus } from "./tus";
+import { Client } from "./client";
 
-interface RequestConfig {
-    body ?: any,
-    headers ?: {[name: string]: string | string[]},
-    params ?: {[param: string]: string | string[]},
-    endpoint ?: string,
-    method ?: string
-}
+import { DossiersAPI } from './api/DossiersAPI';
 
-export class Metarisc
-{
-    private axios : AxiosInstance;
+import { EvenementsAPI } from './api/EvenementsAPI';
 
-    constructor()
-    {
-        this.axios = axios.create({
-            baseURL: 'https://api.metarisc.fr/'
-        });
-    }
+import { NotificationsAPI } from './api/NotificationsAPI';
 
-    async request<T>(config : RequestConfig) : Promise<AxiosResponse<T>>
-    {
-        return this.axios.request<T>({
-            method: config.method || 'GET',
-            url: config.endpoint || '/',
-            params: config.params,
-            data: config.body,
-            headers: config.headers
-        });
-    }
+import { OrganisationsAPI } from './api/OrganisationsAPI';
 
-    async * autoPagingIterator<T>(config : RequestConfig) : AsyncGenerator<T, void, unknown>
-    {
-        let current_page : number = config.params && 'page' in config.params ? parseInt(config.params['page'].toString()) : 1;
-        const per_page : number = config.params && 'per_page' in  config.params ? parseInt(config.params['per_page'].toString()) : 25;
-
-        while (true) {
-            const response = <AxiosResponse<{
-                data?: Array<T>;
-                meta?: {
-                    pagination?: {
-                        total?: number;
-                        count?: number;
-                        per_page?: number;
-                        current_page?: number;
-                        total_pages?: number;
-                      };
-                };
-                }>> await this.request({...config, ...{params: {page: current_page.toString(), per_page: per_page.toString()}}});
-
-            for (const element of response.data.data) {
-                yield element;
-            }
+import { PEIAPI } from './api/PEIAPI';
 
-            if (response.data.meta.pagination.current_page === response.data.meta.pagination.total_pages) {
-                break;
-            }
+import { PingAPI } from './api/PingAPI';
 
-            current_page++;
-        }
+import { UtilisateursAPI } from './api/UtilisateursAPI';
+
+export class Metarisc extends Core
+{
+    
+    public utilisateurs?: UtilisateursAPI;
+    
+    public dossiers?: DossiersAPI;
+    
+    public organisations?: OrganisationsAPI;
+    
+    public pei?: PEIAPI;
+    
+    public ping?: PingAPI;
+    
+    public evenements?: EvenementsAPI;
+    
+    public notifications?: NotificationsAPI;
+    
+    public tus?: Tus;
+
+    constructor(config: MetariscConfig, client?: Client) {
+        super(config, client);
+
+        const tmpClient = this.client;
+
+        return new Proxy(this, {
+            get: function(metarisc, name, receiver) {
+                switch(name) {
+                    
+                    case 'utilisateurs':
+                        return new UtilisateursAPI(config, tmpClient);
+                    
+                    case 'dossiers':
+                        return new DossiersAPI(config, tmpClient);
+                    
+                    case 'organisations':
+                        return new OrganisationsAPI(config, tmpClient);
+                    
+                    case 'pei':
+                        return new PEIAPI(config, tmpClient);
+                    
+                    case 'ping':
+                        return new PingAPI(config, tmpClient);
+                    
+                    case 'evenements':
+                        return new EvenementsAPI(config, tmpClient);
+                    
+                    case 'notifications':
+                        return new NotificationsAPI(config, tmpClient);
+                    
+                    case 'tus':
+                        return new Tus(config, tmpClient);
+                    default:
+                        return Reflect.get(metarisc, name, receiver);
+                }
+            }
+        });
     }
 }

package/src/model/AdressePostale.ts

@@ -0,0 +1,10 @@
+/**
+* Représente une adresse postale permettant de localiser un POI.
+*/
+export type AdressePostale = {
+    'code_postal'?: string;
+    'commune'?: string;
+    'voie'?: string;
+    'code_insee'?: string;
+    'arrondissement'?: string;
+};

package/src/model/AnomalieDECI.ts

@@ -0,0 +1,11 @@
+export type AnomalieDECI = {
+    'code'?: string;
+    'texte'?: string;
+    'indice_de_gravite'?: IndiceDeGraviteEnum;
+};
+
+export enum IndiceDeGraviteEnum {
+    NUMBER_0 = 0,
+    NUMBER_1 = 1,
+    NUMBER_2 = 2
+}

package/src/model/Contact.ts

@@ -0,0 +1,13 @@
+export type Contact = {
+    'id'?: string;
+    'nom'?: string;
+    'prenom'?: string;
+    'fonction'?: string;
+    'telephone'?: string;
+    'adresse'?: string;
+    'site_web_url'?: string;
+    'civilite'?: string;
+    'societe'?: string;
+    'email'?: string;
+    'observations'?: string;
+};

package/src/model/DescriptifTechnique.ts

@@ -0,0 +1,46 @@
+import { DescriptifTechniquePENA } from '../../src/model/DescriptifTechniquePENA';
+import { DescriptifTechniquePIBI } from '../../src/model/DescriptifTechniquePIBI';
+
+export type DescriptifTechnique = DescriptifTechniquePIBI | DescriptifTechniquePENA;
+
+export enum DomanialiteEnum {
+    Privee = 'privee',
+    Publique = 'publique',
+    PriveeConventionnee = 'privee_conventionnee'
+}
+
+export enum NatureEnum {
+    PointAspiration = 'POINT_ASPIRATION',
+    CiterneAerienne = 'CITERNE_AERIENNE',
+    CiterneEnterree = 'CITERNE_ENTERREE',
+    CiterneSemiEnterree = 'CITERNE_SEMI_ENTERREE',
+    CiterneSouple = 'CITERNE_SOUPLE',
+    ReserveAerienne = 'RESERVE_AERIENNE',
+    PoteauRelais = 'POTEAU_RELAIS',
+    PuisardAspiration = 'PUISARD_ASPIRATION',
+    PriseDeportee = 'PRISE_DEPORTEE',
+    PoteauAspiration1x100 = 'POTEAU_ASPIRATION_1x100',
+    PoteauAspiration2x100 = 'POTEAU_ASPIRATION_2x100',
+    BoucheAspiration1x100 = 'BOUCHE_ASPIRATION_1x100'
+}
+
+export enum CaracteristiquesParticulieresEnum {
+    Renversable = 'RENVERSABLE',
+    PreMelange = 'PRE_MELANGE'
+}
+
+export enum EssaisEnginUtiliseEnum {
+    Aucun = 'AUCUN',
+    Fpt = 'FPT',
+    Mpr = 'MPR',
+    Ccf = 'CCF'
+}
+
+export enum EquipementsEnum {
+    Guichet = 'GUICHET',
+    CanneAspiration = 'CANNE_ASPIRATION',
+    Puit = 'PUIT',
+    TrouHomme = 'TROU_HOMME',
+    RaccordTournant = 'RACCORD_TOURNANT',
+    PriseDirecte = 'PRISE_DIRECTE'
+}

package/src/model/DescriptifTechniqueBase.ts

@@ -0,0 +1,5 @@
+export type DescriptifTechniqueBase = {
+    'libelle'?: string;
+    'observations_generales'?: string;
+    'date'?: Date;
+};

package/src/model/DescriptifTechniqueDECIBase.ts

@@ -0,0 +1,19 @@
+import { AnomalieDECI } from '../../src/model/AnomalieDECI';
+
+import { DescriptifTechniqueBase } from '../model/DescriptifTechniqueBase';
+
+export type DescriptifTechniqueDECIBase = DescriptifTechniqueBase & { 
+    'anomalies'?: Array<AnomalieDECI>;
+    'est_reglementaire'?: boolean;
+    'est_reforme'?: boolean;
+    'domanialite'?: DomanialiteEnum;
+    'est_conforme'?: boolean;
+    'performance_theorique'?: number;
+    'performance_reelle'?: number;
+};
+
+export enum DomanialiteEnum {
+    Privee = 'privee',
+    Publique = 'publique',
+    PriveeConventionnee = 'privee_conventionnee'
+}

package/src/model/DescriptifTechniquePENA.ts

@@ -0,0 +1,49 @@
+import { DescriptifTechniquePENAAllOfRealimentation } from '../../src/model/DescriptifTechniquePENAAllOfRealimentation';
+import { DescriptifTechniquePENAAllOfVolumes } from '../../src/model/DescriptifTechniquePENAAllOfVolumes';
+
+import { DescriptifTechniqueDECIBase } from '../model/DescriptifTechniqueDECIBase';
+
+export type DescriptifTechniquePENA = DescriptifTechniqueDECIBase & { 
+    'essais_engin_utilise'?: EssaisEnginUtiliseEnum;
+    'equipements'?: EquipementsEnum;
+    'nature'?: NatureEnum;
+    'volumes'?: DescriptifTechniquePENAAllOfVolumes;
+    'realimentation'?: Array<DescriptifTechniquePENAAllOfRealimentation>;
+};
+
+export enum DomanialiteEnum {
+    Privee = 'privee',
+    Publique = 'publique',
+    PriveeConventionnee = 'privee_conventionnee'
+}
+
+export enum EssaisEnginUtiliseEnum {
+    Aucun = 'AUCUN',
+    Fpt = 'FPT',
+    Mpr = 'MPR',
+    Ccf = 'CCF'
+}
+
+export enum EquipementsEnum {
+    Guichet = 'GUICHET',
+    CanneAspiration = 'CANNE_ASPIRATION',
+    Puit = 'PUIT',
+    TrouHomme = 'TROU_HOMME',
+    RaccordTournant = 'RACCORD_TOURNANT',
+    PriseDirecte = 'PRISE_DIRECTE'
+}
+
+export enum NatureEnum {
+    PointAspiration = 'POINT_ASPIRATION',
+    CiterneAerienne = 'CITERNE_AERIENNE',
+    CiterneEnterree = 'CITERNE_ENTERREE',
+    CiterneSemiEnterree = 'CITERNE_SEMI_ENTERREE',
+    CiterneSouple = 'CITERNE_SOUPLE',
+    ReserveAerienne = 'RESERVE_AERIENNE',
+    PoteauRelais = 'POTEAU_RELAIS',
+    PuisardAspiration = 'PUISARD_ASPIRATION',
+    PriseDeportee = 'PRISE_DEPORTEE',
+    PoteauAspiration1x100 = 'POTEAU_ASPIRATION_1x100',
+    PoteauAspiration2x100 = 'POTEAU_ASPIRATION_2x100',
+    BoucheAspiration1x100 = 'BOUCHE_ASPIRATION_1x100'
+}

package/src/model/DescriptifTechniquePENAAllOfRealimentation.ts

@@ -0,0 +1,11 @@
+export type DescriptifTechniquePENAAllOfRealimentation = {
+    'debit'?: number;
+    'diametre_canalisation'?: number;
+    'nature'?: NatureEnum;
+};
+
+export enum NatureEnum {
+    AdductionEau = 'ADDUCTION_EAU',
+    Toiture = 'TOITURE',
+    Autre = 'AUTRE'
+}

package/src/model/DescriptifTechniquePENAAllOfVolumes.ts

@@ -0,0 +1,4 @@
+export type DescriptifTechniquePENAAllOfVolumes = {
+    'reel'?: number;
+    'theorique'?: number;
+};

package/src/model/DescriptifTechniquePIBI.ts

@@ -0,0 +1,36 @@
+import { DescriptifTechniquePIBIAllOfPesees } from '../../src/model/DescriptifTechniquePIBIAllOfPesees';
+
+import { DescriptifTechniqueDECIBase } from '../model/DescriptifTechniqueDECIBase';
+
+export type DescriptifTechniquePIBI = DescriptifTechniqueDECIBase & { 
+    'numero_serie_appareil'?: string;
+    /**
+    * Surpression mesurée en bar
+    */
+    'surpression'?: number;
+    'nature'?: NatureEnum;
+    'caracteristiques_particulieres'?: CaracteristiquesParticulieresEnum;
+    'pesees'?: DescriptifTechniquePIBIAllOfPesees;
+};
+
+export enum DomanialiteEnum {
+    Privee = 'privee',
+    Publique = 'publique',
+    PriveeConventionnee = 'privee_conventionnee'
+}
+
+export enum NatureEnum {
+    Pi1x65 = 'PI1x65',
+    Pi1x65Pi2x45 = 'PI1x65+PI2x45',
+    Pi1x100 = 'PI1x100',
+    Pi2x100 = 'PI2x100',
+    Bi1x65 = 'BI1x65',
+    Bi1x80 = 'BI1x80',
+    Bi1x100 = 'BI1x100',
+    Bi2x100 = 'BI2x100'
+}
+
+export enum CaracteristiquesParticulieresEnum {
+    Renversable = 'RENVERSABLE',
+    PreMelange = 'PRE_MELANGE'
+}

package/src/model/DescriptifTechniquePIBIAllOfPesees.ts

@@ -0,0 +1,6 @@
+export type DescriptifTechniquePIBIAllOfPesees = {
+    'debit_1bar'?: number;
+    'pression_debit_requis'?: number;
+    'pression_statique'?: number;
+    'debit_gueule_bee'?: number;
+};

package/src/model/Document.ts

@@ -0,0 +1,3 @@
+export type Document = {
+    'id'?: string;
+};

package/src/model/Dossier.ts

@@ -0,0 +1,19 @@
+import { Type } from '../../src/model/Type';
+
+/**
+* Un dossier représente la vie d\'un POI
+*/
+export type Dossier = {
+    'id'?: string;
+    'type'?: Type;
+    'description'?: string;
+    'date_de_creation'?: Date;
+    'createur'?: string;
+    'application_utilisee'?: string;
+    'statut'?: StatutEnum;
+};
+
+export enum StatutEnum {
+    Ouvert = 'OUVERT',
+    Clos = 'CLOS'
+}

package/src/model/Email.ts

@@ -0,0 +1,6 @@
+export type Email = {
+    'email'?: string;
+    'is_primary'?: boolean;
+    'is_publicly_visible'?: boolean;
+    'is_verified'?: boolean;
+};

package/src/model/Evenement.ts

@@ -0,0 +1,15 @@
+export type Evenement = {
+    'id'?: string;
+    'title'?: string;
+    'type'?: TypeEnum;
+    'description'?: string;
+    'date_debut'?: Date;
+    'date_fin'?: Date;
+};
+
+export enum TypeEnum {
+    Defaut = 'DEFAUT',
+    ReconnaissanceOperationnelleAnnuelle = 'RECONNAISSANCE_OPERATIONNELLE_ANNUELLE',
+    VisitePeriodique = 'VISITE_PERIODIQUE',
+    CommissionSecurite = 'COMMISSION_SECURITE'
+}

package/src/model/Feature.ts

@@ -0,0 +1,7 @@
+import { FeatureGeometry } from '../../src/model/FeatureGeometry';
+
+export type Feature = {
+    'type'?: string;
+    'properties'?: any;
+    'geometry'?: FeatureGeometry;
+};

package/src/model/FeatureGeometry.ts

@@ -0,0 +1,5 @@
+export type FeatureGeometry = {
+    'type'?: string;
+    'bbox'?: Array<number>;
+    'coordinates'?: Array<number>;
+};

package/src/model/GetEvenement404Response.ts

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

package/src/model/GetEvenementDetails404Response.ts

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

package/src/model/GetFeature200Response.ts

@@ -0,0 +1,8 @@
+import { Feature } from '../../src/model/Feature';
+import { GetFeature200ResponseCrs } from '../../src/model/GetFeature200ResponseCrs';
+
+export type GetFeature200Response = {
+    'type'?: string;
+    'crs'?: GetFeature200ResponseCrs;
+    'features'?: Array<Feature>;
+};

package/src/model/GetFeature200ResponseCrs.ts

@@ -0,0 +1,6 @@
+import { GetFeature200ResponseCrsProperties } from '../../src/model/GetFeature200ResponseCrsProperties';
+
+export type GetFeature200ResponseCrs = {
+    'type'?: string;
+    'properties'?: GetFeature200ResponseCrsProperties;
+};

package/src/model/GetFeature200ResponseCrsProperties.ts

@@ -0,0 +1,3 @@
+export type GetFeature200ResponseCrsProperties = {
+    'name'?: string;
+};

package/src/model/GetNotification404Response.ts

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

package/src/model/Notification.ts

@@ -0,0 +1,12 @@
+/**
+* Une notification est un objet créé pour avertir ou informer un utilisateur pour un évévemenent spécifique.
+*/
+export type Notification = {
+    'id'?: string;
+    'title': string;
+    'message': string;
+    'contexte': any;
+    'date_creation': Date;
+    'date_de_lecture'?: Date;
+    'utilisateur_id'?: string;
+};

package/src/model/Organisation.ts

@@ -0,0 +1,10 @@
+export type Organisation = {
+    'id'?: string;
+    'nom'?: string;
+    'logo_url'?: string;
+    'type'?: TypeEnum;
+};
+
+export enum TypeEnum {
+    Sis = 'sis'
+}

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;
+};

package/src/model/POI.ts

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

package/src/model/POIReferencesExterieuresInner.ts

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

package/src/model/PatchPoiRequest.ts

@@ -0,0 +1,3 @@
+export type PatchPoiRequest = {
+    'test'?: string;
+};

package/src/model/PieceJointe.ts

@@ -0,0 +1,7 @@
+export type PieceJointe = {
+    'id'?: string;
+    'url'?: string;
+    'nom'?: string;
+    'description'?: string;
+    'type'?: string;
+};

package/src/model/Ping200Response.ts

@@ -0,0 +1,3 @@
+export type Ping200Response = {
+    'message'?: string;
+};

package/src/model/PostDossierRequest.ts

@@ -0,0 +1,5 @@
+export type PostDossierRequest = {
+    'titre'?: string;
+    'description'?: string;
+    'workflows'?: string;
+};

package/src/model/PostEvenementRequest.ts

@@ -0,0 +1,7 @@
+export type PostEvenementRequest = {
+    'title'?: string;
+    'type'?: string;
+    'description'?: string;
+    'date_debut'?: Date;
+    'date_fin'?: Date;
+};

package/src/model/PostNotification400Response.ts

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

package/src/model/PostNotification500Response.ts

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

package/src/model/PostNotificationRequest.ts

@@ -0,0 +1,9 @@
+export type PostNotificationRequest = {
+    'title': string;
+    'message': string;
+    'contexte'?: any;
+    /**
+    * L\'utilisateur que l\'on souhaite notifier
+    */
+    'utilisateur_id': string;
+};

package/src/model/PostTicketRequest.ts

@@ -0,0 +1,10 @@
+export type PostTicketRequest = {
+    /**
+    * L\'intitulé général du ticket
+    */
+    'subject'?: string;
+    /**
+    * La description du ticket prend aussi en charge le contenu HTML
+    */
+    'description'?: string;
+};

package/src/model/SuiviAdministratif.ts

@@ -0,0 +1,6 @@
+export type SuiviAdministratif = {
+    'description'?: string;
+    'date_ajout'?: Date;
+    'evenement_automatique'?: boolean;
+    'createur'?: string;
+};

package/src/model/Tag.ts

@@ -0,0 +1,3 @@
+export type Tag = {
+    'message'?: string;
+};

package/src/model/Ticket.ts

@@ -0,0 +1,18 @@
+export type Ticket = {
+    'id': number;
+    'subject': string;
+    'description': string;
+    'description_html'?: string;
+    'status': StatusEnum;
+    'created_at'?: Date;
+    'updated_at'?: Date;
+};
+
+export enum StatusEnum {
+    New = 'new',
+    Open = 'open',
+    Pending = 'pending',
+    Hold = 'hold',
+    Solved = 'solved',
+    Closed = 'closed'
+}

package/src/model/Type.ts

@@ -0,0 +1,5 @@
+export type Type = {
+    'id'?: string;
+    'titre'?: string;
+    'categorie'?: string;
+};