@tennac-booking/sdk 1.0.106 → 1.0.108
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 +284 -291
- package/README.md +7 -20
- package/api.ts +161 -908
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +128 -593
- package/dist/api.js +75 -537
- package/dist/base.d.ts +1 -1
- package/dist/base.js +1 -1
- package/dist/common.d.ts +1 -1
- package/dist/common.js +1 -1
- package/dist/configuration.d.ts +1 -1
- package/dist/configuration.js +1 -1
- package/dist/esm/api.d.ts +128 -593
- package/dist/esm/api.js +67 -525
- package/dist/esm/base.d.ts +1 -1
- package/dist/esm/base.js +1 -1
- package/dist/esm/common.d.ts +1 -1
- package/dist/esm/common.js +1 -1
- package/dist/esm/configuration.d.ts +1 -1
- package/dist/esm/configuration.js +1 -1
- package/dist/esm/index.d.ts +1 -1
- package/dist/esm/index.js +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.js +1 -1
- package/docs/ClientApi.md +59 -4
- package/docs/{ClientAccountOnboardingResponse.md → ClientFullOnboardingResponse.md} +7 -11
- package/docs/ClientFullOnboardingResponseClub.md +24 -0
- package/docs/ClientRegister201Response.md +26 -0
- package/docs/{ClientRegisterRequestBody.md → ClientRegisterRequest.md} +7 -7
- package/docs/ClubEvent.md +8 -2
- package/docs/ClubPageResponse.md +8 -2
- package/docs/PaymentMethod.md +4 -0
- package/index.ts +1 -1
- package/package.json +1 -1
- package/docs/ActiveSubscriptionResponse.md +0 -22
- package/docs/ClientAccountOnboardingRequest.md +0 -29
- package/docs/ClientAccountResponse.md +0 -44
- package/docs/ClientAccountsApi.md +0 -408
- package/docs/ClientMeResponse.md +0 -28
- package/docs/ClientOnboardingResponse.md +0 -27
- package/docs/ClientRegisterResponse.md +0 -22
- package/docs/ClientSubscriptionResponse.md +0 -34
- package/docs/GetSubscriptionsHistory200Response.md +0 -22
package/dist/esm/base.d.ts
CHANGED
package/dist/esm/base.js
CHANGED
package/dist/esm/common.d.ts
CHANGED
package/dist/esm/common.js
CHANGED
package/dist/esm/index.d.ts
CHANGED
package/dist/esm/index.js
CHANGED
package/dist/index.d.ts
CHANGED
package/dist/index.js
CHANGED
package/docs/ClientApi.md
CHANGED
|
@@ -4,9 +4,64 @@ All URIs are relative to *http://localhost*
|
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
+
|[**clientRegister**](#clientregister) | **POST** /clients/register | |
|
|
7
8
|
|[**getManagedClubs**](#getmanagedclubs) | **GET** /clients/managed-clubs | |
|
|
8
9
|
|[**onboardClub**](#onboardclub) | **POST** /clients/onboarding | |
|
|
9
10
|
|
|
11
|
+
# **clientRegister**
|
|
12
|
+
> ClientRegister201Response clientRegister(clientRegisterRequest)
|
|
13
|
+
|
|
14
|
+
Enregistre un nouvel utilisateur client - Crée l\'utilisateur avec un Stripe Customer
|
|
15
|
+
|
|
16
|
+
### Example
|
|
17
|
+
|
|
18
|
+
```typescript
|
|
19
|
+
import {
|
|
20
|
+
ClientApi,
|
|
21
|
+
Configuration,
|
|
22
|
+
ClientRegisterRequest
|
|
23
|
+
} from '@tennac-booking/sdk';
|
|
24
|
+
|
|
25
|
+
const configuration = new Configuration();
|
|
26
|
+
const apiInstance = new ClientApi(configuration);
|
|
27
|
+
|
|
28
|
+
let clientRegisterRequest: ClientRegisterRequest; //
|
|
29
|
+
|
|
30
|
+
const { status, data } = await apiInstance.clientRegister(
|
|
31
|
+
clientRegisterRequest
|
|
32
|
+
);
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
### Parameters
|
|
36
|
+
|
|
37
|
+
|Name | Type | Description | Notes|
|
|
38
|
+
|------------- | ------------- | ------------- | -------------|
|
|
39
|
+
| **clientRegisterRequest** | **ClientRegisterRequest**| | |
|
|
40
|
+
|
|
41
|
+
|
|
42
|
+
### Return type
|
|
43
|
+
|
|
44
|
+
**ClientRegister201Response**
|
|
45
|
+
|
|
46
|
+
### Authorization
|
|
47
|
+
|
|
48
|
+
No authorization required
|
|
49
|
+
|
|
50
|
+
### HTTP request headers
|
|
51
|
+
|
|
52
|
+
- **Content-Type**: application/json
|
|
53
|
+
- **Accept**: application/json
|
|
54
|
+
|
|
55
|
+
|
|
56
|
+
### HTTP response details
|
|
57
|
+
| Status code | Description | Response headers |
|
|
58
|
+
|-------------|-------------|------------------|
|
|
59
|
+
|**201** | Client enregistré avec succès | - |
|
|
60
|
+
|**400** | Données invalides | - |
|
|
61
|
+
|**500** | Erreur serveur | - |
|
|
62
|
+
|
|
63
|
+
[[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)
|
|
64
|
+
|
|
10
65
|
# **getManagedClubs**
|
|
11
66
|
> ManagedClubsResponse getManagedClubs()
|
|
12
67
|
|
|
@@ -54,9 +109,9 @@ This endpoint does not have any parameters.
|
|
|
54
109
|
[[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)
|
|
55
110
|
|
|
56
111
|
# **onboardClub**
|
|
57
|
-
>
|
|
112
|
+
> ClientFullOnboardingResponse onboardClub(clientOnboardingRequestBody)
|
|
58
113
|
|
|
59
|
-
Enregistre un nouveau club pour la plateforme
|
|
114
|
+
Enregistre un nouveau club pour la plateforme - Crée un compte Stripe Connect Express - Crée le club dans la base de données - Assigne l\'utilisateur comme manager du club - Crée les paramètres par défaut du club - Envoie le lien d\'onboarding Stripe par email
|
|
60
115
|
|
|
61
116
|
### Example
|
|
62
117
|
|
|
@@ -86,11 +141,11 @@ const { status, data } = await apiInstance.onboardClub(
|
|
|
86
141
|
|
|
87
142
|
### Return type
|
|
88
143
|
|
|
89
|
-
**
|
|
144
|
+
**ClientFullOnboardingResponse**
|
|
90
145
|
|
|
91
146
|
### Authorization
|
|
92
147
|
|
|
93
|
-
|
|
148
|
+
[clientAuth](../README.md#clientAuth)
|
|
94
149
|
|
|
95
150
|
### HTTP request headers
|
|
96
151
|
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
#
|
|
1
|
+
# ClientFullOnboardingResponse
|
|
2
2
|
|
|
3
3
|
|
|
4
4
|
## Properties
|
|
@@ -8,26 +8,22 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**clientAccountId** | **string** | | [default to undefined]
|
|
9
9
|
**stripeCustomerId** | **string** | | [default to undefined]
|
|
10
10
|
**stripeConnectedAccountId** | **string** | | [optional] [default to undefined]
|
|
11
|
-
**
|
|
12
|
-
**
|
|
11
|
+
**clientOnboardingLink** | **string** | | [optional] [default to undefined]
|
|
12
|
+
**club** | [**ClientFullOnboardingResponseClub**](ClientFullOnboardingResponseClub.md) | | [default to undefined]
|
|
13
13
|
**message** | **string** | | [default to undefined]
|
|
14
|
-
**isPublicOrganization** | **boolean** | | [default to undefined]
|
|
15
|
-
**manualInvoiceRequired** | **boolean** | | [optional] [default to undefined]
|
|
16
14
|
|
|
17
15
|
## Example
|
|
18
16
|
|
|
19
17
|
```typescript
|
|
20
|
-
import {
|
|
18
|
+
import { ClientFullOnboardingResponse } from '@tennac-booking/sdk';
|
|
21
19
|
|
|
22
|
-
const instance:
|
|
20
|
+
const instance: ClientFullOnboardingResponse = {
|
|
23
21
|
clientAccountId,
|
|
24
22
|
stripeCustomerId,
|
|
25
23
|
stripeConnectedAccountId,
|
|
26
|
-
|
|
27
|
-
|
|
24
|
+
clientOnboardingLink,
|
|
25
|
+
club,
|
|
28
26
|
message,
|
|
29
|
-
isPublicOrganization,
|
|
30
|
-
manualInvoiceRequired,
|
|
31
27
|
};
|
|
32
28
|
```
|
|
33
29
|
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
# ClientFullOnboardingResponseClub
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**clubOnboardingLink** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**stripeAccountId** | **string** | | [default to undefined]
|
|
10
|
+
**clubId** | **string** | | [default to undefined]
|
|
11
|
+
|
|
12
|
+
## Example
|
|
13
|
+
|
|
14
|
+
```typescript
|
|
15
|
+
import { ClientFullOnboardingResponseClub } from '@tennac-booking/sdk';
|
|
16
|
+
|
|
17
|
+
const instance: ClientFullOnboardingResponseClub = {
|
|
18
|
+
clubOnboardingLink,
|
|
19
|
+
stripeAccountId,
|
|
20
|
+
clubId,
|
|
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,26 @@
|
|
|
1
|
+
# ClientRegister201Response
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**message** | **string** | | [default to undefined]
|
|
9
|
+
**stripeCustomerId** | **string** | | [default to undefined]
|
|
10
|
+
**email** | **string** | | [default to undefined]
|
|
11
|
+
**userId** | **string** | | [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { ClientRegister201Response } from '@tennac-booking/sdk';
|
|
17
|
+
|
|
18
|
+
const instance: ClientRegister201Response = {
|
|
19
|
+
message,
|
|
20
|
+
stripeCustomerId,
|
|
21
|
+
email,
|
|
22
|
+
userId,
|
|
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)
|
|
@@ -1,25 +1,25 @@
|
|
|
1
|
-
#
|
|
1
|
+
# ClientRegisterRequest
|
|
2
2
|
|
|
3
3
|
|
|
4
4
|
## Properties
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**email** | **string** | | [default to undefined]
|
|
9
8
|
**password** | **string** | | [default to undefined]
|
|
10
|
-
**
|
|
9
|
+
**email** | **string** | | [default to undefined]
|
|
11
10
|
**lastName** | **string** | | [default to undefined]
|
|
11
|
+
**firstName** | **string** | | [default to undefined]
|
|
12
12
|
|
|
13
13
|
## Example
|
|
14
14
|
|
|
15
15
|
```typescript
|
|
16
|
-
import {
|
|
16
|
+
import { ClientRegisterRequest } from '@tennac-booking/sdk';
|
|
17
17
|
|
|
18
|
-
const instance:
|
|
19
|
-
email,
|
|
18
|
+
const instance: ClientRegisterRequest = {
|
|
20
19
|
password,
|
|
21
|
-
|
|
20
|
+
email,
|
|
22
21
|
lastName,
|
|
22
|
+
firstName,
|
|
23
23
|
};
|
|
24
24
|
```
|
|
25
25
|
|
package/docs/ClubEvent.md
CHANGED
|
@@ -5,10 +5,13 @@
|
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**imageSrc** | **string** | | [optional] [default to undefined]
|
|
8
9
|
**sport** | **string** | | [optional] [default to undefined]
|
|
9
10
|
**description** | **string** | | [optional] [default to undefined]
|
|
10
|
-
**
|
|
11
|
+
**endDate** | **string** | | [default to undefined]
|
|
12
|
+
**startDate** | **string** | | [default to undefined]
|
|
11
13
|
**name** | **string** | | [default to undefined]
|
|
14
|
+
**id** | **string** | | [default to undefined]
|
|
12
15
|
|
|
13
16
|
## Example
|
|
14
17
|
|
|
@@ -16,10 +19,13 @@ Name | Type | Description | Notes
|
|
|
16
19
|
import { ClubEvent } from '@tennac-booking/sdk';
|
|
17
20
|
|
|
18
21
|
const instance: ClubEvent = {
|
|
22
|
+
imageSrc,
|
|
19
23
|
sport,
|
|
20
24
|
description,
|
|
21
|
-
|
|
25
|
+
endDate,
|
|
26
|
+
startDate,
|
|
22
27
|
name,
|
|
28
|
+
id,
|
|
23
29
|
};
|
|
24
30
|
```
|
|
25
31
|
|
package/docs/ClubPageResponse.md
CHANGED
|
@@ -18,7 +18,10 @@ Name | Type | Description | Notes
|
|
|
18
18
|
**isNoShowEnabled** | **boolean** | Indique si la fonctionnalité \"no show\" est activée | [optional] [default to undefined]
|
|
19
19
|
**sports** | **Array<string>** | Liste des sports proposés par le club (identifiés par leur clé) | [optional] [default to undefined]
|
|
20
20
|
**clubPresentation** | [**ClubPresentation**](ClubPresentation.md) | | [default to undefined]
|
|
21
|
-
**
|
|
21
|
+
**comingEvents** | [**Array<ClubEvent>**](ClubEvent.md) | | [default to undefined]
|
|
22
|
+
**comingClosures** | [**Array<ClubEvent>**](ClubEvent.md) | | [default to undefined]
|
|
23
|
+
**lastNews** | [**Array<ClubEvent>**](ClubEvent.md) | | [default to undefined]
|
|
24
|
+
**openingHours** | [**ClubHoursSettingsResponse**](ClubHoursSettingsResponse.md) | | [optional] [default to undefined]
|
|
22
25
|
**createdAt** | [**ClubResponseCreatedAt**](ClubResponseCreatedAt.md) | | [optional] [default to undefined]
|
|
23
26
|
**updatedAt** | [**ClubResponseUpdatedAt**](ClubResponseUpdatedAt.md) | | [optional] [default to undefined]
|
|
24
27
|
|
|
@@ -41,7 +44,10 @@ const instance: ClubPageResponse = {
|
|
|
41
44
|
isNoShowEnabled,
|
|
42
45
|
sports,
|
|
43
46
|
clubPresentation,
|
|
44
|
-
|
|
47
|
+
comingEvents,
|
|
48
|
+
comingClosures,
|
|
49
|
+
lastNews,
|
|
50
|
+
openingHours,
|
|
45
51
|
createdAt,
|
|
46
52
|
updatedAt,
|
|
47
53
|
};
|
package/docs/PaymentMethod.md
CHANGED
|
@@ -7,6 +7,10 @@
|
|
|
7
7
|
|
|
8
8
|
* `Onsite` (value: `'onsite'`)
|
|
9
9
|
|
|
10
|
+
* `OnsiteCard` (value: `'onsite_card'`)
|
|
11
|
+
|
|
12
|
+
* `OnsiteCash` (value: `'onsite_cash'`)
|
|
13
|
+
|
|
10
14
|
* `Free` (value: `'free'`)
|
|
11
15
|
|
|
12
16
|
[[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
package/package.json
CHANGED
|
@@ -1,22 +0,0 @@
|
|
|
1
|
-
# ActiveSubscriptionResponse
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
## Properties
|
|
5
|
-
|
|
6
|
-
Name | Type | Description | Notes
|
|
7
|
-
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**clientAccountId** | **string** | | [default to undefined]
|
|
9
|
-
**subscription** | [**ClientSubscriptionResponse**](ClientSubscriptionResponse.md) | | [default to undefined]
|
|
10
|
-
|
|
11
|
-
## Example
|
|
12
|
-
|
|
13
|
-
```typescript
|
|
14
|
-
import { ActiveSubscriptionResponse } from '@tennac-booking/sdk';
|
|
15
|
-
|
|
16
|
-
const instance: ActiveSubscriptionResponse = {
|
|
17
|
-
clientAccountId,
|
|
18
|
-
subscription,
|
|
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,29 +0,0 @@
|
|
|
1
|
-
# ClientAccountOnboardingRequest
|
|
2
|
-
|
|
3
|
-
Types pour les requêtes/réponses
|
|
4
|
-
|
|
5
|
-
## Properties
|
|
6
|
-
|
|
7
|
-
Name | Type | Description | Notes
|
|
8
|
-
------------ | ------------- | ------------- | -------------
|
|
9
|
-
**businessName** | **string** | | [default to undefined]
|
|
10
|
-
**businessType** | **string** | | [optional] [default to undefined]
|
|
11
|
-
**subscriptionType** | **string** | | [optional] [default to undefined]
|
|
12
|
-
**isPublicOrganization** | **boolean** | | [optional] [default to undefined]
|
|
13
|
-
**priceId** | **string** | | [default to undefined]
|
|
14
|
-
|
|
15
|
-
## Example
|
|
16
|
-
|
|
17
|
-
```typescript
|
|
18
|
-
import { ClientAccountOnboardingRequest } from '@tennac-booking/sdk';
|
|
19
|
-
|
|
20
|
-
const instance: ClientAccountOnboardingRequest = {
|
|
21
|
-
businessName,
|
|
22
|
-
businessType,
|
|
23
|
-
subscriptionType,
|
|
24
|
-
isPublicOrganization,
|
|
25
|
-
priceId,
|
|
26
|
-
};
|
|
27
|
-
```
|
|
28
|
-
|
|
29
|
-
[[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,44 +0,0 @@
|
|
|
1
|
-
# ClientAccountResponse
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
## Properties
|
|
5
|
-
|
|
6
|
-
Name | Type | Description | Notes
|
|
7
|
-
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**id** | **string** | | [default to undefined]
|
|
9
|
-
**email** | **string** | | [default to undefined]
|
|
10
|
-
**businessName** | **string** | | [default to undefined]
|
|
11
|
-
**businessType** | **string** | | [default to undefined]
|
|
12
|
-
**subscriptionType** | **string** | | [default to undefined]
|
|
13
|
-
**status** | **string** | | [default to undefined]
|
|
14
|
-
**platformPaymentMethodSetup** | **boolean** | | [default to undefined]
|
|
15
|
-
**stripeConnectedAccountId** | **string** | | [optional] [default to undefined]
|
|
16
|
-
**connectedAccountOnboardingRequired** | **boolean** | | [optional] [default to undefined]
|
|
17
|
-
**isPublicOrganization** | **boolean** | | [default to undefined]
|
|
18
|
-
**manualInvoiceRequired** | **boolean** | | [optional] [default to undefined]
|
|
19
|
-
**createdAt** | **string** | | [default to undefined]
|
|
20
|
-
**updatedAt** | **string** | | [default to undefined]
|
|
21
|
-
|
|
22
|
-
## Example
|
|
23
|
-
|
|
24
|
-
```typescript
|
|
25
|
-
import { ClientAccountResponse } from '@tennac-booking/sdk';
|
|
26
|
-
|
|
27
|
-
const instance: ClientAccountResponse = {
|
|
28
|
-
id,
|
|
29
|
-
email,
|
|
30
|
-
businessName,
|
|
31
|
-
businessType,
|
|
32
|
-
subscriptionType,
|
|
33
|
-
status,
|
|
34
|
-
platformPaymentMethodSetup,
|
|
35
|
-
stripeConnectedAccountId,
|
|
36
|
-
connectedAccountOnboardingRequired,
|
|
37
|
-
isPublicOrganization,
|
|
38
|
-
manualInvoiceRequired,
|
|
39
|
-
createdAt,
|
|
40
|
-
updatedAt,
|
|
41
|
-
};
|
|
42
|
-
```
|
|
43
|
-
|
|
44
|
-
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|