@devrev/typescript-sdk 1.1.17 → 1.1.19

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.
@@ -106,6 +106,8 @@ export interface AccountsExportRequest {
106
106
  /** Filters for accounts created by the specified user(s). */
107
107
  created_by?: string[];
108
108
  created_date?: DateTimeFilter;
109
+ /** Filters for custom fields. */
110
+ custom_fields?: object;
109
111
  /** Domains for accounts to be filtered. */
110
112
  domains?: string[];
111
113
  /** Array of references of accounts to be filtered. */
@@ -166,6 +168,8 @@ export interface AccountsListRequest {
166
168
  * iteration starts from the beginning.
167
169
  */
168
170
  cursor?: string;
171
+ /** Filters for custom fields. */
172
+ custom_fields?: object;
169
173
  /** Domains for accounts to be filtered. */
170
174
  domains?: string[];
171
175
  /** Array of references of accounts to be filtered. */
@@ -431,7 +435,7 @@ export interface ArticlesCreateRequest {
431
435
  * The users that own the article.
432
436
  * @example ["DEVU-12345"]
433
437
  */
434
- owned_by?: string[];
438
+ owned_by: string[];
435
439
  /**
436
440
  * The published date of the article.
437
441
  * @format date-time
@@ -754,7 +758,9 @@ export type Conversation = AtomBase & {
754
758
  /** Owner IDs for the conversation. */
755
759
  owned_by?: UserSummary[];
756
760
  /** Describes the current stage of a work item. */
757
- stage?: Stage;
761
+ stage?: LegacyStage;
762
+ /** Tags associated with the object. */
763
+ tags?: TagWithValue[];
758
764
  /** Title of the conversation object. */
759
765
  title?: string;
760
766
  };
@@ -1124,6 +1130,8 @@ export interface CustomSchemaFragmentsListRequest {
1124
1130
  * then iteration starts from the beginning.
1125
1131
  */
1126
1132
  cursor?: string;
1133
+ /** Whether only deprecated fragments should be filtered. */
1134
+ deprecated?: boolean;
1127
1135
  /** The list of leaf types. */
1128
1136
  leaf_type?: string[];
1129
1137
  /**
@@ -1677,6 +1685,19 @@ export interface EventRevUserDeleted {
1677
1685
  export interface EventRevUserUpdated {
1678
1686
  rev_user: RevUser;
1679
1687
  }
1688
+ /** event-sla-tracker-created */
1689
+ export interface EventSlaTrackerCreated {
1690
+ sla_tracker: SlaTracker;
1691
+ }
1692
+ /** event-sla-tracker-deleted */
1693
+ export interface EventSlaTrackerDeleted {
1694
+ /** The ID of the SLA tracker that was deleted. */
1695
+ id: string;
1696
+ }
1697
+ /** event-sla-tracker-updated */
1698
+ export interface EventSlaTrackerUpdated {
1699
+ sla_tracker: SlaTracker;
1700
+ }
1680
1701
  /** event-source */
1681
1702
  export type EventSource = AtomBase & {
1682
1703
  /**
@@ -1972,6 +1993,8 @@ export interface GroupsUpdateResponse {
1972
1993
  }
1973
1994
  /** issue */
1974
1995
  export type Issue = WorkBase & {
1996
+ /** Parts associated based on git events. */
1997
+ developed_with?: PartSummary[];
1975
1998
  /** Priority of the work based upon impact and criticality. */
1976
1999
  priority?: IssuePriority;
1977
2000
  };
@@ -1987,6 +2010,14 @@ export type IssueSummary = WorkBaseSummary & {
1987
2010
  /** Priority of the work based upon impact and criticality. */
1988
2011
  priority?: IssuePriority;
1989
2012
  };
2013
+ /**
2014
+ * legacy-stage
2015
+ * Describes the current stage of a work item.
2016
+ */
2017
+ export interface LegacyStage {
2018
+ /** Current stage name of the work item. */
2019
+ name: string;
2020
+ }
1990
2021
  /** link */
1991
2022
  export type Link = AtomBase & {
1992
2023
  /** Type of link used to define the relationship. */
@@ -2295,7 +2326,7 @@ export interface MetricsData {
2295
2326
  * external_ref=org_customer_1 may resolve to
2296
2327
  * don:identity:dvrv-us-1:devo/0:revo/155.
2297
2328
  */
2298
- org_ref?: string;
2329
+ org_ref: string;
2299
2330
  /** Rev User ID or user ref for which metric is being published. */
2300
2331
  user_ref?: string;
2301
2332
  }
@@ -2976,6 +3007,8 @@ export type RevOrg = OrgBase & {
2976
3007
  * @example "don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"
2977
3008
  */
2978
3009
  stock_schema_fragment?: string;
3010
+ /** Tags associated with an object. */
3011
+ tags?: TagWithValue[];
2979
3012
  };
2980
3013
  /** rev-org-summary */
2981
3014
  export type RevOrgSummary = OrgBaseSummary;
@@ -3016,6 +3049,8 @@ export interface RevOrgsCreateRequest {
3016
3049
  * records.
3017
3050
  */
3018
3051
  external_ref?: string;
3052
+ /** Tags associated with the Rev organization. */
3053
+ tags?: SetTagWithValue[];
3019
3054
  /** The tier of the RevOrg. */
3020
3055
  tier?: string;
3021
3056
  }
@@ -3074,6 +3109,8 @@ export interface RevOrgsListRequest {
3074
3109
  * (custom_field_filter=field_name1:val1,val2,val3&custom_field_filter=field_name2:val1,val2).
3075
3110
  */
3076
3111
  custom_field_filter?: string[];
3112
+ /** Filters for custom fields. */
3113
+ custom_fields?: object;
3077
3114
  /** List of external refs to filter Rev organizations for. */
3078
3115
  external_ref?: string[];
3079
3116
  /**
@@ -3095,6 +3132,8 @@ export interface RevOrgsListRequest {
3095
3132
  * them.
3096
3133
  */
3097
3134
  sort_by?: string[];
3135
+ /** List of tags to be filtered. */
3136
+ tags?: string[];
3098
3137
  }
3099
3138
  /**
3100
3139
  * rev-orgs-list-response
@@ -3149,6 +3188,8 @@ export interface RevOrgsUpdateRequest {
3149
3188
  * @example "REV-AbCdEfGh"
3150
3189
  */
3151
3190
  id: string;
3191
+ /** Tags associated with the Rev organization. */
3192
+ tags?: SetTagWithValue[];
3152
3193
  /** The tier of the RevOrg. */
3153
3194
  tier?: string;
3154
3195
  }
@@ -3196,6 +3237,8 @@ export type RevUser = UserBase & {
3196
3237
  * @example "don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"
3197
3238
  */
3198
3239
  stock_schema_fragment?: string;
3240
+ /** Tags associated with the object. */
3241
+ tags?: TagWithValue[];
3199
3242
  };
3200
3243
  /** rev-user-summary */
3201
3244
  export type RevUserSummary = UserBaseSummary & {
@@ -3247,6 +3290,8 @@ export interface RevUsersCreateRequest {
3247
3290
  * @example "REV-AbCdEfGh"
3248
3291
  */
3249
3292
  rev_org?: string;
3293
+ /** Tags associated with the Rev user. */
3294
+ tags?: SetTagWithValue[];
3250
3295
  }
3251
3296
  /**
3252
3297
  * rev-users-create-response
@@ -3297,6 +3342,8 @@ export interface RevUsersListRequest {
3297
3342
  * iteration starts from the beginning.
3298
3343
  */
3299
3344
  cursor?: string;
3345
+ /** Filters for custom fields. */
3346
+ custom_fields?: object;
3300
3347
  /** List of emails of Rev users to be filtered. */
3301
3348
  email?: string[];
3302
3349
  /** List of external refs to filter Rev users for. */
@@ -3326,6 +3373,8 @@ export interface RevUsersListRequest {
3326
3373
  rev_org?: string[];
3327
3374
  /** Fields to sort the Rev users by and the direction to sort them. */
3328
3375
  sort_by?: string[];
3376
+ /** List of tags to be filtered. */
3377
+ tags?: string[];
3329
3378
  }
3330
3379
  /**
3331
3380
  * rev-users-list-response
@@ -3364,6 +3413,8 @@ export interface RevUsersUpdateRequest {
3364
3413
  external_ref?: string;
3365
3414
  /** The ID of Rev user to update. */
3366
3415
  id: string;
3416
+ /** Tags associated with the Rev user. */
3417
+ tags?: SetTagWithValue[];
3367
3418
  }
3368
3419
  /** rev-users-update-request-artifacts */
3369
3420
  export interface RevUsersUpdateRequestArtifacts {
@@ -3449,11 +3500,11 @@ export type SchemaEnumListFieldDescriptor = SchemaFieldDescriptorBase & {
3449
3500
  * schema-field-descriptor
3450
3501
  * Set of field attributes.
3451
3502
  */
3452
- export type SchemaFieldDescriptor = (SchemaBoolFieldDescriptor | SchemaCompositeFieldDescriptor | SchemaDateFieldDescriptor | SchemaDoubleFieldDescriptor | SchemaEnumFieldDescriptor | SchemaFieldDescriptorArrayType | SchemaIdFieldDescriptor | SchemaIntFieldDescriptor | SchemaRichTextFieldDescriptor | SchemaTextFieldDescriptor | SchemaTimestampFieldDescriptor | SchemaTokensFieldDescriptor) & {
3503
+ export type SchemaFieldDescriptor = (SchemaBoolFieldDescriptor | SchemaCompositeFieldDescriptor | SchemaDateFieldDescriptor | SchemaDoubleFieldDescriptor | SchemaEnumFieldDescriptor | SchemaFieldDescriptorArrayType | SchemaIdFieldDescriptor | SchemaIntFieldDescriptor | SchemaRichTextFieldDescriptor | SchemaTextFieldDescriptor | SchemaTimestampFieldDescriptor | SchemaTokensFieldDescriptor | SchemaUenumFieldDescriptor | SchemaUnknownFieldDescriptor) & {
3453
3504
  field_type: SchemaFieldDescriptorFieldType;
3454
3505
  };
3455
3506
  /** schema-field-descriptor-array-type */
3456
- export type SchemaFieldDescriptorArrayType = (SchemaBoolListFieldDescriptor | SchemaCompositeListFieldDescriptor | SchemaDateListFieldDescriptor | SchemaDoubleListFieldDescriptor | SchemaEnumListFieldDescriptor | SchemaIdListFieldDescriptor | SchemaIntListFieldDescriptor | SchemaRichTextListFieldDescriptor | SchemaTextListFieldDescriptor | SchemaTimestampListFieldDescriptor | SchemaTokensListFieldDescriptor) & {
3507
+ export type SchemaFieldDescriptorArrayType = (SchemaBoolListFieldDescriptor | SchemaCompositeListFieldDescriptor | SchemaDateListFieldDescriptor | SchemaDoubleListFieldDescriptor | SchemaEnumListFieldDescriptor | SchemaIdListFieldDescriptor | SchemaIntListFieldDescriptor | SchemaRichTextListFieldDescriptor | SchemaTextListFieldDescriptor | SchemaTimestampListFieldDescriptor | SchemaTokensListFieldDescriptor | SchemaUenumListFieldDescriptor) & {
3457
3508
  base_type: SchemaFieldDescriptorArrayTypeBaseType;
3458
3509
  /**
3459
3510
  * The maximum array length.
@@ -3477,7 +3528,8 @@ export declare enum SchemaFieldDescriptorArrayTypeBaseType {
3477
3528
  RichText = "rich_text",
3478
3529
  Text = "text",
3479
3530
  Timestamp = "timestamp",
3480
- Tokens = "tokens"
3531
+ Tokens = "tokens",
3532
+ Uenum = "uenum"
3481
3533
  }
3482
3534
  /** schema-field-descriptor-base */
3483
3535
  export interface SchemaFieldDescriptorBase {
@@ -3513,7 +3565,9 @@ export declare enum SchemaFieldDescriptorFieldType {
3513
3565
  RichText = "rich_text",
3514
3566
  Text = "text",
3515
3567
  Timestamp = "timestamp",
3516
- Tokens = "tokens"
3568
+ Tokens = "tokens",
3569
+ Uenum = "uenum",
3570
+ Unknown = "unknown"
3517
3571
  }
3518
3572
  /**
3519
3573
  * schema-field-mfz-metadata
@@ -3773,6 +3827,25 @@ export type SchemaTokensListFieldDescriptor = SchemaFieldDescriptorBase & {
3773
3827
  /** The string suffix. */
3774
3828
  suffix?: string;
3775
3829
  };
3830
+ /** schema-uenum-field-descriptor */
3831
+ export type SchemaUenumFieldDescriptor = SchemaFieldDescriptorBase & {
3832
+ /** Allowed values for the field. */
3833
+ allowed_values: UenumValue[];
3834
+ /**
3835
+ * Default value.
3836
+ * @format int64
3837
+ */
3838
+ default_value?: number;
3839
+ };
3840
+ /** schema-uenum-list-field-descriptor */
3841
+ export type SchemaUenumListFieldDescriptor = SchemaFieldDescriptorBase & {
3842
+ /** Allowed values for the field. */
3843
+ allowed_values: UenumValue[];
3844
+ /** Default value. */
3845
+ default_value?: number[];
3846
+ };
3847
+ /** schema-unknown-field-descriptor */
3848
+ export type SchemaUnknownFieldDescriptor = SchemaFieldDescriptorBase;
3776
3849
  /** service-account */
3777
3850
  export type ServiceAccount = UserBase;
3778
3851
  /** service-account-summary */
@@ -3985,7 +4058,23 @@ export declare enum SlaStatus {
3985
4058
  * sla-summary-filter
3986
4059
  * The filter for SLA summary.
3987
4060
  */
3988
- export type SlaSummaryFilter = object;
4061
+ export interface SlaSummaryFilter {
4062
+ /** Filters for records with any of the provided SLA stages. */
4063
+ stage?: SlaSummaryStage[];
4064
+ }
4065
+ /**
4066
+ * The stage of the SLA. This is the metric stage which is closest to
4067
+ * breach.
4068
+ */
4069
+ export declare enum SlaSummaryStage {
4070
+ Breached = "breached",
4071
+ Completed = "completed",
4072
+ Paused = "paused",
4073
+ Running = "running",
4074
+ Warning = "warning"
4075
+ }
4076
+ /** sla-tracker */
4077
+ export type SlaTracker = AtomBase;
3989
4078
  /** slas-assign-request */
3990
4079
  export interface SlasAssignRequest {
3991
4080
  /**
@@ -4120,14 +4209,6 @@ export interface SlasUpdateRequest {
4120
4209
  export interface SlasUpdateResponse {
4121
4210
  sla: Sla;
4122
4211
  }
4123
- /**
4124
- * stage
4125
- * Describes the current stage of a work item.
4126
- */
4127
- export interface Stage {
4128
- /** Current stage name of the work item. */
4129
- name: string;
4130
- }
4131
4212
  /**
4132
4213
  * stage-filter
4133
4214
  * The filter for stages.
@@ -4417,6 +4498,7 @@ export type TimelineEntriesCreateRequest = TimelineEntriesCreateRequestTimelineC
4417
4498
  export interface TimelineEntriesCreateRequestTimelineComment {
4418
4499
  /**
4419
4500
  * The IDs of the artifacts attached to the comment.
4501
+ * @maxItems 10
4420
4502
  * @example ["ARTIFACT-12345"]
4421
4503
  */
4422
4504
  artifacts?: string[];
@@ -4538,17 +4620,20 @@ export interface TimelineEntriesUpdateRequestTimelineCommentArtifacts {
4538
4620
  * Adds the provided artifacts to the comment. An artifact cannot be
4539
4621
  * added more than once, i.e. nothing is done if the artifact is
4540
4622
  * already attached. Mutually exclusive with `set`.
4623
+ * @maxItems 10
4541
4624
  * @example ["ARTIFACT-12345"]
4542
4625
  */
4543
4626
  add?: string[];
4544
4627
  /**
4545
4628
  * Removes the provided artifacts from the comment. If an artifact is
4546
4629
  * not present, then it's ignored. Mututally exclusive with `set`.
4630
+ * @maxItems 10
4547
4631
  * @example ["ARTIFACT-12345"]
4548
4632
  */
4549
4633
  remove?: string[];
4550
4634
  /**
4551
4635
  * Sets the field to the provided artifacts.
4636
+ * @maxItems 10
4552
4637
  * @example ["ARTIFACT-12345"]
4553
4638
  */
4554
4639
  set?: string[];
@@ -4687,6 +4772,25 @@ export interface TimelineThread {
4687
4772
  */
4688
4773
  total_replies?: number;
4689
4774
  }
4775
+ /** uenum-value */
4776
+ export interface UenumValue {
4777
+ /**
4778
+ * The ID of the enum value.
4779
+ * @format int64
4780
+ */
4781
+ id: number;
4782
+ /** Whether the enum value is deprecated. */
4783
+ is_deprecated?: boolean;
4784
+ /** The label of the enum value. */
4785
+ label: string;
4786
+ /**
4787
+ * The ordinal of the enum value.
4788
+ * @format int64
4789
+ */
4790
+ ordinal: number;
4791
+ /** The tooltip of the enum value. */
4792
+ tooltip?: string;
4793
+ }
4690
4794
  /**
4691
4795
  * unit
4692
4796
  * Unit encapsulates the name of the unit and the type of the unit. For
@@ -4795,7 +4899,7 @@ export interface UomsCreateRequest {
4795
4899
  * UOM.
4796
4900
  * @minLength 1
4797
4901
  * @maxLength 64
4798
- * @maxItems 10
4902
+ * @maxItems 12
4799
4903
  */
4800
4904
  dimensions?: string[];
4801
4905
  /**
@@ -5044,6 +5148,9 @@ export interface WebhookEventRequest {
5044
5148
  rev_user_created?: EventRevUserCreated;
5045
5149
  rev_user_deleted?: EventRevUserDeleted;
5046
5150
  rev_user_updated?: EventRevUserUpdated;
5151
+ sla_tracker_created?: EventSlaTrackerCreated;
5152
+ sla_tracker_deleted?: EventSlaTrackerDeleted;
5153
+ sla_tracker_updated?: EventSlaTrackerUpdated;
5047
5154
  tag_created?: EventTagCreated;
5048
5155
  tag_deleted?: EventTagDeleted;
5049
5156
  tag_updated?: EventTagUpdated;
@@ -5150,7 +5257,7 @@ export type WorkBase = AtomBase & {
5150
5257
  /** Users that reported the work. */
5151
5258
  reported_by?: UserSummary[];
5152
5259
  /** Describes the current stage of a work item. */
5153
- stage?: Stage;
5260
+ stage?: LegacyStage;
5154
5261
  /**
5155
5262
  * Stock schema fragment.
5156
5263
  * @example "don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"
@@ -5227,6 +5334,12 @@ export type WorksCreateRequest = (WorksCreateRequestIssue | WorksCreateRequestOp
5227
5334
  };
5228
5335
  /** works-create-request-issue */
5229
5336
  export interface WorksCreateRequestIssue {
5337
+ /**
5338
+ * The IDs of the parts associated with issue.
5339
+ * @maxItems 8
5340
+ * @example ["PROD-12345"]
5341
+ */
5342
+ developed_with?: string[];
5230
5343
  /** Priority of the work based upon impact and criticality. */
5231
5344
  priority?: IssuePriority;
5232
5345
  /** The sprint that the issue belongs to. */
@@ -5535,11 +5648,21 @@ export interface WorksUpdateRequestArtifactIds {
5535
5648
  }
5536
5649
  /** works-update-request-issue */
5537
5650
  export interface WorksUpdateRequestIssue {
5651
+ developed_with?: WorksUpdateRequestIssueDevelopedWith;
5538
5652
  /** Priority of the work based upon impact and criticality. */
5539
5653
  priority?: IssuePriority;
5540
5654
  /** Updates the sprint that the issue belongs to. */
5541
5655
  sprint?: string | null;
5542
5656
  }
5657
+ /** works-update-request-issue-developed-with */
5658
+ export interface WorksUpdateRequestIssueDevelopedWith {
5659
+ /**
5660
+ * Sets the IDs of the parts associated with issue.
5661
+ * @maxItems 8
5662
+ * @example ["PROD-12345"]
5663
+ */
5664
+ set?: string[];
5665
+ }
5543
5666
  /** works-update-request-opportunity */
5544
5667
  export interface WorksUpdateRequestOpportunity {
5545
5668
  /**
@@ -5714,6 +5837,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
5714
5837
  * @example "2023-01-01T12:00:00.000Z"
5715
5838
  */
5716
5839
  'created_date.before'?: string;
5840
+ /** Filters for custom fields. */
5841
+ custom_fields?: object;
5717
5842
  /** Domains for accounts to be filtered. */
5718
5843
  domains?: string[];
5719
5844
  /** Array of references of accounts to be filtered. */
@@ -5809,6 +5934,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
5809
5934
  * starts from the beginning.
5810
5935
  */
5811
5936
  cursor?: string;
5937
+ /** Filters for custom fields. */
5938
+ custom_fields?: object;
5812
5939
  /** Domains for accounts to be filtered. */
5813
5940
  domains?: string[];
5814
5941
  /** Array of references of accounts to be filtered. */
@@ -5846,71 +5973,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
5846
5973
  /** List of tags to be filtered. */
5847
5974
  tags?: string[];
5848
5975
  }, params?: RequestParams) => Promise<AxiosResponse<AccountsListResponse, any>>;
5849
- /**
5850
- * @description Gets a list of accounts.
5851
- *
5852
- * @tags accounts
5853
- * @name AccountsList
5854
- * @request GET:/accounts.list
5855
- * @secure */
5856
- accountsListPaginator(query?: {
5857
- /** Filters for accounts created by the specified user(s). */
5858
- created_by?: string[];
5859
- /**
5860
- * Filters for objects created after the provided timestamp (inclusive).
5861
- * @format date-time
5862
- * @example "2023-01-01T12:00:00.000Z"
5863
- */
5864
- 'created_date.after'?: string;
5865
- /**
5866
- * Filters for objects created before the provided timestamp
5867
- * (inclusive).
5868
- * @format date-time
5869
- * @example "2023-01-01T12:00:00.000Z"
5870
- */
5871
- 'created_date.before'?: string;
5872
- /**
5873
- * The cursor to resume iteration from. If not provided, then iteration
5874
- * starts from the beginning.
5875
- */
5876
- cursor?: string;
5877
- /** Domains for accounts to be filtered. */
5878
- domains?: string[];
5879
- /** Array of references of accounts to be filtered. */
5880
- external_refs?: string[];
5881
- /**
5882
- * The maximum number of accounts to return per page. The default is
5883
- * '50'.
5884
- * @format int32
5885
- */
5886
- limit?: number;
5887
- /**
5888
- * The iteration mode to use, otherwise if not set, then "after" is
5889
- * used.
5890
- */
5891
- mode?: ListMode;
5892
- /**
5893
- * Filters for objects created after the provided timestamp (inclusive).
5894
- * @format date-time
5895
- * @example "2023-01-01T12:00:00.000Z"
5896
- */
5897
- 'modified_date.after'?: string;
5898
- /**
5899
- * Filters for objects created before the provided timestamp
5900
- * (inclusive).
5901
- * @format date-time
5902
- * @example "2023-01-01T12:00:00.000Z"
5903
- */
5904
- 'modified_date.before'?: string;
5905
- /** Filters for accounts owned by the specified user(s). */
5906
- owned_by?: string[];
5907
- /** Fields to sort the accounts by and the direction to sort them in. */
5908
- sort_by?: string[];
5909
- /** Filters for accounts on specified stages. */
5910
- stage?: string[];
5911
- /** List of tags to be filtered. */
5912
- tags?: string[];
5913
- }, params?: RequestParams): AsyncGenerator<AccountsListResponse, void, unknown>;
5914
5976
  /**
5915
5977
  * @description Gets a list of accounts.
5916
5978
  *
@@ -6055,50 +6117,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
6055
6117
  */
6056
6118
  owned_by?: string[];
6057
6119
  }, params?: RequestParams) => Promise<AxiosResponse<ArticlesListResponse, any>>;
6058
- /**
6059
- * @description Lists a collection of articles.
6060
- *
6061
- * @tags articles
6062
- * @name ListArticles
6063
- * @request GET:/articles.list
6064
- * @secure */
6065
- listArticlesPaginator(query?: {
6066
- /**
6067
- * Filters for articles belonging to any of the provided parts.
6068
- * @example ["PROD-12345"]
6069
- */
6070
- applies_to_parts?: string[];
6071
- /**
6072
- * Filters for articles authored by any of the provided users.
6073
- * @example ["DEVU-12345"]
6074
- */
6075
- authored_by?: string[];
6076
- /**
6077
- * Filters for articles created by any of the provided users.
6078
- * @example ["DEVU-12345"]
6079
- */
6080
- created_by?: string[];
6081
- /**
6082
- * The cursor to resume iteration from. If not provided, then iteration
6083
- * starts from the beginning.
6084
- */
6085
- cursor?: string;
6086
- /**
6087
- * The maximum number of articles to return. The default is '50'.
6088
- * @format int32
6089
- */
6090
- limit?: number;
6091
- /**
6092
- * The iteration mode to use, otherwise if not set, then "after" is
6093
- * used.
6094
- */
6095
- mode?: ListMode;
6096
- /**
6097
- * Filters for articles owned by any of the provided users.
6098
- * @example ["DEVU-12345"]
6099
- */
6100
- owned_by?: string[];
6101
- }, params?: RequestParams): AsyncGenerator<ArticlesListResponse, void, unknown>;
6102
6120
  /**
6103
6121
  * @description Lists a collection of articles.
6104
6122
  *
@@ -6195,6 +6213,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
6195
6213
  * @example ["REV-AbCdEfGh"]
6196
6214
  */
6197
6215
  rev_org?: string[];
6216
+ /** Filters for records with any of the provided SLA stages. */
6217
+ 'sla_summary.stage'?: SlaSummaryStage[];
6198
6218
  /** Filters for conversations with any of the provided source channels. */
6199
6219
  source_channels?: string[];
6200
6220
  /** Filters for records in the provided stage(s) by name. */
@@ -6297,6 +6317,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
6297
6317
  * @example ["REV-AbCdEfGh"]
6298
6318
  */
6299
6319
  rev_org?: string[];
6320
+ /** Filters for records with any of the provided SLA stages. */
6321
+ 'sla_summary.stage'?: SlaSummaryStage[];
6300
6322
  /** Filters for conversations with any of the provided source channels. */
6301
6323
  source_channels?: string[];
6302
6324
  /** Filters for records in the provided stage(s) by name. */
@@ -6318,77 +6340,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
6318
6340
  */
6319
6341
  'tags_v2.value'?: string;
6320
6342
  }, params?: RequestParams) => Promise<AxiosResponse<ConversationsListResponse, any>>;
6321
- /**
6322
- * @description Lists the available conversations.
6323
- *
6324
- * @tags conversations
6325
- * @name ConversationsList
6326
- * @request GET:/conversations.list
6327
- * @secure */
6328
- conversationsListPaginator(query?: {
6329
- /**
6330
- * Filters for conversations belonging to any of the provided parts.
6331
- * @example ["PROD-12345"]
6332
- */
6333
- applies_to_parts?: string[];
6334
- /**
6335
- * The cursor to resume iteration from. If not provided, then iteration
6336
- * starts from the beginning.
6337
- */
6338
- cursor?: string;
6339
- /** Filters for conversation that belong to the given groups. */
6340
- group?: string[];
6341
- /** Filters for conversations that are created by verified users. */
6342
- is_creator_verified?: boolean;
6343
- /** Filters for conversations that are spam. */
6344
- is_spam?: boolean;
6345
- /**
6346
- * The maximum number of conversations to return. The default is '50'.
6347
- * @format int32
6348
- */
6349
- limit?: number;
6350
- /**
6351
- * Filters for conversations where these users are participants.
6352
- * @example ["DEVU-12345"]
6353
- */
6354
- members?: string[];
6355
- /**
6356
- * The iteration mode to use, otherwise if not set, then "after" is
6357
- * used.
6358
- */
6359
- mode?: ListMode;
6360
- /**
6361
- * Filters for conversations owned by any of these users.
6362
- * @example ["DEVU-12345"]
6363
- */
6364
- owned_by?: string[];
6365
- /**
6366
- * Filters for conversations that are associated with any of the
6367
- * provided Rev organizations.
6368
- * @example ["REV-AbCdEfGh"]
6369
- */
6370
- rev_org?: string[];
6371
- /** Filters for conversations with any of the provided source channels. */
6372
- source_channels?: string[];
6373
- /** Filters for records in the provided stage(s) by name. */
6374
- 'stage.name'?: string[];
6375
- /**
6376
- * Filters for conversations with any of the provided tags.
6377
- * @deprecated
6378
- * @example ["TAG-12345"]
6379
- */
6380
- tags?: string[];
6381
- /**
6382
- * The ID of the tag.
6383
- * @example "TAG-12345"
6384
- */
6385
- 'tags_v2.id'?: string;
6386
- /**
6387
- * The value for the object's association with the tag. If specified,
6388
- * the value must be one that's specified in the tag's allowed values.
6389
- */
6390
- 'tags_v2.value'?: string;
6391
- }, params?: RequestParams): AsyncGenerator<ConversationsListResponse, void, unknown>;
6392
6343
  /**
6393
6344
  * @description Lists the available conversations.
6394
6345
  *
@@ -6520,46 +6471,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
6520
6471
  /** Filters for engagement of the provided types. */
6521
6472
  type?: EngagementType[];
6522
6473
  }, params?: RequestParams) => Promise<AxiosResponse<EngagementsListResponse, any>>;
6523
- /**
6524
- * @description Lists the engagement records.
6525
- *
6526
- * @tags engagements
6527
- * @name EngagementsList
6528
- * @request GET:/engagements.list
6529
- * @secure */
6530
- engagementsListPaginator(query?: {
6531
- /**
6532
- * The cursor to resume iteration from. If not provided, then iteration
6533
- * starts from the beginning.
6534
- */
6535
- cursor?: string;
6536
- /** Filters for meetings with the provided external_refs. */
6537
- external_ref?: string[];
6538
- /**
6539
- * The maximum number of engagements to return.
6540
- * @format int32
6541
- */
6542
- limit?: number;
6543
- /**
6544
- * Filters for engagement of the provided members.
6545
- * @example ["DEVU-12345"]
6546
- */
6547
- members?: string[];
6548
- /**
6549
- * The iteration mode to use, otherwise if not set, then "after" is
6550
- * used.
6551
- */
6552
- mode?: ListMode;
6553
- /**
6554
- * Filters for engagements with the provided parent.
6555
- * @example ["ACC-12345"]
6556
- */
6557
- parent?: string[];
6558
- /** Fields to sort the engagements by and the direction to sort them. */
6559
- sort_by?: string[];
6560
- /** Filters for engagement of the provided types. */
6561
- type?: EngagementType[];
6562
- }, params?: RequestParams): AsyncGenerator<EngagementsListResponse, void, unknown>;
6563
6474
  /**
6564
6475
  * @description Lists the engagement records.
6565
6476
  *
@@ -6676,34 +6587,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
6676
6587
  /** Comma-separated fields to sort the groups by. */
6677
6588
  sort_by?: string[];
6678
6589
  }, params?: RequestParams) => Promise<AxiosResponse<GroupsListResponse, any>>;
6679
- /**
6680
- * @description Lists the available groups.
6681
- *
6682
- * @tags groups
6683
- * @name GroupsList
6684
- * @request GET:/groups.list
6685
- * @secure */
6686
- groupsListPaginator(query?: {
6687
- /**
6688
- * The cursor to resume iteration from. If not provided, then iteration
6689
- * starts from the beginning.
6690
- */
6691
- cursor?: string;
6692
- /**
6693
- * The maximum number of groups to return. The default is '50'.
6694
- * @format int32
6695
- */
6696
- limit?: number;
6697
- /** Filters the groups on basis of member type. */
6698
- member_type?: GroupMemberType[];
6699
- /**
6700
- * The iteration mode to use, otherwise if not set, then "after" is
6701
- * used.
6702
- */
6703
- mode?: ListMode;
6704
- /** Comma-separated fields to sort the groups by. */
6705
- sort_by?: string[];
6706
- }, params?: RequestParams): AsyncGenerator<GroupsListResponse, void, unknown>;
6707
6590
  /**
6708
6591
  * @description Lists the available groups.
6709
6592
  *
@@ -6805,49 +6688,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
6805
6688
  */
6806
6689
  types?: LinkType[];
6807
6690
  }, params?: RequestParams) => Promise<AxiosResponse<LinksListResponse, any>>;
6808
- /**
6809
- * @description Lists the available links.
6810
- *
6811
- * @tags links
6812
- * @name LinksList
6813
- * @request GET:/links.list
6814
- * @secure */
6815
- linksListPaginator(query: {
6816
- /** The ID of the object to list the links for. */
6817
- object: string;
6818
- /**
6819
- * The cursor to resume iteration from. If not provided, then iteration
6820
- * starts from the beginning.
6821
- */
6822
- cursor?: string;
6823
- /**
6824
- * The direction of the links to list, otherwise if not present, then
6825
- * links in both directions (source and target) are included.
6826
- */
6827
- direction?: LinksDirection;
6828
- /**
6829
- * The maximum number of links to return. If not set, then the default
6830
- * is '50'.
6831
- * @format int32
6832
- */
6833
- limit?: number;
6834
- /**
6835
- * The link type(s) to filter for, otherwise if not present, all link
6836
- * types are included.
6837
- */
6838
- link_type?: LinkType[];
6839
- /**
6840
- * The iteration mode to use, otherwise if not set, then "after" is
6841
- * used.
6842
- */
6843
- mode?: ListMode;
6844
- /**
6845
- * The link types to filter for, otherwise if not present, all link
6846
- * types are included.
6847
- * @deprecated
6848
- */
6849
- types?: LinkType[];
6850
- }, params?: RequestParams): AsyncGenerator<LinksListResponse, void, unknown>;
6851
6691
  /**
6852
6692
  * @description Lists the available links.
6853
6693
  *
@@ -6886,34 +6726,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
6886
6726
  /** The type of metric definitions sought. */
6887
6727
  type?: MetricDefinitionMetricType[];
6888
6728
  }, params?: RequestParams) => Promise<AxiosResponse<MetricDefinitionsListResponse, any>>;
