@devrev/typescript-sdk 1.1.69 → 1.1.71

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.
@@ -1,3 +1,4 @@
1
+ type UtilRequiredKeys<T, K extends keyof T> = Omit<T, K> & Required<Pick<T, K>>;
1
2
  export declare enum AccessLevel {
2
3
  External = "external",
3
4
  Internal = "internal",
@@ -704,6 +705,18 @@ export interface AiAgentEventInputMessage {
704
705
  */
705
706
  message: string;
706
707
  }
708
+ /**
709
+ * ai-agent-event-message-context
710
+ * The context for the message to be sent to the client.
711
+ */
712
+ export interface AiAgentEventMessageContext {
713
+ /**
714
+ * The artifacts to be sent to the client.
715
+ * @maxItems 10
716
+ * @example ["ARTIFACT-12345"]
717
+ */
718
+ artifacts?: string[];
719
+ }
707
720
  /**
708
721
  * ai-agent-event-source-target
709
722
  * The source of the event to send notifications to, of asynchronous
@@ -734,6 +747,11 @@ export interface AiAgentEventsExecuteAsyncRequest {
734
747
  * @format id
735
748
  */
736
749
  agent: string;
750
+ /**
751
+ * The ID of the agent version that will be used for the execution.
752
+ * @format id
753
+ */
754
+ agent_version?: string;
737
755
  /**
738
756
  * The metadata to be sent to the client with the notifications of
739
757
  * execution progress.
@@ -748,6 +766,15 @@ export interface AiAgentEventsExecuteAsyncRequest {
748
766
  * execution progress.
749
767
  */
750
768
  event_source_target?: AiAgentEventSourceTarget;
769
+ /** The context for the message to be sent to the client. */
770
+ message_context?: AiAgentEventMessageContext;
771
+ /**
772
+ * The ID of the parent object for this agent session. Access to agent
773
+ * session will be determined by access to parent.
774
+ * @format id
775
+ * @example "OPP-12345"
776
+ */
777
+ parent?: string;
751
778
  /**
752
779
  * An identifier of a session with an AI agent.
753
780
  * @format text
@@ -968,6 +995,12 @@ export interface ArchetypeMetricTarget {
968
995
  */
969
996
  next_schedule_transition?: string;
970
997
  org_schedule?: OrgScheduleSummary;
998
+ /**
999
+ * The version of the org schedule at the time this tracker was
1000
+ * created.
1001
+ * @format int64
1002
+ */
1003
+ org_schedule_version?: number;
971
1004
  /**
972
1005
  * Time in minutes that remains on a paused metric.
973
1006
  * @format int32
@@ -1183,6 +1216,9 @@ export interface ArticlesCountRequest {
1183
1216
  scope?: number[];
1184
1217
  /** Filter for articles based on intended audience. */
1185
1218
  shared_with?: SharedWithMembershipFilter[];
1219
+ /** Filters for status of the articles. */
1220
+ status?: ArticleStatus[];
1221
+ sync_metadata?: SyncMetadataFilter;
1186
1222
  /**
1187
1223
  * Filters for article with any of the provided tags.
1188
1224
  * @example ["TAG-12345"]
@@ -1300,12 +1336,28 @@ export interface ArticlesCreateRequest {
1300
1336
  export interface ArticlesCreateRequestResource {
1301
1337
  /**
1302
1338
  * IDs of the artifacts.
1339
+ * @deprecated
1303
1340
  * @example ["ARTIFACT-12345"]
1304
1341
  */
1305
1342
  artifacts?: string[];
1343
+ /**
1344
+ * Attachment artifacts of the article. This should only be populated
1345
+ * if the content_artifact is in devrev/rt or drdfv2 format. The
1346
+ * attachment artifacts aren't persisted in the resource.artifacts
1347
+ * field of the article.
1348
+ * @maxItems 200
1349
+ * @example ["ARTIFACT-12345"]
1350
+ */
1351
+ attachments?: string[];
1352
+ /**
1353
+ * The artifact that contains the content of the article.
1354
+ * @format id
1355
+ * @example "ARTIFACT-12345"
1356
+ */
1357
+ content_artifact?: string;
1306
1358
  /**
1307
1359
  * List of content blocks used in the article.
1308
- * @example ["ARTICLE-12345"]
1360
+ * @example ["ART-12345"]
1309
1361
  */
1310
1362
  content_blocks?: string[];
1311
1363
  /**
@@ -1334,7 +1386,7 @@ export interface ArticlesDeleteRequest {
1334
1386
  /**
1335
1387
  * The ID of the article to delete.
1336
1388
  * @format id
1337
- * @example "ARTICLE-12345"
1389
+ * @example "ART-12345"
1338
1390
  */
1339
1391
  id: string;
1340
1392
  }
@@ -1348,9 +1400,16 @@ export interface ArticlesGetRequest {
1348
1400
  /**
1349
1401
  * The ID of the required article.
1350
1402
  * @format id
1351
- * @example "ARTICLE-12345"
1403
+ * @example "ART-12345"
1352
1404
  */
1353
1405
  id: string;
1406
+ /**
1407
+ * The parent article of the content block. The id field is expected
1408
+ * to contain the content block ID.
1409
+ * @format id
1410
+ * @example "ART-12345"
1411
+ */
1412
+ parent_article_id?: string;
1354
1413
  }
1355
1414
  /**
1356
1415
  * articles-get-response
@@ -1421,6 +1480,9 @@ export interface ArticlesListRequest {
1421
1480
  scope?: number[];
1422
1481
  /** Filter for articles based on intended audience. */
1423
1482
  shared_with?: SharedWithMembershipFilter[];
1483
+ /** Filters for status of the articles. */
1484
+ status?: ArticleStatus[];
1485
+ sync_metadata?: SyncMetadataFilter;
1424
1486
  /**
1425
1487
  * Filters for article with any of the provided tags.
1426
1488
  * @example ["TAG-12345"]
@@ -1461,12 +1523,21 @@ export interface ArticlesUpdateRequest {
1461
1523
  aliases?: ArticlesUpdateRequestAliases;
1462
1524
  applies_to_parts?: ArticlesUpdateRequestAppliesToParts;
1463
1525
  artifacts?: ArticlesUpdateRequestArtifacts;
1526
+ attachments?: ArticlesUpdateRequestAttachments;
1464
1527
  authored_by?: ArticlesUpdateRequestAuthoredBy;
1465
1528
  /**
1466
1529
  * The updated brand of the article.
1467
1530
  * @format id
1468
1531
  */
1469
1532
  brand?: string | null;
1533
+ /**
1534
+ * Updates the content artifact of the article. This should be used
1535
+ * with 'file' type of articles. Use versioning for devrev/rt and
1536
+ * drdfv2 format of articles.
1537
+ * @format id
1538
+ * @example "ARTIFACT-12345"
1539
+ */
1540
+ content_artifact?: string;
1470
1541
  content_blocks?: ArticlesUpdateRequestContentBlocks;
1471
1542
  /** Content format of the article. */
1472
1543
  content_format?: ArticleContentFormat;
@@ -1492,7 +1563,7 @@ export interface ArticlesUpdateRequest {
1492
1563
  /**
1493
1564
  * The article's ID.
1494
1565
  * @format id
1495
- * @example "ARTICLE-12345"
1566
+ * @example "ART-12345"
1496
1567
  */
1497
1568
  id: string;
1498
1569
  /**
@@ -1563,6 +1634,21 @@ export interface ArticlesUpdateRequestArtifacts {
1563
1634
  */
1564
1635
  set?: string[];
1565
1636
  }
1637
+ /** articles-update-request-attachments */
1638
+ export interface ArticlesUpdateRequestAttachments {
1639
+ /**
1640
+ * Adds the attachment artifacts to the article.
1641
+ * @maxItems 200
1642
+ * @example ["ARTIFACT-12345"]
1643
+ */
1644
+ add?: string[];
1645
+ /**
1646
+ * Sets the attachment artifacts of the article.
1647
+ * @maxItems 200
1648
+ * @example ["ARTIFACT-12345"]
1649
+ */
1650
+ set?: string[];
1651
+ }
1566
1652
  /** articles-update-request-authored-by */
1567
1653
  export interface ArticlesUpdateRequestAuthoredBy {
1568
1654
  /**
@@ -1575,7 +1661,7 @@ export interface ArticlesUpdateRequestAuthoredBy {
1575
1661
  export interface ArticlesUpdateRequestContentBlocks {
1576
1662
  /**
1577
1663
  * Updates IDs of the content blocks.
1578
- * @example ["ARTICLE-12345"]
1664
+ * @example ["ART-12345"]
1579
1665
  */
1580
1666
  set: string[];
1581
1667
  }
@@ -1601,13 +1687,13 @@ export interface ArticlesUpdateRequestReorder {
1601
1687
  /**
1602
1688
  * The article after which the reordered article is placed.
1603
1689
  * @format id
1604
- * @example "ARTICLE-12345"
1690
+ * @example "ART-12345"
1605
1691
  */
1606
1692
  after?: string;
1607
1693
  /**
1608
1694
  * The article before which the reordered article is placed.
1609
1695
  * @format id
1610
- * @example "ARTICLE-12345"
1696
+ * @example "ART-12345"
1611
1697
  */
1612
1698
  before?: string;
1613
1699
  }
@@ -1635,10 +1721,13 @@ export declare enum ArtifactConfigurationSet {
1635
1721
  ArticleMedia = "article_media",
1636
1722
  Default = "default",
1637
1723
  EmailMedia = "email_media",
1724
+ Favicon = "favicon",
1638
1725
  JobData = "job_data",
1639
1726
  MarketplaceListingIcon = "marketplace_listing_icon",
1640
1727
  MarketplaceMedia = "marketplace_media",
1728
+ ObjectExport = "object_export",
1641
1729
  OrgLogo = "org_logo",
1730
+ PlugCss = "plug_css",
1642
1731
  PlugSetting = "plug_setting",
1643
1732
  PlugSettingBannerCard = "plug_setting_banner_card",
1644
1733
  PortalCss = "portal_css",
@@ -1716,28 +1805,6 @@ export interface ArtifactVersion {
1716
1805
  */
1717
1806
  version: string;
1718
1807
  }
1719
- /**
1720
- * artifacts-download-request
1721
- * The request to download an artifact.
1722
- */
1723
- export interface ArtifactsDownloadRequest {
1724
- /**
1725
- * The ID of the artifact to be downloaded.
1726
- * @format id
1727
- * @example "ARTIFACT-12345"
1728
- */
1729
- id: string;
1730
- /**
1731
- * The access key for the artifact.
1732
- * @format text
1733
- */
1734
- key?: string;
1735
- /**
1736
- * The version of the artifact that needs to be downloaded.
1737
- * @format text
1738
- */
1739
- version?: string;
1740
- }
1741
1808
  /**
1742
1809
  * artifacts-get-request
1743
1810
  * The request to get an artifact's information.
@@ -1762,7 +1829,7 @@ export interface ArtifactsGetRequest {
1762
1829
  export interface ArtifactsGetResponse {
1763
1830
  artifact: Artifact;
1764
1831
  /** The version of the artifact. */
1765
- version: ArtifactVersion;
1832
+ version?: ArtifactVersion;
1766
1833
  }
1767
1834
  /**
1768
1835
  * artifacts-hard-delete-version-request
@@ -1843,6 +1910,11 @@ export interface ArtifactsLocateResponse {
1843
1910
  export interface ArtifactsPrepareRequest {
1844
1911
  /** Represents a set of configuration to be used with the artifacts object. */
1845
1912
  configuration_set?: ArtifactConfigurationSet;
1913
+ /**
1914
+ * The encoding of the file that's being uploaded.
1915
+ * @format text
1916
+ */
1917
+ file_encoding?: string;
1846
1918
  /**
1847
1919
  * The name of the file that's being uploaded.
1848
1920
  * @format text
@@ -2238,9 +2310,12 @@ export declare enum AuthTokenRequestedTokenType {
2238
2310
  UrnDevrevParamsOauthTokenTypeRat = "urn:devrev:params:oauth:token-type:rat",
2239
2311
  UrnDevrevParamsOauthTokenTypeRev = "urn:devrev:params:oauth:token-type:rev",
2240
2312
  UrnDevrevParamsOauthTokenTypeSession = "urn:devrev:params:oauth:token-type:session",
2313
+ UrnDevrevParamsOauthTokenTypeSessionDev = "urn:devrev:params:oauth:token-type:session:dev",
2241
2314
  UrnDevrevParamsOauthTokenTypeSessionDev0 = "urn:devrev:params:oauth:token-type:session:dev0",
2242
2315
  UrnDevrevParamsOauthTokenTypeSessionOnetime = "urn:devrev:params:oauth:token-type:session:onetime",
2316
+ UrnDevrevParamsOauthTokenTypeSessionRev = "urn:devrev:params:oauth:token-type:session:rev",
2243
2317
  UrnDevrevParamsOauthTokenTypeSessionRevActAs = "urn:devrev:params:oauth:token-type:session:rev:act-as",
2318
+ UrnDevrevParamsOauthTokenTypeSessionRevPublic = "urn:devrev:params:oauth:token-type:session:rev:public",
2244
2319
  UrnDevrevParamsOauthTokenTypeSuper = "urn:devrev:params:oauth:token-type:super",
2245
2320
  UrnDevrevParamsOauthTokenTypeSys = "urn:devrev:params:oauth:token-type:sys",
2246
2321
  UrnIetfParamsOauthTokenTypeJwt = "urn:ietf:params:oauth:token-type:jwt"
@@ -2316,6 +2391,13 @@ export interface AuthTokensCreateRequest {
2316
2391
  * @max 1825
2317
2392
  */
2318
2393
  expires_in?: number;
2394
+ /**
2395
+ * The expected validity lifetime of the token in number of minutes.
2396
+ * The value must be less than or equal to 1440 minutes (1 day).
2397
+ * @min 0
2398
+ * @max 1440
2399
+ */
2400
+ expires_in_mins?: number;
2319
2401
  /** Specifies the process of obtaining a token. */
2320
2402
  grant_type?: AuthTokenGrantType;
2321
2403
  /** The type of the requested token. */
@@ -3021,16 +3103,45 @@ export interface ChatCompletionsRequestMessage {
3021
3103
  * Text content of the message.
3022
3104
  * @format text
3023
3105
  */
3024
- content: string;
3106
+ content?: string;
3107
+ /** Used for image inputs. The role must be a user. */
3108
+ image_content?: ChatCompletionsRequestMessageImageContent[];
3025
3109
  /** The role of the entity that is creating the message. */
3026
3110
  role: ChatCompletionsRequestMessageRole;
3027
3111
  }
3112
+ /**
3113
+ * chat-completions-request-message-image-content
3114
+ * Content wrapper for image URLs.
3115
+ */
3116
+ export type ChatCompletionsRequestMessageImageContent = (ChatCompletionsRequestMessageText | ChatCompletionsRequestMessageUrl) & {
3117
+ content_part: ChatCompletionsRequestMessageImageContentContentPart;
3118
+ };
3119
+ export declare enum ChatCompletionsRequestMessageImageContentContentPart {
3120
+ Text = "text",
3121
+ Url = "url"
3122
+ }
3028
3123
  /** The role of the entity that is creating the message. */
3029
3124
  export declare enum ChatCompletionsRequestMessageRole {
3030
3125
  Assistant = "assistant",
3031
3126
  System = "system",
3032
3127
  User = "user"
3033
3128
  }
3129
+ /**
3130
+ * chat-completions-request-message-text
3131
+ * Text content part of a multimodal message.
3132
+ */
3133
+ export interface ChatCompletionsRequestMessageText {
3134
+ /** @format text */
3135
+ text: string;
3136
+ }
3137
+ /**
3138
+ * chat-completions-request-message-url
3139
+ * Image URL content part of a multimodal message.
3140
+ */
3141
+ export interface ChatCompletionsRequestMessageUrl {
3142
+ /** @format text */
3143
+ url: string;
3144
+ }
3034
3145
  /**
3035
3146
  * chat-completions-response
3036
3147
  * The response for the generated chat completion.
@@ -3086,8 +3197,8 @@ export interface ChatsCreateRequestDm {
3086
3197
  */
3087
3198
  records?: string[];
3088
3199
  /**
3089
- * The users to send direct messages to. The authenticated user must
3090
- * be included in this list.
3200
+ * The users or groups to send direct messages to. The authenticated
3201
+ * user must be included in this list.
3091
3202
  * @maxItems 16
3092
3203
  * @minItems 1
3093
3204
  * @example ["DEVU-12345"]
@@ -3111,8 +3222,8 @@ export type ChatsGetRequest = (ChatsGetRequestDm | Empty) & {
3111
3222
  /** chats-get-request-dm */
