@factpulse/sdk 4.0.0 → 4.0.1

package/docs/ClientManagementApi.md

@@ -0,0 +1,483 @@
+# ClientManagementApi
+
+All URIs are relative to *https://factpulse.fr*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**activateClientApiV1ClientsUidActiverPost**](#activateclientapiv1clientsuidactiverpost) | **POST** /api/v1/clients/{uid}/activer | Activate a client|
+|[**createClientApiV1ClientsPost**](#createclientapiv1clientspost) | **POST** /api/v1/clients | Create a client|
+|[**deactivateClientApiV1ClientsUidDesactiverPost**](#deactivateclientapiv1clientsuiddesactiverpost) | **POST** /api/v1/clients/{uid}/desactiver | Deactivate a client|
+|[**getClientApiV1ClientsUidGet**](#getclientapiv1clientsuidget) | **GET** /api/v1/clients/{uid} | Get client details|
+|[**getPdpConfigApiV1ClientsUidPdpConfigGet**](#getpdpconfigapiv1clientsuidpdpconfigget) | **GET** /api/v1/clients/{uid}/pdp-config | Get client PDP configuration|
+|[**listClientsApiV1ClientsGet**](#listclientsapiv1clientsget) | **GET** /api/v1/clients | List clients|
+|[**updateClientApiV1ClientsUidPatch**](#updateclientapiv1clientsuidpatch) | **PATCH** /api/v1/clients/{uid} | Update a client|
+|[**updatePdpConfigApiV1ClientsUidPdpConfigPut**](#updatepdpconfigapiv1clientsuidpdpconfigput) | **PUT** /api/v1/clients/{uid}/pdp-config | Configure client PDP|
+
+# **activateClientApiV1ClientsUidActiverPost**
+> ClientActivateResponse activateClientApiV1ClientsUidActiverPost()
+
+Activate a deactivated client.  **Scope**: Client level (JWT with client_uid that must match {uid})
+
+### Example
+
+```typescript
+import {
+    ClientManagementApi,
+    Configuration
+} from '@factpulse/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ClientManagementApi(configuration);
+
+let uid: string; // (default to undefined)
+
+const { status, data } = await apiInstance.activateClientApiV1ClientsUidActiverPost(
+    uid
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **uid** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**ClientActivateResponse**
+
+### Authorization
+
+[HTTPBearer](../README.md#HTTPBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successful Response |  -  |
+|**400** | Invalid request |  -  |
+|**401** | Missing or invalid JWT token |  -  |
+|**403** | Access denied |  -  |
+|**404** | Client not found |  -  |
+|**500** | Server error |  -  |
+|**422** | Validation 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)
+
+# **createClientApiV1ClientsPost**
+> ClientDetail createClientApiV1ClientsPost(clientCreateRequest)
+
+Create a new client for the account.  **Scope**: Account level (JWT without client_uid)  **Fields**: - `name`: Client name (required) - `description`: Optional description - `siret`: Optional SIRET (14 digits)
+
+### Example
+
+```typescript
+import {
+    ClientManagementApi,
+    Configuration,
+    ClientCreateRequest
+} from '@factpulse/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ClientManagementApi(configuration);
+
+let clientCreateRequest: ClientCreateRequest; //
+
+const { status, data } = await apiInstance.createClientApiV1ClientsPost(
+    clientCreateRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **clientCreateRequest** | **ClientCreateRequest**|  | |
+
+
+### Return type
+
+**ClientDetail**
+
+### Authorization
+
+[HTTPBearer](../README.md#HTTPBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**201** | Successful Response |  -  |
+|**400** | Invalid request |  -  |
+|**401** | Missing or invalid JWT token |  -  |
+|**403** | Access denied |  -  |
+|**404** | Client not found |  -  |
+|**500** | Server error |  -  |
+|**422** | Validation 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)
+
+# **deactivateClientApiV1ClientsUidDesactiverPost**
+> ClientActivateResponse deactivateClientApiV1ClientsUidDesactiverPost()
+
+Deactivate an active client.  **Scope**: Client level (JWT with client_uid that must match {uid})  **Note**: A deactivated client cannot be used for API calls (AFNOR, Chorus Pro, etc.).
+
+### Example
+
+```typescript
+import {
+    ClientManagementApi,
+    Configuration
+} from '@factpulse/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ClientManagementApi(configuration);
+
+let uid: string; // (default to undefined)
+
+const { status, data } = await apiInstance.deactivateClientApiV1ClientsUidDesactiverPost(
+    uid
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **uid** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**ClientActivateResponse**
+
+### Authorization
+
+[HTTPBearer](../README.md#HTTPBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successful Response |  -  |
+|**400** | Invalid request |  -  |
+|**401** | Missing or invalid JWT token |  -  |
+|**403** | Access denied |  -  |
+|**404** | Client not found |  -  |
+|**500** | Server error |  -  |
+|**422** | Validation 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)
+
+# **getClientApiV1ClientsUidGet**
+> ClientDetail getClientApiV1ClientsUidGet()
+
+Get details of a client.  **Scope**: Client level (JWT with client_uid that must match {uid})  **Security**: If the JWT contains a client_uid, it must match the {uid} in the URL, otherwise a 403 error is returned.
+
+### Example
+
+```typescript
+import {
+    ClientManagementApi,
+    Configuration
+} from '@factpulse/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ClientManagementApi(configuration);
+
+let uid: string; // (default to undefined)
+
+const { status, data } = await apiInstance.getClientApiV1ClientsUidGet(
+    uid
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **uid** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**ClientDetail**
+
+### Authorization
+
+[HTTPBearer](../README.md#HTTPBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successful Response |  -  |
+|**400** | Invalid request |  -  |
+|**401** | Missing or invalid JWT token |  -  |
+|**403** | Access denied |  -  |
+|**404** | Client not found |  -  |
+|**500** | Server error |  -  |
+|**422** | Validation 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)
+
+# **getPdpConfigApiV1ClientsUidPdpConfigGet**
+> PDPConfigResponse getPdpConfigApiV1ClientsUidPdpConfigGet()
+
+Get the PDP (PA/PDP) configuration for a client.  **Scope**: Client level (JWT with client_uid that must match {uid})  **Security**: The client secret is never returned. Only a status (`secretStatus`) indicates whether a secret is configured.  **Response**: - If configured: all config details (URLs, client_id, secret status) - If not configured: `isConfigured: false` with a message
+
+### Example
+
+```typescript
+import {
+    ClientManagementApi,
+    Configuration
+} from '@factpulse/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ClientManagementApi(configuration);
+
+let uid: string; // (default to undefined)
+
+const { status, data } = await apiInstance.getPdpConfigApiV1ClientsUidPdpConfigGet(
+    uid
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **uid** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**PDPConfigResponse**
+
+### Authorization
+
+[HTTPBearer](../README.md#HTTPBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successful Response |  -  |
+|**400** | Invalid request |  -  |
+|**401** | Missing or invalid JWT token |  -  |
+|**403** | Access denied |  -  |
+|**404** | Client not found |  -  |
+|**500** | Server error |  -  |
+|**422** | Validation 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)
+
+# **listClientsApiV1ClientsGet**
+> ClientListResponse listClientsApiV1ClientsGet()
+
+Paginated list of clients for the account.  **Scope**: Account level (JWT without client_uid)  **Pagination**: - `page`: Page number (default: 1) - `pageSize`: Page size (default: 20, max: 100)
+
+### Example
+
+```typescript
+import {
+    ClientManagementApi,
+    Configuration
+} from '@factpulse/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ClientManagementApi(configuration);
+
+let page: number; //Page number (optional) (default to 1)
+let pageSize: number; //Page size (optional) (default to 20)
+
+const { status, data } = await apiInstance.listClientsApiV1ClientsGet(
+    page,
+    pageSize
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **page** | [**number**] | Page number | (optional) defaults to 1|
+| **pageSize** | [**number**] | Page size | (optional) defaults to 20|
+
+
+### Return type
+
+**ClientListResponse**
+
+### Authorization
+
+[HTTPBearer](../README.md#HTTPBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successful Response |  -  |
+|**400** | Invalid request |  -  |
+|**401** | Missing or invalid JWT token |  -  |
+|**403** | Access denied |  -  |
+|**404** | Client not found |  -  |
+|**500** | Server error |  -  |
+|**422** | Validation 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)
+
+# **updateClientApiV1ClientsUidPatch**
+> ClientDetail updateClientApiV1ClientsUidPatch(clientUpdateRequest)
+
+Update client information (partial update).  **Scope**: Client level (JWT with client_uid that must match {uid})  **Updatable fields**: - `name`: Client name - `description`: Description - `siret`: SIRET (14 digits)  Only provided fields are updated.
+
+### Example
+
+```typescript
+import {
+    ClientManagementApi,
+    Configuration,
+    ClientUpdateRequest
+} from '@factpulse/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ClientManagementApi(configuration);
+
+let uid: string; // (default to undefined)
+let clientUpdateRequest: ClientUpdateRequest; //
+
+const { status, data } = await apiInstance.updateClientApiV1ClientsUidPatch(
+    uid,
+    clientUpdateRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **clientUpdateRequest** | **ClientUpdateRequest**|  | |
+| **uid** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**ClientDetail**
+
+### Authorization
+
+[HTTPBearer](../README.md#HTTPBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successful Response |  -  |
+|**400** | Invalid request |  -  |
+|**401** | Missing or invalid JWT token |  -  |
+|**403** | Access denied |  -  |
+|**404** | Client not found |  -  |
+|**500** | Server error |  -  |
+|**422** | Validation 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)
+
+# **updatePdpConfigApiV1ClientsUidPdpConfigPut**
+> PDPConfigResponse updatePdpConfigApiV1ClientsUidPdpConfigPut(pDPConfigUpdateRequest)
+
+Configure or update the PDP (PA/PDP) configuration for a client.  **Scope**: Client level (JWT with client_uid that must match {uid})  **Required fields**: - `flowServiceUrl`: PDP Flow Service URL - `tokenUrl`: PDP OAuth token URL - `oauthClientId`: OAuth Client ID - `clientSecret`: OAuth Client Secret (sent but NEVER returned)  **Optional fields**: - `isActive`: Enable/disable the config (default: true) - `modeSandbox`: Sandbox mode (default: false)  **Security**: The `clientSecret` is stored encrypted on Django side and is never returned in API responses.
+
+### Example
+
+```typescript
+import {
+    ClientManagementApi,
+    Configuration,
+    PDPConfigUpdateRequest
+} from '@factpulse/sdk';
+
+const configuration = new Configuration();
+const apiInstance = new ClientManagementApi(configuration);
+
+let uid: string; // (default to undefined)
+let pDPConfigUpdateRequest: PDPConfigUpdateRequest; //
+
+const { status, data } = await apiInstance.updatePdpConfigApiV1ClientsUidPdpConfigPut(
+    uid,
+    pDPConfigUpdateRequest
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **pDPConfigUpdateRequest** | **PDPConfigUpdateRequest**|  | |
+| **uid** | [**string**] |  | defaults to undefined|
+
+
+### Return type
+
+**PDPConfigResponse**
+
+### Authorization
+
+[HTTPBearer](../README.md#HTTPBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successful Response |  -  |
+|**400** | Invalid request |  -  |
+|**401** | Missing or invalid JWT token |  -  |
+|**403** | Access denied |  -  |
+|**404** | Client not found |  -  |
+|**500** | Server error |  -  |
+|**422** | Validation 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)
+

package/docs/ClientSummary.md

@@ -0,0 +1,41 @@
+# ClientSummary
+
+Client list view.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**uid** | **string** | Unique client identifier | [default to undefined]
+**name** | **string** | Client name | [default to undefined]
+**siret** | **string** |  | [optional] [default to undefined]
+**description** | **string** |  | [optional] [default to undefined]
+**isActive** | **boolean** | Whether the client is active | [default to undefined]
+**hasConfigPdp** | **boolean** | Whether PDP config exists | [default to undefined]
+**pdpIsActive** | **boolean** |  | [optional] [default to undefined]
+**pdpIsMock** | **boolean** |  | [optional] [default to undefined]
+**hasConfigChorus** | **boolean** | Whether Chorus Pro config exists | [default to undefined]
+**createdAt** | **string** | Creation date | [default to undefined]
+**updatedAt** | **string** | Last update date | [default to undefined]
+
+## Example
+
+```typescript
+import { ClientSummary } from '@factpulse/sdk';
+
+const instance: ClientSummary = {
+    uid,
+    name,
+    siret,
+    description,
+    isActive,
+    hasConfigPdp,
+    pdpIsActive,
+    pdpIsMock,
+    hasConfigChorus,
+    createdAt,
+    updatedAt,
+};
+```
+
+[[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/ClientUpdateRequest.md

@@ -0,0 +1,25 @@
+# ClientUpdateRequest
+
+Partial client update request.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **string** |  | [optional] [default to undefined]
+**description** | **string** |  | [optional] [default to undefined]
+**siret** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { ClientUpdateRequest } from '@factpulse/sdk';
+
+const instance: ClientUpdateRequest = {
+    name,
+    description,
+    siret,
+};
+```
+
+[[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/DownloadsApi.md

@@ -5,9 +5,7 @@ All URIs are relative to *https://factpulse.fr*
 |Method | HTTP request | Description|
 |------------- | ------------- | -------------|
 |[**checkFileApiV1DownloadDownloadIdHead**](#checkfileapiv1downloaddownloadidhead) | **HEAD** /api/v1/download/{download_id} | Check if a file exists|
-|[**checkFileApiV1DownloadDownloadIdHead_0**](#checkfileapiv1downloaddownloadidhead_0) | **HEAD** /api/v1/download/{download_id} | Check if a file exists|
 |[**downloadFileApiV1DownloadDownloadIdGet**](#downloadfileapiv1downloaddownloadidget) | **GET** /api/v1/download/{download_id} | Download a temporary file|
-|[**downloadFileApiV1DownloadDownloadIdGet_0**](#downloadfileapiv1downloaddownloadidget_0) | **GET** /api/v1/download/{download_id} | Download a temporary file|
 
 # **checkFileApiV1DownloadDownloadIdHead**
 > any checkFileApiV1DownloadDownloadIdHead()
@@ -39,61 +37,6 @@ const { status, data } = await apiInstance.checkFileApiV1DownloadDownloadIdHead(
 | **downloadId** | [**string**] |  | defaults to undefined|
 
 
-### Return type
-
-**any**
-
-### Authorization
-
-[HTTPBearer](../README.md#HTTPBearer)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | File exists |  -  |
-|**401** | Authentication required |  -  |
-|**403** | Access denied |  -  |
-|**404** | File not found or expired |  -  |
-|**422** | Validation 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)
-
-# **checkFileApiV1DownloadDownloadIdHead_0**
-> any checkFileApiV1DownloadDownloadIdHead_0()
-
-Check if a temporary file exists and get its metadata without downloading.  Useful for: - Verifying a download URL is still valid - Getting file size before downloading - Checking expiration time  **Security**: Requires authentication, only file owner can check.
-
-### Example
-
-```typescript
-import {
-    DownloadsApi,
-    Configuration
-} from '@factpulse/sdk';
-
-const configuration = new Configuration();
-const apiInstance = new DownloadsApi(configuration);
-
-let downloadId: string; // (default to undefined)
-
-const { status, data } = await apiInstance.checkFileApiV1DownloadDownloadIdHead_0(
-    downloadId
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **downloadId** | [**string**] |  | defaults to undefined|
-
-
 ### Return type
 
 **any**
@@ -177,61 +120,3 @@ const { status, data } = await apiInstance.downloadFileApiV1DownloadDownloadIdGe
 
 [[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)
 
-# **downloadFileApiV1DownloadDownloadIdGet_0**
-> any downloadFileApiV1DownloadDownloadIdGet_0()
-
-Download a file stored temporarily after asynchronous processing.  **Usage**: - This URL is provided in webhook notifications when using `webhook_mode: \"download_url\"` - Files are automatically deleted after 1 hour - Each file can only be downloaded until it expires  **Security**: - Requires a valid JWT token - Only the user who initiated the task can download the file
-
-### Example
-
-```typescript
-import {
-    DownloadsApi,
-    Configuration
-} from '@factpulse/sdk';
-
-const configuration = new Configuration();
-const apiInstance = new DownloadsApi(configuration);
-
-let downloadId: string; // (default to undefined)
-let deleteAfter: boolean; //If true, delete the file after download (one-time download) (optional) (default to false)
-
-const { status, data } = await apiInstance.downloadFileApiV1DownloadDownloadIdGet_0(
-    downloadId,
-    deleteAfter
-);
-```
-
-### Parameters
-
-|Name | Type | Description  | Notes|
-|------------- | ------------- | ------------- | -------------|
-| **downloadId** | [**string**] |  | defaults to undefined|
-| **deleteAfter** | [**boolean**] | If true, delete the file after download (one-time download) | (optional) defaults to false|
-
-
-### Return type
-
-**any**
-
-### Authorization
-
-[HTTPBearer](../README.md#HTTPBearer)
-
-### HTTP request headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json, application/pdf, application/xml, application/octet-stream
-
-
-### HTTP response details
-| Status code | Description | Response headers |
-|-------------|-------------|------------------|
-|**200** | File content |  -  |
-|**401** | Authentication required |  -  |
-|**403** | Access denied - file belongs to another user |  -  |
-|**404** | File not found or expired |  -  |
-|**422** | Validation 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)
-