dadapush_client 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b357b14e231875744e78f16f7039f350ea784e37
+  data.tar.gz: 8effaad8dcaccc4ca8ac48424c5555a146e1f726
+SHA512:
+  metadata.gz: '058ff8f6f06f3d3d1bc6da75478d884a901bb6d27f527355a886623f036aa5a3299966bf71478ebf7d7d7e4ecd304dcb9a0f3774ca4147513067d5db47fed243'
+  data.tar.gz: 8e0e9a4655a224910957bf96d959ed141d99f45c9e9a5136354a4fcec40c4b31a402853e4da202168ecde60c96ffd3eb68f1697400901368a6292b01fb73c14d

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :development, :test do
+  gem 'rake', '~> 12.0.0'
+  gem 'pry-byebug'
+  gem 'rubocop', '~> 0.66.0'
+end

data/Gemfile.lock

@@ -0,0 +1,79 @@
+PATH
+  remote: .
+  specs:
+    dadapush_client (1.0.0)
+      json (~> 2.1, >= 2.1.0)
+      typhoeus (~> 1.0, >= 1.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ZenTest (4.11.2)
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    autotest (4.4.6)
+      ZenTest (>= 4.4.1)
+    autotest-fsevent (0.2.14)
+      sys-uname
+    autotest-growl (0.2.16)
+    autotest-rails-pure (4.1.2)
+    byebug (10.0.2)
+    coderay (1.1.2)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
+    ethon (0.11.0)
+      ffi (>= 1.3.0)
+    ffi (1.9.25)
+    hashdiff (0.3.7)
+    json (2.1.0)
+    method_source (0.9.0)
+    pry (0.11.3)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.6.0)
+      byebug (~> 10.0)
+      pry (~> 0.10)
+    public_suffix (3.0.3)
+    rake (12.0.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    safe_yaml (1.0.4)
+    sys-uname (1.0.3)
+      ffi (>= 1.0.0)
+    typhoeus (1.3.0)
+      ethon (>= 0.9.0)
+    vcr (3.0.3)
+    webmock (1.24.6)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  autotest (~> 4.4, >= 4.4.6)
+  autotest-fsevent (~> 0.2, >= 0.2.12)
+  autotest-growl (~> 0.2, >= 0.2.16)
+  autotest-rails-pure (~> 4.1, >= 4.1.2)
+  dadapush_client!
+  pry-byebug
+  rake (~> 12.0.0)
+  rspec (~> 3.6, >= 3.6.0)
+  vcr (~> 3.0, >= 3.0.1)
+  webmock (~> 1.24, >= 1.24.3)
+
+BUNDLED WITH
+   1.16.1

data/README.md

@@ -0,0 +1,105 @@
+# 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/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
+
+    gem 'dadapush_client', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.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)
+
+
+## Documentation for Authorization
+
+ All endpoints do not require authorization.
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new(:spec)
+  task default: :spec
+rescue LoadError
+  # no rspec available
+end

data/dadapush_client.gemspec

@@ -0,0 +1,45 @@
+# -*- encoding: utf-8 -*-
+
+=begin
+#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.
+
+The version of the OpenAPI document: v1
+Contact: contacts@dadapush.com
+Generated by: https://openapi-generator.tech
+OpenAPI Generator version: 4.0.2
+
+=end
+
+$:.push File.expand_path("../lib", __FILE__)
+require "dadapush_client/version"
+
+Gem::Specification.new do |s|
+  s.name        = "dadapush_client"
+  s.version     = DaDaPushClient::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["DaDaPush.com"]
+  s.email       = ["contacts@dadapush.com"]
+  s.homepage    = "https://www.dadapush.com"
+  s.summary     = "DaDaPush Client For Ruby"
+  s.description = "DaDaPush: Real-time Notifications App Send real-time notifications through our API without coding and maintaining your own app for iOS or Android devices."
+  s.license     = 'Apache 2.0'
+  s.required_ruby_version = ">= 1.9"
+
+  s.add_runtime_dependency 'typhoeus', '~> 1.0', '>= 1.0.1'
+  s.add_runtime_dependency 'json', '~> 2.1', '>= 2.1.0'
+
+  s.add_development_dependency 'rspec', '~> 3.6', '>= 3.6.0'
+  s.add_development_dependency 'vcr', '~> 3.0', '>= 3.0.1'
+  s.add_development_dependency 'webmock', '~> 1.24', '>= 1.24.3'
+  s.add_development_dependency 'autotest', '~> 4.4', '>= 4.4.6'
+  s.add_development_dependency 'autotest-rails-pure', '~> 4.1', '>= 4.1.2'
+  s.add_development_dependency 'autotest-growl', '~> 0.2', '>= 0.2.16'
+  s.add_development_dependency 'autotest-fsevent', '~> 0.2', '>= 0.2.12'
+
+  s.files         = `find *`.split("\n").uniq.sort.select { |f| !f.empty? }
+  s.test_files    = `find spec/*`.split("\n")
+  s.executables   = []
+  s.require_paths = ["lib"]
+end

