@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.
@@ -21,6 +21,7 @@ export type Account = OrgBase & {
21
21
  external_refs?: string[];
22
22
  /** List of Dev user IDs owning this Account. */
23
23
  owned_by: UserSummary[];
24
+ primary_account?: AccountSummary;
24
25
  /**
25
26
  * The Tier of the corresponding Account.
26
27
  * @format text
@@ -1621,6 +1622,8 @@ export declare enum AuthTokenTokenType {
1621
1622
  * Carries account info.
1622
1623
  */
1623
1624
  export interface AuthTokensAccountTraits {
1625
+ /** Application-defined custom fields of the account. */
1626
+ custom_fields?: object;
1624
1627
  /**
1625
1628
  * The display name of the account.
1626
1629
  * @format text
@@ -2654,6 +2657,11 @@ export type Conversation = AtomBase & {
2654
2657
  /** SLA summary for the object. */
2655
2658
  sla_summary?: ArchetypeSlaSummary;
2656
2659
  sla_tracker?: SlaTrackerSummary;
2660
+ /**
2661
+ * Source channel for the conversation.
2662
+ * @format text
2663
+ */
2664
+ source_channel?: string;
2657
2665
  /** Describes the current stage of a work item. */
2658
2666
  stage?: LegacyStage;
2659
2667
  /** Tags associated with the object. */
@@ -2735,6 +2743,11 @@ export interface ConversationsCreateRequest {
2735
2743
  * @format text
2736
2744
  */
2737
2745
  source_channel?: string;
2746
+ /**
2747
+ * Source channel ID of the conversation.
2748
+ * @format id
2749
+ */
2750
+ source_channel_v2?: string;
2738
2751
  /** Sets an object's initial stage. */
2739
2752
  stage?: StageInit;
2740
2753
  /** Tags associated with the conversation. */
@@ -2883,6 +2896,11 @@ export interface ConversationsListRequest {
2883
2896
  sla_summary?: SlaSummaryFilter;
2884
2897
  /** Filters for conversations with any of the provided source channels. */
2885
2898
  source_channel?: string[];
2899
+ /**
2900
+ * Filters for conversations that are associated with the source
2901
+ * channel.
2902
+ */
2903
+ source_channel_v2?: string[];
2886
2904
  /**
2887
2905
  * Filters for conversations with any of the provided source channels.
2888
2906
  * @deprecated
@@ -2966,6 +2984,11 @@ export interface ConversationsUpdateRequest {
2966
2984
  members?: ConversationsUpdateRequestMembers;
2967
2985
  metadata?: ConversationsUpdateRequestMetadata;
2968
2986
  owned_by?: ConversationsUpdateRequestOwnedBy;
2987
+ /**
2988
+ * Source channel ID of the conversation.
2989
+ * @format id
2990
+ */
2991
+ source_channel_v2?: string;
2969
2992
  /** Updates an object's stage. */
2970
2993
  stage?: StageUpdate;
2971
2994
  /**
@@ -3036,6 +3059,19 @@ export interface ConversationsUpdateRequestUserSessions {
3036
3059
  export interface ConversationsUpdateResponse {
3037
3060
  conversation: Conversation;
3038
3061
  }
3062
+ /**
3063
+ * conversations-vista-group-item
3064
+ * Represents a nested conversations vista group object.
3065
+ */
3066
+ export type ConversationsVistaGroupItem = VistaGroupBase & {
3067
+ /** Type of conversations vista group item. */
3068
+ type: ConversationsVistaGroupItemType;
3069
+ };
3070
+ /** Type of conversations vista group item. */
3071
+ export declare enum ConversationsVistaGroupItemType {
3072
+ Curated = "curated",
3073
+ Dynamic = "dynamic"
3074
+ }
3039
3075
  /** create-command-action */
3040
3076
  export interface CreateCommandAction {
3041
3077
  action_details?: CreateCommandActionDetails;
@@ -3125,6 +3161,14 @@ export interface CreateWeeklyOrgScheduleInterval {
3125
3161
  */
3126
3162
  to: number;
3127
3163
  }
3164
+ /**
3165
+ * curated-vista
3166
+ * Static collection of DevRev objects.
3167
+ */
3168
+ export type CuratedVista = VistaBase & {
3169
+ /** Item list to store a curated list of DevRev objects. */
3170
+ items?: AtomSummary[];
3171
+ };
3128
3172
  /**
3129
3173
  * custom-schema-spec
3130
3174
  * Custom schemas described using identifiers. Each custom field in the
@@ -4284,6 +4328,32 @@ export type DirectorySummary = AtomBaseSummary;
4284
4328
  * Information to define dynamic groups.
4285
4329
  */
4286
4330
  export type DynamicGroupInfo = object;
4331
+ /**
4332
+ * dynamic-vista
4333
+ * Dynamic collection of DevRev objects, all adhering to a specific
4334
+ * filter.
4335
+ */
4336
+ export type DynamicVista = VistaBase & {
4337
+ /** Type of DevRev object for which the vista is applicable. */
4338
+ filter_type: DynamicVistaFilterType;
4339
+ };
4340
+ /** Type of DevRev object for which the vista is applicable. */
4341
+ export declare enum DynamicVistaFilterType {
4342
+ Accounts = "accounts",
4343
+ Articles = "articles",
4344
+ Conversations = "conversations",
4345
+ Credits = "credits",
4346
+ CustomObjects = "custom_objects",
4347
+ DevUsers = "dev_users",
4348
+ Incidents = "incidents",
4349
+ Invoices = "invoices",
4350
+ Meetings = "meetings",
4351
+ Parts = "parts",
4352
+ Quotes = "quotes",
4353
+ RevOrgs = "rev_orgs",
4354
+ RevUsers = "rev_users",
4355
+ Works = "works"
4356
+ }
4287
4357
  /** empty */
4288
4358
  export type Empty = object;
4289
4359
  /** enhancement */
@@ -5385,6 +5455,11 @@ export declare enum GroupIngestionSource {
5385
5455
  Airdrop = "airdrop",
5386
5456
  Scim = "scim"
5387
5457
  }
5458
+ /** Type of the vista group item object. */
5459
+ export declare enum GroupItemType {
5460
+ Curated = "curated",
5461
+ Dynamic = "dynamic"
5462
+ }
5388
5463
  /** Type of the members in the group. */
5389
5464
  export declare enum GroupMemberType {
5390
5465
  DevUser = "dev_user",
@@ -5508,6 +5583,28 @@ export declare enum GroupType {
5508
5583
  Dynamic = "dynamic",
5509
5584
  Static = "static"
5510
5585
  }
5586
+ /**
5587
+ * grouped-vista
5588
+ * Represents a group of multiple vistas as a single unit.
5589
+ */
5590
+ export type GroupedVista = VistaBase & {
5591
+ /** Type of DevRev object for which the grouped vista is applicable. */
5592
+ filter_type: GroupedVistaFilterType;
5593
+ /** Denotes the use case of the grouped vista. */
5594
+ flavor?: GroupedVistaFlavor;
5595
+ };
5596
+ /** Type of DevRev object for which the grouped vista is applicable. */
5597
+ export declare enum GroupedVistaFilterType {
5598
+ Conversations = "conversations",
5599
+ Parts = "parts",
5600
+ Works = "works"
5601
+ }
5602
+ /** Denotes the use case of the grouped vista. */
5603
+ export declare enum GroupedVistaFlavor {
5604
+ Nnl = "nnl",
5605
+ SprintBoard = "sprint_board",
5606
+ SupportInbox = "support_inbox"
5607
+ }
5511
5608
  /**
5512
5609
  * groups-create-request
5513
5610
  * A request to create a new group.
@@ -6235,7 +6332,7 @@ export interface MeetingsCreateRequest {
6235
6332
  * @format date-time
6236
6333
  * @example "2023-01-01T12:00:00.000Z"
6237
6334
  */
6238
- scheduled_date: string;
6335
+ scheduled_date?: string;
6239
6336
  /** The state of meeting. */
6240
6337
  state: MeetingState;
6241
6338
  /** Tags associated with the meeting. */
@@ -7425,6 +7522,19 @@ export interface PartsUpdateRequestTags {
7425
7522
  export interface PartsUpdateResponse {
7426
7523
  part: Part;
7427
7524
  }
7525
+ /**
7526
+ * parts-vista-group-item
7527
+ * Represents a nested parts vista group object.
7528
+ */
7529
+ export type PartsVistaGroupItem = VistaGroupBase & {
7530
+ /** Type of parts vista group item. */
7531
+ type: PartsVistaGroupItemType;
7532
+ };
7533
+ /** Type of parts vista group item. */
7534
+ export declare enum PartsVistaGroupItemType {
7535
+ Curated = "curated",
7536
+ Dynamic = "dynamic"
7537
+ }
7428
7538
  /** product */
7429
7539
  export type Product = PartBase;
7430
7540
  /** product-summary */
@@ -7583,6 +7693,7 @@ export type RevOrg = OrgBase & {
7583
7693
  * @format text
7584
7694
  */
7585
7695
  external_ref?: string;
7696
+ primary_rev_org?: OrgSummary;
7586
7697
  };
7587
7698
  /** rev-org-summary */
7588
7699
  export type RevOrgSummary = OrgBaseSummary;
@@ -10838,6 +10949,7 @@ export type UserBase = AtomBase & {
10838
10949
  full_name?: string;
10839
10950
  /** Phone numbers of the user. */
10840
10951
  phone_numbers?: string[];
10952
+ primary_identity?: UserSummary;
10841
10953
  /** State of the user. */
10842
10954
  state?: UserState;
10843
10955
  };
@@ -10892,6 +11004,100 @@ export declare enum UserType {
10892
11004
  ServiceAccount = "service_account",
10893
11005
  SysUser = "sys_user"
10894
11006
  }
11007
+ /**
11008
+ * vista
11009
+ * Represents a collection of DevRev objects.
11010
+ */
11011
+ export type Vista = (CuratedVista | DynamicVista | GroupedVista) & {
11012
+ /** Type of vista object. */
11013
+ type: VistaType;
11014
+ };
11015
+ /** vista-base */
11016
+ export type VistaBase = AtomBase & {
11017
+ /** Boolean to specify whether it's a default Vista or not. */
11018
+ is_default?: boolean;
11019
+ /**
11020
+ * Name of the vista.
11021
+ * @format text
11022
+ */
11023
+ name: string;
11024
+ /** Users and groups associated with vista. */
11025
+ shared_with?: SharedWithMembership[];
11026
+ };
11027
+ /** Denotes the use case of the vista. */
11028
+ export declare enum VistaFlavor {
11029
+ Nnl = "nnl",
11030
+ SprintBoard = "sprint_board",
11031
+ SupportInbox = "support_inbox"
11032
+ }
11033
+ /**
11034
+ * vista-group
11035
+ * Represents a vista group item.
11036
+ */
11037
+ export type VistaGroup = (ConversationsVistaGroupItem | PartsVistaGroupItem | WorksVistaGroupItem) & {
11038
+ /** Type of DevRev object for which the grouped vista is applicable. */
11039
+ object_type: GroupedVistaFilterType;
11040
+ };
11041
+ /** vista-group-base */
11042
+ export interface VistaGroupBase {
11043
+ /**
11044
+ * Timestamp when the vista group item ends.
11045
+ * @format date-time
11046
+ * @example "2023-01-01T12:00:00.000Z"
11047
+ */
11048
+ end_date?: string;
11049
+ /**
11050
+ * Globally unique object ID.
11051
+ * @format id
11052
+ */
11053
+ id: string;
11054
+ /**
11055
+ * Name of the group.
11056
+ * @format text
11057
+ */
11058
+ name: string;
11059
+ parent?: VistaGroupBaseVistaParentComposite;
11060
+ /**
11061
+ * Timestamp when the vista group item starts.
11062
+ * @format date-time
11063
+ * @example "2023-01-01T12:00:00.000Z"
11064
+ */
11065
+ start_date?: string;
11066
+ /** Defines the state of the group item. */
11067
+ state?: VistaGroupItemState;
11068
+ }
11069
+ /** vista-group-base-vista-parent-composite */
11070
+ export interface VistaGroupBaseVistaParentComposite {
11071
+ /**
11072
+ * Type of the parent vista.
11073
+ * @format text
11074
+ */
11075
+ type: string;
11076
+ /**
11077
+ * Human-readable object ID unique to the Dev organization.
11078
+ * @format text
11079
+ */
11080
+ display_id: string;
11081
+ /** Denotes the use case of the vista. */
11082
+ flavor?: VistaFlavor;
11083
+ /**
11084
+ * Parent vista ID.
11085
+ * @format id
11086
+ * @example "VISTA-12345"
11087
+ */
11088
+ id: string;
11089
+ /**
11090
+ * Name of the parent vista.
11091
+ * @format text
11092
+ */
11093
+ name: string;
11094
+ }
11095
+ /** Type of DevRev object for which the vista group item is applicable. */
11096
+ export declare enum VistaGroupItemGroupObjectType {
11097
+ Conversation = "conversation",
11098
+ Part = "part",
11099
+ Work = "work"
11100
+ }
10895
11101
  /** Defines the state of the group item. */
10896
11102
  export declare enum VistaGroupItemState {
10897
11103
  Active = "active",
@@ -10935,6 +11141,218 @@ export declare enum VistaGroupItemType {
10935
11141
  Curated = "curated",
10936
11142
  Dynamic = "dynamic"
10937
11143
  }
11144
+ /** Type of vista object. */
11145
+ export declare enum VistaType {
11146
+ Curated = "curated",
11147
+ Dynamic = "dynamic",
11148
+ Grouped = "grouped"
11149
+ }
11150
+ /**
11151
+ * vistas-delete-request
11152
+ * The request to delete a vista.
11153
+ */
11154
+ export interface VistasDeleteRequest {
11155
+ /**
11156
+ * The ID of the vista to delete.
11157
+ * @format id
11158
+ * @example "VISTA-12345"
11159
+ */
11160
+ id: string;
11161
+ }
11162
+ /**
11163
+ * vistas-delete-response
11164
+ * The response when deleting a vista.
11165
+ */
11166
+ export type VistasDeleteResponse = object;
11167
+ /**
11168
+ * vistas-get-request
11169
+ * The request to get a vista's information.
11170
+ */
11171
+ export interface VistasGetRequest {
11172
+ /**
11173
+ * The vista's ID.
11174
+ * @format id
11175
+ * @example "VISTA-12345"
11176
+ */
11177
+ id: string;
11178
+ }
11179
+ /**
11180
+ * vistas-get-response
11181
+ * The response to getting a vista's information.
11182
+ */
11183
+ export interface VistasGetResponse {
11184
+ /** Represents a collection of DevRev objects. */
11185
+ vista: Vista;
11186
+ }
11187
+ /** vistas-groups-delete-request */
11188
+ export interface VistasGroupsDeleteRequest {
11189
+ /**
11190
+ * ID of the vista group item to be deleted.
11191
+ * @format id
11192
+ */
11193
+ id: string;
11194
+ }
11195
+ /** vistas-groups-delete-response */
11196
+ export type VistasGroupsDeleteResponse = object;
11197
+ /**
11198
+ * vistas-groups-get-request
11199
+ * The request to get a vista group item's information.
11200
+ */
11201
+ export interface VistasGroupsGetRequest {
11202
+ /**
11203
+ * The vista group item's ID.
11204
+ * @format id
11205
+ */
11206
+ id: string;
11207
+ }
11208
+ /**
11209
+ * vistas-groups-get-response
11210
+ * The response to getting a vista group item's information.
11211
+ */
11212
+ export interface VistasGroupsGetResponse {
11213
+ /** Represents a vista group item. */
11214
+ vista_group: VistaGroup;
11215
+ }
11216
+ /** vistas-groups-list-request */
11217
+ export interface VistasGroupsListRequest {
11218
+ /** Filters for vista group items of the specific type. */
11219
+ type?: GroupItemType[];
11220
+ /**
11221
+ * Filter for vistas group item created by any of these users.
11222
+ * @example ["DEVU-12345"]
11223
+ */
11224
+ created_by?: string[];
11225
+ /** Provides ways to specify date ranges on objects. */
11226
+ created_date?: DateFilter;
11227
+ /**
11228
+ * The cursor to resume iteration from. If not provided, then
11229
+ * iteration starts from the beginning.
11230
+ * @format text
11231
+ */
11232
+ cursor?: string;
11233
+ /** Provides ways to specify date ranges on objects. */
11234
+ end_date?: DateFilter;
11235
+ /** Filters for vista group items of the specific group object type. */
11236
+ group_object_type?: VistaGroupItemGroupObjectType[];
11237
+ /**
11238
+ * The request to get information about a list of vista groups.
11239
+ * @format int32
11240
+ */
11241
+ limit?: number;
11242
+ /**
11243
+ * The iteration mode to use. If "after", then entries after the provided
11244
+ * cursor will be returned, or if no cursor is provided, then from the
11245
+ * beginning. If "before", then entries before the provided cursor will be
11246
+ * returned, or if no cursor is provided, then from the end. Entries will
11247
+ * always be returned in the specified sort-by order.
11248
+ */
11249
+ mode?: ListMode;
11250
+ /** Provides ways to specify date ranges on objects. */
11251
+ modified_date?: DateFilter;
11252
+ /**
11253
+ * Parent ID of the vista group item.
11254
+ * @example ["VISTA-12345"]
11255
+ */
11256
+ parent_id?: string[];
11257
+ /** Comma-separated fields to sort the objects by. */
11258
+ sort_by?: string[];
11259
+ /** Provides ways to specify date ranges on objects. */
11260
+ start_date?: DateFilter;
11261
+ /** Denotes the state of the vista group item. */
11262
+ state?: VistaGroupItemState[];
11263
+ }
11264
+ /**
11265
+ * vistas-groups-list-response
11266
+ * The response to listing the vistas group items.
11267
+ */
11268
+ export interface VistasGroupsListResponse {
11269
+ /**
11270
+ * The cursor used to iterate subsequent results in accordance to the
11271
+ * sort order. If not set, then no later elements exist.
11272
+ * @format text
11273
+ */
11274
+ next_cursor?: string;
11275
+ /**
11276
+ * The cursor used to iterate preceding results in accordance to the
11277
+ * sort order. If not set, then no prior elements exist.
11278
+ * @format text
11279
+ */
11280
+ prev_cursor?: string;
11281
+ /** List of vista group items. */
11282
+ vista_group?: VistaGroup[];
11283
+ }
11284
+ /**
11285
+ * vistas-list-request
11286
+ * The request to get information about a list of vistas.
11287
+ */
11288
+ export interface VistasListRequest {
11289
+ /** Filters for vistas of the specific type. */
11290
+ type?: VistaType[];
11291
+ /**
11292
+ * Filters for vistas created by any of these users.
11293
+ * @example ["DEVU-12345"]
11294
+ */
11295
+ created_by?: string[];
11296
+ /**
11297
+ * The cursor to resume iteration from. If not provided, then
11298
+ * iteration starts from the beginning.
11299
+ * @format text
11300
+ */
11301
+ cursor?: string;
11302
+ /** Filters for vistas of specific flavor. */
11303
+ flavor?: GroupedVistaFlavor[];
11304
+ /** Whether the default vistas should be fetched or not. */
11305
+ is_default?: boolean;
11306
+ /**
11307
+ * The maximum number of vistas to return. The default is '50', the
11308
+ * maximum is '100'.
11309
+ * @format int32
11310
+ */
11311
+ limit?: number;
11312
+ /**
11313
+ * Filters for vistas accessible to the input members.
11314
+ * @example ["DEVU-12345"]
11315
+ */
11316
+ members?: string[];
11317
+ /**
11318
+ * The iteration mode to use. If "after", then entries after the provided
11319
+ * cursor will be returned, or if no cursor is provided, then from the
11320
+ * beginning. If "before", then entries before the provided cursor will be
11321
+ * returned, or if no cursor is provided, then from the end. Entries will
11322
+ * always be returned in the specified sort-by order.
11323
+ */
11324
+ mode?: ListMode;
11325
+ /** Filters for vistas of specific object types like works, parts etc. */
11326
+ object_type?: DynamicVistaFilterType[];
11327
+ /** Filter for vistas accessible to the input members. */
11328
+ shared_with?: SharedWithMembershipFilter[];
11329
+ /** Denotes whether to skip items of vista_group_item in response. */
11330
+ skip_items?: boolean;
11331
+ /** Fields to sort the vistas by and the direction to sort them. */
11332
+ sort_by?: string[];
11333
+ /** Denotes the state of the vista group item. */
11334
+ state?: VistaGroupItemState[];
11335
+ }
11336
+ /**
11337
+ * vistas-list-response
11338
+ * The response to listing the vistas.
11339
+ */
11340
+ export interface VistasListResponse {
11341
+ /**
11342
+ * The cursor used to iterate subsequent results in accordance to the
11343
+ * sort order. If not set, then no later elements exist.
11344
+ * @format text
11345
+ */
11346
+ next_cursor?: string;
11347
+ /**
11348
+ * The cursor used to iterate preceding results in accordance to the
11349
+ * sort order. If not set, then no prior elements exist.
11350
+ * @format text
11351
+ */
11352
+ prev_cursor?: string;
11353
+ /** The list of vistas. */
11354
+ vistas: Vista[];
11355
+ }
10938
11356
  /** web-crawler-job */
10939
11357
  export type WebCrawlerJob = AtomBase & {
10940
11358
  /**
@@ -11005,6 +11423,11 @@ export type WebCrawlerJob = AtomBase & {
11005
11423
  state?: WebCrawlerJobState;
11006
11424
  /** URLs to add to the seed set of URLs to crawl from. */
11007
11425
  urls?: string[];
11426
+ /**
11427
+ * User agent to use for crawling websites in this job.
11428
+ * @format text
11429
+ */
11430
+ user_agent?: string;
11008
11431
  };
11009
11432
  /** State of the web crawler job. */
11010
11433
  export declare enum WebCrawlerJobState {
@@ -11103,6 +11526,12 @@ export interface WebCrawlerJobsCreateRequest {
11103
11526
  sitemap_urls?: string[];
11104
11527
  /** The list of URLs to crawl. */
11105
11528
  urls?: string[];
11529
+ /**
11530
+ * User agent to use for crawling websites in this job.
11531
+ * @format text
11532
+ * @maxLength 1024
11533
+ */
11534
+ user_agent?: string;
11106
11535
  }
11107
11536
  /**
11108
11537
  * web-crawler-jobs-create-response
@@ -11732,6 +12161,11 @@ export interface WorksCreateRequestTicket {
11732
12161
  * @format text
11733
12162
  */
11734
12163
  source_channel?: string;
12164
+ /**
12165
+ * Source channel ID of the ticket.
12166
+ * @format id
12167
+ */
12168
+ source_channel_v2?: string;
11735
12169
  }
11736
12170
  /** works-create-response */
11737
12171
  export interface WorksCreateResponse {
@@ -11863,6 +12297,11 @@ export interface WorksFilterTicket {
11863
12297
  sla_summary?: SlaSummaryFilter;
11864
12298
  /** Filters for tickets with any of the provided source channels. */
11865
12299
  source_channel?: string[];
12300
+ /**
12301
+ * Filters for tickets that are associated with any of the source
12302
+ * channels.
12303
+ */
12304
+ source_channel_v2?: string[];
11866
12305
  /** The filter for survey aggregation. */
11867
12306
  surveys?: SurveyAggregationFilter;
11868
12307
  }
@@ -11934,6 +12373,8 @@ export interface WorksListRequest {
11934
12373
  * @example ["DEVU-12345"]
11935
12374
  */
11936
12375
  reported_by?: string[];
12376
+ /** Fields to sort the works by and the direction to sort them. */
12377
+ sort_by?: string[];
11937
12378
  /** The filter for stages. */
11938
12379
  stage?: StageFilter;
11939
12380
  staged_info?: StagedInfoFilter;
@@ -12222,6 +12663,11 @@ export interface WorksUpdateRequestTicket {
12222
12663
  sentiment_summary?: string;
12223
12664
  /** Severity of the ticket. */
12224
12665
  severity?: TicketSeverity;
12666
+ /**
12667
+ * Updates the source channel of the ticket.
12668
+ * @format id
12669
+ */
12670
+ source_channel_v2?: string | null;
12225
12671
  }
12226
12672
  /** works-update-request-ticket-channels */
12227
12673
  export interface WorksUpdateRequestTicketChannels {
@@ -12232,6 +12678,19 @@ export interface WorksUpdateRequestTicketChannels {
12232
12678
  export interface WorksUpdateResponse {
12233
12679
  work: Work;
12234
12680
  }
12681
+ /**
12682
+ * works-vista-group-item
12683
+ * Represents a nested works vista group object.
12684
+ */
12685
+ export type WorksVistaGroupItem = VistaGroupBase & {
12686
+ /** Type of works vista group item. */
12687
+ type: WorksVistaGroupItemType;
12688
+ };
12689
+ /** Type of works vista group item. */
12690
+ export declare enum WorksVistaGroupItemType {
12691
+ Curated = "curated",
12692
+ Dynamic = "dynamic"
12693
+ }
12235
12694
  import { AxiosInstance, AxiosRequestConfig, AxiosResponse, ResponseType } from 'axios';
12236
12695
  export type QueryParamsType = Record<string | number, any>;
12237
12696
  export interface FullRequestParams extends Omit<AxiosRequestConfig, 'data' | 'params' | 'url' | 'responseType'> {
@@ -13278,6 +13737,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
13278
13737
  'sla_summary.stage'?: SlaSummaryStage[];
13279
13738
  /** Filters for conversations with any of the provided source channels. */
13280
13739
  source_channel?: string[];
13740
+ /**
13741
+ * Filters for conversations that are associated with the source
13742
+ * channel.
13743
+ */
13744
+ source_channel_v2?: string[];
13281
13745
  /**
13282
13746
  * Filters for conversations with any of the provided source channels.
13283
13747
  * @deprecated
@@ -15859,6 +16323,206 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
15859
16323
  * @secure
15860
16324
  */
15861
16325
  timelineEntriesUpdate: (data: TimelineEntriesUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<TimelineEntriesUpdateResponse, any>>;
16326
+ /**
16327
+ * @description Deletes the requested vista.
16328
+ *
16329
+ * @tags vistas
16330
+ * @name VistasDelete
16331
+ * @summary Delete Vista
16332
+ * @request POST:/vistas.delete
16333
+ * @secure
16334
+ */
16335
+ vistasDelete: (data: VistasDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
16336
+ /**
16337
+ * @description Gets the requested vistas's information.
16338
+ *
16339
+ * @tags vistas
16340
+ * @name VistasGet
16341
+ * @summary Get Vista
16342
+ * @request GET:/vistas.get
16343
+ * @secure
16344
+ */
16345
+ vistasGet: (query: {
16346
+ /**
16347
+ * The vista's ID.
16348
+ * @format id
16349
+ * @example "VISTA-12345"
16350
+ */
16351
+ id: string;
16352
+ }, params?: RequestParams) => Promise<AxiosResponse<VistasGetResponse, any>>;
16353
+ /**
16354
+ * @description Gets the requested vistas's information.
16355
+ *
16356
+ * @tags vistas
16357
+ * @name VistasGetPost
16358
+ * @summary Get Vista (POST)
16359
+ * @request POST:/vistas.get
16360
+ * @secure
16361
+ */
16362
+ vistasGetPost: (data: VistasGetRequest, params?: RequestParams) => Promise<AxiosResponse<VistasGetResponse, any>>;
16363
+ /**
16364
+ * @description Deletes the requested vista group item
16365
+ *
16366
+ * @tags vistas
16367
+ * @name VistasGroupsDelete
16368
+ * @summary Delete Vistas Group
16369
+ * @request POST:/vistas.groups.delete
16370
+ * @secure
16371
+ */
16372
+ vistasGroupsDelete: (data: VistasGroupsDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
16373
+ /**
16374
+ * @description Gets the requested vista group item's information.
16375
+ *
16376
+ * @tags vistas
16377
+ * @name VistasGroupsGet
16378
+ * @summary Get Vistas Group
16379
+ * @request GET:/vistas.groups.get
16380
+ * @secure
16381
+ */
16382
+ vistasGroupsGet: (query: {
16383
+ /**
16384
+ * The vista group item's ID.
16385
+ * @format id
16386
+ */
16387
+ id: string;
16388
+ }, params?: RequestParams) => Promise<AxiosResponse<VistasGroupsGetResponse, any>>;
16389
+ /**
16390
+ * @description Gets the requested vista group item's information.
16391
+ *
16392
+ * @tags vistas
16393
+ * @name VistasGroupsGetPost
16394
+ * @summary Get Vistas Group (POST)
16395
+ * @request POST:/vistas.groups.get
16396
+ * @secure
16397
+ */
16398
+ vistasGroupsGetPost: (data: VistasGroupsGetRequest, params?: RequestParams) => Promise<AxiosResponse<VistasGroupsGetResponse, any>>;
16399
+ /**
16400
+ * @description Lists the available vista group items.
16401
+ *
16402
+ * @tags vistas
16403
+ * @name VistasGroupsList
16404
+ * @summary List Vistas Groups
16405
+ * @request GET:/vistas.groups.list
16406
+ * @secure
16407
+ */
16408
+ vistasGroupsList: (query?: {
16409
+ /**
16410
+ * Filter for vistas group item created by any of these users.
16411
+ * @example ["DEVU-12345"]
16412
+ */
16413
+ created_by?: string[];
16414
+ /**
16415
+ * The cursor to resume iteration from. If not provided, then iteration
16416
+ * starts from the beginning.
16417
+ * @format text
16418
+ */
16419
+ cursor?: string;
16420
+ /** Filters for vista group items of the specific group object type. */
16421
+ group_object_type?: VistaGroupItemGroupObjectType[];
16422
+ /**
16423
+ * The request to get information about a list of vista groups.
16424
+ * @format int32
16425
+ */
16426
+ limit?: number;
16427
+ /**
16428
+ * The iteration mode to use, otherwise if not set, then "after" is
16429
+ * used.
16430
+ */
16431
+ mode?: ListMode;
16432
+ /**
16433
+ * Parent ID of the vista group item.
16434
+ * @example ["VISTA-12345"]
16435
+ */
16436
+ parent_id?: string[];
16437
+ /** Comma-separated fields to sort the objects by. */
16438
+ sort_by?: string[];
16439
+ /** Denotes the state of the vista group item. */
16440
+ state?: VistaGroupItemState[];
16441
+ /** Filters for vista group items of the specific type. */
16442
+ type?: GroupItemType[];
16443
+ }, params?: RequestParams) => Promise<AxiosResponse<VistasGroupsListResponse, any>>;
16444
+ /**
16445
+ * @description Lists the available vista group items.
16446
+ *
16447
+ * @tags vistas
16448
+ * @name VistasGroupsListPost
16449
+ * @summary List Vistas Groups (POST)
16450
+ * @request POST:/vistas.groups.list
16451
+ * @secure
16452
+ */
16453
+ vistasGroupsListPost: (data: VistasGroupsListRequest, params?: RequestParams) => Promise<AxiosResponse<VistasGroupsListResponse, any>>;
16454
+ /**
16455
+ * @description Lists the available vistas.
16456
+ *
16457
+ * @tags vistas
16458
+ * @name VistasList
16459
+ * @summary List Vistas
16460
+ * @request GET:/vistas.list
16461
+ * @secure
16462
+ */
16463
+ vistasList: (query?: {
16464
+ /**
16465
+ * Filters for vistas created by any of these users.
16466
+ * @example ["DEVU-12345"]
16467
+ */
16468
+ created_by?: string[];
16469
+ /**
16470
+ * The cursor to resume iteration from. If not provided, then iteration
16471
+ * starts from the beginning.
16472
+ * @format text
16473
+ */
16474
+ cursor?: string;
16475
+ /** Filters for vistas of specific flavor. */
16476
+ flavor?: GroupedVistaFlavor[];
16477
+ /** Whether the default vistas should be fetched or not. */
16478
+ is_default?: boolean;
16479
+ /**
16480
+ * The maximum number of vistas to return. The default is '50', the
16481
+ * maximum is '100'.
16482
+ * @format int32
16483
+ */
16484
+ limit?: number;
16485
+ /**
16486
+ * Filters for vistas accessible to the input members.
16487
+ * @example ["DEVU-12345"]
16488
+ */
16489
+ members?: string[];
16490
+ /**
16491
+ * The iteration mode to use, otherwise if not set, then "after" is
16492
+ * used.
16493
+ */
16494
+ mode?: ListMode;
16495
+ /** Filters for vistas of specific object types like works, parts etc. */
16496
+ object_type?: DynamicVistaFilterType[];
16497
+ /**
16498
+ * ID of the group/member with whom the item is shared.
16499
+ * @format id
16500
+ */
16501
+ 'shared_with.member'?: string;
16502
+ /**
16503
+ * Role ID of the group/member with whom the item is shared.
16504
+ * @format id
16505
+ */
16506
+ 'shared_with.role'?: string;
16507
+ /** Denotes whether to skip items of vista_group_item in response. */
16508
+ skip_items?: boolean;
16509
+ /** Fields to sort the vistas by and the direction to sort them. */
16510
+ sort_by?: string[];
16511
+ /** Denotes the state of the vista group item. */
16512
+ state?: VistaGroupItemState[];
16513
+ /** Filters for vistas of the specific type. */
16514
+ type?: VistaType[];
16515
+ }, params?: RequestParams) => Promise<AxiosResponse<VistasListResponse, any>>;
16516
+ /**
16517
+ * @description Lists the available vistas.
16518
+ *
16519
+ * @tags vistas
16520
+ * @name VistasListPost
16521
+ * @summary List Vistas (POST)
16522
+ * @request POST:/vistas.list
16523
+ * @secure
16524
+ */
16525
+ vistasListPost: (data: VistasListRequest, params?: RequestParams) => Promise<AxiosResponse<VistasListResponse, any>>;
15862
16526
  /**
15863
16527
  * @description Change state of a web crawler job to pause or resume it back to running.
15864
16528
  *
@@ -16167,6 +16831,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
16167
16831
  'ticket.sla_summary.stage'?: SlaSummaryStage[];
16168
16832
  /** Filters for tickets with any of the provided source channels. */
16169
16833
  'ticket.source_channel'?: string[];
16834
+ /**
16835
+ * Filters for tickets that are associated with any of the source
16836
+ * channels.
16837
+ */
16838
+ 'ticket.source_channel_v2'?: string[];
16170
16839
  /** Filters for work of the provided types. */
16171
16840
  type?: WorkType[];
16172
16841
  }, params?: RequestParams) => Promise<AxiosResponse<WorksExportResponse, any>>;
@@ -16276,6 +16945,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
16276
16945
  * @example ["DEVU-12345"]
16277
16946
  */
16278
16947
  reported_by?: string[];
16948
+ /** Fields to sort the works by and the direction to sort them. */
16949
+ sort_by?: string[];
16279
16950
  /** Filters for records in the provided stage(s) by name. */
16280
16951
  'stage.name'?: string[];
16281
16952
  /** Filters for issues that are staged. */
@@ -16329,6 +17000,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
16329
17000
  'ticket.sla_summary.stage'?: SlaSummaryStage[];
16330
17001
  /** Filters for tickets with any of the provided source channels. */
16331
17002
  'ticket.source_channel'?: string[];
17003
+ /**
17004
+ * Filters for tickets that are associated with any of the source
17005
+ * channels.
17006
+ */
17007
+ 'ticket.source_channel_v2'?: string[];
16332
17008
  /** Filters for work of the provided types. */
16333
17009
  type?: WorkType[];
16334
17010
  }, params?: RequestParams) => Promise<AxiosResponse<WorksListResponse, any>>;