@tennac-booking/sdk 1.0.234 → 1.0.236
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.
- package/.openapi-generator/FILES +6 -0
- package/README.md +9 -0
- package/api.ts +464 -0
- package/dist/api.d.ts +355 -0
- package/dist/api.js +184 -0
- package/dist/esm/api.d.ts +355 -0
- package/dist/esm/api.js +184 -0
- package/docs/AcceptBookingInvitationResponse.md +2 -0
- package/docs/ClubAnalyticsStaffApi.md +47 -0
- package/docs/ClubNewSubscriberItem.md +34 -0
- package/docs/ClubNewSubscribersListResponse.md +26 -0
- package/docs/MigrateSubscription200Response.md +22 -0
- package/docs/MigrateSubscriptionRequest.md +26 -0
- package/docs/MigrateUser200Response.md +24 -0
- package/docs/MigrateUserRequest.md +40 -0
- package/docs/UsersApi.md +106 -0
- package/package.json +1 -1
|
@@ -20,6 +20,7 @@ All URIs are relative to *http://localhost*
|
|
|
20
20
|
|[**getMonthlyTurnOver**](#getmonthlyturnover) | **GET** /api/club-analytics/monthly-turnover | |
|
|
21
21
|
|[**getNewBookingsCount**](#getnewbookingscount) | **GET** /api/club-analytics/bookings/new | |
|
|
22
22
|
|[**getNewSubscribersCount**](#getnewsubscriberscount) | **GET** /api/club-analytics/subscribers/new | |
|
|
23
|
+
|[**getNewSubscribersList**](#getnewsubscriberslist) | **GET** /api/club-analytics/subscribers/new/list | |
|
|
23
24
|
|[**getNoShowRate**](#getnoshowrate) | **GET** /api/club-analytics/bookings/no-show-rate | |
|
|
24
25
|
|[**getNumberOfClubUsers**](#getnumberofclubusers) | **GET** /api/club-analytics/users-count | |
|
|
25
26
|
|[**getRetentionRate**](#getretentionrate) | **GET** /api/club-analytics/retention-rate | |
|
|
@@ -887,6 +888,52 @@ const { status, data } = await apiInstance.getNewSubscribersCount(
|
|
|
887
888
|
|
|
888
889
|
[[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)
|
|
889
890
|
|
|
891
|
+
# **getNewSubscribersList**
|
|
892
|
+
> ClubNewSubscribersListResponse getNewSubscribersList()
|
|
893
|
+
|
|
894
|
+
Liste des nouveaux abonnés (30 derniers jours)
|
|
895
|
+
|
|
896
|
+
### Example
|
|
897
|
+
|
|
898
|
+
```typescript
|
|
899
|
+
import {
|
|
900
|
+
ClubAnalyticsStaffApi,
|
|
901
|
+
Configuration
|
|
902
|
+
} from '@tennac-booking/sdk';
|
|
903
|
+
|
|
904
|
+
const configuration = new Configuration();
|
|
905
|
+
const apiInstance = new ClubAnalyticsStaffApi(configuration);
|
|
906
|
+
|
|
907
|
+
const { status, data } = await apiInstance.getNewSubscribersList();
|
|
908
|
+
```
|
|
909
|
+
|
|
910
|
+
### Parameters
|
|
911
|
+
This endpoint does not have any parameters.
|
|
912
|
+
|
|
913
|
+
|
|
914
|
+
### Return type
|
|
915
|
+
|
|
916
|
+
**ClubNewSubscribersListResponse**
|
|
917
|
+
|
|
918
|
+
### Authorization
|
|
919
|
+
|
|
920
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
921
|
+
|
|
922
|
+
### HTTP request headers
|
|
923
|
+
|
|
924
|
+
- **Content-Type**: Not defined
|
|
925
|
+
- **Accept**: application/json
|
|
926
|
+
|
|
927
|
+
|
|
928
|
+
### HTTP response details
|
|
929
|
+
| Status code | Description | Response headers |
|
|
930
|
+
|-------------|-------------|------------------|
|
|
931
|
+
|**200** | Nouveaux abonnés (30 derniers jours) | - |
|
|
932
|
+
|**400** | Bad Request | - |
|
|
933
|
+
|**401** | Unauthorized | - |
|
|
934
|
+
|
|
935
|
+
[[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)
|
|
936
|
+
|
|
890
937
|
# **getNoShowRate**
|
|
891
938
|
> NoShowRateResponse getNoShowRate()
|
|
892
939
|
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
# ClubNewSubscriberItem
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**id** | **string** | ID du joueur | [default to undefined]
|
|
9
|
+
**firstName** | **string** | Prénom | [default to undefined]
|
|
10
|
+
**lastName** | **string** | Nom | [default to undefined]
|
|
11
|
+
**email** | **string** | Email | [default to undefined]
|
|
12
|
+
**profilePictureUrl** | **string** | URL de la photo de profil | [default to undefined]
|
|
13
|
+
**isAccountVerified** | **boolean** | Compte vérifié | [default to undefined]
|
|
14
|
+
**subscribedAt** | **string** | Date d\'abonnement (format ISO) | [default to undefined]
|
|
15
|
+
**subscriptionsToMyClub** | [**Array<ClubPlayerSubscriptionSummary>**](ClubPlayerSubscriptionSummary.md) | Abonnements au club courant | [default to undefined]
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
```typescript
|
|
20
|
+
import { ClubNewSubscriberItem } from '@tennac-booking/sdk';
|
|
21
|
+
|
|
22
|
+
const instance: ClubNewSubscriberItem = {
|
|
23
|
+
id,
|
|
24
|
+
firstName,
|
|
25
|
+
lastName,
|
|
26
|
+
email,
|
|
27
|
+
profilePictureUrl,
|
|
28
|
+
isAccountVerified,
|
|
29
|
+
subscribedAt,
|
|
30
|
+
subscriptionsToMyClub,
|
|
31
|
+
};
|
|
32
|
+
```
|
|
33
|
+
|
|
34
|
+
[[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,26 @@
|
|
|
1
|
+
# ClubNewSubscribersListResponse
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**startDate** | **string** | Date de début incluse (format ISO) | [default to undefined]
|
|
9
|
+
**endDate** | **string** | Date de fin incluse (format ISO) | [default to undefined]
|
|
10
|
+
**total** | **number** | Nombre total de nouveaux abonnés | [default to undefined]
|
|
11
|
+
**subscribers** | [**Array<ClubNewSubscriberItem>**](ClubNewSubscriberItem.md) | Détails des nouveaux abonnés | [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { ClubNewSubscribersListResponse } from '@tennac-booking/sdk';
|
|
17
|
+
|
|
18
|
+
const instance: ClubNewSubscribersListResponse = {
|
|
19
|
+
startDate,
|
|
20
|
+
endDate,
|
|
21
|
+
total,
|
|
22
|
+
subscribers,
|
|
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,22 @@
|
|
|
1
|
+
# MigrateSubscription200Response
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**message** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**success** | **boolean** | | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { MigrateSubscription200Response } from '@tennac-booking/sdk';
|
|
15
|
+
|
|
16
|
+
const instance: MigrateSubscription200Response = {
|
|
17
|
+
message,
|
|
18
|
+
success,
|
|
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)
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# MigrateSubscriptionRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**subscriptionData** | **{ [key: string]: any; }** | Construct a type with a set of properties K of type T | [default to undefined]
|
|
9
|
+
**clubId** | **string** | | [default to undefined]
|
|
10
|
+
**lastName** | **string** | | [default to undefined]
|
|
11
|
+
**firstName** | **string** | | [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { MigrateSubscriptionRequest } from '@tennac-booking/sdk';
|
|
17
|
+
|
|
18
|
+
const instance: MigrateSubscriptionRequest = {
|
|
19
|
+
subscriptionData,
|
|
20
|
+
clubId,
|
|
21
|
+
lastName,
|
|
22
|
+
firstName,
|
|
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,24 @@
|
|
|
1
|
+
# MigrateUser200Response
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**message** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**userId** | **string** | | [optional] [default to undefined]
|
|
10
|
+
**success** | **boolean** | | [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { MigrateUser200Response } from '@tennac-booking/sdk';
|
|
16
|
+
|
|
17
|
+
const instance: MigrateUser200Response = {
|
|
18
|
+
message,
|
|
19
|
+
userId,
|
|
20
|
+
success,
|
|
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)
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
# MigrateUserRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**subscriptionMetadata** | **{ [key: string]: any; }** | Construct a type with a set of properties K of type T | [optional] [default to undefined]
|
|
9
|
+
**metadata** | **{ [key: string]: any; }** | Construct a type with a set of properties K of type T | [optional] [default to undefined]
|
|
10
|
+
**clubId** | **string** | | [default to undefined]
|
|
11
|
+
**city** | **string** | | [optional] [default to undefined]
|
|
12
|
+
**postalCode** | **string** | | [optional] [default to undefined]
|
|
13
|
+
**adress** | **string** | | [optional] [default to undefined]
|
|
14
|
+
**gender** | **string** | | [optional] [default to undefined]
|
|
15
|
+
**phone** | **string** | | [optional] [default to undefined]
|
|
16
|
+
**email** | **string** | | [default to undefined]
|
|
17
|
+
**lastName** | **string** | | [default to undefined]
|
|
18
|
+
**firstName** | **string** | | [default to undefined]
|
|
19
|
+
|
|
20
|
+
## Example
|
|
21
|
+
|
|
22
|
+
```typescript
|
|
23
|
+
import { MigrateUserRequest } from '@tennac-booking/sdk';
|
|
24
|
+
|
|
25
|
+
const instance: MigrateUserRequest = {
|
|
26
|
+
subscriptionMetadata,
|
|
27
|
+
metadata,
|
|
28
|
+
clubId,
|
|
29
|
+
city,
|
|
30
|
+
postalCode,
|
|
31
|
+
adress,
|
|
32
|
+
gender,
|
|
33
|
+
phone,
|
|
34
|
+
email,
|
|
35
|
+
lastName,
|
|
36
|
+
firstName,
|
|
37
|
+
};
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
[[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/UsersApi.md
CHANGED
|
@@ -31,6 +31,8 @@ All URIs are relative to *http://localhost*
|
|
|
31
31
|
|[**login**](#login) | **POST** /api/users/login | |
|
|
32
32
|
|[**loginClubMember**](#loginclubmember) | **POST** /api/users/club-members/login | |
|
|
33
33
|
|[**markNotificationsRead**](#marknotificationsread) | **POST** /api/users/me/notifications/read | |
|
|
34
|
+
|[**migrateSubscription**](#migratesubscription) | **POST** /api/users/migrate-subscriptions | |
|
|
35
|
+
|[**migrateUser**](#migrateuser) | **POST** /api/users/migrate | |
|
|
34
36
|
|[**refreshToken**](#refreshtoken) | **POST** /api/users/refresh-token | |
|
|
35
37
|
|[**register**](#register) | **POST** /api/users | |
|
|
36
38
|
|[**registerFromApp**](#registerfromapp) | **POST** /api/users/register-app | |
|
|
@@ -1418,6 +1420,110 @@ const { status, data } = await apiInstance.markNotificationsRead(
|
|
|
1418
1420
|
- **Accept**: application/json
|
|
1419
1421
|
|
|
1420
1422
|
|
|
1423
|
+
### HTTP response details
|
|
1424
|
+
| Status code | Description | Response headers |
|
|
1425
|
+
|-------------|-------------|------------------|
|
|
1426
|
+
|**200** | Ok | - |
|
|
1427
|
+
|
|
1428
|
+
[[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)
|
|
1429
|
+
|
|
1430
|
+
# **migrateSubscription**
|
|
1431
|
+
> MigrateSubscription200Response migrateSubscription(migrateSubscriptionRequest)
|
|
1432
|
+
|
|
1433
|
+
Endpoint de migration pour importer les abonnements depuis un CSV Map les abonnements aux ClubCustomer existants via firstName/lastName
|
|
1434
|
+
|
|
1435
|
+
### Example
|
|
1436
|
+
|
|
1437
|
+
```typescript
|
|
1438
|
+
import {
|
|
1439
|
+
UsersApi,
|
|
1440
|
+
Configuration,
|
|
1441
|
+
MigrateSubscriptionRequest
|
|
1442
|
+
} from '@tennac-booking/sdk';
|
|
1443
|
+
|
|
1444
|
+
const configuration = new Configuration();
|
|
1445
|
+
const apiInstance = new UsersApi(configuration);
|
|
1446
|
+
|
|
1447
|
+
let migrateSubscriptionRequest: MigrateSubscriptionRequest; //
|
|
1448
|
+
|
|
1449
|
+
const { status, data } = await apiInstance.migrateSubscription(
|
|
1450
|
+
migrateSubscriptionRequest
|
|
1451
|
+
);
|
|
1452
|
+
```
|
|
1453
|
+
|
|
1454
|
+
### Parameters
|
|
1455
|
+
|
|
1456
|
+
|Name | Type | Description | Notes|
|
|
1457
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1458
|
+
| **migrateSubscriptionRequest** | **MigrateSubscriptionRequest**| | |
|
|
1459
|
+
|
|
1460
|
+
|
|
1461
|
+
### Return type
|
|
1462
|
+
|
|
1463
|
+
**MigrateSubscription200Response**
|
|
1464
|
+
|
|
1465
|
+
### Authorization
|
|
1466
|
+
|
|
1467
|
+
No authorization required
|
|
1468
|
+
|
|
1469
|
+
### HTTP request headers
|
|
1470
|
+
|
|
1471
|
+
- **Content-Type**: application/json
|
|
1472
|
+
- **Accept**: application/json
|
|
1473
|
+
|
|
1474
|
+
|
|
1475
|
+
### HTTP response details
|
|
1476
|
+
| Status code | Description | Response headers |
|
|
1477
|
+
|-------------|-------------|------------------|
|
|
1478
|
+
|**200** | Ok | - |
|
|
1479
|
+
|
|
1480
|
+
[[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)
|
|
1481
|
+
|
|
1482
|
+
# **migrateUser**
|
|
1483
|
+
> MigrateUser200Response migrateUser(migrateUserRequest)
|
|
1484
|
+
|
|
1485
|
+
Endpoint de migration pour importer des utilisateurs depuis un CSV Crée l\'utilisateur, le ClubCustomer avec metadata et gère les duplicates
|
|
1486
|
+
|
|
1487
|
+
### Example
|
|
1488
|
+
|
|
1489
|
+
```typescript
|
|
1490
|
+
import {
|
|
1491
|
+
UsersApi,
|
|
1492
|
+
Configuration,
|
|
1493
|
+
MigrateUserRequest
|
|
1494
|
+
} from '@tennac-booking/sdk';
|
|
1495
|
+
|
|
1496
|
+
const configuration = new Configuration();
|
|
1497
|
+
const apiInstance = new UsersApi(configuration);
|
|
1498
|
+
|
|
1499
|
+
let migrateUserRequest: MigrateUserRequest; //
|
|
1500
|
+
|
|
1501
|
+
const { status, data } = await apiInstance.migrateUser(
|
|
1502
|
+
migrateUserRequest
|
|
1503
|
+
);
|
|
1504
|
+
```
|
|
1505
|
+
|
|
1506
|
+
### Parameters
|
|
1507
|
+
|
|
1508
|
+
|Name | Type | Description | Notes|
|
|
1509
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1510
|
+
| **migrateUserRequest** | **MigrateUserRequest**| | |
|
|
1511
|
+
|
|
1512
|
+
|
|
1513
|
+
### Return type
|
|
1514
|
+
|
|
1515
|
+
**MigrateUser200Response**
|
|
1516
|
+
|
|
1517
|
+
### Authorization
|
|
1518
|
+
|
|
1519
|
+
No authorization required
|
|
1520
|
+
|
|
1521
|
+
### HTTP request headers
|
|
1522
|
+
|
|
1523
|
+
- **Content-Type**: application/json
|
|
1524
|
+
- **Accept**: application/json
|
|
1525
|
+
|
|
1526
|
+
|
|
1421
1527
|
### HTTP response details
|
|
1422
1528
|
| Status code | Description | Response headers |
|
|
1423
1529
|
|-------------|-------------|------------------|
|