@devrev/typescript-sdk 1.1.5 → 1.1.6

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.
@@ -80,6 +80,27 @@ export interface AccountsDeleteRequest {
80
80
  * The response to deleting an account.
81
81
  */
82
82
  export type AccountsDeleteResponse = object;
83
+ /**
84
+ * accounts-export-request
85
+ * The request to export a collection of accounts.
86
+ */
87
+ export interface AccountsExportRequest {
88
+ /** Filters for accounts created by the specified user(s). */
89
+ created_by?: string[];
90
+ created_date?: DateTimeFilter;
91
+ /** Array of references of accounts to be filtered. */
92
+ external_refs?: string[];
93
+ /**
94
+ * The number of accounts to return. The default is '50'.
95
+ * @format int32
96
+ * @min 1
97
+ * @max 500
98
+ */
99
+ first?: number;
100
+ modified_date?: DateTimeFilter;
101
+ /** Fields to sort the accounts by and the direction to sort them in. */
102
+ sort_by?: string[];
103
+ }
83
104
  /**
84
105
  * accounts-export-response
85
106
  * The response to exporting a collection of accounts.
@@ -88,6 +109,17 @@ export interface AccountsExportResponse {
88
109
  /** The exported accounts. */
89
110
  accounts: Account[];
90
111
  }
112
+ /**
113
+ * accounts-get-request
114
+ * Request object to get an account's information.
115
+ */
116
+ export interface AccountsGetRequest {
117
+ /**
118
+ * The ID of the account to be retrieved.
119
+ * @example "don:core:<partition>:devo/<dev-org-id>:account/<account-id>"
120
+ */
121
+ id: string;
122
+ }
91
123
  /**
92
124
  * accounts-get-response
93
125
  * The returned account.
@@ -95,6 +127,39 @@ export interface AccountsExportResponse {
95
127
  export interface AccountsGetResponse {
96
128
  account: Account;
97
129
  }
130
+ /**
131
+ * accounts-list-request
132
+ * List the accounts.
133
+ */
134
+ export interface AccountsListRequest {
135
+ /** Filters for accounts created by the specified user(s). */
136
+ created_by?: string[];
137
+ created_date?: DateTimeFilter;
138
+ /**
139
+ * The cursor to resume iteration from. If not provided, then
140
+ * iteration starts from the beginning.
141
+ */
142
+ cursor?: string;
143
+ /** Array of references of accounts to be filtered. */
144
+ external_refs?: string[];
145
+ /**
146
+ * The maximum number of accounts to return per page. The default is
147
+ * '50'.
148
+ * @format int32
149
+ */
150
+ limit?: number;
151
+ /**
152
+ * The iteration mode to use. If "after", then entries after the provided
153
+ * cursor will be returned, or if no cursor is provided, then from the
154
+ * beginning. If "before", then entries before the provided cursor will be
155
+ * returned, or if no cursor is provided, then from the end. Entries will
156
+ * always be returned in the specified sort-by order.
157
+ */
158
+ mode?: ListMode;
159
+ modified_date?: DateTimeFilter;
160
+ /** Fields to sort the accounts by and the direction to sort them in. */
161
+ sort_by?: string[];
162
+ }
98
163
  /**
99
164
  * accounts-list-response
100
165
  * The response to listing all accounts matching the filter criteria.
@@ -158,6 +223,15 @@ export interface AccountsUpdateResponse {
158
223
  * List of custom fields from multiple source fragments.
159
224
  */
160
225
  export type AggregatedSchema = object;
226
+ /** aggregated-schema-get-request */
227
+ export interface AggregatedSchemaGetRequest {
228
+ /** The list of custom schema fragment DONs which are to be aggregated. */
229
+ custom_schema_fragment_ids: string[];
230
+ /** Per object schema, if associated with the leaf type. */
231
+ per_object_schema?: FieldDescriptor[];
232
+ /** The stock schema fragment which is to be aggregated. */
233
+ stock_schema_fragment_id?: string;
234
+ }
161
235
  /** aggregated-schema-get-response */
