@faiber/faiber-crm 0.2.2 → 0.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,410 +1,1149 @@
1
1
  import { ServiceApi, urlEncoded } from "@faiber/sdk-core";
2
2
  export class CrmOperations extends ServiceApi {
3
- /** GET /; permission: public/session-derived. */
3
+ /**
4
+ * Performs the status route operation for the router capability.
5
+ * Calls `GET /` through the shared IDP-aware Faiber client.
6
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
7
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
8
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
9
+ */
4
10
  routerStatusRouteGet(options) {
5
11
  return this.client.request({ ...options, method: "GET", url: `/` });
6
12
  }
7
- /** GET /api/openapi.json; permission: public/session-derived. */
13
+ /**
14
+ * Performs the openapi json operation for the router capability.
15
+ * Calls `GET /api/openapi.json` through the shared IDP-aware Faiber client.
16
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
17
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
18
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
19
+ */
8
20
  routerOpenapiJsonGet(options) {
9
21
  return this.client.request({ ...options, method: "GET", url: `/api/openapi.json` });
10
22
  }
11
- /** GET /api/v1/integration/docs; permission: admin:integration:read. */
23
+ /**
24
+ * Performs the integration docs show operation for the integration capability.
25
+ * Calls `GET /api/v1/integration/docs` through the shared IDP-aware Faiber client.
26
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
27
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
28
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: admin:integration:read.
29
+ */
12
30
  integrationIntegrationDocsShowGet(options) {
13
31
  return this.client.request({ ...options, method: "GET", url: `/api/v1/integration/docs` });
14
32
  }
15
- /** GET /api/v1/integration/flow; permission: public/session-derived. */
33
+ /**
34
+ * Performs the flow integration show operation for the integration capability.
35
+ * Calls `GET /api/v1/integration/flow` through the shared IDP-aware Faiber client.
36
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
37
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
38
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
39
+ */
16
40
  integrationFlowIntegrationShowGet(options) {
17
41
  return this.client.request({ ...options, method: "GET", url: `/api/v1/integration/flow` });
18
42
  }
19
- /** GET /api/v1/lead; permission: lead:read, lead:read_all, lead:read_own. */
43
+ /**
44
+ * Performs the index operation for the lead capability.
45
+ * Calls `GET /api/v1/lead` through the shared IDP-aware Faiber client.
46
+ * @param params Typed query parameters; omitted members retain backend defaults.
47
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
48
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
49
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: lead:read, lead:read_all, lead:read_own.
50
+ */
20
51
  leadIndexGet(params, options) {
21
52
  return this.client.request({ ...options, method: "GET", url: `/api/v1/lead`, params });
22
53
  }
23
- /** POST /api/v1/lead; permission: lead:create. */
54
+ /**
55
+ * Performs the create operation for the lead capability.
56
+ * Calls `POST /api/v1/lead` through the shared IDP-aware Faiber client.
57
+ * @param data Typed JSON request body.
58
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
59
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
60
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: lead:create.
61
+ */
24
62
  leadCreatePost(data, options) {
25
63
  return this.client.request({ ...options, method: "POST", url: `/api/v1/lead`, data: data });
26
64
  }
27
- /** GET /api/v1/lead-campaign; permission: public/session-derived. */
65
+ /**
66
+ * Performs the index operation for the lead campaign capability.
67
+ * Calls `GET /api/v1/lead-campaign` through the shared IDP-aware Faiber client.
68
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
69
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
70
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
71
+ */
28
72
  leadCampaignIndexGet(options) {
29
73
  return this.client.request({ ...options, method: "GET", url: `/api/v1/lead-campaign` });
30
74
  }
31
- /** POST /api/v1/lead-campaign; permission: public/session-derived. */
75
+ /**
76
+ * Performs the create operation for the lead campaign capability.
77
+ * Calls `POST /api/v1/lead-campaign` through the shared IDP-aware Faiber client.
78
+ * @param data Typed JSON request body.
79
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
80
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
81
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
82
+ */
32
83
  leadCampaignCreatePost(data, options) {
33
84
  return this.client.request({ ...options, method: "POST", url: `/api/v1/lead-campaign`, data: data });
34
85
  }
35
- /** DELETE /api/v1/lead-campaign/{id}; permission: public/session-derived. */
86
+ /**
87
+ * Performs the destroy operation for the lead campaign capability.
88
+ * Calls `DELETE /api/v1/lead-campaign/{id}` through the shared IDP-aware Faiber client.
89
+ * @param id Backend path identifier `id`.
90
+ * @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.
93
+ */
36
94
  leadCampaignDestroyDelete(id, options) {
37
95
  return this.client.request({ ...options, method: "DELETE", url: `/api/v1/lead-campaign/${encodeURIComponent(id)}` });
38
96
  }
39
- /** GET /api/v1/lead-campaign/{id}; permission: public/session-derived. */
97
+ /**
98
+ * Performs the show operation for the lead campaign capability.
99
+ * Calls `GET /api/v1/lead-campaign/{id}` through the shared IDP-aware Faiber client.
100
+ * @param id Backend path identifier `id`.
101
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
102
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
103
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
104
+ */
40
105
  leadCampaignShowGet(id, options) {
41
106
  return this.client.request({ ...options, method: "GET", url: `/api/v1/lead-campaign/${encodeURIComponent(id)}` });
42
107
  }
43
- /** PUT /api/v1/lead-campaign/{id}; permission: public/session-derived. */
108
+ /**
109
+ * Performs the update operation for the lead campaign capability.
110
+ * Calls `PUT /api/v1/lead-campaign/{id}` through the shared IDP-aware Faiber client.
111
+ * @param id Backend path identifier `id`.
112
+ * @param data Typed JSON request body.
113
+ * @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: session-derived or public bootstrap route.
116
+ */
44
117
  leadCampaignUpdatePut(id, data, options) {
45
118
  return this.client.request({ ...options, method: "PUT", url: `/api/v1/lead-campaign/${encodeURIComponent(id)}`, data: data });
46
119
  }
47
- /** GET /api/v1/lead-source; permission: public/session-derived. */
120
+ /**
121
+ * Performs the index operation for the lead source capability.
122
+ * Calls `GET /api/v1/lead-source` through the shared IDP-aware Faiber client.
123
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
124
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
125
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
126
+ */
48
127
  leadSourceIndexGet(options) {
49
128
  return this.client.request({ ...options, method: "GET", url: `/api/v1/lead-source` });
50
129
  }
51
- /** POST /api/v1/lead-source; permission: public/session-derived. */
130
+ /**
131
+ * Performs the create operation for the lead source capability.
132
+ * Calls `POST /api/v1/lead-source` through the shared IDP-aware Faiber client.
133
+ * @param data Typed JSON request body.
134
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
135
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
136
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
137
+ */
52
138
  leadSourceCreatePost(data, options) {
53
139
  return this.client.request({ ...options, method: "POST", url: `/api/v1/lead-source`, data: data });
54
140
  }
55
- /** DELETE /api/v1/lead-source/{id}; permission: public/session-derived. */
141
+ /**
142
+ * Performs the destroy operation for the lead source capability.
143
+ * Calls `DELETE /api/v1/lead-source/{id}` through the shared IDP-aware Faiber client.
144
+ * @param id Backend path identifier `id`.
145
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
146
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
147
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
148
+ */
56
149
  leadSourceDestroyDelete(id, options) {
57
150
  return this.client.request({ ...options, method: "DELETE", url: `/api/v1/lead-source/${encodeURIComponent(id)}` });
58
151
  }
59
- /** GET /api/v1/lead-source/{id}; permission: public/session-derived. */
152
+ /**
153
+ * Performs the show operation for the lead source capability.
154
+ * Calls `GET /api/v1/lead-source/{id}` through the shared IDP-aware Faiber client.
155
+ * @param id Backend path identifier `id`.
156
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
157
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
158
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
159
+ */
60
160
  leadSourceShowGet(id, options) {
61
161
  return this.client.request({ ...options, method: "GET", url: `/api/v1/lead-source/${encodeURIComponent(id)}` });
62
162
  }
63
- /** PUT /api/v1/lead-source/{id}; permission: public/session-derived. */
163
+ /**
164
+ * Performs the update operation for the lead source capability.
165
+ * Calls `PUT /api/v1/lead-source/{id}` through the shared IDP-aware Faiber client.
166
+ * @param id Backend path identifier `id`.
167
+ * @param data Typed JSON request body.
168
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
169
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
170
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
171
+ */
64
172
  leadSourceUpdatePut(id, data, options) {
65
173
  return this.client.request({ ...options, method: "PUT", url: `/api/v1/lead-source/${encodeURIComponent(id)}`, data: data });
66
174
  }
67
- /** DELETE /api/v1/lead/{id}; permission: lead:delete. */
175
+ /**
176
+ * Performs the destroy operation for the lead capability.
177
+ * Calls `DELETE /api/v1/lead/{id}` through the shared IDP-aware Faiber client.
178
+ * @param id Backend path identifier `id`.
179
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
180
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
181
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: lead:delete.
182
+ */
68
183
  leadDestroyDelete(id, options) {
69
184
  return this.client.request({ ...options, method: "DELETE", url: `/api/v1/lead/${encodeURIComponent(id)}` });
70
185
  }
71
- /** GET /api/v1/lead/{id}; permission: lead:read, lead:read_all, lead:read_own. */
186
+ /**
187
+ * Performs the show operation for the lead capability.
188
+ * Calls `GET /api/v1/lead/{id}` through the shared IDP-aware Faiber client.
189
+ * @param id Backend path identifier `id`.
190
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
191
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
192
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: lead:read, lead:read_all, lead:read_own.
193
+ */
72
194
  leadShowGet(id, options) {
73
195
  return this.client.request({ ...options, method: "GET", url: `/api/v1/lead/${encodeURIComponent(id)}` });
74
196
  }
75
- /** PUT /api/v1/lead/{id}; permission: lead:update. */
197
+ /**
198
+ * Performs the update operation for the lead capability.
199
+ * Calls `PUT /api/v1/lead/{id}` through the shared IDP-aware Faiber client.
200
+ * @param id Backend path identifier `id`.
201
+ * @param data Typed JSON request body.
202
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
203
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
204
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: lead:update.
205
+ */
76
206
  leadUpdatePut(id, data, options) {
77
207
  return this.client.request({ ...options, method: "PUT", url: `/api/v1/lead/${encodeURIComponent(id)}`, data: data });
78
208
  }
79
- /** GET /api/v1/lead/{id}/check-status; permission: lead:update. */
209
+ /**
210
+ * Performs the check status operation for the lead capability.
211
+ * Calls `GET /api/v1/lead/{id}/check-status` through the shared IDP-aware Faiber client.
212
+ * @param id Backend path identifier `id`.
213
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
214
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
215
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: lead:update.
216
+ */
80
217
  leadCheckStatusGet(id, options) {
81
218
  return this.client.request({ ...options, method: "GET", url: `/api/v1/lead/${encodeURIComponent(id)}/check-status` });
82
219
  }
83
- /** GET /api/v1/lead/{id}/log; permission: lead_log:read. */
220
+ /**
221
+ * Performs the list logs operation for the lead capability.
222
+ * Calls `GET /api/v1/lead/{id}/log` through the shared IDP-aware Faiber client.
223
+ * @param id Backend path identifier `id`.
224
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
225
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
226
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: lead_log:read.
227
+ */
84
228
  leadListLogsGet(id, options) {
85
229
  return this.client.request({ ...options, method: "GET", url: `/api/v1/lead/${encodeURIComponent(id)}/log` });
86
230
  }
87
- /** POST /api/v1/lead/{id}/log; permission: lead_log:create. */
231
+ /**
232
+ * Performs the create log operation for the lead capability.
233
+ * Calls `POST /api/v1/lead/{id}/log` through the shared IDP-aware Faiber client.
234
+ * @param id Backend path identifier `id`.
235
+ * @param data Typed JSON request body.
236
+ * @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: lead_log:create.
239
+ */
88
240
  leadCreateLogPost(id, data, options) {
89
241
  return this.client.request({ ...options, method: "POST", url: `/api/v1/lead/${encodeURIComponent(id)}/log`, data: data });
90
242
  }
91
- /** DELETE /api/v1/lead/{id}/log/{log_id}; permission: lead_log:delete. */
243
+ /**
244
+ * Performs the destroy log operation for the lead capability.
245
+ * Calls `DELETE /api/v1/lead/{id}/log/{log_id}` through the shared IDP-aware Faiber client.
246
+ * @param id Backend path identifier `id`.
247
+ * @param logId Backend path identifier `log_id`.
248
+ * @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: lead_log:delete.
251
+ */
92
252
  leadDestroyLogDelete(id, logId, options) {
93
253
  return this.client.request({ ...options, method: "DELETE", url: `/api/v1/lead/${encodeURIComponent(id)}/log/${encodeURIComponent(logId)}` });
94
254
  }
95
- /** GET /api/v1/lead/{id}/log/{log_id}; permission: lead_log:read. */
255
+ /**
256
+ * Performs the show log operation for the lead capability.
257
+ * Calls `GET /api/v1/lead/{id}/log/{log_id}` through the shared IDP-aware Faiber client.
258
+ * @param id Backend path identifier `id`.
259
+ * @param logId Backend path identifier `log_id`.
260
+ * @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: lead_log:read.
263
+ */
96
264
  leadShowLogGet(id, logId, options) {
97
265
  return this.client.request({ ...options, method: "GET", url: `/api/v1/lead/${encodeURIComponent(id)}/log/${encodeURIComponent(logId)}` });
98
266
  }
99
- /** PUT /api/v1/lead/{id}/log/{log_id}; permission: lead_log:update. */
267
+ /**
268
+ * Performs the update log operation for the lead capability.
269
+ * Calls `PUT /api/v1/lead/{id}/log/{log_id}` through the shared IDP-aware Faiber client.
270
+ * @param id Backend path identifier `id`.
271
+ * @param logId Backend path identifier `log_id`.
272
+ * @param data Typed JSON request body.
273
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
274
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
275
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: lead_log:update.
276
+ */
100
277
  leadUpdateLogPut(id, logId, data, options) {
101
278
  return this.client.request({ ...options, method: "PUT", url: `/api/v1/lead/${encodeURIComponent(id)}/log/${encodeURIComponent(logId)}`, data: data });
102
279
  }
103
- /** PUT /api/v1/lead/{id}/move-to-done; permission: lead:update. */
280
+ /**
281
+ * Performs the move to done operation for the lead capability.
282
+ * Calls `PUT /api/v1/lead/{id}/move-to-done` through the shared IDP-aware Faiber client.
283
+ * @param id Backend path identifier `id`.
284
+ * @param data Typed JSON request body.
285
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
286
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
287
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: lead:update.
288
+ */
104
289
  leadMoveToDonePut(id, data, options) {
105
290
  return this.client.request({ ...options, method: "PUT", url: `/api/v1/lead/${encodeURIComponent(id)}/move-to-done`, data: data });
106
291
  }
107
- /** GET /api/v1/lead/{id}/touch; permission: lead_touch:read. */
292
+ /**
293
+ * Performs the list touches operation for the lead capability.
294
+ * Calls `GET /api/v1/lead/{id}/touch` through the shared IDP-aware Faiber client.
295
+ * @param id Backend path identifier `id`.
296
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
297
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
298
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: lead_touch:read.
299
+ */
108
300
  leadListTouchesGet(id, options) {
109
301
  return this.client.request({ ...options, method: "GET", url: `/api/v1/lead/${encodeURIComponent(id)}/touch` });
110
302
  }
111
- /** POST /api/v1/lead/{id}/touch; permission: lead_touch:create. */
303
+ /**
304
+ * Performs the create touch operation for the lead capability.
305
+ * Calls `POST /api/v1/lead/{id}/touch` through the shared IDP-aware Faiber client.
306
+ * @param id Backend path identifier `id`.
307
+ * @param data Typed JSON request body.
308
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
309
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
310
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: lead_touch:create.
311
+ */
112
312
  leadCreateTouchPost(id, data, options) {
113
313
  return this.client.request({ ...options, method: "POST", url: `/api/v1/lead/${encodeURIComponent(id)}/touch`, data: data });
114
314
  }
115
- /** DELETE /api/v1/lead/{id}/touch/{touch_id}; permission: lead_touch:delete. */
315
+ /**
316
+ * Performs the destroy touch operation for the lead capability.
317
+ * Calls `DELETE /api/v1/lead/{id}/touch/{touch_id}` through the shared IDP-aware Faiber client.
318
+ * @param id Backend path identifier `id`.
319
+ * @param touchId Backend path identifier `touch_id`.
320
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
321
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
322
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: lead_touch:delete.
323
+ */
116
324
  leadDestroyTouchDelete(id, touchId, options) {
117
325
  return this.client.request({ ...options, method: "DELETE", url: `/api/v1/lead/${encodeURIComponent(id)}/touch/${encodeURIComponent(touchId)}` });
118
326
  }
119
- /** GET /api/v1/lead/{id}/touch/{touch_id}; permission: lead_touch:read. */
327
+ /**
328
+ * Performs the show touch operation for the lead capability.
329
+ * Calls `GET /api/v1/lead/{id}/touch/{touch_id}` through the shared IDP-aware Faiber client.
330
+ * @param id Backend path identifier `id`.
331
+ * @param touchId Backend path identifier `touch_id`.
332
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
333
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
334
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: lead_touch:read.
335
+ */
120
336
  leadShowTouchGet(id, touchId, options) {
121
337
  return this.client.request({ ...options, method: "GET", url: `/api/v1/lead/${encodeURIComponent(id)}/touch/${encodeURIComponent(touchId)}` });
122
338
  }
123
- /** PUT /api/v1/lead/{id}/touch/{touch_id}; permission: lead_touch:update. */
339
+ /**
340
+ * Performs the update touch operation for the lead capability.
341
+ * Calls `PUT /api/v1/lead/{id}/touch/{touch_id}` through the shared IDP-aware Faiber client.
342
+ * @param id Backend path identifier `id`.
343
+ * @param touchId Backend path identifier `touch_id`.
344
+ * @param data Typed JSON request body.
345
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
346
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
347
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: lead_touch:update.
348
+ */
124
349
  leadUpdateTouchPut(id, touchId, data, options) {
125
350
  return this.client.request({ ...options, method: "PUT", url: `/api/v1/lead/${encodeURIComponent(id)}/touch/${encodeURIComponent(touchId)}`, data: data });
126
351
  }
127
- /** POST /api/v1/lead/developer; permission: lead:create. */
352
+ /**
353
+ * Performs the create developer operation for the lead capability.
354
+ * Calls `POST /api/v1/lead/developer` through the shared IDP-aware Faiber client.
355
+ * @param data Typed JSON request body.
356
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
357
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
358
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: lead:create.
359
+ */
128
360
  leadCreateDeveloperPost(data, options) {
129
361
  return this.client.request({ ...options, method: "POST", url: `/api/v1/lead/developer`, data: data });
130
362
  }
131
- /** GET /api/v1/lead/developer/ready; permission: lead:read, lead:read_all, lead:read_own. */
363
+ /**
364
+ * Performs the developer ready operation for the lead capability.
365
+ * Calls `GET /api/v1/lead/developer/ready` through the shared IDP-aware Faiber client.
366
+ * @param params Typed query parameters; omitted members retain backend defaults.
367
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
368
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
369
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: lead:read, lead:read_all, lead:read_own.
370
+ */
132
371
  leadDeveloperReadyGet(params, options) {
133
372
  return this.client.request({ ...options, method: "GET", url: `/api/v1/lead/developer/ready`, params });
134
373
  }
135
- /** GET /api/v1/lead/foreign_key; permission: lead:read, lead:read_all, lead:read_own. */
374
+ /**
375
+ * Performs the by foreign key operation for the lead capability.
376
+ * Calls `GET /api/v1/lead/foreign_key` through the shared IDP-aware Faiber client.
377
+ * @param params Typed query parameters; omitted members retain backend defaults.
378
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
379
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
380
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: lead:read, lead:read_all, lead:read_own.
381
+ */
136
382
  leadByForeignKeyGet(params, options) {
137
383
  return this.client.request({ ...options, method: "GET", url: `/api/v1/lead/foreign_key`, params });
138
384
  }
139
- /** DELETE /api/v1/lead/foreign_key/{foreign_key}/profile_id/{profile_id}/flags/{flags}; permission: lead:delete. */
385
+ /**
386
+ * Performs the destroy by foreign key operation for the lead capability.
387
+ * Calls `DELETE /api/v1/lead/foreign_key/{foreign_key}/profile_id/{profile_id}/flags/{flags}` through the shared IDP-aware Faiber client.
388
+ * @param foreignKey Backend path identifier `foreign_key`.
389
+ * @param profileId Backend path identifier `profile_id`.
390
+ * @param flags Backend path identifier `flags`.
391
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
392
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
393
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: lead:delete.
394
+ */
140
395
  leadDestroyByForeignKeyDelete(foreignKey, profileId, flags, options) {
141
396
  return this.client.request({ ...options, method: "DELETE", url: `/api/v1/lead/foreign_key/${encodeURIComponent(foreignKey)}/profile_id/${encodeURIComponent(profileId)}/flags/${encodeURIComponent(flags)}` });
142
397
  }
143
- /** PUT /api/v1/lead/foreign_key/{foreign_key}/profile_id/{profile_id}/flags/{flags}; permission: lead:update. */
398
+ /**
399
+ * Performs the update by foreign key operation for the lead capability.
400
+ * Calls `PUT /api/v1/lead/foreign_key/{foreign_key}/profile_id/{profile_id}/flags/{flags}` through the shared IDP-aware Faiber client.
401
+ * @param foreignKey Backend path identifier `foreign_key`.
402
+ * @param profileId Backend path identifier `profile_id`.
403
+ * @param flags Backend path identifier `flags`.
404
+ * @param data Typed JSON request body.
405
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
406
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
407
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: lead:update.
408
+ */
144
409
  leadUpdateByForeignKeyPut(foreignKey, profileId, flags, data, options) {
145
410
  return this.client.request({ ...options, method: "PUT", url: `/api/v1/lead/foreign_key/${encodeURIComponent(foreignKey)}/profile_id/${encodeURIComponent(profileId)}/flags/${encodeURIComponent(flags)}`, data: data });
146
411
  }
147
- /** GET /api/v1/lead/light; permission: lead:read, lead:read_all, lead:read_own. */
412
+ /**
413
+ * Performs the light operation for the lead capability.
414
+ * Calls `GET /api/v1/lead/light` through the shared IDP-aware Faiber client.
415
+ * @param params Typed query parameters; omitted members retain backend defaults.
416
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
417
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
418
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: lead:read, lead:read_all, lead:read_own.
419
+ */
148
420
  leadLightGet(params, options) {
149
421
  return this.client.request({ ...options, method: "GET", url: `/api/v1/lead/light`, params });
150
422
  }
151
- /** GET /api/v1/reminder; permission: reminder:read. */
423
+ /**
424
+ * Performs the index operation for the reminder capability.
425
+ * Calls `GET /api/v1/reminder` through the shared IDP-aware Faiber client.
426
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
427
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
428
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: reminder:read.
429
+ */
152
430
  reminderIndexGet(options) {
153
431
  return this.client.request({ ...options, method: "GET", url: `/api/v1/reminder` });
154
432
  }
155
- /** POST /api/v1/reminder; permission: reminder:create. */
433
+ /**
434
+ * Performs the create operation for the reminder capability.
435
+ * Calls `POST /api/v1/reminder` through the shared IDP-aware Faiber client.
436
+ * @param data Typed JSON request body.
437
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
438
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
439
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: reminder:create.
440
+ */
156
441
  reminderCreatePost(data, options) {
157
442
  return this.client.request({ ...options, method: "POST", url: `/api/v1/reminder`, data: data });
158
443
  }
159
- /** DELETE /api/v1/reminder/{id}; permission: reminder:delete. */
444
+ /**
445
+ * Performs the destroy operation for the reminder capability.
446
+ * Calls `DELETE /api/v1/reminder/{id}` through the shared IDP-aware Faiber client.
447
+ * @param id Backend path identifier `id`.
448
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
449
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
450
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: reminder:delete.
451
+ */
160
452
  reminderDestroyDelete(id, options) {
161
453
  return this.client.request({ ...options, method: "DELETE", url: `/api/v1/reminder/${encodeURIComponent(id)}` });
162
454
  }
163
- /** PUT /api/v1/reminder/{id}; permission: reminder:update. */
455
+ /**
456
+ * Performs the update operation for the reminder capability.
457
+ * Calls `PUT /api/v1/reminder/{id}` through the shared IDP-aware Faiber client.
458
+ * @param id Backend path identifier `id`.
459
+ * @param data Typed JSON request body.
460
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
461
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
462
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: reminder:update.
463
+ */
164
464
  reminderUpdatePut(id, data, options) {
165
465
  return this.client.request({ ...options, method: "PUT", url: `/api/v1/reminder/${encodeURIComponent(id)}`, data: data });
166
466
  }
167
- /** DELETE /api/v1/reminder/lead_id/{lead_id}; permission: reminder:delete. */
467
+ /**
468
+ * Performs the destroy by lead operation for the reminder capability.
469
+ * Calls `DELETE /api/v1/reminder/lead_id/{lead_id}` through the shared IDP-aware Faiber client.
470
+ * @param leadId Backend path identifier `lead_id`.
471
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
472
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
473
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: reminder:delete.
474
+ */
168
475
  reminderDestroyByLeadDelete(leadId, options) {
169
476
  return this.client.request({ ...options, method: "DELETE", url: `/api/v1/reminder/lead_id/${encodeURIComponent(leadId)}` });
170
477
  }
171
- /** GET /api/v1/reminder/until-today; permission: reminder:read. */
478
+ /**
479
+ * Performs the until today operation for the reminder capability.
480
+ * Calls `GET /api/v1/reminder/until-today` through the shared IDP-aware Faiber client.
481
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
482
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
483
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: reminder:read.
484
+ */
172
485
  reminderUntilTodayGet(options) {
173
486
  return this.client.request({ ...options, method: "GET", url: `/api/v1/reminder/until-today` });
174
487
  }
175
- /** GET /api/v1/sos; permission: sos:read, sos:read_all, sos:read_own. */
488
+ /**
489
+ * Performs the index operation for the sos capability.
490
+ * Calls `GET /api/v1/sos` through the shared IDP-aware Faiber client.
491
+ * @param params Typed query parameters; omitted members retain backend defaults.
492
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
493
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
494
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: sos:read, sos:read_all, sos:read_own.
495
+ */
176
496
  sosIndexGet(params, options) {
177
497
  return this.client.request({ ...options, method: "GET", url: `/api/v1/sos`, params });
178
498
  }
179
- /** POST /api/v1/sos; permission: sos:create. */
499
+ /**
500
+ * Performs the create operation for the sos capability.
501
+ * Calls `POST /api/v1/sos` through the shared IDP-aware Faiber client.
502
+ * @param data Typed JSON request body.
503
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
504
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
505
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: sos:create.
506
+ */
180
507
  sosCreatePost(data, options) {
181
508
  return this.client.request({ ...options, method: "POST", url: `/api/v1/sos`, data: data });
182
509
  }
183
- /** DELETE /api/v1/sos/{id}; permission: sos:delete. */
510
+ /**
511
+ * Performs the destroy operation for the sos capability.
512
+ * Calls `DELETE /api/v1/sos/{id}` through the shared IDP-aware Faiber client.
513
+ * @param id Backend path identifier `id`.
514
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
515
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
516
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: sos:delete.
517
+ */
184
518
  sosDestroyDelete(id, options) {
185
519
  return this.client.request({ ...options, method: "DELETE", url: `/api/v1/sos/${encodeURIComponent(id)}` });
186
520
  }
187
- /** GET /api/v1/sos/{id}; permission: sos:read. */
521
+ /**
522
+ * Performs the show operation for the sos capability.
523
+ * Calls `GET /api/v1/sos/{id}` through the shared IDP-aware Faiber client.
524
+ * @param id Backend path identifier `id`.
525
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
526
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
527
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: sos:read.
528
+ */
188
529
  sosShowGet(id, options) {
189
530
  return this.client.request({ ...options, method: "GET", url: `/api/v1/sos/${encodeURIComponent(id)}` });
190
531
  }
191
- /** PUT /api/v1/sos/{id}; permission: sos:update. */
532
+ /**
533
+ * Performs the update operation for the sos capability.
534
+ * Calls `PUT /api/v1/sos/{id}` through the shared IDP-aware Faiber client.
535
+ * @param id Backend path identifier `id`.
536
+ * @param data Typed JSON request body.
537
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
538
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
539
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: sos:update.
540
+ */
192
541
  sosUpdatePut(id, data, options) {
193
542
  return this.client.request({ ...options, method: "PUT", url: `/api/v1/sos/${encodeURIComponent(id)}`, data: data });
194
543
  }
195
- /** GET /api/v1/sos/{id}/log; permission: sos_log:read. */
544
+ /**
545
+ * Performs the list logs operation for the sos capability.
546
+ * Calls `GET /api/v1/sos/{id}/log` through the shared IDP-aware Faiber client.
547
+ * @param id Backend path identifier `id`.
548
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
549
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
550
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: sos_log:read.
551
+ */
196
552
  sosListLogsGet(id, options) {
197
553
  return this.client.request({ ...options, method: "GET", url: `/api/v1/sos/${encodeURIComponent(id)}/log` });
198
554
  }
199
- /** POST /api/v1/sos/{id}/log; permission: sos_log:create. */
555
+ /**
556
+ * Performs the create log operation for the sos capability.
557
+ * Calls `POST /api/v1/sos/{id}/log` through the shared IDP-aware Faiber client.
558
+ * @param id Backend path identifier `id`.
559
+ * @param data Typed JSON request body.
560
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
561
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
562
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: sos_log:create.
563
+ */
200
564
  sosCreateLogPost(id, data, options) {
201
565
  return this.client.request({ ...options, method: "POST", url: `/api/v1/sos/${encodeURIComponent(id)}/log`, data: data });
202
566
  }
203
- /** DELETE /api/v1/sos/{id}/log/{log_id}; permission: sos_log:delete. */
567
+ /**
568
+ * Performs the destroy log operation for the sos capability.
569
+ * Calls `DELETE /api/v1/sos/{id}/log/{log_id}` through the shared IDP-aware Faiber client.
570
+ * @param id Backend path identifier `id`.
571
+ * @param logId Backend path identifier `log_id`.
572
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
573
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
574
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: sos_log:delete.
575
+ */
204
576
  sosDestroyLogDelete(id, logId, options) {
205
577
  return this.client.request({ ...options, method: "DELETE", url: `/api/v1/sos/${encodeURIComponent(id)}/log/${encodeURIComponent(logId)}` });
206
578
  }
207
- /** GET /api/v1/sos/{id}/log/{log_id}; permission: sos_log:read. */
579
+ /**
580
+ * Performs the show log operation for the sos capability.
581
+ * Calls `GET /api/v1/sos/{id}/log/{log_id}` through the shared IDP-aware Faiber client.
582
+ * @param id Backend path identifier `id`.
583
+ * @param logId Backend path identifier `log_id`.
584
+ * @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: sos_log:read.
587
+ */
208
588
  sosShowLogGet(id, logId, options) {
209
589
  return this.client.request({ ...options, method: "GET", url: `/api/v1/sos/${encodeURIComponent(id)}/log/${encodeURIComponent(logId)}` });
210
590
  }
211
- /** PUT /api/v1/sos/{id}/log/{log_id}; permission: sos_log:update. */
591
+ /**
592
+ * Performs the update log operation for the sos capability.
593
+ * Calls `PUT /api/v1/sos/{id}/log/{log_id}` through the shared IDP-aware Faiber client.
594
+ * @param id Backend path identifier `id`.
595
+ * @param logId Backend path identifier `log_id`.
596
+ * @param data Typed JSON request body.
597
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
598
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
599
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: sos_log:update.
600
+ */
212
601
  sosUpdateLogPut(id, logId, data, options) {
213
602
  return this.client.request({ ...options, method: "PUT", url: `/api/v1/sos/${encodeURIComponent(id)}/log/${encodeURIComponent(logId)}`, data: data });
214
603
  }
215
- /** GET /api/v1/sos/{id}/touch; permission: sos_touch:read. */
604
+ /**
605
+ * Performs the list touches operation for the sos capability.
606
+ * Calls `GET /api/v1/sos/{id}/touch` through the shared IDP-aware Faiber client.
607
+ * @param id Backend path identifier `id`.
608
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
609
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
610
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: sos_touch:read.
611
+ */
216
612
  sosListTouchesGet(id, options) {
217
613
  return this.client.request({ ...options, method: "GET", url: `/api/v1/sos/${encodeURIComponent(id)}/touch` });
218
614
  }
219
- /** POST /api/v1/sos/{id}/touch; permission: sos_touch:create. */
615
+ /**
616
+ * Performs the create touch operation for the sos capability.
617
+ * Calls `POST /api/v1/sos/{id}/touch` through the shared IDP-aware Faiber client.
618
+ * @param id Backend path identifier `id`.
619
+ * @param data Typed JSON request body.
620
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
621
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
622
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: sos_touch:create.
623
+ */
220
624
  sosCreateTouchPost(id, data, options) {
221
625
  return this.client.request({ ...options, method: "POST", url: `/api/v1/sos/${encodeURIComponent(id)}/touch`, data: data });
222
626
  }
223
- /** DELETE /api/v1/sos/{id}/touch/{touch_id}; permission: sos_touch:delete. */
627
+ /**
628
+ * Performs the destroy touch operation for the sos capability.
629
+ * Calls `DELETE /api/v1/sos/{id}/touch/{touch_id}` through the shared IDP-aware Faiber client.
630
+ * @param id Backend path identifier `id`.
631
+ * @param touchId Backend path identifier `touch_id`.
632
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
633
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
634
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: sos_touch:delete.
635
+ */
224
636
  sosDestroyTouchDelete(id, touchId, options) {
225
637
  return this.client.request({ ...options, method: "DELETE", url: `/api/v1/sos/${encodeURIComponent(id)}/touch/${encodeURIComponent(touchId)}` });
226
638
  }
227
- /** GET /api/v1/sos/{id}/touch/{touch_id}; permission: sos_touch:read. */
639
+ /**
640
+ * Performs the show touch operation for the sos capability.
641
+ * Calls `GET /api/v1/sos/{id}/touch/{touch_id}` through the shared IDP-aware Faiber client.
642
+ * @param id Backend path identifier `id`.
643
+ * @param touchId Backend path identifier `touch_id`.
644
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
645
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
646
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: sos_touch:read.
647
+ */
228
648
  sosShowTouchGet(id, touchId, options) {
229
649
  return this.client.request({ ...options, method: "GET", url: `/api/v1/sos/${encodeURIComponent(id)}/touch/${encodeURIComponent(touchId)}` });
230
650
  }
231
- /** PUT /api/v1/sos/{id}/touch/{touch_id}; permission: sos_touch:update. */
651
+ /**
652
+ * Performs the update touch operation for the sos capability.
653
+ * Calls `PUT /api/v1/sos/{id}/touch/{touch_id}` through the shared IDP-aware Faiber client.
654
+ * @param id Backend path identifier `id`.
655
+ * @param touchId Backend path identifier `touch_id`.
656
+ * @param data Typed JSON request body.
657
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
658
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
659
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: sos_touch:update.
660
+ */
232
661
  sosUpdateTouchPut(id, touchId, data, options) {
233
662
  return this.client.request({ ...options, method: "PUT", url: `/api/v1/sos/${encodeURIComponent(id)}/touch/${encodeURIComponent(touchId)}`, data: data });
234
663
  }
235
- /** GET /api/v1/sos/all; permission: sos:read, sos:read_all, sos:read_own. */
664
+ /**
665
+ * Performs the all operation for the sos capability.
666
+ * Calls `GET /api/v1/sos/all` through the shared IDP-aware Faiber client.
667
+ * @param params Typed query parameters; omitted members retain backend defaults.
668
+ * @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: sos:read, sos:read_all, sos:read_own.
671
+ */
236
672
  sosAllGet(params, options) {
237
673
  return this.client.request({ ...options, method: "GET", url: `/api/v1/sos/all`, params });
238
674
  }
239
- /** POST /api/v1/sos/exit_assignee/{profile_id}; permission: sos:update, sos:update_all, sos:update_own. */
675
+ /**
676
+ * Performs the exit assignee route operation for the sos capability.
677
+ * Calls `POST /api/v1/sos/exit_assignee/{profile_id}` through the shared IDP-aware Faiber client.
678
+ * @param profileId Backend path identifier `profile_id`.
679
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
680
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
681
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: sos:update, sos:update_all, sos:update_own.
682
+ */
240
683
  sosExitAssigneeRoutePost(profileId, options) {
241
684
  return this.client.request({ ...options, method: "POST", url: `/api/v1/sos/exit_assignee/${encodeURIComponent(profileId)}` });
242
685
  }
243
- /** GET /api/v1/stats/daily; permission: stats:read. */
686
+ /**
687
+ * Performs the daily operation for the stats capability.
688
+ * Calls `GET /api/v1/stats/daily` through the shared IDP-aware Faiber client.
689
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
690
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
691
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: stats:read.
692
+ */
244
693
  statsDailyGet(options) {
245
694
  return this.client.request({ ...options, method: "GET", url: `/api/v1/stats/daily` });
246
695
  }
247
- /** GET /api/v1/stats/lead; permission: stats:read, stats:read_all, stats:read_own. */
696
+ /**
697
+ * Performs the lead operation for the stats capability.
698
+ * Calls `GET /api/v1/stats/lead` through the shared IDP-aware Faiber client.
699
+ * @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: stats:read, stats:read_all, stats:read_own.
702
+ */
248
703
  statsLeadGet(options) {
249
704
  return this.client.request({ ...options, method: "GET", url: `/api/v1/stats/lead` });
250
705
  }
251
- /** GET /api/v1/team; permission: team:read. */
706
+ /**
707
+ * Performs the index operation for the team capability.
708
+ * Calls `GET /api/v1/team` through the shared IDP-aware Faiber client.
709
+ * @param params Typed query parameters; omitted members retain backend defaults.
710
+ * @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: team:read.
713
+ */
252
714
  teamIndexGet(params, options) {
253
715
  return this.client.request({ ...options, method: "GET", url: `/api/v1/team`, params });
254
716
  }
255
- /** POST /api/v1/team; permission: team:create. */
717
+ /**
718
+ * Performs the create operation for the team capability.
719
+ * Calls `POST /api/v1/team` through the shared IDP-aware Faiber client.
720
+ * @param data Typed JSON request body.
721
+ * @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: team:create.
724
+ */
256
725
  teamCreatePost(data, options) {
257
726
  return this.client.request({ ...options, method: "POST", url: `/api/v1/team`, data: data });
258
727
  }
259
- /** GET /api/v1/team-users; permission: team_user:read. */
728
+ /**
729
+ * Performs the index operation for the team user capability.
730
+ * Calls `GET /api/v1/team-users` through the shared IDP-aware Faiber client.
731
+ * @param params Typed query parameters; omitted members retain backend defaults.
732
+ * @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: team_user:read.
735
+ */
260
736
  teamUserIndexGet(params, options) {
261
737
  return this.client.request({ ...options, method: "GET", url: `/api/v1/team-users`, params });
262
738
  }
263
- /** POST /api/v1/team-users; permission: team_user:create. */
739
+ /**
740
+ * Performs the create operation for the team user capability.
741
+ * Calls `POST /api/v1/team-users` through the shared IDP-aware Faiber client.
742
+ * @param data Typed JSON request body.
743
+ * @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: team_user:create.
746
+ */
264
747
  teamUserCreatePost(data, options) {
265
748
  return this.client.request({ ...options, method: "POST", url: `/api/v1/team-users`, data: data });
266
749
  }
267
- /** DELETE /api/v1/team-users/{id}; permission: team_user:delete. */
750
+ /**
751
+ * Performs the destroy operation for the team user capability.
752
+ * Calls `DELETE /api/v1/team-users/{id}` through the shared IDP-aware Faiber client.
753
+ * @param id Backend path identifier `id`.
754
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
755
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
756
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: team_user:delete.
757
+ */
268
758
  teamUserDestroyDelete(id, options) {
269
759
  return this.client.request({ ...options, method: "DELETE", url: `/api/v1/team-users/${encodeURIComponent(id)}` });
270
760
  }
271
- /** GET /api/v1/team-users/{id}; permission: team_user:read. */
761
+ /**
762
+ * Performs the show operation for the team user capability.
763
+ * Calls `GET /api/v1/team-users/{id}` through the shared IDP-aware Faiber client.
764
+ * @param id Backend path identifier `id`.
765
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
766
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
767
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: team_user:read.
768
+ */
272
769
  teamUserShowGet(id, options) {
273
770
  return this.client.request({ ...options, method: "GET", url: `/api/v1/team-users/${encodeURIComponent(id)}` });
274
771
  }
275
- /** PUT /api/v1/team-users/{id}; permission: team_user:update. */
772
+ /**
773
+ * Performs the update operation for the team user capability.
774
+ * Calls `PUT /api/v1/team-users/{id}` through the shared IDP-aware Faiber client.
775
+ * @param id Backend path identifier `id`.
776
+ * @param data Typed JSON request body.
777
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
778
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
779
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: team_user:update.
780
+ */
276
781
  teamUserUpdatePut(id, data, options) {
277
782
  return this.client.request({ ...options, method: "PUT", url: `/api/v1/team-users/${encodeURIComponent(id)}`, data: data });
278
783
  }
279
- /** POST /api/v1/team-users/multi-profiles; permission: team_user:create. */
784
+ /**
785
+ * Performs the multi profiles operation for the team user capability.
786
+ * Calls `POST /api/v1/team-users/multi-profiles` through the shared IDP-aware Faiber client.
787
+ * @param data Typed JSON request body.
788
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
789
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
790
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: team_user:create.
791
+ */
280
792
  teamUserMultiProfilesPost(data, options) {
281
793
  return this.client.request({ ...options, method: "POST", url: `/api/v1/team-users/multi-profiles`, data: data });
282
794
  }
283
- /** DELETE /api/v1/team/{id}; permission: team:delete. */
795
+ /**
796
+ * Performs the destroy operation for the team capability.
797
+ * Calls `DELETE /api/v1/team/{id}` through the shared IDP-aware Faiber client.
798
+ * @param id Backend path identifier `id`.
799
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
800
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
801
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: team:delete.
802
+ */
284
803
  teamDestroyDelete(id, options) {
285
804
  return this.client.request({ ...options, method: "DELETE", url: `/api/v1/team/${encodeURIComponent(id)}` });
286
805
  }
287
- /** GET /api/v1/team/{id}; permission: team:read. */
806
+ /**
807
+ * Performs the show operation for the team capability.
808
+ * Calls `GET /api/v1/team/{id}` through the shared IDP-aware Faiber client.
809
+ * @param id Backend path identifier `id`.
810
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
811
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
812
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: team:read.
813
+ */
288
814
  teamShowGet(id, options) {
289
815
  return this.client.request({ ...options, method: "GET", url: `/api/v1/team/${encodeURIComponent(id)}` });
290
816
  }
291
- /** PUT /api/v1/team/{id}; permission: team:update. */
817
+ /**
818
+ * Performs the update operation for the team capability.
819
+ * Calls `PUT /api/v1/team/{id}` through the shared IDP-aware Faiber client.
820
+ * @param id Backend path identifier `id`.
821
+ * @param data Typed JSON request body.
822
+ * @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: team:update.
825
+ */
292
826
  teamUpdatePut(id, data, options) {
293
827
  return this.client.request({ ...options, method: "PUT", url: `/api/v1/team/${encodeURIComponent(id)}`, data: data });
294
828
  }
295
- /** GET /api/v1/webhook; permission: public/session-derived. */
829
+ /**
830
+ * Performs the index operation for the webhook capability.
831
+ * Calls `GET /api/v1/webhook` through the shared IDP-aware Faiber client.
832
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
833
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
834
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
835
+ */
296
836
  webhookIndexGet(options) {
297
837
  return this.client.request({ ...options, method: "GET", url: `/api/v1/webhook` });
298
838
  }
299
- /** POST /api/v1/webhook; permission: public/session-derived. */
839
+ /**
840
+ * Performs the create operation for the webhook capability.
841
+ * Calls `POST /api/v1/webhook` through the shared IDP-aware Faiber client.
842
+ * @param data Typed JSON request body.
843
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
844
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
845
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
846
+ */
300
847
  webhookCreatePost(data, options) {
301
848
  return this.client.request({ ...options, method: "POST", url: `/api/v1/webhook`, data: data });
302
849
  }
303
- /** DELETE /api/v1/webhook/{id}; permission: public/session-derived. */
850
+ /**
851
+ * Performs the destroy operation for the webhook capability.
852
+ * Calls `DELETE /api/v1/webhook/{id}` through the shared IDP-aware Faiber client.
853
+ * @param id Backend path identifier `id`.
854
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
855
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
856
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
857
+ */
304
858
  webhookDestroyDelete(id, options) {
305
859
  return this.client.request({ ...options, method: "DELETE", url: `/api/v1/webhook/${encodeURIComponent(id)}` });
306
860
  }
307
- /** GET /api/v1/webhook/{id}; permission: public/session-derived. */
861
+ /**
862
+ * Performs the show operation for the webhook capability.
863
+ * Calls `GET /api/v1/webhook/{id}` through the shared IDP-aware Faiber client.
864
+ * @param id Backend path identifier `id`.
865
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
866
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
867
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
868
+ */
308
869
  webhookShowGet(id, options) {
309
870
  return this.client.request({ ...options, method: "GET", url: `/api/v1/webhook/${encodeURIComponent(id)}` });
310
871
  }
311
- /** PUT /api/v1/webhook/{id}; permission: public/session-derived. */
872
+ /**
873
+ * Performs the update operation for the webhook capability.
874
+ * Calls `PUT /api/v1/webhook/{id}` through the shared IDP-aware Faiber client.
875
+ * @param id Backend path identifier `id`.
876
+ * @param data Typed JSON request body.
877
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
878
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
879
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
880
+ */
312
881
  webhookUpdatePut(id, data, options) {
313
882
  return this.client.request({ ...options, method: "PUT", url: `/api/v1/webhook/${encodeURIComponent(id)}`, data: data });
314
883
  }
315
- /** GET /api/v1/workflow; permission: workflow:read, workflow:read_all, workflow:read_own. */
884
+ /**
885
+ * Performs the index operation for the workflow capability.
886
+ * Calls `GET /api/v1/workflow` through the shared IDP-aware Faiber client.
887
+ * @param params Typed query parameters; omitted members retain backend defaults.
888
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
889
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
890
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: workflow:read, workflow:read_all, workflow:read_own.
891
+ */
316
892
  workflowIndexGet(params, options) {
317
893
  return this.client.request({ ...options, method: "GET", url: `/api/v1/workflow`, params });
318
894
  }
319
- /** POST /api/v1/workflow; permission: workflow:create. */
895
+ /**
896
+ * Performs the create operation for the workflow capability.
897
+ * Calls `POST /api/v1/workflow` through the shared IDP-aware Faiber client.
898
+ * @param data Typed JSON request body.
899
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
900
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
901
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: workflow:create.
902
+ */
320
903
  workflowCreatePost(data, options) {
321
904
  return this.client.request({ ...options, method: "POST", url: `/api/v1/workflow`, data: data });
322
905
  }
323
- /** GET /api/v1/workflow-members; permission: workflow_member:read. */
906
+ /**
907
+ * Performs the index operation for the workflow member capability.
908
+ * Calls `GET /api/v1/workflow-members` through the shared IDP-aware Faiber client.
909
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
910
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
911
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: workflow_member:read.
912
+ */
324
913
  workflowMemberIndexGet(options) {
325
914
  return this.client.request({ ...options, method: "GET", url: `/api/v1/workflow-members` });
326
915
  }
327
- /** DELETE /api/v1/workflow-members/{id}; permission: workflow_member:delete. */
916
+ /**
917
+ * Performs the destroy operation for the workflow member capability.
918
+ * Calls `DELETE /api/v1/workflow-members/{id}` through the shared IDP-aware Faiber client.
919
+ * @param id Backend path identifier `id`.
920
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
921
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
922
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: workflow_member:delete.
923
+ */
328
924
  workflowMemberDestroyDelete(id, options) {
329
925
  return this.client.request({ ...options, method: "DELETE", url: `/api/v1/workflow-members/${encodeURIComponent(id)}` });
330
926
  }
331
- /** GET /api/v1/workflow-members/{id}; permission: workflow_member:read. */
927
+ /**
928
+ * Performs the show operation for the workflow member capability.
929
+ * Calls `GET /api/v1/workflow-members/{id}` through the shared IDP-aware Faiber client.
930
+ * @param id Backend path identifier `id`.
931
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
932
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
933
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: workflow_member:read.
934
+ */
332
935
  workflowMemberShowGet(id, options) {
333
936
  return this.client.request({ ...options, method: "GET", url: `/api/v1/workflow-members/${encodeURIComponent(id)}` });
334
937
  }
335
- /** POST /api/v1/workflow-members/{id}; permission: workflow_member:create. */
938
+ /**
939
+ * Performs the create operation for the workflow member capability.
940
+ * Calls `POST /api/v1/workflow-members/{id}` through the shared IDP-aware Faiber client.
941
+ * @param id Backend path identifier `id`.
942
+ * @param data Typed JSON request body.
943
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
944
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
945
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: workflow_member:create.
946
+ */
336
947
  workflowMemberCreatePost(id, data, options) {
337
948
  return this.client.request({ ...options, method: "POST", url: `/api/v1/workflow-members/${encodeURIComponent(id)}`, data: data });
338
949
  }
339
- /** PUT /api/v1/workflow-members/{id}; permission: workflow_member:update. */
950
+ /**
951
+ * Performs the update operation for the workflow member capability.
952
+ * Calls `PUT /api/v1/workflow-members/{id}` through the shared IDP-aware Faiber client.
953
+ * @param id Backend path identifier `id`.
954
+ * @param data Typed JSON request body.
955
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
956
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
957
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: workflow_member:update.
958
+ */
340
959
  workflowMemberUpdatePut(id, data, options) {
341
960
  return this.client.request({ ...options, method: "PUT", url: `/api/v1/workflow-members/${encodeURIComponent(id)}`, data: data });
342
961
  }
343
- /** GET /api/v1/workflow-members/workflow/{workflow_id}; permission: workflow_member:read. */
962
+ /**
963
+ * Performs the by workflow operation for the workflow member capability.
964
+ * Calls `GET /api/v1/workflow-members/workflow/{workflow_id}` through the shared IDP-aware Faiber client.
965
+ * @param workflowId Backend path identifier `workflow_id`.
966
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
967
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
968
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: workflow_member:read.
969
+ */
344
970
  workflowMemberByWorkflowGet(workflowId, options) {
345
971
  return this.client.request({ ...options, method: "GET", url: `/api/v1/workflow-members/workflow/${encodeURIComponent(workflowId)}` });
346
972
  }
347
- /** GET /api/v1/workflow-node; permission: workflow_node:read, workflow_node:read_all, workflow_node:read_own. */
973
+ /**
974
+ * Performs the index operation for the workflow node capability.
975
+ * Calls `GET /api/v1/workflow-node` through the shared IDP-aware Faiber client.
976
+ * @param params Typed query parameters; omitted members retain backend defaults.
977
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
978
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
979
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: workflow_node:read, workflow_node:read_all, workflow_node:read_own.
980
+ */
348
981
  workflowNodeIndexGet(params, options) {
349
982
  return this.client.request({ ...options, method: "GET", url: `/api/v1/workflow-node`, params });
350
983
  }
351
- /** DELETE /api/v1/workflow-node/{id}; permission: workflow_node:delete. */
984
+ /**
985
+ * Performs the destroy operation for the workflow node capability.
986
+ * Calls `DELETE /api/v1/workflow-node/{id}` through the shared IDP-aware Faiber client.
987
+ * @param id Backend path identifier `id`.
988
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
989
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
990
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: workflow_node:delete.
991
+ */
352
992
  workflowNodeDestroyDelete(id, options) {
353
993
  return this.client.request({ ...options, method: "DELETE", url: `/api/v1/workflow-node/${encodeURIComponent(id)}` });
354
994
  }
355
- /** GET /api/v1/workflow-node/{id}; permission: workflow_node:read. */
995
+ /**
996
+ * Performs the show operation for the workflow node capability.
997
+ * Calls `GET /api/v1/workflow-node/{id}` through the shared IDP-aware Faiber client.
998
+ * @param id Backend path identifier `id`.
999
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
1000
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
1001
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: workflow_node:read.
1002
+ */
356
1003
  workflowNodeShowGet(id, options) {
357
1004
  return this.client.request({ ...options, method: "GET", url: `/api/v1/workflow-node/${encodeURIComponent(id)}` });
358
1005
  }
359
- /** POST /api/v1/workflow-node/{id}; permission: workflow_node:create. */
1006
+ /**
1007
+ * Performs the create operation for the workflow node capability.
1008
+ * Calls `POST /api/v1/workflow-node/{id}` through the shared IDP-aware Faiber client.
1009
+ * @param id Backend path identifier `id`.
1010
+ * @param data Typed JSON request body.
1011
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
1012
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
1013
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: workflow_node:create.
1014
+ */
360
1015
  workflowNodeCreatePost(id, data, options) {
361
1016
  return this.client.request({ ...options, method: "POST", url: `/api/v1/workflow-node/${encodeURIComponent(id)}`, data: data });
362
1017
  }
363
- /** PUT /api/v1/workflow-node/{id}; permission: workflow_node:update. */
1018
+ /**
1019
+ * Performs the update operation for the workflow node capability.
1020
+ * Calls `PUT /api/v1/workflow-node/{id}` through the shared IDP-aware Faiber client.
1021
+ * @param id Backend path identifier `id`.
1022
+ * @param data Typed JSON request body.
1023
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
1024
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
1025
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: workflow_node:update.
1026
+ */
364
1027
  workflowNodeUpdatePut(id, data, options) {
365
1028
  return this.client.request({ ...options, method: "PUT", url: `/api/v1/workflow-node/${encodeURIComponent(id)}`, data: data });
366
1029
  }
367
- /** DELETE /api/v1/workflow/{id}; permission: workflow:delete. */
1030
+ /**
1031
+ * Performs the destroy operation for the workflow capability.
1032
+ * Calls `DELETE /api/v1/workflow/{id}` through the shared IDP-aware Faiber client.
1033
+ * @param id Backend path identifier `id`.
1034
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
1035
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
1036
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: workflow:delete.
1037
+ */
368
1038
  workflowDestroyDelete(id, options) {
369
1039
  return this.client.request({ ...options, method: "DELETE", url: `/api/v1/workflow/${encodeURIComponent(id)}` });
370
1040
  }
371
- /** GET /api/v1/workflow/{id}; permission: workflow:read, workflow:read_all, workflow:read_own. */
1041
+ /**
1042
+ * Performs the show operation for the workflow capability.
1043
+ * Calls `GET /api/v1/workflow/{id}` through the shared IDP-aware Faiber client.
1044
+ * @param id Backend path identifier `id`.
1045
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
1046
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
1047
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: workflow:read, workflow:read_all, workflow:read_own.
1048
+ */
372
1049
  workflowShowGet(id, options) {
373
1050
  return this.client.request({ ...options, method: "GET", url: `/api/v1/workflow/${encodeURIComponent(id)}` });
374
1051
  }
375
- /** PUT /api/v1/workflow/{id}; permission: workflow:update. */
1052
+ /**
1053
+ * Performs the update operation for the workflow capability.
1054
+ * Calls `PUT /api/v1/workflow/{id}` through the shared IDP-aware Faiber client.
1055
+ * @param id Backend path identifier `id`.
1056
+ * @param data Typed JSON request body.
1057
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
1058
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
1059
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: workflow:update.
1060
+ */
376
1061
  workflowUpdatePut(id, data, options) {
377
1062
  return this.client.request({ ...options, method: "PUT", url: `/api/v1/workflow/${encodeURIComponent(id)}`, data: data });
378
1063
  }
379
- /** GET /api/v1/workflow/member-based; permission: workflow:read, workflow:read_all, workflow:read_own. */
1064
+ /**
1065
+ * Performs the member based operation for the workflow capability.
1066
+ * Calls `GET /api/v1/workflow/member-based` through the shared IDP-aware Faiber client.
1067
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
1068
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
1069
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: workflow:read, workflow:read_all, workflow:read_own.
1070
+ */
380
1071
  workflowMemberBasedGet(options) {
381
1072
  return this.client.request({ ...options, method: "GET", url: `/api/v1/workflow/member-based` });
382
1073
  }
383
- /** GET /api/v1/worklog; permission: worklog:read, worklog:read_all, worklog:read_own. */
1074
+ /**
1075
+ * Performs the index operation for the worklog capability.
1076
+ * Calls `GET /api/v1/worklog` through the shared IDP-aware Faiber client.
1077
+ * @param params Typed query parameters; omitted members retain backend defaults.
1078
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
1079
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
1080
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: worklog:read, worklog:read_all, worklog:read_own.
1081
+ */
384
1082
  worklogIndexGet(params, options) {
385
1083
  return this.client.request({ ...options, method: "GET", url: `/api/v1/worklog`, params });
386
1084
  }
387
- /** POST /api/v1/worklog; permission: worklog:create. */
1085
+ /**
1086
+ * Performs the create operation for the worklog capability.
1087
+ * Calls `POST /api/v1/worklog` through the shared IDP-aware Faiber client.
1088
+ * @param data Typed JSON request body.
1089
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
1090
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
1091
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: worklog:create.
1092
+ */
388
1093
  worklogCreatePost(data, options) {
389
1094
  return this.client.request({ ...options, method: "POST", url: `/api/v1/worklog`, data: data });
390
1095
  }
391
- /** DELETE /api/v1/worklog/{id}; permission: worklog:delete. */
1096
+ /**
1097
+ * Performs the destroy operation for the worklog capability.
1098
+ * Calls `DELETE /api/v1/worklog/{id}` through the shared IDP-aware Faiber client.
1099
+ * @param id Backend path identifier `id`.
1100
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
1101
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
1102
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: worklog:delete.
1103
+ */
392
1104
  worklogDestroyDelete(id, options) {
393
1105
  return this.client.request({ ...options, method: "DELETE", url: `/api/v1/worklog/${encodeURIComponent(id)}` });
394
1106
  }
395
- /** GET /api/v1/worklog/{id}; permission: worklog:read, worklog:read_all, worklog:read_own. */
1107
+ /**
1108
+ * Performs the show operation for the worklog capability.
1109
+ * Calls `GET /api/v1/worklog/{id}` through the shared IDP-aware Faiber client.
1110
+ * @param id Backend path identifier `id`.
1111
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
1112
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
1113
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: worklog:read, worklog:read_all, worklog:read_own.
1114
+ */
396
1115
  worklogShowGet(id, options) {
397
1116
  return this.client.request({ ...options, method: "GET", url: `/api/v1/worklog/${encodeURIComponent(id)}` });
398
1117
  }
399
- /** PUT /api/v1/worklog/{id}; permission: worklog:update. */
1118
+ /**
1119
+ * Performs the update operation for the worklog capability.
1120
+ * Calls `PUT /api/v1/worklog/{id}` through the shared IDP-aware Faiber client.
1121
+ * @param id Backend path identifier `id`.
1122
+ * @param data Typed JSON request body.
1123
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
1124
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
1125
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: worklog:update.
1126
+ */
400
1127
  worklogUpdatePut(id, data, options) {
401
1128
  return this.client.request({ ...options, method: "PUT", url: `/api/v1/worklog/${encodeURIComponent(id)}`, data: data });
402
1129
  }
403
- /** GET /health; permission: public/session-derived. */
1130
+ /**
1131
+ * Performs the status route operation for the router capability.
1132
+ * Calls `GET /health` through the shared IDP-aware Faiber client.
1133
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
1134
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
1135
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
1136
+ */
404
1137
  routerStatusRouteGetHealth(options) {
405
1138
  return this.client.request({ ...options, method: "GET", url: `/health` });
406
1139
  }
407
- /** GET /up; permission: public/session-derived. */
1140
+ /**
1141
+ * Performs the status route operation for the router capability.
1142
+ * Calls `GET /up` through the shared IDP-aware Faiber client.
1143
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
1144
+ * @returns The complete Axios response, including the typed service envelope, status, and headers.
1145
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
1146
+ */
408
1147
  routerStatusRouteGetUp(options) {
409
1148
  return this.client.request({ ...options, method: "GET", url: `/up` });
410
1149
  }