@devrev/typescript-sdk 1.1.8 → 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
|
/**
|
|
@@ -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. */
|
|
@@ -1550,8 +1568,131 @@ export interface GetAccountsDefaultRevOrgRequest {
|
|
|
1550
1568
|
export interface GetAccountsDefaultRevOrgResponse {
|
|
1551
1569
|
rev_org: RevOrg;
|
|
1552
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
|
+
}
|
|
1553
1588
|
/** group-summary */
|
|
1554
|
-
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
|
+
}
|
|
1555
1696
|
/** issue */
|
|
1556
1697
|
export type Issue = WorkBase & {
|
|
1557
1698
|
/** Priority of the work based upon impact and criticality. */
|
|
@@ -2190,6 +2331,8 @@ export interface Resource {
|
|
|
2190
2331
|
/** rev-org */
|
|
2191
2332
|
export type RevOrg = OrgBase & {
|
|
2192
2333
|
account?: AccountSummary;
|
|
2334
|
+
/** The artifacts attached to the Rev organization. */
|
|
2335
|
+
artifacts?: ArtifactSummary[];
|
|
2193
2336
|
/** Custom fields. */
|
|
2194
2337
|
custom_fields?: object;
|
|
2195
2338
|
/**
|
|
@@ -2227,6 +2370,11 @@ export interface RevOrgsCreateRequest {
|
|
|
2227
2370
|
* @example "don:core:<partition>:devo/<dev-org-id>:account/<account-id>"
|
|
2228
2371
|
*/
|
|
2229
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[];
|
|
2230
2378
|
/** Application-defined custom fields. */
|
|
2231
2379
|
custom_fields?: object;
|
|
2232
2380
|
/**
|
|
@@ -2350,6 +2498,7 @@ export interface RevOrgsUpdateRequest {
|
|
|
2350
2498
|
* @example "don:core:<partition>:devo/<dev-org-id>:account/<account-id>"
|
|
2351
2499
|
*/
|
|
2352
2500
|
account?: string;
|
|
2501
|
+
artifacts?: RevOrgsUpdateRequestArtifacts;
|
|
2353
2502
|
/**
|
|
2354
2503
|
* Schema fragment IDs associated with this Rev organization.
|
|
2355
2504
|
* @example ["don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"]
|
|
@@ -2377,6 +2526,14 @@ export interface RevOrgsUpdateRequest {
|
|
|
2377
2526
|
/** The tier of the RevOrg. */
|
|
2378
2527
|
tier?: string;
|
|
2379
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
|
+
}
|
|
2380
2537
|
/**
|
|
2381
2538
|
* rev-orgs-update-response
|
|
2382
2539
|
* Response object to updating Rev organization's information.
|
|
@@ -2386,6 +2543,8 @@ export interface RevOrgsUpdateResponse {
|
|
|
2386
2543
|
}
|
|
2387
2544
|
/** rev-user */
|
|
2388
2545
|
export type RevUser = UserBase & {
|
|
2546
|
+
/** The artifacts attached to the Rev user. */
|
|
2547
|
+
artifacts?: ArtifactSummary[];
|
|
2389
2548
|
/** Custom fields. */
|
|
2390
2549
|
custom_fields?: object;
|
|
2391
2550
|
/**
|
|
@@ -2403,6 +2562,8 @@ export type RevUser = UserBase & {
|
|
|
2403
2562
|
* system-generated identifier will be assigned to the user.
|
|
2404
2563
|
*/
|
|
2405
2564
|
external_ref?: string;
|
|
2565
|
+
/** Whether the Rev user is verified or not. */
|
|
2566
|
+
is_verified?: boolean;
|
|
2406
2567
|
rev_org?: OrgSummary;
|
|
2407
2568
|
/**
|
|
2408
2569
|
* Stock schema fragment.
|
|
@@ -2427,6 +2588,11 @@ export type RevUserSummary = UserBaseSummary & {
|
|
|
2427
2588
|
* Request object to create a new Rev user for a Rev organization.
|
|
2428
2589
|
*/
|
|
2429
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[];
|
|
2430
2596
|
/** Application-defined custom fields. */
|
|
2431
2597
|
custom_fields?: object;
|
|
2432
2598
|
/**
|
|
@@ -2556,6 +2722,7 @@ export interface RevUsersListResponse {
|
|
|
2556
2722
|
* Request to update details of a Rev user.
|
|
2557
2723
|
*/
|
|
2558
2724
|
export interface RevUsersUpdateRequest {
|
|
2725
|
+
artifacts?: RevUsersUpdateRequestArtifacts;
|
|
2559
2726
|
/** Application-defined custom fields. */
|
|
2560
2727
|
custom_fields?: object;
|
|
2561
2728
|
custom_schema_fragments?: RevUsersUpdateRequestCustomSchemaFragments;
|
|
@@ -2570,6 +2737,14 @@ export interface RevUsersUpdateRequest {
|
|
|
2570
2737
|
/** The ID of Rev user to update. */
|
|
2571
2738
|
id: string;
|
|
2572
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
|
+
}
|
|
2573
2748
|
/** rev-users-update-request-custom-schema-fragments */
|
|
2574
2749
|
export interface RevUsersUpdateRequestCustomSchemaFragments {
|
|
2575
2750
|
/**
|
|
@@ -3330,8 +3505,10 @@ export interface Stage {
|
|
|
3330
3505
|
* The filter for stages.
|
|
3331
3506
|
*/
|
|
3332
3507
|
export interface StageFilter {
|
|
3333
|
-
/** Filters for records in the provided stage(s). */
|
|
3508
|
+
/** Filters for records in the provided stage(s) by name. */
|
|
3334
3509
|
name?: string[];
|
|
3510
|
+
/** Filters for records in the provided stage(s) by ordinal. */
|
|
3511
|
+
ordinal?: number[];
|
|
3335
3512
|
}
|
|
3336
3513
|
/**
|
|
3337
3514
|
* stage-init
|
|
@@ -4865,8 +5042,10 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
4865
5042
|
rev_org?: string[];
|
|
4866
5043
|
/** Filters for conversations with any of the provided source channels. */
|
|
4867
5044
|
source_channels?: string[];
|
|
4868
|
-
/** Filters for records in the provided stage(s). */
|
|
5045
|
+
/** Filters for records in the provided stage(s) by name. */
|
|
4869
5046
|
'stage.name'?: string[];
|
|
5047
|
+
/** Filters for records in the provided stage(s) by ordinal. */
|
|
5048
|
+
'stage.ordinal'?: number[];
|
|
4870
5049
|
/**
|
|
4871
5050
|
* Filters for conversations with any of the provided tags.
|
|
4872
5051
|
* @example ["don:core:<partition>:devo/<dev-org-id>:tag/<tag-id>"]
|
|
@@ -4956,8 +5135,10 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
4956
5135
|
rev_org?: string[];
|
|
4957
5136
|
/** Filters for conversations with any of the provided source channels. */
|
|
4958
5137
|
source_channels?: string[];
|
|
4959
|
-
/** Filters for records in the provided stage(s). */
|
|
5138
|
+
/** Filters for records in the provided stage(s) by name. */
|
|
4960
5139
|
'stage.name'?: string[];
|
|
5140
|
+
/** Filters for records in the provided stage(s) by ordinal. */
|
|
5141
|
+
'stage.ordinal'?: number[];
|
|
4961
5142
|
/**
|
|
4962
5143
|
* Filters for conversations with any of the provided tags.
|
|
4963
5144
|
* @example ["don:core:<partition>:devo/<dev-org-id>:tag/<tag-id>"]
|
|
@@ -5152,6 +5333,83 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
5152
5333
|
* @secure
|
|
5153
5334
|
*/
|
|
5154
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>>;
|
|
5155
5413
|
/**
|
|
5156
5414
|
* @description Creates a link between two objects to indicate a relationship.
|
|
5157
5415
|
*
|
|
@@ -6091,8 +6349,10 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6091
6349
|
owned_by?: string[];
|
|
6092
6350
|
/** Fields to sort the work items by and the direction to sort them. */
|
|
6093
6351
|
sort_by?: string[];
|
|
6094
|
-
/** Filters for records in the provided stage(s). */
|
|
6352
|
+
/** Filters for records in the provided stage(s) by name. */
|
|
6095
6353
|
'stage.name'?: string[];
|
|
6354
|
+
/** Filters for records in the provided stage(s) by ordinal. */
|
|
6355
|
+
'stage.ordinal'?: number[];
|
|
6096
6356
|
/** Filters for tickets belonging to specific groups. */
|
|
6097
6357
|
'ticket.group'?: string[];
|
|
6098
6358
|
/** Filters for tickets that are spam. */
|
|
@@ -6202,8 +6462,10 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6202
6462
|
owned_by?: string[];
|
|
6203
6463
|
/** Fields to sort the works by and the direction to sort them. */
|
|
6204
6464
|
sort_by?: string[];
|
|
6205
|
-
/** Filters for records in the provided stage(s). */
|
|
6465
|
+
/** Filters for records in the provided stage(s) by name. */
|
|
6206
6466
|
'stage.name'?: string[];
|
|
6467
|
+
/** Filters for records in the provided stage(s) by ordinal. */
|
|
6468
|
+
'stage.ordinal'?: number[];
|
|
6207
6469
|
/** Filters for tickets belonging to specific groups. */
|
|
6208
6470
|
'ticket.group'?: string[];
|
|
6209
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.
|
|
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) {
|
|
@@ -906,6 +912,60 @@ class Api extends HttpClient {
|
|
|
906
912
|
* @secure
|
|
907
913
|
*/
|
|
908
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));
|
|
909
969
|
/**
|
|
910
970
|
* @description Creates a link between two objects to indicate a relationship.
|
|
911
971
|
*
|
|
@@ -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,8 +2774,10 @@ 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[];
|
|
2779
|
+
/** Filters for records in the provided stage(s) by ordinal. */
|
|
2780
|
+
'stage.ordinal'?: number[];
|
|
2765
2781
|
/** Filters for tickets belonging to specific groups. */
|
|
2766
2782
|
'ticket.group'?: string[];
|
|
2767
2783
|
/** Filters for tickets that are spam. */
|
|
@@ -2842,8 +2858,10 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2842
2858
|
* @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
|
|
2843
2859
|
*/
|
|
2844
2860
|
owned_by?: string[];
|
|
2845
|
-
/** Filters for records in the provided stage(s). */
|
|
2861
|
+
/** Filters for records in the provided stage(s) by name. */
|
|
2846
2862
|
'stage.name'?: string[];
|
|
2863
|
+
/** Filters for records in the provided stage(s) by ordinal. */
|
|
2864
|
+
'stage.ordinal'?: number[];
|
|
2847
2865
|
/** Filters for tickets belonging to specific groups. */
|
|
2848
2866
|
'ticket.group'?: string[];
|
|
2849
2867
|
/** Filters for tickets that are spam. */
|