@zyphr-dev/node-sdk 0.1.41 → 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.
- package/dist/index.cjs +1912 -392
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +2055 -501
- package/dist/index.d.ts +2055 -501
- package/dist/index.js +1721 -387
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
- package/src/.openapi-generator/FILES +37 -1
- package/src/client.ts +4 -0
- package/src/src/apis/AuthUserDirectoryApi.ts +68 -46
- package/src/src/apis/DomainsApi.ts +7 -6
- package/src/src/apis/InboxApi.ts +82 -58
- package/src/src/apis/TemplatesApi.ts +10 -6
- package/src/src/apis/WaaSDeliveriesApi.ts +17 -12
- package/src/src/apis/WaaSEndpointsApi.ts +50 -30
- package/src/src/apis/WaaSEventTypesApi.ts +17 -12
- package/src/src/models/CloseWaaSEndpointCircuit200Response.ts +88 -0
- package/src/src/models/CloseWaaSEndpointCircuit200ResponseData.ts +76 -0
- package/src/src/models/GetEndUserById200Response.ts +88 -0
- package/src/src/models/GetEndUserClaims200Response.ts +88 -0
- package/src/src/models/GetEndUserClaims200ResponseData.ts +65 -0
- package/src/src/models/GetSubscriberInboxPreferences200Response.ts +73 -0
- package/src/src/models/GetSubscriberInboxPreferences200ResponseData.ts +88 -0
- package/src/src/models/GetSubscriberInboxPreferences200ResponseDataCategoriesInner.ts +88 -0
- package/src/src/models/GetSubscriberInboxPreferences200ResponseDataCategoriesInnerCategory.ts +97 -0
- package/src/src/models/GetSubscriberInboxPreferences200ResponseDataGlobal.ts +73 -0
- package/src/src/models/GetSubscriberInboxPreferences200ResponseDataGlobalChannelsInner.ts +94 -0
- package/src/src/models/GetSubscriberNotification200Response.ts +73 -0
- package/src/src/models/GetSubscriberUnreadCount200Response.ts +73 -0
- package/src/src/models/GetWaaSDelivery200Response.ts +88 -0
- package/src/src/models/GetWaaSEndpointCircuit200Response.ts +88 -0
- package/src/src/models/GetWaaSEndpointCircuit200ResponseData.ts +123 -0
- package/src/src/models/GetWaaSEndpointMetrics200Response.ts +88 -0
- package/src/src/models/GetWaaSEndpointMetrics200ResponseData.ts +99 -0
- package/src/src/models/GetWaaSEndpointMetrics200ResponseDataHealth.ts +87 -0
- package/src/src/models/GetWaaSEndpointMetrics200ResponseDataWindowsValue.ts +126 -0
- package/src/src/models/InviteEndUser200Response.ts +88 -0
- package/src/src/models/InviteEndUser200ResponseData.ts +81 -0
- package/src/src/models/ListEndUsers200Response.ts +88 -0
- package/src/src/models/{ListWorkflowExecutions200ResponseMeta.ts → ListEndUsers200ResponseMeta.ts} +15 -15
- package/src/src/models/ListWorkflowExecutions200Response.ts +11 -11
- package/src/src/models/MarkAllSubscriberNotificationsRead200Response.ts +73 -0
- package/src/src/models/RotateWaaSEndpointSecret200Response.ts +88 -0
- package/src/src/models/RotateWaaSEndpointSecret200ResponseData.ts +66 -0
- package/src/src/models/SendTemplateTestEmail202Response.ts +90 -0
- package/src/src/models/SendTemplateTestEmail202ResponseData.ts +120 -0
- package/src/src/models/SendTemplateTestEmail202ResponseMeta.ts +66 -0
- package/src/src/models/SetEndUserClaims200Response.ts +73 -0
- package/src/src/models/SetEndUserClaims200ResponseData.ts +73 -0
- package/src/src/models/SmsListResponse.ts +10 -10
- package/src/src/models/UpdateSubscriberPreferences200Response.ts +73 -0
- package/src/src/models/UpdateSubscriberPreferences200ResponseData.ts +81 -0
- package/src/src/models/UpdateSubscriberPreferences200ResponseDataPreferencesInner.ts +102 -0
- package/src/src/models/UpdateWaaSEndpoint200Response.ts +88 -0
- package/src/src/models/UpdateWaaSEventType200Response.ts +88 -0
- package/src/src/models/index.ts +37 -1
package/package.json
CHANGED
|
@@ -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
|
|
@@ -329,6 +358,8 @@ src/models/SessionListResponse.ts
|
|
|
329
358
|
src/models/SessionListResponseData.ts
|
|
330
359
|
src/models/SessionListResponseDataSessionInfo.ts
|
|
331
360
|
src/models/SetDomainInboundRequest.ts
|
|
361
|
+
src/models/SetEndUserClaims200Response.ts
|
|
362
|
+
src/models/SetEndUserClaims200ResponseData.ts
|
|
332
363
|
src/models/SetEndUserClaimsRequest.ts
|
|
333
364
|
src/models/SetPreferencesRequest.ts
|
|
334
365
|
src/models/SetPreferencesRequestPreferencesInner.ts
|
|
@@ -395,13 +426,18 @@ src/models/UpdateEndUserByApplicationRequest.ts
|
|
|
395
426
|
src/models/UpdateEndUserRequest.ts
|
|
396
427
|
src/models/UpdateOrganizationMemberRoleRequest.ts
|
|
397
428
|
src/models/UpdateOrganizationRequest.ts
|
|
429
|
+
src/models/UpdateSubscriberPreferences200Response.ts
|
|
430
|
+
src/models/UpdateSubscriberPreferences200ResponseData.ts
|
|
431
|
+
src/models/UpdateSubscriberPreferences200ResponseDataPreferencesInner.ts
|
|
398
432
|
src/models/UpdateSubscriberPreferencesRequest.ts
|
|
399
433
|
src/models/UpdateSubscriberPreferencesRequestPreferencesInner.ts
|
|
400
434
|
src/models/UpdateSubscriberRequest.ts
|
|
401
435
|
src/models/UpdateTemplateRequest.ts
|
|
402
436
|
src/models/UpdateTopicRequest.ts
|
|
403
437
|
src/models/UpdateWaaSApplicationRequest.ts
|
|
438
|
+
src/models/UpdateWaaSEndpoint200Response.ts
|
|
404
439
|
src/models/UpdateWaaSEndpointRequest.ts
|
|
440
|
+
src/models/UpdateWaaSEventType200Response.ts
|
|
405
441
|
src/models/UpdateWaaSEventTypeRequest.ts
|
|
406
442
|
src/models/UpdateWebhookRequest.ts
|
|
407
443
|
src/models/UpdateWorkflowRequest.ts
|
package/src/client.ts
CHANGED
|
@@ -27,6 +27,7 @@ import {
|
|
|
27
27
|
AuthPhoneApi,
|
|
28
28
|
AuthRegistrationApi,
|
|
29
29
|
AuthSessionsApi,
|
|
30
|
+
AuthUserDirectoryApi,
|
|
30
31
|
AuthUserProfileApi,
|
|
31
32
|
AuthWebAuthnApi,
|
|
32
33
|
DevicesApi,
|
|
@@ -111,6 +112,8 @@ export class Zyphr {
|
|
|
111
112
|
readonly phone: AuthPhoneApi;
|
|
112
113
|
readonly emailOtp: AuthEmailOTPApi;
|
|
113
114
|
readonly profile: AuthUserProfileApi;
|
|
115
|
+
/** Server-side (secret-key) end-user directory: list/search/get/update/delete, invite, and the trusted claims store. */
|
|
116
|
+
readonly userDirectory: AuthUserDirectoryApi;
|
|
114
117
|
readonly webauthn: AuthWebAuthnApi;
|
|
115
118
|
};
|
|
116
119
|
|
|
@@ -166,6 +169,7 @@ export class Zyphr {
|
|
|
166
169
|
phone: new AuthPhoneApi(config),
|
|
167
170
|
emailOtp: new AuthEmailOTPApi(config),
|
|
168
171
|
profile: new AuthUserProfileApi(config),
|
|
172
|
+
userDirectory: new AuthUserDirectoryApi(config),
|
|
169
173
|
webauthn: new AuthWebAuthnApi(config),
|
|
170
174
|
};
|
|
171
175
|
}
|
|
@@ -15,13 +15,28 @@
|
|
|
15
15
|
|
|
16
16
|
import * as runtime from '../runtime';
|
|
17
17
|
import type {
|
|
18
|
+
GetEndUserById200Response,
|
|
19
|
+
GetEndUserClaims200Response,
|
|
20
|
+
InviteEndUser200Response,
|
|
18
21
|
InviteEndUserRequest,
|
|
22
|
+
ListEndUsers200Response,
|
|
23
|
+
SetEndUserClaims200Response,
|
|
19
24
|
SetEndUserClaimsRequest,
|
|
20
25
|
UpdateEndUserByApplicationRequest,
|
|
21
26
|
} from '../models/index';
|
|
22
27
|
import {
|
|
28
|
+
GetEndUserById200ResponseFromJSON,
|
|
29
|
+
GetEndUserById200ResponseToJSON,
|
|
30
|
+
GetEndUserClaims200ResponseFromJSON,
|
|
31
|
+
GetEndUserClaims200ResponseToJSON,
|
|
32
|
+
InviteEndUser200ResponseFromJSON,
|
|
33
|
+
InviteEndUser200ResponseToJSON,
|
|
23
34
|
InviteEndUserRequestFromJSON,
|
|
24
35
|
InviteEndUserRequestToJSON,
|
|
36
|
+
ListEndUsers200ResponseFromJSON,
|
|
37
|
+
ListEndUsers200ResponseToJSON,
|
|
38
|
+
SetEndUserClaims200ResponseFromJSON,
|
|
39
|
+
SetEndUserClaims200ResponseToJSON,
|
|
25
40
|
SetEndUserClaimsRequestFromJSON,
|
|
26
41
|
SetEndUserClaimsRequestToJSON,
|
|
27
42
|
UpdateEndUserByApplicationRequestFromJSON,
|
|
@@ -96,13 +111,13 @@ export interface AuthUserDirectoryApiInterface {
|
|
|
96
111
|
* @throws {RequiredError}
|
|
97
112
|
* @memberof AuthUserDirectoryApiInterface
|
|
98
113
|
*/
|
|
99
|
-
getEndUserByEmailRaw(requestParameters: AuthUserDirectoryApiGetEndUserByEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<
|
|
114
|
+
getEndUserByEmailRaw(requestParameters: AuthUserDirectoryApiGetEndUserByEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetEndUserById200Response>>;
|
|
100
115
|
|
|
101
116
|
/**
|
|
102
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.
|
|
103
118
|
* Look up an end user by email (server-side admin)
|
|
104
119
|
*/
|
|
105
|
-
getEndUserByEmail(email: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<
|
|
120
|
+
getEndUserByEmail(email: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetEndUserById200Response>;
|
|
106
121
|
|
|
107
122
|
/**
|
|
108
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.
|
|
@@ -112,13 +127,13 @@ export interface AuthUserDirectoryApiInterface {
|
|
|
112
127
|
* @throws {RequiredError}
|
|
113
128
|
* @memberof AuthUserDirectoryApiInterface
|
|
114
129
|
*/
|
|
115
|
-
getEndUserByIdRaw(requestParameters: AuthUserDirectoryApiGetEndUserByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<
|
|
130
|
+
getEndUserByIdRaw(requestParameters: AuthUserDirectoryApiGetEndUserByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetEndUserById200Response>>;
|
|
116
131
|
|
|
117
132
|
/**
|
|
118
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.
|
|
119
134
|
* Get an end user by id (server-side admin)
|
|
120
135
|
*/
|
|
121
|
-
getEndUserById(userId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<
|
|
136
|
+
getEndUserById(userId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetEndUserById200Response>;
|
|
122
137
|
|
|
123
138
|
/**
|
|
124
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.
|
|
@@ -128,13 +143,13 @@ export interface AuthUserDirectoryApiInterface {
|
|
|
128
143
|
* @throws {RequiredError}
|
|
129
144
|
* @memberof AuthUserDirectoryApiInterface
|
|
130
145
|
*/
|
|
131
|
-
getEndUserClaimsRaw(requestParameters: AuthUserDirectoryApiGetEndUserClaimsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<
|
|
146
|
+
getEndUserClaimsRaw(requestParameters: AuthUserDirectoryApiGetEndUserClaimsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetEndUserClaims200Response>>;
|
|
132
147
|
|
|
133
148
|
/**
|
|
134
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.
|
|
135
150
|
* Get an end user\'s stored custom claims (server-side admin)
|
|
136
151
|
*/
|
|
137
|
-
getEndUserClaims(userId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<
|
|
152
|
+
getEndUserClaims(userId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetEndUserClaims200Response>;
|
|
138
153
|
|
|
139
154
|
/**
|
|
140
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).
|
|
@@ -144,13 +159,13 @@ export interface AuthUserDirectoryApiInterface {
|
|
|
144
159
|
* @throws {RequiredError}
|
|
145
160
|
* @memberof AuthUserDirectoryApiInterface
|
|
146
161
|
*/
|
|
147
|
-
inviteEndUserRaw(requestParameters: AuthUserDirectoryApiInviteEndUserOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<
|
|
162
|
+
inviteEndUserRaw(requestParameters: AuthUserDirectoryApiInviteEndUserOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<InviteEndUser200Response>>;
|
|
148
163
|
|
|
149
164
|
/**
|
|
150
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).
|
|
151
166
|
* Pre-provision (invite) an end user (server-side admin)
|
|
152
167
|
*/
|
|
153
|
-
inviteEndUser(inviteEndUserRequest: InviteEndUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<
|
|
168
|
+
inviteEndUser(inviteEndUserRequest: InviteEndUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<InviteEndUser200Response>;
|
|
154
169
|
|
|
155
170
|
/**
|
|
156
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.
|
|
@@ -163,16 +178,16 @@ export interface AuthUserDirectoryApiInterface {
|
|
|
163
178
|
* @throws {RequiredError}
|
|
164
179
|
* @memberof AuthUserDirectoryApiInterface
|
|
165
180
|
*/
|
|
166
|
-
listEndUsersRaw(requestParameters: AuthUserDirectoryApiListEndUsersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<
|
|
181
|
+
listEndUsersRaw(requestParameters: AuthUserDirectoryApiListEndUsersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListEndUsers200Response>>;
|
|
167
182
|
|
|
168
183
|
/**
|
|
169
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.
|
|
170
185
|
* List / search end users (server-side admin)
|
|
171
186
|
*/
|
|
172
|
-
listEndUsers(page?: number, perPage?: number, search?: string, environment?: ListEndUsersEnvironmentEnum, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<
|
|
187
|
+
listEndUsers(page?: number, perPage?: number, search?: string, environment?: ListEndUsersEnvironmentEnum, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListEndUsers200Response>;
|
|
173
188
|
|
|
174
189
|
/**
|
|
175
|
-
* 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.
|
|
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.
|
|
176
191
|
* @summary Set an end user\'s stored custom claims (server-side admin)
|
|
177
192
|
* @param {string} userId
|
|
178
193
|
* @param {SetEndUserClaimsRequest} setEndUserClaimsRequest
|
|
@@ -180,13 +195,13 @@ export interface AuthUserDirectoryApiInterface {
|
|
|
180
195
|
* @throws {RequiredError}
|
|
181
196
|
* @memberof AuthUserDirectoryApiInterface
|
|
182
197
|
*/
|
|
183
|
-
setEndUserClaimsRaw(requestParameters: AuthUserDirectoryApiSetEndUserClaimsOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<
|
|
198
|
+
setEndUserClaimsRaw(requestParameters: AuthUserDirectoryApiSetEndUserClaimsOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SetEndUserClaims200Response>>;
|
|
184
199
|
|
|
185
200
|
/**
|
|
186
|
-
* 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.
|
|
201
|
+
* 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.
|
|
187
202
|
* Set an end user\'s stored custom claims (server-side admin)
|
|
188
203
|
*/
|
|
189
|
-
setEndUserClaims(userId: string, setEndUserClaimsRequest: SetEndUserClaimsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<
|
|
204
|
+
setEndUserClaims(userId: string, setEndUserClaimsRequest: SetEndUserClaimsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SetEndUserClaims200Response>;
|
|
190
205
|
|
|
191
206
|
/**
|
|
192
207
|
* 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.
|
|
@@ -197,13 +212,13 @@ export interface AuthUserDirectoryApiInterface {
|
|
|
197
212
|
* @throws {RequiredError}
|
|
198
213
|
* @memberof AuthUserDirectoryApiInterface
|
|
199
214
|
*/
|
|
200
|
-
updateEndUserByApplicationRaw(requestParameters: AuthUserDirectoryApiUpdateEndUserByApplicationOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<
|
|
215
|
+
updateEndUserByApplicationRaw(requestParameters: AuthUserDirectoryApiUpdateEndUserByApplicationOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetEndUserById200Response>>;
|
|
201
216
|
|
|
202
217
|
/**
|
|
203
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.
|
|
204
219
|
* Update an end user (server-side admin)
|
|
205
220
|
*/
|
|
206
|
-
updateEndUserByApplication(userId: string, updateEndUserByApplicationRequest: UpdateEndUserByApplicationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<
|
|
221
|
+
updateEndUserByApplication(userId: string, updateEndUserByApplicationRequest: UpdateEndUserByApplicationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetEndUserById200Response>;
|
|
207
222
|
|
|
208
223
|
}
|
|
209
224
|
|
|
@@ -258,7 +273,7 @@ export class AuthUserDirectoryApi extends runtime.BaseAPI implements AuthUserDir
|
|
|
258
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.
|
|
259
274
|
* Look up an end user by email (server-side admin)
|
|
260
275
|
*/
|
|
261
|
-
async getEndUserByEmailRaw(requestParameters: AuthUserDirectoryApiGetEndUserByEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<
|
|
276
|
+
async getEndUserByEmailRaw(requestParameters: AuthUserDirectoryApiGetEndUserByEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetEndUserById200Response>> {
|
|
262
277
|
if (requestParameters['email'] == null) {
|
|
263
278
|
throw new runtime.RequiredError(
|
|
264
279
|
'email',
|
|
@@ -289,22 +304,23 @@ export class AuthUserDirectoryApi extends runtime.BaseAPI implements AuthUserDir
|
|
|
289
304
|
query: queryParameters,
|
|
290
305
|
}, initOverrides);
|
|
291
306
|
|
|
292
|
-
return new runtime.
|
|
307
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => GetEndUserById200ResponseFromJSON(jsonValue));
|
|
293
308
|
}
|
|
294
309
|
|
|
295
310
|
/**
|
|
296
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.
|
|
297
312
|
* Look up an end user by email (server-side admin)
|
|
298
313
|
*/
|
|
299
|
-
async getEndUserByEmail(email: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<
|
|
300
|
-
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();
|
|
301
317
|
}
|
|
302
318
|
|
|
303
319
|
/**
|
|
304
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.
|
|
305
321
|
* Get an end user by id (server-side admin)
|
|
306
322
|
*/
|
|
307
|
-
async getEndUserByIdRaw(requestParameters: AuthUserDirectoryApiGetEndUserByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<
|
|
323
|
+
async getEndUserByIdRaw(requestParameters: AuthUserDirectoryApiGetEndUserByIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetEndUserById200Response>> {
|
|
308
324
|
if (requestParameters['userId'] == null) {
|
|
309
325
|
throw new runtime.RequiredError(
|
|
310
326
|
'userId',
|
|
@@ -331,22 +347,23 @@ export class AuthUserDirectoryApi extends runtime.BaseAPI implements AuthUserDir
|
|
|
331
347
|
query: queryParameters,
|
|
332
348
|
}, initOverrides);
|
|
333
349
|
|
|
334
|
-
return new runtime.
|
|
350
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => GetEndUserById200ResponseFromJSON(jsonValue));
|
|
335
351
|
}
|
|
336
352
|
|
|
337
353
|
/**
|
|
338
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.
|
|
339
355
|
* Get an end user by id (server-side admin)
|
|
340
356
|
*/
|
|
341
|
-
async getEndUserById(userId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<
|
|
342
|
-
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();
|
|
343
360
|
}
|
|
344
361
|
|
|
345
362
|
/**
|
|
346
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.
|
|
347
364
|
* Get an end user\'s stored custom claims (server-side admin)
|
|
348
365
|
*/
|
|
349
|
-
async getEndUserClaimsRaw(requestParameters: AuthUserDirectoryApiGetEndUserClaimsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<
|
|
366
|
+
async getEndUserClaimsRaw(requestParameters: AuthUserDirectoryApiGetEndUserClaimsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetEndUserClaims200Response>> {
|
|
350
367
|
if (requestParameters['userId'] == null) {
|
|
351
368
|
throw new runtime.RequiredError(
|
|
352
369
|
'userId',
|
|
@@ -373,22 +390,23 @@ export class AuthUserDirectoryApi extends runtime.BaseAPI implements AuthUserDir
|
|
|
373
390
|
query: queryParameters,
|
|
374
391
|
}, initOverrides);
|
|
375
392
|
|
|
376
|
-
return new runtime.
|
|
393
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => GetEndUserClaims200ResponseFromJSON(jsonValue));
|
|
377
394
|
}
|
|
378
395
|
|
|
379
396
|
/**
|
|
380
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.
|
|
381
398
|
* Get an end user\'s stored custom claims (server-side admin)
|
|
382
399
|
*/
|
|
383
|
-
async getEndUserClaims(userId: string, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<
|
|
384
|
-
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();
|
|
385
403
|
}
|
|
386
404
|
|
|
387
405
|
/**
|
|
388
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).
|
|
389
407
|
* Pre-provision (invite) an end user (server-side admin)
|
|
390
408
|
*/
|
|
391
|
-
async inviteEndUserRaw(requestParameters: AuthUserDirectoryApiInviteEndUserOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<
|
|
409
|
+
async inviteEndUserRaw(requestParameters: AuthUserDirectoryApiInviteEndUserOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<InviteEndUser200Response>> {
|
|
392
410
|
if (requestParameters['inviteEndUserRequest'] == null) {
|
|
393
411
|
throw new runtime.RequiredError(
|
|
394
412
|
'inviteEndUserRequest',
|
|
@@ -418,22 +436,23 @@ export class AuthUserDirectoryApi extends runtime.BaseAPI implements AuthUserDir
|
|
|
418
436
|
body: InviteEndUserRequestToJSON(requestParameters['inviteEndUserRequest']),
|
|
419
437
|
}, initOverrides);
|
|
420
438
|
|
|
421
|
-
return new runtime.
|
|
439
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => InviteEndUser200ResponseFromJSON(jsonValue));
|
|
422
440
|
}
|
|
423
441
|
|
|
424
442
|
/**
|
|
425
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).
|
|
426
444
|
* Pre-provision (invite) an end user (server-side admin)
|
|
427
445
|
*/
|
|
428
|
-
async inviteEndUser(inviteEndUserRequest: InviteEndUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<
|
|
429
|
-
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();
|
|
430
449
|
}
|
|
431
450
|
|
|
432
451
|
/**
|
|
433
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.
|
|
434
453
|
* List / search end users (server-side admin)
|
|
435
454
|
*/
|
|
436
|
-
async listEndUsersRaw(requestParameters: AuthUserDirectoryApiListEndUsersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<
|
|
455
|
+
async listEndUsersRaw(requestParameters: AuthUserDirectoryApiListEndUsersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListEndUsers200Response>> {
|
|
437
456
|
const queryParameters: any = {};
|
|
438
457
|
|
|
439
458
|
if (requestParameters['page'] != null) {
|
|
@@ -469,22 +488,23 @@ export class AuthUserDirectoryApi extends runtime.BaseAPI implements AuthUserDir
|
|
|
469
488
|
query: queryParameters,
|
|
470
489
|
}, initOverrides);
|
|
471
490
|
|
|
472
|
-
return new runtime.
|
|
491
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => ListEndUsers200ResponseFromJSON(jsonValue));
|
|
473
492
|
}
|
|
474
493
|
|
|
475
494
|
/**
|
|
476
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.
|
|
477
496
|
* List / search end users (server-side admin)
|
|
478
497
|
*/
|
|
479
|
-
async listEndUsers(page?: number, perPage?: number, search?: string, environment?: ListEndUsersEnvironmentEnum, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<
|
|
480
|
-
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();
|
|
481
501
|
}
|
|
482
502
|
|
|
483
503
|
/**
|
|
484
|
-
* 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.
|
|
504
|
+
* 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.
|
|
485
505
|
* Set an end user\'s stored custom claims (server-side admin)
|
|
486
506
|
*/
|
|
487
|
-
async setEndUserClaimsRaw(requestParameters: AuthUserDirectoryApiSetEndUserClaimsOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<
|
|
507
|
+
async setEndUserClaimsRaw(requestParameters: AuthUserDirectoryApiSetEndUserClaimsOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SetEndUserClaims200Response>> {
|
|
488
508
|
if (requestParameters['userId'] == null) {
|
|
489
509
|
throw new runtime.RequiredError(
|
|
490
510
|
'userId',
|
|
@@ -521,22 +541,23 @@ export class AuthUserDirectoryApi extends runtime.BaseAPI implements AuthUserDir
|
|
|
521
541
|
body: SetEndUserClaimsRequestToJSON(requestParameters['setEndUserClaimsRequest']),
|
|
522
542
|
}, initOverrides);
|
|
523
543
|
|
|
524
|
-
return new runtime.
|
|
544
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => SetEndUserClaims200ResponseFromJSON(jsonValue));
|
|
525
545
|
}
|
|
526
546
|
|
|
527
547
|
/**
|
|
528
|
-
* 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.
|
|
548
|
+
* 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.
|
|
529
549
|
* Set an end user\'s stored custom claims (server-side admin)
|
|
530
550
|
*/
|
|
531
|
-
async setEndUserClaims(userId: string, setEndUserClaimsRequest: SetEndUserClaimsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<
|
|
532
|
-
await this.setEndUserClaimsRaw({ userId: userId, setEndUserClaimsRequest: setEndUserClaimsRequest }, initOverrides);
|
|
551
|
+
async setEndUserClaims(userId: string, setEndUserClaimsRequest: SetEndUserClaimsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SetEndUserClaims200Response> {
|
|
552
|
+
const response = await this.setEndUserClaimsRaw({ userId: userId, setEndUserClaimsRequest: setEndUserClaimsRequest }, initOverrides);
|
|
553
|
+
return await response.value();
|
|
533
554
|
}
|
|
534
555
|
|
|
535
556
|
/**
|
|
536
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.
|
|
537
558
|
* Update an end user (server-side admin)
|
|
538
559
|
*/
|
|
539
|
-
async updateEndUserByApplicationRaw(requestParameters: AuthUserDirectoryApiUpdateEndUserByApplicationOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<
|
|
560
|
+
async updateEndUserByApplicationRaw(requestParameters: AuthUserDirectoryApiUpdateEndUserByApplicationOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetEndUserById200Response>> {
|
|
540
561
|
if (requestParameters['userId'] == null) {
|
|
541
562
|
throw new runtime.RequiredError(
|
|
542
563
|
'userId',
|
|
@@ -573,15 +594,16 @@ export class AuthUserDirectoryApi extends runtime.BaseAPI implements AuthUserDir
|
|
|
573
594
|
body: UpdateEndUserByApplicationRequestToJSON(requestParameters['updateEndUserByApplicationRequest']),
|
|
574
595
|
}, initOverrides);
|
|
575
596
|
|
|
576
|
-
return new runtime.
|
|
597
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => GetEndUserById200ResponseFromJSON(jsonValue));
|
|
577
598
|
}
|
|
578
599
|
|
|
579
600
|
/**
|
|
580
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.
|
|
581
602
|
* Update an end user (server-side admin)
|
|
582
603
|
*/
|
|
583
|
-
async updateEndUserByApplication(userId: string, updateEndUserByApplicationRequest: UpdateEndUserByApplicationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<
|
|
584
|
-
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();
|
|
585
607
|
}
|
|
586
608
|
|
|
587
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<
|
|
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<
|
|
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<
|
|
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.
|
|
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<
|
|
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
|
/**
|