162
236
  export interface AggregatedSchemaGetResponse {
163
237
  /** List of custom fields from multiple source fragments. */
@@ -295,11 +369,64 @@ export interface ConversationsDeleteRequest {
295
369
  * The response for deleting a conversation.
296
370
  */
297
371
  export type ConversationsDeleteResponse = object;
372
+ /** conversations-export-request */
373
+ export interface ConversationsExportRequest {
374
+ /**
375
+ * Filters for conversations belonging to any of the provided parts.
376
+ * @example ["don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"]
377
+ */
378
+ applies_to_parts?: string[];
379
+ /**
380
+ * The number of conversation items to return. The default is '50',
381
+ * the maximum is '5000'.
382
+ * @format int32
383
+ */
384
+ first?: number;
385
+ /** Filters for conversation that belong to the given groups. */
386
+ group?: string[];
387
+ /** Filters for conversations that are spam. */
388
+ is_spam?: boolean;
389
+ /**
390
+ * Filters for conversations where these users are participants.
391
+ * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
392
+ */
393
+ members?: string[];
394
+ /**
395
+ * Filters for conversations owned by any of these users.
396
+ * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
397
+ */
398
+ owned_by?: string[];
399
+ /**
400
+ * Filters for conversations that are associated with any of the
401
+ * provided Rev organizations.
402
+ * @example ["don:identity:<partition>:devo/<dev-org-id>:revo/<rev-org-id>"]
403
+ */
404
+ rev_org?: string[];
405
+ /** The filter for SLA summary. */
406
+ sla_summary?: SlaSummaryFilter;
407
+ /** Filters for conversations with any of the provided source channels. */
408
+ source_channels?: string[];
409
+ /** The filter for stages. */
410
+ stage?: StageFilter;
411
+ /**
412
+ * Filters for conversations with any of the provided tags.
413
+ * @example ["don:core:<partition>:devo/<dev-org-id>:tag/<tag-id>"]
414
+ */
415
+ tags?: string[];
416
+ }
298
417
  /** conversations-export-response */
299
418
  export interface ConversationsExportResponse {
300
419
  /** The resulting collection of conversation items. */
301
420
  conversations: Conversation[];
302
421
  }
422
+ /**
423
+ * conversations-get-request
424
+ * The request to get a conversation's information.
425
+ */
426
+ export interface ConversationsGetRequest {
427
+ /** The requested conversation's ID. */
428
+ id: string;
429
+ }
303
430
  /**
304
431
  * conversations-get-response
305
432
  * The response to getting a conversation's information.
@@ -307,6 +434,66 @@ export interface ConversationsExportResponse {
307
434
  export interface ConversationsGetResponse {
308
435
  conversation: Conversation;
309
436
  }
437
+ /**
438
+ * conversations-list-request
439
+ * The request to get information about a list of conversations.
440
+ */
441
+ export interface ConversationsListRequest {
442
+ /**
443
+ * Filters for conversations belonging to any of the provided parts.
444
+ * @example ["don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"]
445
+ */
446
+ applies_to_parts?: string[];
447
+ /**
448
+ * The cursor to resume iteration from. If not provided, then
449
+ * iteration starts from the beginning.
450
+ */
451
+ cursor?: string;
452
+ /** Filters for conversation that belong to the given groups. */
453
+ group?: string[];
454
+ /** Filters for conversations that are spam. */
455
+ is_spam?: boolean;
456
+ /**
457
+ * The maximum number of conversations to return. The default is '50'.
458
+ * @format int32
459
+ */
460
+ limit?: number;
461
+ /**
462
+ * Filters for conversations where these users are participants.
463
+ * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
464
+ */
465
+ members?: string[];
466
+ /**
467
+ * The iteration mode to use. If "after", then entries after the provided
468
+ * cursor will be returned, or if no cursor is provided, then from the
469
+ * beginning. If "before", then entries before the provided cursor will be
470
+ * returned, or if no cursor is provided, then from the end. Entries will
471
+ * always be returned in the specified sort-by order.
472
+ */
473
+ mode?: ListMode;
474
+ /**
475
+ * Filters for conversations owned by any of these users.
476
+ * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
477
+ */
478
+ owned_by?: string[];
479
+ /**
480
+ * Filters for conversations that are associated with any of the
481
+ * provided Rev organizations.
482
+ * @example ["don:identity:<partition>:devo/<dev-org-id>:revo/<rev-org-id>"]
483
+ */
484
+ rev_org?: string[];
485
+ /** The filter for SLA summary. */
486
+ sla_summary?: SlaSummaryFilter;
487
+ /** Filters for conversations with any of the provided source channels. */
488
+ source_channels?: string[];
489
+ /** The filter for stages. */
490
+ stage?: StageFilter;
491
+ /**
492
+ * Filters for conversations with any of the provided tags.
493
+ * @example ["don:core:<partition>:devo/<dev-org-id>:tag/<tag-id>"]
494
+ */
495
+ tags?: string[];
496
+ }
310
497
  /**
311
498
  * conversations-list-response
312
499
  * The response to listing the conversations.
@@ -428,10 +615,38 @@ export interface CustomSchemaFragment {
428
615
  */
429
616
  export type CustomSchemaFragmentCondition = object;
430
617
  export type CustomSchemaFragmentType = string;
618
+ /** custom-schema-fragments-get-request */
619
+ export interface CustomSchemaFragmentsGetRequest {
620
+ /** The ID of the custom schema fragment. */
621
+ id: string;
622
+ }
431
623
  /** custom-schema-fragments-get-response */
432
624
  export interface CustomSchemaFragmentsGetResponse {
433
625
  fragment: CustomSchemaFragment;
434
626
  }
627
+ /** custom-schema-fragments-list-request */
628
+ export interface CustomSchemaFragmentsListRequest {
629
+ /** The list of app names. */
630
+ app?: string[];
631
+ /**
632
+ * The cursor to resume iteration from, otherwise if not provided,
633
+ * then iteration starts from the beginning.
634
+ */
635
+ cursor?: string;
636
+ /** The list of leaf types. */
637
+ leaf_type?: string[];
638
+ /**
639
+ * The maximum number of items.
640
+ * @format int32
641
+ */
642
+ limit?: number;
643
+ /** The list of fields to sort the items by and how to sort them. */
644
+ sort_by?: string[];
645
+ /** The list of subtypes. */
646
+ subtype?: string[];
647
+ /** Filters for custom schema fragment of the provided types. */
648
+ types?: CustomSchemaFragmentType[];
649
+ }
435
650
  /** custom-schema-fragments-list-response */
436
651
  export interface CustomSchemaFragmentsListResponse {
437
652
  /**
@@ -488,6 +703,67 @@ export interface CustomSchemaFragmentsSetResponse {
488
703
  /** The ID of the custom schema fragment. */
489
704
  id: string;
490
705
  }
706
+ /**
707
+ * date-filter
708
+ * Provides ways to specify date ranges on objects.
709
+ */
710
+ export type DateFilter = (DateTimeFilter | DateTimePreset) & {
711
+ /** Type of date filter. */
712
+ type: DateFilterType;
713
+ };
714
+ /** Type of date filter. */
715
+ export declare enum DateFilterType {
716
+ Preset = "preset",
717
+ Range = "range"
718
+ }
719
+ /** date-time-filter */
720
+ export interface DateTimeFilter {
721
+ /**
722
+ * Filters for objects created after the provided timestamp
723
+ * (inclusive).
724
+ * @format date-time
725
+ */
726
+ after?: string;
727
+ /**
728
+ * Filters for objects created before the provided timestamp
729
+ * (inclusive).
730
+ * @format date-time
731
+ */
732
+ before?: string;
733
+ }
734
+ /**
735
+ * date-time-preset
736
+ * Provides preset types for date filter.
737
+ */
738
+ export type DateTimePreset = (DateTimePresetLastNDays | DateTimePresetNextNDays) & {
739
+ /** Type of date preset. */
740
+ preset_type: DateTimePresetType;
741
+ };
742
+ /** date-time-preset-last-n-days */
743
+ export interface DateTimePresetLastNDays {
744
+ /**
745
+ * The range starts from the current timestamp and continues for the
746
+ * past n days.
747
+ * @min 0
748
+ * @max 4294967295
749
+ */
750
+ days: number;
751
+ }
752
+ /** date-time-preset-next-n-days */
753
+ export interface DateTimePresetNextNDays {
754
+ /**
755
+ * The range starts from the current timestamp and continues for the
756
+ * next n days.
757
+ * @min 0
758
+ * @max 4294967295
759
+ */
760
+ days: number;
761
+ }
762
+ /** Type of date preset. */
763
+ export declare enum DateTimePresetType {
764
+ LastNDays = "last_n_days",
765
+ NextNDays = "next_n_days"
766
+ }
491
767
  /** dev-user-summary */
492
768
  export type DevUserSummary = UserBaseSummary;
493
769
  /** empty */
@@ -507,6 +783,23 @@ export declare enum EngagementType {
507
783
  Offline = "offline",
508
784
  Survey = "survey"
509
785
  }
786
+ /** engagements-count-request */
787
+ export interface EngagementsCountRequest {
788
+ /** Filters for meetings with the provided external_refs. */
789
+ external_ref?: string[];
790
+ /**
791
+ * Filters for engagement of the provided members.
792
+ * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
793
+ */
794
+ members?: string[];
795
+ /**
796
+ * Filters for engagements with the provided parent.
797
+ * @example ["don:core:<partition>:devo/<dev-org-id>:account/<account-id>"]
798
+ */
799
+ parent?: string[];
800
+ /** Filters for engagement of the provided types. */
801
+ type?: EngagementType[];
802
+ }
510
803
  /** engagements-count-response */
511
804
  export interface EngagementsCountResponse {
512
805
  /**
@@ -571,10 +864,52 @@ export interface EngagementsDeleteRequest {
571
864
  }
572
865
  /** engagements-delete-response */
573
866
  export type EngagementsDeleteResponse = object;
867
+ /** engagements-get-request */
868
+ export interface EngagementsGetRequest {
869
+ /** The engagement ID. */
870
+ id: string;
871
+ }
574
872
  /** engagements-get-response */
575
873
  export interface EngagementsGetResponse {
576
874
  engagement: Engagement;
577
875
  }
876
+ /** engagements-list-request */
877
+ export interface EngagementsListRequest {
878
+ /**
879
+ * The cursor to resume iteration from. If not provided, then
880
+ * iteration starts from the beginning.
881
+ */
882
+ cursor?: string;
883
+ /** Filters for meetings with the provided external_refs. */
884
+ external_ref?: string[];
885
+ /**
886
+ * The maximum number of engagements to return.
887
+ * @format int32
888
+ */
889
+ limit?: number;
890
+ /**
891
+ * Filters for engagement of the provided members.
892
+ * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
893
+ */
894
+ members?: string[];
895
+ /**
896
+ * The iteration mode to use. If "after", then entries after the provided
897
+ * cursor will be returned, or if no cursor is provided, then from the
898
+ * beginning. If "before", then entries before the provided cursor will be
899
+ * returned, or if no cursor is provided, then from the end. Entries will
900
+ * always be returned in the specified sort-by order.
901
+ */
902
+ mode?: ListMode;
903
+ /**
904
+ * Filters for engagements with the provided parent.
905
+ * @example ["don:core:<partition>:devo/<dev-org-id>:account/<account-id>"]
906
+ */
907
+ parent?: string[];
908
+ /** Fields to sort the engagements by and the direction to sort them. */
909
+ sort_by?: string[];
910
+ /** Filters for engagement of the provided types. */
911
+ type?: EngagementType[];
912
+ }
578
913
  /** engagements-list-response */
579
914
  export interface EngagementsListResponse {
580
915
  /** The list of engagements. */
@@ -813,6 +1148,11 @@ export interface EventSourcesScheduleEventResponse {
813
1148
  }
814
1149
  /** feature-summary */
815
1150
  export type FeatureSummary = PartBaseSummary;
1151
+ /**
1152
+ * field-descriptor
1153
+ * Set of field attributes.
1154
+ */
1155
+ export type FieldDescriptor = object;
816
1156
  /** group-summary */
817
1157
  export type GroupSummary = AtomBaseSummary;
818
1158
  /** issue */
@@ -926,6 +1266,14 @@ export declare enum LinksDirection {
926
1266
  IsSource = "is_source",
927
1267
  IsTarget = "is_target"
928
1268
  }
1269
+ /**
1270
+ * links-get-request
1271
+ * The request to get a link's information.
1272
+ */
1273
+ export interface LinksGetRequest {
1274
+ /** The requested link's ID. */
1275
+ id: string;
1276
+ }
929
1277
  /**
930
1278
  * links-get-response
931
1279
  * The response to getting a link's information.
@@ -933,6 +1281,50 @@ export declare enum LinksDirection {
933
1281
  export interface LinksGetResponse {
934
1282
  link: Link;
935
1283
  }
1284
+ /**
1285
+ * links-list-request
1286
+ * The request to get information about a list of links.
1287
+ */
1288
+ export interface LinksListRequest {
1289
+ /**
1290
+ * The cursor to resume iteration from. If not provided, then
1291
+ * iteration starts from the beginning.
1292
+ */
1293
+ cursor?: string;
1294
+ /**
1295
+ * The direction of link, which can either be outbound such that the
1296
+ * object is the source of the link, otherwise inbound where the object is
1297
+ * the target of the link.
1298
+ */
1299
+ direction?: LinksDirection;
1300
+ /**
1301
+ * The maximum number of links to return. If not set, then the default
1302
+ * is '50'.
1303
+ * @format int32
1304
+ */
1305
+ limit?: number;
1306
+ /**
1307
+ * The link type(s) to filter for, otherwise if not present, all link
1308
+ * types are included.
1309
+ */
1310
+ link_type?: LinkType[];
1311
+ /**
1312
+ * The iteration mode to use. If "after", then entries after the provided
1313
+ * cursor will be returned, or if no cursor is provided, then from the
1314
+ * beginning. If "before", then entries before the provided cursor will be
1315
+ * returned, or if no cursor is provided, then from the end. Entries will
1316
+ * always be returned in the specified sort-by order.
1317
+ */
1318
+ mode?: ListMode;
1319
+ /** The ID of the object to list the links for. */
1320
+ object: string;
1321
+ /**
1322
+ * The link types to filter for, otherwise if not present, all link
1323
+ * types are included.
1324
+ * @deprecated
1325
+ */
1326
+ types?: LinkType[];
1327
+ }
936
1328
  /**
937
1329
  * links-list-response
938
1330
  * The response to listing the links.
@@ -981,6 +1373,31 @@ export declare enum MetricDefinitionMetricType {
981
1373
  Time = "time",
982
1374
  Value = "value"
983
1375
  }
1376
+ /** metric-definitions-list-request */
1377
+ export interface MetricDefinitionsListRequest {
1378
+ /** The type of objects the metric definition applies to. */
1379
+ applies_to_type?: MetricDefinitionAppliesTo[];
1380
+ /**
1381
+ * The cursor to resume iteration from. If not provided, then
1382
+ * iteration starts from the beginning.
1383
+ */
1384
+ cursor?: string;
1385
+ /**
1386
+ * The maximum number of records to return. The default is '50'.
1387
+ * @format int32
1388
+ */
1389
+ limit?: number;
1390
+ /**
1391
+ * The iteration mode to use. If "after", then entries after the provided
1392
+ * cursor will be returned, or if no cursor is provided, then from the
1393
+ * beginning. If "before", then entries before the provided cursor will be
1394
+ * returned, or if no cursor is provided, then from the end. Entries will
1395
+ * always be returned in the specified sort-by order.
1396
+ */
1397
+ mode?: ListMode;
1398
+ /** The type of metric definitions sought. */
1399
+ type?: MetricDefinitionMetricType[];
1400
+ }
984
1401
  /** metric-definitions-list-response */
985
1402
  export interface MetricDefinitionsListResponse {
986
1403
  /** The list of metric definitions. */
@@ -1159,6 +1576,11 @@ export interface OrgScheduleFragmentsCreateRequest {
1159
1576
  export interface OrgScheduleFragmentsCreateResponse {
1160
1577
  org_schedule_fragment: OrgScheduleFragment;
1161
1578
  }
1579
+ /** org-schedule-fragments-get-request */
1580
+ export interface OrgScheduleFragmentsGetRequest {
1581
+ /** Organization schedule Fragment ID. */
1582
+ id: string;
1583
+ }
1162
1584
  /** org-schedule-fragments-get-response */
1163
1585
  export interface OrgScheduleFragmentsGetResponse {
1164
1586
  org_schedule_fragment: OrgScheduleFragment;
@@ -1223,10 +1645,43 @@ export interface OrgSchedulesCreateRequest {
1223
1645
  export interface OrgSchedulesCreateResponse {
1224
1646
  org_schedule: OrgSchedule;
1225
1647
  }
1648
+ /** org-schedules-get-request */
1649
+ export interface OrgSchedulesGetRequest {
1650
+ /** Organization schedule ID. */
1651
+ id: string;
1652
+ }
1226
1653
  /** org-schedules-get-response */
1227
1654
  export interface OrgSchedulesGetResponse {
1228
1655
  org_schedule: OrgSchedule;
1229
1656
  }
1657
+ /** org-schedules-list-request */
1658
+ export interface OrgSchedulesListRequest {
1659
+ /** Creator ID the filter matches. */
1660
+ created_by_id?: string[];
1661
+ /**
1662
+ * The cursor to resume iteration from. If not provided, then
1663
+ * iteration starts from the beginning.
1664
+ */
1665
+ cursor?: string;
1666
+ /**
1667
+ * Max number of organization schedules returned in a page. Default is
1668
+ * 50.
1669
+ * @format int32
1670
+ */
1671
+ limit?: number;
1672
+ /**
1673
+ * The iteration mode to use. If "after", then entries after the provided
1674
+ * cursor will be returned, or if no cursor is provided, then from the
1675
+ * beginning. If "before", then entries before the provided cursor will be
1676
+ * returned, or if no cursor is provided, then from the end. Entries will
1677
+ * always be returned in the specified sort-by order.
1678
+ */
1679
+ mode?: ListMode;
1680
+ /** The organization schedule statuses the filter matches. */
1681
+ status?: OrgScheduleStatus[];
1682
+ /** Provides ways to specify date ranges on objects. */
1683
+ valid_until?: DateFilter;
1684
+ }
1230
1685
  /** org-schedules-list-response */
1231
1686
  export interface OrgSchedulesListResponse {
1232
1687
  /**
@@ -1390,6 +1845,17 @@ export interface RevOrgsCreateRequest {
1390
1845
  export interface RevOrgsCreateResponse {
1391
1846
  rev_org: RevOrg;
1392
1847
  }
1848
+ /**
1849
+ * rev-orgs-get-request
1850
+ * Request object to get Rev organization's information.
1851
+ */
1852
+ export interface RevOrgsGetRequest {
1853
+ /**
1854
+ * The ID of the required Rev organization.
1855
+ * @example "don:identity:<partition>:devo/<dev-org-id>:revo/<rev-org-id>"
1856
+ */
1857
+ id: string;
1858
+ }
1393
1859
  /**
1394
1860
  * rev-orgs-get-response
1395
1861
  * The response to getting a Rev organization's information.
@@ -1397,6 +1863,47 @@ export interface RevOrgsCreateResponse {
1397
1863
  export interface RevOrgsGetResponse {
1398
1864
  rev_org: RevOrg;
1399
1865
  }
1866
+ /**
1867
+ * rev-orgs-list-request
1868
+ * A request to get the list of Rev organizations for the authenticated
1869
+ * user's Dev organization.
1870
+ */
1871
+ export interface RevOrgsListRequest {
1872
+ /** Filters by creator. */
1873
+ created_by?: string[];
1874
+ created_date?: DateTimeFilter;
1875
+ /**
1876
+ * The cursor to resume iteration from. If not provided, then
1877
+ * iteration starts from the beginning.
1878
+ */
1879
+ cursor?: string;
1880
+ /**
1881
+ * Filters on custom fields. Input will be of the format
1882
+ * (custom_field_filter=field_name1:val1,val2,val3&custom_field_filter=field_name2:val1,val2).
1883
+ */
1884
+ custom_field_filter?: string[];
1885
+ /** List of external refs to filter Rev organizations for. */
1886
+ external_ref?: string[];
1887
+ /**
1888
+ * The maximum number of Rev organizations to be retrieved per page.
1889
+ * @format int32
1890
+ */
1891
+ limit?: number;
1892
+ /**
1893
+ * The iteration mode to use. If "after", then entries after the provided
1894
+ * cursor will be returned, or if no cursor is provided, then from the
1895
+ * beginning. If "before", then entries before the provided cursor will be
1896
+ * returned, or if no cursor is provided, then from the end. Entries will
1897
+ * always be returned in the specified sort-by order.
1898
+ */
1899
+ mode?: ListMode;
1900
+ modified_date?: DateTimeFilter;
1901
+ /**
1902
+ * Fields to sort the Rev organizations by and the direction to sort
1903
+ * them.
1904
+ */
1905
+ sort_by?: string[];
1906
+ }
1400
1907
  /**
1401
1908
  * rev-orgs-list-response
1402
1909
  * The response to getting a list of Rev organizations' information.
@@ -1546,6 +2053,14 @@ export interface RevUsersDeleteRequest {
1546
2053
  * The response to deleting a Rev user of a Rev organization.
1547
2054
  */
1548
2055
  export type RevUsersDeleteResponse = object;
2056
+ /**
2057
+ * rev-users-get-request
2058
+ * Request object to get a Rev user.
2059
+ */
2060
+ export interface RevUsersGetRequest {
2061
+ /** The ID of Rev user to be retrieved. */
2062
+ id: string;
2063
+ }
1549
2064
  /**
1550
2065
  * rev-users-get-response
1551
2066
  * The returned Rev user.
@@ -1553,6 +2068,48 @@ export type RevUsersDeleteResponse = object;
1553
2068
  export interface RevUsersGetResponse {
1554
2069
  rev_user: RevUser;
1555
2070
  }
2071
+ /**
2072
+ * rev-users-list-request
2073
+ * Gets the list of Rev users belonging to the authenticated user's Dev
2074
+ * Organization which the user is also authorized to access.
2075
+ */
2076
+ export interface RevUsersListRequest {
2077
+ /** Filters for Rev users that were created by the specified user(s). */
2078
+ created_by?: string[];
2079
+ created_date?: DateTimeFilter;
2080
+ /**
2081
+ * The cursor to resume iteration from. If not provided, then
2082
+ * iteration starts from the beginning.
2083
+ */
2084
+ cursor?: string;
2085
+ /** List of emails of Rev users to be filtered. */
2086
+ email?: string[];
2087
+ /** List of external refs to filter Rev users for. */
2088
+ external_ref?: string[];
2089
+ /**
2090
+ * The maximum number of Rev users to return. The default is '50'.
2091
+ * @format int32
2092
+ */
2093
+ limit?: number;
2094
+ /**
2095
+ * The iteration mode to use. If "after", then entries after the provided
2096
+ * cursor will be returned, or if no cursor is provided, then from the
2097
+ * beginning. If "before", then entries before the provided cursor will be
2098
+ * returned, or if no cursor is provided, then from the end. Entries will
2099
+ * always be returned in the specified sort-by order.
2100
+ */
2101
+ mode?: ListMode;
2102
+ modified_date?: DateTimeFilter;
2103
+ /** List of phone numbers to filter Rev users on. */
2104
+ phone_numbers?: string[];
2105
+ /**
2106
+ * List of IDs of Rev organizations to be filtered.
2107
+ * @example ["don:identity:<partition>:devo/<dev-org-id>:revo/<rev-org-id>"]
2108
+ */
2109
+ rev_org?: string[];
2110
+ /** Fields to sort the Rev users by and the direction to sort them. */
2111
+ sort_by?: string[];
2112
+ }
1556
2113
  /**
1557
2114
  * rev-users-list-response
1558
2115
  * The response to listing all Rev users matching the filter criteria.
@@ -1990,6 +2547,26 @@ export type SchemaTokensListFieldDescriptor = SchemaFieldDescriptorBase & {
1990
2547
  /** The string suffix. */
1991
2548
  suffix?: string;
1992
2549
  };
2550
+ /** service-account */
2551
+ export type ServiceAccount = UserBase;
2552
+ /** service-account-summary */
2553
+ export type ServiceAccountSummary = UserBaseSummary;
2554
+ /**
2555
+ * service-accounts-get-request
2556
+ * The request object to get a service account's information.
2557
+ */
2558
+ export interface ServiceAccountsGetRequest {
2559
+ /** The ID of the requested service account. */
2560
+ id: string;
2561
+ }
2562
+ /**
2563
+ * service-accounts-get-response
2564
+ * The response object that carries the service account's information
2565
+ * corresponding to the request.
2566
+ */
2567
+ export interface ServiceAccountsGetResponse {
2568
+ service_account: ServiceAccount;
2569
+ }
1993
2570
  /** set-org-schedule-fragment-summary */
1994
2571
  export interface SetOrgScheduleFragmentSummary {
1995
2572
  /** Organization schedule fragment ID. */
@@ -2178,6 +2755,11 @@ export declare enum SlaStatus {
2178
2755
  Draft = "draft",
2179
2756
  Published = "published"
2180
2757
  }
2758
+ /**
2759
+ * sla-summary-filter
2760
+ * The filter for SLA summary.
2761
+ */
2762
+ export type SlaSummaryFilter = object;
2181
2763
  /** slas-assign-request */
2182
2764
  export interface SlasAssignRequest {
2183
2765
  /**
@@ -2222,10 +2804,38 @@ export interface SlasCreateRequest {
2222
2804
  export interface SlasCreateResponse {
2223
2805
  sla: Sla;
2224
2806
  }
2807
+ /** slas-get-request */
2808
+ export interface SlasGetRequest {
2809
+ /** The ID of the SLA to get. */
2810
+ id: string;
2811
+ }
2225
2812
  /** slas-get-response */
2226
2813
  export interface SlasGetResponse {
2227
2814
  sla: Sla;
2228
2815
  }
2816
+ /** slas-list-request */
2817
+ export interface SlasListRequest {
2818
+ /**
2819
+ * The cursor to resume iteration from. If not provided, then
2820
+ * iteration starts from the beginning.
2821
+ */
2822
+ cursor?: string;
2823
+ /**
2824
+ * The maximum number of SLAs to return. The default is '50'.
2825
+ * @format int32
2826
+ */
2827
+ limit?: number;
2828
+ /**
2829
+ * The iteration mode to use. If "after", then entries after the provided
2830
+ * cursor will be returned, or if no cursor is provided, then from the
2831
+ * beginning. If "before", then entries before the provided cursor will be
2832
+ * returned, or if no cursor is provided, then from the end. Entries will
2833
+ * always be returned in the specified sort-by order.
2834
+ */
2835
+ mode?: ListMode;
2836
+ /** The SLA statuses the filter matches. */
2837
+ status?: SlaStatus[];
2838
+ }
2229
2839
  /** slas-list-response */
2230
2840
  export interface SlasListResponse {
2231
2841
  /**
@@ -2292,6 +2902,14 @@ export interface Stage {
2292
2902
  /** Current stage name of the work item. */
2293
2903
  name: string;
2294
2904
  }
2905
+ /**
2906
+ * stage-filter
2907
+ * The filter for stages.
2908
+ */
2909
+ export interface StageFilter {
2910
+ /** Filters for records in the provided stage(s). */
2911
+ name?: string[];
2912
+ }
2295
2913
  /**
2296
2914
  * stage-init
2297
2915
  * Sets an object's initial stage.
@@ -2324,15 +2942,57 @@ export interface Subtype {
2324
2942
  /** Value of the subtype. */
2325
2943
  value: string;
2326
2944
  }
2327
- /** subtypes-list-response */
2945
+ /** subtypes-list-request */
2946
+ export interface SubtypesListRequest {
2947
+ /**
2948
+ * Leaf type for which subtypes are required.
2949
+ * @deprecated
2950
+ */
2951
+ leaf_type?: string;
2952
+ /** List of leaf types for which subtypes are required. */
2953
+ leaf_types?: string[];
2954
+ }
2955
+ /** subtypes-list-response */
2328
2956
  export interface SubtypesListResponse {
2329
2957
  /** List of subtypes. */
2330
2958
  subtypes: Subtype[];
2331
2959
  }
2960
+ /**
2961
+ * survey-aggregation-filter
2962
+ * The filter for survey aggregation.
2963
+ */
2964
+ export type SurveyAggregationFilter = object;
2332
2965
  /** sys-user */
2333
2966
  export type SysUser = UserBase;
2334
2967
  /** sys-user-summary */
2335
2968
  export type SysUserSummary = UserBaseSummary;
2969
+ /**
2970
+ * sys-users-list-request
2971
+ * A request to get the list of system user's information.
2972
+ */
2973
+ export interface SysUsersListRequest {
2974
+ /**
2975
+ * The cursor to resume iteration from. If not provided, then
2976
+ * iteration starts from the beginning.
2977
+ */
2978
+ cursor?: string;
2979
+ /**
2980
+ * The maximum number of system users to return. Value can range from
2981
+ * '1' to '100', with a default of '50'.
2982
+ * @format int32
2983
+ */
2984
+ limit?: number;
2985
+ /**
2986
+ * The iteration mode to use. If "after", then entries after the provided
2987
+ * cursor will be returned, or if no cursor is provided, then from the
2988
+ * beginning. If "before", then entries before the provided cursor will be
2989
+ * returned, or if no cursor is provided, then from the end. Entries will
2990
+ * always be returned in the specified sort-by order.
2991
+ */
2992
+ mode?: ListMode;
2993
+ /** Fields to sort the system users by and the direction to sort them. */
2994
+ sort_by?: string[];
2995
+ }
2336
2996
  /**
2337
2997
  * sys-users-list-response
2338
2998
  * The response to listing the system users.
@@ -2508,6 +3168,47 @@ export declare enum TimelineEntriesCreateRequestType {
2508
3168
  export interface TimelineEntriesCreateResponse {
2509
3169
  timeline_entry: TimelineEntry;
2510
3170
  }
3171
+ /**
3172
+ * timeline-entries-list-request
3173
+ * The request to list timeline entries for an object.
3174
+ */
3175
+ export interface TimelineEntriesListRequest {
3176
+ /**
3177
+ * The collection(s) to list entries from, otherwise if not provided,
3178
+ * all entries are returned.
3179
+ */
3180
+ collections?: TimelineEntriesCollection[];
3181
+ /**
3182
+ * The cursor to resume iteration from. If not provided, then
3183
+ * iteration starts from the beginning.
3184
+ */
3185
+ cursor?: string;
3186
+ /**
3187
+ * The maximum number of entries to return. If not set, then this
3188
+ * defaults to `50`.
3189
+ * @format int32
3190
+ */
3191
+ limit?: number;
3192
+ /**
3193
+ * The iteration mode to use. If "after", then entries after the provided
3194
+ * cursor will be returned, or if no cursor is provided, then from the
3195
+ * beginning. If "before", then entries before the provided cursor will be
3196
+ * returned, or if no cursor is provided, then from the end. Entries will
3197
+ * always be returned in the specified sort-by order.
3198
+ */
3199
+ mode?: ListMode;
3200
+ /**
3201
+ * The ID of the object to list timeline entries for.
3202
+ * @example "don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"
3203
+ */
3204
+ object: string;
3205
+ /**
3206
+ * The visibility of the timeline entries to filter for. Note this is
3207
+ * a strict filter, such that only entries with the exact visibilities
3208
+ * specified will be returned.
3209
+ */
3210
+ visibility?: TimelineEntryVisibility[];
3211
+ }
2511
3212
  /**
2512
3213
  * timeline-entries-list-response
2513
3214
  * The response to listing timeline entries for an object.
@@ -2536,6 +3237,18 @@ export type TimelineEntryBase = AtomBase & {
2536
3237
  object: string;
2537
3238
  /** The type of object that the Timeline entry belongs to. */
2538
3239
  object_type?: TimelineEntryObjectType;
3240
+ /** The reactions to the entry. */
3241
+ reactions?: TimelineReaction[];
3242
+ /** Thread. */
3243
+ thread?: TimelineThread;
3244
+ /**
3245
+ * The visibility of the entry. If 'private', then the entry is only
3246
+ * visible to the creator, 'internal' is visible with the Dev
3247
+ * organization, 'external' is visible to the Dev organzation and Rev
3248
+ * users, and 'public' is visible to all. If not set, then the default
3249
+ * visibility is 'external'.
3250
+ */
3251
+ visibility?: TimelineEntryVisibility;
2539
3252
  };
2540
3253
  /** The type of object that the Timeline entry belongs to. */
2541
3254
  export declare enum TimelineEntryObjectType {
@@ -2569,6 +3282,21 @@ export declare enum TimelineEntryVisibility {
2569
3282
  Private = "private",
2570
3283
  Public = "public"
2571
3284
  }
3285
+ /**
3286
+ * timeline-reaction
3287
+ * Reaction.
3288
+ */
3289
+ export interface TimelineReaction {
3290
+ /** The reaction emoji's unicode codepoint, e.g. "1f44d". */
3291
+ emoji?: string;
3292
+ /** Whether the requesting user reacted. */
3293
+ reacted?: boolean;
3294
+ /**
3295
+ * The total number of users with this reaction.
3296
+ * @format int32
3297
+ */
3298
+ total_users?: number;
3299
+ }
2572
3300
  /**
2573
3301
  * timeline-snap-kit-body
2574
3302
  * Snap Kit Body of the comment.
@@ -2586,6 +3314,17 @@ export interface TimelineSnapKitBody {
2586
3314
  /** ID of the snap-in which created the SnapKit. */
2587
3315
  snap_in_id?: string;
2588
3316
  }
3317
+ /**
3318
+ * timeline-thread
3319
+ * Thread.
3320
+ */
3321
+ export interface TimelineThread {
3322
+ /**
3323
+ * The total number of replies in the thread.
3324
+ * @format int32
3325
+ */
3326
+ total_replies?: number;
3327
+ }
2589
3328
  /**
2590
3329
  * unlink-rev-user-from-rev-org-request
2591
3330
  * A request to unlink a rev user from a rev org.
@@ -2641,12 +3380,13 @@ export declare enum UserState {
2641
3380
  Unassigned = "unassigned"
2642
3381
  }
2643
3382
  /** user-summary */
2644
- export type UserSummary = (DevUserSummary | RevUserSummary | SysUserSummary) & {
3383
+ export type UserSummary = (DevUserSummary | RevUserSummary | ServiceAccountSummary | SysUserSummary) & {
2645
3384
  type: UserType;
2646
3385
  };
2647
3386
  export declare enum UserType {
2648
3387
  DevUser = "dev_user",
2649
3388
  RevUser = "rev_user",
3389
+ ServiceAccount = "service_account",
2650
3390
  SysUser = "sys_user"
2651
3391
  }
2652
3392
  /**
@@ -2828,15 +3568,165 @@ export interface WorksDeleteRequest {
2828
3568
  }
2829
3569
  /** works-delete-response */
2830
3570
  export type WorksDeleteResponse = object;
3571
+ /** works-export-request */
3572
+ export interface WorksExportRequest {
3573
+ /** Provides ways to specify date ranges on objects. */
3574
+ actual_close_date?: DateFilter;
3575
+ /**
3576
+ * Filters for work belonging to any of the provided parts.
3577
+ * @example ["don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"]
3578
+ */
3579
+ applies_to_part?: string[];
3580
+ /**
3581
+ * Filters for work created by any of these users.
3582
+ * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
3583
+ */
3584
+ created_by?: string[];
3585
+ /** Provides ways to specify date ranges on objects. */
3586
+ created_date?: DateFilter;
3587
+ /** Filters for custom fields. */
3588
+ custom_fields?: object;
3589
+ /**
3590
+ * The number of work items to return. The default is '50', the
3591
+ * maximum is '5000'.
3592
+ * @format int32
3593
+ */
3594
+ first?: number;
3595
+ issue?: WorksFilterIssue;
3596
+ /** Provides ways to specify date ranges on objects. */
3597
+ modified_date?: DateFilter;
3598
+ opportunity?: WorksFilterOpportunity;
3599
+ /**
3600
+ * Filters for work owned by any of these users.
3601
+ * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
3602
+ */
3603
+ owned_by?: string[];
3604
+ /** Fields to sort the work items by and the direction to sort them. */
3605
+ sort_by?: string[];
3606
+ /** The filter for stages. */
3607
+ stage?: StageFilter;
3608
+ /** Provides ways to specify date ranges on objects. */
3609
+ target_close_date?: DateFilter;
3610
+ ticket?: WorksFilterTicket;
3611
+ /** Filters for work of the provided types. */
3612
+ type?: WorkType[];
3613
+ }
2831
3614
  /** works-export-response */
2832
3615
  export interface WorksExportResponse {
2833
3616
  /** The resulting collection of work items. */
2834
3617
  works: Work[];
2835
3618
  }
3619
+ /** works-filter-issue */
3620
+ export interface WorksFilterIssue {
3621
+ /** Filters for issues with any of the provided priorities. */
3622
+ priority?: IssuePriority[];
3623
+ /**
3624
+ * Filters for issues with any of the provided Rev organizations.
3625
+ * @example ["don:identity:<partition>:devo/<dev-org-id>:revo/<rev-org-id>"]
3626
+ */
3627
+ rev_orgs?: string[];
3628
+ }
3629
+ /** works-filter-opportunity */
3630
+ export interface WorksFilterOpportunity {
3631
+ /**
3632
+ * Filters for opportunities belonging to any of the provided
3633
+ * accounts.
3634
+ * @example ["don:core:<partition>:devo/<dev-org-id>:account/<account-id>"]
3635
+ */
3636
+ account?: string[];
3637
+ /** Filters for opportunities with any of the provided contacts. */
3638
+ contacts?: string[];
3639
+ }
3640
+ /** works-filter-ticket */
3641
+ export interface WorksFilterTicket {
3642
+ /** Filters for tickets belonging to specific groups. */
3643
+ group?: string[];
3644
+ /** Filters for tickets that are spam. */
3645
+ is_spam?: boolean;
3646
+ /** Filters for tickets that need response. */
3647
+ needs_response?: boolean;
3648
+ /**
3649
+ * Filters for tickets that are associated with any of the provided
3650
+ * Rev organizations.
3651
+ * @example ["don:identity:<partition>:devo/<dev-org-id>:revo/<rev-org-id>"]
3652
+ */
3653
+ rev_org?: string[];
3654
+ /** Filters for tickets with any of the provided severities. */
3655
+ severity?: TicketSeverity[];
3656
+ /** The filter for SLA summary. */
3657
+ sla_summary?: SlaSummaryFilter;
3658
+ /** Filters for tickets with any of the provided source channels. */
3659
+ source_channel?: string[];
3660
+ /** The filter for survey aggregation. */
3661
+ surveys?: SurveyAggregationFilter;
3662
+ }
3663
+ /** works-get-request */
3664
+ export interface WorksGetRequest {
3665
+ /**
3666
+ * The work's ID.
3667
+ * @example "don:core:<partition>:devo/<dev-org-id>:<work-type>/<work-id>"
3668
+ */
3669
+ id: string;
3670
+ }
2836
3671
  /** works-get-response */
2837
3672
  export interface WorksGetResponse {
2838
3673
  work: Work;
2839
3674
  }
3675
+ /** works-list-request */
3676
+ export interface WorksListRequest {
3677
+ /** Provides ways to specify date ranges on objects. */
3678
+ actual_close_date?: DateFilter;
3679
+ /**
3680
+ * Filters for work belonging to any of the provided parts.
3681
+ * @example ["don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"]
3682
+ */
3683
+ applies_to_part?: string[];
3684
+ /**
3685
+ * Filters for work created by any of these users.
3686
+ * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
3687
+ */
3688
+ created_by?: string[];
3689
+ /** Provides ways to specify date ranges on objects. */
3690
+ created_date?: DateFilter;
3691
+ /**
3692
+ * The cursor to resume iteration from. If not provided, then
3693
+ * iteration starts from the beginning.
3694
+ */
3695
+ cursor?: string;
3696
+ /** Filters for custom fields. */
3697
+ custom_fields?: object;
3698
+ issue?: WorksFilterIssue;
3699
+ /**
3700
+ * The maximum number of works to return. The default is '50'.
3701
+ * @format int32
3702
+ */
3703
+ limit?: number;
3704
+ /**
3705
+ * The iteration mode to use. If "after", then entries after the provided
3706
+ * cursor will be returned, or if no cursor is provided, then from the
3707
+ * beginning. If "before", then entries before the provided cursor will be
3708
+ * returned, or if no cursor is provided, then from the end. Entries will
3709
+ * always be returned in the specified sort-by order.
3710
+ */
3711
+ mode?: ListMode;
3712
+ /** Provides ways to specify date ranges on objects. */
3713
+ modified_date?: DateFilter;
3714
+ opportunity?: WorksFilterOpportunity;
3715
+ /**
3716
+ * Filters for work owned by any of these users.
3717
+ * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
3718
+ */
3719
+ owned_by?: string[];
3720
+ /** Fields to sort the works by and the direction to sort them. */
3721
+ sort_by?: string[];
3722
+ /** The filter for stages. */
3723
+ stage?: StageFilter;
3724
+ /** Provides ways to specify date ranges on objects. */
3725
+ target_close_date?: DateFilter;
3726
+ ticket?: WorksFilterTicket;
3727
+ /** Filters for work of the provided types. */
3728
+ type?: WorkType[];
3729
+ }
2840
3730
  /** works-list-response */
2841
3731
  export interface WorksListResponse {
2842
3732
  /**
@@ -3097,6 +3987,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
3097
3987
  /** Fields to sort the accounts by and the direction to sort them in. */
3098
3988
  sort_by?: string[];
3099
3989
  }, params?: RequestParams) => Promise<AxiosResponse<AccountsExportResponse, any>>;
3990
+ /**
3991
+ * @description Exports a collection of accounts.
3992
+ *
3993
+ * @tags accounts
3994
+ * @name AccountsExportPost
3995
+ * @request POST:/accounts.export
3996
+ * @secure
3997
+ */
3998
+ accountsExportPost: (data: AccountsExportRequest, params?: RequestParams) => Promise<AxiosResponse<AccountsExportResponse, any>>;
3100
3999
  /**
3101
4000
  * @description Retrieves an account's information.
3102
4001
  *
@@ -3112,6 +4011,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
3112
4011
  */
3113
4012
  id: string;
3114
4013
  }, params?: RequestParams) => Promise<AxiosResponse<AccountsGetResponse, any>>;
4014
+ /**
4015
+ * @description Retrieves an account's information.
4016
+ *
4017
+ * @tags accounts
4018
+ * @name AccountsGetPost
4019
+ * @request POST:/accounts.get
4020
+ * @secure
4021
+ */
4022
+ accountsGetPost: (data: AccountsGetRequest, params?: RequestParams) => Promise<AxiosResponse<AccountsGetResponse, any>>;
3115
4023
  /**
3116
4024
  * @description Gets a list of accounts.
3117
4025
  *
@@ -3166,6 +4074,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
3166
4074
  /** Fields to sort the accounts by and the direction to sort them in. */
3167
4075
  sort_by?: string[];
3168
4076
  }, params?: RequestParams) => Promise<AxiosResponse<AccountsListResponse, any>>;
4077
+ /**
4078
+ * @description Gets a list of accounts.
4079
+ *
4080
+ * @tags accounts
4081
+ * @name AccountsListPost
4082
+ * @request POST:/accounts.list
4083
+ * @secure
4084
+ */
4085
+ accountsListPost: (data: AccountsListRequest, params?: RequestParams) => Promise<AxiosResponse<AccountsListResponse, any>>;
3169
4086
  /**
3170
4087
  * @description Updates an account's information.
3171
4088
  *
@@ -3243,6 +4160,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
3243
4160
  */
3244
4161
  tags?: string[];
3245
4162
  }, params?: RequestParams) => Promise<AxiosResponse<ConversationsExportResponse, any>>;
4163
+ /**
4164
+ * @description Exports a collection of conversation items.
4165
+ *
4166
+ * @tags conversations
4167
+ * @name ConversationsExportPost
4168
+ * @request POST:/conversations.export
4169
+ * @secure
4170
+ */
4171
+ conversationsExportPost: (data: ConversationsExportRequest, params?: RequestParams) => Promise<AxiosResponse<ConversationsExportResponse, any>>;
3246
4172
  /**
3247
4173
  * @description Gets the requested conversation's information.
3248
4174
  *
@@ -3255,6 +4181,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
3255
4181
  /** The requested conversation's ID. */
3256
4182
  id: string;
3257
4183
  }, params?: RequestParams) => Promise<AxiosResponse<ConversationsGetResponse, any>>;
