@faiber/faiber-crm 0.10.2 → 0.11.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +23 -7
- package/dist/.tsbuildinfo +1 -1
- package/dist/index.d.ts +35 -0
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +35 -0
- package/dist/index.js.map +1 -1
- package/dist/operations.d.ts +207 -44
- package/dist/operations.d.ts.map +1 -1
- package/dist/operations.js +243 -44
- package/dist/operations.js.map +1 -1
- package/dist/operations.types.d.ts +322 -0
- package/dist/operations.types.d.ts.map +1 -1
- package/dist/types.d.ts +12 -0
- package/dist/types.d.ts.map +1 -1
- package/package.json +2 -2
package/dist/operations.js
CHANGED
|
@@ -16,7 +16,7 @@ export class CrmOperations extends ServiceApi {
|
|
|
16
16
|
* @param params Typed query parameters; omitted members retain backend defaults.
|
|
17
17
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
18
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:
|
|
19
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:activity:read.
|
|
20
20
|
*/
|
|
21
21
|
apiActivitiesGet(params, options) {
|
|
22
22
|
return this.client.request({ ...options, method: "GET", url: `/api/v1/activities`, params });
|
|
@@ -27,18 +27,29 @@ export class CrmOperations extends ServiceApi {
|
|
|
27
27
|
* @param data Typed JSON request body.
|
|
28
28
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
29
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:
|
|
30
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:activity:create.
|
|
31
31
|
*/
|
|
32
32
|
apiCreateActivityPost(data, options) {
|
|
33
33
|
return this.client.request({ ...options, method: "POST", url: `/api/v1/activities`, data: data });
|
|
34
34
|
}
|
|
35
|
+
/**
|
|
36
|
+
* Performs the create activity with reminder operation for the api capability.
|
|
37
|
+
* Calls `POST /api/v1/activities/with-reminder` through the shared IDP-aware Faiber client.
|
|
38
|
+
* @param data Typed JSON request body.
|
|
39
|
+
* @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.
|
|
42
|
+
*/
|
|
43
|
+
apiCreateActivityWithReminderPost(data, options) {
|
|
44
|
+
return this.client.request({ ...options, method: "POST", url: `/api/v1/activities/with-reminder`, data: data });
|
|
45
|
+
}
|
|
35
46
|
/**
|
|
36
47
|
* Performs the automation jobs operation for the api capability.
|
|
37
48
|
* Calls `GET /api/v1/automation/jobs` through the shared IDP-aware Faiber client.
|
|
38
49
|
* @param params Typed query parameters; omitted members retain backend defaults.
|
|
39
50
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
40
51
|
* @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:
|
|
52
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:automation:read.
|
|
42
53
|
*/
|
|
43
54
|
apiAutomationJobsGet(params, options) {
|
|
44
55
|
return this.client.request({ ...options, method: "GET", url: `/api/v1/automation/jobs`, params });
|
|
@@ -48,7 +59,7 @@ export class CrmOperations extends ServiceApi {
|
|
|
48
59
|
* Calls `GET /api/v1/automation/webhooks` through the shared IDP-aware Faiber client.
|
|
49
60
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
50
61
|
* @returns The complete Axios response, including the typed service envelope, status, and headers.
|
|
51
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission:
|
|
62
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:automation:read.
|
|
52
63
|
*/
|
|
53
64
|
apiAutomationWebhooksGet(options) {
|
|
54
65
|
return this.client.request({ ...options, method: "GET", url: `/api/v1/automation/webhooks` });
|
|
@@ -60,7 +71,7 @@ export class CrmOperations extends ServiceApi {
|
|
|
60
71
|
* @param pipelineId Backend path identifier `pipeline_id`.
|
|
61
72
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
62
73
|
* @returns The complete Axios response, including the typed service envelope, status, and headers.
|
|
63
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission:
|
|
74
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:board:read.
|
|
64
75
|
*/
|
|
65
76
|
apiBoardGet(entityType, pipelineId, options) {
|
|
66
77
|
return this.client.request({ ...options, method: "GET", url: `/api/v1/boards/${encodeURIComponent(entityType)}/${encodeURIComponent(pipelineId)}` });
|
|
@@ -70,7 +81,7 @@ export class CrmOperations extends ServiceApi {
|
|
|
70
81
|
* Calls `GET /api/v1/campaigns` through the shared IDP-aware Faiber client.
|
|
71
82
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
72
83
|
* @returns The complete Axios response, including the typed service envelope, status, and headers.
|
|
73
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission:
|
|
84
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:marketing:read.
|
|
74
85
|
*/
|
|
75
86
|
apiCampaignsGet(options) {
|
|
76
87
|
return this.client.request({ ...options, method: "GET", url: `/api/v1/campaigns` });
|
|
@@ -81,7 +92,7 @@ export class CrmOperations extends ServiceApi {
|
|
|
81
92
|
* @param data Typed JSON request body.
|
|
82
93
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
83
94
|
* @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:
|
|
95
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:marketing:manage.
|
|
85
96
|
*/
|
|
86
97
|
apiCreateCampaignPost(data, options) {
|
|
87
98
|
return this.client.request({ ...options, method: "POST", url: `/api/v1/campaigns`, data: data });
|
|
@@ -92,7 +103,7 @@ export class CrmOperations extends ServiceApi {
|
|
|
92
103
|
* @param params Typed query parameters; omitted members retain backend defaults.
|
|
93
104
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
94
105
|
* @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:
|
|
106
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:company:read, crm:company:read_all.
|
|
96
107
|
*/
|
|
97
108
|
apiCompaniesGet(params, options) {
|
|
98
109
|
return this.client.request({ ...options, method: "GET", url: `/api/v1/companies`, params });
|
|
@@ -103,7 +114,7 @@ export class CrmOperations extends ServiceApi {
|
|
|
103
114
|
* @param data Typed JSON request body.
|
|
104
115
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
105
116
|
* @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:
|
|
117
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:company:create.
|
|
107
118
|
*/
|
|
108
119
|
apiCreateCompanyPost(data, options) {
|
|
109
120
|
return this.client.request({ ...options, method: "POST", url: `/api/v1/companies`, data: data });
|
|
@@ -114,7 +125,7 @@ export class CrmOperations extends ServiceApi {
|
|
|
114
125
|
* @param id Backend path identifier `id`.
|
|
115
126
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
116
127
|
* @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:
|
|
128
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:company:read, crm:company:read_all.
|
|
118
129
|
*/
|
|
119
130
|
apiCompanyGet(id, options) {
|
|
120
131
|
return this.client.request({ ...options, method: "GET", url: `/api/v1/companies/${encodeURIComponent(id)}` });
|
|
@@ -126,7 +137,7 @@ export class CrmOperations extends ServiceApi {
|
|
|
126
137
|
* @param data Typed JSON request body.
|
|
127
138
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
128
139
|
* @returns The complete Axios response, including the typed service envelope, status, and headers.
|
|
129
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission:
|
|
140
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:company:update.
|
|
130
141
|
*/
|
|
131
142
|
apiUpdateCompanyPatch(id, data, options) {
|
|
132
143
|
return this.client.request({ ...options, method: "PATCH", url: `/api/v1/companies/${encodeURIComponent(id)}`, data: data });
|
|
@@ -137,7 +148,7 @@ export class CrmOperations extends ServiceApi {
|
|
|
137
148
|
* @param params Typed query parameters; omitted members retain backend defaults.
|
|
138
149
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
139
150
|
* @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:
|
|
151
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:contact:read, crm:contact:read_all.
|
|
141
152
|
*/
|
|
142
153
|
apiContactsGet(params, options) {
|
|
143
154
|
return this.client.request({ ...options, method: "GET", url: `/api/v1/contacts`, params });
|
|
@@ -148,7 +159,7 @@ export class CrmOperations extends ServiceApi {
|
|
|
148
159
|
* @param data Typed JSON request body.
|
|
149
160
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
150
161
|
* @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:
|
|
162
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:contact:create.
|
|
152
163
|
*/
|
|
153
164
|
apiCreateContactPost(data, options) {
|
|
154
165
|
return this.client.request({ ...options, method: "POST", url: `/api/v1/contacts`, data: data });
|
|
@@ -159,7 +170,7 @@ export class CrmOperations extends ServiceApi {
|
|
|
159
170
|
* @param id Backend path identifier `id`.
|
|
160
171
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
161
172
|
* @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:
|
|
173
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:contact:read, crm:contact:read_all.
|
|
163
174
|
*/
|
|
164
175
|
apiContactGet(id, options) {
|
|
165
176
|
return this.client.request({ ...options, method: "GET", url: `/api/v1/contacts/${encodeURIComponent(id)}` });
|
|
@@ -171,7 +182,7 @@ export class CrmOperations extends ServiceApi {
|
|
|
171
182
|
* @param data Typed JSON request body.
|
|
172
183
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
173
184
|
* @returns The complete Axios response, including the typed service envelope, status, and headers.
|
|
174
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission:
|
|
185
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:contact:update.
|
|
175
186
|
*/
|
|
176
187
|
apiUpdateContactPatch(id, data, options) {
|
|
177
188
|
return this.client.request({ ...options, method: "PATCH", url: `/api/v1/contacts/${encodeURIComponent(id)}`, data: data });
|
|
@@ -181,7 +192,7 @@ export class CrmOperations extends ServiceApi {
|
|
|
181
192
|
* Calls `GET /api/v1/context` through the shared IDP-aware Faiber client.
|
|
182
193
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
183
194
|
* @returns The complete Axios response, including the typed service envelope, status, and headers.
|
|
184
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission:
|
|
195
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:workspace:read.
|
|
185
196
|
*/
|
|
186
197
|
apiContextGet(options) {
|
|
187
198
|
return this.client.request({ ...options, method: "GET", url: `/api/v1/context` });
|
|
@@ -192,7 +203,7 @@ export class CrmOperations extends ServiceApi {
|
|
|
192
203
|
* @param params Typed query parameters; omitted members retain backend defaults.
|
|
193
204
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
194
205
|
* @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:
|
|
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.
|
|
196
207
|
*/
|
|
197
208
|
apiDealsGet(params, options) {
|
|
198
209
|
return this.client.request({ ...options, method: "GET", url: `/api/v1/deals`, params });
|
|
@@ -203,7 +214,7 @@ export class CrmOperations extends ServiceApi {
|
|
|
203
214
|
* @param data Typed JSON request body.
|
|
204
215
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
205
216
|
* @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:
|
|
217
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:deal:create.
|
|
207
218
|
*/
|
|
208
219
|
apiCreateDealPost(data, options) {
|
|
209
220
|
return this.client.request({ ...options, method: "POST", url: `/api/v1/deals`, data: data });
|
|
@@ -214,7 +225,7 @@ export class CrmOperations extends ServiceApi {
|
|
|
214
225
|
* @param id Backend path identifier `id`.
|
|
215
226
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
216
227
|
* @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:
|
|
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.
|
|
218
229
|
*/
|
|
219
230
|
apiDealGet(id, options) {
|
|
220
231
|
return this.client.request({ ...options, method: "GET", url: `/api/v1/deals/${encodeURIComponent(id)}` });
|
|
@@ -226,7 +237,7 @@ export class CrmOperations extends ServiceApi {
|
|
|
226
237
|
* @param data Typed JSON request body.
|
|
227
238
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
228
239
|
* @returns The complete Axios response, including the typed service envelope, status, and headers.
|
|
229
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission:
|
|
240
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:deal:update.
|
|
230
241
|
*/
|
|
231
242
|
apiUpdateDealPatch(id, data, options) {
|
|
232
243
|
return this.client.request({ ...options, method: "PATCH", url: `/api/v1/deals/${encodeURIComponent(id)}`, data: data });
|
|
@@ -238,7 +249,7 @@ export class CrmOperations extends ServiceApi {
|
|
|
238
249
|
* @param data Typed JSON request body.
|
|
239
250
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
240
251
|
* @returns The complete Axios response, including the typed service envelope, status, and headers.
|
|
241
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission:
|
|
252
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:deal:assign.
|
|
242
253
|
*/
|
|
243
254
|
apiAssignDealPatch(id, data, options) {
|
|
244
255
|
return this.client.request({ ...options, method: "PATCH", url: `/api/v1/deals/${encodeURIComponent(id)}/assignment`, data: data });
|
|
@@ -250,18 +261,29 @@ export class CrmOperations extends ServiceApi {
|
|
|
250
261
|
* @param data Typed JSON request body.
|
|
251
262
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
252
263
|
* @returns The complete Axios response, including the typed service envelope, status, and headers.
|
|
253
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission:
|
|
264
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:deal:move.
|
|
254
265
|
*/
|
|
255
266
|
apiMoveDealStagePatch(id, data, options) {
|
|
256
267
|
return this.client.request({ ...options, method: "PATCH", url: `/api/v1/deals/${encodeURIComponent(id)}/stage`, data: data });
|
|
257
268
|
}
|
|
269
|
+
/**
|
|
270
|
+
* Performs the find office lead operation for the api capability.
|
|
271
|
+
* Calls `GET /api/v1/integration/office/leads/find` through the shared IDP-aware Faiber client.
|
|
272
|
+
* @param params Typed query parameters; omitted members retain backend defaults.
|
|
273
|
+
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
274
|
+
* @returns The complete Axios response, including the typed service envelope, status, and headers.
|
|
275
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: session-derived or public bootstrap route.
|
|
276
|
+
*/
|
|
277
|
+
apiFindOfficeLeadGet(params, options) {
|
|
278
|
+
return this.client.request({ ...options, method: "GET", url: `/api/v1/integration/office/leads/find`, params });
|
|
279
|
+
}
|
|
258
280
|
/**
|
|
259
281
|
* Performs the leads operation for the api capability.
|
|
260
282
|
* Calls `GET /api/v1/leads` through the shared IDP-aware Faiber client.
|
|
261
283
|
* @param params Typed query parameters; omitted members retain backend defaults.
|
|
262
284
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
263
285
|
* @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:
|
|
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.
|
|
265
287
|
*/
|
|
266
288
|
apiLeadsGet(params, options) {
|
|
267
289
|
return this.client.request({ ...options, method: "GET", url: `/api/v1/leads`, params });
|
|
@@ -272,7 +294,7 @@ export class CrmOperations extends ServiceApi {
|
|
|
272
294
|
* @param data Typed JSON request body.
|
|
273
295
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
274
296
|
* @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:
|
|
297
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:lead:create.
|
|
276
298
|
*/
|
|
277
299
|
apiCreateLeadPost(data, options) {
|
|
278
300
|
return this.client.request({ ...options, method: "POST", url: `/api/v1/leads`, data: data });
|
|
@@ -283,7 +305,7 @@ export class CrmOperations extends ServiceApi {
|
|
|
283
305
|
* @param id Backend path identifier `id`.
|
|
284
306
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
285
307
|
* @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:
|
|
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.
|
|
287
309
|
*/
|
|
288
310
|
apiLeadGet(id, options) {
|
|
289
311
|
return this.client.request({ ...options, method: "GET", url: `/api/v1/leads/${encodeURIComponent(id)}` });
|
|
@@ -295,7 +317,7 @@ export class CrmOperations extends ServiceApi {
|
|
|
295
317
|
* @param data Typed JSON request body.
|
|
296
318
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
297
319
|
* @returns The complete Axios response, including the typed service envelope, status, and headers.
|
|
298
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission:
|
|
320
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:lead:update.
|
|
299
321
|
*/
|
|
300
322
|
apiUpdateLeadPatch(id, data, options) {
|
|
301
323
|
return this.client.request({ ...options, method: "PATCH", url: `/api/v1/leads/${encodeURIComponent(id)}`, data: data });
|
|
@@ -307,11 +329,55 @@ export class CrmOperations extends ServiceApi {
|
|
|
307
329
|
* @param data Typed JSON request body.
|
|
308
330
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
309
331
|
* @returns The complete Axios response, including the typed service envelope, status, and headers.
|
|
310
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission:
|
|
332
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:lead:assign.
|
|
311
333
|
*/
|
|
312
334
|
apiAssignLeadPatch(id, data, options) {
|
|
313
335
|
return this.client.request({ ...options, method: "PATCH", url: `/api/v1/leads/${encodeURIComponent(id)}/assignment`, data: data });
|
|
314
336
|
}
|
|
337
|
+
/**
|
|
338
|
+
* Performs the lead history operation for the api capability.
|
|
339
|
+
* Calls `GET /api/v1/leads/{id}/history` through the shared IDP-aware Faiber client.
|
|
340
|
+
* @param id Backend path identifier `id`.
|
|
341
|
+
* @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.
|
|
344
|
+
*/
|
|
345
|
+
apiLeadHistoryGet(id, options) {
|
|
346
|
+
return this.client.request({ ...options, method: "GET", url: `/api/v1/leads/${encodeURIComponent(id)}/history` });
|
|
347
|
+
}
|
|
348
|
+
/**
|
|
349
|
+
* Performs the delete lead reminders operation for the api capability.
|
|
350
|
+
* Calls `DELETE /api/v1/leads/{id}/reminders` through the shared IDP-aware Faiber client.
|
|
351
|
+
* @param id Backend path identifier `id`.
|
|
352
|
+
* @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.
|
|
355
|
+
*/
|
|
356
|
+
apiDeleteLeadRemindersDelete(id, options) {
|
|
357
|
+
return this.client.request({ ...options, method: "DELETE", url: `/api/v1/leads/${encodeURIComponent(id)}/reminders` });
|
|
358
|
+
}
|
|
359
|
+
/**
|
|
360
|
+
* Performs the remove lead from sos operation for the api capability.
|
|
361
|
+
* Calls `DELETE /api/v1/leads/{id}/sos` through the shared IDP-aware Faiber client.
|
|
362
|
+
* @param id Backend path identifier `id`.
|
|
363
|
+
* @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.
|
|
366
|
+
*/
|
|
367
|
+
apiRemoveLeadFromSosDelete(id, options) {
|
|
368
|
+
return this.client.request({ ...options, method: "DELETE", url: `/api/v1/leads/${encodeURIComponent(id)}/sos` });
|
|
369
|
+
}
|
|
370
|
+
/**
|
|
371
|
+
* Performs the add lead to sos operation for the api capability.
|
|
372
|
+
* Calls `POST /api/v1/leads/{id}/sos` through the shared IDP-aware Faiber client.
|
|
373
|
+
* @param id Backend path identifier `id`.
|
|
374
|
+
* @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.
|
|
377
|
+
*/
|
|
378
|
+
apiAddLeadToSosPost(id, options) {
|
|
379
|
+
return this.client.request({ ...options, method: "POST", url: `/api/v1/leads/${encodeURIComponent(id)}/sos` });
|
|
380
|
+
}
|
|
315
381
|
/**
|
|
316
382
|
* Performs the move lead stage operation for the api capability.
|
|
317
383
|
* Calls `PATCH /api/v1/leads/{id}/stage` through the shared IDP-aware Faiber client.
|
|
@@ -319,28 +385,51 @@ export class CrmOperations extends ServiceApi {
|
|
|
319
385
|
* @param data Typed JSON request body.
|
|
320
386
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
321
387
|
* @returns The complete Axios response, including the typed service envelope, status, and headers.
|
|
322
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission:
|
|
388
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:lead:move.
|
|
323
389
|
*/
|
|
324
390
|
apiMoveLeadStagePatch(id, data, options) {
|
|
325
391
|
return this.client.request({ ...options, method: "PATCH", url: `/api/v1/leads/${encodeURIComponent(id)}/stage`, data: data });
|
|
326
392
|
}
|
|
393
|
+
/**
|
|
394
|
+
* Performs the light leads operation for the api capability.
|
|
395
|
+
* Calls `GET /api/v1/leads/light` through the shared IDP-aware Faiber client.
|
|
396
|
+
* @param params Typed query parameters; omitted members retain backend defaults.
|
|
397
|
+
* @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.
|
|
400
|
+
*/
|
|
401
|
+
apiLightLeadsGet(params, options) {
|
|
402
|
+
return this.client.request({ ...options, method: "GET", url: `/api/v1/leads/light`, params });
|
|
403
|
+
}
|
|
327
404
|
/**
|
|
328
405
|
* Performs the pipelines operation for the api capability.
|
|
329
406
|
* Calls `GET /api/v1/pipelines` through the shared IDP-aware Faiber client.
|
|
330
407
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
331
408
|
* @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:
|
|
409
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:pipeline:read.
|
|
333
410
|
*/
|
|
334
411
|
apiPipelinesGet(options) {
|
|
335
412
|
return this.client.request({ ...options, method: "GET", url: `/api/v1/pipelines` });
|
|
336
413
|
}
|
|
414
|
+
/**
|
|
415
|
+
* Performs the update pipeline operation for the api capability.
|
|
416
|
+
* Calls `PATCH /api/v1/pipelines/{id}` through the shared IDP-aware Faiber client.
|
|
417
|
+
* @param id Backend path identifier `id`.
|
|
418
|
+
* @param data Typed JSON request body.
|
|
419
|
+
* @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.
|
|
422
|
+
*/
|
|
423
|
+
apiUpdatePipelinePatch(id, data, options) {
|
|
424
|
+
return this.client.request({ ...options, method: "PATCH", url: `/api/v1/pipelines/${encodeURIComponent(id)}`, data: data });
|
|
425
|
+
}
|
|
337
426
|
/**
|
|
338
427
|
* Performs the report run operation for the api capability.
|
|
339
428
|
* Calls `GET /api/v1/reports/{id}` through the shared IDP-aware Faiber client.
|
|
340
429
|
* @param id Backend path identifier `id`.
|
|
341
430
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
342
431
|
* @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:
|
|
432
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:report:read.
|
|
344
433
|
*/
|
|
345
434
|
apiReportRunGet(id, options) {
|
|
346
435
|
return this.client.request({ ...options, method: "GET", url: `/api/v1/reports/${encodeURIComponent(id)}` });
|
|
@@ -351,7 +440,7 @@ export class CrmOperations extends ServiceApi {
|
|
|
351
440
|
* @param id Backend path identifier `id`.
|
|
352
441
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
353
442
|
* @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:
|
|
443
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:agent:run.
|
|
355
444
|
*/
|
|
356
445
|
apiRequestAgenticInsightPost(id, options) {
|
|
357
446
|
return this.client.request({ ...options, method: "POST", url: `/api/v1/reports/${encodeURIComponent(id)}/agentic` });
|
|
@@ -361,7 +450,7 @@ export class CrmOperations extends ServiceApi {
|
|
|
361
450
|
* Calls `GET /api/v1/reports/catalog` through the shared IDP-aware Faiber client.
|
|
362
451
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
363
452
|
* @returns The complete Axios response, including the typed service envelope, status, and headers.
|
|
364
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission:
|
|
453
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:report:read.
|
|
365
454
|
*/
|
|
366
455
|
apiReportCatalogGet(options) {
|
|
367
456
|
return this.client.request({ ...options, method: "GET", url: `/api/v1/reports/catalog` });
|
|
@@ -372,7 +461,7 @@ export class CrmOperations extends ServiceApi {
|
|
|
372
461
|
* @param params Typed query parameters; omitted members retain backend defaults.
|
|
373
462
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
374
463
|
* @returns The complete Axios response, including the typed service envelope, status, and headers.
|
|
375
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission:
|
|
464
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:report:read.
|
|
376
465
|
*/
|
|
377
466
|
apiOverviewGet(params, options) {
|
|
378
467
|
return this.client.request({ ...options, method: "GET", url: `/api/v1/reports/overview`, params });
|
|
@@ -383,17 +472,27 @@ export class CrmOperations extends ServiceApi {
|
|
|
383
472
|
* @param params Typed query parameters; omitted members retain backend defaults.
|
|
384
473
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
385
474
|
* @returns The complete Axios response, including the typed service envelope, status, and headers.
|
|
386
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission:
|
|
475
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:report:refresh.
|
|
387
476
|
*/
|
|
388
477
|
apiRefreshReportsPost(params, options) {
|
|
389
478
|
return this.client.request({ ...options, method: "POST", url: `/api/v1/reports/refresh`, params });
|
|
390
479
|
}
|
|
480
|
+
/**
|
|
481
|
+
* Performs the list sos leads operation for the api capability.
|
|
482
|
+
* Calls `GET /api/v1/sos` through the shared IDP-aware Faiber client.
|
|
483
|
+
* @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.
|
|
486
|
+
*/
|
|
487
|
+
apiListSosLeadsGet(options) {
|
|
488
|
+
return this.client.request({ ...options, method: "GET", url: `/api/v1/sos` });
|
|
489
|
+
}
|
|
391
490
|
/**
|
|
392
491
|
* Performs the sources operation for the api capability.
|
|
393
492
|
* Calls `GET /api/v1/sources` through the shared IDP-aware Faiber client.
|
|
394
493
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
395
494
|
* @returns The complete Axios response, including the typed service envelope, status, and headers.
|
|
396
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission:
|
|
495
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:marketing:read.
|
|
397
496
|
*/
|
|
398
497
|
apiSourcesGet(options) {
|
|
399
498
|
return this.client.request({ ...options, method: "GET", url: `/api/v1/sources` });
|
|
@@ -404,18 +503,38 @@ export class CrmOperations extends ServiceApi {
|
|
|
404
503
|
* @param data Typed JSON request body.
|
|
405
504
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
406
505
|
* @returns The complete Axios response, including the typed service envelope, status, and headers.
|
|
407
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission:
|
|
506
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:marketing:manage.
|
|
408
507
|
*/
|
|
409
508
|
apiCreateSourcePost(data, options) {
|
|
410
509
|
return this.client.request({ ...options, method: "POST", url: `/api/v1/sources`, data: data });
|
|
411
510
|
}
|
|
511
|
+
/**
|
|
512
|
+
* Performs the daily stats operation for the api capability.
|
|
513
|
+
* Calls `GET /api/v1/stats/daily` through the shared IDP-aware Faiber client.
|
|
514
|
+
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
515
|
+
* @returns The complete Axios response, including the typed service envelope, status, and headers.
|
|
516
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:stats:read, crm:stats:read_own.
|
|
517
|
+
*/
|
|
518
|
+
apiDailyStatsGet(options) {
|
|
519
|
+
return this.client.request({ ...options, method: "GET", url: `/api/v1/stats/daily` });
|
|
520
|
+
}
|
|
521
|
+
/**
|
|
522
|
+
* Performs the lead stats operation for the api capability.
|
|
523
|
+
* Calls `GET /api/v1/stats/lead` through the shared IDP-aware Faiber client.
|
|
524
|
+
* @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.
|
|
527
|
+
*/
|
|
528
|
+
apiLeadStatsGet(options) {
|
|
529
|
+
return this.client.request({ ...options, method: "GET", url: `/api/v1/stats/lead` });
|
|
530
|
+
}
|
|
412
531
|
/**
|
|
413
532
|
* Performs the tasks operation for the api capability.
|
|
414
533
|
* Calls `GET /api/v1/tasks` through the shared IDP-aware Faiber client.
|
|
415
534
|
* @param params Typed query parameters; omitted members retain backend defaults.
|
|
416
535
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
417
536
|
* @returns The complete Axios response, including the typed service envelope, status, and headers.
|
|
418
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission:
|
|
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.
|
|
419
538
|
*/
|
|
420
539
|
apiTasksGet(params, options) {
|
|
421
540
|
return this.client.request({ ...options, method: "GET", url: `/api/v1/tasks`, params });
|
|
@@ -426,11 +545,22 @@ export class CrmOperations extends ServiceApi {
|
|
|
426
545
|
* @param data Typed JSON request body.
|
|
427
546
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
428
547
|
* @returns The complete Axios response, including the typed service envelope, status, and headers.
|
|
429
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission:
|
|
548
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:task:create.
|
|
430
549
|
*/
|
|
431
550
|
apiCreateTaskPost(data, options) {
|
|
432
551
|
return this.client.request({ ...options, method: "POST", url: `/api/v1/tasks`, data: data });
|
|
433
552
|
}
|
|
553
|
+
/**
|
|
554
|
+
* Performs the delete task operation for the api capability.
|
|
555
|
+
* Calls `DELETE /api/v1/tasks/{id}` through the shared IDP-aware Faiber client.
|
|
556
|
+
* @param id Backend path identifier `id`.
|
|
557
|
+
* @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.
|
|
560
|
+
*/
|
|
561
|
+
apiDeleteTaskDelete(id, options) {
|
|
562
|
+
return this.client.request({ ...options, method: "DELETE", url: `/api/v1/tasks/${encodeURIComponent(id)}` });
|
|
563
|
+
}
|
|
434
564
|
/**
|
|
435
565
|
* Performs the update task status operation for the api capability.
|
|
436
566
|
* Calls `PATCH /api/v1/tasks/{id}/status` through the shared IDP-aware Faiber client.
|
|
@@ -438,7 +568,7 @@ export class CrmOperations extends ServiceApi {
|
|
|
438
568
|
* @param data Typed JSON request body.
|
|
439
569
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
440
570
|
* @returns The complete Axios response, including the typed service envelope, status, and headers.
|
|
441
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission:
|
|
571
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:task:update.
|
|
442
572
|
*/
|
|
443
573
|
apiUpdateTaskStatusPatch(id, data, options) {
|
|
444
574
|
return this.client.request({ ...options, method: "PATCH", url: `/api/v1/tasks/${encodeURIComponent(id)}/status`, data: data });
|
|
@@ -448,7 +578,7 @@ export class CrmOperations extends ServiceApi {
|
|
|
448
578
|
* Calls `GET /api/v1/teams` through the shared IDP-aware Faiber client.
|
|
449
579
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
450
580
|
* @returns The complete Axios response, including the typed service envelope, status, and headers.
|
|
451
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission:
|
|
581
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:team:read.
|
|
452
582
|
*/
|
|
453
583
|
apiTeamsGet(options) {
|
|
454
584
|
return this.client.request({ ...options, method: "GET", url: `/api/v1/teams` });
|
|
@@ -459,18 +589,30 @@ export class CrmOperations extends ServiceApi {
|
|
|
459
589
|
* @param data Typed JSON request body.
|
|
460
590
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
461
591
|
* @returns The complete Axios response, including the typed service envelope, status, and headers.
|
|
462
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission:
|
|
592
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:team:create.
|
|
463
593
|
*/
|
|
464
594
|
apiCreateTeamPost(data, options) {
|
|
465
595
|
return this.client.request({ ...options, method: "POST", url: `/api/v1/teams`, data: data });
|
|
466
596
|
}
|
|
597
|
+
/**
|
|
598
|
+
* Performs the delete team operation for the api capability.
|
|
599
|
+
* Calls `DELETE /api/v1/teams/{id}` through the shared IDP-aware Faiber client.
|
|
600
|
+
* @param id Backend path identifier `id`.
|
|
601
|
+
* @param data Typed JSON request body.
|
|
602
|
+
* @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.
|
|
605
|
+
*/
|
|
606
|
+
apiDeleteTeamDelete(id, data, options) {
|
|
607
|
+
return this.client.request({ ...options, method: "DELETE", url: `/api/v1/teams/${encodeURIComponent(id)}`, data: data });
|
|
608
|
+
}
|
|
467
609
|
/**
|
|
468
610
|
* Performs the team operation for the api capability.
|
|
469
611
|
* Calls `GET /api/v1/teams/{id}` through the shared IDP-aware Faiber client.
|
|
470
612
|
* @param id Backend path identifier `id`.
|
|
471
613
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
472
614
|
* @returns The complete Axios response, including the typed service envelope, status, and headers.
|
|
473
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission:
|
|
615
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:team:read.
|
|
474
616
|
*/
|
|
475
617
|
apiTeamGet(id, options) {
|
|
476
618
|
return this.client.request({ ...options, method: "GET", url: `/api/v1/teams/${encodeURIComponent(id)}` });
|
|
@@ -482,18 +624,75 @@ export class CrmOperations extends ServiceApi {
|
|
|
482
624
|
* @param data Typed JSON request body.
|
|
483
625
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
484
626
|
* @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:
|
|
627
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:team:manage_members.
|
|
486
628
|
*/
|
|
487
629
|
apiAddTeamMemberPost(id, data, options) {
|
|
488
630
|
return this.client.request({ ...options, method: "POST", url: `/api/v1/teams/${encodeURIComponent(id)}/members`, data: data });
|
|
489
631
|
}
|
|
632
|
+
/**
|
|
633
|
+
* Performs the remove team member operation for the api capability.
|
|
634
|
+
* Calls `DELETE /api/v1/teams/{team_id}/members/{member_id}` through the shared IDP-aware Faiber client.
|
|
635
|
+
* @param teamId Backend path identifier `team_id`.
|
|
636
|
+
* @param memberId Backend path identifier `member_id`.
|
|
637
|
+
* @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.
|
|
640
|
+
*/
|
|
641
|
+
apiRemoveTeamMemberDelete(teamId, memberId, options) {
|
|
642
|
+
return this.client.request({ ...options, method: "DELETE", url: `/api/v1/teams/${encodeURIComponent(teamId)}/members/${encodeURIComponent(memberId)}` });
|
|
643
|
+
}
|
|
644
|
+
/**
|
|
645
|
+
* Performs the list workflow assignments operation for the api capability.
|
|
646
|
+
* Calls `GET /api/v1/workflows/{id}/assignments` through the shared IDP-aware Faiber client.
|
|
647
|
+
* @param id Backend path identifier `id`.
|
|
648
|
+
* @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: crm:workflow_assignment:read.
|
|
651
|
+
*/
|
|
652
|
+
apiListWorkflowAssignmentsGet(id, options) {
|
|
653
|
+
return this.client.request({ ...options, method: "GET", url: `/api/v1/workflows/${encodeURIComponent(id)}/assignments` });
|
|
654
|
+
}
|
|
655
|
+
/**
|
|
656
|
+
* Performs the create workflow assignment operation for the api capability.
|
|
657
|
+
* Calls `POST /api/v1/workflows/{id}/assignments` through the shared IDP-aware Faiber client.
|
|
658
|
+
* @param id Backend path identifier `id`.
|
|
659
|
+
* @param data Typed JSON request body.
|
|
660
|
+
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
661
|
+
* @returns The complete Axios response, including the typed service envelope, status, and headers.
|
|
662
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:workflow_assignment:manage.
|
|
663
|
+
*/
|
|
664
|
+
apiCreateWorkflowAssignmentPost(id, data, options) {
|
|
665
|
+
return this.client.request({ ...options, method: "POST", url: `/api/v1/workflows/${encodeURIComponent(id)}/assignments`, data: data });
|
|
666
|
+
}
|
|
667
|
+
/**
|
|
668
|
+
* Performs the delete workflow assignment operation for the api capability.
|
|
669
|
+
* Calls `DELETE /api/v1/workflows/{workflow_id}/assignments/{assignment_id}` through the shared IDP-aware Faiber client.
|
|
670
|
+
* @param workflowId Backend path identifier `workflow_id`.
|
|
671
|
+
* @param assignmentId Backend path identifier `assignment_id`.
|
|
672
|
+
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
673
|
+
* @returns The complete Axios response, including the typed service envelope, status, and headers.
|
|
674
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:workflow_assignment:manage.
|
|
675
|
+
*/
|
|
676
|
+
apiDeleteWorkflowAssignmentDelete(workflowId, assignmentId, options) {
|
|
677
|
+
return this.client.request({ ...options, method: "DELETE", url: `/api/v1/workflows/${encodeURIComponent(workflowId)}/assignments/${encodeURIComponent(assignmentId)}` });
|
|
678
|
+
}
|
|
679
|
+
/**
|
|
680
|
+
* Performs the member workflows operation for the api capability.
|
|
681
|
+
* Calls `GET /api/v1/workflows/member-based` through the shared IDP-aware Faiber client.
|
|
682
|
+
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
683
|
+
* @returns The complete Axios response, including the typed service envelope, status, and headers.
|
|
684
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:pipeline:read.
|
|
685
|
+
*/
|
|
686
|
+
apiMemberWorkflowsGet(options) {
|
|
687
|
+
return this.client.request({ ...options, method: "GET", url: `/api/v1/workflows/member-based` });
|
|
688
|
+
}
|
|
490
689
|
/**
|
|
491
690
|
* Performs the update workspace operation for the api capability.
|
|
492
691
|
* Calls `PATCH /api/v1/workspace/settings` through the shared IDP-aware Faiber client.
|
|
493
692
|
* @param data Typed JSON request body.
|
|
494
693
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
495
694
|
* @returns The complete Axios response, including the typed service envelope, status, and headers.
|
|
496
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission:
|
|
695
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:settings:update.
|
|
497
696
|
*/
|
|
498
697
|
apiUpdateWorkspacePatch(data, options) {
|
|
499
698
|
return this.client.request({ ...options, method: "PATCH", url: `/api/v1/workspace/settings`, data: data });
|