@gobodo/gobodo-api v0.1.68

@gobodo/gobodo-api

GobodoGobodoApi - JavaScript client for @gobodo/gobodo-api REST Interface for Gobodo API This SDK is automatically generated by the OpenAPI Generator project:

• API version: 0.1.68
• Package version: 0.1.68
• 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 @gobodo/gobodo-api --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 @gobodo/gobodo-api 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 GobodoGobodoApi = require('@gobodo/gobodo-api');

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

var api = new GobodoGobodoApi.ActionTypesApi()
var id = 789; // {Number} 
var actiontypeid = 789; // {Number} 
var opts = {
  'authorization': "authorization_example", // {String} The authorization token of the logged in user
  'cacheduration': 56, // {Number} The how long the cache entry should persist
  'cachegroup': ["null"], // {[String]} The cache group(s) the cache entry specified by the cachekey should be grouped to
  'cachekey': ["null"], // {[String]} The key to cache the response or the key to remove if a post, put, or delete operation
  'cachescope': "cachescope_example", // {String} The scope of storage of the cache item
  'cacheuser': ["null"], // {[String]} The users the cachekey should be applied to (this is only valid for clearing cache elements previously set for that user)
  'zeusportalPostasApp': 789, // {Number} The id of the application this operation is being performed as if the caller chooses to post as an organization page
  'zeusportalPostas': 789, // {Number} The id of the organization page this operation is being performed as if the caller chooses to post as an organization page
  'zeusportalPostasSite': 789, // {Number} The id of the site this operation is being performed as if the caller chooses to post as an organization page
  'transactionid': "transactionid_example" // {String} The id of the transaction this operation is being run in
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getActionsByType(id, actiontypeid, opts, callback);

Documentation for API Endpoints

All URIs are relative to https://test.api.gobodo.io

*GobodoGobodoApi.