@zyphr-dev/node-sdk 0.1.42 → 0.1.43

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 (53) hide show
  1. package/dist/index.cjs +1763 -321
  2. package/dist/index.cjs.map +1 -1
  3. package/dist/index.d.cts +2122 -643
  4. package/dist/index.d.ts +2122 -643
  5. package/dist/index.js +1582 -316
  6. package/dist/index.js.map +1 -1
  7. package/package.json +1 -1
  8. package/src/.openapi-generator/FILES +35 -1
  9. package/src/src/apis/AuthUserDirectoryApi.ts +54 -36
  10. package/src/src/apis/DomainsApi.ts +7 -6
  11. package/src/src/apis/InboxApi.ts +78 -54
  12. package/src/src/apis/TemplatesApi.ts +10 -6
  13. package/src/src/apis/WaaSDeliveriesApi.ts +17 -12
  14. package/src/src/apis/WaaSEndpointsApi.ts +50 -30
  15. package/src/src/apis/WaaSEventTypesApi.ts +17 -12
  16. package/src/src/models/CloseWaaSEndpointCircuit200Response.ts +88 -0
  17. package/src/src/models/CloseWaaSEndpointCircuit200ResponseData.ts +76 -0
  18. package/src/src/models/GetEndUserById200Response.ts +88 -0
  19. package/src/src/models/GetEndUserClaims200Response.ts +88 -0
  20. package/src/src/models/GetEndUserClaims200ResponseData.ts +65 -0
  21. package/src/src/models/GetSubscriberInboxPreferences200Response.ts +73 -0
  22. package/src/src/models/GetSubscriberInboxPreferences200ResponseData.ts +88 -0
  23. package/src/src/models/GetSubscriberInboxPreferences200ResponseDataCategoriesInner.ts +88 -0
  24. package/src/src/models/GetSubscriberInboxPreferences200ResponseDataCategoriesInnerCategory.ts +97 -0
  25. package/src/src/models/GetSubscriberInboxPreferences200ResponseDataGlobal.ts +73 -0
  26. package/src/src/models/GetSubscriberInboxPreferences200ResponseDataGlobalChannelsInner.ts +94 -0
  27. package/src/src/models/GetSubscriberNotification200Response.ts +73 -0
  28. package/src/src/models/GetSubscriberUnreadCount200Response.ts +73 -0
  29. package/src/src/models/GetWaaSDelivery200Response.ts +88 -0
  30. package/src/src/models/GetWaaSEndpointCircuit200Response.ts +88 -0
  31. package/src/src/models/GetWaaSEndpointCircuit200ResponseData.ts +123 -0
  32. package/src/src/models/GetWaaSEndpointMetrics200Response.ts +88 -0
  33. package/src/src/models/GetWaaSEndpointMetrics200ResponseData.ts +99 -0
  34. package/src/src/models/GetWaaSEndpointMetrics200ResponseDataHealth.ts +87 -0
  35. package/src/src/models/GetWaaSEndpointMetrics200ResponseDataWindowsValue.ts +126 -0
  36. package/src/src/models/InviteEndUser200Response.ts +88 -0
  37. package/src/src/models/InviteEndUser200ResponseData.ts +81 -0
  38. package/src/src/models/ListEndUsers200Response.ts +88 -0
  39. package/src/src/models/{ListWorkflowExecutions200ResponseMeta.ts → ListEndUsers200ResponseMeta.ts} +15 -15
  40. package/src/src/models/ListWorkflowExecutions200Response.ts +11 -11
  41. package/src/src/models/MarkAllSubscriberNotificationsRead200Response.ts +73 -0
  42. package/src/src/models/RotateWaaSEndpointSecret200Response.ts +88 -0
  43. package/src/src/models/RotateWaaSEndpointSecret200ResponseData.ts +66 -0
  44. package/src/src/models/SendTemplateTestEmail202Response.ts +90 -0
  45. package/src/src/models/SendTemplateTestEmail202ResponseData.ts +120 -0
  46. package/src/src/models/SendTemplateTestEmail202ResponseMeta.ts +66 -0
  47. package/src/src/models/SmsListResponse.ts +10 -10
  48. package/src/src/models/UpdateSubscriberPreferences200Response.ts +73 -0
  49. package/src/src/models/UpdateSubscriberPreferences200ResponseData.ts +81 -0
  50. package/src/src/models/UpdateSubscriberPreferences200ResponseDataPreferencesInner.ts +102 -0
  51. package/src/src/models/UpdateWaaSEndpoint200Response.ts +88 -0
  52. package/src/src/models/UpdateWaaSEventType200Response.ts +88 -0
  53. package/src/src/models/index.ts +35 -1
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@zyphr-dev/node-sdk",
3
- "version": "0.1.42",
3
+ "version": "0.1.43",
4
4
  "description": "Official Zyphr SDK for Node.js, React, and React Native",
