lytesnap_backend_api v1.0.13

lytesnap_backend_api

LytesnapBackendApi - JavaScript client for lytesnap_backend_api This document details all the API endpoints that are consumed exclusively by lytesnap frontend. This SDK is automatically generated by the OpenAPI Generator project:

• API version: 1.0.0
• Package version: 1.0.13
• 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 lytesnap_backend_api --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 lytesnap_backend_api 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 LytesnapBackendApi = require('lytesnap_backend_api');

var defaultClient = LytesnapBackendApi.ApiClient.instance;
// Configure Bearer (JWT) access token for authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.accessToken = "YOUR ACCESS TOKEN"

var api = new LytesnapBackendApi.DefaultApi()
var locationId = "locationId_example"; // {String} 
api.deleteLocationLocationId(locationId).then(function() {
  console.log('API called successfully.');
}, function(error) {
  console.error(error);
});

Documentation for API Endpoints

All URIs are relative to http://localhost:5000/api/v1

Documentation for Models

• LytesnapBackendApi.CoachAvailability
• LytesnapBackendApi.CoachAvailabilityLocation
• LytesnapBackendApi.CoachAvailabilityPut
• LytesnapBackendApi.CoachNotification
• LytesnapBackendApi.CoachNotificationAdditionalInfo
• LytesnapBackendApi.CoachNotificationAdditionalInfoLessonInfo
• LytesnapBackendApi.CoachPaymentMethod
• LytesnapBackendApi.CoachProfile
• LytesnapBackendApi.CoachProfileAboutMe
• LytesnapBackendApi.CoachProfileCertificates
• LytesnapBackendApi.CoachProfileCredentialsAndExperience
• LytesnapBackendApi.CoachProfileFaq
• LytesnapBackendApi.CoachProfileSettingsPrivacyResetPassword
• LytesnapBackendApi.CoachProfileTrainingLocations
• LytesnapBackendApi.CoachReview
• LytesnapBackendApi.CoachSession
• LytesnapBackendApi.CoachSessionProvided
• LytesnapBackendApi.CoachSessionPut
• LytesnapBackendApi.CoachSessionPutProvided
• LytesnapBackendApi.CoachSessionPutWhatToBring
• LytesnapBackendApi.CoachSessionWhatToBring
• LytesnapBackendApi.Filter
• LytesnapBackendApi.FilterFocusTags
• LytesnapBackendApi.FilterPriceRange
• LytesnapBackendApi.FilterSchedule
• LytesnapBackendApi.FilterSpecialties
• LytesnapBackendApi.InlineObject
• LytesnapBackendApi.InlineObject1
• LytesnapBackendApi.InlineObject10
• LytesnapBackendApi.InlineObject11
• LytesnapBackendApi.InlineObject12
• LytesnapBackendApi.InlineObject13
• LytesnapBackendApi.InlineObject14
• LytesnapBackendApi.InlineObject15
• LytesnapBackendApi.InlineObject16
• LytesnapBackendApi.InlineObject2
• LytesnapBackendApi.InlineObject3
• LytesnapBackendApi.InlineObject4
• LytesnapBackendApi.InlineObject5
• LytesnapBackendApi.InlineObject6
• LytesnapBackendApi.InlineObject7
• LytesnapBackendApi.InlineObject8
• LytesnapBackendApi.InlineObject9
• LytesnapBackendApi.InlineResponse200
• LytesnapBackendApi.InlineResponse2001
• LytesnapBackendApi.InlineResponse20010
• LytesnapBackendApi.InlineResponse20010CancellationReason
• LytesnapBackendApi.InlineResponse20011
• LytesnapBackendApi.InlineResponse20012
• LytesnapBackendApi.InlineResponse20013
• LytesnapBackendApi.InlineResponse20014
• LytesnapBackendApi.InlineResponse20015
• LytesnapBackendApi.InlineResponse20016
• LytesnapBackendApi.InlineResponse20017
• LytesnapBackendApi.InlineResponse20018
• LytesnapBackendApi.InlineResponse20019
• LytesnapBackendApi.InlineResponse2002
• LytesnapBackendApi.InlineResponse20020
• LytesnapBackendApi.InlineResponse20021
• LytesnapBackendApi.InlineResponse2003
• LytesnapBackendApi.InlineResponse2003SomeoneMessagedMe
• LytesnapBackendApi.InlineResponse2004
• LytesnapBackendApi.InlineResponse2005
• LytesnapBackendApi.InlineResponse2006
• LytesnapBackendApi.InlineResponse2007
• LytesnapBackendApi.InlineResponse2008
• LytesnapBackendApi.InlineResponse2008TopCities
• LytesnapBackendApi.InlineResponse2008TopStates
• LytesnapBackendApi.InlineResponse2009
• LytesnapBackendApi.InlineResponse201
• LytesnapBackendApi.InlineResponse2011
• LytesnapBackendApi.InlineResponse2012
• LytesnapBackendApi.InlineResponse2013
• LytesnapBackendApi.InlineResponse2014
• LytesnapBackendApi.InlineResponse2014Data
• LytesnapBackendApi.InlineResponse400
• LytesnapBackendApi.InlineResponse4001
• LytesnapBackendApi.InlineResponse400Errors
• LytesnapBackendApi.InlineResponse500
• LytesnapBackendApi.InlineResponse500Errors
• LytesnapBackendApi.Lesson
• LytesnapBackendApi.LessonCancelRequest
• LytesnapBackendApi.LessonProblemReport
• LytesnapBackendApi.LessonStudentInfo
• LytesnapBackendApi.LocationRequest
• LytesnapBackendApi.LocationRequestOptional
• LytesnapBackendApi.LocationResponse
• LytesnapBackendApi.StudentNotificationFilter
• LytesnapBackendApi.StudentNotificationFilterFilter
• LytesnapBackendApi.StudentPaymentMethod
• LytesnapBackendApi.StudentPaymentMethodCard
• LytesnapBackendApi.StudentProfile
• LytesnapBackendApi.StudentProfileBasicInfo
• LytesnapBackendApi.StudentProfileExperience
• LytesnapBackendApi.StudentProfileNotificationSettings
• LytesnapBackendApi.StudentProfileNotifications
• LytesnapBackendApi.StudentProfilePaymentMethods
• LytesnapBackendApi.StudentProfilePost
• LytesnapBackendApi.StudentProfilePostExperience
• LytesnapBackendApi.StudentProfilePostNotificationSettings
• LytesnapBackendApi.StudentProfilePostPaymentMethods
• LytesnapBackendApi.User

Documentation for Authorization

bearerAuth

• Type: Bearer authentication (JWT)