@parra/parra-js-sdk 0.3.228 → 0.3.229
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.
- package/dist/ParraAPI.d.ts +120 -1
- package/dist/ParraAPI.js +74 -0
- package/package.json +1 -1
package/dist/ParraAPI.d.ts
CHANGED
|
@@ -1216,6 +1216,35 @@ export interface CreateBoardRequestBody {
|
|
|
1216
1216
|
name: string;
|
|
1217
1217
|
description?: string | null;
|
|
1218
1218
|
}
|
|
1219
|
+
export interface UpdateBoardComponentRequestBody {
|
|
1220
|
+
type: string;
|
|
1221
|
+
key: string;
|
|
1222
|
+
name?: string;
|
|
1223
|
+
description?: string | null;
|
|
1224
|
+
application_id?: string | null;
|
|
1225
|
+
value?: string | null;
|
|
1226
|
+
}
|
|
1227
|
+
export interface CreateBoardComponentRequestBody {
|
|
1228
|
+
type: string;
|
|
1229
|
+
key: string;
|
|
1230
|
+
name?: string;
|
|
1231
|
+
description?: string | null;
|
|
1232
|
+
application_id?: string | null;
|
|
1233
|
+
value?: string | null;
|
|
1234
|
+
}
|
|
1235
|
+
export interface BoardComponent {
|
|
1236
|
+
id: string;
|
|
1237
|
+
created_at: string;
|
|
1238
|
+
updated_at: string;
|
|
1239
|
+
deleted_at?: string | null;
|
|
1240
|
+
type: string;
|
|
1241
|
+
key: string;
|
|
1242
|
+
name?: string;
|
|
1243
|
+
description?: string | null;
|
|
1244
|
+
application_id?: string | null;
|
|
1245
|
+
value?: string | null;
|
|
1246
|
+
tenant_id: string;
|
|
1247
|
+
}
|
|
1219
1248
|
export interface Board {
|
|
1220
1249
|
id: string;
|
|
1221
1250
|
created_at: string;
|
|
@@ -1224,12 +1253,23 @@ export interface Board {
|
|
|
1224
1253
|
tenant_id: string;
|
|
1225
1254
|
name: string;
|
|
1226
1255
|
description?: string | null;
|
|
1256
|
+
components?: Array<BoardComponent>;
|
|
1227
1257
|
}
|
|
1228
1258
|
export interface CreateTicketAttachmentRequestBody {
|
|
1229
1259
|
id: string;
|
|
1230
1260
|
size: Size;
|
|
1231
1261
|
url: string;
|
|
1232
1262
|
}
|
|
1263
|
+
export interface UpdateTicketChecklistItemRequestBody {
|
|
1264
|
+
title?: string;
|
|
1265
|
+
description?: string | null;
|
|
1266
|
+
complete?: boolean | null;
|
|
1267
|
+
}
|
|
1268
|
+
export interface CreateTicketChecklistItemRequestBody {
|
|
1269
|
+
title?: string;
|
|
1270
|
+
description?: string | null;
|
|
1271
|
+
complete?: boolean | null;
|
|
1272
|
+
}
|
|
1233
1273
|
export interface CreateTicketRequestBody {
|
|
1234
1274
|
title: string;
|
|
1235
1275
|
short_title?: string | null;
|
|
@@ -1248,6 +1288,16 @@ export interface CreateTicketRequestBody {
|
|
|
1248
1288
|
featured_title?: string | null;
|
|
1249
1289
|
featured_description?: string | null;
|
|
1250
1290
|
featured_image?: ImageAssetStub;
|
|
1291
|
+
checklist_items?: Array<CreateTicketChecklistItemRequestBody>;
|
|
1292
|
+
components?: Array<string>;
|
|
1293
|
+
assignees?: Array<string>;
|
|
1294
|
+
reported_by_team_member_id?: string | null;
|
|
1295
|
+
}
|
|
1296
|
+
export interface TeamMemberStub {
|
|
1297
|
+
id: string;
|
|
1298
|
+
tenant_id: string;
|
|
1299
|
+
name: string;
|
|
1300
|
+
avatar?: ImageAssetStub | null;
|
|
1251
1301
|
}
|
|
1252
1302
|
export interface TicketAttachment {
|
|
1253
1303
|
id: string;
|
|
@@ -1256,6 +1306,16 @@ export interface TicketAttachment {
|
|
|
1256
1306
|
deleted_at?: string | null;
|
|
1257
1307
|
attachment: ImageAssetStub;
|
|
1258
1308
|
}
|
|
1309
|
+
export interface TicketChecklistItemStub {
|
|
1310
|
+
id: string;
|
|
1311
|
+
title: string;
|
|
1312
|
+
description?: string | null;
|
|
1313
|
+
complete: boolean;
|
|
1314
|
+
}
|
|
1315
|
+
export interface BoardComponentStub {
|
|
1316
|
+
id: string;
|
|
1317
|
+
name: string;
|
|
1318
|
+
}
|
|
1259
1319
|
export interface Ticket {
|
|
1260
1320
|
id: string;
|
|
1261
1321
|
created_at: string;
|
|
@@ -1278,8 +1338,13 @@ export interface Ticket {
|
|
|
1278
1338
|
vote_count: number;
|
|
1279
1339
|
released_at?: string | null;
|
|
1280
1340
|
featured?: TicketFeatured;
|
|
1341
|
+
reported_by_member?: TeamMemberStub;
|
|
1281
1342
|
release?: ReleaseStub;
|
|
1282
|
-
attachments?: Array<TicketAttachment
|
|
1343
|
+
attachments?: Array<TicketAttachment>;
|
|
1344
|
+
assignees?: Array<TeamMemberStub>;
|
|
1345
|
+
checklist_items?: Array<TicketChecklistItemStub>;
|
|
1346
|
+
components?: Array<BoardComponentStub>;
|
|
1347
|
+
reported_by?: TeamMemberStub | null;
|
|
1283
1348
|
}
|
|
1284
1349
|
export interface TicketCollectionResponse {
|
|
1285
1350
|
page: number;
|
|
@@ -1337,6 +1402,12 @@ export interface UserNoteMetrics {
|
|
|
1337
1402
|
export interface LinkUserNoteRequestBody {
|
|
1338
1403
|
ticket_id: string;
|
|
1339
1404
|
}
|
|
1405
|
+
export interface BulkUpdateTicketChecklistItemRequestBody {
|
|
1406
|
+
id: string;
|
|
1407
|
+
title: string;
|
|
1408
|
+
description?: string | null;
|
|
1409
|
+
complete?: boolean | null;
|
|
1410
|
+
}
|
|
1340
1411
|
export interface UpdateTicketRequestBody {
|
|
1341
1412
|
release_id?: string;
|
|
1342
1413
|
title?: string;
|
|
@@ -1354,6 +1425,10 @@ export interface UpdateTicketRequestBody {
|
|
|
1354
1425
|
featured_title?: string | null;
|
|
1355
1426
|
featured_description?: string | null;
|
|
1356
1427
|
featured_image?: ImageAssetStub;
|
|
1428
|
+
components?: Array<string>;
|
|
1429
|
+
checklist_items?: Array<BulkUpdateTicketChecklistItemRequestBody>;
|
|
1430
|
+
assignees?: Array<string>;
|
|
1431
|
+
reported_by_team_member_id?: string | null;
|
|
1357
1432
|
}
|
|
1358
1433
|
export interface BulkUpdateTicketsRequestBody {
|
|
1359
1434
|
release_id?: string;
|
|
@@ -1372,8 +1447,36 @@ export interface BulkUpdateTicketsRequestBody {
|
|
|
1372
1447
|
featured_title?: string | null;
|
|
1373
1448
|
featured_description?: string | null;
|
|
1374
1449
|
featured_image?: ImageAssetStub;
|
|
1450
|
+
components?: Array<string>;
|
|
1451
|
+
checklist_items?: Array<BulkUpdateTicketChecklistItemRequestBody>;
|
|
1452
|
+
assignees?: Array<string>;
|
|
1453
|
+
reported_by_team_member_id?: string | null;
|
|
1375
1454
|
ticket_ids?: Array<string>;
|
|
1376
1455
|
}
|
|
1456
|
+
export interface UpdateTicketAssignmentRequestBody {
|
|
1457
|
+
team_member_id: string;
|
|
1458
|
+
}
|
|
1459
|
+
export interface CreateTicketAssignmentRequestBody {
|
|
1460
|
+
team_member_id: string;
|
|
1461
|
+
}
|
|
1462
|
+
export interface Assignment {
|
|
1463
|
+
id: string;
|
|
1464
|
+
created_at: string;
|
|
1465
|
+
updated_at: string;
|
|
1466
|
+
deleted_at?: string | null;
|
|
1467
|
+
team_member: TeamMemberStub;
|
|
1468
|
+
}
|
|
1469
|
+
export interface TicketChecklistItem {
|
|
1470
|
+
id: string;
|
|
1471
|
+
created_at: string;
|
|
1472
|
+
updated_at: string;
|
|
1473
|
+
deleted_at?: string | null;
|
|
1474
|
+
ticket_id: string;
|
|
1475
|
+
title: string;
|
|
1476
|
+
description?: string | null;
|
|
1477
|
+
complete: boolean;
|
|
1478
|
+
}
|
|
1479
|
+
export type BulkUpdateTicketChecklistItemsRequestBody = Array<BulkUpdateTicketChecklistItemRequestBody>;
|
|
1377
1480
|
export interface UpdateReleaseForTicketRequestBody {
|
|
1378
1481
|
release_id: string;
|
|
1379
1482
|
}
|
|
@@ -2780,6 +2883,7 @@ export interface CreateUserRequestBody {
|
|
|
2780
2883
|
locale?: string | null;
|
|
2781
2884
|
type: string;
|
|
2782
2885
|
identities?: Array<CreateIdentityRequestBody>;
|
|
2886
|
+
metadata?: object | null;
|
|
2783
2887
|
}
|
|
2784
2888
|
export interface UserCollectionResponse {
|
|
2785
2889
|
page: number;
|
|
@@ -2932,6 +3036,11 @@ declare class ParraAPI {
|
|
|
2932
3036
|
$expand?: string;
|
|
2933
3037
|
$search?: string;
|
|
2934
3038
|
}, options?: Options) => Promise<TicketCollectionResponse>;
|
|
3039
|
+
createBoardComponent: (tenant_id: string, board_id: string, body?: CreateBoardComponentRequestBody, options?: Options) => Promise<BoardComponent>;
|
|
3040
|
+
listBoardComponents: (tenant_id: string, board_id: string, options?: Options) => Promise<Array<BoardComponent>>;
|
|
3041
|
+
getBoardComponentById: (tenant_id: string, board_id: string, board_component_id: string, options?: Options) => Promise<BoardComponent>;
|
|
3042
|
+
updateBoardComponentById: (tenant_id: string, board_id: string, board_component_id: string, body: UpdateBoardComponentRequestBody, options?: Options) => Promise<BoardComponent>;
|
|
3043
|
+
deleteBoardComponentById: (tenant_id: string, board_id: string, board_component_id: string, options?: Options) => Promise<Response>;
|
|
2935
3044
|
createUserNoteForBoard: (tenant_id: string, board_id: string, body?: CreateUserNoteRequestBody, options?: Options) => Promise<UserNote>;
|
|
2936
3045
|
paginateUserNotesForBoard: (tenant_id: string, board_id: string, query?: {
|
|
2937
3046
|
$select?: string;
|
|
@@ -2949,7 +3058,17 @@ declare class ParraAPI {
|
|
|
2949
3058
|
getTicketById: (tenant_id: string, ticket_id: string, options?: Options) => Promise<Ticket>;
|
|
2950
3059
|
updateTicketById: (tenant_id: string, ticket_id: string, body?: UpdateTicketRequestBody, options?: Options) => Promise<Ticket>;
|
|
2951
3060
|
deleteTicketById: (tenant_id: string, ticket_id: string, options?: Options) => Promise<Response>;
|
|
3061
|
+
createTicketAssignment: (tenant_id: string, ticket_id: string, body?: CreateTicketAssignmentRequestBody, options?: Options) => Promise<Assignment>;
|
|
3062
|
+
listTicketAssignments: (tenant_id: string, ticket_id: string, options?: Options) => Promise<Array<Assignment>>;
|
|
3063
|
+
getTicketAssignmentById: (tenant_id: string, ticket_id: string, ticket_assignment_id: string, options?: Options) => Promise<Assignment>;
|
|
3064
|
+
updateTicketAssignmentById: (tenant_id: string, ticket_id: string, ticket_assignment_id: string, body: UpdateTicketAssignmentRequestBody, options?: Options) => Promise<Assignment>;
|
|
3065
|
+
deleteTicketAssignmentById: (tenant_id: string, ticket_id: string, ticket_assignment_id: string, options?: Options) => Promise<Response>;
|
|
2952
3066
|
deleteAttachmentForTicketById: (tenant_id: string, ticket_id: string, ticket_attachment_id: string, options?: Options) => Promise<Response>;
|
|
3067
|
+
createTicketChecklistItem: (tenant_id: string, ticket_id: string, body?: CreateTicketChecklistItemRequestBody, options?: Options) => Promise<TicketChecklistItem>;
|
|
3068
|
+
bulkUpdateTicketChecklistItems: (tenant_id: string, ticket_id: string, body?: BulkUpdateTicketChecklistItemsRequestBody, options?: Options) => Promise<Array<TicketChecklistItem>>;
|
|
3069
|
+
listTicketChecklistItems: (tenant_id: string, ticket_id: string, options?: Options) => Promise<Array<TicketChecklistItem>>;
|
|
3070
|
+
updateTicketChecklistItemById: (tenant_id: string, ticket_id: string, ticket_checklist_item_id: string, body?: UpdateTicketChecklistItemRequestBody, options?: Options) => Promise<TicketChecklistItem>;
|
|
3071
|
+
deleteTicketChecklistItemById: (tenant_id: string, ticket_id: string, ticket_checklist_item_id: string, options?: Options) => Promise<Response>;
|
|
2953
3072
|
updateReleaseForTicketById: (tenant_id: string, ticket_id: string, body: UpdateReleaseForTicketRequestBody, options?: Options) => Promise<Ticket>;
|
|
2954
3073
|
removeReleaseFromTicketById: (tenant_id: string, ticket_id: string, options?: Options) => Promise<Response>;
|
|
2955
3074
|
voteForTicketById: (tenant_id: string, ticket_id: string, options?: Options) => Promise<UserTicket>;
|
package/dist/ParraAPI.js
CHANGED
|
@@ -619,6 +619,30 @@ var ParraAPI = /** @class */ (function () {
|
|
|
619
619
|
if (options === void 0) { options = {}; }
|
|
620
620
|
return _this.http.execute("".concat(_this.options.baseUrl, "/v1/tenants/").concat(tenant_id, "/boards/").concat(board_id, "/tickets"), __assign({ method: "get", query: query }, options));
|
|
621
621
|
};
|
|
622
|
+
this.createBoardComponent = function (tenant_id, board_id, body, options) {
|
|
623
|
+
if (options === void 0) { options = {}; }
|
|
624
|
+
return _this.http.execute("".concat(_this.options.baseUrl, "/v1/tenants/").concat(tenant_id, "/boards/").concat(board_id, "/components"), __assign({ method: "post", body: JSON.stringify(body), headers: {
|
|
625
|
+
"content-type": "application/json",
|
|
626
|
+
} }, options));
|
|
627
|
+
};
|
|
628
|
+
this.listBoardComponents = function (tenant_id, board_id, options) {
|
|
629
|
+
if (options === void 0) { options = {}; }
|
|
630
|
+
return _this.http.execute("".concat(_this.options.baseUrl, "/v1/tenants/").concat(tenant_id, "/boards/").concat(board_id, "/components"), __assign({ method: "get" }, options));
|
|
631
|
+
};
|
|
632
|
+
this.getBoardComponentById = function (tenant_id, board_id, board_component_id, options) {
|
|
633
|
+
if (options === void 0) { options = {}; }
|
|
634
|
+
return _this.http.execute("".concat(_this.options.baseUrl, "/v1/tenants/").concat(tenant_id, "/boards/").concat(board_id, "/components/").concat(board_component_id), __assign({ method: "get" }, options));
|
|
635
|
+
};
|
|
636
|
+
this.updateBoardComponentById = function (tenant_id, board_id, board_component_id, body, options) {
|
|
637
|
+
if (options === void 0) { options = {}; }
|
|
638
|
+
return _this.http.execute("".concat(_this.options.baseUrl, "/v1/tenants/").concat(tenant_id, "/boards/").concat(board_id, "/components/").concat(board_component_id), __assign({ method: "put", body: JSON.stringify(body), headers: {
|
|
639
|
+
"content-type": "application/json",
|
|
640
|
+
} }, options));
|
|
641
|
+
};
|
|
642
|
+
this.deleteBoardComponentById = function (tenant_id, board_id, board_component_id, options) {
|
|
643
|
+
if (options === void 0) { options = {}; }
|
|
644
|
+
return _this.http.execute("".concat(_this.options.baseUrl, "/v1/tenants/").concat(tenant_id, "/boards/").concat(board_id, "/components/").concat(board_component_id), __assign({ method: "delete" }, options));
|
|
645
|
+
};
|
|
622
646
|
this.createUserNoteForBoard = function (tenant_id, board_id, body, options) {
|
|
623
647
|
if (options === void 0) { options = {}; }
|
|
624
648
|
return _this.http.execute("".concat(_this.options.baseUrl, "/v1/tenants/").concat(tenant_id, "/boards/").concat(board_id, "/notes"), __assign({ method: "post", body: JSON.stringify(body), headers: {
|
|
@@ -663,10 +687,60 @@ var ParraAPI = /** @class */ (function () {
|
|
|
663
687
|
if (options === void 0) { options = {}; }
|
|
664
688
|
return _this.http.execute("".concat(_this.options.baseUrl, "/v1/tenants/").concat(tenant_id, "/tickets/").concat(ticket_id), __assign({ method: "delete" }, options));
|
|
665
689
|
};
|
|
690
|
+
this.createTicketAssignment = function (tenant_id, ticket_id, body, options) {
|
|
691
|
+
if (options === void 0) { options = {}; }
|
|
692
|
+
return _this.http.execute("".concat(_this.options.baseUrl, "/v1/tenants/").concat(tenant_id, "/tickets/").concat(ticket_id, "/assignments"), __assign({ method: "post", body: JSON.stringify(body), headers: {
|
|
693
|
+
"content-type": "application/json",
|
|
694
|
+
} }, options));
|
|
695
|
+
};
|
|
696
|
+
this.listTicketAssignments = function (tenant_id, ticket_id, options) {
|
|
697
|
+
if (options === void 0) { options = {}; }
|
|
698
|
+
return _this.http.execute("".concat(_this.options.baseUrl, "/v1/tenants/").concat(tenant_id, "/tickets/").concat(ticket_id, "/assignments"), __assign({ method: "get" }, options));
|
|
699
|
+
};
|
|
700
|
+
this.getTicketAssignmentById = function (tenant_id, ticket_id, ticket_assignment_id, options) {
|
|
701
|
+
if (options === void 0) { options = {}; }
|
|
702
|
+
return _this.http.execute("".concat(_this.options.baseUrl, "/v1/tenants/").concat(tenant_id, "/tickets/").concat(ticket_id, "/assignments/").concat(ticket_assignment_id), __assign({ method: "get" }, options));
|
|
703
|
+
};
|
|
704
|
+
this.updateTicketAssignmentById = function (tenant_id, ticket_id, ticket_assignment_id, body, options) {
|
|
705
|
+
if (options === void 0) { options = {}; }
|
|
706
|
+
return _this.http.execute("".concat(_this.options.baseUrl, "/v1/tenants/").concat(tenant_id, "/tickets/").concat(ticket_id, "/assignments/").concat(ticket_assignment_id), __assign({ method: "put", body: JSON.stringify(body), headers: {
|
|
707
|
+
"content-type": "application/json",
|
|
708
|
+
} }, options));
|
|
709
|
+
};
|
|
710
|
+
this.deleteTicketAssignmentById = function (tenant_id, ticket_id, ticket_assignment_id, options) {
|
|
711
|
+
if (options === void 0) { options = {}; }
|
|
712
|
+
return _this.http.execute("".concat(_this.options.baseUrl, "/v1/tenants/").concat(tenant_id, "/tickets/").concat(ticket_id, "/assignments/").concat(ticket_assignment_id), __assign({ method: "delete" }, options));
|
|
713
|
+
};
|
|
666
714
|
this.deleteAttachmentForTicketById = function (tenant_id, ticket_id, ticket_attachment_id, options) {
|
|
667
715
|
if (options === void 0) { options = {}; }
|
|
668
716
|
return _this.http.execute("".concat(_this.options.baseUrl, "/v1/tenants/").concat(tenant_id, "/tickets/").concat(ticket_id, "/attachments/").concat(ticket_attachment_id), __assign({ method: "delete" }, options));
|
|
669
717
|
};
|
|
718
|
+
this.createTicketChecklistItem = function (tenant_id, ticket_id, body, options) {
|
|
719
|
+
if (options === void 0) { options = {}; }
|
|
720
|
+
return _this.http.execute("".concat(_this.options.baseUrl, "/v1/tenants/").concat(tenant_id, "/tickets/").concat(ticket_id, "/checklist/items"), __assign({ method: "post", body: JSON.stringify(body), headers: {
|
|
721
|
+
"content-type": "application/json",
|
|
722
|
+
} }, options));
|
|
723
|
+
};
|
|
724
|
+
this.bulkUpdateTicketChecklistItems = function (tenant_id, ticket_id, body, options) {
|
|
725
|
+
if (options === void 0) { options = {}; }
|
|
726
|
+
return _this.http.execute("".concat(_this.options.baseUrl, "/v1/tenants/").concat(tenant_id, "/tickets/").concat(ticket_id, "/checklist/items"), __assign({ method: "put", body: JSON.stringify(body), headers: {
|
|
727
|
+
"content-type": "application/json",
|
|
728
|
+
} }, options));
|
|
729
|
+
};
|
|
730
|
+
this.listTicketChecklistItems = function (tenant_id, ticket_id, options) {
|
|
731
|
+
if (options === void 0) { options = {}; }
|
|
732
|
+
return _this.http.execute("".concat(_this.options.baseUrl, "/v1/tenants/").concat(tenant_id, "/tickets/").concat(ticket_id, "/checklist/items"), __assign({ method: "get" }, options));
|
|
733
|
+
};
|
|
734
|
+
this.updateTicketChecklistItemById = function (tenant_id, ticket_id, ticket_checklist_item_id, body, options) {
|
|
735
|
+
if (options === void 0) { options = {}; }
|
|
736
|
+
return _this.http.execute("".concat(_this.options.baseUrl, "/v1/tenants/").concat(tenant_id, "/tickets/").concat(ticket_id, "/checklist/items/").concat(ticket_checklist_item_id), __assign({ method: "put", body: JSON.stringify(body), headers: {
|
|
737
|
+
"content-type": "application/json",
|
|
738
|
+
} }, options));
|
|
739
|
+
};
|
|
740
|
+
this.deleteTicketChecklistItemById = function (tenant_id, ticket_id, ticket_checklist_item_id, options) {
|
|
741
|
+
if (options === void 0) { options = {}; }
|
|
742
|
+
return _this.http.execute("".concat(_this.options.baseUrl, "/v1/tenants/").concat(tenant_id, "/tickets/").concat(ticket_id, "/checklist/items/").concat(ticket_checklist_item_id), __assign({ method: "delete" }, options));
|
|
743
|
+
};
|
|
670
744
|
this.updateReleaseForTicketById = function (tenant_id, ticket_id, body, options) {
|
|
671
745
|
if (options === void 0) { options = {}; }
|
|
672
746
|
return _this.http.execute("".concat(_this.options.baseUrl, "/v1/tenants/").concat(tenant_id, "/tickets/").concat(ticket_id, "/release"), __assign({ method: "put", body: JSON.stringify(body), headers: {
|