-
Notifications
You must be signed in to change notification settings - Fork 181
/
user.ts
204 lines (175 loc) · 6.34 KB
/
user.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
import { AuthenticationType, Client } from '@vonage/server-client';
import {
UserListParameters,
UserPageResponse,
UserResponse,
UserType,
WebSocketChannelRequest,
WebSocketChannelResponse,
WebsocketChannel,
} from './types';
const apiUserToUser = (apiUser: UserResponse): UserType => {
delete apiUser._links;
const user = Client.transformers.camelCaseObjectKeys(
apiUser,
true,
) as UserType;
if (user.properties) {
user.properties.customData = apiUser.properties.custom_data;
}
if (user.channels?.websocket) {
user.channels.websocket = apiUser.channels.websocket.map(
(apiSocket: WebSocketChannelResponse): WebsocketChannel => {
const socket = {
uri: apiSocket.uri,
} as WebsocketChannel;
if (apiSocket['content-type']) {
socket.contentType = apiSocket['content-type'];
}
if (apiSocket.headers) {
socket.headers = apiSocket.headers;
}
return socket;
},
);
}
return user as UserType;
};
const userToAPI = (user: UserType): UserResponse => {
const apiUser = Client.transformers.snakeCaseObjectKeys(
user,
true,
) as UserResponse;
// preserve user properties
if (user.properties?.customData) {
apiUser.properties.custom_data = user.properties.customData;
}
// Websockets will change when transformed
if (user.channels?.websocket) {
apiUser.channels.websocket = user.channels.websocket?.map(
(socket: WebsocketChannel): WebSocketChannelRequest => {
const apiSocket = {
uri: socket.uri,
} as WebSocketChannelRequest;
// restore content type
if (socket.contentType) {
apiSocket['content-type'] = socket.contentType;
}
// preserve headers
if (socket.headers) {
apiSocket.headers = socket.headers;
}
return apiSocket;
},
);
}
delete apiUser.id;
return apiUser as UserResponse;
};
/**
* The `Users` class provides methods for managing user data through API requests.
*
* Vonage API responses and requests use `snake_case` for property names, but
* this class performs the necessary key transformations to work with
* `camelCase` property names in your application.
*/
export class Users extends Client {
protected authType = AuthenticationType.JWT;
/**
* Retrieves a list of users, optionally paginated, based on the provided parameters.
*
* @param {UserListParameters} params - Optional parameters to filter and paginate the list of users.
* @return {AsyncGenerator<UserType, void, undefined>} An async generator that yields user objects.
*/
async *listAllUsers(
params: UserListParameters = {},
): AsyncGenerator<UserType, void & UserType, undefined> {
let cursor = params.cursor;
do {
if (cursor) {
params.cursor = cursor;
}
const resp = await this.getUserPage(params);
yield* resp._embedded?.users.map(apiUserToUser);
const next = resp._links?.next?.href
? new URL(resp._links.next.href)
: null;
cursor = next ? `${next.searchParams.get('cursor')}` : undefined;
} while (cursor);
}
/**
* Retrieves a page of users based on the provided parameters, such as pagination and filtering.
*
* @param {UserListParameters} [params={}] - Optional parameters to filter and paginate the list of users.
* @param {number} [params.pageSize] - The number of users to include per page.
* @param {SortOrder} [params.order] - The sorting order for the list (ASC or DESC).
* @param {string} [params.cursor] - A cursor for paginating through the user list.
* @param {string} [params.name] - A name to filter users by.
*
* @return {Promise<UserPageResponse>} A Promise that resolves to a UserPageResponse object containing the user page data.
*
* @throws {Error} If there is an issue with the request or response.
*/
async getUserPage(
params: UserListParameters = {},
): Promise<UserPageResponse> {
const resp = await this.sendGetRequest<UserPageResponse>(
`${this.config.apiHost}/v1/users`,
Client.transformers.snakeCaseObjectKeys(params, true),
);
return resp.data;
}
/**
* Creates a new user with the provided user data.
*
* @param {UserType} user - The user data to create a new user.
* @return {Promise<UserType>} A Promise that resolves to the newly created user.
* @throws {Error} If there is an issue with the request or response.
*/
async createUser(user: UserType): Promise<UserType> {
const resp = await this.sendPostRequest<UserResponse>(
`${this.config.apiHost}/v1/users`,
userToAPI(user),
);
return apiUserToUser(resp.data);
}
/**
* Retrieves user information for the specified user ID.
*
* @param {string} userId - The unique identifier of the user to retrieve.
* @return {Promise<UserType>} A Promise that resolves to the user information for the specified user ID.
* @throws {Error} If there is an issue with the request or response, or if the user with the specified ID is not found.
*/
async getUser(userId: string): Promise<UserType> {
const resp = await this.sendGetRequest<UserResponse>(
`${this.config.apiHost}/v1/users/${userId}`,
);
return apiUserToUser(resp.data);
}
/**
* Updates the user information for the specified user.
*
* @param {UserType} user - The user object containing the updated information.
* @return {Promise<UserType>} A Promise that resolves to the updated user information.
* @throws {Error} If there is an issue with the request or response, or if the user with the specified ID is not found.
*/
async updateUser(user: UserType): Promise<UserType> {
const resp = await this.sendPutRequest<UserResponse>(
`${this.config.apiHost}/v1/users/${user.id}`,
userToAPI(user),
);
return apiUserToUser(resp.data);
}
/**
* Deletes the user with the specified user ID.
*
* @param {string} userId - The unique ID of the user to be deleted.
* @return {Promise<void>} A Promise that resolves once the user is successfully deleted.
* @throws {Error} If there is an issue with the request or response, or if the user with the specified ID is not found.
*/
async deleteUser(userId: string): Promise<void> {
await this.sendDeleteRequest<UserResponse>(
`${this.config.apiHost}/v1/users/${userId}`,
);
}
}