@topoos/context

context

Context - JavaScript client for context Context OpenApi definition This SDK is automatically generated by the OpenAPI Generator project:

• API version: 1.0.1
• Package version: 2.0.0
• Build package: org.openapitools.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

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

Then install it via:

npm install @topoos/context --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 context 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 Context = require('@topoos/context');

var defaultClient = Context.ApiClient.instance;
// Configure API key authorization: customAuth
var customAuth = defaultClient.authentications['customAuth'];
customAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//customAuth.apiKeyPrefix['Authorization'] = "Token"
// Configure OAuth2 access token for authorization: default
var default = defaultClient.authentications['default'];
default.accessToken = "YOUR ACCESS TOKEN"

var api = new Context.ContextApi()
var userId = "userId_example"; // {String} 
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getContext(userId, callback);

Documentation for API Endpoints

All URIs are relative to https://api.topoos.com/ctx/1.0.0

Class	Method	HTTP request	Description
Context.ContextApi	getContext	GET /context/{userId}
Context.GeozonesApi	deleteGeozone	DELETE /geozones/{geozoneId}
Context.GeozonesApi	getDetectTaskStatus	GET /geozones/detectTask/{taskId}
Context.GeozonesApi	getGeozone	GET /geozones/{geozoneId}
Context.GeozonesApi	getGeozones	GET /geozones
Context.GeozonesApi	getUserGeozones	GET /geozones/users/{userId}
Context.GeozonesApi	postDetectTask	POST /geozones/detectTask
Context.GeozonesApi	postGeozone	POST /geozones
Context.GeozonesApi	putGeozone	PUT /geozones/{geozoneId}
Context.MonitorsApi	putMonitor	PUT /monitor/{userId}
Context.ProactivityApi	deleteWebhook	DELETE /proactivity/webhooks/{webhookId}
Context.ProactivityApi	getWebhook	GET /proactivity/webhooks/{webhookId}
Context.ProactivityApi	getWebhooks	GET /proactivity/webhooks
Context.ProactivityApi	postWebhook	POST /proactivity/webhooks
Context.ProactivityApi	putWebhook	PUT /proactivity/webhooks/{webhookId}
Context.RelevantZonesApi	deleteDetectParameters	DELETE /geozones/relevant/parameters
Context.RelevantZonesApi	getDetectParameters	GET /geozones/relevant/parameters
Context.RelevantZonesApi	putDetectParameters	PUT /geozones/relevant/parameters
Context.SearchApi	postSearch	POST /_search

Documentation for Models

• Context.ContextGETResponse
• Context.ContextGETResponseData
• Context.ContextGETResponseDataContext
• Context.ContextGETResponseDataContextEnvironment
• Context.ContextGETResponseDataContextEnvironmentTag
• Context.ContextGETResponseDataContextEnvironmentWeather
• Context.ContextGETResponseDataContextPersonal
• Context.ContextGETResponseDataContextPersonalActivity
• Context.ContextGETResponseDataContextPersonalStatus
• Context.ContextGETResponseDataContextTimespace
• Context.ContextGETResponseDataContextTimespaceGeo
• Context.ContextGETResponseDataContextTimespaceGeotriggers
• Context.ContextGETResponseDataContextTimespaceGeozone
• Context.ContextGETResponseDataContextTimespaceTag
• Context.ContextGETResponseDataItems
• Context.ErrorResponse
• Context.ErrorResponseError
• Context.ErrorResponseErrorErrors
• Context.GenericPOSTResponse
• Context.GenericPOSTResponseData
• Context.Geo
• Context.GeozoneGETResponse
• Context.GeozoneGETResponseData
• Context.GeozoneGETResponseDataItems
• Context.GeozoneGETResponseDataProperties
• Context.GeozonePOSTRequest
• Context.GeozonePOSTRequestProperties
• Context.GeozonesGETResponse
• Context.GeozonesGETResponseData
• Context.GeozonesGETResponseDataItems
• Context.GeozonesGETResponseDataProperties
• Context.MonitorPUTRequest
• Context.MonitorPUTRequestActivity
• Context.MonitorPUTRequestBatch
• Context.MonitorPUTRequestGeo
• Context.MonitorPUTRequestProperties
• Context.Passport
• Context.RelevantZoneParameters
• Context.RelevantZoneParametersGETResponse
• Context.RelevantZoneParametersGETResponseData
• Context.SearchPOSTRequest
• Context.TaskGETResponse
• Context.TaskGETResponseData
• Context.TaskGETResponseDataItems
• Context.WebhookGETResponse
• Context.WebhookGETResponseData
• Context.WebhookGETResponseDataItems
• Context.WebhookPOSTRequest

Documentation for Authorization

customAuth

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header

default

• Type: OAuth
• Flow: implicit
• Authorization URL: https://test.com
• Scopes: N/A