README.md in hackerone-client-0.18.0 vs README.md in hackerone-client-0.19.0
- old
+ new
@@ -3,10 +3,13 @@
A limited client library for interacting with HackerOne. Currently only supports a few operations:
```ruby
client = HackerOne::Client::Api.new("github")
+# POST '/reports' creates a new report
+client.create_report(title: "hi", summary: "hi", impact: "string", severity_rating: :high, source: "api")
+
# 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)
@@ -27,11 +30,11 @@
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")
+# 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