Skip to content

telstra/EventDetectionAPI-SDK-node

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Telstra_EventDetection

TelstraEventDetection - JavaScript client for Telstra_EventDetection

  • API version: 1.0.0
  • Package version: 1.0.0

Installation

npm

To publish the library as a npm,

Then install it via:

npm install Telstra_EventDetection --save
Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

Finally, switch to the directory you want to use your Telstra_EventDetection from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('Telstra_EventDetection') in javascript files from the directory you ran the last command above from.

git

If the library is hosted at a git repository, e.g. https://github.com/Telstra/EventDetectionAPI-SDK-node then install it via:

    npm install Telstra/EventDetectionAPI-SDK-node --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file, that's to say your javascript file where you actually use this library):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

Please follow the installation instruction and execute the following JS code:

var TelstraEventDetection = require('Telstra_EventDetection');

var api = new TelstraEventDetection.AuthenticationApi()

var clientId = "clientId_example"; // {String} 

var clientSecret = "clientSecret_example"; // {String} 

var grantType = "client_credentials"; // {String} 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.authToken(clientId, clientSecret, grantType, callback);

Documentation for API Endpoints

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

Class Method HTTP request Description
TelstraEventDetection.AuthenticationApi authToken POST /v2/oauth/token Generate authentication token
TelstraEventDetection.GetSubscriptionApi getSubscription POST /v1/eventdetection/events/subscriptions Get Event Subscriptions
TelstraEventDetection.LongPollApi longpoll POST /v1/eventdetection/events/{eventType} Poll events
TelstraEventDetection.PushNotificationsApi pushNotifications POST /v1/eventdetection/events/notifications Push event notifications
TelstraEventDetection.RegistrationApi register POST /v1/eventdetection/events Register
TelstraEventDetection.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

About

The Telstra Event Detection API provides the ability to subscribe to and receive network events for a given set of mobile numbers

Topics

Resources

Stars

Watchers

Forks

Packages

No packages published