data/docs/Action.md

@@ -0,0 +1,21 @@
+# DaDaPushClient::Action
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **String** | action button name | 
+**type** | **String** | fix value: link | 
+**url** | **String** | action url | 
+
+## Code Sample
+
+```ruby
+require 'DaDaPushClient'
+
+instance = DaDaPushClient::Action.new(name: VIEW,
+                                 type: link,
+                                 url: https://www.dadapush.com/)
+```
+
+

data/docs/DaDaPushMessageApi.md

@@ -0,0 +1,218 @@
+# DaDaPushClient::DaDaPushMessageApi
+
+All URIs are relative to *https://www.dadapush.com*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**create_message**](DaDaPushMessageApi.md#create_message) | **POST** /api/v1/message | push Message to a Channel
+[**delete_message**](DaDaPushMessageApi.md#delete_message) | **DELETE** /api/v1/message/{messageId} | delete a Channel Message
+[**get_message**](DaDaPushMessageApi.md#get_message) | **GET** /api/v1/message/{messageId} | get a Channel Message
+[**get_messages**](DaDaPushMessageApi.md#get_messages) | **GET** /api/v1/messages | get Message List
+
+
+
+## create_message
+
+> ResultOfMessagePushResponse create_message(body, opts)
+
+push Message to a Channel
+
+<h2>Rate Limit:</h2><ul><li>1 request per 1s</li><li>30 request per 1m</li><li>500 request per 1h</li></ul><h2>Result code/errmsg List:</h2><ul><li>0: ok</li><li>1: server error</li><li>101: channel is exists</li><li>102: channel is not exists</li><li>103: channel token error</li><li>104: channel is not exists</li><li>105: message is not exists</li><li>204: bad request</li><li>205: permission deny</li><li>206: too many request, please after 5 minutes to try!</li><li>301: duplicate username/email</li><li>302: user is not exists</li><li>303: user password is error</li><li>304: client push token is error</li><li>305: user is disabled</li><li>306: your subscription is expired</li><li>307: user not subscribe channel</li></ul>
+
+### Example
+
+```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
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**MessagePushRequest**](MessagePushRequest.md)| body | 
+ **x_channel_token** | **String**| see: https://www.dadapush.com/channel/list | [optional] 
+
+### Return type
+
+[**ResultOfMessagePushResponse**](ResultOfMessagePushResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/json
+- **Accept**: application/json
+
+
+## delete_message
+
+> Result delete_message(message_id, opts)
+
+delete a Channel Message
+
+<h2>Rate Limit:</h2><ul><li>10 request per 1s</li><li>100 request per 1m</li><li>1000 request per 1h</li></ul><h2>Result code/errmsg List:</h2><ul><li>0: ok</li><li>1: server error</li><li>101: channel is exists</li><li>102: channel is not exists</li><li>103: channel token error</li><li>104: channel is not exists</li><li>105: message is not exists</li><li>204: bad request</li><li>205: permission deny</li><li>206: too many request, please after 5 minutes to try!</li><li>301: duplicate username/email</li><li>302: user is not exists</li><li>303: user password is error</li><li>304: client push token is error</li><li>305: user is disabled</li><li>306: your subscription is expired</li><li>307: user not subscribe channel</li></ul>
+
+### Example
+
+```ruby
+# load the gem
+require 'dadapush_client'
+
+api_instance = DaDaPushClient::DaDaPushMessageApi.new
+message_id = 56 # Integer | messageId
+opts = {
+  x_channel_token: 'x_channel_token_example' # String | see: https://www.dadapush.com/channel/list
+}
+
+begin
+  #delete a Channel Message
+  result = api_instance.delete_message(message_id, opts)
+  p result
+rescue DaDaPushClient::ApiError => e
+  puts "Exception when calling DaDaPushMessageApi->delete_message: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **message_id** | **Integer**| messageId | 
+ **x_channel_token** | **String**| see: https://www.dadapush.com/channel/list | [optional] 
+
+### Return type
+
+[**Result**](Result.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_message
+
+> ResultOfMessageObject get_message(message_id, opts)
+
+get a Channel Message
+
+<h2>Rate Limit:</h2><ul><li>10 request per 1s</li><li>100 request per 1m</li><li>1000 request per 1h</li></ul><h2>Result code/errmsg List:</h2><ul><li>0: ok</li><li>1: server error</li><li>101: channel is exists</li><li>102: channel is not exists</li><li>103: channel token error</li><li>104: channel is not exists</li><li>105: message is not exists</li><li>204: bad request</li><li>205: permission deny</li><li>206: too many request, please after 5 minutes to try!</li><li>301: duplicate username/email</li><li>302: user is not exists</li><li>303: user password is error</li><li>304: client push token is error</li><li>305: user is disabled</li><li>306: your subscription is expired</li><li>307: user not subscribe channel</li></ul>
+
+### Example
+
+```ruby
+# load the gem
+require 'dadapush_client'
+
+api_instance = DaDaPushClient::DaDaPushMessageApi.new
+message_id = 56 # Integer | messageId
+opts = {
+  x_channel_token: 'x_channel_token_example' # String | see: https://www.dadapush.com/channel/list
+}
+
+begin
+  #get a Channel Message
+  result = api_instance.get_message(message_id, opts)
+  p result
+rescue DaDaPushClient::ApiError => e
+  puts "Exception when calling DaDaPushMessageApi->get_message: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **message_id** | **Integer**| messageId | 
+ **x_channel_token** | **String**| see: https://www.dadapush.com/channel/list | [optional] 
+
+### Return type
+
+[**ResultOfMessageObject**](ResultOfMessageObject.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_messages
+
+> ResultOfPageResponseOfMessageObject get_messages(page, page_size, opts)
+
+get Message List
+
+<h2>Rate Limit:</h2><ul><li>1 request per 1s</li><li>45 request per 1m</li></ul><h2>Result code/errmsg List:</h2><ul><li>0: ok</li><li>1: server error</li><li>101: channel is exists</li><li>102: channel is not exists</li><li>103: channel token error</li><li>104: channel is not exists</li><li>105: message is not exists</li><li>204: bad request</li><li>205: permission deny</li><li>206: too many request, please after 5 minutes to try!</li><li>301: duplicate username/email</li><li>302: user is not exists</li><li>303: user password is error</li><li>304: client push token is error</li><li>305: user is disabled</li><li>306: your subscription is expired</li><li>307: user not subscribe channel</li></ul>
+
+### Example
+
+```ruby
+# load the gem
+require 'dadapush_client'
+
+api_instance = DaDaPushClient::DaDaPushMessageApi.new
+page = 1 # Integer | greater than 1
+page_size = 10 # Integer | range is 1,50
+opts = {
+  x_channel_token: 'x_channel_token_example' # String | see: https://www.dadapush.com/channel/list
+}
+
+begin
+  #get Message List
+  result = api_instance.get_messages(page, page_size, opts)
+  p result
+rescue DaDaPushClient::ApiError => e
+  puts "Exception when calling DaDaPushMessageApi->get_messages: #{e}"
+end
+```
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **page** | **Integer**| greater than 1 | [default to 1]
+ **page_size** | **Integer**| range is 1,50 | [default to 10]
+ **x_channel_token** | **String**| see: https://www.dadapush.com/channel/list | [optional] 
+
+### Return type
+
+[**ResultOfPageResponseOfMessageObject**](ResultOfPageResponseOfMessageObject.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+