Socket
Book a DemoInstallSign in
Socket

rownd-package

Package Overview
Dependencies
Maintainers
1
Versions
1
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

rownd-package

The Rownd Data Platform makes data privacy fast and easy. Prior to using the package, you must get an API key and secret from https://app.rownd.io.

1.0.0
latest
npmnpm
Version published
Weekly downloads
2
Maintainers
1
Weekly downloads
 
Created
Source

rownd

Rownd - JavaScript client for rownd The Rownd Data Platform API is easy and fast to use. Prior to using the API, you must register an app on the Rownd platform (www.app.rownd.io), retrieve an App Key and Secret, and map personal data-types.
This SDK is automatically generated by the Swagger Codegen project:

  • API version: 1.0.0
  • Package version: 1.0.0
  • Build package: io.swagger.codegen.v3.generators.javascript.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 rownd-package --save

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 Rownd = require('rownd-package');
var defaultClient = Rownd.ApiClient.instance;

// Configure API key authorization: appKey
var appKey = defaultClient.authentications['appKey'];
appKey.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//appKey.apiKeyPrefix['x-rownd-app-key'] = "Token"

// Configure API key authorization: appSecret
var appSecret = defaultClient.authentications['appSecret'];
appSecret.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//appSecret.apiKeyPrefix['x-rownd-app-secret'] = "Token"


var api = new Rownd.AddUserDataApi()
var app = "app_example"; // {String} 
var user = "user_example"; // {String} 
var opts = { 
  'body': new Rownd.AppUserData() // {AppUserData} 
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.applicationUserDataUpsert(app, user, opts, callback);

Documentation for API Endpoints

All URIs are relative to https://api.rownd.io

ClassMethodHTTP requestDescription
Rownd.AddUserDataApiapplicationUserDataUpsertPUT /applications/{app}/users/{user}/data
Rownd.ApplicationsApiapplicationListGET /accounts/{account}/applications
Rownd.DeleteUserDataApiapplicationUserDataDeleteDELETE /applications/{app}/users/{user}/data
Rownd.GetUserDataApiapplicationUserDataGetGET /applications/{app}/users/{user}/data
Rownd.GetUserDataApiapplicationUserDataListGET /applications/{app}/users/data

Documentation for Models

Documentation for Authorization

appKey

  • Type: API key
  • API key parameter name: x-rownd-app-key
  • Location: HTTP header

appSecret

  • Type: API key
  • API key parameter name: x-rownd-app-secret
  • Location: HTTP header

auth0

FAQs

Package last updated on 02 Dec 2020

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

About

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.

  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc

U.S. Patent No. 12,346,443 & 12,314,394. Other pending.