@faiber/faiber-idp 0.3.0 → 0.5.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,186 +1,914 @@
1
1
  import { ServiceApi, urlEncoded } from "@faiber/sdk-core";
2
2
  export class IdpOperations extends ServiceApi {
3
- /** GET /; permission: public/session-derived. */
3
+ /**
4
+ * Performs the status route operation for the router capability.
5
+ * Calls `GET /` through the shared IDP-aware Faiber client.
6
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
7
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
8
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
9
+ */
4
10
  routerStatusRouteGet(options) {
5
11
  return this.client.request({ ...options, method: "GET", url: `/` });
6
12
  }
7
- /** GET /api/openapi.json; permission: public/session-derived. */
13
+ /**
14
+ * Performs the openapi json operation for the router capability.
15
+ * Calls `GET /api/openapi.json` through the shared IDP-aware Faiber client.
16
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
17
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
18
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
19
+ */
8
20
  routerOpenapiJsonGet(options) {
9
21
  return this.client.request({ ...options, method: "GET", url: `/api/openapi.json` });
10
22
  }
11
- /** GET /api/v1/acl/permissions; permission: public/session-derived. */
23
+ /**
24
+ * Performs the discovery operation for the oidc capability.
25
+ * Calls `GET /api/v1/.well-known/openid-configuration` through the shared IDP-aware Faiber client.
26
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
27
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
28
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
29
+ */
30
+ oidcDiscoveryGet(options) {
31
+ return this.client.request({ ...options, method: "GET", url: `/api/v1/.well-known/openid-configuration` });
32
+ }
33
+ /**
34
+ * Performs the permissions index operation for the acl capability.
35
+ * Calls `GET /api/v1/acl/permissions` through the shared IDP-aware Faiber client.
36
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
37
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
38
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
39
+ */
12
40
  aclPermissionsIndexGet(options) {
13
41
  return this.client.request({ ...options, method: "GET", url: `/api/v1/acl/permissions` });
14
42
  }
15
- /** GET /api/v1/acl/roles; permission: public/session-derived. */
43
+ /**
44
+ * Performs the roles index operation for the acl capability.
45
+ * Calls `GET /api/v1/acl/roles` through the shared IDP-aware Faiber client.
46
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
47
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
48
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
49
+ */
16
50
  aclRolesIndexGet(options) {
17
51
  return this.client.request({ ...options, method: "GET", url: `/api/v1/acl/roles` });
18
52
  }
19
- /** POST /api/v1/acl/roles; permission: public/session-derived. */
53
+ /**
54
+ * Performs the roles create operation for the acl capability.
55
+ * Calls `POST /api/v1/acl/roles` through the shared IDP-aware Faiber client.
56
+ * @param data Typed JSON request body.
57
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
58
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
59
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
60
+ */
20
61
  aclRolesCreatePost(data, options) {
21
62
  return this.client.request({ ...options, method: "POST", url: `/api/v1/acl/roles`, data: data });
22
63
  }
23
- /** DELETE /api/v1/acl/roles/{role_id}; permission: public/session-derived. */
64
+ /**
65
+ * Performs the roles delete operation for the acl capability.
66
+ * Calls `DELETE /api/v1/acl/roles/{role_id}` through the shared IDP-aware Faiber client.
67
+ * @param roleId Backend path identifier `role_id`.
68
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
69
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
70
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
71
+ */
24
72
  aclRolesDeleteDelete(roleId, options) {
25
73
  return this.client.request({ ...options, method: "DELETE", url: `/api/v1/acl/roles/${encodeURIComponent(roleId)}` });
26
74
  }
27
- /** GET /api/v1/acl/roles/{role_id}; permission: public/session-derived. */
75
+ /**
76
+ * Performs the roles show operation for the acl capability.
77
+ * Calls `GET /api/v1/acl/roles/{role_id}` through the shared IDP-aware Faiber client.
78
+ * @param roleId Backend path identifier `role_id`.
79
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
80
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
81
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
82
+ */
28
83
  aclRolesShowGet(roleId, options) {
29
84
  return this.client.request({ ...options, method: "GET", url: `/api/v1/acl/roles/${encodeURIComponent(roleId)}` });
30
85
  }
31
- /** PATCH /api/v1/acl/roles/{role_id}; permission: public/session-derived. */
86
+ /**
87
+ * Performs the roles update operation for the acl capability.
88
+ * Calls `PATCH /api/v1/acl/roles/{role_id}` through the shared IDP-aware Faiber client.
89
+ * @param roleId Backend path identifier `role_id`.
90
+ * @param data Typed JSON request body.
91
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
92
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
93
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
94
+ */
32
95
  aclRolesUpdatePatch(roleId, data, options) {
33
96
  return this.client.request({ ...options, method: "PATCH", url: `/api/v1/acl/roles/${encodeURIComponent(roleId)}`, data: data });
34
97
  }
35
- /** PUT /api/v1/acl/roles/{role_id}; permission: public/session-derived. */
98
+ /**
99
+ * Performs the roles update operation for the acl capability.
100
+ * Calls `PUT /api/v1/acl/roles/{role_id}` through the shared IDP-aware Faiber client.
101
+ * @param roleId Backend path identifier `role_id`.
102
+ * @param data Typed JSON request body.
103
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
104
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
105
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
106
+ */
36
107
  aclRolesUpdatePut(roleId, data, options) {
37
108
  return this.client.request({ ...options, method: "PUT", url: `/api/v1/acl/roles/${encodeURIComponent(roleId)}`, data: data });
38
109
  }
39
- /** POST /api/v1/auth/account-login; permission: public/session-derived. */
110
+ /**
111
+ * Performs the login account operation for the auth capability.
112
+ * Calls `POST /api/v1/auth/account-login` through the shared IDP-aware Faiber client.
113
+ * @param data Typed URL-encoded form.
114
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
115
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
116
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
117
+ */
40
118
  authLoginAccountPost(data, options) {
41
119
  return this.client.request({ ...options, method: "POST", url: `/api/v1/auth/account-login`, data: urlEncoded(data), headers: { ...options?.headers, "Content-Type": "application/x-www-form-urlencoded" } });
42
120
  }
43
- /** POST /api/v1/auth/generate/one-time; permission: public/session-derived. */
121
+ /**
122
+ * Performs the public show operation for the identity authority capability.
123
+ * Calls `GET /api/v1/auth/authority` through the shared IDP-aware Faiber client.
124
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
125
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
126
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
127
+ */
128
+ identityAuthorityPublicShowGet(options) {
129
+ return this.client.request({ ...options, method: "GET", url: `/api/v1/auth/authority` });
130
+ }
131
+ /**
132
+ * Performs the start operation for the custom oauth capability.
133
+ * Calls `GET /api/v1/auth/custom-oauth/{provider}` through the shared IDP-aware Faiber client.
134
+ * @param provider Backend path identifier `provider`.
135
+ * @param params Typed query parameters; omitted members retain backend defaults.
136
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
137
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
138
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
139
+ */
140
+ customOauthStartGet(provider, params, options) {
141
+ return this.client.request({ ...options, method: "GET", url: `/api/v1/auth/custom-oauth/${encodeURIComponent(provider)}`, params });
142
+ }
143
+ /**
144
+ * Performs the callback operation for the custom oauth capability.
145
+ * Calls `GET /api/v1/auth/custom-oauth/{provider}/callback` through the shared IDP-aware Faiber client.
146
+ * @param provider Backend path identifier `provider`.
147
+ * @param params Typed query parameters; omitted members retain backend defaults.
148
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
149
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
150
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
151
+ */
152
+ customOauthCallbackGet(provider, params, options) {
153
+ return this.client.request({ ...options, method: "GET", url: `/api/v1/auth/custom-oauth/${encodeURIComponent(provider)}/callback`, params });
154
+ }
155
+ /**
156
+ * Performs the unlink operation for the custom oauth capability.
157
+ * Calls `DELETE /api/v1/auth/custom-oauth/{provider}/link` through the shared IDP-aware Faiber client.
158
+ * @param provider Backend path identifier `provider`.
159
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
160
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
161
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
162
+ */
163
+ customOauthUnlinkDelete(provider, options) {
164
+ return this.client.request({ ...options, method: "DELETE", url: `/api/v1/auth/custom-oauth/${encodeURIComponent(provider)}/link` });
165
+ }
166
+ /**
167
+ * Performs the public providers operation for the custom oauth capability.
168
+ * Calls `GET /api/v1/auth/custom-oauth/providers` through the shared IDP-aware Faiber client.
169
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
170
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
171
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
172
+ */
173
+ customOauthPublicProvidersGet(options) {
174
+ return this.client.request({ ...options, method: "GET", url: `/api/v1/auth/custom-oauth/providers` });
175
+ }
176
+ /**
177
+ * Performs the generate one time token route operation for the auth capability.
178
+ * Calls `POST /api/v1/auth/generate/one-time` through the shared IDP-aware Faiber client.
179
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
180
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
181
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
182
+ */
44
183
  authGenerateOneTimeTokenRoutePost(options) {
45
184
  return this.client.request({ ...options, method: "POST", url: `/api/v1/auth/generate/one-time` });
46
185
  }
47
- /** GET /api/v1/auth/identities; permission: public/session-derived. */
186
+ /**
187
+ * Performs the browser handoff operation for the auth capability.
188
+ * Calls `GET /api/v1/auth/handoff` through the shared IDP-aware Faiber client.
189
+ * @param params Typed query parameters; omitted members retain backend defaults.
190
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
191
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
192
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
193
+ */
194
+ authBrowserHandoffGet(params, options) {
195
+ return this.client.request({ ...options, method: "GET", url: `/api/v1/auth/handoff`, params });
196
+ }
197
+ /**
198
+ * Performs the list linked identities operation for the auth capability.
199
+ * Calls `GET /api/v1/auth/identities` through the shared IDP-aware Faiber client.
200
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
201
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
202
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
203
+ */
48
204
  authListLinkedIdentitiesGet(options) {
49
205
  return this.client.request({ ...options, method: "GET", url: `/api/v1/auth/identities` });
50
206
  }
51
- /** POST /api/v1/auth/login; permission: public/session-derived. */
207
+ /**
208
+ * Performs the login operation for the auth capability.
209
+ * Calls `POST /api/v1/auth/login` through the shared IDP-aware Faiber client.
210
+ * @param data Typed URL-encoded form.
211
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
212
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
213
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
214
+ */
52
215
  authLoginPost(data, options) {
53
216
  return this.client.request({ ...options, method: "POST", url: `/api/v1/auth/login`, data: urlEncoded(data), headers: { ...options?.headers, "Content-Type": "application/x-www-form-urlencoded" } });
54
217
  }
55
- /** DELETE /api/v1/auth/oauth/{provider}; permission: public/session-derived. */
218
+ /**
219
+ * Performs the logout operation for the auth capability.
220
+ * Calls `GET /api/v1/auth/logout` through the shared IDP-aware Faiber client.
221
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
222
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
223
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
224
+ */
225
+ authLogoutGet(options) {
226
+ return this.client.request({ ...options, method: "GET", url: `/api/v1/auth/logout` });
227
+ }
228
+ /**
229
+ * Performs the authorize operation for the auth capability.
230
+ * Calls `GET /api/v1/auth/native/authorize` through the shared IDP-aware Faiber client.
231
+ * @param params Typed query parameters; omitted members retain backend defaults.
232
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
233
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
234
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
235
+ */
236
+ authAuthorizeGet(params, options) {
237
+ return this.client.request({ ...options, method: "GET", url: `/api/v1/auth/native/authorize`, params });
238
+ }
239
+ /**
240
+ * Performs the token operation for the auth capability.
241
+ * Calls `POST /api/v1/auth/native/token` through the shared IDP-aware Faiber client.
242
+ * @param data Typed URL-encoded form.
243
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
244
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
245
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
246
+ */
247
+ authTokenPost(data, options) {
248
+ return this.client.request({ ...options, method: "POST", url: `/api/v1/auth/native/token`, data: urlEncoded(data), headers: { ...options?.headers, "Content-Type": "application/x-www-form-urlencoded" } });
249
+ }
250
+ /**
251
+ * Performs the oauth unlink operation for the auth capability.
252
+ * Calls `DELETE /api/v1/auth/oauth/{provider}` through the shared IDP-aware Faiber client.
253
+ * @param provider Backend path identifier `provider`.
254
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
255
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
256
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
257
+ */
56
258
  authOauthUnlinkDelete(provider, options) {
57
259
  return this.client.request({ ...options, method: "DELETE", url: `/api/v1/auth/oauth/${encodeURIComponent(provider)}` });
58
260
  }
59
- /** GET /api/v1/auth/oauth/{provider}; permission: public/session-derived. */
261
+ /**
262
+ * Performs the oauth start operation for the auth capability.
263
+ * Calls `GET /api/v1/auth/oauth/{provider}` through the shared IDP-aware Faiber client.
264
+ * @param provider Backend path identifier `provider`.
265
+ * @param params Typed query parameters; omitted members retain backend defaults.
266
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
267
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
268
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
269
+ */
60
270
  authOauthStartGet(provider, params, options) {
61
271
  return this.client.request({ ...options, method: "GET", url: `/api/v1/auth/oauth/${encodeURIComponent(provider)}`, params });
62
272
  }
63
- /** GET /api/v1/auth/oauth/{provider}/callback; permission: public/session-derived. */
273
+ /**
274
+ * Performs the oauth callback operation for the auth capability.
275
+ * Calls `GET /api/v1/auth/oauth/{provider}/callback` through the shared IDP-aware Faiber client.
276
+ * @param provider Backend path identifier `provider`.
277
+ * @param params Typed query parameters; omitted members retain backend defaults.
278
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
279
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
280
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
281
+ */
64
282
  authOauthCallbackGet(provider, params, options) {
65
283
  return this.client.request({ ...options, method: "GET", url: `/api/v1/auth/oauth/${encodeURIComponent(provider)}/callback`, params });
66
284
  }
67
- /** GET /api/v1/auth/oauth/providers; permission: public/session-derived. */
285
+ /**
286
+ * Performs the oauth providers operation for the auth capability.
287
+ * Calls `GET /api/v1/auth/oauth/providers` through the shared IDP-aware Faiber client.
288
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
289
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
290
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
291
+ */
68
292
  authOauthProvidersGet(options) {
69
293
  return this.client.request({ ...options, method: "GET", url: `/api/v1/auth/oauth/providers` });
70
294
  }
71
- /** POST /api/v1/auth/otp-login; permission: public/session-derived. */
295
+ /**
296
+ * Performs the otp login operation for the auth capability.
297
+ * Calls `POST /api/v1/auth/otp-login` through the shared IDP-aware Faiber client.
298
+ * @param data Typed URL-encoded form.
299
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
300
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
301
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
302
+ */
72
303
  authOtpLoginPost(data, options) {
73
304
  return this.client.request({ ...options, method: "POST", url: `/api/v1/auth/otp-login`, data: urlEncoded(data), headers: { ...options?.headers, "Content-Type": "application/x-www-form-urlencoded" } });
74
305
  }
75
- /** GET /api/v1/auth/refresh; permission: public/session-derived. */
306
+ /**
307
+ * Performs the refresh token operation for the auth capability.
308
+ * Calls `GET /api/v1/auth/refresh` through the shared IDP-aware Faiber client.
309
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
310
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
311
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
312
+ */
76
313
  authRefreshTokenGet(options) {
77
314
  return this.client.request({ ...options, method: "GET", url: `/api/v1/auth/refresh` });
78
315
  }
79
- /** POST /api/v1/auth/secure/generate/one-time; permission: public/session-derived. */
316
+ /**
317
+ * Performs the generate secure one time token route operation for the auth capability.
318
+ * Calls `POST /api/v1/auth/secure/generate/one-time` through the shared IDP-aware Faiber client.
319
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
320
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
321
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
322
+ */
80
323
  authGenerateSecureOneTimeTokenRoutePost(options) {
81
324
  return this.client.request({ ...options, method: "POST", url: `/api/v1/auth/secure/generate/one-time` });
82
325
  }
83
- /** GET /api/v1/auth/token-login; permission: public/session-derived. */
326
+ /**
327
+ * Performs the list sessions operation for the auth capability.
328
+ * Calls `GET /api/v1/auth/sessions` through the shared IDP-aware Faiber client.
329
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
330
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
331
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
332
+ */
333
+ authListSessionsGet(options) {
334
+ return this.client.request({ ...options, method: "GET", url: `/api/v1/auth/sessions` });
335
+ }
336
+ /**
337
+ * Performs the delete session operation for the auth capability.
338
+ * Calls `DELETE /api/v1/auth/sessions/{session_id}` through the shared IDP-aware Faiber client.
339
+ * @param sessionId Backend path identifier `session_id`.
340
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
341
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
342
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
343
+ */
344
+ authDeleteSessionDelete(sessionId, options) {
345
+ return this.client.request({ ...options, method: "DELETE", url: `/api/v1/auth/sessions/${encodeURIComponent(sessionId)}` });
346
+ }
347
+ /**
348
+ * Performs the login token operation for the auth capability.
349
+ * Calls `GET /api/v1/auth/token-login` through the shared IDP-aware Faiber client.
350
+ * @param params Typed query parameters; omitted members retain backend defaults.
351
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
352
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
353
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
354
+ */
84
355
  authLoginTokenGet(params, options) {
85
356
  return this.client.request({ ...options, method: "GET", url: `/api/v1/auth/token-login`, params });
86
357
  }
87
- /** GET /api/v1/auth/validate; permission: public/session-derived. */
358
+ /**
359
+ * Performs the validate operation for the auth capability.
360
+ * Calls `GET /api/v1/auth/validate` through the shared IDP-aware Faiber client.
361
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
362
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
363
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
364
+ */
88
365
  authValidateGet(options) {
89
366
  return this.client.request({ ...options, method: "GET", url: `/api/v1/auth/validate` });
90
367
  }
91
- /** GET /api/v1/auth/web-login; permission: public/session-derived. */
92
- authLogoutGet(options) {
93
- return this.client.request({ ...options, method: "GET", url: `/api/v1/auth/web-login` });
94
- }
95
- /** POST /api/v1/auth/web-login; permission: public/session-derived. */
368
+ /**
369
+ * Performs the login web operation for the auth capability.
370
+ * Calls `POST /api/v1/auth/web-login` through the shared IDP-aware Faiber client.
371
+ * @param data Typed URL-encoded form.
372
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
373
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
374
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
375
+ */
96
376
  authLoginWebPost(data, options) {
97
377
  return this.client.request({ ...options, method: "POST", url: `/api/v1/auth/web-login`, data: urlEncoded(data), headers: { ...options?.headers, "Content-Type": "application/x-www-form-urlencoded" } });
98
378
  }
99
- /** GET /api/v1/integration/flow; permission: public/session-derived. */
379
+ /**
380
+ * Performs the enroll operation for the identity authority capability.
381
+ * Calls `POST /api/v1/federation/enroll` through the shared IDP-aware Faiber client.
382
+ * @param data Typed JSON request body.
383
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
384
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
385
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
386
+ */
387
+ identityAuthorityEnrollPost(data, options) {
388
+ return this.client.request({ ...options, method: "POST", url: `/api/v1/federation/enroll`, data: data });
389
+ }
390
+ /**
391
+ * Performs the flow integration show operation for the integration capability.
392
+ * Calls `GET /api/v1/integration/flow` through the shared IDP-aware Faiber client.
393
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
394
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
395
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
396
+ */
100
397
  integrationFlowIntegrationShowGet(options) {
101
398
  return this.client.request({ ...options, method: "GET", url: `/api/v1/integration/flow` });
102
399
  }
103
- /** GET /api/v1/settings/oauth; permission: public/session-derived. */
400
+ /**
401
+ * Performs the authorize operation for the oidc capability.
402
+ * Calls `GET /api/v1/oauth2/authorize` through the shared IDP-aware Faiber client.
403
+ * @param params Typed query parameters; omitted members retain backend defaults.
404
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
405
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
406
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
407
+ */
408
+ oidcAuthorizeGet(params, options) {
409
+ return this.client.request({ ...options, method: "GET", url: `/api/v1/oauth2/authorize`, params });
410
+ }
411
+ /**
412
+ * Performs the backchannel logout operation for the oidc capability.
413
+ * Calls `POST /api/v1/oauth2/backchannel-logout` through the shared IDP-aware Faiber client.
414
+ * @param data Typed URL-encoded form.
415
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
416
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
417
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
418
+ */
419
+ oidcBackchannelLogoutPost(data, options) {
420
+ return this.client.request({ ...options, method: "POST", url: `/api/v1/oauth2/backchannel-logout`, data: urlEncoded(data), headers: { ...options?.headers, "Content-Type": "application/x-www-form-urlencoded" } });
421
+ }
422
+ /**
423
+ * Performs the introspect operation for the oidc capability.
424
+ * Calls `POST /api/v1/oauth2/introspect` through the shared IDP-aware Faiber client.
425
+ * @param data Typed URL-encoded form.
426
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
427
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
428
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
429
+ */
430
+ oidcIntrospectPost(data, options) {
431
+ return this.client.request({ ...options, method: "POST", url: `/api/v1/oauth2/introspect`, data: urlEncoded(data), headers: { ...options?.headers, "Content-Type": "application/x-www-form-urlencoded" } });
432
+ }
433
+ /**
434
+ * Performs the jwks operation for the oidc capability.
435
+ * Calls `GET /api/v1/oauth2/jwks` through the shared IDP-aware Faiber client.
436
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
437
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
438
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
439
+ */
440
+ oidcJwksGet(options) {
441
+ return this.client.request({ ...options, method: "GET", url: `/api/v1/oauth2/jwks` });
442
+ }
443
+ /**
444
+ * Performs the logout operation for the oidc capability.
445
+ * Calls `GET /api/v1/oauth2/logout` through the shared IDP-aware Faiber client.
446
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
447
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
448
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
449
+ */
450
+ oidcLogoutGet(options) {
451
+ return this.client.request({ ...options, method: "GET", url: `/api/v1/oauth2/logout` });
452
+ }
453
+ /**
454
+ * Performs the logout operation for the oidc capability.
455
+ * Calls `POST /api/v1/oauth2/logout` through the shared IDP-aware Faiber client.
456
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
457
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
458
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
459
+ */
460
+ oidcLogoutPost(options) {
461
+ return this.client.request({ ...options, method: "POST", url: `/api/v1/oauth2/logout` });
462
+ }
463
+ /**
464
+ * Performs the revoke operation for the oidc capability.
465
+ * Calls `POST /api/v1/oauth2/revoke` through the shared IDP-aware Faiber client.
466
+ * @param data Typed URL-encoded form.
467
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
468
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
469
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
470
+ */
471
+ oidcRevokePost(data, options) {
472
+ return this.client.request({ ...options, method: "POST", url: `/api/v1/oauth2/revoke`, data: urlEncoded(data), headers: { ...options?.headers, "Content-Type": "application/x-www-form-urlencoded" } });
473
+ }
474
+ /**
475
+ * Performs the token operation for the oidc capability.
476
+ * Calls `POST /api/v1/oauth2/token` through the shared IDP-aware Faiber client.
477
+ * @param data Typed URL-encoded form.
478
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
479
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
480
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
481
+ */
482
+ oidcTokenPost(data, options) {
483
+ return this.client.request({ ...options, method: "POST", url: `/api/v1/oauth2/token`, data: urlEncoded(data), headers: { ...options?.headers, "Content-Type": "application/x-www-form-urlencoded" } });
484
+ }
485
+ /**
486
+ * Performs the userinfo operation for the oidc capability.
487
+ * Calls `GET /api/v1/oauth2/userinfo` through the shared IDP-aware Faiber client.
488
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
489
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
490
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
491
+ */
492
+ oidcUserinfoGet(options) {
493
+ return this.client.request({ ...options, method: "GET", url: `/api/v1/oauth2/userinfo` });
494
+ }
495
+ /**
496
+ * Performs the userinfo operation for the oidc capability.
497
+ * Calls `POST /api/v1/oauth2/userinfo` through the shared IDP-aware Faiber client.
498
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
499
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
500
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
501
+ */
502
+ oidcUserinfoPost(options) {
503
+ return this.client.request({ ...options, method: "POST", url: `/api/v1/oauth2/userinfo` });
504
+ }
505
+ /**
506
+ * Performs the list operation for the custom oauth capability.
507
+ * Calls `GET /api/v1/settings/custom-oauth` through the shared IDP-aware Faiber client.
508
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
509
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
510
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
511
+ */
512
+ customOauthListGet(options) {
513
+ return this.client.request({ ...options, method: "GET", url: `/api/v1/settings/custom-oauth` });
514
+ }
515
+ /**
516
+ * Performs the create operation for the custom oauth capability.
517
+ * Calls `POST /api/v1/settings/custom-oauth` through the shared IDP-aware Faiber client.
518
+ * @param data Typed JSON request body.
519
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
520
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
521
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
522
+ */
523
+ customOauthCreatePost(data, options) {
524
+ return this.client.request({ ...options, method: "POST", url: `/api/v1/settings/custom-oauth`, data: data });
525
+ }
526
+ /**
527
+ * Performs the remove operation for the custom oauth capability.
528
+ * Calls `DELETE /api/v1/settings/custom-oauth/{id}` through the shared IDP-aware Faiber client.
529
+ * @param id Backend path identifier `id`.
530
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
531
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
532
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
533
+ */
534
+ customOauthRemoveDelete(id, options) {
535
+ return this.client.request({ ...options, method: "DELETE", url: `/api/v1/settings/custom-oauth/${encodeURIComponent(id)}` });
536
+ }
537
+ /**
538
+ * Performs the update operation for the custom oauth capability.
539
+ * Calls `PUT /api/v1/settings/custom-oauth/{id}` through the shared IDP-aware Faiber client.
540
+ * @param id Backend path identifier `id`.
541
+ * @param data Typed JSON request body.
542
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
543
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
544
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
545
+ */
546
+ customOauthUpdatePut(id, data, options) {
547
+ return this.client.request({ ...options, method: "PUT", url: `/api/v1/settings/custom-oauth/${encodeURIComponent(id)}`, data: data });
548
+ }
549
+ /**
550
+ * Performs the admin show operation for the identity authority capability.
551
+ * Calls `GET /api/v1/settings/identity-authority` through the shared IDP-aware Faiber client.
552
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
553
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
554
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
555
+ */
556
+ identityAuthorityAdminShowGet(options) {
557
+ return this.client.request({ ...options, method: "GET", url: `/api/v1/settings/identity-authority` });
558
+ }
559
+ /**
560
+ * Performs the update operation for the identity authority capability.
561
+ * Calls `PUT /api/v1/settings/identity-authority` through the shared IDP-aware Faiber client.
562
+ * @param data Typed JSON request body.
563
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
564
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
565
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
566
+ */
567
+ identityAuthorityUpdatePut(data, options) {
568
+ return this.client.request({ ...options, method: "PUT", url: `/api/v1/settings/identity-authority`, data: data });
569
+ }
570
+ /**
571
+ * Performs the discover operation for the identity authority capability.
572
+ * Calls `POST /api/v1/settings/identity-authority/discover` through the shared IDP-aware Faiber client.
573
+ * @param data Typed JSON request body.
574
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
575
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
576
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
577
+ */
578
+ identityAuthorityDiscoverPost(data, options) {
579
+ return this.client.request({ ...options, method: "POST", url: `/api/v1/settings/identity-authority/discover`, data: data });
580
+ }
581
+ /**
582
+ * Performs the pair canonical operation for the identity authority capability.
583
+ * Calls `POST /api/v1/settings/identity-authority/pair` through the shared IDP-aware Faiber client.
584
+ * @param data Typed JSON request body.
585
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
586
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
587
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
588
+ */
589
+ identityAuthorityPairCanonicalPost(data, options) {
590
+ return this.client.request({ ...options, method: "POST", url: `/api/v1/settings/identity-authority/pair`, data: data });
591
+ }
592
+ /**
593
+ * Performs the create pairing invitation operation for the identity authority capability.
594
+ * Calls `POST /api/v1/settings/identity-authority/pairing-invitations` through the shared IDP-aware Faiber client.
595
+ * @param data Typed JSON request body.
596
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
597
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
598
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
599
+ */
600
+ identityAuthorityCreatePairingInvitationPost(data, options) {
601
+ return this.client.request({ ...options, method: "POST", url: `/api/v1/settings/identity-authority/pairing-invitations`, data: data });
602
+ }
603
+ /**
604
+ * Performs the oauth settings show operation for the settings capability.
605
+ * Calls `GET /api/v1/settings/oauth` through the shared IDP-aware Faiber client.
606
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
607
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
608
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
609
+ */
104
610
  settingsOauthSettingsShowGet(options) {
105
611
  return this.client.request({ ...options, method: "GET", url: `/api/v1/settings/oauth` });
106
612
  }
107
- /** PUT /api/v1/settings/oauth; permission: public/session-derived. */
613
+ /**
614
+ * Performs the oauth settings update operation for the settings capability.
615
+ * Calls `PUT /api/v1/settings/oauth` through the shared IDP-aware Faiber client.
616
+ * @param data Typed JSON request body.
617
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
618
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
619
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
620
+ */
108
621
  settingsOauthSettingsUpdatePut(data, options) {
109
622
  return this.client.request({ ...options, method: "PUT", url: `/api/v1/settings/oauth`, data: data });
110
623
  }
111
- /** GET /api/v1/users; permission: public/session-derived. */
624
+ /**
625
+ * Performs the list operation for the oauth clients capability.
626
+ * Calls `GET /api/v1/settings/oauth-clients` through the shared IDP-aware Faiber client.
627
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
628
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
629
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
630
+ */
631
+ oauthClientsListGet(options) {
632
+ return this.client.request({ ...options, method: "GET", url: `/api/v1/settings/oauth-clients` });
633
+ }
634
+ /**
635
+ * Performs the create operation for the oauth clients capability.
636
+ * Calls `POST /api/v1/settings/oauth-clients` through the shared IDP-aware Faiber client.
637
+ * @param data Typed JSON request body.
638
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
639
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
640
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
641
+ */
642
+ oauthClientsCreatePost(data, options) {
643
+ return this.client.request({ ...options, method: "POST", url: `/api/v1/settings/oauth-clients`, data: data });
644
+ }
645
+ /**
646
+ * Performs the remove operation for the oauth clients capability.
647
+ * Calls `DELETE /api/v1/settings/oauth-clients/{id}` through the shared IDP-aware Faiber client.
648
+ * @param id Backend path identifier `id`.
649
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
650
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
651
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
652
+ */
653
+ oauthClientsRemoveDelete(id, options) {
654
+ return this.client.request({ ...options, method: "DELETE", url: `/api/v1/settings/oauth-clients/${encodeURIComponent(id)}` });
655
+ }
656
+ /**
657
+ * Performs the update operation for the oauth clients capability.
658
+ * Calls `PUT /api/v1/settings/oauth-clients/{id}` through the shared IDP-aware Faiber client.
659
+ * @param id Backend path identifier `id`.
660
+ * @param data Typed JSON request body.
661
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
662
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
663
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
664
+ */
665
+ oauthClientsUpdatePut(id, data, options) {
666
+ return this.client.request({ ...options, method: "PUT", url: `/api/v1/settings/oauth-clients/${encodeURIComponent(id)}`, data: data });
667
+ }
668
+ /**
669
+ * Performs the rotate operation for the oauth clients capability.
670
+ * Calls `POST /api/v1/settings/oauth-clients/{id}/rotate-secret` through the shared IDP-aware Faiber client.
671
+ * @param id Backend path identifier `id`.
672
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
673
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
674
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
675
+ */
676
+ oauthClientsRotatePost(id, options) {
677
+ return this.client.request({ ...options, method: "POST", url: `/api/v1/settings/oauth-clients/${encodeURIComponent(id)}/rotate-secret` });
678
+ }
679
+ /**
680
+ * Performs the users index operation for the user capability.
681
+ * Calls `GET /api/v1/users` through the shared IDP-aware Faiber client.
682
+ * @param params Typed query parameters; omitted members retain backend defaults.
683
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
684
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
685
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
686
+ */
112
687
  userUsersIndexGet(params, options) {
113
688
  return this.client.request({ ...options, method: "GET", url: `/api/v1/users`, params });
114
689
  }
115
- /** POST /api/v1/users; permission: public/session-derived. */
690
+ /**
691
+ * Performs the user create operation for the user capability.
692
+ * Calls `POST /api/v1/users` through the shared IDP-aware Faiber client.
693
+ * @param data Typed JSON request body.
694
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
695
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
696
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
697
+ */
116
698
  userUserCreatePost(data, options) {
117
699
  return this.client.request({ ...options, method: "POST", url: `/api/v1/users`, data: data });
118
700
  }
119
- /** DELETE /api/v1/users/{user_id}; permission: public/session-derived. */
701
+ /**
702
+ * Performs the user delete operation for the user capability.
703
+ * Calls `DELETE /api/v1/users/{user_id}` through the shared IDP-aware Faiber client.
704
+ * @param userId Backend path identifier `user_id`.
705
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
706
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
707
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
708
+ */
120
709
  userUserDeleteDelete(userId, options) {
121
710
  return this.client.request({ ...options, method: "DELETE", url: `/api/v1/users/${encodeURIComponent(userId)}` });
122
711
  }
123
- /** GET /api/v1/users/{user_id}; permission: public/session-derived. */
712
+ /**
713
+ * Performs the user find operation for the user capability.
714
+ * Calls `GET /api/v1/users/{user_id}` through the shared IDP-aware Faiber client.
715
+ * @param userId Backend path identifier `user_id`.
716
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
717
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
718
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
719
+ */
124
720
  userUserFindGet(userId, options) {
125
721
  return this.client.request({ ...options, method: "GET", url: `/api/v1/users/${encodeURIComponent(userId)}` });
126
722
  }
127
- /** PATCH /api/v1/users/{user_id}; permission: public/session-derived. */
723
+ /**
724
+ * Performs the user update operation for the user capability.
725
+ * Calls `PATCH /api/v1/users/{user_id}` through the shared IDP-aware Faiber client.
726
+ * @param userId Backend path identifier `user_id`.
727
+ * @param data Typed JSON request body.
728
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
729
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
730
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
731
+ */
128
732
  userUserUpdatePatch(userId, data, options) {
129
733
  return this.client.request({ ...options, method: "PATCH", url: `/api/v1/users/${encodeURIComponent(userId)}`, data: data });
130
734
  }
131
- /** PUT /api/v1/users/{user_id}; permission: public/session-derived. */
735
+ /**
736
+ * Performs the user update operation for the user capability.
737
+ * Calls `PUT /api/v1/users/{user_id}` through the shared IDP-aware Faiber client.
738
+ * @param userId Backend path identifier `user_id`.
739
+ * @param data Typed JSON request body.
740
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
741
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
742
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
743
+ */
132
744
  userUserUpdatePut(userId, data, options) {
133
745
  return this.client.request({ ...options, method: "PUT", url: `/api/v1/users/${encodeURIComponent(userId)}`, data: data });
134
746
  }
135
- /** PATCH /api/v1/users/{user_id}/change-password; permission: public/session-derived. */
747
+ /**
748
+ * Performs the change password operation for the user capability.
749
+ * Calls `PATCH /api/v1/users/{user_id}/change-password` through the shared IDP-aware Faiber client.
750
+ * @param userId Backend path identifier `user_id`.
751
+ * @param data Typed JSON request body.
752
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
753
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
754
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
755
+ */
136
756
  userChangePasswordPatch(userId, data, options) {
137
757
  return this.client.request({ ...options, method: "PATCH", url: `/api/v1/users/${encodeURIComponent(userId)}/change-password`, data: data });
138
758
  }
139
- /** PUT /api/v1/users/{user_id}/change-password; permission: public/session-derived. */
759
+ /**
760
+ * Performs the change password operation for the user capability.
761
+ * Calls `PUT /api/v1/users/{user_id}/change-password` through the shared IDP-aware Faiber client.
762
+ * @param userId Backend path identifier `user_id`.
763
+ * @param data Typed JSON request body.
764
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
765
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
766
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
767
+ */
140
768
  userChangePasswordPut(userId, data, options) {
141
769
  return this.client.request({ ...options, method: "PUT", url: `/api/v1/users/${encodeURIComponent(userId)}/change-password`, data: data });
142
770
  }
143
- /** PATCH /api/v1/users/{user_id}/change-roles; permission: public/session-derived. */
771
+ /**
772
+ * Performs the change roles operation for the user capability.
773
+ * Calls `PATCH /api/v1/users/{user_id}/change-roles` through the shared IDP-aware Faiber client.
774
+ * @param userId Backend path identifier `user_id`.
775
+ * @param data Typed JSON request body.
776
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
777
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
778
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
779
+ */
144
780
  userChangeRolesPatch(userId, data, options) {
145
781
  return this.client.request({ ...options, method: "PATCH", url: `/api/v1/users/${encodeURIComponent(userId)}/change-roles`, data: data });
146
782
  }
147
- /** PUT /api/v1/users/{user_id}/change-roles; permission: public/session-derived. */
783
+ /**
784
+ * Performs the change roles operation for the user capability.
785
+ * Calls `PUT /api/v1/users/{user_id}/change-roles` through the shared IDP-aware Faiber client.
786
+ * @param userId Backend path identifier `user_id`.
787
+ * @param data Typed JSON request body.
788
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
789
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
790
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
791
+ */
148
792
  userChangeRolesPut(userId, data, options) {
149
793
  return this.client.request({ ...options, method: "PUT", url: `/api/v1/users/${encodeURIComponent(userId)}/change-roles`, data: data });
150
794
  }
151
- /** GET /api/v1/users/{user_id}/logout; permission: public/session-derived. */
795
+ /**
796
+ * Performs the user logout operation for the user capability.
797
+ * Calls `GET /api/v1/users/{user_id}/logout` through the shared IDP-aware Faiber client.
798
+ * @param userId Backend path identifier `user_id`.
799
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
800
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
801
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
802
+ */
152
803
  userUserLogoutGet(userId, options) {
153
804
  return this.client.request({ ...options, method: "GET", url: `/api/v1/users/${encodeURIComponent(userId)}/logout` });
154
805
  }
155
- /** PATCH /api/v1/users/{user_id}/status; permission: public/session-derived. */
806
+ /**
807
+ * Performs the user set status operation for the user capability.
808
+ * Calls `PATCH /api/v1/users/{user_id}/status` through the shared IDP-aware Faiber client.
809
+ * @param userId Backend path identifier `user_id`.
810
+ * @param data Typed JSON request body.
811
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
812
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
813
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
814
+ */
156
815
  userUserSetStatusPatch(userId, data, options) {
157
816
  return this.client.request({ ...options, method: "PATCH", url: `/api/v1/users/${encodeURIComponent(userId)}/status`, data: data });
158
817
  }
159
- /** PUT /api/v1/users/{user_id}/status; permission: public/session-derived. */
818
+ /**
819
+ * Performs the user set status operation for the user capability.
820
+ * Calls `PUT /api/v1/users/{user_id}/status` through the shared IDP-aware Faiber client.
821
+ * @param userId Backend path identifier `user_id`.
822
+ * @param data Typed JSON request body.
823
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
824
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
825
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
826
+ */
160
827
  userUserSetStatusPut(userId, data, options) {
161
828
  return this.client.request({ ...options, method: "PUT", url: `/api/v1/users/${encodeURIComponent(userId)}/status`, data: data });
162
829
  }
163
- /** POST /api/v1/users/register; permission: public/session-derived. */
830
+ /**
831
+ * Performs the users directory operation for the user capability.
832
+ * Calls `GET /api/v1/users/directory` through the shared IDP-aware Faiber client.
833
+ * @param params Typed query parameters; omitted members retain backend defaults.
834
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
835
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
836
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
837
+ */
838
+ userUsersDirectoryGet(params, options) {
839
+ return this.client.request({ ...options, method: "GET", url: `/api/v1/users/directory`, params });
840
+ }
841
+ /**
842
+ * Performs the register operation for the user capability.
843
+ * Calls `POST /api/v1/users/register` through the shared IDP-aware Faiber client.
844
+ * @param data Typed JSON request body.
845
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
846
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
847
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
848
+ */
164
849
  userRegisterPost(data, options) {
165
850
  return this.client.request({ ...options, method: "POST", url: `/api/v1/users/register`, data: data });
166
851
  }
167
- /** POST /api/v1/users/register-email; permission: public/session-derived. */
852
+ /**
853
+ * Performs the register with email operation for the user capability.
854
+ * Calls `POST /api/v1/users/register-email` through the shared IDP-aware Faiber client.
855
+ * @param data Typed JSON request body.
856
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
857
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
858
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
859
+ */
168
860
  userRegisterWithEmailPost(data, options) {
169
861
  return this.client.request({ ...options, method: "POST", url: `/api/v1/users/register-email`, data: data });
170
862
  }
171
- /** POST /api/v1/users/register-phone; permission: public/session-derived. */
863
+ /**
864
+ * Performs the register with phone operation for the user capability.
865
+ * Calls `POST /api/v1/users/register-phone` through the shared IDP-aware Faiber client.
866
+ * @param data Typed JSON request body.
867
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
868
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
869
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
870
+ */
172
871
  userRegisterWithPhonePost(data, options) {
173
872
  return this.client.request({ ...options, method: "POST", url: `/api/v1/users/register-phone`, data: data });
174
873
  }
175
- /** GET /api/v1/users/self; permission: public/session-derived. */
874
+ /**
875
+ * Performs the users registration stats operation for the user capability.
876
+ * Calls `GET /api/v1/users/registration-stats` through the shared IDP-aware Faiber client.
877
+ * @param params Typed query parameters; omitted members retain backend defaults.
878
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
879
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
880
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
881
+ */
882
+ userUsersRegistrationStatsGet(params, options) {
883
+ return this.client.request({ ...options, method: "GET", url: `/api/v1/users/registration-stats`, params });
884
+ }
885
+ /**
886
+ * Performs the user find self operation for the user capability.
887
+ * Calls `GET /api/v1/users/self` through the shared IDP-aware Faiber client.
888
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
889
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
890
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
891
+ */
176
892
  userUserFindSelfGet(options) {
177
893
  return this.client.request({ ...options, method: "GET", url: `/api/v1/users/self` });
178
894
  }
179
- /** GET /api/v1/users/stats; permission: public/session-derived. */
895
+ /**
896
+ * Performs the users stats operation for the user capability.
897
+ * Calls `GET /api/v1/users/stats` through the shared IDP-aware Faiber client.
898
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
899
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
900
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
901
+ */
180
902
  userUsersStatsGet(options) {
181
903
  return this.client.request({ ...options, method: "GET", url: `/api/v1/users/stats` });
182
904
  }
183
- /** GET /api/v1/users/sync; permission: public/session-derived. */
905
+ /**
906
+ * Performs the sync users operation for the user capability.
907
+ * Calls `GET /api/v1/users/sync` through the shared IDP-aware Faiber client.
908
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
909
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
910
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
911
+ */
184
912
  userSyncUsersGet(options) {
185
913
  return this.client.request({ ...options, method: "GET", url: `/api/v1/users/sync` });
186
914
  }