@devrev/typescript-sdk 1.1.24 → 1.1.27

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.OrgType = exports.OrgScheduleStatus = 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.DevOrgAuthConnectionsUpdateRequestType = exports.DevOrgAuthConnectionsCreateRequestType = exports.DateTimePresetType = exports.DateFilterType = exports.CustomSchemaFragmentsSetRequestType = exports.CustomSchemaFragmentsListRequestPrune = exports.CustomSchemaFragmentType = exports.CustomSchemaFragmentFragmentType = exports.ConversationsCreateRequestTypeValue = exports.CodeChangeSource = 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.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.SchemaFieldDescriptorFieldType = exports.SchemaFieldDescriptorArrayTypeBaseType = exports.QuestionAnswerStatus = exports.PartType = 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.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.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 = void 0;
38
39
  var AccessLevel;
39
40
  (function (AccessLevel) {
40
41
  AccessLevel["External"] = "external";
@@ -149,6 +150,7 @@ var AuthTokenRequestedTokenType;
149
150
  AuthTokenRequestedTokenType["UrnDevrevParamsOauthTokenTypeSession"] = "urn:devrev:params:oauth:token-type:session";
150
151
  AuthTokenRequestedTokenType["UrnDevrevParamsOauthTokenTypeSessionDev0"] = "urn:devrev:params:oauth:token-type:session:dev0";
151
152
  AuthTokenRequestedTokenType["UrnDevrevParamsOauthTokenTypeSessionOnetime"] = "urn:devrev:params:oauth:token-type:session:onetime";
153
+ AuthTokenRequestedTokenType["UrnDevrevParamsOauthTokenTypeSessionRevActAs"] = "urn:devrev:params:oauth:token-type:session:rev:act-as";
152
154
  AuthTokenRequestedTokenType["UrnDevrevParamsOauthTokenTypeSuper"] = "urn:devrev:params:oauth:token-type:super";
153
155
  AuthTokenRequestedTokenType["UrnDevrevParamsOauthTokenTypeSys"] = "urn:devrev:params:oauth:token-type:sys";
154
156
  AuthTokenRequestedTokenType["UrnIetfParamsOauthTokenTypeJwt"] = "urn:ietf:params:oauth:token-type:jwt";
@@ -178,6 +180,13 @@ var AuthTokenTokenType;
178
180
  (function (AuthTokenTokenType) {
179
181
  AuthTokenTokenType["Bearer"] = "bearer";
180
182
  })(AuthTokenTokenType = exports.AuthTokenTokenType || (exports.AuthTokenTokenType = {}));
183
+ var BooleanExpressionType;
184
+ (function (BooleanExpressionType) {
185
+ BooleanExpressionType["And"] = "and";
186
+ BooleanExpressionType["Not"] = "not";
187
+ BooleanExpressionType["Or"] = "or";
188
+ BooleanExpressionType["Primitive"] = "primitive";
189
+ })(BooleanExpressionType = exports.BooleanExpressionType || (exports.BooleanExpressionType = {}));
181
190
  /** Source of the code change object. */
182
191
  var CodeChangeSource;
183
192
  (function (CodeChangeSource) {
@@ -246,6 +255,22 @@ var DevOrgAuthConnectionsUpdateRequestType;
246
255
  DevOrgAuthConnectionsUpdateRequestType["Samlp"] = "samlp";
247
256
  DevOrgAuthConnectionsUpdateRequestType["Waad"] = "waad";
248
257
  })(DevOrgAuthConnectionsUpdateRequestType = exports.DevOrgAuthConnectionsUpdateRequestType || (exports.DevOrgAuthConnectionsUpdateRequestType = {}));
258
+ /** Job title of the Dev User. */
259
+ var DevUserJobTitle;
260
+ (function (DevUserJobTitle) {
261
+ DevUserJobTitle["CustomerSuccessManager"] = "customer_success_manager";
262
+ DevUserJobTitle["Cxo"] = "cxo";
263
+ DevUserJobTitle["Designer"] = "designer";
264
+ DevUserJobTitle["Developer"] = "developer";
265
+ DevUserJobTitle["HeadOfSupport"] = "head_of_support";
266
+ DevUserJobTitle["Operations"] = "operations";
267
+ DevUserJobTitle["Others"] = "others";
268
+ DevUserJobTitle["ProductManager"] = "product_manager";
269
+ DevUserJobTitle["Qa"] = "qa";
270
+ DevUserJobTitle["RevenueLeader"] = "revenue_leader";
271
+ DevUserJobTitle["Support"] = "support";
272
+ DevUserJobTitle["TechLead"] = "tech_lead";
273
+ })(DevUserJobTitle = exports.DevUserJobTitle || (exports.DevUserJobTitle = {}));
249
274
  /** Type of engagement. */
250
275
  var EngagementType;
251
276
  (function (EngagementType) {
@@ -268,6 +293,7 @@ var EngagementsCreateRequestEngagementType;
268
293
  })(EngagementsCreateRequestEngagementType = exports.EngagementsCreateRequestEngagementType || (exports.EngagementsCreateRequestEngagementType = {}));
269
294
  var ErrorBadRequestType;
270
295
  (function (ErrorBadRequestType) {
296
+ ErrorBadRequestType["ArtifactAlreadyAttachedToAParent"] = "artifact_already_attached_to_a_parent";
271
297
  ErrorBadRequestType["BadRequest"] = "bad_request";
272
298
  ErrorBadRequestType["InvalidApiVersion"] = "invalid_api_version";
273
299
  ErrorBadRequestType["InvalidEnumValue"] = "invalid_enum_value";
@@ -409,6 +435,7 @@ var MemberType;
409
435
  var MetricDefinitionAppliesTo;
410
436
  (function (MetricDefinitionAppliesTo) {
411
437
  MetricDefinitionAppliesTo["Conversation"] = "conversation";
438
+ MetricDefinitionAppliesTo["Issue"] = "issue";
412
439
  MetricDefinitionAppliesTo["Ticket"] = "ticket";
413
440
  })(MetricDefinitionAppliesTo = exports.MetricDefinitionAppliesTo || (exports.MetricDefinitionAppliesTo = {}));
414
441
  /**
@@ -422,6 +449,16 @@ var MetricDefinitionMetricType;
422
449
  MetricDefinitionMetricType["Time"] = "time";
423
450
  MetricDefinitionMetricType["Value"] = "value";
424
451
  })(MetricDefinitionMetricType = exports.MetricDefinitionMetricType || (exports.MetricDefinitionMetricType = {}));
452
+ /**
453
+ * The status of the metric. 'active' metrics can be used to create new
454
+ * SLAs, while 'inactive' metrics can not be used in new SLAs. Metrics can
455
+ * be updated between 'active' and 'inactive' states.
456
+ */
457
+ var MetricDefinitionStatus;
458
+ (function (MetricDefinitionStatus) {
459
+ MetricDefinitionStatus["Active"] = "active";
460
+ MetricDefinitionStatus["Inactive"] = "inactive";
461
+ })(MetricDefinitionStatus = exports.MetricDefinitionStatus || (exports.MetricDefinitionStatus = {}));
425
462
  /** Forecast category of the opportunity. */
426
463
  var OpportunityForecastCategory;
427
464
  (function (OpportunityForecastCategory) {
@@ -485,6 +522,7 @@ var PartType;
485
522
  var QuestionAnswerStatus;
486
523
  (function (QuestionAnswerStatus) {
487
524
  QuestionAnswerStatus["Archived"] = "archived";
525
+ QuestionAnswerStatus["Discarded"] = "discarded";
488
526
  QuestionAnswerStatus["Draft"] = "draft";
489
527
  QuestionAnswerStatus["Published"] = "published";
490
528
  QuestionAnswerStatus["ReviewNeeded"] = "review_needed";
@@ -521,6 +559,17 @@ var SchemaFieldDescriptorFieldType;
521
559
  SchemaFieldDescriptorFieldType["Uenum"] = "uenum";
522
560
  SchemaFieldDescriptorFieldType["Unknown"] = "unknown";
523
561
  })(SchemaFieldDescriptorFieldType = exports.SchemaFieldDescriptorFieldType || (exports.SchemaFieldDescriptorFieldType = {}));
562
+ /** The namespaces for hybrid search. */
563
+ var SearchHybridNamespace;
564
+ (function (SearchHybridNamespace) {
565
+ SearchHybridNamespace["Article"] = "article";
566
+ SearchHybridNamespace["Conversation"] = "conversation";
567
+ SearchHybridNamespace["Issue"] = "issue";
568
+ SearchHybridNamespace["Part"] = "part";
569
+ SearchHybridNamespace["QuestionAnswer"] = "question_answer";
570
+ SearchHybridNamespace["Ticket"] = "ticket";
571
+ SearchHybridNamespace["Work"] = "work";
572
+ })(SearchHybridNamespace = exports.SearchHybridNamespace || (exports.SearchHybridNamespace = {}));
524
573
  /** The namespaces to search in. */
525
574
  var SearchNamespace;
526
575
  (function (SearchNamespace) {
@@ -585,6 +634,17 @@ var SearchSortOrderParam;
585
634
  SearchSortOrderParam["Asc"] = "asc";
586
635
  SearchSortOrderParam["Desc"] = "desc";
587
636
  })(SearchSortOrderParam = exports.SearchSortOrderParam || (exports.SearchSortOrderParam = {}));
637
+ /**
638
+ * The object types on which the SLA applies. An external SLA can apply to
639
+ * multiple object types, but an internal SLA can apply to only one object
640
+ * type.
641
+ */
642
+ var SlaAppliesTo;
643
+ (function (SlaAppliesTo) {
644
+ SlaAppliesTo["Conversation"] = "conversation";
645
+ SlaAppliesTo["Issue"] = "issue";
646
+ SlaAppliesTo["Ticket"] = "ticket";
647
+ })(SlaAppliesTo = exports.SlaAppliesTo || (exports.SlaAppliesTo = {}));
588
648
  /**
589
649
  * Specifies the frequency of when the contractually-meaningful evaluation
590
650
  * of the SLA happens. The organization for their own information might
@@ -604,9 +664,10 @@ var SlaEvaluationPeriod;
604
664
  var SlaSelectorAppliesTo;
605
665
  (function (SlaSelectorAppliesTo) {
606
666
  SlaSelectorAppliesTo["Conversation"] = "conversation";
667
+ SlaSelectorAppliesTo["Issue"] = "issue";
607
668
  SlaSelectorAppliesTo["Ticket"] = "ticket";
608
669
  })(SlaSelectorAppliesTo = exports.SlaSelectorAppliesTo || (exports.SlaSelectorAppliesTo = {}));
609
- /** Th SLA policy applies to conversations with these priorities. */
670
+ /** The SLA policy applies to conversations with these priorities. */
610
671
  var SlaSelectorPriority;
611
672
  (function (SlaSelectorPriority) {
612
673
  SlaSelectorPriority["P0"] = "p0";
@@ -644,9 +705,21 @@ var SlaSummaryStage;
644
705
  SlaSummaryStage["Running"] = "running";
645
706
  SlaSummaryStage["Warning"] = "warning";
646
707
  })(SlaSummaryStage = exports.SlaSummaryStage || (exports.SlaSummaryStage = {}));
708
+ /** Type of the SLA. */
709
+ var SlaType;
710
+ (function (SlaType) {
711
+ SlaType["External"] = "external";
712
+ SlaType["Internal"] = "internal";
713
+ })(SlaType = exports.SlaType || (exports.SlaType = {}));
714
+ var SlasFilterAppliesToOperatorType;
715
+ (function (SlasFilterAppliesToOperatorType) {
716
+ SlasFilterAppliesToOperatorType["All"] = "all";
717
+ SlasFilterAppliesToOperatorType["Any"] = "any";
718
+ })(SlasFilterAppliesToOperatorType = exports.SlasFilterAppliesToOperatorType || (exports.SlasFilterAppliesToOperatorType = {}));
647
719
  /** Logical grouping of snap widgets. Useful for filtering. */
648
720
  var SnapWidgetNamespace;
649
721
  (function (SnapWidgetNamespace) {
722
+ SnapWidgetNamespace["CommentSuggestionReplies"] = "comment_suggestion_replies";
650
723
  SnapWidgetNamespace["EmailPreview"] = "email_preview";
651
724
  SnapWidgetNamespace["LinkPreview"] = "link_preview";
652
725
  SnapWidgetNamespace["PlugNudge"] = "plug_nudge";
@@ -665,6 +738,16 @@ var SnapWidgetsCreateRequestType;
665
738
  (function (SnapWidgetsCreateRequestType) {
666
739
  SnapWidgetsCreateRequestType["EmailPreview"] = "email_preview";
667
740
  })(SnapWidgetsCreateRequestType = exports.SnapWidgetsCreateRequestType || (exports.SnapWidgetsCreateRequestType = {}));
741
+ /** Type of stage validation options when creating an object. */
742
+ var StageValidationOptionForCreate;
743
+ (function (StageValidationOptionForCreate) {
744
+ StageValidationOptionForCreate["AllowNonStart"] = "allow_non_start";
745
+ })(StageValidationOptionForCreate = exports.StageValidationOptionForCreate || (exports.StageValidationOptionForCreate = {}));
746
+ /** Type of state validation options when updating the stage of an object. */
747
+ var StageValidationOptionForUpdate;
748
+ (function (StageValidationOptionForUpdate) {
749
+ StageValidationOptionForUpdate["AllowInvalidTransition"] = "allow_invalid_transition";
750
+ })(StageValidationOptionForUpdate = exports.StageValidationOptionForUpdate || (exports.StageValidationOptionForUpdate = {}));
668
751
  var StockSchemaFragmentsListRequestFilterPreset;
669
752
  (function (StockSchemaFragmentsListRequestFilterPreset) {
670
753
  StockSchemaFragmentsListRequestFilterPreset["CustomizableTypesPreset"] = "customizable_types_preset";
@@ -701,6 +784,7 @@ var TicketChannels;
701
784
  TicketChannels["Email"] = "email";
702
785
  TicketChannels["Plug"] = "plug";
703
786
  TicketChannels["Slack"] = "slack";
787
+ TicketChannels["Twilio"] = "twilio";
704
788
  })(TicketChannels = exports.TicketChannels || (exports.TicketChannels = {}));
705
789
  /** Severity of the ticket. */
706
790
  var TicketSeverity;
@@ -1489,6 +1573,24 @@ class Api extends HttpClient {
1489
1573
  * @secure
1490
1574
  */
1491
1575
  this.devUsersGetPost = (data, params = {}) => this.request(Object.assign({ path: `/dev-users.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
1576
+ /**
1577
+ * @description Links an external/secondary identity to the Dev user.
1578
+ *
1579
+ * @tags dev-users
1580
+ * @name DevUsersIdentitiesLink
1581
+ * @request POST:/dev-users.identities.link
1582
+ * @secure
1583
+ */
1584
+ 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));
1585
+ /**
1586
+ * @description Unlinks an external/secondary identity from the Dev user.
1587
+ *
1588
+ * @tags dev-users
1589
+ * @name DevUsersIdentitiesUnlink
1590
+ * @request POST:/dev-users.identities.unlink
1591
+ * @secure
1592
+ */
1593
+ 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));
1492
1594
  /**
1493
1595
  * @description Lists users within your organization.
1494
1596
  *
@@ -1525,6 +1627,24 @@ class Api extends HttpClient {
1525
1627
  * @secure
1526
1628
  */
1527
1629
  this.devUsersSelfPost = (data, params = {}) => this.request(Object.assign({ path: `/dev-users.self`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
1630
+ /**
1631
+ * @description Updates the authenticated user.
1632
+ *
1633
+ * @tags dev-users
1634
+ * @name DevUsersSelfUpdate
1635
+ * @request POST:/dev-users.self.update
1636
+ * @secure
1637
+ */
1638
+ this.devUsersSelfUpdate = (data, params = {}) => this.request(Object.assign({ path: `/dev-users.self.update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
1639
+ /**
1640
+ * @description Updates the user corresponding to the input Id.
1641
+ *
1642
+ * @tags dev-users
1643
+ * @name DevUsersUpdate
1644
+ * @request POST:/dev-users.update
1645
+ * @secure
1646
+ */
1647
+ this.devUsersUpdate = (data, params = {}) => this.request(Object.assign({ path: `/dev-users.update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
1528
1648
  /**
1529
1649
  * @description Counts the engagement records.
1530
1650
  *
@@ -2326,6 +2446,24 @@ class Api extends HttpClient {
2326
2446
  * @secure
2327
2447
  */
2328
2448
  this.searchCorePost = (data, params = {}) => this.request(Object.assign({ path: `/search.core`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
2449
+ /**
2450
+ * @description Performs search, using a combination of syntactic and semantic search.
2451
+ *
2452
+ * @tags search
2453
+ * @name SearchHybrid
2454
+ * @request GET:/search.hybrid
2455
+ * @secure
2456
+ */
2457
+ this.searchHybrid = (query, params = {}) => this.request(Object.assign({ path: `/search.hybrid`, method: 'GET', query: query, secure: true, format: 'json' }, params));
2458
+ /**
2459
+ * @description Performs search, using a combination of syntactic and semantic search.
2460
+ *
2461
+ * @tags search
2462
+ * @name SearchHybridPost
2463
+ * @request POST:/search.hybrid
2464
+ * @secure
2465
+ */
2466
+ this.searchHybridPost = (data, params = {}) => this.request(Object.assign({ path: `/search.hybrid`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
2329
2467
  /**
2330
2468
  * @description Gets a service account.
2331
2469
  *
@@ -2461,6 +2599,114 @@ class Api extends HttpClient {
2461
2599
  * @secure
2462
2600
  */
2463
2601
  this.snapWidgetsCreate = (data, params = {}) => this.request(Object.assign({ path: `/snap-widgets.create`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
2602
+ /**
2603
+ * @description Creates a custom stage.
2604
+ *
2605
+ * @tags customization
2606
+ * @name CustomStagesCreate
2607
+ * @request POST:/stages.custom.create
2608
+ * @secure
2609
+ */
2610
+ this.customStagesCreate = (data, params = {}) => this.request(Object.assign({ path: `/stages.custom.create`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
2611
+ /**
2612
+ * @description Gets a custom stage.
2613
+ *
2614
+ * @tags customization
2615
+ * @name CustomStagesGet
2616
+ * @request GET:/stages.custom.get
2617
+ * @secure
2618
+ */
2619
+ this.customStagesGet = (query, params = {}) => this.request(Object.assign({ path: `/stages.custom.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
2620
+ /**
2621
+ * @description Gets a custom stage.
2622
+ *
2623
+ * @tags customization
2624
+ * @name CustomStagesGetPost
2625
+ * @request POST:/stages.custom.get
2626
+ * @secure
2627
+ */
2628
+ this.customStagesGetPost = (data, params = {}) => this.request(Object.assign({ path: `/stages.custom.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
2629
+ /**
2630
+ * @description Lists custom stages.
2631
+ *
2632
+ * @tags customization
2633
+ * @name CustomStagesList
2634
+ * @request GET:/stages.custom.list
2635
+ * @secure
2636
+ */
2637
+ this.customStagesList = (query, params = {}) => this.request(Object.assign({ path: `/stages.custom.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
2638
+ /**
2639
+ * @description Lists custom stages.
2640
+ *
2641
+ * @tags customization
2642
+ * @name CustomStagesListPost
2643
+ * @request POST:/stages.custom.list
2644
+ * @secure
2645
+ */
2646
+ this.customStagesListPost = (data, params = {}) => this.request(Object.assign({ path: `/stages.custom.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
2647
+ /**
2648
+ * @description Updates a custom stage.
2649
+ *
2650
+ * @tags customization
2651
+ * @name CustomStagesUpdate
2652
+ * @request POST:/stages.custom.update
2653
+ * @secure
2654
+ */
2655
+ this.customStagesUpdate = (data, params = {}) => this.request(Object.assign({ path: `/stages.custom.update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
2656
+ /**
2657
+ * @description Creates a custom state.
2658
+ *
2659
+ * @tags customization
2660
+ * @name CustomStatesCreate
2661
+ * @request POST:/states.custom.create
2662
+ * @secure
2663
+ */
2664
+ this.customStatesCreate = (data, params = {}) => this.request(Object.assign({ path: `/states.custom.create`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
2665
+ /**
2666
+ * @description Gets a custom state.
2667
+ *
2668
+ * @tags customization
2669
+ * @name CustomStatesGet
2670
+ * @request GET:/states.custom.get
2671
+ * @secure
2672
+ */
2673
+ this.customStatesGet = (query, params = {}) => this.request(Object.assign({ path: `/states.custom.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
2674
+ /**
2675
+ * @description Gets a custom state.
2676
+ *
2677
+ * @tags customization
2678
+ * @name CustomStatesGetPost
2679
+ * @request POST:/states.custom.get
2680
+ * @secure
2681
+ */
2682
+ this.customStatesGetPost = (data, params = {}) => this.request(Object.assign({ path: `/states.custom.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
2683
+ /**
2684
+ * @description Lists custom states.
2685
+ *
2686
+ * @tags customization
2687
+ * @name CustomStatesList
2688
+ * @request GET:/states.custom.list
2689
+ * @secure
2690
+ */
2691
+ this.customStatesList = (query, params = {}) => this.request(Object.assign({ path: `/states.custom.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
2692
+ /**
2693
+ * @description Lists custom states.
2694
+ *
2695
+ * @tags customization
2696
+ * @name CustomStatesListPost
2697
+ * @request POST:/states.custom.list
2698
+ * @secure
2699
+ */
2700
+ this.customStatesListPost = (data, params = {}) => this.request(Object.assign({ path: `/states.custom.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
2701
+ /**
2702
+ * @description Updates a custom state.
2703
+ *
2704
+ * @tags customization
2705
+ * @name CustomStatesUpdate
2706
+ * @request POST:/states.custom.update
2707
+ * @secure
2708
+ */
2709
+ this.customStatesUpdate = (data, params = {}) => this.request(Object.assign({ path: `/states.custom.update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
2464
2710
  /**
2465
2711
  * @description Creates a schema for survey, which includes name and description of schema.
2466
2712
  *
@@ -518,6 +518,7 @@ export declare enum AuthTokenRequestedTokenType {
518
518
  UrnDevrevParamsOauthTokenTypeSession = "urn:devrev:params:oauth:token-type:session",
519
519
  UrnDevrevParamsOauthTokenTypeSessionDev0 = "urn:devrev:params:oauth:token-type:session:dev0",
520
520
  UrnDevrevParamsOauthTokenTypeSessionOnetime = "urn:devrev:params:oauth:token-type:session:onetime",
521
+ UrnDevrevParamsOauthTokenTypeSessionRevActAs = "urn:devrev:params:oauth:token-type:session:rev:act-as",
521
522
  UrnDevrevParamsOauthTokenTypeSuper = "urn:devrev:params:oauth:token-type:super",
522
523
  UrnDevrevParamsOauthTokenTypeSys = "urn:devrev:params:oauth:token-type:sys",
523
524
  UrnIetfParamsOauthTokenTypeJwt = "urn:ietf:params:oauth:token-type:jwt"
@@ -1005,8 +1006,18 @@ export interface DevOrgAuthConnectionsUpdateResponse {
1005
1006
  }
1006
1007
  /** dev-user */
1007
1008
  export type DevUser = UserBase & {
1009
+ /**
1010
+ * Start date of the user's employment.
1011
+ * @format date-time
1012
+ * @example "2023-01-01T12:00:00.000Z"
1013
+ */
1014
+ experience_start_date?: string;
1008
1015
  /** IDs of the Dev User outside the DevRev SOR. */
1009
1016
  external_identities?: ExternalIdentity[];
1017
+ /** Job history of the user. */
1018
+ job_history?: JobHistoryItem[];
1019
+ /** Array of skills of the user. */
1020
+ skills?: UserSkill[];
1010
1021
  };
1011
1022
  /** dev-user-external-identity-filter */
1012
1023
  export interface DevUserExternalIdentityFilter {
@@ -1100,10 +1111,35 @@ export type Empty = object;
1100
1111
  export type Enhancement = PartBase;
1101
1112
  /** enhancement-summary */
1102
1113
  export type EnhancementSummary = PartBaseSummary;
1114
+ /**
1115
+ * enum-value
1116
+ * Enum Value defines the structure for an enum.
1117
+ */
1118
+ export interface EnumValue {
1119
+ /**
1120
+ * Unique ID of the enum value. This is immutable.
1121
+ * @format int64
1122
+ */
1123
+ id: number;
1124
+ /** Display label of the enum value. This is mutable. */
1125
+ label: string;
1126
+ /**
1127
+ * Order number of the enum value. This is mutable.
1128
+ * @format int64
1129
+ */
1130
+ ordinal: number;
1131
+ }
1103
1132
  /** error-bad-request */
1104
- export type ErrorBadRequest = ErrorBase & (ErrorBadRequestBadRequest | ErrorBadRequestInvalidApiVersion | ErrorBadRequestInvalidEnumValue | ErrorBadRequestInvalidField | ErrorBadRequestMissingDependency | ErrorBadRequestMissingRequiredField | ErrorBadRequestParseError | ErrorBadRequestStaleSchemaFragments | ErrorBadRequestUnexpectedJsonType | ErrorBadRequestValueNotPermitted) & {
1133
+ export type ErrorBadRequest = ErrorBase & (ErrorBadRequestArtifactAlreadyAttachedToAParent | ErrorBadRequestBadRequest | ErrorBadRequestInvalidApiVersion | ErrorBadRequestInvalidEnumValue | ErrorBadRequestInvalidField | ErrorBadRequestMissingDependency | ErrorBadRequestMissingRequiredField | ErrorBadRequestParseError | ErrorBadRequestStaleSchemaFragments | ErrorBadRequestUnexpectedJsonType | ErrorBadRequestValueNotPermitted) & {
1105
1134
  type: ErrorBadRequestType;
1106
1135
  };
1136
+ /** error-bad-request-artifact-already-attached-to-a-parent */
1137
+ export interface ErrorBadRequestArtifactAlreadyAttachedToAParent {
1138
+ /** The existing parent attached to the artifact. */
1139
+ existing_parent: string;
1140
+ /** Whether the existing parent is the same as the new parent. */
1141
+ is_same: boolean;
1142
+ }
1107
1143
  /** error-bad-request-bad-request */
1108
1144
  export type ErrorBadRequestBadRequest = object;
1109
1145
  /** error-bad-request-invalid-api-version */
@@ -1162,6 +1198,7 @@ export type ErrorBadRequestParseError = object;
1162
1198
  */
1163
1199
  export type ErrorBadRequestStaleSchemaFragments = object;
1164
1200
  export declare enum ErrorBadRequestType {
1201
+ ArtifactAlreadyAttachedToAParent = "artifact_already_attached_to_a_parent",
1165
1202
  BadRequest = "bad_request",
1166
1203
  InvalidApiVersion = "invalid_api_version",
1167
1204
  InvalidEnumValue = "invalid_enum_value",
@@ -1471,6 +1508,8 @@ export type Issue = WorkBase & {
1471
1508
  developed_with?: PartSummary[];
1472
1509
  /** Priority of the work based upon impact and criticality. */
1473
1510
  priority?: IssuePriority;
1511
+ /** Vista group item. */
1512
+ sprint?: VistaGroupItemSummary;
1474
1513
  /**
1475
1514
  * Target start date for the object.
1476
1515
  * @format date-time
@@ -1485,6 +1524,32 @@ export declare enum IssuePriority {
1485
1524
  P2 = "p2",
1486
1525
  P3 = "p3"
1487
1526
  }
1527
+ /**
1528
+ * job-history-item
1529
+ * Defines a job history line item.
1530
+ */
1531
+ export interface JobHistoryItem {
1532
+ /** Enum Value defines the structure for an enum. */
1533
+ employment_status?: EnumValue;
1534
+ /**
1535
+ * The end date of the job, or not specified if current.
1536
+ * @format date-time
1537
+ * @example "2023-01-01T12:00:00.000Z"
1538
+ */
1539
+ end_date?: string;
1540
+ /** Is this the current active job for the user. */
1541
+ is_current?: boolean;
1542
+ /** The job location for the user. */
1543
+ location?: string;
1544
+ /**
1545
+ * The start date of the job.
1546
+ * @format date-time
1547
+ * @example "2023-01-01T12:00:00.000Z"
1548
+ */
1549
+ start_date?: string;
1550
+ /** The job title for the user. */
1551
+ title?: string;
1552
+ }
1488
1553
  /**
1489
1554
  * legacy-stage
1490
1555
  * Describes the current stage of a work item.
@@ -2136,6 +2201,14 @@ export interface StageUpdate {
2136
2201
  /** The updated name of the stage, otherwise unchanged if not set. */
2137
2202
  name?: string;
2138
2203
  }
2204
+ /** Type of stage validation options when creating an object. */
2205
+ export declare enum StageValidationOptionForCreate {
2206
+ AllowNonStart = "allow_non_start"
2207
+ }
2208
+ /** Type of state validation options when updating the stage of an object. */
2209
+ export declare enum StageValidationOptionForUpdate {
2210
+ AllowInvalidTransition = "allow_invalid_transition"
2211
+ }
2139
2212
  /** staged-info-filter */
2140
2213
  export interface StagedInfoFilter {
2141
2214
  /** Filters for issues that are staged. */
@@ -2152,6 +2225,7 @@ export type SurveyResponse = AtomBase & {
2152
2225
  dispatch_id?: string;
2153
2226
  /** The ID of the object for which survey is taken. */
2154
2227
  object?: string;
2228
+ recipient?: UserSummary;
2155
2229
  /** Response for the survey. */
2156
2230
  response?: object;
2157
2231
  /** The ID of the survey for which response is taken. */
@@ -2382,7 +2456,8 @@ export type Ticket = WorkBase & {
2382
2456
  export declare enum TicketChannels {
2383
2457
  Email = "email",
2384
2458
  Plug = "plug",
2385
- Slack = "slack"
2459
+ Slack = "slack",
2460
+ Twilio = "twilio"
2386
2461
  }
2387
2462
  /** Severity of the ticket. */
2388
2463
  export declare enum TicketSeverity {
@@ -2710,6 +2785,14 @@ export type UserBaseSummary = AtomBaseSummary & {
2710
2785
  /** State of the user. */
2711
2786
  state?: UserState;
2712
2787
  };
2788
+ /**
2789
+ * user-skill
2790
+ * Skill associated with the user.
2791
+ */
2792
+ export interface UserSkill {
2793
+ /** Name of the skill. */
2794
+ name?: string;
2795
+ }
2713
2796
  /** State of the user. */
2714
2797
  export declare enum UserState {
2715
2798
  Active = "active",
@@ -2728,6 +2811,11 @@ export declare enum UserType {
2728
2811
  RevUser = "rev_user",
2729
2812
  SysUser = "sys_user"
2730
2813
  }
2814
+ /**
2815
+ * vista-group-item-summary
2816
+ * Vista group item.
2817
+ */
2818
+ export type VistaGroupItemSummary = object;
2731
2819
  /** webhook */
2732
2820
  export type Webhook = AtomBase & {
2733
2821
  /** The event types that the webhook will receive. */
@@ -3054,6 +3142,8 @@ export type WorksCreateRequest = (WorksCreateRequestIssue | WorksCreateRequestTi
3054
3142
  reported_by?: string[];
3055
3143
  /** Sets an object's initial stage. */
3056
3144
  stage?: StageInit;
3145
+ /** The type of stage validations options when creating a work item. */
3146
+ stage_validation_options?: StageValidationOptionForCreate[];
3057
3147
  /** Tags associated with the work item. */
3058
3148
  tags?: SetTagWithValue[];
3059
3149
  /**
@@ -3098,6 +3188,8 @@ export interface WorksCreateRequestTicket {
3098
3188
  group?: string;
3099
3189
  /** Whether the ticket is spam. */
3100
3190
  is_spam?: boolean;
3191
+ /** Whether the ticket needs a response. */
3192
+ needs_response?: boolean;
3101
3193
  /**
3102
3194
  * The Rev organization that the ticket is associated with.
3103
3195
  * @example "REV-AbCdEfGh"
@@ -3195,6 +3287,8 @@ export interface WorksFilterIssue {
3195
3287
  * @example ["REV-AbCdEfGh"]
3196
3288
  */
3197
3289
  rev_orgs?: string[];
3290
+ /** Filters for issues with any of the sprint. */
3291
+ sprint?: string[];
3198
3292
  /** Provides ways to specify date ranges on objects. */
3199
3293
  target_start_date?: DateFilter;
3200
3294
  }
@@ -3331,6 +3425,11 @@ export type WorksUpdateRequest = (Empty | WorksUpdateRequestIssue | WorksUpdateR
3331
3425
  reported_by?: WorksUpdateRequestReportedBy;
3332
3426
  /** Updates an object's stage. */
3333
3427
  stage?: StageUpdate;
3428
+ /**
3429
+ * The type of stage validations options when updating the stage of an
3430
+ * object.
3431
+ */
3432
+ stage_validation_options?: StageValidationOptionForUpdate[];
3334
3433
  staged_info?: WorksUpdateRequestStagedInfoStagedInfoUpdate;
3335
3434
  tags?: WorksUpdateRequestTags;
3336
3435
  /**
@@ -3426,6 +3525,8 @@ export interface WorksUpdateRequestTicket {
3426
3525
  group?: string | null;
3427
3526
  /** Updates whether the ticket is spam. */
3428
3527
  is_spam?: boolean;
3528
+ /** Updates whether the ticket needs a response. */
3529
+ needs_response?: boolean;
3429
3530
  /**
3430
3531
  * Updates the Rev organization that the ticket is associated with.
3431
3532
  * @example "REV-AbCdEfGh"
@@ -4581,6 +4682,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
4581
4682
  * @example ["REV-AbCdEfGh"]
4582
4683
  */
4583
4684
  'issue.rev_orgs'?: string[];
4685
+ /** Filters for issues with any of the sprint. */
4686
+ 'issue.sprint'?: string[];
4584
4687
  /**
4585
4688
  * Filters for work owned by any of these users.
4586
4689
  * @example ["DEVU-12345"]
@@ -4704,6 +4807,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
4704
4807
  * @example ["REV-AbCdEfGh"]
4705
4808
  */
4706
4809
  'issue.rev_orgs'?: string[];
4810
+ /** Filters for issues with any of the sprint. */
4811
+ 'issue.sprint'?: string[];
4707
4812
  /**
4708
4813
  * The maximum number of works to return. The default is '50'.
4709
4814
  * @format int32