@tennac-booking/sdk 1.0.36 → 1.0.38

package/docs/UserPaymentApi.md

@@ -0,0 +1,176 @@
+# UserPaymentApi
+
+All URIs are relative to *https://api.mon-domaine.com*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**addPaymentMethodSetup**](#addpaymentmethodsetup) | **POST** /api/users/addPaymentMethodSetup | Ajoute une méthode de paiement Stripe à la liste de l\'utilisateur|
+|[**confirmPaymentMethodSetup**](#confirmpaymentmethodsetup) | **POST** /api/users/confirmPaymentMethodSetup | Confirme la configuration d\'une méthode de paiement|
+|[**setupPaymentMethod**](#setuppaymentmethod) | **POST** /api/users/setupPaymentMethod | Configure une méthode de paiement pour un utilisateur|
+
+# **addPaymentMethodSetup**
+> AddPaymentMethodSetupResponse addPaymentMethodSetup(addPaymentMethodSetupRequestBody)
+
+
+### Example
+
+```typescript
+import {
+    UserPaymentApi,
+    Configuration,
+    AddPaymentMethodSetupRequestBody
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new UserPaymentApi(configuration);
+
+let addPaymentMethodSetupRequestBody: AddPaymentMethodSetupRequestBody; //
+
+const { status, data } = await apiInstance.addPaymentMethodSetup(
+    addPaymentMethodSetupRequestBody
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **addPaymentMethodSetupRequestBody** | **AddPaymentMethodSetupRequestBody**|  | |
+
+
+### Return type
+
+**AddPaymentMethodSetupResponse**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Méthode de paiement ajoutée |  -  |
+|**400** | Requête invalide |  -  |
+|**401** | Non autorisé |  -  |
+|**500** | Erreur serveur interne |  -  |
+
+[[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)
+
+# **confirmPaymentMethodSetup**
+> ConfirmPaymentMethodSetupResponse confirmPaymentMethodSetup(confirmPaymentMethodSetupRequestBody)
+
+Confirme que la méthode de paiement a été configurée avec succès et la sauvegarde pour l\'utilisateur
+
+### Example
+
+```typescript
+import {
+    UserPaymentApi,
+    Configuration,
+    ConfirmPaymentMethodSetupRequestBody
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new UserPaymentApi(configuration);
+
+let confirmPaymentMethodSetupRequestBody: ConfirmPaymentMethodSetupRequestBody; //
+
+const { status, data } = await apiInstance.confirmPaymentMethodSetup(
+    confirmPaymentMethodSetupRequestBody
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **confirmPaymentMethodSetupRequestBody** | **ConfirmPaymentMethodSetupRequestBody**|  | |
+
+
+### Return type
+
+**ConfirmPaymentMethodSetupResponse**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Méthode de paiement confirmée avec succès |  -  |
+|**400** | Requête invalide |  -  |
+|**401** | Non autorisé |  -  |
+|**404** | Ressource non trouvée |  -  |
+|**500** | Erreur serveur interne |  -  |
+
+[[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)
+
+# **setupPaymentMethod**
+> SetupPaymentMethodResponse setupPaymentMethod(setupPaymentMethodRequestBody)
+
+Initie la configuration d\'une méthode de paiement via Stripe Setup Intent pour permettre les futurs paiements
+
+### Example
+
+```typescript
+import {
+    UserPaymentApi,
+    Configuration,
+    SetupPaymentMethodRequestBody
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new UserPaymentApi(configuration);
+
+let setupPaymentMethodRequestBody: SetupPaymentMethodRequestBody; //
+
+const { status, data } = await apiInstance.setupPaymentMethod(
+    setupPaymentMethodRequestBody
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **setupPaymentMethodRequestBody** | **SetupPaymentMethodRequestBody**|  | |
+
+
+### Return type
+
+**SetupPaymentMethodResponse**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Setup Intent créé avec succès |  -  |
+|**400** | Requête invalide |  -  |
+|**401** | Non autorisé |  -  |
+|**404** | Ressource non trouvée |  -  |
+|**500** | Erreur serveur interne |  -  |
+
+[[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)
+