4184
+ /**
4185
+ * @description Gets the requested conversation's information.
4186
+ *
4187
+ * @tags conversations
4188
+ * @name ConversationsGetPost
4189
+ * @request POST:/conversations.get
4190
+ * @secure
4191
+ */
4192
+ conversationsGetPost: (data: ConversationsGetRequest, params?: RequestParams) => Promise<AxiosResponse<ConversationsGetResponse, any>>;
3258
4193
  /**
3259
4194
  * @description Lists the available conversations.
3260
4195
  *
@@ -3314,6 +4249,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
3314
4249
  */
3315
4250
  tags?: string[];
3316
4251
  }, params?: RequestParams) => Promise<AxiosResponse<ConversationsListResponse, any>>;
4252
+ /**
4253
+ * @description Lists the available conversations.
4254
+ *
4255
+ * @tags conversations
4256
+ * @name ConversationsListPost
4257
+ * @request POST:/conversations.list
4258
+ * @secure
4259
+ */
4260
+ conversationsListPost: (data: ConversationsListRequest, params?: RequestParams) => Promise<AxiosResponse<ConversationsListResponse, any>>;
3317
4261
  /**
3318
4262
  * @description Updates the requested conversation.
3319
4263
  *
@@ -3347,6 +4291,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
3347
4291
  /** Filters for engagement of the provided types. */
