@devrev/typescript-sdk 1.1.22 → 1.1.24

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.
@@ -32,11 +32,17 @@ export type Account = OrgBase & {
32
32
  * @example "don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"
33
33
  */
34
34
  stock_schema_fragment?: string;
35
+ /** Subtype corresponding to the custom type fragment. */
36
+ subtype?: string;
35
37
  /** Tags associated with an object. */
36
38
  tags?: TagWithValue[];
37
39
  /** The Tier of the corresponding Account. */
38
40
  tier?: string;
39
41
  };
42
+ /** account-search-summary */
43
+ export type AccountSearchSummary = SearchSummaryBase & {
44
+ account: AccountSummary;
45
+ };
40
46
  /** account-summary */
41
47
  export type AccountSummary = OrgBaseSummary;
42
48
  /**
@@ -59,8 +65,7 @@ export interface AccountsCreateRequest {
59
65
  domains?: string[];
60
66
  /**
61
67
  * External refs are unique identifiers from your customer system of
62
- * records, stored as a list. Currently the length of this field is
63
- * limited to 1.
68
+ * records, stored as a list.
64
69
  */
65
70
  external_refs?: string[];
66
71
  /** List of Dev users owning this account. */
@@ -74,6 +79,11 @@ export interface AccountsCreateRequest {
74
79
  tags?: SetTagWithValue[];
75
80
  /** The tier of the account. */
76
81
  tier?: string;
82
+ /**
83
+ * List of company websites. Example - ['www.devrev.ai',
84
+ * 'www.marketplace.devrev.ai'].
85
+ */
86
+ websites?: string[];
77
87
  }
78
88
  /**
79
89
  * accounts-create-response
@@ -109,6 +119,8 @@ export interface AccountsExportRequest {
109
119
  created_date?: DateTimeFilter;
110
120
  /** Filters for custom fields. */
111
121
  custom_fields?: object;
122
+ /** Array of display names of accounts to be filtered. */
123
+ display_name?: string[];
112
124
  /** Domains for accounts to be filtered. */
113
125
  domains?: string[];
114
126
  /** Array of references of accounts to be filtered. */
