@devrev/typescript-sdk 1.1.47 → 1.1.49
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.
|
@@ -1307,7 +1307,7 @@ export declare enum AssociatedToType {
|
|
|
1307
1307
|
RevOrg = "rev_org"
|
|
1308
1308
|
}
|
|
1309
1309
|
/** atom */
|
|
1310
|
-
export type Atom = (Account | AppFragment | Capability | Conversation | CustomTypeFragment | DevUser | Engagement | Enhancement | Feature | Incident | Issue | Meeting | Opportunity | Product | RevOrg | RevUser | ServiceAccount | SysUser | Tag | Task | TenantFragment | Ticket | TimelineChangeEvent | TimelineComment | UserPreferences | Webhook) & {
|
|
1310
|
+
export type Atom = (Account | AppFragment | Capability | Conversation | CustomTypeFragment | DevUser | Engagement | Enhancement | Feature | Incident | Issue | Meeting | Opportunity | Product | QuestionAnswer | RevOrg | RevUser | ServiceAccount | SysUser | Tag | Task | TenantFragment | Ticket | TimelineChangeEvent | TimelineComment | UserPreferences | Webhook) & {
|
|
1311
1311
|
type: AtomType;
|
|
1312
1312
|
};
|
|
1313
1313
|
/** atom-base */
|
|
@@ -1339,7 +1339,7 @@ export interface AtomBaseSummary {
|
|
|
1339
1339
|
id: string;
|
|
1340
1340
|
}
|
|
1341
1341
|
/** atom-summary */
|
|
1342
|
-
export type AtomSummary = (AccountSummary | AppFragmentSummary | CapabilitySummary | ConversationSummary | CustomTypeFragmentSummary | DevUserSummary | EngagementSummary | EnhancementSummary | FeatureSummary | IncidentSummary | IssueSummary | MeetingSummary | OpportunitySummary | ProductSummary | RevOrgSummary | RevUserSummary | ServiceAccountSummary | SysUserSummary | TagSummary | TaskSummary | TenantFragmentSummary | TicketSummary | TimelineChangeEventSummary | TimelineCommentSummary | UserPreferencesSummary | WebhookSummary) & {
|
|
1342
|
+
export type AtomSummary = (AccountSummary | AppFragmentSummary | CapabilitySummary | ConversationSummary | CustomTypeFragmentSummary | DevUserSummary | EngagementSummary | EnhancementSummary | FeatureSummary | IncidentSummary | IssueSummary | MeetingSummary | OpportunitySummary | ProductSummary | QuestionAnswerSummary | RevOrgSummary | RevUserSummary | ServiceAccountSummary | SysUserSummary | TagSummary | TaskSummary | TenantFragmentSummary | TicketSummary | TimelineChangeEventSummary | TimelineCommentSummary | UserPreferencesSummary | WebhookSummary) & {
|
|
1343
1343
|
type: AtomType;
|
|
1344
1344
|
};
|
|
1345
1345
|
export declare enum AtomType {
|
|
@@ -1357,6 +1357,7 @@ export declare enum AtomType {
|
|
|
1357
1357
|
Meeting = "meeting",
|
|
1358
1358
|
Opportunity = "opportunity",
|
|
1359
1359
|
Product = "product",
|
|
1360
|
+
QuestionAnswer = "question_answer",
|
|
1360
1361
|
RevOrg = "rev_org",
|
|
1361
1362
|
RevUser = "rev_user",
|
|
1362
1363
|
ServiceAccount = "service_account",
|
|
@@ -4274,7 +4275,7 @@ export type DevUserSummary = UserBaseSummary;
|
|
|
4274
4275
|
export interface DevUsersActivateRequest {
|
|
4275
4276
|
/** IDs of the groups assigned to user during activation. */
|
|
4276
4277
|
groups?: string[];
|
|
4277
|
-
/** The ID for the Dev
|
|
4278
|
+
/** The ID for the Dev user. */
|
|
4278
4279
|
id: string;
|
|
4279
4280
|
}
|
|
4280
4281
|
/**
|
|
@@ -4287,7 +4288,7 @@ export interface DevUsersActivateResponse {
|
|
|
4287
4288
|
}
|
|
4288
4289
|
/**
|
|
4289
4290
|
* dev-users-create-request
|
|
4290
|
-
* Request object to create a new Dev
|
|
4291
|
+
* Request object to create a new Dev user for a Dev organization.
|
|
4291
4292
|
*/
|
|
4292
4293
|
export interface DevUsersCreateRequest {
|
|
4293
4294
|
/** Application-defined custom fields. */
|
|
@@ -4300,19 +4301,19 @@ export interface DevUsersCreateRequest {
|
|
|
4300
4301
|
* specifier, it remains unmodified.
|
|
4301
4302
|
*/
|
|
4302
4303
|
custom_schema_spec?: CustomSchemaSpec;
|
|
4303
|
-
/** Email of the Dev
|
|
4304
|
+
/** Email of the Dev user. */
|
|
4304
4305
|
email: string;
|
|
4305
|
-
/** Full name of the Dev
|
|
4306
|
+
/** Full name of the Dev user. */
|
|
4306
4307
|
full_name?: string;
|
|
4307
|
-
state
|
|
4308
|
+
state: DevUsersCreateRequestStateEnumValue;
|
|
4308
4309
|
}
|
|
4309
|
-
export declare enum
|
|
4310
|
+
export declare enum DevUsersCreateRequestStateEnumValue {
|
|
4310
4311
|
Shadow = "shadow"
|
|
4311
4312
|
}
|
|
4312
4313
|
/**
|
|
4313
4314
|
* dev-users-create-response
|
|
4314
|
-
* Response object for request to create a new Dev
|
|
4315
|
-
*
|
|
4315
|
+
* Response object for request to create a new Dev user for a Dev
|
|
4316
|
+
* organization.
|
|
4316
4317
|
*/
|
|
4317
4318
|
export interface DevUsersCreateResponse {
|
|
4318
4319
|
dev_user: DevUser;
|
|
@@ -4322,7 +4323,7 @@ export interface DevUsersCreateResponse {
|
|
|
4322
4323
|
* A request to deactivate the Dev user.
|
|
4323
4324
|
*/
|
|
4324
4325
|
export interface DevUsersDeactivateRequest {
|
|
4325
|
-
/** The ID for the Dev
|
|
4326
|
+
/** The ID for the Dev user. */
|
|
4326
4327
|
id: string;
|
|
4327
4328
|
}
|
|
4328
4329
|
/**
|
|
@@ -5479,6 +5480,21 @@ export interface EventPartUpdated {
|
|
|
5479
5480
|
old_part?: Part;
|
|
5480
5481
|
part: Part;
|
|
5481
5482
|
}
|
|
5483
|
+
/** event-question-answer-created */
|
|
5484
|
+
export interface EventQuestionAnswerCreated {
|
|
5485
|
+
question_answer: QuestionAnswer;
|
|
5486
|
+
}
|
|
5487
|
+
/** event-question-answer-deleted */
|
|
5488
|
+
export interface EventQuestionAnswerDeleted {
|
|
5489
|
+
/** The ID of the question-answer that was deleted. */
|
|
5490
|
+
id: string;
|
|
5491
|
+
old_question_answer?: QuestionAnswer;
|
|
5492
|
+
}
|
|
5493
|
+
/** event-question-answer-updated */
|
|
5494
|
+
export interface EventQuestionAnswerUpdated {
|
|
5495
|
+
old_question_answer?: QuestionAnswer;
|
|
5496
|
+
question_answer: QuestionAnswer;
|
|
5497
|
+
}
|
|
5482
5498
|
/** event-rev-org-created */
|
|
5483
5499
|
export interface EventRevOrgCreated {
|
|
5484
5500
|
rev_org: RevOrg;
|
|
@@ -7242,6 +7258,14 @@ export interface MeetingsCreateRequest {
|
|
|
7242
7258
|
channel: MeetingChannel;
|
|
7243
7259
|
/** Application-defined custom fields. */
|
|
7244
7260
|
custom_fields?: object;
|
|
7261
|
+
/**
|
|
7262
|
+
* Requested custom schemas described abstractly. Every provided schema's
|
|
7263
|
+
* custom field must be specified, otherwise a bad request error is
|
|
7264
|
+
* returned. If a new custom schema specifier is provided, then it will be
|
|
7265
|
+
* added to the work, otherwise if a custom schema is omitted from the
|
|
7266
|
+
* specifier, it remains unmodified.
|
|
7267
|
+
*/
|
|
7268
|
+
custom_schema_spec?: CustomSchemaSpec;
|
|
7245
7269
|
/** The description of the meeting. */
|
|
7246
7270
|
description?: string;
|
|
7247
7271
|
/**
|
|
@@ -7397,6 +7421,14 @@ export interface MeetingsUpdateRequest {
|
|
|
7397
7421
|
channel?: MeetingChannel;
|
|
7398
7422
|
/** Application-defined custom fields. */
|
|
7399
7423
|
custom_fields?: object;
|
|
7424
|
+
/**
|
|
7425
|
+
* Requested custom schemas described abstractly. Every provided schema's
|
|
7426
|
+
* custom field must be specified, otherwise a bad request error is
|
|
7427
|
+
* returned. If a new custom schema specifier is provided, then it will be
|
|
7428
|
+
* added to the work, otherwise if a custom schema is omitted from the
|
|
7429
|
+
* specifier, it remains unmodified.
|
|
7430
|
+
*/
|
|
7431
|
+
custom_schema_spec?: CustomSchemaSpec;
|
|
7400
7432
|
/** The description of the meeting. */
|
|
7401
7433
|
description?: string;
|
|
7402
7434
|
/**
|
|
@@ -7417,6 +7449,11 @@ export interface MeetingsUpdateRequest {
|
|
|
7417
7449
|
* @example "DEVU-12345"
|
|
7418
7450
|
*/
|
|
7419
7451
|
organizer?: string;
|
|
7452
|
+
/**
|
|
7453
|
+
* The ID of the meeting's recording artifact.
|
|
7454
|
+
* @example "ARTIFACT-12345"
|
|
7455
|
+
*/
|
|
7456
|
+
recording?: string | null;
|
|
7420
7457
|
/** The recording URL of the meeting. */
|
|
7421
7458
|
recording_url?: string;
|
|
7422
7459
|
/**
|
|
@@ -7430,6 +7467,11 @@ export interface MeetingsUpdateRequest {
|
|
|
7430
7467
|
tags?: MeetingsUpdateRequestTags;
|
|
7431
7468
|
/** The title of the meeting. */
|
|
7432
7469
|
title?: string;
|
|
7470
|
+
/**
|
|
7471
|
+
* The ID of the artifact for the transcript of the meeting.
|
|
7472
|
+
* @example "ARTIFACT-12345"
|
|
7473
|
+
*/
|
|
7474
|
+
transcript?: string;
|
|
7433
7475
|
}
|
|
7434
7476
|
/** meetings-update-request-members */
|
|
7435
7477
|
export interface MeetingsUpdateRequestMembers {
|
|
@@ -9325,7 +9367,7 @@ export interface RevUsersGetResponse {
|
|
|
9325
9367
|
/**
|
|
9326
9368
|
* rev-users-list-request
|
|
9327
9369
|
* Gets the list of Rev users belonging to the authenticated user's Dev
|
|
9328
|
-
*
|
|
9370
|
+
* organization which the user is also authorized to access.
|
|
9329
9371
|
*/
|
|
9330
9372
|
export interface RevUsersListRequest {
|
|
9331
9373
|
/**
|
|
@@ -9531,99 +9573,27 @@ export declare enum RolePrivileges {
|
|
|
9531
9573
|
export type RoleSummary = AtomBaseSummary;
|
|
9532
9574
|
/** Target object type of the role. */
|
|
9533
9575
|
export declare enum RoleTarget {
|
|
9534
|
-
AccessControlEntry = "access_control_entry",
|
|
9535
|
-
Account = "account",
|
|
9536
|
-
AccountCommerceDetails = "account_commerce_details",
|
|
9537
|
-
AddonRule = "addon_rule",
|
|
9538
|
-
AiAgent = "ai_agent",
|
|
9539
|
-
AiAgentSession = "ai_agent_session",
|
|
9540
|
-
AiAssistantChat = "ai_assistant_chat",
|
|
9541
|
-
AppFragment = "app_fragment",
|
|
9542
9576
|
Article = "article",
|
|
9543
9577
|
Artifact = "artifact",
|
|
9544
9578
|
Capability = "capability",
|
|
9545
|
-
Channel = "channel",
|
|
9546
|
-
Command = "command",
|
|
9547
|
-
Comment = "comment",
|
|
9548
9579
|
Conversation = "conversation",
|
|
9549
|
-
Credit = "credit",
|
|
9550
|
-
CreditCoupon = "credit_coupon",
|
|
9551
|
-
CustomObject = "custom_object",
|
|
9552
|
-
CustomPart = "custom_part",
|
|
9553
|
-
CustomStage = "custom_stage",
|
|
9554
|
-
CustomState = "custom_state",
|
|
9555
|
-
CustomTypeFragment = "custom_type_fragment",
|
|
9556
|
-
Dashboard = "dashboard",
|
|
9557
|
-
Dataset = "dataset",
|
|
9558
|
-
DevOrg = "dev_org",
|
|
9559
9580
|
DevUser = "dev_user",
|
|
9560
|
-
Directory = "directory",
|
|
9561
|
-
DiscoveryRun = "discovery_run",
|
|
9562
|
-
Dm = "dm",
|
|
9563
|
-
Enhancement = "enhancement",
|
|
9564
|
-
ExternalSyncUnit = "external_sync_unit",
|
|
9565
9581
|
Feature = "feature",
|
|
9566
|
-
Flow = "flow",
|
|
9567
9582
|
Group = "group",
|
|
9568
|
-
Incident = "incident",
|
|
9569
|
-
Invoice = "invoice",
|
|
9570
9583
|
Issue = "issue",
|
|
9571
|
-
Job = "job",
|
|
9572
|
-
Keyring = "keyring",
|
|
9573
|
-
LicenseAssignment = "license_assignment",
|
|
9574
|
-
Link = "link",
|
|
9575
9584
|
Linkable = "linkable",
|
|
9576
|
-
Marketplace = "marketplace",
|
|
9577
|
-
MarketplaceCategory = "marketplace_category",
|
|
9578
|
-
MarketplaceItem = "marketplace_item",
|
|
9579
|
-
MarketplaceSubmission = "marketplace_submission",
|
|
9580
9585
|
Meeting = "meeting",
|
|
9581
|
-
MetricSet = "metric_set",
|
|
9582
|
-
OasisData = "oasis_data",
|
|
9583
|
-
ObjectMember = "object_member",
|
|
9584
9586
|
Opportunity = "opportunity",
|
|
9585
|
-
OrgPreferences = "org_preferences",
|
|
9586
|
-
PaymentMethodCard = "payment_method_card",
|
|
9587
|
-
PortalPreferences = "portal_preferences",
|
|
9588
|
-
Pricing = "pricing",
|
|
9589
9587
|
Product = "product",
|
|
9590
|
-
QuestionAnswer = "question_answer",
|
|
9591
|
-
Quote = "quote",
|
|
9592
|
-
RecordTemplate = "record_template",
|
|
9593
|
-
RevOrg = "rev_org",
|
|
9594
9588
|
RevUser = "rev_user",
|
|
9595
|
-
RevoConfig = "revo_config",
|
|
9596
|
-
Role = "role",
|
|
9597
|
-
RoleSet = "role_set",
|
|
9598
9589
|
Runnable = "runnable",
|
|
9599
|
-
|
|
9600
|
-
ServicePlan = "service_plan",
|
|
9601
|
-
Sku = "sku",
|
|
9602
|
-
SkuRule = "sku_rule",
|
|
9603
|
-
SnapIn = "snap_in",
|
|
9604
|
-
SnapWidget = "snap_widget",
|
|
9605
|
-
StageDiagram = "stage_diagram",
|
|
9606
|
-
SvcAcc = "svc_acc",
|
|
9607
|
-
SyncHistory = "sync_history",
|
|
9608
|
-
SyncMapperRecord = "sync_mapper_record",
|
|
9609
|
-
SyncUnit = "sync_unit",
|
|
9610
|
-
Task = "task",
|
|
9611
|
-
TenantFragment = "tenant_fragment",
|
|
9612
|
-
Ticket = "ticket",
|
|
9613
|
-
Token = "token",
|
|
9614
|
-
Uom = "uom",
|
|
9615
|
-
Vista = "vista",
|
|
9616
|
-
Webhook = "webhook",
|
|
9617
|
-
Widget = "widget",
|
|
9618
|
-
Workflow = "workflow"
|
|
9590
|
+
Ticket = "ticket"
|
|
9619
9591
|
}
|
|
9620
9592
|
/**
|
|
9621
9593
|
* roles-apply-request
|
|
9622
9594
|
* A request to apply (assign or revoke) roles of a principal.
|
|
9623
9595
|
*/
|
|
9624
9596
|
export interface RolesApplyRequest {
|
|
9625
|
-
/** Act as ID. */
|
|
9626
|
-
act_as?: string;
|
|
9627
9597
|
/** Roles to be additionally assigned to principal. */
|
|
9628
9598
|
assign?: string[];
|
|
9629
9599
|
/**
|
|
@@ -9631,8 +9601,6 @@ export interface RolesApplyRequest {
|
|
|
9631
9601
|
* @example "DEV-AbCdEfGh"
|
|
9632
9602
|
*/
|
|
9633
9603
|
principal: string;
|
|
9634
|
-
/** Roles to be revoked from principal. */
|
|
9635
|
-
revoke?: string[];
|
|
9636
9604
|
}
|
|
9637
9605
|
/**
|
|
9638
9606
|
* roles-apply-response
|
|
@@ -9644,14 +9612,8 @@ export type RolesApplyResponse = object;
|
|
|
9644
9612
|
* A request to create a new role.
|
|
9645
9613
|
*/
|
|
9646
9614
|
export interface RolesCreateRequest {
|
|
9647
|
-
/** The caveats on the role. */
|
|
9648
|
-
caveats?: RolesCreateRequestCaveat[];
|
|
9649
|
-
/** Leaf type of the custom object target. */
|
|
9650
|
-
custom_object_target?: string;
|
|
9651
9615
|
/** The description of the role. */
|
|
9652
9616
|
description?: string;
|
|
9653
|
-
/** Field Privileges. */
|
|
9654
|
-
field_privileges?: RolesCreateRequestFieldPrivileges;
|
|
9655
9617
|
/**
|
|
9656
9618
|
* Whether to include all subtypes of the leaf type as target of the
|
|
9657
9619
|
* role.
|
|
@@ -9669,16 +9631,6 @@ export interface RolesCreateRequest {
|
|
|
9669
9631
|
/** The subtype of the target. */
|
|
9670
9632
|
target_subtype?: string;
|
|
9671
9633
|
}
|
|
9672
|
-
/**
|
|
9673
|
-
* roles-create-request-caveat
|
|
9674
|
-
* Caveat under which the role applies.
|
|
9675
|
-
*/
|
|
9676
|
-
export type RolesCreateRequestCaveat = object;
|
|
9677
|
-
/**
|
|
9678
|
-
* roles-create-request-field-privileges
|
|
9679
|
-
* Field Privileges.
|
|
9680
|
-
*/
|
|
9681
|
-
export type RolesCreateRequestFieldPrivileges = object;
|
|
9682
9634
|
/**
|
|
9683
9635
|
* roles-create-response
|
|
9684
9636
|
* A response to a request to create a new role.
|
|
@@ -10295,8 +10247,8 @@ export interface SchemasSubtypePrepareUpdateGetResponseDroppedField {
|
|
|
10295
10247
|
*/
|
|
10296
10248
|
export interface SearchCoreRequest {
|
|
10297
10249
|
/**
|
|
10298
|
-
* The cursor
|
|
10299
|
-
*
|
|
10250
|
+
* The cursor to resume iteration from. If not provided, then
|
|
10251
|
+
* iteration starts from the beginning.
|
|
10300
10252
|
*/
|
|
10301
10253
|
cursor?: string;
|
|
10302
10254
|
/**
|
|
@@ -10305,6 +10257,14 @@ export interface SearchCoreRequest {
|
|
|
10305
10257
|
* @format int32
|
|
10306
10258
|
*/
|
|
10307
10259
|
limit?: number;
|
|
10260
|
+
/**
|
|
10261
|
+
* The iteration mode to use. If "after", then entries after the provided
|
|
10262
|
+
* cursor will be returned, or if no cursor is provided, then from the
|
|
10263
|
+
* beginning. If "before", then entries before the provided cursor will be
|
|
10264
|
+
* returned, or if no cursor is provided, then from the end. Entries will
|
|
10265
|
+
* always be returned in the specified sort-by order.
|
|
10266
|
+
*/
|
|
10267
|
+
mode?: ListMode;
|
|
10308
10268
|
/** The namespaces to search in. */
|
|
10309
10269
|
namespaces?: SearchNamespace[];
|
|
10310
10270
|
/**
|
|
@@ -10327,6 +10287,16 @@ export interface SearchCoreResponse {
|
|
|
10327
10287
|
* not provided.
|
|
10328
10288
|
*/
|
|
10329
10289
|
cursor?: string;
|
|
10290
|
+
/**
|
|
10291
|
+
* The cursor used to iterate subsequent results in accordance to the
|
|
10292
|
+
* sort order. If not set, then no later elements exist.
|
|
10293
|
+
*/
|
|
10294
|
+
next_cursor?: string;
|
|
10295
|
+
/**
|
|
10296
|
+
* The cursor used to iterate preceding results in accordance to the
|
|
10297
|
+
* sort order. If not set, then no prior elements exist.
|
|
10298
|
+
*/
|
|
10299
|
+
prev_cursor?: string;
|
|
10330
10300
|
/** The search results. */
|
|
10331
10301
|
results: SearchResult[];
|
|
10332
10302
|
}
|
|
@@ -13587,6 +13557,9 @@ export interface WebhookEventRequest {
|
|
|
13587
13557
|
part_created?: EventPartCreated;
|
|
13588
13558
|
part_deleted?: EventPartDeleted;
|
|
13589
13559
|
part_updated?: EventPartUpdated;
|
|
13560
|
+
question_answer_created?: EventQuestionAnswerCreated;
|
|
13561
|
+
question_answer_deleted?: EventQuestionAnswerDeleted;
|
|
13562
|
+
question_answer_updated?: EventQuestionAnswerUpdated;
|
|
13590
13563
|
rev_org_created?: EventRevOrgCreated;
|
|
13591
13564
|
rev_org_deleted?: EventRevOrgDeleted;
|
|
13592
13565
|
rev_org_updated?: EventRevOrgUpdated;
|
|
@@ -13668,6 +13641,9 @@ export declare enum WebhookEventType {
|
|
|
13668
13641
|
PartCreated = "part_created",
|
|
13669
13642
|
PartDeleted = "part_deleted",
|
|
13670
13643
|
PartUpdated = "part_updated",
|
|
13644
|
+
QuestionAnswerCreated = "question_answer_created",
|
|
13645
|
+
QuestionAnswerDeleted = "question_answer_deleted",
|
|
13646
|
+
QuestionAnswerUpdated = "question_answer_updated",
|
|
13671
13647
|
RevOrgCreated = "rev_org_created",
|
|
13672
13648
|
RevOrgDeleted = "rev_org_deleted",
|
|
13673
13649
|
RevOrgUpdated = "rev_org_updated",
|
|
@@ -16171,7 +16147,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
16171
16147
|
*/
|
|
16172
16148
|
devUsersActivate: (data: DevUsersActivateRequest, params?: RequestParams) => Promise<AxiosResponse<DevUsersActivateResponse, any>>;
|
|
16173
16149
|
/**
|
|
16174
|
-
* @description Creates a Dev
|
|
16150
|
+
* @description Creates a Dev user for a Dev organization.
|
|
16175
16151
|
*
|
|
16176
16152
|
* @tags dev-users
|
|
16177
16153
|
* @name DevUsersCreate
|
|
@@ -18280,7 +18256,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
18280
18256
|
*/
|
|
18281
18257
|
linkRevUserToRevOrg: (data: LinkRevUserToRevOrgRequest, params?: RequestParams) => Promise<AxiosResponse<LinkRevUserToRevOrgResponse, any>>;
|
|
18282
18258
|
/**
|
|
18283
|
-
* @description Returns a list of all Rev Users belonging to the authenticated user's Dev
|
|
18259
|
+
* @description Returns a list of all Rev Users belonging to the authenticated user's Dev organization.
|
|
18284
18260
|
*
|
|
18285
18261
|
* @tags rev-users
|
|
18286
18262
|
* @name RevUsersList
|
|
@@ -18358,7 +18334,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
18358
18334
|
tags?: string[];
|
|
18359
18335
|
}, params?: RequestParams) => Promise<AxiosResponse<RevUsersListResponse, any>>;
|
|
18360
18336
|
/**
|
|
18361
|
-
* @description Returns a list of all Rev Users belonging to the authenticated user's Dev
|
|
18337
|
+
* @description Returns a list of all Rev Users belonging to the authenticated user's Dev organization.
|
|
18362
18338
|
*
|
|
18363
18339
|
* @tags rev-users
|
|
18364
18340
|
* @name RevUsersListPost
|
|
@@ -18750,8 +18726,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
18750
18726
|
*/
|
|
18751
18727
|
query: string;
|
|
18752
18728
|
/**
|
|
18753
|
-
* The cursor
|
|
18754
|
-
*
|
|
18729
|
+
* The cursor to resume iteration from. If not provided, then iteration
|
|
18730
|
+
* starts from the beginning.
|
|
18755
18731
|
*/
|
|
18756
18732
|
cursor?: string | undefined;
|
|
18757
18733
|
/**
|
|
@@ -18759,6 +18735,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
18759
18735
|
* @format int32
|
|
18760
18736
|
*/
|
|
18761
18737
|
limit?: number | undefined;
|
|
18738
|
+
/**
|
|
18739
|
+
* The iteration mode to use, otherwise if not set, then "after" is
|
|
18740
|
+
* used.
|
|
18741
|
+
*/
|
|
18742
|
+
mode?: ListMode | undefined;
|
|
18762
18743
|
/** The namespaces to search in. */
|
|
18763
18744
|
namespaces?: SearchNamespace[] | undefined;
|
|
18764
18745
|
/**
|
|
@@ -33,7 +33,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
|
33
33
|
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
34
34
|
};
|
|
35
35
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
36
|
-
exports.GroupIngestionSource = exports.GenericNotificationEventType = exports.FieldValueType = exports.ExternalSystemType = exports.EventSourceStatus = exports.EventFetchedResult = exports.ErrorUnauthorizedType = exports.ErrorTooManyRequestsType = exports.ErrorServiceUnavailableType = exports.ErrorNotFoundType = exports.ErrorInternalServerErrorType = exports.ErrorForbiddenType = exports.ErrorConflictType = exports.ErrorBadRequestUnexpectedJsonTypeType = exports.ErrorBadRequestType = exports.EngagementsCreateRequestEngagementType = exports.EngagementType = exports.
|
|
36
|
+
exports.GroupIngestionSource = exports.GenericNotificationEventType = exports.FieldValueType = exports.ExternalSystemType = exports.EventSourceStatus = exports.EventFetchedResult = exports.ErrorUnauthorizedType = exports.ErrorTooManyRequestsType = exports.ErrorServiceUnavailableType = exports.ErrorNotFoundType = exports.ErrorInternalServerErrorType = exports.ErrorForbiddenType = exports.ErrorConflictType = exports.ErrorBadRequestUnexpectedJsonTypeType = exports.ErrorBadRequestType = exports.EngagementsCreateRequestEngagementType = exports.EngagementType = exports.DevUsersCreateRequestStateEnumValue = exports.DevUserJobTitle = exports.DevOrgAuthConnectionsUpdateRequestType = exports.DevOrgAuthConnectionsCreateRequestType = exports.Definedness = exports.DateTimePresetType = exports.DateFilterType = exports.CustomSchemaFragmentsSetRequestType = exports.CustomSchemaFragmentsListRequestPrune = exports.CustomSchemaFragmentType = exports.CustomSchemaFragmentFragmentType = exports.ConversationsCreateRequestTypeValue = exports.CommandSurfaceSurface = exports.CommandSurfaceObjectTypes = exports.CommandStatus = exports.CommandActionTemplateType = exports.CommandActionExecutorType = exports.CodeChangeSource = exports.ChatCompletionsRequestMessageRole = exports.BooleanExpressionType = exports.AuthTokenTokenType = exports.AuthTokenSubjectTokenType = exports.AuthTokenStatus = exports.AuthTokenRequestedTokenType = exports.AuthTokenGrantType = exports.AuthConnectionType = exports.AuthConnectionToggle = exports.AtomType = exports.AssociatedToType = exports.ArticleType = exports.ArticleStatus = exports.AggregationDetailAggregationType = exports.AccessLevel = void 0;
|
|
37
37
|
exports.SnapWidgetsCreateRequestType = exports.SnapWidgetType = exports.SnapWidgetStatus = exports.SnapWidgetNamespace = exports.SlasFilterAppliesToOperatorType = exports.SlaType = exports.SlaTrackerAppliesToType = exports.SlaSummaryStage = exports.SlaStatus = exports.SlaSelectorSeverity = exports.SlaSelectorPriority = exports.SlaSelectorAppliesTo = exports.SlaEvaluationPeriod = exports.SlaAppliesTo = exports.SendNotificationType = exports.SearchSortOrderParam = exports.SearchSortByParam = exports.SearchResultType = exports.SearchNamespace = exports.SearchHybridNamespace = exports.SchemasSubtypePrepareUpdateGetResponseConflictType = exports.SchemaFieldDescriptorFieldType = exports.SchemaFieldDescriptorArrayTypeBaseType = exports.RoleTarget = exports.RolePrivileges = exports.ReactionsUpdateRequestAction = exports.QuestionAnswerStatus = exports.PreferencesType = exports.PartType = exports.OrgType = exports.OrgScheduleStatus = exports.OrgScheduleFragmentStatus = exports.OrgEnvironment = exports.OpportunityPriority = exports.OpportunityForecastCategory = exports.MetricDefinitionStatus = exports.MetricDefinitionMetricType = exports.MetricDefinitionAppliesTo = exports.MetricActionExecuteRequestAction = exports.MemberType = exports.MeetingState = exports.MeetingChannel = exports.ListMode = exports.LinksDirection = exports.LinkType = exports.LinkEndpointType = exports.IssuePriority = exports.GroupedVistaFlavor = exports.GroupType = exports.GroupMemberType = void 0;
|
|
38
38
|
exports.Api = exports.HttpClient = exports.ContentType = exports.WorkType = exports.WebhooksUpdateAction = exports.WebhookStatus = exports.WebhookEventType = exports.VistaType = exports.VistaGroupItemType = exports.VistaGroupItemState = exports.UserType = exports.UserState = exports.UomMetricScope = exports.UnitType = exports.TuringSourcesType = exports.TimelineEntryVisibility = exports.TimelineEntryType = exports.TimelineEntryPanel = exports.TimelineEntryObjectType = exports.TimelineEntriesUpdateRequestType = exports.TimelineEntriesCreateRequestType = exports.TimelineEntriesCollection = exports.TimelineCommentBodyType = exports.TimelineChangeEventEventType = exports.TicketSeverity = exports.TicketChannels = exports.TaskPriority = exports.SyncUnitSyncType = exports.SyncRunStartedBy = exports.SyncRunProgressState = exports.SyncRunMode = exports.SyncProgressState = exports.SyncOutStatus = exports.SyncMetadataFilterSyncOutFilterStatus = exports.SyncMetadataFilterSyncInFilterStatus = exports.SyncInStatus = exports.StockSchemaFragmentsListRequestPrune = exports.StockSchemaFragmentsListRequestFilterPreset = exports.StageValidationOptionForUpdate = exports.StageValidationOptionForCreate = void 0;
|
|
39
39
|
var AccessLevel;
|
|
@@ -112,6 +112,7 @@ var AtomType;
|
|
|
112
112
|
AtomType["Meeting"] = "meeting";
|
|
113
113
|
AtomType["Opportunity"] = "opportunity";
|
|
114
114
|
AtomType["Product"] = "product";
|
|
115
|
+
AtomType["QuestionAnswer"] = "question_answer";
|
|
115
116
|
AtomType["RevOrg"] = "rev_org";
|
|
116
117
|
AtomType["RevUser"] = "rev_user";
|
|
117
118
|
AtomType["ServiceAccount"] = "service_account";
|
|
@@ -345,10 +346,10 @@ var DevUserJobTitle;
|
|
|
345
346
|
DevUserJobTitle["Support"] = "support";
|
|
346
347
|
DevUserJobTitle["TechLead"] = "tech_lead";
|
|
347
348
|
})(DevUserJobTitle = exports.DevUserJobTitle || (exports.DevUserJobTitle = {}));
|
|
348
|
-
var
|
|
349
|
-
(function (
|
|
350
|
-
|
|
351
|
-
})(
|
|
349
|
+
var DevUsersCreateRequestStateEnumValue;
|
|
350
|
+
(function (DevUsersCreateRequestStateEnumValue) {
|
|
351
|
+
DevUsersCreateRequestStateEnumValue["Shadow"] = "shadow";
|
|
352
|
+
})(DevUsersCreateRequestStateEnumValue = exports.DevUsersCreateRequestStateEnumValue || (exports.DevUsersCreateRequestStateEnumValue = {}));
|
|
352
353
|
/** Type of engagement. */
|
|
353
354
|
var EngagementType;
|
|
354
355
|
(function (EngagementType) {
|
|
@@ -729,91 +730,21 @@ var RolePrivileges;
|
|
|
729
730
|
/** Target object type of the role. */
|
|
730
731
|
var RoleTarget;
|
|
731
732
|
(function (RoleTarget) {
|
|
732
|
-
RoleTarget["AccessControlEntry"] = "access_control_entry";
|
|
733
|
-
RoleTarget["Account"] = "account";
|
|
734
|
-
RoleTarget["AccountCommerceDetails"] = "account_commerce_details";
|
|
735
|
-
RoleTarget["AddonRule"] = "addon_rule";
|
|
736
|
-
RoleTarget["AiAgent"] = "ai_agent";
|
|
737
|
-
RoleTarget["AiAgentSession"] = "ai_agent_session";
|
|
738
|
-
RoleTarget["AiAssistantChat"] = "ai_assistant_chat";
|
|
739
|
-
RoleTarget["AppFragment"] = "app_fragment";
|
|
740
733
|
RoleTarget["Article"] = "article";
|
|
741
734
|
RoleTarget["Artifact"] = "artifact";
|
|
742
735
|
RoleTarget["Capability"] = "capability";
|
|
743
|
-
RoleTarget["Channel"] = "channel";
|
|
744
|
-
RoleTarget["Command"] = "command";
|
|
745
|
-
RoleTarget["Comment"] = "comment";
|
|
746
736
|
RoleTarget["Conversation"] = "conversation";
|
|
747
|
-
RoleTarget["Credit"] = "credit";
|
|
748
|
-
RoleTarget["CreditCoupon"] = "credit_coupon";
|
|
749
|
-
RoleTarget["CustomObject"] = "custom_object";
|
|
750
|
-
RoleTarget["CustomPart"] = "custom_part";
|
|
751
|
-
RoleTarget["CustomStage"] = "custom_stage";
|
|
752
|
-
RoleTarget["CustomState"] = "custom_state";
|
|
753
|
-
RoleTarget["CustomTypeFragment"] = "custom_type_fragment";
|
|
754
|
-
RoleTarget["Dashboard"] = "dashboard";
|
|
755
|
-
RoleTarget["Dataset"] = "dataset";
|
|
756
|
-
RoleTarget["DevOrg"] = "dev_org";
|
|
757
737
|
RoleTarget["DevUser"] = "dev_user";
|
|
758
|
-
RoleTarget["Directory"] = "directory";
|
|
759
|
-
RoleTarget["DiscoveryRun"] = "discovery_run";
|
|
760
|
-
RoleTarget["Dm"] = "dm";
|
|
761
|
-
RoleTarget["Enhancement"] = "enhancement";
|
|
762
|
-
RoleTarget["ExternalSyncUnit"] = "external_sync_unit";
|
|
763
738
|
RoleTarget["Feature"] = "feature";
|
|
764
|
-
RoleTarget["Flow"] = "flow";
|
|
765
739
|
RoleTarget["Group"] = "group";
|
|
766
|
-
RoleTarget["Incident"] = "incident";
|
|
767
|
-
RoleTarget["Invoice"] = "invoice";
|
|
768
740
|
RoleTarget["Issue"] = "issue";
|
|
769
|
-
RoleTarget["Job"] = "job";
|
|
770
|
-
RoleTarget["Keyring"] = "keyring";
|
|
771
|
-
RoleTarget["LicenseAssignment"] = "license_assignment";
|
|
772
|
-
RoleTarget["Link"] = "link";
|
|
773
741
|
RoleTarget["Linkable"] = "linkable";
|
|
774
|
-
RoleTarget["Marketplace"] = "marketplace";
|
|
775
|
-
RoleTarget["MarketplaceCategory"] = "marketplace_category";
|
|
776
|
-
RoleTarget["MarketplaceItem"] = "marketplace_item";
|
|
777
|
-
RoleTarget["MarketplaceSubmission"] = "marketplace_submission";
|
|
778
742
|
RoleTarget["Meeting"] = "meeting";
|
|
779
|
-
RoleTarget["MetricSet"] = "metric_set";
|
|
780
|
-
RoleTarget["OasisData"] = "oasis_data";
|
|
781
|
-
RoleTarget["ObjectMember"] = "object_member";
|
|
782
743
|
RoleTarget["Opportunity"] = "opportunity";
|
|
783
|
-
RoleTarget["OrgPreferences"] = "org_preferences";
|
|
784
|
-
RoleTarget["PaymentMethodCard"] = "payment_method_card";
|
|
785
|
-
RoleTarget["PortalPreferences"] = "portal_preferences";
|
|
786
|
-
RoleTarget["Pricing"] = "pricing";
|
|
787
744
|
RoleTarget["Product"] = "product";
|
|
788
|
-
RoleTarget["QuestionAnswer"] = "question_answer";
|
|
789
|
-
RoleTarget["Quote"] = "quote";
|
|
790
|
-
RoleTarget["RecordTemplate"] = "record_template";
|
|
791
|
-
RoleTarget["RevOrg"] = "rev_org";
|
|
792
745
|
RoleTarget["RevUser"] = "rev_user";
|
|
793
|
-
RoleTarget["RevoConfig"] = "revo_config";
|
|
794
|
-
RoleTarget["Role"] = "role";
|
|
795
|
-
RoleTarget["RoleSet"] = "role_set";
|
|
796
746
|
RoleTarget["Runnable"] = "runnable";
|
|
797
|
-
RoleTarget["Score"] = "score";
|
|
798
|
-
RoleTarget["ServicePlan"] = "service_plan";
|
|
799
|
-
RoleTarget["Sku"] = "sku";
|
|
800
|
-
RoleTarget["SkuRule"] = "sku_rule";
|
|
801
|
-
RoleTarget["SnapIn"] = "snap_in";
|
|
802
|
-
RoleTarget["SnapWidget"] = "snap_widget";
|
|
803
|
-
RoleTarget["StageDiagram"] = "stage_diagram";
|
|
804
|
-
RoleTarget["SvcAcc"] = "svc_acc";
|
|
805
|
-
RoleTarget["SyncHistory"] = "sync_history";
|
|
806
|
-
RoleTarget["SyncMapperRecord"] = "sync_mapper_record";
|
|
807
|
-
RoleTarget["SyncUnit"] = "sync_unit";
|
|
808
|
-
RoleTarget["Task"] = "task";
|
|
809
|
-
RoleTarget["TenantFragment"] = "tenant_fragment";
|
|
810
747
|
RoleTarget["Ticket"] = "ticket";
|
|
811
|
-
RoleTarget["Token"] = "token";
|
|
812
|
-
RoleTarget["Uom"] = "uom";
|
|
813
|
-
RoleTarget["Vista"] = "vista";
|
|
814
|
-
RoleTarget["Webhook"] = "webhook";
|
|
815
|
-
RoleTarget["Widget"] = "widget";
|
|
816
|
-
RoleTarget["Workflow"] = "workflow";
|
|
817
748
|
})(RoleTarget = exports.RoleTarget || (exports.RoleTarget = {}));
|
|
818
749
|
var SchemaFieldDescriptorArrayTypeBaseType;
|
|
819
750
|
(function (SchemaFieldDescriptorArrayTypeBaseType) {
|
|
@@ -1337,6 +1268,9 @@ var WebhookEventType;
|
|
|
1337
1268
|
WebhookEventType["PartCreated"] = "part_created";
|
|
1338
1269
|
WebhookEventType["PartDeleted"] = "part_deleted";
|
|
1339
1270
|
WebhookEventType["PartUpdated"] = "part_updated";
|
|
1271
|
+
WebhookEventType["QuestionAnswerCreated"] = "question_answer_created";
|
|
1272
|
+
WebhookEventType["QuestionAnswerDeleted"] = "question_answer_deleted";
|
|
1273
|
+
WebhookEventType["QuestionAnswerUpdated"] = "question_answer_updated";
|
|
1340
1274
|
WebhookEventType["RevOrgCreated"] = "rev_org_created";
|
|
1341
1275
|
WebhookEventType["RevOrgDeleted"] = "rev_org_deleted";
|
|
1342
1276
|
WebhookEventType["RevOrgUpdated"] = "rev_org_updated";
|
|
@@ -2363,7 +2297,7 @@ class Api extends HttpClient {
|
|
|
2363
2297
|
*/
|
|
2364
2298
|
this.devUsersActivate = (data, params = {}) => this.request(Object.assign({ path: `/dev-users.activate`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
2365
2299
|
/**
|
|
2366
|
-
* @description Creates a Dev
|
|
2300
|
+
* @description Creates a Dev user for a Dev organization.
|
|
2367
2301
|
*
|
|
2368
2302
|
* @tags dev-users
|
|
2369
2303
|
* @name DevUsersCreate
|
|
@@ -3732,7 +3666,7 @@ class Api extends HttpClient {
|
|
|
3732
3666
|
*/
|
|
3733
3667
|
this.linkRevUserToRevOrg = (data, params = {}) => this.request(Object.assign({ path: `/rev-users.link`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
3734
3668
|
/**
|
|
3735
|
-
* @description Returns a list of all Rev Users belonging to the authenticated user's Dev
|
|
3669
|
+
* @description Returns a list of all Rev Users belonging to the authenticated user's Dev organization.
|
|
3736
3670
|
*
|
|
3737
3671
|
* @tags rev-users
|
|
3738
3672
|
* @name RevUsersList
|
|
@@ -3742,7 +3676,7 @@ class Api extends HttpClient {
|
|
|
3742
3676
|
*/
|
|
3743
3677
|
this.revUsersList = (query, params = {}) => this.request(Object.assign({ path: `/rev-users.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
3744
3678
|
/**
|
|
3745
|
-
* @description Returns a list of all Rev Users belonging to the authenticated user's Dev
|
|
3679
|
+
* @description Returns a list of all Rev Users belonging to the authenticated user's Dev organization.
|
|
3746
3680
|
*
|
|
3747
3681
|
* @tags rev-users
|
|
3748
3682
|
* @name RevUsersListPost
|
|
@@ -1939,6 +1939,21 @@ export interface EventPartUpdated {
|
|
|
1939
1939
|
old_part?: Part;
|
|
1940
1940
|
part: Part;
|
|
1941
1941
|
}
|
|
1942
|
+
/** event-question-answer-created */
|
|
1943
|
+
export interface EventQuestionAnswerCreated {
|
|
1944
|
+
question_answer: QuestionAnswer;
|
|
1945
|
+
}
|
|
1946
|
+
/** event-question-answer-deleted */
|
|
1947
|
+
export interface EventQuestionAnswerDeleted {
|
|
1948
|
+
/** The ID of the question-answer that was deleted. */
|
|
1949
|
+
id: string;
|
|
1950
|
+
old_question_answer?: QuestionAnswer;
|
|
1951
|
+
}
|
|
1952
|
+
/** event-question-answer-updated */
|
|
1953
|
+
export interface EventQuestionAnswerUpdated {
|
|
1954
|
+
old_question_answer?: QuestionAnswer;
|
|
1955
|
+
question_answer: QuestionAnswer;
|
|
1956
|
+
}
|
|
1942
1957
|
/** event-rev-org-created */
|
|
1943
1958
|
export interface EventRevOrgCreated {
|
|
1944
1959
|
rev_org: RevOrg;
|
|
@@ -2731,6 +2746,24 @@ export interface PartsUpdateResponse {
|
|
|
2731
2746
|
export type Product = PartBase;
|
|
2732
2747
|
/** product-summary */
|
|
2733
2748
|
export type ProductSummary = PartBaseSummary;
|
|
2749
|
+
/** question-answer */
|
|
2750
|
+
export type QuestionAnswer = AtomBase & {
|
|
2751
|
+
/** The Answer. */
|
|
2752
|
+
answer?: string;
|
|
2753
|
+
/** The Question. */
|
|
2754
|
+
question?: string;
|
|
2755
|
+
/** An alternative answer suggested by the Q/A generation algorithm. */
|
|
2756
|
+
suggested_answer?: string;
|
|
2757
|
+
/**
|
|
2758
|
+
* Whether the Q/A was marked for deletion by the Q/A generation
|
|
2759
|
+
* algorithm.
|
|
2760
|
+
*/
|
|
2761
|
+
suggested_for_deletion?: boolean;
|
|
2762
|
+
/** The topic to which the QA belongs. */
|
|
2763
|
+
topic?: string;
|
|
2764
|
+
/** Whether the Q/A was verified. */
|
|
2765
|
+
verified?: boolean;
|
|
2766
|
+
};
|
|
2734
2767
|
/**
|
|
2735
2768
|
* removed-sla-metric-history
|
|
2736
2769
|
* User, timestamp and metric id of removed metrics.
|
|
@@ -4769,6 +4802,9 @@ export interface WebhookEventRequest {
|
|
|
4769
4802
|
part_created?: EventPartCreated;
|
|
4770
4803
|
part_deleted?: EventPartDeleted;
|
|
4771
4804
|
part_updated?: EventPartUpdated;
|
|
4805
|
+
question_answer_created?: EventQuestionAnswerCreated;
|
|
4806
|
+
question_answer_deleted?: EventQuestionAnswerDeleted;
|
|
4807
|
+
question_answer_updated?: EventQuestionAnswerUpdated;
|
|
4772
4808
|
rev_org_created?: EventRevOrgCreated;
|
|
4773
4809
|
rev_org_deleted?: EventRevOrgDeleted;
|
|
4774
4810
|
rev_org_updated?: EventRevOrgUpdated;
|
|
@@ -4850,6 +4886,9 @@ export declare enum WebhookEventType {
|
|
|
4850
4886
|
PartCreated = "part_created",
|
|
4851
4887
|
PartDeleted = "part_deleted",
|
|
4852
4888
|
PartUpdated = "part_updated",
|
|
4889
|
+
QuestionAnswerCreated = "question_answer_created",
|
|
4890
|
+
QuestionAnswerDeleted = "question_answer_deleted",
|
|
4891
|
+
QuestionAnswerUpdated = "question_answer_updated",
|
|
4853
4892
|
RevOrgCreated = "rev_org_created",
|
|
4854
4893
|
RevOrgDeleted = "rev_org_deleted",
|
|
4855
4894
|
RevOrgUpdated = "rev_org_updated",
|
|
@@ -622,6 +622,9 @@ var WebhookEventType;
|
|
|
622
622
|
WebhookEventType["PartCreated"] = "part_created";
|
|
623
623
|
WebhookEventType["PartDeleted"] = "part_deleted";
|
|
624
624
|
WebhookEventType["PartUpdated"] = "part_updated";
|
|
625
|
+
WebhookEventType["QuestionAnswerCreated"] = "question_answer_created";
|
|
626
|
+
WebhookEventType["QuestionAnswerDeleted"] = "question_answer_deleted";
|
|
627
|
+
WebhookEventType["QuestionAnswerUpdated"] = "question_answer_updated";
|
|
625
628
|
WebhookEventType["RevOrgCreated"] = "rev_org_created";
|
|
626
629
|
WebhookEventType["RevOrgDeleted"] = "rev_org_deleted";
|
|
627
630
|
WebhookEventType["RevOrgUpdated"] = "rev_org_updated";
|