@devrev/typescript-sdk 1.1.74 → 1.1.75

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.
@@ -35,10 +35,10 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
35
35
  Object.defineProperty(exports, "__esModule", { value: true });
36
36
  exports.Definedness = exports.DateTimePresetType = exports.DateFilterType = exports.DataLabelConfigDisplayMode = exports.DashboardFilterRelativeDateConditionType = exports.DashboardFilterRelativeDateConditionPeriodType = exports.DashboardFilterRelativeDateConditionCurrentPeriodType = exports.DashboardFilterOperandType = exports.DashboardFilterExpressionOperator = exports.DashboardFilterConditionValueType = exports.DashboardFilterConditionOperator = exports.CustomSchemaFragmentsSetRequestType = exports.CustomSchemaFragmentsListRequestPrune = exports.CustomSchemaFragmentType = exports.CustomSchemaFragmentFragmentType = exports.CurrentPeriod = exports.ConversationsVistaGroupItemType = exports.ConversationsCreateRequestTypeValue = exports.ConversationsConvertRequestConvertTo = exports.ContentTemplateType = exports.ConsoleLogType = exports.ConfigurationProrationBehavior = exports.ConfigurationCollectionMethod = exports.CommandSurfaceSurface = exports.CommandSurfaceObjectTypes = exports.CommandStatus = exports.CommandActionTemplateType = exports.CommandActionExecutorType = exports.CodeChangeSource = exports.ChatType = exports.ChatCompletionsRequestMessageRole = exports.ChatCompletionsRequestMessageImageContentContentPart = 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.AirdropSyncUnitRecipeVersion = exports.AggregationDetailAggregationType = exports.AccessLevel = void 0;
37
37
  exports.GroupedVistaFlavor = exports.GroupedVistaFilterType = exports.GroupType = exports.GroupMemberType = exports.GroupItemType = exports.GroupIngestionSource = exports.GenericNotificationEventType = exports.GanttWidgetVisualizationTimeScale = exports.FieldValueType = exports.ExternalSystemType = exports.ExternalSystemCapability = exports.ExportFormatValue = exports.ExportCompression = exports.ExportAuditLogsRequestOperationType = exports.EventTimelineEntryUpdatedReactionAction = exports.EventSourceStatus = exports.EventFetchedResult = exports.ErrorUnauthorizedType = exports.ErrorTooManyRequestsType = exports.ErrorServiceUnavailableType = exports.ErrorSeeOtherType = exports.ErrorRequestEntityTooLargeType = exports.ErrorNotFoundType = exports.ErrorInternalServerErrorType = exports.ErrorForbiddenType = exports.ErrorConflictType = exports.ErrorBadRequestWorkflowComponentValidationErrorWorkflowComponentValidationLocationType = exports.ErrorBadRequestUnexpectedJsonTypeType = exports.ErrorBadRequestType = exports.ErrorBadRequestSpaceValidationErrorType = exports.ErrorBadRequestGroupHierarchyInvalidParentReason = exports.ErrorBadRequestCustomizationValidationErrorSubtype = exports.EnhancementRevScoreTier = exports.EngagementsCreateRequestEngagementType = exports.EngagementType = exports.DynamicVistaFilterType = exports.DevrevQueryTemplateValueValue = exports.DevrevQueryMembershipOperatorValueType = exports.DevrevQueryGroupExpressionSortDirection = exports.DevrevQueryGroupExpressionOrder = exports.DevrevQueryDateTimePresetOperatorValueType = exports.DevrevQueryDateTimeOperatorValueType = exports.DevrevQueryComparisonOperatorValueType = exports.DevrevExpressionOp = exports.DeviceType = exports.DevicePlatform = exports.DevUsersCreateRequestStateEnumValue = exports.DevUserJobTitle = exports.DevOrgAuthConnectionsUpdateRequestType = exports.DevOrgAuthConnectionsCreateRequestType = void 0;
38
- exports.OrgType = exports.OrgScheduleStatus = exports.OrgScheduleFragmentStatus = exports.OrgEnvironment = exports.OpportunityPriority = exports.OpportunityForecastCategory = exports.ObservabilityTimelineEventType = exports.ObservabilitySessionsListRequestType = exports.ObservabilitySessionsDataGetResponseRecording = exports.ObservabilitySessionsAggregateResponseMetricResultMetricType = exports.ObservabilitySessionsAggregateResponseBucketItemBucketType = exports.ObservabilitySessionsAggregateResponseAggregationResultResultType = exports.ObservabilitySessionsAggregateRequestType = exports.ObservabilitySessionsAggregateRequestSchemaType = exports.ObservabilitySessionsAggregateRequestAggregationConfigType = exports.ObservabilitySessionType = exports.ObjectsListResponseType = exports.NotificationPriority = exports.MobileRecordingRecordingEventsTimelineInputType = exports.MobileRecordingRecordingEventsTimelineEventType = exports.MobileRecordingRecordingEventsTimelineEventName = exports.MobileRecordingAppLaunchLaunchType = exports.MetricTrackerType = exports.MetricDefinitionStatus = exports.MetricDefinitionMetricType = exports.MetricDefinitionAppliesTo = exports.MetricActionExecuteRequestAction = exports.MethodOptionsTagValue = exports.MetadataType = exports.MemberType = exports.MeetingState = exports.MeetingDirection = exports.MeetingChannel = exports.MeerkatWidgetColumnProjectionType = exports.MeerkatWidgetColumnProjectionTimestampRollup = exports.MeerkatWidgetColumnFunctionType = exports.MarketplaceItemOperationFeatureOperationType = exports.MarketplaceItemMcpServerFeatureServerType = exports.MarketplaceItemItemType = exports.MarketplaceItemFeatureType = exports.MarketplaceItemFeatureFeatureType = exports.ListMode = exports.LinksDirection = exports.LinkType = exports.LinkEndpointType = exports.LineVisualizationYAxisStrokeStyle = exports.KanbanVisualizationCardAttributePosition = exports.JobState = exports.JobCategory = exports.IssuePriority = void 0;
39
- exports.StatusCodeClass = exports.StageValidationOptionForUpdate = exports.StageValidationOptionForCreate = exports.SpaceFilterSpaceIdOperatorType = exports.SnapWidgetsCreateRequestType = exports.SnapWidgetType = exports.SnapWidgetStatus = exports.SnapWidgetNamespace = exports.SnapWidgetInteractionType = exports.SnapWidgetClickInteractionClickAction = exports.SnapKitBaseWidgetSnapKitExecution = 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.SessionCustomAttributeFilterFilterType = exports.ServicePlanStatus = exports.ServicePlanBillingCycle = exports.SeriesVisualizationType = exports.SeriesVisualizationStrokeStyle = 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 = exports.PrimitiveValueType = exports.PricingBillingCycle = exports.PreferencesType = exports.PeriodToDate = exports.PartsVistaGroupItemType = exports.PartType = void 0;
40
- exports.WidgetIdentifier = 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.TimelineEntriesListRequestBias = exports.TimelineEntriesCreateRequestType = exports.TimelineEntriesCollection = exports.TimelineCommentBodyType = exports.TimelineChangeEventEventType = exports.TimeMetricTrackerStatus = exports.TicketSeverity = exports.TicketChannels = exports.TaskPriority = exports.TableVisualizationColumnPinPosition = exports.TableVisualizationColumnLockPosition = exports.TableDataStorageType = exports.SyncUnitSyncType = exports.SyncUnitAvailableActions = exports.SyncRunStartedBy = exports.SyncRunProgressState = exports.SyncRunMode = exports.SyncProgressState = exports.SyncPreferenceSyncTier = exports.SyncOutStatus = exports.SyncMetadataFilterSyncOutFilterStatus = exports.SyncMetadataFilterSyncInFilterStatus = exports.SyncInStatus = exports.SyncDirection = exports.StockSchemaFragmentsListRequestPrune = exports.StockSchemaFragmentsListRequestFilterPreset = void 0;
41
- exports.Api = exports.HttpClient = exports.ContentType = exports.WorksVistaGroupItemType = exports.WorksFilterTicketGroupsOpOperatorType = exports.WorksFilterIssueSprintStateValue = exports.WorkType = exports.WidgetVisualizationType = exports.WidgetVersion = exports.WidgetQueryOrderByDirection = exports.WidgetQueryColumnConfigType = exports.WidgetQueryColumnConfigTimeGranularity = exports.WidgetQueryColumnConfigAggregation = void 0;
38
+ exports.OrgScheduleStatus = exports.OrgScheduleFragmentStatus = exports.OrgEnvironment = exports.OpportunityPriority = exports.OpportunityForecastCategory = exports.ObservabilityTimelineEventType = exports.ObservabilitySessionsListRequestType = exports.ObservabilitySessionsDataGetResponseRecording = exports.ObservabilitySessionsAggregateResponseMetricResultMetricType = exports.ObservabilitySessionsAggregateResponseBucketItemBucketType = exports.ObservabilitySessionsAggregateResponseAggregationResultResultType = exports.ObservabilitySessionsAggregateRequestType = exports.ObservabilitySessionsAggregateRequestSchemaType = exports.ObservabilitySessionsAggregateRequestAggregationConfigType = exports.ObservabilitySessionType = exports.ObjectsListResponseType = exports.NotificationPriority = exports.NetworkLogType = exports.MobileRecordingRecordingEventsTimelineInputType = exports.MobileRecordingRecordingEventsTimelineEventType = exports.MobileRecordingRecordingEventsTimelineEventName = exports.MobileRecordingAppLaunchLaunchType = exports.MetricTrackerType = exports.MetricDefinitionStatus = exports.MetricDefinitionMetricType = exports.MetricDefinitionAppliesTo = exports.MetricActionExecuteRequestAction = exports.MethodOptionsTagValue = exports.MetadataType = exports.MemberType = exports.MeetingState = exports.MeetingDirection = exports.MeetingChannel = exports.MeerkatWidgetColumnProjectionType = exports.MeerkatWidgetColumnProjectionTimestampRollup = exports.MeerkatWidgetColumnFunctionType = exports.MarketplaceItemOperationFeatureOperationType = exports.MarketplaceItemMcpServerFeatureServerType = exports.MarketplaceItemItemType = exports.MarketplaceItemFeatureType = exports.MarketplaceItemFeatureFeatureType = exports.ListMode = exports.LinksDirection = exports.LinkType = exports.LinkEndpointType = exports.LineVisualizationYAxisStrokeStyle = exports.KanbanVisualizationCardAttributePosition = exports.JobState = exports.JobCategory = exports.IssuePriority = void 0;
39
+ exports.StageValidationOptionForUpdate = exports.StageValidationOptionForCreate = exports.SpaceFilterSpaceIdOperatorType = exports.SnapWidgetsCreateRequestType = exports.SnapWidgetType = exports.SnapWidgetStatus = exports.SnapWidgetNamespace = exports.SnapWidgetInteractionType = exports.SnapWidgetClickInteractionClickAction = exports.SnapKitBaseWidgetSnapKitExecution = 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.SessionCustomAttributeFilterFilterType = exports.ServicePlanStatus = exports.ServicePlanBillingCycle = exports.SeriesVisualizationType = exports.SeriesVisualizationStrokeStyle = 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 = exports.PrimitiveValueType = exports.PricingBillingCycle = exports.PreferencesType = exports.PeriodToDate = exports.PartsVistaGroupItemType = exports.PartType = exports.OrgType = void 0;
40
+ 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.TimelineEntriesListRequestBias = exports.TimelineEntriesCreateRequestType = exports.TimelineEntriesCollection = exports.TimelineCommentBodyType = exports.TimelineChangeEventEventType = exports.TimeMetricTrackerStatus = exports.TicketSeverity = exports.TicketChannels = exports.TaskPriority = exports.TableVisualizationColumnPinPosition = exports.TableVisualizationColumnLockPosition = exports.TableDataStorageType = exports.SyncUnitSyncType = exports.SyncUnitAvailableActions = exports.SyncRunStartedBy = exports.SyncRunProgressState = exports.SyncRunMode = exports.SyncProgressState = exports.SyncPreferenceSyncTier = exports.SyncOutStatus = exports.SyncMetadataFilterSyncOutFilterStatus = exports.SyncMetadataFilterSyncInFilterStatus = exports.SyncInStatus = exports.SyncDirection = exports.StockSchemaFragmentsListRequestPrune = exports.StockSchemaFragmentsListRequestFilterPreset = exports.StatusCodeClass = void 0;
41
+ exports.Api = exports.HttpClient = exports.ContentType = exports.WorksVistaGroupItemType = exports.WorksFilterTicketGroupsOpOperatorType = exports.WorksFilterIssueSprintStateValue = exports.WorkType = exports.WidgetVisualizationType = exports.WidgetVersion = exports.WidgetQueryOrderByDirection = exports.WidgetQueryColumnConfigType = exports.WidgetQueryColumnConfigTimeGranularity = exports.WidgetQueryColumnConfigAggregation = exports.WidgetIdentifier = void 0;
42
42
  var AccessLevel;
43
43
  (function (AccessLevel) {
44
44
  AccessLevel["External"] = "external";
@@ -438,6 +438,7 @@ var DashboardFilterConditionValueType;
438
438
  DashboardFilterConditionValueType["JsonValue"] = "json_value";
439
439
  DashboardFilterConditionValueType["PartValue"] = "part_value";
440
440
  DashboardFilterConditionValueType["RelativeDateValue"] = "relative_date_value";
441
+ DashboardFilterConditionValueType["TemplateValue"] = "template_value";
441
442
  })(DashboardFilterConditionValueType = exports.DashboardFilterConditionValueType || (exports.DashboardFilterConditionValueType = {}));
442
443
  /** The logical operator that binds the filter conditions or expressions. */
443
444
  var DashboardFilterExpressionOperator;
@@ -757,6 +758,7 @@ var ErrorBadRequestType;
757
758
  ErrorBadRequestType["MergeWorksError"] = "merge_works_error";
758
759
  ErrorBadRequestType["MissingDependency"] = "missing_dependency";
759
760
  ErrorBadRequestType["MissingRequiredField"] = "missing_required_field";
761
+ ErrorBadRequestType["OperationNotAllowed"] = "operation_not_allowed";
760
762
  ErrorBadRequestType["ParseError"] = "parse_error";
761
763
  ErrorBadRequestType["SpaceValidationErrors"] = "space_validation_errors";
762
764
  ErrorBadRequestType["StaleSchemaFragments"] = "stale_schema_fragments";
@@ -1374,6 +1376,19 @@ var MobileRecordingRecordingEventsTimelineInputType;
1374
1376
  MobileRecordingRecordingEventsTimelineInputType["ToolTypeStylus"] = "tool_type_stylus";
1375
1377
  MobileRecordingRecordingEventsTimelineInputType["ToolTypeUnknown"] = "tool_type_unknown";
1376
1378
  })(MobileRecordingRecordingEventsTimelineInputType = exports.MobileRecordingRecordingEventsTimelineInputType || (exports.MobileRecordingRecordingEventsTimelineInputType = {}));
1379
+ /** The type of network log. */
1380
+ var NetworkLogType;
1381
+ (function (NetworkLogType) {
1382
+ NetworkLogType["Css"] = "css";
1383
+ NetworkLogType["Fetch"] = "fetch";
1384
+ NetworkLogType["Font"] = "font";
1385
+ NetworkLogType["Iframe"] = "iframe";
1386
+ NetworkLogType["Img"] = "img";
1387
+ NetworkLogType["Link"] = "link";
1388
+ NetworkLogType["Other"] = "other";
1389
+ NetworkLogType["Script"] = "script";
1390
+ NetworkLogType["Xhr"] = "xhr";
1391
+ })(NetworkLogType = exports.NetworkLogType || (exports.NetworkLogType = {}));
1377
1392
  /** Priority of the notification. */
1378
1393
  var NotificationPriority;
1379
1394
  (function (NotificationPriority) {
@@ -1387,6 +1402,7 @@ var ObjectsListResponseType;
1387
1402
  ObjectsListResponseType["CustomObjects"] = "custom_objects";
1388
1403
  ObjectsListResponseType["Enhancements"] = "enhancements";
1389
1404
  ObjectsListResponseType["Issues"] = "issues";
1405
+ ObjectsListResponseType["RevUsers"] = "rev_users";
1390
1406
  })(ObjectsListResponseType = exports.ObjectsListResponseType || (exports.ObjectsListResponseType = {}));
1391
1407
  var ObservabilitySessionType;