3348
4292
  type?: EngagementType[];
3349
4293
  }, params?: RequestParams) => Promise<AxiosResponse<EngagementsCountResponse, any>>;
4294
+ /**
4295
+ * @description Counts the engagement records.
4296
+ *
4297
+ * @tags engagements
4298
+ * @name EngagementsCountPost
4299
+ * @request POST:/engagements.count
4300
+ * @secure
4301
+ */
4302
+ engagementsCountPost: (data: EngagementsCountRequest, params?: RequestParams) => Promise<AxiosResponse<EngagementsCountResponse, any>>;
3350
4303
  /**
3351
4304
  * @description Creates a new engagement record.
3352
4305
  *
@@ -3377,6 +4330,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
3377
4330
  /** The engagement ID. */
3378
4331
  id: string;
3379
4332
  }, params?: RequestParams) => Promise<AxiosResponse<EngagementsGetResponse, any>>;
4333
+ /**
4334
+ * @description Gets the engagement record.
4335
+ *
4336
+ * @tags engagements
4337
+ * @name EngagementsGetPost
4338
+ * @request POST:/engagements.get
4339
+ * @secure
4340
+ */
4341
+ engagementsGetPost: (data: EngagementsGetRequest, params?: RequestParams) => Promise<AxiosResponse<EngagementsGetResponse, any>>;
3380
4342
  /**
3381
4343
  * @description Lists the engagement records.
3382
4344
  *
@@ -3418,6 +4380,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
3418
4380
  /** Filters for engagement of the provided types. */
