pushy

Pushy - the Ruby gem for the Pushy

No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)

This SDK is automatically generated by the OpenAPI Generator project:

• API version: 1.0.0
• Package version: 1.0.0
• Build package: org.openapitools.codegen.languages.RubyClientCodegen

Installation

Build a gem

To build the Ruby code into a gem:

gem build pushy.gemspec

Then either install the gem locally:

gem install ./pushy-1.0.0.gem

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

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to the Gemfile:

gem 'pushy', '~> 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 'pushy', :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:

ruby -Ilib script.rb

Getting Started

Please follow the installation procedure and then run the following code:

# Load the gem
require 'pushy'

# Setup authorization
Pushy.configure do |config|
  # Configure API key authorization: ApiKeyAuth
  config.api_key['api_key'] = 'YOUR API KEY'
  # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
  #config.api_key_prefix['api_key'] = 'Bearer'
end

api_instance = Pushy::NotificationsApi.new
push_notification = Pushy::PushNotification.new # PushNotification | 

begin
  result = api_instance.push_post(push_notification)
  p result
rescue Pushy::ApiError => e
  puts "Exception when calling NotificationsApi->push_post: #{e}"
end

Documentation for API Endpoints

All URIs are relative to https://api.pushy.me

Class	Method	HTTP request	Description
Pushy::NotificationsApi	push_post	POST /push

Documentation for Models

• Pushy::ApiError
• Pushy::Notification
• Pushy::PushNotification
• Pushy::PushResponse

Documentation for Authorization

ApiKeyAuth

• Type: API key
• API key parameter name: api_key
• Location: URL query string