@devrev/typescript-sdk 1.1.31 → 1.1.32
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.
|
@@ -420,6 +420,20 @@ export type AppFragmentSummary = CustomSchemaFragmentBaseSummary;
|
|
|
420
420
|
* Metric with corresponding target values.
|
|
421
421
|
*/
|
|
422
422
|
export interface ArchetypeMetricTarget {
|
|
423
|
+
/**
|
|
424
|
+
* For breached metrics the time they entered into breach. This is the
|
|
425
|
+
* same as what the target date was, unless the breach happened due to
|
|
426
|
+
* a different policy starting to apply.
|
|
427
|
+
* @format date-time
|
|
428
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
429
|
+
*/
|
|
430
|
+
breached_at?: string;
|
|
431
|
+
/**
|
|
432
|
+
* For completed metrics the time (in minutes) it took to complete
|
|
433
|
+
* them. (Taking into account the schedule if any).
|
|
434
|
+
* @format int32
|
|
435
|
+
*/
|
|
436
|
+
completed_in?: number;
|
|
423
437
|
/**
|
|
424
438
|
* If true, the schedule attached to this metric is out of schedule at
|
|
425
439
|
* the time of the query. It is not set for metrics in *completed*
|
|
@@ -427,12 +441,26 @@ export interface ArchetypeMetricTarget {
|
|
|
427
441
|
*/
|
|
428
442
|
is_out_of_schedule?: boolean;
|
|
429
443
|
metric_definition: MetricDefinitionSummary;
|
|
444
|
+
/**
|
|
445
|
+
* The next time the schedule will change its state, if such is known.
|
|
446
|
+
* @format date-time
|
|
447
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
448
|
+
*/
|
|
449
|
+
next_schedule_transition?: string;
|
|
430
450
|
org_schedule?: OrgScheduleSummary;
|
|
431
451
|
/**
|
|
432
452
|
* Time in minutes that remains on a paused metric.
|
|
433
453
|
* @format int32
|
|
434
454
|
*/
|
|
435
455
|
remaining_time?: number;
|
|
456
|
+
/** Metric stage corresponding to the applicable SLA. */
|
|
457
|
+
stage: string;
|
|
458
|
+
/**
|
|
459
|
+
* It is an indicator of whether the metric has ever been breached
|
|
460
|
+
* (missed). If not, it shows whether the metric is completed, in
|
|
461
|
+
* progress, or not part of the applied policy.
|
|
462
|
+
*/
|
|
463
|
+
status?: string;
|
|
436
464
|
/**
|
|
437
465
|
* Time at which the metric would breach SLA if no action taken.
|
|
438
466
|
* @format date-time
|
|
@@ -2368,6 +2396,103 @@ export interface CreateWeeklyOrgScheduleInterval {
|
|
|
2368
2396
|
* Static collection of Devrev objects.
|
|
2369
2397
|
*/
|
|
2370
2398
|
export type CuratedVistaSummary = VistaBaseSummary;
|
|
2399
|
+
/** custom-link-type */
|
|
2400
|
+
export type CustomLinkType = AtomBase;
|
|
2401
|
+
/** custom-link-type-create-request */
|
|
2402
|
+
export interface CustomLinkTypeCreateRequest {
|
|
2403
|
+
/** The name of the link in the backward direction. */
|
|
2404
|
+
backward_name: string;
|
|
2405
|
+
/** Whether the link type is deprecated. */
|
|
2406
|
+
deprecated?: boolean;
|
|
2407
|
+
/** The name of the link in the forward direction. */
|
|
2408
|
+
forward_name: string;
|
|
2409
|
+
/** The name of the custom link type. */
|
|
2410
|
+
name: string;
|
|
2411
|
+
/** Types from which the link can be made from. */
|
|
2412
|
+
source_types: LinkTargetDescriptor[];
|
|
2413
|
+
/** Types to which the link can be made to. */
|
|
2414
|
+
target_types: LinkTargetDescriptor[];
|
|
2415
|
+
/** The tooltip of the custom link type. */
|
|
2416
|
+
tooltip?: string;
|
|
2417
|
+
}
|
|
2418
|
+
/** custom-link-type-create-response */
|
|
2419
|
+
export interface CustomLinkTypeCreateResponse {
|
|
2420
|
+
custom_link_type: CustomLinkType;
|
|
2421
|
+
}
|
|
2422
|
+
/** custom-link-type-get-request */
|
|
2423
|
+
export interface CustomLinkTypeGetRequest {
|
|
2424
|
+
/** The ID of the custom link type to get. */
|
|
2425
|
+
id: string;
|
|
2426
|
+
}
|
|
2427
|
+
/** custom-link-type-get-response */
|
|
2428
|
+
export interface CustomLinkTypeGetResponse {
|
|
2429
|
+
custom_link_type: CustomLinkType;
|
|
2430
|
+
}
|
|
2431
|
+
/** custom-link-type-list-request */
|
|
2432
|
+
export interface CustomLinkTypeListRequest {
|
|
2433
|
+
/**
|
|
2434
|
+
* The cursor to resume iteration from. If not provided, then
|
|
2435
|
+
* iteration starts from the beginning.
|
|
2436
|
+
*/
|
|
2437
|
+
cursor?: string;
|
|
2438
|
+
/** Whether only deprecated link types should be filtered. */
|
|
2439
|
+
deprecated?: boolean;
|
|
2440
|
+
/**
|
|
2441
|
+
* The maximum number of items.
|
|
2442
|
+
* @format int32
|
|
2443
|
+
*/
|
|
2444
|
+
limit?: number;
|
|
2445
|
+
/**
|
|
2446
|
+
* The iteration mode to use. If "after", then entries after the provided
|
|
2447
|
+
* cursor will be returned, or if no cursor is provided, then from the
|
|
2448
|
+
* beginning. If "before", then entries before the provided cursor will be
|
|
2449
|
+
* returned, or if no cursor is provided, then from the end. Entries will
|
|
2450
|
+
* always be returned in the specified sort-by order.
|
|
2451
|
+
*/
|
|
2452
|
+
mode?: ListMode;
|
|
2453
|
+
/** The list of link type names. */
|
|
2454
|
+
name?: string[];
|
|
2455
|
+
/** The list of fields to sort the items by and how to sort them. */
|
|
2456
|
+
sort_by?: string[];
|
|
2457
|
+
source_types?: LinkDescriptorFilter;
|
|
2458
|
+
target_types?: LinkDescriptorFilter;
|
|
2459
|
+
}
|
|
2460
|
+
/** custom-link-type-list-response */
|
|
2461
|
+
export interface CustomLinkTypeListResponse {
|
|
2462
|
+
/**
|
|
2463
|
+
* The cursor used to iterate subsequent results in accordance to the
|
|
2464
|
+
* sort order. If not set, then no later elements exist.
|
|
2465
|
+
*/
|
|
2466
|
+
next_cursor?: string;
|
|
2467
|
+
/**
|
|
2468
|
+
* The cursor used to iterate preceding results in accordance to the
|
|
2469
|
+
* sort order. If not set, then no prior elements exist.
|
|
2470
|
+
*/
|
|
2471
|
+
prev_cursor?: string;
|
|
2472
|
+
/** The custom link types. */
|
|
2473
|
+
result: CustomLinkType[];
|
|
2474
|
+
}
|
|
2475
|
+
/** custom-link-type-update-request */
|
|
2476
|
+
export interface CustomLinkTypeUpdateRequest {
|
|
2477
|
+
/** The updated name of the link in the backward direction. */
|
|
2478
|
+
backward_name?: string;
|
|
2479
|
+
/** Whether the link type is deprecated. */
|
|
2480
|
+
deprecated?: boolean;
|
|
2481
|
+
/** The updated name of the link in the forward direction. */
|
|
2482
|
+
forward_name?: string;
|
|
2483
|
+
/** The ID of the custom link type to update. */
|
|
2484
|
+
id: string;
|
|
2485
|
+
/** The updated name of the custom link type. */
|
|
2486
|
+
name?: string;
|
|
2487
|
+
source_types?: UpdateLinkTargetDescriptorList;
|
|
2488
|
+
target_types?: UpdateLinkTargetDescriptorList;
|
|
2489
|
+
/** The updated tooltip of the custom link type. */
|
|
2490
|
+
tooltip?: string;
|
|
2491
|
+
}
|
|
2492
|
+
/** custom-link-type-update-response */
|
|
2493
|
+
export interface CustomLinkTypeUpdateResponse {
|
|
2494
|
+
custom_link_type: CustomLinkType;
|
|
2495
|
+
}
|
|
2371
2496
|
/** custom-object-search-summary */
|
|
2372
2497
|
export type CustomObjectSearchSummary = SearchSummaryBase & {
|
|
2373
2498
|
custom_object: CustomObjectSummary;
|
|
@@ -2972,6 +3097,13 @@ export interface DevOrgAuthConnectionsUpdateResponse {
|
|
|
2972
3097
|
}
|
|
2973
3098
|
/** dev-user */
|
|
2974
3099
|
export type DevUser = UserBase & {
|
|
3100
|
+
/** Custom fields. */
|
|
3101
|
+
custom_fields?: object;
|
|
3102
|
+
/**
|
|
3103
|
+
* Custom schema fragments.
|
|
3104
|
+
* @example ["don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"]
|
|
3105
|
+
*/
|
|
3106
|
+
custom_schema_fragments?: string[];
|
|
2975
3107
|
/**
|
|
2976
3108
|
* Start date of the user's employment.
|
|
2977
3109
|
* @format date-time
|
|
@@ -2984,6 +3116,13 @@ export type DevUser = UserBase & {
|
|
|
2984
3116
|
job_history?: JobHistoryItem[];
|
|
2985
3117
|
/** Array of skills of the user. */
|
|
2986
3118
|
skills?: UserSkill[];
|
|
3119
|
+
/**
|
|
3120
|
+
* Stock schema fragment.
|
|
3121
|
+
* @example "don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"
|
|
3122
|
+
*/
|
|
3123
|
+
stock_schema_fragment?: string;
|
|
3124
|
+
/** Subtype corresponding to the custom type fragment. */
|
|
3125
|
+
subtype?: string;
|
|
2987
3126
|
};
|
|
2988
3127
|
/** dev-user-external-identity-filter */
|
|
2989
3128
|
export interface DevUserExternalIdentityFilter {
|
|
@@ -3075,6 +3214,8 @@ export interface DevUsersListRequest {
|
|
|
3075
3214
|
* iteration starts from the beginning.
|
|
3076
3215
|
*/
|
|
3077
3216
|
cursor?: string;
|
|
3217
|
+
/** Filters for custom fields. */
|
|
3218
|
+
custom_fields?: object;
|
|
3078
3219
|
/** Filters Dev users based on email addresses. */
|
|
3079
3220
|
email?: string[];
|
|
3080
3221
|
/** Filters Dev users based on external identity. */
|
|
@@ -3135,6 +3276,16 @@ export interface DevUsersSelfResponse {
|
|
|
3135
3276
|
* user.
|
|
3136
3277
|
*/
|
|
3137
3278
|
export interface DevUsersSelfUpdateRequest {
|
|
3279
|
+
/** Application-defined custom fields. */
|
|
3280
|
+
custom_fields?: object;
|
|
3281
|
+
/**
|
|
3282
|
+
* Requested custom schemas described abstractly. Every provided schema's
|
|
3283
|
+
* custom field must be specified, otherwise a bad request error is
|
|
3284
|
+
* returned. If a new custom schema specifier is provided, then it will be
|
|
3285
|
+
* added to the work, otherwise if a custom schema is omitted from the
|
|
3286
|
+
* specifier, it remains unmodified.
|
|
3287
|
+
*/
|
|
3288
|
+
custom_schema_spec?: CustomSchemaSpec;
|
|
3138
3289
|
/** The updated display name of the Dev user. */
|
|
3139
3290
|
display_name?: string;
|
|
3140
3291
|
/**
|
|
@@ -3182,6 +3333,16 @@ export interface DevUsersUpdateJobHistoryItem {
|
|
|
3182
3333
|
* provided Dev user.
|
|
3183
3334
|
*/
|
|
3184
3335
|
export interface DevUsersUpdateRequest {
|
|
3336
|
+
/** Application-defined custom fields. */
|
|
3337
|
+
custom_fields?: object;
|
|
3338
|
+
/**
|
|
3339
|
+
* Requested custom schemas described abstractly. Every provided schema's
|
|
3340
|
+
* custom field must be specified, otherwise a bad request error is
|
|
3341
|
+
* returned. If a new custom schema specifier is provided, then it will be
|
|
3342
|
+
* added to the work, otherwise if a custom schema is omitted from the
|
|
3343
|
+
* specifier, it remains unmodified.
|
|
3344
|
+
*/
|
|
3345
|
+
custom_schema_spec?: CustomSchemaSpec;
|
|
3185
3346
|
/** The updated display name of the Dev user. */
|
|
3186
3347
|
display_name?: string;
|
|
3187
3348
|
/**
|
|
@@ -3816,6 +3977,11 @@ export interface EventDevUserUpdated {
|
|
|
3816
3977
|
dev_user: DevUser;
|
|
3817
3978
|
old_dev_user?: DevUser;
|
|
3818
3979
|
}
|
|
3980
|
+
export declare enum EventFetchedResult {
|
|
3981
|
+
Forbidden = "forbidden",
|
|
3982
|
+
NotFound = "not_found",
|
|
3983
|
+
Ok = "ok"
|
|
3984
|
+
}
|
|
3819
3985
|
/** event-group-created */
|
|
3820
3986
|
export interface EventGroupCreated {
|
|
3821
3987
|
group: Group;
|
|
@@ -4105,6 +4271,19 @@ export interface EventWorkDeleted {
|
|
|
4105
4271
|
id: string;
|
|
4106
4272
|
old_work?: Work;
|
|
4107
4273
|
}
|
|
4274
|
+
/** event-work-fetched */
|
|
4275
|
+
export type EventWorkFetched = (Empty | EventWorkFetchedOk) & {
|
|
4276
|
+
/**
|
|
4277
|
+
* The ID of the work that was fetched.
|
|
4278
|
+
* @example "ISS-12345"
|
|
4279
|
+
*/
|
|
4280
|
+
id: string;
|
|
4281
|
+
result: EventFetchedResult;
|
|
4282
|
+
};
|
|
4283
|
+
/** event-work-fetched-ok */
|
|
4284
|
+
export interface EventWorkFetchedOk {
|
|
4285
|
+
work?: Work;
|
|
4286
|
+
}
|
|
4108
4287
|
/** event-work-updated */
|
|
4109
4288
|
export interface EventWorkUpdated {
|
|
4110
4289
|
old_work?: Work;
|
|
@@ -4661,6 +4840,12 @@ export interface IncidentsCreateRequest {
|
|
|
4661
4840
|
mitigated_date?: string;
|
|
4662
4841
|
/** User IDs of the users that own the incident. */
|
|
4663
4842
|
owned_by?: string[];
|
|
4843
|
+
/** The article ids of the Post-Incident Analysis(PIA) of the incident. */
|
|
4844
|
+
pia?: string[];
|
|
4845
|
+
/** The article ids of the playbook(s) associated with the incident. */
|
|
4846
|
+
playbooks?: string[];
|
|
4847
|
+
/** The article ids of other documents associated with the incident. */
|
|
4848
|
+
related_docs?: string[];
|
|
4664
4849
|
/**
|
|
4665
4850
|
* The entity that first reported the incident.
|
|
4666
4851
|
* @format int64
|
|
@@ -4725,8 +4910,7 @@ export interface IncidentsGetResponse {
|
|
|
4725
4910
|
export interface IncidentsGroup {
|
|
4726
4911
|
/** The group of incidents. */
|
|
4727
4912
|
incidents: Incident[];
|
|
4728
|
-
|
|
4729
|
-
key: string;
|
|
4913
|
+
key: FieldValue;
|
|
4730
4914
|
/**
|
|
4731
4915
|
* The cursor used to iterate subsequent results in accordance to the
|
|
4732
4916
|
* sort order. If not set, then no later elements exist.
|
|
@@ -4788,6 +4972,21 @@ export interface IncidentsGroupRequest {
|
|
|
4788
4972
|
modified_date?: DateFilter;
|
|
4789
4973
|
/** Filters for incidents owned by any of the provided users. */
|
|
4790
4974
|
owned_by?: string[];
|
|
4975
|
+
/**
|
|
4976
|
+
* Filters for incidents with any of the provided PIAs.
|
|
4977
|
+
* @example ["ARTICLE-12345"]
|
|
4978
|
+
*/
|
|
4979
|
+
pia?: string[];
|
|
4980
|
+
/**
|
|
4981
|
+
* Filters for incidents with any of the provided playbooks.
|
|
4982
|
+
* @example ["ARTICLE-12345"]
|
|
4983
|
+
*/
|
|
4984
|
+
playbook?: string[];
|
|
4985
|
+
/**
|
|
4986
|
+
* Filters for incidents with any of the provided related docs.
|
|
4987
|
+
* @example ["ARTICLE-12345"]
|
|
4988
|
+
*/
|
|
4989
|
+
related_docs?: string[];
|
|
4791
4990
|
/** Filters for incidents with any of the provided reporters. */
|
|
4792
4991
|
reported_by?: number[];
|
|
4793
4992
|
/** Filters for incidents containing any of the provided severities. */
|
|
@@ -4859,6 +5058,21 @@ export interface IncidentsListRequest {
|
|
|
4859
5058
|
modified_date?: DateFilter;
|
|
4860
5059
|
/** Filters for incidents owned by any of the provided users. */
|
|
4861
5060
|
owned_by?: string[];
|
|
5061
|
+
/**
|
|
5062
|
+
* Filters for incidents with any of the provided PIAs.
|
|
5063
|
+
* @example ["ARTICLE-12345"]
|
|
5064
|
+
*/
|
|
5065
|
+
pia?: string[];
|
|
5066
|
+
/**
|
|
5067
|
+
* Filters for incidents with any of the provided playbooks.
|
|
5068
|
+
* @example ["ARTICLE-12345"]
|
|
5069
|
+
*/
|
|
5070
|
+
playbook?: string[];
|
|
5071
|
+
/**
|
|
5072
|
+
* Filters for incidents with any of the provided related docs.
|
|
5073
|
+
* @example ["ARTICLE-12345"]
|
|
5074
|
+
*/
|
|
5075
|
+
related_docs?: string[];
|
|
4862
5076
|
/** Filters for incidents with any of the provided reporters. */
|
|
4863
5077
|
reported_by?: number[];
|
|
4864
5078
|
/** Filters for incidents containing any of the provided severities. */
|
|
@@ -4928,6 +5142,9 @@ export interface IncidentsUpdateRequest {
|
|
|
4928
5142
|
*/
|
|
4929
5143
|
mitigated_date?: string;
|
|
4930
5144
|
owned_by?: UpdateIncidentOwnedBy;
|
|
5145
|
+
pia?: UpdateIncidentPia;
|
|
5146
|
+
playbooks?: UpdateIncidentPlaybooks;
|
|
5147
|
+
related_docs?: UpdateIncidentRelatedDocs;
|
|
4931
5148
|
/**
|
|
4932
5149
|
* The entity that first reported the incident.
|
|
4933
5150
|
* @format int64
|
|
@@ -5089,6 +5306,11 @@ export type Link = AtomBase & {
|
|
|
5089
5306
|
source: LinkEndpointSummary;
|
|
5090
5307
|
target: LinkEndpointSummary;
|
|
5091
5308
|
};
|
|
5309
|
+
/** link-descriptor-filter */
|
|
5310
|
+
export interface LinkDescriptorFilter {
|
|
5311
|
+
/** List of link descriptors. */
|
|
5312
|
+
link_descriptors: LinkTargetDescriptor[];
|
|
5313
|
+
}
|
|
5092
5314
|
/** link-endpoint-summary */
|
|
5093
5315
|
export type LinkEndpointSummary = (CapabilitySummary | ConversationSummary | EnhancementSummary | FeatureSummary | IssueSummary | OpportunitySummary | ProductSummary | TaskSummary | TicketSummary) & {
|
|
5094
5316
|
type: LinkEndpointType;
|
|
@@ -5148,6 +5370,11 @@ export type LinkSummary = AtomBaseSummary & {
|
|
|
5148
5370
|
source: LinkEndpointSummary;
|
|
5149
5371
|
target: LinkEndpointSummary;
|
|
5150
5372
|
};
|
|
5373
|
+
/**
|
|
5374
|
+
* link-target-descriptor
|
|
5375
|
+
* A link target descriptor.
|
|
5376
|
+
*/
|
|
5377
|
+
export type LinkTargetDescriptor = object;
|
|
5151
5378
|
/** Type of link used to define the relationship. */
|
|
5152
5379
|
export declare enum LinkType {
|
|
5153
5380
|
CustomLink = "custom_link",
|
|
@@ -8540,6 +8767,8 @@ export interface SubtypesListResponse {
|
|
|
8540
8767
|
export type Survey = AtomBase & {
|
|
8541
8768
|
/** Description of the survey. */
|
|
8542
8769
|
description?: string;
|
|
8770
|
+
/** Header of the survey. */
|
|
8771
|
+
header?: string;
|
|
8543
8772
|
/** Text posted when introducing the survey to the responder. */
|
|
8544
8773
|
introductory_text?: string;
|
|
8545
8774
|
/**
|
|
@@ -8553,6 +8782,8 @@ export type Survey = AtomBase & {
|
|
|
8553
8782
|
schema?: SchemaFieldDescriptor[];
|
|
8554
8783
|
/** List of all the fields and their respective metadata in the schema. */
|
|
8555
8784
|
schema_with_metadata?: SurveyFieldWithMetadata[];
|
|
8785
|
+
/** Title of the survey. */
|
|
8786
|
+
title?: string;
|
|
8556
8787
|
};
|
|
8557
8788
|
/**
|
|
8558
8789
|
* survey-aggregation-filter
|
|
@@ -8593,6 +8824,8 @@ export type SurveyResponse = AtomBase & {
|
|
|
8593
8824
|
export interface SurveysCreateRequest {
|
|
8594
8825
|
/** Description about the survey. */
|
|
8595
8826
|
description?: string;
|
|
8827
|
+
/** Header of the survey. */
|
|
8828
|
+
header?: string;
|
|
8596
8829
|
/** Text posted when introducing the survey to the responder. */
|
|
8597
8830
|
introductory_text?: string;
|
|
8598
8831
|
/** The survey's name. */
|
|
@@ -8603,6 +8836,8 @@ export interface SurveysCreateRequest {
|
|
|
8603
8836
|
schema?: FieldDescriptor[];
|
|
8604
8837
|
/** The schema with metadata for the survey. */
|
|
8605
8838
|
schema_with_metadata?: SurveyFieldWithMetadata[];
|
|
8839
|
+
/** Title of the survey. */
|
|
8840
|
+
title?: string;
|
|
8606
8841
|
}
|
|
8607
8842
|
/** surveys-create-response */
|
|
8608
8843
|
export interface SurveysCreateResponse {
|
|
@@ -9108,6 +9343,14 @@ export type Ticket = WorkBase & {
|
|
|
9108
9343
|
rev_org?: OrgSummary;
|
|
9109
9344
|
/** The properties of an enum value. */
|
|
9110
9345
|
sentiment?: EnumValue;
|
|
9346
|
+
/**
|
|
9347
|
+
* Timestamp when the sentiment was last modified.
|
|
9348
|
+
* @format date-time
|
|
9349
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
9350
|
+
*/
|
|
9351
|
+
sentiment_modified_date?: string;
|
|
9352
|
+
/** Summary justifying the sentiment. */
|
|
9353
|
+
sentiment_summary?: string;
|
|
9111
9354
|
/** Severity of the ticket. */
|
|
9112
9355
|
severity?: TicketSeverity;
|
|
9113
9356
|
sla_tracker?: SlaTrackerSummary;
|
|
@@ -9216,6 +9459,7 @@ export type TimelineComment = TimelineEntryBase & {
|
|
|
9216
9459
|
};
|
|
9217
9460
|
/** The type of the body to use for the comment. */
|
|
9218
9461
|
export declare enum TimelineCommentBodyType {
|
|
9462
|
+
Data = "data",
|
|
9219
9463
|
SnapKit = "snap_kit",
|
|
9220
9464
|
SnapWidget = "snap_widget",
|
|
9221
9465
|
Text = "text"
|
|
@@ -9566,6 +9810,8 @@ export declare enum TimelineEntryObjectType {
|
|
|
9566
9810
|
}
|
|
9567
9811
|
/** Display panels for the Timeline entry. */
|
|
9568
9812
|
export declare enum TimelineEntryPanel {
|
|
9813
|
+
Alerts = "alerts",
|
|
9814
|
+
Broadcasts = "broadcasts",
|
|
9569
9815
|
CustomerChat = "customer_chat",
|
|
9570
9816
|
Discussions = "discussions",
|
|
9571
9817
|
Events = "events"
|
|
@@ -10025,6 +10271,30 @@ export interface UpdateIncidentOwnedBy {
|
|
|
10025
10271
|
/** Sets the user IDs of the users that own the incident. */
|
|
10026
10272
|
set?: string[];
|
|
10027
10273
|
}
|
|
10274
|
+
/** update-incident-pia */
|
|
10275
|
+
export interface UpdateIncidentPia {
|
|
10276
|
+
/**
|
|
10277
|
+
* Sets the the article ids of the Post-Incident Analysis(PIA) of the
|
|
10278
|
+
* incident.
|
|
10279
|
+
*/
|
|
10280
|
+
set?: string[];
|
|
10281
|
+
}
|
|
10282
|
+
/** update-incident-playbooks */
|
|
10283
|
+
export interface UpdateIncidentPlaybooks {
|
|
10284
|
+
/**
|
|
10285
|
+
* Sets the the article ids of the playbook(s) associated with the
|
|
10286
|
+
* incident.
|
|
10287
|
+
*/
|
|
10288
|
+
set?: string[];
|
|
10289
|
+
}
|
|
10290
|
+
/** update-incident-related-docs */
|
|
10291
|
+
export interface UpdateIncidentRelatedDocs {
|
|
10292
|
+
/**
|
|
10293
|
+
* Sets the the article ids of other documents associated with the
|
|
10294
|
+
* incident.
|
|
10295
|
+
*/
|
|
10296
|
+
set?: string[];
|
|
10297
|
+
}
|
|
10028
10298
|
/** update-incident-stakeholders */
|
|
10029
10299
|
export interface UpdateIncidentStakeholders {
|
|
10030
10300
|
/**
|
|
@@ -10038,6 +10308,11 @@ export interface UpdateIncidentTags {
|
|
|
10038
10308
|
/** Sets the tags associated with the object. */
|
|
10039
10309
|
set?: UpdateTagWithValue[];
|
|
10040
10310
|
}
|
|
10311
|
+
/** update-link-target-descriptor-list */
|
|
10312
|
+
export interface UpdateLinkTargetDescriptorList {
|
|
10313
|
+
/** List of link descriptors. */
|
|
10314
|
+
link_descriptors: LinkTargetDescriptor[];
|
|
10315
|
+
}
|
|
10041
10316
|
/**
|
|
10042
10317
|
* update-stage
|
|
10043
10318
|
* Update object for Stage.
|
|
@@ -10274,6 +10549,7 @@ export interface WebhookEventRequest {
|
|
|
10274
10549
|
webhook_updated?: EventWebhookUpdated;
|
|
10275
10550
|
work_created?: EventWorkCreated;
|
|
10276
10551
|
work_deleted?: EventWorkDeleted;
|
|
10552
|
+
work_fetched?: EventWorkFetched;
|
|
10277
10553
|
work_updated?: EventWorkUpdated;
|
|
10278
10554
|
}
|
|
10279
10555
|
/** webhook-event-response */
|
|
@@ -10334,6 +10610,7 @@ export declare enum WebhookEventType {
|
|
|
10334
10610
|
WebhookUpdated = "webhook_updated",
|
|
10335
10611
|
WorkCreated = "work_created",
|
|
10336
10612
|
WorkDeleted = "work_deleted",
|
|
10613
|
+
WorkFetched = "work_fetched",
|
|
10337
10614
|
WorkUpdated = "work_updated"
|
|
10338
10615
|
}
|
|
10339
10616
|
/** webhook-event-verify */
|
|
@@ -10411,6 +10688,27 @@ export interface WebhooksDeleteRequest {
|
|
|
10411
10688
|
* The response to deleting the webhook.
|
|
10412
10689
|
*/
|
|
10413
10690
|
export type WebhooksDeleteResponse = object;
|
|
10691
|
+
/**
|
|
10692
|
+
* webhooks-fetch-request
|
|
10693
|
+
* The request to fetch an object for a webhook.
|
|
10694
|
+
*/
|
|
10695
|
+
export interface WebhooksFetchRequest {
|
|
10696
|
+
/**
|
|
10697
|
+
* The ID of the webhook to fetch the object for.
|
|
10698
|
+
* @example "don:integration:<partition>:devo/<dev-org-id>:webhook/<webhook-id>"
|
|
10699
|
+
*/
|
|
10700
|
+
id: string;
|
|
10701
|
+
/**
|
|
10702
|
+
* The ID of the object to fetch for the webhook.
|
|
10703
|
+
* @example "ISS-12345"
|
|
10704
|
+
*/
|
|
10705
|
+
object: string;
|
|
10706
|
+
}
|
|
10707
|
+
/**
|
|
10708
|
+
* webhooks-fetch-response
|
|
10709
|
+
* The response to fetching an object for a webhook.
|
|
10710
|
+
*/
|
|
10711
|
+
export type WebhooksFetchResponse = object;
|
|
10414
10712
|
/**
|
|
10415
10713
|
* webhooks-get-request
|
|
10416
10714
|
* The request to get a webhook's information.
|
|
@@ -11178,6 +11476,14 @@ export interface WorksUpdateRequestTicket {
|
|
|
11178
11476
|
* @format int64
|
|
11179
11477
|
*/
|
|
11180
11478
|
sentiment?: number;
|
|
11479
|
+
/**
|
|
11480
|
+
* Timestamp at which sentiment was last modified.
|
|
11481
|
+
* @format date-time
|
|
11482
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
11483
|
+
*/
|
|
11484
|
+
sentiment_modified_date?: string;
|
|
11485
|
+
/** Summary justifying the current sentiment. */
|
|
11486
|
+
sentiment_summary?: string;
|
|
11181
11487
|
/** Severity of the ticket. */
|
|
11182
11488
|
severity?: TicketSeverity;
|
|
11183
11489
|
}
|
|
@@ -12293,6 +12599,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
12293
12599
|
* starts from the beginning.
|
|
12294
12600
|
*/
|
|
12295
12601
|
cursor?: string;
|
|
12602
|
+
/** Filters for custom fields. */
|
|
12603
|
+
custom_fields?: object;
|
|
12296
12604
|
/** Filters Dev users based on email addresses. */
|
|
12297
12605
|
email?: string[];
|
|
12298
12606
|
/** Unique ID of the user in the external source. */
|
|
@@ -12748,6 +13056,21 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
12748
13056
|
mode?: ListMode;
|
|
12749
13057
|
/** Filters for incidents owned by any of the provided users. */
|
|
12750
13058
|
owned_by?: string[];
|
|
13059
|
+
/**
|
|
13060
|
+
* Filters for incidents with any of the provided PIAs.
|
|
13061
|
+
* @example ["ARTICLE-12345"]
|
|
13062
|
+
*/
|
|
13063
|
+
pia?: string[];
|
|
13064
|
+
/**
|
|
13065
|
+
* Filters for incidents with any of the provided playbooks.
|
|
13066
|
+
* @example ["ARTICLE-12345"]
|
|
13067
|
+
*/
|
|
13068
|
+
playbook?: string[];
|
|
13069
|
+
/**
|
|
13070
|
+
* Filters for incidents with any of the provided related docs.
|
|
13071
|
+
* @example ["ARTICLE-12345"]
|
|
13072
|
+
*/
|
|
13073
|
+
related_docs?: string[];
|
|
12751
13074
|
/** Filters for incidents with any of the provided reporters. */
|
|
12752
13075
|
reported_by?: number[];
|
|
12753
13076
|
/** Filters for incidents containing any of the provided severities. */
|
|
@@ -12803,6 +13126,21 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
12803
13126
|
mode?: ListMode;
|
|
12804
13127
|
/** Filters for incidents owned by any of the provided users. */
|
|
12805
13128
|
owned_by?: string[];
|
|
13129
|
+
/**
|
|
13130
|
+
* Filters for incidents with any of the provided PIAs.
|
|
13131
|
+
* @example ["ARTICLE-12345"]
|
|
13132
|
+
*/
|
|
13133
|
+
pia?: string[];
|
|
13134
|
+
/**
|
|
13135
|
+
* Filters for incidents with any of the provided playbooks.
|
|
13136
|
+
* @example ["ARTICLE-12345"]
|
|
13137
|
+
*/
|
|
13138
|
+
playbook?: string[];
|
|
13139
|
+
/**
|
|
13140
|
+
* Filters for incidents with any of the provided related docs.
|
|
13141
|
+
* @example ["ARTICLE-12345"]
|
|
13142
|
+
*/
|
|
13143
|
+
related_docs?: string[];
|
|
12806
13144
|
/** Filters for incidents with any of the provided reporters. */
|
|
12807
13145
|
reported_by?: number[];
|
|
12808
13146
|
/** Filters for incidents containing any of the provided severities. */
|
|
@@ -12856,6 +13194,85 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
12856
13194
|
* @secure
|
|
12857
13195
|
*/
|
|
12858
13196
|
keyringsCreateCallbackPost: (data: KeyringsCreateCallbackRequest, params?: RequestParams) => Promise<AxiosResponse<void, any>>;
|
|
13197
|
+
/**
|
|
13198
|
+
* @description Creates a custom link type.
|
|
13199
|
+
*
|
|
13200
|
+
* @tags customization
|
|
13201
|
+
* @name CustomLinkTypeCreate
|
|
13202
|
+
* @request POST:/link-types.custom.create
|
|
13203
|
+
* @secure
|
|
13204
|
+
*/
|
|
13205
|
+
customLinkTypeCreate: (data: CustomLinkTypeCreateRequest, params?: RequestParams) => Promise<AxiosResponse<CustomLinkTypeCreateResponse, any>>;
|
|
13206
|
+
/**
|
|
13207
|
+
* @description Gets a custom link type.
|
|
13208
|
+
*
|
|
13209
|
+
* @tags customization
|
|
13210
|
+
* @name CustomLinkTypeGet
|
|
13211
|
+
* @request GET:/link-types.custom.get
|
|
13212
|
+
* @secure
|
|
13213
|
+
*/
|
|
13214
|
+
customLinkTypeGet: (query: {
|
|
13215
|
+
/** The ID of the custom link type to get. */
|
|
13216
|
+
id: string;
|
|
13217
|
+
}, params?: RequestParams) => Promise<AxiosResponse<CustomLinkTypeGetResponse, any>>;
|
|
13218
|
+
/**
|
|
13219
|
+
* @description Gets a custom link type.
|
|
13220
|
+
*
|
|
13221
|
+
* @tags customization
|
|
13222
|
+
* @name CustomLinkTypeGetPost
|
|
13223
|
+
* @request POST:/link-types.custom.get
|
|
13224
|
+
* @secure
|
|
13225
|
+
*/
|
|
13226
|
+
customLinkTypeGetPost: (data: CustomLinkTypeGetRequest, params?: RequestParams) => Promise<AxiosResponse<CustomLinkTypeGetResponse, any>>;
|
|
13227
|
+
/**
|
|
13228
|
+
* @description Lists custom link types.
|
|
13229
|
+
*
|
|
13230
|
+
* @tags customization
|
|
13231
|
+
* @name CustomLinkTypeList
|
|
13232
|
+
* @request GET:/link-types.custom.list
|
|
13233
|
+
* @secure
|
|
13234
|
+
*/
|
|
13235
|
+
customLinkTypeList: (query?: {
|
|
13236
|
+
/**
|
|
13237
|
+
* The cursor to resume iteration from. If not provided, then iteration
|
|
13238
|
+
* starts from the beginning.
|
|
13239
|
+
*/
|
|
13240
|
+
cursor?: string;
|
|
13241
|
+
/** Whether only deprecated link types should be filtered. */
|
|
13242
|
+
deprecated?: boolean;
|
|
13243
|
+
/**
|
|
13244
|
+
* The maximum number of items.
|
|
13245
|
+
* @format int32
|
|
13246
|
+
*/
|
|
13247
|
+
limit?: number;
|
|
13248
|
+
/**
|
|
13249
|
+
* The iteration mode to use, otherwise if not set, then "after" is
|
|
13250
|
+
* used.
|
|
13251
|
+
*/
|
|
13252
|
+
mode?: ListMode;
|
|
13253
|
+
/** The list of link type names. */
|
|
13254
|
+
name?: string[];
|
|
13255
|
+
/** The list of fields to sort the items by and how to sort them. */
|
|
13256
|
+
sort_by?: string[];
|
|
13257
|
+
}, params?: RequestParams) => Promise<AxiosResponse<CustomLinkTypeListResponse, any>>;
|
|
13258
|
+
/**
|
|
13259
|
+
* @description Lists custom link types.
|
|
13260
|
+
*
|
|
13261
|
+
* @tags customization
|
|
13262
|
+
* @name CustomLinkTypeListPost
|
|
13263
|
+
* @request POST:/link-types.custom.list
|
|
13264
|
+
* @secure
|
|
13265
|
+
*/
|
|
13266
|
+
customLinkTypeListPost: (data: CustomLinkTypeListRequest, params?: RequestParams) => Promise<AxiosResponse<CustomLinkTypeListResponse, any>>;
|
|
13267
|
+
/**
|
|
13268
|
+
* @description Updates a custom link type.
|
|
13269
|
+
*
|
|
13270
|
+
* @tags customization
|
|
13271
|
+
* @name CustomLinkTypeUpdate
|
|
13272
|
+
* @request POST:/link-types.custom.update
|
|
13273
|
+
* @secure
|
|
13274
|
+
*/
|
|
13275
|
+
customLinkTypeUpdate: (data: CustomLinkTypeUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<CustomLinkTypeUpdateResponse, any>>;
|
|
12859
13276
|
/**
|
|
12860
13277
|
* @description Creates a link between two objects to indicate a relationship.
|
|
12861
13278
|
*
|
|
@@ -14944,6 +15361,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
14944
15361
|
* @secure
|
|
14945
15362
|
*/
|
|
14946
15363
|
webhooksDelete: (data: WebhooksDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
|
|
15364
|
+
/**
|
|
15365
|
+
* @description Fetches an object via webhook.
|
|
15366
|
+
*
|
|
15367
|
+
* @tags webhooks
|
|
15368
|
+
* @name WebhooksFetch
|
|
15369
|
+
* @request POST:/webhooks.fetch
|
|
15370
|
+
* @secure
|
|
15371
|
+
*/
|
|
15372
|
+
webhooksFetch: (data: WebhooksFetchRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
|
|
14947
15373
|
/**
|
|
14948
15374
|
* @description Gets the requested webhook's information.
|
|
14949
15375
|
*
|
|
@@ -33,9 +33,9 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
|
33
33
|
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
34
34
|
};
|
|
35
35
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
36
|
-
exports.
|
|
37
|
-
exports.
|
|
38
|
-
exports.Api = exports.HttpClient = exports.ContentType = exports.WorkType = exports.WebhooksUpdateAction = exports.WebhookStatus = exports.WebhookEventType = exports.VistaType = exports.VistaGroupItemType = exports.VistaGroupItemState = exports.UserType = exports.UserState = exports.UomMetricScope = exports.UnitType = void 0;
|
|
36
|
+
exports.MemberType = exports.ListMode = exports.LinksDirection = exports.LinkType = exports.LinkEndpointType = exports.IssuePriority = exports.GroupedVistaFlavor = exports.GroupType = exports.GroupMemberType = exports.GroupIngestionSource = exports.GenericNotificationEventType = exports.GeneralPreferencesGroupPreferredLocale = exports.FieldValueType = exports.EventSourceStatus = exports.EventFetchedResult = exports.ErrorUnauthorizedType = exports.ErrorTooManyRequestsType = exports.ErrorServiceUnavailableType = exports.ErrorNotFoundType = exports.ErrorInternalServerErrorType = exports.ErrorForbiddenType = exports.ErrorConflictType = exports.ErrorBadRequestUnexpectedJsonTypeType = exports.ErrorBadRequestType = exports.EngagementsCreateRequestEngagementType = exports.EngagementType = exports.DevUserJobTitle = exports.DevOrgAuthConnectionsUpdateRequestType = exports.DevOrgAuthConnectionsCreateRequestType = exports.DateTimePresetType = exports.DateFilterType = exports.CustomSchemaFragmentsSetRequestType = exports.CustomSchemaFragmentsListRequestPrune = exports.CustomSchemaFragmentType = exports.CustomSchemaFragmentFragmentType = exports.ConversationsCreateRequestTypeValue = exports.CodeChangeSource = exports.BooleanExpressionType = exports.AuthTokenTokenType = exports.AuthTokenSubjectTokenType = exports.AuthTokenStatus = exports.AuthTokenRequestedTokenType = exports.AuthTokenGrantType = exports.AuthConnectionType = exports.AuthConnectionToggle = exports.AtomType = exports.ArticleType = exports.ArticleStatus = exports.AggregationDetailAggregationType = exports.AccessLevel = void 0;
|
|
37
|
+
exports.TimelineEntryType = exports.TimelineEntryPanel = exports.TimelineEntryObjectType = exports.TimelineEntriesUpdateRequestType = exports.TimelineEntriesCreateRequestType = exports.TimelineEntriesCollection = exports.TimelineCommentBodyType = exports.TimelineChangeEventEventType = exports.TicketSeverity = exports.TicketChannels = exports.TaskPriority = exports.SyncMetadataFilterSyncOutFilterStatus = exports.SyncMetadataFilterSyncInFilterStatus = exports.StockSchemaFragmentsListRequestPrune = exports.StockSchemaFragmentsListRequestFilterPreset = exports.StageValidationOptionForUpdate = exports.StageValidationOptionForCreate = exports.SnapWidgetsCreateRequestType = exports.SnapWidgetType = exports.SnapWidgetStatus = exports.SnapWidgetNamespace = exports.SlasFilterAppliesToOperatorType = exports.SlaType = exports.SlaSummaryStage = exports.SlaStatus = exports.SlaSelectorSeverity = exports.SlaSelectorPriority = exports.SlaSelectorAppliesTo = exports.SlaEvaluationPeriod = exports.SlaAppliesTo = exports.SendNotificationType = exports.SearchSortOrderParam = exports.SearchSortByParam = exports.SearchResultType = exports.SearchNamespace = exports.SearchHybridNamespace = exports.SchemaFieldDescriptorFieldType = exports.SchemaFieldDescriptorArrayTypeBaseType = exports.QuestionAnswerStatus = exports.PreferencesType = exports.PartType = exports.OrgType = exports.OrgScheduleStatus = exports.OrgScheduleFragmentStatus = exports.OrgEnvironment = exports.OpportunityPriority = exports.OpportunityForecastCategory = exports.MetricDefinitionStatus = exports.MetricDefinitionMetricType = exports.MetricDefinitionAppliesTo = void 0;
|
|
38
|
+
exports.Api = exports.HttpClient = exports.ContentType = exports.WorkType = exports.WebhooksUpdateAction = exports.WebhookStatus = exports.WebhookEventType = exports.VistaType = exports.VistaGroupItemType = exports.VistaGroupItemState = exports.UserType = exports.UserState = exports.UomMetricScope = exports.UnitType = exports.TimelineEntryVisibility = void 0;
|
|
39
39
|
var AccessLevel;
|
|
40
40
|
(function (AccessLevel) {
|
|
41
41
|
AccessLevel["External"] = "external";
|
|
@@ -357,6 +357,12 @@ var ErrorUnauthorizedType;
|
|
|
357
357
|
(function (ErrorUnauthorizedType) {
|
|
358
358
|
ErrorUnauthorizedType["Unauthenticated"] = "unauthenticated";
|
|
359
359
|
})(ErrorUnauthorizedType = exports.ErrorUnauthorizedType || (exports.ErrorUnauthorizedType = {}));
|
|
360
|
+
var EventFetchedResult;
|
|
361
|
+
(function (EventFetchedResult) {
|
|
362
|
+
EventFetchedResult["Forbidden"] = "forbidden";
|
|
363
|
+
EventFetchedResult["NotFound"] = "not_found";
|
|
364
|
+
EventFetchedResult["Ok"] = "ok";
|
|
365
|
+
})(EventFetchedResult = exports.EventFetchedResult || (exports.EventFetchedResult = {}));
|
|
360
366
|
/**
|
|
361
367
|
* Status of the event source. Note that paused/blocked event sources
|
|
362
368
|
* return NotFound error on triggering.
|
|
@@ -885,6 +891,7 @@ var TimelineChangeEventEventType;
|
|
|
885
891
|
/** The type of the body to use for the comment. */
|
|
886
892
|
var TimelineCommentBodyType;
|
|
887
893
|
(function (TimelineCommentBodyType) {
|
|
894
|
+
TimelineCommentBodyType["Data"] = "data";
|
|
888
895
|
TimelineCommentBodyType["SnapKit"] = "snap_kit";
|
|
889
896
|
TimelineCommentBodyType["SnapWidget"] = "snap_widget";
|
|
890
897
|
TimelineCommentBodyType["Text"] = "text";
|
|
@@ -926,6 +933,8 @@ var TimelineEntryObjectType;
|
|
|
926
933
|
/** Display panels for the Timeline entry. */
|
|
927
934
|
var TimelineEntryPanel;
|
|
928
935
|
(function (TimelineEntryPanel) {
|
|
936
|
+
TimelineEntryPanel["Alerts"] = "alerts";
|
|
937
|
+
TimelineEntryPanel["Broadcasts"] = "broadcasts";
|
|
929
938
|
TimelineEntryPanel["CustomerChat"] = "customer_chat";
|
|
930
939
|
TimelineEntryPanel["Discussions"] = "discussions";
|
|
931
940
|
TimelineEntryPanel["Events"] = "events";
|
|
@@ -1054,6 +1063,7 @@ var WebhookEventType;
|
|
|
1054
1063
|
WebhookEventType["WebhookUpdated"] = "webhook_updated";
|
|
1055
1064
|
WebhookEventType["WorkCreated"] = "work_created";
|
|
1056
1065
|
WebhookEventType["WorkDeleted"] = "work_deleted";
|
|
1066
|
+
WebhookEventType["WorkFetched"] = "work_fetched";
|
|
1057
1067
|
WebhookEventType["WorkUpdated"] = "work_updated";
|
|
1058
1068
|
})(WebhookEventType = exports.WebhookEventType || (exports.WebhookEventType = {}));
|
|
1059
1069
|
/** The status of the webhook. */
|
|
@@ -2119,6 +2129,60 @@ class Api extends HttpClient {
|
|
|
2119
2129
|
* @secure
|
|
2120
2130
|
*/
|
|
2121
2131
|
this.keyringsCreateCallbackPost = (data, params = {}) => this.request(Object.assign({ path: `/keyrings.authorize`, method: 'POST', body: data, secure: true, type: ContentType.Json }, params));
|
|
2132
|
+
/**
|
|
2133
|
+
* @description Creates a custom link type.
|
|
2134
|
+
*
|
|
2135
|
+
* @tags customization
|
|
2136
|
+
* @name CustomLinkTypeCreate
|
|
2137
|
+
* @request POST:/link-types.custom.create
|
|
2138
|
+
* @secure
|
|
2139
|
+
*/
|
|
2140
|
+
this.customLinkTypeCreate = (data, params = {}) => this.request(Object.assign({ path: `/link-types.custom.create`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
2141
|
+
/**
|
|
2142
|
+
* @description Gets a custom link type.
|
|
2143
|
+
*
|
|
2144
|
+
* @tags customization
|
|
2145
|
+
* @name CustomLinkTypeGet
|
|
2146
|
+
* @request GET:/link-types.custom.get
|
|
2147
|
+
* @secure
|
|
2148
|
+
*/
|
|
2149
|
+
this.customLinkTypeGet = (query, params = {}) => this.request(Object.assign({ path: `/link-types.custom.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
2150
|
+
/**
|
|
2151
|
+
* @description Gets a custom link type.
|
|
2152
|
+
*
|
|
2153
|
+
* @tags customization
|
|
2154
|
+
* @name CustomLinkTypeGetPost
|
|
2155
|
+
* @request POST:/link-types.custom.get
|
|
2156
|
+
* @secure
|
|
2157
|
+
*/
|
|
2158
|
+
this.customLinkTypeGetPost = (data, params = {}) => this.request(Object.assign({ path: `/link-types.custom.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
2159
|
+
/**
|
|
2160
|
+
* @description Lists custom link types.
|
|
2161
|
+
*
|
|
2162
|
+
* @tags customization
|
|
2163
|
+
* @name CustomLinkTypeList
|
|
2164
|
+
* @request GET:/link-types.custom.list
|
|
2165
|
+
* @secure
|
|
2166
|
+
*/
|
|
2167
|
+
this.customLinkTypeList = (query, params = {}) => this.request(Object.assign({ path: `/link-types.custom.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
2168
|
+
/**
|
|
2169
|
+
* @description Lists custom link types.
|
|
2170
|
+
*
|
|
2171
|
+
* @tags customization
|
|
2172
|
+
* @name CustomLinkTypeListPost
|
|
2173
|
+
* @request POST:/link-types.custom.list
|
|
2174
|
+
* @secure
|
|
2175
|
+
*/
|
|
2176
|
+
this.customLinkTypeListPost = (data, params = {}) => this.request(Object.assign({ path: `/link-types.custom.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
2177
|
+
/**
|
|
2178
|
+
* @description Updates a custom link type.
|
|
2179
|
+
*
|
|
2180
|
+
* @tags customization
|
|
2181
|
+
* @name CustomLinkTypeUpdate
|
|
2182
|
+
* @request POST:/link-types.custom.update
|
|
2183
|
+
* @secure
|
|
2184
|
+
*/
|
|
2185
|
+
this.customLinkTypeUpdate = (data, params = {}) => this.request(Object.assign({ path: `/link-types.custom.update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
2122
2186
|
/**
|
|
2123
2187
|
* @description Creates a link between two objects to indicate a relationship.
|
|
2124
2188
|
*
|
|
@@ -3361,6 +3425,15 @@ class Api extends HttpClient {
|
|
|
3361
3425
|
* @secure
|
|
3362
3426
|
*/
|
|
3363
3427
|
this.webhooksDelete = (data, params = {}) => this.request(Object.assign({ path: `/webhooks.delete`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
3428
|
+
/**
|
|
3429
|
+
* @description Fetches an object via webhook.
|
|
3430
|
+
*
|
|
3431
|
+
* @tags webhooks
|
|
3432
|
+
* @name WebhooksFetch
|
|
3433
|
+
* @request POST:/webhooks.fetch
|
|
3434
|
+
* @secure
|
|
3435
|
+
*/
|
|
3436
|
+
this.webhooksFetch = (data, params = {}) => this.request(Object.assign({ path: `/webhooks.fetch`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
3364
3437
|
/**
|
|
3365
3438
|
* @description Gets the requested webhook's information.
|
|
3366
3439
|
*
|
|
@@ -204,6 +204,20 @@ export interface AccountsUpdateResponse {
|
|
|
204
204
|
* Metric with corresponding target values.
|
|
205
205
|
*/
|
|
206
206
|
export interface ArchetypeMetricTarget {
|
|
207
|
+
/**
|
|
208
|
+
* For breached metrics the time they entered into breach. This is the
|
|
209
|
+
* same as what the target date was, unless the breach happened due to
|
|
210
|
+
* a different policy starting to apply.
|
|
211
|
+
* @format date-time
|
|
212
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
213
|
+
*/
|
|
214
|
+
breached_at?: string;
|
|
215
|
+
/**
|
|
216
|
+
* For completed metrics the time (in minutes) it took to complete
|
|
217
|
+
* them. (Taking into account the schedule if any).
|
|
218
|
+
* @format int32
|
|
219
|
+
*/
|
|
220
|
+
completed_in?: number;
|
|
207
221
|
/**
|
|
208
222
|
* If true, the schedule attached to this metric is out of schedule at
|
|
209
223
|
* the time of the query. It is not set for metrics in *completed*
|
|
@@ -211,12 +225,26 @@ export interface ArchetypeMetricTarget {
|
|
|
211
225
|
*/
|
|
212
226
|
is_out_of_schedule?: boolean;
|
|
213
227
|
metric_definition: MetricDefinitionSummary;
|
|
228
|
+
/**
|
|
229
|
+
* The next time the schedule will change its state, if such is known.
|
|
230
|
+
* @format date-time
|
|
231
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
232
|
+
*/
|
|
233
|
+
next_schedule_transition?: string;
|
|
214
234
|
org_schedule?: OrgScheduleSummary;
|
|
215
235
|
/**
|
|
216
236
|
* Time in minutes that remains on a paused metric.
|
|
217
237
|
* @format int32
|
|
218
238
|
*/
|
|
219
239
|
remaining_time?: number;
|
|
240
|
+
/** Metric stage corresponding to the applicable SLA. */
|
|
241
|
+
stage: string;
|
|
242
|
+
/**
|
|
243
|
+
* It is an indicator of whether the metric has ever been breached
|
|
244
|
+
* (missed). If not, it shows whether the metric is completed, in
|
|
245
|
+
* progress, or not part of the applied policy.
|
|
246
|
+
*/
|
|
247
|
+
status?: string;
|
|
220
248
|
/**
|
|
221
249
|
* Time at which the metric would breach SLA if no action taken.
|
|
222
250
|
* @format date-time
|
|
@@ -1465,6 +1493,11 @@ export interface EventDevUserUpdated {
|
|
|
1465
1493
|
dev_user: DevUser;
|
|
1466
1494
|
old_dev_user?: DevUser;
|
|
1467
1495
|
}
|
|
1496
|
+
export declare enum EventFetchedResult {
|
|
1497
|
+
Forbidden = "forbidden",
|
|
1498
|
+
NotFound = "not_found",
|
|
1499
|
+
Ok = "ok"
|
|
1500
|
+
}
|
|
1468
1501
|
/** event-group-created */
|
|
1469
1502
|
export interface EventGroupCreated {
|
|
1470
1503
|
group: Group;
|
|
@@ -1659,6 +1692,19 @@ export interface EventWorkDeleted {
|
|
|
1659
1692
|
id: string;
|
|
1660
1693
|
old_work?: Work;
|
|
1661
1694
|
}
|
|
1695
|
+
/** event-work-fetched */
|
|
1696
|
+
export type EventWorkFetched = (Empty | EventWorkFetchedOk) & {
|
|
1697
|
+
/**
|
|
1698
|
+
* The ID of the work that was fetched.
|
|
1699
|
+
* @example "ISS-12345"
|
|
1700
|
+
*/
|
|
1701
|
+
id: string;
|
|
1702
|
+
result: EventFetchedResult;
|
|
1703
|
+
};
|
|
1704
|
+
/** event-work-fetched-ok */
|
|
1705
|
+
export interface EventWorkFetchedOk {
|
|
1706
|
+
work?: Work;
|
|
1707
|
+
}
|
|
1662
1708
|
/** event-work-updated */
|
|
1663
1709
|
export interface EventWorkUpdated {
|
|
1664
1710
|
old_work?: Work;
|
|
@@ -2917,6 +2963,8 @@ export interface StagedInfoFilter {
|
|
|
2917
2963
|
export type Survey = AtomBase & {
|
|
2918
2964
|
/** Description of the survey. */
|
|
2919
2965
|
description?: string;
|
|
2966
|
+
/** Header of the survey. */
|
|
2967
|
+
header?: string;
|
|
2920
2968
|
/** Text posted when introducing the survey to the responder. */
|
|
2921
2969
|
introductory_text?: string;
|
|
2922
2970
|
/**
|
|
@@ -2930,6 +2978,8 @@ export type Survey = AtomBase & {
|
|
|
2930
2978
|
schema?: SchemaFieldDescriptor[];
|
|
2931
2979
|
/** List of all the fields and their respective metadata in the schema. */
|
|
2932
2980
|
schema_with_metadata?: SurveyFieldWithMetadata[];
|
|
2981
|
+
/** Title of the survey. */
|
|
2982
|
+
title?: string;
|
|
2933
2983
|
};
|
|
2934
2984
|
/**
|
|
2935
2985
|
* survey-aggregation-filter
|
|
@@ -3187,6 +3237,14 @@ export type Ticket = WorkBase & {
|
|
|
3187
3237
|
rev_org?: OrgSummary;
|
|
3188
3238
|
/** The properties of an enum value. */
|
|
3189
3239
|
sentiment?: EnumValue;
|
|
3240
|
+
/**
|
|
3241
|
+
* Timestamp when the sentiment was last modified.
|
|
3242
|
+
* @format date-time
|
|
3243
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
3244
|
+
*/
|
|
3245
|
+
sentiment_modified_date?: string;
|
|
3246
|
+
/** Summary justifying the sentiment. */
|
|
3247
|
+
sentiment_summary?: string;
|
|
3190
3248
|
/** Severity of the ticket. */
|
|
3191
3249
|
severity?: TicketSeverity;
|
|
3192
3250
|
sla_tracker?: SlaTrackerSummary;
|
|
@@ -3232,6 +3290,7 @@ export type TimelineComment = TimelineEntryBase & {
|
|
|
3232
3290
|
};
|
|
3233
3291
|
/** The type of the body to use for the comment. */
|
|
3234
3292
|
export declare enum TimelineCommentBodyType {
|
|
3293
|
+
Data = "data",
|
|
3235
3294
|
SnapKit = "snap_kit",
|
|
3236
3295
|
SnapWidget = "snap_widget",
|
|
3237
3296
|
Text = "text"
|
|
@@ -3677,6 +3736,7 @@ export interface WebhookEventRequest {
|
|
|
3677
3736
|
webhook_updated?: EventWebhookUpdated;
|
|
3678
3737
|
work_created?: EventWorkCreated;
|
|
3679
3738
|
work_deleted?: EventWorkDeleted;
|
|
3739
|
+
work_fetched?: EventWorkFetched;
|
|
3680
3740
|
work_updated?: EventWorkUpdated;
|
|
3681
3741
|
}
|
|
3682
3742
|
/** webhook-event-response */
|
|
@@ -3737,6 +3797,7 @@ export declare enum WebhookEventType {
|
|
|
3737
3797
|
WebhookUpdated = "webhook_updated",
|
|
3738
3798
|
WorkCreated = "work_created",
|
|
3739
3799
|
WorkDeleted = "work_deleted",
|
|
3800
|
+
WorkFetched = "work_fetched",
|
|
3740
3801
|
WorkUpdated = "work_updated"
|
|
3741
3802
|
}
|
|
3742
3803
|
/** webhook-event-verify */
|
|
@@ -4353,6 +4414,14 @@ export interface WorksUpdateRequestTicket {
|
|
|
4353
4414
|
* @format int64
|
|
4354
4415
|
*/
|
|
4355
4416
|
sentiment?: number;
|
|
4417
|
+
/**
|
|
4418
|
+
* Timestamp at which sentiment was last modified.
|
|
4419
|
+
* @format date-time
|
|
4420
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
4421
|
+
*/
|
|
4422
|
+
sentiment_modified_date?: string;
|
|
4423
|
+
/** Summary justifying the current sentiment. */
|
|
4424
|
+
sentiment_summary?: string;
|
|
4356
4425
|
/** Severity of the ticket. */
|
|
4357
4426
|
severity?: TicketSeverity;
|
|
4358
4427
|
}
|
|
@@ -33,8 +33,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
|
33
33
|
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
34
34
|
};
|
|
35
35
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
36
|
-
exports.
|
|
37
|
-
exports.Api = exports.HttpClient = exports.ContentType = exports.WorkType = exports.WebhooksUpdateAction = exports.WebhookStatus = void 0;
|
|
36
|
+
exports.VistaGroupItemType = exports.VistaGroupItemState = exports.UserType = exports.UserState = exports.TimelineEntryVisibility = exports.TimelineEntryType = exports.TimelineEntryObjectType = exports.TimelineEntriesUpdateRequestType = exports.TimelineEntriesCreateRequestType = exports.TimelineCommentBodyType = exports.TicketSeverity = exports.TicketChannels = exports.SyncMetadataFilterSyncOutFilterStatus = exports.SyncMetadataFilterSyncInFilterStatus = exports.StageValidationOptionForUpdate = exports.StageValidationOptionForCreate = exports.SlaType = exports.SlaSummaryStage = exports.SlaStatus = exports.SchemaFieldDescriptorFieldType = exports.SchemaFieldDescriptorArrayTypeBaseType = exports.PartType = exports.OrgType = exports.OrgScheduleStatus = exports.OrgEnvironment = exports.ListMode = exports.LinkType = exports.LinkEndpointType = exports.IssuePriority = exports.EventFetchedResult = exports.ErrorUnauthorizedType = exports.ErrorTooManyRequestsType = exports.ErrorServiceUnavailableType = exports.ErrorNotFoundType = exports.ErrorInternalServerErrorType = exports.ErrorForbiddenType = exports.ErrorConflictType = exports.ErrorBadRequestUnexpectedJsonTypeType = exports.ErrorBadRequestType = exports.DevOrgAuthConnectionsUpdateRequestType = exports.DevOrgAuthConnectionsCreateRequestType = exports.DateTimePresetType = exports.DateFilterType = exports.AuthTokenTokenType = exports.AuthTokenSubjectTokenType = exports.AuthTokenStatus = exports.AuthTokenRequestedTokenType = exports.AuthTokenGrantType = exports.AuthConnectionType = exports.AuthConnectionToggle = void 0;
|
|
37
|
+
exports.Api = exports.HttpClient = exports.ContentType = exports.WorkType = exports.WebhooksUpdateAction = exports.WebhookStatus = exports.WebhookEventType = void 0;
|
|
38
38
|
var AuthConnectionToggle;
|
|
39
39
|
(function (AuthConnectionToggle) {
|
|
40
40
|
AuthConnectionToggle["Disable"] = "disable";
|
|
@@ -194,6 +194,12 @@ var ErrorUnauthorizedType;
|
|
|
194
194
|
(function (ErrorUnauthorizedType) {
|
|
195
195
|
ErrorUnauthorizedType["Unauthenticated"] = "unauthenticated";
|
|
196
196
|
})(ErrorUnauthorizedType = exports.ErrorUnauthorizedType || (exports.ErrorUnauthorizedType = {}));
|
|
197
|
+
var EventFetchedResult;
|
|
198
|
+
(function (EventFetchedResult) {
|
|
199
|
+
EventFetchedResult["Forbidden"] = "forbidden";
|
|
200
|
+
EventFetchedResult["NotFound"] = "not_found";
|
|
201
|
+
EventFetchedResult["Ok"] = "ok";
|
|
202
|
+
})(EventFetchedResult = exports.EventFetchedResult || (exports.EventFetchedResult = {}));
|
|
197
203
|
/** Priority of the work based upon impact and criticality. */
|
|
198
204
|
var IssuePriority;
|
|
199
205
|
(function (IssuePriority) {
|
|
@@ -374,6 +380,7 @@ var TicketSeverity;
|
|
|
374
380
|
/** The type of the body to use for the comment. */
|
|
375
381
|
var TimelineCommentBodyType;
|
|
376
382
|
(function (TimelineCommentBodyType) {
|
|
383
|
+
TimelineCommentBodyType["Data"] = "data";
|
|
377
384
|
TimelineCommentBodyType["SnapKit"] = "snap_kit";
|
|
378
385
|
TimelineCommentBodyType["SnapWidget"] = "snap_widget";
|
|
379
386
|
TimelineCommentBodyType["Text"] = "text";
|
|
@@ -497,6 +504,7 @@ var WebhookEventType;
|
|
|
497
504
|
WebhookEventType["WebhookUpdated"] = "webhook_updated";
|
|
498
505
|
WebhookEventType["WorkCreated"] = "work_created";
|
|
499
506
|
WebhookEventType["WorkDeleted"] = "work_deleted";
|
|
507
|
+
WebhookEventType["WorkFetched"] = "work_fetched";
|
|
500
508
|
WebhookEventType["WorkUpdated"] = "work_updated";
|
|
501
509
|
})(WebhookEventType = exports.WebhookEventType || (exports.WebhookEventType = {}));
|
|
502
510
|
/** The status of the webhook. */
|