@devrev/typescript-sdk 1.1.6 → 1.1.8

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. */
@@ -23,6 +30,8 @@ export type Account = OrgBase & {
23
30
  * @example "don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"
24
31
  */
25
32
  stock_schema_fragment?: string;
33
+ /** Tags associated with an object. */
34
+ tags?: TagWithValue[];
26
35
  /** The Tier of the corresponding Account. */
27
36
  tier?: string;
28
37
  };
@@ -54,6 +63,8 @@ export interface AccountsCreateRequest {
54
63
  * @example ["don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"]
55
64
  */
56
65
  schema_fragment_ids?: string[];
66
+ /** Tags associated with the account. */
67
+ tags?: SetTagWithValue[];
57
68
  /** The tier of the account. */
58
69
  tier?: string;
59
70
  }
@@ -88,6 +99,8 @@ export interface AccountsExportRequest {
88
99
  /** Filters for accounts created by the specified user(s). */
89
100
  created_by?: string[];
90
101
  created_date?: DateTimeFilter;
102
+ /** Domains for accounts to be filtered. */
103
+ domains?: string[];
91
104
  /** Array of references of accounts to be filtered. */
92
105
  external_refs?: string[];
93
106
  /**
@@ -98,8 +111,14 @@ export interface AccountsExportRequest {
98
111
  */
99
112
  first?: number;
100
113
  modified_date?: DateTimeFilter;
114
+ /** Filters for accounts owned by the specified user(s). */
115
+ owned_by?: string[];
101
116
  /** Fields to sort the accounts by and the direction to sort them in. */
102
117
  sort_by?: string[];
118
+ /** Filters for accounts on specified stages. */
119
+ stage?: string[];
120
+ /** List of tags to be filtered. */
121
+ tags?: string[];
103
122
  }
104
123
  /**
105
124
  * accounts-export-response
@@ -140,6 +159,8 @@ export interface AccountsListRequest {
140
159
  * iteration starts from the beginning.
141
160
  */
142
161
  cursor?: string;
162
+ /** Domains for accounts to be filtered. */
163
+ domains?: string[];
143
164
  /** Array of references of accounts to be filtered. */
144
165
  external_refs?: string[];
145
166
  /**
@@ -157,8 +178,14 @@ export interface AccountsListRequest {
157
178
  */
158
179
  mode?: ListMode;
159
180
  modified_date?: DateTimeFilter;
181
+ /** Filters for accounts owned by the specified user(s). */
182
+ owned_by?: string[];
160
183
  /** Fields to sort the accounts by and the direction to sort them in. */
161
184
  sort_by?: string[];
185
+ /** Filters for accounts on specified stages. */
186
+ stage?: string[];
187
+ /** List of tags to be filtered. */
188
+ tags?: string[];
162
189
  }
163
190
  /**
164
191
  * accounts-list-response
@@ -208,6 +235,8 @@ export interface AccountsUpdateRequest {
208
235
  * @example ["don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"]
209
236
  */
210
237
  schema_fragment_ids?: string[];
238
+ /** Updated tags list associated with the account. */
239
+ tags?: SetTagWithValue[];
211
240
  /** Updated tier of the account. */
212
241
  tier?: string;
213
242
  }
@@ -237,6 +266,297 @@ export interface AggregatedSchemaGetResponse {
237
266
  /** List of custom fields from multiple source fragments. */
238
267
  schema: AggregatedSchema;
239
268
  }