6889
- /**
6890
- * @description Lists metric definitions matching a filter.
6891
- *
6892
- * @tags slas
6893
- * @name MetricDefinitionsList
6894
- * @request GET:/metric-definitions.list
6895
- * @secure */
6896
- metricDefinitionsListPaginator(query?: {
6897
- /** The type of objects the metric definition applies to. */
6898
- applies_to_type?: MetricDefinitionAppliesTo[];
6899
- /**
6900
- * The cursor to resume iteration from. If not provided, then iteration
6901
- * starts from the beginning.
6902
- */
6903
- cursor?: string;
6904
- /**
6905
- * The maximum number of records to return. The default is '50'.
6906
- * @format int32
6907
- */
6908
- limit?: number;
6909
- /**
6910
- * The iteration mode to use, otherwise if not set, then "after" is
6911
- * used.
6912
- */
6913
- mode?: ListMode;
6914
- /** The type of metric definitions sought. */
6915
- type?: MetricDefinitionMetricType[];
6916
- }, params?: RequestParams): AsyncGenerator<MetricDefinitionsListResponse, void, unknown>;
6917
6729
  /**
6918
6730
  * @description Lists metric definitions matching a filter.
6919
6731
  *
@@ -6926,7 +6738,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
6926
6738
  /**
6927
6739
  * @description Ingest endpoint for DevRev metrics data from clients.
6928
6740
  *
6929
- * @tags telemetry
6741
+ * @tags product-usage
6930
6742
  * @name MetricsDevrevIngest
6931
6743
  * @request POST:/metrics.devrev.ingest
6932
6744
  * @secure
@@ -7031,35 +6843,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
7031
6843
  /** The organization schedule statuses the filter matches. */
