@devrev/typescript-sdk 1.1.73 → 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.
@@ -34,10 +34,10 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
34
34
  };
35
35
  Object.defineProperty(exports, "__esModule", { value: true });
36
36
  exports.ErrorConflictType = exports.ErrorBadRequestWorkflowComponentValidationErrorWorkflowComponentValidationLocationType = exports.ErrorBadRequestUnexpectedJsonTypeType = exports.ErrorBadRequestType = exports.ErrorBadRequestSpaceValidationErrorType = exports.ErrorBadRequestGroupHierarchyInvalidParentReason = exports.ErrorBadRequestCustomizationValidationErrorSubtype = exports.EnhancementRevScoreTier = exports.DynamicVistaFilterType = exports.DeviceType = exports.DevicePlatform = exports.DevUsersCreateRequestStateEnumValue = exports.DevUserJobTitle = exports.DevOrgAuthConnectionsUpdateRequestType = exports.DevOrgAuthConnectionsCreateRequestType = exports.Definedness = exports.DateTimePresetType = exports.DateFilterType = exports.DataLabelConfigDisplayMode = exports.CustomSchemaFragmentsSetRequestType = exports.CustomSchemaFragmentsListRequestPrune = exports.CustomSchemaFragmentType = exports.CustomSchemaFragmentFragmentType = exports.ConversationsVistaGroupItemType = exports.ConversationsCreateRequestTypeValue = exports.ConsoleLogType = exports.ConfigurationProrationBehavior = exports.ConfigurationCollectionMethod = exports.CommandSurfaceSurface = exports.CommandSurfaceObjectTypes = exports.CommandStatus = exports.CommandActionTemplateType = exports.CommandActionExecutorType = exports.CodeChangeSource = exports.ChatType = exports.BooleanExpressionType = exports.AuthTokenTokenType = exports.AuthTokenSubjectTokenType = exports.AuthTokenStatus = exports.AuthTokenRequestedTokenType = exports.AuthTokenGrantType = exports.AuthConnectionType = exports.AuthConnectionToggle = exports.AtomType = exports.ArtifactConfigurationSet = exports.ArticleType = exports.ArticleStatus = exports.ArticleContentFormat = exports.AggregationDetailAggregationType = exports.AccessLevel = void 0;
37
- exports.ObservabilitySessionsAggregateRequestSchemaType = exports.ObservabilitySessionsAggregateRequestAggregationConfigType = exports.ObservabilitySessionType = exports.MobileRecordingRecordingEventsTimelineInputType = exports.MobileRecordingRecordingEventsTimelineEventType = exports.MobileRecordingRecordingEventsTimelineEventName = exports.MobileRecordingAppLaunchLaunchType = exports.MetricTrackerType = exports.MetricDefinitionStatus = exports.MetricDefinitionMetricType = exports.MetricDefinitionAppliesTo = exports.MetricActionExecuteRequestAction = exports.MetadataType = exports.MemberType = exports.MeetingState = exports.MeetingDirection = exports.MeetingChannel = exports.MeerkatWidgetColumnProjectionType = exports.MeerkatWidgetColumnProjectionTimestampRollup = exports.MeerkatWidgetColumnFunctionType = exports.MarketplaceItemOperationFeatureOperationType = exports.MarketplaceItemMcpServerFeatureServerType = exports.MarketplaceItemItemType = exports.MarketplaceItemFeatureFeatureType = exports.ListMode = exports.LinksDirection = exports.LinkType = exports.LinkEndpointType = exports.KanbanVisualizationCardAttributePosition = exports.JobState = exports.JobCategory = exports.IssuePriority = exports.GroupedVistaFlavor = exports.GroupedVistaFilterType = exports.GroupType = exports.GroupMemberType = exports.GroupItemType = exports.GroupIngestionSource = exports.FieldValueType = exports.ExternalSystemType = exports.EventTimelineEntryUpdatedReactionAction = exports.EventFetchedResult = exports.ErrorUnauthorizedType = exports.ErrorTooManyRequestsType = exports.ErrorServiceUnavailableType = exports.ErrorSeeOtherType = exports.ErrorRequestEntityTooLargeType = exports.ErrorNotFoundType = exports.ErrorInternalServerErrorType = exports.ErrorForbiddenType = void 0;
38
- exports.StockSchemaFragmentsListRequestPrune = exports.StockSchemaFragmentsListRequestFilterPreset = 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.SchemasSubtypePrepareUpdateGetResponseConflictType = exports.SchemaFieldDescriptorFieldType = exports.SchemaFieldDescriptorArrayTypeBaseType = exports.ReactionsUpdateRequestAction = exports.QuestionAnswerStatus = exports.PricingBillingCycle = exports.PartsVistaGroupItemType = exports.PartType = 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 = void 0;
39
- exports.ContentType = exports.WorksVistaGroupItemType = exports.WorksFilterTicketGroupsOpOperatorType = exports.WorksFilterIssueSprintStateValue = exports.WorkType = exports.WidgetVisualizationType = exports.WidgetQueryOrderByDirection = exports.WidgetQueryColumnConfigType = exports.WidgetQueryColumnConfigTimeGranularity = exports.WidgetQueryColumnConfigAggregation = 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.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.SyncUnitSyncType = exports.SyncRunMode = exports.SyncProgressState = exports.SyncOutStatus = exports.SyncMetadataFilterSyncOutFilterStatus = exports.SyncMetadataFilterSyncInFilterStatus = exports.SyncInStatus = void 0;
40
- exports.Api = exports.HttpClient = void 0;
37
+ exports.ObservabilitySessionsAggregateRequestAggregationConfigType = exports.ObservabilitySessionType = exports.NetworkLogType = exports.MobileRecordingRecordingEventsTimelineInputType = exports.MobileRecordingRecordingEventsTimelineEventType = exports.MobileRecordingRecordingEventsTimelineEventName = exports.MobileRecordingAppLaunchLaunchType = exports.MetricTrackerType = exports.MetricDefinitionStatus = exports.MetricDefinitionMetricType = exports.MetricDefinitionAppliesTo = exports.MetricActionExecuteRequestAction = exports.MetadataType = exports.MemberType = exports.MeetingState = exports.MeetingDirection = exports.MeetingChannel = exports.MeerkatWidgetColumnProjectionType = exports.MeerkatWidgetColumnProjectionTimestampRollup = exports.MeerkatWidgetColumnFunctionType = exports.MarketplaceItemOperationFeatureOperationType = exports.MarketplaceItemMcpServerFeatureServerType = exports.MarketplaceItemItemType = exports.MarketplaceItemFeatureFeatureType = exports.ListMode = exports.LinksDirection = exports.LinkType = exports.LinkEndpointType = exports.KanbanVisualizationCardAttributePosition = exports.JobState = exports.JobCategory = exports.IssuePriority = exports.GroupedVistaFlavor = exports.GroupedVistaFilterType = exports.GroupType = exports.GroupMemberType = exports.GroupItemType = exports.GroupIngestionSource = exports.FieldValueType = exports.ExternalSystemType = exports.EventTimelineEntryUpdatedReactionAction = exports.EventFetchedResult = exports.ErrorUnauthorizedType = exports.ErrorTooManyRequestsType = exports.ErrorServiceUnavailableType = exports.ErrorSeeOtherType = exports.ErrorRequestEntityTooLargeType = exports.ErrorNotFoundType = exports.ErrorInternalServerErrorType = exports.ErrorForbiddenType = void 0;
38
+ exports.StockSchemaFragmentsListRequestFilterPreset = 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.SchemasSubtypePrepareUpdateGetResponseConflictType = exports.SchemaFieldDescriptorFieldType = exports.SchemaFieldDescriptorArrayTypeBaseType = exports.ReactionsUpdateRequestAction = exports.QuestionAnswerStatus = exports.PricingBillingCycle = exports.PartsVistaGroupItemType = exports.PartType = 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 = void 0;
39
+ exports.WorksVistaGroupItemType = exports.WorksFilterTicketGroupsOpOperatorType = exports.WorksFilterIssueSprintStateValue = exports.WorkType = exports.WidgetVisualizationType = exports.WidgetQueryOrderByDirection = exports.WidgetQueryColumnConfigType = exports.WidgetQueryColumnConfigTimeGranularity = exports.WidgetQueryColumnConfigAggregation = 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.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.SyncUnitSyncType = exports.SyncRunMode = exports.SyncProgressState = exports.SyncOutStatus = exports.SyncMetadataFilterSyncOutFilterStatus = exports.SyncMetadataFilterSyncInFilterStatus = exports.SyncInStatus = exports.StockSchemaFragmentsListRequestPrune = void 0;
40
+ exports.Api = exports.HttpClient = exports.ContentType = void 0;
41
41
  var AccessLevel;
42
42
  (function (AccessLevel) {
43
43
  AccessLevel["External"] = "external";
@@ -534,6 +534,7 @@ var ErrorBadRequestType;
534
534
  ErrorBadRequestType["MergeWorksError"] = "merge_works_error";
535
535
  ErrorBadRequestType["MissingDependency"] = "missing_dependency";
536
536
  ErrorBadRequestType["MissingRequiredField"] = "missing_required_field";
537
+ ErrorBadRequestType["OperationNotAllowed"] = "operation_not_allowed";
537
538
  ErrorBadRequestType["ParseError"] = "parse_error";
538
539
  ErrorBadRequestType["SpaceValidationErrors"] = "space_validation_errors";
539
540
  ErrorBadRequestType["StaleSchemaFragments"] = "stale_schema_fragments";
@@ -1027,6 +1028,19 @@ var MobileRecordingRecordingEventsTimelineInputType;
1027
1028
  MobileRecordingRecordingEventsTimelineInputType["ToolTypeStylus"] = "tool_type_stylus";
1028
1029
  MobileRecordingRecordingEventsTimelineInputType["ToolTypeUnknown"] = "tool_type_unknown";
1029
1030
  })(MobileRecordingRecordingEventsTimelineInputType = exports.MobileRecordingRecordingEventsTimelineInputType || (exports.MobileRecordingRecordingEventsTimelineInputType = {}));
1031
+ /** The type of network log. */
1032
+ var NetworkLogType;
1033
+ (function (NetworkLogType) {
1034
+ NetworkLogType["Css"] = "css";
1035
+ NetworkLogType["Fetch"] = "fetch";
1036
+ NetworkLogType["Font"] = "font";
1037
+ NetworkLogType["Iframe"] = "iframe";
1038
+ NetworkLogType["Img"] = "img";
1039
+ NetworkLogType["Link"] = "link";
1040
+ NetworkLogType["Other"] = "other";
1041
+ NetworkLogType["Script"] = "script";
1042
+ NetworkLogType["Xhr"] = "xhr";
1043
+ })(NetworkLogType = exports.NetworkLogType || (exports.NetworkLogType = {}));
1030
1044
  var ObservabilitySessionType;
