Giter VIP home page Giter VIP logo

eventdetectionapi-sdk-ruby's Introduction

Telstra_EventDetection

Telstra_EventDetection - the Ruby gem for the Telstra Event Detection API

  • API version: 1.0.0
  • Package version: 1.0.0

Installation

Build a gem

To build the Ruby code into a gem:

gem build Telstra_EventDetection.gemspec

Then either install the gem locally:

gem install ./Telstra_EventDetection-1.0.0.gem

(for development, run gem install --dev ./Telstra_EventDetection-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 'Telstra_EventDetection', '~> 1.0.0'

Install from Git

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

gem 'Telstra_EventDetection', :git => 'https://github.com/Telstra/EventDetectionAPI-SDK-ruby.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 'Telstra_EventDetection'

api_instance = Telstra_EventDetection::AuthenticationApi.new

client_id = "client_id_example" # String | 

client_secret = "client_secret_example" # String | 

grant_type = "client_credentials" # String | 


begin
  #Generate authentication token
  result = api_instance.auth_token(client_id, client_secret, grant_type)
  p result
rescue Telstra_EventDetection::ApiError => e
  puts "Exception when calling AuthenticationApi->auth_token: #{e}"
end

Documentation for API Endpoints

All URIs are relative to https://tapi.telstra.com

Class Method HTTP request Description
Telstra_EventDetection::AuthenticationApi auth_token POST /v2/oauth/token Generate authentication token
Telstra_EventDetection::GetSubscriptionApi get_subscription POST /v1/eventdetection/events/subscriptions Get Event Subscriptions
Telstra_EventDetection::LongPollApi longpoll POST /v1/eventdetection/events/{eventType} Poll events
Telstra_EventDetection::PushNotificationsApi push_notifications POST /v1/eventdetection/events/notifications Push event notifications
Telstra_EventDetection::RegistrationApi register POST /v1/eventdetection/events Register
Telstra_EventDetection::RegistrationApi unregister DELETE /v1/eventdetection/events/{eventType} Unregister

Documentation for Models

Documentation for Authorisation

auth

  • Type: OAuth
  • Flow: application
  • Authorisation URL:
  • Scopes:
    • v1_eventdetection_simswap: v1_eventdetection_simswap

eventdetectionapi-sdk-ruby's People

Contributors

developersteve avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.