# dadapush_client

DaDaPushClient - the Ruby gem for the DaDaPush Public API

DaDaPush: Real-time Notifications App

Send real-time notifications through our API without coding and maintaining your own app for iOS or Android devices.

This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: v1
- Package version: 1.0.0
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
For more information, please visit [https://www.dadapush.com](https://www.dadapush.com)

## Installation

### Build a gem

To build the Ruby code into a gem:

```shell
gem build dadapush_client.gemspec
```

Then either install the gem locally:

```shell
gem install ./dadapush_client-1.0.0.gem
```

(for development, run `gem install --dev ./dadapush_client-1.0.0.gem` to install the development dependencies)

or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).

Finally add this to the Gemfile:

    gem 'dadapush_client', '~> 1.0.0'

### Install from Git

If the Ruby gem is hosted at a git repository: https://github.com/dadapush/dadapush-ruby-client, then add the following in the Gemfile:

    gem 'dadapush_client', :git => 'https://github.com/dadapush/dadapush-ruby-client.git'

### Include the Ruby code directly

Include the Ruby code directly using `-I` as follows:

```shell
ruby -Ilib script.rb
```

## Getting Started

Please follow the [installation](#installation) procedure and then run the following code:

```ruby
# Load the gem
require 'dadapush_client'

api_instance = DaDaPushClient::DaDaPushMessageApi.new
body = DaDaPushClient::MessagePushRequest.new # MessagePushRequest | body
opts = {
  x_channel_token: 'x_channel_token_example' # String | see: https://www.dadapush.com/channel/list
}

begin
  #push Message to a Channel
  result = api_instance.create_message(body, opts)
  p result
rescue DaDaPushClient::ApiError => e
  puts "Exception when calling DaDaPushMessageApi->create_message: #{e}"
end

```

## Documentation for API Endpoints

All URIs are relative to *https://www.dadapush.com*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*DaDaPushClient::DaDaPushMessageApi* | [**create_message**](docs/DaDaPushMessageApi.md#create_message) | **POST** /api/v1/message | push Message to a Channel
*DaDaPushClient::DaDaPushMessageApi* | [**delete_message**](docs/DaDaPushMessageApi.md#delete_message) | **DELETE** /api/v1/message/{messageId} | delete a Channel Message
*DaDaPushClient::DaDaPushMessageApi* | [**get_message**](docs/DaDaPushMessageApi.md#get_message) | **GET** /api/v1/message/{messageId} | get a Channel Message
*DaDaPushClient::DaDaPushMessageApi* | [**get_messages**](docs/DaDaPushMessageApi.md#get_messages) | **GET** /api/v1/messages | get Message List


## Documentation for Models

 - [DaDaPushClient::Action](docs/Action.md)
 - [DaDaPushClient::MessageObject](docs/MessageObject.md)
 - [DaDaPushClient::MessagePushRequest](docs/MessagePushRequest.md)
 - [DaDaPushClient::MessagePushResponse](docs/MessagePushResponse.md)
 - [DaDaPushClient::PageResponseOfMessageObject](docs/PageResponseOfMessageObject.md)
 - [DaDaPushClient::Result](docs/Result.md)
 - [DaDaPushClient::ResultOfMessageObject](docs/ResultOfMessageObject.md)
 - [DaDaPushClient::ResultOfMessagePushResponse](docs/ResultOfMessagePushResponse.md)
 - [DaDaPushClient::ResultOfPageResponseOfMessageObject](docs/ResultOfPageResponseOfMessageObject.md)