3419
4381
  type?: EngagementType[];
3420
4382
  }, params?: RequestParams) => Promise<AxiosResponse<EngagementsListResponse, any>>;
4383
+ /**
4384
+ * @description Lists the engagement records.
4385
+ *
4386
+ * @tags engagements
4387
+ * @name EngagementsListPost
4388
+ * @request POST:/engagements.list
4389
+ * @secure
4390
+ */
4391
+ engagementsListPost: (data: EngagementsListRequest, params?: RequestParams) => Promise<AxiosResponse<EngagementsListResponse, any>>;
3421
4392
  /**
3422
4393
  * @description Updates the engagement record.
3423
4394
  *
@@ -3475,6 +4446,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
3475
4446
  /** The requested link's ID. */
3476
4447
  id: string;
3477
4448
  }, params?: RequestParams) => Promise<AxiosResponse<LinksGetResponse, any>>;
4449
+ /**
4450
+ * @description Gets the requested link's information.
4451
+ *
4452
+ * @tags links
4453
+ * @name LinksGetPost
4454
+ * @request POST:/links.get
4455
+ * @secure
4456
+ */
4457
+ linksGetPost: (data: LinksGetRequest, params?: RequestParams) => Promise<AxiosResponse<LinksGetResponse, any>>;
3478
4458
  /**
3479
4459
  * @description Lists the available links.
3480
4460
  *
@@ -3519,6 +4499,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
3519
4499
  */
