{"id":21017627,"url":"https://github.com/orbit-love/ruby-orbit-activities","last_synced_at":"2025-05-15T05:33:49.656Z","repository":{"id":48283660,"uuid":"366994736","full_name":"orbit-love/ruby-orbit-activities","owner":"orbit-love","description":"Orbit API helper library for Ruby. This client can create, read, update and delete activities in your Orbit workspace.","archived":false,"fork":false,"pushed_at":"2024-05-16T19:00:59.000Z","size":50,"stargazers_count":4,"open_issues_count":1,"forks_count":1,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-25T15:41:34.422Z","etag":null,"topics":["api","orbit","orbit-api","ruby","sdk"],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/orbit-love.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-05-13T09:11:18.000Z","updated_at":"2023-07-25T14:46:03.000Z","dependencies_parsed_at":"2022-08-12T19:41:32.536Z","dependency_job_id":null,"html_url":"https://github.com/orbit-love/ruby-orbit-activities","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/orbit-love%2Fruby-orbit-activities","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/orbit-love%2Fruby-orbit-activities/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/orbit-love%2Fruby-orbit-activities/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/orbit-love%2Fruby-orbit-activities/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/orbit-love","download_url":"https://codeload.github.com/orbit-love/ruby-orbit-activities/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254282994,"owners_count":22045131,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","orbit","orbit-api","ruby","sdk"],"created_at":"2024-11-19T10:20:19.981Z","updated_at":"2025-05-15T05:33:49.381Z","avatar_url":"https://github.com/orbit-love.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Orbit Activities Helper Library for Ruby\n\n![Build Status](https://github.com/orbit-love/ruby-orbit-activities/workflows/CI/badge.svg)\n[![Gem Version](https://badge.fury.io/rb/orbit_activities.svg)](https://badge.fury.io/rb/orbit_activities)\n[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.0-4baaaa.svg)](code_of_conduct.md)\n\n\u003e Orbit API helper library for Ruby. \u003cbr\u003eThis client can create, read, update and delete activities in your Orbit workspace.\n\n\u003cimg src=\"https://github.com/orbit-love/js-orbit-activities/blob/bc4ce38a34af95e40b2c3e54ba44d3df6b3d3aac/.github/logo.png\" alt=\"Orbit\" style=\"max-width: 300px; margin: 2em 0;\"\u003e\n\n## Package Usage\n\n### Installation\n\nTo install this integration in a standalone app, add the gem to your `Gemfile`:\n\n```ruby\ngem \"orbit_activities\"\n```\n\nThen, run `bundle install` from your terminal.\n\n### Usage\n\n#### Create an Activity\n\nTo create an activity:\n\n```ruby\nOrbitActivities::Request.new(\n    api_key: # Your Orbit API key,\n    workspace_id: # Your Orbit workspace ID,\n    action: \"new_activity\",\n    body: # The custom activity object in JSON format, see Orbit API docs for reference\n)\n```\n\nYou can inspect the Orbit API response by appending `.response` to the end of the initialization method.\n#### Update an Activity\n\nTo update an activity:\n\n```ruby\nOrbitActivities::Request.new(\n    api_key: # Your Orbit API key,\n    workspace_id: # Your Orbit workspace ID,\n    action: \"update_activity\",\n    activity_id: # The ID of the activity to be updated,\n    member_id: # The ID of the member the activity is attached to,\n    body: # The custom activity object in JSON format, see Orbit API docs for reference\n)\n```\n\nYou can inspect the Orbit API response by appending `.response` to the end of the initialization method.\n#### Delete an Activity\n\nTo delete an activity:\n\n```ruby\nOrbitActivities::Request.new(\n    api_key: # Your Orbit API key,\n    workspace_id: # Your Orbit workspace ID,\n    action: \"delete_activity\",\n    activity_id: # The ID of the activity to be updated,\n    member_id: # The ID of the member the activity is attached to\n)\n```\n\nYou can inspect the Orbit API response by appending `.response` to the end of the initialization method.\n#### List Activities\n\nTo list activities:\n\n```ruby\nOrbitActivities::Request.new(\n    api_key: # Your Orbit API key,\n    workspace_id: # Your Orbit workspace ID,\n    action: \"list_activities\",\n    filters: # Any filters on the request in JSON format, see Orbit API docs for reference\n).response\n```\n#### Get Specific Activity\n\nTo get a specific activity:\n\n```ruby\nOrbitActivities::Request.new(\n    api_key: # Your Orbit API key,\n    workspace_id: # Your Orbit workspace ID,\n    action: \"get_activity\",\n    activity_id: # The ID of the actiivity\n).response\n```\n#### Get Member Activities\n\nTo get activities associated with a specific member:\n\n```ruby\nOrbitActivities::Request.new(\n    api_key: # Your Orbit API key,\n    workspace_id: # Your Orbit workspace ID,\n    action: \"list_member_activities\",\n    activity_id: # The ID of the actiivity,\n    member_id: # The ID of the member,\n    filters: # Any filters on the request in JSON format, see Orbit API docs for reference\n).response\n```\n#### Get Latest Activity Timestamp for Activity Type\n\nTo get the latest activity timestamp for a specific activity type:\n\n```ruby\nOrbitActivities::Request.new(\n    api_key: # Your Orbit API key,\n    workspace_id: # Your Orbit workspace ID,\n    action: \"latest_activity_timestamp\",\n    filters: { activity_type: # Activity type to search for, e.g. \"custom:linkedin:comment\" }\n).response\n```\n\nFor details on the data structures the Orbit API expects, refer to the [Orbit API Documentation](https://docs.orbit.love/reference).\n\n## Contributing\n\nWe 💜 contributions from everyone! Check out the [Contributing Guidelines](CONTRIBUTING.md) for more information.\n\n## License\n\nThis is available as open source under the terms of the [MIT License](LICENSE).\n\n## Code of Conduct\n\nThis project uses the [Contributor Code of Conduct](CODE_OF_CONDUCT.md). We ask everyone to please adhere by its guidelines.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Forbit-love%2Fruby-orbit-activities","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Forbit-love%2Fruby-orbit-activities","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Forbit-love%2Fruby-orbit-activities/lists"}