@devrev/typescript-sdk 1.1.25 → 1.1.28

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.
@@ -33,8 +33,9 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
33
33
  return (mod && mod.__esModule) ? mod : { "default": mod };
34
34
  };
35
35
  Object.defineProperty(exports, "__esModule", { value: true });
36
- exports.OrgScheduleFragmentStatus = exports.OrgEnvironment = exports.OpportunityPriority = exports.OpportunityForecastCategory = exports.MetricDefinitionMetricType = exports.MetricDefinitionAppliesTo = exports.MemberType = exports.ListMode = exports.LinksDirection = exports.LinkType = exports.LinkEndpointType = exports.IssuePriority = exports.GroupedVistaFlavor = exports.GroupType = exports.GroupMemberType = exports.EventSourceStatus = exports.ErrorUnauthorizedType = exports.ErrorTooManyRequestsType = exports.ErrorServiceUnavailableType = exports.ErrorNotFoundType = exports.ErrorInternalServerErrorType = exports.ErrorForbiddenType = exports.ErrorConflictType = exports.ErrorBadRequestUnexpectedJsonTypeType = exports.ErrorBadRequestType = exports.EngagementsCreateRequestEngagementType = exports.EngagementType = exports.DevUserJobTitle = exports.DevOrgAuthConnectionsUpdateRequestType = exports.DevOrgAuthConnectionsCreateRequestType = exports.DateTimePresetType = exports.DateFilterType = exports.CustomSchemaFragmentsSetRequestType = exports.CustomSchemaFragmentsListRequestPrune = exports.CustomSchemaFragmentType = exports.CustomSchemaFragmentFragmentType = exports.ConversationsCreateRequestTypeValue = exports.CodeChangeSource = exports.BooleanExpressionType = exports.AuthTokenTokenType = exports.AuthTokenSubjectTokenType = exports.AuthTokenStatus = exports.AuthTokenRequestedTokenType = exports.AuthTokenGrantType = exports.AuthConnectionType = exports.AuthConnectionToggle = exports.AtomType = exports.ArticleStatus = exports.AggregationDetailAggregationType = exports.AccessLevel = void 0;
37
- exports.Api = exports.HttpClient = exports.ContentType = exports.WorkType = exports.WebhooksUpdateAction = exports.WebhookStatus = exports.WebhookEventType = exports.VistaType = exports.UserType = exports.UserState = exports.UomMetricScope = exports.UnitType = exports.TimelineEntryVisibility = exports.TimelineEntryType = exports.TimelineEntryObjectType = exports.TimelineEntriesUpdateRequestType = exports.TimelineEntriesCreateRequestType = exports.TimelineEntriesCollection = exports.TimelineCommentBodyType = exports.TicketSeverity = exports.TicketChannels = exports.TaskPriority = exports.SyncMetadataFilterSyncOutFilterStatus = exports.SyncMetadataFilterSyncInFilterStatus = exports.StockSchemaFragmentsListRequestPrune = exports.StockSchemaFragmentsListRequestFilterPreset = exports.StageValidationOptionForUpdate = exports.StageValidationOptionForCreate = exports.SnapWidgetsCreateRequestType = exports.SnapWidgetType = exports.SnapWidgetStatus = exports.SnapWidgetNamespace = exports.SlaSummaryStage = exports.SlaStatus = exports.SlaSelectorSeverity = exports.SlaSelectorPriority = exports.SlaSelectorAppliesTo = exports.SlaEvaluationPeriod = exports.SearchSortOrderParam = exports.SearchSortByParam = exports.SearchResultType = exports.SearchNamespace = exports.SearchHybridNamespace = exports.SchemaFieldDescriptorFieldType = exports.SchemaFieldDescriptorArrayTypeBaseType = exports.QuestionAnswerStatus = exports.PartType = exports.OrgType = exports.OrgScheduleStatus = void 0;
36
+ exports.OrgEnvironment = exports.OpportunityPriority = exports.OpportunityForecastCategory = exports.MetricDefinitionStatus = exports.MetricDefinitionMetricType = exports.MetricDefinitionAppliesTo = exports.MemberType = exports.ListMode = exports.LinksDirection = exports.LinkType = exports.LinkEndpointType = exports.IssuePriority = exports.GroupedVistaFlavor = exports.GroupType = exports.GroupMemberType = exports.EventSourceStatus = exports.ErrorUnauthorizedType = exports.ErrorTooManyRequestsType = exports.ErrorServiceUnavailableType = exports.ErrorNotFoundType = exports.ErrorInternalServerErrorType = exports.ErrorForbiddenType = exports.ErrorConflictType = exports.ErrorBadRequestUnexpectedJsonTypeType = exports.ErrorBadRequestType = exports.EngagementsCreateRequestEngagementType = exports.EngagementType = exports.DevUserJobTitle = exports.DevOrgAuthConnectionsUpdateRequestType = exports.DevOrgAuthConnectionsCreateRequestType = exports.DateTimePresetType = exports.DateFilterType = exports.CustomSchemaFragmentsSetRequestType = exports.CustomSchemaFragmentsListRequestPrune = exports.CustomSchemaFragmentType = exports.CustomSchemaFragmentFragmentType = exports.ConversationsCreateRequestTypeValue = exports.CodeChangeSource = exports.BooleanExpressionType = exports.AuthTokenTokenType = exports.AuthTokenSubjectTokenType = exports.AuthTokenStatus = exports.AuthTokenRequestedTokenType = exports.AuthTokenGrantType = exports.AuthConnectionType = exports.AuthConnectionToggle = exports.AtomType = exports.ArticleStatus = exports.AggregationDetailAggregationType = exports.AccessLevel = void 0;
37
+ exports.WebhookStatus = exports.WebhookEventType = exports.VistaType = exports.VistaGroupItemType = exports.VistaGroupItemState = exports.UserType = exports.UserState = exports.UomMetricScope = exports.UnitType = exports.TimelineEntryVisibility = exports.TimelineEntryType = exports.TimelineEntryObjectType = exports.TimelineEntriesUpdateRequestType = exports.TimelineEntriesCreateRequestType = exports.TimelineEntriesCollection = exports.TimelineCommentBodyType = exports.TicketSeverity = exports.TicketChannels = exports.TaskPriority = exports.SyncMetadataFilterSyncOutFilterStatus = exports.SyncMetadataFilterSyncInFilterStatus = exports.StockSchemaFragmentsListRequestPrune = exports.StockSchemaFragmentsListRequestFilterPreset = exports.StageValidationOptionForUpdate = exports.StageValidationOptionForCreate = exports.SnapWidgetsCreateRequestType = exports.SnapWidgetType = exports.SnapWidgetStatus = exports.SnapWidgetNamespace = exports.SlasFilterAppliesToOperatorType = exports.SlaType = exports.SlaSummaryStage = exports.SlaStatus = exports.SlaSelectorSeverity = exports.SlaSelectorPriority = exports.SlaSelectorAppliesTo = exports.SlaEvaluationPeriod = exports.SlaAppliesTo = exports.SearchSortOrderParam = exports.SearchSortByParam = exports.SearchResultType = exports.SearchNamespace = exports.SearchHybridNamespace = exports.SchemaFieldDescriptorFieldType = exports.SchemaFieldDescriptorArrayTypeBaseType = exports.QuestionAnswerStatus = exports.PartType = exports.OrgType = exports.OrgScheduleStatus = exports.OrgScheduleFragmentStatus = void 0;
38
+ exports.Api = exports.HttpClient = exports.ContentType = exports.WorkType = exports.WebhooksUpdateAction = void 0;
38
39
  var AccessLevel;
