@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.esm.js
CHANGED
|
@@ -108,7 +108,7 @@ class CancelablePromise {
|
|
|
108
108
|
|
|
109
109
|
const OpenAPI = {
|
|
110
110
|
BASE: 'https://base.manager.iblai.app',
|
|
111
|
-
VERSION: '4.
|
|
111
|
+
VERSION: '4.267.0-core',
|
|
112
112
|
WITH_CREDENTIALS: false,
|
|
113
113
|
CREDENTIALS: 'include',
|
|
114
114
|
TOKEN: undefined,
|
|
@@ -1286,7 +1286,7 @@ class ActivitiesService {
|
|
|
1286
1286
|
* Create an activity
|
|
1287
1287
|
* Creates an Activity. Either `deal` or `person` must be supplied; both must belong to your Platform.
|
|
1288
1288
|
*
|
|
1289
|
-
* **Required permission:** `Ibl.CRM/Activities/
|
|
1289
|
+
* **Required permission:** `Ibl.CRM/Activities/action`.
|
|
1290
1290
|
* @returns Activity
|
|
1291
1291
|
* @throws ApiError
|
|
1292
1292
|
*/
|
|
@@ -1300,7 +1300,7 @@ class ActivitiesService {
|
|
|
1300
1300
|
mediaType: 'application/json',
|
|
1301
1301
|
errors: {
|
|
1302
1302
|
400: `Validation error.`,
|
|
1303
|
-
403: `Missing required permission \`Ibl.CRM/Activities/
|
|
1303
|
+
403: `Missing required permission \`Ibl.CRM/Activities/action\`.`
|
|
1304
1304
|
}
|
|
1305
1305
|
});
|
|
1306
1306
|
}
|
|
@@ -20084,7 +20084,7 @@ class CrmService {
|
|
|
20084
20084
|
* Create an activity
|
|
20085
20085
|
* Creates an Activity. Either `deal` or `person` must be supplied; both must belong to your Platform.
|
|
20086
20086
|
*
|
|
20087
|
-
* **Required permission:** `Ibl.CRM/Activities/
|
|
20087
|
+
* **Required permission:** `Ibl.CRM/Activities/action`.
|
|
20088
20088
|
* @returns Activity
|
|
20089
20089
|
* @throws ApiError
|
|
20090
20090
|
*/
|
|
@@ -20098,7 +20098,7 @@ class CrmService {
|
|
|
20098
20098
|
mediaType: 'application/json',
|
|
20099
20099
|
errors: {
|
|
20100
20100
|
400: `Validation error.`,
|
|
20101
|
-
403: `Missing required permission \`Ibl.CRM/Activities/
|
|
20101
|
+
403: `Missing required permission \`Ibl.CRM/Activities/action\`.`
|
|
20102
20102
|
}
|
|
20103
20103
|
});
|
|
20104
20104
|
}
|
|
@@ -20247,7 +20247,8 @@ class CrmService {
|
|
|
20247
20247
|
pipeline,
|
|
20248
20248
|
source,
|
|
20249
20249
|
stage,
|
|
20250
|
-
status
|
|
20250
|
+
status,
|
|
20251
|
+
tags
|
|
20251
20252
|
}) {
|
|
20252
20253
|
return request(OpenAPI, {
|
|
20253
20254
|
method: 'GET',
|
|
@@ -20266,7 +20267,8 @@ class CrmService {
|
|
|
20266
20267
|
'pipeline': pipeline,
|
|
20267
20268
|
'source': source,
|
|
20268
20269
|
'stage': stage,
|
|
20269
|
-
'status': status
|
|
20270
|
+
'status': status,
|
|
20271
|
+
'tags': tags
|
|
20270
20272
|
},
|
|
20271
20273
|
errors: {
|
|
20272
20274
|
401: `Authentication required.`,
|
|
@@ -20278,7 +20280,7 @@ class CrmService {
|
|
|
20278
20280
|
* Create a deal
|
|
20279
20281
|
* 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`.
|
|
20280
20282
|
*
|
|
20281
|
-
* **Required permission:** `Ibl.CRM/Deals/
|
|
20283
|
+
* **Required permission:** `Ibl.CRM/Deals/action`.
|
|
20282
20284
|
* @returns Deal
|
|
20283
20285
|
* @throws ApiError
|
|
20284
20286
|
*/
|
|
@@ -20292,7 +20294,7 @@ class CrmService {
|
|
|
20292
20294
|
mediaType: 'application/json',
|
|
20293
20295
|
errors: {
|
|
20294
20296
|
400: `Validation error.`,
|
|
20295
|
-
403: `Missing required permission \`Ibl.CRM/Deals/
|
|
20297
|
+
403: `Missing required permission \`Ibl.CRM/Deals/action\`.`
|
|
20296
20298
|
}
|
|
20297
20299
|
});
|
|
20298
20300
|
}
|
|
@@ -20450,6 +20452,59 @@ class CrmService {
|
|
|
20450
20452
|
}
|
|
20451
20453
|
});
|
|
20452
20454
|
}
|
|
20455
|
+
/**
|
|
20456
|
+
* Attach a tag to this record
|
|
20457
|
+
* 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.
|
|
20458
|
+
*
|
|
20459
|
+
* **Required permission:** `Ibl.CRM/Tags/write`.
|
|
20460
|
+
* @returns any No response body
|
|
20461
|
+
* @throws ApiError
|
|
20462
|
+
*/
|
|
20463
|
+
static crmDealsTagsCreate({
|
|
20464
|
+
id,
|
|
20465
|
+
requestBody
|
|
20466
|
+
}) {
|
|
20467
|
+
return request(OpenAPI, {
|
|
20468
|
+
method: 'POST',
|
|
20469
|
+
url: '/api/crm/deals/{id}/tags/',
|
|
20470
|
+
path: {
|
|
20471
|
+
'id': id
|
|
20472
|
+
},
|
|
20473
|
+
body: requestBody,
|
|
20474
|
+
mediaType: 'application/json',
|
|
20475
|
+
errors: {
|
|
20476
|
+
400: `No response body`,
|
|
20477
|
+
403: `No response body`,
|
|
20478
|
+
404: `No response body`,
|
|
20479
|
+
409: `No response body`
|
|
20480
|
+
}
|
|
20481
|
+
});
|
|
20482
|
+
}
|
|
20483
|
+
/**
|
|
20484
|
+
* Detach a tag from this record
|
|
20485
|
+
* Removes the Tag with id `tag_id` from this record. Returns `404` if the tag was not attached.
|
|
20486
|
+
*
|
|
20487
|
+
* **Required permission:** `Ibl.CRM/Tags/write`.
|
|
20488
|
+
* @returns void
|
|
20489
|
+
* @throws ApiError
|
|
20490
|
+
*/
|
|
20491
|
+
static crmDealsTagsDestroy({
|
|
20492
|
+
id,
|
|
20493
|
+
tagId
|
|
20494
|
+
}) {
|
|
20495
|
+
return request(OpenAPI, {
|
|
20496
|
+
method: 'DELETE',
|
|
20497
|
+
url: '/api/crm/deals/{id}/tags/{tag_id}/',
|
|
20498
|
+
path: {
|
|
20499
|
+
'id': id,
|
|
20500
|
+
'tag_id': tagId
|
|
20501
|
+
},
|
|
20502
|
+
errors: {
|
|
20503
|
+
403: `No response body`,
|
|
20504
|
+
404: `No response body`
|
|
20505
|
+
}
|
|
20506
|
+
});
|
|
20507
|
+
}
|
|
20453
20508
|
/**
|
|
20454
20509
|
* Mark a deal as won
|
|
20455
20510
|
* 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.
|
|
@@ -20510,7 +20565,7 @@ class CrmService {
|
|
|
20510
20565
|
* Create a lead source
|
|
20511
20566
|
* Creates a new LeadSource in your Platform. `code` must be unique.
|
|
20512
20567
|
*
|
|
20513
|
-
* **Required permission:** `Ibl.CRM/Pipelines/
|
|
20568
|
+
* **Required permission:** `Ibl.CRM/Pipelines/action`.
|
|
20514
20569
|
* @returns LeadSource
|
|
20515
20570
|
* @throws ApiError
|
|
20516
20571
|
*/
|
|
@@ -20524,7 +20579,7 @@ class CrmService {
|
|
|
20524
20579
|
mediaType: 'application/json',
|
|
20525
20580
|
errors: {
|
|
20526
20581
|
400: `Validation error.`,
|
|
20527
|
-
403: `Missing required permission \`Ibl.CRM/Pipelines/
|
|
20582
|
+
403: `Missing required permission \`Ibl.CRM/Pipelines/action\`.`
|
|
20528
20583
|
}
|
|
20529
20584
|
});
|
|
20530
20585
|
}
|
|
@@ -20640,7 +20695,8 @@ class CrmService {
|
|
|
20640
20695
|
name,
|
|
20641
20696
|
owner,
|
|
20642
20697
|
page,
|
|
20643
|
-
pageSize
|
|
20698
|
+
pageSize,
|
|
20699
|
+
tags
|
|
20644
20700
|
}) {
|
|
20645
20701
|
return request(OpenAPI, {
|
|
20646
20702
|
method: 'GET',
|
|
@@ -20649,7 +20705,8 @@ class CrmService {
|
|
|
20649
20705
|
'name': name,
|
|
20650
20706
|
'owner': owner,
|
|
20651
20707
|
'page': page,
|
|
20652
|
-
'page_size': pageSize
|
|
20708
|
+
'page_size': pageSize,
|
|
20709
|
+
'tags': tags
|
|
20653
20710
|
},
|
|
20654
20711
|
errors: {
|
|
20655
20712
|
401: `Authentication required.`,
|
|
@@ -20661,7 +20718,7 @@ class CrmService {
|
|
|
20661
20718
|
* Create an organization
|
|
20662
20719
|
* Creates a new organization in your Platform. The Platform is inferred from your credentials. `name` must be unique within your Platform.
|
|
20663
20720
|
*
|
|
20664
|
-
* **Required permission:** `Ibl.CRM/Organizations/
|
|
20721
|
+
* **Required permission:** `Ibl.CRM/Organizations/action`.
|
|
20665
20722
|
* @returns Organization
|
|
20666
20723
|
* @throws ApiError
|
|
20667
20724
|
*/
|
|
@@ -20675,7 +20732,7 @@ class CrmService {
|
|
|
20675
20732
|
mediaType: 'application/json',
|
|
20676
20733
|
errors: {
|
|
20677
20734
|
400: `Validation error (for example, duplicate name).`,
|
|
20678
|
-
403: `Missing required permission \`Ibl.CRM/Organizations/
|
|
20735
|
+
403: `Missing required permission \`Ibl.CRM/Organizations/action\`.`
|
|
20679
20736
|
}
|
|
20680
20737
|
});
|
|
20681
20738
|
}
|
|
@@ -20779,6 +20836,59 @@ class CrmService {
|
|
|
20779
20836
|
}
|
|
20780
20837
|
});
|
|
20781
20838
|
}
|
|
20839
|
+
/**
|
|
20840
|
+
* Attach a tag to this record
|
|
20841
|
+
* 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.
|
|
20842
|
+
*
|
|
20843
|
+
* **Required permission:** `Ibl.CRM/Tags/write`.
|
|
20844
|
+
* @returns any No response body
|
|
20845
|
+
* @throws ApiError
|
|
20846
|
+
*/
|
|
20847
|
+
static crmOrganizationsTagsCreate({
|
|
20848
|
+
id,
|
|
20849
|
+
requestBody
|
|
20850
|
+
}) {
|
|
20851
|
+
return request(OpenAPI, {
|
|
20852
|
+
method: 'POST',
|
|
20853
|
+
url: '/api/crm/organizations/{id}/tags/',
|
|
20854
|
+
path: {
|
|
20855
|
+
'id': id
|
|
20856
|
+
},
|
|
20857
|
+
body: requestBody,
|
|
20858
|
+
mediaType: 'application/json',
|
|
20859
|
+
errors: {
|
|
20860
|
+
400: `No response body`,
|
|
20861
|
+
403: `No response body`,
|
|
20862
|
+
404: `No response body`,
|
|
20863
|
+
409: `No response body`
|
|
20864
|
+
}
|
|
20865
|
+
});
|
|
20866
|
+
}
|
|
20867
|
+
/**
|
|
20868
|
+
* Detach a tag from this record
|
|
20869
|
+
* Removes the Tag with id `tag_id` from this record. Returns `404` if the tag was not attached.
|
|
20870
|
+
*
|
|
20871
|
+
* **Required permission:** `Ibl.CRM/Tags/write`.
|
|
20872
|
+
* @returns void
|
|
20873
|
+
* @throws ApiError
|
|
20874
|
+
*/
|
|
20875
|
+
static crmOrganizationsTagsDestroy({
|
|
20876
|
+
id,
|
|
20877
|
+
tagId
|
|
20878
|
+
}) {
|
|
20879
|
+
return request(OpenAPI, {
|
|
20880
|
+
method: 'DELETE',
|
|
20881
|
+
url: '/api/crm/organizations/{id}/tags/{tag_id}/',
|
|
20882
|
+
path: {
|
|
20883
|
+
'id': id,
|
|
20884
|
+
'tag_id': tagId
|
|
20885
|
+
},
|
|
20886
|
+
errors: {
|
|
20887
|
+
403: `No response body`,
|
|
20888
|
+
404: `No response body`
|
|
20889
|
+
}
|
|
20890
|
+
});
|
|
20891
|
+
}
|
|
20782
20892
|
/**
|
|
20783
20893
|
* List persons
|
|
20784
20894
|
* 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`.
|
|
@@ -20795,7 +20905,8 @@ class CrmService {
|
|
|
20795
20905
|
organization,
|
|
20796
20906
|
owner,
|
|
20797
20907
|
page,
|
|
20798
|
-
pageSize
|
|
20908
|
+
pageSize,
|
|
20909
|
+
tags
|
|
20799
20910
|
}) {
|
|
20800
20911
|
return request(OpenAPI, {
|
|
20801
20912
|
method: 'GET',
|
|
@@ -20808,7 +20919,8 @@ class CrmService {
|
|
|
20808
20919
|
'organization': organization,
|
|
20809
20920
|
'owner': owner,
|
|
20810
20921
|
'page': page,
|
|
20811
|
-
'page_size': pageSize
|
|
20922
|
+
'page_size': pageSize,
|
|
20923
|
+
'tags': tags
|
|
20812
20924
|
},
|
|
20813
20925
|
errors: {
|
|
20814
20926
|
401: `Authentication required.`,
|
|
@@ -20820,7 +20932,7 @@ class CrmService {
|
|
|
20820
20932
|
* Create a person
|
|
20821
20933
|
* 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.
|
|
20822
20934
|
*
|
|
20823
|
-
* **Required permission:** `Ibl.CRM/Persons/
|
|
20935
|
+
* **Required permission:** `Ibl.CRM/Persons/action`.
|
|
20824
20936
|
* @returns Person
|
|
20825
20937
|
* @throws ApiError
|
|
20826
20938
|
*/
|
|
@@ -20834,7 +20946,7 @@ class CrmService {
|
|
|
20834
20946
|
mediaType: 'application/json',
|
|
20835
20947
|
errors: {
|
|
20836
20948
|
400: `Validation error.`,
|
|
20837
|
-
403: `Missing required permission \`Ibl.CRM/Persons/
|
|
20949
|
+
403: `Missing required permission \`Ibl.CRM/Persons/action\`.`
|
|
20838
20950
|
}
|
|
20839
20951
|
});
|
|
20840
20952
|
}
|
|
@@ -20997,6 +21109,59 @@ class CrmService {
|
|
|
20997
21109
|
}
|
|
20998
21110
|
});
|
|
20999
21111
|
}
|
|
21112
|
+
/**
|
|
21113
|
+
* Attach a tag to this record
|
|
21114
|
+
* 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.
|
|
21115
|
+
*
|
|
21116
|
+
* **Required permission:** `Ibl.CRM/Tags/write`.
|
|
21117
|
+
* @returns any No response body
|
|
21118
|
+
* @throws ApiError
|
|
21119
|
+
*/
|
|
21120
|
+
static crmPersonsTagsCreate({
|
|
21121
|
+
id,
|
|
21122
|
+
requestBody
|
|
21123
|
+
}) {
|
|
21124
|
+
return request(OpenAPI, {
|
|
21125
|
+
method: 'POST',
|
|
21126
|
+
url: '/api/crm/persons/{id}/tags/',
|
|
21127
|
+
path: {
|
|
21128
|
+
'id': id
|
|
21129
|
+
},
|
|
21130
|
+
body: requestBody,
|
|
21131
|
+
mediaType: 'application/json',
|
|
21132
|
+
errors: {
|
|
21133
|
+
400: `No response body`,
|
|
21134
|
+
403: `No response body`,
|
|
21135
|
+
404: `No response body`,
|
|
21136
|
+
409: `No response body`
|
|
21137
|
+
}
|
|
21138
|
+
});
|
|
21139
|
+
}
|
|
21140
|
+
/**
|
|
21141
|
+
* Detach a tag from this record
|
|
21142
|
+
* Removes the Tag with id `tag_id` from this record. Returns `404` if the tag was not attached.
|
|
21143
|
+
*
|
|
21144
|
+
* **Required permission:** `Ibl.CRM/Tags/write`.
|
|
21145
|
+
* @returns void
|
|
21146
|
+
* @throws ApiError
|
|
21147
|
+
*/
|
|
21148
|
+
static crmPersonsTagsDestroy({
|
|
21149
|
+
id,
|
|
21150
|
+
tagId
|
|
21151
|
+
}) {
|
|
21152
|
+
return request(OpenAPI, {
|
|
21153
|
+
method: 'DELETE',
|
|
21154
|
+
url: '/api/crm/persons/{id}/tags/{tag_id}/',
|
|
21155
|
+
path: {
|
|
21156
|
+
'id': id,
|
|
21157
|
+
'tag_id': tagId
|
|
21158
|
+
},
|
|
21159
|
+
errors: {
|
|
21160
|
+
403: `No response body`,
|
|
21161
|
+
404: `No response body`
|
|
21162
|
+
}
|
|
21163
|
+
});
|
|
21164
|
+
}
|
|
21000
21165
|
/**
|
|
21001
21166
|
* Merge duplicate persons into a primary
|
|
21002
21167
|
* Marks each person in `duplicate_ids` as inactive and reports how many related records (deals, activities, tags) were re-parented onto `primary_id`.
|
|
@@ -21057,7 +21222,7 @@ class CrmService {
|
|
|
21057
21222
|
* Create a pipeline
|
|
21058
21223
|
* 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.
|
|
21059
21224
|
*
|
|
21060
|
-
* **Required permission:** `Ibl.CRM/Pipelines/
|
|
21225
|
+
* **Required permission:** `Ibl.CRM/Pipelines/action`.
|
|
21061
21226
|
* @returns Pipeline
|
|
21062
21227
|
* @throws ApiError
|
|
21063
21228
|
*/
|
|
@@ -21071,7 +21236,7 @@ class CrmService {
|
|
|
21071
21236
|
mediaType: 'application/json',
|
|
21072
21237
|
errors: {
|
|
21073
21238
|
400: `Validation error.`,
|
|
21074
|
-
403: `Missing required permission \`Ibl.CRM/Pipelines/
|
|
21239
|
+
403: `Missing required permission \`Ibl.CRM/Pipelines/action\`.`
|
|
21075
21240
|
}
|
|
21076
21241
|
});
|
|
21077
21242
|
}
|
|
@@ -21114,7 +21279,7 @@ class CrmService {
|
|
|
21114
21279
|
* Create a stage
|
|
21115
21280
|
* 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.
|
|
21116
21281
|
*
|
|
21117
|
-
* **Required permission:** `Ibl.CRM/Pipelines/
|
|
21282
|
+
* **Required permission:** `Ibl.CRM/Pipelines/action`.
|
|
21118
21283
|
* @returns PipelineStage
|
|
21119
21284
|
* @throws ApiError
|
|
21120
21285
|
*/
|
|
@@ -21132,7 +21297,7 @@ class CrmService {
|
|
|
21132
21297
|
mediaType: 'application/json',
|
|
21133
21298
|
errors: {
|
|
21134
21299
|
400: `Validation error.`,
|
|
21135
|
-
403: `Missing required permission \`Ibl.CRM/Pipelines/
|
|
21300
|
+
403: `Missing required permission \`Ibl.CRM/Pipelines/action\`.`,
|
|
21136
21301
|
404: `Pipeline not found.`
|
|
21137
21302
|
}
|
|
21138
21303
|
});
|
|
@@ -21347,6 +21512,159 @@ class CrmService {
|
|
|
21347
21512
|
}
|
|
21348
21513
|
});
|
|
21349
21514
|
}
|
|
21515
|
+
/**
|
|
21516
|
+
* List tags
|
|
21517
|
+
* 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.
|
|
21518
|
+
*
|
|
21519
|
+
* **Required permission:** `Ibl.CRM/Tags/list`.
|
|
21520
|
+
* @returns PaginatedTagList
|
|
21521
|
+
* @throws ApiError
|
|
21522
|
+
*/
|
|
21523
|
+
static crmTagsList({
|
|
21524
|
+
createdAtGte,
|
|
21525
|
+
createdAtLte,
|
|
21526
|
+
name,
|
|
21527
|
+
page,
|
|
21528
|
+
pageSize
|
|
21529
|
+
}) {
|
|
21530
|
+
return request(OpenAPI, {
|
|
21531
|
+
method: 'GET',
|
|
21532
|
+
url: '/api/crm/tags/',
|
|
21533
|
+
query: {
|
|
21534
|
+
'created_at__gte': createdAtGte,
|
|
21535
|
+
'created_at__lte': createdAtLte,
|
|
21536
|
+
'name': name,
|
|
21537
|
+
'page': page,
|
|
21538
|
+
'page_size': pageSize
|
|
21539
|
+
},
|
|
21540
|
+
errors: {
|
|
21541
|
+
401: `Authentication required.`,
|
|
21542
|
+
403: `Missing required permission \`Ibl.CRM/Tags/list\`.`
|
|
21543
|
+
}
|
|
21544
|
+
});
|
|
21545
|
+
}
|
|
21546
|
+
/**
|
|
21547
|
+
* Create a tag
|
|
21548
|
+
* Creates a new Tag in your Platform. `name` must be unique within your Platform; supply `color` as a `#RRGGBB` hex string (defaults to `#888888`).
|
|
21549
|
+
*
|
|
21550
|
+
* **Required permission:** `Ibl.CRM/Tags/action`.
|
|
21551
|
+
* @returns Tag
|
|
21552
|
+
* @throws ApiError
|
|
21553
|
+
*/
|
|
21554
|
+
static crmTagsCreate({
|
|
21555
|
+
requestBody
|
|
21556
|
+
}) {
|
|
21557
|
+
return request(OpenAPI, {
|
|
21558
|
+
method: 'POST',
|
|
21559
|
+
url: '/api/crm/tags/',
|
|
21560
|
+
body: requestBody,
|
|
21561
|
+
mediaType: 'application/json',
|
|
21562
|
+
errors: {
|
|
21563
|
+
400: `Validation error (duplicate name, bad color, etc.).`,
|
|
21564
|
+
403: `Missing required permission \`Ibl.CRM/Tags/action\`.`
|
|
21565
|
+
}
|
|
21566
|
+
});
|
|
21567
|
+
}
|
|
21568
|
+
/**
|
|
21569
|
+
* Retrieve a tag
|
|
21570
|
+
* Returns a single Tag by id.
|
|
21571
|
+
*
|
|
21572
|
+
* **Required permission:** `Ibl.CRM/Tags/read`.
|
|
21573
|
+
* @returns Tag
|
|
21574
|
+
* @throws ApiError
|
|
21575
|
+
*/
|
|
21576
|
+
static crmTagsRetrieve({
|
|
21577
|
+
id
|
|
21578
|
+
}) {
|
|
21579
|
+
return request(OpenAPI, {
|
|
21580
|
+
method: 'GET',
|
|
21581
|
+
url: '/api/crm/tags/{id}/',
|
|
21582
|
+
path: {
|
|
21583
|
+
'id': id
|
|
21584
|
+
},
|
|
21585
|
+
errors: {
|
|
21586
|
+
403: `Missing required permission \`Ibl.CRM/Tags/read\`.`,
|
|
21587
|
+
404: `Tag not found.`
|
|
21588
|
+
}
|
|
21589
|
+
});
|
|
21590
|
+
}
|
|
21591
|
+
/**
|
|
21592
|
+
* Replace a tag
|
|
21593
|
+
* Replaces all editable fields on the Tag.
|
|
21594
|
+
*
|
|
21595
|
+
* **Required permission:** `Ibl.CRM/Tags/write`.
|
|
21596
|
+
* @returns Tag
|
|
21597
|
+
* @throws ApiError
|
|
21598
|
+
*/
|
|
21599
|
+
static crmTagsUpdate({
|
|
21600
|
+
id,
|
|
21601
|
+
requestBody
|
|
21602
|
+
}) {
|
|
21603
|
+
return request(OpenAPI, {
|
|
21604
|
+
method: 'PUT',
|
|
21605
|
+
url: '/api/crm/tags/{id}/',
|
|
21606
|
+
path: {
|
|
21607
|
+
'id': id
|
|
21608
|
+
},
|
|
21609
|
+
body: requestBody,
|
|
21610
|
+
mediaType: 'application/json',
|
|
21611
|
+
errors: {
|
|
21612
|
+
400: `Validation error.`,
|
|
21613
|
+
403: `Missing required permission \`Ibl.CRM/Tags/write\`.`,
|
|
21614
|
+
404: `Tag not found.`
|
|
21615
|
+
}
|
|
21616
|
+
});
|
|
21617
|
+
}
|
|
21618
|
+
/**
|
|
21619
|
+
* Update a tag
|
|
21620
|
+
* Updates only the supplied fields on the Tag (typically `name` or `color`).
|
|
21621
|
+
*
|
|
21622
|
+
* **Required permission:** `Ibl.CRM/Tags/write`.
|
|
21623
|
+
* @returns Tag
|
|
21624
|
+
* @throws ApiError
|
|
21625
|
+
*/
|
|
21626
|
+
static crmTagsPartialUpdate({
|
|
21627
|
+
id,
|
|
21628
|
+
requestBody
|
|
21629
|
+
}) {
|
|
21630
|
+
return request(OpenAPI, {
|
|
21631
|
+
method: 'PATCH',
|
|
21632
|
+
url: '/api/crm/tags/{id}/',
|
|
21633
|
+
path: {
|
|
21634
|
+
'id': id
|
|
21635
|
+
},
|
|
21636
|
+
body: requestBody,
|
|
21637
|
+
mediaType: 'application/json',
|
|
21638
|
+
errors: {
|
|
21639
|
+
400: `Validation error.`,
|
|
21640
|
+
403: `Missing required permission \`Ibl.CRM/Tags/write\`.`,
|
|
21641
|
+
404: `Tag not found.`
|
|
21642
|
+
}
|
|
21643
|
+
});
|
|
21644
|
+
}
|
|
21645
|
+
/**
|
|
21646
|
+
* Delete a tag
|
|
21647
|
+
* Deletes the Tag. All attachments to Persons, Organizations, and Deals are removed atomically via cascade.
|
|
21648
|
+
*
|
|
21649
|
+
* **Required permission:** `Ibl.CRM/Tags/delete`.
|
|
21650
|
+
* @returns void
|
|
21651
|
+
* @throws ApiError
|
|
21652
|
+
*/
|
|
21653
|
+
static crmTagsDestroy({
|
|
21654
|
+
id
|
|
21655
|
+
}) {
|
|
21656
|
+
return request(OpenAPI, {
|
|
21657
|
+
method: 'DELETE',
|
|
21658
|
+
url: '/api/crm/tags/{id}/',
|
|
21659
|
+
path: {
|
|
21660
|
+
'id': id
|
|
21661
|
+
},
|
|
21662
|
+
errors: {
|
|
21663
|
+
403: `Missing required permission \`Ibl.CRM/Tags/delete\`.`,
|
|
21664
|
+
404: `Tag not found.`
|
|
21665
|
+
}
|
|
21666
|
+
});
|
|
21667
|
+
}
|
|
21350
21668
|
}
|
|
21351
21669
|
|
|
21352
21670
|
class CustomDomainsService {
|
|
@@ -21461,7 +21779,8 @@ class DealsService {
|
|
|
21461
21779
|
pipeline,
|
|
21462
21780
|
source,
|
|
21463
21781
|
stage,
|
|
21464
|
-
status
|
|
21782
|
+
status,
|
|
21783
|
+
tags
|
|
21465
21784
|
}) {
|
|
21466
21785
|
return request(OpenAPI, {
|
|
21467
21786
|
method: 'GET',
|
|
@@ -21480,7 +21799,8 @@ class DealsService {
|
|
|
21480
21799
|
'pipeline': pipeline,
|
|
21481
21800
|
'source': source,
|
|
21482
21801
|
'stage': stage,
|
|
21483
|
-
'status': status
|
|
21802
|
+
'status': status,
|
|
21803
|
+
'tags': tags
|
|
21484
21804
|
},
|
|
21485
21805
|
errors: {
|
|
21486
21806
|
401: `Authentication required.`,
|
|
@@ -21492,7 +21812,7 @@ class DealsService {
|
|
|
21492
21812
|
* Create a deal
|
|
21493
21813
|
* 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`.
|
|
21494
21814
|
*
|
|
21495
|
-
* **Required permission:** `Ibl.CRM/Deals/
|
|
21815
|
+
* **Required permission:** `Ibl.CRM/Deals/action`.
|
|
21496
21816
|
* @returns Deal
|
|
21497
21817
|
* @throws ApiError
|
|
21498
21818
|
*/
|
|
@@ -21506,7 +21826,7 @@ class DealsService {
|
|
|
21506
21826
|
mediaType: 'application/json',
|
|
21507
21827
|
errors: {
|
|
21508
21828
|
400: `Validation error.`,
|
|
21509
|
-
403: `Missing required permission \`Ibl.CRM/Deals/
|
|
21829
|
+
403: `Missing required permission \`Ibl.CRM/Deals/action\`.`
|
|
21510
21830
|
}
|
|
21511
21831
|
});
|
|
21512
21832
|
}
|
|
@@ -21664,6 +21984,59 @@ class DealsService {
|
|
|
21664
21984
|
}
|
|
21665
21985
|
});
|
|
21666
21986
|
}
|
|
21987
|
+
/**
|
|
21988
|
+
* Attach a tag to this record
|
|
21989
|
+
* 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.
|
|
21990
|
+
*
|
|
21991
|
+
* **Required permission:** `Ibl.CRM/Tags/write`.
|
|
21992
|
+
* @returns any No response body
|
|
21993
|
+
* @throws ApiError
|
|
21994
|
+
*/
|
|
21995
|
+
static dealsTagsCreate({
|
|
21996
|
+
id,
|
|
21997
|
+
requestBody
|
|
21998
|
+
}) {
|
|
21999
|
+
return request(OpenAPI, {
|
|
22000
|
+
method: 'POST',
|
|
22001
|
+
url: '/deals/{id}/tags/',
|
|
22002
|
+
path: {
|
|
22003
|
+
'id': id
|
|
22004
|
+
},
|
|
22005
|
+
body: requestBody,
|
|
22006
|
+
mediaType: 'application/json',
|
|
22007
|
+
errors: {
|
|
22008
|
+
400: `No response body`,
|
|
22009
|
+
403: `No response body`,
|
|
22010
|
+
404: `No response body`,
|
|
22011
|
+
409: `No response body`
|
|
22012
|
+
}
|
|
22013
|
+
});
|
|
22014
|
+
}
|
|
22015
|
+
/**
|
|
22016
|
+
* Detach a tag from this record
|
|
22017
|
+
* Removes the Tag with id `tag_id` from this record. Returns `404` if the tag was not attached.
|
|
22018
|
+
*
|
|
22019
|
+
* **Required permission:** `Ibl.CRM/Tags/write`.
|
|
22020
|
+
* @returns void
|
|
22021
|
+
* @throws ApiError
|
|
22022
|
+
*/
|
|
22023
|
+
static dealsTagsDestroy({
|
|
22024
|
+
id,
|
|
22025
|
+
tagId
|
|
22026
|
+
}) {
|
|
22027
|
+
return request(OpenAPI, {
|
|
22028
|
+
method: 'DELETE',
|
|
22029
|
+
url: '/deals/{id}/tags/{tag_id}/',
|
|
22030
|
+
path: {
|
|
22031
|
+
'id': id,
|
|
22032
|
+
'tag_id': tagId
|
|
22033
|
+
},
|
|
22034
|
+
errors: {
|
|
22035
|
+
403: `No response body`,
|
|
22036
|
+
404: `No response body`
|
|
22037
|
+
}
|
|
22038
|
+
});
|
|
22039
|
+
}
|
|
21667
22040
|
/**
|
|
21668
22041
|
* Mark a deal as won
|
|
21669
22042
|
* 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.
|
|
@@ -21860,7 +22233,7 @@ class LeadSourcesService {
|
|
|
21860
22233
|
* Create a lead source
|
|
21861
22234
|
* Creates a new LeadSource in your Platform. `code` must be unique.
|
|
21862
22235
|
*
|
|
21863
|
-
* **Required permission:** `Ibl.CRM/Pipelines/
|
|
22236
|
+
* **Required permission:** `Ibl.CRM/Pipelines/action`.
|
|
21864
22237
|
* @returns LeadSource
|
|
21865
22238
|
* @throws ApiError
|
|
21866
22239
|
*/
|
|
@@ -21874,7 +22247,7 @@ class LeadSourcesService {
|
|
|
21874
22247
|
mediaType: 'application/json',
|
|
21875
22248
|
errors: {
|
|
21876
22249
|
400: `Validation error.`,
|
|
21877
|
-
403: `Missing required permission \`Ibl.CRM/Pipelines/
|
|
22250
|
+
403: `Missing required permission \`Ibl.CRM/Pipelines/action\`.`
|
|
21878
22251
|
}
|
|
21879
22252
|
});
|
|
21880
22253
|
}
|
|
@@ -22877,7 +23250,8 @@ class OrganizationsService {
|
|
|
22877
23250
|
name,
|
|
22878
23251
|
owner,
|
|
22879
23252
|
page,
|
|
22880
|
-
pageSize
|
|
23253
|
+
pageSize,
|
|
23254
|
+
tags
|
|
22881
23255
|
}) {
|
|
22882
23256
|
return request(OpenAPI, {
|
|
22883
23257
|
method: 'GET',
|
|
@@ -22886,7 +23260,8 @@ class OrganizationsService {
|
|
|
22886
23260
|
'name': name,
|
|
22887
23261
|
'owner': owner,
|
|
22888
23262
|
'page': page,
|
|
22889
|
-
'page_size': pageSize
|
|
23263
|
+
'page_size': pageSize,
|
|
23264
|
+
'tags': tags
|
|
22890
23265
|
},
|
|
22891
23266
|
errors: {
|
|
22892
23267
|
401: `Authentication required.`,
|
|
@@ -22898,7 +23273,7 @@ class OrganizationsService {
|
|
|
22898
23273
|
* Create an organization
|
|
22899
23274
|
* Creates a new organization in your Platform. The Platform is inferred from your credentials. `name` must be unique within your Platform.
|
|
22900
23275
|
*
|
|
22901
|
-
* **Required permission:** `Ibl.CRM/Organizations/
|
|
23276
|
+
* **Required permission:** `Ibl.CRM/Organizations/action`.
|
|
22902
23277
|
* @returns Organization
|
|
22903
23278
|
* @throws ApiError
|
|
22904
23279
|
*/
|
|
@@ -22912,7 +23287,7 @@ class OrganizationsService {
|
|
|
22912
23287
|
mediaType: 'application/json',
|
|
22913
23288
|
errors: {
|
|
22914
23289
|
400: `Validation error (for example, duplicate name).`,
|
|
22915
|
-
403: `Missing required permission \`Ibl.CRM/Organizations/
|
|
23290
|
+
403: `Missing required permission \`Ibl.CRM/Organizations/action\`.`
|
|
22916
23291
|
}
|
|
22917
23292
|
});
|
|
22918
23293
|
}
|
|
@@ -23016,6 +23391,59 @@ class OrganizationsService {
|
|
|
23016
23391
|
}
|
|
23017
23392
|
});
|
|
23018
23393
|
}
|
|
23394
|
+
/**
|
|
23395
|
+
* Attach a tag to this record
|
|
23396
|
+
* 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.
|
|
23397
|
+
*
|
|
23398
|
+
* **Required permission:** `Ibl.CRM/Tags/write`.
|
|
23399
|
+
* @returns any No response body
|
|
23400
|
+
* @throws ApiError
|
|
23401
|
+
*/
|
|
23402
|
+
static organizationsTagsCreate({
|
|
23403
|
+
id,
|
|
23404
|
+
requestBody
|
|
23405
|
+
}) {
|
|
23406
|
+
return request(OpenAPI, {
|
|
23407
|
+
method: 'POST',
|
|
23408
|
+
url: '/organizations/{id}/tags/',
|
|
23409
|
+
path: {
|
|
23410
|
+
'id': id
|
|
23411
|
+
},
|
|
23412
|
+
body: requestBody,
|
|
23413
|
+
mediaType: 'application/json',
|
|
23414
|
+
errors: {
|
|
23415
|
+
400: `No response body`,
|
|
23416
|
+
403: `No response body`,
|
|
23417
|
+
404: `No response body`,
|
|
23418
|
+
409: `No response body`
|
|
23419
|
+
}
|
|
23420
|
+
});
|
|
23421
|
+
}
|
|
23422
|
+
/**
|
|
23423
|
+
* Detach a tag from this record
|
|
23424
|
+
* Removes the Tag with id `tag_id` from this record. Returns `404` if the tag was not attached.
|
|
23425
|
+
*
|
|
23426
|
+
* **Required permission:** `Ibl.CRM/Tags/write`.
|
|
23427
|
+
* @returns void
|
|
23428
|
+
* @throws ApiError
|
|
23429
|
+
*/
|
|
23430
|
+
static organizationsTagsDestroy({
|
|
23431
|
+
id,
|
|
23432
|
+
tagId
|
|
23433
|
+
}) {
|
|
23434
|
+
return request(OpenAPI, {
|
|
23435
|
+
method: 'DELETE',
|
|
23436
|
+
url: '/organizations/{id}/tags/{tag_id}/',
|
|
23437
|
+
path: {
|
|
23438
|
+
'id': id,
|
|
23439
|
+
'tag_id': tagId
|
|
23440
|
+
},
|
|
23441
|
+
errors: {
|
|
23442
|
+
403: `No response body`,
|
|
23443
|
+
404: `No response body`
|
|
23444
|
+
}
|
|
23445
|
+
});
|
|
23446
|
+
}
|
|
23019
23447
|
}
|
|
23020
23448
|
|
|
23021
23449
|
class PersonsService {
|
|
@@ -23035,7 +23463,8 @@ class PersonsService {
|
|
|
23035
23463
|
organization,
|
|
23036
23464
|
owner,
|
|
23037
23465
|
page,
|
|
23038
|
-
pageSize
|
|
23466
|
+
pageSize,
|
|
23467
|
+
tags
|
|
23039
23468
|
}) {
|
|
23040
23469
|
return request(OpenAPI, {
|
|
23041
23470
|
method: 'GET',
|
|
@@ -23048,7 +23477,8 @@ class PersonsService {
|
|
|
23048
23477
|
'organization': organization,
|
|
23049
23478
|
'owner': owner,
|
|
23050
23479
|
'page': page,
|
|
23051
|
-
'page_size': pageSize
|
|
23480
|
+
'page_size': pageSize,
|
|
23481
|
+
'tags': tags
|
|
23052
23482
|
},
|
|
23053
23483
|
errors: {
|
|
23054
23484
|
401: `Authentication required.`,
|
|
@@ -23060,7 +23490,7 @@ class PersonsService {
|
|
|
23060
23490
|
* Create a person
|
|
23061
23491
|
* 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.
|
|
23062
23492
|
*
|
|
23063
|
-
* **Required permission:** `Ibl.CRM/Persons/
|
|
23493
|
+
* **Required permission:** `Ibl.CRM/Persons/action`.
|
|
23064
23494
|
* @returns Person
|
|
23065
23495
|
* @throws ApiError
|
|
23066
23496
|
*/
|
|
@@ -23074,7 +23504,7 @@ class PersonsService {
|
|
|
23074
23504
|
mediaType: 'application/json',
|
|
23075
23505
|
errors: {
|
|
23076
23506
|
400: `Validation error.`,
|
|
23077
|
-
403: `Missing required permission \`Ibl.CRM/Persons/
|
|
23507
|
+
403: `Missing required permission \`Ibl.CRM/Persons/action\`.`
|
|
23078
23508
|
}
|
|
23079
23509
|
});
|
|
23080
23510
|
}
|
|
@@ -23237,6 +23667,59 @@ class PersonsService {
|
|
|
23237
23667
|
}
|
|
23238
23668
|
});
|
|
23239
23669
|
}
|
|
23670
|
+
/**
|
|
23671
|
+
* Attach a tag to this record
|
|
23672
|
+
* 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.
|
|
23673
|
+
*
|
|
23674
|
+
* **Required permission:** `Ibl.CRM/Tags/write`.
|
|
23675
|
+
* @returns any No response body
|
|
23676
|
+
* @throws ApiError
|
|
23677
|
+
*/
|
|
23678
|
+
static personsTagsCreate({
|
|
23679
|
+
id,
|
|
23680
|
+
requestBody
|
|
23681
|
+
}) {
|
|
23682
|
+
return request(OpenAPI, {
|
|
23683
|
+
method: 'POST',
|
|
23684
|
+
url: '/persons/{id}/tags/',
|
|
23685
|
+
path: {
|
|
23686
|
+
'id': id
|
|
23687
|
+
},
|
|
23688
|
+
body: requestBody,
|
|
23689
|
+
mediaType: 'application/json',
|
|
23690
|
+
errors: {
|
|
23691
|
+
400: `No response body`,
|
|
23692
|
+
403: `No response body`,
|
|
23693
|
+
404: `No response body`,
|
|
23694
|
+
409: `No response body`
|
|
23695
|
+
}
|
|
23696
|
+
});
|
|
23697
|
+
}
|
|
23698
|
+
/**
|
|
23699
|
+
* Detach a tag from this record
|
|
23700
|
+
* Removes the Tag with id `tag_id` from this record. Returns `404` if the tag was not attached.
|
|
23701
|
+
*
|
|
23702
|
+
* **Required permission:** `Ibl.CRM/Tags/write`.
|
|
23703
|
+
* @returns void
|
|
23704
|
+
* @throws ApiError
|
|
23705
|
+
*/
|
|
23706
|
+
static personsTagsDestroy({
|
|
23707
|
+
id,
|
|
23708
|
+
tagId
|
|
23709
|
+
}) {
|
|
23710
|
+
return request(OpenAPI, {
|
|
23711
|
+
method: 'DELETE',
|
|
23712
|
+
url: '/persons/{id}/tags/{tag_id}/',
|
|
23713
|
+
path: {
|
|
23714
|
+
'id': id,
|
|
23715
|
+
'tag_id': tagId
|
|
23716
|
+
},
|
|
23717
|
+
errors: {
|
|
23718
|
+
403: `No response body`,
|
|
23719
|
+
404: `No response body`
|
|
23720
|
+
}
|
|
23721
|
+
});
|
|
23722
|
+
}
|
|
23240
23723
|
/**
|
|
23241
23724
|
* Merge duplicate persons into a primary
|
|
23242
23725
|
* Marks each person in `duplicate_ids` as inactive and reports how many related records (deals, activities, tags) were re-parented onto `primary_id`.
|
|
@@ -23300,7 +23783,7 @@ class PipelinesService {
|
|
|
23300
23783
|
* Create a pipeline
|
|
23301
23784
|
* 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.
|
|
23302
23785
|
*
|
|
23303
|
-
* **Required permission:** `Ibl.CRM/Pipelines/
|
|
23786
|
+
* **Required permission:** `Ibl.CRM/Pipelines/action`.
|
|
23304
23787
|
* @returns Pipeline
|
|
23305
23788
|
* @throws ApiError
|
|
23306
23789
|
*/
|
|
@@ -23314,7 +23797,7 @@ class PipelinesService {
|
|
|
23314
23797
|
mediaType: 'application/json',
|
|
23315
23798
|
errors: {
|
|
23316
23799
|
400: `Validation error.`,
|
|
23317
|
-
403: `Missing required permission \`Ibl.CRM/Pipelines/
|
|
23800
|
+
403: `Missing required permission \`Ibl.CRM/Pipelines/action\`.`
|
|
23318
23801
|
}
|
|
23319
23802
|
});
|
|
23320
23803
|
}
|
|
@@ -23357,7 +23840,7 @@ class PipelinesService {
|
|
|
23357
23840
|
* Create a stage
|
|
23358
23841
|
* 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.
|
|
23359
23842
|
*
|
|
23360
|
-
* **Required permission:** `Ibl.CRM/Pipelines/
|
|
23843
|
+
* **Required permission:** `Ibl.CRM/Pipelines/action`.
|
|
23361
23844
|
* @returns PipelineStage
|
|
23362
23845
|
* @throws ApiError
|
|
23363
23846
|
*/
|
|
@@ -23375,7 +23858,7 @@ class PipelinesService {
|
|
|
23375
23858
|
mediaType: 'application/json',
|
|
23376
23859
|
errors: {
|
|
23377
23860
|
400: `Validation error.`,
|
|
23378
|
-
403: `Missing required permission \`Ibl.CRM/Pipelines/
|
|
23861
|
+
403: `Missing required permission \`Ibl.CRM/Pipelines/action\`.`,
|
|
23379
23862
|
404: `Pipeline not found.`
|
|
23380
23863
|
}
|
|
23381
23864
|
});
|
|
@@ -25792,6 +26275,162 @@ class SkillsService {
|
|
|
25792
26275
|
}
|
|
25793
26276
|
}
|
|
25794
26277
|
|
|
26278
|
+
class TagsService {
|
|
26279
|
+
/**
|
|
26280
|
+
* List tags
|
|
26281
|
+
* 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.
|
|
26282
|
+
*
|
|
26283
|
+
* **Required permission:** `Ibl.CRM/Tags/list`.
|
|
26284
|
+
* @returns PaginatedTagList
|
|
26285
|
+
* @throws ApiError
|
|
26286
|
+
*/
|
|
26287
|
+
static tagsList({
|
|
26288
|
+
createdAtGte,
|
|
26289
|
+
createdAtLte,
|
|
26290
|
+
name,
|
|
26291
|
+
page,
|
|
26292
|
+
pageSize
|
|
26293
|
+
}) {
|
|
26294
|
+
return request(OpenAPI, {
|
|
26295
|
+
method: 'GET',
|
|
26296
|
+
url: '/tags/',
|
|
26297
|
+
query: {
|
|
26298
|
+
'created_at__gte': createdAtGte,
|
|
26299
|
+
'created_at__lte': createdAtLte,
|
|
26300
|
+
'name': name,
|
|
26301
|
+
'page': page,
|
|
26302
|
+
'page_size': pageSize
|
|
26303
|
+
},
|
|
26304
|
+
errors: {
|
|
26305
|
+
401: `Authentication required.`,
|
|
26306
|
+
403: `Missing required permission \`Ibl.CRM/Tags/list\`.`
|
|
26307
|
+
}
|
|
26308
|
+
});
|
|
26309
|
+
}
|
|
26310
|
+
/**
|
|
26311
|
+
* Create a tag
|
|
26312
|
+
* Creates a new Tag in your Platform. `name` must be unique within your Platform; supply `color` as a `#RRGGBB` hex string (defaults to `#888888`).
|
|
26313
|
+
*
|
|
26314
|
+
* **Required permission:** `Ibl.CRM/Tags/action`.
|
|
26315
|
+
* @returns Tag
|
|
26316
|
+
* @throws ApiError
|
|
26317
|
+
*/
|
|
26318
|
+
static tagsCreate({
|
|
26319
|
+
requestBody
|
|
26320
|
+
}) {
|
|
26321
|
+
return request(OpenAPI, {
|
|
26322
|
+
method: 'POST',
|
|
26323
|
+
url: '/tags/',
|
|
26324
|
+
body: requestBody,
|
|
26325
|
+
mediaType: 'application/json',
|
|
26326
|
+
errors: {
|
|
26327
|
+
400: `Validation error (duplicate name, bad color, etc.).`,
|
|
26328
|
+
403: `Missing required permission \`Ibl.CRM/Tags/action\`.`
|
|
26329
|
+
}
|
|
26330
|
+
});
|
|
26331
|
+
}
|
|
26332
|
+
/**
|
|
26333
|
+
* Retrieve a tag
|
|
26334
|
+
* Returns a single Tag by id.
|
|
26335
|
+
*
|
|
26336
|
+
* **Required permission:** `Ibl.CRM/Tags/read`.
|
|
26337
|
+
* @returns Tag
|
|
26338
|
+
* @throws ApiError
|
|
26339
|
+
*/
|
|
26340
|
+
static tagsRetrieve({
|
|
26341
|
+
id
|
|
26342
|
+
}) {
|
|
26343
|
+
return request(OpenAPI, {
|
|
26344
|
+
method: 'GET',
|
|
26345
|
+
url: '/tags/{id}/',
|
|
26346
|
+
path: {
|
|
26347
|
+
'id': id
|
|
26348
|
+
},
|
|
26349
|
+
errors: {
|
|
26350
|
+
403: `Missing required permission \`Ibl.CRM/Tags/read\`.`,
|
|
26351
|
+
404: `Tag not found.`
|
|
26352
|
+
}
|
|
26353
|
+
});
|
|
26354
|
+
}
|
|
26355
|
+
/**
|
|
26356
|
+
* Replace a tag
|
|
26357
|
+
* Replaces all editable fields on the Tag.
|
|
26358
|
+
*
|
|
26359
|
+
* **Required permission:** `Ibl.CRM/Tags/write`.
|
|
26360
|
+
* @returns Tag
|
|
26361
|
+
* @throws ApiError
|
|
26362
|
+
*/
|
|
26363
|
+
static tagsUpdate({
|
|
26364
|
+
id,
|
|
26365
|
+
requestBody
|
|
26366
|
+
}) {
|
|
26367
|
+
return request(OpenAPI, {
|
|
26368
|
+
method: 'PUT',
|
|
26369
|
+
url: '/tags/{id}/',
|
|
26370
|
+
path: {
|
|
26371
|
+
'id': id
|
|
26372
|
+
},
|
|
26373
|
+
body: requestBody,
|
|
26374
|
+
mediaType: 'application/json',
|
|
26375
|
+
errors: {
|
|
26376
|
+
400: `Validation error.`,
|
|
26377
|
+
403: `Missing required permission \`Ibl.CRM/Tags/write\`.`,
|
|
26378
|
+
404: `Tag not found.`
|
|
26379
|
+
}
|
|
26380
|
+
});
|
|
26381
|
+
}
|
|
26382
|
+
/**
|
|
26383
|
+
* Update a tag
|
|
26384
|
+
* Updates only the supplied fields on the Tag (typically `name` or `color`).
|
|
26385
|
+
*
|
|
26386
|
+
* **Required permission:** `Ibl.CRM/Tags/write`.
|
|
26387
|
+
* @returns Tag
|
|
26388
|
+
* @throws ApiError
|
|
26389
|
+
*/
|
|
26390
|
+
static tagsPartialUpdate({
|
|
26391
|
+
id,
|
|
26392
|
+
requestBody
|
|
26393
|
+
}) {
|
|
26394
|
+
return request(OpenAPI, {
|
|
26395
|
+
method: 'PATCH',
|
|
26396
|
+
url: '/tags/{id}/',
|
|
26397
|
+
path: {
|
|
26398
|
+
'id': id
|
|
26399
|
+
},
|
|
26400
|
+
body: requestBody,
|
|
26401
|
+
mediaType: 'application/json',
|
|
26402
|
+
errors: {
|
|
26403
|
+
400: `Validation error.`,
|
|
26404
|
+
403: `Missing required permission \`Ibl.CRM/Tags/write\`.`,
|
|
26405
|
+
404: `Tag not found.`
|
|
26406
|
+
}
|
|
26407
|
+
});
|
|
26408
|
+
}
|
|
26409
|
+
/**
|
|
26410
|
+
* Delete a tag
|
|
26411
|
+
* Deletes the Tag. All attachments to Persons, Organizations, and Deals are removed atomically via cascade.
|
|
26412
|
+
*
|
|
26413
|
+
* **Required permission:** `Ibl.CRM/Tags/delete`.
|
|
26414
|
+
* @returns void
|
|
26415
|
+
* @throws ApiError
|
|
26416
|
+
*/
|
|
26417
|
+
static tagsDestroy({
|
|
26418
|
+
id
|
|
26419
|
+
}) {
|
|
26420
|
+
return request(OpenAPI, {
|
|
26421
|
+
method: 'DELETE',
|
|
26422
|
+
url: '/tags/{id}/',
|
|
26423
|
+
path: {
|
|
26424
|
+
'id': id
|
|
26425
|
+
},
|
|
26426
|
+
errors: {
|
|
26427
|
+
403: `Missing required permission \`Ibl.CRM/Tags/delete\`.`,
|
|
26428
|
+
404: `Tag not found.`
|
|
26429
|
+
}
|
|
26430
|
+
});
|
|
26431
|
+
}
|
|
26432
|
+
}
|
|
26433
|
+
|
|
25795
26434
|
class TransactionsService {
|
|
25796
26435
|
/**
|
|
25797
26436
|
* List transaction history
|
|
@@ -25818,5 +26457,5 @@ class TransactionsService {
|
|
|
25818
26457
|
}
|
|
25819
26458
|
}
|
|
25820
26459
|
|
|
25821
|
-
export { AcceptanceEnum, AccessCheckService, AccountService, ActivitiesService, ActivityTypeEnum, AiAnalyticsService, AnalyticsService, ApiError, AutoRechargeService, AutoRechargeTriggerResponseStatusEnum, BillingService, BlankEnum, BusinessTypeEnum, CancelError, CancelablePromise, CareerService, CatalogService, CeleryHeartbeatFailStatusEnum, CeleryHeartbeatStatusEnum, CommerceService, CoreService, CoursesProgressFrequencyEnum, CredentialsService, CreditTransactionHistoryStatusEnum, CreditsService, CrmService, CustomDomainsService, DealStatusEnum, DealsService, DisabilityStatusEnum, EthnicityEnum, EventsEnum, FeaturesService, FieldTypeEnum, FlowTypeEnum, GenderEnum, GooglePayAccountResponseStatusEnum, GradePostedNotifyModeEnum, GrandfatheringStrategyEnum, HumanSupportRecipientModeEnum, InstitutionTypeEnum, IntervalEnum, ItemTypeEnum, ItemsService, LeadSourcesService, LifecycleStageEnum, MediaService, MediaTypeEnum, ModeEnum, NotificationFrequencyEnum, NotificationSourceTypeEnum, NotificationsService, OpenAPI, OrganizationsService, PeriodEnum, PeriodicFrequencyEnum, PeriodicLearnerScopeEnum, PersonsService, PipelinesService, PlatformListStatusEnum, PlatformsService, PricesService, ProgramTypeEnum, RecipientsRecipientModeEnum, RecommendationsService, ReportsService, ScimService, SearchService, SkillsService, StateEnum, Status0e3Enum, Status3daEnum, TransactionTypeEnum, TransactionsService, Type4b7Enum };
|
|
26460
|
+
export { AcceptanceEnum, AccessCheckService, AccountService, ActivitiesService, ActivityTypeEnum, AiAnalyticsService, AnalyticsService, ApiError, AutoRechargeService, AutoRechargeTriggerResponseStatusEnum, BillingService, BlankEnum, BusinessTypeEnum, CancelError, CancelablePromise, CareerService, CatalogService, CeleryHeartbeatFailStatusEnum, CeleryHeartbeatStatusEnum, CommerceService, CoreService, CoursesProgressFrequencyEnum, CredentialsService, CreditTransactionHistoryStatusEnum, CreditsService, CrmService, CustomDomainsService, DealStatusEnum, DealsService, DisabilityStatusEnum, EthnicityEnum, EventsEnum, FeaturesService, FieldTypeEnum, FlowTypeEnum, GenderEnum, GooglePayAccountResponseStatusEnum, GradePostedNotifyModeEnum, GrandfatheringStrategyEnum, HumanSupportRecipientModeEnum, InstitutionTypeEnum, IntervalEnum, ItemTypeEnum, ItemsService, LeadSourcesService, LifecycleStageEnum, MediaService, MediaTypeEnum, ModeEnum, NotificationFrequencyEnum, NotificationSourceTypeEnum, NotificationsService, OpenAPI, OrganizationsService, PeriodEnum, PeriodicFrequencyEnum, PeriodicLearnerScopeEnum, PersonsService, PipelinesService, PlatformListStatusEnum, PlatformsService, PricesService, ProgramTypeEnum, RecipientsRecipientModeEnum, RecommendationsService, ReportsService, ScimService, SearchService, SkillsService, StateEnum, Status0e3Enum, Status3daEnum, TagsService, TransactionTypeEnum, TransactionsService, Type4b7Enum };
|
|
25822
26461
|
//# sourceMappingURL=index.esm.js.map
|