@iblai/iblai-api 4.266.0-core → 4.267.0-core
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 +681 -41
- package/dist/index.cjs.js.map +1 -1
- package/dist/index.esm.js +681 -42
- package/dist/index.esm.js.map +1 -1
- package/dist/index.umd.js +681 -41
- package/dist/index.umd.js.map +1 -1
- package/dist/types/index.d.ts +5 -0
- package/dist/types/models/Deal.d.ts +12 -0
- package/dist/types/models/Organization.d.ts +12 -0
- package/dist/types/models/PaginatedTagList.d.ts +7 -0
- package/dist/types/models/PatchedDeal.d.ts +12 -0
- package/dist/types/models/PatchedOrganization.d.ts +12 -0
- package/dist/types/models/PatchedPerson.d.ts +12 -0
- package/dist/types/models/PatchedTag.d.ts +30 -0
- package/dist/types/models/Person.d.ts +12 -0
- package/dist/types/models/Tag.d.ts +30 -0
- package/dist/types/models/_TagAttachRequest.d.ts +6 -0
- package/dist/types/services/ActivitiesService.d.ts +1 -1
- package/dist/types/services/CrmService.d.ts +185 -10
- package/dist/types/services/DealsService.d.ts +34 -2
- package/dist/types/services/LeadSourcesService.d.ts +1 -1
- package/dist/types/services/OrganizationsService.d.ts +28 -2
- package/dist/types/services/PersonsService.d.ts +28 -2
- package/dist/types/services/PipelinesService.d.ts +2 -2
- package/dist/types/services/TagsService.d.ts +96 -0
- package/package.json +1 -1
- package/sdk_schema.yml +1484 -239
- package/src/core/OpenAPI.ts +1 -1
- package/src/index.ts +5 -0
- package/src/models/Deal.ts +12 -0
- package/src/models/Organization.ts +12 -0
- package/src/models/PaginatedTagList.ts +12 -0
- package/src/models/PatchedDeal.ts +12 -0
- package/src/models/PatchedOrganization.ts +12 -0
- package/src/models/PatchedPerson.ts +12 -0
- package/src/models/PatchedTag.ts +35 -0
- package/src/models/Person.ts +12 -0
- package/src/models/Tag.ts +35 -0
- package/src/models/_TagAttachRequest.ts +11 -0
- package/src/services/ActivitiesService.ts +2 -2
- package/src/services/CrmService.ts +399 -14
- package/src/services/DealsService.ts +71 -2
- package/src/services/LeadSourcesService.ts +2 -2
- package/src/services/OrganizationsService.ts +65 -2
- package/src/services/PersonsService.ts +65 -2
- package/src/services/PipelinesService.ts +4 -4
- package/src/services/TagsService.ts +201 -0
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.267.0-core',
|
|
114
114
|
WITH_CREDENTIALS: false,
|
|
115
115
|
CREDENTIALS: 'include',
|
|
116
116
|
TOKEN: undefined,
|
|
@@ -1288,7 +1288,7 @@ class ActivitiesService {
|
|
|
1288
1288
|
* Create an activity
|
|
1289
1289
|
* Creates an Activity. Either `deal` or `person` must be supplied; both must belong to your Platform.
|
|
1290
1290
|
*
|
|
1291
|
-
* **Required permission:** `Ibl.CRM/Activities/
|
|
1291
|
+
* **Required permission:** `Ibl.CRM/Activities/action`.
|
|
1292
1292
|
* @returns Activity
|
|
1293
1293
|
* @throws ApiError
|
|
1294
1294
|
*/
|
|
@@ -1302,7 +1302,7 @@ class ActivitiesService {
|
|
|
1302
1302
|
mediaType: 'application/json',
|
|
1303
1303
|
errors: {
|
|
1304
1304
|
400: `Validation error.`,
|
|
1305
|
-
403: `Missing required permission \`Ibl.CRM/Activities/
|
|
1305
|
+
403: `Missing required permission \`Ibl.CRM/Activities/action\`.`
|
|
1306
1306
|
}
|
|
1307
1307
|
});
|
|
1308
1308
|
}
|
|
@@ -20086,7 +20086,7 @@ class CrmService {
|
|
|
20086
20086
|
* Create an activity
|
|
20087
20087
|
* Creates an Activity. Either `deal` or `person` must be supplied; both must belong to your Platform.
|
|
20088
20088
|
*
|
|
20089
|
-
* **Required permission:** `Ibl.CRM/Activities/
|
|
20089
|
+
* **Required permission:** `Ibl.CRM/Activities/action`.
|
|
20090
20090
|
* @returns Activity
|
|
20091
20091
|
* @throws ApiError
|
|
20092
20092
|
*/
|
|
@@ -20100,7 +20100,7 @@ class CrmService {
|
|
|
20100
20100
|
mediaType: 'application/json',
|
|
20101
20101
|
errors: {
|
|
20102
20102
|
400: `Validation error.`,
|
|
20103
|
-
403: `Missing required permission \`Ibl.CRM/Activities/
|
|
20103
|
+
403: `Missing required permission \`Ibl.CRM/Activities/action\`.`
|
|
20104
20104
|
}
|
|
20105
20105
|
});
|
|
20106
20106
|
}
|
|
@@ -20249,7 +20249,8 @@ class CrmService {
|
|
|
20249
20249
|
pipeline,
|
|
20250
20250
|
source,
|
|
20251
20251
|
stage,
|
|
20252
|
-
status
|
|
20252
|
+
status,
|
|
20253
|
+
tags
|
|
20253
20254
|
}) {
|
|
20254
20255
|
return request(OpenAPI, {
|
|
20255
20256
|
method: 'GET',
|
|
@@ -20268,7 +20269,8 @@ class CrmService {
|
|
|
20268
20269
|
'pipeline': pipeline,
|
|
20269
20270
|
'source': source,
|
|
20270
20271
|
'stage': stage,
|
|
20271
|
-
'status': status
|
|
20272
|
+
'status': status,
|
|
20273
|
+
'tags': tags
|
|
20272
20274
|
},
|
|
20273
20275
|
errors: {
|
|
20274
20276
|
401: `Authentication required.`,
|
|
@@ -20280,7 +20282,7 @@ class CrmService {
|
|
|
20280
20282
|
* Create a deal
|
|
20281
20283
|
* Creates a new Deal. All FK targets (`person`, `organization`, `pipeline`, `stage`, `source`) must belong to your Platform; `stage` must belong to `pipeline`. `status` and `closed_at` are service-managed — passing them returns `400`.
|
|
20282
20284
|
*
|
|
20283
|
-
* **Required permission:** `Ibl.CRM/Deals/
|
|
20285
|
+
* **Required permission:** `Ibl.CRM/Deals/action`.
|
|
20284
20286
|
* @returns Deal
|
|
20285
20287
|
* @throws ApiError
|
|
20286
20288
|
*/
|
|
@@ -20294,7 +20296,7 @@ class CrmService {
|
|
|
20294
20296
|
mediaType: 'application/json',
|
|
20295
20297
|
errors: {
|
|
20296
20298
|
400: `Validation error.`,
|
|
20297
|
-
403: `Missing required permission \`Ibl.CRM/Deals/
|
|
20299
|
+
403: `Missing required permission \`Ibl.CRM/Deals/action\`.`
|
|
20298
20300
|
}
|
|
20299
20301
|
});
|
|
20300
20302
|
}
|
|
@@ -20452,6 +20454,59 @@ class CrmService {
|
|
|
20452
20454
|
}
|
|
20453
20455
|
});
|
|
20454
20456
|
}
|
|
20457
|
+
/**
|
|
20458
|
+
* Attach a tag to this record
|
|
20459
|
+
* 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.
|
|
20460
|
+
*
|
|
20461
|
+
* **Required permission:** `Ibl.CRM/Tags/write`.
|
|
20462
|
+
* @returns any No response body
|
|
20463
|
+
* @throws ApiError
|
|
20464
|
+
*/
|
|
20465
|
+
static crmDealsTagsCreate({
|
|
20466
|
+
id,
|
|
20467
|
+
requestBody
|
|
20468
|
+
}) {
|
|
20469
|
+
return request(OpenAPI, {
|
|
20470
|
+
method: 'POST',
|
|
20471
|
+
url: '/api/crm/deals/{id}/tags/',
|
|
20472
|
+
path: {
|
|
20473
|
+
'id': id
|
|
20474
|
+
},
|
|
20475
|
+
body: requestBody,
|
|
20476
|
+
mediaType: 'application/json',
|
|
20477
|
+
errors: {
|
|
20478
|
+
400: `No response body`,
|
|
20479
|
+
403: `No response body`,
|
|
20480
|
+
404: `No response body`,
|
|
20481
|
+
409: `No response body`
|
|
20482
|
+
}
|
|
20483
|
+
});
|
|
20484
|
+
}
|
|
20485
|
+
/**
|
|
20486
|
+
* Detach a tag from this record
|
|
20487
|
+
* Removes the Tag with id `tag_id` from this record. Returns `404` if the tag was not attached.
|
|
20488
|
+
*
|
|
20489
|
+
* **Required permission:** `Ibl.CRM/Tags/write`.
|
|
20490
|
+
* @returns void
|
|
20491
|
+
* @throws ApiError
|
|
20492
|
+
*/
|
|
20493
|
+
static crmDealsTagsDestroy({
|
|
20494
|
+
id,
|
|
20495
|
+
tagId
|
|
20496
|
+
}) {
|
|
20497
|
+
return request(OpenAPI, {
|
|
20498
|
+
method: 'DELETE',
|
|
20499
|
+
url: '/api/crm/deals/{id}/tags/{tag_id}/',
|
|
20500
|
+
path: {
|
|
20501
|
+
'id': id,
|
|
20502
|
+
'tag_id': tagId
|
|
20503
|
+
},
|
|
20504
|
+
errors: {
|
|
20505
|
+
403: `No response body`,
|
|
20506
|
+
404: `No response body`
|
|
20507
|
+
}
|
|
20508
|
+
});
|
|
20509
|
+
}
|
|
20455
20510
|
/**
|
|
20456
20511
|
* Mark a deal as won
|
|
20457
20512
|
* Moves the Deal into a closed-won stage and sets `status='won'`. If `stage_code` is omitted, the first `is_won=True` stage in the Deal's pipeline (by sort order) is used.
|
|
@@ -20512,7 +20567,7 @@ class CrmService {
|
|
|
20512
20567
|
* Create a lead source
|
|
20513
20568
|
* Creates a new LeadSource in your Platform. `code` must be unique.
|
|
20514
20569
|
*
|
|
20515
|
-
* **Required permission:** `Ibl.CRM/Pipelines/
|
|
20570
|
+
* **Required permission:** `Ibl.CRM/Pipelines/action`.
|
|
20516
20571
|
* @returns LeadSource
|
|
20517
20572
|
* @throws ApiError
|
|
20518
20573
|
*/
|
|
@@ -20526,7 +20581,7 @@ class CrmService {
|
|
|
20526
20581
|
mediaType: 'application/json',
|
|
20527
20582
|
errors: {
|
|
20528
20583
|
400: `Validation error.`,
|
|
20529
|
-
403: `Missing required permission \`Ibl.CRM/Pipelines/
|
|
20584
|
+
403: `Missing required permission \`Ibl.CRM/Pipelines/action\`.`
|
|
20530
20585
|
}
|
|
20531
20586
|
});
|
|
20532
20587
|
}
|
|
@@ -20642,7 +20697,8 @@ class CrmService {
|
|
|
20642
20697
|
name,
|
|
20643
20698
|
owner,
|
|
20644
20699
|
page,
|
|
20645
|
-
pageSize
|
|
20700
|
+
pageSize,
|
|
20701
|
+
tags
|
|
20646
20702
|
}) {
|
|
20647
20703
|
return request(OpenAPI, {
|
|
20648
20704
|
method: 'GET',
|
|
@@ -20651,7 +20707,8 @@ class CrmService {
|
|
|
20651
20707
|
'name': name,
|
|
20652
20708
|
'owner': owner,
|
|
20653
20709
|
'page': page,
|
|
20654
|
-
'page_size': pageSize
|
|
20710
|
+
'page_size': pageSize,
|
|
20711
|
+
'tags': tags
|
|
20655
20712
|
},
|
|
20656
20713
|
errors: {
|
|
20657
20714
|
401: `Authentication required.`,
|
|
@@ -20663,7 +20720,7 @@ class CrmService {
|
|
|
20663
20720
|
* Create an organization
|
|
20664
20721
|
* Creates a new organization in your Platform. The Platform is inferred from your credentials. `name` must be unique within your Platform.
|
|
20665
20722
|
*
|
|
20666
|
-
* **Required permission:** `Ibl.CRM/Organizations/
|
|
20723
|
+
* **Required permission:** `Ibl.CRM/Organizations/action`.
|
|
20667
20724
|
* @returns Organization
|
|
20668
20725
|
* @throws ApiError
|
|
20669
20726
|
*/
|
|
@@ -20677,7 +20734,7 @@ class CrmService {
|
|
|
20677
20734
|
mediaType: 'application/json',
|
|
20678
20735
|
errors: {
|
|
20679
20736
|
400: `Validation error (for example, duplicate name).`,
|
|
20680
|
-
403: `Missing required permission \`Ibl.CRM/Organizations/
|
|
20737
|
+
403: `Missing required permission \`Ibl.CRM/Organizations/action\`.`
|
|
20681
20738
|
}
|
|
20682
20739
|
});
|
|
20683
20740
|
}
|
|
@@ -20781,6 +20838,59 @@ class CrmService {
|
|
|
20781
20838
|
}
|
|
20782
20839
|
});
|
|
20783
20840
|
}
|
|
20841
|
+
/**
|
|
20842
|
+
* Attach a tag to this record
|
|
20843
|
+
* 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.
|
|
20844
|
+
*
|
|
20845
|
+
* **Required permission:** `Ibl.CRM/Tags/write`.
|
|
20846
|
+
* @returns any No response body
|
|
20847
|
+
* @throws ApiError
|
|
20848
|
+
*/
|
|
20849
|
+
static crmOrganizationsTagsCreate({
|
|
20850
|
+
id,
|
|
20851
|
+
requestBody
|
|
20852
|
+
}) {
|
|
20853
|
+
return request(OpenAPI, {
|
|
20854
|
+
method: 'POST',
|
|
20855
|
+
url: '/api/crm/organizations/{id}/tags/',
|
|
20856
|
+
path: {
|
|
20857
|
+
'id': id
|
|
20858
|
+
},
|
|
20859
|
+
body: requestBody,
|
|
20860
|
+
mediaType: 'application/json',
|
|
20861
|
+
errors: {
|
|
20862
|
+
400: `No response body`,
|
|
20863
|
+
403: `No response body`,
|
|
20864
|
+
404: `No response body`,
|
|
20865
|
+
409: `No response body`
|
|
20866
|
+
}
|
|
20867
|
+
});
|
|
20868
|
+
}
|
|
20869
|
+
/**
|
|
20870
|
+
* Detach a tag from this record
|
|
20871
|
+
* Removes the Tag with id `tag_id` from this record. Returns `404` if the tag was not attached.
|
|
20872
|
+
*
|
|
20873
|
+
* **Required permission:** `Ibl.CRM/Tags/write`.
|
|
20874
|
+
* @returns void
|
|
20875
|
+
* @throws ApiError
|
|
20876
|
+
*/
|
|
20877
|
+
static crmOrganizationsTagsDestroy({
|
|
20878
|
+
id,
|
|
20879
|
+
tagId
|
|
20880
|
+
}) {
|
|
20881
|
+
return request(OpenAPI, {
|
|
20882
|
+
method: 'DELETE',
|
|
20883
|
+
url: '/api/crm/organizations/{id}/tags/{tag_id}/',
|
|
20884
|
+
path: {
|
|
20885
|
+
'id': id,
|
|
20886
|
+
'tag_id': tagId
|
|
20887
|
+
},
|
|
20888
|
+
errors: {
|
|
20889
|
+
403: `No response body`,
|
|
20890
|
+
404: `No response body`
|
|
20891
|
+
}
|
|
20892
|
+
});
|
|
20893
|
+
}
|
|
20784
20894
|
/**
|
|
20785
20895
|
* List persons
|
|
20786
20896
|
* 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`.
|
|
@@ -20797,7 +20907,8 @@ class CrmService {
|
|
|
20797
20907
|
organization,
|
|
20798
20908
|
owner,
|
|
20799
20909
|
page,
|
|
20800
|
-
pageSize
|
|
20910
|
+
pageSize,
|
|
20911
|
+
tags
|
|
20801
20912
|
}) {
|
|
20802
20913
|
return request(OpenAPI, {
|
|
20803
20914
|
method: 'GET',
|
|
@@ -20810,7 +20921,8 @@ class CrmService {
|
|
|
20810
20921
|
'organization': organization,
|
|
20811
20922
|
'owner': owner,
|
|
20812
20923
|
'page': page,
|
|
20813
|
-
'page_size': pageSize
|
|
20924
|
+
'page_size': pageSize,
|
|
20925
|
+
'tags': tags
|
|
20814
20926
|
},
|
|
20815
20927
|
errors: {
|
|
20816
20928
|
401: `Authentication required.`,
|
|
@@ -20822,7 +20934,7 @@ class CrmService {
|
|
|
20822
20934
|
* Create a person
|
|
20823
20935
|
* Creates a new person in your Platform. The Platform is inferred from your credentials. If `organization` is supplied, it must reference an organization in your Platform.
|
|
20824
20936
|
*
|
|
20825
|
-
* **Required permission:** `Ibl.CRM/Persons/
|
|
20937
|
+
* **Required permission:** `Ibl.CRM/Persons/action`.
|
|
20826
20938
|
* @returns Person
|
|
20827
20939
|
* @throws ApiError
|
|
20828
20940
|
*/
|
|
@@ -20836,7 +20948,7 @@ class CrmService {
|
|
|
20836
20948
|
mediaType: 'application/json',
|
|
20837
20949
|
errors: {
|
|
20838
20950
|
400: `Validation error.`,
|
|
20839
|
-
403: `Missing required permission \`Ibl.CRM/Persons/
|
|
20951
|
+
403: `Missing required permission \`Ibl.CRM/Persons/action\`.`
|
|
20840
20952
|
}
|
|
20841
20953
|
});
|
|
20842
20954
|
}
|
|
@@ -20999,6 +21111,59 @@ class CrmService {
|
|
|
20999
21111
|
}
|
|
21000
21112
|
});
|
|
21001
21113
|
}
|
|
21114
|
+
/**
|
|
21115
|
+
* Attach a tag to this record
|
|
21116
|
+
* 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.
|
|
21117
|
+
*
|
|
21118
|
+
* **Required permission:** `Ibl.CRM/Tags/write`.
|
|
21119
|
+
* @returns any No response body
|
|
21120
|
+
* @throws ApiError
|
|
21121
|
+
*/
|
|
21122
|
+
static crmPersonsTagsCreate({
|
|
21123
|
+
id,
|
|
21124
|
+
requestBody
|
|
21125
|
+
}) {
|
|
21126
|
+
return request(OpenAPI, {
|
|
21127
|
+
method: 'POST',
|
|
21128
|
+
url: '/api/crm/persons/{id}/tags/',
|
|
21129
|
+
path: {
|
|
21130
|
+
'id': id
|
|
21131
|
+
},
|
|
21132
|
+
body: requestBody,
|
|
21133
|
+
mediaType: 'application/json',
|
|
21134
|
+
errors: {
|
|
21135
|
+
400: `No response body`,
|
|
21136
|
+
403: `No response body`,
|
|
21137
|
+
404: `No response body`,
|
|
21138
|
+
409: `No response body`
|
|
21139
|
+
}
|
|
21140
|
+
});
|
|
21141
|
+
}
|
|
21142
|
+
/**
|
|
21143
|
+
* Detach a tag from this record
|
|
21144
|
+
* Removes the Tag with id `tag_id` from this record. Returns `404` if the tag was not attached.
|
|
21145
|
+
*
|
|
21146
|
+
* **Required permission:** `Ibl.CRM/Tags/write`.
|
|
21147
|
+
* @returns void
|
|
21148
|
+
* @throws ApiError
|
|
21149
|
+
*/
|
|
21150
|
+
static crmPersonsTagsDestroy({
|
|
21151
|
+
id,
|
|
21152
|
+
tagId
|
|
21153
|
+
}) {
|
|
21154
|
+
return request(OpenAPI, {
|
|
21155
|
+
method: 'DELETE',
|
|
21156
|
+
url: '/api/crm/persons/{id}/tags/{tag_id}/',
|
|
21157
|
+
path: {
|
|
21158
|
+
'id': id,
|
|
21159
|
+
'tag_id': tagId
|
|
21160
|
+
},
|
|
21161
|
+
errors: {
|
|
21162
|
+
403: `No response body`,
|
|
21163
|
+
404: `No response body`
|
|
21164
|
+
}
|
|
21165
|
+
});
|
|
21166
|
+
}
|
|
21002
21167
|
/**
|
|
21003
21168
|
* Merge duplicate persons into a primary
|
|
21004
21169
|
* Marks each person in `duplicate_ids` as inactive and reports how many related records (deals, activities, tags) were re-parented onto `primary_id`.
|
|
@@ -21059,7 +21224,7 @@ class CrmService {
|
|
|
21059
21224
|
* Create a pipeline
|
|
21060
21225
|
* Creates a new Pipeline. `code` must be unique within your Platform. Promoting another Pipeline to `is_default=true` while one already exists will fail — unset the existing default first.
|
|
21061
21226
|
*
|
|
21062
|
-
* **Required permission:** `Ibl.CRM/Pipelines/
|
|
21227
|
+
* **Required permission:** `Ibl.CRM/Pipelines/action`.
|
|
21063
21228
|
* @returns Pipeline
|
|
21064
21229
|
* @throws ApiError
|
|
21065
21230
|
*/
|
|
@@ -21073,7 +21238,7 @@ class CrmService {
|
|
|
21073
21238
|
mediaType: 'application/json',
|
|
21074
21239
|
errors: {
|
|
21075
21240
|
400: `Validation error.`,
|
|
21076
|
-
403: `Missing required permission \`Ibl.CRM/Pipelines/
|
|
21241
|
+
403: `Missing required permission \`Ibl.CRM/Pipelines/action\`.`
|
|
21077
21242
|
}
|
|
21078
21243
|
});
|
|
21079
21244
|
}
|
|
@@ -21116,7 +21281,7 @@ class CrmService {
|
|
|
21116
21281
|
* Create a stage
|
|
21117
21282
|
* Creates a new PipelineStage in the URL Pipeline. `code` must be unique within that Pipeline. At most one of `is_won` / `is_lost` may be true.
|
|
21118
21283
|
*
|
|
21119
|
-
* **Required permission:** `Ibl.CRM/Pipelines/
|
|
21284
|
+
* **Required permission:** `Ibl.CRM/Pipelines/action`.
|
|
21120
21285
|
* @returns PipelineStage
|
|
21121
21286
|
* @throws ApiError
|
|
21122
21287
|
*/
|
|
@@ -21134,7 +21299,7 @@ class CrmService {
|
|
|
21134
21299
|
mediaType: 'application/json',
|
|
21135
21300
|
errors: {
|
|
21136
21301
|
400: `Validation error.`,
|
|
21137
|
-
403: `Missing required permission \`Ibl.CRM/Pipelines/
|
|
21302
|
+
403: `Missing required permission \`Ibl.CRM/Pipelines/action\`.`,
|
|
21138
21303
|
404: `Pipeline not found.`
|
|
21139
21304
|
}
|
|
21140
21305
|
});
|
|
@@ -21349,6 +21514,159 @@ class CrmService {
|
|
|
21349
21514
|
}
|
|
21350
21515
|
});
|
|
21351
21516
|
}
|
|
21517
|
+
/**
|
|
21518
|
+
* List tags
|
|
21519
|
+
* 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.
|
|
21520
|
+
*
|
|
21521
|
+
* **Required permission:** `Ibl.CRM/Tags/list`.
|
|
21522
|
+
* @returns PaginatedTagList
|
|
21523
|
+
* @throws ApiError
|
|
21524
|
+
*/
|
|
21525
|
+
static crmTagsList({
|
|
21526
|
+
createdAtGte,
|
|
21527
|
+
createdAtLte,
|
|
21528
|
+
name,
|
|
21529
|
+
page,
|
|
21530
|
+
pageSize
|
|
21531
|
+
}) {
|
|
21532
|
+
return request(OpenAPI, {
|
|
21533
|
+
method: 'GET',
|
|
21534
|
+
url: '/api/crm/tags/',
|
|
21535
|
+
query: {
|
|
21536
|
+
'created_at__gte': createdAtGte,
|
|
21537
|
+
'created_at__lte': createdAtLte,
|
|
21538
|
+
'name': name,
|
|
21539
|
+
'page': page,
|
|
21540
|
+
'page_size': pageSize
|
|
21541
|
+
},
|
|
21542
|
+
errors: {
|
|
21543
|
+
401: `Authentication required.`,
|
|
21544
|
+
403: `Missing required permission \`Ibl.CRM/Tags/list\`.`
|
|
21545
|
+
}
|
|
21546
|
+
});
|
|
21547
|
+
}
|
|
21548
|
+
/**
|
|
21549
|
+
* Create a tag
|
|
21550
|
+
* Creates a new Tag in your Platform. `name` must be unique within your Platform; supply `color` as a `#RRGGBB` hex string (defaults to `#888888`).
|
|
21551
|
+
*
|
|
21552
|
+
* **Required permission:** `Ibl.CRM/Tags/action`.
|
|
21553
|
+
* @returns Tag
|
|
21554
|
+
* @throws ApiError
|
|
21555
|
+
*/
|
|
21556
|
+
static crmTagsCreate({
|
|
21557
|
+
requestBody
|
|
21558
|
+
}) {
|
|
21559
|
+
return request(OpenAPI, {
|
|
21560
|
+
method: 'POST',
|
|
21561
|
+
url: '/api/crm/tags/',
|
|
21562
|
+
body: requestBody,
|
|
21563
|
+
mediaType: 'application/json',
|
|
21564
|
+
errors: {
|
|
21565
|
+
400: `Validation error (duplicate name, bad color, etc.).`,
|
|
21566
|
+
403: `Missing required permission \`Ibl.CRM/Tags/action\`.`
|
|
21567
|
+
}
|
|
21568
|
+
});
|
|
21569
|
+
}
|
|
21570
|
+
/**
|
|
21571
|
+
* Retrieve a tag
|
|
21572
|
+
* Returns a single Tag by id.
|
|
21573
|
+
*
|
|
21574
|
+
* **Required permission:** `Ibl.CRM/Tags/read`.
|
|
21575
|
+
* @returns Tag
|
|
21576
|
+
* @throws ApiError
|
|
21577
|
+
*/
|
|
21578
|
+
static crmTagsRetrieve({
|
|
21579
|
+
id
|
|
21580
|
+
}) {
|
|
21581
|
+
return request(OpenAPI, {
|
|
21582
|
+
method: 'GET',
|
|
21583
|
+
url: '/api/crm/tags/{id}/',
|
|
21584
|
+
path: {
|
|
21585
|
+
'id': id
|
|
21586
|
+
},
|
|
21587
|
+
errors: {
|
|
21588
|
+
403: `Missing required permission \`Ibl.CRM/Tags/read\`.`,
|
|
21589
|
+
404: `Tag not found.`
|
|
21590
|
+
}
|
|
21591
|
+
});
|
|
21592
|
+
}
|
|
21593
|
+
/**
|
|
21594
|
+
* Replace a tag
|
|
21595
|
+
* Replaces all editable fields on the Tag.
|
|
21596
|
+
*
|
|
21597
|
+
* **Required permission:** `Ibl.CRM/Tags/write`.
|
|
21598
|
+
* @returns Tag
|
|
21599
|
+
* @throws ApiError
|
|
21600
|
+
*/
|
|
21601
|
+
static crmTagsUpdate({
|
|
21602
|
+
id,
|
|
21603
|
+
requestBody
|
|
21604
|
+
}) {
|
|
21605
|
+
return request(OpenAPI, {
|
|
21606
|
+
method: 'PUT',
|
|
21607
|
+
url: '/api/crm/tags/{id}/',
|
|
21608
|
+
path: {
|
|
21609
|
+
'id': id
|
|
21610
|
+
},
|
|
21611
|
+
body: requestBody,
|
|
21612
|
+
mediaType: 'application/json',
|
|
21613
|
+
errors: {
|
|
21614
|
+
400: `Validation error.`,
|
|
21615
|
+
403: `Missing required permission \`Ibl.CRM/Tags/write\`.`,
|
|
21616
|
+
404: `Tag not found.`
|
|
21617
|
+
}
|
|
21618
|
+
});
|
|
21619
|
+
}
|
|
21620
|
+
/**
|
|
21621
|
+
* Update a tag
|
|
21622
|
+
* Updates only the supplied fields on the Tag (typically `name` or `color`).
|
|
21623
|
+
*
|
|
21624
|
+
* **Required permission:** `Ibl.CRM/Tags/write`.
|
|
21625
|
+
* @returns Tag
|
|
21626
|
+
* @throws ApiError
|
|
21627
|
+
*/
|
|
21628
|
+
static crmTagsPartialUpdate({
|
|
21629
|
+
id,
|
|
21630
|
+
requestBody
|
|
21631
|
+
}) {
|
|
21632
|
+
return request(OpenAPI, {
|
|
21633
|
+
method: 'PATCH',
|
|
21634
|
+
url: '/api/crm/tags/{id}/',
|
|
21635
|
+
path: {
|
|
21636
|
+
'id': id
|
|
21637
|
+
},
|
|
21638
|
+
body: requestBody,
|
|
21639
|
+
mediaType: 'application/json',
|
|
21640
|
+
errors: {
|
|
21641
|
+
400: `Validation error.`,
|
|
21642
|
+
403: `Missing required permission \`Ibl.CRM/Tags/write\`.`,
|
|
21643
|
+
404: `Tag not found.`
|
|
21644
|
+
}
|
|
21645
|
+
});
|
|
21646
|
+
}
|
|
21647
|
+
/**
|
|
21648
|
+
* Delete a tag
|
|
21649
|
+
* Deletes the Tag. All attachments to Persons, Organizations, and Deals are removed atomically via cascade.
|
|
21650
|
+
*
|
|
21651
|
+
* **Required permission:** `Ibl.CRM/Tags/delete`.
|
|
21652
|
+
* @returns void
|
|
21653
|
+
* @throws ApiError
|
|
21654
|
+
*/
|
|
21655
|
+
static crmTagsDestroy({
|
|
21656
|
+
id
|
|
21657
|
+
}) {
|
|
21658
|
+
return request(OpenAPI, {
|
|
21659
|
+
method: 'DELETE',
|
|
21660
|
+
url: '/api/crm/tags/{id}/',
|
|
21661
|
+
path: {
|
|
21662
|
+
'id': id
|
|
21663
|
+
},
|
|
21664
|
+
errors: {
|
|
21665
|
+
403: `Missing required permission \`Ibl.CRM/Tags/delete\`.`,
|
|
21666
|
+
404: `Tag not found.`
|
|
21667
|
+
}
|
|
21668
|
+
});
|
|
21669
|
+
}
|
|
21352
21670
|
}
|
|
21353
21671
|
|
|
21354
21672
|
class CustomDomainsService {
|
|
@@ -21463,7 +21781,8 @@ class DealsService {
|
|
|
21463
21781
|
pipeline,
|
|
21464
21782
|
source,
|
|
21465
21783
|
stage,
|
|
21466
|
-
status
|
|
21784
|
+
status,
|
|
21785
|
+
tags
|
|
21467
21786
|
}) {
|
|
21468
21787
|
return request(OpenAPI, {
|
|
21469
21788
|
method: 'GET',
|
|
@@ -21482,7 +21801,8 @@ class DealsService {
|
|
|
21482
21801
|
'pipeline': pipeline,
|
|
21483
21802
|
'source': source,
|
|
21484
21803
|
'stage': stage,
|
|
21485
|
-
'status': status
|
|
21804
|
+
'status': status,
|
|
21805
|
+
'tags': tags
|
|
21486
21806
|
},
|
|
21487
21807
|
errors: {
|
|
21488
21808
|
401: `Authentication required.`,
|
|
@@ -21494,7 +21814,7 @@ class DealsService {
|
|
|
21494
21814
|
* Create a deal
|
|
21495
21815
|
* Creates a new Deal. All FK targets (`person`, `organization`, `pipeline`, `stage`, `source`) must belong to your Platform; `stage` must belong to `pipeline`. `status` and `closed_at` are service-managed — passing them returns `400`.
|
|
21496
21816
|
*
|
|
21497
|
-
* **Required permission:** `Ibl.CRM/Deals/
|
|
21817
|
+
* **Required permission:** `Ibl.CRM/Deals/action`.
|
|
21498
21818
|
* @returns Deal
|
|
21499
21819
|
* @throws ApiError
|
|
21500
21820
|
*/
|
|
@@ -21508,7 +21828,7 @@ class DealsService {
|
|
|
21508
21828
|
mediaType: 'application/json',
|
|
21509
21829
|
errors: {
|
|
21510
21830
|
400: `Validation error.`,
|
|
21511
|
-
403: `Missing required permission \`Ibl.CRM/Deals/
|
|
21831
|
+
403: `Missing required permission \`Ibl.CRM/Deals/action\`.`
|
|
21512
21832
|
}
|
|
21513
21833
|
});
|
|
21514
21834
|
}
|
|
@@ -21666,6 +21986,59 @@ class DealsService {
|
|
|
21666
21986
|
}
|
|
21667
21987
|
});
|
|
21668
21988
|
}
|
|
21989
|
+
/**
|
|
21990
|
+
* Attach a tag to this record
|
|
21991
|
+
* 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.
|
|
21992
|
+
*
|
|
21993
|
+
* **Required permission:** `Ibl.CRM/Tags/write`.
|
|
21994
|
+
* @returns any No response body
|
|
21995
|
+
* @throws ApiError
|
|
21996
|
+
*/
|
|
21997
|
+
static dealsTagsCreate({
|
|
21998
|
+
id,
|
|
21999
|
+
requestBody
|
|
22000
|
+
}) {
|
|
22001
|
+
return request(OpenAPI, {
|
|
22002
|
+
method: 'POST',
|
|
22003
|
+
url: '/deals/{id}/tags/',
|
|
22004
|
+
path: {
|
|
22005
|
+
'id': id
|
|
22006
|
+
},
|
|
22007
|
+
body: requestBody,
|
|
22008
|
+
mediaType: 'application/json',
|
|
22009
|
+
errors: {
|
|
22010
|
+
400: `No response body`,
|
|
22011
|
+
403: `No response body`,
|
|
22012
|
+
404: `No response body`,
|
|
22013
|
+
409: `No response body`
|
|
22014
|
+
}
|
|
22015
|
+
});
|
|
22016
|
+
}
|
|
22017
|
+
/**
|
|
22018
|
+
* Detach a tag from this record
|
|
22019
|
+
* Removes the Tag with id `tag_id` from this record. Returns `404` if the tag was not attached.
|
|
22020
|
+
*
|
|
22021
|
+
* **Required permission:** `Ibl.CRM/Tags/write`.
|
|
22022
|
+
* @returns void
|
|
22023
|
+
* @throws ApiError
|
|
22024
|
+
*/
|
|
22025
|
+
static dealsTagsDestroy({
|
|
22026
|
+
id,
|
|
22027
|
+
tagId
|
|
22028
|
+
}) {
|
|
22029
|
+
return request(OpenAPI, {
|
|
22030
|
+
method: 'DELETE',
|
|
22031
|
+
url: '/deals/{id}/tags/{tag_id}/',
|
|
22032
|
+
path: {
|
|
22033
|
+
'id': id,
|
|
22034
|
+
'tag_id': tagId
|
|
22035
|
+
},
|
|
22036
|
+
errors: {
|
|
22037
|
+
403: `No response body`,
|
|
22038
|
+
404: `No response body`
|
|
22039
|
+
}
|
|
22040
|
+
});
|
|
22041
|
+
}
|
|
21669
22042
|
/**
|
|
21670
22043
|
* Mark a deal as won
|
|
21671
22044
|
* Moves the Deal into a closed-won stage and sets `status='won'`. If `stage_code` is omitted, the first `is_won=True` stage in the Deal's pipeline (by sort order) is used.
|
|
@@ -21862,7 +22235,7 @@ class LeadSourcesService {
|
|
|
21862
22235
|
* Create a lead source
|
|
21863
22236
|
* Creates a new LeadSource in your Platform. `code` must be unique.
|
|
21864
22237
|
*
|
|
21865
|
-
* **Required permission:** `Ibl.CRM/Pipelines/
|
|
22238
|
+
* **Required permission:** `Ibl.CRM/Pipelines/action`.
|
|
21866
22239
|
* @returns LeadSource
|
|
21867
22240
|
* @throws ApiError
|
|
21868
22241
|
*/
|
|
@@ -21876,7 +22249,7 @@ class LeadSourcesService {
|
|
|
21876
22249
|
mediaType: 'application/json',
|
|
21877
22250
|
errors: {
|
|
21878
22251
|
400: `Validation error.`,
|
|
21879
|
-
403: `Missing required permission \`Ibl.CRM/Pipelines/
|
|
22252
|
+
403: `Missing required permission \`Ibl.CRM/Pipelines/action\`.`
|
|
21880
22253
|
}
|
|
21881
22254
|
});
|
|
21882
22255
|
}
|
|
@@ -22879,7 +23252,8 @@ class OrganizationsService {
|
|
|
22879
23252
|
name,
|
|
22880
23253
|
owner,
|
|
22881
23254
|
page,
|
|
22882
|
-
pageSize
|
|
23255
|
+
pageSize,
|
|
23256
|
+
tags
|
|
22883
23257
|
}) {
|
|
22884
23258
|
return request(OpenAPI, {
|
|
22885
23259
|
method: 'GET',
|
|
@@ -22888,7 +23262,8 @@ class OrganizationsService {
|
|
|
22888
23262
|
'name': name,
|
|
22889
23263
|
'owner': owner,
|
|
22890
23264
|
'page': page,
|
|
22891
|
-
'page_size': pageSize
|
|
23265
|
+
'page_size': pageSize,
|
|
23266
|
+
'tags': tags
|
|
22892
23267
|
},
|
|
22893
23268
|
errors: {
|
|
22894
23269
|
401: `Authentication required.`,
|
|
@@ -22900,7 +23275,7 @@ class OrganizationsService {
|
|
|
22900
23275
|
* Create an organization
|
|
22901
23276
|
* Creates a new organization in your Platform. The Platform is inferred from your credentials. `name` must be unique within your Platform.
|
|
22902
23277
|
*
|
|
22903
|
-
* **Required permission:** `Ibl.CRM/Organizations/
|
|
23278
|
+
* **Required permission:** `Ibl.CRM/Organizations/action`.
|
|
22904
23279
|
* @returns Organization
|
|
22905
23280
|
* @throws ApiError
|
|
22906
23281
|
*/
|
|
@@ -22914,7 +23289,7 @@ class OrganizationsService {
|
|
|
22914
23289
|
mediaType: 'application/json',
|
|
22915
23290
|
errors: {
|
|
22916
23291
|
400: `Validation error (for example, duplicate name).`,
|
|
22917
|
-
403: `Missing required permission \`Ibl.CRM/Organizations/
|
|
23292
|
+
403: `Missing required permission \`Ibl.CRM/Organizations/action\`.`
|
|
22918
23293
|
}
|
|
22919
23294
|
});
|
|
22920
23295
|
}
|
|
@@ -23018,6 +23393,59 @@ class OrganizationsService {
|
|
|
23018
23393
|
}
|
|
23019
23394
|
});
|
|
23020
23395
|
}
|
|
23396
|
+
/**
|
|
23397
|
+
* Attach a tag to this record
|
|
23398
|
+
* 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.
|
|
23399
|
+
*
|
|
23400
|
+
* **Required permission:** `Ibl.CRM/Tags/write`.
|
|
23401
|
+
* @returns any No response body
|
|
23402
|
+
* @throws ApiError
|
|
23403
|
+
*/
|
|
23404
|
+
static organizationsTagsCreate({
|
|
23405
|
+
id,
|
|
23406
|
+
requestBody
|
|
23407
|
+
}) {
|
|
23408
|
+
return request(OpenAPI, {
|
|
23409
|
+
method: 'POST',
|
|
23410
|
+
url: '/organizations/{id}/tags/',
|
|
23411
|
+
path: {
|
|
23412
|
+
'id': id
|
|
23413
|
+
},
|
|
23414
|
+
body: requestBody,
|
|
23415
|
+
mediaType: 'application/json',
|
|
23416
|
+
errors: {
|
|
23417
|
+
400: `No response body`,
|
|
23418
|
+
403: `No response body`,
|
|
23419
|
+
404: `No response body`,
|
|
23420
|
+
409: `No response body`
|
|
23421
|
+
}
|
|
23422
|
+
});
|
|
23423
|
+
}
|
|
23424
|
+
/**
|
|
23425
|
+
* Detach a tag from this record
|
|
23426
|
+
* Removes the Tag with id `tag_id` from this record. Returns `404` if the tag was not attached.
|
|
23427
|
+
*
|
|
23428
|
+
* **Required permission:** `Ibl.CRM/Tags/write`.
|
|
23429
|
+
* @returns void
|
|
23430
|
+
* @throws ApiError
|
|
23431
|
+
*/
|
|
23432
|
+
static organizationsTagsDestroy({
|
|
23433
|
+
id,
|
|
23434
|
+
tagId
|
|
23435
|
+
}) {
|
|
23436
|
+
return request(OpenAPI, {
|
|
23437
|
+
method: 'DELETE',
|
|
23438
|
+
url: '/organizations/{id}/tags/{tag_id}/',
|
|
23439
|
+
path: {
|
|
23440
|
+
'id': id,
|
|
23441
|
+
'tag_id': tagId
|
|
23442
|
+
},
|
|
23443
|
+
errors: {
|
|
23444
|
+
403: `No response body`,
|
|
23445
|
+
404: `No response body`
|
|
23446
|
+
}
|
|
23447
|
+
});
|
|
23448
|
+
}
|
|
23021
23449
|
}
|
|
23022
23450
|
|
|
23023
23451
|
class PersonsService {
|
|
@@ -23037,7 +23465,8 @@ class PersonsService {
|
|
|
23037
23465
|
organization,
|
|
23038
23466
|
owner,
|
|
23039
23467
|
page,
|
|
23040
|
-
pageSize
|
|
23468
|
+
pageSize,
|
|
23469
|
+
tags
|
|
23041
23470
|
}) {
|
|
23042
23471
|
return request(OpenAPI, {
|
|
23043
23472
|
method: 'GET',
|
|
@@ -23050,7 +23479,8 @@ class PersonsService {
|
|
|
23050
23479
|
'organization': organization,
|
|
23051
23480
|
'owner': owner,
|
|
23052
23481
|
'page': page,
|
|
23053
|
-
'page_size': pageSize
|
|
23482
|
+
'page_size': pageSize,
|
|
23483
|
+
'tags': tags
|
|
23054
23484
|
},
|
|
23055
23485
|
errors: {
|
|
23056
23486
|
401: `Authentication required.`,
|
|
@@ -23062,7 +23492,7 @@ class PersonsService {
|
|
|
23062
23492
|
* Create a person
|
|
23063
23493
|
* Creates a new person in your Platform. The Platform is inferred from your credentials. If `organization` is supplied, it must reference an organization in your Platform.
|
|
23064
23494
|
*
|
|
23065
|
-
* **Required permission:** `Ibl.CRM/Persons/
|
|
23495
|
+
* **Required permission:** `Ibl.CRM/Persons/action`.
|
|
23066
23496
|
* @returns Person
|
|
23067
23497
|
* @throws ApiError
|
|
23068
23498
|
*/
|
|
@@ -23076,7 +23506,7 @@ class PersonsService {
|
|
|
23076
23506
|
mediaType: 'application/json',
|
|
23077
23507
|
errors: {
|
|
23078
23508
|
400: `Validation error.`,
|
|
23079
|
-
403: `Missing required permission \`Ibl.CRM/Persons/
|
|
23509
|
+
403: `Missing required permission \`Ibl.CRM/Persons/action\`.`
|
|
23080
23510
|
}
|
|
23081
23511
|
});
|
|
23082
23512
|
}
|
|
@@ -23239,6 +23669,59 @@ class PersonsService {
|
|
|
23239
23669
|
}
|
|
23240
23670
|
});
|
|
23241
23671
|
}
|
|
23672
|
+
/**
|
|
23673
|
+
* Attach a tag to this record
|
|
23674
|
+
* 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.
|
|
23675
|
+
*
|
|
23676
|
+
* **Required permission:** `Ibl.CRM/Tags/write`.
|
|
23677
|
+
* @returns any No response body
|
|
23678
|
+
* @throws ApiError
|
|
23679
|
+
*/
|
|
23680
|
+
static personsTagsCreate({
|
|
23681
|
+
id,
|
|
23682
|
+
requestBody
|
|
23683
|
+
}) {
|
|
23684
|
+
return request(OpenAPI, {
|
|
23685
|
+
method: 'POST',
|
|
23686
|
+
url: '/persons/{id}/tags/',
|
|
23687
|
+
path: {
|
|
23688
|
+
'id': id
|
|
23689
|
+
},
|
|
23690
|
+
body: requestBody,
|
|
23691
|
+
mediaType: 'application/json',
|
|
23692
|
+
errors: {
|
|
23693
|
+
400: `No response body`,
|
|
23694
|
+
403: `No response body`,
|
|
23695
|
+
404: `No response body`,
|
|
23696
|
+
409: `No response body`
|
|
23697
|
+
}
|
|
23698
|
+
});
|
|
23699
|
+
}
|
|
23700
|
+
/**
|
|
23701
|
+
* Detach a tag from this record
|
|
23702
|
+
* Removes the Tag with id `tag_id` from this record. Returns `404` if the tag was not attached.
|
|
23703
|
+
*
|
|
23704
|
+
* **Required permission:** `Ibl.CRM/Tags/write`.
|
|
23705
|
+
* @returns void
|
|
23706
|
+
* @throws ApiError
|
|
23707
|
+
*/
|
|
23708
|
+
static personsTagsDestroy({
|
|
23709
|
+
id,
|
|
23710
|
+
tagId
|
|
23711
|
+
}) {
|
|
23712
|
+
return request(OpenAPI, {
|
|
23713
|
+
method: 'DELETE',
|
|
23714
|
+
url: '/persons/{id}/tags/{tag_id}/',
|
|
23715
|
+
path: {
|
|
23716
|
+
'id': id,
|
|
23717
|
+
'tag_id': tagId
|
|
23718
|
+
},
|
|
23719
|
+
errors: {
|
|
23720
|
+
403: `No response body`,
|
|
23721
|
+
404: `No response body`
|
|
23722
|
+
}
|
|
23723
|
+
});
|
|
23724
|
+
}
|
|
23242
23725
|
/**
|
|
23243
23726
|
* Merge duplicate persons into a primary
|
|
23244
23727
|
* Marks each person in `duplicate_ids` as inactive and reports how many related records (deals, activities, tags) were re-parented onto `primary_id`.
|
|
@@ -23302,7 +23785,7 @@ class PipelinesService {
|
|
|
23302
23785
|
* Create a pipeline
|
|
23303
23786
|
* Creates a new Pipeline. `code` must be unique within your Platform. Promoting another Pipeline to `is_default=true` while one already exists will fail — unset the existing default first.
|
|
23304
23787
|
*
|
|
23305
|
-
* **Required permission:** `Ibl.CRM/Pipelines/
|
|
23788
|
+
* **Required permission:** `Ibl.CRM/Pipelines/action`.
|
|
23306
23789
|
* @returns Pipeline
|
|
23307
23790
|
* @throws ApiError
|
|
23308
23791
|
*/
|
|
@@ -23316,7 +23799,7 @@ class PipelinesService {
|
|
|
23316
23799
|
mediaType: 'application/json',
|
|
23317
23800
|
errors: {
|
|
23318
23801
|
400: `Validation error.`,
|
|
23319
|
-
403: `Missing required permission \`Ibl.CRM/Pipelines/
|
|
23802
|
+
403: `Missing required permission \`Ibl.CRM/Pipelines/action\`.`
|
|
23320
23803
|
}
|
|
23321
23804
|
});
|
|
23322
23805
|
}
|
|
@@ -23359,7 +23842,7 @@ class PipelinesService {
|
|
|
23359
23842
|
* Create a stage
|
|
23360
23843
|
* Creates a new PipelineStage in the URL Pipeline. `code` must be unique within that Pipeline. At most one of `is_won` / `is_lost` may be true.
|
|
23361
23844
|
*
|
|
23362
|
-
* **Required permission:** `Ibl.CRM/Pipelines/
|
|
23845
|
+
* **Required permission:** `Ibl.CRM/Pipelines/action`.
|
|
23363
23846
|
* @returns PipelineStage
|
|
23364
23847
|
* @throws ApiError
|
|
23365
23848
|
*/
|
|
@@ -23377,7 +23860,7 @@ class PipelinesService {
|
|
|
23377
23860
|
mediaType: 'application/json',
|
|
23378
23861
|
errors: {
|
|
23379
23862
|
400: `Validation error.`,
|
|
23380
|
-
403: `Missing required permission \`Ibl.CRM/Pipelines/
|
|
23863
|
+
403: `Missing required permission \`Ibl.CRM/Pipelines/action\`.`,
|
|
23381
23864
|
404: `Pipeline not found.`
|
|
23382
23865
|
}
|
|
23383
23866
|
});
|
|
@@ -25794,6 +26277,162 @@ class SkillsService {
|
|
|
25794
26277
|
}
|
|
25795
26278
|
}
|
|
25796
26279
|
|
|
26280
|
+
class TagsService {
|
|
26281
|
+
/**
|
|
26282
|
+
* List tags
|
|
26283
|
+
* 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.
|
|
26284
|
+
*
|
|
26285
|
+
* **Required permission:** `Ibl.CRM/Tags/list`.
|
|
26286
|
+
* @returns PaginatedTagList
|
|
26287
|
+
* @throws ApiError
|
|
26288
|
+
*/
|
|
26289
|
+
static tagsList({
|
|
26290
|
+
createdAtGte,
|
|
26291
|
+
createdAtLte,
|
|
26292
|
+
name,
|
|
26293
|
+
page,
|
|
26294
|
+
pageSize
|
|
26295
|
+
}) {
|
|
26296
|
+
return request(OpenAPI, {
|
|
26297
|
+
method: 'GET',
|
|
26298
|
+
url: '/tags/',
|
|
26299
|
+
query: {
|
|
26300
|
+
'created_at__gte': createdAtGte,
|
|
26301
|
+
'created_at__lte': createdAtLte,
|
|
26302
|
+
'name': name,
|
|
26303
|
+
'page': page,
|
|
26304
|
+
'page_size': pageSize
|
|
26305
|
+
},
|
|
26306
|
+
errors: {
|
|
26307
|
+
401: `Authentication required.`,
|
|
26308
|
+
403: `Missing required permission \`Ibl.CRM/Tags/list\`.`
|
|
26309
|
+
}
|
|
26310
|
+
});
|
|
26311
|
+
}
|
|
26312
|
+
/**
|
|
26313
|
+
* Create a tag
|
|
26314
|
+
* Creates a new Tag in your Platform. `name` must be unique within your Platform; supply `color` as a `#RRGGBB` hex string (defaults to `#888888`).
|
|
26315
|
+
*
|
|
26316
|
+
* **Required permission:** `Ibl.CRM/Tags/action`.
|
|
26317
|
+
* @returns Tag
|
|
26318
|
+
* @throws ApiError
|
|
26319
|
+
*/
|
|
26320
|
+
static tagsCreate({
|
|
26321
|
+
requestBody
|
|
26322
|
+
}) {
|
|
26323
|
+
return request(OpenAPI, {
|
|
26324
|
+
method: 'POST',
|
|
26325
|
+
url: '/tags/',
|
|
26326
|
+
body: requestBody,
|
|
26327
|
+
mediaType: 'application/json',
|
|
26328
|
+
errors: {
|
|
26329
|
+
400: `Validation error (duplicate name, bad color, etc.).`,
|
|
26330
|
+
403: `Missing required permission \`Ibl.CRM/Tags/action\`.`
|
|
26331
|
+
}
|
|
26332
|
+
});
|
|
26333
|
+
}
|
|
26334
|
+
/**
|
|
26335
|
+
* Retrieve a tag
|
|
26336
|
+
* Returns a single Tag by id.
|
|
26337
|
+
*
|
|
26338
|
+
* **Required permission:** `Ibl.CRM/Tags/read`.
|
|
26339
|
+
* @returns Tag
|
|
26340
|
+
* @throws ApiError
|
|
26341
|
+
*/
|
|
26342
|
+
static tagsRetrieve({
|
|
26343
|
+
id
|
|
26344
|
+
}) {
|
|
26345
|
+
return request(OpenAPI, {
|
|
26346
|
+
method: 'GET',
|
|
26347
|
+
url: '/tags/{id}/',
|
|
26348
|
+
path: {
|
|
26349
|
+
'id': id
|
|
26350
|
+
},
|
|
26351
|
+
errors: {
|
|
26352
|
+
403: `Missing required permission \`Ibl.CRM/Tags/read\`.`,
|
|
26353
|
+
404: `Tag not found.`
|
|
26354
|
+
}
|
|
26355
|
+
});
|
|
26356
|
+
}
|
|
26357
|
+
/**
|
|
26358
|
+
* Replace a tag
|
|
26359
|
+
* Replaces all editable fields on the Tag.
|
|
26360
|
+
*
|
|
26361
|
+
* **Required permission:** `Ibl.CRM/Tags/write`.
|
|
26362
|
+
* @returns Tag
|
|
26363
|
+
* @throws ApiError
|
|
26364
|
+
*/
|
|
26365
|
+
static tagsUpdate({
|
|
26366
|
+
id,
|
|
26367
|
+
requestBody
|
|
26368
|
+
}) {
|
|
26369
|
+
return request(OpenAPI, {
|
|
26370
|
+
method: 'PUT',
|
|
26371
|
+
url: '/tags/{id}/',
|
|
26372
|
+
path: {
|
|
26373
|
+
'id': id
|
|
26374
|
+
},
|
|
26375
|
+
body: requestBody,
|
|
26376
|
+
mediaType: 'application/json',
|
|
26377
|
+
errors: {
|
|
26378
|
+
400: `Validation error.`,
|
|
26379
|
+
403: `Missing required permission \`Ibl.CRM/Tags/write\`.`,
|
|
26380
|
+
404: `Tag not found.`
|
|
26381
|
+
}
|
|
26382
|
+
});
|
|
26383
|
+
}
|
|
26384
|
+
/**
|
|
26385
|
+
* Update a tag
|
|
26386
|
+
* Updates only the supplied fields on the Tag (typically `name` or `color`).
|
|
26387
|
+
*
|
|
26388
|
+
* **Required permission:** `Ibl.CRM/Tags/write`.
|
|
26389
|
+
* @returns Tag
|
|
26390
|
+
* @throws ApiError
|
|
26391
|
+
*/
|
|
26392
|
+
static tagsPartialUpdate({
|
|
26393
|
+
id,
|
|
26394
|
+
requestBody
|
|
26395
|
+
}) {
|
|
26396
|
+
return request(OpenAPI, {
|
|
26397
|
+
method: 'PATCH',
|
|
26398
|
+
url: '/tags/{id}/',
|
|
26399
|
+
path: {
|
|
26400
|
+
'id': id
|
|
26401
|
+
},
|
|
26402
|
+
body: requestBody,
|
|
26403
|
+
mediaType: 'application/json',
|
|
26404
|
+
errors: {
|
|
26405
|
+
400: `Validation error.`,
|
|
26406
|
+
403: `Missing required permission \`Ibl.CRM/Tags/write\`.`,
|
|
26407
|
+
404: `Tag not found.`
|
|
26408
|
+
}
|
|
26409
|
+
});
|
|
26410
|
+
}
|
|
26411
|
+
/**
|
|
26412
|
+
* Delete a tag
|
|
26413
|
+
* Deletes the Tag. All attachments to Persons, Organizations, and Deals are removed atomically via cascade.
|
|
26414
|
+
*
|
|
26415
|
+
* **Required permission:** `Ibl.CRM/Tags/delete`.
|
|
26416
|
+
* @returns void
|
|
26417
|
+
* @throws ApiError
|
|
26418
|
+
*/
|
|
26419
|
+
static tagsDestroy({
|
|
26420
|
+
id
|
|
26421
|
+
}) {
|
|
26422
|
+
return request(OpenAPI, {
|
|
26423
|
+
method: 'DELETE',
|
|
26424
|
+
url: '/tags/{id}/',
|
|
26425
|
+
path: {
|
|
26426
|
+
'id': id
|
|
26427
|
+
},
|
|
26428
|
+
errors: {
|
|
26429
|
+
403: `Missing required permission \`Ibl.CRM/Tags/delete\`.`,
|
|
26430
|
+
404: `Tag not found.`
|
|
26431
|
+
}
|
|
26432
|
+
});
|
|
26433
|
+
}
|
|
26434
|
+
}
|
|
26435
|
+
|
|
25797
26436
|
class TransactionsService {
|
|
25798
26437
|
/**
|
|
25799
26438
|
* List transaction history
|
|
@@ -25855,5 +26494,6 @@ exports.ReportsService = ReportsService;
|
|
|
25855
26494
|
exports.ScimService = ScimService;
|
|
25856
26495
|
exports.SearchService = SearchService;
|
|
25857
26496
|
exports.SkillsService = SkillsService;
|
|
26497
|
+
exports.TagsService = TagsService;
|
|
25858
26498
|
exports.TransactionsService = TransactionsService;
|
|
25859
26499
|
//# sourceMappingURL=index.cjs.js.map
|