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

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.
@@ -5,65 +5,57 @@ import { Collection } from "../collection";
5
5
  import { Dossier } from '../model/Dossier';
6
6
  import { PostDossierRequest } from '../model/PostDossierRequest';
7
7
  import { Workflow } from '../model/Workflow';
8
- import { SuiviAdministratif } from '../model/SuiviAdministratif';
9
8
  import { Tag } from '../model/Tag';
10
9
  import { Document } from '../model/Document';
11
10
  export declare class DossiersAPI extends Core {
12
11
  constructor(config: MetariscConfig, client?: Client);
13
12
  /**
14
13
  * Récupération de l'ensemble des données d'un dossier.
15
- * @param dossierId ID du dossier
14
+ * @param dossierId Identifiant unique du Dossier
16
15
  */
17
16
  getDossier(dossierId: string): Promise<AxiosResponse<Dossier>>;
18
17
  /**
19
- * Rédupération des détails d'un workflow.
20
- * @param dossierId
21
- * @param workflowId
18
+ * Récupération des détails d'un workflow.
19
+ * @param dossierId Identifiant unique du Dossier
20
+ * @param workflowId Identifiant unique du Workflow
22
21
  */
23
- getDossierWorkflowsWorkflow(dossierId: string, workflowId: string): Promise<AxiosResponse<Workflow>>;
22
+ getDossierWorkflowsDetails(dossierId: string, workflowId: string): Promise<AxiosResponse<Workflow>>;
24
23
  /**
25
- * Récupération de la liste des dossiers selon des critères de recherche.
26
- * @param page Numéro de page
27
- * @param perPage Nombre de résultats demandé
28
- */
29
- paginateDossiers(page?: number, perPage?: number): Collection<Dossier>;
30
- /**
31
- * Récupération de la liste du suivi administratif d'un dossier.
32
- * @param dossierId ID du dossier
24
+ * Récupération de la liste des tags d'un dossier.
25
+ * @param dossierId Identifiant unique du Dossier
33
26
  * @param page Numéro de page
34
27
  * @param perPage Nombre de résultats demandé
35
28
  */
36
- paginateSuiviAdministratif(dossierId: string, page?: number, perPage?: number): Collection<SuiviAdministratif>;
29
+ paginateDossierTags(dossierId: string, page?: number, perPage?: number): Collection<Tag>;
37
30
  /**
38
- * Récupération de la liste des tags d'un dossier.
39
- * @param dossierId ID du dossier
31
+ * Liste des documents liés à un workflow.
32
+ * @param dossierId Identifiant unique du Dossier
33
+ * @param workflowId Identifiant unique du Workflow
40
34
  * @param page Numéro de page
41
35
  * @param perPage Nombre de résultats demandé
42
36
  */
43
- paginateTags(dossierId: string, page?: number, perPage?: number): Collection<Tag>;
37
+ paginateDossierWorkflowDocuments(dossierId: string, workflowId: string, page?: number, perPage?: number): Collection<Document>;
44
38
  /**
45
- * Liste des documents liés à un workflow.
46
- * @param dossierId
47
- * @param workflowId
39
+ * Récupération de la liste des workflows d'un dossier.
40
+ * @param dossierId Identifiant unique du Dossier
48
41
  * @param page Numéro de page
49
42
  * @param perPage Nombre de résultats demandé
50
43
  */
51
- paginateWorkflowDocuments(dossierId: string, workflowId: string, page?: number, perPage?: number): Collection<Document>;
44
+ paginateDossierWorkflows(dossierId: string, page?: number, perPage?: number): Collection<Workflow>;
52
45
  /**
53
- * Récupération de la liste des workflows d'un dossier.
54
- * @param dossierId ID du dossier
46
+ * Récupération de la liste des dossiers selon des critères de recherche.
55
47
  * @param page Numéro de page
56
48
  * @param perPage Nombre de résultats demandé
57
49
  */
58
- paginateWorkflows(dossierId: string, page?: number, perPage?: number): Collection<Workflow>;
50
+ paginateDossiers(page?: number, perPage?: number): Collection<Dossier>;
59
51
  /**
60
- * Modification d'un dossier existant.
61
- * @param dossierId ID du dossier
52
+ * TODO : Modification d'un dossier existant.
53
+ * @param dossierId Identifiant unique du Dossier
62
54
  * @param dossier
63
55
  */
64
56
  patchDossier(dossierId: string, dossier?: Dossier): Promise<AxiosResponse<Dossier>>;
65
57
  /**
66
- * Création d'un nouveau dossier.
58
+ * TODO : Création d'un nouveau dossier.
67
59
  * @param postDossierRequest
68
60
  */
69
61
  postDossier(postDossierRequest?: PostDossierRequest): Promise<AxiosResponse<Dossier>>;
@@ -12,7 +12,7 @@ class DossiersAPI extends core_1.Core {
12
12
  }
13
13
  /**
14
14
  * Récupération de l'ensemble des données d'un dossier.
15
- * @param dossierId ID du dossier
15
+ * @param dossierId Identifiant unique du Dossier
16
16
  */
17
17
  async getDossier(dossierId) {
18
18
  const pathVariable = { 'dossier_id': dossierId };
@@ -25,11 +25,11 @@ class DossiersAPI extends core_1.Core {
25
25
  });
26
26
  }
