Add support for Timeline events

CHANGELOG.md

@@ -1,3 +1,7 @@
+## 9.12.0
+
+* Add support for issue and PR timeline events via `Issue.listTimeline`.
+
 ## 9.11.0
 
 * expose IssueLabel.description; update labels REST APIs by @devoncarew in https://github.com/SpinlockLabs/github.dart/pull/355

CONTRIBUTING.md

@@ -30,6 +30,14 @@ GitHub.dart is committed to efficiency as much as possible. If your code is not
 
 Pull Request rejections are not a bad thing. It just means you need to fix something. Perhaps it is important to define 'rejection' as it is used in this case. A rejection is when a GitHub.dart committer comments on a Pull Request with a comment like 'rejected due to incorrect formatting'.
 
+## Generated code
+
+To regenerate the JSON logic for the models, run:
+
+```
+dart run build_runner build -d
+```
+
 ## Tests
 
 To run the complete test suite you will need to install

lib/src/common.dart

@@ -31,6 +31,8 @@ export 'package:github/src/common/model/repos_releases.dart';
 export 'package:github/src/common/model/repos_stats.dart';
 export 'package:github/src/common/model/repos_statuses.dart';
 export 'package:github/src/common/model/search.dart';
+export 'package:github/src/common/model/timeline.dart';
+export 'package:github/src/common/model/timeline_support.dart';
 export 'package:github/src/common/model/users.dart';
 export 'package:github/src/common/orgs_service.dart';
 export 'package:github/src/common/pulls_service.dart';

lib/src/common/issues_service.dart

@@ -432,4 +432,15 @@ class IssuesService extends Service {
         .request('DELETE', '/repos/${slug.fullName}/milestones/$number')
         .then((response) => response.statusCode == StatusCodes.NO_CONTENT);
   }
+
+  /// Lists all timeline events for an issue.
+  ///
+  /// API docs: https://docs.github.com/en/rest/issues/timeline?apiVersion=2022-11-28
+  Stream<TimelineEvent> listTimeline(RepositorySlug slug, int issueNumber) {
+    return PaginationHelper(github).objects(
+      'GET',
+      '/repos/${slug.fullName}/issues/$issueNumber/timeline',
+      TimelineEvent.fromJson,
+    );
+  }
 }

lib/src/common/model/issues.dart

@@ -1,5 +1,4 @@
 import 'package:github/src/common.dart';
-import 'package:github/src/common/model/users.dart';
 import 'package:json_annotation/json_annotation.dart';
 
 part 'issues.g.dart';
@@ -26,6 +25,24 @@ class Issue {
     this.updatedAt,
     this.body = '',
     this.closedBy,
+
+    // Properties from the Timeline API
+    this.activeLockReason,
+    this.authorAssociation,
+    this.bodyHtml,
+    this.bodyText,
+    this.commentsUrl,
+    this.draft,
+    this.eventsUrl,
+    this.labelsUrl,
+    this.locked,
+    this.nodeId,
+    this.performedViaGithubApp,
+    this.reactions,
+    this.repository,
+    this.repositoryUrl,
+    this.stateReason,
+    this.timelineUrl,
   }) {
     if (labels != null) {
       this.labels = labels;
@@ -89,6 +106,46 @@ class Issue {
   bool get isOpen => state == 'open';
   bool get isClosed => state == 'closed';
 
+  // The following properties were added to support the Timeline API.
+
+  String? activeLockReason;
+
+  /// How the author is associated with the repository.
+  ///
+  /// Example: `OWNER`
+  String? authorAssociation;
+
+  String? bodyHtml;
+
+  String? bodyText;
+
+  String? commentsUrl;
+
+  bool? draft;
+
+  String? eventsUrl;
+
+  String? labelsUrl;
+
+  bool? locked;
+
+  String? nodeId;
+
+  GitHubApp? performedViaGithubApp;
+
+  ReactionRollup? reactions;
+
+  Repository? repository;
+
+  String? repositoryUrl;
+
+  /// The reason for the current state
+  ///
+  /// Example: `not_planned`
+  String? stateReason;
+
+  String? timelineUrl;
+
   factory Issue.fromJson(Map<String, dynamic> input) => _$IssueFromJson(input);
   Map<String, dynamic> toJson() => _$IssueToJson(this);
 }
@@ -204,6 +261,13 @@ class Milestone {
     this.createdAt,
     this.updatedAt,
     this.dueOn,
+
+    // Properties from the Timeline API
+    this.closedAt,
+    this.htmlUrl,
+    this.labelsUrl,
+    this.nodeId,
+    this.url,
   });
 
   /// Unique Identifier for Milestone
@@ -241,6 +305,22 @@ class Milestone {
   /// The due date for this milestone
   DateTime? dueOn;
 
+  // The following properties were added to support the Timeline API.
+
+  DateTime? closedAt;
+
+  /// Example: `https://github.com/octocat/Hello-World/milestones/v1.0`
+  String? htmlUrl;
+
+  /// Example: `https://api.github.com/repos/octocat/Hello-World/milestones/1/labels`
+  String? labelsUrl;
+
+  /// Example: `MDk6TWlsZXN0b25lMTAwMjYwNA==`
+  String? nodeId;
+
+  /// Example: `https://api.github.com/repos/octocat/Hello-World/milestones/1`
+  String? url;
+
   factory Milestone.fromJson(Map<String, dynamic> input) =>
       _$MilestoneFromJson(input);
   Map<String, dynamic> toJson() => _$MilestoneToJson(this);