2.0.0 • Published 7 years ago

receptiviti_api v2.0.0

Weekly downloads
1
License
Unlicense
Repository
-
Last release
7 years ago

receptiviti_api

ReceptivitiApi - JavaScript client for receptiviti_api People profiling API This SDK is automatically generated by the Swagger Codegen project:

  • API version: 2.0
  • Package version: 2.0
  • Build package: io.swagger.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 receptiviti_api --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.

Getting Started

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

var ReceptivitiApi = require('receptiviti_api');

var api = new ReceptivitiApi.ContentsApi()

var id = "id_example"; // {String} The Receptiviti ID of the Content

var payload = new ReceptivitiApi.UpdateContentTagsAPIRequest(); // {UpdateContentTagsAPIRequest} 

var opts = { 
  'X_API_KEY': "X_API_KEY_example", // {String} Your API Key
  'X_API_SECRET_KEY': "X_API_SECRET_KEY_example" // {String} Your API Secret Key
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.deleteContentTagsApi(id, payload, opts, callback);

Documentation for API Endpoints

All URIs are relative to https://localhost/v2/api

ClassMethodHTTP requestDescription
ReceptivitiApi.ContentsApideleteContentTagsApiDELETE /content/{id}/tags
ReceptivitiApi.ContentsApigetContentApiGET /content/{id}
ReceptivitiApi.ContentsApiputContentTagsApiPUT /content/{id}/tags
ReceptivitiApi.GeneralApigetPingGET /ping
ReceptivitiApi.LSMApigetLsmScoreApiGET /lsm_score
ReceptivitiApi.PeopleAPIApideletePersonTagsApiDELETE /person/{person_id}/tags
ReceptivitiApi.PeopleAPIApigetMergedPersonalityApiGET /person/merged_personality
ReceptivitiApi.PeopleAPIApigetPersonApiGET /person/{id}
ReceptivitiApi.PeopleAPIApigetPersonContentsApiGET /person/{person_id}/contents
ReceptivitiApi.PeopleAPIApigetPersonListApiGET /person
ReceptivitiApi.PeopleAPIApigetPersonProfileApiGET /person/{person_id}/profile
ReceptivitiApi.PeopleAPIApigetPersonalityLongitudinalAnalysisApiGET /person/{person_id}/longitudinal_analysis
ReceptivitiApi.PeopleAPIApipostPersonContentsApiPOST /person/{person_id}/contents
ReceptivitiApi.PeopleAPIApipostPersonListApiPOST /person
ReceptivitiApi.PeopleAPIApiputPersonApiPUT /person/{id}
ReceptivitiApi.PeopleAPIApiputPersonTagsApiPUT /person/{person_id}/tags
ReceptivitiApi.TwitterImportAPIApigetTwitterImportRequestApiGET /import/twitter/requests/{id}
ReceptivitiApi.TwitterImportAPIApigetTwitterImportRequestPeopleListApiGET /import/twitter/requests/{id}/people
ReceptivitiApi.TwitterImportAPIApigetTwitterImportRequestsListApiGET /import/twitter/requests
ReceptivitiApi.TwitterImportAPIApipostTwitterUserImportPOST /import/twitter/user
ReceptivitiApi.UploadAPIApigetCsvUploadApiGET /upload/upload_request
ReceptivitiApi.UploadAPIApigetUploadRequestApiGET /upload/upload_request/{id}
ReceptivitiApi.UploadAPIApipostCsvUploadApiPOST /upload/upload_request

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization.