@parra/parra-js-sdk 0.3.228 → 0.3.230

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