factpulse 0.1.0

data/lib/factpulse/models/encaissee_request.rb

@@ -0,0 +1,347 @@
+=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 simplifiée pour soumettre un statut ENCAISSÉE (212).  **Usage** : Pour une facture ÉMISE (vous êtes vendeur). Le vendeur confirme l'encaissement et envoie le statut à l'acheteur.  Statut obligatoire PPF - Le montant encaissé est OBLIGATOIRE (BR-FR-CDV-14).
+  class EncaisseeRequest < ApiModelBase
+    # Identifiant de la facture (BT-1)
+    attr_accessor :invoice_id
+
+    # Date d'émission de la facture (YYYY-MM-DD)
+    attr_accessor :invoice_issue_date
+
+    # SIREN de l'acheteur (destinataire du statut)
+    attr_accessor :invoice_buyer_siren
+
+    # Adresse électronique de l'acheteur (MDT-73)
+    attr_accessor :invoice_buyer_electronic_address
+
+    attr_accessor :amount
+
+    # Code devise ISO 4217
+    attr_accessor :currency
+
+    attr_accessor :sender_siren
+
+    # Type de flux (CustomerInvoiceLC pour facture émise)
+    attr_accessor :flow_type
+
+    attr_accessor :pdp_flow_service_url
+
+    attr_accessor :pdp_token_url
+
+    attr_accessor :pdp_client_id
+
+    attr_accessor :pdp_client_secret
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'invoice_id' => :'invoiceId',
+        :'invoice_issue_date' => :'invoiceIssueDate',
+        :'invoice_buyer_siren' => :'invoiceBuyerSiren',
+        :'invoice_buyer_electronic_address' => :'invoiceBuyerElectronicAddress',
+        :'amount' => :'amount',
+        :'currency' => :'currency',
+        :'sender_siren' => :'senderSiren',
+        :'flow_type' => :'flowType',
+        :'pdp_flow_service_url' => :'pdpFlowServiceUrl',
+        :'pdp_token_url' => :'pdpTokenUrl',
+        :'pdp_client_id' => :'pdpClientId',
+        :'pdp_client_secret' => :'pdpClientSecret'
+      }
+    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
+      {
+        :'invoice_id' => :'String',
+        :'invoice_issue_date' => :'Date',
+        :'invoice_buyer_siren' => :'String',
+        :'invoice_buyer_electronic_address' => :'String',
+        :'amount' => :'Amount',
+        :'currency' => :'String',
+        :'sender_siren' => :'String',
+        :'flow_type' => :'String',
+        :'pdp_flow_service_url' => :'String',
+        :'pdp_token_url' => :'String',
+        :'pdp_client_id' => :'String',
+        :'pdp_client_secret' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'sender_siren',
+        :'pdp_flow_service_url',
+        :'pdp_token_url',
+        :'pdp_client_id',
+        :'pdp_client_secret'
+      ])
+    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::EncaisseeRequest` 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::EncaisseeRequest`. 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?(:'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_buyer_siren')
+        self.invoice_buyer_siren = attributes[:'invoice_buyer_siren']
+      else
+        self.invoice_buyer_siren = nil
+      end
+
+      if attributes.key?(:'invoice_buyer_electronic_address')
+        self.invoice_buyer_electronic_address = attributes[:'invoice_buyer_electronic_address']
+      else
+        self.invoice_buyer_electronic_address = nil
+      end
+
+      if attributes.key?(:'amount')
+        self.amount = attributes[:'amount']
+      else
+        self.amount = nil
+      end
+
+      if attributes.key?(:'currency')
+        self.currency = attributes[:'currency']
+      else
+        self.currency = 'EUR'
+      end
+
+      if attributes.key?(:'sender_siren')
+        self.sender_siren = attributes[:'sender_siren']
+      end
+
+      if attributes.key?(:'flow_type')
+        self.flow_type = attributes[:'flow_type']
+      else
+        self.flow_type = 'CustomerInvoiceLC'
+      end
+
+      if attributes.key?(:'pdp_flow_service_url')
+        self.pdp_flow_service_url = attributes[:'pdp_flow_service_url']
+      end
+
+      if attributes.key?(:'pdp_token_url')
+        self.pdp_token_url = attributes[:'pdp_token_url']
+      end
+
+      if attributes.key?(:'pdp_client_id')
+        self.pdp_client_id = attributes[:'pdp_client_id']
+      end
+
+      if attributes.key?(:'pdp_client_secret')
+        self.pdp_client_secret = attributes[:'pdp_client_secret']
+      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 @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 @invoice_buyer_siren.nil?
+        invalid_properties.push('invalid value for "invoice_buyer_siren", invoice_buyer_siren cannot be nil.')
+      end
+
+      if @invoice_buyer_electronic_address.nil?
+        invalid_properties.push('invalid value for "invoice_buyer_electronic_address", invoice_buyer_electronic_address cannot be nil.')
+      end
+
+      if @amount.nil?
+        invalid_properties.push('invalid value for "amount", amount 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 @invoice_id.nil?
+      return false if @invoice_issue_date.nil?
+      return false if @invoice_buyer_siren.nil?
+      return false if @invoice_buyer_electronic_address.nil?
+      return false if @amount.nil?
+      true
+    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] invoice_buyer_siren Value to be assigned
+    def invoice_buyer_siren=(invoice_buyer_siren)
+      if invoice_buyer_siren.nil?
+        fail ArgumentError, 'invoice_buyer_siren cannot be nil'
+      end
+
+      @invoice_buyer_siren = invoice_buyer_siren
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] invoice_buyer_electronic_address Value to be assigned
+    def invoice_buyer_electronic_address=(invoice_buyer_electronic_address)
+      if invoice_buyer_electronic_address.nil?
+        fail ArgumentError, 'invoice_buyer_electronic_address cannot be nil'
+      end
+
+      @invoice_buyer_electronic_address = invoice_buyer_electronic_address
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] amount Value to be assigned
+    def amount=(amount)
+      if amount.nil?
+        fail ArgumentError, 'amount cannot be nil'
+      end
+
+      @amount = amount
+    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 &&
+          invoice_id == o.invoice_id &&
+          invoice_issue_date == o.invoice_issue_date &&
+          invoice_buyer_siren == o.invoice_buyer_siren &&
+          invoice_buyer_electronic_address == o.invoice_buyer_electronic_address &&
+          amount == o.amount &&
+          currency == o.currency &&
+          sender_siren == o.sender_siren &&
+          flow_type == o.flow_type &&
+          pdp_flow_service_url == o.pdp_flow_service_url &&
+          pdp_token_url == o.pdp_token_url &&
+          pdp_client_id == o.pdp_client_id &&
+          pdp_client_secret == o.pdp_client_secret
+    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
+      [invoice_id, invoice_issue_date, invoice_buyer_siren, invoice_buyer_electronic_address, amount, currency, sender_siren, flow_type, pdp_flow_service_url, pdp_token_url, pdp_client_id, pdp_client_secret].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