@factpulse/sdk 3.0.37 → 4.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (222) hide show
  1. package/.openapi-generator/FILES +32 -8
  2. package/.openapi-generator/VERSION +1 -1
  3. package/CHANGELOG.md +5 -12
  4. package/README.md +135 -148
  5. package/api/cdarcycle-de-vie-api.ts +186 -86
  6. package/api/client-management-api.ts +672 -0
  7. package/api/downloads-api.ts +0 -152
  8. package/api/invoice-processing-api.ts +2 -2
  9. package/api.ts +1 -0
  10. package/dist/api/cdarcycle-de-vie-api.d.ts +93 -50
  11. package/dist/api/cdarcycle-de-vie-api.js +174 -80
  12. package/dist/api/client-management-api.d.ts +309 -0
  13. package/dist/api/client-management-api.js +642 -0
  14. package/dist/api/downloads-api.d.ts +0 -68
  15. package/dist/api/downloads-api.js +0 -145
  16. package/dist/api.d.ts +1 -0
  17. package/dist/api.js +1 -0
  18. package/dist/esm/api/cdarcycle-de-vie-api.d.ts +93 -50
  19. package/dist/esm/api/cdarcycle-de-vie-api.js +174 -80
  20. package/dist/esm/api/client-management-api.d.ts +309 -0
  21. package/dist/esm/api/client-management-api.js +632 -0
  22. package/dist/esm/api/downloads-api.d.ts +0 -68
  23. package/dist/esm/api/downloads-api.js +0 -145
  24. package/dist/esm/api.d.ts +1 -0
  25. package/dist/esm/api.js +1 -0
  26. package/dist/esm/models/allowance-charge.d.ts +2 -2
  27. package/dist/esm/models/amount.d.ts +1 -1
  28. package/dist/esm/models/amount1.d.ts +1 -1
  29. package/dist/esm/models/amount2.d.ts +16 -0
  30. package/dist/esm/models/chorus-pro-credentials.d.ts +19 -7
  31. package/dist/esm/models/chorus-pro-destination.d.ts +2 -2
  32. package/dist/esm/models/{body-submit-cdar-xml-api-v1-cdar-submit-xml-post.d.ts → client-activate-response.d.ts} +16 -5
  33. package/dist/esm/models/{facture-electronique-rest-api-schemas-validation-validation-error-response.d.ts → client-create-request.d.ts} +6 -4
  34. package/dist/esm/models/client-detail.d.ts +48 -0
  35. package/dist/esm/models/client-list-response.d.ts +33 -0
  36. package/dist/esm/models/client-list-response.js +14 -0
  37. package/dist/esm/models/client-summary.d.ts +48 -0
  38. package/dist/esm/models/client-summary.js +14 -0
  39. package/dist/esm/models/client-update-request.d.ts +19 -0
  40. package/dist/esm/models/client-update-request.js +14 -0
  41. package/dist/esm/models/encaissee-request.d.ts +39 -0
  42. package/dist/esm/models/encaissee-request.js +14 -0
  43. package/dist/esm/models/facture-electronique-rest-api-schemas-cdar-validation-error-response.d.ts +29 -0
  44. package/dist/esm/models/facture-electronique-rest-api-schemas-cdar-validation-error-response.js +14 -0
  45. package/dist/esm/models/facture-electronique-rest-api-schemas-processing-chorus-pro-credentials.d.ts +24 -0
  46. package/dist/esm/models/facture-electronique-rest-api-schemas-processing-chorus-pro-credentials.js +14 -0
  47. package/dist/esm/models/get-chorus-pro-id-request.d.ts +2 -2
  48. package/dist/esm/models/get-invoice-request.d.ts +2 -2
  49. package/dist/esm/models/get-structure-request.d.ts +2 -2
  50. package/dist/esm/models/index.d.ts +15 -4
  51. package/dist/esm/models/index.js +15 -4
  52. package/dist/esm/models/payment-amount-by-rate.d.ts +2 -2
  53. package/dist/esm/models/pdpconfig-response.d.ts +34 -0
  54. package/dist/esm/models/pdpconfig-response.js +14 -0
  55. package/dist/esm/models/pdpconfig-update-request.d.ts +40 -0
  56. package/dist/esm/models/pdpconfig-update-request.js +14 -0
  57. package/dist/esm/models/recipient.d.ts +1 -1
  58. package/dist/{models/facture-electronique-rest-api-schemas-chorus-pro-chorus-pro-credentials.d.ts → esm/models/refusee-request.d.ts} +16 -14
  59. package/dist/esm/models/refusee-request.js +14 -0
  60. package/dist/esm/models/scheme-id.d.ts +7 -7
  61. package/dist/esm/models/scheme-id.js +7 -7
  62. package/dist/esm/models/search-structure-request.d.ts +2 -2
  63. package/dist/esm/models/{body-submit-cdar-api-v1-cdar-submit-post.d.ts → secret-status.d.ts} +12 -5
  64. package/dist/esm/models/secret-status.js +14 -0
  65. package/dist/esm/models/simplified-cdarresponse.d.ts +36 -0
  66. package/dist/esm/models/simplified-cdarresponse.js +14 -0
  67. package/dist/esm/models/submit-cdarrequest.d.ts +4 -0
  68. package/dist/esm/models/submit-cdarxmlrequest.d.ts +4 -0
  69. package/dist/esm/models/submit-complete-invoice-response.d.ts +1 -1
  70. package/dist/esm/models/submit-invoice-request.d.ts +2 -2
  71. package/dist/esm/models/supplier.d.ts +1 -1
  72. package/dist/esm/models/validate-cdarresponse.d.ts +3 -3
  73. package/dist/esm/models/validation-error-response.d.ts +3 -12
  74. package/dist/esm/src/helpers/client.d.ts +45 -265
  75. package/dist/esm/src/helpers/client.js +211 -773
  76. package/dist/esm/src/helpers/exceptions.d.ts +3 -1
  77. package/dist/esm/src/helpers/exceptions.js +7 -1
  78. package/dist/esm/src/helpers/index.d.ts +1 -2
  79. package/dist/esm/src/helpers/index.js +1 -3
  80. package/dist/models/allowance-charge.d.ts +2 -2
  81. package/dist/models/amount.d.ts +1 -1
  82. package/dist/models/amount1.d.ts +1 -1
  83. package/dist/models/amount2.d.ts +16 -0
  84. package/dist/models/chorus-pro-credentials.d.ts +19 -7
  85. package/dist/models/chorus-pro-destination.d.ts +2 -2
  86. package/dist/models/client-activate-response.d.ts +28 -0
  87. package/dist/models/{facture-electronique-rest-api-schemas-validation-validation-error-response.d.ts → client-create-request.d.ts} +6 -4
  88. package/dist/models/client-detail.d.ts +48 -0
  89. package/dist/models/client-list-response.d.ts +33 -0
  90. package/dist/models/client-list-response.js +15 -0
  91. package/dist/models/client-summary.d.ts +48 -0
  92. package/dist/models/client-summary.js +15 -0
  93. package/dist/models/client-update-request.d.ts +19 -0
  94. package/dist/models/client-update-request.js +15 -0
  95. package/dist/models/encaissee-request.d.ts +39 -0
  96. package/dist/models/encaissee-request.js +15 -0
  97. package/dist/models/facture-electronique-rest-api-schemas-cdar-validation-error-response.d.ts +29 -0
  98. package/dist/models/facture-electronique-rest-api-schemas-cdar-validation-error-response.js +15 -0
  99. package/dist/models/facture-electronique-rest-api-schemas-processing-chorus-pro-credentials.d.ts +24 -0
  100. package/dist/models/facture-electronique-rest-api-schemas-processing-chorus-pro-credentials.js +15 -0
  101. package/dist/models/get-chorus-pro-id-request.d.ts +2 -2
  102. package/dist/models/get-invoice-request.d.ts +2 -2
  103. package/dist/models/get-structure-request.d.ts +2 -2
  104. package/dist/models/index.d.ts +15 -4
  105. package/dist/models/index.js +15 -4
  106. package/dist/models/payment-amount-by-rate.d.ts +2 -2
  107. package/dist/models/pdpconfig-response.d.ts +34 -0
  108. package/dist/models/pdpconfig-response.js +15 -0
  109. package/dist/models/pdpconfig-update-request.d.ts +40 -0
  110. package/dist/models/pdpconfig-update-request.js +15 -0
  111. package/dist/models/recipient.d.ts +1 -1
  112. package/dist/{esm/models/facture-electronique-rest-api-schemas-chorus-pro-chorus-pro-credentials.d.ts → models/refusee-request.d.ts} +16 -14
  113. package/dist/models/refusee-request.js +15 -0
  114. package/dist/models/scheme-id.d.ts +7 -7
  115. package/dist/models/scheme-id.js +7 -7
  116. package/dist/models/search-structure-request.d.ts +2 -2
  117. package/dist/models/{body-submit-cdar-api-v1-cdar-submit-post.d.ts → secret-status.d.ts} +12 -5
  118. package/dist/models/secret-status.js +15 -0
  119. package/dist/models/simplified-cdarresponse.d.ts +36 -0
  120. package/dist/models/simplified-cdarresponse.js +15 -0
  121. package/dist/models/submit-cdarrequest.d.ts +4 -0
  122. package/dist/models/submit-cdarxmlrequest.d.ts +4 -0
  123. package/dist/models/submit-complete-invoice-response.d.ts +1 -1
  124. package/dist/models/submit-invoice-request.d.ts +2 -2
  125. package/dist/models/supplier.d.ts +1 -1
  126. package/dist/models/validate-cdarresponse.d.ts +3 -3
  127. package/dist/models/validation-error-response.d.ts +3 -12
  128. package/dist/src/helpers/client.d.ts +45 -265
  129. package/dist/src/helpers/client.js +214 -784
  130. package/dist/src/helpers/exceptions.d.ts +3 -1
  131. package/dist/src/helpers/exceptions.js +7 -1
  132. package/dist/src/helpers/index.d.ts +1 -2
  133. package/dist/src/helpers/index.js +2 -12
  134. package/docs/AllowanceCharge.md +1 -1
  135. package/docs/Amount.md +1 -1
  136. package/docs/Amount1.md +1 -1
  137. package/docs/Amount2.md +19 -0
  138. package/docs/CDARCycleDeVieApi.md +126 -30
  139. package/docs/ChorusProCredentials.md +9 -9
  140. package/docs/ChorusProDestination.md +1 -1
  141. package/docs/ClientActivateResponse.md +25 -0
  142. package/docs/ClientCreateRequest.md +25 -0
  143. package/docs/ClientDetail.md +41 -0
  144. package/docs/ClientListResponse.md +27 -0
  145. package/docs/ClientManagementApi.md +483 -0
  146. package/docs/ClientSummary.md +41 -0
  147. package/docs/ClientUpdateRequest.md +25 -0
  148. package/docs/DownloadsApi.md +0 -115
  149. package/docs/EncaisseeRequest.md +39 -0
  150. package/docs/FactureElectroniqueRestApiSchemasCdarValidationErrorResponse.md +27 -0
  151. package/docs/FactureElectroniqueRestApiSchemasProcessingChorusProCredentials.md +29 -0
  152. package/docs/GetChorusProIdRequest.md +1 -1
  153. package/docs/GetInvoiceRequest.md +1 -1
  154. package/docs/GetStructureRequest.md +1 -1
  155. package/docs/PDPConfigResponse.md +47 -0
  156. package/docs/PDPConfigUpdateRequest.md +31 -0
  157. package/docs/PaymentAmountByRate.md +1 -1
  158. package/docs/Recipient.md +1 -1
  159. package/docs/RefuseeRequest.md +39 -0
  160. package/docs/SchemeID.md +4 -4
  161. package/docs/SearchStructureRequest.md +1 -1
  162. package/docs/SecretStatus.md +23 -0
  163. package/docs/SimplifiedCDARResponse.md +29 -0
  164. package/docs/SubmitCDARRequest.md +8 -0
  165. package/docs/SubmitCDARXMLRequest.md +8 -0
  166. package/docs/SubmitCompleteInvoiceResponse.md +2 -2
  167. package/docs/SubmitInvoiceRequest.md +1 -1
  168. package/docs/Supplier.md +1 -1
  169. package/docs/ValidateCDARResponse.md +2 -2
  170. package/docs/ValidationErrorResponse.md +3 -9
  171. package/models/allowance-charge.ts +2 -2
  172. package/models/amount.ts +1 -1
  173. package/models/amount1.ts +1 -1
  174. package/models/amount2.ts +22 -0
  175. package/models/chorus-pro-credentials.ts +19 -7
  176. package/models/chorus-pro-destination.ts +2 -2
  177. package/models/client-activate-response.ts +34 -0
  178. package/models/{facture-electronique-rest-api-schemas-validation-validation-error-response.ts → client-create-request.ts} +6 -4
  179. package/models/client-detail.ts +54 -0
  180. package/models/{body-submit-cdar-xml-api-v1-cdar-submit-xml-post.ts → client-list-response.ts} +21 -7
  181. package/models/client-summary.ts +54 -0
  182. package/models/client-update-request.ts +25 -0
  183. package/models/{facture-electronique-rest-api-schemas-chorus-pro-chorus-pro-credentials.ts → encaissee-request.ts} +19 -14
  184. package/models/{body-submit-cdar-api-v1-cdar-submit-post.ts → facture-electronique-rest-api-schemas-cdar-validation-error-response.ts} +17 -9
  185. package/models/facture-electronique-rest-api-schemas-processing-chorus-pro-credentials.ts +30 -0
  186. package/models/get-chorus-pro-id-request.ts +2 -2
  187. package/models/get-invoice-request.ts +2 -2
  188. package/models/get-structure-request.ts +2 -2
  189. package/models/index.ts +15 -4
  190. package/models/payment-amount-by-rate.ts +2 -2
  191. package/models/pdpconfig-response.ts +42 -0
  192. package/models/pdpconfig-update-request.ts +46 -0
  193. package/models/recipient.ts +1 -1
  194. package/models/refusee-request.ts +44 -0
  195. package/models/scheme-id.ts +7 -7
  196. package/models/search-structure-request.ts +2 -2
  197. package/models/secret-status.ts +30 -0
  198. package/models/simplified-cdarresponse.ts +42 -0
  199. package/models/submit-cdarrequest.ts +4 -0
  200. package/models/submit-cdarxmlrequest.ts +4 -0
  201. package/models/submit-complete-invoice-response.ts +1 -1
  202. package/models/submit-invoice-request.ts +2 -2
  203. package/models/supplier.ts +1 -1
  204. package/models/validate-cdarresponse.ts +3 -3
  205. package/models/validation-error-response.ts +3 -12
  206. package/package.json +1 -1
  207. package/src/helpers/client.ts +227 -832
  208. package/src/helpers/exceptions.ts +9 -1
  209. package/src/helpers/index.ts +1 -3
  210. package/dist/models/body-submit-cdar-xml-api-v1-cdar-submit-xml-post.d.ts +0 -17
  211. package/docs/BodySubmitCdarApiV1CdarSubmitPost.md +0 -22
  212. package/docs/BodySubmitCdarXmlApiV1CdarSubmitXmlPost.md +0 -22
  213. package/docs/FactureElectroniqueRestApiSchemasChorusProChorusProCredentials.md +0 -29
  214. package/docs/FactureElectroniqueRestApiSchemasValidationValidationErrorResponse.md +0 -21
  215. /package/dist/esm/models/{body-submit-cdar-api-v1-cdar-submit-post.js → amount2.js} +0 -0
  216. /package/dist/esm/models/{body-submit-cdar-xml-api-v1-cdar-submit-xml-post.js → client-activate-response.js} +0 -0
  217. /package/dist/esm/models/{facture-electronique-rest-api-schemas-chorus-pro-chorus-pro-credentials.js → client-create-request.js} +0 -0
  218. /package/dist/esm/models/{facture-electronique-rest-api-schemas-validation-validation-error-response.js → client-detail.js} +0 -0
  219. /package/dist/models/{body-submit-cdar-api-v1-cdar-submit-post.js → amount2.js} +0 -0
  220. /package/dist/models/{body-submit-cdar-xml-api-v1-cdar-submit-xml-post.js → client-activate-response.js} +0 -0
  221. /package/dist/models/{facture-electronique-rest-api-schemas-chorus-pro-chorus-pro-credentials.js → client-create-request.js} +0 -0
  222. /package/dist/models/{facture-electronique-rest-api-schemas-validation-validation-error-response.js → client-detail.js} +0 -0