7032
6844
  status?: OrgScheduleStatus[];
7033
6845
  }, params?: RequestParams) => Promise<AxiosResponse<OrgSchedulesListResponse, any>>;
7034
- /**
7035
- * @description Gets list of organization schedules.
7036
- *
7037
- * @tags schedules
7038
- * @name OrgSchedulesList
7039
- * @request GET:/org-schedules.list
7040
- * @secure */
7041
- orgSchedulesListPaginator(query?: {
7042
- /** Creator ID the filter matches. */
7043
- created_by_id?: string[];
7044
- /**
7045
- * The cursor to resume iteration from. If not provided, then iteration
7046
- * starts from the beginning.
7047
- */
7048
- cursor?: string;
7049
- /**
7050
- * Max number of organization schedules returned in a page. Default is
7051
- * 50.
7052
- * @format int32
7053
- */
7054
- limit?: number;
7055
- /**
7056
- * The iteration mode to use, otherwise if not set, then "after" is
7057
- * used.
7058
- */
7059
- mode?: ListMode;
7060
- /** The organization schedule statuses the filter matches. */
7061
- status?: OrgScheduleStatus[];
7062
- }, params?: RequestParams): AsyncGenerator<OrgSchedulesListResponse, void, unknown>;
7063
6846
  /**
7064
6847
  * @description Gets list of organization schedules.
7065
6848
  *
@@ -7190,57 +6973,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
7190
6973
  /** Filters for parts of the provided type(s). */
