@devrev/typescript-sdk 1.1.29 → 1.1.30
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.
|
@@ -305,6 +305,19 @@ export interface AccountsUpdateRequestArtifacts {
|
|
|
305
305
|
export interface AccountsUpdateResponse {
|
|
306
306
|
account: Account;
|
|
307
307
|
}
|
|
308
|
+
/** add-tag-with-value */
|
|
309
|
+
export interface AddTagWithValue {
|
|
310
|
+
/**
|
|
311
|
+
* The ID of the tag.
|
|
312
|
+
* @example "TAG-12345"
|
|
313
|
+
*/
|
|
314
|
+
id: string;
|
|
315
|
+
/**
|
|
316
|
+
* The value for the object's association with the tag. If specified,
|
|
317
|
+
* the value must be one that's specified in the tag's allowed values.
|
|
318
|
+
*/
|
|
319
|
+
value?: string;
|
|
320
|
+
}
|
|
308
321
|
/**
|
|
309
322
|
* aggregated-schema
|
|
310
323
|
* List of custom fields from multiple source fragments.
|
|
@@ -409,7 +422,8 @@ export type AppFragmentSummary = CustomSchemaFragmentBaseSummary;
|
|
|
409
422
|
export interface ArchetypeMetricTarget {
|
|
410
423
|
/**
|
|
411
424
|
* If true, the schedule attached to this metric is out of schedule at
|
|
412
|
-
* the time of the query.
|
|
425
|
+
* the time of the query. It is not set for metrics in *completed*
|
|
426
|
+
* stage.
|
|
413
427
|
*/
|
|
414
428
|
is_out_of_schedule?: boolean;
|
|
415
429
|
metric_definition: MetricDefinitionSummary;
|
|
@@ -559,6 +573,16 @@ export interface ArticlesCreateRequest {
|
|
|
559
573
|
* @example ["DEVU-12345"]
|
|
560
574
|
*/
|
|
561
575
|
authored_by?: string[];
|
|
576
|
+
/** Application-defined custom fields. */
|
|
577
|
+
custom_fields?: object;
|
|
578
|
+
/**
|
|
579
|
+
* Requested custom schemas described abstractly. Every provided schema's
|
|
580
|
+
* custom field must be specified, otherwise a bad request error is
|
|
581
|
+
* returned. If a new custom schema specifier is provided, then it will be
|
|
582
|
+
* added to the work, otherwise if a custom schema is omitted from the
|
|
583
|
+
* specifier, it remains unmodified.
|
|
584
|
+
*/
|
|
585
|
+
custom_schema_spec?: CustomSchemaSpec;
|
|
562
586
|
/** Description for the article. */
|
|
563
587
|
description?: string;
|
|
564
588
|
/**
|
|
@@ -739,6 +763,16 @@ export interface ArticlesUpdateRequest {
|
|
|
739
763
|
applies_to_parts?: ArticlesUpdateRequestAppliesToParts;
|
|
740
764
|
artifacts?: ArticlesUpdateRequestArtifacts;
|
|
741
765
|
authored_by?: ArticlesUpdateRequestAuthoredBy;
|
|
766
|
+
/** Application-defined custom fields. */
|
|
767
|
+
custom_fields?: object;
|
|
768
|
+
/**
|
|
769
|
+
* Requested custom schemas described abstractly. Every provided schema's
|
|
770
|
+
* custom field must be specified, otherwise a bad request error is
|
|
771
|
+
* returned. If a new custom schema specifier is provided, then it will be
|
|
772
|
+
* added to the work, otherwise if a custom schema is omitted from the
|
|
773
|
+
* specifier, it remains unmodified.
|
|
774
|
+
*/
|
|
775
|
+
custom_schema_spec?: CustomSchemaSpec;
|
|
742
776
|
/**
|
|
743
777
|
* Updated description of the article object, or unchanged if not
|
|
744
778
|
* provided.
|
|
@@ -1012,7 +1046,7 @@ export interface AtomBaseSummary {
|
|
|
1012
1046
|
id: string;
|
|
1013
1047
|
}
|
|
1014
1048
|
/** atom-summary */
|
|
1015
|
-
export type AtomSummary = (AccountSummary | AppFragmentSummary | CapabilitySummary | ConversationSummary | CustomTypeFragmentSummary | DevUserSummary | EngagementSummary | EnhancementSummary | FeatureSummary | IssueSummary | MeetingSummary | OpportunitySummary | ProductSummary | RevOrgSummary | RevUserSummary | ServiceAccountSummary | SysUserSummary | TagSummary | TaskSummary | TenantFragmentSummary | TicketSummary | TimelineCommentSummary | WebhookSummary) & {
|
|
1049
|
+
export type AtomSummary = (AccountSummary | AppFragmentSummary | CapabilitySummary | ConversationSummary | CustomTypeFragmentSummary | DevUserSummary | EngagementSummary | EnhancementSummary | FeatureSummary | IssueSummary | MeetingSummary | OpportunitySummary | ProductSummary | RevOrgSummary | RevUserSummary | ServiceAccountSummary | SysUserSummary | TagSummary | TaskSummary | TenantFragmentSummary | TicketSummary | TimelineChangeEventSummary | TimelineCommentSummary | WebhookSummary) & {
|
|
1016
1050
|
type: AtomType;
|
|
1017
1051
|
};
|
|
1018
1052
|
export declare enum AtomType {
|
|
@@ -1037,6 +1071,7 @@ export declare enum AtomType {
|
|
|
1037
1071
|
Task = "task",
|
|
1038
1072
|
TenantFragment = "tenant_fragment",
|
|
1039
1073
|
Ticket = "ticket",
|
|
1074
|
+
TimelineChangeEvent = "timeline_change_event",
|
|
1040
1075
|
TimelineComment = "timeline_comment",
|
|
1041
1076
|
Webhook = "webhook"
|
|
1042
1077
|
}
|
|
@@ -1218,6 +1253,11 @@ export declare enum AuthTokenTokenType {
|
|
|
1218
1253
|
export interface AuthTokensAccountTraits {
|
|
1219
1254
|
/** The display name of the account. */
|
|
1220
1255
|
display_name?: string;
|
|
1256
|
+
/**
|
|
1257
|
+
* List of company's domain names on accounts. Example -
|
|
1258
|
+
* ['devrev.ai'].
|
|
1259
|
+
*/
|
|
1260
|
+
domains?: string[];
|
|
1221
1261
|
}
|
|
1222
1262
|
/**
|
|
1223
1263
|
* auth-tokens-create-request
|
|
@@ -1369,7 +1409,10 @@ export interface AuthTokensOrgTraits {
|
|
|
1369
1409
|
description?: string;
|
|
1370
1410
|
/** The display name of the Rev org. */
|
|
1371
1411
|
display_name?: string;
|
|
1372
|
-
/**
|
|
1412
|
+
/**
|
|
1413
|
+
* The domain of the Rev org.
|
|
1414
|
+
* @deprecated
|
|
1415
|
+
*/
|
|
1373
1416
|
domain?: string;
|
|
1374
1417
|
/** Phone numbers of the Rev org. */
|
|
1375
1418
|
phone_numbers?: string[];
|
|
@@ -1627,7 +1670,18 @@ export declare enum CodeChangeSource {
|
|
|
1627
1670
|
Github = "github"
|
|
1628
1671
|
}
|
|
1629
1672
|
/** code-changes-create-request */
|
|
1630
|
-
export
|
|
1673
|
+
export interface CodeChangesCreateRequest {
|
|
1674
|
+
/** Application-defined custom fields. */
|
|
1675
|
+
custom_fields?: object;
|
|
1676
|
+
/**
|
|
1677
|
+
* Requested custom schemas described abstractly. Every provided schema's
|
|
1678
|
+
* custom field must be specified, otherwise a bad request error is
|
|
1679
|
+
* returned. If a new custom schema specifier is provided, then it will be
|
|
1680
|
+
* added to the work, otherwise if a custom schema is omitted from the
|
|
1681
|
+
* specifier, it remains unmodified.
|
|
1682
|
+
*/
|
|
1683
|
+
custom_schema_spec?: CustomSchemaSpec;
|
|
1684
|
+
}
|
|
1631
1685
|
/** code-changes-create-response */
|
|
1632
1686
|
export interface CodeChangesCreateResponse {
|
|
1633
1687
|
code_change: CodeChange;
|
|
@@ -1691,6 +1745,16 @@ export interface CodeChangesListResponse {
|
|
|
1691
1745
|
}
|
|
1692
1746
|
/** code-changes-update-request */
|
|
1693
1747
|
export interface CodeChangesUpdateRequest {
|
|
1748
|
+
/** Application-defined custom fields. */
|
|
1749
|
+
custom_fields?: object;
|
|
1750
|
+
/**
|
|
1751
|
+
* Requested custom schemas described abstractly. Every provided schema's
|
|
1752
|
+
* custom field must be specified, otherwise a bad request error is
|
|
1753
|
+
* returned. If a new custom schema specifier is provided, then it will be
|
|
1754
|
+
* added to the work, otherwise if a custom schema is omitted from the
|
|
1755
|
+
* specifier, it remains unmodified.
|
|
1756
|
+
*/
|
|
1757
|
+
custom_schema_spec?: CustomSchemaSpec;
|
|
1694
1758
|
/** The ID of the code change object to be updated. */
|
|
1695
1759
|
id: string;
|
|
1696
1760
|
}
|
|
@@ -1717,6 +1781,115 @@ export interface CommentSearchSummary {
|
|
|
1717
1781
|
/** Text snippet where the search hit occurred. */
|
|
1718
1782
|
snippet?: string;
|
|
1719
1783
|
}
|
|
1784
|
+
/** content-template */
|
|
1785
|
+
export interface ContentTemplate {
|
|
1786
|
+
type: ContentTemplateType;
|
|
1787
|
+
}
|
|
1788
|
+
/**
|
|
1789
|
+
* content-template-create-request
|
|
1790
|
+
* The request to create a new content template.
|
|
1791
|
+
*/
|
|
1792
|
+
export type ContentTemplateCreateRequest = ContentTemplateCreateRequestNotificationContentTemplate & {
|
|
1793
|
+
type: ContentTemplateType;
|
|
1794
|
+
/**
|
|
1795
|
+
* Input fields schema. The fields will be used to replace variables
|
|
1796
|
+
* present in the content template.
|
|
1797
|
+
*/
|
|
1798
|
+
input_fields_schema?: SchemaFieldDescriptor[];
|
|
1799
|
+
/**
|
|
1800
|
+
* The name of the content template. The name must be unique for each
|
|
1801
|
+
* creator of the content template.
|
|
1802
|
+
*/
|
|
1803
|
+
name: string;
|
|
1804
|
+
};
|
|
1805
|
+
/** content-template-create-request-notification-content-template */
|
|
1806
|
+
export interface ContentTemplateCreateRequestNotificationContentTemplate {
|
|
1807
|
+
/**
|
|
1808
|
+
* Default notification template per language. Only one is permitted
|
|
1809
|
+
* per language. These will be used to replace the notification
|
|
1810
|
+
* content on basis of language preferences of the user. Default is
|
|
1811
|
+
* EN(US).
|
|
1812
|
+
*/
|
|
1813
|
+
defaults: ContentTemplateCreateRequestNotificationContentTemplateDefaultNotificationContentTemplate[];
|
|
1814
|
+
}
|
|
1815
|
+
/** content-template-create-request-notification-content-template-default-notification-content-template */
|
|
1816
|
+
export interface ContentTemplateCreateRequestNotificationContentTemplateDefaultNotificationContentTemplate {
|
|
1817
|
+
/**
|
|
1818
|
+
* Body for the notification. In order to use fields from input fields
|
|
1819
|
+
* schema, use {field_name} in the body.
|
|
1820
|
+
*/
|
|
1821
|
+
body: string;
|
|
1822
|
+
/**
|
|
1823
|
+
* Title for the notification. In order to use fields from input
|
|
1824
|
+
* fields schema, use {field_name} in the title.
|
|
1825
|
+
*/
|
|
1826
|
+
title: string;
|
|
1827
|
+
}
|
|
1828
|
+
/** content-template-create-response */
|
|
1829
|
+
export interface ContentTemplateCreateResponse {
|
|
1830
|
+
content_template: ContentTemplate;
|
|
1831
|
+
}
|
|
1832
|
+
/** content-template-get-request */
|
|
1833
|
+
export interface ContentTemplateGetRequest {
|
|
1834
|
+
/** The content template's ID. */
|
|
1835
|
+
id: string;
|
|
1836
|
+
}
|
|
1837
|
+
/** content-template-get-response */
|
|
1838
|
+
export interface ContentTemplateGetResponse {
|
|
1839
|
+
content_template: ContentTemplate;
|
|
1840
|
+
}
|
|
1841
|
+
/** content-template-list-request */
|
|
1842
|
+
export interface ContentTemplateListRequest {
|
|
1843
|
+
/** Filters for content template of the provided types. */
|
|
1844
|
+
type?: ContentTemplateType[];
|
|
1845
|
+
/**
|
|
1846
|
+
* Filters for content template created by any of these users.
|
|
1847
|
+
* @example ["DEVU-12345"]
|
|
1848
|
+
*/
|
|
1849
|
+
created_by?: string[];
|
|
1850
|
+
/**
|
|
1851
|
+
* The cursor to resume iteration from. If not provided, then
|
|
1852
|
+
* iteration starts from the beginning.
|
|
1853
|
+
*/
|
|
1854
|
+
cursor?: string;
|
|
1855
|
+
/**
|
|
1856
|
+
* The maximum number of content template to return. The default is
|
|
1857
|
+
* '50'.
|
|
1858
|
+
* @format int32
|
|
1859
|
+
*/
|
|
1860
|
+
limit?: number;
|
|
1861
|
+
/**
|
|
1862
|
+
* The iteration mode to use. If "after", then entries after the provided
|
|
1863
|
+
* cursor will be returned, or if no cursor is provided, then from the
|
|
1864
|
+
* beginning. If "before", then entries before the provided cursor will be
|
|
1865
|
+
* returned, or if no cursor is provided, then from the end. Entries will
|
|
1866
|
+
* always be returned in the specified sort-by order.
|
|
1867
|
+
*/
|
|
1868
|
+
mode?: ListMode;
|
|
1869
|
+
/** Filters for content template based on name. */
|
|
1870
|
+
name?: string[];
|
|
1871
|
+
/**
|
|
1872
|
+
* Fields to sort the content template by and the direction to sort
|
|
1873
|
+
* them.
|
|
1874
|
+
*/
|
|
1875
|
+
sort_by?: string[];
|
|
1876
|
+
}
|
|
1877
|
+
/** content-template-list-response */
|
|
1878
|
+
export interface ContentTemplateListResponse {
|
|
1879
|
+
/** The list of content templates. */
|
|
1880
|
+
content_template: ContentTemplate[];
|
|
1881
|
+
/**
|
|
1882
|
+
* The cursor used to iterate subsequent results in accordance to the
|
|
1883
|
+
* sort order. If not set, then no later elements exist.
|
|
1884
|
+
*/
|
|
1885
|
+
next_cursor?: string;
|
|
1886
|
+
/**
|
|
1887
|
+
* The cursor used to iterate preceding results in accordance to the
|
|
1888
|
+
* sort order. If not set, then no prior elements exist.
|
|
1889
|
+
*/
|
|
1890
|
+
prev_cursor?: string;
|
|
1891
|
+
}
|
|
1892
|
+
export type ContentTemplateType = string;
|
|
1720
1893
|
/** conversation */
|
|
1721
1894
|
export type Conversation = AtomBase & {
|
|
1722
1895
|
/** Description of the conversation object. */
|
|
@@ -2131,6 +2304,29 @@ export interface CreateOrgScheduleInterval {
|
|
|
2131
2304
|
*/
|
|
2132
2305
|
to?: string;
|
|
2133
2306
|
}
|
|
2307
|
+
/**
|
|
2308
|
+
* create-stage
|
|
2309
|
+
* Create object for stage.
|
|
2310
|
+
*/
|
|
2311
|
+
export interface CreateStage {
|
|
2312
|
+
/** Notes relevant to the stage */
|
|
2313
|
+
notes?: string;
|
|
2314
|
+
/** DON of the stage. */
|
|
2315
|
+
stage: string;
|
|
2316
|
+
}
|
|
2317
|
+
/**
|
|
2318
|
+
* create-tag-with-value
|
|
2319
|
+
* Create object for tag_summary.
|
|
2320
|
+
*/
|
|
2321
|
+
export interface CreateTagWithValue {
|
|
2322
|
+
/**
|
|
2323
|
+
* ID of the referenced tag
|
|
2324
|
+
* @example "TAG-12345"
|
|
2325
|
+
*/
|
|
2326
|
+
tag_id: string;
|
|
2327
|
+
/** Value associated with the tag for the object. */
|
|
2328
|
+
value?: string;
|
|
2329
|
+
}
|
|
2134
2330
|
/** create-weekly-org-schedule-interval */
|
|
2135
2331
|
export interface CreateWeeklyOrgScheduleInterval {
|
|
2136
2332
|
/**
|
|
@@ -2345,9 +2541,21 @@ export interface CustomSchemaSpec {
|
|
|
2345
2541
|
validate_required_fields?: boolean;
|
|
2346
2542
|
}
|
|
2347
2543
|
/** custom-stage */
|
|
2348
|
-
export type CustomStage = AtomBase
|
|
2544
|
+
export type CustomStage = AtomBase & {
|
|
2545
|
+
/** The human readable name of the state. */
|
|
2546
|
+
name?: string;
|
|
2547
|
+
/**
|
|
2548
|
+
* Ordinal used to sort/group stages.
|
|
2549
|
+
* @format int32
|
|
2550
|
+
*/
|
|
2551
|
+
ordinal?: number;
|
|
2552
|
+
state?: CustomStateSummary;
|
|
2553
|
+
};
|
|
2349
2554
|
/** custom-stage-summary */
|
|
2350
|
-
export type CustomStageSummary = AtomBaseSummary
|
|
2555
|
+
export type CustomStageSummary = AtomBaseSummary & {
|
|
2556
|
+
/** The human readable name of the state. */
|
|
2557
|
+
name?: string;
|
|
2558
|
+
};
|
|
2351
2559
|
/** custom-stages-create-request */
|
|
2352
2560
|
export interface CustomStagesCreateRequest {
|
|
2353
2561
|
/**
|
|
@@ -2426,7 +2634,22 @@ export interface CustomStagesUpdateResponse {
|
|
|
2426
2634
|
custom_stage: CustomStage;
|
|
2427
2635
|
}
|
|
2428
2636
|
/** custom-state */
|
|
2429
|
-
export type CustomState = AtomBase
|
|
2637
|
+
export type CustomState = AtomBase & {
|
|
2638
|
+
/** True if this is a final state. */
|
|
2639
|
+
is_final?: boolean;
|
|
2640
|
+
/** The human readable name of the state. */
|
|
2641
|
+
name?: string;
|
|
2642
|
+
/**
|
|
2643
|
+
* Ordinal used to identify system states.
|
|
2644
|
+
* @format int32
|
|
2645
|
+
*/
|
|
2646
|
+
ordinal?: number;
|
|
2647
|
+
};
|
|
2648
|
+
/** custom-state-summary */
|
|
2649
|
+
export type CustomStateSummary = AtomBaseSummary & {
|
|
2650
|
+
/** The human readable name of the state. */
|
|
2651
|
+
name?: string;
|
|
2652
|
+
};
|
|
2430
2653
|
/** custom-states-create-request */
|
|
2431
2654
|
export interface CustomStatesCreateRequest {
|
|
2432
2655
|
/** Whether this is a final state. */
|
|
@@ -2894,11 +3117,45 @@ export interface DevUsersSelfResponse {
|
|
|
2894
3117
|
export interface DevUsersSelfUpdateRequest {
|
|
2895
3118
|
/** The updated display name of the Dev user. */
|
|
2896
3119
|
display_name?: string;
|
|
3120
|
+
/**
|
|
3121
|
+
* Start date of Dev user's experience.
|
|
3122
|
+
* @format date-time
|
|
3123
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
3124
|
+
*/
|
|
3125
|
+
experience_start_date?: string;
|
|
2897
3126
|
/** The updated full name of the Dev user. */
|
|
2898
3127
|
full_name?: string;
|
|
3128
|
+
/** Job history of the Dev user. */
|
|
3129
|
+
job_history?: DevUsersUpdateJobHistoryItem[];
|
|
2899
3130
|
/** Job title of the Dev User. */
|
|
2900
3131
|
job_title?: DevUserJobTitle;
|
|
2901
3132
|
}
|
|
3133
|
+
/** dev-users-update-job-history-item */
|
|
3134
|
+
export interface DevUsersUpdateJobHistoryItem {
|
|
3135
|
+
/**
|
|
3136
|
+
* Enum for the employment status of the user.
|
|
3137
|
+
* @format int64
|
|
3138
|
+
*/
|
|
3139
|
+
employment_status?: number;
|
|
3140
|
+
/**
|
|
3141
|
+
* End date of the job.
|
|
3142
|
+
* @format date-time
|
|
3143
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
3144
|
+
*/
|
|
3145
|
+
end_date?: string;
|
|
3146
|
+
/** Is this the current active job for the user. */
|
|
3147
|
+
is_current?: boolean;
|
|
3148
|
+
/** The job location for the user. */
|
|
3149
|
+
location?: string;
|
|
3150
|
+
/**
|
|
3151
|
+
* Start date of the job.
|
|
3152
|
+
* @format date-time
|
|
3153
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
3154
|
+
*/
|
|
3155
|
+
start_date?: string;
|
|
3156
|
+
/** The job title for the user. */
|
|
3157
|
+
title?: string;
|
|
3158
|
+
}
|
|
2902
3159
|
/**
|
|
2903
3160
|
* dev-users-update-request
|
|
2904
3161
|
* A request to update the user's information corresponding to the
|
|
@@ -2907,10 +3164,18 @@ export interface DevUsersSelfUpdateRequest {
|
|
|
2907
3164
|
export interface DevUsersUpdateRequest {
|
|
2908
3165
|
/** The updated display name of the Dev user. */
|
|
2909
3166
|
display_name?: string;
|
|
3167
|
+
/**
|
|
3168
|
+
* Start date of Dev user's experience.
|
|
3169
|
+
* @format date-time
|
|
3170
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
3171
|
+
*/
|
|
3172
|
+
experience_start_date?: string;
|
|
2910
3173
|
/** The updated full name of the Dev user. */
|
|
2911
3174
|
full_name?: string;
|
|
2912
3175
|
/** The ID for the Dev user to be updated. */
|
|
2913
3176
|
id: string;
|
|
3177
|
+
/** Job history of the Dev user. */
|
|
3178
|
+
job_history?: DevUsersUpdateJobHistoryItem[];
|
|
2914
3179
|
/** Job title of the Dev User. */
|
|
2915
3180
|
job_title?: DevUserJobTitle;
|
|
2916
3181
|
}
|
|
@@ -2996,6 +3261,8 @@ export type EngagementSummary = AtomBaseSummary;
|
|
|
2996
3261
|
/** Type of engagement. */
|
|
2997
3262
|
export declare enum EngagementType {
|
|
2998
3263
|
Call = "call",
|
|
3264
|
+
Conversation = "conversation",
|
|
3265
|
+
Custom = "custom",
|
|
2999
3266
|
Default = "default",
|
|
3000
3267
|
Email = "email",
|
|
3001
3268
|
LinkedIn = "linked_in",
|
|
@@ -3206,7 +3473,7 @@ export type EnhancementSummary = PartBaseSummary;
|
|
|
3206
3473
|
*/
|
|
3207
3474
|
export interface EnumValue {
|
|
3208
3475
|
/**
|
|
3209
|
-
* The
|
|
3476
|
+
* The unique ID of the enum value.
|
|
3210
3477
|
* @format int64
|
|
3211
3478
|
*/
|
|
3212
3479
|
id: number;
|
|
@@ -3278,9 +3545,11 @@ export interface ErrorBadRequestMergeWorksErrorError {
|
|
|
3278
3545
|
closed?: ErrorBadRequestMergeWorksErrorErrorClosed;
|
|
3279
3546
|
/** The details of the error. */
|
|
3280
3547
|
details: string;
|
|
3548
|
+
different_reporters?: ErrorBadRequestMergeWorksErrorErrorDifferentReporters;
|
|
3281
3549
|
different_workspace?: ErrorBadRequestMergeWorksErrorErrorDifferentWorkspace;
|
|
3282
3550
|
invalid_stage_transition?: ErrorBadRequestMergeWorksErrorErrorInvalidStageTransition;
|
|
3283
|
-
|
|
3551
|
+
locked?: ErrorBadRequestMergeWorksErrorErrorLocked;
|
|
3552
|
+
subtype?: 'already_merged' | 'closed' | 'different_reporters' | 'different_workspace' | 'invalid_stage_transition' | 'locked';
|
|
3284
3553
|
/** The ID of the work which failed the validation. */
|
|
3285
3554
|
work: string;
|
|
3286
3555
|
}
|
|
@@ -3291,12 +3560,19 @@ export interface ErrorBadRequestMergeWorksErrorErrorAlreadyMerged {
|
|
|
3291
3560
|
}
|
|
3292
3561
|
/** error-bad-request-merge-works-error-error-closed */
|
|
3293
3562
|
export type ErrorBadRequestMergeWorksErrorErrorClosed = object;
|
|
3563
|
+
/** error-bad-request-merge-works-error-error-different-reporters */
|
|
3564
|
+
export interface ErrorBadRequestMergeWorksErrorErrorDifferentReporters {
|
|
3565
|
+
/** The reporters of the primary work. */
|
|
3566
|
+
primary_reporters?: string[];
|
|
3567
|
+
/** The reporters of the secondary work. */
|
|
3568
|
+
secondary_reporters?: string[];
|
|
3569
|
+
}
|
|
3294
3570
|
/** error-bad-request-merge-works-error-error-different-workspace */
|
|
3295
3571
|
export interface ErrorBadRequestMergeWorksErrorErrorDifferentWorkspace {
|
|
3296
3572
|
/** The workspace of the primary work. */
|
|
3297
|
-
primary_workspace
|
|
3573
|
+
primary_workspace?: string;
|
|
3298
3574
|
/** The workspace of the secondary work. */
|
|
3299
|
-
secondary_workspace
|
|
3575
|
+
secondary_workspace?: string;
|
|
3300
3576
|
}
|
|
3301
3577
|
/** error-bad-request-merge-works-error-error-invalid-stage-transition */
|
|
3302
3578
|
export interface ErrorBadRequestMergeWorksErrorErrorInvalidStageTransition {
|
|
@@ -3305,6 +3581,8 @@ export interface ErrorBadRequestMergeWorksErrorErrorInvalidStageTransition {
|
|
|
3305
3581
|
/** The stage to which the transition isn't allowed. */
|
|
3306
3582
|
requested_stage: string;
|
|
3307
3583
|
}
|
|
3584
|
+
/** error-bad-request-merge-works-error-error-locked */
|
|
3585
|
+
export type ErrorBadRequestMergeWorksErrorErrorLocked = object;
|
|
3308
3586
|
/** error-bad-request-missing-dependency */
|
|
3309
3587
|
export interface ErrorBadRequestMissingDependency {
|
|
3310
3588
|
/** The dependent fields. */
|
|
@@ -3520,10 +3798,36 @@ export interface EventGroupCreated {
|
|
|
3520
3798
|
export interface EventGroupDeleted {
|
|
3521
3799
|
/** The ID of the group that was deleted. */
|
|
3522
3800
|
id: string;
|
|
3801
|
+
old_group?: Group;
|
|
3802
|
+
}
|
|
3803
|
+
/** event-group-member-added */
|
|
3804
|
+
export interface EventGroupMemberAdded {
|
|
3805
|
+
group: GroupSummary;
|
|
3806
|
+
member: UserSummary;
|
|
3807
|
+
}
|
|
3808
|
+
/** event-group-member-removed */
|
|
3809
|
+
export interface EventGroupMemberRemoved {
|
|
3810
|
+
group: GroupSummary;
|
|
3811
|
+
member: UserSummary;
|
|
3523
3812
|
}
|
|
3524
3813
|
/** event-group-updated */
|
|
3525
3814
|
export interface EventGroupUpdated {
|
|
3526
3815
|
group: Group;
|
|
3816
|
+
old_group?: Group;
|
|
3817
|
+
}
|
|
3818
|
+
/** event-link-created */
|
|
3819
|
+
export interface EventLinkCreated {
|
|
3820
|
+
link: Link;
|
|
3821
|
+
}
|
|
3822
|
+
/** event-link-deleted */
|
|
3823
|
+
export interface EventLinkDeleted {
|
|
3824
|
+
/** The ID of the link that was deleted. */
|
|
3825
|
+
id: string;
|
|
3826
|
+
}
|
|
3827
|
+
/** event-link-updated */
|
|
3828
|
+
export interface EventLinkUpdated {
|
|
3829
|
+
link: Link;
|
|
3830
|
+
old_link?: Link;
|
|
3527
3831
|
}
|
|
3528
3832
|
/** event-part-created */
|
|
3529
3833
|
export interface EventPartCreated {
|
|
@@ -3781,11 +4085,139 @@ export interface ExternalIdentity {
|
|
|
3781
4085
|
export type Feature = PartBase;
|
|
3782
4086
|
/** feature-summary */
|
|
3783
4087
|
export type FeatureSummary = PartBaseSummary;
|
|
4088
|
+
/**
|
|
4089
|
+
* field-delta
|
|
4090
|
+
* A field change.
|
|
4091
|
+
*/
|
|
4092
|
+
export interface FieldDelta {
|
|
4093
|
+
/** Set of field attributes. */
|
|
4094
|
+
field_descriptor?: SchemaFieldDescriptor;
|
|
4095
|
+
/** The name of the field. */
|
|
4096
|
+
name?: string;
|
|
4097
|
+
new_value?: FieldValue;
|
|
4098
|
+
old_value?: FieldValue;
|
|
4099
|
+
}
|
|
3784
4100
|
/**
|
|
3785
4101
|
* field-descriptor
|
|
3786
4102
|
* Set of field attributes.
|
|
3787
4103
|
*/
|
|
3788
4104
|
export type FieldDescriptor = object;
|
|
4105
|
+
/** field-value */
|
|
4106
|
+
export type FieldValue = (FieldValueBool | FieldValueBoolList | FieldValueComposite | FieldValueCompositeList | FieldValueDateList | FieldValueDateTimeList | FieldValueDateTimeValue | FieldValueDateValue | FieldValueDouble | FieldValueDoubleList | FieldValueId | FieldValueIdList | FieldValueInt64 | FieldValueInt64List | FieldValueStage | FieldValueString | FieldValueStringList | FieldValueTagSummary | FieldValueTagSummaryList) & {
|
|
4107
|
+
type: FieldValueType;
|
|
4108
|
+
};
|
|
4109
|
+
/** field-value-bool */
|
|
4110
|
+
export interface FieldValueBool {
|
|
4111
|
+
value: boolean;
|
|
4112
|
+
}
|
|
4113
|
+
/** field-value-bool-list */
|
|
4114
|
+
export interface FieldValueBoolList {
|
|
4115
|
+
values: boolean[];
|
|
4116
|
+
}
|
|
4117
|
+
/** field-value-composite */
|
|
4118
|
+
export interface FieldValueComposite {
|
|
4119
|
+
fields: Record<string, FieldValue>;
|
|
4120
|
+
}
|
|
4121
|
+
/** field-value-composite-list */
|
|
4122
|
+
export interface FieldValueCompositeList {
|
|
4123
|
+
values: FieldValueComposite[];
|
|
4124
|
+
}
|
|
4125
|
+
/** field-value-date-list */
|
|
4126
|
+
export interface FieldValueDateList {
|
|
4127
|
+
/** @example ["2023-01-01"] */
|
|
4128
|
+
values: string[];
|
|
4129
|
+
}
|
|
4130
|
+
/** field-value-date-time-list */
|
|
4131
|
+
export interface FieldValueDateTimeList {
|
|
4132
|
+
/** @example ["2023-01-01T12:00:00.000Z"] */
|
|
4133
|
+
values: string[];
|
|
4134
|
+
}
|
|
4135
|
+
/** field-value-date-time-value */
|
|
4136
|
+
export interface FieldValueDateTimeValue {
|
|
4137
|
+
/**
|
|
4138
|
+
* @format date-time
|
|
4139
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
4140
|
+
*/
|
|
4141
|
+
value: string;
|
|
4142
|
+
}
|
|
4143
|
+
/** field-value-date-value */
|
|
4144
|
+
export interface FieldValueDateValue {
|
|
4145
|
+
/**
|
|
4146
|
+
* @format date
|
|
4147
|
+
* @example "2023-01-01"
|
|
4148
|
+
*/
|
|
4149
|
+
value: string;
|
|
4150
|
+
}
|
|
4151
|
+
/** field-value-double */
|
|
4152
|
+
export interface FieldValueDouble {
|
|
4153
|
+
/** @format double */
|
|
4154
|
+
value: number;
|
|
4155
|
+
}
|
|
4156
|
+
/** field-value-double-list */
|
|
4157
|
+
export interface FieldValueDoubleList {
|
|
4158
|
+
values: number[];
|
|
4159
|
+
}
|
|
4160
|
+
/** field-value-id */
|
|
4161
|
+
export interface FieldValueId {
|
|
4162
|
+
value: string;
|
|
4163
|
+
}
|
|
4164
|
+
/** field-value-id-list */
|
|
4165
|
+
export interface FieldValueIdList {
|
|
4166
|
+
values: string[];
|
|
4167
|
+
}
|
|
4168
|
+
/** field-value-int64 */
|
|
4169
|
+
export interface FieldValueInt64 {
|
|
4170
|
+
/** @format int64 */
|
|
4171
|
+
value: number;
|
|
4172
|
+
}
|
|
4173
|
+
/** field-value-int64-list */
|
|
4174
|
+
export interface FieldValueInt64List {
|
|
4175
|
+
values: number[];
|
|
4176
|
+
}
|
|
4177
|
+
/** field-value-stage */
|
|
4178
|
+
export interface FieldValueStage {
|
|
4179
|
+
name?: string;
|
|
4180
|
+
notes?: string;
|
|
4181
|
+
}
|
|
4182
|
+
/** field-value-string */
|
|
4183
|
+
export interface FieldValueString {
|
|
4184
|
+
value: string;
|
|
4185
|
+
}
|
|
4186
|
+
/** field-value-string-list */
|
|
4187
|
+
export interface FieldValueStringList {
|
|
4188
|
+
values: string[];
|
|
4189
|
+
}
|
|
4190
|
+
/** field-value-tag-summary */
|
|
4191
|
+
export interface FieldValueTagSummary {
|
|
4192
|
+
name?: string;
|
|
4193
|
+
style?: string;
|
|
4194
|
+
tag_id: string;
|
|
4195
|
+
}
|
|
4196
|
+
/** field-value-tag-summary-list */
|
|
4197
|
+
export interface FieldValueTagSummaryList {
|
|
4198
|
+
values: FieldValueTagSummary[];
|
|
4199
|
+
}
|
|
4200
|
+
export declare enum FieldValueType {
|
|
4201
|
+
Bool = "bool",
|
|
4202
|
+
BoolList = "bool_list",
|
|
4203
|
+
Composite = "composite",
|
|
4204
|
+
CompositeList = "composite_list",
|
|
4205
|
+
Date = "date",
|
|
4206
|
+
DateList = "date_list",
|
|
4207
|
+
DateTime = "date_time",
|
|
4208
|
+
DateTimeList = "date_time_list",
|
|
4209
|
+
Double = "double",
|
|
4210
|
+
DoubleList = "double_list",
|
|
4211
|
+
Id = "id",
|
|
4212
|
+
IdList = "id_list",
|
|
4213
|
+
Int = "int",
|
|
4214
|
+
IntList = "int_list",
|
|
4215
|
+
Stage = "stage",
|
|
4216
|
+
String = "string",
|
|
4217
|
+
StringList = "string_list",
|
|
4218
|
+
TagSummary = "tag_summary",
|
|
4219
|
+
TagSummaryList = "tag_summary_list"
|
|
4220
|
+
}
|
|
3789
4221
|
/** Event type of the notification. */
|
|
3790
4222
|
export declare enum GenericNotificationEventType {
|
|
3791
4223
|
Alert = "alert",
|
|
@@ -4044,7 +4476,7 @@ export interface GroupsUpdateResponse {
|
|
|
4044
4476
|
export type Incident = AtomBase & {
|
|
4045
4477
|
/** Parts to which the incident is applicable to. */
|
|
4046
4478
|
applies_to_parts?: PartSummary[];
|
|
4047
|
-
/**
|
|
4479
|
+
/** Artifacts attached to the incident. */
|
|
4048
4480
|
artifacts?: ArtifactSummary[];
|
|
4049
4481
|
/** Body of the incident. */
|
|
4050
4482
|
body?: string;
|
|
@@ -4060,17 +4492,17 @@ export type Incident = AtomBase & {
|
|
|
4060
4492
|
* @format date-time
|
|
4061
4493
|
* @example "2023-01-01T12:00:00.000Z"
|
|
4062
4494
|
*/
|
|
4063
|
-
|
|
4064
|
-
/** List of customers impacted due to the
|
|
4495
|
+
identified_date?: string;
|
|
4496
|
+
/** List of customers impacted due to the incident. */
|
|
4065
4497
|
impacted_customers?: AccountSummary[];
|
|
4066
|
-
/** The users that own the incident. */
|
|
4067
|
-
owned_by?: UserSummary[];
|
|
4068
4498
|
/**
|
|
4069
|
-
* Timestamp when the incident was
|
|
4499
|
+
* Timestamp when the incident was mitigated.
|
|
4070
4500
|
* @format date-time
|
|
4071
4501
|
* @example "2023-01-01T12:00:00.000Z"
|
|
4072
4502
|
*/
|
|
4073
|
-
|
|
4503
|
+
mitigated_date?: string;
|
|
4504
|
+
/** The users that own the incident. */
|
|
4505
|
+
owned_by?: UserSummary[];
|
|
4074
4506
|
/** The properties of an enum value. */
|
|
4075
4507
|
severity?: EnumValue;
|
|
4076
4508
|
/** Describes the current stage of a object. */
|
|
@@ -4098,6 +4530,83 @@ export type Incident = AtomBase & {
|
|
|
4098
4530
|
/** Title of the incident. */
|
|
4099
4531
|
title: string;
|
|
4100
4532
|
};
|
|
4533
|
+
/** incidents-create-request */
|
|
4534
|
+
export interface IncidentsCreateRequest {
|
|
4535
|
+
/** Parts to which the incident is applicable to. */
|
|
4536
|
+
applies_to_parts?: string[];
|
|
4537
|
+
/**
|
|
4538
|
+
* Artifacts attached to the incident.
|
|
4539
|
+
* @example ["ARTIFACT-12345"]
|
|
4540
|
+
*/
|
|
4541
|
+
artifacts?: string[];
|
|
4542
|
+
/** Body of the incident. */
|
|
4543
|
+
body?: string;
|
|
4544
|
+
/** Application-defined custom fields. */
|
|
4545
|
+
custom_fields?: object;
|
|
4546
|
+
/**
|
|
4547
|
+
* Requested custom schemas described abstractly. Every provided schema's
|
|
4548
|
+
* custom field must be specified, otherwise a bad request error is
|
|
4549
|
+
* returned. If a new custom schema specifier is provided, then it will be
|
|
4550
|
+
* added to the work, otherwise if a custom schema is omitted from the
|
|
4551
|
+
* specifier, it remains unmodified.
|
|
4552
|
+
*/
|
|
4553
|
+
custom_schema_spec?: CustomSchemaSpec;
|
|
4554
|
+
/**
|
|
4555
|
+
* Time when the incident was identified/reported.
|
|
4556
|
+
* @format date-time
|
|
4557
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
4558
|
+
*/
|
|
4559
|
+
identified_date?: string;
|
|
4560
|
+
/** List of customers impacted due to the incident. */
|
|
4561
|
+
impacted_customers?: string[];
|
|
4562
|
+
/**
|
|
4563
|
+
* Timestamp when the incident was mitigated.
|
|
4564
|
+
* @format date-time
|
|
4565
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
4566
|
+
*/
|
|
4567
|
+
mitigated_date?: string;
|
|
4568
|
+
/** User IDs of the users that own the incident. */
|
|
4569
|
+
owned_by?: string[];
|
|
4570
|
+
/**
|
|
4571
|
+
* Severity of the incident.
|
|
4572
|
+
* @format int64
|
|
4573
|
+
*/
|
|
4574
|
+
severity?: number;
|
|
4575
|
+
/** Create object for stage. */
|
|
4576
|
+
stage?: CreateStage;
|
|
4577
|
+
/**
|
|
4578
|
+
* Users, along with the incident commander, involved in resolving
|
|
4579
|
+
* incidents and handling communication.
|
|
4580
|
+
*/
|
|
4581
|
+
stakeholders?: string[];
|
|
4582
|
+
/** Tags associated with the object. */
|
|
4583
|
+
tags?: CreateTagWithValue[];
|
|
4584
|
+
/**
|
|
4585
|
+
* Timestamp when the incident is expected to be resolved.
|
|
4586
|
+
* @format date-time
|
|
4587
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
4588
|
+
*/
|
|
4589
|
+
target_close_date?: string;
|
|
4590
|
+
/** Title of the incident. */
|
|
4591
|
+
title: string;
|
|
4592
|
+
}
|
|
4593
|
+
/** incidents-create-response */
|
|
4594
|
+
export interface IncidentsCreateResponse {
|
|
4595
|
+
incident: Incident;
|
|
4596
|
+
}
|
|
4597
|
+
/**
|
|
4598
|
+
* incidents-delete-request
|
|
4599
|
+
* A request to delete an incident.
|
|
4600
|
+
*/
|
|
4601
|
+
export interface IncidentsDeleteRequest {
|
|
4602
|
+
/** ID for the incident. */
|
|
4603
|
+
id: string;
|
|
4604
|
+
}
|
|
4605
|
+
/**
|
|
4606
|
+
* incidents-delete-response
|
|
4607
|
+
* The response to deleting the incident.
|
|
4608
|
+
*/
|
|
4609
|
+
export type IncidentsDeleteResponse = object;
|
|
4101
4610
|
/** incidents-get-request */
|
|
4102
4611
|
export interface IncidentsGetRequest {
|
|
4103
4612
|
/** The ID of the incident to get. */
|
|
@@ -4247,8 +4756,68 @@ export interface IncidentsListResponse {
|
|
|
4247
4756
|
*/
|
|
4248
4757
|
prev_cursor?: string;
|
|
4249
4758
|
}
|
|
4759
|
+
/** incidents-update-request */
|
|
4760
|
+
export interface IncidentsUpdateRequest {
|
|
4761
|
+
applies_to_parts?: UpdateIncidentAppliesToParts;
|
|
4762
|
+
artifacts?: UpdateIncidentArtifacts;
|
|
4763
|
+
/** Body of the incident. */
|
|
4764
|
+
body?: string;
|
|
4765
|
+
/** Application-defined custom fields. */
|
|
4766
|
+
custom_fields?: object;
|
|
4767
|
+
/**
|
|
4768
|
+
* Requested custom schemas described abstractly. Every provided schema's
|
|
4769
|
+
* custom field must be specified, otherwise a bad request error is
|
|
4770
|
+
* returned. If a new custom schema specifier is provided, then it will be
|
|
4771
|
+
* added to the work, otherwise if a custom schema is omitted from the
|
|
4772
|
+
* specifier, it remains unmodified.
|
|
4773
|
+
*/
|
|
4774
|
+
custom_schema_spec?: CustomSchemaSpec;
|
|
4775
|
+
/** The ID of the incident to be updated. */
|
|
4776
|
+
id: string;
|
|
4777
|
+
/**
|
|
4778
|
+
* Time when the incident was identified/reported.
|
|
4779
|
+
* @format date-time
|
|
4780
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
4781
|
+
*/
|
|
4782
|
+
identified_date?: string;
|
|
4783
|
+
impacted_customers?: UpdateIncidentImpactedCustomers;
|
|
4784
|
+
/**
|
|
4785
|
+
* Timestamp when the incident was mitigated.
|
|
4786
|
+
* @format date-time
|
|
4787
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
4788
|
+
*/
|
|
4789
|
+
mitigated_date?: string;
|
|
4790
|
+
owned_by?: UpdateIncidentOwnedBy;
|
|
4791
|
+
/**
|
|
4792
|
+
* Severity of the incident.
|
|
4793
|
+
* @format int64
|
|
4794
|
+
*/
|
|
4795
|
+
severity?: number;
|
|
4796
|
+
/** Update object for Stage. */
|
|
4797
|
+
stage?: UpdateStage;
|
|
4798
|
+
stakeholders?: UpdateIncidentStakeholders;
|
|
4799
|
+
tags?: UpdateIncidentTags;
|
|
4800
|
+
/**
|
|
4801
|
+
* Timestamp when the incident is expected to be resolved.
|
|
4802
|
+
* @format date-time
|
|
4803
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
4804
|
+
*/
|
|
4805
|
+
target_close_date?: string;
|
|
4806
|
+
/** Title of the incident. */
|
|
4807
|
+
title?: string;
|
|
4808
|
+
}
|
|
4809
|
+
/** incidents-update-response */
|
|
4810
|
+
export interface IncidentsUpdateResponse {
|
|
4811
|
+
incident: Incident;
|
|
4812
|
+
}
|
|
4250
4813
|
/** issue */
|
|
4251
4814
|
export type Issue = WorkBase & {
|
|
4815
|
+
/**
|
|
4816
|
+
* Actual start date for the object.
|
|
4817
|
+
* @format date-time
|
|
4818
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
4819
|
+
*/
|
|
4820
|
+
actual_start_date?: string;
|
|
4252
4821
|
/** Parts associated based on git events. */
|
|
4253
4822
|
developed_with?: PartSummary[];
|
|
4254
4823
|
/** Priority of the work based upon impact and criticality. */
|
|
@@ -4274,6 +4843,8 @@ export declare enum IssuePriority {
|
|
|
4274
4843
|
export type IssueSummary = WorkBaseSummary & {
|
|
4275
4844
|
/** Priority of the work based upon impact and criticality. */
|
|
4276
4845
|
priority?: IssuePriority;
|
|
4846
|
+
/** Vista group item. */
|
|
4847
|
+
sprint?: VistaGroupItemSummary;
|
|
4277
4848
|
};
|
|
4278
4849
|
/**
|
|
4279
4850
|
* job-history-item
|
|
@@ -4315,7 +4886,15 @@ export interface KeyringsCreateCallbackRequest {
|
|
|
4315
4886
|
export interface LegacyStage {
|
|
4316
4887
|
/** Current stage name of the work item. */
|
|
4317
4888
|
name: string;
|
|
4889
|
+
/** Notes relevant to the stage. */
|
|
4890
|
+
notes?: string;
|
|
4891
|
+
/**
|
|
4892
|
+
* Current stage number of the work item (sortable).
|
|
4893
|
+
* @format int32
|
|
4894
|
+
*/
|
|
4895
|
+
ordinal?: number;
|
|
4318
4896
|
stage?: CustomStageSummary;
|
|
4897
|
+
state?: CustomStateSummary;
|
|
4319
4898
|
}
|
|
4320
4899
|
/**
|
|
4321
4900
|
* legacy-stage-summary
|
|
@@ -4324,6 +4903,7 @@ export interface LegacyStage {
|
|
|
4324
4903
|
export interface LegacyStageSummary {
|
|
4325
4904
|
/** Current stage name of the work item. */
|
|
4326
4905
|
name: string;
|
|
4906
|
+
stage?: CustomStageSummary;
|
|
4327
4907
|
}
|
|
4328
4908
|
/**
|
|
4329
4909
|
* lines-of-code
|
|
@@ -4423,6 +5003,7 @@ export declare enum LinkType {
|
|
|
4423
5003
|
DevelopedWith = "developed_with",
|
|
4424
5004
|
Imports = "imports",
|
|
4425
5005
|
IsAnalyzedBy = "is_analyzed_by",
|
|
5006
|
+
IsConvertedTo = "is_converted_to",
|
|
4426
5007
|
IsDependentOn = "is_dependent_on",
|
|
4427
5008
|
IsDuplicateOf = "is_duplicate_of",
|
|
4428
5009
|
IsMergedInto = "is_merged_into",
|
|
@@ -5720,6 +6301,19 @@ export interface QuestionAnswersUpdateRequestTags {
|
|
|
5720
6301
|
export interface QuestionAnswersUpdateResponse {
|
|
5721
6302
|
question_answer: QuestionAnswer;
|
|
5722
6303
|
}
|
|
6304
|
+
/** remove-tag-with-value */
|
|
6305
|
+
export interface RemoveTagWithValue {
|
|
6306
|
+
/**
|
|
6307
|
+
* The ID of the tag.
|
|
6308
|
+
* @example "TAG-12345"
|
|
6309
|
+
*/
|
|
6310
|
+
id: string;
|
|
6311
|
+
}
|
|
6312
|
+
/**
|
|
6313
|
+
* removed-sla-metric-history
|
|
6314
|
+
* User, timestamp and metric id of removed metrics.
|
|
6315
|
+
*/
|
|
6316
|
+
export type RemovedSlaMetricHistory = object;
|
|
5723
6317
|
/**
|
|
5724
6318
|
* resource
|
|
5725
6319
|
* Resource details.
|
|
@@ -5802,7 +6396,10 @@ export interface RevOrgsCreateRequest {
|
|
|
5802
6396
|
description?: string;
|
|
5803
6397
|
/** Name of the Rev organization. */
|
|
5804
6398
|
display_name: string;
|
|
5805
|
-
/**
|
|
6399
|
+
/**
|
|
6400
|
+
* Company's domain name. Example - 'devrev.ai'.
|
|
6401
|
+
* @deprecated
|
|
6402
|
+
*/
|
|
5806
6403
|
domain?: string;
|
|
5807
6404
|
/** The environment of the Org. Defaults to 'production' if not specified. */
|
|
5808
6405
|
environment?: OrgEnvironment;
|
|
@@ -5954,7 +6551,10 @@ export interface RevOrgsUpdateRequest {
|
|
|
5954
6551
|
description?: string;
|
|
5955
6552
|
/** Customer chosen name for the Rev organization. */
|
|
5956
6553
|
display_name?: string;
|
|
5957
|
-
/**
|
|
6554
|
+
/**
|
|
6555
|
+
* Company's domain name. Example - 'devrev.ai'.
|
|
6556
|
+
* @deprecated
|
|
6557
|
+
*/
|
|
5958
6558
|
domain?: string;
|
|
5959
6559
|
/** The environment of the Org. Defaults to 'production' if not specified. */
|
|
5960
6560
|
environment?: OrgEnvironment;
|
|
@@ -6183,6 +6783,51 @@ export interface RevUsersListResponse {
|
|
|
6183
6783
|
/** List containing all the Rev users. */
|
|
6184
6784
|
rev_users: RevUser[];
|
|
6185
6785
|
}
|
|
6786
|
+
/**
|
|
6787
|
+
* rev-users-scan-request
|
|
6788
|
+
* Scans the list of Rev users.
|
|
6789
|
+
*/
|
|
6790
|
+
export interface RevUsersScanRequest {
|
|
6791
|
+
/** Filters for Rev users that were created by the specified user(s). */
|
|
6792
|
+
created_by?: string[];
|
|
6793
|
+
created_date?: DateTimeFilter;
|
|
6794
|
+
/**
|
|
6795
|
+
* The cursor to resume iteration, otherwise the beginning if not
|
|
6796
|
+
* provided.
|
|
6797
|
+
*/
|
|
6798
|
+
cursor?: string;
|
|
6799
|
+
/** Filters for custom fields. */
|
|
6800
|
+
custom_fields?: object;
|
|
6801
|
+
/** List of emails of Rev users to be filtered. */
|
|
6802
|
+
email?: string[];
|
|
6803
|
+
/** List of external refs to filter Rev users for. */
|
|
6804
|
+
external_ref?: string[];
|
|
6805
|
+
/** Value of is_verified field to filter the Rev users. */
|
|
6806
|
+
is_verified?: boolean;
|
|
6807
|
+
modified_date?: DateTimeFilter;
|
|
6808
|
+
/** List of phone numbers, in E.164 format, to filter Rev users on. */
|
|
6809
|
+
phone_numbers?: string[];
|
|
6810
|
+
/**
|
|
6811
|
+
* List of IDs of Rev organizations to be filtered.
|
|
6812
|
+
* @example ["REV-AbCdEfGh"]
|
|
6813
|
+
*/
|
|
6814
|
+
rev_org?: string[];
|
|
6815
|
+
/** List of tags to be filtered. */
|
|
6816
|
+
tags?: string[];
|
|
6817
|
+
}
|
|
6818
|
+
/**
|
|
6819
|
+
* rev-users-scan-response
|
|
6820
|
+
* The response to scanning Rev users.
|
|
6821
|
+
*/
|
|
6822
|
+
export interface RevUsersScanResponse {
|
|
6823
|
+
/**
|
|
6824
|
+
* The cursor that should be used to resume iteration, otherwise if
|
|
6825
|
+
* not provided, then iteration has completed.
|
|
6826
|
+
*/
|
|
6827
|
+
next_cursor?: string;
|
|
6828
|
+
/** The iterated Rev users. */
|
|
6829
|
+
rev_users: RevUser[];
|
|
6830
|
+
}
|
|
6186
6831
|
/**
|
|
6187
6832
|
* rev-users-update-request
|
|
6188
6833
|
* Request to update details of a Rev user.
|
|
@@ -6990,6 +7635,8 @@ export interface SetIssueSelector {
|
|
|
6990
7635
|
* values.
|
|
6991
7636
|
*/
|
|
6992
7637
|
custom_fields?: object;
|
|
7638
|
+
/** The SLA policy applies to the issues of these owners. */
|
|
7639
|
+
owners?: string[];
|
|
6993
7640
|
/**
|
|
6994
7641
|
* The SLA policy applies to the issues of these parts.
|
|
6995
7642
|
* @example ["PROD-12345"]
|
|
@@ -7040,7 +7687,17 @@ export interface SetSlaSelector {
|
|
|
7040
7687
|
* value is null, the field must have null value or not be present.
|
|
7041
7688
|
*/
|
|
7042
7689
|
custom_fields?: object;
|
|
7690
|
+
/**
|
|
7691
|
+
* The SLA policy applies to the tickets or conversations of these
|
|
7692
|
+
* groups.
|
|
7693
|
+
*/
|
|
7694
|
+
groups?: string[];
|
|
7043
7695
|
issue_selector?: SetIssueSelector;
|
|
7696
|
+
/**
|
|
7697
|
+
* The SLA policy applies to the tickets or conversations of these
|
|
7698
|
+
* owners.
|
|
7699
|
+
*/
|
|
7700
|
+
owners?: string[];
|
|
7044
7701
|
/**
|
|
7045
7702
|
* The SLA policy applies to the tickets of these parts.
|
|
7046
7703
|
* @example ["PROD-12345"]
|
|
@@ -7059,6 +7716,8 @@ export interface SetSlaSelector {
|
|
|
7059
7716
|
* @example ["TAG-12345"]
|
|
7060
7717
|
*/
|
|
7061
7718
|
tags?: string[];
|
|
7719
|
+
/** The SLA policy applies to tickets with these source channels. */
|
|
7720
|
+
ticket_source_channel?: string[];
|
|
7062
7721
|
}
|
|
7063
7722
|
/** set-support-metric-target */
|
|
7064
7723
|
export interface SetSupportMetricTarget {
|
|
@@ -7265,6 +7924,8 @@ export type SlaTracker = AtomBase & {
|
|
|
7265
7924
|
applies_to_id?: string;
|
|
7266
7925
|
/** Summary of the metrics target being tracked in the SLA tracker. */
|
|
7267
7926
|
metric_target_summaries: ArchetypeMetricTarget[];
|
|
7927
|
+
/** User, timestamp and metric Id of removed metrics. */
|
|
7928
|
+
removed_sla_metric_history?: RemovedSlaMetricHistory[];
|
|
7268
7929
|
sla?: SlaSummary;
|
|
7269
7930
|
/**
|
|
7270
7931
|
* Details of the applicable SLA policy. Can be omitted if no sla
|
|
@@ -7445,6 +8106,11 @@ export interface SlasUpdateRequest {
|
|
|
7445
8106
|
export interface SlasUpdateResponse {
|
|
7446
8107
|
sla: Sla;
|
|
7447
8108
|
}
|
|
8109
|
+
/** snap-in */
|
|
8110
|
+
export type SnapIn = AtomBase & {
|
|
8111
|
+
/** Values of the inputs. */
|
|
8112
|
+
inputs_values?: object;
|
|
8113
|
+
};
|
|
7448
8114
|
/** snap-in-version-summary */
|
|
7449
8115
|
export type SnapInVersionSummary = AtomBaseSummary;
|
|
7450
8116
|
/** snap-ins-resources-request */
|
|
@@ -7471,6 +8137,17 @@ export interface SnapInsResourcesResponseKeyringData {
|
|
|
7471
8137
|
/** The secret value of the keyring. This must be handled with caution. */
|
|
7472
8138
|
secret: string;
|
|
7473
8139
|
}
|
|
8140
|
+
/** snap-ins-update-request */
|
|
8141
|
+
export interface SnapInsUpdateRequest {
|
|
8142
|
+
/** The ID of the snap-in to update. */
|
|
8143
|
+
id: string;
|
|
8144
|
+
/** The updated values of the inputs. */
|
|
8145
|
+
inputs_values?: object;
|
|
8146
|
+
}
|
|
8147
|
+
/** snap-ins-update-response */
|
|
8148
|
+
export interface SnapInsUpdateResponse {
|
|
8149
|
+
snap_in: SnapIn;
|
|
8150
|
+
}
|
|
7474
8151
|
/** snap-widget */
|
|
7475
8152
|
export type SnapWidget = EmailPreviewWidget & {
|
|
7476
8153
|
type: SnapWidgetType;
|
|
@@ -8260,7 +8937,8 @@ export declare enum TicketChannels {
|
|
|
8260
8937
|
Email = "email",
|
|
8261
8938
|
Plug = "plug",
|
|
8262
8939
|
Slack = "slack",
|
|
8263
|
-
Twilio = "twilio"
|
|
8940
|
+
Twilio = "twilio",
|
|
8941
|
+
TwilioSms = "twilio_sms"
|
|
8264
8942
|
}
|
|
8265
8943
|
/** Severity of the ticket. */
|
|
8266
8944
|
export declare enum TicketSeverity {
|
|
@@ -8275,6 +8953,69 @@ export type TicketSummary = WorkBaseSummary & {
|
|
|
8275
8953
|
/** Severity of the ticket. */
|
|
8276
8954
|
severity?: TicketSeverity;
|
|
8277
8955
|
};
|
|
8956
|
+
/** timeline-change-event */
|
|
8957
|
+
export type TimelineChangeEvent = TimelineEntryBase & {
|
|
8958
|
+
/** A timeline change event. */
|
|
8959
|
+
event?: TimelineChangeEventEvent;
|
|
8960
|
+
};
|
|
8961
|
+
/**
|
|
8962
|
+
* timeline-change-event-created
|
|
8963
|
+
* A creation event.
|
|
8964
|
+
*/
|
|
8965
|
+
export interface TimelineChangeEventCreated {
|
|
8966
|
+
object?: AtomSummary;
|
|
8967
|
+
}
|
|
8968
|
+
/**
|
|
8969
|
+
* timeline-change-event-deleted
|
|
8970
|
+
* A deletion event.
|
|
8971
|
+
*/
|
|
8972
|
+
export interface TimelineChangeEventDeleted {
|
|
8973
|
+
/** The ID correspending to the deleted object. */
|
|
8974
|
+
object_id?: string;
|
|
8975
|
+
}
|
|
8976
|
+
/**
|
|
8977
|
+
* timeline-change-event-event
|
|
8978
|
+
* A timeline change event.
|
|
8979
|
+
*/
|
|
8980
|
+
export interface TimelineChangeEventEvent {
|
|
8981
|
+
/** The type of the event. */
|
|
8982
|
+
type?: TimelineChangeEventEventType;
|
|
8983
|
+
/** A creation event. */
|
|
8984
|
+
created?: TimelineChangeEventCreated;
|
|
8985
|
+
/** A deletion event. */
|
|
8986
|
+
deleted?: TimelineChangeEventDeleted;
|
|
8987
|
+
/** A linking event. */
|
|
8988
|
+
linked?: TimelineChangeEventLinked;
|
|
8989
|
+
/** An update event. */
|
|
8990
|
+
updated?: TimelineChangeEventUpdated;
|
|
8991
|
+
}
|
|
8992
|
+
/** The type of the event. */
|
|
8993
|
+
export declare enum TimelineChangeEventEventType {
|
|
8994
|
+
Annotated = "annotated",
|
|
8995
|
+
Created = "created",
|
|
8996
|
+
Deleted = "deleted",
|
|
8997
|
+
Linked = "linked",
|
|
8998
|
+
Updated = "updated"
|
|
8999
|
+
}
|
|
9000
|
+
/**
|
|
9001
|
+
* timeline-change-event-linked
|
|
9002
|
+
* A linking event.
|
|
9003
|
+
*/
|
|
9004
|
+
export interface TimelineChangeEventLinked {
|
|
9005
|
+
link?: LinkSummary;
|
|
9006
|
+
}
|
|
9007
|
+
/** timeline-change-event-summary */
|
|
9008
|
+
export type TimelineChangeEventSummary = TimelineEntryBaseSummary;
|
|
9009
|
+
/**
|
|
9010
|
+
* timeline-change-event-updated
|
|
9011
|
+
* An update event.
|
|
9012
|
+
*/
|
|
9013
|
+
export interface TimelineChangeEventUpdated {
|
|
9014
|
+
/** List of field changes. */
|
|
9015
|
+
field_deltas?: FieldDelta[];
|
|
9016
|
+
/** Type of DevRev object. */
|
|
9017
|
+
object_type?: string;
|
|
9018
|
+
}
|
|
8278
9019
|
/** timeline-comment */
|
|
8279
9020
|
export type TimelineComment = TimelineEntryBase & {
|
|
8280
9021
|
/** The artifacts for the comment. */
|
|
@@ -8577,7 +9318,7 @@ export interface TimelineEntriesUpdateResponse {
|
|
|
8577
9318
|
timeline_entry: TimelineEntry;
|
|
8578
9319
|
}
|
|
8579
9320
|
/** timeline-entry */
|
|
8580
|
-
export type TimelineEntry = TimelineComment & {
|
|
9321
|
+
export type TimelineEntry = (TimelineChangeEvent | TimelineComment) & {
|
|
8581
9322
|
type: TimelineEntryType;
|
|
8582
9323
|
};
|
|
8583
9324
|
/** timeline-entry-base */
|
|
@@ -8626,6 +9367,7 @@ export declare enum TimelineEntryObjectType {
|
|
|
8626
9367
|
RevUser = "rev_user",
|
|
8627
9368
|
Task = "task",
|
|
8628
9369
|
Ticket = "ticket",
|
|
9370
|
+
TimelineChangeEvent = "timeline_change_event",
|
|
8629
9371
|
TimelineComment = "timeline_comment"
|
|
8630
9372
|
}
|
|
8631
9373
|
/** Display panels for the Timeline entry. */
|
|
@@ -8635,6 +9377,7 @@ export declare enum TimelineEntryPanel {
|
|
|
8635
9377
|
Events = "events"
|
|
8636
9378
|
}
|
|
8637
9379
|
export declare enum TimelineEntryType {
|
|
9380
|
+
TimelineChangeEvent = "timeline_change_event",
|
|
8638
9381
|
TimelineComment = "timeline_comment"
|
|
8639
9382
|
}
|
|
8640
9383
|
/**
|
|
@@ -9051,6 +9794,65 @@ export interface UomsUpdateRequestDimensions {
|
|
|
9051
9794
|
export interface UomsUpdateResponse {
|
|
9052
9795
|
uom: Uom;
|
|
9053
9796
|
}
|
|
9797
|
+
/** update-incident-applies-to-parts */
|
|
9798
|
+
export interface UpdateIncidentAppliesToParts {
|
|
9799
|
+
/** Sets the parts to which the incident is applicable to. */
|
|
9800
|
+
set?: string[];
|
|
9801
|
+
}
|
|
9802
|
+
/** update-incident-artifacts */
|
|
9803
|
+
export interface UpdateIncidentArtifacts {
|
|
9804
|
+
/**
|
|
9805
|
+
* Sets the artifacts attached to the incident.
|
|
9806
|
+
* @example ["ARTIFACT-12345"]
|
|
9807
|
+
*/
|
|
9808
|
+
set?: string[];
|
|
9809
|
+
}
|
|
9810
|
+
/** update-incident-impacted-customers */
|
|
9811
|
+
export interface UpdateIncidentImpactedCustomers {
|
|
9812
|
+
/** Sets the list of customers impacted due to the incident. */
|
|
9813
|
+
set?: string[];
|
|
9814
|
+
}
|
|
9815
|
+
/** update-incident-owned-by */
|
|
9816
|
+
export interface UpdateIncidentOwnedBy {
|
|
9817
|
+
/** Sets the user IDs of the users that own the incident. */
|
|
9818
|
+
set?: string[];
|
|
9819
|
+
}
|
|
9820
|
+
/** update-incident-stakeholders */
|
|
9821
|
+
export interface UpdateIncidentStakeholders {
|
|
9822
|
+
/**
|
|
9823
|
+
* Sets the users, along with the incident commander, involved in
|
|
9824
|
+
* resolving incidents and handling communication.
|
|
9825
|
+
*/
|
|
9826
|
+
set?: string[];
|
|
9827
|
+
}
|
|
9828
|
+
/** update-incident-tags */
|
|
9829
|
+
export interface UpdateIncidentTags {
|
|
9830
|
+
/** Sets the tags associated with the object. */
|
|
9831
|
+
set?: UpdateTagWithValue[];
|
|
9832
|
+
}
|
|
9833
|
+
/**
|
|
9834
|
+
* update-stage
|
|
9835
|
+
* Update object for Stage.
|
|
9836
|
+
*/
|
|
9837
|
+
export interface UpdateStage {
|
|
9838
|
+
/** Notes relevant to the stage */
|
|
9839
|
+
notes?: string;
|
|
9840
|
+
/** DON of the stage. */
|
|
9841
|
+
stage?: string;
|
|
9842
|
+
}
|
|
9843
|
+
/**
|
|
9844
|
+
* update-tag-with-value
|
|
9845
|
+
* Update object for TagWithValue.
|
|
9846
|
+
*/
|
|
9847
|
+
export interface UpdateTagWithValue {
|
|
9848
|
+
/**
|
|
9849
|
+
* ID of the referenced tag
|
|
9850
|
+
* @example "TAG-12345"
|
|
9851
|
+
*/
|
|
9852
|
+
tag_id?: string;
|
|
9853
|
+
/** Value associated with the tag for the object. */
|
|
9854
|
+
value?: string;
|
|
9855
|
+
}
|
|
9054
9856
|
/** user-base */
|
|
9055
9857
|
export type UserBase = AtomBase & {
|
|
9056
9858
|
/** The user's display name. The name is non-unique and mutable. */
|
|
@@ -9205,9 +10007,14 @@ export interface WebhookEventRequest {
|
|
|
9205
10007
|
dev_user_updated?: EventDevUserUpdated;
|
|
9206
10008
|
group_created?: EventGroupCreated;
|
|
9207
10009
|
group_deleted?: EventGroupDeleted;
|
|
10010
|
+
group_member_added?: EventGroupMemberAdded;
|
|
10011
|
+
group_member_removed?: EventGroupMemberRemoved;
|
|
9208
10012
|
group_updated?: EventGroupUpdated;
|
|
9209
10013
|
/** The event's ID. */
|
|
9210
10014
|
id: string;
|
|
10015
|
+
link_created?: EventLinkCreated;
|
|
10016
|
+
link_deleted?: EventLinkDeleted;
|
|
10017
|
+
link_updated?: EventLinkUpdated;
|
|
9211
10018
|
part_created?: EventPartCreated;
|
|
9212
10019
|
part_deleted?: EventPartDeleted;
|
|
9213
10020
|
part_updated?: EventPartUpdated;
|
|
@@ -9273,7 +10080,12 @@ export declare enum WebhookEventType {
|
|
|
9273
10080
|
DevUserUpdated = "dev_user_updated",
|
|
9274
10081
|
GroupCreated = "group_created",
|
|
9275
10082
|
GroupDeleted = "group_deleted",
|
|
10083
|
+
GroupMemberAdded = "group_member_added",
|
|
10084
|
+
GroupMemberRemoved = "group_member_removed",
|
|
9276
10085
|
GroupUpdated = "group_updated",
|
|
10086
|
+
LinkCreated = "link_created",
|
|
10087
|
+
LinkDeleted = "link_deleted",
|
|
10088
|
+
LinkUpdated = "link_updated",
|
|
9277
10089
|
PartCreated = "part_created",
|
|
9278
10090
|
PartDeleted = "part_deleted",
|
|
9279
10091
|
PartUpdated = "part_updated",
|
|
@@ -9336,7 +10148,10 @@ export type WebhookSummary = AtomBaseSummary;
|
|
|
9336
10148
|
export interface WebhooksCreateRequest {
|
|
9337
10149
|
/** The event types that the webhook endpoint will receive. */
|
|
9338
10150
|
event_types?: WebhookEventType[];
|
|
9339
|
-
/**
|
|
10151
|
+
/**
|
|
10152
|
+
* The headers to include in every webhook invocation.
|
|
10153
|
+
* @maxItems 8
|
|
10154
|
+
*/
|
|
9340
10155
|
headers?: WebhookHeader[];
|
|
9341
10156
|
/**
|
|
9342
10157
|
* The secret to use when verifying webhook events. If provided, the
|
|
@@ -9461,11 +10276,23 @@ export interface WebhooksUpdateRequestEventTypes {
|
|
|
9461
10276
|
}
|
|
9462
10277
|
/** webhooks-update-request-headers */
|
|
9463
10278
|
export interface WebhooksUpdateRequestHeaders {
|
|
9464
|
-
/**
|
|
10279
|
+
/**
|
|
10280
|
+
* The headers to be added to every webhook invocation. If a provided
|
|
10281
|
+
* header is already specified for the webhook, its value is replaced.
|
|
10282
|
+
* @maxItems 8
|
|
10283
|
+
*/
|
|
9465
10284
|
add?: WebhookHeader[];
|
|
9466
|
-
/**
|
|
10285
|
+
/**
|
|
10286
|
+
* The headers to be removed from every webhook invocation. If a
|
|
10287
|
+
* provided header is not specified for the webhook, then it's
|
|
10288
|
+
* ignored.
|
|
10289
|
+
* @maxItems 8
|
|
10290
|
+
*/
|
|
9467
10291
|
remove?: string[];
|
|
9468
|
-
/**
|
|
10292
|
+
/**
|
|
10293
|
+
* Sets the headers to include in every webhook invocation.
|
|
10294
|
+
* @maxItems 8
|
|
10295
|
+
*/
|
|
9469
10296
|
set?: WebhookHeader[];
|
|
9470
10297
|
}
|
|
9471
10298
|
/**
|
|
@@ -9486,6 +10313,12 @@ export type Work = (Issue | Opportunity | Task | Ticket) & {
|
|
|
9486
10313
|
};
|
|
9487
10314
|
/** work-base */
|
|
9488
10315
|
export type WorkBase = AtomBase & {
|
|
10316
|
+
/**
|
|
10317
|
+
* Timestamp when the work was actually completed.
|
|
10318
|
+
* @format date-time
|
|
10319
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
10320
|
+
*/
|
|
10321
|
+
actual_close_date?: string;
|
|
9489
10322
|
applies_to_part?: PartSummary;
|
|
9490
10323
|
/** The artifacts attached to the work item. */
|
|
9491
10324
|
artifacts?: ArtifactSummary[];
|
|
@@ -10082,6 +10915,10 @@ export interface WorksUpdateRequestStagedInfoStagedInfoUpdate {
|
|
|
10082
10915
|
}
|
|
10083
10916
|
/** works-update-request-tags */
|
|
10084
10917
|
export interface WorksUpdateRequestTags {
|
|
10918
|
+
/** Adds the provided tags on the work item. */
|
|
10919
|
+
add?: AddTagWithValue[];
|
|
10920
|
+
/** Removes the provided tags on the work item. */
|
|
10921
|
+
remove?: RemoveTagWithValue[];
|
|
10085
10922
|
/** Sets the provided tags on the work item. */
|
|
10086
10923
|
set?: SetTagWithValue[];
|
|
10087
10924
|
}
|
|
@@ -10112,6 +10949,11 @@ export interface WorksUpdateRequestTicket {
|
|
|
10112
10949
|
* @example "REV-AbCdEfGh"
|
|
10113
10950
|
*/
|
|
10114
10951
|
rev_org?: string | null;
|
|
10952
|
+
/**
|
|
10953
|
+
* The enum ID for the sentiment of the ticket.
|
|
10954
|
+
* @format int64
|
|
10955
|
+
*/
|
|
10956
|
+
sentiment?: number;
|
|
10115
10957
|
/** Severity of the ticket. */
|
|
10116
10958
|
severity?: TicketSeverity;
|
|
10117
10959
|
}
|
|
@@ -10815,6 +11657,85 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
10815
11657
|
* @secure
|
|
10816
11658
|
*/
|
|
10817
11659
|
codeChangesUpdate: (data: CodeChangesUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<CodeChangesUpdateResponse, any>>;
|
|
11660
|
+
/**
|
|
11661
|
+
* @description Create the content template.
|
|
11662
|
+
*
|
|
11663
|
+
* @tags notifications
|
|
11664
|
+
* @name ContentTemplateCreate
|
|
11665
|
+
* @request POST:/content-template.create
|
|
11666
|
+
* @secure
|
|
11667
|
+
*/
|
|
11668
|
+
contentTemplateCreate: (data: ContentTemplateCreateRequest, params?: RequestParams) => Promise<AxiosResponse<ContentTemplateCreateResponse, any>>;
|
|
11669
|
+
/**
|
|
11670
|
+
* @description Get the content template.
|
|
11671
|
+
*
|
|
11672
|
+
* @tags notifications
|
|
11673
|
+
* @name ContentTemplateGet
|
|
11674
|
+
* @request GET:/content-template.get
|
|
11675
|
+
* @secure
|
|
11676
|
+
*/
|
|
11677
|
+
contentTemplateGet: (query: {
|
|
11678
|
+
/** The content template's ID. */
|
|
11679
|
+
id: string;
|
|
11680
|
+
}, params?: RequestParams) => Promise<AxiosResponse<ContentTemplateGetResponse, any>>;
|
|
11681
|
+
/**
|
|
11682
|
+
* @description Get the content template.
|
|
11683
|
+
*
|
|
11684
|
+
* @tags notifications
|
|
11685
|
+
* @name ContentTemplateGetPost
|
|
11686
|
+
* @request POST:/content-template.get
|
|
11687
|
+
* @secure
|
|
11688
|
+
*/
|
|
11689
|
+
contentTemplateGetPost: (data: ContentTemplateGetRequest, params?: RequestParams) => Promise<AxiosResponse<ContentTemplateGetResponse, any>>;
|
|
11690
|
+
/**
|
|
11691
|
+
* @description Lists the content templates.
|
|
11692
|
+
*
|
|
11693
|
+
* @tags notifications
|
|
11694
|
+
* @name ContentTemplateList
|
|
11695
|
+
* @request GET:/content-template.list
|
|
11696
|
+
* @secure
|
|
11697
|
+
*/
|
|
11698
|
+
contentTemplateList: (query?: {
|
|
11699
|
+
/**
|
|
11700
|
+
* Filters for content template created by any of these users.
|
|
11701
|
+
* @example ["DEVU-12345"]
|
|
11702
|
+
*/
|
|
11703
|
+
created_by?: string[];
|
|
11704
|
+
/**
|
|
11705
|
+
* The cursor to resume iteration from. If not provided, then iteration
|
|
11706
|
+
* starts from the beginning.
|
|
11707
|
+
*/
|
|
11708
|
+
cursor?: string;
|
|
11709
|
+
/**
|
|
11710
|
+
* The maximum number of content template to return. The default is
|
|
11711
|
+
* '50'.
|
|
11712
|
+
* @format int32
|
|
11713
|
+
*/
|
|
11714
|
+
limit?: number;
|
|
11715
|
+
/**
|
|
11716
|
+
* The iteration mode to use, otherwise if not set, then "after" is
|
|
11717
|
+
* used.
|
|
11718
|
+
*/
|
|
11719
|
+
mode?: ListMode;
|
|
11720
|
+
/** Filters for content template based on name. */
|
|
11721
|
+
name?: string[];
|
|
11722
|
+
/**
|
|
11723
|
+
* Fields to sort the content template by and the direction to sort
|
|
11724
|
+
* them.
|
|
11725
|
+
*/
|
|
11726
|
+
sort_by?: string[];
|
|
11727
|
+
/** Filters for content template of the provided types. */
|
|
11728
|
+
type?: ContentTemplateType[];
|
|
11729
|
+
}, params?: RequestParams) => Promise<AxiosResponse<ContentTemplateListResponse, any>>;
|
|
11730
|
+
/**
|
|
11731
|
+
* @description Lists the content templates.
|
|
11732
|
+
*
|
|
11733
|
+
* @tags notifications
|
|
11734
|
+
* @name ContentTemplateListPost
|
|
11735
|
+
* @request POST:/content-template.list
|
|
11736
|
+
* @secure
|
|
11737
|
+
*/
|
|
11738
|
+
contentTemplateListPost: (data: ContentTemplateListRequest, params?: RequestParams) => Promise<AxiosResponse<ContentTemplateListResponse, any>>;
|
|
10818
11739
|
/**
|
|
10819
11740
|
* @description Creates a conversation.
|
|
10820
11741
|
*
|
|
@@ -11520,6 +12441,24 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
11520
12441
|
* @secure
|
|
11521
12442
|
*/
|
|
11522
12443
|
groupsUpdate: (data: GroupsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<GroupsUpdateResponse, any>>;
|
|
12444
|
+
/**
|
|
12445
|
+
* @description Creates an incident.
|
|
12446
|
+
*
|
|
12447
|
+
* @tags operate
|
|
12448
|
+
* @name IncidentsCreate
|
|
12449
|
+
* @request POST:/incidents.create
|
|
12450
|
+
* @secure
|
|
12451
|
+
*/
|
|
12452
|
+
incidentsCreate: (data: IncidentsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<IncidentsCreateResponse, any>>;
|
|
12453
|
+
/**
|
|
12454
|
+
* @description Deletes an incident.
|
|
12455
|
+
*
|
|
12456
|
+
* @tags operate
|
|
12457
|
+
* @name IncidentsDelete
|
|
12458
|
+
* @request POST:/incidents.delete
|
|
12459
|
+
* @secure
|
|
12460
|
+
*/
|
|
12461
|
+
incidentsDelete: (data: IncidentsDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
|
|
11523
12462
|
/**
|
|
11524
12463
|
* @description Gets an incident.
|
|
11525
12464
|
*
|
|
@@ -11652,6 +12591,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
11652
12591
|
* @secure
|
|
11653
12592
|
*/
|
|
11654
12593
|
incidentsListPost: (data: IncidentsListRequest, params?: RequestParams) => Promise<AxiosResponse<IncidentsListResponse, any>>;
|
|
12594
|
+
/**
|
|
12595
|
+
* @description Updates an incident.
|
|
12596
|
+
*
|
|
12597
|
+
* @tags operate
|
|
12598
|
+
* @name IncidentsUpdate
|
|
12599
|
+
* @request POST:/incidents.update
|
|
12600
|
+
* @secure
|
|
12601
|
+
*/
|
|
12602
|
+
incidentsUpdate: (data: IncidentsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<IncidentsUpdateResponse, any>>;
|
|
11655
12603
|
/**
|
|
11656
12604
|
* @description OAuth2 authorization callback.
|
|
11657
12605
|
*
|
|
@@ -12456,6 +13404,75 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
12456
13404
|
* @secure
|
|
12457
13405
|
*/
|
|
12458
13406
|
revUsersListPost: (data: RevUsersListRequest, params?: RequestParams) => Promise<AxiosResponse<RevUsersListResponse, any>>;
|
|
13407
|
+
/**
|
|
13408
|
+
* @description Scans through all Rev users.
|
|
13409
|
+
*
|
|
13410
|
+
* @tags rev-users
|
|
13411
|
+
* @name RevUsersScan
|
|
13412
|
+
* @request GET:/rev-users.scan
|
|
13413
|
+
* @secure
|
|
13414
|
+
*/
|
|
13415
|
+
revUsersScan: (query?: {
|
|
13416
|
+
/** Filters for Rev users that were created by the specified user(s). */
|
|
13417
|
+
created_by?: string[];
|
|
13418
|
+
/**
|
|
13419
|
+
* Filters for objects created after the provided timestamp (inclusive).
|
|
13420
|
+
* @format date-time
|
|
13421
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
13422
|
+
*/
|
|
13423
|
+
'created_date.after'?: string;
|
|
13424
|
+
/**
|
|
13425
|
+
* Filters for objects created before the provided timestamp
|
|
13426
|
+
* (inclusive).
|
|
13427
|
+
* @format date-time
|
|
13428
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
13429
|
+
*/
|
|
13430
|
+
'created_date.before'?: string;
|
|
13431
|
+
/**
|
|
13432
|
+
* The cursor to resume iteration, otherwise the beginning if not
|
|
13433
|
+
* provided.
|
|
13434
|
+
*/
|
|
13435
|
+
cursor?: string;
|
|
13436
|
+
/** Filters for custom fields. */
|
|
13437
|
+
custom_fields?: object;
|
|
13438
|
+
/** List of emails of Rev users to be filtered. */
|
|
13439
|
+
email?: string[];
|
|
13440
|
+
/** List of external refs to filter Rev users for. */
|
|
13441
|
+
external_ref?: string[];
|
|
13442
|
+
/** Value of is_verified field to filter the Rev users. */
|
|
13443
|
+
is_verified?: boolean;
|
|
13444
|
+
/**
|
|
13445
|
+
* Filters for objects created after the provided timestamp (inclusive).
|
|
13446
|
+
* @format date-time
|
|
13447
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
13448
|
+
*/
|
|
13449
|
+
'modified_date.after'?: string;
|
|
13450
|
+
/**
|
|
13451
|
+
* Filters for objects created before the provided timestamp
|
|
13452
|
+
* (inclusive).
|
|
13453
|
+
* @format date-time
|
|
13454
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
13455
|
+
*/
|
|
13456
|
+
'modified_date.before'?: string;
|
|
13457
|
+
/** List of phone numbers, in E.164 format, to filter Rev users on. */
|
|
13458
|
+
phone_numbers?: string[];
|
|
13459
|
+
/**
|
|
13460
|
+
* List of IDs of Rev organizations to be filtered.
|
|
13461
|
+
* @example ["REV-AbCdEfGh"]
|
|
13462
|
+
*/
|
|
13463
|
+
rev_org?: string[];
|
|
13464
|
+
/** List of tags to be filtered. */
|
|
13465
|
+
tags?: string[];
|
|
13466
|
+
}, params?: RequestParams) => Promise<AxiosResponse<RevUsersScanResponse, any>>;
|
|
13467
|
+
/**
|
|
13468
|
+
* @description Scans through all Rev users.
|
|
13469
|
+
*
|
|
13470
|
+
* @tags rev-users
|
|
13471
|
+
* @name RevUsersScanPost
|
|
13472
|
+
* @request POST:/rev-users.scan
|
|
13473
|
+
* @secure
|
|
13474
|
+
*/
|
|
13475
|
+
revUsersScanPost: (data: RevUsersScanRequest, params?: RequestParams) => Promise<AxiosResponse<RevUsersScanResponse, any>>;
|
|
12459
13476
|
/**
|
|
12460
13477
|
* @description Unlinks a rev user from a rev org.
|
|
12461
13478
|
*
|
|
@@ -12932,6 +13949,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
12932
13949
|
* @secure
|
|
12933
13950
|
*/
|
|
12934
13951
|
snapInsResourcesPost: (data: SnapInsResourcesRequest, params?: RequestParams) => Promise<AxiosResponse<SnapInsResourcesResponse, any>>;
|
|
13952
|
+
/**
|
|
13953
|
+
* @description Updates a snap-in.
|
|
13954
|
+
*
|
|
13955
|
+
* @tags snap-ins
|
|
13956
|
+
* @name SnapInsUpdate
|
|
13957
|
+
* @request POST:/snap-ins.update
|
|
13958
|
+
* @secure
|
|
13959
|
+
*/
|
|
13960
|
+
snapInsUpdate: (data: SnapInsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<SnapInsUpdateResponse, any>>;
|
|
12935
13961
|
/**
|
|
12936
13962
|
* @description Create a snap widget object.
|
|
12937
13963
|
*
|