@devrev/typescript-sdk 1.1.73 → 1.1.75
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
|
@@ -1208,6 +1208,11 @@ export interface AirdropSyncUnitsUpdateRequest {
|
|
|
1208
1208
|
* true, the sync unit will be archived.
|
|
1209
1209
|
*/
|
|
1210
1210
|
archive?: boolean;
|
|
1211
|
+
/**
|
|
1212
|
+
* Extraction window for the sync unit.
|
|
1213
|
+
* @format text
|
|
1214
|
+
*/
|
|
1215
|
+
extraction_window?: string;
|
|
1211
1216
|
first_sync_direction?: SyncDirection;
|
|
1212
1217
|
/**
|
|
1213
1218
|
* Sync unit on which the update should be performed.
|
|
@@ -3382,6 +3387,14 @@ export interface BrandsUpdateResponse {
|
|
|
3382
3387
|
export type Capability = PartBase;
|
|
3383
3388
|
/** capability-summary */
|
|
3384
3389
|
export type CapabilitySummary = PartBaseSummary;
|
|
3390
|
+
/**
|
|
3391
|
+
* card-view-ui-metadata
|
|
3392
|
+
* Card view UI hint overrides.
|
|
3393
|
+
*/
|
|
3394
|
+
export interface CardViewUiMetadata {
|
|
3395
|
+
/** True if field is visible in card view. */
|
|
3396
|
+
is_visible?: boolean;
|
|
3397
|
+
}
|
|
3385
3398
|
/** The operator used to compare the key and the value. */
|
|
3386
3399
|
export declare enum CaveatOperator {
|
|
3387
3400
|
Eq = "eq",
|
|
@@ -4700,6 +4713,8 @@ export type Conversation = AtomBase & {
|
|
|
4700
4713
|
* @example "2023-01-01T12:00:00.000Z"
|
|
4701
4714
|
*/
|
|
4702
4715
|
actual_close_date?: string;
|
|
4716
|
+
/** The properties of an enum value. */
|
|
4717
|
+
ai_resolution_status?: EnumValue;
|
|
4703
4718
|
/** Details of the parts relevant to the conversation. */
|
|
4704
4719
|
applies_to_parts?: PartSummary[];
|
|
4705
4720
|
/** Channel IDs of the conversation. */
|
|
@@ -4839,6 +4854,26 @@ export interface ConversationsCreateRequest {
|
|
|
4839
4854
|
* @example "ACC-12345"
|
|
4840
4855
|
*/
|
|
4841
4856
|
account?: string;
|
|
4857
|
+
/**
|
|
4858
|
+
* The AI resolution status enum ID for the conversation. Stock
|
|
4859
|
+
* allowed values:
|
|
4860
|
+
* ```
|
|
4861
|
+
* {
|
|
4862
|
+
* "id": 1,
|
|
4863
|
+
* "label": "deflected",
|
|
4864
|
+
* "ordinal": 1,
|
|
4865
|
+
* "overridable": false
|
|
4866
|
+
* },
|
|
4867
|
+
* {
|
|
4868
|
+
* "id": 2,
|
|
4869
|
+
* "label": "escalated",
|
|
4870
|
+
* "ordinal": 2,
|
|
4871
|
+
* "overridable": false
|
|
4872
|
+
* }
|
|
4873
|
+
* ```
|
|
4874
|
+
* @format int64
|
|
4875
|
+
*/
|
|
4876
|
+
ai_resolution_status?: number;
|
|
4842
4877
|
/**
|
|
4843
4878
|
* The brand associated with the conversation.
|
|
4844
4879
|
* @format id
|
|
@@ -4958,6 +4993,11 @@ export interface ConversationsExportRequest {
|
|
|
4958
4993
|
account?: string[];
|
|
4959
4994
|
/** Provides ways to specify date ranges on objects. */
|
|
4960
4995
|
actual_close_date?: DateFilter;
|
|
4996
|
+
/**
|
|
4997
|
+
* Filters for conversations with any of the provided AI resolution
|
|
4998
|
+
* statuses.
|
|
4999
|
+
*/
|
|
5000
|
+
ai_resolution_status?: number[];
|
|
4961
5001
|
/**
|
|
4962
5002
|
* Filters for conversations belonging to any of the provided parts.
|
|
4963
5003
|
* @example ["PROD-12345"]
|
|
@@ -5079,6 +5119,11 @@ export interface ConversationsListRequest {
|
|
|
5079
5119
|
account?: string[];
|
|
5080
5120
|
/** Provides ways to specify date ranges on objects. */
|
|
5081
5121
|
actual_close_date?: DateFilter;
|
|
5122
|
+
/**
|
|
5123
|
+
* Filters for conversations with any of the provided AI resolution
|
|
5124
|
+
* statuses.
|
|
5125
|
+
*/
|
|
5126
|
+
ai_resolution_status?: number[];
|
|
5082
5127
|
/**
|
|
5083
5128
|
* Filters for conversations belonging to any of the provided parts.
|
|
5084
5129
|
* @example ["PROD-12345"]
|
|
@@ -5210,6 +5255,26 @@ export interface ConversationsUpdateRequest {
|
|
|
5210
5255
|
* @example "ACC-12345"
|
|
5211
5256
|
*/
|
|
5212
5257
|
account?: string | null;
|
|
5258
|
+
/**
|
|
5259
|
+
* The AI resolution status enum ID for the conversation. Stock
|
|
5260
|
+
* allowed values:
|
|
5261
|
+
* ```
|
|
5262
|
+
* {
|
|
5263
|
+
* "id": 1,
|
|
5264
|
+
* "label": "deflected",
|
|
5265
|
+
* "ordinal": 1,
|
|
5266
|
+
* "overridable": false
|
|
5267
|
+
* },
|
|
5268
|
+
* {
|
|
5269
|
+
* "id": 2,
|
|
5270
|
+
* "label": "escalated",
|
|
5271
|
+
* "ordinal": 2,
|
|
5272
|
+
* "overridable": false
|
|
5273
|
+
* }
|
|
5274
|
+
* ```
|
|
5275
|
+
* @format int64
|
|
5276
|
+
*/
|
|
5277
|
+
ai_resolution_status?: number;
|
|
5213
5278
|
applies_to_parts?: ConversationsUpdateRequestAppliesToParts;
|
|
5214
5279
|
/**
|
|
5215
5280
|
* The brand associated with the conversation.
|
|
@@ -5664,6 +5729,11 @@ export interface CreateDashboardFilterCondition {
|
|
|
5664
5729
|
operator: DashboardFilterConditionOperator;
|
|
5665
5730
|
part_value?: CreateDashboardFilterPartCondition;
|
|
5666
5731
|
relative_date_value?: CreateDashboardFilterRelativeDateCondition;
|
|
5732
|
+
/**
|
|
5733
|
+
* The template expression to be resolved at runtime.
|
|
5734
|
+
* @format text
|
|
5735
|
+
*/
|
|
5736
|
+
template_value?: string;
|
|
5667
5737
|
/** The operator used to compare the key and value. */
|
|
5668
5738
|
value_type: DashboardFilterConditionValueType;
|
|
5669
5739
|
}
|
|
@@ -6463,6 +6533,14 @@ export interface CreatePieWidgetVisualization {
|
|
|
6463
6533
|
x: CreatePieVisualizationXAxis[];
|
|
6464
6534
|
y: CreatePieVisualizationYAxis;
|
|
6465
6535
|
}
|
|
6536
|
+
/** create-pinned-filter */
|
|
6537
|
+
export interface CreatePinnedFilter {
|
|
6538
|
+
/**
|
|
6539
|
+
* The field reference name from the data source schema.
|
|
6540
|
+
* @format text
|
|
6541
|
+
*/
|
|
6542
|
+
reference_name: string;
|
|
6543
|
+
}
|
|
6466
6544
|
/** create-rich-text-widget-visualization */
|
|
6467
6545
|
export interface CreateRichTextWidgetVisualization {
|
|
6468
6546
|
/** The content of the rich text. */
|
|
@@ -6685,6 +6763,12 @@ export type CreateStarterMessageNudgeWidgetStarterMessageNudgeType = string;
|
|
|
6685
6763
|
export interface CreateSubWidget {
|
|
6686
6764
|
/** A unified query language for DevRev objects. */
|
|
6687
6765
|
dql_query?: DevrevQuery;
|
|
6766
|
+
/**
|
|
6767
|
+
* Filters that should be shown as empty filter options in the list
|
|
6768
|
+
* view. The UI uses the data source schema to determine appropriate
|
|
6769
|
+
* filter controls for each field.
|
|
6770
|
+
*/
|
|
6771
|
+
pinned_filters?: CreatePinnedFilter[];
|
|
6688
6772
|
query?: CreateWidgetQuery;
|
|
6689
6773
|
/**
|
|
6690
6774
|
* A reference ID for the sub-widget. It should be unique within the
|
|
@@ -7371,6 +7455,8 @@ export type CustomLinkType = AtomBase & {
|
|
|
7371
7455
|
* @format text
|
|
7372
7456
|
*/
|
|
7373
7457
|
tooltip?: string;
|
|
7458
|
+
/** UI metadata for custom link types. */
|
|
7459
|
+
ui?: LinkTypeUiMetadata;
|
|
7374
7460
|
};
|
|
7375
7461
|
/** custom-link-type-create-request */
|
|
7376
7462
|
export interface CustomLinkTypeCreateRequest {
|
|
@@ -8429,7 +8515,14 @@ export interface CustomViewColumnProperties {
|
|
|
8429
8515
|
width?: string;
|
|
8430
8516
|
}
|
|
8431
8517
|
/** dashboard */
|
|
8432
|
-
export type Dashboard = AtomBase
|
|
8518
|
+
export type Dashboard = AtomBase & {
|
|
8519
|
+
/**
|
|
8520
|
+
* Filters that should be shown as empty filter options on the
|
|
8521
|
+
* dashboard. The UI uses the data source schema to determine
|
|
8522
|
+
* appropriate filter controls for each field.
|
|
8523
|
+
*/
|
|
8524
|
+
pinned_filters?: PinnedFilter[];
|
|
8525
|
+
};
|
|
8433
8526
|
/**
|
|
8434
8527
|
* dashboard-filter
|
|
8435
8528
|
* A dashboard filter is a filter that can be applied to tabs, sections,
|
|
@@ -8451,7 +8544,8 @@ export declare enum DashboardFilterConditionOperator {
|
|
|
8451
8544
|
export declare enum DashboardFilterConditionValueType {
|
|
8452
8545
|
JsonValue = "json_value",
|
|
8453
8546
|
PartValue = "part_value",
|
|
8454
|
-
RelativeDateValue = "relative_date_value"
|
|
8547
|
+
RelativeDateValue = "relative_date_value",
|
|
8548
|
+
TemplateValue = "template_value"
|
|
8455
8549
|
}
|
|
8456
8550
|
/** The logical operator that binds the filter conditions or expressions. */
|
|
8457
8551
|
export declare enum DashboardFilterExpressionOperator {
|
|
@@ -9155,6 +9249,11 @@ export type DevUser = UserBase & {
|
|
|
9155
9249
|
experience_start_date?: string;
|
|
9156
9250
|
/** IDs of the Dev User outside the DevRev SOR. */
|
|
9157
9251
|
external_identities?: ExternalIdentity[];
|
|
9252
|
+
/**
|
|
9253
|
+
* Flag indicating if this user is currently invited. Remains true
|
|
9254
|
+
* even after the user accepts the invitation and becomes active.
|
|
9255
|
+
*/
|
|
9256
|
+
is_invited?: boolean;
|
|
9158
9257
|
/** Job history of the user. */
|
|
9159
9258
|
job_history?: JobHistoryItem[];
|
|
9160
9259
|
reports_to?: UserSummary;
|
|
@@ -10967,7 +11066,7 @@ export interface Error {
|
|
|
10967
11066
|
* error-bad-request
|
|
10968
11067
|
* Describes a error due to a bad request by the client.
|
|
10969
11068
|
*/
|
|
10970
|
-
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) & {
|
|
11069
|
+
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) & {
|
|
10971
11070
|
type: ErrorBadRequestType;
|
|
10972
11071
|
};
|
|
10973
11072
|
/** error-bad-request-artifact-already-attached-to-a-parent */
|
|
@@ -11269,6 +11368,32 @@ export interface ErrorBadRequestMissingRequiredField {
|
|
|
11269
11368
|
*/
|
|
11270
11369
|
field_name: string;
|
|
11271
11370
|
}
|
|
11371
|
+
/**
|
|
11372
|
+
* error-bad-request-operation-not-allowed
|
|
11373
|
+
* The operation is not allowed because the current state of the system
|
|
11374
|
+
* blocks it.
|
|
11375
|
+
*/
|
|
11376
|
+
export interface ErrorBadRequestOperationNotAllowed {
|
|
11377
|
+
/**
|
|
11378
|
+
* The current value of the blocking field.
|
|
11379
|
+
* @format text
|
|
11380
|
+
*/
|
|
11381
|
+
current_value?: string;
|
|
11382
|
+
/** The values that would allow the operation to proceed. */
|
|
11383
|
+
expected_values?: string[];
|
|
11384
|
+
/**
|
|
11385
|
+
* Dot-notation path to the field blocking the operation (e.g.
|
|
11386
|
+
* 'state', 'ai_agent.default_version_id',
|
|
11387
|
+
* 'default_version_id.state').
|
|
11388
|
+
* @format text
|
|
11389
|
+
*/
|
|
11390
|
+
field_path: string;
|
|
11391
|
+
/**
|
|
11392
|
+
* Why the operation is not allowed.
|
|
11393
|
+
* @format text
|
|
11394
|
+
*/
|
|
11395
|
+
reason?: string;
|
|
11396
|
+
}
|
|
11272
11397
|
/** error-bad-request-parse-error */
|
|
11273
11398
|
export type ErrorBadRequestParseError = object;
|
|
11274
11399
|
/**
|
|
@@ -11373,6 +11498,7 @@ export declare enum ErrorBadRequestType {
|
|
|
11373
11498
|
MergeWorksError = "merge_works_error",
|
|
11374
11499
|
MissingDependency = "missing_dependency",
|
|
11375
11500
|
MissingRequiredField = "missing_required_field",
|
|
11501
|
+
OperationNotAllowed = "operation_not_allowed",
|
|
11376
11502
|
ParseError = "parse_error",
|
|
11377
11503
|
SpaceValidationErrors = "space_validation_errors",
|
|
11378
11504
|
StaleSchemaFragments = "stale_schema_fragments",
|
|
@@ -11416,6 +11542,13 @@ export declare enum ErrorBadRequestUnexpectedJsonTypeType {
|
|
|
11416
11542
|
}
|
|
11417
11543
|
/** error-bad-request-value-not-permitted */
|
|
11418
11544
|
export interface ErrorBadRequestValueNotPermitted {
|
|
11545
|
+
/**
|
|
11546
|
+
* The actual value that was provided.
|
|
11547
|
+
* @format text
|
|
11548
|
+
*/
|
|
11549
|
+
actual_value?: string;
|
|
11550
|
+
/** The allowed object types for ID fields. */
|
|
11551
|
+
allowed_object_types?: string[];
|
|
11419
11552
|
/** The allowed values for the field. */
|
|
11420
11553
|
allowed_values?: string[];
|
|
11421
11554
|
/**
|
|
@@ -11423,6 +11556,16 @@ export interface ErrorBadRequestValueNotPermitted {
|
|
|
11423
11556
|
* @format text
|
|
11424
11557
|
*/
|
|
11425
11558
|
field_name: string;
|
|
11559
|
+
/**
|
|
11560
|
+
* The maximum allowed value or length.
|
|
11561
|
+
* @format text
|
|
11562
|
+
*/
|
|
11563
|
+
max_value?: string;
|
|
11564
|
+
/**
|
|
11565
|
+
* The minimum allowed value or length.
|
|
11566
|
+
* @format text
|
|
11567
|
+
*/
|
|
11568
|
+
min_value?: string;
|
|
11426
11569
|
/**
|
|
11427
11570
|
* The pattern the value must match.
|
|
11428
11571
|
* @format text
|
|
@@ -12299,11 +12442,47 @@ export interface EventWorkflowDeleted {
|
|
|
12299
12442
|
id: string;
|
|
12300
12443
|
old_workflow?: Workflow;
|
|
12301
12444
|
}
|
|
12445
|
+
/** event-workflow-step-created */
|
|
12446
|
+
export interface EventWorkflowStepCreated {
|
|
12447
|
+
workflow_step: WorkflowStep;
|
|
12448
|
+
}
|
|
12449
|
+
/** event-workflow-step-deleted */
|
|
12450
|
+
export interface EventWorkflowStepDeleted {
|
|
12451
|
+
/**
|
|
12452
|
+
* The ID of the workflow step that was deleted.
|
|
12453
|
+
* @format id
|
|
12454
|
+
*/
|
|
12455
|
+
id: string;
|
|
12456
|
+
old_workflow_step?: WorkflowStep;
|
|
12457
|
+
}
|
|
12458
|
+
/** event-workflow-step-updated */
|
|
12459
|
+
export interface EventWorkflowStepUpdated {
|
|
12460
|
+
old_workflow_step?: WorkflowStep;
|
|
12461
|
+
workflow_step: WorkflowStep;
|
|
12462
|
+
}
|
|
12302
12463
|
/** event-workflow-updated */
|
|
12303
12464
|
export interface EventWorkflowUpdated {
|
|
12304
12465
|
old_workflow?: Workflow;
|
|
12305
12466
|
workflow: Workflow;
|
|
12306
12467
|
}
|
|
12468
|
+
/** event-workflow-version-created */
|
|
12469
|
+
export interface EventWorkflowVersionCreated {
|
|
12470
|
+
workflow_version: WorkflowVersion;
|
|
12471
|
+
}
|
|
12472
|
+
/** event-workflow-version-deleted */
|
|
12473
|
+
export interface EventWorkflowVersionDeleted {
|
|
12474
|
+
/**
|
|
12475
|
+
* The ID of the workflow version that was deleted.
|
|
12476
|
+
* @format id
|
|
12477
|
+
*/
|
|
12478
|
+
id: string;
|
|
12479
|
+
old_workflow_version?: WorkflowVersion;
|
|
12480
|
+
}
|
|
12481
|
+
/** event-workflow-version-updated */
|
|
12482
|
+
export interface EventWorkflowVersionUpdated {
|
|
12483
|
+
old_workflow_version?: WorkflowVersion;
|
|
12484
|
+
workflow_version: WorkflowVersion;
|
|
12485
|
+
}
|
|
12307
12486
|
/**
|
|
12308
12487
|
* export-audit-logs-request
|
|
12309
12488
|
* Request object to get a log's information.
|
|
@@ -13140,8 +13319,7 @@ export type GroupedVista = VistaBase & {
|
|
|
13140
13319
|
flavor?: GroupedVistaFlavor;
|
|
13141
13320
|
/** Automations specific to the Sprint Board vistas. */
|
|
13142
13321
|
sprint_board_automation?: SprintBoardAutomation;
|
|
13143
|
-
|
|
13144
|
-
sprint_board_config?: SprintBoardConfig;
|
|
13322
|
+
sprint_board_config?: GroupedVistaSprintBoardConfig;
|
|
13145
13323
|
};
|
|
13146
13324
|
/** Type of DevRev object for which the grouped vista is applicable. */
|
|
13147
13325
|
export declare enum GroupedVistaFilterType {
|
|
@@ -13155,6 +13333,38 @@ export declare enum GroupedVistaFlavor {
|
|
|
13155
13333
|
SprintBoard = "sprint_board",
|
|
13156
13334
|
SupportInbox = "support_inbox"
|
|
13157
13335
|
}
|
|
13336
|
+
/** grouped-vista-sprint-board-config */
|
|
13337
|
+
export interface GroupedVistaSprintBoardConfig {
|
|
13338
|
+
/**
|
|
13339
|
+
* Cooldown period in days between sprints.
|
|
13340
|
+
* @format int32
|
|
13341
|
+
*/
|
|
13342
|
+
cooldown?: number;
|
|
13343
|
+
/**
|
|
13344
|
+
* Sprint duration in days.
|
|
13345
|
+
* @format int32
|
|
13346
|
+
*/
|
|
13347
|
+
duration?: number;
|
|
13348
|
+
/**
|
|
13349
|
+
* Number of planned sprints for the sprint board.
|
|
13350
|
+
* @format int32
|
|
13351
|
+
*/
|
|
13352
|
+
planned_sprints?: number;
|
|
13353
|
+
sprint_name_config?: GroupedVistaSprintNamingConfig;
|
|
13354
|
+
}
|
|
13355
|
+
/** grouped-vista-sprint-naming-config */
|
|
13356
|
+
export interface GroupedVistaSprintNamingConfig {
|
|
13357
|
+
/**
|
|
13358
|
+
* The number to assign to the next sprint created.
|
|
13359
|
+
* @format int32
|
|
13360
|
+
*/
|
|
13361
|
+
next_sprint_number?: number;
|
|
13362
|
+
/**
|
|
13363
|
+
* Template for naming sprints.
|
|
13364
|
+
* @format text
|
|
13365
|
+
*/
|
|
13366
|
+
sprint_name_template?: string;
|
|
13367
|
+
}
|
|
13158
13368
|
/**
|
|
13159
13369
|
* grouped-vista-summary
|
|
13160
13370
|
* Represents a group of multiple vistas as a single unit.
|
|
@@ -13232,6 +13442,8 @@ export interface GroupsListRequest {
|
|
|
13232
13442
|
group_type?: GroupType[];
|
|
13233
13443
|
/** Filter groups by ingestion source(s). */
|
|
13234
13444
|
ingestion_source?: GroupIngestionSource[];
|
|
13445
|
+
/** Filters the groups on the basis of archival status. */
|
|
13446
|
+
is_archived?: boolean;
|
|
13235
13447
|
/** Whether to fetch default or custom groups. */
|
|
13236
13448
|
is_default?: boolean;
|
|
13237
13449
|
/**
|
|
@@ -14602,6 +14814,66 @@ export interface LinkTargetDescriptorFilter {
|
|
|
14602
14814
|
*/
|
|
14603
14815
|
subtype?: string;
|
|
14604
14816
|
}
|
|
14817
|
+
/**
|
|
14818
|
+
* link-target-gantt-view-ui-metadata
|
|
14819
|
+
* Gantt view UI metadata for a link type.
|
|
14820
|
+
*/
|
|
14821
|
+
export interface LinkTargetGanttViewUiMetadata {
|
|
14822
|
+
/**
|
|
14823
|
+
* Visual connection style reference for gantt view.
|
|
14824
|
+
* @format text
|
|
14825
|
+
*/
|
|
14826
|
+
connection_type?: string;
|
|
14827
|
+
}
|
|
14828
|
+
/**
|
|
14829
|
+
* link-target-list-view-ui-metadata
|
|
14830
|
+
* List view UI metadata for a link type.
|
|
14831
|
+
*/
|
|
14832
|
+
export interface LinkTargetListViewUiMetadata {
|
|
14833
|
+
/**
|
|
14834
|
+
* Whether this link type appears in the column selection dropdown on
|
|
14835
|
+
* vistas.
|
|
14836
|
+
*/
|
|
14837
|
+
is_hidden?: boolean;
|
|
14838
|
+
/**
|
|
14839
|
+
* Whether links of this type are rendered in the expandable hierarchy
|
|
14840
|
+
* section.
|
|
14841
|
+
*/
|
|
14842
|
+
is_hierarchical?: boolean;
|
|
14843
|
+
}
|
|
14844
|
+
/**
|
|
14845
|
+
* link-target-summary-view-ui-metadata
|
|
14846
|
+
* Summary view UI metadata for a link type.
|
|
14847
|
+
*/
|
|
14848
|
+
export interface LinkTargetSummaryViewUiMetadata {
|
|
14849
|
+
/**
|
|
14850
|
+
* Whether this link type is shown in the collapsed compact view of
|
|
14851
|
+
* the sidepanel.
|
|
14852
|
+
*/
|
|
14853
|
+
is_visible?: boolean;
|
|
14854
|
+
}
|
|
14855
|
+
/**
|
|
14856
|
+
* link-target-ui-metadata
|
|
14857
|
+
* UI metadata for one direction of a link type.
|
|
14858
|
+
*/
|
|
14859
|
+
export interface LinkTargetUiMetadata {
|
|
14860
|
+
/**
|
|
14861
|
+
* Color used for linked object IDs.
|
|
14862
|
+
* @format text
|
|
14863
|
+
*/
|
|
14864
|
+
color?: string;
|
|
14865
|
+
/** Gantt view UI metadata for a link type. */
|
|
14866
|
+
gantt_view?: LinkTargetGanttViewUiMetadata;
|
|
14867
|
+
/**
|
|
14868
|
+
* Icon reference for this link type.
|
|
14869
|
+
* @format text
|
|
14870
|
+
*/
|
|
14871
|
+
icon?: string;
|
|
14872
|
+
/** List view UI metadata for a link type. */
|
|
14873
|
+
list_view?: LinkTargetListViewUiMetadata;
|
|
14874
|
+
/** Summary view UI metadata for a link type. */
|
|
14875
|
+
summary_view?: LinkTargetSummaryViewUiMetadata;
|
|
14876
|
+
}
|
|
14605
14877
|
/** Type of link used to define the relationship. */
|
|
14606
14878
|
export declare enum LinkType {
|
|
14607
14879
|
CustomLink = "custom_link",
|
|
@@ -14618,6 +14890,18 @@ export declare enum LinkType {
|
|
|
14618
14890
|
IsRelatedTo = "is_related_to",
|
|
14619
14891
|
Serves = "serves"
|
|
14620
14892
|
}
|
|
14893
|
+
/**
|
|
14894
|
+
* link-type-ui-metadata
|
|
14895
|
+
* UI metadata for custom link types.
|
|
14896
|
+
*/
|
|
14897
|
+
export interface LinkTypeUiMetadata {
|
|
14898
|
+
/** Whether this link type should be hidden in the UI links block. */
|
|
14899
|
+
is_hidden?: boolean;
|
|
14900
|
+
/** UI metadata for one direction of a link type. */
|
|
14901
|
+
source?: LinkTargetUiMetadata;
|
|
14902
|
+
/** UI metadata for one direction of a link type. */
|
|
14903
|
+
target?: LinkTargetUiMetadata;
|
|
14904
|
+
}
|
|
14621
14905
|
/** linkable */
|
|
14622
14906
|
export type Linkable = PartBase;
|
|
14623
14907
|
/** linkable-summary */
|
|
@@ -14885,6 +15169,8 @@ export interface MarketplaceItemFeaturesListRequest {
|
|
|
14885
15169
|
* @format id
|
|
14886
15170
|
*/
|
|
14887
15171
|
marketplace?: string;
|
|
15172
|
+
/** Filters on marketplace item IDs for marketplace item features. */
|
|
15173
|
+
marketplace_item?: string[];
|
|
14888
15174
|
/**
|
|
14889
15175
|
* The iteration mode to use. If "after", then entries after the provided
|
|
14890
15176
|
* cursor will be returned, or if no cursor is provided, then from the
|
|
@@ -15025,6 +15311,11 @@ export type MarketplaceItemSummary = AtomBaseSummary & {
|
|
|
15025
15311
|
* @format text
|
|
15026
15312
|
*/
|
|
15027
15313
|
tagline?: string;
|
|
15314
|
+
/**
|
|
15315
|
+
* Version information for a marketplace listing, specifying the semantic
|
|
15316
|
+
* version being shipped to users.
|
|
15317
|
+
*/
|
|
15318
|
+
version?: MarketplaceListingVersionSummary;
|
|
15028
15319
|
};
|
|
15029
15320
|
/** marketplace-items-install-request */
|
|
15030
15321
|
export interface MarketplaceItemsInstallRequest {
|
|
@@ -15040,6 +15331,12 @@ export interface MarketplaceItemsInstallRequest {
|
|
|
15040
15331
|
export interface MarketplaceItemsInstallResponse {
|
|
15041
15332
|
created_object: AtomSummary;
|
|
15042
15333
|
}
|
|
15334
|
+
/**
|
|
15335
|
+
* marketplace-listing-version-summary
|
|
15336
|
+
* Version information for a marketplace listing, specifying the semantic
|
|
15337
|
+
* version being shipped to users.
|
|
15338
|
+
*/
|
|
15339
|
+
export type MarketplaceListingVersionSummary = object;
|
|
15043
15340
|
/**
|
|
15044
15341
|
* meerkat-widget-column-function
|
|
15045
15342
|
* Deprecated: Use widget_query_column_config with type=function on
|
|
@@ -15154,10 +15451,18 @@ export type Meeting = AtomBase & {
|
|
|
15154
15451
|
* @format text
|
|
15155
15452
|
*/
|
|
15156
15453
|
external_url?: string;
|
|
15454
|
+
/**
|
|
15455
|
+
* Whether this meeting has been archived as a secondary record in a
|
|
15456
|
+
* merge. Archived meetings are excluded from list, count, group, and
|
|
15457
|
+
* search endpoints, but remain retrievable via meetings.get so
|
|
15458
|
+
* clients can follow the merge reference using primary_meeting.
|
|
15459
|
+
*/
|
|
15460
|
+
is_archived?: boolean;
|
|
15157
15461
|
/** The members in the meeting. */
|
|
15158
15462
|
members?: AtomSummary[];
|
|
15159
15463
|
organizer?: AtomSummary;
|
|
15160
15464
|
parent?: AtomSummary;
|
|
15465
|
+
primary_meeting?: MeetingSummary;
|
|
15161
15466
|
recording?: ArtifactSummary;
|
|
15162
15467
|
/**
|
|
15163
15468
|
* Recording URL of the meeting.
|
|
@@ -15704,6 +16009,10 @@ export interface MeetingsUpdateRequestMembers {
|
|
|
15704
16009
|
}
|
|
15705
16010
|
/** meetings-update-request-tags */
|
|
15706
16011
|
export interface MeetingsUpdateRequestTags {
|
|
16012
|
+
/** Adds the provided tags on the meeting item. */
|
|
16013
|
+
add?: AddTagWithValue[];
|
|
16014
|
+
/** Removes the provided tags on the meeting item. */
|
|
16015
|
+
remove?: RemoveTagWithValue[];
|
|
15707
16016
|
/** Sets the provided tags on the meeting item. */
|
|
15708
16017
|
set?: SetTagWithValue[];
|
|
15709
16018
|
}
|
|
@@ -16573,14 +16882,23 @@ export interface Money {
|
|
|
16573
16882
|
}
|
|
16574
16883
|
/** network-log */
|
|
16575
16884
|
export interface NetworkLog {
|
|
16576
|
-
/**
|
|
16577
|
-
|
|
16578
|
-
* @format text
|
|
16579
|
-
*/
|
|
16580
|
-
type: string;
|
|
16885
|
+
/** The type of network log. */
|
|
16886
|
+
type: NetworkLogType;
|
|
16581
16887
|
request: ObservabilityNetworkRequest;
|
|
16582
16888
|
response: ObservabilityNetworkResponse;
|
|
16583
16889
|
}
|
|
16890
|
+
/** The type of network log. */
|
|
16891
|
+
export declare enum NetworkLogType {
|
|
16892
|
+
Css = "css",
|
|
16893
|
+
Fetch = "fetch",
|
|
16894
|
+
Font = "font",
|
|
16895
|
+
Iframe = "iframe",
|
|
16896
|
+
Img = "img",
|
|
16897
|
+
Link = "link",
|
|
16898
|
+
Other = "other",
|
|
16899
|
+
Script = "script",
|
|
16900
|
+
Xhr = "xhr"
|
|
16901
|
+
}
|
|
16584
16902
|
/** notification-content-template */
|
|
16585
16903
|
export type NotificationContentTemplate = ContentTemplateBase;
|
|
16586
16904
|
/** notification-content-template-summary */
|
|
@@ -16630,7 +16948,7 @@ export interface ObjectsListRequest {
|
|
|
16630
16948
|
* objects-list-response
|
|
16631
16949
|
* Response for objects list.
|
|
16632
16950
|
*/
|
|
16633
|
-
export type ObjectsListResponse = (ObjectsListResponseArticlesList | ObjectsListResponseCustomObjectsList | ObjectsListResponseEnhancementsList | ObjectsListResponseIssuesList) & {
|
|
16951
|
+
export type ObjectsListResponse = (ObjectsListResponseArticlesList | ObjectsListResponseCustomObjectsList | ObjectsListResponseEnhancementsList | ObjectsListResponseIssuesList | ObjectsListResponseRevUsersList) & {
|
|
16634
16952
|
type: ObjectsListResponseType;
|
|
16635
16953
|
/**
|
|
16636
16954
|
* The cursor used to iterate subsequent results in accordance to the
|
|
@@ -16665,11 +16983,17 @@ export interface ObjectsListResponseIssuesList {
|
|
|
16665
16983
|
/** The list of issues. */
|
|
16666
16984
|
issues: Work[];
|
|
16667
16985
|
}
|
|
16986
|
+
/** objects-list-response-rev-users-list */
|
|
16987
|
+
export interface ObjectsListResponseRevUsersList {
|
|
16988
|
+
/** The list of Rev users (contacts). */
|
|
16989
|
+
rev_users: RevUser[];
|
|
16990
|
+
}
|
|
16668
16991
|
export declare enum ObjectsListResponseType {
|
|
16669
16992
|
Articles = "articles",
|
|
16670
16993
|
CustomObjects = "custom_objects",
|
|
16671
16994
|
Enhancements = "enhancements",
|
|
16672
|
-
Issues = "issues"
|
|
16995
|
+
Issues = "issues",
|
|
16996
|
+
RevUsers = "rev_users"
|
|
16673
16997
|
}
|
|
16674
16998
|
/** observability-network-request */
|
|
16675
16999
|
export interface ObservabilityNetworkRequest {
|
|
@@ -18377,6 +18701,19 @@ export interface PingResponse {
|
|
|
18377
18701
|
*/
|
|
18378
18702
|
timestamp: string;
|
|
18379
18703
|
}
|
|
18704
|
+
/**
|
|
18705
|
+
* pinned-filter
|
|
18706
|
+
* A pinned filter declares a field that should be shown as an empty
|
|
18707
|
+
* filter option in the UI. The UI uses the data source schema to
|
|
18708
|
+
* determine the appropriate filter control for the field.
|
|
18709
|
+
*/
|
|
18710
|
+
export interface PinnedFilter {
|
|
18711
|
+
/**
|
|
18712
|
+
* The field reference name from the data source schema.
|
|
18713
|
+
* @format text
|
|
18714
|
+
*/
|
|
18715
|
+
reference_name: string;
|
|
18716
|
+
}
|
|
18380
18717
|
/** preferences */
|
|
18381
18718
|
export type Preferences = UserPreferences & {
|
|
18382
18719
|
type: PreferencesType;
|
|
@@ -20268,6 +20605,11 @@ export interface SchemaFieldDescriptorBase {
|
|
|
20268
20605
|
* @format text
|
|
20269
20606
|
*/
|
|
20270
20607
|
description?: string;
|
|
20608
|
+
/**
|
|
20609
|
+
* Whether this field is derived (computed by the system and not
|
|
20610
|
+
* settable by users).
|
|
20611
|
+
*/
|
|
20612
|
+
is_derived?: boolean;
|
|
20271
20613
|
/** Whether this field is filterable, groupable and sortable. */
|
|
20272
20614
|
is_filterable?: boolean;
|
|
20273
20615
|
/** Whether this field is immutable or not. */
|
|
@@ -20389,6 +20731,8 @@ export interface SchemaFieldUenumValue {
|
|
|
20389
20731
|
* The schema of ui specific fields.
|
|
20390
20732
|
*/
|
|
20391
20733
|
export interface SchemaFieldUiMetadata {
|
|
20734
|
+
/** Card view UI hint overrides. */
|
|
20735
|
+
card_view?: CardViewUiMetadata;
|
|
20392
20736
|
/** The client overrides for the field. */
|
|
20393
20737
|
client_overrides?: ClientOverride[];
|
|
20394
20738
|
/** Create view UI hint overrides. */
|
|
@@ -20981,7 +21325,6 @@ export declare enum SearchHybridNamespace {
|
|
|
20981
21325
|
Conversation = "conversation",
|
|
20982
21326
|
CustomObject = "custom_object",
|
|
20983
21327
|
CustomPart = "custom_part",
|
|
20984
|
-
CustomWork = "custom_work",
|
|
20985
21328
|
Dashboard = "dashboard",
|
|
20986
21329
|
Dataset = "dataset",
|
|
20987
21330
|
DevUser = "dev_user",
|
|
@@ -20998,7 +21341,6 @@ export declare enum SearchHybridNamespace {
|
|
|
20998
21341
|
Opportunity = "opportunity",
|
|
20999
21342
|
Part = "part",
|
|
21000
21343
|
Product = "product",
|
|
21001
|
-
Project = "project",
|
|
21002
21344
|
QuestionAnswer = "question_answer",
|
|
21003
21345
|
RevOrg = "rev_org",
|
|
21004
21346
|
RevUser = "rev_user",
|
|
@@ -21054,7 +21396,6 @@ export declare enum SearchNamespace {
|
|
|
21054
21396
|
Conversation = "conversation",
|
|
21055
21397
|
CustomObject = "custom_object",
|
|
21056
21398
|
CustomPart = "custom_part",
|
|
21057
|
-
CustomWork = "custom_work",
|
|
21058
21399
|
Dashboard = "dashboard",
|
|
21059
21400
|
DevUser = "dev_user",
|
|
21060
21401
|
Directory = "directory",
|
|
@@ -21068,7 +21409,6 @@ export declare enum SearchNamespace {
|
|
|
21068
21409
|
Operation = "operation",
|
|
21069
21410
|
Opportunity = "opportunity",
|
|
21070
21411
|
Product = "product",
|
|
21071
|
-
Project = "project",
|
|
21072
21412
|
QuestionAnswer = "question_answer",
|
|
21073
21413
|
RevOrg = "rev_org",
|
|
21074
21414
|
RevUser = "rev_user",
|
|
@@ -22528,29 +22868,13 @@ export interface SprintBoardAutomation {
|
|
|
22528
22868
|
* enabled or not.
|
|
22529
22869
|
*/
|
|
22530
22870
|
auto_issue_rollover_enabled?: boolean;
|
|
22531
|
-
/** Whether this sprintboard has opted for mid-sprint status updates. */
|
|
22532
|
-
sprint_status_update_enabled?: boolean;
|
|
22533
|
-
}
|
|
22534
|
-
/**
|
|
22535
|
-
* sprint-board-config
|
|
22536
|
-
* Settings specific to sprint board vistas.
|
|
22537
|
-
*/
|
|
22538
|
-
export interface SprintBoardConfig {
|
|
22539
22871
|
/**
|
|
22540
|
-
*
|
|
22541
|
-
*
|
|
22542
|
-
*/
|
|
22543
|
-
cooldown?: number;
|
|
22544
|
-
/**
|
|
22545
|
-
* Sprint duration in days.
|
|
22546
|
-
* @format int32
|
|
22872
|
+
* Whether issues should be moved to Backlog stage when removed from a
|
|
22873
|
+
* sprint.
|
|
22547
22874
|
*/
|
|
22548
|
-
|
|
22549
|
-
/**
|
|
22550
|
-
|
|
22551
|
-
* @format int32
|
|
22552
|
-
*/
|
|
22553
|
-
planned_sprints?: number;
|
|
22875
|
+
move_issues_to_backlog_on_sprint_removal_enabled?: boolean;
|
|
22876
|
+
/** Whether this sprintboard has opted for mid-sprint status updates. */
|
|
22877
|
+
sprint_status_update_enabled?: boolean;
|
|
22554
22878
|
}
|
|
22555
22879
|
/**
|
|
22556
22880
|
* stage
|
|
@@ -22912,6 +23236,12 @@ export interface StockSchemaFragmentsListResponse {
|
|
|
22912
23236
|
* widget.
|
|
22913
23237
|
*/
|
|
22914
23238
|
export interface SubWidget {
|
|
23239
|
+
/**
|
|
23240
|
+
* Filters that should be shown as empty filter options in the list
|
|
23241
|
+
* view. The UI uses the data source schema to determine appropriate
|
|
23242
|
+
* filter controls for each field.
|
|
23243
|
+
*/
|
|
23244
|
+
pinned_filters?: PinnedFilter[];
|
|
22915
23245
|
/**
|
|
22916
23246
|
* The query for a widget. This includes measures and dimensions to be
|
|
22917
23247
|
* visualized.
|
|
@@ -24683,8 +25013,14 @@ export interface TimelineEntriesListRequest {
|
|
|
24683
25013
|
/**
|
|
24684
25014
|
* The collection(s) to list entries from, otherwise if not provided,
|
|
24685
25015
|
* all entries are returned.
|
|
25016
|
+
* @maxItems 1
|
|
24686
25017
|
*/
|
|
24687
25018
|
collections?: TimelineEntriesCollection[];
|
|
25019
|
+
/**
|
|
25020
|
+
* Filters for entries created by any of the provided users.
|
|
25021
|
+
* @example ["DEVU-12345"]
|
|
25022
|
+
*/
|
|
25023
|
+
created_by?: string[];
|
|
24688
25024
|
created_date?: DateTimeFilter;
|
|
24689
25025
|
/**
|
|
24690
25026
|
* The cursor to resume iteration from. If not provided, then
|
|
@@ -26027,6 +26363,12 @@ export interface VistaGroupBase {
|
|
|
26027
26363
|
* @maxLength 16000
|
|
26028
26364
|
*/
|
|
26029
26365
|
goals?: string;
|
|
26366
|
+
/**
|
|
26367
|
+
* The artifact ID of the goals document for sprint.
|
|
26368
|
+
* @format id
|
|
26369
|
+
* @example "ARTIFACT-12345"
|
|
26370
|
+
*/
|
|
26371
|
+
goals_document?: string;
|
|
26030
26372
|
/**
|
|
26031
26373
|
* Globally unique object ID.
|
|
26032
26374
|
* @format id
|
|
@@ -27078,7 +27420,13 @@ export interface WebhookEventRequest {
|
|
|
27078
27420
|
work_updated?: EventWorkUpdated;
|
|
27079
27421
|
workflow_created?: EventWorkflowCreated;
|
|
27080
27422
|
workflow_deleted?: EventWorkflowDeleted;
|
|
27423
|
+
workflow_step_created?: EventWorkflowStepCreated;
|
|
27424
|
+
workflow_step_deleted?: EventWorkflowStepDeleted;
|
|
27425
|
+
workflow_step_updated?: EventWorkflowStepUpdated;
|
|
27081
27426
|
workflow_updated?: EventWorkflowUpdated;
|
|
27427
|
+
workflow_version_created?: EventWorkflowVersionCreated;
|
|
27428
|
+
workflow_version_deleted?: EventWorkflowVersionDeleted;
|
|
27429
|
+
workflow_version_updated?: EventWorkflowVersionUpdated;
|
|
27082
27430
|
}
|
|
27083
27431
|
/** webhook-event-response */
|
|
27084
27432
|
export interface WebhookEventResponse {
|
|
@@ -28117,8 +28465,12 @@ export type WorkflowRunSummary = AtomBaseSummary;
|
|
|
28117
28465
|
export type WorkflowSearchSummary = SearchSummaryBase & {
|
|
28118
28466
|
workflow: WorkflowSummary;
|
|
28119
28467
|
};
|
|
28468
|
+
/** workflow-step */
|
|
28469
|
+
export type WorkflowStep = AtomBase;
|
|
28120
28470
|
/** workflow-summary */
|
|
28121
28471
|
export type WorkflowSummary = AtomBaseSummary;
|
|
28472
|
+
/** workflow-version */
|
|
28473
|
+
export type WorkflowVersion = AtomBase;
|
|
28122
28474
|
/** works-count-request */
|
|
28123
28475
|
export interface WorksCountRequest {
|
|
28124
28476
|
/** Filters for work of the provided types. */
|
|
@@ -29269,7 +29621,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
|
|
|
29269
29621
|
*/
|
|
29270
29622
|
export declare class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDataType> {
|
|
29271
29623
|
/**
|
|
29272
|
-
* @description Creates an account, which is a record representing a customer or an organization.
|
|
29624
|
+
* @description Creates an account, which is a record representing a customer or an organization. **Required scopes:** - `account:write` OR `account:all`
|
|
29273
29625
|
*
|
|
29274
29626
|
* @tags accounts
|
|
29275
29627
|
* @name AccountsCreate
|
|
@@ -29279,7 +29631,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
29279
29631
|
*/
|
|
29280
29632
|
accountsCreate: (data: AccountsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<AccountsCreateResponse, any, {}>>;
|
|
29281
29633
|
/**
|
|
29282
|
-
* @description Deletes an account.
|
|
29634
|
+
* @description Deletes an account. **Required scopes:** - `account:all`
|
|
29283
29635
|
*
|
|
29284
29636
|
* @tags accounts
|
|
29285
29637
|
* @name AccountsDelete
|
|
@@ -29289,7 +29641,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
29289
29641
|
*/
|
|
29290
29642
|
accountsDelete: (data: AccountsDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
|
|
29291
29643
|
/**
|
|
29292
|
-
* @description Exports a collection of accounts.
|
|
29644
|
+
* @description Exports a collection of accounts. **Required scopes:** - `account:read` OR `account:write` OR `account:all`
|
|
29293
29645
|
*
|
|
29294
29646
|
* @tags accounts
|
|
29295
29647
|
* @name AccountsExport
|
|
@@ -29357,7 +29709,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
29357
29709
|
websites?: string[];
|
|
29358
29710
|
}, params?: RequestParams) => Promise<AxiosResponse<AccountsExportResponse, any, {}>>;
|
|
29359
29711
|
/**
|
|
29360
|
-
* @description Exports a collection of accounts.
|
|
29712
|
+
* @description Exports a collection of accounts. **Required scopes:** - `account:read` OR `account:write` OR `account:all`
|
|
29361
29713
|
*
|
|
29362
29714
|
* @tags accounts
|
|
29363
29715
|
* @name AccountsExportPost
|
|
@@ -29367,7 +29719,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
29367
29719
|
*/
|
|
29368
29720
|
accountsExportPost: (data: AccountsExportRequest, params?: RequestParams) => Promise<AxiosResponse<AccountsExportResponse, any, {}>>;
|
|
29369
29721
|
/**
|
|
29370
|
-
* @description Retrieves an account's information.
|
|
29722
|
+
* @description Retrieves an account's information. **Required scopes:** - `account:read` OR `account:write` OR `account:all`
|
|
29371
29723
|
*
|
|
29372
29724
|
* @tags accounts
|
|
29373
29725
|
* @name AccountsGet
|
|
@@ -29384,7 +29736,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
29384
29736
|
id: string;
|
|
29385
29737
|
}, params?: RequestParams) => Promise<AxiosResponse<AccountsGetResponse, any, {}>>;
|
|
29386
29738
|
/**
|
|
29387
|
-
* @description Retrieves an account's information.
|
|
29739
|
+
* @description Retrieves an account's information. **Required scopes:** - `account:read` OR `account:write` OR `account:all`
|
|
29388
29740
|
*
|
|
29389
29741
|
* @tags accounts
|
|
29390
29742
|
* @name AccountsGetPost
|
|
@@ -29394,7 +29746,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
29394
29746
|
*/
|
|
29395
29747
|
accountsGetPost: (data: AccountsGetRequest, params?: RequestParams) => Promise<AxiosResponse<AccountsGetResponse, any, {}>>;
|
|
29396
29748
|
/**
|
|
29397
|
-
* @description Gets a list of accounts.
|
|
29749
|
+
* @description Gets a list of accounts. **Required scopes:** - `account:read` OR `account:write` OR `account:all`
|
|
29398
29750
|
*
|
|
29399
29751
|
* @tags accounts
|
|
29400
29752
|
* @name AccountsList
|
|
@@ -29472,7 +29824,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
29472
29824
|
websites?: string[];
|
|
29473
29825
|
}, params?: RequestParams) => Promise<AxiosResponse<AccountsListResponse, any, {}>>;
|
|
29474
29826
|
/**
|
|
29475
|
-
* @description Gets a list of accounts.
|
|
29827
|
+
* @description Gets a list of accounts. **Required scopes:** - `account:read` OR `account:write` OR `account:all`
|
|
29476
29828
|
*
|
|
29477
29829
|
* @tags accounts
|
|
29478
29830
|
* @name AccountsListPost
|
|
@@ -29482,7 +29834,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
29482
29834
|
*/
|
|
29483
29835
|
accountsListPost: (data: AccountsListRequest, params?: RequestParams) => Promise<AxiosResponse<AccountsListResponse, any, {}>>;
|
|
29484
29836
|
/**
|
|
29485
|
-
* @description Merges two accounts.
|
|
29837
|
+
* @description Merges two accounts. **Required scopes:** - `account:all`
|
|
29486
29838
|
*
|
|
29487
29839
|
* @tags accounts
|
|
29488
29840
|
* @name AccountsMerge
|
|
@@ -29492,7 +29844,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
29492
29844
|
*/
|
|
29493
29845
|
accountsMerge: (data: AccountsMergeRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
|
|
29494
29846
|
/**
|
|
29495
|
-
* @description Updates an account's information.
|
|
29847
|
+
* @description Updates an account's information. **Required scopes:** - `account:write` OR `account:all`
|
|
29496
29848
|
*
|
|
29497
29849
|
* @tags accounts
|
|
29498
29850
|
* @name AccountsUpdate
|
|
@@ -29890,7 +30242,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
29890
30242
|
*/
|
|
29891
30243
|
articlesCountPost: (data: ArticlesCountRequest, params?: RequestParams) => Promise<AxiosResponse<ArticlesCountResponse, any, {}>>;
|
|
29892
30244
|
/**
|
|
29893
|
-
* @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.
|
|
30245
|
+
* @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`
|
|
29894
30246
|
*
|
|
29895
30247
|
* @tags articles
|
|
29896
30248
|
* @name CreateArticle
|
|
@@ -29900,7 +30252,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
29900
30252
|
*/
|
|
29901
30253
|
createArticle: (data: ArticlesCreateRequest, params?: RequestParams) => Promise<AxiosResponse<ArticlesCreateResponse, any, {}>>;
|
|
29902
30254
|
/**
|
|
29903
|
-
* @description Deletes an article.
|
|
30255
|
+
* @description Deletes an article. **Required scopes:** - `article:all`
|
|
29904
30256
|
*
|
|
29905
30257
|
* @tags articles
|
|
29906
30258
|
* @name DeleteArticle
|
|
@@ -29910,7 +30262,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
29910
30262
|
*/
|
|
29911
30263
|
deleteArticle: (data: ArticlesDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
|
|
29912
30264
|
/**
|
|
29913
|
-
* @description Gets an article.
|
|
30265
|
+
* @description Gets an article. **Required scopes:** - `article:read` OR `article:write` OR `article:all`
|
|
29914
30266
|
*
|
|
29915
30267
|
* @tags articles
|
|
29916
30268
|
* @name GetArticle
|
|
@@ -29934,7 +30286,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
29934
30286
|
parent_article_id?: string;
|
|
29935
30287
|
}, params?: RequestParams) => Promise<AxiosResponse<ArticlesGetResponse, any, {}>>;
|
|
29936
30288
|
/**
|
|
29937
|
-
* @description Gets an article.
|
|
30289
|
+
* @description Gets an article. **Required scopes:** - `article:read` OR `article:write` OR `article:all`
|
|
29938
30290
|
*
|
|
29939
30291
|
* @tags articles
|
|
29940
30292
|
* @name GetArticlePost
|
|
@@ -29944,7 +30296,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
29944
30296
|
*/
|
|
29945
30297
|
getArticlePost: (data: ArticlesGetRequest, params?: RequestParams) => Promise<AxiosResponse<ArticlesGetResponse, any, {}>>;
|
|
29946
30298
|
/**
|
|
29947
|
-
* @description Lists a collection of articles.
|
|
30299
|
+
* @description Lists a collection of articles. **Required scopes:** - `article:read` OR `article:write` OR `article:all`
|
|
29948
30300
|
*
|
|
29949
30301
|
* @tags articles
|
|
29950
30302
|
* @name ListArticles
|
|
@@ -30044,7 +30396,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
30044
30396
|
tags?: string[];
|
|
30045
30397
|
}, params?: RequestParams) => Promise<AxiosResponse<ArticlesListResponse, any, {}>>;
|
|
30046
30398
|
/**
|
|
30047
|
-
* @description Lists a collection of articles.
|
|
30399
|
+
* @description Lists a collection of articles. **Required scopes:** - `article:read` OR `article:write` OR `article:all`
|
|
30048
30400
|
*
|
|
30049
30401
|
* @tags articles
|
|
30050
30402
|
* @name ListArticlesPost
|
|
@@ -30054,7 +30406,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
30054
30406
|
*/
|
|
30055
30407
|
listArticlesPost: (data: ArticlesListRequest, params?: RequestParams) => Promise<AxiosResponse<ArticlesListResponse, any, {}>>;
|
|
30056
30408
|
/**
|
|
30057
|
-
* @description Updates an article.
|
|
30409
|
+
* @description Updates an article. **Required scopes:** - `article:write` OR `article:all`
|
|
30058
30410
|
*
|
|
30059
30411
|
* @tags articles
|
|
30060
30412
|
* @name UpdateArticle
|
|
@@ -30064,7 +30416,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
30064
30416
|
*/
|
|
30065
30417
|
updateArticle: (data: ArticlesUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<ArticlesUpdateResponse, any, {}>>;
|
|
30066
30418
|
/**
|
|
30067
|
-
* @description Redirects to the artifact's download URL.
|
|
30419
|
+
* @description Redirects to the artifact's download URL. **Required scopes:** - `artifact:read`
|
|
30068
30420
|
*
|
|
30069
30421
|
* @tags artifacts
|
|
30070
30422
|
* @name ArtifactsDownload
|
|
@@ -30091,7 +30443,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
30091
30443
|
version?: string;
|
|
30092
30444
|
}, params?: RequestParams) => Promise<AxiosResponse<any, any, {}>>;
|
|
30093
30445
|
/**
|
|
30094
|
-
* @description Redirects to the artifact's download URL.
|
|
30446
|
+
* @description Redirects to the artifact's download URL. **Required scopes:** - `artifact:read`
|
|
30095
30447
|
*
|
|
30096
30448
|
* @tags artifacts
|
|
30097
30449
|
* @name ArtifactsDownloadPost
|
|
@@ -30101,7 +30453,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
30101
30453
|
*/
|
|
30102
30454
|
artifactsDownloadPost: (data: ArtifactsDownloadRequest, params?: RequestParams) => Promise<AxiosResponse<any, any, {}>>;
|
|
30103
30455
|
/**
|
|
30104
|
-
* @description Gets the requested artifact's information.
|
|
30456
|
+
* @description Gets the requested artifact's information. **Required scopes:** - `artifact:read` Also needs parent read access.
|
|
30105
30457
|
*
|
|
30106
30458
|
* @tags artifacts
|
|
30107
30459
|
* @name ArtifactsGet
|
|
@@ -30123,7 +30475,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
30123
30475
|
version?: string;
|
|
30124
30476
|
}, params?: RequestParams) => Promise<AxiosResponse<ArtifactsGetResponse, any, {}>>;
|
|
30125
30477
|
/**
|
|
30126
|
-
* @description Gets the requested artifact's information.
|
|
30478
|
+
* @description Gets the requested artifact's information. **Required scopes:** - `artifact:read` Also needs parent read access.
|
|
30127
30479
|
*
|
|
30128
30480
|
* @tags artifacts
|
|
30129
30481
|
* @name ArtifactsGetPost
|
|
@@ -30133,7 +30485,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
30133
30485
|
*/
|
|
30134
30486
|
artifactsGetPost: (data: ArtifactsGetRequest, params?: RequestParams) => Promise<AxiosResponse<ArtifactsGetResponse, any, {}>>;
|
|
30135
30487
|
/**
|
|
30136
|
-
* @description List the artifacts attached to an object.
|
|
30488
|
+
* @description List the artifacts attached to an object. **Required scopes:** - `artifact:read` Also needs parent read access.
|
|
30137
30489
|
*
|
|
30138
30490
|
* @tags artifacts
|
|
30139
30491
|
* @name ArtifactsList
|
|
@@ -30149,7 +30501,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
30149
30501
|
parent_id?: string;
|
|
30150
30502
|
}, params?: RequestParams) => Promise<AxiosResponse<ArtifactsListResponse, any, {}>>;
|
|
30151
30503
|
/**
|
|
30152
|
-
* @description List the artifacts attached to an object.
|
|
30504
|
+
* @description List the artifacts attached to an object. **Required scopes:** - `artifact:read` Also needs parent read access.
|
|
30153
30505
|
*
|
|
30154
30506
|
* @tags artifacts
|
|
30155
30507
|
* @name ArtifactsListPost
|
|
@@ -30159,7 +30511,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
30159
30511
|
*/
|
|
30160
30512
|
artifactsListPost: (data: ArtifactsListRequest, params?: RequestParams) => Promise<AxiosResponse<ArtifactsListResponse, any, {}>>;
|
|
30161
30513
|
/**
|
|
30162
|
-
* @description Gets the download URL for the artifact.
|
|
30514
|
+
* @description Gets the download URL for the artifact. **Required scopes:** - `artifact:read` Also needs parent read access.
|
|
30163
30515
|
*
|
|
30164
30516
|
* @tags artifacts
|
|
30165
30517
|
* @name ArtifactsLocate
|
|
@@ -30181,7 +30533,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
30181
30533
|
version?: string;
|
|
30182
30534
|
}, params?: RequestParams) => Promise<AxiosResponse<ArtifactsLocateResponse, any, {}>>;
|
|
30183
30535
|
/**
|
|
30184
|
-
* @description Gets the download URL for the artifact.
|
|
30536
|
+
* @description Gets the download URL for the artifact. **Required scopes:** - `artifact:read` Also needs parent read access.
|
|
30185
30537
|
*
|
|
30186
30538
|
* @tags artifacts
|
|
30187
30539
|
* @name ArtifactsLocatePost
|
|
@@ -30191,7 +30543,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
30191
30543
|
*/
|
|
30192
30544
|
artifactsLocatePost: (data: ArtifactsLocateRequest, params?: RequestParams) => Promise<AxiosResponse<ArtifactsLocateResponse, any, {}>>;
|
|
30193
30545
|
/**
|
|
30194
|
-
* @description Creates an artifact and generates an upload URL for its data.
|
|
30546
|
+
* @description Creates an artifact and generates an upload URL for its data. **Required scopes:** - `artifact:create`
|
|
30195
30547
|
*
|
|
30196
30548
|
* @tags artifacts
|
|
30197
30549
|
* @name ArtifactsPrepare
|
|
@@ -30201,7 +30553,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
30201
30553
|
*/
|
|
30202
30554
|
artifactsPrepare: (data: ArtifactsPrepareRequest, params?: RequestParams) => Promise<AxiosResponse<ArtifactsPrepareResponse, any, {}>>;
|
|
30203
30555
|
/**
|
|
30204
|
-
* @description Permanently deletes a version of an artifact.
|
|
30556
|
+
* @description Permanently deletes a version of an artifact. **Required scopes:** - `artifact:create`
|
|
30205
30557
|
*
|
|
30206
30558
|
* @tags artifacts
|
|
30207
30559
|
* @name ArtifactsHardDeleteVersion
|
|
@@ -30211,7 +30563,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
30211
30563
|
*/
|
|
30212
30564
|
artifactsHardDeleteVersion: (data: ArtifactsHardDeleteVersionRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
|
|
30213
30565
|
/**
|
|
30214
|
-
* @description Prepares a new version for an artifact, returning the URL and form data to upload the updated file.
|
|
30566
|
+
* @description Prepares a new version for an artifact, returning the URL and form data to upload the updated file. **Required scopes:** - `artifact:create`
|
|
30215
30567
|
*
|
|
30216
30568
|
* @tags artifacts
|
|
30217
30569
|
* @name ArtifactsVersionsPrepare
|
|
@@ -30257,7 +30609,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
30257
30609
|
*/
|
|
30258
30610
|
exportAuditLogs: (data: ExportAuditLogsRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
|
|
30259
30611
|
/**
|
|
30260
|
-
* @description Creates a JWT corresponding to the requested token type for the authenticated user.
|
|
30612
|
+
* @description Creates a JWT corresponding to the requested token type for the authenticated user. **Required scopes:** No scopes required.
|
|
30261
30613
|
*
|
|
30262
30614
|
* @tags auth-tokens
|
|
30263
30615
|
* @name AuthTokensCreate
|
|
@@ -30267,7 +30619,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
30267
30619
|
*/
|
|
30268
30620
|
authTokensCreate: (data: AuthTokensCreateRequest, params?: RequestParams) => Promise<AxiosResponse<AuthTokensCreateResponse, any, {}>>;
|
|
30269
30621
|
/**
|
|
30270
|
-
* @description Revokes the token that matches the given token ID issued under the given Dev organization.
|
|
30622
|
+
* @description Revokes the token that matches the given token ID issued under the given Dev organization. **Required scopes:** No scopes required.
|
|
30271
30623
|
*
|
|
30272
30624
|
* @tags auth-tokens
|
|
30273
30625
|
* @name AuthTokensDelete
|
|
@@ -30277,7 +30629,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
30277
30629
|
*/
|
|
30278
30630
|
authTokensDelete: (data: AuthTokensDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
|
|
30279
30631
|
/**
|
|
30280
|
-
* @description Gets the token metadata corresponding to the given token ID under the given Dev organization.
|
|
30632
|
+
* @description Gets the token metadata corresponding to the given token ID under the given Dev organization. **Required scopes:** No scopes required.
|
|
30281
30633
|
*
|
|
30282
30634
|
* @tags auth-tokens
|
|
30283
30635
|
* @name AuthTokensGet
|
|
@@ -30293,7 +30645,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
30293
30645
|
token_id: string;
|
|
30294
30646
|
}, params?: RequestParams) => Promise<AxiosResponse<AuthTokensGetResponse, any, {}>>;
|
|
30295
30647
|
/**
|
|
30296
|
-
* @description Gets the token metadata corresponding to the given token ID under the given Dev organization.
|
|
30648
|
+
* @description Gets the token metadata corresponding to the given token ID under the given Dev organization. **Required scopes:** No scopes required.
|
|
30297
30649
|
*
|
|
30298
30650
|
* @tags auth-tokens
|
|
30299
30651
|
* @name AuthTokensGetPost
|
|
@@ -30303,7 +30655,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
30303
30655
|
*/
|
|
30304
30656
|
authTokensGetPost: (data: AuthTokensGetRequest, params?: RequestParams) => Promise<AxiosResponse<AuthTokensGetResponse, any, {}>>;
|
|
30305
30657
|
/**
|
|
30306
|
-
* @description Returns the Dev organization, user and token attributes extracted from the auth token.
|
|
30658
|
+
* @description Returns the Dev organization, user and token attributes extracted from the auth token. **Required scopes:** No scopes required.
|
|
30307
30659
|
*
|
|
30308
30660
|
* @tags auth-tokens
|
|
30309
30661
|
* @name AuthTokensInfo
|
|
@@ -30313,7 +30665,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
30313
30665
|
*/
|
|
30314
30666
|
authTokensInfo: (params?: RequestParams) => Promise<AxiosResponse<AuthTokensInfoResponse, any, {}>>;
|
|
30315
30667
|
/**
|
|
30316
|
-
* @description Returns the Dev organization, user and token attributes extracted from the auth token.
|
|
30668
|
+
* @description Returns the Dev organization, user and token attributes extracted from the auth token. **Required scopes:** No scopes required.
|
|
30317
30669
|
*
|
|
30318
30670
|
* @tags auth-tokens
|
|
30319
30671
|
* @name AuthTokensInfoPost
|
|
@@ -30323,7 +30675,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
30323
30675
|
*/
|
|
30324
30676
|
authTokensInfoPost: (data: AuthTokensInfoRequest, params?: RequestParams) => Promise<AxiosResponse<AuthTokensInfoResponse, any, {}>>;
|
|
30325
30677
|
/**
|
|
30326
|
-
* @description Gets the token metadata for all the tokens corresponding to the given token type issued for a given subject.
|
|
30678
|
+
* @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.
|
|
30327
30679
|
*
|
|
30328
30680
|
* @tags auth-tokens
|
|
30329
30681
|
* @name AuthTokensList
|
|
@@ -30352,7 +30704,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
30352
30704
|
subject?: string;
|
|
30353
30705
|
}, params?: RequestParams) => Promise<AxiosResponse<AuthTokensListResponse, any, {}>>;
|
|
30354
30706
|
/**
|
|
30355
|
-
* @description Gets the token metadata for all the tokens corresponding to the given token type issued for a given subject.
|
|
30707
|
+
* @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.
|
|
30356
30708
|
*
|
|
30357
30709
|
* @tags auth-tokens
|
|
30358
30710
|
* @name AuthTokensListPost
|
|
@@ -30362,7 +30714,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
30362
30714
|
*/
|
|
30363
30715
|
authTokensListPost: (data: AuthTokensListRequest, params?: RequestParams) => Promise<AxiosResponse<AuthTokensListResponse, any, {}>>;
|
|
30364
30716
|
/**
|
|
30365
|
-
* @description Revokes all the tokens that matches the given token type created by the authenticated user.
|
|
30717
|
+
* @description Revokes all the tokens that matches the given token type created by the authenticated user. **Required scopes:** No scopes required.
|
|
30366
30718
|
*
|
|
30367
30719
|
* @tags auth-tokens
|
|
30368
30720
|
* @name AuthTokensSelfDelete
|
|
@@ -30372,7 +30724,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
30372
30724
|
*/
|
|
30373
30725
|
authTokensSelfDelete: (data: AuthTokensSelfDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
|
|
30374
30726
|
/**
|
|
30375
|
-
* @description Updates token metadata of a token issued under a given Dev organization.
|
|
30727
|
+
* @description Updates token metadata of a token issued under a given Dev organization. **Required scopes:** No scopes required.
|
|
30376
30728
|
*
|
|
30377
30729
|
* @tags auth-tokens
|
|
30378
30730
|
* @name AuthTokensUpdate
|
|
@@ -30465,7 +30817,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
30465
30817
|
*/
|
|
30466
30818
|
brandsUpdate: (data: BrandsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<BrandsUpdateResponse, any, {}>>;
|
|
30467
30819
|
/**
|
|
30468
|
-
* @description Creates a new chat, or optionally opens an existing one.
|
|
30820
|
+
* @description Creates a new chat, or optionally opens an existing one. **Required scopes:** Access is determined by chat membership.
|
|
30469
30821
|
*
|
|
30470
30822
|
* @tags chats
|
|
30471
30823
|
* @name ChatsCreate
|
|
@@ -30475,7 +30827,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
30475
30827
|
*/
|
|
30476
30828
|
chatsCreate: (data: ChatsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<ChatsCreateResponse, any, {}>>;
|
|
30477
30829
|
/**
|
|
30478
|
-
* @description Gets a chat's information.
|
|
30830
|
+
* @description Gets a chat's information. **Required scopes:** Access is determined by chat membership.
|
|
30479
30831
|
*
|
|
30480
30832
|
* @tags chats
|
|
30481
30833
|
* @name ChatsGet
|
|
@@ -30492,7 +30844,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
30492
30844
|
id?: string;
|
|
30493
30845
|
}, params?: RequestParams) => Promise<AxiosResponse<ChatsGetResponse, any, {}>>;
|
|
30494
30846
|
/**
|
|
30495
|
-
* @description Gets a chat's information.
|
|
30847
|
+
* @description Gets a chat's information. **Required scopes:** Access is determined by chat membership.
|
|
30496
30848
|
*
|
|
30497
30849
|
* @tags chats
|
|
30498
30850
|
* @name ChatsGetPost
|
|
@@ -30502,7 +30854,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
30502
30854
|
*/
|
|
30503
30855
|
chatsGetPost: (data: ChatsGetRequest, params?: RequestParams) => Promise<AxiosResponse<ChatsGetResponse, any, {}>>;
|
|
30504
30856
|
/**
|
|
30505
|
-
* @description Updates a chat's information.
|
|
30857
|
+
* @description Updates a chat's information. **Required scopes:** Access is determined by chat membership.
|
|
30506
30858
|
*
|
|
30507
30859
|
* @tags chats
|
|
30508
30860
|
* @name ChatsUpdate
|
|
@@ -30512,7 +30864,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
30512
30864
|
*/
|
|
30513
30865
|
chatsUpdate: (data: ChatsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<ChatsUpdateResponse, any, {}>>;
|
|
30514
30866
|
/**
|
|
30515
|
-
* @description Creates a code change object.
|
|
30867
|
+
* @description Creates a code change object. **Required scopes:** - `code_change:write` OR `code_change:all`
|
|
30516
30868
|
*
|
|
30517
30869
|
* @tags code-changes
|
|
30518
30870
|
* @name CodeChangesCreate
|
|
@@ -30522,7 +30874,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
30522
30874
|
*/
|
|
30523
30875
|
codeChangesCreate: (data: CodeChangesCreateRequest, params?: RequestParams) => Promise<AxiosResponse<CodeChangesCreateResponse, any, {}>>;
|
|
30524
30876
|
/**
|
|
30525
|
-
* @description Deletes a code change object.
|
|
30877
|
+
* @description Deletes a code change object. **Required scopes:** - `code_change:all`
|
|
30526
30878
|
*
|
|
30527
30879
|
* @tags code-changes
|
|
30528
30880
|
* @name CodeChangesDelete
|
|
@@ -30532,7 +30884,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
30532
30884
|
*/
|
|
30533
30885
|
codeChangesDelete: (data: CodeChangesDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
|
|
30534
30886
|
/**
|
|
30535
|
-
* @description Gets a code change object.
|
|
30887
|
+
* @description Gets a code change object. **Required scopes:** - `code_change:read` OR `code_change:write` OR `code_change:all`
|
|
30536
30888
|
*
|
|
30537
30889
|
* @tags code-changes
|
|
30538
30890
|
* @name CodeChangesGet
|
|
@@ -30548,7 +30900,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
30548
30900
|
id: string;
|
|
30549
30901
|
}, params?: RequestParams) => Promise<AxiosResponse<CodeChangesGetResponse, any, {}>>;
|
|
30550
30902
|
/**
|
|
30551
|
-
* @description Gets a code change object.
|
|
30903
|
+
* @description Gets a code change object. **Required scopes:** - `code_change:read` OR `code_change:write` OR `code_change:all`
|
|
30552
30904
|
*
|
|
30553
30905
|
* @tags code-changes
|
|
30554
30906
|
* @name CodeChangesGetPost
|
|
@@ -30558,7 +30910,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
30558
30910
|
*/
|
|
30559
30911
|
codeChangesGetPost: (data: CodeChangesGetRequest, params?: RequestParams) => Promise<AxiosResponse<CodeChangesGetResponse, any, {}>>;
|
|
30560
30912
|
/**
|
|
30561
|
-
* @description Lists code change objects.
|
|
30913
|
+
* @description Lists code change objects. **Required scopes:** - `code_change:read` OR `code_change:write` OR `code_change:all`
|
|
30562
30914
|
*
|
|
30563
30915
|
* @tags code-changes
|
|
30564
30916
|
* @name CodeChangesList
|
|
@@ -30586,7 +30938,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
30586
30938
|
mode?: ListMode;
|
|
30587
30939
|
}, params?: RequestParams) => Promise<AxiosResponse<CodeChangesListResponse, any, {}>>;
|
|
30588
30940
|
/**
|
|
30589
|
-
* @description Lists code change objects.
|
|
30941
|
+
* @description Lists code change objects. **Required scopes:** - `code_change:read` OR `code_change:write` OR `code_change:all`
|
|
30590
30942
|
*
|
|
30591
30943
|
* @tags code-changes
|
|
30592
30944
|
* @name CodeChangesListPost
|
|
@@ -30596,7 +30948,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
30596
30948
|
*/
|
|
30597
30949
|
codeChangesListPost: (data: CodeChangesListRequest, params?: RequestParams) => Promise<AxiosResponse<CodeChangesListResponse, any, {}>>;
|
|
30598
30950
|
/**
|
|
30599
|
-
* @description Updates a code change object.
|
|
30951
|
+
* @description Updates a code change object. **Required scopes:** - `code_change:write` OR `code_change:all`
|
|
30600
30952
|
*
|
|
30601
30953
|
* @tags code-changes
|
|
30602
30954
|
* @name CodeChangesUpdate
|
|
@@ -30606,7 +30958,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
30606
30958
|
*/
|
|
30607
30959
|
codeChangesUpdate: (data: CodeChangesUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<CodeChangesUpdateResponse, any, {}>>;
|
|
30608
30960
|
/**
|
|
30609
|
-
* @description Creates a command.
|
|
30961
|
+
* @description Creates a command. **Required scopes:** - `command:write` OR `command:all`
|
|
30610
30962
|
*
|
|
30611
30963
|
* @tags commands
|
|
30612
30964
|
* @name CommandsCreate
|
|
@@ -30616,7 +30968,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
30616
30968
|
*/
|
|
30617
30969
|
commandsCreate: (data: CommandCreateRequest, params?: RequestParams) => Promise<AxiosResponse<CommandCreateResponse, any, {}>>;
|
|
30618
30970
|
/**
|
|
30619
|
-
* @description Gets a command.
|
|
30971
|
+
* @description Gets a command. **Required scopes:** - `command:read` OR `command:write` OR `command:all`
|
|
30620
30972
|
*
|
|
30621
30973
|
* @tags commands
|
|
30622
30974
|
* @name CommandsGet
|
|
@@ -30632,7 +30984,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
30632
30984
|
id: string;
|
|
30633
30985
|
}, params?: RequestParams) => Promise<AxiosResponse<CommandGetResponse, any, {}>>;
|
|
30634
30986
|
/**
|
|
30635
|
-
* @description Gets a command.
|
|
30987
|
+
* @description Gets a command. **Required scopes:** - `command:read` OR `command:write` OR `command:all`
|
|
30636
30988
|
*
|
|
30637
30989
|
* @tags commands
|
|
30638
30990
|
* @name CommandsGetPost
|
|
@@ -30642,7 +30994,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
30642
30994
|
*/
|
|
30643
30995
|
commandsGetPost: (data: CommandGetRequest, params?: RequestParams) => Promise<AxiosResponse<CommandGetResponse, any, {}>>;
|
|
30644
30996
|
/**
|
|
30645
|
-
* @description Lists commands for a Dev organization.
|
|
30997
|
+
* @description Lists commands for a Dev organization. **Required scopes:** - `command:read` OR `command:write` OR `command:all`
|
|
30646
30998
|
*
|
|
30647
30999
|
* @tags commands
|
|
30648
31000
|
* @name CommandsList
|
|
@@ -30683,7 +31035,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
30683
31035
|
status?: CommandStatus[];
|
|
30684
31036
|
}, params?: RequestParams) => Promise<AxiosResponse<CommandsListResponse, any, {}>>;
|
|
30685
31037
|
/**
|
|
30686
|
-
* @description Lists commands for a Dev organization.
|
|
31038
|
+
* @description Lists commands for a Dev organization. **Required scopes:** - `command:read` OR `command:write` OR `command:all`
|
|
30687
31039
|
*
|
|
30688
31040
|
* @tags commands
|
|
30689
31041
|
* @name CommandsListPost
|
|
@@ -30693,7 +31045,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
30693
31045
|
*/
|
|
30694
31046
|
commandsListPost: (data: CommandsListRequest, params?: RequestParams) => Promise<AxiosResponse<CommandsListResponse, any, {}>>;
|
|
30695
31047
|
/**
|
|
30696
|
-
* @description Updates a command.
|
|
31048
|
+
* @description Updates a command. **Required scopes:** - `command:write` OR `command:all`
|
|
30697
31049
|
*
|
|
30698
31050
|
* @tags commands
|
|
30699
31051
|
* @name CommandsUpdate
|
|
@@ -30801,7 +31153,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
30801
31153
|
*/
|
|
30802
31154
|
conversationsConvert: (data: ConversationsConvertRequest, params?: RequestParams) => Promise<AxiosResponse<ConversationsConvertResponse, any, {}>>;
|
|
30803
31155
|
/**
|
|
30804
|
-
* @description Creates a conversation.
|
|
31156
|
+
* @description Creates a conversation. **Required scopes:** - `conversation:write` OR `conversation:all`
|
|
30805
31157
|
*
|
|
30806
31158
|
* @tags conversations
|
|
30807
31159
|
* @name ConversationsCreate
|
|
@@ -30811,7 +31163,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
30811
31163
|
*/
|
|
30812
31164
|
conversationsCreate: (data: ConversationsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<ConversationsCreateResponse, any, {}>>;
|
|
30813
31165
|
/**
|
|
30814
|
-
* @description Deletes the requested conversation.
|
|
31166
|
+
* @description Deletes the requested conversation. **Required scopes:** - `conversation:all`
|
|
30815
31167
|
*
|
|
30816
31168
|
* @tags conversations
|
|
30817
31169
|
* @name ConversationsDelete
|
|
@@ -30836,6 +31188,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
30836
31188
|
* @example ["ACC-12345"]
|
|
30837
31189
|
*/
|
|
30838
31190
|
account?: string[];
|
|
31191
|
+
/**
|
|
31192
|
+
* Filters for conversations with any of the provided AI resolution
|
|
31193
|
+
* statuses.
|
|
31194
|
+
*/
|
|
31195
|
+
ai_resolution_status?: number[];
|
|
30839
31196
|
/**
|
|
30840
31197
|
* Filters for conversations belonging to any of the provided parts.
|
|
30841
31198
|
* @example ["PROD-12345"]
|
|
@@ -30954,7 +31311,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
30954
31311
|
*/
|
|
30955
31312
|
conversationsExportPost: (data: ConversationsExportRequest, params?: RequestParams) => Promise<AxiosResponse<ConversationsExportResponse, any, {}>>;
|
|
30956
31313
|
/**
|
|
30957
|
-
* @description Gets the requested conversation's information.
|
|
31314
|
+
* @description Gets the requested conversation's information. **Required scopes:** - `conversation:read` OR `conversation:write` OR `conversation:all`
|
|
30958
31315
|
*
|
|
30959
31316
|
* @tags conversations
|
|
30960
31317
|
* @name ConversationsGet
|
|
@@ -30970,7 +31327,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
30970
31327
|
id: string;
|
|
30971
31328
|
}, params?: RequestParams) => Promise<AxiosResponse<ConversationsGetResponse, any, {}>>;
|
|
30972
31329
|
/**
|
|
30973
|
-
* @description Gets the requested conversation's information.
|
|
31330
|
+
* @description Gets the requested conversation's information. **Required scopes:** - `conversation:read` OR `conversation:write` OR `conversation:all`
|
|
30974
31331
|
*
|
|
30975
31332
|
* @tags conversations
|
|
30976
31333
|
* @name ConversationsGetPost
|
|
@@ -30980,7 +31337,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
30980
31337
|
*/
|
|
30981
31338
|
conversationsGetPost: (data: ConversationsGetRequest, params?: RequestParams) => Promise<AxiosResponse<ConversationsGetResponse, any, {}>>;
|
|
30982
31339
|
/**
|
|
30983
|
-
* @description Lists the available conversations.
|
|
31340
|
+
* @description Lists the available conversations. **Required scopes:** - `conversation:read` OR `conversation:write` OR `conversation:all`
|
|
30984
31341
|
*
|
|
30985
31342
|
* @tags conversations
|
|
30986
31343
|
* @name ConversationsList
|
|
@@ -30995,6 +31352,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
30995
31352
|
* @example ["ACC-12345"]
|
|
30996
31353
|
*/
|
|
30997
31354
|
account?: string[];
|
|
31355
|
+
/**
|
|
31356
|
+
* Filters for conversations with any of the provided AI resolution
|
|
31357
|
+
* statuses.
|
|
31358
|
+
*/
|
|
31359
|
+
ai_resolution_status?: number[];
|
|
30998
31360
|
/**
|
|
30999
31361
|
* Filters for conversations belonging to any of the provided parts.
|
|
31000
31362
|
* @example ["PROD-12345"]
|
|
@@ -31115,7 +31477,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
31115
31477
|
'tags_v2.value'?: string;
|
|
31116
31478
|
}, params?: RequestParams) => Promise<AxiosResponse<ConversationsListResponse, any, {}>>;
|
|
31117
31479
|
/**
|
|
31118
|
-
* @description Lists the available conversations.
|
|
31480
|
+
* @description Lists the available conversations. **Required scopes:** - `conversation:read` OR `conversation:write` OR `conversation:all`
|
|
31119
31481
|
*
|
|
31120
31482
|
* @tags conversations
|
|
31121
31483
|
* @name ConversationsListPost
|
|
@@ -31125,7 +31487,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
31125
31487
|
*/
|
|
31126
31488
|
conversationsListPost: (data: ConversationsListRequest, params?: RequestParams) => Promise<AxiosResponse<ConversationsListResponse, any, {}>>;
|
|
31127
31489
|
/**
|
|
31128
|
-
* @description Updates the requested conversation.
|
|
31490
|
+
* @description Updates the requested conversation. **Required scopes:** - `conversation:write` OR `conversation:all`
|
|
31129
31491
|
*
|
|
31130
31492
|
* @tags conversations
|
|
31131
31493
|
* @name ConversationsUpdate
|
|
@@ -31135,7 +31497,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
31135
31497
|
*/
|
|
31136
31498
|
conversationsUpdate: (data: ConversationsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<ConversationsUpdateResponse, any, {}>>;
|
|
31137
31499
|
/**
|
|
31138
|
-
* @description Counts custom objects.
|
|
31500
|
+
* @description Counts custom objects. **Required scopes:** No scopes required.
|
|
31139
31501
|
*
|
|
31140
31502
|
* @tags customization
|
|
31141
31503
|
* @name CustomObjectsCount
|
|
@@ -31154,7 +31516,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
31154
31516
|
filters?: any[];
|
|
31155
31517
|
}, params?: RequestParams) => Promise<AxiosResponse<CustomObjectsCountResponse, any, {}>>;
|
|
31156
31518
|
/**
|
|
31157
|
-
* @description Counts custom objects.
|
|
31519
|
+
* @description Counts custom objects. **Required scopes:** No scopes required.
|
|
31158
31520
|
*
|
|
31159
31521
|
* @tags customization
|
|
31160
31522
|
* @name CustomObjectsCountPost
|
|
@@ -31165,7 +31527,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
31165
31527
|
*/
|
|
31166
31528
|
customObjectsCountPost: (data: CustomObjectsCountRequest, params?: RequestParams) => Promise<AxiosResponse<CustomObjectsCountResponse, any, {}>>;
|
|
31167
31529
|
/**
|
|
31168
|
-
* @description Creates a custom object.
|
|
31530
|
+
* @description Creates a custom object. **Required scopes:** - `custom_type_fragment:write`
|
|
31169
31531
|
*
|
|
31170
31532
|
* @tags customization
|
|
31171
31533
|
* @name CustomObjectsCreate
|
|
@@ -31175,7 +31537,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
31175
31537
|
*/
|
|
31176
31538
|
customObjectsCreate: (data: CustomObjectsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<CustomObjectsCreateResponse, any, {}>>;
|
|
31177
31539
|
/**
|
|
31178
|
-
* @description Deletes a custom object.
|
|
31540
|
+
* @description Deletes a custom object. **Required scopes:** - `custom_type_fragment:write`
|
|
31179
31541
|
*
|
|
31180
31542
|
* @tags customization
|
|
31181
31543
|
* @name CustomObjectsDelete
|
|
@@ -31185,7 +31547,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
31185
31547
|
*/
|
|
31186
31548
|
customObjectsDelete: (data: CustomObjectsDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
|
|
31187
31549
|
/**
|
|
31188
|
-
* @description Gets a custom object.
|
|
31550
|
+
* @description Gets a custom object. **Required scopes:** No scopes required.
|
|
31189
31551
|
*
|
|
31190
31552
|
* @tags customization
|
|
31191
31553
|
* @name CustomObjectsGet
|
|
@@ -31201,7 +31563,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
31201
31563
|
id?: string;
|
|
31202
31564
|
}, params?: RequestParams) => Promise<AxiosResponse<CustomObjectsGetResponse, any, {}>>;
|
|
31203
31565
|
/**
|
|
31204
|
-
* @description Gets a custom object.
|
|
31566
|
+
* @description Gets a custom object. **Required scopes:** No scopes required.
|
|
31205
31567
|
*
|
|
31206
31568
|
* @tags customization
|
|
31207
31569
|
* @name CustomObjectsGetPost
|
|
@@ -31211,7 +31573,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
31211
31573
|
*/
|
|
31212
31574
|
customObjectsGetPost: (data: CustomObjectsGetRequest, params?: RequestParams) => Promise<AxiosResponse<CustomObjectsGetResponse, any, {}>>;
|
|
31213
31575
|
/**
|
|
31214
|
-
* @description Lists custom objects.
|
|
31576
|
+
* @description Lists custom objects. **Required scopes:** No scopes required.
|
|
31215
31577
|
*
|
|
31216
31578
|
* @tags customization
|
|
31217
31579
|
* @name CustomObjectsList
|
|
@@ -31247,7 +31609,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
31247
31609
|
sort_by?: string[];
|
|
31248
31610
|
}, params?: RequestParams) => Promise<AxiosResponse<CustomObjectsListResponse, any, {}>>;
|
|
31249
31611
|
/**
|
|
31250
|
-
* @description Lists custom objects.
|
|
31612
|
+
* @description Lists custom objects. **Required scopes:** No scopes required.
|
|
31251
31613
|
*
|
|
31252
31614
|
* @tags customization
|
|
31253
31615
|
* @name CustomObjectsListPost
|
|
@@ -31258,7 +31620,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
31258
31620
|
*/
|
|
31259
31621
|
customObjectsListPost: (data: CustomObjectsListRequest, params?: RequestParams) => Promise<AxiosResponse<CustomObjectsListResponse, any, {}>>;
|
|
31260
31622
|
/**
|
|
31261
|
-
* @description Updates a custom object.
|
|
31623
|
+
* @description Updates a custom object. **Required scopes:** - `custom_type_fragment:write`
|
|
31262
31624
|
*
|
|
31263
31625
|
* @tags customization
|
|
31264
31626
|
* @name CustomObjectsUpdate
|
|
@@ -31268,7 +31630,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
31268
31630
|
*/
|
|
31269
31631
|
customObjectsUpdate: (data: CustomObjectsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<CustomObjectsUpdateResponse, any, {}>>;
|
|
31270
31632
|
/**
|
|
31271
|
-
* @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:**
|
|
31633
|
+
* @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.
|
|
31272
31634
|
*
|
|
31273
31635
|
* @tags auth-connections, dev-orgs
|
|
31274
31636
|
* @name DevOrgAuthConnectionsCreate
|
|
@@ -31278,7 +31640,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
31278
31640
|
*/
|
|
31279
31641
|
devOrgAuthConnectionsCreate: (data: DevOrgAuthConnectionsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<DevOrgAuthConnectionsCreateResponse, any, {}>>;
|
|
31280
31642
|
/**
|
|
31281
|
-
* @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:**
|
|
31643
|
+
* @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.
|
|
31282
31644
|
*
|
|
31283
31645
|
* @tags auth-connections, dev-orgs
|
|
31284
31646
|
* @name DevOrgAuthConnectionsDelete
|
|
@@ -31288,7 +31650,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
31288
31650
|
*/
|
|
31289
31651
|
devOrgAuthConnectionsDelete: (data: DevOrgAuthConnectionsDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
|
|
31290
31652
|
/**
|
|
31291
|
-
* @description Retrieves the details for an authentication connection. **Required scopes:** - `
|
|
31653
|
+
* @description Retrieves the details for an authentication connection. **Required scopes:** - `Cannot be called via service account.`
|
|
31292
31654
|
*
|
|
31293
31655
|
* @tags auth-connections, dev-orgs
|
|
31294
31656
|
* @name DevOrgAuthConnectionsGet
|
|
@@ -31304,7 +31666,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
31304
31666
|
id: string;
|
|
31305
31667
|
}, params?: RequestParams) => Promise<AxiosResponse<DevOrgAuthConnectionsGetResponse, any, {}>>;
|
|
31306
31668
|
/**
|
|
31307
|
-
* @description Retrieves the details for an authentication connection. **Required scopes:** - `
|
|
31669
|
+
* @description Retrieves the details for an authentication connection. **Required scopes:** - `Cannot be called via service account.`
|
|
31308
31670
|
*
|
|
31309
31671
|
* @tags auth-connections, dev-orgs
|
|
31310
31672
|
* @name DevOrgAuthConnectionsGetPost
|
|
@@ -31314,7 +31676,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
31314
31676
|
*/
|
|
31315
31677
|
devOrgAuthConnectionsGetPost: (data: DevOrgAuthConnectionsGetRequest, params?: RequestParams) => Promise<AxiosResponse<DevOrgAuthConnectionsGetResponse, any, {}>>;
|
|
31316
31678
|
/**
|
|
31317
|
-
* @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:**
|
|
31679
|
+
* @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.
|
|
31318
31680
|
*
|
|
31319
31681
|
* @tags auth-connections, dev-orgs
|
|
31320
31682
|
* @name DevOrgAuthConnectionsList
|
|
@@ -31324,7 +31686,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
31324
31686
|
*/
|
|
31325
31687
|
devOrgAuthConnectionsList: (params?: RequestParams) => Promise<AxiosResponse<DevOrgAuthConnectionsListResponse, any, {}>>;
|
|
31326
31688
|
/**
|
|
31327
|
-
* @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:**
|
|
31689
|
+
* @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.
|
|
31328
31690
|
*
|
|
31329
31691
|
* @tags auth-connections, dev-orgs
|
|
31330
31692
|
* @name DevOrgAuthConnectionsListPost
|
|
@@ -31334,7 +31696,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
31334
31696
|
*/
|
|
31335
31697
|
devOrgAuthConnectionsListPost: (data: Empty, params?: RequestParams) => Promise<AxiosResponse<DevOrgAuthConnectionsListResponse, any, {}>>;
|
|
31336
31698
|
/**
|
|
31337
|
-
* @description Enable or disable an authentication connection for a Dev organization. Atleast one authentication connection must be enabled for a Dev organization. **Required scopes:**
|
|
31699
|
+
* @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.
|
|
31338
31700
|
*
|
|
31339
31701
|
* @tags auth-connections, dev-orgs
|
|
31340
31702
|
* @name DevOrgAuthConnectionsToggle
|
|
@@ -31344,7 +31706,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
31344
31706
|
*/
|
|
31345
31707
|
devOrgAuthConnectionsToggle: (data: DevOrgAuthConnectionsToggleRequest, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
|
|
31346
31708
|
/**
|
|
31347
|
-
* @description Updates an authentication connection. **Required scopes:**
|
|
31709
|
+
* @description Updates an authentication connection. **Required scopes:** Cannot be called via service account.
|
|
31348
31710
|
*
|
|
31349
31711
|
* @tags auth-connections, dev-orgs
|
|
31350
31712
|
* @name DevOrgAuthConnectionsUpdate
|
|
@@ -31354,7 +31716,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
31354
31716
|
*/
|
|
31355
31717
|
devOrgAuthConnectionsUpdate: (data: DevOrgAuthConnectionsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<DevOrgAuthConnectionsUpdateResponse, any, {}>>;
|
|
31356
31718
|
/**
|
|
31357
|
-
* @description Gets the Dev organization's information of the authenticated user. **Required scopes:** - `dev_org:read`
|
|
31719
|
+
* @description Gets the Dev organization's information of the authenticated user. **Required scopes:** - `dev_org:read` OR `dev_org:write`
|
|
31358
31720
|
*
|
|
31359
31721
|
* @tags dev-orgs
|
|
31360
31722
|
* @name DevOrgsGet
|
|
@@ -31364,7 +31726,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
31364
31726
|
*/
|
|
31365
31727
|
devOrgsGet: (params?: RequestParams) => Promise<AxiosResponse<DevOrgsGetResponse, any, {}>>;
|
|
31366
31728
|
/**
|
|
31367
|
-
* @description Gets the Dev organization's information of the authenticated user. **Required scopes:** - `dev_org:read`
|
|
31729
|
+
* @description Gets the Dev organization's information of the authenticated user. **Required scopes:** - `dev_org:read` OR `dev_org:write`
|
|
31368
31730
|
*
|
|
31369
31731
|
* @tags dev-orgs
|
|
31370
31732
|
* @name DevOrgsGetPost
|
|
@@ -31374,7 +31736,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
31374
31736
|
*/
|
|
31375
31737
|
devOrgsGetPost: (data: DevOrgsGetRequest, params?: RequestParams) => Promise<AxiosResponse<DevOrgsGetResponse, any, {}>>;
|
|
31376
31738
|
/**
|
|
31377
|
-
* @description Activates the requested user. **Required scopes:** - `dev_user:write`
|
|
31739
|
+
* @description Activates the requested user. **Required scopes:** - `dev_user:write` OR `dev_user:all`
|
|
31378
31740
|
*
|
|
31379
31741
|
* @tags dev-users
|
|
31380
31742
|
* @name DevUsersActivate
|
|
@@ -31384,7 +31746,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
31384
31746
|
*/
|
|
31385
31747
|
devUsersActivate: (data: DevUsersActivateRequest, params?: RequestParams) => Promise<AxiosResponse<DevUsersActivateResponse, any, {}>>;
|
|
31386
31748
|
/**
|
|
31387
|
-
* @description Creates a Dev user for a Dev organization. **Required scopes:** - `dev_user:write`
|
|
31749
|
+
* @description Creates a Dev user for a Dev organization. **Required scopes:** - `dev_user:write` OR `dev_user:all`
|
|
31388
31750
|
*
|
|
31389
31751
|
* @tags dev-users
|
|
31390
31752
|
* @name DevUsersCreate
|
|
@@ -31404,7 +31766,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
31404
31766
|
*/
|
|
31405
31767
|
devUsersDeactivate: (data: DevUsersDeactivateRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
|
|
31406
31768
|
/**
|
|
31407
|
-
* @description Gets the requested user's information. **Required scopes:** - `dev_user:read`
|
|
31769
|
+
* @description Gets the requested user's information. **Required scopes:** - `dev_user:read` OR `dev_user:write` OR `dev_user:all`
|
|
31408
31770
|
*
|
|
31409
31771
|
* @tags dev-users
|
|
31410
31772
|
* @name DevUsersGet
|
|
@@ -31420,7 +31782,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
31420
31782
|
id: string;
|
|
31421
31783
|
}, params?: RequestParams) => Promise<AxiosResponse<DevUsersGetResponse, any, {}>>;
|
|
31422
31784
|
/**
|
|
31423
|
-
* @description Gets the requested user's information. **Required scopes:** - `dev_user:read`
|
|
31785
|
+
* @description Gets the requested user's information. **Required scopes:** - `dev_user:read` OR `dev_user:write` OR `dev_user:all`
|
|
31424
31786
|
*
|
|
31425
31787
|
* @tags dev-users
|
|
31426
31788
|
* @name DevUsersGetPost
|
|
@@ -31430,7 +31792,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
31430
31792
|
*/
|
|
31431
31793
|
devUsersGetPost: (data: DevUsersGetRequest, params?: RequestParams) => Promise<AxiosResponse<DevUsersGetResponse, any, {}>>;
|
|
31432
31794
|
/**
|
|
31433
|
-
* @description Links an external/secondary identity to the Dev user. **Required scopes:** - `dev_user:write`
|
|
31795
|
+
* @description Links an external/secondary identity to the Dev user. **Required scopes:** - `dev_user:write` OR `dev_user:all`
|
|
31434
31796
|
*
|
|
31435
31797
|
* @tags dev-users
|
|
31436
31798
|
* @name DevUsersIdentitiesLink
|
|
@@ -31440,7 +31802,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
31440
31802
|
*/
|
|
31441
31803
|
devUsersIdentitiesLink: (data: DevUsersIdentitiesLinkRequest, params?: RequestParams) => Promise<AxiosResponse<DevUsersIdentitiesLinkResponse, any, {}>>;
|
|
31442
31804
|
/**
|
|
31443
|
-
* @description Unlinks an external/secondary identity from the Dev user. **Required scopes:** - `dev_user:write`
|
|
31805
|
+
* @description Unlinks an external/secondary identity from the Dev user. **Required scopes:** - `dev_user:write` OR `dev_user:all`
|
|
31444
31806
|
*
|
|
31445
31807
|
* @tags dev-users
|
|
31446
31808
|
* @name DevUsersIdentitiesUnlink
|
|
@@ -31450,7 +31812,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
31450
31812
|
*/
|
|
31451
31813
|
devUsersIdentitiesUnlink: (data: DevUsersIdentitiesUnlinkRequest, params?: RequestParams) => Promise<AxiosResponse<DevUsersIdentitiesUnlinkResponse, any, {}>>;
|
|
31452
31814
|
/**
|
|
31453
|
-
* @description Lists users within your organization. **Required scopes:** - `dev_user:read`
|
|
31815
|
+
* @description Lists users within your organization. **Required scopes:** - `dev_user:read` OR `dev_user:write` OR `dev_user:all`
|
|
31454
31816
|
*
|
|
31455
31817
|
* @tags dev-users
|
|
31456
31818
|
* @name DevUsersList
|
|
@@ -31504,7 +31866,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
31504
31866
|
timezone?: string[];
|
|
31505
31867
|
}, params?: RequestParams) => Promise<AxiosResponse<DevUsersListResponse, any, {}>>;
|
|
31506
31868
|
/**
|
|
31507
|
-
* @description Lists users within your organization. **Required scopes:** - `dev_user:read`
|
|
31869
|
+
* @description Lists users within your organization. **Required scopes:** - `dev_user:read` OR `dev_user:write` OR `dev_user:all`
|
|
31508
31870
|
*
|
|
31509
31871
|
* @tags dev-users
|
|
31510
31872
|
* @name DevUsersListPost
|
|
@@ -31524,7 +31886,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
31524
31886
|
*/
|
|
31525
31887
|
devUsersMerge: (data: DevUsersMergeRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
|
|
31526
31888
|
/**
|
|
31527
|
-
* @description Gets the authenticated user's information. **Required scopes:**
|
|
31889
|
+
* @description Gets the authenticated user's information. **Required scopes:** Default Scopes unavailable for this API
|
|
31528
31890
|
*
|
|
31529
31891
|
* @tags dev-users
|
|
31530
31892
|
* @name DevUsersSelf
|
|
@@ -31534,7 +31896,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
31534
31896
|
*/
|
|
31535
31897
|
devUsersSelf: (params?: RequestParams) => Promise<AxiosResponse<DevUsersSelfResponse, any, {}>>;
|
|
31536
31898
|
/**
|
|
31537
|
-
* @description Gets the authenticated user's information. **Required scopes:**
|
|
31899
|
+
* @description Gets the authenticated user's information. **Required scopes:** Default Scopes unavailable for this API
|
|
31538
31900
|
*
|
|
31539
31901
|
* @tags dev-users
|
|
31540
31902
|
* @name DevUsersSelfPost
|
|
@@ -31544,7 +31906,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
31544
31906
|
*/
|
|
31545
31907
|
devUsersSelfPost: (data: DevUsersSelfRequest, params?: RequestParams) => Promise<AxiosResponse<DevUsersSelfResponse, any, {}>>;
|
|
31546
31908
|
/**
|
|
31547
|
-
* @description Updates the authenticated user. **Required scopes:**
|
|
31909
|
+
* @description Updates the authenticated user. **Required scopes:** Default Scopes unavailable for this API
|
|
31548
31910
|
*
|
|
31549
31911
|
* @tags dev-users
|
|
31550
31912
|
* @name DevUsersSelfUpdate
|
|
@@ -31554,7 +31916,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
31554
31916
|
*/
|
|
31555
31917
|
devUsersSelfUpdate: (data: DevUsersSelfUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<DevUsersUpdateResponse, any, {}>>;
|
|
31556
31918
|
/**
|
|
31557
|
-
* @description Updates the user corresponding to the input Id. **Required scopes:** - `dev_user:write`
|
|
31919
|
+
* @description Updates the user corresponding to the input Id. **Required scopes:** - `dev_user:write` OR `dev_user:all`
|
|
31558
31920
|
*
|
|
31559
31921
|
* @tags dev-users
|
|
31560
31922
|
* @name DevUsersUpdate
|
|
@@ -31564,7 +31926,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
31564
31926
|
*/
|
|
31565
31927
|
devUsersUpdate: (data: DevUsersUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<DevUsersUpdateResponse, any, {}>>;
|
|
31566
31928
|
/**
|
|
31567
|
-
* @description Get count of directories matching given filter.
|
|
31929
|
+
* @description Get count of directories matching given filter. **Required scopes:** - `directory:read` OR `directory:write` OR `directory:all`
|
|
31568
31930
|
*
|
|
31569
31931
|
* @tags directory
|
|
31570
31932
|
* @name DirectoriesCount
|
|
@@ -31585,7 +31947,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
31585
31947
|
modified_by?: string[];
|
|
31586
31948
|
}, params?: RequestParams) => Promise<AxiosResponse<DirectoriesCountResponse, any, {}>>;
|
|
31587
31949
|
/**
|
|
31588
|
-
* @description Get count of directories matching given filter.
|
|
31950
|
+
* @description Get count of directories matching given filter. **Required scopes:** - `directory:read` OR `directory:write` OR `directory:all`
|
|
31589
31951
|
*
|
|
31590
31952
|
* @tags directory
|
|
31591
31953
|
* @name DirectoriesCountPost
|
|
@@ -31595,7 +31957,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
31595
31957
|
*/
|
|
31596
31958
|
directoriesCountPost: (data: DirectoriesCountRequest, params?: RequestParams) => Promise<AxiosResponse<DirectoriesCountResponse, any, {}>>;
|
|
31597
31959
|
/**
|
|
31598
|
-
* @description Creates a directory for the specified inputs.
|
|
31960
|
+
* @description Creates a directory for the specified inputs. **Required scopes:** - `directory:write` OR `directory:all`
|
|
31599
31961
|
*
|
|
31600
31962
|
* @tags directory
|
|
31601
31963
|
* @name DirectoriesCreate
|
|
@@ -31605,7 +31967,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
31605
31967
|
*/
|
|
31606
31968
|
directoriesCreate: (data: DirectoriesCreateRequest, params?: RequestParams) => Promise<AxiosResponse<DirectoriesCreateResponse, any, {}>>;
|
|
31607
31969
|
/**
|
|
31608
|
-
* @description Delete the specified directory.
|
|
31970
|
+
* @description Delete the specified directory. **Required scopes:** - `directory:all`
|
|
31609
31971
|
*
|
|
31610
31972
|
* @tags directory
|
|
31611
31973
|
* @name DirectoriesDelete
|
|
@@ -31615,7 +31977,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
31615
31977
|
*/
|
|
31616
31978
|
directoriesDelete: (data: DirectoriesDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
|
|
31617
31979
|
/**
|
|
31618
|
-
* @description Gets the specified directory.
|
|
31980
|
+
* @description Gets the specified directory. **Required scopes:** - `directory:read` OR `directory:write` OR `directory:all`
|
|
31619
31981
|
*
|
|
31620
31982
|
* @tags directory
|
|
31621
31983
|
* @name DirectoriesGet
|
|
@@ -31631,7 +31993,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
31631
31993
|
id?: string;
|
|
31632
31994
|
}, params?: RequestParams) => Promise<AxiosResponse<DirectoriesGetResponse, any, {}>>;
|
|
31633
31995
|
/**
|
|
31634
|
-
* @description Gets the specified directory.
|
|
31996
|
+
* @description Gets the specified directory. **Required scopes:** - `directory:read` OR `directory:write` OR `directory:all`
|
|
31635
31997
|
*
|
|
31636
31998
|
* @tags directory
|
|
31637
31999
|
* @name DirectoriesGetPost
|
|
@@ -31641,7 +32003,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
31641
32003
|
*/
|
|
31642
32004
|
directoriesGetPost: (data: DirectoriesGetRequest, params?: RequestParams) => Promise<AxiosResponse<DirectoriesGetResponse, any, {}>>;
|
|
31643
32005
|
/**
|
|
31644
|
-
* @description Lists directories matching the request.
|
|
32006
|
+
* @description Lists directories matching the request. **Required scopes:** - `directory:read` OR `directory:write` OR `directory:all`
|
|
31645
32007
|
*
|
|
31646
32008
|
* @tags directory
|
|
31647
32009
|
* @name DirectoriesList
|
|
@@ -31678,7 +32040,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
31678
32040
|
modified_by?: string[];
|
|
31679
32041
|
}, params?: RequestParams) => Promise<AxiosResponse<DirectoriesListResponse, any, {}>>;
|
|
31680
32042
|
/**
|
|
31681
|
-
* @description Lists directories matching the request.
|
|
32043
|
+
* @description Lists directories matching the request. **Required scopes:** - `directory:read` OR `directory:write` OR `directory:all`
|
|
31682
32044
|
*
|
|
31683
32045
|
* @tags directory
|
|
31684
32046
|
* @name DirectoriesListPost
|
|
@@ -31688,7 +32050,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
31688
32050
|
*/
|
|
31689
32051
|
directoriesListPost: (data: DirectoriesListRequest, params?: RequestParams) => Promise<AxiosResponse<DirectoriesListResponse, any, {}>>;
|
|
31690
32052
|
/**
|
|
31691
|
-
* @description Updates the specified directory.
|
|
32053
|
+
* @description Updates the specified directory. **Required scopes:** - `directory:write` OR `directory:all`
|
|
31692
32054
|
*
|
|
31693
32055
|
* @tags directory
|
|
31694
32056
|
* @name DirectoriesUpdate
|
|
@@ -31888,7 +32250,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
31888
32250
|
*/
|
|
31889
32251
|
eventSourcesDeleteScheduledEvent: (data: EventSourcesDeleteScheduledEventRequest, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
|
|
31890
32252
|
/**
|
|
31891
|
-
* @description Creates a new group. A group is a collection of users. **Required scopes:** - `group:write`
|
|
32253
|
+
* @description Creates a new group. A group is a collection of users. **Required scopes:** - `group:write` OR `group:all`
|
|
31892
32254
|
*
|
|
31893
32255
|
* @tags groups
|
|
31894
32256
|
* @name GroupsCreate
|
|
@@ -31898,7 +32260,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
31898
32260
|
*/
|
|
31899
32261
|
groupsCreate: (data: GroupsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<GroupsCreateResponse, any, {}>>;
|
|
31900
32262
|
/**
|
|
31901
|
-
* @description Gets the requested group. **Required scopes:** - `group:read`
|
|
32263
|
+
* @description Gets the requested group. **Required scopes:** - `group:read` OR `group:write` OR `group:all`
|
|
31902
32264
|
*
|
|
31903
32265
|
* @tags groups
|
|
31904
32266
|
* @name GroupsGet
|
|
@@ -31914,7 +32276,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
31914
32276
|
id: string;
|
|
31915
32277
|
}, params?: RequestParams) => Promise<AxiosResponse<GroupsGetResponse, any, {}>>;
|
|
31916
32278
|
/**
|
|
31917
|
-
* @description Gets the requested group. **Required scopes:** - `group:read`
|
|
32279
|
+
* @description Gets the requested group. **Required scopes:** - `group:read` OR `group:write` OR `group:all`
|
|
31918
32280
|
*
|
|
31919
32281
|
* @tags groups
|
|
31920
32282
|
* @name GroupsGetPost
|
|
@@ -31924,7 +32286,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
31924
32286
|
*/
|
|
31925
32287
|
groupsGetPost: (data: GroupsGetRequest, params?: RequestParams) => Promise<AxiosResponse<GroupsGetResponse, any, {}>>;
|
|
31926
32288
|
/**
|
|
31927
|
-
* @description Lists the available groups. **Required scopes:** - `group:read`
|
|
32289
|
+
* @description Lists the available groups. **Required scopes:** - `group:read` OR `group:write` OR `group:all`
|
|
31928
32290
|
*
|
|
31929
32291
|
* @tags groups
|
|
31930
32292
|
* @name GroupsList
|
|
@@ -31945,6 +32307,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
31945
32307
|
group_type?: GroupType[];
|
|
31946
32308
|
/** Filter groups by ingestion source(s). */
|
|
31947
32309
|
ingestion_source?: GroupIngestionSource[];
|
|
32310
|
+
/** Filters the groups on the basis of archival status. */
|
|
32311
|
+
is_archived?: boolean;
|
|
31948
32312
|
/** Whether to fetch default or custom groups. */
|
|
31949
32313
|
is_default?: boolean;
|
|
31950
32314
|
/**
|
|
@@ -31995,7 +32359,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
31995
32359
|
'sync_metadata.origin_system'?: string[];
|
|
31996
32360
|
}, params?: RequestParams) => Promise<AxiosResponse<GroupsListResponse, any, {}>>;
|
|
31997
32361
|
/**
|
|
31998
|
-
* @description Lists the available groups. **Required scopes:** - `group:read`
|
|
32362
|
+
* @description Lists the available groups. **Required scopes:** - `group:read` OR `group:write` OR `group:all`
|
|
31999
32363
|
*
|
|
32000
32364
|
* @tags groups
|
|
32001
32365
|
* @name GroupsListPost
|
|
@@ -32005,7 +32369,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
32005
32369
|
*/
|
|
32006
32370
|
groupsListPost: (data: GroupsListRequest, params?: RequestParams) => Promise<AxiosResponse<GroupsListResponse, any, {}>>;
|
|
32007
32371
|
/**
|
|
32008
|
-
* @description Adds a member to a group. **Required scopes:** - `group_membership:
|
|
32372
|
+
* @description Adds a member to a group. **Required scopes:** - `group_membership:all`
|
|
32009
32373
|
*
|
|
32010
32374
|
* @tags groups
|
|
32011
32375
|
* @name GroupMembersAdd
|
|
@@ -32041,7 +32405,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
32041
32405
|
*/
|
|
32042
32406
|
groupMembersCountPost: (data: GroupMembersCountRequest, params?: RequestParams) => Promise<AxiosResponse<GroupMembersCountResponse, any, {}>>;
|
|
32043
32407
|
/**
|
|
32044
|
-
* @description Lists the members in a group. **Required scopes:** - `group_membership:read`
|
|
32408
|
+
* @description Lists the members in a group. **Required scopes:** - `group_membership:read` OR `group_membership:all`
|
|
32045
32409
|
*
|
|
32046
32410
|
* @tags groups
|
|
32047
32411
|
* @name GroupMembersList
|
|
@@ -32076,7 +32440,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
32076
32440
|
sort_by?: string[];
|
|
32077
32441
|
}, params?: RequestParams) => Promise<AxiosResponse<GroupMembersListResponse, any, {}>>;
|
|
32078
32442
|
/**
|
|
32079
|
-
* @description Lists the members in a group. **Required scopes:** - `group_membership:read`
|
|
32443
|
+
* @description Lists the members in a group. **Required scopes:** - `group_membership:read` OR `group_membership:all`
|
|
32080
32444
|
*
|
|
32081
32445
|
* @tags groups
|
|
32082
32446
|
* @name GroupMembersListPost
|
|
@@ -32086,7 +32450,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
32086
32450
|
*/
|
|
32087
32451
|
groupMembersListPost: (data: GroupMembersListRequest, params?: RequestParams) => Promise<AxiosResponse<GroupMembersListResponse, any, {}>>;
|
|
32088
32452
|
/**
|
|
32089
|
-
* @description Removes a member from a group. **Required scopes:** - `group_membership:
|
|
32453
|
+
* @description Removes a member from a group. **Required scopes:** - `group_membership:all`
|
|
32090
32454
|
*
|
|
32091
32455
|
* @tags groups
|
|
32092
32456
|
* @name GroupMembersRemove
|
|
@@ -32096,7 +32460,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
32096
32460
|
*/
|
|
32097
32461
|
groupMembersRemove: (data: GroupMembersRemoveRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
|
|
32098
32462
|
/**
|
|
32099
|
-
* @description Updates the requested group. **Required scopes:** - `group:write`
|
|
32463
|
+
* @description Updates the requested group. **Required scopes:** - `group:write` OR `group:all`
|
|
32100
32464
|
*
|
|
32101
32465
|
* @tags groups
|
|
32102
32466
|
* @name GroupsUpdate
|
|
@@ -32398,7 +32762,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
32398
32762
|
*/
|
|
32399
32763
|
incidentsUpdate: (data: IncidentsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<IncidentsUpdateResponse, any, {}>>;
|
|
32400
32764
|
/**
|
|
32401
|
-
* @description Retrieves a job's information.
|
|
32765
|
+
* @description Retrieves a job's information. **Required scopes:** - `job:read`
|
|
32402
32766
|
*
|
|
32403
32767
|
* @tags jobs
|
|
32404
32768
|
* @name GetJob
|
|
@@ -32414,7 +32778,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
32414
32778
|
id: string;
|
|
32415
32779
|
}, params?: RequestParams) => Promise<AxiosResponse<JobsGetResponse, any, {}>>;
|
|
32416
32780
|
/**
|
|
32417
|
-
* @description Retrieves a job's information.
|
|
32781
|
+
* @description Retrieves a job's information. **Required scopes:** - `job:read`
|
|
32418
32782
|
*
|
|
32419
32783
|
* @tags jobs
|
|
32420
32784
|
* @name GetJobPost
|
|
@@ -32424,7 +32788,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
32424
32788
|
*/
|
|
32425
32789
|
getJobPost: (data: JobsGetRequest, params?: RequestParams) => Promise<AxiosResponse<JobsGetResponse, any, {}>>;
|
|
32426
32790
|
/**
|
|
32427
|
-
* @description Gets a list of jobs.
|
|
32791
|
+
* @description Gets a list of jobs. **Required scopes:** - `job:read`
|
|
32428
32792
|
*
|
|
32429
32793
|
* @tags jobs
|
|
32430
32794
|
* @name ListJobs
|
|
@@ -32463,7 +32827,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
32463
32827
|
state?: JobState[];
|
|
32464
32828
|
}, params?: RequestParams) => Promise<AxiosResponse<JobsListResponse, any, {}>>;
|
|
32465
32829
|
/**
|
|
32466
|
-
* @description Gets a list of jobs.
|
|
32830
|
+
* @description Gets a list of jobs. **Required scopes:** - `job:read`
|
|
32467
32831
|
*
|
|
32468
32832
|
* @tags jobs
|
|
32469
32833
|
* @name ListJobsPost
|
|
@@ -32473,7 +32837,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
32473
32837
|
*/
|
|
32474
32838
|
listJobsPost: (data: JobsListRequest, params?: RequestParams) => Promise<AxiosResponse<JobsListResponse, any, {}>>;
|
|
32475
32839
|
/**
|
|
32476
|
-
* @description OAuth2 authorization callback.
|
|
32840
|
+
* @description OAuth2 authorization callback. **Required scopes:** - `keyring:read`
|
|
32477
32841
|
*
|
|
32478
32842
|
* @tags keyrings
|
|
32479
32843
|
* @name KeyringsCreateCallback
|
|
@@ -32493,7 +32857,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
32493
32857
|
state: string;
|
|
32494
32858
|
}, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
|
|
32495
32859
|
/**
|
|
32496
|
-
* @description OAuth2 authorization callback.
|
|
32860
|
+
* @description OAuth2 authorization callback. **Required scopes:** - `keyring:read`
|
|
32497
32861
|
*
|
|
32498
32862
|
* @tags keyrings
|
|
32499
32863
|
* @name KeyringsCreateCallbackPost
|
|
@@ -32666,7 +33030,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
32666
33030
|
*/
|
|
32667
33031
|
customLinkTypeUpdate: (data: CustomLinkTypeUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<CustomLinkTypeUpdateResponse, any, {}>>;
|
|
32668
33032
|
/**
|
|
32669
|
-
* @description Creates a link between two objects to indicate a relationship.
|
|
33033
|
+
* @description Creates a link between two objects to indicate a relationship. **Required scopes:** - `link:write` OR `link:all` Also needs linked objects read access.
|
|
32670
33034
|
*
|
|
32671
33035
|
* @tags links
|
|
32672
33036
|
* @name LinksCreate
|
|
@@ -32676,7 +33040,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
32676
33040
|
*/
|
|
32677
33041
|
linksCreate: (data: LinksCreateRequest, params?: RequestParams) => Promise<AxiosResponse<LinksCreateResponse, any, {}>>;
|
|
32678
33042
|
/**
|
|
32679
|
-
* @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.
|
|
33043
|
+
* @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.
|
|
32680
33044
|
*
|
|
32681
33045
|
* @tags links
|
|
32682
33046
|
* @name LinksDelete
|
|
@@ -32686,7 +33050,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
32686
33050
|
*/
|
|
32687
33051
|
linksDelete: (data: LinksDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
|
|
32688
33052
|
/**
|
|
32689
|
-
* @description Gets the requested link's information.
|
|
33053
|
+
* @description Gets the requested link's information. **Required scopes:** - `link:read` OR `link:write` OR `link:all`
|
|
32690
33054
|
*
|
|
32691
33055
|
* @tags links
|
|
32692
33056
|
* @name LinksGet
|
|
@@ -32702,7 +33066,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
32702
33066
|
id: string;
|
|
32703
33067
|
}, params?: RequestParams) => Promise<AxiosResponse<LinksGetResponse, any, {}>>;
|
|
32704
33068
|
/**
|
|
32705
|
-
* @description Gets the requested link's information.
|
|
33069
|
+
* @description Gets the requested link's information. **Required scopes:** - `link:read` OR `link:write` OR `link:all`
|
|
32706
33070
|
*
|
|
32707
33071
|
* @tags links
|
|
32708
33072
|
* @name LinksGetPost
|
|
@@ -32712,7 +33076,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
32712
33076
|
*/
|
|
32713
33077
|
linksGetPost: (data: LinksGetRequest, params?: RequestParams) => Promise<AxiosResponse<LinksGetResponse, any, {}>>;
|
|
32714
33078
|
/**
|
|
32715
|
-
* @description Lists the available links.
|
|
33079
|
+
* @description Lists the available links. **Required scopes:** - `link:read` OR `link:write` OR `link:all`
|
|
32716
33080
|
*
|
|
32717
33081
|
* @tags links
|
|
32718
33082
|
* @name LinksList
|
|
@@ -32771,7 +33135,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
32771
33135
|
types?: LinkType[];
|
|
32772
33136
|
}, params?: RequestParams) => Promise<AxiosResponse<LinksListResponse, any, {}>>;
|
|
32773
33137
|
/**
|
|
32774
|
-
* @description Lists the available links.
|
|
33138
|
+
* @description Lists the available links. **Required scopes:** - `link:read` OR `link:write` OR `link:all`
|
|
32775
33139
|
*
|
|
32776
33140
|
* @tags links
|
|
32777
33141
|
* @name LinksListPost
|
|
@@ -32781,7 +33145,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
32781
33145
|
*/
|
|
32782
33146
|
linksListPost: (data: LinksListRequest, params?: RequestParams) => Promise<AxiosResponse<LinksListResponse, any, {}>>;
|
|
32783
33147
|
/**
|
|
32784
|
-
* @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.
|
|
33148
|
+
* @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.
|
|
32785
33149
|
*
|
|
32786
33150
|
* @tags links
|
|
32787
33151
|
* @name LinksReplace
|
|
@@ -32822,6 +33186,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
32822
33186
|
* @format id
|
|
32823
33187
|
*/
|
|
32824
33188
|
marketplace?: string;
|
|
33189
|
+
/** Filters on marketplace item IDs for marketplace item features. */
|
|
33190
|
+
marketplace_item?: string[];
|
|
32825
33191
|
/**
|
|
32826
33192
|
* The iteration mode to use, otherwise if not set, then "after" is
|
|
32827
33193
|
* used.
|
|
@@ -32859,7 +33225,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
32859
33225
|
*/
|
|
32860
33226
|
marketplaceItemsInstall: (data: MarketplaceItemsInstallRequest, params?: RequestParams) => Promise<AxiosResponse<MarketplaceItemsInstallResponse, any, {}>>;
|
|
32861
33227
|
/**
|
|
32862
|
-
* @description Counts the meeting records.
|
|
33228
|
+
* @description Counts the meeting records. **Required scopes:** - `meeting:read` OR `meeting:write` OR `meeting:all`
|
|
32863
33229
|
*
|
|
32864
33230
|
* @tags meetings
|
|
32865
33231
|
* @name MeetingsCount
|
|
@@ -32932,7 +33298,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
32932
33298
|
tags?: string[];
|
|
32933
33299
|
}, params?: RequestParams) => Promise<AxiosResponse<MeetingsCountResponse, any, {}>>;
|
|
32934
33300
|
/**
|
|
32935
|
-
* @description Counts the meeting records.
|
|
33301
|
+
* @description Counts the meeting records. **Required scopes:** - `meeting:read` OR `meeting:write` OR `meeting:all`
|
|
32936
33302
|
*
|
|
32937
33303
|
* @tags meetings
|
|
32938
33304
|
* @name MeetingsCountPost
|
|
@@ -32942,7 +33308,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
32942
33308
|
*/
|
|
32943
33309
|
meetingsCountPost: (data: MeetingsCountRequest, params?: RequestParams) => Promise<AxiosResponse<MeetingsCountResponse, any, {}>>;
|
|
32944
33310
|
/**
|
|
32945
|
-
* @description Creates a new meeting record.
|
|
33311
|
+
* @description Creates a new meeting record. **Required scopes:** - `meeting:write` OR `meeting:all`
|
|
32946
33312
|
*
|
|
32947
33313
|
* @tags meetings
|
|
32948
33314
|
* @name MeetingsCreate
|
|
@@ -32952,7 +33318,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
32952
33318
|
*/
|
|
32953
33319
|
meetingsCreate: (data: MeetingsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<MeetingsCreateResponse, any, {}>>;
|
|
32954
33320
|
/**
|
|
32955
|
-
* @description Deletes the meeting record.
|
|
33321
|
+
* @description Deletes the meeting record. **Required scopes:** - `meeting:all`
|
|
32956
33322
|
*
|
|
32957
33323
|
* @tags meetings
|
|
32958
33324
|
* @name MeetingsDelete
|
|
@@ -32972,7 +33338,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
32972
33338
|
*/
|
|
32973
33339
|
meetingsExportAsync: (data: MeetingsExportAsyncRequest, params?: RequestParams) => Promise<AxiosResponse<MeetingsExportAsyncResponse, any, {}>>;
|
|
32974
33340
|
/**
|
|
32975
|
-
* @description Gets the meeting record.
|
|
33341
|
+
* @description Gets the meeting record. **Required scopes:** - `meeting:read` OR `meeting:write` OR `meeting:all`
|
|
32976
33342
|
*
|
|
32977
33343
|
* @tags meetings
|
|
32978
33344
|
* @name MeetingsGet
|
|
@@ -32988,7 +33354,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
32988
33354
|
id: string;
|
|
32989
33355
|
}, params?: RequestParams) => Promise<AxiosResponse<MeetingsGetResponse, any, {}>>;
|
|
32990
33356
|
/**
|
|
32991
|
-
* @description Gets the meeting record.
|
|
33357
|
+
* @description Gets the meeting record. **Required scopes:** - `meeting:read` OR `meeting:write` OR `meeting:all`
|
|
32992
33358
|
*
|
|
32993
33359
|
* @tags meetings
|
|
32994
33360
|
* @name MeetingsGetPost
|
|
@@ -32998,7 +33364,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
32998
33364
|
*/
|
|
32999
33365
|
meetingsGetPost: (data: MeetingsGetRequest, params?: RequestParams) => Promise<AxiosResponse<MeetingsGetResponse, any, {}>>;
|
|
33000
33366
|
/**
|
|
33001
|
-
* @description Lists the meeting records.
|
|
33367
|
+
* @description Lists the meeting records. **Required scopes:** - `meeting:read` OR `meeting:write` OR `meeting:all`
|
|
33002
33368
|
*
|
|
33003
33369
|
* @tags meetings
|
|
33004
33370
|
* @name MeetingsList
|
|
@@ -33089,7 +33455,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
33089
33455
|
tags?: string[];
|
|
33090
33456
|
}, params?: RequestParams) => Promise<AxiosResponse<MeetingsListResponse, any, {}>>;
|
|
33091
33457
|
/**
|
|
33092
|
-
* @description Lists the meeting records.
|
|
33458
|
+
* @description Lists the meeting records. **Required scopes:** - `meeting:read` OR `meeting:write` OR `meeting:all`
|
|
33093
33459
|
*
|
|
33094
33460
|
* @tags meetings
|
|
33095
33461
|
* @name MeetingsListPost
|
|
@@ -33099,7 +33465,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
33099
33465
|
*/
|
|
33100
33466
|
meetingsListPost: (data: MeetingsListRequest, params?: RequestParams) => Promise<AxiosResponse<MeetingsListResponse, any, {}>>;
|
|
33101
33467
|
/**
|
|
33102
|
-
* @description Updates the meeting record.
|
|
33468
|
+
* @description Updates the meeting record. **Required scopes:** - `meeting:write` OR `meeting:all`
|
|
33103
33469
|
*
|
|
33104
33470
|
* @tags meetings
|
|
33105
33471
|
* @name MeetingsUpdate
|
|
@@ -33109,7 +33475,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
33109
33475
|
*/
|
|
33110
33476
|
meetingsUpdate: (data: MeetingsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<MeetingsUpdateResponse, any, {}>>;
|
|
33111
33477
|
/**
|
|
33112
|
-
* @description Executes the metric action on the given object.
|
|
33478
|
+
* @description Executes the metric action on the given object. **Required scopes:** No scopes required.
|
|
33113
33479
|
*
|
|
33114
33480
|
* @tags slas
|
|
33115
33481
|
* @name MetricActionExecute
|
|
@@ -33119,7 +33485,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
33119
33485
|
*/
|
|
33120
33486
|
metricActionExecute: (data: MetricActionExecuteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
|
|
33121
33487
|
/**
|
|
33122
|
-
* @description Creates a custom metric definition
|
|
33488
|
+
* @description Creates a custom metric definition **Required scopes:** - `metric_definition:write` OR `metric_definition:all`
|
|
33123
33489
|
*
|
|
33124
33490
|
* @tags slas
|
|
33125
33491
|
* @name MetricDefinitionsCreate
|
|
@@ -33129,7 +33495,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
33129
33495
|
*/
|
|
33130
33496
|
metricDefinitionsCreate: (data: MetricDefinitionsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<MetricDefinitionsCreateResponse, any, {}>>;
|
|
33131
33497
|
/**
|
|
33132
|
-
* @description Deletes a custom metric definition
|
|
33498
|
+
* @description Deletes a custom metric definition **Required scopes:** - `metric_definition:all`
|
|
33133
33499
|
*
|
|
33134
33500
|
* @tags slas
|
|
33135
33501
|
* @name MetricDefinitionsDelete
|
|
@@ -33139,7 +33505,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
33139
33505
|
*/
|
|
33140
33506
|
metricDefinitionsDelete: (data: MetricDefinitionsDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
|
|
33141
33507
|
/**
|
|
33142
|
-
* @description Gets a custom metric definition
|
|
33508
|
+
* @description Gets a custom metric definition **Required scopes:** - `metric_definition:read` OR `metric_definition:write` OR `metric_definition:all`
|
|
33143
33509
|
*
|
|
33144
33510
|
* @tags slas
|
|
33145
33511
|
* @name MetricDefinitionsGet
|
|
@@ -33162,7 +33528,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
33162
33528
|
name?: string;
|
|
33163
33529
|
}, params?: RequestParams) => Promise<AxiosResponse<MetricDefinitionsGetResponse, any, {}>>;
|
|
33164
33530
|
/**
|
|
33165
|
-
* @description Gets a custom metric definition
|
|
33531
|
+
* @description Gets a custom metric definition **Required scopes:** - `metric_definition:read` OR `metric_definition:write` OR `metric_definition:all`
|
|
33166
33532
|
*
|
|
33167
33533
|
* @tags slas
|
|
33168
33534
|
* @name MetricDefinitionsGetPost
|
|
@@ -33172,7 +33538,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
33172
33538
|
*/
|
|
33173
33539
|
metricDefinitionsGetPost: (data: MetricDefinitionsGetRequest, params?: RequestParams) => Promise<AxiosResponse<MetricDefinitionsGetResponse, any, {}>>;
|
|
33174
33540
|
/**
|
|
33175
|
-
* @description Lists metric definitions matching a filter.
|
|
33541
|
+
* @description Lists metric definitions matching a filter. **Required scopes:** - `metric_definition:read` OR `metric_definition:write` OR `metric_definition:all`
|
|
33176
33542
|
*
|
|
33177
33543
|
* @tags slas
|
|
33178
33544
|
* @name MetricDefinitionsList
|
|
@@ -33212,7 +33578,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
33212
33578
|
type?: MetricDefinitionMetricType[];
|
|
33213
33579
|
}, params?: RequestParams) => Promise<AxiosResponse<MetricDefinitionsListResponse, any, {}>>;
|
|
33214
33580
|
/**
|
|
33215
|
-
* @description Lists metric definitions matching a filter.
|
|
33581
|
+
* @description Lists metric definitions matching a filter. **Required scopes:** - `metric_definition:read` OR `metric_definition:write` OR `metric_definition:all`
|
|
33216
33582
|
*
|
|
33217
33583
|
* @tags slas
|
|
33218
33584
|
* @name MetricDefinitionsListPost
|
|
@@ -33222,7 +33588,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
33222
33588
|
*/
|
|
33223
33589
|
metricDefinitionsListPost: (data: MetricDefinitionsListRequest, params?: RequestParams) => Promise<AxiosResponse<MetricDefinitionsListResponse, any, {}>>;
|
|
33224
33590
|
/**
|
|
33225
|
-
* @description Updates a custom metric definition
|
|
33591
|
+
* @description Updates a custom metric definition **Required scopes:** - `metric_definition:write` OR `metric_definition:all`
|
|
33226
33592
|
*
|
|
33227
33593
|
* @tags slas
|
|
33228
33594
|
* @name MetricDefinitionsUpdate
|
|
@@ -33232,7 +33598,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
33232
33598
|
*/
|
|
33233
33599
|
metricDefinitionsUpdate: (data: MetricDefinitionsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<MetricDefinitionsUpdateResponse, any, {}>>;
|
|
33234
33600
|
/**
|
|
33235
|
-
* @description Gets a metric tracker.
|
|
33601
|
+
* @description Gets a metric tracker. **Required scopes:** No scopes required.
|
|
33236
33602
|
*
|
|
33237
33603
|
* @tags slas
|
|
33238
33604
|
* @name MetricTrackersGet
|
|
@@ -33253,7 +33619,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
33253
33619
|
object: string;
|
|
33254
33620
|
}, params?: RequestParams) => Promise<AxiosResponse<MetricTrackersGetResponse, any, {}>>;
|
|
33255
33621
|
/**
|
|
33256
|
-
* @description Gets a metric tracker.
|
|
33622
|
+
* @description Gets a metric tracker. **Required scopes:** No scopes required.
|
|
33257
33623
|
*
|
|
33258
33624
|
* @tags slas
|
|
33259
33625
|
* @name MetricTrackersGetPost
|
|
@@ -33347,7 +33713,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
33347
33713
|
*/
|
|
33348
33714
|
objectsListPost: (data: ObjectsListRequest, params?: RequestParams) => Promise<AxiosResponse<ObjectsListResponse, any, {}>>;
|
|
33349
33715
|
/**
|
|
33350
|
-
* @description Aggregates the sessions data.
|
|
33716
|
+
* @description Aggregates the sessions data. **Required scopes:** No scopes required.
|
|
33351
33717
|
*
|
|
33352
33718
|
* @tags observability
|
|
33353
33719
|
* @name ObservabilitySessionsAggregate
|
|
@@ -33357,7 +33723,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
33357
33723
|
*/
|
|
33358
33724
|
observabilitySessionsAggregate: (data: ObservabilitySessionsAggregateRequest, params?: RequestParams) => Promise<AxiosResponse<ObservabilitySessionsAggregateResponse, any, {}>>;
|
|
33359
33725
|
/**
|
|
33360
|
-
* @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.
|
|
33726
|
+
* @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.
|
|
33361
33727
|
*
|
|
33362
33728
|
* @tags observability
|
|
33363
33729
|
* @name ObservabilitySessionsDataGet
|
|
@@ -33391,7 +33757,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
33391
33757
|
tab_id?: string;
|
|
33392
33758
|
}, params?: RequestParams) => Promise<AxiosResponse<ObservabilitySessionsDataGetResponse, any, {}>>;
|
|
33393
33759
|
/**
|
|
33394
|
-
* @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.
|
|
33760
|
+
* @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.
|
|
33395
33761
|
*
|
|
33396
33762
|
* @tags observability
|
|
33397
33763
|
* @name ObservabilitySessionsDataGetPost
|
|
@@ -33401,7 +33767,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
33401
33767
|
*/
|
|
33402
33768
|
observabilitySessionsDataGetPost: (data: ObservabilitySessionsDataGetRequest, params?: RequestParams) => Promise<AxiosResponse<ObservabilitySessionsDataGetResponse, any, {}>>;
|
|
33403
33769
|
/**
|
|
33404
|
-
* @description Retrieves detailed console and network data for debugging.
|
|
33770
|
+
* @description Retrieves detailed console and network data for debugging. **Required scopes:** No scopes required.
|
|
33405
33771
|
*
|
|
33406
33772
|
* @tags observability
|
|
33407
33773
|
* @name ObservabilitySessionsDeveloperInfoGet
|
|
@@ -33437,7 +33803,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
33437
33803
|
status_code_classes?: StatusCodeClass[];
|
|
33438
33804
|
}, params?: RequestParams) => Promise<AxiosResponse<ObservabilitySessionsDeveloperInfoGetResponse, any, {}>>;
|
|
33439
33805
|
/**
|
|
33440
|
-
* @description Retrieves detailed console and network data for debugging.
|
|
33806
|
+
* @description Retrieves detailed console and network data for debugging. **Required scopes:** No scopes required.
|
|
33441
33807
|
*
|
|
33442
33808
|
* @tags observability
|
|
33443
33809
|
* @name ObservabilitySessionsDeveloperInfoGetPost
|
|
@@ -33447,7 +33813,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
33447
33813
|
*/
|
|
33448
33814
|
observabilitySessionsDeveloperInfoGetPost: (data: ObservabilitySessionsDeveloperInfoGetRequest, params?: RequestParams) => Promise<AxiosResponse<ObservabilitySessionsDeveloperInfoGetResponse, any, {}>>;
|
|
33449
33815
|
/**
|
|
33450
|
-
* @description Gets a specific session metadata by ID.
|
|
33816
|
+
* @description Gets a specific session metadata by ID. **Required scopes:** No scopes required.
|
|
33451
33817
|
*
|
|
33452
33818
|
* @tags observability
|
|
33453
33819
|
* @name ObservabilitySessionsGet
|
|
@@ -33472,7 +33838,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
33472
33838
|
version_key: string;
|
|
33473
33839
|
}, params?: RequestParams) => Promise<AxiosResponse<ObservabilitySessionsGetResponse, any, {}>>;
|
|
33474
33840
|
/**
|
|
33475
|
-
* @description Gets a specific session metadata by ID.
|
|
33841
|
+
* @description Gets a specific session metadata by ID. **Required scopes:** No scopes required.
|
|
33476
33842
|
*
|
|
33477
33843
|
* @tags observability
|
|
33478
33844
|
* @name ObservabilitySessionsGetPost
|
|
@@ -33482,7 +33848,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
33482
33848
|
*/
|
|
33483
33849
|
observabilitySessionsGetPost: (data: ObservabilitySessionsGetRequest, params?: RequestParams) => Promise<AxiosResponse<ObservabilitySessionsGetResponse, any, {}>>;
|
|
33484
33850
|
/**
|
|
33485
|
-
* @description Lists sessions based on filter criteria.
|
|
33851
|
+
* @description Lists sessions based on filter criteria. **Required scopes:** No scopes required.
|
|
33486
33852
|
*
|
|
33487
33853
|
* @tags observability
|
|
33488
33854
|
* @name ObservabilitySessionsList
|
|
@@ -33519,7 +33885,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
33519
33885
|
sort_by?: string[];
|
|
33520
33886
|
}, params?: RequestParams) => Promise<AxiosResponse<ObservabilitySessionsListResponse, any, {}>>;
|
|
33521
33887
|
/**
|
|
33522
|
-
* @description Lists sessions based on filter criteria.
|
|
33888
|
+
* @description Lists sessions based on filter criteria. **Required scopes:** No scopes required.
|
|
33523
33889
|
*
|
|
33524
33890
|
* @tags observability
|
|
33525
33891
|
* @name ObservabilitySessionsListPost
|
|
@@ -33529,7 +33895,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
33529
33895
|
*/
|
|
33530
33896
|
observabilitySessionsListPost: (data: ObservabilitySessionsListRequest, params?: RequestParams) => Promise<AxiosResponse<ObservabilitySessionsListResponse, any, {}>>;
|
|
33531
33897
|
/**
|
|
33532
|
-
* @description Creates an organization schedule fragment.
|
|
33898
|
+
* @description Creates an organization schedule fragment. **Required scopes:** - `org_schedule_fragment:write` OR `org_schedule_fragment:all`
|
|
33533
33899
|
*
|
|
33534
33900
|
* @tags schedules
|
|
33535
33901
|
* @name OrgScheduleFragmentsCreate
|
|
@@ -33539,7 +33905,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
33539
33905
|
*/
|
|
33540
33906
|
orgScheduleFragmentsCreate: (data: OrgScheduleFragmentsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<OrgScheduleFragmentsCreateResponse, any, {}>>;
|
|
33541
33907
|
/**
|
|
33542
|
-
* @description Gets an organization schedule fragment.
|
|
33908
|
+
* @description Gets an organization schedule fragment. **Required scopes:** - `org_schedule_fragment:read` OR `org_schedule_fragment:write` OR `org_schedule_fragment:all`
|
|
33543
33909
|
*
|
|
33544
33910
|
* @tags schedules
|
|
33545
33911
|
* @name OrgScheduleFragmentsGet
|
|
@@ -33555,7 +33921,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
33555
33921
|
id: string;
|
|
33556
33922
|
}, params?: RequestParams) => Promise<AxiosResponse<OrgScheduleFragmentsGetResponse, any, {}>>;
|
|
33557
33923
|
/**
|
|
33558
|
-
* @description Gets an organization schedule fragment.
|
|
33924
|
+
* @description Gets an organization schedule fragment. **Required scopes:** - `org_schedule_fragment:read` OR `org_schedule_fragment:write` OR `org_schedule_fragment:all`
|
|
33559
33925
|
*
|
|
33560
33926
|
* @tags schedules
|
|
33561
33927
|
* @name OrgScheduleFragmentsGetPost
|
|
@@ -33565,7 +33931,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
33565
33931
|
*/
|
|
33566
33932
|
orgScheduleFragmentsGetPost: (data: OrgScheduleFragmentsGetRequest, params?: RequestParams) => Promise<AxiosResponse<OrgScheduleFragmentsGetResponse, any, {}>>;
|
|
33567
33933
|
/**
|
|
33568
|
-
* @description Changes stage of an organization schedule fragment.
|
|
33934
|
+
* @description Changes stage of an organization schedule fragment. **Required scopes:** - `org_schedule_fragment:write` OR `org_schedule_fragment:all`
|
|
33569
33935
|
*
|
|
33570
33936
|
* @tags schedules
|
|
33571
33937
|
* @name OrgScheduleFragmentsTransition
|
|
@@ -33575,7 +33941,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
33575
33941
|
*/
|
|
33576
33942
|
orgScheduleFragmentsTransition: (data: OrgScheduleFragmentsTransitionRequest, params?: RequestParams) => Promise<AxiosResponse<OrgScheduleFragmentsTransitionResponse, any, {}>>;
|
|
33577
33943
|
/**
|
|
33578
|
-
* @description Creates an organization schedule with a default weekly organization schedule and a list of organization schedule fragments.
|
|
33944
|
+
* @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`
|
|
33579
33945
|
*
|
|
33580
33946
|
* @tags schedules
|
|
33581
33947
|
* @name OrgSchedulesCreate
|
|
@@ -33585,7 +33951,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
33585
33951
|
*/
|
|
33586
33952
|
orgSchedulesCreate: (data: OrgSchedulesCreateRequest, params?: RequestParams) => Promise<AxiosResponse<OrgSchedulesCreateResponse, any, {}>>;
|
|
33587
33953
|
/**
|
|
33588
|
-
* @description Evaluates an organization's schedule at specified instants.
|
|
33954
|
+
* @description Evaluates an organization's schedule at specified instants. **Required scopes:** - `org_schedule:read` OR `org_schedule:write` OR `org_schedule:all`
|
|
33589
33955
|
*
|
|
33590
33956
|
* @tags schedules
|
|
33591
33957
|
* @name OrgSchedulesEvaluate
|
|
@@ -33607,7 +33973,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
33607
33973
|
instants: string[];
|
|
33608
33974
|
}, params?: RequestParams) => Promise<AxiosResponse<OrgSchedulesEvaluateResponse, any, {}>>;
|
|
33609
33975
|
/**
|
|
33610
|
-
* @description Evaluates an organization's schedule at specified instants.
|
|
33976
|
+
* @description Evaluates an organization's schedule at specified instants. **Required scopes:** - `org_schedule:read` OR `org_schedule:write` OR `org_schedule:all`
|
|
33611
33977
|
*
|
|
33612
33978
|
* @tags schedules
|
|
33613
33979
|
* @name OrgSchedulesEvaluatePost
|
|
@@ -33617,7 +33983,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
33617
33983
|
*/
|
|
33618
33984
|
orgSchedulesEvaluatePost: (data: OrgSchedulesEvaluateRequest, params?: RequestParams) => Promise<AxiosResponse<OrgSchedulesEvaluateResponse, any, {}>>;
|
|
33619
33985
|
/**
|
|
33620
|
-
* @description Gets an organization schedule.
|
|
33986
|
+
* @description Gets an organization schedule. **Required scopes:** - `org_schedule:read` OR `org_schedule:write` OR `org_schedule:all`
|
|
33621
33987
|
*
|
|
33622
33988
|
* @tags schedules
|
|
33623
33989
|
* @name OrgSchedulesGet
|
|
@@ -33639,7 +34005,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
33639
34005
|
version_number?: number;
|
|
33640
34006
|
}, params?: RequestParams) => Promise<AxiosResponse<OrgSchedulesGetResponse, any, {}>>;
|
|
33641
34007
|
/**
|
|
33642
|
-
* @description Gets an organization schedule.
|
|
34008
|
+
* @description Gets an organization schedule. **Required scopes:** - `org_schedule:read` OR `org_schedule:write` OR `org_schedule:all`
|
|
33643
34009
|
*
|
|
33644
34010
|
* @tags schedules
|
|
33645
34011
|
* @name OrgSchedulesGetPost
|
|
@@ -33649,7 +34015,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
33649
34015
|
*/
|
|
33650
34016
|
orgSchedulesGetPost: (data: OrgSchedulesGetRequest, params?: RequestParams) => Promise<AxiosResponse<OrgSchedulesGetResponse, any, {}>>;
|
|
33651
34017
|
/**
|
|
33652
|
-
* @description Gets list of organization schedules.
|
|
34018
|
+
* @description Gets list of organization schedules. **Required scopes:** - `org_schedule:read` OR `org_schedule:write` OR `org_schedule:all`
|
|
33653
34019
|
*
|
|
33654
34020
|
* @tags schedules
|
|
33655
34021
|
* @name OrgSchedulesList
|
|
@@ -33681,7 +34047,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
33681
34047
|
status?: OrgScheduleStatus[];
|
|
33682
34048
|
}, params?: RequestParams) => Promise<AxiosResponse<OrgSchedulesListResponse, any, {}>>;
|
|
33683
34049
|
/**
|
|
33684
|
-
* @description Gets list of organization schedules.
|
|
34050
|
+
* @description Gets list of organization schedules. **Required scopes:** - `org_schedule:read` OR `org_schedule:write` OR `org_schedule:all`
|
|
33685
34051
|
*
|
|
33686
34052
|
* @tags schedules
|
|
33687
34053
|
* @name OrgSchedulesListPost
|
|
@@ -33691,7 +34057,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
33691
34057
|
*/
|
|
33692
34058
|
orgSchedulesListPost: (data: OrgSchedulesListRequest, params?: RequestParams) => Promise<AxiosResponse<OrgSchedulesListResponse, any, {}>>;
|
|
33693
34059
|
/**
|
|
33694
|
-
* @description Sets next organization schedule fragment which must begin the day the last existing fragment ends.
|
|
34060
|
+
* @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`
|
|
33695
34061
|
*
|
|
33696
34062
|
* @tags schedules
|
|
33697
34063
|
* @name OrgSchedulesSetFuture
|
|
@@ -33701,7 +34067,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
33701
34067
|
*/
|
|
33702
34068
|
orgSchedulesSetFuture: (data: OrgSchedulesSetFutureRequest, params?: RequestParams) => Promise<AxiosResponse<OrgSchedulesSetFutureResponse, any, {}>>;
|
|
33703
34069
|
/**
|
|
33704
|
-
* @description Publishes or archives an organization schedule.
|
|
34070
|
+
* @description Publishes or archives an organization schedule. **Required scopes:** - `org_schedule:write` OR `org_schedule:all`
|
|
33705
34071
|
*
|
|
33706
34072
|
* @tags schedules
|
|
33707
34073
|
* @name OrgSchedulesTransition
|
|
@@ -33711,7 +34077,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
33711
34077
|
*/
|
|
33712
34078
|
orgSchedulesTransition: (data: OrgSchedulesTransitionRequest, params?: RequestParams) => Promise<AxiosResponse<OrgSchedulesTransitionResponse, any, {}>>;
|
|
33713
34079
|
/**
|
|
33714
|
-
* @description Updates an organization schedule.
|
|
34080
|
+
* @description Updates an organization schedule. **Required scopes:** - `org_schedule:write` OR `org_schedule:all`
|
|
33715
34081
|
*
|
|
33716
34082
|
* @tags schedules
|
|
33717
34083
|
* @name OrgSchedulesUpdate
|
|
@@ -33721,7 +34087,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
33721
34087
|
*/
|
|
33722
34088
|
orgSchedulesUpdate: (data: OrgSchedulesUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<OrgSchedulesUpdateResponse, any, {}>>;
|
|
33723
34089
|
/**
|
|
33724
|
-
* @description Creates new [part](https://devrev.ai/docs/product/parts).
|
|
34090
|
+
* @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` |
|
|
33725
34091
|
*
|
|
33726
34092
|
* @tags parts
|
|
33727
34093
|
* @name PartsCreate
|
|
@@ -33731,7 +34097,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
33731
34097
|
*/
|
|
33732
34098
|
partsCreate: (data: PartsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<PartsCreateResponse, any, {}>>;
|
|
33733
34099
|
/**
|
|
33734
|
-
* @description Deletes a [part](https://devrev.ai/docs/product/parts).
|
|
34100
|
+
* @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` |
|
|
33735
34101
|
*
|
|
33736
34102
|
* @tags parts
|
|
33737
34103
|
* @name PartsDelete
|
|
@@ -33741,7 +34107,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
33741
34107
|
*/
|
|
33742
34108
|
partsDelete: (data: PartsDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
|
|
33743
34109
|
/**
|
|
33744
|
-
* @description Gets a [part's](https://devrev.ai/docs/product/parts) information.
|
|
34110
|
+
* @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` |
|
|
33745
34111
|
*
|
|
33746
34112
|
* @tags parts
|
|
33747
34113
|
* @name PartsGet
|
|
@@ -33758,7 +34124,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
33758
34124
|
id: string;
|
|
33759
34125
|
}, params?: RequestParams) => Promise<AxiosResponse<PartsGetResponse, any, {}>>;
|
|
33760
34126
|
/**
|
|
33761
|
-
* @description Gets a [part's](https://devrev.ai/docs/product/parts) information.
|
|
34127
|
+
* @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` |
|
|
33762
34128
|
*
|
|
33763
34129
|
* @tags parts
|
|
33764
34130
|
* @name PartsGetPost
|
|
@@ -33768,7 +34134,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
33768
34134
|
*/
|
|
33769
34135
|
partsGetPost: (data: PartsGetRequest, params?: RequestParams) => Promise<AxiosResponse<PartsGetResponse, any, {}>>;
|
|
33770
34136
|
/**
|
|
33771
|
-
* @description Lists a collection of [parts](https://devrev.ai/docs/product/parts).
|
|
34137
|
+
* @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` |
|
|
33772
34138
|
*
|
|
33773
34139
|
* @tags parts
|
|
33774
34140
|
* @name PartsList
|
|
@@ -33949,7 +34315,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
33949
34315
|
type?: PartType[];
|
|
33950
34316
|
}, params?: RequestParams) => Promise<AxiosResponse<PartsListResponse, any, {}>>;
|
|
33951
34317
|
/**
|
|
33952
|
-
* @description Lists a collection of [parts](https://devrev.ai/docs/product/parts).
|
|
34318
|
+
* @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` |
|
|
33953
34319
|
*
|
|
33954
34320
|
* @tags parts
|
|
33955
34321
|
* @name PartsListPost
|
|
@@ -33959,7 +34325,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
33959
34325
|
*/
|
|
33960
34326
|
partsListPost: (data: PartsListRequest, params?: RequestParams) => Promise<AxiosResponse<PartsListResponse, any, {}>>;
|
|
33961
34327
|
/**
|
|
33962
|
-
* @description Updates a [part's](https://devrev.ai/docs/product/parts) information.
|
|
34328
|
+
* @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` |
|
|
33963
34329
|
*
|
|
33964
34330
|
* @tags parts
|
|
33965
34331
|
* @name PartsUpdate
|
|
@@ -34153,7 +34519,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
34153
34519
|
*/
|
|
34154
34520
|
updateQuestionAnswer: (data: QuestionAnswersUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<QuestionAnswersUpdateResponse, any, {}>>;
|
|
34155
34521
|
/**
|
|
34156
|
-
* @description Lists the reactors for an object.
|
|
34522
|
+
* @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).
|
|
34157
34523
|
*
|
|
34158
34524
|
* @tags timeline-entries, works
|
|
34159
34525
|
* @name ReactionsList
|
|
@@ -34188,7 +34554,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
34188
34554
|
limit?: number;
|
|
34189
34555
|
}, params?: RequestParams) => Promise<AxiosResponse<ReactionsListResponse, any, {}>>;
|
|
34190
34556
|
/**
|
|
34191
|
-
* @description Lists the reactors for an object.
|
|
34557
|
+
* @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).
|
|
34192
34558
|
*
|
|
34193
34559
|
* @tags timeline-entries, works
|
|
34194
34560
|
* @name ReactionsListPost
|
|
@@ -34198,7 +34564,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
34198
34564
|
*/
|
|
34199
34565
|
reactionsListPost: (data: ReactionsListRequest, params?: RequestParams) => Promise<AxiosResponse<ReactionsListResponse, any, {}>>;
|
|
34200
34566
|
/**
|
|
34201
|
-
* @description Updates a reaction for an object.
|
|
34567
|
+
* @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).
|
|
34202
34568
|
*
|
|
34203
34569
|
* @tags timeline-entries, works
|
|
34204
34570
|
* @name ReactionsUpdate
|
|
@@ -34254,7 +34620,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
34254
34620
|
*/
|
|
34255
34621
|
recordTemplateGetPost: (data: RecordTemplateGetRequest, params?: RequestParams) => Promise<AxiosResponse<RecordTemplateGetResponse, any, {}>>;
|
|
34256
34622
|
/**
|
|
34257
|
-
* @description Creates a Rev organization in the authenticated user's Dev organization. **Required scopes:** - `rev_org:write`
|
|
34623
|
+
* @description Creates a Rev organization in the authenticated user's Dev organization. **Required scopes:** - `rev_org:write` OR `rev_org:all`
|
|
34258
34624
|
*
|
|
34259
34625
|
* @tags rev-orgs
|
|
34260
34626
|
* @name RevOrgsCreate
|
|
@@ -34274,7 +34640,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
34274
34640
|
*/
|
|
34275
34641
|
revOrgsDelete: (data: RevOrgsDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
|
|
34276
34642
|
/**
|
|
34277
|
-
* @description Retrieves the Rev organization's information. **Required scopes:** - `rev_org:read`
|
|
34643
|
+
* @description Retrieves the Rev organization's information. **Required scopes:** - `rev_org:read` OR `rev_org:write` OR `rev_org:all`
|
|
34278
34644
|
*
|
|
34279
34645
|
* @tags rev-orgs
|
|
34280
34646
|
* @name RevOrgsGet
|
|
@@ -34298,7 +34664,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
34298
34664
|
id?: string;
|
|
34299
34665
|
}, params?: RequestParams) => Promise<AxiosResponse<RevOrgsGetResponse, any, {}>>;
|
|
34300
34666
|
/**
|
|
34301
|
-
* @description Retrieves the Rev organization's information. **Required scopes:** - `rev_org:read`
|
|
34667
|
+
* @description Retrieves the Rev organization's information. **Required scopes:** - `rev_org:read` OR `rev_org:write` OR `rev_org:all`
|
|
34302
34668
|
*
|
|
34303
34669
|
* @tags rev-orgs
|
|
34304
34670
|
* @name RevOrgsGetPost
|
|
@@ -34308,7 +34674,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
34308
34674
|
*/
|
|
34309
34675
|
revOrgsGetPost: (data: RevOrgsGetRequest, params?: RequestParams) => Promise<AxiosResponse<RevOrgsGetResponse, any, {}>>;
|
|
34310
34676
|
/**
|
|
34311
|
-
* @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`
|
|
34677
|
+
* @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`
|
|
34312
34678
|
*
|
|
34313
34679
|
* @tags rev-orgs
|
|
34314
34680
|
* @name RevOrgsList
|
|
@@ -34386,7 +34752,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
34386
34752
|
tags?: string[];
|
|
34387
34753
|
}, params?: RequestParams) => Promise<AxiosResponse<RevOrgsListResponse, any, {}>>;
|
|
34388
34754
|
/**
|
|
34389
|
-
* @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`
|
|
34755
|
+
* @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`
|
|
34390
34756
|
*
|
|
34391
34757
|
* @tags rev-orgs
|
|
34392
34758
|
* @name RevOrgsListPost
|
|
@@ -34396,7 +34762,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
34396
34762
|
*/
|
|
34397
34763
|
revOrgsListPost: (data: RevOrgsListRequest, params?: RequestParams) => Promise<AxiosResponse<RevOrgsListResponse, any, {}>>;
|
|
34398
34764
|
/**
|
|
34399
|
-
* @description Updates the Rev organization's information. **Required scopes:** - `rev_org:write`
|
|
34765
|
+
* @description Updates the Rev organization's information. **Required scopes:** - `rev_org:write` OR `rev_org:all`
|
|
34400
34766
|
*
|
|
34401
34767
|
* @tags rev-orgs
|
|
34402
34768
|
* @name RevOrgsUpdate
|
|
@@ -34469,7 +34835,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
34469
34835
|
*/
|
|
34470
34836
|
revUsersAssociationsRemove: (data: RevUsersAssociationsRemoveRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
|
|
34471
34837
|
/**
|
|
34472
|
-
* @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`
|
|
34838
|
+
* @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`
|
|
34473
34839
|
*
|
|
34474
34840
|
* @tags rev-users
|
|
34475
34841
|
* @name RevUsersCreate
|
|
@@ -34499,7 +34865,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
34499
34865
|
*/
|
|
34500
34866
|
deleteRevUsersPersonalData: (data: DeleteRevUsersPersonalDataRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
|
|
34501
34867
|
/**
|
|
34502
|
-
* @description Returns the Rev user of a Rev organization by its ID. **Required scopes:** - `rev_user:read`
|
|
34868
|
+
* @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`
|
|
34503
34869
|
*
|
|
34504
34870
|
* @tags rev-users
|
|
34505
34871
|
* @name RevUsersGet
|
|
@@ -34515,7 +34881,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
34515
34881
|
id: string;
|
|
34516
34882
|
}, params?: RequestParams) => Promise<AxiosResponse<RevUsersGetResponse, any, {}>>;
|
|
34517
34883
|
/**
|
|
34518
|
-
* @description Returns the Rev user of a Rev organization by its ID. **Required scopes:** - `rev_user:read`
|
|
34884
|
+
* @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`
|
|
34519
34885
|
*
|
|
34520
34886
|
* @tags rev-users
|
|
34521
34887
|
* @name RevUsersGetPost
|
|
@@ -34536,7 +34902,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
34536
34902
|
*/
|
|
34537
34903
|
linkRevUserToRevOrg: (data: LinkRevUserToRevOrgRequest, params?: RequestParams) => Promise<AxiosResponse<LinkRevUserToRevOrgResponse, any, {}>>;
|
|
34538
34904
|
/**
|
|
34539
|
-
* @description Returns a list of all Rev Users belonging to the authenticated user's Dev organization. **Required scopes:** - `rev_user:read`
|
|
34905
|
+
* @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`
|
|
34540
34906
|
*
|
|
34541
34907
|
* @tags rev-users
|
|
34542
34908
|
* @name RevUsersList
|
|
@@ -34617,7 +34983,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
34617
34983
|
tags?: string[];
|
|
34618
34984
|
}, params?: RequestParams) => Promise<AxiosResponse<RevUsersListResponse, any, {}>>;
|
|
34619
34985
|
/**
|
|
34620
|
-
* @description Returns a list of all Rev Users belonging to the authenticated user's Dev organization. **Required scopes:** - `rev_user:read`
|
|
34986
|
+
* @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`
|
|
34621
34987
|
*
|
|
34622
34988
|
* @tags rev-users
|
|
34623
34989
|
* @name RevUsersListPost
|
|
@@ -34647,7 +35013,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
34647
35013
|
*/
|
|
34648
35014
|
getRevUsersPersonalData: (data: GetRevUsersPersonalDataRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
|
|
34649
35015
|
/**
|
|
34650
|
-
* @description Scans through all Rev users. **Required scopes:** - `rev_user:read`
|
|
35016
|
+
* @description Scans through all Rev users. **Required scopes:** - `rev_user:read` OR `rev_user:write` OR `rev_user:all`
|
|
34651
35017
|
*
|
|
34652
35018
|
* @tags rev-users
|
|
34653
35019
|
* @name RevUsersScan
|
|
@@ -34716,7 +35082,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
34716
35082
|
tags?: string[];
|
|
34717
35083
|
}, params?: RequestParams) => Promise<AxiosResponse<RevUsersScanResponse, any, {}>>;
|
|
34718
35084
|
/**
|
|
34719
|
-
* @description Scans through all Rev users. **Required scopes:** - `rev_user:read`
|
|
35085
|
+
* @description Scans through all Rev users. **Required scopes:** - `rev_user:read` OR `rev_user:write` OR `rev_user:all`
|
|
34720
35086
|
*
|
|
34721
35087
|
* @tags rev-users
|
|
34722
35088
|
* @name RevUsersScanPost
|
|
@@ -34737,7 +35103,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
34737
35103
|
*/
|
|
34738
35104
|
unlinkRevUserFromRevOrg: (data: UnlinkRevUserFromRevOrgRequest, params?: RequestParams) => Promise<AxiosResponse<UnlinkRevUserFromRevOrgResponse, any, {}>>;
|
|
34739
35105
|
/**
|
|
34740
|
-
* @description Updates a Rev user. **Required scopes:** - `rev_user:write`
|
|
35106
|
+
* @description Updates a Rev user. **Required scopes:** - `rev_user:write` OR `rev_user:all`
|
|
34741
35107
|
*
|
|
34742
35108
|
* @tags rev-users
|
|
34743
35109
|
* @name RevUsersUpdate
|
|
@@ -34768,7 +35134,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
34768
35134
|
*/
|
|
34769
35135
|
rolesCreate: (data: RolesCreateRequest, params?: RequestParams) => Promise<AxiosResponse<RolesCreateResponse, any, {}>>;
|
|
34770
35136
|
/**
|
|
34771
|
-
* @description Gets the aggregated schema.
|
|
35137
|
+
* @description Gets the aggregated schema. **Required scopes:** No scopes required.
|
|
34772
35138
|
*
|
|
34773
35139
|
* @tags customization
|
|
34774
35140
|
* @name AggregatedSchemaGet
|
|
@@ -34801,7 +35167,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
34801
35167
|
stock_schema_fragment?: string;
|
|
34802
35168
|
}, params?: RequestParams) => Promise<AxiosResponse<AggregatedSchemaGetResponse, any, {}>>;
|
|
34803
35169
|
/**
|
|
34804
|
-
* @description Gets the aggregated schema.
|
|
35170
|
+
* @description Gets the aggregated schema. **Required scopes:** No scopes required.
|
|
34805
35171
|
*
|
|
34806
35172
|
* @tags customization
|
|
34807
35173
|
* @name AggregatedSchemaGetPost
|
|
@@ -34811,7 +35177,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
34811
35177
|
*/
|
|
34812
35178
|
aggregatedSchemaGetPost: (data: AggregatedSchemaGetRequest, params?: RequestParams) => Promise<AxiosResponse<AggregatedSchemaGetResponse, any, {}>>;
|
|
34813
35179
|
/**
|
|
34814
|
-
* @description Gets a custom schema fragment.
|
|
35180
|
+
* @description Gets a custom schema fragment. **Required scopes:** No scopes required.
|
|
34815
35181
|
*
|
|
34816
35182
|
* @tags customization
|
|
34817
35183
|
* @name CustomSchemaFragmentsGet
|
|
@@ -34829,7 +35195,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
34829
35195
|
include_sync_metadata?: boolean;
|
|
34830
35196
|
}, params?: RequestParams) => Promise<AxiosResponse<CustomSchemaFragmentsGetResponse, any, {}>>;
|
|
34831
35197
|
/**
|
|
34832
|
-
* @description Gets a custom schema fragment.
|
|
35198
|
+
* @description Gets a custom schema fragment. **Required scopes:** No scopes required.
|
|
34833
35199
|
*
|
|
34834
35200
|
* @tags customization
|
|
34835
35201
|
* @name CustomSchemaFragmentsGetPost
|
|
@@ -34839,7 +35205,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
34839
35205
|
*/
|
|
34840
35206
|
customSchemaFragmentsGetPost: (data: CustomSchemaFragmentsGetRequest, params?: RequestParams) => Promise<AxiosResponse<CustomSchemaFragmentsGetResponse, any, {}>>;
|
|
34841
35207
|
/**
|
|
34842
|
-
* @description Lists custom schema fragments.
|
|
35208
|
+
* @description Lists custom schema fragments. **Required scopes:** No scopes required.
|
|
34843
35209
|
*
|
|
34844
35210
|
* @tags customization
|
|
34845
35211
|
* @name CustomSchemaFragmentsList
|
|
@@ -34902,7 +35268,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
34902
35268
|
types?: CustomSchemaFragmentType[];
|
|
34903
35269
|
}, params?: RequestParams) => Promise<AxiosResponse<CustomSchemaFragmentsListResponse, any, {}>>;
|
|
34904
35270
|
/**
|
|
34905
|
-
* @description Lists custom schema fragments.
|
|
35271
|
+
* @description Lists custom schema fragments. **Required scopes:** No scopes required.
|
|
34906
35272
|
*
|
|
34907
35273
|
* @tags customization
|
|
34908
35274
|
* @name CustomSchemaFragmentsListPost
|
|
@@ -34912,7 +35278,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
34912
35278
|
*/
|
|
34913
35279
|
customSchemaFragmentsListPost: (data: CustomSchemaFragmentsListRequest, params?: RequestParams) => Promise<AxiosResponse<CustomSchemaFragmentsListResponse, any, {}>>;
|
|
34914
35280
|
/**
|
|
34915
|
-
* @description Creates or updates a custom schema fragment.
|
|
35281
|
+
* @description Creates or updates a custom schema fragment. **Required scopes:** - `custom_type_fragment:write`
|
|
34916
35282
|
*
|
|
34917
35283
|
* @tags customization
|
|
34918
35284
|
* @name CustomSchemaFragmentsSet
|
|
@@ -34922,7 +35288,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
34922
35288
|
*/
|
|
34923
35289
|
customSchemaFragmentsSet: (data: CustomSchemaFragmentsSetRequest, params?: RequestParams) => Promise<AxiosResponse<CustomSchemaFragmentsSetResponse, any, {}>>;
|
|
34924
35290
|
/**
|
|
34925
|
-
* @description Gets a stock schema fragment.
|
|
35291
|
+
* @description Gets a stock schema fragment. **Required scopes:** No scopes required.
|
|
34926
35292
|
*
|
|
34927
35293
|
* @tags customization
|
|
34928
35294
|
* @name StockSchemaFragmentsGet
|
|
@@ -34943,7 +35309,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
34943
35309
|
leaf_type?: string;
|
|
34944
35310
|
}, params?: RequestParams) => Promise<AxiosResponse<StockSchemaFragmentsGetResponse, any, {}>>;
|
|
34945
35311
|
/**
|
|
34946
|
-
* @description Gets a stock schema fragment.
|
|
35312
|
+
* @description Gets a stock schema fragment. **Required scopes:** No scopes required.
|
|
34947
35313
|
*
|
|
34948
35314
|
* @tags customization
|
|
34949
35315
|
* @name StockSchemaFragmentsGetPost
|
|
@@ -34953,7 +35319,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
34953
35319
|
*/
|
|
34954
35320
|
stockSchemaFragmentsGetPost: (data: StockSchemaFragmentsGetRequest, params?: RequestParams) => Promise<AxiosResponse<StockSchemaFragmentsGetResponse, any, {}>>;
|
|
34955
35321
|
/**
|
|
34956
|
-
* @description Lists stock schema fragments.
|
|
35322
|
+
* @description Lists stock schema fragments. **Required scopes:** No scopes required.
|
|
34957
35323
|
*
|
|
34958
35324
|
* @tags customization
|
|
34959
35325
|
* @name StockSchemaFragmentsList
|
|
@@ -34994,7 +35360,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
34994
35360
|
sort_by?: string[];
|
|
34995
35361
|
}, params?: RequestParams) => Promise<AxiosResponse<StockSchemaFragmentsListResponse, any, {}>>;
|
|
34996
35362
|
/**
|
|
34997
|
-
* @description Lists stock schema fragments.
|
|
35363
|
+
* @description Lists stock schema fragments. **Required scopes:** No scopes required.
|
|
34998
35364
|
*
|
|
34999
35365
|
* @tags customization
|
|
35000
35366
|
* @name StockSchemaFragmentsListPost
|
|
@@ -35033,7 +35399,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
35033
35399
|
*/
|
|
35034
35400
|
subtypesListPost: (data: SubtypesListRequest, params?: RequestParams) => Promise<AxiosResponse<SubtypesListResponse, any, {}>>;
|
|
35035
35401
|
/**
|
|
35036
|
-
* @description Gets the new fragment IDs and fields resulting from changing a subtype.
|
|
35402
|
+
* @description Gets the new fragment IDs and fields resulting from changing a subtype. **Required scopes:** - `custom_type_fragment:write`
|
|
35037
35403
|
*
|
|
35038
35404
|
* @tags customization
|
|
35039
35405
|
* @name SchemasSubtypePrepareUpdateGet
|
|
@@ -35135,7 +35501,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
35135
35501
|
*/
|
|
35136
35502
|
searchHybridPost: (data: SearchHybridRequest, params?: RequestParams) => Promise<AxiosResponse<SearchHybridResponse, any, {}>>;
|
|
35137
35503
|
/**
|
|
35138
|
-
* @description Creates a service account.
|
|
35504
|
+
* @description Creates a service account. **Required scopes:** Not accessible via service account tokens. Requires user authentication.
|
|
35139
35505
|
*
|
|
35140
35506
|
* @tags service-accounts
|
|
35141
35507
|
* @name ServiceAccountsCreate
|
|
@@ -35145,7 +35511,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
35145
35511
|
*/
|
|
35146
35512
|
serviceAccountsCreate: (data: ServiceAccountsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<ServiceAccountsCreateResponse, any, {}>>;
|
|
35147
35513
|
/**
|
|
35148
|
-
* @description Gets a service account.
|
|
35514
|
+
* @description Gets a service account. **Required scopes:** - `svcacc:read`
|
|
35149
35515
|
*
|
|
35150
35516
|
* @tags service-accounts
|
|
35151
35517
|
* @name ServiceAccountsGet
|
|
@@ -35161,7 +35527,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
35161
35527
|
id: string;
|
|
35162
35528
|
}, params?: RequestParams) => Promise<AxiosResponse<ServiceAccountsGetResponse, any, {}>>;
|
|
35163
35529
|
/**
|
|
35164
|
-
* @description Gets a service account.
|
|
35530
|
+
* @description Gets a service account. **Required scopes:** - `svcacc:read`
|
|
35165
35531
|
*
|
|
35166
35532
|
* @tags service-accounts
|
|
35167
35533
|
* @name ServiceAccountsGetPost
|
|
@@ -35181,7 +35547,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
35181
35547
|
*/
|
|
35182
35548
|
serviceAccountsUpdate: (data: ServiceAccountsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<ServiceAccountsUpdateResponse, any, {}>>;
|
|
35183
35549
|
/**
|
|
35184
|
-
* @description Gets an SLA tracker.
|
|
35550
|
+
* @description Gets an SLA tracker. **Required scopes:** No scopes required.
|
|
35185
35551
|
*
|
|
35186
35552
|
* @tags slas
|
|
35187
35553
|
* @name SlaTrackersGet
|
|
@@ -35197,7 +35563,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
35197
35563
|
id: string;
|
|
35198
35564
|
}, params?: RequestParams) => Promise<AxiosResponse<SlaTrackersGetResponse, any, {}>>;
|
|
35199
35565
|
/**
|
|
35200
|
-
* @description Gets an SLA tracker.
|
|
35566
|
+
* @description Gets an SLA tracker. **Required scopes:** No scopes required.
|
|
35201
35567
|
*
|
|
35202
35568
|
* @tags slas
|
|
35203
35569
|
* @name SlaTrackersGetPost
|
|
@@ -35207,7 +35573,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
35207
35573
|
*/
|
|
35208
35574
|
slaTrackersGetPost: (data: SlaTrackersGetRequest, params?: RequestParams) => Promise<AxiosResponse<SlaTrackersGetResponse, any, {}>>;
|
|
35209
35575
|
/**
|
|
35210
|
-
* @description Lists SLA trackers matching a filter.
|
|
35576
|
+
* @description Lists SLA trackers matching a filter. **Required scopes:** No scopes required.
|
|
35211
35577
|
*
|
|
35212
35578
|
* @tags slas
|
|
35213
35579
|
* @name SlaTrackersList
|
|
@@ -35266,7 +35632,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
35266
35632
|
status?: string[];
|
|
35267
35633
|
}, params?: RequestParams) => Promise<AxiosResponse<SlaTrackersListResponse, any, {}>>;
|
|
35268
35634
|
/**
|
|
35269
|
-
* @description Lists SLA trackers matching a filter.
|
|
35635
|
+
* @description Lists SLA trackers matching a filter. **Required scopes:** No scopes required.
|
|
35270
35636
|
*
|
|
35271
35637
|
* @tags slas
|
|
35272
35638
|
* @name SlaTrackersListPost
|
|
@@ -35286,7 +35652,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
35286
35652
|
*/
|
|
35287
35653
|
slaTrackersRemoveMetric: (data: SlaTrackersRemoveMetricRequest, params?: RequestParams) => Promise<AxiosResponse<SlaTrackersRemoveMetricResponse, any, {}>>;
|
|
35288
35654
|
/**
|
|
35289
|
-
* @description
|
|
35655
|
+
* @description Assigns the SLA to a set of Rev organizations. **Required scopes:** - `sla:write`
|
|
35290
35656
|
*
|
|
35291
35657
|
* @tags slas
|
|
35292
35658
|
* @name SlasAssign
|
|
@@ -35296,7 +35662,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
35296
35662
|
*/
|
|
35297
35663
|
slasAssign: (data: SlasAssignRequest, params?: RequestParams) => Promise<AxiosResponse<SlasAssignResponse, any, {}>>;
|
|
35298
35664
|
/**
|
|
35299
|
-
* @description Creates an SLA in draft status.
|
|
35665
|
+
* @description Creates an SLA in draft status. **Required scopes:** - `sla:write`
|
|
35300
35666
|
*
|
|
35301
35667
|
* @tags slas
|
|
35302
35668
|
* @name SlasCreate
|
|
@@ -35306,7 +35672,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
35306
35672
|
*/
|
|
35307
35673
|
slasCreate: (data: SlasCreateRequest, params?: RequestParams) => Promise<AxiosResponse<SlasCreateResponse, any, {}>>;
|
|
35308
35674
|
/**
|
|
35309
|
-
* @description Gets an SLA.
|
|
35675
|
+
* @description Gets an SLA. **Required scopes:** - `sla:read` OR `sla:write`
|
|
35310
35676
|
*
|
|
35311
35677
|
* @tags slas
|
|
35312
35678
|
* @name SlasGet
|
|
@@ -35322,7 +35688,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
35322
35688
|
id: string;
|
|
35323
35689
|
}, params?: RequestParams) => Promise<AxiosResponse<SlasGetResponse, any, {}>>;
|
|
35324
35690
|
/**
|
|
35325
|
-
* @description Gets an SLA.
|
|
35691
|
+
* @description Gets an SLA. **Required scopes:** - `sla:read` OR `sla:write`
|
|
35326
35692
|
*
|
|
35327
35693
|
* @tags slas
|
|
35328
35694
|
* @name SlasGetPost
|
|
@@ -35332,7 +35698,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
35332
35698
|
*/
|
|
35333
35699
|
slasGetPost: (data: SlasGetRequest, params?: RequestParams) => Promise<AxiosResponse<SlasGetResponse, any, {}>>;
|
|
35334
35700
|
/**
|
|
35335
|
-
* @description Lists SLAs matching a filter.
|
|
35701
|
+
* @description Lists SLAs matching a filter. **Required scopes:** - `sla:read` OR `sla:write`
|
|
35336
35702
|
*
|
|
35337
35703
|
* @tags slas
|
|
35338
35704
|
* @name SlasList
|
|
@@ -35372,7 +35738,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
35372
35738
|
status?: SlaStatus[];
|
|
35373
35739
|
}, params?: RequestParams) => Promise<AxiosResponse<SlasListResponse, any, {}>>;
|
|
35374
35740
|
/**
|
|
35375
|
-
* @description Lists SLAs matching a filter.
|
|
35741
|
+
* @description Lists SLAs matching a filter. **Required scopes:** - `sla:read` OR `sla:write`
|
|
35376
35742
|
*
|
|
35377
35743
|
* @tags slas
|
|
35378
35744
|
* @name SlasListPost
|
|
@@ -35382,7 +35748,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
35382
35748
|
*/
|
|
35383
35749
|
slasListPost: (data: SlasListRequest, params?: RequestParams) => Promise<AxiosResponse<SlasListResponse, any, {}>>;
|
|
35384
35750
|
/**
|
|
35385
|
-
* @description Changes the status of an SLA.
|
|
35751
|
+
* @description Changes the status of an SLA. **Required scopes:** - `sla:write`
|
|
35386
35752
|
*
|
|
35387
35753
|
* @tags slas
|
|
35388
35754
|
* @name SlasTransition
|
|
@@ -35392,7 +35758,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
35392
35758
|
*/
|
|
35393
35759
|
slasTransition: (data: SlasTransitionRequest, params?: RequestParams) => Promise<AxiosResponse<SlasTransitionResponse, any, {}>>;
|
|
35394
35760
|
/**
|
|
35395
|
-
* @description Updates a draft SLA.
|
|
35761
|
+
* @description Updates a draft SLA. **Required scopes:** - `sla:write`
|
|
35396
35762
|
*
|
|
35397
35763
|
* @tags slas
|
|
35398
35764
|
* @name SlasUpdate
|
|
@@ -35497,7 +35863,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
35497
35863
|
*/
|
|
35498
35864
|
snapInsUpdate: (data: SnapInsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<SnapInsUpdateResponse, any, {}>>;
|
|
35499
35865
|
/**
|
|
35500
|
-
* @description Executes deferred snap-kit actions.
|
|
35866
|
+
* @description Executes deferred snap-kit actions. **Required scopes:** - `snap_widget:write` OR `snap_widget:all`
|
|
35501
35867
|
*
|
|
35502
35868
|
* @tags snap-kit-execution
|
|
35503
35869
|
* @name SnapKitActionExecuteDeferred
|
|
@@ -35507,7 +35873,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
35507
35873
|
*/
|
|
35508
35874
|
snapKitActionExecuteDeferred: (data: SnapKitActionExecuteDeferredRequest, params?: RequestParams) => Promise<AxiosResponse<SnapKitActionExecuteDeferredResponse, any, {}>>;
|
|
35509
35875
|
/**
|
|
35510
|
-
* @description Create a snap widget object.
|
|
35876
|
+
* @description Create a snap widget object. **Required scopes:** - `snap_widget:write` OR `snap_widget:all`
|
|
35511
35877
|
*
|
|
35512
35878
|
* @tags snap-widgets
|
|
35513
35879
|
* @name SnapWidgetsCreate
|
|
@@ -35517,7 +35883,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
35517
35883
|
*/
|
|
35518
35884
|
snapWidgetsCreate: (data: SnapWidgetsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<SnapWidgetsCreateResponse, any, {}>>;
|
|
35519
35885
|
/**
|
|
35520
|
-
* @description Creates a stage diagram.
|
|
35886
|
+
* @description Creates a stage diagram. **Required scopes:** - `stage_diagram:write`
|
|
35521
35887
|
*
|
|
35522
35888
|
* @tags customization
|
|
35523
35889
|
* @name StageDiagramsCreate
|
|
@@ -35527,7 +35893,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
35527
35893
|
*/
|
|
35528
35894
|
stageDiagramsCreate: (data: StageDiagramsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<StageDiagramsCreateResponse, any, {}>>;
|
|
35529
35895
|
/**
|
|
35530
|
-
* @description Gets a stage diagram.
|
|
35896
|
+
* @description Gets a stage diagram. **Required scopes:** No scopes required.
|
|
35531
35897
|
*
|
|
35532
35898
|
* @tags customization
|
|
35533
35899
|
* @name StageDiagramsGet
|
|
@@ -35554,7 +35920,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
35554
35920
|
leaf_type?: string;
|
|
35555
35921
|
}, params?: RequestParams) => Promise<AxiosResponse<StageDiagramsGetResponse, any, {}>>;
|
|
35556
35922
|
/**
|
|
35557
|
-
* @description Gets a stage diagram.
|
|
35923
|
+
* @description Gets a stage diagram. **Required scopes:** No scopes required.
|
|
35558
35924
|
*
|
|
35559
35925
|
* @tags customization
|
|
35560
35926
|
* @name StageDiagramsGetPost
|
|
@@ -35564,7 +35930,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
35564
35930
|
*/
|
|
35565
35931
|
stageDiagramsGetPost: (data: StageDiagramsGetRequest, params?: RequestParams) => Promise<AxiosResponse<StageDiagramsGetResponse, any, {}>>;
|
|
35566
35932
|
/**
|
|
35567
|
-
* @description Lists stage diagrams.
|
|
35933
|
+
* @description Lists stage diagrams. **Required scopes:** No scopes required.
|
|
35568
35934
|
*
|
|
35569
35935
|
* @tags customization
|
|
35570
35936
|
* @name StageDiagramsList
|
|
@@ -35594,7 +35960,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
35594
35960
|
sort_by?: string[];
|
|
35595
35961
|
}, params?: RequestParams) => Promise<AxiosResponse<StageDiagramsListResponse, any, {}>>;
|
|
35596
35962
|
/**
|
|
35597
|
-
* @description Lists stage diagrams.
|
|
35963
|
+
* @description Lists stage diagrams. **Required scopes:** No scopes required.
|
|
35598
35964
|
*
|
|
35599
35965
|
* @tags customization
|
|
35600
35966
|
* @name StageDiagramsListPost
|
|
@@ -35604,7 +35970,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
35604
35970
|
*/
|
|
35605
35971
|
stageDiagramsListPost: (data: StageDiagramsListRequest, params?: RequestParams) => Promise<AxiosResponse<StageDiagramsListResponse, any, {}>>;
|
|
35606
35972
|
/**
|
|
35607
|
-
* @description Updates a stage diagram.
|
|
35973
|
+
* @description Updates a stage diagram. **Required scopes:** - `stage_diagram:write`
|
|
35608
35974
|
*
|
|
35609
35975
|
* @tags customization
|
|
35610
35976
|
* @name StageDiagramsUpdate
|
|
@@ -35614,7 +35980,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
35614
35980
|
*/
|
|
35615
35981
|
stageDiagramsUpdate: (data: StageDiagramsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<StageDiagramsUpdateResponse, any, {}>>;
|
|
35616
35982
|
/**
|
|
35617
|
-
* @description Creates a custom stage.
|
|
35983
|
+
* @description Creates a custom stage. **Required scopes:** - `custom_stage:write`
|
|
35618
35984
|
*
|
|
35619
35985
|
* @tags customization
|
|
35620
35986
|
* @name CustomStagesCreate
|
|
@@ -35624,7 +35990,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
35624
35990
|
*/
|
|
35625
35991
|
customStagesCreate: (data: CustomStagesCreateRequest, params?: RequestParams) => Promise<AxiosResponse<CustomStagesCreateResponse, any, {}>>;
|
|
35626
35992
|
/**
|
|
35627
|
-
* @description Gets a custom stage.
|
|
35993
|
+
* @description Gets a custom stage. **Required scopes:** No scopes required.
|
|
35628
35994
|
*
|
|
35629
35995
|
* @tags customization
|
|
35630
35996
|
* @name CustomStagesGet
|
|
@@ -35640,7 +36006,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
35640
36006
|
id: string;
|
|
35641
36007
|
}, params?: RequestParams) => Promise<AxiosResponse<CustomStagesGetResponse, any, {}>>;
|
|
35642
36008
|
/**
|
|
35643
|
-
* @description Gets a custom stage.
|
|
36009
|
+
* @description Gets a custom stage. **Required scopes:** No scopes required.
|
|
35644
36010
|
*
|
|
35645
36011
|
* @tags customization
|
|
35646
36012
|
* @name CustomStagesGetPost
|
|
@@ -35650,7 +36016,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
35650
36016
|
*/
|
|
35651
36017
|
customStagesGetPost: (data: CustomStagesGetRequest, params?: RequestParams) => Promise<AxiosResponse<CustomStagesGetResponse, any, {}>>;
|
|
35652
36018
|
/**
|
|
35653
|
-
* @description Lists custom stages.
|
|
36019
|
+
* @description Lists custom stages. **Required scopes:** No scopes required.
|
|
35654
36020
|
*
|
|
35655
36021
|
* @tags customization
|
|
35656
36022
|
* @name CustomStagesList
|
|
@@ -35678,7 +36044,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
35678
36044
|
sort_by?: string[];
|
|
35679
36045
|
}, params?: RequestParams) => Promise<AxiosResponse<CustomStagesListResponse, any, {}>>;
|
|
35680
36046
|
/**
|
|
35681
|
-
* @description Lists custom stages.
|
|
36047
|
+
* @description Lists custom stages. **Required scopes:** No scopes required.
|
|
35682
36048
|
*
|
|
35683
36049
|
* @tags customization
|
|
35684
36050
|
* @name CustomStagesListPost
|
|
@@ -35688,7 +36054,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
35688
36054
|
*/
|
|
35689
36055
|
customStagesListPost: (data: CustomStagesListRequest, params?: RequestParams) => Promise<AxiosResponse<CustomStagesListResponse, any, {}>>;
|
|
35690
36056
|
/**
|
|
35691
|
-
* @description Updates a custom stage.
|
|
36057
|
+
* @description Updates a custom stage. **Required scopes:** - `custom_stage:write`
|
|
35692
36058
|
*
|
|
35693
36059
|
* @tags customization
|
|
35694
36060
|
* @name CustomStagesUpdate
|
|
@@ -35698,7 +36064,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
35698
36064
|
*/
|
|
35699
36065
|
customStagesUpdate: (data: CustomStagesUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<CustomStagesUpdateResponse, any, {}>>;
|
|
35700
36066
|
/**
|
|
35701
|
-
* @description Creates a custom state.
|
|
36067
|
+
* @description Creates a custom state. **Required scopes:** - `custom_state:write`
|
|
35702
36068
|
*
|
|
35703
36069
|
* @tags customization
|
|
35704
36070
|
* @name CustomStatesCreate
|
|
@@ -35708,7 +36074,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
35708
36074
|
*/
|
|
35709
36075
|
customStatesCreate: (data: CustomStatesCreateRequest, params?: RequestParams) => Promise<AxiosResponse<CustomStatesCreateResponse, any, {}>>;
|
|
35710
36076
|
/**
|
|
35711
|
-
* @description Gets a custom state.
|
|
36077
|
+
* @description Gets a custom state. **Required scopes:** No scopes required.
|
|
35712
36078
|
*
|
|
35713
36079
|
* @tags customization
|
|
35714
36080
|
* @name CustomStatesGet
|
|
@@ -35724,7 +36090,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
35724
36090
|
id: string;
|
|
35725
36091
|
}, params?: RequestParams) => Promise<AxiosResponse<CustomStatesGetResponse, any, {}>>;
|
|
35726
36092
|
/**
|
|
35727
|
-
* @description Gets a custom state.
|
|
36093
|
+
* @description Gets a custom state. **Required scopes:** No scopes required.
|
|
35728
36094
|
*
|
|
35729
36095
|
* @tags customization
|
|
35730
36096
|
* @name CustomStatesGetPost
|
|
@@ -35734,7 +36100,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
35734
36100
|
*/
|
|
35735
36101
|
customStatesGetPost: (data: CustomStatesGetRequest, params?: RequestParams) => Promise<AxiosResponse<CustomStatesGetResponse, any, {}>>;
|
|
35736
36102
|
/**
|
|
35737
|
-
* @description Lists custom states.
|
|
36103
|
+
* @description Lists custom states. **Required scopes:** No scopes required.
|
|
35738
36104
|
*
|
|
35739
36105
|
* @tags customization
|
|
35740
36106
|
* @name CustomStatesList
|
|
@@ -35764,7 +36130,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
35764
36130
|
sort_by?: string[];
|
|
35765
36131
|
}, params?: RequestParams) => Promise<AxiosResponse<CustomStatesListResponse, any, {}>>;
|
|
35766
36132
|
/**
|
|
35767
|
-
* @description Lists custom states.
|
|
36133
|
+
* @description Lists custom states. **Required scopes:** No scopes required.
|
|
35768
36134
|
*
|
|
35769
36135
|
* @tags customization
|
|
35770
36136
|
* @name CustomStatesListPost
|
|
@@ -35774,7 +36140,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
35774
36140
|
*/
|
|
35775
36141
|
customStatesListPost: (data: CustomStatesListRequest, params?: RequestParams) => Promise<AxiosResponse<CustomStatesListResponse, any, {}>>;
|
|
35776
36142
|
/**
|
|
35777
|
-
* @description Updates a custom state.
|
|
36143
|
+
* @description Updates a custom state. **Required scopes:** - `custom_state:write`
|
|
35778
36144
|
*
|
|
35779
36145
|
* @tags customization
|
|
35780
36146
|
* @name CustomStatesUpdate
|
|
@@ -35860,7 +36226,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
35860
36226
|
*/
|
|
35861
36227
|
subscribersUpdate: (data: SubscribersUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
|
|
35862
36228
|
/**
|
|
35863
|
-
* @description Creates a schema for survey, which includes name and description of schema.
|
|
36229
|
+
* @description Creates a schema for survey, which includes name and description of schema. **Required scopes:** - `survey:write` OR `survey:all`
|
|
35864
36230
|
*
|
|
35865
36231
|
* @tags surveys
|
|
35866
36232
|
* @name SurveysCreate
|
|
@@ -35870,7 +36236,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
35870
36236
|
*/
|
|
35871
36237
|
surveysCreate: (data: SurveysCreateRequest, params?: RequestParams) => Promise<AxiosResponse<SurveysCreateResponse, any, {}>>;
|
|
35872
36238
|
/**
|
|
35873
|
-
* @description Deletes the specified survey.
|
|
36239
|
+
* @description Deletes the specified survey. **Required scopes:** - `survey:all`
|
|
35874
36240
|
*
|
|
35875
36241
|
* @tags surveys
|
|
35876
36242
|
* @name SurveysDelete
|
|
@@ -35880,7 +36246,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
35880
36246
|
*/
|
|
35881
36247
|
surveysDelete: (data: SurveysDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
|
|
35882
36248
|
/**
|
|
35883
|
-
* @description Gets a survey given the ID.
|
|
36249
|
+
* @description Gets a survey given the ID. **Required scopes:** - `survey:read` OR `survey:write` OR `survey:all`
|
|
35884
36250
|
*
|
|
35885
36251
|
* @tags surveys
|
|
35886
36252
|
* @name SurveysGet
|
|
@@ -35896,7 +36262,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
35896
36262
|
id: string;
|
|
35897
36263
|
}, params?: RequestParams) => Promise<AxiosResponse<SurveysGetResponse, any, {}>>;
|
|
35898
36264
|
/**
|
|
35899
|
-
* @description Gets a survey given the ID.
|
|
36265
|
+
* @description Gets a survey given the ID. **Required scopes:** - `survey:read` OR `survey:write` OR `survey:all`
|
|
35900
36266
|
*
|
|
35901
36267
|
* @tags surveys
|
|
35902
36268
|
* @name SurveysGetPost
|
|
@@ -35906,7 +36272,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
35906
36272
|
*/
|
|
35907
36273
|
surveysGetPost: (data: SurveysGetRequest, params?: RequestParams) => Promise<AxiosResponse<SurveysGetResponse, any, {}>>;
|
|
35908
36274
|
/**
|
|
35909
|
-
* @description List surveys requested by the user.
|
|
36275
|
+
* @description List surveys requested by the user. **Required scopes:** - `survey:read` OR `survey:write` OR `survey:all`
|
|
35910
36276
|
*
|
|
35911
36277
|
* @tags surveys
|
|
35912
36278
|
* @name SurveysList
|
|
@@ -35943,7 +36309,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
35943
36309
|
sort_by?: string[];
|
|
35944
36310
|
}, params?: RequestParams) => Promise<AxiosResponse<SurveysListResponse, any, {}>>;
|
|
35945
36311
|
/**
|
|
35946
|
-
* @description List surveys requested by the user.
|
|
36312
|
+
* @description List surveys requested by the user. **Required scopes:** - `survey:read` OR `survey:write` OR `survey:all`
|
|
35947
36313
|
*
|
|
35948
36314
|
* @tags surveys
|
|
35949
36315
|
* @name SurveysListPost
|
|
@@ -35953,7 +36319,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
35953
36319
|
*/
|
|
35954
36320
|
surveysListPost: (data: SurveysListRequest, params?: RequestParams) => Promise<AxiosResponse<SurveysListResponse, any, {}>>;
|
|
35955
36321
|
/**
|
|
35956
|
-
* @description List survey responses requested by the user.
|
|
36322
|
+
* @description List survey responses requested by the user. **Required scopes:** - `survey_response:read` OR `survey_response:write` OR `survey_response:all`
|
|
35957
36323
|
*
|
|
35958
36324
|
* @tags surveys
|
|
35959
36325
|
* @name SurveysResponsesList
|
|
@@ -36007,7 +36373,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
36007
36373
|
surveys?: string[];
|
|
36008
36374
|
}, params?: RequestParams) => Promise<AxiosResponse<SurveysResponsesListResponse, any, {}>>;
|
|
36009
36375
|
/**
|
|
36010
|
-
* @description List survey responses requested by the user.
|
|
36376
|
+
* @description List survey responses requested by the user. **Required scopes:** - `survey_response:read` OR `survey_response:write` OR `survey_response:all`
|
|
36011
36377
|
*
|
|
36012
36378
|
* @tags surveys
|
|
36013
36379
|
* @name SurveysResponsesListPost
|
|
@@ -36017,7 +36383,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
36017
36383
|
*/
|
|
36018
36384
|
surveysResponsesListPost: (data: SurveysResponsesListRequest, params?: RequestParams) => Promise<AxiosResponse<SurveysResponsesListResponse, any, {}>>;
|
|
36019
36385
|
/**
|
|
36020
|
-
* @description Updates a user's survey response for the provided dispatch ID.
|
|
36386
|
+
* @description Updates a user's survey response for the provided dispatch ID. **Required scopes:** - `survey_response:write` OR `survey_response:all`
|
|
36021
36387
|
*
|
|
36022
36388
|
* @tags surveys
|
|
36023
36389
|
* @name SurveysResponsesUpdate
|
|
@@ -36027,7 +36393,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
36027
36393
|
*/
|
|
36028
36394
|
surveysResponsesUpdate: (data: SurveysResponsesUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
|
|
36029
36395
|
/**
|
|
36030
|
-
* @description Sends a survey on the specified channels.
|
|
36396
|
+
* @description Sends a survey on the specified channels. **Required scopes:** - `survey:write` OR `survey:all`
|
|
36031
36397
|
*
|
|
36032
36398
|
* @tags surveys
|
|
36033
36399
|
* @name SurveysSend
|
|
@@ -36037,7 +36403,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
36037
36403
|
*/
|
|
36038
36404
|
surveysSend: (data: SurveysSendRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
|
|
36039
36405
|
/**
|
|
36040
|
-
* @description Submits a user response to a survey, which is defined by the survey ID.
|
|
36406
|
+
* @description Submits a user response to a survey, which is defined by the survey ID. **Required scopes:** - `survey_response:write` OR `survey_response:all`
|
|
36041
36407
|
*
|
|
36042
36408
|
* @tags surveys
|
|
36043
36409
|
* @name SurveysSubmit
|
|
@@ -36047,7 +36413,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
36047
36413
|
*/
|
|
36048
36414
|
surveysSubmit: (data: SurveysSubmitRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
|
|
36049
36415
|
/**
|
|
36050
|
-
* @description Updates a survey's metadata.
|
|
36416
|
+
* @description Updates a survey's metadata. **Required scopes:** - `survey:write` OR `survey:all`
|
|
36051
36417
|
*
|
|
36052
36418
|
* @tags surveys
|
|
36053
36419
|
* @name SurveysUpdate
|
|
@@ -36057,7 +36423,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
36057
36423
|
*/
|
|
36058
36424
|
surveysUpdate: (data: SurveysUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<SurveysUpdateResponse, any, {}>>;
|
|
36059
36425
|
/**
|
|
36060
|
-
* @description Lists system users within your organization. **Required scopes:**
|
|
36426
|
+
* @description Lists system users within your organization. **Required scopes:** Default Scopes unavailable for this API.
|
|
36061
36427
|
*
|
|
36062
36428
|
* @tags sys-users
|
|
36063
36429
|
* @name SysUsersList
|
|
@@ -36087,7 +36453,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
36087
36453
|
sort_by?: string[];
|
|
36088
36454
|
}, params?: RequestParams) => Promise<AxiosResponse<SysUsersListResponse, any, {}>>;
|
|
36089
36455
|
/**
|
|
36090
|
-
* @description Lists system users within your organization. **Required scopes:**
|
|
36456
|
+
* @description Lists system users within your organization. **Required scopes:** Default Scopes unavailable for this API.
|
|
36091
36457
|
*
|
|
36092
36458
|
* @tags sys-users
|
|
36093
36459
|
* @name SysUsersListPost
|
|
@@ -36097,7 +36463,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
36097
36463
|
*/
|
|
36098
36464
|
sysUsersListPost: (data: SysUsersListRequest, params?: RequestParams) => Promise<AxiosResponse<SysUsersListResponse, any, {}>>;
|
|
36099
36465
|
/**
|
|
36100
|
-
* @description Updates the system user. **Required scopes:**
|
|
36466
|
+
* @description Updates the system user. **Required scopes:** Default Scopes unavailable for this API.
|
|
36101
36467
|
*
|
|
36102
36468
|
* @tags sys-users
|
|
36103
36469
|
* @name SysUsersUpdate
|
|
@@ -36107,7 +36473,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
36107
36473
|
*/
|
|
36108
36474
|
sysUsersUpdate: (data: SysUsersUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<SysUsersUpdateResponse, any, {}>>;
|
|
36109
36475
|
/**
|
|
36110
|
-
* @description Creates a new tag, which is used to create associations between objects and a logical concept denoted by the tag's name.
|
|
36476
|
+
* @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`
|
|
36111
36477
|
*
|
|
36112
36478
|
* @tags tags
|
|
36113
36479
|
* @name TagsCreate
|
|
@@ -36117,7 +36483,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
36117
36483
|
*/
|
|
36118
36484
|
tagsCreate: (data: TagsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<TagsCreateResponse, any, {}>>;
|
|
36119
36485
|
/**
|
|
36120
|
-
* @description Deletes a tag.
|
|
36486
|
+
* @description Deletes a tag. **Required scopes:** - `tag:all`
|
|
36121
36487
|
*
|
|
36122
36488
|
* @tags tags
|
|
36123
36489
|
* @name TagsDelete
|
|
@@ -36127,7 +36493,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
36127
36493
|
*/
|
|
36128
36494
|
tagsDelete: (data: TagsDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
|
|
36129
36495
|
/**
|
|
36130
|
-
* @description Gets a tag's information.
|
|
36496
|
+
* @description Gets a tag's information. **Required scopes:** - `tag:read` OR `tag:write` OR `tag:all`
|
|
36131
36497
|
*
|
|
36132
36498
|
* @tags tags
|
|
36133
36499
|
* @name TagsGet
|
|
@@ -36144,7 +36510,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
36144
36510
|
id: string;
|
|
36145
36511
|
}, params?: RequestParams) => Promise<AxiosResponse<TagsGetResponse, any, {}>>;
|
|
36146
36512
|
/**
|
|
36147
|
-
* @description Gets a tag's information.
|
|
36513
|
+
* @description Gets a tag's information. **Required scopes:** - `tag:read` OR `tag:write` OR `tag:all`
|
|
36148
36514
|
*
|
|
36149
36515
|
* @tags tags
|
|
36150
36516
|
* @name TagsGetPost
|
|
@@ -36154,7 +36520,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
36154
36520
|
*/
|
|
36155
36521
|
tagsGetPost: (data: TagsGetRequest, params?: RequestParams) => Promise<AxiosResponse<TagsGetResponse, any, {}>>;
|
|
36156
36522
|
/**
|
|
36157
|
-
* @description Lists the available tags.
|
|
36523
|
+
* @description Lists the available tags. **Required scopes:** - `tag:read` OR `tag:write` OR `tag:all`
|
|
36158
36524
|
*
|
|
36159
36525
|
* @tags tags
|
|
36160
36526
|
* @name TagsList
|
|
@@ -36185,7 +36551,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
36185
36551
|
sort_by?: string[];
|
|
36186
36552
|
}, params?: RequestParams) => Promise<AxiosResponse<TagsListResponse, any, {}>>;
|
|
36187
36553
|
/**
|
|
36188
|
-
* @description Lists the available tags.
|
|
36554
|
+
* @description Lists the available tags. **Required scopes:** - `tag:read` OR `tag:write` OR `tag:all`
|
|
36189
36555
|
*
|
|
36190
36556
|
* @tags tags
|
|
36191
36557
|
* @name TagsListPost
|
|
@@ -36195,7 +36561,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
36195
36561
|
*/
|
|
36196
36562
|
tagsListPost: (data: TagsListRequest, params?: RequestParams) => Promise<AxiosResponse<TagsListResponse, any, {}>>;
|
|
36197
36563
|
/**
|
|
36198
|
-
* @description Updates a tag's information.
|
|
36564
|
+
* @description Updates a tag's information. **Required scopes:** - `tag:write` OR `tag:all`
|
|
36199
36565
|
*
|
|
36200
36566
|
* @tags tags
|
|
36201
36567
|
* @name TagsUpdate
|
|
@@ -36205,7 +36571,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
36205
36571
|
*/
|
|
36206
36572
|
tagsUpdate: (data: TagsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<TagsUpdateResponse, any, {}>>;
|
|
36207
36573
|
/**
|
|
36208
|
-
* @description Creates a new entry on an object's timeline.
|
|
36574
|
+
* @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).
|
|
36209
36575
|
*
|
|
36210
36576
|
* @tags timeline-entries
|
|
36211
36577
|
* @name TimelineEntriesCreate
|
|
@@ -36215,7 +36581,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
36215
36581
|
*/
|
|
36216
36582
|
timelineEntriesCreate: (data: TimelineEntriesCreateRequest, params?: RequestParams) => Promise<AxiosResponse<TimelineEntriesCreateResponse, any, {}>>;
|
|
36217
36583
|
/**
|
|
36218
|
-
* @description Deletes an entry from an object's timeline.
|
|
36584
|
+
* @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).
|
|
36219
36585
|
*
|
|
36220
36586
|
* @tags timeline-entries
|
|
36221
36587
|
* @name TimelineEntriesDelete
|
|
@@ -36225,7 +36591,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
36225
36591
|
*/
|
|
36226
36592
|
timelineEntriesDelete: (data: TimelineEntriesDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
|
|
36227
36593
|
/**
|
|
36228
|
-
* @description Gets an entry on an object's timeline.
|
|
36594
|
+
* @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).
|
|
36229
36595
|
*
|
|
36230
36596
|
* @tags timeline-entries
|
|
36231
36597
|
* @name TimelineEntriesGet
|
|
@@ -36250,7 +36616,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
36250
36616
|
external_ref?: string;
|
|
36251
36617
|
}, params?: RequestParams) => Promise<AxiosResponse<TimelineEntriesGetResponse, any, {}>>;
|
|
36252
36618
|
/**
|
|
36253
|
-
* @description Gets an entry on an object's timeline.
|
|
36619
|
+
* @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).
|
|
36254
36620
|
*
|
|
36255
36621
|
* @tags timeline-entries
|
|
36256
36622
|
* @name TimelineEntriesGetPost
|
|
@@ -36260,7 +36626,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
36260
36626
|
*/
|
|
36261
36627
|
timelineEntriesGetPost: (data: TimelineEntriesGetRequest, params?: RequestParams) => Promise<AxiosResponse<TimelineEntriesGetResponse, any, {}>>;
|
|
36262
36628
|
/**
|
|
36263
|
-
* @description Lists the timeline entries for an object.
|
|
36629
|
+
* @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).
|
|
36264
36630
|
*
|
|
36265
36631
|
* @tags timeline-entries
|
|
36266
36632
|
* @name TimelineEntriesList
|
|
@@ -36280,8 +36646,14 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
36280
36646
|
/**
|
|
36281
36647
|
* The collection(s) to list entries from, otherwise if not provided,
|
|
36282
36648
|
* all entries are returned.
|
|
36649
|
+
* @maxItems 1
|
|
36283
36650
|
*/
|
|
36284
36651
|
collections?: TimelineEntriesCollection[];
|
|
36652
|
+
/**
|
|
36653
|
+
* Filters for entries created by any of the provided users.
|
|
36654
|
+
* @example ["DEVU-12345"]
|
|
36655
|
+
*/
|
|
36656
|
+
created_by?: string[];
|
|
36285
36657
|
/**
|
|
36286
36658
|
* Filters for objects created after the provided timestamp (inclusive).
|
|
36287
36659
|
* @format date-time
|
|
@@ -36330,7 +36702,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
36330
36702
|
visibility?: TimelineEntryVisibility[];
|
|
36331
36703
|
}, params?: RequestParams) => Promise<AxiosResponse<TimelineEntriesListResponse, any, {}>>;
|
|
36332
36704
|
/**
|
|
36333
|
-
* @description Lists the timeline entries for an object.
|
|
36705
|
+
* @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).
|
|
36334
36706
|
*
|
|
36335
36707
|
* @tags timeline-entries
|
|
36336
36708
|
* @name TimelineEntriesListPost
|
|
@@ -36340,7 +36712,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
36340
36712
|
*/
|
|
36341
36713
|
timelineEntriesListPost: (data: TimelineEntriesListRequest, params?: RequestParams) => Promise<AxiosResponse<TimelineEntriesListResponse, any, {}>>;
|
|
36342
36714
|
/**
|
|
36343
|
-
* @description Updates an entry on an object's timeline.
|
|
36715
|
+
* @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).
|
|
36344
36716
|
*
|
|
36345
36717
|
* @tags timeline-entries
|
|
36346
36718
|
* @name TimelineEntriesUpdate
|
|
@@ -36532,7 +36904,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
36532
36904
|
*/
|
|
36533
36905
|
vistasCreate: (data: VistasCreateRequest, params?: RequestParams) => Promise<AxiosResponse<VistasCreateResponse, any, {}>>;
|
|
36534
36906
|
/**
|
|
36535
|
-
* @description Deletes the requested vista.
|
|
36907
|
+
* @description Deletes the requested vista. **Required scopes:** - `vista:all`
|
|
36536
36908
|
*
|
|
36537
36909
|
* @tags vistas
|
|
36538
36910
|
* @name VistasDelete
|
|
@@ -36542,7 +36914,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
36542
36914
|
*/
|
|
36543
36915
|
vistasDelete: (data: VistasDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
|
|
36544
36916
|
/**
|
|
36545
|
-
* @description Gets the requested vistas's information.
|
|
36917
|
+
* @description Gets the requested vistas's information. **Required scopes:** - `vista:read` OR `vista:write` OR `vista:all`
|
|
36546
36918
|
*
|
|
36547
36919
|
* @tags vistas
|
|
36548
36920
|
* @name VistasGet
|
|
@@ -36559,7 +36931,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
36559
36931
|
id: string;
|
|
36560
36932
|
}, params?: RequestParams) => Promise<AxiosResponse<VistasGetResponse, any, {}>>;
|
|
36561
36933
|
/**
|
|
36562
|
-
* @description Gets the requested vistas's information.
|
|
36934
|
+
* @description Gets the requested vistas's information. **Required scopes:** - `vista:read` OR `vista:write` OR `vista:all`
|
|
36563
36935
|
*
|
|
36564
36936
|
* @tags vistas
|
|
36565
36937
|
* @name VistasGetPost
|
|
@@ -36569,7 +36941,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
36569
36941
|
*/
|
|
36570
36942
|
vistasGetPost: (data: VistasGetRequest, params?: RequestParams) => Promise<AxiosResponse<VistasGetResponse, any, {}>>;
|
|
36571
36943
|
/**
|
|
36572
|
-
* @description Deletes the requested vista group item
|
|
36944
|
+
* @description Deletes the requested vista group item **Required scopes:** - `vista:all` No scopes required for default vistas.
|
|
36573
36945
|
*
|
|
36574
36946
|
* @tags vistas
|
|
36575
36947
|
* @name VistasGroupsDelete
|
|
@@ -36579,7 +36951,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
36579
36951
|
*/
|
|
36580
36952
|
vistasGroupsDelete: (data: VistasGroupsDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
|
|
36581
36953
|
/**
|
|
36582
|
-
* @description Gets the requested vista group item's information.
|
|
36954
|
+
* @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.
|
|
36583
36955
|
*
|
|
36584
36956
|
* @tags vistas
|
|
36585
36957
|
* @name VistasGroupsGet
|
|
@@ -36595,7 +36967,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
36595
36967
|
id: string;
|
|
36596
36968
|
}, params?: RequestParams) => Promise<AxiosResponse<VistasGroupsGetResponse, any, {}>>;
|
|
36597
36969
|
/**
|
|
36598
|
-
* @description Gets the requested vista group item's information.
|
|
36970
|
+
* @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.
|
|
36599
36971
|
*
|
|
36600
36972
|
* @tags vistas
|
|
36601
36973
|
* @name VistasGroupsGetPost
|
|
@@ -36605,7 +36977,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
36605
36977
|
*/
|
|
36606
36978
|
vistasGroupsGetPost: (data: VistasGroupsGetRequest, params?: RequestParams) => Promise<AxiosResponse<VistasGroupsGetResponse, any, {}>>;
|
|
36607
36979
|
/**
|
|
36608
|
-
* @description Lists the available vista group items.
|
|
36980
|
+
* @description Lists the available vista group items. **Required scopes:** - `vista:read` OR `vista:write` OR `vista:all` No scopes required for default vistas.
|
|
36609
36981
|
*
|
|
36610
36982
|
* @tags vistas
|
|
36611
36983
|
* @name VistasGroupsList
|
|
@@ -36667,7 +37039,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
36667
37039
|
type?: GroupItemType[];
|
|
36668
37040
|
}, params?: RequestParams) => Promise<AxiosResponse<VistasGroupsListResponse, any, {}>>;
|
|
36669
37041
|
/**
|
|
36670
|
-
* @description Lists the available vista group items.
|
|
37042
|
+
* @description Lists the available vista group items. **Required scopes:** - `vista:read` OR `vista:write` OR `vista:all` No scopes required for default vistas.
|
|
36671
37043
|
*
|
|
36672
37044
|
* @tags vistas
|
|
36673
37045
|
* @name VistasGroupsListPost
|
|
@@ -36677,7 +37049,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
36677
37049
|
*/
|
|
36678
37050
|
vistasGroupsListPost: (data: VistasGroupsListRequest, params?: RequestParams) => Promise<AxiosResponse<VistasGroupsListResponse, any, {}>>;
|
|
36679
37051
|
/**
|
|
36680
|
-
* @description Lists the available vistas.
|
|
37052
|
+
* @description Lists the available vistas. **Required scopes:** - `vista:read` OR `vista:write` OR `vista:all`
|
|
36681
37053
|
*
|
|
36682
37054
|
* @tags vistas
|
|
36683
37055
|
* @name VistasList
|
|
@@ -36739,7 +37111,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
36739
37111
|
type?: VistaType[];
|
|
36740
37112
|
}, params?: RequestParams) => Promise<AxiosResponse<VistasListResponse, any, {}>>;
|
|
36741
37113
|
/**
|
|
36742
|
-
* @description Lists the available vistas.
|
|
37114
|
+
* @description Lists the available vistas. **Required scopes:** - `vista:read` OR `vista:write` OR `vista:all`
|
|
36743
37115
|
*
|
|
36744
37116
|
* @tags vistas
|
|
36745
37117
|
* @name VistasListPost
|
|
@@ -36749,7 +37121,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
36749
37121
|
*/
|
|
36750
37122
|
vistasListPost: (data: VistasListRequest, params?: RequestParams) => Promise<AxiosResponse<VistasListResponse, any, {}>>;
|
|
36751
37123
|
/**
|
|
36752
|
-
* @description Change state of a web crawler job to pause or resume it back to running.
|
|
37124
|
+
* @description Change state of a web crawler job to pause or resume it back to running. **Required scopes:** - `web_crawler_job:all`
|
|
36753
37125
|
*
|
|
36754
37126
|
* @tags web-crawler-job
|
|
36755
37127
|
* @name WebCrawlerJobsControl
|
|
@@ -36759,7 +37131,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
36759
37131
|
*/
|
|
36760
37132
|
webCrawlerJobsControl: (data: WebCrawlerJobsControlRequest, params?: RequestParams) => Promise<AxiosResponse<WebCrawlerJobsControlResponse, any, {}>>;
|
|
36761
37133
|
/**
|
|
36762
|
-
* @description Creates a web crawler job whose objective is to crawl the provided URLs/sitemaps and generate corresponding webpages as artifacts.
|
|
37134
|
+
* @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`
|
|
36763
37135
|
*
|
|
36764
37136
|
* @tags web-crawler-job
|
|
36765
37137
|
* @name CreateWebCrawlerJob
|
|
@@ -36769,7 +37141,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
36769
37141
|
*/
|
|
36770
37142
|
createWebCrawlerJob: (data: WebCrawlerJobsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<WebCrawlerJobsCreateResponse, any, {}>>;
|
|
36771
37143
|
/**
|
|
36772
|
-
* @description Gets a web crawler job.
|
|
37144
|
+
* @description Gets a web crawler job. **Required scopes:** - `web_crawler_job:all`
|
|
36773
37145
|
*
|
|
36774
37146
|
* @tags web-crawler-job
|
|
36775
37147
|
* @name GetWebCrawlerJob
|
|
@@ -36785,7 +37157,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
36785
37157
|
id: string;
|
|
36786
37158
|
}, params?: RequestParams) => Promise<AxiosResponse<WebCrawlerJobsGetResponse, any, {}>>;
|
|
36787
37159
|
/**
|
|
36788
|
-
* @description Gets a web crawler job.
|
|
37160
|
+
* @description Gets a web crawler job. **Required scopes:** - `web_crawler_job:all`
|
|
36789
37161
|
*
|
|
36790
37162
|
* @tags web-crawler-job
|
|
36791
37163
|
* @name GetWebCrawlerJobPost
|
|
@@ -36795,7 +37167,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
36795
37167
|
*/
|
|
36796
37168
|
getWebCrawlerJobPost: (data: WebCrawlerJobsGetRequest, params?: RequestParams) => Promise<AxiosResponse<WebCrawlerJobsGetResponse, any, {}>>;
|
|
36797
37169
|
/**
|
|
36798
|
-
* @description Lists web crawler jobs.
|
|
37170
|
+
* @description Lists web crawler jobs. **Required scopes:** - `web_crawler_job:all`
|
|
36799
37171
|
*
|
|
36800
37172
|
* @tags web-crawler-job
|
|
36801
37173
|
* @name ListWebCrawlerJobs
|
|
@@ -36828,7 +37200,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
36828
37200
|
mode?: ListMode;
|
|
36829
37201
|
}, params?: RequestParams) => Promise<AxiosResponse<WebCrawlerJobsListResponse, any, {}>>;
|
|
36830
37202
|
/**
|
|
36831
|
-
* @description Lists web crawler jobs.
|
|
37203
|
+
* @description Lists web crawler jobs. **Required scopes:** - `web_crawler_job:all`
|
|
36832
37204
|
*
|
|
36833
37205
|
* @tags web-crawler-job
|
|
36834
37206
|
* @name ListWebCrawlerJobsPost
|
|
@@ -36838,7 +37210,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
36838
37210
|
*/
|
|
36839
37211
|
listWebCrawlerJobsPost: (data: WebCrawlerJobsListRequest, params?: RequestParams) => Promise<AxiosResponse<WebCrawlerJobsListResponse, any, {}>>;
|
|
36840
37212
|
/**
|
|
36841
|
-
* @description Creates a new webhook target.
|
|
37213
|
+
* @description Creates a new webhook target. **Required scopes:** Default Scopes unavailable for this API.
|
|
36842
37214
|
*
|
|
36843
37215
|
* @tags webhooks
|
|
36844
37216
|
* @name WebhooksCreate
|
|
@@ -36848,7 +37220,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
36848
37220
|
*/
|
|
36849
37221
|
webhooksCreate: (data: WebhooksCreateRequest, params?: RequestParams) => Promise<AxiosResponse<WebhooksCreateResponse, any, {}>>;
|
|
36850
37222
|
/**
|
|
36851
|
-
* @description Deletes the requested webhook.
|
|
37223
|
+
* @description Deletes the requested webhook. **Required scopes:** Default Scopes unavailable for this API.
|
|
36852
37224
|
*
|
|
36853
37225
|
* @tags webhooks
|
|
36854
37226
|
* @name WebhooksDelete
|
|
@@ -36858,7 +37230,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
36858
37230
|
*/
|
|
36859
37231
|
webhooksDelete: (data: WebhooksDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
|
|
36860
37232
|
/**
|
|
36861
|
-
* @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.
|
|
37233
|
+
* @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.
|
|
36862
37234
|
*
|
|
36863
37235
|
* @tags webhooks
|
|
36864
37236
|
* @name WebhooksEvent
|
|
@@ -36878,7 +37250,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
36878
37250
|
*/
|
|
36879
37251
|
webhooksFetch: (data: WebhooksFetchRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
|
|
36880
37252
|
/**
|
|
36881
|
-
* @description Gets the requested webhook's information.
|
|
37253
|
+
* @description Gets the requested webhook's information. **Required scopes:** Default Scopes unavailable for this API.
|
|
36882
37254
|
*
|
|
36883
37255
|
* @tags webhooks
|
|
36884
37256
|
* @name WebhooksGet
|
|
@@ -36895,7 +37267,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
36895
37267
|
id: string;
|
|
36896
37268
|
}, params?: RequestParams) => Promise<AxiosResponse<WebhooksGetResponse, any, {}>>;
|
|
36897
37269
|
/**
|
|
36898
|
-
* @description Gets the requested webhook's information.
|
|
37270
|
+
* @description Gets the requested webhook's information. **Required scopes:** Default Scopes unavailable for this API.
|
|
36899
37271
|
*
|
|
36900
37272
|
* @tags webhooks
|
|
36901
37273
|
* @name WebhooksGetPost
|
|
@@ -36905,7 +37277,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
36905
37277
|
*/
|
|
36906
37278
|
webhooksGetPost: (data: WebhooksGetRequest, params?: RequestParams) => Promise<AxiosResponse<WebhooksGetResponse, any, {}>>;
|
|
36907
37279
|
/**
|
|
36908
|
-
* @description Lists the webhooks.
|
|
37280
|
+
* @description Lists the webhooks. **Required scopes:** Default Scopes unavailable for this API.
|
|
36909
37281
|
*
|
|
36910
37282
|
* @tags webhooks
|
|
36911
37283
|
* @name WebhooksList
|
|
@@ -36918,7 +37290,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
36918
37290
|
status?: WebhookStatus[];
|
|
36919
37291
|
}, params?: RequestParams) => Promise<AxiosResponse<WebhooksListResponse, any, {}>>;
|
|
36920
37292
|
/**
|
|
36921
|
-
* @description Lists the webhooks.
|
|
37293
|
+
* @description Lists the webhooks. **Required scopes:** Default Scopes unavailable for this API.
|
|
36922
37294
|
*
|
|
36923
37295
|
* @tags webhooks
|
|
36924
37296
|
* @name WebhooksListPost
|
|
@@ -36928,7 +37300,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
36928
37300
|
*/
|
|
36929
37301
|
webhooksListPost: (data: WebhooksListRequest, params?: RequestParams) => Promise<AxiosResponse<WebhooksListResponse, any, {}>>;
|
|
36930
37302
|
/**
|
|
36931
|
-
* @description Updates the requested webhook.
|
|
37303
|
+
* @description Updates the requested webhook. **Required scopes:** Default Scopes unavailable for this API.
|
|
36932
37304
|
*
|
|
36933
37305
|
* @tags webhooks
|
|
36934
37306
|
* @name WebhooksUpdate
|
|
@@ -36974,7 +37346,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
36974
37346
|
*/
|
|
36975
37347
|
widgetsGetPost: (data: WidgetsGetRequest, params?: RequestParams) => Promise<AxiosResponse<WidgetsGetResponse, any, {}>>;
|
|
36976
37348
|
/**
|
|
36977
|
-
* @description Get count of work matching given filter.
|
|
37349
|
+
* @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` |
|
|
36978
37350
|
*
|
|
36979
37351
|
* @tags works
|
|
36980
37352
|
* @name WorksCount
|
|
@@ -37143,7 +37515,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
37143
37515
|
vista?: string;
|
|
37144
37516
|
}, params?: RequestParams) => Promise<AxiosResponse<WorksCountResponse, any, {}>>;
|
|
37145
37517
|
/**
|
|
37146
|
-
* @description Get count of work matching given filter.
|
|
37518
|
+
* @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` |
|
|
37147
37519
|
*
|
|
37148
37520
|
* @tags works
|
|
37149
37521
|
* @name WorksCountPost
|
|
@@ -37153,7 +37525,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
37153
37525
|
*/
|
|
37154
37526
|
worksCountPost: (data: WorksCountRequest, params?: RequestParams) => Promise<AxiosResponse<WorksCountResponse, any, {}>>;
|
|
37155
37527
|
/**
|
|
37156
|
-
* @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.
|
|
37528
|
+
* @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` |
|
|
37157
37529
|
*
|
|
37158
37530
|
* @tags works
|
|
37159
37531
|
* @name WorksCreate
|
|
@@ -37163,7 +37535,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
37163
37535
|
*/
|
|
37164
37536
|
worksCreate: (data: WorksCreateRequest, params?: RequestParams) => Promise<AxiosResponse<WorksCreateResponse, any, {}>>;
|
|
37165
37537
|
/**
|
|
37166
|
-
* @description Deletes a work item.
|
|
37538
|
+
* @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` |
|
|
37167
37539
|
*
|
|
37168
37540
|
* @tags works
|
|
37169
37541
|
* @name WorksDelete
|
|
@@ -37173,7 +37545,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
37173
37545
|
*/
|
|
37174
37546
|
worksDelete: (data: WorksDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
|
|
37175
37547
|
/**
|
|
37176
|
-
* @description Exports a collection of work items.
|
|
37548
|
+
* @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` |
|
|
37177
37549
|
*
|
|
37178
37550
|
* @tags works
|
|
37179
37551
|
* @name WorksExport
|
|
@@ -37350,7 +37722,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
37350
37722
|
vista?: string;
|
|
37351
37723
|
}, params?: RequestParams) => Promise<AxiosResponse<WorksExportResponse, any, {}>>;
|
|
37352
37724
|
/**
|
|
37353
|
-
* @description Exports a collection of work items.
|
|
37725
|
+
* @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` |
|
|
37354
37726
|
*
|
|
37355
37727
|
* @tags works
|
|
37356
37728
|
* @name WorksExportPost
|
|
@@ -37360,7 +37732,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
37360
37732
|
*/
|
|
37361
37733
|
worksExportPost: (data: WorksExportRequest, params?: RequestParams) => Promise<AxiosResponse<WorksExportResponse, any, {}>>;
|
|
37362
37734
|
/**
|
|
37363
|
-
* @description Gets a work item's information.
|
|
37735
|
+
* @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` |
|
|
37364
37736
|
*
|
|
37365
37737
|
* @tags works
|
|
37366
37738
|
* @name WorksGet
|
|
@@ -37377,7 +37749,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
37377
37749
|
id: string;
|
|
37378
37750
|
}, params?: RequestParams) => Promise<AxiosResponse<WorksGetResponse, any, {}>>;
|
|
37379
37751
|
/**
|
|
37380
|
-
* @description Gets a work item's information.
|
|
37752
|
+
* @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` |
|
|
37381
37753
|
*
|
|
37382
37754
|
* @tags works
|
|
37383
37755
|
* @name WorksGetPost
|
|
@@ -37387,7 +37759,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
37387
37759
|
*/
|
|
37388
37760
|
worksGetPost: (data: WorksGetRequest, params?: RequestParams) => Promise<AxiosResponse<WorksGetResponse, any, {}>>;
|
|
37389
37761
|
/**
|
|
37390
|
-
* @description Lists a collection of work items.
|
|
37762
|
+
* @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` |
|
|
37391
37763
|
*
|
|
37392
37764
|
* @tags works
|
|
37393
37765
|
* @name WorksList
|
|
@@ -37574,7 +37946,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
37574
37946
|
vista?: string;
|
|
37575
37947
|
}, params?: RequestParams) => Promise<AxiosResponse<WorksListResponse, any, {}>>;
|
|
37576
37948
|
/**
|
|
37577
|
-
* @description Lists a collection of work items.
|
|
37949
|
+
* @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` |
|
|
37578
37950
|
*
|
|
37579
37951
|
* @tags works
|
|
37580
37952
|
* @name WorksListPost
|
|
@@ -37584,7 +37956,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
37584
37956
|
*/
|
|
37585
37957
|
worksListPost: (data: WorksListRequest, params?: RequestParams) => Promise<AxiosResponse<WorksListResponse, any, {}>>;
|
|
37586
37958
|
/**
|
|
37587
|
-
* @description Updates a work item's information.
|
|
37959
|
+
* @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` |
|
|
37588
37960
|
*
|
|
37589
37961
|
* @tags works
|
|
37590
37962
|
* @name WorksUpdate
|