@devrev/typescript-sdk 1.1.51 → 1.1.53
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.
- package/README.md +106 -0
- package/dist/auto-generated/beta/beta-devrev-sdk.d.ts +346 -89
- package/dist/auto-generated/beta/beta-devrev-sdk.js +109 -51
- package/dist/auto-generated/public-devrev-sdk.d.ts +2504 -126
- package/dist/auto-generated/public-devrev-sdk.js +546 -12
- package/dist/snap-ins/beta-devrev-sdk-util.d.ts +9 -0
- package/dist/snap-ins/beta-devrev-sdk-util.js +121 -0
- package/dist/snap-ins/constants/error.d.ts +5 -0
- package/dist/snap-ins/constants/error.js +8 -0
- package/dist/snap-ins/constants/util.d.ts +12 -0
- package/dist/snap-ins/constants/util.js +16 -0
- package/dist/snap-ins/error.d.ts +1 -0
- package/dist/snap-ins/error.js +41 -0
- package/dist/snap-ins/util-types.d.ts +13 -0
- package/dist/snap-ins/util-types.js +2 -0
- package/dist/tests/beta-devrev-sdk-util.test.d.ts +1 -0
- package/dist/tests/beta-devrev-sdk-util.test.js +211 -0
- package/dist/tests/error.test.d.ts +1 -0
- package/dist/tests/error.test.js +118 -0
- package/package.json +1 -1
|
@@ -380,6 +380,8 @@ export interface AddTagWithValue {
|
|
|
380
380
|
* List of custom fields from multiple source fragments.
|
|
381
381
|
*/
|
|
382
382
|
export interface AggregatedSchema {
|
|
383
|
+
/** The conditions associated with the fields. */
|
|
384
|
+
conditions?: CustomSchemaFragmentCondition[];
|
|
383
385
|
/** The stock field overrides. */
|
|
384
386
|
stock_field_overrides?: StockFieldOverride[];
|
|
385
387
|
}
|
|
@@ -526,6 +528,8 @@ export interface AiAgentEventExecuteProgressSkillTriggered {
|
|
|
526
528
|
* @maxLength 512
|
|
527
529
|
*/
|
|
528
530
|
skill_name: string;
|
|
531
|
+
/** The thought explaining why the skill was called. */
|
|
532
|
+
thought?: string;
|
|
529
533
|
workflow?: WorkflowSummary;
|
|
530
534
|
workflow_run?: WorkflowRunSummary;
|
|
531
535
|
}
|
|
@@ -606,6 +610,8 @@ export interface AirdropSyncUnitsHistoryResponse {
|
|
|
606
610
|
export type AppFragment = CustomSchemaFragmentBase & {
|
|
607
611
|
/** App this fragment applies to. */
|
|
608
612
|
app?: string;
|
|
613
|
+
/** The display name of the app. */
|
|
614
|
+
app_display_name?: string;
|
|
609
615
|
};
|
|
610
616
|
/** app-fragment-summary */
|
|
611
617
|
export type AppFragmentSummary = CustomSchemaFragmentBaseSummary;
|
|
@@ -1151,13 +1157,39 @@ export interface ArticlesUpdateResponse {
|
|
|
1151
1157
|
article: Article;
|
|
1152
1158
|
}
|
|
1153
1159
|
/** artifact */
|
|
1154
|
-
export type Artifact = AtomBase
|
|
1160
|
+
export type Artifact = AtomBase & {
|
|
1161
|
+
/** Defines a file object. */
|
|
1162
|
+
file?: ArtifactFile;
|
|
1163
|
+
};
|
|
1164
|
+
/**
|
|
1165
|
+
* artifact-file
|
|
1166
|
+
* Defines a file object.
|
|
1167
|
+
*/
|
|
1168
|
+
export interface ArtifactFile {
|
|
1169
|
+
/** Type of the file. */
|
|
1170
|
+
type?: string;
|
|
1171
|
+
/** Name of the file. */
|
|
1172
|
+
name?: string;
|
|
1173
|
+
}
|
|
1174
|
+
/**
|
|
1175
|
+
* artifact-file-summary
|
|
1176
|
+
* Defines a file object.
|
|
1177
|
+
*/
|
|
1178
|
+
export interface ArtifactFileSummary {
|
|
1179
|
+
/** Type of the file. */
|
|
1180
|
+
type?: string;
|
|
1181
|
+
/** Name of the file. */
|
|
1182
|
+
name?: string;
|
|
1183
|
+
}
|
|
1155
1184
|
/** artifact-search-summary */
|
|
1156
1185
|
export type ArtifactSearchSummary = SearchSummaryBase & {
|
|
1157
1186
|
artifact: ArtifactSummary;
|
|
1158
1187
|
};
|
|
1159
1188
|
/** artifact-summary */
|
|
1160
|
-
export type ArtifactSummary = AtomBaseSummary
|
|
1189
|
+
export type ArtifactSummary = AtomBaseSummary & {
|
|
1190
|
+
/** Defines a file object. */
|
|
1191
|
+
file?: ArtifactFileSummary;
|
|
1192
|
+
};
|
|
1161
1193
|
/**
|
|
1162
1194
|
* artifact-version
|
|
1163
1195
|
* The version of the artifact.
|
|
@@ -2095,6 +2127,26 @@ export interface ClientContextPage {
|
|
|
2095
2127
|
/** Page URL, example: https://devrev.ai/pricing */
|
|
2096
2128
|
url?: string;
|
|
2097
2129
|
}
|
|
2130
|
+
/**
|
|
2131
|
+
* client-override
|
|
2132
|
+
* UI hint overrides for a client.
|
|
2133
|
+
*/
|
|
2134
|
+
export interface ClientOverride {
|
|
2135
|
+
/** The name of the client. */
|
|
2136
|
+
client_name?: string;
|
|
2137
|
+
/** The display name of the field. */
|
|
2138
|
+
display_name?: string;
|
|
2139
|
+
/** Whether the field is hidden in the UI. */
|
|
2140
|
+
is_hidden?: boolean;
|
|
2141
|
+
/** Whether the field is mandatory. */
|
|
2142
|
+
is_required?: boolean;
|
|
2143
|
+
/** A placeholder for the field. */
|
|
2144
|
+
placeholder?: string;
|
|
2145
|
+
/** Tooltip for the field. */
|
|
2146
|
+
tooltip?: string;
|
|
2147
|
+
/** The view overrides for the client. */
|
|
2148
|
+
view_overrides?: ViewOverride[];
|
|
2149
|
+
}
|
|
2098
2150
|
/** code-change */
|
|
2099
2151
|
export type CodeChange = AtomBase & {
|
|
2100
2152
|
/** Name of the code branch in the repo. */
|
|
@@ -2716,6 +2768,8 @@ export interface ConversationsExportRequest {
|
|
|
2716
2768
|
group?: string[];
|
|
2717
2769
|
/** Filters for conversations that are created by verified users. */
|
|
2718
2770
|
is_creator_verified?: boolean;
|
|
2771
|
+
/** Filters for conversations that are frozen. */
|
|
2772
|
+
is_frozen?: boolean;
|
|
2719
2773
|
/** Filters for conversations that are spam. */
|
|
2720
2774
|
is_spam?: boolean;
|
|
2721
2775
|
/**
|
|
@@ -2805,6 +2859,8 @@ export interface ConversationsListRequest {
|
|
|
2805
2859
|
group?: string[];
|
|
2806
2860
|
/** Filters for conversations that are created by verified users. */
|
|
2807
2861
|
is_creator_verified?: boolean;
|
|
2862
|
+
/** Filters for conversations that are frozen. */
|
|
2863
|
+
is_frozen?: boolean;
|
|
2808
2864
|
/** Filters for conversations that are spam. */
|
|
2809
2865
|
is_spam?: boolean;
|
|
2810
2866
|
/**
|
|
@@ -2906,6 +2962,8 @@ export interface ConversationsUpdateRequest {
|
|
|
2906
2962
|
group?: string;
|
|
2907
2963
|
/** The ID of the conversation to update. */
|
|
2908
2964
|
id: string;
|
|
2965
|
+
/** Whether the conversation is frozen. */
|
|
2966
|
+
is_frozen?: boolean;
|
|
2909
2967
|
/** Whether the conversation is spam. */
|
|
2910
2968
|
is_spam?: boolean;
|
|
2911
2969
|
members?: ConversationsUpdateRequestMembers;
|
|
@@ -3467,7 +3525,39 @@ export type CustomSchemaFragmentBaseSummary = AtomBaseSummary;
|
|
|
3467
3525
|
* custom-schema-fragment-condition
|
|
3468
3526
|
* The condition associated with a field.
|
|
3469
3527
|
*/
|
|
3470
|
-
export
|
|
3528
|
+
export interface CustomSchemaFragmentCondition {
|
|
3529
|
+
/** The linked effects when the expression evaluates to true. */
|
|
3530
|
+
effects?: CustomSchemaFragmentEffect[];
|
|
3531
|
+
/** The expression to evaluate. */
|
|
3532
|
+
expression?: string;
|
|
3533
|
+
}
|
|
3534
|
+
/**
|
|
3535
|
+
* custom-schema-fragment-effect
|
|
3536
|
+
* An effect associated with a condition.
|
|
3537
|
+
*/
|
|
3538
|
+
export interface CustomSchemaFragmentEffect {
|
|
3539
|
+
/**
|
|
3540
|
+
* Allowed values for the fields based on the condition. This takes
|
|
3541
|
+
* precedence over allowed_values in field_descriptor.
|
|
3542
|
+
*/
|
|
3543
|
+
allowed_values?: string[];
|
|
3544
|
+
/** The fields which are affected by the condition. */
|
|
3545
|
+
fields: string[];
|
|
3546
|
+
/**
|
|
3547
|
+
* Whether the fields should be made immutable or not based on the
|
|
3548
|
+
* condition.
|
|
3549
|
+
*/
|
|
3550
|
+
immutable?: boolean;
|
|
3551
|
+
/** Whether the field values are invalid based on the condition. */
|
|
3552
|
+
invalid?: boolean;
|
|
3553
|
+
/**
|
|
3554
|
+
* Whether the fields are required or not based on the condition. This
|
|
3555
|
+
* takes precedence over is_required in field_descriptor.
|
|
3556
|
+
*/
|
|
3557
|
+
require?: boolean;
|
|
3558
|
+
/** Whether the fields are shown or not based on the condition. */
|
|
3559
|
+
show?: boolean;
|
|
3560
|
+
}
|
|
3471
3561
|
/** Type of the custom schema fragment. */
|
|
3472
3562
|
export declare enum CustomSchemaFragmentFragmentType {
|
|
3473
3563
|
App = "app",
|
|
@@ -3574,6 +3664,8 @@ export type CustomSchemaFragmentsSetRequest = (CustomSchemaFragmentsSetRequestAp
|
|
|
3574
3664
|
export interface CustomSchemaFragmentsSetRequestAppFragment {
|
|
3575
3665
|
/** The app this fragment applies to. */
|
|
3576
3666
|
app: string;
|
|
3667
|
+
/** The display name of the app. */
|
|
3668
|
+
app_display_name?: string;
|
|
3577
3669
|
}
|
|
3578
3670
|
/** custom-schema-fragments-set-request-composite-schema */
|
|
3579
3671
|
export interface CustomSchemaFragmentsSetRequestCompositeSchema {
|
|
@@ -3637,7 +3729,7 @@ export interface CustomSchemaSpec {
|
|
|
3637
3729
|
}
|
|
3638
3730
|
/** custom-stage */
|
|
3639
3731
|
export type CustomStage = AtomBase & {
|
|
3640
|
-
/** The human readable name of the
|
|
3732
|
+
/** The human readable name of the stage. */
|
|
3641
3733
|
name?: string;
|
|
3642
3734
|
/**
|
|
3643
3735
|
* Ordinal used to sort/group stages.
|
|
@@ -3648,7 +3740,7 @@ export type CustomStage = AtomBase & {
|
|
|
3648
3740
|
};
|
|
3649
3741
|
/** custom-stage-summary */
|
|
3650
3742
|
export type CustomStageSummary = AtomBaseSummary & {
|
|
3651
|
-
/** The human readable name of the
|
|
3743
|
+
/** The human readable name of the stage. */
|
|
3652
3744
|
name?: string;
|
|
3653
3745
|
};
|
|
3654
3746
|
/** custom-stages-create-request */
|
|
@@ -3931,6 +4023,11 @@ export interface DeleteRevUsersPersonalDataRequest {
|
|
|
3931
4023
|
* notified.
|
|
3932
4024
|
*/
|
|
3933
4025
|
export type DeleteRevUsersPersonalDataResponse = object;
|
|
4026
|
+
/** dev-org */
|
|
4027
|
+
export type DevOrg = OrgBase & {
|
|
4028
|
+
/** Customer chosen URL slug for the DevOrg. */
|
|
4029
|
+
dev_slug: string;
|
|
4030
|
+
};
|
|
3934
4031
|
/**
|
|
3935
4032
|
* dev-org-auth-connections-create-request
|
|
3936
4033
|
* Request to create a new enterprise authentication connection.
|
|
@@ -4215,6 +4312,18 @@ export interface DevOrgAuthConnectionsUpdateResponse {
|
|
|
4215
4312
|
*/
|
|
4216
4313
|
auth_connection: AuthConnection;
|
|
4217
4314
|
}
|
|
4315
|
+
/**
|
|
4316
|
+
* dev-orgs-get-request
|
|
4317
|
+
* A request to get a Dev organization's information.
|
|
4318
|
+
*/
|
|
4319
|
+
export type DevOrgsGetRequest = object;
|
|
4320
|
+
/**
|
|
4321
|
+
* dev-orgs-get-response
|
|
4322
|
+
* The response to get a Dev organization's information.
|
|
4323
|
+
*/
|
|
4324
|
+
export interface DevOrgsGetResponse {
|
|
4325
|
+
dev_org: DevOrg;
|
|
4326
|
+
}
|
|
4218
4327
|
/** dev-user */
|
|
4219
4328
|
export type DevUser = UserBase & {
|
|
4220
4329
|
/** Custom fields. */
|
|
@@ -4698,10 +4807,10 @@ export interface DirectoriesUpdateRequest {
|
|
|
4698
4807
|
reorder?: DirectoriesUpdateRequestReorder;
|
|
4699
4808
|
tags?: DirectoriesUpdateRequestTags;
|
|
4700
4809
|
/**
|
|
4701
|
-
*
|
|
4810
|
+
* The updated thumbnail for the directory.
|
|
4702
4811
|
* @example "ARTIFACT-12345"
|
|
4703
4812
|
*/
|
|
4704
|
-
thumbnail?: string;
|
|
4813
|
+
thumbnail?: string | null;
|
|
4705
4814
|
/** The updated title for the directory. */
|
|
4706
4815
|
title?: string;
|
|
4707
4816
|
}
|
|
@@ -6335,8 +6444,6 @@ export type Incident = AtomBase & {
|
|
|
6335
6444
|
identified_date?: string;
|
|
6336
6445
|
/** Details of the impact due to the incident. */
|
|
6337
6446
|
impact?: ImpactedCustomerDetails;
|
|
6338
|
-
/** List of customers impacted due to the incident. */
|
|
6339
|
-
impacted_customers?: AccountSummary[];
|
|
6340
6447
|
/**
|
|
6341
6448
|
* Timestamp when the incident was mitigated.
|
|
6342
6449
|
* @format date-time
|
|
@@ -6357,11 +6464,6 @@ export type Incident = AtomBase & {
|
|
|
6357
6464
|
source?: EnumValue;
|
|
6358
6465
|
/** Describes the current stage of a object. */
|
|
6359
6466
|
stage?: Stage;
|
|
6360
|
-
/**
|
|
6361
|
-
* Users, along with the incident commander, involved in resolving
|
|
6362
|
-
* incidents and handling communication.
|
|
6363
|
-
*/
|
|
6364
|
-
stakeholders?: UserSummary[];
|
|
6365
6467
|
/**
|
|
6366
6468
|
* Stock schema fragment.
|
|
6367
6469
|
* @example "don:core:dvrv-us-1:devo/example:custom_type_fragment/custom-type-fragment-id"
|
|
@@ -6425,8 +6527,6 @@ export interface IncidentsCreateRequest {
|
|
|
6425
6527
|
*/
|
|
6426
6528
|
identified_date?: string;
|
|
6427
6529
|
impact?: CreateImpactedCustomerDetails;
|
|
6428
|
-
/** List of customers impacted due to the incident. */
|
|
6429
|
-
impacted_customers?: string[];
|
|
6430
6530
|
/**
|
|
6431
6531
|
* Timestamp when the incident was mitigated.
|
|
6432
6532
|
* @format date-time
|
|
@@ -6459,11 +6559,8 @@ export interface IncidentsCreateRequest {
|
|
|
6459
6559
|
source?: number;
|
|
6460
6560
|
/** Create object for stage. */
|
|
6461
6561
|
stage?: CreateStage;
|
|
6462
|
-
/**
|
|
6463
|
-
|
|
6464
|
-
* incidents and handling communication.
|
|
6465
|
-
*/
|
|
6466
|
-
stakeholders?: string[];
|
|
6562
|
+
/** The type of stage validations options when creating an incident. */
|
|
6563
|
+
stage_validation_options?: StageValidationOptionForCreate[];
|
|
6467
6564
|
/** Tags associated with the object. */
|
|
6468
6565
|
tags?: CreateTagWithValue[];
|
|
6469
6566
|
/**
|
|
@@ -6737,7 +6834,6 @@ export interface IncidentsUpdateRequest {
|
|
|
6737
6834
|
*/
|
|
6738
6835
|
identified_date?: string;
|
|
6739
6836
|
impact?: UpdateImpactedCustomerDetails;
|
|
6740
|
-
impacted_customers?: UpdateIncidentImpactedCustomers;
|
|
6741
6837
|
/**
|
|
6742
6838
|
* Timestamp when the incident was mitigated.
|
|
6743
6839
|
* @format date-time
|
|
@@ -6766,7 +6862,11 @@ export interface IncidentsUpdateRequest {
|
|
|
6766
6862
|
source?: number;
|
|
6767
6863
|
/** Update object for Stage. */
|
|
6768
6864
|
stage?: UpdateStage;
|
|
6769
|
-
|
|
6865
|
+
/**
|
|
6866
|
+
* The type of stage validations options when updating the stage of an
|
|
6867
|
+
* incident.
|
|
6868
|
+
*/
|
|
6869
|
+
stage_validation_options?: StageValidationOptionForUpdate[];
|
|
6770
6870
|
tags?: UpdateIncidentTags;
|
|
6771
6871
|
/**
|
|
6772
6872
|
* Timestamp when the incident is expected to be resolved.
|
|
@@ -8581,8 +8681,12 @@ export type ProductSummary = PartBaseSummary;
|
|
|
8581
8681
|
export type QuestionAnswer = AtomBase & {
|
|
8582
8682
|
/** The Answer. */
|
|
8583
8683
|
answer?: string;
|
|
8684
|
+
/** Details of the parts relevant to the question_answer. */
|
|
8685
|
+
applies_to_parts?: PartSummary[];
|
|
8584
8686
|
/** The Question. */
|
|
8585
8687
|
question?: string;
|
|
8688
|
+
/** Status of the question answer. */
|
|
8689
|
+
status?: QuestionAnswerStatus;
|
|
8586
8690
|
/** An alternative answer suggested by the Q/A generation algorithm. */
|
|
8587
8691
|
suggested_answer?: string;
|
|
8588
8692
|
/**
|
|
@@ -9335,6 +9439,11 @@ export interface RevUsersCreateRequest {
|
|
|
9335
9439
|
description?: string;
|
|
9336
9440
|
/** The user's display name. The name is non-unique and mutable. */
|
|
9337
9441
|
display_name?: string;
|
|
9442
|
+
/**
|
|
9443
|
+
* Artifact ID of a Rev user's display picture.
|
|
9444
|
+
* @example "ARTIFACT-12345"
|
|
9445
|
+
*/
|
|
9446
|
+
display_picture?: string;
|
|
9338
9447
|
/** Email address of the Rev user. */
|
|
9339
9448
|
email?: string;
|
|
9340
9449
|
/**
|
|
@@ -9552,6 +9661,11 @@ export interface RevUsersUpdateRequest {
|
|
|
9552
9661
|
description?: string;
|
|
9553
9662
|
/** Updated display name of the Rev user. */
|
|
9554
9663
|
display_name?: string;
|
|
9664
|
+
/**
|
|
9665
|
+
* Artifact ID of a Rev user's updated display picture.
|
|
9666
|
+
* @example "ARTIFACT-12345"
|
|
9667
|
+
*/
|
|
9668
|
+
display_picture?: string | null;
|
|
9555
9669
|
/** Updated email address of the Rev user. */
|
|
9556
9670
|
email?: string;
|
|
9557
9671
|
/** Updated external ref value of the Rev user. */
|
|
@@ -9751,11 +9865,11 @@ export interface SchemaFieldCreateViewUiMetadata {
|
|
|
9751
9865
|
* schema-field-descriptor
|
|
9752
9866
|
* Set of field attributes.
|
|
9753
9867
|
*/
|
|
9754
|
-
export type SchemaFieldDescriptor = (SchemaBoolFieldDescriptor | SchemaCompositeFieldDescriptor | SchemaDateFieldDescriptor | SchemaDoubleFieldDescriptor | SchemaEnumFieldDescriptor | SchemaFieldDescriptorArrayType | SchemaIdFieldDescriptor | SchemaIntFieldDescriptor | SchemaRichTextFieldDescriptor | SchemaStructFieldDescriptor | SchemaTextFieldDescriptor | SchemaTimestampFieldDescriptor | SchemaTokensFieldDescriptor | SchemaUenumFieldDescriptor | SchemaUnknownFieldDescriptor) & {
|
|
9868
|
+
export type SchemaFieldDescriptor = (SchemaBoolFieldDescriptor | SchemaCompositeFieldDescriptor | SchemaDateFieldDescriptor | SchemaDoubleFieldDescriptor | SchemaEnumFieldDescriptor | SchemaFieldDescriptorArrayType | SchemaIdFieldDescriptor | SchemaIntFieldDescriptor | SchemaJsonValueFieldDescriptor | SchemaRichTextFieldDescriptor | SchemaStructFieldDescriptor | SchemaTextFieldDescriptor | SchemaTimestampFieldDescriptor | SchemaTokensFieldDescriptor | SchemaUenumFieldDescriptor | SchemaUnknownFieldDescriptor) & {
|
|
9755
9869
|
field_type: SchemaFieldDescriptorFieldType;
|
|
9756
9870
|
};
|
|
9757
9871
|
/** schema-field-descriptor-array-type */
|
|
9758
|
-
export type SchemaFieldDescriptorArrayType = (SchemaBoolListFieldDescriptor | SchemaCompositeListFieldDescriptor | SchemaDateListFieldDescriptor | SchemaDoubleListFieldDescriptor | SchemaEnumListFieldDescriptor | SchemaIdListFieldDescriptor | SchemaIntListFieldDescriptor | SchemaRichTextListFieldDescriptor | SchemaStructListFieldDescriptor | SchemaTextListFieldDescriptor | SchemaTimestampListFieldDescriptor | SchemaTokensListFieldDescriptor | SchemaUenumListFieldDescriptor) & {
|
|
9872
|
+
export type SchemaFieldDescriptorArrayType = (SchemaBoolListFieldDescriptor | SchemaCompositeListFieldDescriptor | SchemaDateListFieldDescriptor | SchemaDoubleListFieldDescriptor | SchemaEnumListFieldDescriptor | SchemaIdListFieldDescriptor | SchemaIntListFieldDescriptor | SchemaJsonValueListFieldDescriptor | SchemaRichTextListFieldDescriptor | SchemaStructListFieldDescriptor | SchemaTextListFieldDescriptor | SchemaTimestampListFieldDescriptor | SchemaTokensListFieldDescriptor | SchemaUenumListFieldDescriptor) & {
|
|
9759
9873
|
base_type: SchemaFieldDescriptorArrayTypeBaseType;
|
|
9760
9874
|
/**
|
|
9761
9875
|
* The exact array length.
|
|
@@ -9781,6 +9895,7 @@ export declare enum SchemaFieldDescriptorArrayTypeBaseType {
|
|
|
9781
9895
|
Enum = "enum",
|
|
9782
9896
|
Id = "id",
|
|
9783
9897
|
Int = "int",
|
|
9898
|
+
JsonValue = "json_value",
|
|
9784
9899
|
RichText = "rich_text",
|
|
9785
9900
|
Struct = "struct",
|
|
9786
9901
|
Text = "text",
|
|
@@ -9823,6 +9938,7 @@ export declare enum SchemaFieldDescriptorFieldType {
|
|
|
9823
9938
|
Enum = "enum",
|
|
9824
9939
|
Id = "id",
|
|
9825
9940
|
Int = "int",
|
|
9941
|
+
JsonValue = "json_value",
|
|
9826
9942
|
RichText = "rich_text",
|
|
9827
9943
|
Struct = "struct",
|
|
9828
9944
|
Text = "text",
|
|
@@ -9900,6 +10016,8 @@ export interface SchemaFieldUenumValue {
|
|
|
9900
10016
|
* The schema of ui specific fields.
|
|
9901
10017
|
*/
|
|
9902
10018
|
export interface SchemaFieldUiMetadata {
|
|
10019
|
+
/** The client overrides for the field. */
|
|
10020
|
+
client_overrides?: ClientOverride[];
|
|
9903
10021
|
/** Create view UI hint overrides. */
|
|
9904
10022
|
create_view?: SchemaFieldCreateViewUiMetadata;
|
|
9905
10023
|
/** Detail view UI hint overrides. */
|
|
@@ -10013,6 +10131,16 @@ export type SchemaIntListFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
|
10013
10131
|
*/
|
|
10014
10132
|
lte?: number;
|
|
10015
10133
|
};
|
|
10134
|
+
/** schema-json-value-field-descriptor */
|
|
10135
|
+
export type SchemaJsonValueFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
10136
|
+
/** Default value. */
|
|
10137
|
+
default_value?: any;
|
|
10138
|
+
};
|
|
10139
|
+
/** schema-json-value-list-field-descriptor */
|
|
10140
|
+
export type SchemaJsonValueListFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
10141
|
+
/** Default value. */
|
|
10142
|
+
default_value?: any[];
|
|
10143
|
+
};
|
|
10016
10144
|
/** schema-rich-text-field-descriptor */
|
|
10017
10145
|
export type SchemaRichTextFieldDescriptor = SchemaFieldDescriptorBase & {
|
|
10018
10146
|
/** The contained substring. */
|
|
@@ -10329,14 +10457,39 @@ export interface SearchCoreResponse {
|
|
|
10329
10457
|
}
|
|
10330
10458
|
/** The namespaces for hybrid search. */
|
|
10331
10459
|
export declare enum SearchHybridNamespace {
|
|
10460
|
+
Account = "account",
|
|
10332
10461
|
Article = "article",
|
|
10462
|
+
Capability = "capability",
|
|
10463
|
+
Component = "component",
|
|
10333
10464
|
Conversation = "conversation",
|
|
10465
|
+
CustomObject = "custom_object",
|
|
10466
|
+
CustomPart = "custom_part",
|
|
10467
|
+
CustomWork = "custom_work",
|
|
10468
|
+
Dashboard = "dashboard",
|
|
10334
10469
|
Dataset = "dataset",
|
|
10470
|
+
DevUser = "dev_user",
|
|
10471
|
+
Enhancement = "enhancement",
|
|
10472
|
+
Feature = "feature",
|
|
10473
|
+
Group = "group",
|
|
10335
10474
|
Incident = "incident",
|
|
10336
10475
|
Issue = "issue",
|
|
10476
|
+
Linkable = "linkable",
|
|
10477
|
+
Microservice = "microservice",
|
|
10478
|
+
ObjectMember = "object_member",
|
|
10479
|
+
Opportunity = "opportunity",
|
|
10337
10480
|
Part = "part",
|
|
10481
|
+
Product = "product",
|
|
10482
|
+
Project = "project",
|
|
10338
10483
|
QuestionAnswer = "question_answer",
|
|
10484
|
+
RevOrg = "rev_org",
|
|
10485
|
+
RevUser = "rev_user",
|
|
10486
|
+
Runnable = "runnable",
|
|
10487
|
+
ServiceAccount = "service_account",
|
|
10488
|
+
SysUser = "sys_user",
|
|
10489
|
+
Tag = "tag",
|
|
10490
|
+
Task = "task",
|
|
10339
10491
|
Ticket = "ticket",
|
|
10492
|
+
Vista = "vista",
|
|
10340
10493
|
Widget = "widget",
|
|
10341
10494
|
Work = "work"
|
|
10342
10495
|
}
|
|
@@ -11142,12 +11295,21 @@ export interface SnapInsUpdateRequest {
|
|
|
11142
11295
|
export interface SnapInsUpdateResponse {
|
|
11143
11296
|
snap_in: SnapIn;
|
|
11144
11297
|
}
|
|
11298
|
+
/**
|
|
11299
|
+
* snap-kit-base-widget
|
|
11300
|
+
* A SnapKit based widget.
|
|
11301
|
+
*/
|
|
11302
|
+
export interface SnapKitBaseWidget {
|
|
11303
|
+
snap_kit_execution?: string;
|
|
11304
|
+
}
|
|
11145
11305
|
/** snap-widget */
|
|
11146
11306
|
export type SnapWidget = EmailPreviewWidget & {
|
|
11147
11307
|
type: SnapWidgetType;
|
|
11148
11308
|
};
|
|
11149
11309
|
/** snap-widget-base */
|
|
11150
11310
|
export type SnapWidgetBase = AtomBase & {
|
|
11311
|
+
/** A list of interactions supported by the widget. */
|
|
11312
|
+
interactions?: SnapWidgetInteraction[];
|
|
11151
11313
|
/** A human readable name for the snap widget. */
|
|
11152
11314
|
name: string;
|
|
11153
11315
|
/** Logical grouping of snap widgets. Useful for filtering. */
|
|
@@ -11155,6 +11317,34 @@ export type SnapWidgetBase = AtomBase & {
|
|
|
11155
11317
|
/** The status of the snap widget. */
|
|
11156
11318
|
status: SnapWidgetStatus;
|
|
11157
11319
|
};
|
|
11320
|
+
/**
|
|
11321
|
+
* snap-widget-click-interaction
|
|
11322
|
+
* An interaction supported by a widget.
|
|
11323
|
+
*/
|
|
11324
|
+
export type SnapWidgetClickInteraction = (SnapWidgetOpenPlugWidgetAction | SnapWidgetOpenUrlAction | SnapWidgetStartConversationAction) & {
|
|
11325
|
+
click_action: SnapWidgetClickInteractionClickAction;
|
|
11326
|
+
};
|
|
11327
|
+
export declare enum SnapWidgetClickInteractionClickAction {
|
|
11328
|
+
OpenPlugWidget = "open_plug_widget",
|
|
11329
|
+
OpenUrl = "open_url",
|
|
11330
|
+
StartConversation = "start_conversation"
|
|
11331
|
+
}
|
|
11332
|
+
/**
|
|
11333
|
+
* snap-widget-email-input-interaction
|
|
11334
|
+
* An interaction supported by a widget.
|
|
11335
|
+
*/
|
|
11336
|
+
export type SnapWidgetEmailInputInteraction = object;
|
|
11337
|
+
/**
|
|
11338
|
+
* snap-widget-interaction
|
|
11339
|
+
* An interaction supported by a widget.
|
|
11340
|
+
*/
|
|
11341
|
+
export type SnapWidgetInteraction = (SnapWidgetClickInteraction | SnapWidgetEmailInputInteraction) & {
|
|
11342
|
+
type: SnapWidgetInteractionType;
|
|
11343
|
+
};
|
|
11344
|
+
export declare enum SnapWidgetInteractionType {
|
|
11345
|
+
Click = "click",
|
|
11346
|
+
EmailInput = "email_input"
|
|
11347
|
+
}
|
|
11158
11348
|
/** Logical grouping of snap widgets. Useful for filtering. */
|
|
11159
11349
|
export declare enum SnapWidgetNamespace {
|
|
11160
11350
|
AiAssistantMessage = "ai_assistant_message",
|
|
@@ -11164,6 +11354,32 @@ export declare enum SnapWidgetNamespace {
|
|
|
11164
11354
|
MeetingPreview = "meeting_preview",
|
|
11165
11355
|
PlugNudge = "plug_nudge"
|
|
11166
11356
|
}
|
|
11357
|
+
/**
|
|
11358
|
+
* snap-widget-open-plug-widget-action
|
|
11359
|
+
* Details of open plug widget action.
|
|
11360
|
+
*/
|
|
11361
|
+
export type SnapWidgetOpenPlugWidgetAction = object;
|
|
11362
|
+
/**
|
|
11363
|
+
* snap-widget-open-url-action
|
|
11364
|
+
* Details of open url widget action.
|
|
11365
|
+
*/
|
|
11366
|
+
export interface SnapWidgetOpenUrlAction {
|
|
11367
|
+
/** The url to open when the widget is clicked. */
|
|
11368
|
+
url: string;
|
|
11369
|
+
}
|
|
11370
|
+
/**
|
|
11371
|
+
* snap-widget-start-conversation-action
|
|
11372
|
+
* Details of start conversation action.
|
|
11373
|
+
*/
|
|
11374
|
+
export interface SnapWidgetStartConversationAction {
|
|
11375
|
+
/**
|
|
11376
|
+
* Whether the rich text editor is enabled on the object. Default is
|
|
11377
|
+
* false.
|
|
11378
|
+
*/
|
|
11379
|
+
rte_enabled?: boolean;
|
|
11380
|
+
/** A SnapKit based widget. */
|
|
11381
|
+
starter_message?: SnapKitBaseWidget;
|
|
11382
|
+
}
|
|
11167
11383
|
/** The status of the snap widget. */
|
|
11168
11384
|
export declare enum SnapWidgetStatus {
|
|
11169
11385
|
Draft = "draft",
|
|
@@ -11661,6 +11877,8 @@ export interface SurveysResponsesListRequest {
|
|
|
11661
11877
|
* iteration starts from the beginning.
|
|
11662
11878
|
*/
|
|
11663
11879
|
cursor?: string;
|
|
11880
|
+
/** Filters for survey responses associated with these unique IDs. */
|
|
11881
|
+
dispatch_ids?: string[];
|
|
11664
11882
|
/**
|
|
11665
11883
|
* The maximum number of survey responses to return. If not set, then
|
|
11666
11884
|
* the default is '50'.
|
|
@@ -12335,6 +12553,8 @@ export type Ticket = WorkBase & {
|
|
|
12335
12553
|
sla_tracker?: SlaTrackerSummary;
|
|
12336
12554
|
/** Source channel of the ticket. */
|
|
12337
12555
|
source_channel?: string;
|
|
12556
|
+
/** The properties of an enum value. */
|
|
12557
|
+
visibility?: EnumValue;
|
|
12338
12558
|
};
|
|
12339
12559
|
/** Channels of the ticket. */
|
|
12340
12560
|
export declare enum TicketChannels {
|
|
@@ -13310,11 +13530,6 @@ export interface UpdateIncidentArtifacts {
|
|
|
13310
13530
|
*/
|
|
13311
13531
|
set?: string[];
|
|
13312
13532
|
}
|
|
13313
|
-
/** update-incident-impacted-customers */
|
|
13314
|
-
export interface UpdateIncidentImpactedCustomers {
|
|
13315
|
-
/** Sets the list of customers impacted due to the incident. */
|
|
13316
|
-
set?: string[];
|
|
13317
|
-
}
|
|
13318
13533
|
/** update-incident-owned-by */
|
|
13319
13534
|
export interface UpdateIncidentOwnedBy {
|
|
13320
13535
|
/** Sets the user IDs of the users that own the incident. */
|
|
@@ -13344,14 +13559,6 @@ export interface UpdateIncidentRelatedDocs {
|
|
|
13344
13559
|
*/
|
|
13345
13560
|
set?: string[];
|
|
13346
13561
|
}
|
|
13347
|
-
/** update-incident-stakeholders */
|
|
13348
|
-
export interface UpdateIncidentStakeholders {
|
|
13349
|
-
/**
|
|
13350
|
-
* Sets the users, along with the incident commander, involved in
|
|
13351
|
-
* resolving incidents and handling communication.
|
|
13352
|
-
*/
|
|
13353
|
-
set?: string[];
|
|
13354
|
-
}
|
|
13355
13562
|
/** update-incident-tags */
|
|
13356
13563
|
export interface UpdateIncidentTags {
|
|
13357
13564
|
/** Sets the tags associated with the object. */
|
|
@@ -13478,6 +13685,24 @@ export declare enum UserType {
|
|
|
13478
13685
|
ServiceAccount = "service_account",
|
|
13479
13686
|
SysUser = "sys_user"
|
|
13480
13687
|
}
|
|
13688
|
+
/**
|
|
13689
|
+
* view-override
|
|
13690
|
+
* UI hint overrides for a view.
|
|
13691
|
+
*/
|
|
13692
|
+
export interface ViewOverride {
|
|
13693
|
+
/** The display name of the field. */
|
|
13694
|
+
display_name?: string;
|
|
13695
|
+
/** Whether the field is hidden in the UI. */
|
|
13696
|
+
is_hidden?: boolean;
|
|
13697
|
+
/** Whether the field is mandatory. */
|
|
13698
|
+
is_required?: boolean;
|
|
13699
|
+
/** A placeholder for the field. */
|
|
13700
|
+
placeholder?: string;
|
|
13701
|
+
/** Tooltip for the field. */
|
|
13702
|
+
tooltip?: string;
|
|
13703
|
+
/** The name of the view. */
|
|
13704
|
+
view_name?: string;
|
|
13705
|
+
}
|
|
13481
13706
|
/** vista-base-summary */
|
|
13482
13707
|
export type VistaBaseSummary = AtomBaseSummary & {
|
|
13483
13708
|
/** Name of the vista. */
|
|
@@ -14019,7 +14244,10 @@ export type WorksCreateRequest = (WorksCreateRequestIssue | WorksCreateRequestOp
|
|
|
14019
14244
|
* @example ["ARTIFACT-12345"]
|
|
14020
14245
|
*/
|
|
14021
14246
|
artifacts?: string[];
|
|
14022
|
-
/**
|
|
14247
|
+
/**
|
|
14248
|
+
* Body of the work object.
|
|
14249
|
+
* @maxLength 65536
|
|
14250
|
+
*/
|
|
14023
14251
|
body?: string;
|
|
14024
14252
|
/** Custom fields. */
|
|
14025
14253
|
custom_fields?: object;
|
|
@@ -14415,7 +14643,10 @@ export type WorksUpdateRequest = (Empty | WorksUpdateRequestIssue | WorksUpdateR
|
|
|
14415
14643
|
*/
|
|
14416
14644
|
applies_to_part?: string;
|
|
14417
14645
|
artifacts?: WorksUpdateRequestArtifacts;
|
|
14418
|
-
/**
|
|
14646
|
+
/**
|
|
14647
|
+
* Updated body of the work object, or unchanged if not provided.
|
|
14648
|
+
* @maxLength 65536
|
|
14649
|
+
*/
|
|
14419
14650
|
body?: string;
|
|
14420
14651
|
/** Custom fields. */
|
|
14421
14652
|
custom_fields?: object;
|
|
@@ -15522,7 +15753,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
15522
15753
|
/**
|
|
15523
15754
|
* @description Creates a command.
|
|
15524
15755
|
*
|
|
15525
|
-
* @tags
|
|
15756
|
+
* @tags commands
|
|
15526
15757
|
* @name CommandsCreate
|
|
15527
15758
|
* @summary Create Command
|
|
15528
15759
|
* @request POST:/commands.create
|
|
@@ -15532,7 +15763,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
15532
15763
|
/**
|
|
15533
15764
|
* @description Gets a command.
|
|
15534
15765
|
*
|
|
15535
|
-
* @tags
|
|
15766
|
+
* @tags commands
|
|
15536
15767
|
* @name CommandsGet
|
|
15537
15768
|
* @summary Get Command
|
|
15538
15769
|
* @request GET:/commands.get
|
|
@@ -15545,7 +15776,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
15545
15776
|
/**
|
|
15546
15777
|
* @description Gets a command.
|
|
15547
15778
|
*
|
|
15548
|
-
* @tags
|
|
15779
|
+
* @tags commands
|
|
15549
15780
|
* @name CommandsGetPost
|
|
15550
15781
|
* @summary Get Command (POST)
|
|
15551
15782
|
* @request POST:/commands.get
|
|
@@ -15555,7 +15786,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
15555
15786
|
/**
|
|
15556
15787
|
* @description Lists commands for a Dev organization.
|
|
15557
15788
|
*
|
|
15558
|
-
* @tags
|
|
15789
|
+
* @tags commands
|
|
15559
15790
|
* @name CommandsList
|
|
15560
15791
|
* @summary List Commands
|
|
15561
15792
|
* @request GET:/commands.list
|
|
@@ -15592,7 +15823,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
15592
15823
|
/**
|
|
15593
15824
|
* @description Lists commands for a Dev organization.
|
|
15594
15825
|
*
|
|
15595
|
-
* @tags
|
|
15826
|
+
* @tags commands
|
|
15596
15827
|
* @name CommandsListPost
|
|
15597
15828
|
* @summary List Commands (POST)
|
|
15598
15829
|
* @request POST:/commands.list
|
|
@@ -15602,7 +15833,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
15602
15833
|
/**
|
|
15603
15834
|
* @description Updates a command.
|
|
15604
15835
|
*
|
|
15605
|
-
* @tags
|
|
15836
|
+
* @tags commands
|
|
15606
15837
|
* @name CommandsUpdate
|
|
15607
15838
|
* @summary Update Command
|
|
15608
15839
|
* @request POST:/commands.update
|
|
@@ -15740,6 +15971,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
15740
15971
|
group?: string[];
|
|
15741
15972
|
/** Filters for conversations that are created by verified users. */
|
|
15742
15973
|
is_creator_verified?: boolean;
|
|
15974
|
+
/** Filters for conversations that are frozen. */
|
|
15975
|
+
is_frozen?: boolean;
|
|
15743
15976
|
/** Filters for conversations that are spam. */
|
|
15744
15977
|
is_spam?: boolean;
|
|
15745
15978
|
/**
|
|
@@ -15867,6 +16100,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
15867
16100
|
group?: string[];
|
|
15868
16101
|
/** Filters for conversations that are created by verified users. */
|
|
15869
16102
|
is_creator_verified?: boolean;
|
|
16103
|
+
/** Filters for conversations that are frozen. */
|
|
16104
|
+
is_frozen?: boolean;
|
|
15870
16105
|
/** Filters for conversations that are spam. */
|
|
15871
16106
|
is_spam?: boolean;
|
|
15872
16107
|
/**
|
|
@@ -16088,7 +16323,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
16088
16323
|
/**
|
|
16089
16324
|
* @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. Keep in mind that at a time, only one authentication connection can be enabled for a Dev organization. At present, only 5 enterprise connections can be created by an organization.
|
|
16090
16325
|
*
|
|
16091
|
-
* @tags auth-
|
|
16326
|
+
* @tags auth-connections, dev-orgs
|
|
16092
16327
|
* @name DevOrgAuthConnectionsCreate
|
|
16093
16328
|
* @summary Create Dev Orgs Auth Connection
|
|
16094
16329
|
* @request POST:/dev-orgs.auth-connections.create
|
|
@@ -16098,7 +16333,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
16098
16333
|
/**
|
|
16099
16334
|
* @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.
|
|
16100
16335
|
*
|
|
16101
|
-
* @tags auth-
|
|
16336
|
+
* @tags auth-connections, dev-orgs
|
|
16102
16337
|
* @name DevOrgAuthConnectionsDelete
|
|
16103
16338
|
* @summary Delete Dev Orgs Auth Connection
|
|
16104
16339
|
* @request POST:/dev-orgs.auth-connections.delete
|
|
@@ -16108,7 +16343,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
16108
16343
|
/**
|
|
16109
16344
|
* @description Retrieves the details for an authentication connection.
|
|
16110
16345
|
*
|
|
16111
|
-
* @tags auth-
|
|
16346
|
+
* @tags auth-connections, dev-orgs
|
|
16112
16347
|
* @name DevOrgAuthConnectionsGet
|
|
16113
16348
|
* @summary Get Dev Orgs Auth Connection
|
|
16114
16349
|
* @request GET:/dev-orgs.auth-connections.get
|
|
@@ -16121,7 +16356,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
16121
16356
|
/**
|
|
16122
16357
|
* @description Retrieves the details for an authentication connection.
|
|
16123
16358
|
*
|
|
16124
|
-
* @tags auth-
|
|
16359
|
+
* @tags auth-connections, dev-orgs
|
|
16125
16360
|
* @name DevOrgAuthConnectionsGetPost
|
|
16126
16361
|
* @summary Get Dev Orgs Auth Connection (POST)
|
|
16127
16362
|
* @request POST:/dev-orgs.auth-connections.get
|
|
@@ -16131,7 +16366,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
16131
16366
|
/**
|
|
16132
16367
|
* @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.
|
|
16133
16368
|
*
|
|
16134
|
-
* @tags auth-
|
|
16369
|
+
* @tags auth-connections, dev-orgs
|
|
16135
16370
|
* @name DevOrgAuthConnectionsList
|
|
16136
16371
|
* @summary List Dev Orgs Auth Connections
|
|
16137
16372
|
* @request GET:/dev-orgs.auth-connections.list
|
|
@@ -16141,7 +16376,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
16141
16376
|
/**
|
|
16142
16377
|
* @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.
|
|
16143
16378
|
*
|
|
16144
|
-
* @tags auth-
|
|
16379
|
+
* @tags auth-connections, dev-orgs
|
|
16145
16380
|
* @name DevOrgAuthConnectionsListPost
|
|
16146
16381
|
* @summary List Dev Orgs Auth Connections (POST)
|
|
16147
16382
|
* @request POST:/dev-orgs.auth-connections.list
|
|
@@ -16151,7 +16386,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
16151
16386
|
/**
|
|
16152
16387
|
* @description Enable or disable an authentication connection for a Dev organization. Currently, only 1 authentication connection can be enabled at a time. When a new authentication connection is enabled, the connection which is currently enabled for the Dev organization is automatically disabled.
|
|
16153
16388
|
*
|
|
16154
|
-
* @tags auth-
|
|
16389
|
+
* @tags auth-connections, dev-orgs
|
|
16155
16390
|
* @name DevOrgAuthConnectionsToggle
|
|
16156
16391
|
* @summary Toggle Dev Orgs Auth Connections
|
|
16157
16392
|
* @request POST:/dev-orgs.auth-connections.toggle
|
|
@@ -16161,13 +16396,33 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
16161
16396
|
/**
|
|
16162
16397
|
* @description Updates an authentication connection.
|
|
16163
16398
|
*
|
|
16164
|
-
* @tags auth-
|
|
16399
|
+
* @tags auth-connections, dev-orgs
|
|
16165
16400
|
* @name DevOrgAuthConnectionsUpdate
|
|
16166
16401
|
* @summary Update Dev Orgs Auth Connection
|
|
16167
16402
|
* @request POST:/dev-orgs.auth-connections.update
|
|
16168
16403
|
* @secure
|
|
16169
16404
|
*/
|
|
16170
16405
|
devOrgAuthConnectionsUpdate: (data: DevOrgAuthConnectionsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<DevOrgAuthConnectionsUpdateResponse, any>>;
|
|
16406
|
+
/**
|
|
16407
|
+
* @description Gets the Dev organization's information of the authenticated user.
|
|
16408
|
+
*
|
|
16409
|
+
* @tags dev-orgs
|
|
16410
|
+
* @name DevOrgsGet
|
|
16411
|
+
* @summary Get Dev Org
|
|
16412
|
+
* @request GET:/dev-orgs.get
|
|
16413
|
+
* @secure
|
|
16414
|
+
*/
|
|
16415
|
+
devOrgsGet: (params?: RequestParams) => Promise<AxiosResponse<DevOrgsGetResponse, any>>;
|
|
16416
|
+
/**
|
|
16417
|
+
* @description Gets the Dev organization's information of the authenticated user.
|
|
16418
|
+
*
|
|
16419
|
+
* @tags dev-orgs
|
|
16420
|
+
* @name DevOrgsGetPost
|
|
16421
|
+
* @summary Get Dev Org (POST)
|
|
16422
|
+
* @request POST:/dev-orgs.get
|
|
16423
|
+
* @secure
|
|
16424
|
+
*/
|
|
16425
|
+
devOrgsGetPost: (data: DevOrgsGetRequest, params?: RequestParams) => Promise<AxiosResponse<DevOrgsGetResponse, any>>;
|
|
16171
16426
|
/**
|
|
16172
16427
|
* @description Activates the requested user.
|
|
16173
16428
|
*
|
|
@@ -16602,7 +16857,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
16602
16857
|
/**
|
|
16603
16858
|
* @description Gets an event source.
|
|
16604
16859
|
*
|
|
16605
|
-
* @tags event-
|
|
16860
|
+
* @tags event-sources
|
|
16606
16861
|
* @name EventSourcesGet
|
|
16607
16862
|
* @summary Get Event Source
|
|
16608
16863
|
* @request GET:/event-sources.get
|
|
@@ -16615,7 +16870,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
16615
16870
|
/**
|
|
16616
16871
|
* @description Gets an event source.
|
|
16617
16872
|
*
|
|
16618
|
-
* @tags event-
|
|
16873
|
+
* @tags event-sources
|
|
16619
16874
|
* @name EventSourcesGetPost
|
|
16620
16875
|
* @summary Get Event Source (POST)
|
|
16621
16876
|
* @request POST:/event-sources.get
|
|
@@ -16625,7 +16880,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
16625
16880
|
/**
|
|
16626
16881
|
* @description Schedules an event to be published to the specified event source.
|
|
16627
16882
|
*
|
|
16628
|
-
* @tags event-
|
|
16883
|
+
* @tags event-sources
|
|
16629
16884
|
* @name EventSourcesScheduleEvent
|
|
16630
16885
|
* @summary Schedule Event Sources
|
|
16631
16886
|
* @request POST:/event-sources.schedule
|
|
@@ -16635,7 +16890,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
16635
16890
|
/**
|
|
16636
16891
|
* @description Deletes an event scheduled for the specified event source.
|
|
16637
16892
|
*
|
|
16638
|
-
* @tags event-
|
|
16893
|
+
* @tags event-sources
|
|
16639
16894
|
* @name EventSourcesDeleteScheduledEvent
|
|
16640
16895
|
* @summary Unschedule Event Sources
|
|
16641
16896
|
* @request POST:/event-sources.unschedule
|
|
@@ -16793,7 +17048,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
16793
17048
|
/**
|
|
16794
17049
|
* @description Creates an incident.
|
|
16795
17050
|
*
|
|
16796
|
-
* @tags
|
|
17051
|
+
* @tags incidents
|
|
16797
17052
|
* @name IncidentsCreate
|
|
16798
17053
|
* @summary Create Incident
|
|
16799
17054
|
* @request POST:/incidents.create
|
|
@@ -16803,7 +17058,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
16803
17058
|
/**
|
|
16804
17059
|
* @description Deletes an incident.
|
|
16805
17060
|
*
|
|
16806
|
-
* @tags
|
|
17061
|
+
* @tags incidents
|
|
16807
17062
|
* @name IncidentsDelete
|
|
16808
17063
|
* @summary Delete Incident
|
|
16809
17064
|
* @request POST:/incidents.delete
|
|
@@ -16813,7 +17068,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
16813
17068
|
/**
|
|
16814
17069
|
* @description Gets an incident.
|
|
16815
17070
|
*
|
|
16816
|
-
* @tags
|
|
17071
|
+
* @tags incidents
|
|
16817
17072
|
* @name IncidentsGet
|
|
16818
17073
|
* @summary Get Incident
|
|
16819
17074
|
* @request GET:/incidents.get
|
|
@@ -16826,7 +17081,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
16826
17081
|
/**
|
|
16827
17082
|
* @description Gets an incident.
|
|
16828
17083
|
*
|
|
16829
|
-
* @tags
|
|
17084
|
+
* @tags incidents
|
|
16830
17085
|
* @name IncidentsGetPost
|
|
16831
17086
|
* @summary Get Incident (POST)
|
|
16832
17087
|
* @request POST:/incidents.get
|
|
@@ -16836,7 +17091,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
16836
17091
|
/**
|
|
16837
17092
|
* @description Lists collections of incidents by groups.
|
|
16838
17093
|
*
|
|
16839
|
-
* @tags
|
|
17094
|
+
* @tags incidents
|
|
16840
17095
|
* @name IncidentsGroup
|
|
16841
17096
|
* @summary Group Incidents
|
|
16842
17097
|
* @request GET:/incidents.group
|
|
@@ -16911,7 +17166,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
16911
17166
|
/**
|
|
16912
17167
|
* @description Lists collections of incidents by groups.
|
|
16913
17168
|
*
|
|
16914
|
-
* @tags
|
|
17169
|
+
* @tags incidents
|
|
16915
17170
|
* @name IncidentsGroupPost
|
|
16916
17171
|
* @summary Group Incidents (POST)
|
|
16917
17172
|
* @request POST:/incidents.group
|
|
@@ -16921,7 +17176,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
16921
17176
|
/**
|
|
16922
17177
|
* @description Lists incidents.
|
|
16923
17178
|
*
|
|
16924
|
-
* @tags
|
|
17179
|
+
* @tags incidents
|
|
16925
17180
|
* @name IncidentsList
|
|
16926
17181
|
* @summary List Incidents
|
|
16927
17182
|
* @request GET:/incidents.list
|
|
@@ -16987,7 +17242,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
16987
17242
|
/**
|
|
16988
17243
|
* @description Lists incidents.
|
|
16989
17244
|
*
|
|
16990
|
-
* @tags
|
|
17245
|
+
* @tags incidents
|
|
16991
17246
|
* @name IncidentsListPost
|
|
16992
17247
|
* @summary List Incidents (POST)
|
|
16993
17248
|
* @request POST:/incidents.list
|
|
@@ -16997,7 +17252,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
16997
17252
|
/**
|
|
16998
17253
|
* @description Updates an incident.
|
|
16999
17254
|
*
|
|
17000
|
-
* @tags
|
|
17255
|
+
* @tags incidents
|
|
17001
17256
|
* @name IncidentsUpdate
|
|
17002
17257
|
* @summary Update Incident
|
|
17003
17258
|
* @request POST:/incidents.update
|
|
@@ -17007,7 +17262,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
17007
17262
|
/**
|
|
17008
17263
|
* @description OAuth2 authorization callback.
|
|
17009
17264
|
*
|
|
17010
|
-
* @tags
|
|
17265
|
+
* @tags keyrings
|
|
17011
17266
|
* @name KeyringsCreateCallback
|
|
17012
17267
|
* @summary Authorize Keyrings
|
|
17013
17268
|
* @request GET:/keyrings.authorize
|
|
@@ -17021,7 +17276,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
17021
17276
|
/**
|
|
17022
17277
|
* @description OAuth2 authorization callback.
|
|
17023
17278
|
*
|
|
17024
|
-
* @tags
|
|
17279
|
+
* @tags keyrings
|
|
17025
17280
|
* @name KeyringsCreateCallbackPost
|
|
17026
17281
|
* @summary Authorize Keyrings (POST)
|
|
17027
17282
|
* @request POST:/keyrings.authorize
|
|
@@ -17503,7 +17758,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
17503
17758
|
/**
|
|
17504
17759
|
* @description Ingest endpoint for DevRev metrics data from clients.
|
|
17505
17760
|
*
|
|
17506
|
-
* @tags
|
|
17761
|
+
* @tags metrics
|
|
17507
17762
|
* @name MetricsDevrevIngest
|
|
17508
17763
|
* @summary Ingest Metrics Devrev
|
|
17509
17764
|
* @request POST:/metrics.devrev.ingest
|
|
@@ -19447,6 +19702,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
19447
19702
|
* starts from the beginning.
|
|
19448
19703
|
*/
|
|
19449
19704
|
cursor?: string;
|
|
19705
|
+
/** Filters for survey responses associated with these unique IDs. */
|
|
19706
|
+
dispatch_ids?: string[];
|
|
19450
19707
|
/**
|
|
19451
19708
|
* The maximum number of survey responses to return. If not set, then
|
|
19452
19709
|
* the default is '50'.
|
|
@@ -19789,7 +20046,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
19789
20046
|
/**
|
|
19790
20047
|
* @description Allows publishing of events (example from plug widget).
|
|
19791
20048
|
*
|
|
19792
|
-
* @tags event-
|
|
20049
|
+
* @tags event-sources
|
|
19793
20050
|
* @name TrackEventsPublish
|
|
19794
20051
|
* @summary Publish Track Events
|
|
19795
20052
|
* @request POST:/track-events.publish
|
|
@@ -19799,9 +20056,9 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
19799
20056
|
/**
|
|
19800
20057
|
* @description Counts the number of Unit of Measurements based on the given filters.
|
|
19801
20058
|
*
|
|
19802
|
-
* @tags
|
|
20059
|
+
* @tags uoms
|
|
19803
20060
|
* @name UomsCount
|
|
19804
|
-
* @summary Count
|
|
20061
|
+
* @summary Count UOMs
|
|
19805
20062
|
* @request GET:/uoms.count
|
|
19806
20063
|
* @secure
|
|
19807
20064
|
*/
|
|
@@ -19831,9 +20088,9 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
19831
20088
|
/**
|
|
19832
20089
|
* @description Counts the number of Unit of Measurements based on the given filters.
|
|
19833
20090
|
*
|
|
19834
|
-
* @tags
|
|
20091
|
+
* @tags uoms
|
|
19835
20092
|
* @name UomsCountPost
|
|
19836
|
-
* @summary Count
|
|
20093
|
+
* @summary Count UOMs (POST)
|
|
19837
20094
|
* @request POST:/uoms.count
|
|
19838
20095
|
* @secure
|
|
19839
20096
|
*/
|
|
@@ -19841,9 +20098,9 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
19841
20098
|
/**
|
|
19842
20099
|
* @description Creates a Unit of Measurement on a part.
|
|
19843
20100
|
*
|
|
19844
|
-
* @tags
|
|
20101
|
+
* @tags uoms
|
|
19845
20102
|
* @name UomsCreate
|
|
19846
|
-
* @summary Create
|
|
20103
|
+
* @summary Create UOM
|
|
19847
20104
|
* @request POST:/uoms.create
|
|
19848
20105
|
* @secure
|
|
19849
20106
|
*/
|
|
@@ -19851,9 +20108,9 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
19851
20108
|
/**
|
|
19852
20109
|
* @description Deletes a Unit of Measurement.
|
|
19853
20110
|
*
|
|
19854
|
-
* @tags
|
|
20111
|
+
* @tags uoms
|
|
19855
20112
|
* @name UomsDelete
|
|
19856
|
-
* @summary Delete
|
|
20113
|
+
* @summary Delete UOM
|
|
19857
20114
|
* @request POST:/uoms.delete
|
|
19858
20115
|
* @secure
|
|
19859
20116
|
*/
|
|
@@ -19861,9 +20118,9 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
19861
20118
|
/**
|
|
19862
20119
|
* @description Gets a Unit of Measurement.
|
|
19863
20120
|
*
|
|
19864
|
-
* @tags
|
|
20121
|
+
* @tags uoms
|
|
19865
20122
|
* @name UomsGet
|
|
19866
|
-
* @summary Get
|
|
20123
|
+
* @summary Get UOM
|
|
19867
20124
|
* @request GET:/uoms.get
|
|
19868
20125
|
* @secure
|
|
19869
20126
|
*/
|
|
@@ -19874,9 +20131,9 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
19874
20131
|
/**
|
|
19875
20132
|
* @description Gets a Unit of Measurement.
|
|
19876
20133
|
*
|
|
19877
|
-
* @tags
|
|
20134
|
+
* @tags uoms
|
|
19878
20135
|
* @name UomsGetPost
|
|
19879
|
-
* @summary Get
|
|
20136
|
+
* @summary Get UOM (POST)
|
|
19880
20137
|
* @request POST:/uoms.get
|
|
19881
20138
|
* @secure
|
|
19882
20139
|
*/
|
|
@@ -19884,9 +20141,9 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
19884
20141
|
/**
|
|
19885
20142
|
* @description Gets the Unit of Measurements based on the given filters.
|
|
19886
20143
|
*
|
|
19887
|
-
* @tags
|
|
20144
|
+
* @tags uoms
|
|
19888
20145
|
* @name UomsList
|
|
19889
|
-
* @summary List
|
|
20146
|
+
* @summary List UOMs
|
|
19890
20147
|
* @request GET:/uoms.list
|
|
19891
20148
|
* @secure
|
|
19892
20149
|
*/
|
|
@@ -19937,9 +20194,9 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
19937
20194
|
/**
|
|
19938
20195
|
* @description Gets the Unit of Measurements based on the given filters.
|
|
19939
20196
|
*
|
|
19940
|
-
* @tags
|
|
20197
|
+
* @tags uoms
|
|
19941
20198
|
* @name UomsListPost
|
|
19942
|
-
* @summary List
|
|
20199
|
+
* @summary List UOMs (POST)
|
|
19943
20200
|
* @request POST:/uoms.list
|
|
19944
20201
|
* @secure
|
|
19945
20202
|
*/
|
|
@@ -19947,9 +20204,9 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
19947
20204
|
/**
|
|
19948
20205
|
* @description Updates a Unit of Measurement.
|
|
19949
20206
|
*
|
|
19950
|
-
* @tags
|
|
20207
|
+
* @tags uoms
|
|
19951
20208
|
* @name UomsUpdate
|
|
19952
|
-
* @summary Update
|
|
20209
|
+
* @summary Update UOM
|
|
19953
20210
|
* @request POST:/uoms.update
|
|
19954
20211
|
* @secure
|
|
19955
20212
|
*/
|