@communecter/cocolight-api-client 1.0.71 → 1.0.73

package/types/api/BaseEntity.d.ts

@@ -916,6 +916,24 @@ export declare class BaseEntity<TServerData = any> {
     updateImageProfil({ profil_avatar: image }: {
         profil_avatar: UploadInput;
     }): Promise<unknown>;
+    /**
+     * Mettre à jour l'image de bannière : Permet de mettre à jour l'image de bannière d'un utilisateur ou d'une entité.
+     * Constant : PROFIL_BANNER
+     * @param data - Les données à envoyer.
+     * @param data.banner - L'image de bannière à mettre à jour.
+     * @param data.cropW - Largeur du recadrage.
+     * @param data.cropH - Hauteur du recadrage.
+     * @param data.cropX - Position X du recadrage.
+     * @param data.cropY - Position Y du recadrage.
+     * @returns - Les données de réponse.
+     */
+    updateImageBanner({ banner: image, cropW, cropH, cropX, cropY }: {
+        banner: UploadInput;
+        cropW: number;
+        cropH: number;
+        cropX: number;
+        cropY: number;
+    }): Promise<unknown>;
     /**
      * Crée une instance d'organisation et récupère son profil si nécessaire.
      *

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, 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 } 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 } from "./EndpointApi.types.js";
 /**
  * Classe EndpointApi générée automatiquement depuis endpoints-copie.json
  */
@@ -201,6 +201,16 @@ export declare class EndpointApi {
      * @throws {Error} - En cas d'erreur inattendue.
      */
     profilImage(data: ProfilImageData): Promise<any>;
+    /**
+     * Mettre à jour l'image de bannière : Permet de mettre à jour l'image de la bannière d'un utilisateur ou d'une entité.
+     * Constant : PROFIL_BANNER
+     * @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.
+     */
+    profilBanner(data: ProfilBannerData): Promise<any>;
     /**
      * 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.
      * Constant : GET_ELEMENTS_ABOUT

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

@@ -363,6 +363,33 @@ export interface ProfilImageData {
     };
     [k: string]: unknown;
 }
+export interface ProfilBannerData {
+    /**
+     * Fichier image de profil au format binaire
+     */
+    banner: {
+        [k: string]: unknown;
+    };
+    parentId: string;
+    parentType: "citoyens" | "projects" | "organizations" | "events" | "poi";
+    formOrigin: "banner";
+    cropW: number;
+    cropH: number;
+    cropX: number;
+    cropY: number;
+    pathParams?: {
+        /**
+         * Type d'entité
+         */
+        folder: "citoyens" | "projects" | "organizations" | "events" | "poi";
+        /**
+         * ID de l'utilisateur ou de l'entité
+         */
+        ownerId: string;
+        [k: string]: unknown;
+    };
+    [k: string]: unknown;
+}
 export interface GetElementsAboutData {
     /**
      * Template utilisé (ex: ficheInfoElement)

package/types/api/Event.d.ts

@@ -7,8 +7,8 @@ export declare class Event extends BaseEntity<EventItemNormalized> {
     static entityType: string;
     static entityTag: string;
     static SCHEMA_CONSTANTS: string[];
-    static ADD_BLOCKS: Map<"PROFIL_IMAGE" | "ADD_EVENT", "updateImageProfil" | "addEvent">;
-    static UPDATE_BLOCKS: Map<"UPDATE_BLOCK_SLUG" | "PROFIL_IMAGE", "updateImageProfil" | "updateSlug">;
+    static ADD_BLOCKS: Map<"PROFIL_IMAGE" | "PROFIL_BANNER" | "ADD_EVENT", "updateImageProfil" | "updateImageBanner" | "addEvent">;
+    static UPDATE_BLOCKS: Map<"UPDATE_BLOCK_SLUG" | "PROFIL_IMAGE" | "PROFIL_BANNER", "updateImageProfil" | "updateImageBanner" | "updateSlug">;
     defaultFields: Record<string, any>;
     removeFields: string[];
     transforms: EventTransforms;

package/types/api/Organization.d.ts

@@ -7,8 +7,8 @@ export declare class Organization extends BaseEntity<OrganizationItemNormalized>
     static entityType: string;
     static entityTag: string;
     static SCHEMA_CONSTANTS: string[];
-    static ADD_BLOCKS: Map<"PROFIL_IMAGE" | "ADD_ORGANIZATION", "updateImageProfil" | "addOrganization">;
-    static UPDATE_BLOCKS: Map<"UPDATE_BLOCK_DESCRIPTION" | "UPDATE_BLOCK_INFO" | "UPDATE_BLOCK_SOCIAL" | "UPDATE_BLOCK_LOCALITY" | "UPDATE_BLOCK_SLUG" | "PROFIL_IMAGE", "updateImageProfil" | "updateDescription" | "updateSocial" | "updateLocality" | "updateInfo" | "updateSlug">;
+    static ADD_BLOCKS: Map<"PROFIL_IMAGE" | "PROFIL_BANNER" | "ADD_ORGANIZATION", "updateImageProfil" | "updateImageBanner" | "addOrganization">;
+    static UPDATE_BLOCKS: Map<"UPDATE_BLOCK_DESCRIPTION" | "UPDATE_BLOCK_INFO" | "UPDATE_BLOCK_SOCIAL" | "UPDATE_BLOCK_LOCALITY" | "UPDATE_BLOCK_SLUG" | "PROFIL_IMAGE" | "PROFIL_BANNER", "updateImageProfil" | "updateImageBanner" | "updateDescription" | "updateSocial" | "updateLocality" | "updateInfo" | "updateSlug">;
     defaultFields: Record<string, any>;
     removeFields: string[];
     transforms: Record<string, (val: any, full: any) => any>;

package/types/api/Poi.d.ts

@@ -4,8 +4,8 @@ export declare class Poi extends BaseEntity<any> {
     static entityType: string;
     static entityTag: string;
     static SCHEMA_CONSTANTS: string[];
-    static ADD_BLOCKS: Map<"PROFIL_IMAGE" | "ADD_POI", "updateImageProfil" | "addPoi">;
-    static UPDATE_BLOCKS: Map<"UPDATE_BLOCK_DESCRIPTION" | "UPDATE_BLOCK_INFO" | "UPDATE_BLOCK_LOCALITY" | "UPDATE_BLOCK_SLUG" | "PROFIL_IMAGE", "updateImageProfil" | "updateDescription" | "updateLocality" | "updateInfo" | "updateSlug">;
+    static ADD_BLOCKS: Map<"PROFIL_IMAGE" | "PROFIL_BANNER" | "ADD_POI", "updateImageProfil" | "updateImageBanner" | "addPoi">;
+    static UPDATE_BLOCKS: Map<"UPDATE_BLOCK_DESCRIPTION" | "UPDATE_BLOCK_INFO" | "UPDATE_BLOCK_LOCALITY" | "UPDATE_BLOCK_SLUG" | "PROFIL_IMAGE" | "PROFIL_BANNER", "updateImageProfil" | "updateImageBanner" | "updateDescription" | "updateLocality" | "updateInfo" | "updateSlug">;
     defaultFields: Record<string, any>;
     removeFields: string[];
     _add: (payload: Record<string, any>) => Promise<void>;

package/types/api/Project.d.ts

@@ -9,8 +9,8 @@ export declare class Project extends BaseEntity<ProjectItemNormalized> {
     static entityType: string;
     static entityTag: string;
     static SCHEMA_CONSTANTS: string[];
-    static ADD_BLOCKS: Map<"PROFIL_IMAGE" | "ADD_PROJECT", "addProject" | "updateImageProfil">;
-    static UPDATE_BLOCKS: Map<"UPDATE_BLOCK_DESCRIPTION" | "UPDATE_BLOCK_INFO" | "UPDATE_BLOCK_SOCIAL" | "UPDATE_BLOCK_LOCALITY" | "UPDATE_BLOCK_SLUG" | "PROFIL_IMAGE", "updateImageProfil" | "updateDescription" | "updateSocial" | "updateLocality" | "updateInfo" | "updateSlug">;
+    static ADD_BLOCKS: Map<"PROFIL_IMAGE" | "PROFIL_BANNER" | "ADD_PROJECT", "addProject" | "updateImageProfil" | "updateImageBanner">;
+    static UPDATE_BLOCKS: Map<"UPDATE_BLOCK_DESCRIPTION" | "UPDATE_BLOCK_INFO" | "UPDATE_BLOCK_SOCIAL" | "UPDATE_BLOCK_LOCALITY" | "UPDATE_BLOCK_SLUG" | "PROFIL_IMAGE" | "PROFIL_BANNER", "updateImageProfil" | "updateImageBanner" | "updateDescription" | "updateSocial" | "updateLocality" | "updateInfo" | "updateSlug">;
     defaultFields: Record<string, any>;
     removeFields: string[];
     transforms: ProjectTransforms;

package/types/api/User.d.ts

@@ -10,7 +10,7 @@ export declare class User extends BaseEntity<UserItemNormalized> {
     static entityType: "citoyens";
     static entityTag: string;
     static SCHEMA_CONSTANTS: string[];
-    static UPDATE_BLOCKS: Map<"UPDATE_BLOCK_DESCRIPTION" | "UPDATE_BLOCK_INFO" | "UPDATE_BLOCK_SOCIAL" | "UPDATE_BLOCK_LOCALITY" | "UPDATE_BLOCK_SLUG" | "PROFIL_IMAGE", "updateImageProfil" | "updateDescription" | "updateSocial" | "updateLocality" | "updateInfo" | "updateSlug">;
+    static UPDATE_BLOCKS: Map<"UPDATE_BLOCK_DESCRIPTION" | "UPDATE_BLOCK_INFO" | "UPDATE_BLOCK_SOCIAL" | "UPDATE_BLOCK_LOCALITY" | "UPDATE_BLOCK_SLUG" | "PROFIL_IMAGE" | "PROFIL_BANNER", "updateImageProfil" | "updateImageBanner" | "updateDescription" | "updateSocial" | "updateLocality" | "updateInfo" | "updateSlug">;
     defaultFields: Record<string, any>;
     removeFields: string[];
     transforms: {
@@ -149,6 +149,12 @@ export declare class User extends BaseEntity<UserItemNormalized> {
      * Mettre à jour l'image de profil : Permet de mettre à jour l'image de profil d'un utilisateur ou d'une entité.
      */
     updateImageProfil(data: Parameters<BaseEntity<UserItemNormalized>["updateImageProfil"]>[0]): Promise<unknown>;
+    /**
+     * {@inheritDoc BaseEntity#updateImageBanner}
+     *
+     * Mettre à jour l'image de bannière : Permet de mettre à jour l'image de bannière d'un utilisateur ou d'une entité.
+     */
+    updateImageBanner(data: Parameters<BaseEntity<UserItemNormalized>["updateImageBanner"]>[0]): Promise<unknown>;
     /**
      * {@inheritDoc BaseEntity#getOrganizations}
      * @param [data]