@devrev/typescript-sdk 1.1.4 → 1.1.6
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. */
|
|
@@ -77,6 +80,27 @@ export interface AccountsDeleteRequest {
|
|
|
77
80
|
* The response to deleting an account.
|
|
78
81
|
*/
|
|
79
82
|
export type AccountsDeleteResponse = object;
|
|
83
|
+
/**
|
|
84
|
+
* accounts-export-request
|
|
85
|
+
* The request to export a collection of accounts.
|
|
86
|
+
*/
|
|
87
|
+
export interface AccountsExportRequest {
|
|
88
|
+
/** Filters for accounts created by the specified user(s). */
|
|
89
|
+
created_by?: string[];
|
|
90
|
+
created_date?: DateTimeFilter;
|
|
91
|
+
/** Array of references of accounts to be filtered. */
|
|
92
|
+
external_refs?: string[];
|
|
93
|
+
/**
|
|
94
|
+
* The number of accounts to return. The default is '50'.
|
|
95
|
+
* @format int32
|
|
96
|
+
* @min 1
|
|
97
|
+
* @max 500
|
|
98
|
+
*/
|
|
99
|
+
first?: number;
|
|
100
|
+
modified_date?: DateTimeFilter;
|
|
101
|
+
/** Fields to sort the accounts by and the direction to sort them in. */
|
|
102
|
+
sort_by?: string[];
|
|
103
|
+
}
|
|
80
104
|
/**
|
|
81
105
|
* accounts-export-response
|
|
82
106
|
* The response to exporting a collection of accounts.
|
|
@@ -85,6 +109,17 @@ export interface AccountsExportResponse {
|
|
|
85
109
|
/** The exported accounts. */
|
|
86
110
|
accounts: Account[];
|
|
87
111
|
}
|
|
112
|
+
/**
|
|
113
|
+
* accounts-get-request
|
|
114
|
+
* Request object to get an account's information.
|
|
115
|
+
*/
|
|
116
|
+
export interface AccountsGetRequest {
|
|
117
|
+
/**
|
|
118
|
+
* The ID of the account to be retrieved.
|
|
119
|
+
* @example "don:core:<partition>:devo/<dev-org-id>:account/<account-id>"
|
|
120
|
+
*/
|
|
121
|
+
id: string;
|
|
122
|
+
}
|
|
88
123
|
/**
|
|
89
124
|
* accounts-get-response
|
|
90
125
|
* The returned account.
|
|
@@ -92,6 +127,39 @@ export interface AccountsExportResponse {
|
|
|
92
127
|
export interface AccountsGetResponse {
|
|
93
128
|
account: Account;
|
|
94
129
|
}
|
|
130
|
+
/**
|
|
131
|
+
* accounts-list-request
|
|
132
|
+
* List the accounts.
|
|
133
|
+
*/
|
|
134
|
+
export interface AccountsListRequest {
|
|
135
|
+
/** Filters for accounts created by the specified user(s). */
|
|
136
|
+
created_by?: string[];
|
|
137
|
+
created_date?: DateTimeFilter;
|
|
138
|
+
/**
|
|
139
|
+
* The cursor to resume iteration from. If not provided, then
|
|
140
|
+
* iteration starts from the beginning.
|
|
141
|
+
*/
|
|
142
|
+
cursor?: string;
|
|
143
|
+
/** Array of references of accounts to be filtered. */
|
|
144
|
+
external_refs?: string[];
|
|
145
|
+
/**
|
|
146
|
+
* The maximum number of accounts to return per page. The default is
|
|
147
|
+
* '50'.
|
|
148
|
+
* @format int32
|
|
149
|
+
*/
|
|
150
|
+
limit?: number;
|
|
151
|
+
/**
|
|
152
|
+
* The iteration mode to use. If "after", then entries after the provided
|
|
153
|
+
* cursor will be returned, or if no cursor is provided, then from the
|
|
154
|
+
* beginning. If "before", then entries before the provided cursor will be
|
|
155
|
+
* returned, or if no cursor is provided, then from the end. Entries will
|
|
156
|
+
* always be returned in the specified sort-by order.
|
|
157
|
+
*/
|
|
158
|
+
mode?: ListMode;
|
|
159
|
+
modified_date?: DateTimeFilter;
|
|
160
|
+
/** Fields to sort the accounts by and the direction to sort them in. */
|
|
161
|
+
sort_by?: string[];
|
|
162
|
+
}
|
|
95
163
|
/**
|
|
96
164
|
* accounts-list-response
|
|
97
165
|
* The response to listing all accounts matching the filter criteria.
|
|
@@ -126,7 +194,6 @@ export interface AccountsUpdateRequest {
|
|
|
126
194
|
/**
|
|
127
195
|
* Updated External Refs of account. Currently the length of this
|
|
128
196
|
* field is limited to 1.
|
|
129
|
-
* @maxItems 1
|
|
130
197
|
*/
|
|
131
198
|
external_refs?: string[];
|
|
132
199
|
/**
|
|
@@ -156,6 +223,15 @@ export interface AccountsUpdateResponse {
|
|
|
156
223
|
* List of custom fields from multiple source fragments.
|
|
157
224
|
*/
|
|
158
225
|
export type AggregatedSchema = object;
|
|
226
|
+
/** aggregated-schema-get-request */
|
|
227
|
+
export interface AggregatedSchemaGetRequest {
|
|
228
|
+
/** The list of custom schema fragment DONs which are to be aggregated. */
|
|
229
|
+
custom_schema_fragment_ids: string[];
|
|
230
|
+
/** Per object schema, if associated with the leaf type. */
|
|
231
|
+
per_object_schema?: FieldDescriptor[];
|
|
232
|
+
/** The stock schema fragment which is to be aggregated. */
|
|
233
|
+
stock_schema_fragment_id?: string;
|
|
234
|
+
}
|
|
159
235
|
/** aggregated-schema-get-response */
|
|
160
236
|
export interface AggregatedSchemaGetResponse {
|
|
161
237
|
/** List of custom fields from multiple source fragments. */
|
|
@@ -196,6 +272,8 @@ export type Conversation = AtomBase & {
|
|
|
196
272
|
/** Description of the conversation object. */
|
|
197
273
|
description?: string;
|
|
198
274
|
group?: GroupSummary;
|
|
275
|
+
/** The users in the conversation. */
|
|
276
|
+
members: UserSummary[];
|
|
199
277
|
/** The latest messages on the conversation. */
|
|
200
278
|
messages?: TimelineEntry[];
|
|
201
279
|
/** Metadata on conversation. */
|
|
@@ -291,11 +369,64 @@ export interface ConversationsDeleteRequest {
|
|
|
291
369
|
* The response for deleting a conversation.
|
|
292
370
|
*/
|
|
293
371
|
export type ConversationsDeleteResponse = object;
|
|
372
|
+
/** conversations-export-request */
|
|
373
|
+
export interface ConversationsExportRequest {
|
|
374
|
+
/**
|
|
375
|
+
* Filters for conversations belonging to any of the provided parts.
|
|
376
|
+
* @example ["don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"]
|
|
377
|
+
*/
|
|
378
|
+
applies_to_parts?: string[];
|
|
379
|
+
/**
|
|
380
|
+
* The number of conversation items to return. The default is '50',
|
|
381
|
+
* the maximum is '5000'.
|
|
382
|
+
* @format int32
|
|
383
|
+
*/
|
|
384
|
+
first?: number;
|
|
385
|
+
/** Filters for conversation that belong to the given groups. */
|
|
386
|
+
group?: string[];
|
|
387
|
+
/** Filters for conversations that are spam. */
|
|
388
|
+
is_spam?: boolean;
|
|
389
|
+
/**
|
|
390
|
+
* Filters for conversations where these users are participants.
|
|
391
|
+
* @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
|
|
392
|
+
*/
|
|
393
|
+
members?: string[];
|
|
394
|
+
/**
|
|
395
|
+
* Filters for conversations owned by any of these users.
|
|
396
|
+
* @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
|
|
397
|
+
*/
|
|
398
|
+
owned_by?: string[];
|
|
399
|
+
/**
|
|
400
|
+
* Filters for conversations that are associated with any of the
|
|
401
|
+
* provided Rev organizations.
|
|
402
|
+
* @example ["don:identity:<partition>:devo/<dev-org-id>:revo/<rev-org-id>"]
|
|
403
|
+
*/
|
|
404
|
+
rev_org?: string[];
|
|
405
|
+
/** The filter for SLA summary. */
|
|
406
|
+
sla_summary?: SlaSummaryFilter;
|
|
407
|
+
/** Filters for conversations with any of the provided source channels. */
|
|
408
|
+
source_channels?: string[];
|
|
409
|
+
/** The filter for stages. */
|
|
410
|
+
stage?: StageFilter;
|
|
411
|
+
/**
|
|
412
|
+
* Filters for conversations with any of the provided tags.
|
|
413
|
+
* @example ["don:core:<partition>:devo/<dev-org-id>:tag/<tag-id>"]
|
|
414
|
+
*/
|
|
415
|
+
tags?: string[];
|
|
416
|
+
}
|
|
294
417
|
/** conversations-export-response */
|
|
295
418
|
export interface ConversationsExportResponse {
|
|
296
419
|
/** The resulting collection of conversation items. */
|
|
297
420
|
conversations: Conversation[];
|
|
298
421
|
}
|
|
422
|
+
/**
|
|
423
|
+
* conversations-get-request
|
|
424
|
+
* The request to get a conversation's information.
|
|
425
|
+
*/
|
|
426
|
+
export interface ConversationsGetRequest {
|
|
427
|
+
/** The requested conversation's ID. */
|
|
428
|
+
id: string;
|
|
429
|
+
}
|
|
299
430
|
/**
|
|
300
431
|
* conversations-get-response
|
|
301
432
|
* The response to getting a conversation's information.
|
|
@@ -303,6 +434,66 @@ export interface ConversationsExportResponse {
|
|
|
303
434
|
export interface ConversationsGetResponse {
|
|
304
435
|
conversation: Conversation;
|
|
305
436
|
}
|
|
437
|
+
/**
|
|
438
|
+
* conversations-list-request
|
|
439
|
+
* The request to get information about a list of conversations.
|
|
440
|
+
*/
|
|
441
|
+
export interface ConversationsListRequest {
|
|
442
|
+
/**
|
|
443
|
+
* Filters for conversations belonging to any of the provided parts.
|
|
444
|
+
* @example ["don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"]
|
|
445
|
+
*/
|
|
446
|
+
applies_to_parts?: string[];
|
|
447
|
+
/**
|
|
448
|
+
* The cursor to resume iteration from. If not provided, then
|
|
449
|
+
* iteration starts from the beginning.
|
|
450
|
+
*/
|
|
451
|
+
cursor?: string;
|
|
452
|
+
/** Filters for conversation that belong to the given groups. */
|
|
453
|
+
group?: string[];
|
|
454
|
+
/** Filters for conversations that are spam. */
|
|
455
|
+
is_spam?: boolean;
|
|
456
|
+
/**
|
|
457
|
+
* The maximum number of conversations to return. The default is '50'.
|
|
458
|
+
* @format int32
|
|
459
|
+
*/
|
|
460
|
+
limit?: number;
|
|
461
|
+
/**
|
|
462
|
+
* Filters for conversations where these users are participants.
|
|
463
|
+
* @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
|
|
464
|
+
*/
|
|
465
|
+
members?: string[];
|
|
466
|
+
/**
|
|
467
|
+
* The iteration mode to use. If "after", then entries after the provided
|
|
468
|
+
* cursor will be returned, or if no cursor is provided, then from the
|
|
469
|
+
* beginning. If "before", then entries before the provided cursor will be
|
|
470
|
+
* returned, or if no cursor is provided, then from the end. Entries will
|
|
471
|
+
* always be returned in the specified sort-by order.
|
|
472
|
+
*/
|
|
473
|
+
mode?: ListMode;
|
|
474
|
+
/**
|
|
475
|
+
* Filters for conversations owned by any of these users.
|
|
476
|
+
* @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
|
|
477
|
+
*/
|
|
478
|
+
owned_by?: string[];
|
|
479
|
+
/**
|
|
480
|
+
* Filters for conversations that are associated with any of the
|
|
481
|
+
* provided Rev organizations.
|
|
482
|
+
* @example ["don:identity:<partition>:devo/<dev-org-id>:revo/<rev-org-id>"]
|
|
483
|
+
*/
|
|
484
|
+
rev_org?: string[];
|
|
485
|
+
/** The filter for SLA summary. */
|
|
486
|
+
sla_summary?: SlaSummaryFilter;
|
|
487
|
+
/** Filters for conversations with any of the provided source channels. */
|
|
488
|
+
source_channels?: string[];
|
|
489
|
+
/** The filter for stages. */
|
|
490
|
+
stage?: StageFilter;
|
|
491
|
+
/**
|
|
492
|
+
* Filters for conversations with any of the provided tags.
|
|
493
|
+
* @example ["don:core:<partition>:devo/<dev-org-id>:tag/<tag-id>"]
|
|
494
|
+
*/
|
|
495
|
+
tags?: string[];
|
|
496
|
+
}
|
|
306
497
|
/**
|
|
307
498
|
* conversations-list-response
|
|
308
499
|
* The response to listing the conversations.
|
|
@@ -374,6 +565,46 @@ export interface ConversationsUpdateRequestUserSessions {
|
|
|
374
565
|
export interface ConversationsUpdateResponse {
|
|
375
566
|
conversation: Conversation;
|
|
376
567
|
}
|
|
568
|
+
/** create-org-schedule-interval */
|
|
569
|
+
export interface CreateOrgScheduleInterval {
|
|
570
|
+
/**
|
|
571
|
+
* Date (inclusive) on which the interval begins.
|
|
572
|
+
* @format date-time
|
|
573
|
+
*/
|
|
574
|
+
from: string;
|
|
575
|
+
/**
|
|
576
|
+
* If true, no organization schedule is looked up for these days and
|
|
577
|
+
* they are marked as holidays.
|
|
578
|
+
*/
|
|
579
|
+
is_excluded?: boolean;
|
|
580
|
+
/**
|
|
581
|
+
* The name of the period, for example the event or holiday it
|
|
582
|
+
* represents.
|
|
583
|
+
*/
|
|
584
|
+
name: string;
|
|
585
|
+
/**
|
|
586
|
+
* Date (exclusive) on which the interval ends. If omitted, it is a
|
|
587
|
+
* single day interval.
|
|
588
|
+
* @format date-time
|
|
589
|
+
*/
|
|
590
|
+
to?: string;
|
|
591
|
+
}
|
|
592
|
+
/** create-weekly-org-schedule-interval */
|
|
593
|
+
export interface CreateWeeklyOrgScheduleInterval {
|
|
594
|
+
/**
|
|
595
|
+
* Duration in minutes of the week when the interval starts. 0 is
|
|
596
|
+
* Sunday midnight, when Sunday ends and Monday begins.
|
|
597
|
+
* @format int64
|
|
598
|
+
*/
|
|
599
|
+
from: number;
|
|
600
|
+
/**
|
|
601
|
+
* Duration in minutes of the week when the interval ends (must be
|
|
602
|
+
* larger than 'from'). 0 is Sunday midnight, when Sunday ends and
|
|
603
|
+
* Monday begins.
|
|
604
|
+
* @format int64
|
|
605
|
+
*/
|
|
606
|
+
to: number;
|
|
607
|
+
}
|
|
377
608
|
/** custom-schema-fragment */
|
|
378
609
|
export interface CustomSchemaFragment {
|
|
379
610
|
type: CustomSchemaFragmentType;
|
|
@@ -384,10 +615,38 @@ export interface CustomSchemaFragment {
|
|
|
384
615
|
*/
|
|
385
616
|
export type CustomSchemaFragmentCondition = object;
|
|
386
617
|
export type CustomSchemaFragmentType = string;
|
|
618
|
+
/** custom-schema-fragments-get-request */
|
|
619
|
+
export interface CustomSchemaFragmentsGetRequest {
|
|
620
|
+
/** The ID of the custom schema fragment. */
|
|
621
|
+
id: string;
|
|
622
|
+
}
|
|
387
623
|
/** custom-schema-fragments-get-response */
|
|
388
624
|
export interface CustomSchemaFragmentsGetResponse {
|
|
389
625
|
fragment: CustomSchemaFragment;
|
|
390
626
|
}
|
|
627
|
+
/** custom-schema-fragments-list-request */
|
|
628
|
+
export interface CustomSchemaFragmentsListRequest {
|
|
629
|
+
/** The list of app names. */
|
|
630
|
+
app?: string[];
|
|
631
|
+
/**
|
|
632
|
+
* The cursor to resume iteration from, otherwise if not provided,
|
|
633
|
+
* then iteration starts from the beginning.
|
|
634
|
+
*/
|
|
635
|
+
cursor?: string;
|
|
636
|
+
/** The list of leaf types. */
|
|
637
|
+
leaf_type?: string[];
|
|
638
|
+
/**
|
|
639
|
+
* The maximum number of items.
|
|
640
|
+
* @format int32
|
|
641
|
+
*/
|
|
642
|
+
limit?: number;
|
|
643
|
+
/** The list of fields to sort the items by and how to sort them. */
|
|
644
|
+
sort_by?: string[];
|
|
645
|
+
/** The list of subtypes. */
|
|
646
|
+
subtype?: string[];
|
|
647
|
+
/** Filters for custom schema fragment of the provided types. */
|
|
648
|
+
types?: CustomSchemaFragmentType[];
|
|
649
|
+
}
|
|
391
650
|
/** custom-schema-fragments-list-response */
|
|
392
651
|
export interface CustomSchemaFragmentsListResponse {
|
|
393
652
|
/**
|
|
@@ -402,7 +661,9 @@ export interface CustomSchemaFragmentsListResponse {
|
|
|
402
661
|
export type CustomSchemaFragmentsSetRequest = (CustomSchemaFragmentsSetRequestAppFragment | CustomSchemaFragmentsSetRequestCustomTypeFragment | CustomSchemaFragmentsSetRequestTenantFragment) & {
|
|
403
662
|
/** List of conditions for this fragment. */
|
|
404
663
|
conditions?: CustomSchemaFragmentCondition[];
|
|
405
|
-
/**
|
|
664
|
+
/** List of field names which are being dropped. */
|
|
665
|
+
deleted_fields?: string[];
|
|
666
|
+
/** Whether this fragment has been deprecated. */
|
|
406
667
|
deprecated?: boolean;
|
|
407
668
|
/** The description of the custom schema fragment. */
|
|
408
669
|
description: string;
|
|
@@ -421,6 +682,8 @@ export interface CustomSchemaFragmentsSetRequestAppFragment {
|
|
|
421
682
|
}
|
|
422
683
|
/** custom-schema-fragments-set-request-custom-type-fragment */
|
|
423
684
|
export interface CustomSchemaFragmentsSetRequestCustomTypeFragment {
|
|
685
|
+
/** The ID of the associated custom stage diagram. */
|
|
686
|
+
stage_diagram?: string;
|
|
424
687
|
/** List of stock field enum overrides. */
|
|
425
688
|
stock_field_enum_overrides?: StockFieldEnumOverride[];
|
|
426
689
|
/** The string used to populate the subtype in the leaf type. */
|
|
@@ -440,6 +703,67 @@ export interface CustomSchemaFragmentsSetResponse {
|
|
|
440
703
|
/** The ID of the custom schema fragment. */
|
|
441
704
|
id: string;
|
|
442
705
|
}
|
|
706
|
+
/**
|
|
707
|
+
* date-filter
|
|
708
|
+
* Provides ways to specify date ranges on objects.
|
|
709
|
+
*/
|
|
710
|
+
export type DateFilter = (DateTimeFilter | DateTimePreset) & {
|
|
711
|
+
/** Type of date filter. */
|
|
712
|
+
type: DateFilterType;
|
|
713
|
+
};
|
|
714
|
+
/** Type of date filter. */
|
|
715
|
+
export declare enum DateFilterType {
|
|
716
|
+
Preset = "preset",
|
|
717
|
+
Range = "range"
|
|
718
|
+
}
|
|
719
|
+
/** date-time-filter */
|
|
720
|
+
export interface DateTimeFilter {
|
|
721
|
+
/**
|
|
722
|
+
* Filters for objects created after the provided timestamp
|
|
723
|
+
* (inclusive).
|
|
724
|
+
* @format date-time
|
|
725
|
+
*/
|
|
726
|
+
after?: string;
|
|
727
|
+
/**
|
|
728
|
+
* Filters for objects created before the provided timestamp
|
|
729
|
+
* (inclusive).
|
|
730
|
+
* @format date-time
|
|
731
|
+
*/
|
|
732
|
+
before?: string;
|
|
733
|
+
}
|
|
734
|
+
/**
|
|
735
|
+
* date-time-preset
|
|
736
|
+
* Provides preset types for date filter.
|
|
737
|
+
*/
|
|
738
|
+
export type DateTimePreset = (DateTimePresetLastNDays | DateTimePresetNextNDays) & {
|
|
739
|
+
/** Type of date preset. */
|
|
740
|
+
preset_type: DateTimePresetType;
|
|
741
|
+
};
|
|
742
|
+
/** date-time-preset-last-n-days */
|
|
743
|
+
export interface DateTimePresetLastNDays {
|
|
744
|
+
/**
|
|
745
|
+
* The range starts from the current timestamp and continues for the
|
|
746
|
+
* past n days.
|
|
747
|
+
* @min 0
|
|
748
|
+
* @max 4294967295
|
|
749
|
+
*/
|
|
750
|
+
days: number;
|
|
751
|
+
}
|
|
752
|
+
/** date-time-preset-next-n-days */
|
|
753
|
+
export interface DateTimePresetNextNDays {
|
|
754
|
+
/**
|
|
755
|
+
* The range starts from the current timestamp and continues for the
|
|
756
|
+
* next n days.
|
|
757
|
+
* @min 0
|
|
758
|
+
* @max 4294967295
|
|
759
|
+
*/
|
|
760
|
+
days: number;
|
|
761
|
+
}
|
|
762
|
+
/** Type of date preset. */
|
|
763
|
+
export declare enum DateTimePresetType {
|
|
764
|
+
LastNDays = "last_n_days",
|
|
765
|
+
NextNDays = "next_n_days"
|
|
766
|
+
}
|
|
443
767
|
/** dev-user-summary */
|
|
444
768
|
export type DevUserSummary = UserBaseSummary;
|
|
445
769
|
/** empty */
|
|
@@ -449,6 +773,33 @@ export type Engagement = AtomBase & {
|
|
|
449
773
|
/** Description of the engagement object. */
|
|
450
774
|
description?: string;
|
|
451
775
|
};
|
|
776
|
+
/** Type of engagement. */
|
|
777
|
+
export declare enum EngagementType {
|
|
778
|
+
Call = "call",
|
|
779
|
+
Default = "default",
|
|
780
|
+
Email = "email",
|
|
781
|
+
LinkedIn = "linked_in",
|
|
782
|
+
Meeting = "meeting",
|
|
783
|
+
Offline = "offline",
|
|
784
|
+
Survey = "survey"
|
|
785
|
+
}
|
|
786
|
+
/** engagements-count-request */
|
|
787
|
+
export interface EngagementsCountRequest {
|
|
788
|
+
/** Filters for meetings with the provided external_refs. */
|
|
789
|
+
external_ref?: string[];
|
|
790
|
+
/**
|
|
791
|
+
* Filters for engagement of the provided members.
|
|
792
|
+
* @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
|
|
793
|
+
*/
|
|
794
|
+
members?: string[];
|
|
795
|
+
/**
|
|
796
|
+
* Filters for engagements with the provided parent.
|
|
797
|
+
* @example ["don:core:<partition>:devo/<dev-org-id>:account/<account-id>"]
|
|
798
|
+
*/
|
|
799
|
+
parent?: string[];
|
|
800
|
+
/** Filters for engagement of the provided types. */
|
|
801
|
+
type?: EngagementType[];
|
|
802
|
+
}
|
|
452
803
|
/** engagements-count-response */
|
|
453
804
|
export interface EngagementsCountResponse {
|
|
454
805
|
/**
|
|
@@ -459,10 +810,17 @@ export interface EngagementsCountResponse {
|
|
|
459
810
|
}
|
|
460
811
|
/** engagements-create-request */
|
|
461
812
|
export interface EngagementsCreateRequest {
|
|
813
|
+
/**
|
|
814
|
+
* The IDs of the artifacts to associate with the engagement.
|
|
815
|
+
* @example ["don:core:<partition>:devo/<dev-org-id>:artifact/<artifact-id>"]
|
|
816
|
+
*/
|
|
817
|
+
artifacts?: string[];
|
|
462
818
|
/** The description of the engagement. */
|
|
463
819
|
description?: string;
|
|
464
820
|
/** The type of engagement. */
|
|
465
821
|
engagement_type?: EngagementsCreateRequestEngagementType;
|
|
822
|
+
/** External Reference for the engagement. */
|
|
823
|
+
external_ref?: string;
|
|
466
824
|
/** External URL for the engagement. */
|
|
467
825
|
external_url?: string;
|
|
468
826
|
/**
|
|
@@ -490,6 +848,7 @@ export interface EngagementsCreateRequest {
|
|
|
490
848
|
/** The type of engagement. */
|
|
491
849
|
export declare enum EngagementsCreateRequestEngagementType {
|
|
492
850
|
Call = "call",
|
|
851
|
+
Default = "default",
|
|
493
852
|
Email = "email",
|
|
494
853
|
LinkedIn = "linked_in",
|
|
495
854
|
Offline = "offline"
|
|
@@ -505,10 +864,52 @@ export interface EngagementsDeleteRequest {
|
|
|
505
864
|
}
|
|
506
865
|
/** engagements-delete-response */
|
|
507
866
|
export type EngagementsDeleteResponse = object;
|
|
867
|
+
/** engagements-get-request */
|
|
868
|
+
export interface EngagementsGetRequest {
|
|
869
|
+
/** The engagement ID. */
|
|
870
|
+
id: string;
|
|
871
|
+
}
|
|
508
872
|
/** engagements-get-response */
|
|
509
873
|
export interface EngagementsGetResponse {
|
|
510
874
|
engagement: Engagement;
|
|
511
875
|
}
|
|
876
|
+
/** engagements-list-request */
|
|
877
|
+
export interface EngagementsListRequest {
|
|
878
|
+
/**
|
|
879
|
+
* The cursor to resume iteration from. If not provided, then
|
|
880
|
+
* iteration starts from the beginning.
|
|
881
|
+
*/
|
|
882
|
+
cursor?: string;
|
|
883
|
+
/** Filters for meetings with the provided external_refs. */
|
|
884
|
+
external_ref?: string[];
|
|
885
|
+
/**
|
|
886
|
+
* The maximum number of engagements to return.
|
|
887
|
+
* @format int32
|
|
888
|
+
*/
|
|
889
|
+
limit?: number;
|
|
890
|
+
/**
|
|
891
|
+
* Filters for engagement of the provided members.
|
|
892
|
+
* @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
|
|
893
|
+
*/
|
|
894
|
+
members?: string[];
|
|
895
|
+
/**
|
|
896
|
+
* The iteration mode to use. If "after", then entries after the provided
|
|
897
|
+
* cursor will be returned, or if no cursor is provided, then from the
|
|
898
|
+
* beginning. If "before", then entries before the provided cursor will be
|
|
899
|
+
* returned, or if no cursor is provided, then from the end. Entries will
|
|
900
|
+
* always be returned in the specified sort-by order.
|
|
901
|
+
*/
|
|
902
|
+
mode?: ListMode;
|
|
903
|
+
/**
|
|
904
|
+
* Filters for engagements with the provided parent.
|
|
905
|
+
* @example ["don:core:<partition>:devo/<dev-org-id>:account/<account-id>"]
|
|
906
|
+
*/
|
|
907
|
+
parent?: string[];
|
|
908
|
+
/** Fields to sort the engagements by and the direction to sort them. */
|
|
909
|
+
sort_by?: string[];
|
|
910
|
+
/** Filters for engagement of the provided types. */
|
|
911
|
+
type?: EngagementType[];
|
|
912
|
+
}
|
|
512
913
|
/** engagements-list-response */
|
|
513
914
|
export interface EngagementsListResponse {
|
|
514
915
|
/** The list of engagements. */
|
|
@@ -526,8 +927,11 @@ export interface EngagementsListResponse {
|
|
|
526
927
|
}
|
|
527
928
|
/** engagements-update-request */
|
|
528
929
|
export interface EngagementsUpdateRequest {
|
|
930
|
+
artifacts?: EngagementsUpdateRequestArtifactIds;
|
|
529
931
|
/** Updates the description of the engagement. */
|
|
530
932
|
description?: string;
|
|
933
|
+
/** External Reference for the engagement. */
|
|
934
|
+
external_ref?: string;
|
|
531
935
|
/** Updates the external URL for the engagement. */
|
|
532
936
|
external_url?: string;
|
|
533
937
|
/** The engagement ID. */
|
|
@@ -542,6 +946,14 @@ export interface EngagementsUpdateRequest {
|
|
|
542
946
|
/** Updates the title of the engagement. */
|
|
543
947
|
title?: string;
|
|
544
948
|
}
|
|
949
|
+
/** engagements-update-request-artifact-ids */
|
|
950
|
+
export interface EngagementsUpdateRequestArtifactIds {
|
|
951
|
+
/**
|
|
952
|
+
* Sets the IDs to the provided artifact IDs.
|
|
953
|
+
* @example ["don:core:<partition>:devo/<dev-org-id>:artifact/<artifact-id>"]
|
|
954
|
+
*/
|
|
955
|
+
set?: string[];
|
|
956
|
+
}
|
|
545
957
|
/** engagements-update-request-members */
|
|
546
958
|
export interface EngagementsUpdateRequestMembers {
|
|
547
959
|
/**
|
|
@@ -736,6 +1148,11 @@ export interface EventSourcesScheduleEventResponse {
|
|
|
736
1148
|
}
|
|
737
1149
|
/** feature-summary */
|
|
738
1150
|
export type FeatureSummary = PartBaseSummary;
|
|
1151
|
+
/**
|
|
1152
|
+
* field-descriptor
|
|
1153
|
+
* Set of field attributes.
|
|
1154
|
+
*/
|
|
1155
|
+
export type FieldDescriptor = object;
|
|
739
1156
|
/** group-summary */
|
|
740
1157
|
export type GroupSummary = AtomBaseSummary;
|
|
741
1158
|
/** issue */
|
|
@@ -763,7 +1180,7 @@ export type Link = AtomBase & {
|
|
|
763
1180
|
target: LinkEndpointSummary;
|
|
764
1181
|
};
|
|
765
1182
|
/** link-endpoint-summary */
|
|
766
|
-
export type LinkEndpointSummary = (CapabilitySummary | ConversationSummary | EnhancementSummary | FeatureSummary | IssueSummary | OpportunitySummary | ProductSummary | TicketSummary) & {
|
|
1183
|
+
export type LinkEndpointSummary = (CapabilitySummary | ConversationSummary | EnhancementSummary | FeatureSummary | IssueSummary | OpportunitySummary | ProductSummary | TaskSummary | TicketSummary) & {
|
|
767
1184
|
type: LinkEndpointType;
|
|
768
1185
|
};
|
|
769
1186
|
export declare enum LinkEndpointType {
|
|
@@ -774,6 +1191,7 @@ export declare enum LinkEndpointType {
|
|
|
774
1191
|
Issue = "issue",
|
|
775
1192
|
Opportunity = "opportunity",
|
|
776
1193
|
Product = "product",
|
|
1194
|
+
Task = "task",
|
|
777
1195
|
Ticket = "ticket"
|
|
778
1196
|
}
|
|
779
1197
|
/**
|
|
@@ -848,6 +1266,14 @@ export declare enum LinksDirection {
|
|
|
848
1266
|
IsSource = "is_source",
|
|
849
1267
|
IsTarget = "is_target"
|
|
850
1268
|
}
|
|
1269
|
+
/**
|
|
1270
|
+
* links-get-request
|
|
1271
|
+
* The request to get a link's information.
|
|
1272
|
+
*/
|
|
1273
|
+
export interface LinksGetRequest {
|
|
1274
|
+
/** The requested link's ID. */
|
|
1275
|
+
id: string;
|
|
1276
|
+
}
|
|
851
1277
|
/**
|
|
852
1278
|
* links-get-response
|
|
853
1279
|
* The response to getting a link's information.
|
|
@@ -855,6 +1281,50 @@ export declare enum LinksDirection {
|
|
|
855
1281
|
export interface LinksGetResponse {
|
|
856
1282
|
link: Link;
|
|
857
1283
|
}
|
|
1284
|
+
/**
|
|
1285
|
+
* links-list-request
|
|
1286
|
+
* The request to get information about a list of links.
|
|
1287
|
+
*/
|
|
1288
|
+
export interface LinksListRequest {
|
|
1289
|
+
/**
|
|
1290
|
+
* The cursor to resume iteration from. If not provided, then
|
|
1291
|
+
* iteration starts from the beginning.
|
|
1292
|
+
*/
|
|
1293
|
+
cursor?: string;
|
|
1294
|
+
/**
|
|
1295
|
+
* The direction of link, which can either be outbound such that the
|
|
1296
|
+
* object is the source of the link, otherwise inbound where the object is
|
|
1297
|
+
* the target of the link.
|
|
1298
|
+
*/
|
|
1299
|
+
direction?: LinksDirection;
|
|
1300
|
+
/**
|
|
1301
|
+
* The maximum number of links to return. If not set, then the default
|
|
1302
|
+
* is '50'.
|
|
1303
|
+
* @format int32
|
|
1304
|
+
*/
|
|
1305
|
+
limit?: number;
|
|
1306
|
+
/**
|
|
1307
|
+
* The link type(s) to filter for, otherwise if not present, all link
|
|
1308
|
+
* types are included.
|
|
1309
|
+
*/
|
|
1310
|
+
link_type?: LinkType[];
|
|
1311
|
+
/**
|
|
1312
|
+
* The iteration mode to use. If "after", then entries after the provided
|
|
1313
|
+
* cursor will be returned, or if no cursor is provided, then from the
|
|
1314
|
+
* beginning. If "before", then entries before the provided cursor will be
|
|
1315
|
+
* returned, or if no cursor is provided, then from the end. Entries will
|
|
1316
|
+
* always be returned in the specified sort-by order.
|
|
1317
|
+
*/
|
|
1318
|
+
mode?: ListMode;
|
|
1319
|
+
/** The ID of the object to list the links for. */
|
|
1320
|
+
object: string;
|
|
1321
|
+
/**
|
|
1322
|
+
* The link types to filter for, otherwise if not present, all link
|
|
1323
|
+
* types are included.
|
|
1324
|
+
* @deprecated
|
|
1325
|
+
*/
|
|
1326
|
+
types?: LinkType[];
|
|
1327
|
+
}
|
|
858
1328
|
/**
|
|
859
1329
|
* links-list-response
|
|
860
1330
|
* The response to listing the links.
|
|
@@ -903,46 +1373,394 @@ export declare enum MetricDefinitionMetricType {
|
|
|
903
1373
|
Time = "time",
|
|
904
1374
|
Value = "value"
|
|
905
1375
|
}
|
|
906
|
-
/** metric-definitions-list-
|
|
907
|
-
export interface
|
|
908
|
-
/** The
|
|
909
|
-
|
|
1376
|
+
/** metric-definitions-list-request */
|
|
1377
|
+
export interface MetricDefinitionsListRequest {
|
|
1378
|
+
/** The type of objects the metric definition applies to. */
|
|
1379
|
+
applies_to_type?: MetricDefinitionAppliesTo[];
|
|
1380
|
+
/**
|
|
1381
|
+
* The cursor to resume iteration from. If not provided, then
|
|
1382
|
+
* iteration starts from the beginning.
|
|
1383
|
+
*/
|
|
1384
|
+
cursor?: string;
|
|
1385
|
+
/**
|
|
1386
|
+
* The maximum number of records to return. The default is '50'.
|
|
1387
|
+
* @format int32
|
|
1388
|
+
*/
|
|
1389
|
+
limit?: number;
|
|
1390
|
+
/**
|
|
1391
|
+
* The iteration mode to use. If "after", then entries after the provided
|
|
1392
|
+
* cursor will be returned, or if no cursor is provided, then from the
|
|
1393
|
+
* beginning. If "before", then entries before the provided cursor will be
|
|
1394
|
+
* returned, or if no cursor is provided, then from the end. Entries will
|
|
1395
|
+
* always be returned in the specified sort-by order.
|
|
1396
|
+
*/
|
|
1397
|
+
mode?: ListMode;
|
|
1398
|
+
/** The type of metric definitions sought. */
|
|
1399
|
+
type?: MetricDefinitionMetricType[];
|
|
1400
|
+
}
|
|
1401
|
+
/** metric-definitions-list-response */
|
|
1402
|
+
export interface MetricDefinitionsListResponse {
|
|
1403
|
+
/** The list of metric definitions. */
|
|
1404
|
+
metric_definitions: MetricDefinition[];
|
|
1405
|
+
/**
|
|
1406
|
+
* The cursor used to iterate subsequent results in accordance to the
|
|
1407
|
+
* sort order. If not set, then no later elements exist.
|
|
1408
|
+
*/
|
|
1409
|
+
next_cursor?: string;
|
|
1410
|
+
/**
|
|
1411
|
+
* The cursor used to iterate preceding results in accordance to the
|
|
1412
|
+
* sort order. If not set, then no prior elements exist.
|
|
1413
|
+
*/
|
|
1414
|
+
prev_cursor?: string;
|
|
1415
|
+
}
|
|
1416
|
+
/** opportunity */
|
|
1417
|
+
export type Opportunity = WorkBase;
|
|
1418
|
+
/** Forecast category of the opportunity. */
|
|
1419
|
+
export declare enum OpportunityForecastCategory {
|
|
1420
|
+
BestCase = "best_case",
|
|
1421
|
+
Commit = "commit",
|
|
1422
|
+
MostLikely = "most_likely",
|
|
1423
|
+
Omitted = "omitted",
|
|
1424
|
+
Pipeline = "pipeline",
|
|
1425
|
+
Won = "won"
|
|
1426
|
+
}
|
|
1427
|
+
/** Priority of the opportunity. */
|
|
1428
|
+
export declare enum OpportunityPriority {
|
|
1429
|
+
P0 = "p0",
|
|
1430
|
+
P1 = "p1",
|
|
1431
|
+
P2 = "p2",
|
|
1432
|
+
P3 = "p3"
|
|
1433
|
+
}
|
|
1434
|
+
/** opportunity-summary */
|
|
1435
|
+
export type OpportunitySummary = WorkBaseSummary;
|
|
1436
|
+
/** org-base */
|
|
1437
|
+
export type OrgBase = AtomBase & {
|
|
1438
|
+
/** Name of the Organization. */
|
|
1439
|
+
display_name?: string;
|
|
1440
|
+
};
|
|
1441
|
+
/** org-base-summary */
|
|
1442
|
+
export type OrgBaseSummary = AtomBaseSummary & {
|
|
1443
|
+
/** Name of the Organization. */
|
|
1444
|
+
display_name?: string;
|
|
1445
|
+
};
|
|
1446
|
+
/** The environment of the Org. Defaults to 'production' if not specified. */
|
|
1447
|
+
export declare enum OrgEnvironment {
|
|
1448
|
+
Production = "production",
|
|
1449
|
+
Staging = "staging",
|
|
1450
|
+
Test = "test"
|
|
1451
|
+
}
|
|
1452
|
+
/** org-schedule */
|
|
1453
|
+
export type OrgSchedule = AtomBase & {
|
|
1454
|
+
/** The schedule for each week. */
|
|
1455
|
+
default_weekly_org_schedule?: WeeklyOrgSchedule;
|
|
1456
|
+
/**
|
|
1457
|
+
* The schedule must be valid and well-defined for at least this many
|
|
1458
|
+
* days in the future, otherwise a warning notification is generated.
|
|
1459
|
+
* Default is 0 if not specified.
|
|
1460
|
+
* @format int32
|
|
1461
|
+
*/
|
|
1462
|
+
min_valid_days?: number;
|
|
1463
|
+
/** Human-readable name. */
|
|
1464
|
+
name?: string;
|
|
1465
|
+
/**
|
|
1466
|
+
* The list of schedule fragments. It must be an ordered list of
|
|
1467
|
+
* contiguous fragments (the next starting when the previous one
|
|
1468
|
+
* ends), updates in a published schedule are only allowed to add new
|
|
1469
|
+
* ones to the future.
|
|
1470
|
+
*/
|
|
1471
|
+
org_schedule_fragments?: OrgScheduleFragmentOverview[];
|
|
1472
|
+
/**
|
|
1473
|
+
* Status determines how an item can be used. In 'draft' status an item
|
|
1474
|
+
* can be edited but can't be used. When 'published' the item can longer
|
|
1475
|
+
* be edited but can be used. 'Archived' is read-only.
|
|
1476
|
+
*/
|
|
1477
|
+
status: OrgScheduleStatus;
|
|
1478
|
+
/**
|
|
1479
|
+
* Timezone in which this is defined. Only organization schedules in
|
|
1480
|
+
* the same timezone can be directly combined.
|
|
1481
|
+
*/
|
|
1482
|
+
timezone?: string;
|
|
1483
|
+
/**
|
|
1484
|
+
* Derived field indicating when a valid organization schedule will
|
|
1485
|
+
* become invalid. If omitted, the schedule is already invalid. A
|
|
1486
|
+
* schedule is valid if it has a weekly schedule for all named periods
|
|
1487
|
+
* for all its schedule fragments, and if it has a schedule fragment
|
|
1488
|
+
* for the time period in question.
|
|
1489
|
+
* @format date-time
|
|
1490
|
+
*/
|
|
1491
|
+
valid_until?: string;
|
|
1492
|
+
/**
|
|
1493
|
+
* If the organization schedule fragment specifies that the given day
|
|
1494
|
+
* belongs to a named period, a weekly schedule from this list with
|
|
1495
|
+
* the matching name will be selected.
|
|
1496
|
+
*/
|
|
1497
|
+
weekly_org_schedules?: WeeklyOrgSchedule[];
|
|
1498
|
+
};
|
|
1499
|
+
/** org-schedule-fragment */
|
|
1500
|
+
export type OrgScheduleFragment = AtomBase & {
|
|
1501
|
+
/**
|
|
1502
|
+
* The date (inclusive) on which the organization schedule fragment
|
|
1503
|
+
* begins.
|
|
1504
|
+
* @format date-time
|
|
1505
|
+
*/
|
|
1506
|
+
from?: string;
|
|
1507
|
+
/**
|
|
1508
|
+
* Periods during which the schedule is considered to be 'off' or to
|
|
1509
|
+
* be in some specific named period.
|
|
1510
|
+
*/
|
|
1511
|
+
intervals?: OrgScheduleInterval[];
|
|
1512
|
+
/** Human-readable name, indicating the purpose of the schedule. */
|
|
1513
|
+
name?: string;
|
|
1514
|
+
/**
|
|
1515
|
+
* CLDR region code of the countries/regions it is meant to be valid
|
|
1516
|
+
* for. Does not drive logic, serves only for easier filtering and
|
|
1517
|
+
* organization.
|
|
1518
|
+
*/
|
|
1519
|
+
region_codes?: string[];
|
|
1520
|
+
/**
|
|
1521
|
+
* Status determines how an item can be used. In 'draft' status an item
|
|
1522
|
+
* can be edited but can't be used. When 'published' the item can longer
|
|
1523
|
+
* be edited but can be used. 'Archived' is read-only.
|
|
1524
|
+
*/
|
|
1525
|
+
status: OrgScheduleFragmentStatus;
|
|
1526
|
+
/**
|
|
1527
|
+
* The date (exclusive) on which the organization schedule fragment's
|
|
1528
|
+
* validity ends.
|
|
1529
|
+
* @format date-time
|
|
1530
|
+
*/
|
|
1531
|
+
to?: string;
|
|
1532
|
+
};
|
|
1533
|
+
/**
|
|
1534
|
+
* org-schedule-fragment-overview
|
|
1535
|
+
* The representation of the organization schedule fragment embedded
|
|
1536
|
+
* inside a organization schedule, used to quickly look up the schedule
|
|
1537
|
+
* fragment for the right period.
|
|
1538
|
+
*/
|
|
1539
|
+
export type OrgScheduleFragmentOverview = object;
|
|
1540
|
+
/**
|
|
1541
|
+
* Status determines how an item can be used. In 'draft' status an item
|
|
1542
|
+
* can be edited but can't be used. When 'published' the item can longer
|
|
1543
|
+
* be edited but can be used. 'Archived' is read-only.
|
|
1544
|
+
*/
|
|
1545
|
+
export declare enum OrgScheduleFragmentStatus {
|
|
1546
|
+
Archived = "archived",
|
|
1547
|
+
Draft = "draft",
|
|
1548
|
+
Published = "published"
|
|
1549
|
+
}
|
|
1550
|
+
/** org-schedule-fragments-create-request */
|
|
1551
|
+
export interface OrgScheduleFragmentsCreateRequest {
|
|
1552
|
+
/**
|
|
1553
|
+
* Date (inclusive) on which the organization schedule fragment
|
|
1554
|
+
* begins.
|
|
1555
|
+
* @format date-time
|
|
1556
|
+
*/
|
|
1557
|
+
from: string;
|
|
1558
|
+
/** The intervals that comprise the schedule fragment. */
|
|
1559
|
+
intervals: CreateOrgScheduleInterval[];
|
|
1560
|
+
/** Name of the organization schedule fragment. */
|
|
1561
|
+
name: string;
|
|
1562
|
+
/**
|
|
1563
|
+
* CLDR region code of the countries/regions it is meant to be valid
|
|
1564
|
+
* for. Does not drive logic, serves only for easier filtering and
|
|
1565
|
+
* organization.
|
|
1566
|
+
*/
|
|
1567
|
+
region_codes?: string[];
|
|
1568
|
+
/**
|
|
1569
|
+
* Date (exclusive) on which the organization schedule fragment's
|
|
1570
|
+
* validity ends.
|
|
1571
|
+
* @format date-time
|
|
1572
|
+
*/
|
|
1573
|
+
to: string;
|
|
1574
|
+
}
|
|
1575
|
+
/** org-schedule-fragments-create-response */
|
|
1576
|
+
export interface OrgScheduleFragmentsCreateResponse {
|
|
1577
|
+
org_schedule_fragment: OrgScheduleFragment;
|
|
1578
|
+
}
|
|
1579
|
+
/** org-schedule-fragments-get-request */
|
|
1580
|
+
export interface OrgScheduleFragmentsGetRequest {
|
|
1581
|
+
/** Organization schedule Fragment ID. */
|
|
1582
|
+
id: string;
|
|
1583
|
+
}
|
|
1584
|
+
/** org-schedule-fragments-get-response */
|
|
1585
|
+
export interface OrgScheduleFragmentsGetResponse {
|
|
1586
|
+
org_schedule_fragment: OrgScheduleFragment;
|
|
1587
|
+
}
|
|
1588
|
+
/** org-schedule-fragments-transition-request */
|
|
1589
|
+
export interface OrgScheduleFragmentsTransitionRequest {
|
|
1590
|
+
/** Organization schedule Fragment ID. */
|
|
1591
|
+
id: string;
|
|
1592
|
+
/**
|
|
1593
|
+
* Status determines how an item can be used. In 'draft' status an item
|
|
1594
|
+
* can be edited but can't be used. When 'published' the item can longer
|
|
1595
|
+
* be edited but can be used. 'Archived' is read-only.
|
|
1596
|
+
*/
|
|
1597
|
+
status: OrgScheduleFragmentStatus;
|
|
1598
|
+
}
|
|
1599
|
+
/** org-schedule-fragments-transition-response */
|
|
1600
|
+
export interface OrgScheduleFragmentsTransitionResponse {
|
|
1601
|
+
org_schedule_fragment: OrgScheduleFragment;
|
|
1602
|
+
}
|
|
1603
|
+
/**
|
|
1604
|
+
* org-schedule-interval
|
|
1605
|
+
* An optionally named period on day granularity.
|
|
1606
|
+
*/
|
|
1607
|
+
export type OrgScheduleInterval = object;
|
|
1608
|
+
/**
|
|
1609
|
+
* Status determines how an item can be used. In 'draft' status an item
|
|
1610
|
+
* can be edited but can't be used. When 'published' the item can longer
|
|
1611
|
+
* be edited but can be used. 'Archived' is read-only.
|
|
1612
|
+
*/
|
|
1613
|
+
export declare enum OrgScheduleStatus {
|
|
1614
|
+
Archived = "archived",
|
|
1615
|
+
Draft = "draft",
|
|
1616
|
+
Published = "published"
|
|
1617
|
+
}
|
|
1618
|
+
/** org-schedules-create-request */
|
|
1619
|
+
export interface OrgSchedulesCreateRequest {
|
|
1620
|
+
default_weekly_org_schedule?: SetWeeklyOrgSchedule;
|
|
1621
|
+
/**
|
|
1622
|
+
* Organization schedule must be valid for at least this many days in
|
|
1623
|
+
* the future. Meaning organization schedule fragments must cover this
|
|
1624
|
+
* period. 0 if omitted.
|
|
1625
|
+
* @format int64
|
|
1626
|
+
*/
|
|
1627
|
+
min_valid_days?: number;
|
|
1628
|
+
/** Human-readable name. */
|
|
1629
|
+
name: string;
|
|
1630
|
+
/** List of organization schedule fragments with no overlaps or gaps. */
|
|
1631
|
+
org_schedule_fragments?: SetOrgScheduleFragmentSummary[];
|
|
1632
|
+
/**
|
|
1633
|
+
* Timezone in which the organization schedule applies. Expected to be
|
|
1634
|
+
* a valid IANA time zone name such as America/New_York.
|
|
1635
|
+
*/
|
|
1636
|
+
timezone: string;
|
|
1637
|
+
/**
|
|
1638
|
+
* If this day belongs to a named period according to the currently
|
|
1639
|
+
* active organization schedule fragment, a weekly organization
|
|
1640
|
+
* schedule from this list with the corresponding name will apply.
|
|
1641
|
+
*/
|
|
1642
|
+
weekly_org_schedules?: SetWeeklyOrgSchedule[];
|
|
1643
|
+
}
|
|
1644
|
+
/** org-schedules-create-response */
|
|
1645
|
+
export interface OrgSchedulesCreateResponse {
|
|
1646
|
+
org_schedule: OrgSchedule;
|
|
1647
|
+
}
|
|
1648
|
+
/** org-schedules-get-request */
|
|
1649
|
+
export interface OrgSchedulesGetRequest {
|
|
1650
|
+
/** Organization schedule ID. */
|
|
1651
|
+
id: string;
|
|
1652
|
+
}
|
|
1653
|
+
/** org-schedules-get-response */
|
|
1654
|
+
export interface OrgSchedulesGetResponse {
|
|
1655
|
+
org_schedule: OrgSchedule;
|
|
1656
|
+
}
|
|
1657
|
+
/** org-schedules-list-request */
|
|
1658
|
+
export interface OrgSchedulesListRequest {
|
|
1659
|
+
/** Creator ID the filter matches. */
|
|
1660
|
+
created_by_id?: string[];
|
|
1661
|
+
/**
|
|
1662
|
+
* The cursor to resume iteration from. If not provided, then
|
|
1663
|
+
* iteration starts from the beginning.
|
|
1664
|
+
*/
|
|
1665
|
+
cursor?: string;
|
|
1666
|
+
/**
|
|
1667
|
+
* Max number of organization schedules returned in a page. Default is
|
|
1668
|
+
* 50.
|
|
1669
|
+
* @format int32
|
|
1670
|
+
*/
|
|
1671
|
+
limit?: number;
|
|
1672
|
+
/**
|
|
1673
|
+
* The iteration mode to use. If "after", then entries after the provided
|
|
1674
|
+
* cursor will be returned, or if no cursor is provided, then from the
|
|
1675
|
+
* beginning. If "before", then entries before the provided cursor will be
|
|
1676
|
+
* returned, or if no cursor is provided, then from the end. Entries will
|
|
1677
|
+
* always be returned in the specified sort-by order.
|
|
1678
|
+
*/
|
|
1679
|
+
mode?: ListMode;
|
|
1680
|
+
/** The organization schedule statuses the filter matches. */
|
|
1681
|
+
status?: OrgScheduleStatus[];
|
|
1682
|
+
/** Provides ways to specify date ranges on objects. */
|
|
1683
|
+
valid_until?: DateFilter;
|
|
1684
|
+
}
|
|
1685
|
+
/** org-schedules-list-response */
|
|
1686
|
+
export interface OrgSchedulesListResponse {
|
|
910
1687
|
/**
|
|
911
1688
|
* The cursor used to iterate subsequent results in accordance to the
|
|
912
1689
|
* sort order. If not set, then no later elements exist.
|
|
913
1690
|
*/
|
|
914
1691
|
next_cursor?: string;
|
|
1692
|
+
/** The list of organization schedules. */
|
|
1693
|
+
org_schedules: OrgSchedule[];
|
|
915
1694
|
/**
|
|
916
1695
|
* The cursor used to iterate preceding results in accordance to the
|
|
917
1696
|
* sort order. If not set, then no prior elements exist.
|
|
918
1697
|
*/
|
|
919
1698
|
prev_cursor?: string;
|
|
920
1699
|
}
|
|
921
|
-
/**
|
|
922
|
-
export
|
|
923
|
-
/**
|
|
924
|
-
|
|
925
|
-
/**
|
|
926
|
-
|
|
927
|
-
|
|
928
|
-
|
|
929
|
-
|
|
930
|
-
|
|
931
|
-
|
|
932
|
-
|
|
933
|
-
|
|
934
|
-
|
|
935
|
-
|
|
936
|
-
|
|
937
|
-
|
|
938
|
-
|
|
939
|
-
|
|
1700
|
+
/** org-schedules-set-future-request */
|
|
1701
|
+
export interface OrgSchedulesSetFutureRequest {
|
|
1702
|
+
/** Organization schedule ID. */
|
|
1703
|
+
id: string;
|
|
1704
|
+
/** Organization schedule Fragment ID. */
|
|
1705
|
+
org_schedule_fragment_id: string;
|
|
1706
|
+
}
|
|
1707
|
+
/** org-schedules-set-future-response */
|
|
1708
|
+
export interface OrgSchedulesSetFutureResponse {
|
|
1709
|
+
org_schedule: OrgSchedule;
|
|
1710
|
+
}
|
|
1711
|
+
/** org-schedules-transition-request */
|
|
1712
|
+
export interface OrgSchedulesTransitionRequest {
|
|
1713
|
+
/** Organization schedule ID. */
|
|
1714
|
+
id: string;
|
|
1715
|
+
/**
|
|
1716
|
+
* Status determines how an item can be used. In 'draft' status an item
|
|
1717
|
+
* can be edited but can't be used. When 'published' the item can longer
|
|
1718
|
+
* be edited but can be used. 'Archived' is read-only.
|
|
1719
|
+
*/
|
|
1720
|
+
status: OrgScheduleStatus;
|
|
1721
|
+
}
|
|
1722
|
+
/** org-schedules-transition-response */
|
|
1723
|
+
export interface OrgSchedulesTransitionResponse {
|
|
1724
|
+
org_schedule: OrgSchedule;
|
|
1725
|
+
}
|
|
1726
|
+
/** org-schedules-update-request */
|
|
1727
|
+
export interface OrgSchedulesUpdateRequest {
|
|
1728
|
+
default_weekly_org_schedule?: SetWeeklyOrgSchedule;
|
|
1729
|
+
/** Organization schedule ID. */
|
|
1730
|
+
id: string;
|
|
1731
|
+
/**
|
|
1732
|
+
* Organization schedule must be valid for at least this many days in
|
|
1733
|
+
* the future. Meaning organization schedule fragments must cover this
|
|
1734
|
+
* period. 0 if omitted.
|
|
1735
|
+
* @format int64
|
|
1736
|
+
*/
|
|
1737
|
+
min_valid_days?: number;
|
|
1738
|
+
/** Human-readable name. */
|
|
1739
|
+
name?: string;
|
|
1740
|
+
/** List of organization schedule fragments with no overlaps or gaps. */
|
|
1741
|
+
org_schedule_fragments?: SetOrgScheduleFragmentSummary[];
|
|
1742
|
+
/**
|
|
1743
|
+
* Timezone in which the organization schedule applies. Expected to be
|
|
1744
|
+
* a valid IANA time zone name such as America/New_York.
|
|
1745
|
+
*/
|
|
1746
|
+
timezone?: string;
|
|
1747
|
+
/**
|
|
1748
|
+
* If this day belongs to a named period according to the currently
|
|
1749
|
+
* active organization schedule fragment, a weekly organization
|
|
1750
|
+
* schedule from this list with the corresponding name will apply.
|
|
1751
|
+
*/
|
|
1752
|
+
weekly_org_schedules?: SetWeeklyOrgSchedule[];
|
|
1753
|
+
}
|
|
1754
|
+
/** org-schedules-update-response */
|
|
1755
|
+
export interface OrgSchedulesUpdateResponse {
|
|
1756
|
+
org_schedule: OrgSchedule;
|
|
940
1757
|
}
|
|
941
1758
|
/** org-summary */
|
|
942
|
-
export type OrgSummary = RevOrgSummary & {
|
|
1759
|
+
export type OrgSummary = (AccountSummary | RevOrgSummary) & {
|
|
943
1760
|
type: OrgType;
|
|
944
1761
|
};
|
|
945
1762
|
export declare enum OrgType {
|
|
1763
|
+
Account = "account",
|
|
946
1764
|
RevOrg = "rev_org"
|
|
947
1765
|
}
|
|
948
1766
|
/** part-base-summary */
|
|
@@ -964,6 +1782,8 @@ export declare enum PartType {
|
|
|
964
1782
|
export type ProductSummary = PartBaseSummary;
|
|
965
1783
|
/** rev-org */
|
|
966
1784
|
export type RevOrg = OrgBase & {
|
|
1785
|
+
/** Custom fields. */
|
|
1786
|
+
custom_fields?: object;
|
|
967
1787
|
/**
|
|
968
1788
|
* Custom schema fragments.
|
|
969
1789
|
* @example ["don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"]
|
|
@@ -1025,6 +1845,17 @@ export interface RevOrgsCreateRequest {
|
|
|
1025
1845
|
export interface RevOrgsCreateResponse {
|
|
1026
1846
|
rev_org: RevOrg;
|
|
1027
1847
|
}
|
|
1848
|
+
/**
|
|
1849
|
+
* rev-orgs-get-request
|
|
1850
|
+
* Request object to get Rev organization's information.
|
|
1851
|
+
*/
|
|
1852
|
+
export interface RevOrgsGetRequest {
|
|
1853
|
+
/**
|
|
1854
|
+
* The ID of the required Rev organization.
|
|
1855
|
+
* @example "don:identity:<partition>:devo/<dev-org-id>:revo/<rev-org-id>"
|
|
1856
|
+
*/
|
|
1857
|
+
id: string;
|
|
1858
|
+
}
|
|
1028
1859
|
/**
|
|
1029
1860
|
* rev-orgs-get-response
|
|
1030
1861
|
* The response to getting a Rev organization's information.
|
|
@@ -1032,6 +1863,47 @@ export interface RevOrgsCreateResponse {
|
|
|
1032
1863
|
export interface RevOrgsGetResponse {
|
|
1033
1864
|
rev_org: RevOrg;
|
|
1034
1865
|
}
|
|
1866
|
+
/**
|
|
1867
|
+
* rev-orgs-list-request
|
|
1868
|
+
* A request to get the list of Rev organizations for the authenticated
|
|
1869
|
+
* user's Dev organization.
|
|
1870
|
+
*/
|
|
1871
|
+
export interface RevOrgsListRequest {
|
|
1872
|
+
/** Filters by creator. */
|
|
1873
|
+
created_by?: string[];
|
|
1874
|
+
created_date?: DateTimeFilter;
|
|
1875
|
+
/**
|
|
1876
|
+
* The cursor to resume iteration from. If not provided, then
|
|
1877
|
+
* iteration starts from the beginning.
|
|
1878
|
+
*/
|
|
1879
|
+
cursor?: string;
|
|
1880
|
+
/**
|
|
1881
|
+
* Filters on custom fields. Input will be of the format
|
|
1882
|
+
* (custom_field_filter=field_name1:val1,val2,val3&custom_field_filter=field_name2:val1,val2).
|
|
1883
|
+
*/
|
|
1884
|
+
custom_field_filter?: string[];
|
|
1885
|
+
/** List of external refs to filter Rev organizations for. */
|
|
1886
|
+
external_ref?: string[];
|
|
1887
|
+
/**
|
|
1888
|
+
* The maximum number of Rev organizations to be retrieved per page.
|
|
1889
|
+
* @format int32
|
|
1890
|
+
*/
|
|
1891
|
+
limit?: number;
|
|
1892
|
+
/**
|
|
1893
|
+
* The iteration mode to use. If "after", then entries after the provided
|
|
1894
|
+
* cursor will be returned, or if no cursor is provided, then from the
|
|
1895
|
+
* beginning. If "before", then entries before the provided cursor will be
|
|
1896
|
+
* returned, or if no cursor is provided, then from the end. Entries will
|
|
1897
|
+
* always be returned in the specified sort-by order.
|
|
1898
|
+
*/
|
|
1899
|
+
mode?: ListMode;
|
|
1900
|
+
modified_date?: DateTimeFilter;
|
|
1901
|
+
/**
|
|
1902
|
+
* Fields to sort the Rev organizations by and the direction to sort
|
|
1903
|
+
* them.
|
|
1904
|
+
*/
|
|
1905
|
+
sort_by?: string[];
|
|
1906
|
+
}
|
|
1035
1907
|
/**
|
|
1036
1908
|
* rev-orgs-list-response
|
|
1037
1909
|
* The response to getting a list of Rev organizations' information.
|
|
@@ -1091,6 +1963,8 @@ export interface RevOrgsUpdateResponse {
|
|
|
1091
1963
|
}
|
|
1092
1964
|
/** rev-user */
|
|
1093
1965
|
export type RevUser = UserBase & {
|
|
1966
|
+
/** Custom fields. */
|
|
1967
|
+
custom_fields?: object;
|
|
1094
1968
|
/**
|
|
1095
1969
|
* Custom schema fragments.
|
|
1096
1970
|
* @example ["don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"]
|
|
@@ -1179,6 +2053,14 @@ export interface RevUsersDeleteRequest {
|
|
|
1179
2053
|
* The response to deleting a Rev user of a Rev organization.
|
|
1180
2054
|
*/
|
|
1181
2055
|
export type RevUsersDeleteResponse = object;
|
|
2056
|
+
/**
|
|
2057
|
+
* rev-users-get-request
|
|
2058
|
+
* Request object to get a Rev user.
|
|
2059
|
+
*/
|
|
2060
|
+
export interface RevUsersGetRequest {
|
|
2061
|
+
/** The ID of Rev user to be retrieved. */
|
|
2062
|
+
id: string;
|
|
2063
|
+
}
|
|
1182
2064
|
/**
|
|
1183
2065
|
* rev-users-get-response
|
|
1184
2066
|
* The returned Rev user.
|
|
@@ -1186,6 +2068,48 @@ export type RevUsersDeleteResponse = object;
|
|
|
1186
2068
|
export interface RevUsersGetResponse {
|
|
1187
2069
|
rev_user: RevUser;
|
|
1188
2070
|
}
|
|
2071
|
+
/**
|
|
2072
|
+
* rev-users-list-request
|
|
2073
|
+
* Gets the list of Rev users belonging to the authenticated user's Dev
|
|
2074
|
+
* Organization which the user is also authorized to access.
|
|
2075
|
+
*/
|
|
2076
|
+
export interface RevUsersListRequest {
|
|
2077
|
+
/** Filters for Rev users that were created by the specified user(s). */
|
|
2078
|
+
created_by?: string[];
|
|
2079
|
+
created_date?: DateTimeFilter;
|
|
2080
|
+
/**
|
|
2081
|
+
* The cursor to resume iteration from. If not provided, then
|
|
2082
|
+
* iteration starts from the beginning.
|
|
2083
|
+
*/
|
|
2084
|
+
cursor?: string;
|
|
2085
|
+
/** List of emails of Rev users to be filtered. */
|
|
2086
|
+
email?: string[];
|
|
2087
|
+
/** List of external refs to filter Rev users for. */
|
|
2088
|
+
external_ref?: string[];
|
|
2089
|
+
/**
|
|
2090
|
+
* The maximum number of Rev users to return. The default is '50'.
|
|
2091
|
+
* @format int32
|
|
2092
|
+
*/
|
|
2093
|
+
limit?: number;
|
|
2094
|
+
/**
|
|
2095
|
+
* The iteration mode to use. If "after", then entries after the provided
|
|
2096
|
+
* cursor will be returned, or if no cursor is provided, then from the
|
|
2097
|
+
* beginning. If "before", then entries before the provided cursor will be
|
|
2098
|
+
* returned, or if no cursor is provided, then from the end. Entries will
|
|
2099
|
+
* always be returned in the specified sort-by order.
|
|
2100
|
+
*/
|
|
2101
|
+
mode?: ListMode;
|
|
2102
|
+
modified_date?: DateTimeFilter;
|
|
2103
|
+
/** List of phone numbers to filter Rev users on. */
|
|
2104
|
+
phone_numbers?: string[];
|
|
2105
|
+
/**
|
|
2106
|
+
* List of IDs of Rev organizations to be filtered.
|
|
2107
|
+
* @example ["don:identity:<partition>:devo/<dev-org-id>:revo/<rev-org-id>"]
|
|
2108
|
+
*/
|
|
2109
|
+
rev_org?: string[];
|
|
2110
|
+
/** Fields to sort the Rev users by and the direction to sort them. */
|
|
2111
|
+
sort_by?: string[];
|
|
2112
|
+
}
|
|
1189
2113
|
/**
|
|
1190
2114
|
* rev-users-list-response
|
|
1191
2115
|
* The response to listing all Rev users matching the filter criteria.
|
|
@@ -1258,6 +2182,16 @@ export type SchemaCompositeListFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
|
1258
2182
|
/** Composite type. Required when field type is composite. */
|
|
1259
2183
|
composite_type?: string;
|
|
1260
2184
|
};
|
|
2185
|
+
/** schema-date-field-descriptor */
|
|
2186
|
+
export type SchemaDateFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
2187
|
+
/** Default value. */
|
|
2188
|
+
default_value?: string;
|
|
2189
|
+
};
|
|
2190
|
+
/** schema-date-list-field-descriptor */
|
|
2191
|
+
export type SchemaDateListFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
2192
|
+
/** Default value. */
|
|
2193
|
+
default_value?: string[];
|
|
2194
|
+
};
|
|
1261
2195
|
/** schema-double-field-descriptor */
|
|
1262
2196
|
export type SchemaDoubleFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
1263
2197
|
/**
|
|
@@ -1289,11 +2223,11 @@ export type SchemaEnumListFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
|
1289
2223
|
* schema-field-descriptor
|
|
1290
2224
|
* Set of field attributes.
|
|
1291
2225
|
*/
|
|
1292
|
-
export type SchemaFieldDescriptor = (SchemaBoolFieldDescriptor | SchemaCompositeFieldDescriptor | SchemaDoubleFieldDescriptor | SchemaEnumFieldDescriptor | SchemaFieldDescriptorArrayType | SchemaIdFieldDescriptor | SchemaIntFieldDescriptor | SchemaRichTextFieldDescriptor | SchemaTextFieldDescriptor | SchemaTimestampFieldDescriptor | SchemaTokensFieldDescriptor) & {
|
|
2226
|
+
export type SchemaFieldDescriptor = (SchemaBoolFieldDescriptor | SchemaCompositeFieldDescriptor | SchemaDateFieldDescriptor | SchemaDoubleFieldDescriptor | SchemaEnumFieldDescriptor | SchemaFieldDescriptorArrayType | SchemaIdFieldDescriptor | SchemaIntFieldDescriptor | SchemaRichTextFieldDescriptor | SchemaTextFieldDescriptor | SchemaTimestampFieldDescriptor | SchemaTokensFieldDescriptor) & {
|
|
1293
2227
|
field_type: SchemaFieldDescriptorFieldType;
|
|
1294
2228
|
};
|
|
1295
2229
|
/** schema-field-descriptor-array-type */
|
|
1296
|
-
export type SchemaFieldDescriptorArrayType = (SchemaBoolListFieldDescriptor | SchemaCompositeListFieldDescriptor | SchemaDoubleListFieldDescriptor | SchemaEnumListFieldDescriptor | SchemaIdListFieldDescriptor | SchemaIntListFieldDescriptor | SchemaRichTextListFieldDescriptor | SchemaTextListFieldDescriptor | SchemaTimestampListFieldDescriptor | SchemaTokensListFieldDescriptor) & {
|
|
2230
|
+
export type SchemaFieldDescriptorArrayType = (SchemaBoolListFieldDescriptor | SchemaCompositeListFieldDescriptor | SchemaDateListFieldDescriptor | SchemaDoubleListFieldDescriptor | SchemaEnumListFieldDescriptor | SchemaIdListFieldDescriptor | SchemaIntListFieldDescriptor | SchemaRichTextListFieldDescriptor | SchemaTextListFieldDescriptor | SchemaTimestampListFieldDescriptor | SchemaTokensListFieldDescriptor) & {
|
|
1297
2231
|
base_type: SchemaFieldDescriptorArrayTypeBaseType;
|
|
1298
2232
|
/**
|
|
1299
2233
|
* The maximum array length.
|
|
@@ -1309,6 +2243,7 @@ export type SchemaFieldDescriptorArrayType = (SchemaBoolListFieldDescriptor | Sc
|
|
|
1309
2243
|
export declare enum SchemaFieldDescriptorArrayTypeBaseType {
|
|
1310
2244
|
Bool = "bool",
|
|
1311
2245
|
Composite = "composite",
|
|
2246
|
+
Date = "date",
|
|
1312
2247
|
Double = "double",
|
|
1313
2248
|
Enum = "enum",
|
|
1314
2249
|
Id = "id",
|
|
@@ -1331,6 +2266,8 @@ export interface SchemaFieldDescriptorBase {
|
|
|
1331
2266
|
is_pii?: boolean;
|
|
1332
2267
|
/** Whether this field is required or not. */
|
|
1333
2268
|
is_required?: boolean;
|
|
2269
|
+
/** The schema of MFZ specific fields. */
|
|
2270
|
+
mfz?: SchemaFieldMfzMetadata;
|
|
1334
2271
|
/** Name of the field. */
|
|
1335
2272
|
name: string;
|
|
1336
2273
|
/** Type this field is from. */
|
|
@@ -1342,6 +2279,7 @@ export declare enum SchemaFieldDescriptorFieldType {
|
|
|
1342
2279
|
Array = "array",
|
|
1343
2280
|
Bool = "bool",
|
|
1344
2281
|
Composite = "composite",
|
|
2282
|
+
Date = "date",
|
|
1345
2283
|
Double = "double",
|
|
1346
2284
|
Enum = "enum",
|
|
1347
2285
|
Id = "id",
|
|
@@ -1351,6 +2289,11 @@ export declare enum SchemaFieldDescriptorFieldType {
|
|
|
1351
2289
|
Timestamp = "timestamp",
|
|
1352
2290
|
Tokens = "tokens"
|
|
1353
2291
|
}
|
|
2292
|
+
/**
|
|
2293
|
+
* schema-field-mfz-metadata
|
|
2294
|
+
* The schema of MFZ specific fields.
|
|
2295
|
+
*/
|
|
2296
|
+
export type SchemaFieldMfzMetadata = object;
|
|
1354
2297
|
/**
|
|
1355
2298
|
* schema-field-ui-metadata
|
|
1356
2299
|
* The schema of ui specific fields.
|
|
@@ -1540,10 +2483,7 @@ export type SchemaTextListFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
|
1540
2483
|
};
|
|
1541
2484
|
/** schema-timestamp-field-descriptor */
|
|
1542
2485
|
export type SchemaTimestampFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
1543
|
-
/**
|
|
1544
|
-
* Default value.
|
|
1545
|
-
* @format date-time
|
|
1546
|
-
*/
|
|
2486
|
+
/** Default value. */
|
|
1547
2487
|
default_value?: string;
|
|
1548
2488
|
};
|
|
1549
2489
|
/** schema-timestamp-list-field-descriptor */
|
|
@@ -1607,6 +2547,31 @@ export type SchemaTokensListFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
|
1607
2547
|
/** The string suffix. */
|
|
1608
2548
|
suffix?: string;
|
|
1609
2549
|
};
|
|
2550
|
+
/** service-account */
|
|
2551
|
+
export type ServiceAccount = UserBase;
|
|
2552
|
+
/** service-account-summary */
|
|
2553
|
+
export type ServiceAccountSummary = UserBaseSummary;
|
|
2554
|
+
/**
|
|
2555
|
+
* service-accounts-get-request
|
|
2556
|
+
* The request object to get a service account's information.
|
|
2557
|
+
*/
|
|
2558
|
+
export interface ServiceAccountsGetRequest {
|
|
2559
|
+
/** The ID of the requested service account. */
|
|
2560
|
+
id: string;
|
|
2561
|
+
}
|
|
2562
|
+
/**
|
|
2563
|
+
* service-accounts-get-response
|
|
2564
|
+
* The response object that carries the service account's information
|
|
2565
|
+
* corresponding to the request.
|
|
2566
|
+
*/
|
|
2567
|
+
export interface ServiceAccountsGetResponse {
|
|
2568
|
+
service_account: ServiceAccount;
|
|
2569
|
+
}
|
|
2570
|
+
/** set-org-schedule-fragment-summary */
|
|
2571
|
+
export interface SetOrgScheduleFragmentSummary {
|
|
2572
|
+
/** Organization schedule fragment ID. */
|
|
2573
|
+
id: string;
|
|
2574
|
+
}
|
|
1610
2575
|
/** set-sla-policy */
|
|
1611
2576
|
export interface SetSlaPolicy {
|
|
1612
2577
|
/** Metrics to apply to the selected items. */
|
|
@@ -1657,7 +2622,7 @@ export interface SetSupportMetricTarget {
|
|
|
1657
2622
|
* be breached, in order to avoid breaching the overall SLA policy.
|
|
1658
2623
|
* @format double
|
|
1659
2624
|
*/
|
|
1660
|
-
performance
|
|
2625
|
+
performance?: number;
|
|
1661
2626
|
/**
|
|
1662
2627
|
* The target value to be achieved, for example the time in which to
|
|
1663
2628
|
* do something, or the maximum allowed number of message pairs. The
|
|
@@ -1686,6 +2651,16 @@ export interface SetTagWithValue {
|
|
|
1686
2651
|
*/
|
|
1687
2652
|
value?: string;
|
|
1688
2653
|
}
|
|
2654
|
+
/** set-weekly-org-schedule */
|
|
2655
|
+
export interface SetWeeklyOrgSchedule {
|
|
2656
|
+
/** The 'on' intervals of the week. */
|
|
2657
|
+
intervals: CreateWeeklyOrgScheduleInterval[];
|
|
2658
|
+
/**
|
|
2659
|
+
* The name of the period during which the organization schedule
|
|
2660
|
+
* applies.
|
|
2661
|
+
*/
|
|
2662
|
+
period_name: string;
|
|
2663
|
+
}
|
|
1689
2664
|
/** sla */
|
|
1690
2665
|
export type Sla = AtomBase & {
|
|
1691
2666
|
/**
|
|
@@ -1780,6 +2755,11 @@ export declare enum SlaStatus {
|
|
|
1780
2755
|
Draft = "draft",
|
|
1781
2756
|
Published = "published"
|
|
1782
2757
|
}
|
|
2758
|
+
/**
|
|
2759
|
+
* sla-summary-filter
|
|
2760
|
+
* The filter for SLA summary.
|
|
2761
|
+
*/
|
|
2762
|
+
export type SlaSummaryFilter = object;
|
|
1783
2763
|
/** slas-assign-request */
|
|
1784
2764
|
export interface SlasAssignRequest {
|
|
1785
2765
|
/**
|
|
@@ -1824,10 +2804,38 @@ export interface SlasCreateRequest {
|
|
|
1824
2804
|
export interface SlasCreateResponse {
|
|
1825
2805
|
sla: Sla;
|
|
1826
2806
|
}
|
|
2807
|
+
/** slas-get-request */
|
|
2808
|
+
export interface SlasGetRequest {
|
|
2809
|
+
/** The ID of the SLA to get. */
|
|
2810
|
+
id: string;
|
|
2811
|
+
}
|
|
1827
2812
|
/** slas-get-response */
|
|
1828
2813
|
export interface SlasGetResponse {
|
|
1829
2814
|
sla: Sla;
|
|
1830
2815
|
}
|
|
2816
|
+
/** slas-list-request */
|
|
2817
|
+
export interface SlasListRequest {
|
|
2818
|
+
/**
|
|
2819
|
+
* The cursor to resume iteration from. If not provided, then
|
|
2820
|
+
* iteration starts from the beginning.
|
|
2821
|
+
*/
|
|
2822
|
+
cursor?: string;
|
|
2823
|
+
/**
|
|
2824
|
+
* The maximum number of SLAs to return. The default is '50'.
|
|
2825
|
+
* @format int32
|
|
2826
|
+
*/
|
|
2827
|
+
limit?: number;
|
|
2828
|
+
/**
|
|
2829
|
+
* The iteration mode to use. If "after", then entries after the provided
|
|
2830
|
+
* cursor will be returned, or if no cursor is provided, then from the
|
|
2831
|
+
* beginning. If "before", then entries before the provided cursor will be
|
|
2832
|
+
* returned, or if no cursor is provided, then from the end. Entries will
|
|
2833
|
+
* always be returned in the specified sort-by order.
|
|
2834
|
+
*/
|
|
2835
|
+
mode?: ListMode;
|
|
2836
|
+
/** The SLA statuses the filter matches. */
|
|
2837
|
+
status?: SlaStatus[];
|
|
2838
|
+
}
|
|
1831
2839
|
/** slas-list-response */
|
|
1832
2840
|
export interface SlasListResponse {
|
|
1833
2841
|
/**
|
|
@@ -1894,6 +2902,14 @@ export interface Stage {
|
|
|
1894
2902
|
/** Current stage name of the work item. */
|
|
1895
2903
|
name: string;
|
|
1896
2904
|
}
|
|
2905
|
+
/**
|
|
2906
|
+
* stage-filter
|
|
2907
|
+
* The filter for stages.
|
|
2908
|
+
*/
|
|
2909
|
+
export interface StageFilter {
|
|
2910
|
+
/** Filters for records in the provided stage(s). */
|
|
2911
|
+
name?: string[];
|
|
2912
|
+
}
|
|
1897
2913
|
/**
|
|
1898
2914
|
* stage-init
|
|
1899
2915
|
* Sets an object's initial stage.
|
|
@@ -1926,15 +2942,57 @@ export interface Subtype {
|
|
|
1926
2942
|
/** Value of the subtype. */
|
|
1927
2943
|
value: string;
|
|
1928
2944
|
}
|
|
2945
|
+
/** subtypes-list-request */
|
|
2946
|
+
export interface SubtypesListRequest {
|
|
2947
|
+
/**
|
|
2948
|
+
* Leaf type for which subtypes are required.
|
|
2949
|
+
* @deprecated
|
|
2950
|
+
*/
|
|
2951
|
+
leaf_type?: string;
|
|
2952
|
+
/** List of leaf types for which subtypes are required. */
|
|
2953
|
+
leaf_types?: string[];
|
|
2954
|
+
}
|
|
1929
2955
|
/** subtypes-list-response */
|
|
1930
2956
|
export interface SubtypesListResponse {
|
|
1931
2957
|
/** List of subtypes. */
|
|
1932
2958
|
subtypes: Subtype[];
|
|
1933
2959
|
}
|
|
2960
|
+
/**
|
|
2961
|
+
* survey-aggregation-filter
|
|
2962
|
+
* The filter for survey aggregation.
|
|
2963
|
+
*/
|
|
2964
|
+
export type SurveyAggregationFilter = object;
|
|
1934
2965
|
/** sys-user */
|
|
1935
2966
|
export type SysUser = UserBase;
|
|
1936
2967
|
/** sys-user-summary */
|
|
1937
2968
|
export type SysUserSummary = UserBaseSummary;
|
|
2969
|
+
/**
|
|
2970
|
+
* sys-users-list-request
|
|
2971
|
+
* A request to get the list of system user's information.
|
|
2972
|
+
*/
|
|
2973
|
+
export interface SysUsersListRequest {
|
|
2974
|
+
/**
|
|
2975
|
+
* The cursor to resume iteration from. If not provided, then
|
|
2976
|
+
* iteration starts from the beginning.
|
|
2977
|
+
*/
|
|
2978
|
+
cursor?: string;
|
|
2979
|
+
/**
|
|
2980
|
+
* The maximum number of system users to return. Value can range from
|
|
2981
|
+
* '1' to '100', with a default of '50'.
|
|
2982
|
+
* @format int32
|
|
2983
|
+
*/
|
|
2984
|
+
limit?: number;
|
|
2985
|
+
/**
|
|
2986
|
+
* The iteration mode to use. If "after", then entries after the provided
|
|
2987
|
+
* cursor will be returned, or if no cursor is provided, then from the
|
|
2988
|
+
* beginning. If "before", then entries before the provided cursor will be
|
|
2989
|
+
* returned, or if no cursor is provided, then from the end. Entries will
|
|
2990
|
+
* always be returned in the specified sort-by order.
|
|
2991
|
+
*/
|
|
2992
|
+
mode?: ListMode;
|
|
2993
|
+
/** Fields to sort the system users by and the direction to sort them. */
|
|
2994
|
+
sort_by?: string[];
|
|
2995
|
+
}
|
|
1938
2996
|
/**
|
|
1939
2997
|
* sys-users-list-response
|
|
1940
2998
|
* The response to listing the system users.
|
|
@@ -1992,6 +3050,8 @@ export interface TagWithValue {
|
|
|
1992
3050
|
/** The value for the object's association with the tag. */
|
|
1993
3051
|
value?: string;
|
|
1994
3052
|
}
|
|
3053
|
+
/** task */
|
|
3054
|
+
export type Task = WorkBase;
|
|
1995
3055
|
/** Priority of the work based upon impact and criticality. */
|
|
1996
3056
|
export declare enum TaskPriority {
|
|
1997
3057
|
P0 = "p0",
|
|
@@ -1999,6 +3059,8 @@ export declare enum TaskPriority {
|
|
|
1999
3059
|
P2 = "p2",
|
|
2000
3060
|
P3 = "p3"
|
|
2001
3061
|
}
|
|
3062
|
+
/** task-summary */
|
|
3063
|
+
export type TaskSummary = WorkBaseSummary;
|
|
2002
3064
|
/** ticket */
|
|
2003
3065
|
export type Ticket = WorkBase & {
|
|
2004
3066
|
group?: GroupSummary;
|
|
@@ -2106,6 +3168,47 @@ export declare enum TimelineEntriesCreateRequestType {
|
|
|
2106
3168
|
export interface TimelineEntriesCreateResponse {
|
|
2107
3169
|
timeline_entry: TimelineEntry;
|
|
2108
3170
|
}
|
|
3171
|
+
/**
|
|
3172
|
+
* timeline-entries-list-request
|
|
3173
|
+
* The request to list timeline entries for an object.
|
|
3174
|
+
*/
|
|
3175
|
+
export interface TimelineEntriesListRequest {
|
|
3176
|
+
/**
|
|
3177
|
+
* The collection(s) to list entries from, otherwise if not provided,
|
|
3178
|
+
* all entries are returned.
|
|
3179
|
+
*/
|
|
3180
|
+
collections?: TimelineEntriesCollection[];
|
|
3181
|
+
/**
|
|
3182
|
+
* The cursor to resume iteration from. If not provided, then
|
|
3183
|
+
* iteration starts from the beginning.
|
|
3184
|
+
*/
|
|
3185
|
+
cursor?: string;
|
|
3186
|
+
/**
|
|
3187
|
+
* The maximum number of entries to return. If not set, then this
|
|
3188
|
+
* defaults to `50`.
|
|
3189
|
+
* @format int32
|
|
3190
|
+
*/
|
|
3191
|
+
limit?: number;
|
|
3192
|
+
/**
|
|
3193
|
+
* The iteration mode to use. If "after", then entries after the provided
|
|
3194
|
+
* cursor will be returned, or if no cursor is provided, then from the
|
|
3195
|
+
* beginning. If "before", then entries before the provided cursor will be
|
|
3196
|
+
* returned, or if no cursor is provided, then from the end. Entries will
|
|
3197
|
+
* always be returned in the specified sort-by order.
|
|
3198
|
+
*/
|
|
3199
|
+
mode?: ListMode;
|
|
3200
|
+
/**
|
|
3201
|
+
* The ID of the object to list timeline entries for.
|
|
3202
|
+
* @example "don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"
|
|
3203
|
+
*/
|
|
3204
|
+
object: string;
|
|
3205
|
+
/**
|
|
3206
|
+
* The visibility of the timeline entries to filter for. Note this is
|
|
3207
|
+
* a strict filter, such that only entries with the exact visibilities
|
|
3208
|
+
* specified will be returned.
|
|
3209
|
+
*/
|
|
3210
|
+
visibility?: TimelineEntryVisibility[];
|
|
3211
|
+
}
|
|
2109
3212
|
/**
|
|
2110
3213
|
* timeline-entries-list-response
|
|
2111
3214
|
* The response to listing timeline entries for an object.
|
|
@@ -2129,7 +3232,40 @@ export type TimelineEntry = TimelineComment & {
|
|
|
2129
3232
|
type: TimelineEntryType;
|
|
2130
3233
|
};
|
|
2131
3234
|
/** timeline-entry-base */
|
|
2132
|
-
export type TimelineEntryBase = AtomBase
|
|
3235
|
+
export type TimelineEntryBase = AtomBase & {
|
|
3236
|
+
/** The object that the Timeline entry belongs to. */
|
|
3237
|
+
object: string;
|
|
3238
|
+
/** The type of object that the Timeline entry belongs to. */
|
|
3239
|
+
object_type?: TimelineEntryObjectType;
|
|
3240
|
+
/** The reactions to the entry. */
|
|
3241
|
+
reactions?: TimelineReaction[];
|
|
3242
|
+
/** Thread. */
|
|
3243
|
+
thread?: TimelineThread;
|
|
3244
|
+
/**
|
|
3245
|
+
* The visibility of the entry. If 'private', then the entry is only
|
|
3246
|
+
* visible to the creator, 'internal' is visible with the Dev
|
|
3247
|
+
* organization, 'external' is visible to the Dev organzation and Rev
|
|
3248
|
+
* users, and 'public' is visible to all. If not set, then the default
|
|
3249
|
+
* visibility is 'external'.
|
|
3250
|
+
*/
|
|
3251
|
+
visibility?: TimelineEntryVisibility;
|
|
3252
|
+
};
|
|
3253
|
+
/** The type of object that the Timeline entry belongs to. */
|
|
3254
|
+
export declare enum TimelineEntryObjectType {
|
|
3255
|
+
Account = "account",
|
|
3256
|
+
Capability = "capability",
|
|
3257
|
+
Conversation = "conversation",
|
|
3258
|
+
Enhancement = "enhancement",
|
|
3259
|
+
Feature = "feature",
|
|
3260
|
+
Issue = "issue",
|
|
3261
|
+
Opportunity = "opportunity",
|
|
3262
|
+
Product = "product",
|
|
3263
|
+
RevOrg = "rev_org",
|
|
3264
|
+
RevUser = "rev_user",
|
|
3265
|
+
Task = "task",
|
|
3266
|
+
Ticket = "ticket",
|
|
3267
|
+
TimelineComment = "timeline_comment"
|
|
3268
|
+
}
|
|
2133
3269
|
export declare enum TimelineEntryType {
|
|
2134
3270
|
TimelineComment = "timeline_comment"
|
|
2135
3271
|
}
|
|
@@ -2146,6 +3282,21 @@ export declare enum TimelineEntryVisibility {
|
|
|
2146
3282
|
Private = "private",
|
|
2147
3283
|
Public = "public"
|
|
2148
3284
|
}
|
|
3285
|
+
/**
|
|
3286
|
+
* timeline-reaction
|
|
3287
|
+
* Reaction.
|
|
3288
|
+
*/
|
|
3289
|
+
export interface TimelineReaction {
|
|
3290
|
+
/** The reaction emoji's unicode codepoint, e.g. "1f44d". */
|
|
3291
|
+
emoji?: string;
|
|
3292
|
+
/** Whether the requesting user reacted. */
|
|
3293
|
+
reacted?: boolean;
|
|
3294
|
+
/**
|
|
3295
|
+
* The total number of users with this reaction.
|
|
3296
|
+
* @format int32
|
|
3297
|
+
*/
|
|
3298
|
+
total_users?: number;
|
|
3299
|
+
}
|
|
2149
3300
|
/**
|
|
2150
3301
|
* timeline-snap-kit-body
|
|
2151
3302
|
* Snap Kit Body of the comment.
|
|
@@ -2163,6 +3314,17 @@ export interface TimelineSnapKitBody {
|
|
|
2163
3314
|
/** ID of the snap-in which created the SnapKit. */
|
|
2164
3315
|
snap_in_id?: string;
|
|
2165
3316
|
}
|
|
3317
|
+
/**
|
|
3318
|
+
* timeline-thread
|
|
3319
|
+
* Thread.
|
|
3320
|
+
*/
|
|
3321
|
+
export interface TimelineThread {
|
|
3322
|
+
/**
|
|
3323
|
+
* The total number of replies in the thread.
|
|
3324
|
+
* @format int32
|
|
3325
|
+
*/
|
|
3326
|
+
total_replies?: number;
|
|
3327
|
+
}
|
|
2166
3328
|
/**
|
|
2167
3329
|
* unlink-rev-user-from-rev-org-request
|
|
2168
3330
|
* A request to unlink a rev user from a rev org.
|
|
@@ -2218,16 +3380,22 @@ export declare enum UserState {
|
|
|
2218
3380
|
Unassigned = "unassigned"
|
|
2219
3381
|
}
|
|
2220
3382
|
/** user-summary */
|
|
2221
|
-
export type UserSummary = (DevUserSummary | RevUserSummary | SysUserSummary) & {
|
|
3383
|
+
export type UserSummary = (DevUserSummary | RevUserSummary | ServiceAccountSummary | SysUserSummary) & {
|
|
2222
3384
|
type: UserType;
|
|
2223
3385
|
};
|
|
2224
3386
|
export declare enum UserType {
|
|
2225
3387
|
DevUser = "dev_user",
|
|
2226
3388
|
RevUser = "rev_user",
|
|
3389
|
+
ServiceAccount = "service_account",
|
|
2227
3390
|
SysUser = "sys_user"
|
|
2228
3391
|
}
|
|
3392
|
+
/**
|
|
3393
|
+
* weekly-org-schedule
|
|
3394
|
+
* The schedule for each week.
|
|
3395
|
+
*/
|
|
3396
|
+
export type WeeklyOrgSchedule = object;
|
|
2229
3397
|
/** work */
|
|
2230
|
-
export type Work = (Issue | Opportunity | Ticket) & {
|
|
3398
|
+
export type Work = (Issue | Opportunity | Task | Ticket) & {
|
|
2231
3399
|
type: WorkType;
|
|
2232
3400
|
};
|
|
2233
3401
|
/** work-base */
|
|
@@ -2237,6 +3405,8 @@ export type WorkBase = AtomBase & {
|
|
|
2237
3405
|
artifacts?: ArtifactSummary[];
|
|
2238
3406
|
/** Body of the work object. */
|
|
2239
3407
|
body?: string;
|
|
3408
|
+
/** Custom fields. */
|
|
3409
|
+
custom_fields?: object;
|
|
2240
3410
|
/**
|
|
2241
3411
|
* Custom schema fragments.
|
|
2242
3412
|
* @example ["don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"]
|
|
@@ -2271,6 +3441,7 @@ export type WorkBaseSummary = AtomBaseSummary & {
|
|
|
2271
3441
|
export declare enum WorkType {
|
|
2272
3442
|
Issue = "issue",
|
|
2273
3443
|
Opportunity = "opportunity",
|
|
3444
|
+
Task = "task",
|
|
2274
3445
|
Ticket = "ticket"
|
|
2275
3446
|
}
|
|
2276
3447
|
/** works-create-request */
|
|
@@ -2289,6 +3460,8 @@ export type WorksCreateRequest = (WorksCreateRequestIssue | WorksCreateRequestOp
|
|
|
2289
3460
|
artifacts?: string[];
|
|
2290
3461
|
/** Body of the work object. */
|
|
2291
3462
|
body?: string;
|
|
3463
|
+
/** Custom fields. */
|
|
3464
|
+
custom_fields?: object;
|
|
2292
3465
|
/**
|
|
2293
3466
|
* The custom schema fragments to use.
|
|
2294
3467
|
* @example ["don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"]
|
|
@@ -2343,6 +3516,10 @@ export interface WorksCreateRequestOpportunity {
|
|
|
2343
3516
|
* @format double
|
|
2344
3517
|
*/
|
|
2345
3518
|
customer_budget?: number;
|
|
3519
|
+
/** Forecast category of the opportunity. */
|
|
3520
|
+
forecast_category?: OpportunityForecastCategory;
|
|
3521
|
+
/** Priority of the opportunity. */
|
|
3522
|
+
priority?: OpportunityPriority;
|
|
2346
3523
|
/**
|
|
2347
3524
|
* The probability of winning the deal, lies between 0.0 and 1.0.
|
|
2348
3525
|
* @format double
|
|
@@ -2391,15 +3568,165 @@ export interface WorksDeleteRequest {
|
|
|
2391
3568
|
}
|
|
2392
3569
|
/** works-delete-response */
|
|
2393
3570
|
export type WorksDeleteResponse = object;
|
|
3571
|
+
/** works-export-request */
|
|
3572
|
+
export interface WorksExportRequest {
|
|
3573
|
+
/** Provides ways to specify date ranges on objects. */
|
|
3574
|
+
actual_close_date?: DateFilter;
|
|
3575
|
+
/**
|
|
3576
|
+
* Filters for work belonging to any of the provided parts.
|
|
3577
|
+
* @example ["don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"]
|
|
3578
|
+
*/
|
|
3579
|
+
applies_to_part?: string[];
|
|
3580
|
+
/**
|
|
3581
|
+
* Filters for work created by any of these users.
|
|
3582
|
+
* @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
|
|
3583
|
+
*/
|
|
3584
|
+
created_by?: string[];
|
|
3585
|
+
/** Provides ways to specify date ranges on objects. */
|
|
3586
|
+
created_date?: DateFilter;
|
|
3587
|
+
/** Filters for custom fields. */
|
|
3588
|
+
custom_fields?: object;
|
|
3589
|
+
/**
|
|
3590
|
+
* The number of work items to return. The default is '50', the
|
|
3591
|
+
* maximum is '5000'.
|
|
3592
|
+
* @format int32
|
|
3593
|
+
*/
|
|
3594
|
+
first?: number;
|
|
3595
|
+
issue?: WorksFilterIssue;
|
|
3596
|
+
/** Provides ways to specify date ranges on objects. */
|
|
3597
|
+
modified_date?: DateFilter;
|
|
3598
|
+
opportunity?: WorksFilterOpportunity;
|
|
3599
|
+
/**
|
|
3600
|
+
* Filters for work owned by any of these users.
|
|
3601
|
+
* @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
|
|
3602
|
+
*/
|
|
3603
|
+
owned_by?: string[];
|
|
3604
|
+
/** Fields to sort the work items by and the direction to sort them. */
|
|
3605
|
+
sort_by?: string[];
|
|
3606
|
+
/** The filter for stages. */
|
|
3607
|
+
stage?: StageFilter;
|
|
3608
|
+
/** Provides ways to specify date ranges on objects. */
|
|
3609
|
+
target_close_date?: DateFilter;
|
|
3610
|
+
ticket?: WorksFilterTicket;
|
|
3611
|
+
/** Filters for work of the provided types. */
|
|
3612
|
+
type?: WorkType[];
|
|
3613
|
+
}
|
|
2394
3614
|
/** works-export-response */
|
|
2395
3615
|
export interface WorksExportResponse {
|
|
2396
3616
|
/** The resulting collection of work items. */
|
|
2397
3617
|
works: Work[];
|
|
2398
3618
|
}
|
|
3619
|
+
/** works-filter-issue */
|
|
3620
|
+
export interface WorksFilterIssue {
|
|
3621
|
+
/** Filters for issues with any of the provided priorities. */
|
|
3622
|
+
priority?: IssuePriority[];
|
|
3623
|
+
/**
|
|
3624
|
+
* Filters for issues with any of the provided Rev organizations.
|
|
3625
|
+
* @example ["don:identity:<partition>:devo/<dev-org-id>:revo/<rev-org-id>"]
|
|
3626
|
+
*/
|
|
3627
|
+
rev_orgs?: string[];
|
|
3628
|
+
}
|
|
3629
|
+
/** works-filter-opportunity */
|
|
3630
|
+
export interface WorksFilterOpportunity {
|
|
3631
|
+
/**
|
|
3632
|
+
* Filters for opportunities belonging to any of the provided
|
|
3633
|
+
* accounts.
|
|
3634
|
+
* @example ["don:core:<partition>:devo/<dev-org-id>:account/<account-id>"]
|
|
3635
|
+
*/
|
|
3636
|
+
account?: string[];
|
|
3637
|
+
/** Filters for opportunities with any of the provided contacts. */
|
|
3638
|
+
contacts?: string[];
|
|
3639
|
+
}
|
|
3640
|
+
/** works-filter-ticket */
|
|
3641
|
+
export interface WorksFilterTicket {
|
|
3642
|
+
/** Filters for tickets belonging to specific groups. */
|
|
3643
|
+
group?: string[];
|
|
3644
|
+
/** Filters for tickets that are spam. */
|
|
3645
|
+
is_spam?: boolean;
|
|
3646
|
+
/** Filters for tickets that need response. */
|
|
3647
|
+
needs_response?: boolean;
|
|
3648
|
+
/**
|
|
3649
|
+
* Filters for tickets that are associated with any of the provided
|
|
3650
|
+
* Rev organizations.
|
|
3651
|
+
* @example ["don:identity:<partition>:devo/<dev-org-id>:revo/<rev-org-id>"]
|
|
3652
|
+
*/
|
|
3653
|
+
rev_org?: string[];
|
|
3654
|
+
/** Filters for tickets with any of the provided severities. */
|
|
3655
|
+
severity?: TicketSeverity[];
|
|
3656
|
+
/** The filter for SLA summary. */
|
|
3657
|
+
sla_summary?: SlaSummaryFilter;
|
|
3658
|
+
/** Filters for tickets with any of the provided source channels. */
|
|
3659
|
+
source_channel?: string[];
|
|
3660
|
+
/** The filter for survey aggregation. */
|
|
3661
|
+
surveys?: SurveyAggregationFilter;
|
|
3662
|
+
}
|
|
3663
|
+
/** works-get-request */
|
|
3664
|
+
export interface WorksGetRequest {
|
|
3665
|
+
/**
|
|
3666
|
+
* The work's ID.
|
|
3667
|
+
* @example "don:core:<partition>:devo/<dev-org-id>:<work-type>/<work-id>"
|
|
3668
|
+
*/
|
|
3669
|
+
id: string;
|
|
3670
|
+
}
|
|
2399
3671
|
/** works-get-response */
|
|
2400
3672
|
export interface WorksGetResponse {
|
|
2401
3673
|
work: Work;
|
|
2402
3674
|
}
|
|
3675
|
+
/** works-list-request */
|
|
3676
|
+
export interface WorksListRequest {
|
|
3677
|
+
/** Provides ways to specify date ranges on objects. */
|
|
3678
|
+
actual_close_date?: DateFilter;
|
|
3679
|
+
/**
|
|
3680
|
+
* Filters for work belonging to any of the provided parts.
|
|
3681
|
+
* @example ["don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"]
|
|
3682
|
+
*/
|
|
3683
|
+
applies_to_part?: string[];
|
|
3684
|
+
/**
|
|
3685
|
+
* Filters for work created by any of these users.
|
|
3686
|
+
* @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
|
|
3687
|
+
*/
|
|
3688
|
+
created_by?: string[];
|
|
3689
|
+
/** Provides ways to specify date ranges on objects. */
|
|
3690
|
+
created_date?: DateFilter;
|
|
3691
|
+
/**
|
|
3692
|
+
* The cursor to resume iteration from. If not provided, then
|
|
3693
|
+
* iteration starts from the beginning.
|
|
3694
|
+
*/
|
|
3695
|
+
cursor?: string;
|
|
3696
|
+
/** Filters for custom fields. */
|
|
3697
|
+
custom_fields?: object;
|
|
3698
|
+
issue?: WorksFilterIssue;
|
|
3699
|
+
/**
|
|
3700
|
+
* The maximum number of works to return. The default is '50'.
|
|
3701
|
+
* @format int32
|
|
3702
|
+
*/
|
|
3703
|
+
limit?: number;
|
|
3704
|
+
/**
|
|
3705
|
+
* The iteration mode to use. If "after", then entries after the provided
|
|
3706
|
+
* cursor will be returned, or if no cursor is provided, then from the
|
|
3707
|
+
* beginning. If "before", then entries before the provided cursor will be
|
|
3708
|
+
* returned, or if no cursor is provided, then from the end. Entries will
|
|
3709
|
+
* always be returned in the specified sort-by order.
|
|
3710
|
+
*/
|
|
3711
|
+
mode?: ListMode;
|
|
3712
|
+
/** Provides ways to specify date ranges on objects. */
|
|
3713
|
+
modified_date?: DateFilter;
|
|
3714
|
+
opportunity?: WorksFilterOpportunity;
|
|
3715
|
+
/**
|
|
3716
|
+
* Filters for work owned by any of these users.
|
|
3717
|
+
* @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
|
|
3718
|
+
*/
|
|
3719
|
+
owned_by?: string[];
|
|
3720
|
+
/** Fields to sort the works by and the direction to sort them. */
|
|
3721
|
+
sort_by?: string[];
|
|
3722
|
+
/** The filter for stages. */
|
|
3723
|
+
stage?: StageFilter;
|
|
3724
|
+
/** Provides ways to specify date ranges on objects. */
|
|
3725
|
+
target_close_date?: DateFilter;
|
|
3726
|
+
ticket?: WorksFilterTicket;
|
|
3727
|
+
/** Filters for work of the provided types. */
|
|
3728
|
+
type?: WorkType[];
|
|
3729
|
+
}
|
|
2403
3730
|
/** works-list-response */
|
|
2404
3731
|
export interface WorksListResponse {
|
|
2405
3732
|
/**
|
|
@@ -2425,6 +3752,8 @@ export type WorksUpdateRequest = (WorksUpdateRequestIssue | WorksUpdateRequestOp
|
|
|
2425
3752
|
artifacts?: WorksUpdateRequestArtifactIds;
|
|
2426
3753
|
/** Updated body of the work object, or unchanged if not provided. */
|
|
2427
3754
|
body?: string;
|
|
3755
|
+
/** Custom fields. */
|
|
3756
|
+
custom_fields?: object;
|
|
2428
3757
|
/**
|
|
2429
3758
|
* The custom schema fragments to use.
|
|
2430
3759
|
* @example ["don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"]
|
|
@@ -2546,9 +3875,9 @@ export interface WorksUpdateRequestTicket {
|
|
|
2546
3875
|
export interface WorksUpdateResponse {
|
|
2547
3876
|
work: Work;
|
|
2548
3877
|
}
|
|
2549
|
-
import { AxiosInstance, AxiosRequestConfig, AxiosResponse, ResponseType } from
|
|
3878
|
+
import { AxiosInstance, AxiosRequestConfig, AxiosResponse, ResponseType } from 'axios';
|
|
2550
3879
|
export type QueryParamsType = Record<string | number, any>;
|
|
2551
|
-
export interface FullRequestParams extends Omit<AxiosRequestConfig,
|
|
3880
|
+
export interface FullRequestParams extends Omit<AxiosRequestConfig, 'data' | 'params' | 'url' | 'responseType'> {
|
|
2552
3881
|
/** set parameter to `true` for call `securityWorker` for this request */
|
|
2553
3882
|
secure?: boolean;
|
|
2554
3883
|
/** request path */
|
|
@@ -2562,8 +3891,8 @@ export interface FullRequestParams extends Omit<AxiosRequestConfig, "data" | "pa
|
|
|
2562
3891
|
/** request body */
|
|
2563
3892
|
body?: unknown;
|
|
2564
3893
|
}
|
|
2565
|
-
export type RequestParams = Omit<FullRequestParams,
|
|
2566
|
-
export interface ApiConfig<SecurityDataType = unknown> extends Omit<AxiosRequestConfig,
|
|
3894
|
+
export type RequestParams = Omit<FullRequestParams, 'body' | 'method' | 'query' | 'path'>;
|
|
3895
|
+
export interface ApiConfig<SecurityDataType = unknown> extends Omit<AxiosRequestConfig, 'data' | 'cancelToken'> {
|
|
2567
3896
|
securityWorker?: (securityData: SecurityDataType | null) => Promise<AxiosRequestConfig | void> | AxiosRequestConfig | void;
|
|
2568
3897
|
secure?: boolean;
|
|
2569
3898
|
format?: ResponseType;
|
|
@@ -2628,13 +3957,13 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2628
3957
|
* Filters for objects created after the provided timestamp (inclusive).
|
|
2629
3958
|
* @format date-time
|
|
2630
3959
|
*/
|
|
2631
|
-
|
|
3960
|
+
'created_date.after'?: string;
|
|
2632
3961
|
/**
|
|
2633
3962
|
* Filters for objects created before the provided timestamp
|
|
2634
3963
|
* (inclusive).
|
|
2635
3964
|
* @format date-time
|
|
2636
3965
|
*/
|
|
2637
|
-
|
|
3966
|
+
'created_date.before'?: string;
|
|
2638
3967
|
/** Array of references of accounts to be filtered. */
|
|
2639
3968
|
external_refs?: string[];
|
|
2640
3969
|
/**
|
|
@@ -2648,16 +3977,25 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2648
3977
|
* Filters for objects created after the provided timestamp (inclusive).
|
|
2649
3978
|
* @format date-time
|
|
2650
3979
|
*/
|
|
2651
|
-
|
|
3980
|
+
'modified_date.after'?: string;
|
|
2652
3981
|
/**
|
|
2653
3982
|
* Filters for objects created before the provided timestamp
|
|
2654
3983
|
* (inclusive).
|
|
2655
3984
|
* @format date-time
|
|
2656
3985
|
*/
|
|
2657
|
-
|
|
3986
|
+
'modified_date.before'?: string;
|
|
2658
3987
|
/** Fields to sort the accounts by and the direction to sort them in. */
|
|
2659
3988
|
sort_by?: string[];
|
|
2660
3989
|
}, params?: RequestParams) => Promise<AxiosResponse<AccountsExportResponse, any>>;
|
|
3990
|
+
/**
|
|
3991
|
+
* @description Exports a collection of accounts.
|
|
3992
|
+
*
|
|
3993
|
+
* @tags accounts
|
|
3994
|
+
* @name AccountsExportPost
|
|
3995
|
+
* @request POST:/accounts.export
|
|
3996
|
+
* @secure
|
|
3997
|
+
*/
|
|
3998
|
+
accountsExportPost: (data: AccountsExportRequest, params?: RequestParams) => Promise<AxiosResponse<AccountsExportResponse, any>>;
|
|
2661
3999
|
/**
|
|
2662
4000
|
* @description Retrieves an account's information.
|
|
2663
4001
|
*
|
|
@@ -2673,6 +4011,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2673
4011
|
*/
|
|
2674
4012
|
id: string;
|
|
2675
4013
|
}, params?: RequestParams) => Promise<AxiosResponse<AccountsGetResponse, any>>;
|
|
4014
|
+
/**
|
|
4015
|
+
* @description Retrieves an account's information.
|
|
4016
|
+
*
|
|
4017
|
+
* @tags accounts
|
|
4018
|
+
* @name AccountsGetPost
|
|
4019
|
+
* @request POST:/accounts.get
|
|
4020
|
+
* @secure
|
|
4021
|
+
*/
|
|
4022
|
+
accountsGetPost: (data: AccountsGetRequest, params?: RequestParams) => Promise<AxiosResponse<AccountsGetResponse, any>>;
|
|
2676
4023
|
/**
|
|
2677
4024
|
* @description Gets a list of accounts.
|
|
2678
4025
|
*
|
|
@@ -2688,13 +4035,13 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2688
4035
|
* Filters for objects created after the provided timestamp (inclusive).
|
|
2689
4036
|
* @format date-time
|
|
2690
4037
|
*/
|
|
2691
|
-
|
|
4038
|
+
'created_date.after'?: string;
|
|
2692
4039
|
/**
|
|
2693
4040
|
* Filters for objects created before the provided timestamp
|
|
2694
4041
|
* (inclusive).
|
|
2695
4042
|
* @format date-time
|
|
2696
4043
|
*/
|
|
2697
|
-
|
|
4044
|
+
'created_date.before'?: string;
|
|
2698
4045
|
/**
|
|
2699
4046
|
* The cursor to resume iteration from. If not provided, then iteration
|
|
2700
4047
|
* starts from the beginning.
|
|
@@ -2717,16 +4064,25 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2717
4064
|
* Filters for objects created after the provided timestamp (inclusive).
|
|
2718
4065
|
* @format date-time
|
|
2719
4066
|
*/
|
|
2720
|
-
|
|
4067
|
+
'modified_date.after'?: string;
|
|
2721
4068
|
/**
|
|
2722
4069
|
* Filters for objects created before the provided timestamp
|
|
2723
4070
|
* (inclusive).
|
|
2724
4071
|
* @format date-time
|
|
2725
4072
|
*/
|
|
2726
|
-
|
|
4073
|
+
'modified_date.before'?: string;
|
|
2727
4074
|
/** Fields to sort the accounts by and the direction to sort them in. */
|
|
2728
4075
|
sort_by?: string[];
|
|
2729
4076
|
}, params?: RequestParams) => Promise<AxiosResponse<AccountsListResponse, any>>;
|
|
4077
|
+
/**
|
|
4078
|
+
* @description Gets a list of accounts.
|
|
4079
|
+
*
|
|
4080
|
+
* @tags accounts
|
|
4081
|
+
* @name AccountsListPost
|
|
4082
|
+
* @request POST:/accounts.list
|
|
4083
|
+
* @secure
|
|
4084
|
+
*/
|
|
4085
|
+
accountsListPost: (data: AccountsListRequest, params?: RequestParams) => Promise<AxiosResponse<AccountsListResponse, any>>;
|
|
2730
4086
|
/**
|
|
2731
4087
|
* @description Updates an account's information.
|
|
2732
4088
|
*
|
|
@@ -2797,13 +4153,22 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2797
4153
|
/** Filters for conversations with any of the provided source channels. */
|
|
2798
4154
|
source_channels?: string[];
|
|
2799
4155
|
/** Filters for records in the provided stage(s). */
|
|
2800
|
-
|
|
4156
|
+
'stage.name'?: string[];
|
|
2801
4157
|
/**
|
|
2802
4158
|
* Filters for conversations with any of the provided tags.
|
|
2803
4159
|
* @example ["don:core:<partition>:devo/<dev-org-id>:tag/<tag-id>"]
|
|
2804
4160
|
*/
|
|
2805
4161
|
tags?: string[];
|
|
2806
4162
|
}, params?: RequestParams) => Promise<AxiosResponse<ConversationsExportResponse, any>>;
|
|
4163
|
+
/**
|
|
4164
|
+
* @description Exports a collection of conversation items.
|
|
4165
|
+
*
|
|
4166
|
+
* @tags conversations
|
|
4167
|
+
* @name ConversationsExportPost
|
|
4168
|
+
* @request POST:/conversations.export
|
|
4169
|
+
* @secure
|
|
4170
|
+
*/
|
|
4171
|
+
conversationsExportPost: (data: ConversationsExportRequest, params?: RequestParams) => Promise<AxiosResponse<ConversationsExportResponse, any>>;
|
|
2807
4172
|
/**
|
|
2808
4173
|
* @description Gets the requested conversation's information.
|
|
2809
4174
|
*
|
|
@@ -2816,6 +4181,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2816
4181
|
/** The requested conversation's ID. */
|
|
2817
4182
|
id: string;
|
|
2818
4183
|
}, params?: RequestParams) => Promise<AxiosResponse<ConversationsGetResponse, any>>;
|
|
4184
|
+
/**
|
|
4185
|
+
* @description Gets the requested conversation's information.
|
|
4186
|
+
*
|
|
4187
|
+
* @tags conversations
|
|
4188
|
+
* @name ConversationsGetPost
|
|
4189
|
+
* @request POST:/conversations.get
|
|
4190
|
+
* @secure
|
|
4191
|
+
*/
|
|
4192
|
+
conversationsGetPost: (data: ConversationsGetRequest, params?: RequestParams) => Promise<AxiosResponse<ConversationsGetResponse, any>>;
|
|
2819
4193
|
/**
|
|
2820
4194
|
* @description Lists the available conversations.
|
|
2821
4195
|
*
|
|
@@ -2868,13 +4242,22 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2868
4242
|
/** Filters for conversations with any of the provided source channels. */
|
|
2869
4243
|
source_channels?: string[];
|
|
2870
4244
|
/** Filters for records in the provided stage(s). */
|
|
2871
|
-
|
|
4245
|
+
'stage.name'?: string[];
|
|
2872
4246
|
/**
|
|
2873
4247
|
* Filters for conversations with any of the provided tags.
|
|
2874
4248
|
* @example ["don:core:<partition>:devo/<dev-org-id>:tag/<tag-id>"]
|
|
2875
4249
|
*/
|
|
2876
4250
|
tags?: string[];
|
|
2877
4251
|
}, params?: RequestParams) => Promise<AxiosResponse<ConversationsListResponse, any>>;
|
|
4252
|
+
/**
|
|
4253
|
+
* @description Lists the available conversations.
|
|
4254
|
+
*
|
|
4255
|
+
* @tags conversations
|
|
4256
|
+
* @name ConversationsListPost
|
|
4257
|
+
* @request POST:/conversations.list
|
|
4258
|
+
* @secure
|
|
4259
|
+
*/
|
|
4260
|
+
conversationsListPost: (data: ConversationsListRequest, params?: RequestParams) => Promise<AxiosResponse<ConversationsListResponse, any>>;
|
|
2878
4261
|
/**
|
|
2879
4262
|
* @description Updates the requested conversation.
|
|
2880
4263
|
*
|
|
@@ -2893,12 +4276,30 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2893
4276
|
* @secure
|
|
2894
4277
|
*/
|
|
2895
4278
|
engagementsCount: (query?: {
|
|
4279
|
+
/** Filters for meetings with the provided external_refs. */
|
|
4280
|
+
external_ref?: string[];
|
|
4281
|
+
/**
|
|
4282
|
+
* Filters for engagement of the provided members.
|
|
4283
|
+
* @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
|
|
4284
|
+
*/
|
|
4285
|
+
members?: string[];
|
|
2896
4286
|
/**
|
|
2897
4287
|
* Filters for engagements with the provided parent.
|
|
2898
4288
|
* @example ["don:core:<partition>:devo/<dev-org-id>:account/<account-id>"]
|
|
2899
4289
|
*/
|
|
2900
4290
|
parent?: string[];
|
|
4291
|
+
/** Filters for engagement of the provided types. */
|
|
4292
|
+
type?: EngagementType[];
|
|
2901
4293
|
}, params?: RequestParams) => Promise<AxiosResponse<EngagementsCountResponse, any>>;
|
|
4294
|
+
/**
|
|
4295
|
+
* @description Counts the engagement records.
|
|
4296
|
+
*
|
|
4297
|
+
* @tags engagements
|
|
4298
|
+
* @name EngagementsCountPost
|
|
4299
|
+
* @request POST:/engagements.count
|
|
4300
|
+
* @secure
|
|
4301
|
+
*/
|
|
4302
|
+
engagementsCountPost: (data: EngagementsCountRequest, params?: RequestParams) => Promise<AxiosResponse<EngagementsCountResponse, any>>;
|
|
2902
4303
|
/**
|
|
2903
4304
|
* @description Creates a new engagement record.
|
|
2904
4305
|
*
|
|
@@ -2929,6 +4330,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2929
4330
|
/** The engagement ID. */
|
|
2930
4331
|
id: string;
|
|
2931
4332
|
}, params?: RequestParams) => Promise<AxiosResponse<EngagementsGetResponse, any>>;
|
|
4333
|
+
/**
|
|
4334
|
+
* @description Gets the engagement record.
|
|
4335
|
+
*
|
|
4336
|
+
* @tags engagements
|
|
4337
|
+
* @name EngagementsGetPost
|
|
4338
|
+
* @request POST:/engagements.get
|
|
4339
|
+
* @secure
|
|
4340
|
+
*/
|
|
4341
|
+
engagementsGetPost: (data: EngagementsGetRequest, params?: RequestParams) => Promise<AxiosResponse<EngagementsGetResponse, any>>;
|
|
2932
4342
|
/**
|
|
2933
4343
|
* @description Lists the engagement records.
|
|
2934
4344
|
*
|
|
@@ -2943,11 +4353,18 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2943
4353
|
* starts from the beginning.
|
|
2944
4354
|
*/
|
|
2945
4355
|
cursor?: string;
|
|
4356
|
+
/** Filters for meetings with the provided external_refs. */
|
|
4357
|
+
external_ref?: string[];
|
|
2946
4358
|
/**
|
|
2947
4359
|
* The maximum number of engagements to return.
|
|
2948
4360
|
* @format int32
|
|
2949
4361
|
*/
|
|
2950
4362
|
limit?: number;
|
|
4363
|
+
/**
|
|
4364
|
+
* Filters for engagement of the provided members.
|
|
4365
|
+
* @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
|
|
4366
|
+
*/
|
|
4367
|
+
members?: string[];
|
|
2951
4368
|
/**
|
|
2952
4369
|
* The iteration mode to use, otherwise if not set, then "after" is
|
|
2953
4370
|
* used.
|
|
@@ -2960,7 +4377,18 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2960
4377
|
parent?: string[];
|
|
2961
4378
|
/** Fields to sort the engagements by and the direction to sort them. */
|
|
2962
4379
|
sort_by?: string[];
|
|
4380
|
+
/** Filters for engagement of the provided types. */
|
|
4381
|
+
type?: EngagementType[];
|
|
2963
4382
|
}, params?: RequestParams) => Promise<AxiosResponse<EngagementsListResponse, any>>;
|
|
4383
|
+
/**
|
|
4384
|
+
* @description Lists the engagement records.
|
|
4385
|
+
*
|
|
4386
|
+
* @tags engagements
|
|
4387
|
+
* @name EngagementsListPost
|
|
4388
|
+
* @request POST:/engagements.list
|
|
4389
|
+
* @secure
|
|
4390
|
+
*/
|
|
4391
|
+
engagementsListPost: (data: EngagementsListRequest, params?: RequestParams) => Promise<AxiosResponse<EngagementsListResponse, any>>;
|
|
2964
4392
|
/**
|
|
2965
4393
|
* @description Updates the engagement record.
|
|
2966
4394
|
*
|
|
@@ -3018,6 +4446,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3018
4446
|
/** The requested link's ID. */
|
|
3019
4447
|
id: string;
|
|
3020
4448
|
}, params?: RequestParams) => Promise<AxiosResponse<LinksGetResponse, any>>;
|
|
4449
|
+
/**
|
|
4450
|
+
* @description Gets the requested link's information.
|
|
4451
|
+
*
|
|
4452
|
+
* @tags links
|
|
4453
|
+
* @name LinksGetPost
|
|
4454
|
+
* @request POST:/links.get
|
|
4455
|
+
* @secure
|
|
4456
|
+
*/
|
|
4457
|
+
linksGetPost: (data: LinksGetRequest, params?: RequestParams) => Promise<AxiosResponse<LinksGetResponse, any>>;
|
|
3021
4458
|
/**
|
|
3022
4459
|
* @description Lists the available links.
|
|
3023
4460
|
*
|
|
@@ -3062,6 +4499,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3062
4499
|
*/
|
|
3063
4500
|
types?: LinkType[];
|
|
3064
4501
|
}, params?: RequestParams) => Promise<AxiosResponse<LinksListResponse, any>>;
|
|
4502
|
+
/**
|
|
4503
|
+
* @description Lists the available links.
|
|
4504
|
+
*
|
|
4505
|
+
* @tags links
|
|
4506
|
+
* @name LinksListPost
|
|
4507
|
+
* @request POST:/links.list
|
|
4508
|
+
* @secure
|
|
4509
|
+
*/
|
|
4510
|
+
linksListPost: (data: LinksListRequest, params?: RequestParams) => Promise<AxiosResponse<LinksListResponse, any>>;
|
|
3065
4511
|
/**
|
|
3066
4512
|
* @description Lists metric definitions matching a filter.
|
|
3067
4513
|
*
|
|
@@ -3091,6 +4537,150 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3091
4537
|
/** The type of metric definitions sought. */
|
|
3092
4538
|
type?: MetricDefinitionMetricType[];
|
|
3093
4539
|
}, params?: RequestParams) => Promise<AxiosResponse<MetricDefinitionsListResponse, any>>;
|
|
4540
|
+
/**
|
|
4541
|
+
* @description Lists metric definitions matching a filter.
|
|
4542
|
+
*
|
|
4543
|
+
* @tags slas
|
|
4544
|
+
* @name MetricDefinitionsListPost
|
|
4545
|
+
* @request POST:/metric-definitions.list
|
|
4546
|
+
* @secure
|
|
4547
|
+
*/
|
|
4548
|
+
metricDefinitionsListPost: (data: MetricDefinitionsListRequest, params?: RequestParams) => Promise<AxiosResponse<MetricDefinitionsListResponse, any>>;
|
|
4549
|
+
/**
|
|
4550
|
+
* @description Creates an organization schedule fragment.
|
|
4551
|
+
*
|
|
4552
|
+
* @tags schedules
|
|
4553
|
+
* @name OrgScheduleFragmentsCreate
|
|
4554
|
+
* @request POST:/org-schedule-fragments.create
|
|
4555
|
+
* @secure
|
|
4556
|
+
*/
|
|
4557
|
+
orgScheduleFragmentsCreate: (data: OrgScheduleFragmentsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<OrgScheduleFragmentsCreateResponse, any>>;
|
|
4558
|
+
/**
|
|
4559
|
+
* @description Gets an organization schedule fragment.
|
|
4560
|
+
*
|
|
4561
|
+
* @tags schedules
|
|
4562
|
+
* @name OrgScheduleFragmentsGet
|
|
4563
|
+
* @request GET:/org-schedule-fragments.get
|
|
4564
|
+
* @secure
|
|
4565
|
+
*/
|
|
4566
|
+
orgScheduleFragmentsGet: (query: {
|
|
4567
|
+
/** Organization schedule Fragment ID. */
|
|
4568
|
+
id: string;
|
|
4569
|
+
}, params?: RequestParams) => Promise<AxiosResponse<OrgScheduleFragmentsGetResponse, any>>;
|
|
4570
|
+
/**
|
|
4571
|
+
* @description Gets an organization schedule fragment.
|
|
4572
|
+
*
|
|
4573
|
+
* @tags schedules
|
|
4574
|
+
* @name OrgScheduleFragmentsGetPost
|
|
4575
|
+
* @request POST:/org-schedule-fragments.get
|
|
4576
|
+
* @secure
|
|
4577
|
+
*/
|
|
4578
|
+
orgScheduleFragmentsGetPost: (data: OrgScheduleFragmentsGetRequest, params?: RequestParams) => Promise<AxiosResponse<OrgScheduleFragmentsGetResponse, any>>;
|
|
4579
|
+
/**
|
|
4580
|
+
* @description Changes stage of an organization schedule fragment.
|
|
4581
|
+
*
|
|
4582
|
+
* @tags schedules
|
|
4583
|
+
* @name OrgScheduleFragmentsTransition
|
|
4584
|
+
* @request POST:/org-schedule-fragments.transition
|
|
4585
|
+
* @secure
|
|
4586
|
+
*/
|
|
4587
|
+
orgScheduleFragmentsTransition: (data: OrgScheduleFragmentsTransitionRequest, params?: RequestParams) => Promise<AxiosResponse<OrgScheduleFragmentsTransitionResponse, any>>;
|
|
4588
|
+
/**
|
|
4589
|
+
* @description Creates an organization schedule with a default weekly organization schedule and a list of organization schedule fragments.
|
|
4590
|
+
*
|
|
4591
|
+
* @tags schedules
|
|
4592
|
+
* @name OrgSchedulesCreate
|
|
4593
|
+
* @request POST:/org-schedules.create
|
|
4594
|
+
* @secure
|
|
4595
|
+
*/
|
|
4596
|
+
orgSchedulesCreate: (data: OrgSchedulesCreateRequest, params?: RequestParams) => Promise<AxiosResponse<OrgSchedulesCreateResponse, any>>;
|
|
4597
|
+
/**
|
|
4598
|
+
* @description Gets an organization schedule.
|
|
4599
|
+
*
|
|
4600
|
+
* @tags schedules
|
|
4601
|
+
* @name OrgSchedulesGet
|
|
4602
|
+
* @request GET:/org-schedules.get
|
|
4603
|
+
* @secure
|
|
4604
|
+
*/
|
|
4605
|
+
orgSchedulesGet: (query: {
|
|
4606
|
+
/** Organization schedule ID. */
|
|
4607
|
+
id: string;
|
|
4608
|
+
}, params?: RequestParams) => Promise<AxiosResponse<OrgSchedulesGetResponse, any>>;
|
|
4609
|
+
/**
|
|
4610
|
+
* @description Gets an organization schedule.
|
|
4611
|
+
*
|
|
4612
|
+
* @tags schedules
|
|
4613
|
+
* @name OrgSchedulesGetPost
|
|
4614
|
+
* @request POST:/org-schedules.get
|
|
4615
|
+
* @secure
|
|
4616
|
+
*/
|
|
4617
|
+
orgSchedulesGetPost: (data: OrgSchedulesGetRequest, params?: RequestParams) => Promise<AxiosResponse<OrgSchedulesGetResponse, any>>;
|
|
4618
|
+
/**
|
|
4619
|
+
* @description Gets list of organization schedules.
|
|
4620
|
+
*
|
|
4621
|
+
* @tags schedules
|
|
4622
|
+
* @name OrgSchedulesList
|
|
4623
|
+
* @request GET:/org-schedules.list
|
|
4624
|
+
* @secure
|
|
4625
|
+
*/
|
|
4626
|
+
orgSchedulesList: (query?: {
|
|
4627
|
+
/** Creator ID the filter matches. */
|
|
4628
|
+
created_by_id?: string[];
|
|
4629
|
+
/**
|
|
4630
|
+
* The cursor to resume iteration from. If not provided, then iteration
|
|
4631
|
+
* starts from the beginning.
|
|
4632
|
+
*/
|
|
4633
|
+
cursor?: string;
|
|
4634
|
+
/**
|
|
4635
|
+
* Max number of organization schedules returned in a page. Default is
|
|
4636
|
+
* 50.
|
|
4637
|
+
* @format int32
|
|
4638
|
+
*/
|
|
4639
|
+
limit?: number;
|
|
4640
|
+
/**
|
|
4641
|
+
* The iteration mode to use, otherwise if not set, then "after" is
|
|
4642
|
+
* used.
|
|
4643
|
+
*/
|
|
4644
|
+
mode?: ListMode;
|
|
4645
|
+
/** The organization schedule statuses the filter matches. */
|
|
4646
|
+
status?: OrgScheduleStatus[];
|
|
4647
|
+
}, params?: RequestParams) => Promise<AxiosResponse<OrgSchedulesListResponse, any>>;
|
|
4648
|
+
/**
|
|
4649
|
+
* @description Gets list of organization schedules.
|
|
4650
|
+
*
|
|
4651
|
+
* @tags schedules
|
|
4652
|
+
* @name OrgSchedulesListPost
|
|
4653
|
+
* @request POST:/org-schedules.list
|
|
4654
|
+
* @secure
|
|
4655
|
+
*/
|
|
4656
|
+
orgSchedulesListPost: (data: OrgSchedulesListRequest, params?: RequestParams) => Promise<AxiosResponse<OrgSchedulesListResponse, any>>;
|
|
4657
|
+
/**
|
|
4658
|
+
* @description Sets next organization schedule fragment which must begin the day the last existing fragment ends.
|
|
4659
|
+
*
|
|
4660
|
+
* @tags schedules
|
|
4661
|
+
* @name OrgSchedulesSetFuture
|
|
4662
|
+
* @request POST:/org-schedules.set-future
|
|
4663
|
+
* @secure
|
|
4664
|
+
*/
|
|
4665
|
+
orgSchedulesSetFuture: (data: OrgSchedulesSetFutureRequest, params?: RequestParams) => Promise<AxiosResponse<OrgSchedulesSetFutureResponse, any>>;
|
|
4666
|
+
/**
|
|
4667
|
+
* @description Publishes or archives an organization schedule.
|
|
4668
|
+
*
|
|
4669
|
+
* @tags schedules
|
|
4670
|
+
* @name OrgSchedulesTransition
|
|
4671
|
+
* @request POST:/org-schedules.transition
|
|
4672
|
+
* @secure
|
|
4673
|
+
*/
|
|
4674
|
+
orgSchedulesTransition: (data: OrgSchedulesTransitionRequest, params?: RequestParams) => Promise<AxiosResponse<OrgSchedulesTransitionResponse, any>>;
|
|
4675
|
+
/**
|
|
4676
|
+
* @description Updates an organization schedule.
|
|
4677
|
+
*
|
|
4678
|
+
* @tags schedules
|
|
4679
|
+
* @name OrgSchedulesUpdate
|
|
4680
|
+
* @request POST:/org-schedules.update
|
|
4681
|
+
* @secure
|
|
4682
|
+
*/
|
|
4683
|
+
orgSchedulesUpdate: (data: OrgSchedulesUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<OrgSchedulesUpdateResponse, any>>;
|
|
3094
4684
|
/**
|
|
3095
4685
|
* @description Creates a Rev organization in the authenticated user's Dev organization.
|
|
3096
4686
|
*
|
|
@@ -3115,6 +4705,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3115
4705
|
*/
|
|
3116
4706
|
id: string;
|
|
3117
4707
|
}, params?: RequestParams) => Promise<AxiosResponse<RevOrgsGetResponse, any>>;
|
|
4708
|
+
/**
|
|
4709
|
+
* @description Retrieves the Rev organization's information.
|
|
4710
|
+
*
|
|
4711
|
+
* @tags rev-orgs
|
|
4712
|
+
* @name RevOrgsGetPost
|
|
4713
|
+
* @request POST:/rev-orgs.get
|
|
4714
|
+
* @secure
|
|
4715
|
+
*/
|
|
4716
|
+
revOrgsGetPost: (data: RevOrgsGetRequest, params?: RequestParams) => Promise<AxiosResponse<RevOrgsGetResponse, any>>;
|
|
3118
4717
|
/**
|
|
3119
4718
|
* @description Gets the list of Rev organizations' information belonging to the authenticated user's Dev Organization which the user is also authorized to access.
|
|
3120
4719
|
*
|
|
@@ -3130,13 +4729,13 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3130
4729
|
* Filters for objects created after the provided timestamp (inclusive).
|
|
3131
4730
|
* @format date-time
|
|
3132
4731
|
*/
|
|
3133
|
-
|
|
4732
|
+
'created_date.after'?: string;
|
|
3134
4733
|
/**
|
|
3135
4734
|
* Filters for objects created before the provided timestamp
|
|
3136
4735
|
* (inclusive).
|
|
3137
4736
|
* @format date-time
|
|
3138
4737
|
*/
|
|
3139
|
-
|
|
4738
|
+
'created_date.before'?: string;
|
|
3140
4739
|
/**
|
|
3141
4740
|
* The cursor to resume iteration from. If not provided, then iteration
|
|
3142
4741
|
* starts from the beginning.
|
|
@@ -3163,19 +4762,28 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3163
4762
|
* Filters for objects created after the provided timestamp (inclusive).
|
|
3164
4763
|
* @format date-time
|
|
3165
4764
|
*/
|
|
3166
|
-
|
|
4765
|
+
'modified_date.after'?: string;
|
|
3167
4766
|
/**
|
|
3168
4767
|
* Filters for objects created before the provided timestamp
|
|
3169
4768
|
* (inclusive).
|
|
3170
4769
|
* @format date-time
|
|
3171
4770
|
*/
|
|
3172
|
-
|
|
4771
|
+
'modified_date.before'?: string;
|
|
3173
4772
|
/**
|
|
3174
4773
|
* Fields to sort the Rev organizations by and the direction to sort
|
|
3175
4774
|
* them.
|
|
3176
4775
|
*/
|
|
3177
4776
|
sort_by?: string[];
|
|
3178
4777
|
}, params?: RequestParams) => Promise<AxiosResponse<RevOrgsListResponse, any>>;
|
|
4778
|
+
/**
|
|
4779
|
+
* @description Gets the list of Rev organizations' information belonging to the authenticated user's Dev Organization which the user is also authorized to access.
|
|
4780
|
+
*
|
|
4781
|
+
* @tags rev-orgs
|
|
4782
|
+
* @name RevOrgsListPost
|
|
4783
|
+
* @request POST:/rev-orgs.list
|
|
4784
|
+
* @secure
|
|
4785
|
+
*/
|
|
4786
|
+
revOrgsListPost: (data: RevOrgsListRequest, params?: RequestParams) => Promise<AxiosResponse<RevOrgsListResponse, any>>;
|
|
3179
4787
|
/**
|
|
3180
4788
|
* @description Updates the Rev organization's information.
|
|
3181
4789
|
*
|
|
@@ -3215,6 +4823,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3215
4823
|
/** The ID of Rev user to be retrieved. */
|
|
3216
4824
|
id: string;
|
|
3217
4825
|
}, params?: RequestParams) => Promise<AxiosResponse<RevUsersGetResponse, any>>;
|
|
4826
|
+
/**
|
|
4827
|
+
* @description Returns the Rev user of a Rev organization by its ID.
|
|
4828
|
+
*
|
|
4829
|
+
* @tags rev-users
|
|
4830
|
+
* @name RevUsersGetPost
|
|
4831
|
+
* @request POST:/rev-users.get
|
|
4832
|
+
* @secure
|
|
4833
|
+
*/
|
|
4834
|
+
revUsersGetPost: (data: RevUsersGetRequest, params?: RequestParams) => Promise<AxiosResponse<RevUsersGetResponse, any>>;
|
|
3218
4835
|
/**
|
|
3219
4836
|
* @description Links a rev user to a rev org.
|
|
3220
4837
|
*
|
|
@@ -3239,13 +4856,13 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3239
4856
|
* Filters for objects created after the provided timestamp (inclusive).
|
|
3240
4857
|
* @format date-time
|
|
3241
4858
|
*/
|
|
3242
|
-
|
|
4859
|
+
'created_date.after'?: string;
|
|
3243
4860
|
/**
|
|
3244
4861
|
* Filters for objects created before the provided timestamp
|
|
3245
4862
|
* (inclusive).
|
|
3246
4863
|
* @format date-time
|
|
3247
4864
|
*/
|
|
3248
|
-
|
|
4865
|
+
'created_date.before'?: string;
|
|
3249
4866
|
/**
|
|
3250
4867
|
* The cursor to resume iteration from. If not provided, then iteration
|
|
3251
4868
|
* starts from the beginning.
|
|
@@ -3269,13 +4886,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3269
4886
|
* Filters for objects created after the provided timestamp (inclusive).
|
|
3270
4887
|
* @format date-time
|
|
3271
4888
|
*/
|
|
3272
|
-
|
|
4889
|
+
'modified_date.after'?: string;
|
|
3273
4890
|
/**
|
|
3274
4891
|
* Filters for objects created before the provided timestamp
|
|
3275
4892
|
* (inclusive).
|
|
3276
4893
|
* @format date-time
|
|
3277
4894
|
*/
|
|
3278
|
-
|
|
4895
|
+
'modified_date.before'?: string;
|
|
4896
|
+
/** List of phone numbers to filter Rev users on. */
|
|
4897
|
+
phone_numbers?: string[];
|
|
3279
4898
|
/**
|
|
3280
4899
|
* List of IDs of Rev organizations to be filtered.
|
|
3281
4900
|
* @example ["don:identity:<partition>:devo/<dev-org-id>:revo/<rev-org-id>"]
|
|
@@ -3284,6 +4903,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3284
4903
|
/** Fields to sort the Rev users by and the direction to sort them. */
|
|
3285
4904
|
sort_by?: string[];
|
|
3286
4905
|
}, params?: RequestParams) => Promise<AxiosResponse<RevUsersListResponse, any>>;
|
|
4906
|
+
/**
|
|
4907
|
+
* @description Returns a list of all Rev Users belonging to the authenticated user's Dev Organization.
|
|
4908
|
+
*
|
|
4909
|
+
* @tags rev-users
|
|
4910
|
+
* @name RevUsersListPost
|
|
4911
|
+
* @request POST:/rev-users.list
|
|
4912
|
+
* @secure
|
|
4913
|
+
*/
|
|
4914
|
+
revUsersListPost: (data: RevUsersListRequest, params?: RequestParams) => Promise<AxiosResponse<RevUsersListResponse, any>>;
|
|
3287
4915
|
/**
|
|
3288
4916
|
* @description Unlinks a rev user from a rev org.
|
|
3289
4917
|
*
|
|
@@ -3316,6 +4944,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3316
4944
|
/** The stock schema fragment which is to be aggregated. */
|
|
3317
4945
|
stock_schema_fragment_id?: string;
|
|
3318
4946
|
}, params?: RequestParams) => Promise<AxiosResponse<AggregatedSchemaGetResponse, any>>;
|
|
4947
|
+
/**
|
|
4948
|
+
* @description Gets the aggregated schema.
|
|
4949
|
+
*
|
|
4950
|
+
* @tags customization
|
|
4951
|
+
* @name AggregatedSchemaGetPost
|
|
4952
|
+
* @request POST:/schemas.aggregated.get
|
|
4953
|
+
* @secure
|
|
4954
|
+
*/
|
|
4955
|
+
aggregatedSchemaGetPost: (data: AggregatedSchemaGetRequest, params?: RequestParams) => Promise<AxiosResponse<AggregatedSchemaGetResponse, any>>;
|
|
3319
4956
|
/**
|
|
3320
4957
|
* @description Gets a custom schema fragment.
|
|
3321
4958
|
*
|
|
@@ -3328,6 +4965,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3328
4965
|
/** The ID of the custom schema fragment. */
|
|
3329
4966
|
id: string;
|
|
3330
4967
|
}, params?: RequestParams) => Promise<AxiosResponse<CustomSchemaFragmentsGetResponse, any>>;
|
|
4968
|
+
/**
|
|
4969
|
+
* @description Gets a custom schema fragment.
|
|
4970
|
+
*
|
|
4971
|
+
* @tags customization
|
|
4972
|
+
* @name CustomSchemaFragmentsGetPost
|
|
4973
|
+
* @request POST:/schemas.custom.get
|
|
4974
|
+
* @secure
|
|
4975
|
+
*/
|
|
4976
|
+
customSchemaFragmentsGetPost: (data: CustomSchemaFragmentsGetRequest, params?: RequestParams) => Promise<AxiosResponse<CustomSchemaFragmentsGetResponse, any>>;
|
|
3331
4977
|
/**
|
|
3332
4978
|
* @description Lists custom schema fragments.
|
|
3333
4979
|
*
|
|
@@ -3358,6 +5004,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3358
5004
|
/** Filters for custom schema fragment of the provided types. */
|
|
3359
5005
|
types?: CustomSchemaFragmentType[];
|
|
3360
5006
|
}, params?: RequestParams) => Promise<AxiosResponse<CustomSchemaFragmentsListResponse, any>>;
|
|
5007
|
+
/**
|
|
5008
|
+
* @description Lists custom schema fragments.
|
|
5009
|
+
*
|
|
5010
|
+
* @tags customization
|
|
5011
|
+
* @name CustomSchemaFragmentsListPost
|
|
5012
|
+
* @request POST:/schemas.custom.list
|
|
5013
|
+
* @secure
|
|
5014
|
+
*/
|
|
5015
|
+
customSchemaFragmentsListPost: (data: CustomSchemaFragmentsListRequest, params?: RequestParams) => Promise<AxiosResponse<CustomSchemaFragmentsListResponse, any>>;
|
|
3361
5016
|
/**
|
|
3362
5017
|
* @description Creates or updates a custom schema fragment.
|
|
3363
5018
|
*
|
|
@@ -3384,6 +5039,36 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3384
5039
|
/** List of leaf types for which subtypes are required. */
|
|
3385
5040
|
leaf_types?: string[];
|
|
3386
5041
|
}, params?: RequestParams) => Promise<AxiosResponse<SubtypesListResponse, any>>;
|
|
5042
|
+
/**
|
|
5043
|
+
* @description Lists subtypes.
|
|
5044
|
+
*
|
|
5045
|
+
* @tags customization
|
|
5046
|
+
* @name SubtypesListPost
|
|
5047
|
+
* @request POST:/schemas.subtypes.list
|
|
5048
|
+
* @secure
|
|
5049
|
+
*/
|
|
5050
|
+
subtypesListPost: (data: SubtypesListRequest, params?: RequestParams) => Promise<AxiosResponse<SubtypesListResponse, any>>;
|
|
5051
|
+
/**
|
|
5052
|
+
* @description Gets a service account.
|
|
5053
|
+
*
|
|
5054
|
+
* @tags service-accounts
|
|
5055
|
+
* @name ServiceAccountsGet
|
|
5056
|
+
* @request GET:/service-accounts.get
|
|
5057
|
+
* @secure
|
|
5058
|
+
*/
|
|
5059
|
+
serviceAccountsGet: (query: {
|
|
5060
|
+
/** The ID of the requested service account. */
|
|
5061
|
+
id: string;
|
|
5062
|
+
}, params?: RequestParams) => Promise<AxiosResponse<ServiceAccountsGetResponse, any>>;
|
|
5063
|
+
/**
|
|
5064
|
+
* @description Gets a service account.
|
|
5065
|
+
*
|
|
5066
|
+
* @tags service-accounts
|
|
5067
|
+
* @name ServiceAccountsGetPost
|
|
5068
|
+
* @request POST:/service-accounts.get
|
|
5069
|
+
* @secure
|
|
5070
|
+
*/
|
|
5071
|
+
serviceAccountsGetPost: (data: ServiceAccountsGetRequest, params?: RequestParams) => Promise<AxiosResponse<ServiceAccountsGetResponse, any>>;
|
|
3387
5072
|
/**
|
|
3388
5073
|
* @description Assigns the SLA to a set of Rev organizations.
|
|
3389
5074
|
*
|
|
@@ -3414,6 +5099,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3414
5099
|
/** The ID of the SLA to get. */
|
|
3415
5100
|
id: string;
|
|
3416
5101
|
}, params?: RequestParams) => Promise<AxiosResponse<SlasGetResponse, any>>;
|
|
5102
|
+
/**
|
|
5103
|
+
* @description Gets an SLA.
|
|
5104
|
+
*
|
|
5105
|
+
* @tags slas
|
|
5106
|
+
* @name SlasGetPost
|
|
5107
|
+
* @request POST:/slas.get
|
|
5108
|
+
* @secure
|
|
5109
|
+
*/
|
|
5110
|
+
slasGetPost: (data: SlasGetRequest, params?: RequestParams) => Promise<AxiosResponse<SlasGetResponse, any>>;
|
|
3417
5111
|
/**
|
|
3418
5112
|
* @description Lists SLAs matching a filter.
|
|
3419
5113
|
*
|
|
@@ -3441,6 +5135,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3441
5135
|
/** The SLA statuses the filter matches. */
|
|
3442
5136
|
status?: SlaStatus[];
|
|
3443
5137
|
}, params?: RequestParams) => Promise<AxiosResponse<SlasListResponse, any>>;
|
|
5138
|
+
/**
|
|
5139
|
+
* @description Lists SLAs matching a filter.
|
|
5140
|
+
*
|
|
5141
|
+
* @tags slas
|
|
5142
|
+
* @name SlasListPost
|
|
5143
|
+
* @request POST:/slas.list
|
|
5144
|
+
* @secure
|
|
5145
|
+
*/
|
|
5146
|
+
slasListPost: (data: SlasListRequest, params?: RequestParams) => Promise<AxiosResponse<SlasListResponse, any>>;
|
|
3444
5147
|
/**
|
|
3445
5148
|
* @description Changes the status of an SLA.
|
|
3446
5149
|
*
|
|
@@ -3487,6 +5190,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3487
5190
|
/** Fields to sort the system users by and the direction to sort them. */
|
|
3488
5191
|
sort_by?: string[];
|
|
3489
5192
|
}, params?: RequestParams) => Promise<AxiosResponse<SysUsersListResponse, any>>;
|
|
5193
|
+
/**
|
|
5194
|
+
* @description Lists system users within your organization.
|
|
5195
|
+
*
|
|
5196
|
+
* @tags sys-users
|
|
5197
|
+
* @name SysUsersListPost
|
|
5198
|
+
* @request POST:/sys-users.list
|
|
5199
|
+
* @secure
|
|
5200
|
+
*/
|
|
5201
|
+
sysUsersListPost: (data: SysUsersListRequest, params?: RequestParams) => Promise<AxiosResponse<SysUsersListResponse, any>>;
|
|
3490
5202
|
/**
|
|
3491
5203
|
* @description Updates the system user.
|
|
3492
5204
|
*
|
|
@@ -3547,6 +5259,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3547
5259
|
*/
|
|
3548
5260
|
visibility?: TimelineEntryVisibility[];
|
|
3549
5261
|
}, params?: RequestParams) => Promise<AxiosResponse<TimelineEntriesListResponse, any>>;
|
|
5262
|
+
/**
|
|
5263
|
+
* @description Lists the timeline entries for an object.
|
|
5264
|
+
*
|
|
5265
|
+
* @tags timeline-entries
|
|
5266
|
+
* @name TimelineEntriesListPost
|
|
5267
|
+
* @request POST:/timeline-entries.list
|
|
5268
|
+
* @secure
|
|
5269
|
+
*/
|
|
5270
|
+
timelineEntriesListPost: (data: TimelineEntriesListRequest, params?: RequestParams) => Promise<AxiosResponse<TimelineEntriesListResponse, any>>;
|
|
3550
5271
|
/**
|
|
3551
5272
|
* @description Creates new work ([issue](https://devrev.ai/docs/product/build), [ticket](https://devrev.ai/docs/product/support)) item. [task](https://docs.devrev.ai/product/tasks) and opportunity work types are supported in the beta version.
|
|
3552
5273
|
*
|
|
@@ -3584,6 +5305,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3584
5305
|
* @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
|
|
3585
5306
|
*/
|
|
3586
5307
|
created_by?: string[];
|
|
5308
|
+
/** Filters for custom fields. */
|
|
5309
|
+
custom_fields?: object;
|
|
3587
5310
|
/**
|
|
3588
5311
|
* The number of work items to return. The default is '50', the maximum
|
|
3589
5312
|
* is '5000'.
|
|
@@ -3591,45 +5314,56 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3591
5314
|
*/
|
|
3592
5315
|
first?: number;
|
|
3593
5316
|
/** Filters for issues with any of the provided priorities. */
|
|
3594
|
-
|
|
5317
|
+
'issue.priority'?: IssuePriority[];
|
|
3595
5318
|
/**
|
|
3596
5319
|
* Filters for issues with any of the provided Rev organizations.
|
|
3597
5320
|
* @example ["don:identity:<partition>:devo/<dev-org-id>:revo/<rev-org-id>"]
|
|
3598
5321
|
*/
|
|
3599
|
-
|
|
5322
|
+
'issue.rev_orgs'?: string[];
|
|
3600
5323
|
/**
|
|
3601
5324
|
* Filters for opportunities belonging to any of the provided accounts.
|
|
3602
5325
|
* @example ["don:core:<partition>:devo/<dev-org-id>:account/<account-id>"]
|
|
3603
5326
|
*/
|
|
3604
|
-
|
|
5327
|
+
'opportunity.account'?: string[];
|
|
3605
5328
|
/** Filters for opportunities with any of the provided contacts. */
|
|
3606
|
-
|
|
5329
|
+
'opportunity.contacts'?: string[];
|
|
3607
5330
|
/**
|
|
3608
5331
|
* Filters for work owned by any of these users.
|
|
3609
5332
|
* @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
|
|
3610
5333
|
*/
|
|
3611
5334
|
owned_by?: string[];
|
|
5335
|
+
/** Fields to sort the work items by and the direction to sort them. */
|
|
5336
|
+
sort_by?: string[];
|
|
3612
5337
|
/** Filters for records in the provided stage(s). */
|
|
3613
|
-
|
|
5338
|
+
'stage.name'?: string[];
|
|
3614
5339
|
/** Filters for tickets belonging to specific groups. */
|
|
3615
|
-
|
|
5340
|
+
'ticket.group'?: string[];
|
|
3616
5341
|
/** Filters for tickets that are spam. */
|
|
3617
|
-
|
|
5342
|
+
'ticket.is_spam'?: boolean;
|
|
3618
5343
|
/** Filters for tickets that need response. */
|
|
3619
|
-
|
|
5344
|
+
'ticket.needs_response'?: boolean;
|
|
3620
5345
|
/**
|
|
3621
5346
|
* Filters for tickets that are associated with any of the provided Rev
|
|
3622
5347
|
* organizations.
|
|
3623
5348
|
* @example ["don:identity:<partition>:devo/<dev-org-id>:revo/<rev-org-id>"]
|
|
3624
5349
|
*/
|
|
3625
|
-
|
|
5350
|
+
'ticket.rev_org'?: string[];
|
|
3626
5351
|
/** Filters for tickets with any of the provided severities. */
|
|
3627
|
-
|
|
5352
|
+
'ticket.severity'?: TicketSeverity[];
|
|
3628
5353
|
/** Filters for tickets with any of the provided source channels. */
|
|
3629
|
-
|
|
5354
|
+
'ticket.source_channel'?: string[];
|
|
3630
5355
|
/** Filters for work of the provided types. */
|
|
3631
5356
|
type?: WorkType[];
|
|
3632
5357
|
}, params?: RequestParams) => Promise<AxiosResponse<WorksExportResponse, any>>;
|
|
5358
|
+
/**
|
|
5359
|
+
* @description Exports a collection of work items.
|
|
5360
|
+
*
|
|
5361
|
+
* @tags works
|
|
5362
|
+
* @name WorksExportPost
|
|
5363
|
+
* @request POST:/works.export
|
|
5364
|
+
* @secure
|
|
5365
|
+
*/
|
|
5366
|
+
worksExportPost: (data: WorksExportRequest, params?: RequestParams) => Promise<AxiosResponse<WorksExportResponse, any>>;
|
|
3633
5367
|
/**
|
|
3634
5368
|
* @description Gets a work item's information.
|
|
3635
5369
|
*
|
|
@@ -3645,6 +5379,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3645
5379
|
*/
|
|
3646
5380
|
id: string;
|
|
3647
5381
|
}, params?: RequestParams) => Promise<AxiosResponse<WorksGetResponse, any>>;
|
|
5382
|
+
/**
|
|
5383
|
+
* @description Gets a work item's information.
|
|
5384
|
+
*
|
|
5385
|
+
* @tags works
|
|
5386
|
+
* @name WorksGetPost
|
|
5387
|
+
* @request POST:/works.get
|
|
5388
|
+
* @secure
|
|
5389
|
+
*/
|
|
5390
|
+
worksGetPost: (data: WorksGetRequest, params?: RequestParams) => Promise<AxiosResponse<WorksGetResponse, any>>;
|
|
3648
5391
|
/**
|
|
3649
5392
|
* @description Lists a collection of work items.
|
|
3650
5393
|
*
|
|
@@ -3669,13 +5412,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3669
5412
|
* starts from the beginning.
|
|
3670
5413
|
*/
|
|
3671
5414
|
cursor?: string;
|
|
5415
|
+
/** Filters for custom fields. */
|
|
5416
|
+
custom_fields?: object;
|
|
3672
5417
|
/** Filters for issues with any of the provided priorities. */
|
|
3673
|
-
|
|
5418
|
+
'issue.priority'?: IssuePriority[];
|
|
3674
5419
|
/**
|
|
3675
5420
|
* Filters for issues with any of the provided Rev organizations.
|
|
3676
5421
|
* @example ["don:identity:<partition>:devo/<dev-org-id>:revo/<rev-org-id>"]
|
|
3677
5422
|
*/
|
|
3678
|
-
|
|
5423
|
+
'issue.rev_orgs'?: string[];
|
|
3679
5424
|
/**
|
|
3680
5425
|
* The maximum number of works to return. The default is '50'.
|
|
3681
5426
|
* @format int32
|
|
@@ -3690,35 +5435,46 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3690
5435
|
* Filters for opportunities belonging to any of the provided accounts.
|
|
3691
5436
|
* @example ["don:core:<partition>:devo/<dev-org-id>:account/<account-id>"]
|
|
3692
5437
|
*/
|
|
3693
|
-
|
|
5438
|
+
'opportunity.account'?: string[];
|
|
3694
5439
|
/** Filters for opportunities with any of the provided contacts. */
|
|
3695
|
-
|
|
5440
|
+
'opportunity.contacts'?: string[];
|
|
3696
5441
|
/**
|
|
3697
5442
|
* Filters for work owned by any of these users.
|
|
3698
5443
|
* @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
|
|
3699
5444
|
*/
|
|
3700
5445
|
owned_by?: string[];
|
|
5446
|
+
/** Fields to sort the works by and the direction to sort them. */
|
|
5447
|
+
sort_by?: string[];
|
|
3701
5448
|
/** Filters for records in the provided stage(s). */
|
|
3702
|
-
|
|
5449
|
+
'stage.name'?: string[];
|
|
3703
5450
|
/** Filters for tickets belonging to specific groups. */
|
|
3704
|
-
|
|
5451
|
+
'ticket.group'?: string[];
|
|
3705
5452
|
/** Filters for tickets that are spam. */
|
|
3706
|
-
|
|
5453
|
+
'ticket.is_spam'?: boolean;
|
|
3707
5454
|
/** Filters for tickets that need response. */
|
|
3708
|
-
|
|
5455
|
+
'ticket.needs_response'?: boolean;
|
|
3709
5456
|
/**
|
|
3710
5457
|
* Filters for tickets that are associated with any of the provided Rev
|
|
3711
5458
|
* organizations.
|
|
3712
5459
|
* @example ["don:identity:<partition>:devo/<dev-org-id>:revo/<rev-org-id>"]
|
|
3713
5460
|
*/
|
|
3714
|
-
|
|
5461
|
+
'ticket.rev_org'?: string[];
|
|
3715
5462
|
/** Filters for tickets with any of the provided severities. */
|
|
3716
|
-
|
|
5463
|
+
'ticket.severity'?: TicketSeverity[];
|
|
3717
5464
|
/** Filters for tickets with any of the provided source channels. */
|
|
3718
|
-
|
|
5465
|
+
'ticket.source_channel'?: string[];
|
|
3719
5466
|
/** Filters for work of the provided types. */
|
|
3720
5467
|
type?: WorkType[];
|
|
3721
5468
|
}, params?: RequestParams) => Promise<AxiosResponse<WorksListResponse, any>>;
|
|
5469
|
+
/**
|
|
5470
|
+
* @description Lists a collection of work items.
|
|
5471
|
+
*
|
|
5472
|
+
* @tags works
|
|
5473
|
+
* @name WorksListPost
|
|
5474
|
+
* @request POST:/works.list
|
|
5475
|
+
* @secure
|
|
5476
|
+
*/
|
|
5477
|
+
worksListPost: (data: WorksListRequest, params?: RequestParams) => Promise<AxiosResponse<WorksListResponse, any>>;
|
|
3722
5478
|
/**
|
|
3723
5479
|
* @description Updates a work item's information.
|
|
3724
5480
|
*
|