@devrev/typescript-sdk 1.1.4 → 1.1.5
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.
|
@@ -1,5 +1,7 @@
|
|
|
1
1
|
/** account */
|
|
2
2
|
export type Account = OrgBase & {
|
|
3
|
+
/** Custom fields. */
|
|
4
|
+
custom_fields?: object;
|
|
3
5
|
/**
|
|
4
6
|
* Custom schema fragments.
|
|
5
7
|
* @example ["don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"]
|
|
@@ -24,6 +26,8 @@ export type Account = OrgBase & {
|
|
|
24
26
|
/** The Tier of the corresponding Account. */
|
|
25
27
|
tier?: string;
|
|
26
28
|
};
|
|
29
|
+
/** account-summary */
|
|
30
|
+
export type AccountSummary = OrgBaseSummary;
|
|
27
31
|
/**
|
|
28
32
|
* accounts-create-request
|
|
29
33
|
* Request object to create a new account in the Dev organization.
|
|
@@ -41,7 +45,6 @@ export interface AccountsCreateRequest {
|
|
|
41
45
|
* External refs are unique identifiers from your customer system of
|
|
42
46
|
* records, stored as a list. Currently the length of this field is
|
|
43
47
|
* limited to 1.
|
|
44
|
-
* @maxItems 1
|
|
45
48
|
*/
|
|
46
49
|
external_refs?: string[];
|
|
47
50
|
/** List of Dev users owning this account. */
|
|
@@ -126,7 +129,6 @@ export interface AccountsUpdateRequest {
|
|
|
126
129
|
/**
|
|
127
130
|
* Updated External Refs of account. Currently the length of this
|
|
128
131
|
* field is limited to 1.
|
|
129
|
-
* @maxItems 1
|
|
130
132
|
*/
|
|
131
133
|
external_refs?: string[];
|
|
132
134
|
/**
|
|
@@ -196,6 +198,8 @@ export type Conversation = AtomBase & {
|
|
|
196
198
|
/** Description of the conversation object. */
|
|
197
199
|
description?: string;
|
|
198
200
|
group?: GroupSummary;
|
|
201
|
+
/** The users in the conversation. */
|
|
202
|
+
members: UserSummary[];
|
|
199
203
|
/** The latest messages on the conversation. */
|
|
200
204
|
messages?: TimelineEntry[];
|
|
201
205
|
/** Metadata on conversation. */
|
|
@@ -374,6 +378,46 @@ export interface ConversationsUpdateRequestUserSessions {
|
|
|
374
378
|
export interface ConversationsUpdateResponse {
|
|
375
379
|
conversation: Conversation;
|
|
376
380
|
}
|
|
381
|
+
/** create-org-schedule-interval */
|
|
382
|
+
export interface CreateOrgScheduleInterval {
|
|
383
|
+
/**
|
|
384
|
+
* Date (inclusive) on which the interval begins.
|
|
385
|
+
* @format date-time
|
|
386
|
+
*/
|
|
387
|
+
from: string;
|
|
388
|
+
/**
|
|
389
|
+
* If true, no organization schedule is looked up for these days and
|
|
390
|
+
* they are marked as holidays.
|
|
391
|
+
*/
|
|
392
|
+
is_excluded?: boolean;
|
|
393
|
+
/**
|
|
394
|
+
* The name of the period, for example the event or holiday it
|
|
395
|
+
* represents.
|
|
396
|
+
*/
|
|
397
|
+
name: string;
|
|
398
|
+
/**
|
|
399
|
+
* Date (exclusive) on which the interval ends. If omitted, it is a
|
|
400
|
+
* single day interval.
|
|
401
|
+
* @format date-time
|
|
402
|
+
*/
|
|
403
|
+
to?: string;
|
|
404
|
+
}
|
|
405
|
+
/** create-weekly-org-schedule-interval */
|
|
406
|
+
export interface CreateWeeklyOrgScheduleInterval {
|
|
407
|
+
/**
|
|
408
|
+
* Duration in minutes of the week when the interval starts. 0 is
|
|
409
|
+
* Sunday midnight, when Sunday ends and Monday begins.
|
|
410
|
+
* @format int64
|
|
411
|
+
*/
|
|
412
|
+
from: number;
|
|
413
|
+
/**
|
|
414
|
+
* Duration in minutes of the week when the interval ends (must be
|
|
415
|
+
* larger than 'from'). 0 is Sunday midnight, when Sunday ends and
|
|
416
|
+
* Monday begins.
|
|
417
|
+
* @format int64
|
|
418
|
+
*/
|
|
419
|
+
to: number;
|
|
420
|
+
}
|
|
377
421
|
/** custom-schema-fragment */
|
|
378
422
|
export interface CustomSchemaFragment {
|
|
379
423
|
type: CustomSchemaFragmentType;
|
|
@@ -402,7 +446,9 @@ export interface CustomSchemaFragmentsListResponse {
|
|
|
402
446
|
export type CustomSchemaFragmentsSetRequest = (CustomSchemaFragmentsSetRequestAppFragment | CustomSchemaFragmentsSetRequestCustomTypeFragment | CustomSchemaFragmentsSetRequestTenantFragment) & {
|
|
403
447
|
/** List of conditions for this fragment. */
|
|
404
448
|
conditions?: CustomSchemaFragmentCondition[];
|
|
405
|
-
/**
|
|
449
|
+
/** List of field names which are being dropped. */
|
|
450
|
+
deleted_fields?: string[];
|
|
451
|
+
/** Whether this fragment has been deprecated. */
|
|
406
452
|
deprecated?: boolean;
|
|
407
453
|
/** The description of the custom schema fragment. */
|
|
408
454
|
description: string;
|
|
@@ -421,6 +467,8 @@ export interface CustomSchemaFragmentsSetRequestAppFragment {
|
|
|
421
467
|
}
|
|
422
468
|
/** custom-schema-fragments-set-request-custom-type-fragment */
|
|
423
469
|
export interface CustomSchemaFragmentsSetRequestCustomTypeFragment {
|
|
470
|
+
/** The ID of the associated custom stage diagram. */
|
|
471
|
+
stage_diagram?: string;
|
|
424
472
|
/** List of stock field enum overrides. */
|
|
425
473
|
stock_field_enum_overrides?: StockFieldEnumOverride[];
|
|
426
474
|
/** The string used to populate the subtype in the leaf type. */
|
|
@@ -449,6 +497,16 @@ export type Engagement = AtomBase & {
|
|
|
449
497
|
/** Description of the engagement object. */
|
|
450
498
|
description?: string;
|
|
451
499
|
};
|
|
500
|
+
/** Type of engagement. */
|
|
501
|
+
export declare enum EngagementType {
|
|
502
|
+
Call = "call",
|
|
503
|
+
Default = "default",
|
|
504
|
+
Email = "email",
|
|
505
|
+
LinkedIn = "linked_in",
|
|
506
|
+
Meeting = "meeting",
|
|
507
|
+
Offline = "offline",
|
|
508
|
+
Survey = "survey"
|
|
509
|
+
}
|
|
452
510
|
/** engagements-count-response */
|
|
453
511
|
export interface EngagementsCountResponse {
|
|
454
512
|
/**
|
|
@@ -459,10 +517,17 @@ export interface EngagementsCountResponse {
|
|
|
459
517
|
}
|
|
460
518
|
/** engagements-create-request */
|
|
461
519
|
export interface EngagementsCreateRequest {
|
|
520
|
+
/**
|
|
521
|
+
* The IDs of the artifacts to associate with the engagement.
|
|
522
|
+
* @example ["don:core:<partition>:devo/<dev-org-id>:artifact/<artifact-id>"]
|
|
523
|
+
*/
|
|
524
|
+
artifacts?: string[];
|
|
462
525
|
/** The description of the engagement. */
|
|
463
526
|
description?: string;
|
|
464
527
|
/** The type of engagement. */
|
|
465
528
|
engagement_type?: EngagementsCreateRequestEngagementType;
|
|
529
|
+
/** External Reference for the engagement. */
|
|
530
|
+
external_ref?: string;
|
|
466
531
|
/** External URL for the engagement. */
|
|
467
532
|
external_url?: string;
|
|
468
533
|
/**
|
|
@@ -490,6 +555,7 @@ export interface EngagementsCreateRequest {
|
|
|
490
555
|
/** The type of engagement. */
|
|
491
556
|
export declare enum EngagementsCreateRequestEngagementType {
|
|
492
557
|
Call = "call",
|
|
558
|
+
Default = "default",
|
|
493
559
|
Email = "email",
|
|
494
560
|
LinkedIn = "linked_in",
|
|
495
561
|
Offline = "offline"
|
|
@@ -526,8 +592,11 @@ export interface EngagementsListResponse {
|
|
|
526
592
|
}
|
|
527
593
|
/** engagements-update-request */
|
|
528
594
|
export interface EngagementsUpdateRequest {
|
|
595
|
+
artifacts?: EngagementsUpdateRequestArtifactIds;
|
|
529
596
|
/** Updates the description of the engagement. */
|
|
530
597
|
description?: string;
|
|
598
|
+
/** External Reference for the engagement. */
|
|
599
|
+
external_ref?: string;
|
|
531
600
|
/** Updates the external URL for the engagement. */
|
|
532
601
|
external_url?: string;
|
|
533
602
|
/** The engagement ID. */
|
|
@@ -542,6 +611,14 @@ export interface EngagementsUpdateRequest {
|
|
|
542
611
|
/** Updates the title of the engagement. */
|
|
543
612
|
title?: string;
|
|
544
613
|
}
|
|
614
|
+
/** engagements-update-request-artifact-ids */
|
|
615
|
+
export interface EngagementsUpdateRequestArtifactIds {
|
|
616
|
+
/**
|
|
617
|
+
* Sets the IDs to the provided artifact IDs.
|
|
618
|
+
* @example ["don:core:<partition>:devo/<dev-org-id>:artifact/<artifact-id>"]
|
|
619
|
+
*/
|
|
620
|
+
set?: string[];
|
|
621
|
+
}
|
|
545
622
|
/** engagements-update-request-members */
|
|
546
623
|
export interface EngagementsUpdateRequestMembers {
|
|
547
624
|
/**
|
|
@@ -763,7 +840,7 @@ export type Link = AtomBase & {
|
|
|
763
840
|
target: LinkEndpointSummary;
|
|
764
841
|
};
|
|
765
842
|
/** link-endpoint-summary */
|
|
766
|
-
export type LinkEndpointSummary = (CapabilitySummary | ConversationSummary | EnhancementSummary | FeatureSummary | IssueSummary | OpportunitySummary | ProductSummary | TicketSummary) & {
|
|
843
|
+
export type LinkEndpointSummary = (CapabilitySummary | ConversationSummary | EnhancementSummary | FeatureSummary | IssueSummary | OpportunitySummary | ProductSummary | TaskSummary | TicketSummary) & {
|
|
767
844
|
type: LinkEndpointType;
|
|
768
845
|
};
|
|
769
846
|
export declare enum LinkEndpointType {
|
|
@@ -774,6 +851,7 @@ export declare enum LinkEndpointType {
|
|
|
774
851
|
Issue = "issue",
|
|
775
852
|
Opportunity = "opportunity",
|
|
776
853
|
Product = "product",
|
|
854
|
+
Task = "task",
|
|
777
855
|
Ticket = "ticket"
|
|
778
856
|
}
|
|
779
857
|
/**
|
|
@@ -920,6 +998,22 @@ export interface MetricDefinitionsListResponse {
|
|
|
920
998
|
}
|
|
921
999
|
/** opportunity */
|
|
922
1000
|
export type Opportunity = WorkBase;
|
|
1001
|
+
/** Forecast category of the opportunity. */
|
|
1002
|
+
export declare enum OpportunityForecastCategory {
|
|
1003
|
+
BestCase = "best_case",
|
|
1004
|
+
Commit = "commit",
|
|
1005
|
+
MostLikely = "most_likely",
|
|
1006
|
+
Omitted = "omitted",
|
|
1007
|
+
Pipeline = "pipeline",
|
|
1008
|
+
Won = "won"
|
|
1009
|
+
}
|
|
1010
|
+
/** Priority of the opportunity. */
|
|
1011
|
+
export declare enum OpportunityPriority {
|
|
1012
|
+
P0 = "p0",
|
|
1013
|
+
P1 = "p1",
|
|
1014
|
+
P2 = "p2",
|
|
1015
|
+
P3 = "p3"
|
|
1016
|
+
}
|
|
923
1017
|
/** opportunity-summary */
|
|
924
1018
|
export type OpportunitySummary = WorkBaseSummary;
|
|
925
1019
|
/** org-base */
|
|
@@ -938,11 +1032,280 @@ export declare enum OrgEnvironment {
|
|
|
938
1032
|
Staging = "staging",
|
|
939
1033
|
Test = "test"
|
|
940
1034
|
}
|
|
1035
|
+
/** org-schedule */
|
|
1036
|
+
export type OrgSchedule = AtomBase & {
|
|
1037
|
+
/** The schedule for each week. */
|
|
1038
|
+
default_weekly_org_schedule?: WeeklyOrgSchedule;
|
|
1039
|
+
/**
|
|
1040
|
+
* The schedule must be valid and well-defined for at least this many
|
|
1041
|
+
* days in the future, otherwise a warning notification is generated.
|
|
1042
|
+
* Default is 0 if not specified.
|
|
1043
|
+
* @format int32
|
|
1044
|
+
*/
|
|
1045
|
+
min_valid_days?: number;
|
|
1046
|
+
/** Human-readable name. */
|
|
1047
|
+
name?: string;
|
|
1048
|
+
/**
|
|
1049
|
+
* The list of schedule fragments. It must be an ordered list of
|
|
1050
|
+
* contiguous fragments (the next starting when the previous one
|
|
1051
|
+
* ends), updates in a published schedule are only allowed to add new
|
|
1052
|
+
* ones to the future.
|
|
1053
|
+
*/
|
|
1054
|
+
org_schedule_fragments?: OrgScheduleFragmentOverview[];
|
|
1055
|
+
/**
|
|
1056
|
+
* Status determines how an item can be used. In 'draft' status an item
|
|
1057
|
+
* can be edited but can't be used. When 'published' the item can longer
|
|
1058
|
+
* be edited but can be used. 'Archived' is read-only.
|
|
1059
|
+
*/
|
|
1060
|
+
status: OrgScheduleStatus;
|
|
1061
|
+
/**
|
|
1062
|
+
* Timezone in which this is defined. Only organization schedules in
|
|
1063
|
+
* the same timezone can be directly combined.
|
|
1064
|
+
*/
|
|
1065
|
+
timezone?: string;
|
|
1066
|
+
/**
|
|
1067
|
+
* Derived field indicating when a valid organization schedule will
|
|
1068
|
+
* become invalid. If omitted, the schedule is already invalid. A
|
|
1069
|
+
* schedule is valid if it has a weekly schedule for all named periods
|
|
1070
|
+
* for all its schedule fragments, and if it has a schedule fragment
|
|
1071
|
+
* for the time period in question.
|
|
1072
|
+
* @format date-time
|
|
1073
|
+
*/
|
|
1074
|
+
valid_until?: string;
|
|
1075
|
+
/**
|
|
1076
|
+
* If the organization schedule fragment specifies that the given day
|
|
1077
|
+
* belongs to a named period, a weekly schedule from this list with
|
|
1078
|
+
* the matching name will be selected.
|
|
1079
|
+
*/
|
|
1080
|
+
weekly_org_schedules?: WeeklyOrgSchedule[];
|
|
1081
|
+
};
|
|
1082
|
+
/** org-schedule-fragment */
|
|
1083
|
+
export type OrgScheduleFragment = AtomBase & {
|
|
1084
|
+
/**
|
|
1085
|
+
* The date (inclusive) on which the organization schedule fragment
|
|
1086
|
+
* begins.
|
|
1087
|
+
* @format date-time
|
|
1088
|
+
*/
|
|
1089
|
+
from?: string;
|
|
1090
|
+
/**
|
|
1091
|
+
* Periods during which the schedule is considered to be 'off' or to
|
|
1092
|
+
* be in some specific named period.
|
|
1093
|
+
*/
|
|
1094
|
+
intervals?: OrgScheduleInterval[];
|
|
1095
|
+
/** Human-readable name, indicating the purpose of the schedule. */
|
|
1096
|
+
name?: string;
|
|
1097
|
+
/**
|
|
1098
|
+
* CLDR region code of the countries/regions it is meant to be valid
|
|
1099
|
+
* for. Does not drive logic, serves only for easier filtering and
|
|
1100
|
+
* organization.
|
|
1101
|
+
*/
|
|
1102
|
+
region_codes?: string[];
|
|
1103
|
+
/**
|
|
1104
|
+
* Status determines how an item can be used. In 'draft' status an item
|
|
1105
|
+
* can be edited but can't be used. When 'published' the item can longer
|
|
1106
|
+
* be edited but can be used. 'Archived' is read-only.
|
|
1107
|
+
*/
|
|
1108
|
+
status: OrgScheduleFragmentStatus;
|
|
1109
|
+
/**
|
|
1110
|
+
* The date (exclusive) on which the organization schedule fragment's
|
|
1111
|
+
* validity ends.
|
|
1112
|
+
* @format date-time
|
|
1113
|
+
*/
|
|
1114
|
+
to?: string;
|
|
1115
|
+
};
|
|
1116
|
+
/**
|
|
1117
|
+
* org-schedule-fragment-overview
|
|
1118
|
+
* The representation of the organization schedule fragment embedded
|
|
1119
|
+
* inside a organization schedule, used to quickly look up the schedule
|
|
1120
|
+
* fragment for the right period.
|
|
1121
|
+
*/
|
|
1122
|
+
export type OrgScheduleFragmentOverview = object;
|
|
1123
|
+
/**
|
|
1124
|
+
* Status determines how an item can be used. In 'draft' status an item
|
|
1125
|
+
* can be edited but can't be used. When 'published' the item can longer
|
|
1126
|
+
* be edited but can be used. 'Archived' is read-only.
|
|
1127
|
+
*/
|
|
1128
|
+
export declare enum OrgScheduleFragmentStatus {
|
|
1129
|
+
Archived = "archived",
|
|
1130
|
+
Draft = "draft",
|
|
1131
|
+
Published = "published"
|
|
1132
|
+
}
|
|
1133
|
+
/** org-schedule-fragments-create-request */
|
|
1134
|
+
export interface OrgScheduleFragmentsCreateRequest {
|
|
1135
|
+
/**
|
|
1136
|
+
* Date (inclusive) on which the organization schedule fragment
|
|
1137
|
+
* begins.
|
|
1138
|
+
* @format date-time
|
|
1139
|
+
*/
|
|
1140
|
+
from: string;
|
|
1141
|
+
/** The intervals that comprise the schedule fragment. */
|
|
1142
|
+
intervals: CreateOrgScheduleInterval[];
|
|
1143
|
+
/** Name of the organization schedule fragment. */
|
|
1144
|
+
name: string;
|
|
1145
|
+
/**
|
|
1146
|
+
* CLDR region code of the countries/regions it is meant to be valid
|
|
1147
|
+
* for. Does not drive logic, serves only for easier filtering and
|
|
1148
|
+
* organization.
|
|
1149
|
+
*/
|
|
1150
|
+
region_codes?: string[];
|
|
1151
|
+
/**
|
|
1152
|
+
* Date (exclusive) on which the organization schedule fragment's
|
|
1153
|
+
* validity ends.
|
|
1154
|
+
* @format date-time
|
|
1155
|
+
*/
|
|
1156
|
+
to: string;
|
|
1157
|
+
}
|
|
1158
|
+
/** org-schedule-fragments-create-response */
|
|
1159
|
+
export interface OrgScheduleFragmentsCreateResponse {
|
|
1160
|
+
org_schedule_fragment: OrgScheduleFragment;
|
|
1161
|
+
}
|
|
1162
|
+
/** org-schedule-fragments-get-response */
|
|
1163
|
+
export interface OrgScheduleFragmentsGetResponse {
|
|
1164
|
+
org_schedule_fragment: OrgScheduleFragment;
|
|
1165
|
+
}
|
|
1166
|
+
/** org-schedule-fragments-transition-request */
|
|
1167
|
+
export interface OrgScheduleFragmentsTransitionRequest {
|
|
1168
|
+
/** Organization schedule Fragment ID. */
|
|
1169
|
+
id: string;
|
|
1170
|
+
/**
|
|
1171
|
+
* Status determines how an item can be used. In 'draft' status an item
|
|
1172
|
+
* can be edited but can't be used. When 'published' the item can longer
|
|
1173
|
+
* be edited but can be used. 'Archived' is read-only.
|
|
1174
|
+
*/
|
|
1175
|
+
status: OrgScheduleFragmentStatus;
|
|
1176
|
+
}
|
|
1177
|
+
/** org-schedule-fragments-transition-response */
|
|
1178
|
+
export interface OrgScheduleFragmentsTransitionResponse {
|
|
1179
|
+
org_schedule_fragment: OrgScheduleFragment;
|
|
1180
|
+
}
|
|
1181
|
+
/**
|
|
1182
|
+
* org-schedule-interval
|
|
1183
|
+
* An optionally named period on day granularity.
|
|
1184
|
+
*/
|
|
1185
|
+
export type OrgScheduleInterval = object;
|
|
1186
|
+
/**
|
|
1187
|
+
* Status determines how an item can be used. In 'draft' status an item
|
|
1188
|
+
* can be edited but can't be used. When 'published' the item can longer
|
|
1189
|
+
* be edited but can be used. 'Archived' is read-only.
|
|
1190
|
+
*/
|
|
1191
|
+
export declare enum OrgScheduleStatus {
|
|
1192
|
+
Archived = "archived",
|
|
1193
|
+
Draft = "draft",
|
|
1194
|
+
Published = "published"
|
|
1195
|
+
}
|
|
1196
|
+
/** org-schedules-create-request */
|
|
1197
|
+
export interface OrgSchedulesCreateRequest {
|
|
1198
|
+
default_weekly_org_schedule?: SetWeeklyOrgSchedule;
|
|
1199
|
+
/**
|
|
1200
|
+
* Organization schedule must be valid for at least this many days in
|
|
1201
|
+
* the future. Meaning organization schedule fragments must cover this
|
|
1202
|
+
* period. 0 if omitted.
|
|
1203
|
+
* @format int64
|
|
1204
|
+
*/
|
|
1205
|
+
min_valid_days?: number;
|
|
1206
|
+
/** Human-readable name. */
|
|
1207
|
+
name: string;
|
|
1208
|
+
/** List of organization schedule fragments with no overlaps or gaps. */
|
|
1209
|
+
org_schedule_fragments?: SetOrgScheduleFragmentSummary[];
|
|
1210
|
+
/**
|
|
1211
|
+
* Timezone in which the organization schedule applies. Expected to be
|
|
1212
|
+
* a valid IANA time zone name such as America/New_York.
|
|
1213
|
+
*/
|
|
1214
|
+
timezone: string;
|
|
1215
|
+
/**
|
|
1216
|
+
* If this day belongs to a named period according to the currently
|
|
1217
|
+
* active organization schedule fragment, a weekly organization
|
|
1218
|
+
* schedule from this list with the corresponding name will apply.
|
|
1219
|
+
*/
|
|
1220
|
+
weekly_org_schedules?: SetWeeklyOrgSchedule[];
|
|
1221
|
+
}
|
|
1222
|
+
/** org-schedules-create-response */
|
|
1223
|
+
export interface OrgSchedulesCreateResponse {
|
|
1224
|
+
org_schedule: OrgSchedule;
|
|
1225
|
+
}
|
|
1226
|
+
/** org-schedules-get-response */
|
|
1227
|
+
export interface OrgSchedulesGetResponse {
|
|
1228
|
+
org_schedule: OrgSchedule;
|
|
1229
|
+
}
|
|
1230
|
+
/** org-schedules-list-response */
|
|
1231
|
+
export interface OrgSchedulesListResponse {
|
|
1232
|
+
/**
|
|
1233
|
+
* The cursor used to iterate subsequent results in accordance to the
|
|
1234
|
+
* sort order. If not set, then no later elements exist.
|
|
1235
|
+
*/
|
|
1236
|
+
next_cursor?: string;
|
|
1237
|
+
/** The list of organization schedules. */
|
|
1238
|
+
org_schedules: OrgSchedule[];
|
|
1239
|
+
/**
|
|
1240
|
+
* The cursor used to iterate preceding results in accordance to the
|
|
1241
|
+
* sort order. If not set, then no prior elements exist.
|
|
1242
|
+
*/
|
|
1243
|
+
prev_cursor?: string;
|
|
1244
|
+
}
|
|
1245
|
+
/** org-schedules-set-future-request */
|
|
1246
|
+
export interface OrgSchedulesSetFutureRequest {
|
|
1247
|
+
/** Organization schedule ID. */
|
|
1248
|
+
id: string;
|
|
1249
|
+
/** Organization schedule Fragment ID. */
|
|
1250
|
+
org_schedule_fragment_id: string;
|
|
1251
|
+
}
|
|
1252
|
+
/** org-schedules-set-future-response */
|
|
1253
|
+
export interface OrgSchedulesSetFutureResponse {
|
|
1254
|
+
org_schedule: OrgSchedule;
|
|
1255
|
+
}
|
|
1256
|
+
/** org-schedules-transition-request */
|
|
1257
|
+
export interface OrgSchedulesTransitionRequest {
|
|
1258
|
+
/** Organization schedule ID. */
|
|
1259
|
+
id: string;
|
|
1260
|
+
/**
|
|
1261
|
+
* Status determines how an item can be used. In 'draft' status an item
|
|
1262
|
+
* can be edited but can't be used. When 'published' the item can longer
|
|
1263
|
+
* be edited but can be used. 'Archived' is read-only.
|
|
1264
|
+
*/
|
|
1265
|
+
status: OrgScheduleStatus;
|
|
1266
|
+
}
|
|
1267
|
+
/** org-schedules-transition-response */
|
|
1268
|
+
export interface OrgSchedulesTransitionResponse {
|
|
1269
|
+
org_schedule: OrgSchedule;
|
|
1270
|
+
}
|
|
1271
|
+
/** org-schedules-update-request */
|
|
1272
|
+
export interface OrgSchedulesUpdateRequest {
|
|
1273
|
+
default_weekly_org_schedule?: SetWeeklyOrgSchedule;
|
|
1274
|
+
/** Organization schedule ID. */
|
|
1275
|
+
id: string;
|
|
1276
|
+
/**
|
|
1277
|
+
* Organization schedule must be valid for at least this many days in
|
|
1278
|
+
* the future. Meaning organization schedule fragments must cover this
|
|
1279
|
+
* period. 0 if omitted.
|
|
1280
|
+
* @format int64
|
|
1281
|
+
*/
|
|
1282
|
+
min_valid_days?: number;
|
|
1283
|
+
/** Human-readable name. */
|
|
1284
|
+
name?: string;
|
|
1285
|
+
/** List of organization schedule fragments with no overlaps or gaps. */
|
|
1286
|
+
org_schedule_fragments?: SetOrgScheduleFragmentSummary[];
|
|
1287
|
+
/**
|
|
1288
|
+
* Timezone in which the organization schedule applies. Expected to be
|
|
1289
|
+
* a valid IANA time zone name such as America/New_York.
|
|
1290
|
+
*/
|
|
1291
|
+
timezone?: string;
|
|
1292
|
+
/**
|
|
1293
|
+
* If this day belongs to a named period according to the currently
|
|
1294
|
+
* active organization schedule fragment, a weekly organization
|
|
1295
|
+
* schedule from this list with the corresponding name will apply.
|
|
1296
|
+
*/
|
|
1297
|
+
weekly_org_schedules?: SetWeeklyOrgSchedule[];
|
|
1298
|
+
}
|
|
1299
|
+
/** org-schedules-update-response */
|
|
1300
|
+
export interface OrgSchedulesUpdateResponse {
|
|
1301
|
+
org_schedule: OrgSchedule;
|
|
1302
|
+
}
|
|
941
1303
|
/** org-summary */
|
|
942
|
-
export type OrgSummary = RevOrgSummary & {
|
|
1304
|
+
export type OrgSummary = (AccountSummary | RevOrgSummary) & {
|
|
943
1305
|
type: OrgType;
|
|
944
1306
|
};
|
|
945
1307
|
export declare enum OrgType {
|
|
1308
|
+
Account = "account",
|
|
946
1309
|
RevOrg = "rev_org"
|
|
947
1310
|
}
|
|
948
1311
|
/** part-base-summary */
|
|
@@ -964,6 +1327,8 @@ export declare enum PartType {
|
|
|
964
1327
|
export type ProductSummary = PartBaseSummary;
|
|
965
1328
|
/** rev-org */
|
|
966
1329
|
export type RevOrg = OrgBase & {
|
|
1330
|
+
/** Custom fields. */
|
|
1331
|
+
custom_fields?: object;
|
|
967
1332
|
/**
|
|
968
1333
|
* Custom schema fragments.
|
|
969
1334
|
* @example ["don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"]
|
|
@@ -1091,6 +1456,8 @@ export interface RevOrgsUpdateResponse {
|
|
|
1091
1456
|
}
|
|
1092
1457
|
/** rev-user */
|
|
1093
1458
|
export type RevUser = UserBase & {
|
|
1459
|
+
/** Custom fields. */
|
|
1460
|
+
custom_fields?: object;
|
|
1094
1461
|
/**
|
|
1095
1462
|
* Custom schema fragments.
|
|
1096
1463
|
* @example ["don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"]
|
|
@@ -1258,6 +1625,16 @@ export type SchemaCompositeListFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
|
1258
1625
|
/** Composite type. Required when field type is composite. */
|
|
1259
1626
|
composite_type?: string;
|
|
1260
1627
|
};
|
|
1628
|
+
/** schema-date-field-descriptor */
|
|
1629
|
+
export type SchemaDateFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
1630
|
+
/** Default value. */
|
|
1631
|
+
default_value?: string;
|
|
1632
|
+
};
|
|
1633
|
+
/** schema-date-list-field-descriptor */
|
|
1634
|
+
export type SchemaDateListFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
1635
|
+
/** Default value. */
|
|
1636
|
+
default_value?: string[];
|
|
1637
|
+
};
|
|
1261
1638
|
/** schema-double-field-descriptor */
|
|
1262
1639
|
export type SchemaDoubleFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
1263
1640
|
/**
|
|
@@ -1289,11 +1666,11 @@ export type SchemaEnumListFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
|
1289
1666
|
* schema-field-descriptor
|
|
1290
1667
|
* Set of field attributes.
|
|
1291
1668
|
*/
|
|
1292
|
-
export type SchemaFieldDescriptor = (SchemaBoolFieldDescriptor | SchemaCompositeFieldDescriptor | SchemaDoubleFieldDescriptor | SchemaEnumFieldDescriptor | SchemaFieldDescriptorArrayType | SchemaIdFieldDescriptor | SchemaIntFieldDescriptor | SchemaRichTextFieldDescriptor | SchemaTextFieldDescriptor | SchemaTimestampFieldDescriptor | SchemaTokensFieldDescriptor) & {
|
|
1669
|
+
export type SchemaFieldDescriptor = (SchemaBoolFieldDescriptor | SchemaCompositeFieldDescriptor | SchemaDateFieldDescriptor | SchemaDoubleFieldDescriptor | SchemaEnumFieldDescriptor | SchemaFieldDescriptorArrayType | SchemaIdFieldDescriptor | SchemaIntFieldDescriptor | SchemaRichTextFieldDescriptor | SchemaTextFieldDescriptor | SchemaTimestampFieldDescriptor | SchemaTokensFieldDescriptor) & {
|
|
1293
1670
|
field_type: SchemaFieldDescriptorFieldType;
|
|
1294
1671
|
};
|
|
1295
1672
|
/** schema-field-descriptor-array-type */
|
|
1296
|
-
export type SchemaFieldDescriptorArrayType = (SchemaBoolListFieldDescriptor | SchemaCompositeListFieldDescriptor | SchemaDoubleListFieldDescriptor | SchemaEnumListFieldDescriptor | SchemaIdListFieldDescriptor | SchemaIntListFieldDescriptor | SchemaRichTextListFieldDescriptor | SchemaTextListFieldDescriptor | SchemaTimestampListFieldDescriptor | SchemaTokensListFieldDescriptor) & {
|
|
1673
|
+
export type SchemaFieldDescriptorArrayType = (SchemaBoolListFieldDescriptor | SchemaCompositeListFieldDescriptor | SchemaDateListFieldDescriptor | SchemaDoubleListFieldDescriptor | SchemaEnumListFieldDescriptor | SchemaIdListFieldDescriptor | SchemaIntListFieldDescriptor | SchemaRichTextListFieldDescriptor | SchemaTextListFieldDescriptor | SchemaTimestampListFieldDescriptor | SchemaTokensListFieldDescriptor) & {
|
|
1297
1674
|
base_type: SchemaFieldDescriptorArrayTypeBaseType;
|
|
1298
1675
|
/**
|
|
1299
1676
|
* The maximum array length.
|
|
@@ -1309,6 +1686,7 @@ export type SchemaFieldDescriptorArrayType = (SchemaBoolListFieldDescriptor | Sc
|
|
|
1309
1686
|
export declare enum SchemaFieldDescriptorArrayTypeBaseType {
|
|
1310
1687
|
Bool = "bool",
|
|
1311
1688
|
Composite = "composite",
|
|
1689
|
+
Date = "date",
|
|
1312
1690
|
Double = "double",
|
|
1313
1691
|
Enum = "enum",
|
|
1314
1692
|
Id = "id",
|
|
@@ -1331,6 +1709,8 @@ export interface SchemaFieldDescriptorBase {
|
|
|
1331
1709
|
is_pii?: boolean;
|
|
1332
1710
|
/** Whether this field is required or not. */
|
|
1333
1711
|
is_required?: boolean;
|
|
1712
|
+
/** The schema of MFZ specific fields. */
|
|
1713
|
+
mfz?: SchemaFieldMfzMetadata;
|
|
1334
1714
|
/** Name of the field. */
|
|
1335
1715
|
name: string;
|
|
1336
1716
|
/** Type this field is from. */
|
|
@@ -1342,6 +1722,7 @@ export declare enum SchemaFieldDescriptorFieldType {
|
|
|
1342
1722
|
Array = "array",
|
|
1343
1723
|
Bool = "bool",
|
|
1344
1724
|
Composite = "composite",
|
|
1725
|
+
Date = "date",
|
|
1345
1726
|
Double = "double",
|
|
1346
1727
|
Enum = "enum",
|
|
1347
1728
|
Id = "id",
|
|
@@ -1351,6 +1732,11 @@ export declare enum SchemaFieldDescriptorFieldType {
|
|
|
1351
1732
|
Timestamp = "timestamp",
|
|
1352
1733
|
Tokens = "tokens"
|
|
1353
1734
|
}
|
|
1735
|
+
/**
|
|
1736
|
+
* schema-field-mfz-metadata
|
|
1737
|
+
* The schema of MFZ specific fields.
|
|
1738
|
+
*/
|
|
1739
|
+
export type SchemaFieldMfzMetadata = object;
|
|
1354
1740
|
/**
|
|
1355
1741
|
* schema-field-ui-metadata
|
|
1356
1742
|
* The schema of ui specific fields.
|
|
@@ -1540,10 +1926,7 @@ export type SchemaTextListFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
|
1540
1926
|
};
|
|
1541
1927
|
/** schema-timestamp-field-descriptor */
|
|
1542
1928
|
export type SchemaTimestampFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
1543
|
-
/**
|
|
1544
|
-
* Default value.
|
|
1545
|
-
* @format date-time
|
|
1546
|
-
*/
|
|
1929
|
+
/** Default value. */
|
|
1547
1930
|
default_value?: string;
|
|
1548
1931
|
};
|
|
1549
1932
|
/** schema-timestamp-list-field-descriptor */
|
|
@@ -1607,6 +1990,11 @@ export type SchemaTokensListFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
|
1607
1990
|
/** The string suffix. */
|
|
1608
1991
|
suffix?: string;
|
|
1609
1992
|
};
|
|
1993
|
+
/** set-org-schedule-fragment-summary */
|
|
1994
|
+
export interface SetOrgScheduleFragmentSummary {
|
|
1995
|
+
/** Organization schedule fragment ID. */
|
|
1996
|
+
id: string;
|
|
1997
|
+
}
|
|
1610
1998
|
/** set-sla-policy */
|
|
1611
1999
|
export interface SetSlaPolicy {
|
|
1612
2000
|
/** Metrics to apply to the selected items. */
|
|
@@ -1657,7 +2045,7 @@ export interface SetSupportMetricTarget {
|
|
|
1657
2045
|
* be breached, in order to avoid breaching the overall SLA policy.
|
|
1658
2046
|
* @format double
|
|
1659
2047
|
*/
|
|
1660
|
-
performance
|
|
2048
|
+
performance?: number;
|
|
1661
2049
|
/**
|
|
1662
2050
|
* The target value to be achieved, for example the time in which to
|
|
1663
2051
|
* do something, or the maximum allowed number of message pairs. The
|
|
@@ -1686,6 +2074,16 @@ export interface SetTagWithValue {
|
|
|
1686
2074
|
*/
|
|
1687
2075
|
value?: string;
|
|
1688
2076
|
}
|
|
2077
|
+
/** set-weekly-org-schedule */
|
|
2078
|
+
export interface SetWeeklyOrgSchedule {
|
|
2079
|
+
/** The 'on' intervals of the week. */
|
|
2080
|
+
intervals: CreateWeeklyOrgScheduleInterval[];
|
|
2081
|
+
/**
|
|
2082
|
+
* The name of the period during which the organization schedule
|
|
2083
|
+
* applies.
|
|
2084
|
+
*/
|
|
2085
|
+
period_name: string;
|
|
2086
|
+
}
|
|
1689
2087
|
/** sla */
|
|
1690
2088
|
export type Sla = AtomBase & {
|
|
1691
2089
|
/**
|
|
@@ -1992,6 +2390,8 @@ export interface TagWithValue {
|
|
|
1992
2390
|
/** The value for the object's association with the tag. */
|
|
1993
2391
|
value?: string;
|
|
1994
2392
|
}
|
|
2393
|
+
/** task */
|
|
2394
|
+
export type Task = WorkBase;
|
|
1995
2395
|
/** Priority of the work based upon impact and criticality. */
|
|
1996
2396
|
export declare enum TaskPriority {
|
|
1997
2397
|
P0 = "p0",
|
|
@@ -1999,6 +2399,8 @@ export declare enum TaskPriority {
|
|
|
1999
2399
|
P2 = "p2",
|
|
2000
2400
|
P3 = "p3"
|
|
2001
2401
|
}
|
|
2402
|
+
/** task-summary */
|
|
2403
|
+
export type TaskSummary = WorkBaseSummary;
|
|
2002
2404
|
/** ticket */
|
|
2003
2405
|
export type Ticket = WorkBase & {
|
|
2004
2406
|
group?: GroupSummary;
|
|
@@ -2129,7 +2531,28 @@ export type TimelineEntry = TimelineComment & {
|
|
|
2129
2531
|
type: TimelineEntryType;
|
|
2130
2532
|
};
|
|
2131
2533
|
/** timeline-entry-base */
|
|
2132
|
-
export type TimelineEntryBase = AtomBase
|
|
2534
|
+
export type TimelineEntryBase = AtomBase & {
|
|
2535
|
+
/** The object that the Timeline entry belongs to. */
|
|
2536
|
+
object: string;
|
|
2537
|
+
/** The type of object that the Timeline entry belongs to. */
|
|
2538
|
+
object_type?: TimelineEntryObjectType;
|
|
2539
|
+
};
|
|
2540
|
+
/** The type of object that the Timeline entry belongs to. */
|
|
2541
|
+
export declare enum TimelineEntryObjectType {
|
|
2542
|
+
Account = "account",
|
|
2543
|
+
Capability = "capability",
|
|
2544
|
+
Conversation = "conversation",
|
|
2545
|
+
Enhancement = "enhancement",
|
|
2546
|
+
Feature = "feature",
|
|
2547
|
+
Issue = "issue",
|
|
2548
|
+
Opportunity = "opportunity",
|
|
2549
|
+
Product = "product",
|
|
2550
|
+
RevOrg = "rev_org",
|
|
2551
|
+
RevUser = "rev_user",
|
|
2552
|
+
Task = "task",
|
|
2553
|
+
Ticket = "ticket",
|
|
2554
|
+
TimelineComment = "timeline_comment"
|
|
2555
|
+
}
|
|
2133
2556
|
export declare enum TimelineEntryType {
|
|
2134
2557
|
TimelineComment = "timeline_comment"
|
|
2135
2558
|
}
|
|
@@ -2226,8 +2649,13 @@ export declare enum UserType {
|
|
|
2226
2649
|
RevUser = "rev_user",
|
|
2227
2650
|
SysUser = "sys_user"
|
|
2228
2651
|
}
|
|
2652
|
+
/**
|
|
2653
|
+
* weekly-org-schedule
|
|
2654
|
+
* The schedule for each week.
|
|
2655
|
+
*/
|
|
2656
|
+
export type WeeklyOrgSchedule = object;
|
|
2229
2657
|
/** work */
|
|
2230
|
-
export type Work = (Issue | Opportunity | Ticket) & {
|
|
2658
|
+
export type Work = (Issue | Opportunity | Task | Ticket) & {
|
|
2231
2659
|
type: WorkType;
|
|
2232
2660
|
};
|
|
2233
2661
|
/** work-base */
|
|
@@ -2237,6 +2665,8 @@ export type WorkBase = AtomBase & {
|
|
|
2237
2665
|
artifacts?: ArtifactSummary[];
|
|
2238
2666
|
/** Body of the work object. */
|
|
2239
2667
|
body?: string;
|
|
2668
|
+
/** Custom fields. */
|
|
2669
|
+
custom_fields?: object;
|
|
2240
2670
|
/**
|
|
2241
2671
|
* Custom schema fragments.
|
|
2242
2672
|
* @example ["don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"]
|
|
@@ -2271,6 +2701,7 @@ export type WorkBaseSummary = AtomBaseSummary & {
|
|
|
2271
2701
|
export declare enum WorkType {
|
|
2272
2702
|
Issue = "issue",
|
|
2273
2703
|
Opportunity = "opportunity",
|
|
2704
|
+
Task = "task",
|
|
2274
2705
|
Ticket = "ticket"
|
|
2275
2706
|
}
|
|
2276
2707
|
/** works-create-request */
|
|
@@ -2289,6 +2720,8 @@ export type WorksCreateRequest = (WorksCreateRequestIssue | WorksCreateRequestOp
|
|
|
2289
2720
|
artifacts?: string[];
|
|
2290
2721
|
/** Body of the work object. */
|
|
2291
2722
|
body?: string;
|
|
2723
|
+
/** Custom fields. */
|
|
2724
|
+
custom_fields?: object;
|
|
2292
2725
|
/**
|
|
2293
2726
|
* The custom schema fragments to use.
|
|
2294
2727
|
* @example ["don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"]
|
|
@@ -2343,6 +2776,10 @@ export interface WorksCreateRequestOpportunity {
|
|
|
2343
2776
|
* @format double
|
|
2344
2777
|
*/
|
|
2345
2778
|
customer_budget?: number;
|
|
2779
|
+
/** Forecast category of the opportunity. */
|
|
2780
|
+
forecast_category?: OpportunityForecastCategory;
|
|
2781
|
+
/** Priority of the opportunity. */
|
|
2782
|
+
priority?: OpportunityPriority;
|
|
2346
2783
|
/**
|
|
2347
2784
|
* The probability of winning the deal, lies between 0.0 and 1.0.
|
|
2348
2785
|
* @format double
|
|
@@ -2425,6 +2862,8 @@ export type WorksUpdateRequest = (WorksUpdateRequestIssue | WorksUpdateRequestOp
|
|
|
2425
2862
|
artifacts?: WorksUpdateRequestArtifactIds;
|
|
2426
2863
|
/** Updated body of the work object, or unchanged if not provided. */
|
|
2427
2864
|
body?: string;
|
|
2865
|
+
/** Custom fields. */
|
|
2866
|
+
custom_fields?: object;
|
|
2428
2867
|
/**
|
|
2429
2868
|
* The custom schema fragments to use.
|
|
2430
2869
|
* @example ["don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"]
|
|
@@ -2546,9 +2985,9 @@ export interface WorksUpdateRequestTicket {
|
|
|
2546
2985
|
export interface WorksUpdateResponse {
|
|
2547
2986
|
work: Work;
|
|
2548
2987
|
}
|
|
2549
|
-
import { AxiosInstance, AxiosRequestConfig, AxiosResponse, ResponseType } from
|
|
2988
|
+
import { AxiosInstance, AxiosRequestConfig, AxiosResponse, ResponseType } from 'axios';
|
|
2550
2989
|
export type QueryParamsType = Record<string | number, any>;
|
|
2551
|
-
export interface FullRequestParams extends Omit<AxiosRequestConfig,
|
|
2990
|
+
export interface FullRequestParams extends Omit<AxiosRequestConfig, 'data' | 'params' | 'url' | 'responseType'> {
|
|
2552
2991
|
/** set parameter to `true` for call `securityWorker` for this request */
|
|
2553
2992
|
secure?: boolean;
|
|
2554
2993
|
/** request path */
|
|
@@ -2562,8 +3001,8 @@ export interface FullRequestParams extends Omit<AxiosRequestConfig, "data" | "pa
|
|
|
2562
3001
|
/** request body */
|
|
2563
3002
|
body?: unknown;
|
|
2564
3003
|
}
|
|
2565
|
-
export type RequestParams = Omit<FullRequestParams,
|
|
2566
|
-
export interface ApiConfig<SecurityDataType = unknown> extends Omit<AxiosRequestConfig,
|
|
3004
|
+
export type RequestParams = Omit<FullRequestParams, 'body' | 'method' | 'query' | 'path'>;
|
|
3005
|
+
export interface ApiConfig<SecurityDataType = unknown> extends Omit<AxiosRequestConfig, 'data' | 'cancelToken'> {
|
|
2567
3006
|
securityWorker?: (securityData: SecurityDataType | null) => Promise<AxiosRequestConfig | void> | AxiosRequestConfig | void;
|
|
2568
3007
|
secure?: boolean;
|
|
2569
3008
|
format?: ResponseType;
|
|
@@ -2628,13 +3067,13 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2628
3067
|
* Filters for objects created after the provided timestamp (inclusive).
|
|
2629
3068
|
* @format date-time
|
|
2630
3069
|
*/
|
|
2631
|
-
|
|
3070
|
+
'created_date.after'?: string;
|
|
2632
3071
|
/**
|
|
2633
3072
|
* Filters for objects created before the provided timestamp
|
|
2634
3073
|
* (inclusive).
|
|
2635
3074
|
* @format date-time
|
|
2636
3075
|
*/
|
|
2637
|
-
|
|
3076
|
+
'created_date.before'?: string;
|
|
2638
3077
|
/** Array of references of accounts to be filtered. */
|
|
2639
3078
|
external_refs?: string[];
|
|
2640
3079
|
/**
|
|
@@ -2648,13 +3087,13 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2648
3087
|
* Filters for objects created after the provided timestamp (inclusive).
|
|
2649
3088
|
* @format date-time
|
|
2650
3089
|
*/
|
|
2651
|
-
|
|
3090
|
+
'modified_date.after'?: string;
|
|
2652
3091
|
/**
|
|
2653
3092
|
* Filters for objects created before the provided timestamp
|
|
2654
3093
|
* (inclusive).
|
|
2655
3094
|
* @format date-time
|
|
2656
3095
|
*/
|
|
2657
|
-
|
|
3096
|
+
'modified_date.before'?: string;
|
|
2658
3097
|
/** Fields to sort the accounts by and the direction to sort them in. */
|
|
2659
3098
|
sort_by?: string[];
|
|
2660
3099
|
}, params?: RequestParams) => Promise<AxiosResponse<AccountsExportResponse, any>>;
|
|
@@ -2688,13 +3127,13 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2688
3127
|
* Filters for objects created after the provided timestamp (inclusive).
|
|
2689
3128
|
* @format date-time
|
|
2690
3129
|
*/
|
|
2691
|
-
|
|
3130
|
+
'created_date.after'?: string;
|
|
2692
3131
|
/**
|
|
2693
3132
|
* Filters for objects created before the provided timestamp
|
|
2694
3133
|
* (inclusive).
|
|
2695
3134
|
* @format date-time
|
|
2696
3135
|
*/
|
|
2697
|
-
|
|
3136
|
+
'created_date.before'?: string;
|
|
2698
3137
|
/**
|
|
2699
3138
|
* The cursor to resume iteration from. If not provided, then iteration
|
|
2700
3139
|
* starts from the beginning.
|
|
@@ -2717,13 +3156,13 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2717
3156
|
* Filters for objects created after the provided timestamp (inclusive).
|
|
2718
3157
|
* @format date-time
|
|
2719
3158
|
*/
|
|
2720
|
-
|
|
3159
|
+
'modified_date.after'?: string;
|
|
2721
3160
|
/**
|
|
2722
3161
|
* Filters for objects created before the provided timestamp
|
|
2723
3162
|
* (inclusive).
|
|
2724
3163
|
* @format date-time
|
|
2725
3164
|
*/
|
|
2726
|
-
|
|
3165
|
+
'modified_date.before'?: string;
|
|
2727
3166
|
/** Fields to sort the accounts by and the direction to sort them in. */
|
|
2728
3167
|
sort_by?: string[];
|
|
2729
3168
|
}, params?: RequestParams) => Promise<AxiosResponse<AccountsListResponse, any>>;
|
|
@@ -2797,7 +3236,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2797
3236
|
/** Filters for conversations with any of the provided source channels. */
|
|
2798
3237
|
source_channels?: string[];
|
|
2799
3238
|
/** Filters for records in the provided stage(s). */
|
|
2800
|
-
|
|
3239
|
+
'stage.name'?: string[];
|
|
2801
3240
|
/**
|
|
2802
3241
|
* Filters for conversations with any of the provided tags.
|
|
2803
3242
|
* @example ["don:core:<partition>:devo/<dev-org-id>:tag/<tag-id>"]
|
|
@@ -2868,7 +3307,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2868
3307
|
/** Filters for conversations with any of the provided source channels. */
|
|
2869
3308
|
source_channels?: string[];
|
|
2870
3309
|
/** Filters for records in the provided stage(s). */
|
|
2871
|
-
|
|
3310
|
+
'stage.name'?: string[];
|
|
2872
3311
|
/**
|
|
2873
3312
|
* Filters for conversations with any of the provided tags.
|
|
2874
3313
|
* @example ["don:core:<partition>:devo/<dev-org-id>:tag/<tag-id>"]
|
|
@@ -2893,11 +3332,20 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2893
3332
|
* @secure
|
|
2894
3333
|
*/
|
|
2895
3334
|
engagementsCount: (query?: {
|
|
3335
|
+
/** Filters for meetings with the provided external_refs. */
|
|
3336
|
+
external_ref?: string[];
|
|
3337
|
+
/**
|
|
3338
|
+
* Filters for engagement of the provided members.
|
|
3339
|
+
* @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
|
|
3340
|
+
*/
|
|
3341
|
+
members?: string[];
|
|
2896
3342
|
/**
|
|
2897
3343
|
* Filters for engagements with the provided parent.
|
|
2898
3344
|
* @example ["don:core:<partition>:devo/<dev-org-id>:account/<account-id>"]
|
|
2899
3345
|
*/
|
|
2900
3346
|
parent?: string[];
|
|
3347
|
+
/** Filters for engagement of the provided types. */
|
|
3348
|
+
type?: EngagementType[];
|
|
2901
3349
|
}, params?: RequestParams) => Promise<AxiosResponse<EngagementsCountResponse, any>>;
|
|
2902
3350
|
/**
|
|
2903
3351
|
* @description Creates a new engagement record.
|
|
@@ -2943,11 +3391,18 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2943
3391
|
* starts from the beginning.
|
|
2944
3392
|
*/
|
|
2945
3393
|
cursor?: string;
|
|
3394
|
+
/** Filters for meetings with the provided external_refs. */
|
|
3395
|
+
external_ref?: string[];
|
|
2946
3396
|
/**
|
|
2947
3397
|
* The maximum number of engagements to return.
|
|
2948
3398
|
* @format int32
|
|
2949
3399
|
*/
|
|
2950
3400
|
limit?: number;
|
|
3401
|
+
/**
|
|
3402
|
+
* Filters for engagement of the provided members.
|
|
3403
|
+
* @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
|
|
3404
|
+
*/
|
|
3405
|
+
members?: string[];
|
|
2951
3406
|
/**
|
|
2952
3407
|
* The iteration mode to use, otherwise if not set, then "after" is
|
|
2953
3408
|
* used.
|
|
@@ -2960,6 +3415,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2960
3415
|
parent?: string[];
|
|
2961
3416
|
/** Fields to sort the engagements by and the direction to sort them. */
|
|
2962
3417
|
sort_by?: string[];
|
|
3418
|
+
/** Filters for engagement of the provided types. */
|
|
3419
|
+
type?: EngagementType[];
|
|
2963
3420
|
}, params?: RequestParams) => Promise<AxiosResponse<EngagementsListResponse, any>>;
|
|
2964
3421
|
/**
|
|
2965
3422
|
* @description Updates the engagement record.
|
|
@@ -3091,6 +3548,114 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3091
3548
|
/** The type of metric definitions sought. */
|
|
3092
3549
|
type?: MetricDefinitionMetricType[];
|
|
3093
3550
|
}, params?: RequestParams) => Promise<AxiosResponse<MetricDefinitionsListResponse, any>>;
|
|
3551
|
+
/**
|
|
3552
|
+
* @description Creates an organization schedule fragment.
|
|
3553
|
+
*
|
|
3554
|
+
* @tags schedules
|
|
3555
|
+
* @name OrgScheduleFragmentsCreate
|
|
3556
|
+
* @request POST:/org-schedule-fragments.create
|
|
3557
|
+
* @secure
|
|
3558
|
+
*/
|
|
3559
|
+
orgScheduleFragmentsCreate: (data: OrgScheduleFragmentsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<OrgScheduleFragmentsCreateResponse, any>>;
|
|
3560
|
+
/**
|
|
3561
|
+
* @description Gets an organization schedule fragment.
|
|
3562
|
+
*
|
|
3563
|
+
* @tags schedules
|
|
3564
|
+
* @name OrgScheduleFragmentsGet
|
|
3565
|
+
* @request GET:/org-schedule-fragments.get
|
|
3566
|
+
* @secure
|
|
3567
|
+
*/
|
|
3568
|
+
orgScheduleFragmentsGet: (query: {
|
|
3569
|
+
/** Organization schedule Fragment ID. */
|
|
3570
|
+
id: string;
|
|
3571
|
+
}, params?: RequestParams) => Promise<AxiosResponse<OrgScheduleFragmentsGetResponse, any>>;
|
|
3572
|
+
/**
|
|
3573
|
+
* @description Changes stage of an organization schedule fragment.
|
|
3574
|
+
*
|
|
3575
|
+
* @tags schedules
|
|
3576
|
+
* @name OrgScheduleFragmentsTransition
|
|
3577
|
+
* @request POST:/org-schedule-fragments.transition
|
|
3578
|
+
* @secure
|
|
3579
|
+
*/
|
|
3580
|
+
orgScheduleFragmentsTransition: (data: OrgScheduleFragmentsTransitionRequest, params?: RequestParams) => Promise<AxiosResponse<OrgScheduleFragmentsTransitionResponse, any>>;
|
|
3581
|
+
/**
|
|
3582
|
+
* @description Creates an organization schedule with a default weekly organization schedule and a list of organization schedule fragments.
|
|
3583
|
+
*
|
|
3584
|
+
* @tags schedules
|
|
3585
|
+
* @name OrgSchedulesCreate
|
|
3586
|
+
* @request POST:/org-schedules.create
|
|
3587
|
+
* @secure
|
|
3588
|
+
*/
|
|
3589
|
+
orgSchedulesCreate: (data: OrgSchedulesCreateRequest, params?: RequestParams) => Promise<AxiosResponse<OrgSchedulesCreateResponse, any>>;
|
|
3590
|
+
/**
|
|
3591
|
+
* @description Gets an organization schedule.
|
|
3592
|
+
*
|
|
3593
|
+
* @tags schedules
|
|
3594
|
+
* @name OrgSchedulesGet
|
|
3595
|
+
* @request GET:/org-schedules.get
|
|
3596
|
+
* @secure
|
|
3597
|
+
*/
|
|
3598
|
+
orgSchedulesGet: (query: {
|
|
3599
|
+
/** Organization schedule ID. */
|
|
3600
|
+
id: string;
|
|
3601
|
+
}, params?: RequestParams) => Promise<AxiosResponse<OrgSchedulesGetResponse, any>>;
|
|
3602
|
+
/**
|
|
3603
|
+
* @description Gets list of organization schedules.
|
|
3604
|
+
*
|
|
3605
|
+
* @tags schedules
|
|
3606
|
+
* @name OrgSchedulesList
|
|
3607
|
+
* @request GET:/org-schedules.list
|
|
3608
|
+
* @secure
|
|
3609
|
+
*/
|
|
3610
|
+
orgSchedulesList: (query?: {
|
|
3611
|
+
/** Creator ID the filter matches. */
|
|
3612
|
+
created_by_id?: string[];
|
|
3613
|
+
/**
|
|
3614
|
+
* The cursor to resume iteration from. If not provided, then iteration
|
|
3615
|
+
* starts from the beginning.
|
|
3616
|
+
*/
|
|
3617
|
+
cursor?: string;
|
|
3618
|
+
/**
|
|
3619
|
+
* Max number of organization schedules returned in a page. Default is
|
|
3620
|
+
* 50.
|
|
3621
|
+
* @format int32
|
|
3622
|
+
*/
|
|
3623
|
+
limit?: number;
|
|
3624
|
+
/**
|
|
3625
|
+
* The iteration mode to use, otherwise if not set, then "after" is
|
|
3626
|
+
* used.
|
|
3627
|
+
*/
|
|
3628
|
+
mode?: ListMode;
|
|
3629
|
+
/** The organization schedule statuses the filter matches. */
|
|
3630
|
+
status?: OrgScheduleStatus[];
|
|
3631
|
+
}, params?: RequestParams) => Promise<AxiosResponse<OrgSchedulesListResponse, any>>;
|
|
3632
|
+
/**
|
|
3633
|
+
* @description Sets next organization schedule fragment which must begin the day the last existing fragment ends.
|
|
3634
|
+
*
|
|
3635
|
+
* @tags schedules
|
|
3636
|
+
* @name OrgSchedulesSetFuture
|
|
3637
|
+
* @request POST:/org-schedules.set-future
|
|
3638
|
+
* @secure
|
|
3639
|
+
*/
|
|
3640
|
+
orgSchedulesSetFuture: (data: OrgSchedulesSetFutureRequest, params?: RequestParams) => Promise<AxiosResponse<OrgSchedulesSetFutureResponse, any>>;
|
|
3641
|
+
/**
|
|
3642
|
+
* @description Publishes or archives an organization schedule.
|
|
3643
|
+
*
|
|
3644
|
+
* @tags schedules
|
|
3645
|
+
* @name OrgSchedulesTransition
|
|
3646
|
+
* @request POST:/org-schedules.transition
|
|
3647
|
+
* @secure
|
|
3648
|
+
*/
|
|
3649
|
+
orgSchedulesTransition: (data: OrgSchedulesTransitionRequest, params?: RequestParams) => Promise<AxiosResponse<OrgSchedulesTransitionResponse, any>>;
|
|
3650
|
+
/**
|
|
3651
|
+
* @description Updates an organization schedule.
|
|
3652
|
+
*
|
|
3653
|
+
* @tags schedules
|
|
3654
|
+
* @name OrgSchedulesUpdate
|
|
3655
|
+
* @request POST:/org-schedules.update
|
|
3656
|
+
* @secure
|
|
3657
|
+
*/
|
|
3658
|
+
orgSchedulesUpdate: (data: OrgSchedulesUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<OrgSchedulesUpdateResponse, any>>;
|
|
3094
3659
|
/**
|
|
3095
3660
|
* @description Creates a Rev organization in the authenticated user's Dev organization.
|
|
3096
3661
|
*
|
|
@@ -3130,13 +3695,13 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3130
3695
|
* Filters for objects created after the provided timestamp (inclusive).
|
|
3131
3696
|
* @format date-time
|
|
3132
3697
|
*/
|
|
3133
|
-
|
|
3698
|
+
'created_date.after'?: string;
|
|
3134
3699
|
/**
|
|
3135
3700
|
* Filters for objects created before the provided timestamp
|
|
3136
3701
|
* (inclusive).
|
|
3137
3702
|
* @format date-time
|
|
3138
3703
|
*/
|
|
3139
|
-
|
|
3704
|
+
'created_date.before'?: string;
|
|
3140
3705
|
/**
|
|
3141
3706
|
* The cursor to resume iteration from. If not provided, then iteration
|
|
3142
3707
|
* starts from the beginning.
|
|
@@ -3163,13 +3728,13 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3163
3728
|
* Filters for objects created after the provided timestamp (inclusive).
|
|
3164
3729
|
* @format date-time
|
|
3165
3730
|
*/
|
|
3166
|
-
|
|
3731
|
+
'modified_date.after'?: string;
|
|
3167
3732
|
/**
|
|
3168
3733
|
* Filters for objects created before the provided timestamp
|
|
3169
3734
|
* (inclusive).
|
|
3170
3735
|
* @format date-time
|
|
3171
3736
|
*/
|
|
3172
|
-
|
|
3737
|
+
'modified_date.before'?: string;
|
|
3173
3738
|
/**
|
|
3174
3739
|
* Fields to sort the Rev organizations by and the direction to sort
|
|
3175
3740
|
* them.
|
|
@@ -3239,13 +3804,13 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3239
3804
|
* Filters for objects created after the provided timestamp (inclusive).
|
|
3240
3805
|
* @format date-time
|
|
3241
3806
|
*/
|
|
3242
|
-
|
|
3807
|
+
'created_date.after'?: string;
|
|
3243
3808
|
/**
|
|
3244
3809
|
* Filters for objects created before the provided timestamp
|
|
3245
3810
|
* (inclusive).
|
|
3246
3811
|
* @format date-time
|
|
3247
3812
|
*/
|
|
3248
|
-
|
|
3813
|
+
'created_date.before'?: string;
|
|
3249
3814
|
/**
|
|
3250
3815
|
* The cursor to resume iteration from. If not provided, then iteration
|
|
3251
3816
|
* starts from the beginning.
|
|
@@ -3269,13 +3834,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3269
3834
|
* Filters for objects created after the provided timestamp (inclusive).
|
|
3270
3835
|
* @format date-time
|
|
3271
3836
|
*/
|
|
3272
|
-
|
|
3837
|
+
'modified_date.after'?: string;
|
|
3273
3838
|
/**
|
|
3274
3839
|
* Filters for objects created before the provided timestamp
|
|
3275
3840
|
* (inclusive).
|
|
3276
3841
|
* @format date-time
|
|
3277
3842
|
*/
|
|
3278
|
-
|
|
3843
|
+
'modified_date.before'?: string;
|
|
3844
|
+
/** List of phone numbers to filter Rev users on. */
|
|
3845
|
+
phone_numbers?: string[];
|
|
3279
3846
|
/**
|
|
3280
3847
|
* List of IDs of Rev organizations to be filtered.
|
|
3281
3848
|
* @example ["don:identity:<partition>:devo/<dev-org-id>:revo/<rev-org-id>"]
|
|
@@ -3584,6 +4151,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3584
4151
|
* @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
|
|
3585
4152
|
*/
|
|
3586
4153
|
created_by?: string[];
|
|
4154
|
+
/** Filters for custom fields. */
|
|
4155
|
+
custom_fields?: object;
|
|
3587
4156
|
/**
|
|
3588
4157
|
* The number of work items to return. The default is '50', the maximum
|
|
3589
4158
|
* is '5000'.
|
|
@@ -3591,42 +4160,42 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3591
4160
|
*/
|
|
3592
4161
|
first?: number;
|
|
3593
4162
|
/** Filters for issues with any of the provided priorities. */
|
|
3594
|
-
|
|
4163
|
+
'issue.priority'?: IssuePriority[];
|
|
3595
4164
|
/**
|
|
3596
4165
|
* Filters for issues with any of the provided Rev organizations.
|
|
3597
4166
|
* @example ["don:identity:<partition>:devo/<dev-org-id>:revo/<rev-org-id>"]
|
|
3598
4167
|
*/
|
|
3599
|
-
|
|
4168
|
+
'issue.rev_orgs'?: string[];
|
|
3600
4169
|
/**
|
|
3601
4170
|
* Filters for opportunities belonging to any of the provided accounts.
|
|
3602
4171
|
* @example ["don:core:<partition>:devo/<dev-org-id>:account/<account-id>"]
|
|
3603
4172
|
*/
|
|
3604
|
-
|
|
4173
|
+
'opportunity.account'?: string[];
|
|
3605
4174
|
/** Filters for opportunities with any of the provided contacts. */
|
|
3606
|
-
|
|
4175
|
+
'opportunity.contacts'?: string[];
|
|
3607
4176
|
/**
|
|
3608
4177
|
* Filters for work owned by any of these users.
|
|
3609
4178
|
* @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
|
|
3610
4179
|
*/
|
|
3611
4180
|
owned_by?: string[];
|
|
3612
4181
|
/** Filters for records in the provided stage(s). */
|
|
3613
|
-
|
|
4182
|
+
'stage.name'?: string[];
|
|
3614
4183
|
/** Filters for tickets belonging to specific groups. */
|
|
3615
|
-
|
|
4184
|
+
'ticket.group'?: string[];
|
|
3616
4185
|
/** Filters for tickets that are spam. */
|
|
3617
|
-
|
|
4186
|
+
'ticket.is_spam'?: boolean;
|
|
3618
4187
|
/** Filters for tickets that need response. */
|
|
3619
|
-
|
|
4188
|
+
'ticket.needs_response'?: boolean;
|
|
3620
4189
|
/**
|
|
3621
4190
|
* Filters for tickets that are associated with any of the provided Rev
|
|
3622
4191
|
* organizations.
|
|
3623
4192
|
* @example ["don:identity:<partition>:devo/<dev-org-id>:revo/<rev-org-id>"]
|
|
3624
4193
|
*/
|
|
3625
|
-
|
|
4194
|
+
'ticket.rev_org'?: string[];
|
|
3626
4195
|
/** Filters for tickets with any of the provided severities. */
|
|
3627
|
-
|
|
4196
|
+
'ticket.severity'?: TicketSeverity[];
|
|
3628
4197
|
/** Filters for tickets with any of the provided source channels. */
|
|
3629
|
-
|
|
4198
|
+
'ticket.source_channel'?: string[];
|
|
3630
4199
|
/** Filters for work of the provided types. */
|
|
3631
4200
|
type?: WorkType[];
|
|
3632
4201
|
}, params?: RequestParams) => Promise<AxiosResponse<WorksExportResponse, any>>;
|
|
@@ -3669,13 +4238,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3669
4238
|
* starts from the beginning.
|
|
3670
4239
|
*/
|
|
3671
4240
|
cursor?: string;
|
|
4241
|
+
/** Filters for custom fields. */
|
|
4242
|
+
custom_fields?: object;
|
|
3672
4243
|
/** Filters for issues with any of the provided priorities. */
|
|
3673
|
-
|
|
4244
|
+
'issue.priority'?: IssuePriority[];
|
|
3674
4245
|
/**
|
|
3675
4246
|
* Filters for issues with any of the provided Rev organizations.
|
|
3676
4247
|
* @example ["don:identity:<partition>:devo/<dev-org-id>:revo/<rev-org-id>"]
|
|
3677
4248
|
*/
|
|
3678
|
-
|
|
4249
|
+
'issue.rev_orgs'?: string[];
|
|
3679
4250
|
/**
|
|
3680
4251
|
* The maximum number of works to return. The default is '50'.
|
|
3681
4252
|
* @format int32
|
|
@@ -3690,32 +4261,32 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3690
4261
|
* Filters for opportunities belonging to any of the provided accounts.
|
|
3691
4262
|
* @example ["don:core:<partition>:devo/<dev-org-id>:account/<account-id>"]
|
|
3692
4263
|
*/
|
|
3693
|
-
|
|
4264
|
+
'opportunity.account'?: string[];
|
|
3694
4265
|
/** Filters for opportunities with any of the provided contacts. */
|
|
3695
|
-
|
|
4266
|
+
'opportunity.contacts'?: string[];
|
|
3696
4267
|
/**
|
|
3697
4268
|
* Filters for work owned by any of these users.
|
|
3698
4269
|
* @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
|
|
3699
4270
|
*/
|
|
3700
4271
|
owned_by?: string[];
|
|
3701
4272
|
/** Filters for records in the provided stage(s). */
|
|
3702
|
-
|
|
4273
|
+
'stage.name'?: string[];
|
|
3703
4274
|
/** Filters for tickets belonging to specific groups. */
|
|
3704
|
-
|
|
4275
|
+
'ticket.group'?: string[];
|
|
3705
4276
|
/** Filters for tickets that are spam. */
|
|
3706
|
-
|
|
4277
|
+
'ticket.is_spam'?: boolean;
|
|
3707
4278
|
/** Filters for tickets that need response. */
|
|
3708
|
-
|
|
4279
|
+
'ticket.needs_response'?: boolean;
|
|
3709
4280
|
/**
|
|
3710
4281
|
* Filters for tickets that are associated with any of the provided Rev
|
|
3711
4282
|
* organizations.
|
|
3712
4283
|
* @example ["don:identity:<partition>:devo/<dev-org-id>:revo/<rev-org-id>"]
|
|
3713
4284
|
*/
|
|
3714
|
-
|
|
4285
|
+
'ticket.rev_org'?: string[];
|
|
3715
4286
|
/** Filters for tickets with any of the provided severities. */
|
|
3716
|
-
|
|
4287
|
+
'ticket.severity'?: TicketSeverity[];
|
|
3717
4288
|
/** Filters for tickets with any of the provided source channels. */
|
|
3718
|
-
|
|
4289
|
+
'ticket.source_channel'?: string[];
|
|
3719
4290
|
/** Filters for work of the provided types. */
|
|
3720
4291
|
type?: WorkType[];
|
|
3721
4292
|
}, params?: RequestParams) => Promise<AxiosResponse<WorksListResponse, any>>;
|