@faiber/faiber-crm 0.24.1 → 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +27 -29
- package/dist/.tsbuildinfo +1 -1
- package/dist/contracts.types.d.ts +201 -0
- package/dist/contracts.types.d.ts.map +1 -0
- package/dist/contracts.types.js +2 -0
- package/dist/contracts.types.js.map +1 -0
- package/dist/index.d.ts +80 -77
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +7 -4
- package/dist/index.js.map +1 -1
- package/dist/operations.d.ts +379 -360
- package/dist/operations.d.ts.map +1 -1
- package/dist/operations.js +314 -270
- package/dist/operations.js.map +1 -1
- package/dist/operations.types.d.ts +450 -900
- package/dist/operations.types.d.ts.map +1 -1
- package/dist/types.d.ts +136 -10
- package/dist/types.d.ts.map +1 -1
- package/package.json +4 -3
- package/provenance.json +27 -0
package/dist/operations.d.ts
CHANGED
|
@@ -2,826 +2,845 @@ import { ServiceApi, type Identifier, type RequestOptions } from "@faiber/sdk-co
|
|
|
2
2
|
import type * as T from "./operations.types.js";
|
|
3
3
|
export declare class CrmOperations extends ServiceApi {
|
|
4
4
|
/**
|
|
5
|
-
*
|
|
5
|
+
* Read process liveness and package version in the legacy status/message/data envelope; no dependency probe.
|
|
6
6
|
* Calls `GET /` through the shared IDP-aware Faiber client.
|
|
7
7
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
8
|
-
* @returns The complete Axios response, including the typed
|
|
9
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission:
|
|
8
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
9
|
+
* @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.
|
|
10
10
|
*/
|
|
11
|
-
routerStatusRouteGet(options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").
|
|
11
|
+
routerStatusRouteGet(options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").CrmHealthResponse, unknown, {}, any>>;
|
|
12
12
|
/**
|
|
13
|
-
*
|
|
13
|
+
* 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.
|
|
14
|
+
* Calls `ANY /api` through the shared IDP-aware Faiber client.
|
|
15
|
+
* @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.
|
|
16
|
+
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
17
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
18
|
+
* @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.
|
|
19
|
+
*/
|
|
20
|
+
routerApiNotFoundAny(method: import("@faiber/sdk-core").HttpRequestMethod, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiFallbackResponse, unknown, {}, any>>;
|
|
21
|
+
/**
|
|
22
|
+
* 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.
|
|
23
|
+
* Calls `ANY /api/{*path}` through the shared IDP-aware Faiber client.
|
|
24
|
+
* @param path Backend path identifier `*path`.
|
|
25
|
+
* @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.
|
|
26
|
+
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
27
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
28
|
+
* @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.
|
|
29
|
+
*/
|
|
30
|
+
routerApiPathNotFoundAny(path: string, method: import("@faiber/sdk-core").HttpRequestMethod, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiFallbackResponse, unknown, {}, any>>;
|
|
31
|
+
/**
|
|
32
|
+
* 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.
|
|
14
33
|
* Calls `GET /api/v1/activities` through the shared IDP-aware Faiber client.
|
|
15
34
|
* @param params Typed query parameters; omitted members retain backend defaults.
|
|
16
35
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
17
|
-
* @returns The complete Axios response, including the typed
|
|
18
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:activity:read.
|
|
36
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
37
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of crm:activity:read.
|
|
19
38
|
*/
|
|
20
|
-
apiActivitiesGet(params?: T.ApiActivitiesGetQuery, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").CrmActivityListResponse, unknown, {}>>;
|
|
39
|
+
apiActivitiesGet(params?: T.ApiActivitiesGetQuery, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").CrmActivityListResponse, unknown, {}, any>>;
|
|
21
40
|
/**
|
|
22
|
-
*
|
|
41
|
+
* 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.
|
|
23
42
|
* Calls `POST /api/v1/activities` through the shared IDP-aware Faiber client.
|
|
24
43
|
* @param data Typed JSON request body.
|
|
25
44
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
26
|
-
* @returns The complete Axios response, including the typed
|
|
27
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:activity:create.
|
|
45
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
46
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of crm:activity:create.
|
|
28
47
|
*/
|
|
29
|
-
apiCreateActivityPost(data: T.ApiCreateActivityPostInput, options?: RequestOptions<T.ApiCreateActivityPostInput>): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiCreateActivityPostResponseData>,
|
|
48
|
+
apiCreateActivityPost(data: T.ApiCreateActivityPostInput, options?: RequestOptions<T.ApiCreateActivityPostInput>): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiCreateActivityPostResponseData>, import("./contracts.types.js").CrmActivityCreateInput, {}, any>>;
|
|
30
49
|
/**
|
|
31
|
-
*
|
|
50
|
+
* 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.
|
|
32
51
|
* Calls `POST /api/v1/activities/with-reminder` through the shared IDP-aware Faiber client.
|
|
33
52
|
* @param data Typed JSON request body.
|
|
34
53
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
35
|
-
* @returns The complete Axios response, including the typed
|
|
36
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:activity:create, crm:task:create.
|
|
54
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
55
|
+
* @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.
|
|
37
56
|
*/
|
|
38
|
-
apiCreateActivityWithReminderPost(data: T.ApiCreateActivityWithReminderPostInput, options?: RequestOptions<T.ApiCreateActivityWithReminderPostInput>): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiCreateActivityWithReminderPostResponseData>,
|
|
57
|
+
apiCreateActivityWithReminderPost(data: T.ApiCreateActivityWithReminderPostInput, options?: RequestOptions<T.ApiCreateActivityWithReminderPostInput>): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiCreateActivityWithReminderPostResponseData>, import("./contracts.types.js").CrmActivityReminderCreateInput, {}, any>>;
|
|
39
58
|
/**
|
|
40
|
-
*
|
|
59
|
+
* List workspace durable jobs with cursor/status, ascending UUID; limit defaults 50, clamped 1..100. Result is nullable job-type-specific stored JSON.
|
|
41
60
|
* Calls `GET /api/v1/automation/jobs` through the shared IDP-aware Faiber client.
|
|
42
61
|
* @param params Typed query parameters; omitted members retain backend defaults.
|
|
43
62
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
44
|
-
* @returns The complete Axios response, including the typed
|
|
45
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:automation:read.
|
|
63
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
64
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of crm:automation:read.
|
|
46
65
|
*/
|
|
47
|
-
apiAutomationJobsGet(params?: T.ApiAutomationJobsGetQuery, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").CrmAutomationJobListResponse, unknown, {}>>;
|
|
66
|
+
apiAutomationJobsGet(params?: T.ApiAutomationJobsGetQuery, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").CrmAutomationJobListResponse, unknown, {}, any>>;
|
|
48
67
|
/**
|
|
49
|
-
*
|
|
68
|
+
* List workspace webhook subscriptions, including inactive entries, with total and failed/dead-letter delivery counts.
|
|
50
69
|
* Calls `GET /api/v1/automation/webhooks` through the shared IDP-aware Faiber client.
|
|
51
70
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
52
|
-
* @returns The complete Axios response, including the typed
|
|
53
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:automation:read.
|
|
71
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
72
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of crm:automation:read.
|
|
54
73
|
*/
|
|
55
|
-
apiAutomationWebhooksGet(options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiAutomationWebhooksGetResponseItem[]>, unknown, {}>>;
|
|
74
|
+
apiAutomationWebhooksGet(options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiAutomationWebhooksGetResponseItem[]>, unknown, {}, any>>;
|
|
56
75
|
/**
|
|
57
|
-
*
|
|
76
|
+
* 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.
|
|
58
77
|
* Calls `GET /api/v1/boards/{entity_type}/{pipeline_id}` through the shared IDP-aware Faiber client.
|
|
59
78
|
* @param entityType Backend path identifier `entity_type`.
|
|
60
79
|
* @param pipelineId Backend path identifier `pipeline_id`.
|
|
61
80
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
62
|
-
* @returns The complete Axios response, including the typed
|
|
63
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:board:read.
|
|
81
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
82
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of crm:board:read.
|
|
64
83
|
*/
|
|
65
|
-
apiBoardGet(entityType: Identifier, pipelineId: Identifier, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").CrmBoardResponse, unknown, {}>>;
|
|
84
|
+
apiBoardGet(entityType: Identifier, pipelineId: Identifier, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").CrmBoardResponse, unknown, {}, any>>;
|
|
66
85
|
/**
|
|
67
|
-
*
|
|
86
|
+
* List nondeleted workspace marketing campaigns, including inactive statuses, newest first.
|
|
68
87
|
* Calls `GET /api/v1/campaigns` through the shared IDP-aware Faiber client.
|
|
69
88
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
70
|
-
* @returns The complete Axios response, including the typed
|
|
71
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:marketing:read.
|
|
89
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
90
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of crm:marketing:read.
|
|
72
91
|
*/
|
|
73
|
-
apiCampaignsGet(options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiCampaignsGetResponseItem[]>, unknown, {}>>;
|
|
92
|
+
apiCampaignsGet(options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiCampaignsGetResponseItem[]>, unknown, {}, any>>;
|
|
74
93
|
/**
|
|
75
|
-
*
|
|
94
|
+
* 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.
|
|
76
95
|
* Calls `POST /api/v1/campaigns` through the shared IDP-aware Faiber client.
|
|
77
96
|
* @param data Typed JSON request body.
|
|
78
97
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
79
|
-
* @returns The complete Axios response, including the typed
|
|
80
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:marketing:manage.
|
|
98
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
99
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of crm:marketing:manage.
|
|
81
100
|
*/
|
|
82
|
-
apiCreateCampaignPost(data: T.ApiCreateCampaignPostInput, options?: RequestOptions<T.ApiCreateCampaignPostInput>): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiCreateCampaignPostResponseData>,
|
|
101
|
+
apiCreateCampaignPost(data: T.ApiCreateCampaignPostInput, options?: RequestOptions<T.ApiCreateCampaignPostInput>): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiCreateCampaignPostResponseData>, import("./contracts.types.js").CrmCampaignCreateInput, {}, any>>;
|
|
83
102
|
/**
|
|
84
|
-
*
|
|
103
|
+
* 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.
|
|
85
104
|
* Calls `GET /api/v1/companies` through the shared IDP-aware Faiber client.
|
|
86
105
|
* @param params Typed query parameters; omitted members retain backend defaults.
|
|
87
106
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
88
|
-
* @returns The complete Axios response, including the typed
|
|
89
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:company:read, crm:company:read_all.
|
|
107
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
108
|
+
* @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.
|
|
90
109
|
*/
|
|
91
|
-
apiCompaniesGet(params?: T.ApiCompaniesGetQuery, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").CrmCompanyListResponse, unknown, {}>>;
|
|
110
|
+
apiCompaniesGet(params?: T.ApiCompaniesGetQuery, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").CrmCompanyListResponse, unknown, {}, any>>;
|
|
92
111
|
/**
|
|
93
|
-
*
|
|
112
|
+
* 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.
|
|
94
113
|
* Calls `POST /api/v1/companies` through the shared IDP-aware Faiber client.
|
|
95
114
|
* @param data Typed JSON request body.
|
|
96
115
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
97
|
-
* @returns The complete Axios response, including the typed
|
|
98
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:company:create.
|
|
116
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
117
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of crm:company:create.
|
|
99
118
|
*/
|
|
100
|
-
apiCreateCompanyPost(data: T.ApiCreateCompanyPostInput, options?: RequestOptions<T.ApiCreateCompanyPostInput>): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiCreateCompanyPostResponseData>, T.ApiCreateCompanyPostInput, {}>>;
|
|
119
|
+
apiCreateCompanyPost(data: T.ApiCreateCompanyPostInput, options?: RequestOptions<T.ApiCreateCompanyPostInput>): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiCreateCompanyPostResponseData>, T.ApiCreateCompanyPostInput, {}, any>>;
|
|
101
120
|
/**
|
|
102
|
-
*
|
|
121
|
+
* Read a nondeleted workspace company by UUID; missing or foreign workspace company returns 404.
|
|
103
122
|
* Calls `GET /api/v1/companies/{id}` through the shared IDP-aware Faiber client.
|
|
104
123
|
* @param id Backend path identifier `id`.
|
|
105
124
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
106
|
-
* @returns The complete Axios response, including the typed
|
|
107
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:company:read, crm:company:read_all.
|
|
125
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
126
|
+
* @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.
|
|
108
127
|
*/
|
|
109
|
-
apiCompanyGet(id: Identifier, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiCompanyGetResponseData>, unknown, {}>>;
|
|
128
|
+
apiCompanyGet(id: Identifier, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiCompanyGetResponseData>, unknown, {}, any>>;
|
|
110
129
|
/**
|
|
111
|
-
*
|
|
130
|
+
* 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.
|
|
112
131
|
* Calls `PATCH /api/v1/companies/{id}` through the shared IDP-aware Faiber client.
|
|
113
132
|
* @param id Backend path identifier `id`.
|
|
114
133
|
* @param data Typed JSON request body.
|
|
115
134
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
116
|
-
* @returns The complete Axios response, including the typed
|
|
117
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:company:update.
|
|
135
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
136
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of crm:company:update.
|
|
118
137
|
*/
|
|
119
|
-
apiUpdateCompanyPatch(id: Identifier, data: T.ApiUpdateCompanyPatchInput, options?: RequestOptions<T.ApiUpdateCompanyPatchInput>): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiUpdateCompanyPatchResponseData>, T.ApiUpdateCompanyPatchInput, {}>>;
|
|
138
|
+
apiUpdateCompanyPatch(id: Identifier, data: T.ApiUpdateCompanyPatchInput, options?: RequestOptions<T.ApiUpdateCompanyPatchInput>): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiUpdateCompanyPatchResponseData>, T.ApiUpdateCompanyPatchInput, {}, any>>;
|
|
120
139
|
/**
|
|
121
|
-
*
|
|
140
|
+
* 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.
|
|
122
141
|
* Calls `GET /api/v1/contacts` through the shared IDP-aware Faiber client.
|
|
123
142
|
* @param params Typed query parameters; omitted members retain backend defaults.
|
|
124
143
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
125
|
-
* @returns The complete Axios response, including the typed
|
|
126
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:contact:read, crm:contact:read_all.
|
|
144
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
145
|
+
* @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.
|
|
127
146
|
*/
|
|
128
|
-
apiContactsGet(params?: T.ApiContactsGetQuery, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").CrmContactListResponse, unknown, {}>>;
|
|
147
|
+
apiContactsGet(params?: T.ApiContactsGetQuery, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").CrmContactListResponse, unknown, {}, any>>;
|
|
129
148
|
/**
|
|
130
|
-
*
|
|
149
|
+
* 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.
|
|
131
150
|
* Calls `POST /api/v1/contacts` through the shared IDP-aware Faiber client.
|
|
132
151
|
* @param data Typed JSON request body.
|
|
133
152
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
134
|
-
* @returns The complete Axios response, including the typed
|
|
135
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:contact:create.
|
|
153
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
154
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of crm:contact:create.
|
|
136
155
|
*/
|
|
137
|
-
apiCreateContactPost(data: T.ApiCreateContactPostInput, options?: RequestOptions<T.ApiCreateContactPostInput>): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiCreateContactPostResponseData>, T.ApiCreateContactPostInput, {}>>;
|
|
156
|
+
apiCreateContactPost(data: T.ApiCreateContactPostInput, options?: RequestOptions<T.ApiCreateContactPostInput>): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiCreateContactPostResponseData>, T.ApiCreateContactPostInput, {}, any>>;
|
|
138
157
|
/**
|
|
139
|
-
*
|
|
158
|
+
* Read a nondeleted workspace contact by UUID; missing or foreign workspace contact returns 404.
|
|
140
159
|
* Calls `GET /api/v1/contacts/{id}` through the shared IDP-aware Faiber client.
|
|
141
160
|
* @param id Backend path identifier `id`.
|
|
142
161
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
143
|
-
* @returns The complete Axios response, including the typed
|
|
144
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:contact:read, crm:contact:read_all.
|
|
162
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
163
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of crm:contact:read, crm:contact:read_all.
|
|
145
164
|
*/
|
|
146
|
-
apiContactGet(id: Identifier, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiContactGetResponseData>, unknown, {}>>;
|
|
165
|
+
apiContactGet(id: Identifier, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiContactGetResponseData>, unknown, {}, any>>;
|
|
147
166
|
/**
|
|
148
|
-
*
|
|
167
|
+
* 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.
|
|
149
168
|
* Calls `PATCH /api/v1/contacts/{id}` through the shared IDP-aware Faiber client.
|
|
150
169
|
* @param id Backend path identifier `id`.
|
|
151
170
|
* @param data Typed JSON request body.
|
|
152
171
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
153
|
-
* @returns The complete Axios response, including the typed
|
|
154
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:contact:update.
|
|
172
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
173
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of crm:contact:update.
|
|
155
174
|
*/
|
|
156
|
-
apiUpdateContactPatch(id: Identifier, data: T.ApiUpdateContactPatchInput, options?: RequestOptions<T.ApiUpdateContactPatchInput>): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiUpdateContactPatchResponseData>,
|
|
175
|
+
apiUpdateContactPatch(id: Identifier, data: T.ApiUpdateContactPatchInput, options?: RequestOptions<T.ApiUpdateContactPatchInput>): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiUpdateContactPatchResponseData>, import("./contracts.types.js").CrmContactUpdateInput, {}, any>>;
|
|
157
176
|
/**
|
|
158
|
-
*
|
|
177
|
+
* Read the configured CRM workspace, including locale, timezone, currency, AI settings and optimistic version; absent workspace returns 404.
|
|
159
178
|
* Calls `GET /api/v1/context` through the shared IDP-aware Faiber client.
|
|
160
179
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
161
|
-
* @returns The complete Axios response, including the typed
|
|
162
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:workspace:read.
|
|
180
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
181
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of crm:workspace:read.
|
|
163
182
|
*/
|
|
164
|
-
apiContextGet(options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiContextGetResponseData>, unknown, {}>>;
|
|
183
|
+
apiContextGet(options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiContextGetResponseData>, unknown, {}, any>>;
|
|
165
184
|
/**
|
|
166
|
-
*
|
|
185
|
+
* 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.
|
|
167
186
|
* Calls `GET /api/v1/deals` through the shared IDP-aware Faiber client.
|
|
168
187
|
* @param params Typed query parameters; omitted members retain backend defaults.
|
|
169
188
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
170
|
-
* @returns The complete Axios response, including the typed
|
|
171
|
-
* @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.
|
|
189
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
190
|
+
* @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.
|
|
172
191
|
*/
|
|
173
|
-
apiDealsGet(params?: T.ApiDealsGetQuery, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").CrmDealListResponse, unknown, {}>>;
|
|
192
|
+
apiDealsGet(params?: T.ApiDealsGetQuery, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").CrmDealListResponse, unknown, {}, any>>;
|
|
174
193
|
/**
|
|
175
|
-
*
|
|
194
|
+
* 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.
|
|
176
195
|
* Calls `POST /api/v1/deals` through the shared IDP-aware Faiber client.
|
|
177
196
|
* @param data Typed JSON request body.
|
|
178
197
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
179
|
-
* @returns The complete Axios response, including the typed
|
|
180
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:deal:create.
|
|
198
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
199
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of crm:deal:create.
|
|
181
200
|
*/
|
|
182
|
-
apiCreateDealPost(data: T.ApiCreateDealPostInput, options?: RequestOptions<T.ApiCreateDealPostInput>): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiCreateDealPostResponseData>, T.ApiCreateDealPostInput, {}>>;
|
|
201
|
+
apiCreateDealPost(data: T.ApiCreateDealPostInput, options?: RequestOptions<T.ApiCreateDealPostInput>): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiCreateDealPostResponseData>, T.ApiCreateDealPostInput, {}, any>>;
|
|
183
202
|
/**
|
|
184
|
-
*
|
|
203
|
+
* Read a nondeleted workspace deal visible to caller; only crm:admin or crm:deal:read_all removes owner filtering. Missing/invisible deals return 404.
|
|
185
204
|
* Calls `GET /api/v1/deals/{id}` through the shared IDP-aware Faiber client.
|
|
186
205
|
* @param id Backend path identifier `id`.
|
|
187
206
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
188
|
-
* @returns The complete Axios response, including the typed
|
|
189
|
-
* @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.
|
|
207
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
208
|
+
* @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.
|
|
190
209
|
*/
|
|
191
|
-
apiDealGet(id: Identifier, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiDealGetResponseData>, unknown, {}>>;
|
|
210
|
+
apiDealGet(id: Identifier, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiDealGetResponseData>, unknown, {}, any>>;
|
|
192
211
|
/**
|
|
193
|
-
*
|
|
212
|
+
* 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.
|
|
194
213
|
* Calls `PATCH /api/v1/deals/{id}` through the shared IDP-aware Faiber client.
|
|
195
214
|
* @param id Backend path identifier `id`.
|
|
196
215
|
* @param data Typed JSON request body.
|
|
197
216
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
198
|
-
* @returns The complete Axios response, including the typed
|
|
199
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:deal:update.
|
|
217
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
218
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of crm:deal:update.
|
|
200
219
|
*/
|
|
201
|
-
apiUpdateDealPatch(id: Identifier, data: T.ApiUpdateDealPatchInput, options?: RequestOptions<T.ApiUpdateDealPatchInput>): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiUpdateDealPatchResponseData>, T.ApiUpdateDealPatchInput, {}>>;
|
|
220
|
+
apiUpdateDealPatch(id: Identifier, data: T.ApiUpdateDealPatchInput, options?: RequestOptions<T.ApiUpdateDealPatchInput>): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiUpdateDealPatchResponseData>, T.ApiUpdateDealPatchInput, {}, any>>;
|
|
202
221
|
/**
|
|
203
|
-
*
|
|
222
|
+
* 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.
|
|
204
223
|
* Calls `PATCH /api/v1/deals/{id}/assignment` through the shared IDP-aware Faiber client.
|
|
205
224
|
* @param id Backend path identifier `id`.
|
|
206
225
|
* @param data Typed JSON request body.
|
|
207
226
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
208
|
-
* @returns The complete Axios response, including the typed
|
|
209
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:deal:assign.
|
|
227
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
228
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of crm:deal:assign.
|
|
210
229
|
*/
|
|
211
|
-
apiAssignDealPatch(id: Identifier, data: T.ApiAssignDealPatchInput, options?: RequestOptions<T.ApiAssignDealPatchInput>): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiAssignDealPatchResponseData>, T.ApiAssignDealPatchInput, {}>>;
|
|
230
|
+
apiAssignDealPatch(id: Identifier, data: T.ApiAssignDealPatchInput, options?: RequestOptions<T.ApiAssignDealPatchInput>): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiAssignDealPatchResponseData>, T.ApiAssignDealPatchInput, {}, any>>;
|
|
212
231
|
/**
|
|
213
|
-
*
|
|
232
|
+
* 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.
|
|
214
233
|
* Calls `PATCH /api/v1/deals/{id}/stage` through the shared IDP-aware Faiber client.
|
|
215
234
|
* @param id Backend path identifier `id`.
|
|
216
235
|
* @param data Typed JSON request body.
|
|
217
236
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
218
|
-
* @returns The complete Axios response, including the typed
|
|
219
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:deal:move.
|
|
237
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
238
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of crm:deal:move.
|
|
220
239
|
*/
|
|
221
|
-
apiMoveDealStagePatch(id: Identifier, data: T.ApiMoveDealStagePatchInput, options?: RequestOptions<T.ApiMoveDealStagePatchInput>): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiMoveDealStagePatchResponseData>, T.ApiMoveDealStagePatchInput, {}>>;
|
|
240
|
+
apiMoveDealStagePatch(id: Identifier, data: T.ApiMoveDealStagePatchInput, options?: RequestOptions<T.ApiMoveDealStagePatchInput>): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiMoveDealStagePatchResponseData>, T.ApiMoveDealStagePatchInput, {}, any>>;
|
|
222
241
|
/**
|
|
223
|
-
*
|
|
242
|
+
* 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.
|
|
224
243
|
* Calls `GET /api/v1/integration/office/leads/find` through the shared IDP-aware Faiber client.
|
|
225
244
|
* @param params Typed query parameters; omitted members retain backend defaults.
|
|
226
245
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
227
|
-
* @returns The complete Axios response, including the typed
|
|
228
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission:
|
|
246
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
247
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: No local handler permission check; deployment/gateway authority must be independently verified.
|
|
229
248
|
*/
|
|
230
|
-
apiFindOfficeLeadGet(params
|
|
249
|
+
apiFindOfficeLeadGet(params: T.ApiFindOfficeLeadGetQuery, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").CrmOfficeLeadResponse, unknown, {}, any>>;
|
|
231
250
|
/**
|
|
232
|
-
*
|
|
251
|
+
* 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.
|
|
233
252
|
* Calls `GET /api/v1/leads` through the shared IDP-aware Faiber client.
|
|
234
253
|
* @param params Typed query parameters; omitted members retain backend defaults.
|
|
235
254
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
236
|
-
* @returns The complete Axios response, including the typed
|
|
237
|
-
* @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.
|
|
255
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
256
|
+
* @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.
|
|
238
257
|
*/
|
|
239
|
-
apiLeadsGet(params?: T.ApiLeadsGetQuery, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").CrmLeadListResponse, unknown, {}>>;
|
|
258
|
+
apiLeadsGet(params?: T.ApiLeadsGetQuery, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").CrmLeadListResponse, unknown, {}, any>>;
|
|
240
259
|
/**
|
|
241
|
-
*
|
|
260
|
+
* 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.
|
|
242
261
|
* Calls `POST /api/v1/leads` through the shared IDP-aware Faiber client.
|
|
243
262
|
* @param data Typed JSON request body.
|
|
244
263
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
245
|
-
* @returns The complete Axios response, including the typed
|
|
246
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:lead:create.
|
|
264
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
265
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of crm:lead:create.
|
|
247
266
|
*/
|
|
248
|
-
apiCreateLeadPost(data: T.ApiCreateLeadPostInput, options?: RequestOptions<T.ApiCreateLeadPostInput>): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiCreateLeadPostResponseData>, T.ApiCreateLeadPostInput, {}>>;
|
|
267
|
+
apiCreateLeadPost(data: T.ApiCreateLeadPostInput, options?: RequestOptions<T.ApiCreateLeadPostInput>): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiCreateLeadPostResponseData>, T.ApiCreateLeadPostInput, {}, any>>;
|
|
249
268
|
/**
|
|
250
|
-
*
|
|
269
|
+
* 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.
|
|
251
270
|
* Calls `GET /api/v1/leads/{id}` through the shared IDP-aware Faiber client.
|
|
252
271
|
* @param id Backend path identifier `id`.
|
|
253
272
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
254
|
-
* @returns The complete Axios response, including the typed
|
|
255
|
-
* @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.
|
|
273
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
274
|
+
* @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.
|
|
256
275
|
*/
|
|
257
|
-
apiLeadGet(id: Identifier, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiLeadGetResponseData>, unknown, {}>>;
|
|
276
|
+
apiLeadGet(id: Identifier, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiLeadGetResponseData>, unknown, {}, any>>;
|
|
258
277
|
/**
|
|
259
|
-
*
|
|
278
|
+
* 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.
|
|
260
279
|
* Calls `PATCH /api/v1/leads/{id}` through the shared IDP-aware Faiber client.
|
|
261
280
|
* @param id Backend path identifier `id`.
|
|
262
281
|
* @param data Typed JSON request body.
|
|
263
282
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
264
|
-
* @returns The complete Axios response, including the typed
|
|
265
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:lead: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:lead:update.
|
|
266
285
|
*/
|
|
267
|
-
apiUpdateLeadPatch(id: Identifier, data: T.ApiUpdateLeadPatchInput, options?: RequestOptions<T.ApiUpdateLeadPatchInput>): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiUpdateLeadPatchResponseData>,
|
|
286
|
+
apiUpdateLeadPatch(id: Identifier, data: T.ApiUpdateLeadPatchInput, options?: RequestOptions<T.ApiUpdateLeadPatchInput>): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiUpdateLeadPatchResponseData>, import("./contracts.types.js").CrmLeadUpdateInput, {}, any>>;
|
|
268
287
|
/**
|
|
269
|
-
*
|
|
288
|
+
* 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.
|
|
270
289
|
* Calls `PATCH /api/v1/leads/{id}/assignment` through the shared IDP-aware Faiber client.
|
|
271
290
|
* @param id Backend path identifier `id`.
|
|
272
291
|
* @param data Typed JSON request body.
|
|
273
292
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
274
|
-
* @returns The complete Axios response, including the typed
|
|
275
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:lead:assign.
|
|
293
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
294
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of crm:lead:assign.
|
|
276
295
|
*/
|
|
277
|
-
apiAssignLeadPatch(id: Identifier, data: T.ApiAssignLeadPatchInput, options?: RequestOptions<T.ApiAssignLeadPatchInput>): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiAssignLeadPatchResponseData>, T.ApiAssignLeadPatchInput, {}>>;
|
|
296
|
+
apiAssignLeadPatch(id: Identifier, data: T.ApiAssignLeadPatchInput, options?: RequestOptions<T.ApiAssignLeadPatchInput>): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiAssignLeadPatchResponseData>, T.ApiAssignLeadPatchInput, {}, any>>;
|
|
278
297
|
/**
|
|
279
|
-
*
|
|
298
|
+
* 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.
|
|
280
299
|
* Calls `GET /api/v1/leads/{id}/history` through the shared IDP-aware Faiber client.
|
|
281
300
|
* @param id Backend path identifier `id`.
|
|
282
301
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
283
|
-
* @returns The complete Axios response, including the typed
|
|
284
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:lead:read, crm:activity:read.
|
|
302
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
303
|
+
* @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.
|
|
285
304
|
*/
|
|
286
|
-
apiLeadHistoryGet(id: Identifier, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiLeadHistoryGetResponseItem[]>, unknown, {}>>;
|
|
305
|
+
apiLeadHistoryGet(id: Identifier, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiLeadHistoryGetResponseItem[]>, unknown, {}, any>>;
|
|
287
306
|
/**
|
|
288
|
-
*
|
|
307
|
+
* 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.
|
|
289
308
|
* Calls `DELETE /api/v1/leads/{id}/reminders` through the shared IDP-aware Faiber client.
|
|
290
309
|
* @param id Backend path identifier `id`.
|
|
291
310
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
292
|
-
* @returns The complete Axios response, including the typed
|
|
293
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:task:delete.
|
|
311
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
312
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of crm:task:delete.
|
|
294
313
|
*/
|
|
295
|
-
apiDeleteLeadRemindersDelete(id: Identifier, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").
|
|
314
|
+
apiDeleteLeadRemindersDelete(id: Identifier, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").CrmLeadReminderDeletionResponse, unknown, {}, any>>;
|
|
296
315
|
/**
|
|
297
|
-
*
|
|
316
|
+
* 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.
|
|
298
317
|
* Calls `DELETE /api/v1/leads/{id}/sos` through the shared IDP-aware Faiber client.
|
|
299
318
|
* @param id Backend path identifier `id`.
|
|
300
319
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
301
|
-
* @returns The complete Axios response, including the typed
|
|
302
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:sos:delete.
|
|
320
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
321
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of crm:sos:delete.
|
|
303
322
|
*/
|
|
304
|
-
apiRemoveLeadFromSosDelete(id: Identifier, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiRemoveLeadFromSosDeleteResponseData>, unknown, {}>>;
|
|
323
|
+
apiRemoveLeadFromSosDelete(id: Identifier, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiRemoveLeadFromSosDeleteResponseData>, unknown, {}, any>>;
|
|
305
324
|
/**
|
|
306
|
-
*
|
|
325
|
+
* 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.
|
|
307
326
|
* Calls `POST /api/v1/leads/{id}/sos` through the shared IDP-aware Faiber client.
|
|
308
327
|
* @param id Backend path identifier `id`.
|
|
309
328
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
310
|
-
* @returns The complete Axios response, including the typed
|
|
311
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:sos:create.
|
|
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:sos:create.
|
|
312
331
|
*/
|
|
313
|
-
apiAddLeadToSosPost(id: Identifier, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiAddLeadToSosPostResponseData>, unknown, {}>>;
|
|
332
|
+
apiAddLeadToSosPost(id: Identifier, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiAddLeadToSosPostResponseData>, unknown, {}, any>>;
|
|
314
333
|
/**
|
|
315
|
-
*
|
|
334
|
+
* 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.
|
|
316
335
|
* Calls `PATCH /api/v1/leads/{id}/stage` through the shared IDP-aware Faiber client.
|
|
317
336
|
* @param id Backend path identifier `id`.
|
|
318
337
|
* @param data Typed JSON request body.
|
|
319
338
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
320
|
-
* @returns The complete Axios response, including the typed
|
|
321
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:lead:move.
|
|
339
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
340
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of crm:lead:move.
|
|
322
341
|
*/
|
|
323
|
-
apiMoveLeadStagePatch(id: Identifier, data: T.ApiMoveLeadStagePatchInput, options?: RequestOptions<T.ApiMoveLeadStagePatchInput>): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiMoveLeadStagePatchResponseData>, T.ApiMoveLeadStagePatchInput, {}>>;
|
|
342
|
+
apiMoveLeadStagePatch(id: Identifier, data: T.ApiMoveLeadStagePatchInput, options?: RequestOptions<T.ApiMoveLeadStagePatchInput>): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiMoveLeadStagePatchResponseData>, T.ApiMoveLeadStagePatchInput, {}, any>>;
|
|
324
343
|
/**
|
|
325
|
-
*
|
|
344
|
+
* Alias of the full lead list with exactly the same filters, ownership restrictions and bare Lead response model; no extra profile enrichment.
|
|
326
345
|
* Calls `GET /api/v1/leads/light` through the shared IDP-aware Faiber client.
|
|
327
346
|
* @param params Typed query parameters; omitted members retain backend defaults.
|
|
328
347
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
329
|
-
* @returns The complete Axios response, including the typed
|
|
330
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission:
|
|
348
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
349
|
+
* @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).
|
|
331
350
|
*/
|
|
332
|
-
apiLightLeadsGet(params?: T.ApiLightLeadsGetQuery, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").CrmLeadListResponse, unknown, {}>>;
|
|
351
|
+
apiLightLeadsGet(params?: T.ApiLightLeadsGetQuery, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").CrmLeadListResponse, unknown, {}, any>>;
|
|
333
352
|
/**
|
|
334
|
-
*
|
|
353
|
+
* List nondeleted workspace workflows with their nondeleted stages; includes inactive entries, ordered by entity type, priority, default flag and name.
|
|
335
354
|
* Calls `GET /api/v1/pipelines` through the shared IDP-aware Faiber client.
|
|
336
355
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
337
|
-
* @returns The complete Axios response, including the typed
|
|
338
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:pipeline:read.
|
|
356
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
357
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of crm:pipeline:read.
|
|
339
358
|
*/
|
|
340
|
-
apiPipelinesGet(options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").CrmPipelinesResponse, unknown, {}>>;
|
|
359
|
+
apiPipelinesGet(options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").CrmPipelinesResponse, unknown, {}, any>>;
|
|
341
360
|
/**
|
|
342
|
-
*
|
|
361
|
+
* Patch pipeline fields using required version; negative quota returns 422 and missing/stale version match returns 409. Null fields preserve existing values.
|
|
343
362
|
* Calls `PATCH /api/v1/pipelines/{id}` through the shared IDP-aware Faiber client.
|
|
344
363
|
* @param id Backend path identifier `id`.
|
|
345
364
|
* @param data Typed JSON request body.
|
|
346
365
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
347
|
-
* @returns The complete Axios response, including the typed
|
|
348
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:pipeline:update.
|
|
366
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
367
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of crm:pipeline:update.
|
|
349
368
|
*/
|
|
350
|
-
apiUpdatePipelinePatch(id: Identifier, data: T.ApiUpdatePipelinePatchInput, options?: RequestOptions<T.ApiUpdatePipelinePatchInput>): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiUpdatePipelinePatchResponseData>, T.ApiUpdatePipelinePatchInput, {}>>;
|
|
369
|
+
apiUpdatePipelinePatch(id: Identifier, data: T.ApiUpdatePipelinePatchInput, options?: RequestOptions<T.ApiUpdatePipelinePatchInput>): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiUpdatePipelinePatchResponseData>, T.ApiUpdatePipelinePatchInput, {}, any>>;
|
|
351
370
|
/**
|
|
352
|
-
*
|
|
371
|
+
* Read a workspace report run by UUID, including nullable deterministic summary, AI result/error and completion timestamp; missing or foreign run returns 404.
|
|
353
372
|
* Calls `GET /api/v1/reports/{id}` through the shared IDP-aware Faiber client.
|
|
354
373
|
* @param id Backend path identifier `id`.
|
|
355
374
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
356
|
-
* @returns The complete Axios response, including the typed
|
|
357
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:report:read.
|
|
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:report:read.
|
|
358
377
|
*/
|
|
359
|
-
apiReportRunGet(id: Identifier, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiReportRunGetResponseData>, unknown, {}>>;
|
|
378
|
+
apiReportRunGet(id: Identifier, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiReportRunGetResponseData>, unknown, {}, any>>;
|
|
360
379
|
/**
|
|
361
|
-
*
|
|
380
|
+
* 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.
|
|
362
381
|
* Calls `POST /api/v1/reports/{id}/agentic` through the shared IDP-aware Faiber client.
|
|
363
382
|
* @param id Backend path identifier `id`.
|
|
364
383
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
365
|
-
* @returns The complete Axios response, including the typed
|
|
366
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:agent:run.
|
|
384
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
385
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of crm:agent:run.
|
|
367
386
|
*/
|
|
368
|
-
apiRequestAgenticInsightPost(id: Identifier, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").CrmAgenticInsightResponse, unknown, {}>>;
|
|
387
|
+
apiRequestAgenticInsightPost(id: Identifier, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").CrmAgenticInsightResponse, unknown, {}, any>>;
|
|
369
388
|
/**
|
|
370
|
-
*
|
|
389
|
+
* Read workspace report definitions and global metric definitions as concrete reports/metrics arrays, ordered by report name/UUID and metric key.
|
|
371
390
|
* Calls `GET /api/v1/reports/catalog` through the shared IDP-aware Faiber client.
|
|
372
391
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
373
|
-
* @returns The complete Axios response, including the typed
|
|
374
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:report:read.
|
|
392
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
393
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of crm:report:read.
|
|
375
394
|
*/
|
|
376
|
-
apiReportCatalogGet(options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").CrmReportCatalogResponse, unknown, {}>>;
|
|
395
|
+
apiReportCatalogGet(options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").CrmReportCatalogResponse, unknown, {}, any>>;
|
|
377
396
|
/**
|
|
378
|
-
*
|
|
397
|
+
* 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.
|
|
379
398
|
* Calls `GET /api/v1/reports/overview` through the shared IDP-aware Faiber client.
|
|
380
399
|
* @param params Typed query parameters; omitted members retain backend defaults.
|
|
381
400
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
382
|
-
* @returns The complete Axios response, including the typed
|
|
383
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:report:read.
|
|
401
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
402
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of crm:report:read.
|
|
384
403
|
*/
|
|
385
|
-
apiOverviewGet(params?: T.ApiOverviewGetQuery, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").CrmOverviewResponse, unknown, {}>>;
|
|
404
|
+
apiOverviewGet(params?: T.ApiOverviewGetQuery, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").CrmOverviewResponse, unknown, {}, any>>;
|
|
386
405
|
/**
|
|
387
|
-
*
|
|
406
|
+
* 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.
|
|
388
407
|
* Calls `POST /api/v1/reports/refresh` through the shared IDP-aware Faiber client.
|
|
389
408
|
* @param params Typed query parameters; omitted members retain backend defaults.
|
|
390
409
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
391
|
-
* @returns The complete Axios response, including the typed
|
|
392
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:report:refresh.
|
|
410
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
411
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of crm:report:refresh.
|
|
393
412
|
*/
|
|
394
|
-
apiRefreshReportsPost(params?: T.ApiRefreshReportsPostQuery, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").CrmReportRefreshResponse, unknown, {}>>;
|
|
413
|
+
apiRefreshReportsPost(params?: T.ApiRefreshReportsPostQuery, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").CrmReportRefreshResponse, unknown, {}, any>>;
|
|
395
414
|
/**
|
|
396
|
-
*
|
|
415
|
+
* List SOS entries whose leads are nondeleted in this workspace, newest first; returns SOS records rather than enriched lead objects.
|
|
397
416
|
* Calls `GET /api/v1/sos` through the shared IDP-aware Faiber client.
|
|
398
417
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
399
|
-
* @returns The complete Axios response, including the typed
|
|
400
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:sos:read.
|
|
418
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
419
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of crm:sos:read.
|
|
401
420
|
*/
|
|
402
|
-
apiListSosLeadsGet(options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiListSosLeadsGetResponseItem[]>, unknown, {}>>;
|
|
421
|
+
apiListSosLeadsGet(options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiListSosLeadsGetResponseItem[]>, unknown, {}, any>>;
|
|
403
422
|
/**
|
|
404
|
-
*
|
|
423
|
+
* List all workspace marketing sources, including inactive entries, ordered by active flag then name and UUID.
|
|
405
424
|
* Calls `GET /api/v1/sources` through the shared IDP-aware Faiber client.
|
|
406
425
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
407
|
-
* @returns The complete Axios response, including the typed
|
|
408
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:marketing:read.
|
|
426
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
427
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of crm:marketing:read.
|
|
409
428
|
*/
|
|
410
|
-
apiSourcesGet(options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiSourcesGetResponseItem[]>, unknown, {}>>;
|
|
429
|
+
apiSourcesGet(options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiSourcesGetResponseItem[]>, unknown, {}, any>>;
|
|
411
430
|
/**
|
|
412
|
-
*
|
|
431
|
+
* 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.
|
|
413
432
|
* Calls `POST /api/v1/sources` through the shared IDP-aware Faiber client.
|
|
414
433
|
* @param data Typed JSON request body.
|
|
415
434
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
416
|
-
* @returns The complete Axios response, including the typed
|
|
417
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:marketing:manage.
|
|
435
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
436
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of crm:marketing:manage.
|
|
418
437
|
*/
|
|
419
|
-
apiCreateSourcePost(data: T.ApiCreateSourcePostInput, options?: RequestOptions<T.ApiCreateSourcePostInput>): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiCreateSourcePostResponseData>, T.ApiCreateSourcePostInput, {}>>;
|
|
438
|
+
apiCreateSourcePost(data: T.ApiCreateSourcePostInput, options?: RequestOptions<T.ApiCreateSourcePostInput>): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiCreateSourcePostResponseData>, T.ApiCreateSourcePostInput, {}, any>>;
|
|
420
439
|
/**
|
|
421
|
-
*
|
|
440
|
+
* 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.
|
|
422
441
|
* Calls `GET /api/v1/stats/daily` through the shared IDP-aware Faiber client.
|
|
423
442
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
424
|
-
* @returns The complete Axios response, including the typed
|
|
425
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:stats:read, crm:stats:read_own.
|
|
443
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
444
|
+
* @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.
|
|
426
445
|
*/
|
|
427
|
-
apiDailyStatsGet(options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").
|
|
446
|
+
apiDailyStatsGet(options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").CrmDailyStatsResponse, unknown, {}, any>>;
|
|
428
447
|
/**
|
|
429
|
-
*
|
|
448
|
+
* Aggregate total/active/inactive leads for caller-assigned nondeleted lead workflows; active status uses custom_data.is_active_status, default true.
|
|
430
449
|
* Calls `GET /api/v1/stats/lead` through the shared IDP-aware Faiber client.
|
|
431
450
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
432
|
-
* @returns The complete Axios response, including the typed
|
|
433
|
-
* @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.
|
|
451
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
452
|
+
* @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.
|
|
434
453
|
*/
|
|
435
|
-
apiLeadStatsGet(options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").
|
|
454
|
+
apiLeadStatsGet(options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").CrmLeadStatsResponse, unknown, {}, any>>;
|
|
436
455
|
/**
|
|
437
|
-
*
|
|
456
|
+
* 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.
|
|
438
457
|
* Calls `GET /api/v1/tasks` through the shared IDP-aware Faiber client.
|
|
439
458
|
* @param params Typed query parameters; omitted members retain backend defaults.
|
|
440
459
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
441
|
-
* @returns The complete Axios response, including the typed
|
|
442
|
-
* @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.
|
|
460
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
461
|
+
* @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.
|
|
443
462
|
*/
|
|
444
|
-
apiTasksGet(params?: T.ApiTasksGetQuery, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").CrmTaskListResponse, unknown, {}>>;
|
|
463
|
+
apiTasksGet(params?: T.ApiTasksGetQuery, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").CrmTaskListResponse, unknown, {}, any>>;
|
|
445
464
|
/**
|
|
446
|
-
*
|
|
465
|
+
* 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.
|
|
447
466
|
* Calls `POST /api/v1/tasks` through the shared IDP-aware Faiber client.
|
|
448
467
|
* @param data Typed JSON request body.
|
|
449
468
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
450
|
-
* @returns The complete Axios response, including the typed
|
|
451
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:task:create.
|
|
469
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
470
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of crm:task:create.
|
|
452
471
|
*/
|
|
453
|
-
apiCreateTaskPost(data: T.ApiCreateTaskPostInput, options?: RequestOptions<T.ApiCreateTaskPostInput>): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiCreateTaskPostResponseData>,
|
|
472
|
+
apiCreateTaskPost(data: T.ApiCreateTaskPostInput, options?: RequestOptions<T.ApiCreateTaskPostInput>): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiCreateTaskPostResponseData>, import("./contracts.types.js").CrmTaskCreateInput, {}, any>>;
|
|
454
473
|
/**
|
|
455
|
-
*
|
|
474
|
+
* 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.
|
|
456
475
|
* Calls `DELETE /api/v1/tasks/{id}` through the shared IDP-aware Faiber client.
|
|
457
476
|
* @param id Backend path identifier `id`.
|
|
458
477
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
459
|
-
* @returns The complete Axios response, including the typed
|
|
460
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:task:delete.
|
|
478
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
479
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of crm:task:delete.
|
|
461
480
|
*/
|
|
462
|
-
apiDeleteTaskDelete(id: Identifier, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiDeleteTaskDeleteResponseData>, unknown, {}>>;
|
|
481
|
+
apiDeleteTaskDelete(id: Identifier, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiDeleteTaskDeleteResponseData>, unknown, {}, any>>;
|
|
463
482
|
/**
|
|
464
|
-
*
|
|
483
|
+
* 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.
|
|
465
484
|
* Calls `PATCH /api/v1/tasks/{id}/status` through the shared IDP-aware Faiber client.
|
|
466
485
|
* @param id Backend path identifier `id`.
|
|
467
486
|
* @param data Typed JSON request body.
|
|
468
487
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
469
|
-
* @returns The complete Axios response, including the typed
|
|
470
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:task:update.
|
|
488
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
489
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of crm:task:update.
|
|
471
490
|
*/
|
|
472
|
-
apiUpdateTaskStatusPatch(id: Identifier, data: T.ApiUpdateTaskStatusPatchInput, options?: RequestOptions<T.ApiUpdateTaskStatusPatchInput>): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiUpdateTaskStatusPatchResponseData>,
|
|
491
|
+
apiUpdateTaskStatusPatch(id: Identifier, data: T.ApiUpdateTaskStatusPatchInput, options?: RequestOptions<T.ApiUpdateTaskStatusPatchInput>): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiUpdateTaskStatusPatchResponseData>, import("./contracts.types.js").CrmTaskStatusInput, {}, any>>;
|
|
473
492
|
/**
|
|
474
|
-
*
|
|
493
|
+
* List nondeleted workspace teams with active member counts, ordered by name and UUID; includes inactive teams.
|
|
475
494
|
* Calls `GET /api/v1/teams` through the shared IDP-aware Faiber client.
|
|
476
495
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
477
|
-
* @returns The complete Axios response, including the typed
|
|
478
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:team: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:team:read.
|
|
479
498
|
*/
|
|
480
|
-
apiTeamsGet(options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiTeamsGetResponseItem[]>, unknown, {}>>;
|
|
499
|
+
apiTeamsGet(options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiTeamsGetResponseItem[]>, unknown, {}, any>>;
|
|
481
500
|
/**
|
|
482
|
-
*
|
|
501
|
+
* 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.
|
|
483
502
|
* Calls `POST /api/v1/teams` through the shared IDP-aware Faiber client.
|
|
484
503
|
* @param data Typed JSON request body.
|
|
485
504
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
486
|
-
* @returns The complete Axios response, including the typed
|
|
487
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:team:create.
|
|
505
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
506
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of crm:team:create.
|
|
488
507
|
*/
|
|
489
|
-
apiCreateTeamPost(data: T.ApiCreateTeamPostInput, options?: RequestOptions<T.ApiCreateTeamPostInput>): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiCreateTeamPostResponseData>, T.ApiCreateTeamPostInput, {}>>;
|
|
508
|
+
apiCreateTeamPost(data: T.ApiCreateTeamPostInput, options?: RequestOptions<T.ApiCreateTeamPostInput>): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiCreateTeamPostResponseData>, T.ApiCreateTeamPostInput, {}, any>>;
|
|
490
509
|
/**
|
|
491
|
-
*
|
|
510
|
+
* 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.
|
|
492
511
|
* Calls `DELETE /api/v1/teams/{id}` through the shared IDP-aware Faiber client.
|
|
493
512
|
* @param id Backend path identifier `id`.
|
|
494
513
|
* @param data Typed JSON request body.
|
|
495
514
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
496
|
-
* @returns The complete Axios response, including the typed
|
|
497
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:team:delete.
|
|
515
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
516
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of crm:team:delete.
|
|
498
517
|
*/
|
|
499
|
-
apiDeleteTeamDelete(id: Identifier, data: T.ApiDeleteTeamDeleteInput, options?: RequestOptions<T.ApiDeleteTeamDeleteInput>): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiDeleteTeamDeleteResponseData>, T.ApiDeleteTeamDeleteInput, {}>>;
|
|
518
|
+
apiDeleteTeamDelete(id: Identifier, data: T.ApiDeleteTeamDeleteInput, options?: RequestOptions<T.ApiDeleteTeamDeleteInput>): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiDeleteTeamDeleteResponseData>, T.ApiDeleteTeamDeleteInput, {}, any>>;
|
|
500
519
|
/**
|
|
501
|
-
*
|
|
520
|
+
* Read a nondeleted workspace team with all membership rows, including inactive members; absent team returns 404.
|
|
502
521
|
* Calls `GET /api/v1/teams/{id}` through the shared IDP-aware Faiber client.
|
|
503
522
|
* @param id Backend path identifier `id`.
|
|
504
523
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
505
|
-
* @returns The complete Axios response, including the typed
|
|
506
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:team:read.
|
|
524
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
525
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of crm:team:read.
|
|
507
526
|
*/
|
|
508
|
-
apiTeamGet(id: Identifier, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").CrmTeamDetailResponse, unknown, {}>>;
|
|
527
|
+
apiTeamGet(id: Identifier, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").CrmTeamDetailResponse, unknown, {}, any>>;
|
|
509
528
|
/**
|
|
510
|
-
*
|
|
529
|
+
* 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.
|
|
511
530
|
* Calls `POST /api/v1/teams/{id}/members` through the shared IDP-aware Faiber client.
|
|
512
531
|
* @param id Backend path identifier `id`.
|
|
513
532
|
* @param data Typed JSON request body.
|
|
514
533
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
515
|
-
* @returns The complete Axios response, including the typed
|
|
516
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:team:manage_members.
|
|
534
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
535
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of crm:team:manage_members.
|
|
517
536
|
*/
|
|
518
|
-
apiAddTeamMemberPost(id: Identifier, data: T.ApiAddTeamMemberPostInput, options?: RequestOptions<T.ApiAddTeamMemberPostInput>): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiAddTeamMemberPostResponseData>, T.ApiAddTeamMemberPostInput, {}>>;
|
|
537
|
+
apiAddTeamMemberPost(id: Identifier, data: T.ApiAddTeamMemberPostInput, options?: RequestOptions<T.ApiAddTeamMemberPostInput>): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiAddTeamMemberPostResponseData>, T.ApiAddTeamMemberPostInput, {}, any>>;
|
|
519
538
|
/**
|
|
520
|
-
*
|
|
539
|
+
* 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.
|
|
521
540
|
* Calls `DELETE /api/v1/teams/{team_id}/members/{member_id}` through the shared IDP-aware Faiber client.
|
|
522
541
|
* @param teamId Backend path identifier `team_id`.
|
|
523
542
|
* @param memberId Backend path identifier `member_id`.
|
|
524
543
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
525
|
-
* @returns The complete Axios response, including the typed
|
|
526
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:team:manage_members.
|
|
544
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
545
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of crm:team:manage_members.
|
|
527
546
|
*/
|
|
528
|
-
apiRemoveTeamMemberDelete(teamId: Identifier, memberId: Identifier, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiRemoveTeamMemberDeleteResponseData>, unknown, {}>>;
|
|
547
|
+
apiRemoveTeamMemberDelete(teamId: Identifier, memberId: Identifier, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiRemoveTeamMemberDeleteResponseData>, unknown, {}, any>>;
|
|
529
548
|
/**
|
|
530
|
-
*
|
|
549
|
+
* 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.
|
|
531
550
|
* Calls `GET /api/v1/workflow` through the shared IDP-aware Faiber client.
|
|
532
551
|
* @param params Typed query parameters; omitted members retain backend defaults.
|
|
533
552
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
534
|
-
* @returns The complete Axios response, including the typed
|
|
535
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: workflow:read, workflow:read_all, workflow:read_own.
|
|
553
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
554
|
+
* @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.
|
|
536
555
|
*/
|
|
537
|
-
apiListWorkflowsRouteGetApiV1Workflow(params?: T.ApiListWorkflowsRouteGetApiV1WorkflowQuery, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiListWorkflowsRouteGetApiV1WorkflowResponseItem[]>, unknown, {}>>;
|
|
556
|
+
apiListWorkflowsRouteGetApiV1Workflow(params?: T.ApiListWorkflowsRouteGetApiV1WorkflowQuery, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiListWorkflowsRouteGetApiV1WorkflowResponseItem[]>, unknown, {}, any>>;
|
|
538
557
|
/**
|
|
539
|
-
*
|
|
558
|
+
* 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.
|
|
540
559
|
* Calls `POST /api/v1/workflow` through the shared IDP-aware Faiber client.
|
|
541
560
|
* @param data Typed JSON request body.
|
|
542
561
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
543
|
-
* @returns The complete Axios response, including the typed
|
|
544
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: workflow:create.
|
|
562
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
563
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of workflow:create.
|
|
545
564
|
*/
|
|
546
|
-
apiCreateWorkflowRoutePostApiV1Workflow(data: T.ApiCreateWorkflowRoutePostApiV1WorkflowInput, options?: RequestOptions<T.ApiCreateWorkflowRoutePostApiV1WorkflowInput>): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiCreateWorkflowRoutePostApiV1WorkflowResponseData>,
|
|
565
|
+
apiCreateWorkflowRoutePostApiV1Workflow(data: T.ApiCreateWorkflowRoutePostApiV1WorkflowInput, options?: RequestOptions<T.ApiCreateWorkflowRoutePostApiV1WorkflowInput>): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiCreateWorkflowRoutePostApiV1WorkflowResponseData>, import("./contracts.types.js").CrmWorkflowCreateInput, {}, any>>;
|
|
547
566
|
/**
|
|
548
|
-
*
|
|
567
|
+
* 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.
|
|
549
568
|
* Calls `GET /api/v1/workflow-node` through the shared IDP-aware Faiber client.
|
|
550
569
|
* @param params Typed query parameters; omitted members retain backend defaults.
|
|
551
570
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
552
|
-
* @returns The complete Axios response, including the typed
|
|
553
|
-
* @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.
|
|
571
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
572
|
+
* @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.
|
|
554
573
|
*/
|
|
555
|
-
apiListWorkflowNodesCompatRouteGet(params?: T.ApiListWorkflowNodesCompatRouteGetQuery, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiListWorkflowNodesCompatRouteGetResponseItem[]>, unknown, {}>>;
|
|
574
|
+
apiListWorkflowNodesCompatRouteGet(params?: T.ApiListWorkflowNodesCompatRouteGetQuery, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiListWorkflowNodesCompatRouteGetResponseItem[]>, unknown, {}, any>>;
|
|
556
575
|
/**
|
|
557
|
-
*
|
|
576
|
+
* Soft-delete a node after checking its workspace parent; this singular compatibility route returns data:true, not a deletion object.
|
|
558
577
|
* Calls `DELETE /api/v1/workflow-node/{id}` through the shared IDP-aware Faiber client.
|
|
559
578
|
* @param id Backend path identifier `id`.
|
|
560
579
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
561
|
-
* @returns The complete Axios response, including the typed
|
|
562
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: workflow_node:delete.
|
|
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 workflow_node:delete.
|
|
563
582
|
*/
|
|
564
|
-
apiDeleteWorkflowNodeCompatRouteDelete(id: Identifier, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<boolean>, unknown, {}>>;
|
|
583
|
+
apiDeleteWorkflowNodeCompatRouteDelete(id: Identifier, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<boolean>, unknown, {}, any>>;
|
|
565
584
|
/**
|
|
566
|
-
*
|
|
585
|
+
* Read a nondeleted node by UUID, then require its nondeleted parent in the configured workspace; missing parent or node returns 404.
|
|
567
586
|
* Calls `GET /api/v1/workflow-node/{id}` through the shared IDP-aware Faiber client.
|
|
568
587
|
* @param id Backend path identifier `id`.
|
|
569
588
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
570
|
-
* @returns The complete Axios response, including the typed
|
|
571
|
-
* @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.
|
|
589
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
590
|
+
* @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.
|
|
572
591
|
*/
|
|
573
|
-
apiShowWorkflowNodeCompatRouteGet(id: Identifier, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiShowWorkflowNodeCompatRouteGetResponseData>, unknown, {}>>;
|
|
592
|
+
apiShowWorkflowNodeCompatRouteGet(id: Identifier, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiShowWorkflowNodeCompatRouteGetResponseData>, unknown, {}, any>>;
|
|
574
593
|
/**
|
|
575
|
-
*
|
|
594
|
+
* Resolve a node UUID to its checked workspace parent, then patch it. Explicit null clears sla_minutes/actions; no version parameter is enforced.
|
|
576
595
|
* Calls `PATCH /api/v1/workflow-node/{id}` through the shared IDP-aware Faiber client.
|
|
577
596
|
* @param id Backend path identifier `id`.
|
|
578
597
|
* @param data Typed JSON request body.
|
|
579
598
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
580
|
-
* @returns The complete Axios response, including the typed
|
|
581
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: workflow_node:update.
|
|
599
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
600
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of workflow_node:update.
|
|
582
601
|
*/
|
|
583
|
-
apiUpdateWorkflowNodeCompatRoutePatch(id: Identifier, data: T.ApiUpdateWorkflowNodeCompatRoutePatchInput, options?: RequestOptions<T.ApiUpdateWorkflowNodeCompatRoutePatchInput>): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiUpdateWorkflowNodeCompatRoutePatchResponseData>,
|
|
602
|
+
apiUpdateWorkflowNodeCompatRoutePatch(id: Identifier, data: T.ApiUpdateWorkflowNodeCompatRoutePatchInput, options?: RequestOptions<T.ApiUpdateWorkflowNodeCompatRoutePatchInput>): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiUpdateWorkflowNodeCompatRoutePatchResponseData>, import("./contracts.types.js").CrmWorkflowNodeUpdateInput, {}, any>>;
|
|
584
603
|
/**
|
|
585
|
-
*
|
|
604
|
+
* 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.
|
|
586
605
|
* Calls `POST /api/v1/workflow-node/{id}` through the shared IDP-aware Faiber client.
|
|
587
606
|
* @param id Backend path identifier `id`.
|
|
588
607
|
* @param data Typed JSON request body.
|
|
589
608
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
590
|
-
* @returns The complete Axios response, including the typed
|
|
591
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: workflow_node:create.
|
|
609
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
610
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of workflow_node:create.
|
|
592
611
|
*/
|
|
593
|
-
apiCreateWorkflowNodeRoutePostApiV1WorkflowNodeId(id: Identifier, data: T.ApiCreateWorkflowNodeRoutePostApiV1WorkflowNodeIdInput, options?: RequestOptions<T.ApiCreateWorkflowNodeRoutePostApiV1WorkflowNodeIdInput>): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiCreateWorkflowNodeRoutePostApiV1WorkflowNodeIdResponseData>,
|
|
612
|
+
apiCreateWorkflowNodeRoutePostApiV1WorkflowNodeId(id: Identifier, data: T.ApiCreateWorkflowNodeRoutePostApiV1WorkflowNodeIdInput, options?: RequestOptions<T.ApiCreateWorkflowNodeRoutePostApiV1WorkflowNodeIdInput>): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiCreateWorkflowNodeRoutePostApiV1WorkflowNodeIdResponseData>, import("./contracts.types.js").CrmWorkflowNodeCreateInput, {}, any>>;
|
|
594
613
|
/**
|
|
595
|
-
*
|
|
614
|
+
* Resolve a node UUID to its checked workspace parent, then patch it. Explicit null clears sla_minutes/actions; no version parameter is enforced.
|
|
596
615
|
* Calls `PUT /api/v1/workflow-node/{id}` through the shared IDP-aware Faiber client.
|
|
597
616
|
* @param id Backend path identifier `id`.
|
|
598
617
|
* @param data Typed JSON request body.
|
|
599
618
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
600
|
-
* @returns The complete Axios response, including the typed
|
|
601
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: workflow_node:update.
|
|
619
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
620
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of workflow_node:update.
|
|
602
621
|
*/
|
|
603
|
-
apiUpdateWorkflowNodeCompatRoutePut(id: Identifier, data: T.ApiUpdateWorkflowNodeCompatRoutePutInput, options?: RequestOptions<T.ApiUpdateWorkflowNodeCompatRoutePutInput>): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiUpdateWorkflowNodeCompatRoutePutResponseData>,
|
|
622
|
+
apiUpdateWorkflowNodeCompatRoutePut(id: Identifier, data: T.ApiUpdateWorkflowNodeCompatRoutePutInput, options?: RequestOptions<T.ApiUpdateWorkflowNodeCompatRoutePutInput>): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiUpdateWorkflowNodeCompatRoutePutResponseData>, import("./contracts.types.js").CrmWorkflowNodeUpdateInput, {}, any>>;
|
|
604
623
|
/**
|
|
605
|
-
*
|
|
624
|
+
* Soft-delete a workspace workflow and return {id,deleted:true}; missing or previously deleted workflow returns 404.
|
|
606
625
|
* Calls `DELETE /api/v1/workflow/{id}` through the shared IDP-aware Faiber client.
|
|
607
626
|
* @param id Backend path identifier `id`.
|
|
608
627
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
609
|
-
* @returns The complete Axios response, including the typed
|
|
610
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: workflow:delete.
|
|
628
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
629
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of workflow:delete.
|
|
611
630
|
*/
|
|
612
|
-
apiDeleteWorkflowRouteDeleteApiV1WorkflowId(id: Identifier, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiDeleteWorkflowRouteDeleteApiV1WorkflowIdResponseData>, unknown, {}>>;
|
|
631
|
+
apiDeleteWorkflowRouteDeleteApiV1WorkflowId(id: Identifier, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiDeleteWorkflowRouteDeleteApiV1WorkflowIdResponseData>, unknown, {}, any>>;
|
|
613
632
|
/**
|
|
614
|
-
*
|
|
633
|
+
* Read one nondeleted workspace workflow by UUID; absent or foreign-workspace IDs return 404.
|
|
615
634
|
* Calls `GET /api/v1/workflow/{id}` through the shared IDP-aware Faiber client.
|
|
616
635
|
* @param id Backend path identifier `id`.
|
|
617
636
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
618
|
-
* @returns The complete Axios response, including the typed
|
|
619
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: workflow:read, workflow:read_all, workflow:read_own.
|
|
637
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
638
|
+
* @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.
|
|
620
639
|
*/
|
|
621
|
-
apiShowWorkflowRouteGetApiV1WorkflowId(id: Identifier, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiShowWorkflowRouteGetApiV1WorkflowIdResponseData>, unknown, {}>>;
|
|
640
|
+
apiShowWorkflowRouteGetApiV1WorkflowId(id: Identifier, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiShowWorkflowRouteGetApiV1WorkflowIdResponseData>, unknown, {}, any>>;
|
|
622
641
|
/**
|
|
623
|
-
*
|
|
642
|
+
* 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.
|
|
624
643
|
* Calls `PATCH /api/v1/workflow/{id}` through the shared IDP-aware Faiber client.
|
|
625
644
|
* @param id Backend path identifier `id`.
|
|
626
645
|
* @param data Typed JSON request body.
|
|
627
646
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
628
|
-
* @returns The complete Axios response, including the typed
|
|
629
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: workflow:update.
|
|
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 workflow:update.
|
|
630
649
|
*/
|
|
631
|
-
apiUpdateWorkflowRoutePatchApiV1WorkflowId(id: Identifier, data: T.ApiUpdateWorkflowRoutePatchApiV1WorkflowIdInput, options?: RequestOptions<T.ApiUpdateWorkflowRoutePatchApiV1WorkflowIdInput>): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiUpdateWorkflowRoutePatchApiV1WorkflowIdResponseData>,
|
|
650
|
+
apiUpdateWorkflowRoutePatchApiV1WorkflowId(id: Identifier, data: T.ApiUpdateWorkflowRoutePatchApiV1WorkflowIdInput, options?: RequestOptions<T.ApiUpdateWorkflowRoutePatchApiV1WorkflowIdInput>): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiUpdateWorkflowRoutePatchApiV1WorkflowIdResponseData>, import("./contracts.types.js").CrmWorkflowUpdateInput, {}, any>>;
|
|
632
651
|
/**
|
|
633
|
-
*
|
|
652
|
+
* 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.
|
|
634
653
|
* Calls `PUT /api/v1/workflow/{id}` through the shared IDP-aware Faiber client.
|
|
635
654
|
* @param id Backend path identifier `id`.
|
|
636
655
|
* @param data Typed JSON request body.
|
|
637
656
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
638
|
-
* @returns The complete Axios response, including the typed
|
|
639
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: workflow:update.
|
|
657
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
658
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of workflow:update.
|
|
640
659
|
*/
|
|
641
|
-
apiUpdateWorkflowRoutePut(id: Identifier, data: T.ApiUpdateWorkflowRoutePutInput, options?: RequestOptions<T.ApiUpdateWorkflowRoutePutInput>): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiUpdateWorkflowRoutePutResponseData>,
|
|
660
|
+
apiUpdateWorkflowRoutePut(id: Identifier, data: T.ApiUpdateWorkflowRoutePutInput, options?: RequestOptions<T.ApiUpdateWorkflowRoutePutInput>): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiUpdateWorkflowRoutePutResponseData>, import("./contracts.types.js").CrmWorkflowUpdateInput, {}, any>>;
|
|
642
661
|
/**
|
|
643
|
-
*
|
|
662
|
+
* 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.
|
|
644
663
|
* Calls `GET /api/v1/workflows` through the shared IDP-aware Faiber client.
|
|
645
664
|
* @param params Typed query parameters; omitted members retain backend defaults.
|
|
646
665
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
647
|
-
* @returns The complete Axios response, including the typed
|
|
648
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: workflow:read, workflow:read_all, workflow:read_own.
|
|
666
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
667
|
+
* @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.
|
|
649
668
|
*/
|
|
650
|
-
apiListWorkflowsRouteGetApiV1Workflows(params?: T.ApiListWorkflowsRouteGetApiV1WorkflowsQuery, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiListWorkflowsRouteGetApiV1WorkflowsResponseItem[]>, unknown, {}>>;
|
|
669
|
+
apiListWorkflowsRouteGetApiV1Workflows(params?: T.ApiListWorkflowsRouteGetApiV1WorkflowsQuery, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiListWorkflowsRouteGetApiV1WorkflowsResponseItem[]>, unknown, {}, any>>;
|
|
651
670
|
/**
|
|
652
|
-
*
|
|
671
|
+
* 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.
|
|
653
672
|
* Calls `POST /api/v1/workflows` through the shared IDP-aware Faiber client.
|
|
654
673
|
* @param data Typed JSON request body.
|
|
655
674
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
656
|
-
* @returns The complete Axios response, including the typed
|
|
657
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: workflow:create.
|
|
675
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
676
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of workflow:create.
|
|
658
677
|
*/
|
|
659
|
-
apiCreateWorkflowRoutePostApiV1Workflows(data: T.ApiCreateWorkflowRoutePostApiV1WorkflowsInput, options?: RequestOptions<T.ApiCreateWorkflowRoutePostApiV1WorkflowsInput>): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiCreateWorkflowRoutePostApiV1WorkflowsResponseData>,
|
|
678
|
+
apiCreateWorkflowRoutePostApiV1Workflows(data: T.ApiCreateWorkflowRoutePostApiV1WorkflowsInput, options?: RequestOptions<T.ApiCreateWorkflowRoutePostApiV1WorkflowsInput>): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiCreateWorkflowRoutePostApiV1WorkflowsResponseData>, import("./contracts.types.js").CrmWorkflowCreateInput, {}, any>>;
|
|
660
679
|
/**
|
|
661
|
-
*
|
|
680
|
+
* Soft-delete a workspace workflow and return {id,deleted:true}; missing or previously deleted workflow returns 404.
|
|
662
681
|
* Calls `DELETE /api/v1/workflows/{id}` through the shared IDP-aware Faiber client.
|
|
663
682
|
* @param id Backend path identifier `id`.
|
|
664
683
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
665
|
-
* @returns The complete Axios response, including the typed
|
|
666
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: workflow:delete.
|
|
684
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
685
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of workflow:delete.
|
|
667
686
|
*/
|
|
668
|
-
apiDeleteWorkflowRouteDeleteApiV1WorkflowsId(id: Identifier, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiDeleteWorkflowRouteDeleteApiV1WorkflowsIdResponseData>, unknown, {}>>;
|
|
687
|
+
apiDeleteWorkflowRouteDeleteApiV1WorkflowsId(id: Identifier, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiDeleteWorkflowRouteDeleteApiV1WorkflowsIdResponseData>, unknown, {}, any>>;
|
|
669
688
|
/**
|
|
670
|
-
*
|
|
689
|
+
* Read one nondeleted workspace workflow by UUID; absent or foreign-workspace IDs return 404.
|
|
671
690
|
* Calls `GET /api/v1/workflows/{id}` through the shared IDP-aware Faiber client.
|
|
672
691
|
* @param id Backend path identifier `id`.
|
|
673
692
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
674
|
-
* @returns The complete Axios response, including the typed
|
|
675
|
-
* @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.
|
|
676
695
|
*/
|
|
677
|
-
apiShowWorkflowRouteGetApiV1WorkflowsId(id: Identifier, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiShowWorkflowRouteGetApiV1WorkflowsIdResponseData>, unknown, {}>>;
|
|
696
|
+
apiShowWorkflowRouteGetApiV1WorkflowsId(id: Identifier, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiShowWorkflowRouteGetApiV1WorkflowsIdResponseData>, unknown, {}, any>>;
|
|
678
697
|
/**
|
|
679
|
-
*
|
|
698
|
+
* 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.
|
|
680
699
|
* Calls `PATCH /api/v1/workflows/{id}` through the shared IDP-aware Faiber client.
|
|
681
700
|
* @param id Backend path identifier `id`.
|
|
682
701
|
* @param data Typed JSON request body.
|
|
683
702
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
684
|
-
* @returns The complete Axios response, including the typed
|
|
685
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: workflow:update.
|
|
703
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
704
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of workflow:update.
|
|
686
705
|
*/
|
|
687
|
-
apiUpdateWorkflowRoutePatchApiV1WorkflowsId(id: Identifier, data: T.ApiUpdateWorkflowRoutePatchApiV1WorkflowsIdInput, options?: RequestOptions<T.ApiUpdateWorkflowRoutePatchApiV1WorkflowsIdInput>): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiUpdateWorkflowRoutePatchApiV1WorkflowsIdResponseData>,
|
|
706
|
+
apiUpdateWorkflowRoutePatchApiV1WorkflowsId(id: Identifier, data: T.ApiUpdateWorkflowRoutePatchApiV1WorkflowsIdInput, options?: RequestOptions<T.ApiUpdateWorkflowRoutePatchApiV1WorkflowsIdInput>): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiUpdateWorkflowRoutePatchApiV1WorkflowsIdResponseData>, import("./contracts.types.js").CrmWorkflowUpdateInput, {}, any>>;
|
|
688
707
|
/**
|
|
689
|
-
*
|
|
708
|
+
* List team/user assignments in this workspace for the path workflow UUID, ordered by creation and UUID; does not check parent existence.
|
|
690
709
|
* Calls `GET /api/v1/workflows/{id}/assignments` through the shared IDP-aware Faiber client.
|
|
691
710
|
* @param id Backend path identifier `id`.
|
|
692
711
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
693
|
-
* @returns The complete Axios response, including the typed
|
|
694
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:workflow_assignment:read.
|
|
712
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
713
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of crm:workflow_assignment:read.
|
|
695
714
|
*/
|
|
696
|
-
apiListWorkflowAssignmentsGet(id: Identifier, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiListWorkflowAssignmentsGetResponseItem[]>, unknown, {}>>;
|
|
715
|
+
apiListWorkflowAssignmentsGet(id: Identifier, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiListWorkflowAssignmentsGetResponseItem[]>, unknown, {}, any>>;
|
|
697
716
|
/**
|
|
698
|
-
*
|
|
717
|
+
* 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.
|
|
699
718
|
* Calls `POST /api/v1/workflows/{id}/assignments` through the shared IDP-aware Faiber client.
|
|
700
719
|
* @param id Backend path identifier `id`.
|
|
701
720
|
* @param data Typed JSON request body.
|
|
702
721
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
703
|
-
* @returns The complete Axios response, including the typed
|
|
704
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:workflow_assignment:manage.
|
|
722
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
723
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of crm:workflow_assignment:manage.
|
|
705
724
|
*/
|
|
706
|
-
apiCreateWorkflowAssignmentPost(id: Identifier, data: T.ApiCreateWorkflowAssignmentPostInput, options?: RequestOptions<T.ApiCreateWorkflowAssignmentPostInput>): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiCreateWorkflowAssignmentPostResponseData>, T.ApiCreateWorkflowAssignmentPostInput, {}>>;
|
|
725
|
+
apiCreateWorkflowAssignmentPost(id: Identifier, data: T.ApiCreateWorkflowAssignmentPostInput, options?: RequestOptions<T.ApiCreateWorkflowAssignmentPostInput>): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiCreateWorkflowAssignmentPostResponseData>, T.ApiCreateWorkflowAssignmentPostInput, {}, any>>;
|
|
707
726
|
/**
|
|
708
|
-
*
|
|
727
|
+
* 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.
|
|
709
728
|
* Calls `DELETE /api/v1/workflows/{workflow_id}/assignments/{assignment_id}` through the shared IDP-aware Faiber client.
|
|
710
729
|
* @param workflowId Backend path identifier `workflow_id`.
|
|
711
730
|
* @param assignmentId Backend path identifier `assignment_id`.
|
|
712
731
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
713
|
-
* @returns The complete Axios response, including the typed
|
|
714
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:workflow_assignment:manage.
|
|
732
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
733
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of crm:workflow_assignment:manage.
|
|
715
734
|
*/
|
|
716
|
-
apiDeleteWorkflowAssignmentDelete(workflowId: Identifier, assignmentId: Identifier, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiDeleteWorkflowAssignmentDeleteResponseData>, unknown, {}>>;
|
|
735
|
+
apiDeleteWorkflowAssignmentDelete(workflowId: Identifier, assignmentId: Identifier, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiDeleteWorkflowAssignmentDeleteResponseData>, unknown, {}, any>>;
|
|
717
736
|
/**
|
|
718
|
-
*
|
|
737
|
+
* 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.
|
|
719
738
|
* Calls `GET /api/v1/workflows/{workflow_id}/nodes` through the shared IDP-aware Faiber client.
|
|
720
739
|
* @param workflowId Backend path identifier `workflow_id`.
|
|
721
740
|
* @param params Typed query parameters; omitted members retain backend defaults.
|
|
722
741
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
723
|
-
* @returns The complete Axios response, including the typed
|
|
724
|
-
* @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.
|
|
742
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
743
|
+
* @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.
|
|
725
744
|
*/
|
|
726
|
-
apiListWorkflowNodesRouteGet(workflowId: Identifier, params?: T.ApiListWorkflowNodesRouteGetQuery, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiListWorkflowNodesRouteGetResponseItem[]>, unknown, {}>>;
|
|
745
|
+
apiListWorkflowNodesRouteGet(workflowId: Identifier, params?: T.ApiListWorkflowNodesRouteGetQuery, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiListWorkflowNodesRouteGetResponseItem[]>, unknown, {}, any>>;
|
|
727
746
|
/**
|
|
728
|
-
*
|
|
747
|
+
* 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.
|
|
729
748
|
* Calls `POST /api/v1/workflows/{workflow_id}/nodes` through the shared IDP-aware Faiber client.
|
|
730
749
|
* @param workflowId Backend path identifier `workflow_id`.
|
|
731
750
|
* @param data Typed JSON request body.
|
|
732
751
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
733
|
-
* @returns The complete Axios response, including the typed
|
|
734
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: workflow_node:create.
|
|
752
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
753
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of workflow_node:create.
|
|
735
754
|
*/
|
|
736
|
-
apiCreateWorkflowNodeRoutePostApiV1WorkflowsWorkflowIdNodes(workflowId: Identifier, data: T.ApiCreateWorkflowNodeRoutePostApiV1WorkflowsWorkflowIdNodesInput, options?: RequestOptions<T.ApiCreateWorkflowNodeRoutePostApiV1WorkflowsWorkflowIdNodesInput>): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiCreateWorkflowNodeRoutePostApiV1WorkflowsWorkflowIdNodesResponseData>,
|
|
755
|
+
apiCreateWorkflowNodeRoutePostApiV1WorkflowsWorkflowIdNodes(workflowId: Identifier, data: T.ApiCreateWorkflowNodeRoutePostApiV1WorkflowsWorkflowIdNodesInput, options?: RequestOptions<T.ApiCreateWorkflowNodeRoutePostApiV1WorkflowsWorkflowIdNodesInput>): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiCreateWorkflowNodeRoutePostApiV1WorkflowsWorkflowIdNodesResponseData>, import("./contracts.types.js").CrmWorkflowNodeCreateInput, {}, any>>;
|
|
737
756
|
/**
|
|
738
|
-
*
|
|
757
|
+
* Soft-delete a node scoped to its checked workspace parent; return {id,deleted:true}; missing parent or node returns 404.
|
|
739
758
|
* Calls `DELETE /api/v1/workflows/{workflow_id}/nodes/{node_id}` through the shared IDP-aware Faiber client.
|
|
740
759
|
* @param workflowId Backend path identifier `workflow_id`.
|
|
741
760
|
* @param nodeId Backend path identifier `node_id`.
|
|
742
761
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
743
|
-
* @returns The complete Axios response, including the typed
|
|
744
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: workflow_node:delete.
|
|
762
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
763
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of workflow_node:delete.
|
|
745
764
|
*/
|
|
746
|
-
apiDeleteWorkflowNodeRouteDelete(workflowId: Identifier, nodeId: Identifier, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiDeleteWorkflowNodeRouteDeleteResponseData>, unknown, {}>>;
|
|
765
|
+
apiDeleteWorkflowNodeRouteDelete(workflowId: Identifier, nodeId: Identifier, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiDeleteWorkflowNodeRouteDeleteResponseData>, unknown, {}, any>>;
|
|
747
766
|
/**
|
|
748
|
-
*
|
|
767
|
+
* Read a nondeleted node scoped to a nondeleted workspace parent workflow; missing parent or node returns 404.
|
|
749
768
|
* Calls `GET /api/v1/workflows/{workflow_id}/nodes/{node_id}` through the shared IDP-aware Faiber client.
|
|
750
769
|
* @param workflowId Backend path identifier `workflow_id`.
|
|
751
770
|
* @param nodeId Backend path identifier `node_id`.
|
|
752
771
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
753
|
-
* @returns The complete Axios response, including the typed
|
|
754
|
-
* @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.
|
|
772
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
773
|
+
* @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.
|
|
755
774
|
*/
|
|
756
|
-
apiShowWorkflowNodeRouteGet(workflowId: Identifier, nodeId: Identifier, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiShowWorkflowNodeRouteGetResponseData>, unknown, {}>>;
|
|
775
|
+
apiShowWorkflowNodeRouteGet(workflowId: Identifier, nodeId: Identifier, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiShowWorkflowNodeRouteGetResponseData>, unknown, {}, any>>;
|
|
757
776
|
/**
|
|
758
|
-
*
|
|
777
|
+
* 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.
|
|
759
778
|
* Calls `PATCH /api/v1/workflows/{workflow_id}/nodes/{node_id}` through the shared IDP-aware Faiber client.
|
|
760
779
|
* @param workflowId Backend path identifier `workflow_id`.
|
|
761
780
|
* @param nodeId Backend path identifier `node_id`.
|
|
762
781
|
* @param data Typed JSON request body.
|
|
763
782
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
764
|
-
* @returns The complete Axios response, including the typed
|
|
765
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: workflow_node:update.
|
|
783
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
784
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of workflow_node:update.
|
|
766
785
|
*/
|
|
767
|
-
apiUpdateWorkflowNodeRoutePatch(workflowId: Identifier, nodeId: Identifier, data: T.ApiUpdateWorkflowNodeRoutePatchInput, options?: RequestOptions<T.ApiUpdateWorkflowNodeRoutePatchInput>): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiUpdateWorkflowNodeRoutePatchResponseData>,
|
|
786
|
+
apiUpdateWorkflowNodeRoutePatch(workflowId: Identifier, nodeId: Identifier, data: T.ApiUpdateWorkflowNodeRoutePatchInput, options?: RequestOptions<T.ApiUpdateWorkflowNodeRoutePatchInput>): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiUpdateWorkflowNodeRoutePatchResponseData>, import("./contracts.types.js").CrmWorkflowNodeUpdateInput, {}, any>>;
|
|
768
787
|
/**
|
|
769
|
-
*
|
|
788
|
+
* List nondeleted workflows assigned to the caller directly or through legacy/current team membership, ordered by priority; includes inactive entries.
|
|
770
789
|
* Calls `GET /api/v1/workflows/member-based` through the shared IDP-aware Faiber client.
|
|
771
790
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
772
|
-
* @returns The complete Axios response, including the typed
|
|
773
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:pipeline:read, workflow:read, workflow:read_own.
|
|
791
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
792
|
+
* @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.
|
|
774
793
|
*/
|
|
775
|
-
apiMemberWorkflowsGet(options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiMemberWorkflowsGetResponseItem[]>, unknown, {}>>;
|
|
794
|
+
apiMemberWorkflowsGet(options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiMemberWorkflowsGetResponseItem[]>, unknown, {}, any>>;
|
|
776
795
|
/**
|
|
777
|
-
*
|
|
796
|
+
* 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.
|
|
778
797
|
* Calls `GET /api/v1/worklog` through the shared IDP-aware Faiber client.
|
|
779
798
|
* @param params Typed query parameters; omitted members retain backend defaults.
|
|
780
799
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
781
|
-
* @returns The complete Axios response, including the typed
|
|
782
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: worklog:read, worklog:read_all, worklog:read_own.
|
|
800
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
801
|
+
* @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.
|
|
783
802
|
*/
|
|
784
|
-
apiWorklogsGet(params?: T.ApiWorklogsGetQuery, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiWorklogsGetResponseItem[]>, unknown, {}>>;
|
|
803
|
+
apiWorklogsGet(params?: T.ApiWorklogsGetQuery, options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiWorklogsGetResponseItem[]>, unknown, {}, any>>;
|
|
785
804
|
/**
|
|
786
|
-
*
|
|
805
|
+
* 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.
|
|
787
806
|
* Calls `PATCH /api/v1/workspace/settings` through the shared IDP-aware Faiber client.
|
|
788
807
|
* @param data Typed JSON request body.
|
|
789
808
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
790
|
-
* @returns The complete Axios response, including the typed
|
|
791
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:settings:update.
|
|
809
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
810
|
+
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission: crm:admin or any one of crm:settings:update.
|
|
792
811
|
*/
|
|
793
|
-
apiUpdateWorkspacePatch(data: T.ApiUpdateWorkspacePatchInput, options?: RequestOptions<T.ApiUpdateWorkspacePatchInput>): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiUpdateWorkspacePatchResponseData>,
|
|
812
|
+
apiUpdateWorkspacePatch(data: T.ApiUpdateWorkspacePatchInput, options?: RequestOptions<T.ApiUpdateWorkspacePatchInput>): Promise<import("axios").AxiosResponse<import("./types.js").CrmApiResponse<T.ApiUpdateWorkspacePatchResponseData>, import("./contracts.types.js").CrmWorkspaceUpdateInput, {}, any>>;
|
|
794
813
|
/**
|
|
795
|
-
*
|
|
814
|
+
* Read process liveness and package version in the legacy status/message/data envelope; no dependency probe.
|
|
796
815
|
* Calls `GET /health` through the shared IDP-aware Faiber client.
|
|
797
816
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
798
|
-
* @returns The complete Axios response, including the typed
|
|
799
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission:
|
|
817
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
818
|
+
* @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.
|
|
800
819
|
*/
|
|
801
|
-
routerStatusRouteGetHealth(options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").
|
|
820
|
+
routerStatusRouteGetHealth(options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").CrmHealthResponse, unknown, {}, any>>;
|
|
802
821
|
/**
|
|
803
|
-
*
|
|
822
|
+
* Read process liveness and package version in the legacy status/message/data envelope; no dependency probe.
|
|
804
823
|
* Calls `GET /livez` through the shared IDP-aware Faiber client.
|
|
805
824
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
806
|
-
* @returns The complete Axios response, including the typed
|
|
807
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission:
|
|
825
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
826
|
+
* @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.
|
|
808
827
|
*/
|
|
809
|
-
routerStatusRouteGetLivez(options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").
|
|
828
|
+
routerStatusRouteGetLivez(options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").CrmHealthResponse, unknown, {}, any>>;
|
|
810
829
|
/**
|
|
811
|
-
*
|
|
830
|
+
* Probe database and broker readiness; return legacy status/message/data with dependency booleans and HTTP 503 if either dependency is unavailable.
|
|
812
831
|
* Calls `GET /readyz` through the shared IDP-aware Faiber client.
|
|
813
832
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
814
|
-
* @returns The complete Axios response, including the typed
|
|
815
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission:
|
|
833
|
+
* @returns The complete Axios response, including the typed handler payload, status, and headers.
|
|
834
|
+
* @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.
|
|
816
835
|
*/
|
|
817
|
-
routerReadinessRouteGet(options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").
|
|
836
|
+
routerReadinessRouteGet(options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").CrmReadinessResponse, unknown, {}, any>>;
|
|
818
837
|
/**
|
|
819
|
-
*
|
|
838
|
+
* Read process liveness and package version in the legacy status/message/data envelope; no dependency probe.
|
|
820
839
|
* Calls `GET /up` through the shared IDP-aware Faiber client.
|
|
821
840
|
* @param options Axios headers, timeout, cancellation signal, credentials, adapter, and other request options.
|
|
822
|
-
* @returns The complete Axios response, including the typed
|
|
823
|
-
* @throws AxiosError for authentication, permission, validation, not-found, conflict, or transport failures; required permission:
|
|
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: No local handler permission check; deployment/gateway authority must be independently verified.
|
|
824
843
|
*/
|
|
825
|
-
routerStatusRouteGetUp(options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").
|
|
844
|
+
routerStatusRouteGetUp(options?: RequestOptions): Promise<import("axios").AxiosResponse<import("./types.js").CrmHealthResponse, unknown, {}, any>>;
|
|
826
845
|
}
|
|
827
846
|
//# sourceMappingURL=operations.d.ts.map
|