5
5
  "type": "module",
6
6
  "main": "./dist/index.cjs",
@@ -85,6 +85,8 @@ src/models/BulkUpsertAuthEmailTemplatesResponse.ts
85
85
  src/models/Category.ts
86
86
  src/models/CategoryListResponse.ts
87
87
  src/models/CategoryResponse.ts
88
+ src/models/CloseWaaSEndpointCircuit200Response.ts
89
+ src/models/CloseWaaSEndpointCircuit200ResponseData.ts
88
90
  src/models/ConfirmEmailVerificationRequest.ts
89
91
  src/models/ConfirmEmailVerificationResponse.ts
90
92
  src/models/ConfirmEmailVerificationResponseData.ts
@@ -161,7 +163,25 @@ src/models/GenerateSubscriberTokenRequest.ts
161
163
  src/models/GenerateWaaSPortalToken201Response.ts
162
164
  src/models/GetDomain200Response.ts
163
165
  src/models/GetDomain200ResponseMeta.ts
166
+ src/models/GetEndUserById200Response.ts
167
+ src/models/GetEndUserClaims200Response.ts
168
+ src/models/GetEndUserClaims200ResponseData.ts
169
+ src/models/GetSubscriberInboxPreferences200Response.ts
170
+ src/models/GetSubscriberInboxPreferences200ResponseData.ts
171
+ src/models/GetSubscriberInboxPreferences200ResponseDataCategoriesInner.ts
172
+ src/models/GetSubscriberInboxPreferences200ResponseDataCategoriesInnerCategory.ts
173
+ src/models/GetSubscriberInboxPreferences200ResponseDataGlobal.ts
174
+ src/models/GetSubscriberInboxPreferences200ResponseDataGlobalChannelsInner.ts
175
+ src/models/GetSubscriberNotification200Response.ts
176
+ src/models/GetSubscriberUnreadCount200Response.ts
177
+ src/models/GetWaaSDelivery200Response.ts
164
178
  src/models/GetWaaSEndpoint200Response.ts
179
+ src/models/GetWaaSEndpointCircuit200Response.ts
180
+ src/models/GetWaaSEndpointCircuit200ResponseData.ts
181
+ src/models/GetWaaSEndpointMetrics200Response.ts
182
+ src/models/GetWaaSEndpointMetrics200ResponseData.ts
183
+ src/models/GetWaaSEndpointMetrics200ResponseDataHealth.ts
184
+ src/models/GetWaaSEndpointMetrics200ResponseDataWindowsValue.ts
165
185
  src/models/GetWaaSUsage200Response.ts
166
186
  src/models/InAppNotification.ts
167
187
  src/models/InboundAttachmentUrlResponse.ts
@@ -175,13 +195,16 @@ src/models/InboundEmailResponse.ts
175
195
  src/models/InboxListMeta.ts
176
196
  src/models/InboxListResponse.ts
177
197
  src/models/InboxNotificationResponse.ts
198
+ src/models/InviteEndUser200Response.ts
199
+ src/models/InviteEndUser200ResponseData.ts
178
200
  src/models/InviteEndUserRequest.ts
201
+ src/models/ListEndUsers200Response.ts
202
+ src/models/ListEndUsers200ResponseMeta.ts
179
203
  src/models/ListWaaSApplications200Response.ts
180
204
  src/models/ListWaaSEndpointDeliveries200Response.ts
181
205
  src/models/ListWaaSEndpoints200Response.ts
182
206
  src/models/ListWaaSEventTypes200Response.ts
183
207
  src/models/ListWorkflowExecutions200Response.ts
184
- src/models/ListWorkflowExecutions200ResponseMeta.ts
185
208
  src/models/ListWorkflows200Response.ts
186
209
  src/models/ListWorkflows200ResponseMeta.ts
187
210
  src/models/LoginRequest.ts
@@ -192,6 +215,7 @@ src/models/MagicLinkVerifyResponseData.ts
192
215
  src/models/MarkAllInboxReadRequest.ts
193
216
  src/models/MarkAllReadData.ts
194
217
  src/models/MarkAllReadResponse.ts
218
+ src/models/MarkAllSubscriberNotificationsRead200Response.ts
195
219
  src/models/MarkAllSubscriberNotificationsReadRequest.ts
196
220
  src/models/MarkInboxReadRequest.ts
197
221
  src/models/MfaBackupCodesResponse.ts
@@ -288,6 +312,8 @@ src/models/ResubscribeResponse.ts
288
312
  src/models/RevokeAllSessionsResponse.ts