39
40
  (function (AccessLevel) {
40
41
  AccessLevel["External"] = "external";
@@ -189,6 +190,7 @@ var BooleanExpressionType;
189
190
  /** Source of the code change object. */
190
191
  var CodeChangeSource;
191
192
  (function (CodeChangeSource) {
193
+ CodeChangeSource["Bitbucket"] = "bitbucket";
192
194
  CodeChangeSource["Github"] = "github";
193
195
  })(CodeChangeSource = exports.CodeChangeSource || (exports.CodeChangeSource = {}));
194
196
  var ConversationsCreateRequestTypeValue;
@@ -292,14 +294,17 @@ var EngagementsCreateRequestEngagementType;
292
294
  })(EngagementsCreateRequestEngagementType = exports.EngagementsCreateRequestEngagementType || (exports.EngagementsCreateRequestEngagementType = {}));
293
295
  var ErrorBadRequestType;
294
296
  (function (ErrorBadRequestType) {
297
+ ErrorBadRequestType["ArtifactAlreadyAttachedToAParent"] = "artifact_already_attached_to_a_parent";
295
298
  ErrorBadRequestType["BadRequest"] = "bad_request";
296
299
  ErrorBadRequestType["InvalidApiVersion"] = "invalid_api_version";
297
300
  ErrorBadRequestType["InvalidEnumValue"] = "invalid_enum_value";
298
301
  ErrorBadRequestType["InvalidField"] = "invalid_field";
302
+ ErrorBadRequestType["InvalidId"] = "invalid_id";
299
303
  ErrorBadRequestType["MissingDependency"] = "missing_dependency";
300
304
  ErrorBadRequestType["MissingRequiredField"] = "missing_required_field";
301
305
  ErrorBadRequestType["ParseError"] = "parse_error";
302
306
  ErrorBadRequestType["StaleSchemaFragments"] = "stale_schema_fragments";
307
+ ErrorBadRequestType["UnexpectedIdType"] = "unexpected_id_type";
303
308
  ErrorBadRequestType["UnexpectedJsonType"] = "unexpected_json_type";
304
309
  ErrorBadRequestType["ValueNotPermitted"] = "value_not_permitted";
305
310
  })(ErrorBadRequestType = exports.ErrorBadRequestType || (exports.ErrorBadRequestType = {}));
@@ -433,6 +438,7 @@ var MemberType;
433
438
  var MetricDefinitionAppliesTo;
434
439
  (function (MetricDefinitionAppliesTo) {
435
440
  MetricDefinitionAppliesTo["Conversation"] = "conversation";
441
+ MetricDefinitionAppliesTo["Issue"] = "issue";
436
442
  MetricDefinitionAppliesTo["Ticket"] = "ticket";
437
443
  })(MetricDefinitionAppliesTo = exports.MetricDefinitionAppliesTo || (exports.MetricDefinitionAppliesTo = {}));
438
444
  /**
@@ -446,6 +452,16 @@ var MetricDefinitionMetricType;
446
452
  MetricDefinitionMetricType["Time"] = "time";
447
453
  MetricDefinitionMetricType["Value"] = "value";
448
454
  })(MetricDefinitionMetricType = exports.MetricDefinitionMetricType || (exports.MetricDefinitionMetricType = {}));
455
+ /**
456
+ * The status of the metric. 'active' metrics can be used to create new
457
+ * SLAs, while 'inactive' metrics can not be used in new SLAs. Metrics can
458
+ * be updated between 'active' and 'inactive' states.
459
+ */
460
+ var MetricDefinitionStatus;
461
+ (function (MetricDefinitionStatus) {
462
+ MetricDefinitionStatus["Active"] = "active";
463
+ MetricDefinitionStatus["Inactive"] = "inactive";
464
+ })(MetricDefinitionStatus = exports.MetricDefinitionStatus || (exports.MetricDefinitionStatus = {}));
449
465
  /** Forecast category of the opportunity. */
450
466
  var OpportunityForecastCategory;
