@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 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

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install @p7m/appointment-backend --save

Finally, you need to build the module:

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:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

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:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

Finally, you need to build the module:

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:

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

Documentation for Models

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

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