@devrev/typescript-sdk 1.1.61 → 1.1.63
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.
|
@@ -30,6 +30,7 @@ export type Account = OrgBase & {
|
|
|
30
30
|
external_refs?: string[];
|
|
31
31
|
/** List of Dev user IDs owning this Account. */
|
|
32
32
|
owned_by: UserSummary[];
|
|
33
|
+
primary_account?: AccountSummary;
|
|
33
34
|
/**
|
|
34
35
|
* Stock schema fragment.
|
|
35
36
|
* @format id
|
|
@@ -2169,6 +2170,8 @@ export declare enum AuthTokenTokenType {
|
|
|
2169
2170
|
* Carries account info.
|
|
2170
2171
|
*/
|
|
2171
2172
|
export interface AuthTokensAccountTraits {
|
|
2173
|
+
/** Application-defined custom fields of the account. */
|
|
2174
|
+
custom_fields?: object;
|
|
2172
2175
|
/**
|
|
2173
2176
|
* The display name of the account.
|
|
2174
2177
|
* @format text
|
|
@@ -3918,6 +3921,11 @@ export type Conversation = AtomBase & {
|
|
|
3918
3921
|
/** SLA summary for the object. */
|
|
3919
3922
|
sla_summary?: ArchetypeSlaSummary;
|
|
3920
3923
|
sla_tracker?: SlaTrackerSummary;
|
|
3924
|
+
/**
|
|
3925
|
+
* Source channel for the conversation.
|
|
3926
|
+
* @format text
|
|
3927
|
+
*/
|
|
3928
|
+
source_channel?: string;
|
|
3921
3929
|
/** Describes the current stage of a work item. */
|
|
3922
3930
|
stage?: LegacyStage;
|
|
3923
3931
|
/**
|
|
@@ -4023,6 +4031,11 @@ export interface ConversationsCreateRequest {
|
|
|
4023
4031
|
* @format text
|
|
4024
4032
|
*/
|
|
4025
4033
|
source_channel?: string;
|
|
4034
|
+
/**
|
|
4035
|
+
* Source channel ID of the conversation.
|
|
4036
|
+
* @format id
|
|
4037
|
+
*/
|
|
4038
|
+
source_channel_v2?: string;
|
|
4026
4039
|
/** Sets an object's initial stage. */
|
|
4027
4040
|
stage?: StageInit;
|
|
4028
4041
|
/** Tags associated with the conversation. */
|
|
@@ -4139,6 +4152,11 @@ export interface ConversationsExportRequest {
|
|
|
4139
4152
|
sla_summary?: SlaSummaryFilter;
|
|
4140
4153
|
/** Filters for conversations with any of the provided source channels. */
|
|
4141
4154
|
source_channel?: string[];
|
|
4155
|
+
/**
|
|
4156
|
+
* Filters for conversations that are associated with the source
|
|
4157
|
+
* channel.
|
|
4158
|
+
*/
|
|
4159
|
+
source_channel_v2?: string[];
|
|
4142
4160
|
/**
|
|
4143
4161
|
* Filters for conversations with any of the provided source channels.
|
|
4144
4162
|
* @deprecated
|
|
@@ -4258,6 +4276,11 @@ export interface ConversationsListRequest {
|
|
|
4258
4276
|
sla_summary?: SlaSummaryFilter;
|
|
4259
4277
|
/** Filters for conversations with any of the provided source channels. */
|
|
4260
4278
|
source_channel?: string[];
|
|
4279
|
+
/**
|
|
4280
|
+
* Filters for conversations that are associated with the source
|
|
4281
|
+
* channel.
|
|
4282
|
+
*/
|
|
4283
|
+
source_channel_v2?: string[];
|
|
4261
4284
|
/**
|
|
4262
4285
|
* Filters for conversations with any of the provided source channels.
|
|
4263
4286
|
* @deprecated
|
|
@@ -4343,6 +4366,11 @@ export interface ConversationsUpdateRequest {
|
|
|
4343
4366
|
members?: ConversationsUpdateRequestMembers;
|
|
4344
4367
|
metadata?: ConversationsUpdateRequestMetadata;
|
|
4345
4368
|
owned_by?: ConversationsUpdateRequestOwnedBy;
|
|
4369
|
+
/**
|
|
4370
|
+
* Source channel ID of the conversation.
|
|
4371
|
+
* @format id
|
|
4372
|
+
*/
|
|
4373
|
+
source_channel_v2?: string;
|
|
4346
4374
|
/** Updates an object's stage. */
|
|
4347
4375
|
stage?: StageUpdate;
|
|
4348
4376
|
/**
|
|
@@ -4413,6 +4441,19 @@ export interface ConversationsUpdateRequestUserSessions {
|
|
|
4413
4441
|
export interface ConversationsUpdateResponse {
|
|
4414
4442
|
conversation: Conversation;
|
|
4415
4443
|
}
|
|
4444
|
+
/**
|
|
4445
|
+
* conversations-vista-group-item
|
|
4446
|
+
* Represents a nested conversations vista group object.
|
|
4447
|
+
*/
|
|
4448
|
+
export type ConversationsVistaGroupItem = VistaGroupBase & {
|
|
4449
|
+
/** Type of conversations vista group item. */
|
|
4450
|
+
type: ConversationsVistaGroupItemType;
|
|
4451
|
+
};
|
|
4452
|
+
/** Type of conversations vista group item. */
|
|
4453
|
+
export declare enum ConversationsVistaGroupItemType {
|
|
4454
|
+
Curated = "curated",
|
|
4455
|
+
Dynamic = "dynamic"
|
|
4456
|
+
}
|
|
4416
4457
|
/**
|
|
4417
4458
|
* create-association
|
|
4418
4459
|
* Association of Rev users with Rev orgs or accounts. A Rev user can be
|
|
@@ -4817,9 +4858,17 @@ export interface CreateWeeklyOrgScheduleInterval {
|
|
|
4817
4858
|
*/
|
|
4818
4859
|
to: number;
|
|
4819
4860
|
}
|
|
4861
|
+
/**
|
|
4862
|
+
* curated-vista
|
|
4863
|
+
* Static collection of DevRev objects.
|
|
4864
|
+
*/
|
|
4865
|
+
export type CuratedVista = VistaBase & {
|
|
4866
|
+
/** Item list to store a curated list of DevRev objects. */
|
|
4867
|
+
items?: AtomSummary[];
|
|
4868
|
+
};
|
|
4820
4869
|
/**
|
|
4821
4870
|
* curated-vista-summary
|
|
4822
|
-
* Static collection of
|
|
4871
|
+
* Static collection of DevRev objects.
|
|
4823
4872
|
*/
|
|
4824
4873
|
export type CuratedVistaSummary = VistaBaseSummary;
|
|
4825
4874
|
/**
|
|
@@ -7116,9 +7165,35 @@ export interface DonutWidgetVisualization {
|
|
|
7116
7165
|
* Information to define dynamic groups.
|
|
7117
7166
|
*/
|
|
7118
7167
|
export type DynamicGroupInfo = object;
|
|
7168
|
+
/**
|
|
7169
|
+
* dynamic-vista
|
|
7170
|
+
* Dynamic collection of DevRev objects, all adhering to a specific
|
|
7171
|
+
* filter.
|
|
7172
|
+
*/
|
|
7173
|
+
export type DynamicVista = VistaBase & {
|
|
7174
|
+
/** Type of DevRev object for which the vista is applicable. */
|
|
7175
|
+
filter_type: DynamicVistaFilterType;
|
|
7176
|
+
};
|
|
7177
|
+
/** Type of DevRev object for which the vista is applicable. */
|
|
7178
|
+
export declare enum DynamicVistaFilterType {
|
|
7179
|
+
Accounts = "accounts",
|
|
7180
|
+
Articles = "articles",
|
|
7181
|
+
Conversations = "conversations",
|
|
7182
|
+
Credits = "credits",
|
|
7183
|
+
CustomObjects = "custom_objects",
|
|
7184
|
+
DevUsers = "dev_users",
|
|
7185
|
+
Incidents = "incidents",
|
|
7186
|
+
Invoices = "invoices",
|
|
7187
|
+
Meetings = "meetings",
|
|
7188
|
+
Parts = "parts",
|
|
7189
|
+
Quotes = "quotes",
|
|
7190
|
+
RevOrgs = "rev_orgs",
|
|
7191
|
+
RevUsers = "rev_users",
|
|
7192
|
+
Works = "works"
|
|
7193
|
+
}
|
|
7119
7194
|
/**
|
|
7120
7195
|
* dynamic-vista-summary
|
|
7121
|
-
* Dynamic collection of
|
|
7196
|
+
* Dynamic collection of DevRev objects, all adhering to a specific
|
|
7122
7197
|
* filter.
|
|
7123
7198
|
*/
|
|
7124
7199
|
export type DynamicVistaSummary = VistaBaseSummary;
|
|
@@ -9017,6 +9092,11 @@ export declare enum GroupIngestionSource {
|
|
|
9017
9092
|
Airdrop = "airdrop",
|
|
9018
9093
|
Scim = "scim"
|
|
9019
9094
|
}
|
|
9095
|
+
/** Type of the vista group item object. */
|
|
9096
|
+
export declare enum GroupItemType {
|
|
9097
|
+
Curated = "curated",
|
|
9098
|
+
Dynamic = "dynamic"
|
|
9099
|
+
}
|
|
9020
9100
|
/** Type of the members in the group. */
|
|
9021
9101
|
export declare enum GroupMemberType {
|
|
9022
9102
|
DevUser = "dev_user",
|
|
@@ -9154,6 +9234,22 @@ export declare enum GroupType {
|
|
|
9154
9234
|
Dynamic = "dynamic",
|
|
9155
9235
|
Static = "static"
|
|
9156
9236
|
}
|
|
9237
|
+
/**
|
|
9238
|
+
* grouped-vista
|
|
9239
|
+
* Represents a group of multiple vistas as a single unit.
|
|
9240
|
+
*/
|
|
9241
|
+
export type GroupedVista = VistaBase & {
|
|
9242
|
+
/** Type of DevRev object for which the grouped vista is applicable. */
|
|
9243
|
+
filter_type: GroupedVistaFilterType;
|
|
9244
|
+
/** Denotes the use case of the grouped vista. */
|
|
9245
|
+
flavor?: GroupedVistaFlavor;
|
|
9246
|
+
};
|
|
9247
|
+
/** Type of DevRev object for which the grouped vista is applicable. */
|
|
9248
|
+
export declare enum GroupedVistaFilterType {
|
|
9249
|
+
Conversations = "conversations",
|
|
9250
|
+
Parts = "parts",
|
|
9251
|
+
Works = "works"
|
|
9252
|
+
}
|
|
9157
9253
|
/** Denotes the use case of the grouped vista. */
|
|
9158
9254
|
export declare enum GroupedVistaFlavor {
|
|
9159
9255
|
Nnl = "nnl",
|
|
@@ -10834,7 +10930,7 @@ export interface MeetingsCreateRequest {
|
|
|
10834
10930
|
* @format date-time
|
|
10835
10931
|
* @example "2023-01-01T12:00:00.000Z"
|
|
10836
10932
|
*/
|
|
10837
|
-
scheduled_date
|
|
10933
|
+
scheduled_date?: string;
|
|
10838
10934
|
/** The state of meeting. */
|
|
10839
10935
|
state: MeetingState;
|
|
10840
10936
|
/** Tags associated with the meeting. */
|
|
@@ -12492,6 +12588,19 @@ export interface PartsUpdateRequestTags {
|
|
|
12492
12588
|
export interface PartsUpdateResponse {
|
|
12493
12589
|
part: Part;
|
|
12494
12590
|
}
|
|
12591
|
+
/**
|
|
12592
|
+
* parts-vista-group-item
|
|
12593
|
+
* Represents a nested parts vista group object.
|
|
12594
|
+
*/
|
|
12595
|
+
export type PartsVistaGroupItem = VistaGroupBase & {
|
|
12596
|
+
/** Type of parts vista group item. */
|
|
12597
|
+
type: PartsVistaGroupItemType;
|
|
12598
|
+
};
|
|
12599
|
+
/** Type of parts vista group item. */
|
|
12600
|
+
export declare enum PartsVistaGroupItemType {
|
|
12601
|
+
Curated = "curated",
|
|
12602
|
+
Dynamic = "dynamic"
|
|
12603
|
+
}
|
|
12495
12604
|
/**
|
|
12496
12605
|
* pie-visualization-x-axis
|
|
12497
12606
|
* The X-axis for a pie visualization.
|
|
@@ -13151,6 +13260,7 @@ export type RevOrg = OrgBase & {
|
|
|
13151
13260
|
* @format text
|
|
13152
13261
|
*/
|
|
13153
13262
|
external_ref?: string;
|
|
13263
|
+
primary_rev_org?: OrgSummary;
|
|
13154
13264
|
/**
|
|
13155
13265
|
* Stock schema fragment.
|
|
13156
13266
|
* @format id
|
|
@@ -19197,6 +19307,7 @@ export type UserBase = AtomBase & {
|
|
|
19197
19307
|
full_name?: string;
|
|
19198
19308
|
/** Phone numbers of the user. */
|
|
19199
19309
|
phone_numbers?: string[];
|
|
19310
|
+
primary_identity?: UserSummary;
|
|
19200
19311
|
/** State of the user. */
|
|
19201
19312
|
state?: UserState;
|
|
19202
19313
|
};
|
|
@@ -19299,6 +19410,26 @@ export interface ViewOverride {
|
|
|
19299
19410
|
*/
|
|
19300
19411
|
view_name?: string;
|
|
19301
19412
|
}
|
|
19413
|
+
/**
|
|
19414
|
+
* vista
|
|
19415
|
+
* Represents a collection of DevRev objects.
|
|
19416
|
+
*/
|
|
19417
|
+
export type Vista = (CuratedVista | DynamicVista | GroupedVista) & {
|
|
19418
|
+
/** Type of vista object. */
|
|
19419
|
+
type: VistaType;
|
|
19420
|
+
};
|
|
19421
|
+
/** vista-base */
|
|
19422
|
+
export type VistaBase = AtomBase & {
|
|
19423
|
+
/** Boolean to specify whether it's a default Vista or not. */
|
|
19424
|
+
is_default?: boolean;
|
|
19425
|
+
/**
|
|
19426
|
+
* Name of the vista.
|
|
19427
|
+
* @format text
|
|
19428
|
+
*/
|
|
19429
|
+
name: string;
|
|
19430
|
+
/** Users and groups associated with vista. */
|
|
19431
|
+
shared_with?: SharedWithMembership[];
|
|
19432
|
+
};
|
|
19302
19433
|
/** vista-base-summary */
|
|
19303
19434
|
export type VistaBaseSummary = AtomBaseSummary & {
|
|
19304
19435
|
/**
|
|
@@ -19307,6 +19438,80 @@ export type VistaBaseSummary = AtomBaseSummary & {
|
|
|
19307
19438
|
*/
|
|
19308
19439
|
name: string;
|
|
19309
19440
|
};
|
|
19441
|
+
/** Denotes the use case of the vista. */
|
|
19442
|
+
export declare enum VistaFlavor {
|
|
19443
|
+
Nnl = "nnl",
|
|
19444
|
+
SprintBoard = "sprint_board",
|
|
19445
|
+
SupportInbox = "support_inbox"
|
|
19446
|
+
}
|
|
19447
|
+
/**
|
|
19448
|
+
* vista-group
|
|
19449
|
+
* Represents a vista group item.
|
|
19450
|
+
*/
|
|
19451
|
+
export type VistaGroup = (ConversationsVistaGroupItem | PartsVistaGroupItem | WorksVistaGroupItem) & {
|
|
19452
|
+
/** Type of DevRev object for which the grouped vista is applicable. */
|
|
19453
|
+
object_type: GroupedVistaFilterType;
|
|
19454
|
+
};
|
|
19455
|
+
/** vista-group-base */
|
|
19456
|
+
export interface VistaGroupBase {
|
|
19457
|
+
/**
|
|
19458
|
+
* Timestamp when the vista group item ends.
|
|
19459
|
+
* @format date-time
|
|
19460
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
19461
|
+
*/
|
|
19462
|
+
end_date?: string;
|
|
19463
|
+
/**
|
|
19464
|
+
* Globally unique object ID.
|
|
19465
|
+
* @format id
|
|
19466
|
+
*/
|
|
19467
|
+
id: string;
|
|
19468
|
+
/**
|
|
19469
|
+
* Name of the group.
|
|
19470
|
+
* @format text
|
|
19471
|
+
*/
|
|
19472
|
+
name: string;
|
|
19473
|
+
parent?: VistaGroupBaseVistaParentComposite;
|
|
19474
|
+
/**
|
|
19475
|
+
* Timestamp when the vista group item starts.
|
|
19476
|
+
* @format date-time
|
|
19477
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
19478
|
+
*/
|
|
19479
|
+
start_date?: string;
|
|
19480
|
+
/** Defines the state of the group item. */
|
|
19481
|
+
state?: VistaGroupItemState;
|
|
19482
|
+
}
|
|
19483
|
+
/** vista-group-base-vista-parent-composite */
|
|
19484
|
+
export interface VistaGroupBaseVistaParentComposite {
|
|
19485
|
+
/**
|
|
19486
|
+
* Type of the parent vista.
|
|
19487
|
+
* @format text
|
|
19488
|
+
*/
|
|
19489
|
+
type: string;
|
|
19490
|
+
/**
|
|
19491
|
+
* Human-readable object ID unique to the Dev organization.
|
|
19492
|
+
* @format text
|
|
19493
|
+
*/
|
|
19494
|
+
display_id: string;
|
|
19495
|
+
/** Denotes the use case of the vista. */
|
|
19496
|
+
flavor?: VistaFlavor;
|
|
19497
|
+
/**
|
|
19498
|
+
* Parent vista ID.
|
|
19499
|
+
* @format id
|
|
19500
|
+
* @example "VISTA-12345"
|
|
19501
|
+
*/
|
|
19502
|
+
id: string;
|
|
19503
|
+
/**
|
|
19504
|
+
* Name of the parent vista.
|
|
19505
|
+
* @format text
|
|
19506
|
+
*/
|
|
19507
|
+
name: string;
|
|
19508
|
+
}
|
|
19509
|
+
/** Type of DevRev object for which the vista group item is applicable. */
|
|
19510
|
+
export declare enum VistaGroupItemGroupObjectType {
|
|
19511
|
+
Conversation = "conversation",
|
|
19512
|
+
Part = "part",
|
|
19513
|
+
Work = "work"
|
|
19514
|
+
}
|
|
19310
19515
|
/** Defines the state of the group item. */
|
|
19311
19516
|
export declare enum VistaGroupItemState {
|
|
19312
19517
|
Active = "active",
|
|
@@ -19369,6 +19574,212 @@ export declare enum VistaType {
|
|
|
19369
19574
|
Dynamic = "dynamic",
|
|
19370
19575
|
Grouped = "grouped"
|
|
19371
19576
|
}
|
|
19577
|
+
/**
|
|
19578
|
+
* vistas-delete-request
|
|
19579
|
+
* The request to delete a vista.
|
|
19580
|
+
*/
|
|
19581
|
+
export interface VistasDeleteRequest {
|
|
19582
|
+
/**
|
|
19583
|
+
* The ID of the vista to delete.
|
|
19584
|
+
* @format id
|
|
19585
|
+
* @example "VISTA-12345"
|
|
19586
|
+
*/
|
|
19587
|
+
id: string;
|
|
19588
|
+
}
|
|
19589
|
+
/**
|
|
19590
|
+
* vistas-delete-response
|
|
19591
|
+
* The response when deleting a vista.
|
|
19592
|
+
*/
|
|
19593
|
+
export type VistasDeleteResponse = object;
|
|
19594
|
+
/**
|
|
19595
|
+
* vistas-get-request
|
|
19596
|
+
* The request to get a vista's information.
|
|
19597
|
+
*/
|
|
19598
|
+
export interface VistasGetRequest {
|
|
19599
|
+
/**
|
|
19600
|
+
* The vista's ID.
|
|
19601
|
+
* @format id
|
|
19602
|
+
* @example "VISTA-12345"
|
|
19603
|
+
*/
|
|
19604
|
+
id: string;
|
|
19605
|
+
}
|
|
19606
|
+
/**
|
|
19607
|
+
* vistas-get-response
|
|
19608
|
+
* The response to getting a vista's information.
|
|
19609
|
+
*/
|
|
19610
|
+
export interface VistasGetResponse {
|
|
19611
|
+
/** Represents a collection of DevRev objects. */
|
|
19612
|
+
vista: Vista;
|
|
19613
|
+
}
|
|
19614
|
+
/** vistas-groups-delete-request */
|
|
19615
|
+
export interface VistasGroupsDeleteRequest {
|
|
19616
|
+
/**
|
|
19617
|
+
* ID of the vista group item to be deleted.
|
|
19618
|
+
* @format id
|
|
19619
|
+
*/
|
|
19620
|
+
id: string;
|
|
19621
|
+
}
|
|
19622
|
+
/** vistas-groups-delete-response */
|
|
19623
|
+
export type VistasGroupsDeleteResponse = object;
|
|
19624
|
+
/**
|
|
19625
|
+
* vistas-groups-get-request
|
|
19626
|
+
* The request to get a vista group item's information.
|
|
19627
|
+
*/
|
|
19628
|
+
export interface VistasGroupsGetRequest {
|
|
19629
|
+
/**
|
|
19630
|
+
* The vista group item's ID.
|
|
19631
|
+
* @format id
|
|
19632
|
+
*/
|
|
19633
|
+
id: string;
|
|
19634
|
+
}
|
|
19635
|
+
/**
|
|
19636
|
+
* vistas-groups-get-response
|
|
19637
|
+
* The response to getting a vista group item's information.
|
|
19638
|
+
*/
|
|
19639
|
+
export interface VistasGroupsGetResponse {
|
|
19640
|
+
/** Represents a vista group item. */
|
|
19641
|
+
vista_group: VistaGroup;
|
|
19642
|
+
}
|
|
19643
|
+
/** vistas-groups-list-request */
|
|
19644
|
+
export interface VistasGroupsListRequest {
|
|
19645
|
+
/** Filters for vista group items of the specific type. */
|
|
19646
|
+
type?: GroupItemType[];
|
|
19647
|
+
/**
|
|
19648
|
+
* Filter for vistas group item created by any of these users.
|
|
19649
|
+
* @example ["DEVU-12345"]
|
|
19650
|
+
*/
|
|
19651
|
+
created_by?: string[];
|
|
19652
|
+
/** Provides ways to specify date ranges on objects. */
|
|
19653
|
+
created_date?: DateFilter;
|
|
19654
|
+
/**
|
|
19655
|
+
* The cursor to resume iteration from. If not provided, then
|
|
19656
|
+
* iteration starts from the beginning.
|
|
19657
|
+
* @format text
|
|
19658
|
+
*/
|
|
19659
|
+
cursor?: string;
|
|
19660
|
+
/** Provides ways to specify date ranges on objects. */
|
|
19661
|
+
end_date?: DateFilter;
|
|
19662
|
+
/** Filters for vista group items of the specific group object type. */
|
|
19663
|
+
group_object_type?: VistaGroupItemGroupObjectType[];
|
|
19664
|
+
/**
|
|
19665
|
+
* The request to get information about a list of vista groups.
|
|
19666
|
+
* @format int32
|
|
19667
|
+
*/
|
|
19668
|
+
limit?: number;
|
|
19669
|
+
/**
|
|
19670
|
+
* The iteration mode to use. If "after", then entries after the provided
|
|
19671
|
+
* cursor will be returned, or if no cursor is provided, then from the
|
|
19672
|
+
* beginning. If "before", then entries before the provided cursor will be
|
|
19673
|
+
* returned, or if no cursor is provided, then from the end. Entries will
|
|
19674
|
+
* always be returned in the specified sort-by order.
|
|
19675
|
+
*/
|
|
19676
|
+
mode?: ListMode;
|
|
19677
|
+
/** Provides ways to specify date ranges on objects. */
|
|
19678
|
+
modified_date?: DateFilter;
|
|
19679
|
+
/**
|
|
19680
|
+
* Parent ID of the vista group item.
|
|
19681
|
+
* @example ["VISTA-12345"]
|
|
19682
|
+
*/
|
|
19683
|
+
parent_id?: string[];
|
|
19684
|
+
/** Comma-separated fields to sort the objects by. */
|
|
19685
|
+
sort_by?: string[];
|
|
19686
|
+
/** Provides ways to specify date ranges on objects. */
|
|
19687
|
+
start_date?: DateFilter;
|
|
19688
|
+
/** Denotes the state of the vista group item. */
|
|
19689
|
+
state?: VistaGroupItemState[];
|
|
19690
|
+
}
|
|
19691
|
+
/**
|
|
19692
|
+
* vistas-groups-list-response
|
|
19693
|
+
* The response to listing the vistas group items.
|
|
19694
|
+
*/
|
|
19695
|
+
export interface VistasGroupsListResponse {
|
|
19696
|
+
/**
|
|
19697
|
+
* The cursor used to iterate subsequent results in accordance to the
|
|
19698
|
+
* sort order. If not set, then no later elements exist.
|
|
19699
|
+
* @format text
|
|
19700
|
+
*/
|
|
19701
|
+
next_cursor?: string;
|
|
19702
|
+
/**
|
|
19703
|
+
* The cursor used to iterate preceding results in accordance to the
|
|
19704
|
+
* sort order. If not set, then no prior elements exist.
|
|
19705
|
+
* @format text
|
|
19706
|
+
*/
|
|
19707
|
+
prev_cursor?: string;
|
|
19708
|
+
/** List of vista group items. */
|
|
19709
|
+
vista_group?: VistaGroup[];
|
|
19710
|
+
}
|
|
19711
|
+
/**
|
|
19712
|
+
* vistas-list-request
|
|
19713
|
+
* The request to get information about a list of vistas.
|
|
19714
|
+
*/
|
|
19715
|
+
export interface VistasListRequest {
|
|
19716
|
+
/** Filters for vistas of the specific type. */
|
|
19717
|
+
type?: VistaType[];
|
|
19718
|
+
/**
|
|
19719
|
+
* Filters for vistas created by any of these users.
|
|
19720
|
+
* @example ["DEVU-12345"]
|
|
19721
|
+
*/
|
|
19722
|
+
created_by?: string[];
|
|
19723
|
+
/**
|
|
19724
|
+
* The cursor to resume iteration from. If not provided, then
|
|
19725
|
+
* iteration starts from the beginning.
|
|
19726
|
+
* @format text
|
|
19727
|
+
*/
|
|
19728
|
+
cursor?: string;
|
|
19729
|
+
/** Filters for vistas of specific flavor. */
|
|
19730
|
+
flavor?: GroupedVistaFlavor[];
|
|
19731
|
+
/** Whether the default vistas should be fetched or not. */
|
|
19732
|
+
is_default?: boolean;
|
|
19733
|
+
/**
|
|
19734
|
+
* The maximum number of vistas to return. The default is '50', the
|
|
19735
|
+
* maximum is '100'.
|
|
19736
|
+
* @format int32
|
|
19737
|
+
*/
|
|
19738
|
+
limit?: number;
|
|
19739
|
+
/**
|
|
19740
|
+
* Filters for vistas accessible to the input members.
|
|
19741
|
+
* @example ["DEVU-12345"]
|
|
19742
|
+
*/
|
|
19743
|
+
members?: string[];
|
|
19744
|
+
/**
|
|
19745
|
+
* The iteration mode to use. If "after", then entries after the provided
|
|
19746
|
+
* cursor will be returned, or if no cursor is provided, then from the
|
|
19747
|
+
* beginning. If "before", then entries before the provided cursor will be
|
|
19748
|
+
* returned, or if no cursor is provided, then from the end. Entries will
|
|
19749
|
+
* always be returned in the specified sort-by order.
|
|
19750
|
+
*/
|
|
19751
|
+
mode?: ListMode;
|
|
19752
|
+
/** Filters for vistas of specific object types like works, parts etc. */
|
|
19753
|
+
object_type?: DynamicVistaFilterType[];
|
|
19754
|
+
/** Filter for vistas accessible to the input members. */
|
|
19755
|
+
shared_with?: SharedWithMembershipFilter[];
|
|
19756
|
+
/** Denotes whether to skip items of vista_group_item in response. */
|
|
19757
|
+
skip_items?: boolean;
|
|
19758
|
+
/** Fields to sort the vistas by and the direction to sort them. */
|
|
19759
|
+
sort_by?: string[];
|
|
19760
|
+
/** Denotes the state of the vista group item. */
|
|
19761
|
+
state?: VistaGroupItemState[];
|
|
19762
|
+
}
|
|
19763
|
+
/**
|
|
19764
|
+
* vistas-list-response
|
|
19765
|
+
* The response to listing the vistas.
|
|
19766
|
+
*/
|
|
19767
|
+
export interface VistasListResponse {
|
|
19768
|
+
/**
|
|
19769
|
+
* The cursor used to iterate subsequent results in accordance to the
|
|
19770
|
+
* sort order. If not set, then no later elements exist.
|
|
19771
|
+
* @format text
|
|
19772
|
+
*/
|
|
19773
|
+
next_cursor?: string;
|
|
19774
|
+
/**
|
|
19775
|
+
* The cursor used to iterate preceding results in accordance to the
|
|
19776
|
+
* sort order. If not set, then no prior elements exist.
|
|
19777
|
+
* @format text
|
|
19778
|
+
*/
|
|
19779
|
+
prev_cursor?: string;
|
|
19780
|
+
/** The list of vistas. */
|
|
19781
|
+
vistas: Vista[];
|
|
19782
|
+
}
|
|
19372
19783
|
/**
|
|
19373
19784
|
* visualization-axis-color
|
|
19374
19785
|
* The color for an axis. This can be a single color or a gradient.
|
|
@@ -19486,6 +19897,11 @@ export type WebCrawlerJob = AtomBase & {
|
|
|
19486
19897
|
state?: WebCrawlerJobState;
|
|
19487
19898
|
/** URLs to add to the seed set of URLs to crawl from. */
|
|
19488
19899
|
urls?: string[];
|
|
19900
|
+
/**
|
|
19901
|
+
* User agent to use for crawling websites in this job.
|
|
19902
|
+
* @format text
|
|
19903
|
+
*/
|
|
19904
|
+
user_agent?: string;
|
|
19489
19905
|
};
|
|
19490
19906
|
/** State of the web crawler job. */
|
|
19491
19907
|
export declare enum WebCrawlerJobState {
|
|
@@ -19584,6 +20000,12 @@ export interface WebCrawlerJobsCreateRequest {
|
|
|
19584
20000
|
sitemap_urls?: string[];
|
|
19585
20001
|
/** The list of URLs to crawl. */
|
|
19586
20002
|
urls?: string[];
|
|
20003
|
+
/**
|
|
20004
|
+
* User agent to use for crawling websites in this job.
|
|
20005
|
+
* @format text
|
|
20006
|
+
* @maxLength 1024
|
|
20007
|
+
*/
|
|
20008
|
+
user_agent?: string;
|
|
19587
20009
|
}
|
|
19588
20010
|
/**
|
|
19589
20011
|
* web-crawler-jobs-create-response
|
|
@@ -20823,6 +21245,11 @@ export interface WorksCreateRequestTicket {
|
|
|
20823
21245
|
* @format text
|
|
20824
21246
|
*/
|
|
20825
21247
|
source_channel?: string;
|
|
21248
|
+
/**
|
|
21249
|
+
* Source channel ID of the ticket.
|
|
21250
|
+
* @format id
|
|
21251
|
+
*/
|
|
21252
|
+
source_channel_v2?: string;
|
|
20826
21253
|
}
|
|
20827
21254
|
/** works-create-response */
|
|
20828
21255
|
export interface WorksCreateResponse {
|
|
@@ -20979,6 +21406,11 @@ export interface WorksFilterTicket {
|
|
|
20979
21406
|
sla_summary?: SlaSummaryFilter;
|
|
20980
21407
|
/** Filters for tickets with any of the provided source channels. */
|
|
20981
21408
|
source_channel?: string[];
|
|
21409
|
+
/**
|
|
21410
|
+
* Filters for tickets that are associated with any of the source
|
|
21411
|
+
* channels.
|
|
21412
|
+
*/
|
|
21413
|
+
source_channel_v2?: string[];
|
|
20982
21414
|
/** Filters for tickets with any of the provided subtypes. */
|
|
20983
21415
|
subtype?: string[];
|
|
20984
21416
|
/** The filter for survey aggregation. */
|
|
@@ -21457,6 +21889,11 @@ export interface WorksUpdateRequestTicket {
|
|
|
21457
21889
|
sentiment_summary?: string;
|
|
21458
21890
|
/** Severity of the ticket. */
|
|
21459
21891
|
severity?: TicketSeverity;
|
|
21892
|
+
/**
|
|
21893
|
+
* Updates the source channel of the ticket.
|
|
21894
|
+
* @format id
|
|
21895
|
+
*/
|
|
21896
|
+
source_channel_v2?: string | null;
|
|
21460
21897
|
}
|
|
21461
21898
|
/** works-update-request-ticket-channels */
|
|
21462
21899
|
export interface WorksUpdateRequestTicketChannels {
|
|
@@ -21467,6 +21904,19 @@ export interface WorksUpdateRequestTicketChannels {
|
|
|
21467
21904
|
export interface WorksUpdateResponse {
|
|
21468
21905
|
work: Work;
|
|
21469
21906
|
}
|
|
21907
|
+
/**
|
|
21908
|
+
* works-vista-group-item
|
|
21909
|
+
* Represents a nested works vista group object.
|
|
21910
|
+
*/
|
|
21911
|
+
export type WorksVistaGroupItem = VistaGroupBase & {
|
|
21912
|
+
/** Type of works vista group item. */
|
|
21913
|
+
type: WorksVistaGroupItemType;
|
|
21914
|
+
};
|
|
21915
|
+
/** Type of works vista group item. */
|
|
21916
|
+
export declare enum WorksVistaGroupItemType {
|
|
21917
|
+
Curated = "curated",
|
|
21918
|
+
Dynamic = "dynamic"
|
|
21919
|
+
}
|
|
21470
21920
|
import { AxiosInstance, AxiosRequestConfig, AxiosResponse, ResponseType } from 'axios';
|
|
21471
21921
|
export type QueryParamsType = Record<string | number, any>;
|
|
21472
21922
|
export interface FullRequestParams extends Omit<AxiosRequestConfig, 'data' | 'params' | 'url' | 'responseType'> {
|
|
@@ -22841,6 +23291,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
22841
23291
|
'sla_summary.stage'?: SlaSummaryStage[];
|
|
22842
23292
|
/** Filters for conversations with any of the provided source channels. */
|
|
22843
23293
|
source_channel?: string[];
|
|
23294
|
+
/**
|
|
23295
|
+
* Filters for conversations that are associated with the source
|
|
23296
|
+
* channel.
|
|
23297
|
+
*/
|
|
23298
|
+
source_channel_v2?: string[];
|
|
22844
23299
|
/**
|
|
22845
23300
|
* Filters for conversations with any of the provided source channels.
|
|
22846
23301
|
* @deprecated
|
|
@@ -22995,6 +23450,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
22995
23450
|
'sla_summary.stage'?: SlaSummaryStage[];
|
|
22996
23451
|
/** Filters for conversations with any of the provided source channels. */
|
|
22997
23452
|
source_channel?: string[];
|
|
23453
|
+
/**
|
|
23454
|
+
* Filters for conversations that are associated with the source
|
|
23455
|
+
* channel.
|
|
23456
|
+
*/
|
|
23457
|
+
source_channel_v2?: string[];
|
|
22998
23458
|
/**
|
|
22999
23459
|
* Filters for conversations with any of the provided source channels.
|
|
23000
23460
|
* @deprecated
|
|
@@ -27714,6 +28174,206 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
27714
28174
|
* @secure
|
|
27715
28175
|
*/
|
|
27716
28176
|
uomsUpdate: (data: UomsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<UomsUpdateResponse, any>>;
|
|
28177
|
+
/**
|
|
28178
|
+
* @description Deletes the requested vista.
|
|
28179
|
+
*
|
|
28180
|
+
* @tags vistas
|
|
28181
|
+
* @name VistasDelete
|
|
28182
|
+
* @summary Delete Vista
|
|
28183
|
+
* @request POST:/vistas.delete
|
|
28184
|
+
* @secure
|
|
28185
|
+
*/
|
|
28186
|
+
vistasDelete: (data: VistasDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
|
|
28187
|
+
/**
|
|
28188
|
+
* @description Gets the requested vistas's information.
|
|
28189
|
+
*
|
|
28190
|
+
* @tags vistas
|
|
28191
|
+
* @name VistasGet
|
|
28192
|
+
* @summary Get Vista
|
|
28193
|
+
* @request GET:/vistas.get
|
|
28194
|
+
* @secure
|
|
28195
|
+
*/
|
|
28196
|
+
vistasGet: (query: {
|
|
28197
|
+
/**
|
|
28198
|
+
* The vista's ID.
|
|
28199
|
+
* @format id
|
|
28200
|
+
* @example "VISTA-12345"
|
|
28201
|
+
*/
|
|
28202
|
+
id: string;
|
|
28203
|
+
}, params?: RequestParams) => Promise<AxiosResponse<VistasGetResponse, any>>;
|
|
28204
|
+
/**
|
|
28205
|
+
* @description Gets the requested vistas's information.
|
|
28206
|
+
*
|
|
28207
|
+
* @tags vistas
|
|
28208
|
+
* @name VistasGetPost
|
|
28209
|
+
* @summary Get Vista (POST)
|
|
28210
|
+
* @request POST:/vistas.get
|
|
28211
|
+
* @secure
|
|
28212
|
+
*/
|
|
28213
|
+
vistasGetPost: (data: VistasGetRequest, params?: RequestParams) => Promise<AxiosResponse<VistasGetResponse, any>>;
|
|
28214
|
+
/**
|
|
28215
|
+
* @description Deletes the requested vista group item
|
|
28216
|
+
*
|
|
28217
|
+
* @tags vistas
|
|
28218
|
+
* @name VistasGroupsDelete
|
|
28219
|
+
* @summary Delete Vistas Group
|
|
28220
|
+
* @request POST:/vistas.groups.delete
|
|
28221
|
+
* @secure
|
|
28222
|
+
*/
|
|
28223
|
+
vistasGroupsDelete: (data: VistasGroupsDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
|
|
28224
|
+
/**
|
|
28225
|
+
* @description Gets the requested vista group item's information.
|
|
28226
|
+
*
|
|
28227
|
+
* @tags vistas
|
|
28228
|
+
* @name VistasGroupsGet
|
|
28229
|
+
* @summary Get Vistas Group
|
|
28230
|
+
* @request GET:/vistas.groups.get
|
|
28231
|
+
* @secure
|
|
28232
|
+
*/
|
|
28233
|
+
vistasGroupsGet: (query: {
|
|
28234
|
+
/**
|
|
28235
|
+
* The vista group item's ID.
|
|
28236
|
+
* @format id
|
|
28237
|
+
*/
|
|
28238
|
+
id: string;
|
|
28239
|
+
}, params?: RequestParams) => Promise<AxiosResponse<VistasGroupsGetResponse, any>>;
|
|
28240
|
+
/**
|
|
28241
|
+
* @description Gets the requested vista group item's information.
|
|
28242
|
+
*
|
|
28243
|
+
* @tags vistas
|
|
28244
|
+
* @name VistasGroupsGetPost
|
|
28245
|
+
* @summary Get Vistas Group (POST)
|
|
28246
|
+
* @request POST:/vistas.groups.get
|
|
28247
|
+
* @secure
|
|
28248
|
+
*/
|
|
28249
|
+
vistasGroupsGetPost: (data: VistasGroupsGetRequest, params?: RequestParams) => Promise<AxiosResponse<VistasGroupsGetResponse, any>>;
|
|
28250
|
+
/**
|
|
28251
|
+
* @description Lists the available vista group items.
|
|
28252
|
+
*
|
|
28253
|
+
* @tags vistas
|
|
28254
|
+
* @name VistasGroupsList
|
|
28255
|
+
* @summary List Vistas Groups
|
|
28256
|
+
* @request GET:/vistas.groups.list
|
|
28257
|
+
* @secure
|
|
28258
|
+
*/
|
|
28259
|
+
vistasGroupsList: (query?: {
|
|
28260
|
+
/**
|
|
28261
|
+
* Filter for vistas group item created by any of these users.
|
|
28262
|
+
* @example ["DEVU-12345"]
|
|
28263
|
+
*/
|
|
28264
|
+
created_by?: string[];
|
|
28265
|
+
/**
|
|
28266
|
+
* The cursor to resume iteration from. If not provided, then iteration
|
|
28267
|
+
* starts from the beginning.
|
|
28268
|
+
* @format text
|
|
28269
|
+
*/
|
|
28270
|
+
cursor?: string;
|
|
28271
|
+
/** Filters for vista group items of the specific group object type. */
|
|
28272
|
+
group_object_type?: VistaGroupItemGroupObjectType[];
|
|
28273
|
+
/**
|
|
28274
|
+
* The request to get information about a list of vista groups.
|
|
28275
|
+
* @format int32
|
|
28276
|
+
*/
|
|
28277
|
+
limit?: number;
|
|
28278
|
+
/**
|
|
28279
|
+
* The iteration mode to use, otherwise if not set, then "after" is
|
|
28280
|
+
* used.
|
|
28281
|
+
*/
|
|
28282
|
+
mode?: ListMode;
|
|
28283
|
+
/**
|
|
28284
|
+
* Parent ID of the vista group item.
|
|
28285
|
+
* @example ["VISTA-12345"]
|
|
28286
|
+
*/
|
|
28287
|
+
parent_id?: string[];
|
|
28288
|
+
/** Comma-separated fields to sort the objects by. */
|
|
28289
|
+
sort_by?: string[];
|
|
28290
|
+
/** Denotes the state of the vista group item. */
|
|
28291
|
+
state?: VistaGroupItemState[];
|
|
28292
|
+
/** Filters for vista group items of the specific type. */
|
|
28293
|
+
type?: GroupItemType[];
|
|
28294
|
+
}, params?: RequestParams) => Promise<AxiosResponse<VistasGroupsListResponse, any>>;
|
|
28295
|
+
/**
|
|
28296
|
+
* @description Lists the available vista group items.
|
|
28297
|
+
*
|
|
28298
|
+
* @tags vistas
|
|
28299
|
+
* @name VistasGroupsListPost
|
|
28300
|
+
* @summary List Vistas Groups (POST)
|
|
28301
|
+
* @request POST:/vistas.groups.list
|
|
28302
|
+
* @secure
|
|
28303
|
+
*/
|
|
28304
|
+
vistasGroupsListPost: (data: VistasGroupsListRequest, params?: RequestParams) => Promise<AxiosResponse<VistasGroupsListResponse, any>>;
|
|
28305
|
+
/**
|
|
28306
|
+
* @description Lists the available vistas.
|
|
28307
|
+
*
|
|
28308
|
+
* @tags vistas
|
|
28309
|
+
* @name VistasList
|
|
28310
|
+
* @summary List Vistas
|
|
28311
|
+
* @request GET:/vistas.list
|
|
28312
|
+
* @secure
|
|
28313
|
+
*/
|
|
28314
|
+
vistasList: (query?: {
|
|
28315
|
+
/**
|
|
28316
|
+
* Filters for vistas created by any of these users.
|
|
28317
|
+
* @example ["DEVU-12345"]
|
|
28318
|
+
*/
|
|
28319
|
+
created_by?: string[];
|
|
28320
|
+
/**
|
|
28321
|
+
* The cursor to resume iteration from. If not provided, then iteration
|
|
28322
|
+
* starts from the beginning.
|
|
28323
|
+
* @format text
|
|
28324
|
+
*/
|
|
28325
|
+
cursor?: string;
|
|
28326
|
+
/** Filters for vistas of specific flavor. */
|
|
28327
|
+
flavor?: GroupedVistaFlavor[];
|
|
28328
|
+
/** Whether the default vistas should be fetched or not. */
|
|
28329
|
+
is_default?: boolean;
|
|
28330
|
+
/**
|
|
28331
|
+
* The maximum number of vistas to return. The default is '50', the
|
|
28332
|
+
* maximum is '100'.
|
|
28333
|
+
* @format int32
|
|
28334
|
+
*/
|
|
28335
|
+
limit?: number;
|
|
28336
|
+
/**
|
|
28337
|
+
* Filters for vistas accessible to the input members.
|
|
28338
|
+
* @example ["DEVU-12345"]
|
|
28339
|
+
*/
|
|
28340
|
+
members?: string[];
|
|
28341
|
+
/**
|
|
28342
|
+
* The iteration mode to use, otherwise if not set, then "after" is
|
|
28343
|
+
* used.
|
|
28344
|
+
*/
|
|
28345
|
+
mode?: ListMode;
|
|
28346
|
+
/** Filters for vistas of specific object types like works, parts etc. */
|
|
28347
|
+
object_type?: DynamicVistaFilterType[];
|
|
28348
|
+
/**
|
|
28349
|
+
* ID of the group/member with whom the item is shared.
|
|
28350
|
+
* @format id
|
|
28351
|
+
*/
|
|
28352
|
+
'shared_with.member'?: string;
|
|
28353
|
+
/**
|
|
28354
|
+
* Role ID of the group/member with whom the item is shared.
|
|
28355
|
+
* @format id
|
|
28356
|
+
*/
|
|
28357
|
+
'shared_with.role'?: string;
|
|
28358
|
+
/** Denotes whether to skip items of vista_group_item in response. */
|
|
28359
|
+
skip_items?: boolean;
|
|
28360
|
+
/** Fields to sort the vistas by and the direction to sort them. */
|
|
28361
|
+
sort_by?: string[];
|
|
28362
|
+
/** Denotes the state of the vista group item. */
|
|
28363
|
+
state?: VistaGroupItemState[];
|
|
28364
|
+
/** Filters for vistas of the specific type. */
|
|
28365
|
+
type?: VistaType[];
|
|
28366
|
+
}, params?: RequestParams) => Promise<AxiosResponse<VistasListResponse, any>>;
|
|
28367
|
+
/**
|
|
28368
|
+
* @description Lists the available vistas.
|
|
28369
|
+
*
|
|
28370
|
+
* @tags vistas
|
|
28371
|
+
* @name VistasListPost
|
|
28372
|
+
* @summary List Vistas (POST)
|
|
28373
|
+
* @request POST:/vistas.list
|
|
28374
|
+
* @secure
|
|
28375
|
+
*/
|
|
28376
|
+
vistasListPost: (data: VistasListRequest, params?: RequestParams) => Promise<AxiosResponse<VistasListResponse, any>>;
|
|
27717
28377
|
/**
|
|
27718
28378
|
* @description Change state of a web crawler job to pause or resume it back to running.
|
|
27719
28379
|
*
|
|
@@ -28078,6 +28738,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
28078
28738
|
'ticket.sla_summary.stage'?: SlaSummaryStage[];
|
|
28079
28739
|
/** Filters for tickets with any of the provided source channels. */
|
|
28080
28740
|
'ticket.source_channel'?: string[];
|
|
28741
|
+
/**
|
|
28742
|
+
* Filters for tickets that are associated with any of the source
|
|
28743
|
+
* channels.
|
|
28744
|
+
*/
|
|
28745
|
+
'ticket.source_channel_v2'?: string[];
|
|
28081
28746
|
/** Filters for tickets with any of the provided subtypes. */
|
|
28082
28747
|
'ticket.subtype'?: string[];
|
|
28083
28748
|
/** Filters for work of the provided types. */
|
|
@@ -28262,6 +28927,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
28262
28927
|
'ticket.sla_summary.stage'?: SlaSummaryStage[];
|
|
28263
28928
|
/** Filters for tickets with any of the provided source channels. */
|
|
28264
28929
|
'ticket.source_channel'?: string[];
|
|
28930
|
+
/**
|
|
28931
|
+
* Filters for tickets that are associated with any of the source
|
|
28932
|
+
* channels.
|
|
28933
|
+
*/
|
|
28934
|
+
'ticket.source_channel_v2'?: string[];
|
|
28265
28935
|
/** Filters for tickets with any of the provided subtypes. */
|
|
28266
28936
|
'ticket.subtype'?: string[];
|
|
28267
28937
|
/** Filters for work of the provided types. */
|