451
467
  (function (OpportunityForecastCategory) {
@@ -509,6 +525,7 @@ var PartType;
509
525
  var QuestionAnswerStatus;
510
526
  (function (QuestionAnswerStatus) {
511
527
  QuestionAnswerStatus["Archived"] = "archived";
528
+ QuestionAnswerStatus["Discarded"] = "discarded";
512
529
  QuestionAnswerStatus["Draft"] = "draft";
513
530
  QuestionAnswerStatus["Published"] = "published";
514
531
  QuestionAnswerStatus["ReviewNeeded"] = "review_needed";
@@ -564,6 +581,7 @@ var SearchNamespace;
564
581
  SearchNamespace["Capability"] = "capability";
565
582
  SearchNamespace["Component"] = "component";
566
583
  SearchNamespace["Conversation"] = "conversation";
584
+ SearchNamespace["CustomObject"] = "custom_object";
567
585
  SearchNamespace["CustomPart"] = "custom_part";
568
586
  SearchNamespace["CustomWork"] = "custom_work";
569
587
  SearchNamespace["Dashboard"] = "dashboard";
@@ -595,6 +613,7 @@ var SearchResultType;
595
613
  SearchResultType["Article"] = "article";
596
614
  SearchResultType["Artifact"] = "artifact";
597
615
  SearchResultType["Conversation"] = "conversation";
616
+ SearchResultType["CustomObject"] = "custom_object";
598
617
  SearchResultType["Dashboard"] = "dashboard";
599
618
  SearchResultType["Group"] = "group";
600
619
  SearchResultType["Link"] = "link";
@@ -620,6 +639,17 @@ var SearchSortOrderParam;
620
639
  SearchSortOrderParam["Asc"] = "asc";
621
640
  SearchSortOrderParam["Desc"] = "desc";
622
641
  })(SearchSortOrderParam = exports.SearchSortOrderParam || (exports.SearchSortOrderParam = {}));
642
+ /**
643
+ * The object types on which the SLA applies. An external SLA can apply to
644
+ * multiple object types, but an internal SLA can apply to only one object
645
+ * type.
646
+ */
647
+ var SlaAppliesTo;
648
+ (function (SlaAppliesTo) {
649
+ SlaAppliesTo["Conversation"] = "conversation";
650
+ SlaAppliesTo["Issue"] = "issue";
651
+ SlaAppliesTo["Ticket"] = "ticket";
652
+ })(SlaAppliesTo = exports.SlaAppliesTo || (exports.SlaAppliesTo = {}));
623
653
  /**
624
654
  * Specifies the frequency of when the contractually-meaningful evaluation
625
655
  * of the SLA happens. The organization for their own information might
@@ -639,9 +669,10 @@ var SlaEvaluationPeriod;
639
669
  var SlaSelectorAppliesTo;
640
670
  (function (SlaSelectorAppliesTo) {
641
671
  SlaSelectorAppliesTo["Conversation"] = "conversation";
672
+ SlaSelectorAppliesTo["Issue"] = "issue";
642
673
  SlaSelectorAppliesTo["Ticket"] = "ticket";
643
674
  })(SlaSelectorAppliesTo = exports.SlaSelectorAppliesTo || (exports.SlaSelectorAppliesTo = {}));
644
- /** Th SLA policy applies to conversations with these priorities. */
675
+ /** The SLA policy applies to conversations with these priorities. */
645
676
  var SlaSelectorPriority;
646
677
  (function (SlaSelectorPriority) {
647
678
  SlaSelectorPriority["P0"] = "p0";
@@ -679,6 +710,17 @@ var SlaSummaryStage;
679
710
  SlaSummaryStage["Running"] = "running";
680
711
  SlaSummaryStage["Warning"] = "warning";
681
712
  })(SlaSummaryStage = exports.SlaSummaryStage || (exports.SlaSummaryStage = {}));
713
+ /** Type of the SLA. */
714
+ var SlaType;
715
+ (function (SlaType) {
716
+ SlaType["External"] = "external";
717
+ SlaType["Internal"] = "internal";
718
+ })(SlaType = exports.SlaType || (exports.SlaType = {}));
719
+ var SlasFilterAppliesToOperatorType;
720
+ (function (SlasFilterAppliesToOperatorType) {
721
+ SlasFilterAppliesToOperatorType["All"] = "all";
722
+ SlasFilterAppliesToOperatorType["Any"] = "any";
723
+ })(SlasFilterAppliesToOperatorType = exports.SlasFilterAppliesToOperatorType || (exports.SlasFilterAppliesToOperatorType = {}));
682
724
  /** Logical grouping of snap widgets. Useful for filtering. */
683
725
  var SnapWidgetNamespace;
684
726
  (function (SnapWidgetNamespace) {
@@ -747,6 +789,7 @@ var TicketChannels;
747
789
  TicketChannels["Email"] = "email";
748
790
  TicketChannels["Plug"] = "plug";
749
791
  TicketChannels["Slack"] = "slack";
792
+ TicketChannels["Twilio"] = "twilio";
750
793
  })(TicketChannels = exports.TicketChannels || (exports.TicketChannels = {}));
751
794
  /** Severity of the ticket. */
752
795
  var TicketSeverity;
@@ -849,6 +892,19 @@ var UserType;
849
892
  UserType["ServiceAccount"] = "service_account";
850
893
  UserType["SysUser"] = "sys_user";
851
894
  })(UserType = exports.UserType || (exports.UserType = {}));
895
+ /** Defines the state of the group item. */
896
+ var VistaGroupItemState;
897
+ (function (VistaGroupItemState) {
898
+ VistaGroupItemState["Active"] = "active";
899
+ VistaGroupItemState["Completed"] = "completed";
900
+ VistaGroupItemState["Planned"] = "planned";
901
+ })(VistaGroupItemState = exports.VistaGroupItemState || (exports.VistaGroupItemState = {}));
902
+ /** Type of the group object. */
903
+ var VistaGroupItemType;
904
+ (function (VistaGroupItemType) {
905
+ VistaGroupItemType["Curated"] = "curated";
906
+ VistaGroupItemType["Dynamic"] = "dynamic";
907
+ })(VistaGroupItemType = exports.VistaGroupItemType || (exports.VistaGroupItemType = {}));
852
908
  /** Type of vista object. */
