@devrev/typescript-sdk 1.1.17 → 1.1.18
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
|
|
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?:
|
|
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
|
/**
|
|
@@ -1987,6 +2008,14 @@ export type IssueSummary = WorkBaseSummary & {
|
|
|
1987
2008
|
/** Priority of the work based upon impact and criticality. */
|
|
1988
2009
|
priority?: IssuePriority;
|
|
1989
2010
|
};
|
|
2011
|
+
/**
|
|
2012
|
+
* legacy-stage
|
|
2013
|
+
* Describes the current stage of a work item.
|
|
2014
|
+
*/
|
|
2015
|
+
export interface LegacyStage {
|
|
2016
|
+
/** Current stage name of the work item. */
|
|
2017
|
+
name: string;
|
|
2018
|
+
}
|
|
1990
2019
|
/** link */
|
|
1991
2020
|
export type Link = AtomBase & {
|
|
1992
2021
|
/** Type of link used to define the relationship. */
|
|
@@ -2295,7 +2324,7 @@ export interface MetricsData {
|
|
|
2295
2324
|
* external_ref=org_customer_1 may resolve to
|
|
2296
2325
|
* don:identity:dvrv-us-1:devo/0:revo/155.
|
|
2297
2326
|
*/
|
|
2298
|
-
org_ref
|
|
2327
|
+
org_ref: string;
|
|
2299
2328
|
/** Rev User ID or user ref for which metric is being published. */
|
|
2300
2329
|
user_ref?: string;
|
|
2301
2330
|
}
|
|
@@ -2976,6 +3005,8 @@ export type RevOrg = OrgBase & {
|
|
|
2976
3005
|
* @example "don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"
|
|
2977
3006
|
*/
|
|
2978
3007
|
stock_schema_fragment?: string;
|
|
3008
|
+
/** Tags associated with an object. */
|
|
3009
|
+
tags?: TagWithValue[];
|
|
2979
3010
|
};
|
|
2980
3011
|
/** rev-org-summary */
|
|
2981
3012
|
export type RevOrgSummary = OrgBaseSummary;
|
|
@@ -3016,6 +3047,8 @@ export interface RevOrgsCreateRequest {
|
|
|
3016
3047
|
* records.
|
|
3017
3048
|
*/
|
|
3018
3049
|
external_ref?: string;
|
|
3050
|
+
/** Tags associated with the Rev organization. */
|
|
3051
|
+
tags?: SetTagWithValue[];
|
|
3019
3052
|
/** The tier of the RevOrg. */
|
|
3020
3053
|
tier?: string;
|
|
3021
3054
|
}
|
|
@@ -3074,6 +3107,8 @@ export interface RevOrgsListRequest {
|
|
|
3074
3107
|
* (custom_field_filter=field_name1:val1,val2,val3&custom_field_filter=field_name2:val1,val2).
|
|
3075
3108
|
*/
|
|
3076
3109
|
custom_field_filter?: string[];
|
|
3110
|
+
/** Filters for custom fields. */
|
|
3111
|
+
custom_fields?: object;
|
|
3077
3112
|
/** List of external refs to filter Rev organizations for. */
|
|
3078
3113
|
external_ref?: string[];
|
|
3079
3114
|
/**
|
|
@@ -3095,6 +3130,8 @@ export interface RevOrgsListRequest {
|
|
|
3095
3130
|
* them.
|
|
3096
3131
|
*/
|
|
3097
3132
|
sort_by?: string[];
|
|
3133
|
+
/** List of tags to be filtered. */
|
|
3134
|
+
tags?: string[];
|
|
3098
3135
|
}
|
|
3099
3136
|
/**
|
|
3100
3137
|
* rev-orgs-list-response
|
|
@@ -3149,6 +3186,8 @@ export interface RevOrgsUpdateRequest {
|
|
|
3149
3186
|
* @example "REV-AbCdEfGh"
|
|
3150
3187
|
*/
|
|
3151
3188
|
id: string;
|
|
3189
|
+
/** Tags associated with the Rev organization. */
|
|
3190
|
+
tags?: SetTagWithValue[];
|
|
3152
3191
|
/** The tier of the RevOrg. */
|
|
3153
3192
|
tier?: string;
|
|
3154
3193
|
}
|
|
@@ -3196,6 +3235,8 @@ export type RevUser = UserBase & {
|
|
|
3196
3235
|
* @example "don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"
|
|
3197
3236
|
*/
|
|
3198
3237
|
stock_schema_fragment?: string;
|
|
3238
|
+
/** Tags associated with the object. */
|
|
3239
|
+
tags?: TagWithValue[];
|
|
3199
3240
|
};
|
|
3200
3241
|
/** rev-user-summary */
|
|
3201
3242
|
export type RevUserSummary = UserBaseSummary & {
|
|
@@ -3247,6 +3288,8 @@ export interface RevUsersCreateRequest {
|
|
|
3247
3288
|
* @example "REV-AbCdEfGh"
|
|
3248
3289
|
*/
|
|
3249
3290
|
rev_org?: string;
|
|
3291
|
+
/** Tags associated with the Rev user. */
|
|
3292
|
+
tags?: SetTagWithValue[];
|
|
3250
3293
|
}
|
|
3251
3294
|
/**
|
|
3252
3295
|
* rev-users-create-response
|
|
@@ -3297,6 +3340,8 @@ export interface RevUsersListRequest {
|
|
|
3297
3340
|
* iteration starts from the beginning.
|
|
3298
3341
|
*/
|
|
3299
3342
|
cursor?: string;
|
|
3343
|
+
/** Filters for custom fields. */
|
|
3344
|
+
custom_fields?: object;
|
|
3300
3345
|
/** List of emails of Rev users to be filtered. */
|
|
3301
3346
|
email?: string[];
|
|
3302
3347
|
/** List of external refs to filter Rev users for. */
|
|
@@ -3326,6 +3371,8 @@ export interface RevUsersListRequest {
|
|
|
3326
3371
|
rev_org?: string[];
|
|
3327
3372
|
/** Fields to sort the Rev users by and the direction to sort them. */
|
|
3328
3373
|
sort_by?: string[];
|
|
3374
|
+
/** List of tags to be filtered. */
|
|
3375
|
+
tags?: string[];
|
|
3329
3376
|
}
|
|
3330
3377
|
/**
|
|
3331
3378
|
* rev-users-list-response
|
|
@@ -3364,6 +3411,8 @@ export interface RevUsersUpdateRequest {
|
|
|
3364
3411
|
external_ref?: string;
|
|
3365
3412
|
/** The ID of Rev user to update. */
|
|
3366
3413
|
id: string;
|
|
3414
|
+
/** Tags associated with the Rev user. */
|
|
3415
|
+
tags?: SetTagWithValue[];
|
|
3367
3416
|
}
|
|
3368
3417
|
/** rev-users-update-request-artifacts */
|
|
3369
3418
|
export interface RevUsersUpdateRequestArtifacts {
|
|
@@ -3449,11 +3498,11 @@ export type SchemaEnumListFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
|
3449
3498
|
* schema-field-descriptor
|
|
3450
3499
|
* Set of field attributes.
|
|
3451
3500
|
*/
|
|
3452
|
-
export type SchemaFieldDescriptor = (SchemaBoolFieldDescriptor | SchemaCompositeFieldDescriptor | SchemaDateFieldDescriptor | SchemaDoubleFieldDescriptor | SchemaEnumFieldDescriptor | SchemaFieldDescriptorArrayType | SchemaIdFieldDescriptor | SchemaIntFieldDescriptor | SchemaRichTextFieldDescriptor | SchemaTextFieldDescriptor | SchemaTimestampFieldDescriptor | SchemaTokensFieldDescriptor) & {
|
|
3501
|
+
export type SchemaFieldDescriptor = (SchemaBoolFieldDescriptor | SchemaCompositeFieldDescriptor | SchemaDateFieldDescriptor | SchemaDoubleFieldDescriptor | SchemaEnumFieldDescriptor | SchemaFieldDescriptorArrayType | SchemaIdFieldDescriptor | SchemaIntFieldDescriptor | SchemaRichTextFieldDescriptor | SchemaTextFieldDescriptor | SchemaTimestampFieldDescriptor | SchemaTokensFieldDescriptor | SchemaUenumFieldDescriptor | SchemaUnknownFieldDescriptor) & {
|
|
3453
3502
|
field_type: SchemaFieldDescriptorFieldType;
|
|
3454
3503
|
};
|
|
3455
3504
|
/** schema-field-descriptor-array-type */
|
|
3456
|
-
export type SchemaFieldDescriptorArrayType = (SchemaBoolListFieldDescriptor | SchemaCompositeListFieldDescriptor | SchemaDateListFieldDescriptor | SchemaDoubleListFieldDescriptor | SchemaEnumListFieldDescriptor | SchemaIdListFieldDescriptor | SchemaIntListFieldDescriptor | SchemaRichTextListFieldDescriptor | SchemaTextListFieldDescriptor | SchemaTimestampListFieldDescriptor | SchemaTokensListFieldDescriptor) & {
|
|
3505
|
+
export type SchemaFieldDescriptorArrayType = (SchemaBoolListFieldDescriptor | SchemaCompositeListFieldDescriptor | SchemaDateListFieldDescriptor | SchemaDoubleListFieldDescriptor | SchemaEnumListFieldDescriptor | SchemaIdListFieldDescriptor | SchemaIntListFieldDescriptor | SchemaRichTextListFieldDescriptor | SchemaTextListFieldDescriptor | SchemaTimestampListFieldDescriptor | SchemaTokensListFieldDescriptor | SchemaUenumListFieldDescriptor) & {
|
|
3457
3506
|
base_type: SchemaFieldDescriptorArrayTypeBaseType;
|
|
3458
3507
|
/**
|
|
3459
3508
|
* The maximum array length.
|
|
@@ -3477,7 +3526,8 @@ export declare enum SchemaFieldDescriptorArrayTypeBaseType {
|
|
|
3477
3526
|
RichText = "rich_text",
|
|
3478
3527
|
Text = "text",
|
|
3479
3528
|
Timestamp = "timestamp",
|
|
3480
|
-
Tokens = "tokens"
|
|
3529
|
+
Tokens = "tokens",
|
|
3530
|
+
Uenum = "uenum"
|
|
3481
3531
|
}
|
|
3482
3532
|
/** schema-field-descriptor-base */
|
|
3483
3533
|
export interface SchemaFieldDescriptorBase {
|
|
@@ -3513,7 +3563,9 @@ export declare enum SchemaFieldDescriptorFieldType {
|
|
|
3513
3563
|
RichText = "rich_text",
|
|
3514
3564
|
Text = "text",
|
|
3515
3565
|
Timestamp = "timestamp",
|
|
3516
|
-
Tokens = "tokens"
|
|
3566
|
+
Tokens = "tokens",
|
|
3567
|
+
Uenum = "uenum",
|
|
3568
|
+
Unknown = "unknown"
|
|
3517
3569
|
}
|
|
3518
3570
|
/**
|
|
3519
3571
|
* schema-field-mfz-metadata
|
|
@@ -3773,6 +3825,25 @@ export type SchemaTokensListFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
|
3773
3825
|
/** The string suffix. */
|
|
3774
3826
|
suffix?: string;
|
|
3775
3827
|
};
|
|
3828
|
+
/** schema-uenum-field-descriptor */
|
|
3829
|
+
export type SchemaUenumFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
3830
|
+
/** Allowed values for the field. */
|
|
3831
|
+
allowed_values: UenumValue[];
|
|
3832
|
+
/**
|
|
3833
|
+
* Default value.
|
|
3834
|
+
* @format int64
|
|
3835
|
+
*/
|
|
3836
|
+
default_value?: number;
|
|
3837
|
+
};
|
|
3838
|
+
/** schema-uenum-list-field-descriptor */
|
|
3839
|
+
export type SchemaUenumListFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
3840
|
+
/** Allowed values for the field. */
|
|
3841
|
+
allowed_values: UenumValue[];
|
|
3842
|
+
/** Default value. */
|
|
3843
|
+
default_value?: number[];
|
|
3844
|
+
};
|
|
3845
|
+
/** schema-unknown-field-descriptor */
|
|
3846
|
+
export type SchemaUnknownFieldDescriptor = SchemaFieldDescriptorBase;
|
|
3776
3847
|
/** service-account */
|
|
3777
3848
|
export type ServiceAccount = UserBase;
|
|
3778
3849
|
/** service-account-summary */
|
|
@@ -3985,7 +4056,23 @@ export declare enum SlaStatus {
|
|
|
3985
4056
|
* sla-summary-filter
|
|
3986
4057
|
* The filter for SLA summary.
|
|
3987
4058
|
*/
|
|
3988
|
-
export
|
|
4059
|
+
export interface SlaSummaryFilter {
|
|
4060
|
+
/** Filters for records with any of the provided SLA stages. */
|
|
4061
|
+
stage?: SlaSummaryStage[];
|
|
4062
|
+
}
|
|
4063
|
+
/**
|
|
4064
|
+
* The stage of the SLA. This is the metric stage which is closest to
|
|
4065
|
+
* breach.
|
|
4066
|
+
*/
|
|
4067
|
+
export declare enum SlaSummaryStage {
|
|
4068
|
+
Breached = "breached",
|
|
4069
|
+
Completed = "completed",
|
|
4070
|
+
Paused = "paused",
|
|
4071
|
+
Running = "running",
|
|
4072
|
+
Warning = "warning"
|
|
4073
|
+
}
|
|
4074
|
+
/** sla-tracker */
|
|
4075
|
+
export type SlaTracker = AtomBase;
|
|
3989
4076
|
/** slas-assign-request */
|
|
3990
4077
|
export interface SlasAssignRequest {
|
|
3991
4078
|
/**
|
|
@@ -4120,14 +4207,6 @@ export interface SlasUpdateRequest {
|
|
|
4120
4207
|
export interface SlasUpdateResponse {
|
|
4121
4208
|
sla: Sla;
|
|
4122
4209
|
}
|
|
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
4210
|
/**
|
|
4132
4211
|
* stage-filter
|
|
4133
4212
|
* The filter for stages.
|
|
@@ -4417,6 +4496,7 @@ export type TimelineEntriesCreateRequest = TimelineEntriesCreateRequestTimelineC
|
|
|
4417
4496
|
export interface TimelineEntriesCreateRequestTimelineComment {
|
|
4418
4497
|
/**
|
|
4419
4498
|
* The IDs of the artifacts attached to the comment.
|
|
4499
|
+
* @maxItems 10
|
|
4420
4500
|
* @example ["ARTIFACT-12345"]
|
|
4421
4501
|
*/
|
|
4422
4502
|
artifacts?: string[];
|
|
@@ -4538,17 +4618,20 @@ export interface TimelineEntriesUpdateRequestTimelineCommentArtifacts {
|
|
|
4538
4618
|
* Adds the provided artifacts to the comment. An artifact cannot be
|
|
4539
4619
|
* added more than once, i.e. nothing is done if the artifact is
|
|
4540
4620
|
* already attached. Mutually exclusive with `set`.
|
|
4621
|
+
* @maxItems 10
|
|
4541
4622
|
* @example ["ARTIFACT-12345"]
|
|
4542
4623
|
*/
|
|
4543
4624
|
add?: string[];
|
|
4544
4625
|
/**
|
|
4545
4626
|
* Removes the provided artifacts from the comment. If an artifact is
|
|
4546
4627
|
* not present, then it's ignored. Mututally exclusive with `set`.
|
|
4628
|
+
* @maxItems 10
|
|
4547
4629
|
* @example ["ARTIFACT-12345"]
|
|
4548
4630
|
*/
|
|
4549
4631
|
remove?: string[];
|
|
4550
4632
|
/**
|
|
4551
4633
|
* Sets the field to the provided artifacts.
|
|
4634
|
+
* @maxItems 10
|
|
4552
4635
|
* @example ["ARTIFACT-12345"]
|
|
4553
4636
|
*/
|
|
4554
4637
|
set?: string[];
|
|
@@ -4687,6 +4770,25 @@ export interface TimelineThread {
|
|
|
4687
4770
|
*/
|
|
4688
4771
|
total_replies?: number;
|
|
4689
4772
|
}
|
|
4773
|
+
/** uenum-value */
|
|
4774
|
+
export interface UenumValue {
|
|
4775
|
+
/**
|
|
4776
|
+
* The ID of the enum value.
|
|
4777
|
+
* @format int64
|
|
4778
|
+
*/
|
|
4779
|
+
id: number;
|
|
4780
|
+
/** Whether the enum value is deprecated. */
|
|
4781
|
+
is_deprecated?: boolean;
|
|
4782
|
+
/** The label of the enum value. */
|
|
4783
|
+
label: string;
|
|
4784
|
+
/**
|
|
4785
|
+
* The ordinal of the enum value.
|
|
4786
|
+
* @format int64
|
|
4787
|
+
*/
|
|
4788
|
+
ordinal: number;
|
|
4789
|
+
/** The tooltip of the enum value. */
|
|
4790
|
+
tooltip?: string;
|
|
4791
|
+
}
|
|
4690
4792
|
/**
|
|
4691
4793
|
* unit
|
|
4692
4794
|
* Unit encapsulates the name of the unit and the type of the unit. For
|
|
@@ -4795,7 +4897,7 @@ export interface UomsCreateRequest {
|
|
|
4795
4897
|
* UOM.
|
|
4796
4898
|
* @minLength 1
|
|
4797
4899
|
* @maxLength 64
|
|
4798
|
-
* @maxItems
|
|
4900
|
+
* @maxItems 12
|
|
4799
4901
|
*/
|
|
4800
4902
|
dimensions?: string[];
|
|
4801
4903
|
/**
|
|
@@ -5044,6 +5146,9 @@ export interface WebhookEventRequest {
|
|
|
5044
5146
|
rev_user_created?: EventRevUserCreated;
|
|
5045
5147
|
rev_user_deleted?: EventRevUserDeleted;
|
|
5046
5148
|
rev_user_updated?: EventRevUserUpdated;
|
|
5149
|
+
sla_tracker_created?: EventSlaTrackerCreated;
|
|
5150
|
+
sla_tracker_deleted?: EventSlaTrackerDeleted;
|
|
5151
|
+
sla_tracker_updated?: EventSlaTrackerUpdated;
|
|
5047
5152
|
tag_created?: EventTagCreated;
|
|
5048
5153
|
tag_deleted?: EventTagDeleted;
|
|
5049
5154
|
tag_updated?: EventTagUpdated;
|
|
@@ -5150,7 +5255,7 @@ export type WorkBase = AtomBase & {
|
|
|
5150
5255
|
/** Users that reported the work. */
|
|
5151
5256
|
reported_by?: UserSummary[];
|
|
5152
5257
|
/** Describes the current stage of a work item. */
|
|
5153
|
-
stage?:
|
|
5258
|
+
stage?: LegacyStage;
|
|
5154
5259
|
/**
|
|
5155
5260
|
* Stock schema fragment.
|
|
5156
5261
|
* @example "don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"
|
|
@@ -5227,6 +5332,12 @@ export type WorksCreateRequest = (WorksCreateRequestIssue | WorksCreateRequestOp
|
|
|
5227
5332
|
};
|
|
5228
5333
|
/** works-create-request-issue */
|
|
5229
5334
|
export interface WorksCreateRequestIssue {
|
|
5335
|
+
/**
|
|
5336
|
+
* The IDs of the parts associated with issue.
|
|
5337
|
+
* @maxItems 8
|
|
5338
|
+
* @example ["PROD-12345"]
|
|
5339
|
+
*/
|
|
5340
|
+
developed_with?: string[];
|
|
5230
5341
|
/** Priority of the work based upon impact and criticality. */
|
|
5231
5342
|
priority?: IssuePriority;
|
|
5232
5343
|
/** The sprint that the issue belongs to. */
|
|
@@ -5535,11 +5646,21 @@ export interface WorksUpdateRequestArtifactIds {
|
|
|
5535
5646
|
}
|
|
5536
5647
|
/** works-update-request-issue */
|
|
5537
5648
|
export interface WorksUpdateRequestIssue {
|
|
5649
|
+
developed_with?: WorksUpdateRequestIssueDevelopedWith;
|
|
5538
5650
|
/** Priority of the work based upon impact and criticality. */
|
|
5539
5651
|
priority?: IssuePriority;
|
|
5540
5652
|
/** Updates the sprint that the issue belongs to. */
|
|
5541
5653
|
sprint?: string | null;
|
|
5542
5654
|
}
|
|
5655
|
+
/** works-update-request-issue-developed-with */
|
|
5656
|
+
export interface WorksUpdateRequestIssueDevelopedWith {
|
|
5657
|
+
/**
|
|
5658
|
+
* Sets the IDs of the parts associated with issue.
|
|
5659
|
+
* @maxItems 8
|
|
5660
|
+
* @example ["PROD-12345"]
|
|
5661
|
+
*/
|
|
5662
|
+
set?: string[];
|
|
5663
|
+
}
|
|
5543
5664
|
/** works-update-request-opportunity */
|
|
5544
5665
|
export interface WorksUpdateRequestOpportunity {
|
|
5545
5666
|
/**
|
|
@@ -5714,6 +5835,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
5714
5835
|
* @example "2023-01-01T12:00:00.000Z"
|
|
5715
5836
|
*/
|
|
5716
5837
|
'created_date.before'?: string;
|
|
5838
|
+
/** Filters for custom fields. */
|
|
5839
|
+
custom_fields?: object;
|
|
5717
5840
|
/** Domains for accounts to be filtered. */
|
|
5718
5841
|
domains?: string[];
|
|
5719
5842
|
/** Array of references of accounts to be filtered. */
|
|
@@ -5809,6 +5932,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
5809
5932
|
* starts from the beginning.
|
|
5810
5933
|
*/
|
|
5811
5934
|
cursor?: string;
|
|
5935
|
+
/** Filters for custom fields. */
|
|
5936
|
+
custom_fields?: object;
|
|
5812
5937
|
/** Domains for accounts to be filtered. */
|
|
5813
5938
|
domains?: string[];
|
|
5814
5939
|
/** Array of references of accounts to be filtered. */
|
|
@@ -5846,71 +5971,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
5846
5971
|
/** List of tags to be filtered. */
|
|
5847
5972
|
tags?: string[];
|
|
5848
5973
|
}, 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
5974
|
/**
|
|
5915
5975
|
* @description Gets a list of accounts.
|
|
5916
5976
|
*
|
|
@@ -6055,50 +6115,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6055
6115
|
*/
|
|
6056
6116
|
owned_by?: string[];
|
|
6057
6117
|
}, 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
6118
|
/**
|
|
6103
6119
|
* @description Lists a collection of articles.
|
|
6104
6120
|
*
|
|
@@ -6195,6 +6211,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6195
6211
|
* @example ["REV-AbCdEfGh"]
|
|
6196
6212
|
*/
|
|
6197
6213
|
rev_org?: string[];
|
|
6214
|
+
/** Filters for records with any of the provided SLA stages. */
|
|
6215
|
+
'sla_summary.stage'?: SlaSummaryStage[];
|
|
6198
6216
|
/** Filters for conversations with any of the provided source channels. */
|
|
6199
6217
|
source_channels?: string[];
|
|
6200
6218
|
/** Filters for records in the provided stage(s) by name. */
|
|
@@ -6297,6 +6315,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6297
6315
|
* @example ["REV-AbCdEfGh"]
|
|
6298
6316
|
*/
|
|
6299
6317
|
rev_org?: string[];
|
|
6318
|
+
/** Filters for records with any of the provided SLA stages. */
|
|
6319
|
+
'sla_summary.stage'?: SlaSummaryStage[];
|
|
6300
6320
|
/** Filters for conversations with any of the provided source channels. */
|
|
6301
6321
|
source_channels?: string[];
|
|
6302
6322
|
/** Filters for records in the provided stage(s) by name. */
|
|
@@ -6318,77 +6338,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6318
6338
|
*/
|
|
6319
6339
|
'tags_v2.value'?: string;
|
|
6320
6340
|
}, 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
6341
|
/**
|
|
6393
6342
|
* @description Lists the available conversations.
|
|
6394
6343
|
*
|
|
@@ -6520,46 +6469,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6520
6469
|
/** Filters for engagement of the provided types. */
|
|
6521
6470
|
type?: EngagementType[];
|
|
6522
6471
|
}, 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
6472
|
/**
|
|
6564
6473
|
* @description Lists the engagement records.
|
|
6565
6474
|
*
|
|
@@ -6676,34 +6585,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6676
6585
|
/** Comma-separated fields to sort the groups by. */
|
|
6677
6586
|
sort_by?: string[];
|
|
6678
6587
|
}, 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
6588
|
/**
|
|
6708
6589
|
* @description Lists the available groups.
|
|
6709
6590
|
*
|
|
@@ -6805,49 +6686,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6805
6686
|
*/
|
|
6806
6687
|
types?: LinkType[];
|
|
6807
6688
|
}, 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
6689
|
/**
|
|
6852
6690
|
* @description Lists the available links.
|
|
6853
6691
|
*
|
|
@@ -6886,34 +6724,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6886
6724
|
/** The type of metric definitions sought. */
|
|
6887
6725
|
type?: MetricDefinitionMetricType[];
|
|
6888
6726
|
}, 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
6727
|
/**
|
|
6918
6728
|
* @description Lists metric definitions matching a filter.
|
|
6919
6729
|
*
|
|
@@ -6926,7 +6736,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
6926
6736
|
/**
|
|
6927
6737
|
* @description Ingest endpoint for DevRev metrics data from clients.
|
|
6928
6738
|
*
|
|
6929
|
-
* @tags
|
|
6739
|
+
* @tags product-usage
|
|
6930
6740
|
* @name MetricsDevrevIngest
|
|
6931
6741
|
* @request POST:/metrics.devrev.ingest
|
|
6932
6742
|
* @secure
|
|
@@ -7031,35 +6841,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
7031
6841
|
/** The organization schedule statuses the filter matches. */
|
|
7032
6842
|
status?: OrgScheduleStatus[];
|
|
7033
6843
|
}, 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
6844
|
/**
|
|
7064
6845
|
* @description Gets list of organization schedules.
|
|
7065
6846
|
*
|
|
@@ -7190,57 +6971,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
7190
6971
|
/** Filters for parts of the provided type(s). */
|
|
7191
6972
|
type?: PartType[];
|
|
7192
6973
|
}, 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
6974
|
/**
|
|
7245
6975
|
* @description Lists a collection of [parts](https://devrev.ai/docs/product/parts).
|
|
7246
6976
|
*
|
|
@@ -7337,6 +7067,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
7337
7067
|
* (custom_field_filter=field_name1:val1,val2,val3&custom_field_filter=field_name2:val1,val2).
|
|
7338
7068
|
*/
|
|
7339
7069
|
custom_field_filter?: string[];
|
|
7070
|
+
/** Filters for custom fields. */
|
|
7071
|
+
custom_fields?: object;
|
|
7340
7072
|
/** List of external refs to filter Rev organizations for. */
|
|
7341
7073
|
external_ref?: string[];
|
|
7342
7074
|
/**
|
|
@@ -7367,76 +7099,9 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
7367
7099
|
* them.
|
|
7368
7100
|
*/
|
|
7369
7101
|
sort_by?: string[];
|
|
7102
|
+
/** List of tags to be filtered. */
|
|
7103
|
+
tags?: string[];
|
|
7370
7104
|
}, 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
7105
|
/**
|
|
7441
7106
|
* @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
7107
|
*
|
|
@@ -7499,86 +7164,19 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
7499
7164
|
*
|
|
7500
7165
|
* @tags rev-users
|
|
7501
7166
|
* @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>>;
|
|
7167
|
+
* @request POST:/rev-users.link
|
|
7168
|
+
* @secure
|
|
7169
|
+
*/
|
|
7170
|
+
linkRevUserToRevOrg: (data: LinkRevUserToRevOrgRequest, params?: RequestParams) => Promise<AxiosResponse<LinkRevUserToRevOrgResponse, any>>;
|
|
7574
7171
|
/**
|
|
7575
7172
|
* @description Returns a list of all Rev Users belonging to the authenticated user's Dev Organization.
|
|
7576
7173
|
*
|
|
7577
7174
|
* @tags rev-users
|
|
7578
7175
|
* @name RevUsersList
|
|
7579
7176
|
* @request GET:/rev-users.list
|
|
7580
|
-
* @secure
|
|
7581
|
-
|
|
7177
|
+
* @secure
|
|
7178
|
+
*/
|
|
7179
|
+
revUsersList: (query?: {
|
|
7582
7180
|
/** Filters for Rev users that were created by the specified user(s). */
|
|
7583
7181
|
created_by?: string[];
|
|
7584
7182
|
/**
|
|
@@ -7599,6 +7197,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
7599
7197
|
* starts from the beginning.
|
|
7600
7198
|
*/
|
|
7601
7199
|
cursor?: string;
|
|
7200
|
+
/** Filters for custom fields. */
|
|
7201
|
+
custom_fields?: object;
|
|
7602
7202
|
/** List of emails of Rev users to be filtered. */
|
|
7603
7203
|
email?: string[];
|
|
7604
7204
|
/** List of external refs to filter Rev users for. */
|
|
@@ -7637,7 +7237,9 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
7637
7237
|
rev_org?: string[];
|
|
7638
7238
|
/** Fields to sort the Rev users by and the direction to sort them. */
|
|
7639
7239
|
sort_by?: string[];
|
|
7640
|
-
|
|
7240
|
+
/** List of tags to be filtered. */
|
|
7241
|
+
tags?: string[];
|
|
7242
|
+
}, params?: RequestParams) => Promise<AxiosResponse<RevUsersListResponse, any>>;
|
|
7641
7243
|
/**
|
|
7642
7244
|
* @description Returns a list of all Rev Users belonging to the authenticated user's Dev Organization.
|
|
7643
7245
|
*
|
|
@@ -7725,6 +7327,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
7725
7327
|
* iteration starts from the beginning.
|
|
7726
7328
|
*/
|
|
7727
7329
|
cursor?: string;
|
|
7330
|
+
/** Whether only deprecated fragments should be filtered. */
|
|
7331
|
+
deprecated?: boolean;
|
|
7728
7332
|
/** The list of leaf types. */
|
|
7729
7333
|
leaf_type?: string[];
|
|
7730
7334
|
/**
|
|
@@ -7739,35 +7343,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
7739
7343
|
/** Filters for custom schema fragment of the provided types. */
|
|
7740
7344
|
types?: CustomSchemaFragmentType[];
|
|
7741
7345
|
}, 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
7346
|
/**
|
|
7772
7347
|
* @description Lists custom schema fragments.
|
|
7773
7348
|
*
|
|
@@ -7899,32 +7474,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
7899
7474
|
/** The SLA statuses the filter matches. */
|
|
7900
7475
|
status?: SlaStatus[];
|
|
7901
7476
|
}, 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
7477
|
/**
|
|
7929
7478
|
* @description Lists SLAs matching a filter.
|
|
7930
7479
|
*
|
|
@@ -7980,33 +7529,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
7980
7529
|
/** Fields to sort the system users by and the direction to sort them. */
|
|
7981
7530
|
sort_by?: string[];
|
|
7982
7531
|
}, 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
7532
|
/**
|
|
8011
7533
|
* @description Lists system users within your organization.
|
|
8012
7534
|
*
|
|
@@ -8083,54 +7605,6 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
8083
7605
|
*/
|
|
8084
7606
|
visibility?: TimelineEntryVisibility[];
|
|
8085
7607
|
}, 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
7608
|
/**
|
|
8135
7609
|
* @description Lists the timeline entries for an object.
|
|
8136
7610
|
*
|
|
@@ -8152,7 +7626,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
8152
7626
|
/**
|
|
8153
7627
|
* @description Creates a Unit of Measurement on a part.
|
|
8154
7628
|
*
|
|
8155
|
-
* @tags
|
|
7629
|
+
* @tags product-usage
|
|
8156
7630
|
* @name UomsCreate
|
|
8157
7631
|
* @request POST:/uoms.create
|
|
8158
7632
|
* @secure
|
|
@@ -8161,7 +7635,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
8161
7635
|
/**
|
|
8162
7636
|
* @description Deletes a Unit of Measurement.
|
|
8163
7637
|
*
|
|
8164
|
-
* @tags
|
|
7638
|
+
* @tags product-usage
|
|
8165
7639
|
* @name UomsDelete
|
|
8166
7640
|
* @request POST:/uoms.delete
|
|
8167
7641
|
* @secure
|
|
@@ -8170,7 +7644,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
8170
7644
|
/**
|
|
8171
7645
|
* @description Gets a Unit of Measurement.
|
|
8172
7646
|
*
|
|
8173
|
-
* @tags
|
|
7647
|
+
* @tags product-usage
|
|
8174
7648
|
* @name UomsGet
|
|
8175
7649
|
* @request GET:/uoms.get
|
|
8176
7650
|
* @secure
|
|
@@ -8182,7 +7656,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
8182
7656
|
/**
|
|
8183
7657
|
* @description Gets a Unit of Measurement.
|
|
8184
7658
|
*
|
|
8185
|
-
* @tags
|
|
7659
|
+
* @tags product-usage
|
|
8186
7660
|
* @name UomsGetPost
|
|
8187
7661
|
* @request POST:/uoms.get
|
|
8188
7662
|
* @secure
|
|
@@ -8191,7 +7665,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
8191
7665
|
/**
|
|
8192
7666
|
* @description Gets the Unit of Measurements based on the given filters.
|
|
8193
7667
|
*
|
|
8194
|
-
* @tags
|
|
7668
|
+
* @tags product-usage
|
|
8195
7669
|
* @name UomsList
|
|
8196
7670
|
* @request GET:/uoms.list
|
|
8197
7671
|
* @secure
|
|
@@ -8243,58 +7717,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
8243
7717
|
/**
|
|
8244
7718
|
* @description Gets the Unit of Measurements based on the given filters.
|
|
8245
7719
|
*
|
|
8246
|
-
* @tags
|
|
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
|
|
7720
|
+
* @tags product-usage
|
|
8298
7721
|
* @name UomsListPost
|
|
8299
7722
|
* @request POST:/uoms.list
|
|
8300
7723
|
* @secure
|
|
@@ -8303,7 +7726,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
8303
7726
|
/**
|
|
8304
7727
|
* @description Updates a Unit of Measurement.
|
|
8305
7728
|
*
|
|
8306
|
-
* @tags
|
|
7729
|
+
* @tags product-usage
|
|
8307
7730
|
* @name UomsUpdate
|
|
8308
7731
|
* @request POST:/uoms.update
|
|
8309
7732
|
* @secure
|
|
@@ -8396,6 +7819,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
8396
7819
|
'ticket.rev_org'?: string[];
|
|
8397
7820
|
/** Filters for tickets with any of the provided severities. */
|
|
8398
7821
|
'ticket.severity'?: TicketSeverity[];
|
|
7822
|
+
/** Filters for records with any of the provided SLA stages. */
|
|
7823
|
+
'ticket.sla_summary.stage'?: SlaSummaryStage[];
|
|
8399
7824
|
/** Filters for tickets with any of the provided source channels. */
|
|
8400
7825
|
'ticket.source_channel'?: string[];
|
|
8401
7826
|
/** Filters for work of the provided types. */
|
|
@@ -8512,93 +7937,13 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
8512
7937
|
'ticket.rev_org'?: string[];
|
|
8513
7938
|
/** Filters for tickets with any of the provided severities. */
|
|
8514
7939
|
'ticket.severity'?: TicketSeverity[];
|
|
7940
|
+
/** Filters for records with any of the provided SLA stages. */
|
|
7941
|
+
'ticket.sla_summary.stage'?: SlaSummaryStage[];
|
|
8515
7942
|
/** Filters for tickets with any of the provided source channels. */
|
|
8516
7943
|
'ticket.source_channel'?: string[];
|
|
8517
7944
|
/** Filters for work of the provided types. */
|
|
8518
7945
|
type?: WorkType[];
|
|
8519
7946
|
}, 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
7947
|
/**
|
|
8603
7948
|
* @description Lists a collection of work items.
|
|
8604
7949
|
*
|