# CampaignByMsg91

Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/campaign_by_msg91`. To experiment with that code, run `bin/console` for an interactive prompt.

TODO: Delete this and the text above, and describe your gem

## Installation

Add this line to your application's Gemfile:

```ruby
gem 'campaign_by_msg91'
```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install campaign_by_msg91

## Usage

After installation run

    $ rails g campaign_by_msg91:install

In your `config/initalizers/campaign_by_msg91.rb`, initialize your `auth_key`. This can be
obtained from [msg91.com](msg91.com)

### List Campaigns

To fetch list of campaigns

```ruby
campaigns = CampaignByMsg91::Campaign.new.index
```

### List Campaign Fields

To fetch list of campaign fields

```ruby
campaign_fields = CampaignByMsg91::Campaign.new.index_fields(campaign_slug)
```

### Show Campaign Request Body

To show campaign request body

```ruby
request_body = CampaignByMsg91::Campaign.new.show_request_body(campaign_slug)
```

### Run Campaign

To run a campaign

```ruby
response = CampaignByMsg91::Campaign.new.run_campaign(campaign_slug, request_body)
```

## Development

After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/campaign_by_msg91. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

## License

The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

## Code of Conduct

Everyone interacting in the CampaignByMsg91 project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/campaign_by_msg91/blob/master/CODE_OF_CONDUCT.md).