@tennac-booking/sdk/docs/UsersApi.md

OpenAPI client for @tennac-booking/sdk

# UsersApi

All URIs are relative to *http://localhost*

|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**acceptTerms**](#acceptterms) | **POST** /api/users/accept-terms | |
|[**addFavoriteClub**](#addfavoriteclub) | **POST** /api/users/me/favorite-clubs | |
|[**addFavoritePlayer**](#addfavoriteplayer) | **POST** /api/users/me/favoritesPlayers | |
|[**addOrganization**](#addorganization) | **POST** /api/users/me/add-organization | |
|[**changePassword**](#changepassword) | **PUT** /api/users/me/password | |
|[**completeRegister**](#completeregister) | **POST** /api/users/complete-register | |
|[**getAllUsers**](#getallusers) | **GET** /api/users | |
|[**getBookingDetail**](#getbookingdetail) | **GET** /api/users/me/booking-detail/{bookingId} | |
|[**getCurrentTerms**](#getcurrentterms) | **GET** /api/users/terms | |
|[**getEventBookingDetail**](#geteventbookingdetail) | **GET** /api/users/me/event-booking-detail/{eventBookingId} | |
|[**getFavoriteClubs**](#getfavoriteclubs) | **GET** /api/users/me/favorite-clubs | |
|[**getFavoritesPlayers**](#getfavoritesplayers) | **GET** /api/users/me/favoritesPlayers | |
|[**getFrequentlyPlayedWith**](#getfrequentlyplayedwith) | **GET** /api/users/me/frequentlyPlayedWith | |
|[**getFrequentlyVisitedClub**](#getfrequentlyvisitedclub) | **GET** /api/users/me/frequentlyVisitedClub | |
|[**getMe**](#getme) | **GET** /api/users/me | |
|[**getMyClubMemberships**](#getmyclubmemberships) | **GET** /api/users/me/club-memberships | |
|[**getNearestClubs**](#getnearestclubs) | **GET** /api/users/me/nearest-clubs | |
|[**getNearestClubsFromCoordinates**](#getnearestclubsfromcoordinates) | **GET** /api/users/nearest-clubs/coordinates | |
|[**getNearestUsers**](#getnearestusers) | **GET** /api/users/me/nearest-players | |
|[**getNearestUsersFromCoordinates**](#getnearestusersfromcoordinates) | **GET** /api/users/nearest-players/coordinates | |
|[**getPlayerCategories**](#getplayercategories) | **GET** /api/users/players/categories | |
|[**getUserBookings**](#getuserbookings) | **GET** /api/users/me/bookings | |
|[**getUserEvents**](#getuserevents) | **GET** /api/users/me/events | |
|[**getUserNotifications**](#getusernotifications) | **GET** /api/users/me/notifications | |
|[**getUserProfileById**](#getuserprofilebyid) | **GET** /api/users/profile/{id} | |
|[**leaveBooking**](#leavebooking) | **DELETE** /api/users/me/bookings/{bookingId}/leave | |
|[**listPlayers**](#listplayers) | **GET** /api/users/players | |
|[**login**](#login) | **POST** /api/users/login | |
|[**loginClubMember**](#loginclubmember) | **POST** /api/users/club-members/login | |
|[**markNotificationsRead**](#marknotificationsread) | **POST** /api/users/me/notifications/read | |
|[**migrateSubscription**](#migratesubscription) | **POST** /api/users/migrate-subscriptions | |
|[**migrateUser**](#migrateuser) | **POST** /api/users/migrate | |
|[**refreshToken**](#refreshtoken) | **POST** /api/users/refresh-token | |
|[**register**](#register) | **POST** /api/users | |
|[**registerFromApp**](#registerfromapp) | **POST** /api/users/register-app | |
|[**removeFavoriteClub**](#removefavoriteclub) | **DELETE** /api/users/me/favorite-clubs/{clubId} | |
|[**removeFavoritePlayer**](#removefavoriteplayer) | **DELETE** /api/users/me/favoritesPlayers/{favoritePlayerId} | |
|[**removeOrganization**](#removeorganization) | **POST** /api/users/me/remove-organization | |
|[**requestAccountDeletion**](#requestaccountdeletion) | **POST** /api/users/me/request-account-deletion | |
|[**requestEmailVerification**](#requestemailverification) | **POST** /api/users/me/request-email-verification | |
|[**requestOrganizationCode**](#requestorganizationcode) | **POST** /api/users/me/request-organization-code | |
|[**requestPasswordReset**](#requestpasswordreset) | **POST** /api/users/request-password-reset | |
|[**resetPassword**](#resetpassword) | **POST** /api/users/reset-password | |
|[**searchPartner**](#searchpartner) | **GET** /api/users/searchPartner | |
|[**signInOrSignUpWithGoogle**](#signinorsignupwithgoogle) | **POST** /api/users/googleSignin | |
|[**updateCustomer**](#updatecustomer) | **PUT** /api/users/me/customer | |
|[**updateLevelBySports**](#updatelevelbysports) | **PUT** /api/users/me/level-by-sports | |
|[**updateMe**](#updateme) | **PUT** /api/users/me | |
|[**updateProfilePicture**](#updateprofilepicture) | **PUT** /api/users/me/profile-picture | |
|[**verifyEmail**](#verifyemail) | **POST** /api/users/verify-email | |
|[**verifyOrganization**](#verifyorganization) | **POST** /api/users/verify-organization | |
|[**verifyOrganizationCode**](#verifyorganizationcode) | **POST** /api/users/me/verify-organization-code | |

# **acceptTerms**
> AcceptTermsResponse acceptTerms(acceptTermsRequestBody)

Accepter les CGU

### Example

```typescript
import {
    UsersApi,
    Configuration,
    AcceptTermsRequestBody
} from '@tennac-booking/sdk';

const configuration = new Configuration();
const apiInstance = new UsersApi(configuration);

let acceptTermsRequestBody: AcceptTermsRequestBody; //

const { status, data } = await apiInstance.acceptTerms(
    acceptTermsRequestBody
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **acceptTermsRequestBody** | **AcceptTermsRequestBody**|  | |


### Return type

**AcceptTermsResponse**

### Authorization

[bearerAuth](../README.md#bearerAuth)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | CGU acceptées |  -  |
|**400** | Requête invalide |  -  |
|**404** | CGU non trouvées |  -  |

[[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)

# **addFavoriteClub**
> FavoriteClubMutationResponse addFavoriteClub(favoriteClubRequestBody)


### Example

```typescript
import {
    UsersApi,
    Configuration,
    FavoriteClubRequestBody
} from '@tennac-booking/sdk';

const configuration = new Configuration();
const apiInstance = new UsersApi(configuration);

let favoriteClubRequestBody: FavoriteClubRequestBody; //

const { status, data } = await apiInstance.addFavoriteClub(
    favoriteClubRequestBody
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **favoriteClubRequestBody** | **FavoriteClubRequestBody**|  | |


### Return type

**FavoriteClubMutationResponse**

### Authorization

[bearerAuth](../README.md#bearerAuth)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Ok |  -  |

[[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)

# **addFavoritePlayer**
> FavoritePlayerMutationResponse addFavoritePlayer(favoritePlayerRequestBody)


### Example

```typescript
import {
    UsersApi,
    Configuration,
    FavoritePlayerRequestBody
} from '@tennac-booking/sdk';

const configuration = new Configuration();
const apiInstance = new UsersApi(configuration);

let favoritePlayerRequestBody: FavoritePlayerRequestBody; //

const { status, data } = await apiInstance.addFavoritePlayer(
    favoritePlayerRequestBody
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **favoritePlayerRequestBody** | **FavoritePlayerRequestBody**|  | |


### Return type

**FavoritePlayerMutationResponse**

### Authorization

[bearerAuth](../README.md#bearerAuth)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Ok |  -  |

[[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)

# **addOrganization**
> LeaveEventWaitList200Response addOrganization(addOrganizationRequest)


### Example

```typescript
import {
    UsersApi,
    Configuration,
    AddOrganizationRequest
} from '@tennac-booking/sdk';

const configuration = new Configuration();
const apiInstance = new UsersApi(configuration);

let addOrganizationRequest: AddOrganizationRequest; //

const { status, data } = await apiInstance.addOrganization(
    addOrganizationRequest
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **addOrganizationRequest** | **AddOrganizationRequest**|  | |


### Return type

**LeaveEventWaitList200Response**

### Authorization

[bearerAuth](../README.md#bearerAuth)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Ok |  -  |

[[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)

# **changePassword**
> ChangePasswordResponse changePassword(changePasswordRequestBody)


### Example

```typescript
import {
    UsersApi,
    Configuration,
    ChangePasswordRequestBody
} from '@tennac-booking/sdk';

const configuration = new Configuration();
const apiInstance = new UsersApi(configuration);

let changePasswordRequestBody: ChangePasswordRequestBody; //

const { status, data } = await apiInstance.changePassword(
    changePasswordRequestBody
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **changePasswordRequestBody** | **ChangePasswordRequestBody**|  | |


### Return type

**ChangePasswordResponse**

### Authorization

[bearerAuth](../README.md#bearerAuth)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Ok |  -  |

[[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)

# **completeRegister**
> IUserAttributes completeRegister(completeRegisterRequestBody)


### Example

```typescript
import {
    UsersApi,
    Configuration,
    CompleteRegisterRequestBody
} from '@tennac-booking/sdk';

const configuration = new Configuration();
const apiInstance = new UsersApi(configuration);

let completeRegisterRequestBody: CompleteRegisterRequestBody; //

const { status, data } = await apiInstance.completeRegister(
    completeRegisterRequestBody
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **completeRegisterRequestBody** | **CompleteRegisterRequestBody**|  | |


### Return type

**IUserAttributes**

### Authorization

[bearerAuth](../README.md#bearerAuth)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Ok |  -  |

[[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)

# **getAllUsers**
> Array<IUserAttributes> getAllUsers()


### Example

```typescript
import {
    UsersApi,
    Configuration
} from '@tennac-booking/sdk';

const configuration = new Configuration();
const apiInstance = new UsersApi(configuration);

const { status, data } = await apiInstance.getAllUsers();
```

### Parameters
This endpoint does not have any parameters.


### Return type

**Array<IUserAttributes>**

### Authorization

[bearerAuth](../README.md#bearerAuth)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Ok |  -  |

[[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)

# **getBookingDetail**
> BookingSummary getBookingDetail()


### Example

```typescript
import {
    UsersApi,
    Configuration
} from '@tennac-booking/sdk';

const configuration = new Configuration();
const apiInstance = new UsersApi(configuration);

let bookingId: string; // (default to undefined)

const { status, data } = await apiInstance.getBookingDetail(
    bookingId
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **bookingId** | [**string**] |  | defaults to undefined|


### Return type

**BookingSummary**

### Authorization

[bearerAuth](../README.md#bearerAuth)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Ok |  -  |

[[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)

# **getCurrentTerms**
> TermsAndConditionsResponse getCurrentTerms()

Récupère les CGU actuelles

### Example

```typescript
import {
    UsersApi,
    Configuration
} from '@tennac-booking/sdk';

const configuration = new Configuration();
const apiInstance = new UsersApi(configuration);

let language: string; // (optional) (default to undefined)

const { status, data } = await apiInstance.getCurrentTerms(
    language
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **language** | [**string**] |  | (optional) defaults to undefined|


### Return type

**TermsAndConditionsResponse**

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | CGU actuelles |  -  |
|**404** | Aucune CGU trouvée |  -  |

[[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)

# **getEventBookingDetail**
> EventBookingDetailResponse getEventBookingDetail()


### Example

```typescript
import {
    UsersApi,
    Configuration
} from '@tennac-booking/sdk';

const configuration = new Configuration();
const apiInstance = new UsersApi(configuration);

let eventBookingId: string; // (default to undefined)

const { status, data } = await apiInstance.getEventBookingDetail(
    eventBookingId
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **eventBookingId** | [**string**] |  | defaults to undefined|


### Return type

**EventBookingDetailResponse**

### Authorization

[bearerAuth](../README.md#bearerAuth)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Ok |  -  |

[[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)

# **getFavoriteClubs**
> FavoriteClubsResponse getFavoriteClubs()


### Example

```typescript
import {
    UsersApi,
    Configuration
} from '@tennac-booking/sdk';

const configuration = new Configuration();
const apiInstance = new UsersApi(configuration);

const { status, data } = await apiInstance.getFavoriteClubs();
```

### Parameters
This endpoint does not have any parameters.


### Return type

**FavoriteClubsResponse**

### Authorization

[bearerAuth](../README.md#bearerAuth)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Ok |  -  |

[[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)

# **getFavoritesPlayers**
> FavoritePlayersResponse getFavoritesPlayers()


### Example

```typescript
import {
    UsersApi,
    Configuration
} from '@tennac-booking/sdk';

const configuration = new Configuration();
const apiInstance = new UsersApi(configuration);

const { status, data } = await apiInstance.getFavoritesPlayers();
```

### Parameters
This endpoint does not have any parameters.


### Return type

**FavoritePlayersResponse**

### Authorization

[bearerAuth](../README.md#bearerAuth)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Ok |  -  |

[[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)

# **getFrequentlyPlayedWith**
> Array<PlayerSummary> getFrequentlyPlayedWith()


### Example

```typescript
import {
    UsersApi,
    Configuration
} from '@tennac-booking/sdk';

const configuration = new Configuration();
const apiInstance = new UsersApi(configuration);

const { status, data } = await apiInstance.getFrequentlyPlayedWith();
```

### Parameters
This endpoint does not have any parameters.


### Return type

**Array<PlayerSummary>**

### Authorization

[bearerAuth](../README.md#bearerAuth)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Ok |  -  |

[[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)

# **getFrequentlyVisitedClub**
> Array<ClubSummary> getFrequentlyVisitedClub()


### Example

```typescript
import {
    UsersApi,
    Configuration
} from '@tennac-booking/sdk';

const configuration = new Configuration();
const apiInstance = new UsersApi(configuration);

const { status, data } = await apiInstance.getFrequentlyVisitedClub();
```

### Parameters
This endpoint does not have any parameters.


### Return type

**Array<ClubSummary>**

### Authorization

[bearerAuth](../README.md#bearerAuth)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Ok |  -  |

[[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)

# **getMe**
> UserProfileResponse getMe()


### Example

```typescript
import {
    UsersApi,
    Configuration
} from '@tennac-booking/sdk';

const configuration = new Configuration();
const apiInstance = new UsersApi(configuration);

const { status, data } = await apiInstance.getMe();
```

### Parameters
This endpoint does not have any parameters.


### Return type

**UserProfileResponse**

### Authorization

[bearerAuth](../README.md#bearerAuth)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Ok |  -  |

[[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)

# **getMyClubMemberships**
> UserClubMembershipsResponse getMyClubMemberships()

Récupère les clubs associés à l\'utilisateur avec ses informations de paiement

### Example

```typescript
import {
    UsersApi,
    Configuration
} from '@tennac-booking/sdk';

const configuration = new Configuration();
const apiInstance = new UsersApi(configuration);

const { status, data } = await apiInstance.getMyClubMemberships();
```

### Parameters
This endpoint does not have any parameters.


### Return type

**UserClubMembershipsResponse**

### Authorization

[bearerAuth](../README.md#bearerAuth)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Clubs de l\&#39;utilisateur |  -  |
|**500** | Server Error |  -  |

[[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)

# **getNearestClubs**
> Array<{ [key: string]: any; }> getNearestClubs()


### Example

```typescript
import {
    UsersApi,
    Configuration
} from '@tennac-booking/sdk';

const configuration = new Configuration();
const apiInstance = new UsersApi(configuration);

let radiusInKm: number; // (optional) (default to undefined)
let limit: number; // (optional) (default to undefined)

const { status, data } = await apiInstance.getNearestClubs(
    radiusInKm,
    limit
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **radiusInKm** | [**number**] |  | (optional) defaults to undefined|
| **limit** | [**number**] |  | (optional) defaults to undefined|


### Return type

**Array<{ [key: string]: any; }>**

### Authorization

[bearerAuth](../README.md#bearerAuth)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Ok |  -  |

[[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)

# **getNearestClubsFromCoordinates**
> Array<{ [key: string]: any; }> getNearestClubsFromCoordinates()


### Example

```typescript
import {
    UsersApi,
    Configuration
} from '@tennac-booking/sdk';

const configuration = new Configuration();
const apiInstance = new UsersApi(configuration);

let latitude: number; // (optional) (default to undefined)
let longitude: number; // (optional) (default to undefined)
let radiusInKm: number; // (optional) (default to undefined)
let limit: number; // (optional) (default to undefined)

const { status, data } = await apiInstance.getNearestClubsFromCoordinates(
    latitude,
    longitude,
    radiusInKm,
    limit
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **latitude** | [**number**] |  | (optional) defaults to undefined|
| **longitude** | [**number**] |  | (optional) defaults to undefined|
| **radiusInKm** | [**number**] |  | (optional) defaults to undefined|
| **limit** | [**number**] |  | (optional) defaults to undefined|


### Return type

**Array<{ [key: string]: any; }>**

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Ok |  -  |

[[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)

# **getNearestUsers**
> Array<{ [key: string]: any; }> getNearestUsers()


### Example

```typescript
import {
    UsersApi,
    Configuration
} from '@tennac-booking/sdk';

const configuration = new Configuration();
const apiInstance = new UsersApi(configuration);

let radiusInKm: number; // (optional) (default to undefined)
let limit: number; // (optional) (default to undefined)

const { status, data } = await apiInstance.getNearestUsers(
    radiusInKm,
    limit
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **radiusInKm** | [**number**] |  | (optional) defaults to undefined|
| **limit** | [**number**] |  | (optional) defaults to undefined|


### Return type

**Array<{ [key: string]: any; }>**

### Authorization

[bearerAuth](../README.md#bearerAuth)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Ok |  -  |

[[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)

# **getNearestUsersFromCoordinates**
> Array<{ [key: string]: any; }> getNearestUsersFromCoordinates()


### Example

```typescript
import {
    UsersApi,
    Configuration
} from '@tennac-booking/sdk';

const configuration = new Configuration();
const apiInstance = new UsersApi(configuration);

let latitude: number; // (optional) (default to undefined)
let longitude: number; // (optional) (default to undefined)
let radiusInKm: number; // (optional) (default to undefined)
let limit: number; // (optional) (default to undefined)

const { status, data } = await apiInstance.getNearestUsersFromCoordinates(
    latitude,
    longitude,
    radiusInKm,
    limit
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **latitude** | [**number**] |  | (optional) defaults to undefined|
| **longitude** | [**number**] |  | (optional) defaults to undefined|
| **radiusInKm** | [**number**] |  | (optional) defaults to undefined|
| **limit** | [**number**] |  | (optional) defaults to undefined|


### Return type

**Array<{ [key: string]: any; }>**

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Ok |  -  |

[[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)

# **getPlayerCategories**
> PlayerCategoriesResponse getPlayerCategories()


### Example

```typescript
import {
    UsersApi,
    Configuration
} from '@tennac-booking/sdk';

const configuration = new Configuration();
const apiInstance = new UsersApi(configuration);

const { status, data } = await apiInstance.getPlayerCategories();
```

### Parameters
This endpoint does not have any parameters.


### Return type

**PlayerCategoriesResponse**

### Authorization

[bearerAuth](../README.md#bearerAuth)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Ok |  -  |

[[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)

# **getUserBookings**
> UserBookingsResponse getUserBookings()


### Example

```typescript
import {
    UsersApi,
    Configuration
} from '@tennac-booking/sdk';

const configuration = new Configuration();
const apiInstance = new UsersApi(configuration);

let limit: number; // (optional) (default to undefined)
let skip: number; // (optional) (default to undefined)
let timeFilter: 'upcoming' | 'past'; // (optional) (default to undefined)

const { status, data } = await apiInstance.getUserBookings(
    limit,
    skip,
    timeFilter
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **limit** | [**number**] |  | (optional) defaults to undefined|
| **skip** | [**number**] |  | (optional) defaults to undefined|
| **timeFilter** | [**&#39;upcoming&#39; | &#39;past&#39;**]**Array<&#39;upcoming&#39; &#124; &#39;past&#39;>** |  | (optional) defaults to undefined|


### Return type

**UserBookingsResponse**

### Authorization

[bearerAuth](../README.md#bearerAuth)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Ok |  -  |

[[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)

# **getUserEvents**
> UserEventsResponse getUserEvents()


### Example

```typescript
import {
    UsersApi,
    Configuration
} from '@tennac-booking/sdk';

const configuration = new Configuration();
const apiInstance = new UsersApi(configuration);

let limit: number; // (optional) (default to undefined)
let skip: number; // (optional) (default to undefined)

const { status, data } = await apiInstance.getUserEvents(
    limit,
    skip
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **limit** | [**number**] |  | (optional) defaults to undefined|
| **skip** | [**number**] |  | (optional) defaults to undefined|


### Return type

**UserEventsResponse**

### Authorization

[bearerAuth](../README.md#bearerAuth)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Ok |  -  |

[[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)

# **getUserNotifications**
> UserNotificationsResponse getUserNotifications()


### Example

```typescript
import {
    UsersApi,
    Configuration
} from '@tennac-booking/sdk';

const configuration = new Configuration();
const apiInstance = new UsersApi(configuration);

let limit: number; // (optional) (default to undefined)
let skip: number; // (optional) (default to undefined)
let includeRead: any; // (optional) (default to undefined)

const { status, data } = await apiInstance.getUserNotifications(
    limit,
    skip,
    includeRead
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **limit** | [**number**] |  | (optional) defaults to undefined|
| **skip** | [**number**] |  | (optional) defaults to undefined|
| **includeRead** | **any** |  | (optional) defaults to undefined|


### Return type

**UserNotificationsResponse**

### Authorization

[bearerAuth](../README.md#bearerAuth)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Ok |  -  |

[[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)

# **getUserProfileById**
> PublicUserProfileResponse getUserProfileById()


### Example

```typescript
import {
    UsersApi,
    Configuration
} from '@tennac-booking/sdk';

const configuration = new Configuration();
const apiInstance = new UsersApi(configuration);

let id: string; // (default to undefined)

const { status, data } = await apiInstance.getUserProfileById(
    id
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **id** | [**string**] |  | defaults to undefined|


### Return type

**PublicUserProfileResponse**

### Authorization

[bearerAuth](../README.md#bearerAuth)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Ok |  -  |

[[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)

# **leaveBooking**
> LeaveEventWaitList200Response leaveBooking()

Quitter une réservation

### Example

```typescript
import {
    UsersApi,
    Configuration
} from '@tennac-booking/sdk';

const configuration = new Configuration();
const apiInstance = new UsersApi(configuration);

let bookingId: string; // (default to undefined)

const { status, data } = await apiInstance.leaveBooking(
    bookingId
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **bookingId** | [**string**] |  | defaults to undefined|


### Return type

**LeaveEventWaitList200Response**

### Authorization

[bearerAuth](../README.md#bearerAuth)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Réservation quittée avec succès |  -  |
|**400** | Requête invalide |  -  |
|**404** | Réservation non trouvée |  -  |
|**500** | Erreur serveur |  -  |

[[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)

# **listPlayers**
> PlayerListResponse listPlayers()


### Example

```typescript
import {
    UsersApi,
    Configuration
} from '@tennac-booking/sdk';

const configuration = new Configuration();
const apiInstance = new UsersApi(configuration);

let category: PlayerCategoryId; // (optional) (default to undefined)
let search: string; // (optional) (default to undefined)
let gender: string; // (optional) (default to undefined)
let sharedClub: boolean; // (optional) (default to undefined)
let sportLevels: string; // (optional) (default to undefined)
let limit: number; // (optional) (default to undefined)
let offset: number; // (optional) (default to undefined)
let latitude: number; // (optional) (default to undefined)
let longitude: number; // (optional) (default to undefined)
let radiusInKm: number; // (optional) (default to undefined)

const { status, data } = await apiInstance.listPlayers(
    category,
    search,
    gender,
    sharedClub,
    sportLevels,
    limit,
    offset,
    latitude,
    longitude,
    radiusInKm
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **category** | **PlayerCategoryId** |  | (optional) defaults to undefined|
| **search** | [**string**] |  | (optional) defaults to undefined|
| **gender** | [**string**] |  | (optional) defaults to undefined|
| **sharedClub** | [**boolean**] |  | (optional) defaults to undefined|
| **sportLevels** | [**string**] |  | (optional) defaults to undefined|
| **limit** | [**number**] |  | (optional) defaults to undefined|
| **offset** | [**number**] |  | (optional) defaults to undefined|
| **latitude** | [**number**] |  | (optional) defaults to undefined|
| **longitude** | [**number**] |  | (optional) defaults to undefined|
| **radiusInKm** | [**number**] |  | (optional) defaults to undefined|


### Return type

**PlayerListResponse**

### Authorization

[bearerAuth](../README.md#bearerAuth)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Ok |  -  |

[[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)

# **login**
> LoginWithTermsResponse login(loginRequestBody)


### Example

```typescript
import {
    UsersApi,
    Configuration,
    LoginRequestBody
} from '@tennac-booking/sdk';

const configuration = new Configuration();
const apiInstance = new UsersApi(configuration);

let loginRequestBody: LoginRequestBody; //

const { status, data } = await apiInstance.login(
    loginRequestBody
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **loginRequestBody** | **LoginRequestBody**|  | |


### Return type

**LoginWithTermsResponse**

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Ok |  -  |

[[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)

# **loginClubMember**
> LoginWithTermsResponse loginClubMember(loginRequestBody)


### Example

```typescript
import {
    UsersApi,
    Configuration,
    LoginRequestBody
} from '@tennac-booking/sdk';

const configuration = new Configuration();
const apiInstance = new UsersApi(configuration);

let loginRequestBody: LoginRequestBody; //

const { status, data } = await apiInstance.loginClubMember(
    loginRequestBody
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **loginRequestBody** | **LoginRequestBody**|  | |


### Return type

**LoginWithTermsResponse**

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Ok |  -  |

[[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)

# **markNotificationsRead**
> MarkNotificationsReadResponse markNotificationsRead(markNotificationsReadRequest)


### Example

```typescript
import {
    UsersApi,
    Configuration,
    MarkNotificationsReadRequest
} from '@tennac-booking/sdk';

const configuration = new Configuration();
const apiInstance = new UsersApi(configuration);

let markNotificationsReadRequest: MarkNotificationsReadRequest; //

const { status, data } = await apiInstance.markNotificationsRead(
    markNotificationsReadRequest
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **markNotificationsReadRequest** | **MarkNotificationsReadRequest**|  | |


### Return type

**MarkNotificationsReadResponse**

### Authorization

[bearerAuth](../README.md#bearerAuth)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Ok |  -  |

[[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)

# **migrateSubscription**
> MigrateSubscription200Response migrateSubscription(migrateSubscriptionRequest)

Endpoint de migration pour importer les abonnements depuis un CSV Map les abonnements aux ClubCustomer existants via firstName/lastName

### Example

```typescript
import {
    UsersApi,
    Configuration,
    MigrateSubscriptionRequest
} from '@tennac-booking/sdk';

const configuration = new Configuration();
const apiInstance = new UsersApi(configuration);

let migrateSubscriptionRequest: MigrateSubscriptionRequest; //

const { status, data } = await apiInstance.migrateSubscription(
    migrateSubscriptionRequest
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **migrateSubscriptionRequest** | **MigrateSubscriptionRequest**|  | |


### Return type

**MigrateSubscription200Response**

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Ok |  -  |

[[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)

# **migrateUser**
> MigrateUser200Response migrateUser(migrateUserRequest)

Endpoint de migration pour importer des utilisateurs depuis un CSV Crée l\'utilisateur, le ClubCustomer avec metadata et gère les duplicates

### Example

```typescript
import {
    UsersApi,
    Configuration,
    MigrateUserRequest
} from '@tennac-booking/sdk';

const configuration = new Configuration();
const apiInstance = new UsersApi(configuration);

let migrateUserRequest: MigrateUserRequest; //

const { status, data } = await apiInstance.migrateUser(
    migrateUserRequest
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **migrateUserRequest** | **MigrateUserRequest**|  | |


### Return type

**MigrateUser200Response**

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Ok |  -  |

[[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)

# **refreshToken**
> RefreshTokenResponse refreshToken(refreshTokenRequestBody)


### Example

```typescript
import {
    UsersApi,
    Configuration,
    RefreshTokenRequestBody
} from '@tennac-booking/sdk';

const configuration = new Configuration();
const apiInstance = new UsersApi(configuration);

let refreshTokenRequestBody: RefreshTokenRequestBody; //

const { status, data } = await apiInstance.refreshToken(
    refreshTokenRequestBody
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **refreshTokenRequestBody** | **RefreshTokenRequestBody**|  | |


### Return type

**RefreshTokenResponse**

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Ok |  -  |

[[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)

# **register**
> IUserAttributes register(registerRequestBody)


### Example

```typescript
import {
    UsersApi,
    Configuration,
    RegisterRequestBody
} from '@tennac-booking/sdk';

const configuration = new Configuration();
const apiInstance = new UsersApi(configuration);

let registerRequestBody: RegisterRequestBody; //

const { status, data } = await apiInstance.register(
    registerRequestBody
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **registerRequestBody** | **RegisterRequestBody**|  | |


### Return type

**IUserAttributes**

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**201** | Created |  -  |

[[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)

# **registerFromApp**
> IUserAttributes registerFromApp(appRegisterRequestBody)


### Example

```typescript
import {
    UsersApi,
    Configuration,
    AppRegisterRequestBody
} from '@tennac-booking/sdk';

const configuration = new Configuration();
const apiInstance = new UsersApi(configuration);

let appRegisterRequestBody: AppRegisterRequestBody; //

const { status, data } = await apiInstance.registerFromApp(
    appRegisterRequestBody
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **appRegisterRequestBody** | **AppRegisterRequestBody**|  | |


### Return type

**IUserAttributes**

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**201** | Created |  -  |

[[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)

# **removeFavoriteClub**
> FavoriteClubMutationResponse removeFavoriteClub()


### Example

```typescript
import {
    UsersApi,
    Configuration
} from '@tennac-booking/sdk';

const configuration = new Configuration();
const apiInstance = new UsersApi(configuration);

let clubId: string; // (default to undefined)

const { status, data } = await apiInstance.removeFavoriteClub(
    clubId
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **clubId** | [**string**] |  | defaults to undefined|


### Return type

**FavoriteClubMutationResponse**

### Authorization

[bearerAuth](../README.md#bearerAuth)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Ok |  -  |

[[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)

# **removeFavoritePlayer**
> FavoritePlayerMutationResponse removeFavoritePlayer()


### Example

```typescript
import {
    UsersApi,
    Configuration
} from '@tennac-booking/sdk';

const configuration = new Configuration();
const apiInstance = new UsersApi(configuration);

let favoritePlayerId: string; // (default to undefined)

const { status, data } = await apiInstance.removeFavoritePlayer(
    favoritePlayerId
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **favoritePlayerId** | [**string**] |  | defaults to undefined|


### Return type

**FavoritePlayerMutationResponse**

### Authorization

[bearerAuth](../README.md#bearerAuth)

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Ok |  -  |

[[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)

# **removeOrganization**
> LeaveEventWaitList200Response removeOrganization(addOrganizationRequest)


### Example

```typescript
import {
    UsersApi,
    Configuration,
    AddOrganizationRequest
} from '@tennac-booking/sdk';

const configuration = new Configuration();
const apiInstance = new UsersApi(configuration);

let addOrganizationRequest: AddOrganizationRequest; //

const { status, data } = await apiInstance.removeOrganization(
    addOrganizationRequest
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **addOrganizationRequest** | **AddOrganizationRequest**|  | |


### Return type

**LeaveEventWaitList200Response**

### Authorization

[bearerAuth](../README.md#bearerAuth)

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json


##