factpulse 0.1.0

data/lib/factpulse/models/submit_invoice_request.rb

@@ -0,0 +1,388 @@
+=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
+  # Submit an invoice to Chorus Pro.
+  class SubmitInvoiceRequest < ApiModelBase
+    attr_accessor :credentials
+
+    # Invoice number
+    attr_accessor :invoice_number
+
+    # Invoice date (ISO format: YYYY-MM-DD)
+    attr_accessor :invoice_date
+
+    attr_accessor :payment_due_date
+
+    # Chorus Pro recipient structure ID
+    attr_accessor :structure_id
+
+    attr_accessor :service_code
+
+    attr_accessor :engagement_number
+
+    attr_accessor :total_net_amount
+
+    attr_accessor :vat_amount
+
+    attr_accessor :total_gross_amount
+
+    attr_accessor :main_attachment_id
+
+    attr_accessor :main_attachment_label
+
+    attr_accessor :comment
+
+    attr_accessor :purchase_order_reference
+
+    attr_accessor :contract_reference
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'credentials' => :'credentials',
+        :'invoice_number' => :'invoiceNumber',
+        :'invoice_date' => :'invoiceDate',
+        :'payment_due_date' => :'paymentDueDate',
+        :'structure_id' => :'structureId',
+        :'service_code' => :'serviceCode',
+        :'engagement_number' => :'engagementNumber',
+        :'total_net_amount' => :'totalNetAmount',
+        :'vat_amount' => :'vatAmount',
+        :'total_gross_amount' => :'totalGrossAmount',
+        :'main_attachment_id' => :'mainAttachmentId',
+        :'main_attachment_label' => :'mainAttachmentLabel',
+        :'comment' => :'comment',
+        :'purchase_order_reference' => :'purchaseOrderReference',
+        :'contract_reference' => :'contractReference'
+      }
+    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
+      {
+        :'credentials' => :'ChorusProCredentials',
+        :'invoice_number' => :'String',
+        :'invoice_date' => :'String',
+        :'payment_due_date' => :'String',
+        :'structure_id' => :'Integer',
+        :'service_code' => :'String',
+        :'engagement_number' => :'String',
+        :'total_net_amount' => :'SubmitNetAmount',
+        :'vat_amount' => :'SubmitVatAmount',
+        :'total_gross_amount' => :'SubmitGrossAmount',
+        :'main_attachment_id' => :'Integer',
+        :'main_attachment_label' => :'String',
+        :'comment' => :'String',
+        :'purchase_order_reference' => :'String',
+        :'contract_reference' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'credentials',
+        :'payment_due_date',
+        :'service_code',
+        :'engagement_number',
+        :'main_attachment_id',
+        :'main_attachment_label',
+        :'comment',
+        :'purchase_order_reference',
+        :'contract_reference'
+      ])
+    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::SubmitInvoiceRequest` 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::SubmitInvoiceRequest`. 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?(:'credentials')
+        self.credentials = attributes[:'credentials']
+      end
+
+      if attributes.key?(:'invoice_number')
+        self.invoice_number = attributes[:'invoice_number']
+      else
+        self.invoice_number = nil
+      end
+
+      if attributes.key?(:'invoice_date')
+        self.invoice_date = attributes[:'invoice_date']
+      else
+        self.invoice_date = nil
+      end
+
+      if attributes.key?(:'payment_due_date')
+        self.payment_due_date = attributes[:'payment_due_date']
+      end
+
+      if attributes.key?(:'structure_id')
+        self.structure_id = attributes[:'structure_id']
+      else
+        self.structure_id = nil
+      end
+
+      if attributes.key?(:'service_code')
+        self.service_code = attributes[:'service_code']
+      end
+
+      if attributes.key?(:'engagement_number')
+        self.engagement_number = attributes[:'engagement_number']
+      end
+
+      if attributes.key?(:'total_net_amount')
+        self.total_net_amount = attributes[:'total_net_amount']
+      else
+        self.total_net_amount = nil
+      end
+
+      if attributes.key?(:'vat_amount')
+        self.vat_amount = attributes[:'vat_amount']
+      else
+        self.vat_amount = nil
+      end
+
+      if attributes.key?(:'total_gross_amount')
+        self.total_gross_amount = attributes[:'total_gross_amount']
+      else
+        self.total_gross_amount = nil
+      end
+
+      if attributes.key?(:'main_attachment_id')
+        self.main_attachment_id = attributes[:'main_attachment_id']
+      end
+
+      if attributes.key?(:'main_attachment_label')
+        self.main_attachment_label = attributes[:'main_attachment_label']
+      end
+
+      if attributes.key?(:'comment')
+        self.comment = attributes[:'comment']
+      end
+
+      if attributes.key?(:'purchase_order_reference')
+        self.purchase_order_reference = attributes[:'purchase_order_reference']
+      end
+
+      if attributes.key?(:'contract_reference')
+        self.contract_reference = attributes[:'contract_reference']
+      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_number.nil?
+        invalid_properties.push('invalid value for "invoice_number", invoice_number cannot be nil.')
+      end
+
+      if @invoice_date.nil?
+        invalid_properties.push('invalid value for "invoice_date", invoice_date cannot be nil.')
+      end
+
+      if @structure_id.nil?
+        invalid_properties.push('invalid value for "structure_id", structure_id cannot be nil.')
+      end
+
+      if @total_net_amount.nil?
+        invalid_properties.push('invalid value for "total_net_amount", total_net_amount cannot be nil.')
+      end
+
+      if @vat_amount.nil?
+        invalid_properties.push('invalid value for "vat_amount", vat_amount cannot be nil.')
+      end
+
+      if @total_gross_amount.nil?
+        invalid_properties.push('invalid value for "total_gross_amount", total_gross_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_number.nil?
+      return false if @invoice_date.nil?
+      return false if @structure_id.nil?
+      return false if @total_net_amount.nil?
+      return false if @vat_amount.nil?
+      return false if @total_gross_amount.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] invoice_number Value to be assigned
+    def invoice_number=(invoice_number)
+      if invoice_number.nil?
+        fail ArgumentError, 'invoice_number cannot be nil'
+      end
+
+      @invoice_number = invoice_number
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] invoice_date Value to be assigned
+    def invoice_date=(invoice_date)
+      if invoice_date.nil?
+        fail ArgumentError, 'invoice_date cannot be nil'
+      end
+
+      @invoice_date = invoice_date
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] structure_id Value to be assigned
+    def structure_id=(structure_id)
+      if structure_id.nil?
+        fail ArgumentError, 'structure_id cannot be nil'
+      end
+
+      @structure_id = structure_id
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] total_net_amount Value to be assigned
+    def total_net_amount=(total_net_amount)
+      if total_net_amount.nil?
+        fail ArgumentError, 'total_net_amount cannot be nil'
+      end
+
+      @total_net_amount = total_net_amount
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] vat_amount Value to be assigned
+    def vat_amount=(vat_amount)
+      if vat_amount.nil?
+        fail ArgumentError, 'vat_amount cannot be nil'
+      end
+
+      @vat_amount = vat_amount
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] total_gross_amount Value to be assigned
+    def total_gross_amount=(total_gross_amount)
+      if total_gross_amount.nil?
+        fail ArgumentError, 'total_gross_amount cannot be nil'
+      end
+
+      @total_gross_amount = total_gross_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 &&
+          credentials == o.credentials &&
+          invoice_number == o.invoice_number &&
+          invoice_date == o.invoice_date &&
+          payment_due_date == o.payment_due_date &&
+          structure_id == o.structure_id &&
+          service_code == o.service_code &&
+          engagement_number == o.engagement_number &&
+          total_net_amount == o.total_net_amount &&
+          vat_amount == o.vat_amount &&
+          total_gross_amount == o.total_gross_amount &&
+          main_attachment_id == o.main_attachment_id &&
+          main_attachment_label == o.main_attachment_label &&
+          comment == o.comment &&
+          purchase_order_reference == o.purchase_order_reference &&
+          contract_reference == o.contract_reference
+    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
+      [credentials, invoice_number, invoice_date, payment_due_date, structure_id, service_code, engagement_number, total_net_amount, vat_amount, total_gross_amount, main_attachment_id, main_attachment_label, comment, purchase_order_reference, contract_reference].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

