@devrev/typescript-sdk 1.1.11 → 1.1.13
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.
|
@@ -635,6 +635,8 @@ export interface AtomBaseSummary {
|
|
|
635
635
|
/** Globally unique object ID. */
|
|
636
636
|
id: string;
|
|
637
637
|
}
|
|
638
|
+
/** capability */
|
|
639
|
+
export type Capability = PartBase;
|
|
638
640
|
/** capability-summary */
|
|
639
641
|
export type CapabilitySummary = PartBaseSummary;
|
|
640
642
|
/** conversation */
|
|
@@ -1066,6 +1068,11 @@ export interface CustomSchemaFragmentsSetRequestAppFragment {
|
|
|
1066
1068
|
}
|
|
1067
1069
|
/** custom-schema-fragments-set-request-custom-type-fragment */
|
|
1068
1070
|
export interface CustomSchemaFragmentsSetRequestCustomTypeFragment {
|
|
1071
|
+
/**
|
|
1072
|
+
* Path components used to display available custom types in tree
|
|
1073
|
+
* form.
|
|
1074
|
+
*/
|
|
1075
|
+
path?: CustomTypePathComponent[];
|
|
1069
1076
|
/** The ID of the associated custom stage diagram. */
|
|
1070
1077
|
stage_diagram?: string;
|
|
1071
1078
|
/** List of stock field enum overrides. */
|
|
@@ -1089,6 +1096,11 @@ export interface CustomSchemaFragmentsSetResponse {
|
|
|
1089
1096
|
}
|
|
1090
1097
|
/** custom-type-fragment */
|
|
1091
1098
|
export type CustomTypeFragment = CustomSchemaFragmentBase;
|
|
1099
|
+
/**
|
|
1100
|
+
* custom-type-path-component
|
|
1101
|
+
* Path component for rendering custom type lists in tree form.
|
|
1102
|
+
*/
|
|
1103
|
+
export type CustomTypePathComponent = object;
|
|
1092
1104
|
/**
|
|
1093
1105
|
* date-filter
|
|
1094
1106
|
* Provides ways to specify date ranges on objects.
|
|
@@ -1359,6 +1371,14 @@ export interface EngagementsUpdateRequestTags {
|
|
|
1359
1371
|
export interface EngagementsUpdateResponse {
|
|
1360
1372
|
engagement: Engagement;
|
|
1361
1373
|
}
|
|
1374
|
+
/** enhancement */
|
|
1375
|
+
export type Enhancement = PartBase & {
|
|
1376
|
+
/**
|
|
1377
|
+
* Timestamp when the enhancement is expected to be closed.
|
|
1378
|
+
* @format date-time
|
|
1379
|
+
*/
|
|
1380
|
+
target_close_date?: string;
|
|
1381
|
+
};
|
|
1362
1382
|
/** enhancement-summary */
|
|
1363
1383
|
export type EnhancementSummary = PartBaseSummary;
|
|
1364
1384
|
/** error */
|
|
@@ -1486,6 +1506,64 @@ export declare enum ErrorUnauthorizedType {
|
|
|
1486
1506
|
}
|
|
1487
1507
|
/** error-unauthorized-unauthenticated */
|
|
1488
1508
|
export type ErrorUnauthorizedUnauthenticated = object;
|
|
1509
|
+
/** event-conversation-created */
|
|
1510
|
+
export interface EventConversationCreated {
|
|
1511
|
+
conversation: Conversation;
|
|
1512
|
+
}
|
|
1513
|
+
/** event-conversation-deleted */
|
|
1514
|
+
export interface EventConversationDeleted {
|
|
1515
|
+
/** The ID of the conversation that was deleted. */
|
|
1516
|
+
id: string;
|
|
1517
|
+
}
|
|
1518
|
+
/** event-conversation-updated */
|
|
1519
|
+
export interface EventConversationUpdated {
|
|
1520
|
+
conversation: Conversation;
|
|
1521
|
+
}
|
|
1522
|
+
/** event-part-created */
|
|
1523
|
+
export interface EventPartCreated {
|
|
1524
|
+
part: Part;
|
|
1525
|
+
}
|
|
1526
|
+
/** event-part-deleted */
|
|
1527
|
+
export interface EventPartDeleted {
|
|
1528
|
+
/**
|
|
1529
|
+
* The ID of the part that was deleted.
|
|
1530
|
+
* @example "don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"
|
|
1531
|
+
*/
|
|
1532
|
+
id: string;
|
|
1533
|
+
}
|
|
1534
|
+
/** event-part-updated */
|
|
1535
|
+
export interface EventPartUpdated {
|
|
1536
|
+
part: Part;
|
|
1537
|
+
}
|
|
1538
|
+
/** event-rev-org-created */
|
|
1539
|
+
export interface EventRevOrgCreated {
|
|
1540
|
+
rev_org: RevOrg;
|
|
1541
|
+
}
|
|
1542
|
+
/** event-rev-org-deleted */
|
|
1543
|
+
export interface EventRevOrgDeleted {
|
|
1544
|
+
/**
|
|
1545
|
+
* The ID of the Rev organization that was deleted.
|
|
1546
|
+
* @example "don:identity:<partition>:devo/<dev-org-id>:revo/<rev-org-id>"
|
|
1547
|
+
*/
|
|
1548
|
+
id: string;
|
|
1549
|
+
}
|
|
1550
|
+
/** event-rev-org-updated */
|
|
1551
|
+
export interface EventRevOrgUpdated {
|
|
1552
|
+
rev_org: RevOrg;
|
|
1553
|
+
}
|
|
1554
|
+
/** event-rev-user-created */
|
|
1555
|
+
export interface EventRevUserCreated {
|
|
1556
|
+
rev_user: RevUser;
|
|
1557
|
+
}
|
|
1558
|
+
/** event-rev-user-deleted */
|
|
1559
|
+
export interface EventRevUserDeleted {
|
|
1560
|
+
/** The ID of the Rev user that was deleted. */
|
|
1561
|
+
id: string;
|
|
1562
|
+
}
|
|
1563
|
+
/** event-rev-user-updated */
|
|
1564
|
+
export interface EventRevUserUpdated {
|
|
1565
|
+
rev_user: RevUser;
|
|
1566
|
+
}
|
|
1489
1567
|
/** event-source */
|
|
1490
1568
|
export type EventSource = AtomBase & {
|
|
1491
1569
|
/**
|
|
@@ -1580,6 +1658,72 @@ export interface EventSourcesScheduleEventResponse {
|
|
|
1580
1658
|
*/
|
|
1581
1659
|
event_key?: string;
|
|
1582
1660
|
}
|
|
1661
|
+
/** event-tag-created */
|
|
1662
|
+
export interface EventTagCreated {
|
|
1663
|
+
tag: Tag;
|
|
1664
|
+
}
|
|
1665
|
+
/** event-tag-deleted */
|
|
1666
|
+
export interface EventTagDeleted {
|
|
1667
|
+
/**
|
|
1668
|
+
* The ID of the tag that was deleted.
|
|
1669
|
+
* @example "don:core:<partition>:devo/<dev-org-id>:tag/<tag-id>"
|
|
1670
|
+
*/
|
|
1671
|
+
id: string;
|
|
1672
|
+
}
|
|
1673
|
+
/** event-tag-updated */
|
|
1674
|
+
export interface EventTagUpdated {
|
|
1675
|
+
tag: Tag;
|
|
1676
|
+
}
|
|
1677
|
+
/** event-timeline-entry-created */
|
|
1678
|
+
export interface EventTimelineEntryCreated {
|
|
1679
|
+
entry: TimelineEntry;
|
|
1680
|
+
}
|
|
1681
|
+
/** event-timeline-entry-deleted */
|
|
1682
|
+
export interface EventTimelineEntryDeleted {
|
|
1683
|
+
/**
|
|
1684
|
+
* The ID of the timeline entry that was deleted.
|
|
1685
|
+
* @example "don:core:<partition>:devo/<dev-org-id>:ticket/123:timeline_event/<timeline-event-id>"
|
|
1686
|
+
*/
|
|
1687
|
+
id: string;
|
|
1688
|
+
}
|
|
1689
|
+
/** event-timeline-entry-updated */
|
|
1690
|
+
export interface EventTimelineEntryUpdated {
|
|
1691
|
+
entry: TimelineEntry;
|
|
1692
|
+
}
|
|
1693
|
+
/** event-webhook-created */
|
|
1694
|
+
export interface EventWebhookCreated {
|
|
1695
|
+
webhook: Webhook;
|
|
1696
|
+
}
|
|
1697
|
+
/** event-webhook-deleted */
|
|
1698
|
+
export interface EventWebhookDeleted {
|
|
1699
|
+
/**
|
|
1700
|
+
* The ID of the webhook that was deleted.
|
|
1701
|
+
* @example "don:integration:<partition>:devo/<dev-org-id>:webhook/<webhook-id>"
|
|
1702
|
+
*/
|
|
1703
|
+
id: string;
|
|
1704
|
+
}
|
|
1705
|
+
/** event-webhook-updated */
|
|
1706
|
+
export interface EventWebhookUpdated {
|
|
1707
|
+
webhook: Webhook;
|
|
1708
|
+
}
|
|
1709
|
+
/** event-work-created */
|
|
1710
|
+
export interface EventWorkCreated {
|
|
1711
|
+
work: Work;
|
|
1712
|
+
}
|
|
1713
|
+
/** event-work-deleted */
|
|
1714
|
+
export interface EventWorkDeleted {
|
|
1715
|
+
/**
|
|
1716
|
+
* The ID of the work that was deleted.
|
|
1717
|
+
* @example "don:core:<partition>:devo/<dev-org-id>:<work-type>/<work-id>"
|
|
1718
|
+
*/
|
|
1719
|
+
id: string;
|
|
1720
|
+
}
|
|
1721
|
+
/** event-work-updated */
|
|
1722
|
+
export interface EventWorkUpdated {
|
|
1723
|
+
work: Work;
|
|
1724
|
+
}
|
|
1725
|
+
/** feature */
|
|
1726
|
+
export type Feature = PartBase;
|
|
1583
1727
|
/** feature-summary */
|
|
1584
1728
|
export type FeatureSummary = PartBaseSummary;
|
|
1585
1729
|
/**
|
|
@@ -1974,11 +2118,11 @@ export interface MetricDefinitionsListResponse {
|
|
|
1974
2118
|
export type Opportunity = WorkBase;
|
|
1975
2119
|
/** Forecast category of the opportunity. */
|
|
1976
2120
|
export declare enum OpportunityForecastCategory {
|
|
1977
|
-
BestCase = "best_case",
|
|
1978
2121
|
Commit = "commit",
|
|
1979
|
-
MostLikely = "most_likely",
|
|
1980
2122
|
Omitted = "omitted",
|
|
1981
2123
|
Pipeline = "pipeline",
|
|
2124
|
+
StrongUpside = "strong_upside",
|
|
2125
|
+
Upside = "upside",
|
|
1982
2126
|
Won = "won"
|
|
1983
2127
|
}
|
|
1984
2128
|
/** Priority of the opportunity. */
|
|
@@ -2320,6 +2464,35 @@ export declare enum OrgType {
|
|
|
2320
2464
|
Account = "account",
|
|
2321
2465
|
RevOrg = "rev_org"
|
|
2322
2466
|
}
|
|
2467
|
+
/** part */
|
|
2468
|
+
export type Part = (Capability | Enhancement | Feature | Product) & {
|
|
2469
|
+
type: PartType;
|
|
2470
|
+
};
|
|
2471
|
+
/** part-base */
|
|
2472
|
+
export type PartBase = AtomBase & {
|
|
2473
|
+
/** The attached artifacts. */
|
|
2474
|
+
artifacts?: ArtifactSummary[];
|
|
2475
|
+
/** Custom fields. */
|
|
2476
|
+
custom_fields?: object;
|
|
2477
|
+
/**
|
|
2478
|
+
* Custom schema fragments.
|
|
2479
|
+
* @example ["don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"]
|
|
2480
|
+
*/
|
|
2481
|
+
custom_schema_fragments?: string[];
|
|
2482
|
+
/** Description of the part. */
|
|
2483
|
+
description?: string;
|
|
2484
|
+
/** Name of the part. */
|
|
2485
|
+
name: string;
|
|
2486
|
+
/** The users that own the part. */
|
|
2487
|
+
owned_by: UserSummary[];
|
|
2488
|
+
/**
|
|
2489
|
+
* Stock schema fragment.
|
|
2490
|
+
* @example "don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"
|
|
2491
|
+
*/
|
|
2492
|
+
stock_schema_fragment?: string;
|
|
2493
|
+
/** Tags associated with the object. */
|
|
2494
|
+
tags?: TagWithValue[];
|
|
2495
|
+
};
|
|
2323
2496
|
/** part-base-summary */
|
|
2324
2497
|
export type PartBaseSummary = AtomBaseSummary & {
|
|
2325
2498
|
/** Name of the part. */
|
|
@@ -2335,6 +2508,8 @@ export declare enum PartType {
|
|
|
2335
2508
|
Feature = "feature",
|
|
2336
2509
|
Product = "product"
|
|
2337
2510
|
}
|
|
2511
|
+
/** product */
|
|
2512
|
+
export type Product = PartBase;
|
|
2338
2513
|
/** product-summary */
|
|
2339
2514
|
export type ProductSummary = PartBaseSummary;
|
|
2340
2515
|
/**
|
|
@@ -2430,11 +2605,17 @@ export interface RevOrgsCreateResponse {
|
|
|
2430
2605
|
* Request object to get Rev organization's information.
|
|
2431
2606
|
*/
|
|
2432
2607
|
export interface RevOrgsGetRequest {
|
|
2608
|
+
/**
|
|
2609
|
+
* The ID of account for which default Rev organization is to be
|
|
2610
|
+
* fetched.
|
|
2611
|
+
* @example "don:core:<partition>:devo/<dev-org-id>:account/<account-id>"
|
|
2612
|
+
*/
|
|
2613
|
+
account?: string;
|
|
2433
2614
|
/**
|
|
2434
2615
|
* The ID of the required Rev organization.
|
|
2435
2616
|
* @example "don:identity:<partition>:devo/<dev-org-id>:revo/<rev-org-id>"
|
|
2436
2617
|
*/
|
|
2437
|
-
id
|
|
2618
|
+
id?: string;
|
|
2438
2619
|
}
|
|
2439
2620
|
/**
|
|
2440
2621
|
* rev-orgs-get-response
|
|
@@ -2694,6 +2875,8 @@ export interface RevUsersListRequest {
|
|
|
2694
2875
|
email?: string[];
|
|
2695
2876
|
/** List of external refs to filter Rev users for. */
|
|
2696
2877
|
external_ref?: string[];
|
|
2878
|
+
/** Value of is_verified field to filter the Rev users. */
|
|
2879
|
+
is_verified?: boolean;
|
|
2697
2880
|
/**
|
|
2698
2881
|
* The maximum number of Rev users to return. The default is '50'.
|
|
2699
2882
|
* @format int32
|
|
@@ -3652,6 +3835,26 @@ export interface SysUsersUpdateRequest {
|
|
|
3652
3835
|
export interface SysUsersUpdateResponse {
|
|
3653
3836
|
sys_user: SysUser;
|
|
3654
3837
|
}
|
|
3838
|
+
/** tag */
|
|
3839
|
+
export type Tag = AtomBase & {
|
|
3840
|
+
/**
|
|
3841
|
+
* The allowed values for the tag, where a value is provided when a
|
|
3842
|
+
* tag is associated with an object. If empty, then no value should be
|
|
3843
|
+
* provided when the association is made.
|
|
3844
|
+
*/
|
|
3845
|
+
allowed_values?: string[];
|
|
3846
|
+
/**
|
|
3847
|
+
* An informative description for the tag that should provide context
|
|
3848
|
+
* on the tag's purpose and usage.
|
|
3849
|
+
*/
|
|
3850
|
+
description?: string;
|
|
3851
|
+
/**
|
|
3852
|
+
* The name of the tag, which denotes the logical concept by which all
|
|
3853
|
+
* tagged objects will be associated. The name is guaranteed to be
|
|
3854
|
+
* unique.
|
|
3855
|
+
*/
|
|
3856
|
+
name: string;
|
|
3857
|
+
};
|
|
3655
3858
|
/** tag-summary */
|
|
3656
3859
|
export type TagSummary = AtomBaseSummary & {
|
|
3657
3860
|
/**
|
|
@@ -4122,6 +4325,113 @@ export declare enum UserType {
|
|
|
4122
4325
|
ServiceAccount = "service_account",
|
|
4123
4326
|
SysUser = "sys_user"
|
|
4124
4327
|
}
|
|
4328
|
+
/** webhook */
|
|
4329
|
+
export type Webhook = AtomBase & {
|
|
4330
|
+
/** The event types that the webhook will receive. */
|
|
4331
|
+
event_types?: WebhookEventType[];
|
|
4332
|
+
/**
|
|
4333
|
+
* The secret to use for verifying webhook events.
|
|
4334
|
+
* @format byte
|
|
4335
|
+
*/
|
|
4336
|
+
secret: string;
|
|
4337
|
+
/** The status of the webhook. */
|
|
4338
|
+
status: WebhookStatus;
|
|
4339
|
+
/** The URL of the webhook endpoint. */
|
|
4340
|
+
url: string;
|
|
4341
|
+
};
|
|
4342
|
+
/** webhook-event-request */
|
|
4343
|
+
export interface WebhookEventRequest {
|
|
4344
|
+
conversation_created?: EventConversationCreated;
|
|
4345
|
+
conversation_deleted?: EventConversationDeleted;
|
|
4346
|
+
conversation_updated?: EventConversationUpdated;
|
|
4347
|
+
/** The event's ID. */
|
|
4348
|
+
id: string;
|
|
4349
|
+
part_created?: EventPartCreated;
|
|
4350
|
+
part_deleted?: EventPartDeleted;
|
|
4351
|
+
part_updated?: EventPartUpdated;
|
|
4352
|
+
rev_org_created?: EventRevOrgCreated;
|
|
4353
|
+
rev_org_deleted?: EventRevOrgDeleted;
|
|
4354
|
+
rev_org_updated?: EventRevOrgUpdated;
|
|
4355
|
+
rev_user_created?: EventRevUserCreated;
|
|
4356
|
+
rev_user_deleted?: EventRevUserDeleted;
|
|
4357
|
+
rev_user_updated?: EventRevUserUpdated;
|
|
4358
|
+
tag_created?: EventTagCreated;
|
|
4359
|
+
tag_deleted?: EventTagDeleted;
|
|
4360
|
+
tag_updated?: EventTagUpdated;
|
|
4361
|
+
timeline_entry_created?: EventTimelineEntryCreated;
|
|
4362
|
+
timeline_entry_deleted?: EventTimelineEntryDeleted;
|
|
4363
|
+
timeline_entry_updated?: EventTimelineEntryUpdated;
|
|
4364
|
+
/**
|
|
4365
|
+
* Timestamp of the webhook's invocation for the event. Note this
|
|
4366
|
+
* should be used to protect against replay attacks, where the event
|
|
4367
|
+
* should only be processed if the timestamp isn't stale by several
|
|
4368
|
+
* seconds.
|
|
4369
|
+
* @format date-time
|
|
4370
|
+
*/
|
|
4371
|
+
timestamp?: string;
|
|
4372
|
+
/** The event types that the webhook will receive. */
|
|
4373
|
+
type?: WebhookEventType;
|
|
4374
|
+
verify?: WebhookEventVerify;
|
|
4375
|
+
webhook_created?: EventWebhookCreated;
|
|
4376
|
+
webhook_deleted?: EventWebhookDeleted;
|
|
4377
|
+
/**
|
|
4378
|
+
* ID of the webhook for the event.
|
|
4379
|
+
* @example "don:integration:<partition>:devo/<dev-org-id>:webhook/<webhook-id>"
|
|
4380
|
+
*/
|
|
4381
|
+
webhook_id: string;
|
|
4382
|
+
webhook_updated?: EventWebhookUpdated;
|
|
4383
|
+
work_created?: EventWorkCreated;
|
|
4384
|
+
work_deleted?: EventWorkDeleted;
|
|
4385
|
+
work_updated?: EventWorkUpdated;
|
|
4386
|
+
}
|
|
4387
|
+
/** webhook-event-response */
|
|
4388
|
+
export interface WebhookEventResponse {
|
|
4389
|
+
/**
|
|
4390
|
+
* The challenge from the "verify" request, otherwise this should not
|
|
4391
|
+
* be set for other request types.
|
|
4392
|
+
* @format byte
|
|
4393
|
+
*/
|
|
4394
|
+
challenge?: string;
|
|
4395
|
+
}
|
|
4396
|
+
/** The event types that the webhook will receive. */
|
|
4397
|
+
export declare enum WebhookEventType {
|
|
4398
|
+
PartCreated = "part_created",
|
|
4399
|
+
PartDeleted = "part_deleted",
|
|
4400
|
+
PartUpdated = "part_updated",
|
|
4401
|
+
RevOrgCreated = "rev_org_created",
|
|
4402
|
+
RevOrgDeleted = "rev_org_deleted",
|
|
4403
|
+
RevOrgUpdated = "rev_org_updated",
|
|
4404
|
+
RevUserCreated = "rev_user_created",
|
|
4405
|
+
RevUserDeleted = "rev_user_deleted",
|
|
4406
|
+
RevUserUpdated = "rev_user_updated",
|
|
4407
|
+
TagCreated = "tag_created",
|
|
4408
|
+
TagDeleted = "tag_deleted",
|
|
4409
|
+
TagUpdated = "tag_updated",
|
|
4410
|
+
TimelineEntryCreated = "timeline_entry_created",
|
|
4411
|
+
TimelineEntryDeleted = "timeline_entry_deleted",
|
|
4412
|
+
TimelineEntryUpdated = "timeline_entry_updated",
|
|
4413
|
+
Verify = "verify",
|
|
4414
|
+
WebhookCreated = "webhook_created",
|
|
4415
|
+
WebhookDeleted = "webhook_deleted",
|
|
4416
|
+
WebhookUpdated = "webhook_updated",
|
|
4417
|
+
WorkCreated = "work_created",
|
|
4418
|
+
WorkDeleted = "work_deleted",
|
|
4419
|
+
WorkUpdated = "work_updated"
|
|
4420
|
+
}
|
|
4421
|
+
/** webhook-event-verify */
|
|
4422
|
+
export interface WebhookEventVerify {
|
|
4423
|
+
/**
|
|
4424
|
+
* The challenge that must be echoed in the response.
|
|
4425
|
+
* @format byte
|
|
4426
|
+
*/
|
|
4427
|
+
challenge: string;
|
|
4428
|
+
}
|
|
4429
|
+
/** The status of the webhook. */
|
|
4430
|
+
export declare enum WebhookStatus {
|
|
4431
|
+
Active = "active",
|
|
4432
|
+
Inactive = "inactive",
|
|
4433
|
+
Unverified = "unverified"
|
|
4434
|
+
}
|
|
4125
4435
|
/**
|
|
4126
4436
|
* weekly-org-schedule
|
|
4127
4437
|
* The schedule for each week.
|
|
@@ -4476,7 +4786,7 @@ export interface WorksListResponse {
|
|
|
4476
4786
|
works: Work[];
|
|
4477
4787
|
}
|
|
4478
4788
|
/** works-update-request */
|
|
4479
|
-
export type WorksUpdateRequest = (WorksUpdateRequestIssue | WorksUpdateRequestOpportunity | WorksUpdateRequestTask | WorksUpdateRequestTicket) & {
|
|
4789
|
+
export type WorksUpdateRequest = (Empty | WorksUpdateRequestIssue | WorksUpdateRequestOpportunity | WorksUpdateRequestTask | WorksUpdateRequestTicket) & {
|
|
4480
4790
|
/**
|
|
4481
4791
|
* Updates the part that the work item applies to.
|
|
4482
4792
|
* @example "don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"
|
|
@@ -4509,7 +4819,7 @@ export type WorksUpdateRequest = (WorksUpdateRequestIssue | WorksUpdateRequestOp
|
|
|
4509
4819
|
target_close_date?: string;
|
|
4510
4820
|
/** Updated title of the work object, or unchanged if not provided. */
|
|
4511
4821
|
title?: string;
|
|
4512
|
-
type
|
|
4822
|
+
type?: WorkType;
|
|
4513
4823
|
};
|
|
4514
4824
|
/** works-update-request-artifact-ids */
|
|
4515
4825
|
export interface WorksUpdateRequestArtifactIds {
|
|
@@ -5724,12 +6034,18 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
5724
6034
|
* @request GET:/rev-orgs.get
|
|
5725
6035
|
* @secure
|
|
5726
6036
|
*/
|
|
5727
|
-
revOrgsGet: (query
|
|
6037
|
+
revOrgsGet: (query?: {
|
|
6038
|
+
/**
|
|
6039
|
+
* The ID of account for which default Rev organization is to be
|
|
6040
|
+
* fetched.
|
|
6041
|
+
* @example "don:core:<partition>:devo/<dev-org-id>:account/<account-id>"
|
|
6042
|
+
*/
|
|
6043
|
+
account?: string;
|
|
5728
6044
|
/**
|
|
5729
6045
|
* The ID of the required Rev organization.
|
|
5730
6046
|
* @example "don:identity:<partition>:devo/<dev-org-id>:revo/<rev-org-id>"
|
|
5731
6047
|
*/
|
|
5732
|
-
id
|
|
6048
|
+
id?: string;
|
|
5733
6049
|
}, params?: RequestParams) => Promise<AxiosResponse<RevOrgsGetResponse, any>>;
|
|
5734
6050
|
/**
|
|
5735
6051
|
* @description Retrieves the Rev organization's information.
|
|
@@ -5903,6 +6219,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
5903
6219
|
email?: string[];
|
|
5904
6220
|
/** List of external refs to filter Rev users for. */
|
|
5905
6221
|
external_ref?: string[];
|
|
6222
|
+
/** Value of is_verified field to filter the Rev users. */
|
|
6223
|
+
is_verified?: boolean;
|
|
5906
6224
|
/**
|
|
5907
6225
|
* The maximum number of Rev users to return. The default is '50'.
|
|
5908
6226
|
* @format int32
|
|
@@ -34,7 +34,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
|
34
34
|
};
|
|
35
35
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
36
36
|
exports.UserType = exports.UserState = exports.TimelineEntryVisibility = exports.TimelineEntryType = exports.TimelineEntryObjectType = exports.TimelineEntriesUpdateRequestType = exports.TimelineEntriesCreateRequestType = exports.TimelineEntriesCollection = exports.TimelineCommentBodyType = exports.TicketSeverity = exports.TaskPriority = exports.SlaStatus = exports.SlaSelectorSeverity = exports.SlaSelectorPriority = exports.SlaSelectorAppliesTo = exports.SlaEvaluationPeriod = exports.SchemaFieldDescriptorFieldType = exports.SchemaFieldDescriptorArrayTypeBaseType = exports.PartType = exports.OrgType = exports.OrgScheduleStatus = exports.OrgScheduleFragmentStatus = exports.OrgEnvironment = exports.OpportunityPriority = exports.OpportunityForecastCategory = exports.MetricDefinitionMetricType = exports.MetricDefinitionAppliesTo = exports.ListMode = exports.LinksDirection = exports.LinkType = exports.LinkEndpointType = exports.IssuePriority = exports.GroupMemberType = exports.EventSourceStatus = exports.ErrorUnauthorizedType = exports.ErrorTooManyRequestsType = exports.ErrorServiceUnavailableType = exports.ErrorNotFoundType = exports.ErrorInternalServerErrorType = exports.ErrorForbiddenType = exports.ErrorBadRequestType = exports.EngagementsCreateRequestEngagementType = exports.EngagementType = exports.DateTimePresetType = exports.DateFilterType = exports.CustomSchemaFragmentsSetRequestType = exports.CustomSchemaFragmentType = exports.ConversationsCreateRequestTypeValue = exports.ArticleStatus = exports.AccessLevel = void 0;
|
|
37
|
-
exports.Api = exports.HttpClient = exports.ContentType = exports.WorkType = void 0;
|
|
37
|
+
exports.Api = exports.HttpClient = exports.ContentType = exports.WorkType = exports.WebhookStatus = exports.WebhookEventType = void 0;
|
|
38
38
|
var AccessLevel;
|
|
39
39
|
(function (AccessLevel) {
|
|
40
40
|
AccessLevel["External"] = "external";
|
|
@@ -224,11 +224,11 @@ var MetricDefinitionMetricType;
|
|
|
224
224
|
/** Forecast category of the opportunity. */
|
|
225
225
|
var OpportunityForecastCategory;
|
|
226
226
|
(function (OpportunityForecastCategory) {
|
|
227
|
-
OpportunityForecastCategory["BestCase"] = "best_case";
|
|
228
227
|
OpportunityForecastCategory["Commit"] = "commit";
|
|
229
|
-
OpportunityForecastCategory["MostLikely"] = "most_likely";
|
|
230
228
|
OpportunityForecastCategory["Omitted"] = "omitted";
|
|
231
229
|
OpportunityForecastCategory["Pipeline"] = "pipeline";
|
|
230
|
+
OpportunityForecastCategory["StrongUpside"] = "strong_upside";
|
|
231
|
+
OpportunityForecastCategory["Upside"] = "upside";
|
|
232
232
|
OpportunityForecastCategory["Won"] = "won";
|
|
233
233
|
})(OpportunityForecastCategory = exports.OpportunityForecastCategory || (exports.OpportunityForecastCategory = {}));
|
|
234
234
|
/** Priority of the opportunity. */
|
|
@@ -446,6 +446,39 @@ var UserType;
|
|
|
446
446
|
UserType["ServiceAccount"] = "service_account";
|
|
447
447
|
UserType["SysUser"] = "sys_user";
|
|
448
448
|
})(UserType = exports.UserType || (exports.UserType = {}));
|
|
449
|
+
/** The event types that the webhook will receive. */
|
|
450
|
+
var WebhookEventType;
|
|
451
|
+
(function (WebhookEventType) {
|
|
452
|
+
WebhookEventType["PartCreated"] = "part_created";
|
|
453
|
+
WebhookEventType["PartDeleted"] = "part_deleted";
|
|
454
|
+
WebhookEventType["PartUpdated"] = "part_updated";
|
|
455
|
+
WebhookEventType["RevOrgCreated"] = "rev_org_created";
|
|
456
|
+
WebhookEventType["RevOrgDeleted"] = "rev_org_deleted";
|
|
457
|
+
WebhookEventType["RevOrgUpdated"] = "rev_org_updated";
|
|
458
|
+
WebhookEventType["RevUserCreated"] = "rev_user_created";
|
|
459
|
+
WebhookEventType["RevUserDeleted"] = "rev_user_deleted";
|
|
460
|
+
WebhookEventType["RevUserUpdated"] = "rev_user_updated";
|
|
461
|
+
WebhookEventType["TagCreated"] = "tag_created";
|
|
462
|
+
WebhookEventType["TagDeleted"] = "tag_deleted";
|
|
463
|
+
WebhookEventType["TagUpdated"] = "tag_updated";
|
|
464
|
+
WebhookEventType["TimelineEntryCreated"] = "timeline_entry_created";
|
|
465
|
+
WebhookEventType["TimelineEntryDeleted"] = "timeline_entry_deleted";
|
|
466
|
+
WebhookEventType["TimelineEntryUpdated"] = "timeline_entry_updated";
|
|
467
|
+
WebhookEventType["Verify"] = "verify";
|
|
468
|
+
WebhookEventType["WebhookCreated"] = "webhook_created";
|
|
469
|
+
WebhookEventType["WebhookDeleted"] = "webhook_deleted";
|
|
470
|
+
WebhookEventType["WebhookUpdated"] = "webhook_updated";
|
|
471
|
+
WebhookEventType["WorkCreated"] = "work_created";
|
|
472
|
+
WebhookEventType["WorkDeleted"] = "work_deleted";
|
|
473
|
+
WebhookEventType["WorkUpdated"] = "work_updated";
|
|
474
|
+
})(WebhookEventType = exports.WebhookEventType || (exports.WebhookEventType = {}));
|
|
475
|
+
/** The status of the webhook. */
|
|
476
|
+
var WebhookStatus;
|
|
477
|
+
(function (WebhookStatus) {
|
|
478
|
+
WebhookStatus["Active"] = "active";
|
|
479
|
+
WebhookStatus["Inactive"] = "inactive";
|
|
480
|
+
WebhookStatus["Unverified"] = "unverified";
|
|
481
|
+
})(WebhookStatus = exports.WebhookStatus || (exports.WebhookStatus = {}));
|
|
449
482
|
var WorkType;
|
|
450
483
|
(function (WorkType) {
|
|
451
484
|
WorkType["Issue"] = "issue";
|
|
@@ -205,6 +205,7 @@ export declare enum AuthTokenRequestedTokenType {
|
|
|
205
205
|
UrnDevrevParamsOauthTokenTypeRev = "urn:devrev:params:oauth:token-type:rev",
|
|
206
206
|
UrnDevrevParamsOauthTokenTypeSession = "urn:devrev:params:oauth:token-type:session",
|
|
207
207
|
UrnDevrevParamsOauthTokenTypeSessionDev0 = "urn:devrev:params:oauth:token-type:session:dev0",
|
|
208
|
+
UrnDevrevParamsOauthTokenTypeSessionOnetime = "urn:devrev:params:oauth:token-type:session:onetime",
|
|
208
209
|
UrnDevrevParamsOauthTokenTypeSys = "urn:devrev:params:oauth:token-type:sys",
|
|
209
210
|
UrnIetfParamsOauthTokenTypeJwt = "urn:ietf:params:oauth:token-type:jwt"
|
|
210
211
|
}
|
|
@@ -219,6 +220,7 @@ export declare enum AuthTokenSubjectTokenType {
|
|
|
219
220
|
UrnDevrevParamsOauthTokenTypeJwtAuth0 = "urn:devrev:params:oauth:token-type:jwt:auth0",
|
|
220
221
|
UrnDevrevParamsOauthTokenTypeJwtDev = "urn:devrev:params:oauth:token-type:jwt:dev",
|
|
221
222
|
UrnDevrevParamsOauthTokenTypeRevinfo = "urn:devrev:params:oauth:token-type:revinfo",
|
|
223
|
+
UrnDevrevParamsOauthTokenTypeSession = "urn:devrev:params:oauth:token-type:session",
|
|
222
224
|
UrnDevrevParamsOauthTokenTypeSysu = "urn:devrev:params:oauth:token-type:sysu",
|
|
223
225
|
UrnDevrevParamsOauthTokenTypeUserinfo = "urn:devrev:params:oauth:token-type:userinfo",
|
|
224
226
|
UrnDevrevParamsOauthTokenTypeUserinfoProfile = "urn:devrev:params:oauth:token-type:userinfo:profile",
|
|
@@ -495,7 +497,7 @@ export interface DevOrgAuthConnectionsToggleRequest {
|
|
|
495
497
|
* Request to update an enterprise authentication connection for a Dev
|
|
496
498
|
* organization.
|
|
497
499
|
*/
|
|
498
|
-
export type DevOrgAuthConnectionsUpdateRequest = (AuthConnectionOptionsAzureAd | AuthConnectionOptionsGoogleApps | AuthConnectionOptionsOidc | AuthConnectionOptionsSaml) & {
|
|
500
|
+
export type DevOrgAuthConnectionsUpdateRequest = (AuthConnectionOptionsAzureAd | AuthConnectionOptionsGoogleApps | AuthConnectionOptionsOidc | AuthConnectionOptionsSaml | Empty) & {
|
|
499
501
|
/**
|
|
500
502
|
* New display name of the authentication connection. This name will
|
|
501
503
|
* be visible to all the users when they sign in to this Dev
|
|
@@ -510,7 +512,7 @@ export type DevOrgAuthConnectionsUpdateRequest = (AuthConnectionOptionsAzureAd |
|
|
|
510
512
|
* of authentication connections have different configuration parameters
|
|
511
513
|
* that can be updated.
|
|
512
514
|
*/
|
|
513
|
-
type
|
|
515
|
+
type?: DevOrgAuthConnectionsUpdateRequestType;
|
|
514
516
|
};
|
|
515
517
|
/**
|
|
516
518
|
* Specifies the type for the authentication connection. Different types
|
|
@@ -984,7 +986,7 @@ export interface PartsListResponse {
|
|
|
984
986
|
prev_cursor?: string;
|
|
985
987
|
}
|
|
986
988
|
/** parts-update-request */
|
|
987
|
-
export type PartsUpdateRequest = (PartsUpdateRequestCapability | PartsUpdateRequestEnhancement | PartsUpdateRequestFeature | PartsUpdateRequestProduct) & {
|
|
989
|
+
export type PartsUpdateRequest = (Empty | PartsUpdateRequestCapability | PartsUpdateRequestEnhancement | PartsUpdateRequestFeature | PartsUpdateRequestProduct) & {
|
|
988
990
|
artifacts?: PartsUpdateRequestArtifacts;
|
|
989
991
|
/** The updated description of the part. */
|
|
990
992
|
description?: string;
|
|
@@ -996,7 +998,7 @@ export type PartsUpdateRequest = (PartsUpdateRequestCapability | PartsUpdateRequ
|
|
|
996
998
|
/** The updated name of the part. */
|
|
997
999
|
name?: string;
|
|
998
1000
|
owned_by?: PartsUpdateRequestOwnedBy;
|
|
999
|
-
type
|
|
1001
|
+
type?: PartType;
|
|
1000
1002
|
};
|
|
1001
1003
|
/** parts-update-request-artifacts */
|
|
1002
1004
|
export interface PartsUpdateRequestArtifacts {
|
|
@@ -2004,7 +2006,7 @@ export interface WorksListResponse {
|
|
|
2004
2006
|
works: Work[];
|
|
2005
2007
|
}
|
|
2006
2008
|
/** works-update-request */
|
|
2007
|
-
export type WorksUpdateRequest = (WorksUpdateRequestIssue | WorksUpdateRequestTicket) & {
|
|
2009
|
+
export type WorksUpdateRequest = (Empty | WorksUpdateRequestIssue | WorksUpdateRequestTicket) & {
|
|
2008
2010
|
/**
|
|
2009
2011
|
* Updates the part that the work item applies to.
|
|
2010
2012
|
* @example "don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"
|
|
@@ -2030,7 +2032,7 @@ export type WorksUpdateRequest = (WorksUpdateRequestIssue | WorksUpdateRequestTi
|
|
|
2030
2032
|
target_close_date?: string;
|
|
2031
2033
|
/** Updated title of the work object, or unchanged if not provided. */
|
|
2032
2034
|
title?: string;
|
|
2033
|
-
type
|
|
2035
|
+
type?: WorkType;
|
|
2034
2036
|
};
|
|
2035
2037
|
/** works-update-request-artifact-ids */
|
|
2036
2038
|
export interface WorksUpdateRequestArtifactIds {
|
|
@@ -2450,12 +2452,18 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
2450
2452
|
* @request GET:/rev-orgs.get
|
|
2451
2453
|
* @secure
|
|
2452
2454
|
*/
|
|
2453
|
-
revOrgsGet: (query
|
|
2455
|
+
revOrgsGet: (query?: {
|
|
2456
|
+
/**
|
|
2457
|
+
* The ID of account for which default Rev organization is to be
|
|
2458
|
+
* fetched.
|
|
2459
|
+
* @example "don:core:<partition>:devo/<dev-org-id>:account/<account-id>"
|
|
2460
|
+
*/
|
|
2461
|
+
account?: string;
|
|
2454
2462
|
/**
|
|
2455
2463
|
* The ID of the required Rev organization.
|
|
2456
2464
|
* @example "don:identity:<partition>:devo/<dev-org-id>:revo/<rev-org-id>"
|
|
2457
2465
|
*/
|
|
2458
|
-
id
|
|
2466
|
+
id?: string;
|
|
2459
2467
|
}, params?: RequestParams) => Promise<AxiosResponse<RevOrgsGetResponse, any>>;
|
|
2460
2468
|
/**
|
|
2461
2469
|
* @description Gets the list of Rev organizations' information belonging to the authenticated user's Dev Organization which the user is also authorized to access.
|
|
@@ -67,6 +67,7 @@ var AuthTokenRequestedTokenType;
|
|
|
67
67
|
AuthTokenRequestedTokenType["UrnDevrevParamsOauthTokenTypeRev"] = "urn:devrev:params:oauth:token-type:rev";
|
|
68
68
|
AuthTokenRequestedTokenType["UrnDevrevParamsOauthTokenTypeSession"] = "urn:devrev:params:oauth:token-type:session";
|
|
69
69
|
AuthTokenRequestedTokenType["UrnDevrevParamsOauthTokenTypeSessionDev0"] = "urn:devrev:params:oauth:token-type:session:dev0";
|
|
70
|
+
AuthTokenRequestedTokenType["UrnDevrevParamsOauthTokenTypeSessionOnetime"] = "urn:devrev:params:oauth:token-type:session:onetime";
|
|
70
71
|
AuthTokenRequestedTokenType["UrnDevrevParamsOauthTokenTypeSys"] = "urn:devrev:params:oauth:token-type:sys";
|
|
71
72
|
AuthTokenRequestedTokenType["UrnIetfParamsOauthTokenTypeJwt"] = "urn:ietf:params:oauth:token-type:jwt";
|
|
72
73
|
})(AuthTokenRequestedTokenType = exports.AuthTokenRequestedTokenType || (exports.AuthTokenRequestedTokenType = {}));
|
|
@@ -83,6 +84,7 @@ var AuthTokenSubjectTokenType;
|
|
|
83
84
|
AuthTokenSubjectTokenType["UrnDevrevParamsOauthTokenTypeJwtAuth0"] = "urn:devrev:params:oauth:token-type:jwt:auth0";
|
|
84
85
|
AuthTokenSubjectTokenType["UrnDevrevParamsOauthTokenTypeJwtDev"] = "urn:devrev:params:oauth:token-type:jwt:dev";
|
|
85
86
|
AuthTokenSubjectTokenType["UrnDevrevParamsOauthTokenTypeRevinfo"] = "urn:devrev:params:oauth:token-type:revinfo";
|
|
87
|
+
AuthTokenSubjectTokenType["UrnDevrevParamsOauthTokenTypeSession"] = "urn:devrev:params:oauth:token-type:session";
|
|
86
88
|
AuthTokenSubjectTokenType["UrnDevrevParamsOauthTokenTypeSysu"] = "urn:devrev:params:oauth:token-type:sysu";
|
|
87
89
|
AuthTokenSubjectTokenType["UrnDevrevParamsOauthTokenTypeUserinfo"] = "urn:devrev:params:oauth:token-type:userinfo";
|
|
88
90
|
AuthTokenSubjectTokenType["UrnDevrevParamsOauthTokenTypeUserinfoProfile"] = "urn:devrev:params:oauth:token-type:userinfo:profile";
|