7191
6974
  type?: PartType[];
7192
6975
  }, params?: RequestParams) => Promise<AxiosResponse<PartsListResponse, any>>;
7193
- /**
7194
- * @description Lists a collection of [parts](https://devrev.ai/docs/product/parts).
7195
- *
7196
- * @tags parts
7197
- * @name PartsList
7198
- * @request GET:/parts.list
7199
- * @secure */
7200
- partsListPaginator(query?: {
7201
- /**
7202
- * Filters for parts created by any of these users.
7203
- * @example ["DEVU-12345"]
7204
- */
7205
- created_by?: string[];
7206
- /**
7207
- * The cursor to resume iteration from. If not provided, then iteration
7208
- * starts from the beginning.
7209
- */
7210
- cursor?: string;
7211
- /**
7212
- * The maximum number of parts to return. The default is '50'.
7213
- * @format int32
7214
- */
7215
- limit?: number;
7216
- /**
7217
- * The iteration mode to use, otherwise if not set, then "after" is
7218
- * used.
7219
- */
7220
- mode?: ListMode;
7221
- /** Filters for parts of the provided name(s). */
7222
- name?: string[];
7223
- /**
7224
- * Filters for parts owned by any of these users.
7225
- * @example ["DEVU-12345"]
7226
- */
7227
- owned_by?: string[];
7228
- /**
7229
- * Number of levels to fetch the part hierarchy up to.
7230
- * @format int32
7231
- * @min 1
7232
- */
7233
- 'parent_part.level'?: number;
7234
- /**
7235
- * Part IDs to fetch the hierarchy for. Required if any parent_part.*
7236
- * fields are provided.
7237
- * @minItems 1
7238
- * @example ["PROD-12345"]
7239
- */
7240
- 'parent_part.parts'?: string[];
7241
- /** Filters for parts of the provided type(s). */
7242
- type?: PartType[];
7243
- }, params?: RequestParams): AsyncGenerator<PartsListResponse, void, unknown>;
7244
6976
  /**
7245
6977
  * @description Lists a collection of [parts](https://devrev.ai/docs/product/parts).
7246
6978
  *
@@ -7337,6 +7069,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
7337
7069
  * (custom_field_filter=field_name1:val1,val2,val3&custom_field_filter=field_name2:val1,val2).
7338
7070
  */
