# guest_checkin_rest_api

> Communicate_with_the_Guest_Checkin_backend_using_this_API_

Latest version **0.0.1** (published 2020-08-03) · API license URL license · 0 weekly downloads

## Install

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

## 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.0.1 |
| Published | 2020-08-03 |
| First published | 2020-08-03 |
| Weekly downloads | 0 |
| License | API license URL |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 81.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | evandor |

## Links

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

## Dependencies (3)

- [babel](https://npm.io/package/babel.md) ^6.23.0
- [babel-cli](https://npm.io/package/babel-cli.md) ^6.26.0
- [superagent](https://npm.io/package/superagent.md) 3.7.0

## Recent versions

- 0.0.1 (latest) — 2020-08-03

## README

# guest_checkin_rest_api

GuestCheckinRestApi - JavaScript client for guest_checkin_rest_api
Communicate with the Guest Checkin backend using this API.
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:

- API version: API 0.0.1
- Package version: API 0.0.1
- 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 guest_checkin_rest_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 GuestCheckinRestApi = require('guest_checkin_rest_api');

var api = new GuestCheckinRestApi.CheckinControllerApi()
var body = new GuestCheckinRestApi.CheckinForm(); // {CheckinForm} form

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.addVisitUsingPOST(body, callback);
```

## Documentation for API Endpoints

All URIs are relative to *//gc.int.skysail.io/*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*GuestCheckinRestApi.CheckinControllerApi* | [**addVisitUsingPOST**](docs/CheckinControllerApi.md#addVisitUsingPOST) | **POST** /checkins | adds a customers checkin to this restaurant if valid
*GuestCheckinRestApi.RegistrationControllerApi* | [**addRestaurantUsingPOST1**](docs/RegistrationControllerApi.md#addRestaurantUsingPOST1) | **POST** /register | creates an account, i.e. a user and a restaurant for given input. Fails if users email address already exists.
*GuestCheckinRestApi.RestaurantsControllerApi* | [**addRestaurantUsingPOST2**](docs/RestaurantsControllerApi.md#addRestaurantUsingPOST2) | **POST** /restaurants | adds a restaurant for given input. If no user with this email exists, she will be created.
*GuestCheckinRestApi.RestaurantsControllerApi* | [**getUsersUsingGET**](docs/RestaurantsControllerApi.md#getUsersUsingGET) | **GET** /restaurants | list current restaurants.

## Documentation for Models

 - [GuestCheckinRestApi.AddRestaurantsCmd](docs/AddRestaurantsCmd.md)
 - [GuestCheckinRestApi.CheckinForm](docs/CheckinForm.md)
 - [GuestCheckinRestApi.LoginForm](docs/LoginForm.md)
 - [GuestCheckinRestApi.RegistrationForm](docs/RegistrationForm.md)
 - [GuestCheckinRestApi.RestaurantRow](docs/RestaurantRow.md)
 - [GuestCheckinRestApi.SeqRestaurantRow](docs/SeqRestaurantRow.md)

## Documentation for Authorization

 All endpoints do not require authorization.

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