@faiber/faiber-profile 0.24.1 → 1.0.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.
@@ -1,2377 +1,2619 @@
1
1
  import { ServiceApi, urlEncoded } from "@faiber/sdk-core";
2
2
  export class ProfileOperations extends ServiceApi {
3
3
  /**
4
- * Performs the openapi json operation for the router capability.
4
+ * Read raw generated OpenAPI JSON; annotations do not establish complete mounted-route coverage.
5
5
  * Calls `GET /api/openapi.json` through the shared IDP-aware Faiber client.
6
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.
7
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
8
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: no local authentication or permission check; deployment gateway policy is separate.
9
9
  */
10
10
  routerOpenapiJsonGet(options) {
11
11
  return this.client.request({ ...options, method: "GET", url: `/api/openapi.json` });
12
12
  }
13
13
  /**
14
- * Performs the address get operation for the option capability.
14
+ * Read stored addresses by resolving supplied IDP user_ids to Profile UUIDs. The local mount is public.
15
15
  * Calls `POST /api/v1/address/get` through the shared IDP-aware Faiber client.
16
16
  * @param data Typed JSON request body.
17
17
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
18
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
19
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
18
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
19
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: no local authentication or permission check; deployment gateway policy is separate.
20
20
  */
21
21
  optionAddressGetPost(data, options) {
22
22
  return this.client.request({ ...options, method: "POST", url: `/api/v1/address/get`, data: data });
23
23
  }
24
24
  /**
25
- * Performs the get chat context operation for the session capability.
26
- * Calls `GET /api/v1/auth/chat-context` through the shared IDP-aware Faiber client.
25
+ * List all deployment summary configuration rows, newest first.
26
+ * Calls `GET /api/v1/ai-summaries/configurations` through the shared IDP-aware Faiber client.
27
27
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
28
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
29
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
28
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
29
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: IDP-validated Bearer/cookie actor; profile:ai_summary:configure.
30
30
  */
31
- sessionGetChatContextGet(options) {
32
- return this.client.request({ ...options, method: "GET", url: `/api/v1/auth/chat-context` });
31
+ aiSummaryConfigurationsGet(options) {
32
+ return this.client.request({ ...options, method: "GET", url: `/api/v1/ai-summaries/configurations` });
33
33
  }
34
34
  /**
35
- * Performs the get self operation for the session capability.
36
- * Calls `GET /api/v1/auth/self` through the shared IDP-aware Faiber client.
35
+ * Create a role configuration after confirming the IDP role exists; duplicate role configuration returns 409. Success status is 201.
36
+ * Calls `POST /api/v1/ai-summaries/configurations` through the shared IDP-aware Faiber client.
37
+ * @param data Typed JSON request body.
37
38
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
38
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
39
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
39
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
40
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: IDP-validated Bearer/cookie actor; profile:ai_summary:configure.
40
41
  */
41
- sessionGetSelfGet(options) {
42
- return this.client.request({ ...options, method: "GET", url: `/api/v1/auth/self` });
42
+ aiSummaryConfigurationCreatePost(data, options) {
43
+ return this.client.request({ ...options, method: "POST", url: `/api/v1/ai-summaries/configurations`, data: data });
43
44
  }
44
45
  /**
45
- * Performs the update self name operation for the session capability.
46
- * Calls `PATCH /api/v1/auth/self` through the shared IDP-aware Faiber client.
46
+ * Read one deployment configuration row by UUID.
47
+ * Calls `GET /api/v1/ai-summaries/configurations/{id}` through the shared IDP-aware Faiber client.
48
+ * @param id Backend path identifier `id`.
49
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
50
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
51
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: IDP-validated Bearer/cookie actor; profile:ai_summary:configure.
52
+ */
53
+ aiSummaryConfigurationGet(id, options) {
54
+ return this.client.request({ ...options, method: "GET", url: `/api/v1/ai-summaries/configurations/${encodeURIComponent(id)}` });
55
+ }
56
+ /**
57
+ * Replace a configuration draft with required expected_version; role_id is immutable, missing version returns 422, changed version returns 409.
58
+ * Calls `PUT /api/v1/ai-summaries/configurations/{id}` through the shared IDP-aware Faiber client.
59
+ * @param id Backend path identifier `id`.
47
60
  * @param data Typed JSON request body.
48
61
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
49
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
50
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
62
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
63
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: IDP-validated Bearer/cookie actor; profile:ai_summary:configure.
51
64
  */
52
- sessionUpdateSelfNamePatch(data, options) {
53
- return this.client.request({ ...options, method: "PATCH", url: `/api/v1/auth/self`, data: data });
65
+ aiSummaryConfigurationPut(id, data, options) {
66
+ return this.client.request({ ...options, method: "PUT", url: `/api/v1/ai-summaries/configurations/${encodeURIComponent(id)}`, data: data });
54
67
  }
55
68
  /**
56
- * Performs the complete onboarding operation for the session capability.
57
- * Calls `PUT /api/v1/auth/self/onboarding` through the shared IDP-aware Faiber client.
69
+ * Queue an eligible subject draft preview and return job_id/run_id with status 202. Global generation must be on; preview also requires subject read permission. Preview does not publish.
70
+ * Calls `POST /api/v1/ai-summaries/configurations/{id}/preview` through the shared IDP-aware Faiber client.
71
+ * @param id Backend path identifier `id`.
58
72
  * @param data Typed JSON request body.
59
73
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
60
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
61
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
74
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
75
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: IDP-validated Bearer/cookie actor; profile:ai_summary:configure.
62
76
  */
63
- sessionCompleteOnboardingPut(data, options) {
64
- return this.client.request({ ...options, method: "PUT", url: `/api/v1/auth/self/onboarding`, data: data });
77
+ aiSummaryPreviewPost(id, data, options) {
78
+ return this.client.request({ ...options, method: "POST", url: `/api/v1/ai-summaries/configurations/${encodeURIComponent(id)}/preview`, data: data });
65
79
  }
66
80
  /**
67
- * Performs the index operation for the campaign capability.
68
- * Calls `GET /api/v1/campaign` through the shared IDP-aware Faiber client.
81
+ * Publish an immutable next revision using draft version concurrency, then enqueue eligible role members. Duplicate identical publication or changed draft returns 409.
82
+ * Calls `POST /api/v1/ai-summaries/configurations/{id}/publish` through the shared IDP-aware Faiber client.
83
+ * @param id Backend path identifier `id`.
69
84
  * @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.
85
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
86
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: IDP-validated Bearer/cookie actor; profile:ai_summary:configure.
72
87
  */
73
- campaignIndexGet(options) {
74
- return this.client.request({ ...options, method: "GET", url: `/api/v1/campaign` });
88
+ aiSummaryPublishPost(id, options) {
89
+ return this.client.request({ ...options, method: "POST", url: `/api/v1/ai-summaries/configurations/${encodeURIComponent(id)}/publish` });
75
90
  }
76
91
  /**
77
- * Performs the my contributions operation for the campaign capability.
78
- * Calls `GET /api/v1/campaign-profile/me/contributions` through the shared IDP-aware Faiber client.
92
+ * Enable a published role configuration and enqueue eligible subjects, or disable it and cancel its jobs; enabling without a publication returns 409.
93
+ * Calls `PATCH /api/v1/ai-summaries/configurations/{id}/status` through the shared IDP-aware Faiber client.
94
+ * @param id Backend path identifier `id`.
95
+ * @param data Typed JSON request body.
79
96
  * @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.
97
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
98
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: IDP-validated Bearer/cookie actor; profile:ai_summary:configure.
82
99
  */
83
- campaignMyContributionsGet(options) {
84
- return this.client.request({ ...options, method: "GET", url: `/api/v1/campaign-profile/me/contributions` });
100
+ aiSummaryStatusPatch(id, data, options) {
101
+ return this.client.request({ ...options, method: "PATCH", url: `/api/v1/ai-summaries/configurations/${encodeURIComponent(id)}/status`, data: data });
85
102
  }
86
103
  /**
87
- * Performs the show operation for the campaign capability.
88
- * Calls `GET /api/v1/campaign/{id}` through the shared IDP-aware Faiber client.
104
+ * Validate draft formulas, budgets, sources, IDP role and tool-capable model without publishing; invalid drafts return 422.
105
+ * Calls `POST /api/v1/ai-summaries/configurations/{id}/validate` through the shared IDP-aware Faiber client.
89
106
  * @param id Backend path identifier `id`.
90
107
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
91
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
92
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
108
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
109
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: IDP-validated Bearer/cookie actor; profile:ai_summary:configure.
93
110
  */
94
- campaignShowGet(id, options) {
95
- return this.client.request({ ...options, method: "GET", url: `/api/v1/campaign/${encodeURIComponent(id)}` });
111
+ aiSummaryValidatePost(id, options) {
112
+ return this.client.request({ ...options, method: "POST", url: `/api/v1/ai-summaries/configurations/${encodeURIComponent(id)}/validate` });
113
+ }
114
+ /**
115
+ * Page deployment jobs using subject/role/status; defaults 1/25 and caps 100. Preview configuration, lease token and requested_by are withheld.
116
+ * Calls `GET /api/v1/ai-summaries/jobs` through the shared IDP-aware Faiber client.
117
+ * @param params Typed query parameters; omitted members retain backend defaults.
118
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
119
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
120
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: IDP-validated Bearer/cookie actor; profile:ai_summary:manage.
121
+ */
122
+ aiSummaryJobsGet(params, options) {
123
+ return this.client.request({ ...options, method: "GET", url: `/api/v1/ai-summaries/jobs`, params });
96
124
  }
97
125
  /**
98
- * Performs the contribute operation for the campaign capability.
99
- * Calls `POST /api/v1/campaign/{id}/contributions` through the shared IDP-aware Faiber client.
126
+ * Reset a failed reviewable/terminal job for this deployment and return 202. Nonretryable or missing jobs return 409.
127
+ * Calls `POST /api/v1/ai-summaries/jobs/{id}/retry` through the shared IDP-aware Faiber client.
100
128
  * @param id Backend path identifier `id`.
129
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
130
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
131
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: IDP-validated Bearer/cookie actor; profile:ai_summary:manage.
132
+ */
133
+ aiSummaryRetryPost(id, options) {
134
+ return this.client.request({ ...options, method: "POST", url: `/api/v1/ai-summaries/jobs/${encodeURIComponent(id)}/retry` });
135
+ }
136
+ /**
137
+ * Read persisted deployment/subject/role latest state with availability/freshness and nullable job_status. Required role_id; read_own restricts to current subject, read_all permits others. GET never generates.
138
+ * Calls `GET /api/v1/ai-summaries/latest` through the shared IDP-aware Faiber client.
139
+ * @param params Typed query parameters; omitted members retain backend defaults.
140
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
141
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
142
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: IDP-validated Bearer/cookie actor; profile:ai_summary:read_own.
143
+ */
144
+ aiSummaryLatestGet(params, options) {
145
+ return this.client.request({ ...options, method: "GET", url: `/api/v1/ai-summaries/latest`, params });
146
+ }
147
+ /**
148
+ * Read the configured Agentic project-funded model catalog, including tool support.
149
+ * Calls `GET /api/v1/ai-summaries/models` through the shared IDP-aware Faiber client.
150
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
151
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
152
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: IDP-validated Bearer/cookie actor; profile:ai_summary:configure.
153
+ */
154
+ aiSummaryModelsGet(options) {
155
+ return this.client.request({ ...options, method: "GET", url: `/api/v1/ai-summaries/models` });
156
+ }
157
+ /**
158
+ * Queue 1–100 eligible subject-role pairs from published configurations and return 202 with job IDs; global and role generation must be enabled.
159
+ * Calls `POST /api/v1/ai-summaries/refresh` through the shared IDP-aware Faiber client.
101
160
  * @param data Typed JSON request body.
102
161
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
103
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
104
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
162
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
163
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: IDP-validated Bearer/cookie actor; profile:ai_summary:manage.
105
164
  */
106
- campaignContributePost(id, data, options) {
107
- return this.client.request({ ...options, method: "POST", url: `/api/v1/campaign/${encodeURIComponent(id)}/contributions`, data: data });
165
+ aiSummaryRefreshPost(data, options) {
166
+ return this.client.request({ ...options, method: "POST", url: `/api/v1/ai-summaries/refresh`, data: data });
167
+ }
168
+ /**
169
+ * Read IDP role catalog enriched with matching deployment summary configuration IDs/enabled flags.
170
+ * Calls `GET /api/v1/ai-summaries/roles` through the shared IDP-aware Faiber client.
171
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
172
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
173
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: IDP-validated Bearer/cookie actor; profile:ai_summary:configure.
174
+ */
175
+ aiSummaryRolesGet(options) {
176
+ return this.client.request({ ...options, method: "GET", url: `/api/v1/ai-summaries/roles` });
177
+ }
178
+ /**
179
+ * Read a persisted deployment run only with subject read_own/read_all authority.
180
+ * Calls `GET /api/v1/ai-summaries/runs/{id}` through the shared IDP-aware Faiber client.
181
+ * @param id Backend path identifier `id`.
182
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
183
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
184
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: IDP-validated Bearer/cookie actor; profile:ai_summary:read_own.
185
+ */
186
+ aiSummaryRunGet(id, options) {
187
+ return this.client.request({ ...options, method: "GET", url: `/api/v1/ai-summaries/runs/${encodeURIComponent(id)}` });
188
+ }
189
+ /**
190
+ * Read deployment-scoped global generation, concurrency and retention settings; reading does not invoke a model.
191
+ * Calls `GET /api/v1/ai-summaries/settings` through the shared IDP-aware Faiber client.
192
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
193
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
194
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: IDP-validated Bearer/cookie actor; profile:ai_summary:configure.
195
+ */
196
+ aiSummarySettingsGet(options) {
197
+ return this.client.request({ ...options, method: "GET", url: `/api/v1/ai-summaries/settings` });
198
+ }
199
+ /**
200
+ * Set concurrency 1–16 and retention 1–3650 days; disabling generation cancels pending/retry/generating jobs for this deployment.
201
+ * Calls `PUT /api/v1/ai-summaries/settings` through the shared IDP-aware Faiber client.
202
+ * @param data Typed JSON request body.
203
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
204
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
205
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: IDP-validated Bearer/cookie actor; profile:ai_summary:configure.
206
+ */
207
+ aiSummarySettingsPut(data, options) {
208
+ return this.client.request({ ...options, method: "PUT", url: `/api/v1/ai-summaries/settings`, data: data });
209
+ }
210
+ /**
211
+ * Read source capabilities, configured availability and concrete tool input/output JSON schemas.
212
+ * Calls `GET /api/v1/ai-summaries/sources` through the shared IDP-aware Faiber client.
213
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
214
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
215
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: IDP-validated Bearer/cookie actor; profile:ai_summary:configure.
216
+ */
217
+ aiSummarySourcesGet(options) {
218
+ return this.client.request({ ...options, method: "GET", url: `/api/v1/ai-summaries/sources` });
219
+ }
220
+ /**
221
+ * Check an authenticated source adapter through Agentic. Connectivity alone does not establish eligible subject evidence or activate a configuration.
222
+ * Calls `POST /api/v1/ai-summaries/sources/{source}/check` through the shared IDP-aware Faiber client.
223
+ * @param source Backend path identifier `source`.
224
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
225
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
226
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: IDP-validated Bearer/cookie actor; profile:ai_summary:configure.
227
+ */
228
+ aiSummarySourceCheckPost(source, options) {
229
+ return this.client.request({ ...options, method: "POST", url: `/api/v1/ai-summaries/sources/${encodeURIComponent(source)}/check` });
108
230
  }
109
231
  /**
110
- * Performs the index operation for the city capability.
232
+ * Page persisted deployment summary runs using subject/role/status; defaults page=1/per_page=25 with size cap 100. read_own restricts the subject unless read_all is present.
233
+ * Calls `GET /api/v1/ai-summaries/summaries` through the shared IDP-aware Faiber client.
234
+ * @param params Typed query parameters; omitted members retain backend defaults.
235
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
236
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
237
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: IDP-validated Bearer/cookie actor; profile:ai_summary:read_own.
238
+ */
239
+ aiSummarySummariesGet(params, options) {
240
+ return this.client.request({ ...options, method: "GET", url: `/api/v1/ai-summaries/summaries`, params });
241
+ }
242
+ /**
243
+ * Read Chat-scope context: remove id, user_id, properties and services from the profile; return visible properties as a separate object. Office/LMS histories are omitted.
244
+ * Calls `GET /api/v1/auth/chat-context` through the shared IDP-aware Faiber client.
245
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
246
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
247
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: gateway AuthContext; no additional named handler permission check.
248
+ */
249
+ sessionGetChatContextGet(options) {
250
+ return this.client.request({ ...options, method: "GET", url: `/api/v1/auth/chat-context` });
251
+ }
252
+ /**
253
+ * Read current gateway identity roles, permissions and Full-scope profile.
254
+ * Calls `GET /api/v1/auth/self` through the shared IDP-aware Faiber client.
255
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
256
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
257
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: gateway AuthContext; no additional named handler permission check.
258
+ */
259
+ sessionGetSelfGet(options) {
260
+ return this.client.request({ ...options, method: "GET", url: `/api/v1/auth/self` });
261
+ }
262
+ /**
263
+ * Set current identity fa/en name strings; first name must be nonempty, each name at most 100 characters, locale fa/en, and embedded control characters are rejected with 422.
264
+ * Calls `PATCH /api/v1/auth/self` through the shared IDP-aware Faiber client.
265
+ * @param data Typed JSON request body.
266
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
267
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
268
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: gateway AuthContext; no additional named handler permission check.
269
+ */
270
+ sessionUpdateSelfNamePatch(data, options) {
271
+ return this.client.request({ ...options, method: "PATCH", url: `/api/v1/auth/self`, data: data });
272
+ }
273
+ /**
274
+ * Validate age/height/weight/goal, merge onboarding app fields in PostgreSQL, and return the current session. Caller-supplied identity/role fields are rejected.
275
+ * Calls `PUT /api/v1/auth/self/onboarding` through the shared IDP-aware Faiber client.
276
+ * @param data Typed JSON request body.
277
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
278
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
279
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: gateway AuthContext; no additional named handler permission check.
280
+ */
281
+ sessionCompleteOnboardingPut(data, options) {
282
+ return this.client.request({ ...options, method: "PUT", url: `/api/v1/auth/self/onboarding`, data: data });
283
+ }
284
+ /**
285
+ * List the city records. List pagination defaults 1/15 and caps at 100; filters apply before pagination, and deleted records are hidden unless filter[trashed]=only/with.
111
286
  * Calls `GET /api/v1/city` through the shared IDP-aware Faiber client.
112
287
  * @param params Typed query parameters; omitted members retain backend defaults.
113
288
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
114
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
115
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: city:read.
289
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
290
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: declared IDP permission city:read; gateway enforces ACL metadata, local annotation itself is not a permission check.
116
291
  */
117
292
  cityIndexGet(params, options) {
118
293
  return this.client.request({ ...options, method: "GET", url: `/api/v1/city`, params });
119
294
  }
120
295
  /**
121
- * Performs the store operation for the city capability.
296
+ * Create the city record. Local IDs are UUIDs; responses retain the named backend envelope.
122
297
  * Calls `POST /api/v1/city` through the shared IDP-aware Faiber client.
123
298
  * @param data Typed JSON request body.
124
299
  * @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: city:create.
300
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
301
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: declared IDP permission city:create; gateway enforces ACL metadata, local annotation itself is not a permission check.
127
302
  */
128
303
  cityStorePost(data, options) {
129
304
  return this.client.request({ ...options, method: "POST", url: `/api/v1/city`, data: data });
130
305
  }
131
306
  /**
132
- * Performs the destroy operation for the city capability.
307
+ * Soft-delete the city record. Local IDs are UUIDs; responses retain the named backend envelope.
133
308
  * Calls `DELETE /api/v1/city/{id}` through the shared IDP-aware Faiber client.
134
309
  * @param id Backend path identifier `id`.
135
310
  * @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: city:delete.
311
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
312
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: declared IDP permission city:delete; gateway enforces ACL metadata, local annotation itself is not a permission check.
138
313
  */
139
314
  cityDestroyDelete(id, options) {
140
315
  return this.client.request({ ...options, method: "DELETE", url: `/api/v1/city/${encodeURIComponent(id)}` });
141
316
  }
142
317
  /**
143
- * Performs the show operation for the city capability.
318
+ * Read the city record. Local IDs are UUIDs; responses retain the named backend envelope.
144
319
  * Calls `GET /api/v1/city/{id}` through the shared IDP-aware Faiber client.
145
320
  * @param id Backend path identifier `id`.
146
321
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
147
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
148
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: city:read.
322
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
323
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: declared IDP permission city:read; gateway enforces ACL metadata, local annotation itself is not a permission check.
149
324
  */
150
325
  cityShowGet(id, options) {
151
326
  return this.client.request({ ...options, method: "GET", url: `/api/v1/city/${encodeURIComponent(id)}` });
152
327
  }
153
328
  /**
154
- * Performs the update operation for the city capability.
329
+ * Update supplied fields on the city record. Local IDs are UUIDs; responses retain the named backend envelope.
155
330
  * Calls `PATCH /api/v1/city/{id}` through the shared IDP-aware Faiber client.
156
331
  * @param id Backend path identifier `id`.
157
332
  * @param data Typed JSON request body.
158
333
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
159
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
160
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: city:update.
334
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
335
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: declared IDP permission city:update; gateway enforces ACL metadata, local annotation itself is not a permission check.
161
336
  */
162
337
  cityUpdatePatch(id, data, options) {
163
338
  return this.client.request({ ...options, method: "PATCH", url: `/api/v1/city/${encodeURIComponent(id)}`, data: data });
164
339
  }
165
340
  /**
166
- * Performs the update operation for the city capability.
341
+ * Update supplied fields on the city record. Local IDs are UUIDs; responses retain the named backend envelope.
167
342
  * Calls `PUT /api/v1/city/{id}` through the shared IDP-aware Faiber client.
168
343
  * @param id Backend path identifier `id`.
169
344
  * @param data Typed JSON request body.
170
345
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
171
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
172
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: city:update.
346
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
347
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: declared IDP permission city:update; gateway enforces ACL metadata, local annotation itself is not a permission check.
173
348
  */
174
349
  cityUpdatePut(id, data, options) {
175
350
  return this.client.request({ ...options, method: "PUT", url: `/api/v1/city/${encodeURIComponent(id)}`, data: data });
176
351
  }
177
352
  /**
178
- * Performs the force destroy operation for the city capability.
353
+ * Permanently delete the city record. Local IDs are UUIDs; responses retain the named backend envelope.
179
354
  * Calls `DELETE /api/v1/city/force/{id}` through the shared IDP-aware Faiber client.
180
355
  * @param id Backend path identifier `id`.
181
356
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
182
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
183
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: city:delete.
357
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
358
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: declared IDP permission city:delete; gateway enforces ACL metadata, local annotation itself is not a permission check.
184
359
  */
185
360
  cityForceDestroyDelete(id, options) {
186
361
  return this.client.request({ ...options, method: "DELETE", url: `/api/v1/city/force/${encodeURIComponent(id)}` });
187
362
  }
188
363
  /**
189
- * Performs the restore operation for the city capability.
364
+ * Restore the city record. Local IDs are UUIDs; responses retain the named backend envelope.
190
365
  * Calls `GET /api/v1/city/undo/{id}` through the shared IDP-aware Faiber client.
191
366
  * @param id Backend path identifier `id`.
192
367
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
193
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
194
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: city:delete.
368
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
369
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: declared IDP permission city:delete; gateway enforces ACL metadata, local annotation itself is not a permission check.
195
370
  */
196
371
  cityRestoreGet(id, options) {
197
372
  return this.client.request({ ...options, method: "GET", url: `/api/v1/city/undo/${encodeURIComponent(id)}` });
198
373
  }
199
374
  /**
200
- * Performs the index operation for the country capability.
375
+ * List the country records. List pagination defaults 1/15 and caps at 100; filters apply before pagination, and deleted records are hidden unless filter[trashed]=only/with.
201
376
  * Calls `GET /api/v1/country` through the shared IDP-aware Faiber client.
202
377
  * @param params Typed query parameters; omitted members retain backend defaults.
203
378
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
204
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
205
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: country:read.
379
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
380
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: declared IDP permission country:read; gateway enforces ACL metadata, local annotation itself is not a permission check.
206
381
  */
207
382
  countryIndexGet(params, options) {
208
383
  return this.client.request({ ...options, method: "GET", url: `/api/v1/country`, params });
209
384
  }
210
385
  /**
211
- * Performs the store operation for the country capability.
386
+ * Create the country record. Local IDs are UUIDs; responses retain the named backend envelope.
212
387
  * Calls `POST /api/v1/country` through the shared IDP-aware Faiber client.
213
388
  * @param data Typed JSON request body.
214
389
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
215
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
216
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: country:create.
390
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
391
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: declared IDP permission country:create; gateway enforces ACL metadata, local annotation itself is not a permission check.
217
392
  */
218
393
  countryStorePost(data, options) {
219
394
  return this.client.request({ ...options, method: "POST", url: `/api/v1/country`, data: data });
220
395
  }
221
396
  /**
222
- * Performs the destroy operation for the country capability.
397
+ * Soft-delete the country record. Local IDs are UUIDs; responses retain the named backend envelope.
223
398
  * Calls `DELETE /api/v1/country/{id}` through the shared IDP-aware Faiber client.
224
399
  * @param id Backend path identifier `id`.
225
400
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
226
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
227
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: country:delete.
401
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
402
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: declared IDP permission country:delete; gateway enforces ACL metadata, local annotation itself is not a permission check.
228
403
  */
229
404
  countryDestroyDelete(id, options) {
230
405
  return this.client.request({ ...options, method: "DELETE", url: `/api/v1/country/${encodeURIComponent(id)}` });
231
406
  }
232
407
  /**
233
- * Performs the show operation for the country capability.
408
+ * Read the country record. Local IDs are UUIDs; responses retain the named backend envelope.
234
409
  * Calls `GET /api/v1/country/{id}` through the shared IDP-aware Faiber client.
235
410
  * @param id Backend path identifier `id`.
236
411
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
237
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
238
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: country:read.
412
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
413
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: declared IDP permission country:read; gateway enforces ACL metadata, local annotation itself is not a permission check.
239
414
  */
240
415
  countryShowGet(id, options) {
241
416
  return this.client.request({ ...options, method: "GET", url: `/api/v1/country/${encodeURIComponent(id)}` });
242
417
  }
243
418
  /**
244
- * Performs the update operation for the country capability.
419
+ * Update supplied fields on the country record. Local IDs are UUIDs; responses retain the named backend envelope.
245
420
  * Calls `PATCH /api/v1/country/{id}` through the shared IDP-aware Faiber client.
246
421
  * @param id Backend path identifier `id`.
247
422
  * @param data Typed JSON request body.
248
423
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
249
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
250
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: country:update.
424
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
425
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: declared IDP permission country:update; gateway enforces ACL metadata, local annotation itself is not a permission check.
251
426
  */
252
427
  countryUpdatePatch(id, data, options) {
253
428
  return this.client.request({ ...options, method: "PATCH", url: `/api/v1/country/${encodeURIComponent(id)}`, data: data });
254
429
  }
255
430
  /**
256
- * Performs the update operation for the country capability.
431
+ * Update supplied fields on the country record. Local IDs are UUIDs; responses retain the named backend envelope.
257
432
  * Calls `PUT /api/v1/country/{id}` through the shared IDP-aware Faiber client.
258
433
  * @param id Backend path identifier `id`.
259
434
  * @param data Typed JSON request body.
260
435
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
261
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
262
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: country:update.
436
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
437
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: declared IDP permission country:update; gateway enforces ACL metadata, local annotation itself is not a permission check.
263
438
  */
264
439
  countryUpdatePut(id, data, options) {
265
440
  return this.client.request({ ...options, method: "PUT", url: `/api/v1/country/${encodeURIComponent(id)}`, data: data });
266
441
  }
267
442
  /**
268
- * Performs the force destroy operation for the country capability.
443
+ * Permanently delete the country record. Local IDs are UUIDs; responses retain the named backend envelope.
269
444
  * Calls `DELETE /api/v1/country/force/{id}` through the shared IDP-aware Faiber client.
270
445
  * @param id Backend path identifier `id`.
271
446
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
272
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
273
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: country:delete.
447
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
448
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: declared IDP permission country:delete; gateway enforces ACL metadata, local annotation itself is not a permission check.
274
449
  */
275
450
  countryForceDestroyDelete(id, options) {
276
451
  return this.client.request({ ...options, method: "DELETE", url: `/api/v1/country/force/${encodeURIComponent(id)}` });
277
452
  }
278
453
  /**
279
- * Performs the restore operation for the country capability.
454
+ * Restore the country record. Local IDs are UUIDs; responses retain the named backend envelope.
280
455
  * Calls `GET /api/v1/country/undo/{id}` through the shared IDP-aware Faiber client.
281
456
  * @param id Backend path identifier `id`.
282
457
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
283
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
284
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: country:delete.
458
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
459
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: declared IDP permission country:delete; gateway enforces ACL metadata, local annotation itself is not a permission check.
285
460
  */
286
461
  countryRestoreGet(id, options) {
287
462
  return this.client.request({ ...options, method: "GET", url: `/api/v1/country/undo/${encodeURIComponent(id)}` });
288
463
  }
289
464
  /**
290
- * Performs the index operation for the custom type capability.
465
+ * Page undeleted custom types by name; filter[search] is a name substring, defaults 1/15 and size caps 100.
291
466
  * Calls `GET /api/v1/custom-type` through the shared IDP-aware Faiber client.
292
467
  * @param params Typed query parameters; omitted members retain backend defaults.
293
468
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
294
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
295
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
469
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
470
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: gateway AuthContext; no additional named handler permission check.
296
471
  */
297
472
  customTypeIndexGet(params, options) {
298
473
  return this.client.request({ ...options, method: "GET", url: `/api/v1/custom-type`, params });
299
474
  }
300
475
  /**
301
- * Performs the store operation for the custom type capability.
476
+ * Create a custom type with at least one option matching value_type; invalid options return 422 and duplicate names 409. Options may be raw values or {value,code,labels} objects.
302
477
  * Calls `POST /api/v1/custom-type` through the shared IDP-aware Faiber client.
303
478
  * @param data Typed JSON request body.
304
479
  * @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.
480
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
481
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: gateway AuthContext; no additional named handler permission check.
307
482
  */
308
483
  customTypeStorePost(data, options) {
309
484
  return this.client.request({ ...options, method: "POST", url: `/api/v1/custom-type`, data: data });
310
485
  }
311
486
  /**
312
- * Performs the destroy operation for the custom type capability.
487
+ * Soft-delete a custom type; acknowledgement data is an empty object.
313
488
  * Calls `DELETE /api/v1/custom-type/{id}` through the shared IDP-aware Faiber client.
314
489
  * @param id Backend path identifier `id`.
315
490
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
316
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
317
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
491
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
492
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: gateway AuthContext; no additional named handler permission check.
318
493
  */
319
494
  customTypeDestroyDelete(id, options) {
320
495
  return this.client.request({ ...options, method: "DELETE", url: `/api/v1/custom-type/${encodeURIComponent(id)}` });
321
496
  }
322
497
  /**
323
- * Performs the show operation for the custom type capability.
498
+ * Read an undeleted custom type by UUID.
324
499
  * Calls `GET /api/v1/custom-type/{id}` through the shared IDP-aware Faiber client.
325
500
  * @param id Backend path identifier `id`.
326
501
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
327
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
328
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
502
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
503
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: gateway AuthContext; no additional named handler permission check.
329
504
  */
330
505
  customTypeShowGet(id, options) {
331
506
  return this.client.request({ ...options, method: "GET", url: `/api/v1/custom-type/${encodeURIComponent(id)}` });
332
507
  }
333
508
  /**
334
- * Performs the update operation for the custom type capability.
509
+ * Update supplied custom type fields and validate the resulting option list against value_type.
335
510
  * Calls `PATCH /api/v1/custom-type/{id}` through the shared IDP-aware Faiber client.
336
511
  * @param id Backend path identifier `id`.
337
512
  * @param data Typed JSON request body.
338
513
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
339
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
340
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
514
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
515
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: gateway AuthContext; no additional named handler permission check.
341
516
  */
342
517
  customTypeUpdatePatch(id, data, options) {
343
518
  return this.client.request({ ...options, method: "PATCH", url: `/api/v1/custom-type/${encodeURIComponent(id)}`, data: data });
344
519
  }
345
520
  /**
346
- * Performs the dependency operation for the option capability.
521
+ * Read constant gender/status/employee_type choices.
347
522
  * Calls `GET /api/v1/dependency` through the shared IDP-aware Faiber client.
348
523
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
349
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
350
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: dependency:read.
524
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
525
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: declared IDP permission dependency:read; gateway enforces ACL metadata, local annotation itself is not a permission check.
351
526
  */
352
527
  optionDependencyGet(options) {
353
528
  return this.client.request({ ...options, method: "GET", url: `/api/v1/dependency` });
354
529
  }
355
530
  /**
356
- * Performs the index operation for the education capability.
531
+ * List active undeleted education {id,name} options ordered by name/id.
357
532
  * Calls `GET /api/v1/education` through the shared IDP-aware Faiber client.
358
533
  * @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: profile:read.
534
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
535
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: declared IDP permission profile:read; gateway enforces ACL metadata, local annotation itself is not a permission check.
361
536
  */
362
537
  educationIndexGet(options) {
363
538
  return this.client.request({ ...options, method: "GET", url: `/api/v1/education` });
364
539
  }
365
540
  /**
366
- * Performs the store operation for the education capability.
541
+ * Create an education option from a trimmed name containing 1–255 characters; invalid names return 422.
367
542
  * Calls `POST /api/v1/education` through the shared IDP-aware Faiber client.
368
543
  * @param data Typed JSON request body.
369
544
  * @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: profile:update.
545
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
546
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: declared IDP permission profile:update; gateway enforces ACL metadata, local annotation itself is not a permission check.
372
547
  */
373
548
  educationStorePost(data, options) {
374
549
  return this.client.request({ ...options, method: "POST", url: `/api/v1/education`, data: data });
375
550
  }
376
551
  /**
377
- * Performs the dependencies operation for the education capability.
552
+ * Read attendance choices, active referral source codes and level_max_length=64.
378
553
  * Calls `GET /api/v1/education/dependencies` through the shared IDP-aware Faiber client.
379
554
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
380
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
381
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: profile:read.
555
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
556
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: declared IDP permission profile:read; gateway enforces ACL metadata, local annotation itself is not a permission check.
382
557
  */
383
558
  educationDependenciesGet(options) {
384
559
  return this.client.request({ ...options, method: "GET", url: `/api/v1/education/dependencies` });
385
560
  }
386
561
  /**
387
- * Use the paid coaching workflow with server-owned prices, membership and revision checks. Reuse idempotency keys for purchases; stale versions return 409, unauthorized relationships return 403.
562
+ * As fitness admin, import validated active catalog items from an immutable published Knowledge release in one transaction.
388
563
  * Calls `POST /api/v1/fitness/admin/catalog` through the shared IDP-aware Faiber client.
389
564
  * @param data Typed JSON request body.
390
565
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
391
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
392
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: fitness:admin plus administrator role.
566
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
567
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: declared IDP permission fitness:admin; gateway enforces ACL metadata, local annotation itself is not a permission check; operation also enforces its current-member/order/coach/manager role as documented.
393
568
  */
394
569
  fitnessImportCatalogPost(data, options) {
395
570
  return this.client.request({ ...options, method: "POST", url: `/api/v1/fitness/admin/catalog`, data: data });
396
571
  }
397
572
  /**
398
- * Use the paid coaching workflow with server-owned prices, membership and revision checks. Reuse idempotency keys for purchases; stale versions return 409, unauthorized relationships return 403.
573
+ * As fitness admin, idempotently provision the main gym and Asset products. Validate manager/AI-coach profiles and required model/assistant choices; enabling requires a complete catalog.
399
574
  * Calls `POST /api/v1/fitness/admin/provision` through the shared IDP-aware Faiber client.
400
575
  * @param data Typed JSON request body.
401
576
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
402
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
403
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: fitness:admin plus administrator role.
577
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
578
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: declared IDP permission fitness:admin; gateway enforces ACL metadata, local annotation itself is not a permission check; operation also enforces its current-member/order/coach/manager role as documented.
404
579
  */
405
580
  fitnessProvisionPost(data, options) {
406
581
  return this.client.request({ ...options, method: "POST", url: `/api/v1/fitness/admin/provision`, data: data });
407
582
  }
408
583
  /**
409
- * Use the paid coaching workflow with server-owned prices, membership and revision checks. Reuse idempotency keys for purchases; stale versions return 409, unauthorized relationships return 403.
584
+ * Read enabled catalog entries as an enabled member, manager or enabled main-gym coach. kind/category/name query filters apply, offset floors at zero, and at most 100 rows are returned.
410
585
  * Calls `GET /api/v1/fitness/catalog` through the shared IDP-aware Faiber client.
411
586
  * @param params Typed query parameters; omitted members retain backend defaults.
412
587
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
413
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
414
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: authenticated gym membership, manager/coach relationship or owned order as required by the operation.
588
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
589
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: gateway AuthContext; no additional named handler permission check; operation also enforces its current-member/order/coach/manager role as documented.
415
590
  */
416
591
  fitnessListCatalogGet(params, options) {
417
592
  return this.client.request({ ...options, method: "GET", url: `/api/v1/fitness/catalog`, params });
418
593
  }
419
594
  /**
420
- * Use the paid coaching workflow with server-owned prices, membership and revision checks. Reuse idempotency keys for purchases; stale versions return 409, unauthorized relationships return 403.
595
+ * List enabled coaches and enabled published tariffs for the current enabled member gym, with bilingual coach_name.
421
596
  * Calls `GET /api/v1/fitness/coaches` through the shared IDP-aware Faiber client.
422
597
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
423
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
424
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: authenticated gym membership, manager/coach relationship or owned order as required by the operation.
598
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
599
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: gateway AuthContext; no additional named handler permission check; operation also enforces its current-member/order/coach/manager role as documented.
425
600
  */
426
601
  fitnessCoachesGet(options) {
427
602
  return this.client.request({ ...options, method: "GET", url: `/api/v1/fitness/coaches` });
428
603
  }
429
604
  /**
430
- * Use the paid coaching workflow with server-owned prices, membership and revision checks. Reuse idempotency keys for purchases; stale versions return 409, unauthorized relationships return 403.
605
+ * Read current enabled member entitled coaching context, active AI/trial plans, Full-scope profile and compact catalog. Does not accept a target user ID.
431
606
  * Calls `GET /api/v1/fitness/context` through the shared IDP-aware Faiber client.
432
607
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
433
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
434
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: authenticated gym membership, manager/coach relationship or owned order as required by the operation.
608
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
609
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: gateway AuthContext; no additional named handler permission check; operation also enforces its current-member/order/coach/manager role as documented.
435
610
  */
436
611
  fitnessContextGet(options) {
437
612
  return this.client.request({ ...options, method: "GET", url: `/api/v1/fitness/context` });
438
613
  }
439
614
  /**
440
- * Use the paid coaching workflow with server-owned prices, membership and revision checks. Reuse idempotency keys for purchases; stale versions return 409, unauthorized relationships return 403.
615
+ * Read the current enabled member intake draft, or null if no draft exists.
441
616
  * Calls `GET /api/v1/fitness/intake` through the shared IDP-aware Faiber client.
442
617
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
443
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
444
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: authenticated gym membership, manager/coach relationship or owned order as required by the operation.
618
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
619
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: gateway AuthContext; no additional named handler permission check; operation also enforces its current-member/order/coach/manager role as documented.
445
620
  */
446
621
  fitnessIntakeGet(options) {
447
622
  return this.client.request({ ...options, method: "GET", url: `/api/v1/fitness/intake` });
448
623
  }
449
624
  /**
450
- * Use the paid coaching workflow with server-owned prices, membership and revision checks. Reuse idempotency keys for purchases; stale versions return 409, unauthorized relationships return 403.
625
+ * Validate and save current member intake using expected_version; stale versions return 409 and no duplicate draft is created.
451
626
  * Calls `PUT /api/v1/fitness/intake` through the shared IDP-aware Faiber client.
452
627
  * @param data Typed JSON request body.
453
628
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
454
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
455
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: authenticated gym membership, manager/coach relationship or owned order as required by the operation.
629
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
630
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: gateway AuthContext; no additional named handler permission check; operation also enforces its current-member/order/coach/manager role as documented.
456
631
  */
457
632
  fitnessSaveIntakePut(data, options) {
458
633
  return this.client.request({ ...options, method: "PUT", url: `/api/v1/fitness/intake`, data: data });
459
634
  }
460
635
  /**
461
- * Use the paid coaching workflow with server-owned prices, membership and revision checks. Reuse idempotency keys for purchases; stale versions return 409, unauthorized relationships return 403.
636
+ * Read at most 100 unread current-user order events, newest first.
462
637
  * Calls `GET /api/v1/fitness/notifications` through the shared IDP-aware Faiber client.
463
638
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
464
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
465
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: authenticated gym membership, manager/coach relationship or owned order as required by the operation.
639
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
640
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: gateway AuthContext; no additional named handler permission check; operation also enforces its current-member/order/coach/manager role as documented.
466
641
  */
467
642
  fitnessNotificationsGet(options) {
468
643
  return this.client.request({ ...options, method: "GET", url: `/api/v1/fitness/notifications` });
469
644
  }
470
645
  /**
471
- * Use the paid coaching workflow with server-owned prices, membership and revision checks. Reuse idempotency keys for purchases; stale versions return 409, unauthorized relationships return 403.
646
+ * Mark a current-user order notification read; returns {read:true} even when no owned row matched.
472
647
  * Calls `POST /api/v1/fitness/notifications/{id}/read` through the shared IDP-aware Faiber client.
473
648
  * @param id Backend path identifier `id`.
474
649
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
475
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
476
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: authenticated gym membership, manager/coach relationship or owned order as required by the operation.
650
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
651
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: gateway AuthContext; no additional named handler permission check; operation also enforces its current-member/order/coach/manager role as documented.
477
652
  */
478
653
  fitnessReadNotificationPost(id, options) {
479
654
  return this.client.request({ ...options, method: "POST", url: `/api/v1/fitness/notifications/${encodeURIComponent(id)}/read` });
480
655
  }
481
656
  /**
482
- * Use the paid coaching workflow with server-owned prices, membership and revision checks. Reuse idempotency keys for purchases; stale versions return 409, unauthorized relationships return 403.
657
+ * List up to 200 own/assigned/managed orders, or all orders for fitness admin; job_token and model_snapshot are withheld.
483
658
  * Calls `GET /api/v1/fitness/orders` through the shared IDP-aware Faiber client.
484
659
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
485
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
486
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: authenticated gym membership, manager/coach relationship or owned order as required by the operation.
660
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
661
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: gateway AuthContext; no additional named handler permission check; operation also enforces its current-member/order/coach/manager role as documented.
487
662
  */
488
663
  fitnessOrdersGet(options) {
489
664
  return this.client.request({ ...options, method: "GET", url: `/api/v1/fitness/orders` });
490
665
  }
491
666
  /**
492
- * Use the paid coaching workflow with server-owned prices, membership and revision checks. Reuse idempotency keys for purchases; stale versions return 409, unauthorized relationships return 403.
667
+ * Purchase at server-owned prices or selected human tariff. Idempotency UUID is scoped to the current member; conflicting reuse returns 422. Trial bundles consume explicit entitlement; paid orders create Payment transactions.
493
668
  * Calls `POST /api/v1/fitness/orders` through the shared IDP-aware Faiber client.
494
669
  * @param data Typed JSON request body.
495
670
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
496
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
497
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: authenticated gym membership, manager/coach relationship or owned order as required by the operation.
671
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
672
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: gateway AuthContext; no additional named handler permission check; operation also enforces its current-member/order/coach/manager role as documented.
498
673
  */
499
674
  fitnessPurchasePost(data, options) {
500
675
  return this.client.request({ ...options, method: "POST", url: `/api/v1/fitness/orders`, data: data });
501
676
  }
502
677
  /**
503
- * Use the paid coaching workflow with server-owned prices, membership and revision checks. Reuse idempotency keys for purchases; stale versions return 409, unauthorized relationships return 403.
678
+ * Read an authorized order with current plan and pending proposals; owner, selected coach, gym manager or fitness admin may read.
504
679
  * Calls `GET /api/v1/fitness/orders/{id}` through the shared IDP-aware Faiber client.
505
680
  * @param id Backend path identifier `id`.
506
681
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
507
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
508
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: authenticated gym membership, manager/coach relationship or owned order as required by the operation.
682
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
683
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: gateway AuthContext; no additional named handler permission check; operation also enforces its current-member/order/coach/manager role as documented.
509
684
  */
510
685
  fitnessShowGetApiV1FitnessOrdersId(id, options) {
511
686
  return this.client.request({ ...options, method: "GET", url: `/api/v1/fitness/orders/${encodeURIComponent(id)}` });
512
687
  }
513
688
  /**
514
- * Use the paid coaching workflow with server-owned prices, membership and revision checks. Reuse idempotency keys for purchases; stale versions return 409, unauthorized relationships return 403.
689
+ * Apply a versioned order transition: owner retry/retry_payment/refund, selected enabled coach accept/decline. Invalid transitions return 422; stale update returns 409.
515
690
  * Calls `POST /api/v1/fitness/orders/{id}/action` through the shared IDP-aware Faiber client.
516
691
  * @param id Backend path identifier `id`.
517
692
  * @param data Typed JSON request body.
518
693
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
519
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
520
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: authenticated gym membership, manager/coach relationship or owned order as required by the operation.
694
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
695
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: gateway AuthContext; no additional named handler permission check; operation also enforces its current-member/order/coach/manager role as documented.
521
696
  */
522
697
  fitnessActionPost(id, data, options) {
523
698
  return this.client.request({ ...options, method: "POST", url: `/api/v1/fitness/orders/${encodeURIComponent(id)}/action`, data: data });
524
699
  }
525
700
  /**
526
- * Use the paid coaching workflow with server-owned prices, membership and revision checks. Reuse idempotency keys for purchases; stale versions return 409, unauthorized relationships return 403.
701
+ * Assign and activate a validated human coaching plan as the selected enabled coach; base revision detects stale writes.
527
702
  * Calls `POST /api/v1/fitness/orders/{id}/plan` through the shared IDP-aware Faiber client.
528
703
  * @param id Backend path identifier `id`.
529
704
  * @param data Typed JSON request body.
530
705
  * @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: authenticated gym membership, manager/coach relationship or owned order as required by the operation.
706
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
707
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: gateway AuthContext; no additional named handler permission check; operation also enforces its current-member/order/coach/manager role as documented.
533
708
  */
534
709
  fitnessAssignPost(id, data, options) {
535
710
  return this.client.request({ ...options, method: "POST", url: `/api/v1/fitness/orders/${encodeURIComponent(id)}/plan`, data: data });
536
711
  }
537
712
  /**
538
- * Use the paid coaching workflow with server-owned prices, membership and revision checks. Reuse idempotency keys for purchases; stale versions return 409, unauthorized relationships return 403.
713
+ * Read server-owned one-time plan prices in IRR and support credit quotas. Human tariffs and meal upgrades are separate workflows.
539
714
  * Calls `GET /api/v1/fitness/products` through the shared IDP-aware Faiber client.
540
715
  * @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: authenticated gym membership, manager/coach relationship or owned order as required by the operation.
716
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
717
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: gateway AuthContext; no additional named handler permission check; operation also enforces its current-member/order/coach/manager role as documented.
543
718
  */
544
719
  fitnessProductsGet(options) {
545
720
  return this.client.request({ ...options, method: "GET", url: `/api/v1/fitness/products` });
546
721
  }
547
722
  /**
548
- * Use the paid coaching workflow with server-owned prices, membership and revision checks. Reuse idempotency keys for purchases; stale versions return 409, unauthorized relationships return 403.
723
+ * Validate a revision for an owned AI/trial order using base_revision_id; create a proposal without activating it.
549
724
  * Calls `POST /api/v1/fitness/proposals` through the shared IDP-aware Faiber client.
550
725
  * @param data Typed JSON request body.
551
726
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
552
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
553
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: authenticated gym membership, manager/coach relationship or owned order as required by the operation.
727
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
728
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: gateway AuthContext; no additional named handler permission check; operation also enforces its current-member/order/coach/manager role as documented.
554
729
  */
555
730
  fitnessProposePost(data, options) {
556
731
  return this.client.request({ ...options, method: "POST", url: `/api/v1/fitness/proposals`, data: data });
557
732
  }
558
733
  /**
559
- * Use the paid coaching workflow with server-owned prices, membership and revision checks. Reuse idempotency keys for purchases; stale versions return 409, unauthorized relationships return 403.
734
+ * Read a plan revision only after authorizing its owning order.
560
735
  * Calls `GET /api/v1/fitness/revisions/{id}` through the shared IDP-aware Faiber client.
561
736
  * @param id Backend path identifier `id`.
562
737
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
563
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
564
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: authenticated gym membership, manager/coach relationship or owned order as required by the operation.
738
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
739
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: gateway AuthContext; no additional named handler permission check; operation also enforces its current-member/order/coach/manager role as documented.
565
740
  */
566
741
  fitnessRevisionGet(id, options) {
567
742
  return this.client.request({ ...options, method: "GET", url: `/api/v1/fitness/revisions/${encodeURIComponent(id)}` });
568
743
  }
569
744
  /**
570
- * Use the paid coaching workflow with server-owned prices, membership and revision checks. Reuse idempotency keys for purchases; stale versions return 409, unauthorized relationships return 403.
745
+ * As the order owner, accept a proposed revision using its base revision or reject it. Returns a revision receipt on accept and {status:rejected} on rejection.
571
746
  * Calls `POST /api/v1/fitness/revisions/{id}/review` through the shared IDP-aware Faiber client.
572
747
  * @param id Backend path identifier `id`.
573
748
  * @param data Typed JSON request body.
574
749
  * @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: authenticated gym membership, manager/coach relationship or owned order as required by the operation.
750
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
751
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: gateway AuthContext; no additional named handler permission check; operation also enforces its current-member/order/coach/manager role as documented.
577
752
  */
578
753
  fitnessReviewPost(id, data, options) {
579
754
  return this.client.request({ ...options, method: "POST", url: `/api/v1/fitness/revisions/${encodeURIComponent(id)}/review`, data: data });
580
755
  }
581
756
  /**
582
- * Use the paid coaching workflow with server-owned prices, membership and revision checks. Reuse idempotency keys for purchases; stale versions return 409, unauthorized relationships return 403.
757
+ * Read current membership, active plans, manager flag, assistant ID, paid/trial chat balance and optional trial entitlement.
583
758
  * Calls `GET /api/v1/fitness/self` through the shared IDP-aware Faiber client.
584
759
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
585
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
586
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: authenticated gym membership, manager/coach relationship or owned order as required by the operation.
760
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
761
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: gateway AuthContext; no additional named handler permission check; operation also enforces its current-member/order/coach/manager role as documented.
587
762
  */
588
763
  fitnessMeGet(options) {
589
764
  return this.client.request({ ...options, method: "GET", url: `/api/v1/fitness/self` });
590
765
  }
591
766
  /**
592
- * Use the paid coaching workflow with server-owned prices, membership and revision checks. Reuse idempotency keys for purchases; stale versions return 409, unauthorized relationships return 403.
767
+ * Read the main gym configuration as its manager or fitness admin.
593
768
  * Calls `GET /api/v1/fitness/settings` through the shared IDP-aware Faiber client.
594
769
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
595
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
596
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: authenticated gym membership, manager/coach relationship or owned order as required by the operation.
770
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
771
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: gateway AuthContext; no additional named handler permission check; operation also enforces its current-member/order/coach/manager role as documented.
597
772
  */
598
773
  fitnessSettingsGet(options) {
599
774
  return this.client.request({ ...options, method: "GET", url: `/api/v1/fitness/settings` });
600
775
  }
601
776
  /**
602
- * Use the paid coaching workflow with server-owned prices, membership and revision checks. Reuse idempotency keys for purchases; stale versions return 409, unauthorized relationships return 403.
777
+ * Save manager model/STT/TTS selections after Chat validates them; expected_version detects stale configuration with 409.
603
778
  * Calls `PUT /api/v1/fitness/settings` through the shared IDP-aware Faiber client.
604
779
  * @param data Typed JSON request body.
605
780
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
606
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
607
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: authenticated gym membership, manager/coach relationship or owned order as required by the operation.
781
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
782
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: gateway AuthContext; no additional named handler permission check; operation also enforces its current-member/order/coach/manager role as documented.
608
783
  */
609
784
  fitnessSaveSettingsPut(data, options) {
610
785
  return this.client.request({ ...options, method: "PUT", url: `/api/v1/fitness/settings`, data: data });
611
786
  }
612
787
  /**
613
- * Use the paid coaching workflow with server-owned prices, membership and revision checks. Reuse idempotency keys for purchases; stale versions return 409, unauthorized relationships return 403.
788
+ * As manager or the selected coach, validate and version a tariff and publish its Asset product. Expected-version conflicts return 409.
614
789
  * Calls `POST /api/v1/fitness/tariffs` through the shared IDP-aware Faiber client.
615
790
  * @param data Typed JSON request body.
616
791
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
617
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
618
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: authenticated gym membership, manager/coach relationship or owned order as required by the operation.
792
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
793
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: gateway AuthContext; no additional named handler permission check; operation also enforces its current-member/order/coach/manager role as documented.
619
794
  */
620
795
  fitnessSaveTariffPost(data, options) {
621
796
  return this.client.request({ ...options, method: "POST", url: `/api/v1/fitness/tariffs`, data: data });
622
797
  }
623
798
  /**
624
- * Use the paid coaching workflow with server-owned prices, membership and revision checks. Reuse idempotency keys for purchases; stale versions return 409, unauthorized relationships return 403.
799
+ * Read the manager gym coach roster with profile names and tariff snapshots.
625
800
  * Calls `GET /api/v1/fitness/team` through the shared IDP-aware Faiber client.
626
801
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
627
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
628
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: authenticated gym membership, manager/coach relationship or owned order as required by the operation.
802
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
803
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: gateway AuthContext; no additional named handler permission check; operation also enforces its current-member/order/coach/manager role as documented.
629
804
  */
630
805
  fitnessTeamGet(options) {
631
806
  return this.client.request({ ...options, method: "GET", url: `/api/v1/fitness/team` });
632
807
  }
633
808
  /**
634
- * Use the paid coaching workflow with server-owned prices, membership and revision checks. Reuse idempotency keys for purchases; stale versions return 409, unauthorized relationships return 403.
809
+ * As manager, enroll/disable a coach within the same gym after verifying a Profile exists; the AI coach cannot be assigned here.
635
810
  * Calls `PUT /api/v1/fitness/team` through the shared IDP-aware Faiber client.
636
811
  * @param data Typed JSON request body.
637
812
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
638
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
639
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: authenticated gym membership, manager/coach relationship or owned order as required by the operation.
813
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
814
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: gateway AuthContext; no additional named handler permission check; operation also enforces its current-member/order/coach/manager role as documented.
640
815
  */
641
816
  fitnessSaveCoachPut(data, options) {
642
817
  return this.client.request({ ...options, method: "PUT", url: `/api/v1/fitness/team`, data: data });
643
818
  }
644
819
  /**
645
- * Use the paid coaching workflow with server-owned prices, membership and revision checks. Reuse idempotency keys for purchases; stale versions return 409, unauthorized relationships return 403.
820
+ * Redeem a valid gift for an eligible verified new gym member. Returns frozen trial entitlement; duplicate same-gift redemption reuses it, other prior trials are rejected.
646
821
  * Calls `POST /api/v1/fitness/trial/redeem` through the shared IDP-aware Faiber client.
647
822
  * @param data Typed JSON request body.
648
823
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
649
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
650
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: authenticated gym membership, manager/coach relationship or owned order as required by the operation.
824
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
825
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: gateway AuthContext; no additional named handler permission check; operation also enforces its current-member/order/coach/manager role as documented.
651
826
  */
652
827
  fitnessRedeemPost(data, options) {
653
828
  return this.client.request({ ...options, method: "POST", url: `/api/v1/fitness/trial/redeem`, data: data });
654
829
  }
655
830
  /**
656
- * Use the paid coaching workflow with server-owned prices, membership and revision checks. Reuse idempotency keys for purchases; stale versions return 409, unauthorized relationships return 403.
831
+ * Read model/STT/TTS choices and version as an enabled member or manager; payment is not required.
657
832
  * Calls `GET /api/v1/fitness/voice-settings` through the shared IDP-aware Faiber client.
658
833
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
659
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
660
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: authenticated gym membership, manager/coach relationship or owned order as required by the operation.
834
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
835
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: gateway AuthContext; no additional named handler permission check; operation also enforces its current-member/order/coach/manager role as documented.
661
836
  */
662
837
  fitnessVoiceSettingsGet(options) {
663
838
  return this.client.request({ ...options, method: "GET", url: `/api/v1/fitness/voice-settings` });
664
839
  }
665
840
  /**
666
- * Performs the identity operation for the option capability.
841
+ * Read the current gateway identity profile using Get-scope property/service visibility.
667
842
  * Calls `GET /api/v1/identity` through the shared IDP-aware Faiber client.
668
843
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
669
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
670
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
844
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
845
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: gateway AuthContext; no additional named handler permission check.
671
846
  */
672
847
  optionIdentityGet(options) {
673
848
  return this.client.request({ ...options, method: "GET", url: `/api/v1/identity` });
674
849
  }
675
850
  /**
676
- * Performs the integration docs show operation for the integration capability.
851
+ * Read HTTP integration metadata and SDK snippets; optional direct transport fields are omitted when absent.
677
852
  * Calls `GET /api/v1/integration/docs` through the shared IDP-aware Faiber client.
678
853
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
679
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
680
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: admin:integration:read.
854
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
855
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: declared IDP permission admin:integration:read; gateway enforces ACL metadata, local annotation itself is not a permission check.
681
856
  */
682
857
  integrationIntegrationDocsShowGet(options) {
683
858
  return this.client.request({ ...options, method: "GET", url: `/api/v1/integration/docs` });
684
859
  }
685
860
  /**
686
- * Performs the flow integration show operation for the integration capability.
861
+ * Read the broker queue and event payload field metadata for Profile Flow integration; this does not execute workflows.
687
862
  * Calls `GET /api/v1/integration/flow` through the shared IDP-aware Faiber client.
688
863
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
689
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
690
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
864
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
865
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: no local authentication or permission check; deployment gateway policy is separate.
691
866
  */
692
867
  integrationFlowIntegrationShowGet(options) {
693
868
  return this.client.request({ ...options, method: "GET", url: `/api/v1/integration/flow` });
694
869
  }
695
870
  /**
696
- * Performs the reserve operation for the fitness capability.
871
+ * Reserve one response credit for a trusted Chat turn. Locks quota, checks user/turn binding, consumes paid grant or trial balance, and creates a fifteen-minute reservation lease.
697
872
  * Calls `POST /api/v1/internal/fitness-chat/reserve` through the shared IDP-aware Faiber client.
698
873
  * @param data Typed JSON request body.
699
874
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
700
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
701
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: server-only product trial-gift or fitness-chat bearer credential; never browser administration.
875
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
876
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: dedicated FITNESS_CHAT_TOKEN Bearer service credential; user IDP credentials do not satisfy this guard.
702
877
  */
703
878
  fitnessReservePost(data, options) {
704
879
  return this.client.request({ ...options, method: "POST", url: `/api/v1/internal/fitness-chat/reserve`, data: data });
705
880
  }
706
881
  /**
707
- * Performs the settle operation for the fitness capability.
882
+ * Settle a trusted Chat turn with required success: consume a reserved response on success or refund once on failure; already-settled turns are idempotent.
708
883
  * Calls `POST /api/v1/internal/fitness-chat/settle` through the shared IDP-aware Faiber client.
709
884
  * @param data Typed JSON request body.
710
885
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
711
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
712
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: server-only product trial-gift or fitness-chat bearer credential; never browser administration.
886
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
887
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: dedicated FITNESS_CHAT_TOKEN Bearer service credential; user IDP credentials do not satisfy this guard.
713
888
  */
714
889
  fitnessSettlePost(data, options) {
715
890
  return this.client.request({ ...options, method: "POST", url: `/api/v1/internal/fitness-chat/settle`, data: data });
716
891
  }
717
892
  /**
718
- * Performs the list operation for the fitness capability.
893
+ * Read Asset-only trial gifts with page/per_page/search. Defaults 1/25, size caps at 100, page at 100000, and search length at 200. Token hashes are withheld.
719
894
  * Calls `GET /api/v1/internal/plans/gifts` through the shared IDP-aware Faiber client.
720
895
  * @param params Typed query parameters; omitted members retain backend defaults.
721
896
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
722
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
723
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: server-only product trial-gift or fitness-chat bearer credential; never browser administration.
897
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
898
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: dedicated PRODUCT_TRIAL_GIFT_SERVICE_TOKEN Bearer service credential; intended for Asset adapter.
724
899
  */
725
900
  fitnessListGet(params, options) {
726
901
  return this.client.request({ ...options, method: "GET", url: `/api/v1/internal/plans/gifts`, params });
727
902
  }
728
903
  /**
729
- * Performs the create operation for the fitness capability.
904
+ * Create an Asset-only gift idempotently by request_id and created_by. Limits require responses 1–59/plans 1–2; token is returned only on initial creation.
730
905
  * Calls `POST /api/v1/internal/plans/gifts` through the shared IDP-aware Faiber client.
731
906
  * @param data Typed JSON request body.
732
907
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
733
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
734
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: server-only product trial-gift or fitness-chat bearer credential; never browser administration.
908
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
909
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: dedicated PRODUCT_TRIAL_GIFT_SERVICE_TOKEN Bearer service credential; intended for Asset adapter.
735
910
  */
736
911
  fitnessCreatePost(data, options) {
737
912
  return this.client.request({ ...options, method: "POST", url: `/api/v1/internal/plans/gifts`, data: data });
738
913
  }
739
914
  /**
740
- * Performs the show operation for the fitness capability.
915
+ * Read an Asset-only gift record without its token hash.
741
916
  * Calls `GET /api/v1/internal/plans/gifts/{id}` through the shared IDP-aware Faiber client.
742
917
  * @param id Backend path identifier `id`.
743
918
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
744
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
745
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: server-only product trial-gift or fitness-chat bearer credential; never browser administration.
919
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
920
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: dedicated PRODUCT_TRIAL_GIFT_SERVICE_TOKEN Bearer service credential; intended for Asset adapter.
746
921
  */
747
922
  fitnessShowGetApiV1InternalPlansGiftsId(id, options) {
748
923
  return this.client.request({ ...options, method: "GET", url: `/api/v1/internal/plans/gifts/${encodeURIComponent(id)}` });
749
924
  }
750
925
  /**
751
- * Performs the update operation for the fitness capability.
926
+ * Edit future gift redemption settings; existing entitlement remains frozen. max_uses cannot fall below used_count; token rotation is rejected after first redemption.
752
927
  * Calls `PUT /api/v1/internal/plans/gifts/{id}` through the shared IDP-aware Faiber client.
753
928
  * @param id Backend path identifier `id`.
754
929
  * @param data Typed JSON request body.
755
930
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
756
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
757
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: server-only product trial-gift or fitness-chat bearer credential; never browser administration.
931
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
932
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: dedicated PRODUCT_TRIAL_GIFT_SERVICE_TOKEN Bearer service credential; intended for Asset adapter.
758
933
  */
759
934
  fitnessUpdatePut(id, data, options) {
760
935
  return this.client.request({ ...options, method: "PUT", url: `/api/v1/internal/plans/gifts/${encodeURIComponent(id)}`, data: data });
761
936
  }
762
937
  /**
763
- * Performs the store operation for the log action capability.
938
+ * Insert an action/meta audit row and return its stored ID/timestamp. meta is arbitrary JSON.
764
939
  * Calls `POST /api/v1/log-action` through the shared IDP-aware Faiber client.
765
940
  * @param data Typed JSON request body.
766
941
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
767
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
768
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: log_action:create.
942
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
943
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: declared IDP permission log_action:create; gateway enforces ACL metadata, local annotation itself is not a permission check.
769
944
  */
770
945
  logActionStorePost(data, options) {
771
946
  return this.client.request({ ...options, method: "POST", url: `/api/v1/log-action`, data: data });
772
947
  }
773
948
  /**
774
- * Performs the store slug operation for the log action capability.
949
+ * Insert an audit row with the path slug overriding request action; metadata remains arbitrary JSON.
775
950
  * Calls `POST /api/v1/log-action/{slug}` through the shared IDP-aware Faiber client.
776
951
  * @param slug Backend path identifier `slug`.
777
952
  * @param data Typed JSON request body.
778
953
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
779
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
780
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: log_action:create.
954
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
955
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: declared IDP permission log_action:create; gateway enforces ACL metadata, local annotation itself is not a permission check.
781
956
  */
782
957
  logActionStoreSlugPost(slug, data, options) {
783
958
  return this.client.request({ ...options, method: "POST", url: `/api/v1/log-action/${encodeURIComponent(slug)}`, data: data });
784
959
  }
785
960
  /**
786
- * Performs the store direct operation for the log action capability.
961
+ * Insert an audit row through the public direct mount with the path slug overriding request action.
787
962
  * Calls `POST /api/v1/log-action/direct/{slug}` through the shared IDP-aware Faiber client.
788
963
  * @param slug Backend path identifier `slug`.
789
964
  * @param data Typed JSON request body.
790
965
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
791
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
792
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
966
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
967
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: no local authentication or permission check; deployment gateway policy is separate.
793
968
  */
794
969
  logActionStoreDirectPost(slug, data, options) {
795
970
  return this.client.request({ ...options, method: "POST", url: `/api/v1/log-action/direct/${encodeURIComponent(slug)}`, data: data });
796
971
  }
797
972
  /**
798
- * Performs the index operation for the logger capability.
973
+ * Read all stored audit logs without pagination; local router has no authentication middleware. request/response/meta remain arbitrary JSON.
799
974
  * Calls `GET /api/v1/logger` through the shared IDP-aware Faiber client.
800
975
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
801
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
802
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
976
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
977
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: no local authentication or permission check; deployment gateway policy is separate.
803
978
  */
804
979
  loggerIndexGet(options) {
805
980
  return this.client.request({ ...options, method: "GET", url: `/api/v1/logger` });
806
981
  }
807
982
  /**
808
- * Performs the show operation for the logger capability.
983
+ * Read a stored audit log by UUID; missing row returns data:null.
809
984
  * Calls `GET /api/v1/logger/{log}` through the shared IDP-aware Faiber client.
810
985
  * @param log Backend path identifier `log`.
811
986
  * @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.
987
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
988
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: no local authentication or permission check; deployment gateway policy is separate.
814
989
  */
815
990
  loggerShowGet(log, options) {
816
991
  return this.client.request({ ...options, method: "GET", url: `/api/v1/logger/${encodeURIComponent(log)}` });
817
992
  }
818
993
  /**
819
- * Performs the parent children get operation for the option capability.
994
+ * Read children for parent user_ids, merging legacy links with active parent/child relation types and deduplicating pairs. The local mount is public.
820
995
  * Calls `POST /api/v1/parent/children/get` through the shared IDP-aware Faiber client.
821
996
  * @param data Typed JSON request body.
822
997
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
823
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
824
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
998
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
999
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: no local authentication or permission check; deployment gateway policy is separate.
825
1000
  */
826
1001
  optionParentChildrenGetPost(data, options) {
827
1002
  return this.client.request({ ...options, method: "POST", url: `/api/v1/parent/children/get`, data: data });
828
1003
  }
829
1004
  /**
830
- * Performs the parent get operation for the option capability.
1005
+ * Read legacy parent-link rows for student user_ids. The local mount is public.
831
1006
  * Calls `POST /api/v1/parent/get` through the shared IDP-aware Faiber client.
832
1007
  * @param data Typed JSON request body.
833
1008
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
834
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
835
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
1009
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
1010
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: no local authentication or permission check; deployment gateway policy is separate.
836
1011
  */
837
1012
  optionParentGetPost(data, options) {
838
1013
  return this.client.request({ ...options, method: "POST", url: `/api/v1/parent/get`, data: data });
839
1014
  }
840
1015
  /**
841
- * Performs the index operation for the profile capability.
1016
+ * List undeleted profiles with role, active-enrollment, status, normalized literal identity search and dynamic filters applied before pagination. Defaults page=1/per_page=15; per_page caps at 100. filter[trashed] is accepted but does not expose deleted profiles.
842
1017
  * Calls `GET /api/v1/profile` through the shared IDP-aware Faiber client.
843
1018
  * Supports live core/property/trusted-event filters, repeated date ranges and sorting before pagination; invalid clauses return HTTP 400.
844
1019
  * @param params Typed query parameters; omitted members retain backend defaults.
845
1020
  * @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: /api/v1/profile, profile:read.
1021
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
1022
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: declared IDP permission profile:read; gateway enforces ACL metadata, local annotation itself is not a permission check.
848
1023
  */
849
1024
  profileIndexGet(params, options) {
850
1025
  return this.client.request({ ...options, method: "GET", url: `/api/v1/profile`, params });
851
1026
  }
852
1027
  /**
853
- * Performs the avatar show operation for the profile capability.
1028
+ * Read binary image or private media bytes. Required key must belong to the supplied owner UUID and must not contain traversal; 403 rejects unsafe keys, 404 means the object is unavailable. Returns raw bytes with service Content-Type and Cache-Control headers.
854
1029
  * Calls `GET /api/v1/profile-media/{uuid}/avatar` through the shared IDP-aware Faiber client.
855
1030
  * @param uuid Backend path identifier `uuid`.
856
1031
  * @param params Typed query parameters; omitted members retain backend defaults.
857
1032
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
858
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
859
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
1033
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
1034
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: public read; key restricted to requested owner UUID.
860
1035
  */
861
1036
  profileAvatarShowGetApiV1ProfileMediaUuidAvatar(uuid, params, options) {
862
- return this.client.request({ ...options, method: "GET", url: `/api/v1/profile-media/${encodeURIComponent(uuid)}/avatar`, params });
1037
+ return this.client.request({ ...options, method: "GET", url: `/api/v1/profile-media/${encodeURIComponent(uuid)}/avatar`, params, responseType: "arraybuffer" });
863
1038
  }
864
1039
  /**
865
- * Performs the index operation for the profile property capability.
1040
+ * Read binary image or private media bytes. Required key must belong to the supplied owner UUID and must not contain traversal; 403 rejects unsafe keys, 404 means the object is unavailable. Returns raw bytes with service Content-Type and Cache-Control headers.
1041
+ * Calls `GET /api/v1/profile-media/{uuid}/images` through the shared IDP-aware Faiber client.
1042
+ * @param uuid Backend path identifier `uuid`.
1043
+ * @param params Typed query parameters; omitted members retain backend defaults.
1044
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
1045
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
1046
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: public read; key restricted to requested owner UUID.
1047
+ */
1048
+ profileImageShowGet(uuid, params, options) {
1049
+ return this.client.request({ ...options, method: "GET", url: `/api/v1/profile-media/${encodeURIComponent(uuid)}/images`, params, responseType: "arraybuffer" });
1050
+ }
1051
+ /**
1052
+ * List the property definition records. List pagination defaults 1/15 and caps at 100; filters apply before pagination, and deleted records are hidden unless filter[trashed]=only/with.
866
1053
  * Calls `GET /api/v1/profile-property-definition` through the shared IDP-aware Faiber client.
867
1054
  * @param params Typed query parameters; omitted members retain backend defaults.
868
1055
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
869
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
870
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: profile_property_definition:read.
1056
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
1057
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: declared IDP permission profile_property_definition:read; gateway enforces ACL metadata, local annotation itself is not a permission check.
871
1058
  */
872
1059
  profilePropertyIndexGet(params, options) {
873
1060
  return this.client.request({ ...options, method: "GET", url: `/api/v1/profile-property-definition`, params });
874
1061
  }
875
1062
  /**
876
- * Performs the store operation for the profile property capability.
1063
+ * Create the property definition record. Local IDs are UUIDs; responses retain the named backend envelope.
877
1064
  * Calls `POST /api/v1/profile-property-definition` through the shared IDP-aware Faiber client.
878
1065
  * @param data Typed JSON request body.
879
1066
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
880
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
881
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: profile_property_definition:create.
1067
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
1068
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: declared IDP permission profile_property_definition:create; gateway enforces ACL metadata, local annotation itself is not a permission check.
882
1069
  */
883
1070
  profilePropertyStorePost(data, options) {
884
1071
  return this.client.request({ ...options, method: "POST", url: `/api/v1/profile-property-definition`, data: data });
885
1072
  }
886
1073
  /**
887
- * Performs the destroy operation for the profile property capability.
1074
+ * Soft-delete the property definition record. Local IDs are UUIDs; responses retain the named backend envelope.
888
1075
  * Calls `DELETE /api/v1/profile-property-definition/{id}` through the shared IDP-aware Faiber client.
889
1076
  * @param id Backend path identifier `id`.
890
1077
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
891
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
892
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: profile_property_definition:delete.
1078
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
1079
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: declared IDP permission profile_property_definition:delete; gateway enforces ACL metadata, local annotation itself is not a permission check.
893
1080
  */
894
1081
  profilePropertyDestroyDelete(id, options) {
895
1082
  return this.client.request({ ...options, method: "DELETE", url: `/api/v1/profile-property-definition/${encodeURIComponent(id)}` });
896
1083
  }
897
1084
  /**
898
- * Performs the show operation for the profile property capability.
1085
+ * Read the property definition record. Local IDs are UUIDs; responses retain the named backend envelope.
899
1086
  * Calls `GET /api/v1/profile-property-definition/{id}` through the shared IDP-aware Faiber client.
900
1087
  * @param id Backend path identifier `id`.
901
1088
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
902
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
903
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: profile_property_definition:read.
1089
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
1090
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: declared IDP permission profile_property_definition:read; gateway enforces ACL metadata, local annotation itself is not a permission check.
904
1091
  */
905
1092
  profilePropertyShowGet(id, options) {
906
1093
  return this.client.request({ ...options, method: "GET", url: `/api/v1/profile-property-definition/${encodeURIComponent(id)}` });
907
1094
  }
908
1095
  /**
909
- * Performs the update operation for the profile property capability.
1096
+ * Update supplied fields on the property definition record. Local IDs are UUIDs; responses retain the named backend envelope.
910
1097
  * Calls `PATCH /api/v1/profile-property-definition/{id}` through the shared IDP-aware Faiber client.
911
1098
  * @param id Backend path identifier `id`.
912
1099
  * @param data Typed JSON request body.
913
1100
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
914
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
915
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: profile_property_definition:update.
1101
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
1102
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: declared IDP permission profile_property_definition:update; gateway enforces ACL metadata, local annotation itself is not a permission check.
916
1103
  */
917
1104
  profilePropertyUpdatePatch(id, data, options) {
918
1105
  return this.client.request({ ...options, method: "PATCH", url: `/api/v1/profile-property-definition/${encodeURIComponent(id)}`, data: data });
919
1106
  }
920
1107
  /**
921
- * Performs the update operation for the profile property capability.
1108
+ * Update supplied fields on the property definition record. Local IDs are UUIDs; responses retain the named backend envelope.
922
1109
  * Calls `PUT /api/v1/profile-property-definition/{id}` through the shared IDP-aware Faiber client.
923
1110
  * @param id Backend path identifier `id`.
924
1111
  * @param data Typed JSON request body.
925
1112
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
926
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
927
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: profile_property_definition:update.
1113
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
1114
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: declared IDP permission profile_property_definition:update; gateway enforces ACL metadata, local annotation itself is not a permission check.
928
1115
  */
929
1116
  profilePropertyUpdatePut(id, data, options) {
930
1117
  return this.client.request({ ...options, method: "PUT", url: `/api/v1/profile-property-definition/${encodeURIComponent(id)}`, data: data });
931
1118
  }
932
1119
  /**
933
- * Performs the force destroy operation for the profile property capability.
1120
+ * Permanently delete the property definition record. Local IDs are UUIDs; responses retain the named backend envelope.
934
1121
  * Calls `DELETE /api/v1/profile-property-definition/force/{id}` through the shared IDP-aware Faiber client.
935
1122
  * @param id Backend path identifier `id`.
936
1123
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
937
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
938
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: profile_property_definition:force_delete.
1124
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
1125
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: declared IDP permission profile_property_definition:force_delete; gateway enforces ACL metadata, local annotation itself is not a permission check.
939
1126
  */
940
1127
  profilePropertyForceDestroyDelete(id, options) {
941
1128
  return this.client.request({ ...options, method: "DELETE", url: `/api/v1/profile-property-definition/force/${encodeURIComponent(id)}` });
942
1129
  }
943
1130
  /**
944
- * Performs the restore operation for the profile property capability.
1131
+ * Restore the property definition record. Local IDs are UUIDs; responses retain the named backend envelope.
945
1132
  * Calls `GET /api/v1/profile-property-definition/undo/{id}` through the shared IDP-aware Faiber client.
946
1133
  * @param id Backend path identifier `id`.
947
1134
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
948
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
949
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: profile_property_definition:restore.
1135
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
1136
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: declared IDP permission profile_property_definition:restore; gateway enforces ACL metadata, local annotation itself is not a permission check.
950
1137
  */
951
1138
  profilePropertyRestoreGet(id, options) {
952
1139
  return this.client.request({ ...options, method: "GET", url: `/api/v1/profile-property-definition/undo/${encodeURIComponent(id)}` });
953
1140
  }
954
1141
  /**
955
- * Performs the show profile referral operation for the referral capability.
1142
+ * Read the raw Profile row by local Profile UUID; this is not the shaped public profile response.
956
1143
  * Calls `GET /api/v1/profile-referral/{profile_id}` through the shared IDP-aware Faiber client.
957
1144
  * @param profileId Backend path identifier `profile_id`.
958
1145
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
959
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
960
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
1146
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
1147
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: gateway AuthContext; no additional named handler permission check.
961
1148
  */
962
1149
  referralShowProfileReferralGet(profileId, options) {
963
1150
  return this.client.request({ ...options, method: "GET", url: `/api/v1/profile-referral/${encodeURIComponent(profileId)}` });
964
1151
  }
965
1152
  /**
966
- * Performs the assign operation for the referral capability.
1153
+ * Replace referral source/referrer by local Profile UUID; null/omitted fields clear them. Reject self/cyclic referrals, chains beyond 64 levels and inactive/missing sources or referrers.
967
1154
  * Calls `PUT /api/v1/profile-referral/{profile_id}` through the shared IDP-aware Faiber client.
968
1155
  * @param profileId Backend path identifier `profile_id`.
969
1156
  * @param data Typed JSON request body.
970
1157
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
971
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
972
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
1158
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
1159
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: gateway AuthContext; no additional named handler permission check.
973
1160
  */
974
1161
  referralAssignPut(profileId, data, options) {
975
1162
  return this.client.request({ ...options, method: "PUT", url: `/api/v1/profile-referral/${encodeURIComponent(profileId)}`, data: data });
976
1163
  }
977
1164
  /**
978
- * Performs the list relations operation for the relation capability.
1165
+ * List relations by optional endpoint profile_id and active flag, newest first.
979
1166
  * Calls `GET /api/v1/profile-relation` through the shared IDP-aware Faiber client.
980
1167
  * @param params Typed query parameters; omitted members retain backend defaults.
981
1168
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
982
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
983
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
1169
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
1170
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: gateway AuthContext; no additional named handler permission check.
984
1171
  */
985
1172
  relationListRelationsGet(params, options) {
986
1173
  return this.client.request({ ...options, method: "GET", url: `/api/v1/profile-relation`, params });
987
1174
  }
988
1175
  /**
989
- * Performs the create relation operation for the relation capability.
1176
+ * Create relation plus managed inverse atomically after active-type, endpoint, self-link and cardinality/status constraint checks. Returns one or two rows.
990
1177
  * Calls `POST /api/v1/profile-relation` through the shared IDP-aware Faiber client.
991
1178
  * @param data Typed JSON request body.
992
1179
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
993
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
994
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
1180
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
1181
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: gateway AuthContext; no additional named handler permission check.
995
1182
  */
996
1183
  relationCreateRelationPost(data, options) {
997
1184
  return this.client.request({ ...options, method: "POST", url: `/api/v1/profile-relation`, data: data });
998
1185
  }
999
1186
  /**
1000
- * Performs the delete relation operation for the relation capability.
1187
+ * Permanently delete a relation and its inverse atomically.
1001
1188
  * Calls `DELETE /api/v1/profile-relation/{id}` through the shared IDP-aware Faiber client.
1002
1189
  * @param id Backend path identifier `id`.
1003
1190
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
1004
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
1005
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
1191
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
1192
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: gateway AuthContext; no additional named handler permission check.
1006
1193
  */
1007
1194
  relationDeleteRelationDelete(id, options) {
1008
1195
  return this.client.request({ ...options, method: "DELETE", url: `/api/v1/profile-relation/${encodeURIComponent(id)}` });
1009
1196
  }
1010
1197
  /**
1011
- * Performs the show relation operation for the relation capability.
1198
+ * Read a relation by UUID.
1012
1199
  * Calls `GET /api/v1/profile-relation/{id}` through the shared IDP-aware Faiber client.
1013
1200
  * @param id Backend path identifier `id`.
1014
1201
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
1015
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
1016
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
1202
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
1203
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: gateway AuthContext; no additional named handler permission check.
1017
1204
  */
1018
1205
  relationShowRelationGet(id, options) {
1019
1206
  return this.client.request({ ...options, method: "GET", url: `/api/v1/profile-relation/${encodeURIComponent(id)}` });
1020
1207
  }
1021
1208
  /**
1022
- * Performs the update relation operation for the relation capability.
1209
+ * Update object metadata/active flag on a relation and its managed inverse atomically; returns updated rows.
1023
1210
  * Calls `PUT /api/v1/profile-relation/{id}` through the shared IDP-aware Faiber client.
1024
1211
  * @param id Backend path identifier `id`.
1025
1212
  * @param data Typed JSON request body.
1026
1213
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
1027
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
1028
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
1214
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
1215
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: gateway AuthContext; no additional named handler permission check.
1029
1216
  */
1030
1217
  relationUpdateRelationPut(id, data, options) {
1031
1218
  return this.client.request({ ...options, method: "PUT", url: `/api/v1/profile-relation/${encodeURIComponent(id)}`, data: data });
1032
1219
  }
1033
1220
  /**
1034
- * Performs the delete parent operation for the profile capability.
1221
+ * Delete matching legacy student/parent IDP UUID links and return an empty acknowledgement.
1035
1222
  * Calls `DELETE /api/v1/profile/{student_uuid}/delete/parent/{parent_uuid}` through the shared IDP-aware Faiber client.
1036
1223
  * @param studentUuid Backend path identifier `student_uuid`.
1037
1224
  * @param parentUuid Backend path identifier `parent_uuid`.
1038
1225
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
1039
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
1040
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: profile:update.
1226
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
1227
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: declared IDP permission profile:update; gateway enforces ACL metadata, local annotation itself is not a permission check.
1041
1228
  */
1042
1229
  profileDeleteParentDelete(studentUuid, parentUuid, options) {
1043
1230
  return this.client.request({ ...options, method: "DELETE", url: `/api/v1/profile/${encodeURIComponent(studentUuid)}/delete/parent/${encodeURIComponent(parentUuid)}` });
1044
1231
  }
1045
1232
  /**
1046
- * Performs the destroy operation for the profile capability.
1233
+ * Soft-delete a profile by IDP user UUID; returns an empty acknowledgement.
1047
1234
  * Calls `DELETE /api/v1/profile/{uuid}` through the shared IDP-aware Faiber client.
1048
1235
  * @param uuid Backend path identifier `uuid`.
1049
1236
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
1050
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
1051
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: profile:delete.
1237
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
1238
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: declared IDP permission profile:delete; gateway enforces ACL metadata, local annotation itself is not a permission check.
1052
1239
  */
1053
1240
  profileDestroyDelete(uuid, options) {
1054
1241
  return this.client.request({ ...options, method: "DELETE", url: `/api/v1/profile/${encodeURIComponent(uuid)}` });
1055
1242
  }
1056
1243
  /**
1057
- * Performs the show operation for the profile capability.
1244
+ * Read a profile by IDP user UUID first, falling back to local Profile UUID; return Get-scope properties/services and Office/LMS projections.
1058
1245
  * Calls `GET /api/v1/profile/{uuid}` through the shared IDP-aware Faiber client.
1059
1246
  * @param uuid Backend path identifier `uuid`.
1060
1247
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
1061
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
1062
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: profile:read.
1248
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
1249
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: declared IDP permission profile:read; gateway enforces ACL metadata, local annotation itself is not a permission check.
1063
1250
  */
1064
1251
  profileShowGet(uuid, options) {
1065
1252
  return this.client.request({ ...options, method: "GET", url: `/api/v1/profile/${encodeURIComponent(uuid)}` });
1066
1253
  }
1067
1254
  /**
1068
- * Performs the update operation for the profile capability.
1255
+ * Atomically patch profile scalars, app/meta and validated properties, then rebuild search. Resolves IDP user UUID first and local Profile UUID second. Omission preserves values; job:null clears, while other nullable scalar nulls deserialize as omission in this pinned model.
1069
1256
  * Calls `PATCH /api/v1/profile/{uuid}` through the shared IDP-aware Faiber client.
1070
1257
  * @param uuid Backend path identifier `uuid`.
1071
1258
  * @param data Typed JSON request body.
1072
1259
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
1073
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
1074
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: profile:update.
1260
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
1261
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: declared IDP permission profile:update; gateway enforces ACL metadata, local annotation itself is not a permission check.
1075
1262
  */
1076
1263
  profileUpdatePatch(uuid, data, options) {
1077
1264
  return this.client.request({ ...options, method: "PATCH", url: `/api/v1/profile/${encodeURIComponent(uuid)}`, data: data });
1078
1265
  }
1079
1266
  /**
1080
- * Performs the show admin operation for the profile capability.
1267
+ * Read an admin profile by IDP user UUID with admin-visible properties and trusted service data.
1081
1268
  * Calls `GET /api/v1/profile/{uuid}/admin` through the shared IDP-aware Faiber client.
1082
1269
  * @param uuid Backend path identifier `uuid`.
1083
1270
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
1084
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
1085
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: profile:read_admin.
1271
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
1272
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: declared IDP permission profile:read_admin; gateway enforces ACL metadata, local annotation itself is not a permission check.
1086
1273
  */
1087
1274
  profileShowAdminGet(uuid, options) {
1088
1275
  return this.client.request({ ...options, method: "GET", url: `/api/v1/profile/${encodeURIComponent(uuid)}/admin` });
1089
1276
  }
1090
1277
  /**
1091
- * Performs the avatar delete operation for the profile capability.
1278
+ * Clear the owned/authorized user avatar reference and attempt object cleanup; returns an empty acknowledgement.
1092
1279
  * Calls `DELETE /api/v1/profile/{uuid}/avatar` through the shared IDP-aware Faiber client.
1093
1280
  * @param uuid Backend path identifier `uuid`.
1094
1281
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
1095
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
1096
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
1282
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
1283
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: gateway AuthContext; no additional named handler permission check.
1097
1284
  */
1098
1285
  profileAvatarDeleteDelete(uuid, options) {
1099
1286
  return this.client.request({ ...options, method: "DELETE", url: `/api/v1/profile/${encodeURIComponent(uuid)}/avatar` });
1100
1287
  }
1101
1288
  /**
1102
- * Performs the avatar show operation for the profile capability.
1289
+ * Read binary image or private media bytes. Required key must belong to the supplied owner UUID and must not contain traversal; 403 rejects unsafe keys, 404 means the object is unavailable. Returns raw bytes with service Content-Type and Cache-Control headers.
1103
1290
  * Calls `GET /api/v1/profile/{uuid}/avatar` through the shared IDP-aware Faiber client.
1104
1291
  * @param uuid Backend path identifier `uuid`.
1105
1292
  * @param params Typed query parameters; omitted members retain backend defaults.
1106
1293
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
1107
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
1108
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
1294
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
1295
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: public read; key restricted to requested owner UUID.
1109
1296
  */
1110
1297
  profileAvatarShowGetApiV1ProfileUuidAvatar(uuid, params, options) {
1111
- return this.client.request({ ...options, method: "GET", url: `/api/v1/profile/${encodeURIComponent(uuid)}/avatar`, params });
1298
+ return this.client.request({ ...options, method: "GET", url: `/api/v1/profile/${encodeURIComponent(uuid)}/avatar`, params, responseType: "arraybuffer" });
1112
1299
  }
1113
1300
  /**
1114
- * Performs the avatar store operation for the profile capability.
1301
+ * Upload the multipart file field as JPEG, PNG or WebP (up to 5 MiB). Returns url and key; 413 rejects oversize, 415 unsupported media, 422 absent/empty file, and 503 unconfigured storage.
1115
1302
  * Calls `POST /api/v1/profile/{uuid}/avatar` through the shared IDP-aware Faiber client.
1116
1303
  * @param uuid Backend path identifier `uuid`.
1117
1304
  * @param data Typed multipart form.
1118
1305
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
1119
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
1120
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
1306
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
1307
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: authenticated target user or profile:update permission.
1121
1308
  */
1122
1309
  profileAvatarStorePost(uuid, data, options) {
1123
1310
  return this.client.request({ ...options, method: "POST", url: `/api/v1/profile/${encodeURIComponent(uuid)}/avatar`, data: data });
1124
1311
  }
1125
1312
  /**
1126
- * Performs the delete address operation for the profile capability.
1313
+ * Delete an address by exact title and IDP user UUID; returns an empty acknowledgement even if the title has no row.
1127
1314
  * Calls `DELETE /api/v1/profile/{uuid}/delete/address/{title}` through the shared IDP-aware Faiber client.
1128
1315
  * @param uuid Backend path identifier `uuid`.
1129
1316
  * @param title Backend path identifier `title`.
1130
1317
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
1131
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
1132
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: profile:update.
1318
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
1319
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: declared IDP permission profile:update; gateway enforces ACL metadata, local annotation itself is not a permission check.
1133
1320
  */
1134
1321
  profileDeleteAddressDelete(uuid, title, options) {
1135
1322
  return this.client.request({ ...options, method: "DELETE", url: `/api/v1/profile/${encodeURIComponent(uuid)}/delete/address/${encodeURIComponent(title)}` });
1136
1323
  }
1137
1324
  /**
1138
- * Performs the update employee type operation for the profile capability.
1325
+ * Set employee_type for an IDP user UUID and return the Get-scope profile.
1139
1326
  * Calls `PATCH /api/v1/profile/{uuid}/employee-type` through the shared IDP-aware Faiber client.
1140
1327
  * @param uuid Backend path identifier `uuid`.
1141
1328
  * @param data Typed JSON request body.
1142
1329
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
1143
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
1144
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: profile:update_employee_type.
1330
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
1331
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: declared IDP permission profile:update_employee_type; gateway enforces ACL metadata, local annotation itself is not a permission check.
1145
1332
  */
1146
1333
  profileUpdateEmployeeTypePatch(uuid, data, options) {
1147
1334
  return this.client.request({ ...options, method: "PATCH", url: `/api/v1/profile/${encodeURIComponent(uuid)}/employee-type`, data: data });
1148
1335
  }
1149
1336
  /**
1150
- * Performs the update employee type operation for the profile capability.
1337
+ * Set employee_type for an IDP user UUID and return the Get-scope profile.
1151
1338
  * Calls `PUT /api/v1/profile/{uuid}/employee-type` through the shared IDP-aware Faiber client.
1152
1339
  * @param uuid Backend path identifier `uuid`.
1153
1340
  * @param data Typed JSON request body.
1154
1341
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
1155
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
1156
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: profile:update_employee_type.
1342
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
1343
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: declared IDP permission profile:update_employee_type; gateway enforces ACL metadata, local annotation itself is not a permission check.
1157
1344
  */
1158
1345
  profileUpdateEmployeeTypePut(uuid, data, options) {
1159
1346
  return this.client.request({ ...options, method: "PUT", url: `/api/v1/profile/${encodeURIComponent(uuid)}/employee-type`, data: data });
1160
1347
  }
1161
1348
  /**
1162
- * Performs the update freemium operation for the profile capability.
1349
+ * Set freemium_session_limit for an IDP user UUID and return the Get-scope profile.
1163
1350
  * Calls `PATCH /api/v1/profile/{uuid}/freemium-session-limit` through the shared IDP-aware Faiber client.
1164
1351
  * @param uuid Backend path identifier `uuid`.
1165
1352
  * @param data Typed JSON request body.
1166
1353
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
1167
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
1168
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: profile:freemium_session_limit.
1354
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
1355
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: declared IDP permission profile:freemium_session_limit; gateway enforces ACL metadata, local annotation itself is not a permission check.
1169
1356
  */
1170
1357
  profileUpdateFreemiumPatch(uuid, data, options) {
1171
1358
  return this.client.request({ ...options, method: "PATCH", url: `/api/v1/profile/${encodeURIComponent(uuid)}/freemium-session-limit`, data: data });
1172
1359
  }
1173
1360
  /**
1174
- * Performs the update freemium operation for the profile capability.
1361
+ * Set freemium_session_limit for an IDP user UUID and return the Get-scope profile.
1175
1362
  * Calls `PUT /api/v1/profile/{uuid}/freemium-session-limit` through the shared IDP-aware Faiber client.
1176
1363
  * @param uuid Backend path identifier `uuid`.
1177
1364
  * @param data Typed JSON request body.
1178
1365
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
1179
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
1180
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: profile:freemium_session_limit.
1366
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
1367
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: declared IDP permission profile:freemium_session_limit; gateway enforces ACL metadata, local annotation itself is not a permission check.
1181
1368
  */
1182
1369
  profileUpdateFreemiumPut(uuid, data, options) {
1183
1370
  return this.client.request({ ...options, method: "PUT", url: `/api/v1/profile/${encodeURIComponent(uuid)}/freemium-session-limit`, data: data });
1184
1371
  }
1185
1372
  /**
1186
- * Performs the show full operation for the profile capability.
1373
+ * Read by IDP user UUID or fallback Profile UUID with Full-scope properties/services and Office/LMS projections.
1187
1374
  * Calls `GET /api/v1/profile/{uuid}/full` through the shared IDP-aware Faiber client.
1188
1375
  * @param uuid Backend path identifier `uuid`.
1189
1376
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
1190
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
1191
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: profile:read.
1377
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
1378
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: declared IDP permission profile:read; gateway enforces ACL metadata, local annotation itself is not a permission check.
1192
1379
  */
1193
1380
  profileShowFullGet(uuid, options) {
1194
1381
  return this.client.request({ ...options, method: "GET", url: `/api/v1/profile/${encodeURIComponent(uuid)}/full` });
1195
1382
  }
1196
1383
  /**
1197
- * Performs the media show operation for the profile capability.
1384
+ * Upload the multipart file field as JPEG, PNG or WebP (up to 5 MiB). Returns url and key; 413 rejects oversize, 415 unsupported media, 422 absent/empty file, and 503 unconfigured storage.
1385
+ * Calls `POST /api/v1/profile/{uuid}/images` through the shared IDP-aware Faiber client.
1386
+ * @param uuid Backend path identifier `uuid`.
1387
+ * @param data Typed multipart form.
1388
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
1389
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
1390
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: authenticated target user or profile:update permission.
1391
+ */
1392
+ profileImageStorePost(uuid, data, options) {
1393
+ return this.client.request({ ...options, method: "POST", url: `/api/v1/profile/${encodeURIComponent(uuid)}/images`, data: data });
1394
+ }
1395
+ /**
1396
+ * Read binary image or private media bytes. Required key must belong to the supplied owner UUID and must not contain traversal; 403 rejects unsafe keys, 404 means the object is unavailable. Returns raw bytes with service Content-Type and Cache-Control headers.
1198
1397
  * Calls `GET /api/v1/profile/{uuid}/media` through the shared IDP-aware Faiber client.
1199
1398
  * @param uuid Backend path identifier `uuid`.
1200
1399
  * @param params Typed query parameters; omitted members retain backend defaults.
1201
1400
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
1202
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
1203
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
1401
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
1402
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: authenticated IDP context; key restricted to requested profile UUID.
1204
1403
  */
1205
1404
  profileMediaShowGet(uuid, params, options) {
1206
- return this.client.request({ ...options, method: "GET", url: `/api/v1/profile/${encodeURIComponent(uuid)}/media`, params });
1405
+ return this.client.request({ ...options, method: "GET", url: `/api/v1/profile/${encodeURIComponent(uuid)}/media`, params, responseType: "arraybuffer" });
1207
1406
  }
1208
1407
  /**
1209
- * Performs the update properties operation for the profile capability.
1408
+ * Validate active configured properties, update them atomically and rebuild search. Returns updated_keys and array-item added/removed IDs and counts; unknown/inactive keys return 422.
1210
1409
  * Calls `PATCH /api/v1/profile/{uuid}/properties` through the shared IDP-aware Faiber client.
1211
1410
  * @param uuid Backend path identifier `uuid`.
1212
1411
  * @param data Typed JSON request body.
1213
1412
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
1214
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
1215
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: profile:update.
1413
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
1414
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: declared IDP permission profile:update; gateway enforces ACL metadata, local annotation itself is not a permission check.
1216
1415
  */
1217
1416
  profileUpdatePropertiesPatch(uuid, data, options) {
1218
1417
  return this.client.request({ ...options, method: "PATCH", url: `/api/v1/profile/${encodeURIComponent(uuid)}/properties`, data: data });
1219
1418
  }
1220
1419
  /**
1221
- * Performs the update properties operation for the profile capability.
1420
+ * Validate active configured properties, update them atomically and rebuild search. Returns updated_keys and array-item added/removed IDs and counts; unknown/inactive keys return 422.
1222
1421
  * Calls `PUT /api/v1/profile/{uuid}/properties` through the shared IDP-aware Faiber client.
1223
1422
  * @param uuid Backend path identifier `uuid`.
1224
1423
  * @param data Typed JSON request body.
1225
1424
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
1226
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
1227
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: profile:update.
1425
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
1426
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: declared IDP permission profile:update; gateway enforces ACL metadata, local annotation itself is not a permission check.
1228
1427
  */
1229
1428
  profileUpdatePropertiesPut(uuid, data, options) {
1230
1429
  return this.client.request({ ...options, method: "PUT", url: `/api/v1/profile/${encodeURIComponent(uuid)}/properties`, data: data });
1231
1430
  }
1232
1431
  /**
1233
- * Performs the update status operation for the profile capability.
1432
+ * Set status for an IDP user UUID and return the Get-scope profile.
1234
1433
  * Calls `PATCH /api/v1/profile/{uuid}/status` through the shared IDP-aware Faiber client.
1235
1434
  * @param uuid Backend path identifier `uuid`.
1236
1435
  * @param data Typed JSON request body.
1237
1436
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
1238
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
1239
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: profile:update_status.
1437
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
1438
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: declared IDP permission profile:update_status; gateway enforces ACL metadata, local annotation itself is not a permission check.
1240
1439
  */
1241
1440
  profileUpdateStatusPatch(uuid, data, options) {
1242
1441
  return this.client.request({ ...options, method: "PATCH", url: `/api/v1/profile/${encodeURIComponent(uuid)}/status`, data: data });
1243
1442
  }
1244
1443
  /**
1245
- * Performs the update status operation for the profile capability.
1444
+ * Set status for an IDP user UUID and return the Get-scope profile.
1246
1445
  * Calls `PUT /api/v1/profile/{uuid}/status` through the shared IDP-aware Faiber client.
1247
1446
  * @param uuid Backend path identifier `uuid`.
1248
1447
  * @param data Typed JSON request body.
1249
1448
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
1250
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
1251
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: profile:update_status.
1449
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
1450
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: declared IDP permission profile:update_status; gateway enforces ACL metadata, local annotation itself is not a permission check.
1252
1451
  */
1253
1452
  profileUpdateStatusPut(uuid, data, options) {
1254
1453
  return this.client.request({ ...options, method: "PUT", url: `/api/v1/profile/${encodeURIComponent(uuid)}/status`, data: data });
1255
1454
  }
1256
1455
  /**
1257
- * Performs the accountant index operation for the profile capability.
1456
+ * List undeleted profiles with role, active-enrollment, status, normalized literal identity search and dynamic filters applied before pagination. Defaults page=1/per_page=15; per_page caps at 100. filter[trashed] is accepted but does not expose deleted profiles. This mounted route fixes the role to accountant.
1258
1457
  * Calls `GET /api/v1/profile/accountant` through the shared IDP-aware Faiber client.
1259
1458
  * Supports live core/property/trusted-event filters, repeated date ranges and sorting before pagination; invalid clauses return HTTP 400.
1260
1459
  * @param params Typed query parameters; omitted members retain backend defaults.
1261
1460
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
1262
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
1263
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
1461
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
1462
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: declared IDP permission profile:read_accountant; gateway enforces ACL metadata, local annotation itself is not a permission check.
1264
1463
  */
1265
1464
  profileAccountantIndexGet(params, options) {
1266
1465
  return this.client.request({ ...options, method: "GET", url: `/api/v1/profile/accountant`, params });
1267
1466
  }
1268
1467
  /**
1269
- * Performs the add address operation for the profile capability.
1468
+ * Replace the address with the same title for an IDP user UUID in a transaction; blank titles return 422. Returns an empty acknowledgement.
1270
1469
  * Calls `PATCH /api/v1/profile/add/address/{uuid}` through the shared IDP-aware Faiber client.
1271
1470
  * @param uuid Backend path identifier `uuid`.
1272
1471
  * @param data Typed JSON request body.
1273
1472
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
1274
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
1275
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: profile:update.
1473
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
1474
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: declared IDP permission profile:update; gateway enforces ACL metadata, local annotation itself is not a permission check.
1276
1475
  */
1277
1476
  profileAddAddressPatch(uuid, data, options) {
1278
1477
  return this.client.request({ ...options, method: "PATCH", url: `/api/v1/profile/add/address/${encodeURIComponent(uuid)}`, data: data });
1279
1478
  }
1280
1479
  /**
1281
- * Performs the add address operation for the profile capability.
1480
+ * Replace the address with the same title for an IDP user UUID in a transaction; blank titles return 422. Returns an empty acknowledgement.
1282
1481
  * Calls `PUT /api/v1/profile/add/address/{uuid}` through the shared IDP-aware Faiber client.
1283
1482
  * @param uuid Backend path identifier `uuid`.
1284
1483
  * @param data Typed JSON request body.
1285
1484
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
1286
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
1287
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: profile:update.
1485
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
1486
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: declared IDP permission profile:update; gateway enforces ACL metadata, local annotation itself is not a permission check.
1288
1487
  */
1289
1488
  profileAddAddressPut(uuid, data, options) {
1290
1489
  return this.client.request({ ...options, method: "PUT", url: `/api/v1/profile/add/address/${encodeURIComponent(uuid)}`, data: data });
1291
1490
  }
1292
1491
  /**
1293
- * Performs the add app operation for the profile capability.
1492
+ * Replace schema-free app JSON for an IDP user UUID and return an empty acknowledgement.
1294
1493
  * Calls `PATCH /api/v1/profile/add/app/{uuid}` through the shared IDP-aware Faiber client.
1295
1494
  * @param uuid Backend path identifier `uuid`.
1296
1495
  * @param data Typed JSON request body.
1297
1496
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
1298
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
1299
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: profile:update.
1497
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
1498
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: declared IDP permission profile:update; gateway enforces ACL metadata, local annotation itself is not a permission check.
1300
1499
  */
1301
1500
  profileAddAppPatch(uuid, data, options) {
1302
1501
  return this.client.request({ ...options, method: "PATCH", url: `/api/v1/profile/add/app/${encodeURIComponent(uuid)}`, data: data });
1303
1502
  }
1304
1503
  /**
1305
- * Performs the add app operation for the profile capability.
1504
+ * Replace schema-free app JSON for an IDP user UUID and return an empty acknowledgement.
1306
1505
  * Calls `PUT /api/v1/profile/add/app/{uuid}` through the shared IDP-aware Faiber client.
1307
1506
  * @param uuid Backend path identifier `uuid`.
1308
1507
  * @param data Typed JSON request body.
1309
1508
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
1310
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
1311
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: profile:update.
1509
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
1510
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: declared IDP permission profile:update; gateway enforces ACL metadata, local annotation itself is not a permission check.
1312
1511
  */
1313
1512
  profileAddAppPut(uuid, data, options) {
1314
1513
  return this.client.request({ ...options, method: "PUT", url: `/api/v1/profile/add/app/${encodeURIComponent(uuid)}`, data: data });
1315
1514
  }
1316
1515
  /**
1317
- * Performs the add parent operation for the profile capability.
1516
+ * Replace the legacy parent link for a student IDP UUID; request user_id is the parent IDP UUID. Returns an empty acknowledgement.
1318
1517
  * Calls `PATCH /api/v1/profile/add/parent/{uuid}` through the shared IDP-aware Faiber client.
1319
1518
  * @param uuid Backend path identifier `uuid`.
1320
1519
  * @param data Typed JSON request body.
1321
1520
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
1322
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
1323
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: profile:update.
1521
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
1522
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: declared IDP permission profile:update; gateway enforces ACL metadata, local annotation itself is not a permission check.
1324
1523
  */
1325
1524
  profileAddParentPatch(uuid, data, options) {
1326
1525
  return this.client.request({ ...options, method: "PATCH", url: `/api/v1/profile/add/parent/${encodeURIComponent(uuid)}`, data: data });
1327
1526
  }
1328
1527
  /**
1329
- * Performs the add parent operation for the profile capability.
1528
+ * Replace the legacy parent link for a student IDP UUID; request user_id is the parent IDP UUID. Returns an empty acknowledgement.
1330
1529
  * Calls `PUT /api/v1/profile/add/parent/{uuid}` through the shared IDP-aware Faiber client.
1331
1530
  * @param uuid Backend path identifier `uuid`.
1332
1531
  * @param data Typed JSON request body.
1333
1532
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
1334
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
1335
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: profile:update.
1533
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
1534
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: declared IDP permission profile:update; gateway enforces ACL metadata, local annotation itself is not a permission check.
1336
1535
  */
1337
1536
  profileAddParentPut(uuid, data, options) {
1338
1537
  return this.client.request({ ...options, method: "PUT", url: `/api/v1/profile/add/parent/${encodeURIComponent(uuid)}`, data: data });
1339
1538
  }
1340
1539
  /**
1341
- * Performs the city get operation for the profile capability.
1540
+ * Read undeleted profiles matching any requested city UUID, optionally restricted by nonempty user_ids.
1342
1541
  * Calls `POST /api/v1/profile/city/get` through the shared IDP-aware Faiber client.
1343
1542
  * @param data Typed JSON request body.
1344
1543
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
1345
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
1346
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
1544
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
1545
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: no local authentication or permission check; deployment gateway policy is separate.
1347
1546
  */
1348
1547
  profileCityGetPost(data, options) {
1349
1548
  return this.client.request({ ...options, method: "POST", url: `/api/v1/profile/city/get`, data: data });
1350
1549
  }
1351
1550
  /**
1352
- * Performs the consultant index operation for the profile capability.
1551
+ * List undeleted profiles with role, active-enrollment, status, normalized literal identity search and dynamic filters applied before pagination. Defaults page=1/per_page=15; per_page caps at 100. filter[trashed] is accepted but does not expose deleted profiles. This mounted route fixes the role to consultant.
1353
1552
  * Calls `GET /api/v1/profile/consultant` through the shared IDP-aware Faiber client.
1354
1553
  * Supports live core/property/trusted-event filters, repeated date ranges and sorting before pagination; invalid clauses return HTTP 400.
1355
1554
  * @param params Typed query parameters; omitted members retain backend defaults.
1356
1555
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
1357
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
1358
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
1556
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
1557
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: declared IDP permission profile:read_consultant; gateway enforces ACL metadata, local annotation itself is not a permission check.
1359
1558
  */
1360
1559
  profileConsultantIndexGet(params, options) {
1361
1560
  return this.client.request({ ...options, method: "GET", url: `/api/v1/profile/consultant`, params });
1362
1561
  }
1363
1562
  /**
1364
- * Performs the country get operation for the profile capability.
1563
+ * Read undeleted profiles matching any requested country UUID, optionally restricted by nonempty user_ids.
1365
1564
  * Calls `POST /api/v1/profile/country/get` through the shared IDP-aware Faiber client.
1366
1565
  * @param data Typed JSON request body.
1367
1566
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
1368
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
1369
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
1567
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
1568
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: no local authentication or permission check; deployment gateway policy is separate.
1370
1569
  */
1371
1570
  profileCountryGetPost(data, options) {
1372
1571
  return this.client.request({ ...options, method: "POST", url: `/api/v1/profile/country/get`, data: data });
1373
1572
  }
1374
1573
  /**
1375
- * Performs the force destroy operation for the profile capability.
1574
+ * Permanently delete an undeleted profile by IDP user UUID; returns an empty acknowledgement.
1376
1575
  * Calls `DELETE /api/v1/profile/force/{uuid}` through the shared IDP-aware Faiber client.
1377
1576
  * @param uuid Backend path identifier `uuid`.
1378
1577
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
1379
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
1380
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: profile:force_delete.
1578
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
1579
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: declared IDP permission profile:force_delete; gateway enforces ACL metadata, local annotation itself is not a permission check.
1381
1580
  */
1382
1581
  profileForceDestroyDelete(uuid, options) {
1383
1582
  return this.client.request({ ...options, method: "DELETE", url: `/api/v1/profile/force/${encodeURIComponent(uuid)}` });
1384
1583
  }
1385
1584
  /**
1386
- * Performs the bulk get operation for the profile capability.
1585
+ * Read undeleted profiles for IDP user UUIDs and attach legacy parent summaries. Empty batches return an empty list; the local mount has no auth middleware.
1387
1586
  * Calls `POST /api/v1/profile/get` through the shared IDP-aware Faiber client.
1388
1587
  * @param data Typed JSON request body.
1389
1588
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
1390
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
1391
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
1589
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
1590
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: no local authentication or permission check; deployment gateway policy is separate.
1392
1591
  */
1393
1592
  profileBulkGetPost(data, options) {
1394
1593
  return this.client.request({ ...options, method: "POST", url: `/api/v1/profile/get`, data: data });
1395
1594
  }
1396
1595
  /**
1397
- * Performs the chat list operation for the profile capability.
1596
+ * Read the compatibility chat-list route, which currently always returns an empty array.
1398
1597
  * Calls `GET /api/v1/profile/get-chat-list/{uuid}` through the shared IDP-aware Faiber client.
1399
1598
  * @param uuid Backend path identifier `uuid`.
1400
1599
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
1401
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
1402
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
1600
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
1601
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: no local authentication or permission check; deployment gateway policy is separate.
1403
1602
  */
1404
1603
  profileChatListGet(uuid, options) {
1405
1604
  return this.client.request({ ...options, method: "GET", url: `/api/v1/profile/get-chat-list/${encodeURIComponent(uuid)}` });
1406
1605
  }
1407
1606
  /**
1408
- * Performs the get address operation for the profile capability.
1607
+ * Read stored addresses by IDP user UUID, resolving the separate local Profile UUID.
1409
1608
  * Calls `GET /api/v1/profile/get/address/{uuid}` through the shared IDP-aware Faiber client.
1410
1609
  * @param uuid Backend path identifier `uuid`.
1411
1610
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
1412
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
1413
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: profile:read.
1611
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
1612
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: declared IDP permission profile:read; gateway enforces ACL metadata, local annotation itself is not a permission check.
1414
1613
  */
1415
1614
  profileGetAddressGet(uuid, options) {
1416
1615
  return this.client.request({ ...options, method: "GET", url: `/api/v1/profile/get/address/${encodeURIComponent(uuid)}` });
1417
1616
  }
1418
1617
  /**
1419
- * Performs the get app operation for the profile capability.
1618
+ * Read schema-free stored app JSON for an IDP user UUID; missing data becomes an empty object.
1420
1619
  * Calls `GET /api/v1/profile/get/app/{uuid}` through the shared IDP-aware Faiber client.
1421
1620
  * @param uuid Backend path identifier `uuid`.
1422
1621
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
1423
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
1424
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: profile:read.
1622
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
1623
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: declared IDP permission profile:read; gateway enforces ACL metadata, local annotation itself is not a permission check.
1425
1624
  */
1426
1625
  profileGetAppGet(uuid, options) {
1427
1626
  return this.client.request({ ...options, method: "GET", url: `/api/v1/profile/get/app/${encodeURIComponent(uuid)}` });
1428
1627
  }
1429
1628
  /**
1430
- * Performs the get parent operation for the profile capability.
1629
+ * Read the optional legacy parent-link row by student IDP UUID; missing link is data:null.
1431
1630
  * Calls `GET /api/v1/profile/get/parent/{uuid}` through the shared IDP-aware Faiber client.
1432
1631
  * @param uuid Backend path identifier `uuid`.
1433
1632
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
1434
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
1435
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: profile:read.
1633
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
1634
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: declared IDP permission profile:read; gateway enforces ACL metadata, local annotation itself is not a permission check.
1436
1635
  */
1437
1636
  profileGetParentGet(uuid, options) {
1438
1637
  return this.client.request({ ...options, method: "GET", url: `/api/v1/profile/get/parent/${encodeURIComponent(uuid)}` });
1439
1638
  }
1440
1639
  /**
1441
- * Performs the manager index operation for the profile capability.
1640
+ * List undeleted profiles with role, active-enrollment, status, normalized literal identity search and dynamic filters applied before pagination. Defaults page=1/per_page=15; per_page caps at 100. filter[trashed] is accepted but does not expose deleted profiles. This mounted route fixes the role to manager.
1442
1641
  * Calls `GET /api/v1/profile/manager` through the shared IDP-aware Faiber client.
1443
1642
  * Supports live core/property/trusted-event filters, repeated date ranges and sorting before pagination; invalid clauses return HTTP 400.
1444
1643
  * @param params Typed query parameters; omitted members retain backend defaults.
1445
1644
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
1446
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
1447
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
1645
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
1646
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: declared IDP permission profile:read_manager; gateway enforces ACL metadata, local annotation itself is not a permission check.
1448
1647
  */
1449
1648
  profileManagerIndexGet(params, options) {
1450
1649
  return this.client.request({ ...options, method: "GET", url: `/api/v1/profile/manager`, params });
1451
1650
  }
1452
1651
  /**
1453
- * Performs the get my addresses operation for the profile capability.
1652
+ * Read addresses for the identity supplied by the authenticated gateway context.
1454
1653
  * Calls `GET /api/v1/profile/me/addresses` through the shared IDP-aware Faiber client.
1455
1654
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
1456
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
1457
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
1655
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
1656
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: gateway AuthContext; no additional named handler permission check.
1458
1657
  */
1459
1658
  profileGetMyAddressesGet(options) {
1460
1659
  return this.client.request({ ...options, method: "GET", url: `/api/v1/profile/me/addresses` });
1461
1660
  }
1462
1661
  /**
1463
- * Performs the save my address operation for the profile capability.
1662
+ * Replace an address by title for the current gateway identity. Other addresses remain unchanged; blank titles return 422.
1464
1663
  * Calls `PATCH /api/v1/profile/me/addresses` through the shared IDP-aware Faiber client.
1465
1664
  * @param data Typed JSON request body.
1466
1665
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
1467
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
1468
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
1666
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
1667
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: gateway AuthContext; no additional named handler permission check.
1469
1668
  */
1470
1669
  profileSaveMyAddressPatch(data, options) {
1471
1670
  return this.client.request({ ...options, method: "PATCH", url: `/api/v1/profile/me/addresses`, data: data });
1472
1671
  }
1473
1672
  /**
1474
- * Performs the save my address operation for the profile capability.
1673
+ * Replace an address by title for the current gateway identity. Other addresses remain unchanged; blank titles return 422.
1475
1674
  * Calls `PUT /api/v1/profile/me/addresses` through the shared IDP-aware Faiber client.
1476
1675
  * @param data Typed JSON request body.
1477
1676
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
1478
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
1479
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
1677
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
1678
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: gateway AuthContext; no additional named handler permission check.
1480
1679
  */
1481
1680
  profileSaveMyAddressPut(data, options) {
1482
1681
  return this.client.request({ ...options, method: "PUT", url: `/api/v1/profile/me/addresses`, data: data });
1483
1682
  }
1484
1683
  /**
1485
- * Performs the delete my address operation for the profile capability.
1684
+ * Delete the current gateway identity address by exact title and return an empty acknowledgement.
1486
1685
  * Calls `DELETE /api/v1/profile/me/addresses/{title}` through the shared IDP-aware Faiber client.
1487
1686
  * @param title Backend path identifier `title`.
1488
1687
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
1489
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
1490
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
1688
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
1689
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: gateway AuthContext; no additional named handler permission check.
1491
1690
  */
1492
1691
  profileDeleteMyAddressDelete(title, options) {
1493
1692
  return this.client.request({ ...options, method: "DELETE", url: `/api/v1/profile/me/addresses/${encodeURIComponent(title)}` });
1494
1693
  }
1495
1694
  /**
1496
- * Performs the other index operation for the profile capability.
1695
+ * List undeleted profiles with role, active-enrollment, status, normalized literal identity search and dynamic filters applied before pagination. Defaults page=1/per_page=15; per_page caps at 100. filter[trashed] is accepted but does not expose deleted profiles. This mounted route fixes the role to other.
1497
1696
  * Calls `GET /api/v1/profile/other` through the shared IDP-aware Faiber client.
1498
1697
  * Supports live core/property/trusted-event filters, repeated date ranges and sorting before pagination; invalid clauses return HTTP 400.
1499
1698
  * @param params Typed query parameters; omitted members retain backend defaults.
1500
1699
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
1501
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
1502
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
1700
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
1701
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: declared IDP permission profile:read; gateway enforces ACL metadata, local annotation itself is not a permission check.
1503
1702
  */
1504
1703
  profileOtherIndexGet(params, options) {
1505
1704
  return this.client.request({ ...options, method: "GET", url: `/api/v1/profile/other`, params });
1506
1705
  }
1507
1706
  /**
1508
- * Performs the parent index operation for the profile capability.
1707
+ * List undeleted profiles with role, active-enrollment, status, normalized literal identity search and dynamic filters applied before pagination. Defaults page=1/per_page=15; per_page caps at 100. filter[trashed] is accepted but does not expose deleted profiles. This mounted route fixes the role to parent.
1509
1708
  * Calls `GET /api/v1/profile/parent` through the shared IDP-aware Faiber client.
1510
1709
  * Supports live core/property/trusted-event filters, repeated date ranges and sorting before pagination; invalid clauses return HTTP 400.
1511
1710
  * @param params Typed query parameters; omitted members retain backend defaults.
1512
1711
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
1513
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
1514
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
1712
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
1713
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: declared IDP permission profile:read_parent; gateway enforces ACL metadata, local annotation itself is not a permission check.
1515
1714
  */
1516
1715
  profileParentIndexGet(params, options) {
1517
1716
  return this.client.request({ ...options, method: "GET", url: `/api/v1/profile/parent`, params });
1518
1717
  }
1519
1718
  /**
1520
- * Resolve 1–200 explicit user UUIDs into active directory identities. Returns results and has_more:false; never grants collaborator eligibility.
1719
+ * Resolve 1–200 requested active undeleted IDP user UUIDs. Results preserve names, set email/phone null, and has_more=false. Does not decide external space membership.
1521
1720
  * Calls `POST /api/v1/profile/people/resolve` through the shared IDP-aware Faiber client.
1522
1721
  * @param data Typed JSON request body.
1523
1722
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
1524
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
1525
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: profile:lookup and authenticated directory access.
1723
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
1724
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: declared IDP permission profile:lookup; gateway enforces ACL metadata, local annotation itself is not a permission check.
1526
1725
  */
1527
1726
  workspaceResolvePeople(data, options) {
1528
1727
  return this.client.request({ ...options, method: "POST", url: `/api/v1/profile/people/resolve`, data: data });
1529
1728
  }
1530
1729
  /**
1531
- * Performs the search operation for the profile search capability.
1730
+ * Search using bounded literal normalized terms and dynamic predicates; at least one filter or search term is required. Maximum 50 filters/10 sorts, page defaults 1, per_page defaults 20 and caps at 100. include selects core/properties/services snapshots.
1532
1731
  * Calls `POST /api/v1/profile/people/search` through the shared IDP-aware Faiber client.
1533
1732
  * @param data Typed JSON request body.
1534
1733
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
1535
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
1536
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: profile:lookup.
1734
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
1735
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: declared IDP permission profile:lookup; gateway enforces ACL metadata, local annotation itself is not a permission check.
1537
1736
  */
1538
1737
  profileSearchSearchPostApiV1ProfilePeopleSearch(data, options) {
1539
1738
  return this.client.request({ ...options, method: "POST", url: `/api/v1/profile/people/search`, data: data });
1540
1739
  }
1541
1740
  /**
1542
- * Performs the province get operation for the profile capability.
1741
+ * Read undeleted profiles matching any requested province UUID, optionally restricted by nonempty user_ids.
1543
1742
  * Calls `POST /api/v1/profile/province/get` through the shared IDP-aware Faiber client.
1544
1743
  * @param data Typed JSON request body.
1545
1744
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
1546
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
1547
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
1745
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
1746
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: no local authentication or permission check; deployment gateway policy is separate.
1548
1747
  */
1549
1748
  profileProvinceGetPost(data, options) {
1550
1749
  return this.client.request({ ...options, method: "POST", url: `/api/v1/profile/province/get`, data: data });
1551
1750
  }
1552
1751
  /**
1553
- * Performs the search operation for the profile search capability.
1752
+ * Search using bounded literal normalized terms and dynamic predicates; at least one filter or search term is required. Maximum 50 filters/10 sorts, page defaults 1, per_page defaults 20 and caps at 100. include selects core/properties/services snapshots.
1554
1753
  * Calls `POST /api/v1/profile/search` through the shared IDP-aware Faiber client.
1555
1754
  * @param data Typed JSON request body.
1556
1755
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
1557
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
1558
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: profile:search.
1756
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
1757
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: declared IDP permission profile:search; gateway enforces ACL metadata, local annotation itself is not a permission check.
1559
1758
  */
1560
1759
  profileSearchSearchPost(data, options) {
1561
1760
  return this.client.request({ ...options, method: "POST", url: `/api/v1/profile/search`, data: data });
1562
1761
  }
1563
1762
  /**
1564
- * Performs the student index operation for the profile capability.
1763
+ * List undeleted profiles with role, active-enrollment, status, normalized literal identity search and dynamic filters applied before pagination. Defaults page=1/per_page=15; per_page caps at 100. filter[trashed] is accepted but does not expose deleted profiles. This mounted route fixes the role to student.
1565
1764
  * Calls `GET /api/v1/profile/student` through the shared IDP-aware Faiber client.
1566
1765
  * Supports live core/property/trusted-event filters, repeated date ranges and sorting before pagination; invalid clauses return HTTP 400.
1567
1766
  * @param params Typed query parameters; omitted members retain backend defaults.
1568
1767
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
1569
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
1570
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
1768
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
1769
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: declared IDP permission profile:read_student; gateway enforces ACL metadata, local annotation itself is not a permission check.
1571
1770
  */
1572
1771
  profileStudentIndexGet(params, options) {
1573
1772
  return this.client.request({ ...options, method: "GET", url: `/api/v1/profile/student`, params });
1574
1773
  }
1575
1774
  /**
1576
- * Performs the student pes operation for the profile capability.
1775
+ * Aggregate enrolled nonarchived enrollments across undeleted profiles: count and amount minus discount.
1577
1776
  * Calls `GET /api/v1/profile/students/pes` through the shared IDP-aware Faiber client.
1578
1777
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
1579
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
1580
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
1778
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
1779
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: no local authentication or permission check; deployment gateway policy is separate.
1581
1780
  */
1582
1781
  profileStudentPesGet(options) {
1583
1782
  return this.client.request({ ...options, method: "GET", url: `/api/v1/profile/students/pes` });
1584
1783
  }
1585
1784
  /**
1586
- * Performs the student pes schema operation for the profile capability.
1785
+ * Read the constant PES schema descriptor {count:integer,amount:number}.
1587
1786
  * Calls `GET /api/v1/profile/students/pes/schema` through the shared IDP-aware Faiber client.
1588
1787
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
1589
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
1590
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
1788
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
1789
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: no local authentication or permission check; deployment gateway policy is separate.
1591
1790
  */
1592
1791
  profileStudentPesSchemaGet(options) {
1593
1792
  return this.client.request({ ...options, method: "GET", url: `/api/v1/profile/students/pes/schema` });
1594
1793
  }
1595
1794
  /**
1596
- * Performs the support index operation for the profile capability.
1795
+ * List undeleted profiles with role, active-enrollment, status, normalized literal identity search and dynamic filters applied before pagination. Defaults page=1/per_page=15; per_page caps at 100. filter[trashed] is accepted but does not expose deleted profiles. This mounted route fixes the role to support.
1597
1796
  * Calls `GET /api/v1/profile/support` through the shared IDP-aware Faiber client.
1598
1797
  * Supports live core/property/trusted-event filters, repeated date ranges and sorting before pagination; invalid clauses return HTTP 400.
1599
1798
  * @param params Typed query parameters; omitted members retain backend defaults.
1600
1799
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
1601
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
1602
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
1800
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
1801
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: declared IDP permission profile:read_support; gateway enforces ACL metadata, local annotation itself is not a permission check.
1603
1802
  */
1604
1803
  profileSupportIndexGet(params, options) {
1605
1804
  return this.client.request({ ...options, method: "GET", url: `/api/v1/profile/support`, params });
1606
1805
  }
1607
1806
  /**
1608
- * Performs the support pes operation for the profile capability.
1807
+ * Aggregate pending nonarchived enrollments across undeleted profiles: count and amount minus discount.
1609
1808
  * Calls `GET /api/v1/profile/supports/pes` through the shared IDP-aware Faiber client.
1610
1809
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
1611
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
1612
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
1810
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
1811
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: no local authentication or permission check; deployment gateway policy is separate.
1613
1812
  */
1614
1813
  profileSupportPesGet(options) {
1615
1814
  return this.client.request({ ...options, method: "GET", url: `/api/v1/profile/supports/pes` });
1616
1815
  }
1617
1816
  /**
1618
- * Performs the support pes schema operation for the profile capability.
1817
+ * Read the constant PES schema descriptor {count:integer,amount:number}.
1619
1818
  * Calls `GET /api/v1/profile/supports/pes/schema` through the shared IDP-aware Faiber client.
1620
1819
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
1621
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
1622
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
1820
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
1821
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: no local authentication or permission check; deployment gateway policy is separate.
1623
1822
  */
1624
1823
  profileSupportPesSchemaGet(options) {
1625
1824
  return this.client.request({ ...options, method: "GET", url: `/api/v1/profile/supports/pes/schema` });
1626
1825
  }
1627
1826
  /**
1628
- * Performs the teacher index operation for the profile capability.
1827
+ * List undeleted profiles with role, active-enrollment, status, normalized literal identity search and dynamic filters applied before pagination. Defaults page=1/per_page=15; per_page caps at 100. filter[trashed] is accepted but does not expose deleted profiles. This mounted route fixes the role to teacher.
1629
1828
  * Calls `GET /api/v1/profile/teacher` through the shared IDP-aware Faiber client.
1630
1829
  * Supports live core/property/trusted-event filters, repeated date ranges and sorting before pagination; invalid clauses return HTTP 400.
1631
1830
  * @param params Typed query parameters; omitted members retain backend defaults.
1632
1831
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
1633
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
1634
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
1832
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
1833
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: declared IDP permission profile:read_teacher; gateway enforces ACL metadata, local annotation itself is not a permission check.
1635
1834
  */
1636
1835
  profileTeacherIndexGet(params, options) {
1637
1836
  return this.client.request({ ...options, method: "GET", url: `/api/v1/profile/teacher`, params });
1638
1837
  }
1639
1838
  /**
1640
- * Performs the restore operation for the profile capability.
1839
+ * Restore a profile by IDP user UUID, including a previously deleted row; returns an empty acknowledgement.
1641
1840
  * Calls `GET /api/v1/profile/undo/{uuid}` through the shared IDP-aware Faiber client.
1642
1841
  * @param uuid Backend path identifier `uuid`.
1643
1842
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
1644
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
1645
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: profile:restore.
1843
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
1844
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: declared IDP permission profile:restore; gateway enforces ACL metadata, local annotation itself is not a permission check.
1646
1845
  */
1647
1846
  profileRestoreGet(uuid, options) {
1648
1847
  return this.client.request({ ...options, method: "GET", url: `/api/v1/profile/undo/${encodeURIComponent(uuid)}` });
1649
1848
  }
1650
1849
  /**
1651
- * Performs the add meta operation for the profile capability.
1850
+ * Replace schema-free metadata JSON for an IDP user UUID and return an empty acknowledgement.
1652
1851
  * Calls `PATCH /api/v1/profile/update/{uuid}/meta` through the shared IDP-aware Faiber client.
1653
1852
  * @param uuid Backend path identifier `uuid`.
1654
1853
  * @param data Typed JSON request body.
1655
1854
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
1656
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
1657
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: profile:update.
1855
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
1856
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: declared IDP permission profile:update; gateway enforces ACL metadata, local annotation itself is not a permission check.
1658
1857
  */
1659
1858
  profileAddMetaPatch(uuid, data, options) {
1660
1859
  return this.client.request({ ...options, method: "PATCH", url: `/api/v1/profile/update/${encodeURIComponent(uuid)}/meta`, data: data });
1661
1860
  }
1662
1861
  /**
1663
- * Performs the add meta operation for the profile capability.
1862
+ * Replace schema-free metadata JSON for an IDP user UUID and return an empty acknowledgement.
1664
1863
  * Calls `PUT /api/v1/profile/update/{uuid}/meta` through the shared IDP-aware Faiber client.
1665
1864
  * @param uuid Backend path identifier `uuid`.
1666
1865
  * @param data Typed JSON request body.
1667
1866
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
1668
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
1669
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: profile:update.
1867
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
1868
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: declared IDP permission profile:update; gateway enforces ACL metadata, local annotation itself is not a permission check.
1670
1869
  */
1671
1870
  profileAddMetaPut(uuid, data, options) {
1672
1871
  return this.client.request({ ...options, method: "PUT", url: `/api/v1/profile/update/${encodeURIComponent(uuid)}/meta`, data: data });
1673
1872
  }
1674
1873
  /**
1675
- * Performs the update operation for the education capability.
1874
+ * Atomically update education fields by IDP user UUID. Omission preserves and null clears; invalid attendance/level/referral/education/referrer values return 422. Level is a nonempty string up to 64 characters and description up to 10000.
1676
1875
  * Calls `PUT /api/v1/profile/update/education-information/{uuid}` through the shared IDP-aware Faiber client.
1677
1876
  * @param uuid Backend path identifier `uuid`.
1678
1877
  * @param data Typed JSON request body.
1679
1878
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
1680
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
1681
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: profile:update.
1879
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
1880
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: declared IDP permission profile:update; gateway enforces ACL metadata, local annotation itself is not a permission check.
1682
1881
  */
1683
1882
  educationUpdatePut(uuid, data, options) {
1684
1883
  return this.client.request({ ...options, method: "PUT", url: `/api/v1/profile/update/education-information/${encodeURIComponent(uuid)}`, data: data });
1685
1884
  }
1686
1885
  /**
1687
- * Performs the update personal operation for the profile capability.
1886
+ * Update supplied personal fields for an IDP user UUID. Localized name objects merge fa/en string members; job:null clears the job. Other absent/null optional scalar members are preserved.
1688
1887
  * Calls `PATCH /api/v1/profile/update/personal-information/{uuid}` through the shared IDP-aware Faiber client.
1689
1888
  * @param uuid Backend path identifier `uuid`.
1690
1889
  * @param data Typed JSON request body.
1691
1890
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
1692
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
1693
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: profile:update.
1891
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
1892
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: declared IDP permission profile:update; gateway enforces ACL metadata, local annotation itself is not a permission check.
1694
1893
  */
1695
1894
  profileUpdatePersonalPatch(uuid, data, options) {
1696
1895
  return this.client.request({ ...options, method: "PATCH", url: `/api/v1/profile/update/personal-information/${encodeURIComponent(uuid)}`, data: data });
1697
1896
  }
1698
1897
  /**
1699
- * Performs the update personal operation for the profile capability.
1898
+ * Update supplied personal fields for an IDP user UUID. Localized name objects merge fa/en string members; job:null clears the job. Other absent/null optional scalar members are preserved.
1700
1899
  * Calls `PUT /api/v1/profile/update/personal-information/{uuid}` through the shared IDP-aware Faiber client.
1701
1900
  * @param uuid Backend path identifier `uuid`.
1702
1901
  * @param data Typed JSON request body.
1703
1902
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
1704
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
1705
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: profile:update.
1903
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
1904
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: declared IDP permission profile:update; gateway enforces ACL metadata, local annotation itself is not a permission check.
1706
1905
  */
1707
1906
  profileUpdatePersonalPut(uuid, data, options) {
1708
1907
  return this.client.request({ ...options, method: "PUT", url: `/api/v1/profile/update/personal-information/${encodeURIComponent(uuid)}`, data: data });
1709
1908
  }
1710
1909
  /**
1711
- * Performs the index operation for the province capability.
1910
+ * List the province records. List pagination defaults 1/15 and caps at 100; filters apply before pagination, and deleted records are hidden unless filter[trashed]=only/with.
1712
1911
  * Calls `GET /api/v1/province` through the shared IDP-aware Faiber client.
1713
1912
  * @param params Typed query parameters; omitted members retain backend defaults.
1714
1913
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
1715
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
1716
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: province:read.
1914
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
1915
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: declared IDP permission province:read; gateway enforces ACL metadata, local annotation itself is not a permission check.
1717
1916
  */
1718
1917
  provinceIndexGet(params, options) {
1719
1918
  return this.client.request({ ...options, method: "GET", url: `/api/v1/province`, params });
1720
1919
  }
1721
1920
  /**
1722
- * Performs the store operation for the province capability.
1921
+ * Create the province record. Local IDs are UUIDs; responses retain the named backend envelope.
1723
1922
  * Calls `POST /api/v1/province` through the shared IDP-aware Faiber client.
1724
1923
  * @param data Typed JSON request body.
1725
1924
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
1726
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
1727
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: province:create.
1925
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
1926
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: declared IDP permission province:create; gateway enforces ACL metadata, local annotation itself is not a permission check.
1728
1927
  */
1729
1928
  provinceStorePost(data, options) {
1730
1929
  return this.client.request({ ...options, method: "POST", url: `/api/v1/province`, data: data });
1731
1930
  }
1732
1931
  /**
1733
- * Performs the destroy operation for the province capability.
1932
+ * Soft-delete the province record. Local IDs are UUIDs; responses retain the named backend envelope.
1734
1933
  * Calls `DELETE /api/v1/province/{id}` through the shared IDP-aware Faiber client.
1735
1934
  * @param id Backend path identifier `id`.
1736
1935
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
1737
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
1738
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: province:delete.
1936
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
1937
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: declared IDP permission province:delete; gateway enforces ACL metadata, local annotation itself is not a permission check.
1739
1938
  */
1740
1939
  provinceDestroyDelete(id, options) {
1741
1940
  return this.client.request({ ...options, method: "DELETE", url: `/api/v1/province/${encodeURIComponent(id)}` });
1742
1941
  }
1743
1942
  /**
1744
- * Performs the show operation for the province capability.
1943
+ * Read the province record. Local IDs are UUIDs; responses retain the named backend envelope.
1745
1944
  * Calls `GET /api/v1/province/{id}` through the shared IDP-aware Faiber client.
1746
1945
  * @param id Backend path identifier `id`.
1747
1946
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
1748
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
1749
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: province:read.
1947
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
1948
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: declared IDP permission province:read; gateway enforces ACL metadata, local annotation itself is not a permission check.
1750
1949
  */
1751
1950
  provinceShowGet(id, options) {
1752
1951
  return this.client.request({ ...options, method: "GET", url: `/api/v1/province/${encodeURIComponent(id)}` });
1753
1952
  }
1754
1953
  /**
1755
- * Performs the update operation for the province capability.
1954
+ * Update supplied fields on the province record. Local IDs are UUIDs; responses retain the named backend envelope.
1756
1955
  * Calls `PATCH /api/v1/province/{id}` through the shared IDP-aware Faiber client.
1757
1956
  * @param id Backend path identifier `id`.
1758
1957
  * @param data Typed JSON request body.
1759
1958
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
1760
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
1761
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: province:update.
1959
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
1960
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: declared IDP permission province:update; gateway enforces ACL metadata, local annotation itself is not a permission check.
1762
1961
  */
1763
1962
  provinceUpdatePatch(id, data, options) {
1764
1963
  return this.client.request({ ...options, method: "PATCH", url: `/api/v1/province/${encodeURIComponent(id)}`, data: data });
1765
1964
  }
1766
1965
  /**
1767
- * Performs the update operation for the province capability.
1966
+ * Update supplied fields on the province record. Local IDs are UUIDs; responses retain the named backend envelope.
1768
1967
  * Calls `PUT /api/v1/province/{id}` through the shared IDP-aware Faiber client.
1769
1968
  * @param id Backend path identifier `id`.
1770
1969
  * @param data Typed JSON request body.
1771
1970
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
1772
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
1773
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: province:update.
1971
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
1972
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: declared IDP permission province:update; gateway enforces ACL metadata, local annotation itself is not a permission check.
1774
1973
  */
1775
1974
  provinceUpdatePut(id, data, options) {
1776
1975
  return this.client.request({ ...options, method: "PUT", url: `/api/v1/province/${encodeURIComponent(id)}`, data: data });
1777
1976
  }
1778
1977
  /**
1779
- * Performs the force destroy operation for the province capability.
1978
+ * Permanently delete the province record. Local IDs are UUIDs; responses retain the named backend envelope.
1780
1979
  * Calls `DELETE /api/v1/province/force/{id}` through the shared IDP-aware Faiber client.
1781
1980
  * @param id Backend path identifier `id`.
1782
1981
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
1783
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
1784
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: province:delete.
1982
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
1983
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: declared IDP permission province:delete; gateway enforces ACL metadata, local annotation itself is not a permission check.
1785
1984
  */
1786
1985
  provinceForceDestroyDelete(id, options) {
1787
1986
  return this.client.request({ ...options, method: "DELETE", url: `/api/v1/province/force/${encodeURIComponent(id)}` });
1788
1987
  }
1789
1988
  /**
1790
- * Performs the restore operation for the province capability.
1989
+ * Restore the province record. Local IDs are UUIDs; responses retain the named backend envelope.
1791
1990
  * Calls `GET /api/v1/province/undo/{id}` through the shared IDP-aware Faiber client.
1792
1991
  * @param id Backend path identifier `id`.
1793
1992
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
1794
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
1795
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: province:delete.
1993
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
1994
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: declared IDP permission province:delete; gateway enforces ACL metadata, local annotation itself is not a permission check.
1796
1995
  */
1797
1996
  provinceRestoreGet(id, options) {
1798
1997
  return this.client.request({ ...options, method: "GET", url: `/api/v1/province/undo/${encodeURIComponent(id)}` });
1799
1998
  }
1800
1999
  /**
1801
- * Performs the list operation for the referral capability.
2000
+ * List undeleted referral sources ordered by sort_order.
1802
2001
  * Calls `GET /api/v1/referral-source` through the shared IDP-aware Faiber client.
1803
2002
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
1804
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
1805
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
2003
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
2004
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: gateway AuthContext; no additional named handler permission check.
1806
2005
  */
1807
2006
  referralListGet(options) {
1808
2007
  return this.client.request({ ...options, method: "GET", url: `/api/v1/referral-source` });
1809
2008
  }
1810
2009
  /**
1811
- * Performs the create operation for the referral capability.
2010
+ * Create a referral source requiring nonblank code and object labels/metadata.
1812
2011
  * Calls `POST /api/v1/referral-source` through the shared IDP-aware Faiber client.
1813
2012
  * @param data Typed JSON request body.
1814
2013
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
1815
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
1816
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
2014
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
2015
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: gateway AuthContext; no additional named handler permission check.
1817
2016
  */
1818
2017
  referralCreatePost(data, options) {
1819
2018
  return this.client.request({ ...options, method: "POST", url: `/api/v1/referral-source`, data: data });
1820
2019
  }
1821
2020
  /**
1822
- * Performs the delete operation for the referral capability.
2021
+ * Soft-delete and deactivate a referral source.
1823
2022
  * Calls `DELETE /api/v1/referral-source/{id}` through the shared IDP-aware Faiber client.
1824
2023
  * @param id Backend path identifier `id`.
1825
2024
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
1826
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
1827
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
2025
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
2026
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: gateway AuthContext; no additional named handler permission check.
1828
2027
  */
1829
2028
  referralDeleteDelete(id, options) {
1830
2029
  return this.client.request({ ...options, method: "DELETE", url: `/api/v1/referral-source/${encodeURIComponent(id)}` });
1831
2030
  }
1832
2031
  /**
1833
- * Performs the show operation for the referral capability.
2032
+ * Read a referral source by UUID.
1834
2033
  * Calls `GET /api/v1/referral-source/{id}` through the shared IDP-aware Faiber client.
1835
2034
  * @param id Backend path identifier `id`.
1836
2035
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
1837
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
1838
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
2036
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
2037
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: gateway AuthContext; no additional named handler permission check.
1839
2038
  */
1840
2039
  referralShowGet(id, options) {
1841
2040
  return this.client.request({ ...options, method: "GET", url: `/api/v1/referral-source/${encodeURIComponent(id)}` });
1842
2041
  }
1843
2042
  /**
1844
- * Performs the update operation for the referral capability.
2043
+ * Replace a referral source requiring nonblank code and object labels/metadata.
1845
2044
  * Calls `PUT /api/v1/referral-source/{id}` through the shared IDP-aware Faiber client.
1846
2045
  * @param id Backend path identifier `id`.
1847
2046
  * @param data Typed JSON request body.
1848
2047
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
1849
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
1850
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
2048
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
2049
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: gateway AuthContext; no additional named handler permission check.
1851
2050
  */
1852
2051
  referralUpdatePut(id, data, options) {
1853
2052
  return this.client.request({ ...options, method: "PUT", url: `/api/v1/referral-source/${encodeURIComponent(id)}`, data: data });
1854
2053
  }
1855
2054
  /**
1856
- * Performs the list types operation for the relation capability.
2055
+ * List undeleted relation types ordered by sort_order.
1857
2056
  * Calls `GET /api/v1/relation-type` through the shared IDP-aware Faiber client.
1858
2057
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
1859
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
1860
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
2058
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
2059
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: gateway AuthContext; no additional named handler permission check.
1861
2060
  */
1862
2061
  relationListTypesGet(options) {
1863
2062
  return this.client.request({ ...options, method: "GET", url: `/api/v1/relation-type` });
1864
2063
  }
1865
2064
  /**
1866
- * Performs the create type operation for the relation capability.
2065
+ * Create a validated relation type with object labels/constraints; directional managed inverses require an active inverse type.
1867
2066
  * Calls `POST /api/v1/relation-type` through the shared IDP-aware Faiber client.
1868
2067
  * @param data Typed JSON request body.
1869
2068
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
1870
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
1871
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
2069
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
2070
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: gateway AuthContext; no additional named handler permission check.
1872
2071
  */
1873
2072
  relationCreateTypePost(data, options) {
1874
2073
  return this.client.request({ ...options, method: "POST", url: `/api/v1/relation-type`, data: data });
1875
2074
  }
1876
2075
  /**
1877
- * Performs the delete type operation for the relation capability.
2076
+ * Soft-delete and deactivate a relation type.
1878
2077
  * Calls `DELETE /api/v1/relation-type/{id}` through the shared IDP-aware Faiber client.
1879
2078
  * @param id Backend path identifier `id`.
1880
2079
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
1881
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
1882
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
2080
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
2081
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: gateway AuthContext; no additional named handler permission check.
1883
2082
  */
1884
2083
  relationDeleteTypeDelete(id, options) {
1885
2084
  return this.client.request({ ...options, method: "DELETE", url: `/api/v1/relation-type/${encodeURIComponent(id)}` });
1886
2085
  }
1887
2086
  /**
1888
- * Performs the show type operation for the relation capability.
2087
+ * Read a relation type by UUID.
1889
2088
  * Calls `GET /api/v1/relation-type/{id}` through the shared IDP-aware Faiber client.
1890
2089
  * @param id Backend path identifier `id`.
1891
2090
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
1892
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
1893
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
2091
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
2092
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: gateway AuthContext; no additional named handler permission check.
1894
2093
  */
1895
2094
  relationShowTypeGet(id, options) {
1896
2095
  return this.client.request({ ...options, method: "GET", url: `/api/v1/relation-type/${encodeURIComponent(id)}` });
1897
2096
  }
1898
2097
  /**
1899
- * Performs the update type operation for the relation capability.
2098
+ * Replace a validated relation type definition.
1900
2099
  * Calls `PUT /api/v1/relation-type/{id}` through the shared IDP-aware Faiber client.
1901
2100
  * @param id Backend path identifier `id`.
1902
2101
  * @param data Typed JSON request body.
1903
2102
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
1904
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
1905
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
2103
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
2104
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: gateway AuthContext; no additional named handler permission check.
1906
2105
  */
1907
2106
  relationUpdateTypePut(id, data, options) {
1908
2107
  return this.client.request({ ...options, method: "PUT", url: `/api/v1/relation-type/${encodeURIComponent(id)}`, data: data });
1909
2108
  }
1910
2109
  /**
1911
- * Performs the index operation for the setting capability.
2110
+ * Read all numeric settings, newest first, under data.setting.
1912
2111
  * Calls `GET /api/v1/setting` through the shared IDP-aware Faiber client.
1913
2112
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
1914
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
1915
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: setting:read.
2113
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
2114
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: declared IDP permission setting:read; gateway enforces ACL metadata, local annotation itself is not a permission check.
1916
2115
  */
1917
2116
  settingIndexGet(options) {
1918
2117
  return this.client.request({ ...options, method: "GET", url: `/api/v1/setting` });
1919
2118
  }
1920
2119
  /**
1921
- * Performs the store operation for the setting capability.
2120
+ * Create a numeric setting from key/title/value and return data.setting.
1922
2121
  * Calls `POST /api/v1/setting` through the shared IDP-aware Faiber client.
1923
2122
  * @param data Typed JSON request body.
1924
2123
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
1925
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
1926
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: setting:create.
2124
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
2125
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: declared IDP permission setting:create; gateway enforces ACL metadata, local annotation itself is not a permission check.
1927
2126
  */
1928
2127
  settingStorePost(data, options) {
1929
2128
  return this.client.request({ ...options, method: "POST", url: `/api/v1/setting`, data: data });
1930
2129
  }
1931
2130
  /**
1932
- * Performs the actions list operation for the lifecycle capability.
2131
+ * List state actions, optionally by state_id, ordered by sort_order.
1933
2132
  * Calls `GET /api/v1/state-action` through the shared IDP-aware Faiber client.
1934
2133
  * @param params Typed query parameters; omitted members retain backend defaults.
1935
2134
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
1936
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
1937
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
2135
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
2136
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: gateway AuthContext; no additional named handler permission check.
1938
2137
  */
1939
2138
  lifecycleActionsListGet(params, options) {
1940
2139
  return this.client.request({ ...options, method: "GET", url: `/api/v1/state-action`, params });
1941
2140
  }
1942
2141
  /**
1943
- * Performs the create action operation for the lifecycle capability.
2142
+ * Create a validated enter/exit action of type event/webhook/message/external_flag with retry configuration.
1944
2143
  * Calls `POST /api/v1/state-action` through the shared IDP-aware Faiber client.
1945
2144
  * @param data Typed JSON request body.
1946
2145
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
1947
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
1948
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
2146
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
2147
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: gateway AuthContext; no additional named handler permission check.
1949
2148
  */
1950
2149
  lifecycleCreateActionPost(data, options) {
1951
2150
  return this.client.request({ ...options, method: "POST", url: `/api/v1/state-action`, data: data });
1952
2151
  }
1953
2152
  /**
1954
- * Performs the delete action operation for the lifecycle capability.
2153
+ * Disable an action; this command does not physically delete its row.
1955
2154
  * Calls `DELETE /api/v1/state-action/{id}` through the shared IDP-aware Faiber client.
1956
2155
  * @param id Backend path identifier `id`.
1957
2156
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
1958
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
1959
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
2157
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
2158
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: gateway AuthContext; no additional named handler permission check.
1960
2159
  */
1961
2160
  lifecycleDeleteActionDelete(id, options) {
1962
2161
  return this.client.request({ ...options, method: "DELETE", url: `/api/v1/state-action/${encodeURIComponent(id)}` });
1963
2162
  }
1964
2163
  /**
1965
- * Performs the show action operation for the lifecycle capability.
2164
+ * Read a state action by UUID.
1966
2165
  * Calls `GET /api/v1/state-action/{id}` through the shared IDP-aware Faiber client.
1967
2166
  * @param id Backend path identifier `id`.
1968
2167
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
1969
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
1970
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
2168
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
2169
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: gateway AuthContext; no additional named handler permission check.
1971
2170
  */
1972
2171
  lifecycleShowActionGet(id, options) {
1973
2172
  return this.client.request({ ...options, method: "GET", url: `/api/v1/state-action/${encodeURIComponent(id)}` });
1974
2173
  }
1975
2174
  /**
1976
- * Performs the update action operation for the lifecycle capability.
2175
+ * Replace a validated state action configuration.
1977
2176
  * Calls `PUT /api/v1/state-action/{id}` through the shared IDP-aware Faiber client.
1978
2177
  * @param id Backend path identifier `id`.
1979
2178
  * @param data Typed JSON request body.
1980
2179
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
1981
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
1982
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
2180
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
2181
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: gateway AuthContext; no additional named handler permission check.
1983
2182
  */
1984
2183
  lifecycleUpdateActionPut(id, data, options) {
1985
2184
  return this.client.request({ ...options, method: "PUT", url: `/api/v1/state-action/${encodeURIComponent(id)}`, data: data });
1986
2185
  }
1987
2186
  /**
1988
- * Performs the dry run action operation for the lifecycle capability.
2187
+ * Validate action configuration and evaluate its condition against empty facts; returns execution eligibility without executing or enqueueing.
1989
2188
  * Calls `POST /api/v1/state-action/dry-run` through the shared IDP-aware Faiber client.
1990
2189
  * @param data Typed JSON request body.
1991
2190
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
1992
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
1993
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
2191
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
2192
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: gateway AuthContext; no additional named handler permission check.
1994
2193
  */
1995
2194
  lifecycleDryRunActionPost(data, options) {
1996
2195
  return this.client.request({ ...options, method: "POST", url: `/api/v1/state-action/dry-run`, data: data });
1997
2196
  }
1998
2197
  /**
1999
- * Performs the states operation for the lifecycle capability.
2198
+ * List undeleted state definitions, optionally by system_id, highest priority first.
2000
2199
  * Calls `GET /api/v1/state-definition` through the shared IDP-aware Faiber client.
2001
2200
  * @param params Typed query parameters; omitted members retain backend defaults.
2002
2201
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
2003
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
2004
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
2202
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
2203
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: gateway AuthContext; no additional named handler permission check.
2005
2204
  */
2006
2205
  lifecycleStatesGet(params, options) {
2007
2206
  return this.client.request({ ...options, method: "GET", url: `/api/v1/state-definition`, params });
2008
2207
  }
2009
2208
  /**
2010
- * Performs the create state operation for the lifecycle capability.
2209
+ * Create a validated state under an existing system; each system may have one undeleted fallback. Immediate systems trigger reevaluation.
2011
2210
  * Calls `POST /api/v1/state-definition` through the shared IDP-aware Faiber client.
2012
2211
  * @param data Typed JSON request body.
2013
2212
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
2014
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
2015
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
2213
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
2214
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: gateway AuthContext; no additional named handler permission check.
2016
2215
  */
2017
2216
  lifecycleCreateStatePost(data, options) {
2018
2217
  return this.client.request({ ...options, method: "POST", url: `/api/v1/state-definition`, data: data });
2019
2218
  }
2020
2219
  /**
2021
- * Performs the delete state operation for the lifecycle capability.
2220
+ * Soft-delete/deactivate a state definition and trigger immediate-system reevaluation.
2022
2221
  * Calls `DELETE /api/v1/state-definition/{id}` through the shared IDP-aware Faiber client.
2023
2222
  * @param id Backend path identifier `id`.
2024
2223
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
2025
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
2026
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
2224
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
2225
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: gateway AuthContext; no additional named handler permission check.
2027
2226
  */
2028
2227
  lifecycleDeleteStateDelete(id, options) {
2029
2228
  return this.client.request({ ...options, method: "DELETE", url: `/api/v1/state-definition/${encodeURIComponent(id)}` });
2030
2229
  }
2031
2230
  /**
2032
- * Performs the show state operation for the lifecycle capability.
2231
+ * Read a state definition row by UUID.
2033
2232
  * Calls `GET /api/v1/state-definition/{id}` through the shared IDP-aware Faiber client.
2034
2233
  * @param id Backend path identifier `id`.
2035
2234
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
2036
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
2037
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
2235
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
2236
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: gateway AuthContext; no additional named handler permission check.
2038
2237
  */
2039
2238
  lifecycleShowStateGet(id, options) {
2040
2239
  return this.client.request({ ...options, method: "GET", url: `/api/v1/state-definition/${encodeURIComponent(id)}` });
2041
2240
  }
2042
2241
  /**
2043
- * Performs the update state operation for the lifecycle capability.
2242
+ * Replace a validated state configuration and increment version; immediate systems trigger reevaluation.
2044
2243
  * Calls `PUT /api/v1/state-definition/{id}` through the shared IDP-aware Faiber client.
2045
2244
  * @param id Backend path identifier `id`.
2046
2245
  * @param data Typed JSON request body.
2047
2246
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
2048
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
2049
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
2247
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
2248
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: gateway AuthContext; no additional named handler permission check.
2050
2249
  */
2051
2250
  lifecycleUpdateStatePut(id, data, options) {
2052
2251
  return this.client.request({ ...options, method: "PUT", url: `/api/v1/state-definition/${encodeURIComponent(id)}`, data: data });
2053
2252
  }
2054
2253
  /**
2055
- * Performs the action attempts operation for the lifecycle capability.
2254
+ * List action attempts optionally by outbox_id, newest first.
2056
2255
  * Calls `GET /api/v1/state-evaluation/action-attempts` through the shared IDP-aware Faiber client.
2057
2256
  * @param params Typed query parameters; omitted members retain backend defaults.
2058
2257
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
2059
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
2060
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
2258
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
2259
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: gateway AuthContext; no additional named handler permission check.
2061
2260
  */
2062
2261
  lifecycleActionAttemptsGet(params, options) {
2063
2262
  return this.client.request({ ...options, method: "GET", url: `/api/v1/state-evaluation/action-attempts`, params });
2064
2263
  }
2065
2264
  /**
2066
- * Performs the evaluate operation for the lifecycle capability.
2265
+ * Persist a changed eligible selected state under a profile/system lock, record its transition, and enqueue enter/exit actions; unchanged/ineligible results do not create transitions.
2067
2266
  * Calls `POST /api/v1/state-evaluation/evaluate` through the shared IDP-aware Faiber client.
2068
2267
  * @param data Typed JSON request body.
2069
2268
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
2070
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
2071
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
2269
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
2270
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: gateway AuthContext; no additional named handler permission check.
2072
2271
  */
2073
2272
  lifecycleEvaluatePost(data, options) {
2074
2273
  return this.client.request({ ...options, method: "POST", url: `/api/v1/state-evaluation/evaluate`, data: data });
2075
2274
  }
2076
2275
  /**
2077
- * Performs the outbox operation for the lifecycle capability.
2276
+ * List outbox rows optionally filtered by status.
2078
2277
  * Calls `GET /api/v1/state-evaluation/outbox` through the shared IDP-aware Faiber client.
2079
2278
  * @param params Typed query parameters; omitted members retain backend defaults.
2080
2279
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
2081
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
2082
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
2280
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
2281
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: gateway AuthContext; no additional named handler permission check.
2083
2282
  */
2084
2283
  lifecycleOutboxGet(params, options) {
2085
2284
  return this.client.request({ ...options, method: "GET", url: `/api/v1/state-evaluation/outbox`, params });
2086
2285
  }
2087
2286
  /**
2088
- * Performs the retry operation for the lifecycle capability.
2287
+ * Reset only a failed outbox row to pending; missing rows return 404 and other states 409.
2089
2288
  * Calls `POST /api/v1/state-evaluation/outbox/{id}/retry` through the shared IDP-aware Faiber client.
2090
2289
  * @param id Backend path identifier `id`.
2091
2290
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
2092
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
2093
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
2291
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
2292
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: gateway AuthContext; no additional named handler permission check.
2094
2293
  */
2095
2294
  lifecycleRetryPost(id, options) {
2096
2295
  return this.client.request({ ...options, method: "POST", url: `/api/v1/state-evaluation/outbox/${encodeURIComponent(id)}/retry` });
2097
2296
  }
2098
2297
  /**
2099
- * Performs the process outbox operation for the lifecycle capability.
2298
+ * Process up to 100 ready actions and return the count completed; may publish broker events or call configured webhooks.
2100
2299
  * Calls `POST /api/v1/state-evaluation/outbox/process` through the shared IDP-aware Faiber client.
2101
2300
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
2102
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
2103
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
2301
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
2302
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: gateway AuthContext; no additional named handler permission check.
2104
2303
  */
2105
2304
  lifecycleProcessOutboxPost(options) {
2106
2305
  return this.client.request({ ...options, method: "POST", url: `/api/v1/state-evaluation/outbox/process` });
2107
2306
  }
2108
2307
  /**
2109
- * Performs the preview operation for the lifecycle capability.
2308
+ * Evaluate system eligibility and choose the highest-priority matching active state or fallback without persisting transitions.
2110
2309
  * Calls `POST /api/v1/state-evaluation/preview` through the shared IDP-aware Faiber client.
2111
2310
  * @param data Typed JSON request body.
2112
2311
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
2113
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
2114
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
2312
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
2313
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: gateway AuthContext; no additional named handler permission check.
2115
2314
  */
2116
2315
  lifecyclePreviewPost(data, options) {
2117
2316
  return this.client.request({ ...options, method: "POST", url: `/api/v1/state-evaluation/preview`, data: data });
2118
2317
  }
2119
2318
  /**
2120
- * Performs the transitions operation for the lifecycle capability.
2319
+ * List transitions optionally filtered by Profile UUID and system UUID, newest first.
2121
2320
  * Calls `GET /api/v1/state-evaluation/transitions` through the shared IDP-aware Faiber client.
2122
2321
  * @param params Typed query parameters; omitted members retain backend defaults.
2123
2322
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
2124
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
2125
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
2323
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
2324
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: gateway AuthContext; no additional named handler permission check.
2126
2325
  */
2127
2326
  lifecycleTransitionsGet(params, options) {
2128
2327
  return this.client.request({ ...options, method: "GET", url: `/api/v1/state-evaluation/transitions`, params });
2129
2328
  }
2130
2329
  /**
2131
- * Performs the validate rule operation for the lifecycle capability.
2330
+ * Validate and evaluate the lifecycle AST against supplied JSON facts; returns valid/matched, invalid rules return 422.
2132
2331
  * Calls `POST /api/v1/state-evaluation/validate-rule` through the shared IDP-aware Faiber client.
2133
2332
  * @param data Typed JSON request body.
2134
2333
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
2135
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
2136
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
2334
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
2335
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: gateway AuthContext; no additional named handler permission check.
2137
2336
  */
2138
2337
  lifecycleValidateRulePost(data, options) {
2139
2338
  return this.client.request({ ...options, method: "POST", url: `/api/v1/state-evaluation/validate-rule`, data: data });
2140
2339
  }
2141
2340
  /**
2142
- * Performs the systems operation for the lifecycle capability.
2341
+ * List undeleted lifecycle systems ordered by code.
2143
2342
  * Calls `GET /api/v1/state-system` through the shared IDP-aware Faiber client.
2144
2343
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
2145
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
2146
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
2344
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
2345
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: gateway AuthContext; no additional named handler permission check.
2147
2346
  */
2148
2347
  lifecycleSystemsGet(options) {
2149
2348
  return this.client.request({ ...options, method: "GET", url: `/api/v1/state-system` });
2150
2349
  }
2151
2350
  /**
2152
- * Performs the create system operation for the lifecycle capability.
2351
+ * Create a lifecycle system with object labels/description, validated rule and optional valid cron schedule.
2153
2352
  * Calls `POST /api/v1/state-system` through the shared IDP-aware Faiber client.
2154
2353
  * @param data Typed JSON request body.
2155
2354
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
2156
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
2157
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
2355
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
2356
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: gateway AuthContext; no additional named handler permission check.
2158
2357
  */
2159
2358
  lifecycleCreateSystemPost(data, options) {
2160
2359
  return this.client.request({ ...options, method: "POST", url: `/api/v1/state-system`, data: data });
2161
2360
  }
2162
2361
  /**
2163
- * Performs the delete system operation for the lifecycle capability.
2362
+ * Soft-delete and deactivate a lifecycle system; acknowledge with an empty object.
2164
2363
  * Calls `DELETE /api/v1/state-system/{id}` through the shared IDP-aware Faiber client.
2165
2364
  * @param id Backend path identifier `id`.
2166
2365
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
2167
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
2168
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
2366
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
2367
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: gateway AuthContext; no additional named handler permission check.
2169
2368
  */
2170
2369
  lifecycleDeleteSystemDelete(id, options) {
2171
2370
  return this.client.request({ ...options, method: "DELETE", url: `/api/v1/state-system/${encodeURIComponent(id)}` });
2172
2371
  }
2173
2372
  /**
2174
- * Performs the show system operation for the lifecycle capability.
2373
+ * Read a lifecycle system row by local UUID, including a soft-deleted row if present.
2175
2374
  * Calls `GET /api/v1/state-system/{id}` through the shared IDP-aware Faiber client.
2176
2375
  * @param id Backend path identifier `id`.
2177
2376
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
2178
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
2179
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
2377
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
2378
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: gateway AuthContext; no additional named handler permission check.
2180
2379
  */
2181
2380
  lifecycleShowSystemGet(id, options) {
2182
2381
  return this.client.request({ ...options, method: "GET", url: `/api/v1/state-system/${encodeURIComponent(id)}` });
2183
2382
  }
2184
2383
  /**
2185
- * Performs the update system operation for the lifecycle capability.
2384
+ * Replace lifecycle system configuration, increment version and trigger reevaluation for immediate publication mode.
2186
2385
  * Calls `PUT /api/v1/state-system/{id}` through the shared IDP-aware Faiber client.
2187
2386
  * @param id Backend path identifier `id`.
2188
2387
  * @param data Typed JSON request body.
2189
2388
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
2190
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
2191
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
2389
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
2390
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: gateway AuthContext; no additional named handler permission check.
2192
2391
  */
2193
2392
  lifecycleUpdateSystemPut(id, data, options) {
2194
2393
  return this.client.request({ ...options, method: "PUT", url: `/api/v1/state-system/${encodeURIComponent(id)}`, data: data });
2195
2394
  }
2196
2395
  /**
2197
- * Performs the index operation for the survey capability.
2396
+ * Read all survey rows without pagination. meta is arbitrary stored JSON.
2198
2397
  * Calls `GET /api/v1/survey` through the shared IDP-aware Faiber client.
2199
2398
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
2200
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
2201
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: survey:read.
2399
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
2400
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: declared IDP permission survey:read; gateway enforces ACL metadata, local annotation itself is not a permission check.
2202
2401
  */
2203
2402
  surveyIndexGet(options) {
2204
2403
  return this.client.request({ ...options, method: "GET", url: `/api/v1/survey` });
2205
2404
  }
2206
2405
  /**
2207
- * Performs the store operation for the survey capability.
2406
+ * Create a survey row. Request key type is serialized as survey_type on the returned row; enrollment_id/type/meta may be omitted or null.
2208
2407
  * Calls `POST /api/v1/survey` through the shared IDP-aware Faiber client.
2209
2408
  * @param data Typed JSON request body.
2210
2409
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
2211
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
2212
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: survey:create.
2410
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
2411
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: declared IDP permission survey:create; gateway enforces ACL metadata, local annotation itself is not a permission check.
2213
2412
  */
2214
2413
  surveyStorePost(data, options) {
2215
2414
  return this.client.request({ ...options, method: "POST", url: `/api/v1/survey`, data: data });
2216
2415
  }
2217
2416
  /**
2218
- * Performs the index operation for the trusted service capability.
2417
+ * List the trusted service records. List pagination defaults 1/15 and caps at 100; filters apply before pagination, and deleted records are hidden unless filter[trashed]=only/with.
2219
2418
  * Calls `GET /api/v1/trusted-service` through the shared IDP-aware Faiber client.
2220
2419
  * @param params Typed query parameters; omitted members retain backend defaults.
2221
2420
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
2222
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
2223
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: trusted_service:read.
2421
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
2422
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: declared IDP permission trusted_service:read; gateway enforces ACL metadata, local annotation itself is not a permission check.
2224
2423
  */
2225
2424
  trustedServiceIndexGet(params, options) {
2226
2425
  return this.client.request({ ...options, method: "GET", url: `/api/v1/trusted-service`, params });
2227
2426
  }
2228
2427
  /**
2229
- * Performs the store operation for the trusted service capability.
2428
+ * Create the trusted service record. Local IDs are UUIDs; responses retain the named backend envelope.
2230
2429
  * Calls `POST /api/v1/trusted-service` through the shared IDP-aware Faiber client.
2231
2430
  * @param data Typed JSON request body.
2232
2431
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
2233
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
2234
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: trusted_service:create.
2432
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
2433
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: declared IDP permission trusted_service:create; gateway enforces ACL metadata, local annotation itself is not a permission check.
2235
2434
  */
2236
2435
  trustedServiceStorePost(data, options) {
2237
2436
  return this.client.request({ ...options, method: "POST", url: `/api/v1/trusted-service`, data: data });
2238
2437
  }
2239
2438
  /**
2240
- * Performs the destroy operation for the trusted service capability.
2439
+ * Soft-delete the trusted service record. Local IDs are UUIDs; responses retain the named backend envelope.
2241
2440
  * Calls `DELETE /api/v1/trusted-service/{id}` through the shared IDP-aware Faiber client.
2242
2441
  * @param id Backend path identifier `id`.
2243
2442
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
2244
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
2245
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: trusted_service:delete.
2443
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
2444
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: declared IDP permission trusted_service:delete; gateway enforces ACL metadata, local annotation itself is not a permission check.
2246
2445
  */
2247
2446
  trustedServiceDestroyDelete(id, options) {
2248
2447
  return this.client.request({ ...options, method: "DELETE", url: `/api/v1/trusted-service/${encodeURIComponent(id)}` });
2249
2448
  }
2250
2449
  /**
2251
- * Performs the show operation for the trusted service capability.
2450
+ * Read the trusted service record. Local IDs are UUIDs; responses retain the named backend envelope.
2252
2451
  * Calls `GET /api/v1/trusted-service/{id}` through the shared IDP-aware Faiber client.
2253
2452
  * @param id Backend path identifier `id`.
2254
2453
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
2255
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
2256
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: trusted_service:read.
2454
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
2455
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: declared IDP permission trusted_service:read; gateway enforces ACL metadata, local annotation itself is not a permission check.
2257
2456
  */
2258
2457
  trustedServiceShowGet(id, options) {
2259
2458
  return this.client.request({ ...options, method: "GET", url: `/api/v1/trusted-service/${encodeURIComponent(id)}` });
2260
2459
  }
2261
2460
  /**
2262
- * Performs the update operation for the trusted service capability.
2461
+ * Update supplied fields on the trusted service record. Local IDs are UUIDs; responses retain the named backend envelope.
2263
2462
  * Calls `PATCH /api/v1/trusted-service/{id}` through the shared IDP-aware Faiber client.
2264
2463
  * @param id Backend path identifier `id`.
2265
2464
  * @param data Typed JSON request body.
2266
2465
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
2267
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
2268
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: trusted_service:update.
2466
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
2467
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: declared IDP permission trusted_service:update; gateway enforces ACL metadata, local annotation itself is not a permission check.
2269
2468
  */
2270
2469
  trustedServiceUpdatePatch(id, data, options) {
2271
2470
  return this.client.request({ ...options, method: "PATCH", url: `/api/v1/trusted-service/${encodeURIComponent(id)}`, data: data });
2272
2471
  }
2273
2472
  /**
2274
- * Performs the update operation for the trusted service capability.
2473
+ * Update supplied fields on the trusted service record. Local IDs are UUIDs; responses retain the named backend envelope.
2275
2474
  * Calls `PUT /api/v1/trusted-service/{id}` through the shared IDP-aware Faiber client.
2276
2475
  * @param id Backend path identifier `id`.
2277
2476
  * @param data Typed JSON request body.
2278
2477
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
2279
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
2280
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: trusted_service:update.
2478
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
2479
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: declared IDP permission trusted_service:update; gateway enforces ACL metadata, local annotation itself is not a permission check.
2281
2480
  */
2282
2481
  trustedServiceUpdatePut(id, data, options) {
2283
2482
  return this.client.request({ ...options, method: "PUT", url: `/api/v1/trusted-service/${encodeURIComponent(id)}`, data: data });
2284
2483
  }
2285
2484
  /**
2286
- * Performs the event index operation for the trusted service capability.
2485
+ * Manage trusted-service event visibility and arbitrary payload_schema within the path service UUID. Event reads/updates/deletes verify event ownership and deleted status.
2287
2486
  * Calls `GET /api/v1/trusted-service/{id}/event` through the shared IDP-aware Faiber client.
2288
2487
  * @param id Backend path identifier `id`.
2289
2488
  * @param params Typed query parameters; omitted members retain backend defaults.
2290
2489
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
2291
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
2292
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: trusted_service:read.
2490
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
2491
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: declared IDP permission trusted_service:read; gateway enforces ACL metadata, local annotation itself is not a permission check.
2293
2492
  */
2294
2493
  trustedServiceEventIndexGet(id, params, options) {
2295
2494
  return this.client.request({ ...options, method: "GET", url: `/api/v1/trusted-service/${encodeURIComponent(id)}/event`, params });
2296
2495
  }
2297
2496
  /**
2298
- * Performs the event store operation for the trusted service capability.
2497
+ * Manage trusted-service event visibility and arbitrary payload_schema within the path service UUID. Event reads/updates/deletes verify event ownership and deleted status.
2299
2498
  * Calls `POST /api/v1/trusted-service/{id}/event` through the shared IDP-aware Faiber client.
2300
2499
  * @param id Backend path identifier `id`.
2301
2500
  * @param data Typed JSON request body.
2302
2501
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
2303
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
2304
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: trusted_service:create.
2502
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
2503
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: declared IDP permission trusted_service:create; gateway enforces ACL metadata, local annotation itself is not a permission check.
2305
2504
  */
2306
2505
  trustedServiceEventStorePost(id, data, options) {
2307
2506
  return this.client.request({ ...options, method: "POST", url: `/api/v1/trusted-service/${encodeURIComponent(id)}/event`, data: data });
2308
2507
  }
2309
2508
  /**
2310
- * Performs the event destroy operation for the trusted service capability.
2509
+ * Manage trusted-service event visibility and arbitrary payload_schema within the path service UUID. Event reads/updates/deletes verify event ownership and deleted status.
2311
2510
  * Calls `DELETE /api/v1/trusted-service/{id}/event/{event_id}` through the shared IDP-aware Faiber client.
2312
2511
  * @param id Backend path identifier `id`.
2313
2512
  * @param eventId Backend path identifier `event_id`.
2314
2513
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
2315
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
2316
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: trusted_service:delete.
2514
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
2515
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: declared IDP permission trusted_service:delete; gateway enforces ACL metadata, local annotation itself is not a permission check.
2317
2516
  */
2318
2517
  trustedServiceEventDestroyDelete(id, eventId, options) {
2319
2518
  return this.client.request({ ...options, method: "DELETE", url: `/api/v1/trusted-service/${encodeURIComponent(id)}/event/${encodeURIComponent(eventId)}` });
2320
2519
  }
2321
2520
  /**
2322
- * Performs the event show operation for the trusted service capability.
2521
+ * Manage trusted-service event visibility and arbitrary payload_schema within the path service UUID. Event reads/updates/deletes verify event ownership and deleted status.
2323
2522
  * Calls `GET /api/v1/trusted-service/{id}/event/{event_id}` through the shared IDP-aware Faiber client.
2324
2523
  * @param id Backend path identifier `id`.
2325
2524
  * @param eventId Backend path identifier `event_id`.
2326
2525
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
2327
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
2328
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: trusted_service:read.
2526
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
2527
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: declared IDP permission trusted_service:read; gateway enforces ACL metadata, local annotation itself is not a permission check.
2329
2528
  */
2330
2529
  trustedServiceEventShowGet(id, eventId, options) {
2331
2530
  return this.client.request({ ...options, method: "GET", url: `/api/v1/trusted-service/${encodeURIComponent(id)}/event/${encodeURIComponent(eventId)}` });
2332
2531
  }
2333
2532
  /**
2334
- * Performs the event update operation for the trusted service capability.
2533
+ * Manage trusted-service event visibility and arbitrary payload_schema within the path service UUID. Event reads/updates/deletes verify event ownership and deleted status.
2335
2534
  * Calls `PATCH /api/v1/trusted-service/{id}/event/{event_id}` through the shared IDP-aware Faiber client.
2336
2535
  * @param id Backend path identifier `id`.
2337
2536
  * @param eventId Backend path identifier `event_id`.
2338
2537
  * @param data Typed JSON request body.
2339
2538
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
2340
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
2341
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: trusted_service:update.
2539
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
2540
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: declared IDP permission trusted_service:update; gateway enforces ACL metadata, local annotation itself is not a permission check.
2342
2541
  */
2343
2542
  trustedServiceEventUpdatePatch(id, eventId, data, options) {
2344
2543
  return this.client.request({ ...options, method: "PATCH", url: `/api/v1/trusted-service/${encodeURIComponent(id)}/event/${encodeURIComponent(eventId)}`, data: data });
2345
2544
  }
2346
2545
  /**
2347
- * Performs the event update operation for the trusted service capability.
2546
+ * Manage trusted-service event visibility and arbitrary payload_schema within the path service UUID. Event reads/updates/deletes verify event ownership and deleted status.
2348
2547
  * Calls `PUT /api/v1/trusted-service/{id}/event/{event_id}` through the shared IDP-aware Faiber client.
2349
2548
  * @param id Backend path identifier `id`.
2350
2549
  * @param eventId Backend path identifier `event_id`.
2351
2550
  * @param data Typed JSON request body.
2352
2551
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
2353
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
2354
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: trusted_service:update.
2552
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
2553
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: declared IDP permission trusted_service:update; gateway enforces ACL metadata, local annotation itself is not a permission check.
2355
2554
  */
2356
2555
  trustedServiceEventUpdatePut(id, eventId, data, options) {
2357
2556
  return this.client.request({ ...options, method: "PUT", url: `/api/v1/trusted-service/${encodeURIComponent(id)}/event/${encodeURIComponent(eventId)}`, data: data });
2358
2557
  }
2359
2558
  /**
2360
- * Performs the health operation for the router capability.
2559
+ * Read active campaigns in their current date window, ordered by sort_order and creation time. visibility metadata is returned as data and is not a row predicate.
2560
+ * Calls `GET /campaign` through the shared IDP-aware Faiber client.
2561
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
2562
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
2563
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: gateway AuthContext; no additional named handler permission check.
2564
+ */
2565
+ campaignIndexGet(options) {
2566
+ return this.client.request({ ...options, method: "GET", url: `/campaign` });
2567
+ }
2568
+ /**
2569
+ * Read current user contribution history with purpose snapshots; confirmed_at is not serialized.
2570
+ * Calls `GET /campaign-profile/me/contributions` through the shared IDP-aware Faiber client.
2571
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
2572
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
2573
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: gateway AuthContext; no additional named handler permission check.
2574
+ */
2575
+ campaignMyContributionsGet(options) {
2576
+ return this.client.request({ ...options, method: "GET", url: `/campaign-profile/me/contributions` });
2577
+ }
2578
+ /**
2579
+ * Read one campaign projection by UUID; the detail query does not restrict status or date window.
2580
+ * Calls `GET /campaign/{id}` through the shared IDP-aware Faiber client.
2581
+ * @param id Backend path identifier `id`.
2582
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
2583
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
2584
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: gateway AuthContext; no additional named handler permission check.
2585
+ */
2586
+ campaignShowGet(id, options) {
2587
+ return this.client.request({ ...options, method: "GET", url: `/campaign/${encodeURIComponent(id)}` });
2588
+ }
2589
+ /**
2590
+ * Record a positive money/sha contribution for an available campaign using current user and idempotency_key. Disabled methods return 409, invalid amount/method 422; duplicate user/key reuses the existing receipt.
2591
+ * Calls `POST /campaign/{id}/contributions` through the shared IDP-aware Faiber client.
2592
+ * @param id Backend path identifier `id`.
2593
+ * @param data Typed JSON request body.
2594
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
2595
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
2596
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: gateway AuthContext; no additional named handler permission check.
2597
+ */
2598
+ campaignContributePost(id, data, options) {
2599
+ return this.client.request({ ...options, method: "POST", url: `/campaign/${encodeURIComponent(id)}/contributions`, data: data });
2600
+ }
2601
+ /**
2602
+ * Read process health and the package version; no dependency readiness check is performed.
2361
2603
  * Calls `GET /health` through the shared IDP-aware Faiber client.
2362
2604
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
2363
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
2364
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
2605
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
2606
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: no local authentication or permission check; deployment gateway policy is separate.
2365
2607
  */
2366
2608
  routerHealthGetHealth(options) {
2367
2609
  return this.client.request({ ...options, method: "GET", url: `/health` });
2368
2610
  }
2369
2611
  /**
2370
- * Performs the health operation for the router capability.
2612
+ * Read process health and the package version; no dependency readiness check is performed.
2371
2613
  * Calls `GET /up` through the shared IDP-aware Faiber client.
2372
2614
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
2373
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
2374
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
2615
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
2616
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: no local authentication or permission check; deployment gateway policy is separate.
2375
2617
  */
2376
2618
  routerHealthGetUp(options) {
2377
2619
  return this.client.request({ ...options, method: "GET", url: `/up` });