@iblai/iblai-api 4.415.0-core → 4.416.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.
Files changed (83) hide show
  1. package/dist/index.cjs.js +648 -30
  2. package/dist/index.cjs.js.map +1 -1
  3. package/dist/index.esm.js +649 -31
  4. package/dist/index.esm.js.map +1 -1
  5. package/dist/index.umd.js +648 -30
  6. package/dist/index.umd.js.map +1 -1
  7. package/dist/types/index.d.ts +27 -1
  8. package/dist/types/models/Activity.d.ts +6 -2
  9. package/dist/types/models/Deal.d.ts +14 -2
  10. package/dist/types/models/DealBoard.d.ts +7 -0
  11. package/dist/types/models/DealBoardStage.d.ts +19 -0
  12. package/dist/types/models/DirEnum.d.ts +8 -0
  13. package/dist/types/models/Favorite.d.ts +28 -0
  14. package/dist/types/models/HistoryEntry.d.ts +15 -0
  15. package/dist/types/models/HistoryEntryActionEnum.d.ts +12 -0
  16. package/dist/types/models/ObjectTypeEnum.d.ts +12 -0
  17. package/dist/types/models/Overview.d.ts +24 -0
  18. package/dist/types/models/OverviewActivities.d.ts +5 -0
  19. package/dist/types/models/OverviewCount.d.ts +3 -0
  20. package/dist/types/models/OverviewDeals.d.ts +22 -0
  21. package/dist/types/models/OverviewMonth.d.ts +10 -0
  22. package/dist/types/models/OverviewStage.d.ts +13 -0
  23. package/dist/types/models/PaginatedFavoriteList.d.ts +7 -0
  24. package/dist/types/models/PaginatedSavedViewList.d.ts +7 -0
  25. package/dist/types/models/PatchedActivity.d.ts +6 -2
  26. package/dist/types/models/PatchedDeal.d.ts +14 -2
  27. package/dist/types/models/PatchedPerson.d.ts +4 -0
  28. package/dist/types/models/PatchedPipeline.d.ts +1 -1
  29. package/dist/types/models/PatchedSavedView.d.ts +41 -0
  30. package/dist/types/models/Person.d.ts +4 -0
  31. package/dist/types/models/Pipeline.d.ts +1 -1
  32. package/dist/types/models/PipelineStageReorderRequest.d.ts +6 -0
  33. package/dist/types/models/SavedView.d.ts +41 -0
  34. package/dist/types/models/SavedViewTypeEnum.d.ts +8 -0
  35. package/dist/types/models/SearchDeal.d.ts +40 -0
  36. package/dist/types/models/SearchOrganization.d.ts +10 -0
  37. package/dist/types/models/SearchPerson.d.ts +33 -0
  38. package/dist/types/models/SearchResponse.d.ts +12 -0
  39. package/dist/types/models/{DealStatusEnum.d.ts → Status05cEnum.d.ts} +1 -1
  40. package/dist/types/models/_Column.d.ts +7 -0
  41. package/dist/types/models/_Filter.d.ts +8 -0
  42. package/dist/types/models/_Sort.d.ts +5 -0
  43. package/dist/types/services/CrmService.d.ts +523 -12
  44. package/package.json +1 -1
  45. package/sdk_schema.yml +1905 -27
  46. package/src/core/OpenAPI.ts +1 -1
  47. package/src/index.ts +27 -1
  48. package/src/models/Activity.ts +6 -2
  49. package/src/models/Deal.ts +14 -2
  50. package/src/models/DealBoard.ts +12 -0
  51. package/src/models/DealBoardStage.ts +24 -0
  52. package/src/models/DirEnum.ts +12 -0
  53. package/src/models/Favorite.ts +33 -0
  54. package/src/models/HistoryEntry.ts +20 -0
  55. package/src/models/HistoryEntryActionEnum.ts +16 -0
  56. package/src/models/ObjectTypeEnum.ts +16 -0
  57. package/src/models/Overview.ts +29 -0
  58. package/src/models/OverviewActivities.ts +10 -0
  59. package/src/models/OverviewCount.ts +8 -0
  60. package/src/models/OverviewDeals.ts +27 -0
  61. package/src/models/OverviewMonth.ts +15 -0
  62. package/src/models/OverviewStage.ts +18 -0
  63. package/src/models/PaginatedFavoriteList.ts +12 -0
  64. package/src/models/PaginatedSavedViewList.ts +12 -0
  65. package/src/models/PatchedActivity.ts +6 -2
  66. package/src/models/PatchedDeal.ts +14 -2
  67. package/src/models/PatchedPerson.ts +4 -0
  68. package/src/models/PatchedPipeline.ts +1 -1
  69. package/src/models/PatchedSavedView.ts +46 -0
  70. package/src/models/Person.ts +4 -0
  71. package/src/models/Pipeline.ts +1 -1
  72. package/src/models/PipelineStageReorderRequest.ts +11 -0
  73. package/src/models/SavedView.ts +46 -0
  74. package/src/models/SavedViewTypeEnum.ts +12 -0
  75. package/src/models/SearchDeal.ts +45 -0
  76. package/src/models/SearchOrganization.ts +15 -0
  77. package/src/models/SearchPerson.ts +38 -0
  78. package/src/models/SearchResponse.ts +17 -0
  79. package/src/models/{DealStatusEnum.ts → Status05cEnum.ts} +1 -1
  80. package/src/models/_Column.ts +12 -0
  81. package/src/models/_Filter.ts +13 -0
  82. package/src/models/_Sort.ts +10 -0
  83. package/src/services/CrmService.ts +924 -4
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.415.0-core',
111
+ VERSION: '4.416.0-core',
112
112
  WITH_CREDENTIALS: false,
113
113
  CREDENTIALS: 'include',
114
114
  TOKEN: undefined,
