npm package: @p7m/appointment-backend
Description: # API for appointment scheduling related data  This is the API of the service at P7M that manages the scheduling and management of appointments. It is used by the booking widget (see the **WidgetApi** tag) with functions that are public and don't require 
Latest version: 0.13.5

# @p7m/appointment-backend

AppointmentBackend - JavaScript client for @p7m/appointment-backend
# API for appointment scheduling related data

This is the API of the service at P7M that manages the scheduling and management of appointments. It is used by the
booking widget (see the **WidgetApi** tag) with functions that are public and don't require the user to be authenticated.

For endpoints in other tags the caller has to be authenticated with the system and provide a JWT token in the
Authorization header of the HTTP request. When using the API you typically get this token by authenticating first with
OAuth 2.0.

When you are trying this API using the Swagger interface, you need to click the `Authorize` button and then again
the Authorize button in the pop-up that gets opened.
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 0.13.5
- Package version: 0.13.5
- Generator version: 7.13.0-SNAPSHOT
- 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 @p7m/appointment-backend --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 @p7m/appointment-backend from, and run:

```shell
npm link /path/to/<JAVASCRIPT_CLIENT_DIR>
```

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 AppointmentBackend = require('@p7m/appointment-backend');

var defaultClient = AppointmentBackend.ApiClient.instance;
// Configure OAuth2 access token for authorization: oauth
var oauth = defaultClient.authentications['oauth'];
oauth.accessToken = "YOUR ACCESS TOKEN"

var api = new AppointmentBackend.AvailabilityApi()
var id = "id_example"; // {String} ID of the availability
api.deleteAvailabilityById(id).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});


