@devrev/typescript-sdk 1.1.8 → 1.1.10
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
|
/**
|
|
@@ -42,6 +44,11 @@ export type AccountSummary = OrgBaseSummary;
|
|
|
42
44
|
* Request object to create a new account in the Dev organization.
|
|
43
45
|
*/
|
|
44
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[];
|
|
45
52
|
/** Application-defined custom fields. */
|
|
46
53
|
custom_fields?: object;
|
|
47
54
|
/** Description of the account. */
|
|
@@ -210,6 +217,7 @@ export interface AccountsListResponse {
|
|
|
210
217
|
* Request to update details of the account.
|
|
211
218
|
*/
|
|
212
219
|
export interface AccountsUpdateRequest {
|
|
220
|
+
artifacts?: AccountsUpdateRequestArtifacts;
|
|
213
221
|
/** Application-defined custom fields. */
|
|
214
222
|
custom_fields?: object;
|
|
215
223
|
/** Updated description of the account. */
|
|
@@ -240,6 +248,14 @@ export interface AccountsUpdateRequest {
|
|
|
240
248
|
/** Updated tier of the account. */
|
|
241
249
|
tier?: string;
|
|
242
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
|
+
}
|
|
243
259
|
/**
|
|
244
260
|
* accounts-update-response
|
|
245
261
|
* Updated account object.
|
|
@@ -270,6 +286,8 @@ export interface AggregatedSchemaGetResponse {
|
|
|
270
286
|
export type AppFragment = CustomSchemaFragmentBase;
|
|
271
287
|
/** article */
|
|
272
288
|
export type Article = AtomBase & {
|
|
289
|
+
/** Details of the parts relevant to the article. */
|
|
290
|
+
applies_to_parts: PartSummary[];
|
|
273
291
|
/** Description of the article. */
|
|
274
292
|
description?: string;
|
|
275
293
|
/** Artifacts containing the extracted content. */
|
|
@@ -559,6 +577,38 @@ export interface ArticlesUpdateResponse {
|
|
|
559
577
|
}
|
|
560
578
|
/** artifact-summary */
|
|
561
579
|
export type ArtifactSummary = AtomBaseSummary;
|
|
580
|
+
/**
|
|
581
|
+
* artifacts-prepare-request
|
|
582
|
+
* The request to prepare a URL to upload a file.
|
|
583
|
+
*/
|
|
584
|
+
export interface ArtifactsPrepareRequest {
|
|
585
|
+
/** The name of the file that's being uploaded. */
|
|
586
|
+
file_name: string;
|
|
587
|
+
/** The type of file that's being uploaded. */
|
|
588
|
+
file_type?: string;
|
|
589
|
+
}
|
|
590
|
+
/**
|
|
591
|
+
* artifacts-prepare-response
|
|
592
|
+
* The response to preparing a URL to upload a file.
|
|
593
|
+
*/
|
|
594
|
+
export interface ArtifactsPrepareResponse {
|
|
595
|
+
/** The POST policy form data. */
|
|
596
|
+
form_data: ArtifactsPrepareResponseFormData[];
|
|
597
|
+
/**
|
|
598
|
+
* The generated artifact's ID.
|
|
599
|
+
* @example "don:core:<partition>:devo/<dev-org-id>:artifact/<artifact-id>"
|
|
600
|
+
*/
|
|
601
|
+
id: string;
|
|
602
|
+
/** The URL that the file's data should be uploaded to. */
|
|
603
|
+
url: string;
|
|
604
|
+
}
|
|
605
|
+
/** artifacts-prepare-response-form-data */
|
|
606
|
+
export interface ArtifactsPrepareResponseFormData {
|
|
607
|
+
/** Key of the form field. */
|
|
608
|
+
key: string;
|
|
609
|
+
/** Value corresponding to the key. */
|
|
610
|
+
value: string;
|
|
611
|
+
}
|
|
562
612
|
/** atom-base */
|
|
563
613
|
export interface AtomBase {
|
|
564
614
|
created_by?: UserSummary;
|
|
@@ -732,9 +782,12 @@ export interface ConversationsExportRequest {
|
|
|
732
782
|
stage?: StageFilter;
|
|
733
783
|
/**
|
|
734
784
|
* Filters for conversations with any of the provided tags.
|
|
785
|
+
* @deprecated
|
|
735
786
|
* @example ["don:core:<partition>:devo/<dev-org-id>:tag/<tag-id>"]
|
|
736
787
|
*/
|
|
737
788
|
tags?: string[];
|
|
789
|
+
/** Filters for conversations with any of the provided tags with value. */
|
|
790
|
+
tags_v2?: TagWithValueFilter[];
|
|
738
791
|
}
|
|
739
792
|
/** conversations-export-response */
|
|
740
793
|
export interface ConversationsExportResponse {
|
|
@@ -814,9 +867,12 @@ export interface ConversationsListRequest {
|
|
|
814
867
|
stage?: StageFilter;
|
|
815
868
|
/**
|
|
816
869
|
* Filters for conversations with any of the provided tags.
|
|
870
|
+
* @deprecated
|
|
817
871
|
* @example ["don:core:<partition>:devo/<dev-org-id>:tag/<tag-id>"]
|
|
818
872
|
*/
|
|
819
873
|
tags?: string[];
|
|
874
|
+
/** Filters for conversations with any of the provided tags with value. */
|
|
875
|
+
tags_v2?: TagWithValueFilter[];
|
|
820
876
|
}
|
|
821
877
|
/**
|
|
822
878
|
* conversations-list-response
|
|
@@ -1531,27 +1587,131 @@ export type FeatureSummary = PartBaseSummary;
|
|
|
1531
1587
|
* Set of field attributes.
|
|
1532
1588
|
*/
|
|
1533
1589
|
export type FieldDescriptor = object;
|
|
1590
|
+
/** group */
|
|
1591
|
+
export type Group = AtomBase & {
|
|
1592
|
+
/** Description of the group. */
|
|
1593
|
+
description?: string;
|
|
1594
|
+
/** Whether it is a default group. */
|
|
1595
|
+
is_default: boolean;
|
|
1596
|
+
/** Type of the members in the group. */
|
|
1597
|
+
member_type?: GroupMemberType;
|
|
1598
|
+
/** Name of the group. */
|
|
1599
|
+
name?: string;
|
|
1600
|
+
owner?: UserSummary;
|
|
1601
|
+
};
|
|
1602
|
+
/** Type of the members in the group. */
|
|
1603
|
+
export declare enum GroupMemberType {
|
|
1604
|
+
DevUser = "dev_user",
|
|
1605
|
+
RevUser = "rev_user"
|
|
1606
|
+
}
|
|
1607
|
+
/** group-summary */
|
|
1608
|
+
export type GroupSummary = AtomBaseSummary & {
|
|
1609
|
+
/** Name of the group. */
|
|
1610
|
+
name?: string;
|
|
1611
|
+
};
|
|
1612
|
+
/**
|
|
1613
|
+
* groups-create-request
|
|
1614
|
+
* A request to create a new group.
|
|
1615
|
+
*/
|
|
1616
|
+
export interface GroupsCreateRequest {
|
|
1617
|
+
/** Description of the group. */
|
|
1618
|
+
description: string;
|
|
1619
|
+
/** Type of the members in the group. */
|
|
1620
|
+
member_type?: GroupMemberType;
|
|
1621
|
+
/** Unique name of the group. */
|
|
1622
|
+
name: string;
|
|
1623
|
+
/** Owner of the group. */
|
|
1624
|
+
owner?: string;
|
|
1625
|
+
}
|
|
1626
|
+
/**
|
|
1627
|
+
* groups-create-response
|
|
1628
|
+
* The response to group creation.
|
|
1629
|
+
*/
|
|
1630
|
+
export interface GroupsCreateResponse {
|
|
1631
|
+
group: Group;
|
|
1632
|
+
}
|
|
1633
|
+
/**
|
|
1634
|
+
* groups-get-request
|
|
1635
|
+
* A request to get information about a group.
|
|
1636
|
+
*/
|
|
1637
|
+
export interface GroupsGetRequest {
|
|
1638
|
+
/** The ID of the group to get. */
|
|
1639
|
+
id: string;
|
|
1640
|
+
}
|
|
1641
|
+
/**
|
|
1642
|
+
* groups-get-response
|
|
1643
|
+
* The response to getting the group.
|
|
1644
|
+
*/
|
|
1645
|
+
export interface GroupsGetResponse {
|
|
1646
|
+
group: Group;
|
|
1647
|
+
}
|
|
1534
1648
|
/**
|
|
1535
|
-
*
|
|
1536
|
-
*
|
|
1649
|
+
* groups-list-request
|
|
1650
|
+
* A request to get information about a list of groups.
|
|
1537
1651
|
*/
|
|
1538
|
-
export interface
|
|
1652
|
+
export interface GroupsListRequest {
|
|
1539
1653
|
/**
|
|
1540
|
-
* The
|
|
1541
|
-
*
|
|
1542
|
-
|
|
1654
|
+
* The cursor to resume iteration from. If not provided, then
|
|
1655
|
+
* iteration starts from the beginning.
|
|
1656
|
+
*/
|
|
1657
|
+
cursor?: string;
|
|
1658
|
+
/**
|
|
1659
|
+
* The maximum number of groups to return. The default is '50'.
|
|
1660
|
+
* @format int32
|
|
1661
|
+
*/
|
|
1662
|
+
limit?: number;
|
|
1663
|
+
/** Filters the groups on basis of member type. */
|
|
1664
|
+
member_type?: GroupMemberType[];
|
|
1665
|
+
/**
|
|
1666
|
+
* The iteration mode to use. If "after", then entries after the provided
|
|
1667
|
+
* cursor will be returned, or if no cursor is provided, then from the
|
|
1668
|
+
* beginning. If "before", then entries before the provided cursor will be
|
|
1669
|
+
* returned, or if no cursor is provided, then from the end. Entries will
|
|
1670
|
+
* always be returned in the specified sort-by order.
|
|
1671
|
+
*/
|
|
1672
|
+
mode?: ListMode;
|
|
1673
|
+
/** Comma-separated fields to sort the groups by. */
|
|
1674
|
+
sort_by?: string[];
|
|
1675
|
+
}
|
|
1676
|
+
/**
|
|
1677
|
+
* groups-list-response
|
|
1678
|
+
* The response to listing the groups.
|
|
1679
|
+
*/
|
|
1680
|
+
export interface GroupsListResponse {
|
|
1681
|
+
/** The list of groups. */
|
|
1682
|
+
groups: Group[];
|
|
1683
|
+
/**
|
|
1684
|
+
* The cursor used to iterate subsequent results in accordance to the
|
|
1685
|
+
* sort order. If not set, then no later elements exist.
|
|
1686
|
+
*/
|
|
1687
|
+
next_cursor?: string;
|
|
1688
|
+
/**
|
|
1689
|
+
* The cursor used to iterate preceding results in accordance to the
|
|
1690
|
+
* sort order. If not set, then no prior elements exist.
|
|
1543
1691
|
*/
|
|
1692
|
+
prev_cursor?: string;
|
|
1693
|
+
}
|
|
1694
|
+
/**
|
|
1695
|
+
* groups-update-request
|
|
1696
|
+
* A request to update a group.
|
|
1697
|
+
*/
|
|
1698
|
+
export interface GroupsUpdateRequest {
|
|
1699
|
+
/** The updated group's description. */
|
|
1700
|
+
description?: string;
|
|
1701
|
+
/** The ID of the group to update. */
|
|
1544
1702
|
id: string;
|
|
1703
|
+
/** The updated group's name. */
|
|
1704
|
+
name?: string;
|
|
1705
|
+
/** The updated group's owner. */
|
|
1706
|
+
owner?: string;
|
|
1545
1707
|
}
|
|
1546
1708
|
/**
|
|
1547
|
-
*
|
|
1548
|
-
*
|
|
1709
|
+
* groups-update-response
|
|
1710
|
+
* The response to group update.
|
|
1549
1711
|
*/
|
|
1550
|
-
export interface
|
|
1551
|
-
|
|
1712
|
+
export interface GroupsUpdateResponse {
|
|
1713
|
+
group: Group;
|
|
1552
1714
|
}
|
|
1553
|
-
/** group-summary */
|
|
1554
|
-
export type GroupSummary = AtomBaseSummary;
|
|
1555
1715
|
/** issue */
|
|
1556
1716
|
export type Issue = WorkBase & {
|
|
1557
1717
|
/** Priority of the work based upon impact and criticality. */
|
|
@@ -2190,6 +2350,8 @@ export interface Resource {
|
|
|
2190
2350
|
/** rev-org */
|
|
2191
2351
|
export type RevOrg = OrgBase & {
|
|
2192
2352
|
account?: AccountSummary;
|
|
2353
|
+
/** The artifacts attached to the Rev organization. */
|
|
2354
|
+
artifacts?: ArtifactSummary[];
|
|
2193
2355
|
/** Custom fields. */
|
|
2194
2356
|
custom_fields?: object;
|
|
2195
2357
|
/**
|
|
@@ -2227,6 +2389,11 @@ export interface RevOrgsCreateRequest {
|
|
|
2227
2389
|
* @example "don:core:<partition>:devo/<dev-org-id>:account/<account-id>"
|
|
2228
2390
|
*/
|
|
2229
2391
|
account?: string;
|
|
2392
|
+
/**
|
|
2393
|
+
* The IDs of the artifacts to associate with the Rev organization.
|
|
2394
|
+
* @example ["don:core:<partition>:devo/<dev-org-id>:artifact/<artifact-id>"]
|
|
2395
|
+
*/
|
|
2396
|
+
artifacts?: string[];
|
|
2230
2397
|
/** Application-defined custom fields. */
|
|
2231
2398
|
custom_fields?: object;
|
|
2232
2399
|
/**
|
|
@@ -2350,6 +2517,7 @@ export interface RevOrgsUpdateRequest {
|
|
|
2350
2517
|
* @example "don:core:<partition>:devo/<dev-org-id>:account/<account-id>"
|
|
2351
2518
|
*/
|
|
2352
2519
|
account?: string;
|
|
2520
|
+
artifacts?: RevOrgsUpdateRequestArtifacts;
|
|
2353
2521
|
/**
|
|
2354
2522
|
* Schema fragment IDs associated with this Rev organization.
|
|
2355
2523
|
* @example ["don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"]
|
|
@@ -2377,6 +2545,14 @@ export interface RevOrgsUpdateRequest {
|
|
|
2377
2545
|
/** The tier of the RevOrg. */
|
|
2378
2546
|
tier?: string;
|
|
2379
2547
|
}
|
|
2548
|
+
/** rev-orgs-update-request-artifacts */
|
|
2549
|
+
export interface RevOrgsUpdateRequestArtifacts {
|
|
2550
|
+
/**
|
|
2551
|
+
* Sets the IDs to the provided artifact IDs.
|
|
2552
|
+
* @example ["don:core:<partition>:devo/<dev-org-id>:artifact/<artifact-id>"]
|
|
2553
|
+
*/
|
|
2554
|
+
set?: string[];
|
|
2555
|
+
}
|
|
2380
2556
|
/**
|
|
2381
2557
|
* rev-orgs-update-response
|
|
2382
2558
|
* Response object to updating Rev organization's information.
|
|
@@ -2386,6 +2562,8 @@ export interface RevOrgsUpdateResponse {
|
|
|
2386
2562
|
}
|
|
2387
2563
|
/** rev-user */
|
|
2388
2564
|
export type RevUser = UserBase & {
|
|
2565
|
+
/** The artifacts attached to the Rev user. */
|
|
2566
|
+
artifacts?: ArtifactSummary[];
|
|
2389
2567
|
/** Custom fields. */
|
|
2390
2568
|
custom_fields?: object;
|
|
2391
2569
|
/**
|
|
@@ -2403,6 +2581,8 @@ export type RevUser = UserBase & {
|
|
|
2403
2581
|
* system-generated identifier will be assigned to the user.
|
|
2404
2582
|
*/
|
|
2405
2583
|
external_ref?: string;
|
|
2584
|
+
/** Whether the Rev user is verified or not. */
|
|
2585
|
+
is_verified?: boolean;
|
|
2406
2586
|
rev_org?: OrgSummary;
|
|
2407
2587
|
/**
|
|
2408
2588
|
* Stock schema fragment.
|
|
@@ -2427,6 +2607,11 @@ export type RevUserSummary = UserBaseSummary & {
|
|
|
2427
2607
|
* Request object to create a new Rev user for a Rev organization.
|
|
2428
2608
|
*/
|
|
2429
2609
|
export interface RevUsersCreateRequest {
|
|
2610
|
+
/**
|
|
2611
|
+
* The IDs of the artifacts to associate with the Rev user.
|
|
2612
|
+
* @example ["don:core:<partition>:devo/<dev-org-id>:artifact/<artifact-id>"]
|
|
2613
|
+
*/
|
|
2614
|
+
artifacts?: string[];
|
|
2430
2615
|
/** Application-defined custom fields. */
|
|
2431
2616
|
custom_fields?: object;
|
|
2432
2617
|
/**
|
|
@@ -2556,6 +2741,7 @@ export interface RevUsersListResponse {
|
|
|
2556
2741
|
* Request to update details of a Rev user.
|
|
2557
2742
|
*/
|
|
2558
2743
|
export interface RevUsersUpdateRequest {
|
|
2744
|
+
artifacts?: RevUsersUpdateRequestArtifacts;
|
|
2559
2745
|
/** Application-defined custom fields. */
|
|
2560
2746
|
custom_fields?: object;
|
|
2561
2747
|
custom_schema_fragments?: RevUsersUpdateRequestCustomSchemaFragments;
|
|
@@ -2570,6 +2756,14 @@ export interface RevUsersUpdateRequest {
|
|
|
2570
2756
|
/** The ID of Rev user to update. */
|
|
2571
2757
|
id: string;
|
|
2572
2758
|
}
|
|
2759
|
+
/** rev-users-update-request-artifacts */
|
|
2760
|
+
export interface RevUsersUpdateRequestArtifacts {
|
|
2761
|
+
/**
|
|
2762
|
+
* Sets the IDs to the provided artifact IDs.
|
|
2763
|
+
* @example ["don:core:<partition>:devo/<dev-org-id>:artifact/<artifact-id>"]
|
|
2764
|
+
*/
|
|
2765
|
+
set?: string[];
|
|
2766
|
+
}
|
|
2573
2767
|
/** rev-users-update-request-custom-schema-fragments */
|
|
2574
2768
|
export interface RevUsersUpdateRequestCustomSchemaFragments {
|
|
2575
2769
|
/**
|
|
@@ -3330,7 +3524,7 @@ export interface Stage {
|
|
|
3330
3524
|
* The filter for stages.
|
|
3331
3525
|
*/
|
|
3332
3526
|
export interface StageFilter {
|
|
3333
|
-
/** Filters for records in the provided stage(s). */
|
|
3527
|
+
/** Filters for records in the provided stage(s) by name. */
|
|
3334
3528
|
name?: string[];
|
|
3335
3529
|
}
|
|
3336
3530
|
/**
|
|
@@ -3473,6 +3667,19 @@ export interface TagWithValue {
|
|
|
3473
3667
|
/** The value for the object's association with the tag. */
|
|
3474
3668
|
value?: string;
|
|
3475
3669
|
}
|
|
3670
|
+
/** tag-with-value-filter */
|
|
3671
|
+
export interface TagWithValueFilter {
|
|
3672
|
+
/**
|
|
3673
|
+
* The ID of the tag.
|
|
3674
|
+
* @example "don:core:<partition>:devo/<dev-org-id>:tag/<tag-id>"
|
|
3675
|
+
*/
|
|
3676
|
+
id?: string;
|
|
3677
|
+
/**
|
|
3678
|
+
* The value for the object's association with the tag. If specified,
|
|
3679
|
+
* the value must be one that's specified in the tag's allowed values.
|
|
3680
|
+
*/
|
|
3681
|
+
value?: string;
|
|
3682
|
+
}
|
|
3476
3683
|
/** task */
|
|
3477
3684
|
export type Task = WorkBase;
|
|
3478
3685
|
/** Priority of the work based upon impact and criticality. */
|
|
@@ -4459,31 +4666,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
4459
4666
|
* @secure
|
|
4460
4667
|
*/
|
|
4461
4668
|
accountsCreate: (data: AccountsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<AccountsCreateResponse, any>>;
|
|
4462
|
-
/**
|
|
4463
|
-
* @description Fetches account's default Rev organization.
|
|
4464
|
-
*
|
|
4465
|
-
* @tags accounts
|
|
4466
|
-
* @name GetAccountsDefaultRevOrg
|
|
4467
|
-
* @request GET:/accounts.default-rev-org.get
|
|
4468
|
-
* @secure
|
|
4469
|
-
*/
|
|
4470
|
-
getAccountsDefaultRevOrg: (query: {
|
|
4471
|
-
/**
|
|
4472
|
-
* The ID of Account for which default Rev organization is to be
|
|
4473
|
-
* fetched.
|
|
4474
|
-
* @example "don:core:<partition>:devo/<dev-org-id>:account/<account-id>"
|
|
4475
|
-
*/
|
|
4476
|
-
id: string;
|
|
4477
|
-
}, params?: RequestParams) => Promise<AxiosResponse<GetAccountsDefaultRevOrgResponse, any>>;
|
|
4478
|
-
/**
|
|
4479
|
-
* @description Fetches account's default Rev organization.
|
|
4480
|
-
*
|
|
4481
|
-
* @tags accounts
|
|
4482
|
-
* @name GetAccountsDefaultRevOrgPost
|
|
4483
|
-
* @request POST:/accounts.default-rev-org.get
|
|
4484
|
-
* @secure
|
|
4485
|
-
*/
|
|
4486
|
-
getAccountsDefaultRevOrgPost: (data: GetAccountsDefaultRevOrgRequest, params?: RequestParams) => Promise<AxiosResponse<GetAccountsDefaultRevOrgResponse, any>>;
|
|
4487
4669
|
/**
|
|
4488
4670
|
* @description Deletes an account.
|
|
4489
4671
|
*
|
|
@@ -4803,6 +4985,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
4803
4985
|
* @secure
|
|
4804
4986
|
*/
|
|
4805
4987
|
updateArticle: (data: ArticlesUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<ArticlesUpdateResponse, any>>;
|
|
4988
|
+
/**
|
|
4989
|
+
* @description Creates an artifact and generates an upload URL for its data.
|
|
4990
|
+
*
|
|
4991
|
+
* @tags artifacts
|
|
4992
|
+
* @name ArtifactsPrepare
|
|
4993
|
+
* @request POST:/artifacts.prepare
|
|
4994
|
+
* @secure
|
|
4995
|
+
*/
|
|
4996
|
+
artifactsPrepare: (data: ArtifactsPrepareRequest, params?: RequestParams) => Promise<AxiosResponse<ArtifactsPrepareResponse, any>>;
|
|
4806
4997
|
/**
|
|
4807
4998
|
* @description Creates a conversation.
|
|
4808
4999
|
*
|
|
@@ -4865,13 +5056,24 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
4865
5056
|
rev_org?: string[];
|
|
4866
5057
|
/** Filters for conversations with any of the provided source channels. */
|
|
4867
5058
|
source_channels?: string[];
|
|
4868
|
-
/** Filters for records in the provided stage(s). */
|
|
5059
|
+
/** Filters for records in the provided stage(s) by name. */
|
|
4869
5060
|
'stage.name'?: string[];
|
|
4870
5061
|
/**
|
|
4871
5062
|
* Filters for conversations with any of the provided tags.
|
|
5063
|
+
* @deprecated
|
|
4872
5064
|
* @example ["don:core:<partition>:devo/<dev-org-id>:tag/<tag-id>"]
|
|
4873
5065
|
*/
|
|
4874
5066
|
tags?: string[];
|
|
5067
|
+
/**
|
|
5068
|
+
* The ID of the tag.
|
|
5069
|
+
* @example "don:core:<partition>:devo/<dev-org-id>:tag/<tag-id>"
|
|
5070
|
+
*/
|
|
5071
|
+
'tags_v2.id'?: string;
|
|
5072
|
+
/**
|
|
5073
|
+
* The value for the object's association with the tag. If specified,
|
|
5074
|
+
* the value must be one that's specified in the tag's allowed values.
|
|
5075
|
+
*/
|
|
5076
|
+
'tags_v2.value'?: string;
|
|
4875
5077
|
}, params?: RequestParams) => Promise<AxiosResponse<ConversationsExportResponse, any>>;
|
|
4876
5078
|
/**
|
|
4877
5079
|
* @description Exports a collection of conversation items.
|
|
@@ -4956,13 +5158,24 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
4956
5158
|
rev_org?: string[];
|
|
4957
5159
|
/** Filters for conversations with any of the provided source channels. */
|
|
4958
5160
|
source_channels?: string[];
|
|
4959
|
-
/** Filters for records in the provided stage(s). */
|
|
5161
|
+
/** Filters for records in the provided stage(s) by name. */
|
|
4960
5162
|
'stage.name'?: string[];
|
|
4961
5163
|
/**
|
|
4962
5164
|
* Filters for conversations with any of the provided tags.
|
|
5165
|
+
* @deprecated
|
|
4963
5166
|
* @example ["don:core:<partition>:devo/<dev-org-id>:tag/<tag-id>"]
|
|
4964
5167
|
*/
|
|
4965
5168
|
tags?: string[];
|
|
5169
|
+
/**
|
|
5170
|
+
* The ID of the tag.
|
|
5171
|
+
* @example "don:core:<partition>:devo/<dev-org-id>:tag/<tag-id>"
|
|
5172
|
+
*/
|
|
5173
|
+
'tags_v2.id'?: string;
|
|
5174
|
+
/**
|
|
5175
|
+
* The value for the object's association with the tag. If specified,
|
|
5176
|
+
* the value must be one that's specified in the tag's allowed values.
|
|
5177
|
+
*/
|
|
5178
|
+
'tags_v2.value'?: string;
|
|
4966
5179
|
}, params?: RequestParams) => Promise<AxiosResponse<ConversationsListResponse, any>>;
|
|
4967
5180
|
/**
|
|
4968
5181
|
* @description Lists the available conversations.
|
|
@@ -5152,6 +5365,83 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
5152
5365
|
* @secure
|
|
5153
5366
|
*/
|
|
5154
5367
|
eventSourcesDeleteScheduledEvent: (data: EventSourcesDeleteScheduledEventRequest, params?: RequestParams) => Promise<AxiosResponse<void, any>>;
|
|
5368
|
+
/**
|
|
5369
|
+
* @description Creates a new group. A group is a collection of users.
|
|
5370
|
+
*
|
|
5371
|
+
* @tags groups
|
|
5372
|
+
* @name GroupsCreate
|
|
5373
|
+
* @request POST:/groups.create
|
|
5374
|
+
* @secure
|
|
5375
|
+
*/
|
|
5376
|
+
groupsCreate: (data: GroupsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<GroupsCreateResponse, any>>;
|
|
5377
|
+
/**
|
|
5378
|
+
* @description Gets the requested group.
|
|
5379
|
+
*
|
|
5380
|
+
* @tags groups
|
|
5381
|
+
* @name GroupsGet
|
|
5382
|
+
* @request GET:/groups.get
|
|
5383
|
+
* @secure
|
|
5384
|
+
*/
|
|
5385
|
+
groupsGet: (query: {
|
|
5386
|
+
/** The ID of the group to get. */
|
|
5387
|
+
id: string;
|
|
5388
|
+
}, params?: RequestParams) => Promise<AxiosResponse<GroupsGetResponse, any>>;
|
|
5389
|
+
/**
|
|
5390
|
+
* @description Gets the requested group.
|
|
5391
|
+
*
|
|
5392
|
+
* @tags groups
|
|
5393
|
+
* @name GroupsGetPost
|
|
5394
|
+
* @request POST:/groups.get
|
|
5395
|
+
* @secure
|
|
5396
|
+
*/
|
|
5397
|
+
groupsGetPost: (data: GroupsGetRequest, params?: RequestParams) => Promise<AxiosResponse<GroupsGetResponse, any>>;
|
|
5398
|
+
/**
|
|
5399
|
+
* @description Lists the available groups.
|
|
5400
|
+
*
|
|
5401
|
+
* @tags groups
|
|
5402
|
+
* @name GroupsList
|
|
5403
|
+
* @request GET:/groups.list
|
|
5404
|
+
* @secure
|
|
5405
|
+
*/
|
|
5406
|
+
groupsList: (query?: {
|
|
5407
|
+
/**
|
|
5408
|
+
* The cursor to resume iteration from. If not provided, then iteration
|
|
5409
|
+
* starts from the beginning.
|
|
5410
|
+
*/
|
|
5411
|
+
cursor?: string;
|
|
5412
|
+
/**
|
|
5413
|
+
* The maximum number of groups to return. The default is '50'.
|
|
5414
|
+
* @format int32
|
|
5415
|
+
*/
|
|
5416
|
+
limit?: number;
|
|
5417
|
+
/** Filters the groups on basis of member type. */
|
|
5418
|
+
member_type?: GroupMemberType[];
|
|
5419
|
+
/**
|
|
5420
|
+
* The iteration mode to use, otherwise if not set, then "after" is
|
|
5421
|
+
* used.
|
|
5422
|
+
*/
|
|
5423
|
+
mode?: ListMode;
|
|
5424
|
+
/** Comma-separated fields to sort the groups by. */
|
|
5425
|
+
sort_by?: string[];
|
|
5426
|
+
}, params?: RequestParams) => Promise<AxiosResponse<GroupsListResponse, any>>;
|
|
5427
|
+
/**
|
|
5428
|
+
* @description Lists the available groups.
|
|
5429
|
+
*
|
|
5430
|
+
* @tags groups
|
|
5431
|
+
* @name GroupsListPost
|
|
5432
|
+
* @request POST:/groups.list
|
|
5433
|
+
* @secure
|
|
5434
|
+
*/
|
|
5435
|
+
groupsListPost: (data: GroupsListRequest, params?: RequestParams) => Promise<AxiosResponse<GroupsListResponse, any>>;
|
|
5436
|
+
/**
|
|
5437
|
+
* @description Updates the requested group.
|
|
5438
|
+
*
|
|
5439
|
+
* @tags groups
|
|
5440
|
+
* @name GroupsUpdate
|
|
5441
|
+
* @request POST:/groups.update
|
|
5442
|
+
* @secure
|
|
5443
|
+
*/
|
|
5444
|
+
groupsUpdate: (data: GroupsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<GroupsUpdateResponse, any>>;
|
|
5155
5445
|
/**
|
|
5156
5446
|
* @description Creates a link between two objects to indicate a relationship.
|
|
5157
5447
|
*
|
|
@@ -6091,7 +6381,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6091
6381
|
owned_by?: string[];
|
|
6092
6382
|
/** Fields to sort the work items by and the direction to sort them. */
|
|
6093
6383
|
sort_by?: string[];
|
|
6094
|
-
/** Filters for records in the provided stage(s). */
|
|
6384
|
+
/** Filters for records in the provided stage(s) by name. */
|
|
6095
6385
|
'stage.name'?: string[];
|
|
6096
6386
|
/** Filters for tickets belonging to specific groups. */
|
|
6097
6387
|
'ticket.group'?: string[];
|
|
@@ -6202,7 +6492,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6202
6492
|
owned_by?: string[];
|
|
6203
6493
|
/** Fields to sort the works by and the direction to sort them. */
|
|
6204
6494
|
sort_by?: string[];
|
|
6205
|
-
/** Filters for records in the provided stage(s). */
|
|
6495
|
+
/** Filters for records in the provided stage(s) by name. */
|
|
6206
6496
|
'stage.name'?: string[];
|
|
6207
6497
|
/** Filters for tickets belonging to specific groups. */
|
|
6208
6498
|
'ticket.group'?: string[];
|
|
@@ -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.
|
|
37
|
-
exports.Api = exports.HttpClient = exports.ContentType = 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";
|
|
@@ -142,6 +142,12 @@ var EventSourceStatus;
|
|
|
142
142
|
EventSourceStatus["Blocked"] = "blocked";
|
|
143
143
|
EventSourceStatus["Paused"] = "paused";
|
|
144
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 = {}));
|
|
145
151
|
/** Priority of the work based upon impact and criticality. */
|
|
146
152
|
var IssuePriority;
|
|
147
153
|
(function (IssuePriority) {
|
|
@@ -537,24 +543,6 @@ class Api extends HttpClient {
|
|
|
537
543
|
* @secure
|
|
538
544
|
*/
|
|
539
545
|
this.accountsCreate = (data, params = {}) => this.request(Object.assign({ path: `/accounts.create`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
540
|
-
/**
|
|
541
|
-
* @description Fetches account's default Rev organization.
|
|
542
|
-
*
|
|
543
|
-
* @tags accounts
|
|
544
|
-
* @name GetAccountsDefaultRevOrg
|
|
545
|
-
* @request GET:/accounts.default-rev-org.get
|
|
546
|
-
* @secure
|
|
547
|
-
*/
|
|
548
|
-
this.getAccountsDefaultRevOrg = (query, params = {}) => this.request(Object.assign({ path: `/accounts.default-rev-org.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
549
|
-
/**
|
|
550
|
-
* @description Fetches account's default Rev organization.
|
|
551
|
-
*
|
|
552
|
-
* @tags accounts
|
|
553
|
-
* @name GetAccountsDefaultRevOrgPost
|
|
554
|
-
* @request POST:/accounts.default-rev-org.get
|
|
555
|
-
* @secure
|
|
556
|
-
*/
|
|
557
|
-
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));
|
|
558
546
|
/**
|
|
559
547
|
* @description Deletes an account.
|
|
560
548
|
*
|
|
@@ -708,6 +696,15 @@ class Api extends HttpClient {
|
|
|
708
696
|
* @secure
|
|
709
697
|
*/
|
|
710
698
|
this.updateArticle = (data, params = {}) => this.request(Object.assign({ path: `/articles.update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
699
|
+
/**
|
|
700
|
+
* @description Creates an artifact and generates an upload URL for its data.
|
|
701
|
+
*
|
|
702
|
+
* @tags artifacts
|
|
703
|
+
* @name ArtifactsPrepare
|
|
704
|
+
* @request POST:/artifacts.prepare
|
|
705
|
+
* @secure
|
|
706
|
+
*/
|
|
707
|
+
this.artifactsPrepare = (data, params = {}) => this.request(Object.assign({ path: `/artifacts.prepare`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
711
708
|
/**
|
|
712
709
|
* @description Creates a conversation.
|
|
713
710
|
*
|
|
@@ -906,6 +903,60 @@ class Api extends HttpClient {
|
|
|
906
903
|
* @secure
|
|
907
904
|
*/
|
|
908
905
|
this.eventSourcesDeleteScheduledEvent = (data, params = {}) => this.request(Object.assign({ path: `/event-sources.unschedule`, method: 'POST', body: data, secure: true, type: ContentType.Json }, params));
|
|
906
|
+
/**
|
|
907
|
+
* @description Creates a new group. A group is a collection of users.
|
|
908
|
+
*
|
|
909
|
+
* @tags groups
|
|
910
|
+
* @name GroupsCreate
|
|
911
|
+
* @request POST:/groups.create
|
|
912
|
+
* @secure
|
|
913
|
+
*/
|
|
914
|
+
this.groupsCreate = (data, params = {}) => this.request(Object.assign({ path: `/groups.create`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
915
|
+
/**
|
|
916
|
+
* @description Gets the requested group.
|
|
917
|
+
*
|
|
918
|
+
* @tags groups
|
|
919
|
+
* @name GroupsGet
|
|
920
|
+
* @request GET:/groups.get
|
|
921
|
+
* @secure
|
|
922
|
+
*/
|
|
923
|
+
this.groupsGet = (query, params = {}) => this.request(Object.assign({ path: `/groups.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
924
|
+
/**
|
|
925
|
+
* @description Gets the requested group.
|
|
926
|
+
*
|
|
927
|
+
* @tags groups
|
|
928
|
+
* @name GroupsGetPost
|
|
929
|
+
* @request POST:/groups.get
|
|
930
|
+
* @secure
|
|
931
|
+
*/
|
|
932
|
+
this.groupsGetPost = (data, params = {}) => this.request(Object.assign({ path: `/groups.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
933
|
+
/**
|
|
934
|
+
* @description Lists the available groups.
|
|
935
|
+
*
|
|
936
|
+
* @tags groups
|
|
937
|
+
* @name GroupsList
|
|
938
|
+
* @request GET:/groups.list
|
|
939
|
+
* @secure
|
|
940
|
+
*/
|
|
941
|
+
this.groupsList = (query, params = {}) => this.request(Object.assign({ path: `/groups.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
942
|
+
/**
|
|
943
|
+
* @description Lists the available groups.
|
|
944
|
+
*
|
|
945
|
+
* @tags groups
|
|
946
|
+
* @name GroupsListPost
|
|
947
|
+
* @request POST:/groups.list
|
|
948
|
+
* @secure
|
|
949
|
+
*/
|
|
950
|
+
this.groupsListPost = (data, params = {}) => this.request(Object.assign({ path: `/groups.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
951
|
+
/**
|
|
952
|
+
* @description Updates the requested group.
|
|
953
|
+
*
|
|
954
|
+
* @tags groups
|
|
955
|
+
* @name GroupsUpdate
|
|
956
|
+
* @request POST:/groups.update
|
|
957
|
+
* @secure
|
|
958
|
+
*/
|
|
959
|
+
this.groupsUpdate = (data, params = {}) => this.request(Object.assign({ path: `/groups.update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
909
960
|
/**
|
|
910
961
|
* @description Creates a link between two objects to indicate a relationship.
|
|
911
962
|
*
|
|
@@ -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 */
|
|
@@ -2760,7 +2774,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2760
2774
|
* @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
|
|
2761
2775
|
*/
|
|
2762
2776
|
owned_by?: string[];
|
|
2763
|
-
/** Filters for records in the provided stage(s). */
|
|
2777
|
+
/** Filters for records in the provided stage(s) by name. */
|
|
2764
2778
|
'stage.name'?: string[];
|
|
2765
2779
|
/** Filters for tickets belonging to specific groups. */
|
|
2766
2780
|
'ticket.group'?: string[];
|
|
@@ -2842,7 +2856,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2842
2856
|
* @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
|
|
2843
2857
|
*/
|
|
2844
2858
|
owned_by?: string[];
|
|
2845
|
-
/** Filters for records in the provided stage(s). */
|
|
2859
|
+
/** Filters for records in the provided stage(s) by name. */
|
|
2846
2860
|
'stage.name'?: string[];
|
|
2847
2861
|
/** Filters for tickets belonging to specific groups. */
|
|
2848
2862
|
'ticket.group'?: string[];
|