7339
7071
  custom_field_filter?: string[];
7072
+ /** Filters for custom fields. */
7073
+ custom_fields?: object;
7340
7074
  /** List of external refs to filter Rev organizations for. */
7341
7075
  external_ref?: string[];
7342
7076
  /**
@@ -7367,76 +7101,9 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
7367
7101
  * them.
7368
7102
  */
7369
7103
  sort_by?: string[];
7104
+ /** List of tags to be filtered. */
7105
+ tags?: string[];
7370
7106
  }, params?: RequestParams) => Promise<AxiosResponse<RevOrgsListResponse, any>>;
7371
- /**
7372
- * @description Gets the list of Rev organizations' information belonging to the authenticated user's Dev Organization which the user is also authorized to access.
7373
- *
7374
- * @tags rev-orgs
7375
- * @name RevOrgsList
7376
- * @request GET:/rev-orgs.list
7377
- * @secure */
7378
- revOrgsListPaginator(query?: {
7379
- /**
7380
- * Filters by account.
7381
- * @example ["ACC-12345"]
7382
- */
7383
- account?: string[];
7384
- /** Filters by creator. */
7385
- created_by?: string[];
7386
- /**
7387
- * Filters for objects created after the provided timestamp (inclusive).
7388
- * @format date-time
7389
- * @example "2023-01-01T12:00:00.000Z"
7390
- */
7391
- 'created_date.after'?: string;
7392
- /**
7393
- * Filters for objects created before the provided timestamp
7394
- * (inclusive).
7395
- * @format date-time
7396
- * @example "2023-01-01T12:00:00.000Z"
7397
- */
7398
- 'created_date.before'?: string;
7399
- /**
7400
- * The cursor to resume iteration from. If not provided, then iteration
7401
- * starts from the beginning.
7402
- */
7403
- cursor?: string;
7404
- /**
7405
- * Filters on custom fields. Input will be of the format
7406
- * (custom_field_filter=field_name1:val1,val2,val3&custom_field_filter=field_name2:val1,val2).
7407
- */
7408
- custom_field_filter?: string[];
7409
- /** List of external refs to filter Rev organizations for. */
7410
- external_ref?: string[];
7411
- /**
7412
- * The maximum number of Rev organizations to be retrieved per page.
7413
- * @format int32
7414
- */
7415
- limit?: number;
7416
- /**
7417
- * The iteration mode to use, otherwise if not set, then "after" is
7418
- * used.
7419
- */
7420
- mode?: ListMode;
7421
- /**
7422
- * Filters for objects created after the provided timestamp (inclusive).
7423
- * @format date-time
7424
- * @example "2023-01-01T12:00:00.000Z"
7425
- */
7426
- 'modified_date.after'?: string;
7427
- /**
7428
- * Filters for objects created before the provided timestamp
7429
- * (inclusive).
7430
- * @format date-time
7431
- * @example "2023-01-01T12:00:00.000Z"
7432
- */
7433
- 'modified_date.before'?: string;
7434
- /**
7435
- * Fields to sort the Rev organizations by and the direction to sort
7436
- * them.
7437
- */
7438
- sort_by?: string[];
7439
- }, params?: RequestParams): AsyncGenerator<RevOrgsListResponse, void, unknown>;
7440
7107
  /**
7441
7108
  * @description Gets the list of Rev organizations' information belonging to the authenticated user's Dev Organization which the user is also authorized to access.
7442
7109
  *
@@ -7499,86 +7166,19 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
7499
7166
  *
7500
7167
  * @tags rev-users
7501
7168
  * @name LinkRevUserToRevOrg
7502
- * @request POST:/rev-users.link
7503
- * @secure
7504
- */
7505
- linkRevUserToRevOrg: (data: LinkRevUserToRevOrgRequest, params?: RequestParams) => Promise<AxiosResponse<LinkRevUserToRevOrgResponse, any>>;
7506
- /**
7507
- * @description Returns a list of all Rev Users belonging to the authenticated user's Dev Organization.
7508
- *
7509
- * @tags rev-users
7510
- * @name RevUsersList
7511
- * @request GET:/rev-users.list
7512
- * @secure
7513
- */
7514
- revUsersList: (query?: {
7515
- /** Filters for Rev users that were created by the specified user(s). */
7516
- created_by?: string[];
7517
- /**
7518
- * Filters for objects created after the provided timestamp (inclusive).
7519
- * @format date-time
7520
- * @example "2023-01-01T12:00:00.000Z"
7521
- */
7522
- 'created_date.after'?: string;
7523
- /**
7524
- * Filters for objects created before the provided timestamp
7525
- * (inclusive).
7526
- * @format date-time
7527
- * @example "2023-01-01T12:00:00.000Z"
7528
- */
7529
- 'created_date.before'?: string;
7530
- /**
7531
- * The cursor to resume iteration from. If not provided, then iteration
7532
- * starts from the beginning.
7533
- */
7534
- cursor?: string;
7535
- /** List of emails of Rev users to be filtered. */
7536
- email?: string[];
7537
- /** List of external refs to filter Rev users for. */
7538
- external_ref?: string[];
7539
- /** Value of is_verified field to filter the Rev users. */
7540
- is_verified?: boolean;
7541
- /**
7542
- * The maximum number of Rev users to return. The default is '50'.
7543
- * @format int32
7544
- */
7545
- limit?: number;
7546
- /**
7547
- * The iteration mode to use, otherwise if not set, then "after" is
7548
- * used.
7549
- */
7550
- mode?: ListMode;
7551
- /**
7552
- * Filters for objects created after the provided timestamp (inclusive).
7553
- * @format date-time
7554
- * @example "2023-01-01T12:00:00.000Z"
7555
- */
7556
- 'modified_date.after'?: string;
7557
- /**
7558
- * Filters for objects created before the provided timestamp
7559
- * (inclusive).
7560
- * @format date-time
7561
- * @example "2023-01-01T12:00:00.000Z"
7562
- */
7563
- 'modified_date.before'?: string;
7564
- /** List of phone numbers to filter Rev users on. */
7565
- phone_numbers?: string[];
7566
- /**
7567
- * List of IDs of Rev organizations to be filtered.
7568
- * @example ["REV-AbCdEfGh"]
7569
- */
7570
- rev_org?: string[];
7571
- /** Fields to sort the Rev users by and the direction to sort them. */
7572
- sort_by?: string[];
7573
- }, params?: RequestParams) => Promise<AxiosResponse<RevUsersListResponse, any>>;
7169
+ * @request POST:/rev-users.link
7170
+ * @secure
7171
+ */
7172
+ linkRevUserToRevOrg: (data: LinkRevUserToRevOrgRequest, params?: RequestParams) => Promise<AxiosResponse<LinkRevUserToRevOrgResponse, any>>;
7574
7173
  /**
7575
7174
  * @description Returns a list of all Rev Users belonging to the authenticated user's Dev Organization.
7576
7175
  *
7577
7176
  * @tags rev-users
7578
7177
  * @name RevUsersList
7579
7178
  * @request GET:/rev-users.list
7580
- * @secure */
7581
- revUsersListPaginator(query?: {
7179
+ * @secure
7180
+ */
7181
+ revUsersList: (query?: {
7582
7182
  /** Filters for Rev users that were created by the specified user(s). */
7583
7183
  created_by?: string[];
7584
7184
  /**
@@ -7599,6 +7199,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
7599
7199
  * starts from the beginning.
7600
7200
  */
7601
7201
  cursor?: string;
7202
+ /** Filters for custom fields. */
7203
+ custom_fields?: object;
7602
7204
  /** List of emails of Rev users to be filtered. */
7603
7205
  email?: string[];
7604
7206
  /** List of external refs to filter Rev users for. */
@@ -7637,7 +7239,9 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
7637
7239
  rev_org?: string[];
7638
7240
  /** Fields to sort the Rev users by and the direction to sort them. */
7639
7241
  sort_by?: string[];
7640
- }, params?: RequestParams): AsyncGenerator<RevUsersListResponse, void, unknown>;
7242
+ /** List of tags to be filtered. */
7243
+ tags?: string[];
7244
+ }, params?: RequestParams) => Promise<AxiosResponse<RevUsersListResponse, any>>;
7641
7245
  /**
7642
7246
  * @description Returns a list of all Rev Users belonging to the authenticated user's Dev Organization.
7643
7247
  *
@@ -7725,6 +7329,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
7725
7329
  * iteration starts from the beginning.
7726
7330
  */
