# collaborative_calendar_api

> API_for_managing_events_in_a_collaborative_calendar

Latest version **1.0.0** (published 2023-05-04) · Unlicense license · 0 weekly downloads

## Install

```sh
npm install collaborative_calendar_api
pnpm add collaborative_calendar_api
yarn add collaborative_calendar_api
bun add collaborative_calendar_api
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2023-05-04 |
| First published | 2023-05-04 |
| Weekly downloads | 0 |
| License | Unlicense |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 77.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | incredibledave |

## Links

- npm: https://www.npmjs.com/package/collaborative_calendar_api
- npm.io page: https://npm.io/package/collaborative_calendar_api

## Dependencies (2)

- [@babel/cli](https://npm.io/package/@babel/cli.md) ^7.0.0
- [superagent](https://npm.io/package/superagent.md) ^5.3.0

## Recent versions

- 1.0.0 (latest) — 2023-05-04

## README

# 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](https://github.com/swagger-api/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](https://nodejs.org/)

#### npm

To publish the library as a [npm](https://www.npmjs.com/),
please follow the procedure in ["Publishing npm packages"](https://docs.npmjs.com/getting-started/publishing-npm-packages).

Then install it via:

```shell
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:

```shell
    npm install GIT_USER_ID/GIT_REPO_ID --save
```

### For browser

The library also works in the browser environment via npm and [browserify](http://browserify.org/). 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):

```shell
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:

```javascript
module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}
```

## Getting Started

Please follow the [installation](#installation) instruction and execute the following JS code:

```javascript
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*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*CollaborativeCalendarApi.EventsApi* | [**addEvent**](docs/EventsApi.md#addEvent) | **POST** /events | Add a new event
*CollaborativeCalendarApi.EventsApi* | [**eventsEventIdDelete**](docs/EventsApi.md#eventsEventIdDelete) | **DELETE** /events/{eventId} | Deletes an existing event
*CollaborativeCalendarApi.EventsApi* | [**getEvents**](docs/EventsApi.md#getEvents) | **GET** /events | Get all events
*CollaborativeCalendarApi.EventsApi* | [**updateEvent**](docs/EventsApi.md#updateEvent) | **PUT** /events/{eventId} | Updates an existing event
*CollaborativeCalendarApi.UsersApi* | [**addUser**](docs/UsersApi.md#addUser) | **POST** /users | Add a new user
*CollaborativeCalendarApi.UsersApi* | [**deleteUser**](docs/UsersApi.md#deleteUser) | **DELETE** /users/{userId} | Deletes an existing user
*CollaborativeCalendarApi.UsersApi* | [**getUsers**](docs/UsersApi.md#getUsers) | **GET** /users | Get all users
*CollaborativeCalendarApi.UsersApi* | [**updateUser**](docs/UsersApi.md#updateUser) | **PUT** /users/{userId} | Updates an existing user

## Documentation for Models

 - [CollaborativeCalendarApi.Event](docs/Event.md)
 - [CollaborativeCalendarApi.User](docs/User.md)

## Documentation for Authorization

 All endpoints do not require authorization.

---
_Source: https://npm.io/package/collaborative_calendar_api · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._