3520
4500
  types?: LinkType[];
3521
4501
  }, params?: RequestParams) => Promise<AxiosResponse<LinksListResponse, any>>;
4502
+ /**
4503
+ * @description Lists the available links.
4504
+ *
4505
+ * @tags links
4506
+ * @name LinksListPost
4507
+ * @request POST:/links.list
4508
+ * @secure
4509
+ */
4510
+ linksListPost: (data: LinksListRequest, params?: RequestParams) => Promise<AxiosResponse<LinksListResponse, any>>;
3522
4511
  /**
3523
4512
  * @description Lists metric definitions matching a filter.
3524
4513
  *
@@ -3548,6 +4537,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
3548
4537
  /** The type of metric definitions sought. */
3549
4538
  type?: MetricDefinitionMetricType[];
3550
4539
  }, params?: RequestParams) => Promise<AxiosResponse<MetricDefinitionsListResponse, any>>;
4540
+ /**
4541
+ * @description Lists metric definitions matching a filter.
4542
+ *
4543
+ * @tags slas
4544
+ * @name MetricDefinitionsListPost
4545
+ * @request POST:/metric-definitions.list
4546
+ * @secure
4547
+ */
4548
+ metricDefinitionsListPost: (data: MetricDefinitionsListRequest, params?: RequestParams) => Promise<AxiosResponse<MetricDefinitionsListResponse, any>>;
3551
4549
  /**
3552
4550
  * @description Creates an organization schedule fragment.
3553
4551
  *
@@ -3569,6 +4567,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
3569
4567
  /** Organization schedule Fragment ID. */