7727
7331
  cursor?: string;
7332
+ /** Whether only deprecated fragments should be filtered. */
7333
+ deprecated?: boolean;
7728
7334
  /** The list of leaf types. */
7729
7335
  leaf_type?: string[];
7730
7336
  /**
@@ -7739,35 +7345,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
7739
7345
  /** Filters for custom schema fragment of the provided types. */
7740
7346
  types?: CustomSchemaFragmentType[];
7741
7347
  }, params?: RequestParams) => Promise<AxiosResponse<CustomSchemaFragmentsListResponse, any>>;
7742
- /**
7743
- * @description Lists custom schema fragments.
7744
- *
7745
- * @tags customization
7746
- * @name CustomSchemaFragmentsList
7747
- * @request GET:/schemas.custom.list
7748
- * @secure */
7749
- customSchemaFragmentsListPaginator(query?: {
7750
- /** The list of app names. */
7751
- app?: string[];
7752
- /**
7753
- * The cursor to resume iteration from, otherwise if not provided, then
7754
- * iteration starts from the beginning.
7755
- */
7756
- cursor?: string;
7757
- /** The list of leaf types. */
7758
- leaf_type?: string[];
7759
- /**
7760
- * The maximum number of items.
7761
- * @format int32
7762
- */
7763
- limit?: number;
7764
- /** The list of fields to sort the items by and how to sort them. */
7765
- sort_by?: string[];
7766
- /** The list of subtypes. */
7767
- subtype?: string[];
7768
- /** Filters for custom schema fragment of the provided types. */
7769
- types?: CustomSchemaFragmentType[];
7770
- }, params?: RequestParams): AsyncGenerator<CustomSchemaFragmentsListResponse, void, unknown>;
7771
7348
  /**
7772
7349
  * @description Lists custom schema fragments.
7773
7350
  *
@@ -7899,32 +7476,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
7899
7476
  /** The SLA statuses the filter matches. */
