@faiber/faiber-idp 0.2.2 → 0.5.0
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/README.md +5 -4
- package/dist/.tsbuildinfo +1 -1
- package/dist/index.d.ts +4 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +9 -0
- package/dist/index.js.map +1 -1
- package/dist/operations.d.ts +407 -47
- package/dist/operations.d.ts.map +1 -1
- package/dist/operations.js +419 -49
- package/dist/operations.js.map +1 -1
- package/dist/operations.types.d.ts +402 -88
- package/dist/operations.types.d.ts.map +1 -1
- package/dist/types.d.ts +19 -0
- package/dist/types.d.ts.map +1 -1
- package/package.json +2 -2
package/dist/operations.js
CHANGED
|
@@ -1,186 +1,556 @@
|
|
|
1
1
|
import { ServiceApi, urlEncoded } from "@faiber/sdk-core";
|
|
2
2
|
export class IdpOperations extends ServiceApi {
|
|
3
|
-
/**
|
|
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
|
-
/**
|
|
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
|
-
/**
|
|
23
|
+
/**
|
|
24
|
+
* Performs the permissions index operation for the acl capability.
|
|
25
|
+
* Calls `GET /api/v1/acl/permissions` 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
|
+
*/
|
|
12
30
|
aclPermissionsIndexGet(options) {
|
|
13
31
|
return this.client.request({ ...options, method: "GET", url: `/api/v1/acl/permissions` });
|
|
14
32
|
}
|
|
15
|
-
/**
|
|
33
|
+
/**
|
|
34
|
+
* Performs the roles index operation for the acl capability.
|
|
35
|
+
* Calls `GET /api/v1/acl/roles` 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
|
+
*/
|
|
16
40
|
aclRolesIndexGet(options) {
|
|
17
41
|
return this.client.request({ ...options, method: "GET", url: `/api/v1/acl/roles` });
|
|
18
42
|
}
|
|
19
|
-
/**
|
|
43
|
+
/**
|
|
44
|
+
* Performs the roles create operation for the acl capability.
|
|
45
|
+
* Calls `POST /api/v1/acl/roles` through the shared IDP-aware Faiber client.
|
|
46
|
+
* @param data Typed JSON request body.
|
|
47
|
+
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
48
|
+
* @returns The complete Axios response, including the typed service envelope, status, and headers.
|
|
49
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
|
|
50
|
+
*/
|
|
20
51
|
aclRolesCreatePost(data, options) {
|
|
21
52
|
return this.client.request({ ...options, method: "POST", url: `/api/v1/acl/roles`, data: data });
|
|
22
53
|
}
|
|
23
|
-
/**
|
|
54
|
+
/**
|
|
55
|
+
* Performs the roles delete operation for the acl capability.
|
|
56
|
+
* Calls `DELETE /api/v1/acl/roles/{role_id}` through the shared IDP-aware Faiber client.
|
|
57
|
+
* @param roleId Backend path identifier `role_id`.
|
|
58
|
+
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
59
|
+
* @returns The complete Axios response, including the typed service envelope, status, and headers.
|
|
60
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
|
|
61
|
+
*/
|
|
24
62
|
aclRolesDeleteDelete(roleId, options) {
|
|
25
63
|
return this.client.request({ ...options, method: "DELETE", url: `/api/v1/acl/roles/${encodeURIComponent(roleId)}` });
|
|
26
64
|
}
|
|
27
|
-
/**
|
|
65
|
+
/**
|
|
66
|
+
* Performs the roles show operation for the acl capability.
|
|
67
|
+
* Calls `GET /api/v1/acl/roles/{role_id}` through the shared IDP-aware Faiber client.
|
|
68
|
+
* @param roleId Backend path identifier `role_id`.
|
|
69
|
+
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
70
|
+
* @returns The complete Axios response, including the typed service envelope, status, and headers.
|
|
71
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
|
|
72
|
+
*/
|
|
28
73
|
aclRolesShowGet(roleId, options) {
|
|
29
74
|
return this.client.request({ ...options, method: "GET", url: `/api/v1/acl/roles/${encodeURIComponent(roleId)}` });
|
|
30
75
|
}
|
|
31
|
-
/**
|
|
76
|
+
/**
|
|
77
|
+
* Performs the roles update operation for the acl capability.
|
|
78
|
+
* Calls `PATCH /api/v1/acl/roles/{role_id}` through the shared IDP-aware Faiber client.
|
|
79
|
+
* @param roleId Backend path identifier `role_id`.
|
|
80
|
+
* @param data Typed JSON request body.
|
|
81
|
+
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
82
|
+
* @returns The complete Axios response, including the typed service envelope, status, and headers.
|
|
83
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
|
|
84
|
+
*/
|
|
32
85
|
aclRolesUpdatePatch(roleId, data, options) {
|
|
33
86
|
return this.client.request({ ...options, method: "PATCH", url: `/api/v1/acl/roles/${encodeURIComponent(roleId)}`, data: data });
|
|
34
87
|
}
|
|
35
|
-
/**
|
|
88
|
+
/**
|
|
89
|
+
* Performs the roles update operation for the acl capability.
|
|
90
|
+
* Calls `PUT /api/v1/acl/roles/{role_id}` through the shared IDP-aware Faiber client.
|
|
91
|
+
* @param roleId Backend path identifier `role_id`.
|
|
92
|
+
* @param data Typed JSON request body.
|
|
93
|
+
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
94
|
+
* @returns The complete Axios response, including the typed service envelope, status, and headers.
|
|
95
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
|
|
96
|
+
*/
|
|
36
97
|
aclRolesUpdatePut(roleId, data, options) {
|
|
37
98
|
return this.client.request({ ...options, method: "PUT", url: `/api/v1/acl/roles/${encodeURIComponent(roleId)}`, data: data });
|
|
38
99
|
}
|
|
39
|
-
/**
|
|
100
|
+
/**
|
|
101
|
+
* Performs the login account operation for the auth capability.
|
|
102
|
+
* Calls `POST /api/v1/auth/account-login` through the shared IDP-aware Faiber client.
|
|
103
|
+
* @param data Typed URL-encoded form.
|
|
104
|
+
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
105
|
+
* @returns The complete Axios response, including the typed service envelope, status, and headers.
|
|
106
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
|
|
107
|
+
*/
|
|
40
108
|
authLoginAccountPost(data, options) {
|
|
41
109
|
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
110
|
}
|
|
43
|
-
/**
|
|
111
|
+
/**
|
|
112
|
+
* Performs the generate one time token route operation for the auth capability.
|
|
113
|
+
* Calls `POST /api/v1/auth/generate/one-time` through the shared IDP-aware Faiber client.
|
|
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
|
+
*/
|
|
44
118
|
authGenerateOneTimeTokenRoutePost(options) {
|
|
45
119
|
return this.client.request({ ...options, method: "POST", url: `/api/v1/auth/generate/one-time` });
|
|
46
120
|
}
|
|
47
|
-
/**
|
|
121
|
+
/**
|
|
122
|
+
* Performs the list linked identities operation for the auth capability.
|
|
123
|
+
* Calls `GET /api/v1/auth/identities` 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
|
+
*/
|
|
48
128
|
authListLinkedIdentitiesGet(options) {
|
|
49
129
|
return this.client.request({ ...options, method: "GET", url: `/api/v1/auth/identities` });
|
|
50
130
|
}
|
|
51
|
-
/**
|
|
131
|
+
/**
|
|
132
|
+
* Performs the login operation for the auth capability.
|
|
133
|
+
* Calls `POST /api/v1/auth/login` through the shared IDP-aware Faiber client.
|
|
134
|
+
* @param data Typed URL-encoded form.
|
|
135
|
+
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
136
|
+
* @returns The complete Axios response, including the typed service envelope, status, and headers.
|
|
137
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
|
|
138
|
+
*/
|
|
52
139
|
authLoginPost(data, options) {
|
|
53
140
|
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
141
|
}
|
|
55
|
-
/**
|
|
142
|
+
/**
|
|
143
|
+
* Performs the logout operation for the auth capability.
|
|
144
|
+
* Calls `GET /api/v1/auth/logout` through the shared IDP-aware Faiber client.
|
|
145
|
+
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
146
|
+
* @returns The complete Axios response, including the typed service envelope, status, and headers.
|
|
147
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
|
|
148
|
+
*/
|
|
149
|
+
authLogoutGet(options) {
|
|
150
|
+
return this.client.request({ ...options, method: "GET", url: `/api/v1/auth/logout` });
|
|
151
|
+
}
|
|
152
|
+
/**
|
|
153
|
+
* Performs the authorize operation for the auth capability.
|
|
154
|
+
* Calls `GET /api/v1/auth/native/authorize` through the shared IDP-aware Faiber client.
|
|
155
|
+
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
156
|
+
* @returns The complete Axios response, including the typed service envelope, status, and headers.
|
|
157
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
|
|
158
|
+
*/
|
|
159
|
+
authAuthorizeGet(options) {
|
|
160
|
+
return this.client.request({ ...options, method: "GET", url: `/api/v1/auth/native/authorize` });
|
|
161
|
+
}
|
|
162
|
+
/**
|
|
163
|
+
* Performs the token operation for the auth capability.
|
|
164
|
+
* Calls `POST /api/v1/auth/native/token` through the shared IDP-aware Faiber client.
|
|
165
|
+
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
166
|
+
* @returns The complete Axios response, including the typed service envelope, status, and headers.
|
|
167
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
|
|
168
|
+
*/
|
|
169
|
+
authTokenPost(options) {
|
|
170
|
+
return this.client.request({ ...options, method: "POST", url: `/api/v1/auth/native/token` });
|
|
171
|
+
}
|
|
172
|
+
/**
|
|
173
|
+
* Performs the oauth unlink operation for the auth capability.
|
|
174
|
+
* Calls `DELETE /api/v1/auth/oauth/{provider}` through the shared IDP-aware Faiber client.
|
|
175
|
+
* @param provider Backend path identifier `provider`.
|
|
176
|
+
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
177
|
+
* @returns The complete Axios response, including the typed service envelope, status, and headers.
|
|
178
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
|
|
179
|
+
*/
|
|
56
180
|
authOauthUnlinkDelete(provider, options) {
|
|
57
181
|
return this.client.request({ ...options, method: "DELETE", url: `/api/v1/auth/oauth/${encodeURIComponent(provider)}` });
|
|
58
182
|
}
|
|
59
|
-
/**
|
|
183
|
+
/**
|
|
184
|
+
* Performs the oauth start operation for the auth capability.
|
|
185
|
+
* Calls `GET /api/v1/auth/oauth/{provider}` through the shared IDP-aware Faiber client.
|
|
186
|
+
* @param provider Backend path identifier `provider`.
|
|
187
|
+
* @param params Typed query parameters; omitted members retain backend defaults.
|
|
188
|
+
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
189
|
+
* @returns The complete Axios response, including the typed service envelope, status, and headers.
|
|
190
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
|
|
191
|
+
*/
|
|
60
192
|
authOauthStartGet(provider, params, options) {
|
|
61
193
|
return this.client.request({ ...options, method: "GET", url: `/api/v1/auth/oauth/${encodeURIComponent(provider)}`, params });
|
|
62
194
|
}
|
|
63
|
-
/**
|
|
195
|
+
/**
|
|
196
|
+
* Performs the oauth callback operation for the auth capability.
|
|
197
|
+
* Calls `GET /api/v1/auth/oauth/{provider}/callback` through the shared IDP-aware Faiber client.
|
|
198
|
+
* @param provider Backend path identifier `provider`.
|
|
199
|
+
* @param params Typed query parameters; omitted members retain backend defaults.
|
|
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
|
+
*/
|
|
64
204
|
authOauthCallbackGet(provider, params, options) {
|
|
65
205
|
return this.client.request({ ...options, method: "GET", url: `/api/v1/auth/oauth/${encodeURIComponent(provider)}/callback`, params });
|
|
66
206
|
}
|
|
67
|
-
/**
|
|
207
|
+
/**
|
|
208
|
+
* Performs the oauth providers operation for the auth capability.
|
|
209
|
+
* Calls `GET /api/v1/auth/oauth/providers` through the shared IDP-aware Faiber client.
|
|
210
|
+
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
211
|
+
* @returns The complete Axios response, including the typed service envelope, status, and headers.
|
|
212
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
|
|
213
|
+
*/
|
|
68
214
|
authOauthProvidersGet(options) {
|
|
69
215
|
return this.client.request({ ...options, method: "GET", url: `/api/v1/auth/oauth/providers` });
|
|
70
216
|
}
|
|
71
|
-
/**
|
|
217
|
+
/**
|
|
218
|
+
* Performs the otp login operation for the auth capability.
|
|
219
|
+
* Calls `POST /api/v1/auth/otp-login` through the shared IDP-aware Faiber client.
|
|
220
|
+
* @param data Typed URL-encoded form.
|
|
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
|
+
*/
|
|
72
225
|
authOtpLoginPost(data, options) {
|
|
73
226
|
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
227
|
}
|
|
75
|
-
/**
|
|
228
|
+
/**
|
|
229
|
+
* Performs the refresh token operation for the auth capability.
|
|
230
|
+
* Calls `GET /api/v1/auth/refresh` through the shared IDP-aware Faiber client.
|
|
231
|
+
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
232
|
+
* @returns The complete Axios response, including the typed service envelope, status, and headers.
|
|
233
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
|
|
234
|
+
*/
|
|
76
235
|
authRefreshTokenGet(options) {
|
|
77
236
|
return this.client.request({ ...options, method: "GET", url: `/api/v1/auth/refresh` });
|
|
78
237
|
}
|
|
79
|
-
/**
|
|
238
|
+
/**
|
|
239
|
+
* Performs the generate secure one time token route operation for the auth capability.
|
|
240
|
+
* Calls `POST /api/v1/auth/secure/generate/one-time` through the shared IDP-aware Faiber client.
|
|
241
|
+
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
242
|
+
* @returns The complete Axios response, including the typed service envelope, status, and headers.
|
|
243
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
|
|
244
|
+
*/
|
|
80
245
|
authGenerateSecureOneTimeTokenRoutePost(options) {
|
|
81
246
|
return this.client.request({ ...options, method: "POST", url: `/api/v1/auth/secure/generate/one-time` });
|
|
82
247
|
}
|
|
83
|
-
/**
|
|
248
|
+
/**
|
|
249
|
+
* Performs the list sessions operation for the auth capability.
|
|
250
|
+
* Calls `GET /api/v1/auth/sessions` through the shared IDP-aware Faiber client.
|
|
251
|
+
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
252
|
+
* @returns The complete Axios response, including the typed service envelope, status, and headers.
|
|
253
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
|
|
254
|
+
*/
|
|
255
|
+
authListSessionsGet(options) {
|
|
256
|
+
return this.client.request({ ...options, method: "GET", url: `/api/v1/auth/sessions` });
|
|
257
|
+
}
|
|
258
|
+
/**
|
|
259
|
+
* Performs the delete session operation for the auth capability.
|
|
260
|
+
* Calls `DELETE /api/v1/auth/sessions/{session_id}` through the shared IDP-aware Faiber client.
|
|
261
|
+
* @param sessionId Backend path identifier `session_id`.
|
|
262
|
+
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
263
|
+
* @returns The complete Axios response, including the typed service envelope, status, and headers.
|
|
264
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
|
|
265
|
+
*/
|
|
266
|
+
authDeleteSessionDelete(sessionId, options) {
|
|
267
|
+
return this.client.request({ ...options, method: "DELETE", url: `/api/v1/auth/sessions/${encodeURIComponent(sessionId)}` });
|
|
268
|
+
}
|
|
269
|
+
/**
|
|
270
|
+
* Performs the login token operation for the auth capability.
|
|
271
|
+
* Calls `GET /api/v1/auth/token-login` through the shared IDP-aware Faiber client.
|
|
272
|
+
* @param params Typed query parameters; omitted members retain backend defaults.
|
|
273
|
+
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
274
|
+
* @returns The complete Axios response, including the typed service envelope, status, and headers.
|
|
275
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
|
|
276
|
+
*/
|
|
84
277
|
authLoginTokenGet(params, options) {
|
|
85
278
|
return this.client.request({ ...options, method: "GET", url: `/api/v1/auth/token-login`, params });
|
|
86
279
|
}
|
|
87
|
-
/**
|
|
280
|
+
/**
|
|
281
|
+
* Performs the validate operation for the auth capability.
|
|
282
|
+
* Calls `GET /api/v1/auth/validate` through the shared IDP-aware Faiber client.
|
|
283
|
+
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
284
|
+
* @returns The complete Axios response, including the typed service envelope, status, and headers.
|
|
285
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
|
|
286
|
+
*/
|
|
88
287
|
authValidateGet(options) {
|
|
89
288
|
return this.client.request({ ...options, method: "GET", url: `/api/v1/auth/validate` });
|
|
90
289
|
}
|
|
91
|
-
/**
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
290
|
+
/**
|
|
291
|
+
* Performs the login web operation for the auth capability.
|
|
292
|
+
* Calls `POST /api/v1/auth/web-login` through the shared IDP-aware Faiber client.
|
|
293
|
+
* @param data Typed URL-encoded form.
|
|
294
|
+
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
295
|
+
* @returns The complete Axios response, including the typed service envelope, status, and headers.
|
|
296
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
|
|
297
|
+
*/
|
|
96
298
|
authLoginWebPost(data, options) {
|
|
97
299
|
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
300
|
}
|
|
99
|
-
/**
|
|
301
|
+
/**
|
|
302
|
+
* Performs the flow integration show operation for the integration capability.
|
|
303
|
+
* Calls `GET /api/v1/integration/flow` through the shared IDP-aware Faiber client.
|
|
304
|
+
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
305
|
+
* @returns The complete Axios response, including the typed service envelope, status, and headers.
|
|
306
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
|
|
307
|
+
*/
|
|
100
308
|
integrationFlowIntegrationShowGet(options) {
|
|
101
309
|
return this.client.request({ ...options, method: "GET", url: `/api/v1/integration/flow` });
|
|
102
310
|
}
|
|
103
|
-
/**
|
|
311
|
+
/**
|
|
312
|
+
* Performs the oauth settings show operation for the settings capability.
|
|
313
|
+
* Calls `GET /api/v1/settings/oauth` through the shared IDP-aware Faiber client.
|
|
314
|
+
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
315
|
+
* @returns The complete Axios response, including the typed service envelope, status, and headers.
|
|
316
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
|
|
317
|
+
*/
|
|
104
318
|
settingsOauthSettingsShowGet(options) {
|
|
105
319
|
return this.client.request({ ...options, method: "GET", url: `/api/v1/settings/oauth` });
|
|
106
320
|
}
|
|
107
|
-
/**
|
|
321
|
+
/**
|
|
322
|
+
* Performs the oauth settings update operation for the settings capability.
|
|
323
|
+
* Calls `PUT /api/v1/settings/oauth` through the shared IDP-aware Faiber client.
|
|
324
|
+
* @param data Typed JSON request body.
|
|
325
|
+
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
326
|
+
* @returns The complete Axios response, including the typed service envelope, status, and headers.
|
|
327
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
|
|
328
|
+
*/
|
|
108
329
|
settingsOauthSettingsUpdatePut(data, options) {
|
|
109
330
|
return this.client.request({ ...options, method: "PUT", url: `/api/v1/settings/oauth`, data: data });
|
|
110
331
|
}
|
|
111
|
-
/**
|
|
332
|
+
/**
|
|
333
|
+
* Performs the users index operation for the user capability.
|
|
334
|
+
* Calls `GET /api/v1/users` through the shared IDP-aware Faiber client.
|
|
335
|
+
* @param params Typed query parameters; omitted members retain backend defaults.
|
|
336
|
+
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
337
|
+
* @returns The complete Axios response, including the typed service envelope, status, and headers.
|
|
338
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
|
|
339
|
+
*/
|
|
112
340
|
userUsersIndexGet(params, options) {
|
|
113
341
|
return this.client.request({ ...options, method: "GET", url: `/api/v1/users`, params });
|
|
114
342
|
}
|
|
115
|
-
/**
|
|
343
|
+
/**
|
|
344
|
+
* Performs the user create operation for the user capability.
|
|
345
|
+
* Calls `POST /api/v1/users` through the shared IDP-aware Faiber client.
|
|
346
|
+
* @param data Typed JSON request body.
|
|
347
|
+
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
348
|
+
* @returns The complete Axios response, including the typed service envelope, status, and headers.
|
|
349
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
|
|
350
|
+
*/
|
|
116
351
|
userUserCreatePost(data, options) {
|
|
117
352
|
return this.client.request({ ...options, method: "POST", url: `/api/v1/users`, data: data });
|
|
118
353
|
}
|
|
119
|
-
/**
|
|
354
|
+
/**
|
|
355
|
+
* Performs the user delete operation for the user capability.
|
|
356
|
+
* Calls `DELETE /api/v1/users/{user_id}` through the shared IDP-aware Faiber client.
|
|
357
|
+
* @param userId Backend path identifier `user_id`.
|
|
358
|
+
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
359
|
+
* @returns The complete Axios response, including the typed service envelope, status, and headers.
|
|
360
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
|
|
361
|
+
*/
|
|
120
362
|
userUserDeleteDelete(userId, options) {
|
|
121
363
|
return this.client.request({ ...options, method: "DELETE", url: `/api/v1/users/${encodeURIComponent(userId)}` });
|
|
122
364
|
}
|
|
123
|
-
/**
|
|
365
|
+
/**
|
|
366
|
+
* Performs the user find operation for the user capability.
|
|
367
|
+
* Calls `GET /api/v1/users/{user_id}` through the shared IDP-aware Faiber client.
|
|
368
|
+
* @param userId Backend path identifier `user_id`.
|
|
369
|
+
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
370
|
+
* @returns The complete Axios response, including the typed service envelope, status, and headers.
|
|
371
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
|
|
372
|
+
*/
|
|
124
373
|
userUserFindGet(userId, options) {
|
|
125
374
|
return this.client.request({ ...options, method: "GET", url: `/api/v1/users/${encodeURIComponent(userId)}` });
|
|
126
375
|
}
|
|
127
|
-
/**
|
|
376
|
+
/**
|
|
377
|
+
* Performs the user update operation for the user capability.
|
|
378
|
+
* Calls `PATCH /api/v1/users/{user_id}` through the shared IDP-aware Faiber client.
|
|
379
|
+
* @param userId Backend path identifier `user_id`.
|
|
380
|
+
* @param data Typed JSON request body.
|
|
381
|
+
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
382
|
+
* @returns The complete Axios response, including the typed service envelope, status, and headers.
|
|
383
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
|
|
384
|
+
*/
|
|
128
385
|
userUserUpdatePatch(userId, data, options) {
|
|
129
386
|
return this.client.request({ ...options, method: "PATCH", url: `/api/v1/users/${encodeURIComponent(userId)}`, data: data });
|
|
130
387
|
}
|
|
131
|
-
/**
|
|
388
|
+
/**
|
|
389
|
+
* Performs the user update operation for the user capability.
|
|
390
|
+
* Calls `PUT /api/v1/users/{user_id}` through the shared IDP-aware Faiber client.
|
|
391
|
+
* @param userId Backend path identifier `user_id`.
|
|
392
|
+
* @param data Typed JSON request body.
|
|
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
|
+
*/
|
|
132
397
|
userUserUpdatePut(userId, data, options) {
|
|
133
398
|
return this.client.request({ ...options, method: "PUT", url: `/api/v1/users/${encodeURIComponent(userId)}`, data: data });
|
|
134
399
|
}
|
|
135
|
-
/**
|
|
400
|
+
/**
|
|
401
|
+
* Performs the change password operation for the user capability.
|
|
402
|
+
* Calls `PATCH /api/v1/users/{user_id}/change-password` through the shared IDP-aware Faiber client.
|
|
403
|
+
* @param userId Backend path identifier `user_id`.
|
|
404
|
+
* @param data Typed JSON request body.
|
|
405
|
+
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
406
|
+
* @returns The complete Axios response, including the typed service envelope, status, and headers.
|
|
407
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
|
|
408
|
+
*/
|
|
136
409
|
userChangePasswordPatch(userId, data, options) {
|
|
137
410
|
return this.client.request({ ...options, method: "PATCH", url: `/api/v1/users/${encodeURIComponent(userId)}/change-password`, data: data });
|
|
138
411
|
}
|
|
139
|
-
/**
|
|
412
|
+
/**
|
|
413
|
+
* Performs the change password operation for the user capability.
|
|
414
|
+
* Calls `PUT /api/v1/users/{user_id}/change-password` through the shared IDP-aware Faiber client.
|
|
415
|
+
* @param userId Backend path identifier `user_id`.
|
|
416
|
+
* @param data Typed JSON request body.
|
|
417
|
+
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
418
|
+
* @returns The complete Axios response, including the typed service envelope, status, and headers.
|
|
419
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
|
|
420
|
+
*/
|
|
140
421
|
userChangePasswordPut(userId, data, options) {
|
|
141
422
|
return this.client.request({ ...options, method: "PUT", url: `/api/v1/users/${encodeURIComponent(userId)}/change-password`, data: data });
|
|
142
423
|
}
|
|
143
|
-
/**
|
|
424
|
+
/**
|
|
425
|
+
* Performs the change roles operation for the user capability.
|
|
426
|
+
* Calls `PATCH /api/v1/users/{user_id}/change-roles` through the shared IDP-aware Faiber client.
|
|
427
|
+
* @param userId Backend path identifier `user_id`.
|
|
428
|
+
* @param data Typed JSON request body.
|
|
429
|
+
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
430
|
+
* @returns The complete Axios response, including the typed service envelope, status, and headers.
|
|
431
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
|
|
432
|
+
*/
|
|
144
433
|
userChangeRolesPatch(userId, data, options) {
|
|
145
434
|
return this.client.request({ ...options, method: "PATCH", url: `/api/v1/users/${encodeURIComponent(userId)}/change-roles`, data: data });
|
|
146
435
|
}
|
|
147
|
-
/**
|
|
436
|
+
/**
|
|
437
|
+
* Performs the change roles operation for the user capability.
|
|
438
|
+
* Calls `PUT /api/v1/users/{user_id}/change-roles` through the shared IDP-aware Faiber client.
|
|
439
|
+
* @param userId Backend path identifier `user_id`.
|
|
440
|
+
* @param data Typed JSON request body.
|
|
441
|
+
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
442
|
+
* @returns The complete Axios response, including the typed service envelope, status, and headers.
|
|
443
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
|
|
444
|
+
*/
|
|
148
445
|
userChangeRolesPut(userId, data, options) {
|
|
149
446
|
return this.client.request({ ...options, method: "PUT", url: `/api/v1/users/${encodeURIComponent(userId)}/change-roles`, data: data });
|
|
150
447
|
}
|
|
151
|
-
/**
|
|
448
|
+
/**
|
|
449
|
+
* Performs the user logout operation for the user capability.
|
|
450
|
+
* Calls `GET /api/v1/users/{user_id}/logout` through the shared IDP-aware Faiber client.
|
|
451
|
+
* @param userId Backend path identifier `user_id`.
|
|
452
|
+
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
453
|
+
* @returns The complete Axios response, including the typed service envelope, status, and headers.
|
|
454
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
|
|
455
|
+
*/
|
|
152
456
|
userUserLogoutGet(userId, options) {
|
|
153
457
|
return this.client.request({ ...options, method: "GET", url: `/api/v1/users/${encodeURIComponent(userId)}/logout` });
|
|
154
458
|
}
|
|
155
|
-
/**
|
|
459
|
+
/**
|
|
460
|
+
* Performs the user set status operation for the user capability.
|
|
461
|
+
* Calls `PATCH /api/v1/users/{user_id}/status` through the shared IDP-aware Faiber client.
|
|
462
|
+
* @param userId Backend path identifier `user_id`.
|
|
463
|
+
* @param data Typed JSON request body.
|
|
464
|
+
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
465
|
+
* @returns The complete Axios response, including the typed service envelope, status, and headers.
|
|
466
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
|
|
467
|
+
*/
|
|
156
468
|
userUserSetStatusPatch(userId, data, options) {
|
|
157
469
|
return this.client.request({ ...options, method: "PATCH", url: `/api/v1/users/${encodeURIComponent(userId)}/status`, data: data });
|
|
158
470
|
}
|
|
159
|
-
/**
|
|
471
|
+
/**
|
|
472
|
+
* Performs the user set status operation for the user capability.
|
|
473
|
+
* Calls `PUT /api/v1/users/{user_id}/status` through the shared IDP-aware Faiber client.
|
|
474
|
+
* @param userId Backend path identifier `user_id`.
|
|
475
|
+
* @param data Typed JSON request body.
|
|
476
|
+
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
477
|
+
* @returns The complete Axios response, including the typed service envelope, status, and headers.
|
|
478
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
|
|
479
|
+
*/
|
|
160
480
|
userUserSetStatusPut(userId, data, options) {
|
|
161
481
|
return this.client.request({ ...options, method: "PUT", url: `/api/v1/users/${encodeURIComponent(userId)}/status`, data: data });
|
|
162
482
|
}
|
|
163
|
-
/**
|
|
483
|
+
/**
|
|
484
|
+
* Performs the register operation for the user capability.
|
|
485
|
+
* Calls `POST /api/v1/users/register` through the shared IDP-aware Faiber client.
|
|
486
|
+
* @param data Typed JSON request body.
|
|
487
|
+
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
488
|
+
* @returns The complete Axios response, including the typed service envelope, status, and headers.
|
|
489
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
|
|
490
|
+
*/
|
|
164
491
|
userRegisterPost(data, options) {
|
|
165
492
|
return this.client.request({ ...options, method: "POST", url: `/api/v1/users/register`, data: data });
|
|
166
493
|
}
|
|
167
|
-
/**
|
|
494
|
+
/**
|
|
495
|
+
* Performs the register with email operation for the user capability.
|
|
496
|
+
* Calls `POST /api/v1/users/register-email` through the shared IDP-aware Faiber client.
|
|
497
|
+
* @param data Typed JSON request body.
|
|
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
|
+
*/
|
|
168
502
|
userRegisterWithEmailPost(data, options) {
|
|
169
503
|
return this.client.request({ ...options, method: "POST", url: `/api/v1/users/register-email`, data: data });
|
|
170
504
|
}
|
|
171
|
-
/**
|
|
505
|
+
/**
|
|
506
|
+
* Performs the register with phone operation for the user capability.
|
|
507
|
+
* Calls `POST /api/v1/users/register-phone` through the shared IDP-aware Faiber client.
|
|
508
|
+
* @param data Typed JSON request body.
|
|
509
|
+
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
510
|
+
* @returns The complete Axios response, including the typed service envelope, status, and headers.
|
|
511
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
|
|
512
|
+
*/
|
|
172
513
|
userRegisterWithPhonePost(data, options) {
|
|
173
514
|
return this.client.request({ ...options, method: "POST", url: `/api/v1/users/register-phone`, data: data });
|
|
174
515
|
}
|
|
175
|
-
/**
|
|
516
|
+
/**
|
|
517
|
+
* Performs the users registration stats operation for the user capability.
|
|
518
|
+
* Calls `GET /api/v1/users/registration-stats` through the shared IDP-aware Faiber client.
|
|
519
|
+
* @param params Typed query parameters; omitted members retain backend defaults.
|
|
520
|
+
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
521
|
+
* @returns The complete Axios response, including the typed service envelope, status, and headers.
|
|
522
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
|
|
523
|
+
*/
|
|
524
|
+
userUsersRegistrationStatsGet(params, options) {
|
|
525
|
+
return this.client.request({ ...options, method: "GET", url: `/api/v1/users/registration-stats`, params });
|
|
526
|
+
}
|
|
527
|
+
/**
|
|
528
|
+
* Performs the user find self operation for the user capability.
|
|
529
|
+
* Calls `GET /api/v1/users/self` through the shared IDP-aware Faiber client.
|
|
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
|
+
*/
|
|
176
534
|
userUserFindSelfGet(options) {
|
|
177
535
|
return this.client.request({ ...options, method: "GET", url: `/api/v1/users/self` });
|
|
178
536
|
}
|
|
179
|
-
/**
|
|
537
|
+
/**
|
|
538
|
+
* Performs the users stats operation for the user capability.
|
|
539
|
+
* Calls `GET /api/v1/users/stats` through the shared IDP-aware Faiber client.
|
|
540
|
+
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
541
|
+
* @returns The complete Axios response, including the typed service envelope, status, and headers.
|
|
542
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
|
|
543
|
+
*/
|
|
180
544
|
userUsersStatsGet(options) {
|
|
181
545
|
return this.client.request({ ...options, method: "GET", url: `/api/v1/users/stats` });
|
|
182
546
|
}
|
|
183
|
-
/**
|
|
547
|
+
/**
|
|
548
|
+
* Performs the sync users operation for the user capability.
|
|
549
|
+
* Calls `GET /api/v1/users/sync` through the shared IDP-aware Faiber client.
|
|
550
|
+
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
551
|
+
* @returns The complete Axios response, including the typed service envelope, status, and headers.
|
|
552
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
|
|
553
|
+
*/
|
|
184
554
|
userSyncUsersGet(options) {
|
|
185
555
|
return this.client.request({ ...options, method: "GET", url: `/api/v1/users/sync` });
|
|
186
556
|
}
|