@devrev/typescript-sdk 1.1.7 → 1.1.9

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.
@@ -7,6 +7,8 @@ export declare enum AccessLevel {
7
7
  }
8
8
  /** account */
9
9
  export type Account = OrgBase & {
10
+ /** The artifacts attached to the Account. */
11
+ artifacts?: ArtifactSummary[];
10
12
  /** Custom fields. */
11
13
  custom_fields?: object;
12
14
  /**
@@ -30,6 +32,8 @@ export type Account = OrgBase & {
30
32
  * @example "don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"
31
33
  */
32
34
  stock_schema_fragment?: string;
35
+ /** Tags associated with an object. */
36
+ tags?: TagWithValue[];
33
37
  /** The Tier of the corresponding Account. */
34
38
  tier?: string;
35
39
  };
@@ -40,6 +44,11 @@ export type AccountSummary = OrgBaseSummary;
40
44
  * Request object to create a new account in the Dev organization.
41
45
  */
42
46
  export interface AccountsCreateRequest {
47
+ /**
48
+ * The IDs of the artifacts to associate with the account.
49
+ * @example ["don:core:<partition>:devo/<dev-org-id>:artifact/<artifact-id>"]
50
+ */
51
+ artifacts?: string[];
43
52
  /** Application-defined custom fields. */
44
53
  custom_fields?: object;
45
54
  /** Description of the account. */
@@ -61,6 +70,8 @@ export interface AccountsCreateRequest {
61
70
  * @example ["don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"]
62
71
  */
63
72
  schema_fragment_ids?: string[];
73
+ /** Tags associated with the account. */
74
+ tags?: SetTagWithValue[];
64
75
  /** The tier of the account. */
65
76
  tier?: string;
66
77
  }
@@ -95,6 +106,8 @@ export interface AccountsExportRequest {
95
106
  /** Filters for accounts created by the specified user(s). */
96
107
  created_by?: string[];
97
108
  created_date?: DateTimeFilter;
109
+ /** Domains for accounts to be filtered. */
110
+ domains?: string[];
98
111
  /** Array of references of accounts to be filtered. */
99
112
  external_refs?: string[];
100
113
  /**
@@ -105,8 +118,14 @@ export interface AccountsExportRequest {
105
118
  */
106
119
  first?: number;
107
120
  modified_date?: DateTimeFilter;
121
+ /** Filters for accounts owned by the specified user(s). */
122
+ owned_by?: string[];
108
123
  /** Fields to sort the accounts by and the direction to sort them in. */
109
124
  sort_by?: string[];
125
+ /** Filters for accounts on specified stages. */
126
+ stage?: string[];
127
+ /** List of tags to be filtered. */
128
+ tags?: string[];
110
129
  }
111
130
  /**
112
131
  * accounts-export-response
@@ -147,6 +166,8 @@ export interface AccountsListRequest {
147
166
  * iteration starts from the beginning.
148
167
  */
149
168
  cursor?: string;
169
+ /** Domains for accounts to be filtered. */
170
+ domains?: string[];
150
171
  /** Array of references of accounts to be filtered. */
151
172
  external_refs?: string[];
152
173
  /**
@@ -164,8 +185,14 @@ export interface AccountsListRequest {
164
185
  */
165
186
  mode?: ListMode;
166
187
  modified_date?: DateTimeFilter;
188
+ /** Filters for accounts owned by the specified user(s). */
189
+ owned_by?: string[];
167
190
  /** Fields to sort the accounts by and the direction to sort them in. */
168
191
  sort_by?: string[];
192
+ /** Filters for accounts on specified stages. */
193
+ stage?: string[];
194
+ /** List of tags to be filtered. */
195
+ tags?: string[];
169
196
  }
170
197
  /**
171
198
  * accounts-list-response
@@ -190,6 +217,7 @@ export interface AccountsListResponse {
190
217
  * Request to update details of the account.
191
218
  */