27
27
  /**
28
- * Rédupération des détails d'un workflow.
29
- * @param dossierId
30
- * @param workflowId
28
+ * Récupération des détails d'un workflow.
29
+ * @param dossierId Identifiant unique du Dossier
30
+ * @param workflowId Identifiant unique du Workflow
31
31
  */
32
- async getDossierWorkflowsWorkflow(dossierId, workflowId) {
32
+ async getDossierWorkflowsDetails(dossierId, workflowId) {
33
33
  const pathVariable = { 'dossier_id': dossierId, 'workflow_id': workflowId };
34
34
  return this.request({
35
35
  method: 'GET',
@@ -40,88 +40,72 @@ class DossiersAPI extends core_1.Core {
40
40
  });
41
41
  }
42
42
  /**
43
- * Récupération de la liste des dossiers selon des critères de recherche.
44
- * @param page Numéro de page
45
- * @param perPage Nombre de résultats demandé
46
- */
47
- paginateDossiers(page, perPage) {
48
- const pathVariable = {};
49
- return this.collect({
50
- method: 'GET',
51
- endpoint: utils_1.default.constructPath(pathVariable, '/dossiers/'),
52
- headers: {},
53
- params: { 'page': page.toString(), 'per_page': perPage.toString() },
54
- body: {}
55
- });
56
- }
57
- /**
58
- * Récupération de la liste du suivi administratif d'un dossier.
59
- * @param dossierId ID du dossier
43
+ * Récupération de la liste des tags d'un dossier.
44
+ * @param dossierId Identifiant unique du Dossier
60
45
  * @param page Numéro de page
61
46
  * @param perPage Nombre de résultats demandé
62
47
  */
63
- paginateSuiviAdministratif(dossierId, page, perPage) {
48
+ paginateDossierTags(dossierId, page, perPage) {
64
49
  const pathVariable = { 'dossier_id': dossierId };
65
50
  return this.collect({
66
51
  method: 'GET',
67
- endpoint: utils_1.default.constructPath(pathVariable, '/dossiers/{dossier_id}/suivi_administratif'),
52
+ endpoint: utils_1.default.constructPath(pathVariable, '/dossiers/{dossier_id}/tags'),
68
53
  headers: {},
69
- params: { 'page': page.toString(), 'per_page': perPage.toString() },
54
+ params: { 'page': page?.toString(), 'per_page': perPage?.toString() },
70
55
  body: {}
71
56
  });
72
57
  }
73
58
  /**
74
- * Récupération de la liste des tags d'un dossier.
75
- * @param dossierId ID du dossier
59
+ * Liste des documents liés à un workflow.
60
+ * @param dossierId Identifiant unique du Dossier
61
+ * @param workflowId Identifiant unique du Workflow
76
62
  * @param page Numéro de page
77
63
  * @param perPage Nombre de résultats demandé
78
64
  */
79
- paginateTags(dossierId, page, perPage) {
80
- const pathVariable = { 'dossier_id': dossierId };
65
+ paginateDossierWorkflowDocuments(dossierId, workflowId, page, perPage) {
66
+ const pathVariable = { 'dossier_id': dossierId, 'workflow_id': workflowId };
81
67
  return this.collect({
82
68
  method: 'GET',
83
- endpoint: utils_1.default.constructPath(pathVariable, '/dossiers/{dossier_id}/tags'),
69
+ endpoint: utils_1.default.constructPath(pathVariable, '/dossiers/{dossier_id}/workflows/{workflow_id}/documents'),
84
70
  headers: {},
85
- params: { 'page': page.toString(), 'per_page': perPage.toString() },
71
+ params: { 'page': page?.toString(), 'per_page': perPage?.toString() },
86
72
  body: {}
87
73
  });
88
74
  }
89
75
  /**
90
- * Liste des documents liés à un workflow.
91
- * @param dossierId
92
- * @param workflowId
76
+ * Récupération de la liste des workflows d'un dossier.
77
+ * @param dossierId Identifiant unique du Dossier
93
78
  * @param page Numéro de page
94
79
  * @param perPage Nombre de résultats demandé
95
80
  */
96
- paginateWorkflowDocuments(dossierId, workflowId, page, perPage) {
97
- const pathVariable = { 'dossier_id': dossierId, 'workflow_id': workflowId };
81
+ paginateDossierWorkflows(dossierId, page, perPage) {
82
+ const pathVariable = { 'dossier_id': dossierId };
98
83
  return this.collect({
99
84
  method: 'GET',
100
- endpoint: utils_1.default.constructPath(pathVariable, '/dossiers/{dossier_id}/workflows/{workflow_id}/documents'),
85
+ endpoint: utils_1.default.constructPath(pathVariable, '/dossiers/{dossier_id}/workflows'),
101
86
  headers: {},
102
- params: { 'page': page.toString(), 'per_page': perPage.toString() },
87
+ params: { 'page': page?.toString(), 'per_page': perPage?.toString() },
103
88
  body: {}
104
89
  });
105
90
  }
106
91
  /**
107
- * Récupération de la liste des workflows d'un dossier.
108
- * @param dossierId ID du dossier
92
+ * Récupération de la liste des dossiers selon des critères de recherche.
109
93
  * @param page Numéro de page
110
94
  * @param perPage Nombre de résultats demandé
111
95
  */
112
- paginateWorkflows(dossierId, page, perPage) {
113
- const pathVariable = { 'dossier_id': dossierId };
96
+ paginateDossiers(page, perPage) {
97
+ const pathVariable = {};
114
98
  return this.collect({
115
99
  method: 'GET',
116
- endpoint: utils_1.default.constructPath(pathVariable, '/dossiers/{dossier_id}/workflows'),
100
+ endpoint: utils_1.default.constructPath(pathVariable, '/dossiers'),
117
101
  headers: {},
118
- params: { 'page': page.toString(), 'per_page': perPage.toString() },
102
+ params: { 'page': page?.toString(), 'per_page': perPage?.toString() },
119
103
  body: {}
120
104
  });
121
105
  }
122
106
  /**
123
- * Modification d'un dossier existant.
124
- * @param dossierId ID du dossier
107
+ * TODO : Modification d'un dossier existant.
108
+ * @param dossierId Identifiant unique du Dossier
125
109
  * @param dossier
126
110
  */
127
111
  async patchDossier(dossierId, dossier) {
@@ -135,14 +119,14 @@ class DossiersAPI extends core_1.Core {
135
119
  });
136
120
  }
137
121
  /**
138
- * Création d'un nouveau dossier.
122
+ * TODO : Création d'un nouveau dossier.
139
123
  * @param postDossierRequest
140
124
  */
141
125
  async postDossier(postDossierRequest) {
142
126
  const pathVariable = {};
143
127
  return this.request({
144
128
  method: 'POST',
145
- endpoint: utils_1.default.constructPath(pathVariable, '/dossiers/'),
129
+ endpoint: utils_1.default.constructPath(pathVariable, '/dossiers'),
146
130
  headers: {},
147
131
  params: {},
148
132
  body: { 'titre': postDossierRequest?.titre, 'description': postDossierRequest?.description, 'workflows': postDossierRequest?.workflows }
@@ -4,27 +4,27 @@ import { Client } from "../client";
4
4
  import { Collection } from "../collection";
5
5
  import { Evenement } from '../model/Evenement';
6
6
  import { PostEvenementRequest } from '../model/PostEvenementRequest';
7
- import { Utilisateur1 } from '../model/Utilisateur1';
7
+ import { Utilisateur } from '../model/Utilisateur';
8
8
  export declare class EvenementsAPI extends Core {
9
9
  constructor(config: MetariscConfig, client?: Client);
10
10
  /**
11
11
  * Suppression d'un événement correspondant à l'id donné.
12
- * @param evenementId ID de l'événement
12
+ * @param evenementId Identifiant unique de l'Événement
13
13
  */
14
14
  deleteEvenement(evenementId: string): Promise<AxiosResponse<void>>;
15
15
  /**
16
16
  * Récupération des détails d'un événement correspondant à l'id donné.
17
- * @param evenementId ID de l'événement
17
+ * @param evenementId Identifiant unique de l'Événement
18
18
  * @param evenement
19
19
  */
20
- getEvenement(evenementId: string, evenement?: Evenement): Promise<AxiosResponse<Evenement>>;
20
+ getEvenementDetails(evenementId: string, evenement?: Evenement): Promise<AxiosResponse<Evenement>>;
21
21
  /**
22
22
  * Récupération d'une liste paginée d'utilisateurs liés à un événement calendaire.
23
- * @param evenementId
23
+ * @param evenementId Identifiant unique de l'Événement
24
24
  * @param page Le numéro de la page.
25
25
  * @param perPage Limite le nombre d'objets retournés. La limite est comprise entre 1 et 100, la valeur par défaut étant de 10.
26
26
  */
27
- paginateEvenementUtilisateurs(evenementId: string, page?: number, perPage?: number): Collection<Utilisateur1>;
27
+ paginateEvenementUtilisateurs(evenementId: string, page?: number, perPage?: number): Collection<Utilisateur>;
28
28
  /**
29
29
  * Récupération des détails de tous les événements calendaires existants.
30
30
  * @param page Le numéro de la page.
@@ -34,7 +34,7 @@ export declare class EvenementsAPI extends Core {
34
34
  */
35
35
  paginateEvenements(page?: number, perPage?: number, type?: string, period?: string): Collection<Evenement>;
36
36
  /**
37
- * Création d'un événement.
37
+ * TODO : Création d'un événement.
38
38
  * @param postEvenementRequest
39
39
  */
40
40
  postEvenement(postEvenementRequest?: PostEvenementRequest): Promise<AxiosResponse<Evenement>>;
@@ -12,7 +12,7 @@ class EvenementsAPI extends core_1.Core {
12
12
  }
13
13
  /**
14
14
  * Suppression d'un événement correspondant à l'id donné.
15
- * @param evenementId ID de l'événement
15
+ * @param evenementId Identifiant unique de l'Événement
16
16
  */
17
17
  async deleteEvenement(evenementId) {
18
18
  const pathVariable = { 'evenement_id': evenementId };
@@ -26,10 +26,10 @@ class EvenementsAPI extends core_1.Core {
26
26
  }
27
27
  /**
28
28
  * Récupération des détails d'un événement correspondant à l'id donné.
29
- * @param evenementId ID de l'événement
29
+ * @param evenementId Identifiant unique de l'Événement
30
30
  * @param evenement
31
31
  */
32
- async getEvenement(evenementId, evenement) {
32
+ async getEvenementDetails(evenementId, evenement) {
33
33
  const pathVariable = { 'evenement_id': evenementId };
34
34
  return this.request({
35
35
  method: 'GET',
@@ -41,7 +41,7 @@ class EvenementsAPI extends core_1.Core {
41
41
  }
42
42
  /**
43
43
  * Récupération d'une liste paginée d'utilisateurs liés à un événement calendaire.
44
- * @param evenementId
44
+ * @param evenementId Identifiant unique de l'Événement
45
45
  * @param page Le numéro de la page.
46
46
  * @param perPage Limite le nombre d'objets retournés. La limite est comprise entre 1 et 100, la valeur par défaut étant de 10.
47
47
  */
@@ -51,7 +51,7 @@ class EvenementsAPI extends core_1.Core {
51
51
  method: 'GET',
52
52
  endpoint: utils_1.default.constructPath(pathVariable, '/evenements/{evenement_id}/utilisateurs'),
53
53
  headers: {},
54
- params: { 'page': page.toString(), 'per_page': perPage.toString() },
54
+ params: { 'page': page?.toString(), 'per_page': perPage?.toString() },
55
55
  body: {}
56
56
  });
57
57
  }
@@ -66,21 +66,21 @@ class EvenementsAPI extends core_1.Core {
66
66
  const pathVariable = {};
67
67
  return this.collect({
68
68
  method: 'GET',
69
- endpoint: utils_1.default.constructPath(pathVariable, '/evenements/'),
69
+ endpoint: utils_1.default.constructPath(pathVariable, '/evenements'),
70
70
  headers: {},
71
- params: { 'page': page.toString(), 'per_page': perPage.toString(), 'type': type, 'period': period },
71
+ params: { 'page': page?.toString(), 'per_page': perPage?.toString(), 'type': type, 'period': period },
72
72
  body: {}
73
73
  });
74
74
  }
75
75
  /**
76
- * Création d'un événement.
76
+ * TODO : Création d'un événement.
77
77
  * @param postEvenementRequest
78
78
  */
79
79
  async postEvenement(postEvenementRequest) {
80
80
  const pathVariable = {};
81
81
  return this.request({
82
82
  method: 'POST',
83
- endpoint: utils_1.default.constructPath(pathVariable, '/evenements/'),
83
+ endpoint: utils_1.default.constructPath(pathVariable, '/evenements'),
84
84
  headers: {},
85
85
  params: {},
86
86
  body: { 'title': postEvenementRequest?.title, 'type': postEvenementRequest?.type, 'description': postEvenementRequest?.description, 'date_debut': postEvenementRequest?.date_debut, 'date_fin': postEvenementRequest?.date_fin }
@@ -8,16 +8,16 @@ export declare class NotificationsAPI extends Core {
8
8
  constructor(config: MetariscConfig, client?: Client);
9
9
  /**
10
10
  * Suppression d'une notification correspondante à l'id donné.
11
- * @param notificationId L'id de la notification demandée
11
+ * @param notificationId Identifiant unique de la Notification
12
12
  */
13
13
  deleteNotification(notificationId: string): Promise<AxiosResponse<void>>;
14
14
  /**
15
15
  * Récupération des détails d'une notification correspondante à l'id donné.
16
- * @param notificationId L'id de la notification demandée
16
+ * @param notificationId Identifiant unique de la Notification
17
17
  */
18
18
  getNotification(notificationId: string): Promise<AxiosResponse<Notification>>;
19
19
  /**
20
- * Récupération des détails de toutes les notifications existantes.
20
+ * Récupération des détails de toutes les notifications existantes pour l'utilisateur connecté.
21
21
  * @param page Numéro de page
22
22
  * @param perPage Nombre de résultats demandé
23
23
  */
@@ -12,7 +12,7 @@ class NotificationsAPI extends core_1.Core {
12
12
  }
13
13
  /**
14
14
  * Suppression d'une notification correspondante à l'id donné.
15
- * @param notificationId L'id de la notification demandée
15
+ * @param notificationId Identifiant unique de la Notification
16
16
  */
17
17
  async deleteNotification(notificationId) {
18
18
  const pathVariable = { 'notification_id': notificationId };
@@ -26,7 +26,7 @@ class NotificationsAPI extends core_1.Core {
26
26
  }
27
27
  /**
28
28
  * Récupération des détails d'une notification correspondante à l'id donné.
29
- * @param notificationId L'id de la notification demandée
29
+ * @param notificationId Identifiant unique de la Notification
30
30
  */
31
31
  async getNotification(notificationId) {
32
32
  const pathVariable = { 'notification_id': notificationId };
@@ -39,7 +39,7 @@ class NotificationsAPI extends core_1.Core {
39
39
  });
40
40
  }
41
41
  /**
42
- * Récupération des détails de toutes les notifications existantes.
42
+ * Récupération des détails de toutes les notifications existantes pour l'utilisateur connecté.
43
43
  * @param page Numéro de page
44
44
  * @param perPage Nombre de résultats demandé
45
45
  */
@@ -47,9 +47,9 @@ class NotificationsAPI extends core_1.Core {
47
47
  const pathVariable = {};
48
48
  return this.collect({
49
49
  method: 'GET',
50
- endpoint: utils_1.default.constructPath(pathVariable, '/notifications/'),
50
+ endpoint: utils_1.default.constructPath(pathVariable, '/notifications'),
51
51
  headers: {},
52
- params: { 'page': page.toString(), 'per_page': perPage.toString() },
52
+ params: { 'page': page?.toString(), 'per_page': perPage?.toString() },
53
53
  body: {}
54
54
  });
55
55
  }
@@ -61,7 +61,7 @@ class NotificationsAPI extends core_1.Core {
61
61
  const pathVariable = {};
62
62
  return this.request({
63
63
  method: 'POST',
64
- endpoint: utils_1.default.constructPath(pathVariable, '/notifications/'),
64
+ endpoint: utils_1.default.constructPath(pathVariable, '/notifications'),
65
65
  headers: {},
66
66
  params: {},
67
67
  body: { 'title': postNotificationRequest?.title, 'message': postNotificationRequest?.message, 'contexte': postNotificationRequest?.contexte, 'utilisateur_id': postNotificationRequest?.utilisateur_id }
@@ -0,0 +1,19 @@
1
+ import { Core, MetariscConfig } from "../core";
2
+ import type { AxiosResponse } from "axios";
3
+ import { Client } from "../client";
4
+ import { Collection } from "../collection";
5
+ import { Organisation } from '../model/Organisation';
6
+ export declare class OrganisationsAPI extends Core {
7
+ constructor(config: MetariscConfig, client?: Client);
8
+ /**
9
+ * Récupération des détails d'une organisation.
10
+ * @param orgId Identifiant unique de l'Organisation
11
+ */
12
+ getOrganisation(orgId: string): Promise<AxiosResponse<Organisation>>;
13
+ /**
14
+ * Liste paginée des organisations.
15
+ * @param page Numéro de page
16
+ * @param perPage Nombre de résultats demandé
17
+ */
18
+ paginateOrganisations(page?: number, perPage?: number): Collection<Organisation>;
19
+ }
@@ -0,0 +1,43 @@
1
+ "use strict";
2
+ var __importDefault = (this && this.__importDefault) || function (mod) {
3
+ return (mod && mod.__esModule) ? mod : { "default": mod };
4
+ };
5
+ Object.defineProperty(exports, "__esModule", { value: true });
6
+ exports.OrganisationsAPI = void 0;
7
+ const core_1 = require("../core");
8
+ const utils_1 = __importDefault(require("../utils"));
9
+ class OrganisationsAPI extends core_1.Core {
10
+ constructor(config, client) {
11
+ super(config, client);
12
+ }
13
+ /**
14
+ * Récupération des détails d'une organisation.
15
+ * @param orgId Identifiant unique de l'Organisation
16
+ */
17
+ async getOrganisation(orgId) {
18
+ const pathVariable = { 'org_id': orgId };
19
+ return this.request({
20
+ method: 'GET',
21
+ endpoint: utils_1.default.constructPath(pathVariable, '/organisations/{org_id}'),
22
+ headers: {},
23
+ params: {},
24
+ body: {}
25
+ });
26
+ }
27
+ /**
28
+ * Liste paginée des organisations.
29
+ * @param page Numéro de page
30
+ * @param perPage Nombre de résultats demandé
31
+ */
32
+ paginateOrganisations(page, perPage) {
33
+ const pathVariable = {};
34
+ return this.collect({
35
+ method: 'GET',
36
+ endpoint: utils_1.default.constructPath(pathVariable, '/organisations'),
37
+ headers: {},
38
+ params: { 'page': page?.toString(), 'per_page': perPage?.toString() },
39
+ body: {}
40
+ });
41
+ }
42
+ }
43
+ exports.OrganisationsAPI = OrganisationsAPI;
@@ -0,0 +1,43 @@
1
+ import { Core, MetariscConfig } from "../core";
2
+ import type { AxiosResponse } from "axios";
3
+ import { Client } from "../client";
4
+ import { Collection } from "../collection";
5
+ import { PEI } from '../model/PEI';
6
+ import { Contact } from '../model/Contact';
7
+ import { DescriptifTechnique } from '../model/DescriptifTechnique';
8
+ import { PieceJointe } from '../model/PieceJointe';
9
+ export declare class PEIAPI extends Core {
10
+ constructor(config: MetariscConfig, client?: Client);
11
+ /**
12
+ * Récupération de l'ensemble des données d'un PEI.
13
+ * @param peiId Identifiant unique du PEI
14
+ */
15
+ getPei(peiId: string): Promise<AxiosResponse<PEI>>;
16
+ /**
17
+ * Récupération de la liste des Points d'Eau Incendie (PEI) selon des critères de recherche.
18
+ * @param page Numéro de page
19
+ * @param perPage Nombre de résultats demandé
20
+ */
21
+ paginatePei(page?: number, perPage?: number): Collection<PEI>;
22
+ /**
23
+ * Récupération de la liste des contacts d'un Point d'Eau Incendie.
24
+ * @param peiId Identifiant unique du PEI
25
+ * @param page Numéro de page
26
+ * @param perPage Nombre de résultats demandé
27
+ */
28
+ paginatePeiContacts(peiId: string, page?: number, perPage?: number): Collection<Contact>;
29
+ /**
30
+ * Récupération de l'historique d'un POI.
31
+ * @param peiId Identifiant unique du PEI
32
+ * @param page Numéro de page
33
+ * @param perPage Nombre de résultats demandé
34
+ */
35
+ paginatePeiHistorique(peiId: string, page?: number, perPage?: number): Collection<DescriptifTechnique>;
36
+ /**
37
+ * Récupération de la liste des pièces jointes d'un Point d'Eau Incendie.
38
+ * @param peiId Identifiant unique du PEI
39
+ * @param page Numéro de page
40
+ * @param perPage Nombre de résultats demandé
41
+ */
42
+ paginatePeiPiecesJointes(peiId: string, page?: number, perPage?: number): Collection<PieceJointe>;
43
+ }
@@ -0,0 +1,91 @@
1
+ "use strict";
2
+ var __importDefault = (this && this.__importDefault) || function (mod) {
3
+ return (mod && mod.__esModule) ? mod : { "default": mod };
4
+ };
5
+ Object.defineProperty(exports, "__esModule", { value: true });
6
+ exports.PEIAPI = void 0;
7
+ const core_1 = require("../core");
8
+ const utils_1 = __importDefault(require("../utils"));
9
+ class PEIAPI extends core_1.Core {
10
+ constructor(config, client) {
11
+ super(config, client);
12
+ }
13
+ /**
14
+ * Récupération de l'ensemble des données d'un PEI.
15
+ * @param peiId Identifiant unique du PEI
16
+ */
17
+ async getPei(peiId) {
18
+ const pathVariable = { 'pei_id': peiId };
19
+ return this.request({
20
+ method: 'GET',
21
+ endpoint: utils_1.default.constructPath(pathVariable, '/pei/{pei_id}'),
22
+ headers: {},
23
+ params: {},
24
+ body: {}
25
+ });
26
+ }
27
+ /**
28
+ * Récupération de la liste des Points d'Eau Incendie (PEI) selon des critères de recherche.
29
+ * @param page Numéro de page
30
+ * @param perPage Nombre de résultats demandé
31
+ */
32
+ paginatePei(page, perPage) {
33
+ const pathVariable = {};
34
+ return this.collect({
35
+ method: 'GET',
36
+ endpoint: utils_1.default.constructPath(pathVariable, '/pei'),
37
+ headers: {},
38
+ params: { 'page': page?.toString(), 'per_page': perPage?.toString() },
39
+ body: {}
40
+ });
41
+ }
42
+ /**
43
+ * Récupération de la liste des contacts d'un Point d'Eau Incendie.
44
+ * @param peiId Identifiant unique du PEI
45
+ * @param page Numéro de page
46
+ * @param perPage Nombre de résultats demandé
47
+ */
48
+ paginatePeiContacts(peiId, page, perPage) {
49
+ const pathVariable = { 'pei_id': peiId };
50
+ return this.collect({
51
+ method: 'GET',
52
+ endpoint: utils_1.default.constructPath(pathVariable, '/pei/{pei_id}/contacts'),
53
+ headers: {},
54
+ params: { 'page': page?.toString(), 'per_page': perPage?.toString() },
55
+ body: {}
56
+ });
57
+ }
58
+ /**
59
+ * Récupération de l'historique d'un POI.
60
+ * @param peiId Identifiant unique du PEI
61
+ * @param page Numéro de page
62
+ * @param perPage Nombre de résultats demandé
63
+ */
64
+ paginatePeiHistorique(peiId, page, perPage) {
65
+ const pathVariable = { 'pei_id': peiId };
66
+ return this.collect({
67
+ method: 'GET',
68
+ endpoint: utils_1.default.constructPath(pathVariable, '/pei/{pei_id}/historique'),
69
+ headers: {},
70
+ params: { 'page': page?.toString(), 'per_page': perPage?.toString() },
71
+ body: {}
72
+ });
73
+ }
74
+ /**
75
+ * Récupération de la liste des pièces jointes d'un Point d'Eau Incendie.
76
+ * @param peiId Identifiant unique du PEI
77
+ * @param page Numéro de page
78
+ * @param perPage Nombre de résultats demandé
79
+ */
80
+ paginatePeiPiecesJointes(peiId, page, perPage) {
81
+ const pathVariable = { 'pei_id': peiId };
82
+ return this.collect({
83
+ method: 'GET',
84
+ endpoint: utils_1.default.constructPath(pathVariable, '/pei/{pei_id}/pieces_jointes'),
85
+ headers: {},
86
+ params: { 'page': page?.toString(), 'per_page': perPage?.toString() },
87
+ body: {}
88
+ });
89
+ }
90
+ }
91
+ exports.PEIAPI = PEIAPI;
@@ -10,20 +10,10 @@ export declare class UtilisateursAPI extends Core {
10
10
  * 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.
11
11
  */
12
12
  getUtilisateursMoi(): Promise<AxiosResponse<Utilisateur>>;
13
- /**
14
- * 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.
15
- */
16
- getUtilisateursMoi1(): Promise<AxiosResponse<Utilisateur>>;
17
13
  /**
18
14
  * Liste toutes les adresses mail de l'utilisateur connecté, y compris les adresses non publiquement accessibles.
19
15
  * @param page Numéro de page
20
16
  * @param perPage Nombre de résultats demandé
21
17
  */
22
18
  paginateMoiEmails(page?: number, perPage?: number): Collection<Email>;
23
- /**
24
- * Liste toutes les adresses mail de l'utilisateur connecté, y compris les adresses non publiquement accessibles.
25
- * @param page Numéro de page
26
- * @param perPage Nombre de résultats demandé
27
- */
28
- paginateMoiEmails1(page?: number, perPage?: number): Collection<Email>;
29
19
  }