Skip to content

thystreet/thystreet-javascript-sdk

Repository files navigation

@thystreet/sdk

ThyStreet - JavaScript client for @thystreet/sdk These are API's to easily manage your Thy Street device public pages. Thy Street APIs are completely RESTful and all our responses are returned in JSON. This SDK is automatically generated by the OpenAPI Generator project:

Installation

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install @thystreet/sdk --save

Finally, you need to build the module:

npm run build
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

To use the link you just defined in your project, switch to the directory you want to use your @thystreet/sdk from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

npm run build

git

If the library is hosted at a git repository, e.g.https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --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):

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 ThyStreet = require('@thystreet/sdk');

var defaultClient = ThyStreet.ApiClient.instance;
// Configure HTTP basic authorization: thystreetAuth
var thystreetAuth = defaultClient.authentications['thystreetAuth'];
thystreetAuth.username = 'YOUR USERNAME'
thystreetAuth.password = 'YOUR PASSWORD'

var api = new ThyStreet.DeviceApi()
var deviceId = "deviceId_example"; // {String} 
api.generateToken(deviceId).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

Documentation for API Endpoints

All URIs are relative to https://cheffy-api.thystreet.com/api/v1

Class Method HTTP request Description
ThyStreet.DeviceApi generateToken GET /device/generate/{deviceId}
ThyStreet.DeviceApi setDetails PUT /device/details Toggle your device tariff when your device goes online using this api.
ThyStreet.DeviceApi setToken PUT /device/token
ThyStreet.OrderApi getOrderById GET /order/params/{orderToken}
ThyStreet.OrderApi setStatus PUT /order/status/{orderToken}

Documentation for Models

Documentation for Authorization

thystreetAuth

  • Type: HTTP basic authentication

About

SDK for easy access of Thy Street API for nodejs

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors