factpulse 3.0.9 → 3.0.13

data/lib/factpulse/api/downloads_api.rb

@@ -0,0 +1,280 @@
+=begin
+#FactPulse REST API
+
+# 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/     
+
+The version of the OpenAPI document: 1.0.0
+Contact: contact@factpulse.fr
+Generated by: https://openapi-generator.tech
+Generator version: 7.19.0-SNAPSHOT
+
+=end
+
+require 'cgi'
+
+module FactPulse
+  class DownloadsApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+    # Check if a file exists
+    # 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.
+    # @param download_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Object]
+    def check_file_api_v1_download_download_id_head(download_id, opts = {})
+      data, _status_code, _headers = check_file_api_v1_download_download_id_head_with_http_info(download_id, opts)
+      data
+    end
+
+    # Check if a file exists
+    # 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.
+    # @param download_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def check_file_api_v1_download_download_id_head_with_http_info(download_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DownloadsApi.check_file_api_v1_download_download_id_head ...'
+      end
+      # verify the required parameter 'download_id' is set
+      if @api_client.config.client_side_validation && download_id.nil?
+        fail ArgumentError, "Missing the required parameter 'download_id' when calling DownloadsApi.check_file_api_v1_download_download_id_head"
+      end
+      # resource path
+      local_var_path = '/api/v1/download/{download_id}'.sub('{' + 'download_id' + '}', CGI.escape(download_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Object'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['HTTPBearer']
+
+      new_options = opts.merge(
+        :operation => :"DownloadsApi.check_file_api_v1_download_download_id_head",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:HEAD, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DownloadsApi#check_file_api_v1_download_download_id_head\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Check if a file exists
+    # 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.
+    # @param download_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Object]
+    def check_file_api_v1_download_download_id_head_0(download_id, opts = {})
+      data, _status_code, _headers = check_file_api_v1_download_download_id_head_0_with_http_info(download_id, opts)
+      data
+    end
+
+    # Check if a file exists
+    # 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.
+    # @param download_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def check_file_api_v1_download_download_id_head_0_with_http_info(download_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DownloadsApi.check_file_api_v1_download_download_id_head_0 ...'
+      end
+      # verify the required parameter 'download_id' is set
+      if @api_client.config.client_side_validation && download_id.nil?
+        fail ArgumentError, "Missing the required parameter 'download_id' when calling DownloadsApi.check_file_api_v1_download_download_id_head_0"
+      end
+      # resource path
+      local_var_path = '/api/v1/download/{download_id}'.sub('{' + 'download_id' + '}', CGI.escape(download_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Object'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['HTTPBearer']
+
+      new_options = opts.merge(
+        :operation => :"DownloadsApi.check_file_api_v1_download_download_id_head_0",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:HEAD, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DownloadsApi#check_file_api_v1_download_download_id_head_0\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Download a temporary file
+    # 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
+    # @param download_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :delete_after If true, delete the file after download (one-time download) (default to false)
+    # @return [Object]
+    def download_file_api_v1_download_download_id_get(download_id, opts = {})
+      data, _status_code, _headers = download_file_api_v1_download_download_id_get_with_http_info(download_id, opts)
+      data
+    end
+
+    # Download a temporary file
+    # Download a file stored temporarily after asynchronous processing.  **Usage**: - This URL is provided in webhook notifications when using &#x60;webhook_mode: \&quot;download_url\&quot;&#x60; - 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
+    # @param download_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :delete_after If true, delete the file after download (one-time download) (default to false)
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def download_file_api_v1_download_download_id_get_with_http_info(download_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DownloadsApi.download_file_api_v1_download_download_id_get ...'
+      end
+      # verify the required parameter 'download_id' is set
+      if @api_client.config.client_side_validation && download_id.nil?
+        fail ArgumentError, "Missing the required parameter 'download_id' when calling DownloadsApi.download_file_api_v1_download_download_id_get"
+      end
+      # resource path
+      local_var_path = '/api/v1/download/{download_id}'.sub('{' + 'download_id' + '}', CGI.escape(download_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'delete_after'] = opts[:'delete_after'] if !opts[:'delete_after'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/pdf', 'application/xml', 'application/octet-stream']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Object'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['HTTPBearer']
+
+      new_options = opts.merge(
+        :operation => :"DownloadsApi.download_file_api_v1_download_download_id_get",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DownloadsApi#download_file_api_v1_download_download_id_get\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Download a temporary file
+    # 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
+    # @param download_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :delete_after If true, delete the file after download (one-time download) (default to false)
+    # @return [Object]
+    def download_file_api_v1_download_download_id_get_0(download_id, opts = {})
+      data, _status_code, _headers = download_file_api_v1_download_download_id_get_0_with_http_info(download_id, opts)
+      data
+    end
+
+    # Download a temporary file
+    # Download a file stored temporarily after asynchronous processing.  **Usage**: - This URL is provided in webhook notifications when using &#x60;webhook_mode: \&quot;download_url\&quot;&#x60; - 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
+    # @param download_id [String] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :delete_after If true, delete the file after download (one-time download) (default to false)
+    # @return [Array<(Object, Integer, Hash)>] Object data, response status code and response headers
+    def download_file_api_v1_download_download_id_get_0_with_http_info(download_id, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: DownloadsApi.download_file_api_v1_download_download_id_get_0 ...'
+      end
+      # verify the required parameter 'download_id' is set
+      if @api_client.config.client_side_validation && download_id.nil?
+        fail ArgumentError, "Missing the required parameter 'download_id' when calling DownloadsApi.download_file_api_v1_download_download_id_get_0"
+      end
+      # resource path
+      local_var_path = '/api/v1/download/{download_id}'.sub('{' + 'download_id' + '}', CGI.escape(download_id.to_s))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'delete_after'] = opts[:'delete_after'] if !opts[:'delete_after'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'application/pdf', 'application/xml', 'application/octet-stream']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'Object'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || ['HTTPBearer']
+
+      new_options = opts.merge(
+        :operation => :"DownloadsApi.download_file_api_v1_download_download_id_get_0",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: DownloadsApi#download_file_api_v1_download_download_id_get_0\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+  end
+end