@proxima-nexus/sdk-typescript 1.0.0 → 2.0.1

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.
Files changed (37) hide show
  1. package/CHANGELOG.md +96 -0
  2. package/README.md +173 -159
  3. package/dist/api/event-api.d.ts +171 -65
  4. package/dist/api/event-api.js +273 -93
  5. package/dist/api/group-api.d.ts +147 -70
  6. package/dist/api/group-api.js +234 -101
  7. package/dist/api/user-api.d.ts +210 -125
  8. package/dist/api/user-api.js +297 -171
  9. package/dist/models/create-event-dto.d.ts +4 -4
  10. package/dist/models/create-group-dto.d.ts +6 -5
  11. package/dist/models/create-group-dto.js +7 -1
  12. package/dist/models/create-user-dto.d.ts +0 -4
  13. package/dist/models/entity-connection-dto.d.ts +17 -1
  14. package/dist/models/entity-connection-dto.js +14 -1
  15. package/dist/models/event-dto.d.ts +13 -4
  16. package/dist/models/event-entity-connection-dto.d.ts +17 -1
  17. package/dist/models/event-entity-connection-dto.js +14 -1
  18. package/dist/models/group-dto.d.ts +15 -5
  19. package/dist/models/group-dto.js +7 -1
  20. package/dist/models/group-entity-connection-dto.d.ts +17 -1
  21. package/dist/models/group-entity-connection-dto.js +14 -1
  22. package/dist/models/index.d.ts +3 -0
  23. package/dist/models/index.js +3 -0
  24. package/dist/models/mutate-event-entity-connection-dto.d.ts +22 -0
  25. package/dist/models/mutate-event-entity-connection-dto.js +22 -0
  26. package/dist/models/mutate-group-entity-connection-dto.d.ts +22 -0
  27. package/dist/models/mutate-group-entity-connection-dto.js +22 -0
  28. package/dist/models/mutate-user-connection-dto.d.ts +21 -0
  29. package/dist/models/mutate-user-connection-dto.js +21 -0
  30. package/dist/models/update-event-dto.d.ts +4 -4
  31. package/dist/models/update-group-dto.d.ts +6 -5
  32. package/dist/models/update-group-dto.js +7 -1
  33. package/dist/models/update-user-dto.d.ts +0 -4
  34. package/dist/models/user-dto.d.ts +5 -4
  35. package/dist/models/user-entity-connection-dto.d.ts +17 -1
  36. package/dist/models/user-entity-connection-dto.js +14 -1
  37. package/package.json +5 -4
@@ -17,6 +17,7 @@ import type { EntityConnectionDto } from '../models';
17
17
  import type { EventEntityConnectionDto } from '../models';
18
18
  import type { GetGroupsDto } from '../models';
19
19
  import type { GroupDto } from '../models';
20
+ import type { MutateGroupEntityConnectionDto } from '../models';
20
21
  import type { UpdateGroupDto } from '../models';
21
22
  import type { UserEntityConnectionDto } from '../models';
22
23
  /**
@@ -25,71 +26,82 @@ import type { UserEntityConnectionDto } from '../models';
25
26
  export declare const GroupApiAxiosParamCreator: (configuration?: Configuration) => {
26
27
  /**
27
28
  *
28
- * @summary Add a member to a group
29
+ * @summary Add or update a connection to a group (member, admin, or owner)
29
30
  * @param {string} groupId
30
31
  * @param {string} userId
32
+ * @param {string} xProximaNexusRequesterUserId ID of the user adding a connection to the group
33
+ * @param {MutateGroupEntityConnectionDto} mutateGroupEntityConnectionDto
31
34
  * @param {*} [options] Override http request option.
32
35
  * @throws {RequiredError}
33
36
  */