7900
7477
  status?: SlaStatus[];
7901
7478
  }, params?: RequestParams) => Promise<AxiosResponse<SlasListResponse, any>>;
7902
- /**
7903
- * @description Lists SLAs matching a filter.
7904
- *
7905
- * @tags slas
7906
- * @name SlasList
7907
- * @request GET:/slas.list
7908
- * @secure */
7909
- slasListPaginator(query?: {
7910
- /**
7911
- * The cursor to resume iteration from. If not provided, then iteration
7912
- * starts from the beginning.
7913
- */
7914
- cursor?: string;
7915
- /**
7916
- * The maximum number of SLAs to return. The default is '50'.
7917
- * @format int32
7918
- */
7919
- limit?: number;
7920
- /**
7921
- * The iteration mode to use, otherwise if not set, then "after" is
7922
- * used.
7923
- */
7924
- mode?: ListMode;
7925
- /** The SLA statuses the filter matches. */
7926
- status?: SlaStatus[];
7927
- }, params?: RequestParams): AsyncGenerator<SlasListResponse, void, unknown>;
7928
7479
  /**
7929
7480
  * @description Lists SLAs matching a filter.
7930
7481
  *
@@ -7980,33 +7531,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
7980
7531
  /** Fields to sort the system users by and the direction to sort them. */
7981
7532
  sort_by?: string[];
7982
7533
  }, params?: RequestParams) => Promise<AxiosResponse<SysUsersListResponse, any>>;
7983
- /**
7984
- * @description Lists system users within your organization.
7985
- *
7986
- * @tags sys-users
7987
- * @name SysUsersList
7988
- * @request GET:/sys-users.list
7989
- * @secure */
7990
- sysUsersListPaginator(query?: {
7991
- /**
7992
- * The cursor to resume iteration from. If not provided, then iteration
7993
- * starts from the beginning.
7994
- */
7995
- cursor?: string;
7996
- /**
7997
- * The maximum number of system users to return. Value can range from
7998
- * '1' to '100', with a default of '50'.
7999
- * @format int32
8000
- */
8001
- limit?: number;
8002
- /**
8003
- * The iteration mode to use, otherwise if not set, then "after" is
8004
- * used.
8005
- */
8006
- mode?: ListMode;
8007
- /** Fields to sort the system users by and the direction to sort them. */
8008
- sort_by?: string[];
8009
- }, params?: RequestParams): AsyncGenerator<SysUsersListResponse, void, unknown>;
8010
7534
  /**
8011
7535
  * @description Lists system users within your organization.
8012
7536
  *
@@ -8083,54 +7607,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
8083
7607
  */
8084
7608
  visibility?: TimelineEntryVisibility[];
8085
7609
  }, params?: RequestParams) => Promise<AxiosResponse<TimelineEntriesListResponse, any>>;
