@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
@@ -21,7 +21,7 @@ export type OpenAPIConfig = {
21
21
 
22
22
  export const OpenAPI: OpenAPIConfig = {
23
23
  BASE: 'https://base.manager.iblai.app',
24
- VERSION: '4.415.0-core',
24
+ VERSION: '4.416.0-core',
25
25
  WITH_CREDENTIALS: false,
26
26
  CREDENTIALS: 'include',
27
27
  TOKEN: undefined,
package/src/index.ts CHANGED
@@ -7,6 +7,9 @@ export { CancelablePromise, CancelError } from './core/CancelablePromise';
7
7
  export { OpenAPI } from './core/OpenAPI';
8
8
  export type { OpenAPIConfig } from './core/OpenAPI';
9
9
 
10
+ export type { _Column } from './models/_Column';
11
+ export type { _Filter } from './models/_Filter';
12
+ export type { _Sort } from './models/_Sort';
10
13
  export type { _TagAttachRequest } from './models/_TagAttachRequest';
11
14
  export { AcceptanceEnum } from './models/AcceptanceEnum';
12
15
  export type { AccessibleUser } from './models/AccessibleUser';
@@ -139,9 +142,10 @@ export type { CreditAccountInfo } from './models/CreditAccountInfo';
139
142
  export type { CreditTransactionHistory } from './models/CreditTransactionHistory';
140
143
  export { CreditTransactionHistoryStatusEnum } from './models/CreditTransactionHistoryStatusEnum';
141
144
  export type { Deal } from './models/Deal';
145
+ export type { DealBoard } from './models/DealBoard';
146
+ export type { DealBoardStage } from './models/DealBoardStage';
142
147
  export type { DealLostRequest } from './models/DealLostRequest';
143
148
  export type { DealMoveStageRequest } from './models/DealMoveStageRequest';
144
- export { DealStatusEnum } from './models/DealStatusEnum';
145
149
  export type { DealWonRequest } from './models/DealWonRequest';
146
150
  export type { DemographicsFieldDefinition } from './models/DemographicsFieldDefinition';
147
151
  export type { DemographicsFieldDefinitionWrite } from './models/DemographicsFieldDefinitionWrite';
@@ -153,6 +157,7 @@ export type { DetailedGradeSubsection } from './models/DetailedGradeSubsection';
153
157
  export type { DetailedGradeView } from './models/DetailedGradeView';
154
158
  export type { DetailedGradeViewData } from './models/DetailedGradeViewData';
155
159
  export { DirectionEnum } from './models/DirectionEnum';
160
+ export { DirEnum } from './models/DirEnum';
156
161
  export { DisabilityStatusEnum } from './models/DisabilityStatusEnum';
157
162
  export type { Education } from './models/Education';
158
163
  export type { EdxJwtToken } from './models/EdxJwtToken';
@@ -172,6 +177,7 @@ export type { EximTask } from './models/EximTask';
172
177
  export type { Experience } from './models/Experience';
173
178
  export type { ExportTargetEnvironment } from './models/ExportTargetEnvironment';
174
179
  export type { ExternalCredentialMapping } from './models/ExternalCredentialMapping';
180
+ export type { Favorite } from './models/Favorite';
175
181
  export type { FieldDefinitionImport } from './models/FieldDefinitionImport';
176
182
  export { FieldTypeEnum } from './models/FieldTypeEnum';
177
183
  export { FlowTypeEnum } from './models/FlowTypeEnum';
@@ -187,6 +193,8 @@ export type { GradingPerUserData } from './models/GradingPerUserData';
187
193
  export { GrandfatheringStrategyEnum } from './models/GrandfatheringStrategyEnum';
188
194
  export type { GroupList } from './models/GroupList';
189
195
  export type { GroupListData } from './models/GroupListData';
196
+ export type { HistoryEntry } from './models/HistoryEntry';
197
+ export { HistoryEntryActionEnum } from './models/HistoryEntryActionEnum';
190
198
  export { HumanSupportRecipientModeEnum } from './models/HumanSupportRecipientModeEnum';
191
199
  export type { ImageUpload } from './models/ImageUpload';
192
200
  export type { Institution } from './models/Institution';
@@ -249,6 +257,7 @@ export type { NotificationTemplateTestResponse } from './models/NotificationTemp
249
257
  export type { NotificationToggle } from './models/NotificationToggle';
250
258
  export type { NotificationTypePreference } from './models/NotificationTypePreference';
251
259
  export type { NullEnum } from './models/NullEnum';
260
+ export { ObjectTypeEnum } from './models/ObjectTypeEnum';
252
261
  export type { OnboardingStatusUpdate } from './models/OnboardingStatusUpdate';
253
262
  export type { Organization } from './models/Organization';
254
263
  export type { OverTime } from './models/OverTime';
@@ -256,6 +265,12 @@ export type { OvertimeDataPoint } from './models/OvertimeDataPoint';
256
265
  export type { OvertimeMeta } from './models/OvertimeMeta';
257
266
  export type { OvertimeWithChangeInfo } from './models/OvertimeWithChangeInfo';
258
267
  export type { OverTimeWithTotal } from './models/OverTimeWithTotal';
268
+ export type { Overview } from './models/Overview';
269
+ export type { OverviewActivities } from './models/OverviewActivities';
270
+ export type { OverviewCount } from './models/OverviewCount';
271
+ export type { OverviewDeals } from './models/OverviewDeals';
272
+ export type { OverviewMonth } from './models/OverviewMonth';
273
+ export type { OverviewStage } from './models/OverviewStage';
259
274
  export type { PaginatedAccessibleUserList } from './models/PaginatedAccessibleUserList';
260
275
  export type { PaginatedActivityList } from './models/PaginatedActivityList';
261
276
  export type { PaginatedAssertionsResponse } from './models/PaginatedAssertionsResponse';
@@ -268,6 +283,7 @@ export type { PaginatedCourseLicenseAssignment } from './models/PaginatedCourseL
268
283
  export type { PaginatedCourseLicenseGroupAssignment } from './models/PaginatedCourseLicenseGroupAssignment';
269
284
  export type { PaginatedCourseSuggestion } from './models/PaginatedCourseSuggestion';
270
285
  export type { PaginatedDealList } from './models/PaginatedDealList';
286
+ export type { PaginatedFavoriteList } from './models/PaginatedFavoriteList';
271
287
  export type { PaginatedItemPaywallConfigList } from './models/PaginatedItemPaywallConfigList';
272
288
  export type { PaginatedItemSubscriptionList } from './models/PaginatedItemSubscriptionList';
273
289
  export type { PaginatedItemSubscriptionListList } from './models/PaginatedItemSubscriptionListList';
@@ -291,6 +307,7 @@ export type { PaginatedRbacGroupList } from './models/PaginatedRbacGroupList';
291
307
  export type { PaginatedRbacPolicyList } from './models/PaginatedRbacPolicyList';
292
308
  export type { PaginatedRbacRoleList } from './models/PaginatedRbacRoleList';
293
309
  export type { PaginatedResource } from './models/PaginatedResource';
310
+ export type { PaginatedSavedViewList } from './models/PaginatedSavedViewList';
294
311
  export type { PaginatedSkill } from './models/PaginatedSkill';
295
312
  export type { PaginatedTagList } from './models/PaginatedTagList';
296
313
  export type { PaginatedUserAppList } from './models/PaginatedUserAppList';
@@ -329,6 +346,7 @@ export type { PatchedPlatformPublicMetadata } from './models/PatchedPlatformPubl
329
346
  export type { PatchedRbacGroup } from './models/PatchedRbacGroup';
330
347
  export type { PatchedRbacPolicy } from './models/PatchedRbacPolicy';
331
348
  export type { PatchedRbacRole } from './models/PatchedRbacRole';
349
+ export type { PatchedSavedView } from './models/PatchedSavedView';
332
350
  export type { PatchedSCIMGroup } from './models/PatchedSCIMGroup';
333
351
  export type { PatchedSCIMUserResponse } from './models/PatchedSCIMUserResponse';
334
352
  export type { PatchedSkillThreshold } from './models/PatchedSkillThreshold';
@@ -384,6 +402,7 @@ export type { PersonMergeRequest } from './models/PersonMergeRequest';
384
402
  export type { PersonMergeResponse } from './models/PersonMergeResponse';
385
403
  export type { Pipeline } from './models/Pipeline';
386
404
  export type { PipelineStage } from './models/PipelineStage';
405
+ export type { PipelineStageReorderRequest } from './models/PipelineStageReorderRequest';
387
406
  export type { PlacementAssessment } from './models/PlacementAssessment';
388
407
  export type { PlacementCourseAssignmentCreate } from './models/PlacementCourseAssignmentCreate';
389
408
  export type { PlacementProgramAssignmentCreate } from './models/PlacementProgramAssignmentCreate';
@@ -513,6 +532,8 @@ export type { ResourcePoint } from './models/ResourcePoint';
513
532
  export type { Role } from './models/Role';
514
533
  export type { RoleCreateUpdateRequest } from './models/RoleCreateUpdateRequest';
515
534
  export { RoleEnum } from './models/RoleEnum';
535
+ export type { SavedView } from './models/SavedView';
536
+ export { SavedViewTypeEnum } from './models/SavedViewTypeEnum';
516
537
  export type { SCIMAddress } from './models/SCIMAddress';
517
538
  export type { SCIMEmail } from './models/SCIMEmail';
518
539
  export type { SCIMEnterpriseUser } from './models/SCIMEnterpriseUser';
@@ -524,6 +545,10 @@ export type { SCIMPhoneNumber } from './models/SCIMPhoneNumber';
524
545
  export type { SCIMUserCreateRequest } from './models/SCIMUserCreateRequest';
525
546
  export type { SCIMUserListResponse } from './models/SCIMUserListResponse';
526
547
  export type { SCIMUserResponse } from './models/SCIMUserResponse';
548
+ export type { SearchDeal } from './models/SearchDeal';
549
+ export type { SearchOrganization } from './models/SearchOrganization';
550
+ export type { SearchPerson } from './models/SearchPerson';
551
+ export type { SearchResponse } from './models/SearchResponse';
527
552
  export type { SendNotification } from './models/SendNotification';
528
553
  export type { SendResponse } from './models/SendResponse';
529
554
  export type { SetStudentLLMAccess } from './models/SetStudentLLMAccess';
@@ -538,6 +563,7 @@ export type { SkillThreshold } from './models/SkillThreshold';
538
563
  export { SourceEnum } from './models/SourceEnum';
539
564
  export type { Spa } from './models/Spa';
540
565
  export { StateEnum } from './models/StateEnum';
566
+ export { Status05cEnum } from './models/Status05cEnum';
541
567
  export { Status0e3Enum } from './models/Status0e3Enum';
542
568
  export { Status147Enum } from './models/Status147Enum';
543
569
  export { Status3daEnum } from './models/Status3daEnum';
@@ -53,13 +53,17 @@ export type Activity = {
53
53
  */
54
54
  readonly done_at: string | null;
55
55
  /**
56
- * Id of the Deal this Activity is logged against. Either `deal` or `person` is required.
56
+ * Id of the Deal this Activity is logged against. One of `deal`, `person` or `organization` is required.
57
57
  */
58
58
  deal?: number | null;
59
59
  /**
60
- * UUID of the Person this Activity is logged against. Either `deal` or `person` is required.
60
+ * UUID of the Person this Activity is logged against. One of `deal`, `person` or `organization` is required.
61
61
  */
62
62
  person?: string | null;
63
+ /**
64
+ * UUID of the Organization this Activity is logged against.
65
+ */
66
+ organization?: string | null;
63
67
  /**
64
68
  * Id of the user who scheduled / logged this Activity. Defaults to the calling user on create.
65
69
  */
@@ -2,7 +2,7 @@
2
2
  /* istanbul ignore file */
3
3
  /* tslint:disable */
4
4
  /* eslint-disable */
5
- import type { DealStatusEnum } from './DealStatusEnum';
5
+ import type { Status05cEnum } from './Status05cEnum';
6
6
  /**
7
7
  * Adds a read-only ``tags`` field to a host serializer.
8
8
  *
@@ -42,7 +42,11 @@ export type Deal = {
42
42
  * * `won` - Won
43
43
  * * `lost` - Lost
44
44
  */
45
- readonly status: DealStatusEnum;
45
+ readonly status: Status05cEnum;
46
+ /**
47
+ * Open and untouched for longer than the pipeline's `rotten_days`.
48
+ */
49
+ readonly is_stale: boolean;
46
50
  /**
47
51
  * Set on a `lost` transition (e.g. 'Chose competitor').
48
52
  */
@@ -59,10 +63,18 @@ export type Deal = {
59
63
  * UUID of the primary contact for this Deal. The person must belong to your Platform.
60
64
  */
61
65
  person: string;
66
+ /**
67
+ * The person's name.
68
+ */
69
+ readonly person_name: string;
62
70
  /**
63
71
  * UUID of an organization the Deal is with. Optional; must belong to your Platform.
64
72
  */
65
73
  organization?: string | null;
74
+ /**
75
+ * The organization's name, or null.
76
+ */
77
+ readonly organization_name: string | null;
66
78
  /**
67
79
  * Pipeline this Deal flows through. Must belong to your Platform.
68
80
  */
@@ -0,0 +1,12 @@
1
+ /* generated using openapi-typescript-codegen -- do not edit */
2
+ /* istanbul ignore file */
3
+ /* tslint:disable */
4
+ /* eslint-disable */
5
+ import type { DealBoardStage } from './DealBoardStage';
6
+ import type { Pipeline } from './Pipeline';
7
+ export type DealBoard = {
8
+ pipeline: Pipeline;
9
+ limit: number;
10
+ stages: Array<DealBoardStage>;
11
+ };
12
+
@@ -0,0 +1,24 @@
1
+ /* generated using openapi-typescript-codegen -- do not edit */
2
+ /* istanbul ignore file */
3
+ /* tslint:disable */
4
+ /* eslint-disable */
5
+ import type { Deal } from './Deal';
6
+ import type { PipelineStage } from './PipelineStage';
7
+ export type DealBoardStage = {
8
+ stage: PipelineStage;
9
+ /**
10
+ * Deals in this stage after filters.
11
+ */
12
+ count: number;
13
+ total_value: string;
14
+ /**
15
+ * Sum of `lead_value × stage.probability / 100`.
16
+ */
17
+ weighted_value: string;
18
+ /**
19
+ * True when `count` exceeds `limit`; `deals` holds the newest `limit`.
20
+ */
21
+ has_more: boolean;
22
+ deals: Array<Deal>;
23
+ };
24
+
@@ -0,0 +1,12 @@
1
+ /* generated using openapi-typescript-codegen -- do not edit */
2
+ /* istanbul ignore file */
3
+ /* tslint:disable */
4
+ /* eslint-disable */
5
+ /**
6
+ * * `asc` - asc
7
+ * * `desc` - desc
8
+ */
9
+ export enum DirEnum {
10
+ ASC = 'asc',
11
+ DESC = 'desc',
12
+ }
@@ -0,0 +1,33 @@
1
+ /* generated using openapi-typescript-codegen -- do not edit */
2
+ /* istanbul ignore file */
3
+ /* tslint:disable */
4
+ /* eslint-disable */
5
+ export type Favorite = {
6
+ readonly id: number;
7
+ /**
8
+ * Tenant this favorite belongs to.
9
+ */
10
+ readonly platform: number;
11
+ /**
12
+ * UUID of a Person to star.
13
+ */
14
+ person?: string | null;
15
+ /**
16
+ * UUID of an Organization to star.
17
+ */
18
+ organization?: string | null;
19
+ /**
20
+ * Id of a Deal to star.
21
+ */
22
+ deal?: number | null;
23
+ /**
24
+ * `person`, `organization` or `deal`.
25
+ */
26
+ readonly target_type: string;
27
+ /**
28
+ * The target's display name.
29
+ */
30
+ readonly label: string;
31
+ readonly created_at: string;
32
+ };
33
+
@@ -0,0 +1,20 @@
1
+ /* generated using openapi-typescript-codegen -- do not edit */
2
+ /* istanbul ignore file */
3
+ /* tslint:disable */
4
+ /* eslint-disable */
5
+ import type { HistoryEntryActionEnum } from './HistoryEntryActionEnum';
6
+ /**
7
+ * Who changed what and when. Unlike core's admin-only audit-log API,
8
+ * this omits the actor's email and client IP: any `read` holder sees it.
9
+ */
10
+ export type HistoryEntry = {
11
+ id: number;
12
+ timestamp: string;
13
+ action: HistoryEntryActionEnum;
14
+ actor_username: string | null;
15
+ /**
16
+ * `{field: [old, new]}` as strings; a null reads `"None"`.
17
+ */
18
+ changes: Record<string, any> | null;
19
+ };
20
+
@@ -0,0 +1,16 @@
1
+ /* generated using openapi-typescript-codegen -- do not edit */
2
+ /* istanbul ignore file */
3
+ /* tslint:disable */
4
+ /* eslint-disable */
5
+ /**
6
+ * * `create` - create
7
+ * * `update` - update
8
+ * * `delete` - delete
9
+ * * `access` - access
10
+ */
11
+ export enum HistoryEntryActionEnum {
12
+ CREATE = 'create',
13
+ UPDATE = 'update',
14
+ DELETE = 'delete',
15
+ ACCESS = 'access',
16
+ }
@@ -0,0 +1,16 @@
1
+ /* generated using openapi-typescript-codegen -- do not edit */
2
+ /* istanbul ignore file */
3
+ /* tslint:disable */
4
+ /* eslint-disable */
5
+ /**
6
+ * * `persons` - Persons
7
+ * * `organizations` - Organizations
8
+ * * `deals` - Deals
9
+ * * `activities` - Activities
10
+ */
11
+ export enum ObjectTypeEnum {
12
+ PERSONS = 'persons',
13
+ ORGANIZATIONS = 'organizations',
14
+ DEALS = 'deals',
15
+ ACTIVITIES = 'activities',
16
+ }
@@ -0,0 +1,29 @@
1
+ /* generated using openapi-typescript-codegen -- do not edit */
2
+ /* istanbul ignore file */
3
+ /* tslint:disable */
4
+ /* eslint-disable */
5
+ import type { OverviewActivities } from './OverviewActivities';
6
+ import type { OverviewCount } from './OverviewCount';
7
+ import type { OverviewDeals } from './OverviewDeals';
8
+ /**
9
+ * Sections the caller may list; `period_*` only when a window resolved.
10
+ */
11
+ export type Overview = {
12
+ persons?: OverviewCount;
13
+ organizations?: OverviewCount;
14
+ deals?: OverviewDeals;
15
+ activities?: OverviewActivities;
16
+ period_start_date?: string;
17
+ period_end_date?: string;
18
+ period_persons_created?: number;
19
+ period_deals_created?: number;
20
+ period_deals_won?: number;
21
+ period_deals_won_value?: string;
22
+ period_deals_lost?: number;
23
+ period_deals_lost_value?: string;
24
+ /**
25
+ * Marked done in the window; the automatic stage-change notes are not counted.
26
+ */
27
+ period_activities_done?: number;
28
+ };
29
+
@@ -0,0 +1,10 @@
1
+ /* generated using openapi-typescript-codegen -- do not edit */
2
+ /* istanbul ignore file */
3
+ /* tslint:disable */
4
+ /* eslint-disable */
5
+ export type OverviewActivities = {
6
+ open_count: number;
7
+ due_today: number;
8
+ overdue: number;
9
+ };
10
+
@@ -0,0 +1,8 @@
1
+ /* generated using openapi-typescript-codegen -- do not edit */
2
+ /* istanbul ignore file */
3
+ /* tslint:disable */
4
+ /* eslint-disable */
5
+ export type OverviewCount = {
6
+ count: number;
7
+ };
8
+
@@ -0,0 +1,27 @@
1
+ /* generated using openapi-typescript-codegen -- do not edit */
2
+ /* istanbul ignore file */
3
+ /* tslint:disable */
4
+ /* eslint-disable */
5
+ import type { OverviewMonth } from './OverviewMonth';
6
+ import type { OverviewStage } from './OverviewStage';
7
+ import type { Pipeline } from './Pipeline';
8
+ export type OverviewDeals = {
9
+ /**
10
+ * The pipeline `by_stage` describes.
11
+ */
12
+ pipeline: Pipeline | null;
13
+ /**
14
+ * Most common currency among open deals; money fields sum every deal as if it were in this currency.
15
+ */
16
+ currency: string | null;
17
+ open_count: number;
18
+ pipeline_value: string;
19
+ weighted_value: string;
20
+ won_this_month_count: number;
21
+ won_this_month_value: string;
22
+ lost_this_month_count: number;
23
+ lost_this_month_value: string;
24
+ by_stage: Array<OverviewStage>;
25
+ won_lost_by_month: Array<OverviewMonth>;
26
+ };
27
+
@@ -0,0 +1,15 @@
1
+ /* generated using openapi-typescript-codegen -- do not edit */
2
+ /* istanbul ignore file */
3
+ /* tslint:disable */
4
+ /* eslint-disable */
5
+ export type OverviewMonth = {
6
+ /**
7
+ * `YYYY-MM`, UTC.
8
+ */
9
+ month: string;
10
+ won_count: number;
11
+ won_value: string;
12
+ lost_count: number;
13
+ lost_value: string;
14
+ };
15
+
@@ -0,0 +1,18 @@
1
+ /* generated using openapi-typescript-codegen -- do not edit */
2
+ /* istanbul ignore file */
3
+ /* tslint:disable */
4
+ /* eslint-disable */
5
+ import type { PipelineStage } from './PipelineStage';
6
+ export type OverviewStage = {
7
+ stage: PipelineStage;
8
+ /**
9
+ * Open deals in this stage.
10
+ */
11
+ count: number;
12
+ total_value: string;
13
+ /**
14
+ * Sum of `lead_value × stage.probability / 100`.
15
+ */
16
+ weighted_value: string;
17
+ };
18
+
@@ -0,0 +1,12 @@
1
+ /* generated using openapi-typescript-codegen -- do not edit */
2
+ /* istanbul ignore file */
3
+ /* tslint:disable */
4
+ /* eslint-disable */
5
+ import type { Favorite } from './Favorite';
6
+ export type PaginatedFavoriteList = {
7
+ count: number;
8
+ next?: string | null;
9
+ previous?: string | null;
10
+ results: Array<Favorite>;
11
+ };
12
+
@@ -0,0 +1,12 @@
1
+ /* generated using openapi-typescript-codegen -- do not edit */
2
+ /* istanbul ignore file */
3
+ /* tslint:disable */
4
+ /* eslint-disable */
5
+ import type { SavedView } from './SavedView';
6
+ export type PaginatedSavedViewList = {
7
+ count: number;
8
+ next?: string | null;
9
+ previous?: string | null;
10
+ results: Array<SavedView>;
11
+ };
12
+
@@ -53,13 +53,17 @@ export type PatchedActivity = {
53
53
  */
54
54
  readonly done_at?: string | null;
55
55
  /**
56
- * Id of the Deal this Activity is logged against. Either `deal` or `person` is required.
56
+ * Id of the Deal this Activity is logged against. One of `deal`, `person` or `organization` is required.
57
57
  */
58
58
  deal?: number | null;
59
59
  /**
60
- * UUID of the Person this Activity is logged against. Either `deal` or `person` is required.
60
+ * UUID of the Person this Activity is logged against. One of `deal`, `person` or `organization` is required.
61
61
  */
62
62
  person?: string | null;
63
+ /**
64
+ * UUID of the Organization this Activity is logged against.
65
+ */
66
+ organization?: string | null;
63
67
  /**
64
68
  * Id of the user who scheduled / logged this Activity. Defaults to the calling user on create.
65
69
  */
@@ -2,7 +2,7 @@
2
2
  /* istanbul ignore file */
3
3
  /* tslint:disable */
4
4
  /* eslint-disable */
5
- import type { DealStatusEnum } from './DealStatusEnum';
5
+ import type { Status05cEnum } from './Status05cEnum';
6
6
  /**
7
7
  * Adds a read-only ``tags`` field to a host serializer.
8
8
  *
@@ -42,7 +42,11 @@ export type PatchedDeal = {
42
42
  * * `won` - Won
43
43
  * * `lost` - Lost
44
44
  */
45
- readonly status?: DealStatusEnum;
45
+ readonly status?: Status05cEnum;
46
+ /**
47
+ * Open and untouched for longer than the pipeline's `rotten_days`.
48
+ */
49
+ readonly is_stale?: boolean;
46
50
  /**
47
51
  * Set on a `lost` transition (e.g. 'Chose competitor').
48
52
  */
@@ -59,10 +63,18 @@ export type PatchedDeal = {
59
63
  * UUID of the primary contact for this Deal. The person must belong to your Platform.
60
64
  */
61
65
  person?: string;
66
+ /**
67
+ * The person's name.
68
+ */
69
+ readonly person_name?: string;
62
70
  /**
63
71
  * UUID of an organization the Deal is with. Optional; must belong to your Platform.
64
72
  */
65
73
  organization?: string | null;
74
+ /**
75
+ * The organization's name, or null.
76
+ */
77
+ readonly organization_name?: string | null;
66
78
  /**
67
79
  * Pipeline this Deal flows through. Must belong to your Platform.
68
80
  */
@@ -43,6 +43,10 @@ export type PatchedPerson = {
43
43
  * UUID of an organization in your Platform. References to organizations in other Platforms are rejected.
44
44
  */
45
45
  organization?: string | null;
46
+ /**
47
+ * The organization's name, or null.
48
+ */
49
+ readonly organization_name?: string | null;
46
50
  /**
47
51
  * Id of the platform user who owns / manages this person (internal account manager). Optional.
48
52
  */
@@ -25,7 +25,7 @@ export type PatchedPipeline = {
25
25
  */
26
26
  is_default?: boolean;
27
27
  /**
28
- * Days a Deal can sit in a stage before it's surfaced as stale.
28
+ * Days without a change before an open Deal shows `is_stale`; 0 turns it off.
29
29
  */
30
30
  rotten_days?: number;
31
31
  readonly stages?: Array<PipelineStage>;
@@ -0,0 +1,46 @@
1
+ /* generated using openapi-typescript-codegen -- do not edit */
2
+ /* istanbul ignore file */
3
+ /* tslint:disable */
4
+ /* eslint-disable */
5
+ import type { _Column } from './_Column';
6
+ import type { _Filter } from './_Filter';
7
+ import type { _Sort } from './_Sort';
8
+ import type { ObjectTypeEnum } from './ObjectTypeEnum';
9
+ import type { SavedViewTypeEnum } from './SavedViewTypeEnum';
10
+ export type PatchedSavedView = {
11
+ readonly id?: number;
12
+ /**
13
+ * Tenant this view belongs to.
14
+ */
15
+ readonly platform?: number;
16
+ /**
17
+ * The list this view belongs to.
18
+ *
19
+ * * `persons` - Persons
20
+ * * `organizations` - Organizations
21
+ * * `deals` - Deals
22
+ * * `activities` - Activities
23
+ */
24
+ object_type?: ObjectTypeEnum;
25
+ /**
26
+ * Unique per user and list.
27
+ */
28
+ name?: string;
29
+ /**
30
+ * `kanban` is available for deals only.
31
+ *
32
+ * * `table` - Table
33
+ * * `kanban` - Kanban
34
+ */
35
+ type?: SavedViewTypeEnum;
36
+ columns?: Array<_Column>;
37
+ filters?: Array<_Filter>;
38
+ sorts?: Array<_Sort>;
39
+ /**
40
+ * Kanban column field (e.g. `stage`).
41
+ */
42
+ group_by?: string;
43
+ readonly created_at?: string;
44
+ readonly updated_at?: string;
45
+ };
46
+
@@ -43,6 +43,10 @@ export type Person = {
43
43
  * UUID of an organization in your Platform. References to organizations in other Platforms are rejected.
44
44
  */
45
45
  organization?: string | null;
46
+ /**
47
+ * The organization's name, or null.
48
+ */
49
+ readonly organization_name: string | null;
46
50
  /**
47
51
  * Id of the platform user who owns / manages this person (internal account manager). Optional.
48
52
  */
@@ -25,7 +25,7 @@ export type Pipeline = {
25
25
  */
26
26
  is_default?: boolean;
27
27
  /**
28
- * Days a Deal can sit in a stage before it's surfaced as stale.
28
+ * Days without a change before an open Deal shows `is_stale`; 0 turns it off.
29
29
  */
30
30
  rotten_days?: number;
31
31
  readonly stages: Array<PipelineStage>;
@@ -0,0 +1,11 @@
1
+ /* generated using openapi-typescript-codegen -- do not edit */
2
+ /* istanbul ignore file */
3
+ /* tslint:disable */
4
+ /* eslint-disable */
5
+ export type PipelineStageReorderRequest = {
6
+ /**
7
+ * Every stage id of the Pipeline, in the new left-to-right order.
8
+ */
9
+ order: Array<number>;
10
+ };
11
+