https://github.com/orbit-love/ruby-orbit-activities
Orbit API helper library for Ruby. This client can create, read, update and delete activities in your Orbit workspace.
https://github.com/orbit-love/ruby-orbit-activities
api orbit orbit-api ruby sdk
Last synced: about 1 year ago
JSON representation
Orbit API helper library for Ruby. This client can create, read, update and delete activities in your Orbit workspace.
- Host: GitHub
- URL: https://github.com/orbit-love/ruby-orbit-activities
- Owner: orbit-love
- License: mit
- Created: 2021-05-13T09:11:18.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2024-05-16T19:00:59.000Z (about 2 years ago)
- Last Synced: 2025-04-25T15:41:34.422Z (about 1 year ago)
- Topics: api, orbit, orbit-api, ruby, sdk
- Language: Ruby
- Homepage:
- Size: 48.8 KB
- Stars: 4
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Orbit Activities Helper Library for Ruby
[](https://badge.fury.io/rb/orbit_activities)
[](code_of_conduct.md)
> Orbit API helper library for Ruby.
This client can create, read, update and delete activities in your Orbit workspace.
## Package Usage
### Installation
To install this integration in a standalone app, add the gem to your `Gemfile`:
```ruby
gem "orbit_activities"
```
Then, run `bundle install` from your terminal.
### Usage
#### Create an Activity
To create an activity:
```ruby
OrbitActivities::Request.new(
api_key: # Your Orbit API key,
workspace_id: # Your Orbit workspace ID,
action: "new_activity",
body: # The custom activity object in JSON format, see Orbit API docs for reference
)
```
You can inspect the Orbit API response by appending `.response` to the end of the initialization method.
#### Update an Activity
To update an activity:
```ruby
OrbitActivities::Request.new(
api_key: # Your Orbit API key,
workspace_id: # Your Orbit workspace ID,
action: "update_activity",
activity_id: # The ID of the activity to be updated,
member_id: # The ID of the member the activity is attached to,
body: # The custom activity object in JSON format, see Orbit API docs for reference
)
```
You can inspect the Orbit API response by appending `.response` to the end of the initialization method.
#### Delete an Activity
To delete an activity:
```ruby
OrbitActivities::Request.new(
api_key: # Your Orbit API key,
workspace_id: # Your Orbit workspace ID,
action: "delete_activity",
activity_id: # The ID of the activity to be updated,
member_id: # The ID of the member the activity is attached to
)
```
You can inspect the Orbit API response by appending `.response` to the end of the initialization method.
#### List Activities
To list activities:
```ruby
OrbitActivities::Request.new(
api_key: # Your Orbit API key,
workspace_id: # Your Orbit workspace ID,
action: "list_activities",
filters: # Any filters on the request in JSON format, see Orbit API docs for reference
).response
```
#### Get Specific Activity
To get a specific activity:
```ruby
OrbitActivities::Request.new(
api_key: # Your Orbit API key,
workspace_id: # Your Orbit workspace ID,
action: "get_activity",
activity_id: # The ID of the actiivity
).response
```
#### Get Member Activities
To get activities associated with a specific member:
```ruby
OrbitActivities::Request.new(
api_key: # Your Orbit API key,
workspace_id: # Your Orbit workspace ID,
action: "list_member_activities",
activity_id: # The ID of the actiivity,
member_id: # The ID of the member,
filters: # Any filters on the request in JSON format, see Orbit API docs for reference
).response
```
#### Get Latest Activity Timestamp for Activity Type
To get the latest activity timestamp for a specific activity type:
```ruby
OrbitActivities::Request.new(
api_key: # Your Orbit API key,
workspace_id: # Your Orbit workspace ID,
action: "latest_activity_timestamp",
filters: { activity_type: # Activity type to search for, e.g. "custom:linkedin:comment" }
).response
```
For details on the data structures the Orbit API expects, refer to the [Orbit API Documentation](https://docs.orbit.love/reference).
## Contributing
We 💜 contributions from everyone! Check out the [Contributing Guidelines](CONTRIBUTING.md) for more information.
## License
This is available as open source under the terms of the [MIT License](LICENSE).
## Code of Conduct
This project uses the [Contributor Code of Conduct](CODE_OF_CONDUCT.md). We ask everyone to please adhere by its guidelines.