@metarisc/metarisc-js 0.0.1-alpha.5 → 0.0.1-alpha.7

package/.eslintrc

@@ -8,5 +8,8 @@
         "eslint:recommended",
         "plugin:@typescript-eslint/eslint-recommended",
         "plugin:@typescript-eslint/recommended"
-    ]
+    ],
+    "rules": {
+        "no-multiple-empty-lines": [1, { "max": 1, "maxEOF": 0, "maxBOF": 0 }]
+    }
 }

package/.github/workflows/main.yml

@@ -22,7 +22,7 @@ jobs:
       
       - run: npm run compile
 
-      - run: npm run lint
+      - run: npx eslint . --ext .ts
       
       - run: npm publish --access=public
         env:

package/README.md

@@ -1,3 +1,32 @@
+
 # Metarisc JS
 
 La librairie Metarisc JS offre un accès simple et pratique à l'API Metarisc à partir d'applications écrites en langage JS. Elle comprend un ensemble de classes et de fonctions pour l'ensemble des ressources de l'API.
+
+## NPM
+
+Vous pouvez installer la librairie en utilisant [NPM](https://www.npmjs.com). Exécutez la commande suivante dans votre projet :
+
+```bash
+npm i @metarisc/metarisc-js
+```
+
+Pour utiliser la librairie, il suffit de l'importer comme ceci :
+
+```php
+import { Metarisc } from '@metarisc/metarisc-js';';
+```
+
+## Utilisation
+
+### Requêtes
+
+Pour effectuer une requête sur Metarisc, qu'elle soit simple ou paginés (voir la [documentation](http://metarisc.fr/docs/api/#/#pagination)), faites de cette manière :
+
+Exemple :
+
+```ts
+const m = new Metarisc(config);
+m.NotificationsAPI.getNotification('123456');
+m.NotificationsAPI.paginateNotifications();
+```

package/lib/api/DossiersAPI.d.ts

@@ -0,0 +1,63 @@
+import { Core, MetariscConfig } from "../core";
+import type { AxiosResponse } from "axios";
+import { Dossier } from "../../src/model/Dossier";
+import { PaginateDossiers200Response } from "../../src/model/PaginateDossiers200Response";
+import { PaginateSuiviAdministratif200Response } from "../../src/model/PaginateSuiviAdministratif200Response";
+import { PaginateTags200Response } from "../../src/model/PaginateTags200Response";
+import { PaginateWorkflowDocuments200Response } from "../../src/model/PaginateWorkflowDocuments200Response";
+import { PaginateWorkflows200Response } from "../../src/model/PaginateWorkflows200Response";
+import { PostDossierRequest } from "../../src/model/PostDossierRequest";
+export declare class DossiersAPI extends Core {
+    constructor(config: MetariscConfig);
+    /**
+     * Récupération de l'ensemble des données d'un dossier.
+     * @param dossierId ID du dossier
+     */
+    getDossier(dossierId: string): Promise<AxiosResponse<Dossier>>;
+    /**
+     * Récupération de la liste des dossiers selon des critères de recherche.
+     * @param page Numéro de page
+     * @param perPage Nombre de résultats demandé
+     */
+    paginateDossiers(page?: number, perPage?: number): AsyncGenerator<PaginateDossiers200Response>;
+    /**
+     * Récupération de la liste du suivi administratif d'un dossier.
+     * @param dossierId ID du dossier
+     * @param page Numéro de page
+     * @param perPage Nombre de résultats demandé
+     */
+    paginateSuiviAdministratif(dossierId: string, page?: number, perPage?: number): AsyncGenerator<PaginateSuiviAdministratif200Response>;
+    /**
+     * Récupération de la liste des tags d'un dossier.
+     * @param dossierId ID du dossier
+     * @param page Numéro de page
+     * @param perPage Nombre de résultats demandé
+     */
+    paginateTags(dossierId: string, page?: number, perPage?: number): AsyncGenerator<PaginateTags200Response>;
+    /**
+     * Liste des documents liés à un workflow.
+     * @param dossierId
+     * @param workflowId
+     * @param page Numéro de page
+     * @param perPage Nombre de résultats demandé
+     */
+    paginateWorkflowDocuments(dossierId: string, workflowId: string, page?: number, perPage?: number): AsyncGenerator<PaginateWorkflowDocuments200Response>;
+    /**
+     * Récupération de la liste des workflows d'un dossier.
+     * @param dossierId ID du dossier
+     * @param page Numéro de page
+     * @param perPage Nombre de résultats demandé
+     */
+    paginateWorkflows(dossierId: string, page?: number, perPage?: number): AsyncGenerator<PaginateWorkflows200Response>;
+    /**
+     * Modification d'un dossier existant.
+     * @param dossierId ID du dossier
+     * @param dossier
+     */
+    patchDossier(dossierId: string, dossier?: Dossier): Promise<AxiosResponse<Dossier>>;
+    /**
+     * Création d'un nouveau dossier.
+     * @param postDossierRequest
+     */
+    postDossier(postDossierRequest?: PostDossierRequest): Promise<AxiosResponse<Dossier>>;
+}

package/lib/api/DossiersAPI.js

@@ -0,0 +1,149 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DossiersAPI = void 0;
+const core_1 = require("../core");
+const utils_1 = __importDefault(require("../utils"));
+class DossiersAPI extends core_1.Core {
+    constructor(config) {
+        super(config);
+    }
+    /**
+     * Récupération de l'ensemble des données d'un dossier.
+     * @param dossierId ID du dossier
+     */
+    async getDossier(dossierId) {
+        const pathVariable = { dossier_id: dossierId };
+        return this.request({
+            method: "GET",
+            endpoint: utils_1.default.constructPath(pathVariable, "/dossiers/{dossier_id}"),
+            headers: {},
+            params: {},
+            body: {},
+        });
+    }
+    /**
+     * Récupération de la liste des dossiers selon des critères de recherche.
+     * @param page Numéro de page
+     * @param perPage Nombre de résultats demandé
+     */
+    paginateDossiers(page, perPage) {
+        const pathVariable = {};
+        return this.autoPagingIterator({
+            method: "GET",
+            endpoint: utils_1.default.constructPath(pathVariable, "/dossiers/"),
+            headers: {},
+            params: { page: page.toString(), per_page: perPage.toString() },
+            body: {},
+        });
+    }
+    /**
+     * Récupération de la liste du suivi administratif d'un dossier.
+     * @param dossierId ID du dossier
+     * @param page Numéro de page
+     * @param perPage Nombre de résultats demandé
+     */
+    paginateSuiviAdministratif(dossierId, page, perPage) {
+        const pathVariable = { dossier_id: dossierId };
+        return this.autoPagingIterator({
+            method: "GET",
+            endpoint: utils_1.default.constructPath(pathVariable, "/dossiers/{dossier_id}/suivi_administratif"),
+            headers: {},
+            params: { page: page.toString(), per_page: perPage.toString() },
+            body: {},
+        });
+    }
+    /**
+     * Récupération de la liste des tags d'un dossier.
+     * @param dossierId ID du dossier
+     * @param page Numéro de page
+     * @param perPage Nombre de résultats demandé
+     */
+    paginateTags(dossierId, page, perPage) {
+        const pathVariable = { dossier_id: dossierId };
+        return this.autoPagingIterator({
+            method: "GET",
+            endpoint: utils_1.default.constructPath(pathVariable, "/dossiers/{dossier_id}/tags"),
+            headers: {},
+            params: { page: page.toString(), per_page: perPage.toString() },
+            body: {},
+        });
+    }
+    /**
+     * Liste des documents liés à un workflow.
+     * @param dossierId
+     * @param workflowId
+     * @param page Numéro de page
+     * @param perPage Nombre de résultats demandé
+     */
+    paginateWorkflowDocuments(dossierId, workflowId, page, perPage) {
+        const pathVariable = { dossier_id: dossierId, workflow_id: workflowId };
+        return this.autoPagingIterator({
+            method: "GET",
+            endpoint: utils_1.default.constructPath(pathVariable, "/dossiers/{dossier_id}/workflows/{workflow_id}/documents"),
+            headers: {},
+            params: { page: page.toString(), per_page: perPage.toString() },
+            body: {},
+        });
+    }
+    /**
+     * Récupération de la liste des workflows d'un dossier.
+     * @param dossierId ID du dossier
+     * @param page Numéro de page
+     * @param perPage Nombre de résultats demandé
+     */
+    paginateWorkflows(dossierId, page, perPage) {
+        const pathVariable = { dossier_id: dossierId };
+        return this.autoPagingIterator({
+            method: "GET",
+            endpoint: utils_1.default.constructPath(pathVariable, "/dossiers/{dossier_id}/workflows"),
+            headers: {},
+            params: { page: page.toString(), per_page: perPage.toString() },
+            body: {},
+        });
+    }
+    /**
+     * Modification d'un dossier existant.
+     * @param dossierId ID du dossier
+     * @param dossier
+     */
+    async patchDossier(dossierId, dossier) {
+        const pathVariable = { dossier_id: dossierId };
+        return this.request({
+            method: "PATCH",
+            endpoint: utils_1.default.constructPath(pathVariable, "/dossiers/{dossier_id}"),
+            headers: {},
+            params: {},
+            body: {
+                id: dossier?.id,
+                type: dossier?.type,
+                description: dossier?.description,
+                dateDeCreation: dossier?.dateDeCreation,
+                createur: dossier?.createur,
+                applicationUtilisee: dossier?.applicationUtilisee,
+                statut: dossier?.statut,
+            },
+        });
+    }
+    /**
+     * Création d'un nouveau dossier.
+     * @param postDossierRequest
+     */
+    async postDossier(postDossierRequest) {
+        const pathVariable = {};
+        return this.request({
+            method: "POST",
+            endpoint: utils_1.default.constructPath(pathVariable, "/dossiers/"),
+            headers: {},
+            params: {},
+            body: {
+                titre: postDossierRequest?.titre,
+                description: postDossierRequest?.description,
+                workflows: postDossierRequest?.workflows,
+            },
+        });
+    }
+}
+exports.DossiersAPI = DossiersAPI;

package/lib/api/NotificationsAPI.d.ts

@@ -0,0 +1,30 @@
+import { Core, MetariscConfig } from "../core";
+import type { AxiosResponse } from "axios";
+import { Notification } from "../../src/model/Notification";
+import { PaginateNotifications200Response } from "../../src/model/PaginateNotifications200Response";
+import { PostNotificationRequest } from "../../src/model/PostNotificationRequest";
+export declare class NotificationsAPI extends Core {
+    constructor(config: MetariscConfig);
+    /**
+     * Suppression d'une notification correspondante à l'id donné.
+     * @param notificationId L'id de la notification demandée
+     */
+    deleteNotification(notificationId: string): Promise<AxiosResponse<void>>;
+    /**
+     * Récupération des détails d'une notification correspondante à l'id donné.
+     * @param notificationId L'id de la notification demandée
+     * @param notification
+     */
+    getNotification(notificationId: string, notification?: Notification): Promise<AxiosResponse<Notification>>;
+    /**
+     * Récupération des détails de toutes les notifications existantes.
+     * @param page Numéro de page
+     * @param perPage Nombre de résultats demandé
+     */
+    paginateNotifications(page?: number, perPage?: number): AsyncGenerator<PaginateNotifications200Response>;
+    /**
+     * Création d'une notification.
+     * @param postNotificationRequest
+     */
+    postNotification(postNotificationRequest?: PostNotificationRequest): Promise<AxiosResponse<Notification>>;
+}

package/lib/api/NotificationsAPI.js

@@ -0,0 +1,85 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.NotificationsAPI = void 0;
+const core_1 = require("../core");
+const utils_1 = __importDefault(require("../utils"));
+class NotificationsAPI extends core_1.Core {
+    constructor(config) {
+        super(config);
+    }
+    /**
+     * Suppression d'une notification correspondante à l'id donné.
+     * @param notificationId L'id de la notification demandée
+     */
+    async deleteNotification(notificationId) {
+        const pathVariable = { notification_id: notificationId };
+        return this.request({
+            method: "DELETE",
+            endpoint: utils_1.default.constructPath(pathVariable, "/notifications/{notification_id}"),
+            headers: {},
+            params: {},
+            body: {},
+        });
+    }
+    /**
+     * Récupération des détails d'une notification correspondante à l'id donné.
+     * @param notificationId L'id de la notification demandée
+     * @param notification
+     */
+    async getNotification(notificationId, notification) {
+        const pathVariable = { notification_id: notificationId };
+        return this.request({
+            method: "GET",
+            endpoint: utils_1.default.constructPath(pathVariable, "/notifications/{notification_id}"),
+            headers: {},
+            params: {},
+            body: {
+                id: notification?.id,
+                title: notification?.title,
+                message: notification?.message,
+                contexte: notification?.contexte,
+                dateCreation: notification?.dateCreation,
+                dateDeLecture: notification?.dateDeLecture,
+                utilisateurId: notification?.utilisateurId,
+            },
+        });
+    }
+    /**
+     * Récupération des détails de toutes les notifications existantes.
+     * @param page Numéro de page
+     * @param perPage Nombre de résultats demandé
+     */
+    paginateNotifications(page, perPage) {
+        const pathVariable = {};
+        return this.autoPagingIterator({
+            method: "GET",
+            endpoint: utils_1.default.constructPath(pathVariable, "/notifications/"),
+            headers: {},
+            params: { page: page.toString(), per_page: perPage.toString() },
+            body: {},
+        });
+    }
+    /**
+     * Création d'une notification.
+     * @param postNotificationRequest
+     */
+    async postNotification(postNotificationRequest) {
+        const pathVariable = {};
+        return this.request({
+            method: "POST",
+            endpoint: utils_1.default.constructPath(pathVariable, "/notifications/"),
+            headers: {},
+            params: {},
+            body: {
+                title: postNotificationRequest?.title,
+                message: postNotificationRequest?.message,
+                contexte: postNotificationRequest?.contexte,
+                utilisateurId: postNotificationRequest?.utilisateurId,
+            },
+        });
+    }
+}
+exports.NotificationsAPI = NotificationsAPI;

package/lib/api/OrganisationAPI.d.ts

@@ -0,0 +1,11 @@
+import { Core, MetariscConfig } from "../core";
+import type { AxiosResponse } from 'axios';
+import { Organisation } from '../../src/model/Organisation';
+export declare class OrganisationAPI extends Core {
+    constructor(config: MetariscConfig);
+    /**
+     * Récupération des détails d'une organisation.
+     * @param orgId ID de l'organisation
+     */
+    getOrganisation(orgId: string): Promise<AxiosResponse<Organisation>>;
+}

package/lib/api/OrganisationAPI.js

@@ -0,0 +1,28 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OrganisationAPI = void 0;
+const core_1 = require("../core");
+const utils_1 = __importDefault(require("../utils"));
+class OrganisationAPI extends core_1.Core {
+    constructor(config) {
+        super(config);
+    }
+    /**
+     * Récupération des détails d'une organisation.
+     * @param orgId ID de l'organisation
+     */
+    async getOrganisation(orgId) {
+        const pathVariable = { 'org_id': orgId };
+        return this.request({
+            method: 'GET',
+            endpoint: utils_1.default.constructPath(pathVariable, '/organisations/{org_id}'),
+            headers: {},
+            params: {},
+            body: {}
+        });
+    }
+}
+exports.OrganisationAPI = OrganisationAPI;

package/lib/api/POIAPI.d.ts

@@ -0,0 +1,49 @@
+import { Core, MetariscConfig } from "../core";
+import type { AxiosResponse } from "axios";
+import { POI } from "../../src/model/POI";
+import { PaginateContacts200Response } from "../../src/model/PaginateContacts200Response";
+import { PaginateHistorique200Response } from "../../src/model/PaginateHistorique200Response";
+import { PaginatePiecesJointes200Response } from "../../src/model/PaginatePiecesJointes200Response";
+import { PaginatePoi200Response } from "../../src/model/PaginatePoi200Response";
+import { PatchPoiRequest } from "../../src/model/PatchPoiRequest";
+export declare class POIAPI extends Core {
+    constructor(config: MetariscConfig);
+    /**
+     * Récupération de l'ensemble des données d'un POI.
+     * @param poiId ID du POI
+     */
+    getPoi(poiId: string): Promise<AxiosResponse<POI>>;
+    /**
+     * Récupération de la liste des contacts d'un POI.
+     * @param poiId ID du POI
+     * @param page Numéro de page
+     * @param perPage Nombre de résultats demandé
+     */
+    paginateContacts(poiId: string, page?: number, perPage?: number): AsyncGenerator<PaginateContacts200Response>;
+    /**
+     * Récupération de l'historique d'un POI.
+     * @param poiId ID du POI
+     * @param page Numéro de page
+     * @param perPage Nombre de résultats demandé
+     */
+    paginateHistorique(poiId: string, page?: number, perPage?: number): AsyncGenerator<PaginateHistorique200Response>;
+    /**
+     * Récupération de la liste des pièces jointes d'un POI.
+     * @param poiId ID du POI
+     * @param page Numéro de page
+     * @param perPage Nombre de résultats demandé
+     */
+    paginatePiecesJointes(poiId: string, page?: number, perPage?: number): AsyncGenerator<PaginatePiecesJointes200Response>;
+    /**
+     * Récupération de la liste des POI selon des critères de recherche.
+     * @param page Numéro de page
+     * @param perPage Nombre de résultats demandé
+     */
+    paginatePoi(page?: number, perPage?: number): AsyncGenerator<PaginatePoi200Response>;
+    /**
+     * Modifier un POI existant.
+     * @param poiId ID du POI
+     * @param patchPoiRequest
+     */
+    patchPoi(poiId: string, patchPoiRequest?: PatchPoiRequest): Promise<AxiosResponse<POI>>;
+}

package/lib/api/POIAPI.js

@@ -0,0 +1,106 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.POIAPI = void 0;
+const core_1 = require("../core");
+const utils_1 = __importDefault(require("../utils"));
+class POIAPI extends core_1.Core {
+    constructor(config) {
+        super(config);
+    }
+    /**
+     * Récupération de l'ensemble des données d'un POI.
+     * @param poiId ID du POI
+     */
+    async getPoi(poiId) {
+        const pathVariable = { poi_id: poiId };
+        return this.request({
+            method: "GET",
+            endpoint: utils_1.default.constructPath(pathVariable, "/poi/{poi_id}"),
+            headers: {},
+            params: {},
+            body: {},
+        });
+    }
+    /**
+     * Récupération de la liste des contacts d'un POI.
+     * @param poiId ID du POI
+     * @param page Numéro de page
+     * @param perPage Nombre de résultats demandé
+     */
+    paginateContacts(poiId, page, perPage) {
+        const pathVariable = { poi_id: poiId };
+        return this.autoPagingIterator({
+            method: "GET",
+            endpoint: utils_1.default.constructPath(pathVariable, "/poi/{poi_id}/contacts"),
+            headers: {},
+            params: { page: page.toString(), per_page: perPage.toString() },
+            body: {},
+        });
+    }
+    /**
+     * Récupération de l'historique d'un POI.
+     * @param poiId ID du POI
+     * @param page Numéro de page
+     * @param perPage Nombre de résultats demandé
+     */
+    paginateHistorique(poiId, page, perPage) {
+        const pathVariable = { poi_id: poiId };
+        return this.autoPagingIterator({
+            method: "GET",
+            endpoint: utils_1.default.constructPath(pathVariable, "/poi/{poi_id}/historique"),
+            headers: {},
+            params: { page: page.toString(), per_page: perPage.toString() },
+            body: {},
+        });
+    }
+    /**
+     * Récupération de la liste des pièces jointes d'un POI.
+     * @param poiId ID du POI
+     * @param page Numéro de page
+     * @param perPage Nombre de résultats demandé
+     */
+    paginatePiecesJointes(poiId, page, perPage) {
+        const pathVariable = { poi_id: poiId };
+        return this.autoPagingIterator({
+            method: "GET",
+            endpoint: utils_1.default.constructPath(pathVariable, "/poi/{poi_id}/pieces_jointes"),
+            headers: {},
+            params: { page: page.toString(), per_page: perPage.toString() },
+            body: {},
+        });
+    }
+    /**
+     * Récupération de la liste des POI selon des critères de recherche.
+     * @param page Numéro de page
+     * @param perPage Nombre de résultats demandé
+     */
+    paginatePoi(page, perPage) {
+        const pathVariable = {};
+        return this.autoPagingIterator({
+            method: "GET",
+            endpoint: utils_1.default.constructPath(pathVariable, "/poi/"),
+            headers: {},
+            params: { page: page.toString(), per_page: perPage.toString() },
+            body: {},
+        });
+    }
+    /**
+     * Modifier un POI existant.
+     * @param poiId ID du POI
+     * @param patchPoiRequest
+     */
+    async patchPoi(poiId, patchPoiRequest) {
+        const pathVariable = { poi_id: poiId };
+        return this.request({
+            method: "PATCH",
+            endpoint: utils_1.default.constructPath(pathVariable, "/poi/{poi_id}"),
+            headers: {},
+            params: {},
+            body: { test: patchPoiRequest?.test },
+        });
+    }
+}
+exports.POIAPI = POIAPI;

package/lib/api/PingAPI.d.ts

@@ -0,0 +1,10 @@
+import { Core, MetariscConfig } from "../core";
+import type { AxiosResponse } from 'axios';
+import { Ping200Response } from '../../src/model/Ping200Response';
+export declare class PingAPI extends Core {
+    constructor(config: MetariscConfig);
+    /**
+     * Permet de s'assurer que le service Metarisc est en ligne. Ping ... Pong !
+     */
+    ping(): Promise<AxiosResponse<Ping200Response>>;
+}

package/lib/api/PingAPI.js

@@ -0,0 +1,27 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PingAPI = void 0;
+const core_1 = require("../core");
+const utils_1 = __importDefault(require("../utils"));
+class PingAPI extends core_1.Core {
+    constructor(config) {
+        super(config);
+    }
+    /**
+     * Permet de s'assurer que le service Metarisc est en ligne. Ping ... Pong !
+     */
+    async ping() {
+        const pathVariable = {};
+        return this.request({
+            method: 'GET',
+            endpoint: utils_1.default.constructPath(pathVariable, '/ping'),
+            headers: {},
+            params: {},
+            body: {}
+        });
+    }
+}
+exports.PingAPI = PingAPI;

package/lib/api/SupportAPI.d.ts

@@ -0,0 +1,24 @@
+import { Core, MetariscConfig } from "../core";
+import type { AxiosResponse } from "axios";
+import { PaginateTickets200Response } from "../../src/model/PaginateTickets200Response";
+import { PostTicketRequest } from "../../src/model/PostTicketRequest";
+import { Ticket } from "../../src/model/Ticket";
+export declare class SupportAPI extends Core {
+    constructor(config: MetariscConfig);
+    /**
+     * Récupération des détails du ticket
+     * @param ticketId ID du ticket
+     */
+    getTicket(ticketId: string): Promise<AxiosResponse<Ticket>>;
+    /**
+     * Récupération de la liste des tickets de support.
+     * @param page Numéro de page
+     * @param perPage Nombre de résultats demandé
+     */
+    paginateTickets(page?: number, perPage?: number): AsyncGenerator<PaginateTickets200Response>;
+    /**
+     * Création d'un nouveau ticket de support.
+     * @param postTicketRequest
+     */
+    postTicket(postTicketRequest?: PostTicketRequest): Promise<AxiosResponse<Ticket>>;
+}