@tennac-booking/sdk 1.0.116 → 1.0.117

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (170) hide show
  1. package/.openapi-generator/FILES +3 -0
  2. package/README.md +5 -2
  3. package/api.ts +211 -1
  4. package/base.ts +1 -1
  5. package/common.ts +1 -1
  6. package/configuration.ts +1 -1
  7. package/dist/api.d.ts +173 -1
  8. package/dist/api.js +68 -1
  9. package/dist/base.d.ts +1 -1
  10. package/dist/base.js +1 -1
  11. package/dist/common.d.ts +1 -1
  12. package/dist/common.js +1 -1
  13. package/dist/configuration.d.ts +1 -1
  14. package/dist/configuration.js +1 -1
  15. package/dist/esm/api.d.ts +173 -1
  16. package/dist/esm/api.js +68 -1
  17. package/dist/esm/base.d.ts +1 -1
  18. package/dist/esm/base.js +1 -1
  19. package/dist/esm/common.d.ts +1 -1
  20. package/dist/esm/common.js +1 -1
  21. package/dist/esm/configuration.d.ts +1 -1
  22. package/dist/esm/configuration.js +1 -1
  23. package/dist/esm/index.d.ts +1 -1
  24. package/dist/esm/index.js +1 -1
  25. package/dist/index.d.ts +1 -1
  26. package/dist/index.js +1 -1
  27. package/docs/{DeleteClubRole200Response.md → CheckTeamNameAvailability200Response.md} +5 -5
  28. package/docs/EstimateEventPrice200Response.md +6 -0
  29. package/docs/EstimateEventPriceRequest.md +4 -0
  30. package/docs/EventsApi.md +57 -0
  31. package/docs/JoinEventRequest.md +2 -0
  32. package/docs/JoinEventResponse.md +14 -0
  33. package/docs/JoinEventResponseOnsitePaymentsInner.md +24 -0
  34. package/index.ts +1 -1
  35. package/package.json +1 -1
  36. package/docs/ActiveClub.md +0 -24
  37. package/docs/ActiveClubListResponse.md +0 -20
  38. package/docs/AddClubMemberResponse.md +0 -22
  39. package/docs/AddFavoriteClubRequestBody.md +0 -20
  40. package/docs/AddFavoritePlayerRequestBody.md +0 -20
  41. package/docs/AddPaymentMethodSetupRequestBody.md +0 -20
  42. package/docs/AddPaymentMethodSetupResponse.md +0 -24
  43. package/docs/AdminClubAnalyticsApi.md +0 -249
  44. package/docs/AdminClubSlotsApi.md +0 -182
  45. package/docs/AdminClubSubscriptionsApi.md +0 -394
  46. package/docs/AdminClubsApi.md +0 -170
  47. package/docs/ApiErrorResponse.md +0 -22
  48. package/docs/BlockSlotResponse.md +0 -22
  49. package/docs/Booking.md +0 -32
  50. package/docs/BookingPaymentStatusResponsePaymentStatusInner.md +0 -36
  51. package/docs/BookingPopulatedPaymentByPlayersStatusInner.md +0 -22
  52. package/docs/BookingPopulatedPaymentByPlayersStatusInnerInvoicesInner.md +0 -24
  53. package/docs/BookingPopulatedSlotId.md +0 -26
  54. package/docs/BookingPopulatedSlotIdCourtId.md +0 -22
  55. package/docs/BookingPopulatedUserId.md +0 -24
  56. package/docs/CancelBookingResponseBooking.md +0 -30
  57. package/docs/CheckInPlayersResponseCheckedInPlayersInner.md +0 -34
  58. package/docs/Club.md +0 -46
  59. package/docs/ClubInfoResponse.md +0 -48
  60. package/docs/ClubListResponse.md +0 -22
  61. package/docs/ClubMember.md +0 -34
  62. package/docs/ClubMembersResponse.md +0 -22
  63. package/docs/ClubRole.md +0 -30
  64. package/docs/ClubRolesResponse.md +0 -22
  65. package/docs/ClubSettings.md +0 -40
  66. package/docs/ClubsResponse.md +0 -22
  67. package/docs/ConfirmPaymentMethodSetupRequestBody.md +0 -20
  68. package/docs/ConfirmPaymentMethodSetupResponse.md +0 -22
  69. package/docs/Court.md +0 -32
  70. package/docs/CourtsResponse.md +0 -22
  71. package/docs/CreateClubRoleRequestBody.md +0 -24
  72. package/docs/CreateClubSettingsRequest.md +0 -28
  73. package/docs/CreatePriceRequest.md +0 -26
  74. package/docs/DeleteClub200Response.md +0 -20
  75. package/docs/DeleteClubSettingsRequest.md +0 -20
  76. package/docs/DeleteEvent200Response.md +0 -20
  77. package/docs/DeleteSlotsByClubInRange200Response.md +0 -20
  78. package/docs/DeleteSlotsResponse.md +0 -20
  79. package/docs/DeleteSport200Response.md +0 -20
  80. package/docs/Event.md +0 -40
  81. package/docs/EventBooking.md +0 -32
  82. package/docs/EventRegistrationRequest.md +0 -22
  83. package/docs/FavoriteClubItem.md +0 -26
  84. package/docs/FavoriteClubResponse.md +0 -22
  85. package/docs/FavoritePlayerPublic.md +0 -28
  86. package/docs/FavoritePlayersIdsResponse.md +0 -22
  87. package/docs/FrequentlyPlayedWithItem.md +0 -28
  88. package/docs/FrequentlyVisitedClubItem.md +0 -24
  89. package/docs/GenerateSlotsResponse.md +0 -20
  90. package/docs/GetActiveClubs200Response.md +0 -20
  91. package/docs/GetClubInfos200Response.md +0 -30
  92. package/docs/GetCourtsByClubAndSport200Response.md +0 -26
  93. package/docs/GetLastSixMonthsTurnover200ResponseInner.md +0 -22
  94. package/docs/GetNumberOfClubUsers200Response.md +0 -20
  95. package/docs/GetPublishedEventsByClubId200Response.md +0 -20
  96. package/docs/GetUserRolesResponse.md +0 -20
  97. package/docs/GetUserRolesResponseRolesInner.md +0 -26
  98. package/docs/GetUserSubscriptionsResponse.md +0 -22
  99. package/docs/GoogleSignInRequestBody.md +0 -20
  100. package/docs/GoogleSignInResponse.md +0 -24
  101. package/docs/InitiateSubscriptionSessionRequestBody.md +0 -26
  102. package/docs/InitiateSubscriptionSessionResponse.md +0 -22
  103. package/docs/InvoicesResponse.md +0 -22
  104. package/docs/InvoicesResponseInvoicesInner.md +0 -34
  105. package/docs/InvoicesResponsePagination.md +0 -26
  106. package/docs/LevelBySportsItem.md +0 -22
  107. package/docs/ManagerBookingsApi.md +0 -125
  108. package/docs/ManagerCancelBookingResponseBooking.md +0 -30
  109. package/docs/ManagerClubCourtsApi.md +0 -108
  110. package/docs/ManagerClubRolesApi.md +0 -268
  111. package/docs/ManagerClubSlotsApi.md +0 -119
  112. package/docs/ManagerClubSubscriptionsApi.md +0 -387
  113. package/docs/ManagerClubsApi.md +0 -253
  114. package/docs/ManagerEventResponse.md +0 -22
  115. package/docs/ManagerEventsApi.md +0 -227
  116. package/docs/ManagerSportsApi.md +0 -174
  117. package/docs/NoShowFeeResponseCaptureResultsInner.md +0 -30
  118. package/docs/NoShowFeeResponseCreatorChargeResult.md +0 -26
  119. package/docs/PriceResponse.md +0 -32
  120. package/docs/ProfileVisibilityResponse.md +0 -20
  121. package/docs/PublicClubUser.md +0 -46
  122. package/docs/PublicClubUserFrequentlyPlayedWithInner.md +0 -28
  123. package/docs/PublicClubUserFrequentlyVisitedClubsInner.md +0 -24
  124. package/docs/PublicClubUserLevelBySportsInner.md +0 -22
  125. package/docs/RegisterForEvent201Response.md +0 -20
  126. package/docs/RestoreSubscriptionPlanForClub200Response.md +0 -20
  127. package/docs/SetupPaymentMethodRequestBody.md +0 -20
  128. package/docs/SetupPaymentMethodResponse.md +0 -24
  129. package/docs/Slot.md +0 -24
  130. package/docs/SlotException.md +0 -26
  131. package/docs/SlotResponse.md +0 -34
  132. package/docs/SlotsResponse.md +0 -22
  133. package/docs/Sport.md +0 -24
  134. package/docs/SportsResponse.md +0 -22
  135. package/docs/StaffClubAnalyticsApi.md +0 -104
  136. package/docs/StaffClubBookingsApi.md +0 -52
  137. package/docs/StaffClubsApi.md +0 -100
  138. package/docs/StaffEventResponse.md +0 -20
  139. package/docs/StaffEventsApi.md +0 -54
  140. package/docs/StaffProfileApi.md +0 -54
  141. package/docs/StripeStatus.md +0 -16
  142. package/docs/SubscribeToClubRequestBody.md +0 -22
  143. package/docs/SubscriptionPlan.md +0 -36
  144. package/docs/SubscriptionResponse.md +0 -36
  145. package/docs/UpdateClubRoleRequestBody.md +0 -24
  146. package/docs/UpdateClubSettingsRequest.md +0 -28
  147. package/docs/UpdateCustomerRequestBodyAddress.md +0 -30
  148. package/docs/UpdateCustomerResponseCustomer.md +0 -28
  149. package/docs/UpdateProfilePictureRequestBody.md +0 -20
  150. package/docs/UpdateProfileVisibilityRequestBody.md +0 -20
  151. package/docs/UpdateSubscriptionPlanRequest.md +0 -24
  152. package/docs/UpdateSubscriptionPlanResponse.md +0 -22
  153. package/docs/UpdateUserCityRequestBody.md +0 -20
  154. package/docs/UpdateUserDescriptionRequestBody.md +0 -20
  155. package/docs/User.md +0 -40
  156. package/docs/UserAuthenticationApi.md +0 -226
  157. package/docs/UserBookingsApi.md +0 -120
  158. package/docs/UserCityResponse.md +0 -20
  159. package/docs/UserClubCourtsApi.md +0 -64
  160. package/docs/UserClubSlotsApi.md +0 -181
  161. package/docs/UserClubSportsApi.md +0 -60
  162. package/docs/UserClubsApi.md +0 -53
  163. package/docs/UserDescriptionResponse.md +0 -20
  164. package/docs/UserFavoriteClubsResponse.md +0 -20
  165. package/docs/UserPaymentApi.md +0 -176
  166. package/docs/UserProfileApi.md +0 -1201
  167. package/docs/UserResponse.md +0 -38
  168. package/docs/UserSubscriptionsApi.md +0 -222
  169. package/docs/UsersResponse.md +0 -22
  170. package/docs/YearlyTurnoverResponseMonthlyBreakdownInner.md +0 -24
