@tennac-booking/sdk 1.0.19 → 1.0.21

package/dist/index.js

@@ -2,10 +2,10 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * Pickle Ball API
+ * Pandook API
  * API for managing pickle ball games and players
  *
- * The version of the OpenAPI document: 1.0.17
+ * The version of the OpenAPI document: 1.0.21
  *
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/docs/ClubAnalyticsApi.md

@@ -0,0 +1,253 @@
+# ClubAnalyticsApi
+
+All URIs are relative to *https://api.mon-domaine.com*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**getDailyTurnOver**](#getdailyturnover) | **GET** /api/clubs/{id}/turnover/daily | Chiffre d\'affaires quotidien|
+|[**getInvoices**](#getinvoices) | **GET** /api/clubs/{id}/invoices | Récupérer les factures du club|
+|[**getMonthlyTurnOver**](#getmonthlyturnover) | **GET** /api/clubs/{id}/turnover/monthly | Chiffre d\'affaires mensuel|
+|[**getYearlyTurnOver**](#getyearlyturnover) | **GET** /api/clubs/{id}/turnover/yearly | Chiffre d\'affaires annuel|
+
+# **getDailyTurnOver**
+> DailyTurnoverResponse getDailyTurnOver()
+
+
+### Example
+
+```typescript
+import {
+    ClubAnalyticsApi,
+    Configuration
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ClubAnalyticsApi(configuration);
+
+let id: string; //ID du club (default to undefined)
+let date: string; //Date (format YYYY-MM-DD) (default to undefined)
+
+const { status, data } = await apiInstance.getDailyTurnOver(
+    id,
+    date
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] | ID du club | defaults to undefined|
+| **date** | [**string**] | Date (format YYYY-MM-DD) | defaults to undefined|
+
+
+### Return type
+
+**DailyTurnoverResponse**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Chiffre d\'affaires quotidien |  -  |
+|**400** | Requête invalide |  -  |
+|**401** | Non autorisé |  -  |
+|**403** | Accès interdit |  -  |
+|**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)
+
+# **getInvoices**
+> InvoicesResponse getInvoices()
+
+
+### Example
+
+```typescript
+import {
+    ClubAnalyticsApi,
+    Configuration
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ClubAnalyticsApi(configuration);
+
+let id: string; //ID du club (default to undefined)
+let page: number; //Numéro de page (optional) (default to 1)
+let limit: number; //Nombre d\'éléments par page (optional) (default to 10)
+let status: 'pending' | 'paid' | 'failed' | 'authorized' | 'canceled' | 'expired'; //Filtrer par statut (optional) (default to undefined)
+let startDate: string; //Date de début (ISO format) (optional) (default to undefined)
+let endDate: string; //Date de fin (ISO format) (optional) (default to undefined)
+
+const { status, data } = await apiInstance.getInvoices(
+    id,
+    page,
+    limit,
+    status,
+    startDate,
+    endDate
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] | ID du club | defaults to undefined|
+| **page** | [**number**] | Numéro de page | (optional) defaults to 1|
+| **limit** | [**number**] | Nombre d\'éléments par page | (optional) defaults to 10|
+| **status** | [**&#39;pending&#39; | &#39;paid&#39; | &#39;failed&#39; | &#39;authorized&#39; | &#39;canceled&#39; | &#39;expired&#39;**]**Array<&#39;pending&#39; &#124; &#39;paid&#39; &#124; &#39;failed&#39; &#124; &#39;authorized&#39; &#124; &#39;canceled&#39; &#124; &#39;expired&#39;>** | Filtrer par statut | (optional) defaults to undefined|
+| **startDate** | [**string**] | Date de début (ISO format) | (optional) defaults to undefined|
+| **endDate** | [**string**] | Date de fin (ISO format) | (optional) defaults to undefined|
+
+
+### Return type
+
+**InvoicesResponse**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Liste des factures |  -  |
+|**401** | Non autorisé |  -  |
+|**403** | Accès interdit |  -  |
+|**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)
+
+# **getMonthlyTurnOver**
+> MonthlyTurnoverResponse getMonthlyTurnOver()
+
+
+### Example
+
+```typescript
+import {
+    ClubAnalyticsApi,
+    Configuration
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ClubAnalyticsApi(configuration);
+
+let id: string; //ID du club (default to undefined)
+let year: number; //Année (default to undefined)
+let month: number; //Mois (1-12) (default to undefined)
+
+const { status, data } = await apiInstance.getMonthlyTurnOver(
+    id,
+    year,
+    month
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] | ID du club | defaults to undefined|
+| **year** | [**number**] | Année | defaults to undefined|
+| **month** | [**number**] | Mois (1-12) | defaults to undefined|
+
+
+### Return type
+
+**MonthlyTurnoverResponse**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Chiffre d\&#39;affaires mensuel |  -  |
+|**400** | Requête invalide |  -  |
+|**401** | Non autorisé |  -  |
+|**403** | Accès interdit |  -  |
+|**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)
+
+# **getYearlyTurnOver**
+> YearlyTurnoverResponse getYearlyTurnOver()
+
+
+### Example
+
+```typescript
+import {
+    ClubAnalyticsApi,
+    Configuration
+} from '@tennac-booking/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ClubAnalyticsApi(configuration);
+
+let id: string; //ID du club (default to undefined)
+let year: number; //Année (default to undefined)
+
+const { status, data } = await apiInstance.getYearlyTurnOver(
+    id,
+    year
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **id** | [**string**] | ID du club | defaults to undefined|
+| **year** | [**number**] | Année | defaults to undefined|
+
+
+### Return type
+
+**YearlyTurnoverResponse**
+
+### Authorization
+
+[bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Chiffre d\&#39;affaires annuel |  -  |
+|**400** | Requête invalide |  -  |
+|**401** | Non autorisé |  -  |
+|**403** | Accès interdit |  -  |
+|**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)
+

package/docs/DailyTurnoverResponse.md

@@ -0,0 +1,24 @@
+# DailyTurnoverResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**date** | **string** |  | [optional] [default to undefined]
+**totalTurnover** | **number** |  | [optional] [default to undefined]
+**invoiceCount** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { DailyTurnoverResponse } from '@tennac-booking/sdk';
+
+const instance: DailyTurnoverResponse = {
+    date,
+    totalTurnover,
+    invoiceCount,
+};
+```
+
+[[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/GetLastSixMonthsTurnover200ResponseInner.md

@@ -6,7 +6,7 @@
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **year** | **number** |  | [optional] [default to undefined]
-**month** | **number** |  | [optional] [default to undefined]
+**month** | **string** |  | [optional] [default to undefined]
 **total** | **number** |  | [optional] [default to undefined]
 
 ## Example

package/docs/InvoicesResponse.md

@@ -0,0 +1,22 @@
+# InvoicesResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**invoices** | [**Array<InvoicesResponseInvoicesInner>**](InvoicesResponseInvoicesInner.md) |  | [optional] [default to undefined]
+**pagination** | [**InvoicesResponsePagination**](InvoicesResponsePagination.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { InvoicesResponse } from '@tennac-booking/sdk';
+
+const instance: InvoicesResponse = {
+    invoices,
+    pagination,
+};
+```
+
+[[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/InvoicesResponseInvoicesInner.md

@@ -0,0 +1,34 @@
+# InvoicesResponseInvoicesInner
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**billNumber** | **string** |  | [optional] [default to undefined]
+**date** | **string** |  | [optional] [default to undefined]
+**clientFirstName** | **string** |  | [optional] [default to undefined]
+**clientLastName** | **string** |  | [optional] [default to undefined]
+**clientEmail** | **string** |  | [optional] [default to undefined]
+**totalCost** | **number** |  | [optional] [default to undefined]
+**status** | **string** |  | [optional] [default to undefined]
+**linkToInvoicePDF** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { InvoicesResponseInvoicesInner } from '@tennac-booking/sdk';
+
+const instance: InvoicesResponseInvoicesInner = {
+    billNumber,
+    date,
+    clientFirstName,
+    clientLastName,
+    clientEmail,
+    totalCost,
+    status,
+    linkToInvoicePDF,
+};
+```
+
+[[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/InvoicesResponsePagination.md

@@ -0,0 +1,26 @@
+# InvoicesResponsePagination
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**total** | **number** |  | [optional] [default to undefined]
+**page** | **number** |  | [optional] [default to undefined]
+**limit** | **number** |  | [optional] [default to undefined]
+**totalPages** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { InvoicesResponsePagination } from '@tennac-booking/sdk';
+
+const instance: InvoicesResponsePagination = {
+    total,
+    page,
+    limit,
+    totalPages,
+};
+```
+
+[[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/MonthlyTurnoverResponse.md

@@ -0,0 +1,28 @@
+# MonthlyTurnoverResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**year** | **number** |  | [optional] [default to undefined]
+**month** | **number** |  | [optional] [default to undefined]
+**totalTurnover** | **number** |  | [optional] [default to undefined]
+**invoiceCount** | **number** |  | [optional] [default to undefined]
+**period** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { MonthlyTurnoverResponse } from '@tennac-booking/sdk';
+
+const instance: MonthlyTurnoverResponse = {
+    year,
+    month,
+    totalTurnover,
+    invoiceCount,
+    period,
+};
+```
+
+[[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/StaffClubAnalyticsApi.md

@@ -5,7 +5,7 @@ All URIs are relative to *https://api.mon-domaine.com*
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
 |[**getLastSixMonthsTurnover**](#getlastsixmonthsturnover) | **GET** /api/clubs/{id}/turnover | Get monthly turnover for the last six months|
-|[**getNumberOfClubUsers**](#getnumberofclubusers) | **GET** /api/clubs/{id}/user-count | Get number of users subscribed to the club|
+|[**getNumberOfClubUsers**](#getnumberofclubusers) | **GET** /api/clubs/user-count | Get number of users subscribed to the club|
 
 # **getLastSixMonthsTurnover**
 > Array<GetLastSixMonthsTurnover200ResponseInner> getLastSixMonthsTurnover()
@@ -73,18 +73,11 @@ import {
 const configuration = new Configuration();
 const apiInstance = new StaffClubAnalyticsApi(configuration);
 
-let id: string; //ID du club (default to undefined)
-
-const { status, data } = await apiInstance.getNumberOfClubUsers(
-    id
-);
+const { status, data } = await apiInstance.getNumberOfClubUsers();
 ```
 
 ### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **id** | [**string**] | ID du club | defaults to undefined|
+This endpoint does not have any parameters.
 
 
 ### Return type

package/docs/StaffClubSettingsApi.md

@@ -7,7 +7,7 @@ All URIs are relative to *https://api.mon-domaine.com*
 |[**getClubSettings**](#getclubsettings) | **GET** /api/club-settings | Récupère les paramètres d\'un club|
 
 # **getClubSettings**
-> ClubSettings getClubSettings(getClubSettingsRequest)
+> ClubSettings getClubSettings()
 
 
 ### Example
@@ -15,25 +15,17 @@ All URIs are relative to *https://api.mon-domaine.com*
 ```typescript
 import {
     StaffClubSettingsApi,
-    Configuration,
-    GetClubSettingsRequest
+    Configuration
 } from '@tennac-booking/sdk';
 
 const configuration = new Configuration();
 const apiInstance = new StaffClubSettingsApi(configuration);
 
-let getClubSettingsRequest: GetClubSettingsRequest; //
-
-const { status, data } = await apiInstance.getClubSettings(
-    getClubSettingsRequest
-);
+const { status, data } = await apiInstance.getClubSettings();
 ```
 
 ### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **getClubSettingsRequest** | **GetClubSettingsRequest**|  | |
+This endpoint does not have any parameters.
 
 
 ### Return type
@@ -46,7 +38,7 @@ const { status, data } = await apiInstance.getClubSettings(
 
 ### HTTP request headers
 
- - **Content-Type**: application/json
+ - **Content-Type**: Not defined
  - **Accept**: application/json
 
 

package/docs/YearlyTurnoverResponse.md

@@ -0,0 +1,26 @@
+# YearlyTurnoverResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**year** | **number** |  | [optional] [default to undefined]
+**totalTurnover** | **number** |  | [optional] [default to undefined]
+**totalInvoices** | **number** |  | [optional] [default to undefined]
+**monthlyBreakdown** | [**Array<YearlyTurnoverResponseMonthlyBreakdownInner>**](YearlyTurnoverResponseMonthlyBreakdownInner.md) |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { YearlyTurnoverResponse } from '@tennac-booking/sdk';
+
+const instance: YearlyTurnoverResponse = {
+    year,
+    totalTurnover,
+    totalInvoices,
+    monthlyBreakdown,
+};
+```
+
+[[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/YearlyTurnoverResponseMonthlyBreakdownInner.md

@@ -0,0 +1,24 @@
+# YearlyTurnoverResponseMonthlyBreakdownInner
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**month** | **number** |  | [optional] [default to undefined]
+**monthlyTurnover** | **number** |  | [optional] [default to undefined]
+**invoiceCount** | **number** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { YearlyTurnoverResponseMonthlyBreakdownInner } from '@tennac-booking/sdk';
+
+const instance: YearlyTurnoverResponseMonthlyBreakdownInner = {
+    month,
+    monthlyTurnover,
+    invoiceCount,
+};
+```
+
+[[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/index.ts

@@ -1,10 +1,10 @@
 /* tslint:disable */
 /* eslint-disable */
 /**
- * Pickle Ball API
+ * Pandook API
  * API for managing pickle ball games and players
  *
- * The version of the OpenAPI document: 1.0.17
+ * The version of the OpenAPI document: 1.0.21
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tennac-booking/sdk",
-  "version": "1.0.19",
+  "version": "1.0.21",
   "description": "OpenAPI client for @tennac-booking/sdk",
   "author": "OpenAPI-Generator Contributors",
   "publishConfig": {