289
313
  src/models/RevokeAllSessionsResponseData.ts
290
314
  src/models/RevokeSessionRequest.ts
315
+ src/models/RotateWaaSEndpointSecret200Response.ts
316
+ src/models/RotateWaaSEndpointSecret200ResponseData.ts
291
317
  src/models/SendBatchEmailRequest.ts
292
318
  src/models/SendBatchEmailResponse.ts
293
319
  src/models/SendBatchEmailResult.ts
@@ -320,6 +346,9 @@ src/models/SendSlackMessageResult.ts
320
346
  src/models/SendSmsData.ts
321
347
  src/models/SendSmsRequest.ts
322
348
  src/models/SendSmsResponse.ts
349
+ src/models/SendTemplateTestEmail202Response.ts
350
+ src/models/SendTemplateTestEmail202ResponseData.ts
351
+ src/models/SendTemplateTestEmail202ResponseMeta.ts
323
352
  src/models/SendTemplateTestEmailRequest.ts
324
353
  src/models/SendTestSmsData.ts
325
354
  src/models/SendTestSmsRequest.ts
@@ -397,13 +426,18 @@ src/models/UpdateEndUserByApplicationRequest.ts
397
426
  src/models/UpdateEndUserRequest.ts
398
427
  src/models/UpdateOrganizationMemberRoleRequest.ts
399
428
  src/models/UpdateOrganizationRequest.ts
429
+ src/models/UpdateSubscriberPreferences200Response.ts
430
+ src/models/UpdateSubscriberPreferences200ResponseData.ts
431
+ src/models/UpdateSubscriberPreferences200ResponseDataPreferencesInner.ts
400
432
  src/models/UpdateSubscriberPreferencesRequest.ts
401
433
  src/models/UpdateSubscriberPreferencesRequestPreferencesInner.ts
402
434
  src/models/UpdateSubscriberRequest.ts
403
435
  src/models/UpdateTemplateRequest.ts
404
436
  src/models/UpdateTopicRequest.ts
405
437
  src/models/UpdateWaaSApplicationRequest.ts
438
+ src/models/UpdateWaaSEndpoint200Response.ts
406
439
  src/models/UpdateWaaSEndpointRequest.ts
440
+ src/models/UpdateWaaSEventType200Response.ts
407
441
  src/models/UpdateWaaSEventTypeRequest.ts
408
442
  src/models/UpdateWebhookRequest.ts
409
443
  src/models/UpdateWorkflowRequest.ts
@@ -15,14 +15,26 @@
15
15
 
16
16
  import * as runtime from '../runtime';
17
17
  import type {
18
+ GetEndUserById200Response,
19
+ GetEndUserClaims200Response,
20
+ InviteEndUser200Response,
18
21
  InviteEndUserRequest,
22
+ ListEndUsers200Response,
19
23
  SetEndUserClaims200Response,
20
24
  SetEndUserClaimsRequest,
21
25
  UpdateEndUserByApplicationRequest,
22
26
  } from '../models/index';
