Incident.io Ruby SDK

A comprehensive Ruby SDK for interacting with the incident.io API, generated using OpenAPI Generator. This SDK provides full coverage of the REST API endpoints to integrate with the incident.io platform.

• Installation
• Usage
• Development
• Testing
• Contributing
• License

To install the gem, run the following command:

gem install incident_io_sdk

Alternatively, you can add it to your Gemfile:

gem 'incident_io_sdk', '~> 0.1.3'

Then run:

bundle install

First, you'll need to configure the SDK with your access token:

require 'incident_io_sdk'

config = IncidentIoSdk::Configuration.new
config.access_token = api_key
client = IncidentIoSdk::ApiClient.new(config)

Once the client is initialized, you can use it to interact with the API:

# Example: Fetching schedule entries

api = IncidentIoSdk::SchedulesV2Api.new(client)
response = api.list_schedule_entries(SCHEDULE_ID, opts)

For full usage examples, refer to the documentation.

Ensure that you have the following installed:

• Ruby (>= 2.7)
• Bundler (install with gem install bundler)
• Dependencies can be installed with:

bundle install

For development purposes, you can run the SDK in a local environment:

1. Clone the repository:

   git clone https://github.com/mustafabayar/incident-io-sdk.git
   cd incident-io-sdk

2. Install dependencies:

   bundle install

To run the test suite:

bundle exec rspec

This will run all tests under the spec directory.

We welcome contributions! If you'd like to help improve this SDK, please follow these steps:

1. Fork the repository
2. Create a new branch for your feature or fix
3. Write tests and documentation as needed
4. Ensure all tests pass
5. Submit a pull request

Please make sure to update tests as appropriate.

This project is licensed under the MIT License - see the LICENSE file for details.