@communecter/cocolight-api-client 1.0.76 → 1.0.78

package/types/api/EndpointApi.d.ts

@@ -1,5 +1,5 @@
 import type ApiClient from "../ApiClient.js";
-import type { PersonRegisterData, AuthenticateUrlData, RefreshTokenUrlData, PasswordRecoveryData, ServerExchangeTokenData, ChangePasswordData, DeleteAccountData, UpdateSettingsData, UpdateBlockDescriptionData, UpdateBlockInfoData, UpdateBlockSocialData, UpdateBlockLocalityData, UpdateBlockSlugData, CheckData, ProfilImageData, ProfilBannerData, 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, CoformAnswersSearchData, CoformAnswersByIdData, AddVoteData, AddReportAbuseData, UpdatePathValueData } from "./EndpointApi.types.js";
+import type { PersonRegisterData, AuthenticateUrlData, RefreshTokenUrlData, PasswordRecoveryData, ServerExchangeTokenData, ChangePasswordData, DeleteAccountData, UpdateSettingsData, UpdateBlockDescriptionData, UpdateBlockInfoData, UpdateBlockSocialData, UpdateBlockLocalityData, UpdateBlockSlugData, CheckData, ProfilImageData, ProfilBannerData, 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, CoformAnswersSearchData, CoformAnswersByIdData, AddVoteData, AddReportAbuseData, UpdatePathValueData, DeleteDocumentByContextData } from "./EndpointApi.types.js";
 /**
  * Classe EndpointApi générée automatiquement depuis endpoints-copie.json
  */
@@ -1039,5 +1039,15 @@ export declare class EndpointApi {
      * @throws {Error} - En cas d'erreur inattendue.
      */
     updatePathValue(data: UpdatePathValueData): Promise<any>;
+    /**
+     * Supprimer une image/document par contexte d’entité : Supprimer des documents associés à une entité dans un contexte spécifique
+     * Constant : DELETE_DOCUMENT_BY_CONTEXT
+     * @param data - Données envoyées à l'API
+     * @returns Les données de réponse.
+     * @throws {ApiResponseError} - En cas d'erreur détectée dans la réponse.
+     * @throws {ApiAuthenticationError} - En cas d'erreur d'authentification.
+     * @throws {Error} - En cas d'erreur inattendue.
+     */
+    deleteDocumentByContext(data: DeleteDocumentByContextData): Promise<any>;
 }
 export default EndpointApi;

package/types/api/EndpointApi.types.d.ts

@@ -4480,3 +4480,30 @@ export interface UpdatePathValueData {
     };
     [k: string]: unknown;
 }
+export interface DeleteDocumentByContextData {
+    /**
+     * ID de l’utilisateur
+     */
+    parentId?: string;
+    /**
+     * Type de contexte de l’entité
+     */
+    parentType?: "citoyens" | "organizations" | "projects" | "events" | "poi";
+    path: "communecter";
+    /**
+     * ID image/document à supprimer
+     */
+    ids?: string;
+    pathParams?: {
+        /**
+         * ID du contexte de l’entité
+         */
+        contextId: string;
+        /**
+         * Type de contexte de l’entité
+         */
+        contextType: "citoyens" | "organizations" | "projects" | "events" | "poi";
+        [k: string]: unknown;
+    };
+    [k: string]: unknown;
+}

package/types/api/User.d.ts

