@keyclic/app-sdk
Advanced tools
KeyclicApi - JavaScript client for keyclic_api No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codege
KeyclicApi - JavaScript client for keyclic_api No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) This SDK is automatically generated by the Swagger Codegen project:
To publish the library as a npm, please follow the procedure in "Publishing npm packages".
Then install it via:
npm install keyclic_api --save
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
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.
Please follow the installation instruction and execute the following JS code:
var KeyclicApi = require('keyclic_api');
var defaultClient = KeyclicApi.ApiClient.instance;
// Configure API key authorization: bearer
var bearer = defaultClient.authentications['bearer'];
bearer.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//bearer.apiKeyPrefix['Authorization'] = "Token"
var api = new KeyclicApi.AnalyticApi()
var xKeyclicApp = "com.keyclic.app"; // {String}
var organization = "organization_example"; // {String} The identifier of the resource formatted as GUID string.
var opts = {
'acceptLanguage': "fr-FR", // {String}
'xKeyclicAppVersion': "xKeyclicAppVersion_example", // {String}
'place': "place_example", // {String} The identifier of the resource formatted as GUID string.
'category': "category_example", // {String} The identifier of the resource formatted as GUID string.
'state': "state_example", // {String}
'before': new Date("2013-10-20T19:20:30+01:00"), // {Date}
'after': new Date("2013-10-20T19:20:30+01:00"), // {Date}
'optionsProperty': "optionsProperty_example", // {String}
'optionsSort': "optionsSort_example" // {String}
};
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
};
api.getAnalyticByOrganization(xKeyclicApp, organization, opts, callback);
All URIs are relative to https://api.keyclic.com
| Class | Method | HTTP request | Description |
|---|---|---|---|
| KeyclicApi.AnalyticApi | getAnalyticByOrganization | GET /organizations/{organization}/analytics | Retrieve one Analytic resource. |
| KeyclicApi.ApplicationApi | getApplicationByToken | GET /applications/{token} | Retrieve one Application resource. |
| KeyclicApi.AssignApi | postAssignByOperation | POST /operations/{operation}/assign | Create one Assign resource. |
| KeyclicApi.BusinessActivityApi | cgetBusinessActivities | GET /businessactivities | Retrieve all BusinessActivity resources. |
| KeyclicApi.CategoryApi | cgetCategories | GET /categories | Retrieve all Category resources. |
| KeyclicApi.CategoryApi | cgetCategoriesByOrganization | GET /organizations/{organization}/categories | Retrieve all Category resources. |
| KeyclicApi.CategoryApi | getCategory | GET /categories/{category} | Retrieve one Category resource. |
| KeyclicApi.CategoryApi | patchCategory | PATCH /categories/{category} | Edit one Category resource. |
| KeyclicApi.CategoryApi | postCategoryByOrganization | POST /organizations/{organization}/categories | Create one Category resource. |
| KeyclicApi.ChangeApi | postChangeByToken | POST /security/password/change/{token} | Create one Change resource. |
| KeyclicApi.CommentApi | cgetCommentsByFeedback | GET /feedbacks/{feedback}/comments | Retrieve all Comment resources. |
| KeyclicApi.CommentApi | cgetCommentsByOperation | GET /operations/{operation}/comments | Retrieve all Comment resources. |
| KeyclicApi.CommentApi | postCommentByFeedback | POST /feedbacks/{feedback}/comments | Create one Comment resource. |
| KeyclicApi.CommentApi | postCommentByOperation | POST /operations/{operation}/comments | Create one Comment resource. |
| KeyclicApi.ContributionApi | cgetContributionsByFeedback | GET /feedbacks/{feedback}/contributions | Retrieve all Contribution resources. |
| KeyclicApi.ContributionApi | postContributionByFeedback | POST /feedbacks/{feedback}/contributions | Create one Contribution resource. |
| KeyclicApi.DelegateApi | postDelegateByOrganization | POST /organizations/{organization}/delegates | Create one Delegate resource. |
| KeyclicApi.DeviceApi | deleteDeviceByPersonAndDevice | DELETE /people/{person}/devices/{device} | Remove one Device resource. |
| KeyclicApi.DeviceApi | postDeviceByPerson | POST /people/{person}/devices | Create one Device resource. |
| KeyclicApi.ExportApi | cpostExportByOrganization | POST /organizations/{organization}/reports/exports | Retrieve all Export resources. |
| KeyclicApi.FacebookApi | postFacebook | POST /security/connect/facebook | Create one Facebook resource. |
| KeyclicApi.FeedbackApi | cgetFeedbacks | GET /feedbacks | Retrieve all Feedback resources. |
| KeyclicApi.FeedbackApi | cgetFeedbacksByPerson | GET /people/{person}/feedbacks | Retrieve all Feedback resources. |
| KeyclicApi.FeedbackApi | getFeedback | GET /feedbacks/{feedback} | Retrieve one Feedback resource. |
| KeyclicApi.ImageApi | deleteImageByOperationAndImage | DELETE /operations/{operation}/images/{image} | Remove one Image resource. |
| KeyclicApi.ImageApi | getImageByFeedbackAndImageAndWidthAndHeight | GET /feedbacks/{feedback}/images/{image}/{width}/{height} | Retrieve one Image resource. |
| KeyclicApi.ImageApi | getImageByOperationAndImageAndWidthAndHeight | GET /operations/{operation}/images/{image}/{width}/{height} | Retrieve one Image resource. |
| KeyclicApi.ImageApi | getImageByPersonAndWidthAndHeight | GET /people/{person}/image/{width}/{height} | Retrieve one Image resource. |
| KeyclicApi.ImageApi | postImageByFeedback | POST /feedbacks/{feedback}/images | Create one Image resource. |
| KeyclicApi.ImageApi | postImageByOperation | POST /operations/{operation}/images | Create one Image resource. |
| KeyclicApi.IssueApi | postIssue | POST /feedbacks/issues | Create one Issue resource. |
| KeyclicApi.LogApi | cgetLogsByOperation | GET /operations/{operation}/logs | Retrieve all Log resources. |
| KeyclicApi.LoginApi | postLogin | POST /security/login | Create one Login resource. |
| KeyclicApi.LogoApi | getLogoByOrganizationAndWidthAndHeight | GET /organizations/{organization}/logo/{width}/{height} | Retrieve one Logo resource. |
| KeyclicApi.MemberApi | cgetMembersByOrganization | GET /organizations/{organization}/members | Retrieve all Member resources. |
| KeyclicApi.MemberApi | deleteMemberByOrganizationAndMember | DELETE /organizations/{organization}/members/{member} | Remove one Member resource. |
| KeyclicApi.MemberApi | getMemberByOrganizationAndMember | GET /organizations/{organization}/members/{member} | Retrieve one Member resource. |
| KeyclicApi.MemberApi | patchMemberByOrganizationAndMember | PATCH /organizations/{organization}/members/{member} | Edit one Member resource. |
| KeyclicApi.MemberApi | postMemberByOrganization | POST /organizations/{organization}/members | Create one Member resource. |
| KeyclicApi.OperationApi | cgetOperationsByOrganization | GET /organizations/{organization}/operations | Retrieve all Operation resources. |
| KeyclicApi.OperationApi | cgetOperationsByPerson | GET /people/{person}/operations | Retrieve all Operation resources. |
| KeyclicApi.OperationApi | cgetOperationsByReport | GET /reports/{report}/operations | Retrieve all Operation resources. |
| KeyclicApi.OperationApi | deleteOperation | DELETE /operations/{operation} | Remove one Operation resource. |
| KeyclicApi.OperationApi | getOperation | GET /operations/{operation} | Retrieve one Operation resource. |
| KeyclicApi.OperationApi | patchOperation | PATCH /operations/{operation} | Edit one Operation resource. |
| KeyclicApi.OperationApi | postOperation | POST /operations | Create one Operation resource. |
| KeyclicApi.OrganizationApi | cgetOrganizations | GET /organizations | Retrieve all Organization resources. |
| KeyclicApi.OrganizationApi | getOrganization | GET /organizations/{organization} | Retrieve one Organization resource. |
| KeyclicApi.OrganizationApi | patchOrganization | PATCH /organizations/{organization} | Edit one Organization resource. |
| KeyclicApi.OrganizationApi | postOrganization | POST /organizations | Create one Organization resource. |
| KeyclicApi.PersonApi | cgetPeople | GET /people | Retrieve all Person resources. |
| KeyclicApi.PersonApi | getPerson | GET /people/{person} | Retrieve one Person resource. |
| KeyclicApi.PersonApi | patchPerson | PATCH /people/{person} | Edit one Person resource. |
| KeyclicApi.PlaceApi | cgetPlaces | GET /places | Retrieve all Place resources. |
| KeyclicApi.PlaceApi | cgetPlacesByOrganization | GET /organizations/{organization}/places | Retrieve all Place resources. |
| KeyclicApi.PlaceApi | getPlace | GET /places/{place} | Retrieve one Place resource. |
| KeyclicApi.PlaceApi | patchPlace | PATCH /places/{place} | Edit one Place resource. |
| KeyclicApi.PlaceApi | postPlaceByOrganization | POST /organizations/{organization}/places | Create one Place resource. |
| KeyclicApi.RegisterApi | postRegister | POST /security/register | Create one Register resource. |
| KeyclicApi.RelationshipApi | cgetRelationshipsByOrganization | GET /organizations/{organization}/relationships | Retrieve all Relationship resources. |
| KeyclicApi.RelationshipApi | deleteRelationshipByOrganizationAndRelationship | DELETE /organizations/{organization}/relationships/{relationship} | Remove one Relationship resource. |
| KeyclicApi.RelationshipApi | postRelationshipByOrganization | POST /organizations/{organization}/relationships | Create one Relationship resource. |
| KeyclicApi.ReportApi | cgetReportsByOrganization | GET /organizations/{organization}/reports | Retrieve all Report resources. |
| KeyclicApi.ReportApi | getReport | GET /reports/{report} | Retrieve one Report resource. |
| KeyclicApi.ReportApi | patchReport | PATCH /reports/{report} | Edit one Report resource. |
| KeyclicApi.ResetApi | postReset | POST /security/password/change-request | Create one Reset resource. |
| KeyclicApi.StateApi | patchStateByFeedback | PATCH /feedbacks/{feedback}/state | Edit one State resource. |
| KeyclicApi.StateApi | patchStateByOperation | PATCH /operations/{operation}/state | Edit one State resource. |
| KeyclicApi.StateApi | patchStateByReport | PATCH /reports/{report}/state | Edit one State resource. |
| KeyclicApi.TrackingApi | getTrackingByFeedback | GET /feedbacks/{feedback}/tracking | Retrieve one Tracking resource. |
| KeyclicApi.TrackingApi | getTrackingByReport | GET /reports/{report}/tracking | Retrieve one Tracking resource. |
| KeyclicApi.TransitionApi | postTransitionByFeedback | POST /feedbacks/{feedback}/workflow/transition | Create one Transition resource. |
| KeyclicApi.TransitionApi | postTransitionByOperation | POST /operations/{operation}/workflow/transition | Create one Transition resource. |
| KeyclicApi.TransitionApi | postTransitionByReport | POST /reports/{report}/workflow/transition | Create one Transition resource. |
FAQs
Keyclic App SDK - JavaScript client for Keyclic API
The npm package @keyclic/app-sdk receives a total of 2 weekly downloads. As such, @keyclic/app-sdk popularity was classified as not popular.
We found that @keyclic/app-sdk demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
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.
Security News
Research
Socket researchers have discovered malicious npm packages targeting crypto developers, stealing credentials and wallet data using spyware delivered through typosquats of popular cryptographic libraries.
Security News
Socket's package search now displays weekly downloads for npm packages, helping developers quickly assess popularity and make more informed decisions.
Security News
A Stanford study reveals 9.5% of engineers contribute almost nothing, costing tech $90B annually, with remote work fueling the rise of "ghost engineers."