@@ -145,6 +157,8 @@ export interface AccountsFilters {
145
157
  created_date?: DateTimeFilter;
146
158
  /** Filters for custom fields. */
147
159
  custom_fields?: object;
160
+ /** Array of display names of accounts to be filtered. */
161
+ display_name?: string[];
148
162
  /** Domains for accounts to be filtered. */
149
163
  domains?: string[];
150
164
  /** Array of references of accounts to be filtered. */
@@ -190,6 +204,8 @@ export interface AccountsListRequest {
190
204
  cursor?: string;
191
205
  /** Filters for custom fields. */
192
206
  custom_fields?: object;
207
+ /** Array of display names of accounts to be filtered. */
208
+ display_name?: string[];
193
209
  /** Domains for accounts to be filtered. */
194
210
  domains?: string[];
195
211
  /** Array of references of accounts to be filtered. */
@@ -250,10 +266,7 @@ export interface AccountsUpdateRequest {
250
266
  display_name?: string;
251
267
  /** Updated list of company's domain names. Example - ['devrev.ai']. */
252
268
  domains?: string[];
253
- /**
254
- * Updated External Refs of account. Currently the length of this
255
- * field is limited to 1.
256
- */
269
+ /** Updated External Refs of account. */
257
270
  external_refs?: string[];
258
271
  /**
259
272
  * The ID of account to update.
@@ -270,7 +283,7 @@ export interface AccountsUpdateRequest {
270
283
  /** Updated tags list associated with the account. */
271
284
  tags?: SetTagWithValue[];
272
285
  /** Updated tier of the account. */
273
- tier?: string;
286
+ tier?: string | null;
274
287
  }
275
288
  /** accounts-update-request-artifacts */
276
289
  export interface AccountsUpdateRequestArtifacts {
@@ -296,6 +309,11 @@ export type AggregatedSchema = object;
296
309
  export interface AggregatedSchemaGetRequest {
297
310
  /** The list of custom schema fragment DONs which are to be aggregated. */
298
311
  custom_schema_fragment_ids: string[];
312
+ /**
313
+ * The leaf type. Used for inferring the default stage diagram and
314
+ * tenant fragment ID.
315
+ */
316
+ leaf_type?: string;
299
317
  /** Per object schema, if associated with the leaf type. */
300
318
  per_object_schema?: FieldDescriptor[];
301
319
  /** The stock schema fragment which is to be aggregated. */
@@ -377,6 +395,39 @@ export type AppFragment = CustomSchemaFragmentBase & {
377
395
  /** App this fragment applies to. */
378
396
  app?: string;
379
397
  };
398
+ /** app-fragment-summary */
399
+ export type AppFragmentSummary = CustomSchemaFragmentBaseSummary;
400
+ /**
401
+ * archetype-metric-target
402
+ * Metric with corresponding target values.
403
+ */
404
+ export interface ArchetypeMetricTarget {
405
+ /**
406
+ * If true, the schedule attached to this metric is out of schedule at
407
+ * the time of the query.
408
+ */
409
+ is_out_of_schedule?: boolean;
410
+ metric_definition: MetricDefinitionSummary;
411
+ org_schedule?: OrgScheduleSummary;
412
+ /**
413
+ * Time in minutes that remains on a paused metric.
414
+ * @format int32
415
+ */
416
+ remaining_time?: number;
417
+ /**
418
+ * Time at which the metric would breach SLA if no action taken.
419
+ * @format date-time
420
+ * @example "2023-01-01T12:00:00.000Z"
421
+ */
422
+ target_time?: string;
423
+ /**
424
+ * Time at which the metric would reach the SLA warning limit if no
425
+ * action taken.
426
+ * @format date-time
427
+ * @example "2023-01-01T12:00:00.000Z"
428
+ */
429
+ warning_target_time?: string;
430
+ }
380
431
  /** article */
381
432
  export type Article = AtomBase & {
382
433
  /** Details of the parts relevant to the article. */
@@ -385,6 +436,16 @@ export type Article = AtomBase & {
385
436
  description?: string;
386
437
  /** Artifacts containing the extracted content. */
387
438
  extracted_content?: ArtifactSummary[];
439
+ /**
440
+ * Number of downvotes on the article.
441
+ * @format int32
442
+ */
443
+ num_downvotes?: number;
444
+ /**
445
+ * Number of upvotes on the article.
446
+ * @format int32
447
+ */
448
+ num_upvotes?: number;
388
449
  parent?: DirectorySummary;
389
450
  /** Rank of the article. */
390
451
  rank?: string;
@@ -393,6 +454,10 @@ export type Article = AtomBase & {
393
454
  /** Title of the article. */
394
455
  title?: string;
395
456
  };
457
+ /** article-search-summary */
458
+ export type ArticleSearchSummary = SearchSummaryBase & {
459
+ article: ArticleSummary;
460
+ };
396
461
  /** Status of the article. */
397
462
  export declare enum ArticleStatus {
398
463
  Archived = "archived",
@@ -400,6 +465,13 @@ export declare enum ArticleStatus {
400
465
  Published = "published",
401
466
  ReviewNeeded = "review_needed"
402
467
  }
468
+ /** article-summary */
469
+ export type ArticleSummary = AtomBaseSummary & {
470
+ /** Resource details. */
471
+ resource?: ResourceSummary;
472
+ /** Title of the article. */
473
+ title?: string;
474
+ };
403
475
  /** articles-count-request */
404
476
  export interface ArticlesCountRequest {
405
477
  /**
@@ -422,6 +494,8 @@ export interface ArticlesCountRequest {
422
494
  * @example ["DEVU-12345"]
423
495
  */
424
496
  owned_by?: string[];
497
+ /** Filter for articles based on intended audience. */
498
+ shared_with?: SharedWithMembershipFilter[];
425
499
  }
426
500
  /** articles-count-response */
427
501
  export interface ArticlesCountResponse {
@@ -472,7 +546,7 @@ export interface ArticlesCreateRequest {
472
546
  published_at?: string;
473
547
  resource: ArticlesCreateRequestResource;
474
548
  /** Information about the role the member receives due to the share. */
475
- shared_with?: SharedWithMembership[];
549
+ shared_with?: SetSharedWithMembership[];
476
550
  /** Status of the article. */
477
551
  status?: ArticleStatus;
478
552
  /** Tags associated with the article. */
@@ -573,6 +647,8 @@ export interface ArticlesListRequest {
573
647
  * @example ["DEVU-12345"]
574
648
  */
575
649
  owned_by?: string[];
650
+ /** Filter for articles based on intended audience. */
651
+ shared_with?: SharedWithMembershipFilter[];
576
652
  }
577
653
  /**
578
654
  * articles-list-response
@@ -691,7 +767,7 @@ export interface ArticlesUpdateRequestReorder {
691
767
  /** articles-update-request-shared-with */
692
768
  export interface ArticlesUpdateRequestSharedWith {
693
769
  /** Sets the field to the provided membership list. */
694
- set?: SharedWithMembership[];
770
+ set?: SetSharedWithMembership[];
695
771
  }
696
772
  /** articles-update-request-tags */
697
773
  export interface ArticlesUpdateRequestTags {
@@ -702,8 +778,67 @@ export interface ArticlesUpdateRequestTags {
702
778
  export interface ArticlesUpdateResponse {
703
779
  article: Article;
704
780
  }
781
+ /** artifact */
782
+ export type Artifact = AtomBase;
783
+ /** artifact-search-summary */
784
+ export type ArtifactSearchSummary = SearchSummaryBase & {
785
+ artifact: ArtifactSummary;
786
+ };
705
787
  /** artifact-summary */
706
788
  export type ArtifactSummary = AtomBaseSummary;
789
+ /**
790
+ * artifact-version
791
+ * The version of the artifact.
792
+ */
793
+ export interface ArtifactVersion {
794
+ modified_by?: UserSummary;
795
+ /**
796
+ * The timestamp at which the version was created.
797
+ * @format date-time
798
+ * @example "2023-01-01T12:00:00.000Z"
799
+ */
800
+ timestamp: string;
801
+ /** The version of the artifact. */
802
+ version: string;
803
+ }
804
+ /**
805
+ * artifacts-get-request
806
+ * The request to get an artifact's information.
807
+ */
808
+ export interface ArtifactsGetRequest {
809
+ /**
810
+ * The requested artifact's ID.
811
+ * @example "ARTIFACT-12345"
812
+ */
813
+ id: string;
814
+ /** The version of the artifact that needs to be fetched. */
815
+ version?: string;
816
+ }
817
+ /**
818
+ * artifacts-get-response
819
+ * The response to getting an artifact's information.
820
+ */
821
+ export interface ArtifactsGetResponse {
822
+ artifact: Artifact;
823
+ /** The version of the artifact. */
824
+ version: ArtifactVersion;
825
+ }
826
+ /**
827
+ * artifacts-list-request
828
+ * The request to list artifacts attached to an object.
829
+ */
830
+ export interface ArtifactsListRequest {
831
+ /** The ID of the object to filter artifacts. */
832
+ parent_id?: string;
833
+ }
834
+ /**
835
+ * artifacts-list-response
836
+ * The response to list artifacts attached to an object.
837
+ */
838
+ export interface ArtifactsListResponse {
839
+ /** The artifact's information. */
840
+ artifacts: Artifact[];
841
+ }
707
842
  /**
708
843
  * artifacts-locate-request
709
844
  * The request to get an artifact's download URL.
@@ -819,6 +954,35 @@ export interface AtomBaseSummary {
819
954
  /** Globally unique object ID. */
820
955
  id: string;
821
956
  }
957
+ /** atom-summary */
958
+ export type AtomSummary = (AccountSummary | AppFragmentSummary | CapabilitySummary | ConversationSummary | CustomTypeFragmentSummary | DevUserSummary | EngagementSummary | EnhancementSummary | FeatureSummary | IssueSummary | MeetingSummary | OpportunitySummary | ProductSummary | RevOrgSummary | RevUserSummary | ServiceAccountSummary | SysUserSummary | TagSummary | TaskSummary | TenantFragmentSummary | TicketSummary | TimelineCommentSummary | WebhookSummary) & {
959
+ type: AtomType;
960
+ };
961
+ export declare enum AtomType {
962
+ Account = "account",
963
+ AppFragment = "app_fragment",
964
+ Capability = "capability",
965
+ Conversation = "conversation",
966
+ CustomTypeFragment = "custom_type_fragment",
967
+ DevUser = "dev_user",
968
+ Engagement = "engagement",
969
+ Enhancement = "enhancement",
970
+ Feature = "feature",
971
+ Issue = "issue",
972
+ Meeting = "meeting",
973
+ Opportunity = "opportunity",
974
+ Product = "product",
975
+ RevOrg = "rev_org",
976
+ RevUser = "rev_user",
977
+ ServiceAccount = "service_account",
978
+ SysUser = "sys_user",
979
+ Tag = "tag",
980
+ Task = "task",
981
+ TenantFragment = "tenant_fragment",
982
+ Ticket = "ticket",
983
+ TimelineComment = "timeline_comment",
984
+ Webhook = "webhook"
985
+ }
822
986
  /**
823
987
  * auth-connection
824
988
  * Connection object that specifies the configuration for an
@@ -951,8 +1115,10 @@ export declare enum AuthTokenGrantType {
951
1115
  /** The type of the requested token. */
952
1116
  export declare enum AuthTokenRequestedTokenType {
953
1117
  UrnDevrevParamsOauthTokenTypeAat = "urn:devrev:params:oauth:token-type:aat",
1118
+ UrnDevrevParamsOauthTokenTypeAatActAs = "urn:devrev:params:oauth:token-type:aat:act-as",
954
1119
  UrnDevrevParamsOauthTokenTypeAatPublic = "urn:devrev:params:oauth:token-type:aat:public",
955
1120
  UrnDevrevParamsOauthTokenTypeDev = "urn:devrev:params:oauth:token-type:dev",
1121
+ UrnDevrevParamsOauthTokenTypeDevConnect = "urn:devrev:params:oauth:token-type:dev:connect",
956
1122
  UrnDevrevParamsOauthTokenTypeGat = "urn:devrev:params:oauth:token-type:gat",
957
1123
  UrnDevrevParamsOauthTokenTypePat = "urn:devrev:params:oauth:token-type:pat",
958
1124
  UrnDevrevParamsOauthTokenTypePatActAs = "urn:devrev:params:oauth:token-type:pat:act-as",
@@ -993,7 +1159,10 @@ export declare enum AuthTokenTokenType {
993
1159
  * type.
994
1160
  */
995
1161
  export interface AuthTokensCreateRequest {
996
- /** The unique ID of the Dev user to impersonate. */
1162
+ /**
1163
+ * The unique ID of the Dev user or the service account to
1164
+ * impersonate.
1165
+ */
997
1166
  act_as?: string;
998
1167
  /** The expected audience values with respect to the token. */
999
1168
  aud?: string[];
@@ -1209,6 +1378,101 @@ export interface AuthTokensUserTraits {
1209
1378
  export type Capability = PartBase;
1210
1379
  /** capability-summary */
1211
1380
  export type CapabilitySummary = PartBaseSummary;
1381
+ /**
1382
+ * client-context
1383
+ * Properties of client to be used in track API.
1384
+ */
1385
+ export interface ClientContext {
1386
+ /** Properties of client's browser to be used in track API. */
1387
+ browser?: ClientContextBrowser;
1388
+ /** Properties of client's CPU to be used in track API. */
1389
+ cpu?: ClientContextCpu;
1390
+ /** Properties of client's device to be used in track API. */
1391
+ device?: ClientContextDevice;
1392
+ /** Properties of client's engine to be used in track API. */
1393
+ engine?: ClientContextEngine;
1394
+ /** IP address of the client. */
1395
+ ip?: string;
1396
+ /** The client's locale, example: en-US. */
1397
+ locale?: string;
1398
+ /** Properties of client's OS to be used in track API. */
1399
+ os?: ClientContextOs;
1400
+ /** Properties of client's page to be used in track API. */
1401
+ page?: ClientContextPage;
1402
+ /** The client's timezone, example: Asia/Kolkata. */
1403
+ timezone?: string;
1404
+ /**
1405
+ * User agent of the client, example: Mozilla/5.0 (Macintosh; Intel
1406
+ * Mac OS X.
1407
+ */
1408
+ user_agent?: string;
1409
+ }
1410
+ /**
1411
+ * client-context-browser
1412
+ * Properties of client's browser to be used in track API.
1413
+ */
1414
+ export interface ClientContextBrowser {
1415
+ /** The browser's name, example: Chrome, Safari. */
1416
+ name?: string;
1417
+ /** The browser's version, example: 53.0.2785.143. */
1418
+ version?: string;
1419
+ }
1420
+ /**
1421
+ * client-context-cpu
1422
+ * Properties of client's CPU to be used in track API.
1423
+ */
1424
+ export interface ClientContextCpu {
1425
+ /** CPU architecture, example: amd64. */
1426
+ architecture?: string;
1427
+ }
1428
+ /**
1429
+ * client-context-device
1430
+ * Properties of client's device to be used in track API.
1431
+ */
1432
+ export interface ClientContextDevice {
1433
+ /** Device manufacturer, example: Apple. */
1434
+ manufacturer?: string;
1435
+ /** Device model, example: iphone 6s. */
1436
+ model?: string;
1437
+ /** Device type, example: mobile, tablet, desktop. */
1438
+ type?: string;
1439
+ }
1440
+ /**
1441
+ * client-context-engine
1442
+ * Properties of client's engine to be used in track API.
1443
+ */
1444
+ export interface ClientContextEngine {
1445
+ /** The engine's name, example: Blink, WebKit. */
1446
+ name?: string;
1447
+ /** The engine's version, example: 537.36. */
1448
+ version?: string;
1449
+ }
1450
+ /**
1451
+ * client-context-os
1452
+ * Properties of client's OS to be used in track API.
1453
+ */
1454
+ export interface ClientContextOs {
1455
+ /** The OS's name, example : Windows, Mac OS X. */
1456
+ name?: string;
1457
+ /** The OS's version, example : 10.11.1. */
1458
+ version?: string;
1459
+ }
1460
+ /**
1461
+ * client-context-page
1462
+ * Properties of client's page to be used in track API.
1463
+ */
1464
+ export interface ClientContextPage {
1465
+ /** Page domain, example: devrev.ai */
1466
+ domain?: string;
1467
+ /** Page path, example: /pricing */
1468
+ path?: string;
1469
+ /** Page referrer, example: https://devrev.ai */
1470
+ referrer?: string;
1471
+ /** Page title, example: Pricing */
1472
+ title?: string;
1473
+ /** Page URL, example: https://devrev.ai/pricing */
1474
+ url?: string;
1475
+ }
1212
1476
  /** code-change */
1213
1477
  export type CodeChange = AtomBase & {
1214
1478
  /** Name of the code branch in the repo. */
@@ -1317,6 +1581,7 @@ export type Conversation = AtomBase & {
1317
1581
  metadata?: ConversationMetadata;
1318
1582
  /** Owner IDs for the conversation. */
1319
1583
  owned_by?: UserSummary[];
1584
+ sla_tracker?: SlaTrackerSummary;
1320
1585
  /** Describes the current stage of a work item. */
1321
1586
  stage?: LegacyStage;
1322
1587
  /** Tags associated with the object. */
@@ -1335,6 +1600,10 @@ export interface ConversationMetadata {
1335
1600
  */
1336
1601
  url_context?: string;
1337
1602
  }
1603
+ /** conversation-search-summary */
1604
+ export type ConversationSearchSummary = SearchSummaryBase & {
1605
+ conversation: ConversationSummary;
1606
+ };
1338
1607
  /** conversation-summary */
1339
1608
  export type ConversationSummary = AtomBaseSummary & {
1340
1609
  /** Title of the conversation object. */
@@ -1614,6 +1883,72 @@ export interface ConversationsUpdateRequestUserSessions {
1614
1883
  export interface ConversationsUpdateResponse {
1615
1884
  conversation: Conversation;
1616
1885
  }
1886
+ /**
1887
+ * create-email-info
1888
+ * Information related to an email.
1889
+ */
1890
+ export interface CreateEmailInfo {
1891
+ /** The address of the email address. */
1892
+ address: string;
1893
+ /** The name of the email address. */
1894
+ name?: string;
1895
+ /** The ID of the user associated with the email address. */
1896
+ user?: string;
1897
+ }
1898
+ /**
1899
+ * create-email-inline-attachment
1900
+ * An inline attachment.
1901
+ */
1902
+ export interface CreateEmailInlineAttachment {
1903
+ /**
1904
+ * The artifact of the attachment.
1905
+ * @example "ARTIFACT-12345"
1906
+ */
1907
+ artifact?: string;
1908
+ /** The content id of the attachment. */
1909
+ content_id?: string;
1910
+ }
1911
+ /**
1912
+ * create-email-preview-widget
1913
+ * An email preview widget.
1914
+ */
1915
+ export interface CreateEmailPreviewWidget {
1916
+ /** The list of bcc addresses. */
1917
+ bcc?: CreateEmailInfo[];
1918
+ /** The list of cc addresses. */
1919
+ cc?: CreateEmailInfo[];
1920
+ /** The list of from addresses. */
1921
+ from?: CreateEmailInfo[];
1922
+ /** The html body of the email. */
1923
+ html_body?: string;
1924
+ /** The in reply to of the email. */
1925
+ in_reply_to?: string;
1926
+ /** The list of inline attachments. */
1927
+ inlines?: CreateEmailInlineAttachment[];
1928
+ /** The message id of the email. */
1929
+ message_id?: string;
1930
+ /**
1931
+ * The raw email artifact.
1932
+ * @example "ARTIFACT-12345"
1933
+ */
1934
+ raw_email_artifact?: string;
1935
+ /** The list of references in the email. */
1936
+ references?: string[];
1937
+ /** The list of reply to addresses. */
1938
+ reply_to?: CreateEmailInfo[];
1939
+ /**
1940
+ * The time the email was sent.
1941
+ * @format date-time
1942
+ * @example "2023-01-01T12:00:00.000Z"
1943
+ */
1944
+ sent_timestamp?: string;
1945
+ /** The subject of the email. */
1946
+ subject?: string;
1947
+ /** The text body of the email. */
1948
+ text_body?: string;
1949
+ /** The list of to addresses. */
1950
+ to?: CreateEmailInfo[];
1951
+ }
1617
1952
  /** create-org-schedule-interval */
1618
1953
  export interface CreateOrgScheduleInterval {
1619
1954
  /**
@@ -1656,6 +1991,11 @@ export interface CreateWeeklyOrgScheduleInterval {
1656
1991
  */
1657
1992
  to: number;
1658
1993
  }
1994
+ /**
1995
+ * curated-vista-summary
1996
+ * Static collection of Devrev objects.
1997
+ */
1998
+ export type CuratedVistaSummary = VistaBaseSummary;
1659
1999
  /** custom-schema-fragment */
1660
2000
  export type CustomSchemaFragment = (AppFragment | CustomTypeFragment | TenantFragment) & {
1661
2001
  type: CustomSchemaFragmentType;
@@ -1678,7 +2018,11 @@ export type CustomSchemaFragmentBase = AtomBase & {
1678
2018
  fragment_type?: CustomSchemaFragmentFragmentType;
1679
2019
  /** Leaf type this fragment applies to. */
1680
2020
  leaf_type?: string;
2021
+ new_fragment_ref?: CustomSchemaFragmentSummary;
2022
+ old_fragment_ref?: CustomSchemaFragmentSummary;
1681
2023
  };
2024
+ /** custom-schema-fragment-base-summary */
2025
+ export type CustomSchemaFragmentBaseSummary = AtomBaseSummary;
1682
2026
  /**
1683
2027
  * custom-schema-fragment-condition
1684
2028
  * The condition associated with a field.
@@ -1690,6 +2034,10 @@ export declare enum CustomSchemaFragmentFragmentType {
1690
2034
  CustomType = "custom_type",
1691
2035
  Tenant = "tenant"
1692
2036
  }
2037
+ /** custom-schema-fragment-summary */
2038
+ export type CustomSchemaFragmentSummary = (AppFragmentSummary | CustomTypeFragmentSummary | TenantFragmentSummary) & {
2039
+ type: CustomSchemaFragmentType;
2040
+ };
1693
2041
  export declare enum CustomSchemaFragmentType {
1694
2042
  AppFragment = "app_fragment",
1695
2043
  CustomTypeFragment = "custom_type_fragment",
@@ -1709,8 +2057,8 @@ export interface CustomSchemaFragmentsListRequest {
1709
2057
  /** The list of app names. */
1710
2058
  app?: string[];
1711
2059
  /**
1712
- * The cursor to resume iteration from, otherwise if not provided,
1713
- * then iteration starts from the beginning.
2060
+ * The cursor to resume iteration from. If not provided, then
2061
+ * iteration starts from the beginning.
1714
2062
  */
1715
2063
  cursor?: string;
1716
2064
  /** Whether only deprecated fragments should be filtered. */
@@ -1722,6 +2070,19 @@ export interface CustomSchemaFragmentsListRequest {
1722
2070
  * @format int32
1723
2071
  */
1724
2072
  limit?: number;
2073
+ /**
2074
+ * The iteration mode to use. If "after", then entries after the provided
2075
+ * cursor will be returned, or if no cursor is provided, then from the
2076
+ * beginning. If "before", then entries before the provided cursor will be
2077
+ * returned, or if no cursor is provided, then from the end. Entries will
2078
+ * always be returned in the specified sort-by order.
2079
+ */
2080
+ mode?: ListMode;
2081
+ /**
2082
+ * List of fields which are not required in the payload and can be
2083
+ * pruned away.
2084
+ */
2085
+ prune?: CustomSchemaFragmentsListRequestPrune[];
1725
2086
  /** The list of fields to sort the items by and how to sort them. */
1726
2087
  sort_by?: string[];
1727
2088
  /** The list of subtypes. */
@@ -1729,13 +2090,21 @@ export interface CustomSchemaFragmentsListRequest {
1729
2090
  /** Filters for custom schema fragment of the provided types. */
1730
2091
  types?: CustomSchemaFragmentType[];
1731
2092
  }
2093
+ export declare enum CustomSchemaFragmentsListRequestPrune {
2094
+ Fields = "fields"
2095
+ }
1732
2096
  /** custom-schema-fragments-list-response */
1733
2097
  export interface CustomSchemaFragmentsListResponse {
1734
2098
  /**
1735
- * The cursor to resume iteration from, otherwise if not provided,
1736
- * then iteration starts from the beginning.
2099
+ * The cursor used to iterate subsequent results in accordance to the
2100
+ * sort order. If not set, then no later elements exist.
1737
2101
  */
1738
- cursor?: string;
2102
+ next_cursor?: string;
2103
+ /**
2104
+ * The cursor used to iterate preceding results in accordance to the
2105
+ * sort order. If not set, then no prior elements exist.
2106
+ */
2107
+ prev_cursor?: string;
1739
2108
  /** The custom schema fragments. */
1740
2109
  result: CustomSchemaFragment[];
1741
2110
  }
@@ -1751,6 +2120,8 @@ export type CustomSchemaFragmentsSetRequest = (CustomSchemaFragmentsSetRequestAp
1751
2120
  description: string;
1752
2121
  /** List of all fields in this fragment. */
1753
2122
  fields?: SchemaFieldDescriptor[];
2123
+ /** Whether the leaf type corresponds to a custom object */
2124
+ is_custom_leaf_type?: boolean;
1754
2125
  /** The leaf type this fragment applies to. */
1755
2126
  leaf_type: string;
1756
2127
  type: CustomSchemaFragmentsSetRequestType;
@@ -1769,6 +2140,8 @@ export interface CustomSchemaFragmentsSetRequestCustomTypeFragment {
1769
2140
  path?: CustomTypePathComponent[];
1770
2141
  /** The ID of the associated custom stage diagram. */
1771
2142
  stage_diagram?: string;
2143
+ /** List of Per-DevOrg stock field overrides. */
2144
+ stock_field_overrides?: StockFieldOverride[];
1772
2145
  /** The string used to populate the subtype in the leaf type. */
1773
2146
  subtype: string;
1774
2147
  /** The display name of the subtype. */
@@ -1776,6 +2149,8 @@ export interface CustomSchemaFragmentsSetRequestCustomTypeFragment {
1776
2149
  }
1777
2150
  /** custom-schema-fragments-set-request-tenant-fragment */
1778
2151
  export interface CustomSchemaFragmentsSetRequestTenantFragment {
2152
+ /** The display ID prefix for the custom object. */
2153
+ id_prefix?: string;
1779
2154
  /** List of Per-DevOrg stock field overrides. */
1780
2155
  stock_field_overrides?: StockFieldOverride[];
1781
2156
  }
@@ -1789,6 +2164,24 @@ export interface CustomSchemaFragmentsSetResponse {
1789
2164
  /** The ID of the custom schema fragment. */
1790
2165
  id: string;
1791
2166
  }
2167
+ /**
2168
+ * custom-schema-spec
2169
+ * Requested custom schemas described abstractly. Every provided schema's
2170
+ * custom field must be specified, otherwise a bad request error is
2171
+ * returned. If a new custom schema specifier is provided, then it will be
2172
+ * added to the work, otherwise if a custom schema is omitted from the
2173
+ * specifier, it remains unmodified.
2174
+ */
2175
+ export interface CustomSchemaSpec {
2176
+ /** List of apps that are requested. */
2177
+ apps?: string[];
2178
+ /** Name of the subtype requested. */
2179
+ subtype?: string;
2180
+ /** Whether the tenant schema is requested. */
2181
+ tenant_fragment?: boolean;
2182
+ /** Whether to enforce required fields validation. */
2183
+ validate_required_fields?: boolean;
2184
+ }
1792
2185
  /** custom-type-fragment */
1793
2186
  export type CustomTypeFragment = CustomSchemaFragmentBase & {
1794
2187
  stage_diagram?: StageDiagramSummary;
@@ -1800,11 +2193,19 @@ export type CustomTypeFragment = CustomSchemaFragmentBase & {
1800
2193
  */
1801
2194
  subtype_display_name?: string;
1802
2195
  };
2196
+ /** custom-type-fragment-summary */
2197
+ export type CustomTypeFragmentSummary = CustomSchemaFragmentBaseSummary;
1803
2198
  /**
1804
2199
  * custom-type-path-component
1805
2200
  * Path component for rendering custom type lists in tree form.
1806
2201
  */
1807
2202
  export type CustomTypePathComponent = object;
2203
+ /** dashboard-search-summary */
2204
+ export type DashboardSearchSummary = SearchSummaryBase & {
2205
+ dashboard: DashboardSummary;
2206
+ };
2207
+ /** dashboard-summary */
2208
+ export type DashboardSummary = AtomBaseSummary;
1808
2209
  /**
1809
2210
  * date-filter
1810
2211
  * Provides ways to specify date ranges on objects.
@@ -2105,6 +2506,60 @@ export type DirectorySummary = AtomBaseSummary;
2105
2506
  * Information to define dynamic groups.
2106
2507
  */
2107
2508
  export type DynamicGroupInfo = object;
2509
+ /**
2510
+ * dynamic-vista-summary
2511
+ * Dynamic collection of Devrev objects, all adhering to a specific
2512
+ * filter.
2513
+ */
2514
+ export type DynamicVistaSummary = VistaBaseSummary;
2515
+ /** email-info */
2516
+ export interface EmailInfo {
2517
+ /** The email address. */
2518
+ address: string;
2519
+ /** The email recipient's name. */
2520
+ name?: string;
2521
+ user?: UserSummary;
2522
+ }
2523
+ /** email-inline-attachment */
2524
+ export interface EmailInlineAttachment {
2525
+ artifact?: ArtifactSummary;
2526
+ /** The content id of the attachment. */
2527
+ content_id?: string;
2528
+ }
2529
+ /** email-preview-widget */
2530
+ export type EmailPreviewWidget = SnapWidgetBase & {
2531
+ /** The list of bcc addresses. */
2532
+ bcc: EmailInfo[];
2533
+ /** The list of cc addresses. */
2534
+ cc: EmailInfo[];
2535
+ /** The list of from addresses. */
2536
+ from: EmailInfo[];
2537
+ /** The html body of the email. */
2538
+ html_body?: string;
2539
+ /** The in-reply-to header of the email. */
2540
+ in_reply_to?: string;
2541
+ /** The list of inline attachments. */
2542
+ inlines: EmailInlineAttachment[];
2543
+ /** The message id of the email. */
2544
+ message_id?: string;
2545
+ raw_email_artifact?: ArtifactSummary;
2546
+ /** The references header in the email. */
2547
+ references: string[];
2548
+ /** The list of reply to addresses. */
2549
+ reply_to: EmailInfo[];
2550
+ /**
2551
+ * The time the email was sent.
2552
+ * @format date-time
2553
+ * @example "2023-01-01T12:00:00.000Z"
2554
+ */
2555
+ sent_timestamp?: string;
2556
+ /** The subject of the email. */
2557
+ subject?: string;
2558
+ /** The text body of the email. */
2559
+ text_body?: string;
2560
+ /** The list of to addresses. */
2561
+ to: EmailInfo[];
2562
+ };
2108
2563
  /** empty */
2109
2564
  export type Empty = object;
2110
2565
  /** engagement */
@@ -2112,6 +2567,8 @@ export type Engagement = AtomBase & {
2112
2567
  /** Description of the engagement object. */
2113
2568
  description?: string;
2114
2569
  };
2570
+ /** engagement-summary */
2571
+ export type EngagementSummary = AtomBaseSummary;
2115
2572
  /** Type of engagement. */
2116
2573
  export declare enum EngagementType {
2117
2574
  Call = "call",
@@ -2165,9 +2622,10 @@ export interface EngagementsCreateRequest {
2165
2622
  /**
2166
2623
  * IDs of the users that were part of the engagement.
2167
2624
  * @maxItems 50
2625
+ * @minItems 1
2168
2626
  * @example ["DEVU-12345"]
2169
2627
  */
2170
- members?: string[];
2628
+ members: string[];
2171
2629
  /**
2172
2630
  * The parent object ID in which the engagement was created.
2173
2631
  * Currently, only accounts and opportunities are supported.
@@ -2179,7 +2637,7 @@ export interface EngagementsCreateRequest {
2179
2637
  * @format date-time
2180
2638
  * @example "2023-01-01T12:00:00.000Z"
2181
2639
  */
2182
- scheduled_date?: string;
2640
+ scheduled_date: string;
2183
2641
  /** Tags associated with the engagement. */
2184
2642
  tags?: SetTagWithValue[];
2185
2643
  /** The title of the engagement. */
@@ -2331,11 +2789,16 @@ export interface Error {
2331
2789
  type?: string;
2332
2790
  }
2333
2791
  /** error-bad-request */
2334
- export type ErrorBadRequest = ErrorBase & (ErrorBadRequestBadRequest | ErrorBadRequestInvalidEnumValue | ErrorBadRequestInvalidField | ErrorBadRequestMissingDependency | ErrorBadRequestMissingRequiredField | ErrorBadRequestParseError | ErrorBadRequestValueNotPermitted) & {
2792
+ export type ErrorBadRequest = ErrorBase & (ErrorBadRequestBadRequest | ErrorBadRequestInvalidApiVersion | ErrorBadRequestInvalidEnumValue | ErrorBadRequestInvalidField | ErrorBadRequestMissingDependency | ErrorBadRequestMissingRequiredField | ErrorBadRequestParseError | ErrorBadRequestStaleSchemaFragments | ErrorBadRequestUnexpectedJsonType | ErrorBadRequestValueNotPermitted) & {
2335
2793
  type: ErrorBadRequestType;
2336
2794
  };
2337
2795
  /** error-bad-request-bad-request */
2338
2796
  export type ErrorBadRequestBadRequest = object;
2797
+ /** error-bad-request-invalid-api-version */
2798
+ export interface ErrorBadRequestInvalidApiVersion {
2799
+ /** The provided API version. */
2800
+ value: string;
2801
+ }
2339
2802
  /** error-bad-request-invalid-enum-value */
2340
2803
  export interface ErrorBadRequestInvalidEnumValue {
2341
2804
  /** The allowed values for the field. */
@@ -2352,6 +2815,8 @@ export interface ErrorBadRequestInvalidField {
2352
2815
  }
2353
2816
  /** error-bad-request-missing-dependency */
2354
2817
  export interface ErrorBadRequestMissingDependency {
2818
+ /** The dependent fields. */
2819
+ dependencies?: ErrorBadRequestMissingDependencyDependency[];
2355
2820
  /** The field on which the value depends. */
2356
2821
  dependent_field_name?: string;
2357
2822
  /** The value which needs to be set of the dependent field. */
@@ -2361,6 +2826,13 @@ export interface ErrorBadRequestMissingDependency {
2361
2826
  /** The value that was received. */
2362
2827
  provided_field_value?: string;
2363
2828
  }
2829
+ /** error-bad-request-missing-dependency-dependency */
2830
+ export interface ErrorBadRequestMissingDependencyDependency {
2831
+ /** The dependent field name. */
2832
+ field_name: string;
2833
+ /** The dependent field value. */
2834
+ field_value: string;
2835
+ }
2364
2836
  /** error-bad-request-missing-required-field */
2365
2837
  export interface ErrorBadRequestMissingRequiredField {
2366
2838
  /** The missing field's name. */
@@ -2368,17 +2840,46 @@ export interface ErrorBadRequestMissingRequiredField {
2368
2840
  }
2369
2841
  /** error-bad-request-parse-error */
2370
2842
  export type ErrorBadRequestParseError = object;
2843
+ /**
2844
+ * error-bad-request-stale-schema-fragments
2845
+ * Error indicating that the request contained one or more stale schema
2846
+ * fragments, which are schema fragments that have been replaced by a
2847
+ * newer version and are therefore considered deprecated schema fragments.
2848
+ * The caller should refresh and use the latest schema fragments in their
2849
+ * request.
2850
+ */
2851
+ export type ErrorBadRequestStaleSchemaFragments = object;
2371
2852
  export declare enum ErrorBadRequestType {
2372
2853
  BadRequest = "bad_request",
2854
+ InvalidApiVersion = "invalid_api_version",
2373
2855
  InvalidEnumValue = "invalid_enum_value",
2374
2856
  InvalidField = "invalid_field",
2375
2857
  MissingDependency = "missing_dependency",
2376
2858
  MissingRequiredField = "missing_required_field",
2377
2859
  ParseError = "parse_error",
2860
+ StaleSchemaFragments = "stale_schema_fragments",
2861
+ UnexpectedJsonType = "unexpected_json_type",
2378
2862
  ValueNotPermitted = "value_not_permitted"
2379
2863
  }
2864
+ /** error-bad-request-unexpected-json-type */
2865
+ export interface ErrorBadRequestUnexpectedJsonType {
2866
+ actual: ErrorBadRequestUnexpectedJsonTypeType;
2867
+ expected: ErrorBadRequestUnexpectedJsonTypeType;
2868
+ /** The field name that's invalid. */
2869
+ field_name: string;
2870
+ }
2871
+ export declare enum ErrorBadRequestUnexpectedJsonTypeType {
2872
+ Array = "array",
2873
+ Bool = "bool",
2874
+ Null = "null",
2875
+ Number = "number",
2876
+ Object = "object",
2877
+ String = "string"
2878
+ }
2380
2879
  /** error-bad-request-value-not-permitted */
2381
2880
  export interface ErrorBadRequestValueNotPermitted {
2881
+ /** The allowed values for the field. */
2882
+ allowed_values?: string[];
2382
2883
  /** The field whose value is not permitted. */
2383
2884
  field_name: string;
2384
2885
  /** The reason the value isn't permitted. */
@@ -2391,6 +2892,15 @@ export interface ErrorBase {
2391
2892
  /** The message associated with the error. */
2392
2893
  message?: string;
2393
2894
  }
2895
+ /** error-conflict */
2896
+ export type ErrorConflict = ErrorBase & ErrorConflictConflict & {
2897
+ type: ErrorConflictType;
2898
+ };
2899
+ /** error-conflict-conflict */
2900
+ export type ErrorConflictConflict = object;
2901
+ export declare enum ErrorConflictType {
2902
+ Conflict = "conflict"
2903
+ }
2394
2904
  /** error-forbidden */
2395
2905
  export type ErrorForbidden = ErrorBase & ErrorForbiddenForbidden & {
2396
2906
  type: ErrorForbiddenType;
@@ -2650,6 +3160,19 @@ export interface EventSourcesScheduleEventResponse {
2650
3160
  */
2651
3161
  event_key?: string;
2652
3162
  }
3163
+ /** event-survey-response-created */
3164
+ export interface EventSurveyResponseCreated {
3165
+ survey_response: SurveyResponse;
3166
+ }
3167
+ /** event-survey-response-deleted */
3168
+ export interface EventSurveyResponseDeleted {
3169
+ /** The ID of the survey response that was deleted. */
3170
+ id: string;
3171
+ }
3172
+ /** event-survey-response-updated */
3173
+ export interface EventSurveyResponseUpdated {
3174
+ survey_response: SurveyResponse;
3175
+ }
2653
3176
  /** event-tag-created */
2654
3177
  export interface EventTagCreated {
2655
3178
  tag: Tag;
@@ -2827,6 +3350,10 @@ export interface GroupMembersRemoveRequest {
2827
3350
  }
2828
3351
  /** group-members-remove-response */
2829
3352
  export type GroupMembersRemoveResponse = object;
3353
+ /** group-search-summary */
3354
+ export type GroupSearchSummary = SearchSummaryBase & {
3355
+ group: GroupSummary;
3356
+ };
2830
3357
  /** group-summary */
2831
3358
  export type GroupSummary = AtomBaseSummary & {
2832
3359
  /** Name of the group. */
@@ -2837,6 +3364,20 @@ export declare enum GroupType {
2837
3364
  Dynamic = "dynamic",
2838
3365
  Static = "static"
2839
3366
  }
3367
+ /** Denotes the use case of the grouped vista. */
3368
+ export declare enum GroupedVistaFlavor {
3369
+ Nnl = "nnl",
3370
+ SprintBoard = "sprint_board",
3371
+ SupportInbox = "support_inbox"
3372
+ }
3373
+ /**
3374
+ * grouped-vista-summary
3375
+ * Represents a group of multiple vistas as a single unit.
3376
+ */
3377
+ export type GroupedVistaSummary = VistaBaseSummary & {
3378
+ /** Denotes the use case of the grouped vista. */
3379
+ flavor?: GroupedVistaFlavor;
3380
+ };
2840
3381
  /**
2841
3382
  * groups-create-request
2842
3383
  * A request to create a new group.
@@ -2887,6 +3428,8 @@ export interface GroupsListRequest {
2887
3428
  * iteration starts from the beginning.
2888
3429
  */
2889
3430
  cursor?: string;
3431
+ /** Filters the groups based on the group type. */
3432
+ group_type?: GroupType[];
2890
3433
  /**
2891
3434
  * The maximum number of groups to return. The default is '50'.
2892
3435
  * @format int32
@@ -2950,6 +3493,12 @@ export type Issue = WorkBase & {
2950
3493
  developed_with?: PartSummary[];
2951
3494
  /** Priority of the work based upon impact and criticality. */
2952
3495
  priority?: IssuePriority;
3496
+ /**
3497
+ * Target start date for the object.
3498
+ * @format date-time
3499
+ * @example "2023-01-01T12:00:00.000Z"
3500
+ */
3501
+ target_start_date?: string;
2953
3502
  };
2954
3503
  /** Priority of the work based upon impact and criticality. */
2955
3504
  export declare enum IssuePriority {
@@ -2971,6 +3520,14 @@ export interface LegacyStage {
2971
3520
  /** Current stage name of the work item. */
2972
3521
  name: string;
2973
3522
  }
3523
+ /**
3524
+ * legacy-stage-summary
3525
+ * Describes the current stage of a work item.
3526
+ */
3527
+ export interface LegacyStageSummary {
3528
+ /** Current stage name of the work item. */
3529
+ name: string;
3530
+ }
2974
3531
  /**
2975
3532
  * lines-of-code
2976
3533
  * Details of lines of code in this code change.
@@ -3039,6 +3596,17 @@ export interface LinkRevUserToRevOrgRequest {
3039
3596
  export interface LinkRevUserToRevOrgResponse {
3040
3597
  rev_user: RevUser;
3041
3598
  }
3599
+ /** link-search-summary */
3600
+ export type LinkSearchSummary = SearchSummaryBase & {
3601
+ link: LinkSummary;
3602
+ };
3603
+ /** link-summary */
3604
+ export type LinkSummary = AtomBaseSummary & {
3605
+ /** Type of link used to define the relationship. */
3606
+ link_type: LinkType;
3607
+ source: LinkEndpointSummary;
3608
+ target: LinkEndpointSummary;
3609
+ };
3042
3610
  /** Type of link used to define the relationship. */
3043
3611
  export declare enum LinkType {
3044
3612
  DevelopedWith = "developed_with",
@@ -3179,6 +3747,8 @@ export declare enum ListMode {
3179
3747
  After = "after",
3180
3748
  Before = "before"
3181
3749
  }
3750
+ /** meeting-summary */
3751
+ export type MeetingSummary = AtomBaseSummary;
3182
3752
  /** member-summary */
3183
3753
  export type MemberSummary = (DevUserSummary | RevUserSummary | SysUserSummary) & {
3184
3754
  type: MemberType;
@@ -3233,12 +3803,13 @@ export interface MetricDataPointDimension {
3233
3803
  value: string;
3234
3804
  }
3235
3805
  /** metric-definition */
3236
- export type MetricDefinition = AtomBase;
3806
+ export type MetricDefinition = AtomBase & {
3807
+ /** Human readable name of the metric. */
3808
+ name?: string;
3809
+ };
3237
3810
  /** The list of item types on which the metric might be applied. */
3238
3811
  export declare enum MetricDefinitionAppliesTo {
3239
3812
  Conversation = "conversation",
3240
- Issue = "issue",
3241
- Task = "task",
3242
3813
  Ticket = "ticket"
3243
3814
  }
3244
3815
  /**
@@ -3251,6 +3822,11 @@ export declare enum MetricDefinitionMetricType {
3251
3822
  Time = "time",
3252
3823
  Value = "value"
3253
3824
  }
3825
+ /** metric-definition-summary */
3826
+ export type MetricDefinitionSummary = AtomBaseSummary & {
3827
+ /** Human readable name of the metric. */
3828
+ name?: string;
3829
+ };
3254
3830
  /** metric-definitions-list-request */
3255
3831
  export interface MetricDefinitionsListRequest {
3256
3832
  /** The type of objects the metric definition applies to. */
@@ -3260,6 +3836,11 @@ export interface MetricDefinitionsListRequest {
3260
3836
  * iteration starts from the beginning.
3261
3837
  */
3262
3838
  cursor?: string;
3839
+ /**
3840
+ * Whether to include custom metrics in the response. If not set, then
3841
+ * custom metrics are excluded.
3842
+ */
3843
+ include_custom_metrics?: boolean;
3263
3844
  /**
3264
3845
  * The maximum number of records to return. The default is '50'.
3265
3846
  * @format int32
@@ -3326,6 +3907,12 @@ export interface MetricsDataIngestRequest {
3326
3907
  */
3327
3908
  metrics: MetricsData[];
3328
3909
  }
3910
+ /** object-member-search-summary */
3911
+ export type ObjectMemberSearchSummary = SearchSummaryBase & {
3912
+ object_member: ObjectMemberSummary;
3913
+ };
3914
+ /** object-member-summary */
3915
+ export type ObjectMemberSummary = AtomBaseSummary;
3329
3916
  /** opportunity */
3330
3917
  export type Opportunity = WorkBase;
3331
3918
  /** Forecast category of the opportunity. */
@@ -3533,28 +4120,54 @@ export declare enum OrgScheduleStatus {
3533
4120
  Draft = "draft",
3534
4121
  Published = "published"
3535
4122
  }
3536
- /** org-schedules-create-request */
3537
- export interface OrgSchedulesCreateRequest {
3538
- default_weekly_org_schedule?: SetWeeklyOrgSchedule;
3539
- /**
3540
- * Organization schedule must be valid for at least this many days in
3541
- * the future. Meaning organization schedule fragments must cover this
3542
- * period. 0 if omitted.
3543
- * @format int64
3544
- */
3545
- min_valid_days?: number;
4123
+ /** org-schedule-summary */
4124
+ export type OrgScheduleSummary = AtomBaseSummary & {
3546
4125
  /** Human-readable name. */
3547
- name: string;
3548
- /** List of organization schedule fragments with no overlaps or gaps. */
3549
- org_schedule_fragments?: SetOrgScheduleFragmentSummary[];
4126
+ name?: string;
3550
4127
  /**
3551
- * Timezone in which the organization schedule applies. Expected to be
3552
- * a valid IANA time zone name such as America/New_York.
4128
+ * Status determines how an item can be used. In 'draft' status an item
4129
+ * can be edited but can't be used. When 'published' the item can longer
4130
+ * be edited but can be used. 'Archived' is read-only.
3553
4131
  */
3554
- timezone: string;
4132
+ status: OrgScheduleStatus;
3555
4133
  /**
3556
- * If this day belongs to a named period according to the currently
3557
- * active organization schedule fragment, a weekly organization
4134
+ * Timezone in which this is defined. Only organization schedules in
4135
+ * the same timezone can be directly combined.
4136
+ */
4137
+ timezone?: string;
4138
+ /**
4139
+ * Derived field indicating when a valid organization schedule will
4140
+ * become invalid. If omitted, the schedule is already invalid. A
4141
+ * schedule is valid if it has a weekly schedule for all named periods
4142
+ * for all its schedule fragments, and if it has a schedule fragment
4143
+ * for the time period in question.
4144
+ * @format date-time
4145
+ * @example "2023-01-01T12:00:00.000Z"
4146
+ */
4147
+ valid_until?: string;
4148
+ };
4149
+ /** org-schedules-create-request */
4150
+ export interface OrgSchedulesCreateRequest {
4151
+ default_weekly_org_schedule?: SetWeeklyOrgSchedule;
4152
+ /**
4153
+ * Organization schedule must be valid for at least this many days in
4154
+ * the future. Meaning organization schedule fragments must cover this
4155
+ * period. 0 if omitted.
4156
+ * @format int64
4157
+ */
4158
+ min_valid_days?: number;
4159
+ /** Human-readable name. */
4160
+ name: string;
4161
+ /** List of organization schedule fragments with no overlaps or gaps. */
4162
+ org_schedule_fragments?: SetOrgScheduleFragmentSummary[];
4163
+ /**
4164
+ * Timezone in which the organization schedule applies. Expected to be
4165
+ * a valid IANA time zone name such as America/New_York.
4166
+ */
4167
+ timezone: string;
4168
+ /**
4169
+ * If this day belongs to a named period according to the currently
4170
+ * active organization schedule fragment, a weekly organization
3558
4171
  * schedule from this list with the corresponding name will apply.
3559
4172
  */
3560
4173
  weekly_org_schedules?: SetWeeklyOrgSchedule[];
@@ -3673,6 +4286,10 @@ export interface OrgSchedulesUpdateRequest {
3673
4286
  export interface OrgSchedulesUpdateResponse {
3674
4287
  org_schedule: OrgSchedule;
3675
4288
  }
4289
+ /** org-search-summary */
4290
+ export type OrgSearchSummary = SearchSummaryBase & {
4291
+ org: OrgSummary;
4292
+ };
3676
4293
  /** org-summary */
3677
4294
  export type OrgSummary = (AccountSummary | RevOrgSummary) & {
3678
4295
  type: OrgType;
@@ -3725,6 +4342,8 @@ export type PartBase = AtomBase & {
3725
4342
  * @example "don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"
3726
4343
  */
3727
4344
  stock_schema_fragment?: string;
4345
+ /** Subtype corresponding to the custom type fragment. */
4346
+ subtype?: string;
3728
4347
  /** Tags associated with the object. */
3729
4348
  tags?: TagWithValue[];
3730
4349
  };
@@ -3733,6 +4352,10 @@ export type PartBaseSummary = AtomBaseSummary & {
3733
4352
  /** Name of the part. */
3734
4353
  name: string;
3735
4354
  };
4355
+ /** part-search-summary */
4356
+ export type PartSearchSummary = SearchSummaryBase & {
4357
+ part: PartSummary;
4358
+ };
3736
4359
  /** part-summary */
3737
4360
  export type PartSummary = (CapabilitySummary | EnhancementSummary | FeatureSummary | ProductSummary) & {
3738
4361
  type: PartType;
@@ -3957,6 +4580,287 @@ export interface PartsUpdateResponse {
3957
4580
  export type Product = PartBase;
3958
4581
  /** product-summary */
3959
4582
  export type ProductSummary = PartBaseSummary;
4583
+ /** question-answer */
4584
+ export type QuestionAnswer = AtomBase & {
4585
+ /** The Answer. */
4586
+ answer?: string;
4587
+ /** The Question. */
4588
+ question?: string;
4589
+ /** An alternative answer suggested by the Q/A generation algorithm. */
4590
+ suggested_answer?: string;
4591
+ /**
4592
+ * Whether the Q/A was marked for deletion by the Q/A generation
4593
+ * algorithm.
4594
+ */
4595
+ suggested_for_deletion?: boolean;
4596
+ /** The topic to which the QA belongs. */
4597
+ topic?: string;
4598
+ /** Whether the Q/A was verified. */
4599
+ verified?: boolean;
4600
+ };
4601
+ /** question-answer-search-summary */
4602
+ export type QuestionAnswerSearchSummary = SearchSummaryBase & {
4603
+ question_answer: QuestionAnswerSummary;
4604
+ };
4605
+ /** Status of the question answer. */
4606
+ export declare enum QuestionAnswerStatus {
4607
+ Archived = "archived",
4608
+ Draft = "draft",
4609
+ Published = "published",
4610
+ ReviewNeeded = "review_needed"
4611
+ }
4612
+ /** question-answer-summary */
4613
+ export type QuestionAnswerSummary = AtomBaseSummary & {
4614
+ /** The Question. */
4615
+ question?: string;
4616
+ };
4617
+ /**
4618
+ * question-answers-create-request
4619
+ * The request to create a question-answer.
4620
+ */
4621
+ export interface QuestionAnswersCreateRequest {
4622
+ access_level?: AccessLevel;
4623
+ /** Answer of the question-answer. */
4624
+ answer: string;
4625
+ /**
4626
+ * The articles that the question-answer applies to.
4627
+ * @example ["ARTICLE-12345"]
4628
+ */
4629
+ applies_to_articles?: string[];
4630
+ /**
4631
+ * The parts that the question-answer applies to.
4632
+ * @minItems 1
4633
+ * @example ["PROD-12345"]
4634
+ */
4635
+ applies_to_parts: string[];
4636
+ /**
4637
+ * The users that own the question-answer.
4638
+ * @example ["DEVU-12345"]
4639
+ */
4640
+ owned_by: string[];
4641
+ /** Question of the question-answer. */
4642
+ question: string;
4643
+ /** Information about the role the member receives due to the share. */
4644
+ shared_with?: SetSharedWithMembership[];
4645
+ /**
4646
+ * The source of the question-answer.
4647
+ * @example ["ARTICLE-12345"]
4648
+ */
4649
+ sources?: string[];
4650
+ /** Status of the question answer. */
4651
+ status: QuestionAnswerStatus;
4652
+ /**
4653
+ * Alternative answer for the question-answer sugested by Q/A
4654
+ * Discovery.
4655
+ */
4656
+ suggested_answer?: string;
4657
+ /**
4658
+ * Whether the question-answer was suggeste to be deleted by Q/A
4659
+ * Discovery.
4660
+ */
4661
+ suggested_for_deletion?: boolean;
4662
+ /** Tags associated with the question-answer. */
4663
+ tags?: SetTagWithValue[];
4664
+ /** Topic of the question-answer. */
4665
+ topic?: string;
4666
+ /** Whether the question-answer was verified by a user or not. */
4667
+ verified?: boolean;
4668
+ }
4669
+ /**
4670
+ * question-answers-create-response
4671
+ * Create question-answer response.
4672
+ */
4673
+ export interface QuestionAnswersCreateResponse {
4674
+ question_answer: QuestionAnswer;
4675
+ }
4676
+ /**
4677
+ * question-answers-delete-request
4678
+ * The request to delete a question-answer.
4679
+ */
4680
+ export interface QuestionAnswersDeleteRequest {
4681
+ /** The ID of the question-answer. */
4682
+ id: string;
4683
+ /**
4684
+ * The ID of the question-answer.
4685
+ * @deprecated
4686
+ */
4687
+ question_answer_id?: string;
4688
+ }
4689
+ /**
4690
+ * question-answers-get-request
4691
+ * The request to get a question-answer.
4692
+ */
4693
+ export interface QuestionAnswersGetRequest {
4694
+ /** The ID of the required question-answer. */
4695
+ id: string;
4696
+ }
4697
+ /**
4698
+ * question-answers-get-response
4699
+ * Get question-answer response.
4700
+ */
4701
+ export interface QuestionAnswersGetResponse {
4702
+ question_answer: QuestionAnswer;
4703
+ }
4704
+ /**
4705
+ * question-answers-list-request
4706
+ * The request to list question-answers.
4707
+ */
4708
+ export interface QuestionAnswersListRequest {
4709
+ /**
4710
+ * Filters for question-answer belonging to any of the provided
4711
+ * articles.
4712
+ * @example ["ARTICLE-12345"]
4713
+ */
4714
+ applies_to_articles?: string[];
4715
+ /**
4716
+ * Filters for question-answer belonging to any of the provided parts.
4717
+ * @example ["PROD-12345"]
4718
+ */
4719
+ applies_to_parts?: string[];
4720
+ /**
4721
+ * Filters for question-answers created by any of the provided users.
4722
+ * @example ["DEVU-12345"]
4723
+ */
4724
+ created_by?: string[];
4725
+ /**
4726
+ * The cursor to resume iteration from. If not provided, then
4727
+ * iteration starts from the beginning.
4728
+ */
4729
+ cursor?: string;
4730
+ /**
4731
+ * The maximum number of question-answers to return. The default is
4732
+ * '50'.
4733
+ * @format int32
4734
+ */
4735
+ limit?: number;
4736
+ /**
4737
+ * The iteration mode to use. If "after", then entries after the provided
4738
+ * cursor will be returned, or if no cursor is provided, then from the
4739
+ * beginning. If "before", then entries before the provided cursor will be
4740
+ * returned, or if no cursor is provided, then from the end. Entries will
4741
+ * always be returned in the specified sort-by order.
4742
+ */
4743
+ mode?: ListMode;
4744
+ /**
4745
+ * Filters for question-answers owned by any of the provided users.
4746
+ * @example ["DEVU-12345"]
4747
+ */
4748
+ owned_by?: string[];
4749
+ }
4750
+ /**
4751
+ * question-answers-list-response
4752
+ * List question-answers response.
4753
+ */
4754
+ export interface QuestionAnswersListResponse {
4755
+ /**
4756
+ * The cursor used to iterate subsequent results in accordance to the
4757
+ * sort order. If not set, then no later elements exist.
4758
+ */
4759
+ next_cursor?: string;
4760
+ /**
4761
+ * The cursor used to iterate preceding results in accordance to the
4762
+ * sort order. If not set, then no prior elements exist.
4763
+ */
4764
+ prev_cursor?: string;
4765
+ /** The question-answers entries matching the request. */
4766
+ question_answers: QuestionAnswer[];
4767
+ /**
4768
+ * Total number of question-answer items for the request.
4769
+ * @format int32
4770
+ */
4771
+ total: number;
4772
+ }
4773
+ /**
4774
+ * question-answers-update-request
4775
+ * The request to update a question-answer.
4776
+ */
4777
+ export interface QuestionAnswersUpdateRequest {
4778
+ access_level?: AccessLevel;
4779
+ /**
4780
+ * Updated answer of the question-answer object, or unchanged if not
4781
+ * provided.
4782
+ */
4783
+ answer?: string;
4784
+ applies_to_articles?: QuestionAnswersUpdateRequestAppliesToArticles;
4785
+ applies_to_parts?: QuestionAnswersUpdateRequestAppliesToParts;
4786
+ /** The question-answer's ID. */
4787
+ id: string;
4788
+ owned_by?: QuestionAnswersUpdateRequestOwnedBy;
4789
+ /**
4790
+ * Updated question of the question-answer object, or unchanged if not
4791
+ * provided.
4792
+ */
4793
+ question?: string;
4794
+ shared_with?: QuestionAnswersUpdateRequestSharedWith;
4795
+ sources?: QuestionAnswersUpdateRequestSources;
4796
+ /** Status of the question answer. */
4797
+ status?: QuestionAnswerStatus;
4798
+ /**
4799
+ * Updated suggested_answer of the question-answer object, or
4800
+ * unchanged if not provided.
4801
+ */
4802
+ suggested_answer?: string;
4803
+ /**
4804
+ * Updated suggested_for_deletion of the question-answer object, or
4805
+ * unchanged if not provided.
4806
+ */
4807
+ suggested_for_deletion?: boolean;
4808
+ tags?: QuestionAnswersUpdateRequestTags;
4809
+ /**
4810
+ * Updated topic of the question-answer object, or unchanged if not
4811
+ * provided.
4812
+ */
4813
+ topic?: string;
4814
+ /** Updates whether the question-answer was verified by a user or not. */
4815
+ verified?: boolean;
4816
+ }
4817
+ /** question-answers-update-request-applies-to-articles */
4818
+ export interface QuestionAnswersUpdateRequestAppliesToArticles {
4819
+ /**
4820
+ * Updates the article that the question-answer applies to.
4821
+ * @example ["ARTICLE-12345"]
4822
+ */
4823
+ set?: string[];
4824
+ }
4825
+ /** question-answers-update-request-applies-to-parts */
4826
+ export interface QuestionAnswersUpdateRequestAppliesToParts {
4827
+ /**
4828
+ * Updates the parts that the question-answer applies to.
4829
+ * @example ["PROD-12345"]
4830
+ */
4831
+ set?: string[];
4832
+ }
4833
+ /** question-answers-update-request-owned-by */
4834
+ export interface QuestionAnswersUpdateRequestOwnedBy {
4835
+ /**
4836
+ * Sets the owner IDs to the provided user IDs. This must not be
4837
+ * empty.
4838
+ * @example ["DEVU-12345"]
4839
+ */
4840
+ set?: string[];
4841
+ }
4842
+ /** question-answers-update-request-shared-with */
4843
+ export interface QuestionAnswersUpdateRequestSharedWith {
4844
+ /** Sets the field to the provided membership list. */
4845
+ set?: SetSharedWithMembership[];
4846
+ }
4847
+ /** question-answers-update-request-sources */
4848
+ export interface QuestionAnswersUpdateRequestSources {
4849
+ /**
4850
+ * Sets the sources that generated the question-answer.
4851
+ * @example ["ARTICLE-12345"]
4852
+ */
4853
+ set?: string[];
4854
+ }
4855
+ /** question-answers-update-request-tags */
4856
+ export interface QuestionAnswersUpdateRequestTags {
4857
+ /** Sets the provided tags on the question-answer. */
4858
+ set?: SetTagWithValue[];
4859
+ }
4860
+ /** question-answers-update-response */
4861
+ export interface QuestionAnswersUpdateResponse {
4862
+ question_answer: QuestionAnswer;
4863
+ }
3960
4864
  /**
3961
4865
  * resource
3962
4866
  * Resource details.
@@ -3967,6 +4871,16 @@ export interface Resource {
3967
4871
  /** URL of the external article. */
3968
4872
  url?: string;
3969
4873
  }
4874
+ /**
4875
+ * resource-summary
4876
+ * Resource details.
4877
+ */
4878
+ export interface ResourceSummary {
4879
+ /** Ids of the artifacts. */
4880
+ artifacts?: ArtifactSummary[];
4881
+ /** URL of the external article. */
4882
+ url?: string;
4883
+ }
3970
4884
  /** rev-org */
3971
4885
  export type RevOrg = OrgBase & {
3972
4886
  account?: AccountSummary;
@@ -3995,6 +4909,8 @@ export type RevOrg = OrgBase & {
3995
4909
  * @example "don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"
3996
4910
  */
3997
4911
  stock_schema_fragment?: string;
4912
+ /** Subtype corresponding to the custom type fragment. */
4913
+ subtype?: string;
3998
4914
  /** Tags associated with an object. */
3999
4915
  tags?: TagWithValue[];
4000
4916
  };
@@ -4115,6 +5031,8 @@ export interface RevOrgsListRequest {
4115
5031
  custom_field_filter?: string[];
4116
5032
  /** Filters for custom fields. */
4117
5033
  custom_fields?: object;
5034
+ /** Array of display names of Rev orgs to be filtered. */
5035
+ display_name?: string[];
4118
5036
  /** List of external refs to filter Rev organizations for. */
4119
5037
  external_ref?: string[];
4120
5038
  /**
@@ -4241,6 +5159,8 @@ export type RevUser = UserBase & {
4241
5159
  * @example "don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"
4242
5160
  */
4243
5161
  stock_schema_fragment?: string;
5162
+ /** Subtype corresponding to the custom type fragment. */
5163
+ subtype?: string;
4244
5164
  /** Tags associated with the object. */
4245
5165
  tags?: TagWithValue[];
4246
5166
  };
@@ -4290,7 +5210,8 @@ export interface RevUsersCreateRequest {
4290
5210
  /** Phone numbers, in E.164 format, of the Rev user. */
4291
5211
  phone_numbers?: string[];
4292
5212
  /**
4293
- * The ID of Rev organization for which a Rev user is to be created.
5213
+ * The ID of the Rev organization to which the created Rev user is
5214
+ * associated.
4294
5215
  * @example "REV-AbCdEfGh"
4295
5216
  */
4296
5217
  rev_org?: string;
@@ -4502,6 +5423,14 @@ export type SchemaEnumListFieldDescriptor = SchemaFieldDescriptorBase & {
4502
5423
  /** Default value. */
4503
5424
  default_value?: string[];
4504
5425
  };
5426
+ /**
5427
+ * schema-field-create-view-ui-metadata
5428
+ * Create view UI hint overrides.
5429
+ */
5430
+ export interface SchemaFieldCreateViewUiMetadata {
5431
+ /** Whether field is hidden in the UI create view. */
5432
+ is_hidden?: boolean;
5433
+ }
4505
5434
  /**
4506
5435
  * schema-field-descriptor
4507
5436
  * Set of field attributes.
@@ -4512,6 +5441,11 @@ export type SchemaFieldDescriptor = (SchemaBoolFieldDescriptor | SchemaComposite
4512
5441
  /** schema-field-descriptor-array-type */
4513
5442
  export type SchemaFieldDescriptorArrayType = (SchemaBoolListFieldDescriptor | SchemaCompositeListFieldDescriptor | SchemaDateListFieldDescriptor | SchemaDoubleListFieldDescriptor | SchemaEnumListFieldDescriptor | SchemaIdListFieldDescriptor | SchemaIntListFieldDescriptor | SchemaRichTextListFieldDescriptor | SchemaTextListFieldDescriptor | SchemaTimestampListFieldDescriptor | SchemaTokensListFieldDescriptor | SchemaUenumListFieldDescriptor) & {
4514
5443
  base_type: SchemaFieldDescriptorArrayTypeBaseType;
5444
+ /**
5445
+ * The exact array length.
5446
+ * @format int64
5447
+ */
5448
+ eq_items?: number;
4515
5449
  /**
4516
5450
  * The maximum array length.
4517
5451
  * @format int64
@@ -4543,6 +5477,8 @@ export interface SchemaFieldDescriptorBase {
4543
5477
  description?: string;
4544
5478
  /** Whether this field is filterable, groupable and sortable. */
4545
5479
  is_filterable?: boolean;
5480
+ /** Whether this field is immutable or not. */
5481
+ is_immutable?: boolean;
4546
5482
  /**
4547
5483
  * Whether this field can hold Personally Identifiable Information
4548
5484
  * (PII).
@@ -4575,11 +5511,43 @@ export declare enum SchemaFieldDescriptorFieldType {
4575
5511
  Uenum = "uenum",
4576
5512
  Unknown = "unknown"
4577
5513
  }
5514
+ /**
5515
+ * schema-field-detail-view-ui-metadata
5516
+ * Detail view UI hint overrides.
5517
+ */
5518
+ export interface SchemaFieldDetailViewUiMetadata {
5519
+ /** Whether the field is hidden in the UI detail view. */
5520
+ is_hidden?: boolean;
5521
+ }
5522
+ /**
5523
+ * schema-field-filter-view-ui-metadata
5524
+ * Filter view UI hint overrides.
5525
+ */
5526
+ export interface SchemaFieldFilterViewUiMetadata {
5527
+ /** Whether field is hidden in the UI filter view. */
5528
+ is_hidden?: boolean;
5529
+ }
5530
+ /**
5531
+ * schema-field-list-view-ui-metadata
5532
+ * List view UI hint overrides.
5533
+ */
5534
+ export interface SchemaFieldListViewUiMetadata {
5535
+ /** Whether the field is hidden in the UI list view. */
5536
+ is_hidden?: boolean;
5537
+ }
4578
5538
  /**
4579
5539
  * schema-field-mfz-metadata
4580
5540
  * The schema of MFZ specific fields.
4581
5541
  */
4582
5542
  export type SchemaFieldMfzMetadata = object;
5543
+ /**
5544
+ * schema-field-summary-view-ui-metadata
5545
+ * Summary view UI hint overrides.
5546
+ */
5547
+ export interface SchemaFieldSummaryViewUiMetadata {
5548
+ /** Whether field is hidden in the UI summary view. */
5549
+ is_hidden?: boolean;
5550
+ }
4583
5551
  /**
4584
5552
  * schema-field-uenum-value
4585
5553
  * A unified enum value.
@@ -4589,7 +5557,42 @@ export type SchemaFieldUenumValue = object;
4589
5557
  * schema-field-ui-metadata
4590
5558
  * The schema of ui specific fields.
4591
5559
  */
4592
- export type SchemaFieldUiMetadata = object;
5560
+ export interface SchemaFieldUiMetadata {
5561
+ /** Create view UI hint overrides. */
5562
+ create_view?: SchemaFieldCreateViewUiMetadata;
5563
+ /** Detail view UI hint overrides. */
5564
+ detail_view?: SchemaFieldDetailViewUiMetadata;
5565
+ /** The display name of the field. */
5566
+ display_name?: string;
5567
+ /** Filter view UI hint overrides. */
5568
+ filter_view?: SchemaFieldFilterViewUiMetadata;
5569
+ /** An optional group name for the field. */
5570
+ group_name?: string;
5571
+ /** Whether the field is active in the UI detail view. */
5572
+ is_active_in_detail_view?: boolean;
5573
+ /** Whether the field supports bulk action. */
5574
+ is_bulk_action_enabled?: boolean;
5575
+ /** Whether the field is groupable in the UI. */
5576
+ is_groupable?: boolean;
5577
+ /** Whether the field is hidden in the UI. */
5578
+ is_hidden?: boolean;
5579
+ /** Whether the field is hidden in the UI during creation. */
5580
+ is_hidden_during_create?: boolean;
5581
+ /** Whether the field is read-only in the UI. */
5582
+ is_read_only?: boolean;
5583
+ /** Whether the field is shown in the UI summary view. */
5584
+ is_shown_in_summary?: boolean;
5585
+ /** Whether the field is sortable in the UI. */
5586
+ is_sortable?: boolean;
5587
+ /** List view UI hint overrides. */
5588
+ list_view?: SchemaFieldListViewUiMetadata;
5589
+ /** A placeholder for the field. */
5590
+ placeholder?: string;
5591
+ /** Summary view UI hint overrides. */
5592
+ summary_view?: SchemaFieldSummaryViewUiMetadata;
5593
+ /** Tooltip for the field. */
5594
+ tooltip?: string;
5595
+ }
4593
5596
  /** schema-id-field-descriptor */
4594
5597
  export type SchemaIdFieldDescriptor = SchemaFieldDescriptorBase & {
4595
5598
  /** Default value. */
@@ -4854,46 +5857,167 @@ export type SchemaUenumListFieldDescriptor = SchemaFieldDescriptorBase & {
4854
5857
  };
4855
5858
  /** schema-unknown-field-descriptor */
4856
5859
  export type SchemaUnknownFieldDescriptor = SchemaFieldDescriptorBase;
4857
- /** service-account */
4858
- export type ServiceAccount = UserBase;
4859
- /** service-account-summary */
4860
- export type ServiceAccountSummary = UserBaseSummary;
4861
5860
  /**
4862
- * service-accounts-get-request
4863
- * The request object to get a service account's information.
5861
+ * search-core-request
5862
+ * Search request.
4864
5863
  */
4865
- export interface ServiceAccountsGetRequest {
4866
- /** The ID of the requested service account. */
4867
- id: string;
5864
+ export interface SearchCoreRequest {
5865
+ /**
5866
+ * The cursor from where to begin iteration. Start from beginning if
5867
+ * not provided.
5868
+ */
5869
+ cursor?: string;
5870
+ /**
5871
+ * The maximum number of items to return in a page. The default is
5872
+ * '10'.
5873
+ * @format int32
5874
+ */
5875
+ limit?: number;
5876
+ /** The namespaces to search in. */
5877
+ namespaces?: SearchNamespace[];
5878
+ /**
5879
+ * The query string. Search query language:
5880
+ * https://docs.devrev.ai/product/search#fields
5881
+ */
5882
+ query: string;
5883
+ /** Search sort by parameters. */
5884
+ sort_by?: SearchSortByParam;
5885
+ /** Search sort order parameters. */
5886
+ sort_order?: SearchSortOrderParam;
4868
5887
  }
4869
5888
  /**
4870
- * service-accounts-get-response
4871
- * The response object that carries the service account's information
4872
- * corresponding to the request.
5889
+ * search-core-response
5890
+ * Search response.
4873
5891
  */
4874
- export interface ServiceAccountsGetResponse {
4875
- service_account: ServiceAccount;
4876
- }
4877
- /** set-org-schedule-fragment-summary */
4878
- export interface SetOrgScheduleFragmentSummary {
4879
- /** Organization schedule fragment ID. */
4880
- id: string;
4881
- }
4882
- /** set-sla-policy */
4883
- export interface SetSlaPolicy {
4884
- /** Metrics to apply to the selected items. */
4885
- metrics?: SetSupportMetricTarget[];
4886
- /** Human-readable name. */
4887
- name: string;
4888
- selector: SetSlaSelector;
4889
- }
4890
- /** set-sla-selector */
4891
- export interface SetSlaSelector {
4892
- /** The item type for which the SLA policy applies. */
4893
- applies_to: SlaSelectorAppliesTo;
5892
+ export interface SearchCoreResponse {
4894
5893
  /**
4895
- * Custom fields with their fully qualified names and associated with
4896
- * their exact allowed values. The SLA policy applies to records where
5894
+ * The cursor from where to begin iteration. Start from beginning if
5895
+ * not provided.
5896
+ */
5897
+ cursor?: string;
5898
+ /** The search results. */
5899
+ results: SearchResult[];
5900
+ }
5901
+ /** The namespaces to search in. */
5902
+ export declare enum SearchNamespace {
5903
+ Account = "account",
5904
+ Article = "article",
5905
+ Capability = "capability",
5906
+ Component = "component",
5907
+ Conversation = "conversation",
5908
+ CustomPart = "custom_part",
5909
+ CustomWork = "custom_work",
5910
+ Dashboard = "dashboard",
5911
+ DevUser = "dev_user",
5912
+ Enhancement = "enhancement",
5913
+ Feature = "feature",
5914
+ Group = "group",
5915
+ Issue = "issue",
5916
+ Linkable = "linkable",
5917
+ Microservice = "microservice",
5918
+ ObjectMember = "object_member",
5919
+ Opportunity = "opportunity",
5920
+ Product = "product",
5921
+ Project = "project",
5922
+ QuestionAnswer = "question_answer",
5923
+ RevOrg = "rev_org",
5924
+ RevUser = "rev_user",
5925
+ Runnable = "runnable",
5926
+ ServiceAccount = "service_account",
5927
+ SysUser = "sys_user",
5928
+ Tag = "tag",
5929
+ Task = "task",
5930
+ Ticket = "ticket",
5931
+ Vista = "vista"
5932
+ }
5933
+ /** search-result */
5934
+ export type SearchResult = (AccountSearchSummary | ArticleSearchSummary | ArtifactSearchSummary | ConversationSearchSummary | DashboardSearchSummary | GroupSearchSummary | LinkSearchSummary | ObjectMemberSearchSummary | OrgSearchSummary | PartSearchSummary | QuestionAnswerSearchSummary | TagSearchSummary | UserSearchSummary | VistaSearchSummary | WorkSearchSummary) & {
5935
+ type: SearchResultType;
5936
+ };
5937
+ export declare enum SearchResultType {
5938
+ Account = "account",
5939
+ Article = "article",
5940
+ Artifact = "artifact",
5941
+ Conversation = "conversation",
5942
+ Dashboard = "dashboard",
5943
+ Group = "group",
5944
+ Link = "link",
5945
+ ObjectMember = "object_member",
5946
+ Org = "org",
5947
+ Part = "part",
5948
+ QuestionAnswer = "question_answer",
5949
+ Tag = "tag",
5950
+ User = "user",
5951
+ Vista = "vista",
5952
+ Work = "work"
5953
+ }
5954
+ /** Search sort by parameters. */
5955
+ export declare enum SearchSortByParam {
5956
+ CreatedDate = "created_date",
5957
+ ModifiedDate = "modified_date",
5958
+ Relevance = "relevance"
5959
+ }
5960
+ /** Search sort order parameters. */
5961
+ export declare enum SearchSortOrderParam {
5962
+ Asc = "asc",
5963
+ Desc = "desc"
5964
+ }
5965
+ /** search-summary-base */
5966
+ export interface SearchSummaryBase {
5967
+ /**
5968
+ * Timestamp when the object was last modified.
5969
+ * @format date-time
5970
+ * @example "2023-01-01T12:00:00.000Z"
5971
+ */
5972
+ modified_date?: string;
5973
+ /** Text snippet where the search hit occurred. */
5974
+ snippet?: string;
5975
+ }
5976
+ /** service-account */
5977
+ export type ServiceAccount = UserBase;
5978
+ /** service-account-summary */
5979
+ export type ServiceAccountSummary = UserBaseSummary;
5980
+ /**
5981
+ * service-accounts-get-request
5982
+ * The request object to get a service account's information.
5983
+ */
5984
+ export interface ServiceAccountsGetRequest {
5985
+ /** The ID of the requested service account. */
5986
+ id: string;
5987
+ }
5988
+ /**
5989
+ * service-accounts-get-response
5990
+ * The response object that carries the service account's information
5991
+ * corresponding to the request.
5992
+ */
5993
+ export interface ServiceAccountsGetResponse {
5994
+ service_account: ServiceAccount;
5995
+ }
5996
+ /** set-org-schedule-fragment-summary */
5997
+ export interface SetOrgScheduleFragmentSummary {
5998
+ /** Organization schedule fragment ID. */
5999
+ id: string;
6000
+ }
6001
+ /**
6002
+ * set-shared-with-membership
6003
+ * Information about the role the member receives due to the share.
6004
+ */
6005
+ export type SetSharedWithMembership = object;
6006
+ /** set-sla-policy */
6007
+ export interface SetSlaPolicy {
6008
+ /** Metrics to apply to the selected items. */
6009
+ metrics?: SetSupportMetricTarget[];
6010
+ /** Human-readable name. */
6011
+ name: string;
6012
+ selector: SetSlaSelector;
6013
+ }
6014
+ /** set-sla-selector */
6015
+ export interface SetSlaSelector {
6016
+ /** The item type for which the SLA policy applies. */
6017
+ applies_to: SlaSelectorAppliesTo;
6018
+ /**
6019
+ * Custom fields with their fully qualified names and associated with
6020
+ * their exact allowed values. The SLA policy applies to records where
4897
6021
  * all named custom fields have exactly the specified values. If the
4898
6022
  * value is null, the field must have null value or not be present.
4899
6023
  */
@@ -4971,10 +6095,10 @@ export interface SetWeeklyOrgSchedule {
4971
6095
  period_name: string;
4972
6096
  }
4973
6097
  /**
4974
- * shared-with-membership
4975
- * Information about the role the member receives due to the share.
6098
+ * shared-with-membership-filter
6099
+ * Filter on target item based on intended audience.
4976
6100
  */
4977
- export type SharedWithMembership = object;
6101
+ export type SharedWithMembershipFilter = object;
4978
6102
  /** sla */
4979
6103
  export type Sla = AtomBase & {
4980
6104
  /**
@@ -5069,6 +6193,17 @@ export declare enum SlaStatus {
5069
6193
  Draft = "draft",
5070
6194
  Published = "published"
5071
6195
  }
6196
+ /** sla-summary */
6197
+ export type SlaSummary = AtomBaseSummary & {
6198
+ /** Human-readable name. */
6199
+ name: string;
6200
+ /**
6201
+ * Status determines how an item can be used. In 'draft' status an item
6202
+ * can be edited but can't be used. When 'published' the item can longer
6203
+ * be edited but can be used. 'Archived' is read-only.
6204
+ */
6205
+ status: SlaStatus;
6206
+ };
5072
6207
  /**
5073
6208
  * sla-summary-filter
5074
6209
  * The filter for SLA summary.
@@ -5076,6 +6211,8 @@ export declare enum SlaStatus {
5076
6211
  export interface SlaSummaryFilter {
5077
6212
  /** Filters for records with any of the provided SLA stages. */
5078
6213
  stage?: SlaSummaryStage[];
6214
+ /** Provides ways to specify date ranges on objects. */
6215
+ target_time?: DateFilter;
5079
6216
  }
5080
6217
  /**
5081
6218
  * The stage of the SLA. This is the metric stage which is closest to
@@ -5089,7 +6226,37 @@ export declare enum SlaSummaryStage {
5089
6226
  Warning = "warning"
5090
6227
  }
5091
6228
  /** sla-tracker */
5092
- export type SlaTracker = AtomBase;
6229
+ export type SlaTracker = AtomBase & {
6230
+ /** Details of the object on which the SLA is being tracked. */
6231
+ applies_to_id?: string;
6232
+ /** Summary of the metrics target being tracked in the SLA tracker. */
6233
+ metric_target_summaries: ArchetypeMetricTarget[];
6234
+ sla?: SlaSummary;
6235
+ /**
6236
+ * Details of the applicable SLA policy. Can be omitted if no sla
6237
+ * applies, or if no policy of the sla applies at the moment.
6238
+ */
6239
+ sla_policy_id?: string;
6240
+ /** SLA stage of the object being tracked. */
6241
+ stage?: string;
6242
+ /**
6243
+ * It is an indicator of whether the SLA has ever been breached
6244
+ * (missed). If not, it shows whether the SLA is completed, in
6245
+ * progress, or nil - if no policy is applied.
6246
+ */
6247
+ status?: string;
6248
+ };
6249
+ /** sla-tracker-summary */
6250
+ export type SlaTrackerSummary = AtomBaseSummary;
6251
+ /** sla-trackers-get-request */
6252
+ export interface SlaTrackersGetRequest {
6253
+ /** The ID of the SLA tracker to get. */
6254
+ id: string;
6255
+ }
6256
+ /** sla-trackers-get-response */
6257
+ export interface SlaTrackersGetResponse {
6258
+ sla_tracker: SlaTracker;
6259
+ }
5093
6260
  /** slas-assign-request */
5094
6261
  export interface SlasAssignRequest {
5095
6262
  /**
@@ -5261,10 +6428,49 @@ export interface SnapInsResourcesResponseKeyringsEntry {
5261
6428
  value: SnapInsResourcesResponseKeyringData;
5262
6429
  }
5263
6430
  /** snap-widget */
5264
- export interface SnapWidget {
6431
+ export type SnapWidget = EmailPreviewWidget & {
5265
6432
  type: SnapWidgetType;
6433
+ };
6434
+ /** snap-widget-base */
6435
+ export type SnapWidgetBase = AtomBase & {
6436
+ /** A human readable name for the snap widget. */
6437
+ name: string;
6438
+ /** Logical grouping of snap widgets. Useful for filtering. */
6439
+ namespace?: SnapWidgetNamespace;
6440
+ /** The status of the snap widget. */
6441
+ status: SnapWidgetStatus;
6442
+ };
6443
+ /** Logical grouping of snap widgets. Useful for filtering. */
6444
+ export declare enum SnapWidgetNamespace {
6445
+ EmailPreview = "email_preview",
6446
+ LinkPreview = "link_preview",
6447
+ PlugNudge = "plug_nudge"
6448
+ }
6449
+ /** The status of the snap widget. */
6450
+ export declare enum SnapWidgetStatus {
6451
+ Draft = "draft",
6452
+ Published = "published"
6453
+ }
6454
+ export declare enum SnapWidgetType {
6455
+ EmailPreview = "email_preview"
6456
+ }
6457
+ /** snap-widgets-create-request */
6458
+ export type SnapWidgetsCreateRequest = CreateEmailPreviewWidget & {
6459
+ /** A human readable name for the snap widget. */
6460
+ name: string;
6461
+ /** Logical grouping of snap widgets. Useful for filtering. */
6462
+ namespace?: SnapWidgetNamespace;
6463
+ /** The status of the snap widget. */
6464
+ status?: SnapWidgetStatus;
6465
+ type: SnapWidgetsCreateRequestType;
6466
+ };
6467
+ export declare enum SnapWidgetsCreateRequestType {
6468
+ EmailPreview = "email_preview"
6469
+ }
6470
+ /** snap-widgets-create-response */
6471
+ export interface SnapWidgetsCreateResponse {
6472
+ snap_widget: SnapWidget;
5266
6473
  }
5267
- export type SnapWidgetType = string;
5268
6474
  /** stage-diagram-summary */
5269
6475
  export type StageDiagramSummary = AtomBaseSummary;
5270
6476
  /**
@@ -5291,11 +6497,94 @@ export interface StageUpdate {
5291
6497
  /** The updated name of the stage, otherwise unchanged if not set. */
5292
6498
  name?: string;
5293
6499
  }
6500
+ /** staged-info-filter */
6501
+ export interface StagedInfoFilter {
6502
+ /** Filters for issues that are staged. */
6503
+ is_staged?: boolean;
6504
+ }
5294
6505
  /**
5295
6506
  * stock-field-override
5296
6507
  * A stock field override.
5297
6508
  */
5298
6509
  export type StockFieldOverride = object;
6510
+ /** stock-schema-fragment */
6511
+ export type StockSchemaFragment = AtomBase & {
6512
+ /** Description of the schema. */
6513
+ description?: string;
6514
+ /** List of all fields in this schema. */
6515
+ fields: SchemaFieldDescriptor[];
6516
+ /** Leaf type this fragment applies to. */
6517
+ leaf_type?: string;
6518
+ new_fragment_ref?: AtomSummary;
6519
+ old_fragment_ref?: AtomSummary;
6520
+ /** Title of the schema. */
6521
+ title?: string;
6522
+ };
6523
+ /** stock-schema-fragments-get-request */
6524
+ export interface StockSchemaFragmentsGetRequest {
6525
+ /** The ID of the stock schema fragment. */
6526
+ id?: string;
6527
+ /** The leaf type this fragment applies to. */
6528
+ leaf_type?: string;
6529
+ }
6530
+ /** stock-schema-fragments-get-response */
6531
+ export interface StockSchemaFragmentsGetResponse {
6532
+ fragment: StockSchemaFragment;
6533
+ }
6534
+ /** stock-schema-fragments-list-request */
6535
+ export interface StockSchemaFragmentsListRequest {
6536
+ /**
6537
+ * The cursor to resume iteration from. If not provided, then
6538
+ * iteration starts from the beginning.
6539
+ */
6540
+ cursor?: string;
6541
+ filter_preset?: StockSchemaFragmentsListRequestFilterPreset;
6542
+ /** The list of leaf types. */
6543
+ leaf_type?: string[];
6544
+ /**
6545
+ * The maximum number of items.
6546
+ * @format int32
6547
+ */
6548
+ limit?: number;
6549
+ /**
6550
+ * The iteration mode to use. If "after", then entries after the provided
6551
+ * cursor will be returned, or if no cursor is provided, then from the
6552
+ * beginning. If "before", then entries before the provided cursor will be
6553
+ * returned, or if no cursor is provided, then from the end. Entries will
6554
+ * always be returned in the specified sort-by order.
6555
+ */
6556
+ mode?: ListMode;
6557
+ /**
6558
+ * List of fields which are not required in the payload and can be
6559
+ * pruned away.
6560
+ */
6561
+ prune?: StockSchemaFragmentsListRequestPrune[];
6562
+ /** The list of fields to sort the items by and how to sort them. */
6563
+ sort_by?: string[];
6564
+ }
6565
+ export declare enum StockSchemaFragmentsListRequestFilterPreset {
6566
+ CustomizableTypesPreset = "customizable_types_preset",
6567
+ NoPreset = "no_preset"
6568
+ }
6569
+ export declare enum StockSchemaFragmentsListRequestPrune {
6570
+ CompositeSchemas = "composite_schemas",
6571
+ Fields = "fields"
6572
+ }
6573
+ /** stock-schema-fragments-list-response */
6574
+ export interface StockSchemaFragmentsListResponse {
6575
+ /**
6576
+ * The cursor used to iterate subsequent results in accordance to the
6577
+ * sort order. If not set, then no later elements exist.
6578
+ */
6579
+ next_cursor?: string;
6580
+ /**
6581
+ * The cursor used to iterate preceding results in accordance to the
6582
+ * sort order. If not set, then no prior elements exist.
6583
+ */
6584
+ prev_cursor?: string;
6585
+ /** The stock schema fragments. */
6586
+ result: StockSchemaFragment[];
6587
+ }
5299
6588
  /** subtype */
5300
6589
  export interface Subtype {
5301
6590
  /** Display name of the subtype. */
@@ -5322,11 +6611,239 @@ export interface SubtypesListResponse {
5322
6611
  /** List of subtypes. */
5323
6612
  subtypes: Subtype[];
5324
6613
  }
6614
+ /** survey */
6615
+ export type Survey = AtomBase & {
6616
+ /** Description of the survey. */
6617
+ description?: string;
6618
+ /**
6619
+ * Survey name associated with schema. This name would be unique per
6620
+ * dev org.
6621
+ */
6622
+ name?: string;
6623
+ /** List of all fields in the schema. */
6624
+ schema: SchemaFieldDescriptor[];
6625
+ };
5325
6626
  /**
5326
6627
  * survey-aggregation-filter
5327
6628
  * The filter for survey aggregation.
5328
6629
  */
5329
6630
  export type SurveyAggregationFilter = object;
6631
+ /** survey-response */
6632
+ export type SurveyResponse = AtomBase & {
6633
+ /** The unique ID associated with the dispatched survey. */
6634
+ dispatch_id?: string;
6635
+ /** The ID of the object for which survey is taken. */
6636
+ object?: string;
6637
+ /** Response for the survey. */
6638
+ response?: object;
6639
+ /** The ID of the survey for which response is taken. */
6640
+ survey?: string;
6641
+ };
6642
+ /** surveys-create-request */
6643
+ export interface SurveysCreateRequest {
6644
+ /** Description about the survey. */
6645
+ description?: string;
6646
+ /** The survey's name. */
6647
+ name: string;
6648
+ /** Schema for the survey. */
6649
+ schema: FieldDescriptor[];
6650
+ }
6651
+ /** surveys-create-response */
6652
+ export interface SurveysCreateResponse {
6653
+ survey: Survey;
6654
+ }
6655
+ /** surveys-delete-request */
6656
+ export interface SurveysDeleteRequest {
6657
+ /** ID of the survey being deleted. */
6658
+ id: string;
6659
+ }
6660
+ /** surveys-delete-response */
6661
+ export type SurveysDeleteResponse = object;
6662
+ /** surveys-list-request */
6663
+ export interface SurveysListRequest {
6664
+ /**
6665
+ * Filters for surveys created by any of these users.
6666
+ * @example ["DEVU-12345"]
6667
+ */
6668
+ created_by?: string[];
6669
+ /** Provides ways to specify date ranges on objects. */
6670
+ created_date?: DateFilter;
6671
+ /**
6672
+ * The cursor to resume iteration from. If not provided, then
6673
+ * iteration starts from the beginning.
6674
+ */
6675
+ cursor?: string;
6676
+ /**
6677
+ * The maximum number of surveys to return. If not set, then the
6678
+ * default is '50'.
6679
+ * @format int32
6680
+ */
6681
+ limit?: number;
6682
+ /**
6683
+ * The iteration mode to use. If "after", then entries after the provided
6684
+ * cursor will be returned, or if no cursor is provided, then from the
6685
+ * beginning. If "before", then entries before the provided cursor will be
6686
+ * returned, or if no cursor is provided, then from the end. Entries will
6687
+ * always be returned in the specified sort-by order.
6688
+ */
6689
+ mode?: ListMode;
6690
+ /** Provides ways to specify date ranges on objects. */
6691
+ modified_date?: DateFilter;
6692
+ /** Filters for surveys by name(s). */
6693
+ name?: string[];
6694
+ /** Fields to sort the surveys by and the direction to sort them. */
6695
+ sort_by?: string[];
6696
+ }
6697
+ /** surveys-list-response */
6698
+ export interface SurveysListResponse {
6699
+ /**
6700
+ * The cursor used to iterate subsequent results in accordance to the
6701
+ * sort order. If not set, then no later elements exist.
6702
+ */
6703
+ next_cursor?: string;
6704
+ /**
6705
+ * The cursor used to iterate preceding results in accordance to the
6706
+ * sort order. If not set, then no prior elements exist.
6707
+ */
6708
+ prev_cursor?: string;
6709
+ /** The list of the surveys. */
6710
+ surveys: Survey[];
6711
+ }
6712
+ /** surveys-responses-list-request */
6713
+ export interface SurveysResponsesListRequest {
6714
+ /**
6715
+ * Filters for survey responses created by any of these users.
6716
+ * @example ["DEVU-12345"]
6717
+ */
6718
+ created_by?: string[];
6719
+ /** Provides ways to specify date ranges on objects. */
6720
+ created_date?: DateFilter;
6721
+ /**
6722
+ * The cursor to resume iteration from. If not provided, then
6723
+ * iteration starts from the beginning.
6724
+ */
6725
+ cursor?: string;
6726
+ /**
6727
+ * The maximum number of survey responses to return. If not set, then
6728
+ * the default is '50'.
6729
+ * @format int32
6730
+ */
6731
+ limit?: number;
6732
+ /**
6733
+ * The iteration mode to use. If "after", then entries after the provided
6734
+ * cursor will be returned, or if no cursor is provided, then from the
6735
+ * beginning. If "before", then entries before the provided cursor will be
6736
+ * returned, or if no cursor is provided, then from the end. Entries will
6737
+ * always be returned in the specified sort-by order.
6738
+ */
6739
+ mode?: ListMode;
6740
+ /** Provides ways to specify date ranges on objects. */
6741
+ modified_date?: DateFilter;
6742
+ /**
6743
+ * Filters for survey responses created for the objects.
6744
+ * @example ["ACC-12345"]
6745
+ */
6746
+ objects?: string[];
6747
+ /**
6748
+ * Fields to sort the survey responses by and the direction to sort
6749
+ * them.
6750
+ */
6751
+ sort_by?: string[];
6752
+ /** Filters for survey responses for the provided survey IDs. */
6753
+ surveys?: string[];
6754
+ }
6755
+ /** surveys-responses-list-response */
6756
+ export interface SurveysResponsesListResponse {
6757
+ /**
6758
+ * The cursor used to iterate subsequent results in accordance to the
6759
+ * sort order. If not set, then no later elements exist.
6760
+ */
6761
+ next_cursor?: string;
6762
+ /**
6763
+ * The cursor used to iterate preceding results in accordance to the
6764
+ * sort order. If not set, then no prior elements exist.
6765
+ */
6766
+ prev_cursor?: string;
6767
+ /** The list of the survey responses. */
6768
+ survey_responses: SurveyResponse[];
6769
+ }
6770
+ /** surveys-send-request */
6771
+ export interface SurveysSendRequest {
6772
+ email: SurveysSendRequestEmail;
6773
+ }
6774
+ /** surveys-send-request-email */
6775
+ export interface SurveysSendRequestEmail {
6776
+ /** Message body for a survey email. */
6777
+ body: string;
6778
+ /** Recipients list for a survey email. */
6779
+ recipients: string[];
6780
+ /** Sender email address from which an email is sent. */
6781
+ sender: string;
6782
+ /** Subject for an email where survey is sent. */
6783
+ subject: string;
6784
+ }
6785
+ /** surveys-send-response */
6786
+ export type SurveysSendResponse = object;
6787
+ /** surveys-submit-request */
6788
+ export interface SurveysSubmitRequest {
6789
+ /** The unique ID associated with the dispatched survey. */
6790
+ dispatch_id?: string;
6791
+ /**
6792
+ * The ID of the object this survey is on (e.g. ticket, conversation,
6793
+ * etc).
6794
+ * @example "ACC-12345"
6795
+ */
6796
+ object: string;
6797
+ /** Survey response submitted for the object. */
6798
+ response: object;
6799
+ /**
6800
+ * The response score for the survey. Only applicable for CSAT and
6801
+ * NPS.
6802
+ * @format int32
6803
+ */
6804
+ response_score?: number;
6805
+ /** The source channel from which survey response is submitted. */
6806
+ source_channel?: string;
6807
+ /** The ID of the survey to submit the response to. */
6808
+ survey: string;
6809
+ }
6810
+ /** surveys-submit-response */
6811
+ export type SurveysSubmitResponse = object;
6812
+ /** sync-metadata-filter */
6813
+ export interface SyncMetadataFilter {
6814
+ last_sync_in?: SyncMetadataFilterSyncInFilter;
6815
+ last_sync_out?: SyncMetadataFilterSyncOutFilter;
6816
+ /** Filters for issues synced from this specific origin system. */
6817
+ origin_system?: string[];
6818
+ }
6819
+ /** sync-metadata-filter-sync-in-filter */
6820
+ export interface SyncMetadataFilterSyncInFilter {
6821
+ /** Filters for works with selected sync statuses. */
6822
+ status?: SyncMetadataFilterSyncInFilterStatus[];
6823
+ /** Provides ways to specify date ranges on objects. */
6824
+ sync_date?: DateFilter;
6825
+ /** Filters for works modified with selected sync units. */
6826
+ sync_unit?: string[];
6827
+ }
6828
+ export declare enum SyncMetadataFilterSyncInFilterStatus {
6829
+ Failed = "failed",
6830
+ Modified = "modified",
6831
+ Staged = "staged",
6832
+ Succeeded = "succeeded"
6833
+ }
6834
+ /** sync-metadata-filter-sync-out-filter */
6835
+ export interface SyncMetadataFilterSyncOutFilter {
6836
+ /** Filters for works with selected sync statuses. */
6837
+ status?: SyncMetadataFilterSyncOutFilterStatus[];
6838
+ /** Provides ways to specify date ranges on objects. */
6839
+ sync_date?: DateFilter;
6840
+ /** Filters for works modified with selected sync units. */
6841
+ sync_unit?: string[];
6842
+ }
6843
+ export declare enum SyncMetadataFilterSyncOutFilterStatus {
6844
+ Failed = "failed",
6845
+ Succeeded = "succeeded"
6846
+ }
5330
6847
  /** sys-user */
5331
6848
  export type SysUser = UserBase;
5332
6849
  /** sys-user-summary */
@@ -5420,6 +6937,10 @@ export type Tag = AtomBase & {
5420
6937
  */
5421
6938
  name: string;
5422
6939
  };
6940
+ /** tag-search-summary */
6941
+ export type TagSearchSummary = SearchSummaryBase & {
6942
+ tag: TagSummary;
6943
+ };
5423
6944
  /** tag-summary */
5424
6945
  export type TagSummary = AtomBaseSummary & {
5425
6946
  /**
@@ -5598,15 +7119,26 @@ export declare enum TaskPriority {
5598
7119
  export type TaskSummary = WorkBaseSummary;
5599
7120
  /** tenant-fragment */
5600
7121
  export type TenantFragment = CustomSchemaFragmentBase;
7122
+ /** tenant-fragment-summary */
7123
+ export type TenantFragmentSummary = CustomSchemaFragmentBaseSummary;
5601
7124
  /** ticket */
5602
7125
  export type Ticket = WorkBase & {
7126
+ /** Channels of the ticket. */
7127
+ channels?: TicketChannels[];
5603
7128
  group?: GroupSummary;
5604
7129
  rev_org?: OrgSummary;
5605
7130
  /** Severity of the ticket. */
5606
7131
  severity?: TicketSeverity;
7132
+ sla_tracker?: SlaTrackerSummary;
5607
7133
  /** Source channel of the ticket. */
5608
7134
  source_channel?: string;
5609
7135
  };
7136
+ /** Channels of the ticket. */
7137
+ export declare enum TicketChannels {
7138
+ Email = "email",
7139
+ Plug = "plug",
7140
+ Slack = "slack"
7141
+ }
5610
7142
  /** Severity of the ticket. */
5611
7143
  export declare enum TicketSeverity {
5612
7144
  Blocker = "blocker",
@@ -5642,6 +7174,8 @@ export declare enum TimelineCommentBodyType {
5642
7174
  SnapWidget = "snap_widget",
5643
7175
  Text = "text"
5644
7176
  }
7177
+ /** timeline-comment-summary */
7178
+ export type TimelineCommentSummary = TimelineEntryBaseSummary;
5645
7179
  /** Describes collections of timeline entries. */
5646
7180
  export declare enum TimelineEntriesCollection {
5647
7181
  Discussions = "discussions",
@@ -5698,7 +7232,7 @@ export type TimelineEntriesCreateRequest = TimelineEntriesCreateRequestTimelineC
5698
7232
  export interface TimelineEntriesCreateRequestTimelineComment {
5699
7233
  /**
5700
7234
  * The IDs of the artifacts attached to the comment.
5701
- * @maxItems 10
7235
+ * @maxItems 50
5702
7236
  * @example ["ARTIFACT-12345"]
5703
7237
  */
5704
7238
  artifacts?: string[];
@@ -5713,6 +7247,11 @@ export interface TimelineEntriesCreateRequestTimelineComment {
5713
7247
  link_previews?: string[];
5714
7248
  /** Snap Kit Body of the comment. */
5715
7249
  snap_kit_body?: TimelineSnapKitBody;
7250
+ /**
7251
+ * The snap widget body of the comment.
7252
+ * @example ["don:core:<partition>:devo/<dev-org-id>:snap_widget/<snap-widget-id>"]
7253
+ */
7254
+ snap_widget_body?: string[];
5716
7255
  }
5717
7256
  export declare enum TimelineEntriesCreateRequestType {
5718
7257
  TimelineComment = "timeline_comment"
@@ -5867,7 +7406,7 @@ export interface TimelineEntriesUpdateRequestTimelineCommentArtifacts {
5867
7406
  remove?: string[];
5868
7407
  /**
5869
7408
  * Sets the field to the provided artifacts.
5870
- * @maxItems 10
7409
+ * @maxItems 50
5871
7410
  * @example ["ARTIFACT-12345"]
5872
7411
  */
5873
7412
  set?: string[];
@@ -5931,6 +7470,8 @@ export type TimelineEntryBase = AtomBase & {
5931
7470
  */
5932
7471
  visibility?: TimelineEntryVisibility;
5933
7472
  };
7473
+ /** timeline-entry-base-summary */
7474
+ export type TimelineEntryBaseSummary = AtomBaseSummary;
5934
7475
  /** The type of object that the Timeline entry belongs to. */
5935
7476
  export declare enum TimelineEntryObjectType {
5936
7477
  Account = "account",
@@ -6008,6 +7549,29 @@ export interface TimelineThread {
6008
7549
  */
6009
7550
  total_replies?: number;
6010
7551
  }
7552
+ /** track-event */
7553
+ export interface TrackEvent {
7554
+ /** Properties of client to be used in track API. */
7555
+ client_context?: ClientContext;
7556
+ /** Unique ID for the event. */
7557
+ event_id?: string;
7558
+ /**
7559
+ * The timestamp at which the event occurred.
7560
+ * @format date-time
7561
+ * @example "2023-01-01T12:00:00.000Z"
7562
+ */
7563
+ event_time?: string;
7564
+ /** Name of the event. */
7565
+ name: string;
7566
+ /** Payload of the event */
7567
+ payload: object;
7568
+ }
7569
+ /** track-events-publish-request */
7570
+ export interface TrackEventsPublishRequest {
7571
+ events_list: TrackEvent[];
7572
+ }
7573
+ /** track-events-publish-response */
7574
+ export type TrackEventsPublishResponse = object;
6011
7575
  /**
6012
7576
  * unit
6013
7577
  * Unit encapsulates the name of the unit and the type of the unit. For
@@ -6097,6 +7661,38 @@ export declare enum UomMetricScope {
6097
7661
  Org = "org",
6098
7662
  User = "user"
6099
7663
  }
7664
+ /** uoms-count-request */
7665
+ export interface UomsCountRequest {
7666
+ /** List of aggregation types for filtering list of UOMs. */
7667
+ aggregation_types?: AggregationDetailAggregationType[];
7668
+ /**
7669
+ * List of Unit of Measurement (UOM) DONs to be used in filtering
7670
+ * complete list of UOMs defined in a Dev Org.
7671
+ */
7672
+ ids?: string[];
7673
+ /** List of metric names for filtering list of UOMs. */
7674
+ metric_names?: string[];
7675
+ /**
7676
+ * List of part IDs for filtering list of UOMs.
7677
+ * @example ["PROD-12345"]
7678
+ */
7679
+ part_ids?: string[];
7680
+ /**
7681
+ * List of product IDs for filtering list of UOMs.
7682
+ * @example ["PROD-12345"]
7683
+ */
7684
+ product_ids?: string[];
7685
+ /** List of unit types for filtering list of UOMs. */
7686
+ unit_types?: UnitType[];
7687
+ }
7688
+ /** uoms-count-response */
7689
+ export interface UomsCountResponse {
7690
+ /**
7691
+ * Count of Unit of Measurements matching the filter.
7692
+ * @format int32
7693
+ */
7694
+ count: number;
7695
+ }
6100
7696
  /** uoms-create-request */
6101
7697
  export interface UomsCreateRequest {
6102
7698
  /** Stores aggregation type and dimension information. */
@@ -6324,6 +7920,10 @@ export type UserBaseSummary = AtomBaseSummary & {
6324
7920
  /** State of the user. */
6325
7921
  state?: UserState;
6326
7922
  };
7923
+ /** user-search-summary */
7924
+ export type UserSearchSummary = SearchSummaryBase & {
7925
+ user: UserSummary;
7926
+ };
6327
7927
  /** State of the user. */
6328
7928
  export declare enum UserState {
6329
7929
  Active = "active",
@@ -6343,6 +7943,30 @@ export declare enum UserType {
6343
7943
  ServiceAccount = "service_account",
6344
7944
  SysUser = "sys_user"
6345
7945
  }
7946
+ /** vista-base-summary */
7947
+ export type VistaBaseSummary = AtomBaseSummary & {
7948
+ /** Name of the vista. */
7949
+ name: string;
7950
+ };
7951
+ /** vista-search-summary */
7952
+ export type VistaSearchSummary = SearchSummaryBase & {
7953
+ /** Represents a collection of DevRev objects. */
7954
+ vista: VistaSummary;
7955
+ };
7956
+ /**
7957
+ * vista-summary
7958
+ * Represents a collection of DevRev objects.
7959
+ */
7960
+ export type VistaSummary = (CuratedVistaSummary | DynamicVistaSummary | GroupedVistaSummary) & {
7961
+ /** Type of vista object. */
7962
+ type: VistaType;
7963
+ };
7964
+ /** Type of vista object. */
7965
+ export declare enum VistaType {
7966
+ Curated = "curated",
7967
+ Dynamic = "dynamic",
7968
+ Grouped = "grouped"
7969
+ }
6346
7970
  /** webhook */
6347
7971
  export type Webhook = AtomBase & {
6348
7972
  /** The event types that the webhook will receive. */
@@ -6382,6 +8006,9 @@ export interface WebhookEventRequest {
6382
8006
  sla_tracker_created?: EventSlaTrackerCreated;
6383
8007
  sla_tracker_deleted?: EventSlaTrackerDeleted;
6384
8008
  sla_tracker_updated?: EventSlaTrackerUpdated;
8009
+ survey_response_created?: EventSurveyResponseCreated;
8010
+ survey_response_deleted?: EventSurveyResponseDeleted;
8011
+ survey_response_updated?: EventSurveyResponseUpdated;
6385
8012
  tag_created?: EventTagCreated;
6386
8013
  tag_deleted?: EventTagDeleted;
6387
8014
  tag_updated?: EventTagUpdated;
@@ -6441,6 +8068,9 @@ export declare enum WebhookEventType {
6441
8068
  RevUserCreated = "rev_user_created",
6442
8069
  RevUserDeleted = "rev_user_deleted",
6443
8070
  RevUserUpdated = "rev_user_updated",
8071
+ SlaTrackerCreated = "sla_tracker_created",
8072
+ SlaTrackerDeleted = "sla_tracker_deleted",
8073
+ SlaTrackerUpdated = "sla_tracker_updated",
6444
8074
  TagCreated = "tag_created",
6445
8075
  TagDeleted = "tag_deleted",
6446
8076
  TagUpdated = "tag_updated",
@@ -6469,6 +8099,8 @@ export declare enum WebhookStatus {
6469
8099
  Inactive = "inactive",
6470
8100
  Unverified = "unverified"
6471
8101
  }
8102
+ /** webhook-summary */
8103
+ export type WebhookSummary = AtomBaseSummary;
6472
8104
  /**
6473
8105
  * webhooks-create-request
6474
8106
  * The request to create a new webhook.
@@ -6637,6 +8269,8 @@ export type WorkBase = AtomBase & {
6637
8269
  * @example "don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"
6638
8270
  */
6639
8271
  stock_schema_fragment?: string;
8272
+ /** Subtype corresponding to the custom type fragment. */
8273
+ subtype?: string;
6640
8274
  /** Tags associated with the object. */
6641
8275
  tags?: TagWithValue[];
6642
8276
  /**
@@ -6650,9 +8284,21 @@ export type WorkBase = AtomBase & {
6650
8284
  };
6651
8285
  /** work-base-summary */
6652
8286
  export type WorkBaseSummary = AtomBaseSummary & {
8287
+ /** The users that own the work. */
8288
+ owned_by: UserSummary[];
8289
+ /** Describes the current stage of a work item. */
8290
+ stage?: LegacyStageSummary;
6653
8291
  /** Title of the work object. */
6654
8292
  title: string;
6655
8293
  };
8294
+ /** work-search-summary */
8295
+ export type WorkSearchSummary = SearchSummaryBase & {
8296
+ work: WorkSummary;
8297
+ };
8298
+ /** work-summary */
8299
+ export type WorkSummary = (IssueSummary | OpportunitySummary | TaskSummary | TicketSummary) & {
8300
+ type: WorkType;
8301
+ };
6656
8302
  export declare enum WorkType {
6657
8303
  Issue = "issue",
6658
8304
  Opportunity = "opportunity",
@@ -6682,6 +8328,14 @@ export type WorksCreateRequest = (WorksCreateRequestIssue | WorksCreateRequestOp
6682
8328
  * @example ["don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"]
6683
8329
  */
6684
8330
  custom_schema_fragments?: string[];
8331
+ /**
8332
+ * Requested custom schemas described abstractly. Every provided schema's
8333
+ * custom field must be specified, otherwise a bad request error is
8334
+ * returned. If a new custom schema specifier is provided, then it will be
8335
+ * added to the work, otherwise if a custom schema is omitted from the
8336
+ * specifier, it remains unmodified.
8337
+ */
8338
+ custom_schema_spec?: CustomSchemaSpec;
6685
8339
  /**
6686
8340
  * The users that own the work.
6687
8341
  * @example ["DEVU-12345"]
@@ -6723,6 +8377,12 @@ export interface WorksCreateRequestIssue {
6723
8377
  priority_v2?: number;
6724
8378
  /** The sprint that the issue belongs to. */
6725
8379
  sprint?: string;
8380
+ /**
8381
+ * Timestamp for when the work is expected to start.
8382
+ * @format date-time
8383
+ * @example "2023-01-01T12:00:00.000Z"
8384
+ */
8385
+ target_start_date?: string;
6726
8386
  }
6727
8387
  /** works-create-request-opportunity */
6728
8388
  export interface WorksCreateRequestOpportunity {
@@ -6768,6 +8428,8 @@ export interface WorksCreateRequestTask {
6768
8428
  }
6769
8429
  /** works-create-request-ticket */
6770
8430
  export interface WorksCreateRequestTicket {
8431
+ /** Channels of the ticket. */
8432
+ channels?: TicketChannels[];
6771
8433
  /** The group that the ticket is associated with. */
6772
8434
  group?: string;
6773
8435
  /** Whether the ticket is spam. */
@@ -6829,10 +8491,17 @@ export interface WorksExportRequest {
6829
8491
  * @example ["DEVU-12345"]
6830
8492
  */
6831
8493
  owned_by?: string[];
8494
+ /**
8495
+ * Filters for work reported by any of these users.
8496
+ * @example ["DEVU-12345"]
8497
+ */
8498
+ reported_by?: string[];
6832
8499
  /** Fields to sort the work items by and the direction to sort them. */
6833
8500
  sort_by?: string[];
6834
8501
  /** The filter for stages. */
6835
8502
  stage?: StageFilter;
8503
+ staged_info?: StagedInfoFilter;
8504
+ sync_metadata?: SyncMetadataFilter;
6836
8505
  /**
6837
8506
  * Filters for work with any of the provided tags.
6838
8507
  * @example ["TAG-12345"]
@@ -6856,6 +8525,8 @@ export interface WorksFilterIssue {
6856
8525
  * @example ["ACC-12345"]
6857
8526
  */
6858
8527
  accounts?: string[];
8528
+ /** Provides ways to specify date ranges on objects. */
8529
+ actual_start_date?: DateFilter;
6859
8530
  /** Filters for issues with any of the provided priorities. */
6860
8531
  priority?: IssuePriority[];
6861
8532
  /** Filters for issues with any of the provided priority enum ids. */
@@ -6865,6 +8536,10 @@ export interface WorksFilterIssue {
6865
8536
  * @example ["REV-AbCdEfGh"]
6866
8537
  */
6867
8538
  rev_orgs?: string[];
8539
+ /** Filters for issues with any of the provided subtypes. */
8540
+ subtype?: string[];
8541
+ /** Provides ways to specify date ranges on objects. */
8542
+ target_start_date?: DateFilter;
6868
8543
  }
6869
8544
  /** works-filter-opportunity */
6870
8545
  export interface WorksFilterOpportunity {
@@ -6876,9 +8551,13 @@ export interface WorksFilterOpportunity {
6876
8551
  account?: string[];
6877
8552
  /** Filters for opportunities with any of the provided contacts. */
6878
8553
  contacts?: string[];
8554
+ /** Filters for opportunity with any of the provided subtypes. */
8555
+ subtype?: string[];
6879
8556
  }
6880
8557
  /** works-filter-ticket */
6881
8558
  export interface WorksFilterTicket {
8559
+ /** Filters for tickets with any of the provided channels. */
8560
+ channels?: TicketChannels[];
6882
8561
  /** Filters for tickets belonging to specific groups. */
6883
8562
  group?: string[];
6884
8563
  /** Filters for tickets that are spam. */
@@ -6897,6 +8576,8 @@ export interface WorksFilterTicket {
6897
8576
  sla_summary?: SlaSummaryFilter;
6898
8577
  /** Filters for tickets with any of the provided source channels. */
6899
8578
  source_channel?: string[];
8579
+ /** Filters for tickets with any of the provided subtypes. */
8580
+ subtype?: string[];
6900
8581
  /** The filter for survey aggregation. */
6901
8582
  surveys?: SurveyAggregationFilter;
6902
8583
  }
@@ -6957,10 +8638,17 @@ export interface WorksListRequest {
6957
8638
  * @example ["DEVU-12345"]
6958
8639
  */
6959
8640
  owned_by?: string[];
8641
+ /**
8642
+ * Filters for work reported by any of these users.
8643
+ * @example ["DEVU-12345"]
8644
+ */
8645
+ reported_by?: string[];
6960
8646
  /** Fields to sort the works by and the direction to sort them. */
6961
8647
  sort_by?: string[];
6962
8648
  /** The filter for stages. */
6963
8649
  stage?: StageFilter;
8650
+ staged_info?: StagedInfoFilter;
8651
+ sync_metadata?: SyncMetadataFilter;
6964
8652
  /**
6965
8653
  * Filters for work with any of the provided tags.
6966
8654
  * @example ["TAG-12345"]
@@ -6994,7 +8682,7 @@ export type WorksUpdateRequest = (Empty | WorksUpdateRequestIssue | WorksUpdateR
6994
8682
  * @example "PROD-12345"
6995
8683
  */
6996
8684
  applies_to_part?: string;
6997
- artifacts?: WorksUpdateRequestArtifactIds;
8685
+ artifacts?: WorksUpdateRequestArtifacts;
6998
8686
  /** Updated body of the work object, or unchanged if not provided. */
6999
8687
  body?: string;
7000
8688
  /** Custom fields. */
@@ -7004,6 +8692,14 @@ export type WorksUpdateRequest = (Empty | WorksUpdateRequestIssue | WorksUpdateR
7004
8692
  * @example ["don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"]
7005
8693
  */
7006
8694
  custom_schema_fragments?: string[];
8695
+ /**
8696
+ * Requested custom schemas described abstractly. Every provided schema's
8697
+ * custom field must be specified, otherwise a bad request error is
8698
+ * returned. If a new custom schema specifier is provided, then it will be
8699
+ * added to the work, otherwise if a custom schema is omitted from the
8700
+ * specifier, it remains unmodified.
8701
+ */
8702
+ custom_schema_spec?: CustomSchemaSpec;
7007
8703
  /**
7008
8704
  * The work's ID.
7009
8705
  * @example "ISS-12345"
@@ -7025,10 +8721,23 @@ export type WorksUpdateRequest = (Empty | WorksUpdateRequestIssue | WorksUpdateR
7025
8721
  title?: string;
7026
8722
  type?: WorkType;
7027
8723
  };
7028
- /** works-update-request-artifact-ids */
7029
- export interface WorksUpdateRequestArtifactIds {
8724
+ /** works-update-request-artifacts */
8725
+ export interface WorksUpdateRequestArtifacts {
7030
8726
  /**
7031
- * Sets the IDs to the provided artifact IDs.
8727
+ * Adds the provided artifacts (if not already present) to the field.
8728
+ * @maxItems 50
8729
+ * @example ["ARTIFACT-12345"]
8730
+ */
8731
+ add?: string[];
8732
+ /**
8733
+ * Removes the provided artifacts (if they exist) from the field.
8734
+ * @maxItems 50
8735
+ * @example ["ARTIFACT-12345"]
8736
+ */
8737
+ remove?: string[];
8738
+ /**
8739
+ * Sets the field to the provided artifacts.
8740
+ * @maxItems 50
7032
8741
  * @example ["ARTIFACT-12345"]
7033
8742
  */
7034
8743
  set?: string[];
@@ -7045,6 +8754,12 @@ export interface WorksUpdateRequestIssue {
7045
8754
  priority_v2?: number;
7046
8755
  /** Updates the sprint that the issue belongs to. */
7047
8756
  sprint?: string | null;
8757
+ /**
8758
+ * Updates the timestamp for when the work is expected to start.
8759
+ * @format date-time
8760
+ * @example "2023-01-01T12:00:00.000Z"
8761
+ */
8762
+ target_start_date?: string | null;
7048
8763
  }
7049
8764
  /** works-update-request-issue-developed-with */
7050
8765
  export interface WorksUpdateRequestIssueDevelopedWith {
@@ -7127,6 +8842,7 @@ export interface WorksUpdateRequestTask {
7127
8842
  }
7128
8843
  /** works-update-request-ticket */
7129
8844
  export interface WorksUpdateRequestTicket {
8845
+ channels?: WorksUpdateRequestTicketChannels;
7130
8846
  /** Updates the group that the ticket is associated with. */
7131
8847
  group?: string | null;
7132
8848
  /** Updates whether the ticket is spam. */
@@ -7139,6 +8855,11 @@ export interface WorksUpdateRequestTicket {
7139
8855
  /** Severity of the ticket. */
7140
8856
  severity?: TicketSeverity;
7141
8857
  }
8858
+ /** works-update-request-ticket-channels */
8859
+ export interface WorksUpdateRequestTicketChannels {
8860
+ /** Sets the channels to the provided channels. */
8861
+ set?: TicketChannels[];
8862
+ }
7142
8863
  /** works-update-response */
7143
8864
  export interface WorksUpdateResponse {
7144
8865
  work: Work;
@@ -7236,6 +8957,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
7236
8957
  'created_date.before'?: string;
7237
8958
  /** Filters for custom fields. */
7238
8959
  custom_fields?: object;
8960
+ /** Array of display names of accounts to be filtered. */
8961
+ display_name?: string[];
7239
8962
  /** Domains for accounts to be filtered. */
7240
8963
  domains?: string[];
7241
8964
  /** Array of references of accounts to be filtered. */
@@ -7333,6 +9056,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
7333
9056
  cursor?: string;
7334
9057
  /** Filters for custom fields. */
7335
9058
  custom_fields?: object;
9059
+ /** Array of display names of accounts to be filtered. */
9060
+ display_name?: string[];
7336
9061
  /** Domains for accounts to be filtered. */
7337
9062
  domains?: string[];
7338
9063
  /** Array of references of accounts to be filtered. */
@@ -7532,6 +9257,53 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
7532
9257
  * @secure
7533
9258
  */
7534
9259
  updateArticle: (data: ArticlesUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<ArticlesUpdateResponse, any>>;
9260
+ /**
9261
+ * @description Gets the requested artifact's information.
9262
+ *
9263
+ * @tags artifacts
9264
+ * @name ArtifactsGet
9265
+ * @request GET:/artifacts.get
9266
+ * @secure
9267
+ */
9268
+ artifactsGet: (query: {
9269
+ /**
9270
+ * The requested artifact's ID.
9271
+ * @example "ARTIFACT-12345"
9272
+ */
9273
+ id: string;
9274
+ /** The version of the artifact that needs to be fetched. */
9275
+ version?: string;
9276
+ }, params?: RequestParams) => Promise<AxiosResponse<ArtifactsGetResponse, any>>;
9277
+ /**
9278
+ * @description Gets the requested artifact's information.
9279
+ *
9280
+ * @tags artifacts
9281
+ * @name ArtifactsGetPost
9282
+ * @request POST:/artifacts.get
9283
+ * @secure
9284
+ */
9285
+ artifactsGetPost: (data: ArtifactsGetRequest, params?: RequestParams) => Promise<AxiosResponse<ArtifactsGetResponse, any>>;
9286
+ /**
9287
+ * @description List the artifacts attached to an object.
9288
+ *
9289
+ * @tags artifacts
9290
+ * @name ArtifactsList
9291
+ * @request GET:/artifacts.list
9292
+ * @secure
9293
+ */
9294
+ artifactsList: (query?: {
9295
+ /** The ID of the object to filter artifacts. */
9296
+ parent_id?: string;
9297
+ }, params?: RequestParams) => Promise<AxiosResponse<ArtifactsListResponse, any>>;
9298
+ /**
9299
+ * @description List the artifacts attached to an object.
9300
+ *
9301
+ * @tags artifacts
9302
+ * @name ArtifactsListPost
9303
+ * @request POST:/artifacts.list
9304
+ * @secure
9305
+ */
9306
+ artifactsListPost: (data: ArtifactsListRequest, params?: RequestParams) => Promise<AxiosResponse<ArtifactsListResponse, any>>;
7535
9307
  /**
7536
9308
  * @description Gets the download URL for the artifact.
7537
9309
  *
@@ -7669,27 +9441,27 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
7669
9441
  */
7670
9442
  authTokensUpdate: (data: AuthTokensUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<AuthTokensUpdateResponse, any>>;
7671
9443
  /**
7672
- * @description Create CodeChange object.
9444
+ * @description Creates a code change object.
7673
9445
  *
7674
- * @tags works
9446
+ * @tags code-changes
7675
9447
  * @name CodeChangesCreate
7676
9448
  * @request POST:/code-changes.create
7677
9449
  * @secure
7678
9450
  */
7679
9451
  codeChangesCreate: (data: CodeChangesCreateRequest, params?: RequestParams) => Promise<AxiosResponse<CodeChangesCreateResponse, any>>;
7680
9452
  /**
7681
- * @description Delete CodeChange object.
9453
+ * @description Deletes a code change object.
7682
9454
  *
7683
- * @tags works
9455
+ * @tags code-changes
7684
9456
  * @name CodeChangesDelete
7685
9457
  * @request POST:/code-changes.delete
7686
9458
  * @secure
7687
9459
  */
7688
9460
  codeChangesDelete: (data: CodeChangesDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
7689
9461
  /**
7690
- * @description Get CodeChange object.
9462
+ * @description Gets a code change object.
7691
9463
  *
7692
- * @tags works
9464
+ * @tags code-changes
7693
9465
  * @name CodeChangesGet
7694
9466
  * @request GET:/code-changes.get
7695
9467
  * @secure
@@ -7699,18 +9471,18 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
7699
9471
  id: string;
7700
9472
  }, params?: RequestParams) => Promise<AxiosResponse<CodeChangesGetResponse, any>>;
7701
9473
  /**
7702
- * @description Get CodeChange object.
9474
+ * @description Gets a code change object.
7703
9475
  *
7704
- * @tags works
9476
+ * @tags code-changes
7705
9477
  * @name CodeChangesGetPost
7706
9478
  * @request POST:/code-changes.get
7707
9479
  * @secure
7708
9480
  */
7709
9481
  codeChangesGetPost: (data: CodeChangesGetRequest, params?: RequestParams) => Promise<AxiosResponse<CodeChangesGetResponse, any>>;
7710
9482
  /**
7711
- * @description List CodeChange objects.
9483
+ * @description Lists code change objects.
7712
9484
  *
7713
- * @tags works
9485
+ * @tags code-changes
7714
9486
  * @name CodeChangesList
7715
9487
  * @request GET:/code-changes.list
7716
9488
  * @secure
@@ -7734,18 +9506,18 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
7734
9506
  mode?: ListMode;
7735
9507
  }, params?: RequestParams) => Promise<AxiosResponse<CodeChangesListResponse, any>>;
7736
9508
  /**
7737
- * @description List CodeChange objects.
9509
+ * @description Lists code change objects.
7738
9510
  *
7739
- * @tags works
9511
+ * @tags code-changes
7740
9512
  * @name CodeChangesListPost
7741
9513
  * @request POST:/code-changes.list
7742
9514
  * @secure
7743
9515
  */
7744
9516
  codeChangesListPost: (data: CodeChangesListRequest, params?: RequestParams) => Promise<AxiosResponse<CodeChangesListResponse, any>>;
7745
9517
  /**
7746
- * @description Update CodeChange object.
9518
+ * @description Updates a code change object.
7747
9519
  *
7748
- * @tags works
9520
+ * @tags code-changes
7749
9521
  * @name CodeChangesUpdate
7750
9522
  * @request POST:/code-changes.update
7751
9523
  * @secure
@@ -8328,6 +10100,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
8328
10100
  * starts from the beginning.
8329
10101
  */
8330
10102
  cursor?: string;
10103
+ /** Filters the groups based on the group type. */
10104
+ group_type?: GroupType[];
8331
10105
  /**
8332
10106
  * The maximum number of groups to return. The default is '50'.
8333
10107
  * @format int32
@@ -8524,6 +10298,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
8524
10298
  * starts from the beginning.
8525
10299
  */
8526
10300
  cursor?: string;
10301
+ /**
10302
+ * Whether to include custom metrics in the response. If not set, then
10303
+ * custom metrics are excluded.
10304
+ */
10305
+ include_custom_metrics?: boolean;
8527
10306
  /**
8528
10307
  * The maximum number of records to return. The default is '50'.
8529
10308
  * @format int32
@@ -8726,23 +10505,143 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
8726
10505
  /**
8727
10506
  * @description Gets a [part's](https://devrev.ai/docs/product/parts) information.
8728
10507
  *
8729
- * @tags parts
8730
- * @name PartsGetPost
8731
- * @request POST:/parts.get
10508
+ * @tags parts
10509
+ * @name PartsGetPost
10510
+ * @request POST:/parts.get
10511
+ * @secure
10512
+ */
10513
+ partsGetPost: (data: PartsGetRequest, params?: RequestParams) => Promise<AxiosResponse<PartsGetResponse, any>>;
10514
+ /**
10515
+ * @description Lists a collection of [parts](https://devrev.ai/docs/product/parts).
10516
+ *
10517
+ * @tags parts
10518
+ * @name PartsList
10519
+ * @request GET:/parts.list
10520
+ * @secure
10521
+ */
10522
+ partsList: (query?: {
10523
+ /**
10524
+ * Filters for parts created by any of these users.
10525
+ * @example ["DEVU-12345"]
10526
+ */
10527
+ created_by?: string[];
10528
+ /**
10529
+ * The cursor to resume iteration from. If not provided, then iteration
10530
+ * starts from the beginning.
10531
+ */
10532
+ cursor?: string;
10533
+ /**
10534
+ * The maximum number of parts to return. The default is '50'.
10535
+ * @format int32
10536
+ */
10537
+ limit?: number;
10538
+ /**
10539
+ * The iteration mode to use, otherwise if not set, then "after" is
10540
+ * used.
10541
+ */
10542
+ mode?: ListMode;
10543
+ /** Filters for parts of the provided name(s). */
10544
+ name?: string[];
10545
+ /**
10546
+ * Filters for parts owned by any of these users.
10547
+ * @example ["DEVU-12345"]
10548
+ */
10549
+ owned_by?: string[];
10550
+ /**
10551
+ * Number of levels to fetch the part hierarchy up to.
10552
+ * @format int32
10553
+ * @min 1
10554
+ */
10555
+ 'parent_part.level'?: number;
10556
+ /**
10557
+ * Part IDs to fetch the hierarchy for. Required if any parent_part.*
10558
+ * fields are provided.
10559
+ * @minItems 1
10560
+ * @example ["PROD-12345"]
10561
+ */
10562
+ 'parent_part.parts'?: string[];
10563
+ /** Filters for parts of the provided type(s). */
10564
+ type?: PartType[];
10565
+ }, params?: RequestParams) => Promise<AxiosResponse<PartsListResponse, any>>;
10566
+ /**
10567
+ * @description Lists a collection of [parts](https://devrev.ai/docs/product/parts).
10568
+ *
10569
+ * @tags parts
10570
+ * @name PartsListPost
10571
+ * @request POST:/parts.list
10572
+ * @secure
10573
+ */
10574
+ partsListPost: (data: PartsListRequest, params?: RequestParams) => Promise<AxiosResponse<PartsListResponse, any>>;
10575
+ /**
10576
+ * @description Updates a [part's](https://devrev.ai/docs/product/parts) information.
10577
+ *
10578
+ * @tags parts
10579
+ * @name PartsUpdate
10580
+ * @request POST:/parts.update
10581
+ * @secure
10582
+ */
10583
+ partsUpdate: (data: PartsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<PartsUpdateResponse, any>>;
10584
+ /**
10585
+ * @description Creates a question-answer.
10586
+ *
10587
+ * @tags question-answers
10588
+ * @name CreateQuestionAnswer
10589
+ * @request POST:/question-answers.create
10590
+ * @secure
10591
+ */
10592
+ createQuestionAnswer: (data: QuestionAnswersCreateRequest, params?: RequestParams) => Promise<AxiosResponse<QuestionAnswersCreateResponse, any>>;
10593
+ /**
10594
+ * @description Deletes a question-answer.
10595
+ *
10596
+ * @tags question-answers
10597
+ * @name DeleteQuestionAnswer
10598
+ * @request POST:/question-answers.delete
10599
+ * @secure
10600
+ */
10601
+ deleteQuestionAnswer: (data: QuestionAnswersDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<void, any>>;
10602
+ /**
10603
+ * @description Gets a question-answer.
10604
+ *
10605
+ * @tags question-answers
10606
+ * @name GetQuestionAnswer
10607
+ * @request GET:/question-answers.get
10608
+ * @secure
10609
+ */
10610
+ getQuestionAnswer: (query: {
10611
+ /** The ID of the required question-answer. */
10612
+ id: string;
10613
+ }, params?: RequestParams) => Promise<AxiosResponse<QuestionAnswersGetResponse, any>>;
10614
+ /**
10615
+ * @description Gets a question-answer.
10616
+ *
10617
+ * @tags question-answers
10618
+ * @name GetQuestionAnswerPost
10619
+ * @request POST:/question-answers.get
8732
10620
  * @secure
8733
10621
  */
8734
- partsGetPost: (data: PartsGetRequest, params?: RequestParams) => Promise<AxiosResponse<PartsGetResponse, any>>;
10622
+ getQuestionAnswerPost: (data: QuestionAnswersGetRequest, params?: RequestParams) => Promise<AxiosResponse<QuestionAnswersGetResponse, any>>;
8735
10623
  /**
8736
- * @description Lists a collection of [parts](https://devrev.ai/docs/product/parts).
10624
+ * @description Lists a collection of question-answers.
8737
10625
  *
8738
- * @tags parts
8739
- * @name PartsList
8740
- * @request GET:/parts.list
10626
+ * @tags question-answers
10627
+ * @name ListQuestionAnswers
10628
+ * @request GET:/question-answers.list
8741
10629
  * @secure
8742
10630
  */
8743
- partsList: (query?: {
10631
+ listQuestionAnswers: (query?: {
8744
10632
  /**
8745
- * Filters for parts created by any of these users.
10633
+ * Filters for question-answer belonging to any of the provided
10634
+ * articles.
10635
+ * @example ["ARTICLE-12345"]
10636
+ */
10637
+ applies_to_articles?: string[];
10638
+ /**
10639
+ * Filters for question-answer belonging to any of the provided parts.
10640
+ * @example ["PROD-12345"]
10641
+ */
10642
+ applies_to_parts?: string[];
10643
+ /**
10644
+ * Filters for question-answers created by any of the provided users.
8746
10645
  * @example ["DEVU-12345"]
8747
10646
  */
8748
10647
  created_by?: string[];
@@ -8752,7 +10651,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
8752
10651
  */
8753
10652
  cursor?: string;
8754
10653
  /**
8755
- * The maximum number of parts to return. The default is '50'.
10654
+ * The maximum number of question-answers to return. The default is
10655
+ * '50'.
8756
10656
  * @format int32
8757
10657
  */
8758
10658
  limit?: number;
@@ -8761,47 +10661,30 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
8761
10661
  * used.
8762
10662
  */
8763
10663
  mode?: ListMode;
8764
- /** Filters for parts of the provided name(s). */
8765
- name?: string[];
8766
10664
  /**
8767
- * Filters for parts owned by any of these users.
10665
+ * Filters for question-answers owned by any of the provided users.
8768
10666
  * @example ["DEVU-12345"]
8769
10667
  */
8770
10668
  owned_by?: string[];
8771
- /**
8772
- * Number of levels to fetch the part hierarchy up to.
8773
- * @format int32
8774
- * @min 1
8775
- */
8776
- 'parent_part.level'?: number;
8777
- /**
8778
- * Part IDs to fetch the hierarchy for. Required if any parent_part.*
8779
- * fields are provided.
8780
- * @minItems 1
8781
- * @example ["PROD-12345"]
8782
- */
8783
- 'parent_part.parts'?: string[];
8784
- /** Filters for parts of the provided type(s). */
8785
- type?: PartType[];
8786
- }, params?: RequestParams) => Promise<AxiosResponse<PartsListResponse, any>>;
10669
+ }, params?: RequestParams) => Promise<AxiosResponse<QuestionAnswersListResponse, any>>;
8787
10670
  /**
8788
- * @description Lists a collection of [parts](https://devrev.ai/docs/product/parts).
10671
+ * @description Lists a collection of question-answers.
8789
10672
  *
8790
- * @tags parts
8791
- * @name PartsListPost
8792
- * @request POST:/parts.list
10673
+ * @tags question-answers
10674
+ * @name ListQuestionAnswersPost
10675
+ * @request POST:/question-answers.list
8793
10676
  * @secure
8794
10677
  */
8795
- partsListPost: (data: PartsListRequest, params?: RequestParams) => Promise<AxiosResponse<PartsListResponse, any>>;
10678
+ listQuestionAnswersPost: (data: QuestionAnswersListRequest, params?: RequestParams) => Promise<AxiosResponse<QuestionAnswersListResponse, any>>;
8796
10679
  /**
8797
- * @description Updates a [part's](https://devrev.ai/docs/product/parts) information.
10680
+ * @description Updates a question-answer.
8798
10681
  *
8799
- * @tags parts
8800
- * @name PartsUpdate
8801
- * @request POST:/parts.update
10682
+ * @tags question-answers
10683
+ * @name UpdateQuestionAnswer
10684
+ * @request POST:/question-answers.update
8802
10685
  * @secure
8803
10686
  */
8804
- partsUpdate: (data: PartsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<PartsUpdateResponse, any>>;
10687
+ updateQuestionAnswer: (data: QuestionAnswersUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<QuestionAnswersUpdateResponse, any>>;
8805
10688
  /**
8806
10689
  * @description Creates a Rev organization in the authenticated user's Dev organization.
8807
10690
  *
@@ -8891,6 +10774,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
8891
10774
  custom_field_filter?: string[];
8892
10775
  /** Filters for custom fields. */
8893
10776
  custom_fields?: object;
10777
+ /** Array of display names of Rev orgs to be filtered. */
10778
+ display_name?: string[];
8894
10779
  /** List of external refs to filter Rev organizations for. */
8895
10780
  external_ref?: string[];
8896
10781
  /**
@@ -9100,6 +10985,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
9100
10985
  aggregatedSchemaGet: (query: {
9101
10986
  /** The list of custom schema fragment DONs which are to be aggregated. */
9102
10987
  custom_schema_fragment_ids: string[];
10988
+ /**
10989
+ * The leaf type. Used for inferring the default stage diagram and
10990
+ * tenant fragment ID.
10991
+ */
10992
+ leaf_type?: string;
9103
10993
  /** The stock schema fragment which is to be aggregated. */
9104
10994
  stock_schema_fragment_id?: string;
9105
10995
  }, params?: RequestParams) => Promise<AxiosResponse<AggregatedSchemaGetResponse, any>>;
@@ -9145,8 +11035,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
9145
11035
  /** The list of app names. */
9146
11036
  app?: string[];
9147
11037
  /**
9148
- * The cursor to resume iteration from, otherwise if not provided, then
9149
- * iteration starts from the beginning.
11038
+ * The cursor to resume iteration from. If not provided, then iteration
11039
+ * starts from the beginning.
9150
11040
  */
9151
11041
  cursor?: string;
9152
11042
  /** Whether only deprecated fragments should be filtered. */
@@ -9158,6 +11048,16 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
9158
11048
  * @format int32
9159
11049
  */
9160
11050
  limit?: number;
11051
+ /**
11052
+ * The iteration mode to use, otherwise if not set, then "after" is
11053
+ * used.
11054
+ */
11055
+ mode?: ListMode;
11056
+ /**
11057
+ * List of fields which are not required in the payload and can be
11058
+ * pruned away.
11059
+ */
11060
+ prune?: CustomSchemaFragmentsListRequestPrune[];
9161
11061
  /** The list of fields to sort the items by and how to sort them. */
9162
11062
  sort_by?: string[];
9163
11063
  /** The list of subtypes. */
@@ -9183,6 +11083,77 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
9183
11083
  * @secure
9184
11084
  */
9185
11085
  customSchemaFragmentsSet: (data: CustomSchemaFragmentsSetRequest, params?: RequestParams) => Promise<AxiosResponse<CustomSchemaFragmentsSetResponse, any>>;
11086
+ /**
11087
+ * @description Gets a stock schema fragment.
11088
+ *
11089
+ * @tags customization
11090
+ * @name StockSchemaFragmentsGet
11091
+ * @request GET:/schemas.stock.get
11092
+ * @secure
11093
+ */
11094
+ stockSchemaFragmentsGet: (query?: {
11095
+ /** The ID of the stock schema fragment. */
11096
+ id?: string;
11097
+ /** The leaf type this fragment applies to. */
11098
+ leaf_type?: string;
11099
+ }, params?: RequestParams) => Promise<AxiosResponse<StockSchemaFragmentsGetResponse, any>>;
11100
+ /**
11101
+ * @description Gets a stock schema fragment.
11102
+ *
11103
+ * @tags customization
11104
+ * @name StockSchemaFragmentsGetPost
11105
+ * @request POST:/schemas.stock.get
11106
+ * @secure
11107
+ */
11108
+ stockSchemaFragmentsGetPost: (data: StockSchemaFragmentsGetRequest, params?: RequestParams) => Promise<AxiosResponse<StockSchemaFragmentsGetResponse, any>>;
11109
+ /**
11110
+ * @description Lists stock schema fragments.
11111
+ *
11112
+ * @tags customization
11113
+ * @name StockSchemaFragmentsList
11114
+ * @request GET:/schemas.stock.list
11115
+ * @secure
11116
+ */
11117
+ stockSchemaFragmentsList: (query?: {
11118
+ /**
11119
+ * The cursor to resume iteration from. If not provided, then iteration
11120
+ * starts from the beginning.
11121
+ */
11122
+ cursor?: string;
11123
+ /**
11124
+ * Filter preset to specify whether to filter only customization enabled
11125
+ * leaf types.
11126
+ */
11127
+ filter_preset?: StockSchemaFragmentsListRequestFilterPreset;
11128
+ /** The list of leaf types. */
11129
+ leaf_type?: string[];
11130
+ /**
11131
+ * The maximum number of items.
11132
+ * @format int32
11133
+ */
11134
+ limit?: number;
11135
+ /**
11136
+ * The iteration mode to use, otherwise if not set, then "after" is
11137
+ * used.
11138
+ */
11139
+ mode?: ListMode;
11140
+ /**
11141
+ * List of fields which are not required in the payload and can be
11142
+ * pruned away.
11143
+ */
11144
+ prune?: StockSchemaFragmentsListRequestPrune[];
11145
+ /** The list of fields to sort the items by and how to sort them. */
11146
+ sort_by?: string[];
11147
+ }, params?: RequestParams) => Promise<AxiosResponse<StockSchemaFragmentsListResponse, any>>;
11148
+ /**
11149
+ * @description Lists stock schema fragments.
11150
+ *
11151
+ * @tags customization
11152
+ * @name StockSchemaFragmentsListPost
11153
+ * @request POST:/schemas.stock.list
11154
+ * @secure
11155
+ */
11156
+ stockSchemaFragmentsListPost: (data: StockSchemaFragmentsListRequest, params?: RequestParams) => Promise<AxiosResponse<StockSchemaFragmentsListResponse, any>>;
9186
11157
  /**
9187
11158
  * @description Lists subtypes.
9188
11159
  *
@@ -9209,6 +11180,49 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
9209
11180
  * @secure
9210
11181
  */
9211
11182
  subtypesListPost: (data: SubtypesListRequest, params?: RequestParams) => Promise<AxiosResponse<SubtypesListResponse, any>>;
11183
+ /**
11184
+ * @description Searches for records based on a given query.
11185
+ *
11186
+ * @tags search
11187
+ * @name SearchCore
11188
+ * @request GET:/search.core
11189
+ * @secure
11190
+ */
11191
+ searchCore: (query: {
11192
+ /**
11193
+ * The query string. Search query language:
11194
+ * https://docs.devrev.ai/product/search#fields
11195
+ */
11196
+ query: string;
11197
+ /**
11198
+ * The cursor from where to begin iteration. Start from beginning if not
11199
+ * provided.
11200
+ */
11201
+ cursor?: string | undefined;
11202
+ /**
11203
+ * The maximum number of items to return in a page. The default is '10'.
11204
+ * @format int32
11205
+ */
11206
+ limit?: number | undefined;
11207
+ /** The namespaces to search in. */
11208
+ namespaces?: SearchNamespace[] | undefined;
11209
+ /**
11210
+ * The property on which to sort the search results. The default is
11211
+ * RELEVANCE.
11212
+ */
11213
+ sort_by?: SearchSortByParam | undefined;
11214
+ /** Sorting order. The default is DESCENDING. */
11215
+ sort_order?: SearchSortOrderParam | undefined;
11216
+ }, params?: RequestParams) => Promise<AxiosResponse<SearchCoreResponse, any>>;
11217
+ /**
11218
+ * @description Searches for records based on a given query.
11219
+ *
11220
+ * @tags search
11221
+ * @name SearchCorePost
11222
+ * @request POST:/search.core
11223
+ * @secure
11224
+ */
11225
+ searchCorePost: (data: SearchCoreRequest, params?: RequestParams) => Promise<AxiosResponse<SearchCoreResponse, any>>;
9212
11226
  /**
9213
11227
  * @description Gets a service account.
9214
11228
  *
@@ -9230,6 +11244,27 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
9230
11244
  * @secure
9231
11245
  */
9232
11246
  serviceAccountsGetPost: (data: ServiceAccountsGetRequest, params?: RequestParams) => Promise<AxiosResponse<ServiceAccountsGetResponse, any>>;
11247
+ /**
11248
+ * @description Gets an SLA tracker.
11249
+ *
11250
+ * @tags slas
11251
+ * @name SlaTrackersGet
11252
+ * @request GET:/sla-trackers.get
11253
+ * @secure
11254
+ */
11255
+ slaTrackersGet: (query: {
11256
+ /** The ID of the SLA tracker to get. */
11257
+ id: string;
11258
+ }, params?: RequestParams) => Promise<AxiosResponse<SlaTrackersGetResponse, any>>;
11259
+ /**
11260
+ * @description Gets an SLA tracker.
11261
+ *
11262
+ * @tags slas
11263
+ * @name SlaTrackersGetPost
11264
+ * @request POST:/sla-trackers.get
11265
+ * @secure
11266
+ */
11267
+ slaTrackersGetPost: (data: SlaTrackersGetRequest, params?: RequestParams) => Promise<AxiosResponse<SlaTrackersGetResponse, any>>;
9233
11268
  /**
9234
11269
  * @description Assigns the SLA to a set of Rev organizations.
9235
11270
  *
@@ -9346,6 +11381,147 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
9346
11381
  * @secure
9347
11382
  */
9348
11383
  snapInsResourcesPost: (data: SnapInsResourcesRequest, params?: RequestParams) => Promise<AxiosResponse<SnapInsResourcesResponse, any>>;
11384
+ /**
11385
+ * @description Create a snap widget object.
11386
+ *
11387
+ * @tags snap-widgets
11388
+ * @name SnapWidgetsCreate
11389
+ * @request POST:/snap-widgets.create
11390
+ * @secure
11391
+ */
11392
+ snapWidgetsCreate: (data: SnapWidgetsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<SnapWidgetsCreateResponse, any>>;
11393
+ /**
11394
+ * @description Creates a schema for survey, which includes name and description of schema.
11395
+ *
11396
+ * @tags surveys
11397
+ * @name SurveysCreate
11398
+ * @request POST:/surveys.create
11399
+ * @secure
11400
+ */
11401
+ surveysCreate: (data: SurveysCreateRequest, params?: RequestParams) => Promise<AxiosResponse<SurveysCreateResponse, any>>;
11402
+ /**
11403
+ * @description Deletes the specified survey.
11404
+ *
11405
+ * @tags surveys
11406
+ * @name SurveysDelete
11407
+ * @request POST:/surveys.delete
11408
+ * @secure
11409
+ */
11410
+ surveysDelete: (data: SurveysDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
11411
+ /**
11412
+ * @description List surveys requested by the user.
11413
+ *
11414
+ * @tags surveys
11415
+ * @name SurveysList
11416
+ * @request GET:/surveys.list
11417
+ * @secure
11418
+ */
11419
+ surveysList: (query?: {
11420
+ /**
11421
+ * Filters for surveys created by any of these users.
11422
+ * @example ["DEVU-12345"]
11423
+ */
11424
+ created_by?: string[];
11425
+ /**
11426
+ * The cursor to resume iteration from. If not provided, then iteration
11427
+ * starts from the beginning.
11428
+ */
11429
+ cursor?: string;
11430
+ /**
11431
+ * The maximum number of surveys to return. If not set, then the default
11432
+ * is '50'.
11433
+ * @format int32
11434
+ */
11435
+ limit?: number;
11436
+ /**
11437
+ * The iteration mode to use, otherwise if not set, then "after" is
11438
+ * used.
11439
+ */
11440
+ mode?: ListMode;
11441
+ /** Filters for surveys by name(s). */
11442
+ name?: string[];
11443
+ /** Fields to sort the surveys by and the direction to sort them. */
11444
+ sort_by?: string[];
11445
+ }, params?: RequestParams) => Promise<AxiosResponse<SurveysListResponse, any>>;
11446
+ /**
11447
+ * @description List surveys requested by the user.
11448
+ *
11449
+ * @tags surveys
11450
+ * @name SurveysListPost
11451
+ * @request POST:/surveys.list
11452
+ * @secure
11453
+ */
11454
+ surveysListPost: (data: SurveysListRequest, params?: RequestParams) => Promise<AxiosResponse<SurveysListResponse, any>>;
11455
+ /**
11456
+ * @description List survey responses requested by the user.
11457
+ *
11458
+ * @tags surveys
11459
+ * @name SurveysResponsesList
11460
+ * @request GET:/surveys.responses.list
11461
+ * @secure
11462
+ */
11463
+ surveysResponsesList: (query?: {
11464
+ /**
11465
+ * Filters for survey responses created by any of these users.
11466
+ * @example ["DEVU-12345"]
11467
+ */
11468
+ created_by?: string[];
11469
+ /**
11470
+ * The cursor to resume iteration from. If not provided, then iteration
11471
+ * starts from the beginning.
11472
+ */
11473
+ cursor?: string;
11474
+ /**
11475
+ * The maximum number of survey responses to return. If not set, then
11476
+ * the default is '50'.
11477
+ * @format int32
11478
+ */
11479
+ limit?: number;
11480
+ /**
11481
+ * The iteration mode to use, otherwise if not set, then "after" is
11482
+ * used.
11483
+ */
11484
+ mode?: ListMode;
11485
+ /**
11486
+ * Filters for survey responses created for the objects.
11487
+ * @example ["ACC-12345"]
11488
+ */
11489
+ objects?: string[];
11490
+ /**
11491
+ * Fields to sort the survey responses by and the direction to sort
11492
+ * them.
11493
+ */
11494
+ sort_by?: string[];
11495
+ /** Filters for survey responses for the provided survey IDs. */
11496
+ surveys?: string[];
11497
+ }, params?: RequestParams) => Promise<AxiosResponse<SurveysResponsesListResponse, any>>;
11498
+ /**
11499
+ * @description List survey responses requested by the user.
11500
+ *
11501
+ * @tags surveys
11502
+ * @name SurveysResponsesListPost
11503
+ * @request POST:/surveys.responses.list
11504
+ * @secure
11505
+ */
11506
+ surveysResponsesListPost: (data: SurveysResponsesListRequest, params?: RequestParams) => Promise<AxiosResponse<SurveysResponsesListResponse, any>>;
11507
+ /**
11508
+ * @description Sends a survey on the specified channels.
11509
+ *
11510
+ * @tags surveys
11511
+ * @name SurveysSend
11512
+ * @request POST:/surveys.send
11513
+ * @secure
11514
+ */
11515
+ surveysSend: (data: SurveysSendRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
11516
+ /**
11517
+ * @description Submits a user response to a survey, which is defined by the survey ID.
11518
+ *
11519
+ * @tags surveys
11520
+ * @name SurveysSubmit
11521
+ * @request POST:/surveys.submit
11522
+ * @secure
11523
+ */
11524
+ surveysSubmit: (data: SurveysSubmitRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
9349
11525
  /**
9350
11526
  * @description Lists system users within your organization.
9351
11527
  *
@@ -9590,6 +11766,55 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
9590
11766
  * @secure
9591
11767
  */
9592
11768
  timelineEntriesUpdate: (data: TimelineEntriesUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<TimelineEntriesUpdateResponse, any>>;
11769
+ /**
11770
+ * @description Allows publishing of events (example from plug widget).
11771
+ *
11772
+ * @tags event-source
11773
+ * @name TrackEventsPublish
11774
+ * @request POST:/track-events.publish
11775
+ * @secure
11776
+ */
11777
+ trackEventsPublish: (data: TrackEventsPublishRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
11778
+ /**
11779
+ * @description Counts the number of Unit of Measurements based on the given filters.
11780
+ *
11781
+ * @tags product-usage
11782
+ * @name UomsCount
11783
+ * @request GET:/uoms.count
11784
+ * @secure
11785
+ */
11786
+ uomsCount: (query?: {
11787
+ /** List of aggregation types for filtering list of UOMs. */
11788
+ aggregation_types?: AggregationDetailAggregationType[];
11789
+ /**
11790
+ * List of Unit of Measurement (UOM) DONs to be used in filtering
11791
+ * complete list of UOMs defined in a Dev Org.
11792
+ */
11793
+ ids?: string[];
11794
+ /** List of metric names for filtering list of UOMs. */
11795
+ metric_names?: string[];
11796
+ /**
11797
+ * List of part IDs for filtering list of UOMs.
11798
+ * @example ["PROD-12345"]
11799
+ */
11800
+ part_ids?: string[];
11801
+ /**
11802
+ * List of product IDs for filtering list of UOMs.
11803
+ * @example ["PROD-12345"]
11804
+ */
11805
+ product_ids?: string[];
11806
+ /** List of unit types for filtering list of UOMs. */
11807
+ unit_types?: UnitType[];
11808
+ }, params?: RequestParams) => Promise<AxiosResponse<UomsCountResponse, any>>;
11809
+ /**
11810
+ * @description Counts the number of Unit of Measurements based on the given filters.
11811
+ *
11812
+ * @tags product-usage
11813
+ * @name UomsCountPost
11814
+ * @request POST:/uoms.count
11815
+ * @secure
11816
+ */
11817
+ uomsCountPost: (data: UomsCountRequest, params?: RequestParams) => Promise<AxiosResponse<UomsCountResponse, any>>;
9593
11818
  /**
9594
11819
  * @description Creates a Unit of Measurement on a part.
9595
11820
  *
@@ -9827,6 +12052,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
9827
12052
  * @example ["REV-AbCdEfGh"]
9828
12053
  */
9829
12054
  'issue.rev_orgs'?: string[];
12055
+ /** Filters for issues with any of the provided subtypes. */
12056
+ 'issue.subtype'?: string[];
9830
12057
  /**
9831
12058
  * Filters for opportunities belonging to any of the provided accounts.
9832
12059
  * @example ["ACC-12345"]
@@ -9834,20 +12061,41 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
9834
12061
  'opportunity.account'?: string[];
9835
12062
  /** Filters for opportunities with any of the provided contacts. */
9836
12063
  'opportunity.contacts'?: string[];
12064
+ /** Filters for opportunity with any of the provided subtypes. */
12065
+ 'opportunity.subtype'?: string[];
9837
12066
  /**
9838
12067
  * Filters for work owned by any of these users.
9839
12068
  * @example ["DEVU-12345"]
9840
12069
  */
9841
12070
  owned_by?: string[];
12071
+ /**
12072
+ * Filters for work reported by any of these users.
12073
+ * @example ["DEVU-12345"]
12074
+ */
12075
+ reported_by?: string[];
9842
12076
  /** Fields to sort the work items by and the direction to sort them. */
9843
12077
  sort_by?: string[];
9844
12078
  /** Filters for records in the provided stage(s) by name. */
9845
12079
  'stage.name'?: string[];
12080
+ /** Filters for issues that are staged. */
12081
+ 'staged_info.is_staged'?: boolean;
12082
+ /** Filters for works with selected sync statuses. */
12083
+ 'sync_metadata.last_sync_in.status'?: SyncMetadataFilterSyncInFilterStatus[];
12084
+ /** Filters for works modified with selected sync units. */
12085
+ 'sync_metadata.last_sync_in.sync_unit'?: string[];
12086
+ /** Filters for works with selected sync statuses. */
12087
+ 'sync_metadata.last_sync_out.status'?: SyncMetadataFilterSyncOutFilterStatus[];
12088
+ /** Filters for works modified with selected sync units. */
12089
+ 'sync_metadata.last_sync_out.sync_unit'?: string[];
12090
+ /** Filters for issues synced from this specific origin system. */
12091
+ 'sync_metadata.origin_system'?: string[];
9846
12092
  /**
9847
12093
  * Filters for work with any of the provided tags.
9848
12094
  * @example ["TAG-12345"]
9849
12095
  */
9850
12096
  tags?: string[];
12097
+ /** Filters for tickets with any of the provided channels. */
12098
+ 'ticket.channels'?: TicketChannels[];
9851
12099
  /** Filters for tickets belonging to specific groups. */
9852
12100
  'ticket.group'?: string[];
9853
12101
  /** Filters for tickets that are spam. */
@@ -9866,6 +12114,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
9866
12114
  'ticket.sla_summary.stage'?: SlaSummaryStage[];
9867
12115
  /** Filters for tickets with any of the provided source channels. */
9868
12116
  'ticket.source_channel'?: string[];
12117
+ /** Filters for tickets with any of the provided subtypes. */
12118
+ 'ticket.subtype'?: string[];
9869
12119
  /** Filters for work of the provided types. */
9870
12120
  type?: WorkType[];
9871
12121
  }, params?: RequestParams) => Promise<AxiosResponse<WorksExportResponse, any>>;
@@ -9942,6 +12192,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
9942
12192
  * @example ["REV-AbCdEfGh"]
9943
12193
  */
9944
12194
  'issue.rev_orgs'?: string[];
12195
+ /** Filters for issues with any of the provided subtypes. */
12196
+ 'issue.subtype'?: string[];
9945
12197
  /**
9946
12198
  * The maximum number of works to return. The default is '50'.
9947
12199
  * @format int32
@@ -9959,20 +12211,41 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
9959
12211
  'opportunity.account'?: string[];
9960
12212
  /** Filters for opportunities with any of the provided contacts. */
9961
12213
  'opportunity.contacts'?: string[];
12214
+ /** Filters for opportunity with any of the provided subtypes. */
12215
+ 'opportunity.subtype'?: string[];
9962
12216
  /**
9963
12217
  * Filters for work owned by any of these users.
9964
12218
  * @example ["DEVU-12345"]
9965
12219
  */
9966
12220
  owned_by?: string[];
12221
+ /**
12222
+ * Filters for work reported by any of these users.
12223
+ * @example ["DEVU-12345"]
12224
+ */
12225
+ reported_by?: string[];
9967
12226
  /** Fields to sort the works by and the direction to sort them. */
9968
12227
  sort_by?: string[];
9969
12228
  /** Filters for records in the provided stage(s) by name. */
9970
12229
  'stage.name'?: string[];
12230
+ /** Filters for issues that are staged. */
12231
+ 'staged_info.is_staged'?: boolean;
12232
+ /** Filters for works with selected sync statuses. */
12233
+ 'sync_metadata.last_sync_in.status'?: SyncMetadataFilterSyncInFilterStatus[];
12234
+ /** Filters for works modified with selected sync units. */
12235
+ 'sync_metadata.last_sync_in.sync_unit'?: string[];
12236
+ /** Filters for works with selected sync statuses. */
12237
+ 'sync_metadata.last_sync_out.status'?: SyncMetadataFilterSyncOutFilterStatus[];
12238
+ /** Filters for works modified with selected sync units. */
12239
+ 'sync_metadata.last_sync_out.sync_unit'?: string[];
12240
+ /** Filters for issues synced from this specific origin system. */
12241
+ 'sync_metadata.origin_system'?: string[];
9971
12242
  /**
9972
12243
  * Filters for work with any of the provided tags.
9973
12244
  * @example ["TAG-12345"]
9974
12245
  */
9975
12246
  tags?: string[];
12247
+ /** Filters for tickets with any of the provided channels. */
12248
+ 'ticket.channels'?: TicketChannels[];
9976
12249
  /** Filters for tickets belonging to specific groups. */
9977
12250
  'ticket.group'?: string[];
9978
12251
  /** Filters for tickets that are spam. */
@@ -9991,6 +12264,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
9991
12264
  'ticket.sla_summary.stage'?: SlaSummaryStage[];
9992
12265
  /** Filters for tickets with any of the provided source channels. */
9993
12266
  'ticket.source_channel'?: string[];
12267
+ /** Filters for tickets with any of the provided subtypes. */
12268
+ 'ticket.subtype'?: string[];
9994
12269
  /** Filters for work of the provided types. */
9995
12270
  type?: WorkType[];
9996
12271
  }, params?: RequestParams) => Promise<AxiosResponse<WorksListResponse, any>>;