@@ -0,0 +1,309 @@
1
+ /**
2
+ * FactPulse REST API
3
+ * REST API for electronic invoicing in France: Factur-X, AFNOR PDP/PA, electronic signatures. ## 🎯 Main Features ### 📄 Factur-X Invoice Generation - **Formats**: XML only or PDF/A-3 with embedded XML - **Profiles**: MINIMUM, BASIC, EN16931, EXTENDED - **Standards**: EN 16931 (EU directive 2014/55), ISO 19005-3 (PDF/A-3), CII (UN/CEFACT) - **🆕 Simplified Format**: Generation from SIRET + auto-enrichment (Chorus Pro API + Business Search) ### ✅ Validation and Compliance - **XML Validation**: Schematron (45 to 210+ rules depending on profile) - **PDF Validation**: PDF/A-3, Factur-X XMP metadata, electronic signatures - **VeraPDF**: Strict PDF/A validation (146+ ISO 19005-3 rules) - **Asynchronous Processing**: Celery support for heavy validations (VeraPDF) ### 📡 AFNOR PDP/PA Integration (XP Z12-013) - **Flow Submission**: Send invoices to Partner Dematerialization Platforms - **Flow Search**: View submitted invoices - **Download**: Retrieve PDF/A-3 with XML - **Directory Service**: Company search (SIREN/SIRET) - **Multi-client**: Support for multiple PDP configs per user (stored credentials or zero-storage) ### ✍️ PDF Electronic Signature - **Standards**: PAdES-B-B, PAdES-B-T (RFC 3161 timestamping), PAdES-B-LT (long-term archival) - **eIDAS Levels**: SES (self-signed), AdES (commercial CA), QES (QTSP) - **Validation**: Cryptographic integrity and certificate verification - **Certificate Generation**: Self-signed X.509 certificates for testing ### 🔄 Asynchronous Processing - **Celery**: Asynchronous generation, validation and signing - **Polling**: Status tracking via `/tasks/{task_id}/status` - **No timeout**: Ideal for large files or heavy validations ## 🔒 Authentication All requests require a **JWT token** in the Authorization header: ``` Authorization: Bearer YOUR_JWT_TOKEN ``` ### How to obtain a JWT token? #### 🔑 Method 1: `/api/token/` API (Recommended) **URL:** `https://factpulse.fr/api/token/` This method is **recommended** for integration in your applications and CI/CD workflows. **Prerequisites:** Having set a password on your account **For users registered via email/password:** - You already have a password, use it directly **For users registered via OAuth (Google/GitHub):** - You must first set a password at: https://factpulse.fr/accounts/password/set/ - Once the password is created, you can use the API **Request example:** ```bash curl -X POST https://factpulse.fr/api/token/ \\ -H \"Content-Type: application/json\" \\ -d \'{ \"username\": \"your_email@example.com\", \"password\": \"your_password\" }\' ``` **Optional `client_uid` parameter:** To select credentials for a specific client (PA/PDP, Chorus Pro, signing certificates), add `client_uid`: ```bash curl -X POST https://factpulse.fr/api/token/ \\ -H \"Content-Type: application/json\" \\ -d \'{ \"username\": \"your_email@example.com\", \"password\": \"your_password\", \"client_uid\": \"550e8400-e29b-41d4-a716-446655440000\" }\' ``` The `client_uid` will be included in the JWT and allow the API to automatically use: - AFNOR/PDP credentials configured for this client - Chorus Pro credentials configured for this client - Electronic signature certificates configured for this client **Response:** ```json { \"access\": \"eyJ0eXAiOiJKV1QiLCJhbGc...\", // Access token (validity: 30 min) \"refresh\": \"eyJ0eXAiOiJKV1QiLCJhbGc...\" // Refresh token (validity: 7 days) } ``` **Advantages:** - ✅ Full automation (CI/CD, scripts) - ✅ Programmatic token management - ✅ Refresh token support for automatic access renewal - ✅ Easy integration in any language/tool #### 🖥️ Method 2: Dashboard Generation (Alternative) **URL:** https://factpulse.fr/api/dashboard/ This method is suitable for quick tests or occasional use via the graphical interface. **How it works:** - Log in to the dashboard - Use the \"Generate Test Token\" or \"Generate Production Token\" buttons - Works for **all** users (OAuth and email/password), without requiring a password **Token types:** - **Test Token**: 24h validity, 1000 calls/day quota (free) - **Production Token**: 7 days validity, quota based on your plan **Advantages:** - ✅ Quick for API testing - ✅ No password required - ✅ Simple visual interface **Disadvantages:** - ❌ Requires manual action - ❌ No refresh token - ❌ Less suited for automation ### 📚 Full Documentation For more information on authentication and API usage: https://factpulse.fr/documentation-api/
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ * Contact: contact@factpulse.fr
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import type { Configuration } from '../configuration';
13
+ import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
14
+ import { type RequestArgs, BaseAPI } from '../base';
15
+ import type { ClientActivateResponse } from '../models';
16
+ import type { ClientCreateRequest } from '../models';
17
+ import type { ClientDetail } from '../models';
18
+ import type { ClientListResponse } from '../models';
19
+ import type { ClientUpdateRequest } from '../models';
20
+ import type { PDPConfigResponse } from '../models';
21
+ import type { PDPConfigUpdateRequest } from '../models';
22
+ /**
23
+ * ClientManagementApi - axios parameter creator
24
+ */
25
+ export declare const ClientManagementApiAxiosParamCreator: (configuration?: Configuration) => {
26
+ /**
27
+ * Activate a deactivated client. **Scope**: Client level (JWT with client_uid that must match {uid})
28
+ * @summary Activate a client
29
+ * @param {string} uid
30
+ * @param {*} [options] Override http request option.
31
+ * @throws {RequiredError}
32
+ */
33
+ activateClientApiV1ClientsUidActiverPost: (uid: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
34
+ /**
35
+ * 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)
36
+ * @summary Create a client
37
+ * @param {ClientCreateRequest} clientCreateRequest
38
+ * @param {*} [options] Override http request option.
39
+ * @throws {RequiredError}
40
+ */
41
+ createClientApiV1ClientsPost: (clientCreateRequest: ClientCreateRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
42
+ /**
43
+ * 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.).
44
+ * @summary Deactivate a client
45
+ * @param {string} uid
46
+ * @param {*} [options] Override http request option.
47
+ * @throws {RequiredError}
48
+ */
49
+ deactivateClientApiV1ClientsUidDesactiverPost: (uid: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
50
+ /**
51
+ * 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.
52
+ * @summary Get client details
53
+ * @param {string} uid
54
+ * @param {*} [options] Override http request option.
55
+ * @throws {RequiredError}
56
+ */
57
+ getClientApiV1ClientsUidGet: (uid: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
58
+ /**
59
+ * 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
60
+ * @summary Get client PDP configuration
61
+ * @param {string} uid
62
+ * @param {*} [options] Override http request option.
63
+ * @throws {RequiredError}
64
+ */
65
+ getPdpConfigApiV1ClientsUidPdpConfigGet: (uid: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
66
+ /**
67
+ * 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)
68
+ * @summary List clients
69
+ * @param {number} [page] Page number
70
+ * @param {number} [pageSize] Page size
71
+ * @param {*} [options] Override http request option.
72
+ * @throws {RequiredError}
73
+ */
74
+ listClientsApiV1ClientsGet: (page?: number, pageSize?: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
75
+ /**
76
+ * 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.
77
+ * @summary Update a client
78
+ * @param {string} uid
79
+ * @param {ClientUpdateRequest} clientUpdateRequest
80
+ * @param {*} [options] Override http request option.
81
+ * @throws {RequiredError}
82
+ */
83
+ updateClientApiV1ClientsUidPatch: (uid: string, clientUpdateRequest: ClientUpdateRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
84
+ /**
85
+ * 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.
86
+ * @summary Configure client PDP
87
+ * @param {string} uid
88
+ * @param {PDPConfigUpdateRequest} pDPConfigUpdateRequest
89
+ * @param {*} [options] Override http request option.
90
+ * @throws {RequiredError}
91
+ */
92
+ updatePdpConfigApiV1ClientsUidPdpConfigPut: (uid: string, pDPConfigUpdateRequest: PDPConfigUpdateRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
93
+ };
94
+ /**
95
+ * ClientManagementApi - functional programming interface
96
+ */
97
+ export declare const ClientManagementApiFp: (configuration?: Configuration) => {
98
+ /**
99
+ * Activate a deactivated client. **Scope**: Client level (JWT with client_uid that must match {uid})
100
+ * @summary Activate a client
101
+ * @param {string} uid
102
+ * @param {*} [options] Override http request option.
103
+ * @throws {RequiredError}
104
+ */
105
+ activateClientApiV1ClientsUidActiverPost(uid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ClientActivateResponse>>;
106
+ /**
107
+ * 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)
108
+ * @summary Create a client
109
+ * @param {ClientCreateRequest} clientCreateRequest
110
+ * @param {*} [options] Override http request option.
111
+ * @throws {RequiredError}
112
+ */
113
+ createClientApiV1ClientsPost(clientCreateRequest: ClientCreateRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ClientDetail>>;
114
+ /**
115
+ * 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.).
116
+ * @summary Deactivate a client
117
+ * @param {string} uid
118
+ * @param {*} [options] Override http request option.
119
+ * @throws {RequiredError}
120
+ */
121
+ deactivateClientApiV1ClientsUidDesactiverPost(uid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ClientActivateResponse>>;
122
+ /**
123
+ * 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.
124
+ * @summary Get client details
125
+ * @param {string} uid
126
+ * @param {*} [options] Override http request option.
127
+ * @throws {RequiredError}
128
+ */
129
+ getClientApiV1ClientsUidGet(uid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ClientDetail>>;
130
+ /**
131
+ * 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
132
+ * @summary Get client PDP configuration
133
+ * @param {string} uid
134
+ * @param {*} [options] Override http request option.
135
+ * @throws {RequiredError}
136
+ */
137
+ getPdpConfigApiV1ClientsUidPdpConfigGet(uid: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PDPConfigResponse>>;
138
+ /**
139
+ * 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)
140
+ * @summary List clients
141
+ * @param {number} [page] Page number
142
+ * @param {number} [pageSize] Page size
143
+ * @param {*} [options] Override http request option.
144
+ * @throws {RequiredError}
145
+ */
146
+ listClientsApiV1ClientsGet(page?: number, pageSize?: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ClientListResponse>>;
147
+ /**
148
+ * 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.
149
+ * @summary Update a client
150
+ * @param {string} uid
151
+ * @param {ClientUpdateRequest} clientUpdateRequest
152
+ * @param {*} [options] Override http request option.
153
+ * @throws {RequiredError}
154
+ */
155
+ updateClientApiV1ClientsUidPatch(uid: string, clientUpdateRequest: ClientUpdateRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ClientDetail>>;
156
+ /**
157
+ * 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.
158
+ * @summary Configure client PDP
159
+ * @param {string} uid
160
+ * @param {PDPConfigUpdateRequest} pDPConfigUpdateRequest
161
+ * @param {*} [options] Override http request option.
162
+ * @throws {RequiredError}
163
+ */
164
+ updatePdpConfigApiV1ClientsUidPdpConfigPut(uid: string, pDPConfigUpdateRequest: PDPConfigUpdateRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PDPConfigResponse>>;
165
+ };
166
+ /**
167
+ * ClientManagementApi - factory interface
168
+ */
169
+ export declare const ClientManagementApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
170
+ /**
171
+ * Activate a deactivated client. **Scope**: Client level (JWT with client_uid that must match {uid})
172
+ * @summary Activate a client
173
+ * @param {string} uid
174
+ * @param {*} [options] Override http request option.
175
+ * @throws {RequiredError}
176
+ */
177
+ activateClientApiV1ClientsUidActiverPost(uid: string, options?: RawAxiosRequestConfig): AxiosPromise<ClientActivateResponse>;
178
+ /**
179
+ * 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)
180
+ * @summary Create a client
181
+ * @param {ClientCreateRequest} clientCreateRequest
182
+ * @param {*} [options] Override http request option.
183
+ * @throws {RequiredError}
184
+ */
185
+ createClientApiV1ClientsPost(clientCreateRequest: ClientCreateRequest, options?: RawAxiosRequestConfig): AxiosPromise<ClientDetail>;
186
+ /**
187
+ * 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.).
188
+ * @summary Deactivate a client
189
+ * @param {string} uid
190
+ * @param {*} [options] Override http request option.
191
+ * @throws {RequiredError}
192
+ */
193
+ deactivateClientApiV1ClientsUidDesactiverPost(uid: string, options?: RawAxiosRequestConfig): AxiosPromise<ClientActivateResponse>;
194
+ /**
195
+ * 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.
196
+ * @summary Get client details
197
+ * @param {string} uid
198
+ * @param {*} [options] Override http request option.
199
+ * @throws {RequiredError}
200
+ */
201
+ getClientApiV1ClientsUidGet(uid: string, options?: RawAxiosRequestConfig): AxiosPromise<ClientDetail>;
202
+ /**
203
+ * 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
204
+ * @summary Get client PDP configuration
205
+ * @param {string} uid
206
+ * @param {*} [options] Override http request option.
207
+ * @throws {RequiredError}
208
+ */
209
+ getPdpConfigApiV1ClientsUidPdpConfigGet(uid: string, options?: RawAxiosRequestConfig): AxiosPromise<PDPConfigResponse>;
210
+ /**
211
+ * 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)
212
+ * @summary List clients
213
+ * @param {number} [page] Page number
214
+ * @param {number} [pageSize] Page size
215
+ * @param {*} [options] Override http request option.
216
+ * @throws {RequiredError}
217
+ */
218
+ listClientsApiV1ClientsGet(page?: number, pageSize?: number, options?: RawAxiosRequestConfig): AxiosPromise<ClientListResponse>;
219
+ /**
220
+ * 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.
221
+ * @summary Update a client
222
+ * @param {string} uid
223
+ * @param {ClientUpdateRequest} clientUpdateRequest
224
+ * @param {*} [options] Override http request option.
225
+ * @throws {RequiredError}
226
+ */
227
+ updateClientApiV1ClientsUidPatch(uid: string, clientUpdateRequest: ClientUpdateRequest, options?: RawAxiosRequestConfig): AxiosPromise<ClientDetail>;
228
+ /**
229
+ * 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.
230
+ * @summary Configure client PDP
231
+ * @param {string} uid
232
+ * @param {PDPConfigUpdateRequest} pDPConfigUpdateRequest
233
+ * @param {*} [options] Override http request option.
234
+ * @throws {RequiredError}
235
+ */
236
+ updatePdpConfigApiV1ClientsUidPdpConfigPut(uid: string, pDPConfigUpdateRequest: PDPConfigUpdateRequest, options?: RawAxiosRequestConfig): AxiosPromise<PDPConfigResponse>;
237
+ };
238
+ /**
239
+ * ClientManagementApi - object-oriented interface
240
+ */
241
+ export declare class ClientManagementApi extends BaseAPI {
242
+ /**
243
+ * Activate a deactivated client. **Scope**: Client level (JWT with client_uid that must match {uid})
244
+ * @summary Activate a client
245
+ * @param {string} uid
246
+ * @param {*} [options] Override http request option.
247
+ * @throws {RequiredError}
248
+ */
249
+ activateClientApiV1ClientsUidActiverPost(uid: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ClientActivateResponse, any, {}>>;
250
+ /**
251
+ * 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)
252
+ * @summary Create a client
253
+ * @param {ClientCreateRequest} clientCreateRequest
254
+ * @param {*} [options] Override http request option.
255
+ * @throws {RequiredError}
256
+ */
257
+ createClientApiV1ClientsPost(clientCreateRequest: ClientCreateRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ClientDetail, any, {}>>;
258
+ /**
259
+ * 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.).
260
+ * @summary Deactivate a client
261
+ * @param {string} uid
262
+ * @param {*} [options] Override http request option.
263
+ * @throws {RequiredError}
264
+ */
265
+ deactivateClientApiV1ClientsUidDesactiverPost(uid: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ClientActivateResponse, any, {}>>;
266
+ /**
267
+ * 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.
268
+ * @summary Get client details
269
+ * @param {string} uid
270
+ * @param {*} [options] Override http request option.
271
+ * @throws {RequiredError}
272
+ */
273
+ getClientApiV1ClientsUidGet(uid: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ClientDetail, any, {}>>;
274
+ /**
275
+ * 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
276
+ * @summary Get client PDP configuration
277
+ * @param {string} uid
278
+ * @param {*} [options] Override http request option.
279
+ * @throws {RequiredError}
280
+ */
281
+ getPdpConfigApiV1ClientsUidPdpConfigGet(uid: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PDPConfigResponse, any, {}>>;
282
+ /**
283
+ * 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)
284
+ * @summary List clients
285
+ * @param {number} [page] Page number
286
+ * @param {number} [pageSize] Page size
287
+ * @param {*} [options] Override http request option.
288
+ * @throws {RequiredError}
289
+ */
290
+ listClientsApiV1ClientsGet(page?: number, pageSize?: number, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ClientListResponse, any, {}>>;
291
+ /**
292
+ * 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.
293
+ * @summary Update a client
294
+ * @param {string} uid
295
+ * @param {ClientUpdateRequest} clientUpdateRequest
296
+ * @param {*} [options] Override http request option.
297
+ * @throws {RequiredError}
298
+ */
299
+ updateClientApiV1ClientsUidPatch(uid: string, clientUpdateRequest: ClientUpdateRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ClientDetail, any, {}>>;
300
+ /**
301
+ * 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.
302
+ * @summary Configure client PDP
303
+ * @param {string} uid
304
+ * @param {PDPConfigUpdateRequest} pDPConfigUpdateRequest
305
+ * @param {*} [options] Override http request option.
306
+ * @throws {RequiredError}
307
+ */
308
+ updatePdpConfigApiV1ClientsUidPdpConfigPut(uid: string, pDPConfigUpdateRequest: PDPConfigUpdateRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PDPConfigResponse, any, {}>>;
309
+ }