@devrev/typescript-sdk 1.1.22 → 1.1.24
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.
|
@@ -33,7 +33,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
|
|
|
33
33
|
return (mod && mod.__esModule) ? mod : { "default": mod };
|
|
34
34
|
};
|
|
35
35
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
36
|
-
exports.Api = exports.HttpClient = exports.ContentType = exports.WorkType = exports.WebhooksUpdateAction = exports.WebhookStatus = exports.WebhookEventType = exports.UserType = exports.UserState = exports.TimelineEntryVisibility = exports.TimelineEntryType = exports.TimelineEntryObjectType = exports.TimelineEntriesUpdateRequestType = exports.TimelineEntriesCreateRequestType = exports.TimelineCommentBodyType = exports.TicketSeverity = exports.SlaSummaryStage = exports.PartType = exports.OrgType = exports.OrgEnvironment = exports.ListMode = exports.IssuePriority = exports.ErrorUnauthorizedType = exports.ErrorTooManyRequestsType = exports.ErrorServiceUnavailableType = exports.ErrorNotFoundType = exports.ErrorInternalServerErrorType = exports.ErrorForbiddenType = exports.ErrorBadRequestType = exports.DevOrgAuthConnectionsUpdateRequestType = exports.DevOrgAuthConnectionsCreateRequestType = exports.DateTimePresetType = exports.DateFilterType = exports.AuthTokenTokenType = exports.AuthTokenSubjectTokenType = exports.AuthTokenStatus = exports.AuthTokenRequestedTokenType = exports.AuthTokenGrantType = exports.AuthConnectionType = exports.AuthConnectionToggle = void 0;
|
|
36
|
+
exports.Api = exports.HttpClient = exports.ContentType = exports.WorkType = exports.WebhooksUpdateAction = exports.WebhookStatus = exports.WebhookEventType = exports.UserType = exports.UserState = exports.TimelineEntryVisibility = exports.TimelineEntryType = exports.TimelineEntryObjectType = exports.TimelineEntriesUpdateRequestType = exports.TimelineEntriesCreateRequestType = exports.TimelineCommentBodyType = exports.TicketSeverity = exports.TicketChannels = exports.SyncMetadataFilterSyncOutFilterStatus = exports.SyncMetadataFilterSyncInFilterStatus = exports.SlaSummaryStage = exports.SlaStatus = exports.PartType = exports.OrgType = exports.OrgScheduleStatus = exports.OrgEnvironment = exports.ListMode = exports.IssuePriority = exports.ErrorUnauthorizedType = exports.ErrorTooManyRequestsType = exports.ErrorServiceUnavailableType = exports.ErrorNotFoundType = exports.ErrorInternalServerErrorType = exports.ErrorForbiddenType = exports.ErrorConflictType = exports.ErrorBadRequestUnexpectedJsonTypeType = exports.ErrorBadRequestType = exports.DevOrgAuthConnectionsUpdateRequestType = exports.DevOrgAuthConnectionsCreateRequestType = exports.DateTimePresetType = exports.DateFilterType = exports.AuthTokenTokenType = exports.AuthTokenSubjectTokenType = exports.AuthTokenStatus = exports.AuthTokenRequestedTokenType = exports.AuthTokenGrantType = exports.AuthConnectionType = exports.AuthConnectionToggle = void 0;
|
|
37
37
|
var AuthConnectionToggle;
|
|
38
38
|
(function (AuthConnectionToggle) {
|
|
39
39
|
AuthConnectionToggle["Disable"] = "disable";
|
|
@@ -61,8 +61,10 @@ var AuthTokenGrantType;
|
|
|
61
61
|
var AuthTokenRequestedTokenType;
|
|
62
62
|
(function (AuthTokenRequestedTokenType) {
|
|
63
63
|
AuthTokenRequestedTokenType["UrnDevrevParamsOauthTokenTypeAat"] = "urn:devrev:params:oauth:token-type:aat";
|
|
64
|
+
AuthTokenRequestedTokenType["UrnDevrevParamsOauthTokenTypeAatActAs"] = "urn:devrev:params:oauth:token-type:aat:act-as";
|
|
64
65
|
AuthTokenRequestedTokenType["UrnDevrevParamsOauthTokenTypeAatPublic"] = "urn:devrev:params:oauth:token-type:aat:public";
|
|
65
66
|
AuthTokenRequestedTokenType["UrnDevrevParamsOauthTokenTypeDev"] = "urn:devrev:params:oauth:token-type:dev";
|
|
67
|
+
AuthTokenRequestedTokenType["UrnDevrevParamsOauthTokenTypeDevConnect"] = "urn:devrev:params:oauth:token-type:dev:connect";
|
|
66
68
|
AuthTokenRequestedTokenType["UrnDevrevParamsOauthTokenTypeGat"] = "urn:devrev:params:oauth:token-type:gat";
|
|
67
69
|
AuthTokenRequestedTokenType["UrnDevrevParamsOauthTokenTypePat"] = "urn:devrev:params:oauth:token-type:pat";
|
|
68
70
|
AuthTokenRequestedTokenType["UrnDevrevParamsOauthTokenTypePatActAs"] = "urn:devrev:params:oauth:token-type:pat:act-as";
|
|
@@ -139,13 +141,29 @@ var DevOrgAuthConnectionsUpdateRequestType;
|
|
|
139
141
|
var ErrorBadRequestType;
|
|
140
142
|
(function (ErrorBadRequestType) {
|
|
141
143
|
ErrorBadRequestType["BadRequest"] = "bad_request";
|
|
144
|
+
ErrorBadRequestType["InvalidApiVersion"] = "invalid_api_version";
|
|
142
145
|
ErrorBadRequestType["InvalidEnumValue"] = "invalid_enum_value";
|
|
143
146
|
ErrorBadRequestType["InvalidField"] = "invalid_field";
|
|
144
147
|
ErrorBadRequestType["MissingDependency"] = "missing_dependency";
|
|
145
148
|
ErrorBadRequestType["MissingRequiredField"] = "missing_required_field";
|
|
146
149
|
ErrorBadRequestType["ParseError"] = "parse_error";
|
|
150
|
+
ErrorBadRequestType["StaleSchemaFragments"] = "stale_schema_fragments";
|
|
151
|
+
ErrorBadRequestType["UnexpectedJsonType"] = "unexpected_json_type";
|
|
147
152
|
ErrorBadRequestType["ValueNotPermitted"] = "value_not_permitted";
|
|
148
153
|
})(ErrorBadRequestType = exports.ErrorBadRequestType || (exports.ErrorBadRequestType = {}));
|
|
154
|
+
var ErrorBadRequestUnexpectedJsonTypeType;
|
|
155
|
+
(function (ErrorBadRequestUnexpectedJsonTypeType) {
|
|
156
|
+
ErrorBadRequestUnexpectedJsonTypeType["Array"] = "array";
|
|
157
|
+
ErrorBadRequestUnexpectedJsonTypeType["Bool"] = "bool";
|
|
158
|
+
ErrorBadRequestUnexpectedJsonTypeType["Null"] = "null";
|
|
159
|
+
ErrorBadRequestUnexpectedJsonTypeType["Number"] = "number";
|
|
160
|
+
ErrorBadRequestUnexpectedJsonTypeType["Object"] = "object";
|
|
161
|
+
ErrorBadRequestUnexpectedJsonTypeType["String"] = "string";
|
|
162
|
+
})(ErrorBadRequestUnexpectedJsonTypeType = exports.ErrorBadRequestUnexpectedJsonTypeType || (exports.ErrorBadRequestUnexpectedJsonTypeType = {}));
|
|
163
|
+
var ErrorConflictType;
|
|
164
|
+
(function (ErrorConflictType) {
|
|
165
|
+
ErrorConflictType["Conflict"] = "conflict";
|
|
166
|
+
})(ErrorConflictType = exports.ErrorConflictType || (exports.ErrorConflictType = {}));
|
|
149
167
|
var ErrorForbiddenType;
|
|
150
168
|
(function (ErrorForbiddenType) {
|
|
151
169
|
ErrorForbiddenType["Forbidden"] = "forbidden";
|
|
@@ -197,6 +215,17 @@ var OrgEnvironment;
|
|
|
197
215
|
OrgEnvironment["Staging"] = "staging";
|
|
198
216
|
OrgEnvironment["Test"] = "test";
|
|
199
217
|
})(OrgEnvironment = exports.OrgEnvironment || (exports.OrgEnvironment = {}));
|
|
218
|
+
/**
|
|
219
|
+
* Status determines how an item can be used. In 'draft' status an item
|
|
220
|
+
* can be edited but can't be used. When 'published' the item can longer
|
|
221
|
+
* be edited but can be used. 'Archived' is read-only.
|
|
222
|
+
*/
|
|
223
|
+
var OrgScheduleStatus;
|
|
224
|
+
(function (OrgScheduleStatus) {
|
|
225
|
+
OrgScheduleStatus["Archived"] = "archived";
|
|
226
|
+
OrgScheduleStatus["Draft"] = "draft";
|
|
227
|
+
OrgScheduleStatus["Published"] = "published";
|
|
228
|
+
})(OrgScheduleStatus = exports.OrgScheduleStatus || (exports.OrgScheduleStatus = {}));
|
|
200
229
|
var OrgType;
|
|
201
230
|
(function (OrgType) {
|
|
202
231
|
OrgType["RevOrg"] = "rev_org";
|
|
@@ -208,6 +237,17 @@ var PartType;
|
|
|
208
237
|
PartType["Feature"] = "feature";
|
|
209
238
|
PartType["Product"] = "product";
|
|
210
239
|
})(PartType = exports.PartType || (exports.PartType = {}));
|
|
240
|
+
/**
|
|
241
|
+
* Status determines how an item can be used. In 'draft' status an item
|
|
242
|
+
* can be edited but can't be used. When 'published' the item can longer
|
|
243
|
+
* be edited but can be used. 'Archived' is read-only.
|
|
244
|
+
*/
|
|
245
|
+
var SlaStatus;
|
|
246
|
+
(function (SlaStatus) {
|
|
247
|
+
SlaStatus["Archived"] = "archived";
|
|
248
|
+
SlaStatus["Draft"] = "draft";
|
|
249
|
+
SlaStatus["Published"] = "published";
|
|
250
|
+
})(SlaStatus = exports.SlaStatus || (exports.SlaStatus = {}));
|
|
211
251
|
/**
|
|
212
252
|
* The stage of the SLA. This is the metric stage which is closest to
|
|
213
253
|
* breach.
|
|
@@ -220,6 +260,25 @@ var SlaSummaryStage;
|
|
|
220
260
|
SlaSummaryStage["Running"] = "running";
|
|
221
261
|
SlaSummaryStage["Warning"] = "warning";
|
|
222
262
|
})(SlaSummaryStage = exports.SlaSummaryStage || (exports.SlaSummaryStage = {}));
|
|
263
|
+
var SyncMetadataFilterSyncInFilterStatus;
|
|
264
|
+
(function (SyncMetadataFilterSyncInFilterStatus) {
|
|
265
|
+
SyncMetadataFilterSyncInFilterStatus["Failed"] = "failed";
|
|
266
|
+
SyncMetadataFilterSyncInFilterStatus["Modified"] = "modified";
|
|
267
|
+
SyncMetadataFilterSyncInFilterStatus["Staged"] = "staged";
|
|
268
|
+
SyncMetadataFilterSyncInFilterStatus["Succeeded"] = "succeeded";
|
|
269
|
+
})(SyncMetadataFilterSyncInFilterStatus = exports.SyncMetadataFilterSyncInFilterStatus || (exports.SyncMetadataFilterSyncInFilterStatus = {}));
|
|
270
|
+
var SyncMetadataFilterSyncOutFilterStatus;
|
|
271
|
+
(function (SyncMetadataFilterSyncOutFilterStatus) {
|
|
272
|
+
SyncMetadataFilterSyncOutFilterStatus["Failed"] = "failed";
|
|
273
|
+
SyncMetadataFilterSyncOutFilterStatus["Succeeded"] = "succeeded";
|
|
274
|
+
})(SyncMetadataFilterSyncOutFilterStatus = exports.SyncMetadataFilterSyncOutFilterStatus || (exports.SyncMetadataFilterSyncOutFilterStatus = {}));
|
|
275
|
+
/** Channels of the ticket. */
|
|
276
|
+
var TicketChannels;
|
|
277
|
+
(function (TicketChannels) {
|
|
278
|
+
TicketChannels["Email"] = "email";
|
|
279
|
+
TicketChannels["Plug"] = "plug";
|
|
280
|
+
TicketChannels["Slack"] = "slack";
|
|
281
|
+
})(TicketChannels = exports.TicketChannels || (exports.TicketChannels = {}));
|
|
223
282
|
/** Severity of the ticket. */
|
|
224
283
|
var TicketSeverity;
|
|
225
284
|
(function (TicketSeverity) {
|
|
@@ -312,6 +371,9 @@ var WebhookEventType;
|
|
|
312
371
|
WebhookEventType["RevUserCreated"] = "rev_user_created";
|
|
313
372
|
WebhookEventType["RevUserDeleted"] = "rev_user_deleted";
|
|
314
373
|
WebhookEventType["RevUserUpdated"] = "rev_user_updated";
|
|
374
|
+
WebhookEventType["SlaTrackerCreated"] = "sla_tracker_created";
|
|
375
|
+
WebhookEventType["SlaTrackerDeleted"] = "sla_tracker_deleted";
|
|
376
|
+
WebhookEventType["SlaTrackerUpdated"] = "sla_tracker_updated";
|
|
315
377
|
WebhookEventType["TagCreated"] = "tag_created";
|
|
316
378
|
WebhookEventType["TagDeleted"] = "tag_deleted";
|
|
317
379
|
WebhookEventType["TagUpdated"] = "tag_updated";
|
|
@@ -425,6 +487,123 @@ exports.HttpClient = HttpClient;
|
|
|
425
487
|
class Api extends HttpClient {
|
|
426
488
|
constructor() {
|
|
427
489
|
super(...arguments);
|
|
490
|
+
/**
|
|
491
|
+
* @description Creates an account, which is a record representing a customer or an organization.
|
|
492
|
+
*
|
|
493
|
+
* @tags accounts
|
|
494
|
+
* @name AccountsCreate
|
|
495
|
+
* @request POST:/accounts.create
|
|
496
|
+
* @secure
|
|
497
|
+
*/
|
|
498
|
+
this.accountsCreate = (data, params = {}) => this.request(Object.assign({ path: `/accounts.create`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
499
|
+
/**
|
|
500
|
+
* @description Deletes an account.
|
|
501
|
+
*
|
|
502
|
+
* @tags accounts
|
|
503
|
+
* @name AccountsDelete
|
|
504
|
+
* @request POST:/accounts.delete
|
|
505
|
+
* @secure
|
|
506
|
+
*/
|
|
507
|
+
this.accountsDelete = (data, params = {}) => this.request(Object.assign({ path: `/accounts.delete`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
508
|
+
/**
|
|
509
|
+
* @description Exports a collection of accounts.
|
|
510
|
+
*
|
|
511
|
+
* @tags accounts
|
|
512
|
+
* @name AccountsExport
|
|
513
|
+
* @request GET:/accounts.export
|
|
514
|
+
* @secure
|
|
515
|
+
*/
|
|
516
|
+
this.accountsExport = (query, params = {}) => this.request(Object.assign({ path: `/accounts.export`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
517
|
+
/**
|
|
518
|
+
* @description Exports a collection of accounts.
|
|
519
|
+
*
|
|
520
|
+
* @tags accounts
|
|
521
|
+
* @name AccountsExportPost
|
|
522
|
+
* @request POST:/accounts.export
|
|
523
|
+
* @secure
|
|
524
|
+
*/
|
|
525
|
+
this.accountsExportPost = (data, params = {}) => this.request(Object.assign({ path: `/accounts.export`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
526
|
+
/**
|
|
527
|
+
* @description Retrieves an account's information.
|
|
528
|
+
*
|
|
529
|
+
* @tags accounts
|
|
530
|
+
* @name AccountsGet
|
|
531
|
+
* @request GET:/accounts.get
|
|
532
|
+
* @secure
|
|
533
|
+
*/
|
|
534
|
+
this.accountsGet = (query, params = {}) => this.request(Object.assign({ path: `/accounts.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
535
|
+
/**
|
|
536
|
+
* @description Retrieves an account's information.
|
|
537
|
+
*
|
|
538
|
+
* @tags accounts
|
|
539
|
+
* @name AccountsGetPost
|
|
540
|
+
* @request POST:/accounts.get
|
|
541
|
+
* @secure
|
|
542
|
+
*/
|
|
543
|
+
this.accountsGetPost = (data, params = {}) => this.request(Object.assign({ path: `/accounts.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
544
|
+
/**
|
|
545
|
+
* @description Gets a list of accounts.
|
|
546
|
+
*
|
|
547
|
+
* @tags accounts
|
|
548
|
+
* @name AccountsList
|
|
549
|
+
* @request GET:/accounts.list
|
|
550
|
+
* @secure
|
|
551
|
+
*/
|
|
552
|
+
this.accountsList = (query, params = {}) => this.request(Object.assign({ path: `/accounts.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
553
|
+
/**
|
|
554
|
+
* @description Gets a list of accounts.
|
|
555
|
+
*
|
|
556
|
+
* @tags accounts
|
|
557
|
+
* @name AccountsListPost
|
|
558
|
+
* @request POST:/accounts.list
|
|
559
|
+
* @secure
|
|
560
|
+
*/
|
|
561
|
+
this.accountsListPost = (data, params = {}) => this.request(Object.assign({ path: `/accounts.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
562
|
+
/**
|
|
563
|
+
* @description Updates an account's information.
|
|
564
|
+
*
|
|
565
|
+
* @tags accounts
|
|
566
|
+
* @name AccountsUpdate
|
|
567
|
+
* @request POST:/accounts.update
|
|
568
|
+
* @secure
|
|
569
|
+
*/
|
|
570
|
+
this.accountsUpdate = (data, params = {}) => this.request(Object.assign({ path: `/accounts.update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
571
|
+
/**
|
|
572
|
+
* @description Gets the requested artifact's information.
|
|
573
|
+
*
|
|
574
|
+
* @tags artifacts
|
|
575
|
+
* @name ArtifactsGet
|
|
576
|
+
* @request GET:/artifacts.get
|
|
577
|
+
* @secure
|
|
578
|
+
*/
|
|
579
|
+
this.artifactsGet = (query, params = {}) => this.request(Object.assign({ path: `/artifacts.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
580
|
+
/**
|
|
581
|
+
* @description Gets the requested artifact's information.
|
|
582
|
+
*
|
|
583
|
+
* @tags artifacts
|
|
584
|
+
* @name ArtifactsGetPost
|
|
585
|
+
* @request POST:/artifacts.get
|
|
586
|
+
* @secure
|
|
587
|
+
*/
|
|
588
|
+
this.artifactsGetPost = (data, params = {}) => this.request(Object.assign({ path: `/artifacts.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
589
|
+
/**
|
|
590
|
+
* @description List the artifacts attached to an object.
|
|
591
|
+
*
|
|
592
|
+
* @tags artifacts
|
|
593
|
+
* @name ArtifactsList
|
|
594
|
+
* @request GET:/artifacts.list
|
|
595
|
+
* @secure
|
|
596
|
+
*/
|
|
597
|
+
this.artifactsList = (query, params = {}) => this.request(Object.assign({ path: `/artifacts.list`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
598
|
+
/**
|
|
599
|
+
* @description List the artifacts attached to an object.
|
|
600
|
+
*
|
|
601
|
+
* @tags artifacts
|
|
602
|
+
* @name ArtifactsListPost
|
|
603
|
+
* @request POST:/artifacts.list
|
|
604
|
+
* @secure
|
|
605
|
+
*/
|
|
606
|
+
this.artifactsListPost = (data, params = {}) => this.request(Object.assign({ path: `/artifacts.list`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
428
607
|
/**
|
|
429
608
|
* @description Gets the download URL for the artifact.
|
|
430
609
|
*
|
|
@@ -776,6 +955,24 @@ class Api extends HttpClient {
|
|
|
776
955
|
* @secure
|
|
777
956
|
*/
|
|
778
957
|
this.revOrgsUpdate = (data, params = {}) => this.request(Object.assign({ path: `/rev-orgs.update`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
958
|
+
/**
|
|
959
|
+
* @description Gets an SLA tracker.
|
|
960
|
+
*
|
|
961
|
+
* @tags slas
|
|
962
|
+
* @name SlaTrackersGet
|
|
963
|
+
* @request GET:/sla-trackers.get
|
|
964
|
+
* @secure
|
|
965
|
+
*/
|
|
966
|
+
this.slaTrackersGet = (query, params = {}) => this.request(Object.assign({ path: `/sla-trackers.get`, method: 'GET', query: query, secure: true, format: 'json' }, params));
|
|
967
|
+
/**
|
|
968
|
+
* @description Gets an SLA tracker.
|
|
969
|
+
*
|
|
970
|
+
* @tags slas
|
|
971
|
+
* @name SlaTrackersGetPost
|
|
972
|
+
* @request POST:/sla-trackers.get
|
|
973
|
+
* @secure
|
|
974
|
+
*/
|
|
975
|
+
this.slaTrackersGetPost = (data, params = {}) => this.request(Object.assign({ path: `/sla-trackers.get`, method: 'POST', body: data, secure: true, type: ContentType.Json, format: 'json' }, params));
|
|
779
976
|
/**
|
|
780
977
|
* @description Creates a new tag, which is used to create associations between objects and a logical concept denoted by the tag's name.
|
|
781
978
|
*
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@devrev/typescript-sdk",
|
|
3
|
-
"version": "1.1.
|
|
3
|
+
"version": "1.1.24",
|
|
4
4
|
"description": "## SDK Generation",
|
|
5
5
|
"main": "./dist/index.js",
|
|
6
6
|
"scripts": {
|
|
@@ -39,6 +39,7 @@
|
|
|
39
39
|
"rimraf": "^4.1.2",
|
|
40
40
|
"ts-jest": "^29.0.5",
|
|
41
41
|
"ts-node": "^10.9.1",
|
|
42
|
+
"typedoc": "^0.25.9",
|
|
42
43
|
"typescript": "^4.9.5"
|
|
43
44
|
},
|
|
44
45
|
"dependencies": {
|