@tennac-booking/sdk 1.0.128 → 1.0.129
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 +346 -334
- package/README.md +24 -11
- package/api.ts +1018 -413
- package/base.ts +1 -1
- package/common.ts +1 -1
- package/configuration.ts +1 -1
- package/dist/api.d.ts +858 -345
- package/dist/api.js +317 -157
- 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 +858 -345
- package/dist/esm/api.js +313 -153
- 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/{PlanPriceInput.md → CheckInPlayersRequest.md} +5 -7
- package/docs/{CheckInPlayerResponse.md → CheckInPlayersResponse.md} +5 -5
- package/docs/ClubPlayerSubscriptionSummary.md +3 -3
- package/docs/ClubsStaffApi.md +0 -47
- package/docs/CreatePlan201Response.md +0 -2
- package/docs/CreateSubscriptionPlanRequest.md +2 -2
- package/docs/CreateSubscriptionPlanRequestDiscount.md +0 -2
- package/docs/DeleteSubscriptionPlanResponse.md +0 -2
- package/docs/EventBookingDetailSummary.md +40 -0
- package/docs/EventBookingResponse.md +36 -0
- package/docs/EventBookingResponsePlayersInner.md +28 -0
- package/docs/{CheckInPlayerRequest.md → EventBookingResponsePlayersInnerInvoiceStatus.md} +3 -5
- package/docs/{GetClubType200Response.md → EventBookingResponseSetupStatus.md} +3 -5
- package/docs/EventBookingStatus.md +16 -0
- package/docs/EventsApi.md +4 -1
- package/docs/EventsManagerApi.md +110 -0
- package/docs/InvoiceStatusSETUPPENDING.md +8 -0
- package/docs/InvoiceStatusSETUPSUCCESS.md +8 -0
- package/docs/MonthlyTurnoverResponse.md +1 -0
- package/docs/OffPeakRule.md +0 -2
- package/docs/ParticipationType.md +10 -0
- package/docs/PublicSubscriptionPlanResponse.md +1 -5
- package/docs/PublishEventResponse.md +4 -0
- package/docs/RecurringDefinitionResponse.md +34 -0
- package/docs/SendSubscriptionInvitationRequest.md +0 -2
- package/docs/SubscriptionPlanResponse.md +1 -7
- package/docs/SubscriptionsManagerApi.md +1 -55
- package/docs/UpdateRecurringDefinition200Response.md +20 -0
- package/docs/UpdateRecurringDefinitionRequest.md +56 -0
- package/docs/UserEventParticipation.md +22 -0
- package/docs/UserEventSummary.md +44 -0
- package/docs/UserEventsResponse.md +28 -0
- package/docs/UsersApi.md +54 -0
- package/docs/VisibilityType.md +12 -0
- package/index.ts +1 -1
- package/package.json +1 -1
- package/docs/PlanPrice.md +0 -26
- package/docs/SubscriptionPlanDiscountResponse.md +0 -34
package/docs/EventsManagerApi.md
CHANGED
|
@@ -7,10 +7,12 @@ All URIs are relative to *http://localhost*
|
|
|
7
7
|
|[**checkEventConflicts**](#checkeventconflicts) | **POST** /api/events/manager/checkConflicts | |
|
|
8
8
|
|[**createEvent**](#createevent) | **POST** /api/events/manager/createEvent | |
|
|
9
9
|
|[**deleteEvent**](#deleteevent) | **DELETE** /api/events/manager/deleteEvent/{eventId} | |
|
|
10
|
+
|[**getExpiringRecurringDefinitions**](#getexpiringrecurringdefinitions) | **GET** /api/events/manager/recurring/expiring | |
|
|
10
11
|
|[**publishEvent**](#publishevent) | **PUT** /api/events/manager/publishEvent/{eventId} | |
|
|
11
12
|
|[**unpublishEvent**](#unpublishevent) | **PUT** /api/events/manager/unpublishEvent/{eventId} | |
|
|
12
13
|
|[**updateEvent**](#updateevent) | **PUT** /api/events/manager/updateEvent/{eventId} | |
|
|
13
14
|
|[**updatePublishedEvent**](#updatepublishedevent) | **PUT** /api/events/manager/updatePublishedEvent/{eventId} | |
|
|
15
|
+
|[**updateRecurringDefinition**](#updaterecurringdefinition) | **PUT** /api/events/manager/recurring/{definitionId} | |
|
|
14
16
|
|
|
15
17
|
# **checkEventConflicts**
|
|
16
18
|
> EventConflictCheckResponse checkEventConflicts(eventConflictCheckRequest)
|
|
@@ -175,6 +177,57 @@ const { status, data } = await apiInstance.deleteEvent(
|
|
|
175
177
|
|
|
176
178
|
[[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)
|
|
177
179
|
|
|
180
|
+
# **getExpiringRecurringDefinitions**
|
|
181
|
+
> Array<RecurringDefinitionResponse> getExpiringRecurringDefinitions()
|
|
182
|
+
|
|
183
|
+
List recurring definitions about to expire within `days` (manager)
|
|
184
|
+
|
|
185
|
+
### Example
|
|
186
|
+
|
|
187
|
+
```typescript
|
|
188
|
+
import {
|
|
189
|
+
EventsManagerApi,
|
|
190
|
+
Configuration
|
|
191
|
+
} from '@tennac-booking/sdk';
|
|
192
|
+
|
|
193
|
+
const configuration = new Configuration();
|
|
194
|
+
const apiInstance = new EventsManagerApi(configuration);
|
|
195
|
+
|
|
196
|
+
let days: number; // (optional) (default to undefined)
|
|
197
|
+
|
|
198
|
+
const { status, data } = await apiInstance.getExpiringRecurringDefinitions(
|
|
199
|
+
days
|
|
200
|
+
);
|
|
201
|
+
```
|
|
202
|
+
|
|
203
|
+
### Parameters
|
|
204
|
+
|
|
205
|
+
|Name | Type | Description | Notes|
|
|
206
|
+
|------------- | ------------- | ------------- | -------------|
|
|
207
|
+
| **days** | [**number**] | | (optional) defaults to undefined|
|
|
208
|
+
|
|
209
|
+
|
|
210
|
+
### Return type
|
|
211
|
+
|
|
212
|
+
**Array<RecurringDefinitionResponse>**
|
|
213
|
+
|
|
214
|
+
### Authorization
|
|
215
|
+
|
|
216
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
217
|
+
|
|
218
|
+
### HTTP request headers
|
|
219
|
+
|
|
220
|
+
- **Content-Type**: Not defined
|
|
221
|
+
- **Accept**: application/json
|
|
222
|
+
|
|
223
|
+
|
|
224
|
+
### HTTP response details
|
|
225
|
+
| Status code | Description | Response headers |
|
|
226
|
+
|-------------|-------------|------------------|
|
|
227
|
+
|**200** | List of expiring recurring definitions | - |
|
|
228
|
+
|
|
229
|
+
[[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)
|
|
230
|
+
|
|
178
231
|
# **publishEvent**
|
|
179
232
|
> PublishEventResponse publishEvent()
|
|
180
233
|
|
|
@@ -396,3 +449,60 @@ const { status, data } = await apiInstance.updatePublishedEvent(
|
|
|
396
449
|
|
|
397
450
|
[[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)
|
|
398
451
|
|
|
452
|
+
# **updateRecurringDefinition**
|
|
453
|
+
> UpdateRecurringDefinition200Response updateRecurringDefinition(updateRecurringDefinitionRequest)
|
|
454
|
+
|
|
455
|
+
Update a recurring event definition (manager) and propagate changes to generated Events
|
|
456
|
+
|
|
457
|
+
### Example
|
|
458
|
+
|
|
459
|
+
```typescript
|
|
460
|
+
import {
|
|
461
|
+
EventsManagerApi,
|
|
462
|
+
Configuration,
|
|
463
|
+
UpdateRecurringDefinitionRequest
|
|
464
|
+
} from '@tennac-booking/sdk';
|
|
465
|
+
|
|
466
|
+
const configuration = new Configuration();
|
|
467
|
+
const apiInstance = new EventsManagerApi(configuration);
|
|
468
|
+
|
|
469
|
+
let definitionId: string; // (default to undefined)
|
|
470
|
+
let updateRecurringDefinitionRequest: UpdateRecurringDefinitionRequest; //
|
|
471
|
+
|
|
472
|
+
const { status, data } = await apiInstance.updateRecurringDefinition(
|
|
473
|
+
definitionId,
|
|
474
|
+
updateRecurringDefinitionRequest
|
|
475
|
+
);
|
|
476
|
+
```
|
|
477
|
+
|
|
478
|
+
### Parameters
|
|
479
|
+
|
|
480
|
+
|Name | Type | Description | Notes|
|
|
481
|
+
|------------- | ------------- | ------------- | -------------|
|
|
482
|
+
| **updateRecurringDefinitionRequest** | **UpdateRecurringDefinitionRequest**| | |
|
|
483
|
+
| **definitionId** | [**string**] | | defaults to undefined|
|
|
484
|
+
|
|
485
|
+
|
|
486
|
+
### Return type
|
|
487
|
+
|
|
488
|
+
**UpdateRecurringDefinition200Response**
|
|
489
|
+
|
|
490
|
+
### Authorization
|
|
491
|
+
|
|
492
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
493
|
+
|
|
494
|
+
### HTTP request headers
|
|
495
|
+
|
|
496
|
+
- **Content-Type**: application/json
|
|
497
|
+
- **Accept**: application/json
|
|
498
|
+
|
|
499
|
+
|
|
500
|
+
### HTTP response details
|
|
501
|
+
| Status code | Description | Response headers |
|
|
502
|
+
|-------------|-------------|------------------|
|
|
503
|
+
|**200** | Recurring definition updated | - |
|
|
504
|
+
|**400** | Bad Request | - |
|
|
505
|
+
|**404** | Not Found | - |
|
|
506
|
+
|
|
507
|
+
[[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)
|
|
508
|
+
|
package/docs/OffPeakRule.md
CHANGED
|
@@ -5,7 +5,6 @@
|
|
|
5
5
|
|
|
6
6
|
Name | Type | Description | Notes
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
|
-
**pricingPeriodName** | **string** | | [optional] [default to undefined]
|
|
9
8
|
**percentage** | **number** | | [default to undefined]
|
|
10
9
|
**endHour** | **number** | | [default to undefined]
|
|
11
10
|
**startHour** | **number** | | [default to undefined]
|
|
@@ -17,7 +16,6 @@ Name | Type | Description | Notes
|
|
|
17
16
|
import { OffPeakRule } from '@tennac-booking/sdk';
|
|
18
17
|
|
|
19
18
|
const instance: OffPeakRule = {
|
|
20
|
-
pricingPeriodName,
|
|
21
19
|
percentage,
|
|
22
20
|
endHour,
|
|
23
21
|
startHour,
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# ParticipationType
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Enum
|
|
5
|
+
|
|
6
|
+
* `Solo` (value: `'solo'`)
|
|
7
|
+
|
|
8
|
+
* `Team` (value: `'team'`)
|
|
9
|
+
|
|
10
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -7,12 +7,10 @@ Name | Type | Description | Notes
|
|
|
7
7
|
------------ | ------------- | ------------- | -------------
|
|
8
8
|
**priceId** | **string** | | [default to undefined]
|
|
9
9
|
**name** | **string** | | [default to undefined]
|
|
10
|
-
**amountInCents** | **number** | | [
|
|
10
|
+
**amountInCents** | **number** | | [default to undefined]
|
|
11
11
|
**currency** | **string** | | [default to undefined]
|
|
12
|
-
**prices** | [**Array<PlanPrice>**](PlanPrice.md) | | [default to undefined]
|
|
13
12
|
**interval** | [**PlanInterval**](PlanInterval.md) | | [optional] [default to undefined]
|
|
14
13
|
**description** | **string** | | [optional] [default to undefined]
|
|
15
|
-
**discount** | [**SubscriptionPlanDiscountResponse**](SubscriptionPlanDiscountResponse.md) | | [optional] [default to undefined]
|
|
16
14
|
|
|
17
15
|
## Example
|
|
18
16
|
|
|
@@ -24,10 +22,8 @@ const instance: PublicSubscriptionPlanResponse = {
|
|
|
24
22
|
name,
|
|
25
23
|
amountInCents,
|
|
26
24
|
currency,
|
|
27
|
-
prices,
|
|
28
25
|
interval,
|
|
29
26
|
description,
|
|
30
|
-
discount,
|
|
31
27
|
};
|
|
32
28
|
```
|
|
33
29
|
|
|
@@ -7,6 +7,8 @@ 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
|
+
**needsToSetupPaymentMethod** | **boolean** | | [optional] [default to undefined]
|
|
10
12
|
|
|
11
13
|
## Example
|
|
12
14
|
|
|
@@ -16,6 +18,8 @@ import { PublishEventResponse } from '@tennac-booking/sdk';
|
|
|
16
18
|
const instance: PublishEventResponse = {
|
|
17
19
|
event,
|
|
18
20
|
refundedBookingIds,
|
|
21
|
+
userBooking,
|
|
22
|
+
needsToSetupPaymentMethod,
|
|
19
23
|
};
|
|
20
24
|
```
|
|
21
25
|
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
# RecurringDefinitionResponse
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**id** | **string** | | [default to undefined]
|
|
9
|
+
**clubId** | **string** | | [optional] [default to undefined]
|
|
10
|
+
**title** | **string** | | [default to undefined]
|
|
11
|
+
**baseStartDate** | **string** | | [default to undefined]
|
|
12
|
+
**baseEndDate** | **string** | | [default to undefined]
|
|
13
|
+
**recurringType** | **string** | | [default to undefined]
|
|
14
|
+
**recurrenceEndDate** | **string** | | [optional] [default to undefined]
|
|
15
|
+
**isActive** | **boolean** | | [optional] [default to undefined]
|
|
16
|
+
|
|
17
|
+
## Example
|
|
18
|
+
|
|
19
|
+
```typescript
|
|
20
|
+
import { RecurringDefinitionResponse } from '@tennac-booking/sdk';
|
|
21
|
+
|
|
22
|
+
const instance: RecurringDefinitionResponse = {
|
|
23
|
+
id,
|
|
24
|
+
clubId,
|
|
25
|
+
title,
|
|
26
|
+
baseStartDate,
|
|
27
|
+
baseEndDate,
|
|
28
|
+
recurringType,
|
|
29
|
+
recurrenceEndDate,
|
|
30
|
+
isActive,
|
|
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)
|
|
@@ -7,7 +7,6 @@ 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]
|
|
11
10
|
|
|
12
11
|
## Example
|
|
13
12
|
|
|
@@ -17,7 +16,6 @@ import { SendSubscriptionInvitationRequest } from '@tennac-booking/sdk';
|
|
|
17
16
|
const instance: SendSubscriptionInvitationRequest = {
|
|
18
17
|
userId,
|
|
19
18
|
productId,
|
|
20
|
-
priceId,
|
|
21
19
|
};
|
|
22
20
|
```
|
|
23
21
|
|
|
@@ -9,13 +9,10 @@ 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** | | [
|
|
12
|
+
**amountInCents** | **number** | | [default to undefined]
|
|
13
13
|
**currency** | **string** | | [default to undefined]
|
|
14
|
-
**prices** | [**Array<PlanPrice>**](PlanPrice.md) | | [default to undefined]
|
|
15
14
|
**interval** | [**PlanInterval**](PlanInterval.md) | | [optional] [default to undefined]
|
|
16
15
|
**priceActive** | **boolean** | | [default to undefined]
|
|
17
|
-
**description** | **string** | | [optional] [default to undefined]
|
|
18
|
-
**discount** | [**SubscriptionPlanDiscountResponse**](SubscriptionPlanDiscountResponse.md) | | [optional] [default to undefined]
|
|
19
16
|
|
|
20
17
|
## Example
|
|
21
18
|
|
|
@@ -29,11 +26,8 @@ const instance: SubscriptionPlanResponse = {
|
|
|
29
26
|
priceId,
|
|
30
27
|
amountInCents,
|
|
31
28
|
currency,
|
|
32
|
-
prices,
|
|
33
29
|
interval,
|
|
34
30
|
priceActive,
|
|
35
|
-
description,
|
|
36
|
-
discount,
|
|
37
31
|
};
|
|
38
32
|
```
|
|
39
33
|
|
|
@@ -4,64 +4,10 @@ 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 | |
|
|
8
7
|
|[**createPlan**](#createplan) | **POST** /api/subscriptions/plans | |
|
|
9
8
|
|[**deletePlan**](#deleteplan) | **DELETE** /api/subscriptions/plans/{productId} | |
|
|
10
9
|
|[**updatePlan**](#updateplan) | **PUT** /api/subscriptions/plans | |
|
|
11
10
|
|
|
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
|
-
|
|
65
11
|
# **createPlan**
|
|
66
12
|
> CreatePlan201Response createPlan(createSubscriptionPlanRequest)
|
|
67
13
|
|
|
@@ -119,7 +65,7 @@ const { status, data } = await apiInstance.createPlan(
|
|
|
119
65
|
# **deletePlan**
|
|
120
66
|
> DeleteSubscriptionPlanResponse deletePlan()
|
|
121
67
|
|
|
122
|
-
Supprime un plan par productId (manager)
|
|
68
|
+
Supprime (archive) un plan par productId (manager)
|
|
123
69
|
|
|
124
70
|
### Example
|
|
125
71
|
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# UpdateRecurringDefinition200Response
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**ok** | **boolean** | | [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { UpdateRecurringDefinition200Response } from '@tennac-booking/sdk';
|
|
14
|
+
|
|
15
|
+
const instance: UpdateRecurringDefinition200Response = {
|
|
16
|
+
ok,
|
|
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)
|
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
# UpdateRecurringDefinitionRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**title** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**description** | **string** | | [optional] [default to undefined]
|
|
10
|
+
**photoUrl** | **string** | | [optional] [default to undefined]
|
|
11
|
+
**sportId** | **string** | | [optional] [default to undefined]
|
|
12
|
+
**courts** | **Array<string>** | | [optional] [default to undefined]
|
|
13
|
+
**levels** | **Array<string | null>** | | [optional] [default to undefined]
|
|
14
|
+
**sponsors** | [**Array<EventSponsor>**](EventSponsor.md) | | [optional] [default to undefined]
|
|
15
|
+
**visibilityType** | **string** | | [optional] [default to undefined]
|
|
16
|
+
**type** | **string** | | [optional] [default to undefined]
|
|
17
|
+
**participationType** | **string** | | [optional] [default to undefined]
|
|
18
|
+
**playerLimit** | **number** | | [optional] [default to undefined]
|
|
19
|
+
**teamLimit** | **number** | | [optional] [default to undefined]
|
|
20
|
+
**playersPerTeam** | **number** | | [optional] [default to undefined]
|
|
21
|
+
**price** | **number** | | [optional] [default to undefined]
|
|
22
|
+
**subscriberPrices** | [**Array<SubscriberPrice>**](SubscriberPrice.md) | | [optional] [default to undefined]
|
|
23
|
+
**baseStartDate** | **string** | | [optional] [default to undefined]
|
|
24
|
+
**baseEndDate** | **string** | | [optional] [default to undefined]
|
|
25
|
+
**recurringType** | **string** | | [optional] [default to undefined]
|
|
26
|
+
**recurrenceEndDate** | **string** | | [optional] [default to undefined]
|
|
27
|
+
|
|
28
|
+
## Example
|
|
29
|
+
|
|
30
|
+
```typescript
|
|
31
|
+
import { UpdateRecurringDefinitionRequest } from '@tennac-booking/sdk';
|
|
32
|
+
|
|
33
|
+
const instance: UpdateRecurringDefinitionRequest = {
|
|
34
|
+
title,
|
|
35
|
+
description,
|
|
36
|
+
photoUrl,
|
|
37
|
+
sportId,
|
|
38
|
+
courts,
|
|
39
|
+
levels,
|
|
40
|
+
sponsors,
|
|
41
|
+
visibilityType,
|
|
42
|
+
type,
|
|
43
|
+
participationType,
|
|
44
|
+
playerLimit,
|
|
45
|
+
teamLimit,
|
|
46
|
+
playersPerTeam,
|
|
47
|
+
price,
|
|
48
|
+
subscriberPrices,
|
|
49
|
+
baseStartDate,
|
|
50
|
+
baseEndDate,
|
|
51
|
+
recurringType,
|
|
52
|
+
recurrenceEndDate,
|
|
53
|
+
};
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
[[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
|
+
# UserEventParticipation
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**event** | [**UserEventSummary**](UserEventSummary.md) | | [default to undefined]
|
|
9
|
+
**booking** | [**EventBookingDetailSummary**](EventBookingDetailSummary.md) | | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { UserEventParticipation } from '@tennac-booking/sdk';
|
|
15
|
+
|
|
16
|
+
const instance: UserEventParticipation = {
|
|
17
|
+
event,
|
|
18
|
+
booking,
|
|
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,44 @@
|
|
|
1
|
+
# UserEventSummary
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**id** | **string** | | [default to undefined]
|
|
9
|
+
**clubId** | **string** | | [default to undefined]
|
|
10
|
+
**title** | **string** | | [default to undefined]
|
|
11
|
+
**description** | **string** | | [optional] [default to undefined]
|
|
12
|
+
**photoUrl** | **string** | | [optional] [default to undefined]
|
|
13
|
+
**startDate** | **string** | | [default to undefined]
|
|
14
|
+
**endDate** | **string** | | [default to undefined]
|
|
15
|
+
**participationType** | [**ParticipationType**](ParticipationType.md) | | [default to undefined]
|
|
16
|
+
**visibilityType** | [**VisibilityType**](VisibilityType.md) | | [default to undefined]
|
|
17
|
+
**isActive** | **boolean** | | [default to undefined]
|
|
18
|
+
**price** | **number** | | [optional] [default to undefined]
|
|
19
|
+
**sports** | **Array<string>** | | [optional] [default to undefined]
|
|
20
|
+
**courts** | **Array<string>** | | [optional] [default to undefined]
|
|
21
|
+
|
|
22
|
+
## Example
|
|
23
|
+
|
|
24
|
+
```typescript
|
|
25
|
+
import { UserEventSummary } from '@tennac-booking/sdk';
|
|
26
|
+
|
|
27
|
+
const instance: UserEventSummary = {
|
|
28
|
+
id,
|
|
29
|
+
clubId,
|
|
30
|
+
title,
|
|
31
|
+
description,
|
|
32
|
+
photoUrl,
|
|
33
|
+
startDate,
|
|
34
|
+
endDate,
|
|
35
|
+
participationType,
|
|
36
|
+
visibilityType,
|
|
37
|
+
isActive,
|
|
38
|
+
price,
|
|
39
|
+
sports,
|
|
40
|
+
courts,
|
|
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)
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# UserEventsResponse
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**total** | **number** | | [default to undefined]
|
|
9
|
+
**limit** | **number** | | [default to undefined]
|
|
10
|
+
**skip** | **number** | | [default to undefined]
|
|
11
|
+
**hasMore** | **boolean** | | [default to undefined]
|
|
12
|
+
**participations** | [**Array<UserEventParticipation>**](UserEventParticipation.md) | | [default to undefined]
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import { UserEventsResponse } from '@tennac-booking/sdk';
|
|
18
|
+
|
|
19
|
+
const instance: UserEventsResponse = {
|
|
20
|
+
total,
|
|
21
|
+
limit,
|
|
22
|
+
skip,
|
|
23
|
+
hasMore,
|
|
24
|
+
participations,
|
|
25
|
+
};
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
[[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
|
@@ -22,6 +22,7 @@ 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 | |
|
|
25
26
|
|[**getUserProfileById**](#getuserprofilebyid) | **GET** /api/users/profile/{id} | |
|
|
26
27
|
|[**listPlayers**](#listplayers) | **GET** /api/users/players | |
|
|
27
28
|
|[**login**](#login) | **POST** /api/users/login | |
|
|
@@ -911,6 +912,59 @@ const { status, data } = await apiInstance.getUserBookings(
|
|
|
911
912
|
- **Accept**: application/json
|
|
912
913
|
|
|
913
914
|
|
|
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
|
+
|
|
914
968
|
### HTTP response details
|
|
915
969
|
| Status code | Description | Response headers |
|
|
916
970
|
|-------------|-------------|------------------|
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# VisibilityType
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Enum
|
|
5
|
+
|
|
6
|
+
* `Public` (value: `'public'`)
|
|
7
|
+
|
|
8
|
+
* `Private` (value: `'private'`)
|
|
9
|
+
|
|
10
|
+
* `Invitation` (value: `'invitation'`)
|
|
11
|
+
|
|
12
|
+
[[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