269
+ /** app-fragment */
270
+ export type AppFragment = CustomSchemaFragmentBase;
271
+ /** article */
272
+ export type Article = AtomBase & {
273
+ /** Description of the article. */
274
+ description?: string;
275
+ /** Artifacts containing the extracted content. */
276
+ extracted_content?: ArtifactSummary[];
277
+ /** Resource details. */
278
+ resource?: Resource;
279
+ /** Title of the article. */
280
+ title?: string;
281
+ };
282
+ /** Status of the article. */
283
+ export declare enum ArticleStatus {
284
+ Archived = "archived",
285
+ Draft = "draft",
286
+ Published = "published",
287
+ ReviewNeeded = "review_needed"
288
+ }
289
+ /** articles-count-request */
290
+ export interface ArticlesCountRequest {
291
+ /**
292
+ * Filters for articles belonging to any of the provided parts.
293
+ * @example ["don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"]
294
+ */
295
+ applies_to_parts?: string[];
296
+ /**
297
+ * Filters for articles authored by any of the provided users.
298
+ * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
299
+ */
300
+ authored_by?: string[];
301
+ /**
302
+ * Filters for articles created by any of the provided users.
303
+ * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
304
+ */
305
+ created_by?: string[];
306
+ /**
307
+ * Filters for articles owned by any of the provided users.
308
+ * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
309
+ */
310
+ owned_by?: string[];
311
+ }
312
+ /** articles-count-response */
313
+ export interface ArticlesCountResponse {
314
+ /**
315
+ * The total number of articles matching the filter.
316
+ * @format int32
317
+ */
318
+ count: number;
319
+ }
320
+ /**
321
+ * articles-create-request
322
+ * The request to create an article.
323
+ */
324
+ export interface ArticlesCreateRequest {
325
+ access_level?: AccessLevel;
326
+ /**
327
+ * The parts that the article applies to.
328
+ * @minItems 1
329
+ * @example ["don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"]
330
+ */
331
+ applies_to_parts: string[];
332
+ /**
333
+ * The authors of the article.
334
+ * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
335
+ */
336
+ authored_by?: string[];
337
+ /** Description for the article. */
338
+ description?: string;
339
+ /**
340
+ * ID of the extracted content artifact.
341
+ * @example ["don:core:<partition>:devo/<dev-org-id>:artifact/<artifact-id>"]
342
+ */
343
+ extracted_content?: string[];
344
+ /** Language of the article. */
345
+ language?: string;
346
+ /**
347
+ * The users that own the article.
348
+ * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
349
+ */
350
+ owned_by?: string[];
351
+ /**
352
+ * The published date of the article.
353
+ * @format date-time
354
+ */
355
+ published_at?: string;
356
+ resource: ArticlesCreateRequestResource;
357
+ /** Status of the article. */
358
+ status?: ArticleStatus;
359
+ /** Tags associated with the article. */
360
+ tags?: SetTagWithValue[];
361
+ /** Name of the article. */
362
+ title: string;
363
+ }
364
+ /** articles-create-request-resource */
365
+ export interface ArticlesCreateRequestResource {
366
+ /**
367
+ * IDs of the artifacts.
368
+ * @example ["don:core:<partition>:devo/<dev-org-id>:artifact/<artifact-id>"]
369
+ */
370
+ artifacts?: string[];
371
+ /** URL of the external article. */
372
+ url?: string;
373
+ }
374
+ /**
375
+ * articles-create-response
376
+ * Create article response.
377
+ */
378
+ export interface ArticlesCreateResponse {
379
+ article: Article;
380
+ }
381
+ /**
382
+ * articles-delete-request
383
+ * The request to delete an article.
384
+ */
385
+ export interface ArticlesDeleteRequest {
386
+ /**
387
+ * The ID of the article to delete.
388
+ * @example "don:core:<partition>:devo/<dev-org-id>:article/<article-id>"
389
+ */
390
+ id: string;
391
+ }
392
+ /** articles-delete-response */
393
+ export type ArticlesDeleteResponse = object;
394
+ /**
395
+ * articles-get-request
396
+ * The request to get an article.
397
+ */
398
+ export interface ArticlesGetRequest {
399
+ /**
400
+ * The ID of the required article.
401
+ * @example "don:core:<partition>:devo/<dev-org-id>:article/<article-id>"
402
+ */
403
+ id: string;
404
+ }
405
+ /**
406
+ * articles-get-response
407
+ * Get article response.
408
+ */
409
+ export interface ArticlesGetResponse {
410
+ article: Article;
411
+ }
412
+ /**
413
+ * articles-list-request
414
+ * The request to list articles.
415
+ */
416
+ export interface ArticlesListRequest {
417
+ /**
418
+ * Filters for articles belonging to any of the provided parts.
419
+ * @example ["don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"]
420
+ */
421
+ applies_to_parts?: string[];
422
+ /**
423
+ * Filters for articles authored by any of the provided users.
424
+ * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
425
+ */
426
+ authored_by?: string[];
427
+ /**
428
+ * Filters for articles created by any of the provided users.
429
+ * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
430
+ */
431
+ created_by?: string[];
432
+ /**
433
+ * The cursor to resume iteration from. If not provided, then
434
+ * iteration starts from the beginning.
435
+ */
436
+ cursor?: string;
437
+ /**
438
+ * The maximum number of articles to return. The default is '50'.
439
+ * @format int32
440
+ */
441
+ limit?: number;
442
+ /**
443
+ * The iteration mode to use. If "after", then entries after the provided
444
+ * cursor will be returned, or if no cursor is provided, then from the
445
+ * beginning. If "before", then entries before the provided cursor will be
446
+ * returned, or if no cursor is provided, then from the end. Entries will
447
+ * always be returned in the specified sort-by order.
448
+ */
449
+ mode?: ListMode;
450
+ /**
451
+ * Filters for articles owned by any of the provided users.
452
+ * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
453
+ */
454
+ owned_by?: string[];
455
+ }
456
+ /**
457
+ * articles-list-response
458
+ * List articles response.
459
+ */
460
+ export interface ArticlesListResponse {
461
+ /** The article entries matching the request. */
462
+ articles: Article[];
463
+ /**
464
+ * The cursor used to iterate subsequent results in accordance to the
465
+ * sort order. If not set, then no later elements exist.
466
+ */
467
+ next_cursor?: string;
468
+ /**
469
+ * The cursor used to iterate preceding results in accordance to the
470
+ * sort order. If not set, then no prior elements exist.
471
+ */
472
+ prev_cursor?: string;
473
+ /**
474
+ * Total number of article items for the request.
475
+ * @format int32
476
+ */
477
+ total: number;
478
+ }
479
+ /**
480
+ * articles-update-request
481
+ * The request to update an article.
482
+ */
483
+ export interface ArticlesUpdateRequest {
484
+ access_level?: AccessLevel;
485
+ applies_to_parts?: ArticlesUpdateRequestAppliesToParts;
486
+ artifacts?: ArticlesUpdateRequestArtifacts;
487
+ authored_by?: ArticlesUpdateRequestAuthoredBy;
488
+ /**
489
+ * Updated description of the article object, or unchanged if not
490
+ * provided.
491
+ */
492
+ description?: string;
493
+ extracted_content?: ArticlesUpdateRequestExtractedContent;
494
+ /**
495
+ * The article's ID.
496
+ * @example "don:core:<partition>:devo/<dev-org-id>:article/<article-id>"
497
+ */
498
+ id: string;
499
+ /** Updates the language of the article. */
500
+ language?: string;
501
+ owned_by?: ArticlesUpdateRequestOwnedBy;
502
+ /** Status of the article. */
503
+ status?: ArticleStatus;
504
+ tags?: ArticlesUpdateRequestTags;
505
+ /** Updated title of the article object, or unchanged if not provided. */
506
+ title?: string;
507
+ /** Updates the URL of the external article. */
508
+ url?: string;
509
+ }
510
+ /** articles-update-request-applies-to-parts */
511
+ export interface ArticlesUpdateRequestAppliesToParts {
512
+ /**
513
+ * Updates the parts that the article applies to.
514
+ * @example ["don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"]
515
+ */
516
+ set?: string[];
517
+ }
518
+ /** articles-update-request-artifacts */
519
+ export interface ArticlesUpdateRequestArtifacts {
520
+ /**
521
+ * Updates IDs of the artifacts.
522
+ * @example ["don:core:<partition>:devo/<dev-org-id>:artifact/<artifact-id>"]
523
+ */
524
+ set?: string[];
525
+ }
526
+ /** articles-update-request-authored-by */
527
+ export interface ArticlesUpdateRequestAuthoredBy {
528
+ /**
529
+ * Sets the users that authored the article.
530
+ * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
531
+ */
532
+ set?: string[];
533
+ }
534
+ /** articles-update-request-extracted-content */
535
+ export interface ArticlesUpdateRequestExtractedContent {
536
+ /**
537
+ * Update the ID of the extracted content.
538
+ * @example ["don:core:<partition>:devo/<dev-org-id>:artifact/<artifact-id>"]
539
+ */
540
+ set?: string[];
541
+ }
542
+ /** articles-update-request-owned-by */
543
+ export interface ArticlesUpdateRequestOwnedBy {
544
+ /**
545
+ * Sets the owner IDs to the provided user IDs. This must not be
546
+ * empty.
547
+ * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
548
+ */
549
+ set?: string[];
550
+ }
551
+ /** articles-update-request-tags */
552
+ export interface ArticlesUpdateRequestTags {
553
+ /** Sets the provided tags on the article. */
554
+ set?: SetTagWithValue[];
555
+ }
556
+ /** articles-update-response */
557
+ export interface ArticlesUpdateResponse {
558
+ article: Article;
559
+ }
240
560
  /** artifact-summary */
241
561
  export type ArtifactSummary = AtomBaseSummary;
242
562
  /** atom-base */
