@devrev/typescript-sdk 1.1.22 → 1.1.23

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.
@@ -109,6 +109,8 @@ export interface AccountsExportRequest {
109
109
  created_date?: DateTimeFilter;
110
110
  /** Filters for custom fields. */
111
111
  custom_fields?: object;
112
+ /** Array of display names of accounts to be filtered. */
113
+ display_name?: string[];
112
114
  /** Domains for accounts to be filtered. */
113
115
  domains?: string[];
114
116
  /** Array of references of accounts to be filtered. */
@@ -145,6 +147,8 @@ export interface AccountsFilters {
145
147
  created_date?: DateTimeFilter;
146
148
  /** Filters for custom fields. */
147
149
  custom_fields?: object;
150
+ /** Array of display names of accounts to be filtered. */
151
+ display_name?: string[];
148
152
  /** Domains for accounts to be filtered. */
149
153
  domains?: string[];
150
154
  /** Array of references of accounts to be filtered. */
@@ -190,6 +194,8 @@ export interface AccountsListRequest {
190
194
  cursor?: string;
191
195
  /** Filters for custom fields. */
192
196
  custom_fields?: object;
197
+ /** Array of display names of accounts to be filtered. */
198
+ display_name?: string[];
193
199
  /** Domains for accounts to be filtered. */
194
200
  domains?: string[];
195
201
  /** Array of references of accounts to be filtered. */
@@ -377,6 +383,8 @@ export type AppFragment = CustomSchemaFragmentBase & {
377
383
  /** App this fragment applies to. */
378
384
  app?: string;
379
385
  };
386
+ /** app-fragment-summary */
387
+ export type AppFragmentSummary = CustomSchemaFragmentBaseSummary;
380
388
  /** article */
381
389
  export type Article = AtomBase & {
382
390
  /** Details of the parts relevant to the article. */
@@ -422,6 +430,8 @@ export interface ArticlesCountRequest {
422
430
  * @example ["DEVU-12345"]
423
431
  */
424
432
  owned_by?: string[];
433
+ /** Filter for articles based on intended audience. */
434
+ shared_with?: SharedWithMembershipFilter[];
425
435
  }
426
436
  /** articles-count-response */
427
437
  export interface ArticlesCountResponse {
@@ -573,6 +583,8 @@ export interface ArticlesListRequest {
573
583
  * @example ["DEVU-12345"]
574
584
  */
575
585
  owned_by?: string[];
586
+ /** Filter for articles based on intended audience. */
587
+ shared_with?: SharedWithMembershipFilter[];
576
588
  }
577
589
  /**
578
590
  * articles-list-response
@@ -702,8 +714,63 @@ export interface ArticlesUpdateRequestTags {
702
714
  export interface ArticlesUpdateResponse {
703
715
  article: Article;
704
716
  }
717
+ /** artifact */
718
+ export type Artifact = AtomBase;
705
719
  /** artifact-summary */
706
720
  export type ArtifactSummary = AtomBaseSummary;
721
+ /**
722
+ * artifact-version
723
+ * The version of the artifact.
724
+ */
725
+ export interface ArtifactVersion {
726
+ modified_by?: UserSummary;
727
+ /**
728
+ * The timestamp at which the version was created.
729
+ * @format date-time
730
+ * @example "2023-01-01T12:00:00.000Z"
731
+ */
732
+ timestamp: string;
733
+ /** The version of the artifact. */
734
+ version: string;
735
+ }
736
+ /**
737
+ * artifacts-get-request
738
+ * The request to get an artifact's information.
739
+ */
740
+ export interface ArtifactsGetRequest {
741
+ /**
742
+ * The requested artifact's ID.
743
+ * @example "ARTIFACT-12345"
744
+ */
745
+ id: string;
746
+ /** The version of the artifact that needs to be fetched. */
747
+ version?: string;
748
+ }
749
+ /**
750
+ * artifacts-get-response
751
+ * The response to getting an artifact's information.
752
+ */
753
+ export interface ArtifactsGetResponse {
754
+ artifact: Artifact;
755
+ /** The version of the artifact. */
756
+ version: ArtifactVersion;
757
+ }
758
+ /**
759
+ * artifacts-list-request
760
+ * The request to list artifacts attached to an object.
761
+ */
762
+ export interface ArtifactsListRequest {
763
+ /** The ID of the object to filter artifacts. */
764
+ parent_id: string;
765
+ }
766
+ /**
767
+ * artifacts-list-response
768
+ * The response to list artifacts attached to an object.
769
+ */
770
+ export interface ArtifactsListResponse {
771
+ /** The artifact's information. */
772
+ artifacts: Artifact[];
773
+ }
707
774
  /**
708
775
  * artifacts-locate-request
709
776
  * The request to get an artifact's download URL.
@@ -819,6 +886,35 @@ export interface AtomBaseSummary {
819
886
  /** Globally unique object ID. */
820
887
  id: string;
821
888
  }
889
+ /** atom-summary */
890
+ export type AtomSummary = (AccountSummary | AppFragmentSummary | CapabilitySummary | ConversationSummary | CustomTypeFragmentSummary | DevUserSummary | EngagementSummary | EnhancementSummary | FeatureSummary | IssueSummary | MeetingSummary | OpportunitySummary | ProductSummary | RevOrgSummary | RevUserSummary | ServiceAccountSummary | SysUserSummary | TagSummary | TaskSummary | TenantFragmentSummary | TicketSummary | TimelineCommentSummary | WebhookSummary) & {
891
+ type: AtomType;
892
+ };
893
+ export declare enum AtomType {
894
+ Account = "account",
895
+ AppFragment = "app_fragment",
896
+ Capability = "capability",
897
+ Conversation = "conversation",
898
+ CustomTypeFragment = "custom_type_fragment",
899
+ DevUser = "dev_user",
900
+ Engagement = "engagement",
901
+ Enhancement = "enhancement",
902
+ Feature = "feature",
903
+ Issue = "issue",
904
+ Meeting = "meeting",
905
+ Opportunity = "opportunity",
906
+ Product = "product",
907
+ RevOrg = "rev_org",
908
+ RevUser = "rev_user",
909
+ ServiceAccount = "service_account",
910
+ SysUser = "sys_user",
911
+ Tag = "tag",
912
+ Task = "task",
913
+ TenantFragment = "tenant_fragment",
914
+ Ticket = "ticket",
915
+ TimelineComment = "timeline_comment",
916
+ Webhook = "webhook"
917
+ }
822
918
  /**
823
919
  * auth-connection
824
920
  * Connection object that specifies the configuration for an
@@ -1678,7 +1774,11 @@ export type CustomSchemaFragmentBase = AtomBase & {
1678
1774
  fragment_type?: CustomSchemaFragmentFragmentType;
1679
1775
  /** Leaf type this fragment applies to. */
1680
1776
  leaf_type?: string;
1777
+ new_fragment_ref?: CustomSchemaFragmentSummary;
1778
+ old_fragment_ref?: CustomSchemaFragmentSummary;
1681
1779
  };
1780
+ /** custom-schema-fragment-base-summary */
1781
+ export type CustomSchemaFragmentBaseSummary = AtomBaseSummary;
1682
1782
  /**
1683
1783
  * custom-schema-fragment-condition
1684
1784
  * The condition associated with a field.
@@ -1690,6 +1790,10 @@ export declare enum CustomSchemaFragmentFragmentType {
1690
1790
  CustomType = "custom_type",
1691
1791
  Tenant = "tenant"
1692
1792
  }
1793
+ /** custom-schema-fragment-summary */
1794
+ export type CustomSchemaFragmentSummary = (AppFragmentSummary | CustomTypeFragmentSummary | TenantFragmentSummary) & {
1795
+ type: CustomSchemaFragmentType;
1796
+ };
1693
1797
  export declare enum CustomSchemaFragmentType {
1694
1798
  AppFragment = "app_fragment",
1695
1799
  CustomTypeFragment = "custom_type_fragment",
@@ -1800,6 +1904,8 @@ export type CustomTypeFragment = CustomSchemaFragmentBase & {
1800
1904
  */
1801
1905
  subtype_display_name?: string;
1802
1906
  };
1907
+ /** custom-type-fragment-summary */
1908
+ export type CustomTypeFragmentSummary = CustomSchemaFragmentBaseSummary;
1803
1909
  /**
1804
1910
  * custom-type-path-component
1805
1911
  * Path component for rendering custom type lists in tree form.
@@ -2112,6 +2218,8 @@ export type Engagement = AtomBase & {
2112
2218
  /** Description of the engagement object. */
2113
2219
  description?: string;
2114
2220
  };
2221
+ /** engagement-summary */
2222
+ export type EngagementSummary = AtomBaseSummary;
2115
2223
  /** Type of engagement. */
2116
2224
  export declare enum EngagementType {
2117
2225
  Call = "call",
@@ -2331,11 +2439,16 @@ export interface Error {
2331
2439
  type?: string;
2332
2440
  }
2333
2441
  /** error-bad-request */
2334
- export type ErrorBadRequest = ErrorBase & (ErrorBadRequestBadRequest | ErrorBadRequestInvalidEnumValue | ErrorBadRequestInvalidField | ErrorBadRequestMissingDependency | ErrorBadRequestMissingRequiredField | ErrorBadRequestParseError | ErrorBadRequestValueNotPermitted) & {
2442
+ export type ErrorBadRequest = ErrorBase & (ErrorBadRequestBadRequest | ErrorBadRequestInvalidApiVersion | ErrorBadRequestInvalidEnumValue | ErrorBadRequestInvalidField | ErrorBadRequestMissingDependency | ErrorBadRequestMissingRequiredField | ErrorBadRequestParseError | ErrorBadRequestStaleSchemaFragments | ErrorBadRequestValueNotPermitted) & {
2335
2443
  type: ErrorBadRequestType;
2336
2444
  };
2337
2445
  /** error-bad-request-bad-request */
2338
2446
  export type ErrorBadRequestBadRequest = object;
2447
+ /** error-bad-request-invalid-api-version */
2448
+ export interface ErrorBadRequestInvalidApiVersion {
2449
+ /** The provided API version. */
2450
+ value: string;
2451
+ }
2339
2452
  /** error-bad-request-invalid-enum-value */
2340
2453
  export interface ErrorBadRequestInvalidEnumValue {
2341
2454
  /** The allowed values for the field. */
@@ -2368,13 +2481,24 @@ export interface ErrorBadRequestMissingRequiredField {
2368
2481
  }
2369
2482
  /** error-bad-request-parse-error */
2370
2483
  export type ErrorBadRequestParseError = object;
2484
+ /**
2485
+ * error-bad-request-stale-schema-fragments
2486
+ * Error indicating that the request contained one or more stale schema
2487
+ * fragments, which are schema fragments that have been replaced by a
2488
+ * newer version and are therefore considered deprecated schema fragments.
2489
+ * The caller should refresh and use the latest schema fragments in their
2490
+ * request.
2491
+ */
2492
+ export type ErrorBadRequestStaleSchemaFragments = object;
2371
2493
  export declare enum ErrorBadRequestType {
2372
2494
  BadRequest = "bad_request",
2495
+ InvalidApiVersion = "invalid_api_version",
2373
2496
  InvalidEnumValue = "invalid_enum_value",
2374
2497
  InvalidField = "invalid_field",
2375
2498
  MissingDependency = "missing_dependency",
2376
2499
  MissingRequiredField = "missing_required_field",
2377
2500
  ParseError = "parse_error",
2501
+ StaleSchemaFragments = "stale_schema_fragments",
2378
2502
  ValueNotPermitted = "value_not_permitted"
2379
2503
  }
2380
2504
  /** error-bad-request-value-not-permitted */
@@ -2887,6 +3011,8 @@ export interface GroupsListRequest {
2887
3011
  * iteration starts from the beginning.
2888
3012
  */
2889
3013
  cursor?: string;
3014
+ /** Filters the groups based on the group type. */
3015
+ group_type?: GroupType[];
2890
3016
  /**
2891
3017
  * The maximum number of groups to return. The default is '50'.
2892
3018
  * @format int32
@@ -3179,6 +3305,8 @@ export declare enum ListMode {
3179
3305
  After = "after",
3180
3306
  Before = "before"
3181
3307
  }
3308
+ /** meeting-summary */
3309
+ export type MeetingSummary = AtomBaseSummary;
3182
3310
  /** member-summary */
3183
3311
  export type MemberSummary = (DevUserSummary | RevUserSummary | SysUserSummary) & {
3184
3312
  type: MemberType;
@@ -3237,8 +3365,6 @@ export type MetricDefinition = AtomBase;
3237
3365
  /** The list of item types on which the metric might be applied. */
3238
3366
  export declare enum MetricDefinitionAppliesTo {
3239
3367
  Conversation = "conversation",
3240
- Issue = "issue",
3241
- Task = "task",
3242
3368
  Ticket = "ticket"
3243
3369
  }
3244
3370
  /**
@@ -4502,6 +4628,14 @@ export type SchemaEnumListFieldDescriptor = SchemaFieldDescriptorBase & {
4502
4628
  /** Default value. */
4503
4629
  default_value?: string[];
4504
4630
  };
4631
+ /**
4632
+ * schema-field-create-view-ui-metadata
4633
+ * Create view UI hint overrides.
4634
+ */
4635
+ export interface SchemaFieldCreateViewUiMetadata {
4636
+ /** Whether field is hidden in the UI create view. */
4637
+ is_hidden?: boolean;
4638
+ }
4505
4639
  /**
4506
4640
  * schema-field-descriptor
4507
4641
  * Set of field attributes.
@@ -4512,6 +4646,11 @@ export type SchemaFieldDescriptor = (SchemaBoolFieldDescriptor | SchemaComposite
4512
4646
  /** schema-field-descriptor-array-type */
4513
4647
  export type SchemaFieldDescriptorArrayType = (SchemaBoolListFieldDescriptor | SchemaCompositeListFieldDescriptor | SchemaDateListFieldDescriptor | SchemaDoubleListFieldDescriptor | SchemaEnumListFieldDescriptor | SchemaIdListFieldDescriptor | SchemaIntListFieldDescriptor | SchemaRichTextListFieldDescriptor | SchemaTextListFieldDescriptor | SchemaTimestampListFieldDescriptor | SchemaTokensListFieldDescriptor | SchemaUenumListFieldDescriptor) & {
4514
4648
  base_type: SchemaFieldDescriptorArrayTypeBaseType;
4649
+ /**
4650
+ * The exact array length.
4651
+ * @format int64
4652
+ */
4653
+ eq_items?: number;
4515
4654
  /**
4516
4655
  * The maximum array length.
4517
4656
  * @format int64
@@ -4575,11 +4714,43 @@ export declare enum SchemaFieldDescriptorFieldType {
4575
4714
  Uenum = "uenum",
4576
4715
  Unknown = "unknown"
4577
4716
  }
4717
+ /**
4718
+ * schema-field-detail-view-ui-metadata
4719
+ * Detail view UI hint overrides.
4720
+ */
4721
+ export interface SchemaFieldDetailViewUiMetadata {
4722
+ /** Whether the field is hidden in the UI detail view. */
4723
+ is_hidden?: boolean;
4724
+ }
4725
+ /**
4726
+ * schema-field-filter-view-ui-metadata
4727
+ * Filter view UI hint overrides.
4728
+ */
4729
+ export interface SchemaFieldFilterViewUiMetadata {
4730
+ /** Whether field is hidden in the UI filter view. */
4731
+ is_hidden?: boolean;
4732
+ }
4733
+ /**
4734
+ * schema-field-list-view-ui-metadata
4735
+ * List view UI hint overrides.
4736
+ */
4737
+ export interface SchemaFieldListViewUiMetadata {
4738
+ /** Whether the field is hidden in the UI list view. */
4739
+ is_hidden?: boolean;
4740
+ }
4578
4741
  /**
4579
4742
  * schema-field-mfz-metadata
4580
4743
  * The schema of MFZ specific fields.
4581
4744
  */
4582
4745
  export type SchemaFieldMfzMetadata = object;
4746
+ /**
4747
+ * schema-field-summary-view-ui-metadata
4748
+ * Summary view UI hint overrides.
4749
+ */
4750
+ export interface SchemaFieldSummaryViewUiMetadata {
4751
+ /** Whether field is hidden in the UI summary view. */
4752
+ is_hidden?: boolean;
4753
+ }
4583
4754
  /**
4584
4755
  * schema-field-uenum-value
4585
4756
  * A unified enum value.
@@ -4589,7 +4760,42 @@ export type SchemaFieldUenumValue = object;
4589
4760
  * schema-field-ui-metadata
4590
4761
  * The schema of ui specific fields.
4591
4762
  */
4592
- export type SchemaFieldUiMetadata = object;
4763
+ export interface SchemaFieldUiMetadata {
4764
+ /** Create view UI hint overrides. */
4765
+ create_view?: SchemaFieldCreateViewUiMetadata;
4766
+ /** Detail view UI hint overrides. */
4767
+ detail_view?: SchemaFieldDetailViewUiMetadata;
4768
+ /** The display name of the field. */
4769
+ display_name?: string;
4770
+ /** Filter view UI hint overrides. */
4771
+ filter_view?: SchemaFieldFilterViewUiMetadata;
4772
+ /** An optional group name for the field. */
4773
+ group_name?: string;
4774
+ /** Whether the field is active in the UI detail view. */
4775
+ is_active_in_detail_view?: boolean;
4776
+ /** Whether the field supports bulk action. */
4777
+ is_bulk_action_enabled?: boolean;
4778
+ /** Whether the field is groupable in the UI. */
4779
+ is_groupable?: boolean;
4780
+ /** Whether the field is hidden in the UI. */
4781
+ is_hidden?: boolean;
4782
+ /** Whether the field is hidden in the UI during creation. */
4783
+ is_hidden_during_create?: boolean;
4784
+ /** Whether the field is read-only in the UI. */
4785
+ is_read_only?: boolean;
4786
+ /** Whether the field is shown in the UI summary view. */
4787
+ is_shown_in_summary?: boolean;
4788
+ /** Whether the field is sortable in the UI. */
4789
+ is_sortable?: boolean;
4790
+ /** List view UI hint overrides. */
4791
+ list_view?: SchemaFieldListViewUiMetadata;
4792
+ /** A placeholder for the field. */
4793
+ placeholder?: string;
4794
+ /** Summary view UI hint overrides. */
4795
+ summary_view?: SchemaFieldSummaryViewUiMetadata;
4796
+ /** Tooltip for the field. */
4797
+ tooltip?: string;
4798
+ }
4593
4799
  /** schema-id-field-descriptor */
4594
4800
  export type SchemaIdFieldDescriptor = SchemaFieldDescriptorBase & {
4595
4801
  /** Default value. */
@@ -4975,6 +5181,11 @@ export interface SetWeeklyOrgSchedule {
4975
5181
  * Information about the role the member receives due to the share.
4976
5182
  */
4977
5183
  export type SharedWithMembership = object;
5184
+ /**
5185
+ * shared-with-membership-filter
5186
+ * Filter on target item based on intended audience.
5187
+ */
5188
+ export type SharedWithMembershipFilter = object;
4978
5189
  /** sla */
4979
5190
  export type Sla = AtomBase & {
4980
5191
  /**
@@ -5076,6 +5287,8 @@ export declare enum SlaStatus {
5076
5287
  export interface SlaSummaryFilter {
5077
5288
  /** Filters for records with any of the provided SLA stages. */
5078
5289
  stage?: SlaSummaryStage[];
5290
+ /** Provides ways to specify date ranges on objects. */
5291
+ target_time?: DateFilter;
5079
5292
  }
5080
5293
  /**
5081
5294
  * The stage of the SLA. This is the metric stage which is closest to
@@ -5296,6 +5509,57 @@ export interface StageUpdate {
5296
5509
  * A stock field override.
5297
5510
  */
5298
5511
  export type StockFieldOverride = object;
5512
+ /** stock-schema-fragment */
5513
+ export type StockSchemaFragment = AtomBase & {
5514
+ /** Description of the schema. */
5515
+ description?: string;
5516
+ /** List of all fields in this schema. */
5517
+ fields: SchemaFieldDescriptor[];
5518
+ /** Leaf type this fragment applies to. */
5519
+ leaf_type?: string;
5520
+ new_fragment_ref?: AtomSummary;
5521
+ old_fragment_ref?: AtomSummary;
5522
+ /** Title of the schema. */
5523
+ title?: string;
5524
+ };
5525
+ /** stock-schema-fragments-get-request */
5526
+ export interface StockSchemaFragmentsGetRequest {
5527
+ /** The ID of the stock schema fragment. */
5528
+ id?: string;
5529
+ /** The leaf type this fragment applies to. */
5530
+ leaf_type?: string;
5531
+ }
5532
+ /** stock-schema-fragments-get-response */
5533
+ export interface StockSchemaFragmentsGetResponse {
5534
+ fragment: StockSchemaFragment;
5535
+ }
5536
+ /** stock-schema-fragments-list-request */
5537
+ export interface StockSchemaFragmentsListRequest {
5538
+ /**
5539
+ * The cursor to resume iteration from, otherwise if not provided,
5540
+ * then iteration starts from the beginning.
5541
+ */
5542
+ cursor?: string;
5543
+ /** The list of leaf types. */
5544
+ leaf_type?: string[];
5545
+ /**
5546
+ * The maximum number of items.
5547
+ * @format int32
5548
+ */
5549
+ limit?: number;
5550
+ /** The list of fields to sort the items by and how to sort them. */
5551
+ sort_by?: string[];
5552
+ }
5553
+ /** stock-schema-fragments-list-response */
5554
+ export interface StockSchemaFragmentsListResponse {
5555
+ /**
5556
+ * The cursor to resume iteration from, otherwise if not provided,
5557
+ * then iteration starts from the beginning.
5558
+ */
5559
+ cursor?: string;
5560
+ /** The stock schema fragments. */
5561
+ result: StockSchemaFragment[];
5562
+ }
5299
5563
  /** subtype */
5300
5564
  export interface Subtype {
5301
5565
  /** Display name of the subtype. */
@@ -5598,8 +5862,12 @@ export declare enum TaskPriority {
5598
5862
  export type TaskSummary = WorkBaseSummary;
5599
5863
  /** tenant-fragment */
5600
5864
  export type TenantFragment = CustomSchemaFragmentBase;
5865
+ /** tenant-fragment-summary */
5866
+ export type TenantFragmentSummary = CustomSchemaFragmentBaseSummary;
5601
5867
  /** ticket */
5602
5868
  export type Ticket = WorkBase & {
5869
+ /** Channels of the ticket. */
5870
+ channels?: TicketChannels[];
5603
5871
  group?: GroupSummary;
5604
5872
  rev_org?: OrgSummary;
5605
5873
  /** Severity of the ticket. */
@@ -5607,6 +5875,12 @@ export type Ticket = WorkBase & {
5607
5875
  /** Source channel of the ticket. */
5608
5876
  source_channel?: string;
5609
5877
  };
5878
+ /** Channels of the ticket. */
5879
+ export declare enum TicketChannels {
5880
+ Email = "email",
5881
+ Plug = "plug",
5882
+ Slack = "slack"
5883
+ }
5610
5884
  /** Severity of the ticket. */
5611
5885
  export declare enum TicketSeverity {
5612
5886
  Blocker = "blocker",
@@ -5642,6 +5916,8 @@ export declare enum TimelineCommentBodyType {
5642
5916
  SnapWidget = "snap_widget",
5643
5917
  Text = "text"
5644
5918
  }
5919
+ /** timeline-comment-summary */
5920
+ export type TimelineCommentSummary = TimelineEntryBaseSummary;
5645
5921
  /** Describes collections of timeline entries. */
5646
5922
  export declare enum TimelineEntriesCollection {
5647
5923
  Discussions = "discussions",
@@ -5931,6 +6207,8 @@ export type TimelineEntryBase = AtomBase & {
5931
6207
  */
5932
6208
  visibility?: TimelineEntryVisibility;
5933
6209
  };
6210
+ /** timeline-entry-base-summary */
6211
+ export type TimelineEntryBaseSummary = AtomBaseSummary;
5934
6212
  /** The type of object that the Timeline entry belongs to. */
5935
6213
  export declare enum TimelineEntryObjectType {
5936
6214
  Account = "account",
@@ -6469,6 +6747,8 @@ export declare enum WebhookStatus {
6469
6747
  Inactive = "inactive",
6470
6748
  Unverified = "unverified"
6471
6749
  }
6750
+ /** webhook-summary */
6751
+ export type WebhookSummary = AtomBaseSummary;
6472
6752
  /**
6473
6753
  * webhooks-create-request
6474
6754
  * The request to create a new webhook.
@@ -6768,6 +7048,8 @@ export interface WorksCreateRequestTask {
6768
7048
  }
6769
7049
  /** works-create-request-ticket */
6770
7050
  export interface WorksCreateRequestTicket {
7051
+ /** Channels of the ticket. */
7052
+ channels?: TicketChannels[];
6771
7053
  /** The group that the ticket is associated with. */
6772
7054
  group?: string;
6773
7055
  /** Whether the ticket is spam. */
@@ -6829,6 +7111,11 @@ export interface WorksExportRequest {
6829
7111
  * @example ["DEVU-12345"]
6830
7112
  */
6831
7113
  owned_by?: string[];
7114
+ /**
7115
+ * Filters for work reported by any of these users.
7116
+ * @example ["DEVU-12345"]
7117
+ */
7118
+ reported_by?: string[];
6832
7119
  /** Fields to sort the work items by and the direction to sort them. */
6833
7120
  sort_by?: string[];
6834
7121
  /** The filter for stages. */
@@ -6879,6 +7166,8 @@ export interface WorksFilterOpportunity {
6879
7166
  }
6880
7167
  /** works-filter-ticket */
6881
7168
  export interface WorksFilterTicket {
7169
+ /** Filters for tickets with any of the provided channels. */
7170
+ channels?: TicketChannels[];
6882
7171
  /** Filters for tickets belonging to specific groups. */
6883
7172
  group?: string[];
6884
7173
  /** Filters for tickets that are spam. */
@@ -6957,6 +7246,11 @@ export interface WorksListRequest {
6957
7246
  * @example ["DEVU-12345"]
6958
7247
  */
6959
7248
  owned_by?: string[];
7249
+ /**
7250
+ * Filters for work reported by any of these users.
7251
+ * @example ["DEVU-12345"]
7252
+ */
7253
+ reported_by?: string[];
6960
7254
  /** Fields to sort the works by and the direction to sort them. */
6961
7255
  sort_by?: string[];
6962
7256
  /** The filter for stages. */
@@ -7127,6 +7421,7 @@ export interface WorksUpdateRequestTask {
7127
7421
  }
7128
7422
  /** works-update-request-ticket */
7129
7423
  export interface WorksUpdateRequestTicket {
7424
+ channels?: WorksUpdateRequestTicketChannels;
7130
7425
  /** Updates the group that the ticket is associated with. */
7131
7426
  group?: string | null;
7132
7427
  /** Updates whether the ticket is spam. */
@@ -7139,6 +7434,11 @@ export interface WorksUpdateRequestTicket {
7139
7434
  /** Severity of the ticket. */
7140
7435
  severity?: TicketSeverity;
7141
7436
  }
7437
+ /** works-update-request-ticket-channels */
7438
+ export interface WorksUpdateRequestTicketChannels {
7439
+ /** Sets the channels to the provided channels. */
7440
+ set?: TicketChannels[];
7441
+ }
7142
7442
  /** works-update-response */
7143
7443
  export interface WorksUpdateResponse {
7144
7444
  work: Work;
@@ -7236,6 +7536,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
7236
7536
  'created_date.before'?: string;
7237
7537
  /** Filters for custom fields. */
7238
7538
  custom_fields?: object;
7539
+ /** Array of display names of accounts to be filtered. */
7540
+ display_name?: string[];
7239
7541
  /** Domains for accounts to be filtered. */
7240
7542
  domains?: string[];
7241
7543
  /** Array of references of accounts to be filtered. */
@@ -7333,6 +7635,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
7333
7635
  cursor?: string;
7334
7636
  /** Filters for custom fields. */
7335
7637
  custom_fields?: object;
7638
+ /** Array of display names of accounts to be filtered. */
7639
+ display_name?: string[];
7336
7640
  /** Domains for accounts to be filtered. */
7337
7641
  domains?: string[];
7338
7642
  /** Array of references of accounts to be filtered. */
@@ -7532,6 +7836,53 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
7532
7836
  * @secure
7533
7837
  */
7534
7838
  updateArticle: (data: ArticlesUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<ArticlesUpdateResponse, any>>;
7839
+ /**
7840
+ * @description Gets the requested artifact's information.
7841
+ *
7842
+ * @tags artifacts
7843
+ * @name ArtifactsGet
7844
+ * @request GET:/artifacts.get
7845
+ * @secure
7846
+ */
7847
+ artifactsGet: (query: {
7848
+ /**
7849
+ * The requested artifact's ID.
7850
+ * @example "ARTIFACT-12345"
7851
+ */
7852
+ id: string;
7853
+ /** The version of the artifact that needs to be fetched. */
7854
+ version?: string;
7855
+ }, params?: RequestParams) => Promise<AxiosResponse<ArtifactsGetResponse, any>>;
7856
+ /**
7857
+ * @description Gets the requested artifact's information.
7858
+ *
7859
+ * @tags artifacts
7860
+ * @name ArtifactsGetPost
7861
+ * @request POST:/artifacts.get
7862
+ * @secure
7863
+ */
7864
+ artifactsGetPost: (data: ArtifactsGetRequest, params?: RequestParams) => Promise<AxiosResponse<ArtifactsGetResponse, any>>;
7865
+ /**
7866
+ * @description List the artifacts attached to an object.
7867
+ *
7868
+ * @tags artifacts
7869
+ * @name ArtifactsList
7870
+ * @request GET:/artifacts.list
7871
+ * @secure
7872
+ */
7873
+ artifactsList: (query: {
7874
+ /** The ID of the object to filter artifacts. */
7875
+ parent_id: string;
7876
+ }, params?: RequestParams) => Promise<AxiosResponse<ArtifactsListResponse, any>>;
7877
+ /**
7878
+ * @description List the artifacts attached to an object.
7879
+ *
7880
+ * @tags artifacts
7881
+ * @name ArtifactsListPost
7882
+ * @request POST:/artifacts.list
7883
+ * @secure
7884
+ */
7885
+ artifactsListPost: (data: ArtifactsListRequest, params?: RequestParams) => Promise<AxiosResponse<ArtifactsListResponse, any>>;
7535
7886
  /**
7536
7887
  * @description Gets the download URL for the artifact.
7537
7888
  *
@@ -8328,6 +8679,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
8328
8679
  * starts from the beginning.
8329
8680
  */
8330
8681
  cursor?: string;
8682
+ /** Filters the groups based on the group type. */
8683
+ group_type?: GroupType[];
8331
8684
  /**
8332
8685
  * The maximum number of groups to return. The default is '50'.
8333
8686
  * @format int32
@@ -9183,6 +9536,62 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
9183
9536
  * @secure
9184
9537
  */
9185
9538
  customSchemaFragmentsSet: (data: CustomSchemaFragmentsSetRequest, params?: RequestParams) => Promise<AxiosResponse<CustomSchemaFragmentsSetResponse, any>>;
9539
+ /**
9540
+ * @description Gets a stock schema fragment.
9541
+ *
9542
+ * @tags customization
9543
+ * @name StockSchemaFragmentsGet
9544
+ * @request GET:/schemas.stock.get
9545
+ * @secure
9546
+ */
9547
+ stockSchemaFragmentsGet: (query?: {
9548
+ /** The ID of the stock schema fragment. */
9549
+ id?: string;
9550
+ /** The leaf type this fragment applies to. */
9551
+ leaf_type?: string;
9552
+ }, params?: RequestParams) => Promise<AxiosResponse<StockSchemaFragmentsGetResponse, any>>;
9553
+ /**
9554
+ * @description Gets a stock schema fragment.
9555
+ *
9556
+ * @tags customization
9557
+ * @name StockSchemaFragmentsGetPost
9558
+ * @request POST:/schemas.stock.get
9559
+ * @secure
9560
+ */
9561
+ stockSchemaFragmentsGetPost: (data: StockSchemaFragmentsGetRequest, params?: RequestParams) => Promise<AxiosResponse<StockSchemaFragmentsGetResponse, any>>;
9562
+ /**
9563
+ * @description Lists stock schema fragments.
9564
+ *
9565
+ * @tags customization
9566
+ * @name StockSchemaFragmentsList
9567
+ * @request GET:/schemas.stock.list
9568
+ * @secure
9569
+ */
9570
+ stockSchemaFragmentsList: (query?: {
9571
+ /**
9572
+ * The cursor to resume iteration from, otherwise if not provided, then
9573
+ * iteration starts from the beginning.
9574
+ */
9575
+ cursor?: string;
9576
+ /** The list of leaf types. */
9577
+ leaf_type?: string[];
9578
+ /**
9579
+ * The maximum number of items.
9580
+ * @format int32
9581
+ */
9582
+ limit?: number;
9583
+ /** The list of fields to sort the items by and how to sort them. */
9584
+ sort_by?: string[];
9585
+ }, params?: RequestParams) => Promise<AxiosResponse<StockSchemaFragmentsListResponse, any>>;
9586
+ /**
9587
+ * @description Lists stock schema fragments.
9588
+ *
9589
+ * @tags customization
9590
+ * @name StockSchemaFragmentsListPost
9591
+ * @request POST:/schemas.stock.list
9592
+ * @secure
9593
+ */
9594
+ stockSchemaFragmentsListPost: (data: StockSchemaFragmentsListRequest, params?: RequestParams) => Promise<AxiosResponse<StockSchemaFragmentsListResponse, any>>;
9186
9595
  /**
9187
9596
  * @description Lists subtypes.
9188
9597
  *
@@ -9839,6 +10248,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
9839
10248
  * @example ["DEVU-12345"]
9840
10249
  */
9841
10250
  owned_by?: string[];
10251
+ /**
10252
+ * Filters for work reported by any of these users.
10253
+ * @example ["DEVU-12345"]
10254
+ */
10255
+ reported_by?: string[];
9842
10256
  /** Fields to sort the work items by and the direction to sort them. */
9843
10257
  sort_by?: string[];
9844
10258
  /** Filters for records in the provided stage(s) by name. */
@@ -9848,6 +10262,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
9848
10262
  * @example ["TAG-12345"]
9849
10263
  */
9850
10264
  tags?: string[];
10265
+ /** Filters for tickets with any of the provided channels. */
10266
+ 'ticket.channels'?: TicketChannels[];
9851
10267
  /** Filters for tickets belonging to specific groups. */
9852
10268
  'ticket.group'?: string[];
9853
10269
  /** Filters for tickets that are spam. */
@@ -9964,6 +10380,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
9964
10380
  * @example ["DEVU-12345"]
9965
10381
  */
9966
10382
  owned_by?: string[];
10383
+ /**
10384
+ * Filters for work reported by any of these users.
10385
+ * @example ["DEVU-12345"]
10386
+ */
10387
+ reported_by?: string[];
9967
10388
  /** Fields to sort the works by and the direction to sort them. */
9968
10389
  sort_by?: string[];
9969
10390
  /** Filters for records in the provided stage(s) by name. */
@@ -9973,6 +10394,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
9973
10394
  * @example ["TAG-12345"]
9974
10395
  */
9975
10396
  tags?: string[];
10397
+ /** Filters for tickets with any of the provided channels. */
10398
+ 'ticket.channels'?: TicketChannels[];
9976
10399
  /** Filters for tickets belonging to specific groups. */
9977
10400
  'ticket.group'?: string[];
9978
10401
  /** Filters for tickets that are spam. */
@@ -33,8 +33,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
33
33
  return (mod && mod.__esModule) ? mod : { "default": mod };
34
34
  };
35
35
  Object.defineProperty(exports, "__esModule", { value: true });
36
- exports.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.MemberType = exports.ListMode = exports.LinksDirection = exports.LinkType = exports.LinkEndpointType = exports.IssuePriority = exports.GroupType = exports.GroupMemberType = exports.EventSourceStatus = exports.ErrorUnauthorizedType = exports.ErrorTooManyRequestsType = exports.ErrorServiceUnavailableType = exports.ErrorNotFoundType = exports.ErrorInternalServerErrorType = exports.ErrorForbiddenType = exports.ErrorBadRequestType = exports.EngagementsCreateRequestEngagementType = exports.EngagementType = exports.DevOrgAuthConnectionsUpdateRequestType = exports.DevOrgAuthConnectionsCreateRequestType = exports.DateTimePresetType = exports.DateFilterType = exports.CustomSchemaFragmentsSetRequestType = exports.CustomSchemaFragmentType = exports.CustomSchemaFragmentFragmentType = exports.ConversationsCreateRequestTypeValue = exports.CodeChangeSource = exports.AuthTokenTokenType = exports.AuthTokenSubjectTokenType = exports.AuthTokenStatus = exports.AuthTokenRequestedTokenType = exports.AuthTokenGrantType = exports.AuthConnectionType = exports.AuthConnectionToggle = exports.ArticleStatus = exports.AggregationDetailAggregationType = exports.AccessLevel = void 0;
37
- exports.Api = exports.HttpClient = exports.ContentType = exports.WorkType = exports.WebhooksUpdateAction = exports.WebhookStatus = exports.WebhookEventType = exports.UserType = exports.UserState = exports.UomMetricScope = exports.UnitType = exports.TimelineEntryVisibility = exports.TimelineEntryType = exports.TimelineEntryObjectType = exports.TimelineEntriesUpdateRequestType = exports.TimelineEntriesCreateRequestType = exports.TimelineEntriesCollection = exports.TimelineCommentBodyType = exports.TicketSeverity = exports.TaskPriority = exports.SlaSummaryStage = exports.SlaStatus = exports.SlaSelectorSeverity = exports.SlaSelectorPriority = void 0;
36
+ 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.MemberType = exports.ListMode = exports.LinksDirection = exports.LinkType = exports.LinkEndpointType = exports.IssuePriority = exports.GroupType = exports.GroupMemberType = exports.EventSourceStatus = exports.ErrorUnauthorizedType = exports.ErrorTooManyRequestsType = exports.ErrorServiceUnavailableType = exports.ErrorNotFoundType = exports.ErrorInternalServerErrorType = exports.ErrorForbiddenType = exports.ErrorBadRequestType = exports.EngagementsCreateRequestEngagementType = exports.EngagementType = exports.DevOrgAuthConnectionsUpdateRequestType = exports.DevOrgAuthConnectionsCreateRequestType = exports.DateTimePresetType = exports.DateFilterType = exports.CustomSchemaFragmentsSetRequestType = exports.CustomSchemaFragmentType = exports.CustomSchemaFragmentFragmentType = exports.ConversationsCreateRequestTypeValue = exports.CodeChangeSource = exports.AuthTokenTokenType = exports.AuthTokenSubjectTokenType = exports.AuthTokenStatus = exports.AuthTokenRequestedTokenType = exports.AuthTokenGrantType = exports.AuthConnectionType = exports.AuthConnectionToggle = exports.AtomType = exports.ArticleStatus = exports.AggregationDetailAggregationType = exports.AccessLevel = void 0;
37
+ exports.Api = exports.HttpClient = exports.ContentType = exports.WorkType = exports.WebhooksUpdateAction = exports.WebhookStatus = exports.WebhookEventType = exports.UserType = exports.UserState = exports.UomMetricScope = exports.UnitType = exports.TimelineEntryVisibility = exports.TimelineEntryType = exports.TimelineEntryObjectType = exports.TimelineEntriesUpdateRequestType = exports.TimelineEntriesCreateRequestType = exports.TimelineEntriesCollection = exports.TimelineCommentBodyType = exports.TicketSeverity = exports.TicketChannels = exports.TaskPriority = exports.SlaSummaryStage = exports.SlaStatus = exports.SlaSelectorSeverity = exports.SlaSelectorPriority = exports.SlaSelectorAppliesTo = void 0;
38
38
  var AccessLevel;
39
39
  (function (AccessLevel) {
40
40
  AccessLevel["External"] = "external";
@@ -84,6 +84,32 @@ var ArticleStatus;
84
84
  ArticleStatus["Published"] = "published";
85
85
  ArticleStatus["ReviewNeeded"] = "review_needed";
86
86
  })(ArticleStatus = exports.ArticleStatus || (exports.ArticleStatus = {}));
87
+ var AtomType;
88
+ (function (AtomType) {
89
+ AtomType["Account"] = "account";
90
+ AtomType["AppFragment"] = "app_fragment";
91
+ AtomType["Capability"] = "capability";
92
+ AtomType["Conversation"] = "conversation";
93
+ AtomType["CustomTypeFragment"] = "custom_type_fragment";
94
+ AtomType["DevUser"] = "dev_user";
95
+ AtomType["Engagement"] = "engagement";
96
+ AtomType["Enhancement"] = "enhancement";
97
+ AtomType["Feature"] = "feature";
98
+ AtomType["Issue"] = "issue";
99
+ AtomType["Meeting"] = "meeting";
100
+ AtomType["Opportunity"] = "opportunity";
101
+ AtomType["Product"] = "product";
102
+ AtomType["RevOrg"] = "rev_org";
103
+ AtomType["RevUser"] = "rev_user";
104
+ AtomType["ServiceAccount"] = "service_account";
105
+ AtomType["SysUser"] = "sys_user";
106
+ AtomType["Tag"] = "tag";
107
+ AtomType["Task"] = "task";
108
+ AtomType["TenantFragment"] = "tenant_fragment";
109
+ AtomType["Ticket"] = "ticket";
110
+ AtomType["TimelineComment"] = "timeline_comment";
111
+ AtomType["Webhook"] = "webhook";
112
+ })(AtomType = exports.AtomType || (exports.AtomType = {}));
87
113
  var AuthConnectionToggle;
88
114
  (function (AuthConnectionToggle) {
89
115
  AuthConnectionToggle["Disable"] = "disable";
@@ -237,11 +263,13 @@ var EngagementsCreateRequestEngagementType;
237
263
  var ErrorBadRequestType;
238
264
  (function (ErrorBadRequestType) {
239
265
  ErrorBadRequestType["BadRequest"] = "bad_request";
266
+ ErrorBadRequestType["InvalidApiVersion"] = "invalid_api_version";
240
267
  ErrorBadRequestType["InvalidEnumValue"] = "invalid_enum_value";
241
268
  ErrorBadRequestType["InvalidField"] = "invalid_field";
242
269
  ErrorBadRequestType["MissingDependency"] = "missing_dependency";
243
270
  ErrorBadRequestType["MissingRequiredField"] = "missing_required_field";
244
271
  ErrorBadRequestType["ParseError"] = "parse_error";
272
+ ErrorBadRequestType["StaleSchemaFragments"] = "stale_schema_fragments";
245
273
  ErrorBadRequestType["ValueNotPermitted"] = "value_not_permitted";
246
274
  })(ErrorBadRequestType = exports.ErrorBadRequestType || (exports.ErrorBadRequestType = {}));
247
275
  var ErrorForbiddenType;
@@ -354,8 +382,6 @@ var MemberType;
354
382
  var MetricDefinitionAppliesTo;
355
383
  (function (MetricDefinitionAppliesTo) {
356
384
  MetricDefinitionAppliesTo["Conversation"] = "conversation";
357
- MetricDefinitionAppliesTo["Issue"] = "issue";
358
- MetricDefinitionAppliesTo["Task"] = "task";
359
385
  MetricDefinitionAppliesTo["Ticket"] = "ticket";
360
386
  })(MetricDefinitionAppliesTo = exports.MetricDefinitionAppliesTo || (exports.MetricDefinitionAppliesTo = {}));
361
387
  /**
@@ -527,6 +553,13 @@ var TaskPriority;
527
553
  TaskPriority["P2"] = "p2";
528
554
  TaskPriority["P3"] = "p3";
529
555
  })(TaskPriority = exports.TaskPriority || (exports.TaskPriority = {}));
556
+ /** Channels of the ticket. */
557
+ var TicketChannels;
558
+ (function (TicketChannels) {
559
+ TicketChannels["Email"] = "email";
560
+ TicketChannels["Plug"] = "plug";
561
+ TicketChannels["Slack"] = "slack";
562
+ })(TicketChannels = exports.TicketChannels || (exports.TicketChannels = {}));
530
563
  /** Severity of the ticket. */
531
564
  var TicketSeverity;
532
565
  (function (TicketSeverity) {
@@ -926,6 +959,42 @@ class Api extends HttpClient {
926
959
  * @secure
927
960
  */
928
961
  this.updateArticle = (data, params = {}) => this.request(Object.assign({ path: `/articles.update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
962
+ /**
963
+ * @description Gets the requested artifact's information.
964
+ *
965
+ * @tags artifacts
966
+ * @name ArtifactsGet
967
+ * @request GET:/artifacts.get
968
+ * @secure
969
+ */
970
+ this.artifactsGet = (query, params = {}) => this.request(Object.assign({ path: `/artifacts.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
971
+ /**
972
+ * @description Gets the requested artifact's information.
973
+ *
974
+ * @tags artifacts
975
+ * @name ArtifactsGetPost
976
+ * @request POST:/artifacts.get
977
+ * @secure
978
+ */
979
+ this.artifactsGetPost = (data, params = {}) => this.request(Object.assign({ path: `/artifacts.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
980
+ /**
981
+ * @description List the artifacts attached to an object.
982
+ *
983
+ * @tags artifacts
984
+ * @name ArtifactsList
985
+ * @request GET:/artifacts.list
986
+ * @secure
987
+ */
988
+ this.artifactsList = (query, params = {}) => this.request(Object.assign({ path: `/artifacts.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
989
+ /**
990
+ * @description List the artifacts attached to an object.
991
+ *
992
+ * @tags artifacts
993
+ * @name ArtifactsListPost
994
+ * @request POST:/artifacts.list
995
+ * @secure
996
+ */
997
+ this.artifactsListPost = (data, params = {}) => this.request(Object.assign({ path: `/artifacts.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
929
998
  /**
930
999
  * @description Gets the download URL for the artifact.
931
1000
  *
@@ -1970,6 +2039,42 @@ class Api extends HttpClient {
1970
2039
  * @secure
1971
2040
  */
1972
2041
  this.customSchemaFragmentsSet = (data, params = {}) => this.request(Object.assign({ path: `/schemas.custom.set`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
2042
+ /**
2043
+ * @description Gets a stock schema fragment.
2044
+ *
2045
+ * @tags customization
2046
+ * @name StockSchemaFragmentsGet
2047
+ * @request GET:/schemas.stock.get
2048
+ * @secure
2049
+ */
2050
+ this.stockSchemaFragmentsGet = (query, params = {}) => this.request(Object.assign({ path: `/schemas.stock.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
2051
+ /**
2052
+ * @description Gets a stock schema fragment.
2053
+ *
2054
+ * @tags customization
2055
+ * @name StockSchemaFragmentsGetPost
2056
+ * @request POST:/schemas.stock.get
2057
+ * @secure
2058
+ */
2059
+ this.stockSchemaFragmentsGetPost = (data, params = {}) => this.request(Object.assign({ path: `/schemas.stock.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
2060
+ /**
2061
+ * @description Lists stock schema fragments.
2062
+ *
2063
+ * @tags customization
2064
+ * @name StockSchemaFragmentsList
2065
+ * @request GET:/schemas.stock.list
2066
+ * @secure
2067
+ */
2068
+ this.stockSchemaFragmentsList = (query, params = {}) => this.request(Object.assign({ path: `/schemas.stock.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
2069
+ /**
2070
+ * @description Lists stock schema fragments.
2071
+ *
2072
+ * @tags customization
2073
+ * @name StockSchemaFragmentsListPost
2074
+ * @request POST:/schemas.stock.list
2075
+ * @secure
2076
+ */
2077
+ this.stockSchemaFragmentsListPost = (data, params = {}) => this.request(Object.assign({ path: `/schemas.stock.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
1973
2078
  /**
1974
2079
  * @description Lists subtypes.
1975
2080
  *
@@ -14,8 +14,63 @@ export type Account = OrgBase & {
14
14
  /** The Tier of the corresponding Account. */
15
15
  tier?: string;
16
16
  };
17
+ /** artifact */
18
+ export type Artifact = AtomBase;
17
19
  /** artifact-summary */
18
20
  export type ArtifactSummary = AtomBaseSummary;
21
+ /**
22
+ * artifact-version
23
+ * The version of the artifact.
24
+ */
25
+ export interface ArtifactVersion {
26
+ modified_by?: UserSummary;
27
+ /**
28
+ * The timestamp at which the version was created.
29
+ * @format date-time
30
+ * @example "2023-01-01T12:00:00.000Z"
31
+ */
32
+ timestamp: string;
33
+ /** The version of the artifact. */
34
+ version: string;
35
+ }
36
+ /**
37
+ * artifacts-get-request
38
+ * The request to get an artifact's information.
39
+ */
40
+ export interface ArtifactsGetRequest {
41
+ /**
42
+ * The requested artifact's ID.
43
+ * @example "ARTIFACT-12345"
44
+ */
45
+ id: string;
46
+ /** The version of the artifact that needs to be fetched. */
47
+ version?: string;
48
+ }
49
+ /**
50
+ * artifacts-get-response
51
+ * The response to getting an artifact's information.
52
+ */
53
+ export interface ArtifactsGetResponse {
54
+ artifact: Artifact;
55
+ /** The version of the artifact. */
56
+ version: ArtifactVersion;
57
+ }
58
+ /**
59
+ * artifacts-list-request
60
+ * The request to list artifacts attached to an object.
61
+ */
62
+ export interface ArtifactsListRequest {
63
+ /** The ID of the object to filter artifacts. */
64
+ parent_id: string;
65
+ }
66
+ /**
67
+ * artifacts-list-response
68
+ * The response to list artifacts attached to an object.
69
+ */
70
+ export interface ArtifactsListResponse {
71
+ /** The artifact's information. */
72
+ artifacts: Artifact[];
73
+ }
19
74
  /**
20
75
  * artifacts-locate-request
21
76
  * The request to get an artifact's download URL.
@@ -822,11 +877,16 @@ export type Enhancement = PartBase;
822
877
  /** enhancement-summary */
823
878
  export type EnhancementSummary = PartBaseSummary;
824
879
  /** error-bad-request */
825
- export type ErrorBadRequest = ErrorBase & (ErrorBadRequestBadRequest | ErrorBadRequestInvalidEnumValue | ErrorBadRequestInvalidField | ErrorBadRequestMissingDependency | ErrorBadRequestMissingRequiredField | ErrorBadRequestParseError | ErrorBadRequestValueNotPermitted) & {
880
+ export type ErrorBadRequest = ErrorBase & (ErrorBadRequestBadRequest | ErrorBadRequestInvalidApiVersion | ErrorBadRequestInvalidEnumValue | ErrorBadRequestInvalidField | ErrorBadRequestMissingDependency | ErrorBadRequestMissingRequiredField | ErrorBadRequestParseError | ErrorBadRequestStaleSchemaFragments | ErrorBadRequestValueNotPermitted) & {
826
881
  type: ErrorBadRequestType;
827
882
  };
828
883
  /** error-bad-request-bad-request */
829
884
  export type ErrorBadRequestBadRequest = object;
885
+ /** error-bad-request-invalid-api-version */
886
+ export interface ErrorBadRequestInvalidApiVersion {
887
+ /** The provided API version. */
888
+ value: string;
889
+ }
830
890
  /** error-bad-request-invalid-enum-value */
831
891
  export interface ErrorBadRequestInvalidEnumValue {
832
892
  /** The allowed values for the field. */
@@ -859,13 +919,24 @@ export interface ErrorBadRequestMissingRequiredField {
859
919
  }
860
920
  /** error-bad-request-parse-error */
861
921
  export type ErrorBadRequestParseError = object;
922
+ /**
923
+ * error-bad-request-stale-schema-fragments
924
+ * Error indicating that the request contained one or more stale schema
925
+ * fragments, which are schema fragments that have been replaced by a
926
+ * newer version and are therefore considered deprecated schema fragments.
927
+ * The caller should refresh and use the latest schema fragments in their
928
+ * request.
929
+ */
930
+ export type ErrorBadRequestStaleSchemaFragments = object;
862
931
  export declare enum ErrorBadRequestType {
863
932
  BadRequest = "bad_request",
933
+ InvalidApiVersion = "invalid_api_version",
864
934
  InvalidEnumValue = "invalid_enum_value",
865
935
  InvalidField = "invalid_field",
866
936
  MissingDependency = "missing_dependency",
867
937
  MissingRequiredField = "missing_required_field",
868
938
  ParseError = "parse_error",
939
+ StaleSchemaFragments = "stale_schema_fragments",
869
940
  ValueNotPermitted = "value_not_permitted"
870
941
  }
871
942
  /** error-bad-request-value-not-permitted */
@@ -1647,6 +1718,8 @@ export interface SetTagWithValue {
1647
1718
  export interface SlaSummaryFilter {
1648
1719
  /** Filters for records with any of the provided SLA stages. */
1649
1720
  stage?: SlaSummaryStage[];
1721
+ /** Provides ways to specify date ranges on objects. */
1722
+ target_time?: DateFilter;
1650
1723
  }
1651
1724
  /**
1652
1725
  * The stage of the SLA. This is the metric stage which is closest to
@@ -1871,6 +1944,8 @@ export interface TagsUpdateResponse {
1871
1944
  }
1872
1945
  /** ticket */
1873
1946
  export type Ticket = WorkBase & {
1947
+ /** Channels of the ticket. */
1948
+ channels?: TicketChannels[];
1874
1949
  group?: GroupSummary;
1875
1950
  rev_org?: OrgSummary;
1876
1951
  /** Severity of the ticket. */
@@ -1878,6 +1953,12 @@ export type Ticket = WorkBase & {
1878
1953
  /** Source channel of the ticket. */
1879
1954
  source_channel?: string;
1880
1955
  };
1956
+ /** Channels of the ticket. */
1957
+ export declare enum TicketChannels {
1958
+ Email = "email",
1959
+ Plug = "plug",
1960
+ Slack = "slack"
1961
+ }
1881
1962
  /** Severity of the ticket. */
1882
1963
  export declare enum TicketSeverity {
1883
1964
  Blocker = "blocker",
@@ -2574,6 +2655,8 @@ export interface WorksCreateRequestIssue {
2574
2655
  }
2575
2656
  /** works-create-request-ticket */
2576
2657
  export interface WorksCreateRequestTicket {
2658
+ /** Channels of the ticket. */
2659
+ channels?: TicketChannels[];
2577
2660
  /** The group that the ticket is associated with. */
2578
2661
  group?: string;
2579
2662
  /** Whether the ticket is spam. */
@@ -2632,6 +2715,11 @@ export interface WorksExportRequest {
2632
2715
  * @example ["DEVU-12345"]
2633
2716
  */
2634
2717
  owned_by?: string[];
2718
+ /**
2719
+ * Filters for work reported by any of these users.
2720
+ * @example ["DEVU-12345"]
2721
+ */
2722
+ reported_by?: string[];
2635
2723
  /** The filter for stages. */
2636
2724
  stage?: StageFilter;
2637
2725
  /**
@@ -2669,6 +2757,8 @@ export interface WorksFilterIssue {
2669
2757
  }
2670
2758
  /** works-filter-ticket */
2671
2759
  export interface WorksFilterTicket {
2760
+ /** Filters for tickets with any of the provided channels. */
2761
+ channels?: TicketChannels[];
2672
2762
  /** Filters for tickets belonging to specific groups. */
2673
2763
  group?: string[];
2674
2764
  /** Filters for tickets that are spam. */
@@ -2744,6 +2834,11 @@ export interface WorksListRequest {
2744
2834
  * @example ["DEVU-12345"]
2745
2835
  */
2746
2836
  owned_by?: string[];
2837
+ /**
2838
+ * Filters for work reported by any of these users.
2839
+ * @example ["DEVU-12345"]
2840
+ */
2841
+ reported_by?: string[];
2747
2842
  /** The filter for stages. */
2748
2843
  stage?: StageFilter;
2749
2844
  /**
@@ -2862,6 +2957,7 @@ export interface WorksUpdateRequestTags {
2862
2957
  }
2863
2958
  /** works-update-request-ticket */
2864
2959
  export interface WorksUpdateRequestTicket {
2960
+ channels?: WorksUpdateRequestTicketChannels;
2865
2961
  /** Updates the group that the ticket is associated with. */
2866
2962
  group?: string | null;
2867
2963
  /** Updates whether the ticket is spam. */
@@ -2874,6 +2970,11 @@ export interface WorksUpdateRequestTicket {
2874
2970
  /** Severity of the ticket. */
2875
2971
  severity?: TicketSeverity;
2876
2972
  }
2973
+ /** works-update-request-ticket-channels */
2974
+ export interface WorksUpdateRequestTicketChannels {
2975
+ /** Sets the channels to the provided channels. */
2976
+ set?: TicketChannels[];
2977
+ }
2877
2978
  /** works-update-response */
2878
2979
  export interface WorksUpdateResponse {
2879
2980
  work: Work;
@@ -2927,6 +3028,53 @@ export declare class HttpClient<SecurityDataType = unknown> {
2927
3028
  * DevRev's REST API.
2928
3029
  */
2929
3030
  export declare class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDataType> {
3031
+ /**
3032
+ * @description Gets the requested artifact's information.
3033
+ *
3034
+ * @tags artifacts
3035
+ * @name ArtifactsGet
3036
+ * @request GET:/artifacts.get
3037
+ * @secure
3038
+ */
3039
+ artifactsGet: (query: {
3040
+ /**
3041
+ * The requested artifact's ID.
3042
+ * @example "ARTIFACT-12345"
3043
+ */
3044
+ id: string;
3045
+ /** The version of the artifact that needs to be fetched. */
3046
+ version?: string;
3047
+ }, params?: RequestParams) => Promise<AxiosResponse<ArtifactsGetResponse, any>>;
3048
+ /**
3049
+ * @description Gets the requested artifact's information.
3050
+ *
3051
+ * @tags artifacts
3052
+ * @name ArtifactsGetPost
3053
+ * @request POST:/artifacts.get
3054
+ * @secure
3055
+ */
3056
+ artifactsGetPost: (data: ArtifactsGetRequest, params?: RequestParams) => Promise<AxiosResponse<ArtifactsGetResponse, any>>;
3057
+ /**
3058
+ * @description List the artifacts attached to an object.
3059
+ *
3060
+ * @tags artifacts
3061
+ * @name ArtifactsList
3062
+ * @request GET:/artifacts.list
3063
+ * @secure
3064
+ */
3065
+ artifactsList: (query: {
3066
+ /** The ID of the object to filter artifacts. */
3067
+ parent_id: string;
3068
+ }, params?: RequestParams) => Promise<AxiosResponse<ArtifactsListResponse, any>>;
3069
+ /**
3070
+ * @description List the artifacts attached to an object.
3071
+ *
3072
+ * @tags artifacts
3073
+ * @name ArtifactsListPost
3074
+ * @request POST:/artifacts.list
3075
+ * @secure
3076
+ */
3077
+ artifactsListPost: (data: ArtifactsListRequest, params?: RequestParams) => Promise<AxiosResponse<ArtifactsListResponse, any>>;
2930
3078
  /**
2931
3079
  * @description Gets the download URL for the artifact.
2932
3080
  *
@@ -3767,6 +3915,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
3767
3915
  * @example ["DEVU-12345"]
3768
3916
  */
3769
3917
  owned_by?: string[];
3918
+ /**
3919
+ * Filters for work reported by any of these users.
3920
+ * @example ["DEVU-12345"]
3921
+ */
3922
+ reported_by?: string[];
3770
3923
  /** Filters for records in the provided stage(s) by name. */
3771
3924
  'stage.name'?: string[];
3772
3925
  /**
@@ -3774,6 +3927,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
3774
3927
  * @example ["TAG-12345"]
3775
3928
  */
3776
3929
  tags?: string[];
3930
+ /** Filters for tickets with any of the provided channels. */
3931
+ 'ticket.channels'?: TicketChannels[];
3777
3932
  /** Filters for tickets belonging to specific groups. */
3778
3933
  'ticket.group'?: string[];
3779
3934
  /** Filters for tickets that are spam. */
@@ -3881,6 +4036,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
3881
4036
  * @example ["DEVU-12345"]
3882
4037
  */
3883
4038
  owned_by?: string[];
4039
+ /**
4040
+ * Filters for work reported by any of these users.
4041
+ * @example ["DEVU-12345"]
4042
+ */
4043
+ reported_by?: string[];
3884
4044
  /** Filters for records in the provided stage(s) by name. */
3885
4045
  'stage.name'?: string[];
3886
4046
  /**
@@ -3888,6 +4048,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
3888
4048
  * @example ["TAG-12345"]
3889
4049
  */
3890
4050
  tags?: string[];
4051
+ /** Filters for tickets with any of the provided channels. */
4052
+ 'ticket.channels'?: TicketChannels[];
3891
4053
  /** Filters for tickets belonging to specific groups. */
3892
4054
  'ticket.group'?: string[];
3893
4055
  /** Filters for tickets that are spam. */
@@ -33,7 +33,7 @@ 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.WebhooksUpdateAction = exports.WebhookStatus = exports.WebhookEventType = exports.UserType = exports.UserState = exports.TimelineEntryVisibility = exports.TimelineEntryType = exports.TimelineEntryObjectType = exports.TimelineEntriesUpdateRequestType = exports.TimelineEntriesCreateRequestType = exports.TimelineCommentBodyType = exports.TicketSeverity = exports.SlaSummaryStage = exports.PartType = exports.OrgType = exports.OrgEnvironment = exports.ListMode = exports.IssuePriority = exports.ErrorUnauthorizedType = exports.ErrorTooManyRequestsType = exports.ErrorServiceUnavailableType = exports.ErrorNotFoundType = exports.ErrorInternalServerErrorType = exports.ErrorForbiddenType = exports.ErrorBadRequestType = exports.DevOrgAuthConnectionsUpdateRequestType = exports.DevOrgAuthConnectionsCreateRequestType = exports.DateTimePresetType = exports.DateFilterType = exports.AuthTokenTokenType = exports.AuthTokenSubjectTokenType = exports.AuthTokenStatus = exports.AuthTokenRequestedTokenType = exports.AuthTokenGrantType = exports.AuthConnectionType = exports.AuthConnectionToggle = void 0;
36
+ exports.Api = exports.HttpClient = exports.ContentType = exports.WorkType = exports.WebhooksUpdateAction = exports.WebhookStatus = exports.WebhookEventType = exports.UserType = exports.UserState = exports.TimelineEntryVisibility = exports.TimelineEntryType = exports.TimelineEntryObjectType = exports.TimelineEntriesUpdateRequestType = exports.TimelineEntriesCreateRequestType = exports.TimelineCommentBodyType = exports.TicketSeverity = exports.TicketChannels = exports.SlaSummaryStage = exports.PartType = exports.OrgType = exports.OrgEnvironment = exports.ListMode = exports.IssuePriority = exports.ErrorUnauthorizedType = exports.ErrorTooManyRequestsType = exports.ErrorServiceUnavailableType = exports.ErrorNotFoundType = exports.ErrorInternalServerErrorType = exports.ErrorForbiddenType = exports.ErrorBadRequestType = exports.DevOrgAuthConnectionsUpdateRequestType = exports.DevOrgAuthConnectionsCreateRequestType = exports.DateTimePresetType = exports.DateFilterType = exports.AuthTokenTokenType = exports.AuthTokenSubjectTokenType = exports.AuthTokenStatus = exports.AuthTokenRequestedTokenType = exports.AuthTokenGrantType = exports.AuthConnectionType = exports.AuthConnectionToggle = void 0;
37
37
  var AuthConnectionToggle;
38
38
  (function (AuthConnectionToggle) {
39
39
  AuthConnectionToggle["Disable"] = "disable";
@@ -139,11 +139,13 @@ var DevOrgAuthConnectionsUpdateRequestType;
139
139
  var ErrorBadRequestType;
140
140
  (function (ErrorBadRequestType) {
141
141
  ErrorBadRequestType["BadRequest"] = "bad_request";
142
+ ErrorBadRequestType["InvalidApiVersion"] = "invalid_api_version";
142
143
  ErrorBadRequestType["InvalidEnumValue"] = "invalid_enum_value";
143
144
  ErrorBadRequestType["InvalidField"] = "invalid_field";
144
145
  ErrorBadRequestType["MissingDependency"] = "missing_dependency";
145
146
  ErrorBadRequestType["MissingRequiredField"] = "missing_required_field";
146
147
  ErrorBadRequestType["ParseError"] = "parse_error";
148
+ ErrorBadRequestType["StaleSchemaFragments"] = "stale_schema_fragments";
147
149
  ErrorBadRequestType["ValueNotPermitted"] = "value_not_permitted";
148
150
  })(ErrorBadRequestType = exports.ErrorBadRequestType || (exports.ErrorBadRequestType = {}));
149
151
  var ErrorForbiddenType;
@@ -220,6 +222,13 @@ var SlaSummaryStage;
220
222
  SlaSummaryStage["Running"] = "running";
221
223
  SlaSummaryStage["Warning"] = "warning";
222
224
  })(SlaSummaryStage = exports.SlaSummaryStage || (exports.SlaSummaryStage = {}));
225
+ /** Channels of the ticket. */
226
+ var TicketChannels;
227
+ (function (TicketChannels) {
228
+ TicketChannels["Email"] = "email";
229
+ TicketChannels["Plug"] = "plug";
230
+ TicketChannels["Slack"] = "slack";
231
+ })(TicketChannels = exports.TicketChannels || (exports.TicketChannels = {}));
223
232
  /** Severity of the ticket. */
224
233
  var TicketSeverity;
225
234
  (function (TicketSeverity) {
@@ -425,6 +434,42 @@ exports.HttpClient = HttpClient;
425
434
  class Api extends HttpClient {
426
435
  constructor() {
427
436
  super(...arguments);
437
+ /**
438
+ * @description Gets the requested artifact's information.
439
+ *
440
+ * @tags artifacts
441
+ * @name ArtifactsGet
442
+ * @request GET:/artifacts.get
443
+ * @secure
444
+ */
445
+ this.artifactsGet = (query, params = {}) => this.request(Object.assign({ path: `/artifacts.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
446
+ /**
447
+ * @description Gets the requested artifact's information.
448
+ *
449
+ * @tags artifacts
450
+ * @name ArtifactsGetPost
451
+ * @request POST:/artifacts.get
452
+ * @secure
453
+ */
454
+ this.artifactsGetPost = (data, params = {}) => this.request(Object.assign({ path: `/artifacts.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
455
+ /**
456
+ * @description List the artifacts attached to an object.
457
+ *
458
+ * @tags artifacts
459
+ * @name ArtifactsList
460
+ * @request GET:/artifacts.list
461
+ * @secure
462
+ */
463
+ this.artifactsList = (query, params = {}) => this.request(Object.assign({ path: `/artifacts.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
464
+ /**
465
+ * @description List the artifacts attached to an object.
466
+ *
467
+ * @tags artifacts
468
+ * @name ArtifactsListPost
469
+ * @request POST:/artifacts.list
470
+ * @secure
471
+ */
472
+ this.artifactsListPost = (data, params = {}) => this.request(Object.assign({ path: `/artifacts.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
428
473
  /**
429
474
  * @description Gets the download URL for the artifact.
430
475
  *
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@devrev/typescript-sdk",
3
- "version": "1.1.22",
3
+ "version": "1.1.23",
4
4
  "description": "## SDK Generation",
5
5
  "main": "./dist/index.js",
6
6
  "scripts": {
@@ -39,6 +39,7 @@
39
39
  "rimraf": "^4.1.2",
40
40
  "ts-jest": "^29.0.5",
41
41
  "ts-node": "^10.9.1",
42
+ "typedoc": "^0.25.9",
42
43
  "typescript": "^4.9.5"
43
44
  },
44
45
  "dependencies": {