@@ -5,6 +5,8 @@
5
5
 
6
6
  Name | Type | Description | Notes
7
7
  ------------ | ------------- | ------------- | -------------
8
+ **creditToUseInCents** | **number** | | [optional] [default to undefined]
9
+ **creatorId** | **string** | | [optional] [default to undefined]
8
10
  **shares** | [**Array<EstimateEventPriceRequestSharesInner>**](EstimateEventPriceRequestSharesInner.md) | | [optional] [default to undefined]
9
11
  **playerIds** | **Array<string>** | | [default to undefined]
10
12
 
@@ -14,6 +16,8 @@ Name | Type | Description | Notes
14
16
  import { EstimateEventPriceRequest } from '@tennac-booking/sdk';
15
17
 
16
18
  const instance: EstimateEventPriceRequest = {
19
+ creditToUseInCents,
20
+ creatorId,
17
21
  shares,
18
22
  playerIds,
19
23
  };
package/docs/EventsApi.md CHANGED
@@ -4,12 +4,69 @@ All URIs are relative to *http://localhost*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
7
+ |[**checkTeamNameAvailability**](#checkteamnameavailability) | **GET** /api/events/{eventId}/team-name-availability | |
7
8
  |[**estimateEventPrice**](#estimateeventprice) | **POST** /api/events/{eventId}/estimate-price | |
8
9
  |[**getEventById**](#geteventbyid) | **GET** /api/events/{eventId} | |
9
10
  |[**getPublishedEventsByClubId**](#getpublishedeventsbyclubid) | **GET** /api/events | |
10
11
  |[**joinEvent**](#joinevent) | **POST** /api/events/{eventId}/join | |
11
12
  |[**leaveEvent**](#leaveevent) | **DELETE** /api/events/{eventId}/leave | |
12
13
 
14
+ # **checkTeamNameAvailability**
15
+ > CheckTeamNameAvailability200Response checkTeamNameAvailability()
16
+
17
+ Check team name availability for TEAM participation events
18
+
19
+ ### Example
20
+
21
+ ```typescript
22
+ import {
23
+ EventsApi,
24
+ Configuration
25
+ } from '@tennac-booking/sdk';
26
+
27
+ const configuration = new Configuration();
28
+ const apiInstance = new EventsApi(configuration);
29
+
30
+ let eventId: string; // (default to undefined)
31
+ let teamName: string; // (optional) (default to undefined)
32
+
33
+ const { status, data } = await apiInstance.checkTeamNameAvailability(
34
+ eventId,
35
+ teamName
36
+ );
37
+ ```
38
+
39
+ ### Parameters
40
+
41
+ |Name | Type | Description | Notes|
42
+ |------------- | ------------- | ------------- | -------------|
43
+ | **eventId** | [**string**] | | defaults to undefined|
44
+ | **teamName** | [**string**] | | (optional) defaults to undefined|
45
+
46
+
47
+ ### Return type
48
+
49
+ **CheckTeamNameAvailability200Response**
50
+
51
+ ### Authorization
52
+
53
+ No authorization required
54
+
55
+ ### HTTP request headers
56
+
57
+ - **Content-Type**: Not defined
58
+ - **Accept**: application/json
59
+
60
+
61
+ ### HTTP response details
62
+ | Status code | Description | Response headers |
63
+ |-------------|-------------|------------------|
64
+ |**200** | Team name availability | - |
65
+ |**400** | Bad Request | - |
66
+ |**404** | Not Found | - |
67
+
68
+ [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
69
+
13
70
  # **estimateEventPrice**
14
71
  > EstimateEventPrice200Response estimateEventPrice(estimateEventPriceRequest)
15
72
 
@@ -11,6 +11,7 @@ Name | Type | Description | Notes
11
11
  **paymentMethod** | [**PaymentMethod**](PaymentMethod.md) | | [optional] [default to undefined]
12
12
  **playersPaymentMethods** | [**Array<JoinEventRequestPlayersPaymentMethodsInner>**](JoinEventRequestPlayersPaymentMethodsInner.md) | | [optional] [default to undefined]
13
13
  **useDefaultPaymentMethod** | **boolean** | | [optional] [default to undefined]
14
+ **creditToUseInCents** | **number** | | [optional] [default to undefined]
14
15
 
15
16
  ## Example
16
17
 
@@ -24,6 +25,7 @@ const instance: JoinEventRequest = {
24
25
  paymentMethod,
25
26
  playersPaymentMethods,
26
27
  useDefaultPaymentMethod,
28
+ creditToUseInCents,
27
29
  };
28
30
  ```
29
31
 
@@ -7,6 +7,13 @@ Name | Type | Description | Notes
7
7
  ------------ | ------------- | ------------- | -------------
8
8
  **message** | **string** | | [default to undefined]
9
9
  **event** | [**EventResponse**](EventResponse.md) | | [default to undefined]
10
+ **paymentLinks** | **{ [key: string]: string; }** | Construct a type with a set of properties K of type T | [optional] [default to undefined]
11
+ **onsitePayments** | [**Array<JoinEventResponseOnsitePaymentsInner>**](JoinEventResponseOnsitePaymentsInner.md) | | [optional] [default to undefined]
12
+ **setupNoShowPaymentUrl** | **string** | | [optional] [default to undefined]
13
+ **invoices** | [**Array<CheckInEventParticipants200ResponseInvoicesInner>**](CheckInEventParticipants200ResponseInvoicesInner.md) | | [optional] [default to undefined]
14
+ **creditsAppliedInCents** | **number** | | [optional] [default to undefined]
15
+ **totalAfterCredits** | **number** | | [optional] [default to undefined]
16
+ **perPayerAfterCredits** | **{ [key: string]: number; }** | Construct a type with a set of properties K of type T | [optional] [default to undefined]
10
17
 
11
18
  ## Example
12
19
 
@@ -16,6 +23,13 @@ import { JoinEventResponse } from '@tennac-booking/sdk';
16
23
  const instance: JoinEventResponse = {
17
24
  message,
18
25
  event,
26
+ paymentLinks,
27
+ onsitePayments,
28
+ setupNoShowPaymentUrl,
29
+ invoices,
30
+ creditsAppliedInCents,
31
+ totalAfterCredits,
32
+ perPayerAfterCredits,
19
33
  };
20
34
  ```
21
35
 
@@ -0,0 +1,24 @@
1
+ # JoinEventResponseOnsitePaymentsInner
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **paymentMethod** | [**PaymentMethod**](PaymentMethod.md) | | [default to undefined]
9
+ **amount** | **number** | | [default to undefined]
10
+ **playerId** | **string** | | [default to undefined]
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import { JoinEventResponseOnsitePaymentsInner } from '@tennac-booking/sdk';
16
+
17
+ const instance: JoinEventResponseOnsitePaymentsInner = {
18
+ paymentMethod,
19
+ amount,
20
+ playerId,
21
+ };
22
+ ```
23
+
24
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
package/index.ts CHANGED
@@ -4,7 +4,7 @@
4
4
  * openapi.json
5
5
  * Pandook API Documentation
6
6
  *
7
- * The version of the OpenAPI document: 1.0.116
7
+ * The version of the OpenAPI document: 1.0.117
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@tennac-booking/sdk",
3
- "version": "1.0.116",
3
+ "version": "1.0.117",
4
4
  "description": "OpenAPI client for @tennac-booking/sdk",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {
@@ -1,24 +0,0 @@
1
- # ActiveClub
2
-
3
-
4
- ## Properties
5
-
6
- Name | Type | Description | Notes
7
- ------------ | ------------- | ------------- | -------------
8
- **_id** | **string** | | [optional] [default to undefined]
9
- **name** | **string** | | [optional] [default to undefined]
10
- **paymentFeature** | **boolean** | | [optional] [default to undefined]
11
-
12
- ## Example
13
-
14
- ```typescript
15
- import { ActiveClub } from '@tennac-booking/sdk';
16
-
17
- const instance: ActiveClub = {
18
- _id,
19
- name,
20
- paymentFeature,
21
- };
22
- ```
23
-
24
- [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -1,20 +0,0 @@
1
- # ActiveClubListResponse
2
-
3
-
4
- ## Properties
5
-
6
- Name | Type | Description | Notes
7
- ------------ | ------------- | ------------- | -------------
8
- **clubs** | [**Array<ActiveClub>**](ActiveClub.md) | | [optional] [default to undefined]
9
-
10
- ## Example
11
-
12
- ```typescript
13
- import { ActiveClubListResponse } from '@tennac-booking/sdk';
14
-
15
- const instance: ActiveClubListResponse = {
16
- clubs,
17
- };
18
- ```
19
-
20
- [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -1,22 +0,0 @@
1
- # AddClubMemberResponse
2
-
3
-
4
- ## Properties
5
-
6
- Name | Type | Description | Notes
7
- ------------ | ------------- | ------------- | -------------
8
- **message** | **string** | | [optional] [default to undefined]
9
- **member** | [**ClubMember**](ClubMember.md) | | [optional] [default to undefined]
10
-
11
- ## Example
12
-
13
- ```typescript
14
- import { AddClubMemberResponse } from '@tennac-booking/sdk';
15
-
16
- const instance: AddClubMemberResponse = {
17
- message,
18
- member,
19
- };
20
- ```
21
-
22
- [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -1,20 +0,0 @@
1
- # AddFavoriteClubRequestBody
2
-
3
-
4
- ## Properties
5
-
6
- Name | Type | Description | Notes
7
- ------------ | ------------- | ------------- | -------------
8
- **clubId** | **string** | ID du club à ajouter aux favoris | [default to undefined]
9
-
10
- ## Example
11
-
12
- ```typescript
13
- import { AddFavoriteClubRequestBody } from '@tennac-booking/sdk';
14
-
15
- const instance: AddFavoriteClubRequestBody = {
16
- clubId,
17
- };
18
- ```
19
-
20
- [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -1,20 +0,0 @@
1
- # AddFavoritePlayerRequestBody
2
-
3
-
4
- ## Properties
5
-
6
- Name | Type | Description | Notes
7
- ------------ | ------------- | ------------- | -------------
8
- **favoritePlayerId** | **string** | ID de l\'utilisateur à ajouter en favori | [default to undefined]
9
-
10
- ## Example
11
-
12
- ```typescript
13
- import { AddFavoritePlayerRequestBody } from '@tennac-booking/sdk';
14
-
15
- const instance: AddFavoritePlayerRequestBody = {
16
- favoritePlayerId,
17
- };
18
- ```
19
-
20
- [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -1,20 +0,0 @@
1
- # AddPaymentMethodSetupRequestBody
2
-
3
-
4
- ## Properties
5
-
6
- Name | Type | Description | Notes
7
- ------------ | ------------- | ------------- | -------------
8
- **paymentMethodId** | **string** | ID Stripe du moyen de paiement à ajouter | [default to undefined]
9
-
10
- ## Example
11
-
12
- ```typescript
13
- import { AddPaymentMethodSetupRequestBody } from '@tennac-booking/sdk';
14
-
15
- const instance: AddPaymentMethodSetupRequestBody = {
16
- paymentMethodId,
17
- };
18
- ```
19
-
20
- [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -1,24 +0,0 @@
1
- # AddPaymentMethodSetupResponse
2
-
3
-
4
- ## Properties
5
-
6
- Name | Type | Description | Notes
7
- ------------ | ------------- | ------------- | -------------
8
- **message** | **string** | | [optional] [default to undefined]
9
- **paymentMethods** | **Array<string>** | | [optional] [default to undefined]
10
- **defaultPaymentMethodId** | **string** | | [optional] [default to undefined]
11
-
12
- ## Example
13
-
14
- ```typescript
15
- import { AddPaymentMethodSetupResponse } from '@tennac-booking/sdk';
16
-
17
- const instance: AddPaymentMethodSetupResponse = {
18
- message,
19
- paymentMethods,
20
- defaultPaymentMethodId,
21
- };
22
- ```
23
-
24
- [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -1,249 +0,0 @@
1
- # AdminClubAnalyticsApi
2
-
3
- All URIs are relative to *https://api.mon-domaine.com*
4
-
5
- |Method | HTTP request | Description|
6
- |------------- | ------------- | -------------|
7
- |[**getDailyTurnOverAdmin**](#getdailyturnoveradmin) | **GET** /api/clubs/{id}/turnover/daily | Chiffre d\'affaires quotidien (Admin)|
8
- |[**getInvoicesAdmin**](#getinvoicesadmin) | **GET** /api/clubs/{id}/invoices | Récupérer les factures d\'un club (Admin)|
9
- |[**getMonthlyTurnOverAdmin**](#getmonthlyturnoveradmin) | **GET** /api/clubs/{id}/turnover/monthly | Chiffre d\'affaires mensuel (Admin)|
10
- |[**getYearlyTurnOverAdmin**](#getyearlyturnoveradmin) | **GET** /api/clubs/{id}/turnover/yearly | Chiffre d\'affaires annuel (Admin)|
11
-
12
- # **getDailyTurnOverAdmin**
13
- > DailyTurnoverResponse getDailyTurnOverAdmin()
14
-
15
-
16
- ### Example
17
-
18
- ```typescript
19
- import {
20
- AdminClubAnalyticsApi,
21
- Configuration
22
- } from '@tennac-booking/sdk';
23
-
24
- const configuration = new Configuration();
25
- const apiInstance = new AdminClubAnalyticsApi(configuration);
26
-
27
- let id: string; //ID du club (default to undefined)
28
- let date: string; //Date (YYYY-MM-DD) (default to undefined)
29
-
30
- const { status, data } = await apiInstance.getDailyTurnOverAdmin(
31
- id,
32
- date
33
- );
34
- ```
35
-
36
- ### Parameters
37
-
38
- |Name | Type | Description | Notes|
39
- |------------- | ------------- | ------------- | -------------|
40
- | **id** | [**string**] | ID du club | defaults to undefined|
41
- | **date** | [**string**] | Date (YYYY-MM-DD) | defaults to undefined|
42
-
43
-
44
- ### Return type
45
-
46
- **DailyTurnoverResponse**
47
-
48
- ### Authorization
49
-
50
- [bearerAuth](../README.md#bearerAuth)
51
-
52
- ### HTTP request headers
53
-
54
- - **Content-Type**: Not defined
55
- - **Accept**: application/json
56
-
57
-
58
- ### HTTP response details
59
- | Status code | Description | Response headers |
60
- |-------------|-------------|------------------|
61
- |**200** | Chiffre d\'affaires quotidien | - |
62
- |**400** | Requête invalide | - |
63
- |**401** | Non autorisé | - |
64
- |**500** | Erreur serveur interne | - |
65
-
66
- [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
67
-
68
- # **getInvoicesAdmin**
69
- > InvoicesResponse getInvoicesAdmin()
70
-
71
-
72
- ### Example
73
-
74
- ```typescript
75
- import {
76
- AdminClubAnalyticsApi,
77
- Configuration
78
- } from '@tennac-booking/sdk';
79
-
80
- const configuration = new Configuration();
81
- const apiInstance = new AdminClubAnalyticsApi(configuration);
82
-
83
- let id: string; //ID du club (default to undefined)
84
- let page: number; // (optional) (default to 1)
85
- let limit: number; // (optional) (default to 10)
86
- let status: 'pending' | 'paid' | 'failed' | 'authorized' | 'canceled' | 'expired'; // (optional) (default to undefined)
87
- let startDate: string; // (optional) (default to undefined)
88
- let endDate: string; // (optional) (default to undefined)
89
-
90
- const { status, data } = await apiInstance.getInvoicesAdmin(
91
- id,
92
- page,
93
- limit,
94
- status,
95
- startDate,
96
- endDate
97
- );
98
- ```
99
-
100
- ### Parameters
101
-
102
- |Name | Type | Description | Notes|
103
- |------------- | ------------- | ------------- | -------------|
104
- | **id** | [**string**] | ID du club | defaults to undefined|
105
- | **page** | [**number**] | | (optional) defaults to 1|
106
- | **limit** | [**number**] | | (optional) defaults to 10|
107
- | **status** | [**&#39;pending&#39; | &#39;paid&#39; | &#39;failed&#39; | &#39;authorized&#39; | &#39;canceled&#39; | &#39;expired&#39;**]**Array<&#39;pending&#39; &#124; &#39;paid&#39; &#124; &#39;failed&#39; &#124; &#39;authorized&#39; &#124; &#39;canceled&#39; &#124; &#39;expired&#39;>** | | (optional) defaults to undefined|
108
- | **startDate** | [**string**] | | (optional) defaults to undefined|
109
- | **endDate** | [**string**] | | (optional) defaults to undefined|
110
-
111
-
112
- ### Return type
113
-
114
- **InvoicesResponse**
115
-
116
- ### Authorization
117
-
118
- [bearerAuth](../README.md#bearerAuth)
119
-
120
- ### HTTP request headers
121
-
122
- - **Content-Type**: Not defined
123
- - **Accept**: application/json
124
-
125
-
126
- ### HTTP response details
127
- | Status code | Description | Response headers |
128
- |-------------|-------------|------------------|
129
- |**200** | Liste des factures | - |
130
- |**401** | Non autorisé | - |
131
- |**500** | Erreur serveur interne | - |
132
-
133
- [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
134
-
135
- # **getMonthlyTurnOverAdmin**
136
- > MonthlyTurnoverResponse getMonthlyTurnOverAdmin()
137
-
138
-
139
- ### Example
140
-
141
- ```typescript
142
- import {
143
- AdminClubAnalyticsApi,
144
- Configuration
145
- } from '@tennac-booking/sdk';
146
-
147
- const configuration = new Configuration();
148
- const apiInstance = new AdminClubAnalyticsApi(configuration);
149
-
150
- let id: string; //ID du club (default to undefined)
151
- let year: number; //Année (default to undefined)
152
- let month: number; //Mois (1-12) (default to undefined)
153
-
154
- const { status, data } = await apiInstance.getMonthlyTurnOverAdmin(
155
- id,
156
- year,
157
- month
158
- );
159
- ```
160
-
161
- ### Parameters
162
-
163
- |Name | Type | Description | Notes|
164
- |------------- | ------------- | ------------- | -------------|
165
- | **id** | [**string**] | ID du club | defaults to undefined|
166
- | **year** | [**number**] | Année | defaults to undefined|
167
- | **month** | [**number**] | Mois (1-12) | defaults to undefined|
168
-
169
-
170
- ### Return type
171
-
172
- **MonthlyTurnoverResponse**
173
-
174
- ### Authorization
175
-
176
- [bearerAuth](../README.md#bearerAuth)
177
-
178
- ### HTTP request headers
179
-
180
- - **Content-Type**: Not defined
181
- - **Accept**: application/json
182
-
183
-
184
- ### HTTP response details
185
- | Status code | Description | Response headers |
186
- |-------------|-------------|------------------|
187
- |**200** | Chiffre d\&#39;affaires mensuel | - |
188
- |**400** | Requête invalide | - |
189
- |**401** | Non autorisé | - |
190
- |**500** | Erreur serveur interne | - |
191
-
192
- [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
193
-
194
- # **getYearlyTurnOverAdmin**
195
- > YearlyTurnoverResponse getYearlyTurnOverAdmin()
196
-
197
-
198
- ### Example
199
-
200
- ```typescript
201
- import {
202
- AdminClubAnalyticsApi,
203
- Configuration
204
- } from '@tennac-booking/sdk';
205
-
206
- const configuration = new Configuration();
207
- const apiInstance = new AdminClubAnalyticsApi(configuration);
208
-
209
- let id: string; //ID du club (default to undefined)
210
- let year: number; //Année (default to undefined)
211
-
212
- const { status, data } = await apiInstance.getYearlyTurnOverAdmin(
213
- id,
214
- year
215
- );
216
- ```
217
-
218
- ### Parameters
219
-
220
- |Name | Type | Description | Notes|
221
- |------------- | ------------- | ------------- | -------------|
222
- | **id** | [**string**] | ID du club | defaults to undefined|
223
- | **year** | [**number**] | Année | defaults to undefined|
224
-
225
-
226
- ### Return type
227
-
228
- **YearlyTurnoverResponse**
229
-
230
- ### Authorization
231
-
232
- [bearerAuth](../README.md#bearerAuth)
233
-
234
- ### HTTP request headers
235
-
236
- - **Content-Type**: Not defined
237
- - **Accept**: application/json
238
-
239
-
240
- ### HTTP response details
241
- | Status code | Description | Response headers |
242
- |-------------|-------------|------------------|
243
- |**200** | Chiffre d\&#39;affaires annuel | - |
244
- |**400** | Requête invalide | - |
245
- |**401** | Non autorisé | - |
246
- |**500** | Erreur serveur interne | - |
247
-
248
- [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
249
-