Skip to content

docs: improve Ruby README examples #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bardonadam merged 1 commit into from
Feb 7, 2026
Merged

docs: improve Ruby README examples #6

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 17 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,9 @@ response = activitysmith.notifications.send(
message: "CI pipeline failed on main branch"
}
)

puts response.success
puts response.devices_notified
```

### Start a Live Activity
Expand All @@ -39,10 +42,12 @@ response = activitysmith.notifications.send(
start = activitysmith.live_activities.start(
{
content_state: {
title: "Deploy",
title: "ActivitySmith API Deployment",
subtitle: "start",
number_of_steps: 4,
current_step: 1,
type: "segmented_progress"
type: "segmented_progress",
color: "yellow"
}
}
)
Expand All @@ -57,11 +62,14 @@ update = activitysmith.live_activities.update(
{
activity_id: activity_id,
content_state: {
title: "Deploy",
title: "ActivitySmith API Deployment",
subtitle: "npm i & pm2",
current_step: 3
}
}
)

puts update.devices_notified
```

### End a Live Activity
Expand All @@ -71,12 +79,15 @@ finish = activitysmith.live_activities.end(
{
activity_id: activity_id,
content_state: {
title: "Deploy Complete",
title: "ActivitySmith API Deployment",
subtitle: "done",
current_step: 4,
auto_dismiss_minutes: 3
}
}
)

puts finish.success
```

## Error Handling
Expand All @@ -86,8 +97,8 @@ begin
activitysmith.notifications.send(
{ title: "Build Failed" }
)
rescue OpenapiClient::ApiError => e
puts "Request failed: #{e.code} #{e.message}"
rescue OpenapiClient::ApiError => err
puts "Request failed: #{err.code} #{err.message}"
end
```

Expand Down