```

## Documentation for API Endpoints

All URIs are relative to *https://book.p7m.de/v1*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*AppointmentBackend.AvailabilityApi* | [**deleteAvailabilityById**](docs/AvailabilityApi.md#deleteAvailabilityById) | **DELETE** /availabilities/{id} | Delete an availability
*AppointmentBackend.AvailabilityApi* | [**getAvailabilities**](docs/AvailabilityApi.md#getAvailabilities) | **GET** /availabilities | Get the list of availabilities
*AppointmentBackend.AvailabilityApi* | [**getAvailabilityById**](docs/AvailabilityApi.md#getAvailabilityById) | **GET** /availabilities/{id} | Request a single availability
*AppointmentBackend.AvailabilityApi* | [**postAvailabilities**](docs/AvailabilityApi.md#postAvailabilities) | **POST** /availabilities | Create a new availability period
*AppointmentBackend.AvailabilityApi* | [**putAvailabilityById**](docs/AvailabilityApi.md#putAvailabilityById) | **PUT** /availabilities/{id} | Update a single availability
*AppointmentBackend.BookingTenantApi* | [**deleteBookingTenantById**](docs/BookingTenantApi.md#deleteBookingTenantById) | **DELETE** /booking/tenant/{id} | Delete a booking tenant by ID
*AppointmentBackend.BookingTenantApi* | [**getBookingTenantById**](docs/BookingTenantApi.md#getBookingTenantById) | **GET** /booking/tenant/{id} | Get a (booking) tenant as specified by its ID
*AppointmentBackend.BookingTenantApi* | [**getBookingTenants**](docs/BookingTenantApi.md#getBookingTenants) | **GET** /booking/tenant | Get list of booking tenants
*AppointmentBackend.BookingTenantApi* | [**postBookingTenant**](docs/BookingTenantApi.md#postBookingTenant) | **POST** /booking/tenant | Create a new booking tenant
*AppointmentBackend.BookingTenantApi* | [**putBookingTenantById**](docs/BookingTenantApi.md#putBookingTenantById) | **PUT** /booking/tenant/{id} | Update an existing booking tenant
*AppointmentBackend.HolidayApi* | [**getHolidays**](docs/HolidayApi.md#getHolidays) | **GET** /holidays | Get the list of public holidays for catholic regions of Bavaria
*AppointmentBackend.HolidayApi* | [**getHolidaysRegions**](docs/HolidayApi.md#getHolidaysRegions) | **GET** /holidays/regions | Get the list of holiday regions known by the system
*AppointmentBackend.HolidayApi* | [**getHolidaysRegionsHolidayRegionId**](docs/HolidayApi.md#getHolidaysRegionsHolidayRegionId) | **GET** /holidays/regions/{hrid} | Get the holidays for a given region
*AppointmentBackend.ReservationApi* | [**deleteReservationById**](docs/ReservationApi.md#deleteReservationById) | **DELETE** /reservations/{id} | Delete the reservation with the given ID
*AppointmentBackend.ReservationApi* | [**getReservations**](docs/ReservationApi.md#getReservations) | **GET** /reservations | Get all reservations
*AppointmentBackend.ReservationApi* | [**getReservationsById**](docs/ReservationApi.md#getReservationsById) | **GET** /reservations/{id} | Get a single reservation identified by its ID
*AppointmentBackend.ReservationApi* | [**postReservations**](docs/ReservationApi.md#postReservations) | **POST** /reservations | Create a new reservation
*AppointmentBackend.ReservationApi* | [**putReservationById**](docs/ReservationApi.md#putReservationById) | **PUT** /reservations/{id} | Update an existing reservation
*AppointmentBackend.ReservationApi* | [**putReservationTagsById**](docs/ReservationApi.md#putReservationTagsById) | **PUT** /reservations/{id}/tags | Update (only) the tags of a given reservation
*AppointmentBackend.ServiceApi* | [**deleteServiceById**](docs/ServiceApi.md#deleteServiceById) | **DELETE** /services/{id} | Delete a service by its ID
*AppointmentBackend.ServiceApi* | [**getServiceById**](docs/ServiceApi.md#getServiceById) | **GET** /services/{id} | Get a service by its ID
*AppointmentBackend.ServiceApi* | [**getServices**](docs/ServiceApi.md#getServices) | **GET** /services | Get list of all services
*AppointmentBackend.ServiceApi* | [**postService**](docs/ServiceApi.md#postService) | **POST** /services | Create a new service
*AppointmentBackend.ServiceApi* | [**putServiceById**](docs/ServiceApi.md#putServiceById) | **PUT** /services/{id} | Updates a single service
*AppointmentBackend.TagApi* | [**deleteTagById**](docs/TagApi.md#deleteTagById) | **DELETE** /tags/{id} | Delete a tag by ID
*AppointmentBackend.TagApi* | [**getTagById**](docs/TagApi.md#getTagById) | **GET** /tags/{id} | Get a single tag by its ID
*AppointmentBackend.TagApi* | [**getTags**](docs/TagApi.md#getTags) | **GET** /tags | Get all tags
*AppointmentBackend.TagApi* | [**postTag**](docs/TagApi.md#postTag) | **POST** /tags | Create a new tag
*AppointmentBackend.TagApi* | [**putTagById**](docs/TagApi.md#putTagById) | **PUT** /tags/{id} | Updates an existing tag
*AppointmentBackend.WidgetApiApi* | [**getBookingConfig**](docs/WidgetApiApi.md#getBookingConfig) | **GET** /booking/config/{id} | Get the basic configuration information for the widget of the specified tenant
*AppointmentBackend.WidgetApiApi* | [**getBookingSchedule**](docs/WidgetApiApi.md#getBookingSchedule) | **GET** /booking/schedule/{tid}/{sid}/{wid}/{date} | Get the available times at which a service can be booked.
*AppointmentBackend.WidgetApiApi* | [**postBookingReserve**](docs/WidgetApiApi.md#postBookingReserve) | **POST** /booking/reserve | Reserve a time slot for a user
*AppointmentBackend.WidgetApiApi* | [**postBookingReserveConfirmation**](docs/WidgetApiApi.md#postBookingReserveConfirmation) | **POST** /booking/reserve/{rid}/confirmation | Confirm a reservation with the PIN sent to the user
*AppointmentBackend.WidgetApiApi* | [**putBookingReserveById**](docs/WidgetApiApi.md#putBookingReserveById) | **PUT** /booking/reserve/{rid} | Resend the code for an existing reservation
*AppointmentBackend.WorkerApi* | [**deleteWorkerById**](docs/WorkerApi.md#deleteWorkerById) | **DELETE** /workers/{id} | Deletes a worker by its ID
*AppointmentBackend.WorkerApi* | [**getWorkerById**](docs/WorkerApi.md#getWorkerById) | **GET** /workers/{id} | Get a single worker by its ID
*AppointmentBackend.WorkerApi* | [**getWorkers**](docs/WorkerApi.md#getWorkers) | **GET** /workers | Get the list of all workers
*AppointmentBackend.WorkerApi* | [**postWorker**](docs/WorkerApi.md#postWorker) | **POST** /workers | Create a new worker
*AppointmentBackend.WorkerApi* | [**putWorkerById**](docs/WorkerApi.md#putWorkerById) | **PUT** /workers/{id} | Update an existing worker


## Documentation for Models

 - [AppointmentBackend.AnswerOption](docs/AnswerOption.md)
 - [AppointmentBackend.Availabilities](docs/Availabilities.md)
 - [AppointmentBackend.Availability](docs/Availability.md)
 - [AppointmentBackend.BookingTenant](docs/BookingTenant.md)
 - [AppointmentBackend.ConfirmationRequest](docs/ConfirmationRequest.md)
 - [AppointmentBackend.ConfirmationResponse](docs/ConfirmationResponse.md)
 - [AppointmentBackend.DayOfWeek](docs/DayOfWeek.md)
 - [AppointmentBackend.ExtraQuestion](docs/ExtraQuestion.md)
 - [AppointmentBackend.Holiday](docs/Holiday.md)
 - [AppointmentBackend.HolidayRegion](docs/HolidayRegion.md)
 - [AppointmentBackend.ListWrapperAvailability](docs/ListWrapperAvailability.md)
 - [AppointmentBackend.ListWrapperAvailabilityDataInner](docs/ListWrapperAvailabilityDataInner.md)
 - [AppointmentBackend.ListWrapperBookingTenant](docs/ListWrapperBookingTenant.md)
 - [AppointmentBackend.ListWrapperBookingTenantDataInner](docs/ListWrapperBookingTenantDataInner.md)
 - [AppointmentBackend.ListWrapperHoliday](docs/ListWrapperHoliday.md)
 - [AppointmentBackend.ListWrapperHolidayDataInner](docs/ListWrapperHolidayDataInner.md)
 - [AppointmentBackend.ListWrapperHolidayRegion](docs/ListWrapperHolidayRegion.md)
 - [AppointmentBackend.ListWrapperHolidayRegionDataInner](docs/ListWrapperHolidayRegionDataInner.md)
 - [AppointmentBackend.ListWrapperReservation](docs/ListWrapperReservation.md)
 - [AppointmentBackend.ListWrapperReservationDataInner](docs/ListWrapperReservationDataInner.md)
 - [AppointmentBackend.ListWrapperService](docs/ListWrapperService.md)
 - [AppointmentBackend.ListWrapperServiceDataInner](docs/ListWrapperServiceDataInner.md)
 - [AppointmentBackend.ListWrapperTag](docs/ListWrapperTag.md)
 - [AppointmentBackend.ListWrapperTagDataInner](docs/ListWrapperTagDataInner.md)
 - [AppointmentBackend.ListWrapperWorker](docs/ListWrapperWorker.md)
 - [AppointmentBackend.ListWrapperWorkerDataInner](docs/ListWrapperWorkerDataInner.md)
 - [AppointmentBackend.Medium](docs/Medium.md)
 - [AppointmentBackend.NewAvailability](docs/NewAvailability.md)
 - [AppointmentBackend.NewBookingTenant](docs/NewBookingTenant.md)
 - [AppointmentBackend.NewReservation](docs/NewReservation.md)
 - [AppointmentBackend.NewService](docs/NewService.md)
 - [AppointmentBackend.NewTag](docs/NewTag.md)
 - [AppointmentBackend.NewWorker](docs/NewWorker.md)
 - [AppointmentBackend.Reservation](docs/Reservation.md)
 - [AppointmentBackend.ReservationLimit](docs/ReservationLimit.md)
 - [AppointmentBackend.ReservationRequest](docs/ReservationRequest.md)
 - [AppointmentBackend.ReservationResponse](docs/ReservationResponse.md)
 - [AppointmentBackend.ReservationType](docs/ReservationType.md)
 - [AppointmentBackend.Service](docs/Service.md)
 - [AppointmentBackend.ServiceConfig](docs/ServiceConfig.md)
 - [AppointmentBackend.SourceMedium](docs/SourceMedium.md)
 - [AppointmentBackend.Tag](docs/Tag.md)
 - [AppointmentBackend.TenantConfig](docs/TenantConfig.md)
 - [AppointmentBackend.Worker](docs/Worker.md)
 - [AppointmentBackend.WorkerConfig](docs/WorkerConfig.md)


## Documentation for Authorization


Authentication schemes defined for the API:
### oauth


- **Type**: OAuth
- **Flow**: accessCode
- **Authorization URL**: https://login.p7m.de/auth/authorize
- **Scopes**: N/A