1392
1408
  (function (ObservabilitySessionType) {
@@ -1657,7 +1673,6 @@ var SearchHybridNamespace;
1657
1673
  SearchHybridNamespace["Conversation"] = "conversation";
1658
1674
  SearchHybridNamespace["CustomObject"] = "custom_object";
1659
1675
  SearchHybridNamespace["CustomPart"] = "custom_part";
1660
- SearchHybridNamespace["CustomWork"] = "custom_work";
1661
1676
  SearchHybridNamespace["Dashboard"] = "dashboard";
1662
1677
  SearchHybridNamespace["Dataset"] = "dataset";
1663
1678
  SearchHybridNamespace["DevUser"] = "dev_user";
@@ -1674,7 +1689,6 @@ var SearchHybridNamespace;
1674
1689
  SearchHybridNamespace["Opportunity"] = "opportunity";
1675
1690
  SearchHybridNamespace["Part"] = "part";
1676
1691
  SearchHybridNamespace["Product"] = "product";
1677
- SearchHybridNamespace["Project"] = "project";
1678
1692
  SearchHybridNamespace["QuestionAnswer"] = "question_answer";
1679
1693
  SearchHybridNamespace["RevOrg"] = "rev_org";
1680
1694
  SearchHybridNamespace["RevUser"] = "rev_user";
@@ -1699,7 +1713,6 @@ var SearchNamespace;
1699
1713
  SearchNamespace["Conversation"] = "conversation";
1700
1714
  SearchNamespace["CustomObject"] = "custom_object";
1701
1715
  SearchNamespace["CustomPart"] = "custom_part";
1702
- SearchNamespace["CustomWork"] = "custom_work";
1703
1716
  SearchNamespace["Dashboard"] = "dashboard";
1704
1717
  SearchNamespace["DevUser"] = "dev_user";
1705
1718
  SearchNamespace["Directory"] = "directory";
@@ -1713,7 +1726,6 @@ var SearchNamespace;
1713
1726
  SearchNamespace["Operation"] = "operation";
1714
1727
  SearchNamespace["Opportunity"] = "opportunity";
1715
1728
  SearchNamespace["Product"] = "product";
1716
- SearchNamespace["Project"] = "project";
1717
1729
  SearchNamespace["QuestionAnswer"] = "question_answer";
1718
1730
  SearchNamespace["RevOrg"] = "rev_org";
1719
1731
  SearchNamespace["RevUser"] = "rev_user";
@@ -2646,7 +2658,7 @@ class Api extends HttpClient {
2646
2658
  constructor() {
2647
2659
  super(...arguments);
2648
2660
  /**
2649
- * @description Creates an account, which is a record representing a customer or an organization.
2661
+ * @description Creates an account, which is a record representing a customer or an organization. **Required scopes:** - `account:write` OR `account:all`
2650
2662
  *
2651
2663
  * @tags accounts
2652
2664
  * @name AccountsCreate
@@ -2656,7 +2668,7 @@ class Api extends HttpClient {
2656
2668
  */
2657
2669
  this.accountsCreate = (data, params = {}) => this.request(Object.assign({ path: `/accounts.create`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
2658
2670
  /**
2659
- * @description Deletes an account.
2671
+ * @description Deletes an account. **Required scopes:** - `account:all`
2660
2672
  *
2661
2673
  * @tags accounts
2662
2674
  * @name AccountsDelete
@@ -2666,7 +2678,7 @@ class Api extends HttpClient {
2666
2678
  */
2667
2679
  this.accountsDelete = (data, params = {}) => this.request(Object.assign({ path: `/accounts.delete`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
2668
2680
  /**
2669
- * @description Exports a collection of accounts.
2681
+ * @description Exports a collection of accounts. **Required scopes:** - `account:read` OR `account:write` OR `account:all`
2670
2682
  *
2671
2683
  * @tags accounts
2672
2684
  * @name AccountsExport
@@ -2676,7 +2688,7 @@ class Api extends HttpClient {
2676
2688
  */
2677
2689
  this.accountsExport = (query, params = {}) => this.request(Object.assign({ path: `/accounts.export`, method: 'GET', query: query, secure: true, format: 'json' }, params));
2678
2690
  /**
2679
- * @description Exports a collection of accounts.
2691
+ * @description Exports a collection of accounts. **Required scopes:** - `account:read` OR `account:write` OR `account:all`
2680
2692
  *
2681
2693
  * @tags accounts
2682
2694
  * @name AccountsExportPost
@@ -2686,7 +2698,7 @@ class Api extends HttpClient {
2686
2698
  */
2687
2699
  this.accountsExportPost = (data, params = {}) => this.request(Object.assign({ path: `/accounts.export`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
2688
2700
  /**
2689
- * @description Retrieves an account's information.
2701
+ * @description Retrieves an account's information. **Required scopes:** - `account:read` OR `account:write` OR `account:all`
2690
2702
  *
2691
2703
  * @tags accounts
2692
2704
  * @name AccountsGet
@@ -2696,7 +2708,7 @@ class Api extends HttpClient {
2696
2708
  */
2697
2709
  this.accountsGet = (query, params = {}) => this.request(Object.assign({ path: `/accounts.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
2698
2710
  /**
2699
- * @description Retrieves an account's information.
2711
+ * @description Retrieves an account's information. **Required scopes:** - `account:read` OR `account:write` OR `account:all`
2700
2712
  *
2701
2713
  * @tags accounts
2702
2714
  * @name AccountsGetPost
@@ -2706,7 +2718,7 @@ class Api extends HttpClient {
2706
2718
  */
2707
2719
  this.accountsGetPost = (data, params = {}) => this.request(Object.assign({ path: `/accounts.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
2708
2720
  /**
2709
- * @description Gets a list of accounts.
2721
+ * @description Gets a list of accounts. **Required scopes:** - `account:read` OR `account:write` OR `account:all`
2710
2722
  *
2711
2723
  * @tags accounts
2712
2724
  * @name AccountsList
@@ -2716,7 +2728,7 @@ class Api extends HttpClient {
2716
2728
  */
2717
2729
  this.accountsList = (query, params = {}) => this.request(Object.assign({ path: `/accounts.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
2718
2730
  /**
2719
- * @description Gets a list of accounts.
2731
+ * @description Gets a list of accounts. **Required scopes:** - `account:read` OR `account:write` OR `account:all`
2720
2732
  *
2721
2733
  * @tags accounts
2722
2734
  * @name AccountsListPost
@@ -2726,7 +2738,7 @@ class Api extends HttpClient {
2726
2738
  */
2727
2739
  this.accountsListPost = (data, params = {}) => this.request(Object.assign({ path: `/accounts.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
2728
2740
  /**
2729
- * @description Merges two accounts.
2741
+ * @description Merges two accounts. **Required scopes:** - `account:all`
2730
2742
  *
2731
2743
  * @tags accounts
2732
2744
  * @name AccountsMerge
@@ -2736,7 +2748,7 @@ class Api extends HttpClient {
2736
2748
  */
2737
2749
  this.accountsMerge = (data, params = {}) => this.request(Object.assign({ path: `/accounts.merge`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
2738
2750
  /**
2739
- * @description Updates an account's information.
2751
+ * @description Updates an account's information. **Required scopes:** - `account:write` OR `account:all`
2740
2752
  *
2741
2753
  * @tags accounts
2742
2754
  * @name AccountsUpdate
@@ -2926,7 +2938,7 @@ class Api extends HttpClient {
2926
2938
  */
2927
2939
  this.articlesCountPost = (data, params = {}) => this.request(Object.assign({ path: `/articles.count`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
2928
2940
  /**
2929
- * @description Article is an object which can contain a URL or artifacts in the resource. It also contains the data regarding the owner, author, status and published date of the object. This call creates an article.
2941
+ * @description Article is an object which can contain a URL or artifacts in the resource. It also contains the data regarding the owner, author, status and published date of the object. This call creates an article. **Required scopes:** - `article:write` OR `article:all`
2930
2942
  *
2931
2943
  * @tags articles
2932
2944
  * @name CreateArticle
@@ -2936,7 +2948,7 @@ class Api extends HttpClient {
2936
2948
  */
2937
2949
  this.createArticle = (data, params = {}) => this.request(Object.assign({ path: `/articles.create`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
2938
2950
  /**
2939
- * @description Deletes an article.
2951
+ * @description Deletes an article. **Required scopes:** - `article:all`
2940
2952
  *
2941
2953
  * @tags articles
2942
2954
  * @name DeleteArticle
@@ -2946,7 +2958,7 @@ class Api extends HttpClient {
2946
2958
  */
2947
2959
  this.deleteArticle = (data, params = {}) => this.request(Object.assign({ path: `/articles.delete`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
2948
2960
  /**
2949
- * @description Gets an article.
2961
+ * @description Gets an article. **Required scopes:** - `article:read` OR `article:write` OR `article:all`
2950
2962
  *
2951
2963
  * @tags articles
2952
2964
  * @name GetArticle
@@ -2956,7 +2968,7 @@ class Api extends HttpClient {
2956
2968
  */
2957
2969
  this.getArticle = (query, params = {}) => this.request(Object.assign({ path: `/articles.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
2958
2970
  /**
2959
- * @description Gets an article.
2971
+ * @description Gets an article. **Required scopes:** - `article:read` OR `article:write` OR `article:all`
2960
2972
  *
2961
2973
  * @tags articles
2962
2974
  * @name GetArticlePost
@@ -2966,7 +2978,7 @@ class Api extends HttpClient {
2966
2978
  */
2967
2979
  this.getArticlePost = (data, params = {}) => this.request(Object.assign({ path: `/articles.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
2968
2980
  /**
2969
- * @description Lists a collection of articles.
2981
+ * @description Lists a collection of articles. **Required scopes:** - `article:read` OR `article:write` OR `article:all`
2970
2982
  *
2971
2983
  * @tags articles
2972
2984
  * @name ListArticles
@@ -2976,7 +2988,7 @@ class Api extends HttpClient {
2976
2988
  */
2977
2989
  this.listArticles = (query, params = {}) => this.request(Object.assign({ path: `/articles.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
2978
2990
  /**
2979
- * @description Lists a collection of articles.
2991
+ * @description Lists a collection of articles. **Required scopes:** - `article:read` OR `article:write` OR `article:all`
2980
2992
  *
2981
2993
  * @tags articles
2982
2994
  * @name ListArticlesPost
@@ -2986,7 +2998,7 @@ class Api extends HttpClient {
2986
2998
  */
2987
2999
  this.listArticlesPost = (data, params = {}) => this.request(Object.assign({ path: `/articles.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
2988
3000
  /**
2989
- * @description Updates an article.
3001
+ * @description Updates an article. **Required scopes:** - `article:write` OR `article:all`
2990
3002
  *
2991
3003
  * @tags articles
2992
3004
  * @name UpdateArticle
@@ -2996,7 +3008,7 @@ class Api extends HttpClient {
2996
3008
  */
2997
3009
  this.updateArticle = (data, params = {}) => this.request(Object.assign({ path: `/articles.update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
2998
3010
  /**
2999
- * @description Redirects to the artifact's download URL.
3011
+ * @description Redirects to the artifact's download URL. **Required scopes:** - `artifact:read`
3000
3012
  *
3001
3013
  * @tags artifacts
3002
3014
  * @name ArtifactsDownload
@@ -3006,7 +3018,7 @@ class Api extends HttpClient {
3006
3018
  */
3007
3019
  this.artifactsDownload = (query, params = {}) => this.request(Object.assign({ path: `/artifacts.download`, method: 'GET', query: query, secure: true }, params));
3008
3020
  /**
3009
- * @description Redirects to the artifact's download URL.
3021
+ * @description Redirects to the artifact's download URL. **Required scopes:** - `artifact:read`
3010
3022
  *
3011
3023
  * @tags artifacts
3012
3024
  * @name ArtifactsDownloadPost
@@ -3016,7 +3028,7 @@ class Api extends HttpClient {
3016
3028
  */
3017
3029
  this.artifactsDownloadPost = (data, params = {}) => this.request(Object.assign({ path: `/artifacts.download`, method: 'POST', body: data, secure: true, type: ContentType.Json }, params));
3018
3030
  /**
3019
- * @description Gets the requested artifact's information.
3031
+ * @description Gets the requested artifact's information. **Required scopes:** - `artifact:read` Also needs parent read access.
3020
3032
  *
3021
3033
  * @tags artifacts
3022
3034
  * @name ArtifactsGet
@@ -3026,7 +3038,7 @@ class Api extends HttpClient {
3026
3038
  */
3027
3039
  this.artifactsGet = (query, params = {}) => this.request(Object.assign({ path: `/artifacts.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
3028
3040
  /**
3029
- * @description Gets the requested artifact's information.
3041
+ * @description Gets the requested artifact's information. **Required scopes:** - `artifact:read` Also needs parent read access.
3030
3042
  *
3031
3043
  * @tags artifacts
3032
3044
  * @name ArtifactsGetPost
@@ -3036,7 +3048,7 @@ class Api extends HttpClient {
3036
3048
  */
3037
3049
  this.artifactsGetPost = (data, params = {}) => this.request(Object.assign({ path: `/artifacts.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
3038
3050
  /**
3039
- * @description List the artifacts attached to an object.
3051
+ * @description List the artifacts attached to an object. **Required scopes:** - `artifact:read` Also needs parent read access.
3040
3052
  *
3041
3053
  * @tags artifacts
3042
3054
  * @name ArtifactsList
@@ -3046,7 +3058,7 @@ class Api extends HttpClient {
3046
3058
  */
3047
3059
  this.artifactsList = (query, params = {}) => this.request(Object.assign({ path: `/artifacts.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
3048
3060
  /**
3049
- * @description List the artifacts attached to an object.
3061
+ * @description List the artifacts attached to an object. **Required scopes:** - `artifact:read` Also needs parent read access.
3050
3062
  *
3051
3063
  * @tags artifacts
3052
3064
  * @name ArtifactsListPost
@@ -3056,7 +3068,7 @@ class Api extends HttpClient {
3056
3068
  */
3057
3069
  this.artifactsListPost = (data, params = {}) => this.request(Object.assign({ path: `/artifacts.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
3058
3070
  /**
3059
- * @description Gets the download URL for the artifact.
3071
+ * @description Gets the download URL for the artifact. **Required scopes:** - `artifact:read` Also needs parent read access.
3060
3072
  *
3061
3073
  * @tags artifacts
3062
3074
  * @name ArtifactsLocate
@@ -3066,7 +3078,7 @@ class Api extends HttpClient {
3066
3078
  */
3067
3079
  this.artifactsLocate = (query, params = {}) => this.request(Object.assign({ path: `/artifacts.locate`, method: 'GET', query: query, secure: true, format: 'json' }, params));
3068
3080
  /**
3069
- * @description Gets the download URL for the artifact.
3081
+ * @description Gets the download URL for the artifact. **Required scopes:** - `artifact:read` Also needs parent read access.
3070
3082
  *
3071
3083
  * @tags artifacts
3072
3084
  * @name ArtifactsLocatePost
@@ -3076,7 +3088,7 @@ class Api extends HttpClient {
3076
3088
  */
3077
3089
  this.artifactsLocatePost = (data, params = {}) => this.request(Object.assign({ path: `/artifacts.locate`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
3078
3090
  /**
3079
- * @description Creates an artifact and generates an upload URL for its data.
3091
+ * @description Creates an artifact and generates an upload URL for its data. **Required scopes:** - `artifact:create`
3080
3092
  *
3081
3093
  * @tags artifacts
3082
3094
  * @name ArtifactsPrepare
@@ -3086,7 +3098,7 @@ class Api extends HttpClient {
3086
3098
  */
3087
3099
  this.artifactsPrepare = (data, params = {}) => this.request(Object.assign({ path: `/artifacts.prepare`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
3088
3100
  /**
3089
- * @description Permanently deletes a version of an artifact.
3101
+ * @description Permanently deletes a version of an artifact. **Required scopes:** - `artifact:create`
3090
3102
  *
3091
3103
  * @tags artifacts
3092
3104
  * @name ArtifactsHardDeleteVersion
@@ -3096,7 +3108,7 @@ class Api extends HttpClient {
3096
3108
  */
3097
3109
  this.artifactsHardDeleteVersion = (data, params = {}) => this.request(Object.assign({ path: `/artifacts.versions.delete`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
3098
3110
  /**
3099
- * @description Prepares a new version for an artifact, returning the URL and form data to upload the updated file.
3111
+ * @description Prepares a new version for an artifact, returning the URL and form data to upload the updated file. **Required scopes:** - `artifact:create`
3100
3112
  *
3101
3113
  * @tags artifacts
3102
3114
  * @name ArtifactsVersionsPrepare
@@ -3136,7 +3148,7 @@ class Api extends HttpClient {
3136
3148
  */
3137
3149
  this.exportAuditLogs = (data, params = {}) => this.request(Object.assign({ path: `/audit-logs.fetch`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
3138
3150
  /**
3139
- * @description Creates a JWT corresponding to the requested token type for the authenticated user.
3151
+ * @description Creates a JWT corresponding to the requested token type for the authenticated user. **Required scopes:** No scopes required.
3140
3152
  *
3141
3153
  * @tags auth-tokens
3142
3154
  * @name AuthTokensCreate
@@ -3146,7 +3158,7 @@ class Api extends HttpClient {
3146
3158
  */
3147
3159
  this.authTokensCreate = (data, params = {}) => this.request(Object.assign({ path: `/auth-tokens.create`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
3148
3160
  /**
3149
- * @description Revokes the token that matches the given token ID issued under the given Dev organization.
3161
+ * @description Revokes the token that matches the given token ID issued under the given Dev organization. **Required scopes:** No scopes required.
3150
3162
  *
3151
3163
  * @tags auth-tokens
3152
3164
  * @name AuthTokensDelete
@@ -3156,7 +3168,7 @@ class Api extends HttpClient {
3156
3168
  */
3157
3169
  this.authTokensDelete = (data, params = {}) => this.request(Object.assign({ path: `/auth-tokens.delete`, method: 'POST', body: data, secure: true, type: ContentType.Json }, params));
3158
3170
  /**
3159
- * @description Gets the token metadata corresponding to the given token ID under the given Dev organization.
3171
+ * @description Gets the token metadata corresponding to the given token ID under the given Dev organization. **Required scopes:** No scopes required.
3160
3172
  *
3161
3173
  * @tags auth-tokens
3162
3174
  * @name AuthTokensGet
@@ -3166,7 +3178,7 @@ class Api extends HttpClient {
3166
3178
  */
3167
3179
  this.authTokensGet = (query, params = {}) => this.request(Object.assign({ path: `/auth-tokens.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
3168
3180
  /**
3169
- * @description Gets the token metadata corresponding to the given token ID under the given Dev organization.
3181
+ * @description Gets the token metadata corresponding to the given token ID under the given Dev organization. **Required scopes:** No scopes required.
3170
3182
  *
3171
3183
  * @tags auth-tokens
3172
3184
  * @name AuthTokensGetPost
@@ -3176,7 +3188,7 @@ class Api extends HttpClient {
3176
3188
  */
3177
3189
  this.authTokensGetPost = (data, params = {}) => this.request(Object.assign({ path: `/auth-tokens.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
3178
3190
  /**
3179
- * @description Returns the Dev organization, user and token attributes extracted from the auth token.
3191
+ * @description Returns the Dev organization, user and token attributes extracted from the auth token. **Required scopes:** No scopes required.
3180
3192
  *
3181
3193
  * @tags auth-tokens
3182
3194
  * @name AuthTokensInfo
@@ -3186,7 +3198,7 @@ class Api extends HttpClient {
3186
3198
  */
3187
3199
  this.authTokensInfo = (params = {}) => this.request(Object.assign({ path: `/auth-tokens.info`, method: 'GET', secure: true, format: 'json' }, params));
3188
3200
  /**
3189
- * @description Returns the Dev organization, user and token attributes extracted from the auth token.
3201
+ * @description Returns the Dev organization, user and token attributes extracted from the auth token. **Required scopes:** No scopes required.
3190
3202
  *
3191
3203
  * @tags auth-tokens
3192
3204
  * @name AuthTokensInfoPost
@@ -3196,7 +3208,7 @@ class Api extends HttpClient {
3196
3208
  */
3197
3209
  this.authTokensInfoPost = (data, params = {}) => this.request(Object.assign({ path: `/auth-tokens.info`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
3198
3210
  /**
3199
- * @description Gets the token metadata for all the tokens corresponding to the given token type issued for a given subject.
3211
+ * @description Gets the token metadata for all the tokens corresponding to the given token type issued for a given subject. **Required scopes:** No scopes required.
3200
3212
  *
3201
3213
  * @tags auth-tokens
3202
3214
  * @name AuthTokensList
@@ -3206,7 +3218,7 @@ class Api extends HttpClient {
3206
3218
  */
3207
3219
  this.authTokensList = (query, params = {}) => this.request(Object.assign({ path: `/auth-tokens.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
3208
3220
  /**
3209
- * @description Gets the token metadata for all the tokens corresponding to the given token type issued for a given subject.
3221
+ * @description Gets the token metadata for all the tokens corresponding to the given token type issued for a given subject. **Required scopes:** No scopes required.
3210
3222
  *
3211
3223
  * @tags auth-tokens
3212
3224
  * @name AuthTokensListPost
@@ -3216,7 +3228,7 @@ class Api extends HttpClient {
3216
3228
  */
3217
3229
  this.authTokensListPost = (data, params = {}) => this.request(Object.assign({ path: `/auth-tokens.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
3218
3230
  /**
3219
- * @description Revokes all the tokens that matches the given token type created by the authenticated user.
3231
+ * @description Revokes all the tokens that matches the given token type created by the authenticated user. **Required scopes:** No scopes required.
3220
3232
  *
3221
3233
  * @tags auth-tokens
3222
3234
  * @name AuthTokensSelfDelete
@@ -3226,7 +3238,7 @@ class Api extends HttpClient {
3226
3238
  */
3227
3239
  this.authTokensSelfDelete = (data, params = {}) => this.request(Object.assign({ path: `/auth-tokens.self.delete`, method: 'POST', body: data, secure: true, type: ContentType.Json }, params));
3228
3240
  /**
3229
- * @description Updates token metadata of a token issued under a given Dev organization.
3241
+ * @description Updates token metadata of a token issued under a given Dev organization. **Required scopes:** No scopes required.
3230
3242
  *
3231
3243
  * @tags auth-tokens
3232
3244
  * @name AuthTokensUpdate
@@ -3306,7 +3318,7 @@ class Api extends HttpClient {
3306
3318
  */
3307
3319
  this.brandsUpdate = (data, params = {}) => this.request(Object.assign({ path: `/brands.update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
3308
3320
  /**
3309
- * @description Creates a new chat, or optionally opens an existing one.
3321
+ * @description Creates a new chat, or optionally opens an existing one. **Required scopes:** Access is determined by chat membership.
3310
3322
  *
3311
3323
  * @tags chats
3312
3324
  * @name ChatsCreate
@@ -3316,7 +3328,7 @@ class Api extends HttpClient {
3316
3328
  */
3317
3329
  this.chatsCreate = (data, params = {}) => this.request(Object.assign({ path: `/chats.create`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
3318
3330
  /**
3319
- * @description Gets a chat's information.
3331
+ * @description Gets a chat's information. **Required scopes:** Access is determined by chat membership.
3320
3332
  *
3321
3333
  * @tags chats
3322
3334
  * @name ChatsGet
@@ -3326,7 +3338,7 @@ class Api extends HttpClient {
3326
3338
  */
3327
3339
  this.chatsGet = (query, params = {}) => this.request(Object.assign({ path: `/chats.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
3328
3340
  /**
3329
- * @description Gets a chat's information.
3341
+ * @description Gets a chat's information. **Required scopes:** Access is determined by chat membership.
3330
3342
  *
3331
3343
  * @tags chats
3332
3344
  * @name ChatsGetPost
@@ -3336,7 +3348,7 @@ class Api extends HttpClient {
3336
3348
  */
3337
3349
  this.chatsGetPost = (data, params = {}) => this.request(Object.assign({ path: `/chats.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
3338
3350
  /**
3339
- * @description Updates a chat's information.
3351
+ * @description Updates a chat's information. **Required scopes:** Access is determined by chat membership.
3340
3352
  *
3341
3353
  * @tags chats
3342
3354
  * @name ChatsUpdate
@@ -3346,7 +3358,7 @@ class Api extends HttpClient {
3346
3358
  */
3347
3359
  this.chatsUpdate = (data, params = {}) => this.request(Object.assign({ path: `/chats.update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
3348
3360
  /**
3349
- * @description Creates a code change object.
3361
+ * @description Creates a code change object. **Required scopes:** - `code_change:write` OR `code_change:all`
3350
3362
  *
3351
3363
  * @tags code-changes
3352
3364
  * @name CodeChangesCreate
@@ -3356,7 +3368,7 @@ class Api extends HttpClient {
3356
3368
  */
3357
3369
  this.codeChangesCreate = (data, params = {}) => this.request(Object.assign({ path: `/code-changes.create`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
3358
3370
  /**
3359
- * @description Deletes a code change object.
3371
+ * @description Deletes a code change object. **Required scopes:** - `code_change:all`
3360
3372
  *
3361
3373
  * @tags code-changes
3362
3374
  * @name CodeChangesDelete
@@ -3366,7 +3378,7 @@ class Api extends HttpClient {
3366
3378
  */
3367
3379
  this.codeChangesDelete = (data, params = {}) => this.request(Object.assign({ path: `/code-changes.delete`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
3368
3380
  /**
3369
- * @description Gets a code change object.
3381
+ * @description Gets a code change object. **Required scopes:** - `code_change:read` OR `code_change:write` OR `code_change:all`
3370
3382
  *
3371
3383
  * @tags code-changes
3372
3384
  * @name CodeChangesGet
@@ -3376,7 +3388,7 @@ class Api extends HttpClient {
3376
3388
  */
3377
3389
  this.codeChangesGet = (query, params = {}) => this.request(Object.assign({ path: `/code-changes.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
3378
3390
  /**
3379
- * @description Gets a code change object.
3391
+ * @description Gets a code change object. **Required scopes:** - `code_change:read` OR `code_change:write` OR `code_change:all`
3380
3392
  *
3381
3393
  * @tags code-changes
3382
3394
  * @name CodeChangesGetPost
@@ -3386,7 +3398,7 @@ class Api extends HttpClient {
3386
3398
  */
3387
3399
  this.codeChangesGetPost = (data, params = {}) => this.request(Object.assign({ path: `/code-changes.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
3388
3400
  /**
3389
- * @description Lists code change objects.
3401
+ * @description Lists code change objects. **Required scopes:** - `code_change:read` OR `code_change:write` OR `code_change:all`
3390
3402
  *
3391
3403
  * @tags code-changes
3392
3404
  * @name CodeChangesList
@@ -3396,7 +3408,7 @@ class Api extends HttpClient {
3396
3408
  */
3397
3409
  this.codeChangesList = (query, params = {}) => this.request(Object.assign({ path: `/code-changes.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
3398
3410
  /**
3399
- * @description Lists code change objects.
3411
+ * @description Lists code change objects. **Required scopes:** - `code_change:read` OR `code_change:write` OR `code_change:all`
3400
3412
  *
3401
3413
  * @tags code-changes
3402
3414
  * @name CodeChangesListPost
@@ -3406,7 +3418,7 @@ class Api extends HttpClient {
3406
3418
  */
3407
3419
  this.codeChangesListPost = (data, params = {}) => this.request(Object.assign({ path: `/code-changes.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
3408
3420
  /**
3409
- * @description Updates a code change object.
3421
+ * @description Updates a code change object. **Required scopes:** - `code_change:write` OR `code_change:all`
3410
3422
  *
3411
3423
  * @tags code-changes
3412
3424
  * @name CodeChangesUpdate
@@ -3416,7 +3428,7 @@ class Api extends HttpClient {
3416
3428
  */
3417
3429
  this.codeChangesUpdate = (data, params = {}) => this.request(Object.assign({ path: `/code-changes.update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
3418
3430
  /**
3419
- * @description Creates a command.
3431
+ * @description Creates a command. **Required scopes:** - `command:write` OR `command:all`
3420
3432
  *
3421
3433
  * @tags commands
3422
3434
  * @name CommandsCreate
@@ -3426,7 +3438,7 @@ class Api extends HttpClient {
3426
3438
  */
3427
3439
  this.commandsCreate = (data, params = {}) => this.request(Object.assign({ path: `/commands.create`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
3428
3440
  /**
3429
- * @description Gets a command.
3441
+ * @description Gets a command. **Required scopes:** - `command:read` OR `command:write` OR `command:all`
3430
3442
  *
3431
3443
  * @tags commands
3432
3444
  * @name CommandsGet
@@ -3436,7 +3448,7 @@ class Api extends HttpClient {
3436
3448
  */
3437
3449
  this.commandsGet = (query, params = {}) => this.request(Object.assign({ path: `/commands.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
3438
3450
  /**
3439
- * @description Gets a command.
3451
+ * @description Gets a command. **Required scopes:** - `command:read` OR `command:write` OR `command:all`
3440
3452
  *
3441
3453
  * @tags commands
3442
3454
  * @name CommandsGetPost
@@ -3446,7 +3458,7 @@ class Api extends HttpClient {
3446
3458
  */
3447
3459
  this.commandsGetPost = (data, params = {}) => this.request(Object.assign({ path: `/commands.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
3448
3460
  /**
3449
- * @description Lists commands for a Dev organization.
3461
+ * @description Lists commands for a Dev organization. **Required scopes:** - `command:read` OR `command:write` OR `command:all`
3450
3462
  *
3451
3463
  * @tags commands
3452
3464
  * @name CommandsList
@@ -3456,7 +3468,7 @@ class Api extends HttpClient {
3456
3468
  */
3457
3469
  this.commandsList = (query, params = {}) => this.request(Object.assign({ path: `/commands.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
3458
3470
  /**
3459
- * @description Lists commands for a Dev organization.
3471
+ * @description Lists commands for a Dev organization. **Required scopes:** - `command:read` OR `command:write` OR `command:all`
3460
3472
  *
3461
3473
  * @tags commands
3462
3474
  * @name CommandsListPost
@@ -3466,7 +3478,7 @@ class Api extends HttpClient {
3466
3478
  */
3467
3479
  this.commandsListPost = (data, params = {}) => this.request(Object.assign({ path: `/commands.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
3468
3480
  /**
3469
- * @description Updates a command.
3481
+ * @description Updates a command. **Required scopes:** - `command:write` OR `command:all`
3470
3482
  *
3471
3483
  * @tags commands
3472
3484
  * @name CommandsUpdate
@@ -3536,7 +3548,7 @@ class Api extends HttpClient {
3536
3548
  */
3537
3549
  this.conversationsConvert = (data, params = {}) => this.request(Object.assign({ path: `/conversations.convert`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
3538
3550
  /**
3539
- * @description Creates a conversation.
3551
+ * @description Creates a conversation. **Required scopes:** - `conversation:write` OR `conversation:all`
3540
3552
  *
3541
3553
  * @tags conversations
3542
3554
  * @name ConversationsCreate
@@ -3546,7 +3558,7 @@ class Api extends HttpClient {
3546
3558
  */
3547
3559
  this.conversationsCreate = (data, params = {}) => this.request(Object.assign({ path: `/conversations.create`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
3548
3560
  /**
3549
- * @description Deletes the requested conversation.
3561
+ * @description Deletes the requested conversation. **Required scopes:** - `conversation:all`
3550
3562
  *
3551
3563
  * @tags conversations
3552
3564
  * @name ConversationsDelete
@@ -3576,7 +3588,7 @@ class Api extends HttpClient {
3576
3588
  */
3577
3589
  this.conversationsExportPost = (data, params = {}) => this.request(Object.assign({ path: `/conversations.export`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
3578
3590
  /**
3579
- * @description Gets the requested conversation's information.
3591
+ * @description Gets the requested conversation's information. **Required scopes:** - `conversation:read` OR `conversation:write` OR `conversation:all`
3580
3592
  *
3581
3593
  * @tags conversations
3582
3594
  * @name ConversationsGet
@@ -3586,7 +3598,7 @@ class Api extends HttpClient {
3586
3598
  */
3587
3599
  this.conversationsGet = (query, params = {}) => this.request(Object.assign({ path: `/conversations.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
3588
3600
  /**
3589
- * @description Gets the requested conversation's information.
3601
+ * @description Gets the requested conversation's information. **Required scopes:** - `conversation:read` OR `conversation:write` OR `conversation:all`
3590
3602
  *
3591
3603
  * @tags conversations
3592
3604
  * @name ConversationsGetPost
@@ -3596,7 +3608,7 @@ class Api extends HttpClient {
3596
3608
  */
3597
3609
  this.conversationsGetPost = (data, params = {}) => this.request(Object.assign({ path: `/conversations.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
3598
3610
  /**
3599
- * @description Lists the available conversations.
3611
+ * @description Lists the available conversations. **Required scopes:** - `conversation:read` OR `conversation:write` OR `conversation:all`
3600
3612
  *
3601
3613
  * @tags conversations
3602
3614
  * @name ConversationsList
@@ -3606,7 +3618,7 @@ class Api extends HttpClient {
3606
3618
  */
3607
3619
  this.conversationsList = (query, params = {}) => this.request(Object.assign({ path: `/conversations.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
3608
3620
  /**
3609
- * @description Lists the available conversations.
3621
+ * @description Lists the available conversations. **Required scopes:** - `conversation:read` OR `conversation:write` OR `conversation:all`
3610
3622
  *
3611
3623
  * @tags conversations
3612
3624
  * @name ConversationsListPost
@@ -3616,7 +3628,7 @@ class Api extends HttpClient {
3616
3628
  */
3617
3629
  this.conversationsListPost = (data, params = {}) => this.request(Object.assign({ path: `/conversations.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
3618
3630
  /**
3619
- * @description Updates the requested conversation.
3631
+ * @description Updates the requested conversation. **Required scopes:** - `conversation:write` OR `conversation:all`
3620
3632
  *
3621
3633
  * @tags conversations
3622
3634
  * @name ConversationsUpdate
@@ -3626,7 +3638,7 @@ class Api extends HttpClient {
3626
3638
  */
3627
3639
  this.conversationsUpdate = (data, params = {}) => this.request(Object.assign({ path: `/conversations.update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
3628
3640
  /**
3629
- * @description Counts custom objects.
3641
+ * @description Counts custom objects. **Required scopes:** No scopes required.
3630
3642
  *
3631
3643
  * @tags customization
3632
3644
  * @name CustomObjectsCount
@@ -3637,7 +3649,7 @@ class Api extends HttpClient {
3637
3649
  */
3638
3650
  this.customObjectsCount = (query, params = {}) => this.request(Object.assign({ path: `/custom-objects.count`, method: 'GET', query: query, secure: true, format: 'json' }, params));
3639
3651
  /**
3640
- * @description Counts custom objects.
3652
+ * @description Counts custom objects. **Required scopes:** No scopes required.
3641
3653
  *
3642
3654
  * @tags customization
3643
3655
  * @name CustomObjectsCountPost
@@ -3648,7 +3660,7 @@ class Api extends HttpClient {
3648
3660
  */
3649
3661
  this.customObjectsCountPost = (data, params = {}) => this.request(Object.assign({ path: `/custom-objects.count`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
3650
3662
  /**
3651
- * @description Creates a custom object.
3663
+ * @description Creates a custom object. **Required scopes:** - `custom_type_fragment:write`
3652
3664
  *
3653
3665
  * @tags customization
3654
3666
  * @name CustomObjectsCreate
@@ -3658,7 +3670,7 @@ class Api extends HttpClient {
3658
3670
  */
3659
3671
  this.customObjectsCreate = (data, params = {}) => this.request(Object.assign({ path: `/custom-objects.create`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
3660
3672
  /**
3661
- * @description Deletes a custom object.
3673
+ * @description Deletes a custom object. **Required scopes:** - `custom_type_fragment:write`
3662
3674
  *
3663
3675
  * @tags customization
3664
3676
  * @name CustomObjectsDelete
@@ -3668,7 +3680,7 @@ class Api extends HttpClient {
3668
3680
  */
3669
3681
  this.customObjectsDelete = (data, params = {}) => this.request(Object.assign({ path: `/custom-objects.delete`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
3670
3682
  /**
3671
- * @description Gets a custom object.
3683
+ * @description Gets a custom object. **Required scopes:** No scopes required.
3672
3684
  *
3673
3685
  * @tags customization
3674
3686
  * @name CustomObjectsGet
@@ -3678,7 +3690,7 @@ class Api extends HttpClient {
3678
3690
  */
3679
3691
  this.customObjectsGet = (query, params = {}) => this.request(Object.assign({ path: `/custom-objects.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
3680
3692
  /**
3681
- * @description Gets a custom object.
3693
+ * @description Gets a custom object. **Required scopes:** No scopes required.
3682
3694
  *
3683
3695
  * @tags customization
3684
3696
  * @name CustomObjectsGetPost
@@ -3688,7 +3700,7 @@ class Api extends HttpClient {
3688
3700
  */
3689
3701
  this.customObjectsGetPost = (data, params = {}) => this.request(Object.assign({ path: `/custom-objects.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
3690
3702
  /**
3691
- * @description Lists custom objects.
3703
+ * @description Lists custom objects. **Required scopes:** No scopes required.
3692
3704
  *
3693
3705
  * @tags customization
3694
3706
  * @name CustomObjectsList
@@ -3699,7 +3711,7 @@ class Api extends HttpClient {
3699
3711
  */
3700
3712
  this.customObjectsList = (query, params = {}) => this.request(Object.assign({ path: `/custom-objects.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
3701
3713
  /**
3702
- * @description Lists custom objects.
3714
+ * @description Lists custom objects. **Required scopes:** No scopes required.
3703
3715
  *
3704
3716
  * @tags customization
3705
3717
  * @name CustomObjectsListPost
@@ -3710,7 +3722,7 @@ class Api extends HttpClient {
3710
3722
  */
3711
3723
  this.customObjectsListPost = (data, params = {}) => this.request(Object.assign({ path: `/custom-objects.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
3712
3724
  /**
3713
- * @description Updates a custom object.
3725
+ * @description Updates a custom object. **Required scopes:** - `custom_type_fragment:write`
3714
3726
  *
3715
3727
  * @tags customization
3716
3728
  * @name CustomObjectsUpdate
@@ -3720,7 +3732,7 @@ class Api extends HttpClient {
3720
3732
  */
3721
3733
  this.customObjectsUpdate = (data, params = {}) => this.request(Object.assign({ path: `/custom-objects.update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
3722
3734
  /**
3723
- * @description Creates a new enterprise authentication connection for a Dev organization. This authentication connection will not be enabled by default for the organization and the user will need to explicitly enable this. Only 5 authentication connections can be created by an organization. **Required scopes:** - `dev_org:write`
3735
+ * @description Creates a new enterprise authentication connection for a Dev organization. This authentication connection will not be enabled by default for the organization and the user will need to explicitly enable this. Only 5 authentication connections can be created by an organization. **Required scopes:** Cannot be called via service account.
3724
3736
  *
3725
3737
  * @tags auth-connections, dev-orgs
3726
3738
  * @name DevOrgAuthConnectionsCreate
@@ -3730,7 +3742,7 @@ class Api extends HttpClient {
3730
3742
  */
3731
3743
  this.devOrgAuthConnectionsCreate = (data, params = {}) => this.request(Object.assign({ path: `/dev-orgs.auth-connections.create`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
3732
3744
  /**
3733
- * @description Deletes an authentication connection. Only enterprise connections which are explicitly set up for a Dev organization can be deleted. Default connections can not be deleted using this method. **Required scopes:** - `dev_org:all`
3745
+ * @description Deletes an authentication connection. Only enterprise connections which are explicitly set up for a Dev organization can be deleted. Default connections can not be deleted using this method. **Required scopes:** Cannot be called via service account.
3734
3746
  *
3735
3747
  * @tags auth-connections, dev-orgs
3736
3748
  * @name DevOrgAuthConnectionsDelete
@@ -3740,7 +3752,7 @@ class Api extends HttpClient {
3740
3752
  */
3741
3753
  this.devOrgAuthConnectionsDelete = (data, params = {}) => this.request(Object.assign({ path: `/dev-orgs.auth-connections.delete`, method: 'POST', body: data, secure: true, type: ContentType.Json }, params));
3742
3754
  /**
3743
- * @description Retrieves the details for an authentication connection. **Required scopes:** - `dev_org:read`
3755
+ * @description Retrieves the details for an authentication connection. **Required scopes:** - `Cannot be called via service account.`
3744
3756
  *
3745
3757
  * @tags auth-connections, dev-orgs
3746
3758
  * @name DevOrgAuthConnectionsGet
@@ -3750,7 +3762,7 @@ class Api extends HttpClient {
3750
3762
  */
3751
3763
  this.devOrgAuthConnectionsGet = (query, params = {}) => this.request(Object.assign({ path: `/dev-orgs.auth-connections.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
3752
3764
  /**
3753
- * @description Retrieves the details for an authentication connection. **Required scopes:** - `dev_org:read`
3765
+ * @description Retrieves the details for an authentication connection. **Required scopes:** - `Cannot be called via service account.`
3754
3766
  *
3755
3767
  * @tags auth-connections, dev-orgs
3756
3768
  * @name DevOrgAuthConnectionsGetPost
@@ -3760,7 +3772,7 @@ class Api extends HttpClient {
3760
3772
  */
3761
3773
  this.devOrgAuthConnectionsGetPost = (data, params = {}) => this.request(Object.assign({ path: `/dev-orgs.auth-connections.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
3762
3774
  /**
3763
- * @description Lists all the authentication connections available for a Dev organization. This list will include both social and enterprise connections which are either available by default or are explicitly created by the user. **Required scopes:** - `dev_org:read`
3775
+ * @description Lists all the authentication connections available for a Dev organization. This list will include both social and enterprise connections which are either available by default or are explicitly created by the user. **Required scopes:** Cannot be called via service account.
3764
3776
  *
3765
3777
  * @tags auth-connections, dev-orgs
3766
3778
  * @name DevOrgAuthConnectionsList
@@ -3770,7 +3782,7 @@ class Api extends HttpClient {
3770
3782
  */
3771
3783
  this.devOrgAuthConnectionsList = (params = {}) => this.request(Object.assign({ path: `/dev-orgs.auth-connections.list`, method: 'GET', secure: true, format: 'json' }, params));
3772
3784
  /**
3773
- * @description Lists all the authentication connections available for a Dev organization. This list will include both social and enterprise connections which are either available by default or are explicitly created by the user. **Required scopes:** - `dev_org:read`
3785
+ * @description Lists all the authentication connections available for a Dev organization. This list will include both social and enterprise connections which are either available by default or are explicitly created by the user. **Required scopes:** Cannot be called via service account.
3774
3786
  *
3775
3787
  * @tags auth-connections, dev-orgs
3776
3788
  * @name DevOrgAuthConnectionsListPost
@@ -3780,7 +3792,7 @@ class Api extends HttpClient {
3780
3792
  */
3781
3793
  this.devOrgAuthConnectionsListPost = (data, params = {}) => this.request(Object.assign({ path: `/dev-orgs.auth-connections.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
3782
3794
  /**
3783
- * @description Enable or disable an authentication connection for a Dev organization. Atleast one authentication connection must be enabled for a Dev organization. **Required scopes:** - `dev_org:write`
3795
+ * @description Enable or disable an authentication connection for a Dev organization. Atleast one authentication connection must be enabled for a Dev organization. **Required scopes:** Cannot be called via service account.
3784
3796
  *
3785
3797
  * @tags auth-connections, dev-orgs
3786
3798
  * @name DevOrgAuthConnectionsToggle
@@ -3790,7 +3802,7 @@ class Api extends HttpClient {
3790
3802
  */
3791
3803
  this.devOrgAuthConnectionsToggle = (data, params = {}) => this.request(Object.assign({ path: `/dev-orgs.auth-connections.toggle`, method: 'POST', body: data, secure: true, type: ContentType.Json }, params));
3792
3804
  /**
3793
- * @description Updates an authentication connection. **Required scopes:** - `dev_org:write`
3805
+ * @description Updates an authentication connection. **Required scopes:** Cannot be called via service account.
3794
3806
  *
3795
3807
  * @tags auth-connections, dev-orgs
3796
3808
  * @name DevOrgAuthConnectionsUpdate
@@ -3800,7 +3812,7 @@ class Api extends HttpClient {
3800
3812
  */
3801
3813
  this.devOrgAuthConnectionsUpdate = (data, params = {}) => this.request(Object.assign({ path: `/dev-orgs.auth-connections.update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
3802
3814
  /**
3803
- * @description Gets the Dev organization's information of the authenticated user. **Required scopes:** - `dev_org:read`
3815
+ * @description Gets the Dev organization's information of the authenticated user. **Required scopes:** - `dev_org:read` OR `dev_org:write`
3804
3816
  *
3805
3817
  * @tags dev-orgs
3806
3818
  * @name DevOrgsGet
@@ -3810,7 +3822,7 @@ class Api extends HttpClient {
3810
3822
  */
3811
3823
  this.devOrgsGet = (params = {}) => this.request(Object.assign({ path: `/dev-orgs.get`, method: 'GET', secure: true, format: 'json' }, params));
3812
3824
  /**
3813
- * @description Gets the Dev organization's information of the authenticated user. **Required scopes:** - `dev_org:read`
3825
+ * @description Gets the Dev organization's information of the authenticated user. **Required scopes:** - `dev_org:read` OR `dev_org:write`
3814
3826
  *
3815
3827
  * @tags dev-orgs
3816
3828
  * @name DevOrgsGetPost
@@ -3820,7 +3832,7 @@ class Api extends HttpClient {
3820
3832
  */
3821
3833
  this.devOrgsGetPost = (data, params = {}) => this.request(Object.assign({ path: `/dev-orgs.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
3822
3834
  /**
3823
- * @description Activates the requested user. **Required scopes:** - `dev_user:write`
3835
+ * @description Activates the requested user. **Required scopes:** - `dev_user:write` OR `dev_user:all`
3824
3836
  *
3825
3837
  * @tags dev-users
3826
3838
  * @name DevUsersActivate
@@ -3830,7 +3842,7 @@ class Api extends HttpClient {
3830
3842
  */
3831
3843
  this.devUsersActivate = (data, params = {}) => this.request(Object.assign({ path: `/dev-users.activate`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
3832
3844
  /**
3833
- * @description Creates a Dev user for a Dev organization. **Required scopes:** - `dev_user:write`
3845
+ * @description Creates a Dev user for a Dev organization. **Required scopes:** - `dev_user:write` OR `dev_user:all`
3834
3846
  *
3835
3847
  * @tags dev-users
3836
3848
  * @name DevUsersCreate
@@ -3850,7 +3862,7 @@ class Api extends HttpClient {
3850
3862
  */
3851
3863
  this.devUsersDeactivate = (data, params = {}) => this.request(Object.assign({ path: `/dev-users.deactivate`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
3852
3864
  /**
3853
- * @description Gets the requested user's information. **Required scopes:** - `dev_user:read`
3865
+ * @description Gets the requested user's information. **Required scopes:** - `dev_user:read` OR `dev_user:write` OR `dev_user:all`
3854
3866
  *
3855
3867
  * @tags dev-users
3856
3868
  * @name DevUsersGet
@@ -3860,7 +3872,7 @@ class Api extends HttpClient {
3860
3872
  */
3861
3873
  this.devUsersGet = (query, params = {}) => this.request(Object.assign({ path: `/dev-users.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
3862
3874
  /**
3863
- * @description Gets the requested user's information. **Required scopes:** - `dev_user:read`
3875
+ * @description Gets the requested user's information. **Required scopes:** - `dev_user:read` OR `dev_user:write` OR `dev_user:all`
3864
3876
  *
3865
3877
  * @tags dev-users
3866
3878
  * @name DevUsersGetPost
@@ -3870,7 +3882,7 @@ class Api extends HttpClient {
3870
3882
  */
3871
3883
  this.devUsersGetPost = (data, params = {}) => this.request(Object.assign({ path: `/dev-users.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
3872
3884
  /**
3873
- * @description Links an external/secondary identity to the Dev user. **Required scopes:** - `dev_user:write`
3885
+ * @description Links an external/secondary identity to the Dev user. **Required scopes:** - `dev_user:write` OR `dev_user:all`
3874
3886
  *
3875
3887
  * @tags dev-users
3876
3888
  * @name DevUsersIdentitiesLink
@@ -3880,7 +3892,7 @@ class Api extends HttpClient {
3880
3892
  */
3881
3893
  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));
3882
3894
  /**
3883
- * @description Unlinks an external/secondary identity from the Dev user. **Required scopes:** - `dev_user:write`
3895
+ * @description Unlinks an external/secondary identity from the Dev user. **Required scopes:** - `dev_user:write` OR `dev_user:all`
3884
3896
  *
3885
3897
  * @tags dev-users
3886
3898
  * @name DevUsersIdentitiesUnlink
@@ -3890,7 +3902,7 @@ class Api extends HttpClient {
3890
3902
  */
3891
3903
  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));
3892
3904
  /**
3893
- * @description Lists users within your organization. **Required scopes:** - `dev_user:read`
3905
+ * @description Lists users within your organization. **Required scopes:** - `dev_user:read` OR `dev_user:write` OR `dev_user:all`
3894
3906
  *
3895
3907
  * @tags dev-users
3896
3908
  * @name DevUsersList
@@ -3900,7 +3912,7 @@ class Api extends HttpClient {
3900
3912
  */
3901
3913
  this.devUsersList = (query, params = {}) => this.request(Object.assign({ path: `/dev-users.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
3902
3914
  /**
3903
- * @description Lists users within your organization. **Required scopes:** - `dev_user:read`
3915
+ * @description Lists users within your organization. **Required scopes:** - `dev_user:read` OR `dev_user:write` OR `dev_user:all`
3904
3916
  *
3905
3917
  * @tags dev-users
3906
3918
  * @name DevUsersListPost
@@ -3920,7 +3932,7 @@ class Api extends HttpClient {
3920
3932
  */
3921
3933
  this.devUsersMerge = (data, params = {}) => this.request(Object.assign({ path: `/dev-users.merge`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
3922
3934
  /**
3923
- * @description Gets the authenticated user's information. **Required scopes:** No scopes required
3935
+ * @description Gets the authenticated user's information. **Required scopes:** Default Scopes unavailable for this API
3924
3936
  *
3925
3937
  * @tags dev-users
3926
3938
  * @name DevUsersSelf
@@ -3930,7 +3942,7 @@ class Api extends HttpClient {
3930
3942
  */
3931
3943
  this.devUsersSelf = (params = {}) => this.request(Object.assign({ path: `/dev-users.self`, method: 'GET', secure: true, format: 'json' }, params));
3932
3944
  /**
3933
- * @description Gets the authenticated user's information. **Required scopes:** No scopes required
3945
+ * @description Gets the authenticated user's information. **Required scopes:** Default Scopes unavailable for this API
3934
3946
  *
3935
3947
  * @tags dev-users
3936
3948
  * @name DevUsersSelfPost
@@ -3940,7 +3952,7 @@ class Api extends HttpClient {
3940
3952
  */
3941
3953
  this.devUsersSelfPost = (data, params = {}) => this.request(Object.assign({ path: `/dev-users.self`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
3942
3954
  /**
3943
- * @description Updates the authenticated user. **Required scopes:** No scopes required
3955
+ * @description Updates the authenticated user. **Required scopes:** Default Scopes unavailable for this API
3944
3956
  *
3945
3957
  * @tags dev-users
3946
3958
  * @name DevUsersSelfUpdate
@@ -3950,7 +3962,7 @@ class Api extends HttpClient {
3950
3962
  */
3951
3963
  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));
3952
3964
  /**
3953
- * @description Updates the user corresponding to the input Id. **Required scopes:** - `dev_user:write`
3965
+ * @description Updates the user corresponding to the input Id. **Required scopes:** - `dev_user:write` OR `dev_user:all`
3954
3966
  *
3955
3967
  * @tags dev-users
3956
3968
  * @name DevUsersUpdate
@@ -3960,7 +3972,7 @@ class Api extends HttpClient {
3960
3972
  */
3961
3973
  this.devUsersUpdate = (data, params = {}) => this.request(Object.assign({ path: `/dev-users.update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
3962
3974
  /**
3963
- * @description Get count of directories matching given filter.
3975
+ * @description Get count of directories matching given filter. **Required scopes:** - `directory:read` OR `directory:write` OR `directory:all`
3964
3976
  *
3965
3977
  * @tags directory
3966
3978
  * @name DirectoriesCount
@@ -3970,7 +3982,7 @@ class Api extends HttpClient {
3970
3982
  */
3971
3983
  this.directoriesCount = (query, params = {}) => this.request(Object.assign({ path: `/directories.count`, method: 'GET', query: query, secure: true, format: 'json' }, params));
3972
3984
  /**
3973
- * @description Get count of directories matching given filter.
3985
+ * @description Get count of directories matching given filter. **Required scopes:** - `directory:read` OR `directory:write` OR `directory:all`
3974
3986
  *
3975
3987
  * @tags directory
3976
3988
  * @name DirectoriesCountPost
@@ -3980,7 +3992,7 @@ class Api extends HttpClient {
3980
3992
  */
3981
3993
  this.directoriesCountPost = (data, params = {}) => this.request(Object.assign({ path: `/directories.count`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
3982
3994
  /**
3983
- * @description Creates a directory for the specified inputs.
3995
+ * @description Creates a directory for the specified inputs. **Required scopes:** - `directory:write` OR `directory:all`
3984
3996
  *
3985
3997
  * @tags directory
3986
3998
  * @name DirectoriesCreate
@@ -3990,7 +4002,7 @@ class Api extends HttpClient {
3990
4002
  */
3991
4003
  this.directoriesCreate = (data, params = {}) => this.request(Object.assign({ path: `/directories.create`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
3992
4004
  /**
3993
- * @description Delete the specified directory.
4005
+ * @description Delete the specified directory. **Required scopes:** - `directory:all`
3994
4006
  *
3995
4007
  * @tags directory
3996
4008
  * @name DirectoriesDelete
@@ -4000,7 +4012,7 @@ class Api extends HttpClient {
4000
4012
  */
4001
4013
  this.directoriesDelete = (data, params = {}) => this.request(Object.assign({ path: `/directories.delete`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
4002
4014
  /**
4003
- * @description Gets the specified directory.
4015
+ * @description Gets the specified directory. **Required scopes:** - `directory:read` OR `directory:write` OR `directory:all`
4004
4016
  *
4005
4017
  * @tags directory
4006
4018
  * @name DirectoriesGet
@@ -4010,7 +4022,7 @@ class Api extends HttpClient {
4010
4022
  */
4011
4023
  this.directoriesGet = (query, params = {}) => this.request(Object.assign({ path: `/directories.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
4012
4024
  /**
4013
- * @description Gets the specified directory.
4025
+ * @description Gets the specified directory. **Required scopes:** - `directory:read` OR `directory:write` OR `directory:all`
4014
4026
  *
4015
4027
  * @tags directory
4016
4028
  * @name DirectoriesGetPost
@@ -4020,7 +4032,7 @@ class Api extends HttpClient {
4020
4032
  */
4021
4033
  this.directoriesGetPost = (data, params = {}) => this.request(Object.assign({ path: `/directories.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
4022
4034
  /**
4023
- * @description Lists directories matching the request.
4035
+ * @description Lists directories matching the request. **Required scopes:** - `directory:read` OR `directory:write` OR `directory:all`
4024
4036
  *
4025
4037
  * @tags directory
4026
4038
  * @name DirectoriesList
@@ -4030,7 +4042,7 @@ class Api extends HttpClient {
4030
4042
  */
4031
4043
  this.directoriesList = (query, params = {}) => this.request(Object.assign({ path: `/directories.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
4032
4044
  /**
4033
- * @description Lists directories matching the request.
4045
+ * @description Lists directories matching the request. **Required scopes:** - `directory:read` OR `directory:write` OR `directory:all`
4034
4046
  *
4035
4047
  * @tags directory
4036
4048
  * @name DirectoriesListPost
@@ -4040,7 +4052,7 @@ class Api extends HttpClient {
4040
4052
  */
4041
4053
  this.directoriesListPost = (data, params = {}) => this.request(Object.assign({ path: `/directories.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
4042
4054
  /**
4043
- * @description Updates the specified directory.
4055
+ * @description Updates the specified directory. **Required scopes:** - `directory:write` OR `directory:all`
4044
4056
  *
4045
4057
  * @tags directory
4046
4058
  * @name DirectoriesUpdate
@@ -4180,7 +4192,7 @@ class Api extends HttpClient {
4180
4192
  */
4181
4193
  this.eventSourcesDeleteScheduledEvent = (data, params = {}) => this.request(Object.assign({ path: `/event-sources.unschedule`, method: 'POST', body: data, secure: true, type: ContentType.Json }, params));
4182
4194
  /**
4183
- * @description Creates a new group. A group is a collection of users. **Required scopes:** - `group:write`
4195
+ * @description Creates a new group. A group is a collection of users. **Required scopes:** - `group:write` OR `group:all`
4184
4196
  *
4185
4197
  * @tags groups
4186
4198
  * @name GroupsCreate
@@ -4190,7 +4202,7 @@ class Api extends HttpClient {
4190
4202
  */
4191
4203
  this.groupsCreate = (data, params = {}) => this.request(Object.assign({ path: `/groups.create`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
4192
4204
  /**
4193
- * @description Gets the requested group. **Required scopes:** - `group:read`
4205
+ * @description Gets the requested group. **Required scopes:** - `group:read` OR `group:write` OR `group:all`
4194
4206
  *
4195
4207
  * @tags groups
4196
4208
  * @name GroupsGet
@@ -4200,7 +4212,7 @@ class Api extends HttpClient {
4200
4212
  */
4201
4213
  this.groupsGet = (query, params = {}) => this.request(Object.assign({ path: `/groups.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
4202
4214
  /**
4203
- * @description Gets the requested group. **Required scopes:** - `group:read`
4215
+ * @description Gets the requested group. **Required scopes:** - `group:read` OR `group:write` OR `group:all`
4204
4216
  *
4205
4217
  * @tags groups
4206
4218
  * @name GroupsGetPost
@@ -4210,7 +4222,7 @@ class Api extends HttpClient {
4210
4222
  */
4211
4223
  this.groupsGetPost = (data, params = {}) => this.request(Object.assign({ path: `/groups.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
4212
4224
  /**
4213
- * @description Lists the available groups. **Required scopes:** - `group:read`
4225
+ * @description Lists the available groups. **Required scopes:** - `group:read` OR `group:write` OR `group:all`
4214
4226
  *
4215
4227
  * @tags groups
4216
4228
  * @name GroupsList
@@ -4220,7 +4232,7 @@ class Api extends HttpClient {
4220
4232
  */
4221
4233
  this.groupsList = (query, params = {}) => this.request(Object.assign({ path: `/groups.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
4222
4234
  /**
4223
- * @description Lists the available groups. **Required scopes:** - `group:read`
4235
+ * @description Lists the available groups. **Required scopes:** - `group:read` OR `group:write` OR `group:all`
4224
4236
  *
4225
4237
  * @tags groups
4226
4238
  * @name GroupsListPost
@@ -4230,7 +4242,7 @@ class Api extends HttpClient {
4230
4242
  */
4231
4243
  this.groupsListPost = (data, params = {}) => this.request(Object.assign({ path: `/groups.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
4232
4244
  /**
4233
- * @description Adds a member to a group. **Required scopes:** - `group_membership:write`
4245
+ * @description Adds a member to a group. **Required scopes:** - `group_membership:all`
4234
4246
  *
4235
4247
  * @tags groups
4236
4248
  * @name GroupMembersAdd
@@ -4260,7 +4272,7 @@ class Api extends HttpClient {
4260
4272
  */
4261
4273
  this.groupMembersCountPost = (data, params = {}) => this.request(Object.assign({ path: `/groups.members.count`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
4262
4274
  /**
4263
- * @description Lists the members in a group. **Required scopes:** - `group_membership:read`
4275
+ * @description Lists the members in a group. **Required scopes:** - `group_membership:read` OR `group_membership:all`
4264
4276
  *
4265
4277
  * @tags groups
4266
4278
  * @name GroupMembersList
@@ -4270,7 +4282,7 @@ class Api extends HttpClient {
4270
4282
  */
4271
4283
  this.groupMembersList = (query, params = {}) => this.request(Object.assign({ path: `/groups.members.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
4272
4284
  /**
4273
- * @description Lists the members in a group. **Required scopes:** - `group_membership:read`
4285
+ * @description Lists the members in a group. **Required scopes:** - `group_membership:read` OR `group_membership:all`
4274
4286
  *
4275
4287
  * @tags groups
4276
4288
  * @name GroupMembersListPost
@@ -4280,7 +4292,7 @@ class Api extends HttpClient {
4280
4292
  */
4281
4293
  this.groupMembersListPost = (data, params = {}) => this.request(Object.assign({ path: `/groups.members.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
4282
4294
  /**
4283
- * @description Removes a member from a group. **Required scopes:** - `group_membership:write`
4295
+ * @description Removes a member from a group. **Required scopes:** - `group_membership:all`
4284
4296
  *
4285
4297
  * @tags groups
4286
4298
  * @name GroupMembersRemove
@@ -4290,7 +4302,7 @@ class Api extends HttpClient {
4290
4302
  */
4291
4303
  this.groupMembersRemove = (data, params = {}) => this.request(Object.assign({ path: `/groups.members.remove`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
4292
4304
  /**
4293
- * @description Updates the requested group. **Required scopes:** - `group:write`
4305
+ * @description Updates the requested group. **Required scopes:** - `group:write` OR `group:all`
4294
4306
  *
4295
4307
  * @tags groups
4296
4308
  * @name GroupsUpdate
@@ -4390,7 +4402,7 @@ class Api extends HttpClient {
4390
4402
  */
4391
4403
  this.incidentsUpdate = (data, params = {}) => this.request(Object.assign({ path: `/incidents.update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
4392
4404
  /**
4393
- * @description Retrieves a job's information.
4405
+ * @description Retrieves a job's information. **Required scopes:** - `job:read`
4394
4406
  *
4395
4407
  * @tags jobs
4396
4408
  * @name GetJob
@@ -4400,7 +4412,7 @@ class Api extends HttpClient {
4400
4412
  */
4401
4413
  this.getJob = (query, params = {}) => this.request(Object.assign({ path: `/jobs.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
4402
4414
  /**
4403
- * @description Retrieves a job's information.
4415
+ * @description Retrieves a job's information. **Required scopes:** - `job:read`
4404
4416
  *
4405
4417
  * @tags jobs
4406
4418
  * @name GetJobPost
@@ -4410,7 +4422,7 @@ class Api extends HttpClient {
4410
4422
  */
4411
4423
  this.getJobPost = (data, params = {}) => this.request(Object.assign({ path: `/jobs.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
4412
4424
  /**
4413
- * @description Gets a list of jobs.
4425
+ * @description Gets a list of jobs. **Required scopes:** - `job:read`
4414
4426
  *
4415
4427
  * @tags jobs
4416
4428
  * @name ListJobs
@@ -4420,7 +4432,7 @@ class Api extends HttpClient {
4420
4432
  */
4421
4433
  this.listJobs = (query, params = {}) => this.request(Object.assign({ path: `/jobs.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
4422
4434
  /**
4423
- * @description Gets a list of jobs.
4435
+ * @description Gets a list of jobs. **Required scopes:** - `job:read`
4424
4436
  *
4425
4437
  * @tags jobs
4426
4438
  * @name ListJobsPost
@@ -4430,7 +4442,7 @@ class Api extends HttpClient {
4430
4442
  */
4431
4443
  this.listJobsPost = (data, params = {}) => this.request(Object.assign({ path: `/jobs.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
4432
4444
  /**
4433
- * @description OAuth2 authorization callback.
4445
+ * @description OAuth2 authorization callback. **Required scopes:** - `keyring:read`
4434
4446
  *
4435
4447
  * @tags keyrings
4436
4448
  * @name KeyringsCreateCallback
@@ -4439,7 +4451,7 @@ class Api extends HttpClient {
4439
4451
  */
4440
4452
  this.keyringsCreateCallback = (query, params = {}) => this.request(Object.assign({ path: `/keyrings.authorize`, method: 'GET', query: query }, params));
4441
4453
  /**
4442
- * @description OAuth2 authorization callback.
4454
+ * @description OAuth2 authorization callback. **Required scopes:** - `keyring:read`
4443
4455
  *
4444
4456
  * @tags keyrings
4445
4457
  * @name KeyringsCreateCallbackPost
@@ -4509,7 +4521,7 @@ class Api extends HttpClient {
4509
4521
  */
4510
4522
  this.customLinkTypeUpdate = (data, params = {}) => this.request(Object.assign({ path: `/link-types.custom.update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
4511
4523
  /**
4512
- * @description Creates a link between two objects to indicate a relationship.
4524
+ * @description Creates a link between two objects to indicate a relationship. **Required scopes:** - `link:write` OR `link:all` Also needs linked objects read access.
4513
4525
  *
4514
4526
  * @tags links
4515
4527
  * @name LinksCreate
@@ -4519,7 +4531,7 @@ class Api extends HttpClient {
4519
4531
  */
4520
4532
  this.linksCreate = (data, params = {}) => this.request(Object.assign({ path: `/links.create`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
4521
4533
  /**
4522
- * @description Deletes a link between two objects. Note that for part hierarchy links (e.g. enhancement to capability), deleting a link may leave an orphan object with no parent. If the intent is to re-parent an object rather than unlink it entirely, use `links.replace` instead, which atomically removes the old link and creates a new one in a single transaction.
4534
+ * @description Deletes a link between two objects. Note that for part hierarchy links (e.g. enhancement to capability), deleting a link may leave an orphan object with no parent. If the intent is to re-parent an object rather than unlink it entirely, use `links.replace` instead, which atomically removes the old link and creates a new one in a single transaction. **Required scopes:** - `link:all` Also needs linked objects read access.
4523
4535
  *
4524
4536
  * @tags links
4525
4537
  * @name LinksDelete
@@ -4529,7 +4541,7 @@ class Api extends HttpClient {
4529
4541
  */
4530
4542
  this.linksDelete = (data, params = {}) => this.request(Object.assign({ path: `/links.delete`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
4531
4543
  /**
4532
- * @description Gets the requested link's information.
4544
+ * @description Gets the requested link's information. **Required scopes:** - `link:read` OR `link:write` OR `link:all`
4533
4545
  *
4534
4546
  * @tags links
4535
4547
  * @name LinksGet
@@ -4539,7 +4551,7 @@ class Api extends HttpClient {
4539
4551
  */
4540
4552
  this.linksGet = (query, params = {}) => this.request(Object.assign({ path: `/links.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
4541
4553
  /**
4542
- * @description Gets the requested link's information.
4554
+ * @description Gets the requested link's information. **Required scopes:** - `link:read` OR `link:write` OR `link:all`
4543
4555
  *
4544
4556
  * @tags links
4545
4557
  * @name LinksGetPost
@@ -4549,7 +4561,7 @@ class Api extends HttpClient {
4549
4561
  */
4550
4562
  this.linksGetPost = (data, params = {}) => this.request(Object.assign({ path: `/links.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
4551
4563
  /**
4552
- * @description Lists the available links.
4564
+ * @description Lists the available links. **Required scopes:** - `link:read` OR `link:write` OR `link:all`
4553
4565
  *
4554
4566
  * @tags links
4555
4567
  * @name LinksList
@@ -4559,7 +4571,7 @@ class Api extends HttpClient {
4559
4571
  */
4560
4572
  this.linksList = (query, params = {}) => this.request(Object.assign({ path: `/links.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
4561
4573
  /**
4562
- * @description Lists the available links.
4574
+ * @description Lists the available links. **Required scopes:** - `link:read` OR `link:write` OR `link:all`
4563
4575
  *
4564
4576
  * @tags links
4565
4577
  * @name LinksListPost
@@ -4569,7 +4581,7 @@ class Api extends HttpClient {
4569
4581
  */
4570
4582
  this.linksListPost = (data, params = {}) => this.request(Object.assign({ path: `/links.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
4571
4583
  /**
4572
- * @description Replaces an existing link with a new one. This is useful when an object must always remain linked to a parent — for example, re-parenting an enhancement under a different capability or product part — because it avoids the intermediate unlinked (orphan) state that would otherwise occur if you deleted the old link and created a new one as two separate steps. The existing link identified by `id` is removed and a new link is created from `source` to `target`. Optionally, a different `link_type` or `custom_link_type` can be specified for the new link. For links between parts using a default (non-custom) link type, the replacement is performed atomically. For all other cases (custom link types or non-part endpoints), the replacement is performed as a non-atomic delete followed by a create; in these cases, the new link must have the same link type (or the same `custom_link_type` DON) as the existing link, and must share at least one of the source or target with the existing link, otherwise the request is rejected.
4584
+ * @description Replaces an existing link with a new one. This is useful when an object must always remain linked to a parent — for example, re-parenting an enhancement under a different capability or product part — because it avoids the intermediate unlinked (orphan) state that would otherwise occur if you deleted the old link and created a new one as two separate steps. The existing link identified by `id` is removed and a new link is created from `source` to `target`. Optionally, a different `link_type` or `custom_link_type` can be specified for the new link. For links between parts using a default (non-custom) link type, the replacement is performed atomically. For all other cases (custom link types or non-part endpoints), the replacement is performed as a non-atomic delete followed by a create; in these cases, the new link must have the same link type (or the same `custom_link_type` DON) as the existing link, and must share at least one of the source or target with the existing link, otherwise the request is rejected. **Required scopes:** - `link:write` OR `link:all` Also needs linked objects read access.
4573
4585
  *
4574
4586
  * @tags links
4575
4587
  * @name LinksReplace
@@ -4609,7 +4621,7 @@ class Api extends HttpClient {
4609
4621
  */
4610
4622
  this.marketplaceItemsInstall = (data, params = {}) => this.request(Object.assign({ path: `/marketplace-items.install`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
4611
4623
  /**
4612
- * @description Counts the meeting records.
4624
+ * @description Counts the meeting records. **Required scopes:** - `meeting:read` OR `meeting:write` OR `meeting:all`
4613
4625
  *
4614
4626
  * @tags meetings
4615
4627
  * @name MeetingsCount
@@ -4619,7 +4631,7 @@ class Api extends HttpClient {
4619
4631
  */
4620
4632
  this.meetingsCount = (query, params = {}) => this.request(Object.assign({ path: `/meetings.count`, method: 'GET', query: query, secure: true, format: 'json' }, params));
4621
4633
  /**
4622
- * @description Counts the meeting records.
4634
+ * @description Counts the meeting records. **Required scopes:** - `meeting:read` OR `meeting:write` OR `meeting:all`
4623
4635
  *
4624
4636
  * @tags meetings
4625
4637
  * @name MeetingsCountPost
@@ -4629,7 +4641,7 @@ class Api extends HttpClient {
4629
4641
  */
4630
4642
  this.meetingsCountPost = (data, params = {}) => this.request(Object.assign({ path: `/meetings.count`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
4631
4643
  /**
4632
- * @description Creates a new meeting record.
4644
+ * @description Creates a new meeting record. **Required scopes:** - `meeting:write` OR `meeting:all`
4633
4645
  *
4634
4646
  * @tags meetings
4635
4647
  * @name MeetingsCreate
@@ -4639,7 +4651,7 @@ class Api extends HttpClient {
4639
4651
  */
4640
4652
  this.meetingsCreate = (data, params = {}) => this.request(Object.assign({ path: `/meetings.create`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
4641
4653
  /**
4642
- * @description Deletes the meeting record.
4654
+ * @description Deletes the meeting record. **Required scopes:** - `meeting:all`
4643
4655
  *
4644
4656
  * @tags meetings
4645
4657
  * @name MeetingsDelete
@@ -4659,7 +4671,7 @@ class Api extends HttpClient {
4659
4671
  */
4660
4672
  this.meetingsExportAsync = (data, params = {}) => this.request(Object.assign({ path: `/meetings.export.async`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
4661
4673
  /**
4662
- * @description Gets the meeting record.
4674
+ * @description Gets the meeting record. **Required scopes:** - `meeting:read` OR `meeting:write` OR `meeting:all`
4663
4675
  *
4664
4676
  * @tags meetings
4665
4677
  * @name MeetingsGet
@@ -4669,7 +4681,7 @@ class Api extends HttpClient {
4669
4681
  */
4670
4682
  this.meetingsGet = (query, params = {}) => this.request(Object.assign({ path: `/meetings.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
4671
4683
  /**
4672
- * @description Gets the meeting record.
4684
+ * @description Gets the meeting record. **Required scopes:** - `meeting:read` OR `meeting:write` OR `meeting:all`
4673
4685
  *
4674
4686
  * @tags meetings
4675
4687
  * @name MeetingsGetPost
@@ -4679,7 +4691,7 @@ class Api extends HttpClient {
4679
4691
  */
4680
4692
  this.meetingsGetPost = (data, params = {}) => this.request(Object.assign({ path: `/meetings.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
4681
4693
  /**
4682
- * @description Lists the meeting records.
4694
+ * @description Lists the meeting records. **Required scopes:** - `meeting:read` OR `meeting:write` OR `meeting:all`
4683
4695
  *
4684
4696
  * @tags meetings
4685
4697
  * @name MeetingsList
@@ -4689,7 +4701,7 @@ class Api extends HttpClient {
4689
4701
  */
4690
4702
  this.meetingsList = (query, params = {}) => this.request(Object.assign({ path: `/meetings.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
4691
4703
  /**
4692
- * @description Lists the meeting records.
4704
+ * @description Lists the meeting records. **Required scopes:** - `meeting:read` OR `meeting:write` OR `meeting:all`
4693
4705
  *
4694
4706
  * @tags meetings
4695
4707
  * @name MeetingsListPost
@@ -4699,7 +4711,7 @@ class Api extends HttpClient {
4699
4711
  */
4700
4712
  this.meetingsListPost = (data, params = {}) => this.request(Object.assign({ path: `/meetings.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
4701
4713
  /**
4702
- * @description Updates the meeting record.
4714
+ * @description Updates the meeting record. **Required scopes:** - `meeting:write` OR `meeting:all`
4703
4715
  *
4704
4716
  * @tags meetings
4705
4717
  * @name MeetingsUpdate
@@ -4709,7 +4721,7 @@ class Api extends HttpClient {
4709
4721
  */
4710
4722
  this.meetingsUpdate = (data, params = {}) => this.request(Object.assign({ path: `/meetings.update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
4711
4723
  /**
4712
- * @description Executes the metric action on the given object.
4724
+ * @description Executes the metric action on the given object. **Required scopes:** No scopes required.
4713
4725
  *
4714
4726
  * @tags slas
4715
4727
  * @name MetricActionExecute
@@ -4719,7 +4731,7 @@ class Api extends HttpClient {
4719
4731
  */
4720
4732
  this.metricActionExecute = (data, params = {}) => this.request(Object.assign({ path: `/metric-action.execute`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
4721
4733
  /**
4722
- * @description Creates a custom metric definition
4734
+ * @description Creates a custom metric definition **Required scopes:** - `metric_definition:write` OR `metric_definition:all`
4723
4735
  *
4724
4736
  * @tags slas
4725
4737
  * @name MetricDefinitionsCreate
@@ -4729,7 +4741,7 @@ class Api extends HttpClient {
4729
4741
  */
4730
4742
  this.metricDefinitionsCreate = (data, params = {}) => this.request(Object.assign({ path: `/metric-definitions.create`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
4731
4743
  /**
4732
- * @description Deletes a custom metric definition
4744
+ * @description Deletes a custom metric definition **Required scopes:** - `metric_definition:all`
4733
4745
  *
4734
4746
  * @tags slas
4735
4747
  * @name MetricDefinitionsDelete
@@ -4739,7 +4751,7 @@ class Api extends HttpClient {
4739
4751
  */
4740
4752
  this.metricDefinitionsDelete = (data, params = {}) => this.request(Object.assign({ path: `/metric-definitions.delete`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
4741
4753
  /**
4742
- * @description Gets a custom metric definition
4754
+ * @description Gets a custom metric definition **Required scopes:** - `metric_definition:read` OR `metric_definition:write` OR `metric_definition:all`
4743
4755
  *
4744
4756
  * @tags slas
4745
4757
  * @name MetricDefinitionsGet
@@ -4749,7 +4761,7 @@ class Api extends HttpClient {
4749
4761
  */
4750
4762
  this.metricDefinitionsGet = (query, params = {}) => this.request(Object.assign({ path: `/metric-definitions.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
4751
4763
  /**
4752
- * @description Gets a custom metric definition
4764
+ * @description Gets a custom metric definition **Required scopes:** - `metric_definition:read` OR `metric_definition:write` OR `metric_definition:all`
4753
4765
  *
4754
4766
  * @tags slas
4755
4767
  * @name MetricDefinitionsGetPost
@@ -4759,7 +4771,7 @@ class Api extends HttpClient {
4759
4771
  */
4760
4772
  this.metricDefinitionsGetPost = (data, params = {}) => this.request(Object.assign({ path: `/metric-definitions.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
4761
4773
  /**
4762
- * @description Lists metric definitions matching a filter.
4774
+ * @description Lists metric definitions matching a filter. **Required scopes:** - `metric_definition:read` OR `metric_definition:write` OR `metric_definition:all`
4763
4775
  *
4764
4776
  * @tags slas
4765
4777
  * @name MetricDefinitionsList
@@ -4769,7 +4781,7 @@ class Api extends HttpClient {
4769
4781
  */
4770
4782
  this.metricDefinitionsList = (query, params = {}) => this.request(Object.assign({ path: `/metric-definitions.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
4771
4783
  /**
4772
- * @description Lists metric definitions matching a filter.
4784
+ * @description Lists metric definitions matching a filter. **Required scopes:** - `metric_definition:read` OR `metric_definition:write` OR `metric_definition:all`
4773
4785
  *
4774
4786
  * @tags slas
4775
4787
  * @name MetricDefinitionsListPost
@@ -4779,7 +4791,7 @@ class Api extends HttpClient {
4779
4791
  */
4780
4792
  this.metricDefinitionsListPost = (data, params = {}) => this.request(Object.assign({ path: `/metric-definitions.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
4781
4793
  /**
4782
- * @description Updates a custom metric definition
4794
+ * @description Updates a custom metric definition **Required scopes:** - `metric_definition:write` OR `metric_definition:all`
4783
4795
  *
4784
4796
  * @tags slas
4785
4797
  * @name MetricDefinitionsUpdate
@@ -4789,7 +4801,7 @@ class Api extends HttpClient {
4789
4801
  */
4790
4802
  this.metricDefinitionsUpdate = (data, params = {}) => this.request(Object.assign({ path: `/metric-definitions.update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
4791
4803
  /**
4792
- * @description Gets a metric tracker.
4804
+ * @description Gets a metric tracker. **Required scopes:** No scopes required.
4793
4805
  *
4794
4806
  * @tags slas
4795
4807
  * @name MetricTrackersGet
@@ -4799,7 +4811,7 @@ class Api extends HttpClient {
4799
4811
  */
4800
4812
  this.metricTrackersGet = (query, params = {}) => this.request(Object.assign({ path: `/metric-trackers.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
4801
4813
  /**
4802
- * @description Gets a metric tracker.
4814
+ * @description Gets a metric tracker. **Required scopes:** No scopes required.
4803
4815
  *
4804
4816
  * @tags slas
4805
4817
  * @name MetricTrackersGetPost
@@ -4849,7 +4861,7 @@ class Api extends HttpClient {
4849
4861
  */
4850
4862
  this.objectsListPost = (data, params = {}) => this.request(Object.assign({ path: `/objects.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
4851
4863
  /**
4852
- * @description Aggregates the sessions data.
4864
+ * @description Aggregates the sessions data. **Required scopes:** No scopes required.
4853
4865
  *
4854
4866
  * @tags observability
4855
4867
  * @name ObservabilitySessionsAggregate
@@ -4859,7 +4871,7 @@ class Api extends HttpClient {
4859
4871
  */
4860
4872
  this.observabilitySessionsAggregate = (data, params = {}) => this.request(Object.assign({ path: `/observability.sessions.aggregate`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
4861
4873
  /**
4862
- * @description Retrieves the recording data for a specific session ID and recording ID. For mobile sessions, requires both session_id and recording_id. For web sessions, requires both session_id and tab_id.
4874
+ * @description Retrieves the recording data for a specific session ID and recording ID. For mobile sessions, requires both session_id and recording_id. For web sessions, requires both session_id and tab_id. **Required scopes:** No scopes required.
4863
4875
  *
4864
4876
  * @tags observability
4865
4877
  * @name ObservabilitySessionsDataGet
@@ -4869,7 +4881,7 @@ class Api extends HttpClient {
4869
4881
  */
4870
4882
  this.observabilitySessionsDataGet = (query, params = {}) => this.request(Object.assign({ path: `/observability.sessions.data.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
4871
4883
  /**
4872
- * @description Retrieves the recording data for a specific session ID and recording ID. For mobile sessions, requires both session_id and recording_id. For web sessions, requires both session_id and tab_id.
4884
+ * @description Retrieves the recording data for a specific session ID and recording ID. For mobile sessions, requires both session_id and recording_id. For web sessions, requires both session_id and tab_id. **Required scopes:** No scopes required.
4873
4885
  *
4874
4886
  * @tags observability
4875
4887
  * @name ObservabilitySessionsDataGetPost
@@ -4879,7 +4891,7 @@ class Api extends HttpClient {
4879
4891
  */
4880
4892
  this.observabilitySessionsDataGetPost = (data, params = {}) => this.request(Object.assign({ path: `/observability.sessions.data.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
4881
4893
  /**
4882
- * @description Retrieves detailed console and network data for debugging.
4894
+ * @description Retrieves detailed console and network data for debugging. **Required scopes:** No scopes required.
4883
4895
  *
4884
4896
  * @tags observability
4885
4897
  * @name ObservabilitySessionsDeveloperInfoGet
@@ -4889,7 +4901,7 @@ class Api extends HttpClient {
4889
4901
  */
4890
4902
  this.observabilitySessionsDeveloperInfoGet = (query, params = {}) => this.request(Object.assign({ path: `/observability.sessions.developer-info.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
4891
4903
  /**
4892
- * @description Retrieves detailed console and network data for debugging.
4904
+ * @description Retrieves detailed console and network data for debugging. **Required scopes:** No scopes required.
4893
4905
  *
4894
4906
  * @tags observability
4895
4907
  * @name ObservabilitySessionsDeveloperInfoGetPost
@@ -4899,7 +4911,7 @@ class Api extends HttpClient {
4899
4911
  */
4900
4912
  this.observabilitySessionsDeveloperInfoGetPost = (data, params = {}) => this.request(Object.assign({ path: `/observability.sessions.developer-info.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
4901
4913
  /**
4902
- * @description Gets a specific session metadata by ID.
4914
+ * @description Gets a specific session metadata by ID. **Required scopes:** No scopes required.
4903
4915
  *
4904
4916
  * @tags observability
4905
4917
  * @name ObservabilitySessionsGet
@@ -4909,7 +4921,7 @@ class Api extends HttpClient {
4909
4921
  */
4910
4922
  this.observabilitySessionsGet = (query, params = {}) => this.request(Object.assign({ path: `/observability.sessions.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
4911
4923
  /**
4912
- * @description Gets a specific session metadata by ID.
4924
+ * @description Gets a specific session metadata by ID. **Required scopes:** No scopes required.
4913
4925
  *
4914
4926
  * @tags observability
4915
4927
  * @name ObservabilitySessionsGetPost
@@ -4919,7 +4931,7 @@ class Api extends HttpClient {
4919
4931
  */
4920
4932
  this.observabilitySessionsGetPost = (data, params = {}) => this.request(Object.assign({ path: `/observability.sessions.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
4921
4933
  /**
4922
- * @description Lists sessions based on filter criteria.
4934
+ * @description Lists sessions based on filter criteria. **Required scopes:** No scopes required.
4923
4935
  *
4924
4936
  * @tags observability
4925
4937
  * @name ObservabilitySessionsList
@@ -4929,7 +4941,7 @@ class Api extends HttpClient {
4929
4941
  */
4930
4942
  this.observabilitySessionsList = (query, params = {}) => this.request(Object.assign({ path: `/observability.sessions.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
4931
4943
  /**
4932
- * @description Lists sessions based on filter criteria.
4944
+ * @description Lists sessions based on filter criteria. **Required scopes:** No scopes required.
4933
4945
  *
4934
4946
  * @tags observability
4935
4947
  * @name ObservabilitySessionsListPost
@@ -4939,7 +4951,7 @@ class Api extends HttpClient {
4939
4951
  */
4940
4952
  this.observabilitySessionsListPost = (data, params = {}) => this.request(Object.assign({ path: `/observability.sessions.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
4941
4953
  /**
4942
- * @description Creates an organization schedule fragment.
4954
+ * @description Creates an organization schedule fragment. **Required scopes:** - `org_schedule_fragment:write` OR `org_schedule_fragment:all`
4943
4955
  *
4944
4956
  * @tags schedules
4945
4957
  * @name OrgScheduleFragmentsCreate
@@ -4949,7 +4961,7 @@ class Api extends HttpClient {
4949
4961
  */
4950
4962
  this.orgScheduleFragmentsCreate = (data, params = {}) => this.request(Object.assign({ path: `/org-schedule-fragments.create`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
4951
4963
  /**
4952
- * @description Gets an organization schedule fragment.
4964
+ * @description Gets an organization schedule fragment. **Required scopes:** - `org_schedule_fragment:read` OR `org_schedule_fragment:write` OR `org_schedule_fragment:all`
4953
4965
  *
4954
4966
  * @tags schedules
4955
4967
  * @name OrgScheduleFragmentsGet
@@ -4959,7 +4971,7 @@ class Api extends HttpClient {
4959
4971
  */
4960
4972
  this.orgScheduleFragmentsGet = (query, params = {}) => this.request(Object.assign({ path: `/org-schedule-fragments.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
4961
4973
  /**
4962
- * @description Gets an organization schedule fragment.
4974
+ * @description Gets an organization schedule fragment. **Required scopes:** - `org_schedule_fragment:read` OR `org_schedule_fragment:write` OR `org_schedule_fragment:all`
4963
4975
  *
4964
4976
  * @tags schedules
4965
4977
  * @name OrgScheduleFragmentsGetPost
@@ -4969,7 +4981,7 @@ class Api extends HttpClient {
4969
4981
  */
4970
4982
  this.orgScheduleFragmentsGetPost = (data, params = {}) => this.request(Object.assign({ path: `/org-schedule-fragments.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
4971
4983
  /**
4972
- * @description Changes stage of an organization schedule fragment.
4984
+ * @description Changes stage of an organization schedule fragment. **Required scopes:** - `org_schedule_fragment:write` OR `org_schedule_fragment:all`
4973
4985
  *
4974
4986
  * @tags schedules
4975
4987
  * @name OrgScheduleFragmentsTransition
@@ -4979,7 +4991,7 @@ class Api extends HttpClient {
4979
4991
  */
4980
4992
  this.orgScheduleFragmentsTransition = (data, params = {}) => this.request(Object.assign({ path: `/org-schedule-fragments.transition`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
4981
4993
  /**
4982
- * @description Creates an organization schedule with a default weekly organization schedule and a list of organization schedule fragments.
4994
+ * @description Creates an organization schedule with a default weekly organization schedule and a list of organization schedule fragments. **Required scopes:** - `org_schedule:write` OR `org_schedule:all`
4983
4995
  *
4984
4996
  * @tags schedules
4985
4997
  * @name OrgSchedulesCreate
@@ -4989,7 +5001,7 @@ class Api extends HttpClient {
4989
5001
  */
4990
5002
  this.orgSchedulesCreate = (data, params = {}) => this.request(Object.assign({ path: `/org-schedules.create`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
4991
5003
  /**
4992
- * @description Evaluates an organization's schedule at specified instants.
5004
+ * @description Evaluates an organization's schedule at specified instants. **Required scopes:** - `org_schedule:read` OR `org_schedule:write` OR `org_schedule:all`
4993
5005
  *
4994
5006
  * @tags schedules
4995
5007
  * @name OrgSchedulesEvaluate
@@ -4999,7 +5011,7 @@ class Api extends HttpClient {
4999
5011
  */
5000
5012
  this.orgSchedulesEvaluate = (query, params = {}) => this.request(Object.assign({ path: `/org-schedules.evaluate`, method: 'GET', query: query, secure: true, format: 'json' }, params));
5001
5013
  /**
5002
- * @description Evaluates an organization's schedule at specified instants.
5014
+ * @description Evaluates an organization's schedule at specified instants. **Required scopes:** - `org_schedule:read` OR `org_schedule:write` OR `org_schedule:all`
5003
5015
  *
5004
5016
  * @tags schedules
5005
5017
  * @name OrgSchedulesEvaluatePost
@@ -5009,7 +5021,7 @@ class Api extends HttpClient {
5009
5021
  */
5010
5022
  this.orgSchedulesEvaluatePost = (data, params = {}) => this.request(Object.assign({ path: `/org-schedules.evaluate`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
5011
5023
  /**
5012
- * @description Gets an organization schedule.
5024
+ * @description Gets an organization schedule. **Required scopes:** - `org_schedule:read` OR `org_schedule:write` OR `org_schedule:all`
5013
5025
  *
5014
5026
  * @tags schedules
5015
5027
  * @name OrgSchedulesGet
@@ -5019,7 +5031,7 @@ class Api extends HttpClient {
5019
5031
  */
5020
5032
  this.orgSchedulesGet = (query, params = {}) => this.request(Object.assign({ path: `/org-schedules.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
5021
5033
  /**
5022
- * @description Gets an organization schedule.
5034
+ * @description Gets an organization schedule. **Required scopes:** - `org_schedule:read` OR `org_schedule:write` OR `org_schedule:all`
5023
5035
  *
5024
5036
  * @tags schedules
5025
5037
  * @name OrgSchedulesGetPost
@@ -5029,7 +5041,7 @@ class Api extends HttpClient {
5029
5041
  */
5030
5042
  this.orgSchedulesGetPost = (data, params = {}) => this.request(Object.assign({ path: `/org-schedules.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
5031
5043
  /**
5032
- * @description Gets list of organization schedules.
5044
+ * @description Gets list of organization schedules. **Required scopes:** - `org_schedule:read` OR `org_schedule:write` OR `org_schedule:all`
5033
5045
  *
5034
5046
  * @tags schedules
5035
5047
  * @name OrgSchedulesList
@@ -5039,7 +5051,7 @@ class Api extends HttpClient {
5039
5051
  */
5040
5052
  this.orgSchedulesList = (query, params = {}) => this.request(Object.assign({ path: `/org-schedules.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
5041
5053
  /**
5042
- * @description Gets list of organization schedules.
5054
+ * @description Gets list of organization schedules. **Required scopes:** - `org_schedule:read` OR `org_schedule:write` OR `org_schedule:all`
5043
5055
  *
5044
5056
  * @tags schedules
5045
5057
  * @name OrgSchedulesListPost
@@ -5049,7 +5061,7 @@ class Api extends HttpClient {
5049
5061
  */
5050
5062
  this.orgSchedulesListPost = (data, params = {}) => this.request(Object.assign({ path: `/org-schedules.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
5051
5063
  /**
5052
- * @description Sets next organization schedule fragment which must begin the day the last existing fragment ends.
5064
+ * @description Sets next organization schedule fragment which must begin the day the last existing fragment ends. **Required scopes:** - `org_schedule:write` OR `org_schedule:all`
5053
5065
  *
5054
5066
  * @tags schedules
5055
5067
  * @name OrgSchedulesSetFuture
@@ -5059,7 +5071,7 @@ class Api extends HttpClient {
5059
5071
  */
5060
5072
  this.orgSchedulesSetFuture = (data, params = {}) => this.request(Object.assign({ path: `/org-schedules.set-future`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
5061
5073
  /**
5062
- * @description Publishes or archives an organization schedule.
5074
+ * @description Publishes or archives an organization schedule. **Required scopes:** - `org_schedule:write` OR `org_schedule:all`
5063
5075
  *
5064
5076
  * @tags schedules
5065
5077
  * @name OrgSchedulesTransition
@@ -5069,7 +5081,7 @@ class Api extends HttpClient {
5069
5081
  */
5070
5082
  this.orgSchedulesTransition = (data, params = {}) => this.request(Object.assign({ path: `/org-schedules.transition`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
5071
5083
  /**
5072
- * @description Updates an organization schedule.
5084
+ * @description Updates an organization schedule. **Required scopes:** - `org_schedule:write` OR `org_schedule:all`
5073
5085
  *
5074
5086
  * @tags schedules
5075
5087
  * @name OrgSchedulesUpdate
@@ -5079,7 +5091,7 @@ class Api extends HttpClient {
5079
5091
  */
5080
5092
  this.orgSchedulesUpdate = (data, params = {}) => this.request(Object.assign({ path: `/org-schedules.update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
5081
5093
  /**
5082
- * @description Creates new [part](https://devrev.ai/docs/product/parts).
5094
+ * @description Creates new [part](https://devrev.ai/docs/product/parts). **Required scopes:** Depends on the object type in the `type` field: | type | required scope | |---|---| | capability | `capability:write` OR `capability:all` | | enhancement | `enhancement:write` OR `enhancement:all` | | feature | `feature:write` OR `feature:all` | | product | `product:write` OR `product:all` |
5083
5095
  *
5084
5096
  * @tags parts
5085
5097
  * @name PartsCreate
@@ -5089,7 +5101,7 @@ class Api extends HttpClient {
5089
5101
  */
5090
5102
  this.partsCreate = (data, params = {}) => this.request(Object.assign({ path: `/parts.create`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
5091
5103
  /**
5092
- * @description Deletes a [part](https://devrev.ai/docs/product/parts).
5104
+ * @description Deletes a [part](https://devrev.ai/docs/product/parts). **Required scopes:** Depends on the object type in the `id` field: | type | required scope | |---|---| | capability | `capability:all` | | enhancement | `enhancement:all` | | feature | `feature:all` | | product | `product:all` |
5093
5105
  *
5094
5106
  * @tags parts
5095
5107
  * @name PartsDelete
@@ -5099,7 +5111,7 @@ class Api extends HttpClient {
5099
5111
  */
5100
5112
  this.partsDelete = (data, params = {}) => this.request(Object.assign({ path: `/parts.delete`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
5101
5113
  /**
5102
- * @description Gets a [part's](https://devrev.ai/docs/product/parts) information.
5114
+ * @description Gets a [part's](https://devrev.ai/docs/product/parts) information. **Required scopes:** Depends on the object type in the `id` field: | type | required scope | |---|---| | capability | `capability:read` OR `capability:write` OR `capability:all` | | enhancement | `enhancement:read` OR `enhancement:write` OR `enhancement:all` | | feature | `feature:read` OR `feature:write` OR `feature:all` | | product | `product:read` OR `product:write` OR `product:all` |
5103
5115
  *
5104
5116
  * @tags parts
5105
5117
  * @name PartsGet
@@ -5109,7 +5121,7 @@ class Api extends HttpClient {
5109
5121
  */
5110
5122
  this.partsGet = (query, params = {}) => this.request(Object.assign({ path: `/parts.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
5111
5123
  /**
5112
- * @description Gets a [part's](https://devrev.ai/docs/product/parts) information.
5124
+ * @description Gets a [part's](https://devrev.ai/docs/product/parts) information. **Required scopes:** Depends on the object type in the `id` field: | type | required scope | |---|---| | capability | `capability:read` OR `capability:write` OR `capability:all` | | enhancement | `enhancement:read` OR `enhancement:write` OR `enhancement:all` | | feature | `feature:read` OR `feature:write` OR `feature:all` | | product | `product:read` OR `product:write` OR `product:all` |
5113
5125
  *
5114
5126
  * @tags parts
5115
5127
  * @name PartsGetPost
@@ -5119,7 +5131,7 @@ class Api extends HttpClient {
5119
5131
  */
5120
5132
  this.partsGetPost = (data, params = {}) => this.request(Object.assign({ path: `/parts.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
5121
5133
  /**
5122
- * @description Lists a collection of [parts](https://devrev.ai/docs/product/parts).
5134
+ * @description Lists a collection of [parts](https://devrev.ai/docs/product/parts). **Required scopes:** Depends on the object type in the `id` field: | type | required scope | |---|---| | capability | `capability:read` OR `capability:write` OR `capability:all` | | enhancement | `enhancement:read` OR `enhancement:write` OR `enhancement:all` | | feature | `feature:read` OR `feature:write` OR `feature:all` | | product | `product:read` OR `product:write` OR `product:all` |
5123
5135
  *
5124
5136
  * @tags parts
5125
5137
  * @name PartsList
@@ -5129,7 +5141,7 @@ class Api extends HttpClient {
5129
5141
  */
5130
5142
  this.partsList = (query, params = {}) => this.request(Object.assign({ path: `/parts.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
5131
5143
  /**
5132
- * @description Lists a collection of [parts](https://devrev.ai/docs/product/parts).
5144
+ * @description Lists a collection of [parts](https://devrev.ai/docs/product/parts). **Required scopes:** Depends on the object type in the `id` field: | type | required scope | |---|---| | capability | `capability:read` OR `capability:write` OR `capability:all` | | enhancement | `enhancement:read` OR `enhancement:write` OR `enhancement:all` | | feature | `feature:read` OR `feature:write` OR `feature:all` | | product | `product:read` OR `product:write` OR `product:all` |
5133
5145
  *
5134
5146
  * @tags parts
5135
5147
  * @name PartsListPost
@@ -5139,7 +5151,7 @@ class Api extends HttpClient {
5139
5151
  */
5140
5152
  this.partsListPost = (data, params = {}) => this.request(Object.assign({ path: `/parts.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
5141
5153
  /**
5142
- * @description Updates a [part's](https://devrev.ai/docs/product/parts) information.
5154
+ * @description Updates a [part's](https://devrev.ai/docs/product/parts) information. **Required scopes:** Depends on the object type in the `type` field: | type | required scope | |---|---| | capability | `capability:write` OR `capability:all` | | enhancement | `enhancement:write` OR `enhancement:all` | | feature | `feature:write` OR `feature:all` | | product | `product:write` OR `product:all` |
5143
5155
  *
5144
5156
  * @tags parts
5145
5157
  * @name PartsUpdate
@@ -5267,7 +5279,7 @@ class Api extends HttpClient {
5267
5279
  */
5268
5280
  this.updateQuestionAnswer = (data, params = {}) => this.request(Object.assign({ path: `/question-answers.update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
5269
5281
  /**
5270
- * @description Lists the reactors for an object.
5282
+ * @description Lists the reactors for an object. **Required scopes:** Requires the read or write scope of the parent object's type (e.g. issue:write when posting to an issue's timeline).
5271
5283
  *
5272
5284
  * @tags timeline-entries, works
5273
5285
  * @name ReactionsList
@@ -5277,7 +5289,7 @@ class Api extends HttpClient {
5277
5289
  */
5278
5290
  this.reactionsList = (query, params = {}) => this.request(Object.assign({ path: `/reactions.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
5279
5291
  /**
5280
- * @description Lists the reactors for an object.
5292
+ * @description Lists the reactors for an object. **Required scopes:** Requires the read or write scope of the parent object's type (e.g. issue:write when posting to an issue's timeline).
5281
5293
  *
5282
5294
  * @tags timeline-entries, works
5283
5295
  * @name ReactionsListPost
@@ -5287,7 +5299,7 @@ class Api extends HttpClient {
5287
5299
  */
5288
5300
  this.reactionsListPost = (data, params = {}) => this.request(Object.assign({ path: `/reactions.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
5289
5301
  /**
5290
- * @description Updates a reaction for an object.
5302
+ * @description Updates a reaction for an object. **Required scopes:** Requires the read or write scope of the parent object's type (e.g. issue:write when posting to an issue's timeline).
5291
5303
  *
5292
5304
  * @tags timeline-entries, works
5293
5305
  * @name ReactionsUpdate
@@ -5337,7 +5349,7 @@ class Api extends HttpClient {
5337
5349
  */
5338
5350
  this.recordTemplateGetPost = (data, params = {}) => this.request(Object.assign({ path: `/record-templates.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
5339
5351
  /**
5340
- * @description Creates a Rev organization in the authenticated user's Dev organization. **Required scopes:** - `rev_org:write`
5352
+ * @description Creates a Rev organization in the authenticated user's Dev organization. **Required scopes:** - `rev_org:write` OR `rev_org:all`
5341
5353
  *
5342
5354
  * @tags rev-orgs
5343
5355
  * @name RevOrgsCreate
@@ -5357,7 +5369,7 @@ class Api extends HttpClient {
5357
5369
  */
5358
5370
  this.revOrgsDelete = (data, params = {}) => this.request(Object.assign({ path: `/rev-orgs.delete`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
5359
5371
  /**
5360
- * @description Retrieves the Rev organization's information. **Required scopes:** - `rev_org:read`
5372
+ * @description Retrieves the Rev organization's information. **Required scopes:** - `rev_org:read` OR `rev_org:write` OR `rev_org:all`
5361
5373
  *
5362
5374
  * @tags rev-orgs
5363
5375
  * @name RevOrgsGet
@@ -5367,7 +5379,7 @@ class Api extends HttpClient {
5367
5379
  */
5368
5380
  this.revOrgsGet = (query, params = {}) => this.request(Object.assign({ path: `/rev-orgs.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
5369
5381
  /**
5370
- * @description Retrieves the Rev organization's information. **Required scopes:** - `rev_org:read`
5382
+ * @description Retrieves the Rev organization's information. **Required scopes:** - `rev_org:read` OR `rev_org:write` OR `rev_org:all`
5371
5383
  *
5372
5384
  * @tags rev-orgs
5373
5385
  * @name RevOrgsGetPost
@@ -5377,7 +5389,7 @@ class Api extends HttpClient {
5377
5389
  */
5378
5390
  this.revOrgsGetPost = (data, params = {}) => this.request(Object.assign({ path: `/rev-orgs.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
5379
5391
  /**
5380
- * @description Gets the list of Rev organizations' information belonging to the authenticated user's Dev Organization which the user is also authorized to access. **Required scopes:** - `rev_org:read`
5392
+ * @description Gets the list of Rev organizations' information belonging to the authenticated user's Dev Organization which the user is also authorized to access. **Required scopes:** - `rev_org:read` OR `rev_org:write` OR `rev_org:all`
5381
5393
  *
5382
5394
  * @tags rev-orgs
5383
5395
  * @name RevOrgsList
@@ -5387,7 +5399,7 @@ class Api extends HttpClient {
5387
5399
  */
5388
5400
  this.revOrgsList = (query, params = {}) => this.request(Object.assign({ path: `/rev-orgs.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
5389
5401
  /**
5390
- * @description Gets the list of Rev organizations' information belonging to the authenticated user's Dev Organization which the user is also authorized to access. **Required scopes:** - `rev_org:read`
5402
+ * @description Gets the list of Rev organizations' information belonging to the authenticated user's Dev Organization which the user is also authorized to access. **Required scopes:** - `rev_org:read` OR `rev_org:write` OR `rev_org:all`
5391
5403
  *
5392
5404
  * @tags rev-orgs
5393
5405
  * @name RevOrgsListPost
@@ -5397,7 +5409,7 @@ class Api extends HttpClient {
5397
5409
  */
5398
5410
  this.revOrgsListPost = (data, params = {}) => this.request(Object.assign({ path: `/rev-orgs.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
5399
5411
  /**
5400
- * @description Updates the Rev organization's information. **Required scopes:** - `rev_org:write`
5412
+ * @description Updates the Rev organization's information. **Required scopes:** - `rev_org:write` OR `rev_org:all`
5401
5413
  *
5402
5414
  * @tags rev-orgs
5403
5415
  * @name RevOrgsUpdate
@@ -5447,7 +5459,7 @@ class Api extends HttpClient {
5447
5459
  */
5448
5460
  this.revUsersAssociationsRemove = (data, params = {}) => this.request(Object.assign({ path: `/rev-users.associations.remove`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
5449
5461
  /**
5450
- * @description Creates a Rev user for a Rev organization. Rev user can be a customer or a lead of an organization. **Required scopes:** - `rev_user:write`
5462
+ * @description Creates a Rev user for a Rev organization. Rev user can be a customer or a lead of an organization. **Required scopes:** - `rev_user:write` OR `rev_user:all`
5451
5463
  *
5452
5464
  * @tags rev-users
5453
5465
  * @name RevUsersCreate
@@ -5477,7 +5489,7 @@ class Api extends HttpClient {
5477
5489
  */
5478
5490
  this.deleteRevUsersPersonalData = (data, params = {}) => this.request(Object.assign({ path: `/rev-users.delete-personal-data`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
5479
5491
  /**
5480
- * @description Returns the Rev user of a Rev organization by its ID. **Required scopes:** - `rev_user:read`
5492
+ * @description Returns the Rev user of a Rev organization by its ID. **Required scopes:** - `rev_user:read` OR `rev_user:write` OR `rev_user:all`
5481
5493
  *
5482
5494
  * @tags rev-users
5483
5495
  * @name RevUsersGet
@@ -5487,7 +5499,7 @@ class Api extends HttpClient {
5487
5499
  */
5488
5500
  this.revUsersGet = (query, params = {}) => this.request(Object.assign({ path: `/rev-users.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
5489
5501
  /**
5490
- * @description Returns the Rev user of a Rev organization by its ID. **Required scopes:** - `rev_user:read`
5502
+ * @description Returns the Rev user of a Rev organization by its ID. **Required scopes:** - `rev_user:read` OR `rev_user:write` OR `rev_user:all`
5491
5503
  *
5492
5504
  * @tags rev-users
5493
5505
  * @name RevUsersGetPost
@@ -5508,7 +5520,7 @@ class Api extends HttpClient {
5508
5520
  */
5509
5521
  this.linkRevUserToRevOrg = (data, params = {}) => this.request(Object.assign({ path: `/rev-users.link`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
5510
5522
  /**
5511
- * @description Returns a list of all Rev Users belonging to the authenticated user's Dev organization. **Required scopes:** - `rev_user:read`
5523
+ * @description Returns a list of all Rev Users belonging to the authenticated user's Dev organization. **Required scopes:** - `rev_user:read` OR `rev_user:write` OR `rev_user:all`
5512
5524
  *
5513
5525
  * @tags rev-users
5514
5526
  * @name RevUsersList
@@ -5518,7 +5530,7 @@ class Api extends HttpClient {
5518
5530
  */
5519
5531
  this.revUsersList = (query, params = {}) => this.request(Object.assign({ path: `/rev-users.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
5520
5532
  /**
5521
- * @description Returns a list of all Rev Users belonging to the authenticated user's Dev organization. **Required scopes:** - `rev_user:read`
5533
+ * @description Returns a list of all Rev Users belonging to the authenticated user's Dev organization. **Required scopes:** - `rev_user:read` OR `rev_user:write` OR `rev_user:all`
5522
5534
  *
5523
5535
  * @tags rev-users
5524
5536
  * @name RevUsersListPost
@@ -5548,7 +5560,7 @@ class Api extends HttpClient {
5548
5560
  */
5549
5561
  this.getRevUsersPersonalData = (data, params = {}) => this.request(Object.assign({ path: `/rev-users.personal-data`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
5550
5562
  /**
5551
- * @description Scans through all Rev users. **Required scopes:** - `rev_user:read`
5563
+ * @description Scans through all Rev users. **Required scopes:** - `rev_user:read` OR `rev_user:write` OR `rev_user:all`
5552
5564
  *
5553
5565
  * @tags rev-users
5554
5566
  * @name RevUsersScan
@@ -5558,7 +5570,7 @@ class Api extends HttpClient {
5558
5570
  */
5559
5571
  this.revUsersScan = (query, params = {}) => this.request(Object.assign({ path: `/rev-users.scan`, method: 'GET', query: query, secure: true, format: 'json' }, params));
5560
5572
  /**
5561
- * @description Scans through all Rev users. **Required scopes:** - `rev_user:read`
5573
+ * @description Scans through all Rev users. **Required scopes:** - `rev_user:read` OR `rev_user:write` OR `rev_user:all`
5562
5574
  *
5563
5575
  * @tags rev-users
5564
5576
  * @name RevUsersScanPost
@@ -5579,7 +5591,7 @@ class Api extends HttpClient {
5579
5591
  */
5580
5592
  this.unlinkRevUserFromRevOrg = (data, params = {}) => this.request(Object.assign({ path: `/rev-users.unlink`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
5581
5593
  /**
5582
- * @description Updates a Rev user. **Required scopes:** - `rev_user:write`
5594
+ * @description Updates a Rev user. **Required scopes:** - `rev_user:write` OR `rev_user:all`
5583
5595
  *
5584
5596
  * @tags rev-users
5585
5597
  * @name RevUsersUpdate
@@ -5610,7 +5622,7 @@ class Api extends HttpClient {
5610
5622
  */
5611
5623
  this.rolesCreate = (data, params = {}) => this.request(Object.assign({ path: `/roles.create`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
5612
5624
  /**
5613
- * @description Gets the aggregated schema.
5625
+ * @description Gets the aggregated schema. **Required scopes:** No scopes required.
5614
5626
  *
5615
5627
  * @tags customization
5616
5628
  * @name AggregatedSchemaGet
@@ -5620,7 +5632,7 @@ class Api extends HttpClient {
5620
5632
  */
5621
5633
  this.aggregatedSchemaGet = (query, params = {}) => this.request(Object.assign({ path: `/schemas.aggregated.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
5622
5634
  /**
5623
- * @description Gets the aggregated schema.
5635
+ * @description Gets the aggregated schema. **Required scopes:** No scopes required.
5624
5636
  *
5625
5637
  * @tags customization
5626
5638
  * @name AggregatedSchemaGetPost
@@ -5630,7 +5642,7 @@ class Api extends HttpClient {
5630
5642
  */
5631
5643
  this.aggregatedSchemaGetPost = (data, params = {}) => this.request(Object.assign({ path: `/schemas.aggregated.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
5632
5644
  /**
5633
- * @description Gets a custom schema fragment.
5645
+ * @description Gets a custom schema fragment. **Required scopes:** No scopes required.
5634
5646
  *
5635
5647
  * @tags customization
5636
5648
  * @name CustomSchemaFragmentsGet
@@ -5640,7 +5652,7 @@ class Api extends HttpClient {
5640
5652
  */
5641
5653
  this.customSchemaFragmentsGet = (query, params = {}) => this.request(Object.assign({ path: `/schemas.custom.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
5642
5654
  /**
5643
- * @description Gets a custom schema fragment.
5655
+ * @description Gets a custom schema fragment. **Required scopes:** No scopes required.
5644
5656
  *
5645
5657
  * @tags customization
5646
5658
  * @name CustomSchemaFragmentsGetPost
@@ -5650,7 +5662,7 @@ class Api extends HttpClient {
5650
5662
  */
5651
5663
  this.customSchemaFragmentsGetPost = (data, params = {}) => this.request(Object.assign({ path: `/schemas.custom.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
5652
5664
  /**
5653
- * @description Lists custom schema fragments.
5665
+ * @description Lists custom schema fragments. **Required scopes:** No scopes required.
5654
5666
  *
5655
5667
  * @tags customization
5656
5668
  * @name CustomSchemaFragmentsList
@@ -5660,7 +5672,7 @@ class Api extends HttpClient {
5660
5672
  */
5661
5673
  this.customSchemaFragmentsList = (query, params = {}) => this.request(Object.assign({ path: `/schemas.custom.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
5662
5674
  /**
5663
- * @description Lists custom schema fragments.
5675
+ * @description Lists custom schema fragments. **Required scopes:** No scopes required.
5664
5676
  *
5665
5677
  * @tags customization
5666
5678
  * @name CustomSchemaFragmentsListPost
@@ -5670,7 +5682,7 @@ class Api extends HttpClient {
5670
5682
  */
5671
5683
  this.customSchemaFragmentsListPost = (data, params = {}) => this.request(Object.assign({ path: `/schemas.custom.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
5672
5684
  /**
5673
- * @description Creates or updates a custom schema fragment.
5685
+ * @description Creates or updates a custom schema fragment. **Required scopes:** - `custom_type_fragment:write`
5674
5686
  *
5675
5687
  * @tags customization
5676
5688
  * @name CustomSchemaFragmentsSet
@@ -5680,7 +5692,7 @@ class Api extends HttpClient {
5680
5692
  */
5681
5693
  this.customSchemaFragmentsSet = (data, params = {}) => this.request(Object.assign({ path: `/schemas.custom.set`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
5682
5694
  /**
5683
- * @description Gets a stock schema fragment.
5695
+ * @description Gets a stock schema fragment. **Required scopes:** No scopes required.
5684
5696
  *
5685
5697
  * @tags customization
5686
5698
  * @name StockSchemaFragmentsGet
@@ -5690,7 +5702,7 @@ class Api extends HttpClient {
5690
5702
  */
5691
5703
  this.stockSchemaFragmentsGet = (query, params = {}) => this.request(Object.assign({ path: `/schemas.stock.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
5692
5704
  /**
5693
- * @description Gets a stock schema fragment.
5705
+ * @description Gets a stock schema fragment. **Required scopes:** No scopes required.
5694
5706
  *
5695
5707
  * @tags customization
5696
5708
  * @name StockSchemaFragmentsGetPost
@@ -5700,7 +5712,7 @@ class Api extends HttpClient {
5700
5712
  */
5701
5713
  this.stockSchemaFragmentsGetPost = (data, params = {}) => this.request(Object.assign({ path: `/schemas.stock.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
5702
5714
  /**
5703
- * @description Lists stock schema fragments.
5715
+ * @description Lists stock schema fragments. **Required scopes:** No scopes required.
5704
5716
  *
5705
5717
  * @tags customization
5706
5718
  * @name StockSchemaFragmentsList
@@ -5710,7 +5722,7 @@ class Api extends HttpClient {
5710
5722
  */
5711
5723
  this.stockSchemaFragmentsList = (query, params = {}) => this.request(Object.assign({ path: `/schemas.stock.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
5712
5724
  /**
5713
- * @description Lists stock schema fragments.
5725
+ * @description Lists stock schema fragments. **Required scopes:** No scopes required.
5714
5726
  *
5715
5727
  * @tags customization
5716
5728
  * @name StockSchemaFragmentsListPost
@@ -5740,7 +5752,7 @@ class Api extends HttpClient {
5740
5752
  */
5741
5753
  this.subtypesListPost = (data, params = {}) => this.request(Object.assign({ path: `/schemas.subtypes.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
5742
5754
  /**
5743
- * @description Gets the new fragment IDs and fields resulting from changing a subtype.
5755
+ * @description Gets the new fragment IDs and fields resulting from changing a subtype. **Required scopes:** - `custom_type_fragment:write`
5744
5756
  *
5745
5757
  * @tags customization
5746
5758
  * @name SchemasSubtypePrepareUpdateGet
@@ -5790,7 +5802,7 @@ class Api extends HttpClient {
5790
5802
  */
5791
5803
  this.searchHybridPost = (data, params = {}) => this.request(Object.assign({ path: `/search.hybrid`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
5792
5804
  /**
5793
- * @description Creates a service account.
5805
+ * @description Creates a service account. **Required scopes:** Not accessible via service account tokens. Requires user authentication.
5794
5806
  *
5795
5807
  * @tags service-accounts
5796
5808
  * @name ServiceAccountsCreate
@@ -5800,7 +5812,7 @@ class Api extends HttpClient {
5800
5812
  */
5801
5813
  this.serviceAccountsCreate = (data, params = {}) => this.request(Object.assign({ path: `/service-accounts.create`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
5802
5814
  /**
5803
- * @description Gets a service account.
5815
+ * @description Gets a service account. **Required scopes:** - `svcacc:read`
5804
5816
  *
5805
5817
  * @tags service-accounts
5806
5818
  * @name ServiceAccountsGet
@@ -5810,7 +5822,7 @@ class Api extends HttpClient {
5810
5822
  */
5811
5823
  this.serviceAccountsGet = (query, params = {}) => this.request(Object.assign({ path: `/service-accounts.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
5812
5824
  /**
5813
- * @description Gets a service account.
5825
+ * @description Gets a service account. **Required scopes:** - `svcacc:read`
5814
5826
  *
5815
5827
  * @tags service-accounts
5816
5828
  * @name ServiceAccountsGetPost
@@ -5830,7 +5842,7 @@ class Api extends HttpClient {
5830
5842
  */
5831
5843
  this.serviceAccountsUpdate = (data, params = {}) => this.request(Object.assign({ path: `/service-accounts.update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
5832
5844
  /**
5833
- * @description Gets an SLA tracker.
5845
+ * @description Gets an SLA tracker. **Required scopes:** No scopes required.
5834
5846
  *
5835
5847
  * @tags slas
5836
5848
  * @name SlaTrackersGet
@@ -5840,7 +5852,7 @@ class Api extends HttpClient {
5840
5852
  */
5841
5853
  this.slaTrackersGet = (query, params = {}) => this.request(Object.assign({ path: `/sla-trackers.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
5842
5854
  /**
5843
- * @description Gets an SLA tracker.
5855
+ * @description Gets an SLA tracker. **Required scopes:** No scopes required.
5844
5856
  *
5845
5857
  * @tags slas
5846
5858
  * @name SlaTrackersGetPost
@@ -5850,7 +5862,7 @@ class Api extends HttpClient {
5850
5862
  */
5851
5863
  this.slaTrackersGetPost = (data, params = {}) => this.request(Object.assign({ path: `/sla-trackers.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
5852
5864
  /**
5853
- * @description Lists SLA trackers matching a filter.
5865
+ * @description Lists SLA trackers matching a filter. **Required scopes:** No scopes required.
5854
5866
  *
5855
5867
  * @tags slas
5856
5868
  * @name SlaTrackersList
@@ -5860,7 +5872,7 @@ class Api extends HttpClient {
5860
5872
  */
5861
5873
  this.slaTrackersList = (query, params = {}) => this.request(Object.assign({ path: `/sla-trackers.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
5862
5874
  /**
5863
- * @description Lists SLA trackers matching a filter.
5875
+ * @description Lists SLA trackers matching a filter. **Required scopes:** No scopes required.
5864
5876
  *
5865
5877
  * @tags slas
5866
5878
  * @name SlaTrackersListPost
@@ -5880,7 +5892,7 @@ class Api extends HttpClient {
5880
5892
  */
5881
5893
  this.slaTrackersRemoveMetric = (data, params = {}) => this.request(Object.assign({ path: `/sla-trackers.remove-metric`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
5882
5894
  /**
5883
- * @description Assigns the SLA to a set of Rev organizations.
5895
+ * @description Assigns the SLA to a set of Rev organizations. **Required scopes:** - `sla:write`
5884
5896
  *
5885
5897
  * @tags slas
5886
5898
  * @name SlasAssign
@@ -5890,7 +5902,7 @@ class Api extends HttpClient {
5890
5902
  */
5891
5903
  this.slasAssign = (data, params = {}) => this.request(Object.assign({ path: `/slas.assign`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
5892
5904
  /**
5893
- * @description Creates an SLA in draft status.
5905
+ * @description Creates an SLA in draft status. **Required scopes:** - `sla:write`
5894
5906
  *
5895
5907
  * @tags slas
5896
5908
  * @name SlasCreate
@@ -5900,7 +5912,7 @@ class Api extends HttpClient {
5900
5912
  */
5901
5913
  this.slasCreate = (data, params = {}) => this.request(Object.assign({ path: `/slas.create`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
5902
5914
  /**
5903
- * @description Gets an SLA.
5915
+ * @description Gets an SLA. **Required scopes:** - `sla:read` OR `sla:write`
5904
5916
  *
5905
5917
  * @tags slas
5906
5918
  * @name SlasGet
@@ -5910,7 +5922,7 @@ class Api extends HttpClient {
5910
5922
  */
5911
5923
  this.slasGet = (query, params = {}) => this.request(Object.assign({ path: `/slas.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
5912
5924
  /**
5913
- * @description Gets an SLA.
5925
+ * @description Gets an SLA. **Required scopes:** - `sla:read` OR `sla:write`
5914
5926
  *
5915
5927
  * @tags slas
5916
5928
  * @name SlasGetPost
@@ -5920,7 +5932,7 @@ class Api extends HttpClient {
5920
5932
  */
5921
5933
  this.slasGetPost = (data, params = {}) => this.request(Object.assign({ path: `/slas.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
5922
5934
  /**
5923
- * @description Lists SLAs matching a filter.
5935
+ * @description Lists SLAs matching a filter. **Required scopes:** - `sla:read` OR `sla:write`
5924
5936
  *
5925
5937
  * @tags slas
5926
5938
  * @name SlasList
@@ -5930,7 +5942,7 @@ class Api extends HttpClient {
5930
5942
  */
5931
5943
  this.slasList = (query, params = {}) => this.request(Object.assign({ path: `/slas.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
5932
5944
  /**
5933
- * @description Lists SLAs matching a filter.
5945
+ * @description Lists SLAs matching a filter. **Required scopes:** - `sla:read` OR `sla:write`
5934
5946
  *
5935
5947
  * @tags slas
5936
5948
  * @name SlasListPost
@@ -5940,7 +5952,7 @@ class Api extends HttpClient {
5940
5952
  */
5941
5953
  this.slasListPost = (data, params = {}) => this.request(Object.assign({ path: `/slas.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
5942
5954
  /**
5943
- * @description Changes the status of an SLA.
5955
+ * @description Changes the status of an SLA. **Required scopes:** - `sla:write`
5944
5956
  *
5945
5957
  * @tags slas
5946
5958
  * @name SlasTransition
@@ -5950,7 +5962,7 @@ class Api extends HttpClient {
5950
5962
  */
5951
5963
  this.slasTransition = (data, params = {}) => this.request(Object.assign({ path: `/slas.transition`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
5952
5964
  /**
5953
- * @description Updates a draft SLA.
5965
+ * @description Updates a draft SLA. **Required scopes:** - `sla:write`
5954
5966
  *
5955
5967
  * @tags slas
5956
5968
  * @name SlasUpdate
@@ -6010,7 +6022,7 @@ class Api extends HttpClient {
6010
6022
  */
6011
6023
  this.snapInsUpdate = (data, params = {}) => this.request(Object.assign({ path: `/snap-ins.update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
6012
6024
  /**
6013
- * @description Executes deferred snap-kit actions.
6025
+ * @description Executes deferred snap-kit actions. **Required scopes:** - `snap_widget:write` OR `snap_widget:all`
6014
6026
  *
6015
6027
  * @tags snap-kit-execution
6016
6028
  * @name SnapKitActionExecuteDeferred
@@ -6020,7 +6032,7 @@ class Api extends HttpClient {
6020
6032
  */
6021
6033
  this.snapKitActionExecuteDeferred = (data, params = {}) => this.request(Object.assign({ path: `/snap-kit-action.execute.deferred`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
6022
6034
  /**
6023
- * @description Create a snap widget object.
6035
+ * @description Create a snap widget object. **Required scopes:** - `snap_widget:write` OR `snap_widget:all`
6024
6036
  *
6025
6037
  * @tags snap-widgets
6026
6038
  * @name SnapWidgetsCreate
@@ -6030,7 +6042,7 @@ class Api extends HttpClient {
6030
6042
  */
6031
6043
  this.snapWidgetsCreate = (data, params = {}) => this.request(Object.assign({ path: `/snap-widgets.create`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
6032
6044
  /**
6033
- * @description Creates a stage diagram.
6045
+ * @description Creates a stage diagram. **Required scopes:** - `stage_diagram:write`
6034
6046
  *
6035
6047
  * @tags customization
6036
6048
  * @name StageDiagramsCreate
@@ -6040,7 +6052,7 @@ class Api extends HttpClient {
6040
6052
  */
6041
6053
  this.stageDiagramsCreate = (data, params = {}) => this.request(Object.assign({ path: `/stage-diagrams.create`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
6042
6054
  /**
6043
- * @description Gets a stage diagram.
6055
+ * @description Gets a stage diagram. **Required scopes:** No scopes required.
6044
6056
  *
6045
6057
  * @tags customization
6046
6058
  * @name StageDiagramsGet
@@ -6050,7 +6062,7 @@ class Api extends HttpClient {
6050
6062
  */
6051
6063
  this.stageDiagramsGet = (query, params = {}) => this.request(Object.assign({ path: `/stage-diagrams.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
6052
6064
  /**
6053
- * @description Gets a stage diagram.
6065
+ * @description Gets a stage diagram. **Required scopes:** No scopes required.
6054
6066
  *
6055
6067
  * @tags customization
6056
6068
  * @name StageDiagramsGetPost
@@ -6060,7 +6072,7 @@ class Api extends HttpClient {
6060
6072
  */
6061
6073
  this.stageDiagramsGetPost = (data, params = {}) => this.request(Object.assign({ path: `/stage-diagrams.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
6062
6074
  /**
6063
- * @description Lists stage diagrams.
6075
+ * @description Lists stage diagrams. **Required scopes:** No scopes required.
6064
6076
  *
6065
6077
  * @tags customization
6066
6078
  * @name StageDiagramsList
@@ -6070,7 +6082,7 @@ class Api extends HttpClient {
6070
6082
  */
6071
6083
  this.stageDiagramsList = (query, params = {}) => this.request(Object.assign({ path: `/stage-diagrams.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
6072
6084
  /**
6073
- * @description Lists stage diagrams.
6085
+ * @description Lists stage diagrams. **Required scopes:** No scopes required.
6074
6086
  *
6075
6087
  * @tags customization
6076
6088
  * @name StageDiagramsListPost
@@ -6080,7 +6092,7 @@ class Api extends HttpClient {
6080
6092
  */
6081
6093
  this.stageDiagramsListPost = (data, params = {}) => this.request(Object.assign({ path: `/stage-diagrams.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
6082
6094
  /**
6083
- * @description Updates a stage diagram.
6095
+ * @description Updates a stage diagram. **Required scopes:** - `stage_diagram:write`
6084
6096
  *
6085
6097
  * @tags customization
6086
6098
  * @name StageDiagramsUpdate
@@ -6090,7 +6102,7 @@ class Api extends HttpClient {
6090
6102
  */
6091
6103
  this.stageDiagramsUpdate = (data, params = {}) => this.request(Object.assign({ path: `/stage-diagrams.update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
6092
6104
  /**
6093
- * @description Creates a custom stage.
6105
+ * @description Creates a custom stage. **Required scopes:** - `custom_stage:write`
6094
6106
  *
6095
6107
  * @tags customization
6096
6108
  * @name CustomStagesCreate
@@ -6100,7 +6112,7 @@ class Api extends HttpClient {
6100
6112
  */
6101
6113
  this.customStagesCreate = (data, params = {}) => this.request(Object.assign({ path: `/stages.custom.create`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
6102
6114
  /**
6103
- * @description Gets a custom stage.
6115
+ * @description Gets a custom stage. **Required scopes:** No scopes required.
6104
6116
  *
6105
6117
  * @tags customization
6106
6118
  * @name CustomStagesGet
@@ -6110,7 +6122,7 @@ class Api extends HttpClient {
6110
6122
  */
6111
6123
  this.customStagesGet = (query, params = {}) => this.request(Object.assign({ path: `/stages.custom.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
6112
6124
  /**
6113
- * @description Gets a custom stage.
6125
+ * @description Gets a custom stage. **Required scopes:** No scopes required.
6114
6126
  *
6115
6127
  * @tags customization
6116
6128
  * @name CustomStagesGetPost
@@ -6120,7 +6132,7 @@ class Api extends HttpClient {
6120
6132
  */
6121
6133
  this.customStagesGetPost = (data, params = {}) => this.request(Object.assign({ path: `/stages.custom.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
6122
6134
  /**
6123
- * @description Lists custom stages.
6135
+ * @description Lists custom stages. **Required scopes:** No scopes required.
6124
6136
  *
6125
6137
  * @tags customization
6126
6138
  * @name CustomStagesList
@@ -6130,7 +6142,7 @@ class Api extends HttpClient {
6130
6142
  */
6131
6143
  this.customStagesList = (query, params = {}) => this.request(Object.assign({ path: `/stages.custom.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
6132
6144
  /**
6133
- * @description Lists custom stages.
6145
+ * @description Lists custom stages. **Required scopes:** No scopes required.
6134
6146
  *
6135
6147
  * @tags customization
6136
6148
  * @name CustomStagesListPost
@@ -6140,7 +6152,7 @@ class Api extends HttpClient {
6140
6152
  */
6141
6153
  this.customStagesListPost = (data, params = {}) => this.request(Object.assign({ path: `/stages.custom.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
6142
6154
  /**
6143
- * @description Updates a custom stage.
6155
+ * @description Updates a custom stage. **Required scopes:** - `custom_stage:write`
6144
6156
  *
6145
6157
  * @tags customization
6146
6158
  * @name CustomStagesUpdate
@@ -6150,7 +6162,7 @@ class Api extends HttpClient {
6150
6162
  */
6151
6163
  this.customStagesUpdate = (data, params = {}) => this.request(Object.assign({ path: `/stages.custom.update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
6152
6164
  /**
6153
- * @description Creates a custom state.
6165
+ * @description Creates a custom state. **Required scopes:** - `custom_state:write`
6154
6166
  *
6155
6167
  * @tags customization
6156
6168
  * @name CustomStatesCreate
@@ -6160,7 +6172,7 @@ class Api extends HttpClient {
6160
6172
  */
6161
6173
  this.customStatesCreate = (data, params = {}) => this.request(Object.assign({ path: `/states.custom.create`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
6162
6174
  /**
6163
- * @description Gets a custom state.
6175
+ * @description Gets a custom state. **Required scopes:** No scopes required.
6164
6176
  *
6165
6177
  * @tags customization
6166
6178
  * @name CustomStatesGet
@@ -6170,7 +6182,7 @@ class Api extends HttpClient {
6170
6182
  */
6171
6183
  this.customStatesGet = (query, params = {}) => this.request(Object.assign({ path: `/states.custom.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
6172
6184
  /**
6173
- * @description Gets a custom state.
6185
+ * @description Gets a custom state. **Required scopes:** No scopes required.
6174
6186
  *
6175
6187
  * @tags customization
6176
6188
  * @name CustomStatesGetPost
@@ -6180,7 +6192,7 @@ class Api extends HttpClient {
6180
6192
  */
6181
6193
  this.customStatesGetPost = (data, params = {}) => this.request(Object.assign({ path: `/states.custom.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
6182
6194
  /**
6183
- * @description Lists custom states.
6195
+ * @description Lists custom states. **Required scopes:** No scopes required.
6184
6196
  *
6185
6197
  * @tags customization
6186
6198
  * @name CustomStatesList
@@ -6190,7 +6202,7 @@ class Api extends HttpClient {
6190
6202
  */
6191
6203
  this.customStatesList = (query, params = {}) => this.request(Object.assign({ path: `/states.custom.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
6192
6204
  /**
6193
- * @description Lists custom states.
6205
+ * @description Lists custom states. **Required scopes:** No scopes required.
6194
6206
  *
6195
6207
  * @tags customization
6196
6208
  * @name CustomStatesListPost
@@ -6200,7 +6212,7 @@ class Api extends HttpClient {
6200
6212
  */
6201
6213
  this.customStatesListPost = (data, params = {}) => this.request(Object.assign({ path: `/states.custom.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
6202
6214
  /**
6203
- * @description Updates a custom state.
6215
+ * @description Updates a custom state. **Required scopes:** - `custom_state:write`
6204
6216
  *
6205
6217
  * @tags customization
6206
6218
  * @name CustomStatesUpdate
@@ -6260,7 +6272,7 @@ class Api extends HttpClient {
6260
6272
  */
6261
6273
  this.subscribersUpdate = (data, params = {}) => this.request(Object.assign({ path: `/subscribers.update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
6262
6274
  /**
6263
- * @description Creates a schema for survey, which includes name and description of schema.
6275
+ * @description Creates a schema for survey, which includes name and description of schema. **Required scopes:** - `survey:write` OR `survey:all`
6264
6276
  *
6265
6277
  * @tags surveys
6266
6278
  * @name SurveysCreate
@@ -6270,7 +6282,7 @@ class Api extends HttpClient {
6270
6282
  */
6271
6283
  this.surveysCreate = (data, params = {}) => this.request(Object.assign({ path: `/surveys.create`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
6272
6284
  /**
6273
- * @description Deletes the specified survey.
6285
+ * @description Deletes the specified survey. **Required scopes:** - `survey:all`
6274
6286
  *
6275
6287
  * @tags surveys
6276
6288
  * @name SurveysDelete
@@ -6280,7 +6292,7 @@ class Api extends HttpClient {
6280
6292
  */
6281
6293
  this.surveysDelete = (data, params = {}) => this.request(Object.assign({ path: `/surveys.delete`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
6282
6294
  /**
6283
- * @description Gets a survey given the ID.
6295
+ * @description Gets a survey given the ID. **Required scopes:** - `survey:read` OR `survey:write` OR `survey:all`
6284
6296
  *
6285
6297
  * @tags surveys
6286
6298
  * @name SurveysGet
@@ -6290,7 +6302,7 @@ class Api extends HttpClient {
6290
6302
  */
6291
6303
  this.surveysGet = (query, params = {}) => this.request(Object.assign({ path: `/surveys.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
6292
6304
  /**
6293
- * @description Gets a survey given the ID.
6305
+ * @description Gets a survey given the ID. **Required scopes:** - `survey:read` OR `survey:write` OR `survey:all`
6294
6306
  *
6295
6307
  * @tags surveys
6296
6308
  * @name SurveysGetPost
@@ -6300,7 +6312,7 @@ class Api extends HttpClient {
6300
6312
  */
6301
6313
  this.surveysGetPost = (data, params = {}) => this.request(Object.assign({ path: `/surveys.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
6302
6314
  /**
6303
- * @description List surveys requested by the user.
6315
+ * @description List surveys requested by the user. **Required scopes:** - `survey:read` OR `survey:write` OR `survey:all`
6304
6316
  *
6305
6317
  * @tags surveys
6306
6318
  * @name SurveysList
@@ -6310,7 +6322,7 @@ class Api extends HttpClient {
6310
6322
  */
6311
6323
  this.surveysList = (query, params = {}) => this.request(Object.assign({ path: `/surveys.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
6312
6324
  /**
6313
- * @description List surveys requested by the user.
6325
+ * @description List surveys requested by the user. **Required scopes:** - `survey:read` OR `survey:write` OR `survey:all`
6314
6326
  *
6315
6327
  * @tags surveys
6316
6328
  * @name SurveysListPost
@@ -6320,7 +6332,7 @@ class Api extends HttpClient {
6320
6332
  */
6321
6333
  this.surveysListPost = (data, params = {}) => this.request(Object.assign({ path: `/surveys.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
6322
6334
  /**
6323
- * @description List survey responses requested by the user.
6335
+ * @description List survey responses requested by the user. **Required scopes:** - `survey_response:read` OR `survey_response:write` OR `survey_response:all`
6324
6336
  *
6325
6337
  * @tags surveys
6326
6338
  * @name SurveysResponsesList
@@ -6330,7 +6342,7 @@ class Api extends HttpClient {
6330
6342
  */
6331
6343
  this.surveysResponsesList = (query, params = {}) => this.request(Object.assign({ path: `/surveys.responses.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
6332
6344
  /**
6333
- * @description List survey responses requested by the user.
6345
+ * @description List survey responses requested by the user. **Required scopes:** - `survey_response:read` OR `survey_response:write` OR `survey_response:all`
6334
6346
  *
6335
6347
  * @tags surveys
6336
6348
  * @name SurveysResponsesListPost
@@ -6340,7 +6352,7 @@ class Api extends HttpClient {
6340
6352
  */
6341
6353
  this.surveysResponsesListPost = (data, params = {}) => this.request(Object.assign({ path: `/surveys.responses.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
6342
6354
  /**
6343
- * @description Updates a user's survey response for the provided dispatch ID.
6355
+ * @description Updates a user's survey response for the provided dispatch ID. **Required scopes:** - `survey_response:write` OR `survey_response:all`
6344
6356
  *
6345
6357
  * @tags surveys
6346
6358
  * @name SurveysResponsesUpdate
@@ -6350,7 +6362,7 @@ class Api extends HttpClient {
6350
6362
  */
6351
6363
  this.surveysResponsesUpdate = (data, params = {}) => this.request(Object.assign({ path: `/surveys.responses.update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
6352
6364
  /**
6353
- * @description Sends a survey on the specified channels.
6365
+ * @description Sends a survey on the specified channels. **Required scopes:** - `survey:write` OR `survey:all`
6354
6366
  *
6355
6367
  * @tags surveys
6356
6368
  * @name SurveysSend
@@ -6360,7 +6372,7 @@ class Api extends HttpClient {
6360
6372
  */
6361
6373
  this.surveysSend = (data, params = {}) => this.request(Object.assign({ path: `/surveys.send`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
6362
6374
  /**
6363
- * @description Submits a user response to a survey, which is defined by the survey ID.
6375
+ * @description Submits a user response to a survey, which is defined by the survey ID. **Required scopes:** - `survey_response:write` OR `survey_response:all`
6364
6376
  *
6365
6377
  * @tags surveys
6366
6378
  * @name SurveysSubmit
@@ -6370,7 +6382,7 @@ class Api extends HttpClient {
6370
6382
  */
6371
6383
  this.surveysSubmit = (data, params = {}) => this.request(Object.assign({ path: `/surveys.submit`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
6372
6384
  /**
6373
- * @description Updates a survey's metadata.
6385
+ * @description Updates a survey's metadata. **Required scopes:** - `survey:write` OR `survey:all`
6374
6386
  *
6375
6387
  * @tags surveys
6376
6388
  * @name SurveysUpdate
@@ -6380,7 +6392,7 @@ class Api extends HttpClient {
6380
6392
  */
6381
6393
  this.surveysUpdate = (data, params = {}) => this.request(Object.assign({ path: `/surveys.update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
6382
6394
  /**
6383
- * @description Lists system users within your organization. **Required scopes:** - `dev_user:read`
6395
+ * @description Lists system users within your organization. **Required scopes:** Default Scopes unavailable for this API.
6384
6396
  *
6385
6397
  * @tags sys-users
6386
6398
  * @name SysUsersList
@@ -6390,7 +6402,7 @@ class Api extends HttpClient {
6390
6402
  */
6391
6403
  this.sysUsersList = (query, params = {}) => this.request(Object.assign({ path: `/sys-users.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
6392
6404
  /**
6393
- * @description Lists system users within your organization. **Required scopes:** - `dev_user:read`
6405
+ * @description Lists system users within your organization. **Required scopes:** Default Scopes unavailable for this API.
6394
6406
  *
6395
6407
  * @tags sys-users
6396
6408
  * @name SysUsersListPost
@@ -6400,7 +6412,7 @@ class Api extends HttpClient {
6400
6412
  */
6401
6413
  this.sysUsersListPost = (data, params = {}) => this.request(Object.assign({ path: `/sys-users.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
6402
6414
  /**
6403
- * @description Updates the system user. **Required scopes:** - `dev_user:write`
6415
+ * @description Updates the system user. **Required scopes:** Default Scopes unavailable for this API.
6404
6416
  *
6405
6417
  * @tags sys-users
6406
6418
  * @name SysUsersUpdate
@@ -6410,7 +6422,7 @@ class Api extends HttpClient {
6410
6422
  */
6411
6423
  this.sysUsersUpdate = (data, params = {}) => this.request(Object.assign({ path: `/sys-users.update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
6412
6424
  /**
6413
- * @description Creates a new tag, which is used to create associations between objects and a logical concept denoted by the tag's name.
6425
+ * @description Creates a new tag, which is used to create associations between objects and a logical concept denoted by the tag's name. **Required scopes:** - `tag:write` OR `tag:all`
6414
6426
  *
6415
6427
  * @tags tags
6416
6428
  * @name TagsCreate
@@ -6420,7 +6432,7 @@ class Api extends HttpClient {
6420
6432
  */
6421
6433
  this.tagsCreate = (data, params = {}) => this.request(Object.assign({ path: `/tags.create`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
6422
6434
  /**
6423
- * @description Deletes a tag.
6435
+ * @description Deletes a tag. **Required scopes:** - `tag:all`
6424
6436
  *
6425
6437
  * @tags tags
6426
6438
  * @name TagsDelete
@@ -6430,7 +6442,7 @@ class Api extends HttpClient {
6430
6442
  */
6431
6443
  this.tagsDelete = (data, params = {}) => this.request(Object.assign({ path: `/tags.delete`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
6432
6444
  /**
6433
- * @description Gets a tag's information.
6445
+ * @description Gets a tag's information. **Required scopes:** - `tag:read` OR `tag:write` OR `tag:all`
6434
6446
  *
6435
6447
  * @tags tags
6436
6448
  * @name TagsGet
@@ -6440,7 +6452,7 @@ class Api extends HttpClient {
6440
6452
  */
6441
6453
  this.tagsGet = (query, params = {}) => this.request(Object.assign({ path: `/tags.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
6442
6454
  /**
6443
- * @description Gets a tag's information.
6455
+ * @description Gets a tag's information. **Required scopes:** - `tag:read` OR `tag:write` OR `tag:all`
6444
6456
  *
6445
6457
  * @tags tags
6446
6458
  * @name TagsGetPost
@@ -6450,7 +6462,7 @@ class Api extends HttpClient {
6450
6462
  */
6451
6463
  this.tagsGetPost = (data, params = {}) => this.request(Object.assign({ path: `/tags.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
6452
6464
  /**
6453
- * @description Lists the available tags.
6465
+ * @description Lists the available tags. **Required scopes:** - `tag:read` OR `tag:write` OR `tag:all`
6454
6466
  *
6455
6467
  * @tags tags
6456
6468
  * @name TagsList
@@ -6460,7 +6472,7 @@ class Api extends HttpClient {
6460
6472
  */
6461
6473
  this.tagsList = (query, params = {}) => this.request(Object.assign({ path: `/tags.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
6462
6474
  /**
6463
- * @description Lists the available tags.
6475
+ * @description Lists the available tags. **Required scopes:** - `tag:read` OR `tag:write` OR `tag:all`
6464
6476
  *
6465
6477
  * @tags tags
6466
6478
  * @name TagsListPost
@@ -6470,7 +6482,7 @@ class Api extends HttpClient {
6470
6482
  */
6471
6483
  this.tagsListPost = (data, params = {}) => this.request(Object.assign({ path: `/tags.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
6472
6484
  /**
6473
- * @description Updates a tag's information.
6485
+ * @description Updates a tag's information. **Required scopes:** - `tag:write` OR `tag:all`
6474
6486
  *
6475
6487
  * @tags tags
6476
6488
  * @name TagsUpdate
@@ -6480,7 +6492,7 @@ class Api extends HttpClient {
6480
6492
  */
6481
6493
  this.tagsUpdate = (data, params = {}) => this.request(Object.assign({ path: `/tags.update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
6482
6494
  /**
6483
- * @description Creates a new entry on an object's timeline.
6495
+ * @description Creates a new entry on an object's timeline. **Required scopes:** Requires the read or write scope of the parent object's type (e.g. issue:write when posting to an issue's timeline).
6484
6496
  *
6485
6497
  * @tags timeline-entries
6486
6498
  * @name TimelineEntriesCreate
@@ -6490,7 +6502,7 @@ class Api extends HttpClient {
6490
6502
  */
6491
6503
  this.timelineEntriesCreate = (data, params = {}) => this.request(Object.assign({ path: `/timeline-entries.create`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
6492
6504
  /**
6493
- * @description Deletes an entry from an object's timeline.
6505
+ * @description Deletes an entry from an object's timeline. **Required scopes:** Requires the read or write scope of the parent object's type (e.g. issue:write when posting to an issue's timeline).
6494
6506
  *
6495
6507
  * @tags timeline-entries
6496
6508
  * @name TimelineEntriesDelete
@@ -6500,7 +6512,7 @@ class Api extends HttpClient {
6500
6512
  */
6501
6513
  this.timelineEntriesDelete = (data, params = {}) => this.request(Object.assign({ path: `/timeline-entries.delete`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
6502
6514
  /**
6503
- * @description Gets an entry on an object's timeline.
6515
+ * @description Gets an entry on an object's timeline. **Required scopes:** Requires the read or write scope of the parent object's type (e.g. issue:write when posting to an issue's timeline).
6504
6516
  *
6505
6517
  * @tags timeline-entries
6506
6518
  * @name TimelineEntriesGet
@@ -6510,7 +6522,7 @@ class Api extends HttpClient {
6510
6522
  */
6511
6523
  this.timelineEntriesGet = (query, params = {}) => this.request(Object.assign({ path: `/timeline-entries.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
6512
6524
  /**
6513
- * @description Gets an entry on an object's timeline.
6525
+ * @description Gets an entry on an object's timeline. **Required scopes:** Requires the read or write scope of the parent object's type (e.g. issue:write when posting to an issue's timeline).
6514
6526
  *
6515
6527
  * @tags timeline-entries
6516
6528
  * @name TimelineEntriesGetPost
@@ -6520,7 +6532,7 @@ class Api extends HttpClient {
6520
6532
  */
6521
6533
  this.timelineEntriesGetPost = (data, params = {}) => this.request(Object.assign({ path: `/timeline-entries.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
6522
6534
  /**
6523
- * @description Lists the timeline entries for an object.
6535
+ * @description Lists the timeline entries for an object. **Required scopes:** Requires the read or write scope of the parent object's type (e.g. issue:write when posting to an issue's timeline).
6524
6536
  *
6525
6537
  * @tags timeline-entries
6526
6538
  * @name TimelineEntriesList
@@ -6530,7 +6542,7 @@ class Api extends HttpClient {
6530
6542
  */
6531
6543
  this.timelineEntriesList = (query, params = {}) => this.request(Object.assign({ path: `/timeline-entries.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
6532
6544
  /**
6533
- * @description Lists the timeline entries for an object.
6545
+ * @description Lists the timeline entries for an object. **Required scopes:** Requires the read or write scope of the parent object's type (e.g. issue:write when posting to an issue's timeline).
6534
6546
  *
6535
6547
  * @tags timeline-entries
6536
6548
  * @name TimelineEntriesListPost
@@ -6540,7 +6552,7 @@ class Api extends HttpClient {
6540
6552
  */
6541
6553
  this.timelineEntriesListPost = (data, params = {}) => this.request(Object.assign({ path: `/timeline-entries.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
6542
6554
  /**
6543
- * @description Updates an entry on an object's timeline.
6555
+ * @description Updates an entry on an object's timeline. **Required scopes:** Requires the read or write scope of the parent object's type (e.g. issue:write when posting to an issue's timeline).
6544
6556
  *
6545
6557
  * @tags timeline-entries
6546
6558
  * @name TimelineEntriesUpdate
@@ -6660,7 +6672,7 @@ class Api extends HttpClient {
6660
6672
  */
6661
6673
  this.vistasCreate = (data, params = {}) => this.request(Object.assign({ path: `/vistas.create`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
6662
6674
  /**
6663
- * @description Deletes the requested vista.
6675
+ * @description Deletes the requested vista. **Required scopes:** - `vista:all`
6664
6676
  *
6665
6677
  * @tags vistas
6666
6678
  * @name VistasDelete
@@ -6670,7 +6682,7 @@ class Api extends HttpClient {
6670
6682
  */
6671
6683
  this.vistasDelete = (data, params = {}) => this.request(Object.assign({ path: `/vistas.delete`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
6672
6684
  /**
6673
- * @description Gets the requested vistas's information.
6685
+ * @description Gets the requested vistas's information. **Required scopes:** - `vista:read` OR `vista:write` OR `vista:all`
6674
6686
  *
6675
6687
  * @tags vistas
6676
6688
  * @name VistasGet
@@ -6680,7 +6692,7 @@ class Api extends HttpClient {
6680
6692
  */
6681
6693
  this.vistasGet = (query, params = {}) => this.request(Object.assign({ path: `/vistas.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
6682
6694
  /**
6683
- * @description Gets the requested vistas's information.
6695
+ * @description Gets the requested vistas's information. **Required scopes:** - `vista:read` OR `vista:write` OR `vista:all`
6684
6696
  *
6685
6697
  * @tags vistas
6686
6698
  * @name VistasGetPost
@@ -6690,7 +6702,7 @@ class Api extends HttpClient {
6690
6702
  */
6691
6703
  this.vistasGetPost = (data, params = {}) => this.request(Object.assign({ path: `/vistas.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
6692
6704
  /**
6693
- * @description Deletes the requested vista group item
6705
+ * @description Deletes the requested vista group item **Required scopes:** - `vista:all` No scopes required for default vistas.
6694
6706
  *
6695
6707
  * @tags vistas
6696
6708
  * @name VistasGroupsDelete
@@ -6700,7 +6712,7 @@ class Api extends HttpClient {
6700
6712
  */
6701
6713
  this.vistasGroupsDelete = (data, params = {}) => this.request(Object.assign({ path: `/vistas.groups.delete`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
6702
6714
  /**
6703
- * @description Gets the requested vista group item's information.
6715
+ * @description Gets the requested vista group item's information. **Required scopes:** - `vista:read` OR `vista:write` OR `vista:all` No scopes required for default vistas.
6704
6716
  *
6705
6717
  * @tags vistas
6706
6718
  * @name VistasGroupsGet
@@ -6710,7 +6722,7 @@ class Api extends HttpClient {
6710
6722
  */
6711
6723
  this.vistasGroupsGet = (query, params = {}) => this.request(Object.assign({ path: `/vistas.groups.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
6712
6724
  /**
6713
- * @description Gets the requested vista group item's information.
6725
+ * @description Gets the requested vista group item's information. **Required scopes:** - `vista:read` OR `vista:write` OR `vista:all` No scopes required for default vistas.
6714
6726
  *
6715
6727
  * @tags vistas
6716
6728
  * @name VistasGroupsGetPost
@@ -6720,7 +6732,7 @@ class Api extends HttpClient {
6720
6732
  */
6721
6733
  this.vistasGroupsGetPost = (data, params = {}) => this.request(Object.assign({ path: `/vistas.groups.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
6722
6734
  /**
6723
- * @description Lists the available vista group items.
6735
+ * @description Lists the available vista group items. **Required scopes:** - `vista:read` OR `vista:write` OR `vista:all` No scopes required for default vistas.
6724
6736
  *
6725
6737
  * @tags vistas
6726
6738
  * @name VistasGroupsList
@@ -6730,7 +6742,7 @@ class Api extends HttpClient {
6730
6742
  */
6731
6743
  this.vistasGroupsList = (query, params = {}) => this.request(Object.assign({ path: `/vistas.groups.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
6732
6744
  /**
6733
- * @description Lists the available vista group items.
6745
+ * @description Lists the available vista group items. **Required scopes:** - `vista:read` OR `vista:write` OR `vista:all` No scopes required for default vistas.
6734
6746
  *
6735
6747
  * @tags vistas
6736
6748
  * @name VistasGroupsListPost
@@ -6740,7 +6752,7 @@ class Api extends HttpClient {
6740
6752
  */
6741
6753
  this.vistasGroupsListPost = (data, params = {}) => this.request(Object.assign({ path: `/vistas.groups.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
6742
6754
  /**
6743
- * @description Lists the available vistas.
6755
+ * @description Lists the available vistas. **Required scopes:** - `vista:read` OR `vista:write` OR `vista:all`
6744
6756
  *
6745
6757
  * @tags vistas
6746
6758
  * @name VistasList
@@ -6750,7 +6762,7 @@ class Api extends HttpClient {
6750
6762
  */
6751
6763
  this.vistasList = (query, params = {}) => this.request(Object.assign({ path: `/vistas.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
6752
6764
  /**
6753
- * @description Lists the available vistas.
6765
+ * @description Lists the available vistas. **Required scopes:** - `vista:read` OR `vista:write` OR `vista:all`
6754
6766
  *
6755
6767
  * @tags vistas
6756
6768
  * @name VistasListPost
@@ -6760,7 +6772,7 @@ class Api extends HttpClient {
6760
6772
  */
6761
6773
  this.vistasListPost = (data, params = {}) => this.request(Object.assign({ path: `/vistas.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
6762
6774
  /**
6763
- * @description Change state of a web crawler job to pause or resume it back to running.
6775
+ * @description Change state of a web crawler job to pause or resume it back to running. **Required scopes:** - `web_crawler_job:all`
6764
6776
  *
6765
6777
  * @tags web-crawler-job
6766
6778
  * @name WebCrawlerJobsControl
@@ -6770,7 +6782,7 @@ class Api extends HttpClient {
6770
6782
  */
6771
6783
  this.webCrawlerJobsControl = (data, params = {}) => this.request(Object.assign({ path: `/web-crawler-jobs.control`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
6772
6784
  /**
6773
- * @description Creates a web crawler job whose objective is to crawl the provided URLs/sitemaps and generate corresponding webpages as artifacts.
6785
+ * @description Creates a web crawler job whose objective is to crawl the provided URLs/sitemaps and generate corresponding webpages as artifacts. **Required scopes:** - `web_crawler_job:all`
6774
6786
  *
6775
6787
  * @tags web-crawler-job
6776
6788
  * @name CreateWebCrawlerJob
@@ -6780,7 +6792,7 @@ class Api extends HttpClient {
6780
6792
  */
6781
6793
  this.createWebCrawlerJob = (data, params = {}) => this.request(Object.assign({ path: `/web-crawler-jobs.create`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
6782
6794
  /**
6783
- * @description Gets a web crawler job.
6795
+ * @description Gets a web crawler job. **Required scopes:** - `web_crawler_job:all`
6784
6796
  *
6785
6797
  * @tags web-crawler-job
6786
6798
  * @name GetWebCrawlerJob
@@ -6790,7 +6802,7 @@ class Api extends HttpClient {
6790
6802
  */
6791
6803
  this.getWebCrawlerJob = (query, params = {}) => this.request(Object.assign({ path: `/web-crawler-jobs.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
6792
6804
  /**
6793
- * @description Gets a web crawler job.
6805
+ * @description Gets a web crawler job. **Required scopes:** - `web_crawler_job:all`
6794
6806
  *
6795
6807
  * @tags web-crawler-job
6796
6808
  * @name GetWebCrawlerJobPost
@@ -6800,7 +6812,7 @@ class Api extends HttpClient {
6800
6812
  */
6801
6813
  this.getWebCrawlerJobPost = (data, params = {}) => this.request(Object.assign({ path: `/web-crawler-jobs.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
6802
6814
  /**
6803
- * @description Lists web crawler jobs.
6815
+ * @description Lists web crawler jobs. **Required scopes:** - `web_crawler_job:all`
6804
6816
  *
6805
6817
  * @tags web-crawler-job
6806
6818
  * @name ListWebCrawlerJobs
@@ -6810,7 +6822,7 @@ class Api extends HttpClient {
6810
6822
  */
6811
6823
  this.listWebCrawlerJobs = (query, params = {}) => this.request(Object.assign({ path: `/web-crawler-jobs.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
6812
6824
  /**
6813
- * @description Lists web crawler jobs.
6825
+ * @description Lists web crawler jobs. **Required scopes:** - `web_crawler_job:all`
6814
6826
  *
6815
6827
  * @tags web-crawler-job
6816
6828
  * @name ListWebCrawlerJobsPost
@@ -6820,7 +6832,7 @@ class Api extends HttpClient {
6820
6832
  */
6821
6833
  this.listWebCrawlerJobsPost = (data, params = {}) => this.request(Object.assign({ path: `/web-crawler-jobs.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
6822
6834
  /**
6823
- * @description Creates a new webhook target.
6835
+ * @description Creates a new webhook target. **Required scopes:** Default Scopes unavailable for this API.
6824
6836
  *
6825
6837
  * @tags webhooks
6826
6838
  * @name WebhooksCreate
@@ -6830,7 +6842,7 @@ class Api extends HttpClient {
6830
6842
  */
6831
6843
  this.webhooksCreate = (data, params = {}) => this.request(Object.assign({ path: `/webhooks.create`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
6832
6844
  /**
6833
- * @description Deletes the requested webhook.
6845
+ * @description Deletes the requested webhook. **Required scopes:** Default Scopes unavailable for this API.
6834
6846
  *
6835
6847
  * @tags webhooks
6836
6848
  * @name WebhooksDelete
@@ -6840,7 +6852,7 @@ class Api extends HttpClient {
6840
6852
  */
6841
6853
  this.webhooksDelete = (data, params = {}) => this.request(Object.assign({ path: `/webhooks.delete`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
6842
6854
  /**
6843
- * @description Describes a webhook invocation for an event from DevRev to a webhook's target URL, where the receiving handler must implement the specified protocol. Note the documented endpoint is for exposition and not provided by DevRev.
6855
+ * @description Describes a webhook invocation for an event from DevRev to a webhook's target URL, where the receiving handler must implement the specified protocol. Note the documented endpoint is for exposition and not provided by DevRev. **Required scopes:** Default Scopes unavailable for this API.
6844
6856
  *
6845
6857
  * @tags webhooks
6846
6858
  * @name WebhooksEvent
@@ -6860,7 +6872,7 @@ class Api extends HttpClient {
6860
6872
  */
6861
6873
  this.webhooksFetch = (data, params = {}) => this.request(Object.assign({ path: `/webhooks.fetch`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
6862
6874
  /**
6863
- * @description Gets the requested webhook's information.
6875
+ * @description Gets the requested webhook's information. **Required scopes:** Default Scopes unavailable for this API.
6864
6876
  *
6865
6877
  * @tags webhooks
6866
6878
  * @name WebhooksGet
@@ -6870,7 +6882,7 @@ class Api extends HttpClient {
6870
6882
  */
6871
6883
  this.webhooksGet = (query, params = {}) => this.request(Object.assign({ path: `/webhooks.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
6872
6884
  /**
6873
- * @description Gets the requested webhook's information.
6885
+ * @description Gets the requested webhook's information. **Required scopes:** Default Scopes unavailable for this API.
6874
6886
  *
6875
6887
  * @tags webhooks
6876
6888
  * @name WebhooksGetPost
@@ -6880,7 +6892,7 @@ class Api extends HttpClient {
6880
6892
  */
6881
6893
  this.webhooksGetPost = (data, params = {}) => this.request(Object.assign({ path: `/webhooks.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
6882
6894
  /**
6883
- * @description Lists the webhooks.
6895
+ * @description Lists the webhooks. **Required scopes:** Default Scopes unavailable for this API.
6884
6896
  *
6885
6897
  * @tags webhooks
6886
6898
  * @name WebhooksList
@@ -6890,7 +6902,7 @@ class Api extends HttpClient {
6890
6902
  */
6891
6903
  this.webhooksList = (query, params = {}) => this.request(Object.assign({ path: `/webhooks.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
6892
6904
  /**
6893
- * @description Lists the webhooks.
6905
+ * @description Lists the webhooks. **Required scopes:** Default Scopes unavailable for this API.
6894
6906
  *
6895
6907
  * @tags webhooks
6896
6908
  * @name WebhooksListPost
@@ -6900,7 +6912,7 @@ class Api extends HttpClient {
6900
6912
  */
6901
6913
  this.webhooksListPost = (data, params = {}) => this.request(Object.assign({ path: `/webhooks.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
6902
6914
  /**
6903
- * @description Updates the requested webhook.
6915
+ * @description Updates the requested webhook. **Required scopes:** Default Scopes unavailable for this API.
6904
6916
  *
6905
6917
  * @tags webhooks
6906
6918
  * @name WebhooksUpdate
@@ -6940,7 +6952,7 @@ class Api extends HttpClient {
6940
6952
  */
6941
6953
  this.widgetsGetPost = (data, params = {}) => this.request(Object.assign({ path: `/widgets.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
6942
6954
  /**
6943
- * @description Get count of work matching given filter.
6955
+ * @description Get count of work matching given filter. **Required scopes:** Depends on the object type in the `type` field: | type | required scope | |---|---| | incident | `incident:read` OR `incident:write` OR `incident:all` | | issue | `issue:read` OR `issue:write` OR `issue:all` | | opportunity | `opportunity:read` OR `opportunity:write` OR `opportunity:all` | | task | `task:read` OR `task:write` OR `task:all` | | ticket | `ticket:read` OR `ticket:write` OR `ticket:all` |
6944
6956
  *
6945
6957
  * @tags works
6946
6958
  * @name WorksCount
@@ -6950,7 +6962,7 @@ class Api extends HttpClient {
6950
6962
  */
6951
6963
  this.worksCount = (query, params = {}) => this.request(Object.assign({ path: `/works.count`, method: 'GET', query: query, secure: true, format: 'json' }, params));
6952
6964
  /**
6953
- * @description Get count of work matching given filter.
6965
+ * @description Get count of work matching given filter. **Required scopes:** Depends on the object type in the `type` field: | type | required scope | |---|---| | incident | `incident:read` OR `incident:write` OR `incident:all` | | issue | `issue:read` OR `issue:write` OR `issue:all` | | opportunity | `opportunity:read` OR `opportunity:write` OR `opportunity:all` | | task | `task:read` OR `task:write` OR `task:all` | | ticket | `ticket:read` OR `ticket:write` OR `ticket:all` |
6954
6966
  *
6955
6967
  * @tags works
6956
6968
  * @name WorksCountPost
@@ -6960,7 +6972,7 @@ class Api extends HttpClient {
6960
6972
  */
6961
6973
  this.worksCountPost = (data, params = {}) => this.request(Object.assign({ path: `/works.count`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
6962
6974
  /**
6963
- * @description Creates new work ([issue](https://devrev.ai/docs/product/build), [ticket](https://devrev.ai/docs/product/support)) item. [task](https://devrev.ai/docs/product/tasks) and opportunity work types are supported in the beta version.
6975
+ * @description Creates new work ([issue](https://devrev.ai/docs/product/build), [ticket](https://devrev.ai/docs/product/support)) item. [task](https://devrev.ai/docs/product/tasks) and opportunity work types are supported in the beta version. **Required scopes:** Depends on the object type in the `type` field: | type | required scope | |---|---| | incident | `incident:write` OR `incident:all` | | issue | `issue:write` OR `issue:all` | | opportunity | `opportunity:write` OR `opportunity:all` | | task | `task:write` OR `task:all` | | ticket | `ticket:write` OR `ticket:all` |
6964
6976
  *
6965
6977
  * @tags works
6966
6978
  * @name WorksCreate
@@ -6970,7 +6982,7 @@ class Api extends HttpClient {
6970
6982
  */
6971
6983
  this.worksCreate = (data, params = {}) => this.request(Object.assign({ path: `/works.create`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
6972
6984
  /**
6973
- * @description Deletes a work item.
6985
+ * @description Deletes a work item. **Required scopes:** Depends on the object type in the `id` field: | type | required scope | |---|---| | incident | `incident:all` | | issue | `issue:all` | | opportunity | `opportunity:all` | | task | `task:all` | | ticket | `ticket:all` |
6974
6986
  *
6975
6987
  * @tags works
6976
6988
  * @name WorksDelete
@@ -6980,7 +6992,7 @@ class Api extends HttpClient {
6980
6992
  */
6981
6993
  this.worksDelete = (data, params = {}) => this.request(Object.assign({ path: `/works.delete`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
6982
6994
  /**
6983
- * @description Exports a collection of work items.
6995
+ * @description Exports a collection of work items. **Required scopes:** Depends on the object type in the `type` field: | type | required scope | |---|---| | incident | `incident:read` OR `incident:write` OR `incident:all` | | issue | `issue:read` OR `issue:write` OR `issue:all` | | opportunity | `opportunity:read` OR `opportunity:write` OR `opportunity:all` | | task | `task:read` OR `task:write` OR `task:all` | | ticket | `ticket:read` OR `ticket:write` OR `ticket:all` |
6984
6996
  *
6985
6997
  * @tags works
6986
6998
  * @name WorksExport
@@ -6990,7 +7002,7 @@ class Api extends HttpClient {
6990
7002
  */
6991
7003
  this.worksExport = (query, params = {}) => this.request(Object.assign({ path: `/works.export`, method: 'GET', query: query, secure: true, format: 'json' }, params));
6992
7004
  /**
6993
- * @description Exports a collection of work items.
7005
+ * @description Exports a collection of work items. **Required scopes:** Depends on the object type in the `type` field: | type | required scope | |---|---| | incident | `incident:read` OR `incident:write` OR `incident:all` | | issue | `issue:read` OR `issue:write` OR `issue:all` | | opportunity | `opportunity:read` OR `opportunity:write` OR `opportunity:all` | | task | `task:read` OR `task:write` OR `task:all` | | ticket | `ticket:read` OR `ticket:write` OR `ticket:all` |
6994
7006
  *
6995
7007
  * @tags works
6996
7008
  * @name WorksExportPost
@@ -7000,7 +7012,7 @@ class Api extends HttpClient {
7000
7012
  */
7001
7013
  this.worksExportPost = (data, params = {}) => this.request(Object.assign({ path: `/works.export`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
7002
7014
  /**
7003
- * @description Gets a work item's information.
7015
+ * @description Gets a work item's information. **Required scopes:** Depends on the object type in the `id` field: | type | required scope | |---|---| | incident | `incident:read` OR `incident:write` OR `incident:all` | | issue | `issue:read` OR `issue:write` OR `issue:all` | | opportunity | `opportunity:read` OR `opportunity:write` OR `opportunity:all` | | task | `task:read` OR `task:write` OR `task:all` | | ticket | `ticket:read` OR `ticket:write` OR `ticket:all` |
7004
7016
  *
7005
7017
  * @tags works
7006
7018
  * @name WorksGet
@@ -7010,7 +7022,7 @@ class Api extends HttpClient {
7010
7022
  */
7011
7023
  this.worksGet = (query, params = {}) => this.request(Object.assign({ path: `/works.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
7012
7024
  /**
7013
- * @description Gets a work item's information.
7025
+ * @description Gets a work item's information. **Required scopes:** Depends on the object type in the `id` field: | type | required scope | |---|---| | incident | `incident:read` OR `incident:write` OR `incident:all` | | issue | `issue:read` OR `issue:write` OR `issue:all` | | opportunity | `opportunity:read` OR `opportunity:write` OR `opportunity:all` | | task | `task:read` OR `task:write` OR `task:all` | | ticket | `ticket:read` OR `ticket:write` OR `ticket:all` |
7014
7026
  *
7015
7027
  * @tags works
7016
7028
  * @name WorksGetPost
@@ -7020,7 +7032,7 @@ class Api extends HttpClient {
7020
7032
  */
7021
7033
  this.worksGetPost = (data, params = {}) => this.request(Object.assign({ path: `/works.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
7022
7034
  /**
7023
- * @description Lists a collection of work items.
7035
+ * @description Lists a collection of work items. **Required scopes:** Depends on the object type in the `type` field: | type | required scope | |---|---| | incident | `incident:read` OR `incident:write` OR `incident:all` | | issue | `issue:read` OR `issue:write` OR `issue:all` | | opportunity | `opportunity:read` OR `opportunity:write` OR `opportunity:all` | | task | `task:read` OR `task:write` OR `task:all` | | ticket | `ticket:read` OR `ticket:write` OR `ticket:all` |
7024
7036
  *
7025
7037
  * @tags works
7026
7038
  * @name WorksList
@@ -7030,7 +7042,7 @@ class Api extends HttpClient {
7030
7042
  */
7031
7043
  this.worksList = (query, params = {}) => this.request(Object.assign({ path: `/works.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
7032
7044
  /**
7033
- * @description Lists a collection of work items.
7045
+ * @description Lists a collection of work items. **Required scopes:** Depends on the object type in the `type` field: | type | required scope | |---|---| | incident | `incident:read` OR `incident:write` OR `incident:all` | | issue | `issue:read` OR `issue:write` OR `issue:all` | | opportunity | `opportunity:read` OR `opportunity:write` OR `opportunity:all` | | task | `task:read` OR `task:write` OR `task:all` | | ticket | `ticket:read` OR `ticket:write` OR `ticket:all` |
7034
7046
  *
7035
7047
  * @tags works
7036
7048
  * @name WorksListPost
@@ -7040,7 +7052,7 @@ class Api extends HttpClient {
7040
7052
  */
7041
7053
  this.worksListPost = (data, params = {}) => this.request(Object.assign({ path: `/works.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
7042
7054
  /**
7043
- * @description Updates a work item's information.
7055
+ * @description Updates a work item's information. **Required scopes:** Depends on the object type in the `id` field: | type | required scope | |---|---| | incident | `incident:write` OR `incident:all` | | issue | `issue:write` OR `issue:all` | | opportunity | `opportunity:write` OR `opportunity:all` | | task | `task:write` OR `task:all` | | ticket | `ticket:write` OR `ticket:all` |
7044
7056
  *
7045
7057
  * @tags works
7046
7058
  * @name WorksUpdate