853
909
  var VistaType;
854
910
  (function (VistaType) {
@@ -1535,6 +1591,24 @@ class Api extends HttpClient {
1535
1591
  * @secure
1536
1592
  */
1537
1593
  this.devUsersGetPost = (data, params = {}) => this.request(Object.assign({ path: `/dev-users.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
1594
+ /**
1595
+ * @description Links an external/secondary identity to the Dev user.
1596
+ *
1597
+ * @tags dev-users
1598
+ * @name DevUsersIdentitiesLink
1599
+ * @request POST:/dev-users.identities.link
1600
+ * @secure
1601
+ */
1602
+ this.devUsersIdentitiesLink = (data, params = {}) => this.request(Object.assign({ path: `/dev-users.identities.link`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
1603
+ /**
1604
+ * @description Unlinks an external/secondary identity from the Dev user.
1605
+ *
1606
+ * @tags dev-users
1607
+ * @name DevUsersIdentitiesUnlink
1608
+ * @request POST:/dev-users.identities.unlink
1609
+ * @secure
1610
+ */
1611
+ this.devUsersIdentitiesUnlink = (data, params = {}) => this.request(Object.assign({ path: `/dev-users.identities.unlink`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
1538
1612
  /**
1539
1613
  * @description Lists users within your organization.
1540
1614
  *
@@ -545,6 +545,14 @@ export declare enum AuthTokenSubjectTokenType {
545
545
  export declare enum AuthTokenTokenType {
546
546
  Bearer = "bearer"
547
547
  }
548
+ /**
549
+ * auth-tokens-account-traits
550
+ * Carries account info.
551
+ */
552
+ export interface AuthTokensAccountTraits {
553
+ /** The display name of the account. */
554
+ display_name?: string;
555
+ }
548
556
  /**
549
557
  * auth-tokens-create-request
550
558
  * A request to create a new token corresponding to the requested token
@@ -708,6 +716,10 @@ export interface AuthTokensOrgTraits {
708
716
  * issue a Rev session token.
709
717
  */
710
718
  export interface AuthTokensRevInfo {
719
+ /** An identifier which uniquely identifies an account. */
720
+ account_ref?: string;
721
+ /** Carries account info. */
722
+ account_traits?: AuthTokensAccountTraits;
711
723
  /** An identifier which uniquely identifies a Rev org. */
712
724
  org_ref?: string;
713
725
  /** Carries Rev org info. */
@@ -718,6 +730,10 @@ export interface AuthTokensRevInfo {
718
730
  user_ref?: string;
719
731
  /** Carries Rev user info. */
720
732
  user_traits?: AuthTokensUserTraits;
733
+ /** An identifier which uniquely identifies a workspace. */
734
+ workspace_ref?: string;
735
+ /** Carries Rev org info. */
736
+ workspace_traits?: AuthTokensOrgTraits;
721
737
  }
722
738
  /**
723
739
  * auth-tokens-self-delete-request
@@ -1006,8 +1022,18 @@ export interface DevOrgAuthConnectionsUpdateResponse {
1006
1022
  }
1007
1023
  /** dev-user */
1008
1024
  export type DevUser = UserBase & {
1025
+ /**
1026
+ * Start date of the user's employment.
1027
+ * @format date-time
1028
+ * @example "2023-01-01T12:00:00.000Z"
1029
+ */
1030
+ experience_start_date?: string;
1009
1031
  /** IDs of the Dev User outside the DevRev SOR. */
1010
1032
  external_identities?: ExternalIdentity[];
1033
+ /** Job history of the user. */
1034
+ job_history?: JobHistoryItem[];
1035
+ /** Array of skills of the user. */
1036
+ skills?: UserSkill[];
1011
1037
  };
1012
1038
  /** dev-user-external-identity-filter */
1013
1039
  export interface DevUserExternalIdentityFilter {
@@ -1038,6 +1064,8 @@ export interface DevUsersGetResponse {
1038
1064
  * A request to get the list of Dev user's information.
1039
1065
  */
1040
1066
  export interface DevUsersListRequest {
1067
+ /** Provides ways to specify date ranges on objects. */
1068
+ created_date?: DateFilter;
1041
1069
  /**
1042
1070
  * The cursor to resume iteration from. If not provided, then
1043
1071
  * iteration starts from the beginning.
@@ -1060,6 +1088,8 @@ export interface DevUsersListRequest {
1060
1088
  * always be returned in the specified sort-by order.
1061
1089
  */
1062
1090
  mode?: ListMode;
1091
+ /** Provides ways to specify date ranges on objects. */
1092
+ modified_date?: DateFilter;
1063
1093
  /** Fields to sort the Dev users by and the direction to sort them. */
1064
1094
  sort_by?: string[];
1065
1095
  /** Filters Dev users based on state. */
@@ -1101,10 +1131,35 @@ export type Empty = object;
1101
1131
  export type Enhancement = PartBase;
1102
1132
  /** enhancement-summary */
1103
1133
  export type EnhancementSummary = PartBaseSummary;
1134
+ /**
1135
+ * enum-value
1136
+ * Enum Value defines the structure for an enum.
1137
+ */
1138
+ export interface EnumValue {
1139
+ /**
1140
+ * Unique ID of the enum value. This is immutable.
1141
+ * @format int64
1142
+ */
1143
+ id: number;
1144
+ /** Display label of the enum value. This is mutable. */
1145
+ label: string;
1146
+ /**
1147
+ * Order number of the enum value. This is mutable.
1148
+ * @format int64
1149
+ */
1150
+ ordinal: number;
1151
+ }
1104
1152
  /** error-bad-request */
1105
- export type ErrorBadRequest = ErrorBase & (ErrorBadRequestBadRequest | ErrorBadRequestInvalidApiVersion | ErrorBadRequestInvalidEnumValue | ErrorBadRequestInvalidField | ErrorBadRequestMissingDependency | ErrorBadRequestMissingRequiredField | ErrorBadRequestParseError | ErrorBadRequestStaleSchemaFragments | ErrorBadRequestUnexpectedJsonType | ErrorBadRequestValueNotPermitted) & {
1153
+ export type ErrorBadRequest = ErrorBase & (ErrorBadRequestArtifactAlreadyAttachedToAParent | ErrorBadRequestBadRequest | ErrorBadRequestInvalidApiVersion | ErrorBadRequestInvalidEnumValue | ErrorBadRequestInvalidField | ErrorBadRequestInvalidId | ErrorBadRequestMissingDependency | ErrorBadRequestMissingRequiredField | ErrorBadRequestParseError | ErrorBadRequestStaleSchemaFragments | ErrorBadRequestUnexpectedIdType | ErrorBadRequestUnexpectedJsonType | ErrorBadRequestValueNotPermitted) & {
1106
1154
  type: ErrorBadRequestType;
1107
1155
  };
1156
+ /** error-bad-request-artifact-already-attached-to-a-parent */
1157
+ export interface ErrorBadRequestArtifactAlreadyAttachedToAParent {
1158
+ /** The existing parent attached to the artifact. */
1159
+ existing_parent: string;
1160
+ /** Whether the existing parent is the same as the new parent. */
1161
+ is_same: boolean;
1162
+ }
1108
1163
  /** error-bad-request-bad-request */
1109
1164
  export type ErrorBadRequestBadRequest = object;
1110
1165
  /** error-bad-request-invalid-api-version */
@@ -1126,6 +1181,11 @@ export interface ErrorBadRequestInvalidField {
1126
1181
  /** The field name that's invalid. */
1127
1182
  field_name: string;
1128
1183
  }
1184
+ /** error-bad-request-invalid-id */
1185
+ export interface ErrorBadRequestInvalidId {
1186
+ /** The field whose ID is invalid. */
1187
+ field_name: string;
1188
+ }
1129
1189
  /** error-bad-request-missing-dependency */
1130
1190
  export interface ErrorBadRequestMissingDependency {
1131
1191
  /** The dependent fields. */
@@ -1163,17 +1223,25 @@ export type ErrorBadRequestParseError = object;
1163
1223
  */
1164
1224
  export type ErrorBadRequestStaleSchemaFragments = object;
1165
1225
  export declare enum ErrorBadRequestType {
1226
+ ArtifactAlreadyAttachedToAParent = "artifact_already_attached_to_a_parent",
1166
1227
  BadRequest = "bad_request",
1167
1228
  InvalidApiVersion = "invalid_api_version",
1168
1229
  InvalidEnumValue = "invalid_enum_value",
1169
1230
  InvalidField = "invalid_field",
1231
+ InvalidId = "invalid_id",
1170
1232
  MissingDependency = "missing_dependency",
1171
1233
  MissingRequiredField = "missing_required_field",
1172
1234
  ParseError = "parse_error",
1173
1235
  StaleSchemaFragments = "stale_schema_fragments",
1236
+ UnexpectedIdType = "unexpected_id_type",
1174
1237
  UnexpectedJsonType = "unexpected_json_type",
1175
1238
  ValueNotPermitted = "value_not_permitted"
1176
1239
  }
1240
+ /** error-bad-request-unexpected-id-type */
1241
+ export interface ErrorBadRequestUnexpectedIdType {
1242
+ /** The field whose ID type is unexpected. */
1243
+ field_name: string;
1244
+ }
1177
1245
  /** error-bad-request-unexpected-json-type */
1178
1246
  export interface ErrorBadRequestUnexpectedJsonType {
1179
1247
  actual: ErrorBadRequestUnexpectedJsonTypeType;
@@ -1459,7 +1527,16 @@ export interface EventWorkUpdated {
1459
1527
  * external-identity
1460
1528
  * External identity of a user.
1461
1529
  */
1462
- export type ExternalIdentity = object;
1530
+ export interface ExternalIdentity {
1531
+ /** Display name of the user in the external source. */
1532
+ display_name?: string;
1533
+ /** Unique ID of the user in the external source. */
1534
+ id?: string;
1535
+ /** Whether the external identity is verified or not. */
1536
+ is_verified?: boolean;
1537
+ /** Issuer of the external identity of the user. */
1538
+ issuer?: string;
1539
+ }
1463
1540
  /** feature */
1464
1541
  export type Feature = PartBase;
1465
1542
  /** feature-summary */
@@ -1472,6 +1549,8 @@ export type Issue = WorkBase & {
1472
1549
  developed_with?: PartSummary[];
1473
1550
  /** Priority of the work based upon impact and criticality. */
1474
1551
  priority?: IssuePriority;
1552
+ /** Vista group item. */
1553
+ sprint?: VistaGroupItemSummary;
1475
1554
  /**
1476
1555
  * Target start date for the object.
1477
1556
  * @format date-time
@@ -1486,6 +1565,32 @@ export declare enum IssuePriority {
1486
1565
  P2 = "p2",
1487
1566
  P3 = "p3"
1488
1567
  }
1568
+ /**
1569
+ * job-history-item
1570
+ * Defines a job history line item.
1571
+ */
1572
+ export interface JobHistoryItem {
1573
+ /** Enum Value defines the structure for an enum. */
1574
+ employment_status?: EnumValue;
1575
+ /**
1576
+ * The end date of the job, or not specified if current.
1577
+ * @format date-time
1578
+ * @example "2023-01-01T12:00:00.000Z"
1579
+ */
1580
+ end_date?: string;
1581
+ /** Is this the current active job for the user. */
1582
+ is_current?: boolean;
1583
+ /** The job location for the user. */
1584
+ location?: string;
1585
+ /**
1586
+ * The start date of the job.
1587
+ * @format date-time
1588
+ * @example "2023-01-01T12:00:00.000Z"
1589
+ */
1590
+ start_date?: string;
1591
+ /** The job title for the user. */
1592
+ title?: string;
1593
+ }
1489
1594
  /**
1490
1595
  * legacy-stage
1491
1596
  * Describes the current stage of a work item.
@@ -1789,14 +1894,14 @@ export interface PartsUpdateRequestEnhancement {
1789
1894
  * @format date-time
1790
1895
  * @example "2023-01-01T12:00:00.000Z"
1791
1896
  */
1792
- target_close_date?: string;
1897
+ target_close_date?: string | null;
1793
1898
  /**
1794
1899
  * Updates the target start date of the enhancement. Example Date
1795
1900
  * Format: 2000-11-01T01:01:01Z
1796
1901
  * @format date-time
1797
1902
  * @example "2023-01-01T12:00:00.000Z"
1798
1903
  */
1799
- target_start_date?: string;
1904
+ target_start_date?: string | null;
1800
1905
  }
1801
1906
  /** parts-update-request-feature */
1802
1907
  export type PartsUpdateRequestFeature = object;
@@ -2048,6 +2153,8 @@ export declare enum SlaStatus {
2048
2153
  export type SlaSummary = AtomBaseSummary & {
2049
2154
  /** Human-readable name. */
2050
2155
  name: string;
2156
+ /** Type of the SLA. */
2157
+ sla_type?: SlaType;
2051
2158
  /**
2052
2159
  * Status determines how an item can be used. In 'draft' status an item
2053
2160
  * can be edited but can't be used. When 'published' the item can longer
@@ -2108,6 +2215,11 @@ export interface SlaTrackersGetRequest {
2108
2215
  export interface SlaTrackersGetResponse {
2109
2216
  sla_tracker: SlaTracker;
2110
2217
  }
2218
+ /** Type of the SLA. */
2219
+ export declare enum SlaType {
2220
+ External = "external",
2221
+ Internal = "internal"
2222
+ }
2111
2223
  /** snap-widget */
2112
2224
  export interface SnapWidget {
2113
2225
  type: SnapWidgetType;
@@ -2159,10 +2271,17 @@ export type SurveyAggregationFilter = object;
2159
2271
  export type SurveyResponse = AtomBase & {
2160
2272
  /** The unique ID associated with the dispatched survey. */
2161
2273
  dispatch_id?: string;
2274
+ /** Source channels on which the survey is sent. */
2275
+ dispatched_channels?: EnumValue[];
2162
2276
  /** The ID of the object for which survey is taken. */
2163
2277
  object?: string;
2278
+ recipient?: UserSummary;
2164
2279
  /** Response for the survey. */
2165
2280
  response?: object;
2281
+ /** Enum Value defines the structure for an enum. */
2282
+ response_channel?: EnumValue;
2283
+ /** Enum Value defines the structure for an enum. */
2284
+ stage?: EnumValue;
2166
2285
  /** The ID of the survey for which response is taken. */
2167
2286
  survey?: string;
2168
2287
  };
@@ -2380,6 +2499,8 @@ export type Ticket = WorkBase & {
2380
2499
  /** Channels of the ticket. */
2381
2500
  channels?: TicketChannels[];
2382
2501
  group?: GroupSummary;
2502
+ /** Whether the ticket needs a response. */
2503
+ needs_response?: boolean;
2383
2504
  rev_org?: OrgSummary;
2384
2505
  /** Severity of the ticket. */
2385
2506
  severity?: TicketSeverity;
@@ -2391,7 +2512,8 @@ export type Ticket = WorkBase & {
2391
2512
  export declare enum TicketChannels {
2392
2513
  Email = "email",
2393
2514
  Plug = "plug",
2394
- Slack = "slack"
2515
+ Slack = "slack",
2516
+ Twilio = "twilio"
2395
2517
  }
2396
2518
  /** Severity of the ticket. */
2397
2519
  export declare enum TicketSeverity {
@@ -2719,6 +2841,14 @@ export type UserBaseSummary = AtomBaseSummary & {
2719
2841
  /** State of the user. */
2720
2842
  state?: UserState;
2721
2843
  };
2844
+ /**
2845
+ * user-skill
2846
+ * Skill associated with the user.
2847
+ */
2848
+ export interface UserSkill {
2849
+ /** Name of the skill. */
2850
+ name?: string;
2851
+ }
2722
2852
  /** State of the user. */
2723
2853
  export declare enum UserState {
2724
2854
  Active = "active",
@@ -2737,6 +2867,43 @@ export declare enum UserType {
2737
2867
  RevUser = "rev_user",
2738
2868
  SysUser = "sys_user"
2739
2869
  }
2870
+ /** Defines the state of the group item. */
2871
+ export declare enum VistaGroupItemState {
2872
+ Active = "active",
2873
+ Completed = "completed",
2874
+ Planned = "planned"
2875
+ }
2876
+ /**
2877
+ * vista-group-item-summary
2878
+ * Vista group item.
2879
+ */
2880
+ export interface VistaGroupItemSummary {
2881
+ /**
2882
+ * Timestamp when the vista ends.
2883
+ * @format date-time
2884
+ * @example "2023-01-01T12:00:00.000Z"
2885
+ */
2886
+ end_date?: string;
2887
+ /** ID of the group item in don v2 format. */
2888
+ id: string;
2889
+ /** Name of the group. */
2890
+ name: string;
2891
+ /**
2892
+ * Timestamp when the vista starts.
2893
+ * @format date-time
2894
+ * @example "2023-01-01T12:00:00.000Z"
2895
+ */
2896
+ start_date?: string;
2897
+ /** Defines the state of the group item. */
2898
+ state?: VistaGroupItemState;
2899
+ /** Type of the group object. */
2900
+ type: VistaGroupItemType;
2901
+ }
2902
+ /** Type of the group object. */
2903
+ export declare enum VistaGroupItemType {
2904
+ Curated = "curated",
2905
+ Dynamic = "dynamic"
2906
+ }
2740
2907
  /** webhook */
2741
2908
  export type Webhook = AtomBase & {
2742
2909
  /** The event types that the webhook will receive. */
@@ -3208,6 +3375,8 @@ export interface WorksFilterIssue {
3208
3375
  * @example ["REV-AbCdEfGh"]
3209
3376
  */
3210
3377
  rev_orgs?: string[];
3378
+ /** Filters for issues with any of the sprint. */
3379
+ sprint?: string[];
3211
3380
  /** Provides ways to specify date ranges on objects. */
3212
3381
  target_start_date?: DateFilter;
3213
3382
  }
@@ -4601,6 +4770,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
4601
4770
  * @example ["REV-AbCdEfGh"]
4602
4771
  */
4603
4772
  'issue.rev_orgs'?: string[];
4773
+ /** Filters for issues with any of the sprint. */
4774
+ 'issue.sprint'?: string[];
4604
4775
  /**
4605
4776
  * Filters for work owned by any of these users.
4606
4777
  * @example ["DEVU-12345"]
@@ -4724,6 +4895,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
4724
4895
  * @example ["REV-AbCdEfGh"]
4725
4896
  */
4726
4897
  'issue.rev_orgs'?: string[];
4898
+ /** Filters for issues with any of the sprint. */
4899
+ 'issue.sprint'?: string[];
4727
4900
  /**
4728
4901
  * The maximum number of works to return. The default is '50'.
4729
4902
  * @format int32
@@ -33,7 +33,8 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
33
33
  return (mod && mod.__esModule) ? mod : { "default": mod };
34
34
  };
35
35
  Object.defineProperty(exports, "__esModule", { value: true });
36
- exports.Api = exports.HttpClient = exports.ContentType = exports.WorkType = exports.WebhooksUpdateAction = exports.WebhookStatus = exports.WebhookEventType = exports.UserType = exports.UserState = exports.TimelineEntryVisibility = exports.TimelineEntryType = exports.TimelineEntryObjectType = exports.TimelineEntriesUpdateRequestType = exports.TimelineEntriesCreateRequestType = exports.TimelineCommentBodyType = exports.TicketSeverity = exports.TicketChannels = exports.SyncMetadataFilterSyncOutFilterStatus = exports.SyncMetadataFilterSyncInFilterStatus = exports.StageValidationOptionForUpdate = exports.StageValidationOptionForCreate = exports.SlaSummaryStage = exports.SlaStatus = exports.PartType = exports.OrgType = exports.OrgScheduleStatus = exports.OrgEnvironment = exports.ListMode = exports.IssuePriority = exports.ErrorUnauthorizedType = exports.ErrorTooManyRequestsType = exports.ErrorServiceUnavailableType = exports.ErrorNotFoundType = exports.ErrorInternalServerErrorType = exports.ErrorForbiddenType = exports.ErrorConflictType = exports.ErrorBadRequestUnexpectedJsonTypeType = exports.ErrorBadRequestType = exports.DevOrgAuthConnectionsUpdateRequestType = exports.DevOrgAuthConnectionsCreateRequestType = exports.DateTimePresetType = exports.DateFilterType = exports.AuthTokenTokenType = exports.AuthTokenSubjectTokenType = exports.AuthTokenStatus = exports.AuthTokenRequestedTokenType = exports.AuthTokenGrantType = exports.AuthConnectionType = exports.AuthConnectionToggle = void 0;
36
+ exports.ContentType = exports.WorkType = exports.WebhooksUpdateAction = exports.WebhookStatus = exports.WebhookEventType = exports.VistaGroupItemType = exports.VistaGroupItemState = exports.UserType = exports.UserState = exports.TimelineEntryVisibility = exports.TimelineEntryType = exports.TimelineEntryObjectType = exports.TimelineEntriesUpdateRequestType = exports.TimelineEntriesCreateRequestType = exports.TimelineCommentBodyType = exports.TicketSeverity = exports.TicketChannels = exports.SyncMetadataFilterSyncOutFilterStatus = exports.SyncMetadataFilterSyncInFilterStatus = exports.StageValidationOptionForUpdate = exports.StageValidationOptionForCreate = exports.SlaType = exports.SlaSummaryStage = exports.SlaStatus = exports.PartType = exports.OrgType = exports.OrgScheduleStatus = exports.OrgEnvironment = exports.ListMode = exports.IssuePriority = exports.ErrorUnauthorizedType = exports.ErrorTooManyRequestsType = exports.ErrorServiceUnavailableType = exports.ErrorNotFoundType = exports.ErrorInternalServerErrorType = exports.ErrorForbiddenType = exports.ErrorConflictType = exports.ErrorBadRequestUnexpectedJsonTypeType = exports.ErrorBadRequestType = exports.DevOrgAuthConnectionsUpdateRequestType = exports.DevOrgAuthConnectionsCreateRequestType = exports.DateTimePresetType = exports.DateFilterType = exports.AuthTokenTokenType = exports.AuthTokenSubjectTokenType = exports.AuthTokenStatus = exports.AuthTokenRequestedTokenType = exports.AuthTokenGrantType = exports.AuthConnectionType = exports.AuthConnectionToggle = void 0;
37
+ exports.Api = exports.HttpClient = void 0;
37
38
  var AuthConnectionToggle;
38
39
  (function (AuthConnectionToggle) {
39
40
  AuthConnectionToggle["Disable"] = "disable";
@@ -141,14 +142,17 @@ var DevOrgAuthConnectionsUpdateRequestType;
141
142
  })(DevOrgAuthConnectionsUpdateRequestType = exports.DevOrgAuthConnectionsUpdateRequestType || (exports.DevOrgAuthConnectionsUpdateRequestType = {}));
142
143
  var ErrorBadRequestType;
143
144
  (function (ErrorBadRequestType) {
145
+ ErrorBadRequestType["ArtifactAlreadyAttachedToAParent"] = "artifact_already_attached_to_a_parent";
144
146
  ErrorBadRequestType["BadRequest"] = "bad_request";
145
147
  ErrorBadRequestType["InvalidApiVersion"] = "invalid_api_version";
146
148
  ErrorBadRequestType["InvalidEnumValue"] = "invalid_enum_value";
147
149
  ErrorBadRequestType["InvalidField"] = "invalid_field";
150
+ ErrorBadRequestType["InvalidId"] = "invalid_id";
148
151
  ErrorBadRequestType["MissingDependency"] = "missing_dependency";
149
152
  ErrorBadRequestType["MissingRequiredField"] = "missing_required_field";
150
153
  ErrorBadRequestType["ParseError"] = "parse_error";
151
154
  ErrorBadRequestType["StaleSchemaFragments"] = "stale_schema_fragments";
155
+ ErrorBadRequestType["UnexpectedIdType"] = "unexpected_id_type";
152
156
  ErrorBadRequestType["UnexpectedJsonType"] = "unexpected_json_type";
153
157
  ErrorBadRequestType["ValueNotPermitted"] = "value_not_permitted";
154
158
  })(ErrorBadRequestType = exports.ErrorBadRequestType || (exports.ErrorBadRequestType = {}));
@@ -261,6 +265,12 @@ var SlaSummaryStage;
261
265
  SlaSummaryStage["Running"] = "running";
262
266
  SlaSummaryStage["Warning"] = "warning";
263
267
  })(SlaSummaryStage = exports.SlaSummaryStage || (exports.SlaSummaryStage = {}));
268
+ /** Type of the SLA. */
269
+ var SlaType;
270
+ (function (SlaType) {
271
+ SlaType["External"] = "external";
272
+ SlaType["Internal"] = "internal";
273
+ })(SlaType = exports.SlaType || (exports.SlaType = {}));
264
274
  /** Type of stage validation options when creating an object. */
265
275
  var StageValidationOptionForCreate;
266
276
  (function (StageValidationOptionForCreate) {
@@ -289,6 +299,7 @@ var TicketChannels;
289
299
  TicketChannels["Email"] = "email";
290
300
  TicketChannels["Plug"] = "plug";
291
301
  TicketChannels["Slack"] = "slack";
302
+ TicketChannels["Twilio"] = "twilio";
292
303
  })(TicketChannels = exports.TicketChannels || (exports.TicketChannels = {}));
293
304
  /** Severity of the ticket. */
294
305
  var TicketSeverity;
@@ -361,6 +372,19 @@ var UserType;
361
372
  UserType["RevUser"] = "rev_user";
362
373
  UserType["SysUser"] = "sys_user";
363
374
  })(UserType = exports.UserType || (exports.UserType = {}));
375
+ /** Defines the state of the group item. */
376
+ var VistaGroupItemState;
377
+ (function (VistaGroupItemState) {
378
+ VistaGroupItemState["Active"] = "active";
379
+ VistaGroupItemState["Completed"] = "completed";
380
+ VistaGroupItemState["Planned"] = "planned";
381
+ })(VistaGroupItemState = exports.VistaGroupItemState || (exports.VistaGroupItemState = {}));
382
+ /** Type of the group object. */
383
+ var VistaGroupItemType;
384
+ (function (VistaGroupItemType) {
385
+ VistaGroupItemType["Curated"] = "curated";
386
+ VistaGroupItemType["Dynamic"] = "dynamic";
387
+ })(VistaGroupItemType = exports.VistaGroupItemType || (exports.VistaGroupItemType = {}));
364
388
  /** The event types that the webhook will receive. */
365
389
  var WebhookEventType;
366
390
  (function (WebhookEventType) {
@@ -0,0 +1,4 @@
1
+ export * from './interfaces';
2
+ export * from './schema.pb';
3
+ export * from './stock_objects';
4
+ export * from './types';
@@ -0,0 +1,20 @@
1
+ "use strict";
2
+ var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
+ if (k2 === undefined) k2 = k;
4
+ var desc = Object.getOwnPropertyDescriptor(m, k);
5
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
+ desc = { enumerable: true, get: function() { return m[k]; } };
7
+ }
8
+ Object.defineProperty(o, k2, desc);
9
+ }) : (function(o, m, k, k2) {
10
+ if (k2 === undefined) k2 = k;
11
+ o[k2] = m[k];
12
+ }));
13
+ var __exportStar = (this && this.__exportStar) || function(m, exports) {
14
+ for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
15
+ };
16
+ Object.defineProperty(exports, "__esModule", { value: true });
17
+ __exportStar(require("./interfaces"), exports);
18
+ __exportStar(require("./schema.pb"), exports);
19
+ __exportStar(require("./stock_objects"), exports);
20
+ __exportStar(require("./types"), exports);
@@ -0,0 +1,15 @@
1
+ import { OperationOutput } from './schema.pb';
2
+ import { OperationContext } from './types';
3
+ /**
4
+ * Interface for the operation base class. Contains the GetContext method.
5
+ */
6
+ export interface OperationBaseIfc {
7
+ GetContext: (...args: any[]) => OperationContext;
8
+ }
9
+ /**
10
+ * Interface for the operation class. All operations should implement this interface.
11
+ * Extends the OperationBaseIfc interface.
12
+ */
13
+ export interface OperationIfc extends OperationBaseIfc {
14
+ run(metadata: OperationContext, input: Record<string, any>, resources: Record<string, any>): Promise<OperationOutput>;
15
+ }