@tennac-booking/sdk
Version:
OpenAPI client for @tennac-booking/sdk
168 lines (107 loc) • 4.15 kB
Markdown
# PublicEmailApi
All URIs are relative to *http://localhost*
|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**authEmailExists**](#authemailexists) | **POST** /api/public-email/auth-email-exists | |
|[**requestPublicEmailVerificationCode**](#requestpublicemailverificationcode) | **POST** /api/public-email/request-verification-code | |
|[**verifyCode**](#verifycode) | **POST** /api/public-email/verify-code | |
# **authEmailExists**
> EmailExistsResponse authEmailExists(emailExistsRequestBody)
### Example
```typescript
import {
PublicEmailApi,
Configuration,
EmailExistsRequestBody
} from '@tennac-booking/sdk';
const configuration = new Configuration();
const apiInstance = new PublicEmailApi(configuration);
let emailExistsRequestBody: EmailExistsRequestBody; //
const { status, data } = await apiInstance.authEmailExists(
emailExistsRequestBody
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **emailExistsRequestBody** | **EmailExistsRequestBody**| | |
### Return type
**EmailExistsResponse**
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | OK | - |
|**400** | Payload invalide | - |
[[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)
# **requestPublicEmailVerificationCode**
> RequestEmailCodeResponse requestPublicEmailVerificationCode(requestEmailCodeBody)
### Example
```typescript
import {
PublicEmailApi,
Configuration,
RequestEmailCodeBody
} from '@tennac-booking/sdk';
const configuration = new Configuration();
const apiInstance = new PublicEmailApi(configuration);
let requestEmailCodeBody: RequestEmailCodeBody; //
const { status, data } = await apiInstance.requestPublicEmailVerificationCode(
requestEmailCodeBody
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **requestEmailCodeBody** | **RequestEmailCodeBody**| | |
### Return type
**RequestEmailCodeResponse**
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Code envoyé | - |
|**400** | Payload invalide | - |
|**500** | Erreur envoi email | - |
[[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)
# **verifyCode**
> VerifyEmailCodeResponse verifyCode(verifyEmailCodeBody)
### Example
```typescript
import {
PublicEmailApi,
Configuration,
VerifyEmailCodeBody
} from '@tennac-booking/sdk';
const configuration = new Configuration();
const apiInstance = new PublicEmailApi(configuration);
let verifyEmailCodeBody: VerifyEmailCodeBody; //
const { status, data } = await apiInstance.verifyCode(
verifyEmailCodeBody
);
```
### Parameters
|Name | Type | Description | Notes|
|------------- | ------------- | ------------- | -------------|
| **verifyEmailCodeBody** | **VerifyEmailCodeBody**| | |
### Return type
**VerifyEmailCodeResponse**
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Email verifie | - |
|**400** | Code invalide | - |
[[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)