@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.
|
@@ -21,6 +21,7 @@ export type Account = OrgBase & {
|
|
|
21
21
|
external_refs?: string[];
|
|
22
22
|
/** List of Dev user IDs owning this Account. */
|
|
23
23
|
owned_by: UserSummary[];
|
|
24
|
+
primary_account?: AccountSummary;
|
|
24
25
|
/**
|
|
25
26
|
* The Tier of the corresponding Account.
|
|
26
27
|
* @format text
|
|
@@ -313,6 +314,85 @@ export interface AddTagWithValue {
|
|
|
313
314
|
*/
|
|
314
315
|
value?: string;
|
|
315
316
|
}
|
|
317
|
+
/**
|
|
318
|
+
* aggregated-schema
|
|
319
|
+
* List of custom fields from multiple source fragments.
|
|
320
|
+
*/
|
|
321
|
+
export interface AggregatedSchema {
|
|
322
|
+
/**
|
|
323
|
+
* Apps corresponding to the app fragments used to populate the same
|
|
324
|
+
* in the object.
|
|
325
|
+
*/
|
|
326
|
+
apps?: string[];
|
|
327
|
+
/** The conditions associated with the fields. */
|
|
328
|
+
conditions?: CustomSchemaFragmentCondition[];
|
|
329
|
+
/** List of all composite schemas used by custom fields. */
|
|
330
|
+
custom_composite_schemas: CompositeSchema[];
|
|
331
|
+
/** List of all custom fields in this schema. */
|
|
332
|
+
custom_fields: SchemaFieldDescriptor[];
|
|
333
|
+
/**
|
|
334
|
+
* Description of the schema.
|
|
335
|
+
* @format text
|
|
336
|
+
*/
|
|
337
|
+
description?: string;
|
|
338
|
+
/**
|
|
339
|
+
* True when the fragments being aggregated correspond to a custom
|
|
340
|
+
* leaf type.
|
|
341
|
+
*/
|
|
342
|
+
is_custom_leaf_type?: boolean;
|
|
343
|
+
/**
|
|
344
|
+
* Leaf type of the fragments being aggregated.
|
|
345
|
+
* @format text
|
|
346
|
+
*/
|
|
347
|
+
leaf_type?: string;
|
|
348
|
+
stage_diagram_id?: StageDiagramSummary;
|
|
349
|
+
/** List of all composite schemas used by stock fields. */
|
|
350
|
+
stock_composite_schemas: CompositeSchema[];
|
|
351
|
+
/**
|
|
352
|
+
* Optional overrides for properties of stock fields. Overrides in the
|
|
353
|
+
* custom type fragment take precedence over those defined in the
|
|
354
|
+
* tenant fragment.
|
|
355
|
+
*/
|
|
356
|
+
stock_field_overrides?: StockFieldOverride[];
|
|
357
|
+
/** List of all stock fields in this schema. */
|
|
358
|
+
stock_fields: SchemaFieldDescriptor[];
|
|
359
|
+
/**
|
|
360
|
+
* Subtype corresponding to the custom type fragment used to populate
|
|
361
|
+
* the same in the object.
|
|
362
|
+
* @format text
|
|
363
|
+
*/
|
|
364
|
+
subtype?: string;
|
|
365
|
+
/**
|
|
366
|
+
* Display name of the subtype.
|
|
367
|
+
* @format text
|
|
368
|
+
*/
|
|
369
|
+
subtype_display_name?: string;
|
|
370
|
+
}
|
|
371
|
+
/** aggregated-schema-get-request */
|
|
372
|
+
export interface AggregatedSchemaGetRequest {
|
|
373
|
+
/** The custom schema fragment IDs which are to be aggregated. */
|
|
374
|
+
custom_schema_fragments?: string[];
|
|
375
|
+
/** Custom schemas described using identifiers */
|
|
376
|
+
custom_schema_spec?: CustomSchemaSpecForRead;
|
|
377
|
+
/** Whether the leaf type corresponds to a custom object. */
|
|
378
|
+
is_custom_leaf_type?: boolean;
|
|
379
|
+
/**
|
|
380
|
+
* The leaf type. Used for inferring the default stage diagram and
|
|
381
|
+
* tenant fragment ID.
|
|
382
|
+
* @format text
|
|
383
|
+
*/
|
|
384
|
+
leaf_type?: string;
|
|
385
|
+
/**
|
|
386
|
+
* The stock schema fragment which is to be aggregated.
|
|
387
|
+
* @format id
|
|
388
|
+
*/
|
|
389
|
+
stock_schema_fragment?: string;
|
|
390
|
+
}
|
|
391
|
+
/** aggregated-schema-get-response */
|
|
392
|
+
export interface AggregatedSchemaGetResponse {
|
|
393
|
+
/** List of custom fields from multiple source fragments. */
|
|
394
|
+
schema: AggregatedSchema;
|
|
395
|
+
}
|
|
316
396
|
/**
|
|
317
397
|
* ai-agent-event-execute-error
|
|
318
398
|
* An error object providing the error message for the AI agent event
|
|
@@ -420,6 +500,22 @@ export interface AiAgentSuggestion {
|
|
|
420
500
|
*/
|
|
421
501
|
suggestion: string;
|
|
422
502
|
}
|
|
503
|
+
/**
|
|
504
|
+
* applies-to-part-filter
|
|
505
|
+
* The filter for applies to part.
|
|
506
|
+
*/
|
|
507
|
+
export interface AppliesToPartFilter {
|
|
508
|
+
/**
|
|
509
|
+
* Whether to include items belonging to children of any of the
|
|
510
|
+
* provided parts.
|
|
511
|
+
*/
|
|
512
|
+
include_child_parts?: boolean;
|
|
513
|
+
/**
|
|
514
|
+
* Part IDs to filter on.
|
|
515
|
+
* @example ["PROD-12345"]
|
|
516
|
+
*/
|
|
517
|
+
parts: string[];
|
|
518
|
+
}
|
|
423
519
|
/**
|
|
424
520
|
* archetype-metric-target
|
|
425
521
|
* Metric with corresponding target values.
|
|
@@ -601,6 +697,18 @@ export declare enum ArticleStatus {
|
|
|
601
697
|
Published = "published",
|
|
602
698
|
ReviewNeeded = "review_needed"
|
|
603
699
|
}
|
|
700
|
+
/** article-summary */
|
|
701
|
+
export type ArticleSummary = AtomBaseSummary & {
|
|
702
|
+
/** Type of the article. */
|
|
703
|
+
article_type?: ArticleType;
|
|
704
|
+
/** Resource details. */
|
|
705
|
+
resource?: ResourceSummary;
|
|
706
|
+
/**
|
|
707
|
+
* Title of the article.
|
|
708
|
+
* @format text
|
|
709
|
+
*/
|
|
710
|
+
title?: string;
|
|
711
|
+
};
|
|
604
712
|
/** Type of the article. */
|
|
605
713
|
export declare enum ArticleType {
|
|
606
714
|
Article = "article",
|
|
@@ -755,12 +863,6 @@ export type ArticlesDeleteResponse = object;
|
|
|
755
863
|
* The request to get an article.
|
|
756
864
|
*/
|
|
757
865
|
export interface ArticlesGetRequest {
|
|
758
|
-
/**
|
|
759
|
-
* Optional Dev Org ID for the unauthenticated user.
|
|
760
|
-
* @format id
|
|
761
|
-
* @example "DEV-AbCdEfGh"
|
|
762
|
-
*/
|
|
763
|
-
dev_org?: string;
|
|
764
866
|
/**
|
|
765
867
|
* The ID of the required article.
|
|
766
868
|
* @format id
|
|
@@ -808,12 +910,6 @@ export interface ArticlesListRequest {
|
|
|
808
910
|
* @format text
|
|
809
911
|
*/
|
|
810
912
|
cursor?: string;
|
|
811
|
-
/**
|
|
812
|
-
* Optional Dev Org ID for the unauthenticated user.
|
|
813
|
-
* @format id
|
|
814
|
-
* @example "DEV-AbCdEfGh"
|
|
815
|
-
*/
|
|
816
|
-
dev_org?: string;
|
|
817
913
|
/**
|
|
818
914
|
* The maximum number of articles to return. The default is '50'.
|
|
819
915
|
* @format int32
|
|
@@ -837,6 +933,8 @@ export interface ArticlesListRequest {
|
|
|
837
933
|
* @example ["DEVU-12345"]
|
|
838
934
|
*/
|
|
839
935
|
owned_by?: string[];
|
|
936
|
+
/** Filters for articles with the provided parent directories. */
|
|
937
|
+
parent?: string[];
|
|
840
938
|
/** Filter for the scope of the articles. */
|
|
841
939
|
scope?: number[];
|
|
842
940
|
/** Filter for articles based on intended audience. */
|
|
@@ -1319,7 +1417,7 @@ export interface ArtifactsVersionsPrepareResponseFormData {
|
|
|
1319
1417
|
value: string;
|
|
1320
1418
|
}
|
|
1321
1419
|
/** atom */
|
|
1322
|
-
export type Atom = (AuthToken | Capability | Conversation | DevUser | Enhancement | Feature | Group | Issue | Link | Product | RevOrg | RevUser | ServiceAccount | Sla | SlaTracker | SysUser | Tag | Ticket | TimelineComment | Webhook) & {
|
|
1420
|
+
export type Atom = (Article | AuthToken | Capability | Conversation | DevUser | Enhancement | Feature | Group | Issue | Link | Product | RevOrg | RevUser | ServiceAccount | Sla | SlaTracker | SysUser | Tag | Ticket | TimelineComment | Webhook) & {
|
|
1323
1421
|
type: AtomType;
|
|
1324
1422
|
};
|
|
1325
1423
|
/** atom-base */
|
|
@@ -1363,10 +1461,11 @@ export interface AtomBaseSummary {
|
|
|
1363
1461
|
id: string;
|
|
1364
1462
|
}
|
|
1365
1463
|
/** atom-summary */
|
|
1366
|
-
export type AtomSummary = (AuthTokenSummary | CapabilitySummary | ConversationSummary | DevUserSummary | EnhancementSummary | FeatureSummary | GroupSummary | IssueSummary | LinkSummary | ProductSummary | RevOrgSummary | RevUserSummary | ServiceAccountSummary | SlaSummary | SlaTrackerSummary | SysUserSummary | TagSummary | TicketSummary | TimelineCommentSummary | WebhookSummary) & {
|
|
1464
|
+
export type AtomSummary = (ArticleSummary | AuthTokenSummary | CapabilitySummary | ConversationSummary | DevUserSummary | EnhancementSummary | FeatureSummary | GroupSummary | IssueSummary | LinkSummary | ProductSummary | RevOrgSummary | RevUserSummary | ServiceAccountSummary | SlaSummary | SlaTrackerSummary | SysUserSummary | TagSummary | TicketSummary | TimelineCommentSummary | WebhookSummary) & {
|
|
1367
1465
|
type: AtomType;
|
|
1368
1466
|
};
|
|
1369
1467
|
export declare enum AtomType {
|
|
1468
|
+
Article = "article",
|
|
1370
1469
|
AuthToken = "auth_token",
|
|
1371
1470
|
Capability = "capability",
|
|
1372
1471
|
Conversation = "conversation",
|
|
@@ -1633,6 +1732,8 @@ export declare enum AuthTokenTokenType {
|
|
|
1633
1732
|
* Carries account info.
|
|
1634
1733
|
*/
|
|
1635
1734
|
export interface AuthTokensAccountTraits {
|
|
1735
|
+
/** Application-defined custom fields of the account. */
|
|
1736
|
+
custom_fields?: object;
|
|
1636
1737
|
/**
|
|
1637
1738
|
* The display name of the account.
|
|
1638
1739
|
* @format text
|
|
@@ -2217,6 +2318,54 @@ export interface ChatsUpdateRequestDmUsers {
|
|
|
2217
2318
|
export interface ChatsUpdateResponse {
|
|
2218
2319
|
chat: Chat;
|
|
2219
2320
|
}
|
|
2321
|
+
/**
|
|
2322
|
+
* client-override
|
|
2323
|
+
* UI hint overrides for a client.
|
|
2324
|
+
*/
|
|
2325
|
+
export interface ClientOverride {
|
|
2326
|
+
/**
|
|
2327
|
+
* The name of the client.
|
|
2328
|
+
* @format text
|
|
2329
|
+
*/
|
|
2330
|
+
client_name?: string;
|
|
2331
|
+
/**
|
|
2332
|
+
* Number of decimal places to show. Only applicable for number
|
|
2333
|
+
* fields.
|
|
2334
|
+
* @format int32
|
|
2335
|
+
*/
|
|
2336
|
+
decimal_places?: number;
|
|
2337
|
+
/**
|
|
2338
|
+
* The display name of the field.
|
|
2339
|
+
* @format text
|
|
2340
|
+
*/
|
|
2341
|
+
display_name?: string;
|
|
2342
|
+
/** Whether the field is groupable in the UI. */
|
|
2343
|
+
is_groupable?: boolean;
|
|
2344
|
+
/** Whether the field is hidden in the UI. */
|
|
2345
|
+
is_hidden?: boolean;
|
|
2346
|
+
/**
|
|
2347
|
+
* Relative order in which the field is shown.
|
|
2348
|
+
* @format int32
|
|
2349
|
+
*/
|
|
2350
|
+
order?: number;
|
|
2351
|
+
/**
|
|
2352
|
+
* A placeholder for the field.
|
|
2353
|
+
* @format text
|
|
2354
|
+
*/
|
|
2355
|
+
placeholder?: string;
|
|
2356
|
+
/**
|
|
2357
|
+
* Tooltip for the field.
|
|
2358
|
+
* @format text
|
|
2359
|
+
*/
|
|
2360
|
+
tooltip?: string;
|
|
2361
|
+
/**
|
|
2362
|
+
* Whether to use shorthand notation. Example, 1K instead of 1000.
|
|
2363
|
+
* Only applicable for number fields.
|
|
2364
|
+
*/
|
|
2365
|
+
use_shorthand_notation?: boolean;
|
|
2366
|
+
/** The view overrides for the client. */
|
|
2367
|
+
view_overrides?: ViewOverride[];
|
|
2368
|
+
}
|
|
2220
2369
|
/** code-change */
|
|
2221
2370
|
export type CodeChange = AtomBase & {
|
|
2222
2371
|
/**
|
|
@@ -2645,6 +2794,24 @@ export interface CommandsListResponse {
|
|
|
2645
2794
|
*/
|
|
2646
2795
|
prev_cursor?: string;
|
|
2647
2796
|
}
|
|
2797
|
+
/**
|
|
2798
|
+
* composite-schema
|
|
2799
|
+
* The schema of a composite type.
|
|
2800
|
+
*/
|
|
2801
|
+
export interface CompositeSchema {
|
|
2802
|
+
/**
|
|
2803
|
+
* Description of this composite type.
|
|
2804
|
+
* @format text
|
|
2805
|
+
*/
|
|
2806
|
+
description?: string;
|
|
2807
|
+
/** List of all fields in this schema. */
|
|
2808
|
+
fields: SchemaFieldDescriptor[];
|
|
2809
|
+
/**
|
|
2810
|
+
* Name of this composite type.
|
|
2811
|
+
* @format text
|
|
2812
|
+
*/
|
|
2813
|
+
name?: string;
|
|
2814
|
+
}
|
|
2648
2815
|
/** conversation */
|
|
2649
2816
|
export type Conversation = AtomBase & {
|
|
2650
2817
|
/** Channel IDs of the conversation. */
|
|
@@ -2666,6 +2833,12 @@ export type Conversation = AtomBase & {
|
|
|
2666
2833
|
/** SLA summary for the object. */
|
|
2667
2834
|
sla_summary?: ArchetypeSlaSummary;
|
|
2668
2835
|
sla_tracker?: SlaTrackerSummary;
|
|
2836
|
+
/**
|
|
2837
|
+
* Source channel for the conversation.
|
|
2838
|
+
* @format text
|
|
2839
|
+
*/
|
|
2840
|
+
source_channel?: string;
|
|
2841
|
+
source_channel_v2?: ExternalCommunicationChannelSummary;
|
|
2669
2842
|
/** Describes the current stage of a work item. */
|
|
2670
2843
|
stage?: LegacyStage;
|
|
2671
2844
|
/** Tags associated with the object. */
|
|
@@ -2747,6 +2920,11 @@ export interface ConversationsCreateRequest {
|
|
|
2747
2920
|
* @format text
|
|
2748
2921
|
*/
|
|
2749
2922
|
source_channel?: string;
|
|
2923
|
+
/**
|
|
2924
|
+
* Source channel ID of the conversation.
|
|
2925
|
+
* @format id
|
|
2926
|
+
*/
|
|
2927
|
+
source_channel_v2?: string;
|
|
2750
2928
|
/** Sets an object's initial stage. */
|
|
2751
2929
|
stage?: StageInit;
|
|
2752
2930
|
/** Tags associated with the conversation. */
|
|
@@ -2895,6 +3073,11 @@ export interface ConversationsListRequest {
|
|
|
2895
3073
|
sla_summary?: SlaSummaryFilter;
|
|
2896
3074
|
/** Filters for conversations with any of the provided source channels. */
|
|
2897
3075
|
source_channel?: string[];
|
|
3076
|
+
/**
|
|
3077
|
+
* Filters for conversations that are associated with the source
|
|
3078
|
+
* channel.
|
|
3079
|
+
*/
|
|
3080
|
+
source_channel_v2?: string[];
|
|
2898
3081
|
/**
|
|
2899
3082
|
* Filters for conversations with any of the provided source channels.
|
|
2900
3083
|
* @deprecated
|
|
@@ -2978,6 +3161,11 @@ export interface ConversationsUpdateRequest {
|
|
|
2978
3161
|
members?: ConversationsUpdateRequestMembers;
|
|
2979
3162
|
metadata?: ConversationsUpdateRequestMetadata;
|
|
2980
3163
|
owned_by?: ConversationsUpdateRequestOwnedBy;
|
|
3164
|
+
/**
|
|
3165
|
+
* Source channel ID of the conversation.
|
|
3166
|
+
* @format id
|
|
3167
|
+
*/
|
|
3168
|
+
source_channel_v2?: string;
|
|
2981
3169
|
/** Updates an object's stage. */
|
|
2982
3170
|
stage?: StageUpdate;
|
|
2983
3171
|
/**
|
|
@@ -3048,6 +3236,19 @@ export interface ConversationsUpdateRequestUserSessions {
|
|
|
3048
3236
|
export interface ConversationsUpdateResponse {
|
|
3049
3237
|
conversation: Conversation;
|
|
3050
3238
|
}
|
|
3239
|
+
/**
|
|
3240
|
+
* conversations-vista-group-item
|
|
3241
|
+
* Represents a nested conversations vista group object.
|
|
3242
|
+
*/
|
|
3243
|
+
export type ConversationsVistaGroupItem = VistaGroupBase & {
|
|
3244
|
+
/** Type of conversations vista group item. */
|
|
3245
|
+
type: ConversationsVistaGroupItemType;
|
|
3246
|
+
};
|
|
3247
|
+
/** Type of conversations vista group item. */
|
|
3248
|
+
export declare enum ConversationsVistaGroupItemType {
|
|
3249
|
+
Curated = "curated",
|
|
3250
|
+
Dynamic = "dynamic"
|
|
3251
|
+
}
|
|
3051
3252
|
/** create-command-action */
|
|
3052
3253
|
export interface CreateCommandAction {
|
|
3053
3254
|
action_details?: CreateCommandActionDetails;
|
|
@@ -3121,6 +3322,34 @@ export interface CreateOrgScheduleInterval {
|
|
|
3121
3322
|
*/
|
|
3122
3323
|
to?: string;
|
|
3123
3324
|
}
|
|
3325
|
+
/** create-stage-node */
|
|
3326
|
+
export interface CreateStageNode {
|
|
3327
|
+
/** Whether this stage is deprecated. */
|
|
3328
|
+
is_deprecated?: boolean;
|
|
3329
|
+
/** Whether this is the start stage. */
|
|
3330
|
+
is_start?: boolean;
|
|
3331
|
+
/**
|
|
3332
|
+
* The ID of the stage.
|
|
3333
|
+
* @format id
|
|
3334
|
+
*/
|
|
3335
|
+
stage_id: string;
|
|
3336
|
+
/** List of transitions from this stage. */
|
|
3337
|
+
transitions?: CreateStageTransition[];
|
|
3338
|
+
}
|
|
3339
|
+
/** create-stage-transition */
|
|
3340
|
+
export interface CreateStageTransition {
|
|
3341
|
+
/**
|
|
3342
|
+
* The ID of the target stage.
|
|
3343
|
+
* @format id
|
|
3344
|
+
*/
|
|
3345
|
+
target_stage_id: string;
|
|
3346
|
+
ui?: CreateStageUiMetadata;
|
|
3347
|
+
}
|
|
3348
|
+
/** create-stage-ui-metadata */
|
|
3349
|
+
export interface CreateStageUiMetadata {
|
|
3350
|
+
/** Whether the stage is hidden. */
|
|
3351
|
+
is_hidden?: boolean;
|
|
3352
|
+
}
|
|
3124
3353
|
/** create-weekly-org-schedule-interval */
|
|
3125
3354
|
export interface CreateWeeklyOrgScheduleInterval {
|
|
3126
3355
|
/**
|
|
@@ -3138,138 +3367,824 @@ export interface CreateWeeklyOrgScheduleInterval {
|
|
|
3138
3367
|
to: number;
|
|
3139
3368
|
}
|
|
3140
3369
|
/**
|
|
3141
|
-
*
|
|
3142
|
-
*
|
|
3143
|
-
* request must have the corresponding schema specified; omission results
|
|
3144
|
-
* in a Bad Request error. If a custom schema is not included in the
|
|
3145
|
-
* specifier, it remains unchanged. For surfaces with human interactors,
|
|
3146
|
-
* it is recommended to provide tenant_fragment: true and
|
|
3147
|
-
* validate_required_fields: true.
|
|
3370
|
+
* curated-vista
|
|
3371
|
+
* Static collection of DevRev objects.
|
|
3148
3372
|
*/
|
|
3149
|
-
export
|
|
3150
|
-
/**
|
|
3151
|
-
|
|
3373
|
+
export type CuratedVista = VistaBase & {
|
|
3374
|
+
/** Item list to store a curated list of DevRev objects. */
|
|
3375
|
+
items?: AtomSummary[];
|
|
3376
|
+
};
|
|
3377
|
+
/** custom-object */
|
|
3378
|
+
export type CustomObject = AtomBase & {
|
|
3152
3379
|
/**
|
|
3153
|
-
*
|
|
3380
|
+
* Type of the object.
|
|
3154
3381
|
* @format text
|
|
3155
3382
|
*/
|
|
3156
|
-
|
|
3157
|
-
/**
|
|
3158
|
-
|
|
3159
|
-
/** Whether to enforce required fields validation. */
|
|
3160
|
-
validate_required_fields?: boolean;
|
|
3161
|
-
}
|
|
3162
|
-
/** dashboard */
|
|
3163
|
-
export type Dashboard = AtomBase;
|
|
3164
|
-
/**
|
|
3165
|
-
* date-filter
|
|
3166
|
-
* Provides ways to specify date ranges on objects.
|
|
3167
|
-
*/
|
|
3168
|
-
export type DateFilter = (DateTimeFilter | DateTimePreset) & {
|
|
3169
|
-
/** Type of date filter. */
|
|
3170
|
-
type: DateFilterType;
|
|
3171
|
-
};
|
|
3172
|
-
/** Type of date filter. */
|
|
3173
|
-
export declare enum DateFilterType {
|
|
3174
|
-
Preset = "preset",
|
|
3175
|
-
Range = "range"
|
|
3176
|
-
}
|
|
3177
|
-
/** date-time-filter */
|
|
3178
|
-
export interface DateTimeFilter {
|
|
3383
|
+
leaf_type?: string;
|
|
3384
|
+
/** Describes the current stage of a object. */
|
|
3385
|
+
stage?: Stage;
|
|
3179
3386
|
/**
|
|
3180
|
-
*
|
|
3181
|
-
*
|
|
3182
|
-
* @format date-time
|
|
3183
|
-
* @example "2023-01-01T12:00:00.000Z"
|
|
3387
|
+
* Title of the object.
|
|
3388
|
+
* @format text
|
|
3184
3389
|
*/
|
|
3185
|
-
|
|
3390
|
+
title?: string;
|
|
3186
3391
|
/**
|
|
3187
|
-
*
|
|
3188
|
-
*
|
|
3189
|
-
*
|
|
3190
|
-
* @
|
|
3392
|
+
* A unique key that, if provided, ensures the combination of
|
|
3393
|
+
* {leaf_type, unique_key} is distinct across all objects in the
|
|
3394
|
+
* system.
|
|
3395
|
+
* @format text
|
|
3191
3396
|
*/
|
|
3192
|
-
|
|
3193
|
-
}
|
|
3194
|
-
/**
|
|
3195
|
-
* date-time-preset
|
|
3196
|
-
* Provides preset types for date filter.
|
|
3197
|
-
*/
|
|
3198
|
-
export type DateTimePreset = (DateTimePresetLastNDays | DateTimePresetNextNDays) & {
|
|
3199
|
-
/** Type of date preset. */
|
|
3200
|
-
preset_type: DateTimePresetType;
|
|
3397
|
+
unique_key?: string;
|
|
3201
3398
|
};
|
|
3202
|
-
/**
|
|
3203
|
-
export interface
|
|
3399
|
+
/** custom-objects-count-request */
|
|
3400
|
+
export interface CustomObjectsCountRequest {
|
|
3401
|
+
/** List of filters to apply. */
|
|
3402
|
+
filters?: any[];
|
|
3204
3403
|
/**
|
|
3205
|
-
*
|
|
3206
|
-
*
|
|
3207
|
-
* @min 0
|
|
3208
|
-
* @max 4294967295
|
|
3404
|
+
* Leaf type to filter.
|
|
3405
|
+
* @format text
|
|
3209
3406
|
*/
|
|
3210
|
-
|
|
3407
|
+
leaf_type: string;
|
|
3211
3408
|
}
|
|
3212
|
-
/**
|
|
3213
|
-
export interface
|
|
3409
|
+
/** custom-objects-count-response */
|
|
3410
|
+
export interface CustomObjectsCountResponse {
|
|
3214
3411
|
/**
|
|
3215
|
-
* The
|
|
3216
|
-
*
|
|
3217
|
-
* @min 0
|
|
3218
|
-
* @max 4294967295
|
|
3412
|
+
* The count of custom objects.
|
|
3413
|
+
* @format int64
|
|
3219
3414
|
*/
|
|
3220
|
-
|
|
3221
|
-
}
|
|
3222
|
-
/** Type of date preset. */
|
|
3223
|
-
export declare enum DateTimePresetType {
|
|
3224
|
-
LastNDays = "last_n_days",
|
|
3225
|
-
NextNDays = "next_n_days"
|
|
3226
|
-
}
|
|
3227
|
-
/** Indicates whether this evaluation can change in the future. */
|
|
3228
|
-
export declare enum Definedness {
|
|
3229
|
-
Immutable = "immutable",
|
|
3230
|
-
Mutable = "mutable",
|
|
3231
|
-
Undefined = "undefined"
|
|
3415
|
+
count: number;
|
|
3232
3416
|
}
|
|
3233
|
-
/**
|
|
3234
|
-
export
|
|
3235
|
-
/**
|
|
3236
|
-
|
|
3237
|
-
* Request to create a new enterprise authentication connection.
|
|
3238
|
-
*/
|
|
3239
|
-
export type DevOrgAuthConnectionsCreateRequest = (DevOrgAuthConnectionsCreateRequestAzureAdOptions | DevOrgAuthConnectionsCreateRequestGoogleAppsOptions | DevOrgAuthConnectionsCreateRequestOidcOptions | DevOrgAuthConnectionsCreateRequestOktaOptions | DevOrgAuthConnectionsCreateRequestSamlOptions) & {
|
|
3417
|
+
/** custom-objects-create-request */
|
|
3418
|
+
export interface CustomObjectsCreateRequest {
|
|
3419
|
+
/** Custom fields of the custom object. */
|
|
3420
|
+
custom_fields?: object;
|
|
3240
3421
|
/**
|
|
3241
|
-
*
|
|
3242
|
-
*
|
|
3422
|
+
* Custom schemas described using identifiers. Each custom field in the
|
|
3423
|
+
* request must have the corresponding schema specified; omission results
|
|
3424
|
+
* in a Bad Request error. If a custom schema is not included in the
|
|
3425
|
+
* specifier, it remains unchanged. For surfaces with human interactors,
|
|
3426
|
+
* it is recommended to provide tenant_fragment: true and
|
|
3427
|
+
* validate_required_fields: true.
|
|
3243
3428
|
*/
|
|
3244
|
-
|
|
3429
|
+
custom_schema_spec?: CustomSchemaSpec;
|
|
3245
3430
|
/**
|
|
3246
|
-
*
|
|
3247
|
-
* visible to all the users when they sign in to this Dev
|
|
3248
|
-
* organization. For example, if the display_name is 'abclogin', then
|
|
3249
|
-
* it would appear on the login button as 'Log in to abclogin'.
|
|
3431
|
+
* Leaf type of the custom object.
|
|
3250
3432
|
* @format text
|
|
3251
|
-
* @minLength 1
|
|
3252
|
-
* @maxLength 128
|
|
3253
3433
|
*/
|
|
3254
|
-
|
|
3255
|
-
};
|
|
3256
|
-
/**
|
|
3257
|
-
* dev-org-auth-connections-create-request-azure-ad-options
|
|
3258
|
-
* Object encapsulating the configuration parameters for an Azure AD
|
|
3259
|
-
* authentication connection.
|
|
3260
|
-
* @deprecated
|
|
3261
|
-
*/
|
|
3262
|
-
export interface DevOrgAuthConnectionsCreateRequestAzureAdOptions {
|
|
3434
|
+
leaf_type: string;
|
|
3263
3435
|
/**
|
|
3264
|
-
*
|
|
3265
|
-
* @format
|
|
3436
|
+
* The stage of the custom object.
|
|
3437
|
+
* @format id
|
|
3266
3438
|
*/
|
|
3267
|
-
|
|
3439
|
+
stage?: string;
|
|
3268
3440
|
/**
|
|
3269
|
-
*
|
|
3270
|
-
*
|
|
3441
|
+
* The type of stage validations options when creating a custom
|
|
3442
|
+
* object.
|
|
3271
3443
|
*/
|
|
3272
|
-
|
|
3444
|
+
stage_validation_options?: StageValidationOptionForCreate[];
|
|
3445
|
+
/**
|
|
3446
|
+
* Title of the custom object.
|
|
3447
|
+
* @format text
|
|
3448
|
+
*/
|
|
3449
|
+
title?: string;
|
|
3450
|
+
/**
|
|
3451
|
+
* The unique key of the custom object.This can be used to hold an
|
|
3452
|
+
* external reference to another object.
|
|
3453
|
+
* @format text
|
|
3454
|
+
*/
|
|
3455
|
+
unique_key?: string;
|
|
3456
|
+
}
|
|
3457
|
+
/** custom-objects-create-response */
|
|
3458
|
+
export interface CustomObjectsCreateResponse {
|
|
3459
|
+
custom_object: CustomObject;
|
|
3460
|
+
}
|
|
3461
|
+
/** custom-objects-delete-request */
|
|
3462
|
+
export interface CustomObjectsDeleteRequest {
|
|
3463
|
+
/**
|
|
3464
|
+
* The ID of the custom object to get.
|
|
3465
|
+
* @format id
|
|
3466
|
+
*/
|
|
3467
|
+
id: string;
|
|
3468
|
+
}
|
|
3469
|
+
/** custom-objects-delete-response */
|
|
3470
|
+
export type CustomObjectsDeleteResponse = object;
|
|
3471
|
+
/** custom-objects-get-request */
|
|
3472
|
+
export interface CustomObjectsGetRequest {
|
|
3473
|
+
/**
|
|
3474
|
+
* The ID of the custom object to get.
|
|
3475
|
+
* @format id
|
|
3476
|
+
*/
|
|
3477
|
+
id?: string;
|
|
3478
|
+
}
|
|
3479
|
+
/** custom-objects-get-response */
|
|
3480
|
+
export interface CustomObjectsGetResponse {
|
|
3481
|
+
custom_object: CustomObject;
|
|
3482
|
+
}
|
|
3483
|
+
/** custom-objects-list-request */
|
|
3484
|
+
export interface CustomObjectsListRequest {
|
|
3485
|
+
/**
|
|
3486
|
+
* The cursor to resume iteration from. If not provided, then
|
|
3487
|
+
* iteration starts from the beginning.
|
|
3488
|
+
* @format text
|
|
3489
|
+
*/
|
|
3490
|
+
cursor?: string;
|
|
3491
|
+
/** List of filters to apply. */
|
|
3492
|
+
filter?: any[];
|
|
3493
|
+
/** List of filters to apply. */
|
|
3494
|
+
filters?: any[];
|
|
3495
|
+
/**
|
|
3496
|
+
* Leaf type to filter.
|
|
3497
|
+
* @format text
|
|
3498
|
+
*/
|
|
3499
|
+
leaf_type: string;
|
|
3500
|
+
/**
|
|
3501
|
+
* The maximum number of items.
|
|
3502
|
+
* @format int32
|
|
3503
|
+
*/
|
|
3504
|
+
limit?: number;
|
|
3505
|
+
/**
|
|
3506
|
+
* The iteration mode to use. If "after", then entries after the provided
|
|
3507
|
+
* cursor will be returned, or if no cursor is provided, then from the
|
|
3508
|
+
* beginning. If "before", then entries before the provided cursor will be
|
|
3509
|
+
* returned, or if no cursor is provided, then from the end. Entries will
|
|
3510
|
+
* always be returned in the specified sort-by order.
|
|
3511
|
+
*/
|
|
3512
|
+
mode?: ListMode;
|
|
3513
|
+
/** The list of fields to sort the items by and how to sort them. */
|
|
3514
|
+
sort_by?: string[];
|
|
3515
|
+
}
|
|
3516
|
+
/**
|
|
3517
|
+
* custom-objects-list-response
|
|
3518
|
+
* The response to listing all custom objects matching the filter
|
|
3519
|
+
* criteria.
|
|
3520
|
+
*/
|
|
3521
|
+
export interface CustomObjectsListResponse {
|
|
3522
|
+
/**
|
|
3523
|
+
* The cursor used to iterate subsequent results in accordance to the
|
|
3524
|
+
* sort order. If not set, then no later elements exist.
|
|
3525
|
+
* @format text
|
|
3526
|
+
*/
|
|
3527
|
+
next_cursor?: string;
|
|
3528
|
+
/**
|
|
3529
|
+
* The cursor used to iterate preceding results in accordance to the
|
|
3530
|
+
* sort order. If not set, then no prior elements exist.
|
|
3531
|
+
* @format text
|
|
3532
|
+
*/
|
|
3533
|
+
prev_cursor?: string;
|
|
3534
|
+
/** The custom objects. */
|
|
3535
|
+
result: CustomObject[];
|
|
3536
|
+
}
|
|
3537
|
+
/** custom-objects-update-request */
|
|
3538
|
+
export interface CustomObjectsUpdateRequest {
|
|
3539
|
+
/** Custom fields of the custom object. */
|
|
3540
|
+
custom_fields?: object;
|
|
3541
|
+
/**
|
|
3542
|
+
* Custom schemas described using identifiers. Each custom field in the
|
|
3543
|
+
* request must have the corresponding schema specified; omission results
|
|
3544
|
+
* in a Bad Request error. If a custom schema is not included in the
|
|
3545
|
+
* specifier, it remains unchanged. For surfaces with human interactors,
|
|
3546
|
+
* it is recommended to provide tenant_fragment: true and
|
|
3547
|
+
* validate_required_fields: true.
|
|
3548
|
+
*/
|
|
3549
|
+
custom_schema_spec?: CustomSchemaSpec;
|
|
3550
|
+
/**
|
|
3551
|
+
* The ID of the custom object to update.
|
|
3552
|
+
* @format id
|
|
3553
|
+
*/
|
|
3554
|
+
id: string;
|
|
3555
|
+
/**
|
|
3556
|
+
* Updates the stage of the custom object.
|
|
3557
|
+
* @format id
|
|
3558
|
+
*/
|
|
3559
|
+
stage?: string | null;
|
|
3560
|
+
/**
|
|
3561
|
+
* The type of stage validations options when updating the stage or
|
|
3562
|
+
* the stage diagram of a custom object.
|
|
3563
|
+
*/
|
|
3564
|
+
stage_validation_options?: StageValidationOptionForUpdate[];
|
|
3565
|
+
/**
|
|
3566
|
+
* Updates the title of the custom object.
|
|
3567
|
+
* @format text
|
|
3568
|
+
*/
|
|
3569
|
+
title?: string | null;
|
|
3570
|
+
}
|
|
3571
|
+
/** custom-objects-update-response */
|
|
3572
|
+
export interface CustomObjectsUpdateResponse {
|
|
3573
|
+
custom_object: CustomObject;
|
|
3574
|
+
}
|
|
3575
|
+
/** custom-schema-fragment */
|
|
3576
|
+
export interface CustomSchemaFragment {
|
|
3577
|
+
type: CustomSchemaFragmentType;
|
|
3578
|
+
}
|
|
3579
|
+
/**
|
|
3580
|
+
* custom-schema-fragment-condition
|
|
3581
|
+
* The condition associated with a field.
|
|
3582
|
+
*/
|
|
3583
|
+
export interface CustomSchemaFragmentCondition {
|
|
3584
|
+
/** The associated effects when the expression evaluates to true. */
|
|
3585
|
+
effects?: CustomSchemaFragmentEffect[];
|
|
3586
|
+
/**
|
|
3587
|
+
* The expression to evaluate.
|
|
3588
|
+
* @format text
|
|
3589
|
+
*/
|
|
3590
|
+
expression?: string;
|
|
3591
|
+
}
|
|
3592
|
+
/**
|
|
3593
|
+
* custom-schema-fragment-effect
|
|
3594
|
+
* An effect associated with a condition.
|
|
3595
|
+
*/
|
|
3596
|
+
export interface CustomSchemaFragmentEffect {
|
|
3597
|
+
/**
|
|
3598
|
+
* Allowed values for the fields based on the condition. This takes
|
|
3599
|
+
* precedence over allowed_values in field_descriptor.
|
|
3600
|
+
*/
|
|
3601
|
+
allowed_values?: string[];
|
|
3602
|
+
/** The fields which are affected by the condition. */
|
|
3603
|
+
fields: string[];
|
|
3604
|
+
/**
|
|
3605
|
+
* Whether the fields should be made immutable or not based on the
|
|
3606
|
+
* condition.
|
|
3607
|
+
*/
|
|
3608
|
+
immutable?: boolean;
|
|
3609
|
+
/**
|
|
3610
|
+
* Whether the fields are required or not based on the condition. This
|
|
3611
|
+
* takes precedence over is_required in field_descriptor.
|
|
3612
|
+
*/
|
|
3613
|
+
require?: boolean;
|
|
3614
|
+
/** Whether the fields are shown or not based on the condition. */
|
|
3615
|
+
show?: boolean;
|
|
3616
|
+
}
|
|
3617
|
+
export type CustomSchemaFragmentType = string;
|
|
3618
|
+
/** custom-schema-fragments-get-request */
|
|
3619
|
+
export interface CustomSchemaFragmentsGetRequest {
|
|
3620
|
+
/**
|
|
3621
|
+
* The ID of the custom schema fragment.
|
|
3622
|
+
* @format id
|
|
3623
|
+
*/
|
|
3624
|
+
id: string;
|
|
3625
|
+
}
|
|
3626
|
+
/** custom-schema-fragments-get-response */
|
|
3627
|
+
export interface CustomSchemaFragmentsGetResponse {
|
|
3628
|
+
fragment: CustomSchemaFragment;
|
|
3629
|
+
}
|
|
3630
|
+
/** custom-schema-fragments-list-request */
|
|
3631
|
+
export interface CustomSchemaFragmentsListRequest {
|
|
3632
|
+
/** The list of app names. */
|
|
3633
|
+
app?: string[];
|
|
3634
|
+
/**
|
|
3635
|
+
* The cursor to resume iteration from. If not provided, then
|
|
3636
|
+
* iteration starts from the beginning.
|
|
3637
|
+
* @format text
|
|
3638
|
+
*/
|
|
3639
|
+
cursor?: string;
|
|
3640
|
+
/**
|
|
3641
|
+
* Whether only deprecated fragments should be filtered.
|
|
3642
|
+
* @deprecated
|
|
3643
|
+
*/
|
|
3644
|
+
deprecated?: boolean;
|
|
3645
|
+
/** Whether the leaf type corresponds to a custom object */
|
|
3646
|
+
is_custom_leaf_type?: boolean;
|
|
3647
|
+
/** Whether the fragment has been deprecated. */
|
|
3648
|
+
is_deprecated?: boolean;
|
|
3649
|
+
/** The list of leaf types. */
|
|
3650
|
+
leaf_type?: string[];
|
|
3651
|
+
/**
|
|
3652
|
+
* The maximum number of items.
|
|
3653
|
+
* @format int32
|
|
3654
|
+
*/
|
|
3655
|
+
limit?: number;
|
|
3656
|
+
/**
|
|
3657
|
+
* The iteration mode to use. If "after", then entries after the provided
|
|
3658
|
+
* cursor will be returned, or if no cursor is provided, then from the
|
|
3659
|
+
* beginning. If "before", then entries before the provided cursor will be
|
|
3660
|
+
* returned, or if no cursor is provided, then from the end. Entries will
|
|
3661
|
+
* always be returned in the specified sort-by order.
|
|
3662
|
+
*/
|
|
3663
|
+
mode?: ListMode;
|
|
3664
|
+
/**
|
|
3665
|
+
* List of fields which are not required in the payload and can be
|
|
3666
|
+
* pruned away.
|
|
3667
|
+
*/
|
|
3668
|
+
prune?: CustomSchemaFragmentsListRequestPrune[];
|
|
3669
|
+
/** The list of fields to sort the items by and how to sort them. */
|
|
3670
|
+
sort_by?: string[];
|
|
3671
|
+
/** The list of subtypes. */
|
|
3672
|
+
subtype?: string[];
|
|
3673
|
+
/** Filters for custom schema fragment of the provided types. */
|
|
3674
|
+
types?: CustomSchemaFragmentType[];
|
|
3675
|
+
}
|
|
3676
|
+
export declare enum CustomSchemaFragmentsListRequestPrune {
|
|
3677
|
+
Fields = "fields"
|
|
3678
|
+
}
|
|
3679
|
+
/** custom-schema-fragments-list-response */
|
|
3680
|
+
export interface CustomSchemaFragmentsListResponse {
|
|
3681
|
+
/**
|
|
3682
|
+
* The cursor used to iterate subsequent results in accordance to the
|
|
3683
|
+
* sort order. If not set, then no later elements exist.
|
|
3684
|
+
* @format text
|
|
3685
|
+
*/
|
|
3686
|
+
next_cursor?: string;
|
|
3687
|
+
/**
|
|
3688
|
+
* The cursor used to iterate preceding results in accordance to the
|
|
3689
|
+
* sort order. If not set, then no prior elements exist.
|
|
3690
|
+
* @format text
|
|
3691
|
+
*/
|
|
3692
|
+
prev_cursor?: string;
|
|
3693
|
+
/** The custom schema fragments. */
|
|
3694
|
+
result: CustomSchemaFragment[];
|
|
3695
|
+
}
|
|
3696
|
+
/** custom-schema-fragments-set-request */
|
|
3697
|
+
export type CustomSchemaFragmentsSetRequest = (CustomSchemaFragmentsSetRequestAppFragment | CustomSchemaFragmentsSetRequestCustomTypeFragment | CustomSchemaFragmentsSetRequestTenantFragment) & {
|
|
3698
|
+
type: CustomSchemaFragmentsSetRequestType;
|
|
3699
|
+
/** List of all composite schemas used in this fragment. */
|
|
3700
|
+
composite_schemas?: CustomSchemaFragmentsSetRequestCompositeSchema[];
|
|
3701
|
+
/** List of conditions for this fragment. */
|
|
3702
|
+
conditions?: CustomSchemaFragmentCondition[];
|
|
3703
|
+
/** List of field names which are being dropped. */
|
|
3704
|
+
deleted_fields?: string[];
|
|
3705
|
+
/**
|
|
3706
|
+
* Whether this fragment has been deprecated.
|
|
3707
|
+
* @deprecated
|
|
3708
|
+
*/
|
|
3709
|
+
deprecated?: boolean;
|
|
3710
|
+
/**
|
|
3711
|
+
* The description of the custom schema fragment.
|
|
3712
|
+
* @format text
|
|
3713
|
+
*/
|
|
3714
|
+
description: string;
|
|
3715
|
+
/** List of all fields in this fragment. */
|
|
3716
|
+
fields?: SchemaFieldDescriptor[];
|
|
3717
|
+
/** Whether the leaf type corresponds to a custom object */
|
|
3718
|
+
is_custom_leaf_type?: boolean;
|
|
3719
|
+
/** Whether this fragment has been deprecated. */
|
|
3720
|
+
is_deprecated?: boolean;
|
|
3721
|
+
/**
|
|
3722
|
+
* The leaf type this fragment applies to.
|
|
3723
|
+
* @format text
|
|
3724
|
+
*/
|
|
3725
|
+
leaf_type: string;
|
|
3726
|
+
};
|
|
3727
|
+
/** custom-schema-fragments-set-request-app-fragment */
|
|
3728
|
+
export interface CustomSchemaFragmentsSetRequestAppFragment {
|
|
3729
|
+
/**
|
|
3730
|
+
* The app this fragment applies to.
|
|
3731
|
+
* @format text
|
|
3732
|
+
*/
|
|
3733
|
+
app: string;
|
|
3734
|
+
/**
|
|
3735
|
+
* The display name of the app.
|
|
3736
|
+
* @format text
|
|
3737
|
+
*/
|
|
3738
|
+
app_display_name?: string;
|
|
3739
|
+
}
|
|
3740
|
+
/** custom-schema-fragments-set-request-composite-schema */
|
|
3741
|
+
export interface CustomSchemaFragmentsSetRequestCompositeSchema {
|
|
3742
|
+
/**
|
|
3743
|
+
* Description of this composite type.
|
|
3744
|
+
* @format text
|
|
3745
|
+
*/
|
|
3746
|
+
description?: string;
|
|
3747
|
+
/** List of fields in this composite type. */
|
|
3748
|
+
fields: SchemaFieldDescriptor[];
|
|
3749
|
+
/**
|
|
3750
|
+
* The name of this composite type.
|
|
3751
|
+
* @format text
|
|
3752
|
+
*/
|
|
3753
|
+
name?: string;
|
|
3754
|
+
}
|
|
3755
|
+
/** custom-schema-fragments-set-request-custom-type-fragment */
|
|
3756
|
+
export interface CustomSchemaFragmentsSetRequestCustomTypeFragment {
|
|
3757
|
+
/**
|
|
3758
|
+
* Path components used to display available custom types in tree
|
|
3759
|
+
* form.
|
|
3760
|
+
*/
|
|
3761
|
+
path?: CustomTypePathComponent[];
|
|
3762
|
+
/**
|
|
3763
|
+
* The ID of the associated custom stage diagram.
|
|
3764
|
+
* @format id
|
|
3765
|
+
*/
|
|
3766
|
+
stage_diagram?: string;
|
|
3767
|
+
/** List of Per-DevOrg stock field overrides. */
|
|
3768
|
+
stock_field_overrides?: StockFieldOverride[];
|
|
3769
|
+
/**
|
|
3770
|
+
* The string used to populate the subtype in the leaf type.
|
|
3771
|
+
* @format text
|
|
3772
|
+
*/
|
|
3773
|
+
subtype: string;
|
|
3774
|
+
/**
|
|
3775
|
+
* The display name of the subtype.
|
|
3776
|
+
* @format text
|
|
3777
|
+
*/
|
|
3778
|
+
subtype_display_name?: string;
|
|
3779
|
+
}
|
|
3780
|
+
/** custom-schema-fragments-set-request-tenant-fragment */
|
|
3781
|
+
export interface CustomSchemaFragmentsSetRequestTenantFragment {
|
|
3782
|
+
/**
|
|
3783
|
+
* The display ID prefix for the custom object.
|
|
3784
|
+
* @format text
|
|
3785
|
+
* @pattern ^[A-Z]{2,10}$
|
|
3786
|
+
*/
|
|
3787
|
+
id_prefix?: string;
|
|
3788
|
+
/** List of Per-DevOrg stock field overrides. */
|
|
3789
|
+
stock_field_overrides?: StockFieldOverride[];
|
|
3790
|
+
}
|
|
3791
|
+
export declare enum CustomSchemaFragmentsSetRequestType {
|
|
3792
|
+
AppFragment = "app_fragment",
|
|
3793
|
+
CustomTypeFragment = "custom_type_fragment",
|
|
3794
|
+
TenantFragment = "tenant_fragment"
|
|
3795
|
+
}
|
|
3796
|
+
/** custom-schema-fragments-set-response */
|
|
3797
|
+
export interface CustomSchemaFragmentsSetResponse {
|
|
3798
|
+
/**
|
|
3799
|
+
* The ID of the custom schema fragment.
|
|
3800
|
+
* @format id
|
|
3801
|
+
*/
|
|
3802
|
+
id: string;
|
|
3803
|
+
}
|
|
3804
|
+
/**
|
|
3805
|
+
* custom-schema-spec
|
|
3806
|
+
* Custom schemas described using identifiers. Each custom field in the
|
|
3807
|
+
* request must have the corresponding schema specified; omission results
|
|
3808
|
+
* in a Bad Request error. If a custom schema is not included in the
|
|
3809
|
+
* specifier, it remains unchanged. For surfaces with human interactors,
|
|
3810
|
+
* it is recommended to provide tenant_fragment: true and
|
|
3811
|
+
* validate_required_fields: true.
|
|
3812
|
+
*/
|
|
3813
|
+
export interface CustomSchemaSpec {
|
|
3814
|
+
/** List of apps. */
|
|
3815
|
+
apps?: string[];
|
|
3816
|
+
/**
|
|
3817
|
+
* Name of the subtype.
|
|
3818
|
+
* @format text
|
|
3819
|
+
*/
|
|
3820
|
+
subtype?: string;
|
|
3821
|
+
/** Whether the tenant schema is requested. */
|
|
3822
|
+
tenant_fragment?: boolean;
|
|
3823
|
+
/** Whether to enforce required fields validation. */
|
|
3824
|
+
validate_required_fields?: boolean;
|
|
3825
|
+
}
|
|
3826
|
+
/**
|
|
3827
|
+
* custom-schema-spec-for-read
|
|
3828
|
+
* Custom schemas described using identifiers
|
|
3829
|
+
*/
|
|
3830
|
+
export interface CustomSchemaSpecForRead {
|
|
3831
|
+
/** List of apps. */
|
|
3832
|
+
apps?: string[];
|
|
3833
|
+
/**
|
|
3834
|
+
* Name of the subtype.
|
|
3835
|
+
* @format text
|
|
3836
|
+
*/
|
|
3837
|
+
subtype?: string;
|
|
3838
|
+
}
|
|
3839
|
+
/** custom-stage */
|
|
3840
|
+
export type CustomStage = AtomBase & {
|
|
3841
|
+
/**
|
|
3842
|
+
* The human readable name of the stage.
|
|
3843
|
+
* @format text
|
|
3844
|
+
*/
|
|
3845
|
+
name?: string;
|
|
3846
|
+
/**
|
|
3847
|
+
* Position of the stage in the global stage ordering.
|
|
3848
|
+
* @format int32
|
|
3849
|
+
*/
|
|
3850
|
+
ordinal?: number;
|
|
3851
|
+
state?: CustomStateSummary;
|
|
3852
|
+
};
|
|
3853
|
+
/** custom-stage-summary */
|
|
3854
|
+
export type CustomStageSummary = AtomBaseSummary & {
|
|
3855
|
+
/**
|
|
3856
|
+
* The human readable name of the stage.
|
|
3857
|
+
* @format text
|
|
3858
|
+
*/
|
|
3859
|
+
name?: string;
|
|
3860
|
+
};
|
|
3861
|
+
/** custom-stages-create-request */
|
|
3862
|
+
export interface CustomStagesCreateRequest {
|
|
3863
|
+
/**
|
|
3864
|
+
* A reference to the marketplace item from which this stage was
|
|
3865
|
+
* imported.
|
|
3866
|
+
* @format id
|
|
3867
|
+
*/
|
|
3868
|
+
marketplace_ref?: string;
|
|
3869
|
+
/**
|
|
3870
|
+
* The name of the custom stage.
|
|
3871
|
+
* @format text
|
|
3872
|
+
*/
|
|
3873
|
+
name: string;
|
|
3874
|
+
/**
|
|
3875
|
+
* The ordinal of the custom stage used for ordering.
|
|
3876
|
+
* @format int32
|
|
3877
|
+
*/
|
|
3878
|
+
ordinal: number;
|
|
3879
|
+
/**
|
|
3880
|
+
* The state ID.
|
|
3881
|
+
* @format id
|
|
3882
|
+
*/
|
|
3883
|
+
state: string;
|
|
3884
|
+
}
|
|
3885
|
+
/** custom-stages-create-response */
|
|
3886
|
+
export interface CustomStagesCreateResponse {
|
|
3887
|
+
custom_stage: CustomStage;
|
|
3888
|
+
}
|
|
3889
|
+
/** custom-stages-get-request */
|
|
3890
|
+
export interface CustomStagesGetRequest {
|
|
3891
|
+
/**
|
|
3892
|
+
* The ID of the custom stage to get.
|
|
3893
|
+
* @format id
|
|
3894
|
+
*/
|
|
3895
|
+
id: string;
|
|
3896
|
+
}
|
|
3897
|
+
/** custom-stages-get-response */
|
|
3898
|
+
export interface CustomStagesGetResponse {
|
|
3899
|
+
custom_stage: CustomStage;
|
|
3900
|
+
}
|
|
3901
|
+
/** custom-stages-list-request */
|
|
3902
|
+
export interface CustomStagesListRequest {
|
|
3903
|
+
/**
|
|
3904
|
+
* The cursor to resume iteration from, otherwise if not provided,
|
|
3905
|
+
* then iteration starts from the beginning.
|
|
3906
|
+
* @format text
|
|
3907
|
+
*/
|
|
3908
|
+
cursor?: string;
|
|
3909
|
+
/**
|
|
3910
|
+
* The maximum number of items.
|
|
3911
|
+
* @format int32
|
|
3912
|
+
*/
|
|
3913
|
+
limit?: number;
|
|
3914
|
+
/** The list of stage names. */
|
|
3915
|
+
name?: string[];
|
|
3916
|
+
/** The list of stage ordinals. */
|
|
3917
|
+
ordinal?: number[];
|
|
3918
|
+
/** The list of fields to sort the items by and how to sort them. */
|
|
3919
|
+
sort_by?: string[];
|
|
3920
|
+
}
|
|
3921
|
+
/** custom-stages-list-response */
|
|
3922
|
+
export interface CustomStagesListResponse {
|
|
3923
|
+
/**
|
|
3924
|
+
* The cursor to resume iteration from, otherwise if not provided,
|
|
3925
|
+
* then iteration starts from the beginning.
|
|
3926
|
+
* @format text
|
|
3927
|
+
*/
|
|
3928
|
+
cursor?: string;
|
|
3929
|
+
/** The custom stages. */
|
|
3930
|
+
result: CustomStage[];
|
|
3931
|
+
}
|
|
3932
|
+
/** custom-stages-update-request */
|
|
3933
|
+
export interface CustomStagesUpdateRequest {
|
|
3934
|
+
/**
|
|
3935
|
+
* The ID of the custom stage to update.
|
|
3936
|
+
* @format id
|
|
3937
|
+
*/
|
|
3938
|
+
id: string;
|
|
3939
|
+
/**
|
|
3940
|
+
* The updated name of the custom stage.
|
|
3941
|
+
* @format text
|
|
3942
|
+
*/
|
|
3943
|
+
name?: string;
|
|
3944
|
+
/**
|
|
3945
|
+
* The ordinal of the custom stage.
|
|
3946
|
+
* @format int32
|
|
3947
|
+
*/
|
|
3948
|
+
ordinal?: number;
|
|
3949
|
+
/**
|
|
3950
|
+
* The state ID.
|
|
3951
|
+
* @format id
|
|
3952
|
+
*/
|
|
3953
|
+
state_id?: string;
|
|
3954
|
+
}
|
|
3955
|
+
/** custom-stages-update-response */
|
|
3956
|
+
export interface CustomStagesUpdateResponse {
|
|
3957
|
+
custom_stage: CustomStage;
|
|
3958
|
+
}
|
|
3959
|
+
/** custom-state */
|
|
3960
|
+
export type CustomState = AtomBase & {
|
|
3961
|
+
/** True if this is a final state. */
|
|
3962
|
+
is_final?: boolean;
|
|
3963
|
+
/**
|
|
3964
|
+
* The human readable name of the state.
|
|
3965
|
+
* @format text
|
|
3966
|
+
*/
|
|
3967
|
+
name?: string;
|
|
3968
|
+
/**
|
|
3969
|
+
* Position of the state in the global state ordering.
|
|
3970
|
+
* @format int32
|
|
3971
|
+
*/
|
|
3972
|
+
ordinal?: number;
|
|
3973
|
+
};
|
|
3974
|
+
/** custom-state-summary */
|
|
3975
|
+
export type CustomStateSummary = AtomBaseSummary & {
|
|
3976
|
+
/** True if this is a final state. */
|
|
3977
|
+
is_final?: boolean;
|
|
3978
|
+
/**
|
|
3979
|
+
* The human readable name of the state.
|
|
3980
|
+
* @format text
|
|
3981
|
+
*/
|
|
3982
|
+
name?: string;
|
|
3983
|
+
};
|
|
3984
|
+
/** custom-states-create-request */
|
|
3985
|
+
export interface CustomStatesCreateRequest {
|
|
3986
|
+
/** Whether this is a final state. */
|
|
3987
|
+
is_final?: boolean;
|
|
3988
|
+
/**
|
|
3989
|
+
* The name of the custom state.
|
|
3990
|
+
* @format text
|
|
3991
|
+
*/
|
|
3992
|
+
name: string;
|
|
3993
|
+
/**
|
|
3994
|
+
* Ordinal of the custom state used to identify system states.
|
|
3995
|
+
* @format int32
|
|
3996
|
+
*/
|
|
3997
|
+
ordinal: number;
|
|
3998
|
+
}
|
|
3999
|
+
/** custom-states-create-response */
|
|
4000
|
+
export interface CustomStatesCreateResponse {
|
|
4001
|
+
custom_state: CustomState;
|
|
4002
|
+
}
|
|
4003
|
+
/** custom-states-get-request */
|
|
4004
|
+
export interface CustomStatesGetRequest {
|
|
4005
|
+
/**
|
|
4006
|
+
* The ID of the custom state to get.
|
|
4007
|
+
* @format id
|
|
4008
|
+
*/
|
|
4009
|
+
id: string;
|
|
4010
|
+
}
|
|
4011
|
+
/** custom-states-get-response */
|
|
4012
|
+
export interface CustomStatesGetResponse {
|
|
4013
|
+
custom_state: CustomState;
|
|
4014
|
+
}
|
|
4015
|
+
/** custom-states-list-request */
|
|
4016
|
+
export interface CustomStatesListRequest {
|
|
4017
|
+
/**
|
|
4018
|
+
* The cursor to resume iteration from, otherwise if not provided,
|
|
4019
|
+
* then iteration starts from the beginning.
|
|
4020
|
+
* @format text
|
|
4021
|
+
*/
|
|
4022
|
+
cursor?: string;
|
|
4023
|
+
/** Whether only final states should be filtered. */
|
|
4024
|
+
is_final?: boolean;
|
|
4025
|
+
/**
|
|
4026
|
+
* The maximum number of items.
|
|
4027
|
+
* @format int32
|
|
4028
|
+
*/
|
|
4029
|
+
limit?: number;
|
|
4030
|
+
/** The list of state names. */
|
|
4031
|
+
name?: string[];
|
|
4032
|
+
/** The list of state ordinals. */
|
|
4033
|
+
ordinal?: number[];
|
|
4034
|
+
/** The list of fields to sort the items by and how to sort them. */
|
|
4035
|
+
sort_by?: string[];
|
|
4036
|
+
}
|
|
4037
|
+
/** custom-states-list-response */
|
|
4038
|
+
export interface CustomStatesListResponse {
|
|
4039
|
+
/**
|
|
4040
|
+
* The cursor to resume iteration from, otherwise if not provided,
|
|
4041
|
+
* then iteration starts from the beginning.
|
|
4042
|
+
* @format text
|
|
4043
|
+
*/
|
|
4044
|
+
cursor?: string;
|
|
4045
|
+
/** The custom states. */
|
|
4046
|
+
result: CustomState[];
|
|
4047
|
+
}
|
|
4048
|
+
/** custom-states-update-request */
|
|
4049
|
+
export interface CustomStatesUpdateRequest {
|
|
4050
|
+
/**
|
|
4051
|
+
* The ID of the custom state to update.
|
|
4052
|
+
* @format id
|
|
4053
|
+
*/
|
|
4054
|
+
id: string;
|
|
4055
|
+
/** Whether this is a final state. */
|
|
4056
|
+
is_final?: boolean;
|
|
4057
|
+
/**
|
|
4058
|
+
* The name of the custom state.
|
|
4059
|
+
* @format text
|
|
4060
|
+
*/
|
|
4061
|
+
name?: string;
|
|
4062
|
+
/**
|
|
4063
|
+
* Ordinal of the custom state used to identify system states.
|
|
4064
|
+
* @format int32
|
|
4065
|
+
*/
|
|
4066
|
+
ordinal?: number;
|
|
4067
|
+
}
|
|
4068
|
+
/** custom-states-update-response */
|
|
4069
|
+
export interface CustomStatesUpdateResponse {
|
|
4070
|
+
custom_state: CustomState;
|
|
4071
|
+
}
|
|
4072
|
+
/**
|
|
4073
|
+
* custom-type-path-component
|
|
4074
|
+
* Path component for rendering custom type lists in tree form.
|
|
4075
|
+
*/
|
|
4076
|
+
export type CustomTypePathComponent = object;
|
|
4077
|
+
/** dashboard */
|
|
4078
|
+
export type Dashboard = AtomBase;
|
|
4079
|
+
/**
|
|
4080
|
+
* date-filter
|
|
4081
|
+
* Provides ways to specify date ranges on objects.
|
|
4082
|
+
*/
|
|
4083
|
+
export type DateFilter = (DateTimeFilter | DateTimePreset) & {
|
|
4084
|
+
/** Type of date filter. */
|
|
4085
|
+
type: DateFilterType;
|
|
4086
|
+
};
|
|
4087
|
+
/** Type of date filter. */
|
|
4088
|
+
export declare enum DateFilterType {
|
|
4089
|
+
Preset = "preset",
|
|
4090
|
+
Range = "range"
|
|
4091
|
+
}
|
|
4092
|
+
/** date-time-filter */
|
|
4093
|
+
export interface DateTimeFilter {
|
|
4094
|
+
/**
|
|
4095
|
+
* Filters for objects created after the provided timestamp
|
|
4096
|
+
* (inclusive).
|
|
4097
|
+
* @format date-time
|
|
4098
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
4099
|
+
*/
|
|
4100
|
+
after?: string;
|
|
4101
|
+
/**
|
|
4102
|
+
* Filters for objects created before the provided timestamp
|
|
4103
|
+
* (inclusive).
|
|
4104
|
+
* @format date-time
|
|
4105
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
4106
|
+
*/
|
|
4107
|
+
before?: string;
|
|
4108
|
+
}
|
|
4109
|
+
/**
|
|
4110
|
+
* date-time-preset
|
|
4111
|
+
* Provides preset types for date filter.
|
|
4112
|
+
*/
|
|
4113
|
+
export type DateTimePreset = (DateTimePresetLastNDays | DateTimePresetNextNDays) & {
|
|
4114
|
+
/** Type of date preset. */
|
|
4115
|
+
preset_type: DateTimePresetType;
|
|
4116
|
+
};
|
|
4117
|
+
/** date-time-preset-last-n-days */
|
|
4118
|
+
export interface DateTimePresetLastNDays {
|
|
4119
|
+
/**
|
|
4120
|
+
* The range starts from the current timestamp and continues for the
|
|
4121
|
+
* past n days.
|
|
4122
|
+
* @min 0
|
|
4123
|
+
* @max 4294967295
|
|
4124
|
+
*/
|
|
4125
|
+
days: number;
|
|
4126
|
+
}
|
|
4127
|
+
/** date-time-preset-next-n-days */
|
|
4128
|
+
export interface DateTimePresetNextNDays {
|
|
4129
|
+
/**
|
|
4130
|
+
* The range starts from the current timestamp and continues for the
|
|
4131
|
+
* next n days.
|
|
4132
|
+
* @min 0
|
|
4133
|
+
* @max 4294967295
|
|
4134
|
+
*/
|
|
4135
|
+
days: number;
|
|
4136
|
+
}
|
|
4137
|
+
/** Type of date preset. */
|
|
4138
|
+
export declare enum DateTimePresetType {
|
|
4139
|
+
LastNDays = "last_n_days",
|
|
4140
|
+
NextNDays = "next_n_days"
|
|
4141
|
+
}
|
|
4142
|
+
/** Indicates whether this evaluation can change in the future. */
|
|
4143
|
+
export declare enum Definedness {
|
|
4144
|
+
Immutable = "immutable",
|
|
4145
|
+
Mutable = "mutable",
|
|
4146
|
+
Undefined = "undefined"
|
|
4147
|
+
}
|
|
4148
|
+
/** dev-org */
|
|
4149
|
+
export type DevOrg = OrgBase;
|
|
4150
|
+
/**
|
|
4151
|
+
* dev-org-auth-connections-create-request
|
|
4152
|
+
* Request to create a new enterprise authentication connection.
|
|
4153
|
+
*/
|
|
4154
|
+
export type DevOrgAuthConnectionsCreateRequest = (DevOrgAuthConnectionsCreateRequestAzureAdOptions | DevOrgAuthConnectionsCreateRequestGoogleAppsOptions | DevOrgAuthConnectionsCreateRequestOidcOptions | DevOrgAuthConnectionsCreateRequestOktaOptions | DevOrgAuthConnectionsCreateRequestSamlOptions) & {
|
|
4155
|
+
/**
|
|
4156
|
+
* Defines the type for the authentication connection. Different types of
|
|
4157
|
+
* authentication connections have different configuration parameters.
|
|
4158
|
+
*/
|
|
4159
|
+
type: DevOrgAuthConnectionsCreateRequestType;
|
|
4160
|
+
/**
|
|
4161
|
+
* Display name of the authentication connection. This name will be
|
|
4162
|
+
* visible to all the users when they sign in to this Dev
|
|
4163
|
+
* organization. For example, if the display_name is 'abclogin', then
|
|
4164
|
+
* it would appear on the login button as 'Log in to abclogin'.
|
|
4165
|
+
* @format text
|
|
4166
|
+
* @minLength 1
|
|
4167
|
+
* @maxLength 128
|
|
4168
|
+
*/
|
|
4169
|
+
display_name?: string;
|
|
4170
|
+
};
|
|
4171
|
+
/**
|
|
4172
|
+
* dev-org-auth-connections-create-request-azure-ad-options
|
|
4173
|
+
* Object encapsulating the configuration parameters for an Azure AD
|
|
4174
|
+
* authentication connection.
|
|
4175
|
+
* @deprecated
|
|
4176
|
+
*/
|
|
4177
|
+
export interface DevOrgAuthConnectionsCreateRequestAzureAdOptions {
|
|
4178
|
+
/**
|
|
4179
|
+
* Client ID for the Azure authentication connection.
|
|
4180
|
+
* @format text
|
|
4181
|
+
*/
|
|
4182
|
+
client_id: string;
|
|
4183
|
+
/**
|
|
4184
|
+
* Client secret for the Azure authentication connection.
|
|
4185
|
+
* @format text
|
|
4186
|
+
*/
|
|
4187
|
+
client_secret: string;
|
|
3273
4188
|
/**
|
|
3274
4189
|
* Domain URL of the Azure authentication connection.
|
|
3275
4190
|
* @format text
|
|
@@ -3955,6 +4870,11 @@ export interface DevUsersSelfUpdateRequest {
|
|
|
3955
4870
|
job_history?: DevUsersUpdateJobHistoryItem[];
|
|
3956
4871
|
/** Job title of the Dev User. */
|
|
3957
4872
|
job_title?: DevUserJobTitle;
|
|
4873
|
+
/**
|
|
4874
|
+
* The ID of the Dev user that the user reports to.
|
|
4875
|
+
* @format id
|
|
4876
|
+
*/
|
|
4877
|
+
reports_to?: string;
|
|
3958
4878
|
}
|
|
3959
4879
|
/** dev-users-update-job-history-item */
|
|
3960
4880
|
export interface DevUsersUpdateJobHistoryItem {
|
|
@@ -4030,6 +4950,11 @@ export interface DevUsersUpdateRequest {
|
|
|
4030
4950
|
job_history?: DevUsersUpdateJobHistoryItem[];
|
|
4031
4951
|
/** Job title of the Dev User. */
|
|
4032
4952
|
job_title?: DevUserJobTitle;
|
|
4953
|
+
/**
|
|
4954
|
+
* The ID of the Dev user that the user reports to.
|
|
4955
|
+
* @format id
|
|
4956
|
+
*/
|
|
4957
|
+
reports_to?: string;
|
|
4033
4958
|
}
|
|
4034
4959
|
/**
|
|
4035
4960
|
* dev-users-update-response
|
|
@@ -4125,12 +5050,6 @@ export type DirectoriesDeleteResponse = object;
|
|
|
4125
5050
|
* The request to get a directory.
|
|
4126
5051
|
*/
|
|
4127
5052
|
export interface DirectoriesGetRequest {
|
|
4128
|
-
/**
|
|
4129
|
-
* Optional Dev Org ID for the unauthenticated user.
|
|
4130
|
-
* @format id
|
|
4131
|
-
* @example "DEV-AbCdEfGh"
|
|
4132
|
-
*/
|
|
4133
|
-
dev_org?: string;
|
|
4134
5053
|
/**
|
|
4135
5054
|
* The ID of the requested directory.
|
|
4136
5055
|
* @format id
|
|
@@ -4160,12 +5079,6 @@ export interface DirectoriesListRequest {
|
|
|
4160
5079
|
* @format text
|
|
4161
5080
|
*/
|
|
4162
5081
|
cursor?: string;
|
|
4163
|
-
/**
|
|
4164
|
-
* Optional Dev Org ID for the unauthenticated user.
|
|
4165
|
-
* @format id
|
|
4166
|
-
* @example "DEV-AbCdEfGh"
|
|
4167
|
-
*/
|
|
4168
|
-
dev_org?: string;
|
|
4169
5082
|
/**
|
|
4170
5083
|
* The maximum number of directories to return. The default is '50'.
|
|
4171
5084
|
* @format int32
|
|
@@ -4308,6 +5221,42 @@ export type DirectorySummary = AtomBaseSummary;
|
|
|
4308
5221
|
* Information to define dynamic groups.
|
|
4309
5222
|
*/
|
|
4310
5223
|
export type DynamicGroupInfo = object;
|
|
5224
|
+
/**
|
|
5225
|
+
* dynamic-vista
|
|
5226
|
+
* Dynamic collection of DevRev objects, all adhering to a specific
|
|
5227
|
+
* filter.
|
|
5228
|
+
*/
|
|
5229
|
+
export type DynamicVista = VistaBase & DynamicVistaMeetingsVista & {
|
|
5230
|
+
/** Type of DevRev object for which the vista is applicable. */
|
|
5231
|
+
filter_type: DynamicVistaFilterType;
|
|
5232
|
+
};
|
|
5233
|
+
/** Type of DevRev object for which the vista is applicable. */
|
|
5234
|
+
export declare enum DynamicVistaFilterType {
|
|
5235
|
+
Accounts = "accounts",
|
|
5236
|
+
Articles = "articles",
|
|
5237
|
+
Conversations = "conversations",
|
|
5238
|
+
Credits = "credits",
|
|
5239
|
+
CustomObjects = "custom_objects",
|
|
5240
|
+
DevUsers = "dev_users",
|
|
5241
|
+
Incidents = "incidents",
|
|
5242
|
+
Invoices = "invoices",
|
|
5243
|
+
Meetings = "meetings",
|
|
5244
|
+
Parts = "parts",
|
|
5245
|
+
Quotes = "quotes",
|
|
5246
|
+
RevOrgs = "rev_orgs",
|
|
5247
|
+
RevUsers = "rev_users",
|
|
5248
|
+
Works = "works"
|
|
5249
|
+
}
|
|
5250
|
+
/** dynamic-vista-meetings-vista */
|
|
5251
|
+
export interface DynamicVistaMeetingsVista {
|
|
5252
|
+
filter: MeetingsVistaFilter;
|
|
5253
|
+
/** Pinned items associated with the vista. */
|
|
5254
|
+
items?: DynamicVistaMeetingsVistaItemValue[];
|
|
5255
|
+
}
|
|
5256
|
+
/** dynamic-vista-meetings-vista-item-value */
|
|
5257
|
+
export interface DynamicVistaMeetingsVistaItemValue {
|
|
5258
|
+
item: MeetingSummary;
|
|
5259
|
+
}
|
|
4311
5260
|
/** empty */
|
|
4312
5261
|
export type Empty = object;
|
|
4313
5262
|
/** enhancement */
|
|
@@ -4963,6 +5912,25 @@ export interface EventAiAgentResponse {
|
|
|
4963
5912
|
/** A list of suggestions generated for the AI agent event. */
|
|
4964
5913
|
suggestions?: AiAgentEventSuggestions;
|
|
4965
5914
|
}
|
|
5915
|
+
/** event-article-created */
|
|
5916
|
+
export interface EventArticleCreated {
|
|
5917
|
+
article: Article;
|
|
5918
|
+
}
|
|
5919
|
+
/** event-article-deleted */
|
|
5920
|
+
export interface EventArticleDeleted {
|
|
5921
|
+
/**
|
|
5922
|
+
* The ID of the article that was deleted.
|
|
5923
|
+
* @format id
|
|
5924
|
+
* @example "ARTICLE-12345"
|
|
5925
|
+
*/
|
|
5926
|
+
id: string;
|
|
5927
|
+
old_article?: Article;
|
|
5928
|
+
}
|
|
5929
|
+
/** event-article-updated */
|
|
5930
|
+
export interface EventArticleUpdated {
|
|
5931
|
+
article: Article;
|
|
5932
|
+
old_article?: Article;
|
|
5933
|
+
}
|
|
4966
5934
|
/** event-conversation-created */
|
|
4967
5935
|
export interface EventConversationCreated {
|
|
4968
5936
|
conversation: Conversation;
|
|
@@ -5401,7 +6369,119 @@ export type FeatureSummary = PartBaseSummary;
|
|
|
5401
6369
|
* field-descriptor
|
|
5402
6370
|
* Set of field attributes.
|
|
5403
6371
|
*/
|
|
5404
|
-
export
|
|
6372
|
+
export interface FieldDescriptor {
|
|
6373
|
+
/** The default value for this field. */
|
|
6374
|
+
default_value?: object;
|
|
6375
|
+
/**
|
|
6376
|
+
* Description of the field.
|
|
6377
|
+
* @format text
|
|
6378
|
+
*/
|
|
6379
|
+
description?: string;
|
|
6380
|
+
/** Whether this field is filterable, groupable and sortable. */
|
|
6381
|
+
is_filterable?: boolean;
|
|
6382
|
+
/** Whether this field is immutable or not. */
|
|
6383
|
+
is_immutable?: boolean;
|
|
6384
|
+
/** Whether a stock unified enum can be extended with new values. */
|
|
6385
|
+
is_overridable?: boolean;
|
|
6386
|
+
/** Whether this field is required or not. */
|
|
6387
|
+
is_required?: boolean;
|
|
6388
|
+
/**
|
|
6389
|
+
* Whether this field can hold PII or sensitive information that
|
|
6390
|
+
* should not be logged.
|
|
6391
|
+
*/
|
|
6392
|
+
is_sensitive?: boolean;
|
|
6393
|
+
/** Whether this field is a system field or not. */
|
|
6394
|
+
is_system?: boolean;
|
|
6395
|
+
/**
|
|
6396
|
+
* Name of the field.
|
|
6397
|
+
* @format text
|
|
6398
|
+
*/
|
|
6399
|
+
name?: string;
|
|
6400
|
+
/** Allowed values for a unified enum. */
|
|
6401
|
+
uenum_values?: SchemaFieldUenumValue[];
|
|
6402
|
+
/** The schema of ui specific fields. */
|
|
6403
|
+
ui?: SchemaFieldUiMetadata;
|
|
6404
|
+
/** Validation annotations. */
|
|
6405
|
+
validation?: FieldValidation;
|
|
6406
|
+
}
|
|
6407
|
+
/**
|
|
6408
|
+
* field-validation
|
|
6409
|
+
* Validation annotations.
|
|
6410
|
+
*/
|
|
6411
|
+
export interface FieldValidation {
|
|
6412
|
+
/**
|
|
6413
|
+
* string contains.
|
|
6414
|
+
* @format text
|
|
6415
|
+
*/
|
|
6416
|
+
contains?: string;
|
|
6417
|
+
/** disables validations for this field. */
|
|
6418
|
+
disabled?: boolean;
|
|
6419
|
+
/**
|
|
6420
|
+
* exact array length.
|
|
6421
|
+
* @format int32
|
|
6422
|
+
*/
|
|
6423
|
+
eq_items?: number;
|
|
6424
|
+
/**
|
|
6425
|
+
* exact string length.
|
|
6426
|
+
* @format int32
|
|
6427
|
+
*/
|
|
6428
|
+
eq_len?: number;
|
|
6429
|
+
/**
|
|
6430
|
+
* int must be greater than this.
|
|
6431
|
+
* @format int32
|
|
6432
|
+
*/
|
|
6433
|
+
gt?: number;
|
|
6434
|
+
/**
|
|
6435
|
+
* int must be greater or equal than this.
|
|
6436
|
+
* @format int32
|
|
6437
|
+
*/
|
|
6438
|
+
gte?: number;
|
|
6439
|
+
/**
|
|
6440
|
+
* int must be less than this.
|
|
6441
|
+
* @format int32
|
|
6442
|
+
*/
|
|
6443
|
+
lt?: number;
|
|
6444
|
+
/**
|
|
6445
|
+
* int must be less or equal than this.
|
|
6446
|
+
* @format int32
|
|
6447
|
+
*/
|
|
6448
|
+
lte?: number;
|
|
6449
|
+
/**
|
|
6450
|
+
* maximum array length.
|
|
6451
|
+
* @format int32
|
|
6452
|
+
*/
|
|
6453
|
+
max_items?: number;
|
|
6454
|
+
/**
|
|
6455
|
+
* maximum string length.
|
|
6456
|
+
* @format int32
|
|
6457
|
+
*/
|
|
6458
|
+
max_len?: number;
|
|
6459
|
+
/**
|
|
6460
|
+
* minimum array length.
|
|
6461
|
+
* @format int32
|
|
6462
|
+
*/
|
|
6463
|
+
min_items?: number;
|
|
6464
|
+
/**
|
|
6465
|
+
* minimum string length.
|
|
6466
|
+
* @format int32
|
|
6467
|
+
*/
|
|
6468
|
+
min_len?: number;
|
|
6469
|
+
/**
|
|
6470
|
+
* string pattern (re).
|
|
6471
|
+
* @format text
|
|
6472
|
+
*/
|
|
6473
|
+
pattern?: string;
|
|
6474
|
+
/**
|
|
6475
|
+
* string prefix.
|
|
6476
|
+
* @format text
|
|
6477
|
+
*/
|
|
6478
|
+
prefix?: string;
|
|
6479
|
+
/**
|
|
6480
|
+
* string suffix.
|
|
6481
|
+
* @format text
|
|
6482
|
+
*/
|
|
6483
|
+
suffix?: string;
|
|
6484
|
+
}
|
|
5405
6485
|
/** group */
|
|
5406
6486
|
export type Group = AtomBase;
|
|
5407
6487
|
/** Creation source of the group. */
|
|
@@ -5409,6 +6489,11 @@ export declare enum GroupIngestionSource {
|
|
|
5409
6489
|
Airdrop = "airdrop",
|
|
5410
6490
|
Scim = "scim"
|
|
5411
6491
|
}
|
|
6492
|
+
/** Type of the vista group item object. */
|
|
6493
|
+
export declare enum GroupItemType {
|
|
6494
|
+
Curated = "curated",
|
|
6495
|
+
Dynamic = "dynamic"
|
|
6496
|
+
}
|
|
5412
6497
|
/** Type of the members in the group. */
|
|
5413
6498
|
export declare enum GroupMemberType {
|
|
5414
6499
|
DevUser = "dev_user",
|
|
@@ -5532,6 +6617,28 @@ export declare enum GroupType {
|
|
|
5532
6617
|
Dynamic = "dynamic",
|
|
5533
6618
|
Static = "static"
|
|
5534
6619
|
}
|
|
6620
|
+
/**
|
|
6621
|
+
* grouped-vista
|
|
6622
|
+
* Represents a group of multiple vistas as a single unit.
|
|
6623
|
+
*/
|
|
6624
|
+
export type GroupedVista = VistaBase & {
|
|
6625
|
+
/** Type of DevRev object for which the grouped vista is applicable. */
|
|
6626
|
+
filter_type: GroupedVistaFilterType;
|
|
6627
|
+
/** Denotes the use case of the grouped vista. */
|
|
6628
|
+
flavor?: GroupedVistaFlavor;
|
|
6629
|
+
};
|
|
6630
|
+
/** Type of DevRev object for which the grouped vista is applicable. */
|
|
6631
|
+
export declare enum GroupedVistaFilterType {
|
|
6632
|
+
Conversations = "conversations",
|
|
6633
|
+
Parts = "parts",
|
|
6634
|
+
Works = "works"
|
|
6635
|
+
}
|
|
6636
|
+
/** Denotes the use case of the grouped vista. */
|
|
6637
|
+
export declare enum GroupedVistaFlavor {
|
|
6638
|
+
Nnl = "nnl",
|
|
6639
|
+
SprintBoard = "sprint_board",
|
|
6640
|
+
SupportInbox = "support_inbox"
|
|
6641
|
+
}
|
|
5535
6642
|
/**
|
|
5536
6643
|
* groups-create-request
|
|
5537
6644
|
* A request to create a new group.
|
|
@@ -5906,10 +7013,11 @@ export type Link = AtomBase & {
|
|
|
5906
7013
|
target: LinkEndpointSummary;
|
|
5907
7014
|
};
|
|
5908
7015
|
/** link-endpoint-summary */
|
|
5909
|
-
export type LinkEndpointSummary = (CapabilitySummary | ConversationSummary | DevUserSummary | EnhancementSummary | FeatureSummary | IssueSummary | ProductSummary | RevOrgSummary | RevUserSummary | TicketSummary) & {
|
|
7016
|
+
export type LinkEndpointSummary = (ArticleSummary | CapabilitySummary | ConversationSummary | DevUserSummary | EnhancementSummary | FeatureSummary | IssueSummary | ProductSummary | RevOrgSummary | RevUserSummary | TicketSummary) & {
|
|
5910
7017
|
type: LinkEndpointType;
|
|
5911
7018
|
};
|
|
5912
7019
|
export declare enum LinkEndpointType {
|
|
7020
|
+
Article = "article",
|
|
5913
7021
|
Capability = "capability",
|
|
5914
7022
|
Conversation = "conversation",
|
|
5915
7023
|
DevUser = "dev_user",
|
|
@@ -6153,6 +7261,8 @@ export declare enum MeetingState {
|
|
|
6153
7261
|
Scheduled = "scheduled",
|
|
6154
7262
|
Waiting = "waiting"
|
|
6155
7263
|
}
|
|
7264
|
+
/** meeting-summary */
|
|
7265
|
+
export type MeetingSummary = AtomBaseSummary;
|
|
6156
7266
|
/** meetings-count-request */
|
|
6157
7267
|
export interface MeetingsCountRequest {
|
|
6158
7268
|
/** Filters for meeting on specified channels. */
|
|
@@ -6183,6 +7293,7 @@ export interface MeetingsCountRequest {
|
|
|
6183
7293
|
scheduled_date?: DateFilter;
|
|
6184
7294
|
/** Filters for meeting on specified state or outcomes. */
|
|
6185
7295
|
state?: MeetingState[];
|
|
7296
|
+
sync_metadata?: SyncMetadataFilter;
|
|
6186
7297
|
}
|
|
6187
7298
|
/** meetings-count-response */
|
|
6188
7299
|
export interface MeetingsCountResponse {
|
|
@@ -6369,6 +7480,7 @@ export interface MeetingsListRequest {
|
|
|
6369
7480
|
sort_by?: string[];
|
|
6370
7481
|
/** Filters for meeting on specified state or outcomes. */
|
|
6371
7482
|
state?: MeetingState[];
|
|
7483
|
+
sync_metadata?: SyncMetadataFilter;
|
|
6372
7484
|
}
|
|
6373
7485
|
/** meetings-list-response */
|
|
6374
7486
|
export interface MeetingsListResponse {
|
|
@@ -6484,6 +7596,45 @@ export interface MeetingsUpdateRequestTags {
|
|
|
6484
7596
|
export interface MeetingsUpdateResponse {
|
|
6485
7597
|
meeting: Meeting;
|
|
6486
7598
|
}
|
|
7599
|
+
/** meetings-vista-filter */
|
|
7600
|
+
export interface MeetingsVistaFilter {
|
|
7601
|
+
/** Filters for meeting on specified channels. */
|
|
7602
|
+
channel?: MeetingChannel[];
|
|
7603
|
+
/** Filters for meetings created by the specified user(s). */
|
|
7604
|
+
created_by?: string[];
|
|
7605
|
+
/** Provides ways to specify date ranges on objects. */
|
|
7606
|
+
created_date?: DateFilter;
|
|
7607
|
+
/** Provides ways to specify date ranges on objects. */
|
|
7608
|
+
ended_date?: DateFilter;
|
|
7609
|
+
/** Filters for meetings with the provided external_ref(s). */
|
|
7610
|
+
external_ref?: string[];
|
|
7611
|
+
/**
|
|
7612
|
+
* The field to group the collection by.
|
|
7613
|
+
* @format text
|
|
7614
|
+
*/
|
|
7615
|
+
group_by?: string;
|
|
7616
|
+
/** Filters for links associated with the meeting. */
|
|
7617
|
+
links?: MeetingsFilterLinkSummaryFilter[];
|
|
7618
|
+
/** Filter for meeting on specified Member Ids. */
|
|
7619
|
+
members?: string[];
|
|
7620
|
+
/** Provides ways to specify date ranges on objects. */
|
|
7621
|
+
modified_date?: DateFilter;
|
|
7622
|
+
/** Filter for meeting on specified organizers. */
|
|
7623
|
+
organizer?: string[];
|
|
7624
|
+
/**
|
|
7625
|
+
* Filters for meetings with the provided parent.
|
|
7626
|
+
* @deprecated
|
|
7627
|
+
* @example ["ACC-12345"]
|
|
7628
|
+
*/
|
|
7629
|
+
parent?: string[];
|
|
7630
|
+
/** Provides ways to specify date ranges on objects. */
|
|
7631
|
+
scheduled_date?: DateFilter;
|
|
7632
|
+
/** Comma-separated fields to sort the objects by. */
|
|
7633
|
+
sort_by?: string[];
|
|
7634
|
+
/** Filters for meeting on specified state or outcomes. */
|
|
7635
|
+
state?: MeetingState[];
|
|
7636
|
+
sync_metadata?: SyncMetadataFilter;
|
|
7637
|
+
}
|
|
6487
7638
|
/** member-summary */
|
|
6488
7639
|
export type MemberSummary = (DevUserSummary | GroupSummary | RevUserSummary | SysUserSummary) & {
|
|
6489
7640
|
type: MemberType;
|
|
@@ -7355,6 +8506,8 @@ export interface PartsListRequest {
|
|
|
7355
8506
|
owned_by?: string[];
|
|
7356
8507
|
/** The filter for specifying parent part. */
|
|
7357
8508
|
parent_part?: ParentPartFilter;
|
|
8509
|
+
/** Fields to sort the parts by and the direction to sort them. */
|
|
8510
|
+
sort_by?: string[];
|
|
7358
8511
|
/**
|
|
7359
8512
|
* Filters for part with any of the provided tags.
|
|
7360
8513
|
* @example ["TAG-12345"]
|
|
@@ -7449,6 +8602,19 @@ export interface PartsUpdateRequestTags {
|
|
|
7449
8602
|
export interface PartsUpdateResponse {
|
|
7450
8603
|
part: Part;
|
|
7451
8604
|
}
|
|
8605
|
+
/**
|
|
8606
|
+
* parts-vista-group-item
|
|
8607
|
+
* Represents a nested parts vista group object.
|
|
8608
|
+
*/
|
|
8609
|
+
export type PartsVistaGroupItem = VistaGroupBase & {
|
|
8610
|
+
/** Type of parts vista group item. */
|
|
8611
|
+
type: PartsVistaGroupItemType;
|
|
8612
|
+
};
|
|
8613
|
+
/** Type of parts vista group item. */
|
|
8614
|
+
export declare enum PartsVistaGroupItemType {
|
|
8615
|
+
Curated = "curated",
|
|
8616
|
+
Dynamic = "dynamic"
|
|
8617
|
+
}
|
|
7452
8618
|
/** product */
|
|
7453
8619
|
export type Product = PartBase;
|
|
7454
8620
|
/** product-summary */
|
|
@@ -7586,6 +8752,19 @@ export interface Resource {
|
|
|
7586
8752
|
*/
|
|
7587
8753
|
url?: string;
|
|
7588
8754
|
}
|
|
8755
|
+
/**
|
|
8756
|
+
* resource-summary
|
|
8757
|
+
* Resource details.
|
|
8758
|
+
*/
|
|
8759
|
+
export interface ResourceSummary {
|
|
8760
|
+
/** Artifacts of the resource (relevant only for type artifact). */
|
|
8761
|
+
artifacts?: ArtifactSummary[];
|
|
8762
|
+
/**
|
|
8763
|
+
* URL of the resource (relevant only for type url).
|
|
8764
|
+
* @format text
|
|
8765
|
+
*/
|
|
8766
|
+
url?: string;
|
|
8767
|
+
}
|
|
7589
8768
|
/** rev-org */
|
|
7590
8769
|
export type RevOrg = OrgBase & {
|
|
7591
8770
|
/**
|
|
@@ -7607,6 +8786,7 @@ export type RevOrg = OrgBase & {
|
|
|
7607
8786
|
* @format text
|
|
7608
8787
|
*/
|
|
7609
8788
|
external_ref?: string;
|
|
8789
|
+
primary_rev_org?: OrgSummary;
|
|
7610
8790
|
};
|
|
7611
8791
|
/** rev-org-summary */
|
|
7612
8792
|
export type RevOrgSummary = OrgBaseSummary;
|
|
@@ -8353,12 +9533,85 @@ export type SchemaFieldOasisMetadata = object;
|
|
|
8353
9533
|
* schema-field-uenum-value
|
|
8354
9534
|
* A unified enum value.
|
|
8355
9535
|
*/
|
|
8356
|
-
export
|
|
9536
|
+
export interface SchemaFieldUenumValue {
|
|
9537
|
+
/**
|
|
9538
|
+
* The immutable id of the enum value.
|
|
9539
|
+
* @format int64
|
|
9540
|
+
*/
|
|
9541
|
+
id: number;
|
|
9542
|
+
/** True if this value is deprecated. */
|
|
9543
|
+
is_deprecated?: boolean;
|
|
9544
|
+
/**
|
|
9545
|
+
* The human readable name of the enum value.
|
|
9546
|
+
* @format text
|
|
9547
|
+
*/
|
|
9548
|
+
label: string;
|
|
9549
|
+
/**
|
|
9550
|
+
* The order value of the enum.
|
|
9551
|
+
* @format int64
|
|
9552
|
+
*/
|
|
9553
|
+
ordinal: number;
|
|
9554
|
+
/**
|
|
9555
|
+
* Tooltip shown in the UI for this value.
|
|
9556
|
+
* @format text
|
|
9557
|
+
*/
|
|
9558
|
+
tooltip?: string;
|
|
9559
|
+
}
|
|
8357
9560
|
/**
|
|
8358
9561
|
* schema-field-ui-metadata
|
|
8359
9562
|
* The schema of ui specific fields.
|
|
8360
9563
|
*/
|
|
8361
|
-
export
|
|
9564
|
+
export interface SchemaFieldUiMetadata {
|
|
9565
|
+
/** The client overrides for the field. */
|
|
9566
|
+
client_overrides?: ClientOverride[];
|
|
9567
|
+
/**
|
|
9568
|
+
* Number of decimal places to show (only applicable for number
|
|
9569
|
+
* fields).
|
|
9570
|
+
* @format int32
|
|
9571
|
+
*/
|
|
9572
|
+
decimal_places?: number;
|
|
9573
|
+
/**
|
|
9574
|
+
* The display name of the field.
|
|
9575
|
+
* @format text
|
|
9576
|
+
*/
|
|
9577
|
+
display_name?: string;
|
|
9578
|
+
/**
|
|
9579
|
+
* An optional group name for the field.
|
|
9580
|
+
* @format text
|
|
9581
|
+
*/
|
|
9582
|
+
group_name?: string;
|
|
9583
|
+
/** Whether the field is groupable in the UI. */
|
|
9584
|
+
is_groupable?: boolean;
|
|
9585
|
+
/** Whether the field is hidden in the UI. */
|
|
9586
|
+
is_hidden?: boolean;
|
|
9587
|
+
/** Whether the field is sortable in the UI. */
|
|
9588
|
+
is_sortable?: boolean;
|
|
9589
|
+
/**
|
|
9590
|
+
* Order in which field is shown.
|
|
9591
|
+
* @format int32
|
|
9592
|
+
*/
|
|
9593
|
+
order?: number;
|
|
9594
|
+
/**
|
|
9595
|
+
* A placeholder for the field.
|
|
9596
|
+
* @format text
|
|
9597
|
+
*/
|
|
9598
|
+
placeholder?: string;
|
|
9599
|
+
/**
|
|
9600
|
+
* Tooltip for the field.
|
|
9601
|
+
* @format text
|
|
9602
|
+
*/
|
|
9603
|
+
tooltip?: string;
|
|
9604
|
+
/**
|
|
9605
|
+
* Unit of measurment.
|
|
9606
|
+
* @format text
|
|
9607
|
+
*/
|
|
9608
|
+
unit?: string;
|
|
9609
|
+
/**
|
|
9610
|
+
* Whether to use shorthand notation (only applicable for number
|
|
9611
|
+
* fields).
|
|
9612
|
+
*/
|
|
9613
|
+
use_shorthand_notation?: boolean;
|
|
9614
|
+
}
|
|
8362
9615
|
/** schema-id-field-descriptor */
|
|
8363
9616
|
export type SchemaIdFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
8364
9617
|
/**
|
|
@@ -8730,6 +9983,71 @@ export type SchemaUenumListFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
|
8730
9983
|
};
|
|
8731
9984
|
/** schema-unknown-field-descriptor */
|
|
8732
9985
|
export type SchemaUnknownFieldDescriptor = SchemaFieldDescriptorBase;
|
|
9986
|
+
/** schemas-subtype-prepare-update-get-request */
|
|
9987
|
+
export interface SchemasSubtypePrepareUpdateGetRequest {
|
|
9988
|
+
/** Whether the leaf type corresponds to a custom object. */
|
|
9989
|
+
is_custom_leaf_type?: boolean;
|
|
9990
|
+
/**
|
|
9991
|
+
* Leaf type of the object.
|
|
9992
|
+
* @format text
|
|
9993
|
+
*/
|
|
9994
|
+
leaf_type: string;
|
|
9995
|
+
/**
|
|
9996
|
+
* Name of the new subtype for the object.
|
|
9997
|
+
* @format text
|
|
9998
|
+
*/
|
|
9999
|
+
new_subtype?: string;
|
|
10000
|
+
/**
|
|
10001
|
+
* ID of the object of which subtype is to be changed. Used to fetch
|
|
10002
|
+
* the object's custom schema fragments and custom fields
|
|
10003
|
+
* @format id
|
|
10004
|
+
*/
|
|
10005
|
+
object?: string;
|
|
10006
|
+
}
|
|
10007
|
+
/** schemas-subtype-prepare-update-get-response */
|
|
10008
|
+
export interface SchemasSubtypePrepareUpdateGetResponse {
|
|
10009
|
+
/** List of fields that have a default value and need to be set. */
|
|
10010
|
+
added_fields?: SchemasSubtypePrepareUpdateGetResponseAddedField[];
|
|
10011
|
+
/** List of fields that will be dropped from the object. */
|
|
10012
|
+
dropped_fields?: SchemasSubtypePrepareUpdateGetResponseDroppedField[];
|
|
10013
|
+
/** List of new custom schema fragment IDs of the object. */
|
|
10014
|
+
new_custom_schema_fragments?: string[];
|
|
10015
|
+
/**
|
|
10016
|
+
* ID of the start stage of the new diagram if the subtype change
|
|
10017
|
+
* results in a change in the stage diagram.
|
|
10018
|
+
* @format id
|
|
10019
|
+
*/
|
|
10020
|
+
new_start_stage?: string;
|
|
10021
|
+
}
|
|
10022
|
+
/** schemas-subtype-prepare-update-get-response-added-field */
|
|
10023
|
+
export interface SchemasSubtypePrepareUpdateGetResponseAddedField {
|
|
10024
|
+
/** Default value of the added field. */
|
|
10025
|
+
default_value?: any;
|
|
10026
|
+
/**
|
|
10027
|
+
* API-compliant qualified name of the added field.
|
|
10028
|
+
* @format text
|
|
10029
|
+
*/
|
|
10030
|
+
name: string;
|
|
10031
|
+
}
|
|
10032
|
+
export declare enum SchemasSubtypePrepareUpdateGetResponseConflictType {
|
|
10033
|
+
AbsentInNew = "absent_in_new",
|
|
10034
|
+
AbsentInOld = "absent_in_old",
|
|
10035
|
+
IncompatibleType = "incompatible_type"
|
|
10036
|
+
}
|
|
10037
|
+
/** schemas-subtype-prepare-update-get-response-dropped-field */
|
|
10038
|
+
export interface SchemasSubtypePrepareUpdateGetResponseDroppedField {
|
|
10039
|
+
conflict_type: SchemasSubtypePrepareUpdateGetResponseConflictType;
|
|
10040
|
+
/**
|
|
10041
|
+
* Conflict message for the field being dropped.
|
|
10042
|
+
* @format text
|
|
10043
|
+
*/
|
|
10044
|
+
message: string;
|
|
10045
|
+
/**
|
|
10046
|
+
* API-compliant qualified name of the dropped field.
|
|
10047
|
+
* @format text
|
|
10048
|
+
*/
|
|
10049
|
+
name: string;
|
|
10050
|
+
}
|
|
8733
10051
|
/** service-account */
|
|
8734
10052
|
export type ServiceAccount = UserBase;
|
|
8735
10053
|
/** service-account-summary */
|
|
@@ -9495,6 +10813,136 @@ export interface SnapWidgetsCreateResponse {
|
|
|
9495
10813
|
* Describes the current stage of a object.
|
|
9496
10814
|
*/
|
|
9497
10815
|
export type Stage = object;
|
|
10816
|
+
/** stage-diagram */
|
|
10817
|
+
export type StageDiagram = AtomBase & {
|
|
10818
|
+
/** True if this stage diagram corresponds to a custom leaf type. */
|
|
10819
|
+
is_custom_leaf_type?: boolean;
|
|
10820
|
+
/** True if this stage diagram is the default for the leaf type. */
|
|
10821
|
+
is_default?: boolean;
|
|
10822
|
+
/**
|
|
10823
|
+
* The leaf type this stage diagram applies to.
|
|
10824
|
+
* @format text
|
|
10825
|
+
*/
|
|
10826
|
+
leaf_type?: string;
|
|
10827
|
+
/**
|
|
10828
|
+
* The human readable name of the stage diagram.
|
|
10829
|
+
* @format text
|
|
10830
|
+
*/
|
|
10831
|
+
name?: string;
|
|
10832
|
+
/**
|
|
10833
|
+
* List of stages with their allowed transitions in this stage
|
|
10834
|
+
* diagram.
|
|
10835
|
+
*/
|
|
10836
|
+
stages: StageNode[];
|
|
10837
|
+
};
|
|
10838
|
+
/** stage-diagram-summary */
|
|
10839
|
+
export type StageDiagramSummary = AtomBaseSummary & {
|
|
10840
|
+
/**
|
|
10841
|
+
* The human readable name of the stage diagram.
|
|
10842
|
+
* @format text
|
|
10843
|
+
*/
|
|
10844
|
+
name?: string;
|
|
10845
|
+
};
|
|
10846
|
+
/** stage-diagrams-create-request */
|
|
10847
|
+
export interface StageDiagramsCreateRequest {
|
|
10848
|
+
/** Whether the leaf type corresponds to a custom object. */
|
|
10849
|
+
is_custom_leaf_type?: boolean;
|
|
10850
|
+
/** Whether this is a default stage diagram. */
|
|
10851
|
+
is_default?: boolean;
|
|
10852
|
+
/**
|
|
10853
|
+
* The leaf type this stage diagram applies to.
|
|
10854
|
+
* @format text
|
|
10855
|
+
*/
|
|
10856
|
+
leaf_type: string;
|
|
10857
|
+
/**
|
|
10858
|
+
* The name of the stage diagram. Stage diagram is used for defining
|
|
10859
|
+
* stage transitions.
|
|
10860
|
+
* @format text
|
|
10861
|
+
*/
|
|
10862
|
+
name: string;
|
|
10863
|
+
/** List of stages in the diagram. */
|
|
10864
|
+
stages: CreateStageNode[];
|
|
10865
|
+
}
|
|
10866
|
+
/** stage-diagrams-create-response */
|
|
10867
|
+
export interface StageDiagramsCreateResponse {
|
|
10868
|
+
stage_diagram: StageDiagram;
|
|
10869
|
+
}
|
|
10870
|
+
/** stage-diagrams-get-request */
|
|
10871
|
+
export interface StageDiagramsGetRequest {
|
|
10872
|
+
/**
|
|
10873
|
+
* The ID of the stage diagram to get.
|
|
10874
|
+
* @format id
|
|
10875
|
+
*/
|
|
10876
|
+
id?: string;
|
|
10877
|
+
/**
|
|
10878
|
+
* Whether the leaf type corresponds to a custom object. Specify this
|
|
10879
|
+
* along with leaf_type to get the default custom object stage
|
|
10880
|
+
* diagram.
|
|
10881
|
+
*/
|
|
10882
|
+
is_custom_leaf_type?: boolean;
|
|
10883
|
+
/**
|
|
10884
|
+
* The leaf type. Should be specified to retrieve the default stage
|
|
10885
|
+
* diagram for the leaf type. If not provided, then id is used.
|
|
10886
|
+
* @format text
|
|
10887
|
+
*/
|
|
10888
|
+
leaf_type?: string;
|
|
10889
|
+
}
|
|
10890
|
+
/** stage-diagrams-get-response */
|
|
10891
|
+
export interface StageDiagramsGetResponse {
|
|
10892
|
+
stage_diagram: StageDiagram;
|
|
10893
|
+
}
|
|
10894
|
+
/** stage-diagrams-list-request */
|
|
10895
|
+
export interface StageDiagramsListRequest {
|
|
10896
|
+
/**
|
|
10897
|
+
* The cursor to resume iteration from, otherwise if not provided,
|
|
10898
|
+
* then iteration starts from the beginning.
|
|
10899
|
+
* @format text
|
|
10900
|
+
*/
|
|
10901
|
+
cursor?: string;
|
|
10902
|
+
/** Whether only custom object stage diagrams should be filtered. */
|
|
10903
|
+
is_custom_leaf_type?: boolean;
|
|
10904
|
+
/** The list of leaf types. */
|
|
10905
|
+
leaf_type?: string[];
|
|
10906
|
+
/**
|
|
10907
|
+
* The maximum number of items.
|
|
10908
|
+
* @format int32
|
|
10909
|
+
*/
|
|
10910
|
+
limit?: number;
|
|
10911
|
+
/** The list of stage diagram names. */
|
|
10912
|
+
name?: string[];
|
|
10913
|
+
/** The list of fields to sort the items by and how to sort them. */
|
|
10914
|
+
sort_by?: string[];
|
|
10915
|
+
}
|
|
10916
|
+
/** stage-diagrams-list-response */
|
|
10917
|
+
export interface StageDiagramsListResponse {
|
|
10918
|
+
/**
|
|
10919
|
+
* The cursor to resume iteration from, otherwise if not provided,
|
|
10920
|
+
* then iteration starts from the beginning.
|
|
10921
|
+
* @format text
|
|
10922
|
+
*/
|
|
10923
|
+
cursor?: string;
|
|
10924
|
+
/** The stage diagram. */
|
|
10925
|
+
result: StageDiagram[];
|
|
10926
|
+
}
|
|
10927
|
+
/** stage-diagrams-update-request */
|
|
10928
|
+
export interface StageDiagramsUpdateRequest {
|
|
10929
|
+
/**
|
|
10930
|
+
* The ID of the stage diagram to update.
|
|
10931
|
+
* @format id
|
|
10932
|
+
*/
|
|
10933
|
+
id: string;
|
|
10934
|
+
/**
|
|
10935
|
+
* The updated name of the stage diagram.
|
|
10936
|
+
* @format text
|
|
10937
|
+
*/
|
|
10938
|
+
name?: string;
|
|
10939
|
+
/** List of stages in the stage diagram. */
|
|
10940
|
+
stages?: UpdateStageNode[];
|
|
10941
|
+
}
|
|
10942
|
+
/** stage-diagrams-update-response */
|
|
10943
|
+
export interface StageDiagramsUpdateResponse {
|
|
10944
|
+
stage_diagram: StageDiagram;
|
|
10945
|
+
}
|
|
9498
10946
|
/**
|
|
9499
10947
|
* stage-filter
|
|
9500
10948
|
* The filter for stages.
|
|
@@ -9509,34 +10957,162 @@ export interface StageFilter {
|
|
|
9509
10957
|
*/
|
|
9510
10958
|
export interface StageInit {
|
|
9511
10959
|
/**
|
|
9512
|
-
* The name of the stage.
|
|
10960
|
+
* The name of the stage.
|
|
10961
|
+
* @format text
|
|
10962
|
+
*/
|
|
10963
|
+
name?: string;
|
|
10964
|
+
}
|
|
10965
|
+
/**
|
|
10966
|
+
* stage-node
|
|
10967
|
+
* Diagram stage.
|
|
10968
|
+
*/
|
|
10969
|
+
export interface StageNode {
|
|
10970
|
+
/** True if this stage has been deprecated. */
|
|
10971
|
+
is_deprecated?: boolean;
|
|
10972
|
+
/** True if this stage is the starting stage of the stage diagram. */
|
|
10973
|
+
is_start?: boolean;
|
|
10974
|
+
stage?: CustomStageSummary;
|
|
10975
|
+
/** List of allowed transitions from this stage. */
|
|
10976
|
+
transitions?: StageTransition[];
|
|
10977
|
+
}
|
|
10978
|
+
/**
|
|
10979
|
+
* stage-transition
|
|
10980
|
+
* Stage transition.
|
|
10981
|
+
*/
|
|
10982
|
+
export interface StageTransition {
|
|
10983
|
+
target_stage?: CustomStageSummary;
|
|
10984
|
+
}
|
|
10985
|
+
/**
|
|
10986
|
+
* stage-update
|
|
10987
|
+
* Updates an object's stage.
|
|
10988
|
+
*/
|
|
10989
|
+
export interface StageUpdate {
|
|
10990
|
+
/**
|
|
10991
|
+
* The updated name of the stage, otherwise unchanged if not set.
|
|
10992
|
+
* @format text
|
|
10993
|
+
*/
|
|
10994
|
+
name?: string;
|
|
10995
|
+
}
|
|
10996
|
+
/** Type of stage validation options when creating an object. */
|
|
10997
|
+
export declare enum StageValidationOptionForCreate {
|
|
10998
|
+
AllowNonStart = "allow_non_start"
|
|
10999
|
+
}
|
|
11000
|
+
/** Type of state validation options when updating the stage of an object. */
|
|
11001
|
+
export declare enum StageValidationOptionForUpdate {
|
|
11002
|
+
AllowInvalidTransition = "allow_invalid_transition"
|
|
11003
|
+
}
|
|
11004
|
+
/** staged-info-filter */
|
|
11005
|
+
export interface StagedInfoFilter {
|
|
11006
|
+
/** Filters for issues that are staged. */
|
|
11007
|
+
is_staged?: boolean;
|
|
11008
|
+
}
|
|
11009
|
+
/**
|
|
11010
|
+
* stock-field-override
|
|
11011
|
+
* A stock field override.
|
|
11012
|
+
*/
|
|
11013
|
+
export interface StockFieldOverride {
|
|
11014
|
+
/** Whether the field is required. */
|
|
11015
|
+
is_required?: boolean;
|
|
11016
|
+
/**
|
|
11017
|
+
* Name of the stock field to be overridden.
|
|
11018
|
+
* @format text
|
|
11019
|
+
*/
|
|
11020
|
+
name?: string;
|
|
11021
|
+
/** The schema of ui specific fields. */
|
|
11022
|
+
ui?: SchemaFieldUiMetadata;
|
|
11023
|
+
}
|
|
11024
|
+
/** stock-schema-fragment */
|
|
11025
|
+
export type StockSchemaFragment = AtomBase & {
|
|
11026
|
+
/** List of composite schemas. */
|
|
11027
|
+
composite_schemas: CompositeSchema[];
|
|
11028
|
+
/**
|
|
11029
|
+
* Description of the schema.
|
|
11030
|
+
* @format text
|
|
11031
|
+
*/
|
|
11032
|
+
description?: string;
|
|
11033
|
+
/** List of all fields in this schema. */
|
|
11034
|
+
fields: SchemaFieldDescriptor[];
|
|
11035
|
+
/**
|
|
11036
|
+
* Leaf type this fragment applies to.
|
|
11037
|
+
* @format text
|
|
11038
|
+
*/
|
|
11039
|
+
leaf_type?: string;
|
|
11040
|
+
new_fragment_ref?: AtomSummary;
|
|
11041
|
+
old_fragment_ref?: AtomSummary;
|
|
11042
|
+
};
|
|
11043
|
+
/** stock-schema-fragments-get-request */
|
|
11044
|
+
export interface StockSchemaFragmentsGetRequest {
|
|
11045
|
+
/**
|
|
11046
|
+
* The ID of the stock schema fragment.
|
|
11047
|
+
* @format id
|
|
11048
|
+
*/
|
|
11049
|
+
id?: string;
|
|
11050
|
+
/**
|
|
11051
|
+
* The leaf type this fragment applies to.
|
|
11052
|
+
* @format text
|
|
11053
|
+
*/
|
|
11054
|
+
leaf_type?: string;
|
|
11055
|
+
}
|
|
11056
|
+
/** stock-schema-fragments-get-response */
|
|
11057
|
+
export interface StockSchemaFragmentsGetResponse {
|
|
11058
|
+
fragment: StockSchemaFragment;
|
|
11059
|
+
}
|
|
11060
|
+
/** stock-schema-fragments-list-request */
|
|
11061
|
+
export interface StockSchemaFragmentsListRequest {
|
|
11062
|
+
/**
|
|
11063
|
+
* The cursor to resume iteration from. If not provided, then
|
|
11064
|
+
* iteration starts from the beginning.
|
|
11065
|
+
* @format text
|
|
11066
|
+
*/
|
|
11067
|
+
cursor?: string;
|
|
11068
|
+
filter_preset?: StockSchemaFragmentsListRequestFilterPreset;
|
|
11069
|
+
/** The list of leaf types. */
|
|
11070
|
+
leaf_type?: string[];
|
|
11071
|
+
/**
|
|
11072
|
+
* The maximum number of items.
|
|
11073
|
+
* @format int32
|
|
11074
|
+
*/
|
|
11075
|
+
limit?: number;
|
|
11076
|
+
/**
|
|
11077
|
+
* The iteration mode to use. If "after", then entries after the provided
|
|
11078
|
+
* cursor will be returned, or if no cursor is provided, then from the
|
|
11079
|
+
* beginning. If "before", then entries before the provided cursor will be
|
|
11080
|
+
* returned, or if no cursor is provided, then from the end. Entries will
|
|
11081
|
+
* always be returned in the specified sort-by order.
|
|
11082
|
+
*/
|
|
11083
|
+
mode?: ListMode;
|
|
11084
|
+
/**
|
|
11085
|
+
* List of fields which are not required in the payload and can be
|
|
11086
|
+
* pruned away.
|
|
11087
|
+
*/
|
|
11088
|
+
prune?: StockSchemaFragmentsListRequestPrune[];
|
|
11089
|
+
/** The list of fields to sort the items by and how to sort them. */
|
|
11090
|
+
sort_by?: string[];
|
|
11091
|
+
}
|
|
11092
|
+
export declare enum StockSchemaFragmentsListRequestFilterPreset {
|
|
11093
|
+
CustomizableTypesPreset = "customizable_types_preset",
|
|
11094
|
+
NoPreset = "no_preset"
|
|
11095
|
+
}
|
|
11096
|
+
export declare enum StockSchemaFragmentsListRequestPrune {
|
|
11097
|
+
CompositeSchemas = "composite_schemas",
|
|
11098
|
+
Fields = "fields"
|
|
11099
|
+
}
|
|
11100
|
+
/** stock-schema-fragments-list-response */
|
|
11101
|
+
export interface StockSchemaFragmentsListResponse {
|
|
11102
|
+
/**
|
|
11103
|
+
* The cursor used to iterate subsequent results in accordance to the
|
|
11104
|
+
* sort order. If not set, then no later elements exist.
|
|
9513
11105
|
* @format text
|
|
9514
11106
|
*/
|
|
9515
|
-
|
|
9516
|
-
}
|
|
9517
|
-
/**
|
|
9518
|
-
* stage-update
|
|
9519
|
-
* Updates an object's stage.
|
|
9520
|
-
*/
|
|
9521
|
-
export interface StageUpdate {
|
|
11107
|
+
next_cursor?: string;
|
|
9522
11108
|
/**
|
|
9523
|
-
* The
|
|
11109
|
+
* The cursor used to iterate preceding results in accordance to the
|
|
11110
|
+
* sort order. If not set, then no prior elements exist.
|
|
9524
11111
|
* @format text
|
|
9525
11112
|
*/
|
|
9526
|
-
|
|
9527
|
-
|
|
9528
|
-
|
|
9529
|
-
export declare enum StageValidationOptionForCreate {
|
|
9530
|
-
AllowNonStart = "allow_non_start"
|
|
9531
|
-
}
|
|
9532
|
-
/** Type of state validation options when updating the stage of an object. */
|
|
9533
|
-
export declare enum StageValidationOptionForUpdate {
|
|
9534
|
-
AllowInvalidTransition = "allow_invalid_transition"
|
|
9535
|
-
}
|
|
9536
|
-
/** staged-info-filter */
|
|
9537
|
-
export interface StagedInfoFilter {
|
|
9538
|
-
/** Filters for issues that are staged. */
|
|
9539
|
-
is_staged?: boolean;
|
|
11113
|
+
prev_cursor?: string;
|
|
11114
|
+
/** The stock schema fragments. */
|
|
11115
|
+
result: StockSchemaFragment[];
|
|
9540
11116
|
}
|
|
9541
11117
|
/** survey */
|
|
9542
11118
|
export type Survey = AtomBase & {
|
|
@@ -10750,6 +12326,7 @@ export type TimelineEntryBase = AtomBase & {
|
|
|
10750
12326
|
export type TimelineEntryBaseSummary = AtomBaseSummary;
|
|
10751
12327
|
/** The type of object that the Timeline entry belongs to. */
|
|
10752
12328
|
export declare enum TimelineEntryObjectType {
|
|
12329
|
+
Article = "article",
|
|
10753
12330
|
Capability = "capability",
|
|
10754
12331
|
Conversation = "conversation",
|
|
10755
12332
|
Enhancement = "enhancement",
|
|
@@ -10842,6 +12419,34 @@ export interface UpdateCommandSurface {
|
|
|
10842
12419
|
/** Surfaces from where this command can be invoked. */
|
|
10843
12420
|
surface?: CommandSurfaceSurface;
|
|
10844
12421
|
}
|
|
12422
|
+
/** update-stage-node */
|
|
12423
|
+
export interface UpdateStageNode {
|
|
12424
|
+
/** Whether this stage is deprecated. */
|
|
12425
|
+
is_deprecated?: boolean;
|
|
12426
|
+
/** Whether this is the start stage. */
|
|
12427
|
+
is_start?: boolean;
|
|
12428
|
+
/**
|
|
12429
|
+
* The ID of the stage.
|
|
12430
|
+
* @format id
|
|
12431
|
+
*/
|
|
12432
|
+
stage_id: string;
|
|
12433
|
+
/** List of transitions from this stage. */
|
|
12434
|
+
transitions?: UpdateStageTransition[];
|
|
12435
|
+
}
|
|
12436
|
+
/** update-stage-transition */
|
|
12437
|
+
export interface UpdateStageTransition {
|
|
12438
|
+
/**
|
|
12439
|
+
* The ID of the target stage.
|
|
12440
|
+
* @format id
|
|
12441
|
+
*/
|
|
12442
|
+
target_stage_id: string;
|
|
12443
|
+
ui?: UpdateStageUiMetadata;
|
|
12444
|
+
}
|
|
12445
|
+
/** update-stage-ui-metadata */
|
|
12446
|
+
export interface UpdateStageUiMetadata {
|
|
12447
|
+
/** Whether the stage is hidden. */
|
|
12448
|
+
is_hidden?: boolean;
|
|
12449
|
+
}
|
|
10845
12450
|
/** user-base */
|
|
10846
12451
|
export type UserBase = AtomBase & {
|
|
10847
12452
|
/**
|
|
@@ -10862,6 +12467,7 @@ export type UserBase = AtomBase & {
|
|
|
10862
12467
|
full_name?: string;
|
|
10863
12468
|
/** Phone numbers of the user. */
|
|
10864
12469
|
phone_numbers?: string[];
|
|
12470
|
+
primary_identity?: UserSummary;
|
|
10865
12471
|
/** State of the user. */
|
|
10866
12472
|
state?: UserState;
|
|
10867
12473
|
};
|
|
@@ -10916,6 +12522,146 @@ export declare enum UserType {
|
|
|
10916
12522
|
ServiceAccount = "service_account",
|
|
10917
12523
|
SysUser = "sys_user"
|
|
10918
12524
|
}
|
|
12525
|
+
/**
|
|
12526
|
+
* view-override
|
|
12527
|
+
* UI hint overrides for a view.
|
|
12528
|
+
*/
|
|
12529
|
+
export interface ViewOverride {
|
|
12530
|
+
/**
|
|
12531
|
+
* Number of decimal places to show. Only applicable for number
|
|
12532
|
+
* fields.
|
|
12533
|
+
* @format int32
|
|
12534
|
+
*/
|
|
12535
|
+
decimal_places?: number;
|
|
12536
|
+
/**
|
|
12537
|
+
* The display name of the field.
|
|
12538
|
+
* @format text
|
|
12539
|
+
*/
|
|
12540
|
+
display_name?: string;
|
|
12541
|
+
/** Whether the field is groupable in the UI. */
|
|
12542
|
+
is_groupable?: boolean;
|
|
12543
|
+
/** Whether the field is hidden in the UI. */
|
|
12544
|
+
is_hidden?: boolean;
|
|
12545
|
+
/**
|
|
12546
|
+
* Relative order in which the field is shown.
|
|
12547
|
+
* @format int32
|
|
12548
|
+
*/
|
|
12549
|
+
order?: number;
|
|
12550
|
+
/**
|
|
12551
|
+
* A placeholder for the field.
|
|
12552
|
+
* @format text
|
|
12553
|
+
*/
|
|
12554
|
+
placeholder?: string;
|
|
12555
|
+
/**
|
|
12556
|
+
* Tooltip for the field.
|
|
12557
|
+
* @format text
|
|
12558
|
+
*/
|
|
12559
|
+
tooltip?: string;
|
|
12560
|
+
/**
|
|
12561
|
+
* Whether to use shorthand notation. Example, 1K instead of 1000.
|
|
12562
|
+
* Only applicable for number fields.
|
|
12563
|
+
*/
|
|
12564
|
+
use_shorthand_notation?: boolean;
|
|
12565
|
+
/**
|
|
12566
|
+
* The name of the view.
|
|
12567
|
+
* @format text
|
|
12568
|
+
*/
|
|
12569
|
+
view_name?: string;
|
|
12570
|
+
}
|
|
12571
|
+
/**
|
|
12572
|
+
* vista
|
|
12573
|
+
* Represents a collection of DevRev objects.
|
|
12574
|
+
*/
|
|
12575
|
+
export type Vista = (CuratedVista | DynamicVista | GroupedVista) & {
|
|
12576
|
+
/** Type of vista object. */
|
|
12577
|
+
type: VistaType;
|
|
12578
|
+
};
|
|
12579
|
+
/** vista-base */
|
|
12580
|
+
export type VistaBase = AtomBase & {
|
|
12581
|
+
/** Boolean to specify whether it's a default Vista or not. */
|
|
12582
|
+
is_default?: boolean;
|
|
12583
|
+
/**
|
|
12584
|
+
* Name of the vista.
|
|
12585
|
+
* @format text
|
|
12586
|
+
*/
|
|
12587
|
+
name: string;
|
|
12588
|
+
/** Users and groups associated with vista. */
|
|
12589
|
+
shared_with?: SharedWithMembership[];
|
|
12590
|
+
};
|
|
12591
|
+
/** Denotes the use case of the vista. */
|
|
12592
|
+
export declare enum VistaFlavor {
|
|
12593
|
+
Nnl = "nnl",
|
|
12594
|
+
SprintBoard = "sprint_board",
|
|
12595
|
+
SupportInbox = "support_inbox"
|
|
12596
|
+
}
|
|
12597
|
+
/**
|
|
12598
|
+
* vista-group
|
|
12599
|
+
* Represents a vista group item.
|
|
12600
|
+
*/
|
|
12601
|
+
export type VistaGroup = (ConversationsVistaGroupItem | PartsVistaGroupItem | WorksVistaGroupItem) & {
|
|
12602
|
+
/** Type of DevRev object for which the grouped vista is applicable. */
|
|
12603
|
+
object_type: GroupedVistaFilterType;
|
|
12604
|
+
};
|
|
12605
|
+
/** vista-group-base */
|
|
12606
|
+
export interface VistaGroupBase {
|
|
12607
|
+
/**
|
|
12608
|
+
* Timestamp when the vista group item ends.
|
|
12609
|
+
* @format date-time
|
|
12610
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
12611
|
+
*/
|
|
12612
|
+
end_date?: string;
|
|
12613
|
+
/**
|
|
12614
|
+
* Globally unique object ID.
|
|
12615
|
+
* @format id
|
|
12616
|
+
*/
|
|
12617
|
+
id: string;
|
|
12618
|
+
/**
|
|
12619
|
+
* Name of the group.
|
|
12620
|
+
* @format text
|
|
12621
|
+
*/
|
|
12622
|
+
name: string;
|
|
12623
|
+
parent?: VistaGroupBaseVistaParentComposite;
|
|
12624
|
+
/**
|
|
12625
|
+
* Timestamp when the vista group item starts.
|
|
12626
|
+
* @format date-time
|
|
12627
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
12628
|
+
*/
|
|
12629
|
+
start_date?: string;
|
|
12630
|
+
/** Defines the state of the group item. */
|
|
12631
|
+
state?: VistaGroupItemState;
|
|
12632
|
+
}
|
|
12633
|
+
/** vista-group-base-vista-parent-composite */
|
|
12634
|
+
export interface VistaGroupBaseVistaParentComposite {
|
|
12635
|
+
/**
|
|
12636
|
+
* Type of the parent vista.
|
|
12637
|
+
* @format text
|
|
12638
|
+
*/
|
|
12639
|
+
type: string;
|
|
12640
|
+
/**
|
|
12641
|
+
* Human-readable object ID unique to the Dev organization.
|
|
12642
|
+
* @format text
|
|
12643
|
+
*/
|
|
12644
|
+
display_id: string;
|
|
12645
|
+
/** Denotes the use case of the vista. */
|
|
12646
|
+
flavor?: VistaFlavor;
|
|
12647
|
+
/**
|
|
12648
|
+
* Parent vista ID.
|
|
12649
|
+
* @format id
|
|
12650
|
+
* @example "VISTA-12345"
|
|
12651
|
+
*/
|
|
12652
|
+
id: string;
|
|
12653
|
+
/**
|
|
12654
|
+
* Name of the parent vista.
|
|
12655
|
+
* @format text
|
|
12656
|
+
*/
|
|
12657
|
+
name: string;
|
|
12658
|
+
}
|
|
12659
|
+
/** Type of DevRev object for which the vista group item is applicable. */
|
|
12660
|
+
export declare enum VistaGroupItemGroupObjectType {
|
|
12661
|
+
Conversation = "conversation",
|
|
12662
|
+
Part = "part",
|
|
12663
|
+
Work = "work"
|
|
12664
|
+
}
|
|
10919
12665
|
/** Defines the state of the group item. */
|
|
10920
12666
|
export declare enum VistaGroupItemState {
|
|
10921
12667
|
Active = "active",
|
|
@@ -10959,6 +12705,226 @@ export declare enum VistaGroupItemType {
|
|
|
10959
12705
|
Curated = "curated",
|
|
10960
12706
|
Dynamic = "dynamic"
|
|
10961
12707
|
}
|
|
12708
|
+
/** Type of vista object. */
|
|
12709
|
+
export declare enum VistaType {
|
|
12710
|
+
Curated = "curated",
|
|
12711
|
+
Dynamic = "dynamic",
|
|
12712
|
+
Grouped = "grouped"
|
|
12713
|
+
}
|
|
12714
|
+
/**
|
|
12715
|
+
* vistas-delete-request
|
|
12716
|
+
* The request to delete a vista.
|
|
12717
|
+
*/
|
|
12718
|
+
export interface VistasDeleteRequest {
|
|
12719
|
+
/**
|
|
12720
|
+
* The ID of the vista to delete.
|
|
12721
|
+
* @format id
|
|
12722
|
+
* @example "VISTA-12345"
|
|
12723
|
+
*/
|
|
12724
|
+
id: string;
|
|
12725
|
+
}
|
|
12726
|
+
/**
|
|
12727
|
+
* vistas-delete-response
|
|
12728
|
+
* The response when deleting a vista.
|
|
12729
|
+
*/
|
|
12730
|
+
export type VistasDeleteResponse = object;
|
|
12731
|
+
/**
|
|
12732
|
+
* vistas-get-request
|
|
12733
|
+
* The request to get a vista's information.
|
|
12734
|
+
*/
|
|
12735
|
+
export interface VistasGetRequest {
|
|
12736
|
+
/**
|
|
12737
|
+
* The vista's ID.
|
|
12738
|
+
* @format id
|
|
12739
|
+
* @example "VISTA-12345"
|
|
12740
|
+
*/
|
|
12741
|
+
id: string;
|
|
12742
|
+
}
|
|
12743
|
+
/**
|
|
12744
|
+
* vistas-get-response
|
|
12745
|
+
* The response to getting a vista's information.
|
|
12746
|
+
*/
|
|
12747
|
+
export interface VistasGetResponse {
|
|
12748
|
+
/** Represents a collection of DevRev objects. */
|
|
12749
|
+
vista: Vista;
|
|
12750
|
+
}
|
|
12751
|
+
/** vistas-groups-delete-request */
|
|
12752
|
+
export interface VistasGroupsDeleteRequest {
|
|
12753
|
+
/**
|
|
12754
|
+
* ID of the vista group item to be deleted.
|
|
12755
|
+
* @format id
|
|
12756
|
+
*/
|
|
12757
|
+
id: string;
|
|
12758
|
+
}
|
|
12759
|
+
/** vistas-groups-delete-response */
|
|
12760
|
+
export type VistasGroupsDeleteResponse = object;
|
|
12761
|
+
/**
|
|
12762
|
+
* vistas-groups-get-request
|
|
12763
|
+
* The request to get a vista group item's information.
|
|
12764
|
+
*/
|
|
12765
|
+
export interface VistasGroupsGetRequest {
|
|
12766
|
+
/**
|
|
12767
|
+
* The vista group item's ID.
|
|
12768
|
+
* @format id
|
|
12769
|
+
*/
|
|
12770
|
+
id: string;
|
|
12771
|
+
}
|
|
12772
|
+
/**
|
|
12773
|
+
* vistas-groups-get-response
|
|
12774
|
+
* The response to getting a vista group item's information.
|
|
12775
|
+
*/
|
|
12776
|
+
export interface VistasGroupsGetResponse {
|
|
12777
|
+
/** Represents a vista group item. */
|
|
12778
|
+
vista_group: VistaGroup;
|
|
12779
|
+
}
|
|
12780
|
+
/** vistas-groups-list-request */
|
|
12781
|
+
export interface VistasGroupsListRequest {
|
|
12782
|
+
/** Filters for vista group items of the specific type. */
|
|
12783
|
+
type?: GroupItemType[];
|
|
12784
|
+
/**
|
|
12785
|
+
* Filters for vista group items which have one of the parts linked as
|
|
12786
|
+
* its ancestor part or primary part.
|
|
12787
|
+
* @example ["PROD-12345"]
|
|
12788
|
+
*/
|
|
12789
|
+
ancestor_part?: string[];
|
|
12790
|
+
/** The filter for applies to part. */
|
|
12791
|
+
applies_to_part?: AppliesToPartFilter;
|
|
12792
|
+
/**
|
|
12793
|
+
* Filter for vistas group item created by any of these users.
|
|
12794
|
+
* @example ["DEVU-12345"]
|
|
12795
|
+
*/
|
|
12796
|
+
created_by?: string[];
|
|
12797
|
+
/** Provides ways to specify date ranges on objects. */
|
|
12798
|
+
created_date?: DateFilter;
|
|
12799
|
+
/**
|
|
12800
|
+
* The cursor to resume iteration from. If not provided, then
|
|
12801
|
+
* iteration starts from the beginning.
|
|
12802
|
+
* @format text
|
|
12803
|
+
*/
|
|
12804
|
+
cursor?: string;
|
|
12805
|
+
/** Provides ways to specify date ranges on objects. */
|
|
12806
|
+
end_date?: DateFilter;
|
|
12807
|
+
/** Filters for vista group items of the specific group object type. */
|
|
12808
|
+
group_object_type?: VistaGroupItemGroupObjectType[];
|
|
12809
|
+
/**
|
|
12810
|
+
* The request to get information about a list of vista groups.
|
|
12811
|
+
* @format int32
|
|
12812
|
+
*/
|
|
12813
|
+
limit?: number;
|
|
12814
|
+
/**
|
|
12815
|
+
* The iteration mode to use. If "after", then entries after the provided
|
|
12816
|
+
* cursor will be returned, or if no cursor is provided, then from the
|
|
12817
|
+
* beginning. If "before", then entries before the provided cursor will be
|
|
12818
|
+
* returned, or if no cursor is provided, then from the end. Entries will
|
|
12819
|
+
* always be returned in the specified sort-by order.
|
|
12820
|
+
*/
|
|
12821
|
+
mode?: ListMode;
|
|
12822
|
+
/** Provides ways to specify date ranges on objects. */
|
|
12823
|
+
modified_date?: DateFilter;
|
|
12824
|
+
/**
|
|
12825
|
+
* Parent ID of the vista group item.
|
|
12826
|
+
* @example ["VISTA-12345"]
|
|
12827
|
+
*/
|
|
12828
|
+
parent_id?: string[];
|
|
12829
|
+
/** Comma-separated fields to sort the objects by. */
|
|
12830
|
+
sort_by?: string[];
|
|
12831
|
+
/** Provides ways to specify date ranges on objects. */
|
|
12832
|
+
start_date?: DateFilter;
|
|
12833
|
+
/** Denotes the state of the vista group item. */
|
|
12834
|
+
state?: VistaGroupItemState[];
|
|
12835
|
+
}
|
|
12836
|
+
/**
|
|
12837
|
+
* vistas-groups-list-response
|
|
12838
|
+
* The response to listing the vistas group items.
|
|
12839
|
+
*/
|
|
12840
|
+
export interface VistasGroupsListResponse {
|
|
12841
|
+
/**
|
|
12842
|
+
* The cursor used to iterate subsequent results in accordance to the
|
|
12843
|
+
* sort order. If not set, then no later elements exist.
|
|
12844
|
+
* @format text
|
|
12845
|
+
*/
|
|
12846
|
+
next_cursor?: string;
|
|
12847
|
+
/**
|
|
12848
|
+
* The cursor used to iterate preceding results in accordance to the
|
|
12849
|
+
* sort order. If not set, then no prior elements exist.
|
|
12850
|
+
* @format text
|
|
12851
|
+
*/
|
|
12852
|
+
prev_cursor?: string;
|
|
12853
|
+
/** List of vista group items. */
|
|
12854
|
+
vista_group?: VistaGroup[];
|
|
12855
|
+
}
|
|
12856
|
+
/**
|
|
12857
|
+
* vistas-list-request
|
|
12858
|
+
* The request to get information about a list of vistas.
|
|
12859
|
+
*/
|
|
12860
|
+
export interface VistasListRequest {
|
|
12861
|
+
/** Filters for vistas of the specific type. */
|
|
12862
|
+
type?: VistaType[];
|
|
12863
|
+
/**
|
|
12864
|
+
* Filters for vistas created by any of these users.
|
|
12865
|
+
* @example ["DEVU-12345"]
|
|
12866
|
+
*/
|
|
12867
|
+
created_by?: string[];
|
|
12868
|
+
/**
|
|
12869
|
+
* The cursor to resume iteration from. If not provided, then
|
|
12870
|
+
* iteration starts from the beginning.
|
|
12871
|
+
* @format text
|
|
12872
|
+
*/
|
|
12873
|
+
cursor?: string;
|
|
12874
|
+
/** Filters for vistas of specific flavor. */
|
|
12875
|
+
flavor?: GroupedVistaFlavor[];
|
|
12876
|
+
/** Whether the default vistas should be fetched or not. */
|
|
12877
|
+
is_default?: boolean;
|
|
12878
|
+
/**
|
|
12879
|
+
* The maximum number of vistas to return. The default is '50', the
|
|
12880
|
+
* maximum is '100'.
|
|
12881
|
+
* @format int32
|
|
12882
|
+
*/
|
|
12883
|
+
limit?: number;
|
|
12884
|
+
/**
|
|
12885
|
+
* Filters for vistas accessible to the input members.
|
|
12886
|
+
* @example ["DEVU-12345"]
|
|
12887
|
+
*/
|
|
12888
|
+
members?: string[];
|
|
12889
|
+
/**
|
|
12890
|
+
* The iteration mode to use. If "after", then entries after the provided
|
|
12891
|
+
* cursor will be returned, or if no cursor is provided, then from the
|
|
12892
|
+
* beginning. If "before", then entries before the provided cursor will be
|
|
12893
|
+
* returned, or if no cursor is provided, then from the end. Entries will
|
|
12894
|
+
* always be returned in the specified sort-by order.
|
|
12895
|
+
*/
|
|
12896
|
+
mode?: ListMode;
|
|
12897
|
+
/** Filters for vistas of specific object types like works, parts etc. */
|
|
12898
|
+
object_type?: DynamicVistaFilterType[];
|
|
12899
|
+
/** Filter for vistas accessible to the input members. */
|
|
12900
|
+
shared_with?: SharedWithMembershipFilter[];
|
|
12901
|
+
/** Denotes whether to skip items of vista_group_item in response. */
|
|
12902
|
+
skip_items?: boolean;
|
|
12903
|
+
/** Fields to sort the vistas by and the direction to sort them. */
|
|
12904
|
+
sort_by?: string[];
|
|
12905
|
+
/** Denotes the state of the vista group item. */
|
|
12906
|
+
state?: VistaGroupItemState[];
|
|
12907
|
+
}
|
|
12908
|
+
/**
|
|
12909
|
+
* vistas-list-response
|
|
12910
|
+
* The response to listing the vistas.
|
|
12911
|
+
*/
|
|
12912
|
+
export interface VistasListResponse {
|
|
12913
|
+
/**
|
|
12914
|
+
* The cursor used to iterate subsequent results in accordance to the
|
|
12915
|
+
* sort order. If not set, then no later elements exist.
|
|
12916
|
+
* @format text
|
|
12917
|
+
*/
|
|
12918
|
+
next_cursor?: string;
|
|
12919
|
+
/**
|
|
12920
|
+
* The cursor used to iterate preceding results in accordance to the
|
|
12921
|
+
* sort order. If not set, then no prior elements exist.
|
|
12922
|
+
* @format text
|
|
12923
|
+
*/
|
|
12924
|
+
prev_cursor?: string;
|
|
12925
|
+
/** The list of vistas. */
|
|
12926
|
+
vistas: Vista[];
|
|
12927
|
+
}
|
|
10962
12928
|
/** web-crawler-job */
|
|
10963
12929
|
export type WebCrawlerJob = AtomBase & {
|
|
10964
12930
|
/**
|
|
@@ -11079,7 +13045,10 @@ export interface WebCrawlerJobsCreateRequest {
|
|
|
11079
13045
|
* @format text
|
|
11080
13046
|
*/
|
|
11081
13047
|
accept_regex?: string;
|
|
11082
|
-
/**
|
|
13048
|
+
/**
|
|
13049
|
+
* The list of regexes a URL must satisfy to be crawled.
|
|
13050
|
+
* @maxItems 100
|
|
13051
|
+
*/
|
|
11083
13052
|
accept_regexes?: string[];
|
|
11084
13053
|
/**
|
|
11085
13054
|
* The parts to which created webpage/articles during this crawler job
|
|
@@ -11124,13 +13093,23 @@ export interface WebCrawlerJobsCreateRequest {
|
|
|
11124
13093
|
* The list of regexes which if satisfied by a URL results in
|
|
11125
13094
|
* rejection of the URL. If a URL matches both accept and reject
|
|
11126
13095
|
* regexes, it is rejected.
|
|
13096
|
+
* @maxItems 100
|
|
11127
13097
|
*/
|
|
11128
13098
|
reject_regexes?: string[];
|
|
11129
|
-
/**
|
|
13099
|
+
/**
|
|
13100
|
+
* The list of sitemap index URLs to crawl.
|
|
13101
|
+
* @maxItems 2
|
|
13102
|
+
*/
|
|
11130
13103
|
sitemap_index_urls?: string[];
|
|
11131
|
-
/**
|
|
13104
|
+
/**
|
|
13105
|
+
* The list of sitemap URLs to crawl.
|
|
13106
|
+
* @maxItems 2
|
|
13107
|
+
*/
|
|
11132
13108
|
sitemap_urls?: string[];
|
|
11133
|
-
/**
|
|
13109
|
+
/**
|
|
13110
|
+
* The list of URLs to crawl.
|
|
13111
|
+
* @maxItems 50
|
|
13112
|
+
*/
|
|
11134
13113
|
urls?: string[];
|
|
11135
13114
|
/**
|
|
11136
13115
|
* User agent to use for crawling websites in this job.
|
|
@@ -11244,6 +13223,9 @@ export interface WebhookEventRequest {
|
|
|
11244
13223
|
account_deleted?: EventAccountDeleted;
|
|
11245
13224
|
account_updated?: EventAccountUpdated;
|
|
11246
13225
|
ai_agent_response?: EventAiAgentResponse;
|
|
13226
|
+
article_created?: EventArticleCreated;
|
|
13227
|
+
article_deleted?: EventArticleDeleted;
|
|
13228
|
+
article_updated?: EventArticleUpdated;
|
|
11247
13229
|
conversation_created?: EventConversationCreated;
|
|
11248
13230
|
conversation_deleted?: EventConversationDeleted;
|
|
11249
13231
|
conversation_updated?: EventConversationUpdated;
|
|
@@ -11342,6 +13324,9 @@ export declare enum WebhookEventType {
|
|
|
11342
13324
|
AccountDeleted = "account_deleted",
|
|
11343
13325
|
AccountUpdated = "account_updated",
|
|
11344
13326
|
AiAgentResponse = "ai_agent_response",
|
|
13327
|
+
ArticleCreated = "article_created",
|
|
13328
|
+
ArticleDeleted = "article_deleted",
|
|
13329
|
+
ArticleUpdated = "article_updated",
|
|
11345
13330
|
ConversationCreated = "conversation_created",
|
|
11346
13331
|
ConversationDeleted = "conversation_deleted",
|
|
11347
13332
|
ConversationUpdated = "conversation_updated",
|
|
@@ -11767,6 +13752,11 @@ export interface WorksCreateRequestTicket {
|
|
|
11767
13752
|
* @format text
|
|
11768
13753
|
*/
|
|
11769
13754
|
source_channel?: string;
|
|
13755
|
+
/**
|
|
13756
|
+
* Source channel ID of the ticket.
|
|
13757
|
+
* @format id
|
|
13758
|
+
*/
|
|
13759
|
+
source_channel_v2?: string;
|
|
11770
13760
|
}
|
|
11771
13761
|
/** works-create-response */
|
|
11772
13762
|
export interface WorksCreateResponse {
|
|
@@ -11898,6 +13888,11 @@ export interface WorksFilterTicket {
|
|
|
11898
13888
|
sla_summary?: SlaSummaryFilter;
|
|
11899
13889
|
/** Filters for tickets with any of the provided source channels. */
|
|
11900
13890
|
source_channel?: string[];
|
|
13891
|
+
/**
|
|
13892
|
+
* Filters for tickets that are associated with any of the source
|
|
13893
|
+
* channels.
|
|
13894
|
+
*/
|
|
13895
|
+
source_channel_v2?: string[];
|
|
11901
13896
|
/** The filter for survey aggregation. */
|
|
11902
13897
|
surveys?: SurveyAggregationFilter;
|
|
11903
13898
|
}
|
|
@@ -12259,6 +14254,11 @@ export interface WorksUpdateRequestTicket {
|
|
|
12259
14254
|
sentiment_summary?: string;
|
|
12260
14255
|
/** Severity of the ticket. */
|
|
12261
14256
|
severity?: TicketSeverity;
|
|
14257
|
+
/**
|
|
14258
|
+
* Updates the source channel of the ticket.
|
|
14259
|
+
* @format id
|
|
14260
|
+
*/
|
|
14261
|
+
source_channel_v2?: string | null;
|
|
12262
14262
|
}
|
|
12263
14263
|
/** works-update-request-ticket-channels */
|
|
12264
14264
|
export interface WorksUpdateRequestTicketChannels {
|
|
@@ -12269,6 +14269,19 @@ export interface WorksUpdateRequestTicketChannels {
|
|
|
12269
14269
|
export interface WorksUpdateResponse {
|
|
12270
14270
|
work: Work;
|
|
12271
14271
|
}
|
|
14272
|
+
/**
|
|
14273
|
+
* works-vista-group-item
|
|
14274
|
+
* Represents a nested works vista group object.
|
|
14275
|
+
*/
|
|
14276
|
+
export type WorksVistaGroupItem = VistaGroupBase & {
|
|
14277
|
+
/** Type of works vista group item. */
|
|
14278
|
+
type: WorksVistaGroupItemType;
|
|
14279
|
+
};
|
|
14280
|
+
/** Type of works vista group item. */
|
|
14281
|
+
export declare enum WorksVistaGroupItemType {
|
|
14282
|
+
Curated = "curated",
|
|
14283
|
+
Dynamic = "dynamic"
|
|
14284
|
+
}
|
|
12272
14285
|
import { AxiosInstance, AxiosRequestConfig, AxiosResponse, ResponseType } from 'axios';
|
|
12273
14286
|
export type QueryParamsType = Record<string | number, any>;
|
|
12274
14287
|
export interface FullRequestParams extends Omit<AxiosRequestConfig, 'data' | 'params' | 'url' | 'responseType'> {
|
|
@@ -12567,12 +14580,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
12567
14580
|
* @example "ARTICLE-12345"
|
|
12568
14581
|
*/
|
|
12569
14582
|
id: string;
|
|
12570
|
-
/**
|
|
12571
|
-
* Optional Dev Org ID for the unauthenticated user.
|
|
12572
|
-
* @format id
|
|
12573
|
-
* @example "DEV-AbCdEfGh"
|
|
12574
|
-
*/
|
|
12575
|
-
dev_org?: string;
|
|
12576
14583
|
}, params?: RequestParams) => Promise<AxiosResponse<ArticlesGetResponse, any>>;
|
|
12577
14584
|
/**
|
|
12578
14585
|
* @description Gets an article.
|
|
@@ -12622,12 +14629,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
12622
14629
|
* @format text
|
|
12623
14630
|
*/
|
|
12624
14631
|
cursor?: string;
|
|
12625
|
-
/**
|
|
12626
|
-
* Optional Dev Org ID for the unauthenticated user.
|
|
12627
|
-
* @format id
|
|
12628
|
-
* @example "DEV-AbCdEfGh"
|
|
12629
|
-
*/
|
|
12630
|
-
dev_org?: string;
|
|
12631
14632
|
/**
|
|
12632
14633
|
* The maximum number of articles to return. The default is '50'.
|
|
12633
14634
|
* @format int32
|
|
@@ -12648,6 +14649,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
12648
14649
|
* @example ["DEVU-12345"]
|
|
12649
14650
|
*/
|
|
12650
14651
|
owned_by?: string[];
|
|
14652
|
+
/** Filters for articles with the provided parent directories. */
|
|
14653
|
+
parent?: string[];
|
|
12651
14654
|
/** Filter for the scope of the articles. */
|
|
12652
14655
|
scope?: number[];
|
|
12653
14656
|
/**
|
|
@@ -13327,6 +15330,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
13327
15330
|
'sla_summary.stage'?: SlaSummaryStage[];
|
|
13328
15331
|
/** Filters for conversations with any of the provided source channels. */
|
|
13329
15332
|
source_channel?: string[];
|
|
15333
|
+
/**
|
|
15334
|
+
* Filters for conversations that are associated with the source
|
|
15335
|
+
* channel.
|
|
15336
|
+
*/
|
|
15337
|
+
source_channel_v2?: string[];
|
|
13330
15338
|
/**
|
|
13331
15339
|
* Filters for conversations with any of the provided source channels.
|
|
13332
15340
|
* @deprecated
|
|
@@ -13375,6 +15383,138 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
13375
15383
|
* @secure
|
|
13376
15384
|
*/
|
|
13377
15385
|
conversationsUpdate: (data: ConversationsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<ConversationsUpdateResponse, any>>;
|
|
15386
|
+
/**
|
|
15387
|
+
* @description Counts custom objects.
|
|
15388
|
+
*
|
|
15389
|
+
* @tags customization
|
|
15390
|
+
* @name CustomObjectsCount
|
|
15391
|
+
* @summary Count Custom Objects
|
|
15392
|
+
* @request GET:/custom-objects.count
|
|
15393
|
+
* @secure
|
|
15394
|
+
*/
|
|
15395
|
+
customObjectsCount: (query: {
|
|
15396
|
+
/**
|
|
15397
|
+
* Leaf type to filter.
|
|
15398
|
+
* @format text
|
|
15399
|
+
*/
|
|
15400
|
+
leaf_type: string;
|
|
15401
|
+
/** List of filters to apply. */
|
|
15402
|
+
filters?: any[];
|
|
15403
|
+
}, params?: RequestParams) => Promise<AxiosResponse<CustomObjectsCountResponse, any>>;
|
|
15404
|
+
/**
|
|
15405
|
+
* @description Counts custom objects.
|
|
15406
|
+
*
|
|
15407
|
+
* @tags customization
|
|
15408
|
+
* @name CustomObjectsCountPost
|
|
15409
|
+
* @summary Count Custom Objects (POST)
|
|
15410
|
+
* @request POST:/custom-objects.count
|
|
15411
|
+
* @secure
|
|
15412
|
+
*/
|
|
15413
|
+
customObjectsCountPost: (data: CustomObjectsCountRequest, params?: RequestParams) => Promise<AxiosResponse<CustomObjectsCountResponse, any>>;
|
|
15414
|
+
/**
|
|
15415
|
+
* @description Creates a custom object.
|
|
15416
|
+
*
|
|
15417
|
+
* @tags customization
|
|
15418
|
+
* @name CustomObjectsCreate
|
|
15419
|
+
* @summary Create Custom Object
|
|
15420
|
+
* @request POST:/custom-objects.create
|
|
15421
|
+
* @secure
|
|
15422
|
+
*/
|
|
15423
|
+
customObjectsCreate: (data: CustomObjectsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<CustomObjectsCreateResponse, any>>;
|
|
15424
|
+
/**
|
|
15425
|
+
* @description Deletes a custom object.
|
|
15426
|
+
*
|
|
15427
|
+
* @tags customization
|
|
15428
|
+
* @name CustomObjectsDelete
|
|
15429
|
+
* @summary Delete Custom Object
|
|
15430
|
+
* @request POST:/custom-objects.delete
|
|
15431
|
+
* @secure
|
|
15432
|
+
*/
|
|
15433
|
+
customObjectsDelete: (data: CustomObjectsDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
|
|
15434
|
+
/**
|
|
15435
|
+
* @description Gets a custom object.
|
|
15436
|
+
*
|
|
15437
|
+
* @tags customization
|
|
15438
|
+
* @name CustomObjectsGet
|
|
15439
|
+
* @summary Get Custom Object
|
|
15440
|
+
* @request GET:/custom-objects.get
|
|
15441
|
+
* @secure
|
|
15442
|
+
*/
|
|
15443
|
+
customObjectsGet: (query?: {
|
|
15444
|
+
/**
|
|
15445
|
+
* The ID of the custom object to get.
|
|
15446
|
+
* @format id
|
|
15447
|
+
*/
|
|
15448
|
+
id?: string;
|
|
15449
|
+
}, params?: RequestParams) => Promise<AxiosResponse<CustomObjectsGetResponse, any>>;
|
|
15450
|
+
/**
|
|
15451
|
+
* @description Gets a custom object.
|
|
15452
|
+
*
|
|
15453
|
+
* @tags customization
|
|
15454
|
+
* @name CustomObjectsGetPost
|
|
15455
|
+
* @summary Get Custom Object (POST)
|
|
15456
|
+
* @request POST:/custom-objects.get
|
|
15457
|
+
* @secure
|
|
15458
|
+
*/
|
|
15459
|
+
customObjectsGetPost: (data: CustomObjectsGetRequest, params?: RequestParams) => Promise<AxiosResponse<CustomObjectsGetResponse, any>>;
|
|
15460
|
+
/**
|
|
15461
|
+
* @description Lists custom objects.
|
|
15462
|
+
*
|
|
15463
|
+
* @tags customization
|
|
15464
|
+
* @name CustomObjectsList
|
|
15465
|
+
* @summary List Custom Objects
|
|
15466
|
+
* @request GET:/custom-objects.list
|
|
15467
|
+
* @secure
|
|
15468
|
+
*/
|
|
15469
|
+
customObjectsList: (query: {
|
|
15470
|
+
/**
|
|
15471
|
+
* Leaf type to filter.
|
|
15472
|
+
* @format text
|
|
15473
|
+
*/
|
|
15474
|
+
leaf_type: string;
|
|
15475
|
+
/**
|
|
15476
|
+
* The cursor to resume iteration from. If not provided, then iteration
|
|
15477
|
+
* starts from the beginning.
|
|
15478
|
+
* @format text
|
|
15479
|
+
*/
|
|
15480
|
+
cursor?: string;
|
|
15481
|
+
/** List of filters to apply. */
|
|
15482
|
+
filter?: any[];
|
|
15483
|
+
/** List of filters to apply. */
|
|
15484
|
+
filters?: any[];
|
|
15485
|
+
/**
|
|
15486
|
+
* The maximum number of items.
|
|
15487
|
+
* @format int32
|
|
15488
|
+
*/
|
|
15489
|
+
limit?: number;
|
|
15490
|
+
/**
|
|
15491
|
+
* The iteration mode to use, otherwise if not set, then "after" is
|
|
15492
|
+
* used.
|
|
15493
|
+
*/
|
|
15494
|
+
mode?: ListMode;
|
|
15495
|
+
/** The list of fields to sort the items by and how to sort them. */
|
|
15496
|
+
sort_by?: string[];
|
|
15497
|
+
}, params?: RequestParams) => Promise<AxiosResponse<CustomObjectsListResponse, any>>;
|
|
15498
|
+
/**
|
|
15499
|
+
* @description Lists custom objects.
|
|
15500
|
+
*
|
|
15501
|
+
* @tags customization
|
|
15502
|
+
* @name CustomObjectsListPost
|
|
15503
|
+
* @summary List Custom Objects (POST)
|
|
15504
|
+
* @request POST:/custom-objects.list
|
|
15505
|
+
* @secure
|
|
15506
|
+
*/
|
|
15507
|
+
customObjectsListPost: (data: CustomObjectsListRequest, params?: RequestParams) => Promise<AxiosResponse<CustomObjectsListResponse, any>>;
|
|
15508
|
+
/**
|
|
15509
|
+
* @description Updates a custom object.
|
|
15510
|
+
*
|
|
15511
|
+
* @tags customization
|
|
15512
|
+
* @name CustomObjectsUpdate
|
|
15513
|
+
* @summary Update Custom Object
|
|
15514
|
+
* @request POST:/custom-objects.update
|
|
15515
|
+
* @secure
|
|
15516
|
+
*/
|
|
15517
|
+
customObjectsUpdate: (data: CustomObjectsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<CustomObjectsUpdateResponse, any>>;
|
|
13378
15518
|
/**
|
|
13379
15519
|
* @description Creates a new enterprise authentication connection for a Dev organization. This authentication connection will not be enabled by default for the organization and the user will need to explicitly enable this. Only 5 authentication connections can be created by an organization.
|
|
13380
15520
|
*
|
|
@@ -13726,12 +15866,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
13726
15866
|
* @format id
|
|
13727
15867
|
*/
|
|
13728
15868
|
id: string;
|
|
13729
|
-
/**
|
|
13730
|
-
* Optional Dev Org ID for the unauthenticated user.
|
|
13731
|
-
* @format id
|
|
13732
|
-
* @example "DEV-AbCdEfGh"
|
|
13733
|
-
*/
|
|
13734
|
-
dev_org?: string;
|
|
13735
15869
|
}, params?: RequestParams) => Promise<AxiosResponse<DirectoriesGetResponse, any>>;
|
|
13736
15870
|
/**
|
|
13737
15871
|
* @description Gets the specified directory.
|
|
@@ -13764,12 +15898,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
13764
15898
|
* @format text
|
|
13765
15899
|
*/
|
|
13766
15900
|
cursor?: string;
|
|
13767
|
-
/**
|
|
13768
|
-
* Optional Dev Org ID for the unauthenticated user.
|
|
13769
|
-
* @format id
|
|
13770
|
-
* @example "DEV-AbCdEfGh"
|
|
13771
|
-
*/
|
|
13772
|
-
dev_org?: string;
|
|
13773
15901
|
/**
|
|
13774
15902
|
* The maximum number of directories to return. The default is '50'.
|
|
13775
15903
|
* @format int32
|
|
@@ -14175,6 +16303,22 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
14175
16303
|
parent?: string[];
|
|
14176
16304
|
/** Filters for meeting on specified state or outcomes. */
|
|
14177
16305
|
state?: MeetingState[];
|
|
16306
|
+
/** Filters for issues with this specific external reference. */
|
|
16307
|
+
'sync_metadata.external_reference'?: string[];
|
|
16308
|
+
/** Filters for works with selected sync statuses. */
|
|
16309
|
+
'sync_metadata.last_sync_in.status'?: SyncMetadataFilterSyncInFilterStatus[];
|
|
16310
|
+
/** Filters for works modified with selected sync history. */
|
|
16311
|
+
'sync_metadata.last_sync_in.sync_history'?: string[];
|
|
16312
|
+
/** Filters for works modified with selected sync units. */
|
|
16313
|
+
'sync_metadata.last_sync_in.sync_unit'?: string[];
|
|
16314
|
+
/** Filters for works with selected sync statuses. */
|
|
16315
|
+
'sync_metadata.last_sync_out.status'?: SyncMetadataFilterSyncOutFilterStatus[];
|
|
16316
|
+
/** Filters for works modified with selected sync history. */
|
|
16317
|
+
'sync_metadata.last_sync_out.sync_history'?: string[];
|
|
16318
|
+
/** Filters for works modified with selected sync units. */
|
|
16319
|
+
'sync_metadata.last_sync_out.sync_unit'?: string[];
|
|
16320
|
+
/** Filters for issues synced from this specific origin system. */
|
|
16321
|
+
'sync_metadata.origin_system'?: string[];
|
|
14178
16322
|
}, params?: RequestParams) => Promise<AxiosResponse<MeetingsCountResponse, any>>;
|
|
14179
16323
|
/**
|
|
14180
16324
|
* @description Counts the meeting records.
|
|
@@ -14293,6 +16437,22 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
14293
16437
|
sort_by?: string[];
|
|
14294
16438
|
/** Filters for meeting on specified state or outcomes. */
|
|
14295
16439
|
state?: MeetingState[];
|
|
16440
|
+
/** Filters for issues with this specific external reference. */
|
|
16441
|
+
'sync_metadata.external_reference'?: string[];
|
|
16442
|
+
/** Filters for works with selected sync statuses. */
|
|
16443
|
+
'sync_metadata.last_sync_in.status'?: SyncMetadataFilterSyncInFilterStatus[];
|
|
16444
|
+
/** Filters for works modified with selected sync history. */
|
|
16445
|
+
'sync_metadata.last_sync_in.sync_history'?: string[];
|
|
16446
|
+
/** Filters for works modified with selected sync units. */
|
|
16447
|
+
'sync_metadata.last_sync_in.sync_unit'?: string[];
|
|
16448
|
+
/** Filters for works with selected sync statuses. */
|
|
16449
|
+
'sync_metadata.last_sync_out.status'?: SyncMetadataFilterSyncOutFilterStatus[];
|
|
16450
|
+
/** Filters for works modified with selected sync history. */
|
|
16451
|
+
'sync_metadata.last_sync_out.sync_history'?: string[];
|
|
16452
|
+
/** Filters for works modified with selected sync units. */
|
|
16453
|
+
'sync_metadata.last_sync_out.sync_unit'?: string[];
|
|
16454
|
+
/** Filters for issues synced from this specific origin system. */
|
|
16455
|
+
'sync_metadata.origin_system'?: string[];
|
|
14296
16456
|
}, params?: RequestParams) => Promise<AxiosResponse<MeetingsListResponse, any>>;
|
|
14297
16457
|
/**
|
|
14298
16458
|
* @description Lists the meeting records.
|
|
@@ -14757,6 +16917,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
14757
16917
|
* @example ["PROD-12345"]
|
|
14758
16918
|
*/
|
|
14759
16919
|
'parent_part.parts'?: string[];
|
|
16920
|
+
/** Fields to sort the parts by and the direction to sort them. */
|
|
16921
|
+
sort_by?: string[];
|
|
14760
16922
|
/**
|
|
14761
16923
|
* Filters for part with any of the provided tags.
|
|
14762
16924
|
* @example ["TAG-12345"]
|
|
@@ -15184,23 +17346,255 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
15184
17346
|
/**
|
|
15185
17347
|
* @description Scans through all Rev users.
|
|
15186
17348
|
*
|
|
15187
|
-
* @tags rev-users
|
|
15188
|
-
* @name RevUsersScanPost
|
|
15189
|
-
* @summary Scan Rev Users (POST)
|
|
15190
|
-
* @request POST:/rev-users.scan
|
|
17349
|
+
* @tags rev-users
|
|
17350
|
+
* @name RevUsersScanPost
|
|
17351
|
+
* @summary Scan Rev Users (POST)
|
|
17352
|
+
* @request POST:/rev-users.scan
|
|
17353
|
+
* @secure
|
|
17354
|
+
*/
|
|
17355
|
+
revUsersScanPost: (data: RevUsersScanRequest, params?: RequestParams) => Promise<AxiosResponse<RevUsersScanResponse, any>>;
|
|
17356
|
+
/**
|
|
17357
|
+
* @description Updates a Rev user.
|
|
17358
|
+
*
|
|
17359
|
+
* @tags rev-users
|
|
17360
|
+
* @name RevUsersUpdate
|
|
17361
|
+
* @summary Update Rev User
|
|
17362
|
+
* @request POST:/rev-users.update
|
|
17363
|
+
* @secure
|
|
17364
|
+
*/
|
|
17365
|
+
revUsersUpdate: (data: RevUsersUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<RevUsersUpdateResponse, any>>;
|
|
17366
|
+
/**
|
|
17367
|
+
* @description Gets the aggregated schema.
|
|
17368
|
+
*
|
|
17369
|
+
* @tags customization
|
|
17370
|
+
* @name AggregatedSchemaGet
|
|
17371
|
+
* @summary Get Schemas Aggregated
|
|
17372
|
+
* @request GET:/schemas.aggregated.get
|
|
17373
|
+
* @secure
|
|
17374
|
+
*/
|
|
17375
|
+
aggregatedSchemaGet: (query?: {
|
|
17376
|
+
/** The custom schema fragment IDs which are to be aggregated. */
|
|
17377
|
+
custom_schema_fragments?: string[];
|
|
17378
|
+
/** List of apps. */
|
|
17379
|
+
'custom_schema_spec.apps'?: string[];
|
|
17380
|
+
/**
|
|
17381
|
+
* Name of the subtype.
|
|
17382
|
+
* @format text
|
|
17383
|
+
*/
|
|
17384
|
+
'custom_schema_spec.subtype'?: string;
|
|
17385
|
+
/** Whether the leaf type corresponds to a custom object. */
|
|
17386
|
+
is_custom_leaf_type?: boolean;
|
|
17387
|
+
/**
|
|
17388
|
+
* The leaf type. Used for inferring the default stage diagram and
|
|
17389
|
+
* tenant fragment ID.
|
|
17390
|
+
* @format text
|
|
17391
|
+
*/
|
|
17392
|
+
leaf_type?: string;
|
|
17393
|
+
/**
|
|
17394
|
+
* The stock schema fragment which is to be aggregated.
|
|
17395
|
+
* @format id
|
|
17396
|
+
*/
|
|
17397
|
+
stock_schema_fragment?: string;
|
|
17398
|
+
}, params?: RequestParams) => Promise<AxiosResponse<AggregatedSchemaGetResponse, any>>;
|
|
17399
|
+
/**
|
|
17400
|
+
* @description Gets the aggregated schema.
|
|
17401
|
+
*
|
|
17402
|
+
* @tags customization
|
|
17403
|
+
* @name AggregatedSchemaGetPost
|
|
17404
|
+
* @summary Get Schemas Aggregated (POST)
|
|
17405
|
+
* @request POST:/schemas.aggregated.get
|
|
17406
|
+
* @secure
|
|
17407
|
+
*/
|
|
17408
|
+
aggregatedSchemaGetPost: (data: AggregatedSchemaGetRequest, params?: RequestParams) => Promise<AxiosResponse<AggregatedSchemaGetResponse, any>>;
|
|
17409
|
+
/**
|
|
17410
|
+
* @description Gets a custom schema fragment.
|
|
17411
|
+
*
|
|
17412
|
+
* @tags customization
|
|
17413
|
+
* @name CustomSchemaFragmentsGet
|
|
17414
|
+
* @summary Get Schemas Custom
|
|
17415
|
+
* @request GET:/schemas.custom.get
|
|
17416
|
+
* @secure
|
|
17417
|
+
*/
|
|
17418
|
+
customSchemaFragmentsGet: (query: {
|
|
17419
|
+
/**
|
|
17420
|
+
* The ID of the custom schema fragment.
|
|
17421
|
+
* @format id
|
|
17422
|
+
*/
|
|
17423
|
+
id: string;
|
|
17424
|
+
}, params?: RequestParams) => Promise<AxiosResponse<CustomSchemaFragmentsGetResponse, any>>;
|
|
17425
|
+
/**
|
|
17426
|
+
* @description Gets a custom schema fragment.
|
|
17427
|
+
*
|
|
17428
|
+
* @tags customization
|
|
17429
|
+
* @name CustomSchemaFragmentsGetPost
|
|
17430
|
+
* @summary Get Schemas Custom (POST)
|
|
17431
|
+
* @request POST:/schemas.custom.get
|
|
17432
|
+
* @secure
|
|
17433
|
+
*/
|
|
17434
|
+
customSchemaFragmentsGetPost: (data: CustomSchemaFragmentsGetRequest, params?: RequestParams) => Promise<AxiosResponse<CustomSchemaFragmentsGetResponse, any>>;
|
|
17435
|
+
/**
|
|
17436
|
+
* @description Lists custom schema fragments.
|
|
17437
|
+
*
|
|
17438
|
+
* @tags customization
|
|
17439
|
+
* @name CustomSchemaFragmentsList
|
|
17440
|
+
* @summary List Schemas Custom
|
|
17441
|
+
* @request GET:/schemas.custom.list
|
|
17442
|
+
* @secure
|
|
17443
|
+
*/
|
|
17444
|
+
customSchemaFragmentsList: (query?: {
|
|
17445
|
+
/** The list of app names. */
|
|
17446
|
+
app?: string[];
|
|
17447
|
+
/**
|
|
17448
|
+
* The cursor to resume iteration from. If not provided, then iteration
|
|
17449
|
+
* starts from the beginning.
|
|
17450
|
+
* @format text
|
|
17451
|
+
*/
|
|
17452
|
+
cursor?: string;
|
|
17453
|
+
/**
|
|
17454
|
+
* Whether only deprecated fragments should be filtered.
|
|
17455
|
+
* @deprecated
|
|
17456
|
+
*/
|
|
17457
|
+
deprecated?: boolean;
|
|
17458
|
+
/** Whether the leaf type corresponds to a custom object */
|
|
17459
|
+
is_custom_leaf_type?: boolean;
|
|
17460
|
+
/** Whether the fragment has been deprecated. */
|
|
17461
|
+
is_deprecated?: boolean;
|
|
17462
|
+
/** The list of leaf types. */
|
|
17463
|
+
leaf_type?: string[];
|
|
17464
|
+
/**
|
|
17465
|
+
* The maximum number of items.
|
|
17466
|
+
* @format int32
|
|
17467
|
+
*/
|
|
17468
|
+
limit?: number;
|
|
17469
|
+
/**
|
|
17470
|
+
* The iteration mode to use, otherwise if not set, then "after" is
|
|
17471
|
+
* used.
|
|
17472
|
+
*/
|
|
17473
|
+
mode?: ListMode;
|
|
17474
|
+
/**
|
|
17475
|
+
* List of fields which are not required in the payload and can be
|
|
17476
|
+
* pruned away.
|
|
17477
|
+
*/
|
|
17478
|
+
prune?: CustomSchemaFragmentsListRequestPrune[];
|
|
17479
|
+
/** The list of fields to sort the items by and how to sort them. */
|
|
17480
|
+
sort_by?: string[];
|
|
17481
|
+
/** The list of subtypes. */
|
|
17482
|
+
subtype?: string[];
|
|
17483
|
+
/** Filters for custom schema fragment of the provided types. */
|
|
17484
|
+
types?: CustomSchemaFragmentType[];
|
|
17485
|
+
}, params?: RequestParams) => Promise<AxiosResponse<CustomSchemaFragmentsListResponse, any>>;
|
|
17486
|
+
/**
|
|
17487
|
+
* @description Lists custom schema fragments.
|
|
17488
|
+
*
|
|
17489
|
+
* @tags customization
|
|
17490
|
+
* @name CustomSchemaFragmentsListPost
|
|
17491
|
+
* @summary List Schemas Custom (POST)
|
|
17492
|
+
* @request POST:/schemas.custom.list
|
|
17493
|
+
* @secure
|
|
17494
|
+
*/
|
|
17495
|
+
customSchemaFragmentsListPost: (data: CustomSchemaFragmentsListRequest, params?: RequestParams) => Promise<AxiosResponse<CustomSchemaFragmentsListResponse, any>>;
|
|
17496
|
+
/**
|
|
17497
|
+
* @description Creates or updates a custom schema fragment.
|
|
17498
|
+
*
|
|
17499
|
+
* @tags customization
|
|
17500
|
+
* @name CustomSchemaFragmentsSet
|
|
17501
|
+
* @summary Set Schemas Custom
|
|
17502
|
+
* @request POST:/schemas.custom.set
|
|
17503
|
+
* @secure
|
|
17504
|
+
*/
|
|
17505
|
+
customSchemaFragmentsSet: (data: CustomSchemaFragmentsSetRequest, params?: RequestParams) => Promise<AxiosResponse<CustomSchemaFragmentsSetResponse, any>>;
|
|
17506
|
+
/**
|
|
17507
|
+
* @description Gets a stock schema fragment.
|
|
17508
|
+
*
|
|
17509
|
+
* @tags customization
|
|
17510
|
+
* @name StockSchemaFragmentsGet
|
|
17511
|
+
* @summary Get Schemas Stock
|
|
17512
|
+
* @request GET:/schemas.stock.get
|
|
17513
|
+
* @secure
|
|
17514
|
+
*/
|
|
17515
|
+
stockSchemaFragmentsGet: (query?: {
|
|
17516
|
+
/**
|
|
17517
|
+
* The ID of the stock schema fragment.
|
|
17518
|
+
* @format id
|
|
17519
|
+
*/
|
|
17520
|
+
id?: string;
|
|
17521
|
+
/**
|
|
17522
|
+
* The leaf type this fragment applies to.
|
|
17523
|
+
* @format text
|
|
17524
|
+
*/
|
|
17525
|
+
leaf_type?: string;
|
|
17526
|
+
}, params?: RequestParams) => Promise<AxiosResponse<StockSchemaFragmentsGetResponse, any>>;
|
|
17527
|
+
/**
|
|
17528
|
+
* @description Gets a stock schema fragment.
|
|
17529
|
+
*
|
|
17530
|
+
* @tags customization
|
|
17531
|
+
* @name StockSchemaFragmentsGetPost
|
|
17532
|
+
* @summary Get Schemas Stock (POST)
|
|
17533
|
+
* @request POST:/schemas.stock.get
|
|
17534
|
+
* @secure
|
|
17535
|
+
*/
|
|
17536
|
+
stockSchemaFragmentsGetPost: (data: StockSchemaFragmentsGetRequest, params?: RequestParams) => Promise<AxiosResponse<StockSchemaFragmentsGetResponse, any>>;
|
|
17537
|
+
/**
|
|
17538
|
+
* @description Lists stock schema fragments.
|
|
17539
|
+
*
|
|
17540
|
+
* @tags customization
|
|
17541
|
+
* @name StockSchemaFragmentsList
|
|
17542
|
+
* @summary List Schemas Stock
|
|
17543
|
+
* @request GET:/schemas.stock.list
|
|
17544
|
+
* @secure
|
|
17545
|
+
*/
|
|
17546
|
+
stockSchemaFragmentsList: (query?: {
|
|
17547
|
+
/**
|
|
17548
|
+
* The cursor to resume iteration from. If not provided, then iteration
|
|
17549
|
+
* starts from the beginning.
|
|
17550
|
+
* @format text
|
|
17551
|
+
*/
|
|
17552
|
+
cursor?: string;
|
|
17553
|
+
/**
|
|
17554
|
+
* Filter preset to specify whether to filter only customization enabled
|
|
17555
|
+
* leaf types.
|
|
17556
|
+
*/
|
|
17557
|
+
filter_preset?: StockSchemaFragmentsListRequestFilterPreset;
|
|
17558
|
+
/** The list of leaf types. */
|
|
17559
|
+
leaf_type?: string[];
|
|
17560
|
+
/**
|
|
17561
|
+
* The maximum number of items.
|
|
17562
|
+
* @format int32
|
|
17563
|
+
*/
|
|
17564
|
+
limit?: number;
|
|
17565
|
+
/**
|
|
17566
|
+
* The iteration mode to use, otherwise if not set, then "after" is
|
|
17567
|
+
* used.
|
|
17568
|
+
*/
|
|
17569
|
+
mode?: ListMode;
|
|
17570
|
+
/**
|
|
17571
|
+
* List of fields which are not required in the payload and can be
|
|
17572
|
+
* pruned away.
|
|
17573
|
+
*/
|
|
17574
|
+
prune?: StockSchemaFragmentsListRequestPrune[];
|
|
17575
|
+
/** The list of fields to sort the items by and how to sort them. */
|
|
17576
|
+
sort_by?: string[];
|
|
17577
|
+
}, params?: RequestParams) => Promise<AxiosResponse<StockSchemaFragmentsListResponse, any>>;
|
|
17578
|
+
/**
|
|
17579
|
+
* @description Lists stock schema fragments.
|
|
17580
|
+
*
|
|
17581
|
+
* @tags customization
|
|
17582
|
+
* @name StockSchemaFragmentsListPost
|
|
17583
|
+
* @summary List Schemas Stock (POST)
|
|
17584
|
+
* @request POST:/schemas.stock.list
|
|
15191
17585
|
* @secure
|
|
15192
17586
|
*/
|
|
15193
|
-
|
|
17587
|
+
stockSchemaFragmentsListPost: (data: StockSchemaFragmentsListRequest, params?: RequestParams) => Promise<AxiosResponse<StockSchemaFragmentsListResponse, any>>;
|
|
15194
17588
|
/**
|
|
15195
|
-
* @description
|
|
17589
|
+
* @description Gets the new fragment IDs and fields resulting from changing a subtype.
|
|
15196
17590
|
*
|
|
15197
|
-
* @tags
|
|
15198
|
-
* @name
|
|
15199
|
-
* @summary Update
|
|
15200
|
-
* @request POST:/
|
|
17591
|
+
* @tags customization
|
|
17592
|
+
* @name SchemasSubtypePrepareUpdateGet
|
|
17593
|
+
* @summary Prepare-Update Schemas Subtypes
|
|
17594
|
+
* @request POST:/schemas.subtypes.prepare-update
|
|
15201
17595
|
* @secure
|
|
15202
17596
|
*/
|
|
15203
|
-
|
|
17597
|
+
schemasSubtypePrepareUpdateGet: (data: SchemasSubtypePrepareUpdateGetRequest, params?: RequestParams) => Promise<AxiosResponse<SchemasSubtypePrepareUpdateGetResponse, any>>;
|
|
15204
17598
|
/**
|
|
15205
17599
|
* @description Creates a service account.
|
|
15206
17600
|
*
|
|
@@ -15468,6 +17862,273 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
15468
17862
|
* @secure
|
|
15469
17863
|
*/
|
|
15470
17864
|
snapWidgetsCreate: (data: SnapWidgetsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<SnapWidgetsCreateResponse, any>>;
|
|
17865
|
+
/**
|
|
17866
|
+
* @description Creates a stage diagram.
|
|
17867
|
+
*
|
|
17868
|
+
* @tags customization
|
|
17869
|
+
* @name StageDiagramsCreate
|
|
17870
|
+
* @summary Create Stage Diagram
|
|
17871
|
+
* @request POST:/stage-diagrams.create
|
|
17872
|
+
* @secure
|
|
17873
|
+
*/
|
|
17874
|
+
stageDiagramsCreate: (data: StageDiagramsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<StageDiagramsCreateResponse, any>>;
|
|
17875
|
+
/**
|
|
17876
|
+
* @description Gets a stage diagram.
|
|
17877
|
+
*
|
|
17878
|
+
* @tags customization
|
|
17879
|
+
* @name StageDiagramsGet
|
|
17880
|
+
* @summary Get Stage Diagram
|
|
17881
|
+
* @request GET:/stage-diagrams.get
|
|
17882
|
+
* @secure
|
|
17883
|
+
*/
|
|
17884
|
+
stageDiagramsGet: (query?: {
|
|
17885
|
+
/**
|
|
17886
|
+
* The ID of the stage diagram to get.
|
|
17887
|
+
* @format id
|
|
17888
|
+
*/
|
|
17889
|
+
id?: string;
|
|
17890
|
+
/**
|
|
17891
|
+
* Whether the leaf type corresponds to a custom object. Specify this
|
|
17892
|
+
* along with leaf_type to get the default custom object stage diagram.
|
|
17893
|
+
*/
|
|
17894
|
+
is_custom_leaf_type?: boolean;
|
|
17895
|
+
/**
|
|
17896
|
+
* The leaf type. Should be specified to retrieve the default stage
|
|
17897
|
+
* diagram for the leaf type. If not provided, then id is used.
|
|
17898
|
+
* @format text
|
|
17899
|
+
*/
|
|
17900
|
+
leaf_type?: string;
|
|
17901
|
+
}, params?: RequestParams) => Promise<AxiosResponse<StageDiagramsGetResponse, any>>;
|
|
17902
|
+
/**
|
|
17903
|
+
* @description Gets a stage diagram.
|
|
17904
|
+
*
|
|
17905
|
+
* @tags customization
|
|
17906
|
+
* @name StageDiagramsGetPost
|
|
17907
|
+
* @summary Get Stage Diagram (POST)
|
|
17908
|
+
* @request POST:/stage-diagrams.get
|
|
17909
|
+
* @secure
|
|
17910
|
+
*/
|
|
17911
|
+
stageDiagramsGetPost: (data: StageDiagramsGetRequest, params?: RequestParams) => Promise<AxiosResponse<StageDiagramsGetResponse, any>>;
|
|
17912
|
+
/**
|
|
17913
|
+
* @description Lists stage diagrams.
|
|
17914
|
+
*
|
|
17915
|
+
* @tags customization
|
|
17916
|
+
* @name StageDiagramsList
|
|
17917
|
+
* @summary List Stage Diagrams
|
|
17918
|
+
* @request GET:/stage-diagrams.list
|
|
17919
|
+
* @secure
|
|
17920
|
+
*/
|
|
17921
|
+
stageDiagramsList: (query?: {
|
|
17922
|
+
/**
|
|
17923
|
+
* The cursor to resume iteration from, otherwise if not provided, then
|
|
17924
|
+
* iteration starts from the beginning.
|
|
17925
|
+
* @format text
|
|
17926
|
+
*/
|
|
17927
|
+
cursor?: string;
|
|
17928
|
+
/** Whether only custom object stage diagrams should be filtered. */
|
|
17929
|
+
is_custom_leaf_type?: boolean;
|
|
17930
|
+
/** The list of leaf types. */
|
|
17931
|
+
leaf_type?: string[];
|
|
17932
|
+
/**
|
|
17933
|
+
* The maximum number of items.
|
|
17934
|
+
* @format int32
|
|
17935
|
+
*/
|
|
17936
|
+
limit?: number;
|
|
17937
|
+
/** The list of stage diagram names. */
|
|
17938
|
+
name?: string[];
|
|
17939
|
+
/** The list of fields to sort the items by and how to sort them. */
|
|
17940
|
+
sort_by?: string[];
|
|
17941
|
+
}, params?: RequestParams) => Promise<AxiosResponse<StageDiagramsListResponse, any>>;
|
|
17942
|
+
/**
|
|
17943
|
+
* @description Lists stage diagrams.
|
|
17944
|
+
*
|
|
17945
|
+
* @tags customization
|
|
17946
|
+
* @name StageDiagramsListPost
|
|
17947
|
+
* @summary List Stage Diagrams (POST)
|
|
17948
|
+
* @request POST:/stage-diagrams.list
|
|
17949
|
+
* @secure
|
|
17950
|
+
*/
|
|
17951
|
+
stageDiagramsListPost: (data: StageDiagramsListRequest, params?: RequestParams) => Promise<AxiosResponse<StageDiagramsListResponse, any>>;
|
|
17952
|
+
/**
|
|
17953
|
+
* @description Updates a stage diagram.
|
|
17954
|
+
*
|
|
17955
|
+
* @tags customization
|
|
17956
|
+
* @name StageDiagramsUpdate
|
|
17957
|
+
* @summary Update Stage Diagram
|
|
17958
|
+
* @request POST:/stage-diagrams.update
|
|
17959
|
+
* @secure
|
|
17960
|
+
*/
|
|
17961
|
+
stageDiagramsUpdate: (data: StageDiagramsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<StageDiagramsUpdateResponse, any>>;
|
|
17962
|
+
/**
|
|
17963
|
+
* @description Creates a custom stage.
|
|
17964
|
+
*
|
|
17965
|
+
* @tags customization
|
|
17966
|
+
* @name CustomStagesCreate
|
|
17967
|
+
* @summary Create Stages Custom
|
|
17968
|
+
* @request POST:/stages.custom.create
|
|
17969
|
+
* @secure
|
|
17970
|
+
*/
|
|
17971
|
+
customStagesCreate: (data: CustomStagesCreateRequest, params?: RequestParams) => Promise<AxiosResponse<CustomStagesCreateResponse, any>>;
|
|
17972
|
+
/**
|
|
17973
|
+
* @description Gets a custom stage.
|
|
17974
|
+
*
|
|
17975
|
+
* @tags customization
|
|
17976
|
+
* @name CustomStagesGet
|
|
17977
|
+
* @summary Get Stages Custom
|
|
17978
|
+
* @request GET:/stages.custom.get
|
|
17979
|
+
* @secure
|
|
17980
|
+
*/
|
|
17981
|
+
customStagesGet: (query: {
|
|
17982
|
+
/**
|
|
17983
|
+
* The ID of the custom stage to get.
|
|
17984
|
+
* @format id
|
|
17985
|
+
*/
|
|
17986
|
+
id: string;
|
|
17987
|
+
}, params?: RequestParams) => Promise<AxiosResponse<CustomStagesGetResponse, any>>;
|
|
17988
|
+
/**
|
|
17989
|
+
* @description Gets a custom stage.
|
|
17990
|
+
*
|
|
17991
|
+
* @tags customization
|
|
17992
|
+
* @name CustomStagesGetPost
|
|
17993
|
+
* @summary Get Stages Custom (POST)
|
|
17994
|
+
* @request POST:/stages.custom.get
|
|
17995
|
+
* @secure
|
|
17996
|
+
*/
|
|
17997
|
+
customStagesGetPost: (data: CustomStagesGetRequest, params?: RequestParams) => Promise<AxiosResponse<CustomStagesGetResponse, any>>;
|
|
17998
|
+
/**
|
|
17999
|
+
* @description Lists custom stages.
|
|
18000
|
+
*
|
|
18001
|
+
* @tags customization
|
|
18002
|
+
* @name CustomStagesList
|
|
18003
|
+
* @summary List Stages Custom
|
|
18004
|
+
* @request GET:/stages.custom.list
|
|
18005
|
+
* @secure
|
|
18006
|
+
*/
|
|
18007
|
+
customStagesList: (query?: {
|
|
18008
|
+
/**
|
|
18009
|
+
* The cursor to resume iteration from, otherwise if not provided, then
|
|
18010
|
+
* iteration starts from the beginning.
|
|
18011
|
+
* @format text
|
|
18012
|
+
*/
|
|
18013
|
+
cursor?: string;
|
|
18014
|
+
/**
|
|
18015
|
+
* The maximum number of items.
|
|
18016
|
+
* @format int32
|
|
18017
|
+
*/
|
|
18018
|
+
limit?: number;
|
|
18019
|
+
/** The list of stage names. */
|
|
18020
|
+
name?: string[];
|
|
18021
|
+
/** The list of stage ordinals. */
|
|
18022
|
+
ordinal?: number[];
|
|
18023
|
+
/** The list of fields to sort the items by and how to sort them. */
|
|
18024
|
+
sort_by?: string[];
|
|
18025
|
+
}, params?: RequestParams) => Promise<AxiosResponse<CustomStagesListResponse, any>>;
|
|
18026
|
+
/**
|
|
18027
|
+
* @description Lists custom stages.
|
|
18028
|
+
*
|
|
18029
|
+
* @tags customization
|
|
18030
|
+
* @name CustomStagesListPost
|
|
18031
|
+
* @summary List Stages Custom (POST)
|
|
18032
|
+
* @request POST:/stages.custom.list
|
|
18033
|
+
* @secure
|
|
18034
|
+
*/
|
|
18035
|
+
customStagesListPost: (data: CustomStagesListRequest, params?: RequestParams) => Promise<AxiosResponse<CustomStagesListResponse, any>>;
|
|
18036
|
+
/**
|
|
18037
|
+
* @description Updates a custom stage.
|
|
18038
|
+
*
|
|
18039
|
+
* @tags customization
|
|
18040
|
+
* @name CustomStagesUpdate
|
|
18041
|
+
* @summary Update Stages Custom
|
|
18042
|
+
* @request POST:/stages.custom.update
|
|
18043
|
+
* @secure
|
|
18044
|
+
*/
|
|
18045
|
+
customStagesUpdate: (data: CustomStagesUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<CustomStagesUpdateResponse, any>>;
|
|
18046
|
+
/**
|
|
18047
|
+
* @description Creates a custom state.
|
|
18048
|
+
*
|
|
18049
|
+
* @tags customization
|
|
18050
|
+
* @name CustomStatesCreate
|
|
18051
|
+
* @summary Create States Custom
|
|
18052
|
+
* @request POST:/states.custom.create
|
|
18053
|
+
* @secure
|
|
18054
|
+
*/
|
|
18055
|
+
customStatesCreate: (data: CustomStatesCreateRequest, params?: RequestParams) => Promise<AxiosResponse<CustomStatesCreateResponse, any>>;
|
|
18056
|
+
/**
|
|
18057
|
+
* @description Gets a custom state.
|
|
18058
|
+
*
|
|
18059
|
+
* @tags customization
|
|
18060
|
+
* @name CustomStatesGet
|
|
18061
|
+
* @summary Get States Custom
|
|
18062
|
+
* @request GET:/states.custom.get
|
|
18063
|
+
* @secure
|
|
18064
|
+
*/
|
|
18065
|
+
customStatesGet: (query: {
|
|
18066
|
+
/**
|
|
18067
|
+
* The ID of the custom state to get.
|
|
18068
|
+
* @format id
|
|
18069
|
+
*/
|
|
18070
|
+
id: string;
|
|
18071
|
+
}, params?: RequestParams) => Promise<AxiosResponse<CustomStatesGetResponse, any>>;
|
|
18072
|
+
/**
|
|
18073
|
+
* @description Gets a custom state.
|
|
18074
|
+
*
|
|
18075
|
+
* @tags customization
|
|
18076
|
+
* @name CustomStatesGetPost
|
|
18077
|
+
* @summary Get States Custom (POST)
|
|
18078
|
+
* @request POST:/states.custom.get
|
|
18079
|
+
* @secure
|
|
18080
|
+
*/
|
|
18081
|
+
customStatesGetPost: (data: CustomStatesGetRequest, params?: RequestParams) => Promise<AxiosResponse<CustomStatesGetResponse, any>>;
|
|
18082
|
+
/**
|
|
18083
|
+
* @description Lists custom states.
|
|
18084
|
+
*
|
|
18085
|
+
* @tags customization
|
|
18086
|
+
* @name CustomStatesList
|
|
18087
|
+
* @summary List States Custom
|
|
18088
|
+
* @request GET:/states.custom.list
|
|
18089
|
+
* @secure
|
|
18090
|
+
*/
|
|
18091
|
+
customStatesList: (query?: {
|
|
18092
|
+
/**
|
|
18093
|
+
* The cursor to resume iteration from, otherwise if not provided, then
|
|
18094
|
+
* iteration starts from the beginning.
|
|
18095
|
+
* @format text
|
|
18096
|
+
*/
|
|
18097
|
+
cursor?: string;
|
|
18098
|
+
/** Whether only final states should be filtered. */
|
|
18099
|
+
is_final?: boolean;
|
|
18100
|
+
/**
|
|
18101
|
+
* The maximum number of items.
|
|
18102
|
+
* @format int32
|
|
18103
|
+
*/
|
|
18104
|
+
limit?: number;
|
|
18105
|
+
/** The list of state names. */
|
|
18106
|
+
name?: string[];
|
|
18107
|
+
/** The list of state ordinals. */
|
|
18108
|
+
ordinal?: number[];
|
|
18109
|
+
/** The list of fields to sort the items by and how to sort them. */
|
|
18110
|
+
sort_by?: string[];
|
|
18111
|
+
}, params?: RequestParams) => Promise<AxiosResponse<CustomStatesListResponse, any>>;
|
|
18112
|
+
/**
|
|
18113
|
+
* @description Lists custom states.
|
|
18114
|
+
*
|
|
18115
|
+
* @tags customization
|
|
18116
|
+
* @name CustomStatesListPost
|
|
18117
|
+
* @summary List States Custom (POST)
|
|
18118
|
+
* @request POST:/states.custom.list
|
|
18119
|
+
* @secure
|
|
18120
|
+
*/
|
|
18121
|
+
customStatesListPost: (data: CustomStatesListRequest, params?: RequestParams) => Promise<AxiosResponse<CustomStatesListResponse, any>>;
|
|
18122
|
+
/**
|
|
18123
|
+
* @description Updates a custom state.
|
|
18124
|
+
*
|
|
18125
|
+
* @tags customization
|
|
18126
|
+
* @name CustomStatesUpdate
|
|
18127
|
+
* @summary Update States Custom
|
|
18128
|
+
* @request POST:/states.custom.update
|
|
18129
|
+
* @secure
|
|
18130
|
+
*/
|
|
18131
|
+
customStatesUpdate: (data: CustomStatesUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<CustomStatesUpdateResponse, any>>;
|
|
15471
18132
|
/**
|
|
15472
18133
|
* @description Creates a schema for survey, which includes name and description of schema.
|
|
15473
18134
|
*
|
|
@@ -15920,6 +18581,223 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
15920
18581
|
* @secure
|
|
15921
18582
|
*/
|
|
15922
18583
|
timelineEntriesUpdate: (data: TimelineEntriesUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<TimelineEntriesUpdateResponse, any>>;
|
|
18584
|
+
/**
|
|
18585
|
+
* @description Deletes the requested vista.
|
|
18586
|
+
*
|
|
18587
|
+
* @tags vistas
|
|
18588
|
+
* @name VistasDelete
|
|
18589
|
+
* @summary Delete Vista
|
|
18590
|
+
* @request POST:/vistas.delete
|
|
18591
|
+
* @secure
|
|
18592
|
+
*/
|
|
18593
|
+
vistasDelete: (data: VistasDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
|
|
18594
|
+
/**
|
|
18595
|
+
* @description Gets the requested vistas's information.
|
|
18596
|
+
*
|
|
18597
|
+
* @tags vistas
|
|
18598
|
+
* @name VistasGet
|
|
18599
|
+
* @summary Get Vista
|
|
18600
|
+
* @request GET:/vistas.get
|
|
18601
|
+
* @secure
|
|
18602
|
+
*/
|
|
18603
|
+
vistasGet: (query: {
|
|
18604
|
+
/**
|
|
18605
|
+
* The vista's ID.
|
|
18606
|
+
* @format id
|
|
18607
|
+
* @example "VISTA-12345"
|
|
18608
|
+
*/
|
|
18609
|
+
id: string;
|
|
18610
|
+
}, params?: RequestParams) => Promise<AxiosResponse<VistasGetResponse, any>>;
|
|
18611
|
+
/**
|
|
18612
|
+
* @description Gets the requested vistas's information.
|
|
18613
|
+
*
|
|
18614
|
+
* @tags vistas
|
|
18615
|
+
* @name VistasGetPost
|
|
18616
|
+
* @summary Get Vista (POST)
|
|
18617
|
+
* @request POST:/vistas.get
|
|
18618
|
+
* @secure
|
|
18619
|
+
*/
|
|
18620
|
+
vistasGetPost: (data: VistasGetRequest, params?: RequestParams) => Promise<AxiosResponse<VistasGetResponse, any>>;
|
|
18621
|
+
/**
|
|
18622
|
+
* @description Deletes the requested vista group item
|
|
18623
|
+
*
|
|
18624
|
+
* @tags vistas
|
|
18625
|
+
* @name VistasGroupsDelete
|
|
18626
|
+
* @summary Delete Vistas Group
|
|
18627
|
+
* @request POST:/vistas.groups.delete
|
|
18628
|
+
* @secure
|
|
18629
|
+
*/
|
|
18630
|
+
vistasGroupsDelete: (data: VistasGroupsDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
|
|
18631
|
+
/**
|
|
18632
|
+
* @description Gets the requested vista group item's information.
|
|
18633
|
+
*
|
|
18634
|
+
* @tags vistas
|
|
18635
|
+
* @name VistasGroupsGet
|
|
18636
|
+
* @summary Get Vistas Group
|
|
18637
|
+
* @request GET:/vistas.groups.get
|
|
18638
|
+
* @secure
|
|
18639
|
+
*/
|
|
18640
|
+
vistasGroupsGet: (query: {
|
|
18641
|
+
/**
|
|
18642
|
+
* The vista group item's ID.
|
|
18643
|
+
* @format id
|
|
18644
|
+
*/
|
|
18645
|
+
id: string;
|
|
18646
|
+
}, params?: RequestParams) => Promise<AxiosResponse<VistasGroupsGetResponse, any>>;
|
|
18647
|
+
/**
|
|
18648
|
+
* @description Gets the requested vista group item's information.
|
|
18649
|
+
*
|
|
18650
|
+
* @tags vistas
|
|
18651
|
+
* @name VistasGroupsGetPost
|
|
18652
|
+
* @summary Get Vistas Group (POST)
|
|
18653
|
+
* @request POST:/vistas.groups.get
|
|
18654
|
+
* @secure
|
|
18655
|
+
*/
|
|
18656
|
+
vistasGroupsGetPost: (data: VistasGroupsGetRequest, params?: RequestParams) => Promise<AxiosResponse<VistasGroupsGetResponse, any>>;
|
|
18657
|
+
/**
|
|
18658
|
+
* @description Lists the available vista group items.
|
|
18659
|
+
*
|
|
18660
|
+
* @tags vistas
|
|
18661
|
+
* @name VistasGroupsList
|
|
18662
|
+
* @summary List Vistas Groups
|
|
18663
|
+
* @request GET:/vistas.groups.list
|
|
18664
|
+
* @secure
|
|
18665
|
+
*/
|
|
18666
|
+
vistasGroupsList: (query?: {
|
|
18667
|
+
/**
|
|
18668
|
+
* Filters for vista group items which have one of the parts linked as
|
|
18669
|
+
* its ancestor part or primary part.
|
|
18670
|
+
* @example ["PROD-12345"]
|
|
18671
|
+
*/
|
|
18672
|
+
ancestor_part?: string[];
|
|
18673
|
+
/**
|
|
18674
|
+
* Whether to include items belonging to children of any of the provided
|
|
18675
|
+
* parts.
|
|
18676
|
+
*/
|
|
18677
|
+
'applies_to_part.include_child_parts'?: boolean;
|
|
18678
|
+
/**
|
|
18679
|
+
* Part IDs to filter on. Required if any applies_to_part.* fields are
|
|
18680
|
+
* provided.
|
|
18681
|
+
* @example ["PROD-12345"]
|
|
18682
|
+
*/
|
|
18683
|
+
'applies_to_part.parts'?: string[];
|
|
18684
|
+
/**
|
|
18685
|
+
* Filter for vistas group item created by any of these users.
|
|
18686
|
+
* @example ["DEVU-12345"]
|
|
18687
|
+
*/
|
|
18688
|
+
created_by?: string[];
|
|
18689
|
+
/**
|
|
18690
|
+
* The cursor to resume iteration from. If not provided, then iteration
|
|
18691
|
+
* starts from the beginning.
|
|
18692
|
+
* @format text
|
|
18693
|
+
*/
|
|
18694
|
+
cursor?: string;
|
|
18695
|
+
/** Filters for vista group items of the specific group object type. */
|
|
18696
|
+
group_object_type?: VistaGroupItemGroupObjectType[];
|
|
18697
|
+
/**
|
|
18698
|
+
* The request to get information about a list of vista groups.
|
|
18699
|
+
* @format int32
|
|
18700
|
+
*/
|
|
18701
|
+
limit?: number;
|
|
18702
|
+
/**
|
|
18703
|
+
* The iteration mode to use, otherwise if not set, then "after" is
|
|
18704
|
+
* used.
|
|
18705
|
+
*/
|
|
18706
|
+
mode?: ListMode;
|
|
18707
|
+
/**
|
|
18708
|
+
* Parent ID of the vista group item.
|
|
18709
|
+
* @example ["VISTA-12345"]
|
|
18710
|
+
*/
|
|
18711
|
+
parent_id?: string[];
|
|
18712
|
+
/** Comma-separated fields to sort the objects by. */
|
|
18713
|
+
sort_by?: string[];
|
|
18714
|
+
/** Denotes the state of the vista group item. */
|
|
18715
|
+
state?: VistaGroupItemState[];
|
|
18716
|
+
/** Filters for vista group items of the specific type. */
|
|
18717
|
+
type?: GroupItemType[];
|
|
18718
|
+
}, params?: RequestParams) => Promise<AxiosResponse<VistasGroupsListResponse, any>>;
|
|
18719
|
+
/**
|
|
18720
|
+
* @description Lists the available vista group items.
|
|
18721
|
+
*
|
|
18722
|
+
* @tags vistas
|
|
18723
|
+
* @name VistasGroupsListPost
|
|
18724
|
+
* @summary List Vistas Groups (POST)
|
|
18725
|
+
* @request POST:/vistas.groups.list
|
|
18726
|
+
* @secure
|
|
18727
|
+
*/
|
|
18728
|
+
vistasGroupsListPost: (data: VistasGroupsListRequest, params?: RequestParams) => Promise<AxiosResponse<VistasGroupsListResponse, any>>;
|
|
18729
|
+
/**
|
|
18730
|
+
* @description Lists the available vistas.
|
|
18731
|
+
*
|
|
18732
|
+
* @tags vistas
|
|
18733
|
+
* @name VistasList
|
|
18734
|
+
* @summary List Vistas
|
|
18735
|
+
* @request GET:/vistas.list
|
|
18736
|
+
* @secure
|
|
18737
|
+
*/
|
|
18738
|
+
vistasList: (query?: {
|
|
18739
|
+
/**
|
|
18740
|
+
* Filters for vistas created by any of these users.
|
|
18741
|
+
* @example ["DEVU-12345"]
|
|
18742
|
+
*/
|
|
18743
|
+
created_by?: string[];
|
|
18744
|
+
/**
|
|
18745
|
+
* The cursor to resume iteration from. If not provided, then iteration
|
|
18746
|
+
* starts from the beginning.
|
|
18747
|
+
* @format text
|
|
18748
|
+
*/
|
|
18749
|
+
cursor?: string;
|
|
18750
|
+
/** Filters for vistas of specific flavor. */
|
|
18751
|
+
flavor?: GroupedVistaFlavor[];
|
|
18752
|
+
/** Whether the default vistas should be fetched or not. */
|
|
18753
|
+
is_default?: boolean;
|
|
18754
|
+
/**
|
|
18755
|
+
* The maximum number of vistas to return. The default is '50', the
|
|
18756
|
+
* maximum is '100'.
|
|
18757
|
+
* @format int32
|
|
18758
|
+
*/
|
|
18759
|
+
limit?: number;
|
|
18760
|
+
/**
|
|
18761
|
+
* Filters for vistas accessible to the input members.
|
|
18762
|
+
* @example ["DEVU-12345"]
|
|
18763
|
+
*/
|
|
18764
|
+
members?: string[];
|
|
18765
|
+
/**
|
|
18766
|
+
* The iteration mode to use, otherwise if not set, then "after" is
|
|
18767
|
+
* used.
|
|
18768
|
+
*/
|
|
18769
|
+
mode?: ListMode;
|
|
18770
|
+
/** Filters for vistas of specific object types like works, parts etc. */
|
|
18771
|
+
object_type?: DynamicVistaFilterType[];
|
|
18772
|
+
/**
|
|
18773
|
+
* ID of the group/member with whom the item is shared.
|
|
18774
|
+
* @format id
|
|
18775
|
+
*/
|
|
18776
|
+
'shared_with.member'?: string;
|
|
18777
|
+
/**
|
|
18778
|
+
* Role ID of the group/member with whom the item is shared.
|
|
18779
|
+
* @format id
|
|
18780
|
+
*/
|
|
18781
|
+
'shared_with.role'?: string;
|
|
18782
|
+
/** Denotes whether to skip items of vista_group_item in response. */
|
|
18783
|
+
skip_items?: boolean;
|
|
18784
|
+
/** Fields to sort the vistas by and the direction to sort them. */
|
|
18785
|
+
sort_by?: string[];
|
|
18786
|
+
/** Denotes the state of the vista group item. */
|
|
18787
|
+
state?: VistaGroupItemState[];
|
|
18788
|
+
/** Filters for vistas of the specific type. */
|
|
18789
|
+
type?: VistaType[];
|
|
18790
|
+
}, params?: RequestParams) => Promise<AxiosResponse<VistasListResponse, any>>;
|
|
18791
|
+
/**
|
|
18792
|
+
* @description Lists the available vistas.
|
|
18793
|
+
*
|
|
18794
|
+
* @tags vistas
|
|
18795
|
+
* @name VistasListPost
|
|
18796
|
+
* @summary List Vistas (POST)
|
|
18797
|
+
* @request POST:/vistas.list
|
|
18798
|
+
* @secure
|
|
18799
|
+
*/
|
|
18800
|
+
vistasListPost: (data: VistasListRequest, params?: RequestParams) => Promise<AxiosResponse<VistasListResponse, any>>;
|
|
15923
18801
|
/**
|
|
15924
18802
|
* @description Change state of a web crawler job to pause or resume it back to running.
|
|
15925
18803
|
*
|
|
@@ -16228,6 +19106,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
16228
19106
|
'ticket.sla_summary.stage'?: SlaSummaryStage[];
|
|
16229
19107
|
/** Filters for tickets with any of the provided source channels. */
|
|
16230
19108
|
'ticket.source_channel'?: string[];
|
|
19109
|
+
/**
|
|
19110
|
+
* Filters for tickets that are associated with any of the source
|
|
19111
|
+
* channels.
|
|
19112
|
+
*/
|
|
19113
|
+
'ticket.source_channel_v2'?: string[];
|
|
16231
19114
|
/** Filters for work of the provided types. */
|
|
16232
19115
|
type?: WorkType[];
|
|
16233
19116
|
}, params?: RequestParams) => Promise<AxiosResponse<WorksExportResponse, any>>;
|
|
@@ -16392,6 +19275,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
16392
19275
|
'ticket.sla_summary.stage'?: SlaSummaryStage[];
|
|
16393
19276
|
/** Filters for tickets with any of the provided source channels. */
|
|
16394
19277
|
'ticket.source_channel'?: string[];
|
|
19278
|
+
/**
|
|
19279
|
+
* Filters for tickets that are associated with any of the source
|
|
19280
|
+
* channels.
|
|
19281
|
+
*/
|
|
19282
|
+
'ticket.source_channel_v2'?: string[];
|
|
16395
19283
|
/** Filters for work of the provided types. */
|
|
16396
19284
|
type?: WorkType[];
|
|
16397
19285
|
}, params?: RequestParams) => Promise<AxiosResponse<WorksListResponse, any>>;
|