@devrev/typescript-sdk 1.1.66 → 1.1.68
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.
|
@@ -698,7 +698,7 @@ export interface AiAgentEventInputMessage {
|
|
|
698
698
|
/**
|
|
699
699
|
* The text message of the AI agent event.
|
|
700
700
|
* @format text
|
|
701
|
-
* @maxLength
|
|
701
|
+
* @maxLength 16384
|
|
702
702
|
*/
|
|
703
703
|
message: string;
|
|
704
704
|
}
|
|
@@ -944,6 +944,12 @@ export interface ArchetypeMetricTarget {
|
|
|
944
944
|
* @format int32
|
|
945
945
|
*/
|
|
946
946
|
completed_in?: number;
|
|
947
|
+
/**
|
|
948
|
+
* For completed metrics the time (in seconds) it took to complete
|
|
949
|
+
* them. (Taking into account the schedule if any).
|
|
950
|
+
* @format int32
|
|
951
|
+
*/
|
|
952
|
+
completed_in_seconds?: number;
|
|
947
953
|
/** If true, the metric is part of the applied policy. */
|
|
948
954
|
in_policy?: boolean;
|
|
949
955
|
/**
|
|
@@ -1060,8 +1066,12 @@ export type Article = AtomBase & {
|
|
|
1060
1066
|
resource?: Resource;
|
|
1061
1067
|
/** The properties of an enum value. */
|
|
1062
1068
|
scope?: EnumValue;
|
|
1069
|
+
/** Status of the article. */
|
|
1070
|
+
status?: ArticleStatus;
|
|
1063
1071
|
/** Sync information for records synced into/from DevRev. */
|
|
1064
1072
|
sync_metadata?: SyncMetadata;
|
|
1073
|
+
/** Tags associated with the article. */
|
|
1074
|
+
tags?: TagWithValue[];
|
|
1065
1075
|
/**
|
|
1066
1076
|
* Title of the article.
|
|
1067
1077
|
* @format text
|
|
@@ -1899,7 +1909,7 @@ export declare enum AssociatedToType {
|
|
|
1899
1909
|
RevOrg = "rev_org"
|
|
1900
1910
|
}
|
|
1901
1911
|
/** atom */
|
|
1902
|
-
export type Atom = (Account | AppFragment | Article | AuthToken | Capability | CodeChange | Command | Conversation | CustomObject | CustomTypeFragment | DevOrg | DevUser | Dm | Engagement | Enhancement | Feature | Group | Incident | Issue | Link | Linkable | Meeting | NotificationContentTemplate | ObjectMember | Opportunity | Product | QuestionAnswer | RevOrg | RevUser | Runnable | ServiceAccount | Sla | SlaTracker | SnapIn | SnapInVersion | SysUser | Tag | Task | TenantFragment | Ticket | TimelineChangeEvent | TimelineComment | Uom | UserPreferences | Webhook | Widget) & {
|
|
1912
|
+
export type Atom = (Account | AppFragment | Article | AuthToken | Capability | CodeChange | Command | Conversation | CustomObject | CustomTypeFragment | DevOrg | DevUser | Dm | Engagement | Enhancement | Feature | Group | Incident | Issue | Link | Linkable | Meeting | NotificationContentTemplate | ObjectMember | Opportunity | Product | QuestionAnswer | RevOrg | RevUser | Runnable | ServiceAccount | Sla | SlaTracker | SnapIn | SnapInVersion | SysUser | Tag | Task | TenantFragment | Ticket | TimeMetricTracker | TimelineChangeEvent | TimelineComment | Uom | UserPreferences | Webhook | Widget) & {
|
|
1903
1913
|
type: AtomType;
|
|
1904
1914
|
};
|
|
1905
1915
|
/** atom-base */
|
|
@@ -1943,7 +1953,7 @@ export interface AtomBaseSummary {
|
|
|
1943
1953
|
id: string;
|
|
1944
1954
|
}
|
|
1945
1955
|
/** atom-summary */
|
|
1946
|
-
export type AtomSummary = (AccountSummary | AppFragmentSummary | ArticleSummary | AuthTokenSummary | CapabilitySummary | CodeChangeSummary | CommandSummary | ConversationSummary | CustomObjectSummary | CustomTypeFragmentSummary | DevOrgSummary | DevUserSummary | DmSummary | EngagementSummary | EnhancementSummary | FeatureSummary | GroupSummary | IncidentSummary | IssueSummary | LinkSummary | LinkableSummary | MeetingSummary | NotificationContentTemplateSummary | ObjectMemberSummary | OpportunitySummary | ProductSummary | QuestionAnswerSummary | RevOrgSummary | RevUserSummary | RunnableSummary | ServiceAccountSummary | SlaSummary | SlaTrackerSummary | SnapInSummary | SnapInVersionSummary | SysUserSummary | TagSummary | TaskSummary | TenantFragmentSummary | TicketSummary | TimelineChangeEventSummary | TimelineCommentSummary | UomSummary | UserPreferencesSummary | WebhookSummary | WidgetSummary) & {
|
|
1956
|
+
export type AtomSummary = (AccountSummary | AppFragmentSummary | ArticleSummary | AuthTokenSummary | CapabilitySummary | CodeChangeSummary | CommandSummary | ConversationSummary | CustomObjectSummary | CustomTypeFragmentSummary | DevOrgSummary | DevUserSummary | DmSummary | EngagementSummary | EnhancementSummary | FeatureSummary | GroupSummary | IncidentSummary | IssueSummary | LinkSummary | LinkableSummary | MeetingSummary | NotificationContentTemplateSummary | ObjectMemberSummary | OpportunitySummary | ProductSummary | QuestionAnswerSummary | RevOrgSummary | RevUserSummary | RunnableSummary | ServiceAccountSummary | SlaSummary | SlaTrackerSummary | SnapInSummary | SnapInVersionSummary | SysUserSummary | TagSummary | TaskSummary | TenantFragmentSummary | TicketSummary | TimeMetricTrackerSummary | TimelineChangeEventSummary | TimelineCommentSummary | UomSummary | UserPreferencesSummary | WebhookSummary | WidgetSummary) & {
|
|
1947
1957
|
type: AtomType;
|
|
1948
1958
|
};
|
|
1949
1959
|
export declare enum AtomType {
|
|
@@ -1987,6 +1997,7 @@ export declare enum AtomType {
|
|
|
1987
1997
|
Task = "task",
|
|
1988
1998
|
TenantFragment = "tenant_fragment",
|
|
1989
1999
|
Ticket = "ticket",
|
|
2000
|
+
TimeMetricTracker = "time_metric_tracker",
|
|
1990
2001
|
TimelineChangeEvent = "timeline_change_event",
|
|
1991
2002
|
TimelineComment = "timeline_comment",
|
|
1992
2003
|
Uom = "uom",
|
|
@@ -2903,6 +2914,24 @@ export type Chat = Dm & {
|
|
|
2903
2914
|
};
|
|
2904
2915
|
/** chat-base */
|
|
2905
2916
|
export type ChatBase = AtomBase & {
|
|
2917
|
+
/** Custom fields. */
|
|
2918
|
+
custom_fields?: object;
|
|
2919
|
+
/**
|
|
2920
|
+
* Custom schema fragments.
|
|
2921
|
+
* @example ["don:core:dvrv-us-1:devo/example:custom_type_fragment/custom-type-fragment-id"]
|
|
2922
|
+
*/
|
|
2923
|
+
custom_schema_fragments?: string[];
|
|
2924
|
+
/**
|
|
2925
|
+
* Stock schema fragment.
|
|
2926
|
+
* @format id
|
|
2927
|
+
* @example "don:core:dvrv-us-1:devo/example:custom_type_fragment/custom-type-fragment-id"
|
|
2928
|
+
*/
|
|
2929
|
+
stock_schema_fragment?: string;
|
|
2930
|
+
/**
|
|
2931
|
+
* Subtype corresponding to the custom type fragment.
|
|
2932
|
+
* @format text
|
|
2933
|
+
*/
|
|
2934
|
+
subtype?: string;
|
|
2906
2935
|
/** Sync information for records synced into/from DevRev. */
|
|
2907
2936
|
sync_metadata?: SyncMetadata;
|
|
2908
2937
|
/**
|
|
@@ -4034,6 +4063,8 @@ export type Conversation = AtomBase & {
|
|
|
4034
4063
|
* @example "2023-01-01T12:00:00.000Z"
|
|
4035
4064
|
*/
|
|
4036
4065
|
actual_close_date?: string;
|
|
4066
|
+
/** Details of the parts relevant to the conversation. */
|
|
4067
|
+
applies_to_parts?: PartSummary[];
|
|
4037
4068
|
/** Channel IDs of the conversation. */
|
|
4038
4069
|
channels?: ExternalCommunicationChannelSummary[];
|
|
4039
4070
|
/** Custom fields. */
|
|
@@ -6836,6 +6867,8 @@ export interface DevUsersListRequest {
|
|
|
6836
6867
|
mode?: ListMode;
|
|
6837
6868
|
/** Provides ways to specify date ranges on objects. */
|
|
6838
6869
|
modified_date?: DateFilter;
|
|
6870
|
+
/** List of phone numbers, in E.164 format, to filter Dev users on. */
|
|
6871
|
+
phone_numbers?: string[];
|
|
6839
6872
|
/** Fields to sort the Dev users by and the direction to sort them. */
|
|
6840
6873
|
sort_by?: string[];
|
|
6841
6874
|
/** Filters Dev users based on state. */
|
|
@@ -8991,6 +9024,12 @@ export interface ExportAuditLogsRequest {
|
|
|
8991
9024
|
* @example "2023-01-01T12:00:00.000Z"
|
|
8992
9025
|
*/
|
|
8993
9026
|
to: string;
|
|
9027
|
+
/**
|
|
9028
|
+
* A list of IDs representing the individuals whose audit logs are
|
|
9029
|
+
* being requested.
|
|
9030
|
+
* @example ["DEVU-12345"]
|
|
9031
|
+
*/
|
|
9032
|
+
users?: string[];
|
|
8994
9033
|
}
|
|
8995
9034
|
export declare enum ExportAuditLogsRequestOperationType {
|
|
8996
9035
|
Create = "create",
|
|
@@ -11211,6 +11250,8 @@ export interface MeetingsCountRequest {
|
|
|
11211
11250
|
created_date?: DateFilter;
|
|
11212
11251
|
/** Filters for meeting on custom fields. */
|
|
11213
11252
|
custom_fields?: object;
|
|
11253
|
+
/** Direction of the meetings to be fetched. */
|
|
11254
|
+
direction?: MeetingDirection[];
|
|
11214
11255
|
/** Provides ways to specify date ranges on objects. */
|
|
11215
11256
|
ended_date?: DateFilter;
|
|
11216
11257
|
/** Filters for meetings with the provided external_ref(s). */
|
|
@@ -11401,6 +11442,8 @@ export interface MeetingsListRequest {
|
|
|
11401
11442
|
cursor?: string;
|
|
11402
11443
|
/** Filters for meeting on custom fields. */
|
|
11403
11444
|
custom_fields?: object;
|
|
11445
|
+
/** Direction of the meetings to be fetched. */
|
|
11446
|
+
direction?: MeetingDirection[];
|
|
11404
11447
|
/** Provides ways to specify date ranges on objects. */
|
|
11405
11448
|
ended_date?: DateFilter;
|
|
11406
11449
|
/** Filters for meetings with the provided external_ref(s). */
|
|
@@ -11568,6 +11611,8 @@ export interface MeetingsVistaFilter {
|
|
|
11568
11611
|
created_date?: DateFilter;
|
|
11569
11612
|
/** Filters for meeting on custom fields. */
|
|
11570
11613
|
custom_fields?: object;
|
|
11614
|
+
/** Direction of the meetings to be fetched. */
|
|
11615
|
+
direction?: MeetingDirection[];
|
|
11571
11616
|
/** Provides ways to specify date ranges on objects. */
|
|
11572
11617
|
ended_date?: DateFilter;
|
|
11573
11618
|
/** Filters for meetings with the provided external_ref(s). */
|
|
@@ -11701,6 +11746,7 @@ export type MetricDefinition = AtomBase & {
|
|
|
11701
11746
|
/** The list of item types on which the metric might be applied. */
|
|
11702
11747
|
export declare enum MetricDefinitionAppliesTo {
|
|
11703
11748
|
Conversation = "conversation",
|
|
11749
|
+
Incident = "incident",
|
|
11704
11750
|
Issue = "issue",
|
|
11705
11751
|
Ticket = "ticket"
|
|
11706
11752
|
}
|
|
@@ -11869,10 +11915,16 @@ export interface MetricDefinitionsUpdateResponse {
|
|
|
11869
11915
|
metric_definition: MetricDefinition;
|
|
11870
11916
|
}
|
|
11871
11917
|
/** metric-tracker */
|
|
11872
|
-
export
|
|
11918
|
+
export type MetricTracker = TimeMetricTracker & {
|
|
11873
11919
|
type: MetricTrackerType;
|
|
11920
|
+
};
|
|
11921
|
+
/** metric-tracker-base */
|
|
11922
|
+
export type MetricTrackerBase = AtomBase;
|
|
11923
|
+
/** metric-tracker-base-summary */
|
|
11924
|
+
export type MetricTrackerBaseSummary = AtomBaseSummary;
|
|
11925
|
+
export declare enum MetricTrackerType {
|
|
11926
|
+
TimeMetricTracker = "time_metric_tracker"
|
|
11874
11927
|
}
|
|
11875
|
-
export type MetricTrackerType = string;
|
|
11876
11928
|
/** metric-trackers-get-request */
|
|
11877
11929
|
export interface MetricTrackersGetRequest {
|
|
11878
11930
|
/**
|
|
@@ -12188,7 +12240,27 @@ export type OrgScheduleFragment = AtomBase & {
|
|
|
12188
12240
|
* inside a organization schedule, used to quickly look up the schedule
|
|
12189
12241
|
* fragment for the right period.
|
|
12190
12242
|
*/
|
|
12191
|
-
export
|
|
12243
|
+
export interface OrgScheduleFragmentOverview {
|
|
12244
|
+
/**
|
|
12245
|
+
* The date (inclusive) on which the organization schedule fragment
|
|
12246
|
+
* begins.
|
|
12247
|
+
* @format date-time
|
|
12248
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
12249
|
+
*/
|
|
12250
|
+
from?: string;
|
|
12251
|
+
/**
|
|
12252
|
+
* The organization schedule fragment referenced.
|
|
12253
|
+
* @format id
|
|
12254
|
+
*/
|
|
12255
|
+
id?: string;
|
|
12256
|
+
/**
|
|
12257
|
+
* The date (exclusive) on which the organization schedule fragment's
|
|
12258
|
+
* validity ends.
|
|
12259
|
+
* @format date-time
|
|
12260
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
12261
|
+
*/
|
|
12262
|
+
to?: string;
|
|
12263
|
+
}
|
|
12192
12264
|
/**
|
|
12193
12265
|
* Status determines how an item can be used. In 'draft' status an item
|
|
12194
12266
|
* can be edited but can't be used. When 'published' the item can longer
|
|
@@ -12267,7 +12339,32 @@ export interface OrgScheduleFragmentsTransitionResponse {
|
|
|
12267
12339
|
* org-schedule-interval
|
|
12268
12340
|
* An optionally named period on day granularity.
|
|
12269
12341
|
*/
|
|
12270
|
-
export
|
|
12342
|
+
export interface OrgScheduleInterval {
|
|
12343
|
+
/**
|
|
12344
|
+
* The date (inclusive) on which the interval begins.
|
|
12345
|
+
* @format date-time
|
|
12346
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
12347
|
+
*/
|
|
12348
|
+
from?: string;
|
|
12349
|
+
/**
|
|
12350
|
+
* If true, no schedule is looked up for these days, instead it is a
|
|
12351
|
+
* fully off day.
|
|
12352
|
+
*/
|
|
12353
|
+
is_excluded?: boolean;
|
|
12354
|
+
/**
|
|
12355
|
+
* The name of the period, for example the event or holiday it
|
|
12356
|
+
* represents. Used to connect it to a specific weekly schedule.
|
|
12357
|
+
* @format text
|
|
12358
|
+
*/
|
|
12359
|
+
name?: string;
|
|
12360
|
+
/**
|
|
12361
|
+
* The date (exclusive) on which the interval ends. If omitted, it is
|
|
12362
|
+
* a single day interval.
|
|
12363
|
+
* @format date-time
|
|
12364
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
12365
|
+
*/
|
|
12366
|
+
to?: string;
|
|
12367
|
+
}
|
|
12271
12368
|
/**
|
|
12272
12369
|
* Status determines how an item can be used. In 'draft' status an item
|
|
12273
12370
|
* can be edited but can't be used. When 'published' the item can longer
|
|
@@ -16171,6 +16268,7 @@ export type Sla = AtomBase & {
|
|
|
16171
16268
|
*/
|
|
16172
16269
|
export declare enum SlaAppliesTo {
|
|
16173
16270
|
Conversation = "conversation",
|
|
16271
|
+
Incident = "incident",
|
|
16174
16272
|
Issue = "issue",
|
|
16175
16273
|
Ticket = "ticket"
|
|
16176
16274
|
}
|
|
@@ -16209,6 +16307,7 @@ export type SlaPolicy = object;
|
|
|
16209
16307
|
/** The item type for which the SLA policy applies. */
|
|
16210
16308
|
export declare enum SlaSelectorAppliesTo {
|
|
16211
16309
|
Conversation = "conversation",
|
|
16310
|
+
Incident = "incident",
|
|
16212
16311
|
Issue = "issue",
|
|
16213
16312
|
Ticket = "ticket"
|
|
16214
16313
|
}
|
|
@@ -16308,6 +16407,7 @@ export type SlaTracker = AtomBase & {
|
|
|
16308
16407
|
/** The type of the object on which the SLA is being tracked. */
|
|
16309
16408
|
export declare enum SlaTrackerAppliesToType {
|
|
16310
16409
|
Conversation = "conversation",
|
|
16410
|
+
Incident = "incident",
|
|
16311
16411
|
Issue = "issue",
|
|
16312
16412
|
Ticket = "ticket"
|
|
16313
16413
|
}
|
|
@@ -18503,6 +18603,10 @@ export type TicketSummary = WorkBaseSummary & {
|
|
|
18503
18603
|
/** Severity of the ticket. */
|
|
18504
18604
|
severity?: TicketSeverity;
|
|
18505
18605
|
};
|
|
18606
|
+
/** time-metric-tracker */
|
|
18607
|
+
export type TimeMetricTracker = MetricTrackerBase;
|
|
18608
|
+
/** time-metric-tracker-summary */
|
|
18609
|
+
export type TimeMetricTrackerSummary = MetricTrackerBaseSummary;
|
|
18506
18610
|
/** timeline-change-event */
|
|
18507
18611
|
export type TimelineChangeEvent = TimelineEntryBase & {
|
|
18508
18612
|
/** A timeline change event. */
|
|
@@ -19218,7 +19322,7 @@ export type Uom = AtomBase & {
|
|
|
19218
19322
|
*/
|
|
19219
19323
|
name: string;
|
|
19220
19324
|
part?: PartSummary;
|
|
19221
|
-
product
|
|
19325
|
+
product?: PartSummary;
|
|
19222
19326
|
/**
|
|
19223
19327
|
* Unit encapsulates the name of the unit and the type of the unit. For
|
|
19224
19328
|
* example, '#Number of API calls' where name is 'number_of_api_calls' and
|
|
@@ -19904,6 +20008,8 @@ export type UserSearchSummary = SearchSummaryBase & {
|
|
|
19904
20008
|
* @maxItems 5
|
|
19905
20009
|
*/
|
|
19906
20010
|
comments?: CommentSearchSummary[];
|
|
20011
|
+
/** Phone numbers of the user. */
|
|
20012
|
+
phone_numbers?: string[];
|
|
19907
20013
|
user: UserSummary;
|
|
19908
20014
|
};
|
|
19909
20015
|
/**
|
|
@@ -21156,7 +21262,34 @@ export interface WebhooksUpdateResponse {
|
|
|
21156
21262
|
* weekly-org-schedule
|
|
21157
21263
|
* The schedule for each week.
|
|
21158
21264
|
*/
|
|
21159
|
-
export
|
|
21265
|
+
export interface WeeklyOrgSchedule {
|
|
21266
|
+
/** The 'on' intervals of the week. */
|
|
21267
|
+
intervals?: WeeklyOrgScheduleInterval[];
|
|
21268
|
+
/**
|
|
21269
|
+
* Describes in which named period the schedule applies.
|
|
21270
|
+
* @format text
|
|
21271
|
+
*/
|
|
21272
|
+
period_name?: string;
|
|
21273
|
+
}
|
|
21274
|
+
/**
|
|
21275
|
+
* weekly-org-schedule-interval
|
|
21276
|
+
* A time interval within a week when the schedule is 'on'. It is defined
|
|
21277
|
+
* in minutes counting from Sunday midnight to Sunday midnight. (that is,
|
|
21278
|
+
* 0 is Sunday 00:00).
|
|
21279
|
+
*/
|
|
21280
|
+
export interface WeeklyOrgScheduleInterval {
|
|
21281
|
+
/**
|
|
21282
|
+
* The time (in minutes) when the interval starts.
|
|
21283
|
+
* @format int32
|
|
21284
|
+
*/
|
|
21285
|
+
from?: number;
|
|
21286
|
+
/**
|
|
21287
|
+
* The time (in minutes) when the interval ends. Should be larger than
|
|
21288
|
+
* 'from'.
|
|
21289
|
+
* @format int32
|
|
21290
|
+
*/
|
|
21291
|
+
to?: number;
|
|
21292
|
+
}
|
|
21160
21293
|
/** widget */
|
|
21161
21294
|
export type Widget = AtomBase & {
|
|
21162
21295
|
/** Data sources provide the backing data tables for the widget. */
|
|
@@ -21579,6 +21712,11 @@ export type WorkBase = AtomBase & {
|
|
|
21579
21712
|
reported_by?: UserSummary[];
|
|
21580
21713
|
/** Describes the current stage of a work item. */
|
|
21581
21714
|
stage?: LegacyStage;
|
|
21715
|
+
/**
|
|
21716
|
+
* Display name for current state.
|
|
21717
|
+
* @format text
|
|
21718
|
+
*/
|
|
21719
|
+
state_display_name?: string;
|
|
21582
21720
|
/**
|
|
21583
21721
|
* Stock schema fragment.
|
|
21584
21722
|
* @format id
|
|
@@ -21612,6 +21750,11 @@ export type WorkBaseSummary = AtomBaseSummary & {
|
|
|
21612
21750
|
owned_by: UserSummary[];
|
|
21613
21751
|
/** Describes the current stage of a work item. */
|
|
21614
21752
|
stage?: LegacyStageSummary;
|
|
21753
|
+
/**
|
|
21754
|
+
* Display name for current state.
|
|
21755
|
+
* @format text
|
|
21756
|
+
*/
|
|
21757
|
+
state_display_name?: string;
|
|
21615
21758
|
/** Sync information for records synced into/from DevRev. */
|
|
21616
21759
|
sync_metadata?: SyncMetadataSummary;
|
|
21617
21760
|
/**
|
|
@@ -24512,6 +24655,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
24512
24655
|
* used.
|
|
24513
24656
|
*/
|
|
24514
24657
|
mode?: ListMode;
|
|
24658
|
+
/** List of phone numbers, in E.164 format, to filter Dev users on. */
|
|
24659
|
+
phone_numbers?: string[];
|
|
24515
24660
|
/** Fields to sort the Dev users by and the direction to sort them. */
|
|
24516
24661
|
sort_by?: string[];
|
|
24517
24662
|
/** Filters Dev users based on state. */
|
|
@@ -25669,6 +25814,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
25669
25814
|
created_by?: string[];
|
|
25670
25815
|
/** Filters for meeting on custom fields. */
|
|
25671
25816
|
custom_fields?: object;
|
|
25817
|
+
/** Direction of the meetings to be fetched. */
|
|
25818
|
+
direction?: MeetingDirection[];
|
|
25672
25819
|
/** Filters for meetings with the provided external_ref(s). */
|
|
25673
25820
|
external_ref?: string[];
|
|
25674
25821
|
/**
|
|
@@ -25797,6 +25944,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
25797
25944
|
cursor?: string;
|
|
25798
25945
|
/** Filters for meeting on custom fields. */
|
|
25799
25946
|
custom_fields?: object;
|
|
25947
|
+
/** Direction of the meetings to be fetched. */
|
|
25948
|
+
direction?: MeetingDirection[];
|
|
25800
25949
|
/** Filters for meetings with the provided external_ref(s). */
|
|
25801
25950
|
external_ref?: string[];
|
|
25802
25951
|
/**
|
|
@@ -34,9 +34,9 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
|
34
34
|
};
|
|
35
35
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
36
36
|
exports.ErrorInternalServerErrorType = exports.ErrorForbiddenType = exports.ErrorConflictType = exports.ErrorBadRequestWorkflowComponentValidationErrorWorkflowComponentValidationLocationType = exports.ErrorBadRequestUnexpectedJsonTypeType = exports.ErrorBadRequestType = exports.ErrorBadRequestCustomizationValidationErrorSubtype = exports.EnhancementRevScoreTier = exports.EngagementsCreateRequestEngagementType = exports.EngagementType = exports.DynamicVistaFilterType = exports.DevUsersCreateRequestStateEnumValue = exports.DevUserJobTitle = exports.DevOrgAuthConnectionsUpdateRequestType = exports.DevOrgAuthConnectionsCreateRequestType = exports.Definedness = exports.DateTimePresetType = exports.DateFilterType = exports.CustomSchemaFragmentsSetRequestType = exports.CustomSchemaFragmentsListRequestPrune = exports.CustomSchemaFragmentType = exports.CustomSchemaFragmentFragmentType = exports.ConversationsVistaGroupItemType = exports.ConversationsCreateRequestTypeValue = exports.ContentTemplateType = exports.CommandSurfaceSurface = exports.CommandSurfaceObjectTypes = exports.CommandStatus = exports.CommandActionTemplateType = exports.CommandActionExecutorType = exports.CodeChangeSource = exports.ChatType = exports.ChatCompletionsRequestMessageRole = exports.CaveatOperator = exports.BooleanExpressionType = exports.AuthTokenTokenType = exports.AuthTokenSubjectTokenType = exports.AuthTokenStatus = exports.AuthTokenRequestedTokenType = exports.AuthTokenGrantType = exports.AuthConnectionType = exports.AuthConnectionToggle = exports.AtomType = exports.AssociatedToType = exports.ArtifactConfigurationSet = exports.ArticleType = exports.ArticleStatus = exports.ArticleContentFormat = exports.AggregationDetailAggregationType = exports.AccessLevel = void 0;
|
|
37
|
-
exports.
|
|
38
|
-
exports.
|
|
39
|
-
exports.Api = exports.HttpClient = exports.ContentType = exports.WorksVistaGroupItemType = exports.WorkType = exports.WidgetVisualizationType = exports.WidgetQueryOrderByDirection = exports.WidgetDataSourceType = exports.WidgetColumnProjectionType = exports.WebhooksUpdateAction = exports.WebhookStatus = exports.WebhookEventType = exports.WebCrawlerJobsControlRequestAction = exports.WebCrawlerJobState = exports.VisualizationAxisColorType = exports.VistaType = exports.VistaGroupItemType = exports.VistaGroupItemState = exports.VistaGroupItemGroupObjectType = exports.VistaFlavor = exports.UserType = exports.UserState = exports.UomMetricScope = exports.UnitType = exports.TuringSourcesType = exports.TimelineEntryVisibility = exports.TimelineEntryType = exports.TimelineEntryPanel = exports.TimelineEntryObjectType = void 0;
|
|
37
|
+
exports.RolePrivileges = exports.RecordTemplateState = exports.ReactionsUpdateRequestAction = exports.QuestionAnswerStatus = exports.PrimitiveValueType = exports.PreferencesType = exports.PartsVistaGroupItemType = exports.PartType = exports.OrgType = exports.OrgScheduleStatus = exports.OrgScheduleFragmentStatus = exports.OrgEnvironment = exports.OpportunityPriority = exports.OpportunityForecastCategory = exports.NotificationPriority = exports.MetricTrackerType = exports.MetricDefinitionStatus = exports.MetricDefinitionMetricType = exports.MetricDefinitionAppliesTo = exports.MetricActionExecuteRequestAction = exports.MemberType = exports.MeetingState = exports.MeetingDirection = exports.MeetingChannel = exports.MeerkatWidgetColumnProjectionType = exports.MeerkatWidgetColumnProjectionTimestampRollup = exports.MeerkatWidgetColumnFunctionType = exports.ListMode = exports.LinksDirection = exports.LinkType = exports.LinkEndpointType = exports.KanbanVisualizationCardAttributePosition = exports.IssuePriority = exports.GroupedVistaFlavor = exports.GroupedVistaFilterType = exports.GroupType = exports.GroupMemberType = exports.GroupItemType = exports.GroupIngestionSource = exports.GenericNotificationEventType = exports.FieldValueType = exports.ExternalSystemType = exports.ExportAuditLogsRequestOperationType = exports.EventTimelineEntryUpdatedReactionAction = exports.EventSourceStatus = exports.EventFetchedResult = exports.ErrorUnauthorizedType = exports.ErrorTooManyRequestsType = exports.ErrorServiceUnavailableType = exports.ErrorNotFoundType = void 0;
|
|
38
|
+
exports.TimelineEntriesCreateRequestType = exports.TimelineEntriesCollection = exports.TimelineCommentBodyType = exports.TimelineChangeEventEventType = exports.TicketSeverity = exports.TicketChannels = exports.TaskPriority = exports.TableVisualizationColumnPinPosition = exports.TableVisualizationColumnLockPosition = exports.SyncUnitSyncType = exports.SyncRunStartedBy = exports.SyncRunProgressState = exports.SyncRunMode = exports.SyncProgressState = exports.SyncOutStatus = exports.SyncMetadataFilterSyncOutFilterStatus = exports.SyncMetadataFilterSyncInFilterStatus = exports.SyncInStatus = exports.StockSchemaFragmentsListRequestPrune = exports.StockSchemaFragmentsListRequestFilterPreset = exports.StageValidationOptionForUpdate = exports.StageValidationOptionForCreate = exports.SnapWidgetsCreateRequestType = exports.SnapWidgetType = exports.SnapWidgetStatus = exports.SnapWidgetNamespace = exports.SnapWidgetInteractionType = exports.SnapWidgetClickInteractionClickAction = exports.SnapKitActionRequestElementTypeValue = exports.SlasFilterAppliesToOperatorType = exports.SlaType = exports.SlaTrackerAppliesToType = exports.SlaSummaryStage = exports.SlaStatus = exports.SlaSelectorSeverity = exports.SlaSelectorPriority = exports.SlaSelectorAppliesTo = exports.SlaEvaluationPeriod = exports.SlaAppliesTo = exports.SendNotificationType = exports.SelectorObject = exports.SearchSortOrderParam = exports.SearchSortByParam = exports.SearchResultType = exports.SearchNamespace = exports.SearchHybridNamespace = exports.SchemasSubtypePrepareUpdateGetResponseConflictType = exports.SchemaFieldDescriptorFieldType = exports.SchemaFieldDescriptorArrayTypeBaseType = exports.RoleTarget = void 0;
|
|
39
|
+
exports.Api = exports.HttpClient = exports.ContentType = exports.WorksVistaGroupItemType = exports.WorkType = exports.WidgetVisualizationType = exports.WidgetQueryOrderByDirection = exports.WidgetDataSourceType = exports.WidgetColumnProjectionType = exports.WebhooksUpdateAction = exports.WebhookStatus = exports.WebhookEventType = exports.WebCrawlerJobsControlRequestAction = exports.WebCrawlerJobState = exports.VisualizationAxisColorType = exports.VistaType = exports.VistaGroupItemType = exports.VistaGroupItemState = exports.VistaGroupItemGroupObjectType = exports.VistaFlavor = exports.UserType = exports.UserState = exports.UomMetricScope = exports.UnitType = exports.TuringSourcesType = exports.TimelineEntryVisibility = exports.TimelineEntryType = exports.TimelineEntryPanel = exports.TimelineEntryObjectType = exports.TimelineEntriesUpdateRequestType = void 0;
|
|
40
40
|
var AccessLevel;
|
|
41
41
|
(function (AccessLevel) {
|
|
42
42
|
AccessLevel["External"] = "external";
|
|
@@ -164,6 +164,7 @@ var AtomType;
|
|
|
164
164
|
AtomType["Task"] = "task";
|
|
165
165
|
AtomType["TenantFragment"] = "tenant_fragment";
|
|
166
166
|
AtomType["Ticket"] = "ticket";
|
|
167
|
+
AtomType["TimeMetricTracker"] = "time_metric_tracker";
|
|
167
168
|
AtomType["TimelineChangeEvent"] = "timeline_change_event";
|
|
168
169
|
AtomType["TimelineComment"] = "timeline_comment";
|
|
169
170
|
AtomType["Uom"] = "uom";
|
|
@@ -825,6 +826,7 @@ var MetricActionExecuteRequestAction;
|
|
|
825
826
|
var MetricDefinitionAppliesTo;
|
|
826
827
|
(function (MetricDefinitionAppliesTo) {
|
|
827
828
|
MetricDefinitionAppliesTo["Conversation"] = "conversation";
|
|
829
|
+
MetricDefinitionAppliesTo["Incident"] = "incident";
|
|
828
830
|
MetricDefinitionAppliesTo["Issue"] = "issue";
|
|
829
831
|
MetricDefinitionAppliesTo["Ticket"] = "ticket";
|
|
830
832
|
})(MetricDefinitionAppliesTo = exports.MetricDefinitionAppliesTo || (exports.MetricDefinitionAppliesTo = {}));
|
|
@@ -849,6 +851,10 @@ var MetricDefinitionStatus;
|
|
|
849
851
|
MetricDefinitionStatus["Active"] = "active";
|
|
850
852
|
MetricDefinitionStatus["Inactive"] = "inactive";
|
|
851
853
|
})(MetricDefinitionStatus = exports.MetricDefinitionStatus || (exports.MetricDefinitionStatus = {}));
|
|
854
|
+
var MetricTrackerType;
|
|
855
|
+
(function (MetricTrackerType) {
|
|
856
|
+
MetricTrackerType["TimeMetricTracker"] = "time_metric_tracker";
|
|
857
|
+
})(MetricTrackerType = exports.MetricTrackerType || (exports.MetricTrackerType = {}));
|
|
852
858
|
/** Priority of the notification. */
|
|
853
859
|
var NotificationPriority;
|
|
854
860
|
(function (NotificationPriority) {
|
|
@@ -1161,6 +1167,7 @@ var SendNotificationType;
|
|
|
1161
1167
|
var SlaAppliesTo;
|
|
1162
1168
|
(function (SlaAppliesTo) {
|
|
1163
1169
|
SlaAppliesTo["Conversation"] = "conversation";
|
|
1170
|
+
SlaAppliesTo["Incident"] = "incident";
|
|
1164
1171
|
SlaAppliesTo["Issue"] = "issue";
|
|
1165
1172
|
SlaAppliesTo["Ticket"] = "ticket";
|
|
1166
1173
|
})(SlaAppliesTo = exports.SlaAppliesTo || (exports.SlaAppliesTo = {}));
|
|
@@ -1183,6 +1190,7 @@ var SlaEvaluationPeriod;
|
|
|
1183
1190
|
var SlaSelectorAppliesTo;
|
|
1184
1191
|
(function (SlaSelectorAppliesTo) {
|
|
1185
1192
|
SlaSelectorAppliesTo["Conversation"] = "conversation";
|
|
1193
|
+
SlaSelectorAppliesTo["Incident"] = "incident";
|
|
1186
1194
|
SlaSelectorAppliesTo["Issue"] = "issue";
|
|
1187
1195
|
SlaSelectorAppliesTo["Ticket"] = "ticket";
|
|
1188
1196
|
})(SlaSelectorAppliesTo = exports.SlaSelectorAppliesTo || (exports.SlaSelectorAppliesTo = {}));
|
|
@@ -1228,6 +1236,7 @@ var SlaSummaryStage;
|
|
|
1228
1236
|
var SlaTrackerAppliesToType;
|
|
1229
1237
|
(function (SlaTrackerAppliesToType) {
|
|
1230
1238
|
SlaTrackerAppliesToType["Conversation"] = "conversation";
|
|
1239
|
+
SlaTrackerAppliesToType["Incident"] = "incident";
|
|
1231
1240
|
SlaTrackerAppliesToType["Issue"] = "issue";
|
|
1232
1241
|
SlaTrackerAppliesToType["Ticket"] = "ticket";
|
|
1233
1242
|
})(SlaTrackerAppliesToType = exports.SlaTrackerAppliesToType || (exports.SlaTrackerAppliesToType = {}));
|
|
@@ -541,6 +541,12 @@ export interface ArchetypeMetricTarget {
|
|
|
541
541
|
* @format int32
|
|
542
542
|
*/
|
|
543
543
|
completed_in?: number;
|
|
544
|
+
/**
|
|
545
|
+
* For completed metrics the time (in seconds) it took to complete
|
|
546
|
+
* them. (Taking into account the schedule if any).
|
|
547
|
+
* @format int32
|
|
548
|
+
*/
|
|
549
|
+
completed_in_seconds?: number;
|
|
544
550
|
/** If true, the metric is part of the applied policy. */
|
|
545
551
|
in_policy?: boolean;
|
|
546
552
|
/**
|
|
@@ -657,6 +663,10 @@ export type Article = AtomBase & {
|
|
|
657
663
|
resource?: Resource;
|
|
658
664
|
/** The properties of an enum value. */
|
|
659
665
|
scope?: EnumValue;
|
|
666
|
+
/** Status of the article. */
|
|
667
|
+
status?: ArticleStatus;
|
|
668
|
+
/** Tags associated with the article. */
|
|
669
|
+
tags?: TagWithValue[];
|
|
660
670
|
/**
|
|
661
671
|
* Title of the article.
|
|
662
672
|
* @format text
|
|
@@ -1417,7 +1427,7 @@ export interface ArtifactsVersionsPrepareResponseFormData {
|
|
|
1417
1427
|
value: string;
|
|
1418
1428
|
}
|
|
1419
1429
|
/** atom */
|
|
1420
|
-
export type Atom = (Article | AuthToken | Capability | Conversation | DevUser | Enhancement | Feature | Group | Issue | Link | Product | RevOrg | RevUser | ServiceAccount | Sla | SlaTracker | SysUser | Tag | Ticket | TimelineComment | Webhook) & {
|
|
1430
|
+
export type Atom = (Article | AuthToken | Capability | Conversation | DevUser | Enhancement | Feature | Group | Issue | Link | Product | RevOrg | RevUser | ServiceAccount | Sla | SlaTracker | SysUser | Tag | Ticket | TimeMetricTracker | TimelineComment | Webhook) & {
|
|
1421
1431
|
type: AtomType;
|
|
1422
1432
|
};
|
|
1423
1433
|
/** atom-base */
|
|
@@ -1461,7 +1471,7 @@ export interface AtomBaseSummary {
|
|
|
1461
1471
|
id: string;
|
|
1462
1472
|
}
|
|
1463
1473
|
/** atom-summary */
|
|
1464
|
-
export type AtomSummary = (ArticleSummary | AuthTokenSummary | CapabilitySummary | ConversationSummary | DevUserSummary | EnhancementSummary | FeatureSummary | GroupSummary | IssueSummary | LinkSummary | ProductSummary | RevOrgSummary | RevUserSummary | ServiceAccountSummary | SlaSummary | SlaTrackerSummary | SysUserSummary | TagSummary | TicketSummary | TimelineCommentSummary | WebhookSummary) & {
|
|
1474
|
+
export type AtomSummary = (ArticleSummary | AuthTokenSummary | CapabilitySummary | ConversationSummary | DevUserSummary | EnhancementSummary | FeatureSummary | GroupSummary | IssueSummary | LinkSummary | ProductSummary | RevOrgSummary | RevUserSummary | ServiceAccountSummary | SlaSummary | SlaTrackerSummary | SysUserSummary | TagSummary | TicketSummary | TimeMetricTrackerSummary | TimelineCommentSummary | WebhookSummary) & {
|
|
1465
1475
|
type: AtomType;
|
|
1466
1476
|
};
|
|
1467
1477
|
export declare enum AtomType {
|
|
@@ -1484,6 +1494,7 @@ export declare enum AtomType {
|
|
|
1484
1494
|
SysUser = "sys_user",
|
|
1485
1495
|
Tag = "tag",
|
|
1486
1496
|
Ticket = "ticket",
|
|
1497
|
+
TimeMetricTracker = "time_metric_tracker",
|
|
1487
1498
|
TimelineComment = "timeline_comment",
|
|
1488
1499
|
Webhook = "webhook"
|
|
1489
1500
|
}
|
|
@@ -2814,6 +2825,8 @@ export interface CompositeSchema {
|
|
|
2814
2825
|
}
|
|
2815
2826
|
/** conversation */
|
|
2816
2827
|
export type Conversation = AtomBase & {
|
|
2828
|
+
/** Details of the parts relevant to the conversation. */
|
|
2829
|
+
applies_to_parts?: PartSummary[];
|
|
2817
2830
|
/** Channel IDs of the conversation. */
|
|
2818
2831
|
channels?: ExternalCommunicationChannelSummary[];
|
|
2819
2832
|
/**
|
|
@@ -4768,6 +4781,8 @@ export interface DevUsersListRequest {
|
|
|
4768
4781
|
mode?: ListMode;
|
|
4769
4782
|
/** Provides ways to specify date ranges on objects. */
|
|
4770
4783
|
modified_date?: DateFilter;
|
|
4784
|
+
/** List of phone numbers, in E.164 format, to filter Dev users on. */
|
|
4785
|
+
phone_numbers?: string[];
|
|
4771
4786
|
/** Fields to sort the Dev users by and the direction to sort them. */
|
|
4772
4787
|
sort_by?: string[];
|
|
4773
4788
|
/** Filters Dev users based on state. */
|
|
@@ -7243,6 +7258,16 @@ export declare enum MeetingChannel {
|
|
|
7243
7258
|
Teams = "teams",
|
|
7244
7259
|
Zoom = "zoom"
|
|
7245
7260
|
}
|
|
7261
|
+
/**
|
|
7262
|
+
* Direction of meeting - meetings within an organization are internal.
|
|
7263
|
+
* Meetings with external customers can be incoming or outgoing depending
|
|
7264
|
+
* on who initiates them.
|
|
7265
|
+
*/
|
|
7266
|
+
export declare enum MeetingDirection {
|
|
7267
|
+
Incoming = "incoming",
|
|
7268
|
+
Internal = "internal",
|
|
7269
|
+
Outgoing = "outgoing"
|
|
7270
|
+
}
|
|
7246
7271
|
/** The state of meeting. */
|
|
7247
7272
|
export declare enum MeetingState {
|
|
7248
7273
|
Canceled = "canceled",
|
|
@@ -7264,6 +7289,8 @@ export interface MeetingsCountRequest {
|
|
|
7264
7289
|
created_by?: string[];
|
|
7265
7290
|
/** Provides ways to specify date ranges on objects. */
|
|
7266
7291
|
created_date?: DateFilter;
|
|
7292
|
+
/** Direction of the meetings to be fetched. */
|
|
7293
|
+
direction?: MeetingDirection[];
|
|
7267
7294
|
/** Provides ways to specify date ranges on objects. */
|
|
7268
7295
|
ended_date?: DateFilter;
|
|
7269
7296
|
/** Filters for meetings with the provided external_ref(s). */
|
|
@@ -7438,6 +7465,8 @@ export interface MeetingsListRequest {
|
|
|
7438
7465
|
* @format text
|
|
7439
7466
|
*/
|
|
7440
7467
|
cursor?: string;
|
|
7468
|
+
/** Direction of the meetings to be fetched. */
|
|
7469
|
+
direction?: MeetingDirection[];
|
|
7441
7470
|
/** Provides ways to specify date ranges on objects. */
|
|
7442
7471
|
ended_date?: DateFilter;
|
|
7443
7472
|
/** Filters for meetings with the provided external_ref(s). */
|
|
@@ -7601,6 +7630,8 @@ export interface MeetingsVistaFilter {
|
|
|
7601
7630
|
created_by?: string[];
|
|
7602
7631
|
/** Provides ways to specify date ranges on objects. */
|
|
7603
7632
|
created_date?: DateFilter;
|
|
7633
|
+
/** Direction of the meetings to be fetched. */
|
|
7634
|
+
direction?: MeetingDirection[];
|
|
7604
7635
|
/** Provides ways to specify date ranges on objects. */
|
|
7605
7636
|
ended_date?: DateFilter;
|
|
7606
7637
|
/** Filters for meetings with the provided external_ref(s). */
|
|
@@ -7685,6 +7716,7 @@ export type MetricDefinition = AtomBase & {
|
|
|
7685
7716
|
/** The list of item types on which the metric might be applied. */
|
|
7686
7717
|
export declare enum MetricDefinitionAppliesTo {
|
|
7687
7718
|
Conversation = "conversation",
|
|
7719
|
+
Incident = "incident",
|
|
7688
7720
|
Issue = "issue",
|
|
7689
7721
|
Ticket = "ticket"
|
|
7690
7722
|
}
|
|
@@ -7853,10 +7885,16 @@ export interface MetricDefinitionsUpdateResponse {
|
|
|
7853
7885
|
metric_definition: MetricDefinition;
|
|
7854
7886
|
}
|
|
7855
7887
|
/** metric-tracker */
|
|
7856
|
-
export
|
|
7888
|
+
export type MetricTracker = TimeMetricTracker & {
|
|
7857
7889
|
type: MetricTrackerType;
|
|
7890
|
+
};
|
|
7891
|
+
/** metric-tracker-base */
|
|
7892
|
+
export type MetricTrackerBase = AtomBase;
|
|
7893
|
+
/** metric-tracker-base-summary */
|
|
7894
|
+
export type MetricTrackerBaseSummary = AtomBaseSummary;
|
|
7895
|
+
export declare enum MetricTrackerType {
|
|
7896
|
+
TimeMetricTracker = "time_metric_tracker"
|
|
7858
7897
|
}
|
|
7859
|
-
export type MetricTrackerType = string;
|
|
7860
7898
|
/** metric-trackers-get-request */
|
|
7861
7899
|
export interface MetricTrackersGetRequest {
|
|
7862
7900
|
/**
|
|
@@ -7994,7 +8032,27 @@ export type OrgScheduleFragment = AtomBase & {
|
|
|
7994
8032
|
* inside a organization schedule, used to quickly look up the schedule
|
|
7995
8033
|
* fragment for the right period.
|
|
7996
8034
|
*/
|
|
7997
|
-
export
|
|
8035
|
+
export interface OrgScheduleFragmentOverview {
|
|
8036
|
+
/**
|
|
8037
|
+
* The date (inclusive) on which the organization schedule fragment
|
|
8038
|
+
* begins.
|
|
8039
|
+
* @format date-time
|
|
8040
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
8041
|
+
*/
|
|
8042
|
+
from?: string;
|
|
8043
|
+
/**
|
|
8044
|
+
* The organization schedule fragment referenced.
|
|
8045
|
+
* @format id
|
|
8046
|
+
*/
|
|
8047
|
+
id?: string;
|
|
8048
|
+
/**
|
|
8049
|
+
* The date (exclusive) on which the organization schedule fragment's
|
|
8050
|
+
* validity ends.
|
|
8051
|
+
* @format date-time
|
|
8052
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
8053
|
+
*/
|
|
8054
|
+
to?: string;
|
|
8055
|
+
}
|
|
7998
8056
|
/**
|
|
7999
8057
|
* Status determines how an item can be used. In 'draft' status an item
|
|
8000
8058
|
* can be edited but can't be used. When 'published' the item can longer
|
|
@@ -8073,7 +8131,32 @@ export interface OrgScheduleFragmentsTransitionResponse {
|
|
|
8073
8131
|
* org-schedule-interval
|
|
8074
8132
|
* An optionally named period on day granularity.
|
|
8075
8133
|
*/
|
|
8076
|
-
export
|
|
8134
|
+
export interface OrgScheduleInterval {
|
|
8135
|
+
/**
|
|
8136
|
+
* The date (inclusive) on which the interval begins.
|
|
8137
|
+
* @format date-time
|
|
8138
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
8139
|
+
*/
|
|
8140
|
+
from?: string;
|
|
8141
|
+
/**
|
|
8142
|
+
* If true, no schedule is looked up for these days, instead it is a
|
|
8143
|
+
* fully off day.
|
|
8144
|
+
*/
|
|
8145
|
+
is_excluded?: boolean;
|
|
8146
|
+
/**
|
|
8147
|
+
* The name of the period, for example the event or holiday it
|
|
8148
|
+
* represents. Used to connect it to a specific weekly schedule.
|
|
8149
|
+
* @format text
|
|
8150
|
+
*/
|
|
8151
|
+
name?: string;
|
|
8152
|
+
/**
|
|
8153
|
+
* The date (exclusive) on which the interval ends. If omitted, it is
|
|
8154
|
+
* a single day interval.
|
|
8155
|
+
* @format date-time
|
|
8156
|
+
* @example "2023-01-01T12:00:00.000Z"
|
|
8157
|
+
*/
|
|
8158
|
+
to?: string;
|
|
8159
|
+
}
|
|
8077
8160
|
/**
|
|
8078
8161
|
* Status determines how an item can be used. In 'draft' status an item
|
|
8079
8162
|
* can be edited but can't be used. When 'published' the item can longer
|
|
@@ -10344,6 +10427,7 @@ export type Sla = AtomBase & {
|
|
|
10344
10427
|
*/
|
|
10345
10428
|
export declare enum SlaAppliesTo {
|
|
10346
10429
|
Conversation = "conversation",
|
|
10430
|
+
Incident = "incident",
|
|
10347
10431
|
Issue = "issue",
|
|
10348
10432
|
Ticket = "ticket"
|
|
10349
10433
|
}
|
|
@@ -10382,6 +10466,7 @@ export type SlaPolicy = object;
|
|
|
10382
10466
|
/** The item type for which the SLA policy applies. */
|
|
10383
10467
|
export declare enum SlaSelectorAppliesTo {
|
|
10384
10468
|
Conversation = "conversation",
|
|
10469
|
+
Incident = "incident",
|
|
10385
10470
|
Issue = "issue",
|
|
10386
10471
|
Ticket = "ticket"
|
|
10387
10472
|
}
|
|
@@ -10481,6 +10566,7 @@ export type SlaTracker = AtomBase & {
|
|
|
10481
10566
|
/** The type of the object on which the SLA is being tracked. */
|
|
10482
10567
|
export declare enum SlaTrackerAppliesToType {
|
|
10483
10568
|
Conversation = "conversation",
|
|
10569
|
+
Incident = "incident",
|
|
10484
10570
|
Issue = "issue",
|
|
10485
10571
|
Ticket = "ticket"
|
|
10486
10572
|
}
|
|
@@ -12045,6 +12131,10 @@ export type TicketSummary = WorkBaseSummary & {
|
|
|
12045
12131
|
/** Severity of the ticket. */
|
|
12046
12132
|
severity?: TicketSeverity;
|
|
12047
12133
|
};
|
|
12134
|
+
/** time-metric-tracker */
|
|
12135
|
+
export type TimeMetricTracker = MetricTrackerBase;
|
|
12136
|
+
/** time-metric-tracker-summary */
|
|
12137
|
+
export type TimeMetricTrackerSummary = MetricTrackerBaseSummary;
|
|
12048
12138
|
/** timeline-comment */
|
|
12049
12139
|
export type TimelineComment = TimelineEntryBase & {
|
|
12050
12140
|
/** The artifacts for the comment. */
|
|
@@ -13555,7 +13645,34 @@ export interface WebhooksUpdateResponse {
|
|
|
13555
13645
|
* weekly-org-schedule
|
|
13556
13646
|
* The schedule for each week.
|
|
13557
13647
|
*/
|
|
13558
|
-
export
|
|
13648
|
+
export interface WeeklyOrgSchedule {
|
|
13649
|
+
/** The 'on' intervals of the week. */
|
|
13650
|
+
intervals?: WeeklyOrgScheduleInterval[];
|
|
13651
|
+
/**
|
|
13652
|
+
* Describes in which named period the schedule applies.
|
|
13653
|
+
* @format text
|
|
13654
|
+
*/
|
|
13655
|
+
period_name?: string;
|
|
13656
|
+
}
|
|
13657
|
+
/**
|
|
13658
|
+
* weekly-org-schedule-interval
|
|
13659
|
+
* A time interval within a week when the schedule is 'on'. It is defined
|
|
13660
|
+
* in minutes counting from Sunday midnight to Sunday midnight. (that is,
|
|
13661
|
+
* 0 is Sunday 00:00).
|
|
13662
|
+
*/
|
|
13663
|
+
export interface WeeklyOrgScheduleInterval {
|
|
13664
|
+
/**
|
|
13665
|
+
* The time (in minutes) when the interval starts.
|
|
13666
|
+
* @format int32
|
|
13667
|
+
*/
|
|
13668
|
+
from?: number;
|
|
13669
|
+
/**
|
|
13670
|
+
* The time (in minutes) when the interval ends. Should be larger than
|
|
13671
|
+
* 'from'.
|
|
13672
|
+
* @format int32
|
|
13673
|
+
*/
|
|
13674
|
+
to?: number;
|
|
13675
|
+
}
|
|
13559
13676
|
/** widget */
|
|
13560
13677
|
export type Widget = AtomBase;
|
|
13561
13678
|
/** work */
|
|
@@ -13578,6 +13695,11 @@ export type WorkBase = AtomBase & {
|
|
|
13578
13695
|
reported_by?: UserSummary[];
|
|
13579
13696
|
/** Describes the current stage of a work item. */
|
|
13580
13697
|
stage?: LegacyStage;
|
|
13698
|
+
/**
|
|
13699
|
+
* Display name for current state.
|
|
13700
|
+
* @format text
|
|
13701
|
+
*/
|
|
13702
|
+
state_display_name?: string;
|
|
13581
13703
|
/** Tags associated with the object. */
|
|
13582
13704
|
tags?: TagWithValue[];
|
|
13583
13705
|
/**
|
|
@@ -13598,6 +13720,11 @@ export type WorkBaseSummary = AtomBaseSummary & {
|
|
|
13598
13720
|
owned_by: UserSummary[];
|
|
13599
13721
|
/** Describes the current stage of a work item. */
|
|
13600
13722
|
stage?: LegacyStageSummary;
|
|
13723
|
+
/**
|
|
13724
|
+
* Display name for current state.
|
|
13725
|
+
* @format text
|
|
13726
|
+
*/
|
|
13727
|
+
state_display_name?: string;
|
|
13601
13728
|
/**
|
|
13602
13729
|
* Title of the work object.
|
|
13603
13730
|
* @format text
|
|
@@ -15735,6 +15862,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
15735
15862
|
* used.
|
|
15736
15863
|
*/
|
|
15737
15864
|
mode?: ListMode;
|
|
15865
|
+
/** List of phone numbers, in E.164 format, to filter Dev users on. */
|
|
15866
|
+
phone_numbers?: string[];
|
|
15738
15867
|
/** Fields to sort the Dev users by and the direction to sort them. */
|
|
15739
15868
|
sort_by?: string[];
|
|
15740
15869
|
/** Filters Dev users based on state. */
|
|
@@ -16274,6 +16403,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
16274
16403
|
channel?: MeetingChannel[];
|
|
16275
16404
|
/** Filters for meetings created by the specified user(s). */
|
|
16276
16405
|
created_by?: string[];
|
|
16406
|
+
/** Direction of the meetings to be fetched. */
|
|
16407
|
+
direction?: MeetingDirection[];
|
|
16277
16408
|
/** Filters for meetings with the provided external_ref(s). */
|
|
16278
16409
|
external_ref?: string[];
|
|
16279
16410
|
/**
|
|
@@ -16398,6 +16529,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
16398
16529
|
* @format text
|
|
16399
16530
|
*/
|
|
16400
16531
|
cursor?: string;
|
|
16532
|
+
/** Direction of the meetings to be fetched. */
|
|
16533
|
+
direction?: MeetingDirection[];
|
|
16401
16534
|
/** Filters for meetings with the provided external_ref(s). */
|
|
16402
16535
|
external_ref?: string[];
|
|
16403
16536
|
/**
|
|
@@ -34,8 +34,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
|
34
34
|
};
|
|
35
35
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
36
36
|
exports.GroupedVistaFilterType = exports.GroupType = exports.GroupMemberType = exports.GroupItemType = exports.GroupIngestionSource = exports.EventTimelineEntryUpdatedReactionAction = exports.EventFetchedResult = exports.ErrorUnauthorizedType = exports.ErrorTooManyRequestsType = exports.ErrorServiceUnavailableType = exports.ErrorNotFoundType = exports.ErrorInternalServerErrorType = exports.ErrorForbiddenType = exports.ErrorConflictType = exports.ErrorBadRequestWorkflowComponentValidationErrorWorkflowComponentValidationLocationType = exports.ErrorBadRequestUnexpectedJsonTypeType = exports.ErrorBadRequestType = exports.ErrorBadRequestCustomizationValidationErrorSubtype = exports.DynamicVistaFilterType = exports.DevUsersCreateRequestStateEnumValue = exports.DevUserJobTitle = exports.DevOrgAuthConnectionsUpdateRequestType = exports.DevOrgAuthConnectionsCreateRequestType = exports.Definedness = exports.DateTimePresetType = exports.DateFilterType = exports.CustomSchemaFragmentsSetRequestType = exports.CustomSchemaFragmentsListRequestPrune = exports.ConversationsVistaGroupItemType = exports.ConversationsCreateRequestTypeValue = exports.CommandSurfaceSurface = exports.CommandSurfaceObjectTypes = exports.CommandStatus = exports.CommandActionTemplateType = exports.CommandActionExecutorType = exports.CodeChangeSource = exports.BooleanExpressionType = exports.AuthTokenTokenType = exports.AuthTokenSubjectTokenType = exports.AuthTokenStatus = exports.AuthTokenRequestedTokenType = exports.AuthTokenGrantType = exports.AuthConnectionType = exports.AuthConnectionToggle = exports.AtomType = exports.ArtifactConfigurationSet = exports.ArticleType = exports.ArticleStatus = exports.ArticleContentFormat = exports.AccessLevel = void 0;
|
|
37
|
-
exports.
|
|
38
|
-
exports.Api = exports.HttpClient = exports.ContentType = exports.WorksVistaGroupItemType = exports.WorkType = exports.WebhooksUpdateAction = exports.WebhookStatus = exports.WebhookEventType = exports.WebCrawlerJobsControlRequestAction = exports.WebCrawlerJobState = exports.VistaType = exports.VistaGroupItemType = exports.VistaGroupItemState = exports.VistaGroupItemGroupObjectType = exports.VistaFlavor = exports.UserType = exports.UserState = exports.TimelineEntryVisibility = void 0;
|
|
37
|
+
exports.TimelineEntriesUpdateRequestType = exports.TimelineEntriesCreateRequestType = exports.TimelineCommentBodyType = exports.TicketSeverity = exports.TicketChannels = exports.SyncRunMode = exports.SyncProgressState = exports.SyncMetadataFilterSyncOutFilterStatus = exports.SyncMetadataFilterSyncInFilterStatus = exports.StockSchemaFragmentsListRequestPrune = exports.StockSchemaFragmentsListRequestFilterPreset = exports.StageValidationOptionForUpdate = exports.StageValidationOptionForCreate = exports.SnapKitActionRequestElementTypeValue = exports.SlasFilterAppliesToOperatorType = exports.SlaType = exports.SlaTrackerAppliesToType = exports.SlaSummaryStage = exports.SlaStatus = exports.SlaSelectorSeverity = exports.SlaSelectorPriority = exports.SlaSelectorAppliesTo = exports.SlaEvaluationPeriod = exports.SlaAppliesTo = exports.SchemasSubtypePrepareUpdateGetResponseConflictType = exports.SchemaFieldDescriptorFieldType = exports.SchemaFieldDescriptorArrayTypeBaseType = exports.ReactionsUpdateRequestAction = exports.QuestionAnswerStatus = exports.PartsVistaGroupItemType = exports.PartType = exports.OrgType = exports.OrgScheduleStatus = exports.OrgScheduleFragmentStatus = exports.OrgEnvironment = exports.MetricTrackerType = exports.MetricDefinitionStatus = exports.MetricDefinitionMetricType = exports.MetricDefinitionAppliesTo = exports.MetricActionExecuteRequestAction = exports.MemberType = exports.MeetingState = exports.MeetingDirection = exports.MeetingChannel = exports.ListMode = exports.LinksDirection = exports.LinkType = exports.LinkEndpointType = exports.IssuePriority = exports.GroupedVistaFlavor = void 0;
|
|
38
|
+
exports.Api = exports.HttpClient = exports.ContentType = exports.WorksVistaGroupItemType = exports.WorkType = exports.WebhooksUpdateAction = exports.WebhookStatus = exports.WebhookEventType = exports.WebCrawlerJobsControlRequestAction = exports.WebCrawlerJobState = exports.VistaType = exports.VistaGroupItemType = exports.VistaGroupItemState = exports.VistaGroupItemGroupObjectType = exports.VistaFlavor = exports.UserType = exports.UserState = exports.TimelineEntryVisibility = exports.TimelineEntryType = exports.TimelineEntryObjectType = void 0;
|
|
39
39
|
var AccessLevel;
|
|
40
40
|
(function (AccessLevel) {
|
|
41
41
|
AccessLevel["External"] = "external";
|
|
@@ -104,6 +104,7 @@ var AtomType;
|
|
|
104
104
|
AtomType["SysUser"] = "sys_user";
|
|
105
105
|
AtomType["Tag"] = "tag";
|
|
106
106
|
AtomType["Ticket"] = "ticket";
|
|
107
|
+
AtomType["TimeMetricTracker"] = "time_metric_tracker";
|
|
107
108
|
AtomType["TimelineComment"] = "timeline_comment";
|
|
108
109
|
AtomType["Webhook"] = "webhook";
|
|
109
110
|
})(AtomType = exports.AtomType || (exports.AtomType = {}));
|
|
@@ -541,6 +542,17 @@ var MeetingChannel;
|
|
|
541
542
|
MeetingChannel["Teams"] = "teams";
|
|
542
543
|
MeetingChannel["Zoom"] = "zoom";
|
|
543
544
|
})(MeetingChannel = exports.MeetingChannel || (exports.MeetingChannel = {}));
|
|
545
|
+
/**
|
|
546
|
+
* Direction of meeting - meetings within an organization are internal.
|
|
547
|
+
* Meetings with external customers can be incoming or outgoing depending
|
|
548
|
+
* on who initiates them.
|
|
549
|
+
*/
|
|
550
|
+
var MeetingDirection;
|
|
551
|
+
(function (MeetingDirection) {
|
|
552
|
+
MeetingDirection["Incoming"] = "incoming";
|
|
553
|
+
MeetingDirection["Internal"] = "internal";
|
|
554
|
+
MeetingDirection["Outgoing"] = "outgoing";
|
|
555
|
+
})(MeetingDirection = exports.MeetingDirection || (exports.MeetingDirection = {}));
|
|
544
556
|
/** The state of meeting. */
|
|
545
557
|
var MeetingState;
|
|
546
558
|
(function (MeetingState) {
|
|
@@ -572,6 +584,7 @@ var MetricActionExecuteRequestAction;
|
|
|
572
584
|
var MetricDefinitionAppliesTo;
|
|
573
585
|
(function (MetricDefinitionAppliesTo) {
|
|
574
586
|
MetricDefinitionAppliesTo["Conversation"] = "conversation";
|
|
587
|
+
MetricDefinitionAppliesTo["Incident"] = "incident";
|
|
575
588
|
MetricDefinitionAppliesTo["Issue"] = "issue";
|
|
576
589
|
MetricDefinitionAppliesTo["Ticket"] = "ticket";
|
|
577
590
|
})(MetricDefinitionAppliesTo = exports.MetricDefinitionAppliesTo || (exports.MetricDefinitionAppliesTo = {}));
|
|
@@ -596,6 +609,10 @@ var MetricDefinitionStatus;
|
|
|
596
609
|
MetricDefinitionStatus["Active"] = "active";
|
|
597
610
|
MetricDefinitionStatus["Inactive"] = "inactive";
|
|
598
611
|
})(MetricDefinitionStatus = exports.MetricDefinitionStatus || (exports.MetricDefinitionStatus = {}));
|
|
612
|
+
var MetricTrackerType;
|
|
613
|
+
(function (MetricTrackerType) {
|
|
614
|
+
MetricTrackerType["TimeMetricTracker"] = "time_metric_tracker";
|
|
615
|
+
})(MetricTrackerType = exports.MetricTrackerType || (exports.MetricTrackerType = {}));
|
|
599
616
|
/** The environment of the Org. Defaults to 'production' if not specified. */
|
|
600
617
|
var OrgEnvironment;
|
|
601
618
|
(function (OrgEnvironment) {
|
|
@@ -706,6 +723,7 @@ var SchemasSubtypePrepareUpdateGetResponseConflictType;
|
|
|
706
723
|
var SlaAppliesTo;
|
|
707
724
|
(function (SlaAppliesTo) {
|
|
708
725
|
SlaAppliesTo["Conversation"] = "conversation";
|
|
726
|
+
SlaAppliesTo["Incident"] = "incident";
|
|
709
727
|
SlaAppliesTo["Issue"] = "issue";
|
|
710
728
|
SlaAppliesTo["Ticket"] = "ticket";
|
|
711
729
|
})(SlaAppliesTo = exports.SlaAppliesTo || (exports.SlaAppliesTo = {}));
|
|
@@ -728,6 +746,7 @@ var SlaEvaluationPeriod;
|
|
|
728
746
|
var SlaSelectorAppliesTo;
|
|
729
747
|
(function (SlaSelectorAppliesTo) {
|
|
730
748
|
SlaSelectorAppliesTo["Conversation"] = "conversation";
|
|
749
|
+
SlaSelectorAppliesTo["Incident"] = "incident";
|
|
731
750
|
SlaSelectorAppliesTo["Issue"] = "issue";
|
|
732
751
|
SlaSelectorAppliesTo["Ticket"] = "ticket";
|
|
733
752
|
})(SlaSelectorAppliesTo = exports.SlaSelectorAppliesTo || (exports.SlaSelectorAppliesTo = {}));
|
|
@@ -773,6 +792,7 @@ var SlaSummaryStage;
|
|
|
773
792
|
var SlaTrackerAppliesToType;
|
|
774
793
|
(function (SlaTrackerAppliesToType) {
|
|
775
794
|
SlaTrackerAppliesToType["Conversation"] = "conversation";
|
|
795
|
+
SlaTrackerAppliesToType["Incident"] = "incident";
|
|
776
796
|
SlaTrackerAppliesToType["Issue"] = "issue";
|
|
777
797
|
SlaTrackerAppliesToType["Ticket"] = "ticket";
|
|
778
798
|
})(SlaTrackerAppliesToType = exports.SlaTrackerAppliesToType || (exports.SlaTrackerAppliesToType = {}));
|