@@ -267,22 +267,6 @@ var CreditTransactionHistoryStatusEnum;
267
267
  CreditTransactionHistoryStatusEnum["CANCELLED"] = "cancelled";
268
268
  })(CreditTransactionHistoryStatusEnum || (CreditTransactionHistoryStatusEnum = {}));
269
269
 
270
- /* generated using openapi-typescript-codegen -- do not edit */
271
- /* istanbul ignore file */
272
- /* tslint:disable */
273
- /* eslint-disable */
274
- /**
275
- * * `open` - Open
276
- * * `won` - Won
277
- * * `lost` - Lost
278
- */
279
- var DealStatusEnum;
280
- (function (DealStatusEnum) {
281
- DealStatusEnum["OPEN"] = "open";
282
- DealStatusEnum["WON"] = "won";
283
- DealStatusEnum["LOST"] = "lost";
284
- })(DealStatusEnum || (DealStatusEnum = {}));
285
-
286
270
  /* generated using openapi-typescript-codegen -- do not edit */
287
271
  /* istanbul ignore file */
288
272
  /* tslint:disable */
@@ -297,6 +281,20 @@ var DirectionEnum;
297
281
  DirectionEnum["IMPORT"] = "import";
298
282
  })(DirectionEnum || (DirectionEnum = {}));
299
283
 
284
+ /* generated using openapi-typescript-codegen -- do not edit */
285
+ /* istanbul ignore file */
286
+ /* tslint:disable */
287
+ /* eslint-disable */
288
+ /**
289
+ * * `asc` - asc
290
+ * * `desc` - desc
291
+ */
292
+ var DirEnum;
293
+ (function (DirEnum) {
294
+ DirEnum["ASC"] = "asc";
295
+ DirEnum["DESC"] = "desc";
296
+ })(DirEnum || (DirEnum = {}));
297
+
300
298
  /* generated using openapi-typescript-codegen -- do not edit */
301
299
  /* istanbul ignore file */
302
300
  /* tslint:disable */
@@ -481,6 +479,24 @@ var GrandfatheringStrategyEnum;
481
479
  GrandfatheringStrategyEnum["REQUIRE_SUBSCRIPTION"] = "require_subscription";
482
480
  })(GrandfatheringStrategyEnum || (GrandfatheringStrategyEnum = {}));
483
481
 
482
+ /* generated using openapi-typescript-codegen -- do not edit */
483
+ /* istanbul ignore file */
484
+ /* tslint:disable */
485
+ /* eslint-disable */
486
+ /**
487
+ * * `create` - create
488
+ * * `update` - update
489
+ * * `delete` - delete
490
+ * * `access` - access
491
+ */
492
+ var HistoryEntryActionEnum;
493
+ (function (HistoryEntryActionEnum) {
494
+ HistoryEntryActionEnum["CREATE"] = "create";
495
+ HistoryEntryActionEnum["UPDATE"] = "update";
496
+ HistoryEntryActionEnum["DELETE"] = "delete";
497
+ HistoryEntryActionEnum["ACCESS"] = "access";
498
+ })(HistoryEntryActionEnum || (HistoryEntryActionEnum = {}));
499
+
484
500
  /* generated using openapi-typescript-codegen -- do not edit */
485
501
  /* istanbul ignore file */
486
502
  /* tslint:disable */
@@ -657,6 +673,24 @@ var NotificationSourceTypeEnum;
657
673
  NotificationSourceTypeEnum["USERGROUP"] = "usergroup";
658
674
  })(NotificationSourceTypeEnum || (NotificationSourceTypeEnum = {}));
659
675
 
676
+ /* generated using openapi-typescript-codegen -- do not edit */
677
+ /* istanbul ignore file */
678
+ /* tslint:disable */
679
+ /* eslint-disable */
680
+ /**
681
+ * * `persons` - Persons
682
+ * * `organizations` - Organizations
683
+ * * `deals` - Deals
684
+ * * `activities` - Activities
685
+ */
686
+ var ObjectTypeEnum;
687
+ (function (ObjectTypeEnum) {
688
+ ObjectTypeEnum["PERSONS"] = "persons";
689
+ ObjectTypeEnum["ORGANIZATIONS"] = "organizations";
690
+ ObjectTypeEnum["DEALS"] = "deals";
691
+ ObjectTypeEnum["ACTIVITIES"] = "activities";
692
+ })(ObjectTypeEnum || (ObjectTypeEnum = {}));
693
+
660
694
  /* generated using openapi-typescript-codegen -- do not edit */
661
695
  /* istanbul ignore file */
662
696
  /* tslint:disable */
@@ -841,6 +875,20 @@ var RoleEnum;
841
875
  RoleEnum["DATASET_CURATOR"] = "dataset_curator";
842
876
  })(RoleEnum || (RoleEnum = {}));
843
877
 
878
+ /* generated using openapi-typescript-codegen -- do not edit */
879
+ /* istanbul ignore file */
880
+ /* tslint:disable */
881
+ /* eslint-disable */
882
+ /**
883
+ * * `table` - Table
884
+ * * `kanban` - Kanban
885
+ */
886
+ var SavedViewTypeEnum;
887
+ (function (SavedViewTypeEnum) {
888
+ SavedViewTypeEnum["TABLE"] = "table";
889
+ SavedViewTypeEnum["KANBAN"] = "kanban";
890
+ })(SavedViewTypeEnum || (SavedViewTypeEnum = {}));
891
+
844
892
  /* generated using openapi-typescript-codegen -- do not edit */
845
893
  /* istanbul ignore file */
846
894
  /* tslint:disable */
@@ -885,6 +933,22 @@ var StateEnum;
885
933
  StateEnum["EXPIRED"] = "expired";
886
934
  })(StateEnum || (StateEnum = {}));
887
935
 
