@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.
|
@@ -2608,6 +2608,14 @@ export declare enum BooleanExpressionType {
|
|
|
2608
2608
|
export type Capability = PartBase;
|
|
2609
2609
|
/** capability-summary */
|
|
2610
2610
|
export type CapabilitySummary = PartBaseSummary;
|
|
2611
|
+
/**
|
|
2612
|
+
* card-view-ui-metadata
|
|
2613
|
+
* Card view UI hint overrides.
|
|
2614
|
+
*/
|
|
2615
|
+
export interface CardViewUiMetadata {
|
|
2616
|
+
/** True if field is visible in card view. */
|
|
2617
|
+
is_visible?: boolean;
|
|
2618
|
+
}
|
|
2611
2619
|
/** chat */
|
|
2612
2620
|
export type Chat = Dm & {
|
|
2613
2621
|
type: ChatType;
|
|
@@ -3514,6 +3522,8 @@ export type Conversation = AtomBase & {
|
|
|
3514
3522
|
* @example "2023-01-01T12:00:00.000Z"
|
|
3515
3523
|
*/
|
|
3516
3524
|
actual_close_date?: string;
|
|
3525
|
+
/** The properties of an enum value. */
|
|
3526
|
+
ai_resolution_status?: EnumValue;
|
|
3517
3527
|
/** Details of the parts relevant to the conversation. */
|
|
3518
3528
|
applies_to_parts?: PartSummary[];
|
|
3519
3529
|
/** Channel IDs of the conversation. */
|
|
@@ -3626,6 +3636,26 @@ export interface ConversationsCreateRequest {
|
|
|
3626
3636
|
* @example "ACC-12345"
|
|
3627
3637
|
*/
|
|
3628
3638
|
account?: string;
|
|
3639
|
+
/**
|
|
3640
|
+
* The AI resolution status enum ID for the conversation. Stock
|
|
3641
|
+
* allowed values:
|
|
3642
|
+
* ```
|
|
3643
|
+
* {
|
|
3644
|
+
* "id": 1,
|
|
3645
|
+
* "label": "deflected",
|
|
3646
|
+
* "ordinal": 1,
|
|
3647
|
+
* "overridable": false
|
|
3648
|
+
* },
|
|
3649
|
+
* {
|
|
3650
|
+
* "id": 2,
|
|
3651
|
+
* "label": "escalated",
|
|
3652
|
+
* "ordinal": 2,
|
|
3653
|
+
* "overridable": false
|
|
3654
|
+
* }
|
|
3655
|
+
* ```
|
|
3656
|
+
* @format int64
|
|
3657
|
+
*/
|
|
3658
|
+
ai_resolution_status?: number;
|
|
3629
3659
|
/**
|
|
3630
3660
|
* The brand associated with the conversation.
|
|
3631
3661
|
* @format id
|
|
@@ -3766,6 +3796,11 @@ export interface ConversationsListRequest {
|
|
|
3766
3796
|
account?: string[];
|
|
3767
3797
|
/** Provides ways to specify date ranges on objects. */
|
|
3768
3798
|
actual_close_date?: DateFilter;
|
|
3799
|
+
/**
|
|
3800
|
+
* Filters for conversations with any of the provided AI resolution
|
|
3801
|
+
* statuses.
|
|
3802
|
+
*/
|
|
3803
|
+
ai_resolution_status?: number[];
|
|
3769
3804
|
/**
|
|
3770
3805
|
* Filters for conversations belonging to any of the provided parts.
|
|
3771
3806
|
* @example ["PROD-12345"]
|
|
@@ -3897,6 +3932,26 @@ export interface ConversationsUpdateRequest {
|
|
|
3897
3932
|
* @example "ACC-12345"
|
|
3898
3933
|
*/
|
|
3899
3934
|
account?: string | null;
|
|
3935
|
+
/**
|
|
3936
|
+
* The AI resolution status enum ID for the conversation. Stock
|
|
3937
|
+
* allowed values:
|
|
3938
|
+
* ```
|
|
3939
|
+
* {
|
|
3940
|
+
* "id": 1,
|
|
3941
|
+
* "label": "deflected",
|
|
3942
|
+
* "ordinal": 1,
|
|
3943
|
+
* "overridable": false
|
|
3944
|
+
* },
|
|
3945
|
+
* {
|
|
3946
|
+
* "id": 2,
|
|
3947
|
+
* "label": "escalated",
|
|
3948
|
+
* "ordinal": 2,
|
|
3949
|
+
* "overridable": false
|
|
3950
|
+
* }
|
|
3951
|
+
* ```
|
|
3952
|
+
* @format int64
|
|
3953
|
+
*/
|
|
3954
|
+
ai_resolution_status?: number;
|
|
3900
3955
|
applies_to_parts?: ConversationsUpdateRequestAppliesToParts;
|
|
3901
3956
|
/**
|
|
3902
3957
|
* The brand associated with the conversation.
|
|
@@ -5198,7 +5253,14 @@ export type CustomTypeFragmentSummary = CustomSchemaFragmentBaseSummary;
|
|
|
5198
5253
|
*/
|
|
5199
5254
|
export type CustomTypePathComponent = object;
|
|
5200
5255
|
/** dashboard */
|
|
5201
|
-
export type Dashboard = AtomBase
|
|
5256
|
+
export type Dashboard = AtomBase & {
|
|
5257
|
+
/**
|
|
5258
|
+
* Filters that should be shown as empty filter options on the
|
|
5259
|
+
* dashboard. The UI uses the data source schema to determine
|
|
5260
|
+
* appropriate filter controls for each field.
|
|
5261
|
+
*/
|
|
5262
|
+
pinned_filters?: PinnedFilter[];
|
|
5263
|
+
};
|
|
5202
5264
|
/**
|
|
5203
5265
|
* dashboard-filter
|
|
5204
5266
|
* A dashboard filter is a filter that can be applied to tabs, sections,
|
|
@@ -5783,6 +5845,11 @@ export type DevUser = UserBase & {
|
|
|
5783
5845
|
experience_start_date?: string;
|
|
5784
5846
|
/** IDs of the Dev User outside the DevRev SOR. */
|
|
5785
5847
|
external_identities?: ExternalIdentity[];
|
|
5848
|
+
/**
|
|
5849
|
+
* Flag indicating if this user is currently invited. Remains true
|
|
5850
|
+
* even after the user accepts the invitation and becomes active.
|
|
5851
|
+
*/
|
|
5852
|
+
is_invited?: boolean;
|
|
5786
5853
|
/** Job history of the user. */
|
|
5787
5854
|
job_history?: JobHistoryItem[];
|
|
5788
5855
|
reports_to?: UserSummary;
|
|
@@ -7043,7 +7110,7 @@ export interface Error {
|
|
|
7043
7110
|
* error-bad-request
|
|
7044
7111
|
* Describes a error due to a bad request by the client.
|
|
7045
7112
|
*/
|
|
7046
|
-
export type ErrorBadRequest = ErrorBase & (ErrorBadRequestArtifactAlreadyAttachedToAParent | ErrorBadRequestBadRequest | ErrorBadRequestCustomizationValidationError | ErrorBadRequestGroupHierarchyCircularDependency | ErrorBadRequestGroupHierarchyDepthExceeded | ErrorBadRequestGroupHierarchyInvalidParent | ErrorBadRequestIdNotFound | ErrorBadRequestInvalidApiVersion | ErrorBadRequestInvalidContentType | ErrorBadRequestInvalidEnumValue | ErrorBadRequestInvalidField | ErrorBadRequestInvalidId | ErrorBadRequestMergeWorksError | ErrorBadRequestMissingDependency | ErrorBadRequestMissingRequiredField | ErrorBadRequestParseError | ErrorBadRequestSpaceValidationErrors | ErrorBadRequestStaleSchemaFragments | ErrorBadRequestUnexpectedIdType | ErrorBadRequestUnexpectedJsonType | ErrorBadRequestValueNotPermitted | ErrorBadRequestWorkflowComponentValidationErrors) & {
|
|
7113
|
+
export type ErrorBadRequest = ErrorBase & (ErrorBadRequestArtifactAlreadyAttachedToAParent | ErrorBadRequestBadRequest | ErrorBadRequestCustomizationValidationError | ErrorBadRequestGroupHierarchyCircularDependency | ErrorBadRequestGroupHierarchyDepthExceeded | ErrorBadRequestGroupHierarchyInvalidParent | ErrorBadRequestIdNotFound | ErrorBadRequestInvalidApiVersion | ErrorBadRequestInvalidContentType | ErrorBadRequestInvalidEnumValue | ErrorBadRequestInvalidField | ErrorBadRequestInvalidId | ErrorBadRequestMergeWorksError | ErrorBadRequestMissingDependency | ErrorBadRequestMissingRequiredField | ErrorBadRequestOperationNotAllowed | ErrorBadRequestParseError | ErrorBadRequestSpaceValidationErrors | ErrorBadRequestStaleSchemaFragments | ErrorBadRequestUnexpectedIdType | ErrorBadRequestUnexpectedJsonType | ErrorBadRequestValueNotPermitted | ErrorBadRequestWorkflowComponentValidationErrors) & {
|
|
7047
7114
|
type: ErrorBadRequestType;
|
|
7048
7115
|
};
|
|
7049
7116
|
/** error-bad-request-artifact-already-attached-to-a-parent */
|
|
@@ -7345,6 +7412,32 @@ export interface ErrorBadRequestMissingRequiredField {
|
|
|
7345
7412
|
*/
|
|
7346
7413
|
field_name: string;
|
|
7347
7414
|
}
|
|
7415
|
+
/**
|
|
7416
|
+
* error-bad-request-operation-not-allowed
|
|
7417
|
+
* The operation is not allowed because the current state of the system
|
|
7418
|
+
* blocks it.
|
|
7419
|
+
*/
|
|
7420
|
+
export interface ErrorBadRequestOperationNotAllowed {
|
|
7421
|
+
/**
|
|
7422
|
+
* The current value of the blocking field.
|
|
7423
|
+
* @format text
|
|
7424
|
+
*/
|
|
7425
|
+
current_value?: string;
|
|
7426
|
+
/** The values that would allow the operation to proceed. */
|
|
7427
|
+
expected_values?: string[];
|
|
7428
|
+
/**
|
|
7429
|
+
* Dot-notation path to the field blocking the operation (e.g.
|
|
7430
|
+
* 'state', 'ai_agent.default_version_id',
|
|
7431
|
+
* 'default_version_id.state').
|
|
7432
|
+
* @format text
|
|
7433
|
+
*/
|
|
7434
|
+
field_path: string;
|
|
7435
|
+
/**
|
|
7436
|
+
* Why the operation is not allowed.
|
|
7437
|
+
* @format text
|
|
7438
|
+
*/
|
|
7439
|
+
reason?: string;
|
|
7440
|
+
}
|
|
7348
7441
|
/** error-bad-request-parse-error */
|
|
7349
7442
|
export type ErrorBadRequestParseError = object;
|
|
7350
7443
|
/**
|
|
@@ -7449,6 +7542,7 @@ export declare enum ErrorBadRequestType {
|
|
|
7449
7542
|
MergeWorksError = "merge_works_error",
|
|
7450
7543
|
MissingDependency = "missing_dependency",
|
|
7451
7544
|
MissingRequiredField = "missing_required_field",
|
|
7545
|
+
OperationNotAllowed = "operation_not_allowed",
|
|
7452
7546
|
ParseError = "parse_error",
|
|
7453
7547
|
SpaceValidationErrors = "space_validation_errors",
|
|
7454
7548
|
StaleSchemaFragments = "stale_schema_fragments",
|
|
@@ -7492,6 +7586,13 @@ export declare enum ErrorBadRequestUnexpectedJsonTypeType {
|
|
|
7492
7586
|
}
|
|
7493
7587
|
/** error-bad-request-value-not-permitted */
|
|
7494
7588
|
export interface ErrorBadRequestValueNotPermitted {
|
|
7589
|
+
/**
|
|
7590
|
+
* The actual value that was provided.
|
|
7591
|
+
* @format text
|
|
7592
|
+
*/
|
|
7593
|
+
actual_value?: string;
|
|
7594
|
+
/** The allowed object types for ID fields. */
|
|
7595
|
+
allowed_object_types?: string[];
|
|
7495
7596
|
/** The allowed values for the field. */
|
|
7496
7597
|
allowed_values?: string[];
|
|
7497
7598
|
/**
|
|
@@ -7499,6 +7600,16 @@ export interface ErrorBadRequestValueNotPermitted {
|
|
|
7499
7600
|
* @format text
|
|
7500
7601
|
*/
|
|
7501
7602
|
field_name: string;
|
|
7603
|
+
/**
|
|
7604
|
+
* The maximum allowed value or length.
|
|
7605
|
+
* @format text
|
|
7606
|
+
*/
|
|
7607
|
+
max_value?: string;
|
|
7608
|
+
/**
|
|
7609
|
+
* The minimum allowed value or length.
|
|
7610
|
+
* @format text
|
|
7611
|
+
*/
|
|
7612
|
+
min_value?: string;
|
|
7502
7613
|
/**
|
|
7503
7614
|
* The pattern the value must match.
|
|
7504
7615
|
* @format text
|
|
@@ -8256,11 +8367,47 @@ export interface EventWorkflowDeleted {
|
|
|
8256
8367
|
id: string;
|
|
8257
8368
|
old_workflow?: Workflow;
|
|
8258
8369
|
}
|
|
8370
|
+
/** event-workflow-step-created */
|
|
8371
|
+
export interface EventWorkflowStepCreated {
|
|
8372
|
+
workflow_step: WorkflowStep;
|
|
8373
|
+
}
|
|
8374
|
+
/** event-workflow-step-deleted */
|
|
8375
|
+
export interface EventWorkflowStepDeleted {
|
|
8376
|
+
/**
|
|
8377
|
+
* The ID of the workflow step that was deleted.
|
|
8378
|
+
* @format id
|
|
8379
|
+
*/
|
|
8380
|
+
id: string;
|
|
8381
|
+
old_workflow_step?: WorkflowStep;
|
|
8382
|
+
}
|
|
8383
|
+
/** event-workflow-step-updated */
|
|
8384
|
+
export interface EventWorkflowStepUpdated {
|
|
8385
|
+
old_workflow_step?: WorkflowStep;
|
|
8386
|
+
workflow_step: WorkflowStep;
|
|
8387
|
+
}
|
|
8259
8388
|
/** event-workflow-updated */
|
|
8260
8389
|
export interface EventWorkflowUpdated {
|
|
8261
8390
|
old_workflow?: Workflow;
|
|
8262
8391
|
workflow: Workflow;
|
|
8263
8392
|
}
|
|
8393
|
+
/** event-workflow-version-created */
|
|
8394
|
+
export interface EventWorkflowVersionCreated {
|
|
8395
|
+
workflow_version: WorkflowVersion;
|
|
8396
|
+
}
|
|
8397
|
+
/** event-workflow-version-deleted */
|
|
8398
|
+
export interface EventWorkflowVersionDeleted {
|
|
8399
|
+
/**
|
|
8400
|
+
* The ID of the workflow version that was deleted.
|
|
8401
|
+
* @format id
|
|
8402
|
+
*/
|
|
8403
|
+
id: string;
|
|
8404
|
+
old_workflow_version?: WorkflowVersion;
|
|
8405
|
+
}
|
|
8406
|
+
/** event-workflow-version-updated */
|
|
8407
|
+
export interface EventWorkflowVersionUpdated {
|
|
8408
|
+
old_workflow_version?: WorkflowVersion;
|
|
8409
|
+
workflow_version: WorkflowVersion;
|
|
8410
|
+
}
|
|
8264
8411
|
/** external-communication-channel-summary */
|
|
8265
8412
|
export type ExternalCommunicationChannelSummary = AtomBaseSummary;
|
|
8266
8413
|
/**
|
|
@@ -8884,8 +9031,7 @@ export type GroupedVista = VistaBase & {
|
|
|
8884
9031
|
flavor?: GroupedVistaFlavor;
|
|
8885
9032
|
/** Automations specific to the Sprint Board vistas. */
|
|
8886
9033
|
sprint_board_automation?: SprintBoardAutomation;
|
|
8887
|
-
|
|
8888
|
-
sprint_board_config?: SprintBoardConfig;
|
|
9034
|
+
sprint_board_config?: GroupedVistaSprintBoardConfig;
|
|
8889
9035
|
};
|
|
8890
9036
|
/** Type of DevRev object for which the grouped vista is applicable. */
|
|
8891
9037
|
export declare enum GroupedVistaFilterType {
|
|
@@ -8899,6 +9045,38 @@ export declare enum GroupedVistaFlavor {
|
|
|
8899
9045
|
SprintBoard = "sprint_board",
|
|
8900
9046
|
SupportInbox = "support_inbox"
|
|
8901
9047
|
}
|
|
9048
|
+
/** grouped-vista-sprint-board-config */
|
|
9049
|
+
export interface GroupedVistaSprintBoardConfig {
|
|
9050
|
+
/**
|
|
9051
|
+
* Cooldown period in days between sprints.
|
|
9052
|
+
* @format int32
|
|
9053
|
+
*/
|
|
9054
|
+
cooldown?: number;
|
|
9055
|
+
/**
|
|
9056
|
+
* Sprint duration in days.
|
|
9057
|
+
* @format int32
|
|
9058
|
+
*/
|
|
9059
|
+
duration?: number;
|
|
9060
|
+
/**
|
|
9061
|
+
* Number of planned sprints for the sprint board.
|
|
9062
|
+
* @format int32
|
|
9063
|
+
*/
|
|
9064
|
+
planned_sprints?: number;
|
|
9065
|
+
sprint_name_config?: GroupedVistaSprintNamingConfig;
|
|
9066
|
+
}
|
|
9067
|
+
/** grouped-vista-sprint-naming-config */
|
|
9068
|
+
export interface GroupedVistaSprintNamingConfig {
|
|
9069
|
+
/**
|
|
9070
|
+
* The number to assign to the next sprint created.
|
|
9071
|
+
* @format int32
|
|
9072
|
+
*/
|
|
9073
|
+
next_sprint_number?: number;
|
|
9074
|
+
/**
|
|
9075
|
+
* Template for naming sprints.
|
|
9076
|
+
* @format text
|
|
9077
|
+
*/
|
|
9078
|
+
sprint_name_template?: string;
|
|
9079
|
+
}
|
|
8902
9080
|
/**
|
|
8903
9081
|
* groups-create-request
|
|
8904
9082
|
* A request to create a new group.
|
|
@@ -8968,6 +9146,8 @@ export interface GroupsListRequest {
|
|
|
8968
9146
|
group_type?: GroupType[];
|
|
8969
9147
|
/** Filter groups by ingestion source(s). */
|
|
8970
9148
|
ingestion_source?: GroupIngestionSource[];
|
|
9149
|
+
/** Filters the groups on the basis of archival status. */
|
|
9150
|
+
is_archived?: boolean;
|
|
8971
9151
|
/** Whether to fetch default or custom groups. */
|
|
8972
9152
|
is_default?: boolean;
|
|
8973
9153
|
/**
|
|
@@ -10121,7 +10301,18 @@ export type MarketplaceItemSummary = AtomBaseSummary & {
|
|
|
10121
10301
|
* @format text
|
|
10122
10302
|
*/
|
|
10123
10303
|
tagline?: string;
|
|
10304
|
+
/**
|
|
10305
|
+
* Version information for a marketplace listing, specifying the semantic
|
|
10306
|
+
* version being shipped to users.
|
|
10307
|
+
*/
|
|
10308
|
+
version?: MarketplaceListingVersionSummary;
|
|
10124
10309
|
};
|
|
10310
|
+
/**
|
|
10311
|
+
* marketplace-listing-version-summary
|
|
10312
|
+
* Version information for a marketplace listing, specifying the semantic
|
|
10313
|
+
* version being shipped to users.
|
|
10314
|
+
*/
|
|
10315
|
+
export type MarketplaceListingVersionSummary = object;
|
|
10125
10316
|
/**
|
|
10126
10317
|
* meerkat-widget-column-function
|
|
10127
10318
|
* Deprecated: Use widget_query_column_config with type=function on
|
|
@@ -10236,10 +10427,18 @@ export type Meeting = AtomBase & {
|
|
|
10236
10427
|
* @format text
|
|
10237
10428
|
*/
|
|
10238
10429
|
external_url?: string;
|
|
10430
|
+
/**
|
|
10431
|
+
* Whether this meeting has been archived as a secondary record in a
|
|
10432
|
+
* merge. Archived meetings are excluded from list, count, group, and
|
|
10433
|
+
* search endpoints, but remain retrievable via meetings.get so
|
|
10434
|
+
* clients can follow the merge reference using primary_meeting.
|
|
10435
|
+
*/
|
|
10436
|
+
is_archived?: boolean;
|
|
10239
10437
|
/** The members in the meeting. */
|
|
10240
10438
|
members?: AtomSummary[];
|
|
10241
10439
|
organizer?: AtomSummary;
|
|
10242
10440
|
parent?: AtomSummary;
|
|
10441
|
+
primary_meeting?: MeetingSummary;
|
|
10243
10442
|
recording?: ArtifactSummary;
|
|
10244
10443
|
/**
|
|
10245
10444
|
* Recording URL of the meeting.
|
|
@@ -10707,6 +10906,10 @@ export interface MeetingsUpdateRequestMembers {
|
|
|
10707
10906
|
}
|
|
10708
10907
|
/** meetings-update-request-tags */
|
|
10709
10908
|
export interface MeetingsUpdateRequestTags {
|
|
10909
|
+
/** Adds the provided tags on the meeting item. */
|
|
10910
|
+
add?: AddTagWithValue[];
|
|
10911
|
+
/** Removes the provided tags on the meeting item. */
|
|
10912
|
+
remove?: RemoveTagWithValue[];
|
|
10710
10913
|
/** Sets the provided tags on the meeting item. */
|
|
10711
10914
|
set?: SetTagWithValue[];
|
|
10712
10915
|
}
|
|
@@ -11420,14 +11623,23 @@ export interface Money {
|
|
|
11420
11623
|
}
|
|
11421
11624
|
/** network-log */
|
|
11422
11625
|
export interface NetworkLog {
|
|
11423
|
-
/**
|
|
11424
|
-
|
|
11425
|
-
* @format text
|
|
11426
|
-
*/
|
|
11427
|
-
type: string;
|
|
11626
|
+
/** The type of network log. */
|
|
11627
|
+
type: NetworkLogType;
|
|
11428
11628
|
request: ObservabilityNetworkRequest;
|
|
11429
11629
|
response: ObservabilityNetworkResponse;
|
|
11430
11630
|
}
|
|
11631
|
+
/** The type of network log. */
|
|
11632
|
+
export declare enum NetworkLogType {
|
|
11633
|
+
Css = "css",
|
|
11634
|
+
Fetch = "fetch",
|
|
11635
|
+
Font = "font",
|
|
11636
|
+
Iframe = "iframe",
|
|
11637
|
+
Img = "img",
|
|
11638
|
+
Link = "link",
|
|
11639
|
+
Other = "other",
|
|
11640
|
+
Script = "script",
|
|
11641
|
+
Xhr = "xhr"
|
|
11642
|
+
}
|
|
11431
11643
|
/** notification-content-template */
|
|
11432
11644
|
export type NotificationContentTemplate = ContentTemplateBase;
|
|
11433
11645
|
/** notification-content-template-summary */
|
|
@@ -13111,6 +13323,19 @@ export interface PingResponse {
|
|
|
13111
13323
|
*/
|
|
13112
13324
|
timestamp: string;
|
|
13113
13325
|
}
|
|
13326
|
+
/**
|
|
13327
|
+
* pinned-filter
|
|
13328
|
+
* A pinned filter declares a field that should be shown as an empty
|
|
13329
|
+
* filter option in the UI. The UI uses the data source schema to
|
|
13330
|
+
* determine the appropriate filter control for the field.
|
|
13331
|
+
*/
|
|
13332
|
+
export interface PinnedFilter {
|
|
13333
|
+
/**
|
|
13334
|
+
* The field reference name from the data source schema.
|
|
13335
|
+
* @format text
|
|
13336
|
+
*/
|
|
13337
|
+
reference_name: string;
|
|
13338
|
+
}
|
|
13114
13339
|
/** preferences-base */
|
|
13115
13340
|
export type PreferencesBase = AtomBase;
|
|
13116
13341
|
/** preferences-base-summary */
|
|
@@ -14348,6 +14573,11 @@ export interface SchemaFieldDescriptorBase {
|
|
|
14348
14573
|
* @format text
|
|
14349
14574
|
*/
|
|
14350
14575
|
description?: string;
|
|
14576
|
+
/**
|
|
14577
|
+
* Whether this field is derived (computed by the system and not
|
|
14578
|
+
* settable by users).
|
|
14579
|
+
*/
|
|
14580
|
+
is_derived?: boolean;
|
|
14351
14581
|
/** Whether this field is filterable, groupable and sortable. */
|
|
14352
14582
|
is_filterable?: boolean;
|
|
14353
14583
|
/** Whether this field is immutable or not. */
|
|
@@ -14469,6 +14699,8 @@ export interface SchemaFieldUenumValue {
|
|
|
14469
14699
|
* The schema of ui specific fields.
|
|
14470
14700
|
*/
|
|
14471
14701
|
export interface SchemaFieldUiMetadata {
|
|
14702
|
+
/** Card view UI hint overrides. */
|
|
14703
|
+
card_view?: CardViewUiMetadata;
|
|
14472
14704
|
/** The client overrides for the field. */
|
|
14473
14705
|
client_overrides?: ClientOverride[];
|
|
14474
14706
|
/** Create view UI hint overrides. */
|
|
@@ -16121,29 +16353,13 @@ export interface SprintBoardAutomation {
|
|
|
16121
16353
|
* enabled or not.
|
|
16122
16354
|
*/
|
|
16123
16355
|
auto_issue_rollover_enabled?: boolean;
|
|
16124
|
-
/** Whether this sprintboard has opted for mid-sprint status updates. */
|
|
16125
|
-
sprint_status_update_enabled?: boolean;
|
|
16126
|
-
}
|
|
16127
|
-
/**
|
|
16128
|
-
* sprint-board-config
|
|
16129
|
-
* Settings specific to sprint board vistas.
|
|
16130
|
-
*/
|
|
16131
|
-
export interface SprintBoardConfig {
|
|
16132
16356
|
/**
|
|
16133
|
-
*
|
|
16134
|
-
*
|
|
16135
|
-
*/
|
|
16136
|
-
cooldown?: number;
|
|
16137
|
-
/**
|
|
16138
|
-
* Sprint duration in days.
|
|
16139
|
-
* @format int32
|
|
16140
|
-
*/
|
|
16141
|
-
duration?: number;
|
|
16142
|
-
/**
|
|
16143
|
-
* Number of planned sprints for the sprint board.
|
|
16144
|
-
* @format int32
|
|
16357
|
+
* Whether issues should be moved to Backlog stage when removed from a
|
|
16358
|
+
* sprint.
|
|
16145
16359
|
*/
|
|
16146
|
-
|
|
16360
|
+
move_issues_to_backlog_on_sprint_removal_enabled?: boolean;
|
|
16361
|
+
/** Whether this sprintboard has opted for mid-sprint status updates. */
|
|
16362
|
+
sprint_status_update_enabled?: boolean;
|
|
16147
16363
|
}
|
|
16148
16364
|
/**
|
|
16149
16365
|
* stage
|
|
@@ -16505,6 +16721,12 @@ export interface StockSchemaFragmentsListResponse {
|
|
|
16505
16721
|
* widget.
|
|
16506
16722
|
*/
|
|
16507
16723
|
export interface SubWidget {
|
|
16724
|
+
/**
|
|
16725
|
+
* Filters that should be shown as empty filter options in the list
|
|
16726
|
+
* view. The UI uses the data source schema to determine appropriate
|
|
16727
|
+
* filter controls for each field.
|
|
16728
|
+
*/
|
|
16729
|
+
pinned_filters?: PinnedFilter[];
|
|
16508
16730
|
/**
|
|
16509
16731
|
* The query for a widget. This includes measures and dimensions to be
|
|
16510
16732
|
* visualized.
|
|
@@ -18086,8 +18308,14 @@ export interface TimelineEntriesListRequest {
|
|
|
18086
18308
|
/**
|
|
18087
18309
|
* The collection(s) to list entries from, otherwise if not provided,
|
|
18088
18310
|
* all entries are returned.
|
|
18311
|
+
* @maxItems 1
|
|
18089
18312
|
*/
|
|
18090
18313
|
collections?: TimelineEntriesCollection[];
|
|
18314
|
+
/**
|
|
18315
|
+
* Filters for entries created by any of the provided users.
|
|
18316
|
+
* @example ["DEVU-12345"]
|
|
18317
|
+
*/
|
|
18318
|
+
created_by?: string[];
|
|
18091
18319
|
created_date?: DateTimeFilter;
|
|
18092
18320
|
/**
|
|
18093
18321
|
* The cursor to resume iteration from. If not provided, then
|
|
@@ -18794,6 +19022,12 @@ export interface VistaGroupBase {
|
|
|
18794
19022
|
* @maxLength 16000
|
|
18795
19023
|
*/
|
|
18796
19024
|
goals?: string;
|
|
19025
|
+
/**
|
|
19026
|
+
* The artifact ID of the goals document for sprint.
|
|
19027
|
+
* @format id
|
|
19028
|
+
* @example "ARTIFACT-12345"
|
|
19029
|
+
*/
|
|
19030
|
+
goals_document?: string;
|
|
18797
19031
|
/**
|
|
18798
19032
|
* Globally unique object ID.
|
|
18799
19033
|
* @format id
|
|
@@ -19784,7 +20018,13 @@ export interface WebhookEventRequest {
|
|
|
19784
20018
|
work_updated?: EventWorkUpdated;
|
|
19785
20019
|
workflow_created?: EventWorkflowCreated;
|
|
19786
20020
|
workflow_deleted?: EventWorkflowDeleted;
|
|
20021
|
+
workflow_step_created?: EventWorkflowStepCreated;
|
|
20022
|
+
workflow_step_deleted?: EventWorkflowStepDeleted;
|
|
20023
|
+
workflow_step_updated?: EventWorkflowStepUpdated;
|
|
19787
20024
|
workflow_updated?: EventWorkflowUpdated;
|
|
20025
|
+
workflow_version_created?: EventWorkflowVersionCreated;
|
|
20026
|
+
workflow_version_deleted?: EventWorkflowVersionDeleted;
|
|
20027
|
+
workflow_version_updated?: EventWorkflowVersionUpdated;
|
|
19788
20028
|
}
|
|
19789
20029
|
/** webhook-event-response */
|
|
19790
20030
|
export interface WebhookEventResponse {
|
|
@@ -20682,8 +20922,12 @@ export declare enum WorkType {
|
|
|
20682
20922
|
export type Workflow = AtomBase;
|
|
20683
20923
|
/** workflow-run-summary */
|
|
20684
20924
|
export type WorkflowRunSummary = AtomBaseSummary;
|
|
20925
|
+
/** workflow-step */
|
|
20926
|
+
export type WorkflowStep = AtomBase;
|
|
20685
20927
|
/** workflow-summary */
|
|
20686
20928
|
export type WorkflowSummary = AtomBaseSummary;
|
|
20929
|
+
/** workflow-version */
|
|
20930
|
+
export type WorkflowVersion = AtomBase;
|
|
20687
20931
|
/** works-count-request */
|
|
20688
20932
|
export interface WorksCountRequest {
|
|
20689
20933
|
/** Filters for work of the provided types. */
|
|
@@ -21834,7 +22078,7 @@ export declare class HttpClient<SecurityDataType = unknown> {
|
|
|
21834
22078
|
*/
|
|
21835
22079
|
export declare class Api<SecurityDataType extends unknown> extends HttpClient<SecurityDataType> {
|
|
21836
22080
|
/**
|
|
21837
|
-
* @description Creates an account, which is a record representing a customer or an organization.
|
|
22081
|
+
* @description Creates an account, which is a record representing a customer or an organization. **Required scopes:** - `account:write` OR `account:all`
|
|
21838
22082
|
*
|
|
21839
22083
|
* @tags accounts
|
|
21840
22084
|
* @name AccountsCreate
|
|
@@ -21844,7 +22088,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
21844
22088
|
*/
|
|
21845
22089
|
accountsCreate: (data: AccountsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<AccountsCreateResponse, any, {}>>;
|
|
21846
22090
|
/**
|
|
21847
|
-
* @description Deletes an account.
|
|
22091
|
+
* @description Deletes an account. **Required scopes:** - `account:all`
|
|
21848
22092
|
*
|
|
21849
22093
|
* @tags accounts
|
|
21850
22094
|
* @name AccountsDelete
|
|
@@ -21854,7 +22098,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
21854
22098
|
*/
|
|
21855
22099
|
accountsDelete: (data: AccountsDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
|
|
21856
22100
|
/**
|
|
21857
|
-
* @description Exports a collection of accounts.
|
|
22101
|
+
* @description Exports a collection of accounts. **Required scopes:** - `account:read` OR `account:write` OR `account:all`
|
|
21858
22102
|
*
|
|
21859
22103
|
* @tags accounts
|
|
21860
22104
|
* @name AccountsExport
|
|
@@ -21922,7 +22166,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
21922
22166
|
websites?: string[];
|
|
21923
22167
|
}, params?: RequestParams) => Promise<AxiosResponse<AccountsExportResponse, any, {}>>;
|
|
21924
22168
|
/**
|
|
21925
|
-
* @description Exports a collection of accounts.
|
|
22169
|
+
* @description Exports a collection of accounts. **Required scopes:** - `account:read` OR `account:write` OR `account:all`
|
|
21926
22170
|
*
|
|
21927
22171
|
* @tags accounts
|
|
21928
22172
|
* @name AccountsExportPost
|
|
@@ -21932,7 +22176,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
21932
22176
|
*/
|
|
21933
22177
|
accountsExportPost: (data: AccountsExportRequest, params?: RequestParams) => Promise<AxiosResponse<AccountsExportResponse, any, {}>>;
|
|
21934
22178
|
/**
|
|
21935
|
-
* @description Retrieves an account's information.
|
|
22179
|
+
* @description Retrieves an account's information. **Required scopes:** - `account:read` OR `account:write` OR `account:all`
|
|
21936
22180
|
*
|
|
21937
22181
|
* @tags accounts
|
|
21938
22182
|
* @name AccountsGet
|
|
@@ -21949,7 +22193,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
21949
22193
|
id: string;
|
|
21950
22194
|
}, params?: RequestParams) => Promise<AxiosResponse<AccountsGetResponse, any, {}>>;
|
|
21951
22195
|
/**
|
|
21952
|
-
* @description Retrieves an account's information.
|
|
22196
|
+
* @description Retrieves an account's information. **Required scopes:** - `account:read` OR `account:write` OR `account:all`
|
|
21953
22197
|
*
|
|
21954
22198
|
* @tags accounts
|
|
21955
22199
|
* @name AccountsGetPost
|
|
@@ -21959,7 +22203,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
21959
22203
|
*/
|
|
21960
22204
|
accountsGetPost: (data: AccountsGetRequest, params?: RequestParams) => Promise<AxiosResponse<AccountsGetResponse, any, {}>>;
|
|
21961
22205
|
/**
|
|
21962
|
-
* @description Gets a list of accounts.
|
|
22206
|
+
* @description Gets a list of accounts. **Required scopes:** - `account:read` OR `account:write` OR `account:all`
|
|
21963
22207
|
*
|
|
21964
22208
|
* @tags accounts
|
|
21965
22209
|
* @name AccountsList
|
|
@@ -22037,7 +22281,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
22037
22281
|
websites?: string[];
|
|
22038
22282
|
}, params?: RequestParams) => Promise<AxiosResponse<AccountsListResponse, any, {}>>;
|
|
22039
22283
|
/**
|
|
22040
|
-
* @description Gets a list of accounts.
|
|
22284
|
+
* @description Gets a list of accounts. **Required scopes:** - `account:read` OR `account:write` OR `account:all`
|
|
22041
22285
|
*
|
|
22042
22286
|
* @tags accounts
|
|
22043
22287
|
* @name AccountsListPost
|
|
@@ -22047,7 +22291,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
22047
22291
|
*/
|
|
22048
22292
|
accountsListPost: (data: AccountsListRequest, params?: RequestParams) => Promise<AxiosResponse<AccountsListResponse, any, {}>>;
|
|
22049
22293
|
/**
|
|
22050
|
-
* @description Merges two accounts.
|
|
22294
|
+
* @description Merges two accounts. **Required scopes:** - `account:all`
|
|
22051
22295
|
*
|
|
22052
22296
|
* @tags accounts
|
|
22053
22297
|
* @name AccountsMerge
|
|
@@ -22057,7 +22301,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
22057
22301
|
*/
|
|
22058
22302
|
accountsMerge: (data: AccountsMergeRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
|
|
22059
22303
|
/**
|
|
22060
|
-
* @description Updates an account's information.
|
|
22304
|
+
* @description Updates an account's information. **Required scopes:** - `account:write` OR `account:all`
|
|
22061
22305
|
*
|
|
22062
22306
|
* @tags accounts
|
|
22063
22307
|
* @name AccountsUpdate
|
|
@@ -22067,7 +22311,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
22067
22311
|
*/
|
|
22068
22312
|
accountsUpdate: (data: AccountsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<AccountsUpdateResponse, any, {}>>;
|
|
22069
22313
|
/**
|
|
22070
|
-
* @description Article is an object which can contain a URL or artifacts in the resource. It also contains the data regarding the owner, author, status and published date of the object. This call creates an article.
|
|
22314
|
+
* @description Article is an object which can contain a URL or artifacts in the resource. It also contains the data regarding the owner, author, status and published date of the object. This call creates an article. **Required scopes:** - `article:write` OR `article:all`
|
|
22071
22315
|
*
|
|
22072
22316
|
* @tags articles
|
|
22073
22317
|
* @name CreateArticle
|
|
@@ -22077,7 +22321,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
22077
22321
|
*/
|
|
22078
22322
|
createArticle: (data: ArticlesCreateRequest, params?: RequestParams) => Promise<AxiosResponse<ArticlesCreateResponse, any, {}>>;
|
|
22079
22323
|
/**
|
|
22080
|
-
* @description Deletes an article.
|
|
22324
|
+
* @description Deletes an article. **Required scopes:** - `article:all`
|
|
22081
22325
|
*
|
|
22082
22326
|
* @tags articles
|
|
22083
22327
|
* @name DeleteArticle
|
|
@@ -22087,7 +22331,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
22087
22331
|
*/
|
|
22088
22332
|
deleteArticle: (data: ArticlesDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
|
|
22089
22333
|
/**
|
|
22090
|
-
* @description Gets an article.
|
|
22334
|
+
* @description Gets an article. **Required scopes:** - `article:read` OR `article:write` OR `article:all`
|
|
22091
22335
|
*
|
|
22092
22336
|
* @tags articles
|
|
22093
22337
|
* @name GetArticle
|
|
@@ -22111,7 +22355,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
22111
22355
|
parent_article_id?: string;
|
|
22112
22356
|
}, params?: RequestParams) => Promise<AxiosResponse<ArticlesGetResponse, any, {}>>;
|
|
22113
22357
|
/**
|
|
22114
|
-
* @description Gets an article.
|
|
22358
|
+
* @description Gets an article. **Required scopes:** - `article:read` OR `article:write` OR `article:all`
|
|
22115
22359
|
*
|
|
22116
22360
|
* @tags articles
|
|
22117
22361
|
* @name GetArticlePost
|
|
@@ -22121,7 +22365,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
22121
22365
|
*/
|
|
22122
22366
|
getArticlePost: (data: ArticlesGetRequest, params?: RequestParams) => Promise<AxiosResponse<ArticlesGetResponse, any, {}>>;
|
|
22123
22367
|
/**
|
|
22124
|
-
* @description Lists a collection of articles.
|
|
22368
|
+
* @description Lists a collection of articles. **Required scopes:** - `article:read` OR `article:write` OR `article:all`
|
|
22125
22369
|
*
|
|
22126
22370
|
* @tags articles
|
|
22127
22371
|
* @name ListArticles
|
|
@@ -22221,7 +22465,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
22221
22465
|
tags?: string[];
|
|
22222
22466
|
}, params?: RequestParams) => Promise<AxiosResponse<ArticlesListResponse, any, {}>>;
|
|
22223
22467
|
/**
|
|
22224
|
-
* @description Lists a collection of articles.
|
|
22468
|
+
* @description Lists a collection of articles. **Required scopes:** - `article:read` OR `article:write` OR `article:all`
|
|
22225
22469
|
*
|
|
22226
22470
|
* @tags articles
|
|
22227
22471
|
* @name ListArticlesPost
|
|
@@ -22231,7 +22475,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
22231
22475
|
*/
|
|
22232
22476
|
listArticlesPost: (data: ArticlesListRequest, params?: RequestParams) => Promise<AxiosResponse<ArticlesListResponse, any, {}>>;
|
|
22233
22477
|
/**
|
|
22234
|
-
* @description Updates an article.
|
|
22478
|
+
* @description Updates an article. **Required scopes:** - `article:write` OR `article:all`
|
|
22235
22479
|
*
|
|
22236
22480
|
* @tags articles
|
|
22237
22481
|
* @name UpdateArticle
|
|
@@ -22241,7 +22485,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
22241
22485
|
*/
|
|
22242
22486
|
updateArticle: (data: ArticlesUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<ArticlesUpdateResponse, any, {}>>;
|
|
22243
22487
|
/**
|
|
22244
|
-
* @description Redirects to the artifact's download URL.
|
|
22488
|
+
* @description Redirects to the artifact's download URL. **Required scopes:** - `artifact:read`
|
|
22245
22489
|
*
|
|
22246
22490
|
* @tags artifacts
|
|
22247
22491
|
* @name ArtifactsDownload
|
|
@@ -22268,7 +22512,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
22268
22512
|
version?: string;
|
|
22269
22513
|
}, params?: RequestParams) => Promise<AxiosResponse<any, any, {}>>;
|
|
22270
22514
|
/**
|
|
22271
|
-
* @description Redirects to the artifact's download URL.
|
|
22515
|
+
* @description Redirects to the artifact's download URL. **Required scopes:** - `artifact:read`
|
|
22272
22516
|
*
|
|
22273
22517
|
* @tags artifacts
|
|
22274
22518
|
* @name ArtifactsDownloadPost
|
|
@@ -22278,7 +22522,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
22278
22522
|
*/
|
|
22279
22523
|
artifactsDownloadPost: (data: ArtifactsDownloadRequest, params?: RequestParams) => Promise<AxiosResponse<any, any, {}>>;
|
|
22280
22524
|
/**
|
|
22281
|
-
* @description Gets the requested artifact's information.
|
|
22525
|
+
* @description Gets the requested artifact's information. **Required scopes:** - `artifact:read` Also needs parent read access.
|
|
22282
22526
|
*
|
|
22283
22527
|
* @tags artifacts
|
|
22284
22528
|
* @name ArtifactsGet
|
|
@@ -22300,7 +22544,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
22300
22544
|
version?: string;
|
|
22301
22545
|
}, params?: RequestParams) => Promise<AxiosResponse<ArtifactsGetResponse, any, {}>>;
|
|
22302
22546
|
/**
|
|
22303
|
-
* @description Gets the requested artifact's information.
|
|
22547
|
+
* @description Gets the requested artifact's information. **Required scopes:** - `artifact:read` Also needs parent read access.
|
|
22304
22548
|
*
|
|
22305
22549
|
* @tags artifacts
|
|
22306
22550
|
* @name ArtifactsGetPost
|
|
@@ -22310,7 +22554,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
22310
22554
|
*/
|
|
22311
22555
|
artifactsGetPost: (data: ArtifactsGetRequest, params?: RequestParams) => Promise<AxiosResponse<ArtifactsGetResponse, any, {}>>;
|
|
22312
22556
|
/**
|
|
22313
|
-
* @description List the artifacts attached to an object.
|
|
22557
|
+
* @description List the artifacts attached to an object. **Required scopes:** - `artifact:read` Also needs parent read access.
|
|
22314
22558
|
*
|
|
22315
22559
|
* @tags artifacts
|
|
22316
22560
|
* @name ArtifactsList
|
|
@@ -22326,7 +22570,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
22326
22570
|
parent_id?: string;
|
|
22327
22571
|
}, params?: RequestParams) => Promise<AxiosResponse<ArtifactsListResponse, any, {}>>;
|
|
22328
22572
|
/**
|
|
22329
|
-
* @description List the artifacts attached to an object.
|
|
22573
|
+
* @description List the artifacts attached to an object. **Required scopes:** - `artifact:read` Also needs parent read access.
|
|
22330
22574
|
*
|
|
22331
22575
|
* @tags artifacts
|
|
22332
22576
|
* @name ArtifactsListPost
|
|
@@ -22336,7 +22580,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
22336
22580
|
*/
|
|
22337
22581
|
artifactsListPost: (data: ArtifactsListRequest, params?: RequestParams) => Promise<AxiosResponse<ArtifactsListResponse, any, {}>>;
|
|
22338
22582
|
/**
|
|
22339
|
-
* @description Gets the download URL for the artifact.
|
|
22583
|
+
* @description Gets the download URL for the artifact. **Required scopes:** - `artifact:read` Also needs parent read access.
|
|
22340
22584
|
*
|
|
22341
22585
|
* @tags artifacts
|
|
22342
22586
|
* @name ArtifactsLocate
|
|
@@ -22358,7 +22602,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
22358
22602
|
version?: string;
|
|
22359
22603
|
}, params?: RequestParams) => Promise<AxiosResponse<ArtifactsLocateResponse, any, {}>>;
|
|
22360
22604
|
/**
|
|
22361
|
-
* @description Gets the download URL for the artifact.
|
|
22605
|
+
* @description Gets the download URL for the artifact. **Required scopes:** - `artifact:read` Also needs parent read access.
|
|
22362
22606
|
*
|
|
22363
22607
|
* @tags artifacts
|
|
22364
22608
|
* @name ArtifactsLocatePost
|
|
@@ -22368,7 +22612,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
22368
22612
|
*/
|
|
22369
22613
|
artifactsLocatePost: (data: ArtifactsLocateRequest, params?: RequestParams) => Promise<AxiosResponse<ArtifactsLocateResponse, any, {}>>;
|
|
22370
22614
|
/**
|
|
22371
|
-
* @description Creates an artifact and generates an upload URL for its data.
|
|
22615
|
+
* @description Creates an artifact and generates an upload URL for its data. **Required scopes:** - `artifact:create`
|
|
22372
22616
|
*
|
|
22373
22617
|
* @tags artifacts
|
|
22374
22618
|
* @name ArtifactsPrepare
|
|
@@ -22378,7 +22622,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
22378
22622
|
*/
|
|
22379
22623
|
artifactsPrepare: (data: ArtifactsPrepareRequest, params?: RequestParams) => Promise<AxiosResponse<ArtifactsPrepareResponse, any, {}>>;
|
|
22380
22624
|
/**
|
|
22381
|
-
* @description Permanently deletes a version of an artifact.
|
|
22625
|
+
* @description Permanently deletes a version of an artifact. **Required scopes:** - `artifact:create`
|
|
22382
22626
|
*
|
|
22383
22627
|
* @tags artifacts
|
|
22384
22628
|
* @name ArtifactsHardDeleteVersion
|
|
@@ -22388,7 +22632,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
22388
22632
|
*/
|
|
22389
22633
|
artifactsHardDeleteVersion: (data: ArtifactsHardDeleteVersionRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
|
|
22390
22634
|
/**
|
|
22391
|
-
* @description Prepares a new version for an artifact, returning the URL and form data to upload the updated file.
|
|
22635
|
+
* @description Prepares a new version for an artifact, returning the URL and form data to upload the updated file. **Required scopes:** - `artifact:create`
|
|
22392
22636
|
*
|
|
22393
22637
|
* @tags artifacts
|
|
22394
22638
|
* @name ArtifactsVersionsPrepare
|
|
@@ -22424,7 +22668,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
22424
22668
|
*/
|
|
22425
22669
|
atomsGetPost: (data: AtomsGetRequest, params?: RequestParams) => Promise<AxiosResponse<AtomsGetResponse, any, {}>>;
|
|
22426
22670
|
/**
|
|
22427
|
-
* @description Creates a JWT corresponding to the requested token type for the authenticated user.
|
|
22671
|
+
* @description Creates a JWT corresponding to the requested token type for the authenticated user. **Required scopes:** No scopes required.
|
|
22428
22672
|
*
|
|
22429
22673
|
* @tags auth-tokens
|
|
22430
22674
|
* @name AuthTokensCreate
|
|
@@ -22434,7 +22678,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
22434
22678
|
*/
|
|
22435
22679
|
authTokensCreate: (data: AuthTokensCreateRequest, params?: RequestParams) => Promise<AxiosResponse<AuthTokensCreateResponse, any, {}>>;
|
|
22436
22680
|
/**
|
|
22437
|
-
* @description Revokes the token that matches the given token ID issued under the given Dev organization.
|
|
22681
|
+
* @description Revokes the token that matches the given token ID issued under the given Dev organization. **Required scopes:** No scopes required.
|
|
22438
22682
|
*
|
|
22439
22683
|
* @tags auth-tokens
|
|
22440
22684
|
* @name AuthTokensDelete
|
|
@@ -22444,7 +22688,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
22444
22688
|
*/
|
|
22445
22689
|
authTokensDelete: (data: AuthTokensDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
|
|
22446
22690
|
/**
|
|
22447
|
-
* @description Gets the token metadata corresponding to the given token ID under the given Dev organization.
|
|
22691
|
+
* @description Gets the token metadata corresponding to the given token ID under the given Dev organization. **Required scopes:** No scopes required.
|
|
22448
22692
|
*
|
|
22449
22693
|
* @tags auth-tokens
|
|
22450
22694
|
* @name AuthTokensGet
|
|
@@ -22460,7 +22704,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
22460
22704
|
token_id: string;
|
|
22461
22705
|
}, params?: RequestParams) => Promise<AxiosResponse<AuthTokensGetResponse, any, {}>>;
|
|
22462
22706
|
/**
|
|
22463
|
-
* @description Gets the token metadata corresponding to the given token ID under the given Dev organization.
|
|
22707
|
+
* @description Gets the token metadata corresponding to the given token ID under the given Dev organization. **Required scopes:** No scopes required.
|
|
22464
22708
|
*
|
|
22465
22709
|
* @tags auth-tokens
|
|
22466
22710
|
* @name AuthTokensGetPost
|
|
@@ -22470,7 +22714,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
22470
22714
|
*/
|
|
22471
22715
|
authTokensGetPost: (data: AuthTokensGetRequest, params?: RequestParams) => Promise<AxiosResponse<AuthTokensGetResponse, any, {}>>;
|
|
22472
22716
|
/**
|
|
22473
|
-
* @description Returns the Dev organization, user and token attributes extracted from the auth token.
|
|
22717
|
+
* @description Returns the Dev organization, user and token attributes extracted from the auth token. **Required scopes:** No scopes required.
|
|
22474
22718
|
*
|
|
22475
22719
|
* @tags auth-tokens
|
|
22476
22720
|
* @name AuthTokensInfo
|
|
@@ -22480,7 +22724,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
22480
22724
|
*/
|
|
22481
22725
|
authTokensInfo: (params?: RequestParams) => Promise<AxiosResponse<AuthTokensInfoResponse, any, {}>>;
|
|
22482
22726
|
/**
|
|
22483
|
-
* @description Returns the Dev organization, user and token attributes extracted from the auth token.
|
|
22727
|
+
* @description Returns the Dev organization, user and token attributes extracted from the auth token. **Required scopes:** No scopes required.
|
|
22484
22728
|
*
|
|
22485
22729
|
* @tags auth-tokens
|
|
22486
22730
|
* @name AuthTokensInfoPost
|
|
@@ -22490,7 +22734,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
22490
22734
|
*/
|
|
22491
22735
|
authTokensInfoPost: (data: AuthTokensInfoRequest, params?: RequestParams) => Promise<AxiosResponse<AuthTokensInfoResponse, any, {}>>;
|
|
22492
22736
|
/**
|
|
22493
|
-
* @description Gets the token metadata for all the tokens corresponding to the given token type issued for a given subject.
|
|
22737
|
+
* @description Gets the token metadata for all the tokens corresponding to the given token type issued for a given subject. **Required scopes:** No scopes required.
|
|
22494
22738
|
*
|
|
22495
22739
|
* @tags auth-tokens
|
|
22496
22740
|
* @name AuthTokensList
|
|
@@ -22519,7 +22763,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
22519
22763
|
subject?: string;
|
|
22520
22764
|
}, params?: RequestParams) => Promise<AxiosResponse<AuthTokensListResponse, any, {}>>;
|
|
22521
22765
|
/**
|
|
22522
|
-
* @description Gets the token metadata for all the tokens corresponding to the given token type issued for a given subject.
|
|
22766
|
+
* @description Gets the token metadata for all the tokens corresponding to the given token type issued for a given subject. **Required scopes:** No scopes required.
|
|
22523
22767
|
*
|
|
22524
22768
|
* @tags auth-tokens
|
|
22525
22769
|
* @name AuthTokensListPost
|
|
@@ -22529,7 +22773,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
22529
22773
|
*/
|
|
22530
22774
|
authTokensListPost: (data: AuthTokensListRequest, params?: RequestParams) => Promise<AxiosResponse<AuthTokensListResponse, any, {}>>;
|
|
22531
22775
|
/**
|
|
22532
|
-
* @description Revokes all the tokens that matches the given token type created by the authenticated user.
|
|
22776
|
+
* @description Revokes all the tokens that matches the given token type created by the authenticated user. **Required scopes:** No scopes required.
|
|
22533
22777
|
*
|
|
22534
22778
|
* @tags auth-tokens
|
|
22535
22779
|
* @name AuthTokensSelfDelete
|
|
@@ -22539,7 +22783,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
22539
22783
|
*/
|
|
22540
22784
|
authTokensSelfDelete: (data: AuthTokensSelfDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
|
|
22541
22785
|
/**
|
|
22542
|
-
* @description Updates token metadata of a token issued under a given Dev organization.
|
|
22786
|
+
* @description Updates token metadata of a token issued under a given Dev organization. **Required scopes:** No scopes required.
|
|
22543
22787
|
*
|
|
22544
22788
|
* @tags auth-tokens
|
|
22545
22789
|
* @name AuthTokensUpdate
|
|
@@ -22549,7 +22793,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
22549
22793
|
*/
|
|
22550
22794
|
authTokensUpdate: (data: AuthTokensUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<AuthTokensUpdateResponse, any, {}>>;
|
|
22551
22795
|
/**
|
|
22552
|
-
* @description Creates a new chat, or optionally opens an existing one.
|
|
22796
|
+
* @description Creates a new chat, or optionally opens an existing one. **Required scopes:** Access is determined by chat membership.
|
|
22553
22797
|
*
|
|
22554
22798
|
* @tags chats
|
|
22555
22799
|
* @name ChatsCreate
|
|
@@ -22559,7 +22803,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
22559
22803
|
*/
|
|
22560
22804
|
chatsCreate: (data: ChatsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<ChatsCreateResponse, any, {}>>;
|
|
22561
22805
|
/**
|
|
22562
|
-
* @description Gets a chat's information.
|
|
22806
|
+
* @description Gets a chat's information. **Required scopes:** Access is determined by chat membership.
|
|
22563
22807
|
*
|
|
22564
22808
|
* @tags chats
|
|
22565
22809
|
* @name ChatsGet
|
|
@@ -22576,7 +22820,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
22576
22820
|
id?: string;
|
|
22577
22821
|
}, params?: RequestParams) => Promise<AxiosResponse<ChatsGetResponse, any, {}>>;
|
|
22578
22822
|
/**
|
|
22579
|
-
* @description Gets a chat's information.
|
|
22823
|
+
* @description Gets a chat's information. **Required scopes:** Access is determined by chat membership.
|
|
22580
22824
|
*
|
|
22581
22825
|
* @tags chats
|
|
22582
22826
|
* @name ChatsGetPost
|
|
@@ -22586,7 +22830,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
22586
22830
|
*/
|
|
22587
22831
|
chatsGetPost: (data: ChatsGetRequest, params?: RequestParams) => Promise<AxiosResponse<ChatsGetResponse, any, {}>>;
|
|
22588
22832
|
/**
|
|
22589
|
-
* @description Updates a chat's information.
|
|
22833
|
+
* @description Updates a chat's information. **Required scopes:** Access is determined by chat membership.
|
|
22590
22834
|
*
|
|
22591
22835
|
* @tags chats
|
|
22592
22836
|
* @name ChatsUpdate
|
|
@@ -22596,7 +22840,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
22596
22840
|
*/
|
|
22597
22841
|
chatsUpdate: (data: ChatsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<ChatsUpdateResponse, any, {}>>;
|
|
22598
22842
|
/**
|
|
22599
|
-
* @description Creates a code change object.
|
|
22843
|
+
* @description Creates a code change object. **Required scopes:** - `code_change:write` OR `code_change:all`
|
|
22600
22844
|
*
|
|
22601
22845
|
* @tags code-changes
|
|
22602
22846
|
* @name CodeChangesCreate
|
|
@@ -22606,7 +22850,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
22606
22850
|
*/
|
|
22607
22851
|
codeChangesCreate: (data: CodeChangesCreateRequest, params?: RequestParams) => Promise<AxiosResponse<CodeChangesCreateResponse, any, {}>>;
|
|
22608
22852
|
/**
|
|
22609
|
-
* @description Deletes a code change object.
|
|
22853
|
+
* @description Deletes a code change object. **Required scopes:** - `code_change:all`
|
|
22610
22854
|
*
|
|
22611
22855
|
* @tags code-changes
|
|
22612
22856
|
* @name CodeChangesDelete
|
|
@@ -22616,7 +22860,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
22616
22860
|
*/
|
|
22617
22861
|
codeChangesDelete: (data: CodeChangesDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
|
|
22618
22862
|
/**
|
|
22619
|
-
* @description Gets a code change object.
|
|
22863
|
+
* @description Gets a code change object. **Required scopes:** - `code_change:read` OR `code_change:write` OR `code_change:all`
|
|
22620
22864
|
*
|
|
22621
22865
|
* @tags code-changes
|
|
22622
22866
|
* @name CodeChangesGet
|
|
@@ -22632,7 +22876,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
22632
22876
|
id: string;
|
|
22633
22877
|
}, params?: RequestParams) => Promise<AxiosResponse<CodeChangesGetResponse, any, {}>>;
|
|
22634
22878
|
/**
|
|
22635
|
-
* @description Gets a code change object.
|
|
22879
|
+
* @description Gets a code change object. **Required scopes:** - `code_change:read` OR `code_change:write` OR `code_change:all`
|
|
22636
22880
|
*
|
|
22637
22881
|
* @tags code-changes
|
|
22638
22882
|
* @name CodeChangesGetPost
|
|
@@ -22642,7 +22886,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
22642
22886
|
*/
|
|
22643
22887
|
codeChangesGetPost: (data: CodeChangesGetRequest, params?: RequestParams) => Promise<AxiosResponse<CodeChangesGetResponse, any, {}>>;
|
|
22644
22888
|
/**
|
|
22645
|
-
* @description Lists code change objects.
|
|
22889
|
+
* @description Lists code change objects. **Required scopes:** - `code_change:read` OR `code_change:write` OR `code_change:all`
|
|
22646
22890
|
*
|
|
22647
22891
|
* @tags code-changes
|
|
22648
22892
|
* @name CodeChangesList
|
|
@@ -22670,7 +22914,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
22670
22914
|
mode?: ListMode;
|
|
22671
22915
|
}, params?: RequestParams) => Promise<AxiosResponse<CodeChangesListResponse, any, {}>>;
|
|
22672
22916
|
/**
|
|
22673
|
-
* @description Lists code change objects.
|
|
22917
|
+
* @description Lists code change objects. **Required scopes:** - `code_change:read` OR `code_change:write` OR `code_change:all`
|
|
22674
22918
|
*
|
|
22675
22919
|
* @tags code-changes
|
|
22676
22920
|
* @name CodeChangesListPost
|
|
@@ -22680,7 +22924,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
22680
22924
|
*/
|
|
22681
22925
|
codeChangesListPost: (data: CodeChangesListRequest, params?: RequestParams) => Promise<AxiosResponse<CodeChangesListResponse, any, {}>>;
|
|
22682
22926
|
/**
|
|
22683
|
-
* @description Updates a code change object.
|
|
22927
|
+
* @description Updates a code change object. **Required scopes:** - `code_change:write` OR `code_change:all`
|
|
22684
22928
|
*
|
|
22685
22929
|
* @tags code-changes
|
|
22686
22930
|
* @name CodeChangesUpdate
|
|
@@ -22690,7 +22934,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
22690
22934
|
*/
|
|
22691
22935
|
codeChangesUpdate: (data: CodeChangesUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<CodeChangesUpdateResponse, any, {}>>;
|
|
22692
22936
|
/**
|
|
22693
|
-
* @description Creates a command.
|
|
22937
|
+
* @description Creates a command. **Required scopes:** - `command:write` OR `command:all`
|
|
22694
22938
|
*
|
|
22695
22939
|
* @tags commands
|
|
22696
22940
|
* @name CommandsCreate
|
|
@@ -22700,7 +22944,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
22700
22944
|
*/
|
|
22701
22945
|
commandsCreate: (data: CommandCreateRequest, params?: RequestParams) => Promise<AxiosResponse<CommandCreateResponse, any, {}>>;
|
|
22702
22946
|
/**
|
|
22703
|
-
* @description Gets a command.
|
|
22947
|
+
* @description Gets a command. **Required scopes:** - `command:read` OR `command:write` OR `command:all`
|
|
22704
22948
|
*
|
|
22705
22949
|
* @tags commands
|
|
22706
22950
|
* @name CommandsGet
|
|
@@ -22716,7 +22960,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
22716
22960
|
id: string;
|
|
22717
22961
|
}, params?: RequestParams) => Promise<AxiosResponse<CommandGetResponse, any, {}>>;
|
|
22718
22962
|
/**
|
|
22719
|
-
* @description Gets a command.
|
|
22963
|
+
* @description Gets a command. **Required scopes:** - `command:read` OR `command:write` OR `command:all`
|
|
22720
22964
|
*
|
|
22721
22965
|
* @tags commands
|
|
22722
22966
|
* @name CommandsGetPost
|
|
@@ -22726,7 +22970,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
22726
22970
|
*/
|
|
22727
22971
|
commandsGetPost: (data: CommandGetRequest, params?: RequestParams) => Promise<AxiosResponse<CommandGetResponse, any, {}>>;
|
|
22728
22972
|
/**
|
|
22729
|
-
* @description Lists commands for a Dev organization.
|
|
22973
|
+
* @description Lists commands for a Dev organization. **Required scopes:** - `command:read` OR `command:write` OR `command:all`
|
|
22730
22974
|
*
|
|
22731
22975
|
* @tags commands
|
|
22732
22976
|
* @name CommandsList
|
|
@@ -22767,7 +23011,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
22767
23011
|
status?: CommandStatus[];
|
|
22768
23012
|
}, params?: RequestParams) => Promise<AxiosResponse<CommandsListResponse, any, {}>>;
|
|
22769
23013
|
/**
|
|
22770
|
-
* @description Lists commands for a Dev organization.
|
|
23014
|
+
* @description Lists commands for a Dev organization. **Required scopes:** - `command:read` OR `command:write` OR `command:all`
|
|
22771
23015
|
*
|
|
22772
23016
|
* @tags commands
|
|
22773
23017
|
* @name CommandsListPost
|
|
@@ -22777,7 +23021,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
22777
23021
|
*/
|
|
22778
23022
|
commandsListPost: (data: CommandsListRequest, params?: RequestParams) => Promise<AxiosResponse<CommandsListResponse, any, {}>>;
|
|
22779
23023
|
/**
|
|
22780
|
-
* @description Updates a command.
|
|
23024
|
+
* @description Updates a command. **Required scopes:** - `command:write` OR `command:all`
|
|
22781
23025
|
*
|
|
22782
23026
|
* @tags commands
|
|
22783
23027
|
* @name CommandsUpdate
|
|
@@ -22787,7 +23031,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
22787
23031
|
*/
|
|
22788
23032
|
commandsUpdate: (data: CommandUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<CommandUpdateResponse, any, {}>>;
|
|
22789
23033
|
/**
|
|
22790
|
-
* @description Creates a conversation.
|
|
23034
|
+
* @description Creates a conversation. **Required scopes:** - `conversation:write` OR `conversation:all`
|
|
22791
23035
|
*
|
|
22792
23036
|
* @tags conversations
|
|
22793
23037
|
* @name ConversationsCreate
|
|
@@ -22797,7 +23041,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
22797
23041
|
*/
|
|
22798
23042
|
conversationsCreate: (data: ConversationsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<ConversationsCreateResponse, any, {}>>;
|
|
22799
23043
|
/**
|
|
22800
|
-
* @description Deletes the requested conversation.
|
|
23044
|
+
* @description Deletes the requested conversation. **Required scopes:** - `conversation:all`
|
|
22801
23045
|
*
|
|
22802
23046
|
* @tags conversations
|
|
22803
23047
|
* @name ConversationsDelete
|
|
@@ -22807,7 +23051,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
22807
23051
|
*/
|
|
22808
23052
|
conversationsDelete: (data: ConversationsDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
|
|
22809
23053
|
/**
|
|
22810
|
-
* @description Gets the requested conversation's information.
|
|
23054
|
+
* @description Gets the requested conversation's information. **Required scopes:** - `conversation:read` OR `conversation:write` OR `conversation:all`
|
|
22811
23055
|
*
|
|
22812
23056
|
* @tags conversations
|
|
22813
23057
|
* @name ConversationsGet
|
|
@@ -22823,7 +23067,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
22823
23067
|
id: string;
|
|
22824
23068
|
}, params?: RequestParams) => Promise<AxiosResponse<ConversationsGetResponse, any, {}>>;
|
|
22825
23069
|
/**
|
|
22826
|
-
* @description Gets the requested conversation's information.
|
|
23070
|
+
* @description Gets the requested conversation's information. **Required scopes:** - `conversation:read` OR `conversation:write` OR `conversation:all`
|
|
22827
23071
|
*
|
|
22828
23072
|
* @tags conversations
|
|
22829
23073
|
* @name ConversationsGetPost
|
|
@@ -22833,7 +23077,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
22833
23077
|
*/
|
|
22834
23078
|
conversationsGetPost: (data: ConversationsGetRequest, params?: RequestParams) => Promise<AxiosResponse<ConversationsGetResponse, any, {}>>;
|
|
22835
23079
|
/**
|
|
22836
|
-
* @description Lists the available conversations.
|
|
23080
|
+
* @description Lists the available conversations. **Required scopes:** - `conversation:read` OR `conversation:write` OR `conversation:all`
|
|
22837
23081
|
*
|
|
22838
23082
|
* @tags conversations
|
|
22839
23083
|
* @name ConversationsList
|
|
@@ -22848,6 +23092,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
22848
23092
|
* @example ["ACC-12345"]
|
|
22849
23093
|
*/
|
|
22850
23094
|
account?: string[];
|
|
23095
|
+
/**
|
|
23096
|
+
* Filters for conversations with any of the provided AI resolution
|
|
23097
|
+
* statuses.
|
|
23098
|
+
*/
|
|
23099
|
+
ai_resolution_status?: number[];
|
|
22851
23100
|
/**
|
|
22852
23101
|
* Filters for conversations belonging to any of the provided parts.
|
|
22853
23102
|
* @example ["PROD-12345"]
|
|
@@ -22968,7 +23217,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
22968
23217
|
'tags_v2.value'?: string;
|
|
22969
23218
|
}, params?: RequestParams) => Promise<AxiosResponse<ConversationsListResponse, any, {}>>;
|
|
22970
23219
|
/**
|
|
22971
|
-
* @description Lists the available conversations.
|
|
23220
|
+
* @description Lists the available conversations. **Required scopes:** - `conversation:read` OR `conversation:write` OR `conversation:all`
|
|
22972
23221
|
*
|
|
22973
23222
|
* @tags conversations
|
|
22974
23223
|
* @name ConversationsListPost
|
|
@@ -22978,7 +23227,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
22978
23227
|
*/
|
|
22979
23228
|
conversationsListPost: (data: ConversationsListRequest, params?: RequestParams) => Promise<AxiosResponse<ConversationsListResponse, any, {}>>;
|
|
22980
23229
|
/**
|
|
22981
|
-
* @description Updates the requested conversation.
|
|
23230
|
+
* @description Updates the requested conversation. **Required scopes:** - `conversation:write` OR `conversation:all`
|
|
22982
23231
|
*
|
|
22983
23232
|
* @tags conversations
|
|
22984
23233
|
* @name ConversationsUpdate
|
|
@@ -22988,7 +23237,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
22988
23237
|
*/
|
|
22989
23238
|
conversationsUpdate: (data: ConversationsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<ConversationsUpdateResponse, any, {}>>;
|
|
22990
23239
|
/**
|
|
22991
|
-
* @description Counts custom objects.
|
|
23240
|
+
* @description Counts custom objects. **Required scopes:** No scopes required.
|
|
22992
23241
|
*
|
|
22993
23242
|
* @tags customization
|
|
22994
23243
|
* @name CustomObjectsCount
|
|
@@ -23007,7 +23256,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
23007
23256
|
filters?: any[];
|
|
23008
23257
|
}, params?: RequestParams) => Promise<AxiosResponse<CustomObjectsCountResponse, any, {}>>;
|
|
23009
23258
|
/**
|
|
23010
|
-
* @description Counts custom objects.
|
|
23259
|
+
* @description Counts custom objects. **Required scopes:** No scopes required.
|
|
23011
23260
|
*
|
|
23012
23261
|
* @tags customization
|
|
23013
23262
|
* @name CustomObjectsCountPost
|
|
@@ -23018,7 +23267,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
23018
23267
|
*/
|
|
23019
23268
|
customObjectsCountPost: (data: CustomObjectsCountRequest, params?: RequestParams) => Promise<AxiosResponse<CustomObjectsCountResponse, any, {}>>;
|
|
23020
23269
|
/**
|
|
23021
|
-
* @description Creates a custom object.
|
|
23270
|
+
* @description Creates a custom object. **Required scopes:** - `custom_type_fragment:write`
|
|
23022
23271
|
*
|
|
23023
23272
|
* @tags customization
|
|
23024
23273
|
* @name CustomObjectsCreate
|
|
@@ -23028,7 +23277,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
23028
23277
|
*/
|
|
23029
23278
|
customObjectsCreate: (data: CustomObjectsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<CustomObjectsCreateResponse, any, {}>>;
|
|
23030
23279
|
/**
|
|
23031
|
-
* @description Deletes a custom object.
|
|
23280
|
+
* @description Deletes a custom object. **Required scopes:** - `custom_type_fragment:write`
|
|
23032
23281
|
*
|
|
23033
23282
|
* @tags customization
|
|
23034
23283
|
* @name CustomObjectsDelete
|
|
@@ -23038,7 +23287,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
23038
23287
|
*/
|
|
23039
23288
|
customObjectsDelete: (data: CustomObjectsDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
|
|
23040
23289
|
/**
|
|
23041
|
-
* @description Gets a custom object.
|
|
23290
|
+
* @description Gets a custom object. **Required scopes:** No scopes required.
|
|
23042
23291
|
*
|
|
23043
23292
|
* @tags customization
|
|
23044
23293
|
* @name CustomObjectsGet
|
|
@@ -23054,7 +23303,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
23054
23303
|
id?: string;
|
|
23055
23304
|
}, params?: RequestParams) => Promise<AxiosResponse<CustomObjectsGetResponse, any, {}>>;
|
|
23056
23305
|
/**
|
|
23057
|
-
* @description Gets a custom object.
|
|
23306
|
+
* @description Gets a custom object. **Required scopes:** No scopes required.
|
|
23058
23307
|
*
|
|
23059
23308
|
* @tags customization
|
|
23060
23309
|
* @name CustomObjectsGetPost
|
|
@@ -23064,7 +23313,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
23064
23313
|
*/
|
|
23065
23314
|
customObjectsGetPost: (data: CustomObjectsGetRequest, params?: RequestParams) => Promise<AxiosResponse<CustomObjectsGetResponse, any, {}>>;
|
|
23066
23315
|
/**
|
|
23067
|
-
* @description Lists custom objects.
|
|
23316
|
+
* @description Lists custom objects. **Required scopes:** No scopes required.
|
|
23068
23317
|
*
|
|
23069
23318
|
* @tags customization
|
|
23070
23319
|
* @name CustomObjectsList
|
|
@@ -23100,7 +23349,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
23100
23349
|
sort_by?: string[];
|
|
23101
23350
|
}, params?: RequestParams) => Promise<AxiosResponse<CustomObjectsListResponse, any, {}>>;
|
|
23102
23351
|
/**
|
|
23103
|
-
* @description Lists custom objects.
|
|
23352
|
+
* @description Lists custom objects. **Required scopes:** No scopes required.
|
|
23104
23353
|
*
|
|
23105
23354
|
* @tags customization
|
|
23106
23355
|
* @name CustomObjectsListPost
|
|
@@ -23111,7 +23360,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
23111
23360
|
*/
|
|
23112
23361
|
customObjectsListPost: (data: CustomObjectsListRequest, params?: RequestParams) => Promise<AxiosResponse<CustomObjectsListResponse, any, {}>>;
|
|
23113
23362
|
/**
|
|
23114
|
-
* @description Updates a custom object.
|
|
23363
|
+
* @description Updates a custom object. **Required scopes:** - `custom_type_fragment:write`
|
|
23115
23364
|
*
|
|
23116
23365
|
* @tags customization
|
|
23117
23366
|
* @name CustomObjectsUpdate
|
|
@@ -23121,7 +23370,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
23121
23370
|
*/
|
|
23122
23371
|
customObjectsUpdate: (data: CustomObjectsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<CustomObjectsUpdateResponse, any, {}>>;
|
|
23123
23372
|
/**
|
|
23124
|
-
* @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:**
|
|
23373
|
+
* @description Creates a new enterprise authentication connection for a Dev organization. This authentication connection will not be enabled by default for the organization and the user will need to explicitly enable this. Only 5 authentication connections can be created by an organization. **Required scopes:** Cannot be called via service account.
|
|
23125
23374
|
*
|
|
23126
23375
|
* @tags auth-connections, dev-orgs
|
|
23127
23376
|
* @name DevOrgAuthConnectionsCreate
|
|
@@ -23131,7 +23380,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
23131
23380
|
*/
|
|
23132
23381
|
devOrgAuthConnectionsCreate: (data: DevOrgAuthConnectionsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<DevOrgAuthConnectionsCreateResponse, any, {}>>;
|
|
23133
23382
|
/**
|
|
23134
|
-
* @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:**
|
|
23383
|
+
* @description Deletes an authentication connection. Only enterprise connections which are explicitly set up for a Dev organization can be deleted. Default connections can not be deleted using this method. **Required scopes:** Cannot be called via service account.
|
|
23135
23384
|
*
|
|
23136
23385
|
* @tags auth-connections, dev-orgs
|
|
23137
23386
|
* @name DevOrgAuthConnectionsDelete
|
|
@@ -23141,7 +23390,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
23141
23390
|
*/
|
|
23142
23391
|
devOrgAuthConnectionsDelete: (data: DevOrgAuthConnectionsDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
|
|
23143
23392
|
/**
|
|
23144
|
-
* @description Retrieves the details for an authentication connection. **Required scopes:** - `
|
|
23393
|
+
* @description Retrieves the details for an authentication connection. **Required scopes:** - `Cannot be called via service account.`
|
|
23145
23394
|
*
|
|
23146
23395
|
* @tags auth-connections, dev-orgs
|
|
23147
23396
|
* @name DevOrgAuthConnectionsGet
|
|
@@ -23157,7 +23406,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
23157
23406
|
id: string;
|
|
23158
23407
|
}, params?: RequestParams) => Promise<AxiosResponse<DevOrgAuthConnectionsGetResponse, any, {}>>;
|
|
23159
23408
|
/**
|
|
23160
|
-
* @description Retrieves the details for an authentication connection. **Required scopes:** - `
|
|
23409
|
+
* @description Retrieves the details for an authentication connection. **Required scopes:** - `Cannot be called via service account.`
|
|
23161
23410
|
*
|
|
23162
23411
|
* @tags auth-connections, dev-orgs
|
|
23163
23412
|
* @name DevOrgAuthConnectionsGetPost
|
|
@@ -23167,7 +23416,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
23167
23416
|
*/
|
|
23168
23417
|
devOrgAuthConnectionsGetPost: (data: DevOrgAuthConnectionsGetRequest, params?: RequestParams) => Promise<AxiosResponse<DevOrgAuthConnectionsGetResponse, any, {}>>;
|
|
23169
23418
|
/**
|
|
23170
|
-
* @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:**
|
|
23419
|
+
* @description Lists all the authentication connections available for a Dev organization. This list will include both social and enterprise connections which are either available by default or are explicitly created by the user. **Required scopes:** Cannot be called via service account.
|
|
23171
23420
|
*
|
|
23172
23421
|
* @tags auth-connections, dev-orgs
|
|
23173
23422
|
* @name DevOrgAuthConnectionsList
|
|
@@ -23177,7 +23426,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
23177
23426
|
*/
|
|
23178
23427
|
devOrgAuthConnectionsList: (params?: RequestParams) => Promise<AxiosResponse<DevOrgAuthConnectionsListResponse, any, {}>>;
|
|
23179
23428
|
/**
|
|
23180
|
-
* @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:**
|
|
23429
|
+
* @description Lists all the authentication connections available for a Dev organization. This list will include both social and enterprise connections which are either available by default or are explicitly created by the user. **Required scopes:** Cannot be called via service account.
|
|
23181
23430
|
*
|
|
23182
23431
|
* @tags auth-connections, dev-orgs
|
|
23183
23432
|
* @name DevOrgAuthConnectionsListPost
|
|
@@ -23187,7 +23436,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
23187
23436
|
*/
|
|
23188
23437
|
devOrgAuthConnectionsListPost: (data: Empty, params?: RequestParams) => Promise<AxiosResponse<DevOrgAuthConnectionsListResponse, any, {}>>;
|
|
23189
23438
|
/**
|
|
23190
|
-
* @description Enable or disable an authentication connection for a Dev organization. Atleast one authentication connection must be enabled for a Dev organization. **Required scopes:**
|
|
23439
|
+
* @description Enable or disable an authentication connection for a Dev organization. Atleast one authentication connection must be enabled for a Dev organization. **Required scopes:** Cannot be called via service account.
|
|
23191
23440
|
*
|
|
23192
23441
|
* @tags auth-connections, dev-orgs
|
|
23193
23442
|
* @name DevOrgAuthConnectionsToggle
|
|
@@ -23197,7 +23446,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
23197
23446
|
*/
|
|
23198
23447
|
devOrgAuthConnectionsToggle: (data: DevOrgAuthConnectionsToggleRequest, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
|
|
23199
23448
|
/**
|
|
23200
|
-
* @description Updates an authentication connection. **Required scopes:**
|
|
23449
|
+
* @description Updates an authentication connection. **Required scopes:** Cannot be called via service account.
|
|
23201
23450
|
*
|
|
23202
23451
|
* @tags auth-connections, dev-orgs
|
|
23203
23452
|
* @name DevOrgAuthConnectionsUpdate
|
|
@@ -23207,7 +23456,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
23207
23456
|
*/
|
|
23208
23457
|
devOrgAuthConnectionsUpdate: (data: DevOrgAuthConnectionsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<DevOrgAuthConnectionsUpdateResponse, any, {}>>;
|
|
23209
23458
|
/**
|
|
23210
|
-
* @description Gets the Dev organization's information of the authenticated user. **Required scopes:** - `dev_org:read`
|
|
23459
|
+
* @description Gets the Dev organization's information of the authenticated user. **Required scopes:** - `dev_org:read` OR `dev_org:write`
|
|
23211
23460
|
*
|
|
23212
23461
|
* @tags dev-orgs
|
|
23213
23462
|
* @name DevOrgsGet
|
|
@@ -23217,7 +23466,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
23217
23466
|
*/
|
|
23218
23467
|
devOrgsGet: (params?: RequestParams) => Promise<AxiosResponse<DevOrgsGetResponse, any, {}>>;
|
|
23219
23468
|
/**
|
|
23220
|
-
* @description Gets the Dev organization's information of the authenticated user. **Required scopes:** - `dev_org:read`
|
|
23469
|
+
* @description Gets the Dev organization's information of the authenticated user. **Required scopes:** - `dev_org:read` OR `dev_org:write`
|
|
23221
23470
|
*
|
|
23222
23471
|
* @tags dev-orgs
|
|
23223
23472
|
* @name DevOrgsGetPost
|
|
@@ -23227,7 +23476,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
23227
23476
|
*/
|
|
23228
23477
|
devOrgsGetPost: (data: DevOrgsGetRequest, params?: RequestParams) => Promise<AxiosResponse<DevOrgsGetResponse, any, {}>>;
|
|
23229
23478
|
/**
|
|
23230
|
-
* @description Activates the requested user. **Required scopes:** - `dev_user:write`
|
|
23479
|
+
* @description Activates the requested user. **Required scopes:** - `dev_user:write` OR `dev_user:all`
|
|
23231
23480
|
*
|
|
23232
23481
|
* @tags dev-users
|
|
23233
23482
|
* @name DevUsersActivate
|
|
@@ -23237,7 +23486,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
23237
23486
|
*/
|
|
23238
23487
|
devUsersActivate: (data: DevUsersActivateRequest, params?: RequestParams) => Promise<AxiosResponse<DevUsersActivateResponse, any, {}>>;
|
|
23239
23488
|
/**
|
|
23240
|
-
* @description Creates a Dev user for a Dev organization. **Required scopes:** - `dev_user:write`
|
|
23489
|
+
* @description Creates a Dev user for a Dev organization. **Required scopes:** - `dev_user:write` OR `dev_user:all`
|
|
23241
23490
|
*
|
|
23242
23491
|
* @tags dev-users
|
|
23243
23492
|
* @name DevUsersCreate
|
|
@@ -23257,7 +23506,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
23257
23506
|
*/
|
|
23258
23507
|
devUsersDeactivate: (data: DevUsersDeactivateRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
|
|
23259
23508
|
/**
|
|
23260
|
-
* @description Gets the requested user's information. **Required scopes:** - `dev_user:read`
|
|
23509
|
+
* @description Gets the requested user's information. **Required scopes:** - `dev_user:read` OR `dev_user:write` OR `dev_user:all`
|
|
23261
23510
|
*
|
|
23262
23511
|
* @tags dev-users
|
|
23263
23512
|
* @name DevUsersGet
|
|
@@ -23273,7 +23522,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
23273
23522
|
id: string;
|
|
23274
23523
|
}, params?: RequestParams) => Promise<AxiosResponse<DevUsersGetResponse, any, {}>>;
|
|
23275
23524
|
/**
|
|
23276
|
-
* @description Gets the requested user's information. **Required scopes:** - `dev_user:read`
|
|
23525
|
+
* @description Gets the requested user's information. **Required scopes:** - `dev_user:read` OR `dev_user:write` OR `dev_user:all`
|
|
23277
23526
|
*
|
|
23278
23527
|
* @tags dev-users
|
|
23279
23528
|
* @name DevUsersGetPost
|
|
@@ -23283,7 +23532,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
23283
23532
|
*/
|
|
23284
23533
|
devUsersGetPost: (data: DevUsersGetRequest, params?: RequestParams) => Promise<AxiosResponse<DevUsersGetResponse, any, {}>>;
|
|
23285
23534
|
/**
|
|
23286
|
-
* @description Links an external/secondary identity to the Dev user. **Required scopes:** - `dev_user:write`
|
|
23535
|
+
* @description Links an external/secondary identity to the Dev user. **Required scopes:** - `dev_user:write` OR `dev_user:all`
|
|
23287
23536
|
*
|
|
23288
23537
|
* @tags dev-users
|
|
23289
23538
|
* @name DevUsersIdentitiesLink
|
|
@@ -23293,7 +23542,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
23293
23542
|
*/
|
|
23294
23543
|
devUsersIdentitiesLink: (data: DevUsersIdentitiesLinkRequest, params?: RequestParams) => Promise<AxiosResponse<DevUsersIdentitiesLinkResponse, any, {}>>;
|
|
23295
23544
|
/**
|
|
23296
|
-
* @description Unlinks an external/secondary identity from the Dev user. **Required scopes:** - `dev_user:write`
|
|
23545
|
+
* @description Unlinks an external/secondary identity from the Dev user. **Required scopes:** - `dev_user:write` OR `dev_user:all`
|
|
23297
23546
|
*
|
|
23298
23547
|
* @tags dev-users
|
|
23299
23548
|
* @name DevUsersIdentitiesUnlink
|
|
@@ -23303,7 +23552,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
23303
23552
|
*/
|
|
23304
23553
|
devUsersIdentitiesUnlink: (data: DevUsersIdentitiesUnlinkRequest, params?: RequestParams) => Promise<AxiosResponse<DevUsersIdentitiesUnlinkResponse, any, {}>>;
|
|
23305
23554
|
/**
|
|
23306
|
-
* @description Lists users within your organization. **Required scopes:** - `dev_user:read`
|
|
23555
|
+
* @description Lists users within your organization. **Required scopes:** - `dev_user:read` OR `dev_user:write` OR `dev_user:all`
|
|
23307
23556
|
*
|
|
23308
23557
|
* @tags dev-users
|
|
23309
23558
|
* @name DevUsersList
|
|
@@ -23357,7 +23606,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
23357
23606
|
timezone?: string[];
|
|
23358
23607
|
}, params?: RequestParams) => Promise<AxiosResponse<DevUsersListResponse, any, {}>>;
|
|
23359
23608
|
/**
|
|
23360
|
-
* @description Lists users within your organization. **Required scopes:** - `dev_user:read`
|
|
23609
|
+
* @description Lists users within your organization. **Required scopes:** - `dev_user:read` OR `dev_user:write` OR `dev_user:all`
|
|
23361
23610
|
*
|
|
23362
23611
|
* @tags dev-users
|
|
23363
23612
|
* @name DevUsersListPost
|
|
@@ -23377,7 +23626,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
23377
23626
|
*/
|
|
23378
23627
|
devUsersMerge: (data: DevUsersMergeRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
|
|
23379
23628
|
/**
|
|
23380
|
-
* @description Gets the authenticated user's information. **Required scopes:**
|
|
23629
|
+
* @description Gets the authenticated user's information. **Required scopes:** Default Scopes unavailable for this API
|
|
23381
23630
|
*
|
|
23382
23631
|
* @tags dev-users
|
|
23383
23632
|
* @name DevUsersSelf
|
|
@@ -23387,7 +23636,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
23387
23636
|
*/
|
|
23388
23637
|
devUsersSelf: (params?: RequestParams) => Promise<AxiosResponse<DevUsersSelfResponse, any, {}>>;
|
|
23389
23638
|
/**
|
|
23390
|
-
* @description Gets the authenticated user's information. **Required scopes:**
|
|
23639
|
+
* @description Gets the authenticated user's information. **Required scopes:** Default Scopes unavailable for this API
|
|
23391
23640
|
*
|
|
23392
23641
|
* @tags dev-users
|
|
23393
23642
|
* @name DevUsersSelfPost
|
|
@@ -23397,7 +23646,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
23397
23646
|
*/
|
|
23398
23647
|
devUsersSelfPost: (data: DevUsersSelfRequest, params?: RequestParams) => Promise<AxiosResponse<DevUsersSelfResponse, any, {}>>;
|
|
23399
23648
|
/**
|
|
23400
|
-
* @description Updates the authenticated user. **Required scopes:**
|
|
23649
|
+
* @description Updates the authenticated user. **Required scopes:** Default Scopes unavailable for this API
|
|
23401
23650
|
*
|
|
23402
23651
|
* @tags dev-users
|
|
23403
23652
|
* @name DevUsersSelfUpdate
|
|
@@ -23407,7 +23656,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
23407
23656
|
*/
|
|
23408
23657
|
devUsersSelfUpdate: (data: DevUsersSelfUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<DevUsersUpdateResponse, any, {}>>;
|
|
23409
23658
|
/**
|
|
23410
|
-
* @description Updates the user corresponding to the input Id. **Required scopes:** - `dev_user:write`
|
|
23659
|
+
* @description Updates the user corresponding to the input Id. **Required scopes:** - `dev_user:write` OR `dev_user:all`
|
|
23411
23660
|
*
|
|
23412
23661
|
* @tags dev-users
|
|
23413
23662
|
* @name DevUsersUpdate
|
|
@@ -23417,7 +23666,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
23417
23666
|
*/
|
|
23418
23667
|
devUsersUpdate: (data: DevUsersUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<DevUsersUpdateResponse, any, {}>>;
|
|
23419
23668
|
/**
|
|
23420
|
-
* @description Get count of directories matching given filter.
|
|
23669
|
+
* @description Get count of directories matching given filter. **Required scopes:** - `directory:read` OR `directory:write` OR `directory:all`
|
|
23421
23670
|
*
|
|
23422
23671
|
* @tags directory
|
|
23423
23672
|
* @name DirectoriesCount
|
|
@@ -23438,7 +23687,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
23438
23687
|
modified_by?: string[];
|
|
23439
23688
|
}, params?: RequestParams) => Promise<AxiosResponse<DirectoriesCountResponse, any, {}>>;
|
|
23440
23689
|
/**
|
|
23441
|
-
* @description Get count of directories matching given filter.
|
|
23690
|
+
* @description Get count of directories matching given filter. **Required scopes:** - `directory:read` OR `directory:write` OR `directory:all`
|
|
23442
23691
|
*
|
|
23443
23692
|
* @tags directory
|
|
23444
23693
|
* @name DirectoriesCountPost
|
|
@@ -23448,7 +23697,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
23448
23697
|
*/
|
|
23449
23698
|
directoriesCountPost: (data: DirectoriesCountRequest, params?: RequestParams) => Promise<AxiosResponse<DirectoriesCountResponse, any, {}>>;
|
|
23450
23699
|
/**
|
|
23451
|
-
* @description Creates a directory for the specified inputs.
|
|
23700
|
+
* @description Creates a directory for the specified inputs. **Required scopes:** - `directory:write` OR `directory:all`
|
|
23452
23701
|
*
|
|
23453
23702
|
* @tags directory
|
|
23454
23703
|
* @name DirectoriesCreate
|
|
@@ -23458,7 +23707,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
23458
23707
|
*/
|
|
23459
23708
|
directoriesCreate: (data: DirectoriesCreateRequest, params?: RequestParams) => Promise<AxiosResponse<DirectoriesCreateResponse, any, {}>>;
|
|
23460
23709
|
/**
|
|
23461
|
-
* @description Delete the specified directory.
|
|
23710
|
+
* @description Delete the specified directory. **Required scopes:** - `directory:all`
|
|
23462
23711
|
*
|
|
23463
23712
|
* @tags directory
|
|
23464
23713
|
* @name DirectoriesDelete
|
|
@@ -23468,7 +23717,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
23468
23717
|
*/
|
|
23469
23718
|
directoriesDelete: (data: DirectoriesDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
|
|
23470
23719
|
/**
|
|
23471
|
-
* @description Gets the specified directory.
|
|
23720
|
+
* @description Gets the specified directory. **Required scopes:** - `directory:read` OR `directory:write` OR `directory:all`
|
|
23472
23721
|
*
|
|
23473
23722
|
* @tags directory
|
|
23474
23723
|
* @name DirectoriesGet
|
|
@@ -23484,7 +23733,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
23484
23733
|
id?: string;
|
|
23485
23734
|
}, params?: RequestParams) => Promise<AxiosResponse<DirectoriesGetResponse, any, {}>>;
|
|
23486
23735
|
/**
|
|
23487
|
-
* @description Gets the specified directory.
|
|
23736
|
+
* @description Gets the specified directory. **Required scopes:** - `directory:read` OR `directory:write` OR `directory:all`
|
|
23488
23737
|
*
|
|
23489
23738
|
* @tags directory
|
|
23490
23739
|
* @name DirectoriesGetPost
|
|
@@ -23494,7 +23743,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
23494
23743
|
*/
|
|
23495
23744
|
directoriesGetPost: (data: DirectoriesGetRequest, params?: RequestParams) => Promise<AxiosResponse<DirectoriesGetResponse, any, {}>>;
|
|
23496
23745
|
/**
|
|
23497
|
-
* @description Lists directories matching the request.
|
|
23746
|
+
* @description Lists directories matching the request. **Required scopes:** - `directory:read` OR `directory:write` OR `directory:all`
|
|
23498
23747
|
*
|
|
23499
23748
|
* @tags directory
|
|
23500
23749
|
* @name DirectoriesList
|
|
@@ -23531,7 +23780,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
23531
23780
|
modified_by?: string[];
|
|
23532
23781
|
}, params?: RequestParams) => Promise<AxiosResponse<DirectoriesListResponse, any, {}>>;
|
|
23533
23782
|
/**
|
|
23534
|
-
* @description Lists directories matching the request.
|
|
23783
|
+
* @description Lists directories matching the request. **Required scopes:** - `directory:read` OR `directory:write` OR `directory:all`
|
|
23535
23784
|
*
|
|
23536
23785
|
* @tags directory
|
|
23537
23786
|
* @name DirectoriesListPost
|
|
@@ -23541,7 +23790,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
23541
23790
|
*/
|
|
23542
23791
|
directoriesListPost: (data: DirectoriesListRequest, params?: RequestParams) => Promise<AxiosResponse<DirectoriesListResponse, any, {}>>;
|
|
23543
23792
|
/**
|
|
23544
|
-
* @description Updates the specified directory.
|
|
23793
|
+
* @description Updates the specified directory. **Required scopes:** - `directory:write` OR `directory:all`
|
|
23545
23794
|
*
|
|
23546
23795
|
* @tags directory
|
|
23547
23796
|
* @name DirectoriesUpdate
|
|
@@ -23551,7 +23800,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
23551
23800
|
*/
|
|
23552
23801
|
directoriesUpdate: (data: DirectoriesUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<DirectoriesUpdateResponse, any, {}>>;
|
|
23553
23802
|
/**
|
|
23554
|
-
* @description Creates a new group. A group is a collection of users. **Required scopes:** - `group:write`
|
|
23803
|
+
* @description Creates a new group. A group is a collection of users. **Required scopes:** - `group:write` OR `group:all`
|
|
23555
23804
|
*
|
|
23556
23805
|
* @tags groups
|
|
23557
23806
|
* @name GroupsCreate
|
|
@@ -23561,7 +23810,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
23561
23810
|
*/
|
|
23562
23811
|
groupsCreate: (data: GroupsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<GroupsCreateResponse, any, {}>>;
|
|
23563
23812
|
/**
|
|
23564
|
-
* @description Gets the requested group. **Required scopes:** - `group:read`
|
|
23813
|
+
* @description Gets the requested group. **Required scopes:** - `group:read` OR `group:write` OR `group:all`
|
|
23565
23814
|
*
|
|
23566
23815
|
* @tags groups
|
|
23567
23816
|
* @name GroupsGet
|
|
@@ -23577,7 +23826,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
23577
23826
|
id: string;
|
|
23578
23827
|
}, params?: RequestParams) => Promise<AxiosResponse<GroupsGetResponse, any, {}>>;
|
|
23579
23828
|
/**
|
|
23580
|
-
* @description Gets the requested group. **Required scopes:** - `group:read`
|
|
23829
|
+
* @description Gets the requested group. **Required scopes:** - `group:read` OR `group:write` OR `group:all`
|
|
23581
23830
|
*
|
|
23582
23831
|
* @tags groups
|
|
23583
23832
|
* @name GroupsGetPost
|
|
@@ -23587,7 +23836,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
23587
23836
|
*/
|
|
23588
23837
|
groupsGetPost: (data: GroupsGetRequest, params?: RequestParams) => Promise<AxiosResponse<GroupsGetResponse, any, {}>>;
|
|
23589
23838
|
/**
|
|
23590
|
-
* @description Lists the available groups. **Required scopes:** - `group:read`
|
|
23839
|
+
* @description Lists the available groups. **Required scopes:** - `group:read` OR `group:write` OR `group:all`
|
|
23591
23840
|
*
|
|
23592
23841
|
* @tags groups
|
|
23593
23842
|
* @name GroupsList
|
|
@@ -23608,6 +23857,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
23608
23857
|
group_type?: GroupType[];
|
|
23609
23858
|
/** Filter groups by ingestion source(s). */
|
|
23610
23859
|
ingestion_source?: GroupIngestionSource[];
|
|
23860
|
+
/** Filters the groups on the basis of archival status. */
|
|
23861
|
+
is_archived?: boolean;
|
|
23611
23862
|
/** Whether to fetch default or custom groups. */
|
|
23612
23863
|
is_default?: boolean;
|
|
23613
23864
|
/**
|
|
@@ -23658,7 +23909,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
23658
23909
|
'sync_metadata.origin_system'?: string[];
|
|
23659
23910
|
}, params?: RequestParams) => Promise<AxiosResponse<GroupsListResponse, any, {}>>;
|
|
23660
23911
|
/**
|
|
23661
|
-
* @description Lists the available groups. **Required scopes:** - `group:read`
|
|
23912
|
+
* @description Lists the available groups. **Required scopes:** - `group:read` OR `group:write` OR `group:all`
|
|
23662
23913
|
*
|
|
23663
23914
|
* @tags groups
|
|
23664
23915
|
* @name GroupsListPost
|
|
@@ -23668,7 +23919,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
23668
23919
|
*/
|
|
23669
23920
|
groupsListPost: (data: GroupsListRequest, params?: RequestParams) => Promise<AxiosResponse<GroupsListResponse, any, {}>>;
|
|
23670
23921
|
/**
|
|
23671
|
-
* @description Adds a member to a group. **Required scopes:** - `group_membership:
|
|
23922
|
+
* @description Adds a member to a group. **Required scopes:** - `group_membership:all`
|
|
23672
23923
|
*
|
|
23673
23924
|
* @tags groups
|
|
23674
23925
|
* @name GroupMembersAdd
|
|
@@ -23678,7 +23929,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
23678
23929
|
*/
|
|
23679
23930
|
groupMembersAdd: (data: GroupMembersAddRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
|
|
23680
23931
|
/**
|
|
23681
|
-
* @description Lists the members in a group. **Required scopes:** - `group_membership:read`
|
|
23932
|
+
* @description Lists the members in a group. **Required scopes:** - `group_membership:read` OR `group_membership:all`
|
|
23682
23933
|
*
|
|
23683
23934
|
* @tags groups
|
|
23684
23935
|
* @name GroupMembersList
|
|
@@ -23713,7 +23964,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
23713
23964
|
sort_by?: string[];
|
|
23714
23965
|
}, params?: RequestParams) => Promise<AxiosResponse<GroupMembersListResponse, any, {}>>;
|
|
23715
23966
|
/**
|
|
23716
|
-
* @description Lists the members in a group. **Required scopes:** - `group_membership:read`
|
|
23967
|
+
* @description Lists the members in a group. **Required scopes:** - `group_membership:read` OR `group_membership:all`
|
|
23717
23968
|
*
|
|
23718
23969
|
* @tags groups
|
|
23719
23970
|
* @name GroupMembersListPost
|
|
@@ -23723,7 +23974,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
23723
23974
|
*/
|
|
23724
23975
|
groupMembersListPost: (data: GroupMembersListRequest, params?: RequestParams) => Promise<AxiosResponse<GroupMembersListResponse, any, {}>>;
|
|
23725
23976
|
/**
|
|
23726
|
-
* @description Removes a member from a group. **Required scopes:** - `group_membership:
|
|
23977
|
+
* @description Removes a member from a group. **Required scopes:** - `group_membership:all`
|
|
23727
23978
|
*
|
|
23728
23979
|
* @tags groups
|
|
23729
23980
|
* @name GroupMembersRemove
|
|
@@ -23733,7 +23984,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
23733
23984
|
*/
|
|
23734
23985
|
groupMembersRemove: (data: GroupMembersRemoveRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
|
|
23735
23986
|
/**
|
|
23736
|
-
* @description Updates the requested group. **Required scopes:** - `group:write`
|
|
23987
|
+
* @description Updates the requested group. **Required scopes:** - `group:write` OR `group:all`
|
|
23737
23988
|
*
|
|
23738
23989
|
* @tags groups
|
|
23739
23990
|
* @name GroupsUpdate
|
|
@@ -23743,7 +23994,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
23743
23994
|
*/
|
|
23744
23995
|
groupsUpdate: (data: GroupsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<GroupsUpdateResponse, any, {}>>;
|
|
23745
23996
|
/**
|
|
23746
|
-
* @description Retrieves a job's information.
|
|
23997
|
+
* @description Retrieves a job's information. **Required scopes:** - `job:read`
|
|
23747
23998
|
*
|
|
23748
23999
|
* @tags jobs
|
|
23749
24000
|
* @name GetJob
|
|
@@ -23759,7 +24010,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
23759
24010
|
id: string;
|
|
23760
24011
|
}, params?: RequestParams) => Promise<AxiosResponse<JobsGetResponse, any, {}>>;
|
|
23761
24012
|
/**
|
|
23762
|
-
* @description Retrieves a job's information.
|
|
24013
|
+
* @description Retrieves a job's information. **Required scopes:** - `job:read`
|
|
23763
24014
|
*
|
|
23764
24015
|
* @tags jobs
|
|
23765
24016
|
* @name GetJobPost
|
|
@@ -23769,7 +24020,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
23769
24020
|
*/
|
|
23770
24021
|
getJobPost: (data: JobsGetRequest, params?: RequestParams) => Promise<AxiosResponse<JobsGetResponse, any, {}>>;
|
|
23771
24022
|
/**
|
|
23772
|
-
* @description Gets a list of jobs.
|
|
24023
|
+
* @description Gets a list of jobs. **Required scopes:** - `job:read`
|
|
23773
24024
|
*
|
|
23774
24025
|
* @tags jobs
|
|
23775
24026
|
* @name ListJobs
|
|
@@ -23808,7 +24059,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
23808
24059
|
state?: JobState[];
|
|
23809
24060
|
}, params?: RequestParams) => Promise<AxiosResponse<JobsListResponse, any, {}>>;
|
|
23810
24061
|
/**
|
|
23811
|
-
* @description Gets a list of jobs.
|
|
24062
|
+
* @description Gets a list of jobs. **Required scopes:** - `job:read`
|
|
23812
24063
|
*
|
|
23813
24064
|
* @tags jobs
|
|
23814
24065
|
* @name ListJobsPost
|
|
@@ -23818,7 +24069,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
23818
24069
|
*/
|
|
23819
24070
|
listJobsPost: (data: JobsListRequest, params?: RequestParams) => Promise<AxiosResponse<JobsListResponse, any, {}>>;
|
|
23820
24071
|
/**
|
|
23821
|
-
* @description OAuth2 authorization callback.
|
|
24072
|
+
* @description OAuth2 authorization callback. **Required scopes:** - `keyring:read`
|
|
23822
24073
|
*
|
|
23823
24074
|
* @tags keyrings
|
|
23824
24075
|
* @name KeyringsCreateCallback
|
|
@@ -23838,7 +24089,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
23838
24089
|
state: string;
|
|
23839
24090
|
}, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
|
|
23840
24091
|
/**
|
|
23841
|
-
* @description OAuth2 authorization callback.
|
|
24092
|
+
* @description OAuth2 authorization callback. **Required scopes:** - `keyring:read`
|
|
23842
24093
|
*
|
|
23843
24094
|
* @tags keyrings
|
|
23844
24095
|
* @name KeyringsCreateCallbackPost
|
|
@@ -23848,7 +24099,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
23848
24099
|
*/
|
|
23849
24100
|
keyringsCreateCallbackPost: (data: KeyringsCreateCallbackRequest, params?: RequestParams) => Promise<AxiosResponse<void, any, {}>>;
|
|
23850
24101
|
/**
|
|
23851
|
-
* @description Creates a link between two objects to indicate a relationship.
|
|
24102
|
+
* @description Creates a link between two objects to indicate a relationship. **Required scopes:** - `link:write` OR `link:all` Also needs linked objects read access.
|
|
23852
24103
|
*
|
|
23853
24104
|
* @tags links
|
|
23854
24105
|
* @name LinksCreate
|
|
@@ -23858,7 +24109,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
23858
24109
|
*/
|
|
23859
24110
|
linksCreate: (data: LinksCreateRequest, params?: RequestParams) => Promise<AxiosResponse<LinksCreateResponse, any, {}>>;
|
|
23860
24111
|
/**
|
|
23861
|
-
* @description Deletes a link between two objects. Note that for part hierarchy links (e.g. enhancement to capability), deleting a link may leave an orphan object with no parent. If the intent is to re-parent an object rather than unlink it entirely, use `links.replace` instead, which atomically removes the old link and creates a new one in a single transaction.
|
|
24112
|
+
* @description Deletes a link between two objects. Note that for part hierarchy links (e.g. enhancement to capability), deleting a link may leave an orphan object with no parent. If the intent is to re-parent an object rather than unlink it entirely, use `links.replace` instead, which atomically removes the old link and creates a new one in a single transaction. **Required scopes:** - `link:all` Also needs linked objects read access.
|
|
23862
24113
|
*
|
|
23863
24114
|
* @tags links
|
|
23864
24115
|
* @name LinksDelete
|
|
@@ -23868,7 +24119,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
23868
24119
|
*/
|
|
23869
24120
|
linksDelete: (data: LinksDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
|
|
23870
24121
|
/**
|
|
23871
|
-
* @description Gets the requested link's information.
|
|
24122
|
+
* @description Gets the requested link's information. **Required scopes:** - `link:read` OR `link:write` OR `link:all`
|
|
23872
24123
|
*
|
|
23873
24124
|
* @tags links
|
|
23874
24125
|
* @name LinksGet
|
|
@@ -23884,7 +24135,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
23884
24135
|
id: string;
|
|
23885
24136
|
}, params?: RequestParams) => Promise<AxiosResponse<LinksGetResponse, any, {}>>;
|
|
23886
24137
|
/**
|
|
23887
|
-
* @description Gets the requested link's information.
|
|
24138
|
+
* @description Gets the requested link's information. **Required scopes:** - `link:read` OR `link:write` OR `link:all`
|
|
23888
24139
|
*
|
|
23889
24140
|
* @tags links
|
|
23890
24141
|
* @name LinksGetPost
|
|
@@ -23894,7 +24145,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
23894
24145
|
*/
|
|
23895
24146
|
linksGetPost: (data: LinksGetRequest, params?: RequestParams) => Promise<AxiosResponse<LinksGetResponse, any, {}>>;
|
|
23896
24147
|
/**
|
|
23897
|
-
* @description Lists the available links.
|
|
24148
|
+
* @description Lists the available links. **Required scopes:** - `link:read` OR `link:write` OR `link:all`
|
|
23898
24149
|
*
|
|
23899
24150
|
* @tags links
|
|
23900
24151
|
* @name LinksList
|
|
@@ -23953,7 +24204,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
23953
24204
|
types?: LinkType[];
|
|
23954
24205
|
}, params?: RequestParams) => Promise<AxiosResponse<LinksListResponse, any, {}>>;
|
|
23955
24206
|
/**
|
|
23956
|
-
* @description Lists the available links.
|
|
24207
|
+
* @description Lists the available links. **Required scopes:** - `link:read` OR `link:write` OR `link:all`
|
|
23957
24208
|
*
|
|
23958
24209
|
* @tags links
|
|
23959
24210
|
* @name LinksListPost
|
|
@@ -23963,7 +24214,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
23963
24214
|
*/
|
|
23964
24215
|
linksListPost: (data: LinksListRequest, params?: RequestParams) => Promise<AxiosResponse<LinksListResponse, any, {}>>;
|
|
23965
24216
|
/**
|
|
23966
|
-
* @description Replaces an existing link with a new one. This is useful when an object must always remain linked to a parent — for example, re-parenting an enhancement under a different capability or product part — because it avoids the intermediate unlinked (orphan) state that would otherwise occur if you deleted the old link and created a new one as two separate steps. The existing link identified by `id` is removed and a new link is created from `source` to `target`. Optionally, a different `link_type` or `custom_link_type` can be specified for the new link. For links between parts using a default (non-custom) link type, the replacement is performed atomically. For all other cases (custom link types or non-part endpoints), the replacement is performed as a non-atomic delete followed by a create; in these cases, the new link must have the same link type (or the same `custom_link_type` DON) as the existing link, and must share at least one of the source or target with the existing link, otherwise the request is rejected.
|
|
24217
|
+
* @description Replaces an existing link with a new one. This is useful when an object must always remain linked to a parent — for example, re-parenting an enhancement under a different capability or product part — because it avoids the intermediate unlinked (orphan) state that would otherwise occur if you deleted the old link and created a new one as two separate steps. The existing link identified by `id` is removed and a new link is created from `source` to `target`. Optionally, a different `link_type` or `custom_link_type` can be specified for the new link. For links between parts using a default (non-custom) link type, the replacement is performed atomically. For all other cases (custom link types or non-part endpoints), the replacement is performed as a non-atomic delete followed by a create; in these cases, the new link must have the same link type (or the same `custom_link_type` DON) as the existing link, and must share at least one of the source or target with the existing link, otherwise the request is rejected. **Required scopes:** - `link:write` OR `link:all` Also needs linked objects read access.
|
|
23967
24218
|
*
|
|
23968
24219
|
* @tags links
|
|
23969
24220
|
* @name LinksReplace
|
|
@@ -23973,7 +24224,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
23973
24224
|
*/
|
|
23974
24225
|
linksReplace: (data: LinksReplaceRequest, params?: RequestParams) => Promise<AxiosResponse<LinksReplaceResponse, any, {}>>;
|
|
23975
24226
|
/**
|
|
23976
|
-
* @description Counts the meeting records.
|
|
24227
|
+
* @description Counts the meeting records. **Required scopes:** - `meeting:read` OR `meeting:write` OR `meeting:all`
|
|
23977
24228
|
*
|
|
23978
24229
|
* @tags meetings
|
|
23979
24230
|
* @name MeetingsCount
|
|
@@ -24046,7 +24297,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
24046
24297
|
tags?: string[];
|
|
24047
24298
|
}, params?: RequestParams) => Promise<AxiosResponse<MeetingsCountResponse, any, {}>>;
|
|
24048
24299
|
/**
|
|
24049
|
-
* @description Counts the meeting records.
|
|
24300
|
+
* @description Counts the meeting records. **Required scopes:** - `meeting:read` OR `meeting:write` OR `meeting:all`
|
|
24050
24301
|
*
|
|
24051
24302
|
* @tags meetings
|
|
24052
24303
|
* @name MeetingsCountPost
|
|
@@ -24056,7 +24307,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
24056
24307
|
*/
|
|
24057
24308
|
meetingsCountPost: (data: MeetingsCountRequest, params?: RequestParams) => Promise<AxiosResponse<MeetingsCountResponse, any, {}>>;
|
|
24058
24309
|
/**
|
|
24059
|
-
* @description Creates a new meeting record.
|
|
24310
|
+
* @description Creates a new meeting record. **Required scopes:** - `meeting:write` OR `meeting:all`
|
|
24060
24311
|
*
|
|
24061
24312
|
* @tags meetings
|
|
24062
24313
|
* @name MeetingsCreate
|
|
@@ -24066,7 +24317,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
24066
24317
|
*/
|
|
24067
24318
|
meetingsCreate: (data: MeetingsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<MeetingsCreateResponse, any, {}>>;
|
|
24068
24319
|
/**
|
|
24069
|
-
* @description Deletes the meeting record.
|
|
24320
|
+
* @description Deletes the meeting record. **Required scopes:** - `meeting:all`
|
|
24070
24321
|
*
|
|
24071
24322
|
* @tags meetings
|
|
24072
24323
|
* @name MeetingsDelete
|
|
@@ -24076,7 +24327,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
24076
24327
|
*/
|
|
24077
24328
|
meetingsDelete: (data: MeetingsDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
|
|
24078
24329
|
/**
|
|
24079
|
-
* @description Gets the meeting record.
|
|
24330
|
+
* @description Gets the meeting record. **Required scopes:** - `meeting:read` OR `meeting:write` OR `meeting:all`
|
|
24080
24331
|
*
|
|
24081
24332
|
* @tags meetings
|
|
24082
24333
|
* @name MeetingsGet
|
|
@@ -24092,7 +24343,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
24092
24343
|
id: string;
|
|
24093
24344
|
}, params?: RequestParams) => Promise<AxiosResponse<MeetingsGetResponse, any, {}>>;
|
|
24094
24345
|
/**
|
|
24095
|
-
* @description Gets the meeting record.
|
|
24346
|
+
* @description Gets the meeting record. **Required scopes:** - `meeting:read` OR `meeting:write` OR `meeting:all`
|
|
24096
24347
|
*
|
|
24097
24348
|
* @tags meetings
|
|
24098
24349
|
* @name MeetingsGetPost
|
|
@@ -24102,7 +24353,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
24102
24353
|
*/
|
|
24103
24354
|
meetingsGetPost: (data: MeetingsGetRequest, params?: RequestParams) => Promise<AxiosResponse<MeetingsGetResponse, any, {}>>;
|
|
24104
24355
|
/**
|
|
24105
|
-
* @description Lists the meeting records.
|
|
24356
|
+
* @description Lists the meeting records. **Required scopes:** - `meeting:read` OR `meeting:write` OR `meeting:all`
|
|
24106
24357
|
*
|
|
24107
24358
|
* @tags meetings
|
|
24108
24359
|
* @name MeetingsList
|
|
@@ -24193,7 +24444,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
24193
24444
|
tags?: string[];
|
|
24194
24445
|
}, params?: RequestParams) => Promise<AxiosResponse<MeetingsListResponse, any, {}>>;
|
|
24195
24446
|
/**
|
|
24196
|
-
* @description Lists the meeting records.
|
|
24447
|
+
* @description Lists the meeting records. **Required scopes:** - `meeting:read` OR `meeting:write` OR `meeting:all`
|
|
24197
24448
|
*
|
|
24198
24449
|
* @tags meetings
|
|
24199
24450
|
* @name MeetingsListPost
|
|
@@ -24203,7 +24454,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
24203
24454
|
*/
|
|
24204
24455
|
meetingsListPost: (data: MeetingsListRequest, params?: RequestParams) => Promise<AxiosResponse<MeetingsListResponse, any, {}>>;
|
|
24205
24456
|
/**
|
|
24206
|
-
* @description Updates the meeting record.
|
|
24457
|
+
* @description Updates the meeting record. **Required scopes:** - `meeting:write` OR `meeting:all`
|
|
24207
24458
|
*
|
|
24208
24459
|
* @tags meetings
|
|
24209
24460
|
* @name MeetingsUpdate
|
|
@@ -24213,7 +24464,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
24213
24464
|
*/
|
|
24214
24465
|
meetingsUpdate: (data: MeetingsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<MeetingsUpdateResponse, any, {}>>;
|
|
24215
24466
|
/**
|
|
24216
|
-
* @description Executes the metric action on the given object.
|
|
24467
|
+
* @description Executes the metric action on the given object. **Required scopes:** No scopes required.
|
|
24217
24468
|
*
|
|
24218
24469
|
* @tags slas
|
|
24219
24470
|
* @name MetricActionExecute
|
|
@@ -24223,7 +24474,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
24223
24474
|
*/
|
|
24224
24475
|
metricActionExecute: (data: MetricActionExecuteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
|
|
24225
24476
|
/**
|
|
24226
|
-
* @description Creates a custom metric definition
|
|
24477
|
+
* @description Creates a custom metric definition **Required scopes:** - `metric_definition:write` OR `metric_definition:all`
|
|
24227
24478
|
*
|
|
24228
24479
|
* @tags slas
|
|
24229
24480
|
* @name MetricDefinitionsCreate
|
|
@@ -24233,7 +24484,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
24233
24484
|
*/
|
|
24234
24485
|
metricDefinitionsCreate: (data: MetricDefinitionsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<MetricDefinitionsCreateResponse, any, {}>>;
|
|
24235
24486
|
/**
|
|
24236
|
-
* @description Deletes a custom metric definition
|
|
24487
|
+
* @description Deletes a custom metric definition **Required scopes:** - `metric_definition:all`
|
|
24237
24488
|
*
|
|
24238
24489
|
* @tags slas
|
|
24239
24490
|
* @name MetricDefinitionsDelete
|
|
@@ -24243,7 +24494,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
24243
24494
|
*/
|
|
24244
24495
|
metricDefinitionsDelete: (data: MetricDefinitionsDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
|
|
24245
24496
|
/**
|
|
24246
|
-
* @description Gets a custom metric definition
|
|
24497
|
+
* @description Gets a custom metric definition **Required scopes:** - `metric_definition:read` OR `metric_definition:write` OR `metric_definition:all`
|
|
24247
24498
|
*
|
|
24248
24499
|
* @tags slas
|
|
24249
24500
|
* @name MetricDefinitionsGet
|
|
@@ -24266,7 +24517,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
24266
24517
|
name?: string;
|
|
24267
24518
|
}, params?: RequestParams) => Promise<AxiosResponse<MetricDefinitionsGetResponse, any, {}>>;
|
|
24268
24519
|
/**
|
|
24269
|
-
* @description Gets a custom metric definition
|
|
24520
|
+
* @description Gets a custom metric definition **Required scopes:** - `metric_definition:read` OR `metric_definition:write` OR `metric_definition:all`
|
|
24270
24521
|
*
|
|
24271
24522
|
* @tags slas
|
|
24272
24523
|
* @name MetricDefinitionsGetPost
|
|
@@ -24276,7 +24527,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
24276
24527
|
*/
|
|
24277
24528
|
metricDefinitionsGetPost: (data: MetricDefinitionsGetRequest, params?: RequestParams) => Promise<AxiosResponse<MetricDefinitionsGetResponse, any, {}>>;
|
|
24278
24529
|
/**
|
|
24279
|
-
* @description Lists metric definitions matching a filter.
|
|
24530
|
+
* @description Lists metric definitions matching a filter. **Required scopes:** - `metric_definition:read` OR `metric_definition:write` OR `metric_definition:all`
|
|
24280
24531
|
*
|
|
24281
24532
|
* @tags slas
|
|
24282
24533
|
* @name MetricDefinitionsList
|
|
@@ -24316,7 +24567,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
24316
24567
|
type?: MetricDefinitionMetricType[];
|
|
24317
24568
|
}, params?: RequestParams) => Promise<AxiosResponse<MetricDefinitionsListResponse, any, {}>>;
|
|
24318
24569
|
/**
|
|
24319
|
-
* @description Lists metric definitions matching a filter.
|
|
24570
|
+
* @description Lists metric definitions matching a filter. **Required scopes:** - `metric_definition:read` OR `metric_definition:write` OR `metric_definition:all`
|
|
24320
24571
|
*
|
|
24321
24572
|
* @tags slas
|
|
24322
24573
|
* @name MetricDefinitionsListPost
|
|
@@ -24326,7 +24577,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
24326
24577
|
*/
|
|
24327
24578
|
metricDefinitionsListPost: (data: MetricDefinitionsListRequest, params?: RequestParams) => Promise<AxiosResponse<MetricDefinitionsListResponse, any, {}>>;
|
|
24328
24579
|
/**
|
|
24329
|
-
* @description Updates a custom metric definition
|
|
24580
|
+
* @description Updates a custom metric definition **Required scopes:** - `metric_definition:write` OR `metric_definition:all`
|
|
24330
24581
|
*
|
|
24331
24582
|
* @tags slas
|
|
24332
24583
|
* @name MetricDefinitionsUpdate
|
|
@@ -24336,7 +24587,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
24336
24587
|
*/
|
|
24337
24588
|
metricDefinitionsUpdate: (data: MetricDefinitionsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<MetricDefinitionsUpdateResponse, any, {}>>;
|
|
24338
24589
|
/**
|
|
24339
|
-
* @description Gets a metric tracker.
|
|
24590
|
+
* @description Gets a metric tracker. **Required scopes:** No scopes required.
|
|
24340
24591
|
*
|
|
24341
24592
|
* @tags slas
|
|
24342
24593
|
* @name MetricTrackersGet
|
|
@@ -24357,7 +24608,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
24357
24608
|
object: string;
|
|
24358
24609
|
}, params?: RequestParams) => Promise<AxiosResponse<MetricTrackersGetResponse, any, {}>>;
|
|
24359
24610
|
/**
|
|
24360
|
-
* @description Gets a metric tracker.
|
|
24611
|
+
* @description Gets a metric tracker. **Required scopes:** No scopes required.
|
|
24361
24612
|
*
|
|
24362
24613
|
* @tags slas
|
|
24363
24614
|
* @name MetricTrackersGetPost
|
|
@@ -24367,7 +24618,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
24367
24618
|
*/
|
|
24368
24619
|
metricTrackersGetPost: (data: MetricTrackersGetRequest, params?: RequestParams) => Promise<AxiosResponse<MetricTrackersGetResponse, any, {}>>;
|
|
24369
24620
|
/**
|
|
24370
|
-
* @description Aggregates the sessions data.
|
|
24621
|
+
* @description Aggregates the sessions data. **Required scopes:** No scopes required.
|
|
24371
24622
|
*
|
|
24372
24623
|
* @tags observability
|
|
24373
24624
|
* @name ObservabilitySessionsAggregate
|
|
@@ -24377,7 +24628,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
24377
24628
|
*/
|
|
24378
24629
|
observabilitySessionsAggregate: (data: ObservabilitySessionsAggregateRequest, params?: RequestParams) => Promise<AxiosResponse<ObservabilitySessionsAggregateResponse, any, {}>>;
|
|
24379
24630
|
/**
|
|
24380
|
-
* @description Retrieves the recording data for a specific session ID and recording ID. For mobile sessions, requires both session_id and recording_id. For web sessions, requires both session_id and tab_id.
|
|
24631
|
+
* @description Retrieves the recording data for a specific session ID and recording ID. For mobile sessions, requires both session_id and recording_id. For web sessions, requires both session_id and tab_id. **Required scopes:** No scopes required.
|
|
24381
24632
|
*
|
|
24382
24633
|
* @tags observability
|
|
24383
24634
|
* @name ObservabilitySessionsDataGet
|
|
@@ -24411,7 +24662,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
24411
24662
|
tab_id?: string;
|
|
24412
24663
|
}, params?: RequestParams) => Promise<AxiosResponse<ObservabilitySessionsDataGetResponse, any, {}>>;
|
|
24413
24664
|
/**
|
|
24414
|
-
* @description Retrieves the recording data for a specific session ID and recording ID. For mobile sessions, requires both session_id and recording_id. For web sessions, requires both session_id and tab_id.
|
|
24665
|
+
* @description Retrieves the recording data for a specific session ID and recording ID. For mobile sessions, requires both session_id and recording_id. For web sessions, requires both session_id and tab_id. **Required scopes:** No scopes required.
|
|
24415
24666
|
*
|
|
24416
24667
|
* @tags observability
|
|
24417
24668
|
* @name ObservabilitySessionsDataGetPost
|
|
@@ -24421,7 +24672,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
24421
24672
|
*/
|
|
24422
24673
|
observabilitySessionsDataGetPost: (data: ObservabilitySessionsDataGetRequest, params?: RequestParams) => Promise<AxiosResponse<ObservabilitySessionsDataGetResponse, any, {}>>;
|
|
24423
24674
|
/**
|
|
24424
|
-
* @description Retrieves detailed console and network data for debugging.
|
|
24675
|
+
* @description Retrieves detailed console and network data for debugging. **Required scopes:** No scopes required.
|
|
24425
24676
|
*
|
|
24426
24677
|
* @tags observability
|
|
24427
24678
|
* @name ObservabilitySessionsDeveloperInfoGet
|
|
@@ -24457,7 +24708,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
24457
24708
|
status_code_classes?: StatusCodeClass[];
|
|
24458
24709
|
}, params?: RequestParams) => Promise<AxiosResponse<ObservabilitySessionsDeveloperInfoGetResponse, any, {}>>;
|
|
24459
24710
|
/**
|
|
24460
|
-
* @description Retrieves detailed console and network data for debugging.
|
|
24711
|
+
* @description Retrieves detailed console and network data for debugging. **Required scopes:** No scopes required.
|
|
24461
24712
|
*
|
|
24462
24713
|
* @tags observability
|
|
24463
24714
|
* @name ObservabilitySessionsDeveloperInfoGetPost
|
|
@@ -24467,7 +24718,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
24467
24718
|
*/
|
|
24468
24719
|
observabilitySessionsDeveloperInfoGetPost: (data: ObservabilitySessionsDeveloperInfoGetRequest, params?: RequestParams) => Promise<AxiosResponse<ObservabilitySessionsDeveloperInfoGetResponse, any, {}>>;
|
|
24469
24720
|
/**
|
|
24470
|
-
* @description Gets a specific session metadata by ID.
|
|
24721
|
+
* @description Gets a specific session metadata by ID. **Required scopes:** No scopes required.
|
|
24471
24722
|
*
|
|
24472
24723
|
* @tags observability
|
|
24473
24724
|
* @name ObservabilitySessionsGet
|
|
@@ -24492,7 +24743,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
24492
24743
|
version_key: string;
|
|
24493
24744
|
}, params?: RequestParams) => Promise<AxiosResponse<ObservabilitySessionsGetResponse, any, {}>>;
|
|
24494
24745
|
/**
|
|
24495
|
-
* @description Gets a specific session metadata by ID.
|
|
24746
|
+
* @description Gets a specific session metadata by ID. **Required scopes:** No scopes required.
|
|
24496
24747
|
*
|
|
24497
24748
|
* @tags observability
|
|
24498
24749
|
* @name ObservabilitySessionsGetPost
|
|
@@ -24502,7 +24753,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
24502
24753
|
*/
|
|
24503
24754
|
observabilitySessionsGetPost: (data: ObservabilitySessionsGetRequest, params?: RequestParams) => Promise<AxiosResponse<ObservabilitySessionsGetResponse, any, {}>>;
|
|
24504
24755
|
/**
|
|
24505
|
-
* @description Lists sessions based on filter criteria.
|
|
24756
|
+
* @description Lists sessions based on filter criteria. **Required scopes:** No scopes required.
|
|
24506
24757
|
*
|
|
24507
24758
|
* @tags observability
|
|
24508
24759
|
* @name ObservabilitySessionsList
|
|
@@ -24539,7 +24790,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
24539
24790
|
sort_by?: string[];
|
|
24540
24791
|
}, params?: RequestParams) => Promise<AxiosResponse<ObservabilitySessionsListResponse, any, {}>>;
|
|
24541
24792
|
/**
|
|
24542
|
-
* @description Lists sessions based on filter criteria.
|
|
24793
|
+
* @description Lists sessions based on filter criteria. **Required scopes:** No scopes required.
|
|
24543
24794
|
*
|
|
24544
24795
|
* @tags observability
|
|
24545
24796
|
* @name ObservabilitySessionsListPost
|
|
@@ -24549,7 +24800,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
24549
24800
|
*/
|
|
24550
24801
|
observabilitySessionsListPost: (data: ObservabilitySessionsListRequest, params?: RequestParams) => Promise<AxiosResponse<ObservabilitySessionsListResponse, any, {}>>;
|
|
24551
24802
|
/**
|
|
24552
|
-
* @description Creates an organization schedule fragment.
|
|
24803
|
+
* @description Creates an organization schedule fragment. **Required scopes:** - `org_schedule_fragment:write` OR `org_schedule_fragment:all`
|
|
24553
24804
|
*
|
|
24554
24805
|
* @tags schedules
|
|
24555
24806
|
* @name OrgScheduleFragmentsCreate
|
|
@@ -24559,7 +24810,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
24559
24810
|
*/
|
|
24560
24811
|
orgScheduleFragmentsCreate: (data: OrgScheduleFragmentsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<OrgScheduleFragmentsCreateResponse, any, {}>>;
|
|
24561
24812
|
/**
|
|
24562
|
-
* @description Gets an organization schedule fragment.
|
|
24813
|
+
* @description Gets an organization schedule fragment. **Required scopes:** - `org_schedule_fragment:read` OR `org_schedule_fragment:write` OR `org_schedule_fragment:all`
|
|
24563
24814
|
*
|
|
24564
24815
|
* @tags schedules
|
|
24565
24816
|
* @name OrgScheduleFragmentsGet
|
|
@@ -24575,7 +24826,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
24575
24826
|
id: string;
|
|
24576
24827
|
}, params?: RequestParams) => Promise<AxiosResponse<OrgScheduleFragmentsGetResponse, any, {}>>;
|
|
24577
24828
|
/**
|
|
24578
|
-
* @description Gets an organization schedule fragment.
|
|
24829
|
+
* @description Gets an organization schedule fragment. **Required scopes:** - `org_schedule_fragment:read` OR `org_schedule_fragment:write` OR `org_schedule_fragment:all`
|
|
24579
24830
|
*
|
|
24580
24831
|
* @tags schedules
|
|
24581
24832
|
* @name OrgScheduleFragmentsGetPost
|
|
@@ -24585,7 +24836,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
24585
24836
|
*/
|
|
24586
24837
|
orgScheduleFragmentsGetPost: (data: OrgScheduleFragmentsGetRequest, params?: RequestParams) => Promise<AxiosResponse<OrgScheduleFragmentsGetResponse, any, {}>>;
|
|
24587
24838
|
/**
|
|
24588
|
-
* @description Changes stage of an organization schedule fragment.
|
|
24839
|
+
* @description Changes stage of an organization schedule fragment. **Required scopes:** - `org_schedule_fragment:write` OR `org_schedule_fragment:all`
|
|
24589
24840
|
*
|
|
24590
24841
|
* @tags schedules
|
|
24591
24842
|
* @name OrgScheduleFragmentsTransition
|
|
@@ -24595,7 +24846,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
24595
24846
|
*/
|
|
24596
24847
|
orgScheduleFragmentsTransition: (data: OrgScheduleFragmentsTransitionRequest, params?: RequestParams) => Promise<AxiosResponse<OrgScheduleFragmentsTransitionResponse, any, {}>>;
|
|
24597
24848
|
/**
|
|
24598
|
-
* @description Creates an organization schedule with a default weekly organization schedule and a list of organization schedule fragments.
|
|
24849
|
+
* @description Creates an organization schedule with a default weekly organization schedule and a list of organization schedule fragments. **Required scopes:** - `org_schedule:write` OR `org_schedule:all`
|
|
24599
24850
|
*
|
|
24600
24851
|
* @tags schedules
|
|
24601
24852
|
* @name OrgSchedulesCreate
|
|
@@ -24605,7 +24856,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
24605
24856
|
*/
|
|
24606
24857
|
orgSchedulesCreate: (data: OrgSchedulesCreateRequest, params?: RequestParams) => Promise<AxiosResponse<OrgSchedulesCreateResponse, any, {}>>;
|
|
24607
24858
|
/**
|
|
24608
|
-
* @description Evaluates an organization's schedule at specified instants.
|
|
24859
|
+
* @description Evaluates an organization's schedule at specified instants. **Required scopes:** - `org_schedule:read` OR `org_schedule:write` OR `org_schedule:all`
|
|
24609
24860
|
*
|
|
24610
24861
|
* @tags schedules
|
|
24611
24862
|
* @name OrgSchedulesEvaluate
|
|
@@ -24627,7 +24878,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
24627
24878
|
instants: string[];
|
|
24628
24879
|
}, params?: RequestParams) => Promise<AxiosResponse<OrgSchedulesEvaluateResponse, any, {}>>;
|
|
24629
24880
|
/**
|
|
24630
|
-
* @description Evaluates an organization's schedule at specified instants.
|
|
24881
|
+
* @description Evaluates an organization's schedule at specified instants. **Required scopes:** - `org_schedule:read` OR `org_schedule:write` OR `org_schedule:all`
|
|
24631
24882
|
*
|
|
24632
24883
|
* @tags schedules
|
|
24633
24884
|
* @name OrgSchedulesEvaluatePost
|
|
@@ -24637,7 +24888,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
24637
24888
|
*/
|
|
24638
24889
|
orgSchedulesEvaluatePost: (data: OrgSchedulesEvaluateRequest, params?: RequestParams) => Promise<AxiosResponse<OrgSchedulesEvaluateResponse, any, {}>>;
|
|
24639
24890
|
/**
|
|
24640
|
-
* @description Gets an organization schedule.
|
|
24891
|
+
* @description Gets an organization schedule. **Required scopes:** - `org_schedule:read` OR `org_schedule:write` OR `org_schedule:all`
|
|
24641
24892
|
*
|
|
24642
24893
|
* @tags schedules
|
|
24643
24894
|
* @name OrgSchedulesGet
|
|
@@ -24659,7 +24910,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
24659
24910
|
version_number?: number;
|
|
24660
24911
|
}, params?: RequestParams) => Promise<AxiosResponse<OrgSchedulesGetResponse, any, {}>>;
|
|
24661
24912
|
/**
|
|
24662
|
-
* @description Gets an organization schedule.
|
|
24913
|
+
* @description Gets an organization schedule. **Required scopes:** - `org_schedule:read` OR `org_schedule:write` OR `org_schedule:all`
|
|
24663
24914
|
*
|
|
24664
24915
|
* @tags schedules
|
|
24665
24916
|
* @name OrgSchedulesGetPost
|
|
@@ -24669,7 +24920,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
24669
24920
|
*/
|
|
24670
24921
|
orgSchedulesGetPost: (data: OrgSchedulesGetRequest, params?: RequestParams) => Promise<AxiosResponse<OrgSchedulesGetResponse, any, {}>>;
|
|
24671
24922
|
/**
|
|
24672
|
-
* @description Gets list of organization schedules.
|
|
24923
|
+
* @description Gets list of organization schedules. **Required scopes:** - `org_schedule:read` OR `org_schedule:write` OR `org_schedule:all`
|
|
24673
24924
|
*
|
|
24674
24925
|
* @tags schedules
|
|
24675
24926
|
* @name OrgSchedulesList
|
|
@@ -24701,7 +24952,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
24701
24952
|
status?: OrgScheduleStatus[];
|
|
24702
24953
|
}, params?: RequestParams) => Promise<AxiosResponse<OrgSchedulesListResponse, any, {}>>;
|
|
24703
24954
|
/**
|
|
24704
|
-
* @description Gets list of organization schedules.
|
|
24955
|
+
* @description Gets list of organization schedules. **Required scopes:** - `org_schedule:read` OR `org_schedule:write` OR `org_schedule:all`
|
|
24705
24956
|
*
|
|
24706
24957
|
* @tags schedules
|
|
24707
24958
|
* @name OrgSchedulesListPost
|
|
@@ -24711,7 +24962,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
24711
24962
|
*/
|
|
24712
24963
|
orgSchedulesListPost: (data: OrgSchedulesListRequest, params?: RequestParams) => Promise<AxiosResponse<OrgSchedulesListResponse, any, {}>>;
|
|
24713
24964
|
/**
|
|
24714
|
-
* @description Sets next organization schedule fragment which must begin the day the last existing fragment ends.
|
|
24965
|
+
* @description Sets next organization schedule fragment which must begin the day the last existing fragment ends. **Required scopes:** - `org_schedule:write` OR `org_schedule:all`
|
|
24715
24966
|
*
|
|
24716
24967
|
* @tags schedules
|
|
24717
24968
|
* @name OrgSchedulesSetFuture
|
|
@@ -24721,7 +24972,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
24721
24972
|
*/
|
|
24722
24973
|
orgSchedulesSetFuture: (data: OrgSchedulesSetFutureRequest, params?: RequestParams) => Promise<AxiosResponse<OrgSchedulesSetFutureResponse, any, {}>>;
|
|
24723
24974
|
/**
|
|
24724
|
-
* @description Publishes or archives an organization schedule.
|
|
24975
|
+
* @description Publishes or archives an organization schedule. **Required scopes:** - `org_schedule:write` OR `org_schedule:all`
|
|
24725
24976
|
*
|
|
24726
24977
|
* @tags schedules
|
|
24727
24978
|
* @name OrgSchedulesTransition
|
|
@@ -24731,7 +24982,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
24731
24982
|
*/
|
|
24732
24983
|
orgSchedulesTransition: (data: OrgSchedulesTransitionRequest, params?: RequestParams) => Promise<AxiosResponse<OrgSchedulesTransitionResponse, any, {}>>;
|
|
24733
24984
|
/**
|
|
24734
|
-
* @description Updates an organization schedule.
|
|
24985
|
+
* @description Updates an organization schedule. **Required scopes:** - `org_schedule:write` OR `org_schedule:all`
|
|
24735
24986
|
*
|
|
24736
24987
|
* @tags schedules
|
|
24737
24988
|
* @name OrgSchedulesUpdate
|
|
@@ -24741,7 +24992,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
24741
24992
|
*/
|
|
24742
24993
|
orgSchedulesUpdate: (data: OrgSchedulesUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<OrgSchedulesUpdateResponse, any, {}>>;
|
|
24743
24994
|
/**
|
|
24744
|
-
* @description Creates new [part](https://devrev.ai/docs/product/parts).
|
|
24995
|
+
* @description Creates new [part](https://devrev.ai/docs/product/parts). **Required scopes:** Depends on the object type in the `type` field: | type | required scope | |---|---| | capability | `capability:write` OR `capability:all` | | enhancement | `enhancement:write` OR `enhancement:all` | | feature | `feature:write` OR `feature:all` | | product | `product:write` OR `product:all` |
|
|
24745
24996
|
*
|
|
24746
24997
|
* @tags parts
|
|
24747
24998
|
* @name PartsCreate
|
|
@@ -24751,7 +25002,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
24751
25002
|
*/
|
|
24752
25003
|
partsCreate: (data: PartsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<PartsCreateResponse, any, {}>>;
|
|
24753
25004
|
/**
|
|
24754
|
-
* @description Deletes a [part](https://devrev.ai/docs/product/parts).
|
|
25005
|
+
* @description Deletes a [part](https://devrev.ai/docs/product/parts). **Required scopes:** Depends on the object type in the `id` field: | type | required scope | |---|---| | capability | `capability:all` | | enhancement | `enhancement:all` | | feature | `feature:all` | | product | `product:all` |
|
|
24755
25006
|
*
|
|
24756
25007
|
* @tags parts
|
|
24757
25008
|
* @name PartsDelete
|
|
@@ -24761,7 +25012,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
24761
25012
|
*/
|
|
24762
25013
|
partsDelete: (data: PartsDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
|
|
24763
25014
|
/**
|
|
24764
|
-
* @description Gets a [part's](https://devrev.ai/docs/product/parts) information.
|
|
25015
|
+
* @description Gets a [part's](https://devrev.ai/docs/product/parts) information. **Required scopes:** Depends on the object type in the `id` field: | type | required scope | |---|---| | capability | `capability:read` OR `capability:write` OR `capability:all` | | enhancement | `enhancement:read` OR `enhancement:write` OR `enhancement:all` | | feature | `feature:read` OR `feature:write` OR `feature:all` | | product | `product:read` OR `product:write` OR `product:all` |
|
|
24765
25016
|
*
|
|
24766
25017
|
* @tags parts
|
|
24767
25018
|
* @name PartsGet
|
|
@@ -24778,7 +25029,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
24778
25029
|
id: string;
|
|
24779
25030
|
}, params?: RequestParams) => Promise<AxiosResponse<PartsGetResponse, any, {}>>;
|
|
24780
25031
|
/**
|
|
24781
|
-
* @description Gets a [part's](https://devrev.ai/docs/product/parts) information.
|
|
25032
|
+
* @description Gets a [part's](https://devrev.ai/docs/product/parts) information. **Required scopes:** Depends on the object type in the `id` field: | type | required scope | |---|---| | capability | `capability:read` OR `capability:write` OR `capability:all` | | enhancement | `enhancement:read` OR `enhancement:write` OR `enhancement:all` | | feature | `feature:read` OR `feature:write` OR `feature:all` | | product | `product:read` OR `product:write` OR `product:all` |
|
|
24782
25033
|
*
|
|
24783
25034
|
* @tags parts
|
|
24784
25035
|
* @name PartsGetPost
|
|
@@ -24788,7 +25039,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
24788
25039
|
*/
|
|
24789
25040
|
partsGetPost: (data: PartsGetRequest, params?: RequestParams) => Promise<AxiosResponse<PartsGetResponse, any, {}>>;
|
|
24790
25041
|
/**
|
|
24791
|
-
* @description Lists a collection of [parts](https://devrev.ai/docs/product/parts).
|
|
25042
|
+
* @description Lists a collection of [parts](https://devrev.ai/docs/product/parts). **Required scopes:** Depends on the object type in the `id` field: | type | required scope | |---|---| | capability | `capability:read` OR `capability:write` OR `capability:all` | | enhancement | `enhancement:read` OR `enhancement:write` OR `enhancement:all` | | feature | `feature:read` OR `feature:write` OR `feature:all` | | product | `product:read` OR `product:write` OR `product:all` |
|
|
24792
25043
|
*
|
|
24793
25044
|
* @tags parts
|
|
24794
25045
|
* @name PartsList
|
|
@@ -24969,7 +25220,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
24969
25220
|
type?: PartType[];
|
|
24970
25221
|
}, params?: RequestParams) => Promise<AxiosResponse<PartsListResponse, any, {}>>;
|
|
24971
25222
|
/**
|
|
24972
|
-
* @description Lists a collection of [parts](https://devrev.ai/docs/product/parts).
|
|
25223
|
+
* @description Lists a collection of [parts](https://devrev.ai/docs/product/parts). **Required scopes:** Depends on the object type in the `id` field: | type | required scope | |---|---| | capability | `capability:read` OR `capability:write` OR `capability:all` | | enhancement | `enhancement:read` OR `enhancement:write` OR `enhancement:all` | | feature | `feature:read` OR `feature:write` OR `feature:all` | | product | `product:read` OR `product:write` OR `product:all` |
|
|
24973
25224
|
*
|
|
24974
25225
|
* @tags parts
|
|
24975
25226
|
* @name PartsListPost
|
|
@@ -24979,7 +25230,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
24979
25230
|
*/
|
|
24980
25231
|
partsListPost: (data: PartsListRequest, params?: RequestParams) => Promise<AxiosResponse<PartsListResponse, any, {}>>;
|
|
24981
25232
|
/**
|
|
24982
|
-
* @description Updates a [part's](https://devrev.ai/docs/product/parts) information.
|
|
25233
|
+
* @description Updates a [part's](https://devrev.ai/docs/product/parts) information. **Required scopes:** Depends on the object type in the `type` field: | type | required scope | |---|---| | capability | `capability:write` OR `capability:all` | | enhancement | `enhancement:write` OR `enhancement:all` | | feature | `feature:write` OR `feature:all` | | product | `product:write` OR `product:all` |
|
|
24983
25234
|
*
|
|
24984
25235
|
* @tags parts
|
|
24985
25236
|
* @name PartsUpdate
|
|
@@ -25013,7 +25264,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
25013
25264
|
*/
|
|
25014
25265
|
pingPost: (data: PingRequest, params?: RequestParams) => Promise<AxiosResponse<PingResponse, any, {}>>;
|
|
25015
25266
|
/**
|
|
25016
|
-
* @description Lists the reactors for an object.
|
|
25267
|
+
* @description Lists the reactors for an object. **Required scopes:** Requires the read or write scope of the parent object's type (e.g. issue:write when posting to an issue's timeline).
|
|
25017
25268
|
*
|
|
25018
25269
|
* @tags timeline-entries, works
|
|
25019
25270
|
* @name ReactionsList
|
|
@@ -25048,7 +25299,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
25048
25299
|
limit?: number;
|
|
25049
25300
|
}, params?: RequestParams) => Promise<AxiosResponse<ReactionsListResponse, any, {}>>;
|
|
25050
25301
|
/**
|
|
25051
|
-
* @description Lists the reactors for an object.
|
|
25302
|
+
* @description Lists the reactors for an object. **Required scopes:** Requires the read or write scope of the parent object's type (e.g. issue:write when posting to an issue's timeline).
|
|
25052
25303
|
*
|
|
25053
25304
|
* @tags timeline-entries, works
|
|
25054
25305
|
* @name ReactionsListPost
|
|
@@ -25058,7 +25309,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
25058
25309
|
*/
|
|
25059
25310
|
reactionsListPost: (data: ReactionsListRequest, params?: RequestParams) => Promise<AxiosResponse<ReactionsListResponse, any, {}>>;
|
|
25060
25311
|
/**
|
|
25061
|
-
* @description Updates a reaction for an object.
|
|
25312
|
+
* @description Updates a reaction for an object. **Required scopes:** Requires the read or write scope of the parent object's type (e.g. issue:write when posting to an issue's timeline).
|
|
25062
25313
|
*
|
|
25063
25314
|
* @tags timeline-entries, works
|
|
25064
25315
|
* @name ReactionsUpdate
|
|
@@ -25068,7 +25319,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
25068
25319
|
*/
|
|
25069
25320
|
reactionsUpdate: (data: ReactionsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
|
|
25070
25321
|
/**
|
|
25071
|
-
* @description Creates a Rev organization in the authenticated user's Dev organization. **Required scopes:** - `rev_org:write`
|
|
25322
|
+
* @description Creates a Rev organization in the authenticated user's Dev organization. **Required scopes:** - `rev_org:write` OR `rev_org:all`
|
|
25072
25323
|
*
|
|
25073
25324
|
* @tags rev-orgs
|
|
25074
25325
|
* @name RevOrgsCreate
|
|
@@ -25088,7 +25339,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
25088
25339
|
*/
|
|
25089
25340
|
revOrgsDelete: (data: RevOrgsDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
|
|
25090
25341
|
/**
|
|
25091
|
-
* @description Retrieves the Rev organization's information. **Required scopes:** - `rev_org:read`
|
|
25342
|
+
* @description Retrieves the Rev organization's information. **Required scopes:** - `rev_org:read` OR `rev_org:write` OR `rev_org:all`
|
|
25092
25343
|
*
|
|
25093
25344
|
* @tags rev-orgs
|
|
25094
25345
|
* @name RevOrgsGet
|
|
@@ -25112,7 +25363,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
25112
25363
|
id?: string;
|
|
25113
25364
|
}, params?: RequestParams) => Promise<AxiosResponse<RevOrgsGetResponse, any, {}>>;
|
|
25114
25365
|
/**
|
|
25115
|
-
* @description Retrieves the Rev organization's information. **Required scopes:** - `rev_org:read`
|
|
25366
|
+
* @description Retrieves the Rev organization's information. **Required scopes:** - `rev_org:read` OR `rev_org:write` OR `rev_org:all`
|
|
25116
25367
|
*
|
|
25117
25368
|
* @tags rev-orgs
|
|
25118
25369
|
* @name RevOrgsGetPost
|
|
@@ -25122,7 +25373,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
25122
25373
|
*/
|
|
25123
25374
|
revOrgsGetPost: (data: RevOrgsGetRequest, params?: RequestParams) => Promise<AxiosResponse<RevOrgsGetResponse, any, {}>>;
|
|
25124
25375
|
/**
|
|
25125
|
-
* @description Gets the list of Rev organizations' information belonging to the authenticated user's Dev Organization which the user is also authorized to access. **Required scopes:** - `rev_org:read`
|
|
25376
|
+
* @description Gets the list of Rev organizations' information belonging to the authenticated user's Dev Organization which the user is also authorized to access. **Required scopes:** - `rev_org:read` OR `rev_org:write` OR `rev_org:all`
|
|
25126
25377
|
*
|
|
25127
25378
|
* @tags rev-orgs
|
|
25128
25379
|
* @name RevOrgsList
|
|
@@ -25200,7 +25451,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
25200
25451
|
tags?: string[];
|
|
25201
25452
|
}, params?: RequestParams) => Promise<AxiosResponse<RevOrgsListResponse, any, {}>>;
|
|
25202
25453
|
/**
|
|
25203
|
-
* @description Gets the list of Rev organizations' information belonging to the authenticated user's Dev Organization which the user is also authorized to access. **Required scopes:** - `rev_org:read`
|
|
25454
|
+
* @description Gets the list of Rev organizations' information belonging to the authenticated user's Dev Organization which the user is also authorized to access. **Required scopes:** - `rev_org:read` OR `rev_org:write` OR `rev_org:all`
|
|
25204
25455
|
*
|
|
25205
25456
|
* @tags rev-orgs
|
|
25206
25457
|
* @name RevOrgsListPost
|
|
@@ -25210,7 +25461,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
25210
25461
|
*/
|
|
25211
25462
|
revOrgsListPost: (data: RevOrgsListRequest, params?: RequestParams) => Promise<AxiosResponse<RevOrgsListResponse, any, {}>>;
|
|
25212
25463
|
/**
|
|
25213
|
-
* @description Updates the Rev organization's information. **Required scopes:** - `rev_org:write`
|
|
25464
|
+
* @description Updates the Rev organization's information. **Required scopes:** - `rev_org:write` OR `rev_org:all`
|
|
25214
25465
|
*
|
|
25215
25466
|
* @tags rev-orgs
|
|
25216
25467
|
* @name RevOrgsUpdate
|
|
@@ -25220,7 +25471,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
25220
25471
|
*/
|
|
25221
25472
|
revOrgsUpdate: (data: RevOrgsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<RevOrgsUpdateResponse, any, {}>>;
|
|
25222
25473
|
/**
|
|
25223
|
-
* @description Creates a Rev user for a Rev organization. Rev user can be a customer or a lead of an organization. **Required scopes:** - `rev_user:write`
|
|
25474
|
+
* @description Creates a Rev user for a Rev organization. Rev user can be a customer or a lead of an organization. **Required scopes:** - `rev_user:write` OR `rev_user:all`
|
|
25224
25475
|
*
|
|
25225
25476
|
* @tags rev-users
|
|
25226
25477
|
* @name RevUsersCreate
|
|
@@ -25240,7 +25491,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
25240
25491
|
*/
|
|
25241
25492
|
revUsersDelete: (data: RevUsersDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
|
|
25242
25493
|
/**
|
|
25243
|
-
* @description Returns the Rev user of a Rev organization by its ID. **Required scopes:** - `rev_user:read`
|
|
25494
|
+
* @description Returns the Rev user of a Rev organization by its ID. **Required scopes:** - `rev_user:read` OR `rev_user:write` OR `rev_user:all`
|
|
25244
25495
|
*
|
|
25245
25496
|
* @tags rev-users
|
|
25246
25497
|
* @name RevUsersGet
|
|
@@ -25256,7 +25507,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
25256
25507
|
id: string;
|
|
25257
25508
|
}, params?: RequestParams) => Promise<AxiosResponse<RevUsersGetResponse, any, {}>>;
|
|
25258
25509
|
/**
|
|
25259
|
-
* @description Returns the Rev user of a Rev organization by its ID. **Required scopes:** - `rev_user:read`
|
|
25510
|
+
* @description Returns the Rev user of a Rev organization by its ID. **Required scopes:** - `rev_user:read` OR `rev_user:write` OR `rev_user:all`
|
|
25260
25511
|
*
|
|
25261
25512
|
* @tags rev-users
|
|
25262
25513
|
* @name RevUsersGetPost
|
|
@@ -25266,7 +25517,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
25266
25517
|
*/
|
|
25267
25518
|
revUsersGetPost: (data: RevUsersGetRequest, params?: RequestParams) => Promise<AxiosResponse<RevUsersGetResponse, any, {}>>;
|
|
25268
25519
|
/**
|
|
25269
|
-
* @description Returns a list of all Rev Users belonging to the authenticated user's Dev organization. **Required scopes:** - `rev_user:read`
|
|
25520
|
+
* @description Returns a list of all Rev Users belonging to the authenticated user's Dev organization. **Required scopes:** - `rev_user:read` OR `rev_user:write` OR `rev_user:all`
|
|
25270
25521
|
*
|
|
25271
25522
|
* @tags rev-users
|
|
25272
25523
|
* @name RevUsersList
|
|
@@ -25347,7 +25598,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
25347
25598
|
tags?: string[];
|
|
25348
25599
|
}, params?: RequestParams) => Promise<AxiosResponse<RevUsersListResponse, any, {}>>;
|
|
25349
25600
|
/**
|
|
25350
|
-
* @description Returns a list of all Rev Users belonging to the authenticated user's Dev organization. **Required scopes:** - `rev_user:read`
|
|
25601
|
+
* @description Returns a list of all Rev Users belonging to the authenticated user's Dev organization. **Required scopes:** - `rev_user:read` OR `rev_user:write` OR `rev_user:all`
|
|
25351
25602
|
*
|
|
25352
25603
|
* @tags rev-users
|
|
25353
25604
|
* @name RevUsersListPost
|
|
@@ -25367,7 +25618,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
25367
25618
|
*/
|
|
25368
25619
|
revUsersMerge: (data: RevUsersMergeRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
|
|
25369
25620
|
/**
|
|
25370
|
-
* @description Scans through all Rev users. **Required scopes:** - `rev_user:read`
|
|
25621
|
+
* @description Scans through all Rev users. **Required scopes:** - `rev_user:read` OR `rev_user:write` OR `rev_user:all`
|
|
25371
25622
|
*
|
|
25372
25623
|
* @tags rev-users
|
|
25373
25624
|
* @name RevUsersScan
|
|
@@ -25436,7 +25687,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
25436
25687
|
tags?: string[];
|
|
25437
25688
|
}, params?: RequestParams) => Promise<AxiosResponse<RevUsersScanResponse, any, {}>>;
|
|
25438
25689
|
/**
|
|
25439
|
-
* @description Scans through all Rev users. **Required scopes:** - `rev_user:read`
|
|
25690
|
+
* @description Scans through all Rev users. **Required scopes:** - `rev_user:read` OR `rev_user:write` OR `rev_user:all`
|
|
25440
25691
|
*
|
|
25441
25692
|
* @tags rev-users
|
|
25442
25693
|
* @name RevUsersScanPost
|
|
@@ -25446,7 +25697,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
25446
25697
|
*/
|
|
25447
25698
|
revUsersScanPost: (data: RevUsersScanRequest, params?: RequestParams) => Promise<AxiosResponse<RevUsersScanResponse, any, {}>>;
|
|
25448
25699
|
/**
|
|
25449
|
-
* @description Updates a Rev user. **Required scopes:** - `rev_user:write`
|
|
25700
|
+
* @description Updates a Rev user. **Required scopes:** - `rev_user:write` OR `rev_user:all`
|
|
25450
25701
|
*
|
|
25451
25702
|
* @tags rev-users
|
|
25452
25703
|
* @name RevUsersUpdate
|
|
@@ -25456,7 +25707,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
25456
25707
|
*/
|
|
25457
25708
|
revUsersUpdate: (data: RevUsersUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<RevUsersUpdateResponse, any, {}>>;
|
|
25458
25709
|
/**
|
|
25459
|
-
* @description Gets the aggregated schema.
|
|
25710
|
+
* @description Gets the aggregated schema. **Required scopes:** No scopes required.
|
|
25460
25711
|
*
|
|
25461
25712
|
* @tags customization
|
|
25462
25713
|
* @name AggregatedSchemaGet
|
|
@@ -25489,7 +25740,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
25489
25740
|
stock_schema_fragment?: string;
|
|
25490
25741
|
}, params?: RequestParams) => Promise<AxiosResponse<AggregatedSchemaGetResponse, any, {}>>;
|
|
25491
25742
|
/**
|
|
25492
|
-
* @description Gets the aggregated schema.
|
|
25743
|
+
* @description Gets the aggregated schema. **Required scopes:** No scopes required.
|
|
25493
25744
|
*
|
|
25494
25745
|
* @tags customization
|
|
25495
25746
|
* @name AggregatedSchemaGetPost
|
|
@@ -25499,7 +25750,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
25499
25750
|
*/
|
|
25500
25751
|
aggregatedSchemaGetPost: (data: AggregatedSchemaGetRequest, params?: RequestParams) => Promise<AxiosResponse<AggregatedSchemaGetResponse, any, {}>>;
|
|
25501
25752
|
/**
|
|
25502
|
-
* @description Gets a custom schema fragment.
|
|
25753
|
+
* @description Gets a custom schema fragment. **Required scopes:** No scopes required.
|
|
25503
25754
|
*
|
|
25504
25755
|
* @tags customization
|
|
25505
25756
|
* @name CustomSchemaFragmentsGet
|
|
@@ -25517,7 +25768,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
25517
25768
|
include_sync_metadata?: boolean;
|
|
25518
25769
|
}, params?: RequestParams) => Promise<AxiosResponse<CustomSchemaFragmentsGetResponse, any, {}>>;
|
|
25519
25770
|
/**
|
|
25520
|
-
* @description Gets a custom schema fragment.
|
|
25771
|
+
* @description Gets a custom schema fragment. **Required scopes:** No scopes required.
|
|
25521
25772
|
*
|
|
25522
25773
|
* @tags customization
|
|
25523
25774
|
* @name CustomSchemaFragmentsGetPost
|
|
@@ -25527,7 +25778,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
25527
25778
|
*/
|
|
25528
25779
|
customSchemaFragmentsGetPost: (data: CustomSchemaFragmentsGetRequest, params?: RequestParams) => Promise<AxiosResponse<CustomSchemaFragmentsGetResponse, any, {}>>;
|
|
25529
25780
|
/**
|
|
25530
|
-
* @description Lists custom schema fragments.
|
|
25781
|
+
* @description Lists custom schema fragments. **Required scopes:** No scopes required.
|
|
25531
25782
|
*
|
|
25532
25783
|
* @tags customization
|
|
25533
25784
|
* @name CustomSchemaFragmentsList
|
|
@@ -25590,7 +25841,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
25590
25841
|
types?: CustomSchemaFragmentType[];
|
|
25591
25842
|
}, params?: RequestParams) => Promise<AxiosResponse<CustomSchemaFragmentsListResponse, any, {}>>;
|
|
25592
25843
|
/**
|
|
25593
|
-
* @description Lists custom schema fragments.
|
|
25844
|
+
* @description Lists custom schema fragments. **Required scopes:** No scopes required.
|
|
25594
25845
|
*
|
|
25595
25846
|
* @tags customization
|
|
25596
25847
|
* @name CustomSchemaFragmentsListPost
|
|
@@ -25600,7 +25851,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
25600
25851
|
*/
|
|
25601
25852
|
customSchemaFragmentsListPost: (data: CustomSchemaFragmentsListRequest, params?: RequestParams) => Promise<AxiosResponse<CustomSchemaFragmentsListResponse, any, {}>>;
|
|
25602
25853
|
/**
|
|
25603
|
-
* @description Creates or updates a custom schema fragment.
|
|
25854
|
+
* @description Creates or updates a custom schema fragment. **Required scopes:** - `custom_type_fragment:write`
|
|
25604
25855
|
*
|
|
25605
25856
|
* @tags customization
|
|
25606
25857
|
* @name CustomSchemaFragmentsSet
|
|
@@ -25610,7 +25861,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
25610
25861
|
*/
|
|
25611
25862
|
customSchemaFragmentsSet: (data: CustomSchemaFragmentsSetRequest, params?: RequestParams) => Promise<AxiosResponse<CustomSchemaFragmentsSetResponse, any, {}>>;
|
|
25612
25863
|
/**
|
|
25613
|
-
* @description Gets a stock schema fragment.
|
|
25864
|
+
* @description Gets a stock schema fragment. **Required scopes:** No scopes required.
|
|
25614
25865
|
*
|
|
25615
25866
|
* @tags customization
|
|
25616
25867
|
* @name StockSchemaFragmentsGet
|
|
@@ -25631,7 +25882,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
25631
25882
|
leaf_type?: string;
|
|
25632
25883
|
}, params?: RequestParams) => Promise<AxiosResponse<StockSchemaFragmentsGetResponse, any, {}>>;
|
|
25633
25884
|
/**
|
|
25634
|
-
* @description Gets a stock schema fragment.
|
|
25885
|
+
* @description Gets a stock schema fragment. **Required scopes:** No scopes required.
|
|
25635
25886
|
*
|
|
25636
25887
|
* @tags customization
|
|
25637
25888
|
* @name StockSchemaFragmentsGetPost
|
|
@@ -25641,7 +25892,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
25641
25892
|
*/
|
|
25642
25893
|
stockSchemaFragmentsGetPost: (data: StockSchemaFragmentsGetRequest, params?: RequestParams) => Promise<AxiosResponse<StockSchemaFragmentsGetResponse, any, {}>>;
|
|
25643
25894
|
/**
|
|
25644
|
-
* @description Lists stock schema fragments.
|
|
25895
|
+
* @description Lists stock schema fragments. **Required scopes:** No scopes required.
|
|
25645
25896
|
*
|
|
25646
25897
|
* @tags customization
|
|
25647
25898
|
* @name StockSchemaFragmentsList
|
|
@@ -25682,7 +25933,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
25682
25933
|
sort_by?: string[];
|
|
25683
25934
|
}, params?: RequestParams) => Promise<AxiosResponse<StockSchemaFragmentsListResponse, any, {}>>;
|
|
25684
25935
|
/**
|
|
25685
|
-
* @description Lists stock schema fragments.
|
|
25936
|
+
* @description Lists stock schema fragments. **Required scopes:** No scopes required.
|
|
25686
25937
|
*
|
|
25687
25938
|
* @tags customization
|
|
25688
25939
|
* @name StockSchemaFragmentsListPost
|
|
@@ -25692,7 +25943,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
25692
25943
|
*/
|
|
25693
25944
|
stockSchemaFragmentsListPost: (data: StockSchemaFragmentsListRequest, params?: RequestParams) => Promise<AxiosResponse<StockSchemaFragmentsListResponse, any, {}>>;
|
|
25694
25945
|
/**
|
|
25695
|
-
* @description Gets the new fragment IDs and fields resulting from changing a subtype.
|
|
25946
|
+
* @description Gets the new fragment IDs and fields resulting from changing a subtype. **Required scopes:** - `custom_type_fragment:write`
|
|
25696
25947
|
*
|
|
25697
25948
|
* @tags customization
|
|
25698
25949
|
* @name SchemasSubtypePrepareUpdateGet
|
|
@@ -25702,7 +25953,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
25702
25953
|
*/
|
|
25703
25954
|
schemasSubtypePrepareUpdateGet: (data: SchemasSubtypePrepareUpdateGetRequest, params?: RequestParams) => Promise<AxiosResponse<SchemasSubtypePrepareUpdateGetResponse, any, {}>>;
|
|
25704
25955
|
/**
|
|
25705
|
-
* @description Creates a service account.
|
|
25956
|
+
* @description Creates a service account. **Required scopes:** Not accessible via service account tokens. Requires user authentication.
|
|
25706
25957
|
*
|
|
25707
25958
|
* @tags service-accounts
|
|
25708
25959
|
* @name ServiceAccountsCreate
|
|
@@ -25712,7 +25963,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
25712
25963
|
*/
|
|
25713
25964
|
serviceAccountsCreate: (data: ServiceAccountsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<ServiceAccountsCreateResponse, any, {}>>;
|
|
25714
25965
|
/**
|
|
25715
|
-
* @description Gets a service account.
|
|
25966
|
+
* @description Gets a service account. **Required scopes:** - `svcacc:read`
|
|
25716
25967
|
*
|
|
25717
25968
|
* @tags service-accounts
|
|
25718
25969
|
* @name ServiceAccountsGet
|
|
@@ -25728,7 +25979,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
25728
25979
|
id: string;
|
|
25729
25980
|
}, params?: RequestParams) => Promise<AxiosResponse<ServiceAccountsGetResponse, any, {}>>;
|
|
25730
25981
|
/**
|
|
25731
|
-
* @description Gets a service account.
|
|
25982
|
+
* @description Gets a service account. **Required scopes:** - `svcacc:read`
|
|
25732
25983
|
*
|
|
25733
25984
|
* @tags service-accounts
|
|
25734
25985
|
* @name ServiceAccountsGetPost
|
|
@@ -25738,7 +25989,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
25738
25989
|
*/
|
|
25739
25990
|
serviceAccountsGetPost: (data: ServiceAccountsGetRequest, params?: RequestParams) => Promise<AxiosResponse<ServiceAccountsGetResponse, any, {}>>;
|
|
25740
25991
|
/**
|
|
25741
|
-
* @description Gets an SLA tracker.
|
|
25992
|
+
* @description Gets an SLA tracker. **Required scopes:** No scopes required.
|
|
25742
25993
|
*
|
|
25743
25994
|
* @tags slas
|
|
25744
25995
|
* @name SlaTrackersGet
|
|
@@ -25754,7 +26005,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
25754
26005
|
id: string;
|
|
25755
26006
|
}, params?: RequestParams) => Promise<AxiosResponse<SlaTrackersGetResponse, any, {}>>;
|
|
25756
26007
|
/**
|
|
25757
|
-
* @description Gets an SLA tracker.
|
|
26008
|
+
* @description Gets an SLA tracker. **Required scopes:** No scopes required.
|
|
25758
26009
|
*
|
|
25759
26010
|
* @tags slas
|
|
25760
26011
|
* @name SlaTrackersGetPost
|
|
@@ -25764,7 +26015,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
25764
26015
|
*/
|
|
25765
26016
|
slaTrackersGetPost: (data: SlaTrackersGetRequest, params?: RequestParams) => Promise<AxiosResponse<SlaTrackersGetResponse, any, {}>>;
|
|
25766
26017
|
/**
|
|
25767
|
-
* @description Lists SLA trackers matching a filter.
|
|
26018
|
+
* @description Lists SLA trackers matching a filter. **Required scopes:** No scopes required.
|
|
25768
26019
|
*
|
|
25769
26020
|
* @tags slas
|
|
25770
26021
|
* @name SlaTrackersList
|
|
@@ -25823,7 +26074,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
25823
26074
|
status?: string[];
|
|
25824
26075
|
}, params?: RequestParams) => Promise<AxiosResponse<SlaTrackersListResponse, any, {}>>;
|
|
25825
26076
|
/**
|
|
25826
|
-
* @description Lists SLA trackers matching a filter.
|
|
26077
|
+
* @description Lists SLA trackers matching a filter. **Required scopes:** No scopes required.
|
|
25827
26078
|
*
|
|
25828
26079
|
* @tags slas
|
|
25829
26080
|
* @name SlaTrackersListPost
|
|
@@ -25833,7 +26084,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
25833
26084
|
*/
|
|
25834
26085
|
slaTrackersListPost: (data: SlaTrackersListRequest, params?: RequestParams) => Promise<AxiosResponse<SlaTrackersListResponse, any, {}>>;
|
|
25835
26086
|
/**
|
|
25836
|
-
* @description
|
|
26087
|
+
* @description Assigns the SLA to a set of Rev organizations. **Required scopes:** - `sla:write`
|
|
25837
26088
|
*
|
|
25838
26089
|
* @tags slas
|
|
25839
26090
|
* @name SlasAssign
|
|
@@ -25843,7 +26094,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
25843
26094
|
*/
|
|
25844
26095
|
slasAssign: (data: SlasAssignRequest, params?: RequestParams) => Promise<AxiosResponse<SlasAssignResponse, any, {}>>;
|
|
25845
26096
|
/**
|
|
25846
|
-
* @description Creates an SLA in draft status.
|
|
26097
|
+
* @description Creates an SLA in draft status. **Required scopes:** - `sla:write`
|
|
25847
26098
|
*
|
|
25848
26099
|
* @tags slas
|
|
25849
26100
|
* @name SlasCreate
|
|
@@ -25853,7 +26104,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
25853
26104
|
*/
|
|
25854
26105
|
slasCreate: (data: SlasCreateRequest, params?: RequestParams) => Promise<AxiosResponse<SlasCreateResponse, any, {}>>;
|
|
25855
26106
|
/**
|
|
25856
|
-
* @description Gets an SLA.
|
|
26107
|
+
* @description Gets an SLA. **Required scopes:** - `sla:read` OR `sla:write`
|
|
25857
26108
|
*
|
|
25858
26109
|
* @tags slas
|
|
25859
26110
|
* @name SlasGet
|
|
@@ -25869,7 +26120,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
25869
26120
|
id: string;
|
|
25870
26121
|
}, params?: RequestParams) => Promise<AxiosResponse<SlasGetResponse, any, {}>>;
|
|
25871
26122
|
/**
|
|
25872
|
-
* @description Gets an SLA.
|
|
26123
|
+
* @description Gets an SLA. **Required scopes:** - `sla:read` OR `sla:write`
|
|
25873
26124
|
*
|
|
25874
26125
|
* @tags slas
|
|
25875
26126
|
* @name SlasGetPost
|
|
@@ -25879,7 +26130,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
25879
26130
|
*/
|
|
25880
26131
|
slasGetPost: (data: SlasGetRequest, params?: RequestParams) => Promise<AxiosResponse<SlasGetResponse, any, {}>>;
|
|
25881
26132
|
/**
|
|
25882
|
-
* @description Lists SLAs matching a filter.
|
|
26133
|
+
* @description Lists SLAs matching a filter. **Required scopes:** - `sla:read` OR `sla:write`
|
|
25883
26134
|
*
|
|
25884
26135
|
* @tags slas
|
|
25885
26136
|
* @name SlasList
|
|
@@ -25919,7 +26170,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
25919
26170
|
status?: SlaStatus[];
|
|
25920
26171
|
}, params?: RequestParams) => Promise<AxiosResponse<SlasListResponse, any, {}>>;
|
|
25921
26172
|
/**
|
|
25922
|
-
* @description Lists SLAs matching a filter.
|
|
26173
|
+
* @description Lists SLAs matching a filter. **Required scopes:** - `sla:read` OR `sla:write`
|
|
25923
26174
|
*
|
|
25924
26175
|
* @tags slas
|
|
25925
26176
|
* @name SlasListPost
|
|
@@ -25929,7 +26180,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
25929
26180
|
*/
|
|
25930
26181
|
slasListPost: (data: SlasListRequest, params?: RequestParams) => Promise<AxiosResponse<SlasListResponse, any, {}>>;
|
|
25931
26182
|
/**
|
|
25932
|
-
* @description Changes the status of an SLA.
|
|
26183
|
+
* @description Changes the status of an SLA. **Required scopes:** - `sla:write`
|
|
25933
26184
|
*
|
|
25934
26185
|
* @tags slas
|
|
25935
26186
|
* @name SlasTransition
|
|
@@ -25939,7 +26190,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
25939
26190
|
*/
|
|
25940
26191
|
slasTransition: (data: SlasTransitionRequest, params?: RequestParams) => Promise<AxiosResponse<SlasTransitionResponse, any, {}>>;
|
|
25941
26192
|
/**
|
|
25942
|
-
* @description Updates a draft SLA.
|
|
26193
|
+
* @description Updates a draft SLA. **Required scopes:** - `sla:write`
|
|
25943
26194
|
*
|
|
25944
26195
|
* @tags slas
|
|
25945
26196
|
* @name SlasUpdate
|
|
@@ -25949,7 +26200,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
25949
26200
|
*/
|
|
25950
26201
|
slasUpdate: (data: SlasUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<SlasUpdateResponse, any, {}>>;
|
|
25951
26202
|
/**
|
|
25952
|
-
* @description Executes deferred snap-kit actions.
|
|
26203
|
+
* @description Executes deferred snap-kit actions. **Required scopes:** - `snap_widget:write` OR `snap_widget:all`
|
|
25953
26204
|
*
|
|
25954
26205
|
* @tags snap-kit-execution
|
|
25955
26206
|
* @name SnapKitActionExecuteDeferred
|
|
@@ -25959,7 +26210,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
25959
26210
|
*/
|
|
25960
26211
|
snapKitActionExecuteDeferred: (data: SnapKitActionExecuteDeferredRequest, params?: RequestParams) => Promise<AxiosResponse<SnapKitActionExecuteDeferredResponse, any, {}>>;
|
|
25961
26212
|
/**
|
|
25962
|
-
* @description Create a snap widget object.
|
|
26213
|
+
* @description Create a snap widget object. **Required scopes:** - `snap_widget:write` OR `snap_widget:all`
|
|
25963
26214
|
*
|
|
25964
26215
|
* @tags snap-widgets
|
|
25965
26216
|
* @name SnapWidgetsCreate
|
|
@@ -25969,7 +26220,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
25969
26220
|
*/
|
|
25970
26221
|
snapWidgetsCreate: (data: SnapWidgetsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<SnapWidgetsCreateResponse, any, {}>>;
|
|
25971
26222
|
/**
|
|
25972
|
-
* @description Creates a stage diagram.
|
|
26223
|
+
* @description Creates a stage diagram. **Required scopes:** - `stage_diagram:write`
|
|
25973
26224
|
*
|
|
25974
26225
|
* @tags customization
|
|
25975
26226
|
* @name StageDiagramsCreate
|
|
@@ -25979,7 +26230,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
25979
26230
|
*/
|
|
25980
26231
|
stageDiagramsCreate: (data: StageDiagramsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<StageDiagramsCreateResponse, any, {}>>;
|
|
25981
26232
|
/**
|
|
25982
|
-
* @description Gets a stage diagram.
|
|
26233
|
+
* @description Gets a stage diagram. **Required scopes:** No scopes required.
|
|
25983
26234
|
*
|
|
25984
26235
|
* @tags customization
|
|
25985
26236
|
* @name StageDiagramsGet
|
|
@@ -26006,7 +26257,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
26006
26257
|
leaf_type?: string;
|
|
26007
26258
|
}, params?: RequestParams) => Promise<AxiosResponse<StageDiagramsGetResponse, any, {}>>;
|
|
26008
26259
|
/**
|
|
26009
|
-
* @description Gets a stage diagram.
|
|
26260
|
+
* @description Gets a stage diagram. **Required scopes:** No scopes required.
|
|
26010
26261
|
*
|
|
26011
26262
|
* @tags customization
|
|
26012
26263
|
* @name StageDiagramsGetPost
|
|
@@ -26016,7 +26267,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
26016
26267
|
*/
|
|
26017
26268
|
stageDiagramsGetPost: (data: StageDiagramsGetRequest, params?: RequestParams) => Promise<AxiosResponse<StageDiagramsGetResponse, any, {}>>;
|
|
26018
26269
|
/**
|
|
26019
|
-
* @description Lists stage diagrams.
|
|
26270
|
+
* @description Lists stage diagrams. **Required scopes:** No scopes required.
|
|
26020
26271
|
*
|
|
26021
26272
|
* @tags customization
|
|
26022
26273
|
* @name StageDiagramsList
|
|
@@ -26046,7 +26297,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
26046
26297
|
sort_by?: string[];
|
|
26047
26298
|
}, params?: RequestParams) => Promise<AxiosResponse<StageDiagramsListResponse, any, {}>>;
|
|
26048
26299
|
/**
|
|
26049
|
-
* @description Lists stage diagrams.
|
|
26300
|
+
* @description Lists stage diagrams. **Required scopes:** No scopes required.
|
|
26050
26301
|
*
|
|
26051
26302
|
* @tags customization
|
|
26052
26303
|
* @name StageDiagramsListPost
|
|
@@ -26056,7 +26307,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
26056
26307
|
*/
|
|
26057
26308
|
stageDiagramsListPost: (data: StageDiagramsListRequest, params?: RequestParams) => Promise<AxiosResponse<StageDiagramsListResponse, any, {}>>;
|
|
26058
26309
|
/**
|
|
26059
|
-
* @description Updates a stage diagram.
|
|
26310
|
+
* @description Updates a stage diagram. **Required scopes:** - `stage_diagram:write`
|
|
26060
26311
|
*
|
|
26061
26312
|
* @tags customization
|
|
26062
26313
|
* @name StageDiagramsUpdate
|
|
@@ -26066,7 +26317,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
26066
26317
|
*/
|
|
26067
26318
|
stageDiagramsUpdate: (data: StageDiagramsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<StageDiagramsUpdateResponse, any, {}>>;
|
|
26068
26319
|
/**
|
|
26069
|
-
* @description Creates a custom stage.
|
|
26320
|
+
* @description Creates a custom stage. **Required scopes:** - `custom_stage:write`
|
|
26070
26321
|
*
|
|
26071
26322
|
* @tags customization
|
|
26072
26323
|
* @name CustomStagesCreate
|
|
@@ -26076,7 +26327,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
26076
26327
|
*/
|
|
26077
26328
|
customStagesCreate: (data: CustomStagesCreateRequest, params?: RequestParams) => Promise<AxiosResponse<CustomStagesCreateResponse, any, {}>>;
|
|
26078
26329
|
/**
|
|
26079
|
-
* @description Gets a custom stage.
|
|
26330
|
+
* @description Gets a custom stage. **Required scopes:** No scopes required.
|
|
26080
26331
|
*
|
|
26081
26332
|
* @tags customization
|
|
26082
26333
|
* @name CustomStagesGet
|
|
@@ -26092,7 +26343,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
26092
26343
|
id: string;
|
|
26093
26344
|
}, params?: RequestParams) => Promise<AxiosResponse<CustomStagesGetResponse, any, {}>>;
|
|
26094
26345
|
/**
|
|
26095
|
-
* @description Gets a custom stage.
|
|
26346
|
+
* @description Gets a custom stage. **Required scopes:** No scopes required.
|
|
26096
26347
|
*
|
|
26097
26348
|
* @tags customization
|
|
26098
26349
|
* @name CustomStagesGetPost
|
|
@@ -26102,7 +26353,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
26102
26353
|
*/
|
|
26103
26354
|
customStagesGetPost: (data: CustomStagesGetRequest, params?: RequestParams) => Promise<AxiosResponse<CustomStagesGetResponse, any, {}>>;
|
|
26104
26355
|
/**
|
|
26105
|
-
* @description Lists custom stages.
|
|
26356
|
+
* @description Lists custom stages. **Required scopes:** No scopes required.
|
|
26106
26357
|
*
|
|
26107
26358
|
* @tags customization
|
|
26108
26359
|
* @name CustomStagesList
|
|
@@ -26130,7 +26381,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
26130
26381
|
sort_by?: string[];
|
|
26131
26382
|
}, params?: RequestParams) => Promise<AxiosResponse<CustomStagesListResponse, any, {}>>;
|
|
26132
26383
|
/**
|
|
26133
|
-
* @description Lists custom stages.
|
|
26384
|
+
* @description Lists custom stages. **Required scopes:** No scopes required.
|
|
26134
26385
|
*
|
|
26135
26386
|
* @tags customization
|
|
26136
26387
|
* @name CustomStagesListPost
|
|
@@ -26140,7 +26391,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
26140
26391
|
*/
|
|
26141
26392
|
customStagesListPost: (data: CustomStagesListRequest, params?: RequestParams) => Promise<AxiosResponse<CustomStagesListResponse, any, {}>>;
|
|
26142
26393
|
/**
|
|
26143
|
-
* @description Updates a custom stage.
|
|
26394
|
+
* @description Updates a custom stage. **Required scopes:** - `custom_stage:write`
|
|
26144
26395
|
*
|
|
26145
26396
|
* @tags customization
|
|
26146
26397
|
* @name CustomStagesUpdate
|
|
@@ -26150,7 +26401,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
26150
26401
|
*/
|
|
26151
26402
|
customStagesUpdate: (data: CustomStagesUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<CustomStagesUpdateResponse, any, {}>>;
|
|
26152
26403
|
/**
|
|
26153
|
-
* @description Creates a custom state.
|
|
26404
|
+
* @description Creates a custom state. **Required scopes:** - `custom_state:write`
|
|
26154
26405
|
*
|
|
26155
26406
|
* @tags customization
|
|
26156
26407
|
* @name CustomStatesCreate
|
|
@@ -26160,7 +26411,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
26160
26411
|
*/
|
|
26161
26412
|
customStatesCreate: (data: CustomStatesCreateRequest, params?: RequestParams) => Promise<AxiosResponse<CustomStatesCreateResponse, any, {}>>;
|
|
26162
26413
|
/**
|
|
26163
|
-
* @description Gets a custom state.
|
|
26414
|
+
* @description Gets a custom state. **Required scopes:** No scopes required.
|
|
26164
26415
|
*
|
|
26165
26416
|
* @tags customization
|
|
26166
26417
|
* @name CustomStatesGet
|
|
@@ -26176,7 +26427,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
26176
26427
|
id: string;
|
|
26177
26428
|
}, params?: RequestParams) => Promise<AxiosResponse<CustomStatesGetResponse, any, {}>>;
|
|
26178
26429
|
/**
|
|
26179
|
-
* @description Gets a custom state.
|
|
26430
|
+
* @description Gets a custom state. **Required scopes:** No scopes required.
|
|
26180
26431
|
*
|
|
26181
26432
|
* @tags customization
|
|
26182
26433
|
* @name CustomStatesGetPost
|
|
@@ -26186,7 +26437,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
26186
26437
|
*/
|
|
26187
26438
|
customStatesGetPost: (data: CustomStatesGetRequest, params?: RequestParams) => Promise<AxiosResponse<CustomStatesGetResponse, any, {}>>;
|
|
26188
26439
|
/**
|
|
26189
|
-
* @description Lists custom states.
|
|
26440
|
+
* @description Lists custom states. **Required scopes:** No scopes required.
|
|
26190
26441
|
*
|
|
26191
26442
|
* @tags customization
|
|
26192
26443
|
* @name CustomStatesList
|
|
@@ -26216,7 +26467,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
26216
26467
|
sort_by?: string[];
|
|
26217
26468
|
}, params?: RequestParams) => Promise<AxiosResponse<CustomStatesListResponse, any, {}>>;
|
|
26218
26469
|
/**
|
|
26219
|
-
* @description Lists custom states.
|
|
26470
|
+
* @description Lists custom states. **Required scopes:** No scopes required.
|
|
26220
26471
|
*
|
|
26221
26472
|
* @tags customization
|
|
26222
26473
|
* @name CustomStatesListPost
|
|
@@ -26226,7 +26477,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
26226
26477
|
*/
|
|
26227
26478
|
customStatesListPost: (data: CustomStatesListRequest, params?: RequestParams) => Promise<AxiosResponse<CustomStatesListResponse, any, {}>>;
|
|
26228
26479
|
/**
|
|
26229
|
-
* @description Updates a custom state.
|
|
26480
|
+
* @description Updates a custom state. **Required scopes:** - `custom_state:write`
|
|
26230
26481
|
*
|
|
26231
26482
|
* @tags customization
|
|
26232
26483
|
* @name CustomStatesUpdate
|
|
@@ -26236,7 +26487,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
26236
26487
|
*/
|
|
26237
26488
|
customStatesUpdate: (data: CustomStatesUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<CustomStatesUpdateResponse, any, {}>>;
|
|
26238
26489
|
/**
|
|
26239
|
-
* @description Creates a schema for survey, which includes name and description of schema.
|
|
26490
|
+
* @description Creates a schema for survey, which includes name and description of schema. **Required scopes:** - `survey:write` OR `survey:all`
|
|
26240
26491
|
*
|
|
26241
26492
|
* @tags surveys
|
|
26242
26493
|
* @name SurveysCreate
|
|
@@ -26246,7 +26497,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
26246
26497
|
*/
|
|
26247
26498
|
surveysCreate: (data: SurveysCreateRequest, params?: RequestParams) => Promise<AxiosResponse<SurveysCreateResponse, any, {}>>;
|
|
26248
26499
|
/**
|
|
26249
|
-
* @description Deletes the specified survey.
|
|
26500
|
+
* @description Deletes the specified survey. **Required scopes:** - `survey:all`
|
|
26250
26501
|
*
|
|
26251
26502
|
* @tags surveys
|
|
26252
26503
|
* @name SurveysDelete
|
|
@@ -26256,7 +26507,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
26256
26507
|
*/
|
|
26257
26508
|
surveysDelete: (data: SurveysDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
|
|
26258
26509
|
/**
|
|
26259
|
-
* @description Gets a survey given the ID.
|
|
26510
|
+
* @description Gets a survey given the ID. **Required scopes:** - `survey:read` OR `survey:write` OR `survey:all`
|
|
26260
26511
|
*
|
|
26261
26512
|
* @tags surveys
|
|
26262
26513
|
* @name SurveysGet
|
|
@@ -26272,7 +26523,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
26272
26523
|
id: string;
|
|
26273
26524
|
}, params?: RequestParams) => Promise<AxiosResponse<SurveysGetResponse, any, {}>>;
|
|
26274
26525
|
/**
|
|
26275
|
-
* @description Gets a survey given the ID.
|
|
26526
|
+
* @description Gets a survey given the ID. **Required scopes:** - `survey:read` OR `survey:write` OR `survey:all`
|
|
26276
26527
|
*
|
|
26277
26528
|
* @tags surveys
|
|
26278
26529
|
* @name SurveysGetPost
|
|
@@ -26282,7 +26533,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
26282
26533
|
*/
|
|
26283
26534
|
surveysGetPost: (data: SurveysGetRequest, params?: RequestParams) => Promise<AxiosResponse<SurveysGetResponse, any, {}>>;
|
|
26284
26535
|
/**
|
|
26285
|
-
* @description List surveys requested by the user.
|
|
26536
|
+
* @description List surveys requested by the user. **Required scopes:** - `survey:read` OR `survey:write` OR `survey:all`
|
|
26286
26537
|
*
|
|
26287
26538
|
* @tags surveys
|
|
26288
26539
|
* @name SurveysList
|
|
@@ -26319,7 +26570,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
26319
26570
|
sort_by?: string[];
|
|
26320
26571
|
}, params?: RequestParams) => Promise<AxiosResponse<SurveysListResponse, any, {}>>;
|
|
26321
26572
|
/**
|
|
26322
|
-
* @description List surveys requested by the user.
|
|
26573
|
+
* @description List surveys requested by the user. **Required scopes:** - `survey:read` OR `survey:write` OR `survey:all`
|
|
26323
26574
|
*
|
|
26324
26575
|
* @tags surveys
|
|
26325
26576
|
* @name SurveysListPost
|
|
@@ -26329,7 +26580,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
26329
26580
|
*/
|
|
26330
26581
|
surveysListPost: (data: SurveysListRequest, params?: RequestParams) => Promise<AxiosResponse<SurveysListResponse, any, {}>>;
|
|
26331
26582
|
/**
|
|
26332
|
-
* @description List survey responses requested by the user.
|
|
26583
|
+
* @description List survey responses requested by the user. **Required scopes:** - `survey_response:read` OR `survey_response:write` OR `survey_response:all`
|
|
26333
26584
|
*
|
|
26334
26585
|
* @tags surveys
|
|
26335
26586
|
* @name SurveysResponsesList
|
|
@@ -26383,7 +26634,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
26383
26634
|
surveys?: string[];
|
|
26384
26635
|
}, params?: RequestParams) => Promise<AxiosResponse<SurveysResponsesListResponse, any, {}>>;
|
|
26385
26636
|
/**
|
|
26386
|
-
* @description List survey responses requested by the user.
|
|
26637
|
+
* @description List survey responses requested by the user. **Required scopes:** - `survey_response:read` OR `survey_response:write` OR `survey_response:all`
|
|
26387
26638
|
*
|
|
26388
26639
|
* @tags surveys
|
|
26389
26640
|
* @name SurveysResponsesListPost
|
|
@@ -26393,7 +26644,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
26393
26644
|
*/
|
|
26394
26645
|
surveysResponsesListPost: (data: SurveysResponsesListRequest, params?: RequestParams) => Promise<AxiosResponse<SurveysResponsesListResponse, any, {}>>;
|
|
26395
26646
|
/**
|
|
26396
|
-
* @description Updates a user's survey response for the provided dispatch ID.
|
|
26647
|
+
* @description Updates a user's survey response for the provided dispatch ID. **Required scopes:** - `survey_response:write` OR `survey_response:all`
|
|
26397
26648
|
*
|
|
26398
26649
|
* @tags surveys
|
|
26399
26650
|
* @name SurveysResponsesUpdate
|
|
@@ -26403,7 +26654,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
26403
26654
|
*/
|
|
26404
26655
|
surveysResponsesUpdate: (data: SurveysResponsesUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
|
|
26405
26656
|
/**
|
|
26406
|
-
* @description Sends a survey on the specified channels.
|
|
26657
|
+
* @description Sends a survey on the specified channels. **Required scopes:** - `survey:write` OR `survey:all`
|
|
26407
26658
|
*
|
|
26408
26659
|
* @tags surveys
|
|
26409
26660
|
* @name SurveysSend
|
|
@@ -26413,7 +26664,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
26413
26664
|
*/
|
|
26414
26665
|
surveysSend: (data: SurveysSendRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
|
|
26415
26666
|
/**
|
|
26416
|
-
* @description Submits a user response to a survey, which is defined by the survey ID.
|
|
26667
|
+
* @description Submits a user response to a survey, which is defined by the survey ID. **Required scopes:** - `survey_response:write` OR `survey_response:all`
|
|
26417
26668
|
*
|
|
26418
26669
|
* @tags surveys
|
|
26419
26670
|
* @name SurveysSubmit
|
|
@@ -26423,7 +26674,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
26423
26674
|
*/
|
|
26424
26675
|
surveysSubmit: (data: SurveysSubmitRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
|
|
26425
26676
|
/**
|
|
26426
|
-
* @description Updates a survey's metadata.
|
|
26677
|
+
* @description Updates a survey's metadata. **Required scopes:** - `survey:write` OR `survey:all`
|
|
26427
26678
|
*
|
|
26428
26679
|
* @tags surveys
|
|
26429
26680
|
* @name SurveysUpdate
|
|
@@ -26433,7 +26684,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
26433
26684
|
*/
|
|
26434
26685
|
surveysUpdate: (data: SurveysUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<SurveysUpdateResponse, any, {}>>;
|
|
26435
26686
|
/**
|
|
26436
|
-
* @description Lists system users within your organization. **Required scopes:**
|
|
26687
|
+
* @description Lists system users within your organization. **Required scopes:** Default Scopes unavailable for this API.
|
|
26437
26688
|
*
|
|
26438
26689
|
* @tags sys-users
|
|
26439
26690
|
* @name SysUsersList
|
|
@@ -26463,7 +26714,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
26463
26714
|
sort_by?: string[];
|
|
26464
26715
|
}, params?: RequestParams) => Promise<AxiosResponse<SysUsersListResponse, any, {}>>;
|
|
26465
26716
|
/**
|
|
26466
|
-
* @description Lists system users within your organization. **Required scopes:**
|
|
26717
|
+
* @description Lists system users within your organization. **Required scopes:** Default Scopes unavailable for this API.
|
|
26467
26718
|
*
|
|
26468
26719
|
* @tags sys-users
|
|
26469
26720
|
* @name SysUsersListPost
|
|
@@ -26473,7 +26724,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
26473
26724
|
*/
|
|
26474
26725
|
sysUsersListPost: (data: SysUsersListRequest, params?: RequestParams) => Promise<AxiosResponse<SysUsersListResponse, any, {}>>;
|
|
26475
26726
|
/**
|
|
26476
|
-
* @description Updates the system user. **Required scopes:**
|
|
26727
|
+
* @description Updates the system user. **Required scopes:** Default Scopes unavailable for this API.
|
|
26477
26728
|
*
|
|
26478
26729
|
* @tags sys-users
|
|
26479
26730
|
* @name SysUsersUpdate
|
|
@@ -26483,7 +26734,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
26483
26734
|
*/
|
|
26484
26735
|
sysUsersUpdate: (data: SysUsersUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<SysUsersUpdateResponse, any, {}>>;
|
|
26485
26736
|
/**
|
|
26486
|
-
* @description Creates a new tag, which is used to create associations between objects and a logical concept denoted by the tag's name.
|
|
26737
|
+
* @description Creates a new tag, which is used to create associations between objects and a logical concept denoted by the tag's name. **Required scopes:** - `tag:write` OR `tag:all`
|
|
26487
26738
|
*
|
|
26488
26739
|
* @tags tags
|
|
26489
26740
|
* @name TagsCreate
|
|
@@ -26493,7 +26744,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
26493
26744
|
*/
|
|
26494
26745
|
tagsCreate: (data: TagsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<TagsCreateResponse, any, {}>>;
|
|
26495
26746
|
/**
|
|
26496
|
-
* @description Deletes a tag.
|
|
26747
|
+
* @description Deletes a tag. **Required scopes:** - `tag:all`
|
|
26497
26748
|
*
|
|
26498
26749
|
* @tags tags
|
|
26499
26750
|
* @name TagsDelete
|
|
@@ -26503,7 +26754,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
26503
26754
|
*/
|
|
26504
26755
|
tagsDelete: (data: TagsDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
|
|
26505
26756
|
/**
|
|
26506
|
-
* @description Gets a tag's information.
|
|
26757
|
+
* @description Gets a tag's information. **Required scopes:** - `tag:read` OR `tag:write` OR `tag:all`
|
|
26507
26758
|
*
|
|
26508
26759
|
* @tags tags
|
|
26509
26760
|
* @name TagsGet
|
|
@@ -26520,7 +26771,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
26520
26771
|
id: string;
|
|
26521
26772
|
}, params?: RequestParams) => Promise<AxiosResponse<TagsGetResponse, any, {}>>;
|
|
26522
26773
|
/**
|
|
26523
|
-
* @description Gets a tag's information.
|
|
26774
|
+
* @description Gets a tag's information. **Required scopes:** - `tag:read` OR `tag:write` OR `tag:all`
|
|
26524
26775
|
*
|
|
26525
26776
|
* @tags tags
|
|
26526
26777
|
* @name TagsGetPost
|
|
@@ -26530,7 +26781,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
26530
26781
|
*/
|
|
26531
26782
|
tagsGetPost: (data: TagsGetRequest, params?: RequestParams) => Promise<AxiosResponse<TagsGetResponse, any, {}>>;
|
|
26532
26783
|
/**
|
|
26533
|
-
* @description Lists the available tags.
|
|
26784
|
+
* @description Lists the available tags. **Required scopes:** - `tag:read` OR `tag:write` OR `tag:all`
|
|
26534
26785
|
*
|
|
26535
26786
|
* @tags tags
|
|
26536
26787
|
* @name TagsList
|
|
@@ -26561,7 +26812,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
26561
26812
|
sort_by?: string[];
|
|
26562
26813
|
}, params?: RequestParams) => Promise<AxiosResponse<TagsListResponse, any, {}>>;
|
|
26563
26814
|
/**
|
|
26564
|
-
* @description Lists the available tags.
|
|
26815
|
+
* @description Lists the available tags. **Required scopes:** - `tag:read` OR `tag:write` OR `tag:all`
|
|
26565
26816
|
*
|
|
26566
26817
|
* @tags tags
|
|
26567
26818
|
* @name TagsListPost
|
|
@@ -26571,7 +26822,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
26571
26822
|
*/
|
|
26572
26823
|
tagsListPost: (data: TagsListRequest, params?: RequestParams) => Promise<AxiosResponse<TagsListResponse, any, {}>>;
|
|
26573
26824
|
/**
|
|
26574
|
-
* @description Updates a tag's information.
|
|
26825
|
+
* @description Updates a tag's information. **Required scopes:** - `tag:write` OR `tag:all`
|
|
26575
26826
|
*
|
|
26576
26827
|
* @tags tags
|
|
26577
26828
|
* @name TagsUpdate
|
|
@@ -26581,7 +26832,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
26581
26832
|
*/
|
|
26582
26833
|
tagsUpdate: (data: TagsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<TagsUpdateResponse, any, {}>>;
|
|
26583
26834
|
/**
|
|
26584
|
-
* @description Creates a new entry on an object's timeline.
|
|
26835
|
+
* @description Creates a new entry on an object's timeline. **Required scopes:** Requires the read or write scope of the parent object's type (e.g. issue:write when posting to an issue's timeline).
|
|
26585
26836
|
*
|
|
26586
26837
|
* @tags timeline-entries
|
|
26587
26838
|
* @name TimelineEntriesCreate
|
|
@@ -26591,7 +26842,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
26591
26842
|
*/
|
|
26592
26843
|
timelineEntriesCreate: (data: TimelineEntriesCreateRequest, params?: RequestParams) => Promise<AxiosResponse<TimelineEntriesCreateResponse, any, {}>>;
|
|
26593
26844
|
/**
|
|
26594
|
-
* @description Deletes an entry from an object's timeline.
|
|
26845
|
+
* @description Deletes an entry from an object's timeline. **Required scopes:** Requires the read or write scope of the parent object's type (e.g. issue:write when posting to an issue's timeline).
|
|
26595
26846
|
*
|
|
26596
26847
|
* @tags timeline-entries
|
|
26597
26848
|
* @name TimelineEntriesDelete
|
|
@@ -26601,7 +26852,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
26601
26852
|
*/
|
|
26602
26853
|
timelineEntriesDelete: (data: TimelineEntriesDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
|
|
26603
26854
|
/**
|
|
26604
|
-
* @description Gets an entry on an object's timeline.
|
|
26855
|
+
* @description Gets an entry on an object's timeline. **Required scopes:** Requires the read or write scope of the parent object's type (e.g. issue:write when posting to an issue's timeline).
|
|
26605
26856
|
*
|
|
26606
26857
|
* @tags timeline-entries
|
|
26607
26858
|
* @name TimelineEntriesGet
|
|
@@ -26626,7 +26877,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
26626
26877
|
external_ref?: string;
|
|
26627
26878
|
}, params?: RequestParams) => Promise<AxiosResponse<TimelineEntriesGetResponse, any, {}>>;
|
|
26628
26879
|
/**
|
|
26629
|
-
* @description Gets an entry on an object's timeline.
|
|
26880
|
+
* @description Gets an entry on an object's timeline. **Required scopes:** Requires the read or write scope of the parent object's type (e.g. issue:write when posting to an issue's timeline).
|
|
26630
26881
|
*
|
|
26631
26882
|
* @tags timeline-entries
|
|
26632
26883
|
* @name TimelineEntriesGetPost
|
|
@@ -26636,7 +26887,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
26636
26887
|
*/
|
|
26637
26888
|
timelineEntriesGetPost: (data: TimelineEntriesGetRequest, params?: RequestParams) => Promise<AxiosResponse<TimelineEntriesGetResponse, any, {}>>;
|
|
26638
26889
|
/**
|
|
26639
|
-
* @description Lists the timeline entries for an object.
|
|
26890
|
+
* @description Lists the timeline entries for an object. **Required scopes:** Requires the read or write scope of the parent object's type (e.g. issue:write when posting to an issue's timeline).
|
|
26640
26891
|
*
|
|
26641
26892
|
* @tags timeline-entries
|
|
26642
26893
|
* @name TimelineEntriesList
|
|
@@ -26656,8 +26907,14 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
26656
26907
|
/**
|
|
26657
26908
|
* The collection(s) to list entries from, otherwise if not provided,
|
|
26658
26909
|
* all entries are returned.
|
|
26910
|
+
* @maxItems 1
|
|
26659
26911
|
*/
|
|
26660
26912
|
collections?: TimelineEntriesCollection[];
|
|
26913
|
+
/**
|
|
26914
|
+
* Filters for entries created by any of the provided users.
|
|
26915
|
+
* @example ["DEVU-12345"]
|
|
26916
|
+
*/
|
|
26917
|
+
created_by?: string[];
|
|
26661
26918
|
/**
|
|
26662
26919
|
* Filters for objects created after the provided timestamp (inclusive).
|
|
26663
26920
|
* @format date-time
|
|
@@ -26706,7 +26963,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
26706
26963
|
visibility?: TimelineEntryVisibility[];
|
|
26707
26964
|
}, params?: RequestParams) => Promise<AxiosResponse<TimelineEntriesListResponse, any, {}>>;
|
|
26708
26965
|
/**
|
|
26709
|
-
* @description Lists the timeline entries for an object.
|
|
26966
|
+
* @description Lists the timeline entries for an object. **Required scopes:** Requires the read or write scope of the parent object's type (e.g. issue:write when posting to an issue's timeline).
|
|
26710
26967
|
*
|
|
26711
26968
|
* @tags timeline-entries
|
|
26712
26969
|
* @name TimelineEntriesListPost
|
|
@@ -26716,7 +26973,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
26716
26973
|
*/
|
|
26717
26974
|
timelineEntriesListPost: (data: TimelineEntriesListRequest, params?: RequestParams) => Promise<AxiosResponse<TimelineEntriesListResponse, any, {}>>;
|
|
26718
26975
|
/**
|
|
26719
|
-
* @description Updates an entry on an object's timeline.
|
|
26976
|
+
* @description Updates an entry on an object's timeline. **Required scopes:** Requires the read or write scope of the parent object's type (e.g. issue:write when posting to an issue's timeline).
|
|
26720
26977
|
*
|
|
26721
26978
|
* @tags timeline-entries
|
|
26722
26979
|
* @name TimelineEntriesUpdate
|
|
@@ -26726,7 +26983,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
26726
26983
|
*/
|
|
26727
26984
|
timelineEntriesUpdate: (data: TimelineEntriesUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<TimelineEntriesUpdateResponse, any, {}>>;
|
|
26728
26985
|
/**
|
|
26729
|
-
* @description Deletes the requested vista.
|
|
26986
|
+
* @description Deletes the requested vista. **Required scopes:** - `vista:all`
|
|
26730
26987
|
*
|
|
26731
26988
|
* @tags vistas
|
|
26732
26989
|
* @name VistasDelete
|
|
@@ -26736,7 +26993,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
26736
26993
|
*/
|
|
26737
26994
|
vistasDelete: (data: VistasDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
|
|
26738
26995
|
/**
|
|
26739
|
-
* @description Gets the requested vistas's information.
|
|
26996
|
+
* @description Gets the requested vistas's information. **Required scopes:** - `vista:read` OR `vista:write` OR `vista:all`
|
|
26740
26997
|
*
|
|
26741
26998
|
* @tags vistas
|
|
26742
26999
|
* @name VistasGet
|
|
@@ -26753,7 +27010,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
26753
27010
|
id: string;
|
|
26754
27011
|
}, params?: RequestParams) => Promise<AxiosResponse<VistasGetResponse, any, {}>>;
|
|
26755
27012
|
/**
|
|
26756
|
-
* @description Gets the requested vistas's information.
|
|
27013
|
+
* @description Gets the requested vistas's information. **Required scopes:** - `vista:read` OR `vista:write` OR `vista:all`
|
|
26757
27014
|
*
|
|
26758
27015
|
* @tags vistas
|
|
26759
27016
|
* @name VistasGetPost
|
|
@@ -26763,7 +27020,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
26763
27020
|
*/
|
|
26764
27021
|
vistasGetPost: (data: VistasGetRequest, params?: RequestParams) => Promise<AxiosResponse<VistasGetResponse, any, {}>>;
|
|
26765
27022
|
/**
|
|
26766
|
-
* @description Deletes the requested vista group item
|
|
27023
|
+
* @description Deletes the requested vista group item **Required scopes:** - `vista:all` No scopes required for default vistas.
|
|
26767
27024
|
*
|
|
26768
27025
|
* @tags vistas
|
|
26769
27026
|
* @name VistasGroupsDelete
|
|
@@ -26773,7 +27030,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
26773
27030
|
*/
|
|
26774
27031
|
vistasGroupsDelete: (data: VistasGroupsDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
|
|
26775
27032
|
/**
|
|
26776
|
-
* @description Gets the requested vista group item's information.
|
|
27033
|
+
* @description Gets the requested vista group item's information. **Required scopes:** - `vista:read` OR `vista:write` OR `vista:all` No scopes required for default vistas.
|
|
26777
27034
|
*
|
|
26778
27035
|
* @tags vistas
|
|
26779
27036
|
* @name VistasGroupsGet
|
|
@@ -26789,7 +27046,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
26789
27046
|
id: string;
|
|
26790
27047
|
}, params?: RequestParams) => Promise<AxiosResponse<VistasGroupsGetResponse, any, {}>>;
|
|
26791
27048
|
/**
|
|
26792
|
-
* @description Gets the requested vista group item's information.
|
|
27049
|
+
* @description Gets the requested vista group item's information. **Required scopes:** - `vista:read` OR `vista:write` OR `vista:all` No scopes required for default vistas.
|
|
26793
27050
|
*
|
|
26794
27051
|
* @tags vistas
|
|
26795
27052
|
* @name VistasGroupsGetPost
|
|
@@ -26799,7 +27056,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
26799
27056
|
*/
|
|
26800
27057
|
vistasGroupsGetPost: (data: VistasGroupsGetRequest, params?: RequestParams) => Promise<AxiosResponse<VistasGroupsGetResponse, any, {}>>;
|
|
26801
27058
|
/**
|
|
26802
|
-
* @description Lists the available vista group items.
|
|
27059
|
+
* @description Lists the available vista group items. **Required scopes:** - `vista:read` OR `vista:write` OR `vista:all` No scopes required for default vistas.
|
|
26803
27060
|
*
|
|
26804
27061
|
* @tags vistas
|
|
26805
27062
|
* @name VistasGroupsList
|
|
@@ -26861,7 +27118,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
26861
27118
|
type?: GroupItemType[];
|
|
26862
27119
|
}, params?: RequestParams) => Promise<AxiosResponse<VistasGroupsListResponse, any, {}>>;
|
|
26863
27120
|
/**
|
|
26864
|
-
* @description Lists the available vista group items.
|
|
27121
|
+
* @description Lists the available vista group items. **Required scopes:** - `vista:read` OR `vista:write` OR `vista:all` No scopes required for default vistas.
|
|
26865
27122
|
*
|
|
26866
27123
|
* @tags vistas
|
|
26867
27124
|
* @name VistasGroupsListPost
|
|
@@ -26871,7 +27128,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
26871
27128
|
*/
|
|
26872
27129
|
vistasGroupsListPost: (data: VistasGroupsListRequest, params?: RequestParams) => Promise<AxiosResponse<VistasGroupsListResponse, any, {}>>;
|
|
26873
27130
|
/**
|
|
26874
|
-
* @description Lists the available vistas.
|
|
27131
|
+
* @description Lists the available vistas. **Required scopes:** - `vista:read` OR `vista:write` OR `vista:all`
|
|
26875
27132
|
*
|
|
26876
27133
|
* @tags vistas
|
|
26877
27134
|
* @name VistasList
|
|
@@ -26933,7 +27190,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
26933
27190
|
type?: VistaType[];
|
|
26934
27191
|
}, params?: RequestParams) => Promise<AxiosResponse<VistasListResponse, any, {}>>;
|
|
26935
27192
|
/**
|
|
26936
|
-
* @description Lists the available vistas.
|
|
27193
|
+
* @description Lists the available vistas. **Required scopes:** - `vista:read` OR `vista:write` OR `vista:all`
|
|
26937
27194
|
*
|
|
26938
27195
|
* @tags vistas
|
|
26939
27196
|
* @name VistasListPost
|
|
@@ -26943,7 +27200,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
26943
27200
|
*/
|
|
26944
27201
|
vistasListPost: (data: VistasListRequest, params?: RequestParams) => Promise<AxiosResponse<VistasListResponse, any, {}>>;
|
|
26945
27202
|
/**
|
|
26946
|
-
* @description Change state of a web crawler job to pause or resume it back to running.
|
|
27203
|
+
* @description Change state of a web crawler job to pause or resume it back to running. **Required scopes:** - `web_crawler_job:all`
|
|
26947
27204
|
*
|
|
26948
27205
|
* @tags web-crawler-job
|
|
26949
27206
|
* @name WebCrawlerJobsControl
|
|
@@ -26953,7 +27210,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
26953
27210
|
*/
|
|
26954
27211
|
webCrawlerJobsControl: (data: WebCrawlerJobsControlRequest, params?: RequestParams) => Promise<AxiosResponse<WebCrawlerJobsControlResponse, any, {}>>;
|
|
26955
27212
|
/**
|
|
26956
|
-
* @description Creates a web crawler job whose objective is to crawl the provided URLs/sitemaps and generate corresponding webpages as artifacts.
|
|
27213
|
+
* @description Creates a web crawler job whose objective is to crawl the provided URLs/sitemaps and generate corresponding webpages as artifacts. **Required scopes:** - `web_crawler_job:all`
|
|
26957
27214
|
*
|
|
26958
27215
|
* @tags web-crawler-job
|
|
26959
27216
|
* @name CreateWebCrawlerJob
|
|
@@ -26963,7 +27220,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
26963
27220
|
*/
|
|
26964
27221
|
createWebCrawlerJob: (data: WebCrawlerJobsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<WebCrawlerJobsCreateResponse, any, {}>>;
|
|
26965
27222
|
/**
|
|
26966
|
-
* @description Gets a web crawler job.
|
|
27223
|
+
* @description Gets a web crawler job. **Required scopes:** - `web_crawler_job:all`
|
|
26967
27224
|
*
|
|
26968
27225
|
* @tags web-crawler-job
|
|
26969
27226
|
* @name GetWebCrawlerJob
|
|
@@ -26979,7 +27236,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
26979
27236
|
id: string;
|
|
26980
27237
|
}, params?: RequestParams) => Promise<AxiosResponse<WebCrawlerJobsGetResponse, any, {}>>;
|
|
26981
27238
|
/**
|
|
26982
|
-
* @description Gets a web crawler job.
|
|
27239
|
+
* @description Gets a web crawler job. **Required scopes:** - `web_crawler_job:all`
|
|
26983
27240
|
*
|
|
26984
27241
|
* @tags web-crawler-job
|
|
26985
27242
|
* @name GetWebCrawlerJobPost
|
|
@@ -26989,7 +27246,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
26989
27246
|
*/
|
|
26990
27247
|
getWebCrawlerJobPost: (data: WebCrawlerJobsGetRequest, params?: RequestParams) => Promise<AxiosResponse<WebCrawlerJobsGetResponse, any, {}>>;
|
|
26991
27248
|
/**
|
|
26992
|
-
* @description Lists web crawler jobs.
|
|
27249
|
+
* @description Lists web crawler jobs. **Required scopes:** - `web_crawler_job:all`
|
|
26993
27250
|
*
|
|
26994
27251
|
* @tags web-crawler-job
|
|
26995
27252
|
* @name ListWebCrawlerJobs
|
|
@@ -27022,7 +27279,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
27022
27279
|
mode?: ListMode;
|
|
27023
27280
|
}, params?: RequestParams) => Promise<AxiosResponse<WebCrawlerJobsListResponse, any, {}>>;
|
|
27024
27281
|
/**
|
|
27025
|
-
* @description Lists web crawler jobs.
|
|
27282
|
+
* @description Lists web crawler jobs. **Required scopes:** - `web_crawler_job:all`
|
|
27026
27283
|
*
|
|
27027
27284
|
* @tags web-crawler-job
|
|
27028
27285
|
* @name ListWebCrawlerJobsPost
|
|
@@ -27032,7 +27289,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
27032
27289
|
*/
|
|
27033
27290
|
listWebCrawlerJobsPost: (data: WebCrawlerJobsListRequest, params?: RequestParams) => Promise<AxiosResponse<WebCrawlerJobsListResponse, any, {}>>;
|
|
27034
27291
|
/**
|
|
27035
|
-
* @description Creates a new webhook target.
|
|
27292
|
+
* @description Creates a new webhook target. **Required scopes:** Default Scopes unavailable for this API.
|
|
27036
27293
|
*
|
|
27037
27294
|
* @tags webhooks
|
|
27038
27295
|
* @name WebhooksCreate
|
|
@@ -27042,7 +27299,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
27042
27299
|
*/
|
|
27043
27300
|
webhooksCreate: (data: WebhooksCreateRequest, params?: RequestParams) => Promise<AxiosResponse<WebhooksCreateResponse, any, {}>>;
|
|
27044
27301
|
/**
|
|
27045
|
-
* @description Deletes the requested webhook.
|
|
27302
|
+
* @description Deletes the requested webhook. **Required scopes:** Default Scopes unavailable for this API.
|
|
27046
27303
|
*
|
|
27047
27304
|
* @tags webhooks
|
|
27048
27305
|
* @name WebhooksDelete
|
|
@@ -27052,7 +27309,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
27052
27309
|
*/
|
|
27053
27310
|
webhooksDelete: (data: WebhooksDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
|
|
27054
27311
|
/**
|
|
27055
|
-
* @description Describes a webhook invocation for an event from DevRev to a webhook's target URL, where the receiving handler must implement the specified protocol. Note the documented endpoint is for exposition and not provided by DevRev.
|
|
27312
|
+
* @description Describes a webhook invocation for an event from DevRev to a webhook's target URL, where the receiving handler must implement the specified protocol. Note the documented endpoint is for exposition and not provided by DevRev. **Required scopes:** Default Scopes unavailable for this API.
|
|
27056
27313
|
*
|
|
27057
27314
|
* @tags webhooks
|
|
27058
27315
|
* @name WebhooksEvent
|
|
@@ -27062,7 +27319,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
27062
27319
|
*/
|
|
27063
27320
|
webhooksEvent: (data: WebhookEventRequest, params?: RequestParams) => Promise<AxiosResponse<WebhookEventResponse, any, {}>>;
|
|
27064
27321
|
/**
|
|
27065
|
-
* @description Gets the requested webhook's information.
|
|
27322
|
+
* @description Gets the requested webhook's information. **Required scopes:** Default Scopes unavailable for this API.
|
|
27066
27323
|
*
|
|
27067
27324
|
* @tags webhooks
|
|
27068
27325
|
* @name WebhooksGet
|
|
@@ -27079,7 +27336,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
27079
27336
|
id: string;
|
|
27080
27337
|
}, params?: RequestParams) => Promise<AxiosResponse<WebhooksGetResponse, any, {}>>;
|
|
27081
27338
|
/**
|
|
27082
|
-
* @description Gets the requested webhook's information.
|
|
27339
|
+
* @description Gets the requested webhook's information. **Required scopes:** Default Scopes unavailable for this API.
|
|
27083
27340
|
*
|
|
27084
27341
|
* @tags webhooks
|
|
27085
27342
|
* @name WebhooksGetPost
|
|
@@ -27089,7 +27346,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
27089
27346
|
*/
|
|
27090
27347
|
webhooksGetPost: (data: WebhooksGetRequest, params?: RequestParams) => Promise<AxiosResponse<WebhooksGetResponse, any, {}>>;
|
|
27091
27348
|
/**
|
|
27092
|
-
* @description Lists the webhooks.
|
|
27349
|
+
* @description Lists the webhooks. **Required scopes:** Default Scopes unavailable for this API.
|
|
27093
27350
|
*
|
|
27094
27351
|
* @tags webhooks
|
|
27095
27352
|
* @name WebhooksList
|
|
@@ -27102,7 +27359,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
27102
27359
|
status?: WebhookStatus[];
|
|
27103
27360
|
}, params?: RequestParams) => Promise<AxiosResponse<WebhooksListResponse, any, {}>>;
|
|
27104
27361
|
/**
|
|
27105
|
-
* @description Lists the webhooks.
|
|
27362
|
+
* @description Lists the webhooks. **Required scopes:** Default Scopes unavailable for this API.
|
|
27106
27363
|
*
|
|
27107
27364
|
* @tags webhooks
|
|
27108
27365
|
* @name WebhooksListPost
|
|
@@ -27112,7 +27369,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
27112
27369
|
*/
|
|
27113
27370
|
webhooksListPost: (data: WebhooksListRequest, params?: RequestParams) => Promise<AxiosResponse<WebhooksListResponse, any, {}>>;
|
|
27114
27371
|
/**
|
|
27115
|
-
* @description Updates the requested webhook.
|
|
27372
|
+
* @description Updates the requested webhook. **Required scopes:** Default Scopes unavailable for this API.
|
|
27116
27373
|
*
|
|
27117
27374
|
* @tags webhooks
|
|
27118
27375
|
* @name WebhooksUpdate
|
|
@@ -27122,7 +27379,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
27122
27379
|
*/
|
|
27123
27380
|
webhooksUpdate: (data: WebhooksUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<WebhooksUpdateResponse, any, {}>>;
|
|
27124
27381
|
/**
|
|
27125
|
-
* @description Get count of work matching given filter.
|
|
27382
|
+
* @description Get count of work matching given filter. **Required scopes:** Depends on the object type in the `type` field: | type | required scope | |---|---| | incident | `incident:read` OR `incident:write` OR `incident:all` | | issue | `issue:read` OR `issue:write` OR `issue:all` | | opportunity | `opportunity:read` OR `opportunity:write` OR `opportunity:all` | | task | `task:read` OR `task:write` OR `task:all` | | ticket | `ticket:read` OR `ticket:write` OR `ticket:all` |
|
|
27126
27383
|
*
|
|
27127
27384
|
* @tags works
|
|
27128
27385
|
* @name WorksCount
|
|
@@ -27291,7 +27548,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
27291
27548
|
vista?: string;
|
|
27292
27549
|
}, params?: RequestParams) => Promise<AxiosResponse<WorksCountResponse, any, {}>>;
|
|
27293
27550
|
/**
|
|
27294
|
-
* @description Get count of work matching given filter.
|
|
27551
|
+
* @description Get count of work matching given filter. **Required scopes:** Depends on the object type in the `type` field: | type | required scope | |---|---| | incident | `incident:read` OR `incident:write` OR `incident:all` | | issue | `issue:read` OR `issue:write` OR `issue:all` | | opportunity | `opportunity:read` OR `opportunity:write` OR `opportunity:all` | | task | `task:read` OR `task:write` OR `task:all` | | ticket | `ticket:read` OR `ticket:write` OR `ticket:all` |
|
|
27295
27552
|
*
|
|
27296
27553
|
* @tags works
|
|
27297
27554
|
* @name WorksCountPost
|
|
@@ -27301,7 +27558,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
27301
27558
|
*/
|
|
27302
27559
|
worksCountPost: (data: WorksCountRequest, params?: RequestParams) => Promise<AxiosResponse<WorksCountResponse, any, {}>>;
|
|
27303
27560
|
/**
|
|
27304
|
-
* @description Creates new work ([issue](https://devrev.ai/docs/product/build), [ticket](https://devrev.ai/docs/product/support)) item. [task](https://devrev.ai/docs/product/tasks) and opportunity work types are supported in the beta version.
|
|
27561
|
+
* @description Creates new work ([issue](https://devrev.ai/docs/product/build), [ticket](https://devrev.ai/docs/product/support)) item. [task](https://devrev.ai/docs/product/tasks) and opportunity work types are supported in the beta version. **Required scopes:** Depends on the object type in the `type` field: | type | required scope | |---|---| | incident | `incident:write` OR `incident:all` | | issue | `issue:write` OR `issue:all` | | opportunity | `opportunity:write` OR `opportunity:all` | | task | `task:write` OR `task:all` | | ticket | `ticket:write` OR `ticket:all` |
|
|
27305
27562
|
*
|
|
27306
27563
|
* @tags works
|
|
27307
27564
|
* @name WorksCreate
|
|
@@ -27311,7 +27568,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
27311
27568
|
*/
|
|
27312
27569
|
worksCreate: (data: WorksCreateRequest, params?: RequestParams) => Promise<AxiosResponse<WorksCreateResponse, any, {}>>;
|
|
27313
27570
|
/**
|
|
27314
|
-
* @description Deletes a work item.
|
|
27571
|
+
* @description Deletes a work item. **Required scopes:** Depends on the object type in the `id` field: | type | required scope | |---|---| | incident | `incident:all` | | issue | `issue:all` | | opportunity | `opportunity:all` | | task | `task:all` | | ticket | `ticket:all` |
|
|
27315
27572
|
*
|
|
27316
27573
|
* @tags works
|
|
27317
27574
|
* @name WorksDelete
|
|
@@ -27321,7 +27578,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
27321
27578
|
*/
|
|
27322
27579
|
worksDelete: (data: WorksDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any, {}>>;
|
|
27323
27580
|
/**
|
|
27324
|
-
* @description Exports a collection of work items.
|
|
27581
|
+
* @description Exports a collection of work items. **Required scopes:** Depends on the object type in the `type` field: | type | required scope | |---|---| | incident | `incident:read` OR `incident:write` OR `incident:all` | | issue | `issue:read` OR `issue:write` OR `issue:all` | | opportunity | `opportunity:read` OR `opportunity:write` OR `opportunity:all` | | task | `task:read` OR `task:write` OR `task:all` | | ticket | `ticket:read` OR `ticket:write` OR `ticket:all` |
|
|
27325
27582
|
*
|
|
27326
27583
|
* @tags works
|
|
27327
27584
|
* @name WorksExport
|
|
@@ -27498,7 +27755,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
27498
27755
|
vista?: string;
|
|
27499
27756
|
}, params?: RequestParams) => Promise<AxiosResponse<WorksExportResponse, any, {}>>;
|
|
27500
27757
|
/**
|
|
27501
|
-
* @description Exports a collection of work items.
|
|
27758
|
+
* @description Exports a collection of work items. **Required scopes:** Depends on the object type in the `type` field: | type | required scope | |---|---| | incident | `incident:read` OR `incident:write` OR `incident:all` | | issue | `issue:read` OR `issue:write` OR `issue:all` | | opportunity | `opportunity:read` OR `opportunity:write` OR `opportunity:all` | | task | `task:read` OR `task:write` OR `task:all` | | ticket | `ticket:read` OR `ticket:write` OR `ticket:all` |
|
|
27502
27759
|
*
|
|
27503
27760
|
* @tags works
|
|
27504
27761
|
* @name WorksExportPost
|
|
@@ -27508,7 +27765,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
27508
27765
|
*/
|
|
27509
27766
|
worksExportPost: (data: WorksExportRequest, params?: RequestParams) => Promise<AxiosResponse<WorksExportResponse, any, {}>>;
|
|
27510
27767
|
/**
|
|
27511
|
-
* @description Gets a work item's information.
|
|
27768
|
+
* @description Gets a work item's information. **Required scopes:** Depends on the object type in the `id` field: | type | required scope | |---|---| | incident | `incident:read` OR `incident:write` OR `incident:all` | | issue | `issue:read` OR `issue:write` OR `issue:all` | | opportunity | `opportunity:read` OR `opportunity:write` OR `opportunity:all` | | task | `task:read` OR `task:write` OR `task:all` | | ticket | `ticket:read` OR `ticket:write` OR `ticket:all` |
|
|
27512
27769
|
*
|
|
27513
27770
|
* @tags works
|
|
27514
27771
|
* @name WorksGet
|
|
@@ -27525,7 +27782,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
27525
27782
|
id: string;
|
|
27526
27783
|
}, params?: RequestParams) => Promise<AxiosResponse<WorksGetResponse, any, {}>>;
|
|
27527
27784
|
/**
|
|
27528
|
-
* @description Gets a work item's information.
|
|
27785
|
+
* @description Gets a work item's information. **Required scopes:** Depends on the object type in the `id` field: | type | required scope | |---|---| | incident | `incident:read` OR `incident:write` OR `incident:all` | | issue | `issue:read` OR `issue:write` OR `issue:all` | | opportunity | `opportunity:read` OR `opportunity:write` OR `opportunity:all` | | task | `task:read` OR `task:write` OR `task:all` | | ticket | `ticket:read` OR `ticket:write` OR `ticket:all` |
|
|
27529
27786
|
*
|
|
27530
27787
|
* @tags works
|
|
27531
27788
|
* @name WorksGetPost
|
|
@@ -27535,7 +27792,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
27535
27792
|
*/
|
|
27536
27793
|
worksGetPost: (data: WorksGetRequest, params?: RequestParams) => Promise<AxiosResponse<WorksGetResponse, any, {}>>;
|
|
27537
27794
|
/**
|
|
27538
|
-
* @description Lists a collection of work items.
|
|
27795
|
+
* @description Lists a collection of work items. **Required scopes:** Depends on the object type in the `type` field: | type | required scope | |---|---| | incident | `incident:read` OR `incident:write` OR `incident:all` | | issue | `issue:read` OR `issue:write` OR `issue:all` | | opportunity | `opportunity:read` OR `opportunity:write` OR `opportunity:all` | | task | `task:read` OR `task:write` OR `task:all` | | ticket | `ticket:read` OR `ticket:write` OR `ticket:all` |
|
|
27539
27796
|
*
|
|
27540
27797
|
* @tags works
|
|
27541
27798
|
* @name WorksList
|
|
@@ -27722,7 +27979,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
27722
27979
|
vista?: string;
|
|
27723
27980
|
}, params?: RequestParams) => Promise<AxiosResponse<WorksListResponse, any, {}>>;
|
|
27724
27981
|
/**
|
|
27725
|
-
* @description Lists a collection of work items.
|
|
27982
|
+
* @description Lists a collection of work items. **Required scopes:** Depends on the object type in the `type` field: | type | required scope | |---|---| | incident | `incident:read` OR `incident:write` OR `incident:all` | | issue | `issue:read` OR `issue:write` OR `issue:all` | | opportunity | `opportunity:read` OR `opportunity:write` OR `opportunity:all` | | task | `task:read` OR `task:write` OR `task:all` | | ticket | `ticket:read` OR `ticket:write` OR `ticket:all` |
|
|
27726
27983
|
*
|
|
27727
27984
|
* @tags works
|
|
27728
27985
|
* @name WorksListPost
|
|
@@ -27732,7 +27989,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
27732
27989
|
*/
|
|
27733
27990
|
worksListPost: (data: WorksListRequest, params?: RequestParams) => Promise<AxiosResponse<WorksListResponse, any, {}>>;
|
|
27734
27991
|
/**
|
|
27735
|
-
* @description Updates a work item's information.
|
|
27992
|
+
* @description Updates a work item's information. **Required scopes:** Depends on the object type in the `id` field: | type | required scope | |---|---| | incident | `incident:write` OR `incident:all` | | issue | `issue:write` OR `issue:all` | | opportunity | `opportunity:write` OR `opportunity:all` | | task | `task:write` OR `task:all` | | ticket | `ticket:write` OR `ticket:all` |
|
|
27736
27993
|
*
|
|
27737
27994
|
* @tags works
|
|
27738
27995
|
* @name WorksUpdate
|