23
27
  import {
28
+ GetEndUserById200ResponseFromJSON,
29
+ GetEndUserById200ResponseToJSON,
30
+ GetEndUserClaims200ResponseFromJSON,
31
+ GetEndUserClaims200ResponseToJSON,
32
+ InviteEndUser200ResponseFromJSON,
33
+ InviteEndUser200ResponseToJSON,
24
34
  InviteEndUserRequestFromJSON,
25
35
  InviteEndUserRequestToJSON,
36
+ ListEndUsers200ResponseFromJSON,
37
+ ListEndUsers200ResponseToJSON,
26
38
  SetEndUserClaims200ResponseFromJSON,
27
39
  SetEndUserClaims200ResponseToJSON,
28
40
  SetEndUserClaimsRequestFromJSON,
@@ -99,13 +111,13 @@ export interface AuthUserDirectoryApiInterface {
99
111
  * @throws {RequiredError}
100
112
  * @memberof AuthUserDirectoryApiInterface
101
113
  */
102
- getEndUserByEmailRaw(requestParameters: AuthUserDirectoryApiGetEndUserByEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
114
+ getEndUserByEmailRaw(requestParameters: AuthUserDirectoryApiGetEndUserByEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetEndUserById200Response>>;
103
115
 
104
116
  /**
105
117
  * Secret-key-scoped lookup of a single end user by email address within the authenticating application. Scoped to the application — never resolves a user from another application. Does not return the password hash.
106
118
  * Look up an end user by email (server-side admin)
107
119
  */
108
- getEndUserByEmail(email: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
120
+ getEndUserByEmail(email: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetEndUserById200Response>;
109
121
 
110
122
  /**
111
123
  * Secret-key-scoped fetch of a single end user by id within the authenticating application. Scoped to the application — a caller can never read a user belonging to another application.
@@ -115,13 +127,13 @@ export interface AuthUserDirectoryApiInterface {
115
127
  * @throws {RequiredError}
116
128
  * @memberof AuthUserDirectoryApiInterface
117
129
  */
118
- getEndUserByIdRaw(requestParameters: AuthUserDirectoryApiGetEndUserByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
130
+ getEndUserByIdRaw(requestParameters: AuthUserDirectoryApiGetEndUserByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetEndUserById200Response>>;
119
131
 
120
132
  /**
121
133
  * Secret-key-scoped fetch of a single end user by id within the authenticating application. Scoped to the application — a caller can never read a user belonging to another application.
122
134
  * Get an end user by id (server-side admin)
123
135
  */
124
- getEndUserById(userId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
136
+ getEndUserById(userId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetEndUserById200Response>;
125
137
 
126
138
  /**
127
139
  * Secret-key-scoped read of the authoritative custom_claims stored for an end user. These are the TRUSTED claims embedded into the user\'s JWTs on login/refresh — use them (not the client-writable `metadata` field) for authorization decisions. Returns an empty object when none are set.
@@ -131,13 +143,13 @@ export interface AuthUserDirectoryApiInterface {
131
143
  * @throws {RequiredError}
132
144
  * @memberof AuthUserDirectoryApiInterface
133
145
  */
134
- getEndUserClaimsRaw(requestParameters: AuthUserDirectoryApiGetEndUserClaimsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
146
+ getEndUserClaimsRaw(requestParameters: AuthUserDirectoryApiGetEndUserClaimsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetEndUserClaims200Response>>;
135
147
 
136
148
  /**
137
149
  * Secret-key-scoped read of the authoritative custom_claims stored for an end user. These are the TRUSTED claims embedded into the user\'s JWTs on login/refresh — use them (not the client-writable `metadata` field) for authorization decisions. Returns an empty object when none are set.
138
150
  * Get an end user\'s stored custom claims (server-side admin)
139
151
  */
140
- getEndUserClaims(userId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
152
+ getEndUserClaims(userId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetEndUserClaims200Response>;
141
153
 
142
154
  /**
143
155
  * Secret-key-scoped pre-provisioning for an end user. Creates a passwordless user in the authenticating application (idempotent on email — an existing, non-deleted user is reused, not duplicated) and, when `send_link` is set, sends a first-login link so the user can set up their account without self-registration. - `send_link: \"magic\"` sends a magic-link sign-in email. - `send_link: \"password_reset\"` sends a set-password email. - `send_link: \"none\"` (default) creates the user with no email. A `redirect_url` is required when `send_link` is \"magic\" or \"password_reset\"; it must match the application\'s redirect_uris allowlist (custom schemes such as yourapp://path are permitted).
@@ -147,13 +159,13 @@ export interface AuthUserDirectoryApiInterface {
147
159
  * @throws {RequiredError}
148
160
  * @memberof AuthUserDirectoryApiInterface
149
161
  */
150
- inviteEndUserRaw(requestParameters: AuthUserDirectoryApiInviteEndUserOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
162
+ inviteEndUserRaw(requestParameters: AuthUserDirectoryApiInviteEndUserOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<InviteEndUser200Response>>;
151
163
 
152
164
  /**
153
165
  * Secret-key-scoped pre-provisioning for an end user. Creates a passwordless user in the authenticating application (idempotent on email — an existing, non-deleted user is reused, not duplicated) and, when `send_link` is set, sends a first-login link so the user can set up their account without self-registration. - `send_link: \"magic\"` sends a magic-link sign-in email. - `send_link: \"password_reset\"` sends a set-password email. - `send_link: \"none\"` (default) creates the user with no email. A `redirect_url` is required when `send_link` is \"magic\" or \"password_reset\"; it must match the application\'s redirect_uris allowlist (custom schemes such as yourapp://path are permitted).
154
166
  * Pre-provision (invite) an end user (server-side admin)
155
167
  */
156
- inviteEndUser(inviteEndUserRequest: InviteEndUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
168
+ inviteEndUser(inviteEndUserRequest: InviteEndUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<InviteEndUser200Response>;
157
169
 
158
170
  /**
159
171
  * Secret-key-scoped directory listing of end users in the authenticating application. Supports substring search over email, name, and phone, an optional environment filter (test/live), and pagination. Scoped to the application — never returns users from another application.
@@ -166,13 +178,13 @@ export interface AuthUserDirectoryApiInterface {
166
178
  * @throws {RequiredError}
167
179
  * @memberof AuthUserDirectoryApiInterface
168
180
  */
169
- listEndUsersRaw(requestParameters: AuthUserDirectoryApiListEndUsersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
181
+ listEndUsersRaw(requestParameters: AuthUserDirectoryApiListEndUsersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListEndUsers200Response>>;
170
182
 
171
183
  /**
172
184
  * Secret-key-scoped directory listing of end users in the authenticating application. Supports substring search over email, name, and phone, an optional environment filter (test/live), and pagination. Scoped to the application — never returns users from another application.
173
185
  * List / search end users (server-side admin)
174
186
  */
175
- listEndUsers(page?: number, perPage?: number, search?: string, environment?: ListEndUsersEnvironmentEnum, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
187
+ listEndUsers(page?: number, perPage?: number, search?: string, environment?: ListEndUsersEnvironmentEnum, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListEndUsers200Response>;
176
188
 
177
189
  /**
178
190
  * Secret-key-scoped upsert of the authoritative custom_claims for an end user. Set server-side only — clients cannot write these, which is what makes them safe for authorization (e.g. an account-type/admin flag). Claims are embedded into the user\'s JWTs on the next login/refresh. Max 4KB; reserved JWT/Zyphr claim names are rejected. Each write bumps a monotonic `claims_version` (returned in the response). The change applies seamlessly on the user\'s next login or token refresh — a token carrying an older `claims_version` is rejected on verification and the client silently re-mints with the new claims, without a forced logout. For a hard cut-off (log the user out of all sessions immediately), call POST /auth/sessions/revoke-all after updating claims.
@@ -200,13 +212,13 @@ export interface AuthUserDirectoryApiInterface {
200
212
  * @throws {RequiredError}
201
213
  * @memberof AuthUserDirectoryApiInterface
202
214
  */
203
- updateEndUserByApplicationRaw(requestParameters: AuthUserDirectoryApiUpdateEndUserByApplicationOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
215
+ updateEndUserByApplicationRaw(requestParameters: AuthUserDirectoryApiUpdateEndUserByApplicationOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetEndUserById200Response>>;
204
216
 
205
217
  /**
206
218
  * Secret-key-scoped update of an arbitrary end user in the authenticating application. Updatable fields: email, name, avatar_url, metadata, status. Scoped to the application — a caller can never modify a user belonging to another application.
207
219
  * Update an end user (server-side admin)
208
220
  */
209
- updateEndUserByApplication(userId: string, updateEndUserByApplicationRequest: UpdateEndUserByApplicationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
221
+ updateEndUserByApplication(userId: string, updateEndUserByApplicationRequest: UpdateEndUserByApplicationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetEndUserById200Response>;
210
222
 
211
223
  }
212
224
 
@@ -261,7 +273,7 @@ export class AuthUserDirectoryApi extends runtime.BaseAPI implements AuthUserDir
261
273
  * Secret-key-scoped lookup of a single end user by email address within the authenticating application. Scoped to the application — never resolves a user from another application. Does not return the password hash.
262
274
  * Look up an end user by email (server-side admin)
263
275
  */
264
- async getEndUserByEmailRaw(requestParameters: AuthUserDirectoryApiGetEndUserByEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
276
+ async getEndUserByEmailRaw(requestParameters: AuthUserDirectoryApiGetEndUserByEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetEndUserById200Response>> {
265
277
  if (requestParameters['email'] == null) {
266
278
  throw new runtime.RequiredError(
267
279
  'email',
@@ -292,22 +304,23 @@ export class AuthUserDirectoryApi extends runtime.BaseAPI implements AuthUserDir
292
304
  query: queryParameters,
293
305
  }, initOverrides);
294
306
 
295
- return new runtime.VoidApiResponse(response);
307
+ return new runtime.JSONApiResponse(response, (jsonValue) => GetEndUserById200ResponseFromJSON(jsonValue));
296
308
  }
297
309
 
298
310
  /**
299
311
  * Secret-key-scoped lookup of a single end user by email address within the authenticating application. Scoped to the application — never resolves a user from another application. Does not return the password hash.
300
312
  * Look up an end user by email (server-side admin)
301
313
  */
302
- async getEndUserByEmail(email: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
303
- await this.getEndUserByEmailRaw({ email: email }, initOverrides);
314
+ async getEndUserByEmail(email: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetEndUserById200Response> {
315
+ const response = await this.getEndUserByEmailRaw({ email: email }, initOverrides);
316
+ return await response.value();
304
317
  }
305
318
 
306
319
  /**
307
320
  * Secret-key-scoped fetch of a single end user by id within the authenticating application. Scoped to the application — a caller can never read a user belonging to another application.
308
321
  * Get an end user by id (server-side admin)
309
322
  */
310
- async getEndUserByIdRaw(requestParameters: AuthUserDirectoryApiGetEndUserByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
323
+ async getEndUserByIdRaw(requestParameters: AuthUserDirectoryApiGetEndUserByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetEndUserById200Response>> {
311
324
  if (requestParameters['userId'] == null) {
312
325
  throw new runtime.RequiredError(
313
326
  'userId',
@@ -334,22 +347,23 @@ export class AuthUserDirectoryApi extends runtime.BaseAPI implements AuthUserDir
334
347
  query: queryParameters,
335
348
  }, initOverrides);
336
349
 
337
- return new runtime.VoidApiResponse(response);
350
+ return new runtime.JSONApiResponse(response, (jsonValue) => GetEndUserById200ResponseFromJSON(jsonValue));
338
351
  }
339
352
 
340
353
  /**
341
354
  * Secret-key-scoped fetch of a single end user by id within the authenticating application. Scoped to the application — a caller can never read a user belonging to another application.
342
355
  * Get an end user by id (server-side admin)
343
356
  */
344
- async getEndUserById(userId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
345
- await this.getEndUserByIdRaw({ userId: userId }, initOverrides);
357
+ async getEndUserById(userId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetEndUserById200Response> {
358
+ const response = await this.getEndUserByIdRaw({ userId: userId }, initOverrides);
359
+ return await response.value();
346
360
  }
347
361
 
348
362
  /**
349
363
  * Secret-key-scoped read of the authoritative custom_claims stored for an end user. These are the TRUSTED claims embedded into the user\'s JWTs on login/refresh — use them (not the client-writable `metadata` field) for authorization decisions. Returns an empty object when none are set.
350
364
  * Get an end user\'s stored custom claims (server-side admin)
351
365
  */
352
- async getEndUserClaimsRaw(requestParameters: AuthUserDirectoryApiGetEndUserClaimsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
366
+ async getEndUserClaimsRaw(requestParameters: AuthUserDirectoryApiGetEndUserClaimsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetEndUserClaims200Response>> {
353
367
  if (requestParameters['userId'] == null) {
354
368
  throw new runtime.RequiredError(
355
369
  'userId',
@@ -376,22 +390,23 @@ export class AuthUserDirectoryApi extends runtime.BaseAPI implements AuthUserDir
376
390
  query: queryParameters,
377
391
  }, initOverrides);
378
392
 
379
- return new runtime.VoidApiResponse(response);
393
+ return new runtime.JSONApiResponse(response, (jsonValue) => GetEndUserClaims200ResponseFromJSON(jsonValue));
380
394
  }
381
395
 
382
396
  /**
383
397
  * Secret-key-scoped read of the authoritative custom_claims stored for an end user. These are the TRUSTED claims embedded into the user\'s JWTs on login/refresh — use them (not the client-writable `metadata` field) for authorization decisions. Returns an empty object when none are set.
384
398
  * Get an end user\'s stored custom claims (server-side admin)
385
399
  */
386
- async getEndUserClaims(userId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
387
- await this.getEndUserClaimsRaw({ userId: userId }, initOverrides);
400
+ async getEndUserClaims(userId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetEndUserClaims200Response> {
401
+ const response = await this.getEndUserClaimsRaw({ userId: userId }, initOverrides);
402
+ return await response.value();
388
403
  }
389
404
 
390
405
  /**
391
406
  * Secret-key-scoped pre-provisioning for an end user. Creates a passwordless user in the authenticating application (idempotent on email — an existing, non-deleted user is reused, not duplicated) and, when `send_link` is set, sends a first-login link so the user can set up their account without self-registration. - `send_link: \"magic\"` sends a magic-link sign-in email. - `send_link: \"password_reset\"` sends a set-password email. - `send_link: \"none\"` (default) creates the user with no email. A `redirect_url` is required when `send_link` is \"magic\" or \"password_reset\"; it must match the application\'s redirect_uris allowlist (custom schemes such as yourapp://path are permitted).
392
407
  * Pre-provision (invite) an end user (server-side admin)
393
408
  */
394
- async inviteEndUserRaw(requestParameters: AuthUserDirectoryApiInviteEndUserOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
409
+ async inviteEndUserRaw(requestParameters: AuthUserDirectoryApiInviteEndUserOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<InviteEndUser200Response>> {
395
410
  if (requestParameters['inviteEndUserRequest'] == null) {
396
411
  throw new runtime.RequiredError(
397
412
  'inviteEndUserRequest',
@@ -421,22 +436,23 @@ export class AuthUserDirectoryApi extends runtime.BaseAPI implements AuthUserDir
421
436
  body: InviteEndUserRequestToJSON(requestParameters['inviteEndUserRequest']),
422
437
  }, initOverrides);
423
438
 
424
- return new runtime.VoidApiResponse(response);
439
+ return new runtime.JSONApiResponse(response, (jsonValue) => InviteEndUser200ResponseFromJSON(jsonValue));
425
440
  }
426
441
 
427
442
  /**
428
443
  * Secret-key-scoped pre-provisioning for an end user. Creates a passwordless user in the authenticating application (idempotent on email — an existing, non-deleted user is reused, not duplicated) and, when `send_link` is set, sends a first-login link so the user can set up their account without self-registration. - `send_link: \"magic\"` sends a magic-link sign-in email. - `send_link: \"password_reset\"` sends a set-password email. - `send_link: \"none\"` (default) creates the user with no email. A `redirect_url` is required when `send_link` is \"magic\" or \"password_reset\"; it must match the application\'s redirect_uris allowlist (custom schemes such as yourapp://path are permitted).
429
444
  * Pre-provision (invite) an end user (server-side admin)
430
445
  */
431
- async inviteEndUser(inviteEndUserRequest: InviteEndUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
432
- await this.inviteEndUserRaw({ inviteEndUserRequest: inviteEndUserRequest }, initOverrides);
446
+ async inviteEndUser(inviteEndUserRequest: InviteEndUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<InviteEndUser200Response> {
447
+ const response = await this.inviteEndUserRaw({ inviteEndUserRequest: inviteEndUserRequest }, initOverrides);
448
+ return await response.value();
433
449
  }
434
450
 
435
451
  /**
436
452
  * Secret-key-scoped directory listing of end users in the authenticating application. Supports substring search over email, name, and phone, an optional environment filter (test/live), and pagination. Scoped to the application — never returns users from another application.
437
453
  * List / search end users (server-side admin)
438
454
  */
439
- async listEndUsersRaw(requestParameters: AuthUserDirectoryApiListEndUsersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
455
+ async listEndUsersRaw(requestParameters: AuthUserDirectoryApiListEndUsersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListEndUsers200Response>> {
440
456
  const queryParameters: any = {};
441
457
 
442
458
  if (requestParameters['page'] != null) {
@@ -472,15 +488,16 @@ export class AuthUserDirectoryApi extends runtime.BaseAPI implements AuthUserDir
472
488
  query: queryParameters,
473
489
  }, initOverrides);
474
490
 
475
- return new runtime.VoidApiResponse(response);
491
+ return new runtime.JSONApiResponse(response, (jsonValue) => ListEndUsers200ResponseFromJSON(jsonValue));
476
492
  }
477
493
 
478
494
  /**
479
495
  * Secret-key-scoped directory listing of end users in the authenticating application. Supports substring search over email, name, and phone, an optional environment filter (test/live), and pagination. Scoped to the application — never returns users from another application.
480
496
  * List / search end users (server-side admin)
481
497
  */
482
- async listEndUsers(page?: number, perPage?: number, search?: string, environment?: ListEndUsersEnvironmentEnum, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
483
- await this.listEndUsersRaw({ page: page, perPage: perPage, search: search, environment: environment }, initOverrides);
498
+ async listEndUsers(page?: number, perPage?: number, search?: string, environment?: ListEndUsersEnvironmentEnum, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListEndUsers200Response> {
499
+ const response = await this.listEndUsersRaw({ page: page, perPage: perPage, search: search, environment: environment }, initOverrides);
500
+ return await response.value();
484
501
  }
485
502
 
486
503
  /**
@@ -540,7 +557,7 @@ export class AuthUserDirectoryApi extends runtime.BaseAPI implements AuthUserDir
540
557
  * Secret-key-scoped update of an arbitrary end user in the authenticating application. Updatable fields: email, name, avatar_url, metadata, status. Scoped to the application — a caller can never modify a user belonging to another application.
541
558
  * Update an end user (server-side admin)
542
559
  */
543
- async updateEndUserByApplicationRaw(requestParameters: AuthUserDirectoryApiUpdateEndUserByApplicationOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
560
+ async updateEndUserByApplicationRaw(requestParameters: AuthUserDirectoryApiUpdateEndUserByApplicationOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetEndUserById200Response>> {
544
561
  if (requestParameters['userId'] == null) {
545
562
  throw new runtime.RequiredError(
546
563
  'userId',
@@ -577,15 +594,16 @@ export class AuthUserDirectoryApi extends runtime.BaseAPI implements AuthUserDir
577
594
  body: UpdateEndUserByApplicationRequestToJSON(requestParameters['updateEndUserByApplicationRequest']),
578
595
  }, initOverrides);
579
596
 
580
- return new runtime.VoidApiResponse(response);
597
+ return new runtime.JSONApiResponse(response, (jsonValue) => GetEndUserById200ResponseFromJSON(jsonValue));
581
598
  }
582
599
 
583
600
  /**
584
601
  * Secret-key-scoped update of an arbitrary end user in the authenticating application. Updatable fields: email, name, avatar_url, metadata, status. Scoped to the application — a caller can never modify a user belonging to another application.
585
602
  * Update an end user (server-side admin)
586
603
  */
587
- async updateEndUserByApplication(userId: string, updateEndUserByApplicationRequest: UpdateEndUserByApplicationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
588
- await this.updateEndUserByApplicationRaw({ userId: userId, updateEndUserByApplicationRequest: updateEndUserByApplicationRequest }, initOverrides);
604
+ async updateEndUserByApplication(userId: string, updateEndUserByApplicationRequest: UpdateEndUserByApplicationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetEndUserById200Response> {
605
+ const response = await this.updateEndUserByApplicationRaw({ userId: userId, updateEndUserByApplicationRequest: updateEndUserByApplicationRequest }, initOverrides);
606
+ return await response.value();
589
607
  }
590
608
 
591
609
  }
@@ -166,13 +166,13 @@ export interface DomainsApiInterface {
166
166
  * @throws {RequiredError}
167
167
  * @memberof DomainsApiInterface
168
168
  */
169
- setDomainInboundRaw(requestParameters: DomainsApiSetDomainInboundOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
169
+ setDomainInboundRaw(requestParameters: DomainsApiSetDomainInboundOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetDomain200Response>>;
170
170
 
171
171
  /**
172
172
  * Toggle email receiving for a domain. When enabled, the domain\'s DNS records gain an MX record on the `inbound.` subdomain that the tenant must publish. Requires a plan with inbound email (Starter+).
173
173
  * Enable or disable inbound email for a domain
174
174
  */
175
- setDomainInbound(id: string, setDomainInboundRequest: SetDomainInboundRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
175
+ setDomainInbound(id: string, setDomainInboundRequest: SetDomainInboundRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetDomain200Response>;
176
176
 
177
177
  /**
178
178
  * Queue an asynchronous DNS verification check. Returns immediately with a `job_id`. Poll `GET /v1/domains/{id}/verification-status` (or the higher-level `GET /v1/domains/{id}`) for the result, or subscribe to the `domain.verified` webhook event when sc-5444 ships. Returns 409 if a verification is already in progress for this domain (within the last 2 minutes).
@@ -392,7 +392,7 @@ export class DomainsApi extends runtime.BaseAPI implements DomainsApiInterface {
392
392
  * Toggle email receiving for a domain. When enabled, the domain\'s DNS records gain an MX record on the `inbound.` subdomain that the tenant must publish. Requires a plan with inbound email (Starter+).
393
393
  * Enable or disable inbound email for a domain
394
394
  */
395
- async setDomainInboundRaw(requestParameters: DomainsApiSetDomainInboundOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
395
+ async setDomainInboundRaw(requestParameters: DomainsApiSetDomainInboundOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetDomain200Response>> {
396
396
  if (requestParameters['id'] == null) {
397
397
  throw new runtime.RequiredError(
398
398
  'id',
@@ -425,15 +425,16 @@ export class DomainsApi extends runtime.BaseAPI implements DomainsApiInterface {
425
425
  body: SetDomainInboundRequestToJSON(requestParameters['setDomainInboundRequest']),
426
426
  }, initOverrides);
427
427
 
428
- return new runtime.VoidApiResponse(response);
428
+ return new runtime.JSONApiResponse(response, (jsonValue) => GetDomain200ResponseFromJSON(jsonValue));
429
429
  }
430
430
 
431
431
  /**
432
432
  * Toggle email receiving for a domain. When enabled, the domain\'s DNS records gain an MX record on the `inbound.` subdomain that the tenant must publish. Requires a plan with inbound email (Starter+).
433
433
  * Enable or disable inbound email for a domain
434
434
  */
435
- async setDomainInbound(id: string, setDomainInboundRequest: SetDomainInboundRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
436
- await this.setDomainInboundRaw({ id: id, setDomainInboundRequest: setDomainInboundRequest }, initOverrides);
435
+ async setDomainInbound(id: string, setDomainInboundRequest: SetDomainInboundRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetDomain200Response> {
436
+ const response = await this.setDomainInboundRaw({ id: id, setDomainInboundRequest: setDomainInboundRequest }, initOverrides);
437
+ return await response.value();
437
438
  }
438
439
 
439
440
  /**