3570
4568
  id: string;
3571
4569
  }, params?: RequestParams) => Promise<AxiosResponse<OrgScheduleFragmentsGetResponse, any>>;
4570
+ /**
4571
+ * @description Gets an organization schedule fragment.
4572
+ *
4573
+ * @tags schedules
4574
+ * @name OrgScheduleFragmentsGetPost
4575
+ * @request POST:/org-schedule-fragments.get
4576
+ * @secure
4577
+ */
4578
+ orgScheduleFragmentsGetPost: (data: OrgScheduleFragmentsGetRequest, params?: RequestParams) => Promise<AxiosResponse<OrgScheduleFragmentsGetResponse, any>>;
3572
4579
  /**
3573
4580
  * @description Changes stage of an organization schedule fragment.
3574
4581
  *
@@ -3599,6 +4606,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
3599
4606
  /** Organization schedule ID. */
3600
4607
  id: string;
3601
4608
  }, params?: RequestParams) => Promise<AxiosResponse<OrgSchedulesGetResponse, any>>;
4609
+ /**
4610
+ * @description Gets an organization schedule.
4611
+ *
4612
+ * @tags schedules
4613
+ * @name OrgSchedulesGetPost
4614
+ * @request POST:/org-schedules.get
4615
+ * @secure
4616
+ */
4617
+ orgSchedulesGetPost: (data: OrgSchedulesGetRequest, params?: RequestParams) => Promise<AxiosResponse<OrgSchedulesGetResponse, any>>;
3602
4618
  /**
3603
4619
  * @description Gets list of organization schedules.
3604
4620
  *
@@ -3629,6 +4645,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
3629
4645
  /** The organization schedule statuses the filter matches. */
3630
4646
  status?: OrgScheduleStatus[];
3631
4647
  }, params?: RequestParams) => Promise<AxiosResponse<OrgSchedulesListResponse, any>>;
4648
+ /**
4649
+ * @description Gets list of organization schedules.
4650
+ *
4651
+ * @tags schedules
4652
+ * @name OrgSchedulesListPost
4653
+ * @request POST:/org-schedules.list
4654
+ * @secure
4655
+ */
4656
+ orgSchedulesListPost: (data: OrgSchedulesListRequest, params?: RequestParams) => Promise<AxiosResponse<OrgSchedulesListResponse, any>>;
3632
4657
  /**
3633
4658
  * @description Sets next organization schedule fragment which must begin the day the last existing fragment ends.
3634
4659
  *
@@ -3680,6 +4705,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
3680
4705
  */
3681
4706
  id: string;
3682
4707
  }, params?: RequestParams) => Promise<AxiosResponse<RevOrgsGetResponse, any>>;
4708
+ /**
4709
+ * @description Retrieves the Rev organization's information.
4710
+ *
4711
+ * @tags rev-orgs
4712
+ * @name RevOrgsGetPost
4713
+ * @request POST:/rev-orgs.get
4714
+ * @secure
4715
+ */
4716
+ revOrgsGetPost: (data: RevOrgsGetRequest, params?: RequestParams) => Promise<AxiosResponse<RevOrgsGetResponse, any>>;
3683
4717
  /**
3684
4718
  * @description Gets the list of Rev organizations' information belonging to the authenticated user's Dev Organization which the user is also authorized to access.
3685
4719
  *
@@ -3741,6 +4775,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
3741
4775
  */
3742
4776
  sort_by?: string[];
3743
4777
  }, params?: RequestParams) => Promise<AxiosResponse<RevOrgsListResponse, any>>;
4778
+ /**
4779
+ * @description Gets the list of Rev organizations' information belonging to the authenticated user's Dev Organization which the user is also authorized to access.
4780
+ *
4781
+ * @tags rev-orgs
4782
+ * @name RevOrgsListPost
4783
+ * @request POST:/rev-orgs.list
4784
+ * @secure
4785
+ */
4786
+ revOrgsListPost: (data: RevOrgsListRequest, params?: RequestParams) => Promise<AxiosResponse<RevOrgsListResponse, any>>;
3744
4787
  /**
3745
4788
  * @description Updates the Rev organization's information.
3746
4789
  *
@@ -3780,6 +4823,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
3780
4823
  /** The ID of Rev user to be retrieved. */
3781
4824
  id: string;
3782
4825
  }, params?: RequestParams) => Promise<AxiosResponse<RevUsersGetResponse, any>>;
4826
+ /**
4827
+ * @description Returns the Rev user of a Rev organization by its ID.
4828
+ *
4829
+ * @tags rev-users
4830
+ * @name RevUsersGetPost
4831
+ * @request POST:/rev-users.get
4832
+ * @secure
4833
+ */
4834
+ revUsersGetPost: (data: RevUsersGetRequest, params?: RequestParams) => Promise<AxiosResponse<RevUsersGetResponse, any>>;
3783
4835
  /**
3784
4836
  * @description Links a rev user to a rev org.
3785
4837
  *
@@ -3851,6 +4903,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
3851
4903
  /** Fields to sort the Rev users by and the direction to sort them. */
3852
4904
  sort_by?: string[];
3853
4905
  }, params?: RequestParams) => Promise<AxiosResponse<RevUsersListResponse, any>>;
4906
+ /**
4907
+ * @description Returns a list of all Rev Users belonging to the authenticated user's Dev Organization.
4908
+ *
4909
+ * @tags rev-users
4910
+ * @name RevUsersListPost
4911
+ * @request POST:/rev-users.list
4912
+ * @secure
4913
+ */
4914
+ revUsersListPost: (data: RevUsersListRequest, params?: RequestParams) => Promise<AxiosResponse<RevUsersListResponse, any>>;
3854
4915
  /**
3855
4916
  * @description Unlinks a rev user from a rev org.
3856
4917
  *
@@ -3883,6 +4944,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
3883
4944
  /** The stock schema fragment which is to be aggregated. */
3884
4945
  stock_schema_fragment_id?: string;
3885
4946
  }, params?: RequestParams) => Promise<AxiosResponse<AggregatedSchemaGetResponse, any>>;
4947
+ /**
4948
+ * @description Gets the aggregated schema.
4949
+ *
4950
+ * @tags customization
4951
+ * @name AggregatedSchemaGetPost
4952
+ * @request POST:/schemas.aggregated.get
4953
+ * @secure
4954
+ */
4955
+ aggregatedSchemaGetPost: (data: AggregatedSchemaGetRequest, params?: RequestParams) => Promise<AxiosResponse<AggregatedSchemaGetResponse, any>>;
3886
4956
  /**
3887
4957
  * @description Gets a custom schema fragment.
3888
4958
  *
@@ -3895,6 +4965,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
3895
4965
  /** The ID of the custom schema fragment. */
3896
4966
  id: string;
3897
4967
  }, params?: RequestParams) => Promise<AxiosResponse<CustomSchemaFragmentsGetResponse, any>>;
4968
+ /**
4969
+ * @description Gets a custom schema fragment.
4970
+ *
4971
+ * @tags customization
4972
+ * @name CustomSchemaFragmentsGetPost
4973
+ * @request POST:/schemas.custom.get
4974
+ * @secure
4975
+ */
4976
+ customSchemaFragmentsGetPost: (data: CustomSchemaFragmentsGetRequest, params?: RequestParams) => Promise<AxiosResponse<CustomSchemaFragmentsGetResponse, any>>;
3898
4977
  /**
3899
4978
  * @description Lists custom schema fragments.
3900
4979
  *
@@ -3925,6 +5004,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
3925
5004
  /** Filters for custom schema fragment of the provided types. */
