@iblai/iblai-api 4.415.0-ai → 4.416.0-ai
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/dist/index.cjs.js +648 -30
- package/dist/index.cjs.js.map +1 -1
- package/dist/index.esm.js +649 -31
- package/dist/index.esm.js.map +1 -1
- package/dist/index.umd.js +648 -30
- package/dist/index.umd.js.map +1 -1
- package/dist/types/index.d.ts +27 -1
- package/dist/types/models/Activity.d.ts +6 -2
- package/dist/types/models/Deal.d.ts +14 -2
- package/dist/types/models/DealBoard.d.ts +7 -0
- package/dist/types/models/DealBoardStage.d.ts +19 -0
- package/dist/types/models/DirEnum.d.ts +8 -0
- package/dist/types/models/Favorite.d.ts +28 -0
- package/dist/types/models/HistoryEntry.d.ts +15 -0
- package/dist/types/models/HistoryEntryActionEnum.d.ts +12 -0
- package/dist/types/models/ObjectTypeEnum.d.ts +12 -0
- package/dist/types/models/Overview.d.ts +24 -0
- package/dist/types/models/OverviewActivities.d.ts +5 -0
- package/dist/types/models/OverviewCount.d.ts +3 -0
- package/dist/types/models/OverviewDeals.d.ts +22 -0
- package/dist/types/models/OverviewMonth.d.ts +10 -0
- package/dist/types/models/OverviewStage.d.ts +13 -0
- package/dist/types/models/PaginatedFavoriteList.d.ts +7 -0
- package/dist/types/models/PaginatedSavedViewList.d.ts +7 -0
- package/dist/types/models/PatchedActivity.d.ts +6 -2
- package/dist/types/models/PatchedDeal.d.ts +14 -2
- package/dist/types/models/PatchedPerson.d.ts +4 -0
- package/dist/types/models/PatchedPipeline.d.ts +1 -1
- package/dist/types/models/PatchedSavedView.d.ts +41 -0
- package/dist/types/models/Person.d.ts +4 -0
- package/dist/types/models/Pipeline.d.ts +1 -1
- package/dist/types/models/PipelineStageReorderRequest.d.ts +6 -0
- package/dist/types/models/SavedView.d.ts +41 -0
- package/dist/types/models/SavedViewTypeEnum.d.ts +8 -0
- package/dist/types/models/SearchDeal.d.ts +40 -0
- package/dist/types/models/SearchOrganization.d.ts +10 -0
- package/dist/types/models/SearchPerson.d.ts +33 -0
- package/dist/types/models/SearchResponse.d.ts +12 -0
- package/dist/types/models/{DealStatusEnum.d.ts → Status05cEnum.d.ts} +1 -1
- package/dist/types/models/_Column.d.ts +7 -0
- package/dist/types/models/_Filter.d.ts +8 -0
- package/dist/types/models/_Sort.d.ts +5 -0
- package/dist/types/services/CrmService.d.ts +523 -12
- package/package.json +1 -1
- package/sdk_schema.yml +1905 -27
- package/src/core/OpenAPI.ts +1 -1
- package/src/index.ts +27 -1
- package/src/models/Activity.ts +6 -2
- package/src/models/Deal.ts +14 -2
- package/src/models/DealBoard.ts +12 -0
- package/src/models/DealBoardStage.ts +24 -0
- package/src/models/DirEnum.ts +12 -0
- package/src/models/Favorite.ts +33 -0
- package/src/models/HistoryEntry.ts +20 -0
- package/src/models/HistoryEntryActionEnum.ts +16 -0
- package/src/models/ObjectTypeEnum.ts +16 -0
- package/src/models/Overview.ts +29 -0
- package/src/models/OverviewActivities.ts +10 -0
- package/src/models/OverviewCount.ts +8 -0
- package/src/models/OverviewDeals.ts +27 -0
- package/src/models/OverviewMonth.ts +15 -0
- package/src/models/OverviewStage.ts +18 -0
- package/src/models/PaginatedFavoriteList.ts +12 -0
- package/src/models/PaginatedSavedViewList.ts +12 -0
- package/src/models/PatchedActivity.ts +6 -2
- package/src/models/PatchedDeal.ts +14 -2
- package/src/models/PatchedPerson.ts +4 -0
- package/src/models/PatchedPipeline.ts +1 -1
- package/src/models/PatchedSavedView.ts +46 -0
- package/src/models/Person.ts +4 -0
- package/src/models/Pipeline.ts +1 -1
- package/src/models/PipelineStageReorderRequest.ts +11 -0
- package/src/models/SavedView.ts +46 -0
- package/src/models/SavedViewTypeEnum.ts +12 -0
- package/src/models/SearchDeal.ts +45 -0
- package/src/models/SearchOrganization.ts +15 -0
- package/src/models/SearchPerson.ts +38 -0
- package/src/models/SearchResponse.ts +17 -0
- package/src/models/{DealStatusEnum.ts → Status05cEnum.ts} +1 -1
- package/src/models/_Column.ts +12 -0
- package/src/models/_Filter.ts +13 -0
- package/src/models/_Sort.ts +10 -0
- package/src/services/CrmService.ts +924 -4
package/dist/index.cjs.js
CHANGED
|
@@ -110,7 +110,7 @@ class CancelablePromise {
|
|
|
110
110
|
|
|
111
111
|
const OpenAPI = {
|
|
112
112
|
BASE: 'https://base.manager.iblai.app',
|
|
113
|
-
VERSION: '4.
|
|
113
|
+
VERSION: '4.416.0-ai-plus',
|
|
114
114
|
WITH_CREDENTIALS: false,
|
|
115
115
|
CREDENTIALS: 'include',
|
|
116
116
|
TOKEN: undefined,
|
|
@@ -585,22 +585,6 @@ exports.DataTypeEnum = void 0;
|
|
|
585
585
|
DataTypeEnum["CATEGORICAL"] = "CATEGORICAL";
|
|
586
586
|
})(exports.DataTypeEnum || (exports.DataTypeEnum = {}));
|
|
587
587
|
|
|
588
|
-
/* generated using openapi-typescript-codegen -- do not edit */
|
|
589
|
-
/* istanbul ignore file */
|
|
590
|
-
/* tslint:disable */
|
|
591
|
-
/* eslint-disable */
|
|
592
|
-
/**
|
|
593
|
-
* * `open` - Open
|
|
594
|
-
* * `won` - Won
|
|
595
|
-
* * `lost` - Lost
|
|
596
|
-
*/
|
|
597
|
-
exports.DealStatusEnum = void 0;
|
|
598
|
-
(function (DealStatusEnum) {
|
|
599
|
-
DealStatusEnum["OPEN"] = "open";
|
|
600
|
-
DealStatusEnum["WON"] = "won";
|
|
601
|
-
DealStatusEnum["LOST"] = "lost";
|
|
602
|
-
})(exports.DealStatusEnum || (exports.DealStatusEnum = {}));
|
|
603
|
-
|
|
604
588
|
/* generated using openapi-typescript-codegen -- do not edit */
|
|
605
589
|
/* istanbul ignore file */
|
|
606
590
|
/* tslint:disable */
|
|
@@ -653,6 +637,20 @@ exports.DirectionEnum = void 0;
|
|
|
653
637
|
DirectionEnum["IMPORT"] = "import";
|
|
654
638
|
})(exports.DirectionEnum || (exports.DirectionEnum = {}));
|
|
655
639
|
|
|
640
|
+
/* generated using openapi-typescript-codegen -- do not edit */
|
|
641
|
+
/* istanbul ignore file */
|
|
642
|
+
/* tslint:disable */
|
|
643
|
+
/* eslint-disable */
|
|
644
|
+
/**
|
|
645
|
+
* * `asc` - asc
|
|
646
|
+
* * `desc` - desc
|
|
647
|
+
*/
|
|
648
|
+
exports.DirEnum = void 0;
|
|
649
|
+
(function (DirEnum) {
|
|
650
|
+
DirEnum["ASC"] = "asc";
|
|
651
|
+
DirEnum["DESC"] = "desc";
|
|
652
|
+
})(exports.DirEnum || (exports.DirEnum = {}));
|
|
653
|
+
|
|
656
654
|
/* generated using openapi-typescript-codegen -- do not edit */
|
|
657
655
|
/* istanbul ignore file */
|
|
658
656
|
/* tslint:disable */
|
|
@@ -1003,6 +1001,24 @@ exports.HeygenVideoCreateTypeEnum = void 0;
|
|
|
1003
1001
|
HeygenVideoCreateTypeEnum["IMAGE"] = "image";
|
|
1004
1002
|
})(exports.HeygenVideoCreateTypeEnum || (exports.HeygenVideoCreateTypeEnum = {}));
|
|
1005
1003
|
|
|
1004
|
+
/* generated using openapi-typescript-codegen -- do not edit */
|
|
1005
|
+
/* istanbul ignore file */
|
|
1006
|
+
/* tslint:disable */
|
|
1007
|
+
/* eslint-disable */
|
|
1008
|
+
/**
|
|
1009
|
+
* * `create` - create
|
|
1010
|
+
* * `update` - update
|
|
1011
|
+
* * `delete` - delete
|
|
1012
|
+
* * `access` - access
|
|
1013
|
+
*/
|
|
1014
|
+
exports.HistoryEntryActionEnum = void 0;
|
|
1015
|
+
(function (HistoryEntryActionEnum) {
|
|
1016
|
+
HistoryEntryActionEnum["CREATE"] = "create";
|
|
1017
|
+
HistoryEntryActionEnum["UPDATE"] = "update";
|
|
1018
|
+
HistoryEntryActionEnum["DELETE"] = "delete";
|
|
1019
|
+
HistoryEntryActionEnum["ACCESS"] = "access";
|
|
1020
|
+
})(exports.HistoryEntryActionEnum || (exports.HistoryEntryActionEnum = {}));
|
|
1021
|
+
|
|
1006
1022
|
/* generated using openapi-typescript-codegen -- do not edit */
|
|
1007
1023
|
/* istanbul ignore file */
|
|
1008
1024
|
/* tslint:disable */
|
|
@@ -1359,6 +1375,24 @@ exports.NotificationSourceTypeEnum = void 0;
|
|
|
1359
1375
|
NotificationSourceTypeEnum["USERGROUP"] = "usergroup";
|
|
1360
1376
|
})(exports.NotificationSourceTypeEnum || (exports.NotificationSourceTypeEnum = {}));
|
|
1361
1377
|
|
|
1378
|
+
/* generated using openapi-typescript-codegen -- do not edit */
|
|
1379
|
+
/* istanbul ignore file */
|
|
1380
|
+
/* tslint:disable */
|
|
1381
|
+
/* eslint-disable */
|
|
1382
|
+
/**
|
|
1383
|
+
* * `persons` - Persons
|
|
1384
|
+
* * `organizations` - Organizations
|
|
1385
|
+
* * `deals` - Deals
|
|
1386
|
+
* * `activities` - Activities
|
|
1387
|
+
*/
|
|
1388
|
+
exports.ObjectTypeEnum = void 0;
|
|
1389
|
+
(function (ObjectTypeEnum) {
|
|
1390
|
+
ObjectTypeEnum["PERSONS"] = "persons";
|
|
1391
|
+
ObjectTypeEnum["ORGANIZATIONS"] = "organizations";
|
|
1392
|
+
ObjectTypeEnum["DEALS"] = "deals";
|
|
1393
|
+
ObjectTypeEnum["ACTIVITIES"] = "activities";
|
|
1394
|
+
})(exports.ObjectTypeEnum || (exports.ObjectTypeEnum = {}));
|
|
1395
|
+
|
|
1362
1396
|
/* generated using openapi-typescript-codegen -- do not edit */
|
|
1363
1397
|
/* istanbul ignore file */
|
|
1364
1398
|
/* tslint:disable */
|
|
@@ -1775,6 +1809,20 @@ exports.RoleEnum = void 0;
|
|
|
1775
1809
|
RoleEnum["DATASET_CURATOR"] = "dataset_curator";
|
|
1776
1810
|
})(exports.RoleEnum || (exports.RoleEnum = {}));
|
|
1777
1811
|
|
|
1812
|
+
/* generated using openapi-typescript-codegen -- do not edit */
|
|
1813
|
+
/* istanbul ignore file */
|
|
1814
|
+
/* tslint:disable */
|
|
1815
|
+
/* eslint-disable */
|
|
1816
|
+
/**
|
|
1817
|
+
* * `table` - Table
|
|
1818
|
+
* * `kanban` - Kanban
|
|
1819
|
+
*/
|
|
1820
|
+
exports.SavedViewTypeEnum = void 0;
|
|
1821
|
+
(function (SavedViewTypeEnum) {
|
|
1822
|
+
SavedViewTypeEnum["TABLE"] = "table";
|
|
1823
|
+
SavedViewTypeEnum["KANBAN"] = "kanban";
|
|
1824
|
+
})(exports.SavedViewTypeEnum || (exports.SavedViewTypeEnum = {}));
|
|
1825
|
+
|
|
1778
1826
|
/* generated using openapi-typescript-codegen -- do not edit */
|
|
1779
1827
|
/* istanbul ignore file */
|
|
1780
1828
|
/* tslint:disable */
|
|
@@ -1931,6 +1979,22 @@ exports.StateEnum = void 0;
|
|
|
1931
1979
|
StateEnum["EXPIRED"] = "expired";
|
|
1932
1980
|
})(exports.StateEnum || (exports.StateEnum = {}));
|
|
1933
1981
|
|
|
1982
|
+
/* generated using openapi-typescript-codegen -- do not edit */
|
|
1983
|
+
/* istanbul ignore file */
|
|
1984
|
+
/* tslint:disable */
|
|
1985
|
+
/* eslint-disable */
|
|
1986
|
+
/**
|
|
1987
|
+
* * `open` - Open
|
|
1988
|
+
* * `won` - Won
|
|
1989
|
+
* * `lost` - Lost
|
|
1990
|
+
*/
|
|
1991
|
+
exports.Status05cEnum = void 0;
|
|
1992
|
+
(function (Status05cEnum) {
|
|
1993
|
+
Status05cEnum["OPEN"] = "open";
|
|
1994
|
+
Status05cEnum["WON"] = "won";
|
|
1995
|
+
Status05cEnum["LOST"] = "lost";
|
|
1996
|
+
})(exports.Status05cEnum || (exports.Status05cEnum = {}));
|
|
1997
|
+
|
|
1934
1998
|
/* generated using openapi-typescript-codegen -- do not edit */
|
|
1935
1999
|
/* istanbul ignore file */
|
|
1936
2000
|
/* tslint:disable */
|
|
@@ -43729,37 +43793,49 @@ class CredentialsService {
|
|
|
43729
43793
|
class CrmService {
|
|
43730
43794
|
/**
|
|
43731
43795
|
* List activities
|
|
43732
|
-
* Returns a paginated list of Activities in your Platform. Supports filtering by `type`, `is_done`, `owner`, `deal`, `person`, schedule-from ranges, and `metadata__has_key`.
|
|
43796
|
+
* Returns a paginated list of Activities in your Platform. Supports filtering by `type`, `is_done`, `owner`, `deal`, `person`, `organization`, schedule-from ranges, and `metadata__has_key`.
|
|
43733
43797
|
*
|
|
43734
43798
|
* **Required permission:** `Ibl.CRM/Activities/list`.
|
|
43735
43799
|
* @returns PaginatedActivityList
|
|
43736
43800
|
* @throws ApiError
|
|
43737
43801
|
*/
|
|
43738
43802
|
static crmActivitiesList({
|
|
43803
|
+
dateFilter,
|
|
43739
43804
|
deal,
|
|
43805
|
+
endDate,
|
|
43740
43806
|
isDone,
|
|
43741
43807
|
metadataHasKey,
|
|
43808
|
+
ordering,
|
|
43809
|
+
organization,
|
|
43742
43810
|
owner,
|
|
43743
43811
|
page,
|
|
43744
43812
|
pageSize,
|
|
43745
43813
|
person,
|
|
43746
43814
|
scheduleFromGte,
|
|
43747
43815
|
scheduleFromLte,
|
|
43816
|
+
search,
|
|
43817
|
+
startDate,
|
|
43748
43818
|
type
|
|
43749
43819
|
}) {
|
|
43750
43820
|
return request(OpenAPI, {
|
|
43751
43821
|
method: 'GET',
|
|
43752
43822
|
url: '/api/crm/activities/',
|
|
43753
43823
|
query: {
|
|
43824
|
+
'date_filter': dateFilter,
|
|
43754
43825
|
'deal': deal,
|
|
43826
|
+
'end_date': endDate,
|
|
43755
43827
|
'is_done': isDone,
|
|
43756
43828
|
'metadata__has_key': metadataHasKey,
|
|
43829
|
+
'ordering': ordering,
|
|
43830
|
+
'organization': organization,
|
|
43757
43831
|
'owner': owner,
|
|
43758
43832
|
'page': page,
|
|
43759
43833
|
'page_size': pageSize,
|
|
43760
43834
|
'person': person,
|
|
43761
43835
|
'schedule_from__gte': scheduleFromGte,
|
|
43762
43836
|
'schedule_from__lte': scheduleFromLte,
|
|
43837
|
+
'search': search,
|
|
43838
|
+
'start_date': startDate,
|
|
43763
43839
|
'type': type
|
|
43764
43840
|
},
|
|
43765
43841
|
errors: {
|
|
@@ -43770,7 +43846,7 @@ class CrmService {
|
|
|
43770
43846
|
}
|
|
43771
43847
|
/**
|
|
43772
43848
|
* Create an activity
|
|
43773
|
-
* Creates an Activity.
|
|
43849
|
+
* Creates an Activity. At least one of `deal`, `person` or `organization` must be supplied; all must belong to your Platform.
|
|
43774
43850
|
*
|
|
43775
43851
|
* **Required permission:** `Ibl.CRM/Activities/action`.
|
|
43776
43852
|
* @returns Activity
|
|
@@ -43924,17 +44000,22 @@ class CrmService {
|
|
|
43924
44000
|
static crmDealsList({
|
|
43925
44001
|
createdAtGte,
|
|
43926
44002
|
createdAtLte,
|
|
44003
|
+
dateFilter,
|
|
44004
|
+
endDate,
|
|
43927
44005
|
expectedCloseDateGte,
|
|
43928
44006
|
expectedCloseDateLte,
|
|
43929
44007
|
metadataHasKey,
|
|
44008
|
+
ordering,
|
|
43930
44009
|
organization,
|
|
43931
44010
|
owner,
|
|
43932
44011
|
page,
|
|
43933
44012
|
pageSize,
|
|
43934
44013
|
person,
|
|
43935
44014
|
pipeline,
|
|
44015
|
+
search,
|
|
43936
44016
|
source,
|
|
43937
44017
|
stage,
|
|
44018
|
+
startDate,
|
|
43938
44019
|
status,
|
|
43939
44020
|
tags
|
|
43940
44021
|
}) {
|
|
@@ -43944,17 +44025,22 @@ class CrmService {
|
|
|
43944
44025
|
query: {
|
|
43945
44026
|
'created_at__gte': createdAtGte,
|
|
43946
44027
|
'created_at__lte': createdAtLte,
|
|
44028
|
+
'date_filter': dateFilter,
|
|
44029
|
+
'end_date': endDate,
|
|
43947
44030
|
'expected_close_date__gte': expectedCloseDateGte,
|
|
43948
44031
|
'expected_close_date__lte': expectedCloseDateLte,
|
|
43949
44032
|
'metadata__has_key': metadataHasKey,
|
|
44033
|
+
'ordering': ordering,
|
|
43950
44034
|
'organization': organization,
|
|
43951
44035
|
'owner': owner,
|
|
43952
44036
|
'page': page,
|
|
43953
44037
|
'page_size': pageSize,
|
|
43954
44038
|
'person': person,
|
|
43955
44039
|
'pipeline': pipeline,
|
|
44040
|
+
'search': search,
|
|
43956
44041
|
'source': source,
|
|
43957
44042
|
'stage': stage,
|
|
44043
|
+
'start_date': startDate,
|
|
43958
44044
|
'status': status,
|
|
43959
44045
|
'tags': tags
|
|
43960
44046
|
},
|
|
@@ -44086,6 +44172,29 @@ class CrmService {
|
|
|
44086
44172
|
}
|
|
44087
44173
|
});
|
|
44088
44174
|
}
|
|
44175
|
+
/**
|
|
44176
|
+
* Field-change history for this record
|
|
44177
|
+
* The record's audit entries (create and field updates), newest first, up to 200, each with `changes: {field: [old, new]}` as strings (a null reads `"None"`). The actor is the platform user who made the change. Bulk writes (a person merge, links a delete clears) leave no entry.
|
|
44178
|
+
*
|
|
44179
|
+
* **Required permission:** the record's `read` verb.
|
|
44180
|
+
* @returns HistoryEntry
|
|
44181
|
+
* @throws ApiError
|
|
44182
|
+
*/
|
|
44183
|
+
static crmDealsHistoryList({
|
|
44184
|
+
id
|
|
44185
|
+
}) {
|
|
44186
|
+
return request(OpenAPI, {
|
|
44187
|
+
method: 'GET',
|
|
44188
|
+
url: '/api/crm/deals/{id}/history/',
|
|
44189
|
+
path: {
|
|
44190
|
+
'id': id
|
|
44191
|
+
},
|
|
44192
|
+
errors: {
|
|
44193
|
+
403: `Missing the record's \`read\` permission.`,
|
|
44194
|
+
404: `Record not found.`
|
|
44195
|
+
}
|
|
44196
|
+
});
|
|
44197
|
+
}
|
|
44089
44198
|
/**
|
|
44090
44199
|
* Mark a deal as lost
|
|
44091
44200
|
* Moves the Deal into a closed-lost stage and persists `lost_reason`. If `stage_code` is omitted, the first `is_lost=True` stage in the Deal's pipeline (by sort order) is used.
|
|
@@ -44220,6 +44329,169 @@ class CrmService {
|
|
|
44220
44329
|
}
|
|
44221
44330
|
});
|
|
44222
44331
|
}
|
|
44332
|
+
/**
|
|
44333
|
+
* Deals grouped by stage (the board)
|
|
44334
|
+
* Every deal of one pipeline grouped by stage, in `sort_order`, with per-stage count, value and probability-weighted value. Each stage carries its newest `limit` deals; `has_more` says the stage holds more. The list filters (`owner`, `source`, `tags`, `search`, `status`, …) apply; `stage` is the grouping and `ordering` is ignored.
|
|
44335
|
+
*
|
|
44336
|
+
* **Required permission:** `Ibl.CRM/Deals/list`.
|
|
44337
|
+
* @returns DealBoard
|
|
44338
|
+
* @throws ApiError
|
|
44339
|
+
*/
|
|
44340
|
+
static crmDealsBoardRetrieve({
|
|
44341
|
+
createdAtGte,
|
|
44342
|
+
createdAtLte,
|
|
44343
|
+
dateFilter,
|
|
44344
|
+
endDate,
|
|
44345
|
+
expectedCloseDateGte,
|
|
44346
|
+
expectedCloseDateLte,
|
|
44347
|
+
limit,
|
|
44348
|
+
metadataHasKey,
|
|
44349
|
+
organization,
|
|
44350
|
+
owner,
|
|
44351
|
+
person,
|
|
44352
|
+
pipeline,
|
|
44353
|
+
search,
|
|
44354
|
+
source,
|
|
44355
|
+
stage,
|
|
44356
|
+
startDate,
|
|
44357
|
+
status,
|
|
44358
|
+
tags
|
|
44359
|
+
}) {
|
|
44360
|
+
return request(OpenAPI, {
|
|
44361
|
+
method: 'GET',
|
|
44362
|
+
url: '/api/crm/deals/board/',
|
|
44363
|
+
query: {
|
|
44364
|
+
'created_at__gte': createdAtGte,
|
|
44365
|
+
'created_at__lte': createdAtLte,
|
|
44366
|
+
'date_filter': dateFilter,
|
|
44367
|
+
'end_date': endDate,
|
|
44368
|
+
'expected_close_date__gte': expectedCloseDateGte,
|
|
44369
|
+
'expected_close_date__lte': expectedCloseDateLte,
|
|
44370
|
+
'limit': limit,
|
|
44371
|
+
'metadata__has_key': metadataHasKey,
|
|
44372
|
+
'organization': organization,
|
|
44373
|
+
'owner': owner,
|
|
44374
|
+
'person': person,
|
|
44375
|
+
'pipeline': pipeline,
|
|
44376
|
+
'search': search,
|
|
44377
|
+
'source': source,
|
|
44378
|
+
'stage': stage,
|
|
44379
|
+
'start_date': startDate,
|
|
44380
|
+
'status': status,
|
|
44381
|
+
'tags': tags
|
|
44382
|
+
},
|
|
44383
|
+
errors: {
|
|
44384
|
+
400: `Bad \`pipeline\` or \`limit\`.`,
|
|
44385
|
+
403: `Missing required permission \`Ibl.CRM/Deals/list\`.`,
|
|
44386
|
+
404: `Pipeline not found.`
|
|
44387
|
+
}
|
|
44388
|
+
});
|
|
44389
|
+
}
|
|
44390
|
+
/**
|
|
44391
|
+
* List my favorites
|
|
44392
|
+
* Your starred persons, organizations and deals in this Platform, newest first.
|
|
44393
|
+
*
|
|
44394
|
+
* **Required permission:** `Ibl.CRM/Favorites/list`.
|
|
44395
|
+
* @returns PaginatedFavoriteList
|
|
44396
|
+
* @throws ApiError
|
|
44397
|
+
*/
|
|
44398
|
+
static crmFavoritesList({
|
|
44399
|
+
dateFilter,
|
|
44400
|
+
deal,
|
|
44401
|
+
endDate,
|
|
44402
|
+
ordering,
|
|
44403
|
+
organization,
|
|
44404
|
+
page,
|
|
44405
|
+
pageSize,
|
|
44406
|
+
person,
|
|
44407
|
+
startDate
|
|
44408
|
+
}) {
|
|
44409
|
+
return request(OpenAPI, {
|
|
44410
|
+
method: 'GET',
|
|
44411
|
+
url: '/api/crm/favorites/',
|
|
44412
|
+
query: {
|
|
44413
|
+
'date_filter': dateFilter,
|
|
44414
|
+
'deal': deal,
|
|
44415
|
+
'end_date': endDate,
|
|
44416
|
+
'ordering': ordering,
|
|
44417
|
+
'organization': organization,
|
|
44418
|
+
'page': page,
|
|
44419
|
+
'page_size': pageSize,
|
|
44420
|
+
'person': person,
|
|
44421
|
+
'start_date': startDate
|
|
44422
|
+
},
|
|
44423
|
+
errors: {
|
|
44424
|
+
401: `Authentication required.`,
|
|
44425
|
+
403: `Missing required permission \`Ibl.CRM/Favorites/list\`.`
|
|
44426
|
+
}
|
|
44427
|
+
});
|
|
44428
|
+
}
|
|
44429
|
+
/**
|
|
44430
|
+
* Star a record
|
|
44431
|
+
* Stars exactly one of `person`, `organization`, `deal`. Starring a record you already starred returns the existing favorite with `200`. You also need the target's `read` permission.
|
|
44432
|
+
*
|
|
44433
|
+
* **Required permission:** `Ibl.CRM/Favorites/action`.
|
|
44434
|
+
* @returns Favorite
|
|
44435
|
+
* @throws ApiError
|
|
44436
|
+
*/
|
|
44437
|
+
static crmFavoritesCreate({
|
|
44438
|
+
requestBody
|
|
44439
|
+
}) {
|
|
44440
|
+
return request(OpenAPI, {
|
|
44441
|
+
method: 'POST',
|
|
44442
|
+
url: '/api/crm/favorites/',
|
|
44443
|
+
body: requestBody,
|
|
44444
|
+
mediaType: 'application/json',
|
|
44445
|
+
errors: {
|
|
44446
|
+
400: `Not exactly one target.`,
|
|
44447
|
+
403: `Missing \`Ibl.CRM/Favorites/action\` or the target's \`read\`.`
|
|
44448
|
+
}
|
|
44449
|
+
});
|
|
44450
|
+
}
|
|
44451
|
+
/**
|
|
44452
|
+
* One of your favorites
|
|
44453
|
+
* **Required permission:** `Ibl.CRM/Favorites/read`.
|
|
44454
|
+
* @returns Favorite
|
|
44455
|
+
* @throws ApiError
|
|
44456
|
+
*/
|
|
44457
|
+
static crmFavoritesRetrieve({
|
|
44458
|
+
id
|
|
44459
|
+
}) {
|
|
44460
|
+
return request(OpenAPI, {
|
|
44461
|
+
method: 'GET',
|
|
44462
|
+
url: '/api/crm/favorites/{id}/',
|
|
44463
|
+
path: {
|
|
44464
|
+
'id': id
|
|
44465
|
+
},
|
|
44466
|
+
errors: {
|
|
44467
|
+
403: `Missing required permission \`Ibl.CRM/Favorites/read\`.`,
|
|
44468
|
+
404: `Favorite not found.`
|
|
44469
|
+
}
|
|
44470
|
+
});
|
|
44471
|
+
}
|
|
44472
|
+
/**
|
|
44473
|
+
* Unstar a record
|
|
44474
|
+
* Removes one of your favorites.
|
|
44475
|
+
*
|
|
44476
|
+
* **Required permission:** `Ibl.CRM/Favorites/delete`.
|
|
44477
|
+
* @returns void
|
|
44478
|
+
* @throws ApiError
|
|
44479
|
+
*/
|
|
44480
|
+
static crmFavoritesDestroy({
|
|
44481
|
+
id
|
|
44482
|
+
}) {
|
|
44483
|
+
return request(OpenAPI, {
|
|
44484
|
+
method: 'DELETE',
|
|
44485
|
+
url: '/api/crm/favorites/{id}/',
|
|
44486
|
+
path: {
|
|
44487
|
+
'id': id
|
|
44488
|
+
},
|
|
44489
|
+
errors: {
|
|
44490
|
+
403: `Missing required permission \`Ibl.CRM/Favorites/delete\`.`,
|
|
44491
|
+
404: `Favorite not found.`
|
|
44492
|
+
}
|
|
44493
|
+
});
|
|
44494
|
+
}
|
|
44223
44495
|
/**
|
|
44224
44496
|
* List lead sources
|
|
44225
44497
|
* Returns a paginated list of LeadSources in your Platform.
|
|
@@ -44230,18 +44502,28 @@ class CrmService {
|
|
|
44230
44502
|
*/
|
|
44231
44503
|
static crmLeadSourcesList({
|
|
44232
44504
|
code,
|
|
44505
|
+
dateFilter,
|
|
44506
|
+
endDate,
|
|
44233
44507
|
name,
|
|
44508
|
+
ordering,
|
|
44234
44509
|
page,
|
|
44235
|
-
pageSize
|
|
44510
|
+
pageSize,
|
|
44511
|
+
search,
|
|
44512
|
+
startDate
|
|
44236
44513
|
}) {
|
|
44237
44514
|
return request(OpenAPI, {
|
|
44238
44515
|
method: 'GET',
|
|
44239
44516
|
url: '/api/crm/lead-sources/',
|
|
44240
44517
|
query: {
|
|
44241
44518
|
'code': code,
|
|
44519
|
+
'date_filter': dateFilter,
|
|
44520
|
+
'end_date': endDate,
|
|
44242
44521
|
'name': name,
|
|
44522
|
+
'ordering': ordering,
|
|
44243
44523
|
'page': page,
|
|
44244
|
-
'page_size': pageSize
|
|
44524
|
+
'page_size': pageSize,
|
|
44525
|
+
'search': search,
|
|
44526
|
+
'start_date': startDate
|
|
44245
44527
|
},
|
|
44246
44528
|
errors: {
|
|
44247
44529
|
401: `Authentication required.`,
|
|
@@ -44380,20 +44662,30 @@ class CrmService {
|
|
|
44380
44662
|
* @throws ApiError
|
|
44381
44663
|
*/
|
|
44382
44664
|
static crmOrganizationsList({
|
|
44665
|
+
dateFilter,
|
|
44666
|
+
endDate,
|
|
44383
44667
|
name,
|
|
44668
|
+
ordering,
|
|
44384
44669
|
owner,
|
|
44385
44670
|
page,
|
|
44386
44671
|
pageSize,
|
|
44672
|
+
search,
|
|
44673
|
+
startDate,
|
|
44387
44674
|
tags
|
|
44388
44675
|
}) {
|
|
44389
44676
|
return request(OpenAPI, {
|
|
44390
44677
|
method: 'GET',
|
|
44391
44678
|
url: '/api/crm/organizations/',
|
|
44392
44679
|
query: {
|
|
44680
|
+
'date_filter': dateFilter,
|
|
44681
|
+
'end_date': endDate,
|
|
44393
44682
|
'name': name,
|
|
44683
|
+
'ordering': ordering,
|
|
44394
44684
|
'owner': owner,
|
|
44395
44685
|
'page': page,
|
|
44396
44686
|
'page_size': pageSize,
|
|
44687
|
+
'search': search,
|
|
44688
|
+
'start_date': startDate,
|
|
44397
44689
|
'tags': tags
|
|
44398
44690
|
},
|
|
44399
44691
|
errors: {
|
|
@@ -44503,7 +44795,7 @@ class CrmService {
|
|
|
44503
44795
|
}
|
|
44504
44796
|
/**
|
|
44505
44797
|
* Delete an organization
|
|
44506
|
-
* Deletes the organization.
|
|
44798
|
+
* Deletes the organization. Persons and deals linked to it are kept with the reference cleared; activities attached only to it are deleted, the rest just lose the link.
|
|
44507
44799
|
*
|
|
44508
44800
|
* **Required permission:** `Ibl.CRM/Organizations/delete`.
|
|
44509
44801
|
* @returns void
|
|
@@ -44524,6 +44816,29 @@ class CrmService {
|
|
|
44524
44816
|
}
|
|
44525
44817
|
});
|
|
44526
44818
|
}
|
|
44819
|
+
/**
|
|
44820
|
+
* Field-change history for this record
|
|
44821
|
+
* The record's audit entries (create and field updates), newest first, up to 200, each with `changes: {field: [old, new]}` as strings (a null reads `"None"`). The actor is the platform user who made the change. Bulk writes (a person merge, links a delete clears) leave no entry.
|
|
44822
|
+
*
|
|
44823
|
+
* **Required permission:** the record's `read` verb.
|
|
44824
|
+
* @returns HistoryEntry
|
|
44825
|
+
* @throws ApiError
|
|
44826
|
+
*/
|
|
44827
|
+
static crmOrganizationsHistoryList({
|
|
44828
|
+
id
|
|
44829
|
+
}) {
|
|
44830
|
+
return request(OpenAPI, {
|
|
44831
|
+
method: 'GET',
|
|
44832
|
+
url: '/api/crm/organizations/{id}/history/',
|
|
44833
|
+
path: {
|
|
44834
|
+
'id': id
|
|
44835
|
+
},
|
|
44836
|
+
errors: {
|
|
44837
|
+
403: `Missing the record's \`read\` permission.`,
|
|
44838
|
+
404: `Record not found.`
|
|
44839
|
+
}
|
|
44840
|
+
});
|
|
44841
|
+
}
|
|
44527
44842
|
/**
|
|
44528
44843
|
* Attach a tag to this record
|
|
44529
44844
|
* Attaches an existing Tag to this record. Both the Tag and the record must belong to your Platform. Returns `409 Conflict` with the existing `assignment_id` if the tag is already attached.
|
|
@@ -44577,6 +44892,38 @@ class CrmService {
|
|
|
44577
44892
|
}
|
|
44578
44893
|
});
|
|
44579
44894
|
}
|
|
44895
|
+
/**
|
|
44896
|
+
* CRM overview
|
|
44897
|
+
* Dashboard figures: person and organization counts, open-deal count and value (plain and probability-weighted), this month's won / lost deals, open deals per stage of one pipeline, six months of won / lost history, and activities due today or overdue. Sections you may not `list` are omitted.
|
|
44898
|
+
*
|
|
44899
|
+
* `date_filter` (or `start_date` + `end_date`) adds `period_*` siblings for that window.
|
|
44900
|
+
*
|
|
44901
|
+
* **Required permission:** the `list` verb of each section.
|
|
44902
|
+
* @returns Overview
|
|
44903
|
+
* @throws ApiError
|
|
44904
|
+
*/
|
|
44905
|
+
static crmOverviewRetrieve({
|
|
44906
|
+
dateFilter,
|
|
44907
|
+
endDate,
|
|
44908
|
+
pipeline,
|
|
44909
|
+
startDate
|
|
44910
|
+
}) {
|
|
44911
|
+
return request(OpenAPI, {
|
|
44912
|
+
method: 'GET',
|
|
44913
|
+
url: '/api/crm/overview/',
|
|
44914
|
+
query: {
|
|
44915
|
+
'date_filter': dateFilter,
|
|
44916
|
+
'end_date': endDate,
|
|
44917
|
+
'pipeline': pipeline,
|
|
44918
|
+
'start_date': startDate
|
|
44919
|
+
},
|
|
44920
|
+
errors: {
|
|
44921
|
+
400: `Invalid window or pipeline parameter.`,
|
|
44922
|
+
403: `No CRM list permission.`,
|
|
44923
|
+
404: `Pipeline not found.`
|
|
44924
|
+
}
|
|
44925
|
+
});
|
|
44926
|
+
}
|
|
44580
44927
|
/**
|
|
44581
44928
|
* List persons
|
|
44582
44929
|
* Returns a paginated list of persons in your Platform. Supports filtering by `lifecycle_stage`, `owner`, `organization`, `created_at__gte`/`created_at__lte`, and `metadata__has_key`.
|
|
@@ -44586,28 +44933,40 @@ class CrmService {
|
|
|
44586
44933
|
* @throws ApiError
|
|
44587
44934
|
*/
|
|
44588
44935
|
static crmPersonsList({
|
|
44936
|
+
active,
|
|
44589
44937
|
createdAtGte,
|
|
44590
44938
|
createdAtLte,
|
|
44939
|
+
dateFilter,
|
|
44940
|
+
endDate,
|
|
44591
44941
|
lifecycleStage,
|
|
44592
44942
|
metadataHasKey,
|
|
44943
|
+
ordering,
|
|
44593
44944
|
organization,
|
|
44594
44945
|
owner,
|
|
44595
44946
|
page,
|
|
44596
44947
|
pageSize,
|
|
44948
|
+
search,
|
|
44949
|
+
startDate,
|
|
44597
44950
|
tags
|
|
44598
44951
|
}) {
|
|
44599
44952
|
return request(OpenAPI, {
|
|
44600
44953
|
method: 'GET',
|
|
44601
44954
|
url: '/api/crm/persons/',
|
|
44602
44955
|
query: {
|
|
44956
|
+
'active': active,
|
|
44603
44957
|
'created_at__gte': createdAtGte,
|
|
44604
44958
|
'created_at__lte': createdAtLte,
|
|
44959
|
+
'date_filter': dateFilter,
|
|
44960
|
+
'end_date': endDate,
|
|
44605
44961
|
'lifecycle_stage': lifecycleStage,
|
|
44606
44962
|
'metadata__has_key': metadataHasKey,
|
|
44963
|
+
'ordering': ordering,
|
|
44607
44964
|
'organization': organization,
|
|
44608
44965
|
'owner': owner,
|
|
44609
44966
|
'page': page,
|
|
44610
44967
|
'page_size': pageSize,
|
|
44968
|
+
'search': search,
|
|
44969
|
+
'start_date': startDate,
|
|
44611
44970
|
'tags': tags
|
|
44612
44971
|
},
|
|
44613
44972
|
errors: {
|
|
@@ -44717,7 +45076,7 @@ class CrmService {
|
|
|
44717
45076
|
}
|
|
44718
45077
|
/**
|
|
44719
45078
|
* Delete a person
|
|
44720
|
-
* Deletes the person.
|
|
45079
|
+
* Deletes the person. Fails with `409 Conflict` if any Deal still references it.
|
|
44721
45080
|
*
|
|
44722
45081
|
* **Required permission:** `Ibl.CRM/Persons/delete`.
|
|
44723
45082
|
* @returns void
|
|
@@ -44734,7 +45093,31 @@ class CrmService {
|
|
|
44734
45093
|
},
|
|
44735
45094
|
errors: {
|
|
44736
45095
|
403: `Missing required permission \`Ibl.CRM/Persons/delete\`.`,
|
|
44737
|
-
404: `Person not found
|
|
45096
|
+
404: `Person not found.`,
|
|
45097
|
+
409: `Person still has Deals attached.`
|
|
45098
|
+
}
|
|
45099
|
+
});
|
|
45100
|
+
}
|
|
45101
|
+
/**
|
|
45102
|
+
* Field-change history for this record
|
|
45103
|
+
* The record's audit entries (create and field updates), newest first, up to 200, each with `changes: {field: [old, new]}` as strings (a null reads `"None"`). The actor is the platform user who made the change. Bulk writes (a person merge, links a delete clears) leave no entry.
|
|
45104
|
+
*
|
|
45105
|
+
* **Required permission:** the record's `read` verb.
|
|
45106
|
+
* @returns HistoryEntry
|
|
45107
|
+
* @throws ApiError
|
|
45108
|
+
*/
|
|
45109
|
+
static crmPersonsHistoryList({
|
|
45110
|
+
id
|
|
45111
|
+
}) {
|
|
45112
|
+
return request(OpenAPI, {
|
|
45113
|
+
method: 'GET',
|
|
45114
|
+
url: '/api/crm/persons/{id}/history/',
|
|
45115
|
+
path: {
|
|
45116
|
+
'id': id
|
|
45117
|
+
},
|
|
45118
|
+
errors: {
|
|
45119
|
+
403: `Missing the record's \`read\` permission.`,
|
|
45120
|
+
404: `Record not found.`
|
|
44738
45121
|
}
|
|
44739
45122
|
});
|
|
44740
45123
|
}
|
|
@@ -44885,20 +45268,30 @@ class CrmService {
|
|
|
44885
45268
|
*/
|
|
44886
45269
|
static crmPipelinesList({
|
|
44887
45270
|
code,
|
|
45271
|
+
dateFilter,
|
|
45272
|
+
endDate,
|
|
44888
45273
|
isDefault,
|
|
44889
45274
|
name,
|
|
45275
|
+
ordering,
|
|
44890
45276
|
page,
|
|
44891
|
-
pageSize
|
|
45277
|
+
pageSize,
|
|
45278
|
+
search,
|
|
45279
|
+
startDate
|
|
44892
45280
|
}) {
|
|
44893
45281
|
return request(OpenAPI, {
|
|
44894
45282
|
method: 'GET',
|
|
44895
45283
|
url: '/api/crm/pipelines/',
|
|
44896
45284
|
query: {
|
|
44897
45285
|
'code': code,
|
|
45286
|
+
'date_filter': dateFilter,
|
|
45287
|
+
'end_date': endDate,
|
|
44898
45288
|
'is_default': isDefault,
|
|
44899
45289
|
'name': name,
|
|
45290
|
+
'ordering': ordering,
|
|
44900
45291
|
'page': page,
|
|
44901
|
-
'page_size': pageSize
|
|
45292
|
+
'page_size': pageSize,
|
|
45293
|
+
'search': search,
|
|
45294
|
+
'start_date': startDate
|
|
44902
45295
|
},
|
|
44903
45296
|
errors: {
|
|
44904
45297
|
401: `Authentication required.`,
|
|
@@ -44939,10 +45332,15 @@ class CrmService {
|
|
|
44939
45332
|
static crmPipelinesStagesList({
|
|
44940
45333
|
pipelinePk,
|
|
44941
45334
|
code,
|
|
45335
|
+
dateFilter,
|
|
45336
|
+
endDate,
|
|
44942
45337
|
isLost,
|
|
44943
45338
|
isWon,
|
|
45339
|
+
ordering,
|
|
44944
45340
|
page,
|
|
44945
|
-
pageSize
|
|
45341
|
+
pageSize,
|
|
45342
|
+
search,
|
|
45343
|
+
startDate
|
|
44946
45344
|
}) {
|
|
44947
45345
|
return request(OpenAPI, {
|
|
44948
45346
|
method: 'GET',
|
|
@@ -44952,10 +45350,15 @@ class CrmService {
|
|
|
44952
45350
|
},
|
|
44953
45351
|
query: {
|
|
44954
45352
|
'code': code,
|
|
45353
|
+
'date_filter': dateFilter,
|
|
45354
|
+
'end_date': endDate,
|
|
44955
45355
|
'is_lost': isLost,
|
|
44956
45356
|
'is_won': isWon,
|
|
45357
|
+
'ordering': ordering,
|
|
44957
45358
|
'page': page,
|
|
44958
|
-
'page_size': pageSize
|
|
45359
|
+
'page_size': pageSize,
|
|
45360
|
+
'search': search,
|
|
45361
|
+
'start_date': startDate
|
|
44959
45362
|
},
|
|
44960
45363
|
errors: {
|
|
44961
45364
|
403: `Missing required permission \`Ibl.CRM/Pipelines/list\`.`,
|
|
@@ -45200,6 +45603,58 @@ class CrmService {
|
|
|
45200
45603
|
}
|
|
45201
45604
|
});
|
|
45202
45605
|
}
|
|
45606
|
+
/**
|
|
45607
|
+
* Reorder a pipeline's stages
|
|
45608
|
+
* Sets `sort_order` on every stage of the Pipeline from the position of its id in `order`, in one transaction. `order` must list each stage of this Pipeline exactly once.
|
|
45609
|
+
*
|
|
45610
|
+
* **Required permission:** `Ibl.CRM/Pipelines/write`.
|
|
45611
|
+
* @returns Pipeline
|
|
45612
|
+
* @throws ApiError
|
|
45613
|
+
*/
|
|
45614
|
+
static crmPipelinesStagesReorderCreate({
|
|
45615
|
+
id,
|
|
45616
|
+
requestBody
|
|
45617
|
+
}) {
|
|
45618
|
+
return request(OpenAPI, {
|
|
45619
|
+
method: 'POST',
|
|
45620
|
+
url: '/api/crm/pipelines/{id}/stages/reorder/',
|
|
45621
|
+
path: {
|
|
45622
|
+
'id': id
|
|
45623
|
+
},
|
|
45624
|
+
body: requestBody,
|
|
45625
|
+
mediaType: 'application/json',
|
|
45626
|
+
errors: {
|
|
45627
|
+
400: `\`order\` is not a permutation of the stages.`,
|
|
45628
|
+
403: `Missing required permission \`Ibl.CRM/Pipelines/write\`.`,
|
|
45629
|
+
404: `Pipeline not found.`
|
|
45630
|
+
}
|
|
45631
|
+
});
|
|
45632
|
+
}
|
|
45633
|
+
/**
|
|
45634
|
+
* Search persons, organizations and deals
|
|
45635
|
+
* Case-insensitive substring match on person name / email / job title, organization name and deal title, up to `limit` rows per bucket. A bucket is present only when you hold that resource's `list` permission.
|
|
45636
|
+
*
|
|
45637
|
+
* **Required permission:** `Ibl.CRM/Persons/list`, `Ibl.CRM/Organizations/list` or `Ibl.CRM/Deals/list` (at least one).
|
|
45638
|
+
* @returns SearchResponse
|
|
45639
|
+
* @throws ApiError
|
|
45640
|
+
*/
|
|
45641
|
+
static crmSearchRetrieve({
|
|
45642
|
+
q,
|
|
45643
|
+
limit
|
|
45644
|
+
}) {
|
|
45645
|
+
return request(OpenAPI, {
|
|
45646
|
+
method: 'GET',
|
|
45647
|
+
url: '/api/crm/search/',
|
|
45648
|
+
query: {
|
|
45649
|
+
'limit': limit,
|
|
45650
|
+
'q': q
|
|
45651
|
+
},
|
|
45652
|
+
errors: {
|
|
45653
|
+
400: `\`q\` missing or \`limit\` out of range.`,
|
|
45654
|
+
403: `No CRM list permission.`
|
|
45655
|
+
}
|
|
45656
|
+
});
|
|
45657
|
+
}
|
|
45203
45658
|
/**
|
|
45204
45659
|
* List tags
|
|
45205
45660
|
* Returns a paginated list of Tags in your Platform. Supports filtering by `name` (case-insensitive substring) and `created_at__gte`/`created_at__lte` ISO timestamp ranges.
|
|
@@ -45211,9 +45666,14 @@ class CrmService {
|
|
|
45211
45666
|
static crmTagsList({
|
|
45212
45667
|
createdAtGte,
|
|
45213
45668
|
createdAtLte,
|
|
45669
|
+
dateFilter,
|
|
45670
|
+
endDate,
|
|
45214
45671
|
name,
|
|
45672
|
+
ordering,
|
|
45215
45673
|
page,
|
|
45216
|
-
pageSize
|
|
45674
|
+
pageSize,
|
|
45675
|
+
search,
|
|
45676
|
+
startDate
|
|
45217
45677
|
}) {
|
|
45218
45678
|
return request(OpenAPI, {
|
|
45219
45679
|
method: 'GET',
|
|
@@ -45221,9 +45681,14 @@ class CrmService {
|
|
|
45221
45681
|
query: {
|
|
45222
45682
|
'created_at__gte': createdAtGte,
|
|
45223
45683
|
'created_at__lte': createdAtLte,
|
|
45684
|
+
'date_filter': dateFilter,
|
|
45685
|
+
'end_date': endDate,
|
|
45224
45686
|
'name': name,
|
|
45687
|
+
'ordering': ordering,
|
|
45225
45688
|
'page': page,
|
|
45226
|
-
'page_size': pageSize
|
|
45689
|
+
'page_size': pageSize,
|
|
45690
|
+
'search': search,
|
|
45691
|
+
'start_date': startDate
|
|
45227
45692
|
},
|
|
45228
45693
|
errors: {
|
|
45229
45694
|
401: `Authentication required.`,
|
|
@@ -45353,6 +45818,159 @@ class CrmService {
|
|
|
45353
45818
|
}
|
|
45354
45819
|
});
|
|
45355
45820
|
}
|
|
45821
|
+
/**
|
|
45822
|
+
* List my saved views
|
|
45823
|
+
* Your saved views in this Platform; filter with `object_type`.
|
|
45824
|
+
*
|
|
45825
|
+
* **Required permission:** `Ibl.CRM/Views/list`.
|
|
45826
|
+
* @returns PaginatedSavedViewList
|
|
45827
|
+
* @throws ApiError
|
|
45828
|
+
*/
|
|
45829
|
+
static crmViewsList({
|
|
45830
|
+
dateFilter,
|
|
45831
|
+
endDate,
|
|
45832
|
+
objectType,
|
|
45833
|
+
ordering,
|
|
45834
|
+
page,
|
|
45835
|
+
pageSize,
|
|
45836
|
+
search,
|
|
45837
|
+
startDate,
|
|
45838
|
+
type
|
|
45839
|
+
}) {
|
|
45840
|
+
return request(OpenAPI, {
|
|
45841
|
+
method: 'GET',
|
|
45842
|
+
url: '/api/crm/views/',
|
|
45843
|
+
query: {
|
|
45844
|
+
'date_filter': dateFilter,
|
|
45845
|
+
'end_date': endDate,
|
|
45846
|
+
'object_type': objectType,
|
|
45847
|
+
'ordering': ordering,
|
|
45848
|
+
'page': page,
|
|
45849
|
+
'page_size': pageSize,
|
|
45850
|
+
'search': search,
|
|
45851
|
+
'start_date': startDate,
|
|
45852
|
+
'type': type
|
|
45853
|
+
},
|
|
45854
|
+
errors: {
|
|
45855
|
+
401: `Authentication required.`,
|
|
45856
|
+
403: `Missing required permission \`Ibl.CRM/Views/list\`.`
|
|
45857
|
+
}
|
|
45858
|
+
});
|
|
45859
|
+
}
|
|
45860
|
+
/**
|
|
45861
|
+
* Save a view
|
|
45862
|
+
* Stores columns, filters, sorts and (for deals) a kanban grouping under a name unique to you and the list.
|
|
45863
|
+
*
|
|
45864
|
+
* **Required permission:** `Ibl.CRM/Views/action`.
|
|
45865
|
+
* @returns SavedView
|
|
45866
|
+
* @throws ApiError
|
|
45867
|
+
*/
|
|
45868
|
+
static crmViewsCreate({
|
|
45869
|
+
requestBody
|
|
45870
|
+
}) {
|
|
45871
|
+
return request(OpenAPI, {
|
|
45872
|
+
method: 'POST',
|
|
45873
|
+
url: '/api/crm/views/',
|
|
45874
|
+
body: requestBody,
|
|
45875
|
+
mediaType: 'application/json',
|
|
45876
|
+
errors: {
|
|
45877
|
+
400: `Validation error.`,
|
|
45878
|
+
403: `Missing required permission \`Ibl.CRM/Views/action\`.`
|
|
45879
|
+
}
|
|
45880
|
+
});
|
|
45881
|
+
}
|
|
45882
|
+
/**
|
|
45883
|
+
* Retrieve a saved view
|
|
45884
|
+
* **Required permission:** `Ibl.CRM/Views/read`.
|
|
45885
|
+
* @returns SavedView
|
|
45886
|
+
* @throws ApiError
|
|
45887
|
+
*/
|
|
45888
|
+
static crmViewsRetrieve({
|
|
45889
|
+
id
|
|
45890
|
+
}) {
|
|
45891
|
+
return request(OpenAPI, {
|
|
45892
|
+
method: 'GET',
|
|
45893
|
+
url: '/api/crm/views/{id}/',
|
|
45894
|
+
path: {
|
|
45895
|
+
'id': id
|
|
45896
|
+
},
|
|
45897
|
+
errors: {
|
|
45898
|
+
403: `Missing required permission \`Ibl.CRM/Views/read\`.`,
|
|
45899
|
+
404: `View not found.`
|
|
45900
|
+
}
|
|
45901
|
+
});
|
|
45902
|
+
}
|
|
45903
|
+
/**
|
|
45904
|
+
* Replace a saved view
|
|
45905
|
+
* **Required permission:** `Ibl.CRM/Views/write`.
|
|
45906
|
+
* @returns SavedView
|
|
45907
|
+
* @throws ApiError
|
|
45908
|
+
*/
|
|
45909
|
+
static crmViewsUpdate({
|
|
45910
|
+
id,
|
|
45911
|
+
requestBody
|
|
45912
|
+
}) {
|
|
45913
|
+
return request(OpenAPI, {
|
|
45914
|
+
method: 'PUT',
|
|
45915
|
+
url: '/api/crm/views/{id}/',
|
|
45916
|
+
path: {
|
|
45917
|
+
'id': id
|
|
45918
|
+
},
|
|
45919
|
+
body: requestBody,
|
|
45920
|
+
mediaType: 'application/json',
|
|
45921
|
+
errors: {
|
|
45922
|
+
400: `Validation error.`,
|
|
45923
|
+
403: `Missing required permission \`Ibl.CRM/Views/write\`.`,
|
|
45924
|
+
404: `View not found.`
|
|
45925
|
+
}
|
|
45926
|
+
});
|
|
45927
|
+
}
|
|
45928
|
+
/**
|
|
45929
|
+
* Update a saved view
|
|
45930
|
+
* **Required permission:** `Ibl.CRM/Views/write`.
|
|
45931
|
+
* @returns SavedView
|
|
45932
|
+
* @throws ApiError
|
|
45933
|
+
*/
|
|
45934
|
+
static crmViewsPartialUpdate({
|
|
45935
|
+
id,
|
|
45936
|
+
requestBody
|
|
45937
|
+
}) {
|
|
45938
|
+
return request(OpenAPI, {
|
|
45939
|
+
method: 'PATCH',
|
|
45940
|
+
url: '/api/crm/views/{id}/',
|
|
45941
|
+
path: {
|
|
45942
|
+
'id': id
|
|
45943
|
+
},
|
|
45944
|
+
body: requestBody,
|
|
45945
|
+
mediaType: 'application/json',
|
|
45946
|
+
errors: {
|
|
45947
|
+
400: `Validation error.`,
|
|
45948
|
+
403: `Missing required permission \`Ibl.CRM/Views/write\`.`,
|
|
45949
|
+
404: `View not found.`
|
|
45950
|
+
}
|
|
45951
|
+
});
|
|
45952
|
+
}
|
|
45953
|
+
/**
|
|
45954
|
+
* Delete a saved view
|
|
45955
|
+
* **Required permission:** `Ibl.CRM/Views/delete`.
|
|
45956
|
+
* @returns void
|
|
45957
|
+
* @throws ApiError
|
|
45958
|
+
*/
|
|
45959
|
+
static crmViewsDestroy({
|
|
45960
|
+
id
|
|
45961
|
+
}) {
|
|
45962
|
+
return request(OpenAPI, {
|
|
45963
|
+
method: 'DELETE',
|
|
45964
|
+
url: '/api/crm/views/{id}/',
|
|
45965
|
+
path: {
|
|
45966
|
+
'id': id
|
|
45967
|
+
},
|
|
45968
|
+
errors: {
|
|
45969
|
+
403: `Missing required permission \`Ibl.CRM/Views/delete\`.`,
|
|
45970
|
+
404: `View not found.`
|
|
45971
|
+
}
|
|
45972
|
+
});
|
|
45973
|
+
}
|
|
45356
45974
|
}
|
|
45357
45975
|
|
|
45358
45976
|
class CustomDomainsService {
|