@communecter/cocolight-api-client 1.0.54 → 1.0.56
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.
- package/dist/401.cocolight-api-client.browser.js +1 -0
- package/dist/401.cocolight-api-client.cjs +1 -0
- package/dist/401.cocolight-api-client.mjs.js +1 -0
- package/dist/588.cocolight-api-client.browser.js +1 -0
- package/dist/588.cocolight-api-client.cjs +1 -0
- package/dist/588.cocolight-api-client.mjs.js +1 -0
- package/dist/593.cocolight-api-client.browser.js +1 -0
- package/dist/593.cocolight-api-client.cjs +1 -0
- package/dist/593.cocolight-api-client.mjs.js +1 -0
- package/dist/839.cocolight-api-client.browser.js +1 -0
- package/dist/839.cocolight-api-client.cjs +1 -0
- package/dist/839.cocolight-api-client.mjs.js +1 -0
- package/dist/cocolight-api-client.browser.js +3 -3
- package/dist/cocolight-api-client.cjs +1 -1
- package/dist/cocolight-api-client.mjs.js +1 -1
- package/dist/cocolight-api-client.vite.mjs.js +1 -1
- package/dist/cocolight-api-client.vite.mjs.js.map +1 -1
- package/package.json +29 -17
- package/src/{Api.js → Api.ts} +85 -95
- package/src/{ApiClient.js → ApiClient.ts} +436 -247
- package/src/EJSONType.ts +103 -0
- package/src/api/{Badge.js → Badge.ts} +56 -45
- package/src/api/BaseEntity.ts +3890 -0
- package/src/api/Comment.ts +200 -0
- package/src/api/{EndpointApi.js → EndpointApi.ts} +363 -297
- package/src/api/EndpointApi.types.ts +4609 -0
- package/src/api/EntityRegistry.ts +203 -0
- package/src/api/Event.ts +332 -0
- package/src/api/News.ts +331 -0
- package/src/api/{Organization.js → Organization.ts} +155 -119
- package/src/api/{Poi.js → Poi.ts} +68 -60
- package/src/api/{Project.js → Project.ts} +150 -127
- package/src/api/{User.js → User.ts} +321 -256
- package/src/api/UserApi.ts +148 -0
- package/src/api/serverDataType/Comment.ts +88 -0
- package/src/api/serverDataType/Event.ts +80 -0
- package/src/api/serverDataType/News.ts +138 -0
- package/src/api/serverDataType/Organization.ts +80 -0
- package/src/api/serverDataType/Project.ts +71 -0
- package/src/api/serverDataType/User.ts +103 -0
- package/src/api/serverDataType/common.ts +80 -0
- package/src/endpoints.module.ts +2621 -0
- package/src/error.ts +86 -0
- package/src/index.ts +86 -0
- package/src/mixin/UserMixin.ts +4 -0
- package/src/types/api-responses.ts +217 -0
- package/src/types/entities.ts +22 -0
- package/src/types/error-guards.ts +230 -0
- package/src/types/index.ts +39 -0
- package/src/types/payloads.ts +21 -0
- package/src/types/transforms.ts +110 -0
- package/src/utils/{FileOfflineStorageStrategy.node.js → FileOfflineStorageStrategy.node.ts} +15 -12
- package/src/utils/{FileStorageStrategy.node.js → FileStorageStrategy.node.ts} +16 -39
- package/src/utils/MultiServerFileStorageStrategy.node.ts +67 -0
- package/src/utils/MultiServerTokenStorageStrategy.ts +139 -0
- package/src/utils/{OfflineClientManager.js → OfflineClientManager.ts} +82 -86
- package/src/utils/OfflineQueueStorageStrategy.ts +47 -0
- package/src/utils/TokenStorage.ts +77 -0
- package/src/utils/compat.ts +12 -0
- package/src/utils/createDefaultMultiServerTokenStorageStrategy.ts +35 -0
- package/src/utils/{createDefaultOfflineStrategy.js → createDefaultOfflineStrategy.ts} +8 -3
- package/src/utils/createDefaultTokenStorageStrategy.ts +33 -0
- package/src/utils/{reactive.js → reactive.ts} +49 -40
- package/src/utils/stream-utils.node.ts +12 -0
- package/types/Api.d.ts +38 -82
- package/types/Api.d.ts.map +1 -0
- package/types/ApiClient.d.ts +244 -184
- package/types/ApiClient.d.ts.map +1 -0
- package/types/EJSONType.d.ts +48 -22
- package/types/EJSONType.d.ts.map +1 -0
- package/types/api/Badge.d.ts +20 -20
- package/types/api/Badge.d.ts.map +1 -0
- package/types/api/BaseEntity.d.ts +751 -446
- package/types/api/BaseEntity.d.ts.map +1 -0
- package/types/api/Comment.d.ts +36 -0
- package/types/api/EndpointApi.d.ts +347 -295
- package/types/api/EndpointApi.d.ts.map +1 -0
- package/types/api/EndpointApi.types.d.ts +3914 -4133
- package/types/api/EntityRegistry.d.ts +18 -16
- package/types/api/EntityRegistry.d.ts.map +1 -0
- package/types/api/Event.d.ts +119 -35
- package/types/api/Event.d.ts.map +1 -0
- package/types/api/News.d.ts +52 -20
- package/types/api/News.d.ts.map +1 -0
- package/types/api/Organization.d.ts +165 -49
- package/types/api/Organization.d.ts.map +1 -0
- package/types/api/Poi.d.ts +51 -22
- package/types/api/Poi.d.ts.map +1 -0
- package/types/api/Project.d.ts +151 -52
- package/types/api/Project.d.ts.map +1 -0
- package/types/api/User.d.ts +222 -93
- package/types/api/User.d.ts.map +1 -0
- package/types/api/UserApi.d.ts +60 -9
- package/types/api/UserApi.d.ts.map +1 -0
- package/types/api/serverDataType/Comment.d.ts +83 -0
- package/types/api/serverDataType/Event.d.ts +67 -0
- package/types/api/serverDataType/News.d.ts +130 -0
- package/types/api/serverDataType/Organization.d.ts +65 -0
- package/types/api/serverDataType/Organization.d.ts.map +1 -0
- package/types/api/serverDataType/Project.d.ts +58 -0
- package/types/api/serverDataType/Project.d.ts.map +1 -0
- package/types/api/serverDataType/User.d.ts +86 -0
- package/types/api/serverDataType/User.d.ts.map +1 -0
- package/types/api/serverDataType/common.d.ts +71 -0
- package/types/api/serverDataType/common.d.ts.map +1 -0
- package/types/endpoints.module.d.ts +6922 -1215
- package/types/endpoints.module.d.ts.map +1 -0
- package/types/error.d.ts +25 -51
- package/types/error.d.ts.map +1 -0
- package/types/index.d.ts +55 -48
- package/types/index.d.ts.map +1 -0
- package/types/mixin/UserMixin.d.ts +1 -1
- package/types/mixin/UserMixin.d.ts.map +1 -0
- package/types/types/api-responses.d.ts +190 -0
- package/types/types/api-responses.d.ts.map +1 -0
- package/types/types/entities.d.ts +17 -0
- package/types/types/entities.d.ts.map +1 -0
- package/types/types/error-guards.d.ts +99 -0
- package/types/types/error-guards.d.ts.map +1 -0
- package/types/types/index.d.ts +7 -0
- package/types/types/payloads.d.ts +17 -0
- package/types/types/payloads.d.ts.map +1 -0
- package/types/types/transforms.d.ts +79 -0
- package/types/types/transforms.d.ts.map +1 -0
- package/types/utils/FileOfflineStorageStrategy.node.d.ts +10 -9
- package/types/utils/FileOfflineStorageStrategy.node.d.ts.map +1 -0
- package/types/utils/FileStorageStrategy.node.d.ts +9 -20
- package/types/utils/FileStorageStrategy.node.d.ts.map +1 -0
- package/types/utils/MultiServerFileStorageStrategy.node.d.ts +13 -18
- package/types/utils/MultiServerFileStorageStrategy.node.d.ts.map +1 -0
- package/types/utils/MultiServerTokenStorageStrategy.d.ts +30 -51
- package/types/utils/MultiServerTokenStorageStrategy.d.ts.map +1 -0
- package/types/utils/OfflineClientManager.d.ts +52 -88
- package/types/utils/OfflineClientManager.d.ts.map +1 -0
- package/types/utils/OfflineQueueStorageStrategy.d.ts +12 -9
- package/types/utils/OfflineQueueStorageStrategy.d.ts.map +1 -0
- package/types/utils/TokenStorage.d.ts +20 -70
- package/types/utils/TokenStorage.d.ts.map +1 -0
- package/types/utils/compat.d.ts +4 -0
- package/types/utils/compat.d.ts.map +1 -0
- package/types/utils/createDefaultMultiServerTokenStorageStrategy.d.ts +2 -11
- package/types/utils/createDefaultMultiServerTokenStorageStrategy.d.ts.map +1 -0
- package/types/utils/createDefaultOfflineStrategy.d.ts +2 -3
- package/types/utils/createDefaultOfflineStrategy.d.ts.map +1 -0
- package/types/utils/createDefaultTokenStorageStrategy.d.ts +2 -12
- package/types/utils/createDefaultTokenStorageStrategy.d.ts.map +1 -0
- package/types/utils/reactive.d.ts +10 -16
- package/types/utils/reactive.d.ts.map +1 -0
- package/types/utils/stream-utils.node.d.ts +3 -2
- package/types/utils/stream-utils.node.d.ts.map +1 -0
- package/dist/123.cocolight-api-client.browser.js +0 -1
- package/dist/123.cocolight-api-client.cjs +0 -1
- package/dist/22.cocolight-api-client.mjs.js +0 -1
- package/dist/339.cocolight-api-client.mjs.js +0 -1
- package/dist/394.cocolight-api-client.browser.js +0 -1
- package/dist/394.cocolight-api-client.cjs +0 -1
- package/dist/405.cocolight-api-client.browser.js +0 -1
- package/dist/405.cocolight-api-client.cjs +0 -1
- package/dist/774.cocolight-api-client.mjs.js +0 -1
- package/dist/790.cocolight-api-client.mjs.js +0 -1
- package/dist/931.cocolight-api-client.browser.js +0 -1
- package/dist/931.cocolight-api-client.cjs +0 -1
- package/src/EJSONType.js +0 -53
- package/src/api/BaseEntity.js +0 -2828
- package/src/api/EntityRegistry.js +0 -152
- package/src/api/Event.js +0 -226
- package/src/api/News.js +0 -244
- package/src/api/UserApi.js +0 -81
- package/src/endpoints.module.js +0 -5
- package/src/error.js +0 -121
- package/src/index.js +0 -97
- package/src/mixin/UserMixin.js +0 -8
- package/src/utils/MultiServerFileStorageStrategy.node.js +0 -87
- package/src/utils/MultiServerTokenStorageStrategy.js +0 -188
- package/src/utils/OfflineQueueStorageStrategy.js +0 -51
- package/src/utils/TokenStorage.js +0 -153
- package/src/utils/createDefaultMultiServerTokenStorageStrategy.js +0 -51
- package/src/utils/createDefaultTokenStorageStrategy.js +0 -49
- package/src/utils/stream-utils.node.js +0 -10
|
@@ -1,28 +1,45 @@
|
|
|
1
1
|
// Fichier généré automatiquement
|
|
2
|
-
// @ts-check
|
|
3
2
|
import { ApiAuthenticationError } from "../error.js";
|
|
4
3
|
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
*/
|
|
4
|
+
import type ApiClient from "../ApiClient.js";
|
|
5
|
+
import type { PersonRegisterData, AuthenticateUrlData, RefreshTokenUrlData, PasswordRecoveryData, ServerExchangeTokenData, ChangePasswordData, DeleteAccountData, UpdateSettingsData, UpdateBlockDescriptionData, UpdateBlockInfoData, UpdateBlockSocialData, UpdateBlockLocalityData, UpdateBlockSlugData, CheckData, ProfilImageData, GetElementsAboutData, MulticonnectData, GetNewsData, GetNewsByIdData, AddNewsData, AddImageNewsData, AddFileNewsData, DeleteNewsData, UpdateNewsData, ShareNewsData, GetCommentsData, AddCommentsData, DeleteCommentsData, UpdateCommentsData, SearchTagsData, ShowVoteData, GlobalAutocompleteData, CityAutocompleteData, CityAutocompleteByCountryData, SuggestionInputData, GetProjectsNoAdminData, GetProjectsAdminData, GetPoisNoAdminData, GetPoisAdminData, GetOrganizationsNoAdminData, GetOrganizationsAdminData, GetMembersNoAdminData, GetMembersAdminData, GetFriendsAdminData, GetSubscriptionsData, GetSubscriptionsAdminData, GetSubscribersData, GetSubscribersAdminData, GetContributorsNoAdminData, GetContributorsAdminData, GetBadgesData, GetBadgesFiltersData, ConnectData, DisconnectData, GetElementsKeyData, GetFavorisData, DeleteFavorisData, AddFavorisData, AddOrganizationData, AddProjectData, AddPoiData, AddEventData, DeletePoiData, DeleteEventData, DeleteElementData, AddImageElementData, LinkValidateData, SearchMemberAutocompleteData, GetNotificationsData, GetNotificationsCountData, NotificationUpdateData, MarkNotificationAsReadData, ActivitypubSearchData, ActivitypubLinkData, ActivitypubGetCommunityData, GetBadgeData, AddBadgesData, AssignBadgesData, GetEventsData, ShareEventsData, InviteEventData, FollowData, GetCostumJsonData, GlobalAutocompleteCostumData, CostumEventRequestActorsData, CostumEventRequestSubeventsData, CostumEventRequestElementEventData, CostumEventRequestCategoriesData, CostumEventRequestDatesData, CostumEventRequestEventData, CostumEventRequestLinkTlToEventData, CostumEventRequestLoadContextTagData, GetGalleryData, GetAttendeesNoAdminData, GetAttendeesAdminData } from "./EndpointApi.types.js";
|
|
8
6
|
|
|
9
7
|
/**
|
|
10
8
|
* Classe EndpointApi générée automatiquement depuis endpoints-copie.json
|
|
11
9
|
*/
|
|
12
|
-
class EndpointApi {
|
|
13
|
-
|
|
10
|
+
export class EndpointApi {
|
|
11
|
+
apiClient: ApiClient;
|
|
12
|
+
|
|
13
|
+
/**
|
|
14
|
+
* @param {ApiClient} apiClient - Instance du client API utilisée pour exécuter les appels.
|
|
15
|
+
*/
|
|
16
|
+
constructor(apiClient: ApiClient) {
|
|
14
17
|
this.apiClient = apiClient;
|
|
15
18
|
}
|
|
16
19
|
|
|
17
|
-
|
|
20
|
+
/**
|
|
21
|
+
* Indique si un utilisateur est actuellement connecté.
|
|
22
|
+
*/
|
|
23
|
+
get isConnected(): boolean {
|
|
18
24
|
return this.apiClient.isConnected;
|
|
19
25
|
}
|
|
20
26
|
|
|
21
|
-
|
|
27
|
+
/**
|
|
28
|
+
* Identifiant de l'utilisateur connecté (s'il y en a un).
|
|
29
|
+
*/
|
|
30
|
+
get userId(): string | null {
|
|
22
31
|
return this.apiClient.userId;
|
|
23
32
|
}
|
|
24
33
|
|
|
25
|
-
|
|
34
|
+
/**
|
|
35
|
+
* Appelle un endpoint de l'API de façon sécurisée et retourne la donnée.
|
|
36
|
+
* @template T
|
|
37
|
+
* @param {string} constant - La constante représentant l'endpoint à appeler.
|
|
38
|
+
* @param {object} [data={}] - Données envoyées à l'API.
|
|
39
|
+
* @returns {Promise<T>} Résultat de la requête.
|
|
40
|
+
* @throws {ApiResponseError} En cas d'erreur de l'API.
|
|
41
|
+
*/
|
|
42
|
+
async call<T>(constant: string, data: any = {}): Promise<T> {
|
|
26
43
|
return this.apiClient.safeCall(async () => {
|
|
27
44
|
const response = await this.apiClient.callEndpoint(constant, data);
|
|
28
45
|
this.apiClient.checkAndThrowApiResponseError(response);
|
|
@@ -30,14 +47,32 @@ class EndpointApi {
|
|
|
30
47
|
});
|
|
31
48
|
}
|
|
32
49
|
|
|
33
|
-
|
|
50
|
+
/**
|
|
51
|
+
* Appelle un endpoint qui nécessite que l’utilisateur ne soit **pas** connecté.
|
|
52
|
+
* @template T
|
|
53
|
+
* @param {string} constant - La constante représentant l'endpoint à appeler.
|
|
54
|
+
* @param {object} [data={}] - Données envoyées à l’API.
|
|
55
|
+
* @returns {Promise<T>} Résultat de la requête.
|
|
56
|
+
* @throws {ApiAuthenticationError} Si l’utilisateur est connecté.
|
|
57
|
+
* @throws {ApiResponseError} En cas d'erreur de l'API.
|
|
58
|
+
*/
|
|
59
|
+
async callNoConnected<T>(constant: string, data: any = {}): Promise<T> {
|
|
34
60
|
if (this.isConnected) {
|
|
35
61
|
throw new ApiAuthenticationError("Vous ne devez pas être connecté pour faire cette action.", 403);
|
|
36
62
|
}
|
|
37
63
|
return this.call(constant, data);
|
|
38
64
|
}
|
|
39
|
-
|
|
40
|
-
|
|
65
|
+
|
|
66
|
+
/**
|
|
67
|
+
* Appelle un endpoint qui nécessite que l’utilisateur soit connecté.
|
|
68
|
+
* @template T
|
|
69
|
+
* @param {string} constant - La constante représentant l'endpoint à appeler.
|
|
70
|
+
* @param {object} [data={}] - Données envoyées à l’API.
|
|
71
|
+
* @returns {Promise<T>} Résultat de la requête.
|
|
72
|
+
* @throws {ApiAuthenticationError} Si l’utilisateur n’est pas connecté.
|
|
73
|
+
* @throws {ApiResponseError} En cas d'erreur de l'API.
|
|
74
|
+
*/
|
|
75
|
+
async callIsConnected<T>(constant: string, data: any = {}): Promise<T> {
|
|
41
76
|
if (!this.isConnected) {
|
|
42
77
|
throw new ApiAuthenticationError("Vous devez être connecté pour effectuer cette action.", 401);
|
|
43
78
|
}
|
|
@@ -48,12 +83,12 @@ class EndpointApi {
|
|
|
48
83
|
/**
|
|
49
84
|
* Enregistrement d'un utilisateur : Permet d’enregistrer un nouvel utilisateur avec ses informations personnelles.
|
|
50
85
|
* Constant : PERSON_REGISTER
|
|
51
|
-
* @param
|
|
52
|
-
* @returns
|
|
86
|
+
* @param data - Données envoyées à l'API
|
|
87
|
+
* @returns Les données de réponse.
|
|
53
88
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
54
89
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
55
90
|
*/
|
|
56
|
-
async personRegister(data) {
|
|
91
|
+
async personRegister(data: PersonRegisterData): Promise<any> {
|
|
57
92
|
if (!data || typeof data !== "object") {
|
|
58
93
|
throw new TypeError("Le paramètre data doit être un objet.");
|
|
59
94
|
}
|
|
@@ -63,12 +98,12 @@ class EndpointApi {
|
|
|
63
98
|
/**
|
|
64
99
|
* Authentification : Permet de se connecter en utilisant une adresse email et un mot de passe.
|
|
65
100
|
* Constant : AUTHENTICATE_URL
|
|
66
|
-
* @param
|
|
67
|
-
* @returns
|
|
101
|
+
* @param data - Données envoyées à l'API
|
|
102
|
+
* @returns Les données de réponse.
|
|
68
103
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
69
104
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
70
105
|
*/
|
|
71
|
-
async authenticateUrl(data) {
|
|
106
|
+
async authenticateUrl(data: AuthenticateUrlData): Promise<any> {
|
|
72
107
|
if (!data || typeof data !== "object") {
|
|
73
108
|
throw new TypeError("Le paramètre data doit être un objet.");
|
|
74
109
|
}
|
|
@@ -78,12 +113,12 @@ class EndpointApi {
|
|
|
78
113
|
/**
|
|
79
114
|
* Rafraîchir un token : Permet de rafraîchir un token d'accès expiré en utilisant un token de rafraîchissement.
|
|
80
115
|
* Constant : REFRESH_TOKEN_URL
|
|
81
|
-
* @param
|
|
82
|
-
* @returns
|
|
116
|
+
* @param data - Données envoyées à l'API
|
|
117
|
+
* @returns Les données de réponse.
|
|
83
118
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
84
119
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
85
120
|
*/
|
|
86
|
-
async refreshTokenUrl(data) {
|
|
121
|
+
async refreshTokenUrl(data: RefreshTokenUrlData): Promise<any> {
|
|
87
122
|
if (!data || typeof data !== "object") {
|
|
88
123
|
throw new TypeError("Le paramètre data doit être un objet.");
|
|
89
124
|
}
|
|
@@ -93,24 +128,24 @@ class EndpointApi {
|
|
|
93
128
|
/**
|
|
94
129
|
* Récupérer les informations utilisateur : Récupère les informations du profil utilisateur pour un token donné.
|
|
95
130
|
* Constant : ME_INFO_URL
|
|
96
|
-
* @returns
|
|
131
|
+
* @returns Les données de réponse.
|
|
97
132
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
98
133
|
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
99
134
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
100
135
|
*/
|
|
101
|
-
async meInfoUrl() {
|
|
136
|
+
async meInfoUrl(): Promise<any> {
|
|
102
137
|
return this.callIsConnected("ME_INFO_URL");
|
|
103
138
|
}
|
|
104
139
|
|
|
105
140
|
/**
|
|
106
141
|
* Récupération de mot de passe : Envoie un email pour récupérer le mot de passe.
|
|
107
142
|
* Constant : PASSWORD_RECOVERY
|
|
108
|
-
* @param
|
|
109
|
-
* @returns
|
|
143
|
+
* @param data - Données envoyées à l'API
|
|
144
|
+
* @returns Les données de réponse.
|
|
110
145
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
111
146
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
112
147
|
*/
|
|
113
|
-
async passwordRecovery(data) {
|
|
148
|
+
async passwordRecovery(data: PasswordRecoveryData): Promise<any> {
|
|
114
149
|
if (!data || typeof data !== "object") {
|
|
115
150
|
throw new TypeError("Le paramètre data doit être un objet.");
|
|
116
151
|
}
|
|
@@ -120,13 +155,13 @@ class EndpointApi {
|
|
|
120
155
|
/**
|
|
121
156
|
* Échange de token avec un autre serveur : Permet de se connecter à un autre serveur Communecter en échangeant un token.
|
|
122
157
|
* Constant : SERVER_EXCHANGE_TOKEN
|
|
123
|
-
* @param
|
|
124
|
-
* @returns
|
|
158
|
+
* @param data - Données envoyées à l'API
|
|
159
|
+
* @returns Les données de réponse.
|
|
125
160
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
126
161
|
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
127
162
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
128
163
|
*/
|
|
129
|
-
async serverExchangeToken(data) {
|
|
164
|
+
async serverExchangeToken(data: ServerExchangeTokenData): Promise<any> {
|
|
130
165
|
if (!data || typeof data !== "object") {
|
|
131
166
|
throw new TypeError("Le paramètre data doit être un objet.");
|
|
132
167
|
}
|
|
@@ -136,13 +171,13 @@ class EndpointApi {
|
|
|
136
171
|
/**
|
|
137
172
|
* Changer le mot de passe : Permet de changer le mot de passe d'un utilisateur.
|
|
138
173
|
* Constant : CHANGE_PASSWORD
|
|
139
|
-
* @param
|
|
140
|
-
* @returns
|
|
174
|
+
* @param data - Données envoyées à l'API
|
|
175
|
+
* @returns Les données de réponse.
|
|
141
176
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
142
177
|
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
143
178
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
144
179
|
*/
|
|
145
|
-
async changePassword(data) {
|
|
180
|
+
async changePassword(data: ChangePasswordData): Promise<any> {
|
|
146
181
|
if (!data || typeof data !== "object") {
|
|
147
182
|
throw new TypeError("Le paramètre data doit être un objet.");
|
|
148
183
|
}
|
|
@@ -152,13 +187,13 @@ class EndpointApi {
|
|
|
152
187
|
/**
|
|
153
188
|
* Supprimer un compte : Permet de supprimer un compte utilisateur.
|
|
154
189
|
* Constant : DELETE_ACCOUNT
|
|
155
|
-
* @param
|
|
156
|
-
* @returns
|
|
190
|
+
* @param data - Données envoyées à l'API
|
|
191
|
+
* @returns Les données de réponse.
|
|
157
192
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
158
193
|
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
159
194
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
160
195
|
*/
|
|
161
|
-
async deleteAccount(data) {
|
|
196
|
+
async deleteAccount(data: DeleteAccountData): Promise<any> {
|
|
162
197
|
if (!data || typeof data !== "object") {
|
|
163
198
|
throw new TypeError("Le paramètre data doit être un objet.");
|
|
164
199
|
}
|
|
@@ -168,13 +203,13 @@ class EndpointApi {
|
|
|
168
203
|
/**
|
|
169
204
|
* Mettre à jour les paramètres d'un élément : Mise à jour des paramètres spécifiques d'un élément.
|
|
170
205
|
* Constant : UPDATE_SETTINGS
|
|
171
|
-
* @param
|
|
172
|
-
* @returns
|
|
206
|
+
* @param data - Données envoyées à l'API
|
|
207
|
+
* @returns Les données de réponse.
|
|
173
208
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
174
209
|
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
175
210
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
176
211
|
*/
|
|
177
|
-
async updateSettings(data) {
|
|
212
|
+
async updateSettings(data: UpdateSettingsData): Promise<any> {
|
|
178
213
|
if (!data || typeof data !== "object") {
|
|
179
214
|
throw new TypeError("Le paramètre data doit être un objet.");
|
|
180
215
|
}
|
|
@@ -184,13 +219,13 @@ class EndpointApi {
|
|
|
184
219
|
/**
|
|
185
220
|
* Mettre à jour la description d'un élément : Permet de mettre à jour la description courte et complète d'un élément.
|
|
186
221
|
* Constant : UPDATE_BLOCK_DESCRIPTION
|
|
187
|
-
* @param
|
|
188
|
-
* @returns
|
|
222
|
+
* @param data - Données envoyées à l'API
|
|
223
|
+
* @returns Les données de réponse.
|
|
189
224
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
190
225
|
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
191
226
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
192
227
|
*/
|
|
193
|
-
async updateBlockDescription(data) {
|
|
228
|
+
async updateBlockDescription(data: UpdateBlockDescriptionData): Promise<any> {
|
|
194
229
|
if (!data || typeof data !== "object") {
|
|
195
230
|
throw new TypeError("Le paramètre data doit être un objet.");
|
|
196
231
|
}
|
|
@@ -200,13 +235,13 @@ class EndpointApi {
|
|
|
200
235
|
/**
|
|
201
236
|
* Mettre à jour les informations d'un élément : Permet de mettre à jour les informations générales d'un élément (nom, contacts, etc.).
|
|
202
237
|
* Constant : UPDATE_BLOCK_INFO
|
|
203
|
-
* @param
|
|
204
|
-
* @returns
|
|
238
|
+
* @param data - Données envoyées à l'API
|
|
239
|
+
* @returns Les données de réponse.
|
|
205
240
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
206
241
|
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
207
242
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
208
243
|
*/
|
|
209
|
-
async updateBlockInfo(data) {
|
|
244
|
+
async updateBlockInfo(data: UpdateBlockInfoData): Promise<any> {
|
|
210
245
|
if (!data || typeof data !== "object") {
|
|
211
246
|
throw new TypeError("Le paramètre data doit être un objet.");
|
|
212
247
|
}
|
|
@@ -216,13 +251,13 @@ class EndpointApi {
|
|
|
216
251
|
/**
|
|
217
252
|
* Mettre à jour les réseaux sociaux d'un élément : Permet de mettre à jour les liens vers les réseaux sociaux d'un élément.
|
|
218
253
|
* Constant : UPDATE_BLOCK_SOCIAL
|
|
219
|
-
* @param
|
|
220
|
-
* @returns
|
|
254
|
+
* @param data - Données envoyées à l'API
|
|
255
|
+
* @returns Les données de réponse.
|
|
221
256
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
222
257
|
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
223
258
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
224
259
|
*/
|
|
225
|
-
async updateBlockSocial(data) {
|
|
260
|
+
async updateBlockSocial(data: UpdateBlockSocialData): Promise<any> {
|
|
226
261
|
if (!data || typeof data !== "object") {
|
|
227
262
|
throw new TypeError("Le paramètre data doit être un objet.");
|
|
228
263
|
}
|
|
@@ -232,13 +267,13 @@ class EndpointApi {
|
|
|
232
267
|
/**
|
|
233
268
|
* Mettre à jour les localités d'un élément : Permet de mettre à jour l'adresse et les informations géographiques d'un élément.
|
|
234
269
|
* Constant : UPDATE_BLOCK_LOCALITY
|
|
235
|
-
* @param
|
|
236
|
-
* @returns
|
|
270
|
+
* @param data - Données envoyées à l'API
|
|
271
|
+
* @returns Les données de réponse.
|
|
237
272
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
238
273
|
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
239
274
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
240
275
|
*/
|
|
241
|
-
async updateBlockLocality(data) {
|
|
276
|
+
async updateBlockLocality(data: UpdateBlockLocalityData): Promise<any> {
|
|
242
277
|
if (!data || typeof data !== "object") {
|
|
243
278
|
throw new TypeError("Le paramètre data doit être un objet.");
|
|
244
279
|
}
|
|
@@ -248,13 +283,13 @@ class EndpointApi {
|
|
|
248
283
|
/**
|
|
249
284
|
* Mettre à jour le slug d'un élément : Permet de mettre à jour le slug pour une URL simplifiée.
|
|
250
285
|
* Constant : UPDATE_BLOCK_SLUG
|
|
251
|
-
* @param
|
|
252
|
-
* @returns
|
|
286
|
+
* @param data - Données envoyées à l'API
|
|
287
|
+
* @returns Les données de réponse.
|
|
253
288
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
254
289
|
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
255
290
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
256
291
|
*/
|
|
257
|
-
async updateBlockSlug(data) {
|
|
292
|
+
async updateBlockSlug(data: UpdateBlockSlugData): Promise<any> {
|
|
258
293
|
if (!data || typeof data !== "object") {
|
|
259
294
|
throw new TypeError("Le paramètre data doit être un objet.");
|
|
260
295
|
}
|
|
@@ -264,13 +299,13 @@ class EndpointApi {
|
|
|
264
299
|
/**
|
|
265
300
|
* Vérifier l'état d'une URL : Vérifie si une URL (slug) est valide ou disponible.
|
|
266
301
|
* Constant : CHECK
|
|
267
|
-
* @param
|
|
268
|
-
* @returns
|
|
302
|
+
* @param data - Données envoyées à l'API
|
|
303
|
+
* @returns Les données de réponse.
|
|
269
304
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
270
305
|
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
271
306
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
272
307
|
*/
|
|
273
|
-
async check(data) {
|
|
308
|
+
async check(data: CheckData): Promise<any> {
|
|
274
309
|
if (!data || typeof data !== "object") {
|
|
275
310
|
throw new TypeError("Le paramètre data doit être un objet.");
|
|
276
311
|
}
|
|
@@ -280,13 +315,13 @@ class EndpointApi {
|
|
|
280
315
|
/**
|
|
281
316
|
* Mettre à jour l'image de profil : Permet de mettre à jour l'image de profil d'un utilisateur ou d'une entité.
|
|
282
317
|
* Constant : PROFIL_IMAGE
|
|
283
|
-
* @param
|
|
284
|
-
* @returns
|
|
318
|
+
* @param data - Données envoyées à l'API
|
|
319
|
+
* @returns Les données de réponse.
|
|
285
320
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
286
321
|
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
287
322
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
288
323
|
*/
|
|
289
|
-
async profilImage(data) {
|
|
324
|
+
async profilImage(data: ProfilImageData): Promise<any> {
|
|
290
325
|
if (!data || typeof data !== "object") {
|
|
291
326
|
throw new TypeError("Le paramètre data doit être un objet.");
|
|
292
327
|
}
|
|
@@ -296,12 +331,12 @@ class EndpointApi {
|
|
|
296
331
|
/**
|
|
297
332
|
* Obtenir les éléments liés : Récupère les informations détaillées d'un élément et de ses éléments liés.
|
|
298
333
|
* Constant : GET_ELEMENTS_ABOUT
|
|
299
|
-
* @param
|
|
300
|
-
* @returns
|
|
334
|
+
* @param data - Données envoyées à l'API
|
|
335
|
+
* @returns Les données de réponse.
|
|
301
336
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
302
337
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
303
338
|
*/
|
|
304
|
-
async getElementsAbout(data) {
|
|
339
|
+
async getElementsAbout(data: GetElementsAboutData): Promise<any> {
|
|
305
340
|
if (!data || typeof data !== "object") {
|
|
306
341
|
throw new TypeError("Le paramètre data doit être un objet.");
|
|
307
342
|
}
|
|
@@ -311,13 +346,13 @@ class EndpointApi {
|
|
|
311
346
|
/**
|
|
312
347
|
* Gérer des connexions multiples : Permet d’inviter ou de connecter plusieurs utilisateurs en même temps à une entité.
|
|
313
348
|
* Constant : MULTICONNECT
|
|
314
|
-
* @param
|
|
315
|
-
* @returns
|
|
349
|
+
* @param data - Données envoyées à l'API
|
|
350
|
+
* @returns Les données de réponse.
|
|
316
351
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
317
352
|
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
318
353
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
319
354
|
*/
|
|
320
|
-
async multiconnect(data) {
|
|
355
|
+
async multiconnect(data: MulticonnectData): Promise<any> {
|
|
321
356
|
if (!data || typeof data !== "object") {
|
|
322
357
|
throw new TypeError("Le paramètre data doit être un objet.");
|
|
323
358
|
}
|
|
@@ -327,12 +362,12 @@ class EndpointApi {
|
|
|
327
362
|
/**
|
|
328
363
|
* Récupérer les actualités : Récupère la liste d’actualités selon plusieurs critères.
|
|
329
364
|
* Constant : GET_NEWS
|
|
330
|
-
* @param
|
|
331
|
-
* @returns
|
|
365
|
+
* @param data - Données envoyées à l'API
|
|
366
|
+
* @returns Les données de réponse.
|
|
332
367
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
333
368
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
334
369
|
*/
|
|
335
|
-
async getNews(data) {
|
|
370
|
+
async getNews(data: GetNewsData): Promise<any> {
|
|
336
371
|
if (!data || typeof data !== "object") {
|
|
337
372
|
throw new TypeError("Le paramètre data doit être un objet.");
|
|
338
373
|
}
|
|
@@ -342,12 +377,12 @@ class EndpointApi {
|
|
|
342
377
|
/**
|
|
343
378
|
* Récupérer des actualités par IDs : Récupère des actualités à partir d’une liste d’identifiants.
|
|
344
379
|
* Constant : GET_NEWS_BY_ID
|
|
345
|
-
* @param
|
|
346
|
-
* @returns
|
|
380
|
+
* @param data - Données envoyées à l'API
|
|
381
|
+
* @returns Les données de réponse.
|
|
347
382
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
348
383
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
349
384
|
*/
|
|
350
|
-
async getNewsById(data) {
|
|
385
|
+
async getNewsById(data: GetNewsByIdData): Promise<any> {
|
|
351
386
|
if (!data || typeof data !== "object") {
|
|
352
387
|
throw new TypeError("Le paramètre data doit être un objet.");
|
|
353
388
|
}
|
|
@@ -357,13 +392,13 @@ class EndpointApi {
|
|
|
357
392
|
/**
|
|
358
393
|
* Ajouter une actualité : Ajoute une nouvelle actualité.
|
|
359
394
|
* Constant : ADD_NEWS
|
|
360
|
-
* @param
|
|
361
|
-
* @returns
|
|
395
|
+
* @param data - Données envoyées à l'API
|
|
396
|
+
* @returns Les données de réponse.
|
|
362
397
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
363
398
|
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
364
399
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
365
400
|
*/
|
|
366
|
-
async addNews(data) {
|
|
401
|
+
async addNews(data: AddNewsData): Promise<any> {
|
|
367
402
|
if (!data || typeof data !== "object") {
|
|
368
403
|
throw new TypeError("Le paramètre data doit être un objet.");
|
|
369
404
|
}
|
|
@@ -373,13 +408,13 @@ class EndpointApi {
|
|
|
373
408
|
/**
|
|
374
409
|
* Ajouter une image à une actualité : Ajoute une images à une actualité.
|
|
375
410
|
* Constant : ADD_IMAGE_NEWS
|
|
376
|
-
* @param
|
|
377
|
-
* @returns
|
|
411
|
+
* @param data - Données envoyées à l'API
|
|
412
|
+
* @returns Les données de réponse.
|
|
378
413
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
379
414
|
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
380
415
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
381
416
|
*/
|
|
382
|
-
async addImageNews(data) {
|
|
417
|
+
async addImageNews(data: AddImageNewsData): Promise<any> {
|
|
383
418
|
if (!data || typeof data !== "object") {
|
|
384
419
|
throw new TypeError("Le paramètre data doit être un objet.");
|
|
385
420
|
}
|
|
@@ -389,13 +424,13 @@ class EndpointApi {
|
|
|
389
424
|
/**
|
|
390
425
|
* Ajouter un fichier à une actualité : Ajoute un fichier à une actualité.
|
|
391
426
|
* Constant : ADD_FILE_NEWS
|
|
392
|
-
* @param
|
|
393
|
-
* @returns
|
|
427
|
+
* @param data - Données envoyées à l'API
|
|
428
|
+
* @returns Les données de réponse.
|
|
394
429
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
395
430
|
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
396
431
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
397
432
|
*/
|
|
398
|
-
async addFileNews(data) {
|
|
433
|
+
async addFileNews(data: AddFileNewsData): Promise<any> {
|
|
399
434
|
if (!data || typeof data !== "object") {
|
|
400
435
|
throw new TypeError("Le paramètre data doit être un objet.");
|
|
401
436
|
}
|
|
@@ -405,13 +440,13 @@ class EndpointApi {
|
|
|
405
440
|
/**
|
|
406
441
|
* Supprimer une actualité : Supprime une actualité existante.
|
|
407
442
|
* Constant : DELETE_NEWS
|
|
408
|
-
* @param
|
|
409
|
-
* @returns
|
|
443
|
+
* @param data - Données envoyées à l'API
|
|
444
|
+
* @returns Les données de réponse.
|
|
410
445
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
411
446
|
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
412
447
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
413
448
|
*/
|
|
414
|
-
async deleteNews(data) {
|
|
449
|
+
async deleteNews(data: DeleteNewsData): Promise<any> {
|
|
415
450
|
if (!data || typeof data !== "object") {
|
|
416
451
|
throw new TypeError("Le paramètre data doit être un objet.");
|
|
417
452
|
}
|
|
@@ -421,13 +456,13 @@ class EndpointApi {
|
|
|
421
456
|
/**
|
|
422
457
|
* Mettre à jour une actualité : Met à jour le contenu d’une actualité existante.
|
|
423
458
|
* Constant : UPDATE_NEWS
|
|
424
|
-
* @param
|
|
425
|
-
* @returns
|
|
459
|
+
* @param data - Données envoyées à l'API
|
|
460
|
+
* @returns Les données de réponse.
|
|
426
461
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
427
462
|
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
428
463
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
429
464
|
*/
|
|
430
|
-
async updateNews(data) {
|
|
465
|
+
async updateNews(data: UpdateNewsData): Promise<any> {
|
|
431
466
|
if (!data || typeof data !== "object") {
|
|
432
467
|
throw new TypeError("Le paramètre data doit être un objet.");
|
|
433
468
|
}
|
|
@@ -437,13 +472,13 @@ class EndpointApi {
|
|
|
437
472
|
/**
|
|
438
473
|
* Partager une actualité : Partage une actualité avec une entité ou un utilisateur.
|
|
439
474
|
* Constant : SHARE_NEWS
|
|
440
|
-
* @param
|
|
441
|
-
* @returns
|
|
475
|
+
* @param data - Données envoyées à l'API
|
|
476
|
+
* @returns Les données de réponse.
|
|
442
477
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
443
478
|
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
444
479
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
445
480
|
*/
|
|
446
|
-
async shareNews(data) {
|
|
481
|
+
async shareNews(data: ShareNewsData): Promise<any> {
|
|
447
482
|
if (!data || typeof data !== "object") {
|
|
448
483
|
throw new TypeError("Le paramètre data doit être un objet.");
|
|
449
484
|
}
|
|
@@ -453,12 +488,12 @@ class EndpointApi {
|
|
|
453
488
|
/**
|
|
454
489
|
* Récupérer les commentaires : Récupère les commentaires d’un élément.
|
|
455
490
|
* Constant : GET_COMMENTS
|
|
456
|
-
* @param
|
|
457
|
-
* @returns
|
|
491
|
+
* @param data - Données envoyées à l'API
|
|
492
|
+
* @returns Les données de réponse.
|
|
458
493
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
459
494
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
460
495
|
*/
|
|
461
|
-
async getComments(data) {
|
|
496
|
+
async getComments(data: GetCommentsData): Promise<any> {
|
|
462
497
|
if (!data || typeof data !== "object") {
|
|
463
498
|
throw new TypeError("Le paramètre data doit être un objet.");
|
|
464
499
|
}
|
|
@@ -468,13 +503,13 @@ class EndpointApi {
|
|
|
468
503
|
/**
|
|
469
504
|
* Ajouter un commentaire : Ajoute un commentaire à une actualité ou autre contexte.
|
|
470
505
|
* Constant : ADD_COMMENTS
|
|
471
|
-
* @param
|
|
472
|
-
* @returns
|
|
506
|
+
* @param data - Données envoyées à l'API
|
|
507
|
+
* @returns Les données de réponse.
|
|
473
508
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
474
509
|
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
475
510
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
476
511
|
*/
|
|
477
|
-
async addComments(data) {
|
|
512
|
+
async addComments(data: AddCommentsData): Promise<any> {
|
|
478
513
|
if (!data || typeof data !== "object") {
|
|
479
514
|
throw new TypeError("Le paramètre data doit être un objet.");
|
|
480
515
|
}
|
|
@@ -484,13 +519,13 @@ class EndpointApi {
|
|
|
484
519
|
/**
|
|
485
520
|
* Supprimer un commentaire : Supprime un commentaire existant.
|
|
486
521
|
* Constant : DELETE_COMMENTS
|
|
487
|
-
* @param
|
|
488
|
-
* @returns
|
|
522
|
+
* @param data - Données envoyées à l'API
|
|
523
|
+
* @returns Les données de réponse.
|
|
489
524
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
490
525
|
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
491
526
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
492
527
|
*/
|
|
493
|
-
async deleteComments(data) {
|
|
528
|
+
async deleteComments(data: DeleteCommentsData): Promise<any> {
|
|
494
529
|
if (!data || typeof data !== "object") {
|
|
495
530
|
throw new TypeError("Le paramètre data doit être un objet.");
|
|
496
531
|
}
|
|
@@ -500,13 +535,13 @@ class EndpointApi {
|
|
|
500
535
|
/**
|
|
501
536
|
* Mettre à jour un commentaire : Met à jour le contenu d’un commentaire.
|
|
502
537
|
* Constant : UPDATE_COMMENTS
|
|
503
|
-
* @param
|
|
504
|
-
* @returns
|
|
538
|
+
* @param data - Données envoyées à l'API
|
|
539
|
+
* @returns Les données de réponse.
|
|
505
540
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
506
541
|
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
507
542
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
508
543
|
*/
|
|
509
|
-
async updateComments(data) {
|
|
544
|
+
async updateComments(data: UpdateCommentsData): Promise<any> {
|
|
510
545
|
if (!data || typeof data !== "object") {
|
|
511
546
|
throw new TypeError("Le paramètre data doit être un objet.");
|
|
512
547
|
}
|
|
@@ -516,12 +551,12 @@ class EndpointApi {
|
|
|
516
551
|
/**
|
|
517
552
|
* Rechercher des tags : Recherche des tags correspondant à un mot-clé.
|
|
518
553
|
* Constant : SEARCH_TAGS
|
|
519
|
-
* @param
|
|
520
|
-
* @returns
|
|
554
|
+
* @param data - Données envoyées à l'API
|
|
555
|
+
* @returns Les données de réponse.
|
|
521
556
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
522
557
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
523
558
|
*/
|
|
524
|
-
async searchTags(data) {
|
|
559
|
+
async searchTags(data: SearchTagsData): Promise<any> {
|
|
525
560
|
if (!data || typeof data !== "object") {
|
|
526
561
|
throw new TypeError("Le paramètre data doit être un objet.");
|
|
527
562
|
}
|
|
@@ -531,12 +566,12 @@ class EndpointApi {
|
|
|
531
566
|
/**
|
|
532
567
|
* Afficher les votes d'une actualité : Récupère la liste des votes (like, love, etc.) sur une actualité.
|
|
533
568
|
* Constant : SHOW_VOTE
|
|
534
|
-
* @param
|
|
535
|
-
* @returns
|
|
569
|
+
* @param data - Données envoyées à l'API
|
|
570
|
+
* @returns Les données de réponse.
|
|
536
571
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
537
572
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
538
573
|
*/
|
|
539
|
-
async showVote(data) {
|
|
574
|
+
async showVote(data: ShowVoteData): Promise<any> {
|
|
540
575
|
if (!data || typeof data !== "object") {
|
|
541
576
|
throw new TypeError("Le paramètre data doit être un objet.");
|
|
542
577
|
}
|
|
@@ -546,12 +581,12 @@ class EndpointApi {
|
|
|
546
581
|
/**
|
|
547
582
|
* Recherche globale avec autocomplétion : Effectue une recherche globale avec possibilité d’autocomplétion.
|
|
548
583
|
* Constant : GLOBAL_AUTOCOMPLETE
|
|
549
|
-
* @param
|
|
550
|
-
* @returns
|
|
584
|
+
* @param data - Données envoyées à l'API
|
|
585
|
+
* @returns Les données de réponse.
|
|
551
586
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
552
587
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
553
588
|
*/
|
|
554
|
-
async globalAutocomplete(data) {
|
|
589
|
+
async globalAutocomplete(data: GlobalAutocompleteData): Promise<any> {
|
|
555
590
|
if (!data || typeof data !== "object") {
|
|
556
591
|
throw new TypeError("Le paramètre data doit être un objet.");
|
|
557
592
|
}
|
|
@@ -561,12 +596,12 @@ class EndpointApi {
|
|
|
561
596
|
/**
|
|
562
597
|
* Recherche de villes avec autocomplétion : Recherche des villes en fonction d’un nom, autocomplétion rapide.
|
|
563
598
|
* Constant : CITY_AUTOCOMPLETE
|
|
564
|
-
* @param
|
|
565
|
-
* @returns
|
|
599
|
+
* @param data - Données envoyées à l'API
|
|
600
|
+
* @returns Les données de réponse.
|
|
566
601
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
567
602
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
568
603
|
*/
|
|
569
|
-
async cityAutocomplete(data) {
|
|
604
|
+
async cityAutocomplete(data: CityAutocompleteData): Promise<any> {
|
|
570
605
|
if (!data || typeof data !== "object") {
|
|
571
606
|
throw new TypeError("Le paramètre data doit être un objet.");
|
|
572
607
|
}
|
|
@@ -576,12 +611,12 @@ class EndpointApi {
|
|
|
576
611
|
/**
|
|
577
612
|
* Recherche de villes par pays : Recherche de villes par pays avec autocomplétion.
|
|
578
613
|
* Constant : CITY_AUTOCOMPLETE_BY_COUNTRY
|
|
579
|
-
* @param
|
|
580
|
-
* @returns
|
|
614
|
+
* @param data - Données envoyées à l'API
|
|
615
|
+
* @returns Les données de réponse.
|
|
581
616
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
582
617
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
583
618
|
*/
|
|
584
|
-
async cityAutocompleteByCountry(data) {
|
|
619
|
+
async cityAutocompleteByCountry(data: CityAutocompleteByCountryData): Promise<any> {
|
|
585
620
|
if (!data || typeof data !== "object") {
|
|
586
621
|
throw new TypeError("Le paramètre data doit être un objet.");
|
|
587
622
|
}
|
|
@@ -591,12 +626,12 @@ class EndpointApi {
|
|
|
591
626
|
/**
|
|
592
627
|
* Suggestions d'entrée : Fournit des suggestions basées sur le nom recherché, etc.
|
|
593
628
|
* Constant : SUGGESTION_INPUT
|
|
594
|
-
* @param
|
|
595
|
-
* @returns
|
|
629
|
+
* @param data - Données envoyées à l'API
|
|
630
|
+
* @returns Les données de réponse.
|
|
596
631
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
597
632
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
598
633
|
*/
|
|
599
|
-
async suggestionInput(data) {
|
|
634
|
+
async suggestionInput(data: SuggestionInputData): Promise<any> {
|
|
600
635
|
if (!data || typeof data !== "object") {
|
|
601
636
|
throw new TypeError("Le paramètre data doit être un objet.");
|
|
602
637
|
}
|
|
@@ -606,12 +641,12 @@ class EndpointApi {
|
|
|
606
641
|
/**
|
|
607
642
|
* Récupérer les projets non administrables : Récupère les projets accessibles sans droits d'administration.
|
|
608
643
|
* Constant : GET_PROJECTS_NO_ADMIN
|
|
609
|
-
* @param
|
|
610
|
-
* @returns
|
|
644
|
+
* @param data - Données envoyées à l'API
|
|
645
|
+
* @returns Les données de réponse.
|
|
611
646
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
612
647
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
613
648
|
*/
|
|
614
|
-
async getProjectsNoAdmin(data) {
|
|
649
|
+
async getProjectsNoAdmin(data: GetProjectsNoAdminData): Promise<any> {
|
|
615
650
|
if (!data || typeof data !== "object") {
|
|
616
651
|
throw new TypeError("Le paramètre data doit être un objet.");
|
|
617
652
|
}
|
|
@@ -621,13 +656,13 @@ class EndpointApi {
|
|
|
621
656
|
/**
|
|
622
657
|
* Récupérer les projets administrables : Récupère les projets pour lesquels l'utilisateur a des droits d'administration.
|
|
623
658
|
* Constant : GET_PROJECTS_ADMIN
|
|
624
|
-
* @param
|
|
625
|
-
* @returns
|
|
659
|
+
* @param data - Données envoyées à l'API
|
|
660
|
+
* @returns Les données de réponse.
|
|
626
661
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
627
662
|
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
628
663
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
629
664
|
*/
|
|
630
|
-
async getProjectsAdmin(data) {
|
|
665
|
+
async getProjectsAdmin(data: GetProjectsAdminData): Promise<any> {
|
|
631
666
|
if (!data || typeof data !== "object") {
|
|
632
667
|
throw new TypeError("Le paramètre data doit être un objet.");
|
|
633
668
|
}
|
|
@@ -637,12 +672,12 @@ class EndpointApi {
|
|
|
637
672
|
/**
|
|
638
673
|
* Récupérer les POIs non administrables : Récupère la liste des POIs accessibles sans droits d'administration.
|
|
639
674
|
* Constant : GET_POIS_NO_ADMIN
|
|
640
|
-
* @param
|
|
641
|
-
* @returns
|
|
675
|
+
* @param data - Données envoyées à l'API
|
|
676
|
+
* @returns Les données de réponse.
|
|
642
677
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
643
678
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
644
679
|
*/
|
|
645
|
-
async getPoisNoAdmin(data) {
|
|
680
|
+
async getPoisNoAdmin(data: GetPoisNoAdminData): Promise<any> {
|
|
646
681
|
if (!data || typeof data !== "object") {
|
|
647
682
|
throw new TypeError("Le paramètre data doit être un objet.");
|
|
648
683
|
}
|
|
@@ -652,13 +687,13 @@ class EndpointApi {
|
|
|
652
687
|
/**
|
|
653
688
|
* Récupérer les POIs administrables : Récupère la liste des POIs administrables par l’utilisateur.
|
|
654
689
|
* Constant : GET_POIS_ADMIN
|
|
655
|
-
* @param
|
|
656
|
-
* @returns
|
|
690
|
+
* @param data - Données envoyées à l'API
|
|
691
|
+
* @returns Les données de réponse.
|
|
657
692
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
658
693
|
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
659
694
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
660
695
|
*/
|
|
661
|
-
async getPoisAdmin(data) {
|
|
696
|
+
async getPoisAdmin(data: GetPoisAdminData): Promise<any> {
|
|
662
697
|
if (!data || typeof data !== "object") {
|
|
663
698
|
throw new TypeError("Le paramètre data doit être un objet.");
|
|
664
699
|
}
|
|
@@ -668,12 +703,12 @@ class EndpointApi {
|
|
|
668
703
|
/**
|
|
669
704
|
* Récupérer les organisations non administrables : Récupère la liste des organisations auxquelles l’utilisateur appartient sans les administrer.
|
|
670
705
|
* Constant : GET_ORGANIZATIONS_NO_ADMIN
|
|
671
|
-
* @param
|
|
672
|
-
* @returns
|
|
706
|
+
* @param data - Données envoyées à l'API
|
|
707
|
+
* @returns Les données de réponse.
|
|
673
708
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
674
709
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
675
710
|
*/
|
|
676
|
-
async getOrganizationsNoAdmin(data) {
|
|
711
|
+
async getOrganizationsNoAdmin(data: GetOrganizationsNoAdminData): Promise<any> {
|
|
677
712
|
if (!data || typeof data !== "object") {
|
|
678
713
|
throw new TypeError("Le paramètre data doit être un objet.");
|
|
679
714
|
}
|
|
@@ -683,13 +718,13 @@ class EndpointApi {
|
|
|
683
718
|
/**
|
|
684
719
|
* Récupérer les organisations administrables : Récupère les organisations administrées par l’utilisateur.
|
|
685
720
|
* Constant : GET_ORGANIZATIONS_ADMIN
|
|
686
|
-
* @param
|
|
687
|
-
* @returns
|
|
721
|
+
* @param data - Données envoyées à l'API
|
|
722
|
+
* @returns Les données de réponse.
|
|
688
723
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
689
724
|
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
690
725
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
691
726
|
*/
|
|
692
|
-
async getOrganizationsAdmin(data) {
|
|
727
|
+
async getOrganizationsAdmin(data: GetOrganizationsAdminData): Promise<any> {
|
|
693
728
|
if (!data || typeof data !== "object") {
|
|
694
729
|
throw new TypeError("Le paramètre data doit être un objet.");
|
|
695
730
|
}
|
|
@@ -699,12 +734,12 @@ class EndpointApi {
|
|
|
699
734
|
/**
|
|
700
735
|
* Récupérer les membres non administrables : Récupère les membres d’une organisation sans droits d’admin.
|
|
701
736
|
* Constant : GET_MEMBERS_NO_ADMIN
|
|
702
|
-
* @param
|
|
703
|
-
* @returns
|
|
737
|
+
* @param data - Données envoyées à l'API
|
|
738
|
+
* @returns Les données de réponse.
|
|
704
739
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
705
740
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
706
741
|
*/
|
|
707
|
-
async getMembersNoAdmin(data) {
|
|
742
|
+
async getMembersNoAdmin(data: GetMembersNoAdminData): Promise<any> {
|
|
708
743
|
if (!data || typeof data !== "object") {
|
|
709
744
|
throw new TypeError("Le paramètre data doit être un objet.");
|
|
710
745
|
}
|
|
@@ -714,13 +749,13 @@ class EndpointApi {
|
|
|
714
749
|
/**
|
|
715
750
|
* Récupérer les membres administrables : Récupère les membres d’une organisation administrée par l’utilisateur.
|
|
716
751
|
* Constant : GET_MEMBERS_ADMIN
|
|
717
|
-
* @param
|
|
718
|
-
* @returns
|
|
752
|
+
* @param data - Données envoyées à l'API
|
|
753
|
+
* @returns Les données de réponse.
|
|
719
754
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
720
755
|
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
721
756
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
722
757
|
*/
|
|
723
|
-
async getMembersAdmin(data) {
|
|
758
|
+
async getMembersAdmin(data: GetMembersAdminData): Promise<any> {
|
|
724
759
|
if (!data || typeof data !== "object") {
|
|
725
760
|
throw new TypeError("Le paramètre data doit être un objet.");
|
|
726
761
|
}
|
|
@@ -730,13 +765,13 @@ class EndpointApi {
|
|
|
730
765
|
/**
|
|
731
766
|
* Récupérer les amis administrables : Récupère les amis administrée par l’utilisateur.
|
|
732
767
|
* Constant : GET_FRIENDS_ADMIN
|
|
733
|
-
* @param
|
|
734
|
-
* @returns
|
|
768
|
+
* @param data - Données envoyées à l'API
|
|
769
|
+
* @returns Les données de réponse.
|
|
735
770
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
736
771
|
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
737
772
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
738
773
|
*/
|
|
739
|
-
async getFriendsAdmin(data) {
|
|
774
|
+
async getFriendsAdmin(data: GetFriendsAdminData): Promise<any> {
|
|
740
775
|
if (!data || typeof data !== "object") {
|
|
741
776
|
throw new TypeError("Le paramètre data doit être un objet.");
|
|
742
777
|
}
|
|
@@ -746,12 +781,12 @@ class EndpointApi {
|
|
|
746
781
|
/**
|
|
747
782
|
* Récupérer les suivis non administrables : Liste les entités suivies sans droits d’admin.
|
|
748
783
|
* Constant : GET_SUBSCRIPTIONS
|
|
749
|
-
* @param
|
|
750
|
-
* @returns
|
|
784
|
+
* @param data - Données envoyées à l'API
|
|
785
|
+
* @returns Les données de réponse.
|
|
751
786
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
752
787
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
753
788
|
*/
|
|
754
|
-
async getSubscriptions(data) {
|
|
789
|
+
async getSubscriptions(data: GetSubscriptionsData): Promise<any> {
|
|
755
790
|
if (!data || typeof data !== "object") {
|
|
756
791
|
throw new TypeError("Le paramètre data doit être un objet.");
|
|
757
792
|
}
|
|
@@ -761,13 +796,13 @@ class EndpointApi {
|
|
|
761
796
|
/**
|
|
762
797
|
* Récupérer les suivis administrables : Liste les entités suivies par l’utilisateur, sur lesquelles il est admin.
|
|
763
798
|
* Constant : GET_SUBSCRIPTIONS_ADMIN
|
|
764
|
-
* @param
|
|
765
|
-
* @returns
|
|
799
|
+
* @param data - Données envoyées à l'API
|
|
800
|
+
* @returns Les données de réponse.
|
|
766
801
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
767
802
|
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
768
803
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
769
804
|
*/
|
|
770
|
-
async getSubscriptionsAdmin(data) {
|
|
805
|
+
async getSubscriptionsAdmin(data: GetSubscriptionsAdminData): Promise<any> {
|
|
771
806
|
if (!data || typeof data !== "object") {
|
|
772
807
|
throw new TypeError("Le paramètre data doit être un objet.");
|
|
773
808
|
}
|
|
@@ -777,12 +812,12 @@ class EndpointApi {
|
|
|
777
812
|
/**
|
|
778
813
|
* Récupérer les abonnés non administrables : Liste les abonnés sans droits d’admin.
|
|
779
814
|
* Constant : GET_SUBSCRIBERS
|
|
780
|
-
* @param
|
|
781
|
-
* @returns
|
|
815
|
+
* @param data - Données envoyées à l'API
|
|
816
|
+
* @returns Les données de réponse.
|
|
782
817
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
783
818
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
784
819
|
*/
|
|
785
|
-
async getSubscribers(data) {
|
|
820
|
+
async getSubscribers(data: GetSubscribersData): Promise<any> {
|
|
786
821
|
if (!data || typeof data !== "object") {
|
|
787
822
|
throw new TypeError("Le paramètre data doit être un objet.");
|
|
788
823
|
}
|
|
@@ -792,13 +827,13 @@ class EndpointApi {
|
|
|
792
827
|
/**
|
|
793
828
|
* Récupérer les abonnés administrables : Liste les abonnés d’une entité administrée par l’utilisateur.
|
|
794
829
|
* Constant : GET_SUBSCRIBERS_ADMIN
|
|
795
|
-
* @param
|
|
796
|
-
* @returns
|
|
830
|
+
* @param data - Données envoyées à l'API
|
|
831
|
+
* @returns Les données de réponse.
|
|
797
832
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
798
833
|
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
799
834
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
800
835
|
*/
|
|
801
|
-
async getSubscribersAdmin(data) {
|
|
836
|
+
async getSubscribersAdmin(data: GetSubscribersAdminData): Promise<any> {
|
|
802
837
|
if (!data || typeof data !== "object") {
|
|
803
838
|
throw new TypeError("Le paramètre data doit être un objet.");
|
|
804
839
|
}
|
|
@@ -808,12 +843,12 @@ class EndpointApi {
|
|
|
808
843
|
/**
|
|
809
844
|
* Récupérer les contributeurs non administrables : Récupère les contributeurs sans droits d’admin.
|
|
810
845
|
* Constant : GET_CONTRIBUTORS_NO_ADMIN
|
|
811
|
-
* @param
|
|
812
|
-
* @returns
|
|
846
|
+
* @param data - Données envoyées à l'API
|
|
847
|
+
* @returns Les données de réponse.
|
|
813
848
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
814
849
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
815
850
|
*/
|
|
816
|
-
async getContributorsNoAdmin(data) {
|
|
851
|
+
async getContributorsNoAdmin(data: GetContributorsNoAdminData): Promise<any> {
|
|
817
852
|
if (!data || typeof data !== "object") {
|
|
818
853
|
throw new TypeError("Le paramètre data doit être un objet.");
|
|
819
854
|
}
|
|
@@ -823,13 +858,13 @@ class EndpointApi {
|
|
|
823
858
|
/**
|
|
824
859
|
* Récupérer les contributeurs administrables : Récupère les contributeurs d’un project l’utilisateur est admin.
|
|
825
860
|
* Constant : GET_CONTRIBUTORS_ADMIN
|
|
826
|
-
* @param
|
|
827
|
-
* @returns
|
|
861
|
+
* @param data - Données envoyées à l'API
|
|
862
|
+
* @returns Les données de réponse.
|
|
828
863
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
829
864
|
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
830
865
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
831
866
|
*/
|
|
832
|
-
async getContributorsAdmin(data) {
|
|
867
|
+
async getContributorsAdmin(data: GetContributorsAdminData): Promise<any> {
|
|
833
868
|
if (!data || typeof data !== "object") {
|
|
834
869
|
throw new TypeError("Le paramètre data doit être un objet.");
|
|
835
870
|
}
|
|
@@ -839,12 +874,12 @@ class EndpointApi {
|
|
|
839
874
|
/**
|
|
840
875
|
* Recherche globale des badges : Recherche des badges publics en fonction de divers critères.
|
|
841
876
|
* Constant : GET_BADGES
|
|
842
|
-
* @param
|
|
843
|
-
* @returns
|
|
877
|
+
* @param data - Données envoyées à l'API
|
|
878
|
+
* @returns Les données de réponse.
|
|
844
879
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
845
880
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
846
881
|
*/
|
|
847
|
-
async getBadges(data) {
|
|
882
|
+
async getBadges(data: GetBadgesData): Promise<any> {
|
|
848
883
|
if (!data || typeof data !== "object") {
|
|
849
884
|
throw new TypeError("Le paramètre data doit être un objet.");
|
|
850
885
|
}
|
|
@@ -854,12 +889,12 @@ class EndpointApi {
|
|
|
854
889
|
/**
|
|
855
890
|
* Recherche globale des badges : Recherche des badges publics en fonction de divers critères.
|
|
856
891
|
* Constant : GET_BADGES_FILTERS
|
|
857
|
-
* @param
|
|
858
|
-
* @returns
|
|
892
|
+
* @param data - Données envoyées à l'API
|
|
893
|
+
* @returns Les données de réponse.
|
|
859
894
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
860
895
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
861
896
|
*/
|
|
862
|
-
async getBadgesFilters(data) {
|
|
897
|
+
async getBadgesFilters(data: GetBadgesFiltersData): Promise<any> {
|
|
863
898
|
if (!data || typeof data !== "object") {
|
|
864
899
|
throw new TypeError("Le paramètre data doit être un objet.");
|
|
865
900
|
}
|
|
@@ -869,13 +904,13 @@ class EndpointApi {
|
|
|
869
904
|
/**
|
|
870
905
|
* Suivre un élément : Permet à un utilisateur de suivre un élément (projet, organisation...).
|
|
871
906
|
* Constant : CONNECT
|
|
872
|
-
* @param
|
|
873
|
-
* @returns
|
|
907
|
+
* @param data - Données envoyées à l'API
|
|
908
|
+
* @returns Les données de réponse.
|
|
874
909
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
875
910
|
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
876
911
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
877
912
|
*/
|
|
878
|
-
async connect(data) {
|
|
913
|
+
async connect(data: ConnectData): Promise<any> {
|
|
879
914
|
if (!data || typeof data !== "object") {
|
|
880
915
|
throw new TypeError("Le paramètre data doit être un objet.");
|
|
881
916
|
}
|
|
@@ -885,13 +920,13 @@ class EndpointApi {
|
|
|
885
920
|
/**
|
|
886
921
|
* Se déconnecter d'un élément : Permet de supprimer le lien entre un utilisateur et un élément.
|
|
887
922
|
* Constant : DISCONNECT
|
|
888
|
-
* @param
|
|
889
|
-
* @returns
|
|
923
|
+
* @param data - Données envoyées à l'API
|
|
924
|
+
* @returns Les données de réponse.
|
|
890
925
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
891
926
|
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
892
927
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
893
928
|
*/
|
|
894
|
-
async disconnect(data) {
|
|
929
|
+
async disconnect(data: DisconnectData): Promise<any> {
|
|
895
930
|
if (!data || typeof data !== "object") {
|
|
896
931
|
throw new TypeError("Le paramètre data doit être un objet.");
|
|
897
932
|
}
|
|
@@ -901,12 +936,12 @@ class EndpointApi {
|
|
|
901
936
|
/**
|
|
902
937
|
* Récuperer l'id et la collection d'un element en fonction du slug : Récuperer l'id et la collection d'un element en fonction du slug
|
|
903
938
|
* Constant : GET_ELEMENTS_KEY
|
|
904
|
-
* @param
|
|
905
|
-
* @returns
|
|
939
|
+
* @param data - Données envoyées à l'API
|
|
940
|
+
* @returns Les données de réponse.
|
|
906
941
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
907
942
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
908
943
|
*/
|
|
909
|
-
async getElementsKey(data) {
|
|
944
|
+
async getElementsKey(data: GetElementsKeyData): Promise<any> {
|
|
910
945
|
if (!data || typeof data !== "object") {
|
|
911
946
|
throw new TypeError("Le paramètre data doit être un objet.");
|
|
912
947
|
}
|
|
@@ -916,13 +951,13 @@ class EndpointApi {
|
|
|
916
951
|
/**
|
|
917
952
|
* Récupérer les favoris d'un utilisateur : Récupère la liste des favoris d’un utilisateur.
|
|
918
953
|
* Constant : GET_FAVORIS
|
|
919
|
-
* @param
|
|
920
|
-
* @returns
|
|
954
|
+
* @param data - Données envoyées à l'API
|
|
955
|
+
* @returns Les données de réponse.
|
|
921
956
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
922
957
|
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
923
958
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
924
959
|
*/
|
|
925
|
-
async getFavoris(data) {
|
|
960
|
+
async getFavoris(data: GetFavorisData): Promise<any> {
|
|
926
961
|
if (!data || typeof data !== "object") {
|
|
927
962
|
throw new TypeError("Le paramètre data doit être un objet.");
|
|
928
963
|
}
|
|
@@ -932,13 +967,13 @@ class EndpointApi {
|
|
|
932
967
|
/**
|
|
933
968
|
* Supprimer un favori : Supprime un élément des favoris de l’utilisateur.
|
|
934
969
|
* Constant : DELETE_FAVORIS
|
|
935
|
-
* @param
|
|
936
|
-
* @returns
|
|
970
|
+
* @param data - Données envoyées à l'API
|
|
971
|
+
* @returns Les données de réponse.
|
|
937
972
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
938
973
|
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
939
974
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
940
975
|
*/
|
|
941
|
-
async deleteFavoris(data) {
|
|
976
|
+
async deleteFavoris(data: DeleteFavorisData): Promise<any> {
|
|
942
977
|
if (!data || typeof data !== "object") {
|
|
943
978
|
throw new TypeError("Le paramètre data doit être un objet.");
|
|
944
979
|
}
|
|
@@ -948,13 +983,13 @@ class EndpointApi {
|
|
|
948
983
|
/**
|
|
949
984
|
* Ajouter un favori : Ajoute un élément aux favoris de l’utilisateur.
|
|
950
985
|
* Constant : ADD_FAVORIS
|
|
951
|
-
* @param
|
|
952
|
-
* @returns
|
|
986
|
+
* @param data - Données envoyées à l'API
|
|
987
|
+
* @returns Les données de réponse.
|
|
953
988
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
954
989
|
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
955
990
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
956
991
|
*/
|
|
957
|
-
async addFavoris(data) {
|
|
992
|
+
async addFavoris(data: AddFavorisData): Promise<any> {
|
|
958
993
|
if (!data || typeof data !== "object") {
|
|
959
994
|
throw new TypeError("Le paramètre data doit être un objet.");
|
|
960
995
|
}
|
|
@@ -964,13 +999,13 @@ class EndpointApi {
|
|
|
964
999
|
/**
|
|
965
1000
|
* Créer une organisation : Crée une nouvelle organisation.
|
|
966
1001
|
* Constant : ADD_ORGANIZATION
|
|
967
|
-
* @param
|
|
968
|
-
* @returns
|
|
1002
|
+
* @param data - Données envoyées à l'API
|
|
1003
|
+
* @returns Les données de réponse.
|
|
969
1004
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
970
1005
|
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
971
1006
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
972
1007
|
*/
|
|
973
|
-
async addOrganization(data) {
|
|
1008
|
+
async addOrganization(data: AddOrganizationData): Promise<any> {
|
|
974
1009
|
if (!data || typeof data !== "object") {
|
|
975
1010
|
throw new TypeError("Le paramètre data doit être un objet.");
|
|
976
1011
|
}
|
|
@@ -980,13 +1015,13 @@ class EndpointApi {
|
|
|
980
1015
|
/**
|
|
981
1016
|
* Créer un projet : Crée un nouveau projet avec des informations de base et des options supplémentaires.
|
|
982
1017
|
* Constant : ADD_PROJECT
|
|
983
|
-
* @param
|
|
984
|
-
* @returns
|
|
1018
|
+
* @param data - Données envoyées à l'API
|
|
1019
|
+
* @returns Les données de réponse.
|
|
985
1020
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
986
1021
|
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
987
1022
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
988
1023
|
*/
|
|
989
|
-
async addProject(data) {
|
|
1024
|
+
async addProject(data: AddProjectData): Promise<any> {
|
|
990
1025
|
if (!data || typeof data !== "object") {
|
|
991
1026
|
throw new TypeError("Le paramètre data doit être un objet.");
|
|
992
1027
|
}
|
|
@@ -996,13 +1031,13 @@ class EndpointApi {
|
|
|
996
1031
|
/**
|
|
997
1032
|
* Créer un POI : Crée un nouveau POI (Point d'Intérêt).
|
|
998
1033
|
* Constant : ADD_POI
|
|
999
|
-
* @param
|
|
1000
|
-
* @returns
|
|
1034
|
+
* @param data - Données envoyées à l'API
|
|
1035
|
+
* @returns Les données de réponse.
|
|
1001
1036
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
1002
1037
|
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
1003
1038
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
1004
1039
|
*/
|
|
1005
|
-
async addPoi(data) {
|
|
1040
|
+
async addPoi(data: AddPoiData): Promise<any> {
|
|
1006
1041
|
if (!data || typeof data !== "object") {
|
|
1007
1042
|
throw new TypeError("Le paramètre data doit être un objet.");
|
|
1008
1043
|
}
|
|
@@ -1012,13 +1047,13 @@ class EndpointApi {
|
|
|
1012
1047
|
/**
|
|
1013
1048
|
* Créer un événement : Crée un nouvel événement.
|
|
1014
1049
|
* Constant : ADD_EVENT
|
|
1015
|
-
* @param
|
|
1016
|
-
* @returns
|
|
1050
|
+
* @param data - Données envoyées à l'API
|
|
1051
|
+
* @returns Les données de réponse.
|
|
1017
1052
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
1018
1053
|
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
1019
1054
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
1020
1055
|
*/
|
|
1021
|
-
async addEvent(data) {
|
|
1056
|
+
async addEvent(data: AddEventData): Promise<any> {
|
|
1022
1057
|
if (!data || typeof data !== "object") {
|
|
1023
1058
|
throw new TypeError("Le paramètre data doit être un objet.");
|
|
1024
1059
|
}
|
|
@@ -1028,13 +1063,13 @@ class EndpointApi {
|
|
|
1028
1063
|
/**
|
|
1029
1064
|
* Supprimer un POI : Supprime un POI existant.
|
|
1030
1065
|
* Constant : DELETE_POI
|
|
1031
|
-
* @param
|
|
1032
|
-
* @returns
|
|
1066
|
+
* @param data - Données envoyées à l'API
|
|
1067
|
+
* @returns Les données de réponse.
|
|
1033
1068
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
1034
1069
|
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
1035
1070
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
1036
1071
|
*/
|
|
1037
|
-
async deletePoi(data) {
|
|
1072
|
+
async deletePoi(data: DeletePoiData): Promise<any> {
|
|
1038
1073
|
if (!data || typeof data !== "object") {
|
|
1039
1074
|
throw new TypeError("Le paramètre data doit être un objet.");
|
|
1040
1075
|
}
|
|
@@ -1044,13 +1079,13 @@ class EndpointApi {
|
|
|
1044
1079
|
/**
|
|
1045
1080
|
* Supprimer un événement : Supprime un événement spécifique.
|
|
1046
1081
|
* Constant : DELETE_EVENT
|
|
1047
|
-
* @param
|
|
1048
|
-
* @returns
|
|
1082
|
+
* @param data - Données envoyées à l'API
|
|
1083
|
+
* @returns Les données de réponse.
|
|
1049
1084
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
1050
1085
|
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
1051
1086
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
1052
1087
|
*/
|
|
1053
|
-
async deleteEvent(data) {
|
|
1088
|
+
async deleteEvent(data: DeleteEventData): Promise<any> {
|
|
1054
1089
|
if (!data || typeof data !== "object") {
|
|
1055
1090
|
throw new TypeError("Le paramètre data doit être un objet.");
|
|
1056
1091
|
}
|
|
@@ -1060,13 +1095,13 @@ class EndpointApi {
|
|
|
1060
1095
|
/**
|
|
1061
1096
|
* Supprimer un élément : Supprime un élément existant.
|
|
1062
1097
|
* Constant : DELETE_ELEMENT
|
|
1063
|
-
* @param
|
|
1064
|
-
* @returns
|
|
1098
|
+
* @param data - Données envoyées à l'API
|
|
1099
|
+
* @returns Les données de réponse.
|
|
1065
1100
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
1066
1101
|
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
1067
1102
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
1068
1103
|
*/
|
|
1069
|
-
async deleteElement(data) {
|
|
1104
|
+
async deleteElement(data: DeleteElementData): Promise<any> {
|
|
1070
1105
|
if (!data || typeof data !== "object") {
|
|
1071
1106
|
throw new TypeError("Le paramètre data doit être un objet.");
|
|
1072
1107
|
}
|
|
@@ -1076,13 +1111,13 @@ class EndpointApi {
|
|
|
1076
1111
|
/**
|
|
1077
1112
|
* Ajouter une image à un élément : Ajoute une image à un élément.
|
|
1078
1113
|
* Constant : ADD_IMAGE_ELEMENT
|
|
1079
|
-
* @param
|
|
1080
|
-
* @returns
|
|
1114
|
+
* @param data - Données envoyées à l'API
|
|
1115
|
+
* @returns Les données de réponse.
|
|
1081
1116
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
1082
1117
|
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
1083
1118
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
1084
1119
|
*/
|
|
1085
|
-
async addImageElement(data) {
|
|
1120
|
+
async addImageElement(data: AddImageElementData): Promise<any> {
|
|
1086
1121
|
if (!data || typeof data !== "object") {
|
|
1087
1122
|
throw new TypeError("Le paramètre data doit être un objet.");
|
|
1088
1123
|
}
|
|
@@ -1092,13 +1127,13 @@ class EndpointApi {
|
|
|
1092
1127
|
/**
|
|
1093
1128
|
* Valider un lien : Permet de valider un lien (ex: rejoindre un projet, accepter un membre...).
|
|
1094
1129
|
* Constant : LINK_VALIDATE
|
|
1095
|
-
* @param
|
|
1096
|
-
* @returns
|
|
1130
|
+
* @param data - Données envoyées à l'API
|
|
1131
|
+
* @returns Les données de réponse.
|
|
1097
1132
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
1098
1133
|
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
1099
1134
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
1100
1135
|
*/
|
|
1101
|
-
async linkValidate(data) {
|
|
1136
|
+
async linkValidate(data: LinkValidateData): Promise<any> {
|
|
1102
1137
|
if (!data || typeof data !== "object") {
|
|
1103
1138
|
throw new TypeError("Le paramètre data doit être un objet.");
|
|
1104
1139
|
}
|
|
@@ -1108,12 +1143,12 @@ class EndpointApi {
|
|
|
1108
1143
|
/**
|
|
1109
1144
|
* Recherche avec autocomplétion (membres) : Recherche des membres avec autocomplétion.
|
|
1110
1145
|
* Constant : SEARCH_MEMBER_AUTOCOMPLETE
|
|
1111
|
-
* @param
|
|
1112
|
-
* @returns
|
|
1146
|
+
* @param data - Données envoyées à l'API
|
|
1147
|
+
* @returns Les données de réponse.
|
|
1113
1148
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
1114
1149
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
1115
1150
|
*/
|
|
1116
|
-
async searchMemberAutocomplete(data) {
|
|
1151
|
+
async searchMemberAutocomplete(data: SearchMemberAutocompleteData): Promise<any> {
|
|
1117
1152
|
if (!data || typeof data !== "object") {
|
|
1118
1153
|
throw new TypeError("Le paramètre data doit être un objet.");
|
|
1119
1154
|
}
|
|
@@ -1123,13 +1158,13 @@ class EndpointApi {
|
|
|
1123
1158
|
/**
|
|
1124
1159
|
* Récupérer les notifications : Récupère la liste des notifications pour un utilisateur.
|
|
1125
1160
|
* Constant : GET_NOTIFICATIONS
|
|
1126
|
-
* @param
|
|
1127
|
-
* @returns
|
|
1161
|
+
* @param data - Données envoyées à l'API
|
|
1162
|
+
* @returns Les données de réponse.
|
|
1128
1163
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
1129
1164
|
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
1130
1165
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
1131
1166
|
*/
|
|
1132
|
-
async getNotifications(data) {
|
|
1167
|
+
async getNotifications(data: GetNotificationsData): Promise<any> {
|
|
1133
1168
|
if (!data || typeof data !== "object") {
|
|
1134
1169
|
throw new TypeError("Le paramètre data doit être un objet.");
|
|
1135
1170
|
}
|
|
@@ -1139,13 +1174,13 @@ class EndpointApi {
|
|
|
1139
1174
|
/**
|
|
1140
1175
|
* Récupérer le nombre de notifications : Récupère le nombre de notifications pour un utilisateur.
|
|
1141
1176
|
* Constant : GET_NOTIFICATIONS_COUNT
|
|
1142
|
-
* @param
|
|
1143
|
-
* @returns
|
|
1177
|
+
* @param data - Données envoyées à l'API
|
|
1178
|
+
* @returns Les données de réponse.
|
|
1144
1179
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
1145
1180
|
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
1146
1181
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
1147
1182
|
*/
|
|
1148
|
-
async getNotificationsCount(data) {
|
|
1183
|
+
async getNotificationsCount(data: GetNotificationsCountData): Promise<any> {
|
|
1149
1184
|
if (!data || typeof data !== "object") {
|
|
1150
1185
|
throw new TypeError("Le paramètre data doit être un objet.");
|
|
1151
1186
|
}
|
|
@@ -1155,13 +1190,13 @@ class EndpointApi {
|
|
|
1155
1190
|
/**
|
|
1156
1191
|
* Mettre à jour toutes les notifications : Marque toutes les notifications comme vues ou lues.
|
|
1157
1192
|
* Constant : NOTIFICATION_UPDATE
|
|
1158
|
-
* @param
|
|
1159
|
-
* @returns
|
|
1193
|
+
* @param data - Données envoyées à l'API
|
|
1194
|
+
* @returns Les données de réponse.
|
|
1160
1195
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
1161
1196
|
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
1162
1197
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
1163
1198
|
*/
|
|
1164
|
-
async notificationUpdate(data) {
|
|
1199
|
+
async notificationUpdate(data: NotificationUpdateData): Promise<any> {
|
|
1165
1200
|
if (!data || typeof data !== "object") {
|
|
1166
1201
|
throw new TypeError("Le paramètre data doit être un objet.");
|
|
1167
1202
|
}
|
|
@@ -1171,25 +1206,25 @@ class EndpointApi {
|
|
|
1171
1206
|
/**
|
|
1172
1207
|
* Supprimer toutes les notifications : Supprime toutes les notifications de l’utilisateur.
|
|
1173
1208
|
* Constant : REMOVE_ALL_NOTIFICATIONS
|
|
1174
|
-
* @returns
|
|
1209
|
+
* @returns Les données de réponse.
|
|
1175
1210
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
1176
1211
|
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
1177
1212
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
1178
1213
|
*/
|
|
1179
|
-
async removeAllNotifications() {
|
|
1214
|
+
async removeAllNotifications(): Promise<any> {
|
|
1180
1215
|
return this.callIsConnected("REMOVE_ALL_NOTIFICATIONS");
|
|
1181
1216
|
}
|
|
1182
1217
|
|
|
1183
1218
|
/**
|
|
1184
1219
|
* Marquer une notification comme lue : Marque une notification spécifique comme lue.
|
|
1185
1220
|
* Constant : MARK_NOTIFICATION_AS_READ
|
|
1186
|
-
* @param
|
|
1187
|
-
* @returns
|
|
1221
|
+
* @param data - Données envoyées à l'API
|
|
1222
|
+
* @returns Les données de réponse.
|
|
1188
1223
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
1189
1224
|
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
1190
1225
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
1191
1226
|
*/
|
|
1192
|
-
async markNotificationAsRead(data) {
|
|
1227
|
+
async markNotificationAsRead(data: MarkNotificationAsReadData): Promise<any> {
|
|
1193
1228
|
if (!data || typeof data !== "object") {
|
|
1194
1229
|
throw new TypeError("Le paramètre data doit être un objet.");
|
|
1195
1230
|
}
|
|
@@ -1199,12 +1234,12 @@ class EndpointApi {
|
|
|
1199
1234
|
/**
|
|
1200
1235
|
* Recherche ActivityPub : Recherche des éléments ActivityPub selon une adresse ou un terme.
|
|
1201
1236
|
* Constant : ACTIVITYPUB_SEARCH
|
|
1202
|
-
* @param
|
|
1203
|
-
* @returns
|
|
1237
|
+
* @param data - Données envoyées à l'API
|
|
1238
|
+
* @returns Les données de réponse.
|
|
1204
1239
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
1205
1240
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
1206
1241
|
*/
|
|
1207
|
-
async activitypubSearch(data) {
|
|
1242
|
+
async activitypubSearch(data: ActivitypubSearchData): Promise<any> {
|
|
1208
1243
|
if (!data || typeof data !== "object") {
|
|
1209
1244
|
throw new TypeError("Le paramètre data doit être un objet.");
|
|
1210
1245
|
}
|
|
@@ -1214,13 +1249,13 @@ class EndpointApi {
|
|
|
1214
1249
|
/**
|
|
1215
1250
|
* Mettre à jour une activité (ActivityPub) : Met à jour une activité ActivityPub avec une action et un payload.
|
|
1216
1251
|
* Constant : ACTIVITYPUB_LINK
|
|
1217
|
-
* @param
|
|
1218
|
-
* @returns
|
|
1252
|
+
* @param data - Données envoyées à l'API
|
|
1253
|
+
* @returns Les données de réponse.
|
|
1219
1254
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
1220
1255
|
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
1221
1256
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
1222
1257
|
*/
|
|
1223
|
-
async activitypubLink(data) {
|
|
1258
|
+
async activitypubLink(data: ActivitypubLinkData): Promise<any> {
|
|
1224
1259
|
if (!data || typeof data !== "object") {
|
|
1225
1260
|
throw new TypeError("Le paramètre data doit être un objet.");
|
|
1226
1261
|
}
|
|
@@ -1230,12 +1265,12 @@ class EndpointApi {
|
|
|
1230
1265
|
/**
|
|
1231
1266
|
* Obtenir la liste ActivityPub : Obtient la liste des communautés ActivityPub pour un utilisateur.
|
|
1232
1267
|
* Constant : ACTIVITYPUB_GET_COMMUNITY
|
|
1233
|
-
* @param
|
|
1234
|
-
* @returns
|
|
1268
|
+
* @param data - Données envoyées à l'API
|
|
1269
|
+
* @returns Les données de réponse.
|
|
1235
1270
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
1236
1271
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
1237
1272
|
*/
|
|
1238
|
-
async activitypubGetCommunity(data) {
|
|
1273
|
+
async activitypubGetCommunity(data: ActivitypubGetCommunityData): Promise<any> {
|
|
1239
1274
|
if (!data || typeof data !== "object") {
|
|
1240
1275
|
throw new TypeError("Le paramètre data doit être un objet.");
|
|
1241
1276
|
}
|
|
@@ -1245,12 +1280,12 @@ class EndpointApi {
|
|
|
1245
1280
|
/**
|
|
1246
1281
|
* Récupérer les informations d'un badge : Récupère les détails d’un badge par son ID.
|
|
1247
1282
|
* Constant : GET_BADGE
|
|
1248
|
-
* @param
|
|
1249
|
-
* @returns
|
|
1283
|
+
* @param data - Données envoyées à l'API
|
|
1284
|
+
* @returns Les données de réponse.
|
|
1250
1285
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
1251
1286
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
1252
1287
|
*/
|
|
1253
|
-
async getBadge(data) {
|
|
1288
|
+
async getBadge(data: GetBadgeData): Promise<any> {
|
|
1254
1289
|
if (!data || typeof data !== "object") {
|
|
1255
1290
|
throw new TypeError("Le paramètre data doit être un objet.");
|
|
1256
1291
|
}
|
|
@@ -1260,24 +1295,24 @@ class EndpointApi {
|
|
|
1260
1295
|
/**
|
|
1261
1296
|
* Obtenir la liste des émetteurs de badges : Récupère la liste des émetteurs pour les badges.
|
|
1262
1297
|
* Constant : GET_EMETTEUR_BADGES
|
|
1263
|
-
* @returns
|
|
1298
|
+
* @returns Les données de réponse.
|
|
1264
1299
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
1265
1300
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
1266
1301
|
*/
|
|
1267
|
-
async getEmetteurBadges() {
|
|
1302
|
+
async getEmetteurBadges(): Promise<any> {
|
|
1268
1303
|
return this.call("GET_EMETTEUR_BADGES");
|
|
1269
1304
|
}
|
|
1270
1305
|
|
|
1271
1306
|
/**
|
|
1272
1307
|
* Créer un badge : Crée un nouveau badge avec des informations détaillées.
|
|
1273
1308
|
* Constant : ADD_BADGES
|
|
1274
|
-
* @param
|
|
1275
|
-
* @returns
|
|
1309
|
+
* @param data - Données envoyées à l'API
|
|
1310
|
+
* @returns Les données de réponse.
|
|
1276
1311
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
1277
1312
|
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
1278
1313
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
1279
1314
|
*/
|
|
1280
|
-
async addBadges(data) {
|
|
1315
|
+
async addBadges(data: AddBadgesData): Promise<any> {
|
|
1281
1316
|
if (!data || typeof data !== "object") {
|
|
1282
1317
|
throw new TypeError("Le paramètre data doit être un objet.");
|
|
1283
1318
|
}
|
|
@@ -1287,13 +1322,13 @@ class EndpointApi {
|
|
|
1287
1322
|
/**
|
|
1288
1323
|
* Attribuer un badge : Attribue un badge à une ou plusieurs personnes ou entités.
|
|
1289
1324
|
* Constant : ASSIGN_BADGES
|
|
1290
|
-
* @param
|
|
1291
|
-
* @returns
|
|
1325
|
+
* @param data - Données envoyées à l'API
|
|
1326
|
+
* @returns Les données de réponse.
|
|
1292
1327
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
1293
1328
|
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
1294
1329
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
1295
1330
|
*/
|
|
1296
|
-
async assignBadges(data) {
|
|
1331
|
+
async assignBadges(data: AssignBadgesData): Promise<any> {
|
|
1297
1332
|
if (!data || typeof data !== "object") {
|
|
1298
1333
|
throw new TypeError("Le paramètre data doit être un objet.");
|
|
1299
1334
|
}
|
|
@@ -1303,12 +1338,12 @@ class EndpointApi {
|
|
|
1303
1338
|
/**
|
|
1304
1339
|
* Obtenir la liste des événements : Permet de rechercher des événements selon plusieurs critères (dates, nom, type...).
|
|
1305
1340
|
* Constant : GET_EVENTS
|
|
1306
|
-
* @param
|
|
1307
|
-
* @returns
|
|
1341
|
+
* @param data - Données envoyées à l'API
|
|
1342
|
+
* @returns Les données de réponse.
|
|
1308
1343
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
1309
1344
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
1310
1345
|
*/
|
|
1311
|
-
async getEvents(data) {
|
|
1346
|
+
async getEvents(data: GetEventsData): Promise<any> {
|
|
1312
1347
|
if (!data || typeof data !== "object") {
|
|
1313
1348
|
throw new TypeError("Le paramètre data doit être un objet.");
|
|
1314
1349
|
}
|
|
@@ -1318,13 +1353,13 @@ class EndpointApi {
|
|
|
1318
1353
|
/**
|
|
1319
1354
|
* Partager un événement : Partage un événement avec d’autres utilisateurs ou entités.
|
|
1320
1355
|
* Constant : SHARE_EVENTS
|
|
1321
|
-
* @param
|
|
1322
|
-
* @returns
|
|
1356
|
+
* @param data - Données envoyées à l'API
|
|
1357
|
+
* @returns Les données de réponse.
|
|
1323
1358
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
1324
1359
|
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
1325
1360
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
1326
1361
|
*/
|
|
1327
|
-
async shareEvents(data) {
|
|
1362
|
+
async shareEvents(data: ShareEventsData): Promise<any> {
|
|
1328
1363
|
if (!data || typeof data !== "object") {
|
|
1329
1364
|
throw new TypeError("Le paramètre data doit être un objet.");
|
|
1330
1365
|
}
|
|
@@ -1334,13 +1369,13 @@ class EndpointApi {
|
|
|
1334
1369
|
/**
|
|
1335
1370
|
* Inviter des participants à un événement : Invite plusieurs utilisateurs ou entités à participer à un événement.
|
|
1336
1371
|
* Constant : INVITE_EVENT
|
|
1337
|
-
* @param
|
|
1338
|
-
* @returns
|
|
1372
|
+
* @param data - Données envoyées à l'API
|
|
1373
|
+
* @returns Les données de réponse.
|
|
1339
1374
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
1340
1375
|
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
1341
1376
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
1342
1377
|
*/
|
|
1343
|
-
async inviteEvent(data) {
|
|
1378
|
+
async inviteEvent(data: InviteEventData): Promise<any> {
|
|
1344
1379
|
if (!data || typeof data !== "object") {
|
|
1345
1380
|
throw new TypeError("Le paramètre data doit être un objet.");
|
|
1346
1381
|
}
|
|
@@ -1350,13 +1385,13 @@ class EndpointApi {
|
|
|
1350
1385
|
/**
|
|
1351
1386
|
* Suivre un utilisateur ou un élément : Suivre un utilisateur ou un élément.
|
|
1352
1387
|
* Constant : FOLLOW
|
|
1353
|
-
* @param
|
|
1354
|
-
* @returns
|
|
1388
|
+
* @param data - Données envoyées à l'API
|
|
1389
|
+
* @returns Les données de réponse.
|
|
1355
1390
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
1356
1391
|
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
1357
1392
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
1358
1393
|
*/
|
|
1359
|
-
async follow(data) {
|
|
1394
|
+
async follow(data: FollowData): Promise<any> {
|
|
1360
1395
|
if (!data || typeof data !== "object") {
|
|
1361
1396
|
throw new TypeError("Le paramètre data doit être un objet.");
|
|
1362
1397
|
}
|
|
@@ -1366,12 +1401,12 @@ class EndpointApi {
|
|
|
1366
1401
|
/**
|
|
1367
1402
|
* Récuperer les data d'un JSON d'un costum : Récuperer les data d'un JSON d'un costum
|
|
1368
1403
|
* Constant : GET_COSTUM_JSON
|
|
1369
|
-
* @param
|
|
1370
|
-
* @returns
|
|
1404
|
+
* @param data - Données envoyées à l'API
|
|
1405
|
+
* @returns Les données de réponse.
|
|
1371
1406
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
1372
1407
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
1373
1408
|
*/
|
|
1374
|
-
async getCostumJson(data) {
|
|
1409
|
+
async getCostumJson(data: GetCostumJsonData): Promise<any> {
|
|
1375
1410
|
if (!data || typeof data !== "object") {
|
|
1376
1411
|
throw new TypeError("Le paramètre data doit être un objet.");
|
|
1377
1412
|
}
|
|
@@ -1381,12 +1416,12 @@ class EndpointApi {
|
|
|
1381
1416
|
/**
|
|
1382
1417
|
* Recherche globale lier à un costum : Effectue une recherche globale lier à un costum
|
|
1383
1418
|
* Constant : GLOBAL_AUTOCOMPLETE_COSTUM
|
|
1384
|
-
* @param
|
|
1385
|
-
* @returns
|
|
1419
|
+
* @param data - Données envoyées à l'API
|
|
1420
|
+
* @returns Les données de réponse.
|
|
1386
1421
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
1387
1422
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
1388
1423
|
*/
|
|
1389
|
-
async globalAutocompleteCostum(data) {
|
|
1424
|
+
async globalAutocompleteCostum(data: GlobalAutocompleteCostumData): Promise<any> {
|
|
1390
1425
|
if (!data || typeof data !== "object") {
|
|
1391
1426
|
throw new TypeError("Le paramètre data doit être un objet.");
|
|
1392
1427
|
}
|
|
@@ -1396,12 +1431,12 @@ class EndpointApi {
|
|
|
1396
1431
|
/**
|
|
1397
1432
|
* Récupérer les acteurs d'événement : Récupérer les acteurs (organizers, attendees, creators, animators) d'une entité événement.
|
|
1398
1433
|
* Constant : COSTUM_EVENT_REQUEST_ACTORS
|
|
1399
|
-
* @param
|
|
1400
|
-
* @returns
|
|
1434
|
+
* @param data - Données envoyées à l'API
|
|
1435
|
+
* @returns Les données de réponse.
|
|
1401
1436
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
1402
1437
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
1403
1438
|
*/
|
|
1404
|
-
async costumEventRequestActors(data) {
|
|
1439
|
+
async costumEventRequestActors(data: CostumEventRequestActorsData): Promise<any> {
|
|
1405
1440
|
if (!data || typeof data !== "object") {
|
|
1406
1441
|
throw new TypeError("Le paramètre data doit être un objet.");
|
|
1407
1442
|
}
|
|
@@ -1411,12 +1446,12 @@ class EndpointApi {
|
|
|
1411
1446
|
/**
|
|
1412
1447
|
* Récupérer les sous-événements d’un événement parent : Retourne les sous-événements filtrés par date, type, tags, région, timezone.
|
|
1413
1448
|
* Constant : COSTUM_EVENT_REQUEST_SUBEVENTS
|
|
1414
|
-
* @param
|
|
1415
|
-
* @returns
|
|
1449
|
+
* @param data - Données envoyées à l'API
|
|
1450
|
+
* @returns Les données de réponse.
|
|
1416
1451
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
1417
1452
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
1418
1453
|
*/
|
|
1419
|
-
async costumEventRequestSubevents(data) {
|
|
1454
|
+
async costumEventRequestSubevents(data: CostumEventRequestSubeventsData): Promise<any> {
|
|
1420
1455
|
if (!data || typeof data !== "object") {
|
|
1421
1456
|
throw new TypeError("Le paramètre data doit être un objet.");
|
|
1422
1457
|
}
|
|
@@ -1426,12 +1461,12 @@ class EndpointApi {
|
|
|
1426
1461
|
/**
|
|
1427
1462
|
* Récupérer les événements liés à un élément : Retourne les événements liés à une entité (via links.events ou parent).
|
|
1428
1463
|
* Constant : COSTUM_EVENT_REQUEST_ELEMENT_EVENT
|
|
1429
|
-
* @param
|
|
1430
|
-
* @returns
|
|
1464
|
+
* @param data - Données envoyées à l'API
|
|
1465
|
+
* @returns Les données de réponse.
|
|
1431
1466
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
1432
1467
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
1433
1468
|
*/
|
|
1434
|
-
async costumEventRequestElementEvent(data) {
|
|
1469
|
+
async costumEventRequestElementEvent(data: CostumEventRequestElementEventData): Promise<any> {
|
|
1435
1470
|
if (!data || typeof data !== "object") {
|
|
1436
1471
|
throw new TypeError("Le paramètre data doit être un objet.");
|
|
1437
1472
|
}
|
|
@@ -1441,12 +1476,12 @@ class EndpointApi {
|
|
|
1441
1476
|
/**
|
|
1442
1477
|
* Récupérer les catégories d’événements : Retourne la liste des types (catégories) d’événements enfants liés à l'entité.
|
|
1443
1478
|
* Constant : COSTUM_EVENT_REQUEST_CATEGORIES
|
|
1444
|
-
* @param
|
|
1445
|
-
* @returns
|
|
1479
|
+
* @param data - Données envoyées à l'API
|
|
1480
|
+
* @returns Les données de réponse.
|
|
1446
1481
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
1447
1482
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
1448
1483
|
*/
|
|
1449
|
-
async costumEventRequestCategories(data) {
|
|
1484
|
+
async costumEventRequestCategories(data: CostumEventRequestCategoriesData): Promise<any> {
|
|
1450
1485
|
if (!data || typeof data !== "object") {
|
|
1451
1486
|
throw new TypeError("Le paramètre data doit être un objet.");
|
|
1452
1487
|
}
|
|
@@ -1456,12 +1491,12 @@ class EndpointApi {
|
|
|
1456
1491
|
/**
|
|
1457
1492
|
* Récupérer les dates de sous-événements : Retourne les dates des sous-événements à venir et passés, groupées par jour.
|
|
1458
1493
|
* Constant : COSTUM_EVENT_REQUEST_DATES
|
|
1459
|
-
* @param
|
|
1460
|
-
* @returns
|
|
1494
|
+
* @param data - Données envoyées à l'API
|
|
1495
|
+
* @returns Les données de réponse.
|
|
1461
1496
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
1462
1497
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
1463
1498
|
*/
|
|
1464
|
-
async costumEventRequestDates(data) {
|
|
1499
|
+
async costumEventRequestDates(data: CostumEventRequestDatesData): Promise<any> {
|
|
1465
1500
|
if (!data || typeof data !== "object") {
|
|
1466
1501
|
throw new TypeError("Le paramètre data doit être un objet.");
|
|
1467
1502
|
}
|
|
@@ -1471,12 +1506,12 @@ class EndpointApi {
|
|
|
1471
1506
|
/**
|
|
1472
1507
|
* Récupérer un événement par ID : Retourne les informations détaillées d’un événement par son ID.
|
|
1473
1508
|
* Constant : COSTUM_EVENT_REQUEST_EVENT
|
|
1474
|
-
* @param
|
|
1475
|
-
* @returns
|
|
1509
|
+
* @param data - Données envoyées à l'API
|
|
1510
|
+
* @returns Les données de réponse.
|
|
1476
1511
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
1477
1512
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
1478
1513
|
*/
|
|
1479
|
-
async costumEventRequestEvent(data) {
|
|
1514
|
+
async costumEventRequestEvent(data: CostumEventRequestEventData): Promise<any> {
|
|
1480
1515
|
if (!data || typeof data !== "object") {
|
|
1481
1516
|
throw new TypeError("Le paramètre data doit être un objet.");
|
|
1482
1517
|
}
|
|
@@ -1486,12 +1521,12 @@ class EndpointApi {
|
|
|
1486
1521
|
/**
|
|
1487
1522
|
* Associer une structure à un événement (adresse) : Associe une structure existante à un événement en copiant son adresse.
|
|
1488
1523
|
* Constant : COSTUM_EVENT_REQUEST_LINK_TL_TO_EVENT
|
|
1489
|
-
* @param
|
|
1490
|
-
* @returns
|
|
1524
|
+
* @param data - Données envoyées à l'API
|
|
1525
|
+
* @returns Les données de réponse.
|
|
1491
1526
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
1492
1527
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
1493
1528
|
*/
|
|
1494
|
-
async costumEventRequestLinkTlToEvent(data) {
|
|
1529
|
+
async costumEventRequestLinkTlToEvent(data: CostumEventRequestLinkTlToEventData): Promise<any> {
|
|
1495
1530
|
if (!data || typeof data !== "object") {
|
|
1496
1531
|
throw new TypeError("Le paramètre data doit être un objet.");
|
|
1497
1532
|
}
|
|
@@ -1501,12 +1536,12 @@ class EndpointApi {
|
|
|
1501
1536
|
/**
|
|
1502
1537
|
* Charger les tags de contexte d’un événement : Retourne les tags des sous-événements et des parents d’un événement, avec filtre optionnel.
|
|
1503
1538
|
* Constant : COSTUM_EVENT_REQUEST_LOAD_CONTEXT_TAG
|
|
1504
|
-
* @param
|
|
1505
|
-
* @returns
|
|
1539
|
+
* @param data - Données envoyées à l'API
|
|
1540
|
+
* @returns Les données de réponse.
|
|
1506
1541
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
1507
1542
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
1508
1543
|
*/
|
|
1509
|
-
async costumEventRequestLoadContextTag(data) {
|
|
1544
|
+
async costumEventRequestLoadContextTag(data: CostumEventRequestLoadContextTagData): Promise<any> {
|
|
1510
1545
|
if (!data || typeof data !== "object") {
|
|
1511
1546
|
throw new TypeError("Le paramètre data doit être un objet.");
|
|
1512
1547
|
}
|
|
@@ -1516,18 +1551,49 @@ class EndpointApi {
|
|
|
1516
1551
|
/**
|
|
1517
1552
|
* Récupération de la galerie : Renvoie soit la liste d’albums associés à une entité, soit les images d’un album spécifique.
|
|
1518
1553
|
* Constant : GET_GALLERY
|
|
1519
|
-
* @param
|
|
1520
|
-
* @returns
|
|
1554
|
+
* @param data - Données envoyées à l'API
|
|
1555
|
+
* @returns Les données de réponse.
|
|
1521
1556
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
1522
1557
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
1523
1558
|
*/
|
|
1524
|
-
async getGallery(data) {
|
|
1559
|
+
async getGallery(data: GetGalleryData): Promise<any> {
|
|
1525
1560
|
if (!data || typeof data !== "object") {
|
|
1526
1561
|
throw new TypeError("Le paramètre data doit être un objet.");
|
|
1527
1562
|
}
|
|
1528
1563
|
return this.call("GET_GALLERY", data);
|
|
1529
1564
|
}
|
|
1530
1565
|
|
|
1566
|
+
/**
|
|
1567
|
+
* Récupérer les participants non administrables : Récupère les participants sans droits d’admin.
|
|
1568
|
+
* Constant : GET_ATTENDEES_NO_ADMIN
|
|
1569
|
+
* @param data - Données envoyées à l'API
|
|
1570
|
+
* @returns Les données de réponse.
|
|
1571
|
+
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
1572
|
+
* @throws {Error} - En cas d'erreur inattendue.
|
|
1573
|
+
*/
|
|
1574
|
+
async getAttendeesNoAdmin(data: GetAttendeesNoAdminData): Promise<any> {
|
|
1575
|
+
if (!data || typeof data !== "object") {
|
|
1576
|
+
throw new TypeError("Le paramètre data doit être un objet.");
|
|
1577
|
+
}
|
|
1578
|
+
return this.call("GET_ATTENDEES_NO_ADMIN", data);
|
|
1579
|
+
}
|
|
1580
|
+
|
|
1581
|
+
/**
|
|
1582
|
+
* Récupérer les participants administrables : Récupère les participants d’un événement si l’utilisateur est admin.
|
|
1583
|
+
* Constant : GET_ATTENDEES_ADMIN
|
|
1584
|
+
* @param data - Données envoyées à l'API
|
|
1585
|
+
* @returns Les données de réponse.
|
|
1586
|
+
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
1587
|
+
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
1588
|
+
* @throws {Error} - En cas d'erreur inattendue.
|
|
1589
|
+
*/
|
|
1590
|
+
async getAttendeesAdmin(data: GetAttendeesAdminData): Promise<any> {
|
|
1591
|
+
if (!data || typeof data !== "object") {
|
|
1592
|
+
throw new TypeError("Le paramètre data doit être un objet.");
|
|
1593
|
+
}
|
|
1594
|
+
return this.callIsConnected("GET_ATTENDEES_ADMIN", data);
|
|
1595
|
+
}
|
|
1596
|
+
|
|
1531
1597
|
}
|
|
1532
1598
|
|
|
1533
1599
|
export default EndpointApi;
|