@devrev/typescript-sdk 1.1.74 → 1.1.75

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -3522,6 +3522,8 @@ export type Conversation = AtomBase & {
3522
3522
  * @example "2023-01-01T12:00:00.000Z"
3523
3523
  */
3524
3524
  actual_close_date?: string;
3525
+ /** The properties of an enum value. */
3526
+ ai_resolution_status?: EnumValue;
3525
3527
  /** Details of the parts relevant to the conversation. */
3526
3528
  applies_to_parts?: PartSummary[];
3527
3529
  /** Channel IDs of the conversation. */
@@ -3634,6 +3636,26 @@ export interface ConversationsCreateRequest {
3634
3636
  * @example "ACC-12345"
3635
3637
  */
3636
3638
  account?: string;
3639
+ /**
3640
+ * The AI resolution status enum ID for the conversation. Stock
3641
+ * allowed values:
3642
+ * ```
3643
+ * {
3644
+ * "id": 1,
3645
+ * "label": "deflected",
3646
+ * "ordinal": 1,
3647
+ * "overridable": false
3648
+ * },
3649
+ * {
3650
+ * "id": 2,
3651
+ * "label": "escalated",
3652
+ * "ordinal": 2,
3653
+ * "overridable": false
3654
+ * }
3655
+ * ```
3656
+ * @format int64
3657
+ */
3658
+ ai_resolution_status?: number;
3637
3659
  /**
3638
3660
  * The brand associated with the conversation.
3639
3661
  * @format id
@@ -3774,6 +3796,11 @@ export interface ConversationsListRequest {
3774
3796
  account?: string[];
3775
3797
  /** Provides ways to specify date ranges on objects. */
3776
3798
  actual_close_date?: DateFilter;
3799
+ /**
3800
+ * Filters for conversations with any of the provided AI resolution
3801
+ * statuses.
3802
+ */
3803
+ ai_resolution_status?: number[];
3777
3804
  /**
3778
3805
  * Filters for conversations belonging to any of the provided parts.
3779
3806
  * @example ["PROD-12345"]
@@ -3905,6 +3932,26 @@ export interface ConversationsUpdateRequest {
3905
3932
  * @example "ACC-12345"
3906
3933
  */
3907
3934
  account?: string | null;
3935
+ /**
3936
+ * The AI resolution status enum ID for the conversation. Stock
3937
+ * allowed values:
3938
+ * ```
3939
+ * {
3940
+ * "id": 1,
3941
+ * "label": "deflected",
3942
+ * "ordinal": 1,
3943
+ * "overridable": false
3944
+ * },
3945
+ * {
3946
+ * "id": 2,
3947
+ * "label": "escalated",
3948
+ * "ordinal": 2,
3949
+ * "overridable": false
3950
+ * }
3951
+ * ```
3952
+ * @format int64
3953
+ */
3954
+ ai_resolution_status?: number;
3908
3955
  applies_to_parts?: ConversationsUpdateRequestAppliesToParts;
3909
3956
  /**
3910
3957
  * The brand associated with the conversation.
@@ -5206,7 +5253,14 @@ export type CustomTypeFragmentSummary = CustomSchemaFragmentBaseSummary;
5206
5253
  */
5207
5254
  export type CustomTypePathComponent = object;
5208
5255
  /** dashboard */
5209
- export type Dashboard = AtomBase;
5256
+ export type Dashboard = AtomBase & {
5257
+ /**
5258
+ * Filters that should be shown as empty filter options on the
5259
+ * dashboard. The UI uses the data source schema to determine
5260
+ * appropriate filter controls for each field.
5261
+ */
5262
+ pinned_filters?: PinnedFilter[];
5263
+ };
5210
5264
  /**
5211
5265
  * dashboard-filter
5212
5266
  * A dashboard filter is a filter that can be applied to tabs, sections,
@@ -5791,6 +5845,11 @@ export type DevUser = UserBase & {
5791
5845
  experience_start_date?: string;
5792
5846
  /** IDs of the Dev User outside the DevRev SOR. */
5793
5847
  external_identities?: ExternalIdentity[];
5848
+ /**
5849
+ * Flag indicating if this user is currently invited. Remains true
5850
+ * even after the user accepts the invitation and becomes active.
5851
+ */
5852
+ is_invited?: boolean;
5794
5853
  /** Job history of the user. */
5795
5854
  job_history?: JobHistoryItem[];
5796
5855
  reports_to?: UserSummary;
@@ -7051,7 +7110,7 @@ export interface Error {
7051
7110
  * error-bad-request
7052
7111
  * Describes a error due to a bad request by the client.
7053
7112
  */
7054
- export type ErrorBadRequest = ErrorBase & (ErrorBadRequestArtifactAlreadyAttachedToAParent | ErrorBadRequestBadRequest | ErrorBadRequestCustomizationValidationError | ErrorBadRequestGroupHierarchyCircularDependency | ErrorBadRequestGroupHierarchyDepthExceeded | ErrorBadRequestGroupHierarchyInvalidParent | ErrorBadRequestIdNotFound | ErrorBadRequestInvalidApiVersion | ErrorBadRequestInvalidContentType | ErrorBadRequestInvalidEnumValue | ErrorBadRequestInvalidField | ErrorBadRequestInvalidId | ErrorBadRequestMergeWorksError | ErrorBadRequestMissingDependency | ErrorBadRequestMissingRequiredField | ErrorBadRequestParseError | ErrorBadRequestSpaceValidationErrors | ErrorBadRequestStaleSchemaFragments | ErrorBadRequestUnexpectedIdType | ErrorBadRequestUnexpectedJsonType | ErrorBadRequestValueNotPermitted | ErrorBadRequestWorkflowComponentValidationErrors) & {
7113
+ export type ErrorBadRequest = ErrorBase & (ErrorBadRequestArtifactAlreadyAttachedToAParent | ErrorBadRequestBadRequest | ErrorBadRequestCustomizationValidationError | ErrorBadRequestGroupHierarchyCircularDependency | ErrorBadRequestGroupHierarchyDepthExceeded | ErrorBadRequestGroupHierarchyInvalidParent | ErrorBadRequestIdNotFound | ErrorBadRequestInvalidApiVersion | ErrorBadRequestInvalidContentType | ErrorBadRequestInvalidEnumValue | ErrorBadRequestInvalidField | ErrorBadRequestInvalidId | ErrorBadRequestMergeWorksError | ErrorBadRequestMissingDependency | ErrorBadRequestMissingRequiredField | ErrorBadRequestOperationNotAllowed | ErrorBadRequestParseError | ErrorBadRequestSpaceValidationErrors | ErrorBadRequestStaleSchemaFragments | ErrorBadRequestUnexpectedIdType | ErrorBadRequestUnexpectedJsonType | ErrorBadRequestValueNotPermitted | ErrorBadRequestWorkflowComponentValidationErrors) & {
7055
7114
  type: ErrorBadRequestType;
7056
7115
  };
7057
7116
  /** error-bad-request-artifact-already-attached-to-a-parent */
@@ -7353,6 +7412,32 @@ export interface ErrorBadRequestMissingRequiredField {
7353
7412
  */
7354
7413
  field_name: string;
7355
7414
  }
7415
+ /**
7416
+ * error-bad-request-operation-not-allowed
7417
+ * The operation is not allowed because the current state of the system
7418
+ * blocks it.
7419
+ */
7420
+ export interface ErrorBadRequestOperationNotAllowed {
7421
+ /**
7422
+ * The current value of the blocking field.
7423
+ * @format text
7424
+ */
7425
+ current_value?: string;
7426
+ /** The values that would allow the operation to proceed. */
7427
+ expected_values?: string[];
7428
+ /**
7429
+ * Dot-notation path to the field blocking the operation (e.g.
7430
+ * 'state', 'ai_agent.default_version_id',
7431
+ * 'default_version_id.state').
7432
+ * @format text
7433
+ */
7434
+ field_path: string;
7435
+ /**
7436
+ * Why the operation is not allowed.
7437
+ * @format text
7438
+ */
7439
+ reason?: string;
7440
+ }
7356
7441
  /** error-bad-request-parse-error */
7357
7442
  export type ErrorBadRequestParseError = object;
7358
7443
  /**
@@ -7457,6 +7542,7 @@ export declare enum ErrorBadRequestType {
7457
7542
  MergeWorksError = "merge_works_error",
7458
7543
  MissingDependency = "missing_dependency",
7459
7544
  MissingRequiredField = "missing_required_field",
7545
+ OperationNotAllowed = "operation_not_allowed",
7460
7546
  ParseError = "parse_error",
7461
7547
  SpaceValidationErrors = "space_validation_errors",
7462
7548
  StaleSchemaFragments = "stale_schema_fragments",
@@ -8281,11 +8367,47 @@ export interface EventWorkflowDeleted {
8281
8367
  id: string;
8282
8368
  old_workflow?: Workflow;
8283
8369
  }
8370
+ /** event-workflow-step-created */
8371
+ export interface EventWorkflowStepCreated {
8372
+ workflow_step: WorkflowStep;
8373
+ }
8374
+ /** event-workflow-step-deleted */
8375
+ export interface EventWorkflowStepDeleted {
8376
+ /**
8377
+ * The ID of the workflow step that was deleted.
8378
+ * @format id
8379
+ */
8380
+ id: string;
8381
+ old_workflow_step?: WorkflowStep;
8382
+ }
8383
+ /** event-workflow-step-updated */
8384
+ export interface EventWorkflowStepUpdated {
8385
+ old_workflow_step?: WorkflowStep;
8386
+ workflow_step: WorkflowStep;
8387
+ }
8284
8388
  /** event-workflow-updated */
8285
8389
  export interface EventWorkflowUpdated {
8286
8390
  old_workflow?: Workflow;
8287
8391
  workflow: Workflow;
8288
8392
  }
8393
+ /** event-workflow-version-created */
8394
+ export interface EventWorkflowVersionCreated {
8395
+ workflow_version: WorkflowVersion;
8396
+ }
8397
+ /** event-workflow-version-deleted */
8398
+ export interface EventWorkflowVersionDeleted {
8399
+ /**
8400
+ * The ID of the workflow version that was deleted.
8401
+ * @format id
8402
+ */
8403
+ id: string;
8404
+ old_workflow_version?: WorkflowVersion;
8405
+ }
8406
+ /** event-workflow-version-updated */
8407
+ export interface EventWorkflowVersionUpdated {
8408
+ old_workflow_version?: WorkflowVersion;
8409
+ workflow_version: WorkflowVersion;
8410
+ }
8289
8411
  /** external-communication-channel-summary */
8290
8412
  export type ExternalCommunicationChannelSummary = AtomBaseSummary;
8291
8413
  /**
@@ -8909,8 +9031,7 @@ export type GroupedVista = VistaBase & {
8909
9031
  flavor?: GroupedVistaFlavor;
8910
9032
  /** Automations specific to the Sprint Board vistas. */
8911
9033
  sprint_board_automation?: SprintBoardAutomation;
8912
- /** Settings specific to sprint board vistas. */
8913
- sprint_board_config?: SprintBoardConfig;
9034
+ sprint_board_config?: GroupedVistaSprintBoardConfig;
8914
9035
  };
8915
9036
  /** Type of DevRev object for which the grouped vista is applicable. */
8916
9037
  export declare enum GroupedVistaFilterType {
@@ -8924,6 +9045,38 @@ export declare enum GroupedVistaFlavor {
8924
9045
  SprintBoard = "sprint_board",
8925
9046
  SupportInbox = "support_inbox"
8926
9047
  }
9048
+ /** grouped-vista-sprint-board-config */
9049
+ export interface GroupedVistaSprintBoardConfig {
9050
+ /**
9051
+ * Cooldown period in days between sprints.
9052
+ * @format int32
9053
+ */
9054
+ cooldown?: number;
9055
+ /**
9056
+ * Sprint duration in days.
9057
+ * @format int32
9058
+ */
9059
+ duration?: number;
9060
+ /**
9061
+ * Number of planned sprints for the sprint board.
9062
+ * @format int32
9063
+ */
9064
+ planned_sprints?: number;
9065
+ sprint_name_config?: GroupedVistaSprintNamingConfig;
9066
+ }
9067
+ /** grouped-vista-sprint-naming-config */
9068
+ export interface GroupedVistaSprintNamingConfig {
9069
+ /**
9070
+ * The number to assign to the next sprint created.
9071
+ * @format int32
9072
+ */
9073
+ next_sprint_number?: number;
9074
+ /**
9075
+ * Template for naming sprints.
9076
+ * @format text
9077
+ */
9078
+ sprint_name_template?: string;
9079
+ }
8927
9080
  /**
8928
9081
  * groups-create-request
8929
9082
  * A request to create a new group.
@@ -8993,6 +9146,8 @@ export interface GroupsListRequest {
8993
9146
  group_type?: GroupType[];
8994
9147
  /** Filter groups by ingestion source(s). */
8995
9148
  ingestion_source?: GroupIngestionSource[];
9149
+ /** Filters the groups on the basis of archival status. */
9150
+ is_archived?: boolean;
8996
9151
  /** Whether to fetch default or custom groups. */
8997
9152
  is_default?: boolean;
8998
9153
  /**
@@ -10146,7 +10301,18 @@ export type MarketplaceItemSummary = AtomBaseSummary & {
10146
10301
  * @format text
10147
10302
  */
10148
10303
  tagline?: string;
10304
+ /**
10305
+ * Version information for a marketplace listing, specifying the semantic
10306
+ * version being shipped to users.
10307
+ */
10308
+ version?: MarketplaceListingVersionSummary;
10149
10309
  };
10310
+ /**
10311
+ * marketplace-listing-version-summary
10312
+ * Version information for a marketplace listing, specifying the semantic
10313
+ * version being shipped to users.
10314
+ */
10315
+ export type MarketplaceListingVersionSummary = object;
10150
10316
  /**
10151
10317
  * meerkat-widget-column-function
10152
10318
  * Deprecated: Use widget_query_column_config with type=function on
@@ -10261,10 +10427,18 @@ export type Meeting = AtomBase & {
10261
10427
  * @format text
10262
10428
  */
10263
10429
  external_url?: string;
10430
+ /**
10431
+ * Whether this meeting has been archived as a secondary record in a
10432
+ * merge. Archived meetings are excluded from list, count, group, and
10433
+ * search endpoints, but remain retrievable via meetings.get so
10434
+ * clients can follow the merge reference using primary_meeting.
10435
+ */
10436
+ is_archived?: boolean;
10264
10437
  /** The members in the meeting. */
10265
10438
  members?: AtomSummary[];
10266
10439
  organizer?: AtomSummary;
10267
10440
  parent?: AtomSummary;
10441
+ primary_meeting?: MeetingSummary;
10268
10442
  recording?: ArtifactSummary;
10269
10443
  /**
10270
10444
  * Recording URL of the meeting.
@@ -10732,6 +10906,10 @@ export interface MeetingsUpdateRequestMembers {
10732
10906
  }
10733
10907
  /** meetings-update-request-tags */
10734
10908
  export interface MeetingsUpdateRequestTags {
10909
+ /** Adds the provided tags on the meeting item. */
10910
+ add?: AddTagWithValue[];
10911
+ /** Removes the provided tags on the meeting item. */
10912
+ remove?: RemoveTagWithValue[];
10735
10913
  /** Sets the provided tags on the meeting item. */
10736
10914
  set?: SetTagWithValue[];
10737
10915
  }
@@ -11445,14 +11623,23 @@ export interface Money {
11445
11623
  }
11446
11624
  /** network-log */
11447
11625
  export interface NetworkLog {
11448
- /**
11449
- * Type of the network log.
11450
- * @format text
11451
- */
11452
- type: string;
11626
+ /** The type of network log. */
11627
+ type: NetworkLogType;
11453
11628
  request: ObservabilityNetworkRequest;
11454
11629
  response: ObservabilityNetworkResponse;
11455
11630
  }
11631
+ /** The type of network log. */
11632
+ export declare enum NetworkLogType {
11633
+ Css = "css",
11634
+ Fetch = "fetch",
11635
+ Font = "font",
11636
+ Iframe = "iframe",
11637
+ Img = "img",
11638
+ Link = "link",
11639
+ Other = "other",
11640
+ Script = "script",
11641
+ Xhr = "xhr"
11642
+ }
11456
11643
  /** notification-content-template */
11457
11644
  export type NotificationContentTemplate = ContentTemplateBase;
11458
11645
  /** notification-content-template-summary */
@@ -13136,6 +13323,19 @@ export interface PingResponse {
13136
13323
  */
13137
13324
  timestamp: string;
13138
13325
  }
13326
+ /**
13327
+ * pinned-filter
13328
+ * A pinned filter declares a field that should be shown as an empty
13329
+ * filter option in the UI. The UI uses the data source schema to
13330
+ * determine the appropriate filter control for the field.
13331
+ */
13332
+ export interface PinnedFilter {
13333
+ /**
13334
+ * The field reference name from the data source schema.
13335
+ * @format text
13336
+ */
13337
+ reference_name: string;
13338
+ }
13139
13339
  /** preferences-base */
13140
13340
  export type PreferencesBase = AtomBase;
13141
13341
  /** preferences-base-summary */
@@ -16153,29 +16353,13 @@ export interface SprintBoardAutomation {
16153
16353
  * enabled or not.
16154
16354
  */
16155
16355
  auto_issue_rollover_enabled?: boolean;
16156
- /** Whether this sprintboard has opted for mid-sprint status updates. */
16157
- sprint_status_update_enabled?: boolean;
16158
- }
16159
- /**
16160
- * sprint-board-config
16161
- * Settings specific to sprint board vistas.
16162
- */
16163
- export interface SprintBoardConfig {
16164
16356
  /**
16165
- * Cooldown period in days between sprints.
16166
- * @format int32
16357
+ * Whether issues should be moved to Backlog stage when removed from a
16358
+ * sprint.
16167
16359
  */
16168
- cooldown?: number;
16169
- /**
16170
- * Sprint duration in days.
16171
- * @format int32
16172
- */
16173
- duration?: number;
16174
- /**
16175
- * Number of planned sprints for the sprint board.
16176
- * @format int32
16177
- */
16178
- planned_sprints?: number;
16360
+ move_issues_to_backlog_on_sprint_removal_enabled?: boolean;
16361
+ /** Whether this sprintboard has opted for mid-sprint status updates. */
16362
+ sprint_status_update_enabled?: boolean;
16179
16363
  }
16180
16364
  /**
16181
16365
  * stage
@@ -16537,6 +16721,12 @@ export interface StockSchemaFragmentsListResponse {
16537
16721
  * widget.
16538
16722
  */
16539
16723
  export interface SubWidget {
16724
+ /**
16725
+ * Filters that should be shown as empty filter options in the list
16726
+ * view. The UI uses the data source schema to determine appropriate
16727
+ * filter controls for each field.
16728
+ */
16729
+ pinned_filters?: PinnedFilter[];
16540
16730
  /**
16541
16731
  * The query for a widget. This includes measures and dimensions to be
16542
16732
  * visualized.
@@ -18118,8 +18308,14 @@ export interface TimelineEntriesListRequest {
18118
18308
  /**
18119
18309
  * The collection(s) to list entries from, otherwise if not provided,
18120
18310
  * all entries are returned.
18311
+ * @maxItems 1
18121
18312
  */
18122
18313
  collections?: TimelineEntriesCollection[];
18314
+ /**
18315
+ * Filters for entries created by any of the provided users.
18316
+ * @example ["DEVU-12345"]
18317
+ */
18318
+ created_by?: string[];
18123
18319
  created_date?: DateTimeFilter;
18124
18320
  /**
18125
18321
  * The cursor to resume iteration from. If not provided, then
@@ -18826,6 +19022,12 @@ export interface VistaGroupBase {
18826
19022
  * @maxLength 16000
18827
19023
  */
18828
19024
  goals?: string;
19025
+ /**
19026
+ * The artifact ID of the goals document for sprint.
19027
+ * @format id
19028
+ * @example "ARTIFACT-12345"
19029
+ */
19030
+ goals_document?: string;
18829
19031
  /**
18830
19032
  * Globally unique object ID.
18831
19033
  * @format id
@@ -19816,7 +20018,13 @@ export interface WebhookEventRequest {
19816
20018
  work_updated?: EventWorkUpdated;
19817
20019
  workflow_created?: EventWorkflowCreated;
19818
20020
  workflow_deleted?: EventWorkflowDeleted;
20021
+ workflow_step_created?: EventWorkflowStepCreated;
20022
+ workflow_step_deleted?: EventWorkflowStepDeleted;
20023
+ workflow_step_updated?: EventWorkflowStepUpdated;
19819
20024
  workflow_updated?: EventWorkflowUpdated;
20025
+ workflow_version_created?: EventWorkflowVersionCreated;
20026
+ workflow_version_deleted?: EventWorkflowVersionDeleted;
20027
+ workflow_version_updated?: EventWorkflowVersionUpdated;
19820
20028
  }
19821
20029
  /** webhook-event-response */
19822
20030
  export interface WebhookEventResponse {
@@ -20714,8 +20922,12 @@ export declare enum WorkType {
20714
20922
  export type Workflow = AtomBase;
20715
20923
  /** workflow-run-summary */
20716
20924
  export type WorkflowRunSummary = AtomBaseSummary;
20925
+ /** workflow-step */
20926
+ export type WorkflowStep = AtomBase;
20717
20927
  /** workflow-summary */
20718
20928
  export type WorkflowSummary = AtomBaseSummary;
20929
+ /** workflow-version */
20930
+ export type WorkflowVersion = AtomBase;
20719
20931
  /** works-count-request */
20720
20932
  export interface WorksCountRequest {
20721
20933
  /** Filters for work of the provided types. */
@@ -21866,7 +22078,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
21866
22078
  */
21867
22079
  export declare class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDataType> {
21868
22080
  /**
21869
- * @description Creates an account, which is a record representing a customer or an organization.
22081
+ * @description Creates an account, which is a record representing a customer or an organization. **Required scopes:** - `account:write` OR `account:all`
21870
22082
  *
21871
22083
  * @tags accounts
21872
22084
  * @name AccountsCreate
@@ -21876,7 +22088,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
21876
22088
  */
21877
22089
  accountsCreate: (data: AccountsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<AccountsCreateResponse, any, {}>>;
21878
22090
  /**
21879
- * @description Deletes an account.
22091
+ * @description Deletes an account. **Required scopes:** - `account:all`
21880
22092
  *
21881
22093
  * @tags accounts
21882
22094
  * @name AccountsDelete
@@ -21886,7 +22098,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
21886
22098
  */
21887
22099
  accountsDelete: (data: AccountsDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
21888
22100
  /**
21889
- * @description Exports a collection of accounts.
22101
+ * @description Exports a collection of accounts. **Required scopes:** - `account:read` OR `account:write` OR `account:all`
21890
22102
  *
21891
22103
  * @tags accounts
21892
22104
  * @name AccountsExport
@@ -21954,7 +22166,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
21954
22166
  websites?: string[];
21955
22167
  }, params?: RequestParams) => Promise<AxiosResponse<AccountsExportResponse, any, {}>>;
21956
22168
  /**
21957
- * @description Exports a collection of accounts.
22169
+ * @description Exports a collection of accounts. **Required scopes:** - `account:read` OR `account:write` OR `account:all`
21958
22170
  *
21959
22171
  * @tags accounts
21960
22172
  * @name AccountsExportPost
@@ -21964,7 +22176,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
21964
22176
  */
21965
22177
  accountsExportPost: (data: AccountsExportRequest, params?: RequestParams) => Promise<AxiosResponse<AccountsExportResponse, any, {}>>;
21966
22178
  /**
21967
- * @description Retrieves an account's information.
22179
+ * @description Retrieves an account's information. **Required scopes:** - `account:read` OR `account:write` OR `account:all`
21968
22180
  *
21969
22181
  * @tags accounts
21970
22182
  * @name AccountsGet
@@ -21981,7 +22193,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
21981
22193
  id: string;
21982
22194
  }, params?: RequestParams) => Promise<AxiosResponse<AccountsGetResponse, any, {}>>;
21983
22195
  /**
21984
- * @description Retrieves an account's information.
22196
+ * @description Retrieves an account's information. **Required scopes:** - `account:read` OR `account:write` OR `account:all`
21985
22197
  *
21986
22198
  * @tags accounts
21987
22199
  * @name AccountsGetPost
@@ -21991,7 +22203,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
21991
22203
  */
21992
22204
  accountsGetPost: (data: AccountsGetRequest, params?: RequestParams) => Promise<AxiosResponse<AccountsGetResponse, any, {}>>;
21993
22205
  /**
21994
- * @description Gets a list of accounts.
22206
+ * @description Gets a list of accounts. **Required scopes:** - `account:read` OR `account:write` OR `account:all`
21995
22207
  *
21996
22208
  * @tags accounts
21997
22209
  * @name AccountsList
@@ -22069,7 +22281,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
22069
22281
  websites?: string[];
22070
22282
  }, params?: RequestParams) => Promise<AxiosResponse<AccountsListResponse, any, {}>>;
22071
22283
  /**
22072
- * @description Gets a list of accounts.
22284
+ * @description Gets a list of accounts. **Required scopes:** - `account:read` OR `account:write` OR `account:all`
22073
22285
  *
22074
22286
  * @tags accounts
22075
22287
  * @name AccountsListPost
@@ -22079,7 +22291,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
22079
22291
  */
22080
22292
  accountsListPost: (data: AccountsListRequest, params?: RequestParams) => Promise<AxiosResponse<AccountsListResponse, any, {}>>;
22081
22293
  /**
22082
- * @description Merges two accounts.
22294
+ * @description Merges two accounts. **Required scopes:** - `account:all`
22083
22295
  *
22084
22296
  * @tags accounts
22085
22297
  * @name AccountsMerge
@@ -22089,7 +22301,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
22089
22301
  */
22090
22302
  accountsMerge: (data: AccountsMergeRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
22091
22303
  /**
22092
- * @description Updates an account's information.
22304
+ * @description Updates an account's information. **Required scopes:** - `account:write` OR `account:all`
22093
22305
  *
22094
22306
  * @tags accounts
22095
22307
  * @name AccountsUpdate
@@ -22099,7 +22311,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
22099
22311
  */
22100
22312
  accountsUpdate: (data: AccountsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<AccountsUpdateResponse, any, {}>>;
22101
22313
  /**
22102
- * @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.
22314
+ * @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`
22103
22315
  *
22104
22316
  * @tags articles
22105
22317
  * @name CreateArticle
@@ -22109,7 +22321,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
22109
22321
  */
22110
22322
  createArticle: (data: ArticlesCreateRequest, params?: RequestParams) => Promise<AxiosResponse<ArticlesCreateResponse, any, {}>>;
22111
22323
  /**
22112
- * @description Deletes an article.
22324
+ * @description Deletes an article. **Required scopes:** - `article:all`
22113
22325
  *
22114
22326
  * @tags articles
22115
22327
  * @name DeleteArticle
@@ -22119,7 +22331,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
22119
22331
  */
22120
22332
  deleteArticle: (data: ArticlesDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
22121
22333
  /**
22122
- * @description Gets an article.
22334
+ * @description Gets an article. **Required scopes:** - `article:read` OR `article:write` OR `article:all`
22123
22335
  *
22124
22336
  * @tags articles
22125
22337
  * @name GetArticle
@@ -22143,7 +22355,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
22143
22355
  parent_article_id?: string;
22144
22356
  }, params?: RequestParams) => Promise<AxiosResponse<ArticlesGetResponse, any, {}>>;
22145
22357
  /**
22146
- * @description Gets an article.
22358
+ * @description Gets an article. **Required scopes:** - `article:read` OR `article:write` OR `article:all`
22147
22359
  *
22148
22360
  * @tags articles
22149
22361
  * @name GetArticlePost
@@ -22153,7 +22365,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
22153
22365
  */
22154
22366
  getArticlePost: (data: ArticlesGetRequest, params?: RequestParams) => Promise<AxiosResponse<ArticlesGetResponse, any, {}>>;
22155
22367
  /**
22156
- * @description Lists a collection of articles.
22368
+ * @description Lists a collection of articles. **Required scopes:** - `article:read` OR `article:write` OR `article:all`
22157
22369
  *
22158
22370
  * @tags articles
22159
22371
  * @name ListArticles
@@ -22253,7 +22465,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
22253
22465
  tags?: string[];
22254
22466
  }, params?: RequestParams) => Promise<AxiosResponse<ArticlesListResponse, any, {}>>;
22255
22467
  /**
22256
- * @description Lists a collection of articles.
22468
+ * @description Lists a collection of articles. **Required scopes:** - `article:read` OR `article:write` OR `article:all`
22257
22469
  *
22258
22470
  * @tags articles
22259
22471
  * @name ListArticlesPost
@@ -22263,7 +22475,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
22263
22475
  */
22264
22476
  listArticlesPost: (data: ArticlesListRequest, params?: RequestParams) => Promise<AxiosResponse<ArticlesListResponse, any, {}>>;
22265
22477
  /**
22266
- * @description Updates an article.
22478
+ * @description Updates an article. **Required scopes:** - `article:write` OR `article:all`
22267
22479
  *
22268
22480
  * @tags articles
22269
22481
  * @name UpdateArticle
@@ -22273,7 +22485,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
22273
22485
  */
22274
22486
  updateArticle: (data: ArticlesUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<ArticlesUpdateResponse, any, {}>>;
22275
22487
  /**
22276
- * @description Redirects to the artifact's download URL.
22488
+ * @description Redirects to the artifact's download URL. **Required scopes:** - `artifact:read`
22277
22489
  *
22278
22490
  * @tags artifacts
22279
22491
  * @name ArtifactsDownload
@@ -22300,7 +22512,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
22300
22512
  version?: string;
22301
22513
  }, params?: RequestParams) => Promise<AxiosResponse<any, any, {}>>;
22302
22514
  /**
22303
- * @description Redirects to the artifact's download URL.
22515
+ * @description Redirects to the artifact's download URL. **Required scopes:** - `artifact:read`
22304
22516
  *
22305
22517
  * @tags artifacts
22306
22518
  * @name ArtifactsDownloadPost
@@ -22310,7 +22522,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
22310
22522
  */
22311
22523
  artifactsDownloadPost: (data: ArtifactsDownloadRequest, params?: RequestParams) => Promise<AxiosResponse<any, any, {}>>;
22312
22524
  /**
22313
- * @description Gets the requested artifact's information.
22525
+ * @description Gets the requested artifact's information. **Required scopes:** - `artifact:read` Also needs parent read access.
22314
22526
  *
22315
22527
  * @tags artifacts
22316
22528
  * @name ArtifactsGet
@@ -22332,7 +22544,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
22332
22544
  version?: string;
22333
22545
  }, params?: RequestParams) => Promise<AxiosResponse<ArtifactsGetResponse, any, {}>>;
22334
22546
  /**
22335
- * @description Gets the requested artifact's information.
22547
+ * @description Gets the requested artifact's information. **Required scopes:** - `artifact:read` Also needs parent read access.
22336
22548
  *
22337
22549
  * @tags artifacts
22338
22550
  * @name ArtifactsGetPost
@@ -22342,7 +22554,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
22342
22554
  */
22343
22555
  artifactsGetPost: (data: ArtifactsGetRequest, params?: RequestParams) => Promise<AxiosResponse<ArtifactsGetResponse, any, {}>>;
22344
22556
  /**
22345
- * @description List the artifacts attached to an object.
22557
+ * @description List the artifacts attached to an object. **Required scopes:** - `artifact:read` Also needs parent read access.
22346
22558
  *
22347
22559
  * @tags artifacts
22348
22560
  * @name ArtifactsList
@@ -22358,7 +22570,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
22358
22570
  parent_id?: string;
22359
22571
  }, params?: RequestParams) => Promise<AxiosResponse<ArtifactsListResponse, any, {}>>;
22360
22572
  /**
22361
- * @description List the artifacts attached to an object.
22573
+ * @description List the artifacts attached to an object. **Required scopes:** - `artifact:read` Also needs parent read access.
22362
22574
  *
22363
22575
  * @tags artifacts
22364
22576
  * @name ArtifactsListPost
@@ -22368,7 +22580,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
22368
22580
  */
22369
22581
  artifactsListPost: (data: ArtifactsListRequest, params?: RequestParams) => Promise<AxiosResponse<ArtifactsListResponse, any, {}>>;
22370
22582
  /**
22371
- * @description Gets the download URL for the artifact.
22583
+ * @description Gets the download URL for the artifact. **Required scopes:** - `artifact:read` Also needs parent read access.
22372
22584
  *
22373
22585
  * @tags artifacts
22374
22586
  * @name ArtifactsLocate
@@ -22390,7 +22602,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
22390
22602
  version?: string;
22391
22603
  }, params?: RequestParams) => Promise<AxiosResponse<ArtifactsLocateResponse, any, {}>>;
22392
22604
  /**
22393
- * @description Gets the download URL for the artifact.
22605
+ * @description Gets the download URL for the artifact. **Required scopes:** - `artifact:read` Also needs parent read access.
22394
22606
  *
22395
22607
  * @tags artifacts
22396
22608
  * @name ArtifactsLocatePost
@@ -22400,7 +22612,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
22400
22612
  */
22401
22613
  artifactsLocatePost: (data: ArtifactsLocateRequest, params?: RequestParams) => Promise<AxiosResponse<ArtifactsLocateResponse, any, {}>>;
22402
22614
  /**
22403
- * @description Creates an artifact and generates an upload URL for its data.
22615
+ * @description Creates an artifact and generates an upload URL for its data. **Required scopes:** - `artifact:create`
22404
22616
  *
22405
22617
  * @tags artifacts
22406
22618
  * @name ArtifactsPrepare
@@ -22410,7 +22622,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
22410
22622
  */
22411
22623
  artifactsPrepare: (data: ArtifactsPrepareRequest, params?: RequestParams) => Promise<AxiosResponse<ArtifactsPrepareResponse, any, {}>>;
22412
22624
  /**
22413
- * @description Permanently deletes a version of an artifact.
22625
+ * @description Permanently deletes a version of an artifact. **Required scopes:** - `artifact:create`
22414
22626
  *
22415
22627
  * @tags artifacts
22416
22628
  * @name ArtifactsHardDeleteVersion
@@ -22420,7 +22632,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
22420
22632
  */
22421
22633
  artifactsHardDeleteVersion: (data: ArtifactsHardDeleteVersionRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
22422
22634
  /**
22423
- * @description Prepares a new version for an artifact, returning the URL and form data to upload the updated file.
22635
+ * @description Prepares a new version for an artifact, returning the URL and form data to upload the updated file. **Required scopes:** - `artifact:create`
22424
22636
  *
22425
22637
  * @tags artifacts
22426
22638
  * @name ArtifactsVersionsPrepare
@@ -22456,7 +22668,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
22456
22668
  */
22457
22669
  atomsGetPost: (data: AtomsGetRequest, params?: RequestParams) => Promise<AxiosResponse<AtomsGetResponse, any, {}>>;
22458
22670
  /**
22459
- * @description Creates a JWT corresponding to the requested token type for the authenticated user.
22671
+ * @description Creates a JWT corresponding to the requested token type for the authenticated user. **Required scopes:** No scopes required.
22460
22672
  *
22461
22673
  * @tags auth-tokens
22462
22674
  * @name AuthTokensCreate
@@ -22466,7 +22678,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
22466
22678
  */
22467
22679
  authTokensCreate: (data: AuthTokensCreateRequest, params?: RequestParams) => Promise<AxiosResponse<AuthTokensCreateResponse, any, {}>>;
22468
22680
  /**
22469
- * @description Revokes the token that matches the given token ID issued under the given Dev organization.
22681
+ * @description Revokes the token that matches the given token ID issued under the given Dev organization. **Required scopes:** No scopes required.
22470
22682
  *
22471
22683
  * @tags auth-tokens
22472
22684
  * @name AuthTokensDelete
@@ -22476,7 +22688,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
22476
22688
  */
22477
22689
  authTokensDelete: (data: AuthTokensDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
22478
22690
  /**
22479
- * @description Gets the token metadata corresponding to the given token ID under the given Dev organization.
22691
+ * @description Gets the token metadata corresponding to the given token ID under the given Dev organization. **Required scopes:** No scopes required.
22480
22692
  *
22481
22693
  * @tags auth-tokens
22482
22694
  * @name AuthTokensGet
@@ -22492,7 +22704,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
22492
22704
  token_id: string;
22493
22705
  }, params?: RequestParams) => Promise<AxiosResponse<AuthTokensGetResponse, any, {}>>;
22494
22706
  /**
22495
- * @description Gets the token metadata corresponding to the given token ID under the given Dev organization.
22707
+ * @description Gets the token metadata corresponding to the given token ID under the given Dev organization. **Required scopes:** No scopes required.
22496
22708
  *
22497
22709
  * @tags auth-tokens
22498
22710
  * @name AuthTokensGetPost
@@ -22502,7 +22714,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
22502
22714
  */
22503
22715
  authTokensGetPost: (data: AuthTokensGetRequest, params?: RequestParams) => Promise<AxiosResponse<AuthTokensGetResponse, any, {}>>;
22504
22716
  /**
22505
- * @description Returns the Dev organization, user and token attributes extracted from the auth token.
22717
+ * @description Returns the Dev organization, user and token attributes extracted from the auth token. **Required scopes:** No scopes required.
22506
22718
  *
22507
22719
  * @tags auth-tokens
22508
22720
  * @name AuthTokensInfo
@@ -22512,7 +22724,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
22512
22724
  */
22513
22725
  authTokensInfo: (params?: RequestParams) => Promise<AxiosResponse<AuthTokensInfoResponse, any, {}>>;
22514
22726
  /**
22515
- * @description Returns the Dev organization, user and token attributes extracted from the auth token.
22727
+ * @description Returns the Dev organization, user and token attributes extracted from the auth token. **Required scopes:** No scopes required.
22516
22728
  *
22517
22729
  * @tags auth-tokens
22518
22730
  * @name AuthTokensInfoPost
@@ -22522,7 +22734,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
22522
22734
  */
22523
22735
  authTokensInfoPost: (data: AuthTokensInfoRequest, params?: RequestParams) => Promise<AxiosResponse<AuthTokensInfoResponse, any, {}>>;
22524
22736
  /**
22525
- * @description Gets the token metadata for all the tokens corresponding to the given token type issued for a given subject.
22737
+ * @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.
22526
22738
  *
22527
22739
  * @tags auth-tokens
22528
22740
  * @name AuthTokensList
@@ -22551,7 +22763,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
22551
22763
  subject?: string;
22552
22764
  }, params?: RequestParams) => Promise<AxiosResponse<AuthTokensListResponse, any, {}>>;
22553
22765
  /**
22554
- * @description Gets the token metadata for all the tokens corresponding to the given token type issued for a given subject.
22766
+ * @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.
22555
22767
  *
22556
22768
  * @tags auth-tokens
22557
22769
  * @name AuthTokensListPost
@@ -22561,7 +22773,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
22561
22773
  */
22562
22774
  authTokensListPost: (data: AuthTokensListRequest, params?: RequestParams) => Promise<AxiosResponse<AuthTokensListResponse, any, {}>>;
22563
22775
  /**
22564
- * @description Revokes all the tokens that matches the given token type created by the authenticated user.
22776
+ * @description Revokes all the tokens that matches the given token type created by the authenticated user. **Required scopes:** No scopes required.
22565
22777
  *
22566
22778
  * @tags auth-tokens
22567
22779
  * @name AuthTokensSelfDelete
@@ -22571,7 +22783,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
22571
22783
  */
22572
22784
  authTokensSelfDelete: (data: AuthTokensSelfDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
22573
22785
  /**
22574
- * @description Updates token metadata of a token issued under a given Dev organization.
22786
+ * @description Updates token metadata of a token issued under a given Dev organization. **Required scopes:** No scopes required.
22575
22787
  *
22576
22788
  * @tags auth-tokens
22577
22789
  * @name AuthTokensUpdate
@@ -22581,7 +22793,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
22581
22793
  */
22582
22794
  authTokensUpdate: (data: AuthTokensUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<AuthTokensUpdateResponse, any, {}>>;
22583
22795
  /**
22584
- * @description Creates a new chat, or optionally opens an existing one.
22796
+ * @description Creates a new chat, or optionally opens an existing one. **Required scopes:** Access is determined by chat membership.
22585
22797
  *
22586
22798
  * @tags chats
22587
22799
  * @name ChatsCreate
@@ -22591,7 +22803,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
22591
22803
  */
22592
22804
  chatsCreate: (data: ChatsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<ChatsCreateResponse, any, {}>>;
22593
22805
  /**
22594
- * @description Gets a chat's information.
22806
+ * @description Gets a chat's information. **Required scopes:** Access is determined by chat membership.
22595
22807
  *
22596
22808
  * @tags chats
22597
22809
  * @name ChatsGet
@@ -22608,7 +22820,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
22608
22820
  id?: string;
22609
22821
  }, params?: RequestParams) => Promise<AxiosResponse<ChatsGetResponse, any, {}>>;
22610
22822
  /**
22611
- * @description Gets a chat's information.
22823
+ * @description Gets a chat's information. **Required scopes:** Access is determined by chat membership.
22612
22824
  *
22613
22825
  * @tags chats
22614
22826
  * @name ChatsGetPost
@@ -22618,7 +22830,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
22618
22830
  */
22619
22831
  chatsGetPost: (data: ChatsGetRequest, params?: RequestParams) => Promise<AxiosResponse<ChatsGetResponse, any, {}>>;
22620
22832
  /**
22621
- * @description Updates a chat's information.
22833
+ * @description Updates a chat's information. **Required scopes:** Access is determined by chat membership.
22622
22834
  *
22623
22835
  * @tags chats
22624
22836
  * @name ChatsUpdate
@@ -22628,7 +22840,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
22628
22840
  */
22629
22841
  chatsUpdate: (data: ChatsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<ChatsUpdateResponse, any, {}>>;
22630
22842
  /**
22631
- * @description Creates a code change object.
22843
+ * @description Creates a code change object. **Required scopes:** - `code_change:write` OR `code_change:all`
22632
22844
  *
22633
22845
  * @tags code-changes
22634
22846
  * @name CodeChangesCreate
@@ -22638,7 +22850,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
22638
22850
  */
22639
22851
  codeChangesCreate: (data: CodeChangesCreateRequest, params?: RequestParams) => Promise<AxiosResponse<CodeChangesCreateResponse, any, {}>>;
22640
22852
  /**
22641
- * @description Deletes a code change object.
22853
+ * @description Deletes a code change object. **Required scopes:** - `code_change:all`
22642
22854
  *
22643
22855
  * @tags code-changes
22644
22856
  * @name CodeChangesDelete
@@ -22648,7 +22860,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
22648
22860
  */
22649
22861
  codeChangesDelete: (data: CodeChangesDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
22650
22862
  /**
22651
- * @description Gets a code change object.
22863
+ * @description Gets a code change object. **Required scopes:** - `code_change:read` OR `code_change:write` OR `code_change:all`
22652
22864
  *
22653
22865
  * @tags code-changes
22654
22866
  * @name CodeChangesGet
@@ -22664,7 +22876,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
22664
22876
  id: string;
22665
22877
  }, params?: RequestParams) => Promise<AxiosResponse<CodeChangesGetResponse, any, {}>>;
22666
22878
  /**
22667
- * @description Gets a code change object.
22879
+ * @description Gets a code change object. **Required scopes:** - `code_change:read` OR `code_change:write` OR `code_change:all`
22668
22880
  *
22669
22881
  * @tags code-changes
22670
22882
  * @name CodeChangesGetPost
@@ -22674,7 +22886,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
22674
22886
  */
22675
22887
  codeChangesGetPost: (data: CodeChangesGetRequest, params?: RequestParams) => Promise<AxiosResponse<CodeChangesGetResponse, any, {}>>;
22676
22888
  /**
22677
- * @description Lists code change objects.
22889
+ * @description Lists code change objects. **Required scopes:** - `code_change:read` OR `code_change:write` OR `code_change:all`
22678
22890
  *
22679
22891
  * @tags code-changes
22680
22892
  * @name CodeChangesList
@@ -22702,7 +22914,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
22702
22914
  mode?: ListMode;
22703
22915
  }, params?: RequestParams) => Promise<AxiosResponse<CodeChangesListResponse, any, {}>>;
22704
22916
  /**
22705
- * @description Lists code change objects.
22917
+ * @description Lists code change objects. **Required scopes:** - `code_change:read` OR `code_change:write` OR `code_change:all`
22706
22918
  *
22707
22919
  * @tags code-changes
22708
22920
  * @name CodeChangesListPost
@@ -22712,7 +22924,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
22712
22924
  */
22713
22925
  codeChangesListPost: (data: CodeChangesListRequest, params?: RequestParams) => Promise<AxiosResponse<CodeChangesListResponse, any, {}>>;
22714
22926
  /**
22715
- * @description Updates a code change object.
22927
+ * @description Updates a code change object. **Required scopes:** - `code_change:write` OR `code_change:all`
22716
22928
  *
22717
22929
  * @tags code-changes
22718
22930
  * @name CodeChangesUpdate
@@ -22722,7 +22934,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
22722
22934
  */
22723
22935
  codeChangesUpdate: (data: CodeChangesUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<CodeChangesUpdateResponse, any, {}>>;
22724
22936
  /**
22725
- * @description Creates a command.
22937
+ * @description Creates a command. **Required scopes:** - `command:write` OR `command:all`
22726
22938
  *
22727
22939
  * @tags commands
22728
22940
  * @name CommandsCreate
@@ -22732,7 +22944,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
22732
22944
  */
22733
22945
  commandsCreate: (data: CommandCreateRequest, params?: RequestParams) => Promise<AxiosResponse<CommandCreateResponse, any, {}>>;
22734
22946
  /**
22735
- * @description Gets a command.
22947
+ * @description Gets a command. **Required scopes:** - `command:read` OR `command:write` OR `command:all`
22736
22948
  *
22737
22949
  * @tags commands
22738
22950
  * @name CommandsGet
@@ -22748,7 +22960,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
22748
22960
  id: string;
22749
22961
  }, params?: RequestParams) => Promise<AxiosResponse<CommandGetResponse, any, {}>>;
22750
22962
  /**
22751
- * @description Gets a command.
22963
+ * @description Gets a command. **Required scopes:** - `command:read` OR `command:write` OR `command:all`
22752
22964
  *
22753
22965
  * @tags commands
22754
22966
  * @name CommandsGetPost
@@ -22758,7 +22970,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
22758
22970
  */
22759
22971
  commandsGetPost: (data: CommandGetRequest, params?: RequestParams) => Promise<AxiosResponse<CommandGetResponse, any, {}>>;
22760
22972
  /**
22761
- * @description Lists commands for a Dev organization.
22973
+ * @description Lists commands for a Dev organization. **Required scopes:** - `command:read` OR `command:write` OR `command:all`
22762
22974
  *
22763
22975
  * @tags commands
22764
22976
  * @name CommandsList
@@ -22799,7 +23011,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
22799
23011
  status?: CommandStatus[];
22800
23012
  }, params?: RequestParams) => Promise<AxiosResponse<CommandsListResponse, any, {}>>;
22801
23013
  /**
22802
- * @description Lists commands for a Dev organization.
23014
+ * @description Lists commands for a Dev organization. **Required scopes:** - `command:read` OR `command:write` OR `command:all`
22803
23015
  *
22804
23016
  * @tags commands
22805
23017
  * @name CommandsListPost
@@ -22809,7 +23021,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
22809
23021
  */
22810
23022
  commandsListPost: (data: CommandsListRequest, params?: RequestParams) => Promise<AxiosResponse<CommandsListResponse, any, {}>>;
22811
23023
  /**
22812
- * @description Updates a command.
23024
+ * @description Updates a command. **Required scopes:** - `command:write` OR `command:all`
22813
23025
  *
22814
23026
  * @tags commands
22815
23027
  * @name CommandsUpdate
@@ -22819,7 +23031,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
22819
23031
  */
22820
23032
  commandsUpdate: (data: CommandUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<CommandUpdateResponse, any, {}>>;
22821
23033
  /**
22822
- * @description Creates a conversation.
23034
+ * @description Creates a conversation. **Required scopes:** - `conversation:write` OR `conversation:all`
22823
23035
  *
22824
23036
  * @tags conversations
22825
23037
  * @name ConversationsCreate
@@ -22829,7 +23041,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
22829
23041
  */
22830
23042
  conversationsCreate: (data: ConversationsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<ConversationsCreateResponse, any, {}>>;
22831
23043
  /**
22832
- * @description Deletes the requested conversation.
23044
+ * @description Deletes the requested conversation. **Required scopes:** - `conversation:all`
22833
23045
  *
22834
23046
  * @tags conversations
22835
23047
  * @name ConversationsDelete
@@ -22839,7 +23051,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
22839
23051
  */
22840
23052
  conversationsDelete: (data: ConversationsDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
22841
23053
  /**
22842
- * @description Gets the requested conversation's information.
23054
+ * @description Gets the requested conversation's information. **Required scopes:** - `conversation:read` OR `conversation:write` OR `conversation:all`
22843
23055
  *
22844
23056
  * @tags conversations
22845
23057
  * @name ConversationsGet
@@ -22855,7 +23067,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
22855
23067
  id: string;
22856
23068
  }, params?: RequestParams) => Promise<AxiosResponse<ConversationsGetResponse, any, {}>>;
22857
23069
  /**
22858
- * @description Gets the requested conversation's information.
23070
+ * @description Gets the requested conversation's information. **Required scopes:** - `conversation:read` OR `conversation:write` OR `conversation:all`
22859
23071
  *
22860
23072
  * @tags conversations
22861
23073
  * @name ConversationsGetPost
@@ -22865,7 +23077,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
22865
23077
  */
22866
23078
  conversationsGetPost: (data: ConversationsGetRequest, params?: RequestParams) => Promise<AxiosResponse<ConversationsGetResponse, any, {}>>;
22867
23079
  /**
22868
- * @description Lists the available conversations.
23080
+ * @description Lists the available conversations. **Required scopes:** - `conversation:read` OR `conversation:write` OR `conversation:all`
22869
23081
  *
22870
23082
  * @tags conversations
22871
23083
  * @name ConversationsList
@@ -22880,6 +23092,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
22880
23092
  * @example ["ACC-12345"]
22881
23093
  */
22882
23094
  account?: string[];
23095
+ /**
23096
+ * Filters for conversations with any of the provided AI resolution
23097
+ * statuses.
23098
+ */
23099
+ ai_resolution_status?: number[];
22883
23100
  /**
22884
23101
  * Filters for conversations belonging to any of the provided parts.
22885
23102
  * @example ["PROD-12345"]
@@ -23000,7 +23217,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
23000
23217
  'tags_v2.value'?: string;
23001
23218
  }, params?: RequestParams) => Promise<AxiosResponse<ConversationsListResponse, any, {}>>;
23002
23219
  /**
23003
- * @description Lists the available conversations.
23220
+ * @description Lists the available conversations. **Required scopes:** - `conversation:read` OR `conversation:write` OR `conversation:all`
23004
23221
  *
23005
23222
  * @tags conversations
23006
23223
  * @name ConversationsListPost
@@ -23010,7 +23227,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
23010
23227
  */
23011
23228
  conversationsListPost: (data: ConversationsListRequest, params?: RequestParams) => Promise<AxiosResponse<ConversationsListResponse, any, {}>>;
23012
23229
  /**
23013
- * @description Updates the requested conversation.
23230
+ * @description Updates the requested conversation. **Required scopes:** - `conversation:write` OR `conversation:all`
23014
23231
  *
23015
23232
  * @tags conversations
23016
23233
  * @name ConversationsUpdate
@@ -23020,7 +23237,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
23020
23237
  */
23021
23238
  conversationsUpdate: (data: ConversationsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<ConversationsUpdateResponse, any, {}>>;
23022
23239
  /**
23023
- * @description Counts custom objects.
23240
+ * @description Counts custom objects. **Required scopes:** No scopes required.
23024
23241
  *
23025
23242
  * @tags customization
23026
23243
  * @name CustomObjectsCount
@@ -23039,7 +23256,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
23039
23256
  filters?: any[];
23040
23257
  }, params?: RequestParams) => Promise<AxiosResponse<CustomObjectsCountResponse, any, {}>>;
23041
23258
  /**
23042
- * @description Counts custom objects.
23259
+ * @description Counts custom objects. **Required scopes:** No scopes required.
23043
23260
  *
23044
23261
  * @tags customization
23045
23262
  * @name CustomObjectsCountPost
@@ -23050,7 +23267,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
23050
23267
  */
23051
23268
  customObjectsCountPost: (data: CustomObjectsCountRequest, params?: RequestParams) => Promise<AxiosResponse<CustomObjectsCountResponse, any, {}>>;
23052
23269
  /**
23053
- * @description Creates a custom object.
23270
+ * @description Creates a custom object. **Required scopes:** - `custom_type_fragment:write`
23054
23271
  *
23055
23272
  * @tags customization
23056
23273
  * @name CustomObjectsCreate
@@ -23060,7 +23277,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
23060
23277
  */
23061
23278
  customObjectsCreate: (data: CustomObjectsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<CustomObjectsCreateResponse, any, {}>>;
23062
23279
  /**
23063
- * @description Deletes a custom object.
23280
+ * @description Deletes a custom object. **Required scopes:** - `custom_type_fragment:write`
23064
23281
  *
23065
23282
  * @tags customization
23066
23283
  * @name CustomObjectsDelete
@@ -23070,7 +23287,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
23070
23287
  */
23071
23288
  customObjectsDelete: (data: CustomObjectsDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
23072
23289
  /**
23073
- * @description Gets a custom object.
23290
+ * @description Gets a custom object. **Required scopes:** No scopes required.
23074
23291
  *
23075
23292
  * @tags customization
23076
23293
  * @name CustomObjectsGet
@@ -23086,7 +23303,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
23086
23303
  id?: string;
23087
23304
  }, params?: RequestParams) => Promise<AxiosResponse<CustomObjectsGetResponse, any, {}>>;
23088
23305
  /**
23089
- * @description Gets a custom object.
23306
+ * @description Gets a custom object. **Required scopes:** No scopes required.
23090
23307
  *
23091
23308
  * @tags customization
23092
23309
  * @name CustomObjectsGetPost
@@ -23096,7 +23313,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
23096
23313
  */
23097
23314
  customObjectsGetPost: (data: CustomObjectsGetRequest, params?: RequestParams) => Promise<AxiosResponse<CustomObjectsGetResponse, any, {}>>;
23098
23315
  /**
23099
- * @description Lists custom objects.
23316
+ * @description Lists custom objects. **Required scopes:** No scopes required.
23100
23317
  *
23101
23318
  * @tags customization
23102
23319
  * @name CustomObjectsList
@@ -23132,7 +23349,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
23132
23349
  sort_by?: string[];
23133
23350
  }, params?: RequestParams) => Promise<AxiosResponse<CustomObjectsListResponse, any, {}>>;
23134
23351
  /**
23135
- * @description Lists custom objects.
23352
+ * @description Lists custom objects. **Required scopes:** No scopes required.
23136
23353
  *
23137
23354
  * @tags customization
23138
23355
  * @name CustomObjectsListPost
@@ -23143,7 +23360,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
23143
23360
  */
23144
23361
  customObjectsListPost: (data: CustomObjectsListRequest, params?: RequestParams) => Promise<AxiosResponse<CustomObjectsListResponse, any, {}>>;
23145
23362
  /**
23146
- * @description Updates a custom object.
23363
+ * @description Updates a custom object. **Required scopes:** - `custom_type_fragment:write`
23147
23364
  *
23148
23365
  * @tags customization
23149
23366
  * @name CustomObjectsUpdate
@@ -23153,7 +23370,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
23153
23370
  */
23154
23371
  customObjectsUpdate: (data: CustomObjectsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<CustomObjectsUpdateResponse, any, {}>>;
23155
23372
  /**
23156
- * @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`
23373
+ * @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.
23157
23374
  *
23158
23375
  * @tags auth-connections, dev-orgs
23159
23376
  * @name DevOrgAuthConnectionsCreate
@@ -23163,7 +23380,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
23163
23380
  */
23164
23381
  devOrgAuthConnectionsCreate: (data: DevOrgAuthConnectionsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<DevOrgAuthConnectionsCreateResponse, any, {}>>;
23165
23382
  /**
23166
- * @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`
23383
+ * @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.
23167
23384
  *
23168
23385
  * @tags auth-connections, dev-orgs
23169
23386
  * @name DevOrgAuthConnectionsDelete
@@ -23173,7 +23390,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
23173
23390
  */
23174
23391
  devOrgAuthConnectionsDelete: (data: DevOrgAuthConnectionsDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
23175
23392
  /**
23176
- * @description Retrieves the details for an authentication connection. **Required scopes:** - `dev_org:read`
23393
+ * @description Retrieves the details for an authentication connection. **Required scopes:** - `Cannot be called via service account.`
23177
23394
  *
23178
23395
  * @tags auth-connections, dev-orgs
23179
23396
  * @name DevOrgAuthConnectionsGet
@@ -23189,7 +23406,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
23189
23406
  id: string;
23190
23407
  }, params?: RequestParams) => Promise<AxiosResponse<DevOrgAuthConnectionsGetResponse, any, {}>>;
23191
23408
  /**
23192
- * @description Retrieves the details for an authentication connection. **Required scopes:** - `dev_org:read`
23409
+ * @description Retrieves the details for an authentication connection. **Required scopes:** - `Cannot be called via service account.`
23193
23410
  *
23194
23411
  * @tags auth-connections, dev-orgs
23195
23412
  * @name DevOrgAuthConnectionsGetPost
@@ -23199,7 +23416,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
23199
23416
  */
23200
23417
  devOrgAuthConnectionsGetPost: (data: DevOrgAuthConnectionsGetRequest, params?: RequestParams) => Promise<AxiosResponse<DevOrgAuthConnectionsGetResponse, any, {}>>;
23201
23418
  /**
23202
- * @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`
23419
+ * @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.
23203
23420
  *
23204
23421
  * @tags auth-connections, dev-orgs
23205
23422
  * @name DevOrgAuthConnectionsList
@@ -23209,7 +23426,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
23209
23426
  */
23210
23427
  devOrgAuthConnectionsList: (params?: RequestParams) => Promise<AxiosResponse<DevOrgAuthConnectionsListResponse, any, {}>>;
23211
23428
  /**
23212
- * @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`
23429
+ * @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.
23213
23430
  *
23214
23431
  * @tags auth-connections, dev-orgs
23215
23432
  * @name DevOrgAuthConnectionsListPost
@@ -23219,7 +23436,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
23219
23436
  */
23220
23437
  devOrgAuthConnectionsListPost: (data: Empty, params?: RequestParams) => Promise<AxiosResponse<DevOrgAuthConnectionsListResponse, any, {}>>;
23221
23438
  /**
23222
- * @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`
23439
+ * @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.
23223
23440
  *
23224
23441
  * @tags auth-connections, dev-orgs
23225
23442
  * @name DevOrgAuthConnectionsToggle
@@ -23229,7 +23446,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
23229
23446
  */
23230
23447
  devOrgAuthConnectionsToggle: (data: DevOrgAuthConnectionsToggleRequest, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
23231
23448
  /**
23232
- * @description Updates an authentication connection. **Required scopes:** - `dev_org:write`
23449
+ * @description Updates an authentication connection. **Required scopes:** Cannot be called via service account.
23233
23450
  *
23234
23451
  * @tags auth-connections, dev-orgs
23235
23452
  * @name DevOrgAuthConnectionsUpdate
@@ -23239,7 +23456,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
23239
23456
  */
23240
23457
  devOrgAuthConnectionsUpdate: (data: DevOrgAuthConnectionsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<DevOrgAuthConnectionsUpdateResponse, any, {}>>;
23241
23458
  /**
23242
- * @description Gets the Dev organization's information of the authenticated user. **Required scopes:** - `dev_org:read`
23459
+ * @description Gets the Dev organization's information of the authenticated user. **Required scopes:** - `dev_org:read` OR `dev_org:write`
23243
23460
  *
23244
23461
  * @tags dev-orgs
23245
23462
  * @name DevOrgsGet
@@ -23249,7 +23466,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
23249
23466
  */
23250
23467
  devOrgsGet: (params?: RequestParams) => Promise<AxiosResponse<DevOrgsGetResponse, any, {}>>;
23251
23468
  /**
23252
- * @description Gets the Dev organization's information of the authenticated user. **Required scopes:** - `dev_org:read`
23469
+ * @description Gets the Dev organization's information of the authenticated user. **Required scopes:** - `dev_org:read` OR `dev_org:write`
23253
23470
  *
23254
23471
  * @tags dev-orgs
23255
23472
  * @name DevOrgsGetPost
@@ -23259,7 +23476,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
23259
23476
  */
23260
23477
  devOrgsGetPost: (data: DevOrgsGetRequest, params?: RequestParams) => Promise<AxiosResponse<DevOrgsGetResponse, any, {}>>;
23261
23478
  /**
23262
- * @description Activates the requested user. **Required scopes:** - `dev_user:write`
23479
+ * @description Activates the requested user. **Required scopes:** - `dev_user:write` OR `dev_user:all`
23263
23480
  *
23264
23481
  * @tags dev-users
23265
23482
  * @name DevUsersActivate
@@ -23269,7 +23486,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
23269
23486
  */
23270
23487
  devUsersActivate: (data: DevUsersActivateRequest, params?: RequestParams) => Promise<AxiosResponse<DevUsersActivateResponse, any, {}>>;
23271
23488
  /**
23272
- * @description Creates a Dev user for a Dev organization. **Required scopes:** - `dev_user:write`
23489
+ * @description Creates a Dev user for a Dev organization. **Required scopes:** - `dev_user:write` OR `dev_user:all`
23273
23490
  *
23274
23491
  * @tags dev-users
23275
23492
  * @name DevUsersCreate
@@ -23289,7 +23506,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
23289
23506
  */
23290
23507
  devUsersDeactivate: (data: DevUsersDeactivateRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
23291
23508
  /**
23292
- * @description Gets the requested user's information. **Required scopes:** - `dev_user:read`
23509
+ * @description Gets the requested user's information. **Required scopes:** - `dev_user:read` OR `dev_user:write` OR `dev_user:all`
23293
23510
  *
23294
23511
  * @tags dev-users
23295
23512
  * @name DevUsersGet
@@ -23305,7 +23522,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
23305
23522
  id: string;
23306
23523
  }, params?: RequestParams) => Promise<AxiosResponse<DevUsersGetResponse, any, {}>>;
23307
23524
  /**
23308
- * @description Gets the requested user's information. **Required scopes:** - `dev_user:read`
23525
+ * @description Gets the requested user's information. **Required scopes:** - `dev_user:read` OR `dev_user:write` OR `dev_user:all`
23309
23526
  *
23310
23527
  * @tags dev-users
23311
23528
  * @name DevUsersGetPost
@@ -23315,7 +23532,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
23315
23532
  */
23316
23533
  devUsersGetPost: (data: DevUsersGetRequest, params?: RequestParams) => Promise<AxiosResponse<DevUsersGetResponse, any, {}>>;
23317
23534
  /**
23318
- * @description Links an external/secondary identity to the Dev user. **Required scopes:** - `dev_user:write`
23535
+ * @description Links an external/secondary identity to the Dev user. **Required scopes:** - `dev_user:write` OR `dev_user:all`
23319
23536
  *
23320
23537
  * @tags dev-users
23321
23538
  * @name DevUsersIdentitiesLink
@@ -23325,7 +23542,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
23325
23542
  */
23326
23543
  devUsersIdentitiesLink: (data: DevUsersIdentitiesLinkRequest, params?: RequestParams) => Promise<AxiosResponse<DevUsersIdentitiesLinkResponse, any, {}>>;
23327
23544
  /**
23328
- * @description Unlinks an external/secondary identity from the Dev user. **Required scopes:** - `dev_user:write`
23545
+ * @description Unlinks an external/secondary identity from the Dev user. **Required scopes:** - `dev_user:write` OR `dev_user:all`
23329
23546
  *
23330
23547
  * @tags dev-users
23331
23548
  * @name DevUsersIdentitiesUnlink
@@ -23335,7 +23552,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
23335
23552
  */
23336
23553
  devUsersIdentitiesUnlink: (data: DevUsersIdentitiesUnlinkRequest, params?: RequestParams) => Promise<AxiosResponse<DevUsersIdentitiesUnlinkResponse, any, {}>>;
23337
23554
  /**
23338
- * @description Lists users within your organization. **Required scopes:** - `dev_user:read`
23555
+ * @description Lists users within your organization. **Required scopes:** - `dev_user:read` OR `dev_user:write` OR `dev_user:all`
23339
23556
  *
23340
23557
  * @tags dev-users
23341
23558
  * @name DevUsersList
@@ -23389,7 +23606,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
23389
23606
  timezone?: string[];
23390
23607
  }, params?: RequestParams) => Promise<AxiosResponse<DevUsersListResponse, any, {}>>;
23391
23608
  /**
23392
- * @description Lists users within your organization. **Required scopes:** - `dev_user:read`
23609
+ * @description Lists users within your organization. **Required scopes:** - `dev_user:read` OR `dev_user:write` OR `dev_user:all`
23393
23610
  *
23394
23611
  * @tags dev-users
23395
23612
  * @name DevUsersListPost
@@ -23409,7 +23626,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
23409
23626
  */
23410
23627
  devUsersMerge: (data: DevUsersMergeRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
23411
23628
  /**
23412
- * @description Gets the authenticated user's information. **Required scopes:** No scopes required
23629
+ * @description Gets the authenticated user's information. **Required scopes:** Default Scopes unavailable for this API
23413
23630
  *
23414
23631
  * @tags dev-users
23415
23632
  * @name DevUsersSelf
@@ -23419,7 +23636,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
23419
23636
  */
23420
23637
  devUsersSelf: (params?: RequestParams) => Promise<AxiosResponse<DevUsersSelfResponse, any, {}>>;
23421
23638
  /**
23422
- * @description Gets the authenticated user's information. **Required scopes:** No scopes required
23639
+ * @description Gets the authenticated user's information. **Required scopes:** Default Scopes unavailable for this API
23423
23640
  *
23424
23641
  * @tags dev-users
23425
23642
  * @name DevUsersSelfPost
@@ -23429,7 +23646,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
23429
23646
  */
23430
23647
  devUsersSelfPost: (data: DevUsersSelfRequest, params?: RequestParams) => Promise<AxiosResponse<DevUsersSelfResponse, any, {}>>;
23431
23648
  /**
23432
- * @description Updates the authenticated user. **Required scopes:** No scopes required
23649
+ * @description Updates the authenticated user. **Required scopes:** Default Scopes unavailable for this API
23433
23650
  *
23434
23651
  * @tags dev-users
23435
23652
  * @name DevUsersSelfUpdate
@@ -23439,7 +23656,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
23439
23656
  */
23440
23657
  devUsersSelfUpdate: (data: DevUsersSelfUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<DevUsersUpdateResponse, any, {}>>;
23441
23658
  /**
23442
- * @description Updates the user corresponding to the input Id. **Required scopes:** - `dev_user:write`
23659
+ * @description Updates the user corresponding to the input Id. **Required scopes:** - `dev_user:write` OR `dev_user:all`
23443
23660
  *
23444
23661
  * @tags dev-users
23445
23662
  * @name DevUsersUpdate
@@ -23449,7 +23666,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
23449
23666
  */
23450
23667
  devUsersUpdate: (data: DevUsersUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<DevUsersUpdateResponse, any, {}>>;
23451
23668
  /**
23452
- * @description Get count of directories matching given filter.
23669
+ * @description Get count of directories matching given filter. **Required scopes:** - `directory:read` OR `directory:write` OR `directory:all`
23453
23670
  *
23454
23671
  * @tags directory
23455
23672
  * @name DirectoriesCount
@@ -23470,7 +23687,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
23470
23687
  modified_by?: string[];
23471
23688
  }, params?: RequestParams) => Promise<AxiosResponse<DirectoriesCountResponse, any, {}>>;
23472
23689
  /**
23473
- * @description Get count of directories matching given filter.
23690
+ * @description Get count of directories matching given filter. **Required scopes:** - `directory:read` OR `directory:write` OR `directory:all`
23474
23691
  *
23475
23692
  * @tags directory
23476
23693
  * @name DirectoriesCountPost
@@ -23480,7 +23697,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
23480
23697
  */
23481
23698
  directoriesCountPost: (data: DirectoriesCountRequest, params?: RequestParams) => Promise<AxiosResponse<DirectoriesCountResponse, any, {}>>;
23482
23699
  /**
23483
- * @description Creates a directory for the specified inputs.
23700
+ * @description Creates a directory for the specified inputs. **Required scopes:** - `directory:write` OR `directory:all`
23484
23701
  *
23485
23702
  * @tags directory
23486
23703
  * @name DirectoriesCreate
@@ -23490,7 +23707,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
23490
23707
  */
23491
23708
  directoriesCreate: (data: DirectoriesCreateRequest, params?: RequestParams) => Promise<AxiosResponse<DirectoriesCreateResponse, any, {}>>;
23492
23709
  /**
23493
- * @description Delete the specified directory.
23710
+ * @description Delete the specified directory. **Required scopes:** - `directory:all`
23494
23711
  *
23495
23712
  * @tags directory
23496
23713
  * @name DirectoriesDelete
@@ -23500,7 +23717,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
23500
23717
  */
23501
23718
  directoriesDelete: (data: DirectoriesDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
23502
23719
  /**
23503
- * @description Gets the specified directory.
23720
+ * @description Gets the specified directory. **Required scopes:** - `directory:read` OR `directory:write` OR `directory:all`
23504
23721
  *
23505
23722
  * @tags directory
23506
23723
  * @name DirectoriesGet
@@ -23516,7 +23733,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
23516
23733
  id?: string;
23517
23734
  }, params?: RequestParams) => Promise<AxiosResponse<DirectoriesGetResponse, any, {}>>;
23518
23735
  /**
23519
- * @description Gets the specified directory.
23736
+ * @description Gets the specified directory. **Required scopes:** - `directory:read` OR `directory:write` OR `directory:all`
23520
23737
  *
23521
23738
  * @tags directory
23522
23739
  * @name DirectoriesGetPost
@@ -23526,7 +23743,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
23526
23743
  */
23527
23744
  directoriesGetPost: (data: DirectoriesGetRequest, params?: RequestParams) => Promise<AxiosResponse<DirectoriesGetResponse, any, {}>>;
23528
23745
  /**
23529
- * @description Lists directories matching the request.
23746
+ * @description Lists directories matching the request. **Required scopes:** - `directory:read` OR `directory:write` OR `directory:all`
23530
23747
  *
23531
23748
  * @tags directory
23532
23749
  * @name DirectoriesList
@@ -23563,7 +23780,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
23563
23780
  modified_by?: string[];
23564
23781
  }, params?: RequestParams) => Promise<AxiosResponse<DirectoriesListResponse, any, {}>>;
23565
23782
  /**
23566
- * @description Lists directories matching the request.
23783
+ * @description Lists directories matching the request. **Required scopes:** - `directory:read` OR `directory:write` OR `directory:all`
23567
23784
  *
23568
23785
  * @tags directory
23569
23786
  * @name DirectoriesListPost
@@ -23573,7 +23790,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
23573
23790
  */
23574
23791
  directoriesListPost: (data: DirectoriesListRequest, params?: RequestParams) => Promise<AxiosResponse<DirectoriesListResponse, any, {}>>;
23575
23792
  /**
23576
- * @description Updates the specified directory.
23793
+ * @description Updates the specified directory. **Required scopes:** - `directory:write` OR `directory:all`
23577
23794
  *
23578
23795
  * @tags directory
23579
23796
  * @name DirectoriesUpdate
@@ -23583,7 +23800,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
23583
23800
  */
23584
23801
  directoriesUpdate: (data: DirectoriesUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<DirectoriesUpdateResponse, any, {}>>;
23585
23802
  /**
23586
- * @description Creates a new group. A group is a collection of users. **Required scopes:** - `group:write`
23803
+ * @description Creates a new group. A group is a collection of users. **Required scopes:** - `group:write` OR `group:all`
23587
23804
  *
23588
23805
  * @tags groups
23589
23806
  * @name GroupsCreate
@@ -23593,7 +23810,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
23593
23810
  */
23594
23811
  groupsCreate: (data: GroupsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<GroupsCreateResponse, any, {}>>;
23595
23812
  /**
23596
- * @description Gets the requested group. **Required scopes:** - `group:read`
23813
+ * @description Gets the requested group. **Required scopes:** - `group:read` OR `group:write` OR `group:all`
23597
23814
  *
23598
23815
  * @tags groups
23599
23816
  * @name GroupsGet
@@ -23609,7 +23826,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
23609
23826
  id: string;
23610
23827
  }, params?: RequestParams) => Promise<AxiosResponse<GroupsGetResponse, any, {}>>;
23611
23828
  /**
23612
- * @description Gets the requested group. **Required scopes:** - `group:read`
23829
+ * @description Gets the requested group. **Required scopes:** - `group:read` OR `group:write` OR `group:all`
23613
23830
  *
23614
23831
  * @tags groups
23615
23832
  * @name GroupsGetPost
@@ -23619,7 +23836,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
23619
23836
  */
23620
23837
  groupsGetPost: (data: GroupsGetRequest, params?: RequestParams) => Promise<AxiosResponse<GroupsGetResponse, any, {}>>;
23621
23838
  /**
23622
- * @description Lists the available groups. **Required scopes:** - `group:read`
23839
+ * @description Lists the available groups. **Required scopes:** - `group:read` OR `group:write` OR `group:all`
23623
23840
  *
23624
23841
  * @tags groups
23625
23842
  * @name GroupsList
@@ -23640,6 +23857,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
23640
23857
  group_type?: GroupType[];
23641
23858
  /** Filter groups by ingestion source(s). */
23642
23859
  ingestion_source?: GroupIngestionSource[];
23860
+ /** Filters the groups on the basis of archival status. */
23861
+ is_archived?: boolean;
23643
23862
  /** Whether to fetch default or custom groups. */
23644
23863
  is_default?: boolean;
23645
23864
  /**
@@ -23690,7 +23909,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
23690
23909
  'sync_metadata.origin_system'?: string[];
23691
23910
  }, params?: RequestParams) => Promise<AxiosResponse<GroupsListResponse, any, {}>>;
23692
23911
  /**
23693
- * @description Lists the available groups. **Required scopes:** - `group:read`
23912
+ * @description Lists the available groups. **Required scopes:** - `group:read` OR `group:write` OR `group:all`
23694
23913
  *
23695
23914
  * @tags groups
23696
23915
  * @name GroupsListPost
@@ -23700,7 +23919,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
23700
23919
  */
23701
23920
  groupsListPost: (data: GroupsListRequest, params?: RequestParams) => Promise<AxiosResponse<GroupsListResponse, any, {}>>;
23702
23921
  /**
23703
- * @description Adds a member to a group. **Required scopes:** - `group_membership:write`
23922
+ * @description Adds a member to a group. **Required scopes:** - `group_membership:all`
23704
23923
  *
23705
23924
  * @tags groups
23706
23925
  * @name GroupMembersAdd
@@ -23710,7 +23929,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
23710
23929
  */
23711
23930
  groupMembersAdd: (data: GroupMembersAddRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
23712
23931
  /**
23713
- * @description Lists the members in a group. **Required scopes:** - `group_membership:read`
23932
+ * @description Lists the members in a group. **Required scopes:** - `group_membership:read` OR `group_membership:all`
23714
23933
  *
23715
23934
  * @tags groups
23716
23935
  * @name GroupMembersList
@@ -23745,7 +23964,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
23745
23964
  sort_by?: string[];
23746
23965
  }, params?: RequestParams) => Promise<AxiosResponse<GroupMembersListResponse, any, {}>>;
23747
23966
  /**
23748
- * @description Lists the members in a group. **Required scopes:** - `group_membership:read`
23967
+ * @description Lists the members in a group. **Required scopes:** - `group_membership:read` OR `group_membership:all`
23749
23968
  *
23750
23969
  * @tags groups
23751
23970
  * @name GroupMembersListPost
@@ -23755,7 +23974,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
23755
23974
  */
23756
23975
  groupMembersListPost: (data: GroupMembersListRequest, params?: RequestParams) => Promise<AxiosResponse<GroupMembersListResponse, any, {}>>;
23757
23976
  /**
23758
- * @description Removes a member from a group. **Required scopes:** - `group_membership:write`
23977
+ * @description Removes a member from a group. **Required scopes:** - `group_membership:all`
23759
23978
  *
23760
23979
  * @tags groups
23761
23980
  * @name GroupMembersRemove
@@ -23765,7 +23984,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
23765
23984
  */
23766
23985
  groupMembersRemove: (data: GroupMembersRemoveRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
23767
23986
  /**
23768
- * @description Updates the requested group. **Required scopes:** - `group:write`
23987
+ * @description Updates the requested group. **Required scopes:** - `group:write` OR `group:all`
23769
23988
  *
23770
23989
  * @tags groups
23771
23990
  * @name GroupsUpdate
@@ -23775,7 +23994,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
23775
23994
  */
23776
23995
  groupsUpdate: (data: GroupsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<GroupsUpdateResponse, any, {}>>;
23777
23996
  /**
23778
- * @description Retrieves a job's information.
23997
+ * @description Retrieves a job's information. **Required scopes:** - `job:read`
23779
23998
  *
23780
23999
  * @tags jobs
23781
24000
  * @name GetJob
@@ -23791,7 +24010,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
23791
24010
  id: string;
23792
24011
  }, params?: RequestParams) => Promise<AxiosResponse<JobsGetResponse, any, {}>>;
23793
24012
  /**
23794
- * @description Retrieves a job's information.
24013
+ * @description Retrieves a job's information. **Required scopes:** - `job:read`
23795
24014
  *
23796
24015
  * @tags jobs
23797
24016
  * @name GetJobPost
@@ -23801,7 +24020,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
23801
24020
  */
23802
24021
  getJobPost: (data: JobsGetRequest, params?: RequestParams) => Promise<AxiosResponse<JobsGetResponse, any, {}>>;
23803
24022
  /**
23804
- * @description Gets a list of jobs.
24023
+ * @description Gets a list of jobs. **Required scopes:** - `job:read`
23805
24024
  *
23806
24025
  * @tags jobs
23807
24026
  * @name ListJobs
@@ -23840,7 +24059,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
23840
24059
  state?: JobState[];
23841
24060
  }, params?: RequestParams) => Promise<AxiosResponse<JobsListResponse, any, {}>>;
23842
24061
  /**
23843
- * @description Gets a list of jobs.
24062
+ * @description Gets a list of jobs. **Required scopes:** - `job:read`
23844
24063
  *
23845
24064
  * @tags jobs
23846
24065
  * @name ListJobsPost
@@ -23850,7 +24069,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
23850
24069
  */
23851
24070
  listJobsPost: (data: JobsListRequest, params?: RequestParams) => Promise<AxiosResponse<JobsListResponse, any, {}>>;
23852
24071
  /**
23853
- * @description OAuth2 authorization callback.
24072
+ * @description OAuth2 authorization callback. **Required scopes:** - `keyring:read`
23854
24073
  *
23855
24074
  * @tags keyrings
23856
24075
  * @name KeyringsCreateCallback
@@ -23870,7 +24089,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
23870
24089
  state: string;
23871
24090
  }, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
23872
24091
  /**
23873
- * @description OAuth2 authorization callback.
24092
+ * @description OAuth2 authorization callback. **Required scopes:** - `keyring:read`
23874
24093
  *
23875
24094
  * @tags keyrings
23876
24095
  * @name KeyringsCreateCallbackPost
@@ -23880,7 +24099,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
23880
24099
  */
23881
24100
  keyringsCreateCallbackPost: (data: KeyringsCreateCallbackRequest, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
23882
24101
  /**
23883
- * @description Creates a link between two objects to indicate a relationship.
24102
+ * @description Creates a link between two objects to indicate a relationship. **Required scopes:** - `link:write` OR `link:all` Also needs linked objects read access.
23884
24103
  *
23885
24104
  * @tags links
23886
24105
  * @name LinksCreate
@@ -23890,7 +24109,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
23890
24109
  */
23891
24110
  linksCreate: (data: LinksCreateRequest, params?: RequestParams) => Promise<AxiosResponse<LinksCreateResponse, any, {}>>;
23892
24111
  /**
23893
- * @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.
24112
+ * @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.
23894
24113
  *
23895
24114
  * @tags links
23896
24115
  * @name LinksDelete
@@ -23900,7 +24119,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
23900
24119
  */
23901
24120
  linksDelete: (data: LinksDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
23902
24121
  /**
23903
- * @description Gets the requested link's information.
24122
+ * @description Gets the requested link's information. **Required scopes:** - `link:read` OR `link:write` OR `link:all`
23904
24123
  *
23905
24124
  * @tags links
23906
24125
  * @name LinksGet
@@ -23916,7 +24135,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
23916
24135
  id: string;
23917
24136
  }, params?: RequestParams) => Promise<AxiosResponse<LinksGetResponse, any, {}>>;
23918
24137
  /**
23919
- * @description Gets the requested link's information.
24138
+ * @description Gets the requested link's information. **Required scopes:** - `link:read` OR `link:write` OR `link:all`
23920
24139
  *
23921
24140
  * @tags links
23922
24141
  * @name LinksGetPost
@@ -23926,7 +24145,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
23926
24145
  */
23927
24146
  linksGetPost: (data: LinksGetRequest, params?: RequestParams) => Promise<AxiosResponse<LinksGetResponse, any, {}>>;
23928
24147
  /**
23929
- * @description Lists the available links.
24148
+ * @description Lists the available links. **Required scopes:** - `link:read` OR `link:write` OR `link:all`
23930
24149
  *
23931
24150
  * @tags links
23932
24151
  * @name LinksList
@@ -23985,7 +24204,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
23985
24204
  types?: LinkType[];
23986
24205
  }, params?: RequestParams) => Promise<AxiosResponse<LinksListResponse, any, {}>>;
23987
24206
  /**
23988
- * @description Lists the available links.
24207
+ * @description Lists the available links. **Required scopes:** - `link:read` OR `link:write` OR `link:all`
23989
24208
  *
23990
24209
  * @tags links
23991
24210
  * @name LinksListPost
@@ -23995,7 +24214,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
23995
24214
  */
23996
24215
  linksListPost: (data: LinksListRequest, params?: RequestParams) => Promise<AxiosResponse<LinksListResponse, any, {}>>;
23997
24216
  /**
23998
- * @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.
24217
+ * @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.
23999
24218
  *
24000
24219
  * @tags links
24001
24220
  * @name LinksReplace
@@ -24005,7 +24224,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
24005
24224
  */
24006
24225
  linksReplace: (data: LinksReplaceRequest, params?: RequestParams) => Promise<AxiosResponse<LinksReplaceResponse, any, {}>>;
24007
24226
  /**
24008
- * @description Counts the meeting records.
24227
+ * @description Counts the meeting records. **Required scopes:** - `meeting:read` OR `meeting:write` OR `meeting:all`
24009
24228
  *
24010
24229
  * @tags meetings
24011
24230
  * @name MeetingsCount
@@ -24078,7 +24297,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
24078
24297
  tags?: string[];
24079
24298
  }, params?: RequestParams) => Promise<AxiosResponse<MeetingsCountResponse, any, {}>>;
24080
24299
  /**
24081
- * @description Counts the meeting records.
24300
+ * @description Counts the meeting records. **Required scopes:** - `meeting:read` OR `meeting:write` OR `meeting:all`
24082
24301
  *
24083
24302
  * @tags meetings
24084
24303
  * @name MeetingsCountPost
@@ -24088,7 +24307,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
24088
24307
  */
24089
24308
  meetingsCountPost: (data: MeetingsCountRequest, params?: RequestParams) => Promise<AxiosResponse<MeetingsCountResponse, any, {}>>;
24090
24309
  /**
24091
- * @description Creates a new meeting record.
24310
+ * @description Creates a new meeting record. **Required scopes:** - `meeting:write` OR `meeting:all`
24092
24311
  *
24093
24312
  * @tags meetings
24094
24313
  * @name MeetingsCreate
@@ -24098,7 +24317,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
24098
24317
  */
24099
24318
  meetingsCreate: (data: MeetingsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<MeetingsCreateResponse, any, {}>>;
24100
24319
  /**
24101
- * @description Deletes the meeting record.
24320
+ * @description Deletes the meeting record. **Required scopes:** - `meeting:all`
24102
24321
  *
24103
24322
  * @tags meetings
24104
24323
  * @name MeetingsDelete
@@ -24108,7 +24327,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
24108
24327
  */
24109
24328
  meetingsDelete: (data: MeetingsDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
24110
24329
  /**
24111
- * @description Gets the meeting record.
24330
+ * @description Gets the meeting record. **Required scopes:** - `meeting:read` OR `meeting:write` OR `meeting:all`
24112
24331
  *
24113
24332
  * @tags meetings
24114
24333
  * @name MeetingsGet
@@ -24124,7 +24343,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
24124
24343
  id: string;
24125
24344
  }, params?: RequestParams) => Promise<AxiosResponse<MeetingsGetResponse, any, {}>>;
24126
24345
  /**
24127
- * @description Gets the meeting record.
24346
+ * @description Gets the meeting record. **Required scopes:** - `meeting:read` OR `meeting:write` OR `meeting:all`
24128
24347
  *
24129
24348
  * @tags meetings
24130
24349
  * @name MeetingsGetPost
@@ -24134,7 +24353,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
24134
24353
  */
24135
24354
  meetingsGetPost: (data: MeetingsGetRequest, params?: RequestParams) => Promise<AxiosResponse<MeetingsGetResponse, any, {}>>;
24136
24355
  /**
24137
- * @description Lists the meeting records.
24356
+ * @description Lists the meeting records. **Required scopes:** - `meeting:read` OR `meeting:write` OR `meeting:all`
24138
24357
  *
24139
24358
  * @tags meetings
24140
24359
  * @name MeetingsList
@@ -24225,7 +24444,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
24225
24444
  tags?: string[];
24226
24445
  }, params?: RequestParams) => Promise<AxiosResponse<MeetingsListResponse, any, {}>>;
24227
24446
  /**
24228
- * @description Lists the meeting records.
24447
+ * @description Lists the meeting records. **Required scopes:** - `meeting:read` OR `meeting:write` OR `meeting:all`
24229
24448
  *
24230
24449
  * @tags meetings
24231
24450
  * @name MeetingsListPost
@@ -24235,7 +24454,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
24235
24454
  */
24236
24455
  meetingsListPost: (data: MeetingsListRequest, params?: RequestParams) => Promise<AxiosResponse<MeetingsListResponse, any, {}>>;
24237
24456
  /**
24238
- * @description Updates the meeting record.
24457
+ * @description Updates the meeting record. **Required scopes:** - `meeting:write` OR `meeting:all`
24239
24458
  *
24240
24459
  * @tags meetings
24241
24460
  * @name MeetingsUpdate
@@ -24245,7 +24464,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
24245
24464
  */
24246
24465
  meetingsUpdate: (data: MeetingsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<MeetingsUpdateResponse, any, {}>>;
24247
24466
  /**
24248
- * @description Executes the metric action on the given object.
24467
+ * @description Executes the metric action on the given object. **Required scopes:** No scopes required.
24249
24468
  *
24250
24469
  * @tags slas
24251
24470
  * @name MetricActionExecute
@@ -24255,7 +24474,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
24255
24474
  */
24256
24475
  metricActionExecute: (data: MetricActionExecuteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
24257
24476
  /**
24258
- * @description Creates a custom metric definition
24477
+ * @description Creates a custom metric definition **Required scopes:** - `metric_definition:write` OR `metric_definition:all`
24259
24478
  *
24260
24479
  * @tags slas
24261
24480
  * @name MetricDefinitionsCreate
@@ -24265,7 +24484,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
24265
24484
  */
24266
24485
  metricDefinitionsCreate: (data: MetricDefinitionsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<MetricDefinitionsCreateResponse, any, {}>>;
24267
24486
  /**
24268
- * @description Deletes a custom metric definition
24487
+ * @description Deletes a custom metric definition **Required scopes:** - `metric_definition:all`
24269
24488
  *
24270
24489
  * @tags slas
24271
24490
  * @name MetricDefinitionsDelete
@@ -24275,7 +24494,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
24275
24494
  */
24276
24495
  metricDefinitionsDelete: (data: MetricDefinitionsDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
24277
24496
  /**
24278
- * @description Gets a custom metric definition
24497
+ * @description Gets a custom metric definition **Required scopes:** - `metric_definition:read` OR `metric_definition:write` OR `metric_definition:all`
24279
24498
  *
24280
24499
  * @tags slas
24281
24500
  * @name MetricDefinitionsGet
@@ -24298,7 +24517,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
24298
24517
  name?: string;
24299
24518
  }, params?: RequestParams) => Promise<AxiosResponse<MetricDefinitionsGetResponse, any, {}>>;
24300
24519
  /**
24301
- * @description Gets a custom metric definition
24520
+ * @description Gets a custom metric definition **Required scopes:** - `metric_definition:read` OR `metric_definition:write` OR `metric_definition:all`
24302
24521
  *
24303
24522
  * @tags slas
24304
24523
  * @name MetricDefinitionsGetPost
@@ -24308,7 +24527,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
24308
24527
  */
24309
24528
  metricDefinitionsGetPost: (data: MetricDefinitionsGetRequest, params?: RequestParams) => Promise<AxiosResponse<MetricDefinitionsGetResponse, any, {}>>;
24310
24529
  /**
24311
- * @description Lists metric definitions matching a filter.
24530
+ * @description Lists metric definitions matching a filter. **Required scopes:** - `metric_definition:read` OR `metric_definition:write` OR `metric_definition:all`
24312
24531
  *
24313
24532
  * @tags slas
24314
24533
  * @name MetricDefinitionsList
@@ -24348,7 +24567,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
24348
24567
  type?: MetricDefinitionMetricType[];
24349
24568
  }, params?: RequestParams) => Promise<AxiosResponse<MetricDefinitionsListResponse, any, {}>>;
24350
24569
  /**
24351
- * @description Lists metric definitions matching a filter.
24570
+ * @description Lists metric definitions matching a filter. **Required scopes:** - `metric_definition:read` OR `metric_definition:write` OR `metric_definition:all`
24352
24571
  *
24353
24572
  * @tags slas
24354
24573
  * @name MetricDefinitionsListPost
@@ -24358,7 +24577,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
24358
24577
  */
24359
24578
  metricDefinitionsListPost: (data: MetricDefinitionsListRequest, params?: RequestParams) => Promise<AxiosResponse<MetricDefinitionsListResponse, any, {}>>;
24360
24579
  /**
24361
- * @description Updates a custom metric definition
24580
+ * @description Updates a custom metric definition **Required scopes:** - `metric_definition:write` OR `metric_definition:all`
24362
24581
  *
24363
24582
  * @tags slas
24364
24583
  * @name MetricDefinitionsUpdate
@@ -24368,7 +24587,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
24368
24587
  */
24369
24588
  metricDefinitionsUpdate: (data: MetricDefinitionsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<MetricDefinitionsUpdateResponse, any, {}>>;
24370
24589
  /**
24371
- * @description Gets a metric tracker.
24590
+ * @description Gets a metric tracker. **Required scopes:** No scopes required.
24372
24591
  *
24373
24592
  * @tags slas
24374
24593
  * @name MetricTrackersGet
@@ -24389,7 +24608,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
24389
24608
  object: string;
24390
24609
  }, params?: RequestParams) => Promise<AxiosResponse<MetricTrackersGetResponse, any, {}>>;
24391
24610
  /**
24392
- * @description Gets a metric tracker.
24611
+ * @description Gets a metric tracker. **Required scopes:** No scopes required.
24393
24612
  *
24394
24613
  * @tags slas
24395
24614
  * @name MetricTrackersGetPost
@@ -24399,7 +24618,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
24399
24618
  */
24400
24619
  metricTrackersGetPost: (data: MetricTrackersGetRequest, params?: RequestParams) => Promise<AxiosResponse<MetricTrackersGetResponse, any, {}>>;
24401
24620
  /**
24402
- * @description Aggregates the sessions data.
24621
+ * @description Aggregates the sessions data. **Required scopes:** No scopes required.
24403
24622
  *
24404
24623
  * @tags observability
24405
24624
  * @name ObservabilitySessionsAggregate
@@ -24409,7 +24628,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
24409
24628
  */
24410
24629
  observabilitySessionsAggregate: (data: ObservabilitySessionsAggregateRequest, params?: RequestParams) => Promise<AxiosResponse<ObservabilitySessionsAggregateResponse, any, {}>>;
24411
24630
  /**
24412
- * @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.
24631
+ * @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.
24413
24632
  *
24414
24633
  * @tags observability
24415
24634
  * @name ObservabilitySessionsDataGet
@@ -24443,7 +24662,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
24443
24662
  tab_id?: string;
24444
24663
  }, params?: RequestParams) => Promise<AxiosResponse<ObservabilitySessionsDataGetResponse, any, {}>>;
24445
24664
  /**
24446
- * @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.
24665
+ * @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.
24447
24666
  *
24448
24667
  * @tags observability
24449
24668
  * @name ObservabilitySessionsDataGetPost
@@ -24453,7 +24672,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
24453
24672
  */
24454
24673
  observabilitySessionsDataGetPost: (data: ObservabilitySessionsDataGetRequest, params?: RequestParams) => Promise<AxiosResponse<ObservabilitySessionsDataGetResponse, any, {}>>;
24455
24674
  /**
24456
- * @description Retrieves detailed console and network data for debugging.
24675
+ * @description Retrieves detailed console and network data for debugging. **Required scopes:** No scopes required.
24457
24676
  *
24458
24677
  * @tags observability
24459
24678
  * @name ObservabilitySessionsDeveloperInfoGet
@@ -24489,7 +24708,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
24489
24708
  status_code_classes?: StatusCodeClass[];
24490
24709
  }, params?: RequestParams) => Promise<AxiosResponse<ObservabilitySessionsDeveloperInfoGetResponse, any, {}>>;
24491
24710
  /**
24492
- * @description Retrieves detailed console and network data for debugging.
24711
+ * @description Retrieves detailed console and network data for debugging. **Required scopes:** No scopes required.
24493
24712
  *
24494
24713
  * @tags observability
24495
24714
  * @name ObservabilitySessionsDeveloperInfoGetPost
@@ -24499,7 +24718,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
24499
24718
  */
24500
24719
  observabilitySessionsDeveloperInfoGetPost: (data: ObservabilitySessionsDeveloperInfoGetRequest, params?: RequestParams) => Promise<AxiosResponse<ObservabilitySessionsDeveloperInfoGetResponse, any, {}>>;
24501
24720
  /**
24502
- * @description Gets a specific session metadata by ID.
24721
+ * @description Gets a specific session metadata by ID. **Required scopes:** No scopes required.
24503
24722
  *
24504
24723
  * @tags observability
24505
24724
  * @name ObservabilitySessionsGet
@@ -24524,7 +24743,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
24524
24743
  version_key: string;
24525
24744
  }, params?: RequestParams) => Promise<AxiosResponse<ObservabilitySessionsGetResponse, any, {}>>;
24526
24745
  /**
24527
- * @description Gets a specific session metadata by ID.
24746
+ * @description Gets a specific session metadata by ID. **Required scopes:** No scopes required.
24528
24747
  *
24529
24748
  * @tags observability
24530
24749
  * @name ObservabilitySessionsGetPost
@@ -24534,7 +24753,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
24534
24753
  */
24535
24754
  observabilitySessionsGetPost: (data: ObservabilitySessionsGetRequest, params?: RequestParams) => Promise<AxiosResponse<ObservabilitySessionsGetResponse, any, {}>>;
24536
24755
  /**
24537
- * @description Lists sessions based on filter criteria.
24756
+ * @description Lists sessions based on filter criteria. **Required scopes:** No scopes required.
24538
24757
  *
24539
24758
  * @tags observability
24540
24759
  * @name ObservabilitySessionsList
@@ -24571,7 +24790,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
24571
24790
  sort_by?: string[];
24572
24791
  }, params?: RequestParams) => Promise<AxiosResponse<ObservabilitySessionsListResponse, any, {}>>;
24573
24792
  /**
24574
- * @description Lists sessions based on filter criteria.
24793
+ * @description Lists sessions based on filter criteria. **Required scopes:** No scopes required.
24575
24794
  *
24576
24795
  * @tags observability
24577
24796
  * @name ObservabilitySessionsListPost
@@ -24581,7 +24800,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
24581
24800
  */
24582
24801
  observabilitySessionsListPost: (data: ObservabilitySessionsListRequest, params?: RequestParams) => Promise<AxiosResponse<ObservabilitySessionsListResponse, any, {}>>;
24583
24802
  /**
24584
- * @description Creates an organization schedule fragment.
24803
+ * @description Creates an organization schedule fragment. **Required scopes:** - `org_schedule_fragment:write` OR `org_schedule_fragment:all`
24585
24804
  *
24586
24805
  * @tags schedules
24587
24806
  * @name OrgScheduleFragmentsCreate
@@ -24591,7 +24810,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
24591
24810
  */
24592
24811
  orgScheduleFragmentsCreate: (data: OrgScheduleFragmentsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<OrgScheduleFragmentsCreateResponse, any, {}>>;
24593
24812
  /**
24594
- * @description Gets an organization schedule fragment.
24813
+ * @description Gets an organization schedule fragment. **Required scopes:** - `org_schedule_fragment:read` OR `org_schedule_fragment:write` OR `org_schedule_fragment:all`
24595
24814
  *
24596
24815
  * @tags schedules
24597
24816
  * @name OrgScheduleFragmentsGet
@@ -24607,7 +24826,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
24607
24826
  id: string;
24608
24827
  }, params?: RequestParams) => Promise<AxiosResponse<OrgScheduleFragmentsGetResponse, any, {}>>;
24609
24828
  /**
24610
- * @description Gets an organization schedule fragment.
24829
+ * @description Gets an organization schedule fragment. **Required scopes:** - `org_schedule_fragment:read` OR `org_schedule_fragment:write` OR `org_schedule_fragment:all`
24611
24830
  *
24612
24831
  * @tags schedules
24613
24832
  * @name OrgScheduleFragmentsGetPost
@@ -24617,7 +24836,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
24617
24836
  */
24618
24837
  orgScheduleFragmentsGetPost: (data: OrgScheduleFragmentsGetRequest, params?: RequestParams) => Promise<AxiosResponse<OrgScheduleFragmentsGetResponse, any, {}>>;
24619
24838
  /**
24620
- * @description Changes stage of an organization schedule fragment.
24839
+ * @description Changes stage of an organization schedule fragment. **Required scopes:** - `org_schedule_fragment:write` OR `org_schedule_fragment:all`
24621
24840
  *
24622
24841
  * @tags schedules
24623
24842
  * @name OrgScheduleFragmentsTransition
@@ -24627,7 +24846,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
24627
24846
  */
24628
24847
  orgScheduleFragmentsTransition: (data: OrgScheduleFragmentsTransitionRequest, params?: RequestParams) => Promise<AxiosResponse<OrgScheduleFragmentsTransitionResponse, any, {}>>;
24629
24848
  /**
24630
- * @description Creates an organization schedule with a default weekly organization schedule and a list of organization schedule fragments.
24849
+ * @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`
24631
24850
  *
24632
24851
  * @tags schedules
24633
24852
  * @name OrgSchedulesCreate
@@ -24637,7 +24856,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
24637
24856
  */
24638
24857
  orgSchedulesCreate: (data: OrgSchedulesCreateRequest, params?: RequestParams) => Promise<AxiosResponse<OrgSchedulesCreateResponse, any, {}>>;
24639
24858
  /**
24640
- * @description Evaluates an organization's schedule at specified instants.
24859
+ * @description Evaluates an organization's schedule at specified instants. **Required scopes:** - `org_schedule:read` OR `org_schedule:write` OR `org_schedule:all`
24641
24860
  *
24642
24861
  * @tags schedules
24643
24862
  * @name OrgSchedulesEvaluate
@@ -24659,7 +24878,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
24659
24878
  instants: string[];
24660
24879
  }, params?: RequestParams) => Promise<AxiosResponse<OrgSchedulesEvaluateResponse, any, {}>>;
24661
24880
  /**
24662
- * @description Evaluates an organization's schedule at specified instants.
24881
+ * @description Evaluates an organization's schedule at specified instants. **Required scopes:** - `org_schedule:read` OR `org_schedule:write` OR `org_schedule:all`
24663
24882
  *
24664
24883
  * @tags schedules
24665
24884
  * @name OrgSchedulesEvaluatePost
@@ -24669,7 +24888,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
24669
24888
  */
24670
24889
  orgSchedulesEvaluatePost: (data: OrgSchedulesEvaluateRequest, params?: RequestParams) => Promise<AxiosResponse<OrgSchedulesEvaluateResponse, any, {}>>;
24671
24890
  /**
24672
- * @description Gets an organization schedule.
24891
+ * @description Gets an organization schedule. **Required scopes:** - `org_schedule:read` OR `org_schedule:write` OR `org_schedule:all`
24673
24892
  *
24674
24893
  * @tags schedules
24675
24894
  * @name OrgSchedulesGet
@@ -24691,7 +24910,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
24691
24910
  version_number?: number;
24692
24911
  }, params?: RequestParams) => Promise<AxiosResponse<OrgSchedulesGetResponse, any, {}>>;
24693
24912
  /**
24694
- * @description Gets an organization schedule.
24913
+ * @description Gets an organization schedule. **Required scopes:** - `org_schedule:read` OR `org_schedule:write` OR `org_schedule:all`
24695
24914
  *
24696
24915
  * @tags schedules
24697
24916
  * @name OrgSchedulesGetPost
@@ -24701,7 +24920,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
24701
24920
  */
24702
24921
  orgSchedulesGetPost: (data: OrgSchedulesGetRequest, params?: RequestParams) => Promise<AxiosResponse<OrgSchedulesGetResponse, any, {}>>;
24703
24922
  /**
24704
- * @description Gets list of organization schedules.
24923
+ * @description Gets list of organization schedules. **Required scopes:** - `org_schedule:read` OR `org_schedule:write` OR `org_schedule:all`
24705
24924
  *
24706
24925
  * @tags schedules
24707
24926
  * @name OrgSchedulesList
@@ -24733,7 +24952,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
24733
24952
  status?: OrgScheduleStatus[];
24734
24953
  }, params?: RequestParams) => Promise<AxiosResponse<OrgSchedulesListResponse, any, {}>>;
24735
24954
  /**
24736
- * @description Gets list of organization schedules.
24955
+ * @description Gets list of organization schedules. **Required scopes:** - `org_schedule:read` OR `org_schedule:write` OR `org_schedule:all`
24737
24956
  *
24738
24957
  * @tags schedules
24739
24958
  * @name OrgSchedulesListPost
@@ -24743,7 +24962,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
24743
24962
  */
24744
24963
  orgSchedulesListPost: (data: OrgSchedulesListRequest, params?: RequestParams) => Promise<AxiosResponse<OrgSchedulesListResponse, any, {}>>;
24745
24964
  /**
24746
- * @description Sets next organization schedule fragment which must begin the day the last existing fragment ends.
24965
+ * @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`
24747
24966
  *
24748
24967
  * @tags schedules
24749
24968
  * @name OrgSchedulesSetFuture
@@ -24753,7 +24972,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
24753
24972
  */
24754
24973
  orgSchedulesSetFuture: (data: OrgSchedulesSetFutureRequest, params?: RequestParams) => Promise<AxiosResponse<OrgSchedulesSetFutureResponse, any, {}>>;
24755
24974
  /**
24756
- * @description Publishes or archives an organization schedule.
24975
+ * @description Publishes or archives an organization schedule. **Required scopes:** - `org_schedule:write` OR `org_schedule:all`
24757
24976
  *
24758
24977
  * @tags schedules
24759
24978
  * @name OrgSchedulesTransition
@@ -24763,7 +24982,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
24763
24982
  */
24764
24983
  orgSchedulesTransition: (data: OrgSchedulesTransitionRequest, params?: RequestParams) => Promise<AxiosResponse<OrgSchedulesTransitionResponse, any, {}>>;
24765
24984
  /**
24766
- * @description Updates an organization schedule.
24985
+ * @description Updates an organization schedule. **Required scopes:** - `org_schedule:write` OR `org_schedule:all`
24767
24986
  *
24768
24987
  * @tags schedules
24769
24988
  * @name OrgSchedulesUpdate
@@ -24773,7 +24992,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
24773
24992
  */
24774
24993
  orgSchedulesUpdate: (data: OrgSchedulesUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<OrgSchedulesUpdateResponse, any, {}>>;
24775
24994
  /**
24776
- * @description Creates new [part](https://devrev.ai/docs/product/parts).
24995
+ * @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` |
24777
24996
  *
24778
24997
  * @tags parts
24779
24998
  * @name PartsCreate
@@ -24783,7 +25002,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
24783
25002
  */
24784
25003
  partsCreate: (data: PartsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<PartsCreateResponse, any, {}>>;
24785
25004
  /**
24786
- * @description Deletes a [part](https://devrev.ai/docs/product/parts).
25005
+ * @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` |
24787
25006
  *
24788
25007
  * @tags parts
24789
25008
  * @name PartsDelete
@@ -24793,7 +25012,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
24793
25012
  */
24794
25013
  partsDelete: (data: PartsDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
24795
25014
  /**
24796
- * @description Gets a [part's](https://devrev.ai/docs/product/parts) information.
25015
+ * @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` |
24797
25016
  *
24798
25017
  * @tags parts
24799
25018
  * @name PartsGet
@@ -24810,7 +25029,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
24810
25029
  id: string;
24811
25030
  }, params?: RequestParams) => Promise<AxiosResponse<PartsGetResponse, any, {}>>;
24812
25031
  /**
24813
- * @description Gets a [part's](https://devrev.ai/docs/product/parts) information.
25032
+ * @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` |
24814
25033
  *
24815
25034
  * @tags parts
24816
25035
  * @name PartsGetPost
@@ -24820,7 +25039,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
24820
25039
  */
24821
25040
  partsGetPost: (data: PartsGetRequest, params?: RequestParams) => Promise<AxiosResponse<PartsGetResponse, any, {}>>;
24822
25041
  /**
24823
- * @description Lists a collection of [parts](https://devrev.ai/docs/product/parts).
25042
+ * @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` |
24824
25043
  *
24825
25044
  * @tags parts
24826
25045
  * @name PartsList
@@ -25001,7 +25220,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
25001
25220
  type?: PartType[];
25002
25221
  }, params?: RequestParams) => Promise<AxiosResponse<PartsListResponse, any, {}>>;
25003
25222
  /**
25004
- * @description Lists a collection of [parts](https://devrev.ai/docs/product/parts).
25223
+ * @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` |
25005
25224
  *
25006
25225
  * @tags parts
25007
25226
  * @name PartsListPost
@@ -25011,7 +25230,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
25011
25230
  */
25012
25231
  partsListPost: (data: PartsListRequest, params?: RequestParams) => Promise<AxiosResponse<PartsListResponse, any, {}>>;
25013
25232
  /**
25014
- * @description Updates a [part's](https://devrev.ai/docs/product/parts) information.
25233
+ * @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` |
25015
25234
  *
25016
25235
  * @tags parts
25017
25236
  * @name PartsUpdate
@@ -25045,7 +25264,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
25045
25264
  */
25046
25265
  pingPost: (data: PingRequest, params?: RequestParams) => Promise<AxiosResponse<PingResponse, any, {}>>;
25047
25266
  /**
25048
- * @description Lists the reactors for an object.
25267
+ * @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).
25049
25268
  *
25050
25269
  * @tags timeline-entries, works
25051
25270
  * @name ReactionsList
@@ -25080,7 +25299,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
25080
25299
  limit?: number;
25081
25300
  }, params?: RequestParams) => Promise<AxiosResponse<ReactionsListResponse, any, {}>>;
25082
25301
  /**
25083
- * @description Lists the reactors for an object.
25302
+ * @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).
25084
25303
  *
25085
25304
  * @tags timeline-entries, works
25086
25305
  * @name ReactionsListPost
@@ -25090,7 +25309,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
25090
25309
  */
25091
25310
  reactionsListPost: (data: ReactionsListRequest, params?: RequestParams) => Promise<AxiosResponse<ReactionsListResponse, any, {}>>;
25092
25311
  /**
25093
- * @description Updates a reaction for an object.
25312
+ * @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).
25094
25313
  *
25095
25314
  * @tags timeline-entries, works
25096
25315
  * @name ReactionsUpdate
@@ -25100,7 +25319,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
25100
25319
  */
25101
25320
  reactionsUpdate: (data: ReactionsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
25102
25321
  /**
25103
- * @description Creates a Rev organization in the authenticated user's Dev organization. **Required scopes:** - `rev_org:write`
25322
+ * @description Creates a Rev organization in the authenticated user's Dev organization. **Required scopes:** - `rev_org:write` OR `rev_org:all`
25104
25323
  *
25105
25324
  * @tags rev-orgs
25106
25325
  * @name RevOrgsCreate
@@ -25120,7 +25339,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
25120
25339
  */
25121
25340
  revOrgsDelete: (data: RevOrgsDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
25122
25341
  /**
25123
- * @description Retrieves the Rev organization's information. **Required scopes:** - `rev_org:read`
25342
+ * @description Retrieves the Rev organization's information. **Required scopes:** - `rev_org:read` OR `rev_org:write` OR `rev_org:all`
25124
25343
  *
25125
25344
  * @tags rev-orgs
25126
25345
  * @name RevOrgsGet
@@ -25144,7 +25363,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
25144
25363
  id?: string;
25145
25364
  }, params?: RequestParams) => Promise<AxiosResponse<RevOrgsGetResponse, any, {}>>;
25146
25365
  /**
25147
- * @description Retrieves the Rev organization's information. **Required scopes:** - `rev_org:read`
25366
+ * @description Retrieves the Rev organization's information. **Required scopes:** - `rev_org:read` OR `rev_org:write` OR `rev_org:all`
25148
25367
  *
25149
25368
  * @tags rev-orgs
25150
25369
  * @name RevOrgsGetPost
@@ -25154,7 +25373,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
25154
25373
  */
25155
25374
  revOrgsGetPost: (data: RevOrgsGetRequest, params?: RequestParams) => Promise<AxiosResponse<RevOrgsGetResponse, any, {}>>;
25156
25375
  /**
25157
- * @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`
25376
+ * @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`
25158
25377
  *
25159
25378
  * @tags rev-orgs
25160
25379
  * @name RevOrgsList
@@ -25232,7 +25451,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
25232
25451
  tags?: string[];
25233
25452
  }, params?: RequestParams) => Promise<AxiosResponse<RevOrgsListResponse, any, {}>>;
25234
25453
  /**
25235
- * @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`
25454
+ * @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`
25236
25455
  *
25237
25456
  * @tags rev-orgs
25238
25457
  * @name RevOrgsListPost
@@ -25242,7 +25461,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
25242
25461
  */
25243
25462
  revOrgsListPost: (data: RevOrgsListRequest, params?: RequestParams) => Promise<AxiosResponse<RevOrgsListResponse, any, {}>>;
25244
25463
  /**
25245
- * @description Updates the Rev organization's information. **Required scopes:** - `rev_org:write`
25464
+ * @description Updates the Rev organization's information. **Required scopes:** - `rev_org:write` OR `rev_org:all`
25246
25465
  *
25247
25466
  * @tags rev-orgs
25248
25467
  * @name RevOrgsUpdate
@@ -25252,7 +25471,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
25252
25471
  */
25253
25472
  revOrgsUpdate: (data: RevOrgsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<RevOrgsUpdateResponse, any, {}>>;
25254
25473
  /**
25255
- * @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`
25474
+ * @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`
25256
25475
  *
25257
25476
  * @tags rev-users
25258
25477
  * @name RevUsersCreate
@@ -25272,7 +25491,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
25272
25491
  */
25273
25492
  revUsersDelete: (data: RevUsersDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
25274
25493
  /**
25275
- * @description Returns the Rev user of a Rev organization by its ID. **Required scopes:** - `rev_user:read`
25494
+ * @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`
25276
25495
  *
25277
25496
  * @tags rev-users
25278
25497
  * @name RevUsersGet
@@ -25288,7 +25507,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
25288
25507
  id: string;
25289
25508
  }, params?: RequestParams) => Promise<AxiosResponse<RevUsersGetResponse, any, {}>>;
25290
25509
  /**
25291
- * @description Returns the Rev user of a Rev organization by its ID. **Required scopes:** - `rev_user:read`
25510
+ * @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`
25292
25511
  *
25293
25512
  * @tags rev-users
25294
25513
  * @name RevUsersGetPost
@@ -25298,7 +25517,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
25298
25517
  */
25299
25518
  revUsersGetPost: (data: RevUsersGetRequest, params?: RequestParams) => Promise<AxiosResponse<RevUsersGetResponse, any, {}>>;
25300
25519
  /**
25301
- * @description Returns a list of all Rev Users belonging to the authenticated user's Dev organization. **Required scopes:** - `rev_user:read`
25520
+ * @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`
25302
25521
  *
25303
25522
  * @tags rev-users
25304
25523
  * @name RevUsersList
@@ -25379,7 +25598,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
25379
25598
  tags?: string[];
25380
25599
  }, params?: RequestParams) => Promise<AxiosResponse<RevUsersListResponse, any, {}>>;
25381
25600
  /**
25382
- * @description Returns a list of all Rev Users belonging to the authenticated user's Dev organization. **Required scopes:** - `rev_user:read`
25601
+ * @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`
25383
25602
  *
25384
25603
  * @tags rev-users
25385
25604
  * @name RevUsersListPost
@@ -25399,7 +25618,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
25399
25618
  */
25400
25619
  revUsersMerge: (data: RevUsersMergeRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
25401
25620
  /**
25402
- * @description Scans through all Rev users. **Required scopes:** - `rev_user:read`
25621
+ * @description Scans through all Rev users. **Required scopes:** - `rev_user:read` OR `rev_user:write` OR `rev_user:all`
25403
25622
  *
25404
25623
  * @tags rev-users
25405
25624
  * @name RevUsersScan
@@ -25468,7 +25687,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
25468
25687
  tags?: string[];
25469
25688
  }, params?: RequestParams) => Promise<AxiosResponse<RevUsersScanResponse, any, {}>>;
25470
25689
  /**
25471
- * @description Scans through all Rev users. **Required scopes:** - `rev_user:read`
25690
+ * @description Scans through all Rev users. **Required scopes:** - `rev_user:read` OR `rev_user:write` OR `rev_user:all`
25472
25691
  *
25473
25692
  * @tags rev-users
25474
25693
  * @name RevUsersScanPost
@@ -25478,7 +25697,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
25478
25697
  */
25479
25698
  revUsersScanPost: (data: RevUsersScanRequest, params?: RequestParams) => Promise<AxiosResponse<RevUsersScanResponse, any, {}>>;
25480
25699
  /**
25481
- * @description Updates a Rev user. **Required scopes:** - `rev_user:write`
25700
+ * @description Updates a Rev user. **Required scopes:** - `rev_user:write` OR `rev_user:all`
25482
25701
  *
25483
25702
  * @tags rev-users
25484
25703
  * @name RevUsersUpdate
@@ -25488,7 +25707,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
25488
25707
  */
25489
25708
  revUsersUpdate: (data: RevUsersUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<RevUsersUpdateResponse, any, {}>>;
25490
25709
  /**
25491
- * @description Gets the aggregated schema.
25710
+ * @description Gets the aggregated schema. **Required scopes:** No scopes required.
25492
25711
  *
25493
25712
  * @tags customization
25494
25713
  * @name AggregatedSchemaGet
@@ -25521,7 +25740,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
25521
25740
  stock_schema_fragment?: string;
25522
25741
  }, params?: RequestParams) => Promise<AxiosResponse<AggregatedSchemaGetResponse, any, {}>>;
25523
25742
  /**
25524
- * @description Gets the aggregated schema.
25743
+ * @description Gets the aggregated schema. **Required scopes:** No scopes required.
25525
25744
  *
25526
25745
  * @tags customization
25527
25746
  * @name AggregatedSchemaGetPost
@@ -25531,7 +25750,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
25531
25750
  */
25532
25751
  aggregatedSchemaGetPost: (data: AggregatedSchemaGetRequest, params?: RequestParams) => Promise<AxiosResponse<AggregatedSchemaGetResponse, any, {}>>;
25533
25752
  /**
25534
- * @description Gets a custom schema fragment.
25753
+ * @description Gets a custom schema fragment. **Required scopes:** No scopes required.
25535
25754
  *
25536
25755
  * @tags customization
25537
25756
  * @name CustomSchemaFragmentsGet
@@ -25549,7 +25768,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
25549
25768
  include_sync_metadata?: boolean;
25550
25769
  }, params?: RequestParams) => Promise<AxiosResponse<CustomSchemaFragmentsGetResponse, any, {}>>;
25551
25770
  /**
25552
- * @description Gets a custom schema fragment.
25771
+ * @description Gets a custom schema fragment. **Required scopes:** No scopes required.
25553
25772
  *
25554
25773
  * @tags customization
25555
25774
  * @name CustomSchemaFragmentsGetPost
@@ -25559,7 +25778,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
25559
25778
  */
25560
25779
  customSchemaFragmentsGetPost: (data: CustomSchemaFragmentsGetRequest, params?: RequestParams) => Promise<AxiosResponse<CustomSchemaFragmentsGetResponse, any, {}>>;
25561
25780
  /**
25562
- * @description Lists custom schema fragments.
25781
+ * @description Lists custom schema fragments. **Required scopes:** No scopes required.
25563
25782
  *
25564
25783
  * @tags customization
25565
25784
  * @name CustomSchemaFragmentsList
@@ -25622,7 +25841,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
25622
25841
  types?: CustomSchemaFragmentType[];
25623
25842
  }, params?: RequestParams) => Promise<AxiosResponse<CustomSchemaFragmentsListResponse, any, {}>>;
25624
25843
  /**
25625
- * @description Lists custom schema fragments.
25844
+ * @description Lists custom schema fragments. **Required scopes:** No scopes required.
25626
25845
  *
25627
25846
  * @tags customization
25628
25847
  * @name CustomSchemaFragmentsListPost
@@ -25632,7 +25851,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
25632
25851
  */
25633
25852
  customSchemaFragmentsListPost: (data: CustomSchemaFragmentsListRequest, params?: RequestParams) => Promise<AxiosResponse<CustomSchemaFragmentsListResponse, any, {}>>;
25634
25853
  /**
25635
- * @description Creates or updates a custom schema fragment.
25854
+ * @description Creates or updates a custom schema fragment. **Required scopes:** - `custom_type_fragment:write`
25636
25855
  *
25637
25856
  * @tags customization
25638
25857
  * @name CustomSchemaFragmentsSet
@@ -25642,7 +25861,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
25642
25861
  */
25643
25862
  customSchemaFragmentsSet: (data: CustomSchemaFragmentsSetRequest, params?: RequestParams) => Promise<AxiosResponse<CustomSchemaFragmentsSetResponse, any, {}>>;
25644
25863
  /**
25645
- * @description Gets a stock schema fragment.
25864
+ * @description Gets a stock schema fragment. **Required scopes:** No scopes required.
25646
25865
  *
25647
25866
  * @tags customization
25648
25867
  * @name StockSchemaFragmentsGet
@@ -25663,7 +25882,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
25663
25882
  leaf_type?: string;
25664
25883
  }, params?: RequestParams) => Promise<AxiosResponse<StockSchemaFragmentsGetResponse, any, {}>>;
25665
25884
  /**
25666
- * @description Gets a stock schema fragment.
25885
+ * @description Gets a stock schema fragment. **Required scopes:** No scopes required.
25667
25886
  *
25668
25887
  * @tags customization
25669
25888
  * @name StockSchemaFragmentsGetPost
@@ -25673,7 +25892,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
25673
25892
  */
25674
25893
  stockSchemaFragmentsGetPost: (data: StockSchemaFragmentsGetRequest, params?: RequestParams) => Promise<AxiosResponse<StockSchemaFragmentsGetResponse, any, {}>>;
25675
25894
  /**
25676
- * @description Lists stock schema fragments.
25895
+ * @description Lists stock schema fragments. **Required scopes:** No scopes required.
25677
25896
  *
25678
25897
  * @tags customization
25679
25898
  * @name StockSchemaFragmentsList
@@ -25714,7 +25933,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
25714
25933
  sort_by?: string[];
25715
25934
  }, params?: RequestParams) => Promise<AxiosResponse<StockSchemaFragmentsListResponse, any, {}>>;
25716
25935
  /**
25717
- * @description Lists stock schema fragments.
25936
+ * @description Lists stock schema fragments. **Required scopes:** No scopes required.
25718
25937
  *
25719
25938
  * @tags customization
25720
25939
  * @name StockSchemaFragmentsListPost
@@ -25724,7 +25943,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
25724
25943
  */
25725
25944
  stockSchemaFragmentsListPost: (data: StockSchemaFragmentsListRequest, params?: RequestParams) => Promise<AxiosResponse<StockSchemaFragmentsListResponse, any, {}>>;
25726
25945
  /**
25727
- * @description Gets the new fragment IDs and fields resulting from changing a subtype.
25946
+ * @description Gets the new fragment IDs and fields resulting from changing a subtype. **Required scopes:** - `custom_type_fragment:write`
25728
25947
  *
25729
25948
  * @tags customization
25730
25949
  * @name SchemasSubtypePrepareUpdateGet
@@ -25734,7 +25953,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
25734
25953
  */
25735
25954
  schemasSubtypePrepareUpdateGet: (data: SchemasSubtypePrepareUpdateGetRequest, params?: RequestParams) => Promise<AxiosResponse<SchemasSubtypePrepareUpdateGetResponse, any, {}>>;
25736
25955
  /**
25737
- * @description Creates a service account.
25956
+ * @description Creates a service account. **Required scopes:** Not accessible via service account tokens. Requires user authentication.
25738
25957
  *
25739
25958
  * @tags service-accounts
25740
25959
  * @name ServiceAccountsCreate
@@ -25744,7 +25963,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
25744
25963
  */
25745
25964
  serviceAccountsCreate: (data: ServiceAccountsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<ServiceAccountsCreateResponse, any, {}>>;
25746
25965
  /**
25747
- * @description Gets a service account.
25966
+ * @description Gets a service account. **Required scopes:** - `svcacc:read`
25748
25967
  *
25749
25968
  * @tags service-accounts
25750
25969
  * @name ServiceAccountsGet
@@ -25760,7 +25979,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
25760
25979
  id: string;
25761
25980
  }, params?: RequestParams) => Promise<AxiosResponse<ServiceAccountsGetResponse, any, {}>>;
25762
25981
  /**
25763
- * @description Gets a service account.
25982
+ * @description Gets a service account. **Required scopes:** - `svcacc:read`
25764
25983
  *
25765
25984
  * @tags service-accounts
25766
25985
  * @name ServiceAccountsGetPost
@@ -25770,7 +25989,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
25770
25989
  */
25771
25990
  serviceAccountsGetPost: (data: ServiceAccountsGetRequest, params?: RequestParams) => Promise<AxiosResponse<ServiceAccountsGetResponse, any, {}>>;
25772
25991
  /**
25773
- * @description Gets an SLA tracker.
25992
+ * @description Gets an SLA tracker. **Required scopes:** No scopes required.
25774
25993
  *
25775
25994
  * @tags slas
25776
25995
  * @name SlaTrackersGet
@@ -25786,7 +26005,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
25786
26005
  id: string;
25787
26006
  }, params?: RequestParams) => Promise<AxiosResponse<SlaTrackersGetResponse, any, {}>>;
25788
26007
  /**
25789
- * @description Gets an SLA tracker.
26008
+ * @description Gets an SLA tracker. **Required scopes:** No scopes required.
25790
26009
  *
25791
26010
  * @tags slas
25792
26011
  * @name SlaTrackersGetPost
@@ -25796,7 +26015,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
25796
26015
  */
25797
26016
  slaTrackersGetPost: (data: SlaTrackersGetRequest, params?: RequestParams) => Promise<AxiosResponse<SlaTrackersGetResponse, any, {}>>;
25798
26017
  /**
25799
- * @description Lists SLA trackers matching a filter.
26018
+ * @description Lists SLA trackers matching a filter. **Required scopes:** No scopes required.
25800
26019
  *
25801
26020
  * @tags slas
25802
26021
  * @name SlaTrackersList
@@ -25855,7 +26074,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
25855
26074
  status?: string[];
25856
26075
  }, params?: RequestParams) => Promise<AxiosResponse<SlaTrackersListResponse, any, {}>>;
25857
26076
  /**
25858
- * @description Lists SLA trackers matching a filter.
26077
+ * @description Lists SLA trackers matching a filter. **Required scopes:** No scopes required.
25859
26078
  *
25860
26079
  * @tags slas
25861
26080
  * @name SlaTrackersListPost
@@ -25865,7 +26084,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
25865
26084
  */
25866
26085
  slaTrackersListPost: (data: SlaTrackersListRequest, params?: RequestParams) => Promise<AxiosResponse<SlaTrackersListResponse, any, {}>>;
25867
26086
  /**
25868
- * @description Assigns the SLA to a set of Rev organizations.
26087
+ * @description Assigns the SLA to a set of Rev organizations. **Required scopes:** - `sla:write`
25869
26088
  *
25870
26089
  * @tags slas
25871
26090
  * @name SlasAssign
@@ -25875,7 +26094,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
25875
26094
  */
25876
26095
  slasAssign: (data: SlasAssignRequest, params?: RequestParams) => Promise<AxiosResponse<SlasAssignResponse, any, {}>>;
25877
26096
  /**
25878
- * @description Creates an SLA in draft status.
26097
+ * @description Creates an SLA in draft status. **Required scopes:** - `sla:write`
25879
26098
  *
25880
26099
  * @tags slas
25881
26100
  * @name SlasCreate
@@ -25885,7 +26104,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
25885
26104
  */
25886
26105
  slasCreate: (data: SlasCreateRequest, params?: RequestParams) => Promise<AxiosResponse<SlasCreateResponse, any, {}>>;
25887
26106
  /**
25888
- * @description Gets an SLA.
26107
+ * @description Gets an SLA. **Required scopes:** - `sla:read` OR `sla:write`
25889
26108
  *
25890
26109
  * @tags slas
25891
26110
  * @name SlasGet
@@ -25901,7 +26120,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
25901
26120
  id: string;
25902
26121
  }, params?: RequestParams) => Promise<AxiosResponse<SlasGetResponse, any, {}>>;
25903
26122
  /**
25904
- * @description Gets an SLA.
26123
+ * @description Gets an SLA. **Required scopes:** - `sla:read` OR `sla:write`
25905
26124
  *
25906
26125
  * @tags slas
25907
26126
  * @name SlasGetPost
@@ -25911,7 +26130,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
25911
26130
  */
25912
26131
  slasGetPost: (data: SlasGetRequest, params?: RequestParams) => Promise<AxiosResponse<SlasGetResponse, any, {}>>;
25913
26132
  /**
25914
- * @description Lists SLAs matching a filter.
26133
+ * @description Lists SLAs matching a filter. **Required scopes:** - `sla:read` OR `sla:write`
25915
26134
  *
25916
26135
  * @tags slas
25917
26136
  * @name SlasList
@@ -25951,7 +26170,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
25951
26170
  status?: SlaStatus[];
25952
26171
  }, params?: RequestParams) => Promise<AxiosResponse<SlasListResponse, any, {}>>;
25953
26172
  /**
25954
- * @description Lists SLAs matching a filter.
26173
+ * @description Lists SLAs matching a filter. **Required scopes:** - `sla:read` OR `sla:write`
25955
26174
  *
25956
26175
  * @tags slas
25957
26176
  * @name SlasListPost
@@ -25961,7 +26180,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
25961
26180
  */
25962
26181
  slasListPost: (data: SlasListRequest, params?: RequestParams) => Promise<AxiosResponse<SlasListResponse, any, {}>>;
25963
26182
  /**
25964
- * @description Changes the status of an SLA.
26183
+ * @description Changes the status of an SLA. **Required scopes:** - `sla:write`
25965
26184
  *
25966
26185
  * @tags slas
25967
26186
  * @name SlasTransition
@@ -25971,7 +26190,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
25971
26190
  */
25972
26191
  slasTransition: (data: SlasTransitionRequest, params?: RequestParams) => Promise<AxiosResponse<SlasTransitionResponse, any, {}>>;
25973
26192
  /**
25974
- * @description Updates a draft SLA.
26193
+ * @description Updates a draft SLA. **Required scopes:** - `sla:write`
25975
26194
  *
25976
26195
  * @tags slas
25977
26196
  * @name SlasUpdate
@@ -25981,7 +26200,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
25981
26200
  */
25982
26201
  slasUpdate: (data: SlasUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<SlasUpdateResponse, any, {}>>;
25983
26202
  /**
25984
- * @description Executes deferred snap-kit actions.
26203
+ * @description Executes deferred snap-kit actions. **Required scopes:** - `snap_widget:write` OR `snap_widget:all`
25985
26204
  *
25986
26205
  * @tags snap-kit-execution
25987
26206
  * @name SnapKitActionExecuteDeferred
@@ -25991,7 +26210,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
25991
26210
  */
25992
26211
  snapKitActionExecuteDeferred: (data: SnapKitActionExecuteDeferredRequest, params?: RequestParams) => Promise<AxiosResponse<SnapKitActionExecuteDeferredResponse, any, {}>>;
25993
26212
  /**
25994
- * @description Create a snap widget object.
26213
+ * @description Create a snap widget object. **Required scopes:** - `snap_widget:write` OR `snap_widget:all`
25995
26214
  *
25996
26215
  * @tags snap-widgets
25997
26216
  * @name SnapWidgetsCreate
@@ -26001,7 +26220,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
26001
26220
  */
26002
26221
  snapWidgetsCreate: (data: SnapWidgetsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<SnapWidgetsCreateResponse, any, {}>>;
26003
26222
  /**
26004
- * @description Creates a stage diagram.
26223
+ * @description Creates a stage diagram. **Required scopes:** - `stage_diagram:write`
26005
26224
  *
26006
26225
  * @tags customization
26007
26226
  * @name StageDiagramsCreate
@@ -26011,7 +26230,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
26011
26230
  */
26012
26231
  stageDiagramsCreate: (data: StageDiagramsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<StageDiagramsCreateResponse, any, {}>>;
26013
26232
  /**
26014
- * @description Gets a stage diagram.
26233
+ * @description Gets a stage diagram. **Required scopes:** No scopes required.
26015
26234
  *
26016
26235
  * @tags customization
26017
26236
  * @name StageDiagramsGet
@@ -26038,7 +26257,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
26038
26257
  leaf_type?: string;
26039
26258
  }, params?: RequestParams) => Promise<AxiosResponse<StageDiagramsGetResponse, any, {}>>;
26040
26259
  /**
26041
- * @description Gets a stage diagram.
26260
+ * @description Gets a stage diagram. **Required scopes:** No scopes required.
26042
26261
  *
26043
26262
  * @tags customization
26044
26263
  * @name StageDiagramsGetPost
@@ -26048,7 +26267,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
26048
26267
  */
26049
26268
  stageDiagramsGetPost: (data: StageDiagramsGetRequest, params?: RequestParams) => Promise<AxiosResponse<StageDiagramsGetResponse, any, {}>>;
26050
26269
  /**
26051
- * @description Lists stage diagrams.
26270
+ * @description Lists stage diagrams. **Required scopes:** No scopes required.
26052
26271
  *
26053
26272
  * @tags customization
26054
26273
  * @name StageDiagramsList
@@ -26078,7 +26297,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
26078
26297
  sort_by?: string[];
26079
26298
  }, params?: RequestParams) => Promise<AxiosResponse<StageDiagramsListResponse, any, {}>>;
26080
26299
  /**
26081
- * @description Lists stage diagrams.
26300
+ * @description Lists stage diagrams. **Required scopes:** No scopes required.
26082
26301
  *
26083
26302
  * @tags customization
26084
26303
  * @name StageDiagramsListPost
@@ -26088,7 +26307,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
26088
26307
  */
26089
26308
  stageDiagramsListPost: (data: StageDiagramsListRequest, params?: RequestParams) => Promise<AxiosResponse<StageDiagramsListResponse, any, {}>>;
26090
26309
  /**
26091
- * @description Updates a stage diagram.
26310
+ * @description Updates a stage diagram. **Required scopes:** - `stage_diagram:write`
26092
26311
  *
26093
26312
  * @tags customization
26094
26313
  * @name StageDiagramsUpdate
@@ -26098,7 +26317,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
26098
26317
  */
26099
26318
  stageDiagramsUpdate: (data: StageDiagramsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<StageDiagramsUpdateResponse, any, {}>>;
26100
26319
  /**
26101
- * @description Creates a custom stage.
26320
+ * @description Creates a custom stage. **Required scopes:** - `custom_stage:write`
26102
26321
  *
26103
26322
  * @tags customization
26104
26323
  * @name CustomStagesCreate
@@ -26108,7 +26327,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
26108
26327
  */
26109
26328
  customStagesCreate: (data: CustomStagesCreateRequest, params?: RequestParams) => Promise<AxiosResponse<CustomStagesCreateResponse, any, {}>>;
26110
26329
  /**
26111
- * @description Gets a custom stage.
26330
+ * @description Gets a custom stage. **Required scopes:** No scopes required.
26112
26331
  *
26113
26332
  * @tags customization
26114
26333
  * @name CustomStagesGet
@@ -26124,7 +26343,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
26124
26343
  id: string;
26125
26344
  }, params?: RequestParams) => Promise<AxiosResponse<CustomStagesGetResponse, any, {}>>;
26126
26345
  /**
26127
- * @description Gets a custom stage.
26346
+ * @description Gets a custom stage. **Required scopes:** No scopes required.
26128
26347
  *
26129
26348
  * @tags customization
26130
26349
  * @name CustomStagesGetPost
@@ -26134,7 +26353,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
26134
26353
  */
26135
26354
  customStagesGetPost: (data: CustomStagesGetRequest, params?: RequestParams) => Promise<AxiosResponse<CustomStagesGetResponse, any, {}>>;
26136
26355
  /**
26137
- * @description Lists custom stages.
26356
+ * @description Lists custom stages. **Required scopes:** No scopes required.
26138
26357
  *
26139
26358
  * @tags customization
26140
26359
  * @name CustomStagesList
@@ -26162,7 +26381,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
26162
26381
  sort_by?: string[];
26163
26382
  }, params?: RequestParams) => Promise<AxiosResponse<CustomStagesListResponse, any, {}>>;
26164
26383
  /**
26165
- * @description Lists custom stages.
26384
+ * @description Lists custom stages. **Required scopes:** No scopes required.
26166
26385
  *
26167
26386
  * @tags customization
26168
26387
  * @name CustomStagesListPost
@@ -26172,7 +26391,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
26172
26391
  */
26173
26392
  customStagesListPost: (data: CustomStagesListRequest, params?: RequestParams) => Promise<AxiosResponse<CustomStagesListResponse, any, {}>>;
26174
26393
  /**
26175
- * @description Updates a custom stage.
26394
+ * @description Updates a custom stage. **Required scopes:** - `custom_stage:write`
26176
26395
  *
26177
26396
  * @tags customization
26178
26397
  * @name CustomStagesUpdate
@@ -26182,7 +26401,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
26182
26401
  */
26183
26402
  customStagesUpdate: (data: CustomStagesUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<CustomStagesUpdateResponse, any, {}>>;
26184
26403
  /**
26185
- * @description Creates a custom state.
26404
+ * @description Creates a custom state. **Required scopes:** - `custom_state:write`
26186
26405
  *
26187
26406
  * @tags customization
26188
26407
  * @name CustomStatesCreate
@@ -26192,7 +26411,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
26192
26411
  */
26193
26412
  customStatesCreate: (data: CustomStatesCreateRequest, params?: RequestParams) => Promise<AxiosResponse<CustomStatesCreateResponse, any, {}>>;
26194
26413
  /**
26195
- * @description Gets a custom state.
26414
+ * @description Gets a custom state. **Required scopes:** No scopes required.
26196
26415
  *
26197
26416
  * @tags customization
26198
26417
  * @name CustomStatesGet
@@ -26208,7 +26427,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
26208
26427
  id: string;
26209
26428
  }, params?: RequestParams) => Promise<AxiosResponse<CustomStatesGetResponse, any, {}>>;
26210
26429
  /**
26211
- * @description Gets a custom state.
26430
+ * @description Gets a custom state. **Required scopes:** No scopes required.
26212
26431
  *
26213
26432
  * @tags customization
26214
26433
  * @name CustomStatesGetPost
@@ -26218,7 +26437,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
26218
26437
  */
26219
26438
  customStatesGetPost: (data: CustomStatesGetRequest, params?: RequestParams) => Promise<AxiosResponse<CustomStatesGetResponse, any, {}>>;
26220
26439
  /**
26221
- * @description Lists custom states.
26440
+ * @description Lists custom states. **Required scopes:** No scopes required.
26222
26441
  *
26223
26442
  * @tags customization
26224
26443
  * @name CustomStatesList
@@ -26248,7 +26467,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
26248
26467
  sort_by?: string[];
26249
26468
  }, params?: RequestParams) => Promise<AxiosResponse<CustomStatesListResponse, any, {}>>;
26250
26469
  /**
26251
- * @description Lists custom states.
26470
+ * @description Lists custom states. **Required scopes:** No scopes required.
26252
26471
  *
26253
26472
  * @tags customization
26254
26473
  * @name CustomStatesListPost
@@ -26258,7 +26477,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
26258
26477
  */
26259
26478
  customStatesListPost: (data: CustomStatesListRequest, params?: RequestParams) => Promise<AxiosResponse<CustomStatesListResponse, any, {}>>;
26260
26479
  /**
26261
- * @description Updates a custom state.
26480
+ * @description Updates a custom state. **Required scopes:** - `custom_state:write`
26262
26481
  *
26263
26482
  * @tags customization
26264
26483
  * @name CustomStatesUpdate
@@ -26268,7 +26487,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
26268
26487
  */
26269
26488
  customStatesUpdate: (data: CustomStatesUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<CustomStatesUpdateResponse, any, {}>>;
26270
26489
  /**
26271
- * @description Creates a schema for survey, which includes name and description of schema.
26490
+ * @description Creates a schema for survey, which includes name and description of schema. **Required scopes:** - `survey:write` OR `survey:all`
26272
26491
  *
26273
26492
  * @tags surveys
26274
26493
  * @name SurveysCreate
@@ -26278,7 +26497,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
26278
26497
  */
26279
26498
  surveysCreate: (data: SurveysCreateRequest, params?: RequestParams) => Promise<AxiosResponse<SurveysCreateResponse, any, {}>>;
26280
26499
  /**
26281
- * @description Deletes the specified survey.
26500
+ * @description Deletes the specified survey. **Required scopes:** - `survey:all`
26282
26501
  *
26283
26502
  * @tags surveys
26284
26503
  * @name SurveysDelete
@@ -26288,7 +26507,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
26288
26507
  */
26289
26508
  surveysDelete: (data: SurveysDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
26290
26509
  /**
26291
- * @description Gets a survey given the ID.
26510
+ * @description Gets a survey given the ID. **Required scopes:** - `survey:read` OR `survey:write` OR `survey:all`
26292
26511
  *
26293
26512
  * @tags surveys
26294
26513
  * @name SurveysGet
@@ -26304,7 +26523,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
26304
26523
  id: string;
26305
26524
  }, params?: RequestParams) => Promise<AxiosResponse<SurveysGetResponse, any, {}>>;
26306
26525
  /**
26307
- * @description Gets a survey given the ID.
26526
+ * @description Gets a survey given the ID. **Required scopes:** - `survey:read` OR `survey:write` OR `survey:all`
26308
26527
  *
26309
26528
  * @tags surveys
26310
26529
  * @name SurveysGetPost
@@ -26314,7 +26533,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
26314
26533
  */
26315
26534
  surveysGetPost: (data: SurveysGetRequest, params?: RequestParams) => Promise<AxiosResponse<SurveysGetResponse, any, {}>>;
26316
26535
  /**
26317
- * @description List surveys requested by the user.
26536
+ * @description List surveys requested by the user. **Required scopes:** - `survey:read` OR `survey:write` OR `survey:all`
26318
26537
  *
26319
26538
  * @tags surveys
26320
26539
  * @name SurveysList
@@ -26351,7 +26570,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
26351
26570
  sort_by?: string[];
26352
26571
  }, params?: RequestParams) => Promise<AxiosResponse<SurveysListResponse, any, {}>>;
26353
26572
  /**
26354
- * @description List surveys requested by the user.
26573
+ * @description List surveys requested by the user. **Required scopes:** - `survey:read` OR `survey:write` OR `survey:all`
26355
26574
  *
26356
26575
  * @tags surveys
26357
26576
  * @name SurveysListPost
@@ -26361,7 +26580,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
26361
26580
  */
26362
26581
  surveysListPost: (data: SurveysListRequest, params?: RequestParams) => Promise<AxiosResponse<SurveysListResponse, any, {}>>;
26363
26582
  /**
26364
- * @description List survey responses requested by the user.
26583
+ * @description List survey responses requested by the user. **Required scopes:** - `survey_response:read` OR `survey_response:write` OR `survey_response:all`
26365
26584
  *
26366
26585
  * @tags surveys
26367
26586
  * @name SurveysResponsesList
@@ -26415,7 +26634,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
26415
26634
  surveys?: string[];
26416
26635
  }, params?: RequestParams) => Promise<AxiosResponse<SurveysResponsesListResponse, any, {}>>;
26417
26636
  /**
26418
- * @description List survey responses requested by the user.
26637
+ * @description List survey responses requested by the user. **Required scopes:** - `survey_response:read` OR `survey_response:write` OR `survey_response:all`
26419
26638
  *
26420
26639
  * @tags surveys
26421
26640
  * @name SurveysResponsesListPost
@@ -26425,7 +26644,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
26425
26644
  */
26426
26645
  surveysResponsesListPost: (data: SurveysResponsesListRequest, params?: RequestParams) => Promise<AxiosResponse<SurveysResponsesListResponse, any, {}>>;
26427
26646
  /**
26428
- * @description Updates a user's survey response for the provided dispatch ID.
26647
+ * @description Updates a user's survey response for the provided dispatch ID. **Required scopes:** - `survey_response:write` OR `survey_response:all`
26429
26648
  *
26430
26649
  * @tags surveys
26431
26650
  * @name SurveysResponsesUpdate
@@ -26435,7 +26654,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
26435
26654
  */
26436
26655
  surveysResponsesUpdate: (data: SurveysResponsesUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
26437
26656
  /**
26438
- * @description Sends a survey on the specified channels.
26657
+ * @description Sends a survey on the specified channels. **Required scopes:** - `survey:write` OR `survey:all`
26439
26658
  *
26440
26659
  * @tags surveys
26441
26660
  * @name SurveysSend
@@ -26445,7 +26664,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
26445
26664
  */
26446
26665
  surveysSend: (data: SurveysSendRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
26447
26666
  /**
26448
- * @description Submits a user response to a survey, which is defined by the survey ID.
26667
+ * @description Submits a user response to a survey, which is defined by the survey ID. **Required scopes:** - `survey_response:write` OR `survey_response:all`
26449
26668
  *
26450
26669
  * @tags surveys
26451
26670
  * @name SurveysSubmit
@@ -26455,7 +26674,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
26455
26674
  */
26456
26675
  surveysSubmit: (data: SurveysSubmitRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
26457
26676
  /**
26458
- * @description Updates a survey's metadata.
26677
+ * @description Updates a survey's metadata. **Required scopes:** - `survey:write` OR `survey:all`
26459
26678
  *
26460
26679
  * @tags surveys
26461
26680
  * @name SurveysUpdate
@@ -26465,7 +26684,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
26465
26684
  */
26466
26685
  surveysUpdate: (data: SurveysUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<SurveysUpdateResponse, any, {}>>;
26467
26686
  /**
26468
- * @description Lists system users within your organization. **Required scopes:** - `dev_user:read`
26687
+ * @description Lists system users within your organization. **Required scopes:** Default Scopes unavailable for this API.
26469
26688
  *
26470
26689
  * @tags sys-users
26471
26690
  * @name SysUsersList
@@ -26495,7 +26714,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
26495
26714
  sort_by?: string[];
26496
26715
  }, params?: RequestParams) => Promise<AxiosResponse<SysUsersListResponse, any, {}>>;
26497
26716
  /**
26498
- * @description Lists system users within your organization. **Required scopes:** - `dev_user:read`
26717
+ * @description Lists system users within your organization. **Required scopes:** Default Scopes unavailable for this API.
26499
26718
  *
26500
26719
  * @tags sys-users
26501
26720
  * @name SysUsersListPost
@@ -26505,7 +26724,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
26505
26724
  */
26506
26725
  sysUsersListPost: (data: SysUsersListRequest, params?: RequestParams) => Promise<AxiosResponse<SysUsersListResponse, any, {}>>;
26507
26726
  /**
26508
- * @description Updates the system user. **Required scopes:** - `dev_user:write`
26727
+ * @description Updates the system user. **Required scopes:** Default Scopes unavailable for this API.
26509
26728
  *
26510
26729
  * @tags sys-users
26511
26730
  * @name SysUsersUpdate
@@ -26515,7 +26734,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
26515
26734
  */
26516
26735
  sysUsersUpdate: (data: SysUsersUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<SysUsersUpdateResponse, any, {}>>;
26517
26736
  /**
26518
- * @description Creates a new tag, which is used to create associations between objects and a logical concept denoted by the tag's name.
26737
+ * @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`
26519
26738
  *
26520
26739
  * @tags tags
26521
26740
  * @name TagsCreate
@@ -26525,7 +26744,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
26525
26744
  */
26526
26745
  tagsCreate: (data: TagsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<TagsCreateResponse, any, {}>>;
26527
26746
  /**
26528
- * @description Deletes a tag.
26747
+ * @description Deletes a tag. **Required scopes:** - `tag:all`
26529
26748
  *
26530
26749
  * @tags tags
26531
26750
  * @name TagsDelete
@@ -26535,7 +26754,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
26535
26754
  */
26536
26755
  tagsDelete: (data: TagsDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
26537
26756
  /**
26538
- * @description Gets a tag's information.
26757
+ * @description Gets a tag's information. **Required scopes:** - `tag:read` OR `tag:write` OR `tag:all`
26539
26758
  *
26540
26759
  * @tags tags
26541
26760
  * @name TagsGet
@@ -26552,7 +26771,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
26552
26771
  id: string;
26553
26772
  }, params?: RequestParams) => Promise<AxiosResponse<TagsGetResponse, any, {}>>;
26554
26773
  /**
26555
- * @description Gets a tag's information.
26774
+ * @description Gets a tag's information. **Required scopes:** - `tag:read` OR `tag:write` OR `tag:all`
26556
26775
  *
26557
26776
  * @tags tags
26558
26777
  * @name TagsGetPost
@@ -26562,7 +26781,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
26562
26781
  */
26563
26782
  tagsGetPost: (data: TagsGetRequest, params?: RequestParams) => Promise<AxiosResponse<TagsGetResponse, any, {}>>;
26564
26783
  /**
26565
- * @description Lists the available tags.
26784
+ * @description Lists the available tags. **Required scopes:** - `tag:read` OR `tag:write` OR `tag:all`
26566
26785
  *
26567
26786
  * @tags tags
26568
26787
  * @name TagsList
@@ -26593,7 +26812,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
26593
26812
  sort_by?: string[];
26594
26813
  }, params?: RequestParams) => Promise<AxiosResponse<TagsListResponse, any, {}>>;
26595
26814
  /**
26596
- * @description Lists the available tags.
26815
+ * @description Lists the available tags. **Required scopes:** - `tag:read` OR `tag:write` OR `tag:all`
26597
26816
  *
26598
26817
  * @tags tags
26599
26818
  * @name TagsListPost
@@ -26603,7 +26822,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
26603
26822
  */
26604
26823
  tagsListPost: (data: TagsListRequest, params?: RequestParams) => Promise<AxiosResponse<TagsListResponse, any, {}>>;
26605
26824
  /**
26606
- * @description Updates a tag's information.
26825
+ * @description Updates a tag's information. **Required scopes:** - `tag:write` OR `tag:all`
26607
26826
  *
26608
26827
  * @tags tags
26609
26828
  * @name TagsUpdate
@@ -26613,7 +26832,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
26613
26832
  */
26614
26833
  tagsUpdate: (data: TagsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<TagsUpdateResponse, any, {}>>;
26615
26834
  /**
26616
- * @description Creates a new entry on an object's timeline.
26835
+ * @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).
26617
26836
  *
26618
26837
  * @tags timeline-entries
26619
26838
  * @name TimelineEntriesCreate
@@ -26623,7 +26842,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
26623
26842
  */
26624
26843
  timelineEntriesCreate: (data: TimelineEntriesCreateRequest, params?: RequestParams) => Promise<AxiosResponse<TimelineEntriesCreateResponse, any, {}>>;
26625
26844
  /**
26626
- * @description Deletes an entry from an object's timeline.
26845
+ * @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).
26627
26846
  *
26628
26847
  * @tags timeline-entries
26629
26848
  * @name TimelineEntriesDelete
@@ -26633,7 +26852,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
26633
26852
  */
26634
26853
  timelineEntriesDelete: (data: TimelineEntriesDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
26635
26854
  /**
26636
- * @description Gets an entry on an object's timeline.
26855
+ * @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).
26637
26856
  *
26638
26857
  * @tags timeline-entries
26639
26858
  * @name TimelineEntriesGet
@@ -26658,7 +26877,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
26658
26877
  external_ref?: string;
26659
26878
  }, params?: RequestParams) => Promise<AxiosResponse<TimelineEntriesGetResponse, any, {}>>;
26660
26879
  /**
26661
- * @description Gets an entry on an object's timeline.
26880
+ * @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).
26662
26881
  *
26663
26882
  * @tags timeline-entries
26664
26883
  * @name TimelineEntriesGetPost
@@ -26668,7 +26887,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
26668
26887
  */
26669
26888
  timelineEntriesGetPost: (data: TimelineEntriesGetRequest, params?: RequestParams) => Promise<AxiosResponse<TimelineEntriesGetResponse, any, {}>>;
26670
26889
  /**
26671
- * @description Lists the timeline entries for an object.
26890
+ * @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).
26672
26891
  *
26673
26892
  * @tags timeline-entries
26674
26893
  * @name TimelineEntriesList
@@ -26688,8 +26907,14 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
26688
26907
  /**
26689
26908
  * The collection(s) to list entries from, otherwise if not provided,
26690
26909
  * all entries are returned.
26910
+ * @maxItems 1
26691
26911
  */
26692
26912
  collections?: TimelineEntriesCollection[];
26913
+ /**
26914
+ * Filters for entries created by any of the provided users.
26915
+ * @example ["DEVU-12345"]
26916
+ */
26917
+ created_by?: string[];
26693
26918
  /**
26694
26919
  * Filters for objects created after the provided timestamp (inclusive).
26695
26920
  * @format date-time
@@ -26738,7 +26963,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
26738
26963
  visibility?: TimelineEntryVisibility[];
26739
26964
  }, params?: RequestParams) => Promise<AxiosResponse<TimelineEntriesListResponse, any, {}>>;
26740
26965
  /**
26741
- * @description Lists the timeline entries for an object.
26966
+ * @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).
26742
26967
  *
26743
26968
  * @tags timeline-entries
26744
26969
  * @name TimelineEntriesListPost
@@ -26748,7 +26973,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
26748
26973
  */
26749
26974
  timelineEntriesListPost: (data: TimelineEntriesListRequest, params?: RequestParams) => Promise<AxiosResponse<TimelineEntriesListResponse, any, {}>>;
26750
26975
  /**
26751
- * @description Updates an entry on an object's timeline.
26976
+ * @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).
26752
26977
  *
26753
26978
  * @tags timeline-entries
26754
26979
  * @name TimelineEntriesUpdate
@@ -26758,7 +26983,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
26758
26983
  */
26759
26984
  timelineEntriesUpdate: (data: TimelineEntriesUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<TimelineEntriesUpdateResponse, any, {}>>;
26760
26985
  /**
26761
- * @description Deletes the requested vista.
26986
+ * @description Deletes the requested vista. **Required scopes:** - `vista:all`
26762
26987
  *
26763
26988
  * @tags vistas
26764
26989
  * @name VistasDelete
@@ -26768,7 +26993,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
26768
26993
  */
26769
26994
  vistasDelete: (data: VistasDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
26770
26995
  /**
26771
- * @description Gets the requested vistas's information.
26996
+ * @description Gets the requested vistas's information. **Required scopes:** - `vista:read` OR `vista:write` OR `vista:all`
26772
26997
  *
26773
26998
  * @tags vistas
26774
26999
  * @name VistasGet
@@ -26785,7 +27010,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
26785
27010
  id: string;
26786
27011
  }, params?: RequestParams) => Promise<AxiosResponse<VistasGetResponse, any, {}>>;
26787
27012
  /**
26788
- * @description Gets the requested vistas's information.
27013
+ * @description Gets the requested vistas's information. **Required scopes:** - `vista:read` OR `vista:write` OR `vista:all`
26789
27014
  *
26790
27015
  * @tags vistas
26791
27016
  * @name VistasGetPost
@@ -26795,7 +27020,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
26795
27020
  */
26796
27021
  vistasGetPost: (data: VistasGetRequest, params?: RequestParams) => Promise<AxiosResponse<VistasGetResponse, any, {}>>;
26797
27022
  /**
26798
- * @description Deletes the requested vista group item
27023
+ * @description Deletes the requested vista group item **Required scopes:** - `vista:all` No scopes required for default vistas.
26799
27024
  *
26800
27025
  * @tags vistas
26801
27026
  * @name VistasGroupsDelete
@@ -26805,7 +27030,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
26805
27030
  */
26806
27031
  vistasGroupsDelete: (data: VistasGroupsDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
26807
27032
  /**
26808
- * @description Gets the requested vista group item's information.
27033
+ * @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.
26809
27034
  *
26810
27035
  * @tags vistas
26811
27036
  * @name VistasGroupsGet
@@ -26821,7 +27046,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
26821
27046
  id: string;
26822
27047
  }, params?: RequestParams) => Promise<AxiosResponse<VistasGroupsGetResponse, any, {}>>;
26823
27048
  /**
26824
- * @description Gets the requested vista group item's information.
27049
+ * @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.
26825
27050
  *
26826
27051
  * @tags vistas
26827
27052
  * @name VistasGroupsGetPost
@@ -26831,7 +27056,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
26831
27056
  */
26832
27057
  vistasGroupsGetPost: (data: VistasGroupsGetRequest, params?: RequestParams) => Promise<AxiosResponse<VistasGroupsGetResponse, any, {}>>;
26833
27058
  /**
26834
- * @description Lists the available vista group items.
27059
+ * @description Lists the available vista group items. **Required scopes:** - `vista:read` OR `vista:write` OR `vista:all` No scopes required for default vistas.
26835
27060
  *
26836
27061
  * @tags vistas
26837
27062
  * @name VistasGroupsList
@@ -26893,7 +27118,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
26893
27118
  type?: GroupItemType[];
26894
27119
  }, params?: RequestParams) => Promise<AxiosResponse<VistasGroupsListResponse, any, {}>>;
26895
27120
  /**
26896
- * @description Lists the available vista group items.
27121
+ * @description Lists the available vista group items. **Required scopes:** - `vista:read` OR `vista:write` OR `vista:all` No scopes required for default vistas.
26897
27122
  *
26898
27123
  * @tags vistas
26899
27124
  * @name VistasGroupsListPost
@@ -26903,7 +27128,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
26903
27128
  */
26904
27129
  vistasGroupsListPost: (data: VistasGroupsListRequest, params?: RequestParams) => Promise<AxiosResponse<VistasGroupsListResponse, any, {}>>;
26905
27130
  /**
26906
- * @description Lists the available vistas.
27131
+ * @description Lists the available vistas. **Required scopes:** - `vista:read` OR `vista:write` OR `vista:all`
26907
27132
  *
26908
27133
  * @tags vistas
26909
27134
  * @name VistasList
@@ -26965,7 +27190,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
26965
27190
  type?: VistaType[];
26966
27191
  }, params?: RequestParams) => Promise<AxiosResponse<VistasListResponse, any, {}>>;
26967
27192
  /**
26968
- * @description Lists the available vistas.
27193
+ * @description Lists the available vistas. **Required scopes:** - `vista:read` OR `vista:write` OR `vista:all`
26969
27194
  *
26970
27195
  * @tags vistas
26971
27196
  * @name VistasListPost
@@ -26975,7 +27200,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
26975
27200
  */
26976
27201
  vistasListPost: (data: VistasListRequest, params?: RequestParams) => Promise<AxiosResponse<VistasListResponse, any, {}>>;
26977
27202
  /**
26978
- * @description Change state of a web crawler job to pause or resume it back to running.
27203
+ * @description Change state of a web crawler job to pause or resume it back to running. **Required scopes:** - `web_crawler_job:all`
26979
27204
  *
26980
27205
  * @tags web-crawler-job
26981
27206
  * @name WebCrawlerJobsControl
@@ -26985,7 +27210,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
26985
27210
  */
26986
27211
  webCrawlerJobsControl: (data: WebCrawlerJobsControlRequest, params?: RequestParams) => Promise<AxiosResponse<WebCrawlerJobsControlResponse, any, {}>>;
26987
27212
  /**
26988
- * @description Creates a web crawler job whose objective is to crawl the provided URLs/sitemaps and generate corresponding webpages as artifacts.
27213
+ * @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`
26989
27214
  *
26990
27215
  * @tags web-crawler-job
26991
27216
  * @name CreateWebCrawlerJob
@@ -26995,7 +27220,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
26995
27220
  */
26996
27221
  createWebCrawlerJob: (data: WebCrawlerJobsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<WebCrawlerJobsCreateResponse, any, {}>>;
26997
27222
  /**
26998
- * @description Gets a web crawler job.
27223
+ * @description Gets a web crawler job. **Required scopes:** - `web_crawler_job:all`
26999
27224
  *
27000
27225
  * @tags web-crawler-job
27001
27226
  * @name GetWebCrawlerJob
@@ -27011,7 +27236,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
27011
27236
  id: string;
27012
27237
  }, params?: RequestParams) => Promise<AxiosResponse<WebCrawlerJobsGetResponse, any, {}>>;
27013
27238
  /**
27014
- * @description Gets a web crawler job.
27239
+ * @description Gets a web crawler job. **Required scopes:** - `web_crawler_job:all`
27015
27240
  *
27016
27241
  * @tags web-crawler-job
27017
27242
  * @name GetWebCrawlerJobPost
@@ -27021,7 +27246,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
27021
27246
  */
27022
27247
  getWebCrawlerJobPost: (data: WebCrawlerJobsGetRequest, params?: RequestParams) => Promise<AxiosResponse<WebCrawlerJobsGetResponse, any, {}>>;
27023
27248
  /**
27024
- * @description Lists web crawler jobs.
27249
+ * @description Lists web crawler jobs. **Required scopes:** - `web_crawler_job:all`
27025
27250
  *
27026
27251
  * @tags web-crawler-job
27027
27252
  * @name ListWebCrawlerJobs
@@ -27054,7 +27279,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
27054
27279
  mode?: ListMode;
27055
27280
  }, params?: RequestParams) => Promise<AxiosResponse<WebCrawlerJobsListResponse, any, {}>>;
27056
27281
  /**
27057
- * @description Lists web crawler jobs.
27282
+ * @description Lists web crawler jobs. **Required scopes:** - `web_crawler_job:all`
27058
27283
  *
27059
27284
  * @tags web-crawler-job
27060
27285
  * @name ListWebCrawlerJobsPost
@@ -27064,7 +27289,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
27064
27289
  */
27065
27290
  listWebCrawlerJobsPost: (data: WebCrawlerJobsListRequest, params?: RequestParams) => Promise<AxiosResponse<WebCrawlerJobsListResponse, any, {}>>;
27066
27291
  /**
27067
- * @description Creates a new webhook target.
27292
+ * @description Creates a new webhook target. **Required scopes:** Default Scopes unavailable for this API.
27068
27293
  *
27069
27294
  * @tags webhooks
27070
27295
  * @name WebhooksCreate
@@ -27074,7 +27299,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
27074
27299
  */
27075
27300
  webhooksCreate: (data: WebhooksCreateRequest, params?: RequestParams) => Promise<AxiosResponse<WebhooksCreateResponse, any, {}>>;
27076
27301
  /**
27077
- * @description Deletes the requested webhook.
27302
+ * @description Deletes the requested webhook. **Required scopes:** Default Scopes unavailable for this API.
27078
27303
  *
27079
27304
  * @tags webhooks
27080
27305
  * @name WebhooksDelete
@@ -27084,7 +27309,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
27084
27309
  */
27085
27310
  webhooksDelete: (data: WebhooksDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
27086
27311
  /**
27087
- * @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.
27312
+ * @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.
27088
27313
  *
27089
27314
  * @tags webhooks
27090
27315
  * @name WebhooksEvent
@@ -27094,7 +27319,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
27094
27319
  */
27095
27320
  webhooksEvent: (data: WebhookEventRequest, params?: RequestParams) => Promise<AxiosResponse<WebhookEventResponse, any, {}>>;
27096
27321
  /**
27097
- * @description Gets the requested webhook's information.
27322
+ * @description Gets the requested webhook's information. **Required scopes:** Default Scopes unavailable for this API.
27098
27323
  *
27099
27324
  * @tags webhooks
27100
27325
  * @name WebhooksGet
@@ -27111,7 +27336,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
27111
27336
  id: string;
27112
27337
  }, params?: RequestParams) => Promise<AxiosResponse<WebhooksGetResponse, any, {}>>;
27113
27338
  /**
27114
- * @description Gets the requested webhook's information.
27339
+ * @description Gets the requested webhook's information. **Required scopes:** Default Scopes unavailable for this API.
27115
27340
  *
27116
27341
  * @tags webhooks
27117
27342
  * @name WebhooksGetPost
@@ -27121,7 +27346,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
27121
27346
  */
27122
27347
  webhooksGetPost: (data: WebhooksGetRequest, params?: RequestParams) => Promise<AxiosResponse<WebhooksGetResponse, any, {}>>;
27123
27348
  /**
27124
- * @description Lists the webhooks.
27349
+ * @description Lists the webhooks. **Required scopes:** Default Scopes unavailable for this API.
27125
27350
  *
27126
27351
  * @tags webhooks
27127
27352
  * @name WebhooksList
@@ -27134,7 +27359,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
27134
27359
  status?: WebhookStatus[];
27135
27360
  }, params?: RequestParams) => Promise<AxiosResponse<WebhooksListResponse, any, {}>>;
27136
27361
  /**
27137
- * @description Lists the webhooks.
27362
+ * @description Lists the webhooks. **Required scopes:** Default Scopes unavailable for this API.
27138
27363
  *
27139
27364
  * @tags webhooks
27140
27365
  * @name WebhooksListPost
@@ -27144,7 +27369,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
27144
27369
  */
27145
27370
  webhooksListPost: (data: WebhooksListRequest, params?: RequestParams) => Promise<AxiosResponse<WebhooksListResponse, any, {}>>;
27146
27371
  /**
27147
- * @description Updates the requested webhook.
27372
+ * @description Updates the requested webhook. **Required scopes:** Default Scopes unavailable for this API.
27148
27373
  *
27149
27374
  * @tags webhooks
27150
27375
  * @name WebhooksUpdate
@@ -27154,7 +27379,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
27154
27379
  */
27155
27380
  webhooksUpdate: (data: WebhooksUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<WebhooksUpdateResponse, any, {}>>;
27156
27381
  /**
27157
- * @description Get count of work matching given filter.
27382
+ * @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` |
27158
27383
  *
27159
27384
  * @tags works
27160
27385
  * @name WorksCount
@@ -27323,7 +27548,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
27323
27548
  vista?: string;
27324
27549
  }, params?: RequestParams) => Promise<AxiosResponse<WorksCountResponse, any, {}>>;
27325
27550
  /**
27326
- * @description Get count of work matching given filter.
27551
+ * @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` |
27327
27552
  *
27328
27553
  * @tags works
27329
27554
  * @name WorksCountPost
@@ -27333,7 +27558,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
27333
27558
  */
27334
27559
  worksCountPost: (data: WorksCountRequest, params?: RequestParams) => Promise<AxiosResponse<WorksCountResponse, any, {}>>;
27335
27560
  /**
27336
- * @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.
27561
+ * @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` |
27337
27562
  *
27338
27563
  * @tags works
27339
27564
  * @name WorksCreate
@@ -27343,7 +27568,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
27343
27568
  */
27344
27569
  worksCreate: (data: WorksCreateRequest, params?: RequestParams) => Promise<AxiosResponse<WorksCreateResponse, any, {}>>;
27345
27570
  /**
27346
- * @description Deletes a work item.
27571
+ * @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` |
27347
27572
  *
27348
27573
  * @tags works
27349
27574
  * @name WorksDelete
@@ -27353,7 +27578,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
27353
27578
  */
27354
27579
  worksDelete: (data: WorksDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
27355
27580
  /**
27356
- * @description Exports a collection of work items.
27581
+ * @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` |
27357
27582
  *
27358
27583
  * @tags works
27359
27584
  * @name WorksExport
@@ -27530,7 +27755,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
27530
27755
  vista?: string;
27531
27756
  }, params?: RequestParams) => Promise<AxiosResponse<WorksExportResponse, any, {}>>;
27532
27757
  /**
27533
- * @description Exports a collection of work items.
27758
+ * @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` |
27534
27759
  *
27535
27760
  * @tags works
27536
27761
  * @name WorksExportPost
@@ -27540,7 +27765,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
27540
27765
  */
27541
27766
  worksExportPost: (data: WorksExportRequest, params?: RequestParams) => Promise<AxiosResponse<WorksExportResponse, any, {}>>;
27542
27767
  /**
27543
- * @description Gets a work item's information.
27768
+ * @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` |
27544
27769
  *
27545
27770
  * @tags works
27546
27771
  * @name WorksGet
@@ -27557,7 +27782,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
27557
27782
  id: string;
27558
27783
  }, params?: RequestParams) => Promise<AxiosResponse<WorksGetResponse, any, {}>>;
27559
27784
  /**
27560
- * @description Gets a work item's information.
27785
+ * @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` |
27561
27786
  *
27562
27787
  * @tags works
27563
27788
  * @name WorksGetPost
@@ -27567,7 +27792,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
27567
27792
  */
27568
27793
  worksGetPost: (data: WorksGetRequest, params?: RequestParams) => Promise<AxiosResponse<WorksGetResponse, any, {}>>;
27569
27794
  /**
27570
- * @description Lists a collection of work items.
27795
+ * @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` |
27571
27796
  *
27572
27797
  * @tags works
27573
27798
  * @name WorksList
@@ -27754,7 +27979,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
27754
27979
  vista?: string;
27755
27980
  }, params?: RequestParams) => Promise<AxiosResponse<WorksListResponse, any, {}>>;
27756
27981
  /**
27757
- * @description Lists a collection of work items.
27982
+ * @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` |
27758
27983
  *
27759
27984
  * @tags works
27760
27985
  * @name WorksListPost
@@ -27764,7 +27989,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
27764
27989
  */
27765
27990
  worksListPost: (data: WorksListRequest, params?: RequestParams) => Promise<AxiosResponse<WorksListResponse, any, {}>>;
27766
27991
  /**
27767
- * @description Updates a work item's information.
27992
+ * @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` |
27768
27993
  *
27769
27994
  * @tags works
27770
27995
  * @name WorksUpdate