@tennac-booking/sdk

## @tennac-booking/sdk@1.0.0 This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/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](https://www.typescriptlang.org/docs/handbook/declaration-files/consumption.html)) ### 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/sdk@1.0.0 --save ``` _unPublished (not recommended):_ ``` npm install PATH_TO_GENERATED_PACKAGE --save ``` ### Documentation for API Endpoints All URIs are relative to *https://api.mon-domaine.com* Class | Method | HTTP request | Description ------------ | ------------- | ------------- | ------------- *BookingsApi* | [**bookingsPost**](docs/BookingsApi.md#bookingspost) | **POST** /bookings | Créer une réservation *BookingsApi* | [**bookingsPreBookSlotIdPatch**](docs/BookingsApi.md#bookingsprebookslotidpatch) | **PATCH** /bookings/pre-book/{slotId} | Bloquer un créneau *ClubCourtsApi* | [**createCourtForClub**](docs/ClubCourtsApi.md#createcourtforclub) | **POST** /api/clubs/{id}/courts | Créer un terrain pour un club *ClubCourtsApi* | [**getCourtsByClub**](docs/ClubCourtsApi.md#getcourtsbyclub) | **GET** /api/clubs/{id}/courts | Récupérer tous les terrains pour un club *ClubRolesApi* | [**createClubRole**](docs/ClubRolesApi.md#createclubrole) | **POST** /api/club-roles | Crée un nouveau rôle de club *ClubRolesApi* | [**deleteClubRole**](docs/ClubRolesApi.md#deleteclubrole) | **DELETE** /api/club-roles/{id} | Supprime un rôle de club *ClubRolesApi* | [**getAllClubRoles**](docs/ClubRolesApi.md#getallclubroles) | **GET** /api/club-roles | Récupère tous les rôles de clubs *ClubRolesApi* | [**getClubRoleById**](docs/ClubRolesApi.md#getclubrolebyid) | **GET** /api/club-roles/{id} | Récupère un rôle de club par son ID *ClubRolesApi* | [**updateClubRole**](docs/ClubRolesApi.md#updateclubrole) | **PUT** /api/club-roles/{id} | Met à jour un rôle de club *ClubSettingsApi* | [**createClubSettings**](docs/ClubSettingsApi.md#createclubsettings) | **POST** /api/club-settings | Crée les paramètres d’un club *ClubSettingsApi* | [**deleteClubSettings**](docs/ClubSettingsApi.md#deleteclubsettings) | **DELETE** /api/club-settings | Supprime les paramètres d’un club *ClubSettingsApi* | [**getClubSettings**](docs/ClubSettingsApi.md#getclubsettings) | **GET** /api/club-settings | Récupère les paramètres d’un club *ClubSettingsApi* | [**updateClubSettings**](docs/ClubSettingsApi.md#updateclubsettings) | **PUT** /api/club-settings | Met à jour les paramètres d’un club *ClubSlotsApi* | [**deleteSlotsByClubInRange**](docs/ClubSlotsApi.md#deleteslotsbyclubinrange) | **DELETE** /api/clubs/{id}/slots | Supprimer des créneaux pour un club sur une plage de dates *ClubSlotsApi* | [**generateSlotsForNextThreeWeeks**](docs/ClubSlotsApi.md#generateslotsfornextthreeweeks) | **POST** /api/clubs/{id}/generate-slots | Générer les créneaux pour les 3 semaines à venir *ClubSlotsApi* | [**getAvailableSlotsBySports**](docs/ClubSlotsApi.md#getavailableslotsbysports) | **GET** /api/clubs/{id}/sports/{sportId}/slots | Obtenir tous les slots disponibles pour un sport dans un club *ClubSlotsApi* | [**getAvailableSlotsBySportsAndDay**](docs/ClubSlotsApi.md#getavailableslotsbysportsandday) | **GET** /api/clubs/{id}/sports/{sportId}/slots/{day} | Obtenir les slots disponibles pour un jour donné *ClubSlotsApi* | [**getSlotsByClub**](docs/ClubSlotsApi.md#getslotsbyclub) | **GET** /api/clubs/{id}/slots | Récupérer tous les créneaux pour un club *ClubSportsApi* | [**createSportForClub**](docs/ClubSportsApi.md#createsportforclub) | **POST** /api/clubs/{id}/sports | Créer un sport pour un club *ClubSportsApi* | [**getSportsByClub**](docs/ClubSportsApi.md#getsportsbyclub) | **GET** /api/clubs/{id}/sports | Récupérer tous les sports pour un club *ClubSubscriptionsApi* | [**archivePriceForSubscriptionPlan**](docs/ClubSubscriptionsApi.md#archivepriceforsubscriptionplan) | **DELETE** /api/clubs/{id}/subscription-plans/{priceId}/archive-price | Archiver un prix *ClubSubscriptionsApi* | [**createPriceForSubscriptionPlan**](docs/ClubSubscriptionsApi.md#createpriceforsubscriptionplan) | **POST** /api/clubs/{id}/subscription-plans/{productId}/prices | Créer un nouveau prix pour un plan *ClubSubscriptionsApi* | [**createSubscriptionPlanForClub**](docs/ClubSubscriptionsApi.md#createsubscriptionplanforclub) | **POST** /api/clubs/{id}/subscription-plans | Créer un plan d\'abonnement pour un club *ClubSubscriptionsApi* | [**deleteSubscriptionPlanForClub**](docs/ClubSubscriptionsApi.md#deletesubscriptionplanforclub) | **DELETE** /api/clubs/{id}/subscription-plans/{productId} | Supprimer un plan d\'abonnement pour un club *ClubSubscriptionsApi* | [**restoreSubscriptionPlanForClub**](docs/ClubSubscriptionsApi.md#restoresubscriptionplanforclub) | **POST** /api/clubs/{id}/subscription-plans/{productId}/restore | Réactiver un plan d\'abonnement *ClubSubscriptionsApi* | [**restoreSubscriptionPriceForClub**](docs/ClubSubscriptionsApi.md#restoresubscriptionpriceforclub) | **POST** /api/clubs/{id}/subscription-plans/{priceId}/restore-price | Réactiver un prix *ClubSubscriptionsApi* | [**updateSubscriptionPlanForClub**](docs/ClubSubscriptionsApi.md#updatesubscriptionplanforclub) | **PUT** /api/clubs/{id}/subscription-plans/{priceId} | Mettre à jour un plan d\'abonnement *ClubsApi* | [**addClubMember**](docs/ClubsApi.md#addclubmember) | **PUT** /api/clubs/{id}/add_members | Ajouter un membre à un club *ClubsApi* | [**createClub**](docs/ClubsApi.md#createclub) | **POST** /api/clubs | Créer un nouveau club *ClubsApi* | [**deleteClub**](docs/ClubsApi.md#deleteclub) | **DELETE** /api/clubs/{id} | Supprimer un club *ClubsApi* | [**getAllClubs**](docs/ClubsApi.md#getallclubs) | **GET** /api/clubs | Récupérer tous les clubs *ClubsApi* | [**getClubInfo**](docs/ClubsApi.md#getclubinfo) | **GET** /api/clubs/{id} | Récupérer les informations d\'un club *ClubsApi* | [**getClubMembers**](docs/ClubsApi.md#getclubmembers) | **GET** /api/clubs/{id}/members | Récupérer les membres d\'un club *ClubsApi* | [**getClubRoles**](docs/ClubsApi.md#getclubroles) | **GET** /api/clubs/{id}/roles | Récupérer les rôles d\'un club *ClubsApi* | [**updateClub**](docs/ClubsApi.md#updateclub) | **PUT** /api/clubs/{id} | Mettre à jour un club existant *SportsApi* | [**createSport**](docs/SportsApi.md#createsport) | **POST** /api/sports | Crée un sport dans un club *SportsApi* | [**deleteSport**](docs/SportsApi.md#deletesport) | **DELETE** /api/sports/{id} | Supprime un sport *SportsApi* | [**getAllSports**](docs/SportsApi.md#getallsports) | **GET** /api/sports | Récupère la liste des sports d’un club *SportsApi* | [**updateSport**](docs/SportsApi.md#updatesport) | **PUT** /api/sports/{id} | Met à jour un sport *UsersApi* | [**changePassword**](docs/UsersApi.md#changepassword) | **PUT** /api/users/me/password | Modifie le mot de passe de l\'utilisateur connecté *UsersApi* | [**getAllUsers**](docs/UsersApi.md#getallusers) | **GET** /api/users | Récupère la liste des utilisateurs *UsersApi* | [**getUserInfo**](docs/UsersApi.md#getuserinfo) | **GET** /api/users/me | Récupère les informations de l\'utilisateur connecté *UsersApi* | [**getUserRolesInClubs**](docs/UsersApi.md#getuserrolesinclubs) | **GET** /api/users/me/roles | Récupère les rôles de l\'utilisateur dans les clubs *UsersApi* | [**login**](docs/UsersApi.md#login) | **POST** /api/users/login | Authentifie un utilisateur *UsersApi* | [**refreshToken**](docs/UsersApi.md#refreshtoken) | **POST** /api/users/refresh-token | Rafraîchit le token d\'accès *UsersApi* | [**register**](docs/UsersApi.md#register) | **POST** /api/users | Crée un nouvel utilisateur *UsersApi* | [**updateUser**](docs/UsersApi.md#updateuser) | **PUT** /api/users/me | Met à jour les données de l\'utilisateur connecté ### Documentation For Models - [AddClubMemberRequest](docs/AddClubMemberRequest.md) - [AddClubMemberResponse](docs/AddClubMemberResponse.md) - [ApiErrorResponse](docs/ApiErrorResponse.md) - [BlockSlotResponse](docs/BlockSlotResponse.md) - [Booking](docs/Booking.md) - [BookingResponse](docs/BookingResponse.md) - [BookingStatus](docs/BookingStatus.md) - [ChangePasswordRequestBody](docs/ChangePasswordRequestBody.md) - [ChangePasswordResponse](docs/ChangePasswordResponse.md) - [Club](docs/Club.md) - [ClubInfoResponse](docs/ClubInfoResponse.md) - [ClubListResponse](docs/ClubListResponse.md) - [ClubMember](docs/ClubMember.md) - [ClubMembersResponse](docs/ClubMembersResponse.md) - [ClubResponse](docs/ClubResponse.md) - [ClubRole](docs/ClubRole.md) - [ClubRoleResponse](docs/ClubRoleResponse.md) - [ClubRolesResponse](docs/ClubRolesResponse.md) - [ClubSettings](docs/ClubSettings.md) - [Court](docs/Court.md) - [CourtResponse](docs/CourtResponse.md) - [CourtStatus](docs/CourtStatus.md) - [CourtsResponse](docs/CourtsResponse.md) - [CreateBookingRequest](docs/CreateBookingRequest.md) - [CreateClubRequest](docs/CreateClubRequest.md) - [CreateClubRoleRequestBody](docs/CreateClubRoleRequestBody.md) - [CreateCourtRequest](docs/CreateCourtRequest.md) - [CreatePriceRequest](docs/CreatePriceRequest.md) - [CreateSportRequest](docs/CreateSportRequest.md) - [CreateSubscriptionPlanRequest](docs/CreateSubscriptionPlanRequest.md) - [DeleteClub200Response](docs/DeleteClub200Response.md) - [DeleteClubRole200Response](docs/DeleteClubRole200Response.md) - [DeleteSlotsByClubInRange200Response](docs/DeleteSlotsByClubInRange200Response.md) - [GenerateSlotsForNextThreeWeeks201Response](docs/GenerateSlotsForNextThreeWeeks201Response.md) - [GetAllSportsRequest](docs/GetAllSportsRequest.md) - [GetClubSettingsRequest](docs/GetClubSettingsRequest.md) - [GetUserRolesInClubs200Response](docs/GetUserRolesInClubs200Response.md) - [LoginRequestBody](docs/LoginRequestBody.md) - [LoginResponse](docs/LoginResponse.md) - [PaymentMethod](docs/PaymentMethod.md) - [PlayerWithPaymentMethod](docs/PlayerWithPaymentMethod.md) - [PriceResponse](docs/PriceResponse.md) - [RefreshTokenRequestBody](docs/RefreshTokenRequestBody.md) - [RefreshTokenResponse](docs/RefreshTokenResponse.md) - [RegisterRequestBody](docs/RegisterRequestBody.md) - [RestoreSubscriptionPlanForClub200Response](docs/RestoreSubscriptionPlanForClub200Response.md) - [Slot](docs/Slot.md) - [SlotException](docs/SlotException.md) - [SlotResponse](docs/SlotResponse.md) - [SlotsResponse](docs/SlotsResponse.md) - [Sport](docs/Sport.md) - [SportResponse](docs/SportResponse.md) - [SportsResponse](docs/SportsResponse.md) - [StripeStatus](docs/StripeStatus.md) - [SubscriptionPlan](docs/SubscriptionPlan.md) - [SubscriptionPlanResponse](docs/SubscriptionPlanResponse.md) - [UpdateClubRequest](docs/UpdateClubRequest.md) - [UpdateClubRoleRequestBody](docs/UpdateClubRoleRequestBody.md) - [UpdateSportRequest](docs/UpdateSportRequest.md) - [UpdateSubscriptionPlanRequest](docs/UpdateSubscriptionPlanRequest.md) - [UpdateSubscriptionPlanResponse](docs/UpdateSubscriptionPlanResponse.md) - [UpdateUserRequestBody](docs/UpdateUserRequestBody.md) - [User](docs/User.md) - [UserResponse](docs/UserResponse.md) <a id="documentation-for-authorization"></a> ## Documentation For Authorization Authentication schemes defined for the API: <a id="bearerAuth"></a> ### bearerAuth - **Type**: Bearer authentication (JWT)