@iblai/iblai-api 4.265.1-core → 4.265.2-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 +2168 -258
- package/dist/index.cjs.js.map +1 -1
- package/dist/index.esm.js +2165 -259
- package/dist/index.esm.js.map +1 -1
- package/dist/index.umd.js +2168 -258
- package/dist/index.umd.js.map +1 -1
- package/dist/types/index.d.ts +26 -1
- package/dist/types/models/Activity.d.ts +83 -0
- package/dist/types/models/ActivityTypeEnum.d.ts +18 -0
- package/dist/types/models/Deal.d.ts +83 -0
- package/dist/types/models/DealLostRequest.d.ts +10 -0
- package/dist/types/models/DealMoveStageRequest.d.ts +10 -0
- package/dist/types/models/DealStatusEnum.d.ts +10 -0
- package/dist/types/models/DealWonRequest.d.ts +6 -0
- package/dist/types/models/LeadSource.d.ts +30 -0
- package/dist/types/models/NotificationTemplateDetail.d.ts +24 -2
- package/dist/types/models/NotificationTemplateList.d.ts +5 -2
- package/dist/types/models/Organization.d.ts +1 -1
- package/dist/types/models/PaginatedActivityList.d.ts +7 -0
- package/dist/types/models/PaginatedDealList.d.ts +7 -0
- package/dist/types/models/PaginatedLeadSourceList.d.ts +7 -0
- package/dist/types/models/PaginatedPipelineList.d.ts +7 -0
- package/dist/types/models/PaginatedPipelineStageList.d.ts +7 -0
- package/dist/types/models/PatchedActivity.d.ts +83 -0
- package/dist/types/models/PatchedDeal.d.ts +83 -0
- package/dist/types/models/PatchedLeadSource.d.ts +30 -0
- package/dist/types/models/PatchedNotificationTemplateDetail.d.ts +24 -2
- package/dist/types/models/PatchedOrganization.d.ts +1 -1
- package/dist/types/models/PatchedPipeline.d.ts +34 -0
- package/dist/types/models/PatchedPipelineStage.d.ts +40 -0
- package/dist/types/models/Pipeline.d.ts +34 -0
- package/dist/types/models/PipelineStage.d.ts +40 -0
- package/dist/types/models/RecipientsRecipientModeEnum.d.ts +14 -0
- package/dist/types/models/{TypeD36Enum.d.ts → Type4b7Enum.d.ts} +7 -1
- package/dist/types/services/ActivitiesService.d.ts +126 -0
- package/dist/types/services/CrmService.d.ts +553 -1
- package/dist/types/services/DealsService.d.ts +160 -0
- package/dist/types/services/LeadSourcesService.d.ts +95 -0
- package/dist/types/services/PersonsService.d.ts +1 -1
- package/dist/types/services/PipelinesService.d.ts +183 -0
- package/package.json +1 -1
- package/sdk_schema.yml +4093 -141
- package/src/core/OpenAPI.ts +1 -1
- package/src/index.ts +26 -1
- package/src/models/Activity.ts +88 -0
- package/src/models/ActivityTypeEnum.ts +22 -0
- package/src/models/Deal.ts +88 -0
- package/src/models/DealLostRequest.ts +15 -0
- package/src/models/DealMoveStageRequest.ts +15 -0
- package/src/models/DealStatusEnum.ts +14 -0
- package/src/models/DealWonRequest.ts +11 -0
- package/src/models/LeadSource.ts +35 -0
- package/src/models/NotificationTemplateDetail.ts +24 -2
- package/src/models/NotificationTemplateList.ts +5 -2
- package/src/models/Organization.ts +1 -1
- package/src/models/PaginatedActivityList.ts +12 -0
- package/src/models/PaginatedDealList.ts +12 -0
- package/src/models/PaginatedLeadSourceList.ts +12 -0
- package/src/models/PaginatedPipelineList.ts +12 -0
- package/src/models/PaginatedPipelineStageList.ts +12 -0
- package/src/models/PatchedActivity.ts +88 -0
- package/src/models/PatchedDeal.ts +88 -0
- package/src/models/PatchedLeadSource.ts +35 -0
- package/src/models/PatchedNotificationTemplateDetail.ts +24 -2
- package/src/models/PatchedOrganization.ts +1 -1
- package/src/models/PatchedPipeline.ts +39 -0
- package/src/models/PatchedPipelineStage.ts +45 -0
- package/src/models/Pipeline.ts +39 -0
- package/src/models/PipelineStage.ts +45 -0
- package/src/models/RecipientsRecipientModeEnum.ts +18 -0
- package/src/models/{TypeD36Enum.ts → Type4b7Enum.ts} +7 -1
- package/src/services/ActivitiesService.ts +255 -0
- package/src/services/CrmService.ts +1161 -1
- package/src/services/DealsService.ts +337 -0
- package/src/services/LeadSourcesService.ts +198 -0
- package/src/services/PersonsService.ts +1 -1
- package/src/services/PipelinesService.ts +406 -0
package/src/core/OpenAPI.ts
CHANGED
package/src/index.ts
CHANGED
|
@@ -13,9 +13,11 @@ export type { ActiveUsersData } from './models/ActiveUsersData';
|
|
|
13
13
|
export type { ActiveUsersList } from './models/ActiveUsersList';
|
|
14
14
|
export type { ActiveUsersPerCourse } from './models/ActiveUsersPerCourse';
|
|
15
15
|
export type { ActiveUsersPerCourseData } from './models/ActiveUsersPerCourseData';
|
|
16
|
+
export type { Activity } from './models/Activity';
|
|
16
17
|
export type { ActivityAPI } from './models/ActivityAPI';
|
|
17
18
|
export type { ActivityData } from './models/ActivityData';
|
|
18
19
|
export type { ActivityInfo } from './models/ActivityInfo';
|
|
20
|
+
export { ActivityTypeEnum } from './models/ActivityTypeEnum';
|
|
19
21
|
export type { App } from './models/App';
|
|
20
22
|
export type { AppleSubscriptionStatusRequest } from './models/AppleSubscriptionStatusRequest';
|
|
21
23
|
export type { AppleSubscriptionStatusView } from './models/AppleSubscriptionStatusView';
|
|
@@ -131,6 +133,11 @@ export type { CreditAccountAutoRechargeUpdate } from './models/CreditAccountAuto
|
|
|
131
133
|
export type { CreditAccountInfo } from './models/CreditAccountInfo';
|
|
132
134
|
export type { CreditTransactionHistory } from './models/CreditTransactionHistory';
|
|
133
135
|
export { CreditTransactionHistoryStatusEnum } from './models/CreditTransactionHistoryStatusEnum';
|
|
136
|
+
export type { Deal } from './models/Deal';
|
|
137
|
+
export type { DealLostRequest } from './models/DealLostRequest';
|
|
138
|
+
export type { DealMoveStageRequest } from './models/DealMoveStageRequest';
|
|
139
|
+
export { DealStatusEnum } from './models/DealStatusEnum';
|
|
140
|
+
export type { DealWonRequest } from './models/DealWonRequest';
|
|
134
141
|
export type { DemographicsFieldDefinition } from './models/DemographicsFieldDefinition';
|
|
135
142
|
export type { DemographicsFieldDefinitionWrite } from './models/DemographicsFieldDefinitionWrite';
|
|
136
143
|
export type { DesiredRole } from './models/DesiredRole';
|
|
@@ -188,6 +195,7 @@ export type { ItemSubscriptionList } from './models/ItemSubscriptionList';
|
|
|
188
195
|
export type { ItemTypeCommission } from './models/ItemTypeCommission';
|
|
189
196
|
export { ItemTypeEnum } from './models/ItemTypeEnum';
|
|
190
197
|
export type { LauncherViewPostRequest } from './models/LauncherViewPostRequest';
|
|
198
|
+
export type { LeadSource } from './models/LeadSource';
|
|
191
199
|
export type { LearnerAnalyticsResponse } from './models/LearnerAnalyticsResponse';
|
|
192
200
|
export type { LearnerAnalyticsResult } from './models/LearnerAnalyticsResult';
|
|
193
201
|
export type { LearnerData } from './models/LearnerData';
|
|
@@ -239,6 +247,7 @@ export type { OvertimeDataPoint } from './models/OvertimeDataPoint';
|
|
|
239
247
|
export type { OvertimeMeta } from './models/OvertimeMeta';
|
|
240
248
|
export type { OvertimeWithChangeInfo } from './models/OvertimeWithChangeInfo';
|
|
241
249
|
export type { OverTimeWithTotal } from './models/OverTimeWithTotal';
|
|
250
|
+
export type { PaginatedActivityList } from './models/PaginatedActivityList';
|
|
242
251
|
export type { PaginatedAssertionsResponse } from './models/PaginatedAssertionsResponse';
|
|
243
252
|
export type { PaginatedCourseAccessRequest } from './models/PaginatedCourseAccessRequest';
|
|
244
253
|
export type { PaginatedCourseGroupSuggestion } from './models/PaginatedCourseGroupSuggestion';
|
|
@@ -247,13 +256,17 @@ export type { PaginatedCourseLicense } from './models/PaginatedCourseLicense';
|
|
|
247
256
|
export type { PaginatedCourseLicenseAssignment } from './models/PaginatedCourseLicenseAssignment';
|
|
248
257
|
export type { PaginatedCourseLicenseGroupAssignment } from './models/PaginatedCourseLicenseGroupAssignment';
|
|
249
258
|
export type { PaginatedCourseSuggestion } from './models/PaginatedCourseSuggestion';
|
|
259
|
+
export type { PaginatedDealList } from './models/PaginatedDealList';
|
|
250
260
|
export type { PaginatedItemPaywallConfigList } from './models/PaginatedItemPaywallConfigList';
|
|
251
261
|
export type { PaginatedItemSubscriptionList } from './models/PaginatedItemSubscriptionList';
|
|
252
262
|
export type { PaginatedItemSubscriptionListList } from './models/PaginatedItemSubscriptionListList';
|
|
263
|
+
export type { PaginatedLeadSourceList } from './models/PaginatedLeadSourceList';
|
|
253
264
|
export type { PaginatedOrganizationList } from './models/PaginatedOrganizationList';
|
|
254
265
|
export type { PaginatedPathwayGroupSuggestion } from './models/PaginatedPathwayGroupSuggestion';
|
|
255
266
|
export type { PaginatedPathwaySuggestion } from './models/PaginatedPathwaySuggestion';
|
|
256
267
|
export type { PaginatedPersonList } from './models/PaginatedPersonList';
|
|
268
|
+
export type { PaginatedPipelineList } from './models/PaginatedPipelineList';
|
|
269
|
+
export type { PaginatedPipelineStageList } from './models/PaginatedPipelineStageList';
|
|
257
270
|
export type { PaginatedPlatformInvitation } from './models/PaginatedPlatformInvitation';
|
|
258
271
|
export type { PaginatedPlatformLicense } from './models/PaginatedPlatformLicense';
|
|
259
272
|
export type { PaginatedProgramGroupSuggestion } from './models/PaginatedProgramGroupSuggestion';
|
|
@@ -276,8 +289,11 @@ export type { PaginatedWatchedGroupListList } from './models/PaginatedWatchedGro
|
|
|
276
289
|
export type { PaginatedWatchedUserReadList } from './models/PaginatedWatchedUserReadList';
|
|
277
290
|
export type { PaginatedWatcherReadList } from './models/PaginatedWatcherReadList';
|
|
278
291
|
export type { Pagination } from './models/Pagination';
|
|
292
|
+
export type { PatchedActivity } from './models/PatchedActivity';
|
|
279
293
|
export type { PatchedCreditAccountAutoRechargeUpdate } from './models/PatchedCreditAccountAutoRechargeUpdate';
|
|
294
|
+
export type { PatchedDeal } from './models/PatchedDeal';
|
|
280
295
|
export type { PatchedDemographicsFieldDefinitionWrite } from './models/PatchedDemographicsFieldDefinitionWrite';
|
|
296
|
+
export type { PatchedLeadSource } from './models/PatchedLeadSource';
|
|
281
297
|
export type { PatchedMediaResource } from './models/PatchedMediaResource';
|
|
282
298
|
export type { PatchedNotification } from './models/PatchedNotification';
|
|
283
299
|
export type { PatchedNotificationTemplateDetail } from './models/PatchedNotificationTemplateDetail';
|
|
@@ -285,6 +301,8 @@ export type { PatchedNotificationToggle } from './models/PatchedNotificationTogg
|
|
|
285
301
|
export type { PatchedNotificationTypePreference } from './models/PatchedNotificationTypePreference';
|
|
286
302
|
export type { PatchedOrganization } from './models/PatchedOrganization';
|
|
287
303
|
export type { PatchedPerson } from './models/PatchedPerson';
|
|
304
|
+
export type { PatchedPipeline } from './models/PatchedPipeline';
|
|
305
|
+
export type { PatchedPipelineStage } from './models/PatchedPipelineStage';
|
|
288
306
|
export type { PatchedPlatformPublicImageAsset } from './models/PatchedPlatformPublicImageAsset';
|
|
289
307
|
export type { PatchedPlatformPublicMetadata } from './models/PatchedPlatformPublicMetadata';
|
|
290
308
|
export type { PatchedRbacGroup } from './models/PatchedRbacGroup';
|
|
@@ -344,6 +362,8 @@ export type { PersonInviteResponse } from './models/PersonInviteResponse';
|
|
|
344
362
|
export type { PersonLinkUserRequest } from './models/PersonLinkUserRequest';
|
|
345
363
|
export type { PersonMergeRequest } from './models/PersonMergeRequest';
|
|
346
364
|
export type { PersonMergeResponse } from './models/PersonMergeResponse';
|
|
365
|
+
export type { Pipeline } from './models/Pipeline';
|
|
366
|
+
export type { PipelineStage } from './models/PipelineStage';
|
|
347
367
|
export type { Platform } from './models/Platform';
|
|
348
368
|
export type { PlatformApiKey } from './models/PlatformApiKey';
|
|
349
369
|
export type { PlatformConfigurationList } from './models/PlatformConfigurationList';
|
|
@@ -418,6 +438,7 @@ export type { RbacPolicyGroup } from './models/RbacPolicyGroup';
|
|
|
418
438
|
export type { RbacRole } from './models/RbacRole';
|
|
419
439
|
export type { RbacUser } from './models/RbacUser';
|
|
420
440
|
export type { Recipient } from './models/Recipient';
|
|
441
|
+
export { RecipientsRecipientModeEnum } from './models/RecipientsRecipientModeEnum';
|
|
421
442
|
export type { RecommendationSearchAPI } from './models/RecommendationSearchAPI';
|
|
422
443
|
export type { RedirectTokenRequest } from './models/RedirectTokenRequest';
|
|
423
444
|
export type { RedirectTokenResponse } from './models/RedirectTokenResponse';
|
|
@@ -507,7 +528,7 @@ export type { TokenProxyOutputSerializerData } from './models/TokenProxyOutputSe
|
|
|
507
528
|
export type { TokenProxyUser } from './models/TokenProxyUser';
|
|
508
529
|
export type { TopContent } from './models/TopContent';
|
|
509
530
|
export { TransactionTypeEnum } from './models/TransactionTypeEnum';
|
|
510
|
-
export {
|
|
531
|
+
export { Type4b7Enum } from './models/Type4b7Enum';
|
|
511
532
|
export type { UploadedImage } from './models/UploadedImage';
|
|
512
533
|
export type { UserApp } from './models/UserApp';
|
|
513
534
|
export type { UserDeleteAPIError } from './models/UserDeleteAPIError';
|
|
@@ -583,6 +604,7 @@ export type { WhitelistedDomain } from './models/WhitelistedDomain';
|
|
|
583
604
|
|
|
584
605
|
export { AccessCheckService } from './services/AccessCheckService';
|
|
585
606
|
export { AccountService } from './services/AccountService';
|
|
607
|
+
export { ActivitiesService } from './services/ActivitiesService';
|
|
586
608
|
export { AiAnalyticsService } from './services/AiAnalyticsService';
|
|
587
609
|
export { AnalyticsService } from './services/AnalyticsService';
|
|
588
610
|
export { AutoRechargeService } from './services/AutoRechargeService';
|
|
@@ -595,12 +617,15 @@ export { CredentialsService } from './services/CredentialsService';
|
|
|
595
617
|
export { CreditsService } from './services/CreditsService';
|
|
596
618
|
export { CrmService } from './services/CrmService';
|
|
597
619
|
export { CustomDomainsService } from './services/CustomDomainsService';
|
|
620
|
+
export { DealsService } from './services/DealsService';
|
|
598
621
|
export { FeaturesService } from './services/FeaturesService';
|
|
599
622
|
export { ItemsService } from './services/ItemsService';
|
|
623
|
+
export { LeadSourcesService } from './services/LeadSourcesService';
|
|
600
624
|
export { MediaService } from './services/MediaService';
|
|
601
625
|
export { NotificationsService } from './services/NotificationsService';
|
|
602
626
|
export { OrganizationsService } from './services/OrganizationsService';
|
|
603
627
|
export { PersonsService } from './services/PersonsService';
|
|
628
|
+
export { PipelinesService } from './services/PipelinesService';
|
|
604
629
|
export { PlatformsService } from './services/PlatformsService';
|
|
605
630
|
export { PricesService } from './services/PricesService';
|
|
606
631
|
export { RecommendationsService } from './services/RecommendationsService';
|
|
@@ -0,0 +1,88 @@
|
|
|
1
|
+
/* generated using openapi-typescript-codegen -- do not edit */
|
|
2
|
+
/* istanbul ignore file */
|
|
3
|
+
/* tslint:disable */
|
|
4
|
+
/* eslint-disable */
|
|
5
|
+
import type { ActivityTypeEnum } from './ActivityTypeEnum';
|
|
6
|
+
export type Activity = {
|
|
7
|
+
/**
|
|
8
|
+
* Server-assigned id.
|
|
9
|
+
*/
|
|
10
|
+
readonly id: number;
|
|
11
|
+
/**
|
|
12
|
+
* Platform this Activity belongs to. Set automatically from your credentials; you cannot pass another Platform's id.
|
|
13
|
+
*/
|
|
14
|
+
readonly platform: number;
|
|
15
|
+
/**
|
|
16
|
+
* Short summary (e.g. 'Discovery call', 'Stage changed').
|
|
17
|
+
*/
|
|
18
|
+
title: string;
|
|
19
|
+
/**
|
|
20
|
+
* Interaction kind. One of `call`, `meeting`, `email`, `note`, `task`, `lunch`, `deadline`.
|
|
21
|
+
*
|
|
22
|
+
* * `call` - Call
|
|
23
|
+
* * `meeting` - Meeting
|
|
24
|
+
* * `email` - Email
|
|
25
|
+
* * `note` - Note
|
|
26
|
+
* * `task` - Task
|
|
27
|
+
* * `lunch` - Lunch
|
|
28
|
+
* * `deadline` - Deadline
|
|
29
|
+
*/
|
|
30
|
+
type: ActivityTypeEnum;
|
|
31
|
+
/**
|
|
32
|
+
* Meeting location / call dial-in / venue.
|
|
33
|
+
*/
|
|
34
|
+
location?: string;
|
|
35
|
+
/**
|
|
36
|
+
* Free-text notes.
|
|
37
|
+
*/
|
|
38
|
+
comment?: string;
|
|
39
|
+
/**
|
|
40
|
+
* Scheduled start. Leave null for instant log entries.
|
|
41
|
+
*/
|
|
42
|
+
schedule_from?: string | null;
|
|
43
|
+
/**
|
|
44
|
+
* Scheduled end.
|
|
45
|
+
*/
|
|
46
|
+
schedule_to?: string | null;
|
|
47
|
+
/**
|
|
48
|
+
* Mark the Activity complete. Use `POST /activities/{id}/done/` to flip this and automatically stamp `done_at`.
|
|
49
|
+
*/
|
|
50
|
+
is_done?: boolean;
|
|
51
|
+
/**
|
|
52
|
+
* Read-only. Set automatically the first time `is_done` flips True.
|
|
53
|
+
*/
|
|
54
|
+
readonly done_at: string | null;
|
|
55
|
+
/**
|
|
56
|
+
* Id of the Deal this Activity is logged against. Either `deal` or `person` is required.
|
|
57
|
+
*/
|
|
58
|
+
deal?: number | null;
|
|
59
|
+
/**
|
|
60
|
+
* UUID of the Person this Activity is logged against. Either `deal` or `person` is required.
|
|
61
|
+
*/
|
|
62
|
+
person?: string | null;
|
|
63
|
+
/**
|
|
64
|
+
* Id of the user who scheduled / logged this Activity. Defaults to the calling user on create.
|
|
65
|
+
*/
|
|
66
|
+
owner?: number | null;
|
|
67
|
+
/**
|
|
68
|
+
* When to remind the owner.
|
|
69
|
+
*/
|
|
70
|
+
reminder_at?: string | null;
|
|
71
|
+
/**
|
|
72
|
+
* Marks that a reminder has been sent for this Activity; prevents the same reminder from firing twice.
|
|
73
|
+
*/
|
|
74
|
+
readonly reminder_sent: boolean;
|
|
75
|
+
/**
|
|
76
|
+
* Free-form JSON for Platform-defined attributes.
|
|
77
|
+
*/
|
|
78
|
+
metadata?: any;
|
|
79
|
+
/**
|
|
80
|
+
* Creation timestamp.
|
|
81
|
+
*/
|
|
82
|
+
readonly created_at: string;
|
|
83
|
+
/**
|
|
84
|
+
* Last-modified timestamp.
|
|
85
|
+
*/
|
|
86
|
+
readonly updated_at: string;
|
|
87
|
+
};
|
|
88
|
+
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
/* generated using openapi-typescript-codegen -- do not edit */
|
|
2
|
+
/* istanbul ignore file */
|
|
3
|
+
/* tslint:disable */
|
|
4
|
+
/* eslint-disable */
|
|
5
|
+
/**
|
|
6
|
+
* * `call` - Call
|
|
7
|
+
* * `meeting` - Meeting
|
|
8
|
+
* * `email` - Email
|
|
9
|
+
* * `note` - Note
|
|
10
|
+
* * `task` - Task
|
|
11
|
+
* * `lunch` - Lunch
|
|
12
|
+
* * `deadline` - Deadline
|
|
13
|
+
*/
|
|
14
|
+
export enum ActivityTypeEnum {
|
|
15
|
+
CALL = 'call',
|
|
16
|
+
MEETING = 'meeting',
|
|
17
|
+
EMAIL = 'email',
|
|
18
|
+
NOTE = 'note',
|
|
19
|
+
TASK = 'task',
|
|
20
|
+
LUNCH = 'lunch',
|
|
21
|
+
DEADLINE = 'deadline',
|
|
22
|
+
}
|
|
@@ -0,0 +1,88 @@
|
|
|
1
|
+
/* generated using openapi-typescript-codegen -- do not edit */
|
|
2
|
+
/* istanbul ignore file */
|
|
3
|
+
/* tslint:disable */
|
|
4
|
+
/* eslint-disable */
|
|
5
|
+
import type { DealStatusEnum } from './DealStatusEnum';
|
|
6
|
+
export type Deal = {
|
|
7
|
+
/**
|
|
8
|
+
* Server-assigned id.
|
|
9
|
+
*/
|
|
10
|
+
readonly id: number;
|
|
11
|
+
/**
|
|
12
|
+
* Platform this Deal belongs to. Set automatically from your credentials; you cannot pass another Platform's id.
|
|
13
|
+
*/
|
|
14
|
+
readonly platform: number;
|
|
15
|
+
/**
|
|
16
|
+
* Short display name (e.g. 'Acme renewal — 2026').
|
|
17
|
+
*/
|
|
18
|
+
title: string;
|
|
19
|
+
/**
|
|
20
|
+
* Free-text notes about scope, requirements, etc.
|
|
21
|
+
*/
|
|
22
|
+
description?: string;
|
|
23
|
+
/**
|
|
24
|
+
* Estimated deal value in `currency`.
|
|
25
|
+
*/
|
|
26
|
+
lead_value?: string;
|
|
27
|
+
/**
|
|
28
|
+
* ISO 4217 currency code.
|
|
29
|
+
*/
|
|
30
|
+
currency?: string;
|
|
31
|
+
/**
|
|
32
|
+
* Read-only. Set by the move-stage/won/lost actions and derived from the destination stage's `is_won`/`is_lost`. Direct writes are rejected with `400`; use `POST /deals/{id}/move-stage/` (or `won/` / `lost/`).
|
|
33
|
+
*
|
|
34
|
+
* * `open` - Open
|
|
35
|
+
* * `won` - Won
|
|
36
|
+
* * `lost` - Lost
|
|
37
|
+
*/
|
|
38
|
+
readonly status: DealStatusEnum;
|
|
39
|
+
/**
|
|
40
|
+
* Set on a `lost` transition (e.g. 'Chose competitor').
|
|
41
|
+
*/
|
|
42
|
+
lost_reason?: string;
|
|
43
|
+
/**
|
|
44
|
+
* Forecasted close date — used by revenue projections.
|
|
45
|
+
*/
|
|
46
|
+
expected_close_date?: string | null;
|
|
47
|
+
/**
|
|
48
|
+
* Read-only. Set automatically when the Deal enters a won/lost stage and cleared when it re-opens.
|
|
49
|
+
*/
|
|
50
|
+
readonly closed_at: string | null;
|
|
51
|
+
/**
|
|
52
|
+
* UUID of the primary contact for this Deal. The person must belong to your Platform.
|
|
53
|
+
*/
|
|
54
|
+
person: string;
|
|
55
|
+
/**
|
|
56
|
+
* UUID of an organization the Deal is with. Optional; must belong to your Platform.
|
|
57
|
+
*/
|
|
58
|
+
organization?: string | null;
|
|
59
|
+
/**
|
|
60
|
+
* Pipeline this Deal flows through. Must belong to your Platform.
|
|
61
|
+
*/
|
|
62
|
+
pipeline: number;
|
|
63
|
+
/**
|
|
64
|
+
* Current PipelineStage. On create, must belong to `pipeline`. Use `POST /deals/{id}/move-stage/` to change after creation.
|
|
65
|
+
*/
|
|
66
|
+
stage: number;
|
|
67
|
+
/**
|
|
68
|
+
* Where the Deal originated. Optional; must belong to your Platform.
|
|
69
|
+
*/
|
|
70
|
+
source?: number | null;
|
|
71
|
+
/**
|
|
72
|
+
* Id of the platform user responsible for this Deal (sales rep). Defaults to the calling user on create.
|
|
73
|
+
*/
|
|
74
|
+
owner?: number | null;
|
|
75
|
+
/**
|
|
76
|
+
* Free-form JSON for Platform-defined attributes.
|
|
77
|
+
*/
|
|
78
|
+
metadata?: any;
|
|
79
|
+
/**
|
|
80
|
+
* Creation timestamp.
|
|
81
|
+
*/
|
|
82
|
+
readonly created_at: string;
|
|
83
|
+
/**
|
|
84
|
+
* Last-modified timestamp.
|
|
85
|
+
*/
|
|
86
|
+
readonly updated_at: string;
|
|
87
|
+
};
|
|
88
|
+
|
|
@@ -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 DealLostRequest = {
|
|
6
|
+
/**
|
|
7
|
+
* Free-text reason persisted on `Deal.lost_reason`.
|
|
8
|
+
*/
|
|
9
|
+
lost_reason: string;
|
|
10
|
+
/**
|
|
11
|
+
* Optional `code` of a specific `is_lost=True` stage to move to. When omitted, the first lost stage in the pipeline (by sort order) is used.
|
|
12
|
+
*/
|
|
13
|
+
stage_code?: string;
|
|
14
|
+
};
|
|
15
|
+
|
|
@@ -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 DealMoveStageRequest = {
|
|
6
|
+
/**
|
|
7
|
+
* Id of the destination PipelineStage. One of `stage_id` or `stage_code` is required.
|
|
8
|
+
*/
|
|
9
|
+
stage_id?: number;
|
|
10
|
+
/**
|
|
11
|
+
* Stable `code` of the destination PipelineStage within this Deal's Pipeline. Use this when integrating across environments where ids differ but codes are stable.
|
|
12
|
+
*/
|
|
13
|
+
stage_code?: string;
|
|
14
|
+
};
|
|
15
|
+
|
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
/* generated using openapi-typescript-codegen -- do not edit */
|
|
2
|
+
/* istanbul ignore file */
|
|
3
|
+
/* tslint:disable */
|
|
4
|
+
/* eslint-disable */
|
|
5
|
+
/**
|
|
6
|
+
* * `open` - Open
|
|
7
|
+
* * `won` - Won
|
|
8
|
+
* * `lost` - Lost
|
|
9
|
+
*/
|
|
10
|
+
export enum DealStatusEnum {
|
|
11
|
+
OPEN = 'open',
|
|
12
|
+
WON = 'won',
|
|
13
|
+
LOST = 'lost',
|
|
14
|
+
}
|
|
@@ -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 DealWonRequest = {
|
|
6
|
+
/**
|
|
7
|
+
* Optional `code` of a specific `is_won=True` stage to move to. When omitted, the first won stage in the pipeline (by sort order) is used.
|
|
8
|
+
*/
|
|
9
|
+
stage_code?: string;
|
|
10
|
+
};
|
|
11
|
+
|
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
/* generated using openapi-typescript-codegen -- do not edit */
|
|
2
|
+
/* istanbul ignore file */
|
|
3
|
+
/* tslint:disable */
|
|
4
|
+
/* eslint-disable */
|
|
5
|
+
export type LeadSource = {
|
|
6
|
+
/**
|
|
7
|
+
* Server-assigned id. Stable across renames.
|
|
8
|
+
*/
|
|
9
|
+
readonly id: number;
|
|
10
|
+
/**
|
|
11
|
+
* Platform the LeadSource belongs to. Set automatically from your credentials; you cannot pass another Platform's id.
|
|
12
|
+
*/
|
|
13
|
+
readonly platform: number;
|
|
14
|
+
/**
|
|
15
|
+
* Display name shown to sales reps when categorizing a Deal.
|
|
16
|
+
*/
|
|
17
|
+
name: string;
|
|
18
|
+
/**
|
|
19
|
+
* Stable slug used in API payloads and reports. Unique per Platform; lowercase letters, digits, and hyphens.
|
|
20
|
+
*/
|
|
21
|
+
code: string;
|
|
22
|
+
/**
|
|
23
|
+
* Free-form JSON for Platform-defined attributes.
|
|
24
|
+
*/
|
|
25
|
+
metadata?: any;
|
|
26
|
+
/**
|
|
27
|
+
* Creation timestamp.
|
|
28
|
+
*/
|
|
29
|
+
readonly created_at: string;
|
|
30
|
+
/**
|
|
31
|
+
* Last-modified timestamp.
|
|
32
|
+
*/
|
|
33
|
+
readonly updated_at: string;
|
|
34
|
+
};
|
|
35
|
+
|
|
@@ -9,8 +9,9 @@ import type { HumanSupportRecipientModeEnum } from './HumanSupportRecipientModeE
|
|
|
9
9
|
import type { NullEnum } from './NullEnum';
|
|
10
10
|
import type { PeriodicFrequencyEnum } from './PeriodicFrequencyEnum';
|
|
11
11
|
import type { PeriodicLearnerScopeEnum } from './PeriodicLearnerScopeEnum';
|
|
12
|
+
import type { RecipientsRecipientModeEnum } from './RecipientsRecipientModeEnum';
|
|
12
13
|
import type { Spa } from './Spa';
|
|
13
|
-
import type {
|
|
14
|
+
import type { Type4b7Enum } from './Type4b7Enum';
|
|
14
15
|
/**
|
|
15
16
|
* Serializer for detailed template view and editing
|
|
16
17
|
*/
|
|
@@ -31,6 +32,9 @@ export type NotificationTemplateDetail = {
|
|
|
31
32
|
* * `COURSE_LICENSE_GROUP_ASSIGNMENT` - Course License Group Assignment
|
|
32
33
|
* * `COURSE_SCHEDULE_CHANGE` - Course Schedule Change
|
|
33
34
|
* * `COURSES_PROGRESS_SUMMARY` - Courses Progress Summary
|
|
35
|
+
* * `CRM_DEAL_STAGE_CHANGED` - Crm Deal Stage Changed
|
|
36
|
+
* * `CRM_PERSON_CREATED` - Crm Person Created
|
|
37
|
+
* * `CRM_PERSON_LINKED_TO_USER` - Crm Person Linked To User
|
|
34
38
|
* * `CUSTOM_NOTIFICATION` - Custom Notification
|
|
35
39
|
* * `DEFAULT_TEMPLATE` - Default Template
|
|
36
40
|
* * `HUMAN_SUPPORT_NOTIFICATION` - Human Support Notification
|
|
@@ -55,7 +59,7 @@ export type NotificationTemplateDetail = {
|
|
|
55
59
|
* * `USER_NOTIF_USER_INACTIVITY` - User Notif User Inactivity
|
|
56
60
|
* * `USER_NOTIF_USER_REGISTRATION` - User Notif User Registration
|
|
57
61
|
*/
|
|
58
|
-
readonly type: (
|
|
62
|
+
readonly type: (Type4b7Enum | NullEnum) | null;
|
|
59
63
|
/**
|
|
60
64
|
* Template display name
|
|
61
65
|
*/
|
|
@@ -207,6 +211,24 @@ export type NotificationTemplateDetail = {
|
|
|
207
211
|
* Custom targets: user: {type, id}; user_group: {type, id}; rbac_policy: {type, policy_name}
|
|
208
212
|
*/
|
|
209
213
|
human_support_custom_recipients?: Array<Record<string, any>>;
|
|
214
|
+
/**
|
|
215
|
+
* Recipients config (recipient mode + optional custom targets) for notification types that opt into the generic recipients model (e.g. CRM_*). Null for types that do not.
|
|
216
|
+
*/
|
|
217
|
+
readonly recipients_config: string;
|
|
218
|
+
/**
|
|
219
|
+
* Who receives this notification: 'platform_admins_only', 'object_owner_only' (falls back to admins), 'object_owner_only_strict' (no fallback), 'platform_admins_and_object_owner' (default), or 'custom'.
|
|
220
|
+
*
|
|
221
|
+
* * `platform_admins_only` - platform_admins_only
|
|
222
|
+
* * `object_owner_only` - object_owner_only
|
|
223
|
+
* * `object_owner_only_strict` - object_owner_only_strict
|
|
224
|
+
* * `platform_admins_and_object_owner` - platform_admins_and_object_owner
|
|
225
|
+
* * `custom` - custom
|
|
226
|
+
*/
|
|
227
|
+
recipients_recipient_mode?: RecipientsRecipientModeEnum;
|
|
228
|
+
/**
|
|
229
|
+
* Custom recipient targets (used when recipient_mode='custom'): user: {type, id}; user_group: {type, id}; rbac_policy: {type, policy_name}.
|
|
230
|
+
*/
|
|
231
|
+
recipients_custom_recipients?: Array<Record<string, any>>;
|
|
210
232
|
/**
|
|
211
233
|
* New content notification config (ACTIVITY_NEW_CONTENT only)
|
|
212
234
|
*/
|
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
/* eslint-disable */
|
|
5
5
|
import type { BlankEnum } from './BlankEnum';
|
|
6
6
|
import type { NullEnum } from './NullEnum';
|
|
7
|
-
import type {
|
|
7
|
+
import type { Type4b7Enum } from './Type4b7Enum';
|
|
8
8
|
/**
|
|
9
9
|
* Serializer for listing notification templates with inheritance info
|
|
10
10
|
*/
|
|
@@ -25,6 +25,9 @@ export type NotificationTemplateList = {
|
|
|
25
25
|
* * `COURSE_LICENSE_GROUP_ASSIGNMENT` - Course License Group Assignment
|
|
26
26
|
* * `COURSE_SCHEDULE_CHANGE` - Course Schedule Change
|
|
27
27
|
* * `COURSES_PROGRESS_SUMMARY` - Courses Progress Summary
|
|
28
|
+
* * `CRM_DEAL_STAGE_CHANGED` - Crm Deal Stage Changed
|
|
29
|
+
* * `CRM_PERSON_CREATED` - Crm Person Created
|
|
30
|
+
* * `CRM_PERSON_LINKED_TO_USER` - Crm Person Linked To User
|
|
28
31
|
* * `CUSTOM_NOTIFICATION` - Custom Notification
|
|
29
32
|
* * `DEFAULT_TEMPLATE` - Default Template
|
|
30
33
|
* * `HUMAN_SUPPORT_NOTIFICATION` - Human Support Notification
|
|
@@ -49,7 +52,7 @@ export type NotificationTemplateList = {
|
|
|
49
52
|
* * `USER_NOTIF_USER_INACTIVITY` - User Notif User Inactivity
|
|
50
53
|
* * `USER_NOTIF_USER_REGISTRATION` - User Notif User Registration
|
|
51
54
|
*/
|
|
52
|
-
type?: (
|
|
55
|
+
type?: (Type4b7Enum | BlankEnum | NullEnum) | null;
|
|
53
56
|
/**
|
|
54
57
|
* A friendly name for the notification template.
|
|
55
58
|
*/
|
|
@@ -20,7 +20,7 @@ export type Organization = {
|
|
|
20
20
|
*/
|
|
21
21
|
address?: any;
|
|
22
22
|
/**
|
|
23
|
-
*
|
|
23
|
+
* Id of the Platform user who owns / manages this Organization. Must be an active member of your Platform.
|
|
24
24
|
*/
|
|
25
25
|
owner?: number | null;
|
|
26
26
|
/**
|
|
@@ -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 { Activity } from './Activity';
|
|
6
|
+
export type PaginatedActivityList = {
|
|
7
|
+
count: number;
|
|
8
|
+
next?: string | null;
|
|
9
|
+
previous?: string | null;
|
|
10
|
+
results: Array<Activity>;
|
|
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 { Deal } from './Deal';
|
|
6
|
+
export type PaginatedDealList = {
|
|
7
|
+
count: number;
|
|
8
|
+
next?: string | null;
|
|
9
|
+
previous?: string | null;
|
|
10
|
+
results: Array<Deal>;
|
|
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 { LeadSource } from './LeadSource';
|
|
6
|
+
export type PaginatedLeadSourceList = {
|
|
7
|
+
count: number;
|
|
8
|
+
next?: string | null;
|
|
9
|
+
previous?: string | null;
|
|
10
|
+
results: Array<LeadSource>;
|
|
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 { Pipeline } from './Pipeline';
|
|
6
|
+
export type PaginatedPipelineList = {
|
|
7
|
+
count: number;
|
|
8
|
+
next?: string | null;
|
|
9
|
+
previous?: string | null;
|
|
10
|
+
results: Array<Pipeline>;
|
|
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 { PipelineStage } from './PipelineStage';
|
|
6
|
+
export type PaginatedPipelineStageList = {
|
|
7
|
+
count: number;
|
|
8
|
+
next?: string | null;
|
|
9
|
+
previous?: string | null;
|
|
10
|
+
results: Array<PipelineStage>;
|
|
11
|
+
};
|
|
12
|
+
|