3112
3223
  export interface ChatsGetRequestDm {
3113
3224
  /**
3114
- * The users to send direct messages to. Note the authenticated user
3115
- * must be included in this list.
3225
+ * The users or groups to send direct messages to. Note the
3226
+ * authenticated user must be included in this list.
3116
3227
  * @maxItems 16
3117
3228
  * @minItems 1
3118
3229
  * @example ["DEVU-12345"]
@@ -3165,7 +3276,7 @@ export interface ChatsUpdateRequestDmRecords {
3165
3276
  /** chats-update-request-dm-users */
3166
3277
  export interface ChatsUpdateRequestDmUsers {
3167
3278
  /**
3168
- * The updated list of users to send direct messages to. The
3279
+ * The updated list of users or groups to send direct messages to.
3169
3280
  * authenticated user must be included in this list.
3170
3281
  * @maxItems 16
3171
3282
  * @minItems 1
@@ -3364,6 +3475,12 @@ export interface ClientOverride {
3364
3475
  * @format text
3365
3476
  */
3366
3477
  placeholder?: string;
3478
+ /**
3479
+ * Templatized search query to be used when rendering dropdown options
3480
+ * for id fields.
3481
+ * @format text
3482
+ */
3483
+ search_query?: string;
3367
3484
  /**
3368
3485
  * Tooltip for the field.
3369
3486
  * @format text
@@ -4145,6 +4262,7 @@ export declare enum ContentTemplateType {
4145
4262
  }
4146
4263
  /** conversation */
4147
4264
  export type Conversation = AtomBase & {
4265
+ account?: AccountSummary;
4148
4266
  /**
4149
4267
  * Timestamp when the conversation was actually completed.
4150
4268
  * @format date-time
@@ -4170,6 +4288,12 @@ export type Conversation = AtomBase & {
4170
4288
  group?: GroupSummary;
4171
4289
  /** Whether the object is frozen or not. */
4172
4290
  is_frozen?: boolean;
4291
+ /**
4292
+ * Timestamp of the last message in external discussion.
4293
+ * @format date-time
4294
+ * @example "2023-01-01T12:00:00.000Z"
4295
+ */
4296
+ last_external_message_date?: string;
4173
4297
  /** The users in the conversation. */
4174
4298
  members: UserSummary[];
4175
4299
  /** The latest messages on the conversation. */
@@ -4178,6 +4302,19 @@ export type Conversation = AtomBase & {
4178
4302
  metadata?: ConversationMetadata;
4179
4303
  /** Owner IDs for the conversation. */
4180
4304
  owned_by?: UserSummary[];
4305
+ /** The properties of an enum value. */
4306
+ sentiment?: EnumValue;
4307
+ /**
4308
+ * Timestamp when the sentiment was last modified.
4309
+ * @format date-time
4310
+ * @example "2023-01-01T12:00:00.000Z"
4311
+ */
4312
+ sentiment_modified_date?: string;
4313
+ /**
4314
+ * Summary justifying the sentiment.
4315
+ * @format text
4316
+ */
4317
+ sentiment_summary?: string;
4181
4318
  /** SLA summary for the object. */
4182
4319
  sla_summary?: ArchetypeSlaSummary;
4183
4320
  sla_tracker?: SlaTrackerSummary;
@@ -4247,6 +4384,12 @@ export type ConversationSummary = AtomBaseSummary & {
4247
4384
  */
4248
4385
  export interface ConversationsCreateRequest {
4249
4386
  type: ConversationsCreateRequestTypeValue;
4387
+ /**
4388
+ * The account associated with the conversation.
4389
+ * @format id
4390
+ * @example "ACC-12345"
4391
+ */
4392
+ account?: string;
4250
4393
  /**
4251
4394
  * The brand associated with the conversation.
4252
4395
  * @format id
@@ -4287,6 +4430,11 @@ export interface ConversationsCreateRequest {
4287
4430
  metadata?: ConversationsCreateRequestMetadata;
4288
4431
  /** The users that own the conversation. */
4289
4432
  owned_by?: string[];
4433
+ /**
4434
+ * The ID of the AI agent that owns the conversation.
4435
+ * @format id
4436
+ */
4437
+ owned_by_agent?: string;
4290
4438
  /**
4291
4439
  * Whether the conversation is from a source channel.
4292
4440
  * @format text
@@ -4353,6 +4501,12 @@ export interface ConversationsDeleteRequest {
4353
4501
  export type ConversationsDeleteResponse = object;
4354
4502
  /** conversations-export-request */
4355
4503
  export interface ConversationsExportRequest {
4504
+ /**
4505
+ * Filters for conversations that are associated with any of the
4506
+ * accounts.
4507
+ * @example ["ACC-12345"]
4508
+ */
4509
+ account?: string[];
4356
4510
  /** Provides ways to specify date ranges on objects. */
4357
4511
  actual_close_date?: DateFilter;
4358
4512
  /**
@@ -4394,6 +4548,8 @@ export interface ConversationsExportRequest {
4394
4548
  * @example ["DEVU-12345"]
4395
4549
  */
4396
4550
  owned_by?: string[];
4551
+ /** Filters for conversations owned by any of the AI agents. */
4552
+ owned_by_agent?: string[];
4397
4553
  /**
4398
4554
  * Filters for conversations that are associated with any of the
4399
4555
  * provided Rev organizations.
@@ -4464,6 +4620,12 @@ export interface ConversationsGetResponse {
4464
4620
  * The request to get information about a list of conversations.
4465
4621
  */
4466
4622
  export interface ConversationsListRequest {
4623
+ /**
4624
+ * Filters for conversations that are associated with any of the
4625
+ * accounts.
4626
+ * @example ["ACC-12345"]
4627
+ */
4628
+ account?: string[];
4467
4629
  /** Provides ways to specify date ranges on objects. */
4468
4630
  actual_close_date?: DateFilter;
4469
4631
  /**
@@ -4518,6 +4680,8 @@ export interface ConversationsListRequest {
4518
4680
  * @example ["DEVU-12345"]
4519
4681
  */
4520
4682
  owned_by?: string[];
4683
+ /** Filters for conversations owned by any of the AI agents. */
4684
+ owned_by_agent?: string[];
4521
4685
  /**
4522
4686
  * Filters for conversations that are associated with any of the
4523
4687
  * provided Rev organizations.
@@ -4585,6 +4749,12 @@ export interface ConversationsListResponse {
4585
4749
  * The request to update a conversation.
4586
4750
  */
4587
4751
  export interface ConversationsUpdateRequest {
4752
+ /**
4753
+ * The account associated with the conversation.
4754
+ * @format id
4755
+ * @example "ACC-12345"
4756
+ */
4757
+ account?: string | null;
4588
4758
  applies_to_parts?: ConversationsUpdateRequestAppliesToParts;
4589
4759
  /**
4590
4760
  * The brand associated with the conversation.
@@ -4625,6 +4795,60 @@ export interface ConversationsUpdateRequest {
4625
4795
  members?: ConversationsUpdateRequestMembers;
4626
4796
  metadata?: ConversationsUpdateRequestMetadata;
4627
4797
  owned_by?: ConversationsUpdateRequestOwnedBy;
4798
+ /**
4799
+ * The ID of the AI agent that owns the conversation.
4800
+ * @format id
4801
+ */
4802
+ owned_by_agent?: string | null;
4803
+ /**
4804
+ * The enum ID for the sentiment of the conversation. The allowed ids
4805
+ * can be extended by the user. Stock allowed values:
4806
+ * ```
4807
+ * {
4808
+ * "id": 1,
4809
+ * "label": "Delighted",
4810
+ * "ordinal": 1,
4811
+ * "overridable": true
4812
+ * },
4813
+ * {
4814
+ * "id": 2,
4815
+ * "label": "Happy",
4816
+ * "ordinal": 2,
4817
+ * "overridable": true
4818
+ * },
4819
+ * {
4820
+ * "id": 3,
4821
+ * "label": "Neutral",
4822
+ * "ordinal": 3,
4823
+ * "overridable": true
4824
+ * },
4825
+ * {
4826
+ * "id": 4,
4827
+ * "label": "Unhappy",
4828
+ * "ordinal": 4,
4829
+ * "overridable": true
4830
+ * },
4831
+ * {
4832
+ * "id": 5,
4833
+ * "label": "Frustrated",
4834
+ * "ordinal": 5,
4835
+ * "overridable": true
4836
+ * }
4837
+ * ```
4838
+ * @format int64
4839
+ */
4840
+ sentiment?: number;
4841
+ /**
4842
+ * Timestamp at which sentiment was last modified.
4843
+ * @format date-time
4844
+ * @example "2023-01-01T12:00:00.000Z"
4845
+ */
4846
+ sentiment_modified_date?: string;
4847
+ /**
4848
+ * Summary justifying the current sentiment.
4849
+ * @format text
4850
+ */
4851
+ sentiment_summary?: string;
4628
4852
  /**
4629
4853
  * Source channel ID of the conversation.
4630
4854
  * @format id
@@ -4864,7 +5088,10 @@ export interface CreateEmailPreviewWidget {
4864
5088
  /** The list of to addresses. */
4865
5089
  to?: CreateEmailInfo[];
4866
5090
  }
4867
- /** create-external-source-data-comp */
5091
+ /**
5092
+ * create-external-source-data-comp
5093
+ * Create object for external_source_data_comp.
5094
+ */
4868
5095
  export interface CreateExternalSourceDataComp {
4869
5096
  /**
4870
5097
  * Timestamp when the object was closed in the source system.
@@ -5044,6 +5271,16 @@ export interface CreateSyncIn {
5044
5271
  }
5045
5272
  /** create-sync-metadata */
5046
5273
  export interface CreateSyncMetadata {
5274
+ /**
5275
+ * ID of the record in the external system.
5276
+ * @format text
5277
+ */
5278
+ external_record_id?: string;
5279
+ /**
5280
+ * Type of the external record in the external system.
5281
+ * @format text
5282
+ */
5283
+ external_record_type?: string;
5047
5284
  /**
5048
5285
  * External record URL.
5049
5286
  * @format text
@@ -5159,16 +5396,6 @@ export type CustomLinkType = AtomBase & {
5159
5396
  forward_name?: string;
5160
5397
  /** True if this link type is deprecated. */
5161
5398
  is_deprecated?: boolean;
5162
- /**
5163
- * Max hops sets the limit on how many hierarchical levels can be
5164
- * traversed for a given link type, considering both forward and
5165
- * backward directions. For example, if max_hops is set to 1, a link
5166
- * from 'issue-1' to 'ticket-1' is allowed, but extending the chain to
5167
- * 'issue-2' -> 'issue-1' -> 'ticket-1' would exceed the limit and is
5168
- * not allowed.
5169
- * @format int32
5170
- */
5171
- max_hops?: number;
5172
5399
  /**
5173
5400
  * The human readable name of the link type.
5174
5401
  * @format text
@@ -5176,6 +5403,8 @@ export type CustomLinkType = AtomBase & {
5176
5403
  name?: string;
5177
5404
  /** Types from which this link type can originate. */
5178
5405
  source_types: LinkTargetDescriptor[];
5406
+ /** Sync information for records synced into/from DevRev. */
5407
+ sync_metadata?: SyncMetadata;
5179
5408
  /** Types to which this link type can go. */
5180
5409
  target_types: LinkTargetDescriptor[];
5181
5410
  /**
@@ -5250,7 +5479,8 @@ export interface CustomLinkTypeListRequest {
5250
5479
  /** Whether only deprecated link types should be filtered. */
5251
5480
  is_deprecated?: boolean;
5252
5481
  /**
5253
- * The maximum number of items.
5482
+ * The maximum number of items, for each result and
5483
+ * reverse_result.Default value is 50 for each.
5254
5484
  * @format int32
5255
5485
  */
5256
5486
  limit?: number;
@@ -5268,10 +5498,10 @@ export interface CustomLinkTypeListRequest {
5268
5498
  sort_by?: string[];
5269
5499
  source_types?: LinkDescriptorFilter;
5270
5500
  /** Types from which a link can be made. */
5271
- source_types_v2?: LinkTargetDescriptor[];
5501
+ source_types_v2?: LinkTargetDescriptorFilter[];
5272
5502
  target_types?: LinkDescriptorFilter;
5273
5503
  /** Types to which a link can be made. */
5274
- target_types_v2?: LinkTargetDescriptor[];
5504
+ target_types_v2?: LinkTargetDescriptorFilter[];
5275
5505
  }
5276
5506
  /** custom-link-type-list-response */
5277
5507
  export interface CustomLinkTypeListResponse {
@@ -5289,15 +5519,12 @@ export interface CustomLinkTypeListResponse {
5289
5519
  prev_cursor?: string;
5290
5520
  /** The custom link types. */
5291
5521
  result: CustomLinkType[];
5292
- /**
5293
- * The custom link types matching the request filter in the backward
5294
- * direction.Only returned if include_reverse_results is true.Objects
5295
- * can be present in both result and reverse_result.
5296
- */
5297
- reverse_result?: CustomLinkType[];
5298
5522
  }
5299
5523
  /** custom-link-type-summary */
5300
- export type CustomLinkTypeSummary = AtomBaseSummary;
5524
+ export type CustomLinkTypeSummary = AtomBaseSummary & {
5525
+ /** Sync information for records synced into/from DevRev. */
5526
+ sync_metadata?: SyncMetadataSummary;
5527
+ };
5301
5528
  /** custom-link-type-update-request */
5302
5529
  export interface CustomLinkTypeUpdateRequest {
5303
5530
  /**
@@ -5391,6 +5618,11 @@ export type CustomObjectSearchSummary = SearchSummaryBase & {
5391
5618
  };
5392
5619
  /** custom-object-summary */
5393
5620
  export type CustomObjectSummary = AtomBaseSummary & {
5621
+ /**
5622
+ * Type of the object.
5623
+ * @format text
5624
+ */
5625
+ leaf_type?: string;
5394
5626
  /** Sync information for records synced into/from DevRev. */
5395
5627
  sync_metadata?: SyncMetadataSummary;
5396
5628
  /**
@@ -5430,6 +5662,12 @@ export interface CustomObjectsCreateRequest {
5430
5662
  * validate_required_fields: true.
5431
5663
  */
5432
5664
  custom_schema_spec?: CustomSchemaSpec;
5665
+ /**
5666
+ * Description of the custom object.
5667
+ * @format text
5668
+ * @maxLength 65536
5669
+ */
5670
+ description?: string;
5433
5671
  /**
5434
5672
  * Leaf type of the custom object.
5435
5673
  * @format text
@@ -5550,6 +5788,12 @@ export interface CustomObjectsUpdateRequest {
5550
5788
  * validate_required_fields: true.
5551
5789
  */
5552
5790
  custom_schema_spec?: CustomSchemaSpec;
5791
+ /**
5792
+ * Description of the custom object.
5793
+ * @format text
5794
+ * @maxLength 65536
5795
+ */
5796
+ description?: string;
5553
5797
  /**
5554
5798
  * The ID of the custom object to update.
5555
5799
  * @format id
@@ -5615,9 +5859,14 @@ export type CustomSchemaFragmentBase = AtomBase & {
5615
5859
  leaf_type?: string;
5616
5860
  new_fragment_ref?: CustomSchemaFragmentSummary;
5617
5861
  old_fragment_ref?: CustomSchemaFragmentSummary;
5862
+ /** Sync information for records synced into/from DevRev. */
5863
+ sync_metadata?: SyncMetadata;
5618
5864
  };
5619
5865
  /** custom-schema-fragment-base-summary */
5620
- export type CustomSchemaFragmentBaseSummary = AtomBaseSummary;
5866
+ export type CustomSchemaFragmentBaseSummary = AtomBaseSummary & {
5867
+ /** Sync information for records synced into/from DevRev. */
5868
+ sync_metadata?: SyncMetadataSummary;
5869
+ };
5621
5870
  /**
5622
5871
  * custom-schema-fragment-condition
5623
5872
  * The condition associated with a field.
@@ -5680,6 +5929,8 @@ export interface CustomSchemaFragmentsGetRequest {
5680
5929
  * @format id
5681
5930
  */
5682
5931
  id: string;
5932
+ /** Whether to include sync metadata in the response. */
5933
+ include_sync_metadata?: boolean;
5683
5934
  }
5684
5935
  /** custom-schema-fragments-get-response */
5685
5936
  export interface CustomSchemaFragmentsGetResponse {
@@ -5700,6 +5951,8 @@ export interface CustomSchemaFragmentsListRequest {
5700
5951
  * @deprecated
5701
5952
  */
5702
5953
  deprecated?: boolean;
5954
+ /** Whether to include sync metadata in the response. */
5955
+ include_sync_metadata?: boolean;
5703
5956
  /** Whether the leaf type corresponds to a custom object */
5704
5957
  is_custom_leaf_type?: boolean;
5705
5958
  /** Whether the fragment has been deprecated. */
@@ -5726,6 +5979,7 @@ export interface CustomSchemaFragmentsListRequest {
5726
5979
  prune?: CustomSchemaFragmentsListRequestPrune[];
5727
5980
  /** The list of fields to sort the items by and how to sort them. */
5728
5981
  sort_by?: string[];
5982
+ space?: SpaceFilter;
5729
5983
  /** The list of subtypes. */
5730
5984
  subtype?: string[];
5731
5985
  /** Filters for custom schema fragment of the provided types. */
@@ -5817,6 +6071,11 @@ export interface CustomSchemaFragmentsSetRequestCustomTypeFragment {
5817
6071
  * form.
5818
6072
  */
5819
6073
  path?: CustomTypePathComponent[];
6074
+ /**
6075
+ * The space associated with the object.
6076
+ * @format id
6077
+ */
6078
+ space?: string;
5820
6079
  /**
5821
6080
  * The ID of the associated custom stage diagram.
5822
6081
  * @format id
@@ -5921,6 +6180,8 @@ export type CustomStage = AtomBase & {
5921
6180
  */
5922
6181
  ordinal?: number;
5923
6182
  state?: CustomStateSummary;
6183
+ /** Sync information for records synced into/from DevRev. */
6184
+ sync_metadata?: SyncMetadata;
5924
6185
  };
5925
6186
  /** custom-stage-summary */
5926
6187
  export type CustomStageSummary = AtomBaseSummary & {
@@ -5929,6 +6190,8 @@ export type CustomStageSummary = AtomBaseSummary & {
5929
6190
  * @format text
5930
6191
  */
5931
6192
  name?: string;
6193
+ /** Sync information for records synced into/from DevRev. */
6194
+ sync_metadata?: SyncMetadataSummary;
5932
6195
  };
5933
6196
  /** custom-stages-create-request */
5934
6197
  export interface CustomStagesCreateRequest {
@@ -6042,6 +6305,8 @@ export type CustomState = AtomBase & {
6042
6305
  * @format int32
6043
6306
  */
6044
6307
  ordinal?: number;
6308
+ /** Sync information for records synced into/from DevRev. */
6309
+ sync_metadata?: SyncMetadata;
6045
6310
  };
6046
6311
  /** custom-state-summary */
6047
6312
  export type CustomStateSummary = AtomBaseSummary & {
@@ -6052,6 +6317,8 @@ export type CustomStateSummary = AtomBaseSummary & {
6052
6317
  * @format text
6053
6318
  */
6054
6319
  name?: string;
6320
+ /** Sync information for records synced into/from DevRev. */
6321
+ sync_metadata?: SyncMetadataSummary;
6055
6322
  };
6056
6323
  /** custom-states-create-request */
6057
6324
  export interface CustomStatesCreateRequest {
@@ -6711,32 +6978,92 @@ export interface DevOrgsGetResponse {
6711
6978
  }
6712
6979
  /** dev-user */
6713
6980
  export type DevUser = UserBase & {
6714
- /** Custom fields. */
6715
- custom_fields?: object;
6716
- /**
6717
- * Custom schema fragments.
6718
- * @example ["don:core:dvrv-us-1:devo/example:custom_type_fragment/custom-type-fragment-id"]
6719
- */
6720
- custom_schema_fragments?: string[];
6721
- /**
6722
- * Start date of the user's employment.
6723
- * @format date-time
6724
- * @example "2023-01-01T12:00:00.000Z"
6725
- */
6726
- experience_start_date?: string;
6727
- /** IDs of the Dev User outside the DevRev SOR. */
6728
- external_identities?: ExternalIdentity[];
6729
- /** Job history of the user. */
6730
- job_history?: JobHistoryItem[];
6731
- reports_to?: UserSummary;
6732
- /** Array of skills of the user. */
6733
- skills?: UserSkill[];
6734
- /**
6735
- * Stock schema fragment.
6736
- * @format id
6737
- * @example "don:core:dvrv-us-1:devo/example:custom_type_fragment/custom-type-fragment-id"
6738
- */
6739
- stock_schema_fragment?: string;
6981
+ /**
6982
+ * The availability modes of the user. Stock allowed values:
6983
+ * ```
6984
+ * {
6985
+ * "id": 1,
6986
+ * "label": "Ticket",
6987
+ * "ordinal": 1,
6988
+ * "overridable": false
6989
+ * },
6990
+ * {
6991
+ * "id": 2,
6992
+ * "label": "Conversation",
6993
+ * "ordinal": 2,
6994
+ * "overridable": false
6995
+ * },
6996
+ * {
6997
+ * "id": 3,
6998
+ * "label": "Issue",
6999
+ * "ordinal": 3,
7000
+ * "overridable": false
7001
+ * },
7002
+ * {
7003
+ * "id": 4,
7004
+ * "label": "Incident",
7005
+ * "ordinal": 4,
7006
+ * "overridable": false
7007
+ * },
7008
+ * {
7009
+ * "id": 5,
7010
+ * "label": "Away",
7011
+ * "ordinal": 5,
7012
+ * "overridable": false
7013
+ * },
7014
+ * {
7015
+ * "id": 6,
7016
+ * "label": "Sick",
7017
+ * "ordinal": 6,
7018
+ * "overridable": false
7019
+ * },
7020
+ * {
7021
+ * "id": 7,
7022
+ * "label": "Lunch",
7023
+ * "ordinal": 7,
7024
+ * "overridable": false
7025
+ * },
7026
+ * {
7027
+ * "id": 8,
7028
+ * "label": "Travel",
7029
+ * "ordinal": 8,
7030
+ * "overridable": false
7031
+ * },
7032
+ * {
7033
+ * "id": 9,
7034
+ * "label": "Vacation",
7035
+ * "ordinal": 9,
7036
+ * "overridable": false
7037
+ * }
7038
+ * ```
7039
+ */
7040
+ availability_modes?: EnumValue[];
7041
+ /** Custom fields. */
7042
+ custom_fields?: object;
7043
+ /**
7044
+ * Custom schema fragments.
7045
+ * @example ["don:core:dvrv-us-1:devo/example:custom_type_fragment/custom-type-fragment-id"]
7046
+ */
7047
+ custom_schema_fragments?: string[];
7048
+ /**
7049
+ * Start date of the user's employment.
7050
+ * @format date-time
7051
+ * @example "2023-01-01T12:00:00.000Z"
7052
+ */
7053
+ experience_start_date?: string;
7054
+ /** IDs of the Dev User outside the DevRev SOR. */
7055
+ external_identities?: ExternalIdentity[];
7056
+ /** Job history of the user. */
7057
+ job_history?: JobHistoryItem[];
7058
+ reports_to?: UserSummary;
7059
+ /** Array of skills of the user. */
7060
+ skills?: UserSkill[];
7061
+ /**
7062
+ * Stock schema fragment.
7063
+ * @format id
7064
+ * @example "don:core:dvrv-us-1:devo/example:custom_type_fragment/custom-type-fragment-id"
7065
+ */
7066
+ stock_schema_fragment?: string;
6740
7067
  /**
6741
7068
  * Subtype corresponding to the custom type fragment.
6742
7069
  * @format text
@@ -6973,6 +7300,7 @@ export interface DevUsersListRequest {
6973
7300
  phone_numbers?: string[];
6974
7301
  /** Fields to sort the Dev users by and the direction to sort them. */
6975
7302
  sort_by?: string[];
7303
+ staged_info?: StagedInfoFilter;
6976
7304
  /** Filters Dev users based on state. */
6977
7305
  state?: UserState[];
6978
7306
  /**
@@ -7040,6 +7368,66 @@ export interface DevUsersSelfResponse {
7040
7368
  * user.
7041
7369
  */
7042
7370
  export interface DevUsersSelfUpdateRequest {
7371
+ /**
7372
+ * Availability modes of the Dev user. Stock allowed values:
7373
+ * ```
7374
+ * {
7375
+ * "id": 1,
7376
+ * "label": "Ticket",
7377
+ * "ordinal": 1,
7378
+ * "overridable": false
7379
+ * },
7380
+ * {
7381
+ * "id": 2,
7382
+ * "label": "Conversation",
7383
+ * "ordinal": 2,
7384
+ * "overridable": false
7385
+ * },
7386
+ * {
7387
+ * "id": 3,
7388
+ * "label": "Issue",
7389
+ * "ordinal": 3,
7390
+ * "overridable": false
7391
+ * },
7392
+ * {
7393
+ * "id": 4,
7394
+ * "label": "Incident",
7395
+ * "ordinal": 4,
7396
+ * "overridable": false
7397
+ * },
7398
+ * {
7399
+ * "id": 5,
7400
+ * "label": "Away",
7401
+ * "ordinal": 5,
7402
+ * "overridable": false
7403
+ * },
7404
+ * {
7405
+ * "id": 6,
7406
+ * "label": "Sick",
7407
+ * "ordinal": 6,
7408
+ * "overridable": false
7409
+ * },
7410
+ * {
7411
+ * "id": 7,
7412
+ * "label": "Lunch",
7413
+ * "ordinal": 7,
7414
+ * "overridable": false
7415
+ * },
7416
+ * {
7417
+ * "id": 8,
7418
+ * "label": "Travel",
7419
+ * "ordinal": 8,
7420
+ * "overridable": false
7421
+ * },
7422
+ * {
7423
+ * "id": 9,
7424
+ * "label": "Vacation",
7425
+ * "ordinal": 9,
7426
+ * "overridable": false
7427
+ * }
7428
+ * ```
7429
+ */
7430
+ availability_modes?: number[];
7043
7431
  /** Application-defined custom fields. */
7044
7432
  custom_fields?: object;
7045
7433
  /**
@@ -7115,6 +7503,66 @@ export interface DevUsersUpdateJobHistoryItem {
7115
7503
  * provided Dev user.
7116
7504
  */
7117
7505
  export interface DevUsersUpdateRequest {
7506
+ /**
7507
+ * Availability modes of the Dev user. Stock allowed values:
7508
+ * ```
7509
+ * {
7510
+ * "id": 1,
7511
+ * "label": "Ticket",
7512
+ * "ordinal": 1,
7513
+ * "overridable": false
7514
+ * },
7515
+ * {
7516
+ * "id": 2,
7517
+ * "label": "Conversation",
7518
+ * "ordinal": 2,
7519
+ * "overridable": false
7520
+ * },
7521
+ * {
7522
+ * "id": 3,
7523
+ * "label": "Issue",
7524
+ * "ordinal": 3,
7525
+ * "overridable": false
7526
+ * },
7527
+ * {
7528
+ * "id": 4,
7529
+ * "label": "Incident",
7530
+ * "ordinal": 4,
7531
+ * "overridable": false
7532
+ * },
7533
+ * {
7534
+ * "id": 5,
7535
+ * "label": "Away",
7536
+ * "ordinal": 5,
7537
+ * "overridable": false
7538
+ * },
7539
+ * {
7540
+ * "id": 6,
7541
+ * "label": "Sick",
7542
+ * "ordinal": 6,
7543
+ * "overridable": false
7544
+ * },
7545
+ * {
7546
+ * "id": 7,
7547
+ * "label": "Lunch",
7548
+ * "ordinal": 7,
7549
+ * "overridable": false
7550
+ * },
7551
+ * {
7552
+ * "id": 8,
7553
+ * "label": "Travel",
7554
+ * "ordinal": 8,
7555
+ * "overridable": false
7556
+ * },
7557
+ * {
7558
+ * "id": 9,
7559
+ * "label": "Vacation",
7560
+ * "ordinal": 9,
7561
+ * "overridable": false
7562
+ * }
7563
+ * ```
7564
+ */
7565
+ availability_modes?: number[];
7118
7566
  /** Application-defined custom fields. */
7119
7567
  custom_fields?: object;
7120
7568
  /**
@@ -7156,6 +7604,34 @@ export interface DevUsersUpdateRequest {
7156
7604
  * @format id
7157
7605
  */
7158
7606
  reports_to?: string;
7607
+ staged_info?: DevUsersUpdateRequestStagedInfoUpdate;
7608
+ }
7609
+ /** dev-users-update-request-staged-info-update */
7610
+ export interface DevUsersUpdateRequestStagedInfoUpdate {
7611
+ /** Updates the sync in unresolved fields of the staged Dev user. */
7612
+ sync_in_unresolved_fields?: DevUsersUpdateRequestStagedInfoUpdateUnresolvedField[];
7613
+ /** Updates the sync out unresolved fields of the staged Dev user. */
7614
+ sync_out_unresolved_fields?: DevUsersUpdateRequestStagedInfoUpdateUnresolvedField[];
7615
+ /** Updates the unresolved fields of the staged Dev user. */
7616
+ unresolved_fields?: string[];
7617
+ }
7618
+ /** dev-users-update-request-staged-info-update-unresolved-field */
7619
+ export interface DevUsersUpdateRequestStagedInfoUpdateUnresolvedField {
7620
+ /**
7621
+ * DevRev field name of the object's attribute.
7622
+ * @format text
7623
+ */
7624
+ devrev_field_name?: string;
7625
+ /**
7626
+ * External field name as seen by the end user.
7627
+ * @format text
7628
+ */
7629
+ external_display_name?: string;
7630
+ /**
7631
+ * Api name of the external object's field.
7632
+ * @format text
7633
+ */
7634
+ external_field_name?: string;
7159
7635
  }
7160
7636
  /**
7161
7637
  * dev-users-update-response
@@ -7164,6 +7640,65 @@ export interface DevUsersUpdateRequest {
7164
7640
  export interface DevUsersUpdateResponse {
7165
7641
  dev_user: DevUser;
7166
7642
  }
7643
+ /** device-metadata */
7644
+ export interface DeviceMetadata {
7645
+ /**
7646
+ * The version of the mobile application.
7647
+ * @format text
7648
+ */
7649
+ app_version: string;
7650
+ /**
7651
+ * The company that manufactured the device.
7652
+ * @format text
7653
+ */
7654
+ manufacturer: string;
7655
+ /**
7656
+ * The model name/number of the device.
7657
+ * @format text
7658
+ */
7659
+ model: string;
7660
+ /**
7661
+ * The type of network connection (e.g. WiFi, cellular).
7662
+ * @format text
7663
+ */
7664
+ network_type: string;
7665
+ /**
7666
+ * The version of the device's operating system.
7667
+ * @format text
7668
+ */
7669
+ os_version: string;
7670
+ /**
7671
+ * The PLuG SDK version.
7672
+ * @format text
7673
+ */
7674
+ plug_sdk_version: string;
7675
+ /**
7676
+ * The screen height.
7677
+ * @format int32
7678
+ */
7679
+ screen_height: number;
7680
+ /**
7681
+ * The screen width.
7682
+ * @format int32
7683
+ */
7684
+ screen_width: number;
7685
+ /**
7686
+ * The SDK version.
7687
+ * @format text
7688
+ */
7689
+ sdk_version: string;
7690
+ }
7691
+ /** The platform type for the device. */
7692
+ export declare enum DevicePlatform {
7693
+ Android = "android",
7694
+ Ios = "ios",
7695
+ Web = "web"
7696
+ }
7697
+ /** The type of device used in a web session. */
7698
+ export declare enum DeviceType {
7699
+ Desktop = "desktop",
7700
+ Mobile = "mobile"
7701
+ }
7167
7702
  /** directories-count-request */
7168
7703
  export interface DirectoriesCountRequest {
7169
7704
  /**
@@ -7207,7 +7742,10 @@ export interface DirectoriesCreateRequest {
7207
7742
  parent?: string;
7208
7743
  /** Whether the directory is published. */
7209
7744
  published?: boolean;
7210
- /** Tags associated with the directory. */
7745
+ /**
7746
+ * Tags associated with the directory.
7747
+ * @maxItems 20
7748
+ */
7211
7749
  tags?: SetTagWithValue[];
7212
7750
  /**
7213
7751
  * ID of the thumbnail artifact.
@@ -7370,7 +7908,10 @@ export interface DirectoriesUpdateRequestReorder {
7370
7908
  }
7371
7909
  /** directories-update-request-tags */
7372
7910
  export interface DirectoriesUpdateRequestTags {
7373
- /** Sets the provided tags on the directory. */
7911
+ /**
7912
+ * Sets the provided tags on the directory.
7913
+ * @maxItems 20
7914
+ */
7374
7915
  set?: SetTagWithValue[];
7375
7916
  }
7376
7917
  /**
@@ -7412,10 +7953,19 @@ export type Directory = AtomBase & {
7412
7953
  */
7413
7954
  title?: string;
7414
7955
  };
7956
+ /** directory-search-summary */
7957
+ export type DirectorySearchSummary = SearchSummaryBase & {
7958
+ directory: DirectorySummary;
7959
+ };
7415
7960
  /** directory-summary */
7416
7961
  export type DirectorySummary = AtomBaseSummary & {
7417
7962
  /** Sync information for records synced into/from DevRev. */
7418
7963
  sync_metadata?: SyncMetadataSummary;
7964
+ /**
7965
+ * Title of the directory.
7966
+ * @format text
7967
+ */
7968
+ title?: string;
7419
7969
  };
7420
7970
  /** dm */
7421
7971
  export type Dm = ChatBase & {
@@ -7430,6 +7980,15 @@ export type Dm = ChatBase & {
7430
7980
  */
7431
7981
  users: UserSummary[];
7432
7982
  };
7983
+ /** dm-search-summary */
7984
+ export type DmSearchSummary = SearchSummaryBase & {
7985
+ /**
7986
+ * Comments on the DM.
7987
+ * @maxItems 5
7988
+ */
7989
+ comments?: CommentSearchSummary[];
7990
+ dm: DmSummary;
7991
+ };
7433
7992
  /** dm-summary */
7434
7993
  export type DmSummary = ChatBaseSummary & {
7435
7994
  /**
@@ -7955,6 +8514,11 @@ export type EnhancementSummary = PartBaseSummary;
7955
8514
  * The properties of an enum value.
7956
8515
  */
7957
8516
  export interface EnumValue {
8517
+ /**
8518
+ * Color of the enum value (e.g., red, green, teal).
8519
+ * @format text
8520
+ */
8521
+ color?: string;
7958
8522
  /**
7959
8523
  * The unique ID of the enum value.
7960
8524
  * @format int64
@@ -8016,7 +8580,7 @@ export interface Error {
8016
8580
  * error-bad-request
8017
8581
  * Describes a error due to a bad request by the client.
8018
8582
  */
8019
- export type ErrorBadRequest = ErrorBase & (ErrorBadRequestArtifactAlreadyAttachedToAParent | ErrorBadRequestBadRequest | ErrorBadRequestCustomizationValidationError | ErrorBadRequestInvalidApiVersion | ErrorBadRequestInvalidEnumValue | ErrorBadRequestInvalidField | ErrorBadRequestInvalidId | ErrorBadRequestMergeWorksError | ErrorBadRequestMissingDependency | ErrorBadRequestMissingRequiredField | ErrorBadRequestParseError | ErrorBadRequestStaleSchemaFragments | ErrorBadRequestUnexpectedIdType | ErrorBadRequestUnexpectedJsonType | ErrorBadRequestValueNotPermitted | ErrorBadRequestWorkflowComponentValidationErrors) & {
8583
+ export type ErrorBadRequest = ErrorBase & (ErrorBadRequestArtifactAlreadyAttachedToAParent | ErrorBadRequestBadRequest | ErrorBadRequestCustomizationValidationError | ErrorBadRequestGroupHierarchyCircularDependency | ErrorBadRequestGroupHierarchyDepthExceeded | ErrorBadRequestGroupHierarchyInvalidParent | ErrorBadRequestInvalidApiVersion | ErrorBadRequestInvalidContentType | ErrorBadRequestInvalidEnumValue | ErrorBadRequestInvalidField | ErrorBadRequestInvalidId | ErrorBadRequestMergeWorksError | ErrorBadRequestMissingDependency | ErrorBadRequestMissingRequiredField | ErrorBadRequestParseError | ErrorBadRequestStaleSchemaFragments | ErrorBadRequestUnexpectedIdType | ErrorBadRequestUnexpectedJsonType | ErrorBadRequestValueNotPermitted | ErrorBadRequestWorkflowComponentValidationErrors) & {
8020
8584
  type: ErrorBadRequestType;
8021
8585
  };
8022
8586
  /** error-bad-request-artifact-already-attached-to-a-parent */
@@ -8098,6 +8662,41 @@ export type ErrorBadRequestCustomizationValidationErrorUnknownError = object;
8098
8662
  export type ErrorBadRequestCustomizationValidationErrorUnsupportedType = object;
8099
8663
  /** error-bad-request-customization-validation-error-wrong-type */
8100
8664
  export type ErrorBadRequestCustomizationValidationErrorWrongType = object;
8665
+ /**
8666
+ * error-bad-request-group-hierarchy-circular-dependency
8667
+ * Error indicating that a circular dependency was detected in the group
8668
+ * hierarchy.
8669
+ */
8670
+ export type ErrorBadRequestGroupHierarchyCircularDependency = object;
8671
+ /**
8672
+ * error-bad-request-group-hierarchy-depth-exceeded
8673
+ * Error indicating that the group hierarchy depth limit has been
8674
+ * exceeded.
8675
+ */
8676
+ export interface ErrorBadRequestGroupHierarchyDepthExceeded {
8677
+ /**
8678
+ * The actual depth observed for the hierarchy.
8679
+ * @format int32
8680
+ */
8681
+ actual_depth?: number;
8682
+ /**
8683
+ * The maximum allowed depth for the hierarchy.
8684
+ * @format int32
8685
+ */
8686
+ max_depth?: number;
8687
+ }
8688
+ /**
8689
+ * error-bad-request-group-hierarchy-invalid-parent
8690
+ * Error indicating that an invalid parent was provided for the group
8691
+ * hierarchy.
8692
+ */
8693
+ export interface ErrorBadRequestGroupHierarchyInvalidParent {
8694
+ reason?: ErrorBadRequestGroupHierarchyInvalidParentReason;
8695
+ }
8696
+ export declare enum ErrorBadRequestGroupHierarchyInvalidParentReason {
8697
+ MultipleParents = "multiple_parents",
8698
+ ParentNotLinkedToSpace = "parent_not_linked_to_space"
8699
+ }
8101
8700
  /** error-bad-request-invalid-api-version */
8102
8701
  export interface ErrorBadRequestInvalidApiVersion {
8103
8702
  /**
@@ -8106,6 +8705,14 @@ export interface ErrorBadRequestInvalidApiVersion {
8106
8705
  */
8107
8706
  value: string;
8108
8707
  }
8708
+ /** error-bad-request-invalid-content-type */
8709
+ export interface ErrorBadRequestInvalidContentType {
8710
+ /**
8711
+ * The provided content type.
8712
+ * @format text
8713
+ */
8714
+ value: string;
8715
+ }
8109
8716
  /** error-bad-request-invalid-enum-value */
8110
8717
  export interface ErrorBadRequestInvalidEnumValue {
8111
8718
  /** The allowed values for the field. */
@@ -8277,7 +8884,11 @@ export declare enum ErrorBadRequestType {
8277
8884
  ArtifactAlreadyAttachedToAParent = "artifact_already_attached_to_a_parent",
8278
8885
  BadRequest = "bad_request",
8279
8886
  CustomizationValidationError = "customization_validation_error",
8887
+ GroupHierarchyCircularDependency = "group_hierarchy_circular_dependency",
8888
+ GroupHierarchyDepthExceeded = "group_hierarchy_depth_exceeded",
8889
+ GroupHierarchyInvalidParent = "group_hierarchy_invalid_parent",
8280
8890
  InvalidApiVersion = "invalid_api_version",
8891
+ InvalidContentType = "invalid_content_type",
8281
8892
  InvalidEnumValue = "invalid_enum_value",
8282
8893
  InvalidField = "invalid_field",
8283
8894
  InvalidId = "invalid_id",
@@ -8293,11 +8904,18 @@ export declare enum ErrorBadRequestType {
8293
8904
  }
8294
8905
  /** error-bad-request-unexpected-id-type */
8295
8906
  export interface ErrorBadRequestUnexpectedIdType {
8907
+ /** The allowed types for the field. */
8908
+ allowed_types?: string[];
8296
8909
  /**
8297
8910
  * The field whose ID type is unexpected.
8298
8911
  * @format text
8299
8912
  */
8300
8913
  field_name: string;
8914
+ /**
8915
+ * The ID value that was received.
8916
+ * @format id
8917
+ */
8918
+ value: string;
8301
8919
  }
8302
8920
  /** error-bad-request-unexpected-json-type */
8303
8921
  export interface ErrorBadRequestUnexpectedJsonType {
@@ -8326,6 +8944,11 @@ export interface ErrorBadRequestValueNotPermitted {
8326
8944
  * @format text
8327
8945
  */
8328
8946
  field_name: string;
8947
+ /**
8948
+ * The pattern the value must match.
8949
+ * @format text
8950
+ */
8951
+ pattern?: string;
8329
8952
  /**
8330
8953
  * The reason the value isn't permitted.
8331
8954
  * @format text
@@ -8475,19 +9098,20 @@ export type ErrorNotFoundNotFound = object;
8475
9098
  export declare enum ErrorNotFoundType {
8476
9099
  NotFound = "not_found"
8477
9100
  }
8478
- /** error-see-other */
8479
- export type ErrorSeeOther = ErrorBase & ErrorSeeOtherSeeOther & {
8480
- type: ErrorSeeOtherType;
9101
+ /** error-request-entity-too-large */
9102
+ export type ErrorRequestEntityTooLarge = ErrorBase & ErrorRequestEntityTooLargeRequestEntityTooLarge & {
9103
+ type: ErrorRequestEntityTooLargeType;
9104
+ };
9105
+ /** error-request-entity-too-large-request-entity-too-large */
9106
+ export interface ErrorRequestEntityTooLargeRequestEntityTooLarge {
8481
9107
  /**
8482
- * The URL to redirect to.
8483
- * @format text
9108
+ * The maximum permitted bytes.
9109
+ * @format int32
8484
9110
  */
8485
- location: string;
8486
- };
8487
- /** error-see-other-see-other */
8488
- export type ErrorSeeOtherSeeOther = object;
8489
- export declare enum ErrorSeeOtherType {
8490
- SeeOther = "see_other"
9111
+ max_bytes?: number;
9112
+ }
9113
+ export declare enum ErrorRequestEntityTooLargeType {
9114
+ RequestEntityTooLarge = "request_entity_too_large"
8491
9115
  }
8492
9116
  /** error-service-unavailable */
8493
9117
  export type ErrorServiceUnavailable = ErrorBase & ErrorServiceUnavailableServiceUnavailable & {
@@ -8513,10 +9137,19 @@ export declare enum ErrorTooManyRequestsType {
8513
9137
  TooManyRequests = "too_many_requests"
8514
9138
  }
8515
9139
  /** error-unauthorized */
8516
- export type ErrorUnauthorized = ErrorBase & ErrorUnauthorizedUnauthenticated & {
9140
+ export type ErrorUnauthorized = ErrorBase & (ErrorUnauthorizedDevOrgDeactivated | ErrorUnauthorizedTokenExpired | ErrorUnauthorizedTokenRevoked | ErrorUnauthorizedUnauthenticated) & {
8517
9141
  type: ErrorUnauthorizedType;
8518
9142
  };
9143
+ /** error-unauthorized-dev-org-deactivated */
9144
+ export type ErrorUnauthorizedDevOrgDeactivated = object;
9145
+ /** error-unauthorized-token-expired */
9146
+ export type ErrorUnauthorizedTokenExpired = object;
9147
+ /** error-unauthorized-token-revoked */
9148
+ export type ErrorUnauthorizedTokenRevoked = object;
8519
9149
  export declare enum ErrorUnauthorizedType {
9150
+ DevOrgDeactivated = "dev_org_deactivated",
9151
+ TokenExpired = "token_expired",
9152
+ TokenRevoked = "token_revoked",
8520
9153
  Unauthenticated = "unauthenticated"
8521
9154
  }
8522
9155
  /** error-unauthorized-unauthenticated */
@@ -8561,6 +9194,11 @@ export interface EventAiAgentResponse {
8561
9194
  */
8562
9195
  agent: string;
8563
9196
  agent_response?: 'error' | 'message' | 'message_generation_started' | 'progress' | 'suggestions';
9197
+ /**
9198
+ * The ID of the agent version that was used for the execution.
9199
+ * @format id
9200
+ */
9201
+ agent_version?: string;
8564
9202
  /** The metadata given by client to be passed to the event source. */
8565
9203
  client_metadata?: object;
8566
9204
  /**
@@ -8608,7 +9246,7 @@ export interface EventArticleDeleted {
8608
9246
  /**
8609
9247
  * The ID of the article that was deleted.
8610
9248
  * @format id
8611
- * @example "ARTICLE-12345"
9249
+ * @example "ART-12345"
8612
9250
  */
8613
9251
  id: string;
8614
9252
  old_article?: Article;
@@ -8734,6 +9372,7 @@ export interface EventLinkDeleted {
8734
9372
  * @format id
8735
9373
  */
8736
9374
  id: string;
9375
+ old_link?: Link;
8737
9376
  }
8738
9377
  /** event-link-updated */
8739
9378
  export interface EventLinkUpdated {
@@ -9529,6 +10168,61 @@ export declare enum FieldValueType {
9529
10168
  TagSummary = "tag_summary",
9530
10169
  TagSummaryList = "tag_summary_list"
9531
10170
  }
10171
+ /**
10172
+ * flame-graph-visualization-x-axis
10173
+ * The X-axis for a flame graph visualization.
10174
+ */
10175
+ export interface FlameGraphVisualizationXAxis {
10176
+ /** The color for an axis. This can be a single color or a gradient. */
10177
+ color?: VisualizationAxisColor;
10178
+ /** The drill through configurations for the axis. */
10179
+ drill_throughs?: VisualizationAxisDrillThrough[];
10180
+ /** Whether the axis should be hidden. */
10181
+ is_hidden?: boolean;
10182
+ /**
10183
+ * The label for the axis.
10184
+ * @format text
10185
+ */
10186
+ label?: string;
10187
+ /**
10188
+ * The reference name of the axis.
10189
+ * @format text
10190
+ */
10191
+ reference_name: string;
10192
+ }
10193
+ /**
10194
+ * flame-graph-visualization-y-axis
10195
+ * The Y-axis for a flame graph visualization.
10196
+ */
10197
+ export interface FlameGraphVisualizationYAxis {
10198
+ /** The color for an axis. This can be a single color or a gradient. */
10199
+ color?: VisualizationAxisColor;
10200
+ /** The drill through configurations for the axis. */
10201
+ drill_throughs?: VisualizationAxisDrillThrough[];
10202
+ /** Whether the axis should be hidden. */
10203
+ is_hidden?: boolean;
10204
+ /**
10205
+ * The label for the axis.
10206
+ * @format text
10207
+ */
10208
+ label?: string;
10209
+ /**
10210
+ * The reference name of the axis.
10211
+ * @format text
10212
+ */
10213
+ reference_name: string;
10214
+ }
10215
+ /**
10216
+ * flame-graph-widget-visualization
10217
+ * A Flame Graph chart visualization configuration. Includes metadata
10218
+ * specific to flame graph charts.
10219
+ */
10220
+ export interface FlameGraphWidgetVisualization {
10221
+ /** The configuration for the X-axis. */
10222
+ x: FlameGraphVisualizationXAxis[];
10223
+ /** The configuration for the Y-axes. */
10224
+ y: FlameGraphVisualizationYAxis[];
10225
+ }
9532
10226
  /**
9533
10227
  * general-preferences-group
9534
10228
  * Preferences group for General settings.
@@ -9667,6 +10361,11 @@ export type Group = AtomBase & {
9667
10361
  */
9668
10362
  name?: string;
9669
10363
  owner?: UserSummary;
10364
+ /**
10365
+ * IDs of the immediate parent group(s) that the current group is a
10366
+ * member of.
10367
+ */
10368
+ parents?: string[];
9670
10369
  /** Sync information for records synced into/from DevRev. */
9671
10370
  sync_metadata?: SyncMetadata;
9672
10371
  };
@@ -9696,7 +10395,7 @@ export interface GroupMembersAddRequest {
9696
10395
  */
9697
10396
  group: string;
9698
10397
  /**
9699
- * ID of the member to be added.
10398
+ * ID of the member to be added. Can be a user or a group.
9700
10399
  * @format id
9701
10400
  * @example "DEVU-12345"
9702
10401
  */
@@ -9711,6 +10410,31 @@ export interface GroupMembersAddRequest {
9711
10410
  }
9712
10411
  /** group-members-add-response */
9713
10412
  export type GroupMembersAddResponse = object;
10413
+ /**
10414
+ * group-members-count-request
10415
+ * A request to count group members.
10416
+ */
10417
+ export interface GroupMembersCountRequest {
10418
+ /**
10419
+ * ID of the group for which to count members.
10420
+ * @format id
10421
+ */
10422
+ group: string;
10423
+ }
10424
+ /**
10425
+ * group-members-count-response
10426
+ * Count of group members.
10427
+ */
10428
+ export interface GroupMembersCountResponse {
10429
+ /**
10430
+ * Count of members. This value may be limited by an upper threshold
10431
+ * and may not represent the full total.
10432
+ * @format int32
10433
+ */
10434
+ count: number;
10435
+ /** Whether there are more members than the count value. */
10436
+ has_more: boolean;
10437
+ }
9714
10438
  /**
9715
10439
  * group-members-list-request
9716
10440
  * A request to list group members.
@@ -9741,6 +10465,8 @@ export interface GroupMembersListRequest {
9741
10465
  * always be returned in the specified sort-by order.
9742
10466
  */
9743
10467
  mode?: ListMode;
10468
+ /** Fields to sort the group members by and the direction to sort them. */
10469
+ sort_by?: string[];
9744
10470
  }
9745
10471
  /**
9746
10472
  * group-members-list-response
@@ -9781,7 +10507,7 @@ export interface GroupMembersRemoveRequest {
9781
10507
  */
9782
10508
  group: string;
9783
10509
  /**
9784
- * ID of the member to be removed.
10510
+ * ID of the member to be removed. Can be a user or a group.
9785
10511
  * @format id
9786
10512
  * @example "DEVU-12345"
9787
10513
  */
@@ -9809,6 +10535,11 @@ export type GroupSummary = AtomBaseSummary & {
9809
10535
  * @format text
9810
10536
  */
9811
10537
  name?: string;
10538
+ /**
10539
+ * IDs of the immediate parent group(s) that the current group is a
10540
+ * member of.
10541
+ */
10542
+ parents?: string[];
9812
10543
  /** Sync information for records synced into/from DevRev. */
9813
10544
  sync_metadata?: SyncMetadataSummary;
9814
10545
  };
@@ -9935,8 +10666,14 @@ export interface GroupsListRequest {
9935
10666
  mode?: ListMode;
9936
10667
  /** Filters the groups on the basis of group name. */
9937
10668
  name?: string[];
10669
+ /**
10670
+ * Filters the groups on the basis of parent group(s).
10671
+ * @deprecated
10672
+ */
10673
+ parents?: string[];
9938
10674
  /** Comma-separated fields to sort the groups by. */
9939
10675
  sort_by?: string[];
10676
+ space?: SpaceFilter;
9940
10677
  sync_metadata?: SyncMetadataFilter;
9941
10678
  }
9942
10679
  /**
@@ -10227,6 +10964,7 @@ export interface IncidentsCreateRequest {
10227
10964
  * validate_required_fields: true.
10228
10965
  */
10229
10966
  custom_schema_spec?: CustomSchemaSpec;
10967
+ /** Create object for external_source_data_comp. */
10230
10968
  external_source_data?: CreateExternalSourceDataComp;
10231
10969
  /**
10232
10970
  * Time when the incident was identified/reported.
@@ -10377,6 +11115,11 @@ export interface IncidentsGroupRequest {
10377
11115
  * @example ["ACC-12345"]
10378
11116
  */
10379
11117
  impacted_customers?: string[];
11118
+ /**
11119
+ * Whether to include items belonging to children of any of the
11120
+ * provided parts.
11121
+ */
11122
+ include_child_parts?: boolean;
10380
11123
  /**
10381
11124
  * The maximum number of groups to return. If not set, then the
10382
11125
  * default is '10'.
@@ -10405,17 +11148,17 @@ export interface IncidentsGroupRequest {
10405
11148
  owned_by?: string[];
10406
11149
  /**
10407
11150
  * Filters for incidents with any of the provided PIAs.
10408
- * @example ["ARTICLE-12345"]
11151
+ * @example ["ART-12345"]
10409
11152
  */
10410
11153
  pia?: string[];
10411
11154
  /**
10412
11155
  * Filters for incidents with any of the provided playbooks.
10413
- * @example ["ARTICLE-12345"]
11156
+ * @example ["ART-12345"]
10414
11157
  */
10415
11158
  playbooks?: string[];
10416
11159
  /**
10417
11160
  * Filters for incidents with any of the provided related docs.
10418
- * @example ["ARTICLE-12345"]
11161
+ * @example ["ART-12345"]
10419
11162
  */
10420
11163
  related_docs?: string[];
10421
11164
  /** Filters for incidents with any of the provided reporters. */
@@ -10487,6 +11230,11 @@ export interface IncidentsListRequest {
10487
11230
  * @example ["ACC-12345"]
10488
11231
  */
10489
11232
  impacted_customers?: string[];
11233
+ /**
11234
+ * Whether to include items belonging to children of any of the
11235
+ * provided parts.
11236
+ */
11237
+ include_child_parts?: boolean;
10490
11238
  /**
10491
11239
  * The maximum number of items.
10492
11240
  * @format int32
@@ -10508,17 +11256,17 @@ export interface IncidentsListRequest {
10508
11256
  owned_by?: string[];
10509
11257
  /**
10510
11258
  * Filters for incidents with any of the provided PIAs.
10511
- * @example ["ARTICLE-12345"]
11259
+ * @example ["ART-12345"]
10512
11260
  */
10513
11261
  pia?: string[];
10514
11262
  /**
10515
11263
  * Filters for incidents with any of the provided playbooks.
10516
- * @example ["ARTICLE-12345"]
11264
+ * @example ["ART-12345"]
10517
11265
  */
10518
11266
  playbooks?: string[];
10519
11267
  /**
10520
11268
  * Filters for incidents with any of the provided related docs.
10521
- * @example ["ARTICLE-12345"]
11269
+ * @example ["ART-12345"]
10522
11270
  */
10523
11271
  related_docs?: string[];
10524
11272
  /** Filters for incidents with any of the provided reporters. */
@@ -10586,6 +11334,7 @@ export interface IncidentsUpdateRequest {
10586
11334
  * validate_required_fields: true.
10587
11335
  */
10588
11336
  custom_schema_spec?: CustomSchemaSpec;
11337
+ /** Update object for ExternalSourceDataComp. */
10589
11338
  external_source_data?: UpdateExternalSourceDataComp;
10590
11339
  /**
10591
11340
  * The ID of the incident to be updated.
@@ -10721,6 +11470,63 @@ export type IssueSummary = WorkBaseSummary & {
10721
11470
  /** Vista group item. */
10722
11471
  sprint?: VistaGroupItemSummary;
10723
11472
  };
11473
+ /** job */
11474
+ export type Job = AtomBase & {
11475
+ /** Category of your job. */
11476
+ job_category: JobCategory;
11477
+ /**
11478
+ * Name of your job.
11479
+ * @format text
11480
+ */
11481
+ job_id: string;
11482
+ /** Metadata associated with this job. */
11483
+ metadata_list?: Metadata[];
11484
+ /** Artifact IDs of the output files. */
11485
+ output_artifacts?: ArtifactSummary[];
11486
+ /**
11487
+ * Progress of your item in percentage.
11488
+ * @format int32
11489
+ */
11490
+ progress: number;
11491
+ /**
11492
+ * Number of times the job has been retried.
11493
+ * @format int32
11494
+ */
11495
+ retry_count?: number;
11496
+ /** State of your Job. */
11497
+ state: JobState;
11498
+ /**
11499
+ * Title of your item.
11500
+ * @format text
11501
+ */
11502
+ title: string;
11503
+ };
11504
+ /** Category of your job. */
11505
+ export declare enum JobCategory {
11506
+ BulkUpgrade = "bulk_upgrade",
11507
+ ConvertConversationTicket = "convert_conversation_ticket",
11508
+ DeletePartHierarchy = "delete_part_hierarchy",
11509
+ ExportAccount = "export_account",
11510
+ ExportArticle = "export_article",
11511
+ ExportAuditLog = "export_audit_log",
11512
+ ExportConversation = "export_conversation",
11513
+ ExportCustomObject = "export_custom_object",
11514
+ ExportDevuser = "export_devuser",
11515
+ ExportIncident = "export_incident",
11516
+ ExportPart = "export_part",
11517
+ ExportRevuser = "export_revuser",
11518
+ ExportWork = "export_work",
11519
+ GetObjectAsync = "get_object_async",
11520
+ MergeAccount = "merge_account",
11521
+ MergeDevuser = "merge_devuser",
11522
+ MergeRevorg = "merge_revorg",
11523
+ MergeRevuser = "merge_revuser",
11524
+ MergeTicket = "merge_ticket",
11525
+ MoveRevorg = "move_revorg",
11526
+ MoveRevuser = "move_revuser",
11527
+ OasisDataExport = "oasis_data_export",
11528
+ OasisJob = "oasis_job"
11529
+ }
10724
11530
  /**
10725
11531
  * job-history-item
10726
11532
  * Defines a job history line item.
@@ -10753,6 +11559,89 @@ export interface JobHistoryItem {
10753
11559
  */
10754
11560
  title?: string;
10755
11561
  }
11562
+ /** State of your Job. */
11563
+ export declare enum JobState {
11564
+ Completed = "completed",
11565
+ Failed = "failed",
11566
+ InProgress = "in_progress",
11567
+ Queued = "queued",
11568
+ Started = "started"
11569
+ }
11570
+ /**
11571
+ * jobs-get-request
11572
+ * Request object to get a job's information.
11573
+ */
11574
+ export interface JobsGetRequest {
11575
+ /**
11576
+ * The ID of the job to be retrieved.
11577
+ * @format id
11578
+ */
11579
+ id: string;
11580
+ }
11581
+ /**
11582
+ * jobs-get-response
11583
+ * The returned job.
11584
+ */
11585
+ export interface JobsGetResponse {
11586
+ job: Job;
11587
+ }
11588
+ /**
11589
+ * jobs-list-request
11590
+ * List the jobs.
11591
+ */
11592
+ export interface JobsListRequest {
11593
+ /** Filters on job category. */
11594
+ category?: JobCategory[];
11595
+ /** Filters for jobs created by the specified user(s). */
11596
+ created_by?: string[];
11597
+ /**
11598
+ * The cursor to resume iteration from. If not provided, then
11599
+ * iteration starts from the beginning.
11600
+ * @format text
11601
+ */
11602
+ cursor?: string;
11603
+ /**
11604
+ * The maximum number of jobs to return per page. The default is '50'.
11605
+ * @format int32
11606
+ */
11607
+ limit?: number;
11608
+ /**
11609
+ * The iteration mode to use. If "after", then entries after the provided
11610
+ * cursor will be returned, or if no cursor is provided, then from the
11611
+ * beginning. If "before", then entries before the provided cursor will be
11612
+ * returned, or if no cursor is provided, then from the end. Entries will
11613
+ * always be returned in the specified sort-by order.
11614
+ */
11615
+ mode?: ListMode;
11616
+ /** Filters on the user who owns the job. */
11617
+ owned_by_id?: string[];
11618
+ /** Filters on parent ids for jobs. */
11619
+ parent_ids?: string[];
11620
+ /** Fields to sort the jobs by and the direction to sort them in. */
11621
+ sort_by?: string[];
11622
+ /** Filters on job state. */
11623
+ state?: JobState[];
11624
+ }
11625
+ /**
11626
+ * jobs-list-response
11627
+ * The response to listing all jobs matching the filter criteria.
11628
+ */
11629
+ export interface JobsListResponse {
11630
+ /** List containing all the jobs. */
11631
+ jobs: Job[];
11632
+ /**
11633
+ * The cursor used to iterate subsequent results in accordance to the
11634
+ * sort order. If not set, then no later elements exist.
11635
+ * @format text
11636
+ */
11637
+ next_cursor?: string;
11638
+ /**
11639
+ * The cursor used to iterate preceding results in accordance to the
11640
+ * sort order. If not set, then no prior elements exist.
11641
+ * @format text
11642
+ */
11643
+ prev_cursor?: string;
11644
+ }
10756
11645
  /**
10757
11646
  * kanban-visualization-card-attribute
10758
11647
  * A card attribute in a kanban visualization.
@@ -10802,7 +11691,7 @@ export interface KanbanWidgetVisualization {
10802
11691
  /** The configuration for the card in the kanban. */
10803
11692
  card_attributes: KanbanVisualizationCardAttribute[];
10804
11693
  /** The group_by configuration in the kanban. */
10805
- group_by: WidgetGroupByConfig[];
11694
+ group_by?: WidgetGroupByConfig[];
10806
11695
  }
10807
11696
  /** keyrings-create-callback-request */
10808
11697
  export interface KeyringsCreateCallbackRequest {
@@ -10964,6 +11853,8 @@ export type Link = AtomBase & {
10964
11853
  /** Type of link used to define the relationship. */
10965
11854
  link_type: LinkType;
10966
11855
  source: LinkEndpointSummary;
11856
+ /** Sync information for records synced into/from DevRev. */
11857
+ sync_metadata?: SyncMetadata;
10967
11858
  target: LinkEndpointSummary;
10968
11859
  };
10969
11860
  /** link-descriptor-filter */
@@ -11046,6 +11937,8 @@ export type LinkSummary = AtomBaseSummary & {
11046
11937
  /** Type of link used to define the relationship. */
11047
11938
  link_type: LinkType;
11048
11939
  source: LinkEndpointSummary;
11940
+ /** Sync information for records synced into/from DevRev. */
11941
+ sync_metadata?: SyncMetadataSummary;
11049
11942
  target: LinkEndpointSummary;
11050
11943
  };
11051
11944
  /**
@@ -11071,6 +11964,26 @@ export interface LinkTargetDescriptor {
11071
11964
  */
11072
11965
  subtype?: string;
11073
11966
  }
11967
+ /** link-target-descriptor-filter */
11968
+ export interface LinkTargetDescriptorFilter {
11969
+ /** True when the descriptor describes a custom leaf type. */
11970
+ is_custom_leaf_type?: boolean;
11971
+ /**
11972
+ * Set to true when only the specified leaf type (no subtypes) is
11973
+ * allowed as a link target.
11974
+ */
11975
+ leaf_only?: boolean;
11976
+ /**
11977
+ * Leaf type of the target objects.
11978
+ * @format text
11979
+ */
11980
+ leaf_type?: string;
11981
+ /**
11982
+ * Specific subtype of the target objects.
11983
+ * @format text
11984
+ */
11985
+ subtype?: string;
11986
+ }
11074
11987
  /** Type of link used to define the relationship. */
11075
11988
  export declare enum LinkType {
11076
11989
  CustomLink = "custom_link",
@@ -11175,6 +12088,11 @@ export interface LinksListRequest {
11175
12088
  * @format text
11176
12089
  */
11177
12090
  cursor?: string;
12091
+ /**
12092
+ * The custom link types to filter for, otherwise if not present, all
12093
+ * custom link types are included.
12094
+ */
12095
+ custom_link_type?: string[];
11178
12096
  /**
11179
12097
  * The direction of link, which can either be outbound such that the
11180
12098
  * object is the source of the link, otherwise inbound where the object is
@@ -11294,6 +12212,10 @@ export declare enum MeerkatWidgetColumnFunctionType {
11294
12212
  Max = "max",
11295
12213
  Median = "median",
11296
12214
  Min = "min",
12215
+ P50 = "p50",
12216
+ P90 = "p90",
12217
+ P95 = "p95",
12218
+ P99 = "p99",
11297
12219
  Sum = "sum"
11298
12220
  }
11299
12221
  /**
@@ -11373,7 +12295,7 @@ export type Meeting = AtomBase & {
11373
12295
  */
11374
12296
  external_url?: string;
11375
12297
  /** The members in the meeting. */
11376
- members: UserSummary[];
12298
+ members: AtomSummary[];
11377
12299
  organizer?: UserSummary;
11378
12300
  parent?: AtomSummary;
11379
12301
  recording?: ArtifactSummary;
@@ -11388,6 +12310,12 @@ export type Meeting = AtomBase & {
11388
12310
  * @example "2023-01-01T12:00:00.000Z"
11389
12311
  */
11390
12312
  scheduled_date?: string;
12313
+ /**
12314
+ * The original source timestamp used for display.
12315
+ * @format date-time
12316
+ * @example "2023-01-01T12:00:00.000Z"
12317
+ */
12318
+ source_date?: string;
11391
12319
  /** The state of meeting. */
11392
12320
  state?: MeetingState;
11393
12321
  /**
@@ -11433,6 +12361,15 @@ export declare enum MeetingDirection {
11433
12361
  Internal = "internal",
11434
12362
  Outgoing = "outgoing"
11435
12363
  }
12364
+ /** meeting-search-summary */
12365
+ export type MeetingSearchSummary = SearchSummaryBase & {
12366
+ meeting: MeetingSummary;
12367
+ /**
12368
+ * The title of the meeting.
12369
+ * @format text
12370
+ */
12371
+ title?: string;
12372
+ };
11436
12373
  /** The state of meeting. */
11437
12374
  export declare enum MeetingState {
11438
12375
  Canceled = "canceled",
@@ -11448,6 +12385,11 @@ export declare enum MeetingState {
11448
12385
  export type MeetingSummary = AtomBaseSummary & {
11449
12386
  /** Sync information for records synced into/from DevRev. */
11450
12387
  sync_metadata?: SyncMetadataSummary;
12388
+ /**
12389
+ * Title of the meeting object.
12390
+ * @format text
12391
+ */
12392
+ title?: string;
11451
12393
  };
11452
12394
  /** meetings-count-request */
11453
12395
  export interface MeetingsCountRequest {
@@ -11499,6 +12441,11 @@ export interface MeetingsCountResponse {
11499
12441
  }
11500
12442
  /** meetings-create-request */
11501
12443
  export interface MeetingsCreateRequest {
12444
+ /**
12445
+ * The IDs of the artifacts to associate with the meeting.
12446
+ * @example ["ARTIFACT-12345"]
12447
+ */
12448
+ artifacts?: string[];
11502
12449
  /** The channel of meeting. */
11503
12450
  channel: MeetingChannel;
11504
12451
  /** Application-defined custom fields. */
@@ -11534,12 +12481,12 @@ export interface MeetingsCreateRequest {
11534
12481
  */
11535
12482
  external_url?: string;
11536
12483
  /**
11537
- * IDs of the users that were part of the meeting.
12484
+ * IDs of the users or groups that were part of the meeting.
11538
12485
  * @maxItems 800
11539
12486
  * @minItems 1
11540
12487
  * @example ["DEVU-12345"]
11541
12488
  */
11542
- members: string[];
12489
+ members?: string[];
11543
12490
  /**
11544
12491
  * The ID of the user who organized the meeting. If not provided, the
11545
12492
  * creator is set as the organizer.
@@ -11715,6 +12662,7 @@ export interface MeetingsListResponse {
11715
12662
  }
11716
12663
  /** meetings-update-request */
11717
12664
  export interface MeetingsUpdateRequest {
12665
+ artifacts?: MeetingsUpdateRequestArtifactIds;
11718
12666
  /** The channel of meeting. */
11719
12667
  channel?: MeetingChannel;
11720
12668
  /** Application-defined custom fields. */
@@ -11793,10 +12741,19 @@ export interface MeetingsUpdateRequest {
11793
12741
  */
11794
12742
  transcript?: string;
11795
12743
  }
12744
+ /** meetings-update-request-artifact-ids */
12745
+ export interface MeetingsUpdateRequestArtifactIds {
12746
+ /**
12747
+ * Sets the IDs to the provided artifact IDs.
12748
+ * @example ["ARTIFACT-12345"]
12749
+ */
12750
+ set?: string[];
12751
+ }
11796
12752
  /** meetings-update-request-members */
11797
12753
  export interface MeetingsUpdateRequestMembers {
11798
12754
  /**
11799
- * Sets the members to the provided user IDs. This must not be empty.
12755
+ * Sets the members to the provided user or group IDs. This must not
12756
+ * be empty.
11800
12757
  * @example ["DEVU-12345"]
11801
12758
  */
11802
12759
  set?: string[];
@@ -11867,6 +12824,34 @@ export declare enum MemberType {
11867
12824
  RevUser = "rev_user",
11868
12825
  SysUser = "sys_user"
11869
12826
  }
12827
+ /**
12828
+ * metadata
12829
+ * Key value pair.
12830
+ */
12831
+ export interface Metadata {
12832
+ /** Type of value. */
12833
+ type: MetadataType;
12834
+ /**
12835
+ * Key of the metadata.
12836
+ * @format text
12837
+ */
12838
+ key: string;
12839
+ /**
12840
+ * Value of the metadata.
12841
+ * @format text
12842
+ */
12843
+ value: string;
12844
+ }
12845
+ /** Type of value. */
12846
+ export declare enum MetadataType {
12847
+ Bool = "bool",
12848
+ Don = "don",
12849
+ Email = "email",
12850
+ Json = "json",
12851
+ Number = "number",
12852
+ String = "string",
12853
+ Url = "url"
12854
+ }
11870
12855
  /** metric-action-execute-request */
11871
12856
  export interface MetricActionExecuteRequest {
11872
12857
  action: MetricActionExecuteRequestAction;
@@ -12239,6 +13224,335 @@ export interface MetricsDataIngestRequest {
12239
13224
  */
12240
13225
  metrics: MetricsData[];
12241
13226
  }
13227
+ /** mobile-recording */
13228
+ export interface MobileRecording {
13229
+ app_launch: MobileRecordingAppLaunch;
13230
+ /**
13231
+ * The available RAM on device.
13232
+ * @format int64
13233
+ */
13234
+ available_ram: number;
13235
+ /**
13236
+ * The recording creation timestamp.
13237
+ * @format date-time
13238
+ * @example "2023-01-01T12:00:00.000Z"
13239
+ */
13240
+ created_at: string;
13241
+ device_metadata: DeviceMetadata;
13242
+ observability_sessions_log_data?: ObservabilitySessionsLogData;
13243
+ /** List of events captured in chronological order. */
13244
+ recording_events_timeline: MobileRecordingRecordingEventsTimeline[];
13245
+ /**
13246
+ * The unique recording identifier.
13247
+ * @format text
13248
+ */
13249
+ recording_id: string;
13250
+ /**
13251
+ * The Rev organization ID associated with this recording.
13252
+ * @format id
13253
+ * @example "REV-AbCdEfGh"
13254
+ */
13255
+ rev_org_id?: string;
13256
+ /**
13257
+ * The Rev user ID associated with this recording.
13258
+ * @format id
13259
+ */
13260
+ rev_user_id?: string;
13261
+ /**
13262
+ * The unique session identifier.
13263
+ * @format text
13264
+ */
13265
+ session_id: string;
13266
+ /**
13267
+ * The total RAM available on device.
13268
+ * @format int64
13269
+ */
13270
+ total_ram: number;
13271
+ /** Additional attributes associated with the user. */
13272
+ user_attributes?: object;
13273
+ /** Video playback data for the recording */
13274
+ video_playback_data?: MobileRecordingVideoPlaybackData[];
13275
+ }
13276
+ /** mobile-recording-app-launch */
13277
+ export interface MobileRecordingAppLaunch {
13278
+ /**
13279
+ * The launch time of the application in milliseconds.
13280
+ * @format int64
13281
+ */
13282
+ launch_time_ms: number;
13283
+ launch_type: MobileRecordingAppLaunchLaunchType;
13284
+ }
13285
+ export declare enum MobileRecordingAppLaunchLaunchType {
13286
+ Cold = "cold",
13287
+ Hot = "hot"
13288
+ }
13289
+ /** mobile-recording-recording-events-timeline */
13290
+ export interface MobileRecordingRecordingEventsTimeline {
13291
+ /** List of coordinates associated with the event. */
13292
+ coordinates?: MobileRecordingRecordingEventsTimelineCoordinate[];
13293
+ /**
13294
+ * Custom tag associated with the event.
13295
+ * @format text
13296
+ */
13297
+ custom_tag?: string;
13298
+ event_name?: MobileRecordingRecordingEventsTimelineEventName;
13299
+ /** Additional properties associated with the event. */
13300
+ event_properties?: object;
13301
+ event_type: MobileRecordingRecordingEventsTimelineEventType;
13302
+ /**
13303
+ * Name of exception class if event is an exception.
13304
+ * @format text
13305
+ */
13306
+ exception_class_name?: string;
13307
+ /**
13308
+ * Tag associated with the exception.
13309
+ * @format text
13310
+ */
13311
+ exception_tag?: string;
13312
+ input_type?: MobileRecordingRecordingEventsTimelineInputType;
13313
+ /**
13314
+ * Name of the tag, message or event.
13315
+ * @format text
13316
+ */
13317
+ name?: string;
13318
+ /** Whether the event indicates non-responsiveness. */
13319
+ non_responsive?: boolean;
13320
+ /**
13321
+ * Name of the object associated with the event.
13322
+ * @format text
13323
+ */
13324
+ object_name?: string;
13325
+ /** Additional properties associated with the API request. */
13326
+ request_properties?: object;
13327
+ /** Additional properties associated with the API response. */
13328
+ response_properties?: object;
13329
+ /**
13330
+ * Name of the screen/activity where event occurred.
13331
+ * @format text
13332
+ */
13333
+ screen?: string;
13334
+ /**
13335
+ * Timestamp offset in milliseconds from the start of the recording
13336
+ * when the event occurred. This value is used to synchronize events
13337
+ * with video playback on the timeline and to determine the exact
13338
+ * moment when the event happened during the session.
13339
+ * @format int64
13340
+ */
13341
+ timestamp_offset_ms?: number;
13342
+ }
13343
+ /** mobile-recording-recording-events-timeline-coordinate */
13344
+ export interface MobileRecordingRecordingEventsTimelineCoordinate {
13345
+ /**
13346
+ * The x-coordinate on the screen where the event occurred.
13347
+ * @format double
13348
+ */
13349
+ x: number;
13350
+ /**
13351
+ * The y-coordinate on the screen where the event occurred.
13352
+ * @format double
13353
+ */
13354
+ y: number;
13355
+ }
13356
+ export declare enum MobileRecordingRecordingEventsTimelineEventName {
13357
+ Anr = "anr",
13358
+ Api = "api",
13359
+ AppLaunch = "app_launch",
13360
+ BackButtonPressed = "back_button_pressed",
13361
+ ConsentAccepted = "consent_accepted",
13362
+ Created = "created",
13363
+ Destroyed = "destroyed",
13364
+ DoubleTap = "double_tap",
13365
+ Error = "error",
13366
+ Event = "event",
13367
+ Exception = "exception",
13368
+ HomeButtonPressed = "home_button_pressed",
13369
+ LongPress = "long_press",
13370
+ Msg = "msg",
13371
+ PauseRecordingCalled = "pause_recording_called",
13372
+ Paused = "paused",
13373
+ Pinch = "pinch",
13374
+ RageTap = "rage_tap",
13375
+ ResumeRecordingCalled = "resume_recording_called",
13376
+ Resumed = "resumed",
13377
+ SavedInstanceState = "saved_instance_state",
13378
+ SingleTap = "single_tap",
13379
+ Started = "started",
13380
+ Stopped = "stopped",
13381
+ Swipe = "swipe",
13382
+ SwipeDown = "swipe_down",
13383
+ SwipeLeft = "swipe_left",
13384
+ SwipeRight = "swipe_right",
13385
+ SwipeUp = "swipe_up",
13386
+ Tag = "tag",
13387
+ Zoom = "zoom"
13388
+ }
13389
+ export declare enum MobileRecordingRecordingEventsTimelineEventType {
13390
+ Plug = "plug",
13391
+ System = "system",
13392
+ User = "user"
13393
+ }
13394
+ export declare enum MobileRecordingRecordingEventsTimelineInputType {
13395
+ SystemEventOs = "system_event_os",
13396
+ ToolTypeEraser = "tool_type_eraser",
13397
+ ToolTypeFinger = "tool_type_finger",
13398
+ ToolTypeMouse = "tool_type_mouse",
13399
+ ToolTypeStylus = "tool_type_stylus",
13400
+ ToolTypeUnknown = "tool_type_unknown"
13401
+ }
13402
+ /** mobile-recording-video-playback-data */
13403
+ export interface MobileRecordingVideoPlaybackData {
13404
+ /**
13405
+ * Last frame number e.g. "0010".
13406
+ * @format text
13407
+ */
13408
+ end_frame?: string;
13409
+ /** Maps frame number to image name. */
13410
+ frame_image_map: Record<string, string>;
13411
+ /** Sorted frame numbers e.g. ["0000", "0001", "0002"]. */
13412
+ frames: string[];
13413
+ /**
13414
+ * Presigned URL for the video frames.
13415
+ * @format text
13416
+ */
13417
+ presigned_url?: string;
13418
+ /**
13419
+ * First frame number e.g. "0000".
13420
+ * @format text
13421
+ */
13422
+ start_frame?: string;
13423
+ }
13424
+ /** mobile-session */
13425
+ export interface MobileSession {
13426
+ /**
13427
+ * The session creation date.
13428
+ * @format date-time
13429
+ * @example "2023-01-01T12:00:00.000Z"
13430
+ */
13431
+ created_at: string;
13432
+ device_metadata: DeviceMetadata;
13433
+ /** Whether an exception occurred. */
13434
+ has_exception_occurred: boolean;
13435
+ /** Whether ANR occurred in the session. */
13436
+ is_anr: boolean;
13437
+ /** Whether crash occurred in the session. */
13438
+ is_crash: boolean;
13439
+ /** Whether rage tap occurred. */
13440
+ rage_tap: boolean;
13441
+ /** The list of recording IDs in this session. */
13442
+ recording_ids?: string[];
13443
+ /**
13444
+ * The Rev organization ID associated with this recording.
13445
+ * @format id
13446
+ * @example "REV-AbCdEfGh"
13447
+ */
13448
+ rev_org_id?: string;
13449
+ /**
13450
+ * The Rev user ID associated with this recording.
13451
+ * @format id
13452
+ */
13453
+ rev_user_id?: string;
13454
+ /**
13455
+ * The session duration in milliseconds.
13456
+ * @format int64
13457
+ */
13458
+ session_duration_ms: number;
13459
+ /**
13460
+ * The unique session identifier.
13461
+ * @format text
13462
+ */
13463
+ session_id: string;
13464
+ }
13465
+ /** mobile-sessions-filter */
13466
+ export interface MobileSessionsFilter {
13467
+ /** Filter by app versions. */
13468
+ app_version?: string[];
13469
+ /** Provides ways to specify date ranges on objects. */
13470
+ created_at?: DateFilter;
13471
+ custom_events?: MobileSessionsFilterCustomEventsFilter;
13472
+ /** Filter by device models. */
13473
+ device_model?: string[];
13474
+ /** Filter by exception occurrence. */
13475
+ has_exception_occurred?: boolean;
13476
+ /** Filter by anonymous users. */
13477
+ is_anonymous?: boolean;
13478
+ /** Filter by ANR occurrence. */
13479
+ is_anr?: boolean;
13480
+ /** Filter by crash occurrence. */
13481
+ is_crash?: boolean;
13482
+ /** Filter by device manufacturers. */
13483
+ manufacturer?: string[];
13484
+ /** Filter by network types. */
13485
+ network_type?: string[];
13486
+ /** Filter by OS versions. */
13487
+ os_version?: string[];
13488
+ /** Filter by rage tap. */
13489
+ rage_tap?: boolean;
13490
+ response_time_list?: MobileSessionsFilterResponseTimeListFilter;
13491
+ /**
13492
+ * Filter by Rev org.
13493
+ * @example ["REV-AbCdEfGh"]
13494
+ */
13495
+ rev_org?: string[];
13496
+ /** Filter by Rev user. */
13497
+ rev_user?: string[];
13498
+ /** Filter by screen name. */
13499
+ screen_name?: string[];
13500
+ /** Filter by session attributes. */
13501
+ session_attributes?: SessionCustomAttributeFilter[];
13502
+ session_duration?: MobileSessionsFilterSessionDurationRange;
13503
+ }
13504
+ /** mobile-sessions-filter-custom-events-filter */
13505
+ export interface MobileSessionsFilterCustomEventsFilter {
13506
+ /** Filter by event name. */
13507
+ event_name?: string[];
13508
+ /** Filter by exception class name. */
13509
+ exception_class_name?: string[];
13510
+ /** Filter by event properties. */
13511
+ properties_filters?: SessionCustomAttributeFilter[];
13512
+ }
13513
+ /** mobile-sessions-filter-response-time-list-filter */
13514
+ export interface MobileSessionsFilterResponseTimeListFilter {
13515
+ /** Filter by API name. */
13516
+ api_name?: string[];
13517
+ /** Filter by request properties. */
13518
+ request_properties?: SessionCustomAttributeFilter[];
13519
+ /** Filter by response properties. */
13520
+ response_properties?: SessionCustomAttributeFilter[];
13521
+ round_trip_time?: MobileSessionsFilterRoundTripTimeFilter;
13522
+ }
13523
+ /** mobile-sessions-filter-round-trip-time-filter */
13524
+ export interface MobileSessionsFilterRoundTripTimeFilter {
13525
+ /** Exact round trip time values in milliseconds to filter by. */
13526
+ equals_ms?: number[];
13527
+ range?: MobileSessionsFilterRoundTripTimeRange;
13528
+ }
13529
+ /** mobile-sessions-filter-round-trip-time-range */
13530
+ export interface MobileSessionsFilterRoundTripTimeRange {
13531
+ /**
13532
+ * The maximum round trip time value in milliseconds.
13533
+ * @format double
13534
+ */
13535
+ max_ms?: number;
13536
+ /**
13537
+ * The minimum round trip time value in milliseconds.
13538
+ * @format double
13539
+ */
13540
+ min_ms?: number;
13541
+ }
13542
+ /** mobile-sessions-filter-session-duration-range */
13543
+ export interface MobileSessionsFilterSessionDurationRange {
13544
+ /**
13545
+ * The maximum session duration in milliseconds.
13546
+ * @format int64
13547
+ */
13548
+ max_ms?: number;
13549
+ /**
13550
+ * The minimum session duration in milliseconds.
13551
+ * @format int64
13552
+ * @min 0
13553
+ */
13554
+ min_ms?: number;
13555
+ }
12242
13556
  /**
12243
13557
  * money
12244
13558
  * Money.
@@ -12292,6 +13606,191 @@ export type ObjectMemberSummary = AtomBaseSummary & {
12292
13606
  /** Sync information for records synced into/from DevRev. */
12293
13607
  sync_metadata?: SyncMetadataSummary;
12294
13608
  };
13609
+ /** observability-session */
13610
+ export type ObservabilitySession = (UtilRequiredKeys<MobileSession, 'session_id'> | UtilRequiredKeys<WebSession, 'session_id'>) & {
13611
+ type: ObservabilitySessionType;
13612
+ /** The platform type for the device. */
13613
+ platform?: DevicePlatform;
13614
+ /**
13615
+ * The unique session identifier.
13616
+ * @format text
13617
+ */
13618
+ session_id: string;
13619
+ };
13620
+ export declare enum ObservabilitySessionType {
13621
+ Mobile = "mobile",
13622
+ Web = "web"
13623
+ }
13624
+ /** observability-sessions-data-get-request */
13625
+ export interface ObservabilitySessionsDataGetRequest {
13626
+ /**
13627
+ * The unique identifier of the recording to retrieve in case of
13628
+ * mobile sessions.
13629
+ * @format text
13630
+ */
13631
+ recording_id?: string;
13632
+ /**
13633
+ * The unique identifier of the session containing the recording.
13634
+ * @format text
13635
+ */
13636
+ session_id: string;
13637
+ /**
13638
+ * The unique identifier of the tab to retrieve in case of web
13639
+ * sessions.
13640
+ * @format text
13641
+ */
13642
+ tab_id?: string;
13643
+ /**
13644
+ * The unique app ID to which the session belongs.
13645
+ * @format text
13646
+ */
13647
+ version_key: string;
13648
+ }
13649
+ /** observability-sessions-data-get-response */
13650
+ export type ObservabilitySessionsDataGetResponse = (MobileRecording | WebRecording) & {
13651
+ recording: ObservabilitySessionsDataGetResponseRecording;
13652
+ };
13653
+ export declare enum ObservabilitySessionsDataGetResponseRecording {
13654
+ MobileRecording = "mobile_recording",
13655
+ WebRecording = "web_recording"
13656
+ }
13657
+ /** observability-sessions-get-request */
13658
+ export interface ObservabilitySessionsGetRequest {
13659
+ /** The platform type for the device. */
13660
+ platform: DevicePlatform;
13661
+ /**
13662
+ * The unique identifier of the session to retrieve.
13663
+ * @format text
13664
+ * @minLength 1
13665
+ */
13666
+ session_id: string;
13667
+ /**
13668
+ * The unique app ID to which the session belongs.
13669
+ * @format text
13670
+ * @minLength 1
13671
+ */
13672
+ version_key: string;
13673
+ }
13674
+ /** observability-sessions-get-response */
13675
+ export interface ObservabilitySessionsGetResponse {
13676
+ session: ObservabilitySession;
13677
+ }
13678
+ /** observability-sessions-list-request */
13679
+ export type ObservabilitySessionsListRequest = (MobileSessionsFilter | WebSessionsFilter) & {
13680
+ type: ObservabilitySessionsListRequestType;
13681
+ /**
13682
+ * The cursor to resume iteration from. If not provided, then
13683
+ * iteration starts from the beginning.
13684
+ * @format text
13685
+ */
13686
+ cursor?: string;
13687
+ /**
13688
+ * The maximum number of sessions to return.
13689
+ * @format int32
13690
+ */
13691
+ limit?: number;
13692
+ /**
13693
+ * The iteration mode to use. If "after", then entries after the provided
13694
+ * cursor will be returned, or if no cursor is provided, then from the
13695
+ * beginning. If "before", then entries before the provided cursor will be
13696
+ * returned, or if no cursor is provided, then from the end. Entries will
13697
+ * always be returned in the specified sort-by order.
13698
+ */
13699
+ mode?: ListMode;
13700
+ /** The platform type for the device. */
13701
+ platform: DevicePlatform;
13702
+ /** The fields to sort the sessions by and the direction to sort them. */
13703
+ sort_by?: string[];
13704
+ /**
13705
+ * The unique app ID to which the session belongs.
13706
+ * @format text
13707
+ * @minLength 1
13708
+ */
13709
+ version_key: string;
13710
+ };
13711
+ export declare enum ObservabilitySessionsListRequestType {
13712
+ Mobile = "mobile",
13713
+ Web = "web"
13714
+ }
13715
+ /** observability-sessions-list-response */
13716
+ export interface ObservabilitySessionsListResponse {
13717
+ /**
13718
+ * The cursor used to iterate subsequent results in accordance to the
13719
+ * sort order. If not set, then no later elements exist.
13720
+ * @format text
13721
+ */
13722
+ next_cursor?: string;
13723
+ /**
13724
+ * The cursor used to iterate preceding results in accordance to the
13725
+ * sort order. If not set, then no prior elements exist.
13726
+ * @format text
13727
+ */
13728
+ prev_cursor?: string;
13729
+ /** The list of captured sessions. */
13730
+ sessions: ObservabilitySession[];
13731
+ }
13732
+ /** observability-sessions-log-data */
13733
+ export interface ObservabilitySessionsLogData {
13734
+ /** Whether this log represents an ANR (Application Not Responding). */
13735
+ is_anr?: boolean;
13736
+ /** Whether this log represents a crash. */
13737
+ is_crash?: boolean;
13738
+ /**
13739
+ * The actual log data content.
13740
+ * @format text
13741
+ */
13742
+ value?: string;
13743
+ }
13744
+ /** observability-timeline-event */
13745
+ export interface ObservabilityTimelineEvent {
13746
+ /**
13747
+ * Name of the custom event.
13748
+ * @format text
13749
+ */
13750
+ event?: string;
13751
+ /** Custom event properties. */
13752
+ event_details?: Record<string, string>;
13753
+ /** The type of timeline event. */
13754
+ event_type?: ObservabilityTimelineEventType;
13755
+ /** Whether this is a dead click event. */
13756
+ is_dead?: boolean;
13757
+ /** Whether this is a rage click event. */
13758
+ is_rage?: boolean;
13759
+ /**
13760
+ * Label for the event.
13761
+ * @format text
13762
+ */
13763
+ label?: string;
13764
+ /**
13765
+ * URL of the page where the event occurred.
13766
+ * @format text
13767
+ */
13768
+ page_url?: string;
13769
+ /**
13770
+ * Target element of the event.
13771
+ * @format text
13772
+ */
13773
+ target?: string;
13774
+ /**
13775
+ * Timestamp of the event.
13776
+ * @format date-time
13777
+ * @example "2023-01-01T12:00:00.000Z"
13778
+ */
13779
+ timestamp: string;
13780
+ /**
13781
+ * Value associated with the event.
13782
+ * @format text
13783
+ */
13784
+ value?: string;
13785
+ }
13786
+ /** The type of timeline event. */
13787
+ export declare enum ObservabilityTimelineEventType {
13788
+ Click = "click",
13789
+ FormChange = "form_change",
13790
+ Nav = "nav",
13791
+ PerfCapture = "perf_capture",
13792
+ RecordingStopped = "recording_stopped"
13793
+ }
12295
13794
  /** one-time-line-item-summary */
12296
13795
  export type OneTimeLineItemSummary = LineItemBaseSummary;
12297
13796
  /** operation-search-summary */
@@ -12399,6 +13898,11 @@ export type OrgSchedule = AtomBase & {
12399
13898
  * @example "2023-01-01T12:00:00.000Z"
12400
13899
  */
12401
13900
  valid_until?: string;
13901
+ /**
13902
+ * version number of this org schedule.
13903
+ * @format int64
13904
+ */
13905
+ version_number?: number;
12402
13906
  /**
12403
13907
  * If the organization schedule fragment specifies that the given day
12404
13908
  * belongs to a named period, a weekly schedule from this list with
@@ -12615,6 +14119,11 @@ export type OrgScheduleSummary = AtomBaseSummary & {
12615
14119
  * @example "2023-01-01T12:00:00.000Z"
12616
14120
  */
12617
14121
  valid_until?: string;
14122
+ /**
14123
+ * version number of this org schedule.
14124
+ * @format int64
14125
+ */
14126
+ version_number?: number;
12618
14127
  };
12619
14128
  /** org-schedules-create-request */
12620
14129
  export interface OrgSchedulesCreateRequest {
@@ -12676,6 +14185,12 @@ export interface OrgSchedulesGetRequest {
12676
14185
  * @format id
12677
14186
  */
12678
14187
  id: string;
14188
+ /**
14189
+ * Specific version of the organization schedule to retrieve. If not
14190
+ * provided, returns the latest version.
14191
+ * @format int64
14192
+ */
14193
+ version_number?: number;
12679
14194
  }
12680
14195
  /** org-schedules-get-response */
12681
14196
  export interface OrgSchedulesGetResponse {
@@ -13279,6 +14794,12 @@ export interface PartsUpdateRequestArtifacts {
13279
14794
  export type PartsUpdateRequestCapability = object;
13280
14795
  /** parts-update-request-enhancement */
13281
14796
  export interface PartsUpdateRequestEnhancement {
14797
+ /**
14798
+ * Updates the release notes of the enhancement.
14799
+ * @format text
14800
+ * @maxLength 32768
14801
+ */
14802
+ release_notes?: string;
13282
14803
  /**
13283
14804
  * Custom stage ID which will be used for updating the enhancement.
13284
14805
  * @format id
@@ -13418,6 +14939,29 @@ export interface PieWidgetVisualization {
13418
14939
  /** The Y-axis for a pie visualization. */
13419
14940
  y: PieVisualizationYAxis;
13420
14941
  }
14942
+ /**
14943
+ * ping-request
14944
+ * The request to ping the DevRev service.
14945
+ */
14946
+ export interface PingRequest {
14947
+ /**
14948
+ * DevRev partion ID. For example, dvrv-us-1 for the us-east-1 region.
14949
+ * @format text
14950
+ */
14951
+ devrev_partition?: string;
14952
+ }
14953
+ /**
14954
+ * ping-response
14955
+ * The response to pinging the DevRev service.
14956
+ */
14957
+ export interface PingResponse {
14958
+ /**
14959
+ * Time time at which the ping request was processed.
14960
+ * @format date-time
14961
+ * @example "2023-01-01T12:00:00.000Z"
14962
+ */
14963
+ timestamp: string;
14964
+ }
13421
14965
  /** preferences */
13422
14966
  export type Preferences = UserPreferences & {
13423
14967
  type: PreferencesType;
@@ -13625,7 +15169,7 @@ export interface QuestionAnswersCreateRequest {
13625
15169
  answer: string;
13626
15170
  /**
13627
15171
  * The articles that the question-answer applies to.
13628
- * @example ["ARTICLE-12345"]
15172
+ * @example ["ART-12345"]
13629
15173
  */
13630
15174
  applies_to_articles?: string[];
13631
15175
  /**
@@ -13648,7 +15192,7 @@ export interface QuestionAnswersCreateRequest {
13648
15192
  shared_with?: SetSharedWithMembership[];
13649
15193
  /**
13650
15194
  * The source of the question-answer.
13651
- * @example ["ARTICLE-12345"]
15195
+ * @example ["ART-12345"]
13652
15196
  */
13653
15197
  sources?: string[];
13654
15198
  /** Status of the question answer. */
@@ -13724,7 +15268,7 @@ export interface QuestionAnswersListRequest {
13724
15268
  /**
13725
15269
  * Filters for question-answer belonging to any of the provided
13726
15270
  * articles.
13727
- * @example ["ARTICLE-12345"]
15271
+ * @example ["ART-12345"]
13728
15272
  */
13729
15273
  applies_to_articles?: string[];
13730
15274
  /**
@@ -13843,7 +15387,7 @@ export interface QuestionAnswersUpdateRequest {
13843
15387
  export interface QuestionAnswersUpdateRequestAppliesToArticles {
13844
15388
  /**
13845
15389
  * Updates the article that the question-answer applies to.
13846
- * @example ["ARTICLE-12345"]
15390
+ * @example ["ART-12345"]
13847
15391
  */
13848
15392
  set?: string[];
13849
15393
  }
@@ -13873,7 +15417,7 @@ export interface QuestionAnswersUpdateRequestSharedWith {
13873
15417
  export interface QuestionAnswersUpdateRequestSources {
13874
15418
  /**
13875
15419
  * Sets the sources that generated the question-answer.
13876
- * @example ["ARTICLE-12345"]
15420
+ * @example ["ART-12345"]
13877
15421
  */
13878
15422
  set?: string[];
13879
15423
  }
@@ -13896,10 +15440,11 @@ export interface ReactionsListRequest {
13896
15440
  cursor?: string;
13897
15441
  /**
13898
15442
  * The emoji to list the reactors for. This can be the short name of
13899
- * the emoji (e.g. "joy"), or the code point (e.g. "1f602").
15443
+ * the emoji (e.g. "joy"), or the code point (e.g. "1f602"). If not
15444
+ * provided, all reactions for the object are returned.
13900
15445
  * @format text
13901
15446
  */
13902
- emoji: string;
15447
+ emoji?: string;
13903
15448
  /**
13904
15449
  * The maximum number of reactors to return.
13905
15450
  * @format int32
@@ -13914,6 +15459,12 @@ export interface ReactionsListRequest {
13914
15459
  }
13915
15460
  /** reactions-list-response */
13916
15461
  export interface ReactionsListResponse {
15462
+ /**
15463
+ * For each user who reacted, the corresponding emoji. This value may
15464
+ * be either the emoji's short name (such as "joy") or its Unicode
15465
+ * code point (such as "1f602").
15466
+ */
15467
+ emojis: string[];
13917
15468
  /**
13918
15469
  * The cursor that should be used to iterate the next sequence of
13919
15470
  * results, otherwise if not set, then no elements exist after.
@@ -14048,6 +15599,26 @@ export interface RemovedSlaMetricHistory {
14048
15599
  removed_at: string;
14049
15600
  removed_by: UserSummary;
14050
15601
  }
15602
+ /** replay-data */
15603
+ export interface ReplayData {
15604
+ /**
15605
+ * End time of the replay packet.
15606
+ * @format date-time
15607
+ * @example "2023-01-01T12:00:00.000Z"
15608
+ */
15609
+ end_time: string;
15610
+ /**
15611
+ * Presigned URL for the RRWeb packet.
15612
+ * @format text
15613
+ */
15614
+ presigned_url?: string;
15615
+ /**
15616
+ * Start time of the replay packet.
15617
+ * @format date-time
15618
+ * @example "2023-01-01T12:00:00.000Z"
15619
+ */
15620
+ start_time: string;
15621
+ }
14051
15622
  /**
14052
15623
  * resource
14053
15624
  * Resource details.
@@ -14982,6 +16553,8 @@ export type RolesApplyResponse = object;
14982
16553
  * A request to create a new role.
14983
16554
  */
14984
16555
  export interface RolesCreateRequest {
16556
+ /** Whether to allow private access to the role. */
16557
+ allow_private_access?: boolean;
14985
16558
  /** The caveats on the role. */
14986
16559
  caveats?: RolesCreateRequestCaveat[];
14987
16560
  /**
@@ -15449,6 +17022,12 @@ export interface SchemaFieldUiMetadata {
15449
17022
  * @format text
15450
17023
  */
15451
17024
  placeholder?: string;
17025
+ /**
17026
+ * Templatized search query to be used when rendering dropdown options
17027
+ * for id fields.
17028
+ * @format text
17029
+ */
17030
+ search_query?: string;
15452
17031
  /** Summary view UI hint overrides. */
15453
17032
  summary_view?: SchemaFieldSummaryViewUiMetadata;
15454
17033
  /**
@@ -15932,7 +17511,9 @@ export interface SearchCoreRequest {
15932
17511
  namespaces?: SearchNamespace[];
15933
17512
  /**
15934
17513
  * The query string. Search query language:
15935
- * https://docs.devrev.ai/product/search#fields
17514
+ * https://docs.devrev.ai/product/search#fields. Text and text phrases
17515
+ * will be truncated if they exceed 50 characters respectively;
17516
+ * filters will not be truncated.
15936
17517
  * @format text
15937
17518
  */
15938
17519
  query: string;
@@ -15980,12 +17561,14 @@ export declare enum SearchHybridNamespace {
15980
17561
  Dashboard = "dashboard",
15981
17562
  Dataset = "dataset",
15982
17563
  DevUser = "dev_user",
17564
+ Directory = "directory",
15983
17565
  Enhancement = "enhancement",
15984
17566
  Feature = "feature",
15985
17567
  Group = "group",
15986
17568
  Incident = "incident",
15987
17569
  Issue = "issue",
15988
17570
  Linkable = "linkable",
17571
+ Meeting = "meeting",
15989
17572
  Microservice = "microservice",
15990
17573
  ObjectMember = "object_member",
15991
17574
  Opportunity = "opportunity",
@@ -16021,20 +17604,13 @@ export interface SearchHybridRequest {
16021
17604
  /** The namespaces for hybrid search. */
16022
17605
  namespace: SearchHybridNamespace;
16023
17606
  /**
16024
- * The query string.
17607
+ * The query string. Text and text phrases will be truncated if they
17608
+ * exceed 50 characters respectively; filters will not be truncated.
16025
17609
  * @format text
16026
17610
  * @minLength 1
16027
17611
  * @maxLength 400
16028
17612
  */
16029
- query: string;
16030
- /**
16031
- * The weightage for semantic search. Values between 0 and 1 are
16032
- * accepted.
16033
- * @format float
16034
- * @min 0
16035
- * @max 1
16036
- */
16037
- semantic_weight?: number;
17613
+ query?: string;
16038
17614
  }
16039
17615
  /**
16040
17616
  * search-hybrid-response
@@ -16056,6 +17632,7 @@ export declare enum SearchNamespace {
16056
17632
  CustomWork = "custom_work",
16057
17633
  Dashboard = "dashboard",
16058
17634
  DevUser = "dev_user",
17635
+ Directory = "directory",
16059
17636
  Enhancement = "enhancement",
16060
17637
  Feature = "feature",
16061
17638
  Group = "group",
@@ -16080,7 +17657,7 @@ export declare enum SearchNamespace {
16080
17657
  Workflow = "workflow"
16081
17658
  }
16082
17659
  /** search-result */
16083
- export type SearchResult = (AccountSearchSummary | ArticleSearchSummary | ArtifactSearchSummary | ConversationSearchSummary | CustomObjectSearchSummary | DashboardSearchSummary | GroupSearchSummary | LinkSearchSummary | ObjectMemberSearchSummary | OperationSearchSummary | OrgSearchSummary | PartSearchSummary | QuestionAnswerSearchSummary | TagSearchSummary | UserSearchSummary | VistaSearchSummary | WorkSearchSummary | WorkflowSearchSummary) & {
17660
+ export type SearchResult = (AccountSearchSummary | ArticleSearchSummary | ArtifactSearchSummary | ConversationSearchSummary | CustomObjectSearchSummary | DashboardSearchSummary | DirectorySearchSummary | DmSearchSummary | GroupSearchSummary | LinkSearchSummary | MeetingSearchSummary | ObjectMemberSearchSummary | OperationSearchSummary | OrgSearchSummary | PartSearchSummary | QuestionAnswerSearchSummary | TagSearchSummary | UserSearchSummary | VistaSearchSummary | WorkSearchSummary | WorkflowSearchSummary) & {
16084
17661
  type: SearchResultType;
16085
17662
  };
16086
17663
  export declare enum SearchResultType {
@@ -16090,8 +17667,11 @@ export declare enum SearchResultType {
16090
17667
  Conversation = "conversation",
16091
17668
  CustomObject = "custom_object",
16092
17669
  Dashboard = "dashboard",
17670
+ Directory = "directory",
17671
+ Dm = "dm",
16093
17672
  Group = "group",
16094
17673
  Link = "link",
17674
+ Meeting = "meeting",
16095
17675
  ObjectMember = "object_member",
16096
17676
  Operation = "operation",
16097
17677
  Org = "org",
@@ -16339,7 +17919,8 @@ export type ServicePlan = AtomBase & {
16339
17919
  };
16340
17920
  /** The billing frequency of the service plan. */
16341
17921
  export declare enum ServicePlanBillingCycle {
16342
- Monthly = "monthly"
17922
+ Monthly = "monthly",
17923
+ Yearly = "yearly"
16343
17924
  }
16344
17925
  /**
16345
17926
  * The status of the service plan indicates its current state. If the
@@ -16353,6 +17934,52 @@ export declare enum ServicePlanStatus {
16353
17934
  Cancelled = "cancelled",
16354
17935
  Paused = "paused"
16355
17936
  }
17937
+ /** session-custom-attribute-filter */
17938
+ export type SessionCustomAttributeFilter = (Empty | SessionCustomAttributeFilterBoolFilter | SessionCustomAttributeFilterInt64Filter | SessionCustomAttributeFilterStringFilter) & {
17939
+ /**
17940
+ * Attribute path in JSON to filter by.
17941
+ * @format text
17942
+ */
17943
+ attribute_path: string;
17944
+ filter_type?: SessionCustomAttributeFilterFilterType;
17945
+ };
17946
+ /** session-custom-attribute-filter-bool-filter */
17947
+ export interface SessionCustomAttributeFilterBoolFilter {
17948
+ /** Filter by bool equals. */
17949
+ equals?: boolean;
17950
+ }
17951
+ export declare enum SessionCustomAttributeFilterFilterType {
17952
+ BoolFilter = "bool_filter",
17953
+ Int64Filter = "int64_filter",
17954
+ None = "none",
17955
+ StringFilter = "string_filter"
17956
+ }
17957
+ /** session-custom-attribute-filter-int64-filter */
17958
+ export interface SessionCustomAttributeFilterInt64Filter {
17959
+ /** Exact integer values to filter by. */
17960
+ equals?: number[];
17961
+ range?: SessionCustomAttributeFilterInt64Range;
17962
+ }
17963
+ /** session-custom-attribute-filter-int64-range */
17964
+ export interface SessionCustomAttributeFilterInt64Range {
17965
+ /**
17966
+ * The maximum value of the range.
17967
+ * @format int64
17968
+ */
17969
+ max?: number;
17970
+ /**
17971
+ * The minimum value of the range.
17972
+ * @format int64
17973
+ */
17974
+ min?: number;
17975
+ }
17976
+ /** session-custom-attribute-filter-string-filter */
17977
+ export interface SessionCustomAttributeFilterStringFilter {
17978
+ /** Substring values to filter by. */
17979
+ contains?: string[];
17980
+ /** Exact string values to filter by. */
17981
+ equals?: string[];
17982
+ }
16356
17983
  /** set-issue-selector */
16357
17984
  export interface SetIssueSelector {
16358
17985
  /**
@@ -17215,7 +18842,11 @@ export interface SnapKitActionRequestForm {
17215
18842
  * A SnapKit based widget.
17216
18843
  */
17217
18844
  export interface SnapKitBaseWidget {
17218
- snap_kit_execution?: string;
18845
+ snap_kit_execution?: SnapKitBaseWidgetSnapKitExecution;
18846
+ }
18847
+ export declare enum SnapKitBaseWidgetSnapKitExecution {
18848
+ SnapInExecution = "snap_in_execution",
18849
+ WorkflowExecution = "workflow_execution"
17219
18850
  }
17220
18851
  /** snap-widget */
17221
18852
  export type SnapWidget = (EmailPreviewWidget | StarterMessageNudgeWidget) & {
@@ -17339,6 +18970,17 @@ export declare enum SnapWidgetsCreateRequestType {
17339
18970
  export interface SnapWidgetsCreateResponse {
17340
18971
  snap_widget: SnapWidget;
17341
18972
  }
18973
+ /** space-filter */
18974
+ export interface SpaceFilter {
18975
+ /** Filters for the provided space IDs. */
18976
+ ids?: string[];
18977
+ /** Whether to include child spaces. */
18978
+ include_children?: boolean;
18979
+ /** Whether to include objects not associated with any space. */
18980
+ include_global?: boolean;
18981
+ /** Whether to include parent spaces. */
18982
+ include_parents?: boolean;
18983
+ }
17342
18984
  /**
17343
18985
  * stage
17344
18986
  * Describes the current stage of a object.
@@ -17359,7 +19001,7 @@ export type StageDiagram = AtomBase & {
17359
19001
  */
17360
19002
  leaf_type?: string;
17361
19003
  /**
17362
- * The human readable name of the stage diagram.
19004
+ * The name of the stage diagram.
17363
19005
  * @format text
17364
19006
  */
17365
19007
  name?: string;
@@ -17368,14 +19010,18 @@ export type StageDiagram = AtomBase & {
17368
19010
  * diagram.
17369
19011
  */
17370
19012
  stages: StageNode[];
19013
+ /** Sync information for records synced into/from DevRev. */
19014
+ sync_metadata?: SyncMetadata;
17371
19015
  };
17372
19016
  /** stage-diagram-summary */
17373
19017
  export type StageDiagramSummary = AtomBaseSummary & {
17374
19018
  /**
17375
- * The human readable name of the stage diagram.
19019
+ * The name of the stage diagram.
17376
19020
  * @format text
17377
19021
  */
17378
19022
  name?: string;
19023
+ /** Sync information for records synced into/from DevRev. */
19024
+ sync_metadata?: SyncMetadataSummary;
17379
19025
  };
17380
19026
  /** stage-diagrams-create-request */
17381
19027
  export interface StageDiagramsCreateRequest {
@@ -17484,6 +19130,8 @@ export interface StageDiagramsUpdateResponse {
17484
19130
  export interface StageFilter {
17485
19131
  /** Filters for records in the provided stage(s) by name. */
17486
19132
  name?: string[];
19133
+ /** List of IDs of the custom stages which will be used for filtering. */
19134
+ stages?: string[];
17487
19135
  }
17488
19136
  /**
17489
19137
  * stage-init
@@ -18309,11 +19957,30 @@ export declare enum SyncInStatus {
18309
19957
  Staged = "staged",
18310
19958
  Succeeded = "succeeded"
18311
19959
  }
19960
+ /**
19961
+ * sync-in-summary
19962
+ * Information about the sync to DevRev.
19963
+ */
19964
+ export interface SyncInSummary {
19965
+ /** Status of the sync for the object. */
19966
+ status?: SyncInStatus;
19967
+ sync_unit?: SyncUnitSummary;
19968
+ }
18312
19969
  /**
18313
19970
  * sync-metadata
18314
19971
  * Sync information for records synced into/from DevRev.
18315
19972
  */
18316
19973
  export interface SyncMetadata {
19974
+ /**
19975
+ * ID of the record in the external system.
19976
+ * @format text
19977
+ */
19978
+ external_record_id?: string;
19979
+ /**
19980
+ * Type of the external record in the external system.
19981
+ * @format text
19982
+ */
19983
+ external_record_type?: string;
18317
19984
  /**
18318
19985
  * External record URL.
18319
19986
  * @format text
@@ -18381,6 +20048,8 @@ export interface SyncMetadataSummary {
18381
20048
  * @format text
18382
20049
  */
18383
20050
  external_reference?: string;
20051
+ /** Information about the sync to DevRev. */
20052
+ last_sync_in?: SyncInSummary;
18384
20053
  /**
18385
20054
  * Where the record was first created.
18386
20055
  * @format text
@@ -18430,6 +20099,7 @@ export declare enum SyncProgressState {
18430
20099
  LoadingAttachments = "loading_attachments",
18431
20100
  LoadingAttachmentsError = "loading_attachments_error",
18432
20101
  LoadingError = "loading_error",
20102
+ OrchestrationError = "orchestration_error",
18433
20103
  RecipeDiscovery = "recipe_discovery",
18434
20104
  RecipeDiscoveryError = "recipe_discovery_error",
18435
20105
  RecipeDiscoveryWaitingForUserInput = "recipe_discovery_waiting_for_user_input",
@@ -18456,10 +20126,17 @@ export interface SyncRun {
18456
20126
  * @example "2023-01-01T12:00:00.000Z"
18457
20127
  */
18458
20128
  ended_at?: string;
20129
+ item_analytics_artifact?: ArtifactSummary;
18459
20130
  /** The direction/mode of a sync run. */
18460
20131
  mode?: SyncRunMode;
18461
20132
  /** Progress. */
18462
20133
  progress?: SyncProgress;
20134
+ /**
20135
+ * The percentage of rate limit left during the sync run by the
20136
+ * connector.
20137
+ * @format int32
20138
+ */
20139
+ reserved_rate_limit_percentage?: number;
18463
20140
  /**
18464
20141
  * The time when a sync was started.
18465
20142
  * @format date-time
@@ -18492,9 +20169,25 @@ export interface SyncRunSummary {
18492
20169
  mode?: SyncRunMode;
18493
20170
  /** Progress. */
18494
20171
  progress?: SyncProgressSummary;
20172
+ /**
20173
+ * The percentage of rate limit left during the sync run by the
20174
+ * connector.
20175
+ * @format int32
20176
+ */
20177
+ reserved_rate_limit_percentage?: number;
18495
20178
  }
18496
20179
  /** sync-unit */
18497
20180
  export type SyncUnit = AtomBase & {
20181
+ /**
20182
+ * The name of the sync unit in the external system.
20183
+ * @format text
20184
+ */
20185
+ external_sync_unit_name?: string;
20186
+ /**
20187
+ * The ID of the external system.
20188
+ * @format text
20189
+ */
20190
+ external_system_id?: string;
18498
20191
  /**
18499
20192
  * The name of the external system.
18500
20193
  * @format text
@@ -18515,6 +20208,21 @@ export type SyncUnit = AtomBase & {
18515
20208
  };
18516
20209
  /** sync-unit-summary */
18517
20210
  export type SyncUnitSummary = AtomBaseSummary & {
20211
+ /**
20212
+ * The name of the sync unit in the external system.
20213
+ * @format text
20214
+ */
20215
+ external_sync_unit_name?: string;
20216
+ /**
20217
+ * The ID of the external system.
20218
+ * @format text
20219
+ */
20220
+ external_system_id?: string;
20221
+ /**
20222
+ * The name of the external system.
20223
+ * @format text
20224
+ */
20225
+ external_system_name?: string;
18518
20226
  external_system_type?: ExternalSystemType;
18519
20227
  /** The flag signaling if sync unit is archived. */
18520
20228
  is_archived?: boolean;
@@ -18730,6 +20438,8 @@ export type Tag = AtomBase & {
18730
20438
  */
18731
20439
  name: string;
18732
20440
  style_new?: TagStyle;
20441
+ /** Sync information for records synced into/from DevRev. */
20442
+ sync_metadata?: SyncMetadata;
18733
20443
  };
18734
20444
  /** tag-search-summary */
18735
20445
  export type TagSearchSummary = SearchSummaryBase & {
@@ -18761,6 +20471,8 @@ export type TagSummary = AtomBaseSummary & {
18761
20471
  */
18762
20472
  name: string;
18763
20473
  style_new?: TagStyleSummary;
20474
+ /** Sync information for records synced into/from DevRev. */
20475
+ sync_metadata?: SyncMetadataSummary;
18764
20476
  };
18765
20477
  /** tag-with-value */
18766
20478
  export interface TagWithValue {
@@ -18979,6 +20691,8 @@ export type Ticket = WorkBase & {
18979
20691
  group?: GroupSummary;
18980
20692
  /** Whether the object is frozen or not. */
18981
20693
  is_frozen?: boolean;
20694
+ /** Whether the ticket is spam. */
20695
+ is_spam?: boolean;
18982
20696
  /** Whether the ticket needs a response. */
18983
20697
  needs_response?: boolean;
18984
20698
  rev_org?: OrgSummary;
@@ -19356,6 +21070,8 @@ export interface TimelineEntriesListRequest {
19356
21070
  * @example "PROD-12345"
19357
21071
  */
19358
21072
  object: string;
21073
+ /** Filters for entries to be displayed on the provided panel(s). */
21074
+ panels?: TimelineEntryPanel[];
19359
21075
  /**
19360
21076
  * The visibility of the timeline entries to filter for. Note this is
19361
21077
  * a strict filter, such that only entries with the exact visibilities
@@ -20157,7 +21873,10 @@ export interface UpdateCommandSurface {
20157
21873
  /** Surfaces from where this command can be invoked. */
20158
21874
  surface?: CommandSurfaceSurface;
20159
21875
  }
20160
- /** update-external-source-data-comp */
21876
+ /**
21877
+ * update-external-source-data-comp
21878
+ * Update object for ExternalSourceDataComp.
21879
+ */
20161
21880
  export interface UpdateExternalSourceDataComp {
20162
21881
  /**
20163
21882
  * Timestamp when the object was closed in the source system.
@@ -20371,6 +22090,16 @@ export interface UpdateSyncIn {
20371
22090
  }
20372
22091
  /** update-sync-metadata */
20373
22092
  export interface UpdateSyncMetadata {
22093
+ /**
22094
+ * ID of the record in the external system.
22095
+ * @format text
22096
+ */
22097
+ external_record_id?: string;
22098
+ /**
22099
+ * Type of the external record in the external system.
22100
+ * @format text
22101
+ */
22102
+ external_record_type?: string;
20374
22103
  /**
20375
22104
  * External record URL.
20376
22105
  * @format text
@@ -20555,6 +22284,12 @@ export interface ViewOverride {
20555
22284
  * @format text
20556
22285
  */
20557
22286
  placeholder?: string;
22287
+ /**
22288
+ * Templatized search query to be used when rendering dropdown options
22289
+ * for id fields.
22290
+ * @format text
22291
+ */
22292
+ search_query?: string;
20558
22293
  /**
20559
22294
  * Tooltip for the field.
20560
22295
  * @format text
@@ -21044,6 +22779,24 @@ export type VisualizationAxisDrillThrough = object;
21044
22779
  * The scrollbar configuration for chart.
21045
22780
  */
21046
22781
  export type VisualizationScrollbar = object;
22782
+ /** web-console-metadata */
22783
+ export interface WebConsoleMetadata {
22784
+ /**
22785
+ * Number of error logs in the session.
22786
+ * @format int64
22787
+ */
22788
+ error?: number;
22789
+ /**
22790
+ * Number of info logs in the session.
22791
+ * @format int64
22792
+ */
22793
+ log?: number;
22794
+ /**
22795
+ * Number of warning logs in the session.
22796
+ * @format int64
22797
+ */
22798
+ warn?: number;
22799
+ }
21047
22800
  /** web-crawler-job */
21048
22801
  export type WebCrawlerJob = AtomBase & {
21049
22802
  /**
@@ -21066,6 +22819,11 @@ export type WebCrawlerJob = AtomBase & {
21066
22819
  * @format int32
21067
22820
  */
21068
22821
  frequency?: number;
22822
+ /**
22823
+ * Language code in which crawled articles should be created.
22824
+ * @format text
22825
+ */
22826
+ language_code?: string;
21069
22827
  /**
21070
22828
  * Specifies the maximum recursion depth from the seed URL that we
21071
22829
  * will crawl. If this value is -1, there is no limit on recursion
@@ -21190,6 +22948,12 @@ export interface WebCrawlerJobsCreateRequest {
21190
22948
  * @format int32
21191
22949
  */
21192
22950
  frequency?: number;
22951
+ /**
22952
+ * Language code of the articles created by the job.
22953
+ * @format text
22954
+ * @maxLength 10
22955
+ */
22956
+ language_code?: string;
21193
22957
  /**
21194
22958
  * The maximum depth to crawl.
21195
22959
  * @format int32
@@ -21307,15 +23071,276 @@ export interface WebCrawlerJobsListResponse {
21307
23071
  * sort order. If not set, then no later elements exist.
21308
23072
  * @format text
21309
23073
  */
21310
- next_cursor?: string;
23074
+ next_cursor?: string;
23075
+ /**
23076
+ * The cursor used to iterate preceding results in accordance to the
23077
+ * sort order. If not set, then no prior elements exist.
23078
+ * @format text
23079
+ */
23080
+ prev_cursor?: string;
23081
+ /** The list of jobs. */
23082
+ web_crawler_jobs: WebCrawlerJob[];
23083
+ }
23084
+ /** web-device-metadata */
23085
+ export interface WebDeviceMetadata {
23086
+ /** The type of device used in a web session. */
23087
+ type: DeviceType;
23088
+ /**
23089
+ * The browser name.
23090
+ * @format text
23091
+ */
23092
+ browser?: string;
23093
+ /**
23094
+ * The browser version.
23095
+ * @format text
23096
+ */
23097
+ browser_version?: string;
23098
+ /**
23099
+ * The device model.
23100
+ * @format text
23101
+ */
23102
+ model?: string;
23103
+ /**
23104
+ * The network type (e.g. 4g, 3g, wifi).
23105
+ * @format text
23106
+ */
23107
+ network_type?: string;
23108
+ /**
23109
+ * The operating system.
23110
+ * @format text
23111
+ */
23112
+ os?: string;
23113
+ }
23114
+ /** web-network-metadata */
23115
+ export interface WebNetworkMetadata {
23116
+ /** Map of HTTP status codes to their occurrence counts */
23117
+ status_counts: Record<string, number>;
23118
+ }
23119
+ /** web-recording */
23120
+ export interface WebRecording {
23121
+ console_metadata?: WebConsoleMetadata;
23122
+ /**
23123
+ * The recording creation timestamp.
23124
+ * @format date-time
23125
+ * @example "2023-01-01T12:00:00.000Z"
23126
+ */
23127
+ created_at: string;
23128
+ /**
23129
+ * The number of dead clicks in the session.
23130
+ * @format int64
23131
+ */
23132
+ dead_click_count: number;
23133
+ device_metadata: WebDeviceMetadata;
23134
+ /**
23135
+ * The title of the first page visited.
23136
+ * @format text
23137
+ */
23138
+ first_page_title?: string;
23139
+ /**
23140
+ * The URL of the first page visited.
23141
+ * @format text
23142
+ */
23143
+ first_page_url?: string;
23144
+ network_metadata?: WebNetworkMetadata;
23145
+ /**
23146
+ * The page load time in milliseconds.
23147
+ * @format int64
23148
+ */
23149
+ page_load_time_ms?: number;
23150
+ /**
23151
+ * The number of rage clicks in the session.
23152
+ * @format int64
23153
+ */
23154
+ rage_click_count: number;
23155
+ /** RRWeb replay packets */
23156
+ replay_data: ReplayData[];
23157
+ /**
23158
+ * The Rev organization ID associated with this recording.
23159
+ * @format id
23160
+ * @example "REV-AbCdEfGh"
23161
+ */
23162
+ rev_org_id?: string;
23163
+ /**
23164
+ * The Rev user ID associated with this recording.
23165
+ * @format id
23166
+ */
23167
+ rev_user_id?: string;
23168
+ session_attributes?: WebSessionAttributes;
23169
+ /**
23170
+ * The unique session identifier.
23171
+ * @format text
23172
+ */
23173
+ session_id: string;
23174
+ /**
23175
+ * The unique tab identifier.
23176
+ * @format text
23177
+ */
23178
+ tab_id: string;
23179
+ timeline_data: WebTimelineData;
23180
+ }
23181
+ /** web-session */
23182
+ export interface WebSession {
23183
+ console_metadata?: WebConsoleMetadata;
23184
+ /**
23185
+ * The session creation timestamp.
23186
+ * @format date-time
23187
+ * @example "2023-01-01T12:00:00.000Z"
23188
+ */
23189
+ created_at: string;
23190
+ /**
23191
+ * The number of dead clicks in the session.
23192
+ * @format int64
23193
+ */
23194
+ dead_click_count: number;
23195
+ device_metadata: WebDeviceMetadata;
23196
+ /**
23197
+ * The title of the first page visited.
23198
+ * @format text
23199
+ */
23200
+ first_page_title?: string;
23201
+ /**
23202
+ * The URL of the first page visited.
23203
+ * @format text
23204
+ */
23205
+ first_page_url?: string;
23206
+ network_metadata?: WebNetworkMetadata;
23207
+ /**
23208
+ * The page load time in milliseconds.
23209
+ * @format int64
23210
+ */
23211
+ page_load_time_ms?: number;
23212
+ /**
23213
+ * The number of rage clicks in the session.
23214
+ * @format int64
23215
+ */
23216
+ rage_click_count: number;
23217
+ /**
23218
+ * The Rev organization ID associated with this recording.
23219
+ * @format id
23220
+ * @example "REV-AbCdEfGh"
23221
+ */
23222
+ rev_org_id?: string;
23223
+ /**
23224
+ * The Rev user ID associated with this recording.
23225
+ * @format id
23226
+ */
23227
+ rev_user_id?: string;
23228
+ session_attributes?: WebSessionAttributes;
23229
+ /**
23230
+ * The session duration in milliseconds.
23231
+ * @format int64
23232
+ */
23233
+ session_duration_ms: number;
23234
+ /**
23235
+ * The unique session identifier.
23236
+ * @format text
23237
+ */
23238
+ session_id: string;
23239
+ /** The list of tab IDs in this session. */
23240
+ tab_ids?: string[];
23241
+ }
23242
+ /** web-session-attributes */
23243
+ export interface WebSessionAttributes {
23244
+ /** Map of custom web attribute names to their string values */
23245
+ attributes: Record<string, string>;
23246
+ }
23247
+ /** web-sessions-filter */
23248
+ export interface WebSessionsFilter {
23249
+ /** Filter by browser names. */
23250
+ browser?: string[];
23251
+ /** Filter by browser versions. */
23252
+ browser_version?: string[];
23253
+ console_logs?: WebSessionsFilterConsoleLogsFilter;
23254
+ /** Provides ways to specify date ranges on objects. */
23255
+ created_at?: DateFilter;
23256
+ custom_events?: WebSessionsFilterCustomEventsFilter;
23257
+ /** Filter by device types (desktop|mobile). */
23258
+ device_type?: string[];
23259
+ events?: WebSessionsFilterEventsFilter;
23260
+ /** Filter by sessions with console errors. */
23261
+ has_console_errors?: boolean;
23262
+ /** Filter by sessions with dead clicks. */
23263
+ has_dead_clicks?: boolean;
23264
+ /** Filter by sessions with network errors. */
23265
+ has_network_errors?: boolean;
23266
+ /** Filter by sessions with rage clicks. */
23267
+ has_rage_clicks?: boolean;
23268
+ /** Filter by if user is anonymous. */
23269
+ is_anonymous?: boolean;
23270
+ network_logs?: WebSessionsFilterNetworkLogsFilter;
23271
+ /** Filter by network types. */
23272
+ network_type?: string[];
23273
+ /** Filter by normalized URL. */
23274
+ normalized_url?: string[];
23275
+ /** Filter by operating systems. */
23276
+ os?: string[];
23277
+ /** Filter by page name. */
23278
+ page_name?: string[];
23279
+ /** Filter by page URL. */
23280
+ page_url?: string[];
23281
+ /**
23282
+ * Filter by Rev org.
23283
+ * @example ["REV-AbCdEfGh"]
23284
+ */
23285
+ rev_org?: string[];
23286
+ /** Filter by Rev user. */
23287
+ rev_user?: string[];
23288
+ /** Filter by session attributes. */
23289
+ session_attributes?: SessionCustomAttributeFilter[];
23290
+ session_duration?: WebSessionsFilterSessionDurationRange;
23291
+ }
23292
+ /** web-sessions-filter-console-logs-filter */
23293
+ export interface WebSessionsFilterConsoleLogsFilter {
23294
+ /** Full text search on log body. */
23295
+ body?: string[];
23296
+ /** Filter by full URL. */
23297
+ full_url?: string[];
23298
+ /** Filter by log type. */
23299
+ log_type?: string[];
23300
+ }
23301
+ /** web-sessions-filter-custom-events-filter */
23302
+ export interface WebSessionsFilterCustomEventsFilter {
23303
+ /** Filter by custom event properties. */
23304
+ event_details_filters?: SessionCustomAttributeFilter[];
23305
+ /** Filter by customevent name. */
23306
+ event_name?: string[];
23307
+ }
23308
+ /** web-sessions-filter-events-filter */
23309
+ export interface WebSessionsFilterEventsFilter {
23310
+ /** Filter by dead click events. */
23311
+ is_dead?: boolean;
23312
+ /** Filter by rage click events. */
23313
+ is_rage?: boolean;
23314
+ /** Filter by value. */
23315
+ value?: string[];
23316
+ }
23317
+ /** web-sessions-filter-network-logs-filter */
23318
+ export interface WebSessionsFilterNetworkLogsFilter {
23319
+ /** Filter by request method. */
23320
+ request_method?: string[];
23321
+ /** Filter by request URL. */
23322
+ request_url?: string[];
23323
+ /** Filter by response status code. */
23324
+ response_status?: number[];
23325
+ }
23326
+ /** web-sessions-filter-session-duration-range */
23327
+ export interface WebSessionsFilterSessionDurationRange {
23328
+ /**
23329
+ * The maximum session duration in milliseconds.
23330
+ * @format int64
23331
+ */
23332
+ max_ms?: number;
21311
23333
  /**
21312
- * The cursor used to iterate preceding results in accordance to the
21313
- * sort order. If not set, then no prior elements exist.
21314
- * @format text
23334
+ * The minimum session duration in milliseconds.
23335
+ * @format int64
23336
+ * @min 0
21315
23337
  */
21316
- prev_cursor?: string;
21317
- /** The list of jobs. */
21318
- web_crawler_jobs: WebCrawlerJob[];
23338
+ min_ms?: number;
23339
+ }
23340
+ /** web-timeline-data */
23341
+ export interface WebTimelineData {
23342
+ /** List of timeline events. */
23343
+ events: ObservabilityTimelineEvent[];
21319
23344
  }
21320
23345
  /** webhook */
21321
23346
  export type Webhook = AtomBase & {
@@ -21456,6 +23481,9 @@ export declare enum WebhookEventType {
21456
23481
  ArticleCreated = "article_created",
21457
23482
  ArticleDeleted = "article_deleted",
21458
23483
  ArticleUpdated = "article_updated",
23484
+ ArtifactCreated = "artifact_created",
23485
+ ArtifactDeleted = "artifact_deleted",
23486
+ ArtifactUpdated = "artifact_updated",
21459
23487
  ConversationCreated = "conversation_created",
21460
23488
  ConversationDeleted = "conversation_deleted",
21461
23489
  ConversationUpdated = "conversation_updated",
@@ -21652,7 +23680,10 @@ export interface WebhooksGetResponse {
21652
23680
  * webhooks-list-request
21653
23681
  * The request to list the webhooks.
21654
23682
  */
21655
- export type WebhooksListRequest = object;
23683
+ export interface WebhooksListRequest {
23684
+ /** Filters for webhooks with the provided statuses. */
23685
+ status?: WebhookStatus[];
23686
+ }
21656
23687
  /**
21657
23688
  * webhooks-list-response
21658
23689
  * The response to listing the webhooks.
@@ -21788,6 +23819,12 @@ export type Widget = AtomBase & {
21788
23819
  * @format text
21789
23820
  */
21790
23821
  description: string;
23822
+ /**
23823
+ * The insights associated with the widget for agent generated
23824
+ * widgets.
23825
+ * @format text
23826
+ */
23827
+ insights?: string;
21791
23828
  /** Whether the widget is a draft widget. */
21792
23829
  is_draft?: boolean;
21793
23830
  /** Whether the widget is a system widget. */
@@ -21807,6 +23844,8 @@ export type Widget = AtomBase & {
21807
23844
  * contain multiple sub-widgets.
21808
23845
  */
21809
23846
  sub_widgets: SubWidget[];
23847
+ /** The table manifest for the widget. */
23848
+ table_manifest?: WidgetTableManifest;
21810
23849
  /**
21811
23850
  * The title of the widget.
21812
23851
  * @format text
@@ -21846,7 +23885,7 @@ export interface WidgetColumnProjection {
21846
23885
  /** Whether the column is derived. */
21847
23886
  is_derived?: boolean;
21848
23887
  /** A meerkat specific column projection. */
21849
- meerkat_schema?: MeerkatWidgetColumnProjection;
23888
+ meerkat_schema: MeerkatWidgetColumnProjection;
21850
23889
  /**
21851
23890
  * The reference name of the column.
21852
23891
  * @format text
@@ -22068,6 +24107,11 @@ export type WidgetSummary = AtomBaseSummary & {
22068
24107
  */
22069
24108
  title: string;
22070
24109
  };
24110
+ /**
24111
+ * widget-table-manifest
24112
+ * The table manifest for the widget.
24113
+ */
24114
+ export type WidgetTableManifest = object;
22071
24115
  /**
22072
24116
  * widget-visualization
22073
24117
  * The visualization for a widget. This includes the type of visualization
@@ -22091,6 +24135,11 @@ export interface WidgetVisualization {
22091
24135
  * to donut charts.
22092
24136
  */
22093
24137
  donut?: DonutWidgetVisualization;
24138
+ /**
24139
+ * A Flame Graph chart visualization configuration. Includes metadata
24140
+ * specific to flame graph charts.
24141
+ */
24142
+ flame_graph?: FlameGraphWidgetVisualization;
22094
24143
  /**
22095
24144
  * A heatmap chart visualization configuration. Includes metadata specific
22096
24145
  * to heatmap charts.
@@ -22140,6 +24189,8 @@ export declare enum WidgetVisualizationType {
22140
24189
  Column = "column",
22141
24190
  Combination = "combination",
22142
24191
  Donut = "donut",
24192
+ Flame = "flame",
24193
+ Gantt = "gantt",
22143
24194
  Heatmap = "heatmap",
22144
24195
  Kanban = "kanban",
22145
24196
  Line = "line",
@@ -22288,6 +24339,78 @@ export type WorkflowSearchSummary = SearchSummaryBase & {
22288
24339
  };
22289
24340
  /** workflow-summary */
22290
24341
  export type WorkflowSummary = AtomBaseSummary;
24342
+ /** works-count-request */
24343
+ export interface WorksCountRequest {
24344
+ /** Filters for work of the provided types. */
24345
+ type?: WorkType[];
24346
+ /** Provides ways to specify date ranges on objects. */
24347
+ actual_close_date?: DateFilter;
24348
+ /**
24349
+ * Filters for work belonging to any of the provided parts.
24350
+ * @example ["PROD-12345"]
24351
+ */
24352
+ applies_to_part?: string[];
24353
+ /**
24354
+ * Filters for work created by any of these users.
24355
+ * @example ["DEVU-12345"]
24356
+ */
24357
+ created_by?: string[];
24358
+ /** Provides ways to specify date ranges on objects. */
24359
+ created_date?: DateFilter;
24360
+ /** Filters for custom fields. */
24361
+ custom_fields?: object;
24362
+ /** Filters for work with any of the provided external references. */
24363
+ external_ref?: string[];
24364
+ issue?: WorksFilterIssue;
24365
+ /**
24366
+ * Filters for work modified by any of these users.
24367
+ * @example ["DEVU-12345"]
24368
+ */
24369
+ modified_by?: string[];
24370
+ /** Provides ways to specify date ranges on objects. */
24371
+ modified_date?: DateFilter;
24372
+ opportunity?: WorksFilterOpportunity;
24373
+ /**
24374
+ * Filters for work owned by any of these users.
24375
+ * @example ["DEVU-12345"]
24376
+ */
24377
+ owned_by?: string[];
24378
+ /**
24379
+ * Filters for work reported by any of these users.
24380
+ * @example ["DEVU-12345"]
24381
+ */
24382
+ reported_by?: string[];
24383
+ /** The filter for stages. */
24384
+ stage?: StageFilter;
24385
+ staged_info?: StagedInfoFilter;
24386
+ /** Filters for work with any of the provided states. */
24387
+ state?: string[];
24388
+ sync_metadata?: SyncMetadataFilter;
24389
+ /**
24390
+ * Filters for work with any of the provided tags.
24391
+ * @example ["TAG-12345"]
24392
+ */
24393
+ tags?: string[];
24394
+ /** Provides ways to specify date ranges on objects. */
24395
+ target_close_date?: DateFilter;
24396
+ ticket?: WorksFilterTicket;
24397
+ /**
24398
+ * Filters for work belonging to the given vista.
24399
+ * @format id
24400
+ * @example "VISTA-12345"
24401
+ */
24402
+ vista?: string;
24403
+ }
24404
+ /** works-count-response */
24405
+ export interface WorksCountResponse {
24406
+ /**
24407
+ * Count of works matching the filter.
24408
+ * @format int32
24409
+ */
24410
+ count: number;
24411
+ /** Whether there are more works than the count value. */
24412
+ has_more: boolean;
24413
+ }
22291
24414
  /** works-create-request */
22292
24415
  export type WorksCreateRequest = (WorksCreateRequestIssue | WorksCreateRequestOpportunity | WorksCreateRequestTask | WorksCreateRequestTicket) & {
22293
24416
  type: WorkType;
@@ -22646,6 +24769,12 @@ export interface WorksExportRequest {
22646
24769
  /** Provides ways to specify date ranges on objects. */
22647
24770
  target_close_date?: DateFilter;
22648
24771
  ticket?: WorksFilterTicket;
24772
+ /**
24773
+ * Filters for work belonging to the given vista.
24774
+ * @format id
24775
+ * @example "VISTA-12345"
24776
+ */
24777
+ vista?: string;
22649
24778
  }
22650
24779
  /** works-export-response */
22651
24780
  export interface WorksExportResponse {
@@ -22661,6 +24790,8 @@ export interface WorksFilterIssue {
22661
24790
  accounts?: string[];
22662
24791
  /** Provides ways to specify date ranges on objects. */
22663
24792
  actual_start_date?: DateFilter;
24793
+ /** Filters for issues belonging to specific groups. */
24794
+ group?: string[];
22664
24795
  /** Filters for issues with any of the provided priorities. */
22665
24796
  priority?: IssuePriority[];
22666
24797
  /** Filters for issues with any of the provided priority enum ids. */
@@ -22672,13 +24803,21 @@ export interface WorksFilterIssue {
22672
24803
  rev_orgs?: string[];
22673
24804
  /** The filter for SLA summary. */
22674
24805
  sla_summary?: SlaSummaryFilter;
24806
+ space?: SpaceFilter;
22675
24807
  /** Filters for issues with any of the sprint. */
22676
24808
  sprint?: string[];
24809
+ /** Filters for issues with any of the provided sprint states. */
24810
+ sprint_state?: WorksFilterIssueSprintStateValue[];
22677
24811
  /** Filters for issues with any of the provided subtypes. */
22678
24812
  subtype?: string[];
22679
24813
  /** Provides ways to specify date ranges on objects. */
22680
24814
  target_start_date?: DateFilter;
22681
24815
  }
24816
+ export declare enum WorksFilterIssueSprintStateValue {
24817
+ Active = "active",
24818
+ Completed = "completed",
24819
+ Planned = "planned"
24820
+ }
22682
24821
  /** works-filter-opportunity */
22683
24822
  export interface WorksFilterOpportunity {
22684
24823
  /**
@@ -22699,6 +24838,11 @@ export interface WorksFilterOpportunity {
22699
24838
  }
22700
24839
  /** works-filter-ticket */
22701
24840
  export interface WorksFilterTicket {
24841
+ /**
24842
+ * Filters for tickets with any of the provided accounts.
24843
+ * @example ["ACC-12345"]
24844
+ */
24845
+ account?: string[];
22702
24846
  /** Filters for tickets that are associated with any of the brands. */
22703
24847
  brand?: string[];
22704
24848
  /** Filters for tickets with any of the provided channels. */
@@ -22826,6 +24970,12 @@ export interface WorksListRequest {
22826
24970
  /** Provides ways to specify date ranges on objects. */
22827
24971
  target_close_date?: DateFilter;
22828
24972
  ticket?: WorksFilterTicket;
24973
+ /**
24974
+ * Filters for work belonging to the given vista.
24975
+ * @format id
24976
+ * @example "VISTA-12345"
24977
+ */
24978
+ vista?: string;
22829
24979
  }
22830
24980
  /** works-list-response */
22831
24981
  export interface WorksListResponse {
@@ -22931,6 +25081,11 @@ export interface WorksUpdateRequestArtifacts {
22931
25081
  /** works-update-request-issue */
22932
25082
  export interface WorksUpdateRequestIssue {
22933
25083
  developed_with?: WorksUpdateRequestIssueDevelopedWith;
25084
+ /**
25085
+ * Updates the group that the issue belongs to.
25086
+ * @format id
25087
+ */
25088
+ group?: string;
22934
25089
  /** Priority of the work based upon impact and criticality. */
22935
25090
  priority?: IssuePriority;
22936
25091
  /**
@@ -23688,6 +25843,24 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
23688
25843
  * @format id
23689
25844
  */
23690
25845
  'shared_with.role'?: string;
25846
+ /** Filters for status of the articles. */
25847
+ status?: ArticleStatus[];
25848
+ /** Filters for issues with this specific external reference. */
25849
+ 'sync_metadata.external_reference'?: string[];
25850
+ /** Filters for works with selected sync statuses. */
25851
+ 'sync_metadata.last_sync_in.status'?: SyncMetadataFilterSyncInFilterStatus[];
25852
+ /** Filters for works modified with selected sync history. */
25853
+ 'sync_metadata.last_sync_in.sync_history'?: string[];
25854
+ /** Filters for works modified with selected sync units. */
25855
+ 'sync_metadata.last_sync_in.sync_unit'?: string[];
25856
+ /** Filters for works with selected sync statuses. */
25857
+ 'sync_metadata.last_sync_out.status'?: SyncMetadataFilterSyncOutFilterStatus[];
25858
+ /** Filters for works modified with selected sync history. */
25859
+ 'sync_metadata.last_sync_out.sync_history'?: string[];
25860
+ /** Filters for works modified with selected sync units. */
25861
+ 'sync_metadata.last_sync_out.sync_unit'?: string[];
25862
+ /** Filters for issues synced from this specific origin system. */
25863
+ 'sync_metadata.origin_system'?: string[];
23691
25864
  /**
23692
25865
  * Filters for article with any of the provided tags.
23693
25866
  * @example ["TAG-12345"]
@@ -23737,9 +25910,16 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
23737
25910
  /**
23738
25911
  * The ID of the required article.
23739
25912
  * @format id
23740
- * @example "ARTICLE-12345"
25913
+ * @example "ART-12345"
23741
25914
  */
23742
25915
  id: string;
25916
+ /**
25917
+ * The parent article of the content block. The id field is expected to
25918
+ * contain the content block ID.
25919
+ * @format id
25920
+ * @example "ART-12345"
25921
+ */
25922
+ parent_article_id?: string;
23743
25923
  }, params?: RequestParams) => Promise<AxiosResponse<ArticlesGetResponse, any, {}>>;
23744
25924
  /**
23745
25925
  * @description Gets an article.
@@ -23823,6 +26003,24 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
23823
26003
  * @format id
23824
26004
  */
23825
26005
  'shared_with.role'?: string;
26006
+ /** Filters for status of the articles. */
26007
+ status?: ArticleStatus[];
26008
+ /** Filters for issues with this specific external reference. */
26009
+ 'sync_metadata.external_reference'?: string[];
26010
+ /** Filters for works with selected sync statuses. */
26011
+ 'sync_metadata.last_sync_in.status'?: SyncMetadataFilterSyncInFilterStatus[];
26012
+ /** Filters for works modified with selected sync history. */
26013
+ 'sync_metadata.last_sync_in.sync_history'?: string[];
26014
+ /** Filters for works modified with selected sync units. */
26015
+ 'sync_metadata.last_sync_in.sync_unit'?: string[];
26016
+ /** Filters for works with selected sync statuses. */
26017
+ 'sync_metadata.last_sync_out.status'?: SyncMetadataFilterSyncOutFilterStatus[];
26018
+ /** Filters for works modified with selected sync history. */
26019
+ 'sync_metadata.last_sync_out.sync_history'?: string[];
26020
+ /** Filters for works modified with selected sync units. */
26021
+ 'sync_metadata.last_sync_out.sync_unit'?: string[];
26022
+ /** Filters for issues synced from this specific origin system. */
26023
+ 'sync_metadata.origin_system'?: string[];
23826
26024
  /**
23827
26025
  * Filters for article with any of the provided tags.
23828
26026
  * @example ["TAG-12345"]
@@ -23849,43 +26047,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
23849
26047
  * @secure
23850
26048
  */
23851
26049
  updateArticle: (data: ArticlesUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<ArticlesUpdateResponse, any, {}>>;
23852
- /**
23853
- * @description Redirects to the artifact's download URL.
23854
- *
23855
- * @tags artifacts
23856
- * @name ArtifactsDownload
23857
- * @summary Download Artifacts
23858
- * @request GET:/artifacts.download
23859
- * @secure
23860
- */
23861
- artifactsDownload: (query: {
23862
- /**
23863
- * The ID of the artifact to be downloaded.
23864
- * @format id
23865
- * @example "ARTIFACT-12345"
23866
- */
23867
- id: string;
23868
- /**
23869
- * The access key for the artifact.
23870
- * @format text
23871
- */
23872
- key?: string;
23873
- /**
23874
- * The version of the artifact that needs to be downloaded.
23875
- * @format text
23876
- */
23877
- version?: string;
23878
- }, params?: RequestParams) => Promise<AxiosResponse<any, any, {}>>;
23879
- /**
23880
- * @description Redirects to the artifact's download URL.
23881
- *
23882
- * @tags artifacts
23883
- * @name ArtifactsDownloadPost
23884
- * @summary Download Artifacts (POST)
23885
- * @request POST:/artifacts.download
23886
- * @secure
23887
- */
23888
- artifactsDownloadPost: (data: ArtifactsDownloadRequest, params?: RequestParams) => Promise<AxiosResponse<any, any, {}>>;
23889
26050
  /**
23890
26051
  * @description Gets the requested artifact's information.
23891
26052
  *
@@ -24606,6 +26767,12 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
24606
26767
  * @secure
24607
26768
  */
24608
26769
  conversationsExport: (query?: {
26770
+ /**
26771
+ * Filters for conversations that are associated with any of the
26772
+ * accounts.
26773
+ * @example ["ACC-12345"]
26774
+ */
26775
+ account?: string[];
24609
26776
  /**
24610
26777
  * Filters for conversations belonging to any of the provided parts.
24611
26778
  * @example ["PROD-12345"]
@@ -24657,6 +26824,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
24657
26824
  * @example ["DEVU-12345"]
24658
26825
  */
24659
26826
  owned_by?: string[];
26827
+ /** Filters for conversations owned by any of the AI agents. */
26828
+ owned_by_agent?: string[];
24660
26829
  /**
24661
26830
  * Filters for conversations that are associated with any of the
24662
26831
  * provided Rev organizations.
@@ -24686,6 +26855,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
24686
26855
  source_channels?: string[];
24687
26856
  /** Filters for records in the provided stage(s) by name. */
24688
26857
  'stage.name'?: string[];
26858
+ /** List of IDs of the custom stages which will be used for filtering. */
26859
+ 'stage.stages'?: string[];
24689
26860
  /** Filters for conversations with any of the provided states. */
24690
26861
  state?: string[];
24691
26862
  /** Filters for conversation with any of the provided subtypes. */
@@ -24755,6 +26926,12 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
24755
26926
  * @secure
24756
26927
  */
24757
26928
  conversationsList: (query?: {
26929
+ /**
26930
+ * Filters for conversations that are associated with any of the
26931
+ * accounts.
26932
+ * @example ["ACC-12345"]
26933
+ */
26934
+ account?: string[];
24758
26935
  /**
24759
26936
  * Filters for conversations belonging to any of the provided parts.
24760
26937
  * @example ["PROD-12345"]
@@ -24816,6 +26993,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
24816
26993
  * @example ["DEVU-12345"]
24817
26994
  */
24818
26995
  owned_by?: string[];
26996
+ /** Filters for conversations owned by any of the AI agents. */
26997
+ owned_by_agent?: string[];
24819
26998
  /**
24820
26999
  * Filters for conversations that are associated with any of the
24821
27000
  * provided Rev organizations.
@@ -24845,6 +27024,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
24845
27024
  source_channels?: string[];
24846
27025
  /** Filters for records in the provided stage(s) by name. */
24847
27026
  'stage.name'?: string[];
27027
+ /** List of IDs of the custom stages which will be used for filtering. */
27028
+ 'stage.stages'?: string[];
24848
27029
  /** Filters for conversations with any of the provided states. */
24849
27030
  state?: string[];
24850
27031
  /** Filters for conversation with any of the provided subtypes. */
@@ -24895,6 +27076,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
24895
27076
  * @name CustomObjectsCount
24896
27077
  * @summary Count Custom Objects
24897
27078
  * @request GET:/custom-objects.count
27079
+ * @deprecated
24898
27080
  * @secure
24899
27081
  */
24900
27082
  customObjectsCount: (query: {
@@ -24913,6 +27095,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
24913
27095
  * @name CustomObjectsCountPost
24914
27096
  * @summary Count Custom Objects (POST)
24915
27097
  * @request POST:/custom-objects.count
27098
+ * @deprecated
24916
27099
  * @secure
24917
27100
  */
24918
27101
  customObjectsCountPost: (data: CustomObjectsCountRequest, params?: RequestParams) => Promise<AxiosResponse<CustomObjectsCountResponse, any, {}>>;
@@ -24969,6 +27152,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
24969
27152
  * @name CustomObjectsList
24970
27153
  * @summary List Custom Objects
24971
27154
  * @request GET:/custom-objects.list
27155
+ * @deprecated
24972
27156
  * @secure
24973
27157
  */
24974
27158
  customObjectsList: (query: {
@@ -24992,10 +27176,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
24992
27176
  * @format int32
24993
27177
  */
24994
27178
  limit?: number;
24995
- /**
24996
- * The iteration mode to use, otherwise if not set, then "after" is
24997
- * used.
24998
- */
27179
+ /** The iteration mode to use. If not set, then "after" is used. */
24999
27180
  mode?: ListMode;
25000
27181
  /** The list of fields to sort the items by and how to sort them. */
25001
27182
  sort_by?: string[];
@@ -25007,6 +27188,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
25007
27188
  * @name CustomObjectsListPost
25008
27189
  * @summary List Custom Objects (POST)
25009
27190
  * @request POST:/custom-objects.list
27191
+ * @deprecated
25010
27192
  * @secure
25011
27193
  */
25012
27194
  customObjectsListPost: (data: CustomObjectsListRequest, params?: RequestParams) => Promise<AxiosResponse<CustomObjectsListResponse, any, {}>>;
@@ -25246,6 +27428,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
25246
27428
  phone_numbers?: string[];
25247
27429
  /** Fields to sort the Dev users by and the direction to sort them. */
25248
27430
  sort_by?: string[];
27431
+ /** Filters for issues that are staged. */
27432
+ 'staged_info.is_staged'?: boolean;
25249
27433
  /** Filters Dev users based on state. */
25250
27434
  state?: UserState[];
25251
27435
  /**
@@ -25712,8 +27896,21 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
25712
27896
  mode?: ListMode;
25713
27897
  /** Filters the groups on the basis of group name. */
25714
27898
  name?: string[];
27899
+ /**
27900
+ * Filters the groups on the basis of parent group(s).
27901
+ * @deprecated
27902
+ */
27903
+ parents?: string[];
25715
27904
  /** Comma-separated fields to sort the groups by. */
25716
27905
  sort_by?: string[];
27906
+ /** Filters for the provided space IDs. */
27907
+ 'space.ids'?: string[];
27908
+ /** Whether to include child spaces. */
27909
+ 'space.include_children'?: boolean;
27910
+ /** Whether to include objects not associated with any space. */
27911
+ 'space.include_global'?: boolean;
27912
+ /** Whether to include parent spaces. */
27913
+ 'space.include_parents'?: boolean;
25717
27914
  /** Filters for issues with this specific external reference. */
25718
27915
  'sync_metadata.external_reference'?: string[];
25719
27916
  /** Filters for works with selected sync statuses. */
@@ -25751,6 +27948,32 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
25751
27948
  * @secure
25752
27949
  */
25753
27950
  groupMembersAdd: (data: GroupMembersAddRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
27951
+ /**
27952
+ * @description Counts the members in a group.
27953
+ *
27954
+ * @tags groups
27955
+ * @name GroupMembersCount
27956
+ * @summary Count Groups Members
27957
+ * @request GET:/groups.members.count
27958
+ * @secure
27959
+ */
27960
+ groupMembersCount: (query: {
27961
+ /**
27962
+ * ID of the group for which to count members.
27963
+ * @format id
27964
+ */
27965
+ group: string;
27966
+ }, params?: RequestParams) => Promise<AxiosResponse<GroupMembersCountResponse, any, {}>>;
27967
+ /**
27968
+ * @description Counts the members in a group.
27969
+ *
27970
+ * @tags groups
27971
+ * @name GroupMembersCountPost
27972
+ * @summary Count Groups Members (POST)
27973
+ * @request POST:/groups.members.count
27974
+ * @secure
27975
+ */
27976
+ groupMembersCountPost: (data: GroupMembersCountRequest, params?: RequestParams) => Promise<AxiosResponse<GroupMembersCountResponse, any, {}>>;
25754
27977
  /**
25755
27978
  * @description Lists the members in a group.
25756
27979
  *
@@ -25783,6 +28006,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
25783
28006
  * used.
25784
28007
  */
25785
28008
  mode?: ListMode;
28009
+ /** Fields to sort the group members by and the direction to sort them. */
28010
+ sort_by?: string[];
25786
28011
  }, params?: RequestParams) => Promise<AxiosResponse<GroupMembersListResponse, any, {}>>;
25787
28012
  /**
25788
28013
  * @description Lists the members in a group.
@@ -25895,6 +28120,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
25895
28120
  * @example ["ACC-12345"]
25896
28121
  */
25897
28122
  impacted_customers?: string[];
28123
+ /**
28124
+ * Whether to include items belonging to children of any of the provided
28125
+ * parts.
28126
+ */
28127
+ include_child_parts?: boolean;
25898
28128
  /**
25899
28129
  * The maximum number of groups to return. If not set, then the default
25900
28130
  * is '10'.
@@ -25916,17 +28146,17 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
25916
28146
  owned_by?: string[];
25917
28147
  /**
25918
28148
  * Filters for incidents with any of the provided PIAs.
25919
- * @example ["ARTICLE-12345"]
28149
+ * @example ["ART-12345"]
25920
28150
  */
25921
28151
  pia?: string[];
25922
28152
  /**
25923
28153
  * Filters for incidents with any of the provided playbooks.
25924
- * @example ["ARTICLE-12345"]
28154
+ * @example ["ART-12345"]
25925
28155
  */
25926
28156
  playbooks?: string[];
25927
28157
  /**
25928
28158
  * Filters for incidents with any of the provided related docs.
25929
- * @example ["ARTICLE-12345"]
28159
+ * @example ["ART-12345"]
25930
28160
  */
25931
28161
  related_docs?: string[];
25932
28162
  /** Filters for incidents with any of the provided reporters. */
@@ -26005,6 +28235,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
26005
28235
  * @example ["ACC-12345"]
26006
28236
  */
26007
28237
  impacted_customers?: string[];
28238
+ /**
28239
+ * Whether to include items belonging to children of any of the provided
28240
+ * parts.
28241
+ */
28242
+ include_child_parts?: boolean;
26008
28243
  /**
26009
28244
  * The maximum number of items.
26010
28245
  * @format int32
@@ -26019,17 +28254,17 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
26019
28254
  owned_by?: string[];
26020
28255
  /**
26021
28256
  * Filters for incidents with any of the provided PIAs.
26022
- * @example ["ARTICLE-12345"]
28257
+ * @example ["ART-12345"]
26023
28258
  */
26024
28259
  pia?: string[];
26025
28260
  /**
26026
28261
  * Filters for incidents with any of the provided playbooks.
26027
- * @example ["ARTICLE-12345"]
28262
+ * @example ["ART-12345"]
26028
28263
  */
26029
28264
  playbooks?: string[];
26030
28265
  /**
26031
28266
  * Filters for incidents with any of the provided related docs.
26032
- * @example ["ARTICLE-12345"]
28267
+ * @example ["ART-12345"]
26033
28268
  */
26034
28269
  related_docs?: string[];
26035
28270
  /** Filters for incidents with any of the provided reporters. */
@@ -26088,6 +28323,81 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
26088
28323
  * @secure
26089
28324
  */
26090
28325
  incidentsUpdate: (data: IncidentsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<IncidentsUpdateResponse, any, {}>>;
28326
+ /**
28327
+ * @description Retrieves a job's information.
28328
+ *
28329
+ * @tags jobs
28330
+ * @name GetJob
28331
+ * @summary Get Job
28332
+ * @request GET:/jobs.get
28333
+ * @secure
28334
+ */
28335
+ getJob: (query: {
28336
+ /**
28337
+ * The ID of the job to be retrieved.
28338
+ * @format id
28339
+ */
28340
+ id: string;
28341
+ }, params?: RequestParams) => Promise<AxiosResponse<JobsGetResponse, any, {}>>;
28342
+ /**
28343
+ * @description Retrieves a job's information.
28344
+ *
28345
+ * @tags jobs
28346
+ * @name GetJobPost
28347
+ * @summary Get Job (POST)
28348
+ * @request POST:/jobs.get
28349
+ * @secure
28350
+ */
28351
+ getJobPost: (data: JobsGetRequest, params?: RequestParams) => Promise<AxiosResponse<JobsGetResponse, any, {}>>;
28352
+ /**
28353
+ * @description Gets a list of jobs.
28354
+ *
28355
+ * @tags jobs
28356
+ * @name ListJobs
28357
+ * @summary List Jobs
28358
+ * @request GET:/jobs.list
28359
+ * @secure
28360
+ */
28361
+ listJobs: (query?: {
28362
+ /** Filters on job category. */
28363
+ category?: JobCategory[];
28364
+ /** Filters for jobs created by the specified user(s). */
28365
+ created_by?: string[];
28366
+ /**
28367
+ * The cursor to resume iteration from. If not provided, then iteration
28368
+ * starts from the beginning.
28369
+ * @format text
28370
+ */
28371
+ cursor?: string;
28372
+ /**
28373
+ * The maximum number of jobs to return per page. The default is '50'.
28374
+ * @format int32
28375
+ */
28376
+ limit?: number;
28377
+ /**
28378
+ * The iteration mode to use, otherwise if not set, then "after" is
28379
+ * used.
28380
+ */
28381
+ mode?: ListMode;
28382
+ /** Filters on the user who owns the job. */
28383
+ owned_by_id?: string[];
28384
+ /** Filters on parent ids for jobs. */
28385
+ parent_ids?: string[];
28386
+ /** Fields to sort the jobs by and the direction to sort them in. */
28387
+ sort_by?: string[];
28388
+ /** Filters on job state. */
28389
+ state?: JobState[];
28390
+ }, params?: RequestParams) => Promise<AxiosResponse<JobsListResponse, any, {}>>;
28391
+ /**
28392
+ * @description Gets a list of jobs.
28393
+ *
28394
+ * @tags jobs
28395
+ * @name ListJobsPost
28396
+ * @summary List Jobs (POST)
28397
+ * @request POST:/jobs.list
28398
+ * @secure
28399
+ */
28400
+ listJobsPost: (data: JobsListRequest, params?: RequestParams) => Promise<AxiosResponse<JobsListResponse, any, {}>>;
26091
28401
  /**
26092
28402
  * @description OAuth2 authorization callback.
26093
28403
  *
@@ -26178,7 +28488,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
26178
28488
  /** Whether only deprecated link types should be filtered. */
26179
28489
  is_deprecated?: boolean;
26180
28490
  /**
26181
- * The maximum number of items.
28491
+ * The maximum number of items, for each result and
28492
+ * reverse_result.Default value is 50 for each.
26182
28493
  * @format int32
26183
28494
  */
26184
28495
  limit?: number;
@@ -26347,6 +28658,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
26347
28658
  * @format text
26348
28659
  */
26349
28660
  cursor?: string;
28661
+ /**
28662
+ * The custom link types to filter for, otherwise if not present, all
28663
+ * custom link types are included.
28664
+ */
28665
+ custom_link_type?: string[];
26350
28666
  /**
26351
28667
  * The direction of the links to list, otherwise if not present, then
26352
28668
  * links in both directions (source and target) are included.
@@ -26804,6 +29120,130 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
26804
29120
  * @secure
26805
29121
  */
26806
29122
  notificationsSend: (data: NotificationsSendRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
29123
+ /**
29124
+ * @description Retrieves the recording data for a specific session ID and recording ID. For mobile sessions, requires both session_id and recording_id. For web sessions, requires both session_id and tab_id.
29125
+ *
29126
+ * @tags observability
29127
+ * @name ObservabilitySessionsDataGet
29128
+ * @summary Get Observability Sessions Data
29129
+ * @request GET:/observability.sessions.data.get
29130
+ * @secure
29131
+ */
29132
+ observabilitySessionsDataGet: (query: {
29133
+ /**
29134
+ * The unique identifier of the session containing the recording.
29135
+ * @format text
29136
+ */
29137
+ session_id: string;
29138
+ /**
29139
+ * The unique app ID to which the session belongs.
29140
+ * @format text
29141
+ */
29142
+ version_key: string;
29143
+ /**
29144
+ * The unique identifier of the recording to retrieve in case of mobile
29145
+ * sessions.
29146
+ * @format text
29147
+ */
29148
+ recording_id?: string;
29149
+ /**
29150
+ * The unique identifier of the tab to retrieve in case of web sessions.
29151
+ * @format text
29152
+ */
29153
+ tab_id?: string;
29154
+ }, params?: RequestParams) => Promise<AxiosResponse<ObservabilitySessionsDataGetResponse, any, {}>>;
29155
+ /**
29156
+ * @description Retrieves the recording data for a specific session ID and recording ID. For mobile sessions, requires both session_id and recording_id. For web sessions, requires both session_id and tab_id.
29157
+ *
29158
+ * @tags observability
29159
+ * @name ObservabilitySessionsDataGetPost
29160
+ * @summary Get Observability Sessions Data (POST)
29161
+ * @request POST:/observability.sessions.data.get
29162
+ * @secure
29163
+ */
29164
+ observabilitySessionsDataGetPost: (data: ObservabilitySessionsDataGetRequest, params?: RequestParams) => Promise<AxiosResponse<ObservabilitySessionsDataGetResponse, any, {}>>;
29165
+ /**
29166
+ * @description Gets a specific session metadata by ID.
29167
+ *
29168
+ * @tags observability
29169
+ * @name ObservabilitySessionsGet
29170
+ * @summary Get Observability Session
29171
+ * @request GET:/observability.sessions.get
29172
+ * @secure
29173
+ */
29174
+ observabilitySessionsGet: (query: {
29175
+ /** The platform type to filter sessions by. */
29176
+ platform: DevicePlatform;
29177
+ /**
29178
+ * The unique identifier of the session to retrieve.
29179
+ * @format text
29180
+ * @minLength 1
29181
+ */
29182
+ session_id: string;
29183
+ /**
29184
+ * The unique app ID to which the session belongs.
29185
+ * @format text
29186
+ * @minLength 1
29187
+ */
29188
+ version_key: string;
29189
+ }, params?: RequestParams) => Promise<AxiosResponse<ObservabilitySessionsGetResponse, any, {}>>;
29190
+ /**
29191
+ * @description Gets a specific session metadata by ID.
29192
+ *
29193
+ * @tags observability
29194
+ * @name ObservabilitySessionsGetPost
29195
+ * @summary Get Observability Session (POST)
29196
+ * @request POST:/observability.sessions.get
29197
+ * @secure
29198
+ */
29199
+ observabilitySessionsGetPost: (data: ObservabilitySessionsGetRequest, params?: RequestParams) => Promise<AxiosResponse<ObservabilitySessionsGetResponse, any, {}>>;
29200
+ /**
29201
+ * @description Lists sessions based on filter criteria.
29202
+ *
29203
+ * @tags observability
29204
+ * @name ObservabilitySessionsList
29205
+ * @summary List Observability Sessions
29206
+ * @request GET:/observability.sessions.list
29207
+ * @secure
29208
+ */
29209
+ observabilitySessionsList: (query: {
29210
+ /** Filter by platform type. */
29211
+ platform: DevicePlatform;
29212
+ /**
29213
+ * The unique app ID to which the session belongs.
29214
+ * @format text
29215
+ * @minLength 1
29216
+ */
29217
+ version_key: string;
29218
+ /**
29219
+ * The cursor to resume iteration from. If not provided, then iteration
29220
+ * starts from the beginning.
29221
+ * @format text
29222
+ */
29223
+ cursor?: string;
29224
+ /**
29225
+ * The maximum number of sessions to return.
29226
+ * @format int32
29227
+ */
29228
+ limit?: number;
29229
+ /**
29230
+ * The iteration mode to use, otherwise if not set, then "after" is
29231
+ * used.
29232
+ */
29233
+ mode?: ListMode;
29234
+ /** The fields to sort the sessions by and the direction to sort them. */
29235
+ sort_by?: string[];
29236
+ }, params?: RequestParams) => Promise<AxiosResponse<ObservabilitySessionsListResponse, any, {}>>;
29237
+ /**
29238
+ * @description Lists sessions based on filter criteria.
29239
+ *
29240
+ * @tags observability
29241
+ * @name ObservabilitySessionsListPost
29242
+ * @summary List Observability Sessions (POST)
29243
+ * @request POST:/observability.sessions.list
29244
+ * @secure
29245
+ */
29246
+ observabilitySessionsListPost: (data: ObservabilitySessionsListRequest, params?: RequestParams) => Promise<AxiosResponse<ObservabilitySessionsListResponse, any, {}>>;
26807
29247
  /**
26808
29248
  * @description Creates an organization schedule fragment.
26809
29249
  *
@@ -26907,6 +29347,12 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
26907
29347
  * @format id
26908
29348
  */
26909
29349
  id: string;
29350
+ /**
29351
+ * Specific version of the organization schedule to retrieve. If not
29352
+ * provided, returns the latest version.
29353
+ * @format int64
29354
+ */
29355
+ version_number?: number;
26910
29356
  }, params?: RequestParams) => Promise<AxiosResponse<OrgSchedulesGetResponse, any, {}>>;
26911
29357
  /**
26912
29358
  * @description Gets an organization schedule.
@@ -27197,6 +29643,30 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
27197
29643
  * @secure
27198
29644
  */
27199
29645
  partsUpdate: (data: PartsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<PartsUpdateResponse, any, {}>>;
29646
+ /**
29647
+ * @description Pings the DevRev service.
29648
+ *
29649
+ * @name Ping
29650
+ * @summary Ping
29651
+ * @request GET:/ping
29652
+ * @secure
29653
+ */
29654
+ ping: (query?: {
29655
+ /**
29656
+ * DevRev partion ID. For example, dvrv-us-1 for the us-east-1 region.
29657
+ * @format text
29658
+ */
29659
+ devrev_partition?: string;
29660
+ }, params?: RequestParams) => Promise<AxiosResponse<PingResponse, any, {}>>;
29661
+ /**
29662
+ * @description Pings the DevRev service.
29663
+ *
29664
+ * @name PingPost
29665
+ * @summary Ping (POST)
29666
+ * @request POST:/ping
29667
+ * @secure
29668
+ */
29669
+ pingPost: (data: PingRequest, params?: RequestParams) => Promise<AxiosResponse<PingResponse, any, {}>>;
27200
29670
  /**
27201
29671
  * @description Get the preferences object.
27202
29672
  *
@@ -27301,7 +29771,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
27301
29771
  /**
27302
29772
  * Filters for question-answer belonging to any of the provided
27303
29773
  * articles.
27304
- * @example ["ARTICLE-12345"]
29774
+ * @example ["ART-12345"]
27305
29775
  */
27306
29776
  applies_to_articles?: string[];
27307
29777
  /**
@@ -27367,12 +29837,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
27367
29837
  * @secure
27368
29838
  */
27369
29839
  reactionsList: (query: {
27370
- /**
27371
- * The emoji to list the reactors for. This can be the short name of the
27372
- * emoji (e.g. "joy"), or the code point (e.g. "1f602").
27373
- * @format text
27374
- */
27375
- emoji: string;
27376
29840
  /**
27377
29841
  * The ID of the object to list reactors for.
27378
29842
  * @format id
@@ -27385,6 +29849,13 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
27385
29849
  * @format text
27386
29850
  */
27387
29851
  cursor?: string;
29852
+ /**
29853
+ * The emoji to list the reactors for. This can be the short name of the
29854
+ * emoji (e.g. "joy"), or the code point (e.g. "1f602"). If not
29855
+ * provided, all reactions for the object are returned.
29856
+ * @format text
29857
+ */
29858
+ emoji?: string;
27388
29859
  /**
27389
29860
  * The maximum number of reactors to return.
27390
29861
  * @format int32
@@ -28028,6 +30499,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
28028
30499
  * @format id
28029
30500
  */
28030
30501
  id: string;
30502
+ /** Whether to include sync metadata in the response. */
30503
+ include_sync_metadata?: boolean;
28031
30504
  }, params?: RequestParams) => Promise<AxiosResponse<CustomSchemaFragmentsGetResponse, any, {}>>;
28032
30505
  /**
28033
30506
  * @description Gets a custom schema fragment.
@@ -28062,6 +30535,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
28062
30535
  * @deprecated
28063
30536
  */
28064
30537
  deprecated?: boolean;
30538
+ /** Whether to include sync metadata in the response. */
30539
+ include_sync_metadata?: boolean;
28065
30540
  /** Whether the leaf type corresponds to a custom object */
28066
30541
  is_custom_leaf_type?: boolean;
28067
30542
  /** Whether the fragment has been deprecated. */
@@ -28085,6 +30560,14 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
28085
30560
  prune?: CustomSchemaFragmentsListRequestPrune[];
28086
30561
  /** The list of fields to sort the items by and how to sort them. */
28087
30562
  sort_by?: string[];
30563
+ /** Filters for the provided space IDs. */
30564
+ 'space.ids'?: string[];
30565
+ /** Whether to include child spaces. */
30566
+ 'space.include_children'?: boolean;
30567
+ /** Whether to include objects not associated with any space. */
30568
+ 'space.include_global'?: boolean;
30569
+ /** Whether to include parent spaces. */
30570
+ 'space.include_parents'?: boolean;
28088
30571
  /** The list of subtypes. */
28089
30572
  subtype?: string[];
28090
30573
  /** Filters for custom schema fragment of the provided types. */
@@ -28243,7 +30726,9 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
28243
30726
  searchCore: (query: {
28244
30727
  /**
28245
30728
  * The query string. Search query language:
28246
- * https://docs.devrev.ai/product/search#fields
30729
+ * https://docs.devrev.ai/product/search#fields. Text and text phrases
30730
+ * will be truncated if they exceed 50 characters respectively; filters
30731
+ * will not be truncated.
28247
30732
  * @format text
28248
30733
  */
28249
30734
  query: string;
@@ -28295,13 +30780,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
28295
30780
  searchHybrid: (query: {
28296
30781
  /** The hybrid namespace to search in. */
28297
30782
  namespace: SearchHybridNamespace;
28298
- /**
28299
- * The query string.
28300
- * @format text
28301
- * @minLength 1
28302
- * @maxLength 400
28303
- */
28304
- query: string;
28305
30783
  /**
28306
30784
  * The maximum number of items to return in a page. The default is '10'.
28307
30785
  * @format int32
@@ -28310,13 +30788,13 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
28310
30788
  */
28311
30789
  limit?: number | undefined;
28312
30790
  /**
28313
- * The weightage for semantic search. Values between 0 and 1 are
28314
- * accepted.
28315
- * @format float
28316
- * @min 0
28317
- * @max 1
30791
+ * The query string. Text and text phrases will be truncated if they
30792
+ * exceed 50 characters respectively; filters will not be truncated.
30793
+ * @format text
30794
+ * @minLength 1
30795
+ * @maxLength 400
28318
30796
  */
28319
- semantic_weight?: number | undefined;
30797
+ query?: string | undefined;
28320
30798
  }, params?: RequestParams) => Promise<AxiosResponse<SearchHybridResponse, any, {}>>;
28321
30799
  /**
28322
30800
  * @description Performs search, using a combination of syntactic and semantic search.
@@ -29458,6 +31936,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
29458
31936
  * used.
29459
31937
  */
29460
31938
  mode?: ListMode;
31939
+ /** Filters for entries to be displayed on the provided panel(s). */
31940
+ panels?: TimelineEntryPanel[];
29461
31941
  /**
29462
31942
  * The visibility of the timeline entries to filter for. Note this is a
29463
31943
  * strict filter, such that only entries with the exact visibilities
@@ -30049,7 +32529,10 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
30049
32529
  * @request GET:/webhooks.list
30050
32530
  * @secure
30051
32531
  */
30052
- webhooksList: (params?: RequestParams) => Promise<AxiosResponse<WebhooksListResponse, any, {}>>;
32532
+ webhooksList: (query?: {
32533
+ /** Filters for webhooks with the provided statuses. */
32534
+ status?: WebhookStatus[];
32535
+ }, params?: RequestParams) => Promise<AxiosResponse<WebhooksListResponse, any, {}>>;
30053
32536
  /**
30054
32537
  * @description Lists the webhooks.
30055
32538
  *
@@ -30096,6 +32579,179 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
30096
32579
  * @secure
30097
32580
  */
30098
32581
  widgetsGetPost: (data: WidgetsGetRequest, params?: RequestParams) => Promise<AxiosResponse<WidgetsGetResponse, any, {}>>;
32582
+ /**
32583
+ * @description Get count of work matching given filter.
32584
+ *
32585
+ * @tags works
32586
+ * @name WorksCount
32587
+ * @summary Count Works
32588
+ * @request GET:/works.count
32589
+ * @secure
32590
+ */
32591
+ worksCount: (query?: {
32592
+ /**
32593
+ * Filters for work belonging to any of the provided parts.
32594
+ * @example ["PROD-12345"]
32595
+ */
32596
+ applies_to_part?: string[];
32597
+ /**
32598
+ * Filters for work created by any of these users.
32599
+ * @example ["DEVU-12345"]
32600
+ */
32601
+ created_by?: string[];
32602
+ /** Filters for custom fields. */
32603
+ custom_fields?: object;
32604
+ /** Filters for work with any of the provided external references. */
32605
+ external_ref?: string[];
32606
+ /**
32607
+ * Filters for issues with any of the provided accounts.
32608
+ * @example ["ACC-12345"]
32609
+ */
32610
+ 'issue.accounts'?: string[];
32611
+ /** Filters for issues belonging to specific groups. */
32612
+ 'issue.group'?: string[];
32613
+ /** Filters for issues with any of the provided priorities. */
32614
+ 'issue.priority'?: IssuePriority[];
32615
+ /** Filters for issues with any of the provided priority enum ids. */
32616
+ 'issue.priority_v2'?: number[];
32617
+ /**
32618
+ * Filters for issues with any of the provided Rev organizations.
32619
+ * @example ["REV-AbCdEfGh"]
32620
+ */
32621
+ 'issue.rev_orgs'?: string[];
32622
+ /** Filters for records with any of the provided SLA stages. */
32623
+ 'issue.sla_summary.stage'?: SlaSummaryStage[];
32624
+ /** Filters for the provided space IDs. */
32625
+ 'issue.space.ids'?: string[];
32626
+ /** Whether to include child spaces. */
32627
+ 'issue.space.include_children'?: boolean;
32628
+ /** Whether to include objects not associated with any space. */
32629
+ 'issue.space.include_global'?: boolean;
32630
+ /** Whether to include parent spaces. */
32631
+ 'issue.space.include_parents'?: boolean;
32632
+ /** Filters for issues with any of the sprint. */
32633
+ 'issue.sprint'?: string[];
32634
+ /** Filters for issues with any of the provided sprint states. */
32635
+ 'issue.sprint_state'?: WorksFilterIssueSprintStateValue[];
32636
+ /** Filters for issues with any of the provided subtypes. */
32637
+ 'issue.subtype'?: string[];
32638
+ /**
32639
+ * Filters for work modified by any of these users.
32640
+ * @example ["DEVU-12345"]
32641
+ */
32642
+ modified_by?: string[];
32643
+ /**
32644
+ * Filters for opportunities belonging to any of the provided accounts.
32645
+ * @example ["ACC-12345"]
32646
+ */
32647
+ 'opportunity.account'?: string[];
32648
+ /** Filters for opportunities with any of the provided contacts. */
32649
+ 'opportunity.contacts'?: string[];
32650
+ /**
32651
+ * Filters for opportunities with any of the provided forecast category
32652
+ * enum IDs.
32653
+ */
32654
+ 'opportunity.forecast_category_v2'?: number[];
32655
+ /** Filters for opportunity with any of the provided subtypes. */
32656
+ 'opportunity.subtype'?: string[];
32657
+ /**
32658
+ * Filters for work owned by any of these users.
32659
+ * @example ["DEVU-12345"]
32660
+ */
32661
+ owned_by?: string[];
32662
+ /**
32663
+ * Filters for work reported by any of these users.
32664
+ * @example ["DEVU-12345"]
32665
+ */
32666
+ reported_by?: string[];
32667
+ /** Filters for records in the provided stage(s) by name. */
32668
+ 'stage.name'?: string[];
32669
+ /** List of IDs of the custom stages which will be used for filtering. */
32670
+ 'stage.stages'?: string[];
32671
+ /** Filters for issues that are staged. */
32672
+ 'staged_info.is_staged'?: boolean;
32673
+ /** Filters for work with any of the provided states. */
32674
+ state?: string[];
32675
+ /** Filters for issues with this specific external reference. */
32676
+ 'sync_metadata.external_reference'?: string[];
32677
+ /** Filters for works with selected sync statuses. */
32678
+ 'sync_metadata.last_sync_in.status'?: SyncMetadataFilterSyncInFilterStatus[];
32679
+ /** Filters for works modified with selected sync history. */
32680
+ 'sync_metadata.last_sync_in.sync_history'?: string[];
32681
+ /** Filters for works modified with selected sync units. */
32682
+ 'sync_metadata.last_sync_in.sync_unit'?: string[];
32683
+ /** Filters for works with selected sync statuses. */
32684
+ 'sync_metadata.last_sync_out.status'?: SyncMetadataFilterSyncOutFilterStatus[];
32685
+ /** Filters for works modified with selected sync history. */
32686
+ 'sync_metadata.last_sync_out.sync_history'?: string[];
32687
+ /** Filters for works modified with selected sync units. */
32688
+ 'sync_metadata.last_sync_out.sync_unit'?: string[];
32689
+ /** Filters for issues synced from this specific origin system. */
32690
+ 'sync_metadata.origin_system'?: string[];
32691
+ /**
32692
+ * Filters for work with any of the provided tags.
32693
+ * @example ["TAG-12345"]
32694
+ */
32695
+ tags?: string[];
32696
+ /**
32697
+ * Filters for tickets with any of the provided accounts.
32698
+ * @example ["ACC-12345"]
32699
+ */
32700
+ 'ticket.account'?: string[];
32701
+ /** Filters for tickets that are associated with any of the brands. */
32702
+ 'ticket.brand'?: string[];
32703
+ /** Filters for tickets with any of the provided channels. */
32704
+ 'ticket.channels'?: TicketChannels[];
32705
+ /** Filters for tickets that are associated with any of the channels. */
32706
+ 'ticket.channels_v2'?: string[];
32707
+ /** Filters for tickets belonging to specific groups. */
32708
+ 'ticket.group'?: string[];
32709
+ /** Filters for frozen tickets. */
32710
+ 'ticket.is_frozen'?: boolean;
32711
+ /** Filters for tickets that are spam. */
32712
+ 'ticket.is_spam'?: boolean;
32713
+ /** Filters for tickets that need response. */
32714
+ 'ticket.needs_response'?: boolean;
32715
+ /**
32716
+ * Filters for tickets that are associated with any of the provided Rev
32717
+ * organizations.
32718
+ * @example ["REV-AbCdEfGh"]
32719
+ */
32720
+ 'ticket.rev_org'?: string[];
32721
+ /** Filters for tickets with any of the provided severities. */
32722
+ 'ticket.severity'?: TicketSeverity[];
32723
+ /** Filters for records with any of the provided SLA stages. */
32724
+ 'ticket.sla_summary.stage'?: SlaSummaryStage[];
32725
+ /** Filters for tickets with any of the provided source channels. */
32726
+ 'ticket.source_channel'?: string[];
32727
+ /**
32728
+ * Filters for tickets that are associated with any of the source
32729
+ * channels.
32730
+ */
32731
+ 'ticket.source_channel_v2'?: string[];
32732
+ /** Filters for tickets with any of the provided subtypes. */
32733
+ 'ticket.subtype'?: string[];
32734
+ /** Visibility enum ID of the ticket. */
32735
+ 'ticket.visibility'?: number[];
32736
+ /** Filters for work of the provided types. */
32737
+ type?: WorkType[];
32738
+ /**
32739
+ * Filters for work belonging to the given vista.
32740
+ * @format id
32741
+ * @example "VISTA-12345"
32742
+ */
32743
+ vista?: string;
32744
+ }, params?: RequestParams) => Promise<AxiosResponse<WorksCountResponse, any, {}>>;
32745
+ /**
32746
+ * @description Get count of work matching given filter.
32747
+ *
32748
+ * @tags works
32749
+ * @name WorksCountPost
32750
+ * @summary Count Works (POST)
32751
+ * @request POST:/works.count
32752
+ * @secure
32753
+ */
32754
+ worksCountPost: (data: WorksCountRequest, params?: RequestParams) => Promise<AxiosResponse<WorksCountResponse, any, {}>>;
30099
32755
  /**
30100
32756
  * @description Creates new work ([issue](https://devrev.ai/docs/product/build), [ticket](https://devrev.ai/docs/product/support)) item. [task](https://devrev.ai/docs/product/tasks) and opportunity work types are supported in the beta version.
30101
32757
  *
@@ -30151,6 +32807,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
30151
32807
  * @example ["ACC-12345"]
30152
32808
  */
30153
32809
  'issue.accounts'?: string[];
32810
+ /** Filters for issues belonging to specific groups. */
32811
+ 'issue.group'?: string[];
30154
32812
  /** Filters for issues with any of the provided priorities. */
30155
32813
  'issue.priority'?: IssuePriority[];
30156
32814
  /** Filters for issues with any of the provided priority enum ids. */
@@ -30162,8 +32820,18 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
30162
32820
  'issue.rev_orgs'?: string[];
30163
32821
  /** Filters for records with any of the provided SLA stages. */
30164
32822
  'issue.sla_summary.stage'?: SlaSummaryStage[];
32823
+ /** Filters for the provided space IDs. */
32824
+ 'issue.space.ids'?: string[];
32825
+ /** Whether to include child spaces. */
32826
+ 'issue.space.include_children'?: boolean;
32827
+ /** Whether to include objects not associated with any space. */
32828
+ 'issue.space.include_global'?: boolean;
32829
+ /** Whether to include parent spaces. */
32830
+ 'issue.space.include_parents'?: boolean;
30165
32831
  /** Filters for issues with any of the sprint. */
30166
32832
  'issue.sprint'?: string[];
32833
+ /** Filters for issues with any of the provided sprint states. */
32834
+ 'issue.sprint_state'?: WorksFilterIssueSprintStateValue[];
30167
32835
  /** Filters for issues with any of the provided subtypes. */
30168
32836
  'issue.subtype'?: string[];
30169
32837
  /**
@@ -30199,6 +32867,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
30199
32867
  sort_by?: string[];
30200
32868
  /** Filters for records in the provided stage(s) by name. */
30201
32869
  'stage.name'?: string[];
32870
+ /** List of IDs of the custom stages which will be used for filtering. */
32871
+ 'stage.stages'?: string[];
30202
32872
  /** Filters for issues that are staged. */
30203
32873
  'staged_info.is_staged'?: boolean;
30204
32874
  /** Filters for work with any of the provided states. */
@@ -30224,6 +32894,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
30224
32894
  * @example ["TAG-12345"]
30225
32895
  */
30226
32896
  tags?: string[];
32897
+ /**
32898
+ * Filters for tickets with any of the provided accounts.
32899
+ * @example ["ACC-12345"]
32900
+ */
32901
+ 'ticket.account'?: string[];
30227
32902
  /** Filters for tickets that are associated with any of the brands. */
30228
32903
  'ticket.brand'?: string[];
30229
32904
  /** Filters for tickets with any of the provided channels. */
@@ -30261,6 +32936,12 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
30261
32936
  'ticket.visibility'?: number[];
30262
32937
  /** Filters for work of the provided types. */
30263
32938
  type?: WorkType[];
32939
+ /**
32940
+ * Filters for work belonging to the given vista.
32941
+ * @format id
32942
+ * @example "VISTA-12345"
32943
+ */
32944
+ vista?: string;
30264
32945
  }, params?: RequestParams) => Promise<AxiosResponse<WorksExportResponse, any, {}>>;
30265
32946
  /**
30266
32947
  * @description Exports a collection of work items.
@@ -30334,6 +33015,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
30334
33015
  * @example ["ACC-12345"]
30335
33016
  */
30336
33017
  'issue.accounts'?: string[];
33018
+ /** Filters for issues belonging to specific groups. */
33019
+ 'issue.group'?: string[];
30337
33020
  /** Filters for issues with any of the provided priorities. */
30338
33021
  'issue.priority'?: IssuePriority[];
30339
33022
  /** Filters for issues with any of the provided priority enum ids. */
@@ -30345,8 +33028,18 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
30345
33028
  'issue.rev_orgs'?: string[];
30346
33029
  /** Filters for records with any of the provided SLA stages. */
30347
33030
  'issue.sla_summary.stage'?: SlaSummaryStage[];
33031
+ /** Filters for the provided space IDs. */
33032
+ 'issue.space.ids'?: string[];
33033
+ /** Whether to include child spaces. */
33034
+ 'issue.space.include_children'?: boolean;
33035
+ /** Whether to include objects not associated with any space. */
33036
+ 'issue.space.include_global'?: boolean;
33037
+ /** Whether to include parent spaces. */
33038
+ 'issue.space.include_parents'?: boolean;
30348
33039
  /** Filters for issues with any of the sprint. */
30349
33040
  'issue.sprint'?: string[];
33041
+ /** Filters for issues with any of the provided sprint states. */
33042
+ 'issue.sprint_state'?: WorksFilterIssueSprintStateValue[];
30350
33043
  /** Filters for issues with any of the provided subtypes. */
30351
33044
  'issue.subtype'?: string[];
30352
33045
  /**
@@ -30392,6 +33085,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
30392
33085
  sort_by?: string[];
30393
33086
  /** Filters for records in the provided stage(s) by name. */
30394
33087
  'stage.name'?: string[];
33088
+ /** List of IDs of the custom stages which will be used for filtering. */
33089
+ 'stage.stages'?: string[];
30395
33090
  /** Filters for issues that are staged. */
30396
33091
  'staged_info.is_staged'?: boolean;
30397
33092
  /** Filters for work with any of the provided states. */
@@ -30417,6 +33112,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
30417
33112
  * @example ["TAG-12345"]
30418
33113
  */
30419
33114
  tags?: string[];
33115
+ /**
33116
+ * Filters for tickets with any of the provided accounts.
33117
+ * @example ["ACC-12345"]
33118
+ */
33119
+ 'ticket.account'?: string[];
30420
33120
  /** Filters for tickets that are associated with any of the brands. */
30421
33121
  'ticket.brand'?: string[];
30422
33122
  /** Filters for tickets with any of the provided channels. */
@@ -30454,6 +33154,12 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
30454
33154
  'ticket.visibility'?: number[];
30455
33155
  /** Filters for work of the provided types. */
30456
33156
  type?: WorkType[];
33157
+ /**
33158
+ * Filters for work belonging to the given vista.
33159
+ * @format id
33160
+ * @example "VISTA-12345"
33161
+ */
33162
+ vista?: string;
30457
33163
  }, params?: RequestParams) => Promise<AxiosResponse<WorksListResponse, any, {}>>;
30458
33164
  /**
30459
33165
  * @description Lists a collection of work items.
@@ -30476,3 +33182,4 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
30476
33182
  */
30477
33183
  worksUpdate: (data: WorksUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<WorksUpdateResponse, any, {}>>;
30478
33184
  }
33185
+ export {};