@devrev/typescript-sdk 1.1.5 → 1.1.7
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.
|
@@ -1,3 +1,10 @@
|
|
|
1
|
+
export declare enum AccessLevel {
|
|
2
|
+
External = "external",
|
|
3
|
+
Internal = "internal",
|
|
4
|
+
Private = "private",
|
|
5
|
+
Public = "public",
|
|
6
|
+
Restricted = "restricted"
|
|
7
|
+
}
|
|
1
8
|
/** account */
|
|
2
9
|
export type Account = OrgBase & {
|
|
3
10
|
/** Custom fields. */
|
|
@@ -80,6 +87,27 @@ export interface AccountsDeleteRequest {
|
|
|
80
87
|
* The response to deleting an account.
|
|
81
88
|
*/
|
|
82
89
|
export type AccountsDeleteResponse = object;
|
|
90
|
+
/**
|
|
91
|
+
* accounts-export-request
|
|
92
|
+
* The request to export a collection of accounts.
|
|
93
|
+
*/
|
|
94
|
+
export interface AccountsExportRequest {
|
|
95
|
+
/** Filters for accounts created by the specified user(s). */
|
|
96
|
+
created_by?: string[];
|
|
97
|
+
created_date?: DateTimeFilter;
|
|
98
|
+
/** Array of references of accounts to be filtered. */
|
|
99
|
+
external_refs?: string[];
|
|
100
|
+
/**
|
|
101
|
+
* The number of accounts to return. The default is '50'.
|
|
102
|
+
* @format int32
|
|
103
|
+
* @min 1
|
|
104
|
+
* @max 500
|
|
105
|
+
*/
|
|
106
|
+
first?: number;
|
|
107
|
+
modified_date?: DateTimeFilter;
|
|
108
|
+
/** Fields to sort the accounts by and the direction to sort them in. */
|
|
109
|
+
sort_by?: string[];
|
|
110
|
+
}
|
|
83
111
|
/**
|
|
84
112
|
* accounts-export-response
|
|
85
113
|
* The response to exporting a collection of accounts.
|
|
@@ -88,6 +116,17 @@ export interface AccountsExportResponse {
|
|
|
88
116
|
/** The exported accounts. */
|
|
89
117
|
accounts: Account[];
|
|
90
118
|
}
|
|
119
|
+
/**
|
|
120
|
+
* accounts-get-request
|
|
121
|
+
* Request object to get an account's information.
|
|
122
|
+
*/
|
|
123
|
+
export interface AccountsGetRequest {
|
|
124
|
+
/**
|
|
125
|
+
* The ID of the account to be retrieved.
|
|
126
|
+
* @example "don:core:<partition>:devo/<dev-org-id>:account/<account-id>"
|
|
127
|
+
*/
|
|
128
|
+
id: string;
|
|
129
|
+
}
|
|
91
130
|
/**
|
|
92
131
|
* accounts-get-response
|
|
93
132
|
* The returned account.
|
|
@@ -95,6 +134,39 @@ export interface AccountsExportResponse {
|
|
|
95
134
|
export interface AccountsGetResponse {
|
|
96
135
|
account: Account;
|
|
97
136
|
}
|
|
137
|
+
/**
|
|
138
|
+
* accounts-list-request
|
|
139
|
+
* List the accounts.
|
|
140
|
+
*/
|
|
141
|
+
export interface AccountsListRequest {
|
|
142
|
+
/** Filters for accounts created by the specified user(s). */
|
|
143
|
+
created_by?: string[];
|
|
144
|
+
created_date?: DateTimeFilter;
|
|
145
|
+
/**
|
|
146
|
+
* The cursor to resume iteration from. If not provided, then
|
|
147
|
+
* iteration starts from the beginning.
|
|
148
|
+
*/
|
|
149
|
+
cursor?: string;
|
|
150
|
+
/** Array of references of accounts to be filtered. */
|
|
151
|
+
external_refs?: string[];
|
|
152
|
+
/**
|
|
153
|
+
* The maximum number of accounts to return per page. The default is
|
|
154
|
+
* '50'.
|
|
155
|
+
* @format int32
|
|
156
|
+
*/
|
|
157
|
+
limit?: number;
|
|
158
|
+
/**
|
|
159
|
+
* The iteration mode to use. If "after", then entries after the provided
|
|
160
|
+
* cursor will be returned, or if no cursor is provided, then from the
|
|
161
|
+
* beginning. If "before", then entries before the provided cursor will be
|
|
162
|
+
* returned, or if no cursor is provided, then from the end. Entries will
|
|
163
|
+
* always be returned in the specified sort-by order.
|
|
164
|
+
*/
|
|
165
|
+
mode?: ListMode;
|
|
166
|
+
modified_date?: DateTimeFilter;
|
|
167
|
+
/** Fields to sort the accounts by and the direction to sort them in. */
|
|
168
|
+
sort_by?: string[];
|
|
169
|
+
}
|
|
98
170
|
/**
|
|
99
171
|
* accounts-list-response
|
|
100
172
|
* The response to listing all accounts matching the filter criteria.
|
|
@@ -158,11 +230,309 @@ export interface AccountsUpdateResponse {
|
|
|
158
230
|
* List of custom fields from multiple source fragments.
|
|
159
231
|
*/
|
|
160
232
|
export type AggregatedSchema = object;
|
|
233
|
+
/** aggregated-schema-get-request */
|
|
234
|
+
export interface AggregatedSchemaGetRequest {
|
|
235
|
+
/** The list of custom schema fragment DONs which are to be aggregated. */
|
|
236
|
+
custom_schema_fragment_ids: string[];
|
|
237
|
+
/** Per object schema, if associated with the leaf type. */
|
|
238
|
+
per_object_schema?: FieldDescriptor[];
|
|
239
|
+
/** The stock schema fragment which is to be aggregated. */
|
|
240
|
+
stock_schema_fragment_id?: string;
|
|
241
|
+
}
|
|
161
242
|
/** aggregated-schema-get-response */
|
|
162
243
|
export interface AggregatedSchemaGetResponse {
|
|
163
244
|
/** List of custom fields from multiple source fragments. */
|
|
164
245
|
schema: AggregatedSchema;
|
|
165
246
|
}
|
|
247
|
+
/** app-fragment */
|
|
248
|
+
export type AppFragment = CustomSchemaFragmentBase;
|
|
249
|
+
/** article */
|
|
250
|
+
export type Article = AtomBase & {
|
|
251
|
+
/** Description of the article. */
|
|
252
|
+
description?: string;
|
|
253
|
+
/** Artifacts containing the extracted content. */
|
|
254
|
+
extracted_content?: ArtifactSummary[];
|
|
255
|
+
/** Resource details. */
|
|
256
|
+
resource?: Resource;
|
|
257
|
+
/** Title of the article. */
|
|
258
|
+
title?: string;
|
|
259
|
+
};
|
|
260
|
+
/** Status of the article. */
|
|
261
|
+
export declare enum ArticleStatus {
|
|
262
|
+
Archived = "archived",
|
|
263
|
+
Draft = "draft",
|
|
264
|
+
Published = "published",
|
|
265
|
+
ReviewNeeded = "review_needed"
|
|
266
|
+
}
|
|
267
|
+
/** articles-count-request */
|
|
268
|
+
export interface ArticlesCountRequest {
|
|
269
|
+
/**
|
|
270
|
+
* Filters for articles belonging to any of the provided parts.
|
|
271
|
+
* @example ["don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"]
|
|
272
|
+
*/
|
|
273
|
+
applies_to_parts?: string[];
|
|
274
|
+
/**
|
|
275
|
+
* Filters for articles authored by any of the provided users.
|
|
276
|
+
* @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
|
|
277
|
+
*/
|
|
278
|
+
authored_by?: string[];
|
|
279
|
+
/**
|
|
280
|
+
* Filters for articles created by any of the provided users.
|
|
281
|
+
* @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
|
|
282
|
+
*/
|
|
283
|
+
created_by?: string[];
|
|
284
|
+
/**
|
|
285
|
+
* Filters for articles owned by any of the provided users.
|
|
286
|
+
* @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
|
|
287
|
+
*/
|
|
288
|
+
owned_by?: string[];
|
|
289
|
+
}
|
|
290
|
+
/** articles-count-response */
|
|
291
|
+
export interface ArticlesCountResponse {
|
|
292
|
+
/**
|
|
293
|
+
* The total number of articles matching the filter.
|
|
294
|
+
* @format int32
|
|
295
|
+
*/
|
|
296
|
+
count: number;
|
|
297
|
+
}
|
|
298
|
+
/**
|
|
299
|
+
* articles-create-request
|
|
300
|
+
* The request to create an article.
|
|
301
|
+
*/
|
|
302
|
+
export interface ArticlesCreateRequest {
|
|
303
|
+
access_level?: AccessLevel;
|
|
304
|
+
/**
|
|
305
|
+
* The parts that the article applies to.
|
|
306
|
+
* @minItems 1
|
|
307
|
+
* @example ["don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"]
|
|
308
|
+
*/
|
|
309
|
+
applies_to_parts: string[];
|
|
310
|
+
/**
|
|
311
|
+
* The authors of the article.
|
|
312
|
+
* @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
|
|
313
|
+
*/
|
|
314
|
+
authored_by?: string[];
|
|
315
|
+
/** Description for the article. */
|
|
316
|
+
description?: string;
|
|
317
|
+
/**
|
|
318
|
+
* ID of the extracted content artifact.
|
|
319
|
+
* @example ["don:core:<partition>:devo/<dev-org-id>:artifact/<artifact-id>"]
|
|
320
|
+
*/
|
|
321
|
+
extracted_content?: string[];
|
|
322
|
+
/** Language of the article. */
|
|
323
|
+
language?: string;
|
|
324
|
+
/**
|
|
325
|
+
* The users that own the article.
|
|
326
|
+
* @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
|
|
327
|
+
*/
|
|
328
|
+
owned_by?: string[];
|
|
329
|
+
/**
|
|
330
|
+
* The published date of the article.
|
|
331
|
+
* @format date-time
|
|
332
|
+
*/
|
|
333
|
+
published_at?: string;
|
|
334
|
+
resource: ArticlesCreateRequestResource;
|
|
335
|
+
/** Status of the article. */
|
|
336
|
+
status?: ArticleStatus;
|
|
337
|
+
/** Tags associated with the article. */
|
|
338
|
+
tags?: SetTagWithValue[];
|
|
339
|
+
/** Name of the article. */
|
|
340
|
+
title: string;
|
|
341
|
+
}
|
|
342
|
+
/** articles-create-request-resource */
|
|
343
|
+
export interface ArticlesCreateRequestResource {
|
|
344
|
+
/**
|
|
345
|
+
* IDs of the artifacts.
|
|
346
|
+
* @example ["don:core:<partition>:devo/<dev-org-id>:artifact/<artifact-id>"]
|
|
347
|
+
*/
|
|
348
|
+
artifacts?: string[];
|
|
349
|
+
/** URL of the external article. */
|
|
350
|
+
url?: string;
|
|
351
|
+
}
|
|
352
|
+
/**
|
|
353
|
+
* articles-create-response
|
|
354
|
+
* Create article response.
|
|
355
|
+
*/
|
|
356
|
+
export interface ArticlesCreateResponse {
|
|
357
|
+
article: Article;
|
|
358
|
+
}
|
|
359
|
+
/**
|
|
360
|
+
* articles-delete-request
|
|
361
|
+
* The request to delete an article.
|
|
362
|
+
*/
|
|
363
|
+
export interface ArticlesDeleteRequest {
|
|
364
|
+
/**
|
|
365
|
+
* The ID of the article to delete.
|
|
366
|
+
* @example "don:core:<partition>:devo/<dev-org-id>:article/<article-id>"
|
|
367
|
+
*/
|
|
368
|
+
id: string;
|
|
369
|
+
}
|
|
370
|
+
/**
|
|
371
|
+
* articles-get-request
|
|
372
|
+
* The request to get an article.
|
|
373
|
+
*/
|
|
374
|
+
export interface ArticlesGetRequest {
|
|
375
|
+
/**
|
|
376
|
+
* The ID of the required article.
|
|
377
|
+
* @example "don:core:<partition>:devo/<dev-org-id>:article/<article-id>"
|
|
378
|
+
*/
|
|
379
|
+
id: string;
|
|
380
|
+
}
|
|
381
|
+
/**
|
|
382
|
+
* articles-get-response
|
|
383
|
+
* Get article response.
|
|
384
|
+
*/
|
|
385
|
+
export interface ArticlesGetResponse {
|
|
386
|
+
article: Article;
|
|
387
|
+
}
|
|
388
|
+
/**
|
|
389
|
+
* articles-list-request
|
|
390
|
+
* The request to list articles.
|
|
391
|
+
*/
|
|
392
|
+
export interface ArticlesListRequest {
|
|
393
|
+
/**
|
|
394
|
+
* Filters for articles belonging to any of the provided parts.
|
|
395
|
+
* @example ["don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"]
|
|
396
|
+
*/
|
|
397
|
+
applies_to_parts?: string[];
|
|
398
|
+
/**
|
|
399
|
+
* Filters for articles authored by any of the provided users.
|
|
400
|
+
* @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
|
|
401
|
+
*/
|
|
402
|
+
authored_by?: string[];
|
|
403
|
+
/**
|
|
404
|
+
* Filters for articles created by any of the provided users.
|
|
405
|
+
* @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
|
|
406
|
+
*/
|
|
407
|
+
created_by?: string[];
|
|
408
|
+
/**
|
|
409
|
+
* The cursor to resume iteration from. If not provided, then
|
|
410
|
+
* iteration starts from the beginning.
|
|
411
|
+
*/
|
|
412
|
+
cursor?: string;
|
|
413
|
+
/**
|
|
414
|
+
* The maximum number of articles to return. The default is '50'.
|
|
415
|
+
* @format int32
|
|
416
|
+
*/
|
|
417
|
+
limit?: number;
|
|
418
|
+
/**
|
|
419
|
+
* The iteration mode to use. If "after", then entries after the provided
|
|
420
|
+
* cursor will be returned, or if no cursor is provided, then from the
|
|
421
|
+
* beginning. If "before", then entries before the provided cursor will be
|
|
422
|
+
* returned, or if no cursor is provided, then from the end. Entries will
|
|
423
|
+
* always be returned in the specified sort-by order.
|
|
424
|
+
*/
|
|
425
|
+
mode?: ListMode;
|
|
426
|
+
/**
|
|
427
|
+
* Filters for articles owned by any of the provided users.
|
|
428
|
+
* @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
|
|
429
|
+
*/
|
|
430
|
+
owned_by?: string[];
|
|
431
|
+
}
|
|
432
|
+
/**
|
|
433
|
+
* articles-list-response
|
|
434
|
+
* List articles response.
|
|
435
|
+
*/
|
|
436
|
+
export interface ArticlesListResponse {
|
|
437
|
+
/** The article entries matching the request. */
|
|
438
|
+
articles: Article[];
|
|
439
|
+
/**
|
|
440
|
+
* The cursor used to iterate subsequent results in accordance to the
|
|
441
|
+
* sort order. If not set, then no later elements exist.
|
|
442
|
+
*/
|
|
443
|
+
next_cursor?: string;
|
|
444
|
+
/**
|
|
445
|
+
* The cursor used to iterate preceding results in accordance to the
|
|
446
|
+
* sort order. If not set, then no prior elements exist.
|
|
447
|
+
*/
|
|
448
|
+
prev_cursor?: string;
|
|
449
|
+
/**
|
|
450
|
+
* Total number of article items for the request.
|
|
451
|
+
* @format int32
|
|
452
|
+
*/
|
|
453
|
+
total: number;
|
|
454
|
+
}
|
|
455
|
+
/**
|
|
456
|
+
* articles-update-request
|
|
457
|
+
* The request to update an article.
|
|
458
|
+
*/
|
|
459
|
+
export interface ArticlesUpdateRequest {
|
|
460
|
+
access_level?: AccessLevel;
|
|
461
|
+
applies_to_parts?: ArticlesUpdateRequestAppliesToParts;
|
|
462
|
+
artifacts?: ArticlesUpdateRequestArtifacts;
|
|
463
|
+
authored_by?: ArticlesUpdateRequestAuthoredBy;
|
|
464
|
+
/**
|
|
465
|
+
* Updated description of the article object, or unchanged if not
|
|
466
|
+
* provided.
|
|
467
|
+
*/
|
|
468
|
+
description?: string;
|
|
469
|
+
extracted_content?: ArticlesUpdateRequestExtractedContent;
|
|
470
|
+
/**
|
|
471
|
+
* The article's ID.
|
|
472
|
+
* @example "don:core:<partition>:devo/<dev-org-id>:article/<article-id>"
|
|
473
|
+
*/
|
|
474
|
+
id: string;
|
|
475
|
+
/** Updates the language of the article. */
|
|
476
|
+
language?: string;
|
|
477
|
+
owned_by?: ArticlesUpdateRequestOwnedBy;
|
|
478
|
+
/** Status of the article. */
|
|
479
|
+
status?: ArticleStatus;
|
|
480
|
+
tags?: ArticlesUpdateRequestTags;
|
|
481
|
+
/** Updated title of the article object, or unchanged if not provided. */
|
|
482
|
+
title?: string;
|
|
483
|
+
/** Updates the URL of the external article. */
|
|
484
|
+
url?: string;
|
|
485
|
+
}
|
|
486
|
+
/** articles-update-request-applies-to-parts */
|
|
487
|
+
export interface ArticlesUpdateRequestAppliesToParts {
|
|
488
|
+
/**
|
|
489
|
+
* Updates the parts that the article applies to.
|
|
490
|
+
* @example ["don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"]
|
|
491
|
+
*/
|
|
492
|
+
set?: string[];
|
|
493
|
+
}
|
|
494
|
+
/** articles-update-request-artifacts */
|
|
495
|
+
export interface ArticlesUpdateRequestArtifacts {
|
|
496
|
+
/**
|
|
497
|
+
* Updates IDs of the artifacts.
|
|
498
|
+
* @example ["don:core:<partition>:devo/<dev-org-id>:artifact/<artifact-id>"]
|
|
499
|
+
*/
|
|
500
|
+
set?: string[];
|
|
501
|
+
}
|
|
502
|
+
/** articles-update-request-authored-by */
|
|
503
|
+
export interface ArticlesUpdateRequestAuthoredBy {
|
|
504
|
+
/**
|
|
505
|
+
* Sets the users that authored the article.
|
|
506
|
+
* @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
|
|
507
|
+
*/
|
|
508
|
+
set?: string[];
|
|
509
|
+
}
|
|
510
|
+
/** articles-update-request-extracted-content */
|
|
511
|
+
export interface ArticlesUpdateRequestExtractedContent {
|
|
512
|
+
/**
|
|
513
|
+
* Update the ID of the extracted content.
|
|
514
|
+
* @example ["don:core:<partition>:devo/<dev-org-id>:artifact/<artifact-id>"]
|
|
515
|
+
*/
|
|
516
|
+
set?: string[];
|
|
517
|
+
}
|
|
518
|
+
/** articles-update-request-owned-by */
|
|
519
|
+
export interface ArticlesUpdateRequestOwnedBy {
|
|
520
|
+
/**
|
|
521
|
+
* Sets the owner IDs to the provided user IDs. This must not be
|
|
522
|
+
* empty.
|
|
523
|
+
* @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
|
|
524
|
+
*/
|
|
525
|
+
set?: string[];
|
|
526
|
+
}
|
|
527
|
+
/** articles-update-request-tags */
|
|
528
|
+
export interface ArticlesUpdateRequestTags {
|
|
529
|
+
/** Sets the provided tags on the article. */
|
|
530
|
+
set?: SetTagWithValue[];
|
|
531
|
+
}
|
|
532
|
+
/** articles-update-response */
|
|
533
|
+
export interface ArticlesUpdateResponse {
|
|
534
|
+
article: Article;
|
|
535
|
+
}
|
|
166
536
|
/** artifact-summary */
|
|
167
537
|
export type ArtifactSummary = AtomBaseSummary;
|
|
168
538
|
/** atom-base */
|
|
@@ -295,11 +665,66 @@ export interface ConversationsDeleteRequest {
|
|
|
295
665
|
* The response for deleting a conversation.
|
|
296
666
|
*/
|
|
297
667
|
export type ConversationsDeleteResponse = object;
|
|
668
|
+
/** conversations-export-request */
|
|
669
|
+
export interface ConversationsExportRequest {
|
|
670
|
+
/**
|
|
671
|
+
* Filters for conversations belonging to any of the provided parts.
|
|
672
|
+
* @example ["don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"]
|
|
673
|
+
*/
|
|
674
|
+
applies_to_parts?: string[];
|
|
675
|
+
/**
|
|
676
|
+
* The number of conversation items to return. The default is '50',
|
|
677
|
+
* the maximum is '5000'.
|
|
678
|
+
* @format int32
|
|
679
|
+
*/
|
|
680
|
+
first?: number;
|
|
681
|
+
/** Filters for conversation that belong to the given groups. */
|
|
682
|
+
group?: string[];
|
|
683
|
+
/** Filters for conversations that are created by verified users. */
|
|
684
|
+
is_creator_verified?: boolean;
|
|
685
|
+
/** Filters for conversations that are spam. */
|
|
686
|
+
is_spam?: boolean;
|
|
687
|
+
/**
|
|
688
|
+
* Filters for conversations where these users are participants.
|
|
689
|
+
* @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
|
|
690
|
+
*/
|
|
691
|
+
members?: string[];
|
|
692
|
+
/**
|
|
693
|
+
* Filters for conversations owned by any of these users.
|
|
694
|
+
* @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
|
|
695
|
+
*/
|
|
696
|
+
owned_by?: string[];
|
|
697
|
+
/**
|
|
698
|
+
* Filters for conversations that are associated with any of the
|
|
699
|
+
* provided Rev organizations.
|
|
700
|
+
* @example ["don:identity:<partition>:devo/<dev-org-id>:revo/<rev-org-id>"]
|
|
701
|
+
*/
|
|
702
|
+
rev_org?: string[];
|
|
703
|
+
/** The filter for SLA summary. */
|
|
704
|
+
sla_summary?: SlaSummaryFilter;
|
|
705
|
+
/** Filters for conversations with any of the provided source channels. */
|
|
706
|
+
source_channels?: string[];
|
|
707
|
+
/** The filter for stages. */
|
|
708
|
+
stage?: StageFilter;
|
|
709
|
+
/**
|
|
710
|
+
* Filters for conversations with any of the provided tags.
|
|
711
|
+
* @example ["don:core:<partition>:devo/<dev-org-id>:tag/<tag-id>"]
|
|
712
|
+
*/
|
|
713
|
+
tags?: string[];
|
|
714
|
+
}
|
|
298
715
|
/** conversations-export-response */
|
|
299
716
|
export interface ConversationsExportResponse {
|
|
300
717
|
/** The resulting collection of conversation items. */
|
|
301
718
|
conversations: Conversation[];
|
|
302
719
|
}
|
|
720
|
+
/**
|
|
721
|
+
* conversations-get-request
|
|
722
|
+
* The request to get a conversation's information.
|
|
723
|
+
*/
|
|
724
|
+
export interface ConversationsGetRequest {
|
|
725
|
+
/** The requested conversation's ID. */
|
|
726
|
+
id: string;
|
|
727
|
+
}
|
|
303
728
|
/**
|
|
304
729
|
* conversations-get-response
|
|
305
730
|
* The response to getting a conversation's information.
|
|
@@ -307,6 +732,68 @@ export interface ConversationsExportResponse {
|
|
|
307
732
|
export interface ConversationsGetResponse {
|
|
308
733
|
conversation: Conversation;
|
|
309
734
|
}
|
|
735
|
+
/**
|
|
736
|
+
* conversations-list-request
|
|
737
|
+
* The request to get information about a list of conversations.
|
|
738
|
+
*/
|
|
739
|
+
export interface ConversationsListRequest {
|
|
740
|
+
/**
|
|
741
|
+
* Filters for conversations belonging to any of the provided parts.
|
|
742
|
+
* @example ["don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"]
|
|
743
|
+
*/
|
|
744
|
+
applies_to_parts?: string[];
|
|
745
|
+
/**
|
|
746
|
+
* The cursor to resume iteration from. If not provided, then
|
|
747
|
+
* iteration starts from the beginning.
|
|
748
|
+
*/
|
|
749
|
+
cursor?: string;
|
|
750
|
+
/** Filters for conversation that belong to the given groups. */
|
|
751
|
+
group?: string[];
|
|
752
|
+
/** Filters for conversations that are created by verified users. */
|
|
753
|
+
is_creator_verified?: boolean;
|
|
754
|
+
/** Filters for conversations that are spam. */
|
|
755
|
+
is_spam?: boolean;
|
|
756
|
+
/**
|
|
757
|
+
* The maximum number of conversations to return. The default is '50'.
|
|
758
|
+
* @format int32
|
|
759
|
+
*/
|
|
760
|
+
limit?: number;
|
|
761
|
+
/**
|
|
762
|
+
* Filters for conversations where these users are participants.
|
|
763
|
+
* @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
|
|
764
|
+
*/
|
|
765
|
+
members?: string[];
|
|
766
|
+
/**
|
|
767
|
+
* The iteration mode to use. If "after", then entries after the provided
|
|
768
|
+
* cursor will be returned, or if no cursor is provided, then from the
|
|
769
|
+
* beginning. If "before", then entries before the provided cursor will be
|
|
770
|
+
* returned, or if no cursor is provided, then from the end. Entries will
|
|
771
|
+
* always be returned in the specified sort-by order.
|
|
772
|
+
*/
|
|
773
|
+
mode?: ListMode;
|
|
774
|
+
/**
|
|
775
|
+
* Filters for conversations owned by any of these users.
|
|
776
|
+
* @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
|
|
777
|
+
*/
|
|
778
|
+
owned_by?: string[];
|
|
779
|
+
/**
|
|
780
|
+
* Filters for conversations that are associated with any of the
|
|
781
|
+
* provided Rev organizations.
|
|
782
|
+
* @example ["don:identity:<partition>:devo/<dev-org-id>:revo/<rev-org-id>"]
|
|
783
|
+
*/
|
|
784
|
+
rev_org?: string[];
|
|
785
|
+
/** The filter for SLA summary. */
|
|
786
|
+
sla_summary?: SlaSummaryFilter;
|
|
787
|
+
/** Filters for conversations with any of the provided source channels. */
|
|
788
|
+
source_channels?: string[];
|
|
789
|
+
/** The filter for stages. */
|
|
790
|
+
stage?: StageFilter;
|
|
791
|
+
/**
|
|
792
|
+
* Filters for conversations with any of the provided tags.
|
|
793
|
+
* @example ["don:core:<partition>:devo/<dev-org-id>:tag/<tag-id>"]
|
|
794
|
+
*/
|
|
795
|
+
tags?: string[];
|
|
796
|
+
}
|
|
310
797
|
/**
|
|
311
798
|
* conversations-list-response
|
|
312
799
|
* The response to listing the conversations.
|
|
@@ -419,19 +906,53 @@ export interface CreateWeeklyOrgScheduleInterval {
|
|
|
419
906
|
to: number;
|
|
420
907
|
}
|
|
421
908
|
/** custom-schema-fragment */
|
|
422
|
-
export
|
|
909
|
+
export type CustomSchemaFragment = (AppFragment | CustomTypeFragment | TenantFragment) & {
|
|
423
910
|
type: CustomSchemaFragmentType;
|
|
424
|
-
}
|
|
911
|
+
};
|
|
912
|
+
/** custom-schema-fragment-base */
|
|
913
|
+
export type CustomSchemaFragmentBase = AtomBase;
|
|
425
914
|
/**
|
|
426
915
|
* custom-schema-fragment-condition
|
|
427
916
|
* The condition associated with a field.
|
|
428
917
|
*/
|
|
429
918
|
export type CustomSchemaFragmentCondition = object;
|
|
430
|
-
export
|
|
919
|
+
export declare enum CustomSchemaFragmentType {
|
|
920
|
+
AppFragment = "app_fragment",
|
|
921
|
+
CustomTypeFragment = "custom_type_fragment",
|
|
922
|
+
TenantFragment = "tenant_fragment"
|
|
923
|
+
}
|
|
924
|
+
/** custom-schema-fragments-get-request */
|
|
925
|
+
export interface CustomSchemaFragmentsGetRequest {
|
|
926
|
+
/** The ID of the custom schema fragment. */
|
|
927
|
+
id: string;
|
|
928
|
+
}
|
|
431
929
|
/** custom-schema-fragments-get-response */
|
|
432
930
|
export interface CustomSchemaFragmentsGetResponse {
|
|
433
931
|
fragment: CustomSchemaFragment;
|
|
434
932
|
}
|
|
933
|
+
/** custom-schema-fragments-list-request */
|
|
934
|
+
export interface CustomSchemaFragmentsListRequest {
|
|
935
|
+
/** The list of app names. */
|
|
936
|
+
app?: string[];
|
|
937
|
+
/**
|
|
938
|
+
* The cursor to resume iteration from, otherwise if not provided,
|
|
939
|
+
* then iteration starts from the beginning.
|
|
940
|
+
*/
|
|
941
|
+
cursor?: string;
|
|
942
|
+
/** The list of leaf types. */
|
|
943
|
+
leaf_type?: string[];
|
|
944
|
+
/**
|
|
945
|
+
* The maximum number of items.
|
|
946
|
+
* @format int32
|
|
947
|
+
*/
|
|
948
|
+
limit?: number;
|
|
949
|
+
/** The list of fields to sort the items by and how to sort them. */
|
|
950
|
+
sort_by?: string[];
|
|
951
|
+
/** The list of subtypes. */
|
|
952
|
+
subtype?: string[];
|
|
953
|
+
/** Filters for custom schema fragment of the provided types. */
|
|
954
|
+
types?: CustomSchemaFragmentType[];
|
|
955
|
+
}
|
|
435
956
|
/** custom-schema-fragments-list-response */
|
|
436
957
|
export interface CustomSchemaFragmentsListResponse {
|
|
437
958
|
/**
|
|
@@ -462,8 +983,6 @@ export type CustomSchemaFragmentsSetRequest = (CustomSchemaFragmentsSetRequestAp
|
|
|
462
983
|
export interface CustomSchemaFragmentsSetRequestAppFragment {
|
|
463
984
|
/** The app this fragment applies to. */
|
|
464
985
|
app: string;
|
|
465
|
-
/** The name of the app fragment. */
|
|
466
|
-
app_fragment_name: string;
|
|
467
986
|
}
|
|
468
987
|
/** custom-schema-fragments-set-request-custom-type-fragment */
|
|
469
988
|
export interface CustomSchemaFragmentsSetRequestCustomTypeFragment {
|
|
@@ -488,6 +1007,69 @@ export interface CustomSchemaFragmentsSetResponse {
|
|
|
488
1007
|
/** The ID of the custom schema fragment. */
|
|
489
1008
|
id: string;
|
|
490
1009
|
}
|
|
1010
|
+
/** custom-type-fragment */
|
|
1011
|
+
export type CustomTypeFragment = CustomSchemaFragmentBase;
|
|
1012
|
+
/**
|
|
1013
|
+
* date-filter
|
|
1014
|
+
* Provides ways to specify date ranges on objects.
|
|
1015
|
+
*/
|
|
1016
|
+
export type DateFilter = (DateTimeFilter | DateTimePreset) & {
|
|
1017
|
+
/** Type of date filter. */
|
|
1018
|
+
type: DateFilterType;
|
|
1019
|
+
};
|
|
1020
|
+
/** Type of date filter. */
|
|
1021
|
+
export declare enum DateFilterType {
|
|
1022
|
+
Preset = "preset",
|
|
1023
|
+
Range = "range"
|
|
1024
|
+
}
|
|
1025
|
+
/** date-time-filter */
|
|
1026
|
+
export interface DateTimeFilter {
|
|
1027
|
+
/**
|
|
1028
|
+
* Filters for objects created after the provided timestamp
|
|
1029
|
+
* (inclusive).
|
|
1030
|
+
* @format date-time
|
|
1031
|
+
*/
|
|
1032
|
+
after?: string;
|
|
1033
|
+
/**
|
|
1034
|
+
* Filters for objects created before the provided timestamp
|
|
1035
|
+
* (inclusive).
|
|
1036
|
+
* @format date-time
|
|
1037
|
+
*/
|
|
1038
|
+
before?: string;
|
|
1039
|
+
}
|
|
1040
|
+
/**
|
|
1041
|
+
* date-time-preset
|
|
1042
|
+
* Provides preset types for date filter.
|
|
1043
|
+
*/
|
|
1044
|
+
export type DateTimePreset = (DateTimePresetLastNDays | DateTimePresetNextNDays) & {
|
|
1045
|
+
/** Type of date preset. */
|
|
1046
|
+
preset_type: DateTimePresetType;
|
|
1047
|
+
};
|
|
1048
|
+
/** date-time-preset-last-n-days */
|
|
1049
|
+
export interface DateTimePresetLastNDays {
|
|
1050
|
+
/**
|
|
1051
|
+
* The range starts from the current timestamp and continues for the
|
|
1052
|
+
* past n days.
|
|
1053
|
+
* @min 0
|
|
1054
|
+
* @max 4294967295
|
|
1055
|
+
*/
|
|
1056
|
+
days: number;
|
|
1057
|
+
}
|
|
1058
|
+
/** date-time-preset-next-n-days */
|
|
1059
|
+
export interface DateTimePresetNextNDays {
|
|
1060
|
+
/**
|
|
1061
|
+
* The range starts from the current timestamp and continues for the
|
|
1062
|
+
* next n days.
|
|
1063
|
+
* @min 0
|
|
1064
|
+
* @max 4294967295
|
|
1065
|
+
*/
|
|
1066
|
+
days: number;
|
|
1067
|
+
}
|
|
1068
|
+
/** Type of date preset. */
|
|
1069
|
+
export declare enum DateTimePresetType {
|
|
1070
|
+
LastNDays = "last_n_days",
|
|
1071
|
+
NextNDays = "next_n_days"
|
|
1072
|
+
}
|
|
491
1073
|
/** dev-user-summary */
|
|
492
1074
|
export type DevUserSummary = UserBaseSummary;
|
|
493
1075
|
/** empty */
|
|
@@ -507,6 +1089,23 @@ export declare enum EngagementType {
|
|
|
507
1089
|
Offline = "offline",
|
|
508
1090
|
Survey = "survey"
|
|
509
1091
|
}
|
|
1092
|
+
/** engagements-count-request */
|
|
1093
|
+
export interface EngagementsCountRequest {
|
|
1094
|
+
/** Filters for meetings with the provided external_refs. */
|
|
1095
|
+
external_ref?: string[];
|
|
1096
|
+
/**
|
|
1097
|
+
* Filters for engagement of the provided members.
|
|
1098
|
+
* @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
|
|
1099
|
+
*/
|
|
1100
|
+
members?: string[];
|
|
1101
|
+
/**
|
|
1102
|
+
* Filters for engagements with the provided parent.
|
|
1103
|
+
* @example ["don:core:<partition>:devo/<dev-org-id>:account/<account-id>"]
|
|
1104
|
+
*/
|
|
1105
|
+
parent?: string[];
|
|
1106
|
+
/** Filters for engagement of the provided types. */
|
|
1107
|
+
type?: EngagementType[];
|
|
1108
|
+
}
|
|
510
1109
|
/** engagements-count-response */
|
|
511
1110
|
export interface EngagementsCountResponse {
|
|
512
1111
|
/**
|
|
@@ -571,10 +1170,52 @@ export interface EngagementsDeleteRequest {
|
|
|
571
1170
|
}
|
|
572
1171
|
/** engagements-delete-response */
|
|
573
1172
|
export type EngagementsDeleteResponse = object;
|
|
1173
|
+
/** engagements-get-request */
|
|
1174
|
+
export interface EngagementsGetRequest {
|
|
1175
|
+
/** The engagement ID. */
|
|
1176
|
+
id: string;
|
|
1177
|
+
}
|
|
574
1178
|
/** engagements-get-response */
|
|
575
1179
|
export interface EngagementsGetResponse {
|
|
576
1180
|
engagement: Engagement;
|
|
577
1181
|
}
|
|
1182
|
+
/** engagements-list-request */
|
|
1183
|
+
export interface EngagementsListRequest {
|
|
1184
|
+
/**
|
|
1185
|
+
* The cursor to resume iteration from. If not provided, then
|
|
1186
|
+
* iteration starts from the beginning.
|
|
1187
|
+
*/
|
|
1188
|
+
cursor?: string;
|
|
1189
|
+
/** Filters for meetings with the provided external_refs. */
|
|
1190
|
+
external_ref?: string[];
|
|
1191
|
+
/**
|
|
1192
|
+
* The maximum number of engagements to return.
|
|
1193
|
+
* @format int32
|
|
1194
|
+
*/
|
|
1195
|
+
limit?: number;
|
|
1196
|
+
/**
|
|
1197
|
+
* Filters for engagement of the provided members.
|
|
1198
|
+
* @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
|
|
1199
|
+
*/
|
|
1200
|
+
members?: string[];
|
|
1201
|
+
/**
|
|
1202
|
+
* The iteration mode to use. If "after", then entries after the provided
|
|
1203
|
+
* cursor will be returned, or if no cursor is provided, then from the
|
|
1204
|
+
* beginning. If "before", then entries before the provided cursor will be
|
|
1205
|
+
* returned, or if no cursor is provided, then from the end. Entries will
|
|
1206
|
+
* always be returned in the specified sort-by order.
|
|
1207
|
+
*/
|
|
1208
|
+
mode?: ListMode;
|
|
1209
|
+
/**
|
|
1210
|
+
* Filters for engagements with the provided parent.
|
|
1211
|
+
* @example ["don:core:<partition>:devo/<dev-org-id>:account/<account-id>"]
|
|
1212
|
+
*/
|
|
1213
|
+
parent?: string[];
|
|
1214
|
+
/** Fields to sort the engagements by and the direction to sort them. */
|
|
1215
|
+
sort_by?: string[];
|
|
1216
|
+
/** Filters for engagement of the provided types. */
|
|
1217
|
+
type?: EngagementType[];
|
|
1218
|
+
}
|
|
578
1219
|
/** engagements-list-response */
|
|
579
1220
|
export interface EngagementsListResponse {
|
|
580
1221
|
/** The list of engagements. */
|
|
@@ -813,6 +1454,11 @@ export interface EventSourcesScheduleEventResponse {
|
|
|
813
1454
|
}
|
|
814
1455
|
/** feature-summary */
|
|
815
1456
|
export type FeatureSummary = PartBaseSummary;
|
|
1457
|
+
/**
|
|
1458
|
+
* field-descriptor
|
|
1459
|
+
* Set of field attributes.
|
|
1460
|
+
*/
|
|
1461
|
+
export type FieldDescriptor = object;
|
|
816
1462
|
/** group-summary */
|
|
817
1463
|
export type GroupSummary = AtomBaseSummary;
|
|
818
1464
|
/** issue */
|
|
@@ -926,6 +1572,14 @@ export declare enum LinksDirection {
|
|
|
926
1572
|
IsSource = "is_source",
|
|
927
1573
|
IsTarget = "is_target"
|
|
928
1574
|
}
|
|
1575
|
+
/**
|
|
1576
|
+
* links-get-request
|
|
1577
|
+
* The request to get a link's information.
|
|
1578
|
+
*/
|
|
1579
|
+
export interface LinksGetRequest {
|
|
1580
|
+
/** The requested link's ID. */
|
|
1581
|
+
id: string;
|
|
1582
|
+
}
|
|
929
1583
|
/**
|
|
930
1584
|
* links-get-response
|
|
931
1585
|
* The response to getting a link's information.
|
|
@@ -933,6 +1587,50 @@ export declare enum LinksDirection {
|
|
|
933
1587
|
export interface LinksGetResponse {
|
|
934
1588
|
link: Link;
|
|
935
1589
|
}
|
|
1590
|
+
/**
|
|
1591
|
+
* links-list-request
|
|
1592
|
+
* The request to get information about a list of links.
|
|
1593
|
+
*/
|
|
1594
|
+
export interface LinksListRequest {
|
|
1595
|
+
/**
|
|
1596
|
+
* The cursor to resume iteration from. If not provided, then
|
|
1597
|
+
* iteration starts from the beginning.
|
|
1598
|
+
*/
|
|
1599
|
+
cursor?: string;
|
|
1600
|
+
/**
|
|
1601
|
+
* The direction of link, which can either be outbound such that the
|
|
1602
|
+
* object is the source of the link, otherwise inbound where the object is
|
|
1603
|
+
* the target of the link.
|
|
1604
|
+
*/
|
|
1605
|
+
direction?: LinksDirection;
|
|
1606
|
+
/**
|
|
1607
|
+
* The maximum number of links to return. If not set, then the default
|
|
1608
|
+
* is '50'.
|
|
1609
|
+
* @format int32
|
|
1610
|
+
*/
|
|
1611
|
+
limit?: number;
|
|
1612
|
+
/**
|
|
1613
|
+
* The link type(s) to filter for, otherwise if not present, all link
|
|
1614
|
+
* types are included.
|
|
1615
|
+
*/
|
|
1616
|
+
link_type?: LinkType[];
|
|
1617
|
+
/**
|
|
1618
|
+
* The iteration mode to use. If "after", then entries after the provided
|
|
1619
|
+
* cursor will be returned, or if no cursor is provided, then from the
|
|
1620
|
+
* beginning. If "before", then entries before the provided cursor will be
|
|
1621
|
+
* returned, or if no cursor is provided, then from the end. Entries will
|
|
1622
|
+
* always be returned in the specified sort-by order.
|
|
1623
|
+
*/
|
|
1624
|
+
mode?: ListMode;
|
|
1625
|
+
/** The ID of the object to list the links for. */
|
|
1626
|
+
object: string;
|
|
1627
|
+
/**
|
|
1628
|
+
* The link types to filter for, otherwise if not present, all link
|
|
1629
|
+
* types are included.
|
|
1630
|
+
* @deprecated
|
|
1631
|
+
*/
|
|
1632
|
+
types?: LinkType[];
|
|
1633
|
+
}
|
|
936
1634
|
/**
|
|
937
1635
|
* links-list-response
|
|
938
1636
|
* The response to listing the links.
|
|
@@ -981,6 +1679,31 @@ export declare enum MetricDefinitionMetricType {
|
|
|
981
1679
|
Time = "time",
|
|
982
1680
|
Value = "value"
|
|
983
1681
|
}
|
|
1682
|
+
/** metric-definitions-list-request */
|
|
1683
|
+
export interface MetricDefinitionsListRequest {
|
|
1684
|
+
/** The type of objects the metric definition applies to. */
|
|
1685
|
+
applies_to_type?: MetricDefinitionAppliesTo[];
|
|
1686
|
+
/**
|
|
1687
|
+
* The cursor to resume iteration from. If not provided, then
|
|
1688
|
+
* iteration starts from the beginning.
|
|
1689
|
+
*/
|
|
1690
|
+
cursor?: string;
|
|
1691
|
+
/**
|
|
1692
|
+
* The maximum number of records to return. The default is '50'.
|
|
1693
|
+
* @format int32
|
|
1694
|
+
*/
|
|
1695
|
+
limit?: number;
|
|
1696
|
+
/**
|
|
1697
|
+
* The iteration mode to use. If "after", then entries after the provided
|
|
1698
|
+
* cursor will be returned, or if no cursor is provided, then from the
|
|
1699
|
+
* beginning. If "before", then entries before the provided cursor will be
|
|
1700
|
+
* returned, or if no cursor is provided, then from the end. Entries will
|
|
1701
|
+
* always be returned in the specified sort-by order.
|
|
1702
|
+
*/
|
|
1703
|
+
mode?: ListMode;
|
|
1704
|
+
/** The type of metric definitions sought. */
|
|
1705
|
+
type?: MetricDefinitionMetricType[];
|
|
1706
|
+
}
|
|
984
1707
|
/** metric-definitions-list-response */
|
|
985
1708
|
export interface MetricDefinitionsListResponse {
|
|
986
1709
|
/** The list of metric definitions. */
|
|
@@ -1159,6 +1882,11 @@ export interface OrgScheduleFragmentsCreateRequest {
|
|
|
1159
1882
|
export interface OrgScheduleFragmentsCreateResponse {
|
|
1160
1883
|
org_schedule_fragment: OrgScheduleFragment;
|
|
1161
1884
|
}
|
|
1885
|
+
/** org-schedule-fragments-get-request */
|
|
1886
|
+
export interface OrgScheduleFragmentsGetRequest {
|
|
1887
|
+
/** Organization schedule Fragment ID. */
|
|
1888
|
+
id: string;
|
|
1889
|
+
}
|
|
1162
1890
|
/** org-schedule-fragments-get-response */
|
|
1163
1891
|
export interface OrgScheduleFragmentsGetResponse {
|
|
1164
1892
|
org_schedule_fragment: OrgScheduleFragment;
|
|
@@ -1223,10 +1951,43 @@ export interface OrgSchedulesCreateRequest {
|
|
|
1223
1951
|
export interface OrgSchedulesCreateResponse {
|
|
1224
1952
|
org_schedule: OrgSchedule;
|
|
1225
1953
|
}
|
|
1954
|
+
/** org-schedules-get-request */
|
|
1955
|
+
export interface OrgSchedulesGetRequest {
|
|
1956
|
+
/** Organization schedule ID. */
|
|
1957
|
+
id: string;
|
|
1958
|
+
}
|
|
1226
1959
|
/** org-schedules-get-response */
|
|
1227
1960
|
export interface OrgSchedulesGetResponse {
|
|
1228
1961
|
org_schedule: OrgSchedule;
|
|
1229
1962
|
}
|
|
1963
|
+
/** org-schedules-list-request */
|
|
1964
|
+
export interface OrgSchedulesListRequest {
|
|
1965
|
+
/** Creator ID the filter matches. */
|
|
1966
|
+
created_by_id?: string[];
|
|
1967
|
+
/**
|
|
1968
|
+
* The cursor to resume iteration from. If not provided, then
|
|
1969
|
+
* iteration starts from the beginning.
|
|
1970
|
+
*/
|
|
1971
|
+
cursor?: string;
|
|
1972
|
+
/**
|
|
1973
|
+
* Max number of organization schedules returned in a page. Default is
|
|
1974
|
+
* 50.
|
|
1975
|
+
* @format int32
|
|
1976
|
+
*/
|
|
1977
|
+
limit?: number;
|
|
1978
|
+
/**
|
|
1979
|
+
* The iteration mode to use. If "after", then entries after the provided
|
|
1980
|
+
* cursor will be returned, or if no cursor is provided, then from the
|
|
1981
|
+
* beginning. If "before", then entries before the provided cursor will be
|
|
1982
|
+
* returned, or if no cursor is provided, then from the end. Entries will
|
|
1983
|
+
* always be returned in the specified sort-by order.
|
|
1984
|
+
*/
|
|
1985
|
+
mode?: ListMode;
|
|
1986
|
+
/** The organization schedule statuses the filter matches. */
|
|
1987
|
+
status?: OrgScheduleStatus[];
|
|
1988
|
+
/** Provides ways to specify date ranges on objects. */
|
|
1989
|
+
valid_until?: DateFilter;
|
|
1990
|
+
}
|
|
1230
1991
|
/** org-schedules-list-response */
|
|
1231
1992
|
export interface OrgSchedulesListResponse {
|
|
1232
1993
|
/**
|
|
@@ -1325,6 +2086,16 @@ export declare enum PartType {
|
|
|
1325
2086
|
}
|
|
1326
2087
|
/** product-summary */
|
|
1327
2088
|
export type ProductSummary = PartBaseSummary;
|
|
2089
|
+
/**
|
|
2090
|
+
* resource
|
|
2091
|
+
* Resource details.
|
|
2092
|
+
*/
|
|
2093
|
+
export interface Resource {
|
|
2094
|
+
/** Ids of the artifacts. */
|
|
2095
|
+
artifacts?: ArtifactSummary[];
|
|
2096
|
+
/** URL of the external article. */
|
|
2097
|
+
url?: string;
|
|
2098
|
+
}
|
|
1328
2099
|
/** rev-org */
|
|
1329
2100
|
export type RevOrg = OrgBase & {
|
|
1330
2101
|
/** Custom fields. */
|
|
@@ -1390,6 +2161,17 @@ export interface RevOrgsCreateRequest {
|
|
|
1390
2161
|
export interface RevOrgsCreateResponse {
|
|
1391
2162
|
rev_org: RevOrg;
|
|
1392
2163
|
}
|
|
2164
|
+
/**
|
|
2165
|
+
* rev-orgs-get-request
|
|
2166
|
+
* Request object to get Rev organization's information.
|
|
2167
|
+
*/
|
|
2168
|
+
export interface RevOrgsGetRequest {
|
|
2169
|
+
/**
|
|
2170
|
+
* The ID of the required Rev organization.
|
|
2171
|
+
* @example "don:identity:<partition>:devo/<dev-org-id>:revo/<rev-org-id>"
|
|
2172
|
+
*/
|
|
2173
|
+
id: string;
|
|
2174
|
+
}
|
|
1393
2175
|
/**
|
|
1394
2176
|
* rev-orgs-get-response
|
|
1395
2177
|
* The response to getting a Rev organization's information.
|
|
@@ -1397,6 +2179,47 @@ export interface RevOrgsCreateResponse {
|
|
|
1397
2179
|
export interface RevOrgsGetResponse {
|
|
1398
2180
|
rev_org: RevOrg;
|
|
1399
2181
|
}
|
|
2182
|
+
/**
|
|
2183
|
+
* rev-orgs-list-request
|
|
2184
|
+
* A request to get the list of Rev organizations for the authenticated
|
|
2185
|
+
* user's Dev organization.
|
|
2186
|
+
*/
|
|
2187
|
+
export interface RevOrgsListRequest {
|
|
2188
|
+
/** Filters by creator. */
|
|
2189
|
+
created_by?: string[];
|
|
2190
|
+
created_date?: DateTimeFilter;
|
|
2191
|
+
/**
|
|
2192
|
+
* The cursor to resume iteration from. If not provided, then
|
|
2193
|
+
* iteration starts from the beginning.
|
|
2194
|
+
*/
|
|
2195
|
+
cursor?: string;
|
|
2196
|
+
/**
|
|
2197
|
+
* Filters on custom fields. Input will be of the format
|
|
2198
|
+
* (custom_field_filter=field_name1:val1,val2,val3&custom_field_filter=field_name2:val1,val2).
|
|
2199
|
+
*/
|
|
2200
|
+
custom_field_filter?: string[];
|
|
2201
|
+
/** List of external refs to filter Rev organizations for. */
|
|
2202
|
+
external_ref?: string[];
|
|
2203
|
+
/**
|
|
2204
|
+
* The maximum number of Rev organizations to be retrieved per page.
|
|
2205
|
+
* @format int32
|
|
2206
|
+
*/
|
|
2207
|
+
limit?: number;
|
|
2208
|
+
/**
|
|
2209
|
+
* The iteration mode to use. If "after", then entries after the provided
|
|
2210
|
+
* cursor will be returned, or if no cursor is provided, then from the
|
|
2211
|
+
* beginning. If "before", then entries before the provided cursor will be
|
|
2212
|
+
* returned, or if no cursor is provided, then from the end. Entries will
|
|
2213
|
+
* always be returned in the specified sort-by order.
|
|
2214
|
+
*/
|
|
2215
|
+
mode?: ListMode;
|
|
2216
|
+
modified_date?: DateTimeFilter;
|
|
2217
|
+
/**
|
|
2218
|
+
* Fields to sort the Rev organizations by and the direction to sort
|
|
2219
|
+
* them.
|
|
2220
|
+
*/
|
|
2221
|
+
sort_by?: string[];
|
|
2222
|
+
}
|
|
1400
2223
|
/**
|
|
1401
2224
|
* rev-orgs-list-response
|
|
1402
2225
|
* The response to getting a list of Rev organizations' information.
|
|
@@ -1546,6 +2369,14 @@ export interface RevUsersDeleteRequest {
|
|
|
1546
2369
|
* The response to deleting a Rev user of a Rev organization.
|
|
1547
2370
|
*/
|
|
1548
2371
|
export type RevUsersDeleteResponse = object;
|
|
2372
|
+
/**
|
|
2373
|
+
* rev-users-get-request
|
|
2374
|
+
* Request object to get a Rev user.
|
|
2375
|
+
*/
|
|
2376
|
+
export interface RevUsersGetRequest {
|
|
2377
|
+
/** The ID of Rev user to be retrieved. */
|
|
2378
|
+
id: string;
|
|
2379
|
+
}
|
|
1549
2380
|
/**
|
|
1550
2381
|
* rev-users-get-response
|
|
1551
2382
|
* The returned Rev user.
|
|
@@ -1553,6 +2384,48 @@ export type RevUsersDeleteResponse = object;
|
|
|
1553
2384
|
export interface RevUsersGetResponse {
|
|
1554
2385
|
rev_user: RevUser;
|
|
1555
2386
|
}
|
|
2387
|
+
/**
|
|
2388
|
+
* rev-users-list-request
|
|
2389
|
+
* Gets the list of Rev users belonging to the authenticated user's Dev
|
|
2390
|
+
* Organization which the user is also authorized to access.
|
|
2391
|
+
*/
|
|
2392
|
+
export interface RevUsersListRequest {
|
|
2393
|
+
/** Filters for Rev users that were created by the specified user(s). */
|
|
2394
|
+
created_by?: string[];
|
|
2395
|
+
created_date?: DateTimeFilter;
|
|
2396
|
+
/**
|
|
2397
|
+
* The cursor to resume iteration from. If not provided, then
|
|
2398
|
+
* iteration starts from the beginning.
|
|
2399
|
+
*/
|
|
2400
|
+
cursor?: string;
|
|
2401
|
+
/** List of emails of Rev users to be filtered. */
|
|
2402
|
+
email?: string[];
|
|
2403
|
+
/** List of external refs to filter Rev users for. */
|
|
2404
|
+
external_ref?: string[];
|
|
2405
|
+
/**
|
|
2406
|
+
* The maximum number of Rev users to return. The default is '50'.
|
|
2407
|
+
* @format int32
|
|
2408
|
+
*/
|
|
2409
|
+
limit?: number;
|
|
2410
|
+
/**
|
|
2411
|
+
* The iteration mode to use. If "after", then entries after the provided
|
|
2412
|
+
* cursor will be returned, or if no cursor is provided, then from the
|
|
2413
|
+
* beginning. If "before", then entries before the provided cursor will be
|
|
2414
|
+
* returned, or if no cursor is provided, then from the end. Entries will
|
|
2415
|
+
* always be returned in the specified sort-by order.
|
|
2416
|
+
*/
|
|
2417
|
+
mode?: ListMode;
|
|
2418
|
+
modified_date?: DateTimeFilter;
|
|
2419
|
+
/** List of phone numbers to filter Rev users on. */
|
|
2420
|
+
phone_numbers?: string[];
|
|
2421
|
+
/**
|
|
2422
|
+
* List of IDs of Rev organizations to be filtered.
|
|
2423
|
+
* @example ["don:identity:<partition>:devo/<dev-org-id>:revo/<rev-org-id>"]
|
|
2424
|
+
*/
|
|
2425
|
+
rev_org?: string[];
|
|
2426
|
+
/** Fields to sort the Rev users by and the direction to sort them. */
|
|
2427
|
+
sort_by?: string[];
|
|
2428
|
+
}
|
|
1556
2429
|
/**
|
|
1557
2430
|
* rev-users-list-response
|
|
1558
2431
|
* The response to listing all Rev users matching the filter criteria.
|
|
@@ -1990,6 +2863,26 @@ export type SchemaTokensListFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
|
1990
2863
|
/** The string suffix. */
|
|
1991
2864
|
suffix?: string;
|
|
1992
2865
|
};
|
|
2866
|
+
/** service-account */
|
|
2867
|
+
export type ServiceAccount = UserBase;
|
|
2868
|
+
/** service-account-summary */
|
|
2869
|
+
export type ServiceAccountSummary = UserBaseSummary;
|
|
2870
|
+
/**
|
|
2871
|
+
* service-accounts-get-request
|
|
2872
|
+
* The request object to get a service account's information.
|
|
2873
|
+
*/
|
|
2874
|
+
export interface ServiceAccountsGetRequest {
|
|
2875
|
+
/** The ID of the requested service account. */
|
|
2876
|
+
id: string;
|
|
2877
|
+
}
|
|
2878
|
+
/**
|
|
2879
|
+
* service-accounts-get-response
|
|
2880
|
+
* The response object that carries the service account's information
|
|
2881
|
+
* corresponding to the request.
|
|
2882
|
+
*/
|
|
2883
|
+
export interface ServiceAccountsGetResponse {
|
|
2884
|
+
service_account: ServiceAccount;
|
|
2885
|
+
}
|
|
1993
2886
|
/** set-org-schedule-fragment-summary */
|
|
1994
2887
|
export interface SetOrgScheduleFragmentSummary {
|
|
1995
2888
|
/** Organization schedule fragment ID. */
|
|
@@ -2178,6 +3071,11 @@ export declare enum SlaStatus {
|
|
|
2178
3071
|
Draft = "draft",
|
|
2179
3072
|
Published = "published"
|
|
2180
3073
|
}
|
|
3074
|
+
/**
|
|
3075
|
+
* sla-summary-filter
|
|
3076
|
+
* The filter for SLA summary.
|
|
3077
|
+
*/
|
|
3078
|
+
export type SlaSummaryFilter = object;
|
|
2181
3079
|
/** slas-assign-request */
|
|
2182
3080
|
export interface SlasAssignRequest {
|
|
2183
3081
|
/**
|
|
@@ -2222,10 +3120,38 @@ export interface SlasCreateRequest {
|
|
|
2222
3120
|
export interface SlasCreateResponse {
|
|
2223
3121
|
sla: Sla;
|
|
2224
3122
|
}
|
|
3123
|
+
/** slas-get-request */
|
|
3124
|
+
export interface SlasGetRequest {
|
|
3125
|
+
/** The ID of the SLA to get. */
|
|
3126
|
+
id: string;
|
|
3127
|
+
}
|
|
2225
3128
|
/** slas-get-response */
|
|
2226
3129
|
export interface SlasGetResponse {
|
|
2227
3130
|
sla: Sla;
|
|
2228
3131
|
}
|
|
3132
|
+
/** slas-list-request */
|
|
3133
|
+
export interface SlasListRequest {
|
|
3134
|
+
/**
|
|
3135
|
+
* The cursor to resume iteration from. If not provided, then
|
|
3136
|
+
* iteration starts from the beginning.
|
|
3137
|
+
*/
|
|
3138
|
+
cursor?: string;
|
|
3139
|
+
/**
|
|
3140
|
+
* The maximum number of SLAs to return. The default is '50'.
|
|
3141
|
+
* @format int32
|
|
3142
|
+
*/
|
|
3143
|
+
limit?: number;
|
|
3144
|
+
/**
|
|
3145
|
+
* The iteration mode to use. If "after", then entries after the provided
|
|
3146
|
+
* cursor will be returned, or if no cursor is provided, then from the
|
|
3147
|
+
* beginning. If "before", then entries before the provided cursor will be
|
|
3148
|
+
* returned, or if no cursor is provided, then from the end. Entries will
|
|
3149
|
+
* always be returned in the specified sort-by order.
|
|
3150
|
+
*/
|
|
3151
|
+
mode?: ListMode;
|
|
3152
|
+
/** The SLA statuses the filter matches. */
|
|
3153
|
+
status?: SlaStatus[];
|
|
3154
|
+
}
|
|
2229
3155
|
/** slas-list-response */
|
|
2230
3156
|
export interface SlasListResponse {
|
|
2231
3157
|
/**
|
|
@@ -2292,6 +3218,14 @@ export interface Stage {
|
|
|
2292
3218
|
/** Current stage name of the work item. */
|
|
2293
3219
|
name: string;
|
|
2294
3220
|
}
|
|
3221
|
+
/**
|
|
3222
|
+
* stage-filter
|
|
3223
|
+
* The filter for stages.
|
|
3224
|
+
*/
|
|
3225
|
+
export interface StageFilter {
|
|
3226
|
+
/** Filters for records in the provided stage(s). */
|
|
3227
|
+
name?: string[];
|
|
3228
|
+
}
|
|
2295
3229
|
/**
|
|
2296
3230
|
* stage-init
|
|
2297
3231
|
* Sets an object's initial stage.
|
|
@@ -2324,15 +3258,57 @@ export interface Subtype {
|
|
|
2324
3258
|
/** Value of the subtype. */
|
|
2325
3259
|
value: string;
|
|
2326
3260
|
}
|
|
3261
|
+
/** subtypes-list-request */
|
|
3262
|
+
export interface SubtypesListRequest {
|
|
3263
|
+
/**
|
|
3264
|
+
* Leaf type for which subtypes are required.
|
|
3265
|
+
* @deprecated
|
|
3266
|
+
*/
|
|
3267
|
+
leaf_type?: string;
|
|
3268
|
+
/** List of leaf types for which subtypes are required. */
|
|
3269
|
+
leaf_types?: string[];
|
|
3270
|
+
}
|
|
2327
3271
|
/** subtypes-list-response */
|
|
2328
3272
|
export interface SubtypesListResponse {
|
|
2329
3273
|
/** List of subtypes. */
|
|
2330
3274
|
subtypes: Subtype[];
|
|
2331
3275
|
}
|
|
3276
|
+
/**
|
|
3277
|
+
* survey-aggregation-filter
|
|
3278
|
+
* The filter for survey aggregation.
|
|
3279
|
+
*/
|
|
3280
|
+
export type SurveyAggregationFilter = object;
|
|
2332
3281
|
/** sys-user */
|
|
2333
3282
|
export type SysUser = UserBase;
|
|
2334
3283
|
/** sys-user-summary */
|
|
2335
3284
|
export type SysUserSummary = UserBaseSummary;
|
|
3285
|
+
/**
|
|
3286
|
+
* sys-users-list-request
|
|
3287
|
+
* A request to get the list of system user's information.
|
|
3288
|
+
*/
|
|
3289
|
+
export interface SysUsersListRequest {
|
|
3290
|
+
/**
|
|
3291
|
+
* The cursor to resume iteration from. If not provided, then
|
|
3292
|
+
* iteration starts from the beginning.
|
|
3293
|
+
*/
|
|
3294
|
+
cursor?: string;
|
|
3295
|
+
/**
|
|
3296
|
+
* The maximum number of system users to return. Value can range from
|
|
3297
|
+
* '1' to '100', with a default of '50'.
|
|
3298
|
+
* @format int32
|
|
3299
|
+
*/
|
|
3300
|
+
limit?: number;
|
|
3301
|
+
/**
|
|
3302
|
+
* The iteration mode to use. If "after", then entries after the provided
|
|
3303
|
+
* cursor will be returned, or if no cursor is provided, then from the
|
|
3304
|
+
* beginning. If "before", then entries before the provided cursor will be
|
|
3305
|
+
* returned, or if no cursor is provided, then from the end. Entries will
|
|
3306
|
+
* always be returned in the specified sort-by order.
|
|
3307
|
+
*/
|
|
3308
|
+
mode?: ListMode;
|
|
3309
|
+
/** Fields to sort the system users by and the direction to sort them. */
|
|
3310
|
+
sort_by?: string[];
|
|
3311
|
+
}
|
|
2336
3312
|
/**
|
|
2337
3313
|
* sys-users-list-response
|
|
2338
3314
|
* The response to listing the system users.
|
|
@@ -2401,6 +3377,8 @@ export declare enum TaskPriority {
|
|
|
2401
3377
|
}
|
|
2402
3378
|
/** task-summary */
|
|
2403
3379
|
export type TaskSummary = WorkBaseSummary;
|
|
3380
|
+
/** tenant-fragment */
|
|
3381
|
+
export type TenantFragment = CustomSchemaFragmentBase;
|
|
2404
3382
|
/** ticket */
|
|
2405
3383
|
export type Ticket = WorkBase & {
|
|
2406
3384
|
group?: GroupSummary;
|
|
@@ -2508,6 +3486,47 @@ export declare enum TimelineEntriesCreateRequestType {
|
|
|
2508
3486
|
export interface TimelineEntriesCreateResponse {
|
|
2509
3487
|
timeline_entry: TimelineEntry;
|
|
2510
3488
|
}
|
|
3489
|
+
/**
|
|
3490
|
+
* timeline-entries-list-request
|
|
3491
|
+
* The request to list timeline entries for an object.
|
|
3492
|
+
*/
|
|
3493
|
+
export interface TimelineEntriesListRequest {
|
|
3494
|
+
/**
|
|
3495
|
+
* The collection(s) to list entries from, otherwise if not provided,
|
|
3496
|
+
* all entries are returned.
|
|
3497
|
+
*/
|
|
3498
|
+
collections?: TimelineEntriesCollection[];
|
|
3499
|
+
/**
|
|
3500
|
+
* The cursor to resume iteration from. If not provided, then
|
|
3501
|
+
* iteration starts from the beginning.
|
|
3502
|
+
*/
|
|
3503
|
+
cursor?: string;
|
|
3504
|
+
/**
|
|
3505
|
+
* The maximum number of entries to return. If not set, then this
|
|
3506
|
+
* defaults to `50`.
|
|
3507
|
+
* @format int32
|
|
3508
|
+
*/
|
|
3509
|
+
limit?: number;
|
|
3510
|
+
/**
|
|
3511
|
+
* The iteration mode to use. If "after", then entries after the provided
|
|
3512
|
+
* cursor will be returned, or if no cursor is provided, then from the
|
|
3513
|
+
* beginning. If "before", then entries before the provided cursor will be
|
|
3514
|
+
* returned, or if no cursor is provided, then from the end. Entries will
|
|
3515
|
+
* always be returned in the specified sort-by order.
|
|
3516
|
+
*/
|
|
3517
|
+
mode?: ListMode;
|
|
3518
|
+
/**
|
|
3519
|
+
* The ID of the object to list timeline entries for.
|
|
3520
|
+
* @example "don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"
|
|
3521
|
+
*/
|
|
3522
|
+
object: string;
|
|
3523
|
+
/**
|
|
3524
|
+
* The visibility of the timeline entries to filter for. Note this is
|
|
3525
|
+
* a strict filter, such that only entries with the exact visibilities
|
|
3526
|
+
* specified will be returned.
|
|
3527
|
+
*/
|
|
3528
|
+
visibility?: TimelineEntryVisibility[];
|
|
3529
|
+
}
|
|
2511
3530
|
/**
|
|
2512
3531
|
* timeline-entries-list-response
|
|
2513
3532
|
* The response to listing timeline entries for an object.
|
|
@@ -2536,6 +3555,18 @@ export type TimelineEntryBase = AtomBase & {
|
|
|
2536
3555
|
object: string;
|
|
2537
3556
|
/** The type of object that the Timeline entry belongs to. */
|
|
2538
3557
|
object_type?: TimelineEntryObjectType;
|
|
3558
|
+
/** The reactions to the entry. */
|
|
3559
|
+
reactions?: TimelineReaction[];
|
|
3560
|
+
/** Thread. */
|
|
3561
|
+
thread?: TimelineThread;
|
|
3562
|
+
/**
|
|
3563
|
+
* The visibility of the entry. If 'private', then the entry is only
|
|
3564
|
+
* visible to the creator, 'internal' is visible with the Dev
|
|
3565
|
+
* organization, 'external' is visible to the Dev organzation and Rev
|
|
3566
|
+
* users, and 'public' is visible to all. If not set, then the default
|
|
3567
|
+
* visibility is 'external'.
|
|
3568
|
+
*/
|
|
3569
|
+
visibility?: TimelineEntryVisibility;
|
|
2539
3570
|
};
|
|
2540
3571
|
/** The type of object that the Timeline entry belongs to. */
|
|
2541
3572
|
export declare enum TimelineEntryObjectType {
|
|
@@ -2569,6 +3600,21 @@ export declare enum TimelineEntryVisibility {
|
|
|
2569
3600
|
Private = "private",
|
|
2570
3601
|
Public = "public"
|
|
2571
3602
|
}
|
|
3603
|
+
/**
|
|
3604
|
+
* timeline-reaction
|
|
3605
|
+
* Reaction.
|
|
3606
|
+
*/
|
|
3607
|
+
export interface TimelineReaction {
|
|
3608
|
+
/** The reaction emoji's unicode codepoint, e.g. "1f44d". */
|
|
3609
|
+
emoji?: string;
|
|
3610
|
+
/** Whether the requesting user reacted. */
|
|
3611
|
+
reacted?: boolean;
|
|
3612
|
+
/**
|
|
3613
|
+
* The total number of users with this reaction.
|
|
3614
|
+
* @format int32
|
|
3615
|
+
*/
|
|
3616
|
+
total_users?: number;
|
|
3617
|
+
}
|
|
2572
3618
|
/**
|
|
2573
3619
|
* timeline-snap-kit-body
|
|
2574
3620
|
* Snap Kit Body of the comment.
|
|
@@ -2586,6 +3632,17 @@ export interface TimelineSnapKitBody {
|
|
|
2586
3632
|
/** ID of the snap-in which created the SnapKit. */
|
|
2587
3633
|
snap_in_id?: string;
|
|
2588
3634
|
}
|
|
3635
|
+
/**
|
|
3636
|
+
* timeline-thread
|
|
3637
|
+
* Thread.
|
|
3638
|
+
*/
|
|
3639
|
+
export interface TimelineThread {
|
|
3640
|
+
/**
|
|
3641
|
+
* The total number of replies in the thread.
|
|
3642
|
+
* @format int32
|
|
3643
|
+
*/
|
|
3644
|
+
total_replies?: number;
|
|
3645
|
+
}
|
|
2589
3646
|
/**
|
|
2590
3647
|
* unlink-rev-user-from-rev-org-request
|
|
2591
3648
|
* A request to unlink a rev user from a rev org.
|
|
@@ -2641,12 +3698,13 @@ export declare enum UserState {
|
|
|
2641
3698
|
Unassigned = "unassigned"
|
|
2642
3699
|
}
|
|
2643
3700
|
/** user-summary */
|
|
2644
|
-
export type UserSummary = (DevUserSummary | RevUserSummary | SysUserSummary) & {
|
|
3701
|
+
export type UserSummary = (DevUserSummary | RevUserSummary | ServiceAccountSummary | SysUserSummary) & {
|
|
2645
3702
|
type: UserType;
|
|
2646
3703
|
};
|
|
2647
3704
|
export declare enum UserType {
|
|
2648
3705
|
DevUser = "dev_user",
|
|
2649
3706
|
RevUser = "rev_user",
|
|
3707
|
+
ServiceAccount = "service_account",
|
|
2650
3708
|
SysUser = "sys_user"
|
|
2651
3709
|
}
|
|
2652
3710
|
/**
|
|
@@ -2828,15 +3886,165 @@ export interface WorksDeleteRequest {
|
|
|
2828
3886
|
}
|
|
2829
3887
|
/** works-delete-response */
|
|
2830
3888
|
export type WorksDeleteResponse = object;
|
|
3889
|
+
/** works-export-request */
|
|
3890
|
+
export interface WorksExportRequest {
|
|
3891
|
+
/** Provides ways to specify date ranges on objects. */
|
|
3892
|
+
actual_close_date?: DateFilter;
|
|
3893
|
+
/**
|
|
3894
|
+
* Filters for work belonging to any of the provided parts.
|
|
3895
|
+
* @example ["don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"]
|
|
3896
|
+
*/
|
|
3897
|
+
applies_to_part?: string[];
|
|
3898
|
+
/**
|
|
3899
|
+
* Filters for work created by any of these users.
|
|
3900
|
+
* @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
|
|
3901
|
+
*/
|
|
3902
|
+
created_by?: string[];
|
|
3903
|
+
/** Provides ways to specify date ranges on objects. */
|
|
3904
|
+
created_date?: DateFilter;
|
|
3905
|
+
/** Filters for custom fields. */
|
|
3906
|
+
custom_fields?: object;
|
|
3907
|
+
/**
|
|
3908
|
+
* The number of work items to return. The default is '50', the
|
|
3909
|
+
* maximum is '5000'.
|
|
3910
|
+
* @format int32
|
|
3911
|
+
*/
|
|
3912
|
+
first?: number;
|
|
3913
|
+
issue?: WorksFilterIssue;
|
|
3914
|
+
/** Provides ways to specify date ranges on objects. */
|
|
3915
|
+
modified_date?: DateFilter;
|
|
3916
|
+
opportunity?: WorksFilterOpportunity;
|
|
3917
|
+
/**
|
|
3918
|
+
* Filters for work owned by any of these users.
|
|
3919
|
+
* @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
|
|
3920
|
+
*/
|
|
3921
|
+
owned_by?: string[];
|
|
3922
|
+
/** Fields to sort the work items by and the direction to sort them. */
|
|
3923
|
+
sort_by?: string[];
|
|
3924
|
+
/** The filter for stages. */
|
|
3925
|
+
stage?: StageFilter;
|
|
3926
|
+
/** Provides ways to specify date ranges on objects. */
|
|
3927
|
+
target_close_date?: DateFilter;
|
|
3928
|
+
ticket?: WorksFilterTicket;
|
|
3929
|
+
/** Filters for work of the provided types. */
|
|
3930
|
+
type?: WorkType[];
|
|
3931
|
+
}
|
|
2831
3932
|
/** works-export-response */
|
|
2832
3933
|
export interface WorksExportResponse {
|
|
2833
3934
|
/** The resulting collection of work items. */
|
|
2834
3935
|
works: Work[];
|
|
2835
3936
|
}
|
|
3937
|
+
/** works-filter-issue */
|
|
3938
|
+
export interface WorksFilterIssue {
|
|
3939
|
+
/** Filters for issues with any of the provided priorities. */
|
|
3940
|
+
priority?: IssuePriority[];
|
|
3941
|
+
/**
|
|
3942
|
+
* Filters for issues with any of the provided Rev organizations.
|
|
3943
|
+
* @example ["don:identity:<partition>:devo/<dev-org-id>:revo/<rev-org-id>"]
|
|
3944
|
+
*/
|
|
3945
|
+
rev_orgs?: string[];
|
|
3946
|
+
}
|
|
3947
|
+
/** works-filter-opportunity */
|
|
3948
|
+
export interface WorksFilterOpportunity {
|
|
3949
|
+
/**
|
|
3950
|
+
* Filters for opportunities belonging to any of the provided
|
|
3951
|
+
* accounts.
|
|
3952
|
+
* @example ["don:core:<partition>:devo/<dev-org-id>:account/<account-id>"]
|
|
3953
|
+
*/
|
|
3954
|
+
account?: string[];
|
|
3955
|
+
/** Filters for opportunities with any of the provided contacts. */
|
|
3956
|
+
contacts?: string[];
|
|
3957
|
+
}
|
|
3958
|
+
/** works-filter-ticket */
|
|
3959
|
+
export interface WorksFilterTicket {
|
|
3960
|
+
/** Filters for tickets belonging to specific groups. */
|
|
3961
|
+
group?: string[];
|
|
3962
|
+
/** Filters for tickets that are spam. */
|
|
3963
|
+
is_spam?: boolean;
|
|
3964
|
+
/** Filters for tickets that need response. */
|
|
3965
|
+
needs_response?: boolean;
|
|
3966
|
+
/**
|
|
3967
|
+
* Filters for tickets that are associated with any of the provided
|
|
3968
|
+
* Rev organizations.
|
|
3969
|
+
* @example ["don:identity:<partition>:devo/<dev-org-id>:revo/<rev-org-id>"]
|
|
3970
|
+
*/
|
|
3971
|
+
rev_org?: string[];
|
|
3972
|
+
/** Filters for tickets with any of the provided severities. */
|
|
3973
|
+
severity?: TicketSeverity[];
|
|
3974
|
+
/** The filter for SLA summary. */
|
|
3975
|
+
sla_summary?: SlaSummaryFilter;
|
|
3976
|
+
/** Filters for tickets with any of the provided source channels. */
|
|
3977
|
+
source_channel?: string[];
|
|
3978
|
+
/** The filter for survey aggregation. */
|
|
3979
|
+
surveys?: SurveyAggregationFilter;
|
|
3980
|
+
}
|
|
3981
|
+
/** works-get-request */
|
|
3982
|
+
export interface WorksGetRequest {
|
|
3983
|
+
/**
|
|
3984
|
+
* The work's ID.
|
|
3985
|
+
* @example "don:core:<partition>:devo/<dev-org-id>:<work-type>/<work-id>"
|
|
3986
|
+
*/
|
|
3987
|
+
id: string;
|
|
3988
|
+
}
|
|
2836
3989
|
/** works-get-response */
|
|
2837
3990
|
export interface WorksGetResponse {
|
|
2838
3991
|
work: Work;
|
|
2839
3992
|
}
|
|
3993
|
+
/** works-list-request */
|
|
3994
|
+
export interface WorksListRequest {
|
|
3995
|
+
/** Provides ways to specify date ranges on objects. */
|
|
3996
|
+
actual_close_date?: DateFilter;
|
|
3997
|
+
/**
|
|
3998
|
+
* Filters for work belonging to any of the provided parts.
|
|
3999
|
+
* @example ["don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"]
|
|
4000
|
+
*/
|
|
4001
|
+
applies_to_part?: string[];
|
|
4002
|
+
/**
|
|
4003
|
+
* Filters for work created by any of these users.
|
|
4004
|
+
* @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
|
|
4005
|
+
*/
|
|
4006
|
+
created_by?: string[];
|
|
4007
|
+
/** Provides ways to specify date ranges on objects. */
|
|
4008
|
+
created_date?: DateFilter;
|
|
4009
|
+
/**
|
|
4010
|
+
* The cursor to resume iteration from. If not provided, then
|
|
4011
|
+
* iteration starts from the beginning.
|
|
4012
|
+
*/
|
|
4013
|
+
cursor?: string;
|
|
4014
|
+
/** Filters for custom fields. */
|
|
4015
|
+
custom_fields?: object;
|
|
4016
|
+
issue?: WorksFilterIssue;
|
|
4017
|
+
/**
|
|
4018
|
+
* The maximum number of works to return. The default is '50'.
|
|
4019
|
+
* @format int32
|
|
4020
|
+
*/
|
|
4021
|
+
limit?: number;
|
|
4022
|
+
/**
|
|
4023
|
+
* The iteration mode to use. If "after", then entries after the provided
|
|
4024
|
+
* cursor will be returned, or if no cursor is provided, then from the
|
|
4025
|
+
* beginning. If "before", then entries before the provided cursor will be
|
|
4026
|
+
* returned, or if no cursor is provided, then from the end. Entries will
|
|
4027
|
+
* always be returned in the specified sort-by order.
|
|
4028
|
+
*/
|
|
4029
|
+
mode?: ListMode;
|
|
4030
|
+
/** Provides ways to specify date ranges on objects. */
|
|
4031
|
+
modified_date?: DateFilter;
|
|
4032
|
+
opportunity?: WorksFilterOpportunity;
|
|
4033
|
+
/**
|
|
4034
|
+
* Filters for work owned by any of these users.
|
|
4035
|
+
* @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
|
|
4036
|
+
*/
|
|
4037
|
+
owned_by?: string[];
|
|
4038
|
+
/** Fields to sort the works by and the direction to sort them. */
|
|
4039
|
+
sort_by?: string[];
|
|
4040
|
+
/** The filter for stages. */
|
|
4041
|
+
stage?: StageFilter;
|
|
4042
|
+
/** Provides ways to specify date ranges on objects. */
|
|
4043
|
+
target_close_date?: DateFilter;
|
|
4044
|
+
ticket?: WorksFilterTicket;
|
|
4045
|
+
/** Filters for work of the provided types. */
|
|
4046
|
+
type?: WorkType[];
|
|
4047
|
+
}
|
|
2840
4048
|
/** works-list-response */
|
|
2841
4049
|
export interface WorksListResponse {
|
|
2842
4050
|
/**
|
|
@@ -2855,7 +4063,7 @@ export interface WorksListResponse {
|
|
|
2855
4063
|
/** works-update-request */
|
|
2856
4064
|
export type WorksUpdateRequest = (WorksUpdateRequestIssue | WorksUpdateRequestOpportunity | WorksUpdateRequestTask | WorksUpdateRequestTicket) & {
|
|
2857
4065
|
/**
|
|
2858
|
-
* Updates the part that the work applies to.
|
|
4066
|
+
* Updates the part that the work item applies to.
|
|
2859
4067
|
* @example "don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"
|
|
2860
4068
|
*/
|
|
2861
4069
|
applies_to_part?: string;
|
|
@@ -3087,63 +4295,233 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3087
4295
|
* Filters for objects created after the provided timestamp (inclusive).
|
|
3088
4296
|
* @format date-time
|
|
3089
4297
|
*/
|
|
3090
|
-
'modified_date.after'?: string;
|
|
4298
|
+
'modified_date.after'?: string;
|
|
4299
|
+
/**
|
|
4300
|
+
* Filters for objects created before the provided timestamp
|
|
4301
|
+
* (inclusive).
|
|
4302
|
+
* @format date-time
|
|
4303
|
+
*/
|
|
4304
|
+
'modified_date.before'?: string;
|
|
4305
|
+
/** Fields to sort the accounts by and the direction to sort them in. */
|
|
4306
|
+
sort_by?: string[];
|
|
4307
|
+
}, params?: RequestParams) => Promise<AxiosResponse<AccountsExportResponse, any>>;
|
|
4308
|
+
/**
|
|
4309
|
+
* @description Exports a collection of accounts.
|
|
4310
|
+
*
|
|
4311
|
+
* @tags accounts
|
|
4312
|
+
* @name AccountsExportPost
|
|
4313
|
+
* @request POST:/accounts.export
|
|
4314
|
+
* @secure
|
|
4315
|
+
*/
|
|
4316
|
+
accountsExportPost: (data: AccountsExportRequest, params?: RequestParams) => Promise<AxiosResponse<AccountsExportResponse, any>>;
|
|
4317
|
+
/**
|
|
4318
|
+
* @description Retrieves an account's information.
|
|
4319
|
+
*
|
|
4320
|
+
* @tags accounts
|
|
4321
|
+
* @name AccountsGet
|
|
4322
|
+
* @request GET:/accounts.get
|
|
4323
|
+
* @secure
|
|
4324
|
+
*/
|
|
4325
|
+
accountsGet: (query: {
|
|
4326
|
+
/**
|
|
4327
|
+
* The ID of the account to be retrieved.
|
|
4328
|
+
* @example "don:core:<partition>:devo/<dev-org-id>:account/<account-id>"
|
|
4329
|
+
*/
|
|
4330
|
+
id: string;
|
|
4331
|
+
}, params?: RequestParams) => Promise<AxiosResponse<AccountsGetResponse, any>>;
|
|
4332
|
+
/**
|
|
4333
|
+
* @description Retrieves an account's information.
|
|
4334
|
+
*
|
|
4335
|
+
* @tags accounts
|
|
4336
|
+
* @name AccountsGetPost
|
|
4337
|
+
* @request POST:/accounts.get
|
|
4338
|
+
* @secure
|
|
4339
|
+
*/
|
|
4340
|
+
accountsGetPost: (data: AccountsGetRequest, params?: RequestParams) => Promise<AxiosResponse<AccountsGetResponse, any>>;
|
|
4341
|
+
/**
|
|
4342
|
+
* @description Gets a list of accounts.
|
|
4343
|
+
*
|
|
4344
|
+
* @tags accounts
|
|
4345
|
+
* @name AccountsList
|
|
4346
|
+
* @request GET:/accounts.list
|
|
4347
|
+
* @secure
|
|
4348
|
+
*/
|
|
4349
|
+
accountsList: (query?: {
|
|
4350
|
+
/** Filters for accounts created by the specified user(s). */
|
|
4351
|
+
created_by?: string[];
|
|
4352
|
+
/**
|
|
4353
|
+
* Filters for objects created after the provided timestamp (inclusive).
|
|
4354
|
+
* @format date-time
|
|
4355
|
+
*/
|
|
4356
|
+
'created_date.after'?: string;
|
|
4357
|
+
/**
|
|
4358
|
+
* Filters for objects created before the provided timestamp
|
|
4359
|
+
* (inclusive).
|
|
4360
|
+
* @format date-time
|
|
4361
|
+
*/
|
|
4362
|
+
'created_date.before'?: string;
|
|
4363
|
+
/**
|
|
4364
|
+
* The cursor to resume iteration from. If not provided, then iteration
|
|
4365
|
+
* starts from the beginning.
|
|
4366
|
+
*/
|
|
4367
|
+
cursor?: string;
|
|
4368
|
+
/** Array of references of accounts to be filtered. */
|
|
4369
|
+
external_refs?: string[];
|
|
4370
|
+
/**
|
|
4371
|
+
* The maximum number of accounts to return per page. The default is
|
|
4372
|
+
* '50'.
|
|
4373
|
+
* @format int32
|
|
4374
|
+
*/
|
|
4375
|
+
limit?: number;
|
|
4376
|
+
/**
|
|
4377
|
+
* The iteration mode to use, otherwise if not set, then "after" is
|
|
4378
|
+
* used.
|
|
4379
|
+
*/
|
|
4380
|
+
mode?: ListMode;
|
|
4381
|
+
/**
|
|
4382
|
+
* Filters for objects created after the provided timestamp (inclusive).
|
|
4383
|
+
* @format date-time
|
|
4384
|
+
*/
|
|
4385
|
+
'modified_date.after'?: string;
|
|
4386
|
+
/**
|
|
4387
|
+
* Filters for objects created before the provided timestamp
|
|
4388
|
+
* (inclusive).
|
|
4389
|
+
* @format date-time
|
|
4390
|
+
*/
|
|
4391
|
+
'modified_date.before'?: string;
|
|
4392
|
+
/** Fields to sort the accounts by and the direction to sort them in. */
|
|
4393
|
+
sort_by?: string[];
|
|
4394
|
+
}, params?: RequestParams) => Promise<AxiosResponse<AccountsListResponse, any>>;
|
|
4395
|
+
/**
|
|
4396
|
+
* @description Gets a list of accounts.
|
|
4397
|
+
*
|
|
4398
|
+
* @tags accounts
|
|
4399
|
+
* @name AccountsListPost
|
|
4400
|
+
* @request POST:/accounts.list
|
|
4401
|
+
* @secure
|
|
4402
|
+
*/
|
|
4403
|
+
accountsListPost: (data: AccountsListRequest, params?: RequestParams) => Promise<AxiosResponse<AccountsListResponse, any>>;
|
|
4404
|
+
/**
|
|
4405
|
+
* @description Updates an account's information.
|
|
4406
|
+
*
|
|
4407
|
+
* @tags accounts
|
|
4408
|
+
* @name AccountsUpdate
|
|
4409
|
+
* @request POST:/accounts.update
|
|
4410
|
+
* @secure
|
|
4411
|
+
*/
|
|
4412
|
+
accountsUpdate: (data: AccountsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<AccountsUpdateResponse, any>>;
|
|
4413
|
+
/**
|
|
4414
|
+
* @description Get count of articles matching given filter.
|
|
4415
|
+
*
|
|
4416
|
+
* @tags articles
|
|
4417
|
+
* @name ArticlesCount
|
|
4418
|
+
* @request GET:/articles.count
|
|
4419
|
+
* @secure
|
|
4420
|
+
*/
|
|
4421
|
+
articlesCount: (query?: {
|
|
4422
|
+
/**
|
|
4423
|
+
* Filters for articles belonging to any of the provided parts.
|
|
4424
|
+
* @example ["don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"]
|
|
4425
|
+
*/
|
|
4426
|
+
applies_to_parts?: string[];
|
|
4427
|
+
/**
|
|
4428
|
+
* Filters for articles authored by any of the provided users.
|
|
4429
|
+
* @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
|
|
4430
|
+
*/
|
|
4431
|
+
authored_by?: string[];
|
|
4432
|
+
/**
|
|
4433
|
+
* Filters for articles created by any of the provided users.
|
|
4434
|
+
* @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
|
|
4435
|
+
*/
|
|
4436
|
+
created_by?: string[];
|
|
3091
4437
|
/**
|
|
3092
|
-
* Filters for
|
|
3093
|
-
*
|
|
3094
|
-
* @format date-time
|
|
4438
|
+
* Filters for articles owned by any of the provided users.
|
|
4439
|
+
* @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
|
|
3095
4440
|
*/
|
|
3096
|
-
|
|
3097
|
-
|
|
3098
|
-
sort_by?: string[];
|
|
3099
|
-
}, params?: RequestParams) => Promise<AxiosResponse<AccountsExportResponse, any>>;
|
|
4441
|
+
owned_by?: string[];
|
|
4442
|
+
}, params?: RequestParams) => Promise<AxiosResponse<ArticlesCountResponse, any>>;
|
|
3100
4443
|
/**
|
|
3101
|
-
* @description
|
|
4444
|
+
* @description Get count of articles matching given filter.
|
|
3102
4445
|
*
|
|
3103
|
-
* @tags
|
|
3104
|
-
* @name
|
|
3105
|
-
* @request
|
|
4446
|
+
* @tags articles
|
|
4447
|
+
* @name ArticlesCountPost
|
|
4448
|
+
* @request POST:/articles.count
|
|
3106
4449
|
* @secure
|
|
3107
4450
|
*/
|
|
3108
|
-
|
|
4451
|
+
articlesCountPost: (data: ArticlesCountRequest, params?: RequestParams) => Promise<AxiosResponse<ArticlesCountResponse, any>>;
|
|
4452
|
+
/**
|
|
4453
|
+
* @description Article is an object which can contain a URL or artifacts in the resource. It also contains the data regarding the owner, author, status and published date of the object. This call creates an article.
|
|
4454
|
+
*
|
|
4455
|
+
* @tags articles
|
|
4456
|
+
* @name CreateArticle
|
|
4457
|
+
* @request POST:/articles.create
|
|
4458
|
+
* @secure
|
|
4459
|
+
*/
|
|
4460
|
+
createArticle: (data: ArticlesCreateRequest, params?: RequestParams) => Promise<AxiosResponse<ArticlesCreateResponse, any>>;
|
|
4461
|
+
/**
|
|
4462
|
+
* @description Deletes an article.
|
|
4463
|
+
*
|
|
4464
|
+
* @tags articles
|
|
4465
|
+
* @name DeleteArticle
|
|
4466
|
+
* @request POST:/articles.delete
|
|
4467
|
+
* @secure
|
|
4468
|
+
*/
|
|
4469
|
+
deleteArticle: (data: ArticlesDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<void, any>>;
|
|
4470
|
+
/**
|
|
4471
|
+
* @description Gets an article.
|
|
4472
|
+
*
|
|
4473
|
+
* @tags articles
|
|
4474
|
+
* @name GetArticle
|
|
4475
|
+
* @request GET:/articles.get
|
|
4476
|
+
* @secure
|
|
4477
|
+
*/
|
|
4478
|
+
getArticle: (query: {
|
|
3109
4479
|
/**
|
|
3110
|
-
* The ID of the
|
|
3111
|
-
* @example "don:core:<partition>:devo/<dev-org-id>:
|
|
4480
|
+
* The ID of the required article.
|
|
4481
|
+
* @example "don:core:<partition>:devo/<dev-org-id>:article/<article-id>"
|
|
3112
4482
|
*/
|
|
3113
4483
|
id: string;
|
|
3114
|
-
}, params?: RequestParams) => Promise<AxiosResponse<
|
|
4484
|
+
}, params?: RequestParams) => Promise<AxiosResponse<ArticlesGetResponse, any>>;
|
|
3115
4485
|
/**
|
|
3116
|
-
* @description Gets
|
|
4486
|
+
* @description Gets an article.
|
|
3117
4487
|
*
|
|
3118
|
-
* @tags
|
|
3119
|
-
* @name
|
|
3120
|
-
* @request
|
|
4488
|
+
* @tags articles
|
|
4489
|
+
* @name GetArticlePost
|
|
4490
|
+
* @request POST:/articles.get
|
|
3121
4491
|
* @secure
|
|
3122
4492
|
*/
|
|
3123
|
-
|
|
3124
|
-
|
|
3125
|
-
|
|
4493
|
+
getArticlePost: (data: ArticlesGetRequest, params?: RequestParams) => Promise<AxiosResponse<ArticlesGetResponse, any>>;
|
|
4494
|
+
/**
|
|
4495
|
+
* @description Lists a collection of articles.
|
|
4496
|
+
*
|
|
4497
|
+
* @tags articles
|
|
4498
|
+
* @name ListArticles
|
|
4499
|
+
* @request GET:/articles.list
|
|
4500
|
+
* @secure
|
|
4501
|
+
*/
|
|
4502
|
+
listArticles: (query?: {
|
|
3126
4503
|
/**
|
|
3127
|
-
* Filters for
|
|
3128
|
-
* @
|
|
4504
|
+
* Filters for articles belonging to any of the provided parts.
|
|
4505
|
+
* @example ["don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"]
|
|
3129
4506
|
*/
|
|
3130
|
-
|
|
4507
|
+
applies_to_parts?: string[];
|
|
3131
4508
|
/**
|
|
3132
|
-
* Filters for
|
|
3133
|
-
*
|
|
3134
|
-
* @format date-time
|
|
4509
|
+
* Filters for articles authored by any of the provided users.
|
|
4510
|
+
* @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
|
|
3135
4511
|
*/
|
|
3136
|
-
|
|
4512
|
+
authored_by?: string[];
|
|
4513
|
+
/**
|
|
4514
|
+
* Filters for articles created by any of the provided users.
|
|
4515
|
+
* @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
|
|
4516
|
+
*/
|
|
4517
|
+
created_by?: string[];
|
|
3137
4518
|
/**
|
|
3138
4519
|
* The cursor to resume iteration from. If not provided, then iteration
|
|
3139
4520
|
* starts from the beginning.
|
|
3140
4521
|
*/
|
|
3141
4522
|
cursor?: string;
|
|
3142
|
-
/** Array of references of accounts to be filtered. */
|
|
3143
|
-
external_refs?: string[];
|
|
3144
4523
|
/**
|
|
3145
|
-
* The maximum number of
|
|
3146
|
-
* '50'.
|
|
4524
|
+
* The maximum number of articles to return. The default is '50'.
|
|
3147
4525
|
* @format int32
|
|
3148
4526
|
*/
|
|
3149
4527
|
limit?: number;
|
|
@@ -3153,28 +4531,29 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3153
4531
|
*/
|
|
3154
4532
|
mode?: ListMode;
|
|
3155
4533
|
/**
|
|
3156
|
-
* Filters for
|
|
3157
|
-
* @
|
|
3158
|
-
*/
|
|
3159
|
-
'modified_date.after'?: string;
|
|
3160
|
-
/**
|
|
3161
|
-
* Filters for objects created before the provided timestamp
|
|
3162
|
-
* (inclusive).
|
|
3163
|
-
* @format date-time
|
|
4534
|
+
* Filters for articles owned by any of the provided users.
|
|
4535
|
+
* @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
|
|
3164
4536
|
*/
|
|
3165
|
-
|
|
3166
|
-
|
|
3167
|
-
sort_by?: string[];
|
|
3168
|
-
}, params?: RequestParams) => Promise<AxiosResponse<AccountsListResponse, any>>;
|
|
4537
|
+
owned_by?: string[];
|
|
4538
|
+
}, params?: RequestParams) => Promise<AxiosResponse<ArticlesListResponse, any>>;
|
|
3169
4539
|
/**
|
|
3170
|
-
* @description
|
|
4540
|
+
* @description Lists a collection of articles.
|
|
3171
4541
|
*
|
|
3172
|
-
* @tags
|
|
3173
|
-
* @name
|
|
3174
|
-
* @request POST:/
|
|
4542
|
+
* @tags articles
|
|
4543
|
+
* @name ListArticlesPost
|
|
4544
|
+
* @request POST:/articles.list
|
|
3175
4545
|
* @secure
|
|
3176
4546
|
*/
|
|
3177
|
-
|
|
4547
|
+
listArticlesPost: (data: ArticlesListRequest, params?: RequestParams) => Promise<AxiosResponse<ArticlesListResponse, any>>;
|
|
4548
|
+
/**
|
|
4549
|
+
* @description Updates an article.
|
|
4550
|
+
*
|
|
4551
|
+
* @tags articles
|
|
4552
|
+
* @name UpdateArticle
|
|
4553
|
+
* @request POST:/articles.update
|
|
4554
|
+
* @secure
|
|
4555
|
+
*/
|
|
4556
|
+
updateArticle: (data: ArticlesUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<ArticlesUpdateResponse, any>>;
|
|
3178
4557
|
/**
|
|
3179
4558
|
* @description Creates a conversation.
|
|
3180
4559
|
*
|
|
@@ -3215,6 +4594,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3215
4594
|
first?: number;
|
|
3216
4595
|
/** Filters for conversation that belong to the given groups. */
|
|
3217
4596
|
group?: string[];
|
|
4597
|
+
/** Filters for conversations that are created by verified users. */
|
|
4598
|
+
is_creator_verified?: boolean;
|
|
3218
4599
|
/** Filters for conversations that are spam. */
|
|
3219
4600
|
is_spam?: boolean;
|
|
3220
4601
|
/**
|
|
@@ -3243,6 +4624,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3243
4624
|
*/
|
|
3244
4625
|
tags?: string[];
|
|
3245
4626
|
}, params?: RequestParams) => Promise<AxiosResponse<ConversationsExportResponse, any>>;
|
|
4627
|
+
/**
|
|
4628
|
+
* @description Exports a collection of conversation items.
|
|
4629
|
+
*
|
|
4630
|
+
* @tags conversations
|
|
4631
|
+
* @name ConversationsExportPost
|
|
4632
|
+
* @request POST:/conversations.export
|
|
4633
|
+
* @secure
|
|
4634
|
+
*/
|
|
4635
|
+
conversationsExportPost: (data: ConversationsExportRequest, params?: RequestParams) => Promise<AxiosResponse<ConversationsExportResponse, any>>;
|
|
3246
4636
|
/**
|
|
3247
4637
|
* @description Gets the requested conversation's information.
|
|
3248
4638
|
*
|
|
@@ -3255,6 +4645,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3255
4645
|
/** The requested conversation's ID. */
|
|
3256
4646
|
id: string;
|
|
3257
4647
|
}, params?: RequestParams) => Promise<AxiosResponse<ConversationsGetResponse, any>>;
|
|
4648
|
+
/**
|
|
4649
|
+
* @description Gets the requested conversation's information.
|
|
4650
|
+
*
|
|
4651
|
+
* @tags conversations
|
|
4652
|
+
* @name ConversationsGetPost
|
|
4653
|
+
* @request POST:/conversations.get
|
|
4654
|
+
* @secure
|
|
4655
|
+
*/
|
|
4656
|
+
conversationsGetPost: (data: ConversationsGetRequest, params?: RequestParams) => Promise<AxiosResponse<ConversationsGetResponse, any>>;
|
|
3258
4657
|
/**
|
|
3259
4658
|
* @description Lists the available conversations.
|
|
3260
4659
|
*
|
|
@@ -3276,6 +4675,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3276
4675
|
cursor?: string;
|
|
3277
4676
|
/** Filters for conversation that belong to the given groups. */
|
|
3278
4677
|
group?: string[];
|
|
4678
|
+
/** Filters for conversations that are created by verified users. */
|
|
4679
|
+
is_creator_verified?: boolean;
|
|
3279
4680
|
/** Filters for conversations that are spam. */
|
|
3280
4681
|
is_spam?: boolean;
|
|
3281
4682
|
/**
|
|
@@ -3314,6 +4715,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3314
4715
|
*/
|
|
3315
4716
|
tags?: string[];
|
|
3316
4717
|
}, params?: RequestParams) => Promise<AxiosResponse<ConversationsListResponse, any>>;
|
|
4718
|
+
/**
|
|
4719
|
+
* @description Lists the available conversations.
|
|
4720
|
+
*
|
|
4721
|
+
* @tags conversations
|
|
4722
|
+
* @name ConversationsListPost
|
|
4723
|
+
* @request POST:/conversations.list
|
|
4724
|
+
* @secure
|
|
4725
|
+
*/
|
|
4726
|
+
conversationsListPost: (data: ConversationsListRequest, params?: RequestParams) => Promise<AxiosResponse<ConversationsListResponse, any>>;
|
|
3317
4727
|
/**
|
|
3318
4728
|
* @description Updates the requested conversation.
|
|
3319
4729
|
*
|
|
@@ -3347,6 +4757,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3347
4757
|
/** Filters for engagement of the provided types. */
|
|
3348
4758
|
type?: EngagementType[];
|
|
3349
4759
|
}, params?: RequestParams) => Promise<AxiosResponse<EngagementsCountResponse, any>>;
|
|
4760
|
+
/**
|
|
4761
|
+
* @description Counts the engagement records.
|
|
4762
|
+
*
|
|
4763
|
+
* @tags engagements
|
|
4764
|
+
* @name EngagementsCountPost
|
|
4765
|
+
* @request POST:/engagements.count
|
|
4766
|
+
* @secure
|
|
4767
|
+
*/
|
|
4768
|
+
engagementsCountPost: (data: EngagementsCountRequest, params?: RequestParams) => Promise<AxiosResponse<EngagementsCountResponse, any>>;
|
|
3350
4769
|
/**
|
|
3351
4770
|
* @description Creates a new engagement record.
|
|
3352
4771
|
*
|
|
@@ -3377,6 +4796,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3377
4796
|
/** The engagement ID. */
|
|
3378
4797
|
id: string;
|
|
3379
4798
|
}, params?: RequestParams) => Promise<AxiosResponse<EngagementsGetResponse, any>>;
|
|
4799
|
+
/**
|
|
4800
|
+
* @description Gets the engagement record.
|
|
4801
|
+
*
|
|
4802
|
+
* @tags engagements
|
|
4803
|
+
* @name EngagementsGetPost
|
|
4804
|
+
* @request POST:/engagements.get
|
|
4805
|
+
* @secure
|
|
4806
|
+
*/
|
|
4807
|
+
engagementsGetPost: (data: EngagementsGetRequest, params?: RequestParams) => Promise<AxiosResponse<EngagementsGetResponse, any>>;
|
|
3380
4808
|
/**
|
|
3381
4809
|
* @description Lists the engagement records.
|
|
3382
4810
|
*
|
|
@@ -3418,6 +4846,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3418
4846
|
/** Filters for engagement of the provided types. */
|
|
3419
4847
|
type?: EngagementType[];
|
|
3420
4848
|
}, params?: RequestParams) => Promise<AxiosResponse<EngagementsListResponse, any>>;
|
|
4849
|
+
/**
|
|
4850
|
+
* @description Lists the engagement records.
|
|
4851
|
+
*
|
|
4852
|
+
* @tags engagements
|
|
4853
|
+
* @name EngagementsListPost
|
|
4854
|
+
* @request POST:/engagements.list
|
|
4855
|
+
* @secure
|
|
4856
|
+
*/
|
|
4857
|
+
engagementsListPost: (data: EngagementsListRequest, params?: RequestParams) => Promise<AxiosResponse<EngagementsListResponse, any>>;
|
|
3421
4858
|
/**
|
|
3422
4859
|
* @description Updates the engagement record.
|
|
3423
4860
|
*
|
|
@@ -3475,6 +4912,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3475
4912
|
/** The requested link's ID. */
|
|
3476
4913
|
id: string;
|
|
3477
4914
|
}, params?: RequestParams) => Promise<AxiosResponse<LinksGetResponse, any>>;
|
|
4915
|
+
/**
|
|
4916
|
+
* @description Gets the requested link's information.
|
|
4917
|
+
*
|
|
4918
|
+
* @tags links
|
|
4919
|
+
* @name LinksGetPost
|
|
4920
|
+
* @request POST:/links.get
|
|
4921
|
+
* @secure
|
|
4922
|
+
*/
|
|
4923
|
+
linksGetPost: (data: LinksGetRequest, params?: RequestParams) => Promise<AxiosResponse<LinksGetResponse, any>>;
|
|
3478
4924
|
/**
|
|
3479
4925
|
* @description Lists the available links.
|
|
3480
4926
|
*
|
|
@@ -3519,6 +4965,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3519
4965
|
*/
|
|
3520
4966
|
types?: LinkType[];
|
|
3521
4967
|
}, params?: RequestParams) => Promise<AxiosResponse<LinksListResponse, any>>;
|
|
4968
|
+
/**
|
|
4969
|
+
* @description Lists the available links.
|
|
4970
|
+
*
|
|
4971
|
+
* @tags links
|
|
4972
|
+
* @name LinksListPost
|
|
4973
|
+
* @request POST:/links.list
|
|
4974
|
+
* @secure
|
|
4975
|
+
*/
|
|
4976
|
+
linksListPost: (data: LinksListRequest, params?: RequestParams) => Promise<AxiosResponse<LinksListResponse, any>>;
|
|
3522
4977
|
/**
|
|
3523
4978
|
* @description Lists metric definitions matching a filter.
|
|
3524
4979
|
*
|
|
@@ -3548,6 +5003,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3548
5003
|
/** The type of metric definitions sought. */
|
|
3549
5004
|
type?: MetricDefinitionMetricType[];
|
|
3550
5005
|
}, params?: RequestParams) => Promise<AxiosResponse<MetricDefinitionsListResponse, any>>;
|
|
5006
|
+
/**
|
|
5007
|
+
* @description Lists metric definitions matching a filter.
|
|
5008
|
+
*
|
|
5009
|
+
* @tags slas
|
|
5010
|
+
* @name MetricDefinitionsListPost
|
|
5011
|
+
* @request POST:/metric-definitions.list
|
|
5012
|
+
* @secure
|
|
5013
|
+
*/
|
|
5014
|
+
metricDefinitionsListPost: (data: MetricDefinitionsListRequest, params?: RequestParams) => Promise<AxiosResponse<MetricDefinitionsListResponse, any>>;
|
|
3551
5015
|
/**
|
|
3552
5016
|
* @description Creates an organization schedule fragment.
|
|
3553
5017
|
*
|
|
@@ -3569,6 +5033,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3569
5033
|
/** Organization schedule Fragment ID. */
|
|
3570
5034
|
id: string;
|
|
3571
5035
|
}, params?: RequestParams) => Promise<AxiosResponse<OrgScheduleFragmentsGetResponse, any>>;
|
|
5036
|
+
/**
|
|
5037
|
+
* @description Gets an organization schedule fragment.
|
|
5038
|
+
*
|
|
5039
|
+
* @tags schedules
|
|
5040
|
+
* @name OrgScheduleFragmentsGetPost
|
|
5041
|
+
* @request POST:/org-schedule-fragments.get
|
|
5042
|
+
* @secure
|
|
5043
|
+
*/
|
|
5044
|
+
orgScheduleFragmentsGetPost: (data: OrgScheduleFragmentsGetRequest, params?: RequestParams) => Promise<AxiosResponse<OrgScheduleFragmentsGetResponse, any>>;
|
|
3572
5045
|
/**
|
|
3573
5046
|
* @description Changes stage of an organization schedule fragment.
|
|
3574
5047
|
*
|
|
@@ -3599,6 +5072,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3599
5072
|
/** Organization schedule ID. */
|
|
3600
5073
|
id: string;
|
|
3601
5074
|
}, params?: RequestParams) => Promise<AxiosResponse<OrgSchedulesGetResponse, any>>;
|
|
5075
|
+
/**
|
|
5076
|
+
* @description Gets an organization schedule.
|
|
5077
|
+
*
|
|
5078
|
+
* @tags schedules
|
|
5079
|
+
* @name OrgSchedulesGetPost
|
|
5080
|
+
* @request POST:/org-schedules.get
|
|
5081
|
+
* @secure
|
|
5082
|
+
*/
|
|
5083
|
+
orgSchedulesGetPost: (data: OrgSchedulesGetRequest, params?: RequestParams) => Promise<AxiosResponse<OrgSchedulesGetResponse, any>>;
|
|
3602
5084
|
/**
|
|
3603
5085
|
* @description Gets list of organization schedules.
|
|
3604
5086
|
*
|
|
@@ -3629,6 +5111,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3629
5111
|
/** The organization schedule statuses the filter matches. */
|
|
3630
5112
|
status?: OrgScheduleStatus[];
|
|
3631
5113
|
}, params?: RequestParams) => Promise<AxiosResponse<OrgSchedulesListResponse, any>>;
|
|
5114
|
+
/**
|
|
5115
|
+
* @description Gets list of organization schedules.
|
|
5116
|
+
*
|
|
5117
|
+
* @tags schedules
|
|
5118
|
+
* @name OrgSchedulesListPost
|
|
5119
|
+
* @request POST:/org-schedules.list
|
|
5120
|
+
* @secure
|
|
5121
|
+
*/
|
|
5122
|
+
orgSchedulesListPost: (data: OrgSchedulesListRequest, params?: RequestParams) => Promise<AxiosResponse<OrgSchedulesListResponse, any>>;
|
|
3632
5123
|
/**
|
|
3633
5124
|
* @description Sets next organization schedule fragment which must begin the day the last existing fragment ends.
|
|
3634
5125
|
*
|
|
@@ -3680,6 +5171,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3680
5171
|
*/
|
|
3681
5172
|
id: string;
|
|
3682
5173
|
}, params?: RequestParams) => Promise<AxiosResponse<RevOrgsGetResponse, any>>;
|
|
5174
|
+
/**
|
|
5175
|
+
* @description Retrieves the Rev organization's information.
|
|
5176
|
+
*
|
|
5177
|
+
* @tags rev-orgs
|
|
5178
|
+
* @name RevOrgsGetPost
|
|
5179
|
+
* @request POST:/rev-orgs.get
|
|
5180
|
+
* @secure
|
|
5181
|
+
*/
|
|
5182
|
+
revOrgsGetPost: (data: RevOrgsGetRequest, params?: RequestParams) => Promise<AxiosResponse<RevOrgsGetResponse, any>>;
|
|
3683
5183
|
/**
|
|
3684
5184
|
* @description Gets the list of Rev organizations' information belonging to the authenticated user's Dev Organization which the user is also authorized to access.
|
|
3685
5185
|
*
|
|
@@ -3741,6 +5241,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3741
5241
|
*/
|
|
3742
5242
|
sort_by?: string[];
|
|
3743
5243
|
}, params?: RequestParams) => Promise<AxiosResponse<RevOrgsListResponse, any>>;
|
|
5244
|
+
/**
|
|
5245
|
+
* @description Gets the list of Rev organizations' information belonging to the authenticated user's Dev Organization which the user is also authorized to access.
|
|
5246
|
+
*
|
|
5247
|
+
* @tags rev-orgs
|
|
5248
|
+
* @name RevOrgsListPost
|
|
5249
|
+
* @request POST:/rev-orgs.list
|
|
5250
|
+
* @secure
|
|
5251
|
+
*/
|
|
5252
|
+
revOrgsListPost: (data: RevOrgsListRequest, params?: RequestParams) => Promise<AxiosResponse<RevOrgsListResponse, any>>;
|
|
3744
5253
|
/**
|
|
3745
5254
|
* @description Updates the Rev organization's information.
|
|
3746
5255
|
*
|
|
@@ -3780,6 +5289,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3780
5289
|
/** The ID of Rev user to be retrieved. */
|
|
3781
5290
|
id: string;
|
|
3782
5291
|
}, params?: RequestParams) => Promise<AxiosResponse<RevUsersGetResponse, any>>;
|
|
5292
|
+
/**
|
|
5293
|
+
* @description Returns the Rev user of a Rev organization by its ID.
|
|
5294
|
+
*
|
|
5295
|
+
* @tags rev-users
|
|
5296
|
+
* @name RevUsersGetPost
|
|
5297
|
+
* @request POST:/rev-users.get
|
|
5298
|
+
* @secure
|
|
5299
|
+
*/
|
|
5300
|
+
revUsersGetPost: (data: RevUsersGetRequest, params?: RequestParams) => Promise<AxiosResponse<RevUsersGetResponse, any>>;
|
|
3783
5301
|
/**
|
|
3784
5302
|
* @description Links a rev user to a rev org.
|
|
3785
5303
|
*
|
|
@@ -3851,6 +5369,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3851
5369
|
/** Fields to sort the Rev users by and the direction to sort them. */
|
|
3852
5370
|
sort_by?: string[];
|
|
3853
5371
|
}, params?: RequestParams) => Promise<AxiosResponse<RevUsersListResponse, any>>;
|
|
5372
|
+
/**
|
|
5373
|
+
* @description Returns a list of all Rev Users belonging to the authenticated user's Dev Organization.
|
|
5374
|
+
*
|
|
5375
|
+
* @tags rev-users
|
|
5376
|
+
* @name RevUsersListPost
|
|
5377
|
+
* @request POST:/rev-users.list
|
|
5378
|
+
* @secure
|
|
5379
|
+
*/
|
|
5380
|
+
revUsersListPost: (data: RevUsersListRequest, params?: RequestParams) => Promise<AxiosResponse<RevUsersListResponse, any>>;
|
|
3854
5381
|
/**
|
|
3855
5382
|
* @description Unlinks a rev user from a rev org.
|
|
3856
5383
|
*
|
|
@@ -3883,6 +5410,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3883
5410
|
/** The stock schema fragment which is to be aggregated. */
|
|
3884
5411
|
stock_schema_fragment_id?: string;
|
|
3885
5412
|
}, params?: RequestParams) => Promise<AxiosResponse<AggregatedSchemaGetResponse, any>>;
|
|
5413
|
+
/**
|
|
5414
|
+
* @description Gets the aggregated schema.
|
|
5415
|
+
*
|
|
5416
|
+
* @tags customization
|
|
5417
|
+
* @name AggregatedSchemaGetPost
|
|
5418
|
+
* @request POST:/schemas.aggregated.get
|
|
5419
|
+
* @secure
|
|
5420
|
+
*/
|
|
5421
|
+
aggregatedSchemaGetPost: (data: AggregatedSchemaGetRequest, params?: RequestParams) => Promise<AxiosResponse<AggregatedSchemaGetResponse, any>>;
|
|
3886
5422
|
/**
|
|
3887
5423
|
* @description Gets a custom schema fragment.
|
|
3888
5424
|
*
|
|
@@ -3895,6 +5431,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3895
5431
|
/** The ID of the custom schema fragment. */
|
|
3896
5432
|
id: string;
|
|
3897
5433
|
}, params?: RequestParams) => Promise<AxiosResponse<CustomSchemaFragmentsGetResponse, any>>;
|
|
5434
|
+
/**
|
|
5435
|
+
* @description Gets a custom schema fragment.
|
|
5436
|
+
*
|
|
5437
|
+
* @tags customization
|
|
5438
|
+
* @name CustomSchemaFragmentsGetPost
|
|
5439
|
+
* @request POST:/schemas.custom.get
|
|
5440
|
+
* @secure
|
|
5441
|
+
*/
|
|
5442
|
+
customSchemaFragmentsGetPost: (data: CustomSchemaFragmentsGetRequest, params?: RequestParams) => Promise<AxiosResponse<CustomSchemaFragmentsGetResponse, any>>;
|
|
3898
5443
|
/**
|
|
3899
5444
|
* @description Lists custom schema fragments.
|
|
3900
5445
|
*
|
|
@@ -3925,6 +5470,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3925
5470
|
/** Filters for custom schema fragment of the provided types. */
|
|
3926
5471
|
types?: CustomSchemaFragmentType[];
|
|
3927
5472
|
}, params?: RequestParams) => Promise<AxiosResponse<CustomSchemaFragmentsListResponse, any>>;
|
|
5473
|
+
/**
|
|
5474
|
+
* @description Lists custom schema fragments.
|
|
5475
|
+
*
|
|
5476
|
+
* @tags customization
|
|
5477
|
+
* @name CustomSchemaFragmentsListPost
|
|
5478
|
+
* @request POST:/schemas.custom.list
|
|
5479
|
+
* @secure
|
|
5480
|
+
*/
|
|
5481
|
+
customSchemaFragmentsListPost: (data: CustomSchemaFragmentsListRequest, params?: RequestParams) => Promise<AxiosResponse<CustomSchemaFragmentsListResponse, any>>;
|
|
3928
5482
|
/**
|
|
3929
5483
|
* @description Creates or updates a custom schema fragment.
|
|
3930
5484
|
*
|
|
@@ -3951,6 +5505,36 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3951
5505
|
/** List of leaf types for which subtypes are required. */
|
|
3952
5506
|
leaf_types?: string[];
|
|
3953
5507
|
}, params?: RequestParams) => Promise<AxiosResponse<SubtypesListResponse, any>>;
|
|
5508
|
+
/**
|
|
5509
|
+
* @description Lists subtypes.
|
|
5510
|
+
*
|
|
5511
|
+
* @tags customization
|
|
5512
|
+
* @name SubtypesListPost
|
|
5513
|
+
* @request POST:/schemas.subtypes.list
|
|
5514
|
+
* @secure
|
|
5515
|
+
*/
|
|
5516
|
+
subtypesListPost: (data: SubtypesListRequest, params?: RequestParams) => Promise<AxiosResponse<SubtypesListResponse, any>>;
|
|
5517
|
+
/**
|
|
5518
|
+
* @description Gets a service account.
|
|
5519
|
+
*
|
|
5520
|
+
* @tags service-accounts
|
|
5521
|
+
* @name ServiceAccountsGet
|
|
5522
|
+
* @request GET:/service-accounts.get
|
|
5523
|
+
* @secure
|
|
5524
|
+
*/
|
|
5525
|
+
serviceAccountsGet: (query: {
|
|
5526
|
+
/** The ID of the requested service account. */
|
|
5527
|
+
id: string;
|
|
5528
|
+
}, params?: RequestParams) => Promise<AxiosResponse<ServiceAccountsGetResponse, any>>;
|
|
5529
|
+
/**
|
|
5530
|
+
* @description Gets a service account.
|
|
5531
|
+
*
|
|
5532
|
+
* @tags service-accounts
|
|
5533
|
+
* @name ServiceAccountsGetPost
|
|
5534
|
+
* @request POST:/service-accounts.get
|
|
5535
|
+
* @secure
|
|
5536
|
+
*/
|
|
5537
|
+
serviceAccountsGetPost: (data: ServiceAccountsGetRequest, params?: RequestParams) => Promise<AxiosResponse<ServiceAccountsGetResponse, any>>;
|
|
3954
5538
|
/**
|
|
3955
5539
|
* @description Assigns the SLA to a set of Rev organizations.
|
|
3956
5540
|
*
|
|
@@ -3981,6 +5565,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
3981
5565
|
/** The ID of the SLA to get. */
|
|
3982
5566
|
id: string;
|
|
3983
5567
|
}, params?: RequestParams) => Promise<AxiosResponse<SlasGetResponse, any>>;
|
|
5568
|
+
/**
|
|
5569
|
+
* @description Gets an SLA.
|
|
5570
|
+
*
|
|
5571
|
+
* @tags slas
|
|
5572
|
+
* @name SlasGetPost
|
|
5573
|
+
* @request POST:/slas.get
|
|
5574
|
+
* @secure
|
|
5575
|
+
*/
|
|
5576
|
+
slasGetPost: (data: SlasGetRequest, params?: RequestParams) => Promise<AxiosResponse<SlasGetResponse, any>>;
|
|
3984
5577
|
/**
|
|
3985
5578
|
* @description Lists SLAs matching a filter.
|
|
3986
5579
|
*
|
|
@@ -4008,6 +5601,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
4008
5601
|
/** The SLA statuses the filter matches. */
|
|
4009
5602
|
status?: SlaStatus[];
|
|
4010
5603
|
}, params?: RequestParams) => Promise<AxiosResponse<SlasListResponse, any>>;
|
|
5604
|
+
/**
|
|
5605
|
+
* @description Lists SLAs matching a filter.
|
|
5606
|
+
*
|
|
5607
|
+
* @tags slas
|
|
5608
|
+
* @name SlasListPost
|
|
5609
|
+
* @request POST:/slas.list
|
|
5610
|
+
* @secure
|
|
5611
|
+
*/
|
|
5612
|
+
slasListPost: (data: SlasListRequest, params?: RequestParams) => Promise<AxiosResponse<SlasListResponse, any>>;
|
|
4011
5613
|
/**
|
|
4012
5614
|
* @description Changes the status of an SLA.
|
|
4013
5615
|
*
|
|
@@ -4054,6 +5656,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
4054
5656
|
/** Fields to sort the system users by and the direction to sort them. */
|
|
4055
5657
|
sort_by?: string[];
|
|
4056
5658
|
}, params?: RequestParams) => Promise<AxiosResponse<SysUsersListResponse, any>>;
|
|
5659
|
+
/**
|
|
5660
|
+
* @description Lists system users within your organization.
|
|
5661
|
+
*
|
|
5662
|
+
* @tags sys-users
|
|
5663
|
+
* @name SysUsersListPost
|
|
5664
|
+
* @request POST:/sys-users.list
|
|
5665
|
+
* @secure
|
|
5666
|
+
*/
|
|
5667
|
+
sysUsersListPost: (data: SysUsersListRequest, params?: RequestParams) => Promise<AxiosResponse<SysUsersListResponse, any>>;
|
|
4057
5668
|
/**
|
|
4058
5669
|
* @description Updates the system user.
|
|
4059
5670
|
*
|
|
@@ -4114,6 +5725,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
4114
5725
|
*/
|
|
4115
5726
|
visibility?: TimelineEntryVisibility[];
|
|
4116
5727
|
}, params?: RequestParams) => Promise<AxiosResponse<TimelineEntriesListResponse, any>>;
|
|
5728
|
+
/**
|
|
5729
|
+
* @description Lists the timeline entries for an object.
|
|
5730
|
+
*
|
|
5731
|
+
* @tags timeline-entries
|
|
5732
|
+
* @name TimelineEntriesListPost
|
|
5733
|
+
* @request POST:/timeline-entries.list
|
|
5734
|
+
* @secure
|
|
5735
|
+
*/
|
|
5736
|
+
timelineEntriesListPost: (data: TimelineEntriesListRequest, params?: RequestParams) => Promise<AxiosResponse<TimelineEntriesListResponse, any>>;
|
|
4117
5737
|
/**
|
|
4118
5738
|
* @description Creates new work ([issue](https://devrev.ai/docs/product/build), [ticket](https://devrev.ai/docs/product/support)) item. [task](https://docs.devrev.ai/product/tasks) and opportunity work types are supported in the beta version.
|
|
4119
5739
|
*
|
|
@@ -4178,6 +5798,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
4178
5798
|
* @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
|
|
4179
5799
|
*/
|
|
4180
5800
|
owned_by?: string[];
|
|
5801
|
+
/** Fields to sort the work items by and the direction to sort them. */
|
|
5802
|
+
sort_by?: string[];
|
|
4181
5803
|
/** Filters for records in the provided stage(s). */
|
|
4182
5804
|
'stage.name'?: string[];
|
|
4183
5805
|
/** Filters for tickets belonging to specific groups. */
|
|
@@ -4199,6 +5821,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
4199
5821
|
/** Filters for work of the provided types. */
|
|
4200
5822
|
type?: WorkType[];
|
|
4201
5823
|
}, params?: RequestParams) => Promise<AxiosResponse<WorksExportResponse, any>>;
|
|
5824
|
+
/**
|
|
5825
|
+
* @description Exports a collection of work items.
|
|
5826
|
+
*
|
|
5827
|
+
* @tags works
|
|
5828
|
+
* @name WorksExportPost
|
|
5829
|
+
* @request POST:/works.export
|
|
5830
|
+
* @secure
|
|
5831
|
+
*/
|
|
5832
|
+
worksExportPost: (data: WorksExportRequest, params?: RequestParams) => Promise<AxiosResponse<WorksExportResponse, any>>;
|
|
4202
5833
|
/**
|
|
4203
5834
|
* @description Gets a work item's information.
|
|
4204
5835
|
*
|
|
@@ -4214,6 +5845,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
4214
5845
|
*/
|
|
4215
5846
|
id: string;
|
|
4216
5847
|
}, params?: RequestParams) => Promise<AxiosResponse<WorksGetResponse, any>>;
|
|
5848
|
+
/**
|
|
5849
|
+
* @description Gets a work item's information.
|
|
5850
|
+
*
|
|
5851
|
+
* @tags works
|
|
5852
|
+
* @name WorksGetPost
|
|
5853
|
+
* @request POST:/works.get
|
|
5854
|
+
* @secure
|
|
5855
|
+
*/
|
|
5856
|
+
worksGetPost: (data: WorksGetRequest, params?: RequestParams) => Promise<AxiosResponse<WorksGetResponse, any>>;
|
|
4217
5857
|
/**
|
|
4218
5858
|
* @description Lists a collection of work items.
|
|
4219
5859
|
*
|
|
@@ -4269,6 +5909,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
4269
5909
|
* @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
|
|
4270
5910
|
*/
|
|
4271
5911
|
owned_by?: string[];
|
|
5912
|
+
/** Fields to sort the works by and the direction to sort them. */
|
|
5913
|
+
sort_by?: string[];
|
|
4272
5914
|
/** Filters for records in the provided stage(s). */
|
|
4273
5915
|
'stage.name'?: string[];
|
|
4274
5916
|
/** Filters for tickets belonging to specific groups. */
|
|
@@ -4290,6 +5932,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
4290
5932
|
/** Filters for work of the provided types. */
|
|
4291
5933
|
type?: WorkType[];
|
|
4292
5934
|
}, params?: RequestParams) => Promise<AxiosResponse<WorksListResponse, any>>;
|
|
5935
|
+
/**
|
|
5936
|
+
* @description Lists a collection of work items.
|
|
5937
|
+
*
|
|
5938
|
+
* @tags works
|
|
5939
|
+
* @name WorksListPost
|
|
5940
|
+
* @request POST:/works.list
|
|
5941
|
+
* @secure
|
|
5942
|
+
*/
|
|
5943
|
+
worksListPost: (data: WorksListRequest, params?: RequestParams) => Promise<AxiosResponse<WorksListResponse, any>>;
|
|
4293
5944
|
/**
|
|
4294
5945
|
* @description Updates a work item's information.
|
|
4295
5946
|
*
|