@@ -384,6 +704,8 @@ export interface ConversationsExportRequest {
384
704
  first?: number;
385
705
  /** Filters for conversation that belong to the given groups. */
386
706
  group?: string[];
707
+ /** Filters for conversations that are created by verified users. */
708
+ is_creator_verified?: boolean;
387
709
  /** Filters for conversations that are spam. */
388
710
  is_spam?: boolean;
389
711
  /**
@@ -451,6 +773,8 @@ export interface ConversationsListRequest {
451
773
  cursor?: string;
452
774
  /** Filters for conversation that belong to the given groups. */
453
775
  group?: string[];
776
+ /** Filters for conversations that are created by verified users. */
777
+ is_creator_verified?: boolean;
454
778
  /** Filters for conversations that are spam. */
455
779
  is_spam?: boolean;
456
780
  /**
@@ -606,15 +930,21 @@ export interface CreateWeeklyOrgScheduleInterval {
606
930
  to: number;
607
931
  }
608
932
  /** custom-schema-fragment */
609
- export interface CustomSchemaFragment {
933
+ export type CustomSchemaFragment = (AppFragment | CustomTypeFragment | TenantFragment) & {
610
934
  type: CustomSchemaFragmentType;
611
- }
935
+ };
936
+ /** custom-schema-fragment-base */
937
+ export type CustomSchemaFragmentBase = AtomBase;
612
938
  /**
613
939
  * custom-schema-fragment-condition
614
940
  * The condition associated with a field.
615
941
  */
616
942
  export type CustomSchemaFragmentCondition = object;
617
- export type CustomSchemaFragmentType = string;
943
+ export declare enum CustomSchemaFragmentType {
944
+ AppFragment = "app_fragment",
945
+ CustomTypeFragment = "custom_type_fragment",
946
+ TenantFragment = "tenant_fragment"
947
+ }
618
948
  /** custom-schema-fragments-get-request */
619
949
  export interface CustomSchemaFragmentsGetRequest {
620
950
  /** The ID of the custom schema fragment. */
@@ -677,8 +1007,6 @@ export type CustomSchemaFragmentsSetRequest = (CustomSchemaFragmentsSetRequestAp
677
1007
  export interface CustomSchemaFragmentsSetRequestAppFragment {
678
1008
  /** The app this fragment applies to. */
679
1009
  app: string;
680
- /** The name of the app fragment. */
681
- app_fragment_name: string;
682
1010
  }
683
1011
  /** custom-schema-fragments-set-request-custom-type-fragment */
684
1012
  export interface CustomSchemaFragmentsSetRequestCustomTypeFragment {
@@ -703,6 +1031,8 @@ export interface CustomSchemaFragmentsSetResponse {
703
1031
  /** The ID of the custom schema fragment. */
704
1032
  id: string;
705
1033
  }
1034
+ /** custom-type-fragment */
1035
+ export type CustomTypeFragment = CustomSchemaFragmentBase;
706
1036
  /**
707
1037
  * date-filter
708
1038
  * Provides ways to specify date ranges on objects.
@@ -1100,6 +1430,54 @@ export declare enum ErrorUnauthorizedType {
1100
1430
  }
1101
1431
  /** error-unauthorized-unauthenticated */
1102
1432
  export type ErrorUnauthorizedUnauthenticated = object;
1433
+ /** event-source */
1434
+ export type EventSource = AtomBase & {
1435
+ /**
1436
+ * Configuration of the event source. Fields depend on the event
1437
+ * source type.
1438
+ */
1439
+ config?: object;
1440
+ /** Name of the event source. */
1441
+ name?: string;
1442
+ /** Instructions for setting up the event source. */
1443
+ setup_instructions?: EventSourceSetupInstructions;
1444
+ /**
1445
+ * Status of the event source. Note that paused/blocked event sources
1446
+ * return NotFound error on triggering.
1447
+ */
1448
+ status?: EventSourceStatus;
1449
+ /**
1450
+ * The URL to trigger the event source. Valid only for HTTP
1451
+ * based-event sources. This URL supports both GET and POST requests.
1452
+ */
1453
+ trigger_url?: string;
1454
+ };
1455
+ /** event-source-get-request */
1456
+ export interface EventSourceGetRequest {
1457
+ /** The event source's ID. */
1458
+ id: string;
1459
+ }
1460
+ /** event-source-get-response */
1461
+ export interface EventSourceGetResponse {
1462
+ event_source: EventSource;
1463
+ }
1464
+ /**
1465
+ * event-source-setup-instructions
1466
+ * Instructions for setting up the event source.
1467
+ */
1468
+ export interface EventSourceSetupInstructions {
1469
+ /** Content of the instructions. */
1470
+ content?: string;
1471
+ }
1472
+ /**
1473
+ * Status of the event source. Note that paused/blocked event sources
1474
+ * return NotFound error on triggering.
1475
+ */
1476
+ export declare enum EventSourceStatus {
1477
+ Active = "active",
1478
+ Blocked = "blocked",
1479
+ Paused = "paused"
1480
+ }
1103
1481
  /** event-sources-delete-scheduled-event-request */
1104
1482
  export interface EventSourcesDeleteScheduledEventRequest {
1105
1483
  /** The event key for the event which we want to delete. */
@@ -1153,6 +1531,25 @@ export type FeatureSummary = PartBaseSummary;
1153
1531
  * Set of field attributes.
1154
1532
  */
1155
1533
  export type FieldDescriptor = object;
1534
+ /**
1535
+ * get-accounts-default-rev-org-request
1536
+ * Request object to get an account's default Rev organization.
1537
+ */
1538
+ export interface GetAccountsDefaultRevOrgRequest {
1539
+ /**
1540
+ * The ID of Account for which default Rev organization is to be
1541
+ * fetched.
1542
+ * @example "don:core:<partition>:devo/<dev-org-id>:account/<account-id>"
1543
+ */
1544
+ id: string;
1545
+ }
1546
+ /**
1547
+ * get-accounts-default-rev-org-response
1548
+ * Response object for getting account's default Rev organization.
1549
+ */
1550
+ export interface GetAccountsDefaultRevOrgResponse {
1551
+ rev_org: RevOrg;
1552
+ }
1156
1553
  /** group-summary */
1157
1554
  export type GroupSummary = AtomBaseSummary;
1158
1555
  /** issue */
@@ -1780,8 +2177,19 @@ export declare enum PartType {
1780
2177
  }
1781
2178
  /** product-summary */
1782
2179
  export type ProductSummary = PartBaseSummary;
2180
+ /**
2181
+ * resource
2182
+ * Resource details.
2183
+ */
2184
+ export interface Resource {
2185
+ /** Ids of the artifacts. */
2186
+ artifacts?: ArtifactSummary[];
2187
+ /** URL of the external article. */
2188
+ url?: string;
2189
+ }
1783
2190
  /** rev-org */
1784
2191
  export type RevOrg = OrgBase & {
2192
+ account?: AccountSummary;
1785
2193
  /** Custom fields. */
1786
2194
  custom_fields?: object;
1787
2195
  /**
@@ -1814,6 +2222,11 @@ export type RevOrgSummary = OrgBaseSummary;
1814
2222
  * organization.
1815
2223
  */
1816
2224
  export interface RevOrgsCreateRequest {
2225
+ /**
2226
+ * Account Id to associate with this Rev organization.
2227
+ * @example "don:core:<partition>:devo/<dev-org-id>:account/<account-id>"
2228
+ */
2229
+ account?: string;
1817
2230
  /** Application-defined custom fields. */
1818
2231
  custom_fields?: object;
1819
2232
  /**
@@ -1869,6 +2282,11 @@ export interface RevOrgsGetResponse {
1869
2282
  * user's Dev organization.
1870
2283
  */
1871
2284
  export interface RevOrgsListRequest {
2285
+ /**
2286
+ * Filters by account.
2287
+ * @example ["don:core:<partition>:devo/<dev-org-id>:account/<account-id>"]
2288
+ */
2289
+ account?: string[];
1872
2290
  /** Filters by creator. */
1873
2291
  created_by?: string[];
1874
2292
  created_date?: DateTimeFilter;
@@ -1927,6 +2345,11 @@ export interface RevOrgsListResponse {
1927
2345
  * Request object to update information of the Rev organization.
1928
2346
  */
1929
2347
  export interface RevOrgsUpdateRequest {
2348
+ /**
2349
+ * New account ID to associate with this Rev organization.
2350
+ * @example "don:core:<partition>:devo/<dev-org-id>:account/<account-id>"
2351
+ */
2352
+ account?: string;
1930
2353
  /**
1931
2354
  * Schema fragment IDs associated with this Rev organization.
1932
2355
  * @example ["don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"]
@@ -3061,6 +3484,8 @@ export declare enum TaskPriority {
3061
3484
  }
3062
3485
  /** task-summary */
3063
3486
  export type TaskSummary = WorkBaseSummary;
3487
+ /** tenant-fragment */
3488
+ export type TenantFragment = CustomSchemaFragmentBase;
3064
3489
  /** ticket */
3065
3490
  export type Ticket = WorkBase & {
3066
3491
  group?: GroupSummary;
@@ -3122,6 +3547,13 @@ export type TimelineEntriesCreateRequest = TimelineEntriesCreateRequestTimelineC
3122
3547
  * @format date-time
3123
3548
  */
3124
3549
  expires_at?: string;
3550
+ /**
3551
+ * The labels to be associated with the entry.
3552
+ * @minLength 1
3553
+ * @maxLength 64
3554
+ * @maxItems 16
3555
+ */
3556
+ labels?: string[];
3125
3557
  /**
3126
3558
  * The ID of the object to create the timeline entry for.
3127
3559
  * @example "don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"
@@ -3155,6 +3587,11 @@ export interface TimelineEntriesCreateRequestTimelineComment {
3155
3587
  body?: string;
3156
3588
  /** The type of the body to use for the comment. */
3157
3589
  body_type?: TimelineCommentBodyType;
3590
+ /**
3591
+ * The IDs of the previews of the links posted in the comment.
3592
+ * @example ["don:core:<partition>:devo/<dev-org-id>:snap_widget/<snap-widget-id>"]
3593
+ */
3594
+ link_previews?: string[];
3158
3595
  /** Snap Kit Body of the comment. */
3159
3596
  snap_kit_body?: TimelineSnapKitBody;
3160
3597
  }
@@ -3183,6 +3620,14 @@ export interface TimelineEntriesListRequest {
3183
3620
  * iteration starts from the beginning.
3184
3621
  */
3185
3622
  cursor?: string;
3623
+ /**
3624
+ * Filters for entries containing at least one of the provided labels,
3625
+ * otherwise if no labels are provided, then no label filtering is
3626
+ * done.
3627
+ * @minLength 1
3628
+ * @maxLength 64
3629
+ */
3630
+ labels?: string[];
3186
3631
  /**
3187
3632
  * The maximum number of entries to return. If not set, then this
3188
3633
  * defaults to `50`.
@@ -3227,12 +3672,90 @@ export interface TimelineEntriesListResponse {
3227
3672
  /** The timeline entries for the object. */
3228
3673
  timeline_entries: TimelineEntry[];
3229
3674
  }
3675
+ /**
3676
+ * timeline-entries-update-request
3677
+ * The request to update a timeline entry.
3678
+ */
3679
+ export type TimelineEntriesUpdateRequest = TimelineEntriesUpdateRequestTimelineComment & {
3680
+ /**
3681
+ * The ID of the timeline entry to update.
3682
+ * @example "don:core:<partition>:devo/<dev-org-id>:ticket/123:timeline_event/<timeline-event-id>"
3683
+ */
3684
+ id: string;
3685
+ type: TimelineEntriesUpdateRequestType;
3686
+ };
3687
+ /** timeline-entries-update-request-timeline-comment */
3688
+ export interface TimelineEntriesUpdateRequestTimelineComment {
3689
+ artifacts?: TimelineEntriesUpdateRequestTimelineCommentArtifacts;
3690
+ /** The updated comment's body. */
3691
+ body?: string;
3692
+ /** The type of the body to use for the comment. */
3693
+ body_type?: TimelineCommentBodyType;
3694
+ link_previews?: TimelineEntriesUpdateRequestTimelineCommentLinkPreviews;
3695
+ /** Snap Kit Body of the comment. */
3696
+ snap_kit_body?: TimelineSnapKitBody;
3697
+ }
3698
+ /** timeline-entries-update-request-timeline-comment-artifacts */
3699
+ export interface TimelineEntriesUpdateRequestTimelineCommentArtifacts {
3700
+ /**
3701
+ * Adds the provided artifacts to the comment. An artifact cannot be
3702
+ * added more than once, i.e. nothing is done if the artifact is
3703
+ * already attached. Mutually exclusive with `set`.
3704
+ * @example ["don:core:<partition>:devo/<dev-org-id>:artifact/<artifact-id>"]
3705
+ */
3706
+ add?: string[];
3707
+ /**
3708
+ * Removes the provided artifacts from the comment. If an artifact is
3709
+ * not present, then it's ignored. Mututally exclusive with `set`.
3710
+ * @example ["don:core:<partition>:devo/<dev-org-id>:artifact/<artifact-id>"]
3711
+ */
3712
+ remove?: string[];
3713
+ /**
3714
+ * Sets the field to the provided artifacts.
3715
+ * @example ["don:core:<partition>:devo/<dev-org-id>:artifact/<artifact-id>"]
3716
+ */
3717
+ set?: string[];
3718
+ }
3719
+ /** timeline-entries-update-request-timeline-comment-link-previews */
3720
+ export interface TimelineEntriesUpdateRequestTimelineCommentLinkPreviews {
3721
+ /**
3722
+ * Adds the provided link previews to the comment. A link preview
3723
+ * cannot be added more than once, i.e. nothing is done if the link
3724
+ * preview is already present. Mutually exclusive with `set`.
3725
+ * @example ["don:core:<partition>:devo/<dev-org-id>:snap_widget/<snap-widget-id>"]
3726
+ */
3727
+ add?: string[];
3728
+ /**
3729
+ * Removes the provided link previews from the comment. If a link
3730
+ * preview is not present, then it's ignored. Mutually exclusive with
3731
+ * `set`.
3732
+ * @example ["don:core:<partition>:devo/<dev-org-id>:snap_widget/<snap-widget-id>"]
3733
+ */
3734
+ remove?: string[];
3735
+ /**
3736
+ * Set the link previews to the provided IDs.
3737
+ * @example ["don:core:<partition>:devo/<dev-org-id>:snap_widget/<snap-widget-id>"]
3738
+ */
3739
+ set?: string[];
3740
+ }
3741
+ export declare enum TimelineEntriesUpdateRequestType {
3742
+ TimelineComment = "timeline_comment"
3743
+ }
3744
+ /**
3745
+ * timeline-entries-update-response
3746
+ * The response to updating a timeline entry.
3747
+ */
3748
+ export interface TimelineEntriesUpdateResponse {
3749
+ timeline_entry: TimelineEntry;
3750
+ }
3230
3751
  /** timeline-entry */
3231
3752
  export type TimelineEntry = TimelineComment & {
3232
3753
  type: TimelineEntryType;
3233
3754
  };
3234
3755
  /** timeline-entry-base */
3235
3756
  export type TimelineEntryBase = AtomBase & {
3757
+ /** Labels that are associated with the Timeline entry. */
3758
+ labels?: string[];
3236
3759
  /** The object that the Timeline entry belongs to. */
3237
3760
  object: string;
3238
3761
  /** The type of object that the Timeline entry belongs to. */
@@ -3255,9 +3778,11 @@ export declare enum TimelineEntryObjectType {
3255
3778
  Account = "account",
3256
3779
  Capability = "capability",
3257
3780
  Conversation = "conversation",
3781
+ Engagement = "engagement",
3258
3782
  Enhancement = "enhancement",
3259
3783
  Feature = "feature",
3260
3784
  Issue = "issue",
3785
+ Meeting = "meeting",
3261
3786
  Opportunity = "opportunity",
3262
3787
  Product = "product",
3263
3788
  RevOrg = "rev_org",
@@ -3375,6 +3900,7 @@ export type UserBaseSummary = AtomBaseSummary & {
3375
3900
  export declare enum UserState {
3376
3901
  Active = "active",
3377
3902
  Deactivated = "deactivated",
3903
+ Deleted = "deleted",
3378
3904
  Locked = "locked",
3379
3905
  Shadow = "shadow",
3380
3906
  Unassigned = "unassigned"
@@ -3745,7 +4271,7 @@ export interface WorksListResponse {
3745
4271
  /** works-update-request */
3746
4272
  export type WorksUpdateRequest = (WorksUpdateRequestIssue | WorksUpdateRequestOpportunity | WorksUpdateRequestTask | WorksUpdateRequestTicket) & {
3747
4273
  /**
3748
- * Updates the part that the work applies to.
4274
+ * Updates the part that the work item applies to.
3749
4275
  * @example "don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"
3750
4276
  */
3751
4277
  applies_to_part?: string;
@@ -3933,6 +4459,31 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
3933
4459
  * @secure
3934
4460
  */
3935
4461
  accountsCreate: (data: AccountsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<AccountsCreateResponse, any>>;
4462
+ /**
4463
+ * @description Fetches account's default Rev organization.
4464
+ *
4465
+ * @tags accounts
4466
+ * @name GetAccountsDefaultRevOrg
4467
+ * @request GET:/accounts.default-rev-org.get
4468
+ * @secure
4469
+ */
4470
+ getAccountsDefaultRevOrg: (query: {
4471
+ /**
4472
+ * The ID of Account for which default Rev organization is to be
4473
+ * fetched.
4474
+ * @example "don:core:<partition>:devo/<dev-org-id>:account/<account-id>"
4475
+ */
4476
+ id: string;
4477
+ }, params?: RequestParams) => Promise<AxiosResponse<GetAccountsDefaultRevOrgResponse, any>>;
4478
+ /**
4479
+ * @description Fetches account's default Rev organization.
4480
+ *
4481
+ * @tags accounts
4482
+ * @name GetAccountsDefaultRevOrgPost
4483
+ * @request POST:/accounts.default-rev-org.get
4484
+ * @secure
4485
+ */
4486
+ getAccountsDefaultRevOrgPost: (data: GetAccountsDefaultRevOrgRequest, params?: RequestParams) => Promise<AxiosResponse<GetAccountsDefaultRevOrgResponse, any>>;
3936
4487
  /**
3937
4488
  * @description Deletes an account.
3938
4489
  *
@@ -3964,6 +4515,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
3964
4515
  * @format date-time
3965
4516
  */
3966
4517
  'created_date.before'?: string;
4518
+ /** Domains for accounts to be filtered. */
4519
+ domains?: string[];
3967
4520
  /** Array of references of accounts to be filtered. */
3968
4521
  external_refs?: string[];
3969
4522
  /**
@@ -3984,8 +4537,14 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
3984
4537
  * @format date-time
3985
4538
  */
3986
4539
  'modified_date.before'?: string;
4540
+ /** Filters for accounts owned by the specified user(s). */
4541
+ owned_by?: string[];
3987
4542
  /** Fields to sort the accounts by and the direction to sort them in. */
3988
4543
  sort_by?: string[];
4544
+ /** Filters for accounts on specified stages. */
4545
+ stage?: string[];
4546
+ /** List of tags to be filtered. */
4547
+ tags?: string[];
3989
4548
  }, params?: RequestParams) => Promise<AxiosResponse<AccountsExportResponse, any>>;
3990
4549
  /**
3991
4550
  * @description Exports a collection of accounts.
@@ -4047,6 +4606,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
4047
4606
  * starts from the beginning.
4048
4607
  */
4049
4608
  cursor?: string;
4609
+ /** Domains for accounts to be filtered. */
4610
+ domains?: string[];
4050
4611
  /** Array of references of accounts to be filtered. */
4051
4612
  external_refs?: string[];
4052
4613
  /**
@@ -4071,8 +4632,14 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
4071
4632
  * @format date-time
4072
4633
  */
4073
4634
  'modified_date.before'?: string;
4635
+ /** Filters for accounts owned by the specified user(s). */
4636
+ owned_by?: string[];
4074
4637
  /** Fields to sort the accounts by and the direction to sort them in. */
4075
4638
  sort_by?: string[];
4639
+ /** Filters for accounts on specified stages. */
4640
+ stage?: string[];
4641
+ /** List of tags to be filtered. */
4642
+ tags?: string[];
4076
4643
  }, params?: RequestParams) => Promise<AxiosResponse<AccountsListResponse, any>>;
4077
4644
  /**
4078
4645
  * @description Gets a list of accounts.
@@ -4092,6 +4659,150 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
4092
4659
  * @secure
4093
4660
  */
4094
4661
  accountsUpdate: (data: AccountsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<AccountsUpdateResponse, any>>;
4662
+ /**
4663
+ * @description Get count of articles matching given filter.
4664
+ *
4665
+ * @tags articles
4666
+ * @name ArticlesCount
4667
+ * @request GET:/articles.count
4668
+ * @secure
4669
+ */
4670
+ articlesCount: (query?: {
4671
+ /**
4672
+ * Filters for articles belonging to any of the provided parts.
4673
+ * @example ["don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"]
4674
+ */
4675
+ applies_to_parts?: string[];
4676
+ /**
4677
+ * Filters for articles authored by any of the provided users.
4678
+ * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
4679
+ */
4680
+ authored_by?: string[];
4681
+ /**
4682
+ * Filters for articles created by any of the provided users.
4683
+ * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
4684
+ */
4685
+ created_by?: string[];
4686
+ /**
4687
+ * Filters for articles owned by any of the provided users.
4688
+ * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
4689
+ */
4690
+ owned_by?: string[];
4691
+ }, params?: RequestParams) => Promise<AxiosResponse<ArticlesCountResponse, any>>;
4692
+ /**
4693
+ * @description Get count of articles matching given filter.
4694
+ *
4695
+ * @tags articles
4696
+ * @name ArticlesCountPost
4697
+ * @request POST:/articles.count
4698
+ * @secure
4699
+ */
4700
+ articlesCountPost: (data: ArticlesCountRequest, params?: RequestParams) => Promise<AxiosResponse<ArticlesCountResponse, any>>;
4701
+ /**
4702
+ * @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.
4703
+ *
4704
+ * @tags articles
4705
+ * @name CreateArticle
4706
+ * @request POST:/articles.create
4707
+ * @secure
4708
+ */
4709
+ createArticle: (data: ArticlesCreateRequest, params?: RequestParams) => Promise<AxiosResponse<ArticlesCreateResponse, any>>;
4710
+ /**
4711
+ * @description Deletes an article.
4712
+ *
4713
+ * @tags articles
4714
+ * @name DeleteArticle
4715
+ * @request POST:/articles.delete
4716
+ * @secure
4717
+ */
4718
+ deleteArticle: (data: ArticlesDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
4719
+ /**
4720
+ * @description Gets an article.
4721
+ *
4722
+ * @tags articles
4723
+ * @name GetArticle
4724
+ * @request GET:/articles.get
4725
+ * @secure
4726
+ */
4727
+ getArticle: (query: {
4728
+ /**
4729
+ * The ID of the required article.
4730
+ * @example "don:core:<partition>:devo/<dev-org-id>:article/<article-id>"
4731
+ */
4732
+ id: string;
4733
+ }, params?: RequestParams) => Promise<AxiosResponse<ArticlesGetResponse, any>>;
4734
+ /**
4735
+ * @description Gets an article.
4736
+ *
4737
+ * @tags articles
4738
+ * @name GetArticlePost
4739
+ * @request POST:/articles.get
4740
+ * @secure
4741
+ */
4742
+ getArticlePost: (data: ArticlesGetRequest, params?: RequestParams) => Promise<AxiosResponse<ArticlesGetResponse, any>>;
4743
+ /**
4744
+ * @description Lists a collection of articles.
4745
+ *
4746
+ * @tags articles
4747
+ * @name ListArticles
4748
+ * @request GET:/articles.list
4749
+ * @secure
4750
+ */
4751
+ listArticles: (query?: {
4752
+ /**
4753
+ * Filters for articles belonging to any of the provided parts.
4754
+ * @example ["don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"]
4755
+ */
4756
+ applies_to_parts?: string[];
4757
+ /**
4758
+ * Filters for articles authored by any of the provided users.
4759
+ * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
4760
+ */
4761
+ authored_by?: string[];
4762
+ /**
4763
+ * Filters for articles created by any of the provided users.
4764
+ * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
4765
+ */
4766
+ created_by?: string[];
4767
+ /**
4768
+ * The cursor to resume iteration from. If not provided, then iteration
4769
+ * starts from the beginning.
4770
+ */
4771
+ cursor?: string;
4772
+ /**
4773
+ * The maximum number of articles to return. The default is '50'.
4774
+ * @format int32
4775
+ */
4776
+ limit?: number;
4777
+ /**
4778
+ * The iteration mode to use, otherwise if not set, then "after" is
4779
+ * used.
4780
+ */
4781
+ mode?: ListMode;
4782
+ /**
4783
+ * Filters for articles owned by any of the provided users.
4784
+ * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
4785
+ */
4786
+ owned_by?: string[];
4787
+ }, params?: RequestParams) => Promise<AxiosResponse<ArticlesListResponse, any>>;
4788
+ /**
4789
+ * @description Lists a collection of articles.
4790
+ *
4791
+ * @tags articles
4792
+ * @name ListArticlesPost
4793
+ * @request POST:/articles.list
4794
+ * @secure
4795
+ */
4796
+ listArticlesPost: (data: ArticlesListRequest, params?: RequestParams) => Promise<AxiosResponse<ArticlesListResponse, any>>;
4797
+ /**
4798
+ * @description Updates an article.
4799
+ *
4800
+ * @tags articles
4801
+ * @name UpdateArticle
4802
+ * @request POST:/articles.update
4803
+ * @secure
4804
+ */
4805
+ updateArticle: (data: ArticlesUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<ArticlesUpdateResponse, any>>;
4095
4806
  /**
4096
4807
  * @description Creates a conversation.
4097
4808
  *
@@ -4132,6 +4843,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
4132
4843
  first?: number;
4133
4844
  /** Filters for conversation that belong to the given groups. */
4134
4845
  group?: string[];
4846
+ /** Filters for conversations that are created by verified users. */
4847
+ is_creator_verified?: boolean;
4135
4848
  /** Filters for conversations that are spam. */
4136
4849
  is_spam?: boolean;
4137
4850
  /**
@@ -4211,6 +4924,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
4211
4924
  cursor?: string;
4212
4925
  /** Filters for conversation that belong to the given groups. */
4213
4926
  group?: string[];
4927
+ /** Filters for conversations that are created by verified users. */
4928
+ is_creator_verified?: boolean;
4214
4929
  /** Filters for conversations that are spam. */
4215
4930
  is_spam?: boolean;
4216
4931
  /**
@@ -4398,6 +5113,27 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
4398
5113
  * @secure
4399
5114
  */
4400
5115
  engagementsUpdate: (data: EngagementsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<EngagementsUpdateResponse, any>>;
5116
+ /**
5117
+ * @description Gets an event source.
5118
+ *
5119
+ * @tags event-source
5120
+ * @name EventSourcesGet
5121
+ * @request GET:/event-sources.get
5122
+ * @secure
5123
+ */
5124
+ eventSourcesGet: (query: {
5125
+ /** The event source's ID. */
5126
+ id: string;
5127
+ }, params?: RequestParams) => Promise<AxiosResponse<EventSourceGetResponse, any>>;
5128
+ /**
5129
+ * @description Gets an event source.
5130
+ *
5131
+ * @tags event-source
5132
+ * @name EventSourcesGetPost
5133
+ * @request POST:/event-sources.get
5134
+ * @secure
5135
+ */
5136
+ eventSourcesGetPost: (data: EventSourceGetRequest, params?: RequestParams) => Promise<AxiosResponse<EventSourceGetResponse, any>>;
4401
5137
  /**
4402
5138
  * @description Schedules an event to be published to the specified event source.
4403
5139
  *
@@ -4723,6 +5459,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
4723
5459
  * @secure
4724
5460
  */
4725
5461
  revOrgsList: (query?: {
5462
+ /**
5463
+ * Filters by account.
5464
+ * @example ["don:core:<partition>:devo/<dev-org-id>:account/<account-id>"]
5465
+ */
5466
+ account?: string[];
4726
5467
  /** Filters by creator. */
4727
5468
  created_by?: string[];
4728
5469
  /**
@@ -5241,6 +5982,13 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
5241
5982
  * starts from the beginning.
5242
5983
  */
5243
5984
  cursor?: string;
5985
+ /**
5986
+ * Filters for entries containing at least one of the provided labels,
5987
+ * otherwise if no labels are provided, then no label filtering is done.
5988
+ * @minLength 1
5989
+ * @maxLength 64
5990
+ */
5991
+ labels?: string[];
5244
5992
  /**
5245
5993
  * The maximum number of entries to return. If not set, then this
5246
5994
  * defaults to `50`.
@@ -5268,6 +6016,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
5268
6016
  * @secure
5269
6017
  */
5270
6018
  timelineEntriesListPost: (data: TimelineEntriesListRequest, params?: RequestParams) => Promise<AxiosResponse<TimelineEntriesListResponse, any>>;
6019
+ /**
6020
+ * @description Updates an entry on an object's timeline.
6021
+ *
6022
+ * @tags timeline-entries
6023
+ * @name TimelineEntriesUpdate
6024
+ * @request POST:/timeline-entries.update
6025
+ * @secure
6026
+ */
6027
+ timelineEntriesUpdate: (data: TimelineEntriesUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<TimelineEntriesUpdateResponse, any>>;
5271
6028
  /**
5272
6029
  * @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.
5273
6030
  *
@@ -33,11 +33,34 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
33
33
  return (mod && mod.__esModule) ? mod : { "default": mod };
34
34
  };
35
35
  Object.defineProperty(exports, "__esModule", { value: true });
36
- exports.Api = exports.HttpClient = exports.ContentType = exports.WorkType = exports.UserType = exports.UserState = exports.TimelineEntryVisibility = exports.TimelineEntryType = exports.TimelineEntryObjectType = exports.TimelineEntriesCreateRequestType = exports.TimelineEntriesCollection = exports.TimelineCommentBodyType = exports.TicketSeverity = exports.TaskPriority = exports.SlaStatus = exports.SlaSelectorSeverity = exports.SlaSelectorPriority = exports.SlaSelectorAppliesTo = exports.SlaEvaluationPeriod = exports.SchemaFieldDescriptorFieldType = exports.SchemaFieldDescriptorArrayTypeBaseType = exports.PartType = exports.OrgType = exports.OrgScheduleStatus = exports.OrgScheduleFragmentStatus = exports.OrgEnvironment = exports.OpportunityPriority = exports.OpportunityForecastCategory = exports.MetricDefinitionMetricType = exports.MetricDefinitionAppliesTo = exports.ListMode = exports.LinksDirection = exports.LinkType = exports.LinkEndpointType = exports.IssuePriority = exports.ErrorUnauthorizedType = exports.ErrorTooManyRequestsType = exports.ErrorServiceUnavailableType = exports.ErrorNotFoundType = exports.ErrorInternalServerErrorType = exports.ErrorForbiddenType = exports.ErrorBadRequestType = exports.EngagementsCreateRequestEngagementType = exports.EngagementType = exports.DateTimePresetType = exports.DateFilterType = exports.CustomSchemaFragmentsSetRequestType = exports.ConversationsCreateRequestTypeValue = void 0;
36
+ exports.WorkType = exports.UserType = exports.UserState = exports.TimelineEntryVisibility = exports.TimelineEntryType = exports.TimelineEntryObjectType = exports.TimelineEntriesUpdateRequestType = exports.TimelineEntriesCreateRequestType = exports.TimelineEntriesCollection = exports.TimelineCommentBodyType = exports.TicketSeverity = exports.TaskPriority = exports.SlaStatus = exports.SlaSelectorSeverity = exports.SlaSelectorPriority = exports.SlaSelectorAppliesTo = exports.SlaEvaluationPeriod = exports.SchemaFieldDescriptorFieldType = exports.SchemaFieldDescriptorArrayTypeBaseType = exports.PartType = exports.OrgType = exports.OrgScheduleStatus = exports.OrgScheduleFragmentStatus = exports.OrgEnvironment = exports.OpportunityPriority = exports.OpportunityForecastCategory = exports.MetricDefinitionMetricType = exports.MetricDefinitionAppliesTo = exports.ListMode = exports.LinksDirection = exports.LinkType = exports.LinkEndpointType = exports.IssuePriority = exports.EventSourceStatus = exports.ErrorUnauthorizedType = exports.ErrorTooManyRequestsType = exports.ErrorServiceUnavailableType = exports.ErrorNotFoundType = exports.ErrorInternalServerErrorType = exports.ErrorForbiddenType = exports.ErrorBadRequestType = exports.EngagementsCreateRequestEngagementType = exports.EngagementType = exports.DateTimePresetType = exports.DateFilterType = exports.CustomSchemaFragmentsSetRequestType = exports.CustomSchemaFragmentType = exports.ConversationsCreateRequestTypeValue = exports.ArticleStatus = exports.AccessLevel = void 0;
37
+ exports.Api = exports.HttpClient = exports.ContentType = void 0;
38
+ var AccessLevel;
39
+ (function (AccessLevel) {
40
+ AccessLevel["External"] = "external";
41
+ AccessLevel["Internal"] = "internal";
42
+ AccessLevel["Private"] = "private";
43
+ AccessLevel["Public"] = "public";
44
+ AccessLevel["Restricted"] = "restricted";
45
+ })(AccessLevel = exports.AccessLevel || (exports.AccessLevel = {}));
46
+ /** Status of the article. */
47
+ var ArticleStatus;
48
+ (function (ArticleStatus) {
49
+ ArticleStatus["Archived"] = "archived";
50
+ ArticleStatus["Draft"] = "draft";
51
+ ArticleStatus["Published"] = "published";
52
+ ArticleStatus["ReviewNeeded"] = "review_needed";
53
+ })(ArticleStatus = exports.ArticleStatus || (exports.ArticleStatus = {}));
37
54
  var ConversationsCreateRequestTypeValue;
38
55
  (function (ConversationsCreateRequestTypeValue) {
39
56
  ConversationsCreateRequestTypeValue["Support"] = "support";
40
57
  })(ConversationsCreateRequestTypeValue = exports.ConversationsCreateRequestTypeValue || (exports.ConversationsCreateRequestTypeValue = {}));
58
+ var CustomSchemaFragmentType;
59
+ (function (CustomSchemaFragmentType) {
60
+ CustomSchemaFragmentType["AppFragment"] = "app_fragment";
61
+ CustomSchemaFragmentType["CustomTypeFragment"] = "custom_type_fragment";
62
+ CustomSchemaFragmentType["TenantFragment"] = "tenant_fragment";
63
+ })(CustomSchemaFragmentType = exports.CustomSchemaFragmentType || (exports.CustomSchemaFragmentType = {}));
41
64
  var CustomSchemaFragmentsSetRequestType;
42
65
  (function (CustomSchemaFragmentsSetRequestType) {
43
66
  CustomSchemaFragmentsSetRequestType["AppFragment"] = "app_fragment";
@@ -109,6 +132,16 @@ var ErrorUnauthorizedType;
109
132
  (function (ErrorUnauthorizedType) {
110
133
  ErrorUnauthorizedType["Unauthenticated"] = "unauthenticated";
111
134
  })(ErrorUnauthorizedType = exports.ErrorUnauthorizedType || (exports.ErrorUnauthorizedType = {}));
135
+ /**
136
+ * Status of the event source. Note that paused/blocked event sources
137
+ * return NotFound error on triggering.
138
+ */
139
+ var EventSourceStatus;
140
+ (function (EventSourceStatus) {
141
+ EventSourceStatus["Active"] = "active";
142
+ EventSourceStatus["Blocked"] = "blocked";
143
+ EventSourceStatus["Paused"] = "paused";
144
+ })(EventSourceStatus = exports.EventSourceStatus || (exports.EventSourceStatus = {}));
112
145
  /** Priority of the work based upon impact and criticality. */
113
146
  var IssuePriority;
114
147
  (function (IssuePriority) {
@@ -349,15 +382,21 @@ var TimelineEntriesCreateRequestType;
349
382
  (function (TimelineEntriesCreateRequestType) {
350
383
  TimelineEntriesCreateRequestType["TimelineComment"] = "timeline_comment";
351
384
  })(TimelineEntriesCreateRequestType = exports.TimelineEntriesCreateRequestType || (exports.TimelineEntriesCreateRequestType = {}));
385
+ var TimelineEntriesUpdateRequestType;
386
+ (function (TimelineEntriesUpdateRequestType) {
387
+ TimelineEntriesUpdateRequestType["TimelineComment"] = "timeline_comment";
388
+ })(TimelineEntriesUpdateRequestType = exports.TimelineEntriesUpdateRequestType || (exports.TimelineEntriesUpdateRequestType = {}));
352
389
  /** The type of object that the Timeline entry belongs to. */
353
390
  var TimelineEntryObjectType;
354
391
  (function (TimelineEntryObjectType) {
355
392
  TimelineEntryObjectType["Account"] = "account";
356
393
  TimelineEntryObjectType["Capability"] = "capability";
357
394
  TimelineEntryObjectType["Conversation"] = "conversation";
395
+ TimelineEntryObjectType["Engagement"] = "engagement";
358
396
  TimelineEntryObjectType["Enhancement"] = "enhancement";
359
397
  TimelineEntryObjectType["Feature"] = "feature";
360
398
  TimelineEntryObjectType["Issue"] = "issue";
399
+ TimelineEntryObjectType["Meeting"] = "meeting";
361
400
  TimelineEntryObjectType["Opportunity"] = "opportunity";
362
401
  TimelineEntryObjectType["Product"] = "product";
363
402
  TimelineEntryObjectType["RevOrg"] = "rev_org";
@@ -389,6 +428,7 @@ var UserState;
389
428
  (function (UserState) {
390
429
  UserState["Active"] = "active";
391
430
  UserState["Deactivated"] = "deactivated";
431
+ UserState["Deleted"] = "deleted";
392
432
  UserState["Locked"] = "locked";
393
433
  UserState["Shadow"] = "shadow";
394
434
  UserState["Unassigned"] = "unassigned";
@@ -497,6 +537,24 @@ class Api extends HttpClient {
497
537
  * @secure
498
538
  */
499
539
  this.accountsCreate = (data, params = {}) => this.request(Object.assign({ path: `/accounts.create`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
540
+ /**
541
+ * @description Fetches account's default Rev organization.
542
+ *
543
+ * @tags accounts
544
+ * @name GetAccountsDefaultRevOrg
545
+ * @request GET:/accounts.default-rev-org.get
546
+ * @secure
547
+ */
548
+ this.getAccountsDefaultRevOrg = (query, params = {}) => this.request(Object.assign({ path: `/accounts.default-rev-org.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
549
+ /**
550
+ * @description Fetches account's default Rev organization.
551
+ *
552
+ * @tags accounts
553
+ * @name GetAccountsDefaultRevOrgPost
554
+ * @request POST:/accounts.default-rev-org.get
555
+ * @secure
556
+ */
557
+ this.getAccountsDefaultRevOrgPost = (data, params = {}) => this.request(Object.assign({ path: `/accounts.default-rev-org.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
500
558
  /**
501
559
  * @description Deletes an account.
502
560
  *
@@ -569,6 +627,87 @@ class Api extends HttpClient {
569
627
  * @secure
570
628
  */
571
629
  this.accountsUpdate = (data, params = {}) => this.request(Object.assign({ path: `/accounts.update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
630
+ /**
631
+ * @description Get count of articles matching given filter.
632
+ *
633
+ * @tags articles
634
+ * @name ArticlesCount
635
+ * @request GET:/articles.count
636
+ * @secure
637
+ */
638
+ this.articlesCount = (query, params = {}) => this.request(Object.assign({ path: `/articles.count`, method: 'GET', query: query, secure: true, format: 'json' }, params));
639
+ /**
640
+ * @description Get count of articles matching given filter.
641
+ *
642
+ * @tags articles
643
+ * @name ArticlesCountPost
644
+ * @request POST:/articles.count
645
+ * @secure
646
+ */
647
+ this.articlesCountPost = (data, params = {}) => this.request(Object.assign({ path: `/articles.count`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
648
+ /**
649
+ * @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.
650
+ *
651
+ * @tags articles
652
+ * @name CreateArticle
653
+ * @request POST:/articles.create
654
+ * @secure
655
+ */
656
+ this.createArticle = (data, params = {}) => this.request(Object.assign({ path: `/articles.create`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
657
+ /**
658
+ * @description Deletes an article.
659
+ *
660
+ * @tags articles
661
+ * @name DeleteArticle
662
+ * @request POST:/articles.delete
663
+ * @secure
664
+ */
665
+ this.deleteArticle = (data, params = {}) => this.request(Object.assign({ path: `/articles.delete`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
666
+ /**
667
+ * @description Gets an article.
668
+ *
669
+ * @tags articles
670
+ * @name GetArticle
671
+ * @request GET:/articles.get
672
+ * @secure
673
+ */
674
+ this.getArticle = (query, params = {}) => this.request(Object.assign({ path: `/articles.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
675
+ /**
676
+ * @description Gets an article.
677
+ *
678
+ * @tags articles
679
+ * @name GetArticlePost
680
+ * @request POST:/articles.get
681
+ * @secure
682
+ */
683
+ this.getArticlePost = (data, params = {}) => this.request(Object.assign({ path: `/articles.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
684
+ /**
685
+ * @description Lists a collection of articles.
686
+ *
687
+ * @tags articles
688
+ * @name ListArticles
689
+ * @request GET:/articles.list
690
+ * @secure
691
+ */
692
+ this.listArticles = (query, params = {}) => this.request(Object.assign({ path: `/articles.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
693
+ /**
694
+ * @description Lists a collection of articles.
695
+ *
696
+ * @tags articles
697
+ * @name ListArticlesPost
698
+ * @request POST:/articles.list
699
+ * @secure
700
+ */
701
+ this.listArticlesPost = (data, params = {}) => this.request(Object.assign({ path: `/articles.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
702
+ /**
703
+ * @description Updates an article.
704
+ *
705
+ * @tags articles
706
+ * @name UpdateArticle
707
+ * @request POST:/articles.update
708
+ * @secure
709
+ */
710
+ this.updateArticle = (data, params = {}) => this.request(Object.assign({ path: `/articles.update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
572
711
  /**
573
712
  * @description Creates a conversation.
574
713
  *
@@ -731,6 +870,24 @@ class Api extends HttpClient {
731
870
  * @secure
732
871
  */
733
872
  this.engagementsUpdate = (data, params = {}) => this.request(Object.assign({ path: `/engagements.update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
873
+ /**
874
+ * @description Gets an event source.
875
+ *
876
+ * @tags event-source
877
+ * @name EventSourcesGet
878
+ * @request GET:/event-sources.get
879
+ * @secure
880
+ */
881
+ this.eventSourcesGet = (query, params = {}) => this.request(Object.assign({ path: `/event-sources.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
882
+ /**
883
+ * @description Gets an event source.
884
+ *
885
+ * @tags event-source
886
+ * @name EventSourcesGetPost
887
+ * @request POST:/event-sources.get
888
+ * @secure
889
+ */
890
+ this.eventSourcesGetPost = (data, params = {}) => this.request(Object.assign({ path: `/event-sources.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
734
891
  /**
735
892
  * @description Schedules an event to be published to the specified event source.
736
893
  *
@@ -1289,6 +1446,15 @@ class Api extends HttpClient {
1289
1446
  * @secure
1290
1447
  */
1291
1448
  this.timelineEntriesListPost = (data, params = {}) => this.request(Object.assign({ path: `/timeline-entries.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
1449
+ /**
1450
+ * @description Updates an entry on an object's timeline.
1451
+ *
1452
+ * @tags timeline-entries
1453
+ * @name TimelineEntriesUpdate
1454
+ * @request POST:/timeline-entries.update
1455
+ * @secure
1456
+ */
1457
+ this.timelineEntriesUpdate = (data, params = {}) => this.request(Object.assign({ path: `/timeline-entries.update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
1292
1458
  /**
1293
1459
  * @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.
1294
1460
  *
@@ -1622,6 +1622,7 @@ export type UserBaseSummary = AtomBaseSummary & {
1622
1622
  export declare enum UserState {
1623
1623
  Active = "active",
1624
1624
  Deactivated = "deactivated",
1625
+ Deleted = "deleted",
1625
1626
  Locked = "locked",
1626
1627
  Shadow = "shadow",
1627
1628
  Unassigned = "unassigned"
@@ -1991,7 +1992,7 @@ export interface WorksListResponse {
1991
1992
  /** works-update-request */
1992
1993
  export type WorksUpdateRequest = (WorksUpdateRequestIssue | WorksUpdateRequestTicket) & {
1993
1994
  /**
1994
- * Updates the part that the work applies to.
1995
+ * Updates the part that the work item applies to.
1995
1996
  * @example "don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"
1996
1997
  */
1997
1998
  applies_to_part?: string;
@@ -247,6 +247,7 @@ var UserState;
247
247
  (function (UserState) {
248
248
  UserState["Active"] = "active";
249
249
  UserState["Deactivated"] = "deactivated";
250
+ UserState["Deleted"] = "deleted";
250
251
  UserState["Locked"] = "locked";
251
252
  UserState["Shadow"] = "shadow";
252
253
  UserState["Unassigned"] = "unassigned";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@devrev/typescript-sdk",
3
- "version": "1.1.6",
3
+ "version": "1.1.8",
4
4
  "description": "## SDK Generation",
5
5
  "main": "./dist/index.js",
6
6
  "scripts": {