@tennac-booking/sdk

v1.0.143

Published

5 hours ago

OpenAPI client for @tennac-booking/sdk

0High
0Medium
0Low

theooo

vlt_dev

baptistend

axios typescript openapi-client openapi-generator @tennac-booking/sdk

@tennac-booking/[email protected]

This generator creates TypeScript/JavaScript client that utilizes axios. The generated Node module can be used in the following environments:

Environment

Node.js
Webpack
Browserify

Language level

ES5 - you must have a Promises/A+ library installed
ES6

Module system

CommonJS
ES6 module system

It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via package.json. (Reference)

Building

To build and compile the typescript sources to javascript use:

npm install
npm run build

Publishing

First build the package then run npm publish

Consuming

navigate to the folder of your consuming project and run one of the following commands.

published:

npm install @tennac-booking/[email protected] --save

unPublished (not recommended):

npm install PATH_TO_GENERATED_PACKAGE --save

Documentation for API Endpoints

All URIs are relative to http://localhost

Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- BookingsApi | getBookingHistory | GET /api/bookings/history/{bookingId} | BookingsApi | getBookingPrice | POST /api/bookings/booking-price | BookingsApi | getQuickReservationSlots | GET /api/bookings/quick-reservations | BookingsManagerApi | applyNoShowFee | POST /api/bookings/{bookingId}/no-show | BookingsManagerApi | managerCancelBooking | POST /api/bookings/{bookingId}/manager-cancel | BookingsStaffApi | checkInPlayer | POST /api/bookings/{bookingId}/check-in | BookingsStaffApi | createStaffBooking | POST /api/bookings/staff | BookingsStaffApi | getBookingById | GET /api/bookings/{bookingId} | BookingsStaffApi | getBookingHistoryStaff | GET /api/bookings/staff/history{bookingId} | BookingsStaffApi | getBookingPaymentStatus | GET /api/bookings/{bookingId}/payment-status | BookingsStaffApi | getDailyBookings | GET /api/bookings/daily/{date} | BookingsStaffApi | getWeeklyBookings | GET /api/bookings/weekly/{weekId} | BookingsStaffApi | listClubBookings | GET /api/bookings/staff | BookingsUserApi | cancelBooking | DELETE /api/bookings/{bookingId} | BookingsUserApi | createBooking | POST /api/bookings | ClientApi | clientRegister | POST /clients/register | ClientApi | getClientSubscriptions | GET /clients/subscriptions | ClientApi | getManagedClubs | GET /clients/managed-clubs | ClientApi | onboardClub | POST /clients/onboarding | ClubAnalyticsApi | getMostLikedClub | GET /api/club-analytics/most-liked-clubs | ClubAnalyticsApi | getPopularClubs | GET /api/club-analytics/popular-clubs | ClubAnalyticsStaffApi | getAnalyticsBySport | GET /api/club-analytics/sport/{sportId}/analytics | ClubAnalyticsStaffApi | getBookingsPerDay | GET /api/club-analytics/bookings/per-day | ClubAnalyticsStaffApi | getClubPlayerBookingsById | GET /api/club-analytics/players/{playerId}/bookings | ClubAnalyticsStaffApi | getClubPlayerById | GET /api/club-analytics/players/{playerId} | ClubAnalyticsStaffApi | getClubPlayerStatisticsById | GET /api/club-analytics/players/{playerId}/statistics | ClubAnalyticsStaffApi | getClubPlayers | GET /api/club-analytics/players | ClubAnalyticsStaffApi | getClubSubscribersSummary | GET /api/club-analytics/subscribers/total | ClubAnalyticsStaffApi | getDailyTurnOver | GET /api/club-analytics/daily-turnover | ClubAnalyticsStaffApi | getGenderPercentage | GET /api/club-analytics/gender-percentage | ClubAnalyticsStaffApi | getInfillPercentagePerPeriod | GET /api/club-analytics/infill-percentage | ClubAnalyticsStaffApi | getLastSixMonthsTurnover | GET /api/club-analytics/last-six-months-turnover | ClubAnalyticsStaffApi | getLeastBookedTimeSlots | GET /api/club-analytics/bookings/least-booked-time-slots | ClubAnalyticsStaffApi | getLeastBookedWeekday | GET /api/club-analytics/bookings/least-booked-weekday | ClubAnalyticsStaffApi | getMonthlyTurnOver | GET /api/club-analytics/monthly-turnover | ClubAnalyticsStaffApi | getNewBookingsCount | GET /api/club-analytics/bookings/new | ClubAnalyticsStaffApi | getNewSubscribersCount | GET /api/club-analytics/subscribers/new | ClubAnalyticsStaffApi | getNoShowRate | GET /api/club-analytics/bookings/no-show-rate | ClubAnalyticsStaffApi | getNumberOfClubUsers | GET /api/club-analytics/users-count | ClubAnalyticsStaffApi | getRetentionRate | GET /api/club-analytics/retention-rate | ClubAnalyticsStaffApi | getRevenueBySport | GET /api/club-analytics/revenue-by-sport | ClubAnalyticsStaffApi | getTenNextBookings | GET /api/club-analytics/next-bookings | ClubAnalyticsStaffApi | getTopCourtsByBookings | GET /api/club-analytics/top-courts | ClubAnalyticsStaffApi | getYearlyTurnOver | GET /api/club-analytics/yearly-turnover | ClubRolesManagerApi | createClubRole | POST /api/club-roles | ClubRolesManagerApi | deleteClubRole | DELETE /api/club-roles/{id} | ClubRolesManagerApi | updateClubRole | PUT /api/club-roles/{id} | ClubRolesStaffApi | getAllClubRoles | GET /api/club-roles | ClubRolesStaffApi | getClubRoleById | GET /api/club-roles/{id} | ClubRolesStaffApi | getUserRolesInClubs | GET /api/club-roles/me/roles | ClubSettingsManagerApi | duplicateDaySchedule | POST /api/club-settings/hours/day/duplicate | ClubSettingsManagerApi | updateAccessSettings | PATCH /api/club-settings/access | ClubSettingsManagerApi | updateClubGeneralSettings | PATCH /api/club-settings/settings/general | ClubSettingsManagerApi | updateDaySchedule | PATCH /api/club-settings/hours/day/{day} | ClubSettingsManagerApi | updateHoursSettings | PUT /api/club-settings/hours | ClubSettingsManagerApi | updatePresentationSettings | PATCH /api/club-settings/presentation | ClubSettingsManagerApi | updateReservationSettings | PUT /api/club-settings/reservation | ClubSettingsStaffApi | getAccessSettings | GET /api/club-settings/access | ClubSettingsStaffApi | getClubGeneralSettings | GET /api/club-settings/settings/general | ClubSettingsStaffApi | getHoursSettings | GET /api/club-settings/hours | ClubSettingsStaffApi | getPresentationSettings | GET /api/club-settings/presentation | ClubSettingsStaffApi | getReservationSettings | GET /api/club-settings/reservation | ClubsApi | getActiveClubs | GET /api/clubs/active | ClubsApi | getAllClubs | GET /api/clubs | ClubsApi | getAvailableSlotsByClubById | GET /api/clubs/{clubID}/availableSlots | ClubsApi | getAvailableSlotsBySports | GET /api/clubs/{id}/sports/{sportId}/slots | ClubsApi | getAvailableSlotsBySportsAndDay | GET /api/clubs/{id}/sports/{sportId}/slots/{day} | ClubsApi | getClubInfo | GET /api/clubs/info | ClubsApi | getClubMetadata | GET /api/clubs/{clubId}/metadata | ClubsApi | getClubPageInfo | GET /api/clubs/club-page/{clubId} | ClubsApi | getClubUsersById | GET /api/clubs/{id}/users | ClubsApi | getClubsWithVerificationDomains | GET /api/clubs/verification-domains | ClubsApi | getCourtsByClubAndSportById | GET /api/clubs/{id}/sports/{sportId}/courts | ClubsApi | getPublishedActualities | GET /api/clubs/{id}/actualities | ClubsApi | getSlotsByClubById | GET /api/clubs/{id}/slots | ClubsApi | getSportsByClubById | GET /api/clubs/{id}/sports | ClubsManagerApi | addClubMember | POST /api/clubs/members | ClubsManagerApi | archivePriceForSubscriptionPlan | DELETE /api/clubs/subscription-plans/{priceId}/archive-price | ClubsManagerApi | createActuality | POST /api/clubs/actualities | ClubsManagerApi | createCourtForClub | POST /api/clubs/courts | ClubsManagerApi | createPriceForSubscriptionPlan | POST /api/clubs/subscription-plans/{productId}/prices | ClubsManagerApi | createSportForClub | POST /api/clubs/sports | ClubsManagerApi | deleteActuality | DELETE /api/clubs/actualities/{actualityId} | ClubsManagerApi | deleteClubMember | DELETE /api/clubs/members/{userId} | ClubsManagerApi | deleteCourt | DELETE /api/clubs/courts/{courtId} | ClubsManagerApi | deleteSlotsByClubInRange | DELETE /api/clubs/slots | ClubsManagerApi | deleteSubscriptionPlanForClub | DELETE /api/clubs/subscription-plans/{productId} | ClubsManagerApi | publishActuality | PATCH /api/clubs/actualities/{actualityId}/publish | ClubsManagerApi | restoreSubscriptionPlanForClub | POST /api/clubs/subscription-plans/{productId}/restore | ClubsManagerApi | restoreSubscriptionPriceForClub | POST /api/clubs/subscription-plans/{priceId}/restore-price | ClubsManagerApi | updateActuality | PUT /api/clubs/actualities/{actualityId} | ClubsManagerApi | updateClub | PUT /api/clubs | ClubsManagerApi | updateClubInfos | PUT /api/clubs/infos | ClubsManagerApi | updateClubMember | PATCH /api/clubs/members/{userId} | ClubsManagerApi | updateClubPresentationSettings | PUT /api/clubs/settings/presentation | ClubsManagerApi | updateCourt | PUT /api/clubs/courts/{courtId} | ClubsManagerApi | updateSubscriptionPlanForClub | PUT /api/clubs/subscription-plans/{priceId} | ClubsStaffApi | createOnsiteInvoiceForBooking | POST /api/clubs/staff/bookings/{bookingId}/invoices | ClubsStaffApi | getActualities | GET /api/clubs/staff/actualities | ClubsStaffApi | getClubInfos | GET /api/clubs/infos | ClubsStaffApi | getClubMembers | GET /api/clubs/members | ClubsStaffApi | getClubPresentationSettings | GET /api/clubs/settings/presentation | ClubsStaffApi | getClubRoles | GET /api/clubs/roles | ClubsStaffApi | getClubType | GET /api/clubs/clubType | ClubsStaffApi | getCourtsByClub | GET /api/clubs/courts | ClubsStaffApi | getInvoices | GET /api/clubs/invoices | ClubsStaffApi | getUserProfileStaff | GET /api/clubs/staff/profile/{id} | ClubsStaffApi | updateUserCreditsStaff | PUT /api/clubs/staff/user-credits/{id} | DefaultApi | createClub | POST /api/clubs | EventsApi | checkTeamNameAvailability | GET /api/events/{eventId}/team-name-availability | EventsApi | estimateEventPrice | POST /api/events/{eventId}/estimate-price | EventsApi | getEventById | GET /api/events/{eventId} | EventsApi | getPublishedEventsByClubId | GET /api/events | EventsApi | joinEvent | POST /api/events/{eventId}/join | EventsApi | leaveEvent | DELETE /api/events/{eventId}/leave | EventsManagerApi | checkEventConflicts | POST /api/events/manager/checkConflicts | EventsManagerApi | createEvent | POST /api/events/manager/createEvent | EventsManagerApi | deleteEvent | DELETE /api/events/manager/deleteEvent/{eventId} | EventsManagerApi | getExpiringRecurringDefinitions | GET /api/events/manager/recurring/expiring | EventsManagerApi | publishEvent | PUT /api/events/manager/publishEvent/{eventId} | EventsManagerApi | unpublishEvent | PUT /api/events/manager/unpublishEvent/{eventId} | EventsManagerApi | updateEvent | PUT /api/events/manager/updateEvent/{eventId} | EventsManagerApi | updatePublishedEvent | PUT /api/events/manager/updatePublishedEvent/{eventId} | EventsManagerApi | updateRecurringDefinition | PUT /api/events/manager/recurring/{definitionId} | EventsStaffApi | checkInEventParticipants | POST /api/events/{eventBookingId}/check-in | EventsStaffApi | getDailyEvents | GET /api/events/calendar/daily | EventsStaffApi | getEventsByClub | GET /api/events/staff/getEvents | EventsStaffApi | getMonthlyEvents | GET /api/events/calendar/monthly | EventsStaffApi | getWeeklyEvents | GET /api/events/calendar/weekly | ImagesApi | cleanupImages | POST /api/images/cleanup | SportsManagerApi | createSport | POST /api/sports | SportsManagerApi | deleteSport | DELETE /api/sports/{id} | SportsManagerApi | updateSport | PUT /api/sports/{id} | SportsPublicApi | getVerifiedSports | GET /api/sports/verified | SubscriptionsManagerApi | archivePlan | POST /api/subscriptions/plans/{productId}/archive | SubscriptionsManagerApi | createPlan | POST /api/subscriptions/plans | SubscriptionsManagerApi | deletePlan | DELETE /api/subscriptions/plans/{productId} | SubscriptionsManagerApi | updatePlan | PUT /api/subscriptions/plans | SubscriptionsPublicApi | getPublicPlans | GET /api/subscriptions/plans/{clubId} | SubscriptionsStaffApi | getClubPlans | GET /api/subscriptions/plans | SubscriptionsStaffApi | sendSubscriptionInvitation | POST /api/subscriptions/invitations | SubscriptionsUserApi | cancel | DELETE /api/subscriptions/{clubId}/{subscriptionId} | SubscriptionsUserApi | mySubscriptions | GET /api/subscriptions/me | SubscriptionsUserApi | resume | POST /api/subscriptions/{clubId}/{subscriptionId}/resume | SubscriptionsUserApi | subscribe | POST /api/subscriptions/subscribe | UserApi | getMyClubInfos | GET /api/users/me/club-infos | UsersApi | addFavoriteClub | POST /api/users/me/favorite-clubs | UsersApi | addFavoritePlayer | POST /api/users/me/favoritesPlayers | UsersApi | addOrganization | POST /api/users/me/add-organization | UsersApi | changePassword | PUT /api/users/me/password | UsersApi | getAllUsers | GET /api/users | UsersApi | getBookingDetail | GET /api/users/me/booking-detail/{bookingId} | UsersApi | getFavoriteClubs | GET /api/users/me/favorite-clubs | UsersApi | getFavoritesPlayers | GET /api/users/me/favoritesPlayers | UsersApi | getFrequentlyPlayedWith | GET /api/users/me/frequentlyPlayedWith | UsersApi | getFrequentlyVisitedClub | GET /api/users/me/frequentlyVisitedClub | UsersApi | getMe | GET /api/users/me | UsersApi | getMyClubMemberships | GET /api/users/me/club-memberships | UsersApi | getNearestClubs | GET /api/users/me/nearest-clubs | UsersApi | getNearestClubsFromCoordinates | GET /api/users/nearest-clubs/coordinates | UsersApi | getNearestUsers | GET /api/users/me/nearest-players | UsersApi | getNearestUsersFromCoordinates | GET /api/users/nearest-players/coordinates | UsersApi | getPlayerCategories | GET /api/users/players/categories | UsersApi | getUserBookings | GET /api/users/me/bookings | UsersApi | getUserEvents | GET /api/users/me/events | UsersApi | getUserProfileById | GET /api/users/profile/{id} | UsersApi | listPlayers | GET /api/users/players | UsersApi | login | POST /api/users/login | UsersApi | refreshToken | POST /api/users/refresh-token | UsersApi | register | POST /api/users | UsersApi | removeFavoriteClub | DELETE /api/users/me/favorite-clubs/{clubId} | UsersApi | removeFavoritePlayer | DELETE /api/users/me/favoritesPlayers/{favoritePlayerId} | UsersApi | removeOrganization | POST /api/users/me/remove-organization | UsersApi | requestEmailVerification | POST /api/users/me/request-email-verification | UsersApi | requestPasswordReset | POST /api/users/request-password-reset | UsersApi | resetPassword | POST /api/users/reset-password | UsersApi | signInOrSignUpWithGoogle | POST /api/users/googleSignin | UsersApi | updateCustomer | PUT /api/users/me/customer | UsersApi | updateLevelBySports | PUT /api/users/me/level-by-sports | UsersApi | updateMe | PUT /api/users/me | UsersApi | updateProfilePicture | PUT /api/users/me/profile-picture | UsersApi | verifyEmail | POST /api/users/verify-email | UsersApi | verifyOrganization | POST /api/users/verify-organization |

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

bearerAuth

Type: Bearer authentication (JWT)

staffAuth

Type: Bearer authentication (JWT)

managerAuth

Type: Bearer authentication (JWT)

clientAuth

Type: Bearer authentication (JWT)