@tennac-booking/sdk 1.0.215 → 1.0.217
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 +9 -0
- package/README.md +11 -0
- package/api.ts +541 -0
- package/dist/api.d.ts +440 -0
- package/dist/api.js +165 -5
- package/dist/esm/api.d.ts +440 -0
- package/dist/esm/api.js +160 -0
- package/docs/MarkNotificationsReadRequest.md +22 -0
- package/docs/MarkNotificationsReadResponse.md +20 -0
- package/docs/NotificationData.md +22 -0
- package/docs/NotificationParticipantPreview.md +22 -0
- package/docs/NotificationPreview.md +60 -0
- package/docs/NotificationResponse.md +36 -0
- package/docs/NotificationType.md +26 -0
- package/docs/UserNotificationsResponse.md +22 -0
- package/docs/UserNotificationsResponseMeta.md +28 -0
- package/docs/UsersApi.md +109 -0
- package/package.json +1 -1
package/dist/esm/api.js
CHANGED
|
@@ -245,6 +245,23 @@ export const InvoiceStatusSETUPPENDING = {
|
|
|
245
245
|
export const InvoiceStatusSETUPSUCCESS = {
|
|
246
246
|
SetupSuccess: 'setup_success'
|
|
247
247
|
};
|
|
248
|
+
/**
|
|
249
|
+
*
|
|
250
|
+
* @export
|
|
251
|
+
* @enum {string}
|
|
252
|
+
*/
|
|
253
|
+
export const NotificationType = {
|
|
254
|
+
BookingCreated: 'booking_created',
|
|
255
|
+
BookingSetupRequired: 'booking_setup_required',
|
|
256
|
+
BookingCancelled: 'booking_cancelled',
|
|
257
|
+
BookingReminder: 'booking_reminder',
|
|
258
|
+
EventRegistrationConfirmed: 'event_registration_confirmed',
|
|
259
|
+
EventReminder: 'event_reminder',
|
|
260
|
+
OpenBookingJoined: 'open_booking_joined',
|
|
261
|
+
OpenBookingJoinConfirmed: 'open_booking_join_confirmed',
|
|
262
|
+
WaitlistSpotAvailable: 'waitlist_spot_available',
|
|
263
|
+
WaitlistConfirmed: 'waitlist_confirmed'
|
|
264
|
+
};
|
|
248
265
|
export const PartialPublicAccessSettingsPaymentModeEnum = {
|
|
249
266
|
Free: 'free',
|
|
250
267
|
AccessFee: 'access_fee',
|
|
@@ -14287,6 +14304,47 @@ export const UsersApiAxiosParamCreator = function (configuration) {
|
|
|
14287
14304
|
options: localVarRequestOptions,
|
|
14288
14305
|
};
|
|
14289
14306
|
}),
|
|
14307
|
+
/**
|
|
14308
|
+
*
|
|
14309
|
+
* @param {number} [limit]
|
|
14310
|
+
* @param {number} [skip]
|
|
14311
|
+
* @param {any} [includeRead]
|
|
14312
|
+
* @param {*} [options] Override http request option.
|
|
14313
|
+
* @throws {RequiredError}
|
|
14314
|
+
*/
|
|
14315
|
+
getUserNotifications: (limit_1, skip_1, includeRead_1, ...args_1) => __awaiter(this, [limit_1, skip_1, includeRead_1, ...args_1], void 0, function* (limit, skip, includeRead, options = {}) {
|
|
14316
|
+
const localVarPath = `/api/users/me/notifications`;
|
|
14317
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
14318
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
14319
|
+
let baseOptions;
|
|
14320
|
+
if (configuration) {
|
|
14321
|
+
baseOptions = configuration.baseOptions;
|
|
14322
|
+
}
|
|
14323
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
14324
|
+
const localVarHeaderParameter = {};
|
|
14325
|
+
const localVarQueryParameter = {};
|
|
14326
|
+
// authentication bearerAuth required
|
|
14327
|
+
// http bearer authentication required
|
|
14328
|
+
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
14329
|
+
if (limit !== undefined) {
|
|
14330
|
+
localVarQueryParameter['limit'] = limit;
|
|
14331
|
+
}
|
|
14332
|
+
if (skip !== undefined) {
|
|
14333
|
+
localVarQueryParameter['skip'] = skip;
|
|
14334
|
+
}
|
|
14335
|
+
if (includeRead !== undefined) {
|
|
14336
|
+
for (const [key, value] of Object.entries(includeRead)) {
|
|
14337
|
+
localVarQueryParameter[key] = value;
|
|
14338
|
+
}
|
|
14339
|
+
}
|
|
14340
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
14341
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
14342
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
14343
|
+
return {
|
|
14344
|
+
url: toPathString(localVarUrlObj),
|
|
14345
|
+
options: localVarRequestOptions,
|
|
14346
|
+
};
|
|
14347
|
+
}),
|
|
14290
14348
|
/**
|
|
14291
14349
|
*
|
|
14292
14350
|
* @param {string} id
|
|
@@ -14474,6 +14532,38 @@ export const UsersApiAxiosParamCreator = function (configuration) {
|
|
|
14474
14532
|
options: localVarRequestOptions,
|
|
14475
14533
|
};
|
|
14476
14534
|
}),
|
|
14535
|
+
/**
|
|
14536
|
+
*
|
|
14537
|
+
* @param {MarkNotificationsReadRequest} markNotificationsReadRequest
|
|
14538
|
+
* @param {*} [options] Override http request option.
|
|
14539
|
+
* @throws {RequiredError}
|
|
14540
|
+
*/
|
|
14541
|
+
markNotificationsRead: (markNotificationsReadRequest_1, ...args_1) => __awaiter(this, [markNotificationsReadRequest_1, ...args_1], void 0, function* (markNotificationsReadRequest, options = {}) {
|
|
14542
|
+
// verify required parameter 'markNotificationsReadRequest' is not null or undefined
|
|
14543
|
+
assertParamExists('markNotificationsRead', 'markNotificationsReadRequest', markNotificationsReadRequest);
|
|
14544
|
+
const localVarPath = `/api/users/me/notifications/read`;
|
|
14545
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
14546
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
14547
|
+
let baseOptions;
|
|
14548
|
+
if (configuration) {
|
|
14549
|
+
baseOptions = configuration.baseOptions;
|
|
14550
|
+
}
|
|
14551
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
14552
|
+
const localVarHeaderParameter = {};
|
|
14553
|
+
const localVarQueryParameter = {};
|
|
14554
|
+
// authentication bearerAuth required
|
|
14555
|
+
// http bearer authentication required
|
|
14556
|
+
yield setBearerAuthToObject(localVarHeaderParameter, configuration);
|
|
14557
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
14558
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
14559
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
14560
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
14561
|
+
localVarRequestOptions.data = serializeDataIfNeeded(markNotificationsReadRequest, localVarRequestOptions, configuration);
|
|
14562
|
+
return {
|
|
14563
|
+
url: toPathString(localVarUrlObj),
|
|
14564
|
+
options: localVarRequestOptions,
|
|
14565
|
+
};
|
|
14566
|
+
}),
|
|
14477
14567
|
/**
|
|
14478
14568
|
*
|
|
14479
14569
|
* @param {RefreshTokenRequestBody} refreshTokenRequestBody
|
|
@@ -15375,6 +15465,23 @@ export const UsersApiFp = function (configuration) {
|
|
|
15375
15465
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
15376
15466
|
});
|
|
15377
15467
|
},
|
|
15468
|
+
/**
|
|
15469
|
+
*
|
|
15470
|
+
* @param {number} [limit]
|
|
15471
|
+
* @param {number} [skip]
|
|
15472
|
+
* @param {any} [includeRead]
|
|
15473
|
+
* @param {*} [options] Override http request option.
|
|
15474
|
+
* @throws {RequiredError}
|
|
15475
|
+
*/
|
|
15476
|
+
getUserNotifications(limit, skip, includeRead, options) {
|
|
15477
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
15478
|
+
var _a, _b, _c;
|
|
15479
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getUserNotifications(limit, skip, includeRead, options);
|
|
15480
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
15481
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['UsersApi.getUserNotifications']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
15482
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
15483
|
+
});
|
|
15484
|
+
},
|
|
15378
15485
|
/**
|
|
15379
15486
|
*
|
|
15380
15487
|
* @param {string} id
|
|
@@ -15459,6 +15566,21 @@ export const UsersApiFp = function (configuration) {
|
|
|
15459
15566
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
15460
15567
|
});
|
|
15461
15568
|
},
|
|
15569
|
+
/**
|
|
15570
|
+
*
|
|
15571
|
+
* @param {MarkNotificationsReadRequest} markNotificationsReadRequest
|
|
15572
|
+
* @param {*} [options] Override http request option.
|
|
15573
|
+
* @throws {RequiredError}
|
|
15574
|
+
*/
|
|
15575
|
+
markNotificationsRead(markNotificationsReadRequest, options) {
|
|
15576
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
15577
|
+
var _a, _b, _c;
|
|
15578
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.markNotificationsRead(markNotificationsReadRequest, options);
|
|
15579
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
15580
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['UsersApi.markNotificationsRead']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
15581
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
15582
|
+
});
|
|
15583
|
+
},
|
|
15462
15584
|
/**
|
|
15463
15585
|
*
|
|
15464
15586
|
* @param {RefreshTokenRequestBody} refreshTokenRequestBody
|
|
@@ -15927,6 +16049,15 @@ export const UsersApiFactory = function (configuration, basePath, axios) {
|
|
|
15927
16049
|
getUserEvents(requestParameters = {}, options) {
|
|
15928
16050
|
return localVarFp.getUserEvents(requestParameters.limit, requestParameters.skip, options).then((request) => request(axios, basePath));
|
|
15929
16051
|
},
|
|
16052
|
+
/**
|
|
16053
|
+
*
|
|
16054
|
+
* @param {UsersApiGetUserNotificationsRequest} requestParameters Request parameters.
|
|
16055
|
+
* @param {*} [options] Override http request option.
|
|
16056
|
+
* @throws {RequiredError}
|
|
16057
|
+
*/
|
|
16058
|
+
getUserNotifications(requestParameters = {}, options) {
|
|
16059
|
+
return localVarFp.getUserNotifications(requestParameters.limit, requestParameters.skip, requestParameters.includeRead, options).then((request) => request(axios, basePath));
|
|
16060
|
+
},
|
|
15930
16061
|
/**
|
|
15931
16062
|
*
|
|
15932
16063
|
* @param {UsersApiGetUserProfileByIdRequest} requestParameters Request parameters.
|
|
@@ -15972,6 +16103,15 @@ export const UsersApiFactory = function (configuration, basePath, axios) {
|
|
|
15972
16103
|
loginClubMember(requestParameters, options) {
|
|
15973
16104
|
return localVarFp.loginClubMember(requestParameters.loginRequestBody, options).then((request) => request(axios, basePath));
|
|
15974
16105
|
},
|
|
16106
|
+
/**
|
|
16107
|
+
*
|
|
16108
|
+
* @param {UsersApiMarkNotificationsReadRequest} requestParameters Request parameters.
|
|
16109
|
+
* @param {*} [options] Override http request option.
|
|
16110
|
+
* @throws {RequiredError}
|
|
16111
|
+
*/
|
|
16112
|
+
markNotificationsRead(requestParameters, options) {
|
|
16113
|
+
return localVarFp.markNotificationsRead(requestParameters.markNotificationsReadRequest, options).then((request) => request(axios, basePath));
|
|
16114
|
+
},
|
|
15975
16115
|
/**
|
|
15976
16116
|
*
|
|
15977
16117
|
* @param {UsersApiRefreshTokenRequest} requestParameters Request parameters.
|
|
@@ -16343,6 +16483,16 @@ export class UsersApi extends BaseAPI {
|
|
|
16343
16483
|
getUserEvents(requestParameters = {}, options) {
|
|
16344
16484
|
return UsersApiFp(this.configuration).getUserEvents(requestParameters.limit, requestParameters.skip, options).then((request) => request(this.axios, this.basePath));
|
|
16345
16485
|
}
|
|
16486
|
+
/**
|
|
16487
|
+
*
|
|
16488
|
+
* @param {UsersApiGetUserNotificationsRequest} requestParameters Request parameters.
|
|
16489
|
+
* @param {*} [options] Override http request option.
|
|
16490
|
+
* @throws {RequiredError}
|
|
16491
|
+
* @memberof UsersApi
|
|
16492
|
+
*/
|
|
16493
|
+
getUserNotifications(requestParameters = {}, options) {
|
|
16494
|
+
return UsersApiFp(this.configuration).getUserNotifications(requestParameters.limit, requestParameters.skip, requestParameters.includeRead, options).then((request) => request(this.axios, this.basePath));
|
|
16495
|
+
}
|
|
16346
16496
|
/**
|
|
16347
16497
|
*
|
|
16348
16498
|
* @param {UsersApiGetUserProfileByIdRequest} requestParameters Request parameters.
|
|
@@ -16393,6 +16543,16 @@ export class UsersApi extends BaseAPI {
|
|
|
16393
16543
|
loginClubMember(requestParameters, options) {
|
|
16394
16544
|
return UsersApiFp(this.configuration).loginClubMember(requestParameters.loginRequestBody, options).then((request) => request(this.axios, this.basePath));
|
|
16395
16545
|
}
|
|
16546
|
+
/**
|
|
16547
|
+
*
|
|
16548
|
+
* @param {UsersApiMarkNotificationsReadRequest} requestParameters Request parameters.
|
|
16549
|
+
* @param {*} [options] Override http request option.
|
|
16550
|
+
* @throws {RequiredError}
|
|
16551
|
+
* @memberof UsersApi
|
|
16552
|
+
*/
|
|
16553
|
+
markNotificationsRead(requestParameters, options) {
|
|
16554
|
+
return UsersApiFp(this.configuration).markNotificationsRead(requestParameters.markNotificationsReadRequest, options).then((request) => request(this.axios, this.basePath));
|
|
16555
|
+
}
|
|
16396
16556
|
/**
|
|
16397
16557
|
*
|
|
16398
16558
|
* @param {UsersApiRefreshTokenRequest} requestParameters Request parameters.
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# MarkNotificationsReadRequest
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**notificationIds** | **Array<string>** | | [optional] [default to undefined]
|
|
9
|
+
**readAll** | **boolean** | | [optional] [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { MarkNotificationsReadRequest } from '@tennac-booking/sdk';
|
|
15
|
+
|
|
16
|
+
const instance: MarkNotificationsReadRequest = {
|
|
17
|
+
notificationIds,
|
|
18
|
+
readAll,
|
|
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,20 @@
|
|
|
1
|
+
# MarkNotificationsReadResponse
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**updatedCount** | **number** | | [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { MarkNotificationsReadResponse } from '@tennac-booking/sdk';
|
|
14
|
+
|
|
15
|
+
const instance: MarkNotificationsReadResponse = {
|
|
16
|
+
updatedCount,
|
|
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,22 @@
|
|
|
1
|
+
# NotificationData
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**pathname** | **string** | | [default to undefined]
|
|
9
|
+
**params** | **{ [key: string]: string; }** | Construct a type with a set of properties K of type T | [optional] [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { NotificationData } from '@tennac-booking/sdk';
|
|
15
|
+
|
|
16
|
+
const instance: NotificationData = {
|
|
17
|
+
pathname,
|
|
18
|
+
params,
|
|
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,22 @@
|
|
|
1
|
+
# NotificationParticipantPreview
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**id** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**name** | **string** | | [optional] [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { NotificationParticipantPreview } from '@tennac-booking/sdk';
|
|
15
|
+
|
|
16
|
+
const instance: NotificationParticipantPreview = {
|
|
17
|
+
id,
|
|
18
|
+
name,
|
|
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,60 @@
|
|
|
1
|
+
# NotificationPreview
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**bookingId** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**eventId** | **string** | | [optional] [default to undefined]
|
|
10
|
+
**eventBookingId** | **string** | | [optional] [default to undefined]
|
|
11
|
+
**clubId** | **string** | | [optional] [default to undefined]
|
|
12
|
+
**clubName** | **string** | | [optional] [default to undefined]
|
|
13
|
+
**clubPicture** | **string** | | [optional] [default to undefined]
|
|
14
|
+
**courtName** | **string** | | [optional] [default to undefined]
|
|
15
|
+
**eventName** | **string** | | [optional] [default to undefined]
|
|
16
|
+
**startDate** | **string** | | [optional] [default to undefined]
|
|
17
|
+
**endDate** | **string** | | [optional] [default to undefined]
|
|
18
|
+
**reminderDelayHours** | **number** | | [optional] [default to undefined]
|
|
19
|
+
**reason** | **string** | | [optional] [default to undefined]
|
|
20
|
+
**joinerId** | **string** | | [optional] [default to undefined]
|
|
21
|
+
**joinerName** | **string** | | [optional] [default to undefined]
|
|
22
|
+
**targetLabel** | **string** | | [optional] [default to undefined]
|
|
23
|
+
**targetType** | **string** | | [optional] [default to undefined]
|
|
24
|
+
**targetId** | **string** | | [optional] [default to undefined]
|
|
25
|
+
**priceInCents** | **number** | | [optional] [default to undefined]
|
|
26
|
+
**expiresAt** | **string** | | [optional] [default to undefined]
|
|
27
|
+
**waitingListPaymentHoldDuration** | **number** | | [optional] [default to undefined]
|
|
28
|
+
**participants** | [**Array<NotificationParticipantPreview>**](NotificationParticipantPreview.md) | | [optional] [default to undefined]
|
|
29
|
+
|
|
30
|
+
## Example
|
|
31
|
+
|
|
32
|
+
```typescript
|
|
33
|
+
import { NotificationPreview } from '@tennac-booking/sdk';
|
|
34
|
+
|
|
35
|
+
const instance: NotificationPreview = {
|
|
36
|
+
bookingId,
|
|
37
|
+
eventId,
|
|
38
|
+
eventBookingId,
|
|
39
|
+
clubId,
|
|
40
|
+
clubName,
|
|
41
|
+
clubPicture,
|
|
42
|
+
courtName,
|
|
43
|
+
eventName,
|
|
44
|
+
startDate,
|
|
45
|
+
endDate,
|
|
46
|
+
reminderDelayHours,
|
|
47
|
+
reason,
|
|
48
|
+
joinerId,
|
|
49
|
+
joinerName,
|
|
50
|
+
targetLabel,
|
|
51
|
+
targetType,
|
|
52
|
+
targetId,
|
|
53
|
+
priceInCents,
|
|
54
|
+
expiresAt,
|
|
55
|
+
waitingListPaymentHoldDuration,
|
|
56
|
+
participants,
|
|
57
|
+
};
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
[[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,36 @@
|
|
|
1
|
+
# NotificationResponse
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**id** | **string** | | [default to undefined]
|
|
9
|
+
**type** | [**NotificationType**](NotificationType.md) | | [default to undefined]
|
|
10
|
+
**title** | **string** | | [default to undefined]
|
|
11
|
+
**message** | **string** | | [default to undefined]
|
|
12
|
+
**data** | [**NotificationData**](NotificationData.md) | | [optional] [default to undefined]
|
|
13
|
+
**preview** | [**NotificationPreview**](NotificationPreview.md) | | [optional] [default to undefined]
|
|
14
|
+
**createdAt** | **string** | | [default to undefined]
|
|
15
|
+
**readAt** | **string** | | [optional] [default to undefined]
|
|
16
|
+
**isRead** | **boolean** | | [default to undefined]
|
|
17
|
+
|
|
18
|
+
## Example
|
|
19
|
+
|
|
20
|
+
```typescript
|
|
21
|
+
import { NotificationResponse } from '@tennac-booking/sdk';
|
|
22
|
+
|
|
23
|
+
const instance: NotificationResponse = {
|
|
24
|
+
id,
|
|
25
|
+
type,
|
|
26
|
+
title,
|
|
27
|
+
message,
|
|
28
|
+
data,
|
|
29
|
+
preview,
|
|
30
|
+
createdAt,
|
|
31
|
+
readAt,
|
|
32
|
+
isRead,
|
|
33
|
+
};
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
[[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
|
+
# NotificationType
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Enum
|
|
5
|
+
|
|
6
|
+
* `BookingCreated` (value: `'booking_created'`)
|
|
7
|
+
|
|
8
|
+
* `BookingSetupRequired` (value: `'booking_setup_required'`)
|
|
9
|
+
|
|
10
|
+
* `BookingCancelled` (value: `'booking_cancelled'`)
|
|
11
|
+
|
|
12
|
+
* `BookingReminder` (value: `'booking_reminder'`)
|
|
13
|
+
|
|
14
|
+
* `EventRegistrationConfirmed` (value: `'event_registration_confirmed'`)
|
|
15
|
+
|
|
16
|
+
* `EventReminder` (value: `'event_reminder'`)
|
|
17
|
+
|
|
18
|
+
* `OpenBookingJoined` (value: `'open_booking_joined'`)
|
|
19
|
+
|
|
20
|
+
* `OpenBookingJoinConfirmed` (value: `'open_booking_join_confirmed'`)
|
|
21
|
+
|
|
22
|
+
* `WaitlistSpotAvailable` (value: `'waitlist_spot_available'`)
|
|
23
|
+
|
|
24
|
+
* `WaitlistConfirmed` (value: `'waitlist_confirmed'`)
|
|
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
|
+
# UserNotificationsResponse
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**notifications** | [**Array<NotificationResponse>**](NotificationResponse.md) | | [default to undefined]
|
|
9
|
+
**meta** | [**UserNotificationsResponseMeta**](UserNotificationsResponseMeta.md) | | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { UserNotificationsResponse } from '@tennac-booking/sdk';
|
|
15
|
+
|
|
16
|
+
const instance: UserNotificationsResponse = {
|
|
17
|
+
notifications,
|
|
18
|
+
meta,
|
|
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,28 @@
|
|
|
1
|
+
# UserNotificationsResponseMeta
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**unreadCount** | **number** | | [default to undefined]
|
|
9
|
+
**hasMore** | **boolean** | | [default to undefined]
|
|
10
|
+
**total** | **number** | | [default to undefined]
|
|
11
|
+
**skip** | **number** | | [default to undefined]
|
|
12
|
+
**limit** | **number** | | [default to undefined]
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import { UserNotificationsResponseMeta } from '@tennac-booking/sdk';
|
|
18
|
+
|
|
19
|
+
const instance: UserNotificationsResponseMeta = {
|
|
20
|
+
unreadCount,
|
|
21
|
+
hasMore,
|
|
22
|
+
total,
|
|
23
|
+
skip,
|
|
24
|
+
limit,
|
|
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
|
@@ -24,11 +24,13 @@ All URIs are relative to *http://localhost*
|
|
|
24
24
|
|[**getPlayerCategories**](#getplayercategories) | **GET** /api/users/players/categories | |
|
|
25
25
|
|[**getUserBookings**](#getuserbookings) | **GET** /api/users/me/bookings | |
|
|
26
26
|
|[**getUserEvents**](#getuserevents) | **GET** /api/users/me/events | |
|
|
27
|
+
|[**getUserNotifications**](#getusernotifications) | **GET** /api/users/me/notifications | |
|
|
27
28
|
|[**getUserProfileById**](#getuserprofilebyid) | **GET** /api/users/profile/{id} | |
|
|
28
29
|
|[**leaveBooking**](#leavebooking) | **DELETE** /api/users/me/bookings/{bookingId}/leave | |
|
|
29
30
|
|[**listPlayers**](#listplayers) | **GET** /api/users/players | |
|
|
30
31
|
|[**login**](#login) | **POST** /api/users/login | |
|
|
31
32
|
|[**loginClubMember**](#loginclubmember) | **POST** /api/users/club-members/login | |
|
|
33
|
+
|[**markNotificationsRead**](#marknotificationsread) | **POST** /api/users/me/notifications/read | |
|
|
32
34
|
|[**refreshToken**](#refreshtoken) | **POST** /api/users/refresh-token | |
|
|
33
35
|
|[**register**](#register) | **POST** /api/users | |
|
|
34
36
|
|[**registerFromApp**](#registerfromapp) | **POST** /api/users/register-app | |
|
|
@@ -1023,6 +1025,62 @@ const { status, data } = await apiInstance.getUserEvents(
|
|
|
1023
1025
|
- **Accept**: application/json
|
|
1024
1026
|
|
|
1025
1027
|
|
|
1028
|
+
### HTTP response details
|
|
1029
|
+
| Status code | Description | Response headers |
|
|
1030
|
+
|-------------|-------------|------------------|
|
|
1031
|
+
|**200** | Ok | - |
|
|
1032
|
+
|
|
1033
|
+
[[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)
|
|
1034
|
+
|
|
1035
|
+
# **getUserNotifications**
|
|
1036
|
+
> UserNotificationsResponse getUserNotifications()
|
|
1037
|
+
|
|
1038
|
+
|
|
1039
|
+
### Example
|
|
1040
|
+
|
|
1041
|
+
```typescript
|
|
1042
|
+
import {
|
|
1043
|
+
UsersApi,
|
|
1044
|
+
Configuration
|
|
1045
|
+
} from '@tennac-booking/sdk';
|
|
1046
|
+
|
|
1047
|
+
const configuration = new Configuration();
|
|
1048
|
+
const apiInstance = new UsersApi(configuration);
|
|
1049
|
+
|
|
1050
|
+
let limit: number; // (optional) (default to undefined)
|
|
1051
|
+
let skip: number; // (optional) (default to undefined)
|
|
1052
|
+
let includeRead: any; // (optional) (default to undefined)
|
|
1053
|
+
|
|
1054
|
+
const { status, data } = await apiInstance.getUserNotifications(
|
|
1055
|
+
limit,
|
|
1056
|
+
skip,
|
|
1057
|
+
includeRead
|
|
1058
|
+
);
|
|
1059
|
+
```
|
|
1060
|
+
|
|
1061
|
+
### Parameters
|
|
1062
|
+
|
|
1063
|
+
|Name | Type | Description | Notes|
|
|
1064
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1065
|
+
| **limit** | [**number**] | | (optional) defaults to undefined|
|
|
1066
|
+
| **skip** | [**number**] | | (optional) defaults to undefined|
|
|
1067
|
+
| **includeRead** | **any** | | (optional) defaults to undefined|
|
|
1068
|
+
|
|
1069
|
+
|
|
1070
|
+
### Return type
|
|
1071
|
+
|
|
1072
|
+
**UserNotificationsResponse**
|
|
1073
|
+
|
|
1074
|
+
### Authorization
|
|
1075
|
+
|
|
1076
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1077
|
+
|
|
1078
|
+
### HTTP request headers
|
|
1079
|
+
|
|
1080
|
+
- **Content-Type**: Not defined
|
|
1081
|
+
- **Accept**: application/json
|
|
1082
|
+
|
|
1083
|
+
|
|
1026
1084
|
### HTTP response details
|
|
1027
1085
|
| Status code | Description | Response headers |
|
|
1028
1086
|
|-------------|-------------|------------------|
|
|
@@ -1306,6 +1364,57 @@ No authorization required
|
|
|
1306
1364
|
- **Accept**: application/json
|
|
1307
1365
|
|
|
1308
1366
|
|
|
1367
|
+
### HTTP response details
|
|
1368
|
+
| Status code | Description | Response headers |
|
|
1369
|
+
|-------------|-------------|------------------|
|
|
1370
|
+
|**200** | Ok | - |
|
|
1371
|
+
|
|
1372
|
+
[[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)
|
|
1373
|
+
|
|
1374
|
+
# **markNotificationsRead**
|
|
1375
|
+
> MarkNotificationsReadResponse markNotificationsRead(markNotificationsReadRequest)
|
|
1376
|
+
|
|
1377
|
+
|
|
1378
|
+
### Example
|
|
1379
|
+
|
|
1380
|
+
```typescript
|
|
1381
|
+
import {
|
|
1382
|
+
UsersApi,
|
|
1383
|
+
Configuration,
|
|
1384
|
+
MarkNotificationsReadRequest
|
|
1385
|
+
} from '@tennac-booking/sdk';
|
|
1386
|
+
|
|
1387
|
+
const configuration = new Configuration();
|
|
1388
|
+
const apiInstance = new UsersApi(configuration);
|
|
1389
|
+
|
|
1390
|
+
let markNotificationsReadRequest: MarkNotificationsReadRequest; //
|
|
1391
|
+
|
|
1392
|
+
const { status, data } = await apiInstance.markNotificationsRead(
|
|
1393
|
+
markNotificationsReadRequest
|
|
1394
|
+
);
|
|
1395
|
+
```
|
|
1396
|
+
|
|
1397
|
+
### Parameters
|
|
1398
|
+
|
|
1399
|
+
|Name | Type | Description | Notes|
|
|
1400
|
+
|------------- | ------------- | ------------- | -------------|
|
|
1401
|
+
| **markNotificationsReadRequest** | **MarkNotificationsReadRequest**| | |
|
|
1402
|
+
|
|
1403
|
+
|
|
1404
|
+
### Return type
|
|
1405
|
+
|
|
1406
|
+
**MarkNotificationsReadResponse**
|
|
1407
|
+
|
|
1408
|
+
### Authorization
|
|
1409
|
+
|
|
1410
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
1411
|
+
|
|
1412
|
+
### HTTP request headers
|
|
1413
|
+
|
|
1414
|
+
- **Content-Type**: application/json
|
|
1415
|
+
- **Accept**: application/json
|
|
1416
|
+
|
|
1417
|
+
|
|
1309
1418
|
### HTTP response details
|
|
1310
1419
|
| Status code | Description | Response headers |
|
|
1311
1420
|
|-------------|-------------|------------------|
|