factpulse 0.1.0

data/lib/factpulse/models/create_aggregated_report_request.rb

@@ -0,0 +1,320 @@
+=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
+  # Request to create a PPF-compliant aggregated e-reporting submission.  This schema allows creating a SINGLE report file containing multiple flux types, as expected by the PPF and PA platforms: - TransactionsReport: Contains both Invoice (10.1) and Transactions (10.3) - PaymentsReport: Contains both Invoice payments (10.2) and Transaction payments (10.4)  Source: Specifications externes v3.1, XSD ereporting.xsd
+  class CreateAggregatedReportRequest < ApiModelBase
+    # Report identifier (generated by caller)
+    attr_accessor :report_id
+
+    attr_accessor :report_name
+
+    # Transmission type: IN=Initial, RE=Rectificative (TT-4)
+    attr_accessor :transmission_type
+
+    # Report sender (PA transmitting the report)
+    attr_accessor :sender
+
+    attr_accessor :issuer
+
+    # Reporting period
+    attr_accessor :period
+
+    attr_accessor :invoices
+
+    attr_accessor :transactions
+
+    attr_accessor :invoice_payments
+
+    attr_accessor :transaction_payments
+
+    class EnumAttributeValidator
+      attr_reader :datatype
+      attr_reader :allowable_values
+
+      def initialize(datatype, allowable_values)
+        @allowable_values = allowable_values.map do |value|
+          case datatype.to_s
+          when /Integer/i
+            value.to_i
+          when /Float/i
+            value.to_f
+          else
+            value
+          end
+        end
+      end
+
+      def valid?(value)
+        !value || allowable_values.include?(value)
+      end
+    end
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'report_id' => :'reportId',
+        :'report_name' => :'reportName',
+        :'transmission_type' => :'transmissionType',
+        :'sender' => :'sender',
+        :'issuer' => :'issuer',
+        :'period' => :'period',
+        :'invoices' => :'invoices',
+        :'transactions' => :'transactions',
+        :'invoice_payments' => :'invoicePayments',
+        :'transaction_payments' => :'transactionPayments'
+      }
+    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
+      {
+        :'report_id' => :'String',
+        :'report_name' => :'String',
+        :'transmission_type' => :'TransmissionTypeCode',
+        :'sender' => :'ReportSender',
+        :'issuer' => :'ReportIssuer',
+        :'period' => :'ReportPeriod',
+        :'invoices' => :'Array<InvoiceInput>',
+        :'transactions' => :'Array<AggregatedTransactionInput>',
+        :'invoice_payments' => :'Array<InvoicePaymentInput>',
+        :'transaction_payments' => :'Array<AggregatedPaymentInput>'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'report_name',
+        :'issuer',
+        :'invoices',
+        :'transactions',
+        :'invoice_payments',
+        :'transaction_payments'
+      ])
+    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::CreateAggregatedReportRequest` 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::CreateAggregatedReportRequest`. 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?(:'report_id')
+        self.report_id = attributes[:'report_id']
+      else
+        self.report_id = nil
+      end
+
+      if attributes.key?(:'report_name')
+        self.report_name = attributes[:'report_name']
+      end
+
+      if attributes.key?(:'transmission_type')
+        self.transmission_type = attributes[:'transmission_type']
+      end
+
+      if attributes.key?(:'sender')
+        self.sender = attributes[:'sender']
+      else
+        self.sender = nil
+      end
+
+      if attributes.key?(:'issuer')
+        self.issuer = attributes[:'issuer']
+      end
+
+      if attributes.key?(:'period')
+        self.period = attributes[:'period']
+      else
+        self.period = nil
+      end
+
+      if attributes.key?(:'invoices')
+        if (value = attributes[:'invoices']).is_a?(Array)
+          self.invoices = value
+        end
+      end
+
+      if attributes.key?(:'transactions')
+        if (value = attributes[:'transactions']).is_a?(Array)
+          self.transactions = value
+        end
+      end
+
+      if attributes.key?(:'invoice_payments')
+        if (value = attributes[:'invoice_payments']).is_a?(Array)
+          self.invoice_payments = value
+        end
+      end
+
+      if attributes.key?(:'transaction_payments')
+        if (value = attributes[:'transaction_payments']).is_a?(Array)
+          self.transaction_payments = value
+        end
+      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 @report_id.nil?
+        invalid_properties.push('invalid value for "report_id", report_id cannot be nil.')
+      end
+
+      if @sender.nil?
+        invalid_properties.push('invalid value for "sender", sender cannot be nil.')
+      end
+
+      if @period.nil?
+        invalid_properties.push('invalid value for "period", period 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 @report_id.nil?
+      return false if @sender.nil?
+      return false if @period.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] report_id Value to be assigned
+    def report_id=(report_id)
+      if report_id.nil?
+        fail ArgumentError, 'report_id cannot be nil'
+      end
+
+      @report_id = report_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] sender Value to be assigned
+    def sender=(sender)
+      if sender.nil?
+        fail ArgumentError, 'sender cannot be nil'
+      end
+
+      @sender = sender
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] period Value to be assigned
+    def period=(period)
+      if period.nil?
+        fail ArgumentError, 'period cannot be nil'
+      end
+
+      @period = period
+    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 &&
+          report_id == o.report_id &&
+          report_name == o.report_name &&
+          transmission_type == o.transmission_type &&
+          sender == o.sender &&
+          issuer == o.issuer &&
+          period == o.period &&
+          invoices == o.invoices &&
+          transactions == o.transactions &&
+          invoice_payments == o.invoice_payments &&
+          transaction_payments == o.transaction_payments
+    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
+      [report_id, report_name, transmission_type, sender, issuer, period, invoices, transactions, invoice_payments, transaction_payments].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