README.md in hackerone-client-0.17.0 vs README.md in hackerone-client-0.18.0
- old
+ new
@@ -3,12 +3,12 @@
A limited client library for interacting with HackerOne. Currently only supports a few operations:
```ruby
client = HackerOne::Client::Api.new("github")
-# GET '/reports' returns all reports in the "new" state for a given program
-client.reports
+# GET '/reports' returns all reports in a given state for a program, by default :new
+client.reports(state: :new)
# GET '/report/{id}' returns report data for a given report
report = client.report(id)
# PUT '/reports/{id}/assignee'
@@ -26,9 +26,12 @@
# POST '/report/{id}/add_report_reference add a "reference" e.g. internal issue number
report.add_report_reference(reference)
# Triage an issue (add a reference and set state to :triaged)
report.triage(reference)
+
+# Set the severity on a report (rating can be none, low, medium, high or critical)
+report.update_severity(rating: "high")
# POST /reports/{id}/bounty_suggestions
report.suggest_bounty(message: "I suggest $500 with a small bonus. Report is well-written.", amount: 500, bonus_amount: 50)
# POST /reports/{id}/bounties