3926
5005
  types?: CustomSchemaFragmentType[];
3927
5006
  }, params?: RequestParams) => Promise<AxiosResponse<CustomSchemaFragmentsListResponse, any>>;
5007
+ /**
5008
+ * @description Lists custom schema fragments.
5009
+ *
5010
+ * @tags customization
5011
+ * @name CustomSchemaFragmentsListPost
5012
+ * @request POST:/schemas.custom.list
5013
+ * @secure
5014
+ */
5015
+ customSchemaFragmentsListPost: (data: CustomSchemaFragmentsListRequest, params?: RequestParams) => Promise<AxiosResponse<CustomSchemaFragmentsListResponse, any>>;
3928
5016
  /**
3929
5017
  * @description Creates or updates a custom schema fragment.
3930
5018
  *
@@ -3951,6 +5039,36 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
3951
5039
  /** List of leaf types for which subtypes are required. */
3952
5040
  leaf_types?: string[];
3953
5041
  }, params?: RequestParams) => Promise<AxiosResponse<SubtypesListResponse, any>>;
5042
+ /**
5043
+ * @description Lists subtypes.
5044
+ *
5045
+ * @tags customization
5046
+ * @name SubtypesListPost
5047
+ * @request POST:/schemas.subtypes.list
5048
+ * @secure
5049
+ */
5050
+ subtypesListPost: (data: SubtypesListRequest, params?: RequestParams) => Promise<AxiosResponse<SubtypesListResponse, any>>;
5051
+ /**
5052
+ * @description Gets a service account.
5053
+ *
5054
+ * @tags service-accounts
5055
+ * @name ServiceAccountsGet
5056
+ * @request GET:/service-accounts.get
5057
+ * @secure
5058
+ */
5059
+ serviceAccountsGet: (query: {
5060
+ /** The ID of the requested service account. */
5061
+ id: string;
5062
+ }, params?: RequestParams) => Promise<AxiosResponse<ServiceAccountsGetResponse, any>>;
5063
+ /**
5064
+ * @description Gets a service account.
5065
+ *
5066
+ * @tags service-accounts
5067
+ * @name ServiceAccountsGetPost
5068
+ * @request POST:/service-accounts.get
5069
+ * @secure
5070
+ */
5071
+ serviceAccountsGetPost: (data: ServiceAccountsGetRequest, params?: RequestParams) => Promise<AxiosResponse<ServiceAccountsGetResponse, any>>;
3954
5072
  /**
3955
5073
  * @description Assigns the SLA to a set of Rev organizations.
3956
5074
  *
@@ -3981,6 +5099,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
3981
5099
  /** The ID of the SLA to get. */
3982
5100
  id: string;
3983
5101
  }, params?: RequestParams) => Promise<AxiosResponse<SlasGetResponse, any>>;
5102
+ /**
5103
+ * @description Gets an SLA.
5104
+ *
5105
+ * @tags slas
5106
+ * @name SlasGetPost
5107
+ * @request POST:/slas.get
5108
+ * @secure
5109
+ */
5110
+ slasGetPost: (data: SlasGetRequest, params?: RequestParams) => Promise<AxiosResponse<SlasGetResponse, any>>;
3984
5111
  /**
3985
5112
  * @description Lists SLAs matching a filter.
3986
5113
  *
@@ -4008,6 +5135,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
4008
5135
  /** The SLA statuses the filter matches. */
4009
5136
  status?: SlaStatus[];
4010
5137
  }, params?: RequestParams) => Promise<AxiosResponse<SlasListResponse, any>>;
5138
+ /**
5139
+ * @description Lists SLAs matching a filter.
5140
+ *
5141
+ * @tags slas
5142
+ * @name SlasListPost
5143
+ * @request POST:/slas.list
5144
+ * @secure
5145
+ */
5146
+ slasListPost: (data: SlasListRequest, params?: RequestParams) => Promise<AxiosResponse<SlasListResponse, any>>;
4011
5147
  /**
4012
5148
  * @description Changes the status of an SLA.
4013
5149
  *
@@ -4054,6 +5190,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
4054
5190
  /** Fields to sort the system users by and the direction to sort them. */
4055
5191
  sort_by?: string[];
4056
5192
  }, params?: RequestParams) => Promise<AxiosResponse<SysUsersListResponse, any>>;
5193
+ /**
5194
+ * @description Lists system users within your organization.
5195
+ *
5196
+ * @tags sys-users
5197
+ * @name SysUsersListPost
5198
+ * @request POST:/sys-users.list
5199
+ * @secure
5200
+ */
5201
+ sysUsersListPost: (data: SysUsersListRequest, params?: RequestParams) => Promise<AxiosResponse<SysUsersListResponse, any>>;
4057
5202
  /**
4058
5203
  * @description Updates the system user.
4059
5204
  *
@@ -4114,6 +5259,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
4114
5259
  */
4115
5260
  visibility?: TimelineEntryVisibility[];
4116
5261
  }, params?: RequestParams) => Promise<AxiosResponse<TimelineEntriesListResponse, any>>;
5262
+ /**
5263
+ * @description Lists the timeline entries for an object.
5264
+ *
5265
+ * @tags timeline-entries
5266
+ * @name TimelineEntriesListPost
5267
+ * @request POST:/timeline-entries.list
5268
+ * @secure
5269
+ */
5270
+ timelineEntriesListPost: (data: TimelineEntriesListRequest, params?: RequestParams) => Promise<AxiosResponse<TimelineEntriesListResponse, any>>;
4117
5271
  /**
4118
5272
  * @description Creates new work ([issue](https://devrev.ai/docs/product/build), [ticket](https://devrev.ai/docs/product/support)) item. [task](https://docs.devrev.ai/product/tasks) and opportunity work types are supported in the beta version.
4119
5273
  *
@@ -4178,6 +5332,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
4178
5332
  * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
4179
5333
  */
4180
5334
  owned_by?: string[];
5335
+ /** Fields to sort the work items by and the direction to sort them. */
5336
+ sort_by?: string[];
4181
5337
  /** Filters for records in the provided stage(s). */
4182
5338
  'stage.name'?: string[];
4183
5339
  /** Filters for tickets belonging to specific groups. */
@@ -4199,6 +5355,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
4199
5355
  /** Filters for work of the provided types. */
4200
5356
  type?: WorkType[];
4201
5357
  }, params?: RequestParams) => Promise<AxiosResponse<WorksExportResponse, any>>;
5358
+ /**
5359
+ * @description Exports a collection of work items.
5360
+ *
5361
+ * @tags works
5362
+ * @name WorksExportPost
5363
+ * @request POST:/works.export
5364
+ * @secure
5365
+ */
5366
+ worksExportPost: (data: WorksExportRequest, params?: RequestParams) => Promise<AxiosResponse<WorksExportResponse, any>>;
4202
5367
  /**
4203
5368
  * @description Gets a work item's information.
4204
5369
  *
@@ -4214,6 +5379,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
4214
5379
  */
4215
5380
  id: string;
4216
5381
  }, params?: RequestParams) => Promise<AxiosResponse<WorksGetResponse, any>>;
5382
+ /**
5383
+ * @description Gets a work item's information.
5384
+ *
5385
+ * @tags works
5386
+ * @name WorksGetPost
5387
+ * @request POST:/works.get
5388
+ * @secure
5389
+ */
5390
+ worksGetPost: (data: WorksGetRequest, params?: RequestParams) => Promise<AxiosResponse<WorksGetResponse, any>>;
4217
5391
  /**
4218
5392
  * @description Lists a collection of work items.
4219
5393
  *
@@ -4269,6 +5443,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
4269
5443
  * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
4270
5444
  */
4271
5445
  owned_by?: string[];
5446
+ /** Fields to sort the works by and the direction to sort them. */
5447
+ sort_by?: string[];
4272
5448
  /** Filters for records in the provided stage(s). */
4273
5449
  'stage.name'?: string[];
4274
5450
  /** Filters for tickets belonging to specific groups. */
@@ -4290,6 +5466,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
4290
5466
  /** Filters for work of the provided types. */
4291
5467
  type?: WorkType[];
4292
5468
  }, params?: RequestParams) => Promise<AxiosResponse<WorksListResponse, any>>;
5469
+ /**
5470
+ * @description Lists a collection of work items.
5471
+ *
5472
+ * @tags works
5473
+ * @name WorksListPost
5474
+ * @request POST:/works.list
5475
+ * @secure
5476
+ */
5477
+ worksListPost: (data: WorksListRequest, params?: RequestParams) => Promise<AxiosResponse<WorksListResponse, any>>;
4293
5478
  /**
4294
5479
  * @description Updates a work item's information.
4295
5480
  *