@devrev/typescript-sdk 1.1.68 → 1.1.70

package/dist/auto-generated/beta/beta-devrev-sdk.js

@@ -33,10 +33,10 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-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;
-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;
-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;
-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;
+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.ConfigurationProrationBehavior = exports.ConfigurationCollectionMethod = 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;
+exports.PrimitiveValueType = exports.PricingBillingCycle = 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.ErrorSeeOtherType = exports.ErrorNotFoundType = exports.ErrorInternalServerErrorType = exports.ErrorForbiddenType = void 0;
+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.SkuType = exports.SkuState = exports.ServicePlanStatus = exports.ServicePlanBillingCycle = exports.SendNotificationType = exports.SelectorObject = exports.SearchSortOrderParam = exports.SearchSortByParam = exports.SearchResultType = exports.SearchNamespace = exports.SearchHybridNamespace = exports.SchemasSubtypePrepareUpdateGetResponseConflictType = exports.SchemaFieldDescriptorFieldType = exports.SchemaFieldDescriptorArrayTypeBaseType = exports.RoleTarget = exports.RolePrivileges = exports.RecordTemplateState = exports.ReactionsUpdateRequestAction = exports.QuestionAnswerStatus = void 0;
+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 = exports.TimelineEntriesCreateRequestType = exports.TimelineEntriesCollection = exports.TimelineCommentBodyType = exports.TimelineChangeEventEventType = exports.TimeMetricTrackerStatus = exports.TicketSeverity = exports.TicketChannels = exports.TaskPriority = exports.TableVisualizationColumnPinPosition = void 0;
 var AccessLevel;
 (function (AccessLevel) {
     AccessLevel["External"] = "external";
@@ -320,6 +320,25 @@ var CommandSurfaceSurface;
     CommandSurfaceSurface["CustomerChat"] = "customer_chat";
     CommandSurfaceSurface["Discussions"] = "discussions";
 })(CommandSurfaceSurface = exports.CommandSurfaceSurface || (exports.CommandSurfaceSurface = {}));