34
- addMember: (groupId: string, userId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
37
+ addConnection: (groupId: string, userId: string, xProximaNexusRequesterUserId: string, mutateGroupEntityConnectionDto: MutateGroupEntityConnectionDto, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
35
38
  /**
36
39
  *
37
40
  * @summary Create a group
41
+ * @param {string} xProximaNexusRequesterUserId ID of the user creating the group
38
42
  * @param {CreateGroupDto} createGroupDto
39
43
  * @param {*} [options] Override http request option.
40
44
  * @throws {RequiredError}
41
45
  */
42
- create: (createGroupDto: CreateGroupDto, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
46
+ create: (xProximaNexusRequesterUserId: string, createGroupDto: CreateGroupDto, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
43
47
  /**
44
48
  *
45
49
  * @summary Get a group by ID
46
50
  * @param {string} groupId
51
+ * @param {string} [xProximaNexusRequesterUserId] ID of the user getting a group by ID. If set, 401 may be returned if the user cannot view the group, otherwise requesterConnection will be set on the result.
47
52
  * @param {*} [options] Override http request option.
48
53
  * @throws {RequiredError}
49
54
  */
50
- findOne: (groupId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
55
+ get: (groupId: string, xProximaNexusRequesterUserId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
51
56
  /**
52
57
  *
53
58
  * @summary Get a batch of groups by IDs
54
59
  * @param {GetGroupsDto} getGroupsDto
60
+ * @param {string} [xProximaNexusRequesterUserId] ID of the user getting a batch of groups. If set, groups will be filtered to only include groups that the user can see, and requesterConnection will be set on the results.
55
61
  * @param {*} [options] Override http request option.
56
62
  * @throws {RequiredError}
57
63
  */
58
- getBatch: (getGroupsDto: GetGroupsDto, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
64
+ getBatch: (getGroupsDto: GetGroupsDto, xProximaNexusRequesterUserId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
59
65
  /**
60
66
  *
61
- * @summary Get events of a group
67
+ * @summary Get connections of a group
62
68
  * @param {string} groupId
69
+ * @param {Array<GroupControllerGetConnectionsStateEnum>} [state] Filter connections by state (e.g., requested for pending approvals)
70
+ * @param {Array<GroupControllerGetConnectionsTypeEnum>} [type] Filter connections by type. Can be a single type or multiple types (comma-separated or array)
71
+ * @param {string} [xProximaNexusRequesterUserId] ID of the user getting connections of the group. If set, 401 may be returned if the user cannot view the group connections.
63
72
  * @param {*} [options] Override http request option.
64
73
  * @throws {RequiredError}
65
74
  */
66
- getEvents: (groupId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
75
+ getConnections: (groupId: string, state?: Array<GroupControllerGetConnectionsStateEnum>, type?: Array<GroupControllerGetConnectionsTypeEnum>, xProximaNexusRequesterUserId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
67
76
  /**
68
77
  *
69
- * @summary Get members of a group
78
+ * @summary Get events of a group
70
79
  * @param {string} groupId
80
+ * @param {string} [xProximaNexusRequesterUserId] ID of the user getting events of the group. If set, events will be filtered to only include events that the user can see, and requesterConnection will be set on the results.
71
81
  * @param {*} [options] Override http request option.
72
82
  * @throws {RequiredError}
73
83
  */
74
- getMembers: (groupId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
84
+ getEvents: (groupId: string, xProximaNexusRequesterUserId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
75
85
  /**
76
86
  *
77
87
  * @summary Delete a group
78
88
  * @param {string} groupId
79
- * @param {string} xProximaNexusRequesterUserId Requester user ID
89
+ * @param {string} xProximaNexusRequesterUserId ID of the user deleting the group
80
90
  * @param {*} [options] Override http request option.
81
91
  * @throws {RequiredError}
82
92
  */
83
93
  remove: (groupId: string, xProximaNexusRequesterUserId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
84
94
  /**
85
95
  *
86
- * @summary Remove a member from a group
96
+ * @summary Remove a connection from a group
87
97
  * @param {string} groupId
88
98
  * @param {string} userId
99
+ * @param {string} xProximaNexusRequesterUserId ID of the user removing a connection from the group
100
+ * @param {MutateGroupEntityConnectionDto} mutateGroupEntityConnectionDto
89
101
  * @param {*} [options] Override http request option.
90
102
  * @throws {RequiredError}
91
103
  */
92
- removeMember: (groupId: string, userId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
104
+ removeConnection: (groupId: string, userId: string, xProximaNexusRequesterUserId: string, mutateGroupEntityConnectionDto: MutateGroupEntityConnectionDto, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
93
105
  /**
94
106
  *
95
107
  * @summary Search groups
@@ -102,19 +114,21 @@ export declare const GroupApiAxiosParamCreator: (configuration?: Configuration)
102
114
  * @param {number} [minLongitude] Minimum longitude for bounding box
103
115
  * @param {number} [maxLongitude] Maximum longitude for bounding box
104
116
  * @param {number} [limit] Limit results (1-1000)
117
+ * @param {string} [xProximaNexusRequesterUserId] ID of the user searching for groups. If set, groups will be filtered to only include groups that the user can see, and requesterConnection will be set on the results.
105
118
  * @param {*} [options] Override http request option.
106
119
  * @throws {RequiredError}
107
120
  */
108
- search: (displayName?: string, latitude?: number, longitude?: number, radius?: number, minLatitude?: number, maxLatitude?: number, minLongitude?: number, maxLongitude?: number, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
121
+ search: (displayName?: string, latitude?: number, longitude?: number, radius?: number, minLatitude?: number, maxLatitude?: number, minLongitude?: number, maxLongitude?: number, limit?: number, xProximaNexusRequesterUserId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
109
122
  /**
110
123
  *
111
124
  * @summary Update a group
112
125
  * @param {string} groupId
126
+ * @param {string} xProximaNexusRequesterUserId ID of the user updating the group
113
127
  * @param {UpdateGroupDto} updateGroupDto
114
128
  * @param {*} [options] Override http request option.
115
129
  * @throws {RequiredError}
116
130
  */
117
- update: (groupId: string, updateGroupDto: UpdateGroupDto, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
131
+ update: (groupId: string, xProximaNexusRequesterUserId: string, updateGroupDto: UpdateGroupDto, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
118
132
  };
119
133
  /**
120
134
  * GroupApi - functional programming interface
@@ -122,71 +136,82 @@ export declare const GroupApiAxiosParamCreator: (configuration?: Configuration)
122
136
  export declare const GroupApiFp: (configuration?: Configuration) => {
123
137
  /**
124
138
  *
125
- * @summary Add a member to a group
139
+ * @summary Add or update a connection to a group (member, admin, or owner)
126
140
  * @param {string} groupId
127
141
  * @param {string} userId
142
+ * @param {string} xProximaNexusRequesterUserId ID of the user adding a connection to the group
143
+ * @param {MutateGroupEntityConnectionDto} mutateGroupEntityConnectionDto
128
144
  * @param {*} [options] Override http request option.
129
145
  * @throws {RequiredError}
130
146
  */
131
- addMember(groupId: string, userId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EntityConnectionDto>>;
147
+ addConnection(groupId: string, userId: string, xProximaNexusRequesterUserId: string, mutateGroupEntityConnectionDto: MutateGroupEntityConnectionDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EntityConnectionDto>>;
132
148
  /**
133
149
  *
134
150
  * @summary Create a group
151
+ * @param {string} xProximaNexusRequesterUserId ID of the user creating the group
135
152
  * @param {CreateGroupDto} createGroupDto
136
153
  * @param {*} [options] Override http request option.
137
154
  * @throws {RequiredError}
138
155
  */
139
- create(createGroupDto: CreateGroupDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
156
+ create(xProximaNexusRequesterUserId: string, createGroupDto: CreateGroupDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
140
157
  /**
141
158
  *
142
159
  * @summary Get a group by ID
143
160
  * @param {string} groupId
161
+ * @param {string} [xProximaNexusRequesterUserId] ID of the user getting a group by ID. If set, 401 may be returned if the user cannot view the group, otherwise requesterConnection will be set on the result.
144
162
  * @param {*} [options] Override http request option.
145
163
  * @throws {RequiredError}
146
164
  */
147
- findOne(groupId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GroupDto>>;
165
+ get(groupId: string, xProximaNexusRequesterUserId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GroupDto>>;
148
166
  /**
149
167
  *
150
168
  * @summary Get a batch of groups by IDs
151
169
  * @param {GetGroupsDto} getGroupsDto
170
+ * @param {string} [xProximaNexusRequesterUserId] ID of the user getting a batch of groups. If set, groups will be filtered to only include groups that the user can see, and requesterConnection will be set on the results.
152
171
  * @param {*} [options] Override http request option.
153
172
  * @throws {RequiredError}
154
173
  */
155
- getBatch(getGroupsDto: GetGroupsDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<GroupDto>>>;
174
+ getBatch(getGroupsDto: GetGroupsDto, xProximaNexusRequesterUserId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<GroupDto>>>;
156
175
  /**
157
176
  *
158
- * @summary Get events of a group
177
+ * @summary Get connections of a group
159
178
  * @param {string} groupId
179
+ * @param {Array<GroupControllerGetConnectionsStateEnum>} [state] Filter connections by state (e.g., requested for pending approvals)
180
+ * @param {Array<GroupControllerGetConnectionsTypeEnum>} [type] Filter connections by type. Can be a single type or multiple types (comma-separated or array)
181
+ * @param {string} [xProximaNexusRequesterUserId] ID of the user getting connections of the group. If set, 401 may be returned if the user cannot view the group connections.
160
182
  * @param {*} [options] Override http request option.
161
183
  * @throws {RequiredError}
162
184
  */
163
- getEvents(groupId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<EventEntityConnectionDto>>>;
185
+ getConnections(groupId: string, state?: Array<GroupControllerGetConnectionsStateEnum>, type?: Array<GroupControllerGetConnectionsTypeEnum>, xProximaNexusRequesterUserId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<UserEntityConnectionDto>>>;
164
186
  /**
165
187
  *
166
- * @summary Get members of a group
188
+ * @summary Get events of a group
167
189
  * @param {string} groupId
190
+ * @param {string} [xProximaNexusRequesterUserId] ID of the user getting events of the group. If set, events will be filtered to only include events that the user can see, and requesterConnection will be set on the results.
168
191
  * @param {*} [options] Override http request option.
169
192
  * @throws {RequiredError}
170
193
  */
171
- getMembers(groupId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<UserEntityConnectionDto>>>;
194
+ getEvents(groupId: string, xProximaNexusRequesterUserId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<EventEntityConnectionDto>>>;
172
195
  /**
173
196
  *
174
197
  * @summary Delete a group
175
198
  * @param {string} groupId
176
- * @param {string} xProximaNexusRequesterUserId Requester user ID
199
+ * @param {string} xProximaNexusRequesterUserId ID of the user deleting the group
177
200
  * @param {*} [options] Override http request option.
178
201
  * @throws {RequiredError}
179
202
  */
180
203
  remove(groupId: string, xProximaNexusRequesterUserId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
181
204
  /**
182
205
  *
183
- * @summary Remove a member from a group
206
+ * @summary Remove a connection from a group
184
207
  * @param {string} groupId
185
208
  * @param {string} userId
209
+ * @param {string} xProximaNexusRequesterUserId ID of the user removing a connection from the group
210
+ * @param {MutateGroupEntityConnectionDto} mutateGroupEntityConnectionDto
186
211
  * @param {*} [options] Override http request option.
187
212
  * @throws {RequiredError}
188
213
  */
189
- removeMember(groupId: string, userId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
214
+ removeConnection(groupId: string, userId: string, xProximaNexusRequesterUserId: string, mutateGroupEntityConnectionDto: MutateGroupEntityConnectionDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
190
215
  /**
191
216
  *
192
217
  * @summary Search groups
@@ -199,19 +224,21 @@ export declare const GroupApiFp: (configuration?: Configuration) => {
199
224
  * @param {number} [minLongitude] Minimum longitude for bounding box
200
225
  * @param {number} [maxLongitude] Maximum longitude for bounding box
201
226
  * @param {number} [limit] Limit results (1-1000)
227
+ * @param {string} [xProximaNexusRequesterUserId] ID of the user searching for groups. If set, groups will be filtered to only include groups that the user can see, and requesterConnection will be set on the results.
202
228
  * @param {*} [options] Override http request option.
203
229
  * @throws {RequiredError}
204
230
  */
205
- search(displayName?: string, latitude?: number, longitude?: number, radius?: number, minLatitude?: number, maxLatitude?: number, minLongitude?: number, maxLongitude?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<GroupDto>>>;
231
+ search(displayName?: string, latitude?: number, longitude?: number, radius?: number, minLatitude?: number, maxLatitude?: number, minLongitude?: number, maxLongitude?: number, limit?: number, xProximaNexusRequesterUserId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<GroupDto>>>;
206
232
  /**
207
233
  *
208
234
  * @summary Update a group
209
235
  * @param {string} groupId
236
+ * @param {string} xProximaNexusRequesterUserId ID of the user updating the group
210
237
  * @param {UpdateGroupDto} updateGroupDto
211
238
  * @param {*} [options] Override http request option.
212
239
  * @throws {RequiredError}
213
240
  */
214
- update(groupId: string, updateGroupDto: UpdateGroupDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
241
+ update(groupId: string, xProximaNexusRequesterUserId: string, updateGroupDto: UpdateGroupDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<string>>;
215
242
  };
216
243
  /**
217
244
  * GroupApi - factory interface
@@ -219,71 +246,82 @@ export declare const GroupApiFp: (configuration?: Configuration) => {
219
246
  export declare const GroupApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
220
247
  /**
221
248
  *
222
- * @summary Add a member to a group
249
+ * @summary Add or update a connection to a group (member, admin, or owner)
223
250
  * @param {string} groupId
224
251
  * @param {string} userId
252
+ * @param {string} xProximaNexusRequesterUserId ID of the user adding a connection to the group
253
+ * @param {MutateGroupEntityConnectionDto} mutateGroupEntityConnectionDto
225
254
  * @param {*} [options] Override http request option.
226
255
  * @throws {RequiredError}
227
256
  */
228
- addMember(groupId: string, userId: string, options?: RawAxiosRequestConfig): AxiosPromise<EntityConnectionDto>;
257
+ addConnection(groupId: string, userId: string, xProximaNexusRequesterUserId: string, mutateGroupEntityConnectionDto: MutateGroupEntityConnectionDto, options?: RawAxiosRequestConfig): AxiosPromise<EntityConnectionDto>;
229
258
  /**
230
259
  *
231
260
  * @summary Create a group
261
+ * @param {string} xProximaNexusRequesterUserId ID of the user creating the group
232
262
  * @param {CreateGroupDto} createGroupDto
233
263
  * @param {*} [options] Override http request option.
234
264
  * @throws {RequiredError}
235
265
  */
236
- create(createGroupDto: CreateGroupDto, options?: RawAxiosRequestConfig): AxiosPromise<string>;
266
+ create(xProximaNexusRequesterUserId: string, createGroupDto: CreateGroupDto, options?: RawAxiosRequestConfig): AxiosPromise<string>;
237
267
  /**
238
268
  *
239
269
  * @summary Get a group by ID
240
270
  * @param {string} groupId
271
+ * @param {string} [xProximaNexusRequesterUserId] ID of the user getting a group by ID. If set, 401 may be returned if the user cannot view the group, otherwise requesterConnection will be set on the result.
241
272
  * @param {*} [options] Override http request option.
242
273
  * @throws {RequiredError}
243
274
  */
244
- findOne(groupId: string, options?: RawAxiosRequestConfig): AxiosPromise<GroupDto>;
275
+ get(groupId: string, xProximaNexusRequesterUserId?: string, options?: RawAxiosRequestConfig): AxiosPromise<GroupDto>;
245
276
  /**
246
277
  *
247
278
  * @summary Get a batch of groups by IDs
248
279
  * @param {GetGroupsDto} getGroupsDto
280
+ * @param {string} [xProximaNexusRequesterUserId] ID of the user getting a batch of groups. If set, groups will be filtered to only include groups that the user can see, and requesterConnection will be set on the results.
249
281
  * @param {*} [options] Override http request option.
250
282
  * @throws {RequiredError}
251
283
  */
252
- getBatch(getGroupsDto: GetGroupsDto, options?: RawAxiosRequestConfig): AxiosPromise<Array<GroupDto>>;
284
+ getBatch(getGroupsDto: GetGroupsDto, xProximaNexusRequesterUserId?: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<GroupDto>>;
253
285
  /**
254
286
  *
255
- * @summary Get events of a group
287
+ * @summary Get connections of a group
256
288
  * @param {string} groupId
289
+ * @param {Array<GroupControllerGetConnectionsStateEnum>} [state] Filter connections by state (e.g., requested for pending approvals)
290
+ * @param {Array<GroupControllerGetConnectionsTypeEnum>} [type] Filter connections by type. Can be a single type or multiple types (comma-separated or array)
291
+ * @param {string} [xProximaNexusRequesterUserId] ID of the user getting connections of the group. If set, 401 may be returned if the user cannot view the group connections.
257
292
  * @param {*} [options] Override http request option.
258
293
  * @throws {RequiredError}
259
294
  */
260
- getEvents(groupId: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<EventEntityConnectionDto>>;
295
+ getConnections(groupId: string, state?: Array<GroupControllerGetConnectionsStateEnum>, type?: Array<GroupControllerGetConnectionsTypeEnum>, xProximaNexusRequesterUserId?: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<UserEntityConnectionDto>>;
261
296
  /**
262
297
  *
263
- * @summary Get members of a group
298
+ * @summary Get events of a group
264
299
  * @param {string} groupId
300
+ * @param {string} [xProximaNexusRequesterUserId] ID of the user getting events of the group. If set, events will be filtered to only include events that the user can see, and requesterConnection will be set on the results.
265
301
  * @param {*} [options] Override http request option.
266
302
  * @throws {RequiredError}
267
303
  */
268
- getMembers(groupId: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<UserEntityConnectionDto>>;
304
+ getEvents(groupId: string, xProximaNexusRequesterUserId?: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<EventEntityConnectionDto>>;
269
305
  /**
270
306
  *
271
307
  * @summary Delete a group
272
308
  * @param {string} groupId
273
- * @param {string} xProximaNexusRequesterUserId Requester user ID
309
+ * @param {string} xProximaNexusRequesterUserId ID of the user deleting the group
274
310
  * @param {*} [options] Override http request option.
275
311
  * @throws {RequiredError}
276
312
  */
277
313
  remove(groupId: string, xProximaNexusRequesterUserId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
278
314
  /**
279
315
  *
280
- * @summary Remove a member from a group
316
+ * @summary Remove a connection from a group
281
317
  * @param {string} groupId
282
318
  * @param {string} userId
319
+ * @param {string} xProximaNexusRequesterUserId ID of the user removing a connection from the group
320
+ * @param {MutateGroupEntityConnectionDto} mutateGroupEntityConnectionDto
283
321
  * @param {*} [options] Override http request option.
284
322
  * @throws {RequiredError}
285
323
  */
286
- removeMember(groupId: string, userId: string, options?: RawAxiosRequestConfig): AxiosPromise<string>;
324
+ removeConnection(groupId: string, userId: string, xProximaNexusRequesterUserId: string, mutateGroupEntityConnectionDto: MutateGroupEntityConnectionDto, options?: RawAxiosRequestConfig): AxiosPromise<void>;
287
325
  /**
288
326
  *
289
327
  * @summary Search groups
@@ -296,19 +334,21 @@ export declare const GroupApiFactory: (configuration?: Configuration, basePath?:
296
334
  * @param {number} [minLongitude] Minimum longitude for bounding box
297
335
  * @param {number} [maxLongitude] Maximum longitude for bounding box
298
336
  * @param {number} [limit] Limit results (1-1000)
337
+ * @param {string} [xProximaNexusRequesterUserId] ID of the user searching for groups. If set, groups will be filtered to only include groups that the user can see, and requesterConnection will be set on the results.
299
338
  * @param {*} [options] Override http request option.
300
339
  * @throws {RequiredError}
301
340
  */
302
- search(displayName?: string, latitude?: number, longitude?: number, radius?: number, minLatitude?: number, maxLatitude?: number, minLongitude?: number, maxLongitude?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<GroupDto>>;
341
+ search(displayName?: string, latitude?: number, longitude?: number, radius?: number, minLatitude?: number, maxLatitude?: number, minLongitude?: number, maxLongitude?: number, limit?: number, xProximaNexusRequesterUserId?: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<GroupDto>>;
303
342
  /**
304
343
  *
305
344
  * @summary Update a group
306
345
  * @param {string} groupId
346
+ * @param {string} xProximaNexusRequesterUserId ID of the user updating the group
307
347
  * @param {UpdateGroupDto} updateGroupDto
308
348
  * @param {*} [options] Override http request option.
309
349
  * @throws {RequiredError}
310
350
  */
311
- update(groupId: string, updateGroupDto: UpdateGroupDto, options?: RawAxiosRequestConfig): AxiosPromise<string>;
351
+ update(groupId: string, xProximaNexusRequesterUserId: string, updateGroupDto: UpdateGroupDto, options?: RawAxiosRequestConfig): AxiosPromise<string>;
312
352
  };
313
353
  /**
314
354
  * GroupApi - interface
@@ -316,71 +356,82 @@ export declare const GroupApiFactory: (configuration?: Configuration, basePath?:
316
356
  export interface GroupApiInterface {
317
357
  /**
318
358
  *
319
- * @summary Add a member to a group
359
+ * @summary Add or update a connection to a group (member, admin, or owner)
320
360
  * @param {string} groupId
321
361
  * @param {string} userId
362
+ * @param {string} xProximaNexusRequesterUserId ID of the user adding a connection to the group
363
+ * @param {MutateGroupEntityConnectionDto} mutateGroupEntityConnectionDto
322
364
  * @param {*} [options] Override http request option.
323
365
  * @throws {RequiredError}
324
366
  */
325
- addMember(groupId: string, userId: string, options?: RawAxiosRequestConfig): AxiosPromise<EntityConnectionDto>;
367
+ addConnection(groupId: string, userId: string, xProximaNexusRequesterUserId: string, mutateGroupEntityConnectionDto: MutateGroupEntityConnectionDto, options?: RawAxiosRequestConfig): AxiosPromise<EntityConnectionDto>;
326
368
  /**
327
369
  *
328
370
  * @summary Create a group
371
+ * @param {string} xProximaNexusRequesterUserId ID of the user creating the group
329
372
  * @param {CreateGroupDto} createGroupDto
330
373
  * @param {*} [options] Override http request option.
331
374
  * @throws {RequiredError}
332
375
  */
333
- create(createGroupDto: CreateGroupDto, options?: RawAxiosRequestConfig): AxiosPromise<string>;
376
+ create(xProximaNexusRequesterUserId: string, createGroupDto: CreateGroupDto, options?: RawAxiosRequestConfig): AxiosPromise<string>;
334
377
  /**
335
378
  *
336
379
  * @summary Get a group by ID
337
380
  * @param {string} groupId
381
+ * @param {string} [xProximaNexusRequesterUserId] ID of the user getting a group by ID. If set, 401 may be returned if the user cannot view the group, otherwise requesterConnection will be set on the result.
338
382
  * @param {*} [options] Override http request option.
339
383
  * @throws {RequiredError}
340
384
  */
341
- findOne(groupId: string, options?: RawAxiosRequestConfig): AxiosPromise<GroupDto>;
385
+ get(groupId: string, xProximaNexusRequesterUserId?: string, options?: RawAxiosRequestConfig): AxiosPromise<GroupDto>;
342
386
  /**
343
387
  *
344
388
  * @summary Get a batch of groups by IDs
345
389
  * @param {GetGroupsDto} getGroupsDto
390
+ * @param {string} [xProximaNexusRequesterUserId] ID of the user getting a batch of groups. If set, groups will be filtered to only include groups that the user can see, and requesterConnection will be set on the results.
346
391
  * @param {*} [options] Override http request option.
347
392
  * @throws {RequiredError}
348
393
  */
349
- getBatch(getGroupsDto: GetGroupsDto, options?: RawAxiosRequestConfig): AxiosPromise<Array<GroupDto>>;
394
+ getBatch(getGroupsDto: GetGroupsDto, xProximaNexusRequesterUserId?: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<GroupDto>>;
350
395
  /**
351
396
  *
352
- * @summary Get events of a group
397
+ * @summary Get connections of a group
353
398
  * @param {string} groupId
399
+ * @param {Array<GroupControllerGetConnectionsStateEnum>} [state] Filter connections by state (e.g., requested for pending approvals)
400
+ * @param {Array<GroupControllerGetConnectionsTypeEnum>} [type] Filter connections by type. Can be a single type or multiple types (comma-separated or array)
401
+ * @param {string} [xProximaNexusRequesterUserId] ID of the user getting connections of the group. If set, 401 may be returned if the user cannot view the group connections.
354
402
  * @param {*} [options] Override http request option.
355
403
  * @throws {RequiredError}
356
404
  */
357
- getEvents(groupId: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<EventEntityConnectionDto>>;
405
+ getConnections(groupId: string, state?: Array<GroupControllerGetConnectionsStateEnum>, type?: Array<GroupControllerGetConnectionsTypeEnum>, xProximaNexusRequesterUserId?: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<UserEntityConnectionDto>>;
358
406
  /**
359
407
  *
360
- * @summary Get members of a group
408
+ * @summary Get events of a group
361
409
  * @param {string} groupId
410
+ * @param {string} [xProximaNexusRequesterUserId] ID of the user getting events of the group. If set, events will be filtered to only include events that the user can see, and requesterConnection will be set on the results.
362
411
  * @param {*} [options] Override http request option.
363
412
  * @throws {RequiredError}
364
413
  */
365
- getMembers(groupId: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<UserEntityConnectionDto>>;
414
+ getEvents(groupId: string, xProximaNexusRequesterUserId?: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<EventEntityConnectionDto>>;
366
415
  /**
367
416
  *
368
417
  * @summary Delete a group
369
418
  * @param {string} groupId
370
- * @param {string} xProximaNexusRequesterUserId Requester user ID
419
+ * @param {string} xProximaNexusRequesterUserId ID of the user deleting the group
371
420
  * @param {*} [options] Override http request option.
372
421
  * @throws {RequiredError}
373
422
  */
374
423
  remove(groupId: string, xProximaNexusRequesterUserId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
375
424
  /**
376
425
  *
377
- * @summary Remove a member from a group
426
+ * @summary Remove a connection from a group
378
427
  * @param {string} groupId
379
428
  * @param {string} userId
429
+ * @param {string} xProximaNexusRequesterUserId ID of the user removing a connection from the group
430
+ * @param {MutateGroupEntityConnectionDto} mutateGroupEntityConnectionDto
380
431
  * @param {*} [options] Override http request option.
381
432
  * @throws {RequiredError}
382
433
  */
383
- removeMember(groupId: string, userId: string, options?: RawAxiosRequestConfig): AxiosPromise<string>;
434
+ removeConnection(groupId: string, userId: string, xProximaNexusRequesterUserId: string, mutateGroupEntityConnectionDto: MutateGroupEntityConnectionDto, options?: RawAxiosRequestConfig): AxiosPromise<void>;
384
435
  /**
385
436
  *
386
437
  * @summary Search groups
@@ -393,19 +444,21 @@ export interface GroupApiInterface {
393
444
  * @param {number} [minLongitude] Minimum longitude for bounding box
394
445
  * @param {number} [maxLongitude] Maximum longitude for bounding box
395
446
  * @param {number} [limit] Limit results (1-1000)
447
+ * @param {string} [xProximaNexusRequesterUserId] ID of the user searching for groups. If set, groups will be filtered to only include groups that the user can see, and requesterConnection will be set on the results.
396
448
  * @param {*} [options] Override http request option.
397
449
  * @throws {RequiredError}
398
450
  */
399
- search(displayName?: string, latitude?: number, longitude?: number, radius?: number, minLatitude?: number, maxLatitude?: number, minLongitude?: number, maxLongitude?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<GroupDto>>;
451
+ search(displayName?: string, latitude?: number, longitude?: number, radius?: number, minLatitude?: number, maxLatitude?: number, minLongitude?: number, maxLongitude?: number, limit?: number, xProximaNexusRequesterUserId?: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<GroupDto>>;
400
452
  /**
401
453
  *
402
454
  * @summary Update a group
403
455
  * @param {string} groupId
456
+ * @param {string} xProximaNexusRequesterUserId ID of the user updating the group
404
457
  * @param {UpdateGroupDto} updateGroupDto
405
458
  * @param {*} [options] Override http request option.
406
459
  * @throws {RequiredError}
407
460
  */
408
- update(groupId: string, updateGroupDto: UpdateGroupDto, options?: RawAxiosRequestConfig): AxiosPromise<string>;
461
+ update(groupId: string, xProximaNexusRequesterUserId: string, updateGroupDto: UpdateGroupDto, options?: RawAxiosRequestConfig): AxiosPromise<string>;
409
462
  }
410
463
  /**
411
464
  * GroupApi - object-oriented interface
@@ -413,71 +466,82 @@ export interface GroupApiInterface {
413
466
  export declare class GroupApi extends BaseAPI implements GroupApiInterface {
414
467
  /**
415
468
  *
416
- * @summary Add a member to a group
469
+ * @summary Add or update a connection to a group (member, admin, or owner)
417
470
  * @param {string} groupId
418
471
  * @param {string} userId
472
+ * @param {string} xProximaNexusRequesterUserId ID of the user adding a connection to the group
473
+ * @param {MutateGroupEntityConnectionDto} mutateGroupEntityConnectionDto
419
474
  * @param {*} [options] Override http request option.
420
475
  * @throws {RequiredError}
421
476
  */
422
- addMember(groupId: string, userId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<EntityConnectionDto, any, {}>>;
477
+ addConnection(groupId: string, userId: string, xProximaNexusRequesterUserId: string, mutateGroupEntityConnectionDto: MutateGroupEntityConnectionDto, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<EntityConnectionDto, any, {}>>;
423
478
  /**
424
479
  *
425
480
  * @summary Create a group
481
+ * @param {string} xProximaNexusRequesterUserId ID of the user creating the group
426
482
  * @param {CreateGroupDto} createGroupDto
427
483
  * @param {*} [options] Override http request option.
428
484
  * @throws {RequiredError}
429
485
  */
430
- create(createGroupDto: CreateGroupDto, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any, {}>>;
486
+ create(xProximaNexusRequesterUserId: string, createGroupDto: CreateGroupDto, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any, {}>>;
431
487
  /**
432
488
  *
433
489
  * @summary Get a group by ID
434
490
  * @param {string} groupId
491
+ * @param {string} [xProximaNexusRequesterUserId] ID of the user getting a group by ID. If set, 401 may be returned if the user cannot view the group, otherwise requesterConnection will be set on the result.
435
492
  * @param {*} [options] Override http request option.
436
493
  * @throws {RequiredError}
437
494
  */
438
- findOne(groupId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GroupDto, any, {}>>;
495
+ get(groupId: string, xProximaNexusRequesterUserId?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GroupDto, any, {}>>;
439
496
  /**
440
497
  *
441
498
  * @summary Get a batch of groups by IDs
442
499
  * @param {GetGroupsDto} getGroupsDto
500
+ * @param {string} [xProximaNexusRequesterUserId] ID of the user getting a batch of groups. If set, groups will be filtered to only include groups that the user can see, and requesterConnection will be set on the results.
443
501
  * @param {*} [options] Override http request option.
444
502
  * @throws {RequiredError}
445
503
  */
446
- getBatch(getGroupsDto: GetGroupsDto, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GroupDto[], any, {}>>;
504
+ getBatch(getGroupsDto: GetGroupsDto, xProximaNexusRequesterUserId?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GroupDto[], any, {}>>;
447
505
  /**
448
506
  *
449
- * @summary Get events of a group
507
+ * @summary Get connections of a group
450
508
  * @param {string} groupId
509
+ * @param {Array<GroupControllerGetConnectionsStateEnum>} [state] Filter connections by state (e.g., requested for pending approvals)
510
+ * @param {Array<GroupControllerGetConnectionsTypeEnum>} [type] Filter connections by type. Can be a single type or multiple types (comma-separated or array)
511
+ * @param {string} [xProximaNexusRequesterUserId] ID of the user getting connections of the group. If set, 401 may be returned if the user cannot view the group connections.
451
512
  * @param {*} [options] Override http request option.
452
513
  * @throws {RequiredError}
453
514
  */
454
- getEvents(groupId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<EventEntityConnectionDto[], any, {}>>;
515
+ getConnections(groupId: string, state?: Array<GroupControllerGetConnectionsStateEnum>, type?: Array<GroupControllerGetConnectionsTypeEnum>, xProximaNexusRequesterUserId?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<UserEntityConnectionDto[], any, {}>>;
455
516
  /**
456
517
  *
457
- * @summary Get members of a group
518
+ * @summary Get events of a group
458
519
  * @param {string} groupId
520
+ * @param {string} [xProximaNexusRequesterUserId] ID of the user getting events of the group. If set, events will be filtered to only include events that the user can see, and requesterConnection will be set on the results.
459
521
  * @param {*} [options] Override http request option.
460
522
  * @throws {RequiredError}
461
523
  */
462
- getMembers(groupId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<UserEntityConnectionDto[], any, {}>>;
524
+ getEvents(groupId: string, xProximaNexusRequesterUserId?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<EventEntityConnectionDto[], any, {}>>;
463
525
  /**
464
526
  *
465
527
  * @summary Delete a group
466
528
  * @param {string} groupId
467
- * @param {string} xProximaNexusRequesterUserId Requester user ID
529
+ * @param {string} xProximaNexusRequesterUserId ID of the user deleting the group
468
530
  * @param {*} [options] Override http request option.
469
531
  * @throws {RequiredError}
470
532
  */
471
533
  remove(groupId: string, xProximaNexusRequesterUserId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
472
534
  /**
473
535
  *
474
- * @summary Remove a member from a group
536
+ * @summary Remove a connection from a group
475
537
  * @param {string} groupId
476
538
  * @param {string} userId
539
+ * @param {string} xProximaNexusRequesterUserId ID of the user removing a connection from the group
540
+ * @param {MutateGroupEntityConnectionDto} mutateGroupEntityConnectionDto
477
541
  * @param {*} [options] Override http request option.
478
542
  * @throws {RequiredError}
479
543
  */
480
- removeMember(groupId: string, userId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any, {}>>;
544
+ removeConnection(groupId: string, userId: string, xProximaNexusRequesterUserId: string, mutateGroupEntityConnectionDto: MutateGroupEntityConnectionDto, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
481
545
  /**
482
546
  *
483
547
  * @summary Search groups
@@ -490,17 +554,30 @@ export declare class GroupApi extends BaseAPI implements GroupApiInterface {
490
554
  * @param {number} [minLongitude] Minimum longitude for bounding box
491
555
  * @param {number} [maxLongitude] Maximum longitude for bounding box
492
556
  * @param {number} [limit] Limit results (1-1000)
557
+ * @param {string} [xProximaNexusRequesterUserId] ID of the user searching for groups. If set, groups will be filtered to only include groups that the user can see, and requesterConnection will be set on the results.
493
558
  * @param {*} [options] Override http request option.
494
559
  * @throws {RequiredError}
495
560
  */
496
- search(displayName?: string, latitude?: number, longitude?: number, radius?: number, minLatitude?: number, maxLatitude?: number, minLongitude?: number, maxLongitude?: number, limit?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GroupDto[], any, {}>>;
561
+ search(displayName?: string, latitude?: number, longitude?: number, radius?: number, minLatitude?: number, maxLatitude?: number, minLongitude?: number, maxLongitude?: number, limit?: number, xProximaNexusRequesterUserId?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GroupDto[], any, {}>>;
497
562
  /**
498
563
  *
499
564
  * @summary Update a group
500
565
  * @param {string} groupId
566
+ * @param {string} xProximaNexusRequesterUserId ID of the user updating the group
501
567
  * @param {UpdateGroupDto} updateGroupDto
502
568
  * @param {*} [options] Override http request option.
503
569
  * @throws {RequiredError}
504
570
  */
505
- update(groupId: string, updateGroupDto: UpdateGroupDto, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any, {}>>;
571
+ update(groupId: string, xProximaNexusRequesterUserId: string, updateGroupDto: UpdateGroupDto, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<string, any, {}>>;
572
+ }
573
+ export declare enum GroupControllerGetConnectionsStateEnum {
574
+ requested = "requested",
575
+ active = "active",
576
+ rejected = "rejected",
577
+ blocked = "blocked"
578
+ }
579
+ export declare enum GroupControllerGetConnectionsTypeEnum {
580
+ member = "member",
581
+ admin = "admin",
582
+ owner = "owner"
506
583
  }