1.0.0 • Published 1 year ago

collaborative_calendar_api v1.0.0

Weekly downloads
-
License
Unlicense
Repository
-
Last release
1 year ago

collaborative_calendar_api

CollaborativeCalendarApi - JavaScript client for collaborative_calendar_api API for managing events in a collaborative calendar This SDK is automatically generated by the Swagger Codegen project:

  • API version: 1.0.0
  • Package version: 1.0.0
  • Build package: io.swagger.codegen.v3.generators.javascript.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 collaborative_calendar_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.

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 CollaborativeCalendarApi = require('collaborative_calendar_api');

var api = new CollaborativeCalendarApi.EventsApi()
var name = "name_example"; // {String} Name of the event
var _date = new Date("2013-10-20T19:20:30+01:00"); // {Date} Date of the event
var startingtime = "startingtime_example"; // {String} Startingtime of the event
var endingtime = "endingtime_example"; // {String} Endingtime of the event
var opts = { 
  'body': new CollaborativeCalendarApi.Event(), // {Event} Add a new event to the calendar
  'dailyevent': true, // {Boolean} The event takes a whole day
  'description': "description_example" // {String} Description of the event
};
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addEvent(name, _date, startingtime, endingtime, opts, callback);

Documentation for API Endpoints

All URIs are relative to http://localhost:8000

ClassMethodHTTP requestDescription
CollaborativeCalendarApi.EventsApiaddEventPOST /eventsAdd a new event
CollaborativeCalendarApi.EventsApieventsEventIdDeleteDELETE /events/{eventId}Deletes an existing event
CollaborativeCalendarApi.EventsApigetEventsGET /eventsGet all events
CollaborativeCalendarApi.EventsApiupdateEventPUT /events/{eventId}Updates an existing event
CollaborativeCalendarApi.UsersApiaddUserPOST /usersAdd a new user
CollaborativeCalendarApi.UsersApideleteUserDELETE /users/{userId}Deletes an existing user
CollaborativeCalendarApi.UsersApigetUsersGET /usersGet all users
CollaborativeCalendarApi.UsersApiupdateUserPUT /users/{userId}Updates an existing user

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization.

1.0.0

1 year ago