@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,50 +1,82 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
/**
|
|
4
|
-
* @typedef {import("../error.js").ApiResponseError} ApiResponseError
|
|
5
|
-
*/
|
|
1
|
+
import type ApiClient from "../ApiClient.js";
|
|
2
|
+
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";
|
|
6
3
|
/**
|
|
7
4
|
* Classe EndpointApi générée automatiquement depuis endpoints-copie.json
|
|
8
5
|
*/
|
|
9
|
-
declare class EndpointApi {
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
6
|
+
export declare class EndpointApi {
|
|
7
|
+
apiClient: ApiClient;
|
|
8
|
+
/**
|
|
9
|
+
* @param {ApiClient} apiClient - Instance du client API utilisée pour exécuter les appels.
|
|
10
|
+
*/
|
|
11
|
+
constructor(apiClient: ApiClient);
|
|
12
|
+
/**
|
|
13
|
+
* Indique si un utilisateur est actuellement connecté.
|
|
14
|
+
*/
|
|
15
|
+
get isConnected(): boolean;
|
|
16
|
+
/**
|
|
17
|
+
* Identifiant de l'utilisateur connecté (s'il y en a un).
|
|
18
|
+
*/
|
|
19
|
+
get userId(): string | null;
|
|
20
|
+
/**
|
|
21
|
+
* Appelle un endpoint de l'API de façon sécurisée et retourne la donnée.
|
|
22
|
+
* @template T
|
|
23
|
+
* @param {string} constant - La constante représentant l'endpoint à appeler.
|
|
24
|
+
* @param {object} [data={}] - Données envoyées à l'API.
|
|
25
|
+
* @returns {Promise<T>} Résultat de la requête.
|
|
26
|
+
* @throws {ApiResponseError} En cas d'erreur de l'API.
|
|
27
|
+
*/
|
|
28
|
+
call<T>(constant: string, data?: any): Promise<T>;
|
|
29
|
+
/**
|
|
30
|
+
* Appelle un endpoint qui nécessite que l’utilisateur ne soit **pas** connecté.
|
|
31
|
+
* @template T
|
|
32
|
+
* @param {string} constant - La constante représentant l'endpoint à appeler.
|
|
33
|
+
* @param {object} [data={}] - Données envoyées à l’API.
|
|
34
|
+
* @returns {Promise<T>} Résultat de la requête.
|
|
35
|
+
* @throws {ApiAuthenticationError} Si l’utilisateur est connecté.
|
|
36
|
+
* @throws {ApiResponseError} En cas d'erreur de l'API.
|
|
37
|
+
*/
|
|
38
|
+
callNoConnected<T>(constant: string, data?: any): Promise<T>;
|
|
39
|
+
/**
|
|
40
|
+
* Appelle un endpoint qui nécessite que l’utilisateur soit connecté.
|
|
41
|
+
* @template T
|
|
42
|
+
* @param {string} constant - La constante représentant l'endpoint à appeler.
|
|
43
|
+
* @param {object} [data={}] - Données envoyées à l’API.
|
|
44
|
+
* @returns {Promise<T>} Résultat de la requête.
|
|
45
|
+
* @throws {ApiAuthenticationError} Si l’utilisateur n’est pas connecté.
|
|
46
|
+
* @throws {ApiResponseError} En cas d'erreur de l'API.
|
|
47
|
+
*/
|
|
48
|
+
callIsConnected<T>(constant: string, data?: any): Promise<T>;
|
|
17
49
|
/**
|
|
18
50
|
* Enregistrement d'un utilisateur : Permet d’enregistrer un nouvel utilisateur avec ses informations personnelles.
|
|
19
51
|
* Constant : PERSON_REGISTER
|
|
20
|
-
* @param
|
|
21
|
-
* @returns
|
|
52
|
+
* @param data - Données envoyées à l'API
|
|
53
|
+
* @returns Les données de réponse.
|
|
22
54
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
23
55
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
24
56
|
*/
|
|
25
|
-
personRegister(data:
|
|
57
|
+
personRegister(data: PersonRegisterData): Promise<any>;
|
|
26
58
|
/**
|
|
27
59
|
* Authentification : Permet de se connecter en utilisant une adresse email et un mot de passe.
|
|
28
60
|
* Constant : AUTHENTICATE_URL
|
|
29
|
-
* @param
|
|
30
|
-
* @returns
|
|
61
|
+
* @param data - Données envoyées à l'API
|
|
62
|
+
* @returns Les données de réponse.
|
|
31
63
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
32
64
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
33
65
|
*/
|
|
34
|
-
authenticateUrl(data:
|
|
66
|
+
authenticateUrl(data: AuthenticateUrlData): Promise<any>;
|
|
35
67
|
/**
|
|
36
68
|
* Rafraîchir un token : Permet de rafraîchir un token d'accès expiré en utilisant un token de rafraîchissement.
|
|
37
69
|
* Constant : REFRESH_TOKEN_URL
|
|
38
|
-
* @param
|
|
39
|
-
* @returns
|
|
70
|
+
* @param data - Données envoyées à l'API
|
|
71
|
+
* @returns Les données de réponse.
|
|
40
72
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
41
73
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
42
74
|
*/
|
|
43
|
-
refreshTokenUrl(data:
|
|
75
|
+
refreshTokenUrl(data: RefreshTokenUrlData): Promise<any>;
|
|
44
76
|
/**
|
|
45
77
|
* Récupérer les informations utilisateur : Récupère les informations du profil utilisateur pour un token donné.
|
|
46
78
|
* Constant : ME_INFO_URL
|
|
47
|
-
* @returns
|
|
79
|
+
* @returns Les données de réponse.
|
|
48
80
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
49
81
|
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
50
82
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
@@ -53,665 +85,665 @@ declare class EndpointApi {
|
|
|
53
85
|
/**
|
|
54
86
|
* Récupération de mot de passe : Envoie un email pour récupérer le mot de passe.
|
|
55
87
|
* Constant : PASSWORD_RECOVERY
|
|
56
|
-
* @param
|
|
57
|
-
* @returns
|
|
88
|
+
* @param data - Données envoyées à l'API
|
|
89
|
+
* @returns Les données de réponse.
|
|
58
90
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
59
91
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
60
92
|
*/
|
|
61
|
-
passwordRecovery(data:
|
|
93
|
+
passwordRecovery(data: PasswordRecoveryData): Promise<any>;
|
|
62
94
|
/**
|
|
63
95
|
* Échange de token avec un autre serveur : Permet de se connecter à un autre serveur Communecter en échangeant un token.
|
|
64
96
|
* Constant : SERVER_EXCHANGE_TOKEN
|
|
65
|
-
* @param
|
|
66
|
-
* @returns
|
|
97
|
+
* @param data - Données envoyées à l'API
|
|
98
|
+
* @returns Les données de réponse.
|
|
67
99
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
68
100
|
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
69
101
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
70
102
|
*/
|
|
71
|
-
serverExchangeToken(data:
|
|
103
|
+
serverExchangeToken(data: ServerExchangeTokenData): Promise<any>;
|
|
72
104
|
/**
|
|
73
105
|
* Changer le mot de passe : Permet de changer le mot de passe d'un utilisateur.
|
|
74
106
|
* Constant : CHANGE_PASSWORD
|
|
75
|
-
* @param
|
|
76
|
-
* @returns
|
|
107
|
+
* @param data - Données envoyées à l'API
|
|
108
|
+
* @returns Les données de réponse.
|
|
77
109
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
78
110
|
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
79
111
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
80
112
|
*/
|
|
81
|
-
changePassword(data:
|
|
113
|
+
changePassword(data: ChangePasswordData): Promise<any>;
|
|
82
114
|
/**
|
|
83
115
|
* Supprimer un compte : Permet de supprimer un compte utilisateur.
|
|
84
116
|
* Constant : DELETE_ACCOUNT
|
|
85
|
-
* @param
|
|
86
|
-
* @returns
|
|
117
|
+
* @param data - Données envoyées à l'API
|
|
118
|
+
* @returns Les données de réponse.
|
|
87
119
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
88
120
|
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
89
121
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
90
122
|
*/
|
|
91
|
-
deleteAccount(data:
|
|
123
|
+
deleteAccount(data: DeleteAccountData): Promise<any>;
|
|
92
124
|
/**
|
|
93
125
|
* Mettre à jour les paramètres d'un élément : Mise à jour des paramètres spécifiques d'un élément.
|
|
94
126
|
* Constant : UPDATE_SETTINGS
|
|
95
|
-
* @param
|
|
96
|
-
* @returns
|
|
127
|
+
* @param data - Données envoyées à l'API
|
|
128
|
+
* @returns Les données de réponse.
|
|
97
129
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
98
130
|
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
99
131
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
100
132
|
*/
|
|
101
|
-
updateSettings(data:
|
|
133
|
+
updateSettings(data: UpdateSettingsData): Promise<any>;
|
|
102
134
|
/**
|
|
103
135
|
* Mettre à jour la description d'un élément : Permet de mettre à jour la description courte et complète d'un élément.
|
|
104
136
|
* Constant : UPDATE_BLOCK_DESCRIPTION
|
|
105
|
-
* @param
|
|
106
|
-
* @returns
|
|
137
|
+
* @param data - Données envoyées à l'API
|
|
138
|
+
* @returns Les données de réponse.
|
|
107
139
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
108
140
|
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
109
141
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
110
142
|
*/
|
|
111
|
-
updateBlockDescription(data:
|
|
143
|
+
updateBlockDescription(data: UpdateBlockDescriptionData): Promise<any>;
|
|
112
144
|
/**
|
|
113
145
|
* Mettre à jour les informations d'un élément : Permet de mettre à jour les informations générales d'un élément (nom, contacts, etc.).
|
|
114
146
|
* Constant : UPDATE_BLOCK_INFO
|
|
115
|
-
* @param
|
|
116
|
-
* @returns
|
|
147
|
+
* @param data - Données envoyées à l'API
|
|
148
|
+
* @returns Les données de réponse.
|
|
117
149
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
118
150
|
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
119
151
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
120
152
|
*/
|
|
121
|
-
updateBlockInfo(data:
|
|
153
|
+
updateBlockInfo(data: UpdateBlockInfoData): Promise<any>;
|
|
122
154
|
/**
|
|
123
155
|
* 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.
|
|
124
156
|
* Constant : UPDATE_BLOCK_SOCIAL
|
|
125
|
-
* @param
|
|
126
|
-
* @returns
|
|
157
|
+
* @param data - Données envoyées à l'API
|
|
158
|
+
* @returns Les données de réponse.
|
|
127
159
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
128
160
|
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
129
161
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
130
162
|
*/
|
|
131
|
-
updateBlockSocial(data:
|
|
163
|
+
updateBlockSocial(data: UpdateBlockSocialData): Promise<any>;
|
|
132
164
|
/**
|
|
133
165
|
* Mettre à jour les localités d'un élément : Permet de mettre à jour l'adresse et les informations géographiques d'un élément.
|
|
134
166
|
* Constant : UPDATE_BLOCK_LOCALITY
|
|
135
|
-
* @param
|
|
136
|
-
* @returns
|
|
167
|
+
* @param data - Données envoyées à l'API
|
|
168
|
+
* @returns Les données de réponse.
|
|
137
169
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
138
170
|
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
139
171
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
140
172
|
*/
|
|
141
|
-
updateBlockLocality(data:
|
|
173
|
+
updateBlockLocality(data: UpdateBlockLocalityData): Promise<any>;
|
|
142
174
|
/**
|
|
143
175
|
* Mettre à jour le slug d'un élément : Permet de mettre à jour le slug pour une URL simplifiée.
|
|
144
176
|
* Constant : UPDATE_BLOCK_SLUG
|
|
145
|
-
* @param
|
|
146
|
-
* @returns
|
|
177
|
+
* @param data - Données envoyées à l'API
|
|
178
|
+
* @returns Les données de réponse.
|
|
147
179
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
148
180
|
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
149
181
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
150
182
|
*/
|
|
151
|
-
updateBlockSlug(data:
|
|
183
|
+
updateBlockSlug(data: UpdateBlockSlugData): Promise<any>;
|
|
152
184
|
/**
|
|
153
185
|
* Vérifier l'état d'une URL : Vérifie si une URL (slug) est valide ou disponible.
|
|
154
186
|
* Constant : CHECK
|
|
155
|
-
* @param
|
|
156
|
-
* @returns
|
|
187
|
+
* @param data - Données envoyées à l'API
|
|
188
|
+
* @returns Les données de réponse.
|
|
157
189
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
158
190
|
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
159
191
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
160
192
|
*/
|
|
161
|
-
check(data:
|
|
193
|
+
check(data: CheckData): Promise<any>;
|
|
162
194
|
/**
|
|
163
195
|
* Mettre à jour l'image de profil : Permet de mettre à jour l'image de profil d'un utilisateur ou d'une entité.
|
|
164
196
|
* Constant : PROFIL_IMAGE
|
|
165
|
-
* @param
|
|
166
|
-
* @returns
|
|
197
|
+
* @param data - Données envoyées à l'API
|
|
198
|
+
* @returns Les données de réponse.
|
|
167
199
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
168
200
|
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
169
201
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
170
202
|
*/
|
|
171
|
-
profilImage(data:
|
|
203
|
+
profilImage(data: ProfilImageData): Promise<any>;
|
|
172
204
|
/**
|
|
173
205
|
* 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.
|
|
174
206
|
* Constant : GET_ELEMENTS_ABOUT
|
|
175
|
-
* @param
|
|
176
|
-
* @returns
|
|
207
|
+
* @param data - Données envoyées à l'API
|
|
208
|
+
* @returns Les données de réponse.
|
|
177
209
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
178
210
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
179
211
|
*/
|
|
180
|
-
getElementsAbout(data:
|
|
212
|
+
getElementsAbout(data: GetElementsAboutData): Promise<any>;
|
|
181
213
|
/**
|
|
182
214
|
* Gérer des connexions multiples : Permet d’inviter ou de connecter plusieurs utilisateurs en même temps à une entité.
|
|
183
215
|
* Constant : MULTICONNECT
|
|
184
|
-
* @param
|
|
185
|
-
* @returns
|
|
216
|
+
* @param data - Données envoyées à l'API
|
|
217
|
+
* @returns Les données de réponse.
|
|
186
218
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
187
219
|
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
188
220
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
189
221
|
*/
|
|
190
|
-
multiconnect(data:
|
|
222
|
+
multiconnect(data: MulticonnectData): Promise<any>;
|
|
191
223
|
/**
|
|
192
224
|
* Récupérer les actualités : Récupère la liste d’actualités selon plusieurs critères.
|
|
193
225
|
* Constant : GET_NEWS
|
|
194
|
-
* @param
|
|
195
|
-
* @returns
|
|
226
|
+
* @param data - Données envoyées à l'API
|
|
227
|
+
* @returns Les données de réponse.
|
|
196
228
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
197
229
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
198
230
|
*/
|
|
199
|
-
getNews(data:
|
|
231
|
+
getNews(data: GetNewsData): Promise<any>;
|
|
200
232
|
/**
|
|
201
233
|
* Récupérer des actualités par IDs : Récupère des actualités à partir d’une liste d’identifiants.
|
|
202
234
|
* Constant : GET_NEWS_BY_ID
|
|
203
|
-
* @param
|
|
204
|
-
* @returns
|
|
235
|
+
* @param data - Données envoyées à l'API
|
|
236
|
+
* @returns Les données de réponse.
|
|
205
237
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
206
238
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
207
239
|
*/
|
|
208
|
-
getNewsById(data:
|
|
240
|
+
getNewsById(data: GetNewsByIdData): Promise<any>;
|
|
209
241
|
/**
|
|
210
242
|
* Ajouter une actualité : Ajoute une nouvelle actualité.
|
|
211
243
|
* Constant : ADD_NEWS
|
|
212
|
-
* @param
|
|
213
|
-
* @returns
|
|
244
|
+
* @param data - Données envoyées à l'API
|
|
245
|
+
* @returns Les données de réponse.
|
|
214
246
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
215
247
|
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
216
248
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
217
249
|
*/
|
|
218
|
-
addNews(data:
|
|
250
|
+
addNews(data: AddNewsData): Promise<any>;
|
|
219
251
|
/**
|
|
220
252
|
* Ajouter une image à une actualité : Ajoute une images à une actualité.
|
|
221
253
|
* Constant : ADD_IMAGE_NEWS
|
|
222
|
-
* @param
|
|
223
|
-
* @returns
|
|
254
|
+
* @param data - Données envoyées à l'API
|
|
255
|
+
* @returns Les données de réponse.
|
|
224
256
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
225
257
|
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
226
258
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
227
259
|
*/
|
|
228
|
-
addImageNews(data:
|
|
260
|
+
addImageNews(data: AddImageNewsData): Promise<any>;
|
|
229
261
|
/**
|
|
230
262
|
* Ajouter un fichier à une actualité : Ajoute un fichier à une actualité.
|
|
231
263
|
* Constant : ADD_FILE_NEWS
|
|
232
|
-
* @param
|
|
233
|
-
* @returns
|
|
264
|
+
* @param data - Données envoyées à l'API
|
|
265
|
+
* @returns Les données de réponse.
|
|
234
266
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
235
267
|
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
236
268
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
237
269
|
*/
|
|
238
|
-
addFileNews(data:
|
|
270
|
+
addFileNews(data: AddFileNewsData): Promise<any>;
|
|
239
271
|
/**
|
|
240
272
|
* Supprimer une actualité : Supprime une actualité existante.
|
|
241
273
|
* Constant : DELETE_NEWS
|
|
242
|
-
* @param
|
|
243
|
-
* @returns
|
|
274
|
+
* @param data - Données envoyées à l'API
|
|
275
|
+
* @returns Les données de réponse.
|
|
244
276
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
245
277
|
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
246
278
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
247
279
|
*/
|
|
248
|
-
deleteNews(data:
|
|
280
|
+
deleteNews(data: DeleteNewsData): Promise<any>;
|
|
249
281
|
/**
|
|
250
282
|
* Mettre à jour une actualité : Met à jour le contenu d’une actualité existante.
|
|
251
283
|
* Constant : UPDATE_NEWS
|
|
252
|
-
* @param
|
|
253
|
-
* @returns
|
|
284
|
+
* @param data - Données envoyées à l'API
|
|
285
|
+
* @returns Les données de réponse.
|
|
254
286
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
255
287
|
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
256
288
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
257
289
|
*/
|
|
258
|
-
updateNews(data:
|
|
290
|
+
updateNews(data: UpdateNewsData): Promise<any>;
|
|
259
291
|
/**
|
|
260
292
|
* Partager une actualité : Partage une actualité avec une entité ou un utilisateur.
|
|
261
293
|
* Constant : SHARE_NEWS
|
|
262
|
-
* @param
|
|
263
|
-
* @returns
|
|
294
|
+
* @param data - Données envoyées à l'API
|
|
295
|
+
* @returns Les données de réponse.
|
|
264
296
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
265
297
|
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
266
298
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
267
299
|
*/
|
|
268
|
-
shareNews(data:
|
|
300
|
+
shareNews(data: ShareNewsData): Promise<any>;
|
|
269
301
|
/**
|
|
270
302
|
* Récupérer les commentaires : Récupère les commentaires d’un élément.
|
|
271
303
|
* Constant : GET_COMMENTS
|
|
272
|
-
* @param
|
|
273
|
-
* @returns
|
|
304
|
+
* @param data - Données envoyées à l'API
|
|
305
|
+
* @returns Les données de réponse.
|
|
274
306
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
275
307
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
276
308
|
*/
|
|
277
|
-
getComments(data:
|
|
309
|
+
getComments(data: GetCommentsData): Promise<any>;
|
|
278
310
|
/**
|
|
279
311
|
* Ajouter un commentaire : Ajoute un commentaire à une actualité ou autre contexte.
|
|
280
312
|
* Constant : ADD_COMMENTS
|
|
281
|
-
* @param
|
|
282
|
-
* @returns
|
|
313
|
+
* @param data - Données envoyées à l'API
|
|
314
|
+
* @returns Les données de réponse.
|
|
283
315
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
284
316
|
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
285
317
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
286
318
|
*/
|
|
287
|
-
addComments(data:
|
|
319
|
+
addComments(data: AddCommentsData): Promise<any>;
|
|
288
320
|
/**
|
|
289
321
|
* Supprimer un commentaire : Supprime un commentaire existant.
|
|
290
322
|
* Constant : DELETE_COMMENTS
|
|
291
|
-
* @param
|
|
292
|
-
* @returns
|
|
323
|
+
* @param data - Données envoyées à l'API
|
|
324
|
+
* @returns Les données de réponse.
|
|
293
325
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
294
326
|
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
295
327
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
296
328
|
*/
|
|
297
|
-
deleteComments(data:
|
|
329
|
+
deleteComments(data: DeleteCommentsData): Promise<any>;
|
|
298
330
|
/**
|
|
299
331
|
* Mettre à jour un commentaire : Met à jour le contenu d’un commentaire.
|
|
300
332
|
* Constant : UPDATE_COMMENTS
|
|
301
|
-
* @param
|
|
302
|
-
* @returns
|
|
333
|
+
* @param data - Données envoyées à l'API
|
|
334
|
+
* @returns Les données de réponse.
|
|
303
335
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
304
336
|
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
305
337
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
306
338
|
*/
|
|
307
|
-
updateComments(data:
|
|
339
|
+
updateComments(data: UpdateCommentsData): Promise<any>;
|
|
308
340
|
/**
|
|
309
341
|
* Rechercher des tags : Recherche des tags correspondant à un mot-clé.
|
|
310
342
|
* Constant : SEARCH_TAGS
|
|
311
|
-
* @param
|
|
312
|
-
* @returns
|
|
343
|
+
* @param data - Données envoyées à l'API
|
|
344
|
+
* @returns Les données de réponse.
|
|
313
345
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
314
346
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
315
347
|
*/
|
|
316
|
-
searchTags(data:
|
|
348
|
+
searchTags(data: SearchTagsData): Promise<any>;
|
|
317
349
|
/**
|
|
318
350
|
* Afficher les votes d'une actualité : Récupère la liste des votes (like, love, etc.) sur une actualité.
|
|
319
351
|
* Constant : SHOW_VOTE
|
|
320
|
-
* @param
|
|
321
|
-
* @returns
|
|
352
|
+
* @param data - Données envoyées à l'API
|
|
353
|
+
* @returns Les données de réponse.
|
|
322
354
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
323
355
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
324
356
|
*/
|
|
325
|
-
showVote(data:
|
|
357
|
+
showVote(data: ShowVoteData): Promise<any>;
|
|
326
358
|
/**
|
|
327
359
|
* Recherche globale avec autocomplétion : Effectue une recherche globale avec possibilité d’autocomplétion.
|
|
328
360
|
* Constant : GLOBAL_AUTOCOMPLETE
|
|
329
|
-
* @param
|
|
330
|
-
* @returns
|
|
361
|
+
* @param data - Données envoyées à l'API
|
|
362
|
+
* @returns Les données de réponse.
|
|
331
363
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
332
364
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
333
365
|
*/
|
|
334
|
-
globalAutocomplete(data:
|
|
366
|
+
globalAutocomplete(data: GlobalAutocompleteData): Promise<any>;
|
|
335
367
|
/**
|
|
336
368
|
* Recherche de villes avec autocomplétion : Recherche des villes en fonction d’un nom, autocomplétion rapide.
|
|
337
369
|
* Constant : CITY_AUTOCOMPLETE
|
|
338
|
-
* @param
|
|
339
|
-
* @returns
|
|
370
|
+
* @param data - Données envoyées à l'API
|
|
371
|
+
* @returns Les données de réponse.
|
|
340
372
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
341
373
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
342
374
|
*/
|
|
343
|
-
cityAutocomplete(data:
|
|
375
|
+
cityAutocomplete(data: CityAutocompleteData): Promise<any>;
|
|
344
376
|
/**
|
|
345
377
|
* Recherche de villes par pays : Recherche de villes par pays avec autocomplétion.
|
|
346
378
|
* Constant : CITY_AUTOCOMPLETE_BY_COUNTRY
|
|
347
|
-
* @param
|
|
348
|
-
* @returns
|
|
379
|
+
* @param data - Données envoyées à l'API
|
|
380
|
+
* @returns Les données de réponse.
|
|
349
381
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
350
382
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
351
383
|
*/
|
|
352
|
-
cityAutocompleteByCountry(data:
|
|
384
|
+
cityAutocompleteByCountry(data: CityAutocompleteByCountryData): Promise<any>;
|
|
353
385
|
/**
|
|
354
386
|
* Suggestions d'entrée : Fournit des suggestions basées sur le nom recherché, etc.
|
|
355
387
|
* Constant : SUGGESTION_INPUT
|
|
356
|
-
* @param
|
|
357
|
-
* @returns
|
|
388
|
+
* @param data - Données envoyées à l'API
|
|
389
|
+
* @returns Les données de réponse.
|
|
358
390
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
359
391
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
360
392
|
*/
|
|
361
|
-
suggestionInput(data:
|
|
393
|
+
suggestionInput(data: SuggestionInputData): Promise<any>;
|
|
362
394
|
/**
|
|
363
395
|
* Récupérer les projets non administrables : Récupère les projets accessibles sans droits d'administration.
|
|
364
396
|
* Constant : GET_PROJECTS_NO_ADMIN
|
|
365
|
-
* @param
|
|
366
|
-
* @returns
|
|
397
|
+
* @param data - Données envoyées à l'API
|
|
398
|
+
* @returns Les données de réponse.
|
|
367
399
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
368
400
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
369
401
|
*/
|
|
370
|
-
getProjectsNoAdmin(data:
|
|
402
|
+
getProjectsNoAdmin(data: GetProjectsNoAdminData): Promise<any>;
|
|
371
403
|
/**
|
|
372
404
|
* Récupérer les projets administrables : Récupère les projets pour lesquels l'utilisateur a des droits d'administration.
|
|
373
405
|
* Constant : GET_PROJECTS_ADMIN
|
|
374
|
-
* @param
|
|
375
|
-
* @returns
|
|
406
|
+
* @param data - Données envoyées à l'API
|
|
407
|
+
* @returns Les données de réponse.
|
|
376
408
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
377
409
|
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
378
410
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
379
411
|
*/
|
|
380
|
-
getProjectsAdmin(data:
|
|
412
|
+
getProjectsAdmin(data: GetProjectsAdminData): Promise<any>;
|
|
381
413
|
/**
|
|
382
414
|
* Récupérer les POIs non administrables : Récupère la liste des POIs accessibles sans droits d'administration.
|
|
383
415
|
* Constant : GET_POIS_NO_ADMIN
|
|
384
|
-
* @param
|
|
385
|
-
* @returns
|
|
416
|
+
* @param data - Données envoyées à l'API
|
|
417
|
+
* @returns Les données de réponse.
|
|
386
418
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
387
419
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
388
420
|
*/
|
|
389
|
-
getPoisNoAdmin(data:
|
|
421
|
+
getPoisNoAdmin(data: GetPoisNoAdminData): Promise<any>;
|
|
390
422
|
/**
|
|
391
423
|
* Récupérer les POIs administrables : Récupère la liste des POIs administrables par l’utilisateur.
|
|
392
424
|
* Constant : GET_POIS_ADMIN
|
|
393
|
-
* @param
|
|
394
|
-
* @returns
|
|
425
|
+
* @param data - Données envoyées à l'API
|
|
426
|
+
* @returns Les données de réponse.
|
|
395
427
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
396
428
|
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
397
429
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
398
430
|
*/
|
|
399
|
-
getPoisAdmin(data:
|
|
431
|
+
getPoisAdmin(data: GetPoisAdminData): Promise<any>;
|
|
400
432
|
/**
|
|
401
433
|
* Récupérer les organisations non administrables : Récupère la liste des organisations auxquelles l’utilisateur appartient sans les administrer.
|
|
402
434
|
* Constant : GET_ORGANIZATIONS_NO_ADMIN
|
|
403
|
-
* @param
|
|
404
|
-
* @returns
|
|
435
|
+
* @param data - Données envoyées à l'API
|
|
436
|
+
* @returns Les données de réponse.
|
|
405
437
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
406
438
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
407
439
|
*/
|
|
408
|
-
getOrganizationsNoAdmin(data:
|
|
440
|
+
getOrganizationsNoAdmin(data: GetOrganizationsNoAdminData): Promise<any>;
|
|
409
441
|
/**
|
|
410
442
|
* Récupérer les organisations administrables : Récupère les organisations administrées par l’utilisateur.
|
|
411
443
|
* Constant : GET_ORGANIZATIONS_ADMIN
|
|
412
|
-
* @param
|
|
413
|
-
* @returns
|
|
444
|
+
* @param data - Données envoyées à l'API
|
|
445
|
+
* @returns Les données de réponse.
|
|
414
446
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
415
447
|
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
416
448
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
417
449
|
*/
|
|
418
|
-
getOrganizationsAdmin(data:
|
|
450
|
+
getOrganizationsAdmin(data: GetOrganizationsAdminData): Promise<any>;
|
|
419
451
|
/**
|
|
420
452
|
* Récupérer les membres non administrables : Récupère les membres d’une organisation sans droits d’admin.
|
|
421
453
|
* Constant : GET_MEMBERS_NO_ADMIN
|
|
422
|
-
* @param
|
|
423
|
-
* @returns
|
|
454
|
+
* @param data - Données envoyées à l'API
|
|
455
|
+
* @returns Les données de réponse.
|
|
424
456
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
425
457
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
426
458
|
*/
|
|
427
|
-
getMembersNoAdmin(data:
|
|
459
|
+
getMembersNoAdmin(data: GetMembersNoAdminData): Promise<any>;
|
|
428
460
|
/**
|
|
429
461
|
* Récupérer les membres administrables : Récupère les membres d’une organisation administrée par l’utilisateur.
|
|
430
462
|
* Constant : GET_MEMBERS_ADMIN
|
|
431
|
-
* @param
|
|
432
|
-
* @returns
|
|
463
|
+
* @param data - Données envoyées à l'API
|
|
464
|
+
* @returns Les données de réponse.
|
|
433
465
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
434
466
|
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
435
467
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
436
468
|
*/
|
|
437
|
-
getMembersAdmin(data:
|
|
469
|
+
getMembersAdmin(data: GetMembersAdminData): Promise<any>;
|
|
438
470
|
/**
|
|
439
471
|
* Récupérer les amis administrables : Récupère les amis administrée par l’utilisateur.
|
|
440
472
|
* Constant : GET_FRIENDS_ADMIN
|
|
441
|
-
* @param
|
|
442
|
-
* @returns
|
|
473
|
+
* @param data - Données envoyées à l'API
|
|
474
|
+
* @returns Les données de réponse.
|
|
443
475
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
444
476
|
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
445
477
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
446
478
|
*/
|
|
447
|
-
getFriendsAdmin(data:
|
|
479
|
+
getFriendsAdmin(data: GetFriendsAdminData): Promise<any>;
|
|
448
480
|
/**
|
|
449
481
|
* Récupérer les suivis non administrables : Liste les entités suivies sans droits d’admin.
|
|
450
482
|
* Constant : GET_SUBSCRIPTIONS
|
|
451
|
-
* @param
|
|
452
|
-
* @returns
|
|
483
|
+
* @param data - Données envoyées à l'API
|
|
484
|
+
* @returns Les données de réponse.
|
|
453
485
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
454
486
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
455
487
|
*/
|
|
456
|
-
getSubscriptions(data:
|
|
488
|
+
getSubscriptions(data: GetSubscriptionsData): Promise<any>;
|
|
457
489
|
/**
|
|
458
490
|
* Récupérer les suivis administrables : Liste les entités suivies par l’utilisateur, sur lesquelles il est admin.
|
|
459
491
|
* Constant : GET_SUBSCRIPTIONS_ADMIN
|
|
460
|
-
* @param
|
|
461
|
-
* @returns
|
|
492
|
+
* @param data - Données envoyées à l'API
|
|
493
|
+
* @returns Les données de réponse.
|
|
462
494
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
463
495
|
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
464
496
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
465
497
|
*/
|
|
466
|
-
getSubscriptionsAdmin(data:
|
|
498
|
+
getSubscriptionsAdmin(data: GetSubscriptionsAdminData): Promise<any>;
|
|
467
499
|
/**
|
|
468
500
|
* Récupérer les abonnés non administrables : Liste les abonnés sans droits d’admin.
|
|
469
501
|
* Constant : GET_SUBSCRIBERS
|
|
470
|
-
* @param
|
|
471
|
-
* @returns
|
|
502
|
+
* @param data - Données envoyées à l'API
|
|
503
|
+
* @returns Les données de réponse.
|
|
472
504
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
473
505
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
474
506
|
*/
|
|
475
|
-
getSubscribers(data:
|
|
507
|
+
getSubscribers(data: GetSubscribersData): Promise<any>;
|
|
476
508
|
/**
|
|
477
509
|
* Récupérer les abonnés administrables : Liste les abonnés d’une entité administrée par l’utilisateur.
|
|
478
510
|
* Constant : GET_SUBSCRIBERS_ADMIN
|
|
479
|
-
* @param
|
|
480
|
-
* @returns
|
|
511
|
+
* @param data - Données envoyées à l'API
|
|
512
|
+
* @returns Les données de réponse.
|
|
481
513
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
482
514
|
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
483
515
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
484
516
|
*/
|
|
485
|
-
getSubscribersAdmin(data:
|
|
517
|
+
getSubscribersAdmin(data: GetSubscribersAdminData): Promise<any>;
|
|
486
518
|
/**
|
|
487
519
|
* Récupérer les contributeurs non administrables : Récupère les contributeurs sans droits d’admin.
|
|
488
520
|
* Constant : GET_CONTRIBUTORS_NO_ADMIN
|
|
489
|
-
* @param
|
|
490
|
-
* @returns
|
|
521
|
+
* @param data - Données envoyées à l'API
|
|
522
|
+
* @returns Les données de réponse.
|
|
491
523
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
492
524
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
493
525
|
*/
|
|
494
|
-
getContributorsNoAdmin(data:
|
|
526
|
+
getContributorsNoAdmin(data: GetContributorsNoAdminData): Promise<any>;
|
|
495
527
|
/**
|
|
496
528
|
* Récupérer les contributeurs administrables : Récupère les contributeurs d’un project l’utilisateur est admin.
|
|
497
529
|
* Constant : GET_CONTRIBUTORS_ADMIN
|
|
498
|
-
* @param
|
|
499
|
-
* @returns
|
|
530
|
+
* @param data - Données envoyées à l'API
|
|
531
|
+
* @returns Les données de réponse.
|
|
500
532
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
501
533
|
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
502
534
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
503
535
|
*/
|
|
504
|
-
getContributorsAdmin(data:
|
|
536
|
+
getContributorsAdmin(data: GetContributorsAdminData): Promise<any>;
|
|
505
537
|
/**
|
|
506
538
|
* Recherche globale des badges : Recherche des badges publics en fonction de divers critères.
|
|
507
539
|
* Constant : GET_BADGES
|
|
508
|
-
* @param
|
|
509
|
-
* @returns
|
|
540
|
+
* @param data - Données envoyées à l'API
|
|
541
|
+
* @returns Les données de réponse.
|
|
510
542
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
511
543
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
512
544
|
*/
|
|
513
|
-
getBadges(data:
|
|
545
|
+
getBadges(data: GetBadgesData): Promise<any>;
|
|
514
546
|
/**
|
|
515
547
|
* Recherche globale des badges : Recherche des badges publics en fonction de divers critères.
|
|
516
548
|
* Constant : GET_BADGES_FILTERS
|
|
517
|
-
* @param
|
|
518
|
-
* @returns
|
|
549
|
+
* @param data - Données envoyées à l'API
|
|
550
|
+
* @returns Les données de réponse.
|
|
519
551
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
520
552
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
521
553
|
*/
|
|
522
|
-
getBadgesFilters(data:
|
|
554
|
+
getBadgesFilters(data: GetBadgesFiltersData): Promise<any>;
|
|
523
555
|
/**
|
|
524
556
|
* Suivre un élément : Permet à un utilisateur de suivre un élément (projet, organisation...).
|
|
525
557
|
* Constant : CONNECT
|
|
526
|
-
* @param
|
|
527
|
-
* @returns
|
|
558
|
+
* @param data - Données envoyées à l'API
|
|
559
|
+
* @returns Les données de réponse.
|
|
528
560
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
529
561
|
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
530
562
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
531
563
|
*/
|
|
532
|
-
connect(data:
|
|
564
|
+
connect(data: ConnectData): Promise<any>;
|
|
533
565
|
/**
|
|
534
566
|
* Se déconnecter d'un élément : Permet de supprimer le lien entre un utilisateur et un élément.
|
|
535
567
|
* Constant : DISCONNECT
|
|
536
|
-
* @param
|
|
537
|
-
* @returns
|
|
568
|
+
* @param data - Données envoyées à l'API
|
|
569
|
+
* @returns Les données de réponse.
|
|
538
570
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
539
571
|
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
540
572
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
541
573
|
*/
|
|
542
|
-
disconnect(data:
|
|
574
|
+
disconnect(data: DisconnectData): Promise<any>;
|
|
543
575
|
/**
|
|
544
576
|
* 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
|
|
545
577
|
* Constant : GET_ELEMENTS_KEY
|
|
546
|
-
* @param
|
|
547
|
-
* @returns
|
|
578
|
+
* @param data - Données envoyées à l'API
|
|
579
|
+
* @returns Les données de réponse.
|
|
548
580
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
549
581
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
550
582
|
*/
|
|
551
|
-
getElementsKey(data:
|
|
583
|
+
getElementsKey(data: GetElementsKeyData): Promise<any>;
|
|
552
584
|
/**
|
|
553
585
|
* Récupérer les favoris d'un utilisateur : Récupère la liste des favoris d’un utilisateur.
|
|
554
586
|
* Constant : GET_FAVORIS
|
|
555
|
-
* @param
|
|
556
|
-
* @returns
|
|
587
|
+
* @param data - Données envoyées à l'API
|
|
588
|
+
* @returns Les données de réponse.
|
|
557
589
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
558
590
|
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
559
591
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
560
592
|
*/
|
|
561
|
-
getFavoris(data:
|
|
593
|
+
getFavoris(data: GetFavorisData): Promise<any>;
|
|
562
594
|
/**
|
|
563
595
|
* Supprimer un favori : Supprime un élément des favoris de l’utilisateur.
|
|
564
596
|
* Constant : DELETE_FAVORIS
|
|
565
|
-
* @param
|
|
566
|
-
* @returns
|
|
597
|
+
* @param data - Données envoyées à l'API
|
|
598
|
+
* @returns Les données de réponse.
|
|
567
599
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
568
600
|
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
569
601
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
570
602
|
*/
|
|
571
|
-
deleteFavoris(data:
|
|
603
|
+
deleteFavoris(data: DeleteFavorisData): Promise<any>;
|
|
572
604
|
/**
|
|
573
605
|
* Ajouter un favori : Ajoute un élément aux favoris de l’utilisateur.
|
|
574
606
|
* Constant : ADD_FAVORIS
|
|
575
|
-
* @param
|
|
576
|
-
* @returns
|
|
607
|
+
* @param data - Données envoyées à l'API
|
|
608
|
+
* @returns Les données de réponse.
|
|
577
609
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
578
610
|
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
579
611
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
580
612
|
*/
|
|
581
|
-
addFavoris(data:
|
|
613
|
+
addFavoris(data: AddFavorisData): Promise<any>;
|
|
582
614
|
/**
|
|
583
615
|
* Créer une organisation : Crée une nouvelle organisation.
|
|
584
616
|
* Constant : ADD_ORGANIZATION
|
|
585
|
-
* @param
|
|
586
|
-
* @returns
|
|
617
|
+
* @param data - Données envoyées à l'API
|
|
618
|
+
* @returns Les données de réponse.
|
|
587
619
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
588
620
|
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
589
621
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
590
622
|
*/
|
|
591
|
-
addOrganization(data:
|
|
623
|
+
addOrganization(data: AddOrganizationData): Promise<any>;
|
|
592
624
|
/**
|
|
593
625
|
* Créer un projet : Crée un nouveau projet avec des informations de base et des options supplémentaires.
|
|
594
626
|
* Constant : ADD_PROJECT
|
|
595
|
-
* @param
|
|
596
|
-
* @returns
|
|
627
|
+
* @param data - Données envoyées à l'API
|
|
628
|
+
* @returns Les données de réponse.
|
|
597
629
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
598
630
|
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
599
631
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
600
632
|
*/
|
|
601
|
-
addProject(data:
|
|
633
|
+
addProject(data: AddProjectData): Promise<any>;
|
|
602
634
|
/**
|
|
603
635
|
* Créer un POI : Crée un nouveau POI (Point d'Intérêt).
|
|
604
636
|
* Constant : ADD_POI
|
|
605
|
-
* @param
|
|
606
|
-
* @returns
|
|
637
|
+
* @param data - Données envoyées à l'API
|
|
638
|
+
* @returns Les données de réponse.
|
|
607
639
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
608
640
|
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
609
641
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
610
642
|
*/
|
|
611
|
-
addPoi(data:
|
|
643
|
+
addPoi(data: AddPoiData): Promise<any>;
|
|
612
644
|
/**
|
|
613
645
|
* Créer un événement : Crée un nouvel événement.
|
|
614
646
|
* Constant : ADD_EVENT
|
|
615
|
-
* @param
|
|
616
|
-
* @returns
|
|
647
|
+
* @param data - Données envoyées à l'API
|
|
648
|
+
* @returns Les données de réponse.
|
|
617
649
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
618
650
|
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
619
651
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
620
652
|
*/
|
|
621
|
-
addEvent(data:
|
|
653
|
+
addEvent(data: AddEventData): Promise<any>;
|
|
622
654
|
/**
|
|
623
655
|
* Supprimer un POI : Supprime un POI existant.
|
|
624
656
|
* Constant : DELETE_POI
|
|
625
|
-
* @param
|
|
626
|
-
* @returns
|
|
657
|
+
* @param data - Données envoyées à l'API
|
|
658
|
+
* @returns Les données de réponse.
|
|
627
659
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
628
660
|
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
629
661
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
630
662
|
*/
|
|
631
|
-
deletePoi(data:
|
|
663
|
+
deletePoi(data: DeletePoiData): Promise<any>;
|
|
632
664
|
/**
|
|
633
665
|
* Supprimer un événement : Supprime un événement spécifique.
|
|
634
666
|
* Constant : DELETE_EVENT
|
|
635
|
-
* @param
|
|
636
|
-
* @returns
|
|
667
|
+
* @param data - Données envoyées à l'API
|
|
668
|
+
* @returns Les données de réponse.
|
|
637
669
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
638
670
|
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
639
671
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
640
672
|
*/
|
|
641
|
-
deleteEvent(data:
|
|
673
|
+
deleteEvent(data: DeleteEventData): Promise<any>;
|
|
642
674
|
/**
|
|
643
675
|
* Supprimer un élément : Supprime un élément existant.
|
|
644
676
|
* Constant : DELETE_ELEMENT
|
|
645
|
-
* @param
|
|
646
|
-
* @returns
|
|
677
|
+
* @param data - Données envoyées à l'API
|
|
678
|
+
* @returns Les données de réponse.
|
|
647
679
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
648
680
|
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
649
681
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
650
682
|
*/
|
|
651
|
-
deleteElement(data:
|
|
683
|
+
deleteElement(data: DeleteElementData): Promise<any>;
|
|
652
684
|
/**
|
|
653
685
|
* Ajouter une image à un élément : Ajoute une image à un élément.
|
|
654
686
|
* Constant : ADD_IMAGE_ELEMENT
|
|
655
|
-
* @param
|
|
656
|
-
* @returns
|
|
687
|
+
* @param data - Données envoyées à l'API
|
|
688
|
+
* @returns Les données de réponse.
|
|
657
689
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
658
690
|
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
659
691
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
660
692
|
*/
|
|
661
|
-
addImageElement(data:
|
|
693
|
+
addImageElement(data: AddImageElementData): Promise<any>;
|
|
662
694
|
/**
|
|
663
695
|
* Valider un lien : Permet de valider un lien (ex: rejoindre un projet, accepter un membre...).
|
|
664
696
|
* Constant : LINK_VALIDATE
|
|
665
|
-
* @param
|
|
666
|
-
* @returns
|
|
697
|
+
* @param data - Données envoyées à l'API
|
|
698
|
+
* @returns Les données de réponse.
|
|
667
699
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
668
700
|
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
669
701
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
670
702
|
*/
|
|
671
|
-
linkValidate(data:
|
|
703
|
+
linkValidate(data: LinkValidateData): Promise<any>;
|
|
672
704
|
/**
|
|
673
705
|
* Recherche avec autocomplétion (membres) : Recherche des membres avec autocomplétion.
|
|
674
706
|
* Constant : SEARCH_MEMBER_AUTOCOMPLETE
|
|
675
|
-
* @param
|
|
676
|
-
* @returns
|
|
707
|
+
* @param data - Données envoyées à l'API
|
|
708
|
+
* @returns Les données de réponse.
|
|
677
709
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
678
710
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
679
711
|
*/
|
|
680
|
-
searchMemberAutocomplete(data:
|
|
712
|
+
searchMemberAutocomplete(data: SearchMemberAutocompleteData): Promise<any>;
|
|
681
713
|
/**
|
|
682
714
|
* Récupérer les notifications : Récupère la liste des notifications pour un utilisateur.
|
|
683
715
|
* Constant : GET_NOTIFICATIONS
|
|
684
|
-
* @param
|
|
685
|
-
* @returns
|
|
716
|
+
* @param data - Données envoyées à l'API
|
|
717
|
+
* @returns Les données de réponse.
|
|
686
718
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
687
719
|
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
688
720
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
689
721
|
*/
|
|
690
|
-
getNotifications(data:
|
|
722
|
+
getNotifications(data: GetNotificationsData): Promise<any>;
|
|
691
723
|
/**
|
|
692
724
|
* Récupérer le nombre de notifications : Récupère le nombre de notifications pour un utilisateur.
|
|
693
725
|
* Constant : GET_NOTIFICATIONS_COUNT
|
|
694
|
-
* @param
|
|
695
|
-
* @returns
|
|
726
|
+
* @param data - Données envoyées à l'API
|
|
727
|
+
* @returns Les données de réponse.
|
|
696
728
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
697
729
|
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
698
730
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
699
731
|
*/
|
|
700
|
-
getNotificationsCount(data:
|
|
732
|
+
getNotificationsCount(data: GetNotificationsCountData): Promise<any>;
|
|
701
733
|
/**
|
|
702
734
|
* Mettre à jour toutes les notifications : Marque toutes les notifications comme vues ou lues.
|
|
703
735
|
* Constant : NOTIFICATION_UPDATE
|
|
704
|
-
* @param
|
|
705
|
-
* @returns
|
|
736
|
+
* @param data - Données envoyées à l'API
|
|
737
|
+
* @returns Les données de réponse.
|
|
706
738
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
707
739
|
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
708
740
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
709
741
|
*/
|
|
710
|
-
notificationUpdate(data:
|
|
742
|
+
notificationUpdate(data: NotificationUpdateData): Promise<any>;
|
|
711
743
|
/**
|
|
712
744
|
* Supprimer toutes les notifications : Supprime toutes les notifications de l’utilisateur.
|
|
713
745
|
* Constant : REMOVE_ALL_NOTIFICATIONS
|
|
714
|
-
* @returns
|
|
746
|
+
* @returns Les données de réponse.
|
|
715
747
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
716
748
|
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
717
749
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
@@ -720,54 +752,54 @@ declare class EndpointApi {
|
|
|
720
752
|
/**
|
|
721
753
|
* Marquer une notification comme lue : Marque une notification spécifique comme lue.
|
|
722
754
|
* Constant : MARK_NOTIFICATION_AS_READ
|
|
723
|
-
* @param
|
|
724
|
-
* @returns
|
|
755
|
+
* @param data - Données envoyées à l'API
|
|
756
|
+
* @returns Les données de réponse.
|
|
725
757
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
726
758
|
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
727
759
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
728
760
|
*/
|
|
729
|
-
markNotificationAsRead(data:
|
|
761
|
+
markNotificationAsRead(data: MarkNotificationAsReadData): Promise<any>;
|
|
730
762
|
/**
|
|
731
763
|
* Recherche ActivityPub : Recherche des éléments ActivityPub selon une adresse ou un terme.
|
|
732
764
|
* Constant : ACTIVITYPUB_SEARCH
|
|
733
|
-
* @param
|
|
734
|
-
* @returns
|
|
765
|
+
* @param data - Données envoyées à l'API
|
|
766
|
+
* @returns Les données de réponse.
|
|
735
767
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
736
768
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
737
769
|
*/
|
|
738
|
-
activitypubSearch(data:
|
|
770
|
+
activitypubSearch(data: ActivitypubSearchData): Promise<any>;
|
|
739
771
|
/**
|
|
740
772
|
* Mettre à jour une activité (ActivityPub) : Met à jour une activité ActivityPub avec une action et un payload.
|
|
741
773
|
* Constant : ACTIVITYPUB_LINK
|
|
742
|
-
* @param
|
|
743
|
-
* @returns
|
|
774
|
+
* @param data - Données envoyées à l'API
|
|
775
|
+
* @returns Les données de réponse.
|
|
744
776
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
745
777
|
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
746
778
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
747
779
|
*/
|
|
748
|
-
activitypubLink(data:
|
|
780
|
+
activitypubLink(data: ActivitypubLinkData): Promise<any>;
|
|
749
781
|
/**
|
|
750
782
|
* Obtenir la liste ActivityPub : Obtient la liste des communautés ActivityPub pour un utilisateur.
|
|
751
783
|
* Constant : ACTIVITYPUB_GET_COMMUNITY
|
|
752
|
-
* @param
|
|
753
|
-
* @returns
|
|
784
|
+
* @param data - Données envoyées à l'API
|
|
785
|
+
* @returns Les données de réponse.
|
|
754
786
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
755
787
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
756
788
|
*/
|
|
757
|
-
activitypubGetCommunity(data:
|
|
789
|
+
activitypubGetCommunity(data: ActivitypubGetCommunityData): Promise<any>;
|
|
758
790
|
/**
|
|
759
791
|
* Récupérer les informations d'un badge : Récupère les détails d’un badge par son ID.
|
|
760
792
|
* Constant : GET_BADGE
|
|
761
|
-
* @param
|
|
762
|
-
* @returns
|
|
793
|
+
* @param data - Données envoyées à l'API
|
|
794
|
+
* @returns Les données de réponse.
|
|
763
795
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
764
796
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
765
797
|
*/
|
|
766
|
-
getBadge(data:
|
|
798
|
+
getBadge(data: GetBadgeData): Promise<any>;
|
|
767
799
|
/**
|
|
768
800
|
* Obtenir la liste des émetteurs de badges : Récupère la liste des émetteurs pour les badges.
|
|
769
801
|
* Constant : GET_EMETTEUR_BADGES
|
|
770
|
-
* @returns
|
|
802
|
+
* @returns Les données de réponse.
|
|
771
803
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
772
804
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
773
805
|
*/
|
|
@@ -775,159 +807,179 @@ declare class EndpointApi {
|
|
|
775
807
|
/**
|
|
776
808
|
* Créer un badge : Crée un nouveau badge avec des informations détaillées.
|
|
777
809
|
* Constant : ADD_BADGES
|
|
778
|
-
* @param
|
|
779
|
-
* @returns
|
|
810
|
+
* @param data - Données envoyées à l'API
|
|
811
|
+
* @returns Les données de réponse.
|
|
780
812
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
781
813
|
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
782
814
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
783
815
|
*/
|
|
784
|
-
addBadges(data:
|
|
816
|
+
addBadges(data: AddBadgesData): Promise<any>;
|
|
785
817
|
/**
|
|
786
818
|
* Attribuer un badge : Attribue un badge à une ou plusieurs personnes ou entités.
|
|
787
819
|
* Constant : ASSIGN_BADGES
|
|
788
|
-
* @param
|
|
789
|
-
* @returns
|
|
820
|
+
* @param data - Données envoyées à l'API
|
|
821
|
+
* @returns Les données de réponse.
|
|
790
822
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
791
823
|
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
792
824
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
793
825
|
*/
|
|
794
|
-
assignBadges(data:
|
|
826
|
+
assignBadges(data: AssignBadgesData): Promise<any>;
|
|
795
827
|
/**
|
|
796
828
|
* Obtenir la liste des événements : Permet de rechercher des événements selon plusieurs critères (dates, nom, type...).
|
|
797
829
|
* Constant : GET_EVENTS
|
|
798
|
-
* @param
|
|
799
|
-
* @returns
|
|
830
|
+
* @param data - Données envoyées à l'API
|
|
831
|
+
* @returns Les données de réponse.
|
|
800
832
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
801
833
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
802
834
|
*/
|
|
803
|
-
getEvents(data:
|
|
835
|
+
getEvents(data: GetEventsData): Promise<any>;
|
|
804
836
|
/**
|
|
805
837
|
* Partager un événement : Partage un événement avec d’autres utilisateurs ou entités.
|
|
806
838
|
* Constant : SHARE_EVENTS
|
|
807
|
-
* @param
|
|
808
|
-
* @returns
|
|
839
|
+
* @param data - Données envoyées à l'API
|
|
840
|
+
* @returns Les données de réponse.
|
|
809
841
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
810
842
|
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
811
843
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
812
844
|
*/
|
|
813
|
-
shareEvents(data:
|
|
845
|
+
shareEvents(data: ShareEventsData): Promise<any>;
|
|
814
846
|
/**
|
|
815
847
|
* Inviter des participants à un événement : Invite plusieurs utilisateurs ou entités à participer à un événement.
|
|
816
848
|
* Constant : INVITE_EVENT
|
|
817
|
-
* @param
|
|
818
|
-
* @returns
|
|
849
|
+
* @param data - Données envoyées à l'API
|
|
850
|
+
* @returns Les données de réponse.
|
|
819
851
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
820
852
|
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
821
853
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
822
854
|
*/
|
|
823
|
-
inviteEvent(data:
|
|
855
|
+
inviteEvent(data: InviteEventData): Promise<any>;
|
|
824
856
|
/**
|
|
825
857
|
* Suivre un utilisateur ou un élément : Suivre un utilisateur ou un élément.
|
|
826
858
|
* Constant : FOLLOW
|
|
827
|
-
* @param
|
|
828
|
-
* @returns
|
|
859
|
+
* @param data - Données envoyées à l'API
|
|
860
|
+
* @returns Les données de réponse.
|
|
829
861
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
830
862
|
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
831
863
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
832
864
|
*/
|
|
833
|
-
follow(data:
|
|
865
|
+
follow(data: FollowData): Promise<any>;
|
|
834
866
|
/**
|
|
835
867
|
* Récuperer les data d'un JSON d'un costum : Récuperer les data d'un JSON d'un costum
|
|
836
868
|
* Constant : GET_COSTUM_JSON
|
|
837
|
-
* @param
|
|
838
|
-
* @returns
|
|
869
|
+
* @param data - Données envoyées à l'API
|
|
870
|
+
* @returns Les données de réponse.
|
|
839
871
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
840
872
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
841
873
|
*/
|
|
842
|
-
getCostumJson(data:
|
|
874
|
+
getCostumJson(data: GetCostumJsonData): Promise<any>;
|
|
843
875
|
/**
|
|
844
876
|
* Recherche globale lier à un costum : Effectue une recherche globale lier à un costum
|
|
845
877
|
* Constant : GLOBAL_AUTOCOMPLETE_COSTUM
|
|
846
|
-
* @param
|
|
847
|
-
* @returns
|
|
878
|
+
* @param data - Données envoyées à l'API
|
|
879
|
+
* @returns Les données de réponse.
|
|
848
880
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
849
881
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
850
882
|
*/
|
|
851
|
-
globalAutocompleteCostum(data:
|
|
883
|
+
globalAutocompleteCostum(data: GlobalAutocompleteCostumData): Promise<any>;
|
|
852
884
|
/**
|
|
853
885
|
* Récupérer les acteurs d'événement : Récupérer les acteurs (organizers, attendees, creators, animators) d'une entité événement.
|
|
854
886
|
* Constant : COSTUM_EVENT_REQUEST_ACTORS
|
|
855
|
-
* @param
|
|
856
|
-
* @returns
|
|
887
|
+
* @param data - Données envoyées à l'API
|
|
888
|
+
* @returns Les données de réponse.
|
|
857
889
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
858
890
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
859
891
|
*/
|
|
860
|
-
costumEventRequestActors(data:
|
|
892
|
+
costumEventRequestActors(data: CostumEventRequestActorsData): Promise<any>;
|
|
861
893
|
/**
|
|
862
894
|
* 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.
|
|
863
895
|
* Constant : COSTUM_EVENT_REQUEST_SUBEVENTS
|
|
864
|
-
* @param
|
|
865
|
-
* @returns
|
|
896
|
+
* @param data - Données envoyées à l'API
|
|
897
|
+
* @returns Les données de réponse.
|
|
866
898
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
867
899
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
868
900
|
*/
|
|
869
|
-
costumEventRequestSubevents(data:
|
|
901
|
+
costumEventRequestSubevents(data: CostumEventRequestSubeventsData): Promise<any>;
|
|
870
902
|
/**
|
|
871
903
|
* Récupérer les événements liés à un élément : Retourne les événements liés à une entité (via links.events ou parent).
|
|
872
904
|
* Constant : COSTUM_EVENT_REQUEST_ELEMENT_EVENT
|
|
873
|
-
* @param
|
|
874
|
-
* @returns
|
|
905
|
+
* @param data - Données envoyées à l'API
|
|
906
|
+
* @returns Les données de réponse.
|
|
875
907
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
876
908
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
877
909
|
*/
|
|
878
|
-
costumEventRequestElementEvent(data:
|
|
910
|
+
costumEventRequestElementEvent(data: CostumEventRequestElementEventData): Promise<any>;
|
|
879
911
|
/**
|
|
880
912
|
* Récupérer les catégories d’événements : Retourne la liste des types (catégories) d’événements enfants liés à l'entité.
|
|
881
913
|
* Constant : COSTUM_EVENT_REQUEST_CATEGORIES
|
|
882
|
-
* @param
|
|
883
|
-
* @returns
|
|
914
|
+
* @param data - Données envoyées à l'API
|
|
915
|
+
* @returns Les données de réponse.
|
|
884
916
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
885
917
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
886
918
|
*/
|
|
887
|
-
costumEventRequestCategories(data:
|
|
919
|
+
costumEventRequestCategories(data: CostumEventRequestCategoriesData): Promise<any>;
|
|
888
920
|
/**
|
|
889
921
|
* Récupérer les dates de sous-événements : Retourne les dates des sous-événements à venir et passés, groupées par jour.
|
|
890
922
|
* Constant : COSTUM_EVENT_REQUEST_DATES
|
|
891
|
-
* @param
|
|
892
|
-
* @returns
|
|
923
|
+
* @param data - Données envoyées à l'API
|
|
924
|
+
* @returns Les données de réponse.
|
|
893
925
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
894
926
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
895
927
|
*/
|
|
896
|
-
costumEventRequestDates(data:
|
|
928
|
+
costumEventRequestDates(data: CostumEventRequestDatesData): Promise<any>;
|
|
897
929
|
/**
|
|
898
930
|
* Récupérer un événement par ID : Retourne les informations détaillées d’un événement par son ID.
|
|
899
931
|
* Constant : COSTUM_EVENT_REQUEST_EVENT
|
|
900
|
-
* @param
|
|
901
|
-
* @returns
|
|
932
|
+
* @param data - Données envoyées à l'API
|
|
933
|
+
* @returns Les données de réponse.
|
|
902
934
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
903
935
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
904
936
|
*/
|
|
905
|
-
costumEventRequestEvent(data:
|
|
937
|
+
costumEventRequestEvent(data: CostumEventRequestEventData): Promise<any>;
|
|
906
938
|
/**
|
|
907
939
|
* Associer une structure à un événement (adresse) : Associe une structure existante à un événement en copiant son adresse.
|
|
908
940
|
* Constant : COSTUM_EVENT_REQUEST_LINK_TL_TO_EVENT
|
|
909
|
-
* @param
|
|
910
|
-
* @returns
|
|
941
|
+
* @param data - Données envoyées à l'API
|
|
942
|
+
* @returns Les données de réponse.
|
|
911
943
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
912
944
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
913
945
|
*/
|
|
914
|
-
costumEventRequestLinkTlToEvent(data:
|
|
946
|
+
costumEventRequestLinkTlToEvent(data: CostumEventRequestLinkTlToEventData): Promise<any>;
|
|
915
947
|
/**
|
|
916
948
|
* 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.
|
|
917
949
|
* Constant : COSTUM_EVENT_REQUEST_LOAD_CONTEXT_TAG
|
|
918
|
-
* @param
|
|
919
|
-
* @returns
|
|
950
|
+
* @param data - Données envoyées à l'API
|
|
951
|
+
* @returns Les données de réponse.
|
|
920
952
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
921
953
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
922
954
|
*/
|
|
923
|
-
costumEventRequestLoadContextTag(data:
|
|
955
|
+
costumEventRequestLoadContextTag(data: CostumEventRequestLoadContextTagData): Promise<any>;
|
|
924
956
|
/**
|
|
925
957
|
* Récupération de la galerie : Renvoie soit la liste d’albums associés à une entité, soit les images d’un album spécifique.
|
|
926
958
|
* Constant : GET_GALLERY
|
|
927
|
-
* @param
|
|
928
|
-
* @returns
|
|
959
|
+
* @param data - Données envoyées à l'API
|
|
960
|
+
* @returns Les données de réponse.
|
|
961
|
+
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
962
|
+
* @throws {Error} - En cas d'erreur inattendue.
|
|
963
|
+
*/
|
|
964
|
+
getGallery(data: GetGalleryData): Promise<any>;
|
|
965
|
+
/**
|
|
966
|
+
* Récupérer les participants non administrables : Récupère les participants sans droits d’admin.
|
|
967
|
+
* Constant : GET_ATTENDEES_NO_ADMIN
|
|
968
|
+
* @param data - Données envoyées à l'API
|
|
969
|
+
* @returns Les données de réponse.
|
|
929
970
|
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
930
971
|
* @throws {Error} - En cas d'erreur inattendue.
|
|
931
972
|
*/
|
|
932
|
-
|
|
973
|
+
getAttendeesNoAdmin(data: GetAttendeesNoAdminData): Promise<any>;
|
|
974
|
+
/**
|
|
975
|
+
* Récupérer les participants administrables : Récupère les participants d’un événement si l’utilisateur est admin.
|
|
976
|
+
* Constant : GET_ATTENDEES_ADMIN
|
|
977
|
+
* @param data - Données envoyées à l'API
|
|
978
|
+
* @returns Les données de réponse.
|
|
979
|
+
* @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
|
|
980
|
+
* @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
|
|
981
|
+
* @throws {Error} - En cas d'erreur inattendue.
|
|
982
|
+
*/
|
|
983
|
+
getAttendeesAdmin(data: GetAttendeesAdminData): Promise<any>;
|
|
933
984
|
}
|
|
985
|
+
export default EndpointApi;
|