@devrev/typescript-sdk 1.1.27 → 1.1.28
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/auto-generated/beta/beta-devrev-sdk.d.ts +163 -8
- package/dist/auto-generated/beta/beta-devrev-sdk.js +20 -2
- package/dist/auto-generated/public-devrev-sdk.d.ts +93 -5
- package/dist/auto-generated/public-devrev-sdk.js +23 -1
- package/dist/snap-ins/types.d.ts +4 -0
- package/dist/snap-ins/types.test.js +4 -0
- package/package.json +1 -1
|
@@ -42,6 +42,11 @@ export type Account = OrgBase & {
|
|
|
42
42
|
/** account-search-summary */
|
|
43
43
|
export type AccountSearchSummary = SearchSummaryBase & {
|
|
44
44
|
account: AccountSummary;
|
|
45
|
+
/**
|
|
46
|
+
* Comments on the work.
|
|
47
|
+
* @maxItems 5
|
|
48
|
+
*/
|
|
49
|
+
comments?: CommentSearchSummary[];
|
|
45
50
|
};
|
|
46
51
|
/** account-summary */
|
|
47
52
|
export type AccountSummary = OrgBaseSummary;
|
|
@@ -1166,6 +1171,14 @@ export declare enum AuthTokenSubjectTokenType {
|
|
|
1166
1171
|
export declare enum AuthTokenTokenType {
|
|
1167
1172
|
Bearer = "bearer"
|
|
1168
1173
|
}
|
|
1174
|
+
/**
|
|
1175
|
+
* auth-tokens-account-traits
|
|
1176
|
+
* Carries account info.
|
|
1177
|
+
*/
|
|
1178
|
+
export interface AuthTokensAccountTraits {
|
|
1179
|
+
/** The display name of the account. */
|
|
1180
|
+
display_name?: string;
|
|
1181
|
+
}
|
|
1169
1182
|
/**
|
|
1170
1183
|
* auth-tokens-create-request
|
|
1171
1184
|
* A request to create a new token corresponding to the requested token
|
|
@@ -1329,6 +1342,10 @@ export interface AuthTokensOrgTraits {
|
|
|
1329
1342
|
* issue a Rev session token.
|
|
1330
1343
|
*/
|
|
1331
1344
|
export interface AuthTokensRevInfo {
|
|
1345
|
+
/** An identifier which uniquely identifies an account. */
|
|
1346
|
+
account_ref?: string;
|
|
1347
|
+
/** Carries account info. */
|
|
1348
|
+
account_traits?: AuthTokensAccountTraits;
|
|
1332
1349
|
/** An identifier which uniquely identifies a Rev org. */
|
|
1333
1350
|
org_ref?: string;
|
|
1334
1351
|
/** Carries Rev org info. */
|
|
@@ -1339,6 +1356,10 @@ export interface AuthTokensRevInfo {
|
|
|
1339
1356
|
user_ref?: string;
|
|
1340
1357
|
/** Carries Rev user info. */
|
|
1341
1358
|
user_traits?: AuthTokensUserTraits;
|
|
1359
|
+
/** An identifier which uniquely identifies a workspace. */
|
|
1360
|
+
workspace_ref?: string;
|
|
1361
|
+
/** Carries Rev org info. */
|
|
1362
|
+
workspace_traits?: AuthTokensOrgTraits;
|
|
1342
1363
|
}
|
|
1343
1364
|
/**
|
|
1344
1365
|
* auth-tokens-self-delete-request
|
|
@@ -1547,6 +1568,7 @@ export type CodeChange = AtomBase & {
|
|
|
1547
1568
|
};
|
|
1548
1569
|
/** Source of the code change object. */
|
|
1549
1570
|
export declare enum CodeChangeSource {
|
|
1571
|
+
Bitbucket = "bitbucket",
|
|
1550
1572
|
Github = "github"
|
|
1551
1573
|
}
|
|
1552
1574
|
/** code-changes-create-request */
|
|
@@ -1621,6 +1643,12 @@ export interface CodeChangesUpdateRequest {
|
|
|
1621
1643
|
export interface CodeChangesUpdateResponse {
|
|
1622
1644
|
code_change: CodeChange;
|
|
1623
1645
|
}
|
|
1646
|
+
/** comment-search-summary */
|
|
1647
|
+
export interface CommentSearchSummary {
|
|
1648
|
+
comment?: TimelineCommentSummary;
|
|
1649
|
+
/** Text snippet where the search hit occurred. */
|
|
1650
|
+
snippet?: string;
|
|
1651
|
+
}
|
|
1624
1652
|
/** conversation */
|
|
1625
1653
|
export type Conversation = AtomBase & {
|
|
1626
1654
|
/** Description of the conversation object. */
|
|
@@ -1655,6 +1683,11 @@ export interface ConversationMetadata {
|
|
|
1655
1683
|
}
|
|
1656
1684
|
/** conversation-search-summary */
|
|
1657
1685
|
export type ConversationSearchSummary = SearchSummaryBase & {
|
|
1686
|
+
/**
|
|
1687
|
+
* Comments on the work.
|
|
1688
|
+
* @maxItems 5
|
|
1689
|
+
*/
|
|
1690
|
+
comments?: CommentSearchSummary[];
|
|
1658
1691
|
conversation: ConversationSummary;
|
|
1659
1692
|
};
|
|
1660
1693
|
/** conversation-summary */
|
|
@@ -1978,6 +2011,8 @@ export interface CreateEmailPreviewWidget {
|
|
|
1978
2011
|
in_reply_to?: string;
|
|
1979
2012
|
/** The list of inline attachments. */
|
|
1980
2013
|
inlines?: CreateEmailInlineAttachment[];
|
|
2014
|
+
/** Whether the email is spam. */
|
|
2015
|
+
is_spam?: boolean;
|
|
1981
2016
|
/** The message id of the email. */
|
|
1982
2017
|
message_id?: string;
|
|
1983
2018
|
/**
|
|
@@ -2049,6 +2084,12 @@ export interface CreateWeeklyOrgScheduleInterval {
|
|
|
2049
2084
|
* Static collection of Devrev objects.
|
|
2050
2085
|
*/
|
|
2051
2086
|
export type CuratedVistaSummary = VistaBaseSummary;
|
|
2087
|
+
/** custom-object-search-summary */
|
|
2088
|
+
export type CustomObjectSearchSummary = SearchSummaryBase & {
|
|
2089
|
+
custom_object: CustomObjectSummary;
|
|
2090
|
+
};
|
|
2091
|
+
/** custom-object-summary */
|
|
2092
|
+
export type CustomObjectSummary = AtomBaseSummary;
|
|
2052
2093
|
/** custom-schema-fragment */
|
|
2053
2094
|
export type CustomSchemaFragment = (AppFragment | CustomTypeFragment | TenantFragment) & {
|
|
2054
2095
|
type: CustomSchemaFragmentType;
|
|
@@ -2675,6 +2716,8 @@ export interface DevUsersGetResponse {
|
|
|
2675
2716
|
* Request to link external identity to a Dev user.
|
|
2676
2717
|
*/
|
|
2677
2718
|
export interface DevUsersIdentitiesLinkRequest {
|
|
2719
|
+
/** The ID of the Dev user to link the external identity to. */
|
|
2720
|
+
dev_user: string;
|
|
2678
2721
|
/** Display name of the Dev user in the external source. */
|
|
2679
2722
|
display_name?: string;
|
|
2680
2723
|
/** Unique ID of the Dev user in the external source. */
|
|
@@ -2694,6 +2737,8 @@ export interface DevUsersIdentitiesLinkResponse {
|
|
|
2694
2737
|
* Request to unlink an external identity from a Dev user.
|
|
2695
2738
|
*/
|
|
2696
2739
|
export interface DevUsersIdentitiesUnlinkRequest {
|
|
2740
|
+
/** The ID of the Dev user to unlink the external identity from. */
|
|
2741
|
+
dev_user: string;
|
|
2697
2742
|
/** Issuer that needs to be unlinked from a Dev user. */
|
|
2698
2743
|
issuer: string;
|
|
2699
2744
|
}
|
|
@@ -2710,6 +2755,8 @@ export interface DevUsersIdentitiesUnlinkResponse {
|
|
|
2710
2755
|
* A request to get the list of Dev user's information.
|
|
2711
2756
|
*/
|
|
2712
2757
|
export interface DevUsersListRequest {
|
|
2758
|
+
/** Provides ways to specify date ranges on objects. */
|
|
2759
|
+
created_date?: DateFilter;
|
|
2713
2760
|
/**
|
|
2714
2761
|
* The cursor to resume iteration from. If not provided, then
|
|
2715
2762
|
* iteration starts from the beginning.
|
|
@@ -2732,6 +2779,8 @@ export interface DevUsersListRequest {
|
|
|
2732
2779
|
* always be returned in the specified sort-by order.
|
|
2733
2780
|
*/
|
|
2734
2781
|
mode?: ListMode;
|
|
2782
|
+
/** Provides ways to specify date ranges on objects. */
|
|
2783
|
+
modified_date?: DateFilter;
|
|
2735
2784
|
/** Fields to sort the Dev users by and the direction to sort them. */
|
|
2736
2785
|
sort_by?: string[];
|
|
2737
2786
|
/** Filters Dev users based on state. */
|
|
@@ -2843,6 +2892,8 @@ export type EmailPreviewWidget = SnapWidgetBase & {
|
|
|
2843
2892
|
in_reply_to?: string;
|
|
2844
2893
|
/** The list of inline attachments. */
|
|
2845
2894
|
inlines: EmailInlineAttachment[];
|
|
2895
|
+
/** Whether the email is spam. */
|
|
2896
|
+
is_spam?: boolean;
|
|
2846
2897
|
/** The message id of the email. */
|
|
2847
2898
|
message_id?: string;
|
|
2848
2899
|
raw_email_artifact?: ArtifactSummary;
|
|
@@ -3110,7 +3161,7 @@ export interface Error {
|
|
|
3110
3161
|
type?: string;
|
|
3111
3162
|
}
|
|
3112
3163
|
/** error-bad-request */
|
|
3113
|
-
export type ErrorBadRequest = ErrorBase & (ErrorBadRequestArtifactAlreadyAttachedToAParent | ErrorBadRequestBadRequest | ErrorBadRequestInvalidApiVersion | ErrorBadRequestInvalidEnumValue | ErrorBadRequestInvalidField | ErrorBadRequestMissingDependency | ErrorBadRequestMissingRequiredField | ErrorBadRequestParseError | ErrorBadRequestStaleSchemaFragments | ErrorBadRequestUnexpectedJsonType | ErrorBadRequestValueNotPermitted) & {
|
|
3164
|
+
export type ErrorBadRequest = ErrorBase & (ErrorBadRequestArtifactAlreadyAttachedToAParent | ErrorBadRequestBadRequest | ErrorBadRequestInvalidApiVersion | ErrorBadRequestInvalidEnumValue | ErrorBadRequestInvalidField | ErrorBadRequestInvalidId | ErrorBadRequestMissingDependency | ErrorBadRequestMissingRequiredField | ErrorBadRequestParseError | ErrorBadRequestStaleSchemaFragments | ErrorBadRequestUnexpectedIdType | ErrorBadRequestUnexpectedJsonType | ErrorBadRequestValueNotPermitted) & {
|
|
3114
3165
|
type: ErrorBadRequestType;
|
|
3115
3166
|
};
|
|
3116
3167
|
/** error-bad-request-artifact-already-attached-to-a-parent */
|
|
@@ -3141,6 +3192,11 @@ export interface ErrorBadRequestInvalidField {
|
|
|
3141
3192
|
/** The field name that's invalid. */
|
|
3142
3193
|
field_name: string;
|
|
3143
3194
|
}
|
|
3195
|
+
/** error-bad-request-invalid-id */
|
|
3196
|
+
export interface ErrorBadRequestInvalidId {
|
|
3197
|
+
/** The field whose ID is invalid. */
|
|
3198
|
+
field_name: string;
|
|
3199
|
+
}
|
|
3144
3200
|
/** error-bad-request-missing-dependency */
|
|
3145
3201
|
export interface ErrorBadRequestMissingDependency {
|
|
3146
3202
|
/** The dependent fields. */
|
|
@@ -3183,13 +3239,20 @@ export declare enum ErrorBadRequestType {
|
|
|
3183
3239
|
InvalidApiVersion = "invalid_api_version",
|
|
3184
3240
|
InvalidEnumValue = "invalid_enum_value",
|
|
3185
3241
|
InvalidField = "invalid_field",
|
|
3242
|
+
InvalidId = "invalid_id",
|
|
3186
3243
|
MissingDependency = "missing_dependency",
|
|
3187
3244
|
MissingRequiredField = "missing_required_field",
|
|
3188
3245
|
ParseError = "parse_error",
|
|
3189
3246
|
StaleSchemaFragments = "stale_schema_fragments",
|
|
3247
|
+
UnexpectedIdType = "unexpected_id_type",
|
|
3190
3248
|
UnexpectedJsonType = "unexpected_json_type",
|
|
3191
3249
|
ValueNotPermitted = "value_not_permitted"
|
|
3192
3250
|
}
|
|
3251
|
+
/** error-bad-request-unexpected-id-type */
|
|
3252
|
+
export interface ErrorBadRequestUnexpectedIdType {
|
|
3253
|
+
/** The field whose ID type is unexpected. */
|
|
3254
|
+
field_name: string;
|
|
3255
|
+
}
|
|
3193
3256
|
/** error-bad-request-unexpected-json-type */
|
|
3194
3257
|
export interface ErrorBadRequestUnexpectedJsonType {
|
|
3195
3258
|
actual: ErrorBadRequestUnexpectedJsonTypeType;
|
|
@@ -3570,7 +3633,16 @@ export interface EventWorkUpdated {
|
|
|
3570
3633
|
* external-identity
|
|
3571
3634
|
* External identity of a user.
|
|
3572
3635
|
*/
|
|
3573
|
-
export
|
|
3636
|
+
export interface ExternalIdentity {
|
|
3637
|
+
/** Display name of the user in the external source. */
|
|
3638
|
+
display_name?: string;
|
|
3639
|
+
/** Unique ID of the user in the external source. */
|
|
3640
|
+
id?: string;
|
|
3641
|
+
/** Whether the external identity is verified or not. */
|
|
3642
|
+
is_verified?: boolean;
|
|
3643
|
+
/** Issuer of the external identity of the user. */
|
|
3644
|
+
issuer?: string;
|
|
3645
|
+
}
|
|
3574
3646
|
/** feature */
|
|
3575
3647
|
export type Feature = PartBase;
|
|
3576
3648
|
/** feature-summary */
|
|
@@ -4744,6 +4816,11 @@ export type PartBaseSummary = AtomBaseSummary & {
|
|
|
4744
4816
|
};
|
|
4745
4817
|
/** part-search-summary */
|
|
4746
4818
|
export type PartSearchSummary = SearchSummaryBase & {
|
|
4819
|
+
/**
|
|
4820
|
+
* Comments on the work.
|
|
4821
|
+
* @maxItems 5
|
|
4822
|
+
*/
|
|
4823
|
+
comments?: CommentSearchSummary[];
|
|
4747
4824
|
part: PartSummary;
|
|
4748
4825
|
};
|
|
4749
4826
|
/** part-summary */
|
|
@@ -4940,14 +5017,14 @@ export interface PartsUpdateRequestEnhancement {
|
|
|
4940
5017
|
* @format date-time
|
|
4941
5018
|
* @example "2023-01-01T12:00:00.000Z"
|
|
4942
5019
|
*/
|
|
4943
|
-
target_close_date?: string;
|
|
5020
|
+
target_close_date?: string | null;
|
|
4944
5021
|
/**
|
|
4945
5022
|
* Updates the target start date of the enhancement. Example Date
|
|
4946
5023
|
* Format: 2000-11-01T01:01:01Z
|
|
4947
5024
|
* @format date-time
|
|
4948
5025
|
* @example "2023-01-01T12:00:00.000Z"
|
|
4949
5026
|
*/
|
|
4950
|
-
target_start_date?: string;
|
|
5027
|
+
target_start_date?: string | null;
|
|
4951
5028
|
}
|
|
4952
5029
|
/** parts-update-request-feature */
|
|
4953
5030
|
export type PartsUpdateRequestFeature = object;
|
|
@@ -6351,6 +6428,7 @@ export declare enum SearchNamespace {
|
|
|
6351
6428
|
Capability = "capability",
|
|
6352
6429
|
Component = "component",
|
|
6353
6430
|
Conversation = "conversation",
|
|
6431
|
+
CustomObject = "custom_object",
|
|
6354
6432
|
CustomPart = "custom_part",
|
|
6355
6433
|
CustomWork = "custom_work",
|
|
6356
6434
|
Dashboard = "dashboard",
|
|
@@ -6377,7 +6455,7 @@ export declare enum SearchNamespace {
|
|
|
6377
6455
|
Vista = "vista"
|
|
6378
6456
|
}
|
|
6379
6457
|
/** search-result */
|
|
6380
|
-
export type SearchResult = (AccountSearchSummary | ArticleSearchSummary | ArtifactSearchSummary | ConversationSearchSummary | DashboardSearchSummary | GroupSearchSummary | LinkSearchSummary | ObjectMemberSearchSummary | OrgSearchSummary | PartSearchSummary | QuestionAnswerSearchSummary | TagSearchSummary | UserSearchSummary | VistaSearchSummary | WorkSearchSummary) & {
|
|
6458
|
+
export type SearchResult = (AccountSearchSummary | ArticleSearchSummary | ArtifactSearchSummary | ConversationSearchSummary | CustomObjectSearchSummary | DashboardSearchSummary | GroupSearchSummary | LinkSearchSummary | ObjectMemberSearchSummary | OrgSearchSummary | PartSearchSummary | QuestionAnswerSearchSummary | TagSearchSummary | UserSearchSummary | VistaSearchSummary | WorkSearchSummary) & {
|
|
6381
6459
|
type: SearchResultType;
|
|
6382
6460
|
};
|
|
6383
6461
|
export declare enum SearchResultType {
|
|
@@ -6385,6 +6463,7 @@ export declare enum SearchResultType {
|
|
|
6385
6463
|
Article = "article",
|
|
6386
6464
|
Artifact = "artifact",
|
|
6387
6465
|
Conversation = "conversation",
|
|
6466
|
+
CustomObject = "custom_object",
|
|
6388
6467
|
Dashboard = "dashboard",
|
|
6389
6468
|
Group = "group",
|
|
6390
6469
|
Link = "link",
|
|
@@ -6687,6 +6766,8 @@ export declare enum SlaStatus {
|
|
|
6687
6766
|
export type SlaSummary = AtomBaseSummary & {
|
|
6688
6767
|
/** Human-readable name. */
|
|
6689
6768
|
name: string;
|
|
6769
|
+
/** Type of the SLA. */
|
|
6770
|
+
sla_type?: SlaType;
|
|
6690
6771
|
/**
|
|
6691
6772
|
* Status determines how an item can be used. In 'draft' status an item
|
|
6692
6773
|
* can be edited but can't be used. When 'published' the item can longer
|
|
@@ -7124,28 +7205,52 @@ export interface SubtypesListResponse {
|
|
|
7124
7205
|
export type Survey = AtomBase & {
|
|
7125
7206
|
/** Description of the survey. */
|
|
7126
7207
|
description?: string;
|
|
7208
|
+
/** Text posted when introducing the survey to the responder. */
|
|
7209
|
+
introductory_text?: string;
|
|
7127
7210
|
/**
|
|
7128
7211
|
* Survey name associated with schema. This name would be unique per
|
|
7129
7212
|
* dev org.
|
|
7130
7213
|
*/
|
|
7131
7214
|
name?: string;
|
|
7215
|
+
/** Text posted after the response is collected. */
|
|
7216
|
+
response_text?: string;
|
|
7132
7217
|
/** List of all fields in the schema. */
|
|
7133
|
-
schema
|
|
7218
|
+
schema?: SchemaFieldDescriptor[];
|
|
7219
|
+
/** List of all the fields and their respective metadata in the schema. */
|
|
7220
|
+
schema_with_metadata?: SurveyFieldWithMetadata[];
|
|
7134
7221
|
};
|
|
7135
7222
|
/**
|
|
7136
7223
|
* survey-aggregation-filter
|
|
7137
7224
|
* The filter for survey aggregation.
|
|
7138
7225
|
*/
|
|
7139
7226
|
export type SurveyAggregationFilter = object;
|
|
7227
|
+
/**
|
|
7228
|
+
* survey-field-with-metadata
|
|
7229
|
+
* Field descriptors with additional metadata for surveys.
|
|
7230
|
+
*/
|
|
7231
|
+
export interface SurveyFieldWithMetadata {
|
|
7232
|
+
/** Set of field attributes. */
|
|
7233
|
+
field?: SchemaFieldDescriptor;
|
|
7234
|
+
/** Additional metadata for the input field. */
|
|
7235
|
+
metadata?: object;
|
|
7236
|
+
/** The question linked to the input field. */
|
|
7237
|
+
question?: string;
|
|
7238
|
+
}
|
|
7140
7239
|
/** survey-response */
|
|
7141
7240
|
export type SurveyResponse = AtomBase & {
|
|
7142
7241
|
/** The unique ID associated with the dispatched survey. */
|
|
7143
7242
|
dispatch_id?: string;
|
|
7243
|
+
/** Source channels on which the survey is sent. */
|
|
7244
|
+
dispatched_channels?: EnumValue[];
|
|
7144
7245
|
/** The ID of the object for which survey is taken. */
|
|
7145
7246
|
object?: string;
|
|
7146
7247
|
recipient?: UserSummary;
|
|
7147
7248
|
/** Response for the survey. */
|
|
7148
7249
|
response?: object;
|
|
7250
|
+
/** Enum Value defines the structure for an enum. */
|
|
7251
|
+
response_channel?: EnumValue;
|
|
7252
|
+
/** Enum Value defines the structure for an enum. */
|
|
7253
|
+
stage?: EnumValue;
|
|
7149
7254
|
/** The ID of the survey for which response is taken. */
|
|
7150
7255
|
survey?: string;
|
|
7151
7256
|
};
|
|
@@ -7153,10 +7258,16 @@ export type SurveyResponse = AtomBase & {
|
|
|
7153
7258
|
export interface SurveysCreateRequest {
|
|
7154
7259
|
/** Description about the survey. */
|
|
7155
7260
|
description?: string;
|
|
7261
|
+
/** Text posted when introducing the survey to the responder. */
|
|
7262
|
+
introductory_text?: string;
|
|
7156
7263
|
/** The survey's name. */
|
|
7157
7264
|
name: string;
|
|
7265
|
+
/** Text posted after the response is collected. */
|
|
7266
|
+
response_text?: string;
|
|
7158
7267
|
/** Schema for the survey. */
|
|
7159
|
-
schema
|
|
7268
|
+
schema?: FieldDescriptor[];
|
|
7269
|
+
/** The schema with metadata for the survey. */
|
|
7270
|
+
schema_with_metadata?: SurveyFieldWithMetadata[];
|
|
7160
7271
|
}
|
|
7161
7272
|
/** surveys-create-response */
|
|
7162
7273
|
export interface SurveysCreateResponse {
|
|
@@ -7650,6 +7761,8 @@ export type Ticket = WorkBase & {
|
|
|
7650
7761
|
/** Channels of the ticket. */
|
|
7651
7762
|
channels?: TicketChannels[];
|
|
7652
7763
|
group?: GroupSummary;
|
|
7764
|
+
/** Whether the ticket needs a response. */
|
|
7765
|
+
needs_response?: boolean;
|
|
7653
7766
|
rev_org?: OrgSummary;
|
|
7654
7767
|
/** Severity of the ticket. */
|
|
7655
7768
|
severity?: TicketSeverity;
|
|
@@ -8475,6 +8588,11 @@ export type UserBaseSummary = AtomBaseSummary & {
|
|
|
8475
8588
|
};
|
|
8476
8589
|
/** user-search-summary */
|
|
8477
8590
|
export type UserSearchSummary = SearchSummaryBase & {
|
|
8591
|
+
/**
|
|
8592
|
+
* Comments on the work.
|
|
8593
|
+
* @maxItems 5
|
|
8594
|
+
*/
|
|
8595
|
+
comments?: CommentSearchSummary[];
|
|
8478
8596
|
user: UserSummary;
|
|
8479
8597
|
};
|
|
8480
8598
|
/**
|
|
@@ -8509,11 +8627,43 @@ export type VistaBaseSummary = AtomBaseSummary & {
|
|
|
8509
8627
|
/** Name of the vista. */
|
|
8510
8628
|
name: string;
|
|
8511
8629
|
};
|
|
8630
|
+
/** Defines the state of the group item. */
|
|
8631
|
+
export declare enum VistaGroupItemState {
|
|
8632
|
+
Active = "active",
|
|
8633
|
+
Completed = "completed",
|
|
8634
|
+
Planned = "planned"
|
|
8635
|
+
}
|
|
8512
8636
|
/**
|
|
8513
8637
|
* vista-group-item-summary
|
|
8514
8638
|
* Vista group item.
|
|
8515
8639
|
*/
|
|
8516
|
-
export
|
|
8640
|
+
export interface VistaGroupItemSummary {
|
|
8641
|
+
/**
|
|
8642
|
+
* Timestamp when the vista ends.
|
|
8643
|
+
* @format date-time
|
|
8644
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
8645
|
+
*/
|
|
8646
|
+
end_date?: string;
|
|
8647
|
+
/** ID of the group item in don v2 format. */
|
|
8648
|
+
id: string;
|
|
8649
|
+
/** Name of the group. */
|
|
8650
|
+
name: string;
|
|
8651
|
+
/**
|
|
8652
|
+
* Timestamp when the vista starts.
|
|
8653
|
+
* @format date-time
|
|
8654
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
8655
|
+
*/
|
|
8656
|
+
start_date?: string;
|
|
8657
|
+
/** Defines the state of the group item. */
|
|
8658
|
+
state?: VistaGroupItemState;
|
|
8659
|
+
/** Type of the group object. */
|
|
8660
|
+
type: VistaGroupItemType;
|
|
8661
|
+
}
|
|
8662
|
+
/** Type of the group object. */
|
|
8663
|
+
export declare enum VistaGroupItemType {
|
|
8664
|
+
Curated = "curated",
|
|
8665
|
+
Dynamic = "dynamic"
|
|
8666
|
+
}
|
|
8517
8667
|
/** vista-search-summary */
|
|
8518
8668
|
export type VistaSearchSummary = SearchSummaryBase & {
|
|
8519
8669
|
/** Represents a collection of DevRev objects. */
|
|
@@ -8859,6 +9009,11 @@ export type WorkBaseSummary = AtomBaseSummary & {
|
|
|
8859
9009
|
};
|
|
8860
9010
|
/** work-search-summary */
|
|
8861
9011
|
export type WorkSearchSummary = SearchSummaryBase & {
|
|
9012
|
+
/**
|
|
9013
|
+
* Comments on the work.
|
|
9014
|
+
* @maxItems 5
|
|
9015
|
+
*/
|
|
9016
|
+
comments?: CommentSearchSummary[];
|
|
8862
9017
|
work: WorkSummary;
|
|
8863
9018
|
};
|
|
8864
9019
|
/** work-summary */
|
|
@@ -34,8 +34,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
|
34
34
|
};
|
|
35
35
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
36
36
|
exports.OrgEnvironment = exports.OpportunityPriority = exports.OpportunityForecastCategory = exports.MetricDefinitionStatus = exports.MetricDefinitionMetricType = exports.MetricDefinitionAppliesTo = exports.MemberType = exports.ListMode = exports.LinksDirection = exports.LinkType = exports.LinkEndpointType = exports.IssuePriority = exports.GroupedVistaFlavor = exports.GroupType = exports.GroupMemberType = exports.EventSourceStatus = 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.ArticleStatus = exports.AggregationDetailAggregationType = exports.AccessLevel = void 0;
|
|
37
|
-
exports.
|
|
38
|
-
exports.Api = exports.HttpClient = exports.ContentType = void 0;
|
|
37
|
+
exports.WebhookStatus = exports.WebhookEventType = exports.VistaType = exports.VistaGroupItemType = exports.VistaGroupItemState = exports.UserType = exports.UserState = exports.UomMetricScope = exports.UnitType = exports.TimelineEntryVisibility = exports.TimelineEntryType = exports.TimelineEntryObjectType = exports.TimelineEntriesUpdateRequestType = exports.TimelineEntriesCreateRequestType = exports.TimelineEntriesCollection = exports.TimelineCommentBodyType = 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.SearchSortOrderParam = exports.SearchSortByParam = exports.SearchResultType = exports.SearchNamespace = exports.SearchHybridNamespace = exports.SchemaFieldDescriptorFieldType = exports.SchemaFieldDescriptorArrayTypeBaseType = exports.QuestionAnswerStatus = exports.PartType = exports.OrgType = exports.OrgScheduleStatus = exports.OrgScheduleFragmentStatus = void 0;
|
|
38
|
+
exports.Api = exports.HttpClient = exports.ContentType = exports.WorkType = exports.WebhooksUpdateAction = void 0;
|
|
39
39
|
var AccessLevel;
|
|
40
40
|
(function (AccessLevel) {
|
|
41
41
|
AccessLevel["External"] = "external";
|
|
@@ -190,6 +190,7 @@ var BooleanExpressionType;
|
|
|
190
190
|
/** Source of the code change object. */
|
|
191
191
|
var CodeChangeSource;
|
|
192
192
|
(function (CodeChangeSource) {
|
|
193
|
+
CodeChangeSource["Bitbucket"] = "bitbucket";
|
|
193
194
|
CodeChangeSource["Github"] = "github";
|
|
194
195
|
})(CodeChangeSource = exports.CodeChangeSource || (exports.CodeChangeSource = {}));
|
|
195
196
|
var ConversationsCreateRequestTypeValue;
|
|
@@ -298,10 +299,12 @@ var ErrorBadRequestType;
|
|
|
298
299
|
ErrorBadRequestType["InvalidApiVersion"] = "invalid_api_version";
|
|
299
300
|
ErrorBadRequestType["InvalidEnumValue"] = "invalid_enum_value";
|
|
300
301
|
ErrorBadRequestType["InvalidField"] = "invalid_field";
|
|
302
|
+
ErrorBadRequestType["InvalidId"] = "invalid_id";
|
|
301
303
|
ErrorBadRequestType["MissingDependency"] = "missing_dependency";
|
|
302
304
|
ErrorBadRequestType["MissingRequiredField"] = "missing_required_field";
|
|
303
305
|
ErrorBadRequestType["ParseError"] = "parse_error";
|
|
304
306
|
ErrorBadRequestType["StaleSchemaFragments"] = "stale_schema_fragments";
|
|
307
|
+
ErrorBadRequestType["UnexpectedIdType"] = "unexpected_id_type";
|
|
305
308
|
ErrorBadRequestType["UnexpectedJsonType"] = "unexpected_json_type";
|
|
306
309
|
ErrorBadRequestType["ValueNotPermitted"] = "value_not_permitted";
|
|
307
310
|
})(ErrorBadRequestType = exports.ErrorBadRequestType || (exports.ErrorBadRequestType = {}));
|
|
@@ -578,6 +581,7 @@ var SearchNamespace;
|
|
|
578
581
|
SearchNamespace["Capability"] = "capability";
|
|
579
582
|
SearchNamespace["Component"] = "component";
|
|
580
583
|
SearchNamespace["Conversation"] = "conversation";
|
|
584
|
+
SearchNamespace["CustomObject"] = "custom_object";
|
|
581
585
|
SearchNamespace["CustomPart"] = "custom_part";
|
|
582
586
|
SearchNamespace["CustomWork"] = "custom_work";
|
|
583
587
|
SearchNamespace["Dashboard"] = "dashboard";
|
|
@@ -609,6 +613,7 @@ var SearchResultType;
|
|
|
609
613
|
SearchResultType["Article"] = "article";
|
|
610
614
|
SearchResultType["Artifact"] = "artifact";
|
|
611
615
|
SearchResultType["Conversation"] = "conversation";
|
|
616
|
+
SearchResultType["CustomObject"] = "custom_object";
|
|
612
617
|
SearchResultType["Dashboard"] = "dashboard";
|
|
613
618
|
SearchResultType["Group"] = "group";
|
|
614
619
|
SearchResultType["Link"] = "link";
|
|
@@ -887,6 +892,19 @@ var UserType;
|
|
|
887
892
|
UserType["ServiceAccount"] = "service_account";
|
|
888
893
|
UserType["SysUser"] = "sys_user";
|
|
889
894
|
})(UserType = exports.UserType || (exports.UserType = {}));
|
|
895
|
+
/** Defines the state of the group item. */
|
|
896
|
+
var VistaGroupItemState;
|
|
897
|
+
(function (VistaGroupItemState) {
|
|
898
|
+
VistaGroupItemState["Active"] = "active";
|
|
899
|
+
VistaGroupItemState["Completed"] = "completed";
|
|
900
|
+
VistaGroupItemState["Planned"] = "planned";
|
|
901
|
+
})(VistaGroupItemState = exports.VistaGroupItemState || (exports.VistaGroupItemState = {}));
|
|
902
|
+
/** Type of the group object. */
|
|
903
|
+
var VistaGroupItemType;
|
|
904
|
+
(function (VistaGroupItemType) {
|
|
905
|
+
VistaGroupItemType["Curated"] = "curated";
|
|
906
|
+
VistaGroupItemType["Dynamic"] = "dynamic";
|
|
907
|
+
})(VistaGroupItemType = exports.VistaGroupItemType || (exports.VistaGroupItemType = {}));
|
|
890
908
|
/** Type of vista object. */
|
|
891
909
|
var VistaType;
|
|
892
910
|
(function (VistaType) {
|
|
@@ -545,6 +545,14 @@ export declare enum AuthTokenSubjectTokenType {
|
|
|
545
545
|
export declare enum AuthTokenTokenType {
|
|
546
546
|
Bearer = "bearer"
|
|
547
547
|
}
|
|
548
|
+
/**
|
|
549
|
+
* auth-tokens-account-traits
|
|
550
|
+
* Carries account info.
|
|
551
|
+
*/
|
|
552
|
+
export interface AuthTokensAccountTraits {
|
|
553
|
+
/** The display name of the account. */
|
|
554
|
+
display_name?: string;
|
|
555
|
+
}
|
|
548
556
|
/**
|
|
549
557
|
* auth-tokens-create-request
|
|
550
558
|
* A request to create a new token corresponding to the requested token
|
|
@@ -708,6 +716,10 @@ export interface AuthTokensOrgTraits {
|
|
|
708
716
|
* issue a Rev session token.
|
|
709
717
|
*/
|
|
710
718
|
export interface AuthTokensRevInfo {
|
|
719
|
+
/** An identifier which uniquely identifies an account. */
|
|
720
|
+
account_ref?: string;
|
|
721
|
+
/** Carries account info. */
|
|
722
|
+
account_traits?: AuthTokensAccountTraits;
|
|
711
723
|
/** An identifier which uniquely identifies a Rev org. */
|
|
712
724
|
org_ref?: string;
|
|
713
725
|
/** Carries Rev org info. */
|
|
@@ -718,6 +730,10 @@ export interface AuthTokensRevInfo {
|
|
|
718
730
|
user_ref?: string;
|
|
719
731
|
/** Carries Rev user info. */
|
|
720
732
|
user_traits?: AuthTokensUserTraits;
|
|
733
|
+
/** An identifier which uniquely identifies a workspace. */
|
|
734
|
+
workspace_ref?: string;
|
|
735
|
+
/** Carries Rev org info. */
|
|
736
|
+
workspace_traits?: AuthTokensOrgTraits;
|
|
721
737
|
}
|
|
722
738
|
/**
|
|
723
739
|
* auth-tokens-self-delete-request
|
|
@@ -1048,6 +1064,8 @@ export interface DevUsersGetResponse {
|
|
|
1048
1064
|
* A request to get the list of Dev user's information.
|
|
1049
1065
|
*/
|
|
1050
1066
|
export interface DevUsersListRequest {
|
|
1067
|
+
/** Provides ways to specify date ranges on objects. */
|
|
1068
|
+
created_date?: DateFilter;
|
|
1051
1069
|
/**
|
|
1052
1070
|
* The cursor to resume iteration from. If not provided, then
|
|
1053
1071
|
* iteration starts from the beginning.
|
|
@@ -1070,6 +1088,8 @@ export interface DevUsersListRequest {
|
|
|
1070
1088
|
* always be returned in the specified sort-by order.
|
|
1071
1089
|
*/
|
|
1072
1090
|
mode?: ListMode;
|
|
1091
|
+
/** Provides ways to specify date ranges on objects. */
|
|
1092
|
+
modified_date?: DateFilter;
|
|
1073
1093
|
/** Fields to sort the Dev users by and the direction to sort them. */
|
|
1074
1094
|
sort_by?: string[];
|
|
1075
1095
|
/** Filters Dev users based on state. */
|
|
@@ -1130,7 +1150,7 @@ export interface EnumValue {
|
|
|
1130
1150
|
ordinal: number;
|
|
1131
1151
|
}
|
|
1132
1152
|
/** error-bad-request */
|
|
1133
|
-
export type ErrorBadRequest = ErrorBase & (ErrorBadRequestArtifactAlreadyAttachedToAParent | ErrorBadRequestBadRequest | ErrorBadRequestInvalidApiVersion | ErrorBadRequestInvalidEnumValue | ErrorBadRequestInvalidField | ErrorBadRequestMissingDependency | ErrorBadRequestMissingRequiredField | ErrorBadRequestParseError | ErrorBadRequestStaleSchemaFragments | ErrorBadRequestUnexpectedJsonType | ErrorBadRequestValueNotPermitted) & {
|
|
1153
|
+
export type ErrorBadRequest = ErrorBase & (ErrorBadRequestArtifactAlreadyAttachedToAParent | ErrorBadRequestBadRequest | ErrorBadRequestInvalidApiVersion | ErrorBadRequestInvalidEnumValue | ErrorBadRequestInvalidField | ErrorBadRequestInvalidId | ErrorBadRequestMissingDependency | ErrorBadRequestMissingRequiredField | ErrorBadRequestParseError | ErrorBadRequestStaleSchemaFragments | ErrorBadRequestUnexpectedIdType | ErrorBadRequestUnexpectedJsonType | ErrorBadRequestValueNotPermitted) & {
|
|
1134
1154
|
type: ErrorBadRequestType;
|
|
1135
1155
|
};
|
|
1136
1156
|
/** error-bad-request-artifact-already-attached-to-a-parent */
|
|
@@ -1161,6 +1181,11 @@ export interface ErrorBadRequestInvalidField {
|
|
|
1161
1181
|
/** The field name that's invalid. */
|
|
1162
1182
|
field_name: string;
|
|
1163
1183
|
}
|
|
1184
|
+
/** error-bad-request-invalid-id */
|
|
1185
|
+
export interface ErrorBadRequestInvalidId {
|
|
1186
|
+
/** The field whose ID is invalid. */
|
|
1187
|
+
field_name: string;
|
|
1188
|
+
}
|
|
1164
1189
|
/** error-bad-request-missing-dependency */
|
|
1165
1190
|
export interface ErrorBadRequestMissingDependency {
|
|
1166
1191
|
/** The dependent fields. */
|
|
@@ -1203,13 +1228,20 @@ export declare enum ErrorBadRequestType {
|
|
|
1203
1228
|
InvalidApiVersion = "invalid_api_version",
|
|
1204
1229
|
InvalidEnumValue = "invalid_enum_value",
|
|
1205
1230
|
InvalidField = "invalid_field",
|
|
1231
|
+
InvalidId = "invalid_id",
|
|
1206
1232
|
MissingDependency = "missing_dependency",
|
|
1207
1233
|
MissingRequiredField = "missing_required_field",
|
|
1208
1234
|
ParseError = "parse_error",
|
|
1209
1235
|
StaleSchemaFragments = "stale_schema_fragments",
|
|
1236
|
+
UnexpectedIdType = "unexpected_id_type",
|
|
1210
1237
|
UnexpectedJsonType = "unexpected_json_type",
|
|
1211
1238
|
ValueNotPermitted = "value_not_permitted"
|
|
1212
1239
|
}
|
|
1240
|
+
/** error-bad-request-unexpected-id-type */
|
|
1241
|
+
export interface ErrorBadRequestUnexpectedIdType {
|
|
1242
|
+
/** The field whose ID type is unexpected. */
|
|
1243
|
+
field_name: string;
|
|
1244
|
+
}
|
|
1213
1245
|
/** error-bad-request-unexpected-json-type */
|
|
1214
1246
|
export interface ErrorBadRequestUnexpectedJsonType {
|
|
1215
1247
|
actual: ErrorBadRequestUnexpectedJsonTypeType;
|
|
@@ -1495,7 +1527,16 @@ export interface EventWorkUpdated {
|
|
|
1495
1527
|
* external-identity
|
|
1496
1528
|
* External identity of a user.
|
|
1497
1529
|
*/
|
|
1498
|
-
export
|
|
1530
|
+
export interface ExternalIdentity {
|
|
1531
|
+
/** Display name of the user in the external source. */
|
|
1532
|
+
display_name?: string;
|
|
1533
|
+
/** Unique ID of the user in the external source. */
|
|
1534
|
+
id?: string;
|
|
1535
|
+
/** Whether the external identity is verified or not. */
|
|
1536
|
+
is_verified?: boolean;
|
|
1537
|
+
/** Issuer of the external identity of the user. */
|
|
1538
|
+
issuer?: string;
|
|
1539
|
+
}
|
|
1499
1540
|
/** feature */
|
|
1500
1541
|
export type Feature = PartBase;
|
|
1501
1542
|
/** feature-summary */
|
|
@@ -1853,14 +1894,14 @@ export interface PartsUpdateRequestEnhancement {
|
|
|
1853
1894
|
* @format date-time
|
|
1854
1895
|
* @example "2023-01-01T12:00:00.000Z"
|
|
1855
1896
|
*/
|
|
1856
|
-
target_close_date?: string;
|
|
1897
|
+
target_close_date?: string | null;
|
|
1857
1898
|
/**
|
|
1858
1899
|
* Updates the target start date of the enhancement. Example Date
|
|
1859
1900
|
* Format: 2000-11-01T01:01:01Z
|
|
1860
1901
|
* @format date-time
|
|
1861
1902
|
* @example "2023-01-01T12:00:00.000Z"
|
|
1862
1903
|
*/
|
|
1863
|
-
target_start_date?: string;
|
|
1904
|
+
target_start_date?: string | null;
|
|
1864
1905
|
}
|
|
1865
1906
|
/** parts-update-request-feature */
|
|
1866
1907
|
export type PartsUpdateRequestFeature = object;
|
|
@@ -2112,6 +2153,8 @@ export declare enum SlaStatus {
|
|
|
2112
2153
|
export type SlaSummary = AtomBaseSummary & {
|
|
2113
2154
|
/** Human-readable name. */
|
|
2114
2155
|
name: string;
|
|
2156
|
+
/** Type of the SLA. */
|
|
2157
|
+
sla_type?: SlaType;
|
|
2115
2158
|
/**
|
|
2116
2159
|
* Status determines how an item can be used. In 'draft' status an item
|
|
2117
2160
|
* can be edited but can't be used. When 'published' the item can longer
|
|
@@ -2172,6 +2215,11 @@ export interface SlaTrackersGetRequest {
|
|
|
2172
2215
|
export interface SlaTrackersGetResponse {
|
|
2173
2216
|
sla_tracker: SlaTracker;
|
|
2174
2217
|
}
|
|
2218
|
+
/** Type of the SLA. */
|
|
2219
|
+
export declare enum SlaType {
|
|
2220
|
+
External = "external",
|
|
2221
|
+
Internal = "internal"
|
|
2222
|
+
}
|
|
2175
2223
|
/** snap-widget */
|
|
2176
2224
|
export interface SnapWidget {
|
|
2177
2225
|
type: SnapWidgetType;
|
|
@@ -2223,11 +2271,17 @@ export type SurveyAggregationFilter = object;
|
|
|
2223
2271
|
export type SurveyResponse = AtomBase & {
|
|
2224
2272
|
/** The unique ID associated with the dispatched survey. */
|
|
2225
2273
|
dispatch_id?: string;
|
|
2274
|
+
/** Source channels on which the survey is sent. */
|
|
2275
|
+
dispatched_channels?: EnumValue[];
|
|
2226
2276
|
/** The ID of the object for which survey is taken. */
|
|
2227
2277
|
object?: string;
|
|
2228
2278
|
recipient?: UserSummary;
|
|
2229
2279
|
/** Response for the survey. */
|
|
2230
2280
|
response?: object;
|
|
2281
|
+
/** Enum Value defines the structure for an enum. */
|
|
2282
|
+
response_channel?: EnumValue;
|
|
2283
|
+
/** Enum Value defines the structure for an enum. */
|
|
2284
|
+
stage?: EnumValue;
|
|
2231
2285
|
/** The ID of the survey for which response is taken. */
|
|
2232
2286
|
survey?: string;
|
|
2233
2287
|
};
|
|
@@ -2445,6 +2499,8 @@ export type Ticket = WorkBase & {
|
|
|
2445
2499
|
/** Channels of the ticket. */
|
|
2446
2500
|
channels?: TicketChannels[];
|
|
2447
2501
|
group?: GroupSummary;
|
|
2502
|
+
/** Whether the ticket needs a response. */
|
|
2503
|
+
needs_response?: boolean;
|
|
2448
2504
|
rev_org?: OrgSummary;
|
|
2449
2505
|
/** Severity of the ticket. */
|
|
2450
2506
|
severity?: TicketSeverity;
|
|
@@ -2811,11 +2867,43 @@ export declare enum UserType {
|
|
|
2811
2867
|
RevUser = "rev_user",
|
|
2812
2868
|
SysUser = "sys_user"
|
|
2813
2869
|
}
|
|
2870
|
+
/** Defines the state of the group item. */
|
|
2871
|
+
export declare enum VistaGroupItemState {
|
|
2872
|
+
Active = "active",
|
|
2873
|
+
Completed = "completed",
|
|
2874
|
+
Planned = "planned"
|
|
2875
|
+
}
|
|
2814
2876
|
/**
|
|
2815
2877
|
* vista-group-item-summary
|
|
2816
2878
|
* Vista group item.
|
|
2817
2879
|
*/
|
|
2818
|
-
export
|
|
2880
|
+
export interface VistaGroupItemSummary {
|
|
2881
|
+
/**
|
|
2882
|
+
* Timestamp when the vista ends.
|
|
2883
|
+
* @format date-time
|
|
2884
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
2885
|
+
*/
|
|
2886
|
+
end_date?: string;
|
|
2887
|
+
/** ID of the group item in don v2 format. */
|
|
2888
|
+
id: string;
|
|
2889
|
+
/** Name of the group. */
|
|
2890
|
+
name: string;
|
|
2891
|
+
/**
|
|
2892
|
+
* Timestamp when the vista starts.
|
|
2893
|
+
* @format date-time
|
|
2894
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
2895
|
+
*/
|
|
2896
|
+
start_date?: string;
|
|
2897
|
+
/** Defines the state of the group item. */
|
|
2898
|
+
state?: VistaGroupItemState;
|
|
2899
|
+
/** Type of the group object. */
|
|
2900
|
+
type: VistaGroupItemType;
|
|
2901
|
+
}
|
|
2902
|
+
/** Type of the group object. */
|
|
2903
|
+
export declare enum VistaGroupItemType {
|
|
2904
|
+
Curated = "curated",
|
|
2905
|
+
Dynamic = "dynamic"
|
|
2906
|
+
}
|
|
2819
2907
|
/** webhook */
|
|
2820
2908
|
export type Webhook = AtomBase & {
|
|
2821
2909
|
/** The event types that the webhook will receive. */
|
|
@@ -33,7 +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.
|
|
36
|
+
exports.ContentType = exports.WorkType = exports.WebhooksUpdateAction = exports.WebhookStatus = exports.WebhookEventType = 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.PartType = exports.OrgType = exports.OrgScheduleStatus = exports.OrgEnvironment = exports.ListMode = exports.IssuePriority = 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 = void 0;
|
|
37
38
|
var AuthConnectionToggle;
|
|
38
39
|
(function (AuthConnectionToggle) {
|
|
39
40
|
AuthConnectionToggle["Disable"] = "disable";
|
|
@@ -146,10 +147,12 @@ var ErrorBadRequestType;
|
|
|
146
147
|
ErrorBadRequestType["InvalidApiVersion"] = "invalid_api_version";
|
|
147
148
|
ErrorBadRequestType["InvalidEnumValue"] = "invalid_enum_value";
|
|
148
149
|
ErrorBadRequestType["InvalidField"] = "invalid_field";
|
|
150
|
+
ErrorBadRequestType["InvalidId"] = "invalid_id";
|
|
149
151
|
ErrorBadRequestType["MissingDependency"] = "missing_dependency";
|
|
150
152
|
ErrorBadRequestType["MissingRequiredField"] = "missing_required_field";
|
|
151
153
|
ErrorBadRequestType["ParseError"] = "parse_error";
|
|
152
154
|
ErrorBadRequestType["StaleSchemaFragments"] = "stale_schema_fragments";
|
|
155
|
+
ErrorBadRequestType["UnexpectedIdType"] = "unexpected_id_type";
|
|
153
156
|
ErrorBadRequestType["UnexpectedJsonType"] = "unexpected_json_type";
|
|
154
157
|
ErrorBadRequestType["ValueNotPermitted"] = "value_not_permitted";
|
|
155
158
|
})(ErrorBadRequestType = exports.ErrorBadRequestType || (exports.ErrorBadRequestType = {}));
|
|
@@ -262,6 +265,12 @@ var SlaSummaryStage;
|
|
|
262
265
|
SlaSummaryStage["Running"] = "running";
|
|
263
266
|
SlaSummaryStage["Warning"] = "warning";
|
|
264
267
|
})(SlaSummaryStage = exports.SlaSummaryStage || (exports.SlaSummaryStage = {}));
|
|
268
|
+
/** Type of the SLA. */
|
|
269
|
+
var SlaType;
|
|
270
|
+
(function (SlaType) {
|
|
271
|
+
SlaType["External"] = "external";
|
|
272
|
+
SlaType["Internal"] = "internal";
|
|
273
|
+
})(SlaType = exports.SlaType || (exports.SlaType = {}));
|
|
265
274
|
/** Type of stage validation options when creating an object. */
|
|
266
275
|
var StageValidationOptionForCreate;
|
|
267
276
|
(function (StageValidationOptionForCreate) {
|
|
@@ -363,6 +372,19 @@ var UserType;
|
|
|
363
372
|
UserType["RevUser"] = "rev_user";
|
|
364
373
|
UserType["SysUser"] = "sys_user";
|
|
365
374
|
})(UserType = exports.UserType || (exports.UserType = {}));
|
|
375
|
+
/** Defines the state of the group item. */
|
|
376
|
+
var VistaGroupItemState;
|
|
377
|
+
(function (VistaGroupItemState) {
|
|
378
|
+
VistaGroupItemState["Active"] = "active";
|
|
379
|
+
VistaGroupItemState["Completed"] = "completed";
|
|
380
|
+
VistaGroupItemState["Planned"] = "planned";
|
|
381
|
+
})(VistaGroupItemState = exports.VistaGroupItemState || (exports.VistaGroupItemState = {}));
|
|
382
|
+
/** Type of the group object. */
|
|
383
|
+
var VistaGroupItemType;
|
|
384
|
+
(function (VistaGroupItemType) {
|
|
385
|
+
VistaGroupItemType["Curated"] = "curated";
|
|
386
|
+
VistaGroupItemType["Dynamic"] = "dynamic";
|
|
387
|
+
})(VistaGroupItemType = exports.VistaGroupItemType || (exports.VistaGroupItemType = {}));
|
|
366
388
|
/** The event types that the webhook will receive. */
|
|
367
389
|
var WebhookEventType;
|
|
368
390
|
(function (WebhookEventType) {
|
package/dist/snap-ins/types.d.ts
CHANGED
|
@@ -31,6 +31,10 @@ export type Context = {
|
|
|
31
31
|
* `actor_session_token`: For commands, and snap-kits, where the user is performing some action, this is the token of the user who is performing the action.
|
|
32
32
|
*/
|
|
33
33
|
secrets: Record<string, string>;
|
|
34
|
+
/**
|
|
35
|
+
* The ID of the user on whose behalf the function is being invoked.
|
|
36
|
+
*/
|
|
37
|
+
user_id?: string;
|
|
34
38
|
};
|
|
35
39
|
/**
|
|
36
40
|
* Metadata about the execution of the function.
|
|
@@ -6,6 +6,7 @@ const SOURCE_ID = 'don:integration:dvrv-us-1:devo/TEST-DEVORG:automation/0000000
|
|
|
6
6
|
const SNAP_IN_ID = 'don:integration:dvrv-us-1:devo/TEST-DEVORG:snap_in/00000000-0000-0000-0000-000000000000';
|
|
7
7
|
const SNAP_IN_VERSION_ID = 'don:integration:dvrv-us-1:devo/TEST-DEVORG:snap_in_package/00000000-0000-0000-0000-000000000000';
|
|
8
8
|
const SERVICE_ACCOUNT_ID = 'don:identity:dvrv-us-1:devo/TEST-DEVORG:svcacc/00000000-0000-0000-0000-000000000000';
|
|
9
|
+
const USER_ID = 'don:identity:dvrv-us-1:devo/TEST-DEVORG:devu/123';
|
|
9
10
|
describe('Snap-ins types', () => {
|
|
10
11
|
describe('Context', () => {
|
|
11
12
|
test('should have the required properties', () => {
|
|
@@ -16,6 +17,7 @@ describe('Snap-ins types', () => {
|
|
|
16
17
|
snap_in_version_id: SNAP_IN_VERSION_ID,
|
|
17
18
|
service_account_id: SERVICE_ACCOUNT_ID,
|
|
18
19
|
secrets: { secret1: 'value1', secret2: 'value2' },
|
|
20
|
+
user_id: USER_ID,
|
|
19
21
|
};
|
|
20
22
|
expect(context).toHaveProperty('dev_oid');
|
|
21
23
|
expect(context).toHaveProperty('source_id');
|
|
@@ -23,6 +25,7 @@ describe('Snap-ins types', () => {
|
|
|
23
25
|
expect(context).toHaveProperty('snap_in_version_id');
|
|
24
26
|
expect(context).toHaveProperty('service_account_id');
|
|
25
27
|
expect(context).toHaveProperty('secrets');
|
|
28
|
+
expect(context).toHaveProperty('user_id');
|
|
26
29
|
});
|
|
27
30
|
});
|
|
28
31
|
describe('ExecutionMetadata', () => {
|
|
@@ -60,6 +63,7 @@ describe('Snap-ins types', () => {
|
|
|
60
63
|
snap_in_version_id: SNAP_IN_VERSION_ID,
|
|
61
64
|
service_account_id: SERVICE_ACCOUNT_ID,
|
|
62
65
|
secrets: { secret1: 'value1', secret2: 'value2' },
|
|
66
|
+
user_id: USER_ID,
|
|
63
67
|
},
|
|
64
68
|
execution_metadata: {
|
|
65
69
|
request_id: 'request-123',
|