192
219
  export interface AccountsUpdateRequest {
220
+ artifacts?: AccountsUpdateRequestArtifacts;
193
221
  /** Application-defined custom fields. */
194
222
  custom_fields?: object;
195
223
  /** Updated description of the account. */
@@ -215,9 +243,19 @@ export interface AccountsUpdateRequest {
215
243
  * @example ["don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"]
216
244
  */
217
245
  schema_fragment_ids?: string[];
246
+ /** Updated tags list associated with the account. */
247
+ tags?: SetTagWithValue[];
218
248
  /** Updated tier of the account. */
219
249
  tier?: string;
220
250
  }
251
+ /** accounts-update-request-artifacts */
252
+ export interface AccountsUpdateRequestArtifacts {
253
+ /**
254
+ * Sets the IDs to the provided artifact IDs.
255
+ * @example ["don:core:<partition>:devo/<dev-org-id>:artifact/<artifact-id>"]
256
+ */
257
+ set?: string[];
258
+ }
221
259
  /**
222
260
  * accounts-update-response
223
261
  * Updated account object.
@@ -248,6 +286,8 @@ export interface AggregatedSchemaGetResponse {
248
286
  export type AppFragment = CustomSchemaFragmentBase;
249
287
  /** article */
250
288
  export type Article = AtomBase & {
289
+ /** Details of the parts relevant to the article. */
290
+ applies_to_parts: PartSummary[];
251
291
  /** Description of the article. */
252
292
  description?: string;
253
293
  /** Artifacts containing the extracted content. */
@@ -367,6 +407,8 @@ export interface ArticlesDeleteRequest {
367
407
  */
368
408
  id: string;
369
409
  }
410
+ /** articles-delete-response */
411
+ export type ArticlesDeleteResponse = object;
370
412
  /**
371
413
  * articles-get-request
372
414
  * The request to get an article.
@@ -1406,6 +1448,54 @@ export declare enum ErrorUnauthorizedType {
1406
1448
  }
1407
1449
  /** error-unauthorized-unauthenticated */
1408
1450
  export type ErrorUnauthorizedUnauthenticated = object;
1451
+ /** event-source */
1452
+ export type EventSource = AtomBase & {
1453
+ /**
1454
+ * Configuration of the event source. Fields depend on the event
1455
+ * source type.
1456
+ */
1457
+ config?: object;
1458
+ /** Name of the event source. */
1459
+ name?: string;
1460
+ /** Instructions for setting up the event source. */
1461
+ setup_instructions?: EventSourceSetupInstructions;
1462
+ /**
1463
+ * Status of the event source. Note that paused/blocked event sources
1464
+ * return NotFound error on triggering.
1465
+ */
1466
+ status?: EventSourceStatus;
1467
+ /**
1468
+ * The URL to trigger the event source. Valid only for HTTP
1469
+ * based-event sources. This URL supports both GET and POST requests.
1470
+ */
1471
+ trigger_url?: string;
1472
+ };
1473
+ /** event-source-get-request */
1474
+ export interface EventSourceGetRequest {
1475
+ /** The event source's ID. */
1476
+ id: string;
1477
+ }
1478
+ /** event-source-get-response */
1479
+ export interface EventSourceGetResponse {
1480
+ event_source: EventSource;
1481
+ }
1482
+ /**
1483
+ * event-source-setup-instructions
1484
+ * Instructions for setting up the event source.
1485
+ */
1486
+ export interface EventSourceSetupInstructions {
1487
+ /** Content of the instructions. */
1488
+ content?: string;
1489
+ }
1490
+ /**
1491
+ * Status of the event source. Note that paused/blocked event sources
1492
+ * return NotFound error on triggering.
1493
+ */
1494
+ export declare enum EventSourceStatus {
1495
+ Active = "active",
1496
+ Blocked = "blocked",
1497
+ Paused = "paused"
1498
+ }
1409
1499
  /** event-sources-delete-scheduled-event-request */
1410
1500
  export interface EventSourcesDeleteScheduledEventRequest {
1411
1501
  /** The event key for the event which we want to delete. */
@@ -1459,8 +1549,150 @@ export type FeatureSummary = PartBaseSummary;
1459
1549
  * Set of field attributes.
1460
1550
  */
1461
1551
  export type FieldDescriptor = object;
1552
+ /**
1553
+ * get-accounts-default-rev-org-request
1554
+ * Request object to get an account's default Rev organization.
1555
+ */
1556
+ export interface GetAccountsDefaultRevOrgRequest {
1557
+ /**
1558
+ * The ID of Account for which default Rev organization is to be
1559
+ * fetched.
1560
+ * @example "don:core:<partition>:devo/<dev-org-id>:account/<account-id>"
1561
+ */
1562
+ id: string;
1563
+ }
1564
+ /**
1565
+ * get-accounts-default-rev-org-response
1566
+ * Response object for getting account's default Rev organization.
1567
+ */
1568
+ export interface GetAccountsDefaultRevOrgResponse {
1569
+ rev_org: RevOrg;
1570
+ }
1571
+ /** group */
1572
+ export type Group = AtomBase & {
1573
+ /** Description of the group. */
1574
+ description?: string;
1575
+ /** Whether it is a default group. */
1576
+ is_default: boolean;
1577
+ /** Type of the members in the group. */
1578
+ member_type?: GroupMemberType;
1579
+ /** Name of the group. */
1580
+ name?: string;
1581
+ owner?: UserSummary;
1582
+ };
1583
+ /** Type of the members in the group. */
1584
+ export declare enum GroupMemberType {
1585
+ DevUser = "dev_user",
1586
+ RevUser = "rev_user"
1587
+ }
1462
1588
  /** group-summary */
1463
- export type GroupSummary = AtomBaseSummary;
1589
+ export type GroupSummary = AtomBaseSummary & {
1590
+ /** Name of the group. */
1591
+ name?: string;
1592
+ };
1593
+ /**
1594
+ * groups-create-request
1595
+ * A request to create a new group.
1596
+ */
1597
+ export interface GroupsCreateRequest {
1598
+ /** Description of the group. */
1599
+ description: string;
1600
+ /** Type of the members in the group. */
1601
+ member_type?: GroupMemberType;
1602
+ /** Unique name of the group. */
1603
+ name: string;
1604
+ /** Owner of the group. */
1605
+ owner?: string;
1606
+ }
1607
+ /**
1608
+ * groups-create-response
1609
+ * The response to group creation.
1610
+ */
1611
+ export interface GroupsCreateResponse {
1612
+ group: Group;
1613
+ }
1614
+ /**
1615
+ * groups-get-request
1616
+ * A request to get information about a group.
1617
+ */
1618
+ export interface GroupsGetRequest {
1619
+ /** The ID of the group to get. */
1620
+ id: string;
1621
+ }
1622
+ /**
1623
+ * groups-get-response
1624
+ * The response to getting the group.
1625
+ */
1626
+ export interface GroupsGetResponse {
1627
+ group: Group;
1628
+ }
1629
+ /**
1630
+ * groups-list-request
1631
+ * A request to get information about a list of groups.
1632
+ */
1633
+ export interface GroupsListRequest {
1634
+ /**
1635
+ * The cursor to resume iteration from. If not provided, then
1636
+ * iteration starts from the beginning.
1637
+ */
1638
+ cursor?: string;
1639
+ /**
1640
+ * The maximum number of groups to return. The default is '50'.
1641
+ * @format int32
1642
+ */
1643
+ limit?: number;
1644
+ /** Filters the groups on basis of member type. */
1645
+ member_type?: GroupMemberType[];
1646
+ /**
1647
+ * The iteration mode to use. If "after", then entries after the provided
1648
+ * cursor will be returned, or if no cursor is provided, then from the
1649
+ * beginning. If "before", then entries before the provided cursor will be
1650
+ * returned, or if no cursor is provided, then from the end. Entries will
1651
+ * always be returned in the specified sort-by order.
1652
+ */
1653
+ mode?: ListMode;
1654
+ /** Comma-separated fields to sort the groups by. */
1655
+ sort_by?: string[];
1656
+ }
1657
+ /**
1658
+ * groups-list-response
1659
+ * The response to listing the groups.
1660
+ */
1661
+ export interface GroupsListResponse {
1662
+ /** The list of groups. */
1663
+ groups: Group[];
1664
+ /**
1665
+ * The cursor used to iterate subsequent results in accordance to the
1666
+ * sort order. If not set, then no later elements exist.
1667
+ */
1668
+ next_cursor?: string;
1669
+ /**
1670
+ * The cursor used to iterate preceding results in accordance to the
1671
+ * sort order. If not set, then no prior elements exist.
1672
+ */
1673
+ prev_cursor?: string;
1674
+ }
1675
+ /**
1676
+ * groups-update-request
1677
+ * A request to update a group.
1678
+ */
1679
+ export interface GroupsUpdateRequest {
1680
+ /** The updated group's description. */
1681
+ description?: string;
1682
+ /** The ID of the group to update. */
1683
+ id: string;
1684
+ /** The updated group's name. */
1685
+ name?: string;
1686
+ /** The updated group's owner. */
1687
+ owner?: string;
1688
+ }
1689
+ /**
1690
+ * groups-update-response
1691
+ * The response to group update.
1692
+ */
1693
+ export interface GroupsUpdateResponse {
1694
+ group: Group;
1695
+ }
1464
1696
  /** issue */
1465
1697
  export type Issue = WorkBase & {
1466
1698
  /** Priority of the work based upon impact and criticality. */
@@ -2098,6 +2330,9 @@ export interface Resource {
2098
2330
  }
2099
2331
  /** rev-org */
2100
2332
  export type RevOrg = OrgBase & {
2333
+ account?: AccountSummary;
2334
+ /** The artifacts attached to the Rev organization. */
2335
+ artifacts?: ArtifactSummary[];
2101
2336
  /** Custom fields. */
2102
2337
  custom_fields?: object;
2103
2338
  /**
@@ -2130,6 +2365,16 @@ export type RevOrgSummary = OrgBaseSummary;
2130
2365
  * organization.
2131
2366
  */
2132
2367
  export interface RevOrgsCreateRequest {
2368
+ /**
2369
+ * Account Id to associate with this Rev organization.
2370
+ * @example "don:core:<partition>:devo/<dev-org-id>:account/<account-id>"
2371
+ */
2372
+ account?: string;
2373
+ /**
2374
+ * The IDs of the artifacts to associate with the Rev organization.
2375
+ * @example ["don:core:<partition>:devo/<dev-org-id>:artifact/<artifact-id>"]
2376
+ */
2377
+ artifacts?: string[];
2133
2378
  /** Application-defined custom fields. */
2134
2379
  custom_fields?: object;
2135
2380
  /**
@@ -2185,6 +2430,11 @@ export interface RevOrgsGetResponse {
2185
2430
  * user's Dev organization.
2186
2431
  */
2187
2432
  export interface RevOrgsListRequest {
2433
+ /**
2434
+ * Filters by account.
2435
+ * @example ["don:core:<partition>:devo/<dev-org-id>:account/<account-id>"]
2436
+ */
2437
+ account?: string[];
2188
2438
  /** Filters by creator. */
2189
2439
  created_by?: string[];
2190
2440
  created_date?: DateTimeFilter;
@@ -2243,6 +2493,12 @@ export interface RevOrgsListResponse {
2243
2493
  * Request object to update information of the Rev organization.
2244
2494
  */
2245
2495
  export interface RevOrgsUpdateRequest {
2496
+ /**
2497
+ * New account ID to associate with this Rev organization.
2498
+ * @example "don:core:<partition>:devo/<dev-org-id>:account/<account-id>"
2499
+ */
2500
+ account?: string;
2501
+ artifacts?: RevOrgsUpdateRequestArtifacts;
2246
2502
  /**
2247
2503
  * Schema fragment IDs associated with this Rev organization.
2248
2504
  * @example ["don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"]
@@ -2270,6 +2526,14 @@ export interface RevOrgsUpdateRequest {
2270
2526
  /** The tier of the RevOrg. */
2271
2527
  tier?: string;
2272
2528
  }
2529
+ /** rev-orgs-update-request-artifacts */
2530
+ export interface RevOrgsUpdateRequestArtifacts {
2531
+ /**
2532
+ * Sets the IDs to the provided artifact IDs.
2533
+ * @example ["don:core:<partition>:devo/<dev-org-id>:artifact/<artifact-id>"]
2534
+ */
2535
+ set?: string[];
2536
+ }
2273
2537
  /**
2274
2538
  * rev-orgs-update-response
2275
2539
  * Response object to updating Rev organization's information.
@@ -2279,6 +2543,8 @@ export interface RevOrgsUpdateResponse {
2279
2543
  }
2280
2544
  /** rev-user */
2281
2545
  export type RevUser = UserBase & {
2546
+ /** The artifacts attached to the Rev user. */
2547
+ artifacts?: ArtifactSummary[];
2282
2548
  /** Custom fields. */
2283
2549
  custom_fields?: object;
2284
2550
  /**
@@ -2296,6 +2562,8 @@ export type RevUser = UserBase & {
2296
2562
  * system-generated identifier will be assigned to the user.
2297
2563
  */
2298
2564
  external_ref?: string;
2565
+ /** Whether the Rev user is verified or not. */
2566
+ is_verified?: boolean;
2299
2567
  rev_org?: OrgSummary;
2300
2568
  /**
2301
2569
  * Stock schema fragment.
@@ -2320,6 +2588,11 @@ export type RevUserSummary = UserBaseSummary & {
2320
2588
  * Request object to create a new Rev user for a Rev organization.
2321
2589
  */
2322
2590
  export interface RevUsersCreateRequest {
2591
+ /**
2592
+ * The IDs of the artifacts to associate with the Rev user.
2593
+ * @example ["don:core:<partition>:devo/<dev-org-id>:artifact/<artifact-id>"]
2594
+ */
2595
+ artifacts?: string[];
2323
2596
  /** Application-defined custom fields. */
2324
2597
  custom_fields?: object;
2325
2598
  /**
@@ -2449,6 +2722,7 @@ export interface RevUsersListResponse {
2449
2722
  * Request to update details of a Rev user.
2450
2723
  */
2451
2724
  export interface RevUsersUpdateRequest {
2725
+ artifacts?: RevUsersUpdateRequestArtifacts;
2452
2726
  /** Application-defined custom fields. */
2453
2727
  custom_fields?: object;
2454
2728
  custom_schema_fragments?: RevUsersUpdateRequestCustomSchemaFragments;
@@ -2463,6 +2737,14 @@ export interface RevUsersUpdateRequest {
2463
2737
  /** The ID of Rev user to update. */
2464
2738
  id: string;
2465
2739
  }
2740
+ /** rev-users-update-request-artifacts */
2741
+ export interface RevUsersUpdateRequestArtifacts {
2742
+ /**
2743
+ * Sets the IDs to the provided artifact IDs.
2744
+ * @example ["don:core:<partition>:devo/<dev-org-id>:artifact/<artifact-id>"]
2745
+ */
2746
+ set?: string[];
2747
+ }
2466
2748
  /** rev-users-update-request-custom-schema-fragments */
2467
2749
  export interface RevUsersUpdateRequestCustomSchemaFragments {
2468
2750
  /**
@@ -3223,8 +3505,10 @@ export interface Stage {
3223
3505
  * The filter for stages.
3224
3506
  */
3225
3507
  export interface StageFilter {
3226
- /** Filters for records in the provided stage(s). */
3508
+ /** Filters for records in the provided stage(s) by name. */
3227
3509
  name?: string[];
3510
+ /** Filters for records in the provided stage(s) by ordinal. */
3511
+ ordinal?: number[];
3228
3512
  }
3229
3513
  /**
3230
3514
  * stage-init
@@ -3440,6 +3724,13 @@ export type TimelineEntriesCreateRequest = TimelineEntriesCreateRequestTimelineC
3440
3724
  * @format date-time
3441
3725
  */
3442
3726
  expires_at?: string;
3727
+ /**
3728
+ * The labels to be associated with the entry.
3729
+ * @minLength 1
3730
+ * @maxLength 64
3731
+ * @maxItems 16
3732
+ */
3733
+ labels?: string[];
3443
3734
  /**
3444
3735
  * The ID of the object to create the timeline entry for.
3445
3736
  * @example "don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"
@@ -3473,6 +3764,11 @@ export interface TimelineEntriesCreateRequestTimelineComment {
3473
3764
  body?: string;
3474
3765
  /** The type of the body to use for the comment. */
3475
3766
  body_type?: TimelineCommentBodyType;
3767
+ /**
3768
+ * The IDs of the previews of the links posted in the comment.
3769
+ * @example ["don:core:<partition>:devo/<dev-org-id>:snap_widget/<snap-widget-id>"]
3770
+ */
3771
+ link_previews?: string[];
3476
3772
  /** Snap Kit Body of the comment. */
3477
3773
  snap_kit_body?: TimelineSnapKitBody;
3478
3774
  }
@@ -3501,6 +3797,14 @@ export interface TimelineEntriesListRequest {
3501
3797
  * iteration starts from the beginning.
3502
3798
  */
3503
3799
  cursor?: string;
3800
+ /**
3801
+ * Filters for entries containing at least one of the provided labels,
3802
+ * otherwise if no labels are provided, then no label filtering is
3803
+ * done.
3804
+ * @minLength 1
3805
+ * @maxLength 64
3806
+ */
3807
+ labels?: string[];
3504
3808
  /**
3505
3809
  * The maximum number of entries to return. If not set, then this
3506
3810
  * defaults to `50`.
@@ -3545,12 +3849,90 @@ export interface TimelineEntriesListResponse {
3545
3849
  /** The timeline entries for the object. */
3546
3850
  timeline_entries: TimelineEntry[];
3547
3851
  }
3852
+ /**
3853
+ * timeline-entries-update-request
3854
+ * The request to update a timeline entry.
3855
+ */
3856
+ export type TimelineEntriesUpdateRequest = TimelineEntriesUpdateRequestTimelineComment & {
3857
+ /**
3858
+ * The ID of the timeline entry to update.
3859
+ * @example "don:core:<partition>:devo/<dev-org-id>:ticket/123:timeline_event/<timeline-event-id>"
3860
+ */
3861
+ id: string;
3862
+ type: TimelineEntriesUpdateRequestType;
3863
+ };
3864
+ /** timeline-entries-update-request-timeline-comment */
3865
+ export interface TimelineEntriesUpdateRequestTimelineComment {
3866
+ artifacts?: TimelineEntriesUpdateRequestTimelineCommentArtifacts;
3867
+ /** The updated comment's body. */
3868
+ body?: string;
3869
+ /** The type of the body to use for the comment. */
3870
+ body_type?: TimelineCommentBodyType;
3871
+ link_previews?: TimelineEntriesUpdateRequestTimelineCommentLinkPreviews;
3872
+ /** Snap Kit Body of the comment. */
3873
+ snap_kit_body?: TimelineSnapKitBody;
3874
+ }
3875
+ /** timeline-entries-update-request-timeline-comment-artifacts */
3876
+ export interface TimelineEntriesUpdateRequestTimelineCommentArtifacts {
3877
+ /**
3878
+ * Adds the provided artifacts to the comment. An artifact cannot be
3879
+ * added more than once, i.e. nothing is done if the artifact is
3880
+ * already attached. Mutually exclusive with `set`.
3881
+ * @example ["don:core:<partition>:devo/<dev-org-id>:artifact/<artifact-id>"]
3882
+ */
3883
+ add?: string[];
3884
+ /**
3885
+ * Removes the provided artifacts from the comment. If an artifact is
3886
+ * not present, then it's ignored. Mututally exclusive with `set`.
3887
+ * @example ["don:core:<partition>:devo/<dev-org-id>:artifact/<artifact-id>"]
3888
+ */
3889
+ remove?: string[];
3890
+ /**
3891
+ * Sets the field to the provided artifacts.
3892
+ * @example ["don:core:<partition>:devo/<dev-org-id>:artifact/<artifact-id>"]
3893
+ */
3894
+ set?: string[];
3895
+ }
3896
+ /** timeline-entries-update-request-timeline-comment-link-previews */
3897
+ export interface TimelineEntriesUpdateRequestTimelineCommentLinkPreviews {
3898
+ /**
3899
+ * Adds the provided link previews to the comment. A link preview
3900
+ * cannot be added more than once, i.e. nothing is done if the link
3901
+ * preview is already present. Mutually exclusive with `set`.
3902
+ * @example ["don:core:<partition>:devo/<dev-org-id>:snap_widget/<snap-widget-id>"]
3903
+ */
3904
+ add?: string[];
3905
+ /**
3906
+ * Removes the provided link previews from the comment. If a link
3907
+ * preview is not present, then it's ignored. Mutually exclusive with
3908
+ * `set`.
3909
+ * @example ["don:core:<partition>:devo/<dev-org-id>:snap_widget/<snap-widget-id>"]
3910
+ */
3911
+ remove?: string[];
3912
+ /**
3913
+ * Set the link previews to the provided IDs.
3914
+ * @example ["don:core:<partition>:devo/<dev-org-id>:snap_widget/<snap-widget-id>"]
3915
+ */
3916
+ set?: string[];
3917
+ }
3918
+ export declare enum TimelineEntriesUpdateRequestType {
3919
+ TimelineComment = "timeline_comment"
3920
+ }
3921
+ /**
3922
+ * timeline-entries-update-response
3923
+ * The response to updating a timeline entry.
3924
+ */
3925
+ export interface TimelineEntriesUpdateResponse {
3926
+ timeline_entry: TimelineEntry;
3927
+ }
3548
3928
  /** timeline-entry */
3549
3929
  export type TimelineEntry = TimelineComment & {
3550
3930
  type: TimelineEntryType;
3551
3931
  };
3552
3932
  /** timeline-entry-base */
3553
3933
  export type TimelineEntryBase = AtomBase & {
3934
+ /** Labels that are associated with the Timeline entry. */
3935
+ labels?: string[];
3554
3936
  /** The object that the Timeline entry belongs to. */
3555
3937
  object: string;
3556
3938
  /** The type of object that the Timeline entry belongs to. */
@@ -3573,9 +3955,11 @@ export declare enum TimelineEntryObjectType {
3573
3955
  Account = "account",
3574
3956
  Capability = "capability",
3575
3957
  Conversation = "conversation",
3958
+ Engagement = "engagement",
3576
3959
  Enhancement = "enhancement",
3577
3960
  Feature = "feature",
3578
3961
  Issue = "issue",
3962
+ Meeting = "meeting",
3579
3963
  Opportunity = "opportunity",
3580
3964
  Product = "product",
3581
3965
  RevOrg = "rev_org",
@@ -3693,6 +4077,7 @@ export type UserBaseSummary = AtomBaseSummary & {
3693
4077
  export declare enum UserState {
3694
4078
  Active = "active",
3695
4079
  Deactivated = "deactivated",
4080
+ Deleted = "deleted",
3696
4081
  Locked = "locked",
3697
4082
  Shadow = "shadow",
3698
4083
  Unassigned = "unassigned"
@@ -4251,6 +4636,31 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
4251
4636
  * @secure
4252
4637
  */
4253
4638
  accountsCreate: (data: AccountsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<AccountsCreateResponse, any>>;
4639
+ /**
4640
+ * @description Fetches account's default Rev organization.
4641
+ *
4642
+ * @tags accounts
4643
+ * @name GetAccountsDefaultRevOrg
4644
+ * @request GET:/accounts.default-rev-org.get
4645
+ * @secure
4646
+ */
4647
+ getAccountsDefaultRevOrg: (query: {
4648
+ /**
4649
+ * The ID of Account for which default Rev organization is to be
4650
+ * fetched.
4651
+ * @example "don:core:<partition>:devo/<dev-org-id>:account/<account-id>"
4652
+ */
4653
+ id: string;
4654
+ }, params?: RequestParams) => Promise<AxiosResponse<GetAccountsDefaultRevOrgResponse, any>>;
4655
+ /**
4656
+ * @description Fetches account's default Rev organization.
4657
+ *
4658
+ * @tags accounts
4659
+ * @name GetAccountsDefaultRevOrgPost
4660
+ * @request POST:/accounts.default-rev-org.get
4661
+ * @secure
4662
+ */
4663
+ getAccountsDefaultRevOrgPost: (data: GetAccountsDefaultRevOrgRequest, params?: RequestParams) => Promise<AxiosResponse<GetAccountsDefaultRevOrgResponse, any>>;
4254
4664
  /**
4255
4665
  * @description Deletes an account.
4256
4666
  *
@@ -4282,6 +4692,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
4282
4692
  * @format date-time
4283
4693
  */
4284
4694
  'created_date.before'?: string;
4695
+ /** Domains for accounts to be filtered. */
4696
+ domains?: string[];
4285
4697
  /** Array of references of accounts to be filtered. */
4286
4698
  external_refs?: string[];
4287
4699
  /**
@@ -4302,8 +4714,14 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
4302
4714
  * @format date-time
4303
4715
  */
4304
4716
  'modified_date.before'?: string;
4717
+ /** Filters for accounts owned by the specified user(s). */
4718
+ owned_by?: string[];
4305
4719
  /** Fields to sort the accounts by and the direction to sort them in. */
4306
4720
  sort_by?: string[];
4721
+ /** Filters for accounts on specified stages. */
4722
+ stage?: string[];
4723
+ /** List of tags to be filtered. */
4724
+ tags?: string[];
4307
4725
  }, params?: RequestParams) => Promise<AxiosResponse<AccountsExportResponse, any>>;
4308
4726
  /**
4309
4727
  * @description Exports a collection of accounts.
@@ -4365,6 +4783,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
4365
4783
  * starts from the beginning.
4366
4784
  */
4367
4785
  cursor?: string;
4786
+ /** Domains for accounts to be filtered. */
4787
+ domains?: string[];
4368
4788
  /** Array of references of accounts to be filtered. */
4369
4789
  external_refs?: string[];
4370
4790
  /**
@@ -4389,8 +4809,14 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
4389
4809
  * @format date-time
4390
4810
  */
4391
4811
  'modified_date.before'?: string;
4812
+ /** Filters for accounts owned by the specified user(s). */
4813
+ owned_by?: string[];
4392
4814
  /** Fields to sort the accounts by and the direction to sort them in. */
4393
4815
  sort_by?: string[];
4816
+ /** Filters for accounts on specified stages. */
4817
+ stage?: string[];
4818
+ /** List of tags to be filtered. */
4819
+ tags?: string[];
4394
4820
  }, params?: RequestParams) => Promise<AxiosResponse<AccountsListResponse, any>>;
4395
4821
  /**
4396
4822
  * @description Gets a list of accounts.
@@ -4466,7 +4892,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
4466
4892
  * @request POST:/articles.delete
4467
4893
  * @secure
4468
4894
  */
4469
- deleteArticle: (data: ArticlesDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<void, any>>;
4895
+ deleteArticle: (data: ArticlesDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
4470
4896
  /**
4471
4897
  * @description Gets an article.
4472
4898
  *
@@ -4616,8 +5042,10 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
4616
5042
  rev_org?: string[];
4617
5043
  /** Filters for conversations with any of the provided source channels. */
4618
5044
  source_channels?: string[];
4619
- /** Filters for records in the provided stage(s). */
5045
+ /** Filters for records in the provided stage(s) by name. */
4620
5046
  'stage.name'?: string[];
5047
+ /** Filters for records in the provided stage(s) by ordinal. */
5048
+ 'stage.ordinal'?: number[];
4621
5049
  /**
4622
5050
  * Filters for conversations with any of the provided tags.
4623
5051
  * @example ["don:core:<partition>:devo/<dev-org-id>:tag/<tag-id>"]
@@ -4707,8 +5135,10 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
4707
5135
  rev_org?: string[];
4708
5136
  /** Filters for conversations with any of the provided source channels. */
4709
5137
  source_channels?: string[];
4710
- /** Filters for records in the provided stage(s). */
5138
+ /** Filters for records in the provided stage(s) by name. */
4711
5139
  'stage.name'?: string[];
5140
+ /** Filters for records in the provided stage(s) by ordinal. */
5141
+ 'stage.ordinal'?: number[];
4712
5142
  /**
4713
5143
  * Filters for conversations with any of the provided tags.
4714
5144
  * @example ["don:core:<partition>:devo/<dev-org-id>:tag/<tag-id>"]
@@ -4864,6 +5294,27 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
4864
5294
  * @secure
4865
5295
  */
4866
5296
  engagementsUpdate: (data: EngagementsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<EngagementsUpdateResponse, any>>;
5297
+ /**
5298
+ * @description Gets an event source.
5299
+ *
5300
+ * @tags event-source
5301
+ * @name EventSourcesGet
5302
+ * @request GET:/event-sources.get
5303
+ * @secure
5304
+ */
5305
+ eventSourcesGet: (query: {
5306
+ /** The event source's ID. */
5307
+ id: string;
5308
+ }, params?: RequestParams) => Promise<AxiosResponse<EventSourceGetResponse, any>>;
5309
+ /**
5310
+ * @description Gets an event source.
5311
+ *
5312
+ * @tags event-source
5313
+ * @name EventSourcesGetPost
5314
+ * @request POST:/event-sources.get
5315
+ * @secure
5316
+ */
5317
+ eventSourcesGetPost: (data: EventSourceGetRequest, params?: RequestParams) => Promise<AxiosResponse<EventSourceGetResponse, any>>;
4867
5318
  /**
4868
5319
  * @description Schedules an event to be published to the specified event source.
4869
5320
  *
@@ -4882,6 +5333,83 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
4882
5333
  * @secure
4883
5334
  */
4884
5335
  eventSourcesDeleteScheduledEvent: (data: EventSourcesDeleteScheduledEventRequest, params?: RequestParams) => Promise<AxiosResponse<void, any>>;
5336
+ /**
5337
+ * @description Creates a new group. A group is a collection of users.
5338
+ *
5339
+ * @tags groups
5340
+ * @name GroupsCreate
5341
+ * @request POST:/groups.create
5342
+ * @secure
5343
+ */
5344
+ groupsCreate: (data: GroupsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<GroupsCreateResponse, any>>;
5345
+ /**
5346
+ * @description Gets the requested group.
5347
+ *
5348
+ * @tags groups
5349
+ * @name GroupsGet
5350
+ * @request GET:/groups.get
5351
+ * @secure
5352
+ */
5353
+ groupsGet: (query: {
5354
+ /** The ID of the group to get. */
5355
+ id: string;
5356
+ }, params?: RequestParams) => Promise<AxiosResponse<GroupsGetResponse, any>>;
5357
+ /**
5358
+ * @description Gets the requested group.
5359
+ *
5360
+ * @tags groups
5361
+ * @name GroupsGetPost
5362
+ * @request POST:/groups.get
5363
+ * @secure
5364
+ */
5365
+ groupsGetPost: (data: GroupsGetRequest, params?: RequestParams) => Promise<AxiosResponse<GroupsGetResponse, any>>;
5366
+ /**
5367
+ * @description Lists the available groups.
5368
+ *
5369
+ * @tags groups
5370
+ * @name GroupsList
5371
+ * @request GET:/groups.list
5372
+ * @secure
5373
+ */
5374
+ groupsList: (query?: {
5375
+ /**
5376
+ * The cursor to resume iteration from. If not provided, then iteration
5377
+ * starts from the beginning.
5378
+ */
5379
+ cursor?: string;
5380
+ /**
5381
+ * The maximum number of groups to return. The default is '50'.
5382
+ * @format int32
5383
+ */
5384
+ limit?: number;
5385
+ /** Filters the groups on basis of member type. */
5386
+ member_type?: GroupMemberType[];
5387
+ /**
5388
+ * The iteration mode to use, otherwise if not set, then "after" is
5389
+ * used.
5390
+ */
5391
+ mode?: ListMode;
5392
+ /** Comma-separated fields to sort the groups by. */
5393
+ sort_by?: string[];
5394
+ }, params?: RequestParams) => Promise<AxiosResponse<GroupsListResponse, any>>;
5395
+ /**
5396
+ * @description Lists the available groups.
5397
+ *
5398
+ * @tags groups
5399
+ * @name GroupsListPost
5400
+ * @request POST:/groups.list
5401
+ * @secure
5402
+ */
5403
+ groupsListPost: (data: GroupsListRequest, params?: RequestParams) => Promise<AxiosResponse<GroupsListResponse, any>>;
5404
+ /**
5405
+ * @description Updates the requested group.
5406
+ *
5407
+ * @tags groups
5408
+ * @name GroupsUpdate
5409
+ * @request POST:/groups.update
5410
+ * @secure
5411
+ */
5412
+ groupsUpdate: (data: GroupsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<GroupsUpdateResponse, any>>;
4885
5413
  /**
4886
5414
  * @description Creates a link between two objects to indicate a relationship.
4887
5415
  *
@@ -5189,6 +5717,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
5189
5717
  * @secure
5190
5718
  */
5191
5719
  revOrgsList: (query?: {
5720
+ /**
5721
+ * Filters by account.
5722
+ * @example ["don:core:<partition>:devo/<dev-org-id>:account/<account-id>"]
5723
+ */
5724
+ account?: string[];
5192
5725
  /** Filters by creator. */
5193
5726
  created_by?: string[];
5194
5727
  /**
@@ -5707,6 +6240,13 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
5707
6240
  * starts from the beginning.
5708
6241
  */
5709
6242
  cursor?: string;
6243
+ /**
6244
+ * Filters for entries containing at least one of the provided labels,
6245
+ * otherwise if no labels are provided, then no label filtering is done.
6246
+ * @minLength 1
6247
+ * @maxLength 64
6248
+ */
6249
+ labels?: string[];
5710
6250
  /**
5711
6251
  * The maximum number of entries to return. If not set, then this
5712
6252
  * defaults to `50`.
@@ -5734,6 +6274,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
5734
6274
  * @secure
5735
6275
  */
5736
6276
  timelineEntriesListPost: (data: TimelineEntriesListRequest, params?: RequestParams) => Promise<AxiosResponse<TimelineEntriesListResponse, any>>;
6277
+ /**
6278
+ * @description Updates an entry on an object's timeline.
6279
+ *
6280
+ * @tags timeline-entries
6281
+ * @name TimelineEntriesUpdate
6282
+ * @request POST:/timeline-entries.update
6283
+ * @secure
6284
+ */
6285
+ timelineEntriesUpdate: (data: TimelineEntriesUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<TimelineEntriesUpdateResponse, any>>;
5737
6286
  /**
5738
6287
  * @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.
5739
6288
  *
@@ -5800,8 +6349,10 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
5800
6349
  owned_by?: string[];
5801
6350
  /** Fields to sort the work items by and the direction to sort them. */
5802
6351
  sort_by?: string[];
5803
- /** Filters for records in the provided stage(s). */
6352
+ /** Filters for records in the provided stage(s) by name. */
5804
6353
  'stage.name'?: string[];
6354
+ /** Filters for records in the provided stage(s) by ordinal. */
6355
+ 'stage.ordinal'?: number[];
5805
6356
  /** Filters for tickets belonging to specific groups. */
5806
6357
  'ticket.group'?: string[];
5807
6358
  /** Filters for tickets that are spam. */
@@ -5911,8 +6462,10 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
5911
6462
  owned_by?: string[];
5912
6463
  /** Fields to sort the works by and the direction to sort them. */
5913
6464
  sort_by?: string[];
5914
- /** Filters for records in the provided stage(s). */
6465
+ /** Filters for records in the provided stage(s) by name. */
5915
6466
  'stage.name'?: string[];
6467
+ /** Filters for records in the provided stage(s) by ordinal. */
6468
+ 'stage.ordinal'?: number[];
5916
6469
  /** Filters for tickets belonging to specific groups. */
5917
6470
  'ticket.group'?: string[];
5918
6471
  /** Filters for tickets that are spam. */
@@ -33,8 +33,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
33
33
  return (mod && mod.__esModule) ? mod : { "default": mod };
34
34
  };
35
35
  Object.defineProperty(exports, "__esModule", { value: true });
36
- exports.HttpClient = exports.ContentType = exports.WorkType = exports.UserType = exports.UserState = exports.TimelineEntryVisibility = exports.TimelineEntryType = exports.TimelineEntryObjectType = exports.TimelineEntriesCreateRequestType = exports.TimelineEntriesCollection = exports.TimelineCommentBodyType = exports.TicketSeverity = exports.TaskPriority = exports.SlaStatus = exports.SlaSelectorSeverity = exports.SlaSelectorPriority = exports.SlaSelectorAppliesTo = exports.SlaEvaluationPeriod = exports.SchemaFieldDescriptorFieldType = exports.SchemaFieldDescriptorArrayTypeBaseType = exports.PartType = exports.OrgType = exports.OrgScheduleStatus = exports.OrgScheduleFragmentStatus = exports.OrgEnvironment = exports.OpportunityPriority = exports.OpportunityForecastCategory = exports.MetricDefinitionMetricType = exports.MetricDefinitionAppliesTo = exports.ListMode = exports.LinksDirection = exports.LinkType = exports.LinkEndpointType = exports.IssuePriority = exports.ErrorUnauthorizedType = exports.ErrorTooManyRequestsType = exports.ErrorServiceUnavailableType = exports.ErrorNotFoundType = exports.ErrorInternalServerErrorType = exports.ErrorForbiddenType = exports.ErrorBadRequestType = exports.EngagementsCreateRequestEngagementType = exports.EngagementType = exports.DateTimePresetType = exports.DateFilterType = exports.CustomSchemaFragmentsSetRequestType = exports.CustomSchemaFragmentType = exports.ConversationsCreateRequestTypeValue = exports.ArticleStatus = exports.AccessLevel = void 0;
37
- exports.Api = void 0;
36
+ exports.UserType = exports.UserState = exports.TimelineEntryVisibility = exports.TimelineEntryType = exports.TimelineEntryObjectType = exports.TimelineEntriesUpdateRequestType = exports.TimelineEntriesCreateRequestType = exports.TimelineEntriesCollection = exports.TimelineCommentBodyType = exports.TicketSeverity = exports.TaskPriority = exports.SlaStatus = exports.SlaSelectorSeverity = exports.SlaSelectorPriority = exports.SlaSelectorAppliesTo = exports.SlaEvaluationPeriod = exports.SchemaFieldDescriptorFieldType = exports.SchemaFieldDescriptorArrayTypeBaseType = exports.PartType = exports.OrgType = exports.OrgScheduleStatus = exports.OrgScheduleFragmentStatus = exports.OrgEnvironment = exports.OpportunityPriority = exports.OpportunityForecastCategory = exports.MetricDefinitionMetricType = exports.MetricDefinitionAppliesTo = exports.ListMode = exports.LinksDirection = exports.LinkType = exports.LinkEndpointType = exports.IssuePriority = exports.GroupMemberType = exports.EventSourceStatus = exports.ErrorUnauthorizedType = exports.ErrorTooManyRequestsType = exports.ErrorServiceUnavailableType = exports.ErrorNotFoundType = exports.ErrorInternalServerErrorType = exports.ErrorForbiddenType = exports.ErrorBadRequestType = exports.EngagementsCreateRequestEngagementType = exports.EngagementType = exports.DateTimePresetType = exports.DateFilterType = exports.CustomSchemaFragmentsSetRequestType = exports.CustomSchemaFragmentType = exports.ConversationsCreateRequestTypeValue = exports.ArticleStatus = exports.AccessLevel = void 0;
37
+ exports.Api = exports.HttpClient = exports.ContentType = exports.WorkType = void 0;
38
38
  var AccessLevel;
39
39
  (function (AccessLevel) {
40
40
  AccessLevel["External"] = "external";
@@ -132,6 +132,22 @@ var ErrorUnauthorizedType;
132
132
  (function (ErrorUnauthorizedType) {
133
133
  ErrorUnauthorizedType["Unauthenticated"] = "unauthenticated";
134
134
  })(ErrorUnauthorizedType = exports.ErrorUnauthorizedType || (exports.ErrorUnauthorizedType = {}));
135
+ /**
136
+ * Status of the event source. Note that paused/blocked event sources
137
+ * return NotFound error on triggering.
138
+ */
139
+ var EventSourceStatus;
140
+ (function (EventSourceStatus) {
141
+ EventSourceStatus["Active"] = "active";
142
+ EventSourceStatus["Blocked"] = "blocked";
143
+ EventSourceStatus["Paused"] = "paused";
144
+ })(EventSourceStatus = exports.EventSourceStatus || (exports.EventSourceStatus = {}));
145
+ /** Type of the members in the group. */
146
+ var GroupMemberType;
147
+ (function (GroupMemberType) {
148
+ GroupMemberType["DevUser"] = "dev_user";
149
+ GroupMemberType["RevUser"] = "rev_user";
150
+ })(GroupMemberType = exports.GroupMemberType || (exports.GroupMemberType = {}));
135
151
  /** Priority of the work based upon impact and criticality. */
136
152
  var IssuePriority;
137
153
  (function (IssuePriority) {
@@ -372,15 +388,21 @@ var TimelineEntriesCreateRequestType;
372
388
  (function (TimelineEntriesCreateRequestType) {
373
389
  TimelineEntriesCreateRequestType["TimelineComment"] = "timeline_comment";
374
390
  })(TimelineEntriesCreateRequestType = exports.TimelineEntriesCreateRequestType || (exports.TimelineEntriesCreateRequestType = {}));
391
+ var TimelineEntriesUpdateRequestType;
392
+ (function (TimelineEntriesUpdateRequestType) {
393
+ TimelineEntriesUpdateRequestType["TimelineComment"] = "timeline_comment";
394
+ })(TimelineEntriesUpdateRequestType = exports.TimelineEntriesUpdateRequestType || (exports.TimelineEntriesUpdateRequestType = {}));
375
395
  /** The type of object that the Timeline entry belongs to. */
376
396
  var TimelineEntryObjectType;
377
397
  (function (TimelineEntryObjectType) {
378
398
  TimelineEntryObjectType["Account"] = "account";
379
399
  TimelineEntryObjectType["Capability"] = "capability";
380
400
  TimelineEntryObjectType["Conversation"] = "conversation";
401
+ TimelineEntryObjectType["Engagement"] = "engagement";
381
402
  TimelineEntryObjectType["Enhancement"] = "enhancement";
382
403
  TimelineEntryObjectType["Feature"] = "feature";
383
404
  TimelineEntryObjectType["Issue"] = "issue";
405
+ TimelineEntryObjectType["Meeting"] = "meeting";
384
406
  TimelineEntryObjectType["Opportunity"] = "opportunity";
385
407
  TimelineEntryObjectType["Product"] = "product";
386
408
  TimelineEntryObjectType["RevOrg"] = "rev_org";
@@ -412,6 +434,7 @@ var UserState;
412
434
  (function (UserState) {
413
435
  UserState["Active"] = "active";
414
436
  UserState["Deactivated"] = "deactivated";
437
+ UserState["Deleted"] = "deleted";
415
438
  UserState["Locked"] = "locked";
416
439
  UserState["Shadow"] = "shadow";
417
440
  UserState["Unassigned"] = "unassigned";
@@ -520,6 +543,24 @@ class Api extends HttpClient {
520
543
  * @secure
521
544
  */
522
545
  this.accountsCreate = (data, params = {}) => this.request(Object.assign({ path: `/accounts.create`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
546
+ /**
547
+ * @description Fetches account's default Rev organization.
548
+ *
549
+ * @tags accounts
550
+ * @name GetAccountsDefaultRevOrg
551
+ * @request GET:/accounts.default-rev-org.get
552
+ * @secure
553
+ */
554
+ this.getAccountsDefaultRevOrg = (query, params = {}) => this.request(Object.assign({ path: `/accounts.default-rev-org.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
555
+ /**
556
+ * @description Fetches account's default Rev organization.
557
+ *
558
+ * @tags accounts
559
+ * @name GetAccountsDefaultRevOrgPost
560
+ * @request POST:/accounts.default-rev-org.get
561
+ * @secure
562
+ */
563
+ this.getAccountsDefaultRevOrgPost = (data, params = {}) => this.request(Object.assign({ path: `/accounts.default-rev-org.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
523
564
  /**
524
565
  * @description Deletes an account.
525
566
  *
@@ -627,7 +668,7 @@ class Api extends HttpClient {
627
668
  * @request POST:/articles.delete
628
669
  * @secure
629
670
  */
630
- this.deleteArticle = (data, params = {}) => this.request(Object.assign({ path: `/articles.delete`, method: 'POST', body: data, secure: true, type: ContentType.Json }, params));
671
+ this.deleteArticle = (data, params = {}) => this.request(Object.assign({ path: `/articles.delete`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
631
672
  /**
632
673
  * @description Gets an article.
633
674
  *
@@ -835,6 +876,24 @@ class Api extends HttpClient {
835
876
  * @secure
836
877
  */
837
878
  this.engagementsUpdate = (data, params = {}) => this.request(Object.assign({ path: `/engagements.update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
879
+ /**
880
+ * @description Gets an event source.
881
+ *
882
+ * @tags event-source
883
+ * @name EventSourcesGet
884
+ * @request GET:/event-sources.get
885
+ * @secure
886
+ */
887
+ this.eventSourcesGet = (query, params = {}) => this.request(Object.assign({ path: `/event-sources.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
888
+ /**
889
+ * @description Gets an event source.
890
+ *
891
+ * @tags event-source
892
+ * @name EventSourcesGetPost
893
+ * @request POST:/event-sources.get
894
+ * @secure
895
+ */
896
+ this.eventSourcesGetPost = (data, params = {}) => this.request(Object.assign({ path: `/event-sources.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
838
897
  /**
839
898
  * @description Schedules an event to be published to the specified event source.
840
899
  *
@@ -853,6 +912,60 @@ class Api extends HttpClient {
853
912
  * @secure
854
913
  */
855
914
  this.eventSourcesDeleteScheduledEvent = (data, params = {}) => this.request(Object.assign({ path: `/event-sources.unschedule`, method: 'POST', body: data, secure: true, type: ContentType.Json }, params));
915
+ /**
916
+ * @description Creates a new group. A group is a collection of users.
917
+ *
918
+ * @tags groups
919
+ * @name GroupsCreate
920
+ * @request POST:/groups.create
921
+ * @secure
922
+ */
923
+ this.groupsCreate = (data, params = {}) => this.request(Object.assign({ path: `/groups.create`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
924
+ /**
925
+ * @description Gets the requested group.
926
+ *
927
+ * @tags groups
928
+ * @name GroupsGet
929
+ * @request GET:/groups.get
930
+ * @secure
931
+ */
932
+ this.groupsGet = (query, params = {}) => this.request(Object.assign({ path: `/groups.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
933
+ /**
934
+ * @description Gets the requested group.
935
+ *
936
+ * @tags groups
937
+ * @name GroupsGetPost
938
+ * @request POST:/groups.get
939
+ * @secure
940
+ */
941
+ this.groupsGetPost = (data, params = {}) => this.request(Object.assign({ path: `/groups.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
942
+ /**
943
+ * @description Lists the available groups.
944
+ *
945
+ * @tags groups
946
+ * @name GroupsList
947
+ * @request GET:/groups.list
948
+ * @secure
949
+ */
950
+ this.groupsList = (query, params = {}) => this.request(Object.assign({ path: `/groups.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
951
+ /**
952
+ * @description Lists the available groups.
953
+ *
954
+ * @tags groups
955
+ * @name GroupsListPost
956
+ * @request POST:/groups.list
957
+ * @secure
958
+ */
959
+ this.groupsListPost = (data, params = {}) => this.request(Object.assign({ path: `/groups.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
960
+ /**
961
+ * @description Updates the requested group.
962
+ *
963
+ * @tags groups
964
+ * @name GroupsUpdate
965
+ * @request POST:/groups.update
966
+ * @secure
967
+ */
968
+ this.groupsUpdate = (data, params = {}) => this.request(Object.assign({ path: `/groups.update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
856
969
  /**
857
970
  * @description Creates a link between two objects to indicate a relationship.
858
971
  *
@@ -1393,6 +1506,15 @@ class Api extends HttpClient {
1393
1506
  * @secure
1394
1507
  */
1395
1508
  this.timelineEntriesListPost = (data, params = {}) => this.request(Object.assign({ path: `/timeline-entries.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
1509
+ /**
1510
+ * @description Updates an entry on an object's timeline.
1511
+ *
1512
+ * @tags timeline-entries
1513
+ * @name TimelineEntriesUpdate
1514
+ * @request POST:/timeline-entries.update
1515
+ * @secure
1516
+ */
1517
+ this.timelineEntriesUpdate = (data, params = {}) => this.request(Object.assign({ path: `/timeline-entries.update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
1396
1518
  /**
1397
1519
  * @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.
1398
1520
  *
@@ -900,6 +900,11 @@ export declare enum PartType {
900
900
  }
901
901
  /** parts-create-request */
902
902
  export type PartsCreateRequest = (PartsCreateRequestCapability | PartsCreateRequestEnhancement | PartsCreateRequestFeature | PartsCreateRequestProduct) & {
903
+ /**
904
+ * The IDs of the artifacts.
905
+ * @example ["don:core:<partition>:devo/<dev-org-id>:artifact/<artifact-id>"]
906
+ */
907
+ artifacts?: string[];
903
908
  /** Description of the part. */
904
909
  description?: string;
905
910
  /** Name of the part. */
@@ -980,6 +985,7 @@ export interface PartsListResponse {
980
985
  }
981
986
  /** parts-update-request */
982
987
  export type PartsUpdateRequest = (PartsUpdateRequestCapability | PartsUpdateRequestEnhancement | PartsUpdateRequestFeature | PartsUpdateRequestProduct) & {
988
+ artifacts?: PartsUpdateRequestArtifacts;
983
989
  /** The updated description of the part. */
984
990
  description?: string;
985
991
  /**
@@ -992,6 +998,14 @@ export type PartsUpdateRequest = (PartsUpdateRequestCapability | PartsUpdateRequ
992
998
  owned_by?: PartsUpdateRequestOwnedBy;
993
999
  type: PartType;
994
1000
  };
1001
+ /** parts-update-request-artifacts */
1002
+ export interface PartsUpdateRequestArtifacts {
1003
+ /**
1004
+ * Sets the artifacts to the provided IDs.
1005
+ * @example ["don:core:<partition>:devo/<dev-org-id>:artifact/<artifact-id>"]
1006
+ */
1007
+ set?: string[];
1008
+ }
995
1009
  /** parts-update-request-capability */
996
1010
  export type PartsUpdateRequestCapability = object;
997
1011
  /** parts-update-request-enhancement */
@@ -1622,6 +1636,7 @@ export type UserBaseSummary = AtomBaseSummary & {
1622
1636
  export declare enum UserState {
1623
1637
  Active = "active",
1624
1638
  Deactivated = "deactivated",
1639
+ Deleted = "deleted",
1625
1640
  Locked = "locked",
1626
1641
  Shadow = "shadow",
1627
1642
  Unassigned = "unassigned"
@@ -2759,8 +2774,10 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
2759
2774
  * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
2760
2775
  */
2761
2776
  owned_by?: string[];
2762
- /** Filters for records in the provided stage(s). */
2777
+ /** Filters for records in the provided stage(s) by name. */
2763
2778
  'stage.name'?: string[];
2779
+ /** Filters for records in the provided stage(s) by ordinal. */
2780
+ 'stage.ordinal'?: number[];
2764
2781
  /** Filters for tickets belonging to specific groups. */
2765
2782
  'ticket.group'?: string[];
2766
2783
  /** Filters for tickets that are spam. */
@@ -2841,8 +2858,10 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
2841
2858
  * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
2842
2859
  */
2843
2860
  owned_by?: string[];
2844
- /** Filters for records in the provided stage(s). */
2861
+ /** Filters for records in the provided stage(s) by name. */
2845
2862
  'stage.name'?: string[];
2863
+ /** Filters for records in the provided stage(s) by ordinal. */
2864
+ 'stage.ordinal'?: number[];
2846
2865
  /** Filters for tickets belonging to specific groups. */
2847
2866
  'ticket.group'?: string[];
2848
2867
  /** Filters for tickets that are spam. */
@@ -247,6 +247,7 @@ var UserState;
247
247
  (function (UserState) {
248
248
  UserState["Active"] = "active";
249
249
  UserState["Deactivated"] = "deactivated";
250
+ UserState["Deleted"] = "deleted";
250
251
  UserState["Locked"] = "locked";
251
252
  UserState["Shadow"] = "shadow";
252
253
  UserState["Unassigned"] = "unassigned";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@devrev/typescript-sdk",
3
- "version": "1.1.7",
3
+ "version": "1.1.9",
4
4
  "description": "## SDK Generation",
5
5
  "main": "./dist/index.js",
6
6
  "scripts": {