factpulse 0.1.0

data/lib/factpulse/models/create_cdar_request.rb

@@ -0,0 +1,414 @@
+=begin
+#FactPulse REST API
+
+# REST API for electronic invoicing in France: Factur-X, AFNOR PDP/PA, electronic signatures.  ## 🎯 Main Features  ### 📄 Factur-X - 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)  ### ✅ Factur-X - Validation - **XML Validation**: Schematron (45 to 210+ rules depending on profile) - **PDF Validation**: PDF/A-3, Factur-X XMP metadata - **VeraPDF**: Strict PDF/A validation (146+ ISO 19005-3 rules)  ### ✍️ 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  ### 📋 Flux 6 - Invoice Lifecycle (CDAR) - **CDAR Messages**: Acknowledgements, invoice statuses - **PPF Statuses**: REFUSED (210), PAID (212)  ### 📊 Flux 10 - E-Reporting - **Tax Declarations**: International B2B, B2C - **Flow Types**: 10.1 (B2B transactions), 10.2 (B2B payments), 10.3 (B2C transactions), 10.4 (B2C payments)  ### 📡 AFNOR PDP/PA (XP Z12-013) - **Flow Service**: Submit and search flows to PDPs - **Directory Service**: Company search (SIREN/SIRET) - **Multi-client**: Support for multiple PDP configs per user  ### 🏛️ Chorus Pro - **Public Sector Invoicing**: Complete API for Chorus Pro  ### ⏳ Async Tasks - **Celery**: Asynchronous generation, validation and signing - **Polling**: Status tracking via `/tasks/{task_id}/status` - **Webhooks**: Automatic notifications when tasks complete  ## 🔒 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.20.0-SNAPSHOT
+
+=end
+
+require 'date'
+require 'time'
+
+module FactPulse
+  # Requête de création d'un message CDAR.
+  class CreateCDARRequest < ApiModelBase
+    # Identifiant unique du message CDAR
+    attr_accessor :document_id
+
+    # Code processus métier (REGULATED, B2C, B2BINT, etc.)
+    attr_accessor :business_process
+
+    # Type de message (23=Traitement, 305=Transmission)
+    attr_accessor :type_code
+
+    # SIREN de l'émetteur (9 chiffres)
+    attr_accessor :sender_siren
+
+    # Rôle de l'émetteur (WK, SE, BY, etc.)
+    attr_accessor :sender_role
+
+    attr_accessor :sender_name
+
+    attr_accessor :sender_email
+
+    # Liste des destinataires
+    attr_accessor :recipients
+
+    # Identifiant de la facture (BT-1)
+    attr_accessor :invoice_id
+
+    # Date d'émission de la facture (YYYY-MM-DD)
+    attr_accessor :invoice_issue_date
+
+    # Type de document (380=Facture, 381=Avoir)
+    attr_accessor :invoice_type_code
+
+    attr_accessor :invoice_seller_siren
+
+    attr_accessor :invoice_buyer_siren
+
+    # Code statut de la facture (200-601)
+    attr_accessor :status
+
+    attr_accessor :reason_code
+
+    attr_accessor :reason_text
+
+    attr_accessor :action_code
+
+    attr_accessor :encaisse_amount
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'document_id' => :'documentId',
+        :'business_process' => :'businessProcess',
+        :'type_code' => :'typeCode',
+        :'sender_siren' => :'senderSiren',
+        :'sender_role' => :'senderRole',
+        :'sender_name' => :'senderName',
+        :'sender_email' => :'senderEmail',
+        :'recipients' => :'recipients',
+        :'invoice_id' => :'invoiceId',
+        :'invoice_issue_date' => :'invoiceIssueDate',
+        :'invoice_type_code' => :'invoiceTypeCode',
+        :'invoice_seller_siren' => :'invoiceSellerSiren',
+        :'invoice_buyer_siren' => :'invoiceBuyerSiren',
+        :'status' => :'status',
+        :'reason_code' => :'reasonCode',
+        :'reason_text' => :'reasonText',
+        :'action_code' => :'actionCode',
+        :'encaisse_amount' => :'encaisseAmount'
+      }
+    end
+
+    # Returns attribute mapping this model knows about
+    def self.acceptable_attribute_map
+      attribute_map
+    end
+
+    # Returns all the JSON keys this model knows about
+    def self.acceptable_attributes
+      acceptable_attribute_map.values
+    end
+
+    # Attribute type mapping.
+    def self.openapi_types
+      {
+        :'document_id' => :'String',
+        :'business_process' => :'String',
+        :'type_code' => :'String',
+        :'sender_siren' => :'String',
+        :'sender_role' => :'String',
+        :'sender_name' => :'String',
+        :'sender_email' => :'String',
+        :'recipients' => :'Array<RecipientInput>',
+        :'invoice_id' => :'String',
+        :'invoice_issue_date' => :'Date',
+        :'invoice_type_code' => :'String',
+        :'invoice_seller_siren' => :'String',
+        :'invoice_buyer_siren' => :'String',
+        :'status' => :'String',
+        :'reason_code' => :'String',
+        :'reason_text' => :'String',
+        :'action_code' => :'String',
+        :'encaisse_amount' => :'Encaisseamount'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'sender_name',
+        :'sender_email',
+        :'invoice_seller_siren',
+        :'invoice_buyer_siren',
+        :'reason_code',
+        :'reason_text',
+        :'action_code',
+        :'encaisse_amount'
+      ])
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `FactPulse::CreateCDARRequest` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      acceptable_attribute_map = self.class.acceptable_attribute_map
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!acceptable_attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `FactPulse::CreateCDARRequest`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'document_id')
+        self.document_id = attributes[:'document_id']
+      else
+        self.document_id = nil
+      end
+
+      if attributes.key?(:'business_process')
+        self.business_process = attributes[:'business_process']
+      else
+        self.business_process = 'REGULATED'
+      end
+
+      if attributes.key?(:'type_code')
+        self.type_code = attributes[:'type_code']
+      else
+        self.type_code = '23'
+      end
+
+      if attributes.key?(:'sender_siren')
+        self.sender_siren = attributes[:'sender_siren']
+      else
+        self.sender_siren = nil
+      end
+
+      if attributes.key?(:'sender_role')
+        self.sender_role = attributes[:'sender_role']
+      else
+        self.sender_role = 'WK'
+      end
+
+      if attributes.key?(:'sender_name')
+        self.sender_name = attributes[:'sender_name']
+      end
+
+      if attributes.key?(:'sender_email')
+        self.sender_email = attributes[:'sender_email']
+      end
+
+      if attributes.key?(:'recipients')
+        if (value = attributes[:'recipients']).is_a?(Array)
+          self.recipients = value
+        end
+      end
+
+      if attributes.key?(:'invoice_id')
+        self.invoice_id = attributes[:'invoice_id']
+      else
+        self.invoice_id = nil
+      end
+
+      if attributes.key?(:'invoice_issue_date')
+        self.invoice_issue_date = attributes[:'invoice_issue_date']
+      else
+        self.invoice_issue_date = nil
+      end
+
+      if attributes.key?(:'invoice_type_code')
+        self.invoice_type_code = attributes[:'invoice_type_code']
+      else
+        self.invoice_type_code = '380'
+      end
+
+      if attributes.key?(:'invoice_seller_siren')
+        self.invoice_seller_siren = attributes[:'invoice_seller_siren']
+      end
+
+      if attributes.key?(:'invoice_buyer_siren')
+        self.invoice_buyer_siren = attributes[:'invoice_buyer_siren']
+      end
+
+      if attributes.key?(:'status')
+        self.status = attributes[:'status']
+      else
+        self.status = nil
+      end
+
+      if attributes.key?(:'reason_code')
+        self.reason_code = attributes[:'reason_code']
+      end
+
+      if attributes.key?(:'reason_text')
+        self.reason_text = attributes[:'reason_text']
+      end
+
+      if attributes.key?(:'action_code')
+        self.action_code = attributes[:'action_code']
+      end
+
+      if attributes.key?(:'encaisse_amount')
+        self.encaisse_amount = attributes[:'encaisse_amount']
+      end
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properties with the reasons
+    def list_invalid_properties
+      warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
+      invalid_properties = Array.new
+      if @document_id.nil?
+        invalid_properties.push('invalid value for "document_id", document_id cannot be nil.')
+      end
+
+      if @sender_siren.nil?
+        invalid_properties.push('invalid value for "sender_siren", sender_siren cannot be nil.')
+      end
+
+      if @invoice_id.nil?
+        invalid_properties.push('invalid value for "invoice_id", invoice_id cannot be nil.')
+      end
+
+      if @invoice_issue_date.nil?
+        invalid_properties.push('invalid value for "invoice_issue_date", invoice_issue_date cannot be nil.')
+      end
+
+      if @status.nil?
+        invalid_properties.push('invalid value for "status", status cannot be nil.')
+      end
+
+      invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      warn '[DEPRECATED] the `valid?` method is obsolete'
+      return false if @document_id.nil?
+      return false if @sender_siren.nil?
+      return false if @invoice_id.nil?
+      return false if @invoice_issue_date.nil?
+      return false if @status.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] document_id Value to be assigned
+    def document_id=(document_id)
+      if document_id.nil?
+        fail ArgumentError, 'document_id cannot be nil'
+      end
+
+      @document_id = document_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] sender_siren Value to be assigned
+    def sender_siren=(sender_siren)
+      if sender_siren.nil?
+        fail ArgumentError, 'sender_siren cannot be nil'
+      end
+
+      @sender_siren = sender_siren
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] invoice_id Value to be assigned
+    def invoice_id=(invoice_id)
+      if invoice_id.nil?
+        fail ArgumentError, 'invoice_id cannot be nil'
+      end
+
+      @invoice_id = invoice_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] invoice_issue_date Value to be assigned
+    def invoice_issue_date=(invoice_issue_date)
+      if invoice_issue_date.nil?
+        fail ArgumentError, 'invoice_issue_date cannot be nil'
+      end
+
+      @invoice_issue_date = invoice_issue_date
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] status Value to be assigned
+    def status=(status)
+      if status.nil?
+        fail ArgumentError, 'status cannot be nil'
+      end
+
+      @status = status
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          document_id == o.document_id &&
+          business_process == o.business_process &&
+          type_code == o.type_code &&
+          sender_siren == o.sender_siren &&
+          sender_role == o.sender_role &&
+          sender_name == o.sender_name &&
+          sender_email == o.sender_email &&
+          recipients == o.recipients &&
+          invoice_id == o.invoice_id &&
+          invoice_issue_date == o.invoice_issue_date &&
+          invoice_type_code == o.invoice_type_code &&
+          invoice_seller_siren == o.invoice_seller_siren &&
+          invoice_buyer_siren == o.invoice_buyer_siren &&
+          status == o.status &&
+          reason_code == o.reason_code &&
+          reason_text == o.reason_text &&
+          action_code == o.action_code &&
+          encaisse_amount == o.encaisse_amount
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    def hash
+      [document_id, business_process, type_code, sender_siren, sender_role, sender_name, sender_email, recipients, invoice_id, invoice_issue_date, invoice_type_code, invoice_seller_siren, invoice_buyer_siren, status, reason_code, reason_text, action_code, encaisse_amount].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def self.build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      attributes = attributes.transform_keys(&:to_sym)
+      transformed_hash = {}
+      openapi_types.each_pair do |key, type|
+        if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = nil
+        elsif type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the attribute
+          # is documented as an array but the input is not
+          if attributes[attribute_map[key]].is_a?(Array)
+            transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
+          end
+        elsif !attributes[attribute_map[key]].nil?
+          transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
+        end
+      end
+      new(transformed_hash)
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        if value.nil?
+          is_nullable = self.class.openapi_nullable.include?(attr)
+          next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
+        end
+
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+  end
+
+end