+/**
+ * Charge collection strategy for the service plan. Defaults to
+ * charge_automatically.
+ */
+var ConfigurationCollectionMethod;
+(function (ConfigurationCollectionMethod) {
+    ConfigurationCollectionMethod["ChargeAutomatically"] = "charge_automatically";
+    ConfigurationCollectionMethod["SendInvoice"] = "send_invoice";
+})(ConfigurationCollectionMethod = exports.ConfigurationCollectionMethod || (exports.ConfigurationCollectionMethod = {}));
+/**
+ * Determines how to handle prorations resulting from the billing_date. If
+ * no value is passed, the default is create_prorations.
+ */
+var ConfigurationProrationBehavior;
+(function (ConfigurationProrationBehavior) {
+    ConfigurationProrationBehavior["AlwaysInvoice"] = "always_invoice";
+    ConfigurationProrationBehavior["CreateProrations"] = "create_prorations";
+    ConfigurationProrationBehavior["None"] = "none";
+})(ConfigurationProrationBehavior = exports.ConfigurationProrationBehavior || (exports.ConfigurationProrationBehavior = {}));
 var ContentTemplateType;
 (function (ContentTemplateType) {
     ContentTemplateType["NotificationContentTemplate"] = "notification_content_template";
@@ -539,6 +558,10 @@ var ErrorNotFoundType;
 (function (ErrorNotFoundType) {
     ErrorNotFoundType["NotFound"] = "not_found";
 })(ErrorNotFoundType = exports.ErrorNotFoundType || (exports.ErrorNotFoundType = {}));
+var ErrorSeeOtherType;
+(function (ErrorSeeOtherType) {
+    ErrorSeeOtherType["SeeOther"] = "see_other";
+})(ErrorSeeOtherType = exports.ErrorSeeOtherType || (exports.ErrorSeeOtherType = {}));
 var ErrorServiceUnavailableType;
 (function (ErrorServiceUnavailableType) {
     ErrorServiceUnavailableType["ServiceUnavailable"] = "service_unavailable";
@@ -590,6 +613,7 @@ var ExternalSystemType;
     ExternalSystemType["JiraDataCenter"] = "jira_data_center";
     ExternalSystemType["Linear"] = "linear";
     ExternalSystemType["Rocketlane"] = "rocketlane";
+    ExternalSystemType["S3"] = "s3";
     ExternalSystemType["SalesforceSales"] = "salesforce_sales";
     ExternalSystemType["SalesforceService"] = "salesforce_service";
     ExternalSystemType["Servicenow"] = "servicenow";
@@ -934,6 +958,13 @@ var PreferencesType;
 (function (PreferencesType) {
     PreferencesType["UserPreferences"] = "user_preferences";
 })(PreferencesType = exports.PreferencesType || (exports.PreferencesType = {}));
+/** Billing frequency of the SKU. */
+var PricingBillingCycle;
+(function (PricingBillingCycle) {
+    PricingBillingCycle["Monthly"] = "monthly";
+    PricingBillingCycle["OneTime"] = "one_time";
+    PricingBillingCycle["Yearly"] = "yearly";
+})(PricingBillingCycle = exports.PricingBillingCycle || (exports.PricingBillingCycle = {}));
 /** Type of the value. */
 var PrimitiveValueType;
 (function (PrimitiveValueType) {
@@ -1159,6 +1190,46 @@ var SendNotificationType;
 (function (SendNotificationType) {
     SendNotificationType["GenericNotification"] = "generic_notification";
 })(SendNotificationType = exports.SendNotificationType || (exports.SendNotificationType = {}));
+/** The billing frequency of the service plan. */
+var ServicePlanBillingCycle;
+(function (ServicePlanBillingCycle) {
+    ServicePlanBillingCycle["Monthly"] = "monthly";
+})(ServicePlanBillingCycle = exports.ServicePlanBillingCycle || (exports.ServicePlanBillingCycle = {}));
+/**
+ * The status of the service plan indicates its current state. If the
+ * status is 'active,' it means the service plan items are in use and
+ * billed every cycle. If the status is 'cancelled,' it signifies that the
+ * service plan has been terminated and is no longer active or considered
+ * for billing.
+ */
+var ServicePlanStatus;
+(function (ServicePlanStatus) {
+    ServicePlanStatus["Active"] = "active";
+    ServicePlanStatus["Cancelled"] = "cancelled";
+    ServicePlanStatus["Paused"] = "paused";
+})(ServicePlanStatus = exports.ServicePlanStatus || (exports.ServicePlanStatus = {}));
+/**
+ * Current state of the SKU. A SKU is visible to RevOs only when it is
+ * released.
+ */
+var SkuState;
+(function (SkuState) {
+    SkuState["Approved"] = "approved";
+    SkuState["Draft"] = "draft";
+    SkuState["EndOfLife"] = "end_of_life";
+    SkuState["EndOfSale"] = "end_of_sale";
+    SkuState["Released"] = "released";
+})(SkuState = exports.SkuState || (exports.SkuState = {}));
+/** It defines the type of SKU. */
+var SkuType;
+(function (SkuType) {
+    SkuType["Consumption"] = "consumption";
+    SkuType["ConsumptionAddon"] = "consumption_addon";
+    SkuType["OneOffAddon"] = "one_off_addon";
+    SkuType["OneOffCharge"] = "one_off_charge";
+    SkuType["Subscription"] = "subscription";
+    SkuType["SubscriptionAddon"] = "subscription_addon";
+})(SkuType = exports.SkuType || (exports.SkuType = {}));
 /**
  * The object types on which the SLA applies. An external SLA can apply to
  * multiple object types, but an internal SLA can apply to only one object
@@ -1276,6 +1347,7 @@ var SnapWidgetNamespace;
     SnapWidgetNamespace["LinkPreview"] = "link_preview";
     SnapWidgetNamespace["MeetingPreview"] = "meeting_preview";
     SnapWidgetNamespace["PlugNudge"] = "plug_nudge";
+    SnapWidgetNamespace["SideThread"] = "side_thread";
 })(SnapWidgetNamespace = exports.SnapWidgetNamespace || (exports.SnapWidgetNamespace = {}));
 /** The status of the snap widget. */
 var SnapWidgetStatus;
@@ -1431,6 +1503,13 @@ var TicketSeverity;
     TicketSeverity["Low"] = "low";
     TicketSeverity["Medium"] = "medium";
 })(TicketSeverity = exports.TicketSeverity || (exports.TicketSeverity = {}));
+/** The current status of the metric. */
+var TimeMetricTrackerStatus;
+(function (TimeMetricTrackerStatus) {
+    TimeMetricTrackerStatus["Completed"] = "completed";
+    TimeMetricTrackerStatus["Paused"] = "paused";
+    TimeMetricTrackerStatus["Running"] = "running";
+})(TimeMetricTrackerStatus = exports.TimeMetricTrackerStatus || (exports.TimeMetricTrackerStatus = {}));
 /** The type of the event. */
 var TimelineChangeEventEventType;
 (function (TimelineChangeEventEventType) {
@@ -2076,6 +2155,26 @@ class Api extends HttpClient {
          * @secure
          */
         this.updateArticle = (data, params = {}) => this.request(Object.assign({ path: `/articles.update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
+        /**
+         * @description Redirects to the artifact's download URL.
+         *
+         * @tags artifacts
+         * @name ArtifactsDownload
+         * @summary Download Artifacts
+         * @request GET:/artifacts.download
+         * @secure
+         */
+        this.artifactsDownload = (query, params = {}) => this.request(Object.assign({ path: `/artifacts.download`, method: 'GET', query: query, secure: true }, params));
+        /**
+         * @description Redirects to the artifact's download URL.
+         *
+         * @tags artifacts
+         * @name ArtifactsDownloadPost
+         * @summary Download Artifacts (POST)
+         * @request POST:/artifacts.download
+         * @secure
+         */
+        this.artifactsDownloadPost = (data, params = {}) => this.request(Object.assign({ path: `/artifacts.download`, method: 'POST', body: data, secure: true, type: ContentType.Json }, params));
         /**
          * @description Gets the requested artifact's information.
          *
@@ -5007,6 +5106,26 @@ class Api extends HttpClient {
          * @secure
          */
         this.customStatesUpdate = (data, params = {}) => this.request(Object.assign({ path: `/states.custom.update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
+        /**
+         * @description Gets the requesting user's subscriber status for an object.
+         *
+         * @tags subscribers
+         * @name SubscribersGet
+         * @summary Get Subscriber
+         * @request GET:/subscribers.get
+         * @secure
+         */
+        this.subscribersGet = (query, params = {}) => this.request(Object.assign({ path: `/subscribers.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
+        /**
+         * @description Gets the requesting user's subscriber status for an object.
+         *
+         * @tags subscribers
+         * @name SubscribersGetPost
+         * @summary Get Subscriber (POST)
+         * @request POST:/subscribers.get
+         * @secure
+         */
+        this.subscribersGetPost = (data, params = {}) => this.request(Object.assign({ path: `/subscribers.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
         /**
          * @description Lists subscribers of an object.
          *