# @docket/docket.js > JavaScript SDK for interfacing with the Docket API Latest version **0.21.0** (published 2020-01-16) · MIT license · 0 weekly downloads ## Install ```sh npm install @docket/docket.js pnpm add @docket/docket.js yarn add @docket/docket.js bun add @docket/docket.js ``` ## Health **Score 15/100 (F)** — status: abandoned. Positive: no vulnerabilities. Warnings: low downloads; no types; no esm support; pre 1.0. Negative: abandoned; low maintenance score. ## Facts | | | |---|---| | Version | 0.21.0 | | Published | 2020-01-16 | | First published | 2019-02-01 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 2 | | Unpacked size | 304.3 KB | | Known vulnerabilities | 0 | | Install scripts | no | | Maintainers | john-goldsmith | ## Links - npm: https://www.npmjs.com/package/@docket/docket.js - npm.io page: https://npm.io/package/@docket/docket.js ## Dependencies (2) - [@babel/cli](https://npm.io/package/@babel/cli.md) ^7.0.0 - [superagent](https://npm.io/package/superagent.md) 3.7.0 ## Recent versions - 0.21.0 (latest) — 2020-01-16 - 0.20.0 — 2020-01-16 - 0.19.0 — 2020-01-15 - 0.18.0 — 2019-03-23 - 0.17.0 — 2019-02-25 - 0.16.0 — 2019-02-08 - 0.15.0 — 2019-02-07 - 0.14.0 — 2019-02-06 - 0.13.0 — 2019-02-01 ## README # docket.js DocketJs - JavaScript client for docket.js Docket API This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project: - API version: 1.0.0 - Package version: 1.0.0 - Build package: org.openapitools.codegen.languages.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 docket.js --save ``` Finally, you need to build the module: ```shell 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: ```shell npm install ``` Next, [link](https://docs.npmjs.com/cli/link) it globally in npm with the following, also from `JAVASCRIPT_CLIENT_DIR`: ```shell npm link ``` To use the link you just defined in your project, switch to the directory you want to use your docket.js from, and run: ```shell npm link /path/to/ ``` Finally, you need to build the module: ```shell 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: ```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 DocketJs = require('docket.js'); var api = new DocketJs.DocsApi() api.getDocs().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 *http://localhost:3001/v1* Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- *DocketJs.DocsApi* | [**getDocs**](docs/DocsApi.md#getDocs) | **GET** /docs | Get the OpenAPI 3.x spec *DocketJs.EventsApi* | [**createMyEvent**](docs/EventsApi.md#createMyEvent) | **POST** /my/events | Create a new event for the current user *DocketJs.EventsApi* | [**deleteMyEventById**](docs/EventsApi.md#deleteMyEventById) | **DELETE** /my/events/{eventId} | Delete an event for the current user by it's ID *DocketJs.EventsApi* | [**getMyEventById**](docs/EventsApi.md#getMyEventById) | **GET** /my/events/{eventId} | Get an event for the current user by it's ID *DocketJs.EventsApi* | [**importMyEvents**](docs/EventsApi.md#importMyEvents) | **POST** /my/events/import | Bulk import events for the current user *DocketJs.EventsApi* | [**listMyEvents**](docs/EventsApi.md#listMyEvents) | **GET** /my/events | List the current user's events *DocketJs.EventsApi* | [**updateMyEventById**](docs/EventsApi.md#updateMyEventById) | **PATCH** /my/events/{eventId} | Update an event for the current user by it's ID *DocketJs.GoogleApi* | [**getGoogleOAuthUrl**](docs/GoogleApi.md#getGoogleOAuthUrl) | **GET** /google/oauth-url | Get the OAuth2 URL for Google services *DocketJs.GoogleApi* | [**googleGetAccessTokens**](docs/GoogleApi.md#googleGetAccessTokens) | **GET** /google/tokens | Get Google access tokens *DocketJs.GoogleApi* | [**googleListCalendarLists**](docs/GoogleApi.md#googleListCalendarLists) | **GET** /google/calendars-lists | List calendar lists *DocketJs.GoogleApi* | [**googleListEventInstances**](docs/GoogleApi.md#googleListEventInstances) | **GET** /google/calendars/{calendarId}/events/{eventId}/instances | Get event instances by ID *DocketJs.GoogleApi* | [**googleListEventsByCalendarId**](docs/GoogleApi.md#googleListEventsByCalendarId) | **GET** /google/calendars/{calendarId}/events | List events by calendar ID *DocketJs.GoogleApi* | [**googleShowCalendarById**](docs/GoogleApi.md#googleShowCalendarById) | **GET** /google/calendars/{calendarId} | Get calendar by ID *DocketJs.GoogleApi* | [**googleShowCalendarListById**](docs/GoogleApi.md#googleShowCalendarListById) | **GET** /google/calendars-lists/{calendarListId} | Get a Google calendar list by ID *DocketJs.GoogleApi* | [**googleShowEventById**](docs/GoogleApi.md#googleShowEventById) | **GET** /google/calendars/{calendarId}/events/{eventId} | Get event by ID *DocketJs.GoogleApi* | [**googleWatchCalendarLists**](docs/GoogleApi.md#googleWatchCalendarLists) | **POST** /google/calendars-lists/watch | Watch calendar lists *DocketJs.GoogleApi* | [**googleWatchEvents**](docs/GoogleApi.md#googleWatchEvents) | **POST** /google/calendars/{calendarId}/events/watch | Watch events *DocketJs.HealthCheckApi* | [**listHealthCheck**](docs/HealthCheckApi.md#listHealthCheck) | **GET** /health-check | Health check *DocketJs.LocalesApi* | [**listLocales**](docs/LocalesApi.md#listLocales) | **GET** /locales | List locales *DocketJs.MicrosoftApi* | [**getMicrosoftOAuthUrl**](docs/MicrosoftApi.md#getMicrosoftOAuthUrl) | **GET** /microsoft/oauth-url | Get Microsoft OAuth URL *DocketJs.MicrosoftApi* | [**microsoftGetAccessTokens**](docs/MicrosoftApi.md#microsoftGetAccessTokens) | **GET** /microsoft/tokens | Get Microsoft access tokens *DocketJs.MicrosoftApi* | [**microsoftListCalendars**](docs/MicrosoftApi.md#microsoftListCalendars) | **GET** /microsoft/calendars | List Microsoft calendars *DocketJs.MicrosoftApi* | [**microsoftListEventsByCalendarId**](docs/MicrosoftApi.md#microsoftListEventsByCalendarId) | **GET** /microsoft/calendars/{calendarId}/events | List Microsoft events by calendar ID *DocketJs.SearchApi* | [**listSearchResults**](docs/SearchApi.md#listSearchResults) | **GET** /search | Perform a search *DocketJs.SessionsApi* | [**createSession**](docs/SessionsApi.md#createSession) | **POST** /sessions | Create a new session *DocketJs.TranslationsApi* | [**listTranslationsByLocale**](docs/TranslationsApi.md#listTranslationsByLocale) | **GET** /locales/{localeCode}/translations | List translations by locale code *DocketJs.UsersApi* | [**confirmRegistration**](docs/UsersApi.md#confirmRegistration) | **POST** /users/confirm-registration | Confirm a new user's registration *DocketJs.UsersApi* | [**createUser**](docs/UsersApi.md#createUser) | **POST** /users | Create a new user *DocketJs.UsersApi* | [**destroyMyProfile**](docs/UsersApi.md#destroyMyProfile) | **DELETE** /my/profile | Delete the current user *DocketJs.UsersApi* | [**forgotPassword**](docs/UsersApi.md#forgotPassword) | **POST** /users/forgot-password | Facilitates a user to reset their password *DocketJs.UsersApi* | [**getMyProfile**](docs/UsersApi.md#getMyProfile) | **GET** /my/profile | Return the current user's profile *DocketJs.UsersApi* | [**resetPassword**](docs/UsersApi.md#resetPassword) | **POST** /users/reset-password | Reset a user's password *DocketJs.UsersApi* | [**showMyMembership**](docs/UsersApi.md#showMyMembership) | **GET** /my/membership | Get the current user's membership status *DocketJs.UsersApi* | [**updateMyMembership**](docs/UsersApi.md#updateMyMembership) | **PATCH** /my/membership | Update the current user's membership status *DocketJs.UsersApi* | [**updateMyProfile**](docs/UsersApi.md#updateMyProfile) | **PATCH** /my/profile | Update the current user's profile ## Documentation for Models - [DocketJs.ClientError](docs/ClientError.md) - [DocketJs.ClientErrorErrors](docs/ClientErrorErrors.md) - [DocketJs.Event](docs/Event.md) - [DocketJs.InlineObject](docs/InlineObject.md) - [DocketJs.InlineObject1](docs/InlineObject1.md) - [DocketJs.InlineObject2](docs/InlineObject2.md) - [DocketJs.InlineObject3](docs/InlineObject3.md) - [DocketJs.InlineObject4](docs/InlineObject4.md) - [DocketJs.InlineObject5](docs/InlineObject5.md) - [DocketJs.InlineObject6](docs/InlineObject6.md) - [DocketJs.InlineObject7](docs/InlineObject7.md) - [DocketJs.InlineObject8](docs/InlineObject8.md) - [DocketJs.InlineResponse200](docs/InlineResponse200.md) - [DocketJs.InlineResponse2001](docs/InlineResponse2001.md) - [DocketJs.InlineResponse2001Data](docs/InlineResponse2001Data.md) - [DocketJs.InlineResponse2001DataAttributes](docs/InlineResponse2001DataAttributes.md) - [DocketJs.InlineResponse2002](docs/InlineResponse2002.md) - [DocketJs.InlineResponse2002Data](docs/InlineResponse2002Data.md) - [DocketJs.InlineResponse2003](docs/InlineResponse2003.md) - [DocketJs.InlineResponse2003Data](docs/InlineResponse2003Data.md) - [DocketJs.InlineResponse2004](docs/InlineResponse2004.md) - [DocketJs.InlineResponse2005](docs/InlineResponse2005.md) - [DocketJs.InlineResponse2005Data](docs/InlineResponse2005Data.md) - [DocketJs.InlineResponse2006](docs/InlineResponse2006.md) - [DocketJs.InlineResponse2006Data](docs/InlineResponse2006Data.md) - [DocketJs.InlineResponse2007](docs/InlineResponse2007.md) - [DocketJs.InlineResponse2008](docs/InlineResponse2008.md) - [DocketJs.InlineResponse2008Data](docs/InlineResponse2008Data.md) - [DocketJs.InlineResponse2009](docs/InlineResponse2009.md) - [DocketJs.InlineResponse2009Data](docs/InlineResponse2009Data.md) - [DocketJs.InlineResponse200Data](docs/InlineResponse200Data.md) - [DocketJs.InlineResponse200DataAttributes](docs/InlineResponse200DataAttributes.md) - [DocketJs.InlineResponse200Links](docs/InlineResponse200Links.md) - [DocketJs.Locale](docs/Locale.md) - [DocketJs.MyEventsData](docs/MyEventsData.md) - [DocketJs.MyEventsDataAttributes](docs/MyEventsDataAttributes.md) - [DocketJs.MyEventsImportData](docs/MyEventsImportData.md) - [DocketJs.MyProfileData](docs/MyProfileData.md) - [DocketJs.MyProfileDataAttributes](docs/MyProfileDataAttributes.md) - [DocketJs.Session](docs/Session.md) - [DocketJs.SessionsData](docs/SessionsData.md) - [DocketJs.SessionsDataAttributes](docs/SessionsDataAttributes.md) - [DocketJs.Translation](docs/Translation.md) - [DocketJs.User](docs/User.md) - [DocketJs.UsersConfirmRegistrationData](docs/UsersConfirmRegistrationData.md) - [DocketJs.UsersConfirmRegistrationDataAttributes](docs/UsersConfirmRegistrationDataAttributes.md) - [DocketJs.UsersData](docs/UsersData.md) - [DocketJs.UsersDataAttributes](docs/UsersDataAttributes.md) - [DocketJs.UsersForgotPasswordData](docs/UsersForgotPasswordData.md) - [DocketJs.UsersForgotPasswordDataAttributes](docs/UsersForgotPasswordDataAttributes.md) ## Documentation for Authorization ### bearerAuth - **Type**: Bearer authentication (JWT) --- _Source: https://npm.io/package/@docket/docket.js · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._