@devrev/typescript-sdk 1.1.62 → 1.1.64
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.
|
@@ -30,6 +30,7 @@ export type Account = OrgBase & {
|
|
|
30
30
|
external_refs?: string[];
|
|
31
31
|
/** List of Dev user IDs owning this Account. */
|
|
32
32
|
owned_by: UserSummary[];
|
|
33
|
+
primary_account?: AccountSummary;
|
|
33
34
|
/**
|
|
34
35
|
* Stock schema fragment.
|
|
35
36
|
* @format id
|
|
@@ -432,15 +433,64 @@ export interface AddTagWithValue {
|
|
|
432
433
|
* List of custom fields from multiple source fragments.
|
|
433
434
|
*/
|
|
434
435
|
export interface AggregatedSchema {
|
|
436
|
+
/**
|
|
437
|
+
* Apps corresponding to the app fragments used to populate the same
|
|
438
|
+
* in the object.
|
|
439
|
+
*/
|
|
440
|
+
apps?: string[];
|
|
435
441
|
/** The conditions associated with the fields. */
|
|
436
442
|
conditions?: CustomSchemaFragmentCondition[];
|
|
437
|
-
/**
|
|
443
|
+
/** List of all composite schemas used by custom fields. */
|
|
444
|
+
custom_composite_schemas: CompositeSchema[];
|
|
445
|
+
/** List of all custom fields in this schema. */
|
|
446
|
+
custom_fields: SchemaFieldDescriptor[];
|
|
447
|
+
/**
|
|
448
|
+
* Description of the schema.
|
|
449
|
+
* @format text
|
|
450
|
+
*/
|
|
451
|
+
description?: string;
|
|
452
|
+
/**
|
|
453
|
+
* True when the fragments being aggregated correspond to a custom
|
|
454
|
+
* leaf type.
|
|
455
|
+
*/
|
|
456
|
+
is_custom_leaf_type?: boolean;
|
|
457
|
+
/**
|
|
458
|
+
* Leaf type of the fragments being aggregated.
|
|
459
|
+
* @format text
|
|
460
|
+
*/
|
|
461
|
+
leaf_type?: string;
|
|
462
|
+
stage_diagram_id?: StageDiagramSummary;
|
|
463
|
+
/** List of all composite schemas used by stock fields. */
|
|
464
|
+
stock_composite_schemas: CompositeSchema[];
|
|
465
|
+
/**
|
|
466
|
+
* Optional overrides for properties of stock fields. Overrides in the
|
|
467
|
+
* custom type fragment take precedence over those defined in the
|
|
468
|
+
* tenant fragment.
|
|
469
|
+
*/
|
|
438
470
|
stock_field_overrides?: StockFieldOverride[];
|
|
471
|
+
/** List of all stock fields in this schema. */
|
|
472
|
+
stock_fields: SchemaFieldDescriptor[];
|
|
473
|
+
/**
|
|
474
|
+
* Subtype corresponding to the custom type fragment used to populate
|
|
475
|
+
* the same in the object.
|
|
476
|
+
* @format text
|
|
477
|
+
*/
|
|
478
|
+
subtype?: string;
|
|
479
|
+
/**
|
|
480
|
+
* Display name of the subtype.
|
|
481
|
+
* @format text
|
|
482
|
+
*/
|
|
483
|
+
subtype_display_name?: string;
|
|
484
|
+
/**
|
|
485
|
+
* Name of the schema.
|
|
486
|
+
* @format text
|
|
487
|
+
*/
|
|
488
|
+
title?: string;
|
|
439
489
|
}
|
|
440
490
|
/** aggregated-schema-get-request */
|
|
441
491
|
export interface AggregatedSchemaGetRequest {
|
|
442
|
-
/** The
|
|
443
|
-
|
|
492
|
+
/** The custom schema fragment IDs which are to be aggregated. */
|
|
493
|
+
custom_schema_fragments?: string[];
|
|
444
494
|
/** Custom schemas described using identifiers */
|
|
445
495
|
custom_schema_spec?: CustomSchemaSpecForRead;
|
|
446
496
|
/** Whether the leaf type corresponds to a custom object. */
|
|
@@ -451,13 +501,11 @@ export interface AggregatedSchemaGetRequest {
|
|
|
451
501
|
* @format text
|
|
452
502
|
*/
|
|
453
503
|
leaf_type?: string;
|
|
454
|
-
/** Per object schema, if associated with the leaf type. */
|
|
455
|
-
per_object_schema?: FieldDescriptor[];
|
|
456
504
|
/**
|
|
457
505
|
* The stock schema fragment which is to be aggregated.
|
|
458
506
|
* @format id
|
|
459
507
|
*/
|
|
460
|
-
|
|
508
|
+
stock_schema_fragment?: string;
|
|
461
509
|
}
|
|
462
510
|
/** aggregated-schema-get-response */
|
|
463
511
|
export interface AggregatedSchemaGetResponse {
|
|
@@ -855,6 +903,22 @@ export type AppFragment = CustomSchemaFragmentBase & {
|
|
|
855
903
|
};
|
|
856
904
|
/** app-fragment-summary */
|
|
857
905
|
export type AppFragmentSummary = CustomSchemaFragmentBaseSummary;
|
|
906
|
+
/**
|
|
907
|
+
* applies-to-part-filter
|
|
908
|
+
* The filter for applies to part.
|
|
909
|
+
*/
|
|
910
|
+
export interface AppliesToPartFilter {
|
|
911
|
+
/**
|
|
912
|
+
* Whether to include items belonging to children of any of the
|
|
913
|
+
* provided parts.
|
|
914
|
+
*/
|
|
915
|
+
include_child_parts?: boolean;
|
|
916
|
+
/**
|
|
917
|
+
* Part IDs to filter on.
|
|
918
|
+
* @example ["PROD-12345"]
|
|
919
|
+
*/
|
|
920
|
+
parts: string[];
|
|
921
|
+
}
|
|
858
922
|
/**
|
|
859
923
|
* archetype-metric-target
|
|
860
924
|
* Metric with corresponding target values.
|
|
@@ -1101,6 +1165,8 @@ export interface ArticlesCountRequest {
|
|
|
1101
1165
|
* @example ["DEVU-12345"]
|
|
1102
1166
|
*/
|
|
1103
1167
|
owned_by?: string[];
|
|
1168
|
+
/** Filters for articles with the provided parent directories. */
|
|
1169
|
+
parent?: string[];
|
|
1104
1170
|
/** Filter for the scope of the articles. */
|
|
1105
1171
|
scope?: number[];
|
|
1106
1172
|
/** Filter for articles based on intended audience. */
|
|
@@ -1267,12 +1333,6 @@ export type ArticlesDeleteResponse = object;
|
|
|
1267
1333
|
* The request to get an article.
|
|
1268
1334
|
*/
|
|
1269
1335
|
export interface ArticlesGetRequest {
|
|
1270
|
-
/**
|
|
1271
|
-
* Optional Dev Org ID for the unauthenticated user.
|
|
1272
|
-
* @format id
|
|
1273
|
-
* @example "DEV-AbCdEfGh"
|
|
1274
|
-
*/
|
|
1275
|
-
dev_org?: string;
|
|
1276
1336
|
/**
|
|
1277
1337
|
* The ID of the required article.
|
|
1278
1338
|
* @format id
|
|
@@ -1320,12 +1380,6 @@ export interface ArticlesListRequest {
|
|
|
1320
1380
|
* @format text
|
|
1321
1381
|
*/
|
|
1322
1382
|
cursor?: string;
|
|
1323
|
-
/**
|
|
1324
|
-
* Optional Dev Org ID for the unauthenticated user.
|
|
1325
|
-
* @format id
|
|
1326
|
-
* @example "DEV-AbCdEfGh"
|
|
1327
|
-
*/
|
|
1328
|
-
dev_org?: string;
|
|
1329
1383
|
/**
|
|
1330
1384
|
* The maximum number of articles to return. The default is '50'.
|
|
1331
1385
|
* @format int32
|
|
@@ -1349,6 +1403,8 @@ export interface ArticlesListRequest {
|
|
|
1349
1403
|
* @example ["DEVU-12345"]
|
|
1350
1404
|
*/
|
|
1351
1405
|
owned_by?: string[];
|
|
1406
|
+
/** Filters for articles with the provided parent directories. */
|
|
1407
|
+
parent?: string[];
|
|
1352
1408
|
/** Filter for the scope of the articles. */
|
|
1353
1409
|
scope?: number[];
|
|
1354
1410
|
/** Filter for articles based on intended audience. */
|
|
@@ -1843,7 +1899,7 @@ export declare enum AssociatedToType {
|
|
|
1843
1899
|
RevOrg = "rev_org"
|
|
1844
1900
|
}
|
|
1845
1901
|
/** atom */
|
|
1846
|
-
export type Atom = (Account | AppFragment | AuthToken | Capability | CodeChange | Command | Conversation | CustomObject | CustomTypeFragment | DevOrg | DevUser | Dm | Engagement | Enhancement | Feature | Group | Incident | Issue | Link | Linkable | Meeting | ObjectMember | Opportunity | Product | QuestionAnswer | RevOrg | RevUser | Runnable | ServiceAccount | Sla | SlaTracker | SnapIn | SnapInVersion | SysUser | Tag | Task | TenantFragment | Ticket | TimelineChangeEvent | TimelineComment | Uom | UserPreferences | Webhook | Widget) & {
|
|
1902
|
+
export type Atom = (Account | AppFragment | Article | AuthToken | Capability | CodeChange | Command | Conversation | CustomObject | CustomTypeFragment | DevOrg | DevUser | Dm | Engagement | Enhancement | Feature | Group | Incident | Issue | Link | Linkable | Meeting | NotificationContentTemplate | ObjectMember | Opportunity | Product | QuestionAnswer | RevOrg | RevUser | Runnable | ServiceAccount | Sla | SlaTracker | SnapIn | SnapInVersion | SysUser | Tag | Task | TenantFragment | Ticket | TimelineChangeEvent | TimelineComment | Uom | UserPreferences | Webhook | Widget) & {
|
|
1847
1903
|
type: AtomType;
|
|
1848
1904
|
};
|
|
1849
1905
|
/** atom-base */
|
|
@@ -1887,12 +1943,13 @@ export interface AtomBaseSummary {
|
|
|
1887
1943
|
id: string;
|
|
1888
1944
|
}
|
|
1889
1945
|
/** atom-summary */
|
|
1890
|
-
export type AtomSummary = (AccountSummary | AppFragmentSummary | AuthTokenSummary | CapabilitySummary | CodeChangeSummary | CommandSummary | ConversationSummary | CustomObjectSummary | CustomTypeFragmentSummary | DevOrgSummary | DevUserSummary | DmSummary | EngagementSummary | EnhancementSummary | FeatureSummary | GroupSummary | IncidentSummary | IssueSummary | LinkSummary | LinkableSummary | MeetingSummary | ObjectMemberSummary | OpportunitySummary | ProductSummary | QuestionAnswerSummary | RevOrgSummary | RevUserSummary | RunnableSummary | ServiceAccountSummary | SlaSummary | SlaTrackerSummary | SnapInSummary | SnapInVersionSummary | SysUserSummary | TagSummary | TaskSummary | TenantFragmentSummary | TicketSummary | TimelineChangeEventSummary | TimelineCommentSummary | UomSummary | UserPreferencesSummary | WebhookSummary | WidgetSummary) & {
|
|
1946
|
+
export type AtomSummary = (AccountSummary | AppFragmentSummary | ArticleSummary | AuthTokenSummary | CapabilitySummary | CodeChangeSummary | CommandSummary | ConversationSummary | CustomObjectSummary | CustomTypeFragmentSummary | DevOrgSummary | DevUserSummary | DmSummary | EngagementSummary | EnhancementSummary | FeatureSummary | GroupSummary | IncidentSummary | IssueSummary | LinkSummary | LinkableSummary | MeetingSummary | NotificationContentTemplateSummary | ObjectMemberSummary | OpportunitySummary | ProductSummary | QuestionAnswerSummary | RevOrgSummary | RevUserSummary | RunnableSummary | ServiceAccountSummary | SlaSummary | SlaTrackerSummary | SnapInSummary | SnapInVersionSummary | SysUserSummary | TagSummary | TaskSummary | TenantFragmentSummary | TicketSummary | TimelineChangeEventSummary | TimelineCommentSummary | UomSummary | UserPreferencesSummary | WebhookSummary | WidgetSummary) & {
|
|
1891
1947
|
type: AtomType;
|
|
1892
1948
|
};
|
|
1893
1949
|
export declare enum AtomType {
|
|
1894
1950
|
Account = "account",
|
|
1895
1951
|
AppFragment = "app_fragment",
|
|
1952
|
+
Article = "article",
|
|
1896
1953
|
AuthToken = "auth_token",
|
|
1897
1954
|
Capability = "capability",
|
|
1898
1955
|
CodeChange = "code_change",
|
|
@@ -1912,6 +1969,7 @@ export declare enum AtomType {
|
|
|
1912
1969
|
Link = "link",
|
|
1913
1970
|
Linkable = "linkable",
|
|
1914
1971
|
Meeting = "meeting",
|
|
1972
|
+
NotificationContentTemplate = "notification_content_template",
|
|
1915
1973
|
ObjectMember = "object_member",
|
|
1916
1974
|
Opportunity = "opportunity",
|
|
1917
1975
|
Product = "product",
|
|
@@ -2181,6 +2239,8 @@ export declare enum AuthTokenTokenType {
|
|
|
2181
2239
|
* Carries account info.
|
|
2182
2240
|
*/
|
|
2183
2241
|
export interface AuthTokensAccountTraits {
|
|
2242
|
+
/** Application-defined custom fields of the account. */
|
|
2243
|
+
custom_fields?: object;
|
|
2184
2244
|
/**
|
|
2185
2245
|
* The display name of the account.
|
|
2186
2246
|
* @format text
|
|
@@ -2830,6 +2890,13 @@ export interface BrandsUpdateResponse {
|
|
|
2830
2890
|
export type Capability = PartBase;
|
|
2831
2891
|
/** capability-summary */
|
|
2832
2892
|
export type CapabilitySummary = PartBaseSummary;
|
|
2893
|
+
/** The operator used to compare the key and the value. */
|
|
2894
|
+
export declare enum CaveatOperator {
|
|
2895
|
+
Eq = "eq",
|
|
2896
|
+
In = "in",
|
|
2897
|
+
Intersects = "intersects",
|
|
2898
|
+
NotEq = "not_eq"
|
|
2899
|
+
}
|
|
2833
2900
|
/** chat */
|
|
2834
2901
|
export type Chat = Dm & {
|
|
2835
2902
|
type: ChatType;
|
|
@@ -3217,6 +3284,12 @@ export interface ClientOverride {
|
|
|
3217
3284
|
* @format text
|
|
3218
3285
|
*/
|
|
3219
3286
|
client_name?: string;
|
|
3287
|
+
/**
|
|
3288
|
+
* Number of decimal places to show. Only applicable for number
|
|
3289
|
+
* fields.
|
|
3290
|
+
* @format int32
|
|
3291
|
+
*/
|
|
3292
|
+
decimal_places?: number;
|
|
3220
3293
|
/**
|
|
3221
3294
|
* The display name of the field.
|
|
3222
3295
|
* @format text
|
|
@@ -3228,6 +3301,11 @@ export interface ClientOverride {
|
|
|
3228
3301
|
is_hidden?: boolean;
|
|
3229
3302
|
/** Whether the field is mandatory. */
|
|
3230
3303
|
is_required?: boolean;
|
|
3304
|
+
/**
|
|
3305
|
+
* Relative order in which the field is shown.
|
|
3306
|
+
* @format int32
|
|
3307
|
+
*/
|
|
3308
|
+
order?: number;
|
|
3231
3309
|
/**
|
|
3232
3310
|
* A placeholder for the field.
|
|
3233
3311
|
* @format text
|
|
@@ -3238,6 +3316,11 @@ export interface ClientOverride {
|
|
|
3238
3316
|
* @format text
|
|
3239
3317
|
*/
|
|
3240
3318
|
tooltip?: string;
|
|
3319
|
+
/**
|
|
3320
|
+
* Whether to use shorthand notation. Example, 1K instead of 1000.
|
|
3321
|
+
* Only applicable for number fields.
|
|
3322
|
+
*/
|
|
3323
|
+
use_shorthand_notation?: boolean;
|
|
3241
3324
|
/** The view overrides for the client. */
|
|
3242
3325
|
view_overrides?: ViewOverride[];
|
|
3243
3326
|
}
|
|
@@ -3472,6 +3555,8 @@ export interface ColumnWidgetVisualization {
|
|
|
3472
3555
|
}
|
|
3473
3556
|
/** command */
|
|
3474
3557
|
export type Command = AtomBase & {
|
|
3558
|
+
/** Action defines some logic to run. */
|
|
3559
|
+
action?: CommandAction;
|
|
3475
3560
|
/**
|
|
3476
3561
|
* Description of the command.
|
|
3477
3562
|
* @format text
|
|
@@ -3497,6 +3582,7 @@ export type Command = AtomBase & {
|
|
|
3497
3582
|
* shared.
|
|
3498
3583
|
*/
|
|
3499
3584
|
shared_with?: SharedWithMembership[];
|
|
3585
|
+
source?: SnapInSummary;
|
|
3500
3586
|
/** Status of the command. */
|
|
3501
3587
|
status?: CommandStatus;
|
|
3502
3588
|
/** Surfaces where this command can be invoked. */
|
|
@@ -3508,6 +3594,26 @@ export type Command = AtomBase & {
|
|
|
3508
3594
|
*/
|
|
3509
3595
|
usage_hint?: string;
|
|
3510
3596
|
};
|
|
3597
|
+
/**
|
|
3598
|
+
* command-action
|
|
3599
|
+
* Action defines some logic to run.
|
|
3600
|
+
*/
|
|
3601
|
+
export interface CommandAction {
|
|
3602
|
+
/**
|
|
3603
|
+
* The raw code to execute, defined in the language specified by
|
|
3604
|
+
* executor.
|
|
3605
|
+
* @format text
|
|
3606
|
+
*/
|
|
3607
|
+
code?: string;
|
|
3608
|
+
/** Specifies how the action is defined. */
|
|
3609
|
+
executor_type?: CommandActionExecutorType;
|
|
3610
|
+
/**
|
|
3611
|
+
* The message to populate in discussion box, when the command is
|
|
3612
|
+
* selected to execute.
|
|
3613
|
+
* @format text
|
|
3614
|
+
*/
|
|
3615
|
+
message?: string;
|
|
3616
|
+
}
|
|
3511
3617
|
/** Specifies how the action is defined. */
|
|
3512
3618
|
export declare enum CommandActionExecutorType {
|
|
3513
3619
|
Rego = "rego",
|
|
@@ -3765,10 +3871,32 @@ export interface CommentSearchSummary {
|
|
|
3765
3871
|
*/
|
|
3766
3872
|
snippet?: string;
|
|
3767
3873
|
}
|
|
3874
|
+
/**
|
|
3875
|
+
* composite-schema
|
|
3876
|
+
* The schema of a composite type.
|
|
3877
|
+
*/
|
|
3878
|
+
export interface CompositeSchema {
|
|
3879
|
+
/**
|
|
3880
|
+
* Description of this composite type.
|
|
3881
|
+
* @format text
|
|
3882
|
+
*/
|
|
3883
|
+
description?: string;
|
|
3884
|
+
/** List of all fields in this schema. */
|
|
3885
|
+
fields: SchemaFieldDescriptor[];
|
|
3886
|
+
/**
|
|
3887
|
+
* Name of this composite type.
|
|
3888
|
+
* @format text
|
|
3889
|
+
*/
|
|
3890
|
+
name?: string;
|
|
3891
|
+
}
|
|
3768
3892
|
/** content-template */
|
|
3769
|
-
export
|
|
3893
|
+
export type ContentTemplate = NotificationContentTemplate & {
|
|
3770
3894
|
type: ContentTemplateType;
|
|
3771
|
-
}
|
|
3895
|
+
};
|
|
3896
|
+
/** content-template-base */
|
|
3897
|
+
export type ContentTemplateBase = AtomBase;
|
|
3898
|
+
/** content-template-base-summary */
|
|
3899
|
+
export type ContentTemplateBaseSummary = AtomBaseSummary;
|
|
3772
3900
|
/**
|
|
3773
3901
|
* content-template-create-request
|
|
3774
3902
|
* The request to create a new content template.
|
|
@@ -3895,7 +4023,9 @@ export interface ContentTemplateListResponse {
|
|
|
3895
4023
|
*/
|
|
3896
4024
|
prev_cursor?: string;
|
|
3897
4025
|
}
|
|
3898
|
-
export
|
|
4026
|
+
export declare enum ContentTemplateType {
|
|
4027
|
+
NotificationContentTemplate = "notification_content_template"
|
|
4028
|
+
}
|
|
3899
4029
|
/** conversation */
|
|
3900
4030
|
export type Conversation = AtomBase & {
|
|
3901
4031
|
/**
|
|
@@ -3930,6 +4060,12 @@ export type Conversation = AtomBase & {
|
|
|
3930
4060
|
/** SLA summary for the object. */
|
|
3931
4061
|
sla_summary?: ArchetypeSlaSummary;
|
|
3932
4062
|
sla_tracker?: SlaTrackerSummary;
|
|
4063
|
+
/**
|
|
4064
|
+
* Source channel for the conversation.
|
|
4065
|
+
* @format text
|
|
4066
|
+
*/
|
|
4067
|
+
source_channel?: string;
|
|
4068
|
+
source_channel_v2?: ExternalCommunicationChannelSummary;
|
|
3933
4069
|
/** Describes the current stage of a work item. */
|
|
3934
4070
|
stage?: LegacyStage;
|
|
3935
4071
|
/**
|
|
@@ -4035,6 +4171,11 @@ export interface ConversationsCreateRequest {
|
|
|
4035
4171
|
* @format text
|
|
4036
4172
|
*/
|
|
4037
4173
|
source_channel?: string;
|
|
4174
|
+
/**
|
|
4175
|
+
* Source channel ID of the conversation.
|
|
4176
|
+
* @format id
|
|
4177
|
+
*/
|
|
4178
|
+
source_channel_v2?: string;
|
|
4038
4179
|
/** Sets an object's initial stage. */
|
|
4039
4180
|
stage?: StageInit;
|
|
4040
4181
|
/** Tags associated with the conversation. */
|
|
@@ -4151,6 +4292,11 @@ export interface ConversationsExportRequest {
|
|
|
4151
4292
|
sla_summary?: SlaSummaryFilter;
|
|
4152
4293
|
/** Filters for conversations with any of the provided source channels. */
|
|
4153
4294
|
source_channel?: string[];
|
|
4295
|
+
/**
|
|
4296
|
+
* Filters for conversations that are associated with the source
|
|
4297
|
+
* channel.
|
|
4298
|
+
*/
|
|
4299
|
+
source_channel_v2?: string[];
|
|
4154
4300
|
/**
|
|
4155
4301
|
* Filters for conversations with any of the provided source channels.
|
|
4156
4302
|
* @deprecated
|
|
@@ -4270,6 +4416,11 @@ export interface ConversationsListRequest {
|
|
|
4270
4416
|
sla_summary?: SlaSummaryFilter;
|
|
4271
4417
|
/** Filters for conversations with any of the provided source channels. */
|
|
4272
4418
|
source_channel?: string[];
|
|
4419
|
+
/**
|
|
4420
|
+
* Filters for conversations that are associated with the source
|
|
4421
|
+
* channel.
|
|
4422
|
+
*/
|
|
4423
|
+
source_channel_v2?: string[];
|
|
4273
4424
|
/**
|
|
4274
4425
|
* Filters for conversations with any of the provided source channels.
|
|
4275
4426
|
* @deprecated
|
|
@@ -4355,6 +4506,11 @@ export interface ConversationsUpdateRequest {
|
|
|
4355
4506
|
members?: ConversationsUpdateRequestMembers;
|
|
4356
4507
|
metadata?: ConversationsUpdateRequestMetadata;
|
|
4357
4508
|
owned_by?: ConversationsUpdateRequestOwnedBy;
|
|
4509
|
+
/**
|
|
4510
|
+
* Source channel ID of the conversation.
|
|
4511
|
+
* @format id
|
|
4512
|
+
*/
|
|
4513
|
+
source_channel_v2?: string;
|
|
4358
4514
|
/** Updates an object's stage. */
|
|
4359
4515
|
stage?: StageUpdate;
|
|
4360
4516
|
/**
|
|
@@ -4425,6 +4581,19 @@ export interface ConversationsUpdateRequestUserSessions {
|
|
|
4425
4581
|
export interface ConversationsUpdateResponse {
|
|
4426
4582
|
conversation: Conversation;
|
|
4427
4583
|
}
|
|
4584
|
+
/**
|
|
4585
|
+
* conversations-vista-group-item
|
|
4586
|
+
* Represents a nested conversations vista group object.
|
|
4587
|
+
*/
|
|
4588
|
+
export type ConversationsVistaGroupItem = VistaGroupBase & {
|
|
4589
|
+
/** Type of conversations vista group item. */
|
|
4590
|
+
type: ConversationsVistaGroupItemType;
|
|
4591
|
+
};
|
|
4592
|
+
/** Type of conversations vista group item. */
|
|
4593
|
+
export declare enum ConversationsVistaGroupItemType {
|
|
4594
|
+
Curated = "curated",
|
|
4595
|
+
Dynamic = "dynamic"
|
|
4596
|
+
}
|
|
4428
4597
|
/**
|
|
4429
4598
|
* create-association
|
|
4430
4599
|
* Association of Rev users with Rev orgs or accounts. A Rev user can be
|
|
@@ -4829,9 +4998,17 @@ export interface CreateWeeklyOrgScheduleInterval {
|
|
|
4829
4998
|
*/
|
|
4830
4999
|
to: number;
|
|
4831
5000
|
}
|
|
5001
|
+
/**
|
|
5002
|
+
* curated-vista
|
|
5003
|
+
* Static collection of DevRev objects.
|
|
5004
|
+
*/
|
|
5005
|
+
export type CuratedVista = VistaBase & {
|
|
5006
|
+
/** Item list to store a curated list of DevRev objects. */
|
|
5007
|
+
items?: AtomSummary[];
|
|
5008
|
+
};
|
|
4832
5009
|
/**
|
|
4833
5010
|
* curated-vista-summary
|
|
4834
|
-
* Static collection of
|
|
5011
|
+
* Static collection of DevRev objects.
|
|
4835
5012
|
*/
|
|
4836
5013
|
export type CuratedVistaSummary = VistaBaseSummary;
|
|
4837
5014
|
/**
|
|
@@ -5056,6 +5233,13 @@ export type CustomObject = AtomBase & {
|
|
|
5056
5233
|
* @example ["don:core:dvrv-us-1:devo/example:custom_type_fragment/custom-type-fragment-id"]
|
|
5057
5234
|
*/
|
|
5058
5235
|
custom_schema_fragments?: string[];
|
|
5236
|
+
/**
|
|
5237
|
+
* Type of the object.
|
|
5238
|
+
* @format text
|
|
5239
|
+
*/
|
|
5240
|
+
leaf_type?: string;
|
|
5241
|
+
/** Describes the current stage of a object. */
|
|
5242
|
+
stage?: Stage;
|
|
5059
5243
|
/**
|
|
5060
5244
|
* Stock schema fragment.
|
|
5061
5245
|
* @format id
|
|
@@ -5069,6 +5253,18 @@ export type CustomObject = AtomBase & {
|
|
|
5069
5253
|
subtype?: string;
|
|
5070
5254
|
/** Sync information for records synced into/from DevRev. */
|
|
5071
5255
|
sync_metadata?: SyncMetadata;
|
|
5256
|
+
/**
|
|
5257
|
+
* Title of the object.
|
|
5258
|
+
* @format text
|
|
5259
|
+
*/
|
|
5260
|
+
title?: string;
|
|
5261
|
+
/**
|
|
5262
|
+
* A unique key that, if provided, ensures the combination of
|
|
5263
|
+
* {leaf_type, unique_key} is distinct across all objects in the
|
|
5264
|
+
* system.
|
|
5265
|
+
* @format text
|
|
5266
|
+
*/
|
|
5267
|
+
unique_key?: string;
|
|
5072
5268
|
};
|
|
5073
5269
|
/** custom-object-search-summary */
|
|
5074
5270
|
export type CustomObjectSearchSummary = SearchSummaryBase & {
|
|
@@ -5078,6 +5274,11 @@ export type CustomObjectSearchSummary = SearchSummaryBase & {
|
|
|
5078
5274
|
export type CustomObjectSummary = AtomBaseSummary & {
|
|
5079
5275
|
/** Sync information for records synced into/from DevRev. */
|
|
5080
5276
|
sync_metadata?: SyncMetadataSummary;
|
|
5277
|
+
/**
|
|
5278
|
+
* Title of the object.
|
|
5279
|
+
* @format text
|
|
5280
|
+
*/
|
|
5281
|
+
title?: string;
|
|
5081
5282
|
};
|
|
5082
5283
|
/** custom-objects-count-request */
|
|
5083
5284
|
export interface CustomObjectsCountRequest {
|
|
@@ -5135,7 +5336,7 @@ export interface CustomObjectsCreateRequest {
|
|
|
5135
5336
|
* external reference to another object.
|
|
5136
5337
|
* @format text
|
|
5137
5338
|
*/
|
|
5138
|
-
unique_key
|
|
5339
|
+
unique_key?: string;
|
|
5139
5340
|
}
|
|
5140
5341
|
/** custom-objects-create-response */
|
|
5141
5342
|
export interface CustomObjectsCreateResponse {
|
|
@@ -5261,6 +5462,8 @@ export type CustomSchemaFragment = (AppFragment | CustomTypeFragment | TenantFra
|
|
|
5261
5462
|
};
|
|
5262
5463
|
/** custom-schema-fragment-base */
|
|
5263
5464
|
export type CustomSchemaFragmentBase = AtomBase & {
|
|
5465
|
+
/** List of composite schemas. */
|
|
5466
|
+
composite_schemas?: CompositeSchema[];
|
|
5264
5467
|
/** The conditions associated with the fields. */
|
|
5265
5468
|
conditions?: CustomSchemaFragmentCondition[];
|
|
5266
5469
|
/**
|
|
@@ -5278,6 +5481,8 @@ export type CustomSchemaFragmentBase = AtomBase & {
|
|
|
5278
5481
|
fields?: SchemaFieldDescriptor[];
|
|
5279
5482
|
/** Type of the custom schema fragment. */
|
|
5280
5483
|
fragment_type?: CustomSchemaFragmentFragmentType;
|
|
5484
|
+
/** Indicates if the leaf type corresponds to a custom object. */
|
|
5485
|
+
is_custom_leaf_type?: boolean;
|
|
5281
5486
|
/**
|
|
5282
5487
|
* Indicates if the fragment is deprecated. Modifications to this
|
|
5283
5488
|
* field are done in-place and don't result in creation of a new
|
|
@@ -5299,7 +5504,7 @@ export type CustomSchemaFragmentBaseSummary = AtomBaseSummary;
|
|
|
5299
5504
|
* The condition associated with a field.
|
|
5300
5505
|
*/
|
|
5301
5506
|
export interface CustomSchemaFragmentCondition {
|
|
5302
|
-
/** The
|
|
5507
|
+
/** The associated effects when the expression evaluates to true. */
|
|
5303
5508
|
effects?: CustomSchemaFragmentEffect[];
|
|
5304
5509
|
/**
|
|
5305
5510
|
* The expression to evaluate.
|
|
@@ -5516,6 +5721,7 @@ export interface CustomSchemaFragmentsSetRequestTenantFragment {
|
|
|
5516
5721
|
/**
|
|
5517
5722
|
* The display ID prefix for the custom object.
|
|
5518
5723
|
* @format text
|
|
5724
|
+
* @pattern ^[A-Z]{2,10}$
|
|
5519
5725
|
*/
|
|
5520
5726
|
id_prefix?: string;
|
|
5521
5727
|
/** List of Per-DevOrg stock field overrides. */
|
|
@@ -5591,7 +5797,7 @@ export type CustomStage = AtomBase & {
|
|
|
5591
5797
|
*/
|
|
5592
5798
|
name?: string;
|
|
5593
5799
|
/**
|
|
5594
|
-
*
|
|
5800
|
+
* Position of the stage in the global stage ordering.
|
|
5595
5801
|
* @format int32
|
|
5596
5802
|
*/
|
|
5597
5803
|
ordinal?: number;
|
|
@@ -5713,7 +5919,7 @@ export type CustomState = AtomBase & {
|
|
|
5713
5919
|
*/
|
|
5714
5920
|
name?: string;
|
|
5715
5921
|
/**
|
|
5716
|
-
*
|
|
5922
|
+
* Position of the state in the global state ordering.
|
|
5717
5923
|
* @format int32
|
|
5718
5924
|
*/
|
|
5719
5925
|
ordinal?: number;
|
|
@@ -5824,10 +6030,10 @@ export type CustomTypeFragment = CustomSchemaFragmentBase & {
|
|
|
5824
6030
|
*/
|
|
5825
6031
|
path?: CustomTypePathComponent[];
|
|
5826
6032
|
stage_diagram?: StageDiagramSummary;
|
|
5827
|
-
/**
|
|
6033
|
+
/** Optional overrides for properties of stock fields. */
|
|
5828
6034
|
stock_field_overrides?: StockFieldOverride[];
|
|
5829
6035
|
/**
|
|
5830
|
-
*
|
|
6036
|
+
* Subtype this fragment applies to.
|
|
5831
6037
|
* @format text
|
|
5832
6038
|
*/
|
|
5833
6039
|
subtype?: string;
|
|
@@ -5845,6 +6051,27 @@ export type CustomTypeFragmentSummary = CustomSchemaFragmentBaseSummary;
|
|
|
5845
6051
|
* Path component for rendering custom type lists in tree form.
|
|
5846
6052
|
*/
|
|
5847
6053
|
export type CustomTypePathComponent = object;
|
|
6054
|
+
/** custom-view */
|
|
6055
|
+
export interface CustomView {
|
|
6056
|
+
/** A list of vista's column preferences in order. */
|
|
6057
|
+
column_properties?: CustomViewColumnProperties[];
|
|
6058
|
+
/** Boolean to specify whether to show groups or not. */
|
|
6059
|
+
show_groups?: boolean;
|
|
6060
|
+
}
|
|
6061
|
+
/** custom-view-column-properties */
|
|
6062
|
+
export interface CustomViewColumnProperties {
|
|
6063
|
+
/**
|
|
6064
|
+
* Name of the column.
|
|
6065
|
+
* @format text
|
|
6066
|
+
*/
|
|
6067
|
+
name: string;
|
|
6068
|
+
/**
|
|
6069
|
+
* Width of the column.
|
|
6070
|
+
* @format text
|
|
6071
|
+
* @maxLength 10
|
|
6072
|
+
*/
|
|
6073
|
+
width?: string;
|
|
6074
|
+
}
|
|
5848
6075
|
/** dashboard */
|
|
5849
6076
|
export type Dashboard = AtomBase;
|
|
5850
6077
|
/**
|
|
@@ -6711,6 +6938,11 @@ export interface DevUsersSelfUpdateRequest {
|
|
|
6711
6938
|
job_history?: DevUsersUpdateJobHistoryItem[];
|
|
6712
6939
|
/** Job title of the Dev User. */
|
|
6713
6940
|
job_title?: DevUserJobTitle;
|
|
6941
|
+
/**
|
|
6942
|
+
* The ID of the Dev user that the user reports to.
|
|
6943
|
+
* @format id
|
|
6944
|
+
*/
|
|
6945
|
+
reports_to?: string;
|
|
6714
6946
|
}
|
|
6715
6947
|
/** dev-users-update-job-history-item */
|
|
6716
6948
|
export interface DevUsersUpdateJobHistoryItem {
|
|
@@ -6786,6 +7018,11 @@ export interface DevUsersUpdateRequest {
|
|
|
6786
7018
|
job_history?: DevUsersUpdateJobHistoryItem[];
|
|
6787
7019
|
/** Job title of the Dev User. */
|
|
6788
7020
|
job_title?: DevUserJobTitle;
|
|
7021
|
+
/**
|
|
7022
|
+
* The ID of the Dev user that the user reports to.
|
|
7023
|
+
* @format id
|
|
7024
|
+
*/
|
|
7025
|
+
reports_to?: string;
|
|
6789
7026
|
}
|
|
6790
7027
|
/**
|
|
6791
7028
|
* dev-users-update-response
|
|
@@ -6881,12 +7118,6 @@ export type DirectoriesDeleteResponse = object;
|
|
|
6881
7118
|
* The request to get a directory.
|
|
6882
7119
|
*/
|
|
6883
7120
|
export interface DirectoriesGetRequest {
|
|
6884
|
-
/**
|
|
6885
|
-
* Optional Dev Org ID for the unauthenticated user.
|
|
6886
|
-
* @format id
|
|
6887
|
-
* @example "DEV-AbCdEfGh"
|
|
6888
|
-
*/
|
|
6889
|
-
dev_org?: string;
|
|
6890
7121
|
/**
|
|
6891
7122
|
* The ID of the requested directory.
|
|
6892
7123
|
* @format id
|
|
@@ -6916,12 +7147,6 @@ export interface DirectoriesListRequest {
|
|
|
6916
7147
|
* @format text
|
|
6917
7148
|
*/
|
|
6918
7149
|
cursor?: string;
|
|
6919
|
-
/**
|
|
6920
|
-
* Optional Dev Org ID for the unauthenticated user.
|
|
6921
|
-
* @format id
|
|
6922
|
-
* @example "DEV-AbCdEfGh"
|
|
6923
|
-
*/
|
|
6924
|
-
dev_org?: string;
|
|
6925
7150
|
/**
|
|
6926
7151
|
* The maximum number of directories to return. The default is '50'.
|
|
6927
7152
|
* @format int32
|
|
@@ -7140,9 +7365,45 @@ export interface DonutWidgetVisualization {
|
|
|
7140
7365
|
* Information to define dynamic groups.
|
|
7141
7366
|
*/
|
|
7142
7367
|
export type DynamicGroupInfo = object;
|
|
7368
|
+
/**
|
|
7369
|
+
* dynamic-vista
|
|
7370
|
+
* Dynamic collection of DevRev objects, all adhering to a specific
|
|
7371
|
+
* filter.
|
|
7372
|
+
*/
|
|
7373
|
+
export type DynamicVista = VistaBase & DynamicVistaMeetingsVista & {
|
|
7374
|
+
/** Type of DevRev object for which the vista is applicable. */
|
|
7375
|
+
filter_type: DynamicVistaFilterType;
|
|
7376
|
+
};
|
|
7377
|
+
/** Type of DevRev object for which the vista is applicable. */
|
|
7378
|
+
export declare enum DynamicVistaFilterType {
|
|
7379
|
+
Accounts = "accounts",
|
|
7380
|
+
Articles = "articles",
|
|
7381
|
+
Conversations = "conversations",
|
|
7382
|
+
Credits = "credits",
|
|
7383
|
+
CustomObjects = "custom_objects",
|
|
7384
|
+
DevUsers = "dev_users",
|
|
7385
|
+
Incidents = "incidents",
|
|
7386
|
+
Invoices = "invoices",
|
|
7387
|
+
Meetings = "meetings",
|
|
7388
|
+
Parts = "parts",
|
|
7389
|
+
Quotes = "quotes",
|
|
7390
|
+
RevOrgs = "rev_orgs",
|
|
7391
|
+
RevUsers = "rev_users",
|
|
7392
|
+
Works = "works"
|
|
7393
|
+
}
|
|
7394
|
+
/** dynamic-vista-meetings-vista */
|
|
7395
|
+
export interface DynamicVistaMeetingsVista {
|
|
7396
|
+
filter: MeetingsVistaFilter;
|
|
7397
|
+
/** Pinned items associated with the vista. */
|
|
7398
|
+
items?: DynamicVistaMeetingsVistaItemValue[];
|
|
7399
|
+
}
|
|
7400
|
+
/** dynamic-vista-meetings-vista-item-value */
|
|
7401
|
+
export interface DynamicVistaMeetingsVistaItemValue {
|
|
7402
|
+
item: MeetingSummary;
|
|
7403
|
+
}
|
|
7143
7404
|
/**
|
|
7144
7405
|
* dynamic-vista-summary
|
|
7145
|
-
* Dynamic collection of
|
|
7406
|
+
* Dynamic collection of DevRev objects, all adhering to a specific
|
|
7146
7407
|
* filter.
|
|
7147
7408
|
*/
|
|
7148
7409
|
export type DynamicVistaSummary = VistaBaseSummary;
|
|
@@ -8168,6 +8429,25 @@ export interface EventAiAgentResponse {
|
|
|
8168
8429
|
/** A list of suggestions generated for the AI agent event. */
|
|
8169
8430
|
suggestions?: AiAgentEventSuggestions;
|
|
8170
8431
|
}
|
|
8432
|
+
/** event-article-created */
|
|
8433
|
+
export interface EventArticleCreated {
|
|
8434
|
+
article: Article;
|
|
8435
|
+
}
|
|
8436
|
+
/** event-article-deleted */
|
|
8437
|
+
export interface EventArticleDeleted {
|
|
8438
|
+
/**
|
|
8439
|
+
* The ID of the article that was deleted.
|
|
8440
|
+
* @format id
|
|
8441
|
+
* @example "ARTICLE-12345"
|
|
8442
|
+
*/
|
|
8443
|
+
id: string;
|
|
8444
|
+
old_article?: Article;
|
|
8445
|
+
}
|
|
8446
|
+
/** event-article-updated */
|
|
8447
|
+
export interface EventArticleUpdated {
|
|
8448
|
+
article: Article;
|
|
8449
|
+
old_article?: Article;
|
|
8450
|
+
}
|
|
8171
8451
|
/** event-conversation-created */
|
|
8172
8452
|
export interface EventConversationCreated {
|
|
8173
8453
|
conversation: Conversation;
|
|
@@ -8777,64 +9057,190 @@ export interface FieldDelta {
|
|
|
8777
9057
|
* field-descriptor
|
|
8778
9058
|
* Set of field attributes.
|
|
8779
9059
|
*/
|
|
8780
|
-
export
|
|
8781
|
-
/**
|
|
8782
|
-
|
|
8783
|
-
type: FieldValueType;
|
|
8784
|
-
};
|
|
8785
|
-
/** field-value-bool */
|
|
8786
|
-
export interface FieldValueBool {
|
|
8787
|
-
value: boolean;
|
|
8788
|
-
}
|
|
8789
|
-
/** field-value-bool-list */
|
|
8790
|
-
export interface FieldValueBoolList {
|
|
8791
|
-
values: boolean[];
|
|
8792
|
-
}
|
|
8793
|
-
/** field-value-composite */
|
|
8794
|
-
export interface FieldValueComposite {
|
|
8795
|
-
fields: Record<string, FieldValue>;
|
|
8796
|
-
}
|
|
8797
|
-
/** field-value-composite-list */
|
|
8798
|
-
export interface FieldValueCompositeList {
|
|
8799
|
-
values: FieldValueComposite[];
|
|
8800
|
-
}
|
|
8801
|
-
/** field-value-date-list */
|
|
8802
|
-
export interface FieldValueDateList {
|
|
8803
|
-
/** @example ["2023-01-01"] */
|
|
8804
|
-
values: string[];
|
|
8805
|
-
}
|
|
8806
|
-
/** field-value-date-time-list */
|
|
8807
|
-
export interface FieldValueDateTimeList {
|
|
8808
|
-
/** @example ["2023-01-01T12:00:00.000Z"] */
|
|
8809
|
-
values: string[];
|
|
8810
|
-
}
|
|
8811
|
-
/** field-value-date-time-value */
|
|
8812
|
-
export interface FieldValueDateTimeValue {
|
|
9060
|
+
export interface FieldDescriptor {
|
|
9061
|
+
/** The default value for this field. */
|
|
9062
|
+
default_value?: object;
|
|
8813
9063
|
/**
|
|
8814
|
-
*
|
|
8815
|
-
* @
|
|
9064
|
+
* Description of the field.
|
|
9065
|
+
* @format text
|
|
8816
9066
|
*/
|
|
8817
|
-
|
|
8818
|
-
}
|
|
8819
|
-
/** field-value-date-value */
|
|
8820
|
-
export interface FieldValueDateValue {
|
|
9067
|
+
description?: string;
|
|
8821
9068
|
/**
|
|
8822
|
-
*
|
|
8823
|
-
* @
|
|
9069
|
+
* Composite type.
|
|
9070
|
+
* @format text
|
|
8824
9071
|
*/
|
|
8825
|
-
|
|
8826
|
-
|
|
8827
|
-
|
|
8828
|
-
|
|
8829
|
-
|
|
8830
|
-
|
|
8831
|
-
|
|
8832
|
-
|
|
8833
|
-
|
|
8834
|
-
|
|
9072
|
+
devrev_composite_type?: string;
|
|
9073
|
+
/** Allowed values for an enum field type. */
|
|
9074
|
+
devrev_enum?: string[];
|
|
9075
|
+
/**
|
|
9076
|
+
* DevRev field type.
|
|
9077
|
+
* @format text
|
|
9078
|
+
*/
|
|
9079
|
+
devrev_field_type?: string;
|
|
9080
|
+
/** Object ID types. */
|
|
9081
|
+
devrev_id_type?: string[];
|
|
9082
|
+
/** Whether this field is filterable, groupable and sortable. */
|
|
9083
|
+
is_filterable?: boolean;
|
|
9084
|
+
/** Whether this field is immutable or not. */
|
|
9085
|
+
is_immutable?: boolean;
|
|
9086
|
+
/** Whether a stock unified enum can be extended with new values. */
|
|
9087
|
+
is_overridable?: boolean;
|
|
9088
|
+
/** Whether this field is required or not. */
|
|
9089
|
+
is_required?: boolean;
|
|
9090
|
+
/**
|
|
9091
|
+
* Whether this field can hold PII or sensitive information that
|
|
9092
|
+
* should not be logged.
|
|
9093
|
+
*/
|
|
9094
|
+
is_sensitive?: boolean;
|
|
9095
|
+
/** Whether this field is a system field or not. */
|
|
9096
|
+
is_system?: boolean;
|
|
9097
|
+
/**
|
|
9098
|
+
* Name of the field.
|
|
9099
|
+
* @format text
|
|
9100
|
+
*/
|
|
9101
|
+
name?: string;
|
|
9102
|
+
/** Allowed values for a unified enum. */
|
|
9103
|
+
uenum_values?: SchemaFieldUenumValue[];
|
|
9104
|
+
/** The schema of ui specific fields. */
|
|
9105
|
+
ui?: SchemaFieldUiMetadata;
|
|
9106
|
+
/** Validation annotations. */
|
|
9107
|
+
validation?: FieldValidation;
|
|
8835
9108
|
}
|
|
8836
|
-
/**
|
|
8837
|
-
|
|
9109
|
+
/**
|
|
9110
|
+
* field-validation
|
|
9111
|
+
* Validation annotations.
|
|
9112
|
+
*/
|
|
9113
|
+
export interface FieldValidation {
|
|
9114
|
+
/**
|
|
9115
|
+
* string contains.
|
|
9116
|
+
* @format text
|
|
9117
|
+
*/
|
|
9118
|
+
contains?: string;
|
|
9119
|
+
/** disables validations for this field. */
|
|
9120
|
+
disabled?: boolean;
|
|
9121
|
+
/**
|
|
9122
|
+
* exact array length.
|
|
9123
|
+
* @format int32
|
|
9124
|
+
*/
|
|
9125
|
+
eq_items?: number;
|
|
9126
|
+
/**
|
|
9127
|
+
* exact string length.
|
|
9128
|
+
* @format int32
|
|
9129
|
+
*/
|
|
9130
|
+
eq_len?: number;
|
|
9131
|
+
/**
|
|
9132
|
+
* int must be greater than this.
|
|
9133
|
+
* @format int32
|
|
9134
|
+
*/
|
|
9135
|
+
gt?: number;
|
|
9136
|
+
/**
|
|
9137
|
+
* int must be greater or equal than this.
|
|
9138
|
+
* @format int32
|
|
9139
|
+
*/
|
|
9140
|
+
gte?: number;
|
|
9141
|
+
/**
|
|
9142
|
+
* int must be less than this.
|
|
9143
|
+
* @format int32
|
|
9144
|
+
*/
|
|
9145
|
+
lt?: number;
|
|
9146
|
+
/**
|
|
9147
|
+
* int must be less or equal than this.
|
|
9148
|
+
* @format int32
|
|
9149
|
+
*/
|
|
9150
|
+
lte?: number;
|
|
9151
|
+
/**
|
|
9152
|
+
* maximum array length.
|
|
9153
|
+
* @format int32
|
|
9154
|
+
*/
|
|
9155
|
+
max_items?: number;
|
|
9156
|
+
/**
|
|
9157
|
+
* maximum string length.
|
|
9158
|
+
* @format int32
|
|
9159
|
+
*/
|
|
9160
|
+
max_len?: number;
|
|
9161
|
+
/**
|
|
9162
|
+
* minimum array length.
|
|
9163
|
+
* @format int32
|
|
9164
|
+
*/
|
|
9165
|
+
min_items?: number;
|
|
9166
|
+
/**
|
|
9167
|
+
* minimum string length.
|
|
9168
|
+
* @format int32
|
|
9169
|
+
*/
|
|
9170
|
+
min_len?: number;
|
|
9171
|
+
/**
|
|
9172
|
+
* string pattern (re).
|
|
9173
|
+
* @format text
|
|
9174
|
+
*/
|
|
9175
|
+
pattern?: string;
|
|
9176
|
+
/**
|
|
9177
|
+
* string prefix.
|
|
9178
|
+
* @format text
|
|
9179
|
+
*/
|
|
9180
|
+
prefix?: string;
|
|
9181
|
+
/**
|
|
9182
|
+
* string suffix.
|
|
9183
|
+
* @format text
|
|
9184
|
+
*/
|
|
9185
|
+
suffix?: string;
|
|
9186
|
+
}
|
|
9187
|
+
/** field-value */
|
|
9188
|
+
export type FieldValue = (FieldValueBool | FieldValueBoolList | FieldValueComposite | FieldValueCompositeList | FieldValueDateList | FieldValueDateTimeList | FieldValueDateTimeValue | FieldValueDateValue | FieldValueDouble | FieldValueDoubleList | FieldValueId | FieldValueIdList | FieldValueInt64 | FieldValueInt64List | FieldValueStage | FieldValueString | FieldValueStringList | FieldValueTagSummary | FieldValueTagSummaryList) & {
|
|
9189
|
+
type: FieldValueType;
|
|
9190
|
+
};
|
|
9191
|
+
/** field-value-bool */
|
|
9192
|
+
export interface FieldValueBool {
|
|
9193
|
+
value: boolean;
|
|
9194
|
+
}
|
|
9195
|
+
/** field-value-bool-list */
|
|
9196
|
+
export interface FieldValueBoolList {
|
|
9197
|
+
values: boolean[];
|
|
9198
|
+
}
|
|
9199
|
+
/** field-value-composite */
|
|
9200
|
+
export interface FieldValueComposite {
|
|
9201
|
+
fields: Record<string, FieldValue>;
|
|
9202
|
+
}
|
|
9203
|
+
/** field-value-composite-list */
|
|
9204
|
+
export interface FieldValueCompositeList {
|
|
9205
|
+
values: FieldValueComposite[];
|
|
9206
|
+
}
|
|
9207
|
+
/** field-value-date-list */
|
|
9208
|
+
export interface FieldValueDateList {
|
|
9209
|
+
/** @example ["2023-01-01"] */
|
|
9210
|
+
values: string[];
|
|
9211
|
+
}
|
|
9212
|
+
/** field-value-date-time-list */
|
|
9213
|
+
export interface FieldValueDateTimeList {
|
|
9214
|
+
/** @example ["2023-01-01T12:00:00.000Z"] */
|
|
9215
|
+
values: string[];
|
|
9216
|
+
}
|
|
9217
|
+
/** field-value-date-time-value */
|
|
9218
|
+
export interface FieldValueDateTimeValue {
|
|
9219
|
+
/**
|
|
9220
|
+
* @format date-time
|
|
9221
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
9222
|
+
*/
|
|
9223
|
+
value: string;
|
|
9224
|
+
}
|
|
9225
|
+
/** field-value-date-value */
|
|
9226
|
+
export interface FieldValueDateValue {
|
|
9227
|
+
/**
|
|
9228
|
+
* @format date
|
|
9229
|
+
* @example "2023-01-01"
|
|
9230
|
+
*/
|
|
9231
|
+
value: string;
|
|
9232
|
+
}
|
|
9233
|
+
/** field-value-double */
|
|
9234
|
+
export interface FieldValueDouble {
|
|
9235
|
+
/** @format double */
|
|
9236
|
+
value: number;
|
|
9237
|
+
}
|
|
9238
|
+
/** field-value-double-list */
|
|
9239
|
+
export interface FieldValueDoubleList {
|
|
9240
|
+
values: number[];
|
|
9241
|
+
}
|
|
9242
|
+
/** field-value-id */
|
|
9243
|
+
export interface FieldValueId {
|
|
8838
9244
|
/** @format id */
|
|
8839
9245
|
value: string;
|
|
8840
9246
|
}
|
|
@@ -9041,6 +9447,11 @@ export declare enum GroupIngestionSource {
|
|
|
9041
9447
|
Airdrop = "airdrop",
|
|
9042
9448
|
Scim = "scim"
|
|
9043
9449
|
}
|
|
9450
|
+
/** Type of the vista group item object. */
|
|
9451
|
+
export declare enum GroupItemType {
|
|
9452
|
+
Curated = "curated",
|
|
9453
|
+
Dynamic = "dynamic"
|
|
9454
|
+
}
|
|
9044
9455
|
/** Type of the members in the group. */
|
|
9045
9456
|
export declare enum GroupMemberType {
|
|
9046
9457
|
DevUser = "dev_user",
|
|
@@ -9178,6 +9589,22 @@ export declare enum GroupType {
|
|
|
9178
9589
|
Dynamic = "dynamic",
|
|
9179
9590
|
Static = "static"
|
|
9180
9591
|
}
|
|
9592
|
+
/**
|
|
9593
|
+
* grouped-vista
|
|
9594
|
+
* Represents a group of multiple vistas as a single unit.
|
|
9595
|
+
*/
|
|
9596
|
+
export type GroupedVista = VistaBase & {
|
|
9597
|
+
/** Type of DevRev object for which the grouped vista is applicable. */
|
|
9598
|
+
filter_type: GroupedVistaFilterType;
|
|
9599
|
+
/** Denotes the use case of the grouped vista. */
|
|
9600
|
+
flavor?: GroupedVistaFlavor;
|
|
9601
|
+
};
|
|
9602
|
+
/** Type of DevRev object for which the grouped vista is applicable. */
|
|
9603
|
+
export declare enum GroupedVistaFilterType {
|
|
9604
|
+
Conversations = "conversations",
|
|
9605
|
+
Parts = "parts",
|
|
9606
|
+
Works = "works"
|
|
9607
|
+
}
|
|
9181
9608
|
/** Denotes the use case of the grouped vista. */
|
|
9182
9609
|
export declare enum GroupedVistaFlavor {
|
|
9183
9610
|
Nnl = "nnl",
|
|
@@ -10284,11 +10711,12 @@ export interface LinkDescriptorFilter {
|
|
|
10284
10711
|
link_descriptors: LinkTargetDescriptor[];
|
|
10285
10712
|
}
|
|
10286
10713
|
/** link-endpoint-summary */
|
|
10287
|
-
export type LinkEndpointSummary = (AccountSummary | CapabilitySummary | CodeChangeSummary | ConversationSummary | CustomObjectSummary | DevUserSummary | EnhancementSummary | FeatureSummary | IncidentSummary | IssueSummary | LinkableSummary | MeetingSummary | OpportunitySummary | ProductSummary | RevOrgSummary | RevUserSummary | RunnableSummary | TaskSummary | TicketSummary | WidgetSummary) & {
|
|
10714
|
+
export type LinkEndpointSummary = (AccountSummary | ArticleSummary | CapabilitySummary | CodeChangeSummary | ConversationSummary | CustomObjectSummary | DevUserSummary | EnhancementSummary | FeatureSummary | IncidentSummary | IssueSummary | LinkableSummary | MeetingSummary | OpportunitySummary | ProductSummary | RevOrgSummary | RevUserSummary | RunnableSummary | TaskSummary | TicketSummary | WidgetSummary) & {
|
|
10288
10715
|
type: LinkEndpointType;
|
|
10289
10716
|
};
|
|
10290
10717
|
export declare enum LinkEndpointType {
|
|
10291
10718
|
Account = "account",
|
|
10719
|
+
Article = "article",
|
|
10292
10720
|
Capability = "capability",
|
|
10293
10721
|
CodeChange = "code_change",
|
|
10294
10722
|
Conversation = "conversation",
|
|
@@ -10660,6 +11088,12 @@ export type Meeting = AtomBase & {
|
|
|
10660
11088
|
* @format text
|
|
10661
11089
|
*/
|
|
10662
11090
|
description?: string;
|
|
11091
|
+
/**
|
|
11092
|
+
* Direction of meeting - meetings within an organization are internal.
|
|
11093
|
+
* Meetings with external customers can be incoming or outgoing depending
|
|
11094
|
+
* on who initiates them.
|
|
11095
|
+
*/
|
|
11096
|
+
direction?: MeetingDirection;
|
|
10663
11097
|
/**
|
|
10664
11098
|
* Time at which meeting ended.
|
|
10665
11099
|
* @format date-time
|
|
@@ -10726,6 +11160,16 @@ export declare enum MeetingChannel {
|
|
|
10726
11160
|
Teams = "teams",
|
|
10727
11161
|
Zoom = "zoom"
|
|
10728
11162
|
}
|
|
11163
|
+
/**
|
|
11164
|
+
* Direction of meeting - meetings within an organization are internal.
|
|
11165
|
+
* Meetings with external customers can be incoming or outgoing depending
|
|
11166
|
+
* on who initiates them.
|
|
11167
|
+
*/
|
|
11168
|
+
export declare enum MeetingDirection {
|
|
11169
|
+
Incoming = "incoming",
|
|
11170
|
+
Internal = "internal",
|
|
11171
|
+
Outgoing = "outgoing"
|
|
11172
|
+
}
|
|
10729
11173
|
/** The state of meeting. */
|
|
10730
11174
|
export declare enum MeetingState {
|
|
10731
11175
|
Canceled = "canceled",
|
|
@@ -10774,6 +11218,7 @@ export interface MeetingsCountRequest {
|
|
|
10774
11218
|
scheduled_date?: DateFilter;
|
|
10775
11219
|
/** Filters for meeting on specified state or outcomes. */
|
|
10776
11220
|
state?: MeetingState[];
|
|
11221
|
+
sync_metadata?: SyncMetadataFilter;
|
|
10777
11222
|
/** Filters for meeting by tags. */
|
|
10778
11223
|
tags?: string[];
|
|
10779
11224
|
}
|
|
@@ -10976,6 +11421,7 @@ export interface MeetingsListRequest {
|
|
|
10976
11421
|
sort_by?: string[];
|
|
10977
11422
|
/** Filters for meeting on specified state or outcomes. */
|
|
10978
11423
|
state?: MeetingState[];
|
|
11424
|
+
sync_metadata?: SyncMetadataFilter;
|
|
10979
11425
|
/** Filters for meeting by tags. */
|
|
10980
11426
|
tags?: string[];
|
|
10981
11427
|
}
|
|
@@ -11093,6 +11539,49 @@ export interface MeetingsUpdateRequestTags {
|
|
|
11093
11539
|
export interface MeetingsUpdateResponse {
|
|
11094
11540
|
meeting: Meeting;
|
|
11095
11541
|
}
|
|
11542
|
+
/** meetings-vista-filter */
|
|
11543
|
+
export interface MeetingsVistaFilter {
|
|
11544
|
+
/** Filters for meeting on specified channels. */
|
|
11545
|
+
channel?: MeetingChannel[];
|
|
11546
|
+
/** Filters for meetings created by the specified user(s). */
|
|
11547
|
+
created_by?: string[];
|
|
11548
|
+
/** Provides ways to specify date ranges on objects. */
|
|
11549
|
+
created_date?: DateFilter;
|
|
11550
|
+
/** Filters for meeting on custom fields. */
|
|
11551
|
+
custom_fields?: object;
|
|
11552
|
+
/** Provides ways to specify date ranges on objects. */
|
|
11553
|
+
ended_date?: DateFilter;
|
|
11554
|
+
/** Filters for meetings with the provided external_ref(s). */
|
|
11555
|
+
external_ref?: string[];
|
|
11556
|
+
/**
|
|
11557
|
+
* The field to group the collection by.
|
|
11558
|
+
* @format text
|
|
11559
|
+
*/
|
|
11560
|
+
group_by?: string;
|
|
11561
|
+
/** Filters for links associated with the meeting. */
|
|
11562
|
+
links?: MeetingsFilterLinkSummaryFilter[];
|
|
11563
|
+
/** Filter for meeting on specified Member Ids. */
|
|
11564
|
+
members?: string[];
|
|
11565
|
+
/** Provides ways to specify date ranges on objects. */
|
|
11566
|
+
modified_date?: DateFilter;
|
|
11567
|
+
/** Filter for meeting on specified organizers. */
|
|
11568
|
+
organizer?: string[];
|
|
11569
|
+
/**
|
|
11570
|
+
* Filters for meetings with the provided parent.
|
|
11571
|
+
* @deprecated
|
|
11572
|
+
* @example ["ACC-12345"]
|
|
11573
|
+
*/
|
|
11574
|
+
parent?: string[];
|
|
11575
|
+
/** Provides ways to specify date ranges on objects. */
|
|
11576
|
+
scheduled_date?: DateFilter;
|
|
11577
|
+
/** Comma-separated fields to sort the objects by. */
|
|
11578
|
+
sort_by?: string[];
|
|
11579
|
+
/** Filters for meeting on specified state or outcomes. */
|
|
11580
|
+
state?: MeetingState[];
|
|
11581
|
+
sync_metadata?: SyncMetadataFilter;
|
|
11582
|
+
/** Filters for meeting by tags. */
|
|
11583
|
+
tags?: string[];
|
|
11584
|
+
}
|
|
11096
11585
|
/** member-summary */
|
|
11097
11586
|
export type MemberSummary = (DevUserSummary | GroupSummary | RevUserSummary | SysUserSummary) & {
|
|
11098
11587
|
type: MemberType;
|
|
@@ -11484,6 +11973,10 @@ export interface Money {
|
|
|
11484
11973
|
*/
|
|
11485
11974
|
currency?: string;
|
|
11486
11975
|
}
|
|
11976
|
+
/** notification-content-template */
|
|
11977
|
+
export type NotificationContentTemplate = ContentTemplateBase;
|
|
11978
|
+
/** notification-content-template-summary */
|
|
11979
|
+
export type NotificationContentTemplateSummary = ContentTemplateBaseSummary;
|
|
11487
11980
|
/** notifications-send-request */
|
|
11488
11981
|
export interface NotificationsSendRequest {
|
|
11489
11982
|
/**
|
|
@@ -12364,6 +12857,8 @@ export interface PartsListRequest {
|
|
|
12364
12857
|
owned_by?: string[];
|
|
12365
12858
|
/** The filter for specifying parent part. */
|
|
12366
12859
|
parent_part?: ParentPartFilter;
|
|
12860
|
+
/** Fields to sort the parts by and the direction to sort them. */
|
|
12861
|
+
sort_by?: string[];
|
|
12367
12862
|
/** Filters for subtypes. */
|
|
12368
12863
|
subtype?: string[];
|
|
12369
12864
|
/**
|
|
@@ -12516,6 +13011,19 @@ export interface PartsUpdateRequestTags {
|
|
|
12516
13011
|
export interface PartsUpdateResponse {
|
|
12517
13012
|
part: Part;
|
|
12518
13013
|
}
|
|
13014
|
+
/**
|
|
13015
|
+
* parts-vista-group-item
|
|
13016
|
+
* Represents a nested parts vista group object.
|
|
13017
|
+
*/
|
|
13018
|
+
export type PartsVistaGroupItem = VistaGroupBase & {
|
|
13019
|
+
/** Type of parts vista group item. */
|
|
13020
|
+
type: PartsVistaGroupItemType;
|
|
13021
|
+
};
|
|
13022
|
+
/** Type of parts vista group item. */
|
|
13023
|
+
export declare enum PartsVistaGroupItemType {
|
|
13024
|
+
Curated = "curated",
|
|
13025
|
+
Dynamic = "dynamic"
|
|
13026
|
+
}
|
|
12519
13027
|
/**
|
|
12520
13028
|
* pie-visualization-x-axis
|
|
12521
13029
|
* The X-axis for a pie visualization.
|
|
@@ -12621,6 +13129,19 @@ export type PreferencesUpdateRequest = UpdateUserPreferences & {
|
|
|
12621
13129
|
export interface PreferencesUpdateResponse {
|
|
12622
13130
|
preferences: Preferences;
|
|
12623
13131
|
}
|
|
13132
|
+
/** Type of the value. */
|
|
13133
|
+
export declare enum PrimitiveValueType {
|
|
13134
|
+
Attribute = "attribute",
|
|
13135
|
+
Bool = "bool",
|
|
13136
|
+
Id = "id",
|
|
13137
|
+
IdList = "id_list",
|
|
13138
|
+
Int = "int",
|
|
13139
|
+
IntList = "int_list",
|
|
13140
|
+
OverridableEnum = "overridable_enum",
|
|
13141
|
+
OverridableEnumList = "overridable_enum_list",
|
|
13142
|
+
String = "string",
|
|
13143
|
+
StringList = "string_list"
|
|
13144
|
+
}
|
|
12624
13145
|
/** product */
|
|
12625
13146
|
export type Product = PartBase;
|
|
12626
13147
|
/** product-summary */
|
|
@@ -13175,6 +13696,7 @@ export type RevOrg = OrgBase & {
|
|
|
13175
13696
|
* @format text
|
|
13176
13697
|
*/
|
|
13177
13698
|
external_ref?: string;
|
|
13699
|
+
primary_rev_org?: OrgSummary;
|
|
13178
13700
|
/**
|
|
13179
13701
|
* Stock schema fragment.
|
|
13180
13702
|
* @format id
|
|
@@ -14051,6 +14573,8 @@ export type RolesApplyResponse = object;
|
|
|
14051
14573
|
* A request to create a new role.
|
|
14052
14574
|
*/
|
|
14053
14575
|
export interface RolesCreateRequest {
|
|
14576
|
+
/** The caveats on the role. */
|
|
14577
|
+
caveats?: RolesCreateRequestCaveat[];
|
|
14054
14578
|
/**
|
|
14055
14579
|
* The description of the role.
|
|
14056
14580
|
* @format text
|
|
@@ -14079,6 +14603,51 @@ export interface RolesCreateRequest {
|
|
|
14079
14603
|
*/
|
|
14080
14604
|
target_subtype?: string;
|
|
14081
14605
|
}
|
|
14606
|
+
/**
|
|
14607
|
+
* roles-create-request-caveat
|
|
14608
|
+
* Caveat under which the role applies.
|
|
14609
|
+
*/
|
|
14610
|
+
export interface RolesCreateRequestCaveat {
|
|
14611
|
+
/** Selector. */
|
|
14612
|
+
key: Selector;
|
|
14613
|
+
/** The operator used to compare the key and the value. */
|
|
14614
|
+
operator: CaveatOperator;
|
|
14615
|
+
/** Primitive Value. */
|
|
14616
|
+
value: RolesCreateRequestPrimitiveValue;
|
|
14617
|
+
}
|
|
14618
|
+
/**
|
|
14619
|
+
* roles-create-request-primitive-value
|
|
14620
|
+
* Primitive Value.
|
|
14621
|
+
*/
|
|
14622
|
+
export interface RolesCreateRequestPrimitiveValue {
|
|
14623
|
+
/** Type of the value. */
|
|
14624
|
+
type: PrimitiveValueType;
|
|
14625
|
+
/** Selector. */
|
|
14626
|
+
attribute_value?: Selector;
|
|
14627
|
+
/** Boolean value. */
|
|
14628
|
+
bool_value?: boolean;
|
|
14629
|
+
/** List of ID values. */
|
|
14630
|
+
id_list_value?: string[];
|
|
14631
|
+
/**
|
|
14632
|
+
* ID value.
|
|
14633
|
+
* @format id
|
|
14634
|
+
*/
|
|
14635
|
+
id_value?: string;
|
|
14636
|
+
/** List of integer values. */
|
|
14637
|
+
int_list_value?: number[];
|
|
14638
|
+
/**
|
|
14639
|
+
* Integer value.
|
|
14640
|
+
* @format int64
|
|
14641
|
+
*/
|
|
14642
|
+
int_value?: number;
|
|
14643
|
+
/** List of string values. */
|
|
14644
|
+
string_list_value?: string[];
|
|
14645
|
+
/**
|
|
14646
|
+
* String value.
|
|
14647
|
+
* @format text
|
|
14648
|
+
*/
|
|
14649
|
+
string_value?: string;
|
|
14650
|
+
}
|
|
14082
14651
|
/**
|
|
14083
14652
|
* roles-create-response
|
|
14084
14653
|
* A response to a request to create a new role.
|
|
@@ -14419,6 +14988,12 @@ export interface SchemaFieldUiMetadata {
|
|
|
14419
14988
|
client_overrides?: ClientOverride[];
|
|
14420
14989
|
/** Create view UI hint overrides. */
|
|
14421
14990
|
create_view?: SchemaFieldCreateViewUiMetadata;
|
|
14991
|
+
/**
|
|
14992
|
+
* Number of decimal places to show (only applicable for number
|
|
14993
|
+
* fields).
|
|
14994
|
+
* @format int32
|
|
14995
|
+
*/
|
|
14996
|
+
decimal_places?: number;
|
|
14422
14997
|
/** Detail view UI hint overrides. */
|
|
14423
14998
|
detail_view?: SchemaFieldDetailViewUiMetadata;
|
|
14424
14999
|
/**
|
|
@@ -14437,7 +15012,7 @@ export interface SchemaFieldUiMetadata {
|
|
|
14437
15012
|
is_active_in_detail_view?: boolean;
|
|
14438
15013
|
/** Whether the field supports bulk action. */
|
|
14439
15014
|
is_bulk_action_enabled?: boolean;
|
|
14440
|
-
/** Indicates if the field holds a currency value
|
|
15015
|
+
/** Indicates if the field holds a currency value. */
|
|
14441
15016
|
is_currency_field?: boolean;
|
|
14442
15017
|
/** Whether the field is groupable in the UI. */
|
|
14443
15018
|
is_groupable?: boolean;
|
|
@@ -14477,6 +15052,11 @@ export interface SchemaFieldUiMetadata {
|
|
|
14477
15052
|
* @format text
|
|
14478
15053
|
*/
|
|
14479
15054
|
unit?: string;
|
|
15055
|
+
/**
|
|
15056
|
+
* Whether to use shorthand notation (only applicable for number
|
|
15057
|
+
* fields).
|
|
15058
|
+
*/
|
|
15059
|
+
use_shorthand_notation?: boolean;
|
|
14480
15060
|
}
|
|
14481
15061
|
/** schema-id-field-descriptor */
|
|
14482
15062
|
export type SchemaIdFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
@@ -15140,6 +15720,24 @@ export interface SearchSummaryBase {
|
|
|
15140
15720
|
*/
|
|
15141
15721
|
snippet?: string;
|
|
15142
15722
|
}
|
|
15723
|
+
/**
|
|
15724
|
+
* selector
|
|
15725
|
+
* Selector.
|
|
15726
|
+
*/
|
|
15727
|
+
export interface Selector {
|
|
15728
|
+
/**
|
|
15729
|
+
* Attribute of the object.
|
|
15730
|
+
* @format text
|
|
15731
|
+
*/
|
|
15732
|
+
attribute: string;
|
|
15733
|
+
/** The object. */
|
|
15734
|
+
object: SelectorObject;
|
|
15735
|
+
}
|
|
15736
|
+
/** The object. */
|
|
15737
|
+
export declare enum SelectorObject {
|
|
15738
|
+
Actor = "actor",
|
|
15739
|
+
Target = "target"
|
|
15740
|
+
}
|
|
15143
15741
|
/** send-notification */
|
|
15144
15742
|
export type SendNotification = SendNotificationGenericNotificationEntry & {
|
|
15145
15743
|
type: SendNotificationType;
|
|
@@ -16207,9 +16805,9 @@ export interface Stage {
|
|
|
16207
16805
|
}
|
|
16208
16806
|
/** stage-diagram */
|
|
16209
16807
|
export type StageDiagram = AtomBase & {
|
|
16210
|
-
/** True if this diagram corresponds to a custom leaf type. */
|
|
16808
|
+
/** True if this stage diagram corresponds to a custom leaf type. */
|
|
16211
16809
|
is_custom_leaf_type?: boolean;
|
|
16212
|
-
/** True if this diagram is the default for the leaf type. */
|
|
16810
|
+
/** True if this stage diagram is the default for the leaf type. */
|
|
16213
16811
|
is_default?: boolean;
|
|
16214
16812
|
/**
|
|
16215
16813
|
* The leaf type this stage diagram applies to.
|
|
@@ -16217,17 +16815,20 @@ export type StageDiagram = AtomBase & {
|
|
|
16217
16815
|
*/
|
|
16218
16816
|
leaf_type?: string;
|
|
16219
16817
|
/**
|
|
16220
|
-
* The human readable name of the diagram.
|
|
16818
|
+
* The human readable name of the stage diagram.
|
|
16221
16819
|
* @format text
|
|
16222
16820
|
*/
|
|
16223
16821
|
name?: string;
|
|
16224
|
-
/**
|
|
16822
|
+
/**
|
|
16823
|
+
* List of stages with their allowed transitions in this stage
|
|
16824
|
+
* diagram.
|
|
16825
|
+
*/
|
|
16225
16826
|
stages: StageNode[];
|
|
16226
16827
|
};
|
|
16227
16828
|
/** stage-diagram-summary */
|
|
16228
16829
|
export type StageDiagramSummary = AtomBaseSummary & {
|
|
16229
16830
|
/**
|
|
16230
|
-
* The human readable name of the diagram.
|
|
16831
|
+
* The human readable name of the stage diagram.
|
|
16231
16832
|
* @format text
|
|
16232
16833
|
*/
|
|
16233
16834
|
name?: string;
|
|
@@ -16367,7 +16968,7 @@ export interface StageNode {
|
|
|
16367
16968
|
/** True if this stage is the starting stage of the stage diagram. */
|
|
16368
16969
|
is_start?: boolean;
|
|
16369
16970
|
stage?: CustomStageSummary;
|
|
16370
|
-
/**
|
|
16971
|
+
/** List of allowed transitions from this stage. */
|
|
16371
16972
|
transitions?: StageTransition[];
|
|
16372
16973
|
}
|
|
16373
16974
|
/**
|
|
@@ -16438,6 +17039,8 @@ export interface StockFieldOverride {
|
|
|
16438
17039
|
}
|
|
16439
17040
|
/** stock-schema-fragment */
|
|
16440
17041
|
export type StockSchemaFragment = AtomBase & {
|
|
17042
|
+
/** List of composite schemas. */
|
|
17043
|
+
composite_schemas: CompositeSchema[];
|
|
16441
17044
|
/**
|
|
16442
17045
|
* Description of the schema.
|
|
16443
17046
|
* @format text
|
|
@@ -17796,7 +18399,17 @@ export declare enum TaskPriority {
|
|
|
17796
18399
|
export type TaskSummary = WorkBaseSummary;
|
|
17797
18400
|
/** tenant-fragment */
|
|
17798
18401
|
export type TenantFragment = CustomSchemaFragmentBase & {
|
|
17799
|
-
/**
|
|
18402
|
+
/**
|
|
18403
|
+
* The display ID prefix. For custom leaf types only.
|
|
18404
|
+
* @format text
|
|
18405
|
+
*/
|
|
18406
|
+
id_prefix?: string;
|
|
18407
|
+
/**
|
|
18408
|
+
* The display name of the leaf type. For custom leaf types only.
|
|
18409
|
+
* @format text
|
|
18410
|
+
*/
|
|
18411
|
+
leaf_type_display_name?: string;
|
|
18412
|
+
/** Optional overrides for properties of stock fields. */
|
|
17800
18413
|
stock_field_overrides?: StockFieldOverride[];
|
|
17801
18414
|
};
|
|
17802
18415
|
/** tenant-fragment-summary */
|
|
@@ -18318,6 +18931,7 @@ export type TimelineEntryBaseSummary = AtomBaseSummary & {
|
|
|
18318
18931
|
/** The type of object that the Timeline entry belongs to. */
|
|
18319
18932
|
export declare enum TimelineEntryObjectType {
|
|
18320
18933
|
Account = "account",
|
|
18934
|
+
Article = "article",
|
|
18321
18935
|
Capability = "capability",
|
|
18322
18936
|
CodeChange = "code_change",
|
|
18323
18937
|
Conversation = "conversation",
|
|
@@ -19221,6 +19835,7 @@ export type UserBase = AtomBase & {
|
|
|
19221
19835
|
full_name?: string;
|
|
19222
19836
|
/** Phone numbers of the user. */
|
|
19223
19837
|
phone_numbers?: string[];
|
|
19838
|
+
primary_identity?: UserSummary;
|
|
19224
19839
|
/** State of the user. */
|
|
19225
19840
|
state?: UserState;
|
|
19226
19841
|
};
|
|
@@ -19296,6 +19911,12 @@ export declare enum UserType {
|
|
|
19296
19911
|
* UI hint overrides for a view.
|
|
19297
19912
|
*/
|
|
19298
19913
|
export interface ViewOverride {
|
|
19914
|
+
/**
|
|
19915
|
+
* Number of decimal places to show. Only applicable for number
|
|
19916
|
+
* fields.
|
|
19917
|
+
* @format int32
|
|
19918
|
+
*/
|
|
19919
|
+
decimal_places?: number;
|
|
19299
19920
|
/**
|
|
19300
19921
|
* The display name of the field.
|
|
19301
19922
|
* @format text
|
|
@@ -19307,6 +19928,11 @@ export interface ViewOverride {
|
|
|
19307
19928
|
is_hidden?: boolean;
|
|
19308
19929
|
/** Whether the field is mandatory. */
|
|
19309
19930
|
is_required?: boolean;
|
|
19931
|
+
/**
|
|
19932
|
+
* Relative order in which the field is shown.
|
|
19933
|
+
* @format int32
|
|
19934
|
+
*/
|
|
19935
|
+
order?: number;
|
|
19310
19936
|
/**
|
|
19311
19937
|
* A placeholder for the field.
|
|
19312
19938
|
* @format text
|
|
@@ -19317,12 +19943,37 @@ export interface ViewOverride {
|
|
|
19317
19943
|
* @format text
|
|
19318
19944
|
*/
|
|
19319
19945
|
tooltip?: string;
|
|
19946
|
+
/**
|
|
19947
|
+
* Whether to use shorthand notation. Example, 1K instead of 1000.
|
|
19948
|
+
* Only applicable for number fields.
|
|
19949
|
+
*/
|
|
19950
|
+
use_shorthand_notation?: boolean;
|
|
19320
19951
|
/**
|
|
19321
19952
|
* The name of the view.
|
|
19322
19953
|
* @format text
|
|
19323
19954
|
*/
|
|
19324
19955
|
view_name?: string;
|
|
19325
19956
|
}
|
|
19957
|
+
/**
|
|
19958
|
+
* vista
|
|
19959
|
+
* Represents a collection of DevRev objects.
|
|
19960
|
+
*/
|
|
19961
|
+
export type Vista = (CuratedVista | DynamicVista | GroupedVista) & {
|
|
19962
|
+
/** Type of vista object. */
|
|
19963
|
+
type: VistaType;
|
|
19964
|
+
};
|
|
19965
|
+
/** vista-base */
|
|
19966
|
+
export type VistaBase = AtomBase & {
|
|
19967
|
+
/** Boolean to specify whether it's a default Vista or not. */
|
|
19968
|
+
is_default?: boolean;
|
|
19969
|
+
/**
|
|
19970
|
+
* Name of the vista.
|
|
19971
|
+
* @format text
|
|
19972
|
+
*/
|
|
19973
|
+
name: string;
|
|
19974
|
+
/** Users and groups associated with vista. */
|
|
19975
|
+
shared_with?: SharedWithMembership[];
|
|
19976
|
+
};
|
|
19326
19977
|
/** vista-base-summary */
|
|
19327
19978
|
export type VistaBaseSummary = AtomBaseSummary & {
|
|
19328
19979
|
/**
|
|
@@ -19331,6 +19982,80 @@ export type VistaBaseSummary = AtomBaseSummary & {
|
|
|
19331
19982
|
*/
|
|
19332
19983
|
name: string;
|
|
19333
19984
|
};
|
|
19985
|
+
/** Denotes the use case of the vista. */
|
|
19986
|
+
export declare enum VistaFlavor {
|
|
19987
|
+
Nnl = "nnl",
|
|
19988
|
+
SprintBoard = "sprint_board",
|
|
19989
|
+
SupportInbox = "support_inbox"
|
|
19990
|
+
}
|
|
19991
|
+
/**
|
|
19992
|
+
* vista-group
|
|
19993
|
+
* Represents a vista group item.
|
|
19994
|
+
*/
|
|
19995
|
+
export type VistaGroup = (ConversationsVistaGroupItem | PartsVistaGroupItem | WorksVistaGroupItem) & {
|
|
19996
|
+
/** Type of DevRev object for which the grouped vista is applicable. */
|
|
19997
|
+
object_type: GroupedVistaFilterType;
|
|
19998
|
+
};
|
|
19999
|
+
/** vista-group-base */
|
|
20000
|
+
export interface VistaGroupBase {
|
|
20001
|
+
/**
|
|
20002
|
+
* Timestamp when the vista group item ends.
|
|
20003
|
+
* @format date-time
|
|
20004
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
20005
|
+
*/
|
|
20006
|
+
end_date?: string;
|
|
20007
|
+
/**
|
|
20008
|
+
* Globally unique object ID.
|
|
20009
|
+
* @format id
|
|
20010
|
+
*/
|
|
20011
|
+
id: string;
|
|
20012
|
+
/**
|
|
20013
|
+
* Name of the group.
|
|
20014
|
+
* @format text
|
|
20015
|
+
*/
|
|
20016
|
+
name: string;
|
|
20017
|
+
parent?: VistaGroupBaseVistaParentComposite;
|
|
20018
|
+
/**
|
|
20019
|
+
* Timestamp when the vista group item starts.
|
|
20020
|
+
* @format date-time
|
|
20021
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
20022
|
+
*/
|
|
20023
|
+
start_date?: string;
|
|
20024
|
+
/** Defines the state of the group item. */
|
|
20025
|
+
state?: VistaGroupItemState;
|
|
20026
|
+
}
|
|
20027
|
+
/** vista-group-base-vista-parent-composite */
|
|
20028
|
+
export interface VistaGroupBaseVistaParentComposite {
|
|
20029
|
+
/**
|
|
20030
|
+
* Type of the parent vista.
|
|
20031
|
+
* @format text
|
|
20032
|
+
*/
|
|
20033
|
+
type: string;
|
|
20034
|
+
/**
|
|
20035
|
+
* Human-readable object ID unique to the Dev organization.
|
|
20036
|
+
* @format text
|
|
20037
|
+
*/
|
|
20038
|
+
display_id: string;
|
|
20039
|
+
/** Denotes the use case of the vista. */
|
|
20040
|
+
flavor?: VistaFlavor;
|
|
20041
|
+
/**
|
|
20042
|
+
* Parent vista ID.
|
|
20043
|
+
* @format id
|
|
20044
|
+
* @example "VISTA-12345"
|
|
20045
|
+
*/
|
|
20046
|
+
id: string;
|
|
20047
|
+
/**
|
|
20048
|
+
* Name of the parent vista.
|
|
20049
|
+
* @format text
|
|
20050
|
+
*/
|
|
20051
|
+
name: string;
|
|
20052
|
+
}
|
|
20053
|
+
/** Type of DevRev object for which the vista group item is applicable. */
|
|
20054
|
+
export declare enum VistaGroupItemGroupObjectType {
|
|
20055
|
+
Conversation = "conversation",
|
|
20056
|
+
Part = "part",
|
|
20057
|
+
Work = "work"
|
|
20058
|
+
}
|
|
19334
20059
|
/** Defines the state of the group item. */
|
|
19335
20060
|
export declare enum VistaGroupItemState {
|
|
19336
20061
|
Active = "active",
|
|
@@ -19356,42 +20081,304 @@ export interface VistaGroupItemSummary {
|
|
|
19356
20081
|
*/
|
|
19357
20082
|
id: string;
|
|
19358
20083
|
/**
|
|
19359
|
-
* Name of the group.
|
|
19360
|
-
* @format text
|
|
20084
|
+
* Name of the group.
|
|
20085
|
+
* @format text
|
|
20086
|
+
*/
|
|
20087
|
+
name: string;
|
|
20088
|
+
/**
|
|
20089
|
+
* Timestamp when the vista starts.
|
|
20090
|
+
* @format date-time
|
|
20091
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
20092
|
+
*/
|
|
20093
|
+
start_date?: string;
|
|
20094
|
+
/** Defines the state of the group item. */
|
|
20095
|
+
state?: VistaGroupItemState;
|
|
20096
|
+
}
|
|
20097
|
+
/** Type of the group object. */
|
|
20098
|
+
export declare enum VistaGroupItemType {
|
|
20099
|
+
Curated = "curated",
|
|
20100
|
+
Dynamic = "dynamic"
|
|
20101
|
+
}
|
|
20102
|
+
/** vista-search-summary */
|
|
20103
|
+
export type VistaSearchSummary = SearchSummaryBase & {
|
|
20104
|
+
/** Represents a collection of DevRev objects. */
|
|
20105
|
+
vista: VistaSummary;
|
|
20106
|
+
};
|
|
20107
|
+
/**
|
|
20108
|
+
* vista-summary
|
|
20109
|
+
* Represents a collection of DevRev objects.
|
|
20110
|
+
*/
|
|
20111
|
+
export type VistaSummary = (CuratedVistaSummary | DynamicVistaSummary | GroupedVistaSummary) & {
|
|
20112
|
+
/** Type of vista object. */
|
|
20113
|
+
type: VistaType;
|
|
20114
|
+
};
|
|
20115
|
+
/** Type of vista object. */
|
|
20116
|
+
export declare enum VistaType {
|
|
20117
|
+
Curated = "curated",
|
|
20118
|
+
Dynamic = "dynamic",
|
|
20119
|
+
Grouped = "grouped"
|
|
20120
|
+
}
|
|
20121
|
+
/**
|
|
20122
|
+
* vistas-create-request
|
|
20123
|
+
* The request to create new vista.
|
|
20124
|
+
*/
|
|
20125
|
+
export type VistasCreateRequest = VistasCreateRequestDynamicVista & {
|
|
20126
|
+
/** Type of vista object. */
|
|
20127
|
+
type: VistaType;
|
|
20128
|
+
custom_view?: CustomView;
|
|
20129
|
+
/**
|
|
20130
|
+
* Description of the vista.
|
|
20131
|
+
* @format text
|
|
20132
|
+
*/
|
|
20133
|
+
description?: string;
|
|
20134
|
+
/**
|
|
20135
|
+
* Name of the vista.
|
|
20136
|
+
* @format text
|
|
20137
|
+
*/
|
|
20138
|
+
name: string;
|
|
20139
|
+
/** Users and groups associated with vista. */
|
|
20140
|
+
shared_with?: SetSharedWithMembership[];
|
|
20141
|
+
};
|
|
20142
|
+
/** vistas-create-request-dynamic-vista */
|
|
20143
|
+
export type VistasCreateRequestDynamicVista = VistasCreateRequestDynamicVistaMeetingsVista & {
|
|
20144
|
+
/** Type of DevRev object for which the vista is applicable. */
|
|
20145
|
+
filter_type: DynamicVistaFilterType;
|
|
20146
|
+
};
|
|
20147
|
+
/** vistas-create-request-dynamic-vista-meetings-vista */
|
|
20148
|
+
export interface VistasCreateRequestDynamicVistaMeetingsVista {
|
|
20149
|
+
filter: MeetingsVistaFilter;
|
|
20150
|
+
/** Pinned items associated with the vista. */
|
|
20151
|
+
items?: VistasCreateRequestDynamicVistaMeetingsVistaItemValue[];
|
|
20152
|
+
}
|
|
20153
|
+
/** vistas-create-request-dynamic-vista-meetings-vista-item-value */
|
|
20154
|
+
export interface VistasCreateRequestDynamicVistaMeetingsVistaItemValue {
|
|
20155
|
+
/**
|
|
20156
|
+
* The ID of the item.
|
|
20157
|
+
* @format id
|
|
20158
|
+
*/
|
|
20159
|
+
id: string;
|
|
20160
|
+
}
|
|
20161
|
+
/**
|
|
20162
|
+
* vistas-create-response
|
|
20163
|
+
* The response to vista creation.
|
|
20164
|
+
*/
|
|
20165
|
+
export interface VistasCreateResponse {
|
|
20166
|
+
/** Represents a collection of DevRev objects. */
|
|
20167
|
+
vista: Vista;
|
|
20168
|
+
}
|
|
20169
|
+
/**
|
|
20170
|
+
* vistas-delete-request
|
|
20171
|
+
* The request to delete a vista.
|
|
20172
|
+
*/
|
|
20173
|
+
export interface VistasDeleteRequest {
|
|
20174
|
+
/**
|
|
20175
|
+
* The ID of the vista to delete.
|
|
20176
|
+
* @format id
|
|
20177
|
+
* @example "VISTA-12345"
|
|
20178
|
+
*/
|
|
20179
|
+
id: string;
|
|
20180
|
+
}
|
|
20181
|
+
/**
|
|
20182
|
+
* vistas-delete-response
|
|
20183
|
+
* The response when deleting a vista.
|
|
20184
|
+
*/
|
|
20185
|
+
export type VistasDeleteResponse = object;
|
|
20186
|
+
/**
|
|
20187
|
+
* vistas-get-request
|
|
20188
|
+
* The request to get a vista's information.
|
|
20189
|
+
*/
|
|
20190
|
+
export interface VistasGetRequest {
|
|
20191
|
+
/**
|
|
20192
|
+
* The vista's ID.
|
|
20193
|
+
* @format id
|
|
20194
|
+
* @example "VISTA-12345"
|
|
20195
|
+
*/
|
|
20196
|
+
id: string;
|
|
20197
|
+
}
|
|
20198
|
+
/**
|
|
20199
|
+
* vistas-get-response
|
|
20200
|
+
* The response to getting a vista's information.
|
|
20201
|
+
*/
|
|
20202
|
+
export interface VistasGetResponse {
|
|
20203
|
+
/** Represents a collection of DevRev objects. */
|
|
20204
|
+
vista: Vista;
|
|
20205
|
+
}
|
|
20206
|
+
/** vistas-groups-delete-request */
|
|
20207
|
+
export interface VistasGroupsDeleteRequest {
|
|
20208
|
+
/**
|
|
20209
|
+
* ID of the vista group item to be deleted.
|
|
20210
|
+
* @format id
|
|
20211
|
+
*/
|
|
20212
|
+
id: string;
|
|
20213
|
+
}
|
|
20214
|
+
/** vistas-groups-delete-response */
|
|
20215
|
+
export type VistasGroupsDeleteResponse = object;
|
|
20216
|
+
/**
|
|
20217
|
+
* vistas-groups-get-request
|
|
20218
|
+
* The request to get a vista group item's information.
|
|
20219
|
+
*/
|
|
20220
|
+
export interface VistasGroupsGetRequest {
|
|
20221
|
+
/**
|
|
20222
|
+
* The vista group item's ID.
|
|
20223
|
+
* @format id
|
|
20224
|
+
*/
|
|
20225
|
+
id: string;
|
|
20226
|
+
}
|
|
20227
|
+
/**
|
|
20228
|
+
* vistas-groups-get-response
|
|
20229
|
+
* The response to getting a vista group item's information.
|
|
20230
|
+
*/
|
|
20231
|
+
export interface VistasGroupsGetResponse {
|
|
20232
|
+
/** Represents a vista group item. */
|
|
20233
|
+
vista_group: VistaGroup;
|
|
20234
|
+
}
|
|
20235
|
+
/** vistas-groups-list-request */
|
|
20236
|
+
export interface VistasGroupsListRequest {
|
|
20237
|
+
/** Filters for vista group items of the specific type. */
|
|
20238
|
+
type?: GroupItemType[];
|
|
20239
|
+
/**
|
|
20240
|
+
* Filters for vista group items which have one of the parts linked as
|
|
20241
|
+
* its ancestor part or primary part.
|
|
20242
|
+
* @example ["PROD-12345"]
|
|
20243
|
+
*/
|
|
20244
|
+
ancestor_part?: string[];
|
|
20245
|
+
/** The filter for applies to part. */
|
|
20246
|
+
applies_to_part?: AppliesToPartFilter;
|
|
20247
|
+
/**
|
|
20248
|
+
* Filter for vistas group item created by any of these users.
|
|
20249
|
+
* @example ["DEVU-12345"]
|
|
20250
|
+
*/
|
|
20251
|
+
created_by?: string[];
|
|
20252
|
+
/** Provides ways to specify date ranges on objects. */
|
|
20253
|
+
created_date?: DateFilter;
|
|
20254
|
+
/**
|
|
20255
|
+
* The cursor to resume iteration from. If not provided, then
|
|
20256
|
+
* iteration starts from the beginning.
|
|
20257
|
+
* @format text
|
|
20258
|
+
*/
|
|
20259
|
+
cursor?: string;
|
|
20260
|
+
/** Provides ways to specify date ranges on objects. */
|
|
20261
|
+
end_date?: DateFilter;
|
|
20262
|
+
/** Filters for vista group items of the specific group object type. */
|
|
20263
|
+
group_object_type?: VistaGroupItemGroupObjectType[];
|
|
20264
|
+
/**
|
|
20265
|
+
* The request to get information about a list of vista groups.
|
|
20266
|
+
* @format int32
|
|
20267
|
+
*/
|
|
20268
|
+
limit?: number;
|
|
20269
|
+
/**
|
|
20270
|
+
* The iteration mode to use. If "after", then entries after the provided
|
|
20271
|
+
* cursor will be returned, or if no cursor is provided, then from the
|
|
20272
|
+
* beginning. If "before", then entries before the provided cursor will be
|
|
20273
|
+
* returned, or if no cursor is provided, then from the end. Entries will
|
|
20274
|
+
* always be returned in the specified sort-by order.
|
|
20275
|
+
*/
|
|
20276
|
+
mode?: ListMode;
|
|
20277
|
+
/** Provides ways to specify date ranges on objects. */
|
|
20278
|
+
modified_date?: DateFilter;
|
|
20279
|
+
/**
|
|
20280
|
+
* Parent ID of the vista group item.
|
|
20281
|
+
* @example ["VISTA-12345"]
|
|
20282
|
+
*/
|
|
20283
|
+
parent_id?: string[];
|
|
20284
|
+
/** Comma-separated fields to sort the objects by. */
|
|
20285
|
+
sort_by?: string[];
|
|
20286
|
+
/** Provides ways to specify date ranges on objects. */
|
|
20287
|
+
start_date?: DateFilter;
|
|
20288
|
+
/** Denotes the state of the vista group item. */
|
|
20289
|
+
state?: VistaGroupItemState[];
|
|
20290
|
+
}
|
|
20291
|
+
/**
|
|
20292
|
+
* vistas-groups-list-response
|
|
20293
|
+
* The response to listing the vistas group items.
|
|
20294
|
+
*/
|
|
20295
|
+
export interface VistasGroupsListResponse {
|
|
20296
|
+
/**
|
|
20297
|
+
* The cursor used to iterate subsequent results in accordance to the
|
|
20298
|
+
* sort order. If not set, then no later elements exist.
|
|
20299
|
+
* @format text
|
|
20300
|
+
*/
|
|
20301
|
+
next_cursor?: string;
|
|
20302
|
+
/**
|
|
20303
|
+
* The cursor used to iterate preceding results in accordance to the
|
|
20304
|
+
* sort order. If not set, then no prior elements exist.
|
|
20305
|
+
* @format text
|
|
20306
|
+
*/
|
|
20307
|
+
prev_cursor?: string;
|
|
20308
|
+
/** List of vista group items. */
|
|
20309
|
+
vista_group?: VistaGroup[];
|
|
20310
|
+
}
|
|
20311
|
+
/**
|
|
20312
|
+
* vistas-list-request
|
|
20313
|
+
* The request to get information about a list of vistas.
|
|
20314
|
+
*/
|
|
20315
|
+
export interface VistasListRequest {
|
|
20316
|
+
/** Filters for vistas of the specific type. */
|
|
20317
|
+
type?: VistaType[];
|
|
20318
|
+
/**
|
|
20319
|
+
* Filters for vistas created by any of these users.
|
|
20320
|
+
* @example ["DEVU-12345"]
|
|
20321
|
+
*/
|
|
20322
|
+
created_by?: string[];
|
|
20323
|
+
/**
|
|
20324
|
+
* The cursor to resume iteration from. If not provided, then
|
|
20325
|
+
* iteration starts from the beginning.
|
|
20326
|
+
* @format text
|
|
20327
|
+
*/
|
|
20328
|
+
cursor?: string;
|
|
20329
|
+
/** Filters for vistas of specific flavor. */
|
|
20330
|
+
flavor?: GroupedVistaFlavor[];
|
|
20331
|
+
/** Whether the default vistas should be fetched or not. */
|
|
20332
|
+
is_default?: boolean;
|
|
20333
|
+
/**
|
|
20334
|
+
* The maximum number of vistas to return. The default is '50', the
|
|
20335
|
+
* maximum is '100'.
|
|
20336
|
+
* @format int32
|
|
20337
|
+
*/
|
|
20338
|
+
limit?: number;
|
|
20339
|
+
/**
|
|
20340
|
+
* Filters for vistas accessible to the input members.
|
|
20341
|
+
* @example ["DEVU-12345"]
|
|
19361
20342
|
*/
|
|
19362
|
-
|
|
20343
|
+
members?: string[];
|
|
19363
20344
|
/**
|
|
19364
|
-
*
|
|
19365
|
-
*
|
|
19366
|
-
*
|
|
20345
|
+
* The iteration mode to use. If "after", then entries after the provided
|
|
20346
|
+
* cursor will be returned, or if no cursor is provided, then from the
|
|
20347
|
+
* beginning. If "before", then entries before the provided cursor will be
|
|
20348
|
+
* returned, or if no cursor is provided, then from the end. Entries will
|
|
20349
|
+
* always be returned in the specified sort-by order.
|
|
19367
20350
|
*/
|
|
19368
|
-
|
|
19369
|
-
/**
|
|
19370
|
-
|
|
19371
|
-
|
|
19372
|
-
|
|
19373
|
-
|
|
19374
|
-
|
|
19375
|
-
|
|
20351
|
+
mode?: ListMode;
|
|
20352
|
+
/** Filters for vistas of specific object types like works, parts etc. */
|
|
20353
|
+
object_type?: DynamicVistaFilterType[];
|
|
20354
|
+
/** Filter for vistas accessible to the input members. */
|
|
20355
|
+
shared_with?: SharedWithMembershipFilter[];
|
|
20356
|
+
/** Denotes whether to skip items of vista_group_item in response. */
|
|
20357
|
+
skip_items?: boolean;
|
|
20358
|
+
/** Fields to sort the vistas by and the direction to sort them. */
|
|
20359
|
+
sort_by?: string[];
|
|
20360
|
+
/** Denotes the state of the vista group item. */
|
|
20361
|
+
state?: VistaGroupItemState[];
|
|
19376
20362
|
}
|
|
19377
|
-
/** vista-search-summary */
|
|
19378
|
-
export type VistaSearchSummary = SearchSummaryBase & {
|
|
19379
|
-
/** Represents a collection of DevRev objects. */
|
|
19380
|
-
vista: VistaSummary;
|
|
19381
|
-
};
|
|
19382
20363
|
/**
|
|
19383
|
-
*
|
|
19384
|
-
*
|
|
20364
|
+
* vistas-list-response
|
|
20365
|
+
* The response to listing the vistas.
|
|
19385
20366
|
*/
|
|
19386
|
-
export
|
|
19387
|
-
/**
|
|
19388
|
-
|
|
19389
|
-
|
|
19390
|
-
|
|
19391
|
-
|
|
19392
|
-
|
|
19393
|
-
|
|
19394
|
-
|
|
20367
|
+
export interface VistasListResponse {
|
|
20368
|
+
/**
|
|
20369
|
+
* The cursor used to iterate subsequent results in accordance to the
|
|
20370
|
+
* sort order. If not set, then no later elements exist.
|
|
20371
|
+
* @format text
|
|
20372
|
+
*/
|
|
20373
|
+
next_cursor?: string;
|
|
20374
|
+
/**
|
|
20375
|
+
* The cursor used to iterate preceding results in accordance to the
|
|
20376
|
+
* sort order. If not set, then no prior elements exist.
|
|
20377
|
+
* @format text
|
|
20378
|
+
*/
|
|
20379
|
+
prev_cursor?: string;
|
|
20380
|
+
/** The list of vistas. */
|
|
20381
|
+
vistas: Vista[];
|
|
19395
20382
|
}
|
|
19396
20383
|
/**
|
|
19397
20384
|
* visualization-axis-color
|
|
@@ -19560,7 +20547,10 @@ export interface WebCrawlerJobsCreateRequest {
|
|
|
19560
20547
|
* @format text
|
|
19561
20548
|
*/
|
|
19562
20549
|
accept_regex?: string;
|
|
19563
|
-
/**
|
|
20550
|
+
/**
|
|
20551
|
+
* The list of regexes a URL must satisfy to be crawled.
|
|
20552
|
+
* @maxItems 100
|
|
20553
|
+
*/
|
|
19564
20554
|
accept_regexes?: string[];
|
|
19565
20555
|
/**
|
|
19566
20556
|
* The parts to which created webpage/articles during this crawler job
|
|
@@ -19605,13 +20595,23 @@ export interface WebCrawlerJobsCreateRequest {
|
|
|
19605
20595
|
* The list of regexes which if satisfied by a URL results in
|
|
19606
20596
|
* rejection of the URL. If a URL matches both accept and reject
|
|
19607
20597
|
* regexes, it is rejected.
|
|
20598
|
+
* @maxItems 100
|
|
19608
20599
|
*/
|
|
19609
20600
|
reject_regexes?: string[];
|
|
19610
|
-
/**
|
|
20601
|
+
/**
|
|
20602
|
+
* The list of sitemap index URLs to crawl.
|
|
20603
|
+
* @maxItems 2
|
|
20604
|
+
*/
|
|
19611
20605
|
sitemap_index_urls?: string[];
|
|
19612
|
-
/**
|
|
20606
|
+
/**
|
|
20607
|
+
* The list of sitemap URLs to crawl.
|
|
20608
|
+
* @maxItems 2
|
|
20609
|
+
*/
|
|
19613
20610
|
sitemap_urls?: string[];
|
|
19614
|
-
/**
|
|
20611
|
+
/**
|
|
20612
|
+
* The list of URLs to crawl.
|
|
20613
|
+
* @maxItems 50
|
|
20614
|
+
*/
|
|
19615
20615
|
urls?: string[];
|
|
19616
20616
|
/**
|
|
19617
20617
|
* User agent to use for crawling websites in this job.
|
|
@@ -19727,6 +20727,9 @@ export interface WebhookEventRequest {
|
|
|
19727
20727
|
account_deleted?: EventAccountDeleted;
|
|
19728
20728
|
account_updated?: EventAccountUpdated;
|
|
19729
20729
|
ai_agent_response?: EventAiAgentResponse;
|
|
20730
|
+
article_created?: EventArticleCreated;
|
|
20731
|
+
article_deleted?: EventArticleDeleted;
|
|
20732
|
+
article_updated?: EventArticleUpdated;
|
|
19730
20733
|
conversation_created?: EventConversationCreated;
|
|
19731
20734
|
conversation_deleted?: EventConversationDeleted;
|
|
19732
20735
|
conversation_updated?: EventConversationUpdated;
|
|
@@ -19825,6 +20828,9 @@ export declare enum WebhookEventType {
|
|
|
19825
20828
|
AccountDeleted = "account_deleted",
|
|
19826
20829
|
AccountUpdated = "account_updated",
|
|
19827
20830
|
AiAgentResponse = "ai_agent_response",
|
|
20831
|
+
ArticleCreated = "article_created",
|
|
20832
|
+
ArticleDeleted = "article_deleted",
|
|
20833
|
+
ArticleUpdated = "article_updated",
|
|
19828
20834
|
ConversationCreated = "conversation_created",
|
|
19829
20835
|
ConversationDeleted = "conversation_deleted",
|
|
19830
20836
|
ConversationUpdated = "conversation_updated",
|
|
@@ -20858,6 +21864,11 @@ export interface WorksCreateRequestTicket {
|
|
|
20858
21864
|
* @format text
|
|
20859
21865
|
*/
|
|
20860
21866
|
source_channel?: string;
|
|
21867
|
+
/**
|
|
21868
|
+
* Source channel ID of the ticket.
|
|
21869
|
+
* @format id
|
|
21870
|
+
*/
|
|
21871
|
+
source_channel_v2?: string;
|
|
20861
21872
|
}
|
|
20862
21873
|
/** works-create-response */
|
|
20863
21874
|
export interface WorksCreateResponse {
|
|
@@ -21014,6 +22025,11 @@ export interface WorksFilterTicket {
|
|
|
21014
22025
|
sla_summary?: SlaSummaryFilter;
|
|
21015
22026
|
/** Filters for tickets with any of the provided source channels. */
|
|
21016
22027
|
source_channel?: string[];
|
|
22028
|
+
/**
|
|
22029
|
+
* Filters for tickets that are associated with any of the source
|
|
22030
|
+
* channels.
|
|
22031
|
+
*/
|
|
22032
|
+
source_channel_v2?: string[];
|
|
21017
22033
|
/** Filters for tickets with any of the provided subtypes. */
|
|
21018
22034
|
subtype?: string[];
|
|
21019
22035
|
/** The filter for survey aggregation. */
|
|
@@ -21492,6 +22508,11 @@ export interface WorksUpdateRequestTicket {
|
|
|
21492
22508
|
sentiment_summary?: string;
|
|
21493
22509
|
/** Severity of the ticket. */
|
|
21494
22510
|
severity?: TicketSeverity;
|
|
22511
|
+
/**
|
|
22512
|
+
* Updates the source channel of the ticket.
|
|
22513
|
+
* @format id
|
|
22514
|
+
*/
|
|
22515
|
+
source_channel_v2?: string | null;
|
|
21495
22516
|
}
|
|
21496
22517
|
/** works-update-request-ticket-channels */
|
|
21497
22518
|
export interface WorksUpdateRequestTicketChannels {
|
|
@@ -21502,6 +22523,19 @@ export interface WorksUpdateRequestTicketChannels {
|
|
|
21502
22523
|
export interface WorksUpdateResponse {
|
|
21503
22524
|
work: Work;
|
|
21504
22525
|
}
|
|
22526
|
+
/**
|
|
22527
|
+
* works-vista-group-item
|
|
22528
|
+
* Represents a nested works vista group object.
|
|
22529
|
+
*/
|
|
22530
|
+
export type WorksVistaGroupItem = VistaGroupBase & {
|
|
22531
|
+
/** Type of works vista group item. */
|
|
22532
|
+
type: WorksVistaGroupItemType;
|
|
22533
|
+
};
|
|
22534
|
+
/** Type of works vista group item. */
|
|
22535
|
+
export declare enum WorksVistaGroupItemType {
|
|
22536
|
+
Curated = "curated",
|
|
22537
|
+
Dynamic = "dynamic"
|
|
22538
|
+
}
|
|
21505
22539
|
import { AxiosInstance, AxiosRequestConfig, AxiosResponse, ResponseType } from 'axios';
|
|
21506
22540
|
export type QueryParamsType = Record<string | number, any>;
|
|
21507
22541
|
export interface FullRequestParams extends Omit<AxiosRequestConfig, 'data' | 'params' | 'url' | 'responseType'> {
|
|
@@ -21917,6 +22951,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
21917
22951
|
* @example ["DEVU-12345"]
|
|
21918
22952
|
*/
|
|
21919
22953
|
owned_by?: string[];
|
|
22954
|
+
/** Filters for articles with the provided parent directories. */
|
|
22955
|
+
parent?: string[];
|
|
21920
22956
|
/** Filter for the scope of the articles. */
|
|
21921
22957
|
scope?: number[];
|
|
21922
22958
|
/**
|
|
@@ -21981,12 +23017,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
21981
23017
|
* @example "ARTICLE-12345"
|
|
21982
23018
|
*/
|
|
21983
23019
|
id: string;
|
|
21984
|
-
/**
|
|
21985
|
-
* Optional Dev Org ID for the unauthenticated user.
|
|
21986
|
-
* @format id
|
|
21987
|
-
* @example "DEV-AbCdEfGh"
|
|
21988
|
-
*/
|
|
21989
|
-
dev_org?: string;
|
|
21990
23020
|
}, params?: RequestParams) => Promise<AxiosResponse<ArticlesGetResponse, any>>;
|
|
21991
23021
|
/**
|
|
21992
23022
|
* @description Gets an article.
|
|
@@ -22036,12 +23066,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
22036
23066
|
* @format text
|
|
22037
23067
|
*/
|
|
22038
23068
|
cursor?: string;
|
|
22039
|
-
/**
|
|
22040
|
-
* Optional Dev Org ID for the unauthenticated user.
|
|
22041
|
-
* @format id
|
|
22042
|
-
* @example "DEV-AbCdEfGh"
|
|
22043
|
-
*/
|
|
22044
|
-
dev_org?: string;
|
|
22045
23069
|
/**
|
|
22046
23070
|
* The maximum number of articles to return. The default is '50'.
|
|
22047
23071
|
* @format int32
|
|
@@ -22062,6 +23086,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
22062
23086
|
* @example ["DEVU-12345"]
|
|
22063
23087
|
*/
|
|
22064
23088
|
owned_by?: string[];
|
|
23089
|
+
/** Filters for articles with the provided parent directories. */
|
|
23090
|
+
parent?: string[];
|
|
22065
23091
|
/** Filter for the scope of the articles. */
|
|
22066
23092
|
scope?: number[];
|
|
22067
23093
|
/**
|
|
@@ -22888,6 +23914,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
22888
23914
|
'sla_summary.stage'?: SlaSummaryStage[];
|
|
22889
23915
|
/** Filters for conversations with any of the provided source channels. */
|
|
22890
23916
|
source_channel?: string[];
|
|
23917
|
+
/**
|
|
23918
|
+
* Filters for conversations that are associated with the source
|
|
23919
|
+
* channel.
|
|
23920
|
+
*/
|
|
23921
|
+
source_channel_v2?: string[];
|
|
22891
23922
|
/**
|
|
22892
23923
|
* Filters for conversations with any of the provided source channels.
|
|
22893
23924
|
* @deprecated
|
|
@@ -23042,6 +24073,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
23042
24073
|
'sla_summary.stage'?: SlaSummaryStage[];
|
|
23043
24074
|
/** Filters for conversations with any of the provided source channels. */
|
|
23044
24075
|
source_channel?: string[];
|
|
24076
|
+
/**
|
|
24077
|
+
* Filters for conversations that are associated with the source
|
|
24078
|
+
* channel.
|
|
24079
|
+
*/
|
|
24080
|
+
source_channel_v2?: string[];
|
|
23045
24081
|
/**
|
|
23046
24082
|
* Filters for conversations with any of the provided source channels.
|
|
23047
24083
|
* @deprecated
|
|
@@ -23577,12 +24613,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
23577
24613
|
* @format id
|
|
23578
24614
|
*/
|
|
23579
24615
|
id: string;
|
|
23580
|
-
/**
|
|
23581
|
-
* Optional Dev Org ID for the unauthenticated user.
|
|
23582
|
-
* @format id
|
|
23583
|
-
* @example "DEV-AbCdEfGh"
|
|
23584
|
-
*/
|
|
23585
|
-
dev_org?: string;
|
|
23586
24616
|
}, params?: RequestParams) => Promise<AxiosResponse<DirectoriesGetResponse, any>>;
|
|
23587
24617
|
/**
|
|
23588
24618
|
* @description Gets the specified directory.
|
|
@@ -23615,12 +24645,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
23615
24645
|
* @format text
|
|
23616
24646
|
*/
|
|
23617
24647
|
cursor?: string;
|
|
23618
|
-
/**
|
|
23619
|
-
* Optional Dev Org ID for the unauthenticated user.
|
|
23620
|
-
* @format id
|
|
23621
|
-
* @example "DEV-AbCdEfGh"
|
|
23622
|
-
*/
|
|
23623
|
-
dev_org?: string;
|
|
23624
24648
|
/**
|
|
23625
24649
|
* The maximum number of directories to return. The default is '50'.
|
|
23626
24650
|
* @format int32
|
|
@@ -24644,6 +25668,22 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
24644
25668
|
parent?: string[];
|
|
24645
25669
|
/** Filters for meeting on specified state or outcomes. */
|
|
24646
25670
|
state?: MeetingState[];
|
|
25671
|
+
/** Filters for issues with this specific external reference. */
|
|
25672
|
+
'sync_metadata.external_reference'?: string[];
|
|
25673
|
+
/** Filters for works with selected sync statuses. */
|
|
25674
|
+
'sync_metadata.last_sync_in.status'?: SyncMetadataFilterSyncInFilterStatus[];
|
|
25675
|
+
/** Filters for works modified with selected sync history. */
|
|
25676
|
+
'sync_metadata.last_sync_in.sync_history'?: string[];
|
|
25677
|
+
/** Filters for works modified with selected sync units. */
|
|
25678
|
+
'sync_metadata.last_sync_in.sync_unit'?: string[];
|
|
25679
|
+
/** Filters for works with selected sync statuses. */
|
|
25680
|
+
'sync_metadata.last_sync_out.status'?: SyncMetadataFilterSyncOutFilterStatus[];
|
|
25681
|
+
/** Filters for works modified with selected sync history. */
|
|
25682
|
+
'sync_metadata.last_sync_out.sync_history'?: string[];
|
|
25683
|
+
/** Filters for works modified with selected sync units. */
|
|
25684
|
+
'sync_metadata.last_sync_out.sync_unit'?: string[];
|
|
25685
|
+
/** Filters for issues synced from this specific origin system. */
|
|
25686
|
+
'sync_metadata.origin_system'?: string[];
|
|
24647
25687
|
/** Filters for meeting by tags. */
|
|
24648
25688
|
tags?: string[];
|
|
24649
25689
|
}, params?: RequestParams) => Promise<AxiosResponse<MeetingsCountResponse, any>>;
|
|
@@ -24766,6 +25806,22 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
24766
25806
|
sort_by?: string[];
|
|
24767
25807
|
/** Filters for meeting on specified state or outcomes. */
|
|
24768
25808
|
state?: MeetingState[];
|
|
25809
|
+
/** Filters for issues with this specific external reference. */
|
|
25810
|
+
'sync_metadata.external_reference'?: string[];
|
|
25811
|
+
/** Filters for works with selected sync statuses. */
|
|
25812
|
+
'sync_metadata.last_sync_in.status'?: SyncMetadataFilterSyncInFilterStatus[];
|
|
25813
|
+
/** Filters for works modified with selected sync history. */
|
|
25814
|
+
'sync_metadata.last_sync_in.sync_history'?: string[];
|
|
25815
|
+
/** Filters for works modified with selected sync units. */
|
|
25816
|
+
'sync_metadata.last_sync_in.sync_unit'?: string[];
|
|
25817
|
+
/** Filters for works with selected sync statuses. */
|
|
25818
|
+
'sync_metadata.last_sync_out.status'?: SyncMetadataFilterSyncOutFilterStatus[];
|
|
25819
|
+
/** Filters for works modified with selected sync history. */
|
|
25820
|
+
'sync_metadata.last_sync_out.sync_history'?: string[];
|
|
25821
|
+
/** Filters for works modified with selected sync units. */
|
|
25822
|
+
'sync_metadata.last_sync_out.sync_unit'?: string[];
|
|
25823
|
+
/** Filters for issues synced from this specific origin system. */
|
|
25824
|
+
'sync_metadata.origin_system'?: string[];
|
|
24769
25825
|
/** Filters for meeting by tags. */
|
|
24770
25826
|
tags?: string[];
|
|
24771
25827
|
}, params?: RequestParams) => Promise<AxiosResponse<MeetingsListResponse, any>>;
|
|
@@ -25324,6 +26380,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
25324
26380
|
* @example ["PROD-12345"]
|
|
25325
26381
|
*/
|
|
25326
26382
|
'parent_part.parts'?: string[];
|
|
26383
|
+
/** Fields to sort the parts by and the direction to sort them. */
|
|
26384
|
+
sort_by?: string[];
|
|
25327
26385
|
/** Filters for subtypes. */
|
|
25328
26386
|
subtype?: string[];
|
|
25329
26387
|
/**
|
|
@@ -26137,8 +27195,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
26137
27195
|
* @secure
|
|
26138
27196
|
*/
|
|
26139
27197
|
aggregatedSchemaGet: (query?: {
|
|
26140
|
-
/** The
|
|
26141
|
-
|
|
27198
|
+
/** The custom schema fragment IDs which are to be aggregated. */
|
|
27199
|
+
custom_schema_fragments?: string[];
|
|
26142
27200
|
/** List of apps. */
|
|
26143
27201
|
'custom_schema_spec.apps'?: string[];
|
|
26144
27202
|
/**
|
|
@@ -26158,7 +27216,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
26158
27216
|
* The stock schema fragment which is to be aggregated.
|
|
26159
27217
|
* @format id
|
|
26160
27218
|
*/
|
|
26161
|
-
|
|
27219
|
+
stock_schema_fragment?: string;
|
|
26162
27220
|
}, params?: RequestParams) => Promise<AxiosResponse<AggregatedSchemaGetResponse, any>>;
|
|
26163
27221
|
/**
|
|
26164
27222
|
* @description Gets the aggregated schema.
|
|
@@ -27773,6 +28831,233 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
27773
28831
|
* @secure
|
|
27774
28832
|
*/
|
|
27775
28833
|
uomsUpdate: (data: UomsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<UomsUpdateResponse, any>>;
|
|
28834
|
+
/**
|
|
28835
|
+
* @description Creates a vista.
|
|
28836
|
+
*
|
|
28837
|
+
* @tags vistas
|
|
28838
|
+
* @name VistasCreate
|
|
28839
|
+
* @summary Create Vista
|
|
28840
|
+
* @request POST:/vistas.create
|
|
28841
|
+
* @secure
|
|
28842
|
+
*/
|
|
28843
|
+
vistasCreate: (data: VistasCreateRequest, params?: RequestParams) => Promise<AxiosResponse<VistasCreateResponse, any>>;
|
|
28844
|
+
/**
|
|
28845
|
+
* @description Deletes the requested vista.
|
|
28846
|
+
*
|
|
28847
|
+
* @tags vistas
|
|
28848
|
+
* @name VistasDelete
|
|
28849
|
+
* @summary Delete Vista
|
|
28850
|
+
* @request POST:/vistas.delete
|
|
28851
|
+
* @secure
|
|
28852
|
+
*/
|
|
28853
|
+
vistasDelete: (data: VistasDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
|
|
28854
|
+
/**
|
|
28855
|
+
* @description Gets the requested vistas's information.
|
|
28856
|
+
*
|
|
28857
|
+
* @tags vistas
|
|
28858
|
+
* @name VistasGet
|
|
28859
|
+
* @summary Get Vista
|
|
28860
|
+
* @request GET:/vistas.get
|
|
28861
|
+
* @secure
|
|
28862
|
+
*/
|
|
28863
|
+
vistasGet: (query: {
|
|
28864
|
+
/**
|
|
28865
|
+
* The vista's ID.
|
|
28866
|
+
* @format id
|
|
28867
|
+
* @example "VISTA-12345"
|
|
28868
|
+
*/
|
|
28869
|
+
id: string;
|
|
28870
|
+
}, params?: RequestParams) => Promise<AxiosResponse<VistasGetResponse, any>>;
|
|
28871
|
+
/**
|
|
28872
|
+
* @description Gets the requested vistas's information.
|
|
28873
|
+
*
|
|
28874
|
+
* @tags vistas
|
|
28875
|
+
* @name VistasGetPost
|
|
28876
|
+
* @summary Get Vista (POST)
|
|
28877
|
+
* @request POST:/vistas.get
|
|
28878
|
+
* @secure
|
|
28879
|
+
*/
|
|
28880
|
+
vistasGetPost: (data: VistasGetRequest, params?: RequestParams) => Promise<AxiosResponse<VistasGetResponse, any>>;
|
|
28881
|
+
/**
|
|
28882
|
+
* @description Deletes the requested vista group item
|
|
28883
|
+
*
|
|
28884
|
+
* @tags vistas
|
|
28885
|
+
* @name VistasGroupsDelete
|
|
28886
|
+
* @summary Delete Vistas Group
|
|
28887
|
+
* @request POST:/vistas.groups.delete
|
|
28888
|
+
* @secure
|
|
28889
|
+
*/
|
|
28890
|
+
vistasGroupsDelete: (data: VistasGroupsDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
|
|
28891
|
+
/**
|
|
28892
|
+
* @description Gets the requested vista group item's information.
|
|
28893
|
+
*
|
|
28894
|
+
* @tags vistas
|
|
28895
|
+
* @name VistasGroupsGet
|
|
28896
|
+
* @summary Get Vistas Group
|
|
28897
|
+
* @request GET:/vistas.groups.get
|
|
28898
|
+
* @secure
|
|
28899
|
+
*/
|
|
28900
|
+
vistasGroupsGet: (query: {
|
|
28901
|
+
/**
|
|
28902
|
+
* The vista group item's ID.
|
|
28903
|
+
* @format id
|
|
28904
|
+
*/
|
|
28905
|
+
id: string;
|
|
28906
|
+
}, params?: RequestParams) => Promise<AxiosResponse<VistasGroupsGetResponse, any>>;
|
|
28907
|
+
/**
|
|
28908
|
+
* @description Gets the requested vista group item's information.
|
|
28909
|
+
*
|
|
28910
|
+
* @tags vistas
|
|
28911
|
+
* @name VistasGroupsGetPost
|
|
28912
|
+
* @summary Get Vistas Group (POST)
|
|
28913
|
+
* @request POST:/vistas.groups.get
|
|
28914
|
+
* @secure
|
|
28915
|
+
*/
|
|
28916
|
+
vistasGroupsGetPost: (data: VistasGroupsGetRequest, params?: RequestParams) => Promise<AxiosResponse<VistasGroupsGetResponse, any>>;
|
|
28917
|
+
/**
|
|
28918
|
+
* @description Lists the available vista group items.
|
|
28919
|
+
*
|
|
28920
|
+
* @tags vistas
|
|
28921
|
+
* @name VistasGroupsList
|
|
28922
|
+
* @summary List Vistas Groups
|
|
28923
|
+
* @request GET:/vistas.groups.list
|
|
28924
|
+
* @secure
|
|
28925
|
+
*/
|
|
28926
|
+
vistasGroupsList: (query?: {
|
|
28927
|
+
/**
|
|
28928
|
+
* Filters for vista group items which have one of the parts linked as
|
|
28929
|
+
* its ancestor part or primary part.
|
|
28930
|
+
* @example ["PROD-12345"]
|
|
28931
|
+
*/
|
|
28932
|
+
ancestor_part?: string[];
|
|
28933
|
+
/**
|
|
28934
|
+
* Whether to include items belonging to children of any of the provided
|
|
28935
|
+
* parts.
|
|
28936
|
+
*/
|
|
28937
|
+
'applies_to_part.include_child_parts'?: boolean;
|
|
28938
|
+
/**
|
|
28939
|
+
* Part IDs to filter on. Required if any applies_to_part.* fields are
|
|
28940
|
+
* provided.
|
|
28941
|
+
* @example ["PROD-12345"]
|
|
28942
|
+
*/
|
|
28943
|
+
'applies_to_part.parts'?: string[];
|
|
28944
|
+
/**
|
|
28945
|
+
* Filter for vistas group item created by any of these users.
|
|
28946
|
+
* @example ["DEVU-12345"]
|
|
28947
|
+
*/
|
|
28948
|
+
created_by?: string[];
|
|
28949
|
+
/**
|
|
28950
|
+
* The cursor to resume iteration from. If not provided, then iteration
|
|
28951
|
+
* starts from the beginning.
|
|
28952
|
+
* @format text
|
|
28953
|
+
*/
|
|
28954
|
+
cursor?: string;
|
|
28955
|
+
/** Filters for vista group items of the specific group object type. */
|
|
28956
|
+
group_object_type?: VistaGroupItemGroupObjectType[];
|
|
28957
|
+
/**
|
|
28958
|
+
* The request to get information about a list of vista groups.
|
|
28959
|
+
* @format int32
|
|
28960
|
+
*/
|
|
28961
|
+
limit?: number;
|
|
28962
|
+
/**
|
|
28963
|
+
* The iteration mode to use, otherwise if not set, then "after" is
|
|
28964
|
+
* used.
|
|
28965
|
+
*/
|
|
28966
|
+
mode?: ListMode;
|
|
28967
|
+
/**
|
|
28968
|
+
* Parent ID of the vista group item.
|
|
28969
|
+
* @example ["VISTA-12345"]
|
|
28970
|
+
*/
|
|
28971
|
+
parent_id?: string[];
|
|
28972
|
+
/** Comma-separated fields to sort the objects by. */
|
|
28973
|
+
sort_by?: string[];
|
|
28974
|
+
/** Denotes the state of the vista group item. */
|
|
28975
|
+
state?: VistaGroupItemState[];
|
|
28976
|
+
/** Filters for vista group items of the specific type. */
|
|
28977
|
+
type?: GroupItemType[];
|
|
28978
|
+
}, params?: RequestParams) => Promise<AxiosResponse<VistasGroupsListResponse, any>>;
|
|
28979
|
+
/**
|
|
28980
|
+
* @description Lists the available vista group items.
|
|
28981
|
+
*
|
|
28982
|
+
* @tags vistas
|
|
28983
|
+
* @name VistasGroupsListPost
|
|
28984
|
+
* @summary List Vistas Groups (POST)
|
|
28985
|
+
* @request POST:/vistas.groups.list
|
|
28986
|
+
* @secure
|
|
28987
|
+
*/
|
|
28988
|
+
vistasGroupsListPost: (data: VistasGroupsListRequest, params?: RequestParams) => Promise<AxiosResponse<VistasGroupsListResponse, any>>;
|
|
28989
|
+
/**
|
|
28990
|
+
* @description Lists the available vistas.
|
|
28991
|
+
*
|
|
28992
|
+
* @tags vistas
|
|
28993
|
+
* @name VistasList
|
|
28994
|
+
* @summary List Vistas
|
|
28995
|
+
* @request GET:/vistas.list
|
|
28996
|
+
* @secure
|
|
28997
|
+
*/
|
|
28998
|
+
vistasList: (query?: {
|
|
28999
|
+
/**
|
|
29000
|
+
* Filters for vistas created by any of these users.
|
|
29001
|
+
* @example ["DEVU-12345"]
|
|
29002
|
+
*/
|
|
29003
|
+
created_by?: string[];
|
|
29004
|
+
/**
|
|
29005
|
+
* The cursor to resume iteration from. If not provided, then iteration
|
|
29006
|
+
* starts from the beginning.
|
|
29007
|
+
* @format text
|
|
29008
|
+
*/
|
|
29009
|
+
cursor?: string;
|
|
29010
|
+
/** Filters for vistas of specific flavor. */
|
|
29011
|
+
flavor?: GroupedVistaFlavor[];
|
|
29012
|
+
/** Whether the default vistas should be fetched or not. */
|
|
29013
|
+
is_default?: boolean;
|
|
29014
|
+
/**
|
|
29015
|
+
* The maximum number of vistas to return. The default is '50', the
|
|
29016
|
+
* maximum is '100'.
|
|
29017
|
+
* @format int32
|
|
29018
|
+
*/
|
|
29019
|
+
limit?: number;
|
|
29020
|
+
/**
|
|
29021
|
+
* Filters for vistas accessible to the input members.
|
|
29022
|
+
* @example ["DEVU-12345"]
|
|
29023
|
+
*/
|
|
29024
|
+
members?: string[];
|
|
29025
|
+
/**
|
|
29026
|
+
* The iteration mode to use, otherwise if not set, then "after" is
|
|
29027
|
+
* used.
|
|
29028
|
+
*/
|
|
29029
|
+
mode?: ListMode;
|
|
29030
|
+
/** Filters for vistas of specific object types like works, parts etc. */
|
|
29031
|
+
object_type?: DynamicVistaFilterType[];
|
|
29032
|
+
/**
|
|
29033
|
+
* ID of the group/member with whom the item is shared.
|
|
29034
|
+
* @format id
|
|
29035
|
+
*/
|
|
29036
|
+
'shared_with.member'?: string;
|
|
29037
|
+
/**
|
|
29038
|
+
* Role ID of the group/member with whom the item is shared.
|
|
29039
|
+
* @format id
|
|
29040
|
+
*/
|
|
29041
|
+
'shared_with.role'?: string;
|
|
29042
|
+
/** Denotes whether to skip items of vista_group_item in response. */
|
|
29043
|
+
skip_items?: boolean;
|
|
29044
|
+
/** Fields to sort the vistas by and the direction to sort them. */
|
|
29045
|
+
sort_by?: string[];
|
|
29046
|
+
/** Denotes the state of the vista group item. */
|
|
29047
|
+
state?: VistaGroupItemState[];
|
|
29048
|
+
/** Filters for vistas of the specific type. */
|
|
29049
|
+
type?: VistaType[];
|
|
29050
|
+
}, params?: RequestParams) => Promise<AxiosResponse<VistasListResponse, any>>;
|
|
29051
|
+
/**
|
|
29052
|
+
* @description Lists the available vistas.
|
|
29053
|
+
*
|
|
29054
|
+
* @tags vistas
|
|
29055
|
+
* @name VistasListPost
|
|
29056
|
+
* @summary List Vistas (POST)
|
|
29057
|
+
* @request POST:/vistas.list
|
|
29058
|
+
* @secure
|
|
29059
|
+
*/
|
|
29060
|
+
vistasListPost: (data: VistasListRequest, params?: RequestParams) => Promise<AxiosResponse<VistasListResponse, any>>;
|
|
27776
29061
|
/**
|
|
27777
29062
|
* @description Change state of a web crawler job to pause or resume it back to running.
|
|
27778
29063
|
*
|
|
@@ -28137,6 +29422,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
28137
29422
|
'ticket.sla_summary.stage'?: SlaSummaryStage[];
|
|
28138
29423
|
/** Filters for tickets with any of the provided source channels. */
|
|
28139
29424
|
'ticket.source_channel'?: string[];
|
|
29425
|
+
/**
|
|
29426
|
+
* Filters for tickets that are associated with any of the source
|
|
29427
|
+
* channels.
|
|
29428
|
+
*/
|
|
29429
|
+
'ticket.source_channel_v2'?: string[];
|
|
28140
29430
|
/** Filters for tickets with any of the provided subtypes. */
|
|
28141
29431
|
'ticket.subtype'?: string[];
|
|
28142
29432
|
/** Filters for work of the provided types. */
|
|
@@ -28321,6 +29611,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
28321
29611
|
'ticket.sla_summary.stage'?: SlaSummaryStage[];
|
|
28322
29612
|
/** Filters for tickets with any of the provided source channels. */
|
|
28323
29613
|
'ticket.source_channel'?: string[];
|
|
29614
|
+
/**
|
|
29615
|
+
* Filters for tickets that are associated with any of the source
|
|
29616
|
+
* channels.
|
|
29617
|
+
*/
|
|
29618
|
+
'ticket.source_channel_v2'?: string[];
|
|
28324
29619
|
/** Filters for tickets with any of the provided subtypes. */
|
|
28325
29620
|
'ticket.subtype'?: string[];
|
|
28326
29621
|
/** Filters for work of the provided types. */
|