@tennac-booking/sdk 1.0.125 → 1.0.127
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 +334 -343
- package/README.md +11 -19
- package/api.ts +422 -591
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +317 -496
- package/dist/api.js +164 -156
- 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 +317 -496
- package/dist/esm/api.js +160 -152
- 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/BookingsStaffApi.md +10 -10
- package/docs/{EventBookingResponsePlayersInnerInvoiceStatus.md → CheckInPlayerRequest.md} +5 -3
- package/docs/{CheckInPlayersResponse.md → CheckInPlayerResponse.md} +5 -5
- package/docs/ClubPlayerSubscriptionSummary.md +3 -3
- package/docs/ClubsStaffApi.md +54 -0
- package/docs/CreatePlan201Response.md +2 -0
- package/docs/CreateSubscriptionPlanRequest.md +2 -2
- package/docs/CreateSubscriptionPlanRequestDiscount.md +2 -0
- package/docs/DeleteSubscriptionPlanResponse.md +2 -0
- package/docs/EventsApi.md +1 -4
- package/docs/{EventBookingResponseSetupStatus.md → GetClubType200Response.md} +5 -3
- package/docs/MonthlyTurnoverResponse.md +0 -1
- package/docs/OffPeakRule.md +2 -0
- package/docs/PlanPrice.md +26 -0
- package/docs/{CheckInPlayersRequest.md → PlanPriceInput.md} +7 -5
- package/docs/PublicSubscriptionPlanResponse.md +5 -1
- package/docs/PublishEventResponse.md +0 -2
- package/docs/SendSubscriptionInvitationRequest.md +2 -0
- package/docs/SubscriptionPlanDiscountResponse.md +34 -0
- package/docs/SubscriptionPlanResponse.md +7 -1
- package/docs/SubscriptionsManagerApi.md +55 -1
- package/docs/UsersApi.md +0 -54
- package/index.ts +1 -1
- package/package.json +1 -1
- package/docs/EventBookingDetailSummary.md +0 -40
- package/docs/EventBookingResponse.md +0 -36
- package/docs/EventBookingResponsePlayersInner.md +0 -28
- package/docs/EventBookingStatus.md +0 -16
- package/docs/InvoiceStatusSETUPPENDING.md +0 -8
- package/docs/InvoiceStatusSETUPSUCCESS.md +0 -8
- package/docs/ParticipationType.md +0 -10
- package/docs/UserEventParticipation.md +0 -22
- package/docs/UserEventSummary.md +0 -44
- package/docs/UserEventsResponse.md +0 -28
- package/docs/VisibilityType.md +0 -12
package/docs/BookingsStaffApi.md
CHANGED
|
@@ -4,7 +4,7 @@ All URIs are relative to *http://localhost*
|
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
-
|[**
|
|
7
|
+
|[**checkInPlayer**](#checkinplayer) | **POST** /api/bookings/{bookingId}/check-in | |
|
|
8
8
|
|[**createStaffBooking**](#createstaffbooking) | **POST** /api/bookings/staff | |
|
|
9
9
|
|[**getBookingById**](#getbookingbyid) | **GET** /api/bookings/{bookingId} | |
|
|
10
10
|
|[**getBookingHistoryStaff**](#getbookinghistorystaff) | **GET** /api/bookings/staff/history{bookingId} | |
|
|
@@ -13,10 +13,10 @@ All URIs are relative to *http://localhost*
|
|
|
13
13
|
|[**getWeeklyBookings**](#getweeklybookings) | **GET** /api/bookings/weekly/{weekId} | |
|
|
14
14
|
|[**listClubBookings**](#listclubbookings) | **GET** /api/bookings/staff | |
|
|
15
15
|
|
|
16
|
-
# **
|
|
17
|
-
>
|
|
16
|
+
# **checkInPlayer**
|
|
17
|
+
> CheckInPlayerResponse checkInPlayer(checkInPlayerRequest)
|
|
18
18
|
|
|
19
|
-
Check-in
|
|
19
|
+
Check-in d\'un joueur (paiement en ligne ou sur place)
|
|
20
20
|
|
|
21
21
|
### Example
|
|
22
22
|
|
|
@@ -24,18 +24,18 @@ Check-in des joueurs only for club with payment features
|
|
|
24
24
|
import {
|
|
25
25
|
BookingsStaffApi,
|
|
26
26
|
Configuration,
|
|
27
|
-
|
|
27
|
+
CheckInPlayerRequest
|
|
28
28
|
} from '@tennac-booking/sdk';
|
|
29
29
|
|
|
30
30
|
const configuration = new Configuration();
|
|
31
31
|
const apiInstance = new BookingsStaffApi(configuration);
|
|
32
32
|
|
|
33
33
|
let bookingId: string; // (default to undefined)
|
|
34
|
-
let
|
|
34
|
+
let checkInPlayerRequest: CheckInPlayerRequest; //
|
|
35
35
|
|
|
36
|
-
const { status, data } = await apiInstance.
|
|
36
|
+
const { status, data } = await apiInstance.checkInPlayer(
|
|
37
37
|
bookingId,
|
|
38
|
-
|
|
38
|
+
checkInPlayerRequest
|
|
39
39
|
);
|
|
40
40
|
```
|
|
41
41
|
|
|
@@ -43,13 +43,13 @@ const { status, data } = await apiInstance.checkInPlayers(
|
|
|
43
43
|
|
|
44
44
|
|Name | Type | Description | Notes|
|
|
45
45
|
|------------- | ------------- | ------------- | -------------|
|
|
46
|
-
| **
|
|
46
|
+
| **checkInPlayerRequest** | **CheckInPlayerRequest**| | |
|
|
47
47
|
| **bookingId** | [**string**] | | defaults to undefined|
|
|
48
48
|
|
|
49
49
|
|
|
50
50
|
### Return type
|
|
51
51
|
|
|
52
|
-
**
|
|
52
|
+
**CheckInPlayerResponse**
|
|
53
53
|
|
|
54
54
|
### Authorization
|
|
55
55
|
|
|
@@ -1,17 +1,19 @@
|
|
|
1
|
-
#
|
|
1
|
+
# CheckInPlayerRequest
|
|
2
2
|
|
|
3
3
|
|
|
4
4
|
## Properties
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**playerId** | **string** | ID du joueur qui a payé/est arrivé | [default to undefined]
|
|
8
9
|
|
|
9
10
|
## Example
|
|
10
11
|
|
|
11
12
|
```typescript
|
|
12
|
-
import {
|
|
13
|
+
import { CheckInPlayerRequest } from '@tennac-booking/sdk';
|
|
13
14
|
|
|
14
|
-
const instance:
|
|
15
|
+
const instance: CheckInPlayerRequest = {
|
|
16
|
+
playerId,
|
|
15
17
|
};
|
|
16
18
|
```
|
|
17
19
|
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
#
|
|
1
|
+
# CheckInPlayerResponse
|
|
2
2
|
|
|
3
3
|
|
|
4
4
|
## Properties
|
|
@@ -6,16 +6,16 @@
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**message** | **string** | Message de confirmation | [default to undefined]
|
|
9
|
-
**
|
|
9
|
+
**invoice** | [**CheckedInPlayer**](CheckedInPlayer.md) | | [default to undefined]
|
|
10
10
|
|
|
11
11
|
## Example
|
|
12
12
|
|
|
13
13
|
```typescript
|
|
14
|
-
import {
|
|
14
|
+
import { CheckInPlayerResponse } from '@tennac-booking/sdk';
|
|
15
15
|
|
|
16
|
-
const instance:
|
|
16
|
+
const instance: CheckInPlayerResponse = {
|
|
17
17
|
message,
|
|
18
|
-
|
|
18
|
+
invoice,
|
|
19
19
|
};
|
|
20
20
|
```
|
|
21
21
|
|
|
@@ -7,9 +7,9 @@ Name | Type | Description | Notes
|
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**id** | **string** | ID du plan d\'abonnement | [default to undefined]
|
|
9
9
|
**name** | **string** | Nom du plan | [default to undefined]
|
|
10
|
-
**
|
|
10
|
+
**prices** | [**Array<PlanPrice>**](PlanPrice.md) | Tarifications disponibles | [default to undefined]
|
|
11
11
|
**currency** | **string** | Devise | [default to undefined]
|
|
12
|
-
**interval** | **string** | Intervalle
|
|
12
|
+
**interval** | **string** | Intervalle par défaut | [default to undefined]
|
|
13
13
|
|
|
14
14
|
## Example
|
|
15
15
|
|
|
@@ -19,7 +19,7 @@ import { ClubPlayerSubscriptionSummary } from '@tennac-booking/sdk';
|
|
|
19
19
|
const instance: ClubPlayerSubscriptionSummary = {
|
|
20
20
|
id,
|
|
21
21
|
name,
|
|
22
|
-
|
|
22
|
+
prices,
|
|
23
23
|
currency,
|
|
24
24
|
interval,
|
|
25
25
|
};
|
package/docs/ClubsStaffApi.md
CHANGED
|
@@ -10,6 +10,7 @@ All URIs are relative to *http://localhost*
|
|
|
10
10
|
|[**getClubMembers**](#getclubmembers) | **GET** /api/clubs/members | |
|
|
11
11
|
|[**getClubPresentationSettings**](#getclubpresentationsettings) | **GET** /api/clubs/settings/presentation | |
|
|
12
12
|
|[**getClubRoles**](#getclubroles) | **GET** /api/clubs/roles | |
|
|
13
|
+
|[**getClubType**](#getclubtype) | **GET** /api/clubs/{clubId}/clubType | |
|
|
13
14
|
|[**getCourtsByClub**](#getcourtsbyclub) | **GET** /api/clubs/courts | |
|
|
14
15
|
|[**getInvoices**](#getinvoices) | **GET** /api/clubs/invoices | |
|
|
15
16
|
|[**getUserProfileStaff**](#getuserprofilestaff) | **GET** /api/clubs/staff/profile/{id} | |
|
|
@@ -292,6 +293,59 @@ This endpoint does not have any parameters.
|
|
|
292
293
|
|
|
293
294
|
[[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)
|
|
294
295
|
|
|
296
|
+
# **getClubType**
|
|
297
|
+
> GetClubType200Response getClubType()
|
|
298
|
+
|
|
299
|
+
|
|
300
|
+
### Example
|
|
301
|
+
|
|
302
|
+
```typescript
|
|
303
|
+
import {
|
|
304
|
+
ClubsStaffApi,
|
|
305
|
+
Configuration
|
|
306
|
+
} from '@tennac-booking/sdk';
|
|
307
|
+
|
|
308
|
+
const configuration = new Configuration();
|
|
309
|
+
const apiInstance = new ClubsStaffApi(configuration);
|
|
310
|
+
|
|
311
|
+
let clubId: string; // (default to undefined)
|
|
312
|
+
|
|
313
|
+
const { status, data } = await apiInstance.getClubType(
|
|
314
|
+
clubId
|
|
315
|
+
);
|
|
316
|
+
```
|
|
317
|
+
|
|
318
|
+
### Parameters
|
|
319
|
+
|
|
320
|
+
|Name | Type | Description | Notes|
|
|
321
|
+
|------------- | ------------- | ------------- | -------------|
|
|
322
|
+
| **clubId** | [**string**] | | defaults to undefined|
|
|
323
|
+
|
|
324
|
+
|
|
325
|
+
### Return type
|
|
326
|
+
|
|
327
|
+
**GetClubType200Response**
|
|
328
|
+
|
|
329
|
+
### Authorization
|
|
330
|
+
|
|
331
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
332
|
+
|
|
333
|
+
### HTTP request headers
|
|
334
|
+
|
|
335
|
+
- **Content-Type**: Not defined
|
|
336
|
+
- **Accept**: application/json
|
|
337
|
+
|
|
338
|
+
|
|
339
|
+
### HTTP response details
|
|
340
|
+
| Status code | Description | Response headers |
|
|
341
|
+
|-------------|-------------|------------------|
|
|
342
|
+
|**200** | Type de club | - |
|
|
343
|
+
|**400** | Bad Request | - |
|
|
344
|
+
|**404** | Club non trouvé | - |
|
|
345
|
+
|**500** | Server Error | - |
|
|
346
|
+
|
|
347
|
+
[[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)
|
|
348
|
+
|
|
295
349
|
# **getCourtsByClub**
|
|
296
350
|
> Array<CourtResponse> getCourtsByClub()
|
|
297
351
|
|
|
@@ -5,6 +5,7 @@
|
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**priceIds** | **Array<string>** | | [default to undefined]
|
|
8
9
|
**priceId** | **string** | | [default to undefined]
|
|
9
10
|
**productId** | **string** | | [default to undefined]
|
|
10
11
|
|
|
@@ -14,6 +15,7 @@ Name | Type | Description | Notes
|
|
|
14
15
|
import { CreatePlan201Response } from '@tennac-booking/sdk';
|
|
15
16
|
|
|
16
17
|
const instance: CreatePlan201Response = {
|
|
18
|
+
priceIds,
|
|
17
19
|
priceId,
|
|
18
20
|
productId,
|
|
19
21
|
};
|
|
@@ -8,7 +8,7 @@ Name | Type | Description | Notes
|
|
|
8
8
|
**clubId** | **string** | | [optional] [default to undefined]
|
|
9
9
|
**name** | **string** | | [default to undefined]
|
|
10
10
|
**description** | **string** | | [optional] [default to undefined]
|
|
11
|
-
**
|
|
11
|
+
**prices** | [**Array<PlanPriceInput>**](PlanPriceInput.md) | | [default to undefined]
|
|
12
12
|
**currency** | **string** | | [default to undefined]
|
|
13
13
|
**interval** | [**PlanInterval**](PlanInterval.md) | | [default to undefined]
|
|
14
14
|
**discount** | [**CreateSubscriptionPlanRequestDiscount**](CreateSubscriptionPlanRequestDiscount.md) | | [optional] [default to undefined]
|
|
@@ -22,7 +22,7 @@ const instance: CreateSubscriptionPlanRequest = {
|
|
|
22
22
|
clubId,
|
|
23
23
|
name,
|
|
24
24
|
description,
|
|
25
|
-
|
|
25
|
+
prices,
|
|
26
26
|
currency,
|
|
27
27
|
interval,
|
|
28
28
|
discount,
|
|
@@ -7,6 +7,7 @@ Name | Type | Description | Notes
|
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**bookingFree** | **boolean** | | [optional] [default to undefined]
|
|
9
9
|
**offPeakRules** | [**Array<OffPeakRule>**](OffPeakRule.md) | | [optional] [default to undefined]
|
|
10
|
+
**offPeakRuleNames** | **Array<string>** | Liste optionnelle des noms de périodes tarifaires sur lesquelles appliquer la remise. Laisser vide pour appliquer la remise à toutes les heures d\'ouverture du club. | [optional] [default to undefined]
|
|
10
11
|
**validTo** | **string** | | [optional] [default to undefined]
|
|
11
12
|
**validFrom** | **string** | | [optional] [default to undefined]
|
|
12
13
|
**maxDiscountAmountInCents** | **number** | | [optional] [default to undefined]
|
|
@@ -21,6 +22,7 @@ import { CreateSubscriptionPlanRequestDiscount } from '@tennac-booking/sdk';
|
|
|
21
22
|
const instance: CreateSubscriptionPlanRequestDiscount = {
|
|
22
23
|
bookingFree,
|
|
23
24
|
offPeakRules,
|
|
25
|
+
offPeakRuleNames,
|
|
24
26
|
validTo,
|
|
25
27
|
validFrom,
|
|
26
28
|
maxDiscountAmountInCents,
|
|
@@ -6,6 +6,7 @@
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**message** | **string** | | [default to undefined]
|
|
9
|
+
**archivedInstead** | **boolean** | | [optional] [default to undefined]
|
|
9
10
|
|
|
10
11
|
## Example
|
|
11
12
|
|
|
@@ -14,6 +15,7 @@ import { DeleteSubscriptionPlanResponse } from '@tennac-booking/sdk';
|
|
|
14
15
|
|
|
15
16
|
const instance: DeleteSubscriptionPlanResponse = {
|
|
16
17
|
message,
|
|
18
|
+
archivedInstead,
|
|
17
19
|
};
|
|
18
20
|
```
|
|
19
21
|
|
package/docs/EventsApi.md
CHANGED
|
@@ -141,11 +141,9 @@ const configuration = new Configuration();
|
|
|
141
141
|
const apiInstance = new EventsApi(configuration);
|
|
142
142
|
|
|
143
143
|
let eventId: string; // (default to undefined)
|
|
144
|
-
let userId: string; // (optional) (default to undefined)
|
|
145
144
|
|
|
146
145
|
const { status, data } = await apiInstance.getEventById(
|
|
147
|
-
eventId
|
|
148
|
-
userId
|
|
146
|
+
eventId
|
|
149
147
|
);
|
|
150
148
|
```
|
|
151
149
|
|
|
@@ -154,7 +152,6 @@ const { status, data } = await apiInstance.getEventById(
|
|
|
154
152
|
|Name | Type | Description | Notes|
|
|
155
153
|
|------------- | ------------- | ------------- | -------------|
|
|
156
154
|
| **eventId** | [**string**] | | defaults to undefined|
|
|
157
|
-
| **userId** | [**string**] | | (optional) defaults to undefined|
|
|
158
155
|
|
|
159
156
|
|
|
160
157
|
### Return type
|
|
@@ -1,17 +1,19 @@
|
|
|
1
|
-
#
|
|
1
|
+
# GetClubType200Response
|
|
2
2
|
|
|
3
3
|
|
|
4
4
|
## Properties
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**clubType** | **string** | | [default to undefined]
|
|
8
9
|
|
|
9
10
|
## Example
|
|
10
11
|
|
|
11
12
|
```typescript
|
|
12
|
-
import {
|
|
13
|
+
import { GetClubType200Response } from '@tennac-booking/sdk';
|
|
13
14
|
|
|
14
|
-
const instance:
|
|
15
|
+
const instance: GetClubType200Response = {
|
|
16
|
+
clubType,
|
|
15
17
|
};
|
|
16
18
|
```
|
|
17
19
|
|
package/docs/OffPeakRule.md
CHANGED
|
@@ -5,6 +5,7 @@
|
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**pricingPeriodName** | **string** | | [optional] [default to undefined]
|
|
8
9
|
**percentage** | **number** | | [default to undefined]
|
|
9
10
|
**endHour** | **number** | | [default to undefined]
|
|
10
11
|
**startHour** | **number** | | [default to undefined]
|
|
@@ -16,6 +17,7 @@ Name | Type | Description | Notes
|
|
|
16
17
|
import { OffPeakRule } from '@tennac-booking/sdk';
|
|
17
18
|
|
|
18
19
|
const instance: OffPeakRule = {
|
|
20
|
+
pricingPeriodName,
|
|
19
21
|
percentage,
|
|
20
22
|
endHour,
|
|
21
23
|
startHour,
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# PlanPrice
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**amountInCents** | **number** | | [default to undefined]
|
|
9
|
+
**interval** | [**PlanInterval**](PlanInterval.md) | | [default to undefined]
|
|
10
|
+
**active** | **boolean** | | [optional] [default to undefined]
|
|
11
|
+
**stripePriceId** | **string** | | [optional] [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { PlanPrice } from '@tennac-booking/sdk';
|
|
17
|
+
|
|
18
|
+
const instance: PlanPrice = {
|
|
19
|
+
amountInCents,
|
|
20
|
+
interval,
|
|
21
|
+
active,
|
|
22
|
+
stripePriceId,
|
|
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,19 +1,21 @@
|
|
|
1
|
-
#
|
|
1
|
+
# PlanPriceInput
|
|
2
2
|
|
|
3
3
|
|
|
4
4
|
## Properties
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**
|
|
8
|
+
**amountInCents** | **number** | | [default to undefined]
|
|
9
|
+
**interval** | [**PlanInterval**](PlanInterval.md) | | [default to undefined]
|
|
9
10
|
|
|
10
11
|
## Example
|
|
11
12
|
|
|
12
13
|
```typescript
|
|
13
|
-
import {
|
|
14
|
+
import { PlanPriceInput } from '@tennac-booking/sdk';
|
|
14
15
|
|
|
15
|
-
const instance:
|
|
16
|
-
|
|
16
|
+
const instance: PlanPriceInput = {
|
|
17
|
+
amountInCents,
|
|
18
|
+
interval,
|
|
17
19
|
};
|
|
18
20
|
```
|
|
19
21
|
|
|
@@ -7,10 +7,12 @@ Name | Type | Description | Notes
|
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**priceId** | **string** | | [default to undefined]
|
|
9
9
|
**name** | **string** | | [default to undefined]
|
|
10
|
-
**amountInCents** | **number** | | [default to undefined]
|
|
10
|
+
**amountInCents** | **number** | | [optional] [default to undefined]
|
|
11
11
|
**currency** | **string** | | [default to undefined]
|
|
12
|
+
**prices** | [**Array<PlanPrice>**](PlanPrice.md) | | [default to undefined]
|
|
12
13
|
**interval** | [**PlanInterval**](PlanInterval.md) | | [optional] [default to undefined]
|
|
13
14
|
**description** | **string** | | [optional] [default to undefined]
|
|
15
|
+
**discount** | [**SubscriptionPlanDiscountResponse**](SubscriptionPlanDiscountResponse.md) | | [optional] [default to undefined]
|
|
14
16
|
|
|
15
17
|
## Example
|
|
16
18
|
|
|
@@ -22,8 +24,10 @@ const instance: PublicSubscriptionPlanResponse = {
|
|
|
22
24
|
name,
|
|
23
25
|
amountInCents,
|
|
24
26
|
currency,
|
|
27
|
+
prices,
|
|
25
28
|
interval,
|
|
26
29
|
description,
|
|
30
|
+
discount,
|
|
27
31
|
};
|
|
28
32
|
```
|
|
29
33
|
|
|
@@ -7,7 +7,6 @@ Name | Type | Description | Notes
|
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**event** | [**EventResponse**](EventResponse.md) | | [default to undefined]
|
|
9
9
|
**refundedBookingIds** | **Array<string>** | | [optional] [default to undefined]
|
|
10
|
-
**userBooking** | [**EventBookingResponse**](EventBookingResponse.md) | | [optional] [default to undefined]
|
|
11
10
|
|
|
12
11
|
## Example
|
|
13
12
|
|
|
@@ -17,7 +16,6 @@ import { PublishEventResponse } from '@tennac-booking/sdk';
|
|
|
17
16
|
const instance: PublishEventResponse = {
|
|
18
17
|
event,
|
|
19
18
|
refundedBookingIds,
|
|
20
|
-
userBooking,
|
|
21
19
|
};
|
|
22
20
|
```
|
|
23
21
|
|
|
@@ -7,6 +7,7 @@ Name | Type | Description | Notes
|
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**userId** | **string** | | [default to undefined]
|
|
9
9
|
**productId** | **string** | Identifiant Stripe (productId) du plan sélectionné par le staff. | [default to undefined]
|
|
10
|
+
**priceId** | **string** | Price spécifique proposé dans l\'invitation (facultatif). | [optional] [default to undefined]
|
|
10
11
|
|
|
11
12
|
## Example
|
|
12
13
|
|
|
@@ -16,6 +17,7 @@ import { SendSubscriptionInvitationRequest } from '@tennac-booking/sdk';
|
|
|
16
17
|
const instance: SendSubscriptionInvitationRequest = {
|
|
17
18
|
userId,
|
|
18
19
|
productId,
|
|
20
|
+
priceId,
|
|
19
21
|
};
|
|
20
22
|
```
|
|
21
23
|
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
# SubscriptionPlanDiscountResponse
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**type** | [**DiscountType**](DiscountType.md) | | [default to undefined]
|
|
9
|
+
**percentage** | **number** | | [optional] [default to undefined]
|
|
10
|
+
**maxDiscountAmountInCents** | **number** | | [optional] [default to undefined]
|
|
11
|
+
**validFrom** | **string** | | [optional] [default to undefined]
|
|
12
|
+
**validTo** | **string** | | [optional] [default to undefined]
|
|
13
|
+
**offPeakRuleNames** | **Array<string>** | | [optional] [default to undefined]
|
|
14
|
+
**offPeakRules** | [**Array<OffPeakRule>**](OffPeakRule.md) | | [optional] [default to undefined]
|
|
15
|
+
**bookingFree** | **boolean** | | [optional] [default to undefined]
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
```typescript
|
|
20
|
+
import { SubscriptionPlanDiscountResponse } from '@tennac-booking/sdk';
|
|
21
|
+
|
|
22
|
+
const instance: SubscriptionPlanDiscountResponse = {
|
|
23
|
+
type,
|
|
24
|
+
percentage,
|
|
25
|
+
maxDiscountAmountInCents,
|
|
26
|
+
validFrom,
|
|
27
|
+
validTo,
|
|
28
|
+
offPeakRuleNames,
|
|
29
|
+
offPeakRules,
|
|
30
|
+
bookingFree,
|
|
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)
|
|
@@ -9,10 +9,13 @@ Name | Type | Description | Notes
|
|
|
9
9
|
**productName** | **string** | | [default to undefined]
|
|
10
10
|
**productActive** | **boolean** | | [default to undefined]
|
|
11
11
|
**priceId** | **string** | | [default to undefined]
|
|
12
|
-
**amountInCents** | **number** | | [default to undefined]
|
|
12
|
+
**amountInCents** | **number** | | [optional] [default to undefined]
|
|
13
13
|
**currency** | **string** | | [default to undefined]
|
|
14
|
+
**prices** | [**Array<PlanPrice>**](PlanPrice.md) | | [default to undefined]
|
|
14
15
|
**interval** | [**PlanInterval**](PlanInterval.md) | | [optional] [default to undefined]
|
|
15
16
|
**priceActive** | **boolean** | | [default to undefined]
|
|
17
|
+
**description** | **string** | | [optional] [default to undefined]
|
|
18
|
+
**discount** | [**SubscriptionPlanDiscountResponse**](SubscriptionPlanDiscountResponse.md) | | [optional] [default to undefined]
|
|
16
19
|
|
|
17
20
|
## Example
|
|
18
21
|
|
|
@@ -26,8 +29,11 @@ const instance: SubscriptionPlanResponse = {
|
|
|
26
29
|
priceId,
|
|
27
30
|
amountInCents,
|
|
28
31
|
currency,
|
|
32
|
+
prices,
|
|
29
33
|
interval,
|
|
30
34
|
priceActive,
|
|
35
|
+
description,
|
|
36
|
+
discount,
|
|
31
37
|
};
|
|
32
38
|
```
|
|
33
39
|
|
|
@@ -4,10 +4,64 @@ All URIs are relative to *http://localhost*
|
|
|
4
4
|
|
|
5
5
|
|Method | HTTP request | Description|
|
|
6
6
|
|------------- | ------------- | -------------|
|
|
7
|
+
|[**archivePlan**](#archiveplan) | **POST** /api/subscriptions/plans/{productId}/archive | |
|
|
7
8
|
|[**createPlan**](#createplan) | **POST** /api/subscriptions/plans | |
|
|
8
9
|
|[**deletePlan**](#deleteplan) | **DELETE** /api/subscriptions/plans/{productId} | |
|
|
9
10
|
|[**updatePlan**](#updateplan) | **PUT** /api/subscriptions/plans | |
|
|
10
11
|
|
|
12
|
+
# **archivePlan**
|
|
13
|
+
> DeleteSubscriptionPlanResponse archivePlan()
|
|
14
|
+
|
|
15
|
+
Supprime (archive) un plan par productId (manager)
|
|
16
|
+
|
|
17
|
+
### Example
|
|
18
|
+
|
|
19
|
+
```typescript
|
|
20
|
+
import {
|
|
21
|
+
SubscriptionsManagerApi,
|
|
22
|
+
Configuration
|
|
23
|
+
} from '@tennac-booking/sdk';
|
|
24
|
+
|
|
25
|
+
const configuration = new Configuration();
|
|
26
|
+
const apiInstance = new SubscriptionsManagerApi(configuration);
|
|
27
|
+
|
|
28
|
+
let productId: string; // (default to undefined)
|
|
29
|
+
|
|
30
|
+
const { status, data } = await apiInstance.archivePlan(
|
|
31
|
+
productId
|
|
32
|
+
);
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
### Parameters
|
|
36
|
+
|
|
37
|
+
|Name | Type | Description | Notes|
|
|
38
|
+
|------------- | ------------- | ------------- | -------------|
|
|
39
|
+
| **productId** | [**string**] | | defaults to undefined|
|
|
40
|
+
|
|
41
|
+
|
|
42
|
+
### Return type
|
|
43
|
+
|
|
44
|
+
**DeleteSubscriptionPlanResponse**
|
|
45
|
+
|
|
46
|
+
### Authorization
|
|
47
|
+
|
|
48
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
49
|
+
|
|
50
|
+
### HTTP request headers
|
|
51
|
+
|
|
52
|
+
- **Content-Type**: Not defined
|
|
53
|
+
- **Accept**: application/json
|
|
54
|
+
|
|
55
|
+
|
|
56
|
+
### HTTP response details
|
|
57
|
+
| Status code | Description | Response headers |
|
|
58
|
+
|-------------|-------------|------------------|
|
|
59
|
+
|**200** | Plan archivé | - |
|
|
60
|
+
|**400** | Bad Request | - |
|
|
61
|
+
|**401** | Unauthorized | - |
|
|
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
|
+
|
|
11
65
|
# **createPlan**
|
|
12
66
|
> CreatePlan201Response createPlan(createSubscriptionPlanRequest)
|
|
13
67
|
|
|
@@ -65,7 +119,7 @@ const { status, data } = await apiInstance.createPlan(
|
|
|
65
119
|
# **deletePlan**
|
|
66
120
|
> DeleteSubscriptionPlanResponse deletePlan()
|
|
67
121
|
|
|
68
|
-
Supprime
|
|
122
|
+
Supprime un plan par productId (manager)
|
|
69
123
|
|
|
70
124
|
### Example
|
|
71
125
|
|
package/docs/UsersApi.md
CHANGED
|
@@ -22,7 +22,6 @@ All URIs are relative to *http://localhost*
|
|
|
22
22
|
|[**getNearestUsersFromCoordinates**](#getnearestusersfromcoordinates) | **GET** /api/users/nearest-players/coordinates | |
|
|
23
23
|
|[**getPlayerCategories**](#getplayercategories) | **GET** /api/users/players/categories | |
|
|
24
24
|
|[**getUserBookings**](#getuserbookings) | **GET** /api/users/me/bookings | |
|
|
25
|
-
|[**getUserEvents**](#getuserevents) | **GET** /api/users/me/events | |
|
|
26
25
|
|[**getUserProfileById**](#getuserprofilebyid) | **GET** /api/users/profile/{id} | |
|
|
27
26
|
|[**listPlayers**](#listplayers) | **GET** /api/users/players | |
|
|
28
27
|
|[**login**](#login) | **POST** /api/users/login | |
|
|
@@ -912,59 +911,6 @@ const { status, data } = await apiInstance.getUserBookings(
|
|
|
912
911
|
- **Accept**: application/json
|
|
913
912
|
|
|
914
913
|
|
|
915
|
-
### HTTP response details
|
|
916
|
-
| Status code | Description | Response headers |
|
|
917
|
-
|-------------|-------------|------------------|
|
|
918
|
-
|**200** | Ok | - |
|
|
919
|
-
|
|
920
|
-
[[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)
|
|
921
|
-
|
|
922
|
-
# **getUserEvents**
|
|
923
|
-
> UserEventsResponse getUserEvents()
|
|
924
|
-
|
|
925
|
-
|
|
926
|
-
### Example
|
|
927
|
-
|
|
928
|
-
```typescript
|
|
929
|
-
import {
|
|
930
|
-
UsersApi,
|
|
931
|
-
Configuration
|
|
932
|
-
} from '@tennac-booking/sdk';
|
|
933
|
-
|
|
934
|
-
const configuration = new Configuration();
|
|
935
|
-
const apiInstance = new UsersApi(configuration);
|
|
936
|
-
|
|
937
|
-
let limit: number; // (optional) (default to undefined)
|
|
938
|
-
let skip: number; // (optional) (default to undefined)
|
|
939
|
-
|
|
940
|
-
const { status, data } = await apiInstance.getUserEvents(
|
|
941
|
-
limit,
|
|
942
|
-
skip
|
|
943
|
-
);
|
|
944
|
-
```
|
|
945
|
-
|
|
946
|
-
### Parameters
|
|
947
|
-
|
|
948
|
-
|Name | Type | Description | Notes|
|
|
949
|
-
|------------- | ------------- | ------------- | -------------|
|
|
950
|
-
| **limit** | [**number**] | | (optional) defaults to undefined|
|
|
951
|
-
| **skip** | [**number**] | | (optional) defaults to undefined|
|
|
952
|
-
|
|
953
|
-
|
|
954
|
-
### Return type
|
|
955
|
-
|
|
956
|
-
**UserEventsResponse**
|
|
957
|
-
|
|
958
|
-
### Authorization
|
|
959
|
-
|
|
960
|
-
[bearerAuth](../README.md#bearerAuth)
|
|
961
|
-
|
|
962
|
-
### HTTP request headers
|
|
963
|
-
|
|
964
|
-
- **Content-Type**: Not defined
|
|
965
|
-
- **Accept**: application/json
|
|
966
|
-
|
|
967
|
-
|
|
968
914
|
### HTTP response details
|
|
969
915
|
| Status code | Description | Response headers |
|
|
970
916
|
|-------------|-------------|------------------|
|
package/index.ts
CHANGED