@@ -341,5 +341,142 @@ export declare class User extends BaseEntity<UserItemNormalized> {
      * @returns L'entité correspondante au slug.
      */
     entityBySlug(slug: string): Promise<EntityTypes>;
+    /**
+     * Valide les préconditions communes pour les méthodes de vérification de rôle.
+     * @private
+     * @param methodName - Nom de la méthode appelante (pour les messages d'erreur).
+     * @param expectedTypes - Types d'entité parent autorisés.
+     * @throws {ApiError} 401 - Si l'utilisateur n'est pas connecté.
+     * @throws {ApiError} 401 - Si l'utilisateur connecté n'est pas administrateur de l'entité parente.
+     * @throws {ApiError} 404 - Si l'utilisateur n'est pas enregistré.
+     * @throws {ApiError} 404 - Si l'entité parente n'est pas enregistrée.
+     * @throws {ApiError} 400 - Si le type d'entité parent n'est pas valide.
+     */
+    private _validateRoleCheckPreconditions;
+    /**
+     * Récupère le lien utilisateur pour l'entité parente.
+     * @private
+     * @returns Le lien utilisateur ou null.
+     */
+    private _getUserLinkForParent;
+    /**
+     * Vérifie si l'utilisateur est administrateur de l'entité parente.
+     *
+     * Cette méthode permet de vérifier si un utilisateur possède les droits d'administration
+     * sur l'organisation ou le projet parent. Elle est particulièrement utile après avoir
+     * récupéré des membres via `getMembers()` pour déterminer leur niveau de permissions.
+     *
+     * @returns `true` si l'utilisateur est administrateur de l'entité parente, `false` sinon.
+     *
+     * @throws {ApiError} 401 - Si l'utilisateur n'est pas connecté.
+     * @throws {ApiError} 401 - Si l'utilisateur connecté n'est pas administrateur de l'entité parente.
+     * @throws {ApiError} 404 - Si l'utilisateur n'est pas enregistré (pas d'ID).
+     * @throws {ApiError} 404 - Si l'entité parente n'est pas enregistrée (pas d'ID).
+     * @throws {ApiError} 400 - Si l'entité parente n'est pas de type "organizations" ou "projects".
+     *
+     * @example
+     * // Vérifier les admins d'une organisation
+     * const org = await me.organization({ slug: "openAtlas" });
+     * const members = await org.getMembers();
+     *
+     * for (const member of members.results) {
+     *   if (member.getEntityType() === "citoyens") {
+     *     if (member.isAdmin()) {
+     *       console.log(`${member.data.name} est administrateur`);
+     *     }
+     *   }
+     * }
+     *
+     * @example
+     * // Récupérer uniquement les membres admins
+     * const org = await me.organization({ slug: "myOrg" });
+     * const adminMembers = await org.getMembers({}, { isAdmin: true });
+     *
+     * // Vérifier chaque admin
+     * for (const admin of adminMembers.results) {
+     *   if (admin.getEntityType() === "citoyens" && admin.isAdmin()) {
+     *     console.log(`${admin.data.name} a les droits admin`);
+     *   }
+     * }
+     */
+    isAdmin(): boolean;
+    /**
+     * Vérifie si l'utilisateur est membre de l'organisation parente.
+     *
+     * Cette méthode permet de vérifier si un utilisateur est membre actif d'une organisation.
+     * Elle est utile pour déterminer si un utilisateur a accès aux ressources de l'organisation.
+     *
+     * @returns `true` si l'utilisateur est membre validé de l'organisation parente, `false` sinon.
+     *
+     * @throws {ApiError} 401 - Si l'utilisateur n'est pas connecté.
+     * @throws {ApiError} 401 - Si l'utilisateur connecté n'est pas administrateur de l'entité parente.
+     * @throws {ApiError} 404 - Si l'utilisateur n'est pas enregistré (pas d'ID).
+     * @throws {ApiError} 404 - Si l'entité parente n'est pas enregistrée (pas d'ID).
+     * @throws {ApiError} 400 - Si l'entité parente n'est pas de type "organizations".
+     *
+     * @example
+     * // Vérifier les membres d'une organisation
+     * const org = await me.organization({ slug: "myOrg" });
+     * const members = await org.getMembers();
+     *
+     * for (const member of members.results) {
+     *   if (member.getEntityType() === "citoyens" && member.isMember()) {
+     *     console.log(`${member.data.name} est membre de l'organisation`);
+     *   }
+     * }
+     */
+    isMember(): boolean;
+    /**
+     * Vérifie si l'utilisateur est contributeur du projet parent.
+     *
+     * Cette méthode permet de vérifier si un utilisateur est contributeur actif d'un projet.
+     * Elle est utile pour déterminer si un utilisateur peut participer aux activités du projet.
+     *
+     * @returns `true` si l'utilisateur est contributeur validé du projet parent, `false` sinon.
+     *
+     * @throws {ApiError} 401 - Si l'utilisateur n'est pas connecté.
+     * @throws {ApiError} 401 - Si l'utilisateur connecté n'est pas administrateur de l'entité parente.
+     * @throws {ApiError} 404 - Si l'utilisateur n'est pas enregistré (pas d'ID).
+     * @throws {ApiError} 404 - Si l'entité parente n'est pas enregistrée (pas d'ID).
+     * @throws {ApiError} 400 - Si l'entité parente n'est pas de type "projects".
+     *
+     * @example
+     * // Vérifier les contributeurs d'un projet
+     * const project = await me.project({ slug: "myProject" });
+     * const contributors = await project.getContributors();
+     *
+     * for (const contributor of contributors.results) {
+     *   if (contributor.getEntityType() === "citoyens" && contributor.isContributor()) {
+     *     console.log(`${contributor.data.name} est contributeur du projet`);
+     *   }
+     * }
+     */
+    isContributor(): boolean;
+    /**
+     * Vérifie si l'utilisateur est participant de l'événement parent.
+     *
+     * Cette méthode permet de vérifier si un utilisateur est inscrit comme participant à un événement.
+     * Elle est utile pour déterminer si un utilisateur a confirmé sa participation à l'événement.
+     *
+     * @returns `true` si l'utilisateur est participant validé de l'événement parent, `false` sinon.
+     *
+     * @throws {ApiError} 401 - Si l'utilisateur n'est pas connecté.
+     * @throws {ApiError} 401 - Si l'utilisateur connecté n'est pas administrateur de l'entité parente.
+     * @throws {ApiError} 404 - Si l'utilisateur n'est pas enregistré (pas d'ID).
+     * @throws {ApiError} 404 - Si l'entité parente n'est pas enregistrée (pas d'ID).
+     * @throws {ApiError} 400 - Si l'entité parente n'est pas de type "events".
+     *
+     * @example
+     * // Vérifier les participants d'un événement
+     * const event = await me.event({ slug: "myEvent" });
+     * const attendees = await event.getAttendees();
+     *
+     * for (const attendee of attendees.results) {
+     *   if (attendee.getEntityType() === "citoyens" && attendee.isAttendee()) {
+     *     console.log(`${attendee.data.name} participe à l'événement`);
+     *   }
+     * }
+     */
+    isAttendee(): boolean;
 }
 export {};

