UNPKG

@tennac-booking/sdk

Version:

OpenAPI client for @tennac-booking/sdk

173 lines (112 loc) 4.67 kB
# SubscriptionsMobileApi All URIs are relative to *http://localhost* |Method | HTTP request | Description| |------------- | ------------- | -------------| |[**cancelIncomplete**](#cancelincomplete) | **POST** /api/mobile/subscriptions/cancel-incomplete | | |[**getDetail**](#getdetail) | **POST** /api/mobile/subscriptions/detail | | |[**mobilePaymentSheet**](#mobilepaymentsheet) | **POST** /api/mobile/subscriptions/payment-sheet | | # **cancelIncomplete** > CancelIncompleteResponse cancelIncomplete(cancelIncompleteBody) Annule immédiatement une subscription restée en statut \"incomplete\" (après fermeture PaymentSheet). ### Example ```typescript import { SubscriptionsMobileApi, Configuration, CancelIncompleteBody } from '@tennac-booking/sdk'; const configuration = new Configuration(); const apiInstance = new SubscriptionsMobileApi(configuration); let cancelIncompleteBody: CancelIncompleteBody; // const { status, data } = await apiInstance.cancelIncomplete( cancelIncompleteBody ); ``` ### Parameters |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | **cancelIncompleteBody** | **CancelIncompleteBody**| | | ### Return type **CancelIncompleteResponse** ### Authorization [bearerAuth](../README.md#bearerAuth) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| |**200** | Canceled if incomplete | - | |**400** | Bad Request | - | |**401** | Unauthorized | - | [[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) # **getDetail** > MobileSubscriptionDetailResponse getDetail(subscriptionDetailBody) Détail d\'un abonnement utilisateur pour l\'app mobile (compte connecté du club). ### Example ```typescript import { SubscriptionsMobileApi, Configuration, SubscriptionDetailBody } from '@tennac-booking/sdk'; const configuration = new Configuration(); const apiInstance = new SubscriptionsMobileApi(configuration); let subscriptionDetailBody: SubscriptionDetailBody; // const { status, data } = await apiInstance.getDetail( subscriptionDetailBody ); ``` ### Parameters |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | **subscriptionDetailBody** | **SubscriptionDetailBody**| | | ### Return type **MobileSubscriptionDetailResponse** ### Authorization [bearerAuth](../README.md#bearerAuth) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| |**200** | Subscription detail | - | |**400** | Bad Request | - | |**401** | Unauthorized | - | [[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) # **mobilePaymentSheet** > SubscriptionPaymentSheetResponse mobilePaymentSheet(mobilePaymentSheetBody) Prépare une PaymentSheet pour l\'app mobile (compte connecté du club). Renvoie soit un PaymentIntent client secret, soit un SetupIntent si Stripe n\'a pas généré de PI. ### Example ```typescript import { SubscriptionsMobileApi, Configuration, MobilePaymentSheetBody } from '@tennac-booking/sdk'; const configuration = new Configuration(); const apiInstance = new SubscriptionsMobileApi(configuration); let mobilePaymentSheetBody: MobilePaymentSheetBody; // const { status, data } = await apiInstance.mobilePaymentSheet( mobilePaymentSheetBody ); ``` ### Parameters |Name | Type | Description | Notes| |------------- | ------------- | ------------- | -------------| | **mobilePaymentSheetBody** | **MobilePaymentSheetBody**| | | ### Return type **SubscriptionPaymentSheetResponse** ### Authorization [bearerAuth](../README.md#bearerAuth) ### HTTP request headers - **Content-Type**: application/json - **Accept**: application/json ### HTTP response details | Status code | Description | Response headers | |-------------|-------------|------------------| |**200** | Payment sheet ready | - | |**400** | Bad Request | - | |**401** | Unauthorized | - | [[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)