8086
- /**
8087
- * @description Lists the timeline entries for an object.
8088
- *
8089
- * @tags timeline-entries
8090
- * @name TimelineEntriesList
8091
- * @request GET:/timeline-entries.list
8092
- * @secure */
8093
- timelineEntriesListPaginator(query: {
8094
- /**
8095
- * The ID of the object to list timeline entries for.
8096
- * @example "PROD-12345"
8097
- */
8098
- object: string;
8099
- /**
8100
- * The collection(s) to list entries from, otherwise if not provided,
8101
- * all entries are returned.
8102
- */
8103
- collections?: TimelineEntriesCollection[];
8104
- /**
8105
- * The cursor to resume iteration from. If not provided, then iteration
8106
- * starts from the beginning.
8107
- */
8108
- cursor?: string;
8109
- /**
8110
- * Filters for entries containing at least one of the provided labels,
8111
- * otherwise if no labels are provided, then no label filtering is done.
8112
- * @minLength 1
8113
- * @maxLength 64
8114
- */
8115
- labels?: string[];
8116
- /**
8117
- * The maximum number of entries to return. If not set, then this
8118
- * defaults to `50`.
8119
- * @format int32
8120
- */
8121
- limit?: number;
8122
- /**
8123
- * The iteration mode to use, otherwise if not set, then "after" is
8124
- * used.
8125
- */
8126
- mode?: ListMode;
8127
- /**
8128
- * The visibility of the timeline entries to filter for. Note this is a
8129
- * strict filter, such that only entries with the exact visibilities
8130
- * specified will be returned.
8131
- */
8132
- visibility?: TimelineEntryVisibility[];
8133
- }, params?: RequestParams): AsyncGenerator<TimelineEntriesListResponse, void, unknown>;
8134
7610
  /**
8135
7611
  * @description Lists the timeline entries for an object.
8136
7612
  *
@@ -8152,7 +7628,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
8152
7628
  /**
8153
7629
  * @description Creates a Unit of Measurement on a part.
8154
7630
  *
8155
- * @tags commerce
7631
+ * @tags product-usage
8156
7632
  * @name UomsCreate
8157
7633
  * @request POST:/uoms.create
8158
7634
  * @secure
@@ -8161,7 +7637,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
8161
7637
  /**
8162
7638
  * @description Deletes a Unit of Measurement.
8163
7639
  *
8164
- * @tags commerce
7640
+ * @tags product-usage
8165
7641
  * @name UomsDelete
8166
7642
  * @request POST:/uoms.delete
8167
7643
  * @secure
@@ -8170,7 +7646,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
8170
7646
  /**
8171
7647
  * @description Gets a Unit of Measurement.
8172
7648
  *
8173
- * @tags commerce
7649
+ * @tags product-usage
8174
7650
  * @name UomsGet
8175
7651
  * @request GET:/uoms.get
8176
7652
  * @secure
@@ -8182,7 +7658,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
8182
7658
  /**
8183
7659
  * @description Gets a Unit of Measurement.
8184
7660
  *
8185
- * @tags commerce
7661
+ * @tags product-usage
8186
7662
  * @name UomsGetPost
8187
7663
  * @request POST:/uoms.get
8188
7664
  * @secure
@@ -8191,7 +7667,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
8191
7667
  /**
8192
7668
  * @description Gets the Unit of Measurements based on the given filters.
8193
7669
  *
8194
- * @tags commerce
7670
+ * @tags product-usage
8195
7671
  * @name UomsList
8196
7672
  * @request GET:/uoms.list
8197
7673
  * @secure
@@ -8243,58 +7719,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
8243
7719
  /**
8244
7720
  * @description Gets the Unit of Measurements based on the given filters.
8245
7721
  *
8246
- * @tags commerce
8247
- * @name UomsList
8248
- * @request GET:/uoms.list
8249
- * @secure */
8250
- uomsListPaginator(query?: {
8251
- /** List of aggregation types for filtering list of UOMs. */
8252
- aggregation_types?: AggregationDetailAggregationType[];
8253
- /**
8254
- * The cursor to resume iteration from. If not provided, then iteration
8255
- * starts from the beginning.
8256
- */
8257
- cursor?: string;
8258
- /**
8259
- * List of Unit of Measurement (UOM) DONs to be used in filtering
8260
- * complete list of UOMs defined in a Dev Org.
8261
- */
8262
- ids?: string[];
8263
- /**
8264
- * The maximum number of UOMs to be returned in a response. The default
8265
- * is '50'.
8266
- * @format int32
8267
- */
8268
- limit?: number;
8269
- /** List of metric names for filtering list of UOMs. */
8270
- metric_names?: string[];
8271
- /**
8272
- * The iteration mode to use, otherwise if not set, then "after" is
8273
- * used.
8274
- */
8275
- mode?: ListMode;
8276
- /**
8277
- * List of part IDs for filtering list of UOMs.
8278
- * @example ["PROD-12345"]
8279
- */
8280
- part_ids?: string[];
8281
- /**
8282
- * List of product IDs for filtering list of UOMs.
8283
- * @example ["PROD-12345"]
8284
- */
8285
- product_ids?: string[];
8286
- /**
8287
- * Fields to sort the Unit Of Measuments (UOMs) by and the direction to
8288
- * sort them.
8289
- */
8290
- sort_by?: string[];
8291
- /** List of unit types for filtering list of UOMs. */
8292
- unit_types?: UnitType[];
8293
- }, params?: RequestParams): AsyncGenerator<UomsListResponse, void, unknown>;
8294
- /**
8295
- * @description Gets the Unit of Measurements based on the given filters.
8296
- *
8297
- * @tags commerce
7722
+ * @tags product-usage
8298
7723
  * @name UomsListPost
8299
7724
  * @request POST:/uoms.list
8300
7725
  * @secure
@@ -8303,7 +7728,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
8303
7728
  /**
8304
7729
  * @description Updates a Unit of Measurement.
8305
7730
  *
8306
- * @tags commerce
7731
+ * @tags product-usage
8307
7732
  * @name UomsUpdate
8308
7733
  * @request POST:/uoms.update
8309
7734
  * @secure
@@ -8396,6 +7821,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
8396
7821
  'ticket.rev_org'?: string[];
8397
7822
  /** Filters for tickets with any of the provided severities. */
8398
7823
  'ticket.severity'?: TicketSeverity[];
7824
+ /** Filters for records with any of the provided SLA stages. */
7825
+ 'ticket.sla_summary.stage'?: SlaSummaryStage[];
8399
7826
  /** Filters for tickets with any of the provided source channels. */
8400
7827
  'ticket.source_channel'?: string[];
8401
7828
  /** Filters for work of the provided types. */
@@ -8512,93 +7939,13 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
8512
7939
  'ticket.rev_org'?: string[];
8513
7940
  /** Filters for tickets with any of the provided severities. */
8514
7941
  'ticket.severity'?: TicketSeverity[];
7942
+ /** Filters for records with any of the provided SLA stages. */
7943
+ 'ticket.sla_summary.stage'?: SlaSummaryStage[];
8515
7944
  /** Filters for tickets with any of the provided source channels. */
8516
7945
  'ticket.source_channel'?: string[];
8517
7946
  /** Filters for work of the provided types. */
8518
7947
  type?: WorkType[];
8519
7948
  }, params?: RequestParams) => Promise<AxiosResponse<WorksListResponse, any>>;
8520
- /**
8521
- * @description Lists a collection of work items.
8522
- *
8523
- * @tags works
8524
- * @name WorksList
8525
- * @request GET:/works.list
8526
- * @secure */
8527
- worksListPaginator(query?: {
8528
- /**
8529
- * Filters for work belonging to any of the provided parts.
8530
- * @example ["PROD-12345"]
8531
- */
8532
- applies_to_part?: string[];
8533
- /**
8534
- * Filters for work created by any of these users.
8535
- * @example ["DEVU-12345"]
8536
- */
8537
- created_by?: string[];
8538
- /**
8539
- * The cursor to resume iteration from. If not provided, then iteration
8540
- * starts from the beginning.
8541
- */
8542
- cursor?: string;
8543
- /** Filters for custom fields. */
8544
- custom_fields?: object;
8545
- /** Filters for issues with any of the provided priorities. */
8546
- 'issue.priority'?: IssuePriority[];
8547
- /**
8548
- * Filters for issues with any of the provided Rev organizations.
8549
- * @example ["REV-AbCdEfGh"]
8550
- */
8551
- 'issue.rev_orgs'?: string[];
8552
- /**
8553
- * The maximum number of works to return. The default is '50'.
8554
- * @format int32
8555
- */
8556
- limit?: number;
8557
- /**
8558
- * The iteration mode to use, otherwise if not set, then "after" is
8559
- * used.
8560
- */
8561
- mode?: ListMode;
8562
- /**
8563
- * Filters for opportunities belonging to any of the provided accounts.
8564
- * @example ["ACC-12345"]
8565
- */
8566
- 'opportunity.account'?: string[];
8567
- /** Filters for opportunities with any of the provided contacts. */
8568
- 'opportunity.contacts'?: string[];
8569
- /**
8570
- * Filters for work owned by any of these users.
8571
- * @example ["DEVU-12345"]
8572
- */
8573
- owned_by?: string[];
8574
- /** Fields to sort the works by and the direction to sort them. */
8575
- sort_by?: string[];
8576
- /** Filters for records in the provided stage(s) by name. */
8577
- 'stage.name'?: string[];
8578
- /**
8579
- * Filters for work with any of the provided tags.
8580
- * @example ["TAG-12345"]
8581
- */
8582
- tags?: string[];
8583
- /** Filters for tickets belonging to specific groups. */
8584
- 'ticket.group'?: string[];
8585
- /** Filters for tickets that are spam. */
8586
- 'ticket.is_spam'?: boolean;
8587
- /** Filters for tickets that need response. */
8588
- 'ticket.needs_response'?: boolean;
8589
- /**
8590
- * Filters for tickets that are associated with any of the provided Rev
8591
- * organizations.
8592
- * @example ["REV-AbCdEfGh"]
8593
- */
8594
- 'ticket.rev_org'?: string[];
8595
- /** Filters for tickets with any of the provided severities. */
8596
- 'ticket.severity'?: TicketSeverity[];
8597
- /** Filters for tickets with any of the provided source channels. */
8598
- 'ticket.source_channel'?: string[];
8599
- /** Filters for work of the provided types. */
8600
- type?: WorkType[];
8601
- }, params?: RequestParams): AsyncGenerator<WorksListResponse, void, unknown>;
8602
7949
  /**
8603
7950
  * @description Lists a collection of work items.
8604
7951
  *