easyappointments_api

v1.1.3

Published

9 months ago

These_are_the_OpenAPI_specs_that_describe_the_REST_API_of_EasyAppointments_

Downloads

0High
0Medium
0Low

ndiaz-kambda

easyappointments_api

EasyappointmentsApi - JavaScript client for easyappointments_api These are the OpenAPI specs that describe the REST API of Easy!Appointments. This SDK is automatically generated by the Swagger Codegen project:

API version: 1.0.0
Package version: 1.0.0
Build package: io.swagger.codegen.v3.generators.javascript.JavaScriptClientCodegen For more information, please visit https://easyappointments.org

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 easyappointments_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:

    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 EasyappointmentsApi = require('easyappointments_api');
var defaultClient = EasyappointmentsApi.ApiClient.instance;
// Configure HTTP basic authorization: BasicAuth
var BasicAuth = defaultClient.authentications['BasicAuth'];
BasicAuth.username = 'YOUR USERNAME'
BasicAuth.password = 'YOUR PASSWORD'


var api = new EasyappointmentsApi.AdminsApi()
var adminId = 56; // {Number} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
api.adminsAdminIdDelete(adminId, callback);

Documentation for API Endpoints

All URIs are relative to https://demo.easyappointments.org/index.php/api/v1/

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- EasyappointmentsApi.AdminsApi | adminsAdminIdDelete | DELETE /admins/{adminId} | Delete an admin EasyappointmentsApi.AdminsApi | adminsAdminIdGet | GET /admins/{adminId} | Get an admin EasyappointmentsApi.AdminsApi | adminsAdminIdPut | PUT /admins/{adminId} | Update an admin EasyappointmentsApi.AdminsApi | adminsGet | GET /admins | Get all admins EasyappointmentsApi.AdminsApi | adminsPost | POST /admins | Create an admin EasyappointmentsApi.AppointmentsApi | appointmentsAppointmentIdDelete | DELETE /appointments/{appointmentId} | Delete an appointment EasyappointmentsApi.AppointmentsApi | appointmentsAppointmentIdGet | GET /appointments/{appointmentId} | Get an appointment EasyappointmentsApi.AppointmentsApi | appointmentsAppointmentIdPut | PUT /appointments/{appointmentId} | Update an appointment EasyappointmentsApi.AppointmentsApi | appointmentsGet | GET /appointments | Get all appointments EasyappointmentsApi.AppointmentsApi | appointmentsPost | POST /appointments | Create an appointment EasyappointmentsApi.AvailabilitiesApi | availabilitiesGet | GET /availabilities | Gets availability EasyappointmentsApi.CategoriesApi | categoriesCategoryIdDelete | DELETE /categories/{categoryId} | Delete a category EasyappointmentsApi.CategoriesApi | categoriesCategoryIdGet | GET /categories/{categoryId} | Get a category EasyappointmentsApi.CategoriesApi | categoriesCategoryIdPut | PUT /categories/{categoryId} | Update a category EasyappointmentsApi.CategoriesApi | categoriesGet | GET /categories | Get all categories EasyappointmentsApi.CategoriesApi | categoriesPost | POST /categories | Create a category EasyappointmentsApi.CustomersApi | customersCustomerIdDelete | DELETE /customers/{customerId} | Delete a customer EasyappointmentsApi.CustomersApi | customersCustomerIdGet | GET /customers/{customerId} | Get a customer EasyappointmentsApi.CustomersApi | customersCustomerIdPut | PUT /customers/{customerId} | Update a customer EasyappointmentsApi.CustomersApi | customersGet | GET /customers | Get all customers EasyappointmentsApi.CustomersApi | customersPost | POST /customers | Create a customer EasyappointmentsApi.ProvidersApi | providersGet | GET /providers | Get all providers EasyappointmentsApi.ProvidersApi | providersPost | POST /providers | Create a provider EasyappointmentsApi.ProvidersApi | providersProviderIdDelete | DELETE /providers/{providerId} | Delete a provider EasyappointmentsApi.ProvidersApi | providersProviderIdGet | GET /providers/{providerId} | Get a provider EasyappointmentsApi.ProvidersApi | providersProviderIdPut | PUT /providers/{providerId} | Update a provider EasyappointmentsApi.SecretariesApi | secretariesGet | GET /secretaries | Get all secretaries EasyappointmentsApi.SecretariesApi | secretariesPost | POST /secretaries | Create a secretary EasyappointmentsApi.SecretariesApi | secretariesSecretaryIdDelete | DELETE /secretaries/{secretaryId} | Delete a secretary EasyappointmentsApi.SecretariesApi | secretariesSecretaryIdGet | GET /secretaries/{secretaryId} | Get a secretary EasyappointmentsApi.SecretariesApi | secretariesSecretaryIdPut | PUT /secretaries/{secretaryId} | Update a secretary EasyappointmentsApi.ServicesApi | servicesGet | GET /services | Get all services EasyappointmentsApi.ServicesApi | servicesPost | POST /services | Create a service EasyappointmentsApi.ServicesApi | servicesServiceIdDelete | DELETE /services/{serviceId} | Delete a service EasyappointmentsApi.ServicesApi | servicesServiceIdGet | GET /services/{serviceId} | Get a service EasyappointmentsApi.ServicesApi | servicesServiceIdPut | PUT /services/{serviceId} | Update a service EasyappointmentsApi.SettingsApi | settingsGet | GET /settings | Get all settings EasyappointmentsApi.SettingsApi | settingsSettingNameGet | GET /settings/{settingName} | Get a setting EasyappointmentsApi.SettingsApi | settingsSettingNamePut | PUT /settings/{settingName} | Update a setting EasyappointmentsApi.UnavailabilitiesApi | unavailabilitiesGet | GET /unavailabilities | Get all unavailabilities EasyappointmentsApi.UnavailabilitiesApi | unavailabilitiesPost | POST /unavailabilities | Create an unavailability EasyappointmentsApi.UnavailabilitiesApi | unavailabilitiesUnavailabilityIdDelete | DELETE /unavailabilities/{unavailabilityId} | Delete an unavailability EasyappointmentsApi.UnavailabilitiesApi | unavailabilitiesUnavailabilityIdGet | GET /unavailabilities/{unavailabilityId} | Get an unavailability EasyappointmentsApi.UnavailabilitiesApi | unavailabilitiesUnavailabilityIdPut | PUT /unavailabilities/{unavailabilityId} | Update an unavailability

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme

easyappointments_api

Installation

For Node.js

npm

git

For browser

Webpack Configuration

Getting Started

Documentation for API Endpoints

Documentation for Models

Documentation for Authorization

BasicAuth

BearerToken