long-strange-trip v0.0.2

long_strange_trip_api

LongStrangeTripApi - JavaScript client for long_strange_trip_api This app is about you. All the places you've been, where you are now, and oh all the places you'll go. This SDK is automatically generated by the Swagger Codegen project:

• API version: 0.0.1
• Package version: 0.0.1
• Build package: io.swagger.codegen.languages.JavascriptClientCodegen For more information, please visit https://github.com/weareudonishaslem/

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 long_strange_trip_api --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 long_strange_trip_api from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('long_strange_trip_api') 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/YOUR_USERNAME/long_strange_trip_api then install it via:

    npm install YOUR_USERNAME/long_strange_trip_api --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 LongStrangeTripApi = require('long_strange_trip_api');

var defaultClient = LongStrangeTripApi.ApiClient.instance;

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

var api = new LongStrangeTripApi.DatasetsApi()

var owner = "weareudonishaslem"; // {String} User name and unique identifier of the creator of a dataset or project. For example, in the URL: [https://data.world/jonloyens/an-intro-to-dataworld-dataset](https://data.world/jonloyens/an-intro-to-dataworld-dataset), jonloyens is the unique identifier of the owner.

var id = "blog-series"; // {String} Dataset unique identifier. For example, in the URL:[https://data.world/jonloyens/an-intro-to-dataworld-dataset](https://data.world/jonloyens/an-intro-to-dataworld-dataset), an-intro-to-dataworld-dataset is the unique identifier of the dataset.

var body = new LongStrangeTripApi.FileBatchUpdateRequest(); // {FileBatchUpdateRequest} 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addFilesBySource(owner, id, body, callback);

Documentation for API Endpoints

All URIs are relative to https://api.data.world/v0

Documentation for Models

• LongStrangeTripApi.CreateDatasetResponse
• LongStrangeTripApi.CreateInsightResponse
• LongStrangeTripApi.CreateProjectResponse
• LongStrangeTripApi.DatasetCreateRequest
• LongStrangeTripApi.DatasetPatchRequest
• LongStrangeTripApi.DatasetPutRequest
• LongStrangeTripApi.DatasetSummaryResponse
• LongStrangeTripApi.ErrorMessage
• LongStrangeTripApi.FileBatchUpdateRequest
• LongStrangeTripApi.FileCreateOrUpdateRequest
• LongStrangeTripApi.FileCreateRequest
• LongStrangeTripApi.FileSourceCreateOrUpdateRequest
• LongStrangeTripApi.FileSourceCreateRequest
• LongStrangeTripApi.FileSourceSummaryResponse
• LongStrangeTripApi.FileSummaryResponse
• LongStrangeTripApi.InsightBody
• LongStrangeTripApi.InsightCreateRequest
• LongStrangeTripApi.InsightPatchRequest
• LongStrangeTripApi.InsightPutRequest
• LongStrangeTripApi.InsightSummaryResponse
• LongStrangeTripApi.LinkedDatasetCreateOrUpdateRequest
• LongStrangeTripApi.LinkedDatasetSummaryResponse
• LongStrangeTripApi.OauthTokenReference
• LongStrangeTripApi.PaginatedDatasetResults
• LongStrangeTripApi.PaginatedInsightResults
• LongStrangeTripApi.PaginatedProjectResults
• LongStrangeTripApi.ProjectCreateRequest
• LongStrangeTripApi.ProjectPatchRequest
• LongStrangeTripApi.ProjectSummaryResponse
• LongStrangeTripApi.SuccessMessage
• LongStrangeTripApi.UserDataResponse
• LongStrangeTripApi.WebAuthorization
• LongStrangeTripApi.WebCredentials

Documentation for Authorization

token

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