data/lib/factpulse/models/submit_invoice_response.rb

@@ -0,0 +1,213 @@
+=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
+  # Response after invoice submission.
+  class SubmitInvoiceResponse < ApiModelBase
+    # Return code (0 = success)
+    attr_accessor :return_code
+
+    # Return message
+    attr_accessor :message
+
+    attr_accessor :chorus_invoice_id
+
+    attr_accessor :deposit_flow_number
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'return_code' => :'returnCode',
+        :'message' => :'message',
+        :'chorus_invoice_id' => :'chorusInvoiceId',
+        :'deposit_flow_number' => :'depositFlowNumber'
+      }
+    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
+      {
+        :'return_code' => :'Integer',
+        :'message' => :'String',
+        :'chorus_invoice_id' => :'Integer',
+        :'deposit_flow_number' => :'String'
+      }
+    end
+
+    # List of attributes with nullable: true
+    def self.openapi_nullable
+      Set.new([
+        :'chorus_invoice_id',
+        :'deposit_flow_number'
+      ])
+    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::SubmitInvoiceResponse` 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::SubmitInvoiceResponse`. 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?(:'return_code')
+        self.return_code = attributes[:'return_code']
+      else
+        self.return_code = nil
+      end
+
+      if attributes.key?(:'message')
+        self.message = attributes[:'message']
+      else
+        self.message = nil
+      end
+
+      if attributes.key?(:'chorus_invoice_id')
+        self.chorus_invoice_id = attributes[:'chorus_invoice_id']
+      end
+
+      if attributes.key?(:'deposit_flow_number')
+        self.deposit_flow_number = attributes[:'deposit_flow_number']
+      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 @return_code.nil?
+        invalid_properties.push('invalid value for "return_code", return_code cannot be nil.')
+      end
+
+      if @message.nil?
+        invalid_properties.push('invalid value for "message", message 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 @return_code.nil?
+      return false if @message.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] return_code Value to be assigned
+    def return_code=(return_code)
+      if return_code.nil?
+        fail ArgumentError, 'return_code cannot be nil'
+      end
+
+      @return_code = return_code
+    end
+
+    # Custom attribute writer method with validation
+    # @param [Object] message Value to be assigned
+    def message=(message)
+      if message.nil?
+        fail ArgumentError, 'message cannot be nil'
+      end
+
+      @message = message
+    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 &&
+          return_code == o.return_code &&
+          message == o.message &&
+          chorus_invoice_id == o.chorus_invoice_id &&
+          deposit_flow_number == o.deposit_flow_number
+    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
+      [return_code, message, chorus_invoice_id, deposit_flow_number].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