@devrev/typescript-sdk 1.1.11 → 1.1.12
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 */
|
|
@@ -1359,6 +1361,14 @@ export interface EngagementsUpdateRequestTags {
|
|
|
1359
1361
|
export interface EngagementsUpdateResponse {
|
|
1360
1362
|
engagement: Engagement;
|
|
1361
1363
|
}
|
|
1364
|
+
/** enhancement */
|
|
1365
|
+
export type Enhancement = PartBase & {
|
|
1366
|
+
/**
|
|
1367
|
+
* Timestamp when the enhancement is expected to be closed.
|
|
1368
|
+
* @format date-time
|
|
1369
|
+
*/
|
|
1370
|
+
target_close_date?: string;
|
|
1371
|
+
};
|
|
1362
1372
|
/** enhancement-summary */
|
|
1363
1373
|
export type EnhancementSummary = PartBaseSummary;
|
|
1364
1374
|
/** error */
|
|
@@ -1486,6 +1496,64 @@ export declare enum ErrorUnauthorizedType {
|
|
|
1486
1496
|
}
|
|
1487
1497
|
/** error-unauthorized-unauthenticated */
|
|
1488
1498
|
export type ErrorUnauthorizedUnauthenticated = object;
|
|
1499
|
+
/** event-conversation-created */
|
|
1500
|
+
export interface EventConversationCreated {
|
|
1501
|
+
conversation: Conversation;
|
|
1502
|
+
}
|
|
1503
|
+
/** event-conversation-deleted */
|
|
1504
|
+
export interface EventConversationDeleted {
|
|
1505
|
+
/** The ID of the conversation that was deleted. */
|
|
1506
|
+
id: string;
|
|
1507
|
+
}
|
|
1508
|
+
/** event-conversation-updated */
|
|
1509
|
+
export interface EventConversationUpdated {
|
|
1510
|
+
conversation: Conversation;
|
|
1511
|
+
}
|
|
1512
|
+
/** event-part-created */
|
|
1513
|
+
export interface EventPartCreated {
|
|
1514
|
+
part: Part;
|
|
1515
|
+
}
|
|
1516
|
+
/** event-part-deleted */
|
|
1517
|
+
export interface EventPartDeleted {
|
|
1518
|
+
/**
|
|
1519
|
+
* The ID of the part that was deleted.
|
|
1520
|
+
* @example "don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"
|
|
1521
|
+
*/
|
|
1522
|
+
id: string;
|
|
1523
|
+
}
|
|
1524
|
+
/** event-part-updated */
|
|
1525
|
+
export interface EventPartUpdated {
|
|
1526
|
+
part: Part;
|
|
1527
|
+
}
|
|
1528
|
+
/** event-rev-org-created */
|
|
1529
|
+
export interface EventRevOrgCreated {
|
|
1530
|
+
rev_org: RevOrg;
|
|
1531
|
+
}
|
|
1532
|
+
/** event-rev-org-deleted */
|
|
1533
|
+
export interface EventRevOrgDeleted {
|
|
1534
|
+
/**
|
|
1535
|
+
* The ID of the Rev organization that was deleted.
|
|
1536
|
+
* @example "don:identity:<partition>:devo/<dev-org-id>:revo/<rev-org-id>"
|
|
1537
|
+
*/
|
|
1538
|
+
id: string;
|
|
1539
|
+
}
|
|
1540
|
+
/** event-rev-org-updated */
|
|
1541
|
+
export interface EventRevOrgUpdated {
|
|
1542
|
+
rev_org: RevOrg;
|
|
1543
|
+
}
|
|
1544
|
+
/** event-rev-user-created */
|
|
1545
|
+
export interface EventRevUserCreated {
|
|
1546
|
+
rev_user: RevUser;
|
|
1547
|
+
}
|
|
1548
|
+
/** event-rev-user-deleted */
|
|
1549
|
+
export interface EventRevUserDeleted {
|
|
1550
|
+
/** The ID of the Rev user that was deleted. */
|
|
1551
|
+
id: string;
|
|
1552
|
+
}
|
|
1553
|
+
/** event-rev-user-updated */
|
|
1554
|
+
export interface EventRevUserUpdated {
|
|
1555
|
+
rev_user: RevUser;
|
|
1556
|
+
}
|
|
1489
1557
|
/** event-source */
|
|
1490
1558
|
export type EventSource = AtomBase & {
|
|
1491
1559
|
/**
|
|
@@ -1580,6 +1648,72 @@ export interface EventSourcesScheduleEventResponse {
|
|
|
1580
1648
|
*/
|
|
1581
1649
|
event_key?: string;
|
|
1582
1650
|
}
|
|
1651
|
+
/** event-tag-created */
|
|
1652
|
+
export interface EventTagCreated {
|
|
1653
|
+
tag: Tag;
|
|
1654
|
+
}
|
|
1655
|
+
/** event-tag-deleted */
|
|
1656
|
+
export interface EventTagDeleted {
|
|
1657
|
+
/**
|
|
1658
|
+
* The ID of the tag that was deleted.
|
|
1659
|
+
* @example "don:core:<partition>:devo/<dev-org-id>:tag/<tag-id>"
|
|
1660
|
+
*/
|
|
1661
|
+
id: string;
|
|
1662
|
+
}
|
|
1663
|
+
/** event-tag-updated */
|
|
1664
|
+
export interface EventTagUpdated {
|
|
1665
|
+
tag: Tag;
|
|
1666
|
+
}
|
|
1667
|
+
/** event-timeline-entry-created */
|
|
1668
|
+
export interface EventTimelineEntryCreated {
|
|
1669
|
+
entry: TimelineEntry;
|
|
1670
|
+
}
|
|
1671
|
+
/** event-timeline-entry-deleted */
|
|
1672
|
+
export interface EventTimelineEntryDeleted {
|
|
1673
|
+
/**
|
|
1674
|
+
* The ID of the timeline entry that was deleted.
|
|
1675
|
+
* @example "don:core:<partition>:devo/<dev-org-id>:ticket/123:timeline_event/<timeline-event-id>"
|
|
1676
|
+
*/
|
|
1677
|
+
id: string;
|
|
1678
|
+
}
|
|
1679
|
+
/** event-timeline-entry-updated */
|
|
1680
|
+
export interface EventTimelineEntryUpdated {
|
|
1681
|
+
entry: TimelineEntry;
|
|
1682
|
+
}
|
|
1683
|
+
/** event-webhook-created */
|
|
1684
|
+
export interface EventWebhookCreated {
|
|
1685
|
+
webhook: Webhook;
|
|
1686
|
+
}
|
|
1687
|
+
/** event-webhook-deleted */
|
|
1688
|
+
export interface EventWebhookDeleted {
|
|
1689
|
+
/**
|
|
1690
|
+
* The ID of the webhook that was deleted.
|
|
1691
|
+
* @example "don:integration:<partition>:devo/<dev-org-id>:webhook/<webhook-id>"
|
|
1692
|
+
*/
|
|
1693
|
+
id: string;
|
|
1694
|
+
}
|
|
1695
|
+
/** event-webhook-updated */
|
|
1696
|
+
export interface EventWebhookUpdated {
|
|
1697
|
+
webhook: Webhook;
|
|
1698
|
+
}
|
|
1699
|
+
/** event-work-created */
|
|
1700
|
+
export interface EventWorkCreated {
|
|
1701
|
+
work: Work;
|
|
1702
|
+
}
|
|
1703
|
+
/** event-work-deleted */
|
|
1704
|
+
export interface EventWorkDeleted {
|
|
1705
|
+
/**
|
|
1706
|
+
* The ID of the work that was deleted.
|
|
1707
|
+
* @example "don:core:<partition>:devo/<dev-org-id>:<work-type>/<work-id>"
|
|
1708
|
+
*/
|
|
1709
|
+
id: string;
|
|
1710
|
+
}
|
|
1711
|
+
/** event-work-updated */
|
|
1712
|
+
export interface EventWorkUpdated {
|
|
1713
|
+
work: Work;
|
|
1714
|
+
}
|
|
1715
|
+
/** feature */
|
|
1716
|
+
export type Feature = PartBase;
|
|
1583
1717
|
/** feature-summary */
|
|
1584
1718
|
export type FeatureSummary = PartBaseSummary;
|
|
1585
1719
|
/**
|
|
@@ -1974,11 +2108,11 @@ export interface MetricDefinitionsListResponse {
|
|
|
1974
2108
|
export type Opportunity = WorkBase;
|
|
1975
2109
|
/** Forecast category of the opportunity. */
|
|
1976
2110
|
export declare enum OpportunityForecastCategory {
|
|
1977
|
-
BestCase = "best_case",
|
|
1978
2111
|
Commit = "commit",
|
|
1979
|
-
MostLikely = "most_likely",
|
|
1980
2112
|
Omitted = "omitted",
|
|
1981
2113
|
Pipeline = "pipeline",
|
|
2114
|
+
StrongUpside = "strong_upside",
|
|
2115
|
+
Upside = "upside",
|
|
1982
2116
|
Won = "won"
|
|
1983
2117
|
}
|
|
1984
2118
|
/** Priority of the opportunity. */
|
|
@@ -2320,6 +2454,35 @@ export declare enum OrgType {
|
|
|
2320
2454
|
Account = "account",
|
|
2321
2455
|
RevOrg = "rev_org"
|
|
2322
2456
|
}
|
|
2457
|
+
/** part */
|
|
2458
|
+
export type Part = (Capability | Enhancement | Feature | Product) & {
|
|
2459
|
+
type: PartType;
|
|
2460
|
+
};
|
|
2461
|
+
/** part-base */
|
|
2462
|
+
export type PartBase = AtomBase & {
|
|
2463
|
+
/** The attached artifacts. */
|
|
2464
|
+
artifacts?: ArtifactSummary[];
|
|
2465
|
+
/** Custom fields. */
|
|
2466
|
+
custom_fields?: object;
|
|
2467
|
+
/**
|
|
2468
|
+
* Custom schema fragments.
|
|
2469
|
+
* @example ["don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"]
|
|
2470
|
+
*/
|
|
2471
|
+
custom_schema_fragments?: string[];
|
|
2472
|
+
/** Description of the part. */
|
|
2473
|
+
description?: string;
|
|
2474
|
+
/** Name of the part. */
|
|
2475
|
+
name: string;
|
|
2476
|
+
/** The users that own the part. */
|
|
2477
|
+
owned_by: UserSummary[];
|
|
2478
|
+
/**
|
|
2479
|
+
* Stock schema fragment.
|
|
2480
|
+
* @example "don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"
|
|
2481
|
+
*/
|
|
2482
|
+
stock_schema_fragment?: string;
|
|
2483
|
+
/** Tags associated with the object. */
|
|
2484
|
+
tags?: TagWithValue[];
|
|
2485
|
+
};
|
|
2323
2486
|
/** part-base-summary */
|
|
2324
2487
|
export type PartBaseSummary = AtomBaseSummary & {
|
|
2325
2488
|
/** Name of the part. */
|
|
@@ -2335,6 +2498,8 @@ export declare enum PartType {
|
|
|
2335
2498
|
Feature = "feature",
|
|
2336
2499
|
Product = "product"
|
|
2337
2500
|
}
|
|
2501
|
+
/** product */
|
|
2502
|
+
export type Product = PartBase;
|
|
2338
2503
|
/** product-summary */
|
|
2339
2504
|
export type ProductSummary = PartBaseSummary;
|
|
2340
2505
|
/**
|
|
@@ -2430,11 +2595,17 @@ export interface RevOrgsCreateResponse {
|
|
|
2430
2595
|
* Request object to get Rev organization's information.
|
|
2431
2596
|
*/
|
|
2432
2597
|
export interface RevOrgsGetRequest {
|
|
2598
|
+
/**
|
|
2599
|
+
* The ID of account for which default Rev organization is to be
|
|
2600
|
+
* fetched.
|
|
2601
|
+
* @example "don:core:<partition>:devo/<dev-org-id>:account/<account-id>"
|
|
2602
|
+
*/
|
|
2603
|
+
account?: string;
|
|
2433
2604
|
/**
|
|
2434
2605
|
* The ID of the required Rev organization.
|
|
2435
2606
|
* @example "don:identity:<partition>:devo/<dev-org-id>:revo/<rev-org-id>"
|
|
2436
2607
|
*/
|
|
2437
|
-
id
|
|
2608
|
+
id?: string;
|
|
2438
2609
|
}
|
|
2439
2610
|
/**
|
|
2440
2611
|
* rev-orgs-get-response
|
|
@@ -3652,6 +3823,26 @@ export interface SysUsersUpdateRequest {
|
|
|
3652
3823
|
export interface SysUsersUpdateResponse {
|
|
3653
3824
|
sys_user: SysUser;
|
|
3654
3825
|
}
|
|
3826
|
+
/** tag */
|
|
3827
|
+
export type Tag = AtomBase & {
|
|
3828
|
+
/**
|
|
3829
|
+
* The allowed values for the tag, where a value is provided when a
|
|
3830
|
+
* tag is associated with an object. If empty, then no value should be
|
|
3831
|
+
* provided when the association is made.
|
|
3832
|
+
*/
|
|
3833
|
+
allowed_values?: string[];
|
|
3834
|
+
/**
|
|
3835
|
+
* An informative description for the tag that should provide context
|
|
3836
|
+
* on the tag's purpose and usage.
|
|
3837
|
+
*/
|
|
3838
|
+
description?: string;
|
|
3839
|
+
/**
|
|
3840
|
+
* The name of the tag, which denotes the logical concept by which all
|
|
3841
|
+
* tagged objects will be associated. The name is guaranteed to be
|
|
3842
|
+
* unique.
|
|
3843
|
+
*/
|
|
3844
|
+
name: string;
|
|
3845
|
+
};
|
|
3655
3846
|
/** tag-summary */
|
|
3656
3847
|
export type TagSummary = AtomBaseSummary & {
|
|
3657
3848
|
/**
|
|
@@ -4122,6 +4313,113 @@ export declare enum UserType {
|
|
|
4122
4313
|
ServiceAccount = "service_account",
|
|
4123
4314
|
SysUser = "sys_user"
|
|
4124
4315
|
}
|
|
4316
|
+
/** webhook */
|
|
4317
|
+
export type Webhook = AtomBase & {
|
|
4318
|
+
/** The event types that the webhook will receive. */
|
|
4319
|
+
event_types?: WebhookEventType[];
|
|
4320
|
+
/**
|
|
4321
|
+
* The secret to use for verifying webhook events.
|
|
4322
|
+
* @format byte
|
|
4323
|
+
*/
|
|
4324
|
+
secret: string;
|
|
4325
|
+
/** The status of the webhook. */
|
|
4326
|
+
status: WebhookStatus;
|
|
4327
|
+
/** The URL of the webhook endpoint. */
|
|
4328
|
+
url: string;
|
|
4329
|
+
};
|
|
4330
|
+
/** webhook-event-request */
|
|
4331
|
+
export interface WebhookEventRequest {
|
|
4332
|
+
conversation_created?: EventConversationCreated;
|
|
4333
|
+
conversation_deleted?: EventConversationDeleted;
|
|
4334
|
+
conversation_updated?: EventConversationUpdated;
|
|
4335
|
+
/** The event's ID. */
|
|
4336
|
+
id: string;
|
|
4337
|
+
part_created?: EventPartCreated;
|
|
4338
|
+
part_deleted?: EventPartDeleted;
|
|
4339
|
+
part_updated?: EventPartUpdated;
|
|
4340
|
+
rev_org_created?: EventRevOrgCreated;
|
|
4341
|
+
rev_org_deleted?: EventRevOrgDeleted;
|
|
4342
|
+
rev_org_updated?: EventRevOrgUpdated;
|
|
4343
|
+
rev_user_created?: EventRevUserCreated;
|
|
4344
|
+
rev_user_deleted?: EventRevUserDeleted;
|
|
4345
|
+
rev_user_updated?: EventRevUserUpdated;
|
|
4346
|
+
tag_created?: EventTagCreated;
|
|
4347
|
+
tag_deleted?: EventTagDeleted;
|
|
4348
|
+
tag_updated?: EventTagUpdated;
|
|
4349
|
+
timeline_entry_created?: EventTimelineEntryCreated;
|
|
4350
|
+
timeline_entry_deleted?: EventTimelineEntryDeleted;
|
|
4351
|
+
timeline_entry_updated?: EventTimelineEntryUpdated;
|
|
4352
|
+
/**
|
|
4353
|
+
* Timestamp of the webhook's invocation for the event. Note this
|
|
4354
|
+
* should be used to protect against replay attacks, where the event
|
|
4355
|
+
* should only be processed if the timestamp isn't stale by several
|
|
4356
|
+
* seconds.
|
|
4357
|
+
* @format date-time
|
|
4358
|
+
*/
|
|
4359
|
+
timestamp?: string;
|
|
4360
|
+
/** The event types that the webhook will receive. */
|
|
4361
|
+
type?: WebhookEventType;
|
|
4362
|
+
verify?: WebhookEventVerify;
|
|
4363
|
+
webhook_created?: EventWebhookCreated;
|
|
4364
|
+
webhook_deleted?: EventWebhookDeleted;
|
|
4365
|
+
/**
|
|
4366
|
+
* ID of the webhook for the event.
|
|
4367
|
+
* @example "don:integration:<partition>:devo/<dev-org-id>:webhook/<webhook-id>"
|
|
4368
|
+
*/
|
|
4369
|
+
webhook_id: string;
|
|
4370
|
+
webhook_updated?: EventWebhookUpdated;
|
|
4371
|
+
work_created?: EventWorkCreated;
|
|
4372
|
+
work_deleted?: EventWorkDeleted;
|
|
4373
|
+
work_updated?: EventWorkUpdated;
|
|
4374
|
+
}
|
|
4375
|
+
/** webhook-event-response */
|
|
4376
|
+
export interface WebhookEventResponse {
|
|
4377
|
+
/**
|
|
4378
|
+
* The challenge from the "verify" request, otherwise this should not
|
|
4379
|
+
* be set for other request types.
|
|
4380
|
+
* @format byte
|
|
4381
|
+
*/
|
|
4382
|
+
challenge?: string;
|
|
4383
|
+
}
|
|
4384
|
+
/** The event types that the webhook will receive. */
|
|
4385
|
+
export declare enum WebhookEventType {
|
|
4386
|
+
PartCreated = "part_created",
|
|
4387
|
+
PartDeleted = "part_deleted",
|
|
4388
|
+
PartUpdated = "part_updated",
|
|
4389
|
+
RevOrgCreated = "rev_org_created",
|
|
4390
|
+
RevOrgDeleted = "rev_org_deleted",
|
|
4391
|
+
RevOrgUpdated = "rev_org_updated",
|
|
4392
|
+
RevUserCreated = "rev_user_created",
|
|
4393
|
+
RevUserDeleted = "rev_user_deleted",
|
|
4394
|
+
RevUserUpdated = "rev_user_updated",
|
|
4395
|
+
TagCreated = "tag_created",
|
|
4396
|
+
TagDeleted = "tag_deleted",
|
|
4397
|
+
TagUpdated = "tag_updated",
|
|
4398
|
+
TimelineEntryCreated = "timeline_entry_created",
|
|
4399
|
+
TimelineEntryDeleted = "timeline_entry_deleted",
|
|
4400
|
+
TimelineEntryUpdated = "timeline_entry_updated",
|
|
4401
|
+
Verify = "verify",
|
|
4402
|
+
WebhookCreated = "webhook_created",
|
|
4403
|
+
WebhookDeleted = "webhook_deleted",
|
|
4404
|
+
WebhookUpdated = "webhook_updated",
|
|
4405
|
+
WorkCreated = "work_created",
|
|
4406
|
+
WorkDeleted = "work_deleted",
|
|
4407
|
+
WorkUpdated = "work_updated"
|
|
4408
|
+
}
|
|
4409
|
+
/** webhook-event-verify */
|
|
4410
|
+
export interface WebhookEventVerify {
|
|
4411
|
+
/**
|
|
4412
|
+
* The challenge that must be echoed in the response.
|
|
4413
|
+
* @format byte
|
|
4414
|
+
*/
|
|
4415
|
+
challenge: string;
|
|
4416
|
+
}
|
|
4417
|
+
/** The status of the webhook. */
|
|
4418
|
+
export declare enum WebhookStatus {
|
|
4419
|
+
Active = "active",
|
|
4420
|
+
Inactive = "inactive",
|
|
4421
|
+
Unverified = "unverified"
|
|
4422
|
+
}
|
|
4125
4423
|
/**
|
|
4126
4424
|
* weekly-org-schedule
|
|
4127
4425
|
* The schedule for each week.
|
|
@@ -4476,7 +4774,7 @@ export interface WorksListResponse {
|
|
|
4476
4774
|
works: Work[];
|
|
4477
4775
|
}
|
|
4478
4776
|
/** works-update-request */
|
|
4479
|
-
export type WorksUpdateRequest = (WorksUpdateRequestIssue | WorksUpdateRequestOpportunity | WorksUpdateRequestTask | WorksUpdateRequestTicket) & {
|
|
4777
|
+
export type WorksUpdateRequest = (Empty | WorksUpdateRequestIssue | WorksUpdateRequestOpportunity | WorksUpdateRequestTask | WorksUpdateRequestTicket) & {
|
|
4480
4778
|
/**
|
|
4481
4779
|
* Updates the part that the work item applies to.
|
|
4482
4780
|
* @example "don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"
|
|
@@ -4509,7 +4807,7 @@ export type WorksUpdateRequest = (WorksUpdateRequestIssue | WorksUpdateRequestOp
|
|
|
4509
4807
|
target_close_date?: string;
|
|
4510
4808
|
/** Updated title of the work object, or unchanged if not provided. */
|
|
4511
4809
|
title?: string;
|
|
4512
|
-
type
|
|
4810
|
+
type?: WorkType;
|
|
4513
4811
|
};
|
|
4514
4812
|
/** works-update-request-artifact-ids */
|
|
4515
4813
|
export interface WorksUpdateRequestArtifactIds {
|
|
@@ -5724,12 +6022,18 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
5724
6022
|
* @request GET:/rev-orgs.get
|
|
5725
6023
|
* @secure
|
|
5726
6024
|
*/
|
|
5727
|
-
revOrgsGet: (query
|
|
6025
|
+
revOrgsGet: (query?: {
|
|
6026
|
+
/**
|
|
6027
|
+
* The ID of account for which default Rev organization is to be
|
|
6028
|
+
* fetched.
|
|
6029
|
+
* @example "don:core:<partition>:devo/<dev-org-id>:account/<account-id>"
|
|
6030
|
+
*/
|
|
6031
|
+
account?: string;
|
|
5728
6032
|
/**
|
|
5729
6033
|
* The ID of the required Rev organization.
|
|
5730
6034
|
* @example "don:identity:<partition>:devo/<dev-org-id>:revo/<rev-org-id>"
|
|
5731
6035
|
*/
|
|
5732
|
-
id
|
|
6036
|
+
id?: string;
|
|
5733
6037
|
}, params?: RequestParams) => Promise<AxiosResponse<RevOrgsGetResponse, any>>;
|
|
5734
6038
|
/**
|
|
5735
6039
|
* @description Retrieves the Rev organization's information.
|
|
@@ -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";
|