@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.
- package/CHANGELOG.md +96 -0
- package/README.md +173 -159
- package/dist/api/event-api.d.ts +171 -65
- package/dist/api/event-api.js +273 -93
- package/dist/api/group-api.d.ts +147 -70
- package/dist/api/group-api.js +234 -101
- package/dist/api/user-api.d.ts +210 -125
- package/dist/api/user-api.js +297 -171
- package/dist/models/create-event-dto.d.ts +4 -4
- package/dist/models/create-group-dto.d.ts +6 -5
- package/dist/models/create-group-dto.js +7 -1
- package/dist/models/create-user-dto.d.ts +0 -4
- package/dist/models/entity-connection-dto.d.ts +17 -1
- package/dist/models/entity-connection-dto.js +14 -1
- package/dist/models/event-dto.d.ts +13 -4
- package/dist/models/event-entity-connection-dto.d.ts +17 -1
- package/dist/models/event-entity-connection-dto.js +14 -1
- package/dist/models/group-dto.d.ts +15 -5
- package/dist/models/group-dto.js +7 -1
- package/dist/models/group-entity-connection-dto.d.ts +17 -1
- package/dist/models/group-entity-connection-dto.js +14 -1
- package/dist/models/index.d.ts +3 -0
- package/dist/models/index.js +3 -0
- package/dist/models/mutate-event-entity-connection-dto.d.ts +22 -0
- package/dist/models/mutate-event-entity-connection-dto.js +22 -0
- package/dist/models/mutate-group-entity-connection-dto.d.ts +22 -0
- package/dist/models/mutate-group-entity-connection-dto.js +22 -0
- package/dist/models/mutate-user-connection-dto.d.ts +21 -0
- package/dist/models/mutate-user-connection-dto.js +21 -0
- package/dist/models/update-event-dto.d.ts +4 -4
- package/dist/models/update-group-dto.d.ts +6 -5
- package/dist/models/update-group-dto.js +7 -1
- package/dist/models/update-user-dto.d.ts +0 -4
- package/dist/models/user-dto.d.ts +5 -4
- package/dist/models/user-entity-connection-dto.d.ts +17 -1
- package/dist/models/user-entity-connection-dto.js +14 -1
- package/package.json +5 -4
package/dist/api/user-api.d.ts
CHANGED
|
@@ -17,6 +17,7 @@ import type { EntityConnectionDto } from '../models';
|
|
|
17
17
|
import type { EventEntityConnectionDto } from '../models';
|
|
18
18
|
import type { GetUsersDto } from '../models';
|
|
19
19
|
import type { GroupEntityConnectionDto } from '../models';
|
|
20
|
+
import type { MutateUserConnectionDto } from '../models';
|
|
20
21
|
import type { MutateUserResponseDto } from '../models';
|
|
21
22
|
import type { UpdateUserDto } from '../models';
|
|
22
23
|
import type { UserDto } from '../models';
|
|
@@ -27,80 +28,92 @@ import type { UserEntityConnectionDto } from '../models';
|
|
|
27
28
|
export declare const UserApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
28
29
|
/**
|
|
29
30
|
*
|
|
30
|
-
* @summary
|
|
31
|
-
* @param {
|
|
32
|
-
* @param {string} friendUserId
|
|
31
|
+
* @summary Create a user
|
|
32
|
+
* @param {CreateUserDto} createUserDto
|
|
33
33
|
* @param {*} [options] Override http request option.
|
|
34
34
|
* @throws {RequiredError}
|
|
35
35
|
*/
|
|
36
|
-
|
|
36
|
+
create: (createUserDto: CreateUserDto, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
37
37
|
/**
|
|
38
|
-
*
|
|
39
|
-
* @summary
|
|
40
|
-
* @param {
|
|
38
|
+
* Remove a friend connection or unblock a user. For BLOCKED connections, only the user who initiated the block can unblock.
|
|
39
|
+
* @summary Delete a connection with another user
|
|
40
|
+
* @param {string} userId
|
|
41
|
+
* @param {string} targetUserId
|
|
42
|
+
* @param {UserControllerDeleteConnectionTypeEnum} type Type of connection to delete
|
|
43
|
+
* @param {string} xProximaNexusRequesterUserId ID of the user deleting the connection
|
|
41
44
|
* @param {*} [options] Override http request option.
|
|
42
45
|
* @throws {RequiredError}
|
|
43
46
|
*/
|
|
44
|
-
|
|
47
|
+
deleteConnection: (userId: string, targetUserId: string, type: UserControllerDeleteConnectionTypeEnum, xProximaNexusRequesterUserId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
45
48
|
/**
|
|
46
49
|
*
|
|
47
50
|
* @summary Get a user by ID
|
|
48
51
|
* @param {string} userId
|
|
52
|
+
* @param {string} [xProximaNexusRequesterUserId] ID of the user getting a user by ID. If set, 401 may be returned if the user cannot view the user, otherwise requesterConnection will be set on the result.
|
|
49
53
|
* @param {*} [options] Override http request option.
|
|
50
54
|
* @throws {RequiredError}
|
|
51
55
|
*/
|
|
52
|
-
|
|
56
|
+
get: (userId: string, xProximaNexusRequesterUserId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
53
57
|
/**
|
|
54
58
|
*
|
|
55
59
|
* @summary Get a batch of users by IDs
|
|
56
60
|
* @param {GetUsersDto} getUsersDto
|
|
61
|
+
* @param {string} [xProximaNexusRequesterUserId] ID of the user getting a batch of users. If set, users will be filtered to only include users that the user can see, and requesterConnection will be set on the results.
|
|
57
62
|
* @param {*} [options] Override http request option.
|
|
58
63
|
* @throws {RequiredError}
|
|
59
64
|
*/
|
|
60
|
-
getBatch: (getUsersDto: GetUsersDto, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
65
|
+
getBatch: (getUsersDto: GetUsersDto, xProximaNexusRequesterUserId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
61
66
|
/**
|
|
62
|
-
*
|
|
63
|
-
* @summary Get
|
|
67
|
+
* Get user connections with optional type and state filters. Visibility rules apply: HIDDEN/CONNECTIONS users only show connections to self or connected users. Only the user themselves can see BLOCKED connections or non-ACTIVE states.
|
|
68
|
+
* @summary Get connections of a user
|
|
64
69
|
* @param {string} userId
|
|
70
|
+
* @param {Array<UserControllerGetConnectionsStateEnum>} [state] Filter connections by state. Can be multiple values. Non-self requesters can only see ACTIVE connections.
|
|
71
|
+
* @param {Array<UserControllerGetConnectionsTypeEnum>} [type] Filter connections by type. Can be multiple values.
|
|
72
|
+
* @param {string} [xProximaNexusRequesterUserId] ID of the user viewing connections. Required for non-PUBLIC users. Only the user themselves can view BLOCKED or non-ACTIVE connections.
|
|
65
73
|
* @param {*} [options] Override http request option.
|
|
66
74
|
* @throws {RequiredError}
|
|
67
75
|
*/
|
|
68
|
-
|
|
76
|
+
getConnections: (userId: string, state?: Array<UserControllerGetConnectionsStateEnum>, type?: Array<UserControllerGetConnectionsTypeEnum>, xProximaNexusRequesterUserId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
69
77
|
/**
|
|
70
78
|
*
|
|
71
|
-
* @summary Get
|
|
79
|
+
* @summary Get events of a user
|
|
72
80
|
* @param {string} userId
|
|
81
|
+
* @param {string} [xProximaNexusRequesterUserId] ID of the user getting events of a user. If set, events will be filtered to only include events that the user can see, and requesterConnection will be set on the results.
|
|
73
82
|
* @param {*} [options] Override http request option.
|
|
74
83
|
* @throws {RequiredError}
|
|
75
84
|
*/
|
|
76
|
-
|
|
85
|
+
getEvents: (userId: string, xProximaNexusRequesterUserId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
77
86
|
/**
|
|
78
87
|
*
|
|
79
88
|
* @summary Get groups of a user
|
|
80
89
|
* @param {string} userId
|
|
90
|
+
* @param {string} [xProximaNexusRequesterUserId] ID of the user getting groups of a user. If set, groups will be filtered to only include groups that the user can see, and requesterConnection will be set on the results.
|
|
81
91
|
* @param {*} [options] Override http request option.
|
|
82
92
|
* @throws {RequiredError}
|
|
83
93
|
*/
|
|
84
|
-
getGroups: (userId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
94
|
+
getGroups: (userId: string, xProximaNexusRequesterUserId?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
85
95
|
/**
|
|
86
|
-
*
|
|
87
|
-
* @summary
|
|
96
|
+
* Create a friend request, accept a pending request, or block a user. For FRIEND type: creates REQUESTED state if no connection exists; target user can accept by setting state to ACTIVE. For BLOCKED type: creates a mutual block.
|
|
97
|
+
* @summary Create or update a connection with another user
|
|
88
98
|
* @param {string} userId
|
|
99
|
+
* @param {string} targetUserId
|
|
100
|
+
* @param {string} xProximaNexusRequesterUserId ID of the user creating/modifying the connection (must match userId)
|
|
101
|
+
* @param {MutateUserConnectionDto} mutateUserConnectionDto
|
|
89
102
|
* @param {*} [options] Override http request option.
|
|
90
103
|
* @throws {RequiredError}
|
|
91
104
|
*/
|
|
92
|
-
|
|
105
|
+
putConnection: (userId: string, targetUserId: string, xProximaNexusRequesterUserId: string, mutateUserConnectionDto: MutateUserConnectionDto, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
93
106
|
/**
|
|
94
107
|
*
|
|
95
|
-
* @summary
|
|
108
|
+
* @summary Delete a user
|
|
96
109
|
* @param {string} userId
|
|
97
|
-
* @param {string}
|
|
110
|
+
* @param {string} xProximaNexusRequesterUserId ID of the user deleting the user
|
|
98
111
|
* @param {*} [options] Override http request option.
|
|
99
112
|
* @throws {RequiredError}
|
|
100
113
|
*/
|
|
101
|
-
|
|
114
|
+
remove: (userId: string, xProximaNexusRequesterUserId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
102
115
|
/**
|
|
103
|
-
*
|
|
116
|
+
* Search for users. When requesterUserId is provided, HIDDEN users are filtered out unless the requester is connected to them, and users who have blocked the requester are also filtered out. When requesterUserId is not provided, all users are returned without visibility filtering.
|
|
104
117
|
* @summary Search users
|
|
105
118
|
* @param {string} [displayName] Display name search (ILIKE)
|
|
106
119
|
* @param {number} [latitude] Latitude for radius search
|
|
@@ -111,19 +124,21 @@ export declare const UserApiAxiosParamCreator: (configuration?: Configuration) =
|
|
|
111
124
|
* @param {number} [minLongitude] Minimum longitude for bounding box
|
|
112
125
|
* @param {number} [maxLongitude] Maximum longitude for bounding box
|
|
113
126
|
* @param {number} [limit] Limit results (1-1000)
|
|
127
|
+
* @param {string} [xProximaNexusRequesterUserId] ID of the user searching for users. If set, users will be filtered to only include users that the user can see, and requesterConnection will be set on the results.
|
|
114
128
|
* @param {*} [options] Override http request option.
|
|
115
129
|
* @throws {RequiredError}
|
|
116
130
|
*/
|
|
117
|
-
search: (displayName?: string, latitude?: number, longitude?: number, radius?: number, minLatitude?: number, maxLatitude?: number, minLongitude?: number, maxLongitude?: number, limit?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
131
|
+
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>;
|
|
118
132
|
/**
|
|
119
133
|
*
|
|
120
134
|
* @summary Update a user
|
|
121
135
|
* @param {string} userId
|
|
136
|
+
* @param {string} xProximaNexusRequesterUserId ID of the user updating the user
|
|
122
137
|
* @param {UpdateUserDto} updateUserDto
|
|
123
138
|
* @param {*} [options] Override http request option.
|
|
124
139
|
* @throws {RequiredError}
|
|
125
140
|
*/
|
|
126
|
-
update: (userId: string, updateUserDto: UpdateUserDto, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
141
|
+
update: (userId: string, xProximaNexusRequesterUserId: string, updateUserDto: UpdateUserDto, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
127
142
|
};
|
|
128
143
|
/**
|
|
129
144
|
* UserApi - functional programming interface
|
|
@@ -131,80 +146,92 @@ export declare const UserApiAxiosParamCreator: (configuration?: Configuration) =
|
|
|
131
146
|
export declare const UserApiFp: (configuration?: Configuration) => {
|
|
132
147
|
/**
|
|
133
148
|
*
|
|
134
|
-
* @summary
|
|
135
|
-
* @param {
|
|
136
|
-
* @param {string} friendUserId
|
|
149
|
+
* @summary Create a user
|
|
150
|
+
* @param {CreateUserDto} createUserDto
|
|
137
151
|
* @param {*} [options] Override http request option.
|
|
138
152
|
* @throws {RequiredError}
|
|
139
153
|
*/
|
|
140
|
-
|
|
154
|
+
create(createUserDto: CreateUserDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MutateUserResponseDto>>;
|
|
141
155
|
/**
|
|
142
|
-
*
|
|
143
|
-
* @summary
|
|
144
|
-
* @param {
|
|
156
|
+
* Remove a friend connection or unblock a user. For BLOCKED connections, only the user who initiated the block can unblock.
|
|
157
|
+
* @summary Delete a connection with another user
|
|
158
|
+
* @param {string} userId
|
|
159
|
+
* @param {string} targetUserId
|
|
160
|
+
* @param {UserControllerDeleteConnectionTypeEnum} type Type of connection to delete
|
|
161
|
+
* @param {string} xProximaNexusRequesterUserId ID of the user deleting the connection
|
|
145
162
|
* @param {*} [options] Override http request option.
|
|
146
163
|
* @throws {RequiredError}
|
|
147
164
|
*/
|
|
148
|
-
|
|
165
|
+
deleteConnection(userId: string, targetUserId: string, type: UserControllerDeleteConnectionTypeEnum, xProximaNexusRequesterUserId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
149
166
|
/**
|
|
150
167
|
*
|
|
151
168
|
* @summary Get a user by ID
|
|
152
169
|
* @param {string} userId
|
|
170
|
+
* @param {string} [xProximaNexusRequesterUserId] ID of the user getting a user by ID. If set, 401 may be returned if the user cannot view the user, otherwise requesterConnection will be set on the result.
|
|
153
171
|
* @param {*} [options] Override http request option.
|
|
154
172
|
* @throws {RequiredError}
|
|
155
173
|
*/
|
|
156
|
-
|
|
174
|
+
get(userId: string, xProximaNexusRequesterUserId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserDto>>;
|
|
157
175
|
/**
|
|
158
176
|
*
|
|
159
177
|
* @summary Get a batch of users by IDs
|
|
160
178
|
* @param {GetUsersDto} getUsersDto
|
|
179
|
+
* @param {string} [xProximaNexusRequesterUserId] ID of the user getting a batch of users. If set, users will be filtered to only include users that the user can see, and requesterConnection will be set on the results.
|
|
161
180
|
* @param {*} [options] Override http request option.
|
|
162
181
|
* @throws {RequiredError}
|
|
163
182
|
*/
|
|
164
|
-
getBatch(getUsersDto: GetUsersDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<UserDto>>>;
|
|
183
|
+
getBatch(getUsersDto: GetUsersDto, xProximaNexusRequesterUserId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<UserDto>>>;
|
|
165
184
|
/**
|
|
166
|
-
*
|
|
167
|
-
* @summary Get
|
|
185
|
+
* Get user connections with optional type and state filters. Visibility rules apply: HIDDEN/CONNECTIONS users only show connections to self or connected users. Only the user themselves can see BLOCKED connections or non-ACTIVE states.
|
|
186
|
+
* @summary Get connections of a user
|
|
168
187
|
* @param {string} userId
|
|
188
|
+
* @param {Array<UserControllerGetConnectionsStateEnum>} [state] Filter connections by state. Can be multiple values. Non-self requesters can only see ACTIVE connections.
|
|
189
|
+
* @param {Array<UserControllerGetConnectionsTypeEnum>} [type] Filter connections by type. Can be multiple values.
|
|
190
|
+
* @param {string} [xProximaNexusRequesterUserId] ID of the user viewing connections. Required for non-PUBLIC users. Only the user themselves can view BLOCKED or non-ACTIVE connections.
|
|
169
191
|
* @param {*} [options] Override http request option.
|
|
170
192
|
* @throws {RequiredError}
|
|
171
193
|
*/
|
|
172
|
-
|
|
194
|
+
getConnections(userId: string, state?: Array<UserControllerGetConnectionsStateEnum>, type?: Array<UserControllerGetConnectionsTypeEnum>, xProximaNexusRequesterUserId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<UserEntityConnectionDto>>>;
|
|
173
195
|
/**
|
|
174
196
|
*
|
|
175
|
-
* @summary Get
|
|
197
|
+
* @summary Get events of a user
|
|
176
198
|
* @param {string} userId
|
|
199
|
+
* @param {string} [xProximaNexusRequesterUserId] ID of the user getting events of a user. If set, events will be filtered to only include events that the user can see, and requesterConnection will be set on the results.
|
|
177
200
|
* @param {*} [options] Override http request option.
|
|
178
201
|
* @throws {RequiredError}
|
|
179
202
|
*/
|
|
180
|
-
|
|
203
|
+
getEvents(userId: string, xProximaNexusRequesterUserId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<EventEntityConnectionDto>>>;
|
|
181
204
|
/**
|
|
182
205
|
*
|
|
183
206
|
* @summary Get groups of a user
|
|
184
207
|
* @param {string} userId
|
|
208
|
+
* @param {string} [xProximaNexusRequesterUserId] ID of the user getting groups of a user. If set, groups will be filtered to only include groups that the user can see, and requesterConnection will be set on the results.
|
|
185
209
|
* @param {*} [options] Override http request option.
|
|
186
210
|
* @throws {RequiredError}
|
|
187
211
|
*/
|
|
188
|
-
getGroups(userId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<GroupEntityConnectionDto>>>;
|
|
212
|
+
getGroups(userId: string, xProximaNexusRequesterUserId?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<GroupEntityConnectionDto>>>;
|
|
189
213
|
/**
|
|
190
|
-
*
|
|
191
|
-
* @summary
|
|
214
|
+
* Create a friend request, accept a pending request, or block a user. For FRIEND type: creates REQUESTED state if no connection exists; target user can accept by setting state to ACTIVE. For BLOCKED type: creates a mutual block.
|
|
215
|
+
* @summary Create or update a connection with another user
|
|
192
216
|
* @param {string} userId
|
|
217
|
+
* @param {string} targetUserId
|
|
218
|
+
* @param {string} xProximaNexusRequesterUserId ID of the user creating/modifying the connection (must match userId)
|
|
219
|
+
* @param {MutateUserConnectionDto} mutateUserConnectionDto
|
|
193
220
|
* @param {*} [options] Override http request option.
|
|
194
221
|
* @throws {RequiredError}
|
|
195
222
|
*/
|
|
196
|
-
|
|
223
|
+
putConnection(userId: string, targetUserId: string, xProximaNexusRequesterUserId: string, mutateUserConnectionDto: MutateUserConnectionDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EntityConnectionDto>>;
|
|
197
224
|
/**
|
|
198
225
|
*
|
|
199
|
-
* @summary
|
|
226
|
+
* @summary Delete a user
|
|
200
227
|
* @param {string} userId
|
|
201
|
-
* @param {string}
|
|
228
|
+
* @param {string} xProximaNexusRequesterUserId ID of the user deleting the user
|
|
202
229
|
* @param {*} [options] Override http request option.
|
|
203
230
|
* @throws {RequiredError}
|
|
204
231
|
*/
|
|
205
|
-
|
|
232
|
+
remove(userId: string, xProximaNexusRequesterUserId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
206
233
|
/**
|
|
207
|
-
*
|
|
234
|
+
* Search for users. When requesterUserId is provided, HIDDEN users are filtered out unless the requester is connected to them, and users who have blocked the requester are also filtered out. When requesterUserId is not provided, all users are returned without visibility filtering.
|
|
208
235
|
* @summary Search users
|
|
209
236
|
* @param {string} [displayName] Display name search (ILIKE)
|
|
210
237
|
* @param {number} [latitude] Latitude for radius search
|
|
@@ -215,19 +242,21 @@ export declare const UserApiFp: (configuration?: Configuration) => {
|
|
|
215
242
|
* @param {number} [minLongitude] Minimum longitude for bounding box
|
|
216
243
|
* @param {number} [maxLongitude] Maximum longitude for bounding box
|
|
217
244
|
* @param {number} [limit] Limit results (1-1000)
|
|
245
|
+
* @param {string} [xProximaNexusRequesterUserId] ID of the user searching for users. If set, users will be filtered to only include users that the user can see, and requesterConnection will be set on the results.
|
|
218
246
|
* @param {*} [options] Override http request option.
|
|
219
247
|
* @throws {RequiredError}
|
|
220
248
|
*/
|
|
221
|
-
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<UserDto>>>;
|
|
249
|
+
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<UserDto>>>;
|
|
222
250
|
/**
|
|
223
251
|
*
|
|
224
252
|
* @summary Update a user
|
|
225
253
|
* @param {string} userId
|
|
254
|
+
* @param {string} xProximaNexusRequesterUserId ID of the user updating the user
|
|
226
255
|
* @param {UpdateUserDto} updateUserDto
|
|
227
256
|
* @param {*} [options] Override http request option.
|
|
228
257
|
* @throws {RequiredError}
|
|
229
258
|
*/
|
|
230
|
-
update(userId: string, updateUserDto: UpdateUserDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MutateUserResponseDto>>;
|
|
259
|
+
update(userId: string, xProximaNexusRequesterUserId: string, updateUserDto: UpdateUserDto, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MutateUserResponseDto>>;
|
|
231
260
|
};
|
|
232
261
|
/**
|
|
233
262
|
* UserApi - factory interface
|
|
@@ -235,80 +264,92 @@ export declare const UserApiFp: (configuration?: Configuration) => {
|
|
|
235
264
|
export declare const UserApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
236
265
|
/**
|
|
237
266
|
*
|
|
238
|
-
* @summary
|
|
239
|
-
* @param {
|
|
240
|
-
* @param {string} friendUserId
|
|
267
|
+
* @summary Create a user
|
|
268
|
+
* @param {CreateUserDto} createUserDto
|
|
241
269
|
* @param {*} [options] Override http request option.
|
|
242
270
|
* @throws {RequiredError}
|
|
243
271
|
*/
|
|
244
|
-
|
|
272
|
+
create(createUserDto: CreateUserDto, options?: RawAxiosRequestConfig): AxiosPromise<MutateUserResponseDto>;
|
|
245
273
|
/**
|
|
246
|
-
*
|
|
247
|
-
* @summary
|
|
248
|
-
* @param {
|
|
274
|
+
* Remove a friend connection or unblock a user. For BLOCKED connections, only the user who initiated the block can unblock.
|
|
275
|
+
* @summary Delete a connection with another user
|
|
276
|
+
* @param {string} userId
|
|
277
|
+
* @param {string} targetUserId
|
|
278
|
+
* @param {UserControllerDeleteConnectionTypeEnum} type Type of connection to delete
|
|
279
|
+
* @param {string} xProximaNexusRequesterUserId ID of the user deleting the connection
|
|
249
280
|
* @param {*} [options] Override http request option.
|
|
250
281
|
* @throws {RequiredError}
|
|
251
282
|
*/
|
|
252
|
-
|
|
283
|
+
deleteConnection(userId: string, targetUserId: string, type: UserControllerDeleteConnectionTypeEnum, xProximaNexusRequesterUserId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
253
284
|
/**
|
|
254
285
|
*
|
|
255
286
|
* @summary Get a user by ID
|
|
256
287
|
* @param {string} userId
|
|
288
|
+
* @param {string} [xProximaNexusRequesterUserId] ID of the user getting a user by ID. If set, 401 may be returned if the user cannot view the user, otherwise requesterConnection will be set on the result.
|
|
257
289
|
* @param {*} [options] Override http request option.
|
|
258
290
|
* @throws {RequiredError}
|
|
259
291
|
*/
|
|
260
|
-
|
|
292
|
+
get(userId: string, xProximaNexusRequesterUserId?: string, options?: RawAxiosRequestConfig): AxiosPromise<UserDto>;
|
|
261
293
|
/**
|
|
262
294
|
*
|
|
263
295
|
* @summary Get a batch of users by IDs
|
|
264
296
|
* @param {GetUsersDto} getUsersDto
|
|
297
|
+
* @param {string} [xProximaNexusRequesterUserId] ID of the user getting a batch of users. If set, users will be filtered to only include users that the user can see, and requesterConnection will be set on the results.
|
|
265
298
|
* @param {*} [options] Override http request option.
|
|
266
299
|
* @throws {RequiredError}
|
|
267
300
|
*/
|
|
268
|
-
getBatch(getUsersDto: GetUsersDto, options?: RawAxiosRequestConfig): AxiosPromise<Array<UserDto>>;
|
|
301
|
+
getBatch(getUsersDto: GetUsersDto, xProximaNexusRequesterUserId?: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<UserDto>>;
|
|
269
302
|
/**
|
|
270
|
-
*
|
|
271
|
-
* @summary Get
|
|
303
|
+
* Get user connections with optional type and state filters. Visibility rules apply: HIDDEN/CONNECTIONS users only show connections to self or connected users. Only the user themselves can see BLOCKED connections or non-ACTIVE states.
|
|
304
|
+
* @summary Get connections of a user
|
|
272
305
|
* @param {string} userId
|
|
306
|
+
* @param {Array<UserControllerGetConnectionsStateEnum>} [state] Filter connections by state. Can be multiple values. Non-self requesters can only see ACTIVE connections.
|
|
307
|
+
* @param {Array<UserControllerGetConnectionsTypeEnum>} [type] Filter connections by type. Can be multiple values.
|
|
308
|
+
* @param {string} [xProximaNexusRequesterUserId] ID of the user viewing connections. Required for non-PUBLIC users. Only the user themselves can view BLOCKED or non-ACTIVE connections.
|
|
273
309
|
* @param {*} [options] Override http request option.
|
|
274
310
|
* @throws {RequiredError}
|
|
275
311
|
*/
|
|
276
|
-
|
|
312
|
+
getConnections(userId: string, state?: Array<UserControllerGetConnectionsStateEnum>, type?: Array<UserControllerGetConnectionsTypeEnum>, xProximaNexusRequesterUserId?: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<UserEntityConnectionDto>>;
|
|
277
313
|
/**
|
|
278
314
|
*
|
|
279
|
-
* @summary Get
|
|
315
|
+
* @summary Get events of a user
|
|
280
316
|
* @param {string} userId
|
|
317
|
+
* @param {string} [xProximaNexusRequesterUserId] ID of the user getting events of a user. If set, events will be filtered to only include events that the user can see, and requesterConnection will be set on the results.
|
|
281
318
|
* @param {*} [options] Override http request option.
|
|
282
319
|
* @throws {RequiredError}
|
|
283
320
|
*/
|
|
284
|
-
|
|
321
|
+
getEvents(userId: string, xProximaNexusRequesterUserId?: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<EventEntityConnectionDto>>;
|
|
285
322
|
/**
|
|
286
323
|
*
|
|
287
324
|
* @summary Get groups of a user
|
|
288
325
|
* @param {string} userId
|
|
326
|
+
* @param {string} [xProximaNexusRequesterUserId] ID of the user getting groups of a user. If set, groups will be filtered to only include groups that the user can see, and requesterConnection will be set on the results.
|
|
289
327
|
* @param {*} [options] Override http request option.
|
|
290
328
|
* @throws {RequiredError}
|
|
291
329
|
*/
|
|
292
|
-
getGroups(userId: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<GroupEntityConnectionDto>>;
|
|
330
|
+
getGroups(userId: string, xProximaNexusRequesterUserId?: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<GroupEntityConnectionDto>>;
|
|
293
331
|
/**
|
|
294
|
-
*
|
|
295
|
-
* @summary
|
|
332
|
+
* Create a friend request, accept a pending request, or block a user. For FRIEND type: creates REQUESTED state if no connection exists; target user can accept by setting state to ACTIVE. For BLOCKED type: creates a mutual block.
|
|
333
|
+
* @summary Create or update a connection with another user
|
|
296
334
|
* @param {string} userId
|
|
335
|
+
* @param {string} targetUserId
|
|
336
|
+
* @param {string} xProximaNexusRequesterUserId ID of the user creating/modifying the connection (must match userId)
|
|
337
|
+
* @param {MutateUserConnectionDto} mutateUserConnectionDto
|
|
297
338
|
* @param {*} [options] Override http request option.
|
|
298
339
|
* @throws {RequiredError}
|
|
299
340
|
*/
|
|
300
|
-
|
|
341
|
+
putConnection(userId: string, targetUserId: string, xProximaNexusRequesterUserId: string, mutateUserConnectionDto: MutateUserConnectionDto, options?: RawAxiosRequestConfig): AxiosPromise<EntityConnectionDto>;
|
|
301
342
|
/**
|
|
302
343
|
*
|
|
303
|
-
* @summary
|
|
344
|
+
* @summary Delete a user
|
|
304
345
|
* @param {string} userId
|
|
305
|
-
* @param {string}
|
|
346
|
+
* @param {string} xProximaNexusRequesterUserId ID of the user deleting the user
|
|
306
347
|
* @param {*} [options] Override http request option.
|
|
307
348
|
* @throws {RequiredError}
|
|
308
349
|
*/
|
|
309
|
-
|
|
350
|
+
remove(userId: string, xProximaNexusRequesterUserId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
310
351
|
/**
|
|
311
|
-
*
|
|
352
|
+
* Search for users. When requesterUserId is provided, HIDDEN users are filtered out unless the requester is connected to them, and users who have blocked the requester are also filtered out. When requesterUserId is not provided, all users are returned without visibility filtering.
|
|
312
353
|
* @summary Search users
|
|
313
354
|
* @param {string} [displayName] Display name search (ILIKE)
|
|
314
355
|
* @param {number} [latitude] Latitude for radius search
|
|
@@ -319,19 +360,21 @@ export declare const UserApiFactory: (configuration?: Configuration, basePath?:
|
|
|
319
360
|
* @param {number} [minLongitude] Minimum longitude for bounding box
|
|
320
361
|
* @param {number} [maxLongitude] Maximum longitude for bounding box
|
|
321
362
|
* @param {number} [limit] Limit results (1-1000)
|
|
363
|
+
* @param {string} [xProximaNexusRequesterUserId] ID of the user searching for users. If set, users will be filtered to only include users that the user can see, and requesterConnection will be set on the results.
|
|
322
364
|
* @param {*} [options] Override http request option.
|
|
323
365
|
* @throws {RequiredError}
|
|
324
366
|
*/
|
|
325
|
-
search(displayName?: string, latitude?: number, longitude?: number, radius?: number, minLatitude?: number, maxLatitude?: number, minLongitude?: number, maxLongitude?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<UserDto>>;
|
|
367
|
+
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<UserDto>>;
|
|
326
368
|
/**
|
|
327
369
|
*
|
|
328
370
|
* @summary Update a user
|
|
329
371
|
* @param {string} userId
|
|
372
|
+
* @param {string} xProximaNexusRequesterUserId ID of the user updating the user
|
|
330
373
|
* @param {UpdateUserDto} updateUserDto
|
|
331
374
|
* @param {*} [options] Override http request option.
|
|
332
375
|
* @throws {RequiredError}
|
|
333
376
|
*/
|
|
334
|
-
update(userId: string, updateUserDto: UpdateUserDto, options?: RawAxiosRequestConfig): AxiosPromise<MutateUserResponseDto>;
|
|
377
|
+
update(userId: string, xProximaNexusRequesterUserId: string, updateUserDto: UpdateUserDto, options?: RawAxiosRequestConfig): AxiosPromise<MutateUserResponseDto>;
|
|
335
378
|
};
|
|
336
379
|
/**
|
|
337
380
|
* UserApi - interface
|
|
@@ -339,80 +382,92 @@ export declare const UserApiFactory: (configuration?: Configuration, basePath?:
|
|
|
339
382
|
export interface UserApiInterface {
|
|
340
383
|
/**
|
|
341
384
|
*
|
|
342
|
-
* @summary
|
|
343
|
-
* @param {
|
|
344
|
-
* @param {string} friendUserId
|
|
385
|
+
* @summary Create a user
|
|
386
|
+
* @param {CreateUserDto} createUserDto
|
|
345
387
|
* @param {*} [options] Override http request option.
|
|
346
388
|
* @throws {RequiredError}
|
|
347
389
|
*/
|
|
348
|
-
|
|
390
|
+
create(createUserDto: CreateUserDto, options?: RawAxiosRequestConfig): AxiosPromise<MutateUserResponseDto>;
|
|
349
391
|
/**
|
|
350
|
-
*
|
|
351
|
-
* @summary
|
|
352
|
-
* @param {
|
|
392
|
+
* Remove a friend connection or unblock a user. For BLOCKED connections, only the user who initiated the block can unblock.
|
|
393
|
+
* @summary Delete a connection with another user
|
|
394
|
+
* @param {string} userId
|
|
395
|
+
* @param {string} targetUserId
|
|
396
|
+
* @param {UserControllerDeleteConnectionTypeEnum} type Type of connection to delete
|
|
397
|
+
* @param {string} xProximaNexusRequesterUserId ID of the user deleting the connection
|
|
353
398
|
* @param {*} [options] Override http request option.
|
|
354
399
|
* @throws {RequiredError}
|
|
355
400
|
*/
|
|
356
|
-
|
|
401
|
+
deleteConnection(userId: string, targetUserId: string, type: UserControllerDeleteConnectionTypeEnum, xProximaNexusRequesterUserId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
357
402
|
/**
|
|
358
403
|
*
|
|
359
404
|
* @summary Get a user by ID
|
|
360
405
|
* @param {string} userId
|
|
406
|
+
* @param {string} [xProximaNexusRequesterUserId] ID of the user getting a user by ID. If set, 401 may be returned if the user cannot view the user, otherwise requesterConnection will be set on the result.
|
|
361
407
|
* @param {*} [options] Override http request option.
|
|
362
408
|
* @throws {RequiredError}
|
|
363
409
|
*/
|
|
364
|
-
|
|
410
|
+
get(userId: string, xProximaNexusRequesterUserId?: string, options?: RawAxiosRequestConfig): AxiosPromise<UserDto>;
|
|
365
411
|
/**
|
|
366
412
|
*
|
|
367
413
|
* @summary Get a batch of users by IDs
|
|
368
414
|
* @param {GetUsersDto} getUsersDto
|
|
415
|
+
* @param {string} [xProximaNexusRequesterUserId] ID of the user getting a batch of users. If set, users will be filtered to only include users that the user can see, and requesterConnection will be set on the results.
|
|
369
416
|
* @param {*} [options] Override http request option.
|
|
370
417
|
* @throws {RequiredError}
|
|
371
418
|
*/
|
|
372
|
-
getBatch(getUsersDto: GetUsersDto, options?: RawAxiosRequestConfig): AxiosPromise<Array<UserDto>>;
|
|
419
|
+
getBatch(getUsersDto: GetUsersDto, xProximaNexusRequesterUserId?: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<UserDto>>;
|
|
373
420
|
/**
|
|
374
|
-
*
|
|
375
|
-
* @summary Get
|
|
421
|
+
* Get user connections with optional type and state filters. Visibility rules apply: HIDDEN/CONNECTIONS users only show connections to self or connected users. Only the user themselves can see BLOCKED connections or non-ACTIVE states.
|
|
422
|
+
* @summary Get connections of a user
|
|
376
423
|
* @param {string} userId
|
|
424
|
+
* @param {Array<UserControllerGetConnectionsStateEnum>} [state] Filter connections by state. Can be multiple values. Non-self requesters can only see ACTIVE connections.
|
|
425
|
+
* @param {Array<UserControllerGetConnectionsTypeEnum>} [type] Filter connections by type. Can be multiple values.
|
|
426
|
+
* @param {string} [xProximaNexusRequesterUserId] ID of the user viewing connections. Required for non-PUBLIC users. Only the user themselves can view BLOCKED or non-ACTIVE connections.
|
|
377
427
|
* @param {*} [options] Override http request option.
|
|
378
428
|
* @throws {RequiredError}
|
|
379
429
|
*/
|
|
380
|
-
|
|
430
|
+
getConnections(userId: string, state?: Array<UserControllerGetConnectionsStateEnum>, type?: Array<UserControllerGetConnectionsTypeEnum>, xProximaNexusRequesterUserId?: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<UserEntityConnectionDto>>;
|
|
381
431
|
/**
|
|
382
432
|
*
|
|
383
|
-
* @summary Get
|
|
433
|
+
* @summary Get events of a user
|
|
384
434
|
* @param {string} userId
|
|
435
|
+
* @param {string} [xProximaNexusRequesterUserId] ID of the user getting events of a user. If set, events will be filtered to only include events that the user can see, and requesterConnection will be set on the results.
|
|
385
436
|
* @param {*} [options] Override http request option.
|
|
386
437
|
* @throws {RequiredError}
|
|
387
438
|
*/
|
|
388
|
-
|
|
439
|
+
getEvents(userId: string, xProximaNexusRequesterUserId?: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<EventEntityConnectionDto>>;
|
|
389
440
|
/**
|
|
390
441
|
*
|
|
391
442
|
* @summary Get groups of a user
|
|
392
443
|
* @param {string} userId
|
|
444
|
+
* @param {string} [xProximaNexusRequesterUserId] ID of the user getting groups of a user. If set, groups will be filtered to only include groups that the user can see, and requesterConnection will be set on the results.
|
|
393
445
|
* @param {*} [options] Override http request option.
|
|
394
446
|
* @throws {RequiredError}
|
|
395
447
|
*/
|
|
396
|
-
getGroups(userId: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<GroupEntityConnectionDto>>;
|
|
448
|
+
getGroups(userId: string, xProximaNexusRequesterUserId?: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<GroupEntityConnectionDto>>;
|
|
397
449
|
/**
|
|
398
|
-
*
|
|
399
|
-
* @summary
|
|
450
|
+
* Create a friend request, accept a pending request, or block a user. For FRIEND type: creates REQUESTED state if no connection exists; target user can accept by setting state to ACTIVE. For BLOCKED type: creates a mutual block.
|
|
451
|
+
* @summary Create or update a connection with another user
|
|
400
452
|
* @param {string} userId
|
|
453
|
+
* @param {string} targetUserId
|
|
454
|
+
* @param {string} xProximaNexusRequesterUserId ID of the user creating/modifying the connection (must match userId)
|
|
455
|
+
* @param {MutateUserConnectionDto} mutateUserConnectionDto
|
|
401
456
|
* @param {*} [options] Override http request option.
|
|
402
457
|
* @throws {RequiredError}
|
|
403
458
|
*/
|
|
404
|
-
|
|
459
|
+
putConnection(userId: string, targetUserId: string, xProximaNexusRequesterUserId: string, mutateUserConnectionDto: MutateUserConnectionDto, options?: RawAxiosRequestConfig): AxiosPromise<EntityConnectionDto>;
|
|
405
460
|
/**
|
|
406
461
|
*
|
|
407
|
-
* @summary
|
|
462
|
+
* @summary Delete a user
|
|
408
463
|
* @param {string} userId
|
|
409
|
-
* @param {string}
|
|
464
|
+
* @param {string} xProximaNexusRequesterUserId ID of the user deleting the user
|
|
410
465
|
* @param {*} [options] Override http request option.
|
|
411
466
|
* @throws {RequiredError}
|
|
412
467
|
*/
|
|
413
|
-
|
|
468
|
+
remove(userId: string, xProximaNexusRequesterUserId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
414
469
|
/**
|
|
415
|
-
*
|
|
470
|
+
* Search for users. When requesterUserId is provided, HIDDEN users are filtered out unless the requester is connected to them, and users who have blocked the requester are also filtered out. When requesterUserId is not provided, all users are returned without visibility filtering.
|
|
416
471
|
* @summary Search users
|
|
417
472
|
* @param {string} [displayName] Display name search (ILIKE)
|
|
418
473
|
* @param {number} [latitude] Latitude for radius search
|
|
@@ -423,19 +478,21 @@ export interface UserApiInterface {
|
|
|
423
478
|
* @param {number} [minLongitude] Minimum longitude for bounding box
|
|
424
479
|
* @param {number} [maxLongitude] Maximum longitude for bounding box
|
|
425
480
|
* @param {number} [limit] Limit results (1-1000)
|
|
481
|
+
* @param {string} [xProximaNexusRequesterUserId] ID of the user searching for users. If set, users will be filtered to only include users that the user can see, and requesterConnection will be set on the results.
|
|
426
482
|
* @param {*} [options] Override http request option.
|
|
427
483
|
* @throws {RequiredError}
|
|
428
484
|
*/
|
|
429
|
-
search(displayName?: string, latitude?: number, longitude?: number, radius?: number, minLatitude?: number, maxLatitude?: number, minLongitude?: number, maxLongitude?: number, limit?: number, options?: RawAxiosRequestConfig): AxiosPromise<Array<UserDto>>;
|
|
485
|
+
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<UserDto>>;
|
|
430
486
|
/**
|
|
431
487
|
*
|
|
432
488
|
* @summary Update a user
|
|
433
489
|
* @param {string} userId
|
|
490
|
+
* @param {string} xProximaNexusRequesterUserId ID of the user updating the user
|
|
434
491
|
* @param {UpdateUserDto} updateUserDto
|
|
435
492
|
* @param {*} [options] Override http request option.
|
|
436
493
|
* @throws {RequiredError}
|
|
437
494
|
*/
|
|
438
|
-
update(userId: string, updateUserDto: UpdateUserDto, options?: RawAxiosRequestConfig): AxiosPromise<MutateUserResponseDto>;
|
|
495
|
+
update(userId: string, xProximaNexusRequesterUserId: string, updateUserDto: UpdateUserDto, options?: RawAxiosRequestConfig): AxiosPromise<MutateUserResponseDto>;
|
|
439
496
|
}
|
|
440
497
|
/**
|
|
441
498
|
* UserApi - object-oriented interface
|
|
@@ -443,80 +500,92 @@ export interface UserApiInterface {
|
|
|
443
500
|
export declare class UserApi extends BaseAPI implements UserApiInterface {
|
|
444
501
|
/**
|
|
445
502
|
*
|
|
446
|
-
* @summary
|
|
447
|
-
* @param {
|
|
448
|
-
* @param {string} friendUserId
|
|
503
|
+
* @summary Create a user
|
|
504
|
+
* @param {CreateUserDto} createUserDto
|
|
449
505
|
* @param {*} [options] Override http request option.
|
|
450
506
|
* @throws {RequiredError}
|
|
451
507
|
*/
|
|
452
|
-
|
|
508
|
+
create(createUserDto: CreateUserDto, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MutateUserResponseDto, any, {}>>;
|
|
453
509
|
/**
|
|
454
|
-
*
|
|
455
|
-
* @summary
|
|
456
|
-
* @param {
|
|
510
|
+
* Remove a friend connection or unblock a user. For BLOCKED connections, only the user who initiated the block can unblock.
|
|
511
|
+
* @summary Delete a connection with another user
|
|
512
|
+
* @param {string} userId
|
|
513
|
+
* @param {string} targetUserId
|
|
514
|
+
* @param {UserControllerDeleteConnectionTypeEnum} type Type of connection to delete
|
|
515
|
+
* @param {string} xProximaNexusRequesterUserId ID of the user deleting the connection
|
|
457
516
|
* @param {*} [options] Override http request option.
|
|
458
517
|
* @throws {RequiredError}
|
|
459
518
|
*/
|
|
460
|
-
|
|
519
|
+
deleteConnection(userId: string, targetUserId: string, type: UserControllerDeleteConnectionTypeEnum, xProximaNexusRequesterUserId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
461
520
|
/**
|
|
462
521
|
*
|
|
463
522
|
* @summary Get a user by ID
|
|
464
523
|
* @param {string} userId
|
|
524
|
+
* @param {string} [xProximaNexusRequesterUserId] ID of the user getting a user by ID. If set, 401 may be returned if the user cannot view the user, otherwise requesterConnection will be set on the result.
|
|
465
525
|
* @param {*} [options] Override http request option.
|
|
466
526
|
* @throws {RequiredError}
|
|
467
527
|
*/
|
|
468
|
-
|
|
528
|
+
get(userId: string, xProximaNexusRequesterUserId?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<UserDto, any, {}>>;
|
|
469
529
|
/**
|
|
470
530
|
*
|
|
471
531
|
* @summary Get a batch of users by IDs
|
|
472
532
|
* @param {GetUsersDto} getUsersDto
|
|
533
|
+
* @param {string} [xProximaNexusRequesterUserId] ID of the user getting a batch of users. If set, users will be filtered to only include users that the user can see, and requesterConnection will be set on the results.
|
|
473
534
|
* @param {*} [options] Override http request option.
|
|
474
535
|
* @throws {RequiredError}
|
|
475
536
|
*/
|
|
476
|
-
getBatch(getUsersDto: GetUsersDto, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<UserDto[], any, {}>>;
|
|
537
|
+
getBatch(getUsersDto: GetUsersDto, xProximaNexusRequesterUserId?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<UserDto[], any, {}>>;
|
|
477
538
|
/**
|
|
478
|
-
*
|
|
479
|
-
* @summary Get
|
|
539
|
+
* Get user connections with optional type and state filters. Visibility rules apply: HIDDEN/CONNECTIONS users only show connections to self or connected users. Only the user themselves can see BLOCKED connections or non-ACTIVE states.
|
|
540
|
+
* @summary Get connections of a user
|
|
480
541
|
* @param {string} userId
|
|
542
|
+
* @param {Array<UserControllerGetConnectionsStateEnum>} [state] Filter connections by state. Can be multiple values. Non-self requesters can only see ACTIVE connections.
|
|
543
|
+
* @param {Array<UserControllerGetConnectionsTypeEnum>} [type] Filter connections by type. Can be multiple values.
|
|
544
|
+
* @param {string} [xProximaNexusRequesterUserId] ID of the user viewing connections. Required for non-PUBLIC users. Only the user themselves can view BLOCKED or non-ACTIVE connections.
|
|
481
545
|
* @param {*} [options] Override http request option.
|
|
482
546
|
* @throws {RequiredError}
|
|
483
547
|
*/
|
|
484
|
-
|
|
548
|
+
getConnections(userId: string, state?: Array<UserControllerGetConnectionsStateEnum>, type?: Array<UserControllerGetConnectionsTypeEnum>, xProximaNexusRequesterUserId?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<UserEntityConnectionDto[], any, {}>>;
|
|
485
549
|
/**
|
|
486
550
|
*
|
|
487
|
-
* @summary Get
|
|
551
|
+
* @summary Get events of a user
|
|
488
552
|
* @param {string} userId
|
|
553
|
+
* @param {string} [xProximaNexusRequesterUserId] ID of the user getting events of a user. If set, events will be filtered to only include events that the user can see, and requesterConnection will be set on the results.
|
|
489
554
|
* @param {*} [options] Override http request option.
|
|
490
555
|
* @throws {RequiredError}
|
|
491
556
|
*/
|
|
492
|
-
|
|
557
|
+
getEvents(userId: string, xProximaNexusRequesterUserId?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<EventEntityConnectionDto[], any, {}>>;
|
|
493
558
|
/**
|
|
494
559
|
*
|
|
495
560
|
* @summary Get groups of a user
|
|
496
561
|
* @param {string} userId
|
|
562
|
+
* @param {string} [xProximaNexusRequesterUserId] ID of the user getting groups of a user. If set, groups will be filtered to only include groups that the user can see, and requesterConnection will be set on the results.
|
|
497
563
|
* @param {*} [options] Override http request option.
|
|
498
564
|
* @throws {RequiredError}
|
|
499
565
|
*/
|
|
500
|
-
getGroups(userId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GroupEntityConnectionDto[], any, {}>>;
|
|
566
|
+
getGroups(userId: string, xProximaNexusRequesterUserId?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<GroupEntityConnectionDto[], any, {}>>;
|
|
501
567
|
/**
|
|
502
|
-
*
|
|
503
|
-
* @summary
|
|
568
|
+
* Create a friend request, accept a pending request, or block a user. For FRIEND type: creates REQUESTED state if no connection exists; target user can accept by setting state to ACTIVE. For BLOCKED type: creates a mutual block.
|
|
569
|
+
* @summary Create or update a connection with another user
|
|
504
570
|
* @param {string} userId
|
|
571
|
+
* @param {string} targetUserId
|
|
572
|
+
* @param {string} xProximaNexusRequesterUserId ID of the user creating/modifying the connection (must match userId)
|
|
573
|
+
* @param {MutateUserConnectionDto} mutateUserConnectionDto
|
|
505
574
|
* @param {*} [options] Override http request option.
|
|
506
575
|
* @throws {RequiredError}
|
|
507
576
|
*/
|
|
508
|
-
|
|
577
|
+
putConnection(userId: string, targetUserId: string, xProximaNexusRequesterUserId: string, mutateUserConnectionDto: MutateUserConnectionDto, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<EntityConnectionDto, any, {}>>;
|
|
509
578
|
/**
|
|
510
579
|
*
|
|
511
|
-
* @summary
|
|
580
|
+
* @summary Delete a user
|
|
512
581
|
* @param {string} userId
|
|
513
|
-
* @param {string}
|
|
582
|
+
* @param {string} xProximaNexusRequesterUserId ID of the user deleting the user
|
|
514
583
|
* @param {*} [options] Override http request option.
|
|
515
584
|
* @throws {RequiredError}
|
|
516
585
|
*/
|
|
517
|
-
|
|
586
|
+
remove(userId: string, xProximaNexusRequesterUserId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
518
587
|
/**
|
|
519
|
-
*
|
|
588
|
+
* Search for users. When requesterUserId is provided, HIDDEN users are filtered out unless the requester is connected to them, and users who have blocked the requester are also filtered out. When requesterUserId is not provided, all users are returned without visibility filtering.
|
|
520
589
|
* @summary Search users
|
|
521
590
|
* @param {string} [displayName] Display name search (ILIKE)
|
|
522
591
|
* @param {number} [latitude] Latitude for radius search
|
|
@@ -527,17 +596,33 @@ export declare class UserApi extends BaseAPI implements UserApiInterface {
|
|
|
527
596
|
* @param {number} [minLongitude] Minimum longitude for bounding box
|
|
528
597
|
* @param {number} [maxLongitude] Maximum longitude for bounding box
|
|
529
598
|
* @param {number} [limit] Limit results (1-1000)
|
|
599
|
+
* @param {string} [xProximaNexusRequesterUserId] ID of the user searching for users. If set, users will be filtered to only include users that the user can see, and requesterConnection will be set on the results.
|
|
530
600
|
* @param {*} [options] Override http request option.
|
|
531
601
|
* @throws {RequiredError}
|
|
532
602
|
*/
|
|
533
|
-
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<UserDto[], any, {}>>;
|
|
603
|
+
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<UserDto[], any, {}>>;
|
|
534
604
|
/**
|
|
535
605
|
*
|
|
536
606
|
* @summary Update a user
|
|
537
607
|
* @param {string} userId
|
|
608
|
+
* @param {string} xProximaNexusRequesterUserId ID of the user updating the user
|
|
538
609
|
* @param {UpdateUserDto} updateUserDto
|
|
539
610
|
* @param {*} [options] Override http request option.
|
|
540
611
|
* @throws {RequiredError}
|
|
541
612
|
*/
|
|
542
|
-
update(userId: string, updateUserDto: UpdateUserDto, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MutateUserResponseDto, any, {}>>;
|
|
613
|
+
update(userId: string, xProximaNexusRequesterUserId: string, updateUserDto: UpdateUserDto, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MutateUserResponseDto, any, {}>>;
|
|
614
|
+
}
|
|
615
|
+
export declare enum UserControllerDeleteConnectionTypeEnum {
|
|
616
|
+
friend = "friend",
|
|
617
|
+
blocked = "blocked"
|
|
618
|
+
}
|
|
619
|
+
export declare enum UserControllerGetConnectionsStateEnum {
|
|
620
|
+
requested = "requested",
|
|
621
|
+
active = "active",
|
|
622
|
+
rejected = "rejected",
|
|
623
|
+
blocked = "blocked"
|
|
624
|
+
}
|
|
625
|
+
export declare enum UserControllerGetConnectionsTypeEnum {
|
|
626
|
+
friend = "friend",
|
|
627
|
+
blocked = "blocked"
|
|
543
628
|
}
|