@faiber/faiber-crm 0.24.0 → 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,1003 +1,1047 @@
1
1
  import { ServiceApi, urlEncoded } from "@faiber/sdk-core";
2
+ function wildcardPath(path) {
3
+ const parts = String(path).split("/");
4
+ if (parts.some(part => !part || part === "." || part === ".." || /[%?#\\]/.test(part)))
5
+ throw new TypeError("Wildcard paths require nonempty raw segments without dot traversal, percent escapes, query, fragment or backslash");
6
+ return parts.map(part => encodeURIComponent(part)).join("/");
7
+ }
8
+ const registeredApiPaths = ["^/api/v1/activities$", "^/api/v1/activities/with-reminder$", "^/api/v1/automation/jobs$", "^/api/v1/automation/webhooks$", "^/api/v1/boards/[^/]+/[^/]+$", "^/api/v1/campaigns$", "^/api/v1/companies$", "^/api/v1/companies/[^/]+$", "^/api/v1/contacts$", "^/api/v1/contacts/[^/]+$", "^/api/v1/context$", "^/api/v1/deals$", "^/api/v1/deals/[^/]+$", "^/api/v1/deals/[^/]+/assignment$", "^/api/v1/deals/[^/]+/stage$", "^/api/v1/integration/office/leads/find$", "^/api/v1/leads$", "^/api/v1/leads/[^/]+$", "^/api/v1/leads/[^/]+/assignment$", "^/api/v1/leads/[^/]+/history$", "^/api/v1/leads/[^/]+/reminders$", "^/api/v1/leads/[^/]+/sos$", "^/api/v1/leads/[^/]+/stage$", "^/api/v1/leads/light$", "^/api/v1/pipelines$", "^/api/v1/pipelines/[^/]+$", "^/api/v1/reports/[^/]+$", "^/api/v1/reports/[^/]+/agentic$", "^/api/v1/reports/catalog$", "^/api/v1/reports/overview$", "^/api/v1/reports/refresh$", "^/api/v1/sos$", "^/api/v1/sources$", "^/api/v1/stats/daily$", "^/api/v1/stats/lead$", "^/api/v1/tasks$", "^/api/v1/tasks/[^/]+$", "^/api/v1/tasks/[^/]+/status$", "^/api/v1/teams$", "^/api/v1/teams/[^/]+$", "^/api/v1/teams/[^/]+/members$", "^/api/v1/teams/[^/]+/members/[^/]+$", "^/api/v1/workflow$", "^/api/v1/workflow-node$", "^/api/v1/workflow-node/[^/]+$", "^/api/v1/workflow/[^/]+$", "^/api/v1/workflows$", "^/api/v1/workflows/[^/]+$", "^/api/v1/workflows/[^/]+/assignments$", "^/api/v1/workflows/[^/]+/assignments/[^/]+$", "^/api/v1/workflows/[^/]+/nodes$", "^/api/v1/workflows/[^/]+/nodes/[^/]+$", "^/api/v1/workflows/member-based$", "^/api/v1/worklog$", "^/api/v1/workspace/settings$"].map(pattern => new RegExp(pattern));
9
+ function unregisteredApiPath(path) {
10
+ const encoded = wildcardPath(path);
11
+ if (registeredApiPaths.some(pattern => pattern.test(`/api/${encoded}`)))
12
+ throw new TypeError("Use the named CRM operation for registered API paths");
13
+ return encoded;
14
+ }
2
15
  export class CrmOperations extends ServiceApi {
3
16
  /**
4
- * Performs the status route operation for the router capability.
17
+ * Read process liveness and package version in the legacy status/message/data envelope; no dependency probe.
5
18
  * Calls `GET /` through the shared IDP-aware Faiber client.
6
19
  * @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.
20
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
21
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: No local handler permission check; deployment/gateway authority must be independently verified.
9
22
  */
10
23
  routerStatusRouteGet(options) {
11
24
  return this.client.request({ ...options, method: "GET", url: `/` });
12
25
  }
13
26
  /**
14
- * Performs the activities operation for the api capability.
27
+ * Reach the legacy API not-found boundary with the chosen method. The handler returns structured 404; HEAD has no body and production CORS answers OPTIONS with empty 200. Axios rejects 404 by default; intentional diagnostics should check empty bodies. Registered paths are rejected locally by wildcard diagnostics. Does not mutate CRM records.
28
+ * Calls `ANY /api` through the shared IDP-aware Faiber client.
29
+ * @param method HTTP method accepted by the mounted ANY handler; CONNECT requires an explicit tunnel-capable Axios adapter. The SDK never sends an ANY verb.
30
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
31
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
32
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: No local handler permission check; deployment/gateway authority must be independently verified.
33
+ */
34
+ routerApiNotFoundAny(method, options) {
35
+ if (!["GET", "POST", "PUT", "PATCH", "DELETE", "HEAD", "OPTIONS", "TRACE", "CONNECT"].includes(method))
36
+ throw new TypeError("Invalid HTTP method");
37
+ if (method === "CONNECT" && !options?.adapter)
38
+ throw new TypeError("CONNECT requires an explicit tunnel-capable Axios adapter");
39
+ return this.client.request({ ...options, method: method, url: `/api` });
40
+ }
41
+ /**
42
+ * Reach the legacy API not-found boundary with the chosen method. The handler returns structured 404; HEAD has no body and production CORS answers OPTIONS with empty 200. Axios rejects 404 by default; intentional diagnostics should check empty bodies. Registered paths are rejected locally by wildcard diagnostics. Does not mutate CRM records.
43
+ * Calls `ANY /api/{*path}` through the shared IDP-aware Faiber client.
44
+ * @param path Backend path identifier `*path`.
45
+ * @param method HTTP method accepted by the mounted ANY handler; CONNECT requires an explicit tunnel-capable Axios adapter. The SDK never sends an ANY verb.
46
+ * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
47
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
48
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: No local handler permission check; deployment/gateway authority must be independently verified.
49
+ */
50
+ routerApiPathNotFoundAny(path, method, options) {
51
+ if (!["GET", "POST", "PUT", "PATCH", "DELETE", "HEAD", "OPTIONS", "TRACE", "CONNECT"].includes(method))
52
+ throw new TypeError("Invalid HTTP method");
53
+ if (method === "CONNECT" && !options?.adapter)
54
+ throw new TypeError("CONNECT requires an explicit tunnel-capable Axios adapter");
55
+ return this.client.request({ ...options, method: method, url: `/api/${unregisteredApiPath(path)}` });
56
+ }
57
+ /**
58
+ * List workspace activities ordered by occurred_at DESC,id DESC, with id < cursor; enrich nullable owner profiles. Only cursor/limit are consumed. Limit defaults 50, clamped 1..100.
15
59
  * Calls `GET /api/v1/activities` through the shared IDP-aware Faiber client.
16
60
  * @param params Typed query parameters; omitted members retain backend defaults.
17
61
  * @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: crm:activity:read.
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: crm:admin or any one of crm:activity:read.
20
64
  */
21
65
  apiActivitiesGet(params, options) {
22
66
  return this.client.request({ ...options, method: "GET", url: `/api/v1/activities`, params });
23
67
  }
24
68
  /**
25
- * Performs the create activity operation for the api capability.
69
+ * Create note/call/email/meeting/demo/message activity, default occurred_at to now and owner to caller; return nullable owner profile and HTTP 201. Requires a nonempty Idempotency-Key header up to 128 characters; duplicate submissions return 409 instead of replaying a response.
26
70
  * Calls `POST /api/v1/activities` through the shared IDP-aware Faiber client.
27
71
  * @param data Typed JSON request body.
28
72
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
29
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
30
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:activity:create.
73
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
74
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of crm:activity:create.
31
75
  */
32
76
  apiCreateActivityPost(data, options) {
33
77
  return this.client.request({ ...options, method: "POST", url: `/api/v1/activities`, data: data });
34
78
  }
35
79
  /**
36
- * Performs the create activity with reminder operation for the api capability.
80
+ * Create an activity and reminder task atomically under one key. Validate activity type, nonempty reminder title and priority; reminder assignee defaults caller and type defaults reminder. Returns 201 with both records. Authorization accepts either listed create permission. Requires a nonempty Idempotency-Key header up to 128 characters; duplicate submissions return 409 instead of replaying a response.
37
81
  * Calls `POST /api/v1/activities/with-reminder` through the shared IDP-aware Faiber client.
38
82
  * @param data Typed JSON request body.
39
83
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
40
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
41
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:activity:create, crm:task:create.
84
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
85
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of crm:activity:create, crm:task:create.
42
86
  */
43
87
  apiCreateActivityWithReminderPost(data, options) {
44
88
  return this.client.request({ ...options, method: "POST", url: `/api/v1/activities/with-reminder`, data: data });
45
89
  }
46
90
  /**
47
- * Performs the automation jobs operation for the api capability.
91
+ * List workspace durable jobs with cursor/status, ascending UUID; limit defaults 50, clamped 1..100. Result is nullable job-type-specific stored JSON.
48
92
  * Calls `GET /api/v1/automation/jobs` through the shared IDP-aware Faiber client.
49
93
  * @param params Typed query parameters; omitted members retain backend defaults.
50
94
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
51
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
52
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:automation:read.
95
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
96
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of crm:automation:read.
53
97
  */
54
98
  apiAutomationJobsGet(params, options) {
55
99
  return this.client.request({ ...options, method: "GET", url: `/api/v1/automation/jobs`, params });
56
100
  }
57
101
  /**
58
- * Performs the automation webhooks operation for the api capability.
102
+ * List workspace webhook subscriptions, including inactive entries, with total and failed/dead-letter delivery counts.
59
103
  * Calls `GET /api/v1/automation/webhooks` through the shared IDP-aware Faiber client.
60
104
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
61
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
62
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:automation:read.
105
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
106
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of crm:automation:read.
63
107
  */
64
108
  apiAutomationWebhooksGet(options) {
65
109
  return this.client.request({ ...options, method: "GET", url: `/api/v1/automation/webhooks` });
66
110
  }
67
111
  /**
68
- * Performs the board operation for the api capability.
112
+ * Read a lead or deal board with concrete pipeline/stage/record columns and summed value. Invalid entity_type 400, missing workspace pipeline 404. At most 1000 recently updated records; board permission does not apply per-record owner filtering.
69
113
  * Calls `GET /api/v1/boards/{entity_type}/{pipeline_id}` through the shared IDP-aware Faiber client.
70
114
  * @param entityType Backend path identifier `entity_type`.
71
115
  * @param pipelineId Backend path identifier `pipeline_id`.
72
116
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
73
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
74
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:board:read.
117
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
118
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of crm:board:read.
75
119
  */
76
120
  apiBoardGet(entityType, pipelineId, options) {
77
121
  return this.client.request({ ...options, method: "GET", url: `/api/v1/boards/${encodeURIComponent(entityType)}/${encodeURIComponent(pipelineId)}` });
78
122
  }
79
123
  /**
80
- * Performs the campaigns operation for the api capability.
124
+ * List nondeleted workspace marketing campaigns, including inactive statuses, newest first.
81
125
  * Calls `GET /api/v1/campaigns` through the shared IDP-aware Faiber client.
82
126
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
83
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
84
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:marketing:read.
127
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
128
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of crm:marketing:read.
85
129
  */
86
130
  apiCampaignsGet(options) {
87
131
  return this.client.request({ ...options, method: "GET", url: `/api/v1/campaigns` });
88
132
  }
89
133
  /**
90
- * Performs the create campaign operation for the api capability.
134
+ * Create a campaign with trimmed nonempty name/slug, status draft/active/paused/completed/archived (default draft), currency default IRR and extensible metadata; return 201. Requires a nonempty Idempotency-Key header up to 128 characters; duplicate submissions return 409 instead of replaying a response.
91
135
  * Calls `POST /api/v1/campaigns` through the shared IDP-aware Faiber client.
92
136
  * @param data Typed JSON request body.
93
137
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
94
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
95
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:marketing:manage.
138
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
139
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of crm:marketing:manage.
96
140
  */
97
141
  apiCreateCampaignPost(data, options) {
98
142
  return this.client.request({ ...options, method: "POST", url: `/api/v1/campaigns`, data: data });
99
143
  }
100
144
  /**
101
- * Performs the companies operation for the api capability.
145
+ * Search nondeleted workspace companies by name/domain with q and ascending UUID cursor. Only cursor/limit/q are consumed; limit defaults 50, clamped 1..100.
102
146
  * Calls `GET /api/v1/companies` through the shared IDP-aware Faiber client.
103
147
  * @param params Typed query parameters; omitted members retain backend defaults.
104
148
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
105
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
106
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:company:read, crm:company:read_all.
149
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
150
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of crm:company:read, crm:company:read_all.
107
151
  */
108
152
  apiCompaniesGet(params, options) {
109
153
  return this.client.request({ ...options, method: "GET", url: `/api/v1/companies`, params });
110
154
  }
111
155
  /**
112
- * Performs the create company operation for the api capability.
156
+ * Create a company with trimmed nonempty name and nonnegative employee count/revenue. Validate selected active team and owner membership; return 201. Requires a nonempty Idempotency-Key header up to 128 characters; duplicate submissions return 409 instead of replaying a response.
113
157
  * Calls `POST /api/v1/companies` through the shared IDP-aware Faiber client.
114
158
  * @param data Typed JSON request body.
115
159
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
116
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
117
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:company:create.
160
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
161
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of crm:company:create.
118
162
  */
119
163
  apiCreateCompanyPost(data, options) {
120
164
  return this.client.request({ ...options, method: "POST", url: `/api/v1/companies`, data: data });
121
165
  }
122
166
  /**
123
- * Performs the company operation for the api capability.
167
+ * Read a nondeleted workspace company by UUID; missing or foreign workspace company returns 404.
124
168
  * Calls `GET /api/v1/companies/{id}` through the shared IDP-aware Faiber client.
125
169
  * @param id Backend path identifier `id`.
126
170
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
127
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
128
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:company:read, crm:company:read_all.
171
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
172
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of crm:company:read, crm:company:read_all.
129
173
  */
130
174
  apiCompanyGet(id, options) {
131
175
  return this.client.request({ ...options, method: "GET", url: `/api/v1/companies/${encodeURIComponent(id)}` });
132
176
  }
133
177
  /**
134
- * Performs the update company operation for the api capability.
178
+ * Patch company fields using required version; validate nonempty name and nonnegative count/revenue. Optional nulls preserve fields; missing company 404 and stale version 409. Requires a nonempty Idempotency-Key header up to 128 characters; duplicate submissions return 409 instead of replaying a response.
135
179
  * Calls `PATCH /api/v1/companies/{id}` through the shared IDP-aware Faiber client.
136
180
  * @param id Backend path identifier `id`.
137
181
  * @param data Typed JSON request body.
138
182
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
139
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
140
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:company:update.
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: crm:admin or any one of crm:company:update.
141
185
  */
142
186
  apiUpdateCompanyPatch(id, data, options) {
143
187
  return this.client.request({ ...options, method: "PATCH", url: `/api/v1/companies/${encodeURIComponent(id)}`, data: data });
144
188
  }
145
189
  /**
146
- * Performs the contacts operation for the api capability.
190
+ * Search nondeleted workspace contacts by first/last name/email with q and ascending UUID cursor. Only cursor/limit/q are consumed; limit defaults 50, clamped 1..100.
147
191
  * Calls `GET /api/v1/contacts` through the shared IDP-aware Faiber client.
148
192
  * @param params Typed query parameters; omitted members retain backend defaults.
149
193
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
150
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
151
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:contact:read, crm:contact:read_all.
194
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
195
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of crm:contact:read, crm:contact:read_all.
152
196
  */
153
197
  apiContactsGet(params, options) {
154
198
  return this.client.request({ ...options, method: "GET", url: `/api/v1/contacts`, params });
155
199
  }
156
200
  /**
157
- * Performs the create contact operation for the api capability.
201
+ * Create a contact with trimmed nonempty first_name and optional profile/consent/custom data; validate selected active team and owner membership. Returns 201. Requires a nonempty Idempotency-Key header up to 128 characters; duplicate submissions return 409 instead of replaying a response.
158
202
  * Calls `POST /api/v1/contacts` through the shared IDP-aware Faiber client.
159
203
  * @param data Typed JSON request body.
160
204
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
161
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
162
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:contact:create.
205
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
206
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of crm:contact:create.
163
207
  */
164
208
  apiCreateContactPost(data, options) {
165
209
  return this.client.request({ ...options, method: "POST", url: `/api/v1/contacts`, data: data });
166
210
  }
167
211
  /**
168
- * Performs the contact operation for the api capability.
212
+ * Read a nondeleted workspace contact by UUID; missing or foreign workspace contact returns 404.
169
213
  * Calls `GET /api/v1/contacts/{id}` through the shared IDP-aware Faiber client.
170
214
  * @param id Backend path identifier `id`.
171
215
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
172
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
173
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:contact:read, crm:contact:read_all.
216
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
217
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of crm:contact:read, crm:contact:read_all.
174
218
  */
175
219
  apiContactGet(id, options) {
176
220
  return this.client.request({ ...options, method: "GET", url: `/api/v1/contacts/${encodeURIComponent(id)}` });
177
221
  }
178
222
  /**
179
- * Performs the update contact operation for the api capability.
223
+ * Patch contact with required version; validate nonempty first_name and active/inactive/do_not_contact lifecycle status. Optional nulls preserve fields; missing contact 404, stale version 409. Requires a nonempty Idempotency-Key header up to 128 characters; duplicate submissions return 409 instead of replaying a response.
180
224
  * Calls `PATCH /api/v1/contacts/{id}` through the shared IDP-aware Faiber client.
181
225
  * @param id Backend path identifier `id`.
182
226
  * @param data Typed JSON request body.
183
227
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
184
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
185
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:contact:update.
228
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
229
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of crm:contact:update.
186
230
  */
187
231
  apiUpdateContactPatch(id, data, options) {
188
232
  return this.client.request({ ...options, method: "PATCH", url: `/api/v1/contacts/${encodeURIComponent(id)}`, data: data });
189
233
  }
190
234
  /**
191
- * Performs the context operation for the api capability.
235
+ * Read the configured CRM workspace, including locale, timezone, currency, AI settings and optimistic version; absent workspace returns 404.
192
236
  * Calls `GET /api/v1/context` through the shared IDP-aware Faiber client.
193
237
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
194
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
195
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:workspace:read.
238
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
239
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of crm:workspace:read.
196
240
  */
197
241
  apiContextGet(options) {
198
242
  return this.client.request({ ...options, method: "GET", url: `/api/v1/context` });
199
243
  }
200
244
  /**
201
- * Performs the deals operation for the api capability.
245
+ * List bare nondeleted workspace deals with cursor/q/pipeline/stage/status/team/owner filters, ascending UUID. Caller-only unless crm:admin or crm:deal:read_all. Limit defaults 50, clamped 1..100.
202
246
  * Calls `GET /api/v1/deals` through the shared IDP-aware Faiber client.
203
247
  * @param params Typed query parameters; omitted members retain backend defaults.
204
248
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
205
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
206
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:deal:read, crm:deal:read_all, crm:deal:read_own.
249
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
250
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of crm:deal:read, crm:deal:read_all, crm:deal:read_own.
207
251
  */
208
252
  apiDealsGet(params, options) {
209
253
  return this.client.request({ ...options, method: "GET", url: `/api/v1/deals`, params });
210
254
  }
211
255
  /**
212
- * Performs the create deal operation for the api capability.
256
+ * Create a deal with nonempty trimmed name, nonnegative amounts and probability 0..1. Choose active deal stage when omitted, default probability from stage, owner caller and currency IRR. Validate team membership; return 201. Requires a nonempty Idempotency-Key header up to 128 characters; duplicate submissions return 409 instead of replaying a response.
213
257
  * Calls `POST /api/v1/deals` through the shared IDP-aware Faiber client.
214
258
  * @param data Typed JSON request body.
215
259
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
216
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
217
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:deal:create.
260
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
261
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of crm:deal:create.
218
262
  */
219
263
  apiCreateDealPost(data, options) {
220
264
  return this.client.request({ ...options, method: "POST", url: `/api/v1/deals`, data: data });
221
265
  }
222
266
  /**
223
- * Performs the deal operation for the api capability.
267
+ * Read a nondeleted workspace deal visible to caller; only crm:admin or crm:deal:read_all removes owner filtering. Missing/invisible deals return 404.
224
268
  * Calls `GET /api/v1/deals/{id}` through the shared IDP-aware Faiber client.
225
269
  * @param id Backend path identifier `id`.
226
270
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
227
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
228
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:deal:read, crm:deal:read_all, crm:deal:read_own.
271
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
272
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of crm:deal:read, crm:deal:read_all, crm:deal:read_own.
229
273
  */
230
274
  apiDealGet(id, options) {
231
275
  return this.client.request({ ...options, method: "GET", url: `/api/v1/deals/${encodeURIComponent(id)}` });
232
276
  }
233
277
  /**
234
- * Performs the update deal operation for the api capability.
278
+ * Patch a deal with required version; validate name, nonnegative amounts and probability 0..1. Optional nulls preserve fields; missing 404, stale version 409. Requires a nonempty Idempotency-Key header up to 128 characters; duplicate submissions return 409 instead of replaying a response.
235
279
  * Calls `PATCH /api/v1/deals/{id}` through the shared IDP-aware Faiber client.
236
280
  * @param id Backend path identifier `id`.
237
281
  * @param data Typed JSON request body.
238
282
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
239
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
240
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:deal:update.
283
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
284
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of crm:deal:update.
241
285
  */
242
286
  apiUpdateDealPatch(id, data, options) {
243
287
  return this.client.request({ ...options, method: "PATCH", url: `/api/v1/deals/${encodeURIComponent(id)}`, data: data });
244
288
  }
245
289
  /**
246
- * Performs the assign deal operation for the api capability.
290
+ * Replace deal team and owner using required version; omitted or null IDs clear assignments. Validate active team and owner membership when selected, and write assignment activity. Missing 404, validation 422, stale version 409. Requires a nonempty Idempotency-Key header up to 128 characters; duplicate submissions return 409 instead of replaying a response.
247
291
  * Calls `PATCH /api/v1/deals/{id}/assignment` through the shared IDP-aware Faiber client.
248
292
  * @param id Backend path identifier `id`.
249
293
  * @param data Typed JSON request body.
250
294
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
251
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
252
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:deal:assign.
295
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
296
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of crm:deal:assign.
253
297
  */
254
298
  apiAssignDealPatch(id, data, options) {
255
299
  return this.client.request({ ...options, method: "PATCH", url: `/api/v1/deals/${encodeURIComponent(id)}/assignment`, data: data });
256
300
  }
257
301
  /**
258
- * Performs the move deal stage operation for the api capability.
302
+ * Move a deal within its pipeline with required version; active stage required. Lost requires nonempty loss_reason; update status/probability/closed_at and write stage-change activity. Missing 404, validation 422, stale version 409. Requires a nonempty Idempotency-Key header up to 128 characters; duplicate submissions return 409 instead of replaying a response.
259
303
  * Calls `PATCH /api/v1/deals/{id}/stage` through the shared IDP-aware Faiber client.
260
304
  * @param id Backend path identifier `id`.
261
305
  * @param data Typed JSON request body.
262
306
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
263
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
264
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:deal:move.
307
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
308
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of crm:deal:move.
265
309
  */
266
310
  apiMoveDealStagePatch(id, data, options) {
267
311
  return this.client.request({ ...options, method: "PATCH", url: `/api/v1/deals/${encodeURIComponent(id)}/stage`, data: data });
268
312
  }
269
313
  /**
270
- * Performs the find office lead operation for the api capability.
314
+ * Find a nullable legacy leads-table row by profile_id, foreign_key and comma-separated flags. Empty flags may match a single candidate. Response is legacy status/message/data without meta. This handler has no local authorization or workspace predicate.
271
315
  * Calls `GET /api/v1/integration/office/leads/find` through the shared IDP-aware Faiber client.
272
316
  * @param params Typed query parameters; omitted members retain backend defaults.
273
317
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
274
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
275
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
318
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
319
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: No local handler permission check; deployment/gateway authority must be independently verified.
276
320
  */
277
321
  apiFindOfficeLeadGet(params, options) {
278
322
  return this.client.request({ ...options, method: "GET", url: `/api/v1/integration/office/leads/find`, params });
279
323
  }
280
324
  /**
281
- * Performs the leads operation for the api capability.
325
+ * List bare nondeleted workspace lead records with UUID cursor and q/pipeline/stage/status/team/owner/statuses/profile/active date filters. statuses is comma-separated. Caller-only unless crm:admin or crm:lead:read_all. Limit defaults 50, clamped 1..100; UUID cursor remains id > cursor even with task_priority/created_at/created_at_desc sorting.
282
326
  * Calls `GET /api/v1/leads` through the shared IDP-aware Faiber client.
283
327
  * @param params Typed query parameters; omitted members retain backend defaults.
284
328
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
285
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
286
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:lead:read, crm:lead:read_all, crm:lead:read_own.
329
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
330
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of crm:lead:read, crm:lead:read_all, crm:lead:read_own.
287
331
  */
288
332
  apiLeadsGet(params, options) {
289
333
  return this.client.request({ ...options, method: "GET", url: `/api/v1/leads`, params });
290
334
  }
291
335
  /**
292
- * Performs the create lead operation for the api capability.
336
+ * Create a lead with trimmed title, score 0..100 and nonnegative value; choose an active lead stage when omitted, default owner to caller and currency IRR. Validate active team/member assignment; return a bare Lead with HTTP 201. Requires a nonempty Idempotency-Key header up to 128 characters; duplicate submissions return 409 instead of replaying a response.
293
337
  * Calls `POST /api/v1/leads` through the shared IDP-aware Faiber client.
294
338
  * @param data Typed JSON request body.
295
339
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
296
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
297
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:lead:create.
340
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
341
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of crm:lead:create.
298
342
  */
299
343
  apiCreateLeadPost(data, options) {
300
344
  return this.client.request({ ...options, method: "POST", url: `/api/v1/leads`, data: data });
301
345
  }
302
346
  /**
303
- * Performs the lead operation for the api capability.
347
+ * Read a nondeleted workspace lead visible to the caller and enrich a nullable remote profile using column or legacy custom_data.profile_id; missing/invisible leads return 404.
304
348
  * Calls `GET /api/v1/leads/{id}` through the shared IDP-aware Faiber client.
305
349
  * @param id Backend path identifier `id`.
306
350
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
307
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
308
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:lead:read, crm:lead:read_all, crm:lead:read_own.
351
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
352
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of crm:lead:read, crm:lead:read_all, crm:lead:read_own.
309
353
  */
310
354
  apiLeadGet(id, options) {
311
355
  return this.client.request({ ...options, method: "GET", url: `/api/v1/leads/${encodeURIComponent(id)}` });
312
356
  }
313
357
  /**
314
- * Performs the update lead operation for the api capability.
358
+ * Patch a bare lead with required version; validate nonempty title, score 0..100, nonnegative value and new/working/qualified/disqualified/converted status. Optional nulls preserve fields; missing 404, stale version 409. Requires a nonempty Idempotency-Key header up to 128 characters; duplicate submissions return 409 instead of replaying a response.
315
359
  * Calls `PATCH /api/v1/leads/{id}` through the shared IDP-aware Faiber client.
316
360
  * @param id Backend path identifier `id`.
317
361
  * @param data Typed JSON request body.
318
362
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
319
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
320
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:lead:update.
363
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
364
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of crm:lead:update.
321
365
  */
322
366
  apiUpdateLeadPatch(id, data, options) {
323
367
  return this.client.request({ ...options, method: "PATCH", url: `/api/v1/leads/${encodeURIComponent(id)}`, data: data });
324
368
  }
325
369
  /**
326
- * Performs the assign lead operation for the api capability.
370
+ * Replace lead team and owner using required version; omitted or null IDs clear assignments. Validate active team and owner membership when selected, and write assignment activity. Missing 404, validation 422, stale version 409. Requires a nonempty Idempotency-Key header up to 128 characters; duplicate submissions return 409 instead of replaying a response.
327
371
  * Calls `PATCH /api/v1/leads/{id}/assignment` through the shared IDP-aware Faiber client.
328
372
  * @param id Backend path identifier `id`.
329
373
  * @param data Typed JSON request body.
330
374
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
331
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
332
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:lead:assign.
375
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
376
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of crm:lead:assign.
333
377
  */
334
378
  apiAssignLeadPatch(id, data, options) {
335
379
  return this.client.request({ ...options, method: "PATCH", url: `/api/v1/leads/${encodeURIComponent(id)}/assignment`, data: data });
336
380
  }
337
381
  /**
338
- * Performs the lead history operation for the api capability.
382
+ * Merge activities and audit events for a workspace lead, newest first, with nullable actor profiles and extensible event data. Either crm:lead:read or crm:activity:read suffices; this handler does not apply lead ownership filtering.
339
383
  * Calls `GET /api/v1/leads/{id}/history` through the shared IDP-aware Faiber client.
340
384
  * @param id Backend path identifier `id`.
341
385
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
342
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
343
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:lead:read, crm:activity:read.
386
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
387
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of crm:lead:read, crm:activity:read.
344
388
  */
345
389
  apiLeadHistoryGet(id, options) {
346
390
  return this.client.request({ ...options, method: "GET", url: `/api/v1/leads/${encodeURIComponent(id)}/history` });
347
391
  }
348
392
  /**
349
- * Performs the delete lead reminders operation for the api capability.
393
+ * Soft-delete all nondeleted tasks for the workspace lead UUID; return {lead_id,deleted} with a numeric affected count, including zero. No parent check, version or idempotency key is required.
350
394
  * Calls `DELETE /api/v1/leads/{id}/reminders` through the shared IDP-aware Faiber client.
351
395
  * @param id Backend path identifier `id`.
352
396
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
353
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
354
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:task:delete.
397
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
398
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of crm:task:delete.
355
399
  */
356
400
  apiDeleteLeadRemindersDelete(id, options) {
357
401
  return this.client.request({ ...options, method: "DELETE", url: `/api/v1/leads/${encodeURIComponent(id)}/reminders` });
358
402
  }
359
403
  /**
360
- * Performs the remove lead from sos operation for the api capability.
404
+ * Remove an SOS entry and return {id,deleted:true}, where id is the SOS entry UUID, not the lead UUID; absent entry returns 404. Requires a nonempty Idempotency-Key header up to 128 characters; duplicate submissions return 409 instead of replaying a response.
361
405
  * Calls `DELETE /api/v1/leads/{id}/sos` through the shared IDP-aware Faiber client.
362
406
  * @param id Backend path identifier `id`.
363
407
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
364
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
365
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:sos:delete.
408
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
409
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of crm:sos:delete.
366
410
  */
367
411
  apiRemoveLeadFromSosDelete(id, options) {
368
412
  return this.client.request({ ...options, method: "DELETE", url: `/api/v1/leads/${encodeURIComponent(id)}/sos` });
369
413
  }
370
414
  /**
371
- * Performs the add lead to sos operation for the api capability.
415
+ * Upsert SOS for a nondeleted workspace lead; existing SOS retains its record identity and creator. Missing lead returns 404. Returns 201. Requires a nonempty Idempotency-Key header up to 128 characters; duplicate submissions return 409 instead of replaying a response.
372
416
  * Calls `POST /api/v1/leads/{id}/sos` through the shared IDP-aware Faiber client.
373
417
  * @param id Backend path identifier `id`.
374
418
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
375
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
376
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:sos:create.
419
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
420
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of crm:sos:create.
377
421
  */
378
422
  apiAddLeadToSosPost(id, options) {
379
423
  return this.client.request({ ...options, method: "POST", url: `/api/v1/leads/${encodeURIComponent(id)}/sos` });
380
424
  }
381
425
  /**
382
- * Performs the move lead stage operation for the api capability.
426
+ * Move a lead within its pipeline with required version; active stage required. Lost stage disqualifies and records loss_reason; won/activation/recurring slug qualifies. Write stage-change activity; missing 404, invalid stage 422, stale version 409. Requires a nonempty Idempotency-Key header up to 128 characters; duplicate submissions return 409 instead of replaying a response.
383
427
  * Calls `PATCH /api/v1/leads/{id}/stage` through the shared IDP-aware Faiber client.
384
428
  * @param id Backend path identifier `id`.
385
429
  * @param data Typed JSON request body.
386
430
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
387
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
388
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:lead:move.
431
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
432
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of crm:lead:move.
389
433
  */
390
434
  apiMoveLeadStagePatch(id, data, options) {
391
435
  return this.client.request({ ...options, method: "PATCH", url: `/api/v1/leads/${encodeURIComponent(id)}/stage`, data: data });
392
436
  }
393
437
  /**
394
- * Performs the light leads operation for the api capability.
438
+ * Alias of the full lead list with exactly the same filters, ownership restrictions and bare Lead response model; no extra profile enrichment.
395
439
  * Calls `GET /api/v1/leads/light` through the shared IDP-aware Faiber client.
396
440
  * @param params Typed query parameters; omitted members retain backend defaults.
397
441
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
398
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
399
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
442
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
443
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of crm:lead:read, crm:lead:read_all, crm:lead:read_own (delegates to the full lead-list handler).
400
444
  */
401
445
  apiLightLeadsGet(params, options) {
402
446
  return this.client.request({ ...options, method: "GET", url: `/api/v1/leads/light`, params });
403
447
  }
404
448
  /**
405
- * Performs the pipelines operation for the api capability.
449
+ * List nondeleted workspace workflows with their nondeleted stages; includes inactive entries, ordered by entity type, priority, default flag and name.
406
450
  * Calls `GET /api/v1/pipelines` through the shared IDP-aware Faiber client.
407
451
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
408
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
409
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:pipeline:read.
452
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
453
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of crm:pipeline:read.
410
454
  */
411
455
  apiPipelinesGet(options) {
412
456
  return this.client.request({ ...options, method: "GET", url: `/api/v1/pipelines` });
413
457
  }
414
458
  /**
415
- * Performs the update pipeline operation for the api capability.
459
+ * Patch pipeline fields using required version; negative quota returns 422 and missing/stale version match returns 409. Null fields preserve existing values.
416
460
  * Calls `PATCH /api/v1/pipelines/{id}` through the shared IDP-aware Faiber client.
417
461
  * @param id Backend path identifier `id`.
418
462
  * @param data Typed JSON request body.
419
463
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
420
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
421
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:pipeline:update.
464
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
465
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of crm:pipeline:update.
422
466
  */
423
467
  apiUpdatePipelinePatch(id, data, options) {
424
468
  return this.client.request({ ...options, method: "PATCH", url: `/api/v1/pipelines/${encodeURIComponent(id)}`, data: data });
425
469
  }
426
470
  /**
427
- * Performs the report run operation for the api capability.
471
+ * Read a workspace report run by UUID, including nullable deterministic summary, AI result/error and completion timestamp; missing or foreign run returns 404.
428
472
  * Calls `GET /api/v1/reports/{id}` through the shared IDP-aware Faiber client.
429
473
  * @param id Backend path identifier `id`.
430
474
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
431
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
432
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:report:read.
475
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
476
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of crm:report:read.
433
477
  */
434
478
  apiReportRunGet(id, options) {
435
479
  return this.client.request({ ...options, method: "GET", url: `/api/v1/reports/${encodeURIComponent(id)}` });
436
480
  }
437
481
  /**
438
- * Performs the request agentic insight operation for the api capability.
482
+ * Queue report insight for a ready/ready_without_ai report, charge to configured project owner only when execution starts. Disabled AI or missing owner returns 422; missing ready run 404. Return queued job/project-owner UUIDs with HTTP 202. Requires a nonempty Idempotency-Key header up to 128 characters; duplicate submissions return 409 instead of replaying a response.
439
483
  * Calls `POST /api/v1/reports/{id}/agentic` through the shared IDP-aware Faiber client.
440
484
  * @param id Backend path identifier `id`.
441
485
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
442
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
443
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:agent:run.
486
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
487
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of crm:agent:run.
444
488
  */
445
489
  apiRequestAgenticInsightPost(id, options) {
446
490
  return this.client.request({ ...options, method: "POST", url: `/api/v1/reports/${encodeURIComponent(id)}/agentic` });
447
491
  }
448
492
  /**
449
- * Performs the report catalog operation for the api capability.
493
+ * Read workspace report definitions and global metric definitions as concrete reports/metrics arrays, ordered by report name/UUID and metric key.
450
494
  * Calls `GET /api/v1/reports/catalog` through the shared IDP-aware Faiber client.
451
495
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
452
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
453
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:report:read.
496
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
497
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of crm:report:read.
454
498
  */
455
499
  apiReportCatalogGet(options) {
456
500
  return this.client.request({ ...options, method: "GET", url: `/api/v1/reports/catalog` });
457
501
  }
458
502
  /**
459
- * Performs the overview operation for the api capability.
503
+ * Calculate provisional metrics and data-quality warnings for period_start/period_end query. Default start is the first UTC day of end month and default end now; financial totals depend on ingested actuals.
460
504
  * Calls `GET /api/v1/reports/overview` through the shared IDP-aware Faiber client.
461
505
  * @param params Typed query parameters; omitted members retain backend defaults.
462
506
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
463
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
464
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:report:read.
507
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
508
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of crm:report:read.
465
509
  */
466
510
  apiOverviewGet(params, options) {
467
511
  return this.client.request({ ...options, method: "GET", url: `/api/v1/reports/overview`, params });
468
512
  }
469
513
  /**
470
- * Performs the refresh reports operation for the api capability.
514
+ * Calculate and persist certified metric snapshots/report run; period bounds are query parameters and no JSON body is read. Returns 201 with ready status, overview and agentic_started:false. Requires a nonempty Idempotency-Key header up to 128 characters; duplicate submissions return 409 instead of replaying a response.
471
515
  * Calls `POST /api/v1/reports/refresh` through the shared IDP-aware Faiber client.
472
516
  * @param params Typed query parameters; omitted members retain backend defaults.
473
517
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
474
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
475
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:report:refresh.
518
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
519
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of crm:report:refresh.
476
520
  */
477
521
  apiRefreshReportsPost(params, options) {
478
522
  return this.client.request({ ...options, method: "POST", url: `/api/v1/reports/refresh`, params });
479
523
  }
480
524
  /**
481
- * Performs the list sos leads operation for the api capability.
525
+ * List SOS entries whose leads are nondeleted in this workspace, newest first; returns SOS records rather than enriched lead objects.
482
526
  * Calls `GET /api/v1/sos` through the shared IDP-aware Faiber client.
483
527
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
484
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
485
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:sos:read.
528
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
529
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of crm:sos:read.
486
530
  */
487
531
  apiListSosLeadsGet(options) {
488
532
  return this.client.request({ ...options, method: "GET", url: `/api/v1/sos` });
489
533
  }
490
534
  /**
491
- * Performs the sources operation for the api capability.
535
+ * List all workspace marketing sources, including inactive entries, ordered by active flag then name and UUID.
492
536
  * Calls `GET /api/v1/sources` through the shared IDP-aware Faiber client.
493
537
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
494
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
495
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:marketing:read.
538
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
539
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of crm:marketing:read.
496
540
  */
497
541
  apiSourcesGet(options) {
498
542
  return this.client.request({ ...options, method: "GET", url: `/api/v1/sources` });
499
543
  }
500
544
  /**
501
- * Performs the create source operation for the api capability.
545
+ * Create a marketing source with trimmed nonempty name/slug and channel default other; return HTTP 201. Requires a nonempty Idempotency-Key header up to 128 characters; duplicate submissions return 409 instead of replaying a response.
502
546
  * Calls `POST /api/v1/sources` through the shared IDP-aware Faiber client.
503
547
  * @param data Typed JSON request body.
504
548
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
505
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
506
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:marketing:manage.
549
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
550
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of crm:marketing:manage.
507
551
  */
508
552
  apiCreateSourcePost(data, options) {
509
553
  return this.client.request({ ...options, method: "POST", url: `/api/v1/sources`, data: data });
510
554
  }
511
555
  /**
512
- * Performs the daily stats operation for the api capability.
556
+ * Calculate caller-assigned workflow daily quotas from backlog and priority, completed-today counts and extra work in UTC. Default total allocation limit is 50; no assigned/actionable workflows returns empty totals and all_tasks_done:true.
513
557
  * Calls `GET /api/v1/stats/daily` through the shared IDP-aware Faiber client.
514
558
  * @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: crm:stats:read, crm:stats:read_own.
559
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
560
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of crm:stats:read, crm:stats:read_own.
517
561
  */
518
562
  apiDailyStatsGet(options) {
519
563
  return this.client.request({ ...options, method: "GET", url: `/api/v1/stats/daily` });
520
564
  }
521
565
  /**
522
- * Performs the lead stats operation for the api capability.
566
+ * Aggregate total/active/inactive leads for caller-assigned nondeleted lead workflows; active status uses custom_data.is_active_status, default true.
523
567
  * Calls `GET /api/v1/stats/lead` through the shared IDP-aware Faiber client.
524
568
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
525
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
526
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:stats:read, crm:stats:read_all, crm:stats:read_own.
569
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
570
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of crm:stats:read, crm:stats:read_all, crm:stats:read_own.
527
571
  */
528
572
  apiLeadStatsGet(options) {
529
573
  return this.client.request({ ...options, method: "GET", url: `/api/v1/stats/lead` });
530
574
  }
531
575
  /**
532
- * Performs the tasks operation for the api capability.
576
+ * List nondeleted task rows by ascending UUID; filters cursor/status/profile_id and due_at via active_from/active_to. Caller-only unless crm:admin or crm:task:read_all. Limit defaults 50, clamped 1..100.
533
577
  * Calls `GET /api/v1/tasks` through the shared IDP-aware Faiber client.
534
578
  * @param params Typed query parameters; omitted members retain backend defaults.
535
579
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
536
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
537
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:task:read, crm:task:read_all, crm:task:read_own.
580
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
581
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of crm:task:read, crm:task:read_all, crm:task:read_own.
538
582
  */
539
583
  apiTasksGet(params, options) {
540
584
  return this.client.request({ ...options, method: "GET", url: `/api/v1/tasks`, params });
541
585
  }
542
586
  /**
543
- * Performs the create task operation for the api capability.
587
+ * Create a task with nonempty trimmed title, priority low/normal/high/urgent (default normal), task_type default follow_up and assignee default caller; return 201. Requires a nonempty Idempotency-Key header up to 128 characters; duplicate submissions return 409 instead of replaying a response.
544
588
  * Calls `POST /api/v1/tasks` through the shared IDP-aware Faiber client.
545
589
  * @param data Typed JSON request body.
546
590
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
547
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
548
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:task:create.
591
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
592
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of crm:task:create.
549
593
  */
550
594
  apiCreateTaskPost(data, options) {
551
595
  return this.client.request({ ...options, method: "POST", url: `/api/v1/tasks`, data: data });
552
596
  }
553
597
  /**
554
- * Performs the delete task operation for the api capability.
598
+ * Soft-delete a nondeleted workspace task and return {id,deleted:true}; no version body is accepted, and absent task returns 404. Requires a nonempty Idempotency-Key header up to 128 characters; duplicate submissions return 409 instead of replaying a response.
555
599
  * Calls `DELETE /api/v1/tasks/{id}` through the shared IDP-aware Faiber client.
556
600
  * @param id Backend path identifier `id`.
557
601
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
558
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
559
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:task:delete.
602
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
603
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of crm:task:delete.
560
604
  */
561
605
  apiDeleteTaskDelete(id, options) {
562
606
  return this.client.request({ ...options, method: "DELETE", url: `/api/v1/tasks/${encodeURIComponent(id)}` });
563
607
  }
564
608
  /**
565
- * Performs the update task status operation for the api capability.
609
+ * Set open/in_progress/completed/cancelled with required version; completed sets completed_at and other statuses clear it. Missing task 404; stale version 409. Requires a nonempty Idempotency-Key header up to 128 characters; duplicate submissions return 409 instead of replaying a response.
566
610
  * Calls `PATCH /api/v1/tasks/{id}/status` through the shared IDP-aware Faiber client.
567
611
  * @param id Backend path identifier `id`.
568
612
  * @param data Typed JSON request body.
569
613
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
570
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
571
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:task:update.
614
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
615
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of crm:task:update.
572
616
  */
573
617
  apiUpdateTaskStatusPatch(id, data, options) {
574
618
  return this.client.request({ ...options, method: "PATCH", url: `/api/v1/tasks/${encodeURIComponent(id)}/status`, data: data });
575
619
  }
576
620
  /**
577
- * Performs the teams operation for the api capability.
621
+ * List nondeleted workspace teams with active member counts, ordered by name and UUID; includes inactive teams.
578
622
  * Calls `GET /api/v1/teams` through the shared IDP-aware Faiber client.
579
623
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
580
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
581
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:team:read.
624
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
625
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of crm:team:read.
582
626
  */
583
627
  apiTeamsGet(options) {
584
628
  return this.client.request({ ...options, method: "GET", url: `/api/v1/teams` });
585
629
  }
586
630
  /**
587
- * Performs the create team operation for the api capability.
631
+ * Create a trimmed nonempty team name with optional description/manager; return the team and zero member count with HTTP 201. Requires a nonempty Idempotency-Key header up to 128 characters; duplicate submissions return 409 instead of replaying a response.
588
632
  * Calls `POST /api/v1/teams` through the shared IDP-aware Faiber client.
589
633
  * @param data Typed JSON request body.
590
634
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
591
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
592
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:team:create.
635
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
636
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of crm:team:create.
593
637
  */
594
638
  apiCreateTeamPost(data, options) {
595
639
  return this.client.request({ ...options, method: "POST", url: `/api/v1/teams`, data: data });
596
640
  }
597
641
  /**
598
- * Performs the delete team operation for the api capability.
642
+ * Soft-delete a team with required optimistic version; deactivate members, detach team references and remove workflow assignments transactionally. Missing team returns 404 and version conflict 409. Requires a nonempty Idempotency-Key header up to 128 characters; duplicate submissions return 409 instead of replaying a response.
599
643
  * Calls `DELETE /api/v1/teams/{id}` through the shared IDP-aware Faiber client.
600
644
  * @param id Backend path identifier `id`.
601
645
  * @param data Typed JSON request body.
602
646
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
603
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
604
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:team:delete.
647
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
648
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of crm:team:delete.
605
649
  */
606
650
  apiDeleteTeamDelete(id, data, options) {
607
651
  return this.client.request({ ...options, method: "DELETE", url: `/api/v1/teams/${encodeURIComponent(id)}`, data: data });
608
652
  }
609
653
  /**
610
- * Performs the team operation for the api capability.
654
+ * Read a nondeleted workspace team with all membership rows, including inactive members; absent team returns 404.
611
655
  * Calls `GET /api/v1/teams/{id}` through the shared IDP-aware Faiber client.
612
656
  * @param id Backend path identifier `id`.
613
657
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
614
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
615
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:team:read.
658
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
659
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of crm:team:read.
616
660
  */
617
661
  apiTeamGet(id, options) {
618
662
  return this.client.request({ ...options, method: "GET", url: `/api/v1/teams/${encodeURIComponent(id)}` });
619
663
  }
620
664
  /**
621
- * Performs the add team member operation for the api capability.
665
+ * Upsert/reactivate a team user membership with optional title and capacity default 1 in 0..100; missing nondeleted team returns 404. Returns 201. Requires a nonempty Idempotency-Key header up to 128 characters; duplicate submissions return 409 instead of replaying a response.
622
666
  * Calls `POST /api/v1/teams/{id}/members` through the shared IDP-aware Faiber client.
623
667
  * @param id Backend path identifier `id`.
624
668
  * @param data Typed JSON request body.
625
669
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
626
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
627
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:team:manage_members.
670
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
671
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of crm:team:manage_members.
628
672
  */
629
673
  apiAddTeamMemberPost(id, data, options) {
630
674
  return this.client.request({ ...options, method: "POST", url: `/api/v1/teams/${encodeURIComponent(id)}/members`, data: data });
631
675
  }
632
676
  /**
633
- * Performs the remove team member operation for the api capability.
677
+ * Deactivate an active membership identified by member UUID under the team; return the updated membership, or 404 if inactive/missing. Requires a nonempty Idempotency-Key header up to 128 characters; duplicate submissions return 409 instead of replaying a response.
634
678
  * Calls `DELETE /api/v1/teams/{team_id}/members/{member_id}` through the shared IDP-aware Faiber client.
635
679
  * @param teamId Backend path identifier `team_id`.
636
680
  * @param memberId Backend path identifier `member_id`.
637
681
  * @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: crm:team:manage_members.
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: crm:admin or any one of crm:team:manage_members.
640
684
  */
641
685
  apiRemoveTeamMemberDelete(teamId, memberId, options) {
642
686
  return this.client.request({ ...options, method: "DELETE", url: `/api/v1/teams/${encodeURIComponent(teamId)}/members/${encodeURIComponent(memberId)}` });
643
687
  }
644
688
  /**
645
- * Performs the list workflows route operation for the api capability.
689
+ * List nondeleted workspace workflows, including inactive entries. Only sort is consumed from ListQuery; comma-separated entity columns support a - prefix and priority is the final ordering.
646
690
  * Calls `GET /api/v1/workflow` through the shared IDP-aware Faiber client.
647
691
  * @param params Typed query parameters; omitted members retain backend defaults.
648
692
  * @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: workflow:read, workflow:read_all, workflow:read_own.
693
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
694
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of workflow:read, workflow:read_all, workflow:read_own.
651
695
  */
652
696
  apiListWorkflowsRouteGetApiV1Workflow(params, options) {
653
697
  return this.client.request({ ...options, method: "GET", url: `/api/v1/workflow`, params });
654
698
  }
655
699
  /**
656
- * Performs the create workflow route operation for the api capability.
700
+ * Create a workflow with name/slug, required acquire_flags and priority. Defaults entity_type:lead, is_active:true and zero quota; normalize/deduplicate flags and require unique action keys/forms. Returns 201.
657
701
  * Calls `POST /api/v1/workflow` through the shared IDP-aware Faiber client.
658
702
  * @param data Typed JSON request body.
659
703
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
660
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
661
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: workflow:create.
704
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
705
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of workflow:create.
662
706
  */
663
707
  apiCreateWorkflowRoutePostApiV1Workflow(data, options) {
664
708
  return this.client.request({ ...options, method: "POST", url: `/api/v1/workflow`, data: data });
665
709
  }
666
710
  /**
667
- * Performs the list workflow nodes compat route operation for the api capability.
711
+ * List nondeleted nodes whose parent workflows are nondeleted; includes inactive nodes. The repository has no workspace predicate on this compatibility listing. Only sort is consumed.
668
712
  * Calls `GET /api/v1/workflow-node` through the shared IDP-aware Faiber client.
669
713
  * @param params Typed query parameters; omitted members retain backend defaults.
670
714
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
671
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
672
- * @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.
715
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
716
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of workflow_node:read, workflow_node:read_all, workflow_node:read_own.
673
717
  */
674
718
  apiListWorkflowNodesCompatRouteGet(params, options) {
675
719
  return this.client.request({ ...options, method: "GET", url: `/api/v1/workflow-node`, params });
676
720
  }
677
721
  /**
678
- * Performs the delete workflow node compat route operation for the api capability.
722
+ * Soft-delete a node after checking its workspace parent; this singular compatibility route returns data:true, not a deletion object.
679
723
  * Calls `DELETE /api/v1/workflow-node/{id}` through the shared IDP-aware Faiber client.
680
724
  * @param id Backend path identifier `id`.
681
725
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
682
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
683
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: workflow_node:delete.
726
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
727
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of workflow_node:delete.
684
728
  */
685
729
  apiDeleteWorkflowNodeCompatRouteDelete(id, options) {
686
730
  return this.client.request({ ...options, method: "DELETE", url: `/api/v1/workflow-node/${encodeURIComponent(id)}` });
687
731
  }
688
732
  /**
689
- * Performs the show workflow node compat route operation for the api capability.
733
+ * Read a nondeleted node by UUID, then require its nondeleted parent in the configured workspace; missing parent or node returns 404.
690
734
  * Calls `GET /api/v1/workflow-node/{id}` through the shared IDP-aware Faiber client.
691
735
  * @param id Backend path identifier `id`.
692
736
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
693
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
694
- * @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.
737
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
738
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of workflow_node:read, workflow_node:read_all, workflow_node:read_own.
695
739
  */
696
740
  apiShowWorkflowNodeCompatRouteGet(id, options) {
697
741
  return this.client.request({ ...options, method: "GET", url: `/api/v1/workflow-node/${encodeURIComponent(id)}` });
698
742
  }
699
743
  /**
700
- * Performs the update workflow node compat route operation for the api capability.
744
+ * Resolve a node UUID to its checked workspace parent, then patch it. Explicit null clears sla_minutes/actions; no version parameter is enforced.
701
745
  * Calls `PATCH /api/v1/workflow-node/{id}` through the shared IDP-aware Faiber client.
702
746
  * @param id Backend path identifier `id`.
703
747
  * @param data Typed JSON request body.
704
748
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
705
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
706
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: workflow_node:update.
749
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
750
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of workflow_node:update.
707
751
  */
708
752
  apiUpdateWorkflowNodeCompatRoutePatch(id, data, options) {
709
753
  return this.client.request({ ...options, method: "PATCH", url: `/api/v1/workflow-node/${encodeURIComponent(id)}`, data: data });
710
754
  }
711
755
  /**
712
- * Performs the create workflow node route operation for the api capability.
756
+ * Create a node under the path workflow UUID (the singular route names that parameter id). Validate name/slug, probability 0..1, open/won/lost stage type and nonnegative SLA; defaults drag permissions true. Returns 201.
713
757
  * Calls `POST /api/v1/workflow-node/{id}` through the shared IDP-aware Faiber client.
714
758
  * @param id Backend path identifier `id`.
715
759
  * @param data Typed JSON request body.
716
760
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
717
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
718
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: workflow_node:create.
761
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
762
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of workflow_node:create.
719
763
  */
720
764
  apiCreateWorkflowNodeRoutePostApiV1WorkflowNodeId(id, data, options) {
721
765
  return this.client.request({ ...options, method: "POST", url: `/api/v1/workflow-node/${encodeURIComponent(id)}`, data: data });
722
766
  }
723
767
  /**
724
- * Performs the update workflow node compat route operation for the api capability.
768
+ * Resolve a node UUID to its checked workspace parent, then patch it. Explicit null clears sla_minutes/actions; no version parameter is enforced.
725
769
  * Calls `PUT /api/v1/workflow-node/{id}` through the shared IDP-aware Faiber client.
726
770
  * @param id Backend path identifier `id`.
727
771
  * @param data Typed JSON request body.
728
772
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
729
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
730
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: workflow_node:update.
773
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
774
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of workflow_node:update.
731
775
  */
732
776
  apiUpdateWorkflowNodeCompatRoutePut(id, data, options) {
733
777
  return this.client.request({ ...options, method: "PUT", url: `/api/v1/workflow-node/${encodeURIComponent(id)}`, data: data });
734
778
  }
735
779
  /**
736
- * Performs the delete workflow route operation for the api capability.
780
+ * Soft-delete a workspace workflow and return {id,deleted:true}; missing or previously deleted workflow returns 404.
737
781
  * Calls `DELETE /api/v1/workflow/{id}` through the shared IDP-aware Faiber client.
738
782
  * @param id Backend path identifier `id`.
739
783
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
740
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
741
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: workflow:delete.
784
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
785
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of workflow:delete.
742
786
  */
743
787
  apiDeleteWorkflowRouteDeleteApiV1WorkflowId(id, options) {
744
788
  return this.client.request({ ...options, method: "DELETE", url: `/api/v1/workflow/${encodeURIComponent(id)}` });
745
789
  }
746
790
  /**
747
- * Performs the show workflow route operation for the api capability.
791
+ * Read one nondeleted workspace workflow by UUID; absent or foreign-workspace IDs return 404.
748
792
  * Calls `GET /api/v1/workflow/{id}` through the shared IDP-aware Faiber client.
749
793
  * @param id Backend path identifier `id`.
750
794
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
751
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
752
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: workflow:read, workflow:read_all, workflow:read_own.
795
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
796
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of workflow:read, workflow:read_all, workflow:read_own.
753
797
  */
754
798
  apiShowWorkflowRouteGetApiV1WorkflowId(id, options) {
755
799
  return this.client.request({ ...options, method: "GET", url: `/api/v1/workflow/${encodeURIComponent(id)}` });
756
800
  }
757
801
  /**
758
- * Performs the update workflow route operation for the api capability.
802
+ * Patch a nondeleted workflow. Explicit null clears team_id/actions/hint; null on ordinary optional fields preserves them. Actions null serializes as an empty array in responses. Version is accepted but repository does not enforce optimistic locking.
759
803
  * Calls `PATCH /api/v1/workflow/{id}` through the shared IDP-aware Faiber client.
760
804
  * @param id Backend path identifier `id`.
761
805
  * @param data Typed JSON request body.
762
806
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
763
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
764
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: workflow:update.
807
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
808
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of workflow:update.
765
809
  */
766
810
  apiUpdateWorkflowRoutePatchApiV1WorkflowId(id, data, options) {
767
811
  return this.client.request({ ...options, method: "PATCH", url: `/api/v1/workflow/${encodeURIComponent(id)}`, data: data });
768
812
  }
769
813
  /**
770
- * Performs the update workflow route operation for the api capability.
814
+ * Patch a nondeleted workflow. Explicit null clears team_id/actions/hint; null on ordinary optional fields preserves them. Actions null serializes as an empty array in responses. Version is accepted but repository does not enforce optimistic locking.
771
815
  * Calls `PUT /api/v1/workflow/{id}` through the shared IDP-aware Faiber client.
772
816
  * @param id Backend path identifier `id`.
773
817
  * @param data Typed JSON request body.
774
818
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
775
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
776
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: workflow:update.
819
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
820
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of workflow:update.
777
821
  */
778
822
  apiUpdateWorkflowRoutePut(id, data, options) {
779
823
  return this.client.request({ ...options, method: "PUT", url: `/api/v1/workflow/${encodeURIComponent(id)}`, data: data });
780
824
  }
781
825
  /**
782
- * Performs the list workflows route operation for the api capability.
826
+ * List nondeleted workspace workflows, including inactive entries. Only sort is consumed from ListQuery; comma-separated entity columns support a - prefix and priority is the final ordering.
783
827
  * Calls `GET /api/v1/workflows` through the shared IDP-aware Faiber client.
784
828
  * @param params Typed query parameters; omitted members retain backend defaults.
785
829
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
786
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
787
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: workflow:read, workflow:read_all, workflow:read_own.
830
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
831
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of workflow:read, workflow:read_all, workflow:read_own.
788
832
  */
789
833
  apiListWorkflowsRouteGetApiV1Workflows(params, options) {
790
834
  return this.client.request({ ...options, method: "GET", url: `/api/v1/workflows`, params });
791
835
  }
792
836
  /**
793
- * Performs the create workflow route operation for the api capability.
837
+ * Create a workflow with name/slug, required acquire_flags and priority. Defaults entity_type:lead, is_active:true and zero quota; normalize/deduplicate flags and require unique action keys/forms. Returns 201.
794
838
  * Calls `POST /api/v1/workflows` through the shared IDP-aware Faiber client.
795
839
  * @param data Typed JSON request body.
796
840
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
797
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
798
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: workflow:create.
841
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
842
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of workflow:create.
799
843
  */
800
844
  apiCreateWorkflowRoutePostApiV1Workflows(data, options) {
801
845
  return this.client.request({ ...options, method: "POST", url: `/api/v1/workflows`, data: data });
802
846
  }
803
847
  /**
804
- * Performs the delete workflow route operation for the api capability.
848
+ * Soft-delete a workspace workflow and return {id,deleted:true}; missing or previously deleted workflow returns 404.
805
849
  * Calls `DELETE /api/v1/workflows/{id}` through the shared IDP-aware Faiber client.
806
850
  * @param id Backend path identifier `id`.
807
851
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
808
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
809
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: workflow:delete.
852
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
853
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of workflow:delete.
810
854
  */
811
855
  apiDeleteWorkflowRouteDeleteApiV1WorkflowsId(id, options) {
812
856
  return this.client.request({ ...options, method: "DELETE", url: `/api/v1/workflows/${encodeURIComponent(id)}` });
813
857
  }
814
858
  /**
815
- * Performs the show workflow route operation for the api capability.
859
+ * Read one nondeleted workspace workflow by UUID; absent or foreign-workspace IDs return 404.
816
860
  * Calls `GET /api/v1/workflows/{id}` through the shared IDP-aware Faiber client.
817
861
  * @param id Backend path identifier `id`.
818
862
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
819
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
820
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: workflow:read, workflow:read_all, workflow:read_own.
863
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
864
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of workflow:read, workflow:read_all, workflow:read_own.
821
865
  */
822
866
  apiShowWorkflowRouteGetApiV1WorkflowsId(id, options) {
823
867
  return this.client.request({ ...options, method: "GET", url: `/api/v1/workflows/${encodeURIComponent(id)}` });
824
868
  }
825
869
  /**
826
- * Performs the update workflow route operation for the api capability.
870
+ * Patch a nondeleted workflow. Explicit null clears team_id/actions/hint; null on ordinary optional fields preserves them. Actions null serializes as an empty array in responses. Version is accepted but repository does not enforce optimistic locking.
827
871
  * Calls `PATCH /api/v1/workflows/{id}` through the shared IDP-aware Faiber client.
828
872
  * @param id Backend path identifier `id`.
829
873
  * @param data Typed JSON request body.
830
874
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
831
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
832
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: workflow:update.
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: crm:admin or any one of workflow:update.
833
877
  */
834
878
  apiUpdateWorkflowRoutePatchApiV1WorkflowsId(id, data, options) {
835
879
  return this.client.request({ ...options, method: "PATCH", url: `/api/v1/workflows/${encodeURIComponent(id)}`, data: data });
836
880
  }
837
881
  /**
838
- * Performs the list workflow assignments operation for the api capability.
882
+ * List team/user assignments in this workspace for the path workflow UUID, ordered by creation and UUID; does not check parent existence.
839
883
  * Calls `GET /api/v1/workflows/{id}/assignments` through the shared IDP-aware Faiber client.
840
884
  * @param id Backend path identifier `id`.
841
885
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
842
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
843
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:workflow_assignment:read.
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: crm:admin or any one of crm:workflow_assignment:read.
844
888
  */
845
889
  apiListWorkflowAssignmentsGet(id, options) {
846
890
  return this.client.request({ ...options, method: "GET", url: `/api/v1/workflows/${encodeURIComponent(id)}/assignments` });
847
891
  }
848
892
  /**
849
- * Performs the create workflow assignment operation for the api capability.
893
+ * Assign exactly one team_id or user_id to a workflow; supplied team must exist and duplicate assignments return 409. Returns 201; parent validity also depends on database constraints. Requires a nonempty Idempotency-Key header up to 128 characters; duplicate submissions return 409 instead of replaying a response.
850
894
  * Calls `POST /api/v1/workflows/{id}/assignments` through the shared IDP-aware Faiber client.
851
895
  * @param id Backend path identifier `id`.
852
896
  * @param data Typed JSON request body.
853
897
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
854
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
855
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:workflow_assignment:manage.
898
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
899
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of crm:workflow_assignment:manage.
856
900
  */
857
901
  apiCreateWorkflowAssignmentPost(id, data, options) {
858
902
  return this.client.request({ ...options, method: "POST", url: `/api/v1/workflows/${encodeURIComponent(id)}/assignments`, data: data });
859
903
  }
860
904
  /**
861
- * Performs the delete workflow assignment operation for the api capability.
905
+ * Hard-delete a workflow assignment scoped by workspace, workflow UUID and assignment UUID; return {id,deleted:true}, or 404. Requires a nonempty Idempotency-Key header up to 128 characters; duplicate submissions return 409 instead of replaying a response.
862
906
  * Calls `DELETE /api/v1/workflows/{workflow_id}/assignments/{assignment_id}` through the shared IDP-aware Faiber client.
863
907
  * @param workflowId Backend path identifier `workflow_id`.
864
908
  * @param assignmentId Backend path identifier `assignment_id`.
865
909
  * @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: crm:workflow_assignment:manage.
910
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
911
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of crm:workflow_assignment:manage.
868
912
  */
869
913
  apiDeleteWorkflowAssignmentDelete(workflowId, assignmentId, options) {
870
914
  return this.client.request({ ...options, method: "DELETE", url: `/api/v1/workflows/${encodeURIComponent(workflowId)}/assignments/${encodeURIComponent(assignmentId)}` });
871
915
  }
872
916
  /**
873
- * Performs the list workflow nodes route operation for the api capability.
917
+ * List nondeleted nodes after checking that the parent workflow belongs to this workspace; includes inactive nodes. Only sort is consumed; sort columns precede priority ordering.
874
918
  * Calls `GET /api/v1/workflows/{workflow_id}/nodes` through the shared IDP-aware Faiber client.
875
919
  * @param workflowId Backend path identifier `workflow_id`.
876
920
  * @param params Typed query parameters; omitted members retain backend defaults.
877
921
  * @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: workflow_node:read, workflow_node:read_all, workflow_node:read_own.
922
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
923
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of workflow_node:read, workflow_node:read_all, workflow_node:read_own.
880
924
  */
881
925
  apiListWorkflowNodesRouteGet(workflowId, params, options) {
882
926
  return this.client.request({ ...options, method: "GET", url: `/api/v1/workflows/${encodeURIComponent(workflowId)}/nodes`, params });
883
927
  }
884
928
  /**
885
- * Performs the create workflow node route operation for the api capability.
929
+ * Create a node under the path workflow UUID (the singular route names that parameter id). Validate name/slug, probability 0..1, open/won/lost stage type and nonnegative SLA; defaults drag permissions true. Returns 201.
886
930
  * Calls `POST /api/v1/workflows/{workflow_id}/nodes` through the shared IDP-aware Faiber client.
887
931
  * @param workflowId Backend path identifier `workflow_id`.
888
932
  * @param data Typed JSON request body.
889
933
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
890
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
891
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: workflow_node:create.
934
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
935
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of workflow_node:create.
892
936
  */
893
937
  apiCreateWorkflowNodeRoutePostApiV1WorkflowsWorkflowIdNodes(workflowId, data, options) {
894
938
  return this.client.request({ ...options, method: "POST", url: `/api/v1/workflows/${encodeURIComponent(workflowId)}/nodes`, data: data });
895
939
  }
896
940
  /**
897
- * Performs the delete workflow node route operation for the api capability.
941
+ * Soft-delete a node scoped to its checked workspace parent; return {id,deleted:true}; missing parent or node returns 404.
898
942
  * Calls `DELETE /api/v1/workflows/{workflow_id}/nodes/{node_id}` through the shared IDP-aware Faiber client.
899
943
  * @param workflowId Backend path identifier `workflow_id`.
900
944
  * @param nodeId Backend path identifier `node_id`.
901
945
  * @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: workflow_node:delete.
946
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
947
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of workflow_node:delete.
904
948
  */
905
949
  apiDeleteWorkflowNodeRouteDelete(workflowId, nodeId, options) {
906
950
  return this.client.request({ ...options, method: "DELETE", url: `/api/v1/workflows/${encodeURIComponent(workflowId)}/nodes/${encodeURIComponent(nodeId)}` });
907
951
  }
908
952
  /**
909
- * Performs the show workflow node route operation for the api capability.
953
+ * Read a nondeleted node scoped to a nondeleted workspace parent workflow; missing parent or node returns 404.
910
954
  * Calls `GET /api/v1/workflows/{workflow_id}/nodes/{node_id}` through the shared IDP-aware Faiber client.
911
955
  * @param workflowId Backend path identifier `workflow_id`.
912
956
  * @param nodeId Backend path identifier `node_id`.
913
957
  * @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: workflow_node:read, workflow_node:read_all, workflow_node:read_own.
958
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
959
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of workflow_node:read, workflow_node:read_all, workflow_node:read_own.
916
960
  */
917
961
  apiShowWorkflowNodeRouteGet(workflowId, nodeId, options) {
918
962
  return this.client.request({ ...options, method: "GET", url: `/api/v1/workflows/${encodeURIComponent(workflowId)}/nodes/${encodeURIComponent(nodeId)}` });
919
963
  }
920
964
  /**
921
- * Performs the update workflow node route operation for the api capability.
965
+ * Patch a node within its checked workspace parent; explicit null clears sla_minutes/actions and ordinary optional nulls preserve fields. Validate probability, stage type, name/slug and SLA. No version parameter is enforced.
922
966
  * Calls `PATCH /api/v1/workflows/{workflow_id}/nodes/{node_id}` through the shared IDP-aware Faiber client.
923
967
  * @param workflowId Backend path identifier `workflow_id`.
924
968
  * @param nodeId Backend path identifier `node_id`.
925
969
  * @param data Typed JSON request body.
926
970
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
927
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
928
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: workflow_node:update.
971
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
972
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of workflow_node:update.
929
973
  */
930
974
  apiUpdateWorkflowNodeRoutePatch(workflowId, nodeId, data, options) {
931
975
  return this.client.request({ ...options, method: "PATCH", url: `/api/v1/workflows/${encodeURIComponent(workflowId)}/nodes/${encodeURIComponent(nodeId)}`, data: data });
932
976
  }
933
977
  /**
934
- * Performs the member workflows operation for the api capability.
978
+ * List nondeleted workflows assigned to the caller directly or through legacy/current team membership, ordered by priority; includes inactive entries.
935
979
  * Calls `GET /api/v1/workflows/member-based` through the shared IDP-aware Faiber client.
936
980
  * @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: crm:pipeline:read, workflow:read, workflow:read_own.
981
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
982
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of crm:pipeline:read, workflow:read, workflow:read_own.
939
983
  */
940
984
  apiMemberWorkflowsGet(options) {
941
985
  return this.client.request({ ...options, method: "GET", url: `/api/v1/workflows/member-based` });
942
986
  }
943
987
  /**
944
- * Performs the worklogs operation for the api capability.
988
+ * List nondeleted legacy worklogs; restrict assignee_id to caller unless worklog:read_all or crm:admin. Comma-separated entity sort columns support - prefix; no workspace predicate exists in repository.
945
989
  * Calls `GET /api/v1/worklog` through the shared IDP-aware Faiber client.
946
990
  * @param params Typed query parameters; omitted members retain backend defaults.
947
991
  * @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: worklog:read, worklog:read_all, worklog:read_own.
992
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
993
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of worklog:read, worklog:read_all, worklog:read_own.
950
994
  */
951
995
  apiWorklogsGet(params, options) {
952
996
  return this.client.request({ ...options, method: "GET", url: `/api/v1/worklog`, params });
953
997
  }
954
998
  /**
955
- * Performs the update workspace operation for the api capability.
999
+ * Patch workspace settings with required version. AI mode must be off/advisory/approval_required/bounded_auto; ordinary optional nulls preserve values. Missing workspace returns 404; stale version 409. Requires a nonempty Idempotency-Key header up to 128 characters; duplicate submissions return 409 instead of replaying a response.
956
1000
  * Calls `PATCH /api/v1/workspace/settings` through the shared IDP-aware Faiber client.
957
1001
  * @param data Typed JSON request body.
958
1002
  * @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: crm:settings:update.
1003
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
1004
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of crm:settings:update.
961
1005
  */
962
1006
  apiUpdateWorkspacePatch(data, options) {
963
1007
  return this.client.request({ ...options, method: "PATCH", url: `/api/v1/workspace/settings`, data: data });
964
1008
  }
965
1009
  /**
966
- * Performs the status route operation for the router capability.
1010
+ * Read process liveness and package version in the legacy status/message/data envelope; no dependency probe.
967
1011
  * Calls `GET /health` through the shared IDP-aware Faiber client.
968
1012
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
969
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
970
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
1013
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
1014
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: No local handler permission check; deployment/gateway authority must be independently verified.
971
1015
  */
972
1016
  routerStatusRouteGetHealth(options) {
973
1017
  return this.client.request({ ...options, method: "GET", url: `/health` });
974
1018
  }
975
1019
  /**
976
- * Performs the status route operation for the router capability.
1020
+ * Read process liveness and package version in the legacy status/message/data envelope; no dependency probe.
977
1021
  * Calls `GET /livez` through the shared IDP-aware Faiber client.
978
1022
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
979
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
980
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
1023
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
1024
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: No local handler permission check; deployment/gateway authority must be independently verified.
981
1025
  */
982
1026
  routerStatusRouteGetLivez(options) {
983
1027
  return this.client.request({ ...options, method: "GET", url: `/livez` });
984
1028
  }
985
1029
  /**
986
- * Performs the readiness route operation for the router capability.
1030
+ * Probe database and broker readiness; return legacy status/message/data with dependency booleans and HTTP 503 if either dependency is unavailable.
987
1031
  * Calls `GET /readyz` through the shared IDP-aware Faiber client.
988
1032
  * @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: 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: No local handler permission check; deployment/gateway authority must be independently verified.
991
1035
  */
992
1036
  routerReadinessRouteGet(options) {
993
1037
  return this.client.request({ ...options, method: "GET", url: `/readyz` });
994
1038
  }
995
1039
  /**
996
- * Performs the status route operation for the router capability.
1040
+ * Read process liveness and package version in the legacy status/message/data envelope; no dependency probe.
997
1041
  * Calls `GET /up` through the shared IDP-aware Faiber client.
998
1042
  * @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
999
- * @returns The complete Axios response, including the typed service envelope, status, and headers.
1000
- * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
1043
+ * @returns The complete Axios response, including the typed handler payload, status, and headers.
1044
+ * @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: No local handler permission check; deployment/gateway authority must be independently verified.
1001
1045
  */
1002
1046
  routerStatusRouteGetUp(options) {
1003
1047
  return this.client.request({ ...options, method: "GET", url: `/up` });