@devrev/typescript-sdk 1.1.63 → 1.1.65
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.
|
@@ -314,6 +314,85 @@ export interface AddTagWithValue {
|
|
|
314
314
|
*/
|
|
315
315
|
value?: string;
|
|
316
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
|
+
}
|
|
317
396
|
/**
|
|
318
397
|
* ai-agent-event-execute-error
|
|
319
398
|
* An error object providing the error message for the AI agent event
|
|
@@ -421,6 +500,22 @@ export interface AiAgentSuggestion {
|
|
|
421
500
|
*/
|
|
422
501
|
suggestion: string;
|
|
423
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
|
+
}
|
|
424
519
|
/**
|
|
425
520
|
* archetype-metric-target
|
|
426
521
|
* Metric with corresponding target values.
|
|
@@ -602,6 +697,18 @@ export declare enum ArticleStatus {
|
|
|
602
697
|
Published = "published",
|
|
603
698
|
ReviewNeeded = "review_needed"
|
|
604
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
|
+
};
|
|
605
712
|
/** Type of the article. */
|
|
606
713
|
export declare enum ArticleType {
|
|
607
714
|
Article = "article",
|
|
@@ -826,6 +933,8 @@ export interface ArticlesListRequest {
|
|
|
826
933
|
* @example ["DEVU-12345"]
|
|
827
934
|
*/
|
|
828
935
|
owned_by?: string[];
|
|
936
|
+
/** Filters for articles with the provided parent directories. */
|
|
937
|
+
parent?: string[];
|
|
829
938
|
/** Filter for the scope of the articles. */
|
|
830
939
|
scope?: number[];
|
|
831
940
|
/** Filter for articles based on intended audience. */
|
|
@@ -1308,7 +1417,7 @@ export interface ArtifactsVersionsPrepareResponseFormData {
|
|
|
1308
1417
|
value: string;
|
|
1309
1418
|
}
|
|
1310
1419
|
/** atom */
|
|
1311
|
-
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) & {
|
|
1312
1421
|
type: AtomType;
|
|
1313
1422
|
};
|
|
1314
1423
|
/** atom-base */
|
|
@@ -1352,10 +1461,11 @@ export interface AtomBaseSummary {
|
|
|
1352
1461
|
id: string;
|
|
1353
1462
|
}
|
|
1354
1463
|
/** atom-summary */
|
|
1355
|
-
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) & {
|
|
1356
1465
|
type: AtomType;
|
|
1357
1466
|
};
|
|
1358
1467
|
export declare enum AtomType {
|
|
1468
|
+
Article = "article",
|
|
1359
1469
|
AuthToken = "auth_token",
|
|
1360
1470
|
Capability = "capability",
|
|
1361
1471
|
Conversation = "conversation",
|
|
@@ -2208,6 +2318,54 @@ export interface ChatsUpdateRequestDmUsers {
|
|
|
2208
2318
|
export interface ChatsUpdateResponse {
|
|
2209
2319
|
chat: Chat;
|
|
2210
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
|
+
}
|
|
2211
2369
|
/** code-change */
|
|
2212
2370
|
export type CodeChange = AtomBase & {
|
|
2213
2371
|
/**
|
|
@@ -2636,6 +2794,24 @@ export interface CommandsListResponse {
|
|
|
2636
2794
|
*/
|
|
2637
2795
|
prev_cursor?: string;
|
|
2638
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
|
+
}
|
|
2639
2815
|
/** conversation */
|
|
2640
2816
|
export type Conversation = AtomBase & {
|
|
2641
2817
|
/** Channel IDs of the conversation. */
|
|
@@ -2662,6 +2838,7 @@ export type Conversation = AtomBase & {
|
|
|
2662
2838
|
* @format text
|
|
2663
2839
|
*/
|
|
2664
2840
|
source_channel?: string;
|
|
2841
|
+
source_channel_v2?: ExternalCommunicationChannelSummary;
|
|
2665
2842
|
/** Describes the current stage of a work item. */
|
|
2666
2843
|
stage?: LegacyStage;
|
|
2667
2844
|
/** Tags associated with the object. */
|
|
@@ -2757,8 +2934,6 @@ export interface ConversationsCreateRequest {
|
|
|
2757
2934
|
* @format text
|
|
2758
2935
|
*/
|
|
2759
2936
|
title?: string;
|
|
2760
|
-
/** The IDs of user sessions associated with the conversation. */
|
|
2761
|
-
user_sessions?: string[];
|
|
2762
2937
|
}
|
|
2763
2938
|
/** conversations-create-request-message */
|
|
2764
2939
|
export interface ConversationsCreateRequestMessage {
|
|
@@ -3002,7 +3177,6 @@ export interface ConversationsUpdateRequest {
|
|
|
3002
3177
|
* @format text
|
|
3003
3178
|
*/
|
|
3004
3179
|
title?: string;
|
|
3005
|
-
user_sessions?: ConversationsUpdateRequestUserSessions;
|
|
3006
3180
|
}
|
|
3007
3181
|
/** conversations-update-request-applies-to-parts */
|
|
3008
3182
|
export interface ConversationsUpdateRequestAppliesToParts {
|
|
@@ -3047,11 +3221,6 @@ export interface ConversationsUpdateRequestTags {
|
|
|
3047
3221
|
/** Sets the tag IDs to the provided tags. */
|
|
3048
3222
|
set?: SetTagWithValue[];
|
|
3049
3223
|
}
|
|
3050
|
-
/** conversations-update-request-user-sessions */
|
|
3051
|
-
export interface ConversationsUpdateRequestUserSessions {
|
|
3052
|
-
/** The updated user sessions that the conversation is associated with. */
|
|
3053
|
-
set?: string[];
|
|
3054
|
-
}
|
|
3055
3224
|
/**
|
|
3056
3225
|
* conversations-update-response
|
|
3057
3226
|
* The response for updating a conversation.
|
|
@@ -3145,6 +3314,34 @@ export interface CreateOrgScheduleInterval {
|
|
|
3145
3314
|
*/
|
|
3146
3315
|
to?: string;
|
|
3147
3316
|
}
|
|
3317
|
+
/** create-stage-node */
|
|
3318
|
+
export interface CreateStageNode {
|
|
3319
|
+
/** Whether this stage is deprecated. */
|
|
3320
|
+
is_deprecated?: boolean;
|
|
3321
|
+
/** Whether this is the start stage. */
|
|
3322
|
+
is_start?: boolean;
|
|
3323
|
+
/**
|
|
3324
|
+
* The ID of the stage.
|
|
3325
|
+
* @format id
|
|
3326
|
+
*/
|
|
3327
|
+
stage_id: string;
|
|
3328
|
+
/** List of transitions from this stage. */
|
|
3329
|
+
transitions?: CreateStageTransition[];
|
|
3330
|
+
}
|
|
3331
|
+
/** create-stage-transition */
|
|
3332
|
+
export interface CreateStageTransition {
|
|
3333
|
+
/**
|
|
3334
|
+
* The ID of the target stage.
|
|
3335
|
+
* @format id
|
|
3336
|
+
*/
|
|
3337
|
+
target_stage_id: string;
|
|
3338
|
+
ui?: CreateStageUiMetadata;
|
|
3339
|
+
}
|
|
3340
|
+
/** create-stage-ui-metadata */
|
|
3341
|
+
export interface CreateStageUiMetadata {
|
|
3342
|
+
/** Whether the stage is hidden. */
|
|
3343
|
+
is_hidden?: boolean;
|
|
3344
|
+
}
|
|
3148
3345
|
/** create-weekly-org-schedule-interval */
|
|
3149
3346
|
export interface CreateWeeklyOrgScheduleInterval {
|
|
3150
3347
|
/**
|
|
@@ -3169,165 +3366,843 @@ export type CuratedVista = VistaBase & {
|
|
|
3169
3366
|
/** Item list to store a curated list of DevRev objects. */
|
|
3170
3367
|
items?: AtomSummary[];
|
|
3171
3368
|
};
|
|
3172
|
-
/**
|
|
3173
|
-
|
|
3174
|
-
* Custom schemas described using identifiers. Each custom field in the
|
|
3175
|
-
* request must have the corresponding schema specified; omission results
|
|
3176
|
-
* in a Bad Request error. If a custom schema is not included in the
|
|
3177
|
-
* specifier, it remains unchanged. For surfaces with human interactors,
|
|
3178
|
-
* it is recommended to provide tenant_fragment: true and
|
|
3179
|
-
* validate_required_fields: true.
|
|
3180
|
-
*/
|
|
3181
|
-
export interface CustomSchemaSpec {
|
|
3182
|
-
/** List of apps. */
|
|
3183
|
-
apps?: string[];
|
|
3369
|
+
/** custom-object */
|
|
3370
|
+
export type CustomObject = AtomBase & {
|
|
3184
3371
|
/**
|
|
3185
|
-
*
|
|
3372
|
+
* Type of the object.
|
|
3186
3373
|
* @format text
|
|
3187
3374
|
*/
|
|
3188
|
-
|
|
3189
|
-
/**
|
|
3190
|
-
|
|
3191
|
-
/** Whether to enforce required fields validation. */
|
|
3192
|
-
validate_required_fields?: boolean;
|
|
3193
|
-
}
|
|
3194
|
-
/** dashboard */
|
|
3195
|
-
export type Dashboard = AtomBase;
|
|
3196
|
-
/**
|
|
3197
|
-
* date-filter
|
|
3198
|
-
* Provides ways to specify date ranges on objects.
|
|
3199
|
-
*/
|
|
3200
|
-
export type DateFilter = (DateTimeFilter | DateTimePreset) & {
|
|
3201
|
-
/** Type of date filter. */
|
|
3202
|
-
type: DateFilterType;
|
|
3203
|
-
};
|
|
3204
|
-
/** Type of date filter. */
|
|
3205
|
-
export declare enum DateFilterType {
|
|
3206
|
-
Preset = "preset",
|
|
3207
|
-
Range = "range"
|
|
3208
|
-
}
|
|
3209
|
-
/** date-time-filter */
|
|
3210
|
-
export interface DateTimeFilter {
|
|
3375
|
+
leaf_type?: string;
|
|
3376
|
+
/** Describes the current stage of a object. */
|
|
3377
|
+
stage?: Stage;
|
|
3211
3378
|
/**
|
|
3212
|
-
*
|
|
3213
|
-
*
|
|
3214
|
-
* @format date-time
|
|
3215
|
-
* @example "2023-01-01T12:00:00.000Z"
|
|
3379
|
+
* Title of the object.
|
|
3380
|
+
* @format text
|
|
3216
3381
|
*/
|
|
3217
|
-
|
|
3382
|
+
title?: string;
|
|
3218
3383
|
/**
|
|
3219
|
-
*
|
|
3220
|
-
*
|
|
3221
|
-
*
|
|
3222
|
-
* @
|
|
3384
|
+
* A unique key that, if provided, ensures the combination of
|
|
3385
|
+
* {leaf_type, unique_key} is distinct across all objects in the
|
|
3386
|
+
* system.
|
|
3387
|
+
* @format text
|
|
3223
3388
|
*/
|
|
3224
|
-
|
|
3225
|
-
}
|
|
3226
|
-
/**
|
|
3227
|
-
* date-time-preset
|
|
3228
|
-
* Provides preset types for date filter.
|
|
3229
|
-
*/
|
|
3230
|
-
export type DateTimePreset = (DateTimePresetLastNDays | DateTimePresetNextNDays) & {
|
|
3231
|
-
/** Type of date preset. */
|
|
3232
|
-
preset_type: DateTimePresetType;
|
|
3389
|
+
unique_key?: string;
|
|
3233
3390
|
};
|
|
3234
|
-
/**
|
|
3235
|
-
export interface
|
|
3391
|
+
/** custom-objects-count-request */
|
|
3392
|
+
export interface CustomObjectsCountRequest {
|
|
3393
|
+
/** List of filters to apply. */
|
|
3394
|
+
filters?: any[];
|
|
3236
3395
|
/**
|
|
3237
|
-
*
|
|
3238
|
-
*
|
|
3239
|
-
* @min 0
|
|
3240
|
-
* @max 4294967295
|
|
3396
|
+
* Leaf type to filter.
|
|
3397
|
+
* @format text
|
|
3241
3398
|
*/
|
|
3242
|
-
|
|
3399
|
+
leaf_type: string;
|
|
3243
3400
|
}
|
|
3244
|
-
/**
|
|
3245
|
-
export interface
|
|
3401
|
+
/** custom-objects-count-response */
|
|
3402
|
+
export interface CustomObjectsCountResponse {
|
|
3246
3403
|
/**
|
|
3247
|
-
* The
|
|
3248
|
-
*
|
|
3249
|
-
* @min 0
|
|
3250
|
-
* @max 4294967295
|
|
3404
|
+
* The count of custom objects.
|
|
3405
|
+
* @format int64
|
|
3251
3406
|
*/
|
|
3252
|
-
|
|
3253
|
-
}
|
|
3254
|
-
/** Type of date preset. */
|
|
3255
|
-
export declare enum DateTimePresetType {
|
|
3256
|
-
LastNDays = "last_n_days",
|
|
3257
|
-
NextNDays = "next_n_days"
|
|
3258
|
-
}
|
|
3259
|
-
/** Indicates whether this evaluation can change in the future. */
|
|
3260
|
-
export declare enum Definedness {
|
|
3261
|
-
Immutable = "immutable",
|
|
3262
|
-
Mutable = "mutable",
|
|
3263
|
-
Undefined = "undefined"
|
|
3407
|
+
count: number;
|
|
3264
3408
|
}
|
|
3265
|
-
/**
|
|
3266
|
-
export
|
|
3267
|
-
/**
|
|
3268
|
-
|
|
3269
|
-
* Request to create a new enterprise authentication connection.
|
|
3270
|
-
*/
|
|
3271
|
-
export type DevOrgAuthConnectionsCreateRequest = (DevOrgAuthConnectionsCreateRequestAzureAdOptions | DevOrgAuthConnectionsCreateRequestGoogleAppsOptions | DevOrgAuthConnectionsCreateRequestOidcOptions | DevOrgAuthConnectionsCreateRequestOktaOptions | DevOrgAuthConnectionsCreateRequestSamlOptions) & {
|
|
3409
|
+
/** custom-objects-create-request */
|
|
3410
|
+
export interface CustomObjectsCreateRequest {
|
|
3411
|
+
/** Custom fields of the custom object. */
|
|
3412
|
+
custom_fields?: object;
|
|
3272
3413
|
/**
|
|
3273
|
-
*
|
|
3274
|
-
*
|
|
3414
|
+
* Custom schemas described using identifiers. Each custom field in the
|
|
3415
|
+
* request must have the corresponding schema specified; omission results
|
|
3416
|
+
* in a Bad Request error. If a custom schema is not included in the
|
|
3417
|
+
* specifier, it remains unchanged. For surfaces with human interactors,
|
|
3418
|
+
* it is recommended to provide tenant_fragment: true and
|
|
3419
|
+
* validate_required_fields: true.
|
|
3275
3420
|
*/
|
|
3276
|
-
|
|
3421
|
+
custom_schema_spec?: CustomSchemaSpec;
|
|
3277
3422
|
/**
|
|
3278
|
-
*
|
|
3279
|
-
* visible to all the users when they sign in to this Dev
|
|
3280
|
-
* organization. For example, if the display_name is 'abclogin', then
|
|
3281
|
-
* it would appear on the login button as 'Log in to abclogin'.
|
|
3423
|
+
* Leaf type of the custom object.
|
|
3282
3424
|
* @format text
|
|
3283
|
-
* @minLength 1
|
|
3284
|
-
* @maxLength 128
|
|
3285
3425
|
*/
|
|
3286
|
-
|
|
3287
|
-
};
|
|
3288
|
-
/**
|
|
3289
|
-
* dev-org-auth-connections-create-request-azure-ad-options
|
|
3290
|
-
* Object encapsulating the configuration parameters for an Azure AD
|
|
3291
|
-
* authentication connection.
|
|
3292
|
-
* @deprecated
|
|
3293
|
-
*/
|
|
3294
|
-
export interface DevOrgAuthConnectionsCreateRequestAzureAdOptions {
|
|
3426
|
+
leaf_type: string;
|
|
3295
3427
|
/**
|
|
3296
|
-
*
|
|
3297
|
-
* @format
|
|
3428
|
+
* The stage of the custom object.
|
|
3429
|
+
* @format id
|
|
3298
3430
|
*/
|
|
3299
|
-
|
|
3431
|
+
stage?: string;
|
|
3300
3432
|
/**
|
|
3301
|
-
*
|
|
3302
|
-
*
|
|
3433
|
+
* The type of stage validations options when creating a custom
|
|
3434
|
+
* object.
|
|
3303
3435
|
*/
|
|
3304
|
-
|
|
3436
|
+
stage_validation_options?: StageValidationOptionForCreate[];
|
|
3305
3437
|
/**
|
|
3306
|
-
*
|
|
3438
|
+
* Title of the custom object.
|
|
3307
3439
|
* @format text
|
|
3308
3440
|
*/
|
|
3309
|
-
|
|
3310
|
-
}
|
|
3311
|
-
/**
|
|
3312
|
-
* dev-org-auth-connections-create-request-google-apps-options
|
|
3313
|
-
* Object encapsulating the configuration parameters for a Google Apps
|
|
3314
|
-
* authentication connection.
|
|
3315
|
-
* @deprecated
|
|
3316
|
-
*/
|
|
3317
|
-
export interface DevOrgAuthConnectionsCreateRequestGoogleAppsOptions {
|
|
3441
|
+
title?: string;
|
|
3318
3442
|
/**
|
|
3319
|
-
*
|
|
3443
|
+
* The unique key of the custom object.This can be used to hold an
|
|
3444
|
+
* external reference to another object.
|
|
3320
3445
|
* @format text
|
|
3321
3446
|
*/
|
|
3322
|
-
|
|
3447
|
+
unique_key?: string;
|
|
3448
|
+
}
|
|
3449
|
+
/** custom-objects-create-response */
|
|
3450
|
+
export interface CustomObjectsCreateResponse {
|
|
3451
|
+
custom_object: CustomObject;
|
|
3452
|
+
}
|
|
3453
|
+
/** custom-objects-delete-request */
|
|
3454
|
+
export interface CustomObjectsDeleteRequest {
|
|
3323
3455
|
/**
|
|
3324
|
-
*
|
|
3325
|
-
* @format
|
|
3456
|
+
* The ID of the custom object to get.
|
|
3457
|
+
* @format id
|
|
3326
3458
|
*/
|
|
3327
|
-
|
|
3459
|
+
id: string;
|
|
3460
|
+
}
|
|
3461
|
+
/** custom-objects-delete-response */
|
|
3462
|
+
export type CustomObjectsDeleteResponse = object;
|
|
3463
|
+
/** custom-objects-get-request */
|
|
3464
|
+
export interface CustomObjectsGetRequest {
|
|
3328
3465
|
/**
|
|
3329
|
-
*
|
|
3330
|
-
* @format
|
|
3466
|
+
* The ID of the custom object to get.
|
|
3467
|
+
* @format id
|
|
3468
|
+
*/
|
|
3469
|
+
id?: string;
|
|
3470
|
+
}
|
|
3471
|
+
/** custom-objects-get-response */
|
|
3472
|
+
export interface CustomObjectsGetResponse {
|
|
3473
|
+
custom_object: CustomObject;
|
|
3474
|
+
}
|
|
3475
|
+
/** custom-objects-list-request */
|
|
3476
|
+
export interface CustomObjectsListRequest {
|
|
3477
|
+
/**
|
|
3478
|
+
* The cursor to resume iteration from. If not provided, then
|
|
3479
|
+
* iteration starts from the beginning.
|
|
3480
|
+
* @format text
|
|
3481
|
+
*/
|
|
3482
|
+
cursor?: string;
|
|
3483
|
+
/** List of filters to apply. */
|
|
3484
|
+
filter?: any[];
|
|
3485
|
+
/** List of filters to apply. */
|
|
3486
|
+
filters?: any[];
|
|
3487
|
+
/**
|
|
3488
|
+
* Leaf type to filter.
|
|
3489
|
+
* @format text
|
|
3490
|
+
*/
|
|
3491
|
+
leaf_type: string;
|
|
3492
|
+
/**
|
|
3493
|
+
* The maximum number of items.
|
|
3494
|
+
* @format int32
|
|
3495
|
+
*/
|
|
3496
|
+
limit?: number;
|
|
3497
|
+
/**
|
|
3498
|
+
* The iteration mode to use. If "after", then entries after the provided
|
|
3499
|
+
* cursor will be returned, or if no cursor is provided, then from the
|
|
3500
|
+
* beginning. If "before", then entries before the provided cursor will be
|
|
3501
|
+
* returned, or if no cursor is provided, then from the end. Entries will
|
|
3502
|
+
* always be returned in the specified sort-by order.
|
|
3503
|
+
*/
|
|
3504
|
+
mode?: ListMode;
|
|
3505
|
+
/** The list of fields to sort the items by and how to sort them. */
|
|
3506
|
+
sort_by?: string[];
|
|
3507
|
+
}
|
|
3508
|
+
/**
|
|
3509
|
+
* custom-objects-list-response
|
|
3510
|
+
* The response to listing all custom objects matching the filter
|
|
3511
|
+
* criteria.
|
|
3512
|
+
*/
|
|
3513
|
+
export interface CustomObjectsListResponse {
|
|
3514
|
+
/**
|
|
3515
|
+
* The cursor used to iterate subsequent results in accordance to the
|
|
3516
|
+
* sort order. If not set, then no later elements exist.
|
|
3517
|
+
* @format text
|
|
3518
|
+
*/
|
|
3519
|
+
next_cursor?: string;
|
|
3520
|
+
/**
|
|
3521
|
+
* The cursor used to iterate preceding results in accordance to the
|
|
3522
|
+
* sort order. If not set, then no prior elements exist.
|
|
3523
|
+
* @format text
|
|
3524
|
+
*/
|
|
3525
|
+
prev_cursor?: string;
|
|
3526
|
+
/** The custom objects. */
|
|
3527
|
+
result: CustomObject[];
|
|
3528
|
+
}
|
|
3529
|
+
/** custom-objects-update-request */
|
|
3530
|
+
export interface CustomObjectsUpdateRequest {
|
|
3531
|
+
/** Custom fields of the custom object. */
|
|
3532
|
+
custom_fields?: object;
|
|
3533
|
+
/**
|
|
3534
|
+
* Custom schemas described using identifiers. Each custom field in the
|
|
3535
|
+
* request must have the corresponding schema specified; omission results
|
|
3536
|
+
* in a Bad Request error. If a custom schema is not included in the
|
|
3537
|
+
* specifier, it remains unchanged. For surfaces with human interactors,
|
|
3538
|
+
* it is recommended to provide tenant_fragment: true and
|
|
3539
|
+
* validate_required_fields: true.
|
|
3540
|
+
*/
|
|
3541
|
+
custom_schema_spec?: CustomSchemaSpec;
|
|
3542
|
+
/**
|
|
3543
|
+
* The ID of the custom object to update.
|
|
3544
|
+
* @format id
|
|
3545
|
+
*/
|
|
3546
|
+
id: string;
|
|
3547
|
+
/**
|
|
3548
|
+
* Updates the stage of the custom object.
|
|
3549
|
+
* @format id
|
|
3550
|
+
*/
|
|
3551
|
+
stage?: string | null;
|
|
3552
|
+
/**
|
|
3553
|
+
* The type of stage validations options when updating the stage or
|
|
3554
|
+
* the stage diagram of a custom object.
|
|
3555
|
+
*/
|
|
3556
|
+
stage_validation_options?: StageValidationOptionForUpdate[];
|
|
3557
|
+
/**
|
|
3558
|
+
* Updates the title of the custom object.
|
|
3559
|
+
* @format text
|
|
3560
|
+
*/
|
|
3561
|
+
title?: string | null;
|
|
3562
|
+
}
|
|
3563
|
+
/** custom-objects-update-response */
|
|
3564
|
+
export interface CustomObjectsUpdateResponse {
|
|
3565
|
+
custom_object: CustomObject;
|
|
3566
|
+
}
|
|
3567
|
+
/** custom-schema-fragment */
|
|
3568
|
+
export interface CustomSchemaFragment {
|
|
3569
|
+
type: CustomSchemaFragmentType;
|
|
3570
|
+
}
|
|
3571
|
+
/**
|
|
3572
|
+
* custom-schema-fragment-condition
|
|
3573
|
+
* The condition associated with a field.
|
|
3574
|
+
*/
|
|
3575
|
+
export interface CustomSchemaFragmentCondition {
|
|
3576
|
+
/** The associated effects when the expression evaluates to true. */
|
|
3577
|
+
effects?: CustomSchemaFragmentEffect[];
|
|
3578
|
+
/**
|
|
3579
|
+
* The expression to evaluate.
|
|
3580
|
+
* @format text
|
|
3581
|
+
*/
|
|
3582
|
+
expression?: string;
|
|
3583
|
+
}
|
|
3584
|
+
/**
|
|
3585
|
+
* custom-schema-fragment-effect
|
|
3586
|
+
* An effect associated with a condition.
|
|
3587
|
+
*/
|
|
3588
|
+
export interface CustomSchemaFragmentEffect {
|
|
3589
|
+
/**
|
|
3590
|
+
* Allowed values for the fields based on the condition. This takes
|
|
3591
|
+
* precedence over allowed_values in field_descriptor.
|
|
3592
|
+
*/
|
|
3593
|
+
allowed_values?: string[];
|
|
3594
|
+
/** The fields which are affected by the condition. */
|
|
3595
|
+
fields: string[];
|
|
3596
|
+
/**
|
|
3597
|
+
* Whether the fields should be made immutable or not based on the
|
|
3598
|
+
* condition.
|
|
3599
|
+
*/
|
|
3600
|
+
immutable?: boolean;
|
|
3601
|
+
/**
|
|
3602
|
+
* Whether the fields are required or not based on the condition. This
|
|
3603
|
+
* takes precedence over is_required in field_descriptor.
|
|
3604
|
+
*/
|
|
3605
|
+
require?: boolean;
|
|
3606
|
+
/** Whether the fields are shown or not based on the condition. */
|
|
3607
|
+
show?: boolean;
|
|
3608
|
+
}
|
|
3609
|
+
export type CustomSchemaFragmentType = string;
|
|
3610
|
+
/** custom-schema-fragments-get-request */
|
|
3611
|
+
export interface CustomSchemaFragmentsGetRequest {
|
|
3612
|
+
/**
|
|
3613
|
+
* The ID of the custom schema fragment.
|
|
3614
|
+
* @format id
|
|
3615
|
+
*/
|
|
3616
|
+
id: string;
|
|
3617
|
+
}
|
|
3618
|
+
/** custom-schema-fragments-get-response */
|
|
3619
|
+
export interface CustomSchemaFragmentsGetResponse {
|
|
3620
|
+
fragment: CustomSchemaFragment;
|
|
3621
|
+
}
|
|
3622
|
+
/** custom-schema-fragments-list-request */
|
|
3623
|
+
export interface CustomSchemaFragmentsListRequest {
|
|
3624
|
+
/** The list of app names. */
|
|
3625
|
+
app?: string[];
|
|
3626
|
+
/**
|
|
3627
|
+
* The cursor to resume iteration from. If not provided, then
|
|
3628
|
+
* iteration starts from the beginning.
|
|
3629
|
+
* @format text
|
|
3630
|
+
*/
|
|
3631
|
+
cursor?: string;
|
|
3632
|
+
/**
|
|
3633
|
+
* Whether only deprecated fragments should be filtered.
|
|
3634
|
+
* @deprecated
|
|
3635
|
+
*/
|
|
3636
|
+
deprecated?: boolean;
|
|
3637
|
+
/** Whether the leaf type corresponds to a custom object */
|
|
3638
|
+
is_custom_leaf_type?: boolean;
|
|
3639
|
+
/** Whether the fragment has been deprecated. */
|
|
3640
|
+
is_deprecated?: boolean;
|
|
3641
|
+
/** The list of leaf types. */
|
|
3642
|
+
leaf_type?: string[];
|
|
3643
|
+
/**
|
|
3644
|
+
* The maximum number of items.
|
|
3645
|
+
* @format int32
|
|
3646
|
+
*/
|
|
3647
|
+
limit?: number;
|
|
3648
|
+
/**
|
|
3649
|
+
* The iteration mode to use. If "after", then entries after the provided
|
|
3650
|
+
* cursor will be returned, or if no cursor is provided, then from the
|
|
3651
|
+
* beginning. If "before", then entries before the provided cursor will be
|
|
3652
|
+
* returned, or if no cursor is provided, then from the end. Entries will
|
|
3653
|
+
* always be returned in the specified sort-by order.
|
|
3654
|
+
*/
|
|
3655
|
+
mode?: ListMode;
|
|
3656
|
+
/**
|
|
3657
|
+
* List of fields which are not required in the payload and can be
|
|
3658
|
+
* pruned away.
|
|
3659
|
+
*/
|
|
3660
|
+
prune?: CustomSchemaFragmentsListRequestPrune[];
|
|
3661
|
+
/** The list of fields to sort the items by and how to sort them. */
|
|
3662
|
+
sort_by?: string[];
|
|
3663
|
+
/** The list of subtypes. */
|
|
3664
|
+
subtype?: string[];
|
|
3665
|
+
/** Filters for custom schema fragment of the provided types. */
|
|
3666
|
+
types?: CustomSchemaFragmentType[];
|
|
3667
|
+
}
|
|
3668
|
+
export declare enum CustomSchemaFragmentsListRequestPrune {
|
|
3669
|
+
Fields = "fields"
|
|
3670
|
+
}
|
|
3671
|
+
/** custom-schema-fragments-list-response */
|
|
3672
|
+
export interface CustomSchemaFragmentsListResponse {
|
|
3673
|
+
/**
|
|
3674
|
+
* The cursor used to iterate subsequent results in accordance to the
|
|
3675
|
+
* sort order. If not set, then no later elements exist.
|
|
3676
|
+
* @format text
|
|
3677
|
+
*/
|
|
3678
|
+
next_cursor?: string;
|
|
3679
|
+
/**
|
|
3680
|
+
* The cursor used to iterate preceding results in accordance to the
|
|
3681
|
+
* sort order. If not set, then no prior elements exist.
|
|
3682
|
+
* @format text
|
|
3683
|
+
*/
|
|
3684
|
+
prev_cursor?: string;
|
|
3685
|
+
/** The custom schema fragments. */
|
|
3686
|
+
result: CustomSchemaFragment[];
|
|
3687
|
+
}
|
|
3688
|
+
/** custom-schema-fragments-set-request */
|
|
3689
|
+
export type CustomSchemaFragmentsSetRequest = (CustomSchemaFragmentsSetRequestAppFragment | CustomSchemaFragmentsSetRequestCustomTypeFragment | CustomSchemaFragmentsSetRequestTenantFragment) & {
|
|
3690
|
+
type: CustomSchemaFragmentsSetRequestType;
|
|
3691
|
+
/** List of all composite schemas used in this fragment. */
|
|
3692
|
+
composite_schemas?: CustomSchemaFragmentsSetRequestCompositeSchema[];
|
|
3693
|
+
/** List of conditions for this fragment. */
|
|
3694
|
+
conditions?: CustomSchemaFragmentCondition[];
|
|
3695
|
+
/** List of field names which are being dropped. */
|
|
3696
|
+
deleted_fields?: string[];
|
|
3697
|
+
/**
|
|
3698
|
+
* Whether this fragment has been deprecated.
|
|
3699
|
+
* @deprecated
|
|
3700
|
+
*/
|
|
3701
|
+
deprecated?: boolean;
|
|
3702
|
+
/**
|
|
3703
|
+
* The description of the custom schema fragment.
|
|
3704
|
+
* @format text
|
|
3705
|
+
*/
|
|
3706
|
+
description: string;
|
|
3707
|
+
/** List of all fields in this fragment. */
|
|
3708
|
+
fields?: SchemaFieldDescriptor[];
|
|
3709
|
+
/** Whether the leaf type corresponds to a custom object */
|
|
3710
|
+
is_custom_leaf_type?: boolean;
|
|
3711
|
+
/** Whether this fragment has been deprecated. */
|
|
3712
|
+
is_deprecated?: boolean;
|
|
3713
|
+
/**
|
|
3714
|
+
* The leaf type this fragment applies to.
|
|
3715
|
+
* @format text
|
|
3716
|
+
*/
|
|
3717
|
+
leaf_type: string;
|
|
3718
|
+
};
|
|
3719
|
+
/** custom-schema-fragments-set-request-app-fragment */
|
|
3720
|
+
export interface CustomSchemaFragmentsSetRequestAppFragment {
|
|
3721
|
+
/**
|
|
3722
|
+
* The app this fragment applies to.
|
|
3723
|
+
* @format text
|
|
3724
|
+
*/
|
|
3725
|
+
app: string;
|
|
3726
|
+
/**
|
|
3727
|
+
* The display name of the app.
|
|
3728
|
+
* @format text
|
|
3729
|
+
*/
|
|
3730
|
+
app_display_name?: string;
|
|
3731
|
+
}
|
|
3732
|
+
/** custom-schema-fragments-set-request-composite-schema */
|
|
3733
|
+
export interface CustomSchemaFragmentsSetRequestCompositeSchema {
|
|
3734
|
+
/**
|
|
3735
|
+
* Description of this composite type.
|
|
3736
|
+
* @format text
|
|
3737
|
+
*/
|
|
3738
|
+
description?: string;
|
|
3739
|
+
/** List of fields in this composite type. */
|
|
3740
|
+
fields: SchemaFieldDescriptor[];
|
|
3741
|
+
/**
|
|
3742
|
+
* The name of this composite type.
|
|
3743
|
+
* @format text
|
|
3744
|
+
*/
|
|
3745
|
+
name?: string;
|
|
3746
|
+
}
|
|
3747
|
+
/** custom-schema-fragments-set-request-custom-type-fragment */
|
|
3748
|
+
export interface CustomSchemaFragmentsSetRequestCustomTypeFragment {
|
|
3749
|
+
/**
|
|
3750
|
+
* Path components used to display available custom types in tree
|
|
3751
|
+
* form.
|
|
3752
|
+
*/
|
|
3753
|
+
path?: CustomTypePathComponent[];
|
|
3754
|
+
/**
|
|
3755
|
+
* The ID of the associated custom stage diagram.
|
|
3756
|
+
* @format id
|
|
3757
|
+
*/
|
|
3758
|
+
stage_diagram?: string;
|
|
3759
|
+
/** List of Per-DevOrg stock field overrides. */
|
|
3760
|
+
stock_field_overrides?: StockFieldOverride[];
|
|
3761
|
+
/**
|
|
3762
|
+
* The string used to populate the subtype in the leaf type.
|
|
3763
|
+
* @format text
|
|
3764
|
+
*/
|
|
3765
|
+
subtype: string;
|
|
3766
|
+
/**
|
|
3767
|
+
* The display name of the subtype.
|
|
3768
|
+
* @format text
|
|
3769
|
+
*/
|
|
3770
|
+
subtype_display_name?: string;
|
|
3771
|
+
}
|
|
3772
|
+
/** custom-schema-fragments-set-request-tenant-fragment */
|
|
3773
|
+
export interface CustomSchemaFragmentsSetRequestTenantFragment {
|
|
3774
|
+
/**
|
|
3775
|
+
* The display ID prefix for the custom object.
|
|
3776
|
+
* @format text
|
|
3777
|
+
* @pattern ^[A-Z]{2,10}$
|
|
3778
|
+
*/
|
|
3779
|
+
id_prefix?: string;
|
|
3780
|
+
/** List of Per-DevOrg stock field overrides. */
|
|
3781
|
+
stock_field_overrides?: StockFieldOverride[];
|
|
3782
|
+
}
|
|
3783
|
+
export declare enum CustomSchemaFragmentsSetRequestType {
|
|
3784
|
+
AppFragment = "app_fragment",
|
|
3785
|
+
CustomTypeFragment = "custom_type_fragment",
|
|
3786
|
+
TenantFragment = "tenant_fragment"
|
|
3787
|
+
}
|
|
3788
|
+
/** custom-schema-fragments-set-response */
|
|
3789
|
+
export interface CustomSchemaFragmentsSetResponse {
|
|
3790
|
+
/**
|
|
3791
|
+
* The ID of the custom schema fragment.
|
|
3792
|
+
* @format id
|
|
3793
|
+
*/
|
|
3794
|
+
id: string;
|
|
3795
|
+
}
|
|
3796
|
+
/**
|
|
3797
|
+
* custom-schema-spec
|
|
3798
|
+
* Custom schemas described using identifiers. Each custom field in the
|
|
3799
|
+
* request must have the corresponding schema specified; omission results
|
|
3800
|
+
* in a Bad Request error. If a custom schema is not included in the
|
|
3801
|
+
* specifier, it remains unchanged. For surfaces with human interactors,
|
|
3802
|
+
* it is recommended to provide tenant_fragment: true and
|
|
3803
|
+
* validate_required_fields: true.
|
|
3804
|
+
*/
|
|
3805
|
+
export interface CustomSchemaSpec {
|
|
3806
|
+
/** List of apps. */
|
|
3807
|
+
apps?: string[];
|
|
3808
|
+
/**
|
|
3809
|
+
* Name of the subtype.
|
|
3810
|
+
* @format text
|
|
3811
|
+
*/
|
|
3812
|
+
subtype?: string;
|
|
3813
|
+
/** Whether the tenant schema is requested. */
|
|
3814
|
+
tenant_fragment?: boolean;
|
|
3815
|
+
/** Whether to enforce required fields validation. */
|
|
3816
|
+
validate_required_fields?: boolean;
|
|
3817
|
+
}
|
|
3818
|
+
/**
|
|
3819
|
+
* custom-schema-spec-for-read
|
|
3820
|
+
* Custom schemas described using identifiers
|
|
3821
|
+
*/
|
|
3822
|
+
export interface CustomSchemaSpecForRead {
|
|
3823
|
+
/** List of apps. */
|
|
3824
|
+
apps?: string[];
|
|
3825
|
+
/**
|
|
3826
|
+
* Name of the subtype.
|
|
3827
|
+
* @format text
|
|
3828
|
+
*/
|
|
3829
|
+
subtype?: string;
|
|
3830
|
+
}
|
|
3831
|
+
/** custom-stage */
|
|
3832
|
+
export type CustomStage = AtomBase & {
|
|
3833
|
+
/**
|
|
3834
|
+
* The human readable name of the stage.
|
|
3835
|
+
* @format text
|
|
3836
|
+
*/
|
|
3837
|
+
name?: string;
|
|
3838
|
+
/**
|
|
3839
|
+
* Position of the stage in the global stage ordering.
|
|
3840
|
+
* @format int32
|
|
3841
|
+
*/
|
|
3842
|
+
ordinal?: number;
|
|
3843
|
+
state?: CustomStateSummary;
|
|
3844
|
+
};
|
|
3845
|
+
/** custom-stage-summary */
|
|
3846
|
+
export type CustomStageSummary = AtomBaseSummary & {
|
|
3847
|
+
/**
|
|
3848
|
+
* The human readable name of the stage.
|
|
3849
|
+
* @format text
|
|
3850
|
+
*/
|
|
3851
|
+
name?: string;
|
|
3852
|
+
};
|
|
3853
|
+
/** custom-stages-create-request */
|
|
3854
|
+
export interface CustomStagesCreateRequest {
|
|
3855
|
+
/**
|
|
3856
|
+
* A reference to the marketplace item from which this stage was
|
|
3857
|
+
* imported.
|
|
3858
|
+
* @format id
|
|
3859
|
+
*/
|
|
3860
|
+
marketplace_ref?: string;
|
|
3861
|
+
/**
|
|
3862
|
+
* The name of the custom stage.
|
|
3863
|
+
* @format text
|
|
3864
|
+
*/
|
|
3865
|
+
name: string;
|
|
3866
|
+
/**
|
|
3867
|
+
* The ordinal of the custom stage used for ordering.
|
|
3868
|
+
* @format int32
|
|
3869
|
+
*/
|
|
3870
|
+
ordinal: number;
|
|
3871
|
+
/**
|
|
3872
|
+
* The state ID.
|
|
3873
|
+
* @format id
|
|
3874
|
+
*/
|
|
3875
|
+
state: string;
|
|
3876
|
+
}
|
|
3877
|
+
/** custom-stages-create-response */
|
|
3878
|
+
export interface CustomStagesCreateResponse {
|
|
3879
|
+
custom_stage: CustomStage;
|
|
3880
|
+
}
|
|
3881
|
+
/** custom-stages-get-request */
|
|
3882
|
+
export interface CustomStagesGetRequest {
|
|
3883
|
+
/**
|
|
3884
|
+
* The ID of the custom stage to get.
|
|
3885
|
+
* @format id
|
|
3886
|
+
*/
|
|
3887
|
+
id: string;
|
|
3888
|
+
}
|
|
3889
|
+
/** custom-stages-get-response */
|
|
3890
|
+
export interface CustomStagesGetResponse {
|
|
3891
|
+
custom_stage: CustomStage;
|
|
3892
|
+
}
|
|
3893
|
+
/** custom-stages-list-request */
|
|
3894
|
+
export interface CustomStagesListRequest {
|
|
3895
|
+
/**
|
|
3896
|
+
* The cursor to resume iteration from, otherwise if not provided,
|
|
3897
|
+
* then iteration starts from the beginning.
|
|
3898
|
+
* @format text
|
|
3899
|
+
*/
|
|
3900
|
+
cursor?: string;
|
|
3901
|
+
/**
|
|
3902
|
+
* The maximum number of items.
|
|
3903
|
+
* @format int32
|
|
3904
|
+
*/
|
|
3905
|
+
limit?: number;
|
|
3906
|
+
/** The list of stage names. */
|
|
3907
|
+
name?: string[];
|
|
3908
|
+
/** The list of stage ordinals. */
|
|
3909
|
+
ordinal?: number[];
|
|
3910
|
+
/** The list of fields to sort the items by and how to sort them. */
|
|
3911
|
+
sort_by?: string[];
|
|
3912
|
+
}
|
|
3913
|
+
/** custom-stages-list-response */
|
|
3914
|
+
export interface CustomStagesListResponse {
|
|
3915
|
+
/**
|
|
3916
|
+
* The cursor to resume iteration from, otherwise if not provided,
|
|
3917
|
+
* then iteration starts from the beginning.
|
|
3918
|
+
* @format text
|
|
3919
|
+
*/
|
|
3920
|
+
cursor?: string;
|
|
3921
|
+
/** The custom stages. */
|
|
3922
|
+
result: CustomStage[];
|
|
3923
|
+
}
|
|
3924
|
+
/** custom-stages-update-request */
|
|
3925
|
+
export interface CustomStagesUpdateRequest {
|
|
3926
|
+
/**
|
|
3927
|
+
* The ID of the custom stage to update.
|
|
3928
|
+
* @format id
|
|
3929
|
+
*/
|
|
3930
|
+
id: string;
|
|
3931
|
+
/**
|
|
3932
|
+
* The updated name of the custom stage.
|
|
3933
|
+
* @format text
|
|
3934
|
+
*/
|
|
3935
|
+
name?: string;
|
|
3936
|
+
/**
|
|
3937
|
+
* The ordinal of the custom stage.
|
|
3938
|
+
* @format int32
|
|
3939
|
+
*/
|
|
3940
|
+
ordinal?: number;
|
|
3941
|
+
/**
|
|
3942
|
+
* The state ID.
|
|
3943
|
+
* @format id
|
|
3944
|
+
*/
|
|
3945
|
+
state_id?: string;
|
|
3946
|
+
}
|
|
3947
|
+
/** custom-stages-update-response */
|
|
3948
|
+
export interface CustomStagesUpdateResponse {
|
|
3949
|
+
custom_stage: CustomStage;
|
|
3950
|
+
}
|
|
3951
|
+
/** custom-state */
|
|
3952
|
+
export type CustomState = AtomBase & {
|
|
3953
|
+
/** True if this is a final state. */
|
|
3954
|
+
is_final?: boolean;
|
|
3955
|
+
/**
|
|
3956
|
+
* The human readable name of the state.
|
|
3957
|
+
* @format text
|
|
3958
|
+
*/
|
|
3959
|
+
name?: string;
|
|
3960
|
+
/**
|
|
3961
|
+
* Position of the state in the global state ordering.
|
|
3962
|
+
* @format int32
|
|
3963
|
+
*/
|
|
3964
|
+
ordinal?: number;
|
|
3965
|
+
};
|
|
3966
|
+
/** custom-state-summary */
|
|
3967
|
+
export type CustomStateSummary = AtomBaseSummary & {
|
|
3968
|
+
/** True if this is a final state. */
|
|
3969
|
+
is_final?: boolean;
|
|
3970
|
+
/**
|
|
3971
|
+
* The human readable name of the state.
|
|
3972
|
+
* @format text
|
|
3973
|
+
*/
|
|
3974
|
+
name?: string;
|
|
3975
|
+
};
|
|
3976
|
+
/** custom-states-create-request */
|
|
3977
|
+
export interface CustomStatesCreateRequest {
|
|
3978
|
+
/** Whether this is a final state. */
|
|
3979
|
+
is_final?: boolean;
|
|
3980
|
+
/**
|
|
3981
|
+
* The name of the custom state.
|
|
3982
|
+
* @format text
|
|
3983
|
+
*/
|
|
3984
|
+
name: string;
|
|
3985
|
+
/**
|
|
3986
|
+
* Ordinal of the custom state used to identify system states.
|
|
3987
|
+
* @format int32
|
|
3988
|
+
*/
|
|
3989
|
+
ordinal: number;
|
|
3990
|
+
}
|
|
3991
|
+
/** custom-states-create-response */
|
|
3992
|
+
export interface CustomStatesCreateResponse {
|
|
3993
|
+
custom_state: CustomState;
|
|
3994
|
+
}
|
|
3995
|
+
/** custom-states-get-request */
|
|
3996
|
+
export interface CustomStatesGetRequest {
|
|
3997
|
+
/**
|
|
3998
|
+
* The ID of the custom state to get.
|
|
3999
|
+
* @format id
|
|
4000
|
+
*/
|
|
4001
|
+
id: string;
|
|
4002
|
+
}
|
|
4003
|
+
/** custom-states-get-response */
|
|
4004
|
+
export interface CustomStatesGetResponse {
|
|
4005
|
+
custom_state: CustomState;
|
|
4006
|
+
}
|
|
4007
|
+
/** custom-states-list-request */
|
|
4008
|
+
export interface CustomStatesListRequest {
|
|
4009
|
+
/**
|
|
4010
|
+
* The cursor to resume iteration from, otherwise if not provided,
|
|
4011
|
+
* then iteration starts from the beginning.
|
|
4012
|
+
* @format text
|
|
4013
|
+
*/
|
|
4014
|
+
cursor?: string;
|
|
4015
|
+
/** Whether only final states should be filtered. */
|
|
4016
|
+
is_final?: boolean;
|
|
4017
|
+
/**
|
|
4018
|
+
* The maximum number of items.
|
|
4019
|
+
* @format int32
|
|
4020
|
+
*/
|
|
4021
|
+
limit?: number;
|
|
4022
|
+
/** The list of state names. */
|
|
4023
|
+
name?: string[];
|
|
4024
|
+
/** The list of state ordinals. */
|
|
4025
|
+
ordinal?: number[];
|
|
4026
|
+
/** The list of fields to sort the items by and how to sort them. */
|
|
4027
|
+
sort_by?: string[];
|
|
4028
|
+
}
|
|
4029
|
+
/** custom-states-list-response */
|
|
4030
|
+
export interface CustomStatesListResponse {
|
|
4031
|
+
/**
|
|
4032
|
+
* The cursor to resume iteration from, otherwise if not provided,
|
|
4033
|
+
* then iteration starts from the beginning.
|
|
4034
|
+
* @format text
|
|
4035
|
+
*/
|
|
4036
|
+
cursor?: string;
|
|
4037
|
+
/** The custom states. */
|
|
4038
|
+
result: CustomState[];
|
|
4039
|
+
}
|
|
4040
|
+
/** custom-states-update-request */
|
|
4041
|
+
export interface CustomStatesUpdateRequest {
|
|
4042
|
+
/**
|
|
4043
|
+
* The ID of the custom state to update.
|
|
4044
|
+
* @format id
|
|
4045
|
+
*/
|
|
4046
|
+
id: string;
|
|
4047
|
+
/** Whether this is a final state. */
|
|
4048
|
+
is_final?: boolean;
|
|
4049
|
+
/**
|
|
4050
|
+
* The name of the custom state.
|
|
4051
|
+
* @format text
|
|
4052
|
+
*/
|
|
4053
|
+
name?: string;
|
|
4054
|
+
/**
|
|
4055
|
+
* Ordinal of the custom state used to identify system states.
|
|
4056
|
+
* @format int32
|
|
4057
|
+
*/
|
|
4058
|
+
ordinal?: number;
|
|
4059
|
+
}
|
|
4060
|
+
/** custom-states-update-response */
|
|
4061
|
+
export interface CustomStatesUpdateResponse {
|
|
4062
|
+
custom_state: CustomState;
|
|
4063
|
+
}
|
|
4064
|
+
/**
|
|
4065
|
+
* custom-type-path-component
|
|
4066
|
+
* Path component for rendering custom type lists in tree form.
|
|
4067
|
+
*/
|
|
4068
|
+
export type CustomTypePathComponent = object;
|
|
4069
|
+
/** dashboard */
|
|
4070
|
+
export type Dashboard = AtomBase;
|
|
4071
|
+
/**
|
|
4072
|
+
* date-filter
|
|
4073
|
+
* Provides ways to specify date ranges on objects.
|
|
4074
|
+
*/
|
|
4075
|
+
export type DateFilter = (DateTimeFilter | DateTimePreset) & {
|
|
4076
|
+
/** Type of date filter. */
|
|
4077
|
+
type: DateFilterType;
|
|
4078
|
+
};
|
|
4079
|
+
/** Type of date filter. */
|
|
4080
|
+
export declare enum DateFilterType {
|
|
4081
|
+
Preset = "preset",
|
|
4082
|
+
Range = "range"
|
|
4083
|
+
}
|
|
4084
|
+
/** date-time-filter */
|
|
4085
|
+
export interface DateTimeFilter {
|
|
4086
|
+
/**
|
|
4087
|
+
* Filters for objects created after the provided timestamp
|
|
4088
|
+
* (inclusive).
|
|
4089
|
+
* @format date-time
|
|
4090
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
4091
|
+
*/
|
|
4092
|
+
after?: string;
|
|
4093
|
+
/**
|
|
4094
|
+
* Filters for objects created before the provided timestamp
|
|
4095
|
+
* (inclusive).
|
|
4096
|
+
* @format date-time
|
|
4097
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
4098
|
+
*/
|
|
4099
|
+
before?: string;
|
|
4100
|
+
}
|
|
4101
|
+
/**
|
|
4102
|
+
* date-time-preset
|
|
4103
|
+
* Provides preset types for date filter.
|
|
4104
|
+
*/
|
|
4105
|
+
export type DateTimePreset = (DateTimePresetLastNDays | DateTimePresetNextNDays) & {
|
|
4106
|
+
/** Type of date preset. */
|
|
4107
|
+
preset_type: DateTimePresetType;
|
|
4108
|
+
};
|
|
4109
|
+
/** date-time-preset-last-n-days */
|
|
4110
|
+
export interface DateTimePresetLastNDays {
|
|
4111
|
+
/**
|
|
4112
|
+
* The range starts from the current timestamp and continues for the
|
|
4113
|
+
* past n days.
|
|
4114
|
+
* @min 0
|
|
4115
|
+
* @max 4294967295
|
|
4116
|
+
*/
|
|
4117
|
+
days: number;
|
|
4118
|
+
}
|
|
4119
|
+
/** date-time-preset-next-n-days */
|
|
4120
|
+
export interface DateTimePresetNextNDays {
|
|
4121
|
+
/**
|
|
4122
|
+
* The range starts from the current timestamp and continues for the
|
|
4123
|
+
* next n days.
|
|
4124
|
+
* @min 0
|
|
4125
|
+
* @max 4294967295
|
|
4126
|
+
*/
|
|
4127
|
+
days: number;
|
|
4128
|
+
}
|
|
4129
|
+
/** Type of date preset. */
|
|
4130
|
+
export declare enum DateTimePresetType {
|
|
4131
|
+
LastNDays = "last_n_days",
|
|
4132
|
+
NextNDays = "next_n_days"
|
|
4133
|
+
}
|
|
4134
|
+
/** Indicates whether this evaluation can change in the future. */
|
|
4135
|
+
export declare enum Definedness {
|
|
4136
|
+
Immutable = "immutable",
|
|
4137
|
+
Mutable = "mutable",
|
|
4138
|
+
Undefined = "undefined"
|
|
4139
|
+
}
|
|
4140
|
+
/** dev-org */
|
|
4141
|
+
export type DevOrg = OrgBase;
|
|
4142
|
+
/**
|
|
4143
|
+
* dev-org-auth-connections-create-request
|
|
4144
|
+
* Request to create a new enterprise authentication connection.
|
|
4145
|
+
*/
|
|
4146
|
+
export type DevOrgAuthConnectionsCreateRequest = (DevOrgAuthConnectionsCreateRequestAzureAdOptions | DevOrgAuthConnectionsCreateRequestGoogleAppsOptions | DevOrgAuthConnectionsCreateRequestOidcOptions | DevOrgAuthConnectionsCreateRequestOktaOptions | DevOrgAuthConnectionsCreateRequestSamlOptions) & {
|
|
4147
|
+
/**
|
|
4148
|
+
* Defines the type for the authentication connection. Different types of
|
|
4149
|
+
* authentication connections have different configuration parameters.
|
|
4150
|
+
*/
|
|
4151
|
+
type: DevOrgAuthConnectionsCreateRequestType;
|
|
4152
|
+
/**
|
|
4153
|
+
* Display name of the authentication connection. This name will be
|
|
4154
|
+
* visible to all the users when they sign in to this Dev
|
|
4155
|
+
* organization. For example, if the display_name is 'abclogin', then
|
|
4156
|
+
* it would appear on the login button as 'Log in to abclogin'.
|
|
4157
|
+
* @format text
|
|
4158
|
+
* @minLength 1
|
|
4159
|
+
* @maxLength 128
|
|
4160
|
+
*/
|
|
4161
|
+
display_name?: string;
|
|
4162
|
+
};
|
|
4163
|
+
/**
|
|
4164
|
+
* dev-org-auth-connections-create-request-azure-ad-options
|
|
4165
|
+
* Object encapsulating the configuration parameters for an Azure AD
|
|
4166
|
+
* authentication connection.
|
|
4167
|
+
* @deprecated
|
|
4168
|
+
*/
|
|
4169
|
+
export interface DevOrgAuthConnectionsCreateRequestAzureAdOptions {
|
|
4170
|
+
/**
|
|
4171
|
+
* Client ID for the Azure authentication connection.
|
|
4172
|
+
* @format text
|
|
4173
|
+
*/
|
|
4174
|
+
client_id: string;
|
|
4175
|
+
/**
|
|
4176
|
+
* Client secret for the Azure authentication connection.
|
|
4177
|
+
* @format text
|
|
4178
|
+
*/
|
|
4179
|
+
client_secret: string;
|
|
4180
|
+
/**
|
|
4181
|
+
* Domain URL of the Azure authentication connection.
|
|
4182
|
+
* @format text
|
|
4183
|
+
*/
|
|
4184
|
+
domain: string;
|
|
4185
|
+
}
|
|
4186
|
+
/**
|
|
4187
|
+
* dev-org-auth-connections-create-request-google-apps-options
|
|
4188
|
+
* Object encapsulating the configuration parameters for a Google Apps
|
|
4189
|
+
* authentication connection.
|
|
4190
|
+
* @deprecated
|
|
4191
|
+
*/
|
|
4192
|
+
export interface DevOrgAuthConnectionsCreateRequestGoogleAppsOptions {
|
|
4193
|
+
/**
|
|
4194
|
+
* Client ID for the Google Apps authentication connection.
|
|
4195
|
+
* @format text
|
|
4196
|
+
*/
|
|
4197
|
+
client_id: string;
|
|
4198
|
+
/**
|
|
4199
|
+
* Client secret for the Google Apps authentication connection.
|
|
4200
|
+
* @format text
|
|
4201
|
+
*/
|
|
4202
|
+
client_secret: string;
|
|
4203
|
+
/**
|
|
4204
|
+
* Tenant domain URL of the Google Apps authentication connection.
|
|
4205
|
+
* @format text
|
|
3331
4206
|
*/
|
|
3332
4207
|
tenant_domain: string;
|
|
3333
4208
|
}
|
|
@@ -3987,6 +4862,11 @@ export interface DevUsersSelfUpdateRequest {
|
|
|
3987
4862
|
job_history?: DevUsersUpdateJobHistoryItem[];
|
|
3988
4863
|
/** Job title of the Dev User. */
|
|
3989
4864
|
job_title?: DevUserJobTitle;
|
|
4865
|
+
/**
|
|
4866
|
+
* The ID of the Dev user that the user reports to.
|
|
4867
|
+
* @format id
|
|
4868
|
+
*/
|
|
4869
|
+
reports_to?: string;
|
|
3990
4870
|
}
|
|
3991
4871
|
/** dev-users-update-job-history-item */
|
|
3992
4872
|
export interface DevUsersUpdateJobHistoryItem {
|
|
@@ -4062,6 +4942,11 @@ export interface DevUsersUpdateRequest {
|
|
|
4062
4942
|
job_history?: DevUsersUpdateJobHistoryItem[];
|
|
4063
4943
|
/** Job title of the Dev User. */
|
|
4064
4944
|
job_title?: DevUserJobTitle;
|
|
4945
|
+
/**
|
|
4946
|
+
* The ID of the Dev user that the user reports to.
|
|
4947
|
+
* @format id
|
|
4948
|
+
*/
|
|
4949
|
+
reports_to?: string;
|
|
4065
4950
|
}
|
|
4066
4951
|
/**
|
|
4067
4952
|
* dev-users-update-response
|
|
@@ -4101,11 +4986,6 @@ export interface DirectoriesCreateRequest {
|
|
|
4101
4986
|
* @format text
|
|
4102
4987
|
*/
|
|
4103
4988
|
description?: string;
|
|
4104
|
-
/**
|
|
4105
|
-
* Icon for the directory.
|
|
4106
|
-
* @format text
|
|
4107
|
-
*/
|
|
4108
|
-
icon?: string;
|
|
4109
4989
|
/**
|
|
4110
4990
|
* Language of the directory.
|
|
4111
4991
|
* @format text
|
|
@@ -4333,7 +5213,7 @@ export type DynamicGroupInfo = object;
|
|
|
4333
5213
|
* Dynamic collection of DevRev objects, all adhering to a specific
|
|
4334
5214
|
* filter.
|
|
4335
5215
|
*/
|
|
4336
|
-
export type DynamicVista = VistaBase & {
|
|
5216
|
+
export type DynamicVista = VistaBase & DynamicVistaMeetingsVista & {
|
|
4337
5217
|
/** Type of DevRev object for which the vista is applicable. */
|
|
4338
5218
|
filter_type: DynamicVistaFilterType;
|
|
4339
5219
|
};
|
|
@@ -4354,6 +5234,16 @@ export declare enum DynamicVistaFilterType {
|
|
|
4354
5234
|
RevUsers = "rev_users",
|
|
4355
5235
|
Works = "works"
|
|
4356
5236
|
}
|
|
5237
|
+
/** dynamic-vista-meetings-vista */
|
|
5238
|
+
export interface DynamicVistaMeetingsVista {
|
|
5239
|
+
filter: MeetingsVistaFilter;
|
|
5240
|
+
/** Pinned items associated with the vista. */
|
|
5241
|
+
items?: DynamicVistaMeetingsVistaItemValue[];
|
|
5242
|
+
}
|
|
5243
|
+
/** dynamic-vista-meetings-vista-item-value */
|
|
5244
|
+
export interface DynamicVistaMeetingsVistaItemValue {
|
|
5245
|
+
item: MeetingSummary;
|
|
5246
|
+
}
|
|
4357
5247
|
/** empty */
|
|
4358
5248
|
export type Empty = object;
|
|
4359
5249
|
/** enhancement */
|
|
@@ -5009,6 +5899,25 @@ export interface EventAiAgentResponse {
|
|
|
5009
5899
|
/** A list of suggestions generated for the AI agent event. */
|
|
5010
5900
|
suggestions?: AiAgentEventSuggestions;
|
|
5011
5901
|
}
|
|
5902
|
+
/** event-article-created */
|
|
5903
|
+
export interface EventArticleCreated {
|
|
5904
|
+
article: Article;
|
|
5905
|
+
}
|
|
5906
|
+
/** event-article-deleted */
|
|
5907
|
+
export interface EventArticleDeleted {
|
|
5908
|
+
/**
|
|
5909
|
+
* The ID of the article that was deleted.
|
|
5910
|
+
* @format id
|
|
5911
|
+
* @example "ARTICLE-12345"
|
|
5912
|
+
*/
|
|
5913
|
+
id: string;
|
|
5914
|
+
old_article?: Article;
|
|
5915
|
+
}
|
|
5916
|
+
/** event-article-updated */
|
|
5917
|
+
export interface EventArticleUpdated {
|
|
5918
|
+
article: Article;
|
|
5919
|
+
old_article?: Article;
|
|
5920
|
+
}
|
|
5012
5921
|
/** event-conversation-created */
|
|
5013
5922
|
export interface EventConversationCreated {
|
|
5014
5923
|
conversation: Conversation;
|
|
@@ -5388,66 +6297,178 @@ export interface EventWorkCreated {
|
|
|
5388
6297
|
/** event-work-deleted */
|
|
5389
6298
|
export interface EventWorkDeleted {
|
|
5390
6299
|
/**
|
|
5391
|
-
* The ID of the work that was deleted.
|
|
5392
|
-
* @format id
|
|
5393
|
-
* @example "ISS-12345"
|
|
6300
|
+
* The ID of the work that was deleted.
|
|
6301
|
+
* @format id
|
|
6302
|
+
* @example "ISS-12345"
|
|
6303
|
+
*/
|
|
6304
|
+
id: string;
|
|
6305
|
+
old_work?: Work;
|
|
6306
|
+
}
|
|
6307
|
+
/** event-work-fetched */
|
|
6308
|
+
export type EventWorkFetched = (Empty | EventWorkFetchedOk) & {
|
|
6309
|
+
/**
|
|
6310
|
+
* The ID of the work that was fetched.
|
|
6311
|
+
* @format id
|
|
6312
|
+
* @example "ISS-12345"
|
|
6313
|
+
*/
|
|
6314
|
+
id: string;
|
|
6315
|
+
result: EventFetchedResult;
|
|
6316
|
+
};
|
|
6317
|
+
/** event-work-fetched-ok */
|
|
6318
|
+
export interface EventWorkFetchedOk {
|
|
6319
|
+
work?: Work;
|
|
6320
|
+
}
|
|
6321
|
+
/** event-work-updated */
|
|
6322
|
+
export interface EventWorkUpdated {
|
|
6323
|
+
old_work?: Work;
|
|
6324
|
+
work: Work;
|
|
6325
|
+
}
|
|
6326
|
+
/** external-communication-channel-summary */
|
|
6327
|
+
export type ExternalCommunicationChannelSummary = AtomBaseSummary;
|
|
6328
|
+
/**
|
|
6329
|
+
* external-identity
|
|
6330
|
+
* External identity of a user.
|
|
6331
|
+
*/
|
|
6332
|
+
export interface ExternalIdentity {
|
|
6333
|
+
/**
|
|
6334
|
+
* Display name of the user in the external source.
|
|
6335
|
+
* @format text
|
|
6336
|
+
*/
|
|
6337
|
+
display_name?: string;
|
|
6338
|
+
/**
|
|
6339
|
+
* Unique ID of the user in the external source.
|
|
6340
|
+
* @format text
|
|
6341
|
+
*/
|
|
6342
|
+
id?: string;
|
|
6343
|
+
/** Whether the external identity is verified or not. */
|
|
6344
|
+
is_verified?: boolean;
|
|
6345
|
+
/**
|
|
6346
|
+
* Issuer of the external identity of the user.
|
|
6347
|
+
* @format text
|
|
6348
|
+
*/
|
|
6349
|
+
issuer?: string;
|
|
6350
|
+
}
|
|
6351
|
+
/** feature */
|
|
6352
|
+
export type Feature = PartBase;
|
|
6353
|
+
/** feature-summary */
|
|
6354
|
+
export type FeatureSummary = PartBaseSummary;
|
|
6355
|
+
/**
|
|
6356
|
+
* field-descriptor
|
|
6357
|
+
* Set of field attributes.
|
|
6358
|
+
*/
|
|
6359
|
+
export interface FieldDescriptor {
|
|
6360
|
+
/** The default value for this field. */
|
|
6361
|
+
default_value?: object;
|
|
6362
|
+
/**
|
|
6363
|
+
* Description of the field.
|
|
6364
|
+
* @format text
|
|
6365
|
+
*/
|
|
6366
|
+
description?: string;
|
|
6367
|
+
/** Whether this field is filterable, groupable and sortable. */
|
|
6368
|
+
is_filterable?: boolean;
|
|
6369
|
+
/** Whether this field is immutable or not. */
|
|
6370
|
+
is_immutable?: boolean;
|
|
6371
|
+
/** Whether a stock unified enum can be extended with new values. */
|
|
6372
|
+
is_overridable?: boolean;
|
|
6373
|
+
/** Whether this field is required or not. */
|
|
6374
|
+
is_required?: boolean;
|
|
6375
|
+
/**
|
|
6376
|
+
* Whether this field can hold PII or sensitive information that
|
|
6377
|
+
* should not be logged.
|
|
6378
|
+
*/
|
|
6379
|
+
is_sensitive?: boolean;
|
|
6380
|
+
/** Whether this field is a system field or not. */
|
|
6381
|
+
is_system?: boolean;
|
|
6382
|
+
/**
|
|
6383
|
+
* Name of the field.
|
|
6384
|
+
* @format text
|
|
6385
|
+
*/
|
|
6386
|
+
name?: string;
|
|
6387
|
+
/** Allowed values for a unified enum. */
|
|
6388
|
+
uenum_values?: SchemaFieldUenumValue[];
|
|
6389
|
+
/** The schema of ui specific fields. */
|
|
6390
|
+
ui?: SchemaFieldUiMetadata;
|
|
6391
|
+
/** Validation annotations. */
|
|
6392
|
+
validation?: FieldValidation;
|
|
6393
|
+
}
|
|
6394
|
+
/**
|
|
6395
|
+
* field-validation
|
|
6396
|
+
* Validation annotations.
|
|
6397
|
+
*/
|
|
6398
|
+
export interface FieldValidation {
|
|
6399
|
+
/**
|
|
6400
|
+
* string contains.
|
|
6401
|
+
* @format text
|
|
6402
|
+
*/
|
|
6403
|
+
contains?: string;
|
|
6404
|
+
/** disables validations for this field. */
|
|
6405
|
+
disabled?: boolean;
|
|
6406
|
+
/**
|
|
6407
|
+
* exact array length.
|
|
6408
|
+
* @format int32
|
|
6409
|
+
*/
|
|
6410
|
+
eq_items?: number;
|
|
6411
|
+
/**
|
|
6412
|
+
* exact string length.
|
|
6413
|
+
* @format int32
|
|
6414
|
+
*/
|
|
6415
|
+
eq_len?: number;
|
|
6416
|
+
/**
|
|
6417
|
+
* int must be greater than this.
|
|
6418
|
+
* @format int32
|
|
6419
|
+
*/
|
|
6420
|
+
gt?: number;
|
|
6421
|
+
/**
|
|
6422
|
+
* int must be greater or equal than this.
|
|
6423
|
+
* @format int32
|
|
6424
|
+
*/
|
|
6425
|
+
gte?: number;
|
|
6426
|
+
/**
|
|
6427
|
+
* int must be less than this.
|
|
6428
|
+
* @format int32
|
|
6429
|
+
*/
|
|
6430
|
+
lt?: number;
|
|
6431
|
+
/**
|
|
6432
|
+
* int must be less or equal than this.
|
|
6433
|
+
* @format int32
|
|
6434
|
+
*/
|
|
6435
|
+
lte?: number;
|
|
6436
|
+
/**
|
|
6437
|
+
* maximum array length.
|
|
6438
|
+
* @format int32
|
|
6439
|
+
*/
|
|
6440
|
+
max_items?: number;
|
|
6441
|
+
/**
|
|
6442
|
+
* maximum string length.
|
|
6443
|
+
* @format int32
|
|
6444
|
+
*/
|
|
6445
|
+
max_len?: number;
|
|
6446
|
+
/**
|
|
6447
|
+
* minimum array length.
|
|
6448
|
+
* @format int32
|
|
5394
6449
|
*/
|
|
5395
|
-
|
|
5396
|
-
old_work?: Work;
|
|
5397
|
-
}
|
|
5398
|
-
/** event-work-fetched */
|
|
5399
|
-
export type EventWorkFetched = (Empty | EventWorkFetchedOk) & {
|
|
6450
|
+
min_items?: number;
|
|
5400
6451
|
/**
|
|
5401
|
-
*
|
|
5402
|
-
* @format
|
|
5403
|
-
* @example "ISS-12345"
|
|
6452
|
+
* minimum string length.
|
|
6453
|
+
* @format int32
|
|
5404
6454
|
*/
|
|
5405
|
-
|
|
5406
|
-
result: EventFetchedResult;
|
|
5407
|
-
};
|
|
5408
|
-
/** event-work-fetched-ok */
|
|
5409
|
-
export interface EventWorkFetchedOk {
|
|
5410
|
-
work?: Work;
|
|
5411
|
-
}
|
|
5412
|
-
/** event-work-updated */
|
|
5413
|
-
export interface EventWorkUpdated {
|
|
5414
|
-
old_work?: Work;
|
|
5415
|
-
work: Work;
|
|
5416
|
-
}
|
|
5417
|
-
/** external-communication-channel-summary */
|
|
5418
|
-
export type ExternalCommunicationChannelSummary = AtomBaseSummary;
|
|
5419
|
-
/**
|
|
5420
|
-
* external-identity
|
|
5421
|
-
* External identity of a user.
|
|
5422
|
-
*/
|
|
5423
|
-
export interface ExternalIdentity {
|
|
6455
|
+
min_len?: number;
|
|
5424
6456
|
/**
|
|
5425
|
-
*
|
|
6457
|
+
* string pattern (re).
|
|
5426
6458
|
* @format text
|
|
5427
6459
|
*/
|
|
5428
|
-
|
|
6460
|
+
pattern?: string;
|
|
5429
6461
|
/**
|
|
5430
|
-
*
|
|
6462
|
+
* string prefix.
|
|
5431
6463
|
* @format text
|
|
5432
6464
|
*/
|
|
5433
|
-
|
|
5434
|
-
/** Whether the external identity is verified or not. */
|
|
5435
|
-
is_verified?: boolean;
|
|
6465
|
+
prefix?: string;
|
|
5436
6466
|
/**
|
|
5437
|
-
*
|
|
6467
|
+
* string suffix.
|
|
5438
6468
|
* @format text
|
|
5439
6469
|
*/
|
|
5440
|
-
|
|
6470
|
+
suffix?: string;
|
|
5441
6471
|
}
|
|
5442
|
-
/** feature */
|
|
5443
|
-
export type Feature = PartBase;
|
|
5444
|
-
/** feature-summary */
|
|
5445
|
-
export type FeatureSummary = PartBaseSummary;
|
|
5446
|
-
/**
|
|
5447
|
-
* field-descriptor
|
|
5448
|
-
* Set of field attributes.
|
|
5449
|
-
*/
|
|
5450
|
-
export type FieldDescriptor = object;
|
|
5451
6472
|
/** group */
|
|
5452
6473
|
export type Group = AtomBase;
|
|
5453
6474
|
/** Creation source of the group. */
|
|
@@ -5846,6 +6867,11 @@ export interface InstantEvaluation {
|
|
|
5846
6867
|
export type Issue = WorkBase & {
|
|
5847
6868
|
/** Parts associated based on git events. */
|
|
5848
6869
|
developed_with?: PartSummary[];
|
|
6870
|
+
/**
|
|
6871
|
+
* Estimated effort to complete the issue.
|
|
6872
|
+
* @format double
|
|
6873
|
+
*/
|
|
6874
|
+
estimated_effort?: number;
|
|
5849
6875
|
/** Priority of the work based upon impact and criticality. */
|
|
5850
6876
|
priority?: IssuePriority;
|
|
5851
6877
|
/** The properties of an enum value. */
|
|
@@ -5979,10 +7005,11 @@ export type Link = AtomBase & {
|
|
|
5979
7005
|
target: LinkEndpointSummary;
|
|
5980
7006
|
};
|
|
5981
7007
|
/** link-endpoint-summary */
|
|
5982
|
-
export type LinkEndpointSummary = (CapabilitySummary | ConversationSummary | DevUserSummary | EnhancementSummary | FeatureSummary | IssueSummary | ProductSummary | RevOrgSummary | RevUserSummary | TicketSummary) & {
|
|
7008
|
+
export type LinkEndpointSummary = (ArticleSummary | CapabilitySummary | ConversationSummary | DevUserSummary | EnhancementSummary | FeatureSummary | IssueSummary | ProductSummary | RevOrgSummary | RevUserSummary | TicketSummary) & {
|
|
5983
7009
|
type: LinkEndpointType;
|
|
5984
7010
|
};
|
|
5985
7011
|
export declare enum LinkEndpointType {
|
|
7012
|
+
Article = "article",
|
|
5986
7013
|
Capability = "capability",
|
|
5987
7014
|
Conversation = "conversation",
|
|
5988
7015
|
DevUser = "dev_user",
|
|
@@ -6226,6 +7253,8 @@ export declare enum MeetingState {
|
|
|
6226
7253
|
Scheduled = "scheduled",
|
|
6227
7254
|
Waiting = "waiting"
|
|
6228
7255
|
}
|
|
7256
|
+
/** meeting-summary */
|
|
7257
|
+
export type MeetingSummary = AtomBaseSummary;
|
|
6229
7258
|
/** meetings-count-request */
|
|
6230
7259
|
export interface MeetingsCountRequest {
|
|
6231
7260
|
/** Filters for meeting on specified channels. */
|
|
@@ -6256,6 +7285,9 @@ export interface MeetingsCountRequest {
|
|
|
6256
7285
|
scheduled_date?: DateFilter;
|
|
6257
7286
|
/** Filters for meeting on specified state or outcomes. */
|
|
6258
7287
|
state?: MeetingState[];
|
|
7288
|
+
/** Subtypes of meeting to be filtered. */
|
|
7289
|
+
subtype?: string[];
|
|
7290
|
+
sync_metadata?: SyncMetadataFilter;
|
|
6259
7291
|
}
|
|
6260
7292
|
/** meetings-count-response */
|
|
6261
7293
|
export interface MeetingsCountResponse {
|
|
@@ -6442,6 +7474,9 @@ export interface MeetingsListRequest {
|
|
|
6442
7474
|
sort_by?: string[];
|
|
6443
7475
|
/** Filters for meeting on specified state or outcomes. */
|
|
6444
7476
|
state?: MeetingState[];
|
|
7477
|
+
/** Subtypes of meeting to be filtered. */
|
|
7478
|
+
subtype?: string[];
|
|
7479
|
+
sync_metadata?: SyncMetadataFilter;
|
|
6445
7480
|
}
|
|
6446
7481
|
/** meetings-list-response */
|
|
6447
7482
|
export interface MeetingsListResponse {
|
|
@@ -6557,6 +7592,47 @@ export interface MeetingsUpdateRequestTags {
|
|
|
6557
7592
|
export interface MeetingsUpdateResponse {
|
|
6558
7593
|
meeting: Meeting;
|
|
6559
7594
|
}
|
|
7595
|
+
/** meetings-vista-filter */
|
|
7596
|
+
export interface MeetingsVistaFilter {
|
|
7597
|
+
/** Filters for meeting on specified channels. */
|
|
7598
|
+
channel?: MeetingChannel[];
|
|
7599
|
+
/** Filters for meetings created by the specified user(s). */
|
|
7600
|
+
created_by?: string[];
|
|
7601
|
+
/** Provides ways to specify date ranges on objects. */
|
|
7602
|
+
created_date?: DateFilter;
|
|
7603
|
+
/** Provides ways to specify date ranges on objects. */
|
|
7604
|
+
ended_date?: DateFilter;
|
|
7605
|
+
/** Filters for meetings with the provided external_ref(s). */
|
|
7606
|
+
external_ref?: string[];
|
|
7607
|
+
/**
|
|
7608
|
+
* The field to group the collection by.
|
|
7609
|
+
* @format text
|
|
7610
|
+
*/
|
|
7611
|
+
group_by?: string;
|
|
7612
|
+
/** Filters for links associated with the meeting. */
|
|
7613
|
+
links?: MeetingsFilterLinkSummaryFilter[];
|
|
7614
|
+
/** Filter for meeting on specified Member Ids. */
|
|
7615
|
+
members?: string[];
|
|
7616
|
+
/** Provides ways to specify date ranges on objects. */
|
|
7617
|
+
modified_date?: DateFilter;
|
|
7618
|
+
/** Filter for meeting on specified organizers. */
|
|
7619
|
+
organizer?: string[];
|
|
7620
|
+
/**
|
|
7621
|
+
* Filters for meetings with the provided parent.
|
|
7622
|
+
* @deprecated
|
|
7623
|
+
* @example ["ACC-12345"]
|
|
7624
|
+
*/
|
|
7625
|
+
parent?: string[];
|
|
7626
|
+
/** Provides ways to specify date ranges on objects. */
|
|
7627
|
+
scheduled_date?: DateFilter;
|
|
7628
|
+
/** Comma-separated fields to sort the objects by. */
|
|
7629
|
+
sort_by?: string[];
|
|
7630
|
+
/** Filters for meeting on specified state or outcomes. */
|
|
7631
|
+
state?: MeetingState[];
|
|
7632
|
+
/** Subtypes of meeting to be filtered. */
|
|
7633
|
+
subtype?: string[];
|
|
7634
|
+
sync_metadata?: SyncMetadataFilter;
|
|
7635
|
+
}
|
|
6560
7636
|
/** member-summary */
|
|
6561
7637
|
export type MemberSummary = (DevUserSummary | GroupSummary | RevUserSummary | SysUserSummary) & {
|
|
6562
7638
|
type: MemberType;
|
|
@@ -7428,6 +8504,8 @@ export interface PartsListRequest {
|
|
|
7428
8504
|
owned_by?: string[];
|
|
7429
8505
|
/** The filter for specifying parent part. */
|
|
7430
8506
|
parent_part?: ParentPartFilter;
|
|
8507
|
+
/** Fields to sort the parts by and the direction to sort them. */
|
|
8508
|
+
sort_by?: string[];
|
|
7431
8509
|
/**
|
|
7432
8510
|
* Filters for part with any of the provided tags.
|
|
7433
8511
|
* @example ["TAG-12345"]
|
|
@@ -7672,6 +8750,19 @@ export interface Resource {
|
|
|
7672
8750
|
*/
|
|
7673
8751
|
url?: string;
|
|
7674
8752
|
}
|
|
8753
|
+
/**
|
|
8754
|
+
* resource-summary
|
|
8755
|
+
* Resource details.
|
|
8756
|
+
*/
|
|
8757
|
+
export interface ResourceSummary {
|
|
8758
|
+
/** Artifacts of the resource (relevant only for type artifact). */
|
|
8759
|
+
artifacts?: ArtifactSummary[];
|
|
8760
|
+
/**
|
|
8761
|
+
* URL of the resource (relevant only for type url).
|
|
8762
|
+
* @format text
|
|
8763
|
+
*/
|
|
8764
|
+
url?: string;
|
|
8765
|
+
}
|
|
7675
8766
|
/** rev-org */
|
|
7676
8767
|
export type RevOrg = OrgBase & {
|
|
7677
8768
|
/**
|
|
@@ -8440,12 +9531,85 @@ export type SchemaFieldOasisMetadata = object;
|
|
|
8440
9531
|
* schema-field-uenum-value
|
|
8441
9532
|
* A unified enum value.
|
|
8442
9533
|
*/
|
|
8443
|
-
export
|
|
9534
|
+
export interface SchemaFieldUenumValue {
|
|
9535
|
+
/**
|
|
9536
|
+
* The immutable id of the enum value.
|
|
9537
|
+
* @format int64
|
|
9538
|
+
*/
|
|
9539
|
+
id: number;
|
|
9540
|
+
/** True if this value is deprecated. */
|
|
9541
|
+
is_deprecated?: boolean;
|
|
9542
|
+
/**
|
|
9543
|
+
* The human readable name of the enum value.
|
|
9544
|
+
* @format text
|
|
9545
|
+
*/
|
|
9546
|
+
label: string;
|
|
9547
|
+
/**
|
|
9548
|
+
* The order value of the enum.
|
|
9549
|
+
* @format int64
|
|
9550
|
+
*/
|
|
9551
|
+
ordinal: number;
|
|
9552
|
+
/**
|
|
9553
|
+
* Tooltip shown in the UI for this value.
|
|
9554
|
+
* @format text
|
|
9555
|
+
*/
|
|
9556
|
+
tooltip?: string;
|
|
9557
|
+
}
|
|
8444
9558
|
/**
|
|
8445
9559
|
* schema-field-ui-metadata
|
|
8446
9560
|
* The schema of ui specific fields.
|
|
8447
9561
|
*/
|
|
8448
|
-
export
|
|
9562
|
+
export interface SchemaFieldUiMetadata {
|
|
9563
|
+
/** The client overrides for the field. */
|
|
9564
|
+
client_overrides?: ClientOverride[];
|
|
9565
|
+
/**
|
|
9566
|
+
* Number of decimal places to show (only applicable for number
|
|
9567
|
+
* fields).
|
|
9568
|
+
* @format int32
|
|
9569
|
+
*/
|
|
9570
|
+
decimal_places?: number;
|
|
9571
|
+
/**
|
|
9572
|
+
* The display name of the field.
|
|
9573
|
+
* @format text
|
|
9574
|
+
*/
|
|
9575
|
+
display_name?: string;
|
|
9576
|
+
/**
|
|
9577
|
+
* An optional group name for the field.
|
|
9578
|
+
* @format text
|
|
9579
|
+
*/
|
|
9580
|
+
group_name?: string;
|
|
9581
|
+
/** Whether the field is groupable in the UI. */
|
|
9582
|
+
is_groupable?: boolean;
|
|
9583
|
+
/** Whether the field is hidden in the UI. */
|
|
9584
|
+
is_hidden?: boolean;
|
|
9585
|
+
/** Whether the field is sortable in the UI. */
|
|
9586
|
+
is_sortable?: boolean;
|
|
9587
|
+
/**
|
|
9588
|
+
* Order in which field is shown.
|
|
9589
|
+
* @format int32
|
|
9590
|
+
*/
|
|
9591
|
+
order?: number;
|
|
9592
|
+
/**
|
|
9593
|
+
* A placeholder for the field.
|
|
9594
|
+
* @format text
|
|
9595
|
+
*/
|
|
9596
|
+
placeholder?: string;
|
|
9597
|
+
/**
|
|
9598
|
+
* Tooltip for the field.
|
|
9599
|
+
* @format text
|
|
9600
|
+
*/
|
|
9601
|
+
tooltip?: string;
|
|
9602
|
+
/**
|
|
9603
|
+
* Unit of measurment.
|
|
9604
|
+
* @format text
|
|
9605
|
+
*/
|
|
9606
|
+
unit?: string;
|
|
9607
|
+
/**
|
|
9608
|
+
* Whether to use shorthand notation (only applicable for number
|
|
9609
|
+
* fields).
|
|
9610
|
+
*/
|
|
9611
|
+
use_shorthand_notation?: boolean;
|
|
9612
|
+
}
|
|
8449
9613
|
/** schema-id-field-descriptor */
|
|
8450
9614
|
export type SchemaIdFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
8451
9615
|
/**
|
|
@@ -8817,6 +9981,71 @@ export type SchemaUenumListFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
|
8817
9981
|
};
|
|
8818
9982
|
/** schema-unknown-field-descriptor */
|
|
8819
9983
|
export type SchemaUnknownFieldDescriptor = SchemaFieldDescriptorBase;
|
|
9984
|
+
/** schemas-subtype-prepare-update-get-request */
|
|
9985
|
+
export interface SchemasSubtypePrepareUpdateGetRequest {
|
|
9986
|
+
/** Whether the leaf type corresponds to a custom object. */
|
|
9987
|
+
is_custom_leaf_type?: boolean;
|
|
9988
|
+
/**
|
|
9989
|
+
* Leaf type of the object.
|
|
9990
|
+
* @format text
|
|
9991
|
+
*/
|
|
9992
|
+
leaf_type: string;
|
|
9993
|
+
/**
|
|
9994
|
+
* Name of the new subtype for the object.
|
|
9995
|
+
* @format text
|
|
9996
|
+
*/
|
|
9997
|
+
new_subtype?: string;
|
|
9998
|
+
/**
|
|
9999
|
+
* ID of the object of which subtype is to be changed. Used to fetch
|
|
10000
|
+
* the object's custom schema fragments and custom fields
|
|
10001
|
+
* @format id
|
|
10002
|
+
*/
|
|
10003
|
+
object?: string;
|
|
10004
|
+
}
|
|
10005
|
+
/** schemas-subtype-prepare-update-get-response */
|
|
10006
|
+
export interface SchemasSubtypePrepareUpdateGetResponse {
|
|
10007
|
+
/** List of fields that have a default value and need to be set. */
|
|
10008
|
+
added_fields?: SchemasSubtypePrepareUpdateGetResponseAddedField[];
|
|
10009
|
+
/** List of fields that will be dropped from the object. */
|
|
10010
|
+
dropped_fields?: SchemasSubtypePrepareUpdateGetResponseDroppedField[];
|
|
10011
|
+
/** List of new custom schema fragment IDs of the object. */
|
|
10012
|
+
new_custom_schema_fragments?: string[];
|
|
10013
|
+
/**
|
|
10014
|
+
* ID of the start stage of the new diagram if the subtype change
|
|
10015
|
+
* results in a change in the stage diagram.
|
|
10016
|
+
* @format id
|
|
10017
|
+
*/
|
|
10018
|
+
new_start_stage?: string;
|
|
10019
|
+
}
|
|
10020
|
+
/** schemas-subtype-prepare-update-get-response-added-field */
|
|
10021
|
+
export interface SchemasSubtypePrepareUpdateGetResponseAddedField {
|
|
10022
|
+
/** Default value of the added field. */
|
|
10023
|
+
default_value?: any;
|
|
10024
|
+
/**
|
|
10025
|
+
* API-compliant qualified name of the added field.
|
|
10026
|
+
* @format text
|
|
10027
|
+
*/
|
|
10028
|
+
name: string;
|
|
10029
|
+
}
|
|
10030
|
+
export declare enum SchemasSubtypePrepareUpdateGetResponseConflictType {
|
|
10031
|
+
AbsentInNew = "absent_in_new",
|
|
10032
|
+
AbsentInOld = "absent_in_old",
|
|
10033
|
+
IncompatibleType = "incompatible_type"
|
|
10034
|
+
}
|
|
10035
|
+
/** schemas-subtype-prepare-update-get-response-dropped-field */
|
|
10036
|
+
export interface SchemasSubtypePrepareUpdateGetResponseDroppedField {
|
|
10037
|
+
conflict_type: SchemasSubtypePrepareUpdateGetResponseConflictType;
|
|
10038
|
+
/**
|
|
10039
|
+
* Conflict message for the field being dropped.
|
|
10040
|
+
* @format text
|
|
10041
|
+
*/
|
|
10042
|
+
message: string;
|
|
10043
|
+
/**
|
|
10044
|
+
* API-compliant qualified name of the dropped field.
|
|
10045
|
+
* @format text
|
|
10046
|
+
*/
|
|
10047
|
+
name: string;
|
|
10048
|
+
}
|
|
8820
10049
|
/** service-account */
|
|
8821
10050
|
export type ServiceAccount = UserBase;
|
|
8822
10051
|
/** service-account-summary */
|
|
@@ -9539,49 +10768,179 @@ export type SnapKitActionRequest = (SnapKitActionRequestButton | SnapKitActionRe
|
|
|
9539
10768
|
* @format date-time
|
|
9540
10769
|
* @example "2023-01-01T12:00:00.000Z"
|
|
9541
10770
|
*/
|
|
9542
|
-
timestamp: string;
|
|
9543
|
-
};
|
|
9544
|
-
/** snap-kit-action-request-button */
|
|
9545
|
-
export interface SnapKitActionRequestButton {
|
|
10771
|
+
timestamp: string;
|
|
10772
|
+
};
|
|
10773
|
+
/** snap-kit-action-request-button */
|
|
10774
|
+
export interface SnapKitActionRequestButton {
|
|
10775
|
+
/**
|
|
10776
|
+
* Value for the button interactive element.
|
|
10777
|
+
* @format text
|
|
10778
|
+
*/
|
|
10779
|
+
value: string;
|
|
10780
|
+
}
|
|
10781
|
+
export declare enum SnapKitActionRequestElementTypeValue {
|
|
10782
|
+
Button = "button",
|
|
10783
|
+
Form = "form"
|
|
10784
|
+
}
|
|
10785
|
+
/** snap-kit-action-request-form */
|
|
10786
|
+
export interface SnapKitActionRequestForm {
|
|
10787
|
+
/** Value for the form interactive element. */
|
|
10788
|
+
value: object;
|
|
10789
|
+
}
|
|
10790
|
+
/** snap-widget */
|
|
10791
|
+
export interface SnapWidget {
|
|
10792
|
+
type: SnapWidgetType;
|
|
10793
|
+
}
|
|
10794
|
+
export type SnapWidgetType = string;
|
|
10795
|
+
/** snap-widgets-create-request */
|
|
10796
|
+
export interface SnapWidgetsCreateRequest {
|
|
10797
|
+
type: SnapWidgetsCreateRequestType;
|
|
10798
|
+
/**
|
|
10799
|
+
* Sets the members that the snap widget is shared with.
|
|
10800
|
+
* @maxItems 8
|
|
10801
|
+
*/
|
|
10802
|
+
shared_with?: SetSharedWithMembership[];
|
|
10803
|
+
}
|
|
10804
|
+
export type SnapWidgetsCreateRequestType = string;
|
|
10805
|
+
/** snap-widgets-create-response */
|
|
10806
|
+
export interface SnapWidgetsCreateResponse {
|
|
10807
|
+
snap_widget: SnapWidget;
|
|
10808
|
+
}
|
|
10809
|
+
/**
|
|
10810
|
+
* stage
|
|
10811
|
+
* Describes the current stage of a object.
|
|
10812
|
+
*/
|
|
10813
|
+
export type Stage = object;
|
|
10814
|
+
/** stage-diagram */
|
|
10815
|
+
export type StageDiagram = AtomBase & {
|
|
10816
|
+
/** True if this stage diagram corresponds to a custom leaf type. */
|
|
10817
|
+
is_custom_leaf_type?: boolean;
|
|
10818
|
+
/** True if this stage diagram is the default for the leaf type. */
|
|
10819
|
+
is_default?: boolean;
|
|
10820
|
+
/**
|
|
10821
|
+
* The leaf type this stage diagram applies to.
|
|
10822
|
+
* @format text
|
|
10823
|
+
*/
|
|
10824
|
+
leaf_type?: string;
|
|
10825
|
+
/**
|
|
10826
|
+
* The human readable name of the stage diagram.
|
|
10827
|
+
* @format text
|
|
10828
|
+
*/
|
|
10829
|
+
name?: string;
|
|
10830
|
+
/**
|
|
10831
|
+
* List of stages with their allowed transitions in this stage
|
|
10832
|
+
* diagram.
|
|
10833
|
+
*/
|
|
10834
|
+
stages: StageNode[];
|
|
10835
|
+
};
|
|
10836
|
+
/** stage-diagram-summary */
|
|
10837
|
+
export type StageDiagramSummary = AtomBaseSummary & {
|
|
10838
|
+
/**
|
|
10839
|
+
* The human readable name of the stage diagram.
|
|
10840
|
+
* @format text
|
|
10841
|
+
*/
|
|
10842
|
+
name?: string;
|
|
10843
|
+
};
|
|
10844
|
+
/** stage-diagrams-create-request */
|
|
10845
|
+
export interface StageDiagramsCreateRequest {
|
|
10846
|
+
/** Whether the leaf type corresponds to a custom object. */
|
|
10847
|
+
is_custom_leaf_type?: boolean;
|
|
10848
|
+
/** Whether this is a default stage diagram. */
|
|
10849
|
+
is_default?: boolean;
|
|
10850
|
+
/**
|
|
10851
|
+
* The leaf type this stage diagram applies to.
|
|
10852
|
+
* @format text
|
|
10853
|
+
*/
|
|
10854
|
+
leaf_type: string;
|
|
10855
|
+
/**
|
|
10856
|
+
* The name of the stage diagram. Stage diagram is used for defining
|
|
10857
|
+
* stage transitions.
|
|
10858
|
+
* @format text
|
|
10859
|
+
*/
|
|
10860
|
+
name: string;
|
|
10861
|
+
/** List of stages in the diagram. */
|
|
10862
|
+
stages: CreateStageNode[];
|
|
10863
|
+
}
|
|
10864
|
+
/** stage-diagrams-create-response */
|
|
10865
|
+
export interface StageDiagramsCreateResponse {
|
|
10866
|
+
stage_diagram: StageDiagram;
|
|
10867
|
+
}
|
|
10868
|
+
/** stage-diagrams-get-request */
|
|
10869
|
+
export interface StageDiagramsGetRequest {
|
|
10870
|
+
/**
|
|
10871
|
+
* The ID of the stage diagram to get.
|
|
10872
|
+
* @format id
|
|
10873
|
+
*/
|
|
10874
|
+
id?: string;
|
|
10875
|
+
/**
|
|
10876
|
+
* Whether the leaf type corresponds to a custom object. Specify this
|
|
10877
|
+
* along with leaf_type to get the default custom object stage
|
|
10878
|
+
* diagram.
|
|
10879
|
+
*/
|
|
10880
|
+
is_custom_leaf_type?: boolean;
|
|
9546
10881
|
/**
|
|
9547
|
-
*
|
|
10882
|
+
* The leaf type. Should be specified to retrieve the default stage
|
|
10883
|
+
* diagram for the leaf type. If not provided, then id is used.
|
|
9548
10884
|
* @format text
|
|
9549
10885
|
*/
|
|
9550
|
-
|
|
10886
|
+
leaf_type?: string;
|
|
9551
10887
|
}
|
|
9552
|
-
|
|
9553
|
-
|
|
9554
|
-
|
|
10888
|
+
/** stage-diagrams-get-response */
|
|
10889
|
+
export interface StageDiagramsGetResponse {
|
|
10890
|
+
stage_diagram: StageDiagram;
|
|
9555
10891
|
}
|
|
9556
|
-
/**
|
|
9557
|
-
export interface
|
|
9558
|
-
/**
|
|
9559
|
-
|
|
10892
|
+
/** stage-diagrams-list-request */
|
|
10893
|
+
export interface StageDiagramsListRequest {
|
|
10894
|
+
/**
|
|
10895
|
+
* The cursor to resume iteration from, otherwise if not provided,
|
|
10896
|
+
* then iteration starts from the beginning.
|
|
10897
|
+
* @format text
|
|
10898
|
+
*/
|
|
10899
|
+
cursor?: string;
|
|
10900
|
+
/** Whether only custom object stage diagrams should be filtered. */
|
|
10901
|
+
is_custom_leaf_type?: boolean;
|
|
10902
|
+
/** The list of leaf types. */
|
|
10903
|
+
leaf_type?: string[];
|
|
10904
|
+
/**
|
|
10905
|
+
* The maximum number of items.
|
|
10906
|
+
* @format int32
|
|
10907
|
+
*/
|
|
10908
|
+
limit?: number;
|
|
10909
|
+
/** The list of stage diagram names. */
|
|
10910
|
+
name?: string[];
|
|
10911
|
+
/** The list of fields to sort the items by and how to sort them. */
|
|
10912
|
+
sort_by?: string[];
|
|
9560
10913
|
}
|
|
9561
|
-
/**
|
|
9562
|
-
export interface
|
|
9563
|
-
|
|
10914
|
+
/** stage-diagrams-list-response */
|
|
10915
|
+
export interface StageDiagramsListResponse {
|
|
10916
|
+
/**
|
|
10917
|
+
* The cursor to resume iteration from, otherwise if not provided,
|
|
10918
|
+
* then iteration starts from the beginning.
|
|
10919
|
+
* @format text
|
|
10920
|
+
*/
|
|
10921
|
+
cursor?: string;
|
|
10922
|
+
/** The stage diagram. */
|
|
10923
|
+
result: StageDiagram[];
|
|
9564
10924
|
}
|
|
9565
|
-
|
|
9566
|
-
|
|
9567
|
-
export interface SnapWidgetsCreateRequest {
|
|
9568
|
-
type: SnapWidgetsCreateRequestType;
|
|
10925
|
+
/** stage-diagrams-update-request */
|
|
10926
|
+
export interface StageDiagramsUpdateRequest {
|
|
9569
10927
|
/**
|
|
9570
|
-
*
|
|
9571
|
-
* @
|
|
10928
|
+
* The ID of the stage diagram to update.
|
|
10929
|
+
* @format id
|
|
9572
10930
|
*/
|
|
9573
|
-
|
|
10931
|
+
id: string;
|
|
10932
|
+
/**
|
|
10933
|
+
* The updated name of the stage diagram.
|
|
10934
|
+
* @format text
|
|
10935
|
+
*/
|
|
10936
|
+
name?: string;
|
|
10937
|
+
/** List of stages in the stage diagram. */
|
|
10938
|
+
stages?: UpdateStageNode[];
|
|
9574
10939
|
}
|
|
9575
|
-
|
|
9576
|
-
|
|
9577
|
-
|
|
9578
|
-
snap_widget: SnapWidget;
|
|
10940
|
+
/** stage-diagrams-update-response */
|
|
10941
|
+
export interface StageDiagramsUpdateResponse {
|
|
10942
|
+
stage_diagram: StageDiagram;
|
|
9579
10943
|
}
|
|
9580
|
-
/**
|
|
9581
|
-
* stage
|
|
9582
|
-
* Describes the current stage of a object.
|
|
9583
|
-
*/
|
|
9584
|
-
export type Stage = object;
|
|
9585
10944
|
/**
|
|
9586
10945
|
* stage-filter
|
|
9587
10946
|
* The filter for stages.
|
|
@@ -9601,6 +10960,26 @@ export interface StageInit {
|
|
|
9601
10960
|
*/
|
|
9602
10961
|
name?: string;
|
|
9603
10962
|
}
|
|
10963
|
+
/**
|
|
10964
|
+
* stage-node
|
|
10965
|
+
* Diagram stage.
|
|
10966
|
+
*/
|
|
10967
|
+
export interface StageNode {
|
|
10968
|
+
/** True if this stage has been deprecated. */
|
|
10969
|
+
is_deprecated?: boolean;
|
|
10970
|
+
/** True if this stage is the starting stage of the stage diagram. */
|
|
10971
|
+
is_start?: boolean;
|
|
10972
|
+
stage?: CustomStageSummary;
|
|
10973
|
+
/** List of allowed transitions from this stage. */
|
|
10974
|
+
transitions?: StageTransition[];
|
|
10975
|
+
}
|
|
10976
|
+
/**
|
|
10977
|
+
* stage-transition
|
|
10978
|
+
* Stage transition.
|
|
10979
|
+
*/
|
|
10980
|
+
export interface StageTransition {
|
|
10981
|
+
target_stage?: CustomStageSummary;
|
|
10982
|
+
}
|
|
9604
10983
|
/**
|
|
9605
10984
|
* stage-update
|
|
9606
10985
|
* Updates an object's stage.
|
|
@@ -9625,6 +11004,114 @@ export interface StagedInfoFilter {
|
|
|
9625
11004
|
/** Filters for issues that are staged. */
|
|
9626
11005
|
is_staged?: boolean;
|
|
9627
11006
|
}
|
|
11007
|
+
/**
|
|
11008
|
+
* stock-field-override
|
|
11009
|
+
* A stock field override.
|
|
11010
|
+
*/
|
|
11011
|
+
export interface StockFieldOverride {
|
|
11012
|
+
/** Whether the field is required. */
|
|
11013
|
+
is_required?: boolean;
|
|
11014
|
+
/**
|
|
11015
|
+
* Name of the stock field to be overridden.
|
|
11016
|
+
* @format text
|
|
11017
|
+
*/
|
|
11018
|
+
name?: string;
|
|
11019
|
+
/** The schema of ui specific fields. */
|
|
11020
|
+
ui?: SchemaFieldUiMetadata;
|
|
11021
|
+
}
|
|
11022
|
+
/** stock-schema-fragment */
|
|
11023
|
+
export type StockSchemaFragment = AtomBase & {
|
|
11024
|
+
/** List of composite schemas. */
|
|
11025
|
+
composite_schemas: CompositeSchema[];
|
|
11026
|
+
/**
|
|
11027
|
+
* Description of the schema.
|
|
11028
|
+
* @format text
|
|
11029
|
+
*/
|
|
11030
|
+
description?: string;
|
|
11031
|
+
/** List of all fields in this schema. */
|
|
11032
|
+
fields: SchemaFieldDescriptor[];
|
|
11033
|
+
/**
|
|
11034
|
+
* Leaf type this fragment applies to.
|
|
11035
|
+
* @format text
|
|
11036
|
+
*/
|
|
11037
|
+
leaf_type?: string;
|
|
11038
|
+
new_fragment_ref?: AtomSummary;
|
|
11039
|
+
old_fragment_ref?: AtomSummary;
|
|
11040
|
+
};
|
|
11041
|
+
/** stock-schema-fragments-get-request */
|
|
11042
|
+
export interface StockSchemaFragmentsGetRequest {
|
|
11043
|
+
/**
|
|
11044
|
+
* The ID of the stock schema fragment.
|
|
11045
|
+
* @format id
|
|
11046
|
+
*/
|
|
11047
|
+
id?: string;
|
|
11048
|
+
/**
|
|
11049
|
+
* The leaf type this fragment applies to.
|
|
11050
|
+
* @format text
|
|
11051
|
+
*/
|
|
11052
|
+
leaf_type?: string;
|
|
11053
|
+
}
|
|
11054
|
+
/** stock-schema-fragments-get-response */
|
|
11055
|
+
export interface StockSchemaFragmentsGetResponse {
|
|
11056
|
+
fragment: StockSchemaFragment;
|
|
11057
|
+
}
|
|
11058
|
+
/** stock-schema-fragments-list-request */
|
|
11059
|
+
export interface StockSchemaFragmentsListRequest {
|
|
11060
|
+
/**
|
|
11061
|
+
* The cursor to resume iteration from. If not provided, then
|
|
11062
|
+
* iteration starts from the beginning.
|
|
11063
|
+
* @format text
|
|
11064
|
+
*/
|
|
11065
|
+
cursor?: string;
|
|
11066
|
+
filter_preset?: StockSchemaFragmentsListRequestFilterPreset;
|
|
11067
|
+
/** The list of leaf types. */
|
|
11068
|
+
leaf_type?: string[];
|
|
11069
|
+
/**
|
|
11070
|
+
* The maximum number of items.
|
|
11071
|
+
* @format int32
|
|
11072
|
+
*/
|
|
11073
|
+
limit?: number;
|
|
11074
|
+
/**
|
|
11075
|
+
* The iteration mode to use. If "after", then entries after the provided
|
|
11076
|
+
* cursor will be returned, or if no cursor is provided, then from the
|
|
11077
|
+
* beginning. If "before", then entries before the provided cursor will be
|
|
11078
|
+
* returned, or if no cursor is provided, then from the end. Entries will
|
|
11079
|
+
* always be returned in the specified sort-by order.
|
|
11080
|
+
*/
|
|
11081
|
+
mode?: ListMode;
|
|
11082
|
+
/**
|
|
11083
|
+
* List of fields which are not required in the payload and can be
|
|
11084
|
+
* pruned away.
|
|
11085
|
+
*/
|
|
11086
|
+
prune?: StockSchemaFragmentsListRequestPrune[];
|
|
11087
|
+
/** The list of fields to sort the items by and how to sort them. */
|
|
11088
|
+
sort_by?: string[];
|
|
11089
|
+
}
|
|
11090
|
+
export declare enum StockSchemaFragmentsListRequestFilterPreset {
|
|
11091
|
+
CustomizableTypesPreset = "customizable_types_preset",
|
|
11092
|
+
NoPreset = "no_preset"
|
|
11093
|
+
}
|
|
11094
|
+
export declare enum StockSchemaFragmentsListRequestPrune {
|
|
11095
|
+
CompositeSchemas = "composite_schemas",
|
|
11096
|
+
Fields = "fields"
|
|
11097
|
+
}
|
|
11098
|
+
/** stock-schema-fragments-list-response */
|
|
11099
|
+
export interface StockSchemaFragmentsListResponse {
|
|
11100
|
+
/**
|
|
11101
|
+
* The cursor used to iterate subsequent results in accordance to the
|
|
11102
|
+
* sort order. If not set, then no later elements exist.
|
|
11103
|
+
* @format text
|
|
11104
|
+
*/
|
|
11105
|
+
next_cursor?: string;
|
|
11106
|
+
/**
|
|
11107
|
+
* The cursor used to iterate preceding results in accordance to the
|
|
11108
|
+
* sort order. If not set, then no prior elements exist.
|
|
11109
|
+
* @format text
|
|
11110
|
+
*/
|
|
11111
|
+
prev_cursor?: string;
|
|
11112
|
+
/** The stock schema fragments. */
|
|
11113
|
+
result: StockSchemaFragment[];
|
|
11114
|
+
}
|
|
9628
11115
|
/** survey */
|
|
9629
11116
|
export type Survey = AtomBase & {
|
|
9630
11117
|
/**
|
|
@@ -10837,6 +12324,7 @@ export type TimelineEntryBase = AtomBase & {
|
|
|
10837
12324
|
export type TimelineEntryBaseSummary = AtomBaseSummary;
|
|
10838
12325
|
/** The type of object that the Timeline entry belongs to. */
|
|
10839
12326
|
export declare enum TimelineEntryObjectType {
|
|
12327
|
+
Article = "article",
|
|
10840
12328
|
Capability = "capability",
|
|
10841
12329
|
Conversation = "conversation",
|
|
10842
12330
|
Enhancement = "enhancement",
|
|
@@ -10929,6 +12417,34 @@ export interface UpdateCommandSurface {
|
|
|
10929
12417
|
/** Surfaces from where this command can be invoked. */
|
|
10930
12418
|
surface?: CommandSurfaceSurface;
|
|
10931
12419
|
}
|
|
12420
|
+
/** update-stage-node */
|
|
12421
|
+
export interface UpdateStageNode {
|
|
12422
|
+
/** Whether this stage is deprecated. */
|
|
12423
|
+
is_deprecated?: boolean;
|
|
12424
|
+
/** Whether this is the start stage. */
|
|
12425
|
+
is_start?: boolean;
|
|
12426
|
+
/**
|
|
12427
|
+
* The ID of the stage.
|
|
12428
|
+
* @format id
|
|
12429
|
+
*/
|
|
12430
|
+
stage_id: string;
|
|
12431
|
+
/** List of transitions from this stage. */
|
|
12432
|
+
transitions?: UpdateStageTransition[];
|
|
12433
|
+
}
|
|
12434
|
+
/** update-stage-transition */
|
|
12435
|
+
export interface UpdateStageTransition {
|
|
12436
|
+
/**
|
|
12437
|
+
* The ID of the target stage.
|
|
12438
|
+
* @format id
|
|
12439
|
+
*/
|
|
12440
|
+
target_stage_id: string;
|
|
12441
|
+
ui?: UpdateStageUiMetadata;
|
|
12442
|
+
}
|
|
12443
|
+
/** update-stage-ui-metadata */
|
|
12444
|
+
export interface UpdateStageUiMetadata {
|
|
12445
|
+
/** Whether the stage is hidden. */
|
|
12446
|
+
is_hidden?: boolean;
|
|
12447
|
+
}
|
|
10932
12448
|
/** user-base */
|
|
10933
12449
|
export type UserBase = AtomBase & {
|
|
10934
12450
|
/**
|
|
@@ -11004,6 +12520,52 @@ export declare enum UserType {
|
|
|
11004
12520
|
ServiceAccount = "service_account",
|
|
11005
12521
|
SysUser = "sys_user"
|
|
11006
12522
|
}
|
|
12523
|
+
/**
|
|
12524
|
+
* view-override
|
|
12525
|
+
* UI hint overrides for a view.
|
|
12526
|
+
*/
|
|
12527
|
+
export interface ViewOverride {
|
|
12528
|
+
/**
|
|
12529
|
+
* Number of decimal places to show. Only applicable for number
|
|
12530
|
+
* fields.
|
|
12531
|
+
* @format int32
|
|
12532
|
+
*/
|
|
12533
|
+
decimal_places?: number;
|
|
12534
|
+
/**
|
|
12535
|
+
* The display name of the field.
|
|
12536
|
+
* @format text
|
|
12537
|
+
*/
|
|
12538
|
+
display_name?: string;
|
|
12539
|
+
/** Whether the field is groupable in the UI. */
|
|
12540
|
+
is_groupable?: boolean;
|
|
12541
|
+
/** Whether the field is hidden in the UI. */
|
|
12542
|
+
is_hidden?: boolean;
|
|
12543
|
+
/**
|
|
12544
|
+
* Relative order in which the field is shown.
|
|
12545
|
+
* @format int32
|
|
12546
|
+
*/
|
|
12547
|
+
order?: number;
|
|
12548
|
+
/**
|
|
12549
|
+
* A placeholder for the field.
|
|
12550
|
+
* @format text
|
|
12551
|
+
*/
|
|
12552
|
+
placeholder?: string;
|
|
12553
|
+
/**
|
|
12554
|
+
* Tooltip for the field.
|
|
12555
|
+
* @format text
|
|
12556
|
+
*/
|
|
12557
|
+
tooltip?: string;
|
|
12558
|
+
/**
|
|
12559
|
+
* Whether to use shorthand notation. Example, 1K instead of 1000.
|
|
12560
|
+
* Only applicable for number fields.
|
|
12561
|
+
*/
|
|
12562
|
+
use_shorthand_notation?: boolean;
|
|
12563
|
+
/**
|
|
12564
|
+
* The name of the view.
|
|
12565
|
+
* @format text
|
|
12566
|
+
*/
|
|
12567
|
+
view_name?: string;
|
|
12568
|
+
}
|
|
11007
12569
|
/**
|
|
11008
12570
|
* vista
|
|
11009
12571
|
* Represents a collection of DevRev objects.
|
|
@@ -11217,6 +12779,14 @@ export interface VistasGroupsGetResponse {
|
|
|
11217
12779
|
export interface VistasGroupsListRequest {
|
|
11218
12780
|
/** Filters for vista group items of the specific type. */
|
|
11219
12781
|
type?: GroupItemType[];
|
|
12782
|
+
/**
|
|
12783
|
+
* Filters for vista group items which have one of the parts linked as
|
|
12784
|
+
* its ancestor part or primary part.
|
|
12785
|
+
* @example ["PROD-12345"]
|
|
12786
|
+
*/
|
|
12787
|
+
ancestor_part?: string[];
|
|
12788
|
+
/** The filter for applies to part. */
|
|
12789
|
+
applies_to_part?: AppliesToPartFilter;
|
|
11220
12790
|
/**
|
|
11221
12791
|
* Filter for vistas group item created by any of these users.
|
|
11222
12792
|
* @example ["DEVU-12345"]
|
|
@@ -11473,7 +13043,10 @@ export interface WebCrawlerJobsCreateRequest {
|
|
|
11473
13043
|
* @format text
|
|
11474
13044
|
*/
|
|
11475
13045
|
accept_regex?: string;
|
|
11476
|
-
/**
|
|
13046
|
+
/**
|
|
13047
|
+
* The list of regexes a URL must satisfy to be crawled.
|
|
13048
|
+
* @maxItems 100
|
|
13049
|
+
*/
|
|
11477
13050
|
accept_regexes?: string[];
|
|
11478
13051
|
/**
|
|
11479
13052
|
* The parts to which created webpage/articles during this crawler job
|
|
@@ -11518,13 +13091,23 @@ export interface WebCrawlerJobsCreateRequest {
|
|
|
11518
13091
|
* The list of regexes which if satisfied by a URL results in
|
|
11519
13092
|
* rejection of the URL. If a URL matches both accept and reject
|
|
11520
13093
|
* regexes, it is rejected.
|
|
13094
|
+
* @maxItems 100
|
|
11521
13095
|
*/
|
|
11522
13096
|
reject_regexes?: string[];
|
|
11523
|
-
/**
|
|
13097
|
+
/**
|
|
13098
|
+
* The list of sitemap index URLs to crawl.
|
|
13099
|
+
* @maxItems 2
|
|
13100
|
+
*/
|
|
11524
13101
|
sitemap_index_urls?: string[];
|
|
11525
|
-
/**
|
|
13102
|
+
/**
|
|
13103
|
+
* The list of sitemap URLs to crawl.
|
|
13104
|
+
* @maxItems 2
|
|
13105
|
+
*/
|
|
11526
13106
|
sitemap_urls?: string[];
|
|
11527
|
-
/**
|
|
13107
|
+
/**
|
|
13108
|
+
* The list of URLs to crawl.
|
|
13109
|
+
* @maxItems 50
|
|
13110
|
+
*/
|
|
11528
13111
|
urls?: string[];
|
|
11529
13112
|
/**
|
|
11530
13113
|
* User agent to use for crawling websites in this job.
|
|
@@ -11638,6 +13221,9 @@ export interface WebhookEventRequest {
|
|
|
11638
13221
|
account_deleted?: EventAccountDeleted;
|
|
11639
13222
|
account_updated?: EventAccountUpdated;
|
|
11640
13223
|
ai_agent_response?: EventAiAgentResponse;
|
|
13224
|
+
article_created?: EventArticleCreated;
|
|
13225
|
+
article_deleted?: EventArticleDeleted;
|
|
13226
|
+
article_updated?: EventArticleUpdated;
|
|
11641
13227
|
conversation_created?: EventConversationCreated;
|
|
11642
13228
|
conversation_deleted?: EventConversationDeleted;
|
|
11643
13229
|
conversation_updated?: EventConversationUpdated;
|
|
@@ -11736,6 +13322,9 @@ export declare enum WebhookEventType {
|
|
|
11736
13322
|
AccountDeleted = "account_deleted",
|
|
11737
13323
|
AccountUpdated = "account_updated",
|
|
11738
13324
|
AiAgentResponse = "ai_agent_response",
|
|
13325
|
+
ArticleCreated = "article_created",
|
|
13326
|
+
ArticleDeleted = "article_deleted",
|
|
13327
|
+
ArticleUpdated = "article_updated",
|
|
11739
13328
|
ConversationCreated = "conversation_created",
|
|
11740
13329
|
ConversationDeleted = "conversation_deleted",
|
|
11741
13330
|
ConversationUpdated = "conversation_updated",
|
|
@@ -13058,6 +14647,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
13058
14647
|
* @example ["DEVU-12345"]
|
|
13059
14648
|
*/
|
|
13060
14649
|
owned_by?: string[];
|
|
14650
|
+
/** Filters for articles with the provided parent directories. */
|
|
14651
|
+
parent?: string[];
|
|
13061
14652
|
/** Filter for the scope of the articles. */
|
|
13062
14653
|
scope?: number[];
|
|
13063
14654
|
/**
|
|
@@ -13790,6 +15381,138 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
13790
15381
|
* @secure
|
|
13791
15382
|
*/
|
|
13792
15383
|
conversationsUpdate: (data: ConversationsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<ConversationsUpdateResponse, any>>;
|
|
15384
|
+
/**
|
|
15385
|
+
* @description Counts custom objects.
|
|
15386
|
+
*
|
|
15387
|
+
* @tags customization
|
|
15388
|
+
* @name CustomObjectsCount
|
|
15389
|
+
* @summary Count Custom Objects
|
|
15390
|
+
* @request GET:/custom-objects.count
|
|
15391
|
+
* @secure
|
|
15392
|
+
*/
|
|
15393
|
+
customObjectsCount: (query: {
|
|
15394
|
+
/**
|
|
15395
|
+
* Leaf type to filter.
|
|
15396
|
+
* @format text
|
|
15397
|
+
*/
|
|
15398
|
+
leaf_type: string;
|
|
15399
|
+
/** List of filters to apply. */
|
|
15400
|
+
filters?: any[];
|
|
15401
|
+
}, params?: RequestParams) => Promise<AxiosResponse<CustomObjectsCountResponse, any>>;
|
|
15402
|
+
/**
|
|
15403
|
+
* @description Counts custom objects.
|
|
15404
|
+
*
|
|
15405
|
+
* @tags customization
|
|
15406
|
+
* @name CustomObjectsCountPost
|
|
15407
|
+
* @summary Count Custom Objects (POST)
|
|
15408
|
+
* @request POST:/custom-objects.count
|
|
15409
|
+
* @secure
|
|
15410
|
+
*/
|
|
15411
|
+
customObjectsCountPost: (data: CustomObjectsCountRequest, params?: RequestParams) => Promise<AxiosResponse<CustomObjectsCountResponse, any>>;
|
|
15412
|
+
/**
|
|
15413
|
+
* @description Creates a custom object.
|
|
15414
|
+
*
|
|
15415
|
+
* @tags customization
|
|
15416
|
+
* @name CustomObjectsCreate
|
|
15417
|
+
* @summary Create Custom Object
|
|
15418
|
+
* @request POST:/custom-objects.create
|
|
15419
|
+
* @secure
|
|
15420
|
+
*/
|
|
15421
|
+
customObjectsCreate: (data: CustomObjectsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<CustomObjectsCreateResponse, any>>;
|
|
15422
|
+
/**
|
|
15423
|
+
* @description Deletes a custom object.
|
|
15424
|
+
*
|
|
15425
|
+
* @tags customization
|
|
15426
|
+
* @name CustomObjectsDelete
|
|
15427
|
+
* @summary Delete Custom Object
|
|
15428
|
+
* @request POST:/custom-objects.delete
|
|
15429
|
+
* @secure
|
|
15430
|
+
*/
|
|
15431
|
+
customObjectsDelete: (data: CustomObjectsDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
|
|
15432
|
+
/**
|
|
15433
|
+
* @description Gets a custom object.
|
|
15434
|
+
*
|
|
15435
|
+
* @tags customization
|
|
15436
|
+
* @name CustomObjectsGet
|
|
15437
|
+
* @summary Get Custom Object
|
|
15438
|
+
* @request GET:/custom-objects.get
|
|
15439
|
+
* @secure
|
|
15440
|
+
*/
|
|
15441
|
+
customObjectsGet: (query?: {
|
|
15442
|
+
/**
|
|
15443
|
+
* The ID of the custom object to get.
|
|
15444
|
+
* @format id
|
|
15445
|
+
*/
|
|
15446
|
+
id?: string;
|
|
15447
|
+
}, params?: RequestParams) => Promise<AxiosResponse<CustomObjectsGetResponse, any>>;
|
|
15448
|
+
/**
|
|
15449
|
+
* @description Gets a custom object.
|
|
15450
|
+
*
|
|
15451
|
+
* @tags customization
|
|
15452
|
+
* @name CustomObjectsGetPost
|
|
15453
|
+
* @summary Get Custom Object (POST)
|
|
15454
|
+
* @request POST:/custom-objects.get
|
|
15455
|
+
* @secure
|
|
15456
|
+
*/
|
|
15457
|
+
customObjectsGetPost: (data: CustomObjectsGetRequest, params?: RequestParams) => Promise<AxiosResponse<CustomObjectsGetResponse, any>>;
|
|
15458
|
+
/**
|
|
15459
|
+
* @description Lists custom objects.
|
|
15460
|
+
*
|
|
15461
|
+
* @tags customization
|
|
15462
|
+
* @name CustomObjectsList
|
|
15463
|
+
* @summary List Custom Objects
|
|
15464
|
+
* @request GET:/custom-objects.list
|
|
15465
|
+
* @secure
|
|
15466
|
+
*/
|
|
15467
|
+
customObjectsList: (query: {
|
|
15468
|
+
/**
|
|
15469
|
+
* Leaf type to filter.
|
|
15470
|
+
* @format text
|
|
15471
|
+
*/
|
|
15472
|
+
leaf_type: string;
|
|
15473
|
+
/**
|
|
15474
|
+
* The cursor to resume iteration from. If not provided, then iteration
|
|
15475
|
+
* starts from the beginning.
|
|
15476
|
+
* @format text
|
|
15477
|
+
*/
|
|
15478
|
+
cursor?: string;
|
|
15479
|
+
/** List of filters to apply. */
|
|
15480
|
+
filter?: any[];
|
|
15481
|
+
/** List of filters to apply. */
|
|
15482
|
+
filters?: any[];
|
|
15483
|
+
/**
|
|
15484
|
+
* The maximum number of items.
|
|
15485
|
+
* @format int32
|
|
15486
|
+
*/
|
|
15487
|
+
limit?: number;
|
|
15488
|
+
/**
|
|
15489
|
+
* The iteration mode to use, otherwise if not set, then "after" is
|
|
15490
|
+
* used.
|
|
15491
|
+
*/
|
|
15492
|
+
mode?: ListMode;
|
|
15493
|
+
/** The list of fields to sort the items by and how to sort them. */
|
|
15494
|
+
sort_by?: string[];
|
|
15495
|
+
}, params?: RequestParams) => Promise<AxiosResponse<CustomObjectsListResponse, any>>;
|
|
15496
|
+
/**
|
|
15497
|
+
* @description Lists custom objects.
|
|
15498
|
+
*
|
|
15499
|
+
* @tags customization
|
|
15500
|
+
* @name CustomObjectsListPost
|
|
15501
|
+
* @summary List Custom Objects (POST)
|
|
15502
|
+
* @request POST:/custom-objects.list
|
|
15503
|
+
* @secure
|
|
15504
|
+
*/
|
|
15505
|
+
customObjectsListPost: (data: CustomObjectsListRequest, params?: RequestParams) => Promise<AxiosResponse<CustomObjectsListResponse, any>>;
|
|
15506
|
+
/**
|
|
15507
|
+
* @description Updates a custom object.
|
|
15508
|
+
*
|
|
15509
|
+
* @tags customization
|
|
15510
|
+
* @name CustomObjectsUpdate
|
|
15511
|
+
* @summary Update Custom Object
|
|
15512
|
+
* @request POST:/custom-objects.update
|
|
15513
|
+
* @secure
|
|
15514
|
+
*/
|
|
15515
|
+
customObjectsUpdate: (data: CustomObjectsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<CustomObjectsUpdateResponse, any>>;
|
|
13793
15516
|
/**
|
|
13794
15517
|
* @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.
|
|
13795
15518
|
*
|
|
@@ -14578,6 +16301,24 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
14578
16301
|
parent?: string[];
|
|
14579
16302
|
/** Filters for meeting on specified state or outcomes. */
|
|
14580
16303
|
state?: MeetingState[];
|
|
16304
|
+
/** Subtypes of meeting to be filtered. */
|
|
16305
|
+
subtype?: string[];
|
|
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[];
|
|
14581
16322
|
}, params?: RequestParams) => Promise<AxiosResponse<MeetingsCountResponse, any>>;
|
|
14582
16323
|
/**
|
|
14583
16324
|
* @description Counts the meeting records.
|
|
@@ -14696,6 +16437,24 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
14696
16437
|
sort_by?: string[];
|
|
14697
16438
|
/** Filters for meeting on specified state or outcomes. */
|
|
14698
16439
|
state?: MeetingState[];
|
|
16440
|
+
/** Subtypes of meeting to be filtered. */
|
|
16441
|
+
subtype?: string[];
|
|
16442
|
+
/** Filters for issues with this specific external reference. */
|
|
16443
|
+
'sync_metadata.external_reference'?: string[];
|
|
16444
|
+
/** Filters for works with selected sync statuses. */
|
|
16445
|
+
'sync_metadata.last_sync_in.status'?: SyncMetadataFilterSyncInFilterStatus[];
|
|
16446
|
+
/** Filters for works modified with selected sync history. */
|
|
16447
|
+
'sync_metadata.last_sync_in.sync_history'?: string[];
|
|
16448
|
+
/** Filters for works modified with selected sync units. */
|
|
16449
|
+
'sync_metadata.last_sync_in.sync_unit'?: string[];
|
|
16450
|
+
/** Filters for works with selected sync statuses. */
|
|
16451
|
+
'sync_metadata.last_sync_out.status'?: SyncMetadataFilterSyncOutFilterStatus[];
|
|
16452
|
+
/** Filters for works modified with selected sync history. */
|
|
16453
|
+
'sync_metadata.last_sync_out.sync_history'?: string[];
|
|
16454
|
+
/** Filters for works modified with selected sync units. */
|
|
16455
|
+
'sync_metadata.last_sync_out.sync_unit'?: string[];
|
|
16456
|
+
/** Filters for issues synced from this specific origin system. */
|
|
16457
|
+
'sync_metadata.origin_system'?: string[];
|
|
14699
16458
|
}, params?: RequestParams) => Promise<AxiosResponse<MeetingsListResponse, any>>;
|
|
14700
16459
|
/**
|
|
14701
16460
|
* @description Lists the meeting records.
|
|
@@ -15160,6 +16919,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
15160
16919
|
* @example ["PROD-12345"]
|
|
15161
16920
|
*/
|
|
15162
16921
|
'parent_part.parts'?: string[];
|
|
16922
|
+
/** Fields to sort the parts by and the direction to sort them. */
|
|
16923
|
+
sort_by?: string[];
|
|
15163
16924
|
/**
|
|
15164
16925
|
* Filters for part with any of the provided tags.
|
|
15165
16926
|
* @example ["TAG-12345"]
|
|
@@ -15604,6 +17365,238 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
15604
17365
|
* @secure
|
|
15605
17366
|
*/
|
|
15606
17367
|
revUsersUpdate: (data: RevUsersUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<RevUsersUpdateResponse, any>>;
|
|
17368
|
+
/**
|
|
17369
|
+
* @description Gets the aggregated schema.
|
|
17370
|
+
*
|
|
17371
|
+
* @tags customization
|
|
17372
|
+
* @name AggregatedSchemaGet
|
|
17373
|
+
* @summary Get Schemas Aggregated
|
|
17374
|
+
* @request GET:/schemas.aggregated.get
|
|
17375
|
+
* @secure
|
|
17376
|
+
*/
|
|
17377
|
+
aggregatedSchemaGet: (query?: {
|
|
17378
|
+
/** The custom schema fragment IDs which are to be aggregated. */
|
|
17379
|
+
custom_schema_fragments?: string[];
|
|
17380
|
+
/** List of apps. */
|
|
17381
|
+
'custom_schema_spec.apps'?: string[];
|
|
17382
|
+
/**
|
|
17383
|
+
* Name of the subtype.
|
|
17384
|
+
* @format text
|
|
17385
|
+
*/
|
|
17386
|
+
'custom_schema_spec.subtype'?: string;
|
|
17387
|
+
/** Whether the leaf type corresponds to a custom object. */
|
|
17388
|
+
is_custom_leaf_type?: boolean;
|
|
17389
|
+
/**
|
|
17390
|
+
* The leaf type. Used for inferring the default stage diagram and
|
|
17391
|
+
* tenant fragment ID.
|
|
17392
|
+
* @format text
|
|
17393
|
+
*/
|
|
17394
|
+
leaf_type?: string;
|
|
17395
|
+
/**
|
|
17396
|
+
* The stock schema fragment which is to be aggregated.
|
|
17397
|
+
* @format id
|
|
17398
|
+
*/
|
|
17399
|
+
stock_schema_fragment?: string;
|
|
17400
|
+
}, params?: RequestParams) => Promise<AxiosResponse<AggregatedSchemaGetResponse, any>>;
|
|
17401
|
+
/**
|
|
17402
|
+
* @description Gets the aggregated schema.
|
|
17403
|
+
*
|
|
17404
|
+
* @tags customization
|
|
17405
|
+
* @name AggregatedSchemaGetPost
|
|
17406
|
+
* @summary Get Schemas Aggregated (POST)
|
|
17407
|
+
* @request POST:/schemas.aggregated.get
|
|
17408
|
+
* @secure
|
|
17409
|
+
*/
|
|
17410
|
+
aggregatedSchemaGetPost: (data: AggregatedSchemaGetRequest, params?: RequestParams) => Promise<AxiosResponse<AggregatedSchemaGetResponse, any>>;
|
|
17411
|
+
/**
|
|
17412
|
+
* @description Gets a custom schema fragment.
|
|
17413
|
+
*
|
|
17414
|
+
* @tags customization
|
|
17415
|
+
* @name CustomSchemaFragmentsGet
|
|
17416
|
+
* @summary Get Schemas Custom
|
|
17417
|
+
* @request GET:/schemas.custom.get
|
|
17418
|
+
* @secure
|
|
17419
|
+
*/
|
|
17420
|
+
customSchemaFragmentsGet: (query: {
|
|
17421
|
+
/**
|
|
17422
|
+
* The ID of the custom schema fragment.
|
|
17423
|
+
* @format id
|
|
17424
|
+
*/
|
|
17425
|
+
id: string;
|
|
17426
|
+
}, params?: RequestParams) => Promise<AxiosResponse<CustomSchemaFragmentsGetResponse, any>>;
|
|
17427
|
+
/**
|
|
17428
|
+
* @description Gets a custom schema fragment.
|
|
17429
|
+
*
|
|
17430
|
+
* @tags customization
|
|
17431
|
+
* @name CustomSchemaFragmentsGetPost
|
|
17432
|
+
* @summary Get Schemas Custom (POST)
|
|
17433
|
+
* @request POST:/schemas.custom.get
|
|
17434
|
+
* @secure
|
|
17435
|
+
*/
|
|
17436
|
+
customSchemaFragmentsGetPost: (data: CustomSchemaFragmentsGetRequest, params?: RequestParams) => Promise<AxiosResponse<CustomSchemaFragmentsGetResponse, any>>;
|
|
17437
|
+
/**
|
|
17438
|
+
* @description Lists custom schema fragments.
|
|
17439
|
+
*
|
|
17440
|
+
* @tags customization
|
|
17441
|
+
* @name CustomSchemaFragmentsList
|
|
17442
|
+
* @summary List Schemas Custom
|
|
17443
|
+
* @request GET:/schemas.custom.list
|
|
17444
|
+
* @secure
|
|
17445
|
+
*/
|
|
17446
|
+
customSchemaFragmentsList: (query?: {
|
|
17447
|
+
/** The list of app names. */
|
|
17448
|
+
app?: string[];
|
|
17449
|
+
/**
|
|
17450
|
+
* The cursor to resume iteration from. If not provided, then iteration
|
|
17451
|
+
* starts from the beginning.
|
|
17452
|
+
* @format text
|
|
17453
|
+
*/
|
|
17454
|
+
cursor?: string;
|
|
17455
|
+
/**
|
|
17456
|
+
* Whether only deprecated fragments should be filtered.
|
|
17457
|
+
* @deprecated
|
|
17458
|
+
*/
|
|
17459
|
+
deprecated?: boolean;
|
|
17460
|
+
/** Whether the leaf type corresponds to a custom object */
|
|
17461
|
+
is_custom_leaf_type?: boolean;
|
|
17462
|
+
/** Whether the fragment has been deprecated. */
|
|
17463
|
+
is_deprecated?: boolean;
|
|
17464
|
+
/** The list of leaf types. */
|
|
17465
|
+
leaf_type?: string[];
|
|
17466
|
+
/**
|
|
17467
|
+
* The maximum number of items.
|
|
17468
|
+
* @format int32
|
|
17469
|
+
*/
|
|
17470
|
+
limit?: number;
|
|
17471
|
+
/**
|
|
17472
|
+
* The iteration mode to use, otherwise if not set, then "after" is
|
|
17473
|
+
* used.
|
|
17474
|
+
*/
|
|
17475
|
+
mode?: ListMode;
|
|
17476
|
+
/**
|
|
17477
|
+
* List of fields which are not required in the payload and can be
|
|
17478
|
+
* pruned away.
|
|
17479
|
+
*/
|
|
17480
|
+
prune?: CustomSchemaFragmentsListRequestPrune[];
|
|
17481
|
+
/** The list of fields to sort the items by and how to sort them. */
|
|
17482
|
+
sort_by?: string[];
|
|
17483
|
+
/** The list of subtypes. */
|
|
17484
|
+
subtype?: string[];
|
|
17485
|
+
/** Filters for custom schema fragment of the provided types. */
|
|
17486
|
+
types?: CustomSchemaFragmentType[];
|
|
17487
|
+
}, params?: RequestParams) => Promise<AxiosResponse<CustomSchemaFragmentsListResponse, any>>;
|
|
17488
|
+
/**
|
|
17489
|
+
* @description Lists custom schema fragments.
|
|
17490
|
+
*
|
|
17491
|
+
* @tags customization
|
|
17492
|
+
* @name CustomSchemaFragmentsListPost
|
|
17493
|
+
* @summary List Schemas Custom (POST)
|
|
17494
|
+
* @request POST:/schemas.custom.list
|
|
17495
|
+
* @secure
|
|
17496
|
+
*/
|
|
17497
|
+
customSchemaFragmentsListPost: (data: CustomSchemaFragmentsListRequest, params?: RequestParams) => Promise<AxiosResponse<CustomSchemaFragmentsListResponse, any>>;
|
|
17498
|
+
/**
|
|
17499
|
+
* @description Creates or updates a custom schema fragment.
|
|
17500
|
+
*
|
|
17501
|
+
* @tags customization
|
|
17502
|
+
* @name CustomSchemaFragmentsSet
|
|
17503
|
+
* @summary Set Schemas Custom
|
|
17504
|
+
* @request POST:/schemas.custom.set
|
|
17505
|
+
* @secure
|
|
17506
|
+
*/
|
|
17507
|
+
customSchemaFragmentsSet: (data: CustomSchemaFragmentsSetRequest, params?: RequestParams) => Promise<AxiosResponse<CustomSchemaFragmentsSetResponse, any>>;
|
|
17508
|
+
/**
|
|
17509
|
+
* @description Gets a stock schema fragment.
|
|
17510
|
+
*
|
|
17511
|
+
* @tags customization
|
|
17512
|
+
* @name StockSchemaFragmentsGet
|
|
17513
|
+
* @summary Get Schemas Stock
|
|
17514
|
+
* @request GET:/schemas.stock.get
|
|
17515
|
+
* @secure
|
|
17516
|
+
*/
|
|
17517
|
+
stockSchemaFragmentsGet: (query?: {
|
|
17518
|
+
/**
|
|
17519
|
+
* The ID of the stock schema fragment.
|
|
17520
|
+
* @format id
|
|
17521
|
+
*/
|
|
17522
|
+
id?: string;
|
|
17523
|
+
/**
|
|
17524
|
+
* The leaf type this fragment applies to.
|
|
17525
|
+
* @format text
|
|
17526
|
+
*/
|
|
17527
|
+
leaf_type?: string;
|
|
17528
|
+
}, params?: RequestParams) => Promise<AxiosResponse<StockSchemaFragmentsGetResponse, any>>;
|
|
17529
|
+
/**
|
|
17530
|
+
* @description Gets a stock schema fragment.
|
|
17531
|
+
*
|
|
17532
|
+
* @tags customization
|
|
17533
|
+
* @name StockSchemaFragmentsGetPost
|
|
17534
|
+
* @summary Get Schemas Stock (POST)
|
|
17535
|
+
* @request POST:/schemas.stock.get
|
|
17536
|
+
* @secure
|
|
17537
|
+
*/
|
|
17538
|
+
stockSchemaFragmentsGetPost: (data: StockSchemaFragmentsGetRequest, params?: RequestParams) => Promise<AxiosResponse<StockSchemaFragmentsGetResponse, any>>;
|
|
17539
|
+
/**
|
|
17540
|
+
* @description Lists stock schema fragments.
|
|
17541
|
+
*
|
|
17542
|
+
* @tags customization
|
|
17543
|
+
* @name StockSchemaFragmentsList
|
|
17544
|
+
* @summary List Schemas Stock
|
|
17545
|
+
* @request GET:/schemas.stock.list
|
|
17546
|
+
* @secure
|
|
17547
|
+
*/
|
|
17548
|
+
stockSchemaFragmentsList: (query?: {
|
|
17549
|
+
/**
|
|
17550
|
+
* The cursor to resume iteration from. If not provided, then iteration
|
|
17551
|
+
* starts from the beginning.
|
|
17552
|
+
* @format text
|
|
17553
|
+
*/
|
|
17554
|
+
cursor?: string;
|
|
17555
|
+
/**
|
|
17556
|
+
* Filter preset to specify whether to filter only customization enabled
|
|
17557
|
+
* leaf types.
|
|
17558
|
+
*/
|
|
17559
|
+
filter_preset?: StockSchemaFragmentsListRequestFilterPreset;
|
|
17560
|
+
/** The list of leaf types. */
|
|
17561
|
+
leaf_type?: string[];
|
|
17562
|
+
/**
|
|
17563
|
+
* The maximum number of items.
|
|
17564
|
+
* @format int32
|
|
17565
|
+
*/
|
|
17566
|
+
limit?: number;
|
|
17567
|
+
/**
|
|
17568
|
+
* The iteration mode to use, otherwise if not set, then "after" is
|
|
17569
|
+
* used.
|
|
17570
|
+
*/
|
|
17571
|
+
mode?: ListMode;
|
|
17572
|
+
/**
|
|
17573
|
+
* List of fields which are not required in the payload and can be
|
|
17574
|
+
* pruned away.
|
|
17575
|
+
*/
|
|
17576
|
+
prune?: StockSchemaFragmentsListRequestPrune[];
|
|
17577
|
+
/** The list of fields to sort the items by and how to sort them. */
|
|
17578
|
+
sort_by?: string[];
|
|
17579
|
+
}, params?: RequestParams) => Promise<AxiosResponse<StockSchemaFragmentsListResponse, any>>;
|
|
17580
|
+
/**
|
|
17581
|
+
* @description Lists stock schema fragments.
|
|
17582
|
+
*
|
|
17583
|
+
* @tags customization
|
|
17584
|
+
* @name StockSchemaFragmentsListPost
|
|
17585
|
+
* @summary List Schemas Stock (POST)
|
|
17586
|
+
* @request POST:/schemas.stock.list
|
|
17587
|
+
* @secure
|
|
17588
|
+
*/
|
|
17589
|
+
stockSchemaFragmentsListPost: (data: StockSchemaFragmentsListRequest, params?: RequestParams) => Promise<AxiosResponse<StockSchemaFragmentsListResponse, any>>;
|
|
17590
|
+
/**
|
|
17591
|
+
* @description Gets the new fragment IDs and fields resulting from changing a subtype.
|
|
17592
|
+
*
|
|
17593
|
+
* @tags customization
|
|
17594
|
+
* @name SchemasSubtypePrepareUpdateGet
|
|
17595
|
+
* @summary Prepare-Update Schemas Subtypes
|
|
17596
|
+
* @request POST:/schemas.subtypes.prepare-update
|
|
17597
|
+
* @secure
|
|
17598
|
+
*/
|
|
17599
|
+
schemasSubtypePrepareUpdateGet: (data: SchemasSubtypePrepareUpdateGetRequest, params?: RequestParams) => Promise<AxiosResponse<SchemasSubtypePrepareUpdateGetResponse, any>>;
|
|
15607
17600
|
/**
|
|
15608
17601
|
* @description Creates a service account.
|
|
15609
17602
|
*
|
|
@@ -15871,6 +17864,273 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
15871
17864
|
* @secure
|
|
15872
17865
|
*/
|
|
15873
17866
|
snapWidgetsCreate: (data: SnapWidgetsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<SnapWidgetsCreateResponse, any>>;
|
|
17867
|
+
/**
|
|
17868
|
+
* @description Creates a stage diagram.
|
|
17869
|
+
*
|
|
17870
|
+
* @tags customization
|
|
17871
|
+
* @name StageDiagramsCreate
|
|
17872
|
+
* @summary Create Stage Diagram
|
|
17873
|
+
* @request POST:/stage-diagrams.create
|
|
17874
|
+
* @secure
|
|
17875
|
+
*/
|
|
17876
|
+
stageDiagramsCreate: (data: StageDiagramsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<StageDiagramsCreateResponse, any>>;
|
|
17877
|
+
/**
|
|
17878
|
+
* @description Gets a stage diagram.
|
|
17879
|
+
*
|
|
17880
|
+
* @tags customization
|
|
17881
|
+
* @name StageDiagramsGet
|
|
17882
|
+
* @summary Get Stage Diagram
|
|
17883
|
+
* @request GET:/stage-diagrams.get
|
|
17884
|
+
* @secure
|
|
17885
|
+
*/
|
|
17886
|
+
stageDiagramsGet: (query?: {
|
|
17887
|
+
/**
|
|
17888
|
+
* The ID of the stage diagram to get.
|
|
17889
|
+
* @format id
|
|
17890
|
+
*/
|
|
17891
|
+
id?: string;
|
|
17892
|
+
/**
|
|
17893
|
+
* Whether the leaf type corresponds to a custom object. Specify this
|
|
17894
|
+
* along with leaf_type to get the default custom object stage diagram.
|
|
17895
|
+
*/
|
|
17896
|
+
is_custom_leaf_type?: boolean;
|
|
17897
|
+
/**
|
|
17898
|
+
* The leaf type. Should be specified to retrieve the default stage
|
|
17899
|
+
* diagram for the leaf type. If not provided, then id is used.
|
|
17900
|
+
* @format text
|
|
17901
|
+
*/
|
|
17902
|
+
leaf_type?: string;
|
|
17903
|
+
}, params?: RequestParams) => Promise<AxiosResponse<StageDiagramsGetResponse, any>>;
|
|
17904
|
+
/**
|
|
17905
|
+
* @description Gets a stage diagram.
|
|
17906
|
+
*
|
|
17907
|
+
* @tags customization
|
|
17908
|
+
* @name StageDiagramsGetPost
|
|
17909
|
+
* @summary Get Stage Diagram (POST)
|
|
17910
|
+
* @request POST:/stage-diagrams.get
|
|
17911
|
+
* @secure
|
|
17912
|
+
*/
|
|
17913
|
+
stageDiagramsGetPost: (data: StageDiagramsGetRequest, params?: RequestParams) => Promise<AxiosResponse<StageDiagramsGetResponse, any>>;
|
|
17914
|
+
/**
|
|
17915
|
+
* @description Lists stage diagrams.
|
|
17916
|
+
*
|
|
17917
|
+
* @tags customization
|
|
17918
|
+
* @name StageDiagramsList
|
|
17919
|
+
* @summary List Stage Diagrams
|
|
17920
|
+
* @request GET:/stage-diagrams.list
|
|
17921
|
+
* @secure
|
|
17922
|
+
*/
|
|
17923
|
+
stageDiagramsList: (query?: {
|
|
17924
|
+
/**
|
|
17925
|
+
* The cursor to resume iteration from, otherwise if not provided, then
|
|
17926
|
+
* iteration starts from the beginning.
|
|
17927
|
+
* @format text
|
|
17928
|
+
*/
|
|
17929
|
+
cursor?: string;
|
|
17930
|
+
/** Whether only custom object stage diagrams should be filtered. */
|
|
17931
|
+
is_custom_leaf_type?: boolean;
|
|
17932
|
+
/** The list of leaf types. */
|
|
17933
|
+
leaf_type?: string[];
|
|
17934
|
+
/**
|
|
17935
|
+
* The maximum number of items.
|
|
17936
|
+
* @format int32
|
|
17937
|
+
*/
|
|
17938
|
+
limit?: number;
|
|
17939
|
+
/** The list of stage diagram names. */
|
|
17940
|
+
name?: string[];
|
|
17941
|
+
/** The list of fields to sort the items by and how to sort them. */
|
|
17942
|
+
sort_by?: string[];
|
|
17943
|
+
}, params?: RequestParams) => Promise<AxiosResponse<StageDiagramsListResponse, any>>;
|
|
17944
|
+
/**
|
|
17945
|
+
* @description Lists stage diagrams.
|
|
17946
|
+
*
|
|
17947
|
+
* @tags customization
|
|
17948
|
+
* @name StageDiagramsListPost
|
|
17949
|
+
* @summary List Stage Diagrams (POST)
|
|
17950
|
+
* @request POST:/stage-diagrams.list
|
|
17951
|
+
* @secure
|
|
17952
|
+
*/
|
|
17953
|
+
stageDiagramsListPost: (data: StageDiagramsListRequest, params?: RequestParams) => Promise<AxiosResponse<StageDiagramsListResponse, any>>;
|
|
17954
|
+
/**
|
|
17955
|
+
* @description Updates a stage diagram.
|
|
17956
|
+
*
|
|
17957
|
+
* @tags customization
|
|
17958
|
+
* @name StageDiagramsUpdate
|
|
17959
|
+
* @summary Update Stage Diagram
|
|
17960
|
+
* @request POST:/stage-diagrams.update
|
|
17961
|
+
* @secure
|
|
17962
|
+
*/
|
|
17963
|
+
stageDiagramsUpdate: (data: StageDiagramsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<StageDiagramsUpdateResponse, any>>;
|
|
17964
|
+
/**
|
|
17965
|
+
* @description Creates a custom stage.
|
|
17966
|
+
*
|
|
17967
|
+
* @tags customization
|
|
17968
|
+
* @name CustomStagesCreate
|
|
17969
|
+
* @summary Create Stages Custom
|
|
17970
|
+
* @request POST:/stages.custom.create
|
|
17971
|
+
* @secure
|
|
17972
|
+
*/
|
|
17973
|
+
customStagesCreate: (data: CustomStagesCreateRequest, params?: RequestParams) => Promise<AxiosResponse<CustomStagesCreateResponse, any>>;
|
|
17974
|
+
/**
|
|
17975
|
+
* @description Gets a custom stage.
|
|
17976
|
+
*
|
|
17977
|
+
* @tags customization
|
|
17978
|
+
* @name CustomStagesGet
|
|
17979
|
+
* @summary Get Stages Custom
|
|
17980
|
+
* @request GET:/stages.custom.get
|
|
17981
|
+
* @secure
|
|
17982
|
+
*/
|
|
17983
|
+
customStagesGet: (query: {
|
|
17984
|
+
/**
|
|
17985
|
+
* The ID of the custom stage to get.
|
|
17986
|
+
* @format id
|
|
17987
|
+
*/
|
|
17988
|
+
id: string;
|
|
17989
|
+
}, params?: RequestParams) => Promise<AxiosResponse<CustomStagesGetResponse, any>>;
|
|
17990
|
+
/**
|
|
17991
|
+
* @description Gets a custom stage.
|
|
17992
|
+
*
|
|
17993
|
+
* @tags customization
|
|
17994
|
+
* @name CustomStagesGetPost
|
|
17995
|
+
* @summary Get Stages Custom (POST)
|
|
17996
|
+
* @request POST:/stages.custom.get
|
|
17997
|
+
* @secure
|
|
17998
|
+
*/
|
|
17999
|
+
customStagesGetPost: (data: CustomStagesGetRequest, params?: RequestParams) => Promise<AxiosResponse<CustomStagesGetResponse, any>>;
|
|
18000
|
+
/**
|
|
18001
|
+
* @description Lists custom stages.
|
|
18002
|
+
*
|
|
18003
|
+
* @tags customization
|
|
18004
|
+
* @name CustomStagesList
|
|
18005
|
+
* @summary List Stages Custom
|
|
18006
|
+
* @request GET:/stages.custom.list
|
|
18007
|
+
* @secure
|
|
18008
|
+
*/
|
|
18009
|
+
customStagesList: (query?: {
|
|
18010
|
+
/**
|
|
18011
|
+
* The cursor to resume iteration from, otherwise if not provided, then
|
|
18012
|
+
* iteration starts from the beginning.
|
|
18013
|
+
* @format text
|
|
18014
|
+
*/
|
|
18015
|
+
cursor?: string;
|
|
18016
|
+
/**
|
|
18017
|
+
* The maximum number of items.
|
|
18018
|
+
* @format int32
|
|
18019
|
+
*/
|
|
18020
|
+
limit?: number;
|
|
18021
|
+
/** The list of stage names. */
|
|
18022
|
+
name?: string[];
|
|
18023
|
+
/** The list of stage ordinals. */
|
|
18024
|
+
ordinal?: number[];
|
|
18025
|
+
/** The list of fields to sort the items by and how to sort them. */
|
|
18026
|
+
sort_by?: string[];
|
|
18027
|
+
}, params?: RequestParams) => Promise<AxiosResponse<CustomStagesListResponse, any>>;
|
|
18028
|
+
/**
|
|
18029
|
+
* @description Lists custom stages.
|
|
18030
|
+
*
|
|
18031
|
+
* @tags customization
|
|
18032
|
+
* @name CustomStagesListPost
|
|
18033
|
+
* @summary List Stages Custom (POST)
|
|
18034
|
+
* @request POST:/stages.custom.list
|
|
18035
|
+
* @secure
|
|
18036
|
+
*/
|
|
18037
|
+
customStagesListPost: (data: CustomStagesListRequest, params?: RequestParams) => Promise<AxiosResponse<CustomStagesListResponse, any>>;
|
|
18038
|
+
/**
|
|
18039
|
+
* @description Updates a custom stage.
|
|
18040
|
+
*
|
|
18041
|
+
* @tags customization
|
|
18042
|
+
* @name CustomStagesUpdate
|
|
18043
|
+
* @summary Update Stages Custom
|
|
18044
|
+
* @request POST:/stages.custom.update
|
|
18045
|
+
* @secure
|
|
18046
|
+
*/
|
|
18047
|
+
customStagesUpdate: (data: CustomStagesUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<CustomStagesUpdateResponse, any>>;
|
|
18048
|
+
/**
|
|
18049
|
+
* @description Creates a custom state.
|
|
18050
|
+
*
|
|
18051
|
+
* @tags customization
|
|
18052
|
+
* @name CustomStatesCreate
|
|
18053
|
+
* @summary Create States Custom
|
|
18054
|
+
* @request POST:/states.custom.create
|
|
18055
|
+
* @secure
|
|
18056
|
+
*/
|
|
18057
|
+
customStatesCreate: (data: CustomStatesCreateRequest, params?: RequestParams) => Promise<AxiosResponse<CustomStatesCreateResponse, any>>;
|
|
18058
|
+
/**
|
|
18059
|
+
* @description Gets a custom state.
|
|
18060
|
+
*
|
|
18061
|
+
* @tags customization
|
|
18062
|
+
* @name CustomStatesGet
|
|
18063
|
+
* @summary Get States Custom
|
|
18064
|
+
* @request GET:/states.custom.get
|
|
18065
|
+
* @secure
|
|
18066
|
+
*/
|
|
18067
|
+
customStatesGet: (query: {
|
|
18068
|
+
/**
|
|
18069
|
+
* The ID of the custom state to get.
|
|
18070
|
+
* @format id
|
|
18071
|
+
*/
|
|
18072
|
+
id: string;
|
|
18073
|
+
}, params?: RequestParams) => Promise<AxiosResponse<CustomStatesGetResponse, any>>;
|
|
18074
|
+
/**
|
|
18075
|
+
* @description Gets a custom state.
|
|
18076
|
+
*
|
|
18077
|
+
* @tags customization
|
|
18078
|
+
* @name CustomStatesGetPost
|
|
18079
|
+
* @summary Get States Custom (POST)
|
|
18080
|
+
* @request POST:/states.custom.get
|
|
18081
|
+
* @secure
|
|
18082
|
+
*/
|
|
18083
|
+
customStatesGetPost: (data: CustomStatesGetRequest, params?: RequestParams) => Promise<AxiosResponse<CustomStatesGetResponse, any>>;
|
|
18084
|
+
/**
|
|
18085
|
+
* @description Lists custom states.
|
|
18086
|
+
*
|
|
18087
|
+
* @tags customization
|
|
18088
|
+
* @name CustomStatesList
|
|
18089
|
+
* @summary List States Custom
|
|
18090
|
+
* @request GET:/states.custom.list
|
|
18091
|
+
* @secure
|
|
18092
|
+
*/
|
|
18093
|
+
customStatesList: (query?: {
|
|
18094
|
+
/**
|
|
18095
|
+
* The cursor to resume iteration from, otherwise if not provided, then
|
|
18096
|
+
* iteration starts from the beginning.
|
|
18097
|
+
* @format text
|
|
18098
|
+
*/
|
|
18099
|
+
cursor?: string;
|
|
18100
|
+
/** Whether only final states should be filtered. */
|
|
18101
|
+
is_final?: boolean;
|
|
18102
|
+
/**
|
|
18103
|
+
* The maximum number of items.
|
|
18104
|
+
* @format int32
|
|
18105
|
+
*/
|
|
18106
|
+
limit?: number;
|
|
18107
|
+
/** The list of state names. */
|
|
18108
|
+
name?: string[];
|
|
18109
|
+
/** The list of state ordinals. */
|
|
18110
|
+
ordinal?: number[];
|
|
18111
|
+
/** The list of fields to sort the items by and how to sort them. */
|
|
18112
|
+
sort_by?: string[];
|
|
18113
|
+
}, params?: RequestParams) => Promise<AxiosResponse<CustomStatesListResponse, any>>;
|
|
18114
|
+
/**
|
|
18115
|
+
* @description Lists custom states.
|
|
18116
|
+
*
|
|
18117
|
+
* @tags customization
|
|
18118
|
+
* @name CustomStatesListPost
|
|
18119
|
+
* @summary List States Custom (POST)
|
|
18120
|
+
* @request POST:/states.custom.list
|
|
18121
|
+
* @secure
|
|
18122
|
+
*/
|
|
18123
|
+
customStatesListPost: (data: CustomStatesListRequest, params?: RequestParams) => Promise<AxiosResponse<CustomStatesListResponse, any>>;
|
|
18124
|
+
/**
|
|
18125
|
+
* @description Updates a custom state.
|
|
18126
|
+
*
|
|
18127
|
+
* @tags customization
|
|
18128
|
+
* @name CustomStatesUpdate
|
|
18129
|
+
* @summary Update States Custom
|
|
18130
|
+
* @request POST:/states.custom.update
|
|
18131
|
+
* @secure
|
|
18132
|
+
*/
|
|
18133
|
+
customStatesUpdate: (data: CustomStatesUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<CustomStatesUpdateResponse, any>>;
|
|
15874
18134
|
/**
|
|
15875
18135
|
* @description Creates a schema for survey, which includes name and description of schema.
|
|
15876
18136
|
*
|
|
@@ -16406,6 +18666,23 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
16406
18666
|
* @secure
|
|
16407
18667
|
*/
|
|
16408
18668
|
vistasGroupsList: (query?: {
|
|
18669
|
+
/**
|
|
18670
|
+
* Filters for vista group items which have one of the parts linked as
|
|
18671
|
+
* its ancestor part or primary part.
|
|
18672
|
+
* @example ["PROD-12345"]
|
|
18673
|
+
*/
|
|
18674
|
+
ancestor_part?: string[];
|
|
18675
|
+
/**
|
|
18676
|
+
* Whether to include items belonging to children of any of the provided
|
|
18677
|
+
* parts.
|
|
18678
|
+
*/
|
|
18679
|
+
'applies_to_part.include_child_parts'?: boolean;
|
|
18680
|
+
/**
|
|
18681
|
+
* Part IDs to filter on. Required if any applies_to_part.* fields are
|
|
18682
|
+
* provided.
|
|
18683
|
+
* @example ["PROD-12345"]
|
|
18684
|
+
*/
|
|
18685
|
+
'applies_to_part.parts'?: string[];
|
|
16409
18686
|
/**
|
|
16410
18687
|
* Filter for vistas group item created by any of these users.
|
|
16411
18688
|
* @example ["DEVU-12345"]
|