@communecter/cocolight-api-client 1.0.193 → 1.0.194

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/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@communecter/cocolight-api-client",
3
- "version": "1.0.193",
3
+ "version": "1.0.194",
4
4
  "description": "Client Axios simplifié pour l'API cocolight",
5
5
  "repository": {
6
6
  "type": "git",
@@ -2102,6 +2102,10 @@ export interface GetMembersNoAdminData {
2102
2102
  * Flag pour ne pas filtrer sur une clé de source spécifique
2103
2103
  */
2104
2104
  notSourceKey: true;
2105
+ /**
2106
+ * Liste des champs à retourner
2107
+ */
2108
+ fields?: string[];
2105
2109
  filters: {
2106
2110
  [k: string]: unknown;
2107
2111
  };
@@ -2180,6 +2184,10 @@ export interface GetMembersAdminData {
2180
2184
  * Flag pour ne pas filtrer sur une clé de source spécifique
2181
2185
  */
2182
2186
  notSourceKey: true;
2187
+ /**
2188
+ * Liste des champs à retourner
2189
+ */
2190
+ fields?: string[];
2183
2191
  filters: {
2184
2192
  [k: string]: unknown;
2185
2193
  };
@@ -2624,6 +2632,10 @@ export interface GetContributorsNoAdminData {
2624
2632
  * Flag pour ne pas filtrer sur une clé de source spécifique
2625
2633
  */
2626
2634
  notSourceKey: true;
2635
+ /**
2636
+ * Liste des champs à retourner
2637
+ */
2638
+ fields?: string[];
2627
2639
  filters: {
2628
2640
  [k: string]: unknown;
2629
2641
  };
@@ -2702,6 +2714,10 @@ export interface GetContributorsAdminData {
2702
2714
  * Flag pour ne pas filtrer sur une clé de source spécifique
2703
2715
  */
2704
2716
  notSourceKey: true;
2717
+ /**
2718
+ * Liste des champs à retourner
2719
+ */
2720
+ fields?: string[];
2705
2721
  filters: {
2706
2722
  [k: string]: unknown;
2707
2723
  };
@@ -5691,6 +5707,10 @@ export interface GetAttendeesNoAdminData {
5691
5707
  * Flag pour ne pas filtrer sur une clé de source spécifique
5692
5708
  */
5693
5709
  notSourceKey: true;
5710
+ /**
5711
+ * Liste des champs à retourner
5712
+ */
5713
+ fields?: string[];
5694
5714
  filters: {
5695
5715
  [k: string]: unknown;
5696
5716
  };
@@ -5764,6 +5784,10 @@ export interface GetAttendeesAdminData {
5764
5784
  * Flag pour ne pas filtrer sur une clé de source spécifique
5765
5785
  */
5766
5786
  notSourceKey: true;
5787
+ /**
5788
+ * Liste des champs à retourner
5789
+ */
5790
+ fields?: string[];
5767
5791
  filters: {
5768
5792
  [k: string]: unknown;
5769
5793
  };
@@ -51,7 +51,12 @@ export declare class Event extends BaseEntity<EventItemNormalized> {
51
51
  /**
52
52
  * Récupérer les participants d'un événement.
53
53
  * Constant : GET_ATTENDEES_NO_ADMIN
54
- * @param data - Paramètres (partiels) de recherche/pagination.
54
+ * @param data - Paramètres (partiels) de recherche/pagination (`name`, `indexStep`,
55
+ * `filters` complémentaires, `fields`…). Les `filters` fournis sont fusionnés avec le filtre
56
+ * de lien construit par le SDK, ce dernier restant prioritaire : l'appelant peut restreindre
57
+ * la liste (un champ de profil, par exemple) mais pas en changer la sémantique « participants ».
58
+ * `fields` AJOUTE des champs à la projection par défaut de la recherche (elle n'est pas remplacée) ;
59
+ * sans objet sur le chemin admin, où les documents reviennent complets (il y est retiré).
55
60
  * @param options - Options supplémentaires.
56
61
  * @param options.toBeValidated - Indique si les participants doivent être validés.
57
62
  * @param options.isAdmin - Indique si l'utilisateur est admin.
@@ -177,7 +177,13 @@ export declare class Organization extends BaseEntity<OrganizationItemNormalized>
177
177
  /**
178
178
  * Récupérer les membres de l'organisation.
179
179
  * Constant : GET_MEMBERS_ADMIN / GET_MEMBERS_NO_ADMIN
180
- * @param data - Paramètres (partiels) de recherche/pagination.
180
+ * @param data - Paramètres (partiels) de recherche/pagination (`name`, `indexStep`,
181
+ * `filters` complémentaires, `fields`…). Les `filters` fournis sont fusionnés avec le filtre
182
+ * membership construit par le SDK, ce dernier restant prioritaire : l'appelant peut
183
+ * restreindre la liste (un champ de profil, par exemple) mais pas en changer la sémantique.
184
+ * `fields` AJOUTE des champs à la projection par défaut de la recherche (elle n'est pas
185
+ * remplacée) : utile pour lire sur la liste un champ de profil qu'elle ne ramène pas. Sans objet
186
+ * sur le chemin admin, où les documents reviennent complets (il y est retiré).
181
187
  * @param options - Options supplémentaires.
182
188
  * @param options.toBeValidated - Indique si les membres doivent être validés.
183
189
  * @param options.isAdmin - Indique si l'utilisateur est admin.
@@ -217,6 +223,13 @@ export declare class Organization extends BaseEntity<OrganizationItemNormalized>
217
223
  *
218
224
  * // Restreindre la recherche : uniquement les organisations
219
225
  * const onlyOrgas = await organization.getMembers({}, { searchType: "organizations" });
226
+ *
227
+ * // Restreindre par un champ du profil des membres (filtre serveur, fusionné au membership)
228
+ * // et ramener ce champ + les contacts sur la liste (projection additive)
229
+ * const coordinateurs = await organization.getMembers(
230
+ * { filters: { territoires: "Arrageois" }, fields: ["territoires", "telephone"] },
231
+ * { roles: ["Coordonnateur(trice)"] }
232
+ * );
220
233
  */
221
234
  getMembers(data?: Partial<GetMembersAdminData | GetMembersNoAdminData>, options?: {
222
235
  toBeValidated?: boolean;
@@ -91,7 +91,12 @@ export declare class Project extends BaseEntity<ProjectItemNormalized> {
91
91
  /**
92
92
  * Récupérer les contributeurs d'un projet.
93
93
  * Constant : GET_CONTRIBUTORS_ADMIN / GET_CONTRIBUTORS_NO_ADMIN
94
- * @param data - Paramètres (partiels) de recherche/pagination.
94
+ * @param data - Paramètres (partiels) de recherche/pagination (`name`, `indexStep`,
95
+ * `filters` complémentaires, `fields`…). Les `filters` fournis sont fusionnés avec le filtre
96
+ * de lien construit par le SDK, ce dernier restant prioritaire : l'appelant peut restreindre
97
+ * la liste (un champ de profil, par exemple) mais pas en changer la sémantique « contributeurs ».
98
+ * `fields` AJOUTE des champs à la projection par défaut de la recherche (elle n'est pas remplacée) ;
99
+ * sans objet sur le chemin admin, où les documents reviennent complets (il y est retiré).
95
100
  * @param options - Options supplémentaires.
96
101
  * @param options.toBeValidated - Indique si les contributeurs doivent être validés.
97
102
  * @param options.isAdmin - Indique si l'utilisateur est admin.
@@ -15793,6 +15793,12 @@ declare const endpoints: {
15793
15793
  default: boolean;
15794
15794
  type: string;
15795
15795
  };
15796
+ fields: {
15797
+ items: {
15798
+ type: string;
15799
+ };
15800
+ type: string;
15801
+ };
15796
15802
  filters: {
15797
15803
  additionalProperties: boolean;
15798
15804
  allOf: {
@@ -16086,7 +16092,6 @@ declare const endpoints: {
16086
16092
  scopeValue?: undefined;
16087
16093
  sourceKey?: undefined;
16088
16094
  costumEditMode?: undefined;
16089
- fields?: undefined;
16090
16095
  mapUsed?: undefined;
16091
16096
  options?: undefined;
16092
16097
  sort?: undefined;
@@ -16283,6 +16288,12 @@ declare const endpoints: {
16283
16288
  default: boolean;
16284
16289
  type: string;
16285
16290
  };
16291
+ fields: {
16292
+ items: {
16293
+ type: string;
16294
+ };
16295
+ type: string;
16296
+ };
16286
16297
  filters: {
16287
16298
  additionalProperties: boolean;
16288
16299
  allOf: {
@@ -16615,7 +16626,6 @@ declare const endpoints: {
16615
16626
  scopeValue?: undefined;
16616
16627
  sourceKey?: undefined;
16617
16628
  costumEditMode?: undefined;
16618
- fields?: undefined;
16619
16629
  mapUsed?: undefined;
16620
16630
  options?: undefined;
16621
16631
  sort?: undefined;
@@ -19151,6 +19161,12 @@ declare const endpoints: {
19151
19161
  default: boolean;
19152
19162
  type: string;
19153
19163
  };
19164
+ fields: {
19165
+ items: {
19166
+ type: string;
19167
+ };
19168
+ type: string;
19169
+ };
19154
19170
  filters: {
19155
19171
  additionalProperties: boolean;
19156
19172
  allOf: {
@@ -19444,7 +19460,6 @@ declare const endpoints: {
19444
19460
  scopeValue?: undefined;
19445
19461
  sourceKey?: undefined;
19446
19462
  costumEditMode?: undefined;
19447
- fields?: undefined;
19448
19463
  mapUsed?: undefined;
19449
19464
  options?: undefined;
19450
19465
  sort?: undefined;
@@ -19641,6 +19656,12 @@ declare const endpoints: {
19641
19656
  default: boolean;
19642
19657
  type: string;
19643
19658
  };
19659
+ fields: {
19660
+ items: {
19661
+ type: string;
19662
+ };
19663
+ type: string;
19664
+ };
19644
19665
  filters: {
19645
19666
  additionalProperties: boolean;
19646
19667
  allOf: {
@@ -19973,7 +19994,6 @@ declare const endpoints: {
19973
19994
  scopeValue?: undefined;
19974
19995
  sourceKey?: undefined;
19975
19996
  costumEditMode?: undefined;
19976
- fields?: undefined;
19977
19997
  mapUsed?: undefined;
19978
19998
  options?: undefined;
19979
19999
  sort?: undefined;
@@ -31612,6 +31632,12 @@ declare const endpoints: {
31612
31632
  default: boolean;
31613
31633
  type: string;
31614
31634
  };
31635
+ fields: {
31636
+ items: {
31637
+ type: string;
31638
+ };
31639
+ type: string;
31640
+ };
31615
31641
  filters: {
31616
31642
  additionalProperties: boolean;
31617
31643
  allOf: {
@@ -31905,7 +31931,6 @@ declare const endpoints: {
31905
31931
  scopeValue?: undefined;
31906
31932
  sourceKey?: undefined;
31907
31933
  costumEditMode?: undefined;
31908
- fields?: undefined;
31909
31934
  mapUsed?: undefined;
31910
31935
  options?: undefined;
31911
31936
  sort?: undefined;
@@ -32103,6 +32128,12 @@ declare const endpoints: {
32103
32128
  default: boolean;
32104
32129
  type: string;
32105
32130
  };
32131
+ fields: {
32132
+ items: {
32133
+ type: string;
32134
+ };
32135
+ type: string;
32136
+ };
32106
32137
  filters: {
32107
32138
  additionalProperties: boolean;
32108
32139
  allOf: {
@@ -32435,7 +32466,6 @@ declare const endpoints: {
32435
32466
  scopeValue?: undefined;
32436
32467
  sourceKey?: undefined;
32437
32468
  costumEditMode?: undefined;
32438
- fields?: undefined;
32439
32469
  mapUsed?: undefined;
32440
32470
  options?: undefined;
32441
32471
  sort?: undefined;