package/types/endpoints.module.d.ts

@@ -4086,6 +4086,8 @@ declare const endpoints: {
                 address?: undefined;
                 userId?: undefined;
                 docType?: undefined;
+                contextId?: undefined;
+                contextType?: undefined;
             };
             required: string[];
             then: {
@@ -4534,6 +4536,8 @@ declare const endpoints: {
                 address?: undefined;
                 userId?: undefined;
                 docType?: undefined;
+                contextId?: undefined;
+                contextType?: undefined;
             };
             required: string[];
             then: {
@@ -6776,6 +6780,8 @@ declare const endpoints: {
                 address?: undefined;
                 userId?: undefined;
                 docType?: undefined;
+                contextId?: undefined;
+                contextType?: undefined;
             };
             required: string[];
             type: string;
@@ -9596,6 +9602,8 @@ declare const endpoints: {
                 address?: undefined;
                 userId?: undefined;
                 docType?: undefined;
+                contextId?: undefined;
+                contextType?: undefined;
             };
             required: string[];
             then: {
@@ -12226,6 +12234,8 @@ declare const endpoints: {
                 address?: undefined;
                 userId?: undefined;
                 docType?: undefined;
+                contextId?: undefined;
+                contextType?: undefined;
             };
             required: string[];
             type: string;
@@ -14352,6 +14362,8 @@ declare const endpoints: {
                 address?: undefined;
                 userId?: undefined;
                 docType?: undefined;
+                contextId?: undefined;
+                contextType?: undefined;
             };
             required: string[];
             type: string;
@@ -14388,6 +14400,8 @@ declare const endpoints: {
                 address?: undefined;
                 userId?: undefined;
                 docType?: undefined;
+                contextId?: undefined;
+                contextType?: undefined;
             };
             type: string;
             additionalProperties?: undefined;
@@ -14875,7 +14889,6 @@ declare const endpoints: {
                     const: string;
                     default: string;
                     type: string;
-                    enum?: undefined;
                 };
                 email: {
                     format: string;
@@ -15199,7 +15212,6 @@ declare const endpoints: {
                     const: string;
                     default: string;
                     type: string;
-                    enum?: undefined;
                 };
                 geo: {
                     additionalProperties: boolean;
@@ -16283,6 +16295,8 @@ declare const endpoints: {
                 address?: undefined;
                 userId?: undefined;
                 docType?: undefined;
+                contextId?: undefined;
+                contextType?: undefined;
             };
             required: string[];
             type: string;
@@ -16334,6 +16348,8 @@ declare const endpoints: {
                 address?: undefined;
                 userId?: undefined;
                 docType?: undefined;
+                contextId?: undefined;
+                contextType?: undefined;
             };
             required: string[];
             type: string;
@@ -17496,6 +17512,8 @@ declare const endpoints: {
                 ownerId?: undefined;
                 userId?: undefined;
                 docType?: undefined;
+                contextId?: undefined;
+                contextType?: undefined;
             };
             required: string[];
             type: string;
@@ -17734,6 +17752,8 @@ declare const endpoints: {
                 ownerId?: undefined;
                 address?: undefined;
                 docType?: undefined;
+                contextId?: undefined;
+                contextType?: undefined;
             };
             required: string[];
             type: string;
@@ -20500,6 +20520,8 @@ declare const endpoints: {
                 ownerId?: undefined;
                 address?: undefined;
                 userId?: undefined;
+                contextId?: undefined;
+                contextType?: undefined;
             };
             required: string[];
             then: {
@@ -22063,7 +22085,6 @@ declare const endpoints: {
                     default: string;
                     enum: string[];
                     type: string;
-                    const?: undefined;
                 };
                 id: {
                     default: string;
@@ -22233,6 +22254,226 @@ declare const endpoints: {
         pathParams?: undefined;
         params?: undefined;
         functionCocostum?: undefined;
+    } | {
+        auth: string;
+        constant: string;
+        contentType: string;
+        method: string;
+        path: string;
+        pathParams: {
+            additionalProperties: boolean;
+            properties: {
+                contextId: {
+                    default: string;
+                    pattern: string;
+                    type: string;
+                };
+                contextType: {
+                    default: string;
+                    enum: string[];
+                    type: string;
+                };
+                id?: undefined;
+                type?: undefined;
+                isLive?: undefined;
+                q?: undefined;
+                slug?: undefined;
+                index?: undefined;
+                folder?: undefined;
+                ownerId?: undefined;
+                address?: undefined;
+                userId?: undefined;
+                docType?: undefined;
+            };
+            required: string[];
+            type: string;
+            else?: undefined;
+            if?: undefined;
+            then?: undefined;
+            allOf?: undefined;
+            slug?: undefined;
+        };
+        request: {
+            additionalProperties: boolean;
+            properties: {
+                ids: {
+                    pattern: string;
+                    type: string;
+                };
+                parentId: {
+                    default: string;
+                    pattern: string;
+                    type: string;
+                };
+                parentType: {
+                    default: string;
+                    enum: string[];
+                    type: string;
+                };
+                path: {
+                    const: string;
+                    default: string;
+                    type: string;
+                };
+                app?: undefined;
+                email?: undefined;
+                isInvitation?: undefined;
+                mode?: undefined;
+                name?: undefined;
+                pendingUserId?: undefined;
+                pwd?: undefined;
+                username?: undefined;
+                password?: undefined;
+                refreshToken?: undefined;
+                type?: undefined;
+                serverUrl?: undefined;
+                newPassword?: undefined;
+                newPassword2?: undefined;
+                oldPassword?: undefined;
+                scope?: undefined;
+                userId?: undefined;
+                idEntity?: undefined;
+                typeEntity?: undefined;
+                value?: undefined;
+                block?: undefined;
+                descMentions?: undefined;
+                description?: undefined;
+                id?: undefined;
+                shortDescription?: undefined;
+                typeElement?: undefined;
+                diaspora?: undefined;
+                facebook?: undefined;
+                github?: undefined;
+                gitlab?: undefined;
+                instagram?: undefined;
+                mastodon?: undefined;
+                signal?: undefined;
+                telegram?: undefined;
+                twitter?: undefined;
+                address?: undefined;
+                geo?: undefined;
+                geoPosition?: undefined;
+                slug?: undefined;
+                profil_avatar?: undefined;
+                banner?: undefined;
+                cropH?: undefined;
+                cropW?: undefined;
+                cropX?: undefined;
+                cropY?: undefined;
+                formOrigin?: undefined;
+                tpl?: undefined;
+                listInvite?: undefined;
+                dateLimit?: undefined;
+                indexStep?: undefined;
+                search?: undefined;
+                json?: undefined;
+                markdownActive?: undefined;
+                mediaFile?: undefined;
+                mediaImg?: undefined;
+                mentions?: undefined;
+                tags?: undefined;
+                text?: undefined;
+                newsImage?: undefined;
+                newsFile?: undefined;
+                isLive?: undefined;
+                idNews?: undefined;
+                childId?: undefined;
+                childType?: undefined;
+                comment?: undefined;
+                connectType?: undefined;
+                argval?: undefined;
+                contextId?: undefined;
+                contextType?: undefined;
+                parentCommentId?: undefined;
+                params?: undefined;
+                count?: undefined;
+                countType?: undefined;
+                fediverse?: undefined;
+                filters?: undefined;
+                indexMax?: undefined;
+                indexMin?: undefined;
+                initType?: undefined;
+                locality?: undefined;
+                notSourceKey?: undefined;
+                ranges?: undefined;
+                searchBy?: undefined;
+                searchTags?: undefined;
+                searchType?: undefined;
+                countryCode?: undefined;
+                formInMap?: undefined;
+                scopeValue?: undefined;
+                fields?: undefined;
+                collection?: undefined;
+                pull?: undefined;
+                arrayForm?: undefined;
+                key?: undefined;
+                preferences?: undefined;
+                role?: undefined;
+                url?: undefined;
+                parent?: undefined;
+                public?: undefined;
+                urls?: undefined;
+                endDate?: undefined;
+                openingHours?: undefined;
+                organizer?: undefined;
+                recurrency?: undefined;
+                startDate?: undefined;
+                timeZone?: undefined;
+                qqfile?: undefined;
+                qqfilename?: undefined;
+                qqtotalfilesize?: undefined;
+                qquuid?: undefined;
+                linkOption?: undefined;
+                searchMode?: undefined;
+                refreshTimestamp?: undefined;
+                action?: undefined;
+                all?: undefined;
+                actor?: undefined;
+                payload?: undefined;
+                criteria?: undefined;
+                isParcours?: undefined;
+                issuer?: undefined;
+                award?: undefined;
+                badgeId?: undefined;
+                evidences?: undefined;
+                narative?: undefined;
+                endDateUTC?: undefined;
+                startDateUTC?: undefined;
+                costumEditMode?: undefined;
+                costumSlug?: undefined;
+                mapUsed?: undefined;
+                options?: undefined;
+                sortBy?: undefined;
+                sourceKey?: undefined;
+                parent_only?: undefined;
+                types?: undefined;
+                date?: undefined;
+                fromToday?: undefined;
+                regions?: undefined;
+                timezone?: undefined;
+                event?: undefined;
+                tl?: undefined;
+                contentKey?: undefined;
+                folderId?: undefined;
+                answerId?: undefined;
+                finderPath?: undefined;
+                details?: undefined;
+            };
+            required: string[];
+            type: string;
+            allOf?: undefined;
+            $defs?: undefined;
+            else?: undefined;
+            if?: undefined;
+            then?: undefined;
+            anyOf?: undefined;
+            startBeforeEnd?: undefined;
+        };
+        generateModule?: undefined;
+        onlyAuthNone?: undefined;
+        postActions?: undefined;
+        params?: undefined;
+        functionCocostum?: undefined;
     })[];
 };
 export default endpoints;