@devrev/typescript-sdk 1.1.7 → 1.1.8
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.
|
@@ -30,6 +30,8 @@ export type Account = OrgBase & {
|
|
|
30
30
|
* @example "don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"
|
|
31
31
|
*/
|
|
32
32
|
stock_schema_fragment?: string;
|
|
33
|
+
/** Tags associated with an object. */
|
|
34
|
+
tags?: TagWithValue[];
|
|
33
35
|
/** The Tier of the corresponding Account. */
|
|
34
36
|
tier?: string;
|
|
35
37
|
};
|
|
@@ -61,6 +63,8 @@ export interface AccountsCreateRequest {
|
|
|
61
63
|
* @example ["don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"]
|
|
62
64
|
*/
|
|
63
65
|
schema_fragment_ids?: string[];
|
|
66
|
+
/** Tags associated with the account. */
|
|
67
|
+
tags?: SetTagWithValue[];
|
|
64
68
|
/** The tier of the account. */
|
|
65
69
|
tier?: string;
|
|
66
70
|
}
|
|
@@ -95,6 +99,8 @@ export interface AccountsExportRequest {
|
|
|
95
99
|
/** Filters for accounts created by the specified user(s). */
|
|
96
100
|
created_by?: string[];
|
|
97
101
|
created_date?: DateTimeFilter;
|
|
102
|
+
/** Domains for accounts to be filtered. */
|
|
103
|
+
domains?: string[];
|
|
98
104
|
/** Array of references of accounts to be filtered. */
|
|
99
105
|
external_refs?: string[];
|
|
100
106
|
/**
|
|
@@ -105,8 +111,14 @@ export interface AccountsExportRequest {
|
|
|
105
111
|
*/
|
|
106
112
|
first?: number;
|
|
107
113
|
modified_date?: DateTimeFilter;
|
|
114
|
+
/** Filters for accounts owned by the specified user(s). */
|
|
115
|
+
owned_by?: string[];
|
|
108
116
|
/** Fields to sort the accounts by and the direction to sort them in. */
|
|
109
117
|
sort_by?: string[];
|
|
118
|
+
/** Filters for accounts on specified stages. */
|
|
119
|
+
stage?: string[];
|
|
120
|
+
/** List of tags to be filtered. */
|
|
121
|
+
tags?: string[];
|
|
110
122
|
}
|
|
111
123
|
/**
|
|
112
124
|
* accounts-export-response
|
|
@@ -147,6 +159,8 @@ export interface AccountsListRequest {
|
|
|
147
159
|
* iteration starts from the beginning.
|
|
148
160
|
*/
|
|
149
161
|
cursor?: string;
|
|
162
|
+
/** Domains for accounts to be filtered. */
|
|
163
|
+
domains?: string[];
|
|
150
164
|
/** Array of references of accounts to be filtered. */
|
|
151
165
|
external_refs?: string[];
|
|
152
166
|
/**
|
|
@@ -164,8 +178,14 @@ export interface AccountsListRequest {
|
|
|
164
178
|
*/
|
|
165
179
|
mode?: ListMode;
|
|
166
180
|
modified_date?: DateTimeFilter;
|
|
181
|
+
/** Filters for accounts owned by the specified user(s). */
|
|
182
|
+
owned_by?: string[];
|
|
167
183
|
/** Fields to sort the accounts by and the direction to sort them in. */
|
|
168
184
|
sort_by?: string[];
|
|
185
|
+
/** Filters for accounts on specified stages. */
|
|
186
|
+
stage?: string[];
|
|
187
|
+
/** List of tags to be filtered. */
|
|
188
|
+
tags?: string[];
|
|
169
189
|
}
|
|
170
190
|
/**
|
|
171
191
|
* accounts-list-response
|
|
@@ -215,6 +235,8 @@ export interface AccountsUpdateRequest {
|
|
|
215
235
|
* @example ["don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"]
|
|
216
236
|
*/
|
|
217
237
|
schema_fragment_ids?: string[];
|
|
238
|
+
/** Updated tags list associated with the account. */
|
|
239
|
+
tags?: SetTagWithValue[];
|
|
218
240
|
/** Updated tier of the account. */
|
|
219
241
|
tier?: string;
|
|
220
242
|
}
|
|
@@ -367,6 +389,8 @@ export interface ArticlesDeleteRequest {
|
|
|
367
389
|
*/
|
|
368
390
|
id: string;
|
|
369
391
|
}
|
|
392
|
+
/** articles-delete-response */
|
|
393
|
+
export type ArticlesDeleteResponse = object;
|
|
370
394
|
/**
|
|
371
395
|
* articles-get-request
|
|
372
396
|
* The request to get an article.
|
|
@@ -1406,6 +1430,54 @@ export declare enum ErrorUnauthorizedType {
|
|
|
1406
1430
|
}
|
|
1407
1431
|
/** error-unauthorized-unauthenticated */
|
|
1408
1432
|
export type ErrorUnauthorizedUnauthenticated = object;
|
|
1433
|
+
/** event-source */
|
|
1434
|
+
export type EventSource = AtomBase & {
|
|
1435
|
+
/**
|
|
1436
|
+
* Configuration of the event source. Fields depend on the event
|
|
1437
|
+
* source type.
|
|
1438
|
+
*/
|
|
1439
|
+
config?: object;
|
|
1440
|
+
/** Name of the event source. */
|
|
1441
|
+
name?: string;
|
|
1442
|
+
/** Instructions for setting up the event source. */
|
|
1443
|
+
setup_instructions?: EventSourceSetupInstructions;
|
|
1444
|
+
/**
|
|
1445
|
+
* Status of the event source. Note that paused/blocked event sources
|
|
1446
|
+
* return NotFound error on triggering.
|
|
1447
|
+
*/
|
|
1448
|
+
status?: EventSourceStatus;
|
|
1449
|
+
/**
|
|
1450
|
+
* The URL to trigger the event source. Valid only for HTTP
|
|
1451
|
+
* based-event sources. This URL supports both GET and POST requests.
|
|
1452
|
+
*/
|
|
1453
|
+
trigger_url?: string;
|
|
1454
|
+
};
|
|
1455
|
+
/** event-source-get-request */
|
|
1456
|
+
export interface EventSourceGetRequest {
|
|
1457
|
+
/** The event source's ID. */
|
|
1458
|
+
id: string;
|
|
1459
|
+
}
|
|
1460
|
+
/** event-source-get-response */
|
|
1461
|
+
export interface EventSourceGetResponse {
|
|
1462
|
+
event_source: EventSource;
|
|
1463
|
+
}
|
|
1464
|
+
/**
|
|
1465
|
+
* event-source-setup-instructions
|
|
1466
|
+
* Instructions for setting up the event source.
|
|
1467
|
+
*/
|
|
1468
|
+
export interface EventSourceSetupInstructions {
|
|
1469
|
+
/** Content of the instructions. */
|
|
1470
|
+
content?: string;
|
|
1471
|
+
}
|
|
1472
|
+
/**
|
|
1473
|
+
* Status of the event source. Note that paused/blocked event sources
|
|
1474
|
+
* return NotFound error on triggering.
|
|
1475
|
+
*/
|
|
1476
|
+
export declare enum EventSourceStatus {
|
|
1477
|
+
Active = "active",
|
|
1478
|
+
Blocked = "blocked",
|
|
1479
|
+
Paused = "paused"
|
|
1480
|
+
}
|
|
1409
1481
|
/** event-sources-delete-scheduled-event-request */
|
|
1410
1482
|
export interface EventSourcesDeleteScheduledEventRequest {
|
|
1411
1483
|
/** The event key for the event which we want to delete. */
|
|
@@ -1459,6 +1531,25 @@ export type FeatureSummary = PartBaseSummary;
|
|
|
1459
1531
|
* Set of field attributes.
|
|
1460
1532
|
*/
|
|
1461
1533
|
export type FieldDescriptor = object;
|
|
1534
|
+
/**
|
|
1535
|
+
* get-accounts-default-rev-org-request
|
|
1536
|
+
* Request object to get an account's default Rev organization.
|
|
1537
|
+
*/
|
|
1538
|
+
export interface GetAccountsDefaultRevOrgRequest {
|
|
1539
|
+
/**
|
|
1540
|
+
* The ID of Account for which default Rev organization is to be
|
|
1541
|
+
* fetched.
|
|
1542
|
+
* @example "don:core:<partition>:devo/<dev-org-id>:account/<account-id>"
|
|
1543
|
+
*/
|
|
1544
|
+
id: string;
|
|
1545
|
+
}
|
|
1546
|
+
/**
|
|
1547
|
+
* get-accounts-default-rev-org-response
|
|
1548
|
+
* Response object for getting account's default Rev organization.
|
|
1549
|
+
*/
|
|
1550
|
+
export interface GetAccountsDefaultRevOrgResponse {
|
|
1551
|
+
rev_org: RevOrg;
|
|
1552
|
+
}
|
|
1462
1553
|
/** group-summary */
|
|
1463
1554
|
export type GroupSummary = AtomBaseSummary;
|
|
1464
1555
|
/** issue */
|
|
@@ -2098,6 +2189,7 @@ export interface Resource {
|
|
|
2098
2189
|
}
|
|
2099
2190
|
/** rev-org */
|
|
2100
2191
|
export type RevOrg = OrgBase & {
|
|
2192
|
+
account?: AccountSummary;
|
|
2101
2193
|
/** Custom fields. */
|
|
2102
2194
|
custom_fields?: object;
|
|
2103
2195
|
/**
|
|
@@ -2130,6 +2222,11 @@ export type RevOrgSummary = OrgBaseSummary;
|
|
|
2130
2222
|
* organization.
|
|
2131
2223
|
*/
|
|
2132
2224
|
export interface RevOrgsCreateRequest {
|
|
2225
|
+
/**
|
|
2226
|
+
* Account Id to associate with this Rev organization.
|
|
2227
|
+
* @example "don:core:<partition>:devo/<dev-org-id>:account/<account-id>"
|
|
2228
|
+
*/
|
|
2229
|
+
account?: string;
|
|
2133
2230
|
/** Application-defined custom fields. */
|
|
2134
2231
|
custom_fields?: object;
|
|
2135
2232
|
/**
|
|
@@ -2185,6 +2282,11 @@ export interface RevOrgsGetResponse {
|
|
|
2185
2282
|
* user's Dev organization.
|
|
2186
2283
|
*/
|
|
2187
2284
|
export interface RevOrgsListRequest {
|
|
2285
|
+
/**
|
|
2286
|
+
* Filters by account.
|
|
2287
|
+
* @example ["don:core:<partition>:devo/<dev-org-id>:account/<account-id>"]
|
|
2288
|
+
*/
|
|
2289
|
+
account?: string[];
|
|
2188
2290
|
/** Filters by creator. */
|
|
2189
2291
|
created_by?: string[];
|
|
2190
2292
|
created_date?: DateTimeFilter;
|
|
@@ -2243,6 +2345,11 @@ export interface RevOrgsListResponse {
|
|
|
2243
2345
|
* Request object to update information of the Rev organization.
|
|
2244
2346
|
*/
|
|
2245
2347
|
export interface RevOrgsUpdateRequest {
|
|
2348
|
+
/**
|
|
2349
|
+
* New account ID to associate with this Rev organization.
|
|
2350
|
+
* @example "don:core:<partition>:devo/<dev-org-id>:account/<account-id>"
|
|
2351
|
+
*/
|
|
2352
|
+
account?: string;
|
|
2246
2353
|
/**
|
|
2247
2354
|
* Schema fragment IDs associated with this Rev organization.
|
|
2248
2355
|
* @example ["don:core:<partition>:devo/<dev-org-id>:custom_type_fragment/<custom-type-fragment-id>"]
|
|
@@ -3440,6 +3547,13 @@ export type TimelineEntriesCreateRequest = TimelineEntriesCreateRequestTimelineC
|
|
|
3440
3547
|
* @format date-time
|
|
3441
3548
|
*/
|
|
3442
3549
|
expires_at?: string;
|
|
3550
|
+
/**
|
|
3551
|
+
* The labels to be associated with the entry.
|
|
3552
|
+
* @minLength 1
|
|
3553
|
+
* @maxLength 64
|
|
3554
|
+
* @maxItems 16
|
|
3555
|
+
*/
|
|
3556
|
+
labels?: string[];
|
|
3443
3557
|
/**
|
|
3444
3558
|
* The ID of the object to create the timeline entry for.
|
|
3445
3559
|
* @example "don:core:<partition>:devo/<dev-org-id>:<part-type>/<part-id>"
|
|
@@ -3473,6 +3587,11 @@ export interface TimelineEntriesCreateRequestTimelineComment {
|
|
|
3473
3587
|
body?: string;
|
|
3474
3588
|
/** The type of the body to use for the comment. */
|
|
3475
3589
|
body_type?: TimelineCommentBodyType;
|
|
3590
|
+
/**
|
|
3591
|
+
* The IDs of the previews of the links posted in the comment.
|
|
3592
|
+
* @example ["don:core:<partition>:devo/<dev-org-id>:snap_widget/<snap-widget-id>"]
|
|
3593
|
+
*/
|
|
3594
|
+
link_previews?: string[];
|
|
3476
3595
|
/** Snap Kit Body of the comment. */
|
|
3477
3596
|
snap_kit_body?: TimelineSnapKitBody;
|
|
3478
3597
|
}
|
|
@@ -3501,6 +3620,14 @@ export interface TimelineEntriesListRequest {
|
|
|
3501
3620
|
* iteration starts from the beginning.
|
|
3502
3621
|
*/
|
|
3503
3622
|
cursor?: string;
|
|
3623
|
+
/**
|
|
3624
|
+
* Filters for entries containing at least one of the provided labels,
|
|
3625
|
+
* otherwise if no labels are provided, then no label filtering is
|
|
3626
|
+
* done.
|
|
3627
|
+
* @minLength 1
|
|
3628
|
+
* @maxLength 64
|
|
3629
|
+
*/
|
|
3630
|
+
labels?: string[];
|
|
3504
3631
|
/**
|
|
3505
3632
|
* The maximum number of entries to return. If not set, then this
|
|
3506
3633
|
* defaults to `50`.
|
|
@@ -3545,12 +3672,90 @@ export interface TimelineEntriesListResponse {
|
|
|
3545
3672
|
/** The timeline entries for the object. */
|
|
3546
3673
|
timeline_entries: TimelineEntry[];
|
|
3547
3674
|
}
|
|
3675
|
+
/**
|
|
3676
|
+
* timeline-entries-update-request
|
|
3677
|
+
* The request to update a timeline entry.
|
|
3678
|
+
*/
|
|
3679
|
+
export type TimelineEntriesUpdateRequest = TimelineEntriesUpdateRequestTimelineComment & {
|
|
3680
|
+
/**
|
|
3681
|
+
* The ID of the timeline entry to update.
|
|
3682
|
+
* @example "don:core:<partition>:devo/<dev-org-id>:ticket/123:timeline_event/<timeline-event-id>"
|
|
3683
|
+
*/
|
|
3684
|
+
id: string;
|
|
3685
|
+
type: TimelineEntriesUpdateRequestType;
|
|
3686
|
+
};
|
|
3687
|
+
/** timeline-entries-update-request-timeline-comment */
|
|
3688
|
+
export interface TimelineEntriesUpdateRequestTimelineComment {
|
|
3689
|
+
artifacts?: TimelineEntriesUpdateRequestTimelineCommentArtifacts;
|
|
3690
|
+
/** The updated comment's body. */
|
|
3691
|
+
body?: string;
|
|
3692
|
+
/** The type of the body to use for the comment. */
|
|
3693
|
+
body_type?: TimelineCommentBodyType;
|
|
3694
|
+
link_previews?: TimelineEntriesUpdateRequestTimelineCommentLinkPreviews;
|
|
3695
|
+
/** Snap Kit Body of the comment. */
|
|
3696
|
+
snap_kit_body?: TimelineSnapKitBody;
|
|
3697
|
+
}
|
|
3698
|
+
/** timeline-entries-update-request-timeline-comment-artifacts */
|
|
3699
|
+
export interface TimelineEntriesUpdateRequestTimelineCommentArtifacts {
|
|
3700
|
+
/**
|
|
3701
|
+
* Adds the provided artifacts to the comment. An artifact cannot be
|
|
3702
|
+
* added more than once, i.e. nothing is done if the artifact is
|
|
3703
|
+
* already attached. Mutually exclusive with `set`.
|
|
3704
|
+
* @example ["don:core:<partition>:devo/<dev-org-id>:artifact/<artifact-id>"]
|
|
3705
|
+
*/
|
|
3706
|
+
add?: string[];
|
|
3707
|
+
/**
|
|
3708
|
+
* Removes the provided artifacts from the comment. If an artifact is
|
|
3709
|
+
* not present, then it's ignored. Mututally exclusive with `set`.
|
|
3710
|
+
* @example ["don:core:<partition>:devo/<dev-org-id>:artifact/<artifact-id>"]
|
|
3711
|
+
*/
|
|
3712
|
+
remove?: string[];
|
|
3713
|
+
/**
|
|
3714
|
+
* Sets the field to the provided artifacts.
|
|
3715
|
+
* @example ["don:core:<partition>:devo/<dev-org-id>:artifact/<artifact-id>"]
|
|
3716
|
+
*/
|
|
3717
|
+
set?: string[];
|
|
3718
|
+
}
|
|
3719
|
+
/** timeline-entries-update-request-timeline-comment-link-previews */
|
|
3720
|
+
export interface TimelineEntriesUpdateRequestTimelineCommentLinkPreviews {
|
|
3721
|
+
/**
|
|
3722
|
+
* Adds the provided link previews to the comment. A link preview
|
|
3723
|
+
* cannot be added more than once, i.e. nothing is done if the link
|
|
3724
|
+
* preview is already present. Mutually exclusive with `set`.
|
|
3725
|
+
* @example ["don:core:<partition>:devo/<dev-org-id>:snap_widget/<snap-widget-id>"]
|
|
3726
|
+
*/
|
|
3727
|
+
add?: string[];
|
|
3728
|
+
/**
|
|
3729
|
+
* Removes the provided link previews from the comment. If a link
|
|
3730
|
+
* preview is not present, then it's ignored. Mutually exclusive with
|
|
3731
|
+
* `set`.
|
|
3732
|
+
* @example ["don:core:<partition>:devo/<dev-org-id>:snap_widget/<snap-widget-id>"]
|
|
3733
|
+
*/
|
|
3734
|
+
remove?: string[];
|
|
3735
|
+
/**
|
|
3736
|
+
* Set the link previews to the provided IDs.
|
|
3737
|
+
* @example ["don:core:<partition>:devo/<dev-org-id>:snap_widget/<snap-widget-id>"]
|
|
3738
|
+
*/
|
|
3739
|
+
set?: string[];
|
|
3740
|
+
}
|
|
3741
|
+
export declare enum TimelineEntriesUpdateRequestType {
|
|
3742
|
+
TimelineComment = "timeline_comment"
|
|
3743
|
+
}
|
|
3744
|
+
/**
|
|
3745
|
+
* timeline-entries-update-response
|
|
3746
|
+
* The response to updating a timeline entry.
|
|
3747
|
+
*/
|
|
3748
|
+
export interface TimelineEntriesUpdateResponse {
|
|
3749
|
+
timeline_entry: TimelineEntry;
|
|
3750
|
+
}
|
|
3548
3751
|
/** timeline-entry */
|
|
3549
3752
|
export type TimelineEntry = TimelineComment & {
|
|
3550
3753
|
type: TimelineEntryType;
|
|
3551
3754
|
};
|
|
3552
3755
|
/** timeline-entry-base */
|
|
3553
3756
|
export type TimelineEntryBase = AtomBase & {
|
|
3757
|
+
/** Labels that are associated with the Timeline entry. */
|
|
3758
|
+
labels?: string[];
|
|
3554
3759
|
/** The object that the Timeline entry belongs to. */
|
|
3555
3760
|
object: string;
|
|
3556
3761
|
/** The type of object that the Timeline entry belongs to. */
|
|
@@ -3573,9 +3778,11 @@ export declare enum TimelineEntryObjectType {
|
|
|
3573
3778
|
Account = "account",
|
|
3574
3779
|
Capability = "capability",
|
|
3575
3780
|
Conversation = "conversation",
|
|
3781
|
+
Engagement = "engagement",
|
|
3576
3782
|
Enhancement = "enhancement",
|
|
3577
3783
|
Feature = "feature",
|
|
3578
3784
|
Issue = "issue",
|
|
3785
|
+
Meeting = "meeting",
|
|
3579
3786
|
Opportunity = "opportunity",
|
|
3580
3787
|
Product = "product",
|
|
3581
3788
|
RevOrg = "rev_org",
|
|
@@ -3693,6 +3900,7 @@ export type UserBaseSummary = AtomBaseSummary & {
|
|
|
3693
3900
|
export declare enum UserState {
|
|
3694
3901
|
Active = "active",
|
|
3695
3902
|
Deactivated = "deactivated",
|
|
3903
|
+
Deleted = "deleted",
|
|
3696
3904
|
Locked = "locked",
|
|
3697
3905
|
Shadow = "shadow",
|
|
3698
3906
|
Unassigned = "unassigned"
|
|
@@ -4251,6 +4459,31 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
4251
4459
|
* @secure
|
|
4252
4460
|
*/
|
|
4253
4461
|
accountsCreate: (data: AccountsCreateRequest, params?: RequestParams) => Promise<AxiosResponse<AccountsCreateResponse, any>>;
|
|
4462
|
+
/**
|
|
4463
|
+
* @description Fetches account's default Rev organization.
|
|
4464
|
+
*
|
|
4465
|
+
* @tags accounts
|
|
4466
|
+
* @name GetAccountsDefaultRevOrg
|
|
4467
|
+
* @request GET:/accounts.default-rev-org.get
|
|
4468
|
+
* @secure
|
|
4469
|
+
*/
|
|
4470
|
+
getAccountsDefaultRevOrg: (query: {
|
|
4471
|
+
/**
|
|
4472
|
+
* The ID of Account for which default Rev organization is to be
|
|
4473
|
+
* fetched.
|
|
4474
|
+
* @example "don:core:<partition>:devo/<dev-org-id>:account/<account-id>"
|
|
4475
|
+
*/
|
|
4476
|
+
id: string;
|
|
4477
|
+
}, params?: RequestParams) => Promise<AxiosResponse<GetAccountsDefaultRevOrgResponse, any>>;
|
|
4478
|
+
/**
|
|
4479
|
+
* @description Fetches account's default Rev organization.
|
|
4480
|
+
*
|
|
4481
|
+
* @tags accounts
|
|
4482
|
+
* @name GetAccountsDefaultRevOrgPost
|
|
4483
|
+
* @request POST:/accounts.default-rev-org.get
|
|
4484
|
+
* @secure
|
|
4485
|
+
*/
|
|
4486
|
+
getAccountsDefaultRevOrgPost: (data: GetAccountsDefaultRevOrgRequest, params?: RequestParams) => Promise<AxiosResponse<GetAccountsDefaultRevOrgResponse, any>>;
|
|
4254
4487
|
/**
|
|
4255
4488
|
* @description Deletes an account.
|
|
4256
4489
|
*
|
|
@@ -4282,6 +4515,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
4282
4515
|
* @format date-time
|
|
4283
4516
|
*/
|
|
4284
4517
|
'created_date.before'?: string;
|
|
4518
|
+
/** Domains for accounts to be filtered. */
|
|
4519
|
+
domains?: string[];
|
|
4285
4520
|
/** Array of references of accounts to be filtered. */
|
|
4286
4521
|
external_refs?: string[];
|
|
4287
4522
|
/**
|
|
@@ -4302,8 +4537,14 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
4302
4537
|
* @format date-time
|
|
4303
4538
|
*/
|
|
4304
4539
|
'modified_date.before'?: string;
|
|
4540
|
+
/** Filters for accounts owned by the specified user(s). */
|
|
4541
|
+
owned_by?: string[];
|
|
4305
4542
|
/** Fields to sort the accounts by and the direction to sort them in. */
|
|
4306
4543
|
sort_by?: string[];
|
|
4544
|
+
/** Filters for accounts on specified stages. */
|
|
4545
|
+
stage?: string[];
|
|
4546
|
+
/** List of tags to be filtered. */
|
|
4547
|
+
tags?: string[];
|
|
4307
4548
|
}, params?: RequestParams) => Promise<AxiosResponse<AccountsExportResponse, any>>;
|
|
4308
4549
|
/**
|
|
4309
4550
|
* @description Exports a collection of accounts.
|
|
@@ -4365,6 +4606,8 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
4365
4606
|
* starts from the beginning.
|
|
4366
4607
|
*/
|
|
4367
4608
|
cursor?: string;
|
|
4609
|
+
/** Domains for accounts to be filtered. */
|
|
4610
|
+
domains?: string[];
|
|
4368
4611
|
/** Array of references of accounts to be filtered. */
|
|
4369
4612
|
external_refs?: string[];
|
|
4370
4613
|
/**
|
|
@@ -4389,8 +4632,14 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
4389
4632
|
* @format date-time
|
|
4390
4633
|
*/
|
|
4391
4634
|
'modified_date.before'?: string;
|
|
4635
|
+
/** Filters for accounts owned by the specified user(s). */
|
|
4636
|
+
owned_by?: string[];
|
|
4392
4637
|
/** Fields to sort the accounts by and the direction to sort them in. */
|
|
4393
4638
|
sort_by?: string[];
|
|
4639
|
+
/** Filters for accounts on specified stages. */
|
|
4640
|
+
stage?: string[];
|
|
4641
|
+
/** List of tags to be filtered. */
|
|
4642
|
+
tags?: string[];
|
|
4394
4643
|
}, params?: RequestParams) => Promise<AxiosResponse<AccountsListResponse, any>>;
|
|
4395
4644
|
/**
|
|
4396
4645
|
* @description Gets a list of accounts.
|
|
@@ -4466,7 +4715,7 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
4466
4715
|
* @request POST:/articles.delete
|
|
4467
4716
|
* @secure
|
|
4468
4717
|
*/
|
|
4469
|
-
deleteArticle: (data: ArticlesDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<
|
|
4718
|
+
deleteArticle: (data: ArticlesDeleteRequest, params?: RequestParams) => Promise<AxiosResponse<object, any>>;
|
|
4470
4719
|
/**
|
|
4471
4720
|
* @description Gets an article.
|
|
4472
4721
|
*
|
|
@@ -4864,6 +5113,27 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
4864
5113
|
* @secure
|
|
4865
5114
|
*/
|
|
4866
5115
|
engagementsUpdate: (data: EngagementsUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<EngagementsUpdateResponse, any>>;
|
|
5116
|
+
/**
|
|
5117
|
+
* @description Gets an event source.
|
|
5118
|
+
*
|
|
5119
|
+
* @tags event-source
|
|
5120
|
+
* @name EventSourcesGet
|
|
5121
|
+
* @request GET:/event-sources.get
|
|
5122
|
+
* @secure
|
|
5123
|
+
*/
|
|
5124
|
+
eventSourcesGet: (query: {
|
|
5125
|
+
/** The event source's ID. */
|
|
5126
|
+
id: string;
|
|
5127
|
+
}, params?: RequestParams) => Promise<AxiosResponse<EventSourceGetResponse, any>>;
|
|
5128
|
+
/**
|
|
5129
|
+
* @description Gets an event source.
|
|
5130
|
+
*
|
|
5131
|
+
* @tags event-source
|
|
5132
|
+
* @name EventSourcesGetPost
|
|
5133
|
+
* @request POST:/event-sources.get
|
|
5134
|
+
* @secure
|
|
5135
|
+
*/
|
|
5136
|
+
eventSourcesGetPost: (data: EventSourceGetRequest, params?: RequestParams) => Promise<AxiosResponse<EventSourceGetResponse, any>>;
|
|
4867
5137
|
/**
|
|
4868
5138
|
* @description Schedules an event to be published to the specified event source.
|
|
4869
5139
|
*
|
|
@@ -5189,6 +5459,11 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
5189
5459
|
* @secure
|
|
5190
5460
|
*/
|
|
5191
5461
|
revOrgsList: (query?: {
|
|
5462
|
+
/**
|
|
5463
|
+
* Filters by account.
|
|
5464
|
+
* @example ["don:core:<partition>:devo/<dev-org-id>:account/<account-id>"]
|
|
5465
|
+
*/
|
|
5466
|
+
account?: string[];
|
|
5192
5467
|
/** Filters by creator. */
|
|
5193
5468
|
created_by?: string[];
|
|
5194
5469
|
/**
|
|
@@ -5707,6 +5982,13 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
5707
5982
|
* starts from the beginning.
|
|
5708
5983
|
*/
|
|
5709
5984
|
cursor?: string;
|
|
5985
|
+
/**
|
|
5986
|
+
* Filters for entries containing at least one of the provided labels,
|
|
5987
|
+
* otherwise if no labels are provided, then no label filtering is done.
|
|
5988
|
+
* @minLength 1
|
|
5989
|
+
* @maxLength 64
|
|
5990
|
+
*/
|
|
5991
|
+
labels?: string[];
|
|
5710
5992
|
/**
|
|
5711
5993
|
* The maximum number of entries to return. If not set, then this
|
|
5712
5994
|
* defaults to `50`.
|
|
@@ -5734,6 +6016,15 @@ export declare class Api<SecurityDataType extends unknown> extends HttpClient<Se
|
|
|
5734
6016
|
* @secure
|
|
5735
6017
|
*/
|
|
5736
6018
|
timelineEntriesListPost: (data: TimelineEntriesListRequest, params?: RequestParams) => Promise<AxiosResponse<TimelineEntriesListResponse, any>>;
|
|
6019
|
+
/**
|
|
6020
|
+
* @description Updates an entry on an object's timeline.
|
|
6021
|
+
*
|
|
6022
|
+
* @tags timeline-entries
|
|
6023
|
+
* @name TimelineEntriesUpdate
|
|
6024
|
+
* @request POST:/timeline-entries.update
|
|
6025
|
+
* @secure
|
|
6026
|
+
*/
|
|
6027
|
+
timelineEntriesUpdate: (data: TimelineEntriesUpdateRequest, params?: RequestParams) => Promise<AxiosResponse<TimelineEntriesUpdateResponse, any>>;
|
|
5737
6028
|
/**
|
|
5738
6029
|
* @description Creates new work ([issue](https://devrev.ai/docs/product/build), [ticket](https://devrev.ai/docs/product/support)) item. [task](https://docs.devrev.ai/product/tasks) and opportunity work types are supported in the beta version.
|
|
5739
6030
|
*
|
|
@@ -33,8 +33,8 @@ 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.
|
|
37
|
-
exports.Api = void 0;
|
|
36
|
+
exports.WorkType = 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.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 = void 0;
|
|
38
38
|
var AccessLevel;
|
|
39
39
|
(function (AccessLevel) {
|
|
40
40
|
AccessLevel["External"] = "external";
|
|
@@ -132,6 +132,16 @@ var ErrorUnauthorizedType;
|
|
|
132
132
|
(function (ErrorUnauthorizedType) {
|
|
133
133
|
ErrorUnauthorizedType["Unauthenticated"] = "unauthenticated";
|
|
134
134
|
})(ErrorUnauthorizedType = exports.ErrorUnauthorizedType || (exports.ErrorUnauthorizedType = {}));
|
|
135
|
+
/**
|
|
136
|
+
* Status of the event source. Note that paused/blocked event sources
|
|
137
|
+
* return NotFound error on triggering.
|
|
138
|
+
*/
|
|
139
|
+
var EventSourceStatus;
|
|
140
|
+
(function (EventSourceStatus) {
|
|
141
|
+
EventSourceStatus["Active"] = "active";
|
|
142
|
+
EventSourceStatus["Blocked"] = "blocked";
|
|
143
|
+
EventSourceStatus["Paused"] = "paused";
|
|
144
|
+
})(EventSourceStatus = exports.EventSourceStatus || (exports.EventSourceStatus = {}));
|
|
135
145
|
/** Priority of the work based upon impact and criticality. */
|
|
136
146
|
var IssuePriority;
|
|
137
147
|
(function (IssuePriority) {
|
|
@@ -372,15 +382,21 @@ var TimelineEntriesCreateRequestType;
|
|
|
372
382
|
(function (TimelineEntriesCreateRequestType) {
|
|
373
383
|
TimelineEntriesCreateRequestType["TimelineComment"] = "timeline_comment";
|
|
374
384
|
})(TimelineEntriesCreateRequestType = exports.TimelineEntriesCreateRequestType || (exports.TimelineEntriesCreateRequestType = {}));
|
|
385
|
+
var TimelineEntriesUpdateRequestType;
|
|
386
|
+
(function (TimelineEntriesUpdateRequestType) {
|
|
387
|
+
TimelineEntriesUpdateRequestType["TimelineComment"] = "timeline_comment";
|
|
388
|
+
})(TimelineEntriesUpdateRequestType = exports.TimelineEntriesUpdateRequestType || (exports.TimelineEntriesUpdateRequestType = {}));
|
|
375
389
|
/** The type of object that the Timeline entry belongs to. */
|
|
376
390
|
var TimelineEntryObjectType;
|
|
377
391
|
(function (TimelineEntryObjectType) {
|
|
378
392
|
TimelineEntryObjectType["Account"] = "account";
|
|
379
393
|
TimelineEntryObjectType["Capability"] = "capability";
|
|
380
394
|
TimelineEntryObjectType["Conversation"] = "conversation";
|
|
395
|
+
TimelineEntryObjectType["Engagement"] = "engagement";
|
|
381
396
|
TimelineEntryObjectType["Enhancement"] = "enhancement";
|
|
382
397
|
TimelineEntryObjectType["Feature"] = "feature";
|
|
383
398
|
TimelineEntryObjectType["Issue"] = "issue";
|
|
399
|
+
TimelineEntryObjectType["Meeting"] = "meeting";
|
|
384
400
|
TimelineEntryObjectType["Opportunity"] = "opportunity";
|
|
385
401
|
TimelineEntryObjectType["Product"] = "product";
|
|
386
402
|
TimelineEntryObjectType["RevOrg"] = "rev_org";
|
|
@@ -412,6 +428,7 @@ var UserState;
|
|
|
412
428
|
(function (UserState) {
|
|
413
429
|
UserState["Active"] = "active";
|
|
414
430
|
UserState["Deactivated"] = "deactivated";
|
|
431
|
+
UserState["Deleted"] = "deleted";
|
|
415
432
|
UserState["Locked"] = "locked";
|
|
416
433
|
UserState["Shadow"] = "shadow";
|
|
417
434
|
UserState["Unassigned"] = "unassigned";
|
|
@@ -520,6 +537,24 @@ class Api extends HttpClient {
|
|
|
520
537
|
* @secure
|
|
521
538
|
*/
|
|
522
539
|
this.accountsCreate = (data, params = {}) => this.request(Object.assign({ path: `/accounts.create`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
540
|
+
/**
|
|
541
|
+
* @description Fetches account's default Rev organization.
|
|
542
|
+
*
|
|
543
|
+
* @tags accounts
|
|
544
|
+
* @name GetAccountsDefaultRevOrg
|
|
545
|
+
* @request GET:/accounts.default-rev-org.get
|
|
546
|
+
* @secure
|
|
547
|
+
*/
|
|
548
|
+
this.getAccountsDefaultRevOrg = (query, params = {}) => this.request(Object.assign({ path: `/accounts.default-rev-org.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
549
|
+
/**
|
|
550
|
+
* @description Fetches account's default Rev organization.
|
|
551
|
+
*
|
|
552
|
+
* @tags accounts
|
|
553
|
+
* @name GetAccountsDefaultRevOrgPost
|
|
554
|
+
* @request POST:/accounts.default-rev-org.get
|
|
555
|
+
* @secure
|
|
556
|
+
*/
|
|
557
|
+
this.getAccountsDefaultRevOrgPost = (data, params = {}) => this.request(Object.assign({ path: `/accounts.default-rev-org.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
523
558
|
/**
|
|
524
559
|
* @description Deletes an account.
|
|
525
560
|
*
|
|
@@ -627,7 +662,7 @@ class Api extends HttpClient {
|
|
|
627
662
|
* @request POST:/articles.delete
|
|
628
663
|
* @secure
|
|
629
664
|
*/
|
|
630
|
-
this.deleteArticle = (data, params = {}) => this.request(Object.assign({ path: `/articles.delete`, method: 'POST', body: data, secure: true, type: ContentType.Json }, params));
|
|
665
|
+
this.deleteArticle = (data, params = {}) => this.request(Object.assign({ path: `/articles.delete`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
631
666
|
/**
|
|
632
667
|
* @description Gets an article.
|
|
633
668
|
*
|
|
@@ -835,6 +870,24 @@ class Api extends HttpClient {
|
|
|
835
870
|
* @secure
|
|
836
871
|
*/
|
|
837
872
|
this.engagementsUpdate = (data, params = {}) => this.request(Object.assign({ path: `/engagements.update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
873
|
+
/**
|
|
874
|
+
* @description Gets an event source.
|
|
875
|
+
*
|
|
876
|
+
* @tags event-source
|
|
877
|
+
* @name EventSourcesGet
|
|
878
|
+
* @request GET:/event-sources.get
|
|
879
|
+
* @secure
|
|
880
|
+
*/
|
|
881
|
+
this.eventSourcesGet = (query, params = {}) => this.request(Object.assign({ path: `/event-sources.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
882
|
+
/**
|
|
883
|
+
* @description Gets an event source.
|
|
884
|
+
*
|
|
885
|
+
* @tags event-source
|
|
886
|
+
* @name EventSourcesGetPost
|
|
887
|
+
* @request POST:/event-sources.get
|
|
888
|
+
* @secure
|
|
889
|
+
*/
|
|
890
|
+
this.eventSourcesGetPost = (data, params = {}) => this.request(Object.assign({ path: `/event-sources.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
838
891
|
/**
|
|
839
892
|
* @description Schedules an event to be published to the specified event source.
|
|
840
893
|
*
|
|
@@ -1393,6 +1446,15 @@ class Api extends HttpClient {
|
|
|
1393
1446
|
* @secure
|
|
1394
1447
|
*/
|
|
1395
1448
|
this.timelineEntriesListPost = (data, params = {}) => this.request(Object.assign({ path: `/timeline-entries.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
1449
|
+
/**
|
|
1450
|
+
* @description Updates an entry on an object's timeline.
|
|
1451
|
+
*
|
|
1452
|
+
* @tags timeline-entries
|
|
1453
|
+
* @name TimelineEntriesUpdate
|
|
1454
|
+
* @request POST:/timeline-entries.update
|
|
1455
|
+
* @secure
|
|
1456
|
+
*/
|
|
1457
|
+
this.timelineEntriesUpdate = (data, params = {}) => this.request(Object.assign({ path: `/timeline-entries.update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
1396
1458
|
/**
|
|
1397
1459
|
* @description Creates new work ([issue](https://devrev.ai/docs/product/build), [ticket](https://devrev.ai/docs/product/support)) item. [task](https://docs.devrev.ai/product/tasks) and opportunity work types are supported in the beta version.
|
|
1398
1460
|
*
|
|
@@ -1622,6 +1622,7 @@ export type UserBaseSummary = AtomBaseSummary & {
|
|
|
1622
1622
|
export declare enum UserState {
|
|
1623
1623
|
Active = "active",
|
|
1624
1624
|
Deactivated = "deactivated",
|
|
1625
|
+
Deleted = "deleted",
|
|
1625
1626
|
Locked = "locked",
|
|
1626
1627
|
Shadow = "shadow",
|
|
1627
1628
|
Unassigned = "unassigned"
|
|
@@ -247,6 +247,7 @@ var UserState;
|
|
|
247
247
|
(function (UserState) {
|
|
248
248
|
UserState["Active"] = "active";
|
|
249
249
|
UserState["Deactivated"] = "deactivated";
|
|
250
|
+
UserState["Deleted"] = "deleted";
|
|
250
251
|
UserState["Locked"] = "locked";
|
|
251
252
|
UserState["Shadow"] = "shadow";
|
|
252
253
|
UserState["Unassigned"] = "unassigned";
|