@devrev/typescript-sdk 1.1.6 → 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. */
@@ -237,6 +244,295 @@ export interface AggregatedSchemaGetResponse {
237
244
  /** List of custom fields from multiple source fragments. */
238
245
  schema: AggregatedSchema;
239
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
+ }
240
536
  /** artifact-summary */
241
537
  export type ArtifactSummary = AtomBaseSummary;
242
538
  /** atom-base */
@@ -384,6 +680,8 @@ export interface ConversationsExportRequest {
384
680
  first?: number;
385
681
  /** Filters for conversation that belong to the given groups. */
386
682
  group?: string[];
683
+ /** Filters for conversations that are created by verified users. */
684
+ is_creator_verified?: boolean;
387
685
  /** Filters for conversations that are spam. */
388
686
  is_spam?: boolean;
389
687
  /**
@@ -451,6 +749,8 @@ export interface ConversationsListRequest {
451
749
  cursor?: string;
452
750
  /** Filters for conversation that belong to the given groups. */
453
751
  group?: string[];
752
+ /** Filters for conversations that are created by verified users. */
753
+ is_creator_verified?: boolean;
454
754
  /** Filters for conversations that are spam. */
455
755
  is_spam?: boolean;
456
756
  /**
@@ -606,15 +906,21 @@ export interface CreateWeeklyOrgScheduleInterval {
606
906
  to: number;
607
907
  }
608
908
  /** custom-schema-fragment */
609
- export interface CustomSchemaFragment {
909
+ export type CustomSchemaFragment = (AppFragment | CustomTypeFragment | TenantFragment) & {
610
910
  type: CustomSchemaFragmentType;
611
- }
911
+ };
912
+ /** custom-schema-fragment-base */
913
+ export type CustomSchemaFragmentBase = AtomBase;
612
914
  /**
613
915
  * custom-schema-fragment-condition
614
916
  * The condition associated with a field.
615
917
  */
616
918
  export type CustomSchemaFragmentCondition = object;
617
- export type CustomSchemaFragmentType = string;
919
+ export declare enum CustomSchemaFragmentType {
920
+ AppFragment = "app_fragment",
921
+ CustomTypeFragment = "custom_type_fragment",
922
+ TenantFragment = "tenant_fragment"
923
+ }
618
924
  /** custom-schema-fragments-get-request */
619
925
  export interface CustomSchemaFragmentsGetRequest {
620
926
  /** The ID of the custom schema fragment. */
@@ -677,8 +983,6 @@ export type CustomSchemaFragmentsSetRequest = (CustomSchemaFragmentsSetRequestAp
677
983
  export interface CustomSchemaFragmentsSetRequestAppFragment {
678
984
  /** The app this fragment applies to. */
679
985
  app: string;
680
- /** The name of the app fragment. */
681
- app_fragment_name: string;
682
986
  }
683
987
  /** custom-schema-fragments-set-request-custom-type-fragment */
684
988
  export interface CustomSchemaFragmentsSetRequestCustomTypeFragment {
@@ -703,6 +1007,8 @@ export interface CustomSchemaFragmentsSetResponse {
703
1007
  /** The ID of the custom schema fragment. */
704
1008
  id: string;
705
1009
  }
1010
+ /** custom-type-fragment */
1011
+ export type CustomTypeFragment = CustomSchemaFragmentBase;
706
1012
  /**
707
1013
  * date-filter
708
1014
  * Provides ways to specify date ranges on objects.
@@ -1780,6 +2086,16 @@ export declare enum PartType {
1780
2086
  }
1781
2087
  /** product-summary */
1782
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
+ }
1783
2099
  /** rev-org */
1784
2100
  export type RevOrg = OrgBase & {
1785
2101
  /** Custom fields. */
@@ -3061,6 +3377,8 @@ export declare enum TaskPriority {
3061
3377
  }
3062
3378
  /** task-summary */
3063
3379
  export type TaskSummary = WorkBaseSummary;
3380
+ /** tenant-fragment */
3381
+ export type TenantFragment = CustomSchemaFragmentBase;
3064
3382
  /** ticket */
3065
3383
  export type Ticket = WorkBase & {
3066
3384
  group?: GroupSummary;
@@ -3745,7 +4063,7 @@ export interface WorksListResponse {
3745
4063
  /** works-update-request */
3746
4064
  export type WorksUpdateRequest = (WorksUpdateRequestIssue | WorksUpdateRequestOpportunity | WorksUpdateRequestTask | WorksUpdateRequestTicket) & {
3747
4065
  /**
3748
- * Updates the part that the work applies to.
4066
+ * Updates the part that the work item applies to.
3749
4067
  * @example "don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"
3750
4068
  */
3751
4069
  applies_to_part?: string;
@@ -4092,6 +4410,150 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
4092
4410
  * @secure
4093
4411
  */
4094
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[];
4437
+ /**
4438
+ * Filters for articles owned by any of the provided users.
4439
+ * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
4440
+ */
4441
+ owned_by?: string[];
4442
+ }, params?: RequestParams) => Promise<AxiosResponse<ArticlesCountResponse, any>>;
4443
+ /**
4444
+ * @description Get count of articles matching given filter.
4445
+ *
4446
+ * @tags articles
4447
+ * @name ArticlesCountPost
4448
+ * @request POST:/articles.count
4449
+ * @secure
4450
+ */
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: {
4479
+ /**
4480
+ * The ID of the required article.
4481
+ * @example "don:core:<partition>:devo/<dev-org-id>:article/<article-id>"
4482
+ */
4483
+ id: string;
4484
+ }, params?: RequestParams) => Promise<AxiosResponse<ArticlesGetResponse, any>>;
4485
+ /**
4486
+ * @description Gets an article.
4487
+ *
4488
+ * @tags articles
4489
+ * @name GetArticlePost
4490
+ * @request POST:/articles.get
4491
+ * @secure
4492
+ */
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?: {
4503
+ /**
4504
+ * Filters for articles belonging to any of the provided parts.
4505
+ * @example ["don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"]
4506
+ */
4507
+ applies_to_parts?: string[];
4508
+ /**
4509
+ * Filters for articles authored by any of the provided users.
4510
+ * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
4511
+ */
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[];
4518
+ /**
4519
+ * The cursor to resume iteration from. If not provided, then iteration
4520
+ * starts from the beginning.
4521
+ */
4522
+ cursor?: string;
4523
+ /**
4524
+ * The maximum number of articles to return. The default is '50'.
4525
+ * @format int32
4526
+ */
4527
+ limit?: number;
4528
+ /**
4529
+ * The iteration mode to use, otherwise if not set, then "after" is
4530
+ * used.
4531
+ */
4532
+ mode?: ListMode;
4533
+ /**
4534
+ * Filters for articles owned by any of the provided users.
4535
+ * @example ["don:identity:<partition>:devo/<dev-org-id>:devu/<dev-user-id>"]
4536
+ */
4537
+ owned_by?: string[];
4538
+ }, params?: RequestParams) => Promise<AxiosResponse<ArticlesListResponse, any>>;
4539
+ /**
4540
+ * @description Lists a collection of articles.
4541
+ *
4542
+ * @tags articles
4543
+ * @name ListArticlesPost
4544
+ * @request POST:/articles.list
4545
+ * @secure
4546
+ */
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>>;
4095
4557
  /**
4096
4558
  * @description Creates a conversation.
4097
4559
  *
@@ -4132,6 +4594,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
4132
4594
  first?: number;
4133
4595
  /** Filters for conversation that belong to the given groups. */
4134
4596
  group?: string[];
4597
+ /** Filters for conversations that are created by verified users. */
4598
+ is_creator_verified?: boolean;
4135
4599
  /** Filters for conversations that are spam. */
4136
4600
  is_spam?: boolean;
4137
4601
  /**
@@ -4211,6 +4675,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
4211
4675
  cursor?: string;
4212
4676
  /** Filters for conversation that belong to the given groups. */
4213
4677
  group?: string[];
4678
+ /** Filters for conversations that are created by verified users. */
4679
+ is_creator_verified?: boolean;
4214
4680
  /** Filters for conversations that are spam. */
4215
4681
  is_spam?: boolean;
4216
4682
  /**
@@ -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.HttpClient = exports.ContentType = exports.WorkType = exports.UserType = exports.UserState = exports.TimelineEntryVisibility = exports.TimelineEntryType = exports.TimelineEntryObjectType = exports.TimelineEntriesCreateRequestType = exports.TimelineEntriesCollection = exports.TimelineCommentBodyType = exports.TicketSeverity = exports.TaskPriority = exports.SlaStatus = exports.SlaSelectorSeverity = exports.SlaSelectorPriority = exports.SlaSelectorAppliesTo = exports.SlaEvaluationPeriod = exports.SchemaFieldDescriptorFieldType = exports.SchemaFieldDescriptorArrayTypeBaseType = exports.PartType = exports.OrgType = exports.OrgScheduleStatus = exports.OrgScheduleFragmentStatus = exports.OrgEnvironment = exports.OpportunityPriority = exports.OpportunityForecastCategory = exports.MetricDefinitionMetricType = exports.MetricDefinitionAppliesTo = exports.ListMode = exports.LinksDirection = exports.LinkType = exports.LinkEndpointType = exports.IssuePriority = exports.ErrorUnauthorizedType = exports.ErrorTooManyRequestsType = exports.ErrorServiceUnavailableType = exports.ErrorNotFoundType = exports.ErrorInternalServerErrorType = exports.ErrorForbiddenType = exports.ErrorBadRequestType = exports.EngagementsCreateRequestEngagementType = exports.EngagementType = exports.DateTimePresetType = exports.DateFilterType = exports.CustomSchemaFragmentsSetRequestType = exports.CustomSchemaFragmentType = exports.ConversationsCreateRequestTypeValue = exports.ArticleStatus = exports.AccessLevel = void 0;
37
+ exports.Api = void 0;
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";
@@ -569,6 +592,87 @@ class Api extends HttpClient {
569
592
  * @secure
570
593
  */
571
594
  this.accountsUpdate = (data, params = {}) => this.request(Object.assign({ path: `/accounts.update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
595
+ /**
596
+ * @description Get count of articles matching given filter.
597
+ *
598
+ * @tags articles
599
+ * @name ArticlesCount
600
+ * @request GET:/articles.count
601
+ * @secure
602
+ */
603
+ this.articlesCount = (query, params = {}) => this.request(Object.assign({ path: `/articles.count`, method: 'GET', query: query, secure: true, format: 'json' }, params));
604
+ /**
605
+ * @description Get count of articles matching given filter.
606
+ *
607
+ * @tags articles
608
+ * @name ArticlesCountPost
609
+ * @request POST:/articles.count
610
+ * @secure
611
+ */
612
+ this.articlesCountPost = (data, params = {}) => this.request(Object.assign({ path: `/articles.count`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
613
+ /**
614
+ * @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.
615
+ *
616
+ * @tags articles
617
+ * @name CreateArticle
618
+ * @request POST:/articles.create
619
+ * @secure
620
+ */
621
+ this.createArticle = (data, params = {}) => this.request(Object.assign({ path: `/articles.create`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
622
+ /**
623
+ * @description Deletes an article.
624
+ *
625
+ * @tags articles
626
+ * @name DeleteArticle
627
+ * @request POST:/articles.delete
628
+ * @secure
629
+ */
630
+ this.deleteArticle = (data, params = {}) => this.request(Object.assign({ path: `/articles.delete`, method: 'POST', body: data, secure: true, type: ContentType.Json }, params));
631
+ /**
632
+ * @description Gets an article.
633
+ *
634
+ * @tags articles
635
+ * @name GetArticle
636
+ * @request GET:/articles.get
637
+ * @secure
638
+ */
639
+ this.getArticle = (query, params = {}) => this.request(Object.assign({ path: `/articles.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
640
+ /**
641
+ * @description Gets an article.
642
+ *
643
+ * @tags articles
644
+ * @name GetArticlePost
645
+ * @request POST:/articles.get
646
+ * @secure
647
+ */
648
+ this.getArticlePost = (data, params = {}) => this.request(Object.assign({ path: `/articles.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
649
+ /**
650
+ * @description Lists a collection of articles.
651
+ *
652
+ * @tags articles
653
+ * @name ListArticles
654
+ * @request GET:/articles.list
655
+ * @secure
656
+ */
657
+ this.listArticles = (query, params = {}) => this.request(Object.assign({ path: `/articles.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
658
+ /**
659
+ * @description Lists a collection of articles.
660
+ *
661
+ * @tags articles
662
+ * @name ListArticlesPost
663
+ * @request POST:/articles.list
664
+ * @secure
665
+ */
666
+ this.listArticlesPost = (data, params = {}) => this.request(Object.assign({ path: `/articles.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
667
+ /**
668
+ * @description Updates an article.
669
+ *
670
+ * @tags articles
671
+ * @name UpdateArticle
672
+ * @request POST:/articles.update
673
+ * @secure
674
+ */
675
+ this.updateArticle = (data, params = {}) => this.request(Object.assign({ path: `/articles.update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
572
676
  /**
573
677
  * @description Creates a conversation.
574
678
  *
@@ -1991,7 +1991,7 @@ export interface WorksListResponse {
1991
1991
  /** works-update-request */
1992
1992
  export type WorksUpdateRequest = (WorksUpdateRequestIssue | WorksUpdateRequestTicket) & {
1993
1993
  /**
1994
- * Updates the part that the work applies to.
1994
+ * Updates the part that the work item applies to.
1995
1995
  * @example "don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"
1996
1996
  */
1997
1997
  applies_to_part?: string;
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.7",
4
4
  "description": "## SDK Generation",
5
5
  "main": "./dist/index.js",
6
6
  "scripts": {