Stalactite-data-client-js NPM

stalactite-data-client-js

StalactiteDataClientJs - JavaScript client for stalactite-data-client-js No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator) This SDK is automatically generated by the OpenAPI Generator project:

API version: 0.4.1-dev.bd231ef55e5bb92892335c80f9248fcaae852223
Package version: 0.4.1-dev.bd231ef55e5bb92892335c80f9248fcaae852223
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 stalactite-data-client-js --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 stalactite-data-client-js 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 StalactiteDataClientJs = require('stalactite-data-client-js');

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

var api = new StalactiteDataClientJs.CustomersApi()
var createCustomerRequest = new StalactiteDataClientJs.CreateCustomerRequest(); // {CreateCustomerRequest} 
api.createCustomer(createCustomerRequest).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Documentation for API Endpoints

All URIs are relative to https://stalactite.jalis.dev/data

Class	Method	HTTP request
StalactiteDataClientJs.CustomersApi	createCustomer	POST /customers
StalactiteDataClientJs.CustomersApi	deleteCustomer	DELETE /customers/{uid}
StalactiteDataClientJs.CustomersApi	getCustomer	GET /customers/{uid}
StalactiteDataClientJs.CustomersApi	getCustomerBy	GET /customers/by
StalactiteDataClientJs.CustomersApi	getCustomers	GET /customers
StalactiteDataClientJs.CustomersApi	getMyCustomerInfos	GET /customers/me
StalactiteDataClientJs.CustomersApi	updateCustomer	PUT /customers/{uid}
StalactiteDataClientJs.CustomersAccessApi	getCustomerAccessClearance	GET /customers/{customerUid}/access/{domainUid}
StalactiteDataClientJs.CustomersAccessApi	getMyCustomerAccessClearance	GET /customers/me/access/{uid}
StalactiteDataClientJs.CustomersRelationsApi	getCustomerRelations	GET /customers/{uid}/relations
StalactiteDataClientJs.CustomersRelationsApi	getMyCustomerRelations	GET /customers/me/relations
StalactiteDataClientJs.DomainsApi	createDomain	POST /domains
StalactiteDataClientJs.DomainsApi	deleteDomain	DELETE /domains/{uid}
StalactiteDataClientJs.DomainsApi	getDomain	GET /domains/{uid}
StalactiteDataClientJs.DomainsApi	getDomainBy	GET /domains/by
StalactiteDataClientJs.DomainsApi	getDomains	GET /domains
StalactiteDataClientJs.DomainsApi	updateDomain	PUT /domains/{uid}
StalactiteDataClientJs.DomainsRelationsApi	addCustomerRelations	POST /domains/{uid}/relations/customers
StalactiteDataClientJs.DomainsRelationsApi	addUserRelations	POST /domains/{uid}/relations/users
StalactiteDataClientJs.DomainsRelationsApi	getDomainRelations	GET /domains/{uid}/relations
StalactiteDataClientJs.PermissionsApi	createPermission	POST /permissions
StalactiteDataClientJs.PermissionsApi	deletePermission	DELETE /permissions/{uid}
StalactiteDataClientJs.PermissionsApi	getPermission	GET /permissions/{uid}
StalactiteDataClientJs.PermissionsApi	getPermissions	GET /permissions
StalactiteDataClientJs.PermissionsApi	updatePermission	PUT /permissions/{uid}
StalactiteDataClientJs.PostsApi	addPostPermissions	POST /posts/{uid}/permissions
StalactiteDataClientJs.PostsApi	createPost	POST /posts
StalactiteDataClientJs.PostsApi	deletePost	DELETE /posts/{uid}
StalactiteDataClientJs.PostsApi	deletePostPermissions	DELETE /posts/{uid}/permissions
StalactiteDataClientJs.PostsApi	getPost	GET /posts/{uid}
StalactiteDataClientJs.PostsApi	getPostUser	GET /posts/{uid}/users
StalactiteDataClientJs.PostsApi	getPosts	GET /posts
StalactiteDataClientJs.PostsApi	updatePost	PUT /posts/{uid}
StalactiteDataClientJs.RelationsApi	deleteDomainCustomerRelation	DELETE /relations/customers/{uid}
StalactiteDataClientJs.RelationsApi	deleteDomainUserRelation	DELETE /relations/users/{uid}
StalactiteDataClientJs.UsersApi	createUser	POST /users
StalactiteDataClientJs.UsersApi	deleteUser	DELETE /users/{uid}
StalactiteDataClientJs.UsersApi	getUser	GET /users/{uid}
StalactiteDataClientJs.UsersApi	getUserBy	GET /users/by
StalactiteDataClientJs.UsersApi	getUserSubordinates	GET /users/{uid}/subordinates
StalactiteDataClientJs.UsersApi	getUsers	GET /users
StalactiteDataClientJs.UsersApi	updateUser	PUT /users/{uid}
StalactiteDataClientJs.UsersAccessClearancesApi	getMyAccessClearances	GET /users/me/access/{domainUid}
StalactiteDataClientJs.UsersAccessClearancesApi	getUserAccessClearances	GET /users/{userUid}/access/{domainUid}
StalactiteDataClientJs.UsersLeadsApi	addUserLeads	POST /users/{uid}/leads
StalactiteDataClientJs.UsersLeadsApi	getUserLeads	GET /users/{uid}/leads
StalactiteDataClientJs.UsersLeadsApi	removeUserLeads	DELETE /users/{uid}/leads
StalactiteDataClientJs.UsersMeApi	getMeAsUser	GET /users/me
StalactiteDataClientJs.UsersMeApi	getMyLeads	GET /users/me/leads
StalactiteDataClientJs.UsersMeApi	getMyPosts	GET /users/me/posts
StalactiteDataClientJs.UsersMeApi	getMySubordinates	GET /users/me/subordinates
StalactiteDataClientJs.UsersPostsApi	addUserPosts	POST /users/{uid}/posts
StalactiteDataClientJs.UsersPostsApi	getUserPosts	GET /users/{uid}/posts
StalactiteDataClientJs.UsersPostsApi	removeUserPosts	DELETE /users/{uid}/posts
StalactiteDataClientJs.UsersRelationsApi	getMyDomainRelations	GET /users/me/relations
StalactiteDataClientJs.UsersRelationsApi	getUserDomainRelations	GET /users/{uid}/relations

Documentation for Models

Documentation for Authorization

StalactiteToken

Type: API key
API key parameter name: X-API-TOKEN
Location: HTTP header

@babel/cli superagent

0.4.1-dev.bd231ef55e5bb92892335c80f9248fcaae852223

4 years ago

0.4.1-dev.4c95de03f71340044d687e177ba098f6a90f3fd1

4 years ago