1031
1045
  (function (ObservabilitySessionType) {
1032
1046
  ObservabilitySessionType["Mobile"] = "mobile";
@@ -2022,7 +2036,7 @@ class Api extends HttpClient {
2022
2036
  constructor() {
2023
2037
  super(...arguments);
2024
2038
  /**
2025
- * @description Creates an account, which is a record representing a customer or an organization.
2039
+ * @description Creates an account, which is a record representing a customer or an organization. **Required scopes:** - `account:write` OR `account:all`
2026
2040
  *
2027
2041
  * @tags accounts
2028
2042
  * @name AccountsCreate
@@ -2032,7 +2046,7 @@ class Api extends HttpClient {
2032
2046
  */
2033
2047
  this.accountsCreate = (data, params = {}) => this.request(Object.assign({ path: `/accounts.create`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
2034
2048
  /**
2035
- * @description Deletes an account.
2049
+ * @description Deletes an account. **Required scopes:** - `account:all`
2036
2050
  *
2037
2051
  * @tags accounts
2038
2052
  * @name AccountsDelete
@@ -2042,7 +2056,7 @@ class Api extends HttpClient {
2042
2056
  */
2043
2057
  this.accountsDelete = (data, params = {}) => this.request(Object.assign({ path: `/accounts.delete`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
2044
2058
  /**
2045
- * @description Exports a collection of accounts.
2059
+ * @description Exports a collection of accounts. **Required scopes:** - `account:read` OR `account:write` OR `account:all`
2046
2060
  *
2047
2061
  * @tags accounts
2048
2062
  * @name AccountsExport
@@ -2052,7 +2066,7 @@ class Api extends HttpClient {
2052
2066
  */
2053
2067
  this.accountsExport = (query, params = {}) => this.request(Object.assign({ path: `/accounts.export`, method: 'GET', query: query, secure: true, format: 'json' }, params));
2054
2068
  /**
2055
- * @description Exports a collection of accounts.
2069
+ * @description Exports a collection of accounts. **Required scopes:** - `account:read` OR `account:write` OR `account:all`
2056
2070
  *
2057
2071
  * @tags accounts
2058
2072
  * @name AccountsExportPost
@@ -2062,7 +2076,7 @@ class Api extends HttpClient {
2062
2076
  */
2063
2077
  this.accountsExportPost = (data, params = {}) => this.request(Object.assign({ path: `/accounts.export`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
2064
2078
  /**
2065
- * @description Retrieves an account's information.
2079
+ * @description Retrieves an account's information. **Required scopes:** - `account:read` OR `account:write` OR `account:all`
2066
2080
  *
2067
2081
  * @tags accounts
2068
2082
  * @name AccountsGet
@@ -2072,7 +2086,7 @@ class Api extends HttpClient {
2072
2086
  */
2073
2087
  this.accountsGet = (query, params = {}) => this.request(Object.assign({ path: `/accounts.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
2074
2088
  /**
2075
- * @description Retrieves an account's information.
2089
+ * @description Retrieves an account's information. **Required scopes:** - `account:read` OR `account:write` OR `account:all`
2076
2090
  *
2077
2091
  * @tags accounts
2078
2092
  * @name AccountsGetPost
@@ -2082,7 +2096,7 @@ class Api extends HttpClient {
2082
2096
  */
2083
2097
  this.accountsGetPost = (data, params = {}) => this.request(Object.assign({ path: `/accounts.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
2084
2098
  /**
2085
- * @description Gets a list of accounts.
2099
+ * @description Gets a list of accounts. **Required scopes:** - `account:read` OR `account:write` OR `account:all`
2086
2100
  *
2087
2101
  * @tags accounts
2088
2102
  * @name AccountsList
@@ -2092,7 +2106,7 @@ class Api extends HttpClient {
2092
2106
  */
2093
2107
  this.accountsList = (query, params = {}) => this.request(Object.assign({ path: `/accounts.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
2094
2108
  /**
2095
- * @description Gets a list of accounts.
2109
+ * @description Gets a list of accounts. **Required scopes:** - `account:read` OR `account:write` OR `account:all`
2096
2110
  *
2097
2111
  * @tags accounts
2098
2112
  * @name AccountsListPost
@@ -2102,7 +2116,7 @@ class Api extends HttpClient {
2102
2116
  */
2103
2117
  this.accountsListPost = (data, params = {}) => this.request(Object.assign({ path: `/accounts.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
2104
2118
  /**
2105
- * @description Merges two accounts.
2119
+ * @description Merges two accounts. **Required scopes:** - `account:all`
2106
2120
  *
2107
2121
  * @tags accounts
2108
2122
  * @name AccountsMerge
@@ -2112,7 +2126,7 @@ class Api extends HttpClient {
2112
2126
  */
2113
2127
  this.accountsMerge = (data, params = {}) => this.request(Object.assign({ path: `/accounts.merge`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
2114
2128
  /**
2115
- * @description Updates an account's information.
2129
+ * @description Updates an account's information. **Required scopes:** - `account:write` OR `account:all`
2116
2130
  *
2117
2131
  * @tags accounts
2118
2132
  * @name AccountsUpdate
@@ -2122,7 +2136,7 @@ class Api extends HttpClient {
2122
2136
  */
2123
2137
  this.accountsUpdate = (data, params = {}) => this.request(Object.assign({ path: `/accounts.update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
2124
2138
  /**
2125
- * @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.
2139
+ * @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`
2126
2140
  *
2127
2141
  * @tags articles
2128
2142
  * @name CreateArticle
@@ -2132,7 +2146,7 @@ class Api extends HttpClient {
2132
2146
  */
2133
2147
  this.createArticle = (data, params = {}) => this.request(Object.assign({ path: `/articles.create`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
2134
2148
  /**
2135
- * @description Deletes an article.
2149
+ * @description Deletes an article. **Required scopes:** - `article:all`
2136
2150
  *
2137
2151
  * @tags articles
2138
2152
  * @name DeleteArticle
@@ -2142,7 +2156,7 @@ class Api extends HttpClient {
2142
2156
  */
2143
2157
  this.deleteArticle = (data, params = {}) => this.request(Object.assign({ path: `/articles.delete`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
2144
2158
  /**
2145
- * @description Gets an article.
2159
+ * @description Gets an article. **Required scopes:** - `article:read` OR `article:write` OR `article:all`
2146
2160
  *
2147
2161
  * @tags articles
2148
2162
  * @name GetArticle
@@ -2152,7 +2166,7 @@ class Api extends HttpClient {
2152
2166
  */
2153
2167
  this.getArticle = (query, params = {}) => this.request(Object.assign({ path: `/articles.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
2154
2168
  /**
2155
- * @description Gets an article.
2169
+ * @description Gets an article. **Required scopes:** - `article:read` OR `article:write` OR `article:all`
2156
2170
  *
2157
2171
  * @tags articles
2158
2172
  * @name GetArticlePost
@@ -2162,7 +2176,7 @@ class Api extends HttpClient {
2162
2176
  */
2163
2177
  this.getArticlePost = (data, params = {}) => this.request(Object.assign({ path: `/articles.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
2164
2178
  /**
2165
- * @description Lists a collection of articles.
2179
+ * @description Lists a collection of articles. **Required scopes:** - `article:read` OR `article:write` OR `article:all`
2166
2180
  *
2167
2181
  * @tags articles
2168
2182
  * @name ListArticles
@@ -2172,7 +2186,7 @@ class Api extends HttpClient {
2172
2186
  */
2173
2187
  this.listArticles = (query, params = {}) => this.request(Object.assign({ path: `/articles.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
2174
2188
  /**
2175
- * @description Lists a collection of articles.
2189
+ * @description Lists a collection of articles. **Required scopes:** - `article:read` OR `article:write` OR `article:all`
2176
2190
  *
2177
2191
  * @tags articles
2178
2192
  * @name ListArticlesPost
@@ -2182,7 +2196,7 @@ class Api extends HttpClient {
2182
2196
  */
2183
2197
  this.listArticlesPost = (data, params = {}) => this.request(Object.assign({ path: `/articles.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
2184
2198
  /**
2185
- * @description Updates an article.
2199
+ * @description Updates an article. **Required scopes:** - `article:write` OR `article:all`
2186
2200
  *
2187
2201
  * @tags articles
2188
2202
  * @name UpdateArticle
@@ -2192,7 +2206,7 @@ class Api extends HttpClient {
2192
2206
  */
2193
2207
  this.updateArticle = (data, params = {}) => this.request(Object.assign({ path: `/articles.update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
2194
2208
  /**
2195
- * @description Redirects to the artifact's download URL.
2209
+ * @description Redirects to the artifact's download URL. **Required scopes:** - `artifact:read`
2196
2210
  *
2197
2211
  * @tags artifacts
2198
2212
  * @name ArtifactsDownload
@@ -2202,7 +2216,7 @@ class Api extends HttpClient {
2202
2216
  */
2203
2217
  this.artifactsDownload = (query, params = {}) => this.request(Object.assign({ path: `/artifacts.download`, method: 'GET', query: query, secure: true }, params));
2204
2218
  /**
2205
- * @description Redirects to the artifact's download URL.
2219
+ * @description Redirects to the artifact's download URL. **Required scopes:** - `artifact:read`
2206
2220
  *
2207
2221
  * @tags artifacts
2208
2222
  * @name ArtifactsDownloadPost
@@ -2212,7 +2226,7 @@ class Api extends HttpClient {
2212
2226
  */
2213
2227
  this.artifactsDownloadPost = (data, params = {}) => this.request(Object.assign({ path: `/artifacts.download`, method: 'POST', body: data, secure: true, type: ContentType.Json }, params));
2214
2228
  /**
2215
- * @description Gets the requested artifact's information.
2229
+ * @description Gets the requested artifact's information. **Required scopes:** - `artifact:read` Also needs parent read access.
2216
2230
  *
2217
2231
  * @tags artifacts
2218
2232
  * @name ArtifactsGet
@@ -2222,7 +2236,7 @@ class Api extends HttpClient {
2222
2236
  */
2223
2237
  this.artifactsGet = (query, params = {}) => this.request(Object.assign({ path: `/artifacts.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
2224
2238
  /**
2225
- * @description Gets the requested artifact's information.
2239
+ * @description Gets the requested artifact's information. **Required scopes:** - `artifact:read` Also needs parent read access.
2226
2240
  *
2227
2241
  * @tags artifacts
2228
2242
  * @name ArtifactsGetPost
@@ -2232,7 +2246,7 @@ class Api extends HttpClient {
2232
2246
  */
2233
2247
  this.artifactsGetPost = (data, params = {}) => this.request(Object.assign({ path: `/artifacts.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
2234
2248
  /**
2235
- * @description List the artifacts attached to an object.
2249
+ * @description List the artifacts attached to an object. **Required scopes:** - `artifact:read` Also needs parent read access.
2236
2250
  *
2237
2251
  * @tags artifacts
2238
2252
  * @name ArtifactsList
@@ -2242,7 +2256,7 @@ class Api extends HttpClient {
2242
2256
  */
2243
2257
  this.artifactsList = (query, params = {}) => this.request(Object.assign({ path: `/artifacts.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
2244
2258
  /**
2245
- * @description List the artifacts attached to an object.
2259
+ * @description List the artifacts attached to an object. **Required scopes:** - `artifact:read` Also needs parent read access.
2246
2260
  *
2247
2261
  * @tags artifacts
2248
2262
  * @name ArtifactsListPost
@@ -2252,7 +2266,7 @@ class Api extends HttpClient {
2252
2266
  */
2253
2267
  this.artifactsListPost = (data, params = {}) => this.request(Object.assign({ path: `/artifacts.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
2254
2268
  /**
2255
- * @description Gets the download URL for the artifact.
2269
+ * @description Gets the download URL for the artifact. **Required scopes:** - `artifact:read` Also needs parent read access.
2256
2270
  *
2257
2271
  * @tags artifacts
2258
2272
  * @name ArtifactsLocate
@@ -2262,7 +2276,7 @@ class Api extends HttpClient {
2262
2276
  */
2263
2277
  this.artifactsLocate = (query, params = {}) => this.request(Object.assign({ path: `/artifacts.locate`, method: 'GET', query: query, secure: true, format: 'json' }, params));
2264
2278
  /**
2265
- * @description Gets the download URL for the artifact.
2279
+ * @description Gets the download URL for the artifact. **Required scopes:** - `artifact:read` Also needs parent read access.
2266
2280
  *
2267
2281
  * @tags artifacts
2268
2282
  * @name ArtifactsLocatePost
@@ -2272,7 +2286,7 @@ class Api extends HttpClient {
2272
2286
  */
2273
2287
  this.artifactsLocatePost = (data, params = {}) => this.request(Object.assign({ path: `/artifacts.locate`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
2274
2288
  /**
2275
- * @description Creates an artifact and generates an upload URL for its data.
2289
+ * @description Creates an artifact and generates an upload URL for its data. **Required scopes:** - `artifact:create`
2276
2290
  *
2277
2291
  * @tags artifacts
2278
2292
  * @name ArtifactsPrepare
@@ -2282,7 +2296,7 @@ class Api extends HttpClient {
2282
2296
  */
2283
2297
  this.artifactsPrepare = (data, params = {}) => this.request(Object.assign({ path: `/artifacts.prepare`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
2284
2298
  /**
2285
- * @description Permanently deletes a version of an artifact.
2299
+ * @description Permanently deletes a version of an artifact. **Required scopes:** - `artifact:create`
2286
2300
  *
2287
2301
  * @tags artifacts
2288
2302
  * @name ArtifactsHardDeleteVersion
@@ -2292,7 +2306,7 @@ class Api extends HttpClient {
2292
2306
  */
2293
2307
  this.artifactsHardDeleteVersion = (data, params = {}) => this.request(Object.assign({ path: `/artifacts.versions.delete`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
2294
2308
  /**
2295
- * @description Prepares a new version for an artifact, returning the URL and form data to upload the updated file.
2309
+ * @description Prepares a new version for an artifact, returning the URL and form data to upload the updated file. **Required scopes:** - `artifact:create`
2296
2310
  *
2297
2311
  * @tags artifacts
2298
2312
  * @name ArtifactsVersionsPrepare
@@ -2322,7 +2336,7 @@ class Api extends HttpClient {
2322
2336
  */
2323
2337
  this.atomsGetPost = (data, params = {}) => this.request(Object.assign({ path: `/atoms.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
2324
2338
  /**
2325
- * @description Creates a JWT corresponding to the requested token type for the authenticated user.
2339
+ * @description Creates a JWT corresponding to the requested token type for the authenticated user. **Required scopes:** No scopes required.
2326
2340
  *
2327
2341
  * @tags auth-tokens
2328
2342
  * @name AuthTokensCreate
@@ -2332,7 +2346,7 @@ class Api extends HttpClient {
2332
2346
  */
2333
2347
  this.authTokensCreate = (data, params = {}) => this.request(Object.assign({ path: `/auth-tokens.create`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
2334
2348
  /**
2335
- * @description Revokes the token that matches the given token ID issued under the given Dev organization.
2349
+ * @description Revokes the token that matches the given token ID issued under the given Dev organization. **Required scopes:** No scopes required.
2336
2350
  *
2337
2351
  * @tags auth-tokens
2338
2352
  * @name AuthTokensDelete
@@ -2342,7 +2356,7 @@ class Api extends HttpClient {
2342
2356
  */
2343
2357
  this.authTokensDelete = (data, params = {}) => this.request(Object.assign({ path: `/auth-tokens.delete`, method: 'POST', body: data, secure: true, type: ContentType.Json }, params));
2344
2358
  /**
2345
- * @description Gets the token metadata corresponding to the given token ID under the given Dev organization.
2359
+ * @description Gets the token metadata corresponding to the given token ID under the given Dev organization. **Required scopes:** No scopes required.
2346
2360
  *
2347
2361
  * @tags auth-tokens
2348
2362
  * @name AuthTokensGet
@@ -2352,7 +2366,7 @@ class Api extends HttpClient {
2352
2366
  */
2353
2367
  this.authTokensGet = (query, params = {}) => this.request(Object.assign({ path: `/auth-tokens.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
2354
2368
  /**
2355
- * @description Gets the token metadata corresponding to the given token ID under the given Dev organization.
2369
+ * @description Gets the token metadata corresponding to the given token ID under the given Dev organization. **Required scopes:** No scopes required.
2356
2370
  *
2357
2371
  * @tags auth-tokens
2358
2372
  * @name AuthTokensGetPost
@@ -2362,7 +2376,7 @@ class Api extends HttpClient {
2362
2376
  */
2363
2377
  this.authTokensGetPost = (data, params = {}) => this.request(Object.assign({ path: `/auth-tokens.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
2364
2378
  /**
2365
- * @description Returns the Dev organization, user and token attributes extracted from the auth token.
2379
+ * @description Returns the Dev organization, user and token attributes extracted from the auth token. **Required scopes:** No scopes required.
2366
2380
  *
2367
2381
  * @tags auth-tokens
2368
2382
  * @name AuthTokensInfo
@@ -2372,7 +2386,7 @@ class Api extends HttpClient {
2372
2386
  */
2373
2387
  this.authTokensInfo = (params = {}) => this.request(Object.assign({ path: `/auth-tokens.info`, method: 'GET', secure: true, format: 'json' }, params));
2374
2388
  /**
2375
- * @description Returns the Dev organization, user and token attributes extracted from the auth token.
2389
+ * @description Returns the Dev organization, user and token attributes extracted from the auth token. **Required scopes:** No scopes required.
2376
2390
  *
2377
2391
  * @tags auth-tokens
2378
2392
  * @name AuthTokensInfoPost
@@ -2382,7 +2396,7 @@ class Api extends HttpClient {
2382
2396
  */
2383
2397
  this.authTokensInfoPost = (data, params = {}) => this.request(Object.assign({ path: `/auth-tokens.info`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
2384
2398
  /**
2385
- * @description Gets the token metadata for all the tokens corresponding to the given token type issued for a given subject.
2399
+ * @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.
2386
2400
  *
2387
2401
  * @tags auth-tokens
2388
2402
  * @name AuthTokensList
@@ -2392,7 +2406,7 @@ class Api extends HttpClient {
2392
2406
  */
2393
2407
  this.authTokensList = (query, params = {}) => this.request(Object.assign({ path: `/auth-tokens.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
2394
2408
  /**
2395
- * @description Gets the token metadata for all the tokens corresponding to the given token type issued for a given subject.
2409
+ * @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.
2396
2410
  *
2397
2411
  * @tags auth-tokens
2398
2412
  * @name AuthTokensListPost
@@ -2402,7 +2416,7 @@ class Api extends HttpClient {
2402
2416
  */
2403
2417
  this.authTokensListPost = (data, params = {}) => this.request(Object.assign({ path: `/auth-tokens.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
2404
2418
  /**
2405
- * @description Revokes all the tokens that matches the given token type created by the authenticated user.
2419
+ * @description Revokes all the tokens that matches the given token type created by the authenticated user. **Required scopes:** No scopes required.
2406
2420
  *
2407
2421
  * @tags auth-tokens
2408
2422
  * @name AuthTokensSelfDelete
@@ -2412,7 +2426,7 @@ class Api extends HttpClient {
2412
2426
  */
2413
2427
  this.authTokensSelfDelete = (data, params = {}) => this.request(Object.assign({ path: `/auth-tokens.self.delete`, method: 'POST', body: data, secure: true, type: ContentType.Json }, params));
2414
2428
  /**
2415
- * @description Updates token metadata of a token issued under a given Dev organization.
2429
+ * @description Updates token metadata of a token issued under a given Dev organization. **Required scopes:** No scopes required.
2416
2430
  *
2417
2431
  * @tags auth-tokens
2418
2432
  * @name AuthTokensUpdate
@@ -2422,7 +2436,7 @@ class Api extends HttpClient {
2422
2436
  */
2423
2437
  this.authTokensUpdate = (data, params = {}) => this.request(Object.assign({ path: `/auth-tokens.update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
2424
2438
  /**
2425
- * @description Creates a new chat, or optionally opens an existing one.
2439
+ * @description Creates a new chat, or optionally opens an existing one. **Required scopes:** Access is determined by chat membership.
2426
2440
  *
2427
2441
  * @tags chats
2428
2442
  * @name ChatsCreate
@@ -2432,7 +2446,7 @@ class Api extends HttpClient {
2432
2446
  */
2433
2447
  this.chatsCreate = (data, params = {}) => this.request(Object.assign({ path: `/chats.create`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
2434
2448
  /**
2435
- * @description Gets a chat's information.
2449
+ * @description Gets a chat's information. **Required scopes:** Access is determined by chat membership.
2436
2450
  *
2437
2451
  * @tags chats
2438
2452
  * @name ChatsGet
@@ -2442,7 +2456,7 @@ class Api extends HttpClient {
2442
2456
  */
2443
2457
  this.chatsGet = (query, params = {}) => this.request(Object.assign({ path: `/chats.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
2444
2458
  /**
2445
- * @description Gets a chat's information.
2459
+ * @description Gets a chat's information. **Required scopes:** Access is determined by chat membership.
2446
2460
  *
2447
2461
  * @tags chats
2448
2462
  * @name ChatsGetPost
@@ -2452,7 +2466,7 @@ class Api extends HttpClient {
2452
2466
  */
2453
2467
  this.chatsGetPost = (data, params = {}) => this.request(Object.assign({ path: `/chats.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
2454
2468
  /**
2455
- * @description Updates a chat's information.
2469
+ * @description Updates a chat's information. **Required scopes:** Access is determined by chat membership.
2456
2470
  *
2457
2471
  * @tags chats
2458
2472
  * @name ChatsUpdate
@@ -2462,7 +2476,7 @@ class Api extends HttpClient {
2462
2476
  */
2463
2477
  this.chatsUpdate = (data, params = {}) => this.request(Object.assign({ path: `/chats.update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
2464
2478
  /**
2465
- * @description Creates a code change object.
2479
+ * @description Creates a code change object. **Required scopes:** - `code_change:write` OR `code_change:all`
2466
2480
  *
2467
2481
  * @tags code-changes
2468
2482
  * @name CodeChangesCreate
@@ -2472,7 +2486,7 @@ class Api extends HttpClient {
2472
2486
  */
2473
2487
  this.codeChangesCreate = (data, params = {}) => this.request(Object.assign({ path: `/code-changes.create`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
2474
2488
  /**
2475
- * @description Deletes a code change object.
2489
+ * @description Deletes a code change object. **Required scopes:** - `code_change:all`
2476
2490
  *
2477
2491
  * @tags code-changes
2478
2492
  * @name CodeChangesDelete
@@ -2482,7 +2496,7 @@ class Api extends HttpClient {
2482
2496
  */
2483
2497
  this.codeChangesDelete = (data, params = {}) => this.request(Object.assign({ path: `/code-changes.delete`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
2484
2498
  /**
2485
- * @description Gets a code change object.
2499
+ * @description Gets a code change object. **Required scopes:** - `code_change:read` OR `code_change:write` OR `code_change:all`
2486
2500
  *
2487
2501
  * @tags code-changes
2488
2502
  * @name CodeChangesGet
@@ -2492,7 +2506,7 @@ class Api extends HttpClient {
2492
2506
  */
2493
2507
  this.codeChangesGet = (query, params = {}) => this.request(Object.assign({ path: `/code-changes.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
2494
2508
  /**
2495
- * @description Gets a code change object.
2509
+ * @description Gets a code change object. **Required scopes:** - `code_change:read` OR `code_change:write` OR `code_change:all`
2496
2510
  *
2497
2511
  * @tags code-changes
2498
2512
  * @name CodeChangesGetPost
@@ -2502,7 +2516,7 @@ class Api extends HttpClient {
2502
2516
  */
2503
2517
  this.codeChangesGetPost = (data, params = {}) => this.request(Object.assign({ path: `/code-changes.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
2504
2518
  /**
2505
- * @description Lists code change objects.
2519
+ * @description Lists code change objects. **Required scopes:** - `code_change:read` OR `code_change:write` OR `code_change:all`
2506
2520
  *
2507
2521
  * @tags code-changes
2508
2522
  * @name CodeChangesList
@@ -2512,7 +2526,7 @@ class Api extends HttpClient {
2512
2526
  */
2513
2527
  this.codeChangesList = (query, params = {}) => this.request(Object.assign({ path: `/code-changes.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
2514
2528
  /**
2515
- * @description Lists code change objects.
2529
+ * @description Lists code change objects. **Required scopes:** - `code_change:read` OR `code_change:write` OR `code_change:all`
2516
2530
  *
2517
2531
  * @tags code-changes
2518
2532
  * @name CodeChangesListPost
@@ -2522,7 +2536,7 @@ class Api extends HttpClient {
2522
2536
  */
2523
2537
  this.codeChangesListPost = (data, params = {}) => this.request(Object.assign({ path: `/code-changes.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
2524
2538
  /**
2525
- * @description Updates a code change object.
2539
+ * @description Updates a code change object. **Required scopes:** - `code_change:write` OR `code_change:all`
2526
2540
  *
2527
2541
  * @tags code-changes
2528
2542
  * @name CodeChangesUpdate
@@ -2532,7 +2546,7 @@ class Api extends HttpClient {
2532
2546
  */
2533
2547
  this.codeChangesUpdate = (data, params = {}) => this.request(Object.assign({ path: `/code-changes.update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
2534
2548
  /**
2535
- * @description Creates a command.
2549
+ * @description Creates a command. **Required scopes:** - `command:write` OR `command:all`
2536
2550
  *
2537
2551
  * @tags commands
2538
2552
  * @name CommandsCreate
@@ -2542,7 +2556,7 @@ class Api extends HttpClient {
2542
2556
  */
2543
2557
  this.commandsCreate = (data, params = {}) => this.request(Object.assign({ path: `/commands.create`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
2544
2558
  /**
2545
- * @description Gets a command.
2559
+ * @description Gets a command. **Required scopes:** - `command:read` OR `command:write` OR `command:all`
2546
2560
  *
2547
2561
  * @tags commands
2548
2562
  * @name CommandsGet
@@ -2552,7 +2566,7 @@ class Api extends HttpClient {
2552
2566
  */
2553
2567
  this.commandsGet = (query, params = {}) => this.request(Object.assign({ path: `/commands.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
2554
2568
  /**
2555
- * @description Gets a command.
2569
+ * @description Gets a command. **Required scopes:** - `command:read` OR `command:write` OR `command:all`
2556
2570
  *
2557
2571
  * @tags commands
2558
2572
  * @name CommandsGetPost
@@ -2562,7 +2576,7 @@ class Api extends HttpClient {
2562
2576
  */
2563
2577
  this.commandsGetPost = (data, params = {}) => this.request(Object.assign({ path: `/commands.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
2564
2578
  /**
2565
- * @description Lists commands for a Dev organization.
2579
+ * @description Lists commands for a Dev organization. **Required scopes:** - `command:read` OR `command:write` OR `command:all`
2566
2580
  *
2567
2581
  * @tags commands
2568
2582
  * @name CommandsList
@@ -2572,7 +2586,7 @@ class Api extends HttpClient {
2572
2586
  */
2573
2587
  this.commandsList = (query, params = {}) => this.request(Object.assign({ path: `/commands.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
2574
2588
  /**
2575
- * @description Lists commands for a Dev organization.
2589
+ * @description Lists commands for a Dev organization. **Required scopes:** - `command:read` OR `command:write` OR `command:all`
2576
2590
  *
2577
2591
  * @tags commands
2578
2592
  * @name CommandsListPost
@@ -2582,7 +2596,7 @@ class Api extends HttpClient {
2582
2596
  */
2583
2597
  this.commandsListPost = (data, params = {}) => this.request(Object.assign({ path: `/commands.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
2584
2598
  /**
2585
- * @description Updates a command.
2599
+ * @description Updates a command. **Required scopes:** - `command:write` OR `command:all`
2586
2600
  *
2587
2601
  * @tags commands
2588
2602
  * @name CommandsUpdate
@@ -2592,7 +2606,7 @@ class Api extends HttpClient {
2592
2606
  */
2593
2607
  this.commandsUpdate = (data, params = {}) => this.request(Object.assign({ path: `/commands.update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
2594
2608
  /**
2595
- * @description Creates a conversation.
2609
+ * @description Creates a conversation. **Required scopes:** - `conversation:write` OR `conversation:all`
2596
2610
  *
2597
2611
  * @tags conversations
2598
2612
  * @name ConversationsCreate
@@ -2602,7 +2616,7 @@ class Api extends HttpClient {
2602
2616
  */
2603
2617
  this.conversationsCreate = (data, params = {}) => this.request(Object.assign({ path: `/conversations.create`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
2604
2618
  /**
2605
- * @description Deletes the requested conversation.
2619
+ * @description Deletes the requested conversation. **Required scopes:** - `conversation:all`
2606
2620
  *
2607
2621
  * @tags conversations
2608
2622
  * @name ConversationsDelete
@@ -2612,7 +2626,7 @@ class Api extends HttpClient {
2612
2626
  */
2613
2627
  this.conversationsDelete = (data, params = {}) => this.request(Object.assign({ path: `/conversations.delete`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
2614
2628
  /**
2615
- * @description Gets the requested conversation's information.
2629
+ * @description Gets the requested conversation's information. **Required scopes:** - `conversation:read` OR `conversation:write` OR `conversation:all`
2616
2630
  *
2617
2631
  * @tags conversations
2618
2632
  * @name ConversationsGet
@@ -2622,7 +2636,7 @@ class Api extends HttpClient {
2622
2636
  */
2623
2637
  this.conversationsGet = (query, params = {}) => this.request(Object.assign({ path: `/conversations.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
2624
2638
  /**
2625
- * @description Gets the requested conversation's information.
2639
+ * @description Gets the requested conversation's information. **Required scopes:** - `conversation:read` OR `conversation:write` OR `conversation:all`
2626
2640
  *
2627
2641
  * @tags conversations
2628
2642
  * @name ConversationsGetPost
@@ -2632,7 +2646,7 @@ class Api extends HttpClient {
2632
2646
  */
2633
2647
  this.conversationsGetPost = (data, params = {}) => this.request(Object.assign({ path: `/conversations.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
2634
2648
  /**
2635
- * @description Lists the available conversations.
2649
+ * @description Lists the available conversations. **Required scopes:** - `conversation:read` OR `conversation:write` OR `conversation:all`
2636
2650
  *
2637
2651
  * @tags conversations
2638
2652
  * @name ConversationsList
@@ -2642,7 +2656,7 @@ class Api extends HttpClient {
2642
2656
  */
2643
2657
  this.conversationsList = (query, params = {}) => this.request(Object.assign({ path: `/conversations.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
2644
2658
  /**
2645
- * @description Lists the available conversations.
2659
+ * @description Lists the available conversations. **Required scopes:** - `conversation:read` OR `conversation:write` OR `conversation:all`
2646
2660
  *
2647
2661
  * @tags conversations
2648
2662
  * @name ConversationsListPost
@@ -2652,7 +2666,7 @@ class Api extends HttpClient {
2652
2666
  */
2653
2667
  this.conversationsListPost = (data, params = {}) => this.request(Object.assign({ path: `/conversations.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
2654
2668
  /**
2655
- * @description Updates the requested conversation.
2669
+ * @description Updates the requested conversation. **Required scopes:** - `conversation:write` OR `conversation:all`
2656
2670
  *
2657
2671
  * @tags conversations
2658
2672
  * @name ConversationsUpdate
@@ -2662,7 +2676,7 @@ class Api extends HttpClient {
2662
2676
  */
2663
2677
  this.conversationsUpdate = (data, params = {}) => this.request(Object.assign({ path: `/conversations.update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
2664
2678
  /**
2665
- * @description Counts custom objects.
2679
+ * @description Counts custom objects. **Required scopes:** No scopes required.
2666
2680
  *
2667
2681
  * @tags customization
2668
2682
  * @name CustomObjectsCount
@@ -2673,7 +2687,7 @@ class Api extends HttpClient {
2673
2687
  */
2674
2688
  this.customObjectsCount = (query, params = {}) => this.request(Object.assign({ path: `/custom-objects.count`, method: 'GET', query: query, secure: true, format: 'json' }, params));
2675
2689
  /**
2676
- * @description Counts custom objects.
2690
+ * @description Counts custom objects. **Required scopes:** No scopes required.
2677
2691
  *
2678
2692
  * @tags customization
2679
2693
  * @name CustomObjectsCountPost
@@ -2684,7 +2698,7 @@ class Api extends HttpClient {
2684
2698
  */
2685
2699
  this.customObjectsCountPost = (data, params = {}) => this.request(Object.assign({ path: `/custom-objects.count`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
2686
2700
  /**
2687
- * @description Creates a custom object.
2701
+ * @description Creates a custom object. **Required scopes:** - `custom_type_fragment:write`
2688
2702
  *
2689
2703
  * @tags customization
2690
2704
  * @name CustomObjectsCreate
@@ -2694,7 +2708,7 @@ class Api extends HttpClient {
2694
2708
  */
2695
2709
  this.customObjectsCreate = (data, params = {}) => this.request(Object.assign({ path: `/custom-objects.create`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
2696
2710
  /**
2697
- * @description Deletes a custom object.
2711
+ * @description Deletes a custom object. **Required scopes:** - `custom_type_fragment:write`
2698
2712
  *
2699
2713
  * @tags customization
2700
2714
  * @name CustomObjectsDelete
@@ -2704,7 +2718,7 @@ class Api extends HttpClient {
2704
2718
  */
2705
2719
  this.customObjectsDelete = (data, params = {}) => this.request(Object.assign({ path: `/custom-objects.delete`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
2706
2720
  /**
2707
- * @description Gets a custom object.
2721
+ * @description Gets a custom object. **Required scopes:** No scopes required.
2708
2722
  *
2709
2723
  * @tags customization
2710
2724
  * @name CustomObjectsGet
@@ -2714,7 +2728,7 @@ class Api extends HttpClient {
2714
2728
  */
2715
2729
  this.customObjectsGet = (query, params = {}) => this.request(Object.assign({ path: `/custom-objects.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
2716
2730
  /**
2717
- * @description Gets a custom object.
2731
+ * @description Gets a custom object. **Required scopes:** No scopes required.
2718
2732
  *
2719
2733
  * @tags customization
2720
2734
  * @name CustomObjectsGetPost
@@ -2724,7 +2738,7 @@ class Api extends HttpClient {
2724
2738
  */
2725
2739
  this.customObjectsGetPost = (data, params = {}) => this.request(Object.assign({ path: `/custom-objects.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
2726
2740
  /**
2727
- * @description Lists custom objects.
2741
+ * @description Lists custom objects. **Required scopes:** No scopes required.
2728
2742
  *
2729
2743
  * @tags customization
2730
2744
  * @name CustomObjectsList
@@ -2735,7 +2749,7 @@ class Api extends HttpClient {
2735
2749
  */
2736
2750
  this.customObjectsList = (query, params = {}) => this.request(Object.assign({ path: `/custom-objects.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
2737
2751
  /**
2738
- * @description Lists custom objects.
2752
+ * @description Lists custom objects. **Required scopes:** No scopes required.
2739
2753
  *
2740
2754
  * @tags customization
2741
2755
  * @name CustomObjectsListPost
@@ -2746,7 +2760,7 @@ class Api extends HttpClient {
2746
2760
  */
2747
2761
  this.customObjectsListPost = (data, params = {}) => this.request(Object.assign({ path: `/custom-objects.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
2748
2762
  /**
2749
- * @description Updates a custom object.
2763
+ * @description Updates a custom object. **Required scopes:** - `custom_type_fragment:write`
2750
2764
  *
2751
2765
  * @tags customization
2752
2766
  * @name CustomObjectsUpdate
@@ -2756,7 +2770,7 @@ class Api extends HttpClient {
2756
2770
  */
2757
2771
  this.customObjectsUpdate = (data, params = {}) => this.request(Object.assign({ path: `/custom-objects.update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
2758
2772
  /**
2759
- * @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`
2773
+ * @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.
2760
2774
  *
2761
2775
  * @tags auth-connections, dev-orgs
2762
2776
  * @name DevOrgAuthConnectionsCreate
@@ -2766,7 +2780,7 @@ class Api extends HttpClient {
2766
2780
  */
2767
2781
  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));
2768
2782
  /**
2769
- * @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`
2783
+ * @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.
2770
2784
  *
2771
2785
  * @tags auth-connections, dev-orgs
2772
2786
  * @name DevOrgAuthConnectionsDelete
@@ -2776,7 +2790,7 @@ class Api extends HttpClient {
2776
2790
  */
2777
2791
  this.devOrgAuthConnectionsDelete = (data, params = {}) => this.request(Object.assign({ path: `/dev-orgs.auth-connections.delete`, method: 'POST', body: data, secure: true, type: ContentType.Json }, params));
2778
2792
  /**
2779
- * @description Retrieves the details for an authentication connection. **Required scopes:** - `dev_org:read`
2793
+ * @description Retrieves the details for an authentication connection. **Required scopes:** - `Cannot be called via service account.`
2780
2794
  *
2781
2795
  * @tags auth-connections, dev-orgs
2782
2796
  * @name DevOrgAuthConnectionsGet
@@ -2786,7 +2800,7 @@ class Api extends HttpClient {
2786
2800
  */
2787
2801
  this.devOrgAuthConnectionsGet = (query, params = {}) => this.request(Object.assign({ path: `/dev-orgs.auth-connections.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
2788
2802
  /**
2789
- * @description Retrieves the details for an authentication connection. **Required scopes:** - `dev_org:read`
2803
+ * @description Retrieves the details for an authentication connection. **Required scopes:** - `Cannot be called via service account.`
2790
2804
  *
2791
2805
  * @tags auth-connections, dev-orgs
2792
2806
  * @name DevOrgAuthConnectionsGetPost
@@ -2796,7 +2810,7 @@ class Api extends HttpClient {
2796
2810
  */
2797
2811
  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));
2798
2812
  /**
2799
- * @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`
2813
+ * @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.
2800
2814
  *
2801
2815
  * @tags auth-connections, dev-orgs
2802
2816
  * @name DevOrgAuthConnectionsList
@@ -2806,7 +2820,7 @@ class Api extends HttpClient {
2806
2820
  */
2807
2821
  this.devOrgAuthConnectionsList = (params = {}) => this.request(Object.assign({ path: `/dev-orgs.auth-connections.list`, method: 'GET', secure: true, format: 'json' }, params));
2808
2822
  /**
2809
- * @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`
2823
+ * @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.
2810
2824
  *
2811
2825
  * @tags auth-connections, dev-orgs
2812
2826
  * @name DevOrgAuthConnectionsListPost
@@ -2816,7 +2830,7 @@ class Api extends HttpClient {
2816
2830
  */
2817
2831
  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));
2818
2832
  /**
2819
- * @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`
2833
+ * @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.
2820
2834
  *
2821
2835
  * @tags auth-connections, dev-orgs
2822
2836
  * @name DevOrgAuthConnectionsToggle
@@ -2826,7 +2840,7 @@ class Api extends HttpClient {
2826
2840
  */
2827
2841
  this.devOrgAuthConnectionsToggle = (data, params = {}) => this.request(Object.assign({ path: `/dev-orgs.auth-connections.toggle`, method: 'POST', body: data, secure: true, type: ContentType.Json }, params));
2828
2842
  /**
2829
- * @description Updates an authentication connection. **Required scopes:** - `dev_org:write`
2843
+ * @description Updates an authentication connection. **Required scopes:** Cannot be called via service account.
2830
2844
  *
2831
2845
  * @tags auth-connections, dev-orgs
2832
2846
  * @name DevOrgAuthConnectionsUpdate
@@ -2836,7 +2850,7 @@ class Api extends HttpClient {
2836
2850
  */
2837
2851
  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));
2838
2852
  /**
2839
- * @description Gets the Dev organization's information of the authenticated user. **Required scopes:** - `dev_org:read`
2853
+ * @description Gets the Dev organization's information of the authenticated user. **Required scopes:** - `dev_org:read` OR `dev_org:write`
2840
2854
  *
2841
2855
  * @tags dev-orgs
2842
2856
  * @name DevOrgsGet
@@ -2846,7 +2860,7 @@ class Api extends HttpClient {
2846
2860
  */
2847
2861
  this.devOrgsGet = (params = {}) => this.request(Object.assign({ path: `/dev-orgs.get`, method: 'GET', secure: true, format: 'json' }, params));
2848
2862
  /**
2849
- * @description Gets the Dev organization's information of the authenticated user. **Required scopes:** - `dev_org:read`
2863
+ * @description Gets the Dev organization's information of the authenticated user. **Required scopes:** - `dev_org:read` OR `dev_org:write`
2850
2864
  *
2851
2865
  * @tags dev-orgs
2852
2866
  * @name DevOrgsGetPost
@@ -2856,7 +2870,7 @@ class Api extends HttpClient {
2856
2870
  */
2857
2871
  this.devOrgsGetPost = (data, params = {}) => this.request(Object.assign({ path: `/dev-orgs.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
2858
2872
  /**
2859
- * @description Activates the requested user. **Required scopes:** - `dev_user:write`
2873
+ * @description Activates the requested user. **Required scopes:** - `dev_user:write` OR `dev_user:all`
2860
2874
  *
2861
2875
  * @tags dev-users
2862
2876
  * @name DevUsersActivate
@@ -2866,7 +2880,7 @@ class Api extends HttpClient {
2866
2880
  */
2867
2881
  this.devUsersActivate = (data, params = {}) => this.request(Object.assign({ path: `/dev-users.activate`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
2868
2882
  /**
2869
- * @description Creates a Dev user for a Dev organization. **Required scopes:** - `dev_user:write`
2883
+ * @description Creates a Dev user for a Dev organization. **Required scopes:** - `dev_user:write` OR `dev_user:all`
2870
2884
  *
2871
2885
  * @tags dev-users
2872
2886
  * @name DevUsersCreate
@@ -2886,7 +2900,7 @@ class Api extends HttpClient {
2886
2900
  */
2887
2901
  this.devUsersDeactivate = (data, params = {}) => this.request(Object.assign({ path: `/dev-users.deactivate`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
2888
2902
  /**
2889
- * @description Gets the requested user's information. **Required scopes:** - `dev_user:read`
2903
+ * @description Gets the requested user's information. **Required scopes:** - `dev_user:read` OR `dev_user:write` OR `dev_user:all`
2890
2904
  *
2891
2905
  * @tags dev-users
2892
2906
  * @name DevUsersGet
@@ -2896,7 +2910,7 @@ class Api extends HttpClient {
2896
2910
  */
2897
2911
  this.devUsersGet = (query, params = {}) => this.request(Object.assign({ path: `/dev-users.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
2898
2912
  /**
2899
- * @description Gets the requested user's information. **Required scopes:** - `dev_user:read`
2913
+ * @description Gets the requested user's information. **Required scopes:** - `dev_user:read` OR `dev_user:write` OR `dev_user:all`
2900
2914
  *
2901
2915
  * @tags dev-users
2902
2916
  * @name DevUsersGetPost
@@ -2906,7 +2920,7 @@ class Api extends HttpClient {
2906
2920
  */
2907
2921
  this.devUsersGetPost = (data, params = {}) => this.request(Object.assign({ path: `/dev-users.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
2908
2922
  /**
2909
- * @description Links an external/secondary identity to the Dev user. **Required scopes:** - `dev_user:write`
2923
+ * @description Links an external/secondary identity to the Dev user. **Required scopes:** - `dev_user:write` OR `dev_user:all`
2910
2924
  *
2911
2925
  * @tags dev-users
2912
2926
  * @name DevUsersIdentitiesLink
@@ -2916,7 +2930,7 @@ class Api extends HttpClient {
2916
2930
  */
2917
2931
  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));
2918
2932
  /**
2919
- * @description Unlinks an external/secondary identity from the Dev user. **Required scopes:** - `dev_user:write`
2933
+ * @description Unlinks an external/secondary identity from the Dev user. **Required scopes:** - `dev_user:write` OR `dev_user:all`
2920
2934
  *
2921
2935
  * @tags dev-users
2922
2936
  * @name DevUsersIdentitiesUnlink
@@ -2926,7 +2940,7 @@ class Api extends HttpClient {
2926
2940
  */
2927
2941
  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));
2928
2942
  /**
2929
- * @description Lists users within your organization. **Required scopes:** - `dev_user:read`
2943
+ * @description Lists users within your organization. **Required scopes:** - `dev_user:read` OR `dev_user:write` OR `dev_user:all`
2930
2944
  *
2931
2945
  * @tags dev-users
2932
2946
  * @name DevUsersList
@@ -2936,7 +2950,7 @@ class Api extends HttpClient {
2936
2950
  */
2937
2951
  this.devUsersList = (query, params = {}) => this.request(Object.assign({ path: `/dev-users.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
2938
2952
  /**
2939
- * @description Lists users within your organization. **Required scopes:** - `dev_user:read`
2953
+ * @description Lists users within your organization. **Required scopes:** - `dev_user:read` OR `dev_user:write` OR `dev_user:all`
2940
2954
  *
2941
2955
  * @tags dev-users
2942
2956
  * @name DevUsersListPost
@@ -2956,7 +2970,7 @@ class Api extends HttpClient {
2956
2970
  */
2957
2971
  this.devUsersMerge = (data, params = {}) => this.request(Object.assign({ path: `/dev-users.merge`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
2958
2972
  /**
2959
- * @description Gets the authenticated user's information. **Required scopes:** No scopes required
2973
+ * @description Gets the authenticated user's information. **Required scopes:** Default Scopes unavailable for this API
2960
2974
  *
2961
2975
  * @tags dev-users
2962
2976
  * @name DevUsersSelf
@@ -2966,7 +2980,7 @@ class Api extends HttpClient {
2966
2980
  */
2967
2981
  this.devUsersSelf = (params = {}) => this.request(Object.assign({ path: `/dev-users.self`, method: 'GET', secure: true, format: 'json' }, params));
2968
2982
  /**
2969
- * @description Gets the authenticated user's information. **Required scopes:** No scopes required
2983
+ * @description Gets the authenticated user's information. **Required scopes:** Default Scopes unavailable for this API
2970
2984
  *
2971
2985
  * @tags dev-users
2972
2986
  * @name DevUsersSelfPost
@@ -2976,7 +2990,7 @@ class Api extends HttpClient {
2976
2990
  */
2977
2991
  this.devUsersSelfPost = (data, params = {}) => this.request(Object.assign({ path: `/dev-users.self`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
2978
2992
  /**
2979
- * @description Updates the authenticated user. **Required scopes:** No scopes required
2993
+ * @description Updates the authenticated user. **Required scopes:** Default Scopes unavailable for this API
2980
2994
  *
2981
2995
  * @tags dev-users
2982
2996
  * @name DevUsersSelfUpdate
@@ -2986,7 +3000,7 @@ class Api extends HttpClient {
2986
3000
  */
2987
3001
  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));
2988
3002
  /**
2989
- * @description Updates the user corresponding to the input Id. **Required scopes:** - `dev_user:write`
3003
+ * @description Updates the user corresponding to the input Id. **Required scopes:** - `dev_user:write` OR `dev_user:all`
2990
3004
  *
2991
3005
  * @tags dev-users
2992
3006
  * @name DevUsersUpdate
@@ -2996,7 +3010,7 @@ class Api extends HttpClient {
2996
3010
  */
2997
3011
  this.devUsersUpdate = (data, params = {}) => this.request(Object.assign({ path: `/dev-users.update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
2998
3012
  /**
2999
- * @description Get count of directories matching given filter.
3013
+ * @description Get count of directories matching given filter. **Required scopes:** - `directory:read` OR `directory:write` OR `directory:all`
3000
3014
  *
3001
3015
  * @tags directory
3002
3016
  * @name DirectoriesCount
@@ -3006,7 +3020,7 @@ class Api extends HttpClient {
3006
3020
  */
3007
3021
  this.directoriesCount = (query, params = {}) => this.request(Object.assign({ path: `/directories.count`, method: 'GET', query: query, secure: true, format: 'json' }, params));
3008
3022
  /**
3009
- * @description Get count of directories matching given filter.
3023
+ * @description Get count of directories matching given filter. **Required scopes:** - `directory:read` OR `directory:write` OR `directory:all`
3010
3024
  *
3011
3025
  * @tags directory
3012
3026
  * @name DirectoriesCountPost
@@ -3016,7 +3030,7 @@ class Api extends HttpClient {
3016
3030
  */
3017
3031
  this.directoriesCountPost = (data, params = {}) => this.request(Object.assign({ path: `/directories.count`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
3018
3032
  /**
3019
- * @description Creates a directory for the specified inputs.
3033
+ * @description Creates a directory for the specified inputs. **Required scopes:** - `directory:write` OR `directory:all`
3020
3034
  *
3021
3035
  * @tags directory
3022
3036
  * @name DirectoriesCreate
@@ -3026,7 +3040,7 @@ class Api extends HttpClient {
3026
3040
  */
3027
3041
  this.directoriesCreate = (data, params = {}) => this.request(Object.assign({ path: `/directories.create`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
3028
3042
  /**
3029
- * @description Delete the specified directory.
3043
+ * @description Delete the specified directory. **Required scopes:** - `directory:all`
3030
3044
  *
3031
3045
  * @tags directory
3032
3046
  * @name DirectoriesDelete
@@ -3036,7 +3050,7 @@ class Api extends HttpClient {
3036
3050
  */
3037
3051
  this.directoriesDelete = (data, params = {}) => this.request(Object.assign({ path: `/directories.delete`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
3038
3052
  /**
3039
- * @description Gets the specified directory.
3053
+ * @description Gets the specified directory. **Required scopes:** - `directory:read` OR `directory:write` OR `directory:all`
3040
3054
  *
3041
3055
  * @tags directory
3042
3056
  * @name DirectoriesGet
@@ -3046,7 +3060,7 @@ class Api extends HttpClient {
3046
3060
  */
3047
3061
  this.directoriesGet = (query, params = {}) => this.request(Object.assign({ path: `/directories.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
3048
3062
  /**
3049
- * @description Gets the specified directory.
3063
+ * @description Gets the specified directory. **Required scopes:** - `directory:read` OR `directory:write` OR `directory:all`
3050
3064
  *
3051
3065
  * @tags directory
3052
3066
  * @name DirectoriesGetPost
@@ -3056,7 +3070,7 @@ class Api extends HttpClient {
3056
3070
  */
3057
3071
  this.directoriesGetPost = (data, params = {}) => this.request(Object.assign({ path: `/directories.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
3058
3072
  /**
3059
- * @description Lists directories matching the request.
3073
+ * @description Lists directories matching the request. **Required scopes:** - `directory:read` OR `directory:write` OR `directory:all`
3060
3074
  *
3061
3075
  * @tags directory
3062
3076
  * @name DirectoriesList
@@ -3066,7 +3080,7 @@ class Api extends HttpClient {
3066
3080
  */
3067
3081
  this.directoriesList = (query, params = {}) => this.request(Object.assign({ path: `/directories.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
3068
3082
  /**
3069
- * @description Lists directories matching the request.
3083
+ * @description Lists directories matching the request. **Required scopes:** - `directory:read` OR `directory:write` OR `directory:all`
3070
3084
  *
3071
3085
  * @tags directory
3072
3086
  * @name DirectoriesListPost
@@ -3076,7 +3090,7 @@ class Api extends HttpClient {
3076
3090
  */
3077
3091
  this.directoriesListPost = (data, params = {}) => this.request(Object.assign({ path: `/directories.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
3078
3092
  /**
3079
- * @description Updates the specified directory.
3093
+ * @description Updates the specified directory. **Required scopes:** - `directory:write` OR `directory:all`
3080
3094
  *
3081
3095
  * @tags directory
3082
3096
  * @name DirectoriesUpdate
@@ -3086,7 +3100,7 @@ class Api extends HttpClient {
3086
3100
  */
3087
3101
  this.directoriesUpdate = (data, params = {}) => this.request(Object.assign({ path: `/directories.update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
3088
3102
  /**
3089
- * @description Creates a new group. A group is a collection of users. **Required scopes:** - `group:write`
3103
+ * @description Creates a new group. A group is a collection of users. **Required scopes:** - `group:write` OR `group:all`
3090
3104
  *
3091
3105
  * @tags groups
3092
3106
  * @name GroupsCreate
@@ -3096,7 +3110,7 @@ class Api extends HttpClient {
3096
3110
  */
3097
3111
  this.groupsCreate = (data, params = {}) => this.request(Object.assign({ path: `/groups.create`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
3098
3112
  /**
3099
- * @description Gets the requested group. **Required scopes:** - `group:read`
3113
+ * @description Gets the requested group. **Required scopes:** - `group:read` OR `group:write` OR `group:all`
3100
3114
  *
3101
3115
  * @tags groups
3102
3116
  * @name GroupsGet
@@ -3106,7 +3120,7 @@ class Api extends HttpClient {
3106
3120
  */
3107
3121
  this.groupsGet = (query, params = {}) => this.request(Object.assign({ path: `/groups.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
3108
3122
  /**
3109
- * @description Gets the requested group. **Required scopes:** - `group:read`
3123
+ * @description Gets the requested group. **Required scopes:** - `group:read` OR `group:write` OR `group:all`
3110
3124
  *
3111
3125
  * @tags groups
3112
3126
  * @name GroupsGetPost
@@ -3116,7 +3130,7 @@ class Api extends HttpClient {
3116
3130
  */
3117
3131
  this.groupsGetPost = (data, params = {}) => this.request(Object.assign({ path: `/groups.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
3118
3132
  /**
3119
- * @description Lists the available groups. **Required scopes:** - `group:read`
3133
+ * @description Lists the available groups. **Required scopes:** - `group:read` OR `group:write` OR `group:all`
3120
3134
  *
3121
3135
  * @tags groups
3122
3136
  * @name GroupsList
@@ -3126,7 +3140,7 @@ class Api extends HttpClient {
3126
3140
  */
3127
3141
  this.groupsList = (query, params = {}) => this.request(Object.assign({ path: `/groups.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
3128
3142
  /**
3129
- * @description Lists the available groups. **Required scopes:** - `group:read`
3143
+ * @description Lists the available groups. **Required scopes:** - `group:read` OR `group:write` OR `group:all`
3130
3144
  *
3131
3145
  * @tags groups
3132
3146
  * @name GroupsListPost
@@ -3136,7 +3150,7 @@ class Api extends HttpClient {
3136
3150
  */
3137
3151
  this.groupsListPost = (data, params = {}) => this.request(Object.assign({ path: `/groups.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
3138
3152
  /**
3139
- * @description Adds a member to a group. **Required scopes:** - `group_membership:write`
3153
+ * @description Adds a member to a group. **Required scopes:** - `group_membership:all`
3140
3154
  *
3141
3155
  * @tags groups
3142
3156
  * @name GroupMembersAdd
@@ -3146,7 +3160,7 @@ class Api extends HttpClient {
3146
3160
  */
3147
3161
  this.groupMembersAdd = (data, params = {}) => this.request(Object.assign({ path: `/groups.members.add`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
3148
3162
  /**
3149
- * @description Lists the members in a group. **Required scopes:** - `group_membership:read`
3163
+ * @description Lists the members in a group. **Required scopes:** - `group_membership:read` OR `group_membership:all`
3150
3164
  *
3151
3165
  * @tags groups
3152
3166
  * @name GroupMembersList
@@ -3156,7 +3170,7 @@ class Api extends HttpClient {
3156
3170
  */
3157
3171
  this.groupMembersList = (query, params = {}) => this.request(Object.assign({ path: `/groups.members.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
3158
3172
  /**
3159
- * @description Lists the members in a group. **Required scopes:** - `group_membership:read`
3173
+ * @description Lists the members in a group. **Required scopes:** - `group_membership:read` OR `group_membership:all`
3160
3174
  *
3161
3175
  * @tags groups
3162
3176
  * @name GroupMembersListPost
@@ -3166,7 +3180,7 @@ class Api extends HttpClient {
3166
3180
  */
3167
3181
  this.groupMembersListPost = (data, params = {}) => this.request(Object.assign({ path: `/groups.members.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
3168
3182
  /**
3169
- * @description Removes a member from a group. **Required scopes:** - `group_membership:write`
3183
+ * @description Removes a member from a group. **Required scopes:** - `group_membership:all`
3170
3184
  *
3171
3185
  * @tags groups
3172
3186
  * @name GroupMembersRemove
@@ -3176,7 +3190,7 @@ class Api extends HttpClient {
3176
3190
  */
3177
3191
  this.groupMembersRemove = (data, params = {}) => this.request(Object.assign({ path: `/groups.members.remove`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
3178
3192
  /**
3179
- * @description Updates the requested group. **Required scopes:** - `group:write`
3193
+ * @description Updates the requested group. **Required scopes:** - `group:write` OR `group:all`
3180
3194
  *
3181
3195
  * @tags groups
3182
3196
  * @name GroupsUpdate
@@ -3186,7 +3200,7 @@ class Api extends HttpClient {
3186
3200
  */
3187
3201
  this.groupsUpdate = (data, params = {}) => this.request(Object.assign({ path: `/groups.update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
3188
3202
  /**
3189
- * @description Retrieves a job's information.
3203
+ * @description Retrieves a job's information. **Required scopes:** - `job:read`
3190
3204
  *
3191
3205
  * @tags jobs
3192
3206
  * @name GetJob
@@ -3196,7 +3210,7 @@ class Api extends HttpClient {
3196
3210
  */
3197
3211
  this.getJob = (query, params = {}) => this.request(Object.assign({ path: `/jobs.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
3198
3212
  /**
3199
- * @description Retrieves a job's information.
3213
+ * @description Retrieves a job's information. **Required scopes:** - `job:read`
3200
3214
  *
3201
3215
  * @tags jobs
3202
3216
  * @name GetJobPost
@@ -3206,7 +3220,7 @@ class Api extends HttpClient {
3206
3220
  */
3207
3221
  this.getJobPost = (data, params = {}) => this.request(Object.assign({ path: `/jobs.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
3208
3222
  /**
3209
- * @description Gets a list of jobs.
3223
+ * @description Gets a list of jobs. **Required scopes:** - `job:read`
3210
3224
  *
3211
3225
  * @tags jobs
3212
3226
  * @name ListJobs
@@ -3216,7 +3230,7 @@ class Api extends HttpClient {
3216
3230
  */
3217
3231
  this.listJobs = (query, params = {}) => this.request(Object.assign({ path: `/jobs.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
3218
3232
  /**
3219
- * @description Gets a list of jobs.
3233
+ * @description Gets a list of jobs. **Required scopes:** - `job:read`
3220
3234
  *
3221
3235
  * @tags jobs
3222
3236
  * @name ListJobsPost
@@ -3226,7 +3240,7 @@ class Api extends HttpClient {
3226
3240
  */
3227
3241
  this.listJobsPost = (data, params = {}) => this.request(Object.assign({ path: `/jobs.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
3228
3242
  /**
3229
- * @description OAuth2 authorization callback.
3243
+ * @description OAuth2 authorization callback. **Required scopes:** - `keyring:read`
3230
3244
  *
3231
3245
  * @tags keyrings
3232
3246
  * @name KeyringsCreateCallback
@@ -3235,7 +3249,7 @@ class Api extends HttpClient {
3235
3249
  */
3236
3250
  this.keyringsCreateCallback = (query, params = {}) => this.request(Object.assign({ path: `/keyrings.authorize`, method: 'GET', query: query }, params));
3237
3251
  /**
3238
- * @description OAuth2 authorization callback.
3252
+ * @description OAuth2 authorization callback. **Required scopes:** - `keyring:read`
3239
3253
  *
3240
3254
  * @tags keyrings
3241
3255
  * @name KeyringsCreateCallbackPost
@@ -3245,7 +3259,7 @@ class Api extends HttpClient {
3245
3259
  */
3246
3260
  this.keyringsCreateCallbackPost = (data, params = {}) => this.request(Object.assign({ path: `/keyrings.authorize`, method: 'POST', body: data, secure: true, type: ContentType.Json }, params));
3247
3261
  /**
3248
- * @description Creates a link between two objects to indicate a relationship.
3262
+ * @description Creates a link between two objects to indicate a relationship. **Required scopes:** - `link:write` OR `link:all` Also needs linked objects read access.
3249
3263
  *
3250
3264
  * @tags links
3251
3265
  * @name LinksCreate
@@ -3255,7 +3269,7 @@ class Api extends HttpClient {
3255
3269
  */
3256
3270
  this.linksCreate = (data, params = {}) => this.request(Object.assign({ path: `/links.create`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
3257
3271
  /**
3258
- * @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.
3272
+ * @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.
3259
3273
  *
3260
3274
  * @tags links
3261
3275
  * @name LinksDelete
@@ -3265,7 +3279,7 @@ class Api extends HttpClient {
3265
3279
  */
3266
3280
  this.linksDelete = (data, params = {}) => this.request(Object.assign({ path: `/links.delete`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
3267
3281
  /**
3268
- * @description Gets the requested link's information.
3282
+ * @description Gets the requested link's information. **Required scopes:** - `link:read` OR `link:write` OR `link:all`
3269
3283
  *
3270
3284
  * @tags links
3271
3285
  * @name LinksGet
@@ -3275,7 +3289,7 @@ class Api extends HttpClient {
3275
3289
  */
3276
3290
  this.linksGet = (query, params = {}) => this.request(Object.assign({ path: `/links.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
3277
3291
  /**
3278
- * @description Gets the requested link's information.
3292
+ * @description Gets the requested link's information. **Required scopes:** - `link:read` OR `link:write` OR `link:all`
3279
3293
  *
3280
3294
  * @tags links
3281
3295
  * @name LinksGetPost
@@ -3285,7 +3299,7 @@ class Api extends HttpClient {
3285
3299
  */
3286
3300
  this.linksGetPost = (data, params = {}) => this.request(Object.assign({ path: `/links.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
3287
3301
  /**
3288
- * @description Lists the available links.
3302
+ * @description Lists the available links. **Required scopes:** - `link:read` OR `link:write` OR `link:all`
3289
3303
  *
3290
3304
  * @tags links
3291
3305
  * @name LinksList
@@ -3295,7 +3309,7 @@ class Api extends HttpClient {
3295
3309
  */
3296
3310
  this.linksList = (query, params = {}) => this.request(Object.assign({ path: `/links.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
3297
3311
  /**
3298
- * @description Lists the available links.
3312
+ * @description Lists the available links. **Required scopes:** - `link:read` OR `link:write` OR `link:all`
3299
3313
  *
3300
3314
  * @tags links
3301
3315
  * @name LinksListPost
@@ -3305,7 +3319,7 @@ class Api extends HttpClient {
3305
3319
  */
3306
3320
  this.linksListPost = (data, params = {}) => this.request(Object.assign({ path: `/links.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
3307
3321
  /**
3308
- * @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.
3322
+ * @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.
3309
3323
  *
3310
3324
  * @tags links
3311
3325
  * @name LinksReplace
@@ -3315,7 +3329,7 @@ class Api extends HttpClient {
3315
3329
  */
3316
3330
  this.linksReplace = (data, params = {}) => this.request(Object.assign({ path: `/links.replace`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
3317
3331
  /**
3318
- * @description Counts the meeting records.
3332
+ * @description Counts the meeting records. **Required scopes:** - `meeting:read` OR `meeting:write` OR `meeting:all`
3319
3333
  *
3320
3334
  * @tags meetings
3321
3335
  * @name MeetingsCount
@@ -3325,7 +3339,7 @@ class Api extends HttpClient {
3325
3339
  */
3326
3340
  this.meetingsCount = (query, params = {}) => this.request(Object.assign({ path: `/meetings.count`, method: 'GET', query: query, secure: true, format: 'json' }, params));
3327
3341
  /**
3328
- * @description Counts the meeting records.
3342
+ * @description Counts the meeting records. **Required scopes:** - `meeting:read` OR `meeting:write` OR `meeting:all`
3329
3343
  *
3330
3344
  * @tags meetings
3331
3345
  * @name MeetingsCountPost
@@ -3335,7 +3349,7 @@ class Api extends HttpClient {
3335
3349
  */
3336
3350
  this.meetingsCountPost = (data, params = {}) => this.request(Object.assign({ path: `/meetings.count`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
3337
3351
  /**
3338
- * @description Creates a new meeting record.
3352
+ * @description Creates a new meeting record. **Required scopes:** - `meeting:write` OR `meeting:all`
3339
3353
  *
3340
3354
  * @tags meetings
3341
3355
  * @name MeetingsCreate
@@ -3345,7 +3359,7 @@ class Api extends HttpClient {
3345
3359
  */
3346
3360
  this.meetingsCreate = (data, params = {}) => this.request(Object.assign({ path: `/meetings.create`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
3347
3361
  /**
3348
- * @description Deletes the meeting record.
3362
+ * @description Deletes the meeting record. **Required scopes:** - `meeting:all`
3349
3363
  *
3350
3364
  * @tags meetings
3351
3365
  * @name MeetingsDelete
@@ -3355,7 +3369,7 @@ class Api extends HttpClient {
3355
3369
  */
3356
3370
  this.meetingsDelete = (data, params = {}) => this.request(Object.assign({ path: `/meetings.delete`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
3357
3371
  /**
3358
- * @description Gets the meeting record.
3372
+ * @description Gets the meeting record. **Required scopes:** - `meeting:read` OR `meeting:write` OR `meeting:all`
3359
3373
  *
3360
3374
  * @tags meetings
3361
3375
  * @name MeetingsGet
@@ -3365,7 +3379,7 @@ class Api extends HttpClient {
3365
3379
  */
3366
3380
  this.meetingsGet = (query, params = {}) => this.request(Object.assign({ path: `/meetings.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
3367
3381
  /**
3368
- * @description Gets the meeting record.
3382
+ * @description Gets the meeting record. **Required scopes:** - `meeting:read` OR `meeting:write` OR `meeting:all`
3369
3383
  *
3370
3384
  * @tags meetings
3371
3385
  * @name MeetingsGetPost
@@ -3375,7 +3389,7 @@ class Api extends HttpClient {
3375
3389
  */
3376
3390
  this.meetingsGetPost = (data, params = {}) => this.request(Object.assign({ path: `/meetings.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
3377
3391
  /**
3378
- * @description Lists the meeting records.
3392
+ * @description Lists the meeting records. **Required scopes:** - `meeting:read` OR `meeting:write` OR `meeting:all`
3379
3393
  *
3380
3394
  * @tags meetings
3381
3395
  * @name MeetingsList
@@ -3385,7 +3399,7 @@ class Api extends HttpClient {
3385
3399
  */
3386
3400
  this.meetingsList = (query, params = {}) => this.request(Object.assign({ path: `/meetings.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
3387
3401
  /**
3388
- * @description Lists the meeting records.
3402
+ * @description Lists the meeting records. **Required scopes:** - `meeting:read` OR `meeting:write` OR `meeting:all`
3389
3403
  *
3390
3404
  * @tags meetings
3391
3405
  * @name MeetingsListPost
@@ -3395,7 +3409,7 @@ class Api extends HttpClient {
3395
3409
  */
3396
3410
  this.meetingsListPost = (data, params = {}) => this.request(Object.assign({ path: `/meetings.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
3397
3411
  /**
3398
- * @description Updates the meeting record.
3412
+ * @description Updates the meeting record. **Required scopes:** - `meeting:write` OR `meeting:all`
3399
3413
  *
3400
3414
  * @tags meetings
3401
3415
  * @name MeetingsUpdate
@@ -3405,7 +3419,7 @@ class Api extends HttpClient {
3405
3419
  */
3406
3420
  this.meetingsUpdate = (data, params = {}) => this.request(Object.assign({ path: `/meetings.update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
3407
3421
  /**
3408
- * @description Executes the metric action on the given object.
3422
+ * @description Executes the metric action on the given object. **Required scopes:** No scopes required.
3409
3423
  *
3410
3424
  * @tags slas
3411
3425
  * @name MetricActionExecute
@@ -3415,7 +3429,7 @@ class Api extends HttpClient {
3415
3429
  */
3416
3430
  this.metricActionExecute = (data, params = {}) => this.request(Object.assign({ path: `/metric-action.execute`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
3417
3431
  /**
3418
- * @description Creates a custom metric definition
3432
+ * @description Creates a custom metric definition **Required scopes:** - `metric_definition:write` OR `metric_definition:all`
3419
3433
  *
3420
3434
  * @tags slas
3421
3435
  * @name MetricDefinitionsCreate
@@ -3425,7 +3439,7 @@ class Api extends HttpClient {
3425
3439
  */
3426
3440
  this.metricDefinitionsCreate = (data, params = {}) => this.request(Object.assign({ path: `/metric-definitions.create`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
3427
3441
  /**
3428
- * @description Deletes a custom metric definition
3442
+ * @description Deletes a custom metric definition **Required scopes:** - `metric_definition:all`
3429
3443
  *
3430
3444
  * @tags slas
3431
3445
  * @name MetricDefinitionsDelete
@@ -3435,7 +3449,7 @@ class Api extends HttpClient {
3435
3449
  */
3436
3450
  this.metricDefinitionsDelete = (data, params = {}) => this.request(Object.assign({ path: `/metric-definitions.delete`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
3437
3451
  /**
3438
- * @description Gets a custom metric definition
3452
+ * @description Gets a custom metric definition **Required scopes:** - `metric_definition:read` OR `metric_definition:write` OR `metric_definition:all`
3439
3453
  *
3440
3454
  * @tags slas
3441
3455
  * @name MetricDefinitionsGet
@@ -3445,7 +3459,7 @@ class Api extends HttpClient {
3445
3459
  */
3446
3460
  this.metricDefinitionsGet = (query, params = {}) => this.request(Object.assign({ path: `/metric-definitions.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
3447
3461
  /**
3448
- * @description Gets a custom metric definition
3462
+ * @description Gets a custom metric definition **Required scopes:** - `metric_definition:read` OR `metric_definition:write` OR `metric_definition:all`
3449
3463
  *
3450
3464
  * @tags slas
3451
3465
  * @name MetricDefinitionsGetPost
@@ -3455,7 +3469,7 @@ class Api extends HttpClient {
3455
3469
  */
3456
3470
  this.metricDefinitionsGetPost = (data, params = {}) => this.request(Object.assign({ path: `/metric-definitions.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
3457
3471
  /**
3458
- * @description Lists metric definitions matching a filter.
3472
+ * @description Lists metric definitions matching a filter. **Required scopes:** - `metric_definition:read` OR `metric_definition:write` OR `metric_definition:all`
3459
3473
  *
3460
3474
  * @tags slas
3461
3475
  * @name MetricDefinitionsList
@@ -3465,7 +3479,7 @@ class Api extends HttpClient {
3465
3479
  */
3466
3480
  this.metricDefinitionsList = (query, params = {}) => this.request(Object.assign({ path: `/metric-definitions.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
3467
3481
  /**
3468
- * @description Lists metric definitions matching a filter.
3482
+ * @description Lists metric definitions matching a filter. **Required scopes:** - `metric_definition:read` OR `metric_definition:write` OR `metric_definition:all`
3469
3483
  *
3470
3484
  * @tags slas
3471
3485
  * @name MetricDefinitionsListPost
@@ -3475,7 +3489,7 @@ class Api extends HttpClient {
3475
3489
  */
3476
3490
  this.metricDefinitionsListPost = (data, params = {}) => this.request(Object.assign({ path: `/metric-definitions.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
3477
3491
  /**
3478
- * @description Updates a custom metric definition
3492
+ * @description Updates a custom metric definition **Required scopes:** - `metric_definition:write` OR `metric_definition:all`
3479
3493
  *
3480
3494
  * @tags slas
3481
3495
  * @name MetricDefinitionsUpdate
@@ -3485,7 +3499,7 @@ class Api extends HttpClient {
3485
3499
  */
3486
3500
  this.metricDefinitionsUpdate = (data, params = {}) => this.request(Object.assign({ path: `/metric-definitions.update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
3487
3501
  /**
3488
- * @description Gets a metric tracker.
3502
+ * @description Gets a metric tracker. **Required scopes:** No scopes required.
3489
3503
  *
3490
3504
  * @tags slas
3491
3505
  * @name MetricTrackersGet
@@ -3495,7 +3509,7 @@ class Api extends HttpClient {
3495
3509
  */
3496
3510
  this.metricTrackersGet = (query, params = {}) => this.request(Object.assign({ path: `/metric-trackers.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
3497
3511
  /**
3498
- * @description Gets a metric tracker.
3512
+ * @description Gets a metric tracker. **Required scopes:** No scopes required.
3499
3513
  *
3500
3514
  * @tags slas
3501
3515
  * @name MetricTrackersGetPost
@@ -3505,7 +3519,7 @@ class Api extends HttpClient {
3505
3519
  */
3506
3520
  this.metricTrackersGetPost = (data, params = {}) => this.request(Object.assign({ path: `/metric-trackers.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
3507
3521
  /**
3508
- * @description Aggregates the sessions data.
3522
+ * @description Aggregates the sessions data. **Required scopes:** No scopes required.
3509
3523
  *
3510
3524
  * @tags observability
3511
3525
  * @name ObservabilitySessionsAggregate
@@ -3515,7 +3529,7 @@ class Api extends HttpClient {
3515
3529
  */
3516
3530
  this.observabilitySessionsAggregate = (data, params = {}) => this.request(Object.assign({ path: `/observability.sessions.aggregate`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
3517
3531
  /**
3518
- * @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.
3532
+ * @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.
3519
3533
  *
3520
3534
  * @tags observability
3521
3535
  * @name ObservabilitySessionsDataGet
@@ -3525,7 +3539,7 @@ class Api extends HttpClient {
3525
3539
  */
3526
3540
  this.observabilitySessionsDataGet = (query, params = {}) => this.request(Object.assign({ path: `/observability.sessions.data.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
3527
3541
  /**
3528
- * @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.
3542
+ * @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.
3529
3543
  *
3530
3544
  * @tags observability
3531
3545
  * @name ObservabilitySessionsDataGetPost
@@ -3535,7 +3549,7 @@ class Api extends HttpClient {
3535
3549
  */
3536
3550
  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));
3537
3551
  /**
3538
- * @description Retrieves detailed console and network data for debugging.
3552
+ * @description Retrieves detailed console and network data for debugging. **Required scopes:** No scopes required.
3539
3553
  *
3540
3554
  * @tags observability
3541
3555
  * @name ObservabilitySessionsDeveloperInfoGet
@@ -3545,7 +3559,7 @@ class Api extends HttpClient {
3545
3559
  */
3546
3560
  this.observabilitySessionsDeveloperInfoGet = (query, params = {}) => this.request(Object.assign({ path: `/observability.sessions.developer-info.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
3547
3561
  /**
3548
- * @description Retrieves detailed console and network data for debugging.
3562
+ * @description Retrieves detailed console and network data for debugging. **Required scopes:** No scopes required.
3549
3563
  *
3550
3564
  * @tags observability
3551
3565
  * @name ObservabilitySessionsDeveloperInfoGetPost
@@ -3555,7 +3569,7 @@ class Api extends HttpClient {
3555
3569
  */
3556
3570
  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));
3557
3571
  /**
3558
- * @description Gets a specific session metadata by ID.
3572
+ * @description Gets a specific session metadata by ID. **Required scopes:** No scopes required.
3559
3573
  *
3560
3574
  * @tags observability
3561
3575
  * @name ObservabilitySessionsGet
@@ -3565,7 +3579,7 @@ class Api extends HttpClient {
3565
3579
  */
3566
3580
  this.observabilitySessionsGet = (query, params = {}) => this.request(Object.assign({ path: `/observability.sessions.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
3567
3581
  /**
3568
- * @description Gets a specific session metadata by ID.
3582
+ * @description Gets a specific session metadata by ID. **Required scopes:** No scopes required.
3569
3583
  *
3570
3584
  * @tags observability
3571
3585
  * @name ObservabilitySessionsGetPost
@@ -3575,7 +3589,7 @@ class Api extends HttpClient {
3575
3589
  */
3576
3590
  this.observabilitySessionsGetPost = (data, params = {}) => this.request(Object.assign({ path: `/observability.sessions.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
3577
3591
  /**
3578
- * @description Lists sessions based on filter criteria.
3592
+ * @description Lists sessions based on filter criteria. **Required scopes:** No scopes required.
3579
3593
  *
3580
3594
  * @tags observability
3581
3595
  * @name ObservabilitySessionsList
@@ -3585,7 +3599,7 @@ class Api extends HttpClient {
3585
3599
  */
3586
3600
  this.observabilitySessionsList = (query, params = {}) => this.request(Object.assign({ path: `/observability.sessions.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
3587
3601
  /**
3588
- * @description Lists sessions based on filter criteria.
3602
+ * @description Lists sessions based on filter criteria. **Required scopes:** No scopes required.
3589
3603
  *
3590
3604
  * @tags observability
3591
3605
  * @name ObservabilitySessionsListPost
@@ -3595,7 +3609,7 @@ class Api extends HttpClient {
3595
3609
  */
3596
3610
  this.observabilitySessionsListPost = (data, params = {}) => this.request(Object.assign({ path: `/observability.sessions.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
3597
3611
  /**
3598
- * @description Creates an organization schedule fragment.
3612
+ * @description Creates an organization schedule fragment. **Required scopes:** - `org_schedule_fragment:write` OR `org_schedule_fragment:all`
3599
3613
  *
3600
3614
  * @tags schedules
3601
3615
  * @name OrgScheduleFragmentsCreate
@@ -3605,7 +3619,7 @@ class Api extends HttpClient {
3605
3619
  */
3606
3620
  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));
3607
3621
  /**
3608
- * @description Gets an organization schedule fragment.
3622
+ * @description Gets an organization schedule fragment. **Required scopes:** - `org_schedule_fragment:read` OR `org_schedule_fragment:write` OR `org_schedule_fragment:all`
3609
3623
  *
3610
3624
  * @tags schedules
3611
3625
  * @name OrgScheduleFragmentsGet
@@ -3615,7 +3629,7 @@ class Api extends HttpClient {
3615
3629
  */
3616
3630
  this.orgScheduleFragmentsGet = (query, params = {}) => this.request(Object.assign({ path: `/org-schedule-fragments.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
3617
3631
  /**
3618
- * @description Gets an organization schedule fragment.
3632
+ * @description Gets an organization schedule fragment. **Required scopes:** - `org_schedule_fragment:read` OR `org_schedule_fragment:write` OR `org_schedule_fragment:all`
3619
3633
  *
3620
3634
  * @tags schedules
3621
3635
  * @name OrgScheduleFragmentsGetPost
@@ -3625,7 +3639,7 @@ class Api extends HttpClient {
3625
3639
  */
3626
3640
  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));
3627
3641
  /**
3628
- * @description Changes stage of an organization schedule fragment.
3642
+ * @description Changes stage of an organization schedule fragment. **Required scopes:** - `org_schedule_fragment:write` OR `org_schedule_fragment:all`
3629
3643
  *
3630
3644
  * @tags schedules
3631
3645
  * @name OrgScheduleFragmentsTransition
@@ -3635,7 +3649,7 @@ class Api extends HttpClient {
3635
3649
  */
3636
3650
  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));
3637
3651
  /**
3638
- * @description Creates an organization schedule with a default weekly organization schedule and a list of organization schedule fragments.
3652
+ * @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`
3639
3653
  *
3640
3654
  * @tags schedules
3641
3655
  * @name OrgSchedulesCreate
@@ -3645,7 +3659,7 @@ class Api extends HttpClient {
3645
3659
  */
3646
3660
  this.orgSchedulesCreate = (data, params = {}) => this.request(Object.assign({ path: `/org-schedules.create`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
3647
3661
  /**
3648
- * @description Evaluates an organization's schedule at specified instants.
3662
+ * @description Evaluates an organization's schedule at specified instants. **Required scopes:** - `org_schedule:read` OR `org_schedule:write` OR `org_schedule:all`
3649
3663
  *
3650
3664
  * @tags schedules
3651
3665
  * @name OrgSchedulesEvaluate
@@ -3655,7 +3669,7 @@ class Api extends HttpClient {
3655
3669
  */
3656
3670
  this.orgSchedulesEvaluate = (query, params = {}) => this.request(Object.assign({ path: `/org-schedules.evaluate`, method: 'GET', query: query, secure: true, format: 'json' }, params));
3657
3671
  /**
3658
- * @description Evaluates an organization's schedule at specified instants.
3672
+ * @description Evaluates an organization's schedule at specified instants. **Required scopes:** - `org_schedule:read` OR `org_schedule:write` OR `org_schedule:all`
3659
3673
  *
3660
3674
  * @tags schedules
3661
3675
  * @name OrgSchedulesEvaluatePost
@@ -3665,7 +3679,7 @@ class Api extends HttpClient {
3665
3679
  */
3666
3680
  this.orgSchedulesEvaluatePost = (data, params = {}) => this.request(Object.assign({ path: `/org-schedules.evaluate`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
3667
3681
  /**
3668
- * @description Gets an organization schedule.
3682
+ * @description Gets an organization schedule. **Required scopes:** - `org_schedule:read` OR `org_schedule:write` OR `org_schedule:all`
3669
3683
  *
3670
3684
  * @tags schedules
3671
3685
  * @name OrgSchedulesGet
@@ -3675,7 +3689,7 @@ class Api extends HttpClient {
3675
3689
  */
3676
3690
  this.orgSchedulesGet = (query, params = {}) => this.request(Object.assign({ path: `/org-schedules.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
3677
3691
  /**
3678
- * @description Gets an organization schedule.
3692
+ * @description Gets an organization schedule. **Required scopes:** - `org_schedule:read` OR `org_schedule:write` OR `org_schedule:all`
3679
3693
  *
3680
3694
  * @tags schedules
3681
3695
  * @name OrgSchedulesGetPost
@@ -3685,7 +3699,7 @@ class Api extends HttpClient {
3685
3699
  */
3686
3700
  this.orgSchedulesGetPost = (data, params = {}) => this.request(Object.assign({ path: `/org-schedules.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
3687
3701
  /**
3688
- * @description Gets list of organization schedules.
3702
+ * @description Gets list of organization schedules. **Required scopes:** - `org_schedule:read` OR `org_schedule:write` OR `org_schedule:all`
3689
3703
  *
3690
3704
  * @tags schedules
3691
3705
  * @name OrgSchedulesList
@@ -3695,7 +3709,7 @@ class Api extends HttpClient {
3695
3709
  */
3696
3710
  this.orgSchedulesList = (query, params = {}) => this.request(Object.assign({ path: `/org-schedules.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
3697
3711
  /**
3698
- * @description Gets list of organization schedules.
3712
+ * @description Gets list of organization schedules. **Required scopes:** - `org_schedule:read` OR `org_schedule:write` OR `org_schedule:all`
3699
3713
  *
3700
3714
  * @tags schedules
3701
3715
  * @name OrgSchedulesListPost
@@ -3705,7 +3719,7 @@ class Api extends HttpClient {
3705
3719
  */
3706
3720
  this.orgSchedulesListPost = (data, params = {}) => this.request(Object.assign({ path: `/org-schedules.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
3707
3721
  /**
3708
- * @description Sets next organization schedule fragment which must begin the day the last existing fragment ends.
3722
+ * @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`
3709
3723
  *
3710
3724
  * @tags schedules
3711
3725
  * @name OrgSchedulesSetFuture
@@ -3715,7 +3729,7 @@ class Api extends HttpClient {
3715
3729
  */
3716
3730
  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));
3717
3731
  /**
3718
- * @description Publishes or archives an organization schedule.
3732
+ * @description Publishes or archives an organization schedule. **Required scopes:** - `org_schedule:write` OR `org_schedule:all`
3719
3733
  *
3720
3734
  * @tags schedules
3721
3735
  * @name OrgSchedulesTransition
@@ -3725,7 +3739,7 @@ class Api extends HttpClient {
3725
3739
  */
3726
3740
  this.orgSchedulesTransition = (data, params = {}) => this.request(Object.assign({ path: `/org-schedules.transition`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
3727
3741
  /**
3728
- * @description Updates an organization schedule.
3742
+ * @description Updates an organization schedule. **Required scopes:** - `org_schedule:write` OR `org_schedule:all`
3729
3743
  *
3730
3744
  * @tags schedules
3731
3745
  * @name OrgSchedulesUpdate
@@ -3735,7 +3749,7 @@ class Api extends HttpClient {
3735
3749
  */
3736
3750
  this.orgSchedulesUpdate = (data, params = {}) => this.request(Object.assign({ path: `/org-schedules.update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
3737
3751
  /**
3738
- * @description Creates new [part](https://devrev.ai/docs/product/parts).
3752
+ * @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` |
3739
3753
  *
3740
3754
  * @tags parts
3741
3755
  * @name PartsCreate
@@ -3745,7 +3759,7 @@ class Api extends HttpClient {
3745
3759
  */
3746
3760
  this.partsCreate = (data, params = {}) => this.request(Object.assign({ path: `/parts.create`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
3747
3761
  /**
3748
- * @description Deletes a [part](https://devrev.ai/docs/product/parts).
3762
+ * @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` |
3749
3763
  *
3750
3764
  * @tags parts
3751
3765
  * @name PartsDelete
@@ -3755,7 +3769,7 @@ class Api extends HttpClient {
3755
3769
  */
3756
3770
  this.partsDelete = (data, params = {}) => this.request(Object.assign({ path: `/parts.delete`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
3757
3771
  /**
3758
- * @description Gets a [part's](https://devrev.ai/docs/product/parts) information.
3772
+ * @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` |
3759
3773
  *
3760
3774
  * @tags parts
3761
3775
  * @name PartsGet
@@ -3765,7 +3779,7 @@ class Api extends HttpClient {
3765
3779
  */
3766
3780
  this.partsGet = (query, params = {}) => this.request(Object.assign({ path: `/parts.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
3767
3781
  /**
3768
- * @description Gets a [part's](https://devrev.ai/docs/product/parts) information.
3782
+ * @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` |
3769
3783
  *
3770
3784
  * @tags parts
3771
3785
  * @name PartsGetPost
@@ -3775,7 +3789,7 @@ class Api extends HttpClient {
3775
3789
  */
3776
3790
  this.partsGetPost = (data, params = {}) => this.request(Object.assign({ path: `/parts.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
3777
3791
  /**
3778
- * @description Lists a collection of [parts](https://devrev.ai/docs/product/parts).
3792
+ * @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` |
3779
3793
  *
3780
3794
  * @tags parts
3781
3795
  * @name PartsList
@@ -3785,7 +3799,7 @@ class Api extends HttpClient {
3785
3799
  */
3786
3800
  this.partsList = (query, params = {}) => this.request(Object.assign({ path: `/parts.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
3787
3801
  /**
3788
- * @description Lists a collection of [parts](https://devrev.ai/docs/product/parts).
3802
+ * @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` |
3789
3803
  *
3790
3804
  * @tags parts
3791
3805
  * @name PartsListPost
@@ -3795,7 +3809,7 @@ class Api extends HttpClient {
3795
3809
  */
3796
3810
  this.partsListPost = (data, params = {}) => this.request(Object.assign({ path: `/parts.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
3797
3811
  /**
3798
- * @description Updates a [part's](https://devrev.ai/docs/product/parts) information.
3812
+ * @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` |
3799
3813
  *
3800
3814
  * @tags parts
3801
3815
  * @name PartsUpdate
@@ -3823,7 +3837,7 @@ class Api extends HttpClient {
3823
3837
  */
3824
3838
  this.pingPost = (data, params = {}) => this.request(Object.assign({ path: `/ping`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
3825
3839
  /**
3826
- * @description Lists the reactors for an object.
3840
+ * @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).
3827
3841
  *
3828
3842
  * @tags timeline-entries, works
3829
3843
  * @name ReactionsList
@@ -3833,7 +3847,7 @@ class Api extends HttpClient {
3833
3847
  */
3834
3848
  this.reactionsList = (query, params = {}) => this.request(Object.assign({ path: `/reactions.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
3835
3849
  /**
3836
- * @description Lists the reactors for an object.
3850
+ * @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).
3837
3851
  *
3838
3852
  * @tags timeline-entries, works
3839
3853
  * @name ReactionsListPost
@@ -3843,7 +3857,7 @@ class Api extends HttpClient {
3843
3857
  */
3844
3858
  this.reactionsListPost = (data, params = {}) => this.request(Object.assign({ path: `/reactions.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
3845
3859
  /**
3846
- * @description Updates a reaction for an object.
3860
+ * @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).
3847
3861
  *
3848
3862
  * @tags timeline-entries, works
3849
3863
  * @name ReactionsUpdate
@@ -3853,7 +3867,7 @@ class Api extends HttpClient {
3853
3867
  */
3854
3868
  this.reactionsUpdate = (data, params = {}) => this.request(Object.assign({ path: `/reactions.update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
3855
3869
  /**
3856
- * @description Creates a Rev organization in the authenticated user's Dev organization. **Required scopes:** - `rev_org:write`
3870
+ * @description Creates a Rev organization in the authenticated user's Dev organization. **Required scopes:** - `rev_org:write` OR `rev_org:all`
3857
3871
  *
3858
3872
  * @tags rev-orgs
3859
3873
  * @name RevOrgsCreate
@@ -3873,7 +3887,7 @@ class Api extends HttpClient {
3873
3887
  */
3874
3888
  this.revOrgsDelete = (data, params = {}) => this.request(Object.assign({ path: `/rev-orgs.delete`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
3875
3889
  /**
3876
- * @description Retrieves the Rev organization's information. **Required scopes:** - `rev_org:read`
3890
+ * @description Retrieves the Rev organization's information. **Required scopes:** - `rev_org:read` OR `rev_org:write` OR `rev_org:all`
3877
3891
  *
3878
3892
  * @tags rev-orgs
3879
3893
  * @name RevOrgsGet
@@ -3883,7 +3897,7 @@ class Api extends HttpClient {
3883
3897
  */
3884
3898
  this.revOrgsGet = (query, params = {}) => this.request(Object.assign({ path: `/rev-orgs.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
3885
3899
  /**
3886
- * @description Retrieves the Rev organization's information. **Required scopes:** - `rev_org:read`
3900
+ * @description Retrieves the Rev organization's information. **Required scopes:** - `rev_org:read` OR `rev_org:write` OR `rev_org:all`
3887
3901
  *
3888
3902
  * @tags rev-orgs
3889
3903
  * @name RevOrgsGetPost
@@ -3893,7 +3907,7 @@ class Api extends HttpClient {
3893
3907
  */
3894
3908
  this.revOrgsGetPost = (data, params = {}) => this.request(Object.assign({ path: `/rev-orgs.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
3895
3909
  /**
3896
- * @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`
3910
+ * @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`
3897
3911
  *
3898
3912
  * @tags rev-orgs
3899
3913
  * @name RevOrgsList
@@ -3903,7 +3917,7 @@ class Api extends HttpClient {
3903
3917
  */
3904
3918
  this.revOrgsList = (query, params = {}) => this.request(Object.assign({ path: `/rev-orgs.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
3905
3919
  /**
3906
- * @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`
3920
+ * @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`
3907
3921
  *
3908
3922
  * @tags rev-orgs
3909
3923
  * @name RevOrgsListPost
@@ -3913,7 +3927,7 @@ class Api extends HttpClient {
3913
3927
  */
3914
3928
  this.revOrgsListPost = (data, params = {}) => this.request(Object.assign({ path: `/rev-orgs.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
3915
3929
  /**
3916
- * @description Updates the Rev organization's information. **Required scopes:** - `rev_org:write`
3930
+ * @description Updates the Rev organization's information. **Required scopes:** - `rev_org:write` OR `rev_org:all`
3917
3931
  *
3918
3932
  * @tags rev-orgs
3919
3933
  * @name RevOrgsUpdate
@@ -3923,7 +3937,7 @@ class Api extends HttpClient {
3923
3937
  */
3924
3938
  this.revOrgsUpdate = (data, params = {}) => this.request(Object.assign({ path: `/rev-orgs.update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
3925
3939
  /**
3926
- * @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`
3940
+ * @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`
3927
3941
  *
3928
3942
  * @tags rev-users
3929
3943
  * @name RevUsersCreate
@@ -3943,7 +3957,7 @@ class Api extends HttpClient {
3943
3957
  */
3944
3958
  this.revUsersDelete = (data, params = {}) => this.request(Object.assign({ path: `/rev-users.delete`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
3945
3959
  /**
3946
- * @description Returns the Rev user of a Rev organization by its ID. **Required scopes:** - `rev_user:read`
3960
+ * @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`
3947
3961
  *
3948
3962
  * @tags rev-users
3949
3963
  * @name RevUsersGet
@@ -3953,7 +3967,7 @@ class Api extends HttpClient {
3953
3967
  */
3954
3968
  this.revUsersGet = (query, params = {}) => this.request(Object.assign({ path: `/rev-users.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
3955
3969
  /**
3956
- * @description Returns the Rev user of a Rev organization by its ID. **Required scopes:** - `rev_user:read`
3970
+ * @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`
3957
3971
  *
3958
3972
  * @tags rev-users
3959
3973
  * @name RevUsersGetPost
@@ -3963,7 +3977,7 @@ class Api extends HttpClient {
3963
3977
  */
3964
3978
  this.revUsersGetPost = (data, params = {}) => this.request(Object.assign({ path: `/rev-users.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
3965
3979
  /**
3966
- * @description Returns a list of all Rev Users belonging to the authenticated user's Dev organization. **Required scopes:** - `rev_user:read`
3980
+ * @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`
3967
3981
  *
3968
3982
  * @tags rev-users
3969
3983
  * @name RevUsersList
@@ -3973,7 +3987,7 @@ class Api extends HttpClient {
3973
3987
  */
3974
3988
  this.revUsersList = (query, params = {}) => this.request(Object.assign({ path: `/rev-users.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
3975
3989
  /**
3976
- * @description Returns a list of all Rev Users belonging to the authenticated user's Dev organization. **Required scopes:** - `rev_user:read`
3990
+ * @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`
3977
3991
  *
3978
3992
  * @tags rev-users
3979
3993
  * @name RevUsersListPost
@@ -3993,7 +4007,7 @@ class Api extends HttpClient {
3993
4007
  */
3994
4008
  this.revUsersMerge = (data, params = {}) => this.request(Object.assign({ path: `/rev-users.merge`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
3995
4009
  /**
3996
- * @description Scans through all Rev users. **Required scopes:** - `rev_user:read`
4010
+ * @description Scans through all Rev users. **Required scopes:** - `rev_user:read` OR `rev_user:write` OR `rev_user:all`
3997
4011
  *
3998
4012
  * @tags rev-users
3999
4013
  * @name RevUsersScan
@@ -4003,7 +4017,7 @@ class Api extends HttpClient {
4003
4017
  */
4004
4018
  this.revUsersScan = (query, params = {}) => this.request(Object.assign({ path: `/rev-users.scan`, method: 'GET', query: query, secure: true, format: 'json' }, params));
4005
4019
  /**
4006
- * @description Scans through all Rev users. **Required scopes:** - `rev_user:read`
4020
+ * @description Scans through all Rev users. **Required scopes:** - `rev_user:read` OR `rev_user:write` OR `rev_user:all`
4007
4021
  *
4008
4022
  * @tags rev-users
4009
4023
  * @name RevUsersScanPost
@@ -4013,7 +4027,7 @@ class Api extends HttpClient {
4013
4027
  */
4014
4028
  this.revUsersScanPost = (data, params = {}) => this.request(Object.assign({ path: `/rev-users.scan`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
4015
4029
  /**
4016
- * @description Updates a Rev user. **Required scopes:** - `rev_user:write`
4030
+ * @description Updates a Rev user. **Required scopes:** - `rev_user:write` OR `rev_user:all`
4017
4031
  *
4018
4032
  * @tags rev-users
4019
4033
  * @name RevUsersUpdate
@@ -4023,7 +4037,7 @@ class Api extends HttpClient {
4023
4037
  */
4024
4038
  this.revUsersUpdate = (data, params = {}) => this.request(Object.assign({ path: `/rev-users.update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
4025
4039
  /**
4026
- * @description Gets the aggregated schema.
4040
+ * @description Gets the aggregated schema. **Required scopes:** No scopes required.
4027
4041
  *
4028
4042
  * @tags customization
4029
4043
  * @name AggregatedSchemaGet
@@ -4033,7 +4047,7 @@ class Api extends HttpClient {
4033
4047
  */
4034
4048
  this.aggregatedSchemaGet = (query, params = {}) => this.request(Object.assign({ path: `/schemas.aggregated.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
4035
4049
  /**
4036
- * @description Gets the aggregated schema.
4050
+ * @description Gets the aggregated schema. **Required scopes:** No scopes required.
4037
4051
  *
4038
4052
  * @tags customization
4039
4053
  * @name AggregatedSchemaGetPost
@@ -4043,7 +4057,7 @@ class Api extends HttpClient {
4043
4057
  */
4044
4058
  this.aggregatedSchemaGetPost = (data, params = {}) => this.request(Object.assign({ path: `/schemas.aggregated.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
4045
4059
  /**
4046
- * @description Gets a custom schema fragment.
4060
+ * @description Gets a custom schema fragment. **Required scopes:** No scopes required.
4047
4061
  *
4048
4062
  * @tags customization
4049
4063
  * @name CustomSchemaFragmentsGet
@@ -4053,7 +4067,7 @@ class Api extends HttpClient {
4053
4067
  */
4054
4068
  this.customSchemaFragmentsGet = (query, params = {}) => this.request(Object.assign({ path: `/schemas.custom.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
4055
4069
  /**
4056
- * @description Gets a custom schema fragment.
4070
+ * @description Gets a custom schema fragment. **Required scopes:** No scopes required.
4057
4071
  *
4058
4072
  * @tags customization
4059
4073
  * @name CustomSchemaFragmentsGetPost
@@ -4063,7 +4077,7 @@ class Api extends HttpClient {
4063
4077
  */
4064
4078
  this.customSchemaFragmentsGetPost = (data, params = {}) => this.request(Object.assign({ path: `/schemas.custom.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
4065
4079
  /**
4066
- * @description Lists custom schema fragments.
4080
+ * @description Lists custom schema fragments. **Required scopes:** No scopes required.
4067
4081
  *
4068
4082
  * @tags customization
4069
4083
  * @name CustomSchemaFragmentsList
@@ -4073,7 +4087,7 @@ class Api extends HttpClient {
4073
4087
  */
4074
4088
  this.customSchemaFragmentsList = (query, params = {}) => this.request(Object.assign({ path: `/schemas.custom.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
4075
4089
  /**
4076
- * @description Lists custom schema fragments.
4090
+ * @description Lists custom schema fragments. **Required scopes:** No scopes required.
4077
4091
  *
4078
4092
  * @tags customization
4079
4093
  * @name CustomSchemaFragmentsListPost
@@ -4083,7 +4097,7 @@ class Api extends HttpClient {
4083
4097
  */
4084
4098
  this.customSchemaFragmentsListPost = (data, params = {}) => this.request(Object.assign({ path: `/schemas.custom.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
4085
4099
  /**
4086
- * @description Creates or updates a custom schema fragment.
4100
+ * @description Creates or updates a custom schema fragment. **Required scopes:** - `custom_type_fragment:write`
4087
4101
  *
4088
4102
  * @tags customization
4089
4103
  * @name CustomSchemaFragmentsSet
@@ -4093,7 +4107,7 @@ class Api extends HttpClient {
4093
4107
  */
4094
4108
  this.customSchemaFragmentsSet = (data, params = {}) => this.request(Object.assign({ path: `/schemas.custom.set`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
4095
4109
  /**
4096
- * @description Gets a stock schema fragment.
4110
+ * @description Gets a stock schema fragment. **Required scopes:** No scopes required.
4097
4111
  *
4098
4112
  * @tags customization
4099
4113
  * @name StockSchemaFragmentsGet
@@ -4103,7 +4117,7 @@ class Api extends HttpClient {
4103
4117
  */
4104
4118
  this.stockSchemaFragmentsGet = (query, params = {}) => this.request(Object.assign({ path: `/schemas.stock.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
4105
4119
  /**
4106
- * @description Gets a stock schema fragment.
4120
+ * @description Gets a stock schema fragment. **Required scopes:** No scopes required.
4107
4121
  *
4108
4122
  * @tags customization
4109
4123
  * @name StockSchemaFragmentsGetPost
@@ -4113,7 +4127,7 @@ class Api extends HttpClient {
4113
4127
  */
4114
4128
  this.stockSchemaFragmentsGetPost = (data, params = {}) => this.request(Object.assign({ path: `/schemas.stock.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
4115
4129
  /**
4116
- * @description Lists stock schema fragments.
4130
+ * @description Lists stock schema fragments. **Required scopes:** No scopes required.
4117
4131
  *
4118
4132
  * @tags customization
4119
4133
  * @name StockSchemaFragmentsList
@@ -4123,7 +4137,7 @@ class Api extends HttpClient {
4123
4137
  */
4124
4138
  this.stockSchemaFragmentsList = (query, params = {}) => this.request(Object.assign({ path: `/schemas.stock.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
4125
4139
  /**
4126
- * @description Lists stock schema fragments.
4140
+ * @description Lists stock schema fragments. **Required scopes:** No scopes required.
4127
4141
  *
4128
4142
  * @tags customization
4129
4143
  * @name StockSchemaFragmentsListPost
@@ -4133,7 +4147,7 @@ class Api extends HttpClient {
4133
4147
  */
4134
4148
  this.stockSchemaFragmentsListPost = (data, params = {}) => this.request(Object.assign({ path: `/schemas.stock.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
4135
4149
  /**
4136
- * @description Gets the new fragment IDs and fields resulting from changing a subtype.
4150
+ * @description Gets the new fragment IDs and fields resulting from changing a subtype. **Required scopes:** - `custom_type_fragment:write`
4137
4151
  *
4138
4152
  * @tags customization
4139
4153
  * @name SchemasSubtypePrepareUpdateGet
@@ -4143,7 +4157,7 @@ class Api extends HttpClient {
4143
4157
  */
4144
4158
  this.schemasSubtypePrepareUpdateGet = (data, params = {}) => this.request(Object.assign({ path: `/schemas.subtypes.prepare-update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
4145
4159
  /**
4146
- * @description Creates a service account.
4160
+ * @description Creates a service account. **Required scopes:** Not accessible via service account tokens. Requires user authentication.
4147
4161
  *
4148
4162
  * @tags service-accounts
4149
4163
  * @name ServiceAccountsCreate
@@ -4153,7 +4167,7 @@ class Api extends HttpClient {
4153
4167
  */
4154
4168
  this.serviceAccountsCreate = (data, params = {}) => this.request(Object.assign({ path: `/service-accounts.create`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
4155
4169
  /**
4156
- * @description Gets a service account.
4170
+ * @description Gets a service account. **Required scopes:** - `svcacc:read`
4157
4171
  *
4158
4172
  * @tags service-accounts
4159
4173
  * @name ServiceAccountsGet
@@ -4163,7 +4177,7 @@ class Api extends HttpClient {
4163
4177
  */
4164
4178
  this.serviceAccountsGet = (query, params = {}) => this.request(Object.assign({ path: `/service-accounts.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
4165
4179
  /**
4166
- * @description Gets a service account.
4180
+ * @description Gets a service account. **Required scopes:** - `svcacc:read`
4167
4181
  *
4168
4182
  * @tags service-accounts
4169
4183
  * @name ServiceAccountsGetPost
@@ -4173,7 +4187,7 @@ class Api extends HttpClient {
4173
4187
  */
4174
4188
  this.serviceAccountsGetPost = (data, params = {}) => this.request(Object.assign({ path: `/service-accounts.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
4175
4189
  /**
4176
- * @description Gets an SLA tracker.
4190
+ * @description Gets an SLA tracker. **Required scopes:** No scopes required.
4177
4191
  *
4178
4192
  * @tags slas
4179
4193
  * @name SlaTrackersGet
@@ -4183,7 +4197,7 @@ class Api extends HttpClient {
4183
4197
  */
4184
4198
  this.slaTrackersGet = (query, params = {}) => this.request(Object.assign({ path: `/sla-trackers.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
4185
4199
  /**
4186
- * @description Gets an SLA tracker.
4200
+ * @description Gets an SLA tracker. **Required scopes:** No scopes required.
4187
4201
  *
4188
4202
  * @tags slas
4189
4203
  * @name SlaTrackersGetPost
@@ -4193,7 +4207,7 @@ class Api extends HttpClient {
4193
4207
  */
4194
4208
  this.slaTrackersGetPost = (data, params = {}) => this.request(Object.assign({ path: `/sla-trackers.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
4195
4209
  /**
4196
- * @description Lists SLA trackers matching a filter.
4210
+ * @description Lists SLA trackers matching a filter. **Required scopes:** No scopes required.
4197
4211
  *
4198
4212
  * @tags slas
4199
4213
  * @name SlaTrackersList
@@ -4203,7 +4217,7 @@ class Api extends HttpClient {
4203
4217
  */
4204
4218
  this.slaTrackersList = (query, params = {}) => this.request(Object.assign({ path: `/sla-trackers.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
4205
4219
  /**
4206
- * @description Lists SLA trackers matching a filter.
4220
+ * @description Lists SLA trackers matching a filter. **Required scopes:** No scopes required.
4207
4221
  *
4208
4222
  * @tags slas
4209
4223
  * @name SlaTrackersListPost
@@ -4213,7 +4227,7 @@ class Api extends HttpClient {
4213
4227
  */
4214
4228
  this.slaTrackersListPost = (data, params = {}) => this.request(Object.assign({ path: `/sla-trackers.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
4215
4229
  /**
4216
- * @description Assigns the SLA to a set of Rev organizations.
4230
+ * @description Assigns the SLA to a set of Rev organizations. **Required scopes:** - `sla:write`
4217
4231
  *
4218
4232
  * @tags slas
4219
4233
  * @name SlasAssign
@@ -4223,7 +4237,7 @@ class Api extends HttpClient {
4223
4237
  */
4224
4238
  this.slasAssign = (data, params = {}) => this.request(Object.assign({ path: `/slas.assign`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
4225
4239
  /**
4226
- * @description Creates an SLA in draft status.
4240
+ * @description Creates an SLA in draft status. **Required scopes:** - `sla:write`
4227
4241
  *
4228
4242
  * @tags slas
4229
4243
  * @name SlasCreate
@@ -4233,7 +4247,7 @@ class Api extends HttpClient {
4233
4247
  */
4234
4248
  this.slasCreate = (data, params = {}) => this.request(Object.assign({ path: `/slas.create`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
4235
4249
  /**
4236
- * @description Gets an SLA.
4250
+ * @description Gets an SLA. **Required scopes:** - `sla:read` OR `sla:write`
4237
4251
  *
4238
4252
  * @tags slas
4239
4253
  * @name SlasGet
@@ -4243,7 +4257,7 @@ class Api extends HttpClient {
4243
4257
  */
4244
4258
  this.slasGet = (query, params = {}) => this.request(Object.assign({ path: `/slas.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
4245
4259
  /**
4246
- * @description Gets an SLA.
4260
+ * @description Gets an SLA. **Required scopes:** - `sla:read` OR `sla:write`
4247
4261
  *
4248
4262
  * @tags slas
4249
4263
  * @name SlasGetPost
@@ -4253,7 +4267,7 @@ class Api extends HttpClient {
4253
4267
  */
4254
4268
  this.slasGetPost = (data, params = {}) => this.request(Object.assign({ path: `/slas.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
4255
4269
  /**
4256
- * @description Lists SLAs matching a filter.
4270
+ * @description Lists SLAs matching a filter. **Required scopes:** - `sla:read` OR `sla:write`
4257
4271
  *
4258
4272
  * @tags slas
4259
4273
  * @name SlasList
@@ -4263,7 +4277,7 @@ class Api extends HttpClient {
4263
4277
  */
4264
4278
  this.slasList = (query, params = {}) => this.request(Object.assign({ path: `/slas.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
4265
4279
  /**
4266
- * @description Lists SLAs matching a filter.
4280
+ * @description Lists SLAs matching a filter. **Required scopes:** - `sla:read` OR `sla:write`
4267
4281
  *
4268
4282
  * @tags slas
4269
4283
  * @name SlasListPost
@@ -4273,7 +4287,7 @@ class Api extends HttpClient {
4273
4287
  */
4274
4288
  this.slasListPost = (data, params = {}) => this.request(Object.assign({ path: `/slas.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
4275
4289
  /**
4276
- * @description Changes the status of an SLA.
4290
+ * @description Changes the status of an SLA. **Required scopes:** - `sla:write`
4277
4291
  *
4278
4292
  * @tags slas
4279
4293
  * @name SlasTransition
@@ -4283,7 +4297,7 @@ class Api extends HttpClient {
4283
4297
  */
4284
4298
  this.slasTransition = (data, params = {}) => this.request(Object.assign({ path: `/slas.transition`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
4285
4299
  /**
4286
- * @description Updates a draft SLA.
4300
+ * @description Updates a draft SLA. **Required scopes:** - `sla:write`
4287
4301
  *
4288
4302
  * @tags slas
4289
4303
  * @name SlasUpdate
@@ -4293,7 +4307,7 @@ class Api extends HttpClient {
4293
4307
  */
4294
4308
  this.slasUpdate = (data, params = {}) => this.request(Object.assign({ path: `/slas.update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
4295
4309
  /**
4296
- * @description Executes deferred snap-kit actions.
4310
+ * @description Executes deferred snap-kit actions. **Required scopes:** - `snap_widget:write` OR `snap_widget:all`
4297
4311
  *
4298
4312
  * @tags snap-kit-execution
4299
4313
  * @name SnapKitActionExecuteDeferred
@@ -4303,7 +4317,7 @@ class Api extends HttpClient {
4303
4317
  */
4304
4318
  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));
4305
4319
  /**
4306
- * @description Create a snap widget object.
4320
+ * @description Create a snap widget object. **Required scopes:** - `snap_widget:write` OR `snap_widget:all`
4307
4321
  *
4308
4322
  * @tags snap-widgets
4309
4323
  * @name SnapWidgetsCreate
@@ -4313,7 +4327,7 @@ class Api extends HttpClient {
4313
4327
  */
4314
4328
  this.snapWidgetsCreate = (data, params = {}) => this.request(Object.assign({ path: `/snap-widgets.create`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
4315
4329
  /**
4316
- * @description Creates a stage diagram.
4330
+ * @description Creates a stage diagram. **Required scopes:** - `stage_diagram:write`
4317
4331
  *
4318
4332
  * @tags customization
4319
4333
  * @name StageDiagramsCreate
@@ -4323,7 +4337,7 @@ class Api extends HttpClient {
4323
4337
  */
4324
4338
  this.stageDiagramsCreate = (data, params = {}) => this.request(Object.assign({ path: `/stage-diagrams.create`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
4325
4339
  /**
4326
- * @description Gets a stage diagram.
4340
+ * @description Gets a stage diagram. **Required scopes:** No scopes required.
4327
4341
  *
4328
4342
  * @tags customization
4329
4343
  * @name StageDiagramsGet
@@ -4333,7 +4347,7 @@ class Api extends HttpClient {
4333
4347
  */
4334
4348
  this.stageDiagramsGet = (query, params = {}) => this.request(Object.assign({ path: `/stage-diagrams.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
4335
4349
  /**
4336
- * @description Gets a stage diagram.
4350
+ * @description Gets a stage diagram. **Required scopes:** No scopes required.
4337
4351
  *
4338
4352
  * @tags customization
4339
4353
  * @name StageDiagramsGetPost
@@ -4343,7 +4357,7 @@ class Api extends HttpClient {
4343
4357
  */
4344
4358
  this.stageDiagramsGetPost = (data, params = {}) => this.request(Object.assign({ path: `/stage-diagrams.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
4345
4359
  /**
4346
- * @description Lists stage diagrams.
4360
+ * @description Lists stage diagrams. **Required scopes:** No scopes required.
4347
4361
  *
4348
4362
  * @tags customization
4349
4363
  * @name StageDiagramsList
@@ -4353,7 +4367,7 @@ class Api extends HttpClient {
4353
4367
  */
4354
4368
  this.stageDiagramsList = (query, params = {}) => this.request(Object.assign({ path: `/stage-diagrams.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
4355
4369
  /**
4356
- * @description Lists stage diagrams.
4370
+ * @description Lists stage diagrams. **Required scopes:** No scopes required.
4357
4371
  *
4358
4372
  * @tags customization
4359
4373
  * @name StageDiagramsListPost
@@ -4363,7 +4377,7 @@ class Api extends HttpClient {
4363
4377
  */
4364
4378
  this.stageDiagramsListPost = (data, params = {}) => this.request(Object.assign({ path: `/stage-diagrams.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
4365
4379
  /**
4366
- * @description Updates a stage diagram.
4380
+ * @description Updates a stage diagram. **Required scopes:** - `stage_diagram:write`
4367
4381
  *
4368
4382
  * @tags customization
4369
4383
  * @name StageDiagramsUpdate
@@ -4373,7 +4387,7 @@ class Api extends HttpClient {
4373
4387
  */
4374
4388
  this.stageDiagramsUpdate = (data, params = {}) => this.request(Object.assign({ path: `/stage-diagrams.update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
4375
4389
  /**
4376
- * @description Creates a custom stage.
4390
+ * @description Creates a custom stage. **Required scopes:** - `custom_stage:write`
4377
4391
  *
4378
4392
  * @tags customization
4379
4393
  * @name CustomStagesCreate
@@ -4383,7 +4397,7 @@ class Api extends HttpClient {
4383
4397
  */
4384
4398
  this.customStagesCreate = (data, params = {}) => this.request(Object.assign({ path: `/stages.custom.create`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
4385
4399
  /**
4386
- * @description Gets a custom stage.
4400
+ * @description Gets a custom stage. **Required scopes:** No scopes required.
4387
4401
  *
4388
4402
  * @tags customization
4389
4403
  * @name CustomStagesGet
@@ -4393,7 +4407,7 @@ class Api extends HttpClient {
4393
4407
  */
4394
4408
  this.customStagesGet = (query, params = {}) => this.request(Object.assign({ path: `/stages.custom.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
4395
4409
  /**
4396
- * @description Gets a custom stage.
4410
+ * @description Gets a custom stage. **Required scopes:** No scopes required.
4397
4411
  *
4398
4412
  * @tags customization
4399
4413
  * @name CustomStagesGetPost
@@ -4403,7 +4417,7 @@ class Api extends HttpClient {
4403
4417
  */
4404
4418
  this.customStagesGetPost = (data, params = {}) => this.request(Object.assign({ path: `/stages.custom.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
4405
4419
  /**
4406
- * @description Lists custom stages.
4420
+ * @description Lists custom stages. **Required scopes:** No scopes required.
4407
4421
  *
4408
4422
  * @tags customization
4409
4423
  * @name CustomStagesList
@@ -4413,7 +4427,7 @@ class Api extends HttpClient {
4413
4427
  */
4414
4428
  this.customStagesList = (query, params = {}) => this.request(Object.assign({ path: `/stages.custom.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
4415
4429
  /**
4416
- * @description Lists custom stages.
4430
+ * @description Lists custom stages. **Required scopes:** No scopes required.
4417
4431
  *
4418
4432
  * @tags customization
4419
4433
  * @name CustomStagesListPost
@@ -4423,7 +4437,7 @@ class Api extends HttpClient {
4423
4437
  */
4424
4438
  this.customStagesListPost = (data, params = {}) => this.request(Object.assign({ path: `/stages.custom.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
4425
4439
  /**
4426
- * @description Updates a custom stage.
4440
+ * @description Updates a custom stage. **Required scopes:** - `custom_stage:write`
4427
4441
  *
4428
4442
  * @tags customization
4429
4443
  * @name CustomStagesUpdate
@@ -4433,7 +4447,7 @@ class Api extends HttpClient {
4433
4447
  */
4434
4448
  this.customStagesUpdate = (data, params = {}) => this.request(Object.assign({ path: `/stages.custom.update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
4435
4449
  /**
4436
- * @description Creates a custom state.
4450
+ * @description Creates a custom state. **Required scopes:** - `custom_state:write`
4437
4451
  *
4438
4452
  * @tags customization
4439
4453
  * @name CustomStatesCreate
@@ -4443,7 +4457,7 @@ class Api extends HttpClient {
4443
4457
  */
4444
4458
  this.customStatesCreate = (data, params = {}) => this.request(Object.assign({ path: `/states.custom.create`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
4445
4459
  /**
4446
- * @description Gets a custom state.
4460
+ * @description Gets a custom state. **Required scopes:** No scopes required.
4447
4461
  *
4448
4462
  * @tags customization
4449
4463
  * @name CustomStatesGet
@@ -4453,7 +4467,7 @@ class Api extends HttpClient {
4453
4467
  */
4454
4468
  this.customStatesGet = (query, params = {}) => this.request(Object.assign({ path: `/states.custom.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
4455
4469
  /**
4456
- * @description Gets a custom state.
4470
+ * @description Gets a custom state. **Required scopes:** No scopes required.
4457
4471
  *
4458
4472
  * @tags customization
4459
4473
  * @name CustomStatesGetPost
@@ -4463,7 +4477,7 @@ class Api extends HttpClient {
4463
4477
  */
4464
4478
  this.customStatesGetPost = (data, params = {}) => this.request(Object.assign({ path: `/states.custom.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
4465
4479
  /**
4466
- * @description Lists custom states.
4480
+ * @description Lists custom states. **Required scopes:** No scopes required.
4467
4481
  *
4468
4482
  * @tags customization
4469
4483
  * @name CustomStatesList
@@ -4473,7 +4487,7 @@ class Api extends HttpClient {
4473
4487
  */
4474
4488
  this.customStatesList = (query, params = {}) => this.request(Object.assign({ path: `/states.custom.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
4475
4489
  /**
4476
- * @description Lists custom states.
4490
+ * @description Lists custom states. **Required scopes:** No scopes required.
4477
4491
  *
4478
4492
  * @tags customization
4479
4493
  * @name CustomStatesListPost
@@ -4483,7 +4497,7 @@ class Api extends HttpClient {
4483
4497
  */
4484
4498
  this.customStatesListPost = (data, params = {}) => this.request(Object.assign({ path: `/states.custom.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
4485
4499
  /**
4486
- * @description Updates a custom state.
4500
+ * @description Updates a custom state. **Required scopes:** - `custom_state:write`
4487
4501
  *
4488
4502
  * @tags customization
4489
4503
  * @name CustomStatesUpdate
@@ -4493,7 +4507,7 @@ class Api extends HttpClient {
4493
4507
  */
4494
4508
  this.customStatesUpdate = (data, params = {}) => this.request(Object.assign({ path: `/states.custom.update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
4495
4509
  /**
4496
- * @description Creates a schema for survey, which includes name and description of schema.
4510
+ * @description Creates a schema for survey, which includes name and description of schema. **Required scopes:** - `survey:write` OR `survey:all`
4497
4511
  *
4498
4512
  * @tags surveys
4499
4513
  * @name SurveysCreate
@@ -4503,7 +4517,7 @@ class Api extends HttpClient {
4503
4517
  */
4504
4518
  this.surveysCreate = (data, params = {}) => this.request(Object.assign({ path: `/surveys.create`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
4505
4519
  /**
4506
- * @description Deletes the specified survey.
4520
+ * @description Deletes the specified survey. **Required scopes:** - `survey:all`
4507
4521
  *
4508
4522
  * @tags surveys
4509
4523
  * @name SurveysDelete
@@ -4513,7 +4527,7 @@ class Api extends HttpClient {
4513
4527
  */
4514
4528
  this.surveysDelete = (data, params = {}) => this.request(Object.assign({ path: `/surveys.delete`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
4515
4529
  /**
4516
- * @description Gets a survey given the ID.
4530
+ * @description Gets a survey given the ID. **Required scopes:** - `survey:read` OR `survey:write` OR `survey:all`
4517
4531
  *
4518
4532
  * @tags surveys
4519
4533
  * @name SurveysGet
@@ -4523,7 +4537,7 @@ class Api extends HttpClient {
4523
4537
  */
4524
4538
  this.surveysGet = (query, params = {}) => this.request(Object.assign({ path: `/surveys.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
4525
4539
  /**
4526
- * @description Gets a survey given the ID.
4540
+ * @description Gets a survey given the ID. **Required scopes:** - `survey:read` OR `survey:write` OR `survey:all`
4527
4541
  *
4528
4542
  * @tags surveys
4529
4543
  * @name SurveysGetPost
@@ -4533,7 +4547,7 @@ class Api extends HttpClient {
4533
4547
  */
4534
4548
  this.surveysGetPost = (data, params = {}) => this.request(Object.assign({ path: `/surveys.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
4535
4549
  /**
4536
- * @description List surveys requested by the user.
4550
+ * @description List surveys requested by the user. **Required scopes:** - `survey:read` OR `survey:write` OR `survey:all`
4537
4551
  *
4538
4552
  * @tags surveys
4539
4553
  * @name SurveysList
@@ -4543,7 +4557,7 @@ class Api extends HttpClient {
4543
4557
  */
4544
4558
  this.surveysList = (query, params = {}) => this.request(Object.assign({ path: `/surveys.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
4545
4559
  /**
4546
- * @description List surveys requested by the user.
4560
+ * @description List surveys requested by the user. **Required scopes:** - `survey:read` OR `survey:write` OR `survey:all`
4547
4561
  *
4548
4562
  * @tags surveys
4549
4563
  * @name SurveysListPost
@@ -4553,7 +4567,7 @@ class Api extends HttpClient {
4553
4567
  */
4554
4568
  this.surveysListPost = (data, params = {}) => this.request(Object.assign({ path: `/surveys.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
4555
4569
  /**
4556
- * @description List survey responses requested by the user.
4570
+ * @description List survey responses requested by the user. **Required scopes:** - `survey_response:read` OR `survey_response:write` OR `survey_response:all`
4557
4571
  *
4558
4572
  * @tags surveys
4559
4573
  * @name SurveysResponsesList
@@ -4563,7 +4577,7 @@ class Api extends HttpClient {
4563
4577
  */
4564
4578
  this.surveysResponsesList = (query, params = {}) => this.request(Object.assign({ path: `/surveys.responses.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
4565
4579
  /**
4566
- * @description List survey responses requested by the user.
4580
+ * @description List survey responses requested by the user. **Required scopes:** - `survey_response:read` OR `survey_response:write` OR `survey_response:all`
4567
4581
  *
4568
4582
  * @tags surveys
4569
4583
  * @name SurveysResponsesListPost
@@ -4573,7 +4587,7 @@ class Api extends HttpClient {
4573
4587
  */
4574
4588
  this.surveysResponsesListPost = (data, params = {}) => this.request(Object.assign({ path: `/surveys.responses.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
4575
4589
  /**
4576
- * @description Updates a user's survey response for the provided dispatch ID.
4590
+ * @description Updates a user's survey response for the provided dispatch ID. **Required scopes:** - `survey_response:write` OR `survey_response:all`
4577
4591
  *
4578
4592
  * @tags surveys
4579
4593
  * @name SurveysResponsesUpdate
@@ -4583,7 +4597,7 @@ class Api extends HttpClient {
4583
4597
  */
4584
4598
  this.surveysResponsesUpdate = (data, params = {}) => this.request(Object.assign({ path: `/surveys.responses.update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
4585
4599
  /**
4586
- * @description Sends a survey on the specified channels.
4600
+ * @description Sends a survey on the specified channels. **Required scopes:** - `survey:write` OR `survey:all`
4587
4601
  *
4588
4602
  * @tags surveys
4589
4603
  * @name SurveysSend
@@ -4593,7 +4607,7 @@ class Api extends HttpClient {
4593
4607
  */
4594
4608
  this.surveysSend = (data, params = {}) => this.request(Object.assign({ path: `/surveys.send`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
4595
4609
  /**
4596
- * @description Submits a user response to a survey, which is defined by the survey ID.
4610
+ * @description Submits a user response to a survey, which is defined by the survey ID. **Required scopes:** - `survey_response:write` OR `survey_response:all`
4597
4611
  *
4598
4612
  * @tags surveys
4599
4613
  * @name SurveysSubmit
@@ -4603,7 +4617,7 @@ class Api extends HttpClient {
4603
4617
  */
4604
4618
  this.surveysSubmit = (data, params = {}) => this.request(Object.assign({ path: `/surveys.submit`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
4605
4619
  /**
4606
- * @description Updates a survey's metadata.
4620
+ * @description Updates a survey's metadata. **Required scopes:** - `survey:write` OR `survey:all`
4607
4621
  *
4608
4622
  * @tags surveys
4609
4623
  * @name SurveysUpdate
@@ -4613,7 +4627,7 @@ class Api extends HttpClient {
4613
4627
  */
4614
4628
  this.surveysUpdate = (data, params = {}) => this.request(Object.assign({ path: `/surveys.update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
4615
4629
  /**
4616
- * @description Lists system users within your organization. **Required scopes:** - `dev_user:read`
4630
+ * @description Lists system users within your organization. **Required scopes:** Default Scopes unavailable for this API.
4617
4631
  *
4618
4632
  * @tags sys-users
4619
4633
  * @name SysUsersList
@@ -4623,7 +4637,7 @@ class Api extends HttpClient {
4623
4637
  */
4624
4638
  this.sysUsersList = (query, params = {}) => this.request(Object.assign({ path: `/sys-users.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
4625
4639
  /**
4626
- * @description Lists system users within your organization. **Required scopes:** - `dev_user:read`
4640
+ * @description Lists system users within your organization. **Required scopes:** Default Scopes unavailable for this API.
4627
4641
  *
4628
4642
  * @tags sys-users
4629
4643
  * @name SysUsersListPost
@@ -4633,7 +4647,7 @@ class Api extends HttpClient {
4633
4647
  */
4634
4648
  this.sysUsersListPost = (data, params = {}) => this.request(Object.assign({ path: `/sys-users.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
4635
4649
  /**
4636
- * @description Updates the system user. **Required scopes:** - `dev_user:write`
4650
+ * @description Updates the system user. **Required scopes:** Default Scopes unavailable for this API.
4637
4651
  *
4638
4652
  * @tags sys-users
4639
4653
  * @name SysUsersUpdate
@@ -4643,7 +4657,7 @@ class Api extends HttpClient {
4643
4657
  */
4644
4658
  this.sysUsersUpdate = (data, params = {}) => this.request(Object.assign({ path: `/sys-users.update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
4645
4659
  /**
4646
- * @description Creates a new tag, which is used to create associations between objects and a logical concept denoted by the tag's name.
4660
+ * @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`
4647
4661
  *
4648
4662
  * @tags tags
4649
4663
  * @name TagsCreate
@@ -4653,7 +4667,7 @@ class Api extends HttpClient {
4653
4667
  */
4654
4668
  this.tagsCreate = (data, params = {}) => this.request(Object.assign({ path: `/tags.create`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
4655
4669
  /**
4656
- * @description Deletes a tag.
4670
+ * @description Deletes a tag. **Required scopes:** - `tag:all`
4657
4671
  *
4658
4672
  * @tags tags
4659
4673
  * @name TagsDelete
@@ -4663,7 +4677,7 @@ class Api extends HttpClient {
4663
4677
  */
4664
4678
  this.tagsDelete = (data, params = {}) => this.request(Object.assign({ path: `/tags.delete`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
4665
4679
  /**
4666
- * @description Gets a tag's information.
4680
+ * @description Gets a tag's information. **Required scopes:** - `tag:read` OR `tag:write` OR `tag:all`
4667
4681
  *
4668
4682
  * @tags tags
4669
4683
  * @name TagsGet
@@ -4673,7 +4687,7 @@ class Api extends HttpClient {
4673
4687
  */
4674
4688
  this.tagsGet = (query, params = {}) => this.request(Object.assign({ path: `/tags.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
4675
4689
  /**
4676
- * @description Gets a tag's information.
4690
+ * @description Gets a tag's information. **Required scopes:** - `tag:read` OR `tag:write` OR `tag:all`
4677
4691
  *
4678
4692
  * @tags tags
4679
4693
  * @name TagsGetPost
@@ -4683,7 +4697,7 @@ class Api extends HttpClient {
4683
4697
  */
4684
4698
  this.tagsGetPost = (data, params = {}) => this.request(Object.assign({ path: `/tags.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
4685
4699
  /**
4686
- * @description Lists the available tags.
4700
+ * @description Lists the available tags. **Required scopes:** - `tag:read` OR `tag:write` OR `tag:all`
4687
4701
  *
4688
4702
  * @tags tags
4689
4703
  * @name TagsList
@@ -4693,7 +4707,7 @@ class Api extends HttpClient {
4693
4707
  */
4694
4708
  this.tagsList = (query, params = {}) => this.request(Object.assign({ path: `/tags.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
4695
4709
  /**
4696
- * @description Lists the available tags.
4710
+ * @description Lists the available tags. **Required scopes:** - `tag:read` OR `tag:write` OR `tag:all`
4697
4711
  *
4698
4712
  * @tags tags
4699
4713
  * @name TagsListPost
@@ -4703,7 +4717,7 @@ class Api extends HttpClient {
4703
4717
  */
4704
4718
  this.tagsListPost = (data, params = {}) => this.request(Object.assign({ path: `/tags.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
4705
4719
  /**
4706
- * @description Updates a tag's information.
4720
+ * @description Updates a tag's information. **Required scopes:** - `tag:write` OR `tag:all`
4707
4721
  *
4708
4722
  * @tags tags
4709
4723
  * @name TagsUpdate
@@ -4713,7 +4727,7 @@ class Api extends HttpClient {
4713
4727
  */
4714
4728
  this.tagsUpdate = (data, params = {}) => this.request(Object.assign({ path: `/tags.update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
4715
4729
  /**
4716
- * @description Creates a new entry on an object's timeline.
4730
+ * @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).
4717
4731
  *
4718
4732
  * @tags timeline-entries
4719
4733
  * @name TimelineEntriesCreate
@@ -4723,7 +4737,7 @@ class Api extends HttpClient {
4723
4737
  */
4724
4738
  this.timelineEntriesCreate = (data, params = {}) => this.request(Object.assign({ path: `/timeline-entries.create`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
4725
4739
  /**
4726
- * @description Deletes an entry from an object's timeline.
4740
+ * @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).
4727
4741
  *
4728
4742
  * @tags timeline-entries
4729
4743
  * @name TimelineEntriesDelete
@@ -4733,7 +4747,7 @@ class Api extends HttpClient {
4733
4747
  */
4734
4748
  this.timelineEntriesDelete = (data, params = {}) => this.request(Object.assign({ path: `/timeline-entries.delete`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
4735
4749
  /**
4736
- * @description Gets an entry on an object's timeline.
4750
+ * @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).
4737
4751
  *
4738
4752
  * @tags timeline-entries
4739
4753
  * @name TimelineEntriesGet
@@ -4743,7 +4757,7 @@ class Api extends HttpClient {
4743
4757
  */
4744
4758
  this.timelineEntriesGet = (query, params = {}) => this.request(Object.assign({ path: `/timeline-entries.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
4745
4759
  /**
4746
- * @description Gets an entry on an object's timeline.
4760
+ * @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).
4747
4761
  *
4748
4762
  * @tags timeline-entries
4749
4763
  * @name TimelineEntriesGetPost
@@ -4753,7 +4767,7 @@ class Api extends HttpClient {
4753
4767
  */
4754
4768
  this.timelineEntriesGetPost = (data, params = {}) => this.request(Object.assign({ path: `/timeline-entries.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
4755
4769
  /**
4756
- * @description Lists the timeline entries for an object.
4770
+ * @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).
4757
4771
  *
4758
4772
  * @tags timeline-entries
4759
4773
  * @name TimelineEntriesList
@@ -4763,7 +4777,7 @@ class Api extends HttpClient {
4763
4777
  */
4764
4778
  this.timelineEntriesList = (query, params = {}) => this.request(Object.assign({ path: `/timeline-entries.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
4765
4779
  /**
4766
- * @description Lists the timeline entries for an object.
4780
+ * @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).
4767
4781
  *
4768
4782
  * @tags timeline-entries
4769
4783
  * @name TimelineEntriesListPost
@@ -4773,7 +4787,7 @@ class Api extends HttpClient {
4773
4787
  */
4774
4788
  this.timelineEntriesListPost = (data, params = {}) => this.request(Object.assign({ path: `/timeline-entries.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
4775
4789
  /**
4776
- * @description Updates an entry on an object's timeline.
4790
+ * @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).
4777
4791
  *
4778
4792
  * @tags timeline-entries
4779
4793
  * @name TimelineEntriesUpdate
@@ -4783,7 +4797,7 @@ class Api extends HttpClient {
4783
4797
  */
4784
4798
  this.timelineEntriesUpdate = (data, params = {}) => this.request(Object.assign({ path: `/timeline-entries.update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
4785
4799
  /**
4786
- * @description Deletes the requested vista.
4800
+ * @description Deletes the requested vista. **Required scopes:** - `vista:all`
4787
4801
  *
4788
4802
  * @tags vistas
4789
4803
  * @name VistasDelete
@@ -4793,7 +4807,7 @@ class Api extends HttpClient {
4793
4807
  */
4794
4808
  this.vistasDelete = (data, params = {}) => this.request(Object.assign({ path: `/vistas.delete`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
4795
4809
  /**
4796
- * @description Gets the requested vistas's information.
4810
+ * @description Gets the requested vistas's information. **Required scopes:** - `vista:read` OR `vista:write` OR `vista:all`
4797
4811
  *
4798
4812
  * @tags vistas
4799
4813
  * @name VistasGet
@@ -4803,7 +4817,7 @@ class Api extends HttpClient {
4803
4817
  */
4804
4818
  this.vistasGet = (query, params = {}) => this.request(Object.assign({ path: `/vistas.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
4805
4819
  /**
4806
- * @description Gets the requested vistas's information.
4820
+ * @description Gets the requested vistas's information. **Required scopes:** - `vista:read` OR `vista:write` OR `vista:all`
4807
4821
  *
4808
4822
  * @tags vistas
4809
4823
  * @name VistasGetPost
@@ -4813,7 +4827,7 @@ class Api extends HttpClient {
4813
4827
  */
4814
4828
  this.vistasGetPost = (data, params = {}) => this.request(Object.assign({ path: `/vistas.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
4815
4829
  /**
4816
- * @description Deletes the requested vista group item
4830
+ * @description Deletes the requested vista group item **Required scopes:** - `vista:all` No scopes required for default vistas.
4817
4831
  *
4818
4832
  * @tags vistas
4819
4833
  * @name VistasGroupsDelete
@@ -4823,7 +4837,7 @@ class Api extends HttpClient {
4823
4837
  */
4824
4838
  this.vistasGroupsDelete = (data, params = {}) => this.request(Object.assign({ path: `/vistas.groups.delete`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
4825
4839
  /**
4826
- * @description Gets the requested vista group item's information.
4840
+ * @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.
4827
4841
  *
4828
4842
  * @tags vistas
4829
4843
  * @name VistasGroupsGet
@@ -4833,7 +4847,7 @@ class Api extends HttpClient {
4833
4847
  */
4834
4848
  this.vistasGroupsGet = (query, params = {}) => this.request(Object.assign({ path: `/vistas.groups.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
4835
4849
  /**
4836
- * @description Gets the requested vista group item's information.
4850
+ * @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.
4837
4851
  *
4838
4852
  * @tags vistas
4839
4853
  * @name VistasGroupsGetPost
@@ -4843,7 +4857,7 @@ class Api extends HttpClient {
4843
4857
  */
4844
4858
  this.vistasGroupsGetPost = (data, params = {}) => this.request(Object.assign({ path: `/vistas.groups.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
4845
4859
  /**
4846
- * @description Lists the available vista group items.
4860
+ * @description Lists the available vista group items. **Required scopes:** - `vista:read` OR `vista:write` OR `vista:all` No scopes required for default vistas.
4847
4861
  *
4848
4862
  * @tags vistas
4849
4863
  * @name VistasGroupsList
@@ -4853,7 +4867,7 @@ class Api extends HttpClient {
4853
4867
  */
4854
4868
  this.vistasGroupsList = (query, params = {}) => this.request(Object.assign({ path: `/vistas.groups.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
4855
4869
  /**
4856
- * @description Lists the available vista group items.
4870
+ * @description Lists the available vista group items. **Required scopes:** - `vista:read` OR `vista:write` OR `vista:all` No scopes required for default vistas.
4857
4871
  *
4858
4872
  * @tags vistas
4859
4873
  * @name VistasGroupsListPost
@@ -4863,7 +4877,7 @@ class Api extends HttpClient {
4863
4877
  */
4864
4878
  this.vistasGroupsListPost = (data, params = {}) => this.request(Object.assign({ path: `/vistas.groups.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
4865
4879
  /**
4866
- * @description Lists the available vistas.
4880
+ * @description Lists the available vistas. **Required scopes:** - `vista:read` OR `vista:write` OR `vista:all`
4867
4881
  *
4868
4882
  * @tags vistas
4869
4883
  * @name VistasList
@@ -4873,7 +4887,7 @@ class Api extends HttpClient {
4873
4887
  */
4874
4888
  this.vistasList = (query, params = {}) => this.request(Object.assign({ path: `/vistas.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
4875
4889
  /**
4876
- * @description Lists the available vistas.
4890
+ * @description Lists the available vistas. **Required scopes:** - `vista:read` OR `vista:write` OR `vista:all`
4877
4891
  *
4878
4892
  * @tags vistas
4879
4893
  * @name VistasListPost
@@ -4883,7 +4897,7 @@ class Api extends HttpClient {
4883
4897
  */
4884
4898
  this.vistasListPost = (data, params = {}) => this.request(Object.assign({ path: `/vistas.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
4885
4899
  /**
4886
- * @description Change state of a web crawler job to pause or resume it back to running.
4900
+ * @description Change state of a web crawler job to pause or resume it back to running. **Required scopes:** - `web_crawler_job:all`
4887
4901
  *
4888
4902
  * @tags web-crawler-job
4889
4903
  * @name WebCrawlerJobsControl
@@ -4893,7 +4907,7 @@ class Api extends HttpClient {
4893
4907
  */
4894
4908
  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));
4895
4909
  /**
4896
- * @description Creates a web crawler job whose objective is to crawl the provided URLs/sitemaps and generate corresponding webpages as artifacts.
4910
+ * @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`
4897
4911
  *
4898
4912
  * @tags web-crawler-job
4899
4913
  * @name CreateWebCrawlerJob
@@ -4903,7 +4917,7 @@ class Api extends HttpClient {
4903
4917
  */
4904
4918
  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));
4905
4919
  /**
4906
- * @description Gets a web crawler job.
4920
+ * @description Gets a web crawler job. **Required scopes:** - `web_crawler_job:all`
4907
4921
  *
4908
4922
  * @tags web-crawler-job
4909
4923
  * @name GetWebCrawlerJob
@@ -4913,7 +4927,7 @@ class Api extends HttpClient {
4913
4927
  */
4914
4928
  this.getWebCrawlerJob = (query, params = {}) => this.request(Object.assign({ path: `/web-crawler-jobs.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
4915
4929
  /**
4916
- * @description Gets a web crawler job.
4930
+ * @description Gets a web crawler job. **Required scopes:** - `web_crawler_job:all`
4917
4931
  *
4918
4932
  * @tags web-crawler-job
4919
4933
  * @name GetWebCrawlerJobPost
@@ -4923,7 +4937,7 @@ class Api extends HttpClient {
4923
4937
  */
4924
4938
  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));
4925
4939
  /**
4926
- * @description Lists web crawler jobs.
4940
+ * @description Lists web crawler jobs. **Required scopes:** - `web_crawler_job:all`
4927
4941
  *
4928
4942
  * @tags web-crawler-job
4929
4943
  * @name ListWebCrawlerJobs
@@ -4933,7 +4947,7 @@ class Api extends HttpClient {
4933
4947
  */
4934
4948
  this.listWebCrawlerJobs = (query, params = {}) => this.request(Object.assign({ path: `/web-crawler-jobs.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
4935
4949
  /**
4936
- * @description Lists web crawler jobs.
4950
+ * @description Lists web crawler jobs. **Required scopes:** - `web_crawler_job:all`
4937
4951
  *
4938
4952
  * @tags web-crawler-job
4939
4953
  * @name ListWebCrawlerJobsPost
@@ -4943,7 +4957,7 @@ class Api extends HttpClient {
4943
4957
  */
4944
4958
  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));
4945
4959
  /**
4946
- * @description Creates a new webhook target.
4960
+ * @description Creates a new webhook target. **Required scopes:** Default Scopes unavailable for this API.
4947
4961
  *
4948
4962
  * @tags webhooks
4949
4963
  * @name WebhooksCreate
@@ -4953,7 +4967,7 @@ class Api extends HttpClient {
4953
4967
  */
4954
4968
  this.webhooksCreate = (data, params = {}) => this.request(Object.assign({ path: `/webhooks.create`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
4955
4969
  /**
4956
- * @description Deletes the requested webhook.
4970
+ * @description Deletes the requested webhook. **Required scopes:** Default Scopes unavailable for this API.
4957
4971
  *
4958
4972
  * @tags webhooks
4959
4973
  * @name WebhooksDelete
@@ -4963,7 +4977,7 @@ class Api extends HttpClient {
4963
4977
  */
4964
4978
  this.webhooksDelete = (data, params = {}) => this.request(Object.assign({ path: `/webhooks.delete`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
4965
4979
  /**
4966
- * @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.
4980
+ * @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.
4967
4981
  *
4968
4982
  * @tags webhooks
4969
4983
  * @name WebhooksEvent
@@ -4973,7 +4987,7 @@ class Api extends HttpClient {
4973
4987
  */
4974
4988
  this.webhooksEvent = (data, params = {}) => this.request(Object.assign({ path: `/webhooks.event`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
4975
4989
  /**
4976
- * @description Gets the requested webhook's information.
4990
+ * @description Gets the requested webhook's information. **Required scopes:** Default Scopes unavailable for this API.
4977
4991
  *
4978
4992
  * @tags webhooks
4979
4993
  * @name WebhooksGet
@@ -4983,7 +4997,7 @@ class Api extends HttpClient {
4983
4997
  */
4984
4998
  this.webhooksGet = (query, params = {}) => this.request(Object.assign({ path: `/webhooks.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
4985
4999
  /**
4986
- * @description Gets the requested webhook's information.
5000
+ * @description Gets the requested webhook's information. **Required scopes:** Default Scopes unavailable for this API.
4987
5001
  *
4988
5002
  * @tags webhooks
4989
5003
  * @name WebhooksGetPost
@@ -4993,7 +5007,7 @@ class Api extends HttpClient {
4993
5007
  */
4994
5008
  this.webhooksGetPost = (data, params = {}) => this.request(Object.assign({ path: `/webhooks.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
4995
5009
  /**
4996
- * @description Lists the webhooks.
5010
+ * @description Lists the webhooks. **Required scopes:** Default Scopes unavailable for this API.
4997
5011
  *
4998
5012
  * @tags webhooks
4999
5013
  * @name WebhooksList
@@ -5003,7 +5017,7 @@ class Api extends HttpClient {
5003
5017
  */
5004
5018
  this.webhooksList = (query, params = {}) => this.request(Object.assign({ path: `/webhooks.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
5005
5019
  /**
5006
- * @description Lists the webhooks.
5020
+ * @description Lists the webhooks. **Required scopes:** Default Scopes unavailable for this API.
5007
5021
  *
5008
5022
  * @tags webhooks
5009
5023
  * @name WebhooksListPost
@@ -5013,7 +5027,7 @@ class Api extends HttpClient {
5013
5027
  */
5014
5028
  this.webhooksListPost = (data, params = {}) => this.request(Object.assign({ path: `/webhooks.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
5015
5029
  /**
5016
- * @description Updates the requested webhook.
5030
+ * @description Updates the requested webhook. **Required scopes:** Default Scopes unavailable for this API.
5017
5031
  *
5018
5032
  * @tags webhooks
5019
5033
  * @name WebhooksUpdate
@@ -5023,7 +5037,7 @@ class Api extends HttpClient {
5023
5037
  */
5024
5038
  this.webhooksUpdate = (data, params = {}) => this.request(Object.assign({ path: `/webhooks.update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
5025
5039
  /**
5026
- * @description Get count of work matching given filter.
5040
+ * @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` |
5027
5041
  *
5028
5042
  * @tags works
5029
5043
  * @name WorksCount
@@ -5033,7 +5047,7 @@ class Api extends HttpClient {
5033
5047
  */
5034
5048
  this.worksCount = (query, params = {}) => this.request(Object.assign({ path: `/works.count`, method: 'GET', query: query, secure: true, format: 'json' }, params));
5035
5049
  /**
5036
- * @description Get count of work matching given filter.
5050
+ * @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` |
5037
5051
  *
5038
5052
  * @tags works
5039
5053
  * @name WorksCountPost
@@ -5043,7 +5057,7 @@ class Api extends HttpClient {
5043
5057
  */
5044
5058
  this.worksCountPost = (data, params = {}) => this.request(Object.assign({ path: `/works.count`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
5045
5059
  /**
5046
- * @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.
5060
+ * @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` |
5047
5061
  *
5048
5062
  * @tags works
5049
5063
  * @name WorksCreate
@@ -5053,7 +5067,7 @@ class Api extends HttpClient {
5053
5067
  */
5054
5068
  this.worksCreate = (data, params = {}) => this.request(Object.assign({ path: `/works.create`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
5055
5069
  /**
5056
- * @description Deletes a work item.
5070
+ * @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` |
5057
5071
  *
5058
5072
  * @tags works
5059
5073
  * @name WorksDelete
@@ -5063,7 +5077,7 @@ class Api extends HttpClient {
5063
5077
  */
5064
5078
  this.worksDelete = (data, params = {}) => this.request(Object.assign({ path: `/works.delete`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
5065
5079
  /**
5066
- * @description Exports a collection of work items.
5080
+ * @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` |
5067
5081
  *
5068
5082
  * @tags works
5069
5083
  * @name WorksExport
@@ -5073,7 +5087,7 @@ class Api extends HttpClient {
5073
5087
  */
5074
5088
  this.worksExport = (query, params = {}) => this.request(Object.assign({ path: `/works.export`, method: 'GET', query: query, secure: true, format: 'json' }, params));
5075
5089
  /**
5076
- * @description Exports a collection of work items.
5090
+ * @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` |
5077
5091
  *
5078
5092
  * @tags works
5079
5093
  * @name WorksExportPost
@@ -5083,7 +5097,7 @@ class Api extends HttpClient {
5083
5097
  */
5084
5098
  this.worksExportPost = (data, params = {}) => this.request(Object.assign({ path: `/works.export`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
5085
5099
  /**
5086
- * @description Gets a work item's information.
5100
+ * @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` |
5087
5101
  *
5088
5102
  * @tags works
5089
5103
  * @name WorksGet
@@ -5093,7 +5107,7 @@ class Api extends HttpClient {
5093
5107
  */
5094
5108
  this.worksGet = (query, params = {}) => this.request(Object.assign({ path: `/works.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
5095
5109
  /**
5096
- * @description Gets a work item's information.
5110
+ * @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` |
5097
5111
  *
5098
5112
  * @tags works
5099
5113
  * @name WorksGetPost
@@ -5103,7 +5117,7 @@ class Api extends HttpClient {
5103
5117
  */
5104
5118
  this.worksGetPost = (data, params = {}) => this.request(Object.assign({ path: `/works.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
5105
5119
  /**
5106
- * @description Lists a collection of work items.
5120
+ * @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` |
5107
5121
  *
5108
5122
  * @tags works
5109
5123
  * @name WorksList
@@ -5113,7 +5127,7 @@ class Api extends HttpClient {
5113
5127
  */
5114
5128
  this.worksList = (query, params = {}) => this.request(Object.assign({ path: `/works.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
5115
5129
  /**
5116
- * @description Lists a collection of work items.
5130
+ * @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` |
5117
5131
  *
5118
5132
  * @tags works
5119
5133
  * @name WorksListPost
@@ -5123,7 +5137,7 @@ class Api extends HttpClient {
5123
5137
  */
5124
5138
  this.worksListPost = (data, params = {}) => this.request(Object.assign({ path: `/works.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
5125
5139
  /**
5126
- * @description Updates a work item's information.
5140
+ * @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` |
5127
5141
  *
5128
5142
  * @tags works
5129
5143
  * @name WorksUpdate