@tennac-booking/sdk 1.0.34 → 1.0.35

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.
@@ -0,0 +1,26 @@
1
+ # GenderPercentage
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **malePercentage** | **number** | Pourcentage d\'utilisateurs masculins | [optional] [default to undefined]
9
+ **femalePercentage** | **number** | Pourcentage d\'utilisateurs féminins | [optional] [default to undefined]
10
+ **otherPercentage** | **number** | Pourcentage d\'utilisateurs non spécifiés | [optional] [default to undefined]
11
+ **totalPlayers** | **number** | Nombre total de joueurs | [optional] [default to undefined]
12
+
13
+ ## Example
14
+
15
+ ```typescript
16
+ import { GenderPercentage } from '@tennac-booking/sdk';
17
+
18
+ const instance: GenderPercentage = {
19
+ malePercentage,
20
+ femalePercentage,
21
+ otherPercentage,
22
+ totalPlayers,
23
+ };
24
+ ```
25
+
26
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,32 @@
1
+ # Location
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **type** | **string** | | [default to undefined]
9
+ **coordinates** | **Array<number>** | Longitude et latitude | [default to undefined]
10
+ **city** | **string** | | [optional] [default to undefined]
11
+ **country** | **string** | | [optional] [default to undefined]
12
+ **postalCode** | **string** | | [optional] [default to undefined]
13
+ **state** | **string** | | [optional] [default to undefined]
14
+ **address** | **string** | | [optional] [default to undefined]
15
+
16
+ ## Example
17
+
18
+ ```typescript
19
+ import { Location } from '@tennac-booking/sdk';
20
+
21
+ const instance: Location = {
22
+ type,
23
+ coordinates,
24
+ city,
25
+ country,
26
+ postalCode,
27
+ state,
28
+ address,
29
+ };
30
+ ```
31
+
32
+ [[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/docs/Sport.md CHANGED
@@ -5,7 +5,6 @@
5
5
 
6
6
  Name | Type | Description | Notes
7
7
  ------------ | ------------- | ------------- | -------------
8
- **_id** | **string** | | [optional] [default to undefined]
9
8
  **key** | **string** | | [optional] [default to undefined]
10
9
  **clubId** | **string** | | [optional] [default to undefined]
11
10
 
@@ -15,7 +14,6 @@ Name | Type | Description | Notes
15
14
  import { Sport } from '@tennac-booking/sdk';
16
15
 
17
16
  const instance: Sport = {
18
- _id,
19
17
  key,
20
18
  clubId,
21
19
  };
@@ -5,11 +5,12 @@ All URIs are relative to *https://api.mon-domaine.com*
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
7
7
  |[**getClubPlayers**](#getclubplayers) | **GET** /api/analytics/players | Récupère la liste des joueurs du club (données staff uniquement)|
8
+ |[**getGenderPercentage**](#getgenderpercentage) | **GET** /api/analytics/gender | Récupère le pourcentage de joueurs par genre pour le club courant|
8
9
  |[**getLastSixMonthsTurnover**](#getlastsixmonthsturnover) | **GET** /api/analytics/lastSixMonthsTurnover | Get monthly turnover for the last six months (club courant)|
9
10
  |[**getNumberOfClubUsers**](#getnumberofclubusers) | **GET** /api/analytics/user-count | Get number of users subscribed to the club|
10
11
 
11
12
  # **getClubPlayers**
12
- > GetClubPlayers200Response getClubPlayers()
13
+ > Array<UserStaffResponse> getClubPlayers()
13
14
 
14
15
 
15
16
  ### Example
@@ -32,7 +33,7 @@ This endpoint does not have any parameters.
32
33
 
33
34
  ### Return type
34
35
 
35
- **GetClubPlayers200Response**
36
+ **Array<UserStaffResponse>**
36
37
 
37
38
  ### Authorization
38
39
 
@@ -52,6 +53,52 @@ This endpoint does not have any parameters.
52
53
 
53
54
  [[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)
54
55
 
56
+ # **getGenderPercentage**
57
+ > GenderPercentage getGenderPercentage()
58
+
59
+
60
+ ### Example
61
+
62
+ ```typescript
63
+ import {
64
+ StaffClubAnalyticsApi,
65
+ Configuration
66
+ } from '@tennac-booking/sdk';
67
+
68
+ const configuration = new Configuration();
69
+ const apiInstance = new StaffClubAnalyticsApi(configuration);
70
+
71
+ const { status, data } = await apiInstance.getGenderPercentage();
72
+ ```
73
+
74
+ ### Parameters
75
+ This endpoint does not have any parameters.
76
+
77
+
78
+ ### Return type
79
+
80
+ **GenderPercentage**
81
+
82
+ ### Authorization
83
+
84
+ [bearerAuth](../README.md#bearerAuth)
85
+
86
+ ### HTTP request headers
87
+
88
+ - **Content-Type**: Not defined
89
+ - **Accept**: application/json
90
+
91
+
92
+ ### HTTP response details
93
+ | Status code | Description | Response headers |
94
+ |-------------|-------------|------------------|
95
+ |**200** | Pourcentage de joueurs par genre | - |
96
+ |**401** | Non autorisé | - |
97
+ |**403** | Accès interdit | - |
98
+ |**500** | Erreur serveur interne | - |
99
+
100
+ [[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)
101
+
55
102
  # **getLastSixMonthsTurnover**
56
103
  > Array<GetLastSixMonthsTurnover200ResponseInner> getLastSixMonthsTurnover()
57
104
 
@@ -100,7 +100,7 @@ This endpoint does not have any parameters.
100
100
  [[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)
101
101
 
102
102
  # **getSports**
103
- > SportsResponse getSports()
103
+ > Array<SportResponse> getSports()
104
104
 
105
105
 
106
106
  ### Example
@@ -123,7 +123,7 @@ This endpoint does not have any parameters.
123
123
 
124
124
  ### Return type
125
125
 
126
- **SportsResponse**
126
+ **Array<SportResponse>**
127
127
 
128
128
  ### Authorization
129
129
 
@@ -7,7 +7,7 @@ All URIs are relative to *https://api.mon-domaine.com*
7
7
  |[**getSportsByClub**](#getsportsbyclub) | **GET** /api/clubs/{id}/sports | Récupérer tous les sports pour un club|
8
8
 
9
9
  # **getSportsByClub**
10
- > SportsResponse getSportsByClub()
10
+ > Array<Sport> getSportsByClub()
11
11
 
12
12
 
13
13
  ### Example
@@ -37,7 +37,7 @@ const { status, data } = await apiInstance.getSportsByClub(
37
37
 
38
38
  ### Return type
39
39
 
40
- **SportsResponse**
40
+ **Array<Sport>**
41
41
 
42
42
  ### Authorization
43
43
 
@@ -0,0 +1,243 @@
1
+ # UsersApi
2
+
3
+ All URIs are relative to *https://api.mon-domaine.com*
4
+
5
+ |Method | HTTP request | Description|
6
+ |------------- | ------------- | -------------|
7
+ |[**apiUsersMeNearestClubsGet**](#apiusersmenearestclubsget) | **GET** /api/users/me/nearest-clubs/ | Récupère les clubs proches de l’utilisateur connecté|
8
+ |[**apiUsersMeNearestPlayersGet**](#apiusersmenearestplayersget) | **GET** /api/users/me/nearest-players/ | Récupère les utilisateurs proches de l’utilisateur connecté|
9
+ |[**apiUsersNearestClubsCoordinatesGet**](#apiusersnearestclubscoordinatesget) | **GET** /api/users/nearest-clubs/coordinates | Récupère les clubs proches d’une position donnée|
10
+ |[**apiUsersNearestPlayersCoordinatesGet**](#apiusersnearestplayerscoordinatesget) | **GET** /api/users/nearest-players/coordinates | Récupère les utilisateurs proches d’une position donnée|
11
+
12
+ # **apiUsersMeNearestClubsGet**
13
+ > Array<Club> apiUsersMeNearestClubsGet()
14
+
15
+
16
+ ### Example
17
+
18
+ ```typescript
19
+ import {
20
+ UsersApi,
21
+ Configuration
22
+ } from '@tennac-booking/sdk';
23
+
24
+ const configuration = new Configuration();
25
+ const apiInstance = new UsersApi(configuration);
26
+
27
+ let radiusInKm: number; //Rayon de recherche en kilomètres (optional) (default to undefined)
28
+ let limit: number; //Nombre maximum de résultats (optional) (default to undefined)
29
+
30
+ const { status, data } = await apiInstance.apiUsersMeNearestClubsGet(
31
+ radiusInKm,
32
+ limit
33
+ );
34
+ ```
35
+
36
+ ### Parameters
37
+
38
+ |Name | Type | Description | Notes|
39
+ |------------- | ------------- | ------------- | -------------|
40
+ | **radiusInKm** | [**number**] | Rayon de recherche en kilomètres | (optional) defaults to undefined|
41
+ | **limit** | [**number**] | Nombre maximum de résultats | (optional) defaults to undefined|
42
+
43
+
44
+ ### Return type
45
+
46
+ **Array<Club>**
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** | Liste des clubs à proximité | - |
62
+ |**401** | Non autorisé | - |
63
+ |**500** | Erreur serveur interne | - |
64
+
65
+ [[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)
66
+
67
+ # **apiUsersMeNearestPlayersGet**
68
+ > Array<UserResponse> apiUsersMeNearestPlayersGet()
69
+
70
+
71
+ ### Example
72
+
73
+ ```typescript
74
+ import {
75
+ UsersApi,
76
+ Configuration
77
+ } from '@tennac-booking/sdk';
78
+
79
+ const configuration = new Configuration();
80
+ const apiInstance = new UsersApi(configuration);
81
+
82
+ let radiusInKm: number; //Rayon de recherche en kilomètres (optional) (default to undefined)
83
+ let limit: number; //Nombre maximum de résultats (optional) (default to undefined)
84
+
85
+ const { status, data } = await apiInstance.apiUsersMeNearestPlayersGet(
86
+ radiusInKm,
87
+ limit
88
+ );
89
+ ```
90
+
91
+ ### Parameters
92
+
93
+ |Name | Type | Description | Notes|
94
+ |------------- | ------------- | ------------- | -------------|
95
+ | **radiusInKm** | [**number**] | Rayon de recherche en kilomètres | (optional) defaults to undefined|
96
+ | **limit** | [**number**] | Nombre maximum de résultats | (optional) defaults to undefined|
97
+
98
+
99
+ ### Return type
100
+
101
+ **Array<UserResponse>**
102
+
103
+ ### Authorization
104
+
105
+ [bearerAuth](../README.md#bearerAuth)
106
+
107
+ ### HTTP request headers
108
+
109
+ - **Content-Type**: Not defined
110
+ - **Accept**: application/json
111
+
112
+
113
+ ### HTTP response details
114
+ | Status code | Description | Response headers |
115
+ |-------------|-------------|------------------|
116
+ |**200** | Liste des utilisateurs à proximité | - |
117
+ |**401** | Non autorisé | - |
118
+ |**500** | Erreur serveur interne | - |
119
+
120
+ [[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)
121
+
122
+ # **apiUsersNearestClubsCoordinatesGet**
123
+ > Array<Club> apiUsersNearestClubsCoordinatesGet()
124
+
125
+
126
+ ### Example
127
+
128
+ ```typescript
129
+ import {
130
+ UsersApi,
131
+ Configuration
132
+ } from '@tennac-booking/sdk';
133
+
134
+ const configuration = new Configuration();
135
+ const apiInstance = new UsersApi(configuration);
136
+
137
+ let latitude: number; //Latitude de la position (default to undefined)
138
+ let longitude: number; //Longitude de la position (default to undefined)
139
+ let radiusInKm: number; //Rayon de recherche en kilomètres (optional) (default to undefined)
140
+ let limit: number; //Nombre maximum de résultats (optional) (default to undefined)
141
+
142
+ const { status, data } = await apiInstance.apiUsersNearestClubsCoordinatesGet(
143
+ latitude,
144
+ longitude,
145
+ radiusInKm,
146
+ limit
147
+ );
148
+ ```
149
+
150
+ ### Parameters
151
+
152
+ |Name | Type | Description | Notes|
153
+ |------------- | ------------- | ------------- | -------------|
154
+ | **latitude** | [**number**] | Latitude de la position | defaults to undefined|
155
+ | **longitude** | [**number**] | Longitude de la position | defaults to undefined|
156
+ | **radiusInKm** | [**number**] | Rayon de recherche en kilomètres | (optional) defaults to undefined|
157
+ | **limit** | [**number**] | Nombre maximum de résultats | (optional) defaults to undefined|
158
+
159
+
160
+ ### Return type
161
+
162
+ **Array<Club>**
163
+
164
+ ### Authorization
165
+
166
+ [bearerAuth](../README.md#bearerAuth)
167
+
168
+ ### HTTP request headers
169
+
170
+ - **Content-Type**: Not defined
171
+ - **Accept**: application/json
172
+
173
+
174
+ ### HTTP response details
175
+ | Status code | Description | Response headers |
176
+ |-------------|-------------|------------------|
177
+ |**200** | Liste des clubs à proximité | - |
178
+ |**400** | Requête invalide | - |
179
+ |**500** | Erreur serveur interne | - |
180
+
181
+ [[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)
182
+
183
+ # **apiUsersNearestPlayersCoordinatesGet**
184
+ > Array<UserResponse> apiUsersNearestPlayersCoordinatesGet()
185
+
186
+
187
+ ### Example
188
+
189
+ ```typescript
190
+ import {
191
+ UsersApi,
192
+ Configuration
193
+ } from '@tennac-booking/sdk';
194
+
195
+ const configuration = new Configuration();
196
+ const apiInstance = new UsersApi(configuration);
197
+
198
+ let latitude: number; //Latitude de la position (default to undefined)
199
+ let longitude: number; //Longitude de la position (default to undefined)
200
+ let radiusInKm: number; //Rayon de recherche en kilomètres (optional) (default to undefined)
201
+ let limit: number; //Nombre maximum de résultats (optional) (default to undefined)
202
+
203
+ const { status, data } = await apiInstance.apiUsersNearestPlayersCoordinatesGet(
204
+ latitude,
205
+ longitude,
206
+ radiusInKm,
207
+ limit
208
+ );
209
+ ```
210
+
211
+ ### Parameters
212
+
213
+ |Name | Type | Description | Notes|
214
+ |------------- | ------------- | ------------- | -------------|
215
+ | **latitude** | [**number**] | Latitude de la position | defaults to undefined|
216
+ | **longitude** | [**number**] | Longitude de la position | defaults to undefined|
217
+ | **radiusInKm** | [**number**] | Rayon de recherche en kilomètres | (optional) defaults to undefined|
218
+ | **limit** | [**number**] | Nombre maximum de résultats | (optional) defaults to undefined|
219
+
220
+
221
+ ### Return type
222
+
223
+ **Array<UserResponse>**
224
+
225
+ ### Authorization
226
+
227
+ [bearerAuth](../README.md#bearerAuth)
228
+
229
+ ### HTTP request headers
230
+
231
+ - **Content-Type**: Not defined
232
+ - **Accept**: application/json
233
+
234
+
235
+ ### HTTP response details
236
+ | Status code | Description | Response headers |
237
+ |-------------|-------------|------------------|
238
+ |**200** | Liste des utilisateurs à proximité | - |
239
+ |**400** | Requête invalide | - |
240
+ |**500** | Erreur serveur interne | - |
241
+
242
+ [[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)
243
+
package/index.ts CHANGED
@@ -4,7 +4,7 @@
4
4
  * Pandook API
5
5
  * API for managing pickle ball games and players
6
6
  *
7
- * The version of the OpenAPI document: 1.0.34
7
+ * The version of the OpenAPI document: 1.0.35
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.34",
3
+ "version": "1.0.35",
4
4
  "description": "OpenAPI client for @tennac-booking/sdk",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {
@@ -1,22 +0,0 @@
1
- # GetClubPlayers200Response
2
-
3
-
4
- ## Properties
5
-
6
- Name | Type | Description | Notes
7
- ------------ | ------------- | ------------- | -------------
8
- **clubPlayers** | [**Array&lt;UserStaffResponse&gt;**](UserStaffResponse.md) | | [optional] [default to undefined]
9
- **total** | **number** | | [optional] [default to undefined]
10
-
11
- ## Example
12
-
13
- ```typescript
14
- import { GetClubPlayers200Response } from '@tennac-booking/sdk';
15
-
16
- const instance: GetClubPlayers200Response = {
17
- clubPlayers,
18
- total,
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,22 +0,0 @@
1
- # SportsResponse
2
-
3
-
4
- ## Properties
5
-
6
- Name | Type | Description | Notes
7
- ------------ | ------------- | ------------- | -------------
8
- **sports** | [**Array&lt;SportResponse&gt;**](SportResponse.md) | | [optional] [default to undefined]
9
- **total** | **number** | | [optional] [default to undefined]
10
-
11
- ## Example
12
-
13
- ```typescript
14
- import { SportsResponse } from '@tennac-booking/sdk';
15
-
16
- const instance: SportsResponse = {
17
- sports,
18
- total,
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)