936
+ /* generated using openapi-typescript-codegen -- do not edit */
937
+ /* istanbul ignore file */
938
+ /* tslint:disable */
939
+ /* eslint-disable */
940
+ /**
941
+ * * `open` - Open
942
+ * * `won` - Won
943
+ * * `lost` - Lost
944
+ */
945
+ var Status05cEnum;
946
+ (function (Status05cEnum) {
947
+ Status05cEnum["OPEN"] = "open";
948
+ Status05cEnum["WON"] = "won";
949
+ Status05cEnum["LOST"] = "lost";
950
+ })(Status05cEnum || (Status05cEnum = {}));
951
+
888
952
  /* generated using openapi-typescript-codegen -- do not edit */
889
953
  /* istanbul ignore file */
890
954
  /* tslint:disable */
@@ -23446,37 +23510,49 @@ class CredentialsService {
23446
23510
  class CrmService {
23447
23511
  /**
23448
23512
  * List activities
23449
- * 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`.
23513
+ * 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`.
23450
23514
  *
23451
23515
  * **Required permission:** `Ibl.CRM/Activities/list`.
23452
23516
  * @returns PaginatedActivityList
23453
23517
  * @throws ApiError
23454
23518
  */
23455
23519
  static crmActivitiesList({
23520
+ dateFilter,
23456
23521
  deal,
23522
+ endDate,
23457
23523
  isDone,
23458
23524
  metadataHasKey,
23525
+ ordering,
23526
+ organization,
23459
23527
  owner,
23460
23528
  page,
23461
23529
  pageSize,
23462
23530
  person,
23463
23531
  scheduleFromGte,
23464
23532
  scheduleFromLte,
23533
+ search,
23534
+ startDate,
23465
23535
  type
23466
23536
  }) {
23467
23537
  return request(OpenAPI, {
23468
23538
  method: 'GET',
23469
23539
  url: '/api/crm/activities/',
23470
23540
  query: {
23541
+ 'date_filter': dateFilter,
23471
23542
  'deal': deal,
23543
+ 'end_date': endDate,
23472
23544
  'is_done': isDone,
23473
23545
  'metadata__has_key': metadataHasKey,
23546
+ 'ordering': ordering,
23547
+ 'organization': organization,
23474
23548
  'owner': owner,
23475
23549
  'page': page,
23476
23550
  'page_size': pageSize,
23477
23551
  'person': person,
23478
23552
  'schedule_from__gte': scheduleFromGte,
23479
23553
  'schedule_from__lte': scheduleFromLte,
23554
+ 'search': search,
23555
+ 'start_date': startDate,
23480
23556
  'type': type
23481
23557
  },
23482
23558
  errors: {
@@ -23487,7 +23563,7 @@ class CrmService {
23487
23563
  }
23488
23564
  /**
23489
23565
  * Create an activity
23490
- * Creates an Activity. Either `deal` or `person` must be supplied; both must belong to your Platform.
23566
+ * Creates an Activity. At least one of `deal`, `person` or `organization` must be supplied; all must belong to your Platform.
23491
23567
  *
23492
23568
  * **Required permission:** `Ibl.CRM/Activities/action`.
23493
23569
  * @returns Activity
@@ -23641,17 +23717,22 @@ class CrmService {
23641
23717
  static crmDealsList({
23642
23718
  createdAtGte,
23643
23719
  createdAtLte,
23720
+ dateFilter,
23721
+ endDate,
23644
23722
  expectedCloseDateGte,
23645
23723
  expectedCloseDateLte,
23646
23724
  metadataHasKey,
23725
+ ordering,
23647
23726
  organization,
23648
23727
  owner,
23649
23728
  page,
23650
23729
  pageSize,
23651
23730
  person,
23652
23731
  pipeline,
23732
+ search,
23653
23733
  source,
23654
23734
  stage,
23735
+ startDate,
23655
23736
  status,
23656
23737
  tags
23657
23738
  }) {
@@ -23661,17 +23742,22 @@ class CrmService {
23661
23742
  query: {
23662
23743
  'created_at__gte': createdAtGte,
23663
23744
  'created_at__lte': createdAtLte,
23745
+ 'date_filter': dateFilter,
23746
+ 'end_date': endDate,
23664
23747
  'expected_close_date__gte': expectedCloseDateGte,
23665
23748
  'expected_close_date__lte': expectedCloseDateLte,
23666
23749
  'metadata__has_key': metadataHasKey,
23750
+ 'ordering': ordering,
23667
23751
  'organization': organization,
23668
23752
  'owner': owner,
23669
23753
  'page': page,
23670
23754
  'page_size': pageSize,
23671
23755
  'person': person,
23672
23756
  'pipeline': pipeline,
23757
+ 'search': search,
23673
23758
  'source': source,
23674
23759
  'stage': stage,
23760
+ 'start_date': startDate,
23675
23761
  'status': status,
23676
23762
  'tags': tags
23677
23763
  },
@@ -23803,6 +23889,29 @@ class CrmService {
23803
23889
  }
23804
23890
  });
23805
23891
  }
23892
+ /**
23893
+ * Field-change history for this record
23894
+ * 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.
23895
+ *
23896
+ * **Required permission:** the record's `read` verb.
23897
+ * @returns HistoryEntry
23898
+ * @throws ApiError
23899
+ */
23900
+ static crmDealsHistoryList({
23901
+ id
23902
+ }) {
23903
+ return request(OpenAPI, {
23904
+ method: 'GET',
23905
+ url: '/api/crm/deals/{id}/history/',
23906
+ path: {
23907
+ 'id': id
23908
+ },
23909
+ errors: {
23910
+ 403: `Missing the record's \`read\` permission.`,
23911
+ 404: `Record not found.`
23912
+ }
23913
+ });
23914
+ }
23806
23915
  /**
23807
23916
  * Mark a deal as lost
23808
23917
  * 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.
@@ -23937,6 +24046,169 @@ class CrmService {
23937
24046
  }
23938
24047
  });
23939
24048
  }
24049
+ /**
24050
+ * Deals grouped by stage (the board)
24051
+ * 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.
24052
+ *
24053
+ * **Required permission:** `Ibl.CRM/Deals/list`.
24054
+ * @returns DealBoard
24055
+ * @throws ApiError
24056
+ */
24057
+ static crmDealsBoardRetrieve({
24058
+ createdAtGte,
24059
+ createdAtLte,
24060
+ dateFilter,
24061
+ endDate,
24062
+ expectedCloseDateGte,
24063
+ expectedCloseDateLte,
24064
+ limit,
24065
+ metadataHasKey,
24066
+ organization,
24067
+ owner,
24068
+ person,
24069
+ pipeline,
24070
+ search,
24071
+ source,
24072
+ stage,
24073
+ startDate,
24074
+ status,
24075
+ tags
24076
+ }) {
24077
+ return request(OpenAPI, {
24078
+ method: 'GET',
24079
+ url: '/api/crm/deals/board/',
24080
+ query: {
24081
+ 'created_at__gte': createdAtGte,
24082
+ 'created_at__lte': createdAtLte,
24083
+ 'date_filter': dateFilter,
24084
+ 'end_date': endDate,
24085
+ 'expected_close_date__gte': expectedCloseDateGte,
24086
+ 'expected_close_date__lte': expectedCloseDateLte,
24087
+ 'limit': limit,
24088
+ 'metadata__has_key': metadataHasKey,
24089
+ 'organization': organization,
24090
+ 'owner': owner,
24091
+ 'person': person,
24092
+ 'pipeline': pipeline,
24093
+ 'search': search,
24094
+ 'source': source,
24095
+ 'stage': stage,
24096
+ 'start_date': startDate,
24097
+ 'status': status,
24098
+ 'tags': tags
24099
+ },
24100
+ errors: {
24101
+ 400: `Bad \`pipeline\` or \`limit\`.`,
24102
+ 403: `Missing required permission \`Ibl.CRM/Deals/list\`.`,
24103
+ 404: `Pipeline not found.`
24104
+ }
24105
+ });
24106
+ }
24107
+ /**
24108
+ * List my favorites
24109
+ * Your starred persons, organizations and deals in this Platform, newest first.
24110
+ *
24111
+ * **Required permission:** `Ibl.CRM/Favorites/list`.
24112
+ * @returns PaginatedFavoriteList
24113
+ * @throws ApiError
24114
+ */
24115
+ static crmFavoritesList({
24116
+ dateFilter,
24117
+ deal,
24118
+ endDate,
24119
+ ordering,
24120
+ organization,
24121
+ page,
24122
+ pageSize,
24123
+ person,
24124
+ startDate
24125
+ }) {
24126
+ return request(OpenAPI, {
24127
+ method: 'GET',
24128
+ url: '/api/crm/favorites/',
24129
+ query: {
24130
+ 'date_filter': dateFilter,
24131
+ 'deal': deal,
24132
+ 'end_date': endDate,
24133
+ 'ordering': ordering,
24134
+ 'organization': organization,
24135
+ 'page': page,
24136
+ 'page_size': pageSize,
24137
+ 'person': person,
24138
+ 'start_date': startDate
24139
+ },
24140
+ errors: {
24141
+ 401: `Authentication required.`,
24142
+ 403: `Missing required permission \`Ibl.CRM/Favorites/list\`.`
24143
+ }
24144
+ });
24145
+ }
24146
+ /**
24147
+ * Star a record
24148
+ * 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.
24149
+ *
24150
+ * **Required permission:** `Ibl.CRM/Favorites/action`.
24151
+ * @returns Favorite
24152
+ * @throws ApiError
24153
+ */
24154
+ static crmFavoritesCreate({
24155
+ requestBody
24156
+ }) {
24157
+ return request(OpenAPI, {
24158
+ method: 'POST',
24159
+ url: '/api/crm/favorites/',
24160
+ body: requestBody,
24161
+ mediaType: 'application/json',
24162
+ errors: {
24163
+ 400: `Not exactly one target.`,
24164
+ 403: `Missing \`Ibl.CRM/Favorites/action\` or the target's \`read\`.`
24165
+ }
24166
+ });
24167
+ }
24168
+ /**
24169
+ * One of your favorites
24170
+ * **Required permission:** `Ibl.CRM/Favorites/read`.
24171
+ * @returns Favorite
24172
+ * @throws ApiError
24173
+ */
24174
+ static crmFavoritesRetrieve({
24175
+ id
24176
+ }) {
24177
+ return request(OpenAPI, {
24178
+ method: 'GET',
24179
+ url: '/api/crm/favorites/{id}/',
24180
+ path: {
24181
+ 'id': id
24182
+ },
24183
+ errors: {
24184
+ 403: `Missing required permission \`Ibl.CRM/Favorites/read\`.`,
24185
+ 404: `Favorite not found.`
24186
+ }
24187
+ });
24188
+ }
24189
+ /**
24190
+ * Unstar a record
24191
+ * Removes one of your favorites.
24192
+ *
24193
+ * **Required permission:** `Ibl.CRM/Favorites/delete`.
24194
+ * @returns void
24195
+ * @throws ApiError
24196
+ */
24197
+ static crmFavoritesDestroy({
24198
+ id
24199
+ }) {
24200
+ return request(OpenAPI, {
24201
+ method: 'DELETE',
24202
+ url: '/api/crm/favorites/{id}/',
24203
+ path: {
24204
+ 'id': id
24205
+ },
24206
+ errors: {
24207
+ 403: `Missing required permission \`Ibl.CRM/Favorites/delete\`.`,
24208
+ 404: `Favorite not found.`
24209
+ }
24210
+ });
24211
+ }
23940
24212
  /**
23941
24213
  * List lead sources
23942
24214
  * Returns a paginated list of LeadSources in your Platform.
@@ -23947,18 +24219,28 @@ class CrmService {
23947
24219
  */
23948
24220
  static crmLeadSourcesList({
23949
24221
  code,
24222
+ dateFilter,
24223
+ endDate,
23950
24224
  name,
24225
+ ordering,
23951
24226
  page,
23952
- pageSize
24227
+ pageSize,
24228
+ search,
24229
+ startDate
23953
24230
  }) {
23954
24231
  return request(OpenAPI, {
23955
24232
  method: 'GET',
23956
24233
  url: '/api/crm/lead-sources/',
23957
24234
  query: {
23958
24235
  'code': code,
24236
+ 'date_filter': dateFilter,
24237
+ 'end_date': endDate,
23959
24238
  'name': name,
24239
+ 'ordering': ordering,
23960
24240
  'page': page,
23961
- 'page_size': pageSize
24241
+ 'page_size': pageSize,
24242
+ 'search': search,
24243
+ 'start_date': startDate
23962
24244
  },
23963
24245
  errors: {
23964
24246
  401: `Authentication required.`,
@@ -24097,20 +24379,30 @@ class CrmService {
24097
24379
  * @throws ApiError
24098
24380
  */
24099
24381
  static crmOrganizationsList({
24382
+ dateFilter,
24383
+ endDate,
24100
24384
  name,
24385
+ ordering,
24101
24386
  owner,
24102
24387
  page,
24103
24388
  pageSize,
24389
+ search,
24390
+ startDate,
24104
24391
  tags
24105
24392
  }) {
24106
24393
  return request(OpenAPI, {
24107
24394
  method: 'GET',
24108
24395
  url: '/api/crm/organizations/',
24109
24396
  query: {
24397
+ 'date_filter': dateFilter,
24398
+ 'end_date': endDate,
24110
24399
  'name': name,
24400
+ 'ordering': ordering,
24111
24401
  'owner': owner,
24112
24402
  'page': page,
24113
24403
  'page_size': pageSize,
24404
+ 'search': search,
24405
+ 'start_date': startDate,
24114
24406
  'tags': tags
24115
24407
  },
24116
24408
  errors: {
@@ -24220,7 +24512,7 @@ class CrmService {
24220
24512
  }
24221
24513
  /**
24222
24514
  * Delete an organization
24223
- * Deletes the organization. Any persons linked to it are kept; their organization reference is cleared.
24515
+ * 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.
24224
24516
  *
24225
24517
  * **Required permission:** `Ibl.CRM/Organizations/delete`.
24226
24518
  * @returns void
@@ -24241,6 +24533,29 @@ class CrmService {
24241
24533
  }
24242
24534
  });
24243
24535
  }
24536
+ /**
24537
+ * Field-change history for this record
24538
+ * 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.
24539
+ *
24540
+ * **Required permission:** the record's `read` verb.
24541
+ * @returns HistoryEntry
24542
+ * @throws ApiError
24543
+ */
24544
+ static crmOrganizationsHistoryList({
24545
+ id
24546
+ }) {
24547
+ return request(OpenAPI, {
24548
+ method: 'GET',
24549
+ url: '/api/crm/organizations/{id}/history/',
24550
+ path: {
24551
+ 'id': id
24552
+ },
24553
+ errors: {
24554
+ 403: `Missing the record's \`read\` permission.`,
24555
+ 404: `Record not found.`
24556
+ }
24557
+ });
24558
+ }
24244
24559
  /**
24245
24560
  * Attach a tag to this record
24246
24561
  * 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.
@@ -24294,6 +24609,38 @@ class CrmService {
24294
24609
  }
24295
24610
  });
24296
24611
  }
24612
+ /**
24613
+ * CRM overview
24614
+ * 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.
24615
+ *
24616
+ * `date_filter` (or `start_date` + `end_date`) adds `period_*` siblings for that window.
24617
+ *
24618
+ * **Required permission:** the `list` verb of each section.
24619
+ * @returns Overview
24620
+ * @throws ApiError
24621
+ */
24622
+ static crmOverviewRetrieve({
24623
+ dateFilter,
24624
+ endDate,
24625
+ pipeline,
24626
+ startDate
24627
+ }) {
24628
+ return request(OpenAPI, {
24629
+ method: 'GET',
24630
+ url: '/api/crm/overview/',
24631
+ query: {
24632
+ 'date_filter': dateFilter,
24633
+ 'end_date': endDate,
24634
+ 'pipeline': pipeline,
24635
+ 'start_date': startDate
24636
+ },
24637
+ errors: {
24638
+ 400: `Invalid window or pipeline parameter.`,
24639
+ 403: `No CRM list permission.`,
24640
+ 404: `Pipeline not found.`
24641
+ }
24642
+ });
24643
+ }
24297
24644
  /**
24298
24645
  * List persons
24299
24646
  * 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`.
@@ -24303,28 +24650,40 @@ class CrmService {
24303
24650
  * @throws ApiError
24304
24651
  */
24305
24652
  static crmPersonsList({
24653
+ active,
24306
24654
  createdAtGte,
24307
24655
  createdAtLte,
24656
+ dateFilter,
24657
+ endDate,
24308
24658
  lifecycleStage,
24309
24659
  metadataHasKey,
24660
+ ordering,
24310
24661
  organization,
24311
24662
  owner,
24312
24663
  page,
24313
24664
  pageSize,
24665
+ search,
24666
+ startDate,
24314
24667
  tags
24315
24668
  }) {
24316
24669
  return request(OpenAPI, {
24317
24670
  method: 'GET',
24318
24671
  url: '/api/crm/persons/',
24319
24672
  query: {
24673
+ 'active': active,
24320
24674
  'created_at__gte': createdAtGte,
24321
24675
  'created_at__lte': createdAtLte,
24676
+ 'date_filter': dateFilter,
24677
+ 'end_date': endDate,
24322
24678
  'lifecycle_stage': lifecycleStage,
24323
24679
  'metadata__has_key': metadataHasKey,
24680
+ 'ordering': ordering,
24324
24681
  'organization': organization,
24325
24682
  'owner': owner,
24326
24683
  'page': page,
24327
24684
  'page_size': pageSize,
24685
+ 'search': search,
24686
+ 'start_date': startDate,
24328
24687
  'tags': tags
24329
24688
  },
24330
24689
  errors: {
@@ -24434,7 +24793,7 @@ class CrmService {
24434
24793
  }
24435
24794
  /**
24436
24795
  * Delete a person
24437
- * Deletes the person.
24796
+ * Deletes the person. Fails with `409 Conflict` if any Deal still references it.
24438
24797
  *
24439
24798
  * **Required permission:** `Ibl.CRM/Persons/delete`.
24440
24799
  * @returns void
@@ -24451,7 +24810,31 @@ class CrmService {
24451
24810
  },
24452
24811
  errors: {
24453
24812
  403: `Missing required permission \`Ibl.CRM/Persons/delete\`.`,
24454
- 404: `Person not found.`
24813
+ 404: `Person not found.`,
24814
+ 409: `Person still has Deals attached.`
24815
+ }
24816
+ });
24817
+ }
24818
+ /**
24819
+ * Field-change history for this record
24820
+ * 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.
24821
+ *
24822
+ * **Required permission:** the record's `read` verb.
24823
+ * @returns HistoryEntry
24824
+ * @throws ApiError
24825
+ */
24826
+ static crmPersonsHistoryList({
24827
+ id
24828
+ }) {
24829
+ return request(OpenAPI, {
24830
+ method: 'GET',
24831
+ url: '/api/crm/persons/{id}/history/',
24832
+ path: {
24833
+ 'id': id
24834
+ },
24835
+ errors: {
24836
+ 403: `Missing the record's \`read\` permission.`,
24837
+ 404: `Record not found.`
24455
24838
  }
24456
24839
  });
24457
24840
  }
@@ -24602,20 +24985,30 @@ class CrmService {
24602
24985
  */
24603
24986
  static crmPipelinesList({
24604
24987
  code,
24988
+ dateFilter,
24989
+ endDate,
24605
24990
  isDefault,
24606
24991
  name,
24992
+ ordering,
24607
24993
  page,
24608
- pageSize
24994
+ pageSize,
24995
+ search,
24996
+ startDate
24609
24997
  }) {
24610
24998
  return request(OpenAPI, {
24611
24999
  method: 'GET',
24612
25000
  url: '/api/crm/pipelines/',
24613
25001
  query: {
24614
25002
  'code': code,
25003
+ 'date_filter': dateFilter,
25004
+ 'end_date': endDate,
24615
25005
  'is_default': isDefault,
24616
25006
  'name': name,
25007
+ 'ordering': ordering,
24617
25008
  'page': page,
24618
- 'page_size': pageSize
25009
+ 'page_size': pageSize,
25010
+ 'search': search,
25011
+ 'start_date': startDate
24619
25012
  },
24620
25013
  errors: {
24621
25014
  401: `Authentication required.`,
@@ -24656,10 +25049,15 @@ class CrmService {
24656
25049
  static crmPipelinesStagesList({
24657
25050
  pipelinePk,
24658
25051
  code,
25052
+ dateFilter,
25053
+ endDate,
24659
25054
  isLost,
24660
25055
  isWon,
25056
+ ordering,
24661
25057
  page,
24662
- pageSize
25058
+ pageSize,
25059
+ search,
25060
+ startDate
24663
25061
  }) {
24664
25062
  return request(OpenAPI, {
24665
25063
  method: 'GET',
@@ -24669,10 +25067,15 @@ class CrmService {
24669
25067
  },
24670
25068
  query: {
24671
25069
  'code': code,
25070
+ 'date_filter': dateFilter,
25071
+ 'end_date': endDate,
24672
25072
  'is_lost': isLost,
24673
25073
  'is_won': isWon,
25074
+ 'ordering': ordering,
24674
25075
  'page': page,
24675
- 'page_size': pageSize
25076
+ 'page_size': pageSize,
25077
+ 'search': search,
25078
+ 'start_date': startDate
24676
25079
  },
24677
25080
  errors: {
24678
25081
  403: `Missing required permission \`Ibl.CRM/Pipelines/list\`.`,
@@ -24917,6 +25320,58 @@ class CrmService {
24917
25320
  }
24918
25321
  });
24919
25322
  }
25323
+ /**
25324
+ * Reorder a pipeline's stages
25325
+ * 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.
25326
+ *
25327
+ * **Required permission:** `Ibl.CRM/Pipelines/write`.
25328
+ * @returns Pipeline
25329
+ * @throws ApiError
25330
+ */
25331
+ static crmPipelinesStagesReorderCreate({
25332
+ id,
25333
+ requestBody
25334
+ }) {
25335
+ return request(OpenAPI, {
25336
+ method: 'POST',
25337
+ url: '/api/crm/pipelines/{id}/stages/reorder/',
25338
+ path: {
25339
+ 'id': id
25340
+ },
25341
+ body: requestBody,
25342
+ mediaType: 'application/json',
25343
+ errors: {
25344
+ 400: `\`order\` is not a permutation of the stages.`,
25345
+ 403: `Missing required permission \`Ibl.CRM/Pipelines/write\`.`,
25346
+ 404: `Pipeline not found.`
25347
+ }
25348
+ });
25349
+ }
25350
+ /**
25351
+ * Search persons, organizations and deals
25352
+ * 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.
25353
+ *
25354
+ * **Required permission:** `Ibl.CRM/Persons/list`, `Ibl.CRM/Organizations/list` or `Ibl.CRM/Deals/list` (at least one).
25355
+ * @returns SearchResponse
25356
+ * @throws ApiError
25357
+ */
25358
+ static crmSearchRetrieve({
25359
+ q,
25360
+ limit
25361
+ }) {
25362
+ return request(OpenAPI, {
25363
+ method: 'GET',
25364
+ url: '/api/crm/search/',
25365
+ query: {
25366
+ 'limit': limit,
25367
+ 'q': q
25368
+ },
25369
+ errors: {
25370
+ 400: `\`q\` missing or \`limit\` out of range.`,
25371
+ 403: `No CRM list permission.`
25372
+ }
25373
+ });
25374
+ }
24920
25375
  /**
24921
25376
  * List tags
24922
25377
  * 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.
@@ -24928,9 +25383,14 @@ class CrmService {
24928
25383
  static crmTagsList({
24929
25384
  createdAtGte,
24930
25385
  createdAtLte,
25386
+ dateFilter,
25387
+ endDate,
24931
25388
  name,
25389
+ ordering,
24932
25390
  page,
24933
- pageSize
25391
+ pageSize,
25392
+ search,
25393
+ startDate
24934
25394
  }) {
24935
25395
  return request(OpenAPI, {
24936
25396
  method: 'GET',
@@ -24938,9 +25398,14 @@ class CrmService {
24938
25398
  query: {
24939
25399
  'created_at__gte': createdAtGte,
24940
25400
  'created_at__lte': createdAtLte,
25401
+ 'date_filter': dateFilter,
25402
+ 'end_date': endDate,
24941
25403
  'name': name,
25404
+ 'ordering': ordering,
24942
25405
  'page': page,
24943
- 'page_size': pageSize
25406
+ 'page_size': pageSize,
25407
+ 'search': search,
25408
+ 'start_date': startDate
24944
25409
  },
24945
25410
  errors: {
24946
25411
  401: `Authentication required.`,
@@ -25070,6 +25535,159 @@ class CrmService {
25070
25535
  }
25071
25536
  });
25072
25537
  }
25538
+ /**
25539
+ * List my saved views
25540
+ * Your saved views in this Platform; filter with `object_type`.
25541
+ *
25542
+ * **Required permission:** `Ibl.CRM/Views/list`.
25543
+ * @returns PaginatedSavedViewList
25544
+ * @throws ApiError
25545
+ */
25546
+ static crmViewsList({
25547
+ dateFilter,
25548
+ endDate,
25549
+ objectType,
25550
+ ordering,
25551
+ page,
25552
+ pageSize,
25553
+ search,
25554
+ startDate,
25555
+ type
25556
+ }) {
25557
+ return request(OpenAPI, {
25558
+ method: 'GET',
25559
+ url: '/api/crm/views/',
25560
+ query: {
25561
+ 'date_filter': dateFilter,
25562
+ 'end_date': endDate,
25563
+ 'object_type': objectType,
25564
+ 'ordering': ordering,
25565
+ 'page': page,
25566
+ 'page_size': pageSize,
25567
+ 'search': search,
25568
+ 'start_date': startDate,
25569
+ 'type': type
25570
+ },
25571
+ errors: {
25572
+ 401: `Authentication required.`,
25573
+ 403: `Missing required permission \`Ibl.CRM/Views/list\`.`
25574
+ }
25575
+ });
25576
+ }
25577
+ /**
25578
+ * Save a view
25579
+ * Stores columns, filters, sorts and (for deals) a kanban grouping under a name unique to you and the list.
25580
+ *
25581
+ * **Required permission:** `Ibl.CRM/Views/action`.
25582
+ * @returns SavedView
25583
+ * @throws ApiError
25584
+ */
25585
+ static crmViewsCreate({
25586
+ requestBody
25587
+ }) {
25588
+ return request(OpenAPI, {
25589
+ method: 'POST',
25590
+ url: '/api/crm/views/',
25591
+ body: requestBody,
25592
+ mediaType: 'application/json',
25593
+ errors: {
25594
+ 400: `Validation error.`,
25595
+ 403: `Missing required permission \`Ibl.CRM/Views/action\`.`
25596
+ }
25597
+ });
25598
+ }
25599
+ /**
25600
+ * Retrieve a saved view
25601
+ * **Required permission:** `Ibl.CRM/Views/read`.
25602
+ * @returns SavedView
25603
+ * @throws ApiError
25604
+ */
25605
+ static crmViewsRetrieve({
25606
+ id
25607
+ }) {
25608
+ return request(OpenAPI, {
25609
+ method: 'GET',
25610
+ url: '/api/crm/views/{id}/',
25611
+ path: {
25612
+ 'id': id
25613
+ },
25614
+ errors: {
25615
+ 403: `Missing required permission \`Ibl.CRM/Views/read\`.`,
25616
+ 404: `View not found.`
25617
+ }
25618
+ });
25619
+ }
25620
+ /**
25621
+ * Replace a saved view
25622
+ * **Required permission:** `Ibl.CRM/Views/write`.
25623
+ * @returns SavedView
25624
+ * @throws ApiError
25625
+ */
25626
+ static crmViewsUpdate({
25627
+ id,
25628
+ requestBody
25629
+ }) {
25630
+ return request(OpenAPI, {
25631
+ method: 'PUT',
25632
+ url: '/api/crm/views/{id}/',
25633
+ path: {
25634
+ 'id': id
25635
+ },
25636
+ body: requestBody,
25637
+ mediaType: 'application/json',
25638
+ errors: {
25639
+ 400: `Validation error.`,
25640
+ 403: `Missing required permission \`Ibl.CRM/Views/write\`.`,
25641
+ 404: `View not found.`
25642
+ }
25643
+ });
25644
+ }
25645
+ /**
25646
+ * Update a saved view
25647
+ * **Required permission:** `Ibl.CRM/Views/write`.
25648
+ * @returns SavedView
25649
+ * @throws ApiError
25650
+ */
25651
+ static crmViewsPartialUpdate({
25652
+ id,
25653
+ requestBody
25654
+ }) {
25655
+ return request(OpenAPI, {
25656
+ method: 'PATCH',
25657
+ url: '/api/crm/views/{id}/',
25658
+ path: {
25659
+ 'id': id
25660
+ },
25661
+ body: requestBody,
25662
+ mediaType: 'application/json',
25663
+ errors: {
25664
+ 400: `Validation error.`,
25665
+ 403: `Missing required permission \`Ibl.CRM/Views/write\`.`,
25666
+ 404: `View not found.`
25667
+ }
25668
+ });
25669
+ }
25670
+ /**
25671
+ * Delete a saved view
25672
+ * **Required permission:** `Ibl.CRM/Views/delete`.
25673
+ * @returns void
25674
+ * @throws ApiError
25675
+ */
25676
+ static crmViewsDestroy({
25677
+ id
25678
+ }) {
25679
+ return request(OpenAPI, {
25680
+ method: 'DELETE',
25681
+ url: '/api/crm/views/{id}/',
25682
+ path: {
25683
+ 'id': id
25684
+ },
25685
+ errors: {
25686
+ 403: `Missing required permission \`Ibl.CRM/Views/delete\`.`,
25687
+ 404: `View not found.`
25688
+ }
25689
+ });
25690
+ }
25073
25691
  }
25074
25692
 
25075
25693
  class CustomDomainsService {
@@ -28251,5 +28869,5 @@ class SkillsService {
28251
28869
  }
28252
28870
  }
28253
28871
 
28254
- export { AcceptanceEnum, ActivityTypeEnum, AiAnalyticsService, AnalyticsService, ApiError, AutoRechargeTriggerResponseStatusEnum, BillingService, BlankEnum, BusinessTypeEnum, CancelError, CancelablePromise, CareerService, CatalogService, CeleryHeartbeatFailStatusEnum, CeleryHeartbeatStatusEnum, CommerceService, CoreService, CoursesProgressFrequencyEnum, CoursesProgressLearnerScopeEnum, CredentialsService, CreditTransactionHistoryStatusEnum, CrmService, CustomDomainsService, DealStatusEnum, DirectionEnum, DisabilityStatusEnum, EthnicityEnum, EventsEnum, EximService, FeaturesService, FieldTypeEnum, FlowTypeEnum, GenderEnum, GooglePayAccountResponseStatusEnum, GradePostedNotifyModeEnum, GrandfatheringStrategyEnum, HumanSupportRecipientModeEnum, InstitutionTypeEnum, IntervalEnum, ItemTypeEnum, KindEnum, LifecycleStageEnum, MediaService, MediaTypeEnum, NotificationFrequencyEnum, NotificationSourceTypeEnum, NotificationsService, OpenAPI, PeriodEnum, PlatformApiKeyModeEnum, PlatformApplicationFeeActionActionEnum, PlatformApplicationPlacementUpdateStatusEnum, PlatformApplicationTransitionActionEnum, PlatformListStatusEnum, ProgramTypeEnum, RecipientsRecipientModeEnum, RecommendationsService, ReportsService, RoleEnum, ScimService, SearchService, SkillsService, SourceEnum, StateEnum, Status0e3Enum, Status147Enum, Status3daEnum, StripeCheckoutSessionRequestModeEnum, TimezoneEnum, TransactionTypeEnum, Type6d9Enum };
28872
+ export { AcceptanceEnum, ActivityTypeEnum, AiAnalyticsService, AnalyticsService, ApiError, AutoRechargeTriggerResponseStatusEnum, BillingService, BlankEnum, BusinessTypeEnum, CancelError, CancelablePromise, CareerService, CatalogService, CeleryHeartbeatFailStatusEnum, CeleryHeartbeatStatusEnum, CommerceService, CoreService, CoursesProgressFrequencyEnum, CoursesProgressLearnerScopeEnum, CredentialsService, CreditTransactionHistoryStatusEnum, CrmService, CustomDomainsService, DirEnum, DirectionEnum, DisabilityStatusEnum, EthnicityEnum, EventsEnum, EximService, FeaturesService, FieldTypeEnum, FlowTypeEnum, GenderEnum, GooglePayAccountResponseStatusEnum, GradePostedNotifyModeEnum, GrandfatheringStrategyEnum, HistoryEntryActionEnum, HumanSupportRecipientModeEnum, InstitutionTypeEnum, IntervalEnum, ItemTypeEnum, KindEnum, LifecycleStageEnum, MediaService, MediaTypeEnum, NotificationFrequencyEnum, NotificationSourceTypeEnum, NotificationsService, ObjectTypeEnum, OpenAPI, PeriodEnum, PlatformApiKeyModeEnum, PlatformApplicationFeeActionActionEnum, PlatformApplicationPlacementUpdateStatusEnum, PlatformApplicationTransitionActionEnum, PlatformListStatusEnum, ProgramTypeEnum, RecipientsRecipientModeEnum, RecommendationsService, ReportsService, RoleEnum, SavedViewTypeEnum, ScimService, SearchService, SkillsService, SourceEnum, StateEnum, Status05cEnum, Status0e3Enum, Status147Enum, Status3daEnum, StripeCheckoutSessionRequestModeEnum, TimezoneEnum, TransactionTypeEnum, Type6d9Enum };
28255
28873
  //# sourceMappingURL=index.esm.js.map