This package has been deprecated

Author message:

This package has been deprecated in favor of @docket/docket.js

@docket/docket-sdk

@DocketDocketSdk - JavaScript client for @docket/docket-sdk No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen) This SDK is automatically generated by the Swagger Codegen project:

• API version: 0.1.0
• Package version: 0.1.0
• Build package: io.swagger.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 @docket/docket-sdk --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 @DocketDocketSdk = require('@docket/docket-sdk');

var api = new @DocketDocketSdk.AuthApi()

var authPostRequestBody = new @DocketDocketSdk.AuthPostRequestBody(); // {AuthPostRequestBody} 

api.auth(authPostRequestBody).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:3000/v1

Class	Method	HTTP request	Description
@DocketDocketSdk.AuthApi	auth	POST /auth	Issues a JWT
@DocketDocketSdk.DocumentationApi	getDocs	GET /docs	Returns an OpenAPI 3.0 spec.
@DocketDocketSdk.GoogleApi	getGoogleAuthTokens	GET /google/tokens	Get Google OAuth tokens
@DocketDocketSdk.GoogleApi	getGoogleAuthUrl	GET /google/url	Get Google OAuth URL
@DocketDocketSdk.MeApi	createMyEvent	POST /me/events	Creates a new event for the current user
@DocketDocketSdk.MeApi	deleteMe	DELETE /me	Deletes the current user
@DocketDocketSdk.MeApi	deleteMyEventById	DELETE /me/events/{id}	Deletes an event for the current user
@DocketDocketSdk.MeApi	getMe	GET /me	Fetches the current user
@DocketDocketSdk.MeApi	getMyEventById	GET /me/events/{id}	Fetches a specific event for the current user
@DocketDocketSdk.MeApi	getMyEvents	GET /me/events	Fetches all events for the current user
@DocketDocketSdk.MeApi	updateMe	PUT /me	Updates the current user
@DocketDocketSdk.MeApi	updateMyEventById	PUT /me/events/{id}	Updates an event for the current user
@DocketDocketSdk.StatusApi	getHealthCheck	GET /health-check	Health check
@DocketDocketSdk.UserApi	confirmUser	GET /users/confirm/{code}	Confirms user's registration
@DocketDocketSdk.UserApi	createUser	POST /users	Create a user
@DocketDocketSdk.UserApi	forgotPassword	POST /users/forgot-password	Forgot password
@DocketDocketSdk.UserApi	resetPassword	POST /users/reset-password	Reset password

Documentation for Models

• @DocketDocketSdk.AuthPostRequestBody
• @DocketDocketSdk.Error
• @DocketDocketSdk.Event
• @DocketDocketSdk.ForgotPasswordPostRequestBody
• @DocketDocketSdk.InlineResponse200
• @DocketDocketSdk.InlineResponse2001
• @DocketDocketSdk.InlineResponse2002
• @DocketDocketSdk.InlineResponse2003
• @DocketDocketSdk.MeEventPutRequestBody
• @DocketDocketSdk.MeEventsPostRequestBody
• @DocketDocketSdk.MePutRequestBody
• @DocketDocketSdk.ResetPasswordPostRequestBody
• @DocketDocketSdk.User
• @DocketDocketSdk.UsersPostRequestBody

Documentation for Authorization

bearerAuth

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header