@devrev/typescript-sdk 1.1.50 → 1.1.52
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.
- package/README.md +106 -0
- package/dist/auto-generated/beta/beta-devrev-sdk.d.ts +270 -56
- package/dist/auto-generated/beta/beta-devrev-sdk.js +108 -51
- package/dist/auto-generated/public-devrev-sdk.d.ts +2497 -113
- package/dist/auto-generated/public-devrev-sdk.js +535 -12
- package/dist/snap-ins/beta-devrev-sdk-util.d.ts +9 -0
- package/dist/snap-ins/beta-devrev-sdk-util.js +121 -0
- package/dist/snap-ins/constants/error.d.ts +5 -0
- package/dist/snap-ins/constants/error.js +8 -0
- package/dist/snap-ins/constants/util.d.ts +12 -0
- package/dist/snap-ins/constants/util.js +16 -0
- package/dist/snap-ins/error.d.ts +1 -0
- package/dist/snap-ins/error.js +41 -0
- package/dist/snap-ins/util-types.d.ts +13 -0
- package/dist/snap-ins/util-types.js +2 -0
- package/dist/tests/beta-devrev-sdk-util.test.d.ts +1 -0
- package/dist/tests/beta-devrev-sdk-util.test.js +211 -0
- package/dist/tests/error.test.d.ts +1 -0
- package/dist/tests/error.test.js +118 -0
- package/package.json +1 -1
|
@@ -526,6 +526,8 @@ export interface AiAgentEventExecuteProgressSkillTriggered {
|
|
|
526
526
|
* @maxLength 512
|
|
527
527
|
*/
|
|
528
528
|
skill_name: string;
|
|
529
|
+
/** The thought explaining why the skill was called. */
|
|
530
|
+
thought?: string;
|
|
529
531
|
workflow?: WorkflowSummary;
|
|
530
532
|
workflow_run?: WorkflowRunSummary;
|
|
531
533
|
}
|
|
@@ -1151,13 +1153,39 @@ export interface ArticlesUpdateResponse {
|
|
|
1151
1153
|
article: Article;
|
|
1152
1154
|
}
|
|
1153
1155
|
/** artifact */
|
|
1154
|
-
export type Artifact = AtomBase
|
|
1156
|
+
export type Artifact = AtomBase & {
|
|
1157
|
+
/** Defines a file object. */
|
|
1158
|
+
file?: ArtifactFile;
|
|
1159
|
+
};
|
|
1160
|
+
/**
|
|
1161
|
+
* artifact-file
|
|
1162
|
+
* Defines a file object.
|
|
1163
|
+
*/
|
|
1164
|
+
export interface ArtifactFile {
|
|
1165
|
+
/** Type of the file. */
|
|
1166
|
+
type?: string;
|
|
1167
|
+
/** Name of the file. */
|
|
1168
|
+
name?: string;
|
|
1169
|
+
}
|
|
1170
|
+
/**
|
|
1171
|
+
* artifact-file-summary
|
|
1172
|
+
* Defines a file object.
|
|
1173
|
+
*/
|
|
1174
|
+
export interface ArtifactFileSummary {
|
|
1175
|
+
/** Type of the file. */
|
|
1176
|
+
type?: string;
|
|
1177
|
+
/** Name of the file. */
|
|
1178
|
+
name?: string;
|
|
1179
|
+
}
|
|
1155
1180
|
/** artifact-search-summary */
|
|
1156
1181
|
export type ArtifactSearchSummary = SearchSummaryBase & {
|
|
1157
1182
|
artifact: ArtifactSummary;
|
|
1158
1183
|
};
|
|
1159
1184
|
/** artifact-summary */
|
|
1160
|
-
export type ArtifactSummary = AtomBaseSummary
|
|
1185
|
+
export type ArtifactSummary = AtomBaseSummary & {
|
|
1186
|
+
/** Defines a file object. */
|
|
1187
|
+
file?: ArtifactFileSummary;
|
|
1188
|
+
};
|
|
1161
1189
|
/**
|
|
1162
1190
|
* artifact-version
|
|
1163
1191
|
* The version of the artifact.
|
|
@@ -3931,6 +3959,11 @@ export interface DeleteRevUsersPersonalDataRequest {
|
|
|
3931
3959
|
* notified.
|
|
3932
3960
|
*/
|
|
3933
3961
|
export type DeleteRevUsersPersonalDataResponse = object;
|
|
3962
|
+
/** dev-org */
|
|
3963
|
+
export type DevOrg = OrgBase & {
|
|
3964
|
+
/** Customer chosen URL slug for the DevOrg. */
|
|
3965
|
+
dev_slug: string;
|
|
3966
|
+
};
|
|
3934
3967
|
/**
|
|
3935
3968
|
* dev-org-auth-connections-create-request
|
|
3936
3969
|
* Request to create a new enterprise authentication connection.
|
|
@@ -4215,6 +4248,18 @@ export interface DevOrgAuthConnectionsUpdateResponse {
|
|
|
4215
4248
|
*/
|
|
4216
4249
|
auth_connection: AuthConnection;
|
|
4217
4250
|
}
|
|
4251
|
+
/**
|
|
4252
|
+
* dev-orgs-get-request
|
|
4253
|
+
* A request to get a Dev organization's information.
|
|
4254
|
+
*/
|
|
4255
|
+
export type DevOrgsGetRequest = object;
|
|
4256
|
+
/**
|
|
4257
|
+
* dev-orgs-get-response
|
|
4258
|
+
* The response to get a Dev organization's information.
|
|
4259
|
+
*/
|
|
4260
|
+
export interface DevOrgsGetResponse {
|
|
4261
|
+
dev_org: DevOrg;
|
|
4262
|
+
}
|
|
4218
4263
|
/** dev-user */
|
|
4219
4264
|
export type DevUser = UserBase & {
|
|
4220
4265
|
/** Custom fields. */
|
|
@@ -4698,10 +4743,10 @@ export interface DirectoriesUpdateRequest {
|
|
|
4698
4743
|
reorder?: DirectoriesUpdateRequestReorder;
|
|
4699
4744
|
tags?: DirectoriesUpdateRequestTags;
|
|
4700
4745
|
/**
|
|
4701
|
-
*
|
|
4746
|
+
* The updated thumbnail for the directory.
|
|
4702
4747
|
* @example "ARTIFACT-12345"
|
|
4703
4748
|
*/
|
|
4704
|
-
thumbnail?: string;
|
|
4749
|
+
thumbnail?: string | null;
|
|
4705
4750
|
/** The updated title for the directory. */
|
|
4706
4751
|
title?: string;
|
|
4707
4752
|
}
|
|
@@ -5036,7 +5081,32 @@ export interface EngagementsUpdateResponse {
|
|
|
5036
5081
|
engagement: Engagement;
|
|
5037
5082
|
}
|
|
5038
5083
|
/** enhancement */
|
|
5039
|
-
export type Enhancement = PartBase
|
|
5084
|
+
export type Enhancement = PartBase & {
|
|
5085
|
+
/**
|
|
5086
|
+
* Actual close date for the object.
|
|
5087
|
+
* @format date-time
|
|
5088
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
5089
|
+
*/
|
|
5090
|
+
actual_close_date?: string;
|
|
5091
|
+
/**
|
|
5092
|
+
* Actual start date for the object.
|
|
5093
|
+
* @format date-time
|
|
5094
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
5095
|
+
*/
|
|
5096
|
+
actual_start_date?: string;
|
|
5097
|
+
/**
|
|
5098
|
+
* Target close date for the object.
|
|
5099
|
+
* @format date-time
|
|
5100
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
5101
|
+
*/
|
|
5102
|
+
target_close_date?: string;
|
|
5103
|
+
/**
|
|
5104
|
+
* Target start date for the object.
|
|
5105
|
+
* @format date-time
|
|
5106
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
5107
|
+
*/
|
|
5108
|
+
target_start_date?: string;
|
|
5109
|
+
};
|
|
5040
5110
|
/** enhancement-summary */
|
|
5041
5111
|
export type EnhancementSummary = PartBaseSummary;
|
|
5042
5112
|
/**
|
|
@@ -6434,6 +6504,8 @@ export interface IncidentsCreateRequest {
|
|
|
6434
6504
|
source?: number;
|
|
6435
6505
|
/** Create object for stage. */
|
|
6436
6506
|
stage?: CreateStage;
|
|
6507
|
+
/** The type of stage validations options when creating an incident. */
|
|
6508
|
+
stage_validation_options?: StageValidationOptionForCreate[];
|
|
6437
6509
|
/**
|
|
6438
6510
|
* Users, along with the incident commander, involved in resolving
|
|
6439
6511
|
* incidents and handling communication.
|
|
@@ -6741,6 +6813,11 @@ export interface IncidentsUpdateRequest {
|
|
|
6741
6813
|
source?: number;
|
|
6742
6814
|
/** Update object for Stage. */
|
|
6743
6815
|
stage?: UpdateStage;
|
|
6816
|
+
/**
|
|
6817
|
+
* The type of stage validations options when updating the stage of an
|
|
6818
|
+
* incident.
|
|
6819
|
+
*/
|
|
6820
|
+
stage_validation_options?: StageValidationOptionForUpdate[];
|
|
6744
6821
|
stakeholders?: UpdateIncidentStakeholders;
|
|
6745
6822
|
tags?: UpdateIncidentTags;
|
|
6746
6823
|
/**
|
|
@@ -9310,6 +9387,11 @@ export interface RevUsersCreateRequest {
|
|
|
9310
9387
|
description?: string;
|
|
9311
9388
|
/** The user's display name. The name is non-unique and mutable. */
|
|
9312
9389
|
display_name?: string;
|
|
9390
|
+
/**
|
|
9391
|
+
* Artifact ID of a Rev user's display picture.
|
|
9392
|
+
* @example "ARTIFACT-12345"
|
|
9393
|
+
*/
|
|
9394
|
+
display_picture?: string;
|
|
9313
9395
|
/** Email address of the Rev user. */
|
|
9314
9396
|
email?: string;
|
|
9315
9397
|
/**
|
|
@@ -9527,6 +9609,11 @@ export interface RevUsersUpdateRequest {
|
|
|
9527
9609
|
description?: string;
|
|
9528
9610
|
/** Updated display name of the Rev user. */
|
|
9529
9611
|
display_name?: string;
|
|
9612
|
+
/**
|
|
9613
|
+
* Artifact ID of a Rev user's updated display picture.
|
|
9614
|
+
* @example "ARTIFACT-12345"
|
|
9615
|
+
*/
|
|
9616
|
+
display_picture?: string | null;
|
|
9530
9617
|
/** Updated email address of the Rev user. */
|
|
9531
9618
|
email?: string;
|
|
9532
9619
|
/** Updated external ref value of the Rev user. */
|
|
@@ -10304,14 +10391,39 @@ export interface SearchCoreResponse {
|
|
|
10304
10391
|
}
|
|
10305
10392
|
/** The namespaces for hybrid search. */
|
|
10306
10393
|
export declare enum SearchHybridNamespace {
|
|
10394
|
+
Account = "account",
|
|
10307
10395
|
Article = "article",
|
|
10396
|
+
Capability = "capability",
|
|
10397
|
+
Component = "component",
|
|
10308
10398
|
Conversation = "conversation",
|
|
10399
|
+
CustomObject = "custom_object",
|
|
10400
|
+
CustomPart = "custom_part",
|
|
10401
|
+
CustomWork = "custom_work",
|
|
10402
|
+
Dashboard = "dashboard",
|
|
10309
10403
|
Dataset = "dataset",
|
|
10404
|
+
DevUser = "dev_user",
|
|
10405
|
+
Enhancement = "enhancement",
|
|
10406
|
+
Feature = "feature",
|
|
10407
|
+
Group = "group",
|
|
10310
10408
|
Incident = "incident",
|
|
10311
10409
|
Issue = "issue",
|
|
10410
|
+
Linkable = "linkable",
|
|
10411
|
+
Microservice = "microservice",
|
|
10412
|
+
ObjectMember = "object_member",
|
|
10413
|
+
Opportunity = "opportunity",
|
|
10312
10414
|
Part = "part",
|
|
10415
|
+
Product = "product",
|
|
10416
|
+
Project = "project",
|
|
10313
10417
|
QuestionAnswer = "question_answer",
|
|
10418
|
+
RevOrg = "rev_org",
|
|
10419
|
+
RevUser = "rev_user",
|
|
10420
|
+
Runnable = "runnable",
|
|
10421
|
+
ServiceAccount = "service_account",
|
|
10422
|
+
SysUser = "sys_user",
|
|
10423
|
+
Tag = "tag",
|
|
10424
|
+
Task = "task",
|
|
10314
10425
|
Ticket = "ticket",
|
|
10426
|
+
Vista = "vista",
|
|
10315
10427
|
Widget = "widget",
|
|
10316
10428
|
Work = "work"
|
|
10317
10429
|
}
|
|
@@ -11117,12 +11229,21 @@ export interface SnapInsUpdateRequest {
|
|
|
11117
11229
|
export interface SnapInsUpdateResponse {
|
|
11118
11230
|
snap_in: SnapIn;
|
|
11119
11231
|
}
|
|
11232
|
+
/**
|
|
11233
|
+
* snap-kit-base-widget
|
|
11234
|
+
* A SnapKit based widget.
|
|
11235
|
+
*/
|
|
11236
|
+
export interface SnapKitBaseWidget {
|
|
11237
|
+
snap_kit_execution?: string;
|
|
11238
|
+
}
|
|
11120
11239
|
/** snap-widget */
|
|
11121
11240
|
export type SnapWidget = EmailPreviewWidget & {
|
|
11122
11241
|
type: SnapWidgetType;
|
|
11123
11242
|
};
|
|
11124
11243
|
/** snap-widget-base */
|
|
11125
11244
|
export type SnapWidgetBase = AtomBase & {
|
|
11245
|
+
/** A list of interactions supported by the widget. */
|
|
11246
|
+
interactions?: SnapWidgetInteraction[];
|
|
11126
11247
|
/** A human readable name for the snap widget. */
|
|
11127
11248
|
name: string;
|
|
11128
11249
|
/** Logical grouping of snap widgets. Useful for filtering. */
|
|
@@ -11130,14 +11251,71 @@ export type SnapWidgetBase = AtomBase & {
|
|
|
11130
11251
|
/** The status of the snap widget. */
|
|
11131
11252
|
status: SnapWidgetStatus;
|
|
11132
11253
|
};
|
|
11254
|
+
/**
|
|
11255
|
+
* snap-widget-click-interaction
|
|
11256
|
+
* An interaction supported by a widget.
|
|
11257
|
+
*/
|
|
11258
|
+
export type SnapWidgetClickInteraction = (SnapWidgetOpenPlugWidgetAction | SnapWidgetOpenUrlAction | SnapWidgetStartConversationAction) & {
|
|
11259
|
+
click_action: SnapWidgetClickInteractionClickAction;
|
|
11260
|
+
};
|
|
11261
|
+
export declare enum SnapWidgetClickInteractionClickAction {
|
|
11262
|
+
OpenPlugWidget = "open_plug_widget",
|
|
11263
|
+
OpenUrl = "open_url",
|
|
11264
|
+
StartConversation = "start_conversation"
|
|
11265
|
+
}
|
|
11266
|
+
/** snap-widget-display-interaction-base */
|
|
11267
|
+
export type SnapWidgetDisplayInteractionBase = object;
|
|
11268
|
+
/**
|
|
11269
|
+
* snap-widget-email-input-interaction
|
|
11270
|
+
* An interaction supported by a widget.
|
|
11271
|
+
*/
|
|
11272
|
+
export type SnapWidgetEmailInputInteraction = SnapWidgetDisplayInteractionBase;
|
|
11273
|
+
/**
|
|
11274
|
+
* snap-widget-interaction
|
|
11275
|
+
* An interaction supported by a widget.
|
|
11276
|
+
*/
|
|
11277
|
+
export type SnapWidgetInteraction = (SnapWidgetClickInteraction | SnapWidgetEmailInputInteraction) & {
|
|
11278
|
+
type: SnapWidgetInteractionType;
|
|
11279
|
+
};
|
|
11280
|
+
export declare enum SnapWidgetInteractionType {
|
|
11281
|
+
Click = "click",
|
|
11282
|
+
EmailInput = "email_input"
|
|
11283
|
+
}
|
|
11133
11284
|
/** Logical grouping of snap widgets. Useful for filtering. */
|
|
11134
11285
|
export declare enum SnapWidgetNamespace {
|
|
11135
11286
|
AiAssistantMessage = "ai_assistant_message",
|
|
11136
11287
|
CommentSuggestionReplies = "comment_suggestion_replies",
|
|
11137
11288
|
EmailPreview = "email_preview",
|
|
11138
11289
|
LinkPreview = "link_preview",
|
|
11290
|
+
MeetingPreview = "meeting_preview",
|
|
11139
11291
|
PlugNudge = "plug_nudge"
|
|
11140
11292
|
}
|
|
11293
|
+
/**
|
|
11294
|
+
* snap-widget-open-plug-widget-action
|
|
11295
|
+
* Details of open plug widget action.
|
|
11296
|
+
*/
|
|
11297
|
+
export type SnapWidgetOpenPlugWidgetAction = SnapWidgetDisplayInteractionBase;
|
|
11298
|
+
/**
|
|
11299
|
+
* snap-widget-open-url-action
|
|
11300
|
+
* Details of open url widget action.
|
|
11301
|
+
*/
|
|
11302
|
+
export type SnapWidgetOpenUrlAction = SnapWidgetDisplayInteractionBase & {
|
|
11303
|
+
/** The url to open when the widget is clicked. */
|
|
11304
|
+
url: string;
|
|
11305
|
+
};
|
|
11306
|
+
/**
|
|
11307
|
+
* snap-widget-start-conversation-action
|
|
11308
|
+
* Details of start conversation action.
|
|
11309
|
+
*/
|
|
11310
|
+
export type SnapWidgetStartConversationAction = SnapWidgetDisplayInteractionBase & {
|
|
11311
|
+
/**
|
|
11312
|
+
* Whether the rich text editor is enabled on the object. Default is
|
|
11313
|
+
* false.
|
|
11314
|
+
*/
|
|
11315
|
+
rte_enabled?: boolean;
|
|
11316
|
+
/** A SnapKit based widget. */
|
|
11317
|
+
starter_message?: SnapKitBaseWidget;
|
|
11318
|
+
};
|
|
11141
11319
|
/** The status of the snap widget. */
|
|
11142
11320
|
export declare enum SnapWidgetStatus {
|
|
11143
11321
|
Draft = "draft",
|
|
@@ -11635,6 +11813,8 @@ export interface SurveysResponsesListRequest {
|
|
|
11635
11813
|
* iteration starts from the beginning.
|
|
11636
11814
|
*/
|
|
11637
11815
|
cursor?: string;
|
|
11816
|
+
/** Filters for survey responses associated with these unique IDs. */
|
|
11817
|
+
dispatch_ids?: string[];
|
|
11638
11818
|
/**
|
|
11639
11819
|
* The maximum number of survey responses to return. If not set, then
|
|
11640
11820
|
* the default is '50'.
|
|
@@ -13993,7 +14173,10 @@ export type WorksCreateRequest = (WorksCreateRequestIssue | WorksCreateRequestOp
|
|
|
13993
14173
|
* @example ["ARTIFACT-12345"]
|
|
13994
14174
|
*/
|
|
13995
14175
|
artifacts?: string[];
|
|
13996
|
-
/**
|
|
14176
|
+
/**
|
|
14177
|
+
* Body of the work object.
|
|
14178
|
+
* @maxLength 65536
|
|
14179
|
+
*/
|
|
13997
14180
|
body?: string;
|
|
13998
14181
|
/** Custom fields. */
|
|
13999
14182
|
custom_fields?: object;
|
|
@@ -14261,6 +14444,8 @@ export interface WorksFilterTicket {
|
|
|
14261
14444
|
channels?: TicketChannels[];
|
|
14262
14445
|
/** Filters for tickets belonging to specific groups. */
|
|
14263
14446
|
group?: string[];
|
|
14447
|
+
/** Filters for frozen tickets. */
|
|
14448
|
+
is_frozen?: boolean;
|
|
14264
14449
|
/** Filters for tickets that are spam. */
|
|
14265
14450
|
is_spam?: boolean;
|
|
14266
14451
|
/** Filters for tickets that need response. */
|
|
@@ -14387,7 +14572,10 @@ export type WorksUpdateRequest = (Empty | WorksUpdateRequestIssue | WorksUpdateR
|
|
|
14387
14572
|
*/
|
|
14388
14573
|
applies_to_part?: string;
|
|
14389
14574
|
artifacts?: WorksUpdateRequestArtifacts;
|
|
14390
|
-
/**
|
|
14575
|
+
/**
|
|
14576
|
+
* Updated body of the work object, or unchanged if not provided.
|
|
14577
|
+
* @maxLength 65536
|
|
14578
|
+
*/
|
|
14391
14579
|
body?: string;
|
|
14392
14580
|
/** Custom fields. */
|
|
14393
14581
|
custom_fields?: object;
|
|
@@ -15494,7 +15682,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
15494
15682
|
/**
|
|
15495
15683
|
* @description Creates a command.
|
|
15496
15684
|
*
|
|
15497
|
-
* @tags
|
|
15685
|
+
* @tags commands
|
|
15498
15686
|
* @name CommandsCreate
|
|
15499
15687
|
* @summary Create Command
|
|
15500
15688
|
* @request POST:/commands.create
|
|
@@ -15504,7 +15692,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
15504
15692
|
/**
|
|
15505
15693
|
* @description Gets a command.
|
|
15506
15694
|
*
|
|
15507
|
-
* @tags
|
|
15695
|
+
* @tags commands
|
|
15508
15696
|
* @name CommandsGet
|
|
15509
15697
|
* @summary Get Command
|
|
15510
15698
|
* @request GET:/commands.get
|
|
@@ -15517,7 +15705,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
15517
15705
|
/**
|
|
15518
15706
|
* @description Gets a command.
|
|
15519
15707
|
*
|
|
15520
|
-
* @tags
|
|
15708
|
+
* @tags commands
|
|
15521
15709
|
* @name CommandsGetPost
|
|
15522
15710
|
* @summary Get Command (POST)
|
|
15523
15711
|
* @request POST:/commands.get
|
|
@@ -15527,7 +15715,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
15527
15715
|
/**
|
|
15528
15716
|
* @description Lists commands for a Dev organization.
|
|
15529
15717
|
*
|
|
15530
|
-
* @tags
|
|
15718
|
+
* @tags commands
|
|
15531
15719
|
* @name CommandsList
|
|
15532
15720
|
* @summary List Commands
|
|
15533
15721
|
* @request GET:/commands.list
|
|
@@ -15564,7 +15752,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
15564
15752
|
/**
|
|
15565
15753
|
* @description Lists commands for a Dev organization.
|
|
15566
15754
|
*
|
|
15567
|
-
* @tags
|
|
15755
|
+
* @tags commands
|
|
15568
15756
|
* @name CommandsListPost
|
|
15569
15757
|
* @summary List Commands (POST)
|
|
15570
15758
|
* @request POST:/commands.list
|
|
@@ -15574,7 +15762,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
15574
15762
|
/**
|
|
15575
15763
|
* @description Updates a command.
|
|
15576
15764
|
*
|
|
15577
|
-
* @tags
|
|
15765
|
+
* @tags commands
|
|
15578
15766
|
* @name CommandsUpdate
|
|
15579
15767
|
* @summary Update Command
|
|
15580
15768
|
* @request POST:/commands.update
|
|
@@ -16060,7 +16248,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
16060
16248
|
/**
|
|
16061
16249
|
* @description Creates a new enterprise authentication connection for a Dev organization. This authentication connection will not be enabled by default for the organization and the user will need to explicitly enable this. Keep in mind that at a time, only one authentication connection can be enabled for a Dev organization. At present, only 5 enterprise connections can be created by an organization.
|
|
16062
16250
|
*
|
|
16063
|
-
* @tags auth-
|
|
16251
|
+
* @tags auth-connections, dev-orgs
|
|
16064
16252
|
* @name DevOrgAuthConnectionsCreate
|
|
16065
16253
|
* @summary Create Dev Orgs Auth Connection
|
|
16066
16254
|
* @request POST:/dev-orgs.auth-connections.create
|
|
@@ -16070,7 +16258,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
16070
16258
|
/**
|
|
16071
16259
|
* @description Deletes an authentication connection. Only enterprise connections which are explicitly set up for a Dev organization can be deleted. Default connections can not be deleted using this method.
|
|
16072
16260
|
*
|
|
16073
|
-
* @tags auth-
|
|
16261
|
+
* @tags auth-connections, dev-orgs
|
|
16074
16262
|
* @name DevOrgAuthConnectionsDelete
|
|
16075
16263
|
* @summary Delete Dev Orgs Auth Connection
|
|
16076
16264
|
* @request POST:/dev-orgs.auth-connections.delete
|
|
@@ -16080,7 +16268,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
16080
16268
|
/**
|
|
16081
16269
|
* @description Retrieves the details for an authentication connection.
|
|
16082
16270
|
*
|
|
16083
|
-
* @tags auth-
|
|
16271
|
+
* @tags auth-connections, dev-orgs
|
|
16084
16272
|
* @name DevOrgAuthConnectionsGet
|
|
16085
16273
|
* @summary Get Dev Orgs Auth Connection
|
|
16086
16274
|
* @request GET:/dev-orgs.auth-connections.get
|
|
@@ -16093,7 +16281,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
16093
16281
|
/**
|
|
16094
16282
|
* @description Retrieves the details for an authentication connection.
|
|
16095
16283
|
*
|
|
16096
|
-
* @tags auth-
|
|
16284
|
+
* @tags auth-connections, dev-orgs
|
|
16097
16285
|
* @name DevOrgAuthConnectionsGetPost
|
|
16098
16286
|
* @summary Get Dev Orgs Auth Connection (POST)
|
|
16099
16287
|
* @request POST:/dev-orgs.auth-connections.get
|
|
@@ -16103,7 +16291,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
16103
16291
|
/**
|
|
16104
16292
|
* @description Lists all the authentication connections available for a Dev organization. This list will include both social and enterprise connections which are either available by default or are explicitly created by the user.
|
|
16105
16293
|
*
|
|
16106
|
-
* @tags auth-
|
|
16294
|
+
* @tags auth-connections, dev-orgs
|
|
16107
16295
|
* @name DevOrgAuthConnectionsList
|
|
16108
16296
|
* @summary List Dev Orgs Auth Connections
|
|
16109
16297
|
* @request GET:/dev-orgs.auth-connections.list
|
|
@@ -16113,7 +16301,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
16113
16301
|
/**
|
|
16114
16302
|
* @description Lists all the authentication connections available for a Dev organization. This list will include both social and enterprise connections which are either available by default or are explicitly created by the user.
|
|
16115
16303
|
*
|
|
16116
|
-
* @tags auth-
|
|
16304
|
+
* @tags auth-connections, dev-orgs
|
|
16117
16305
|
* @name DevOrgAuthConnectionsListPost
|
|
16118
16306
|
* @summary List Dev Orgs Auth Connections (POST)
|
|
16119
16307
|
* @request POST:/dev-orgs.auth-connections.list
|
|
@@ -16123,7 +16311,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
16123
16311
|
/**
|
|
16124
16312
|
* @description Enable or disable an authentication connection for a Dev organization. Currently, only 1 authentication connection can be enabled at a time. When a new authentication connection is enabled, the connection which is currently enabled for the Dev organization is automatically disabled.
|
|
16125
16313
|
*
|
|
16126
|
-
* @tags auth-
|
|
16314
|
+
* @tags auth-connections, dev-orgs
|
|
16127
16315
|
* @name DevOrgAuthConnectionsToggle
|
|
16128
16316
|
* @summary Toggle Dev Orgs Auth Connections
|
|
16129
16317
|
* @request POST:/dev-orgs.auth-connections.toggle
|
|
@@ -16133,13 +16321,33 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
16133
16321
|
/**
|
|
16134
16322
|
* @description Updates an authentication connection.
|
|
16135
16323
|
*
|
|
16136
|
-
* @tags auth-
|
|
16324
|
+
* @tags auth-connections, dev-orgs
|
|
16137
16325
|
* @name DevOrgAuthConnectionsUpdate
|
|
16138
16326
|
* @summary Update Dev Orgs Auth Connection
|
|
16139
16327
|
* @request POST:/dev-orgs.auth-connections.update
|
|
16140
16328
|
* @secure
|
|
16141
16329
|
*/
|
|
16142
16330
|
devOrgAuthConnectionsUpdate: (data: DevOrgAuthConnectionsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<DevOrgAuthConnectionsUpdateResponse, any>>;
|
|
16331
|
+
/**
|
|
16332
|
+
* @description Gets the Dev organization's information of the authenticated user.
|
|
16333
|
+
*
|
|
16334
|
+
* @tags dev-orgs
|
|
16335
|
+
* @name DevOrgsGet
|
|
16336
|
+
* @summary Get Dev Org
|
|
16337
|
+
* @request GET:/dev-orgs.get
|
|
16338
|
+
* @secure
|
|
16339
|
+
*/
|
|
16340
|
+
devOrgsGet: (params?: RequestParams) => Promise<AxiosResponse<DevOrgsGetResponse, any>>;
|
|
16341
|
+
/**
|
|
16342
|
+
* @description Gets the Dev organization's information of the authenticated user.
|
|
16343
|
+
*
|
|
16344
|
+
* @tags dev-orgs
|
|
16345
|
+
* @name DevOrgsGetPost
|
|
16346
|
+
* @summary Get Dev Org (POST)
|
|
16347
|
+
* @request POST:/dev-orgs.get
|
|
16348
|
+
* @secure
|
|
16349
|
+
*/
|
|
16350
|
+
devOrgsGetPost: (data: DevOrgsGetRequest, params?: RequestParams) => Promise<AxiosResponse<DevOrgsGetResponse, any>>;
|
|
16143
16351
|
/**
|
|
16144
16352
|
* @description Activates the requested user.
|
|
16145
16353
|
*
|
|
@@ -16574,7 +16782,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
16574
16782
|
/**
|
|
16575
16783
|
* @description Gets an event source.
|
|
16576
16784
|
*
|
|
16577
|
-
* @tags event-
|
|
16785
|
+
* @tags event-sources
|
|
16578
16786
|
* @name EventSourcesGet
|
|
16579
16787
|
* @summary Get Event Source
|
|
16580
16788
|
* @request GET:/event-sources.get
|
|
@@ -16587,7 +16795,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
16587
16795
|
/**
|
|
16588
16796
|
* @description Gets an event source.
|
|
16589
16797
|
*
|
|
16590
|
-
* @tags event-
|
|
16798
|
+
* @tags event-sources
|
|
16591
16799
|
* @name EventSourcesGetPost
|
|
16592
16800
|
* @summary Get Event Source (POST)
|
|
16593
16801
|
* @request POST:/event-sources.get
|
|
@@ -16597,7 +16805,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
16597
16805
|
/**
|
|
16598
16806
|
* @description Schedules an event to be published to the specified event source.
|
|
16599
16807
|
*
|
|
16600
|
-
* @tags event-
|
|
16808
|
+
* @tags event-sources
|
|
16601
16809
|
* @name EventSourcesScheduleEvent
|
|
16602
16810
|
* @summary Schedule Event Sources
|
|
16603
16811
|
* @request POST:/event-sources.schedule
|
|
@@ -16607,7 +16815,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
16607
16815
|
/**
|
|
16608
16816
|
* @description Deletes an event scheduled for the specified event source.
|
|
16609
16817
|
*
|
|
16610
|
-
* @tags event-
|
|
16818
|
+
* @tags event-sources
|
|
16611
16819
|
* @name EventSourcesDeleteScheduledEvent
|
|
16612
16820
|
* @summary Unschedule Event Sources
|
|
16613
16821
|
* @request POST:/event-sources.unschedule
|
|
@@ -16765,7 +16973,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
16765
16973
|
/**
|
|
16766
16974
|
* @description Creates an incident.
|
|
16767
16975
|
*
|
|
16768
|
-
* @tags
|
|
16976
|
+
* @tags incidents
|
|
16769
16977
|
* @name IncidentsCreate
|
|
16770
16978
|
* @summary Create Incident
|
|
16771
16979
|
* @request POST:/incidents.create
|
|
@@ -16775,7 +16983,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
16775
16983
|
/**
|
|
16776
16984
|
* @description Deletes an incident.
|
|
16777
16985
|
*
|
|
16778
|
-
* @tags
|
|
16986
|
+
* @tags incidents
|
|
16779
16987
|
* @name IncidentsDelete
|
|
16780
16988
|
* @summary Delete Incident
|
|
16781
16989
|
* @request POST:/incidents.delete
|
|
@@ -16785,7 +16993,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
16785
16993
|
/**
|
|
16786
16994
|
* @description Gets an incident.
|
|
16787
16995
|
*
|
|
16788
|
-
* @tags
|
|
16996
|
+
* @tags incidents
|
|
16789
16997
|
* @name IncidentsGet
|
|
16790
16998
|
* @summary Get Incident
|
|
16791
16999
|
* @request GET:/incidents.get
|
|
@@ -16798,7 +17006,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
16798
17006
|
/**
|
|
16799
17007
|
* @description Gets an incident.
|
|
16800
17008
|
*
|
|
16801
|
-
* @tags
|
|
17009
|
+
* @tags incidents
|
|
16802
17010
|
* @name IncidentsGetPost
|
|
16803
17011
|
* @summary Get Incident (POST)
|
|
16804
17012
|
* @request POST:/incidents.get
|
|
@@ -16808,7 +17016,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
16808
17016
|
/**
|
|
16809
17017
|
* @description Lists collections of incidents by groups.
|
|
16810
17018
|
*
|
|
16811
|
-
* @tags
|
|
17019
|
+
* @tags incidents
|
|
16812
17020
|
* @name IncidentsGroup
|
|
16813
17021
|
* @summary Group Incidents
|
|
16814
17022
|
* @request GET:/incidents.group
|
|
@@ -16883,7 +17091,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
16883
17091
|
/**
|
|
16884
17092
|
* @description Lists collections of incidents by groups.
|
|
16885
17093
|
*
|
|
16886
|
-
* @tags
|
|
17094
|
+
* @tags incidents
|
|
16887
17095
|
* @name IncidentsGroupPost
|
|
16888
17096
|
* @summary Group Incidents (POST)
|
|
16889
17097
|
* @request POST:/incidents.group
|
|
@@ -16893,7 +17101,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
16893
17101
|
/**
|
|
16894
17102
|
* @description Lists incidents.
|
|
16895
17103
|
*
|
|
16896
|
-
* @tags
|
|
17104
|
+
* @tags incidents
|
|
16897
17105
|
* @name IncidentsList
|
|
16898
17106
|
* @summary List Incidents
|
|
16899
17107
|
* @request GET:/incidents.list
|
|
@@ -16959,7 +17167,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
16959
17167
|
/**
|
|
16960
17168
|
* @description Lists incidents.
|
|
16961
17169
|
*
|
|
16962
|
-
* @tags
|
|
17170
|
+
* @tags incidents
|
|
16963
17171
|
* @name IncidentsListPost
|
|
16964
17172
|
* @summary List Incidents (POST)
|
|
16965
17173
|
* @request POST:/incidents.list
|
|
@@ -16969,7 +17177,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
16969
17177
|
/**
|
|
16970
17178
|
* @description Updates an incident.
|
|
16971
17179
|
*
|
|
16972
|
-
* @tags
|
|
17180
|
+
* @tags incidents
|
|
16973
17181
|
* @name IncidentsUpdate
|
|
16974
17182
|
* @summary Update Incident
|
|
16975
17183
|
* @request POST:/incidents.update
|
|
@@ -16979,7 +17187,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
16979
17187
|
/**
|
|
16980
17188
|
* @description OAuth2 authorization callback.
|
|
16981
17189
|
*
|
|
16982
|
-
* @tags
|
|
17190
|
+
* @tags keyrings
|
|
16983
17191
|
* @name KeyringsCreateCallback
|
|
16984
17192
|
* @summary Authorize Keyrings
|
|
16985
17193
|
* @request GET:/keyrings.authorize
|
|
@@ -16993,7 +17201,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
16993
17201
|
/**
|
|
16994
17202
|
* @description OAuth2 authorization callback.
|
|
16995
17203
|
*
|
|
16996
|
-
* @tags
|
|
17204
|
+
* @tags keyrings
|
|
16997
17205
|
* @name KeyringsCreateCallbackPost
|
|
16998
17206
|
* @summary Authorize Keyrings (POST)
|
|
16999
17207
|
* @request POST:/keyrings.authorize
|
|
@@ -17475,7 +17683,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
17475
17683
|
/**
|
|
17476
17684
|
* @description Ingest endpoint for DevRev metrics data from clients.
|
|
17477
17685
|
*
|
|
17478
|
-
* @tags
|
|
17686
|
+
* @tags metrics
|
|
17479
17687
|
* @name MetricsDevrevIngest
|
|
17480
17688
|
* @summary Ingest Metrics Devrev
|
|
17481
17689
|
* @request POST:/metrics.devrev.ingest
|
|
@@ -19419,6 +19627,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
19419
19627
|
* starts from the beginning.
|
|
19420
19628
|
*/
|
|
19421
19629
|
cursor?: string;
|
|
19630
|
+
/** Filters for survey responses associated with these unique IDs. */
|
|
19631
|
+
dispatch_ids?: string[];
|
|
19422
19632
|
/**
|
|
19423
19633
|
* The maximum number of survey responses to return. If not set, then
|
|
19424
19634
|
* the default is '50'.
|
|
@@ -19761,7 +19971,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
19761
19971
|
/**
|
|
19762
19972
|
* @description Allows publishing of events (example from plug widget).
|
|
19763
19973
|
*
|
|
19764
|
-
* @tags event-
|
|
19974
|
+
* @tags event-sources
|
|
19765
19975
|
* @name TrackEventsPublish
|
|
19766
19976
|
* @summary Publish Track Events
|
|
19767
19977
|
* @request POST:/track-events.publish
|
|
@@ -19771,9 +19981,9 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
19771
19981
|
/**
|
|
19772
19982
|
* @description Counts the number of Unit of Measurements based on the given filters.
|
|
19773
19983
|
*
|
|
19774
|
-
* @tags
|
|
19984
|
+
* @tags uoms
|
|
19775
19985
|
* @name UomsCount
|
|
19776
|
-
* @summary Count
|
|
19986
|
+
* @summary Count UOMs
|
|
19777
19987
|
* @request GET:/uoms.count
|
|
19778
19988
|
* @secure
|
|
19779
19989
|
*/
|
|
@@ -19803,9 +20013,9 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
19803
20013
|
/**
|
|
19804
20014
|
* @description Counts the number of Unit of Measurements based on the given filters.
|
|
19805
20015
|
*
|
|
19806
|
-
* @tags
|
|
20016
|
+
* @tags uoms
|
|
19807
20017
|
* @name UomsCountPost
|
|
19808
|
-
* @summary Count
|
|
20018
|
+
* @summary Count UOMs (POST)
|
|
19809
20019
|
* @request POST:/uoms.count
|
|
19810
20020
|
* @secure
|
|
19811
20021
|
*/
|
|
@@ -19813,9 +20023,9 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
19813
20023
|
/**
|
|
19814
20024
|
* @description Creates a Unit of Measurement on a part.
|
|
19815
20025
|
*
|
|
19816
|
-
* @tags
|
|
20026
|
+
* @tags uoms
|
|
19817
20027
|
* @name UomsCreate
|
|
19818
|
-
* @summary Create
|
|
20028
|
+
* @summary Create UOM
|
|
19819
20029
|
* @request POST:/uoms.create
|
|
19820
20030
|
* @secure
|
|
19821
20031
|
*/
|
|
@@ -19823,9 +20033,9 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
19823
20033
|
/**
|
|
19824
20034
|
* @description Deletes a Unit of Measurement.
|
|
19825
20035
|
*
|
|
19826
|
-
* @tags
|
|
20036
|
+
* @tags uoms
|
|
19827
20037
|
* @name UomsDelete
|
|
19828
|
-
* @summary Delete
|
|
20038
|
+
* @summary Delete UOM
|
|
19829
20039
|
* @request POST:/uoms.delete
|
|
19830
20040
|
* @secure
|
|
19831
20041
|
*/
|
|
@@ -19833,9 +20043,9 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
19833
20043
|
/**
|
|
19834
20044
|
* @description Gets a Unit of Measurement.
|
|
19835
20045
|
*
|
|
19836
|
-
* @tags
|
|
20046
|
+
* @tags uoms
|
|
19837
20047
|
* @name UomsGet
|
|
19838
|
-
* @summary Get
|
|
20048
|
+
* @summary Get UOM
|
|
19839
20049
|
* @request GET:/uoms.get
|
|
19840
20050
|
* @secure
|
|
19841
20051
|
*/
|
|
@@ -19846,9 +20056,9 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
19846
20056
|
/**
|
|
19847
20057
|
* @description Gets a Unit of Measurement.
|
|
19848
20058
|
*
|
|
19849
|
-
* @tags
|
|
20059
|
+
* @tags uoms
|
|
19850
20060
|
* @name UomsGetPost
|
|
19851
|
-
* @summary Get
|
|
20061
|
+
* @summary Get UOM (POST)
|
|
19852
20062
|
* @request POST:/uoms.get
|
|
19853
20063
|
* @secure
|
|
19854
20064
|
*/
|
|
@@ -19856,9 +20066,9 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
19856
20066
|
/**
|
|
19857
20067
|
* @description Gets the Unit of Measurements based on the given filters.
|
|
19858
20068
|
*
|
|
19859
|
-
* @tags
|
|
20069
|
+
* @tags uoms
|
|
19860
20070
|
* @name UomsList
|
|
19861
|
-
* @summary List
|
|
20071
|
+
* @summary List UOMs
|
|
19862
20072
|
* @request GET:/uoms.list
|
|
19863
20073
|
* @secure
|
|
19864
20074
|
*/
|
|
@@ -19909,9 +20119,9 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
19909
20119
|
/**
|
|
19910
20120
|
* @description Gets the Unit of Measurements based on the given filters.
|
|
19911
20121
|
*
|
|
19912
|
-
* @tags
|
|
20122
|
+
* @tags uoms
|
|
19913
20123
|
* @name UomsListPost
|
|
19914
|
-
* @summary List
|
|
20124
|
+
* @summary List UOMs (POST)
|
|
19915
20125
|
* @request POST:/uoms.list
|
|
19916
20126
|
* @secure
|
|
19917
20127
|
*/
|
|
@@ -19919,9 +20129,9 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
19919
20129
|
/**
|
|
19920
20130
|
* @description Updates a Unit of Measurement.
|
|
19921
20131
|
*
|
|
19922
|
-
* @tags
|
|
20132
|
+
* @tags uoms
|
|
19923
20133
|
* @name UomsUpdate
|
|
19924
|
-
* @summary Update
|
|
20134
|
+
* @summary Update UOM
|
|
19925
20135
|
* @request POST:/uoms.update
|
|
19926
20136
|
* @secure
|
|
19927
20137
|
*/
|
|
@@ -20143,6 +20353,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
20143
20353
|
'ticket.channels'?: TicketChannels[];
|
|
20144
20354
|
/** Filters for tickets belonging to specific groups. */
|
|
20145
20355
|
'ticket.group'?: string[];
|
|
20356
|
+
/** Filters for frozen tickets. */
|
|
20357
|
+
'ticket.is_frozen'?: boolean;
|
|
20146
20358
|
/** Filters for tickets that are spam. */
|
|
20147
20359
|
'ticket.is_spam'?: boolean;
|
|
20148
20360
|
/** Filters for tickets that need response. */
|
|
@@ -20310,6 +20522,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
20310
20522
|
'ticket.channels'?: TicketChannels[];
|
|
20311
20523
|
/** Filters for tickets belonging to specific groups. */
|
|
20312
20524
|
'ticket.group'?: string[];
|
|
20525
|
+
/** Filters for frozen tickets. */
|
|
20526
|
+
'ticket.is_frozen'?: boolean;
|
|
20313
20527
|
/** Filters for tickets that are spam. */
|
|
20314
20528
|
'ticket.is_spam'?: boolean;
|
|
20315
20529
|
/** Filters for tickets that need response. */
|