storecove 1.0.9 → 1.0.10

data/lib/storecove/models/preflight_invoice_recipient_result.rb

@@ -6,6 +6,7 @@
 OpenAPI spec version: 2.0.1
 Contact: apisupport@storecove.nl
 Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.3.1
 
 =end
 
@@ -68,7 +69,7 @@ module StorecoveApi
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
-    # @return Array for valid properies with the reasons
+    # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
       return invalid_properties

data/lib/storecove/models/public_identifier.rb

@@ -6,6 +6,7 @@
 OpenAPI spec version: 2.0.1
 Contact: apisupport@storecove.nl
 Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.3.1
 
 =end
 
@@ -14,7 +15,7 @@ require 'date'
 module StorecoveApi
   # A public identifier for this customer.
   class PublicIdentifier
-    # The scheme of the public identifier, e.g. chambre of commerce number (for The Netherlands: NL:KVK), VAT, IBAN, or NL:OIN (OIN is a Dutch government organizaton id). The full list can be found on https://joinup.ec.europa.eu/svn/peppol/TransportInfrastructure/PEPPOL_Policy%20for%20use%20of%20identifiers-300.pdf.
+    # The scheme of the identifier. See <<_company>> for a list.
     attr_accessor :scheme
 
     # The actual identifier.
@@ -56,7 +57,7 @@ module StorecoveApi
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
-    # @return Array for valid properies with the reasons
+    # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
       if @scheme.nil?

data/lib/storecove/models/public_identifiers.rb

@@ -6,6 +6,7 @@
 OpenAPI spec version: 2.0.1
 Contact: apisupport@storecove.nl
 Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.3.1
 
 =end
 
@@ -38,7 +39,7 @@ module StorecoveApi
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
-    # @return Array for valid properies with the reasons
+    # @return Array for valid properties with the reasons
     def list_invalid_properties
       invalid_properties = Array.new
       return invalid_properties

data/lib/storecove/models/purchase_invoice.rb

@@ -0,0 +1,463 @@
+=begin
+#Storecove API
+
+#Storecove API
+
+OpenAPI spec version: 2.0.1
+Contact: apisupport@storecove.nl
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+Swagger Codegen version: 2.3.1
+
+=end
+
+require 'date'
+
+module StorecoveApi
+
+  class PurchaseInvoice
+    # The GUID of the invoice
+    attr_accessor :guid
+
+    # The id of the LegalEntity the invoice was received for.
+    attr_accessor :legal_entity_id
+
+    # The Base64 encoded PDF document associated with the invoice.
+    attr_accessor :document
+
+    # The invoicenumber.
+    attr_accessor :invoice_number
+
+    # The date the invoice was issued. Format \"YYYY-MM-DD\".
+    attr_accessor :issue_date
+
+    # The date the invoice was issued for tax purposes. In most countries MUST match the issue_date. Format \"YYYY-MM-DD\".
+    attr_accessor :tax_point_date
+
+    # The date the invoice must be payed by. Format \"YYYY-MM-DD\".
+    attr_accessor :due_date
+
+    # The ISO 4217 currency for the invoice.
+    attr_accessor :document_currency_code
+
+    # Whether or not the invoice is reverse charged.
+    attr_accessor :vat_reverse_charge
+
+    # The total invoice amount payable, including VAT. This is equal to the sum of the invoice_lines (amount_excluding_vat + vat.amount)
+    attr_accessor :amount_including_vat
+
+    # A correction on the amount to pay, for instance if the invoice has been prepaid, in which case it will be negative.
+    attr_accessor :allowance_charge
+
+    # The difference between the invoice total and the sum of the invoice lines.
+    attr_accessor :payable_rounding_amount
+
+    # The total invoice amount payable including VAT. This is equal to amount_including_vat + allowance_charge + payable_rounding_amount. This property is redundant and provided only to make invoice processing more easy. You can also choose to only store this property, instead of the underlying fields.
+    attr_accessor :payable_amount
+
+    # The source the invoice was received from.
+    attr_accessor :source
+
+    # The organzation that sent the invoice.
+    attr_accessor :sender
+
+    # The type of invoice.
+    attr_accessor :invoice_type
+
+    # The start date of the period this invoice relates to. Format \"YYYY-MM-DD\".
+    attr_accessor :period_start
+
+    # The end date of the period this invoice relates to. Format \"YYYY-MM-DD\".
+    attr_accessor :period_end
+
+    # The end date of the period this invoice relates to. Format \"YYYY-MM-DD\".
+    attr_accessor :buyer_reference
+
+    # The end date of the period this invoice relates to. Format \"YYYY-MM-DD\".
+    attr_accessor :billing_reference
+
+    # The end date of the period this invoice relates to. Format \"YYYY-MM-DD\".
+    attr_accessor :contract_document_reference
+
+    attr_accessor :invoice_lines
+
+    attr_accessor :accounting
+
+    attr_accessor :payment_means
+
+    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
+      {
+        :'guid' => :'guid',
+        :'legal_entity_id' => :'legal_entity_id',
+        :'document' => :'document',
+        :'invoice_number' => :'invoice_number',
+        :'issue_date' => :'issue_date',
+        :'tax_point_date' => :'tax_point_date',
+        :'due_date' => :'due_date',
+        :'document_currency_code' => :'document_currency_code',
+        :'vat_reverse_charge' => :'vat_reverse_charge',
+        :'amount_including_vat' => :'amount_including_vat',
+        :'allowance_charge' => :'allowance_charge',
+        :'payable_rounding_amount' => :'payable_rounding_amount',
+        :'payable_amount' => :'payable_amount',
+        :'source' => :'source',
+        :'sender' => :'sender',
+        :'invoice_type' => :'invoice_type',
+        :'period_start' => :'period_start',
+        :'period_end' => :'period_end',
+        :'buyer_reference' => :'buyer_reference',
+        :'billing_reference' => :'billing_reference',
+        :'contract_document_reference' => :'contract_document_reference',
+        :'invoice_lines' => :'invoice_lines',
+        :'accounting' => :'accounting',
+        :'payment_means' => :'payment_means'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'guid' => :'String',
+        :'legal_entity_id' => :'Integer',
+        :'document' => :'String',
+        :'invoice_number' => :'String',
+        :'issue_date' => :'String',
+        :'tax_point_date' => :'String',
+        :'due_date' => :'String',
+        :'document_currency_code' => :'String',
+        :'vat_reverse_charge' => :'BOOLEAN',
+        :'amount_including_vat' => :'Float',
+        :'allowance_charge' => :'Float',
+        :'payable_rounding_amount' => :'Float',
+        :'payable_amount' => :'Float',
+        :'source' => :'String',
+        :'sender' => :'PurchaseInvoiceSender',
+        :'invoice_type' => :'String',
+        :'period_start' => :'String',
+        :'period_end' => :'String',
+        :'buyer_reference' => :'String',
+        :'billing_reference' => :'String',
+        :'contract_document_reference' => :'String',
+        :'invoice_lines' => :'Array<PurchaseInvoiceInvoiceLine>',
+        :'accounting' => :'AccountingDetails',
+        :'payment_means' => :'PaymentMeans'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
+
+      if attributes.has_key?(:'guid')
+        self.guid = attributes[:'guid']
+      end
+
+      if attributes.has_key?(:'legal_entity_id')
+        self.legal_entity_id = attributes[:'legal_entity_id']
+      end
+
+      if attributes.has_key?(:'document')
+        self.document = attributes[:'document']
+      end
+
+      if attributes.has_key?(:'invoice_number')
+        self.invoice_number = attributes[:'invoice_number']
+      end
+
+      if attributes.has_key?(:'issue_date')
+        self.issue_date = attributes[:'issue_date']
+      end
+
+      if attributes.has_key?(:'tax_point_date')
+        self.tax_point_date = attributes[:'tax_point_date']
+      end
+
+      if attributes.has_key?(:'due_date')
+        self.due_date = attributes[:'due_date']
+      end
+
+      if attributes.has_key?(:'document_currency_code')
+        self.document_currency_code = attributes[:'document_currency_code']
+      end
+
+      if attributes.has_key?(:'vat_reverse_charge')
+        self.vat_reverse_charge = attributes[:'vat_reverse_charge']
+      end
+
+      if attributes.has_key?(:'amount_including_vat')
+        self.amount_including_vat = attributes[:'amount_including_vat']
+      end
+
+      if attributes.has_key?(:'allowance_charge')
+        self.allowance_charge = attributes[:'allowance_charge']
+      end
+
+      if attributes.has_key?(:'payable_rounding_amount')
+        self.payable_rounding_amount = attributes[:'payable_rounding_amount']
+      end
+
+      if attributes.has_key?(:'payable_amount')
+        self.payable_amount = attributes[:'payable_amount']
+      end
+
+      if attributes.has_key?(:'source')
+        self.source = attributes[:'source']
+      end
+
+      if attributes.has_key?(:'sender')
+        self.sender = attributes[:'sender']
+      end
+
+      if attributes.has_key?(:'invoice_type')
+        self.invoice_type = attributes[:'invoice_type']
+      end
+
+      if attributes.has_key?(:'period_start')
+        self.period_start = attributes[:'period_start']
+      end
+
+      if attributes.has_key?(:'period_end')
+        self.period_end = attributes[:'period_end']
+      end
+
+      if attributes.has_key?(:'buyer_reference')
+        self.buyer_reference = attributes[:'buyer_reference']
+      end
+
+      if attributes.has_key?(:'billing_reference')
+        self.billing_reference = attributes[:'billing_reference']
+      end
+
+      if attributes.has_key?(:'contract_document_reference')
+        self.contract_document_reference = attributes[:'contract_document_reference']
+      end
+
+      if attributes.has_key?(:'invoice_lines')
+        if (value = attributes[:'invoice_lines']).is_a?(Array)
+          self.invoice_lines = value
+        end
+      end
+
+      if attributes.has_key?(:'accounting')
+        self.accounting = attributes[:'accounting']
+      end
+
+      if attributes.has_key?(:'payment_means')
+        self.payment_means = attributes[:'payment_means']
+      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
+      invalid_properties = Array.new
+      return 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?
+      source_validator = EnumAttributeValidator.new('String', ["peppol", "script", "supplier", "email"])
+      return false unless source_validator.valid?(@source)
+      invoice_type_validator = EnumAttributeValidator.new('String', ["invoice", "creditnote", "correctioninvoice"])
+      return false unless invoice_type_validator.valid?(@invoice_type)
+      return true
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] source Object to be assigned
+    def source=(source)
+      validator = EnumAttributeValidator.new('String', ["peppol", "script", "supplier", "email"])
+      unless validator.valid?(source)
+        fail ArgumentError, "invalid value for 'source', must be one of #{validator.allowable_values}."
+      end
+      @source = source
+    end
+
+    # Custom attribute writer method checking allowed values (enum).
+    # @param [Object] invoice_type Object to be assigned
+    def invoice_type=(invoice_type)
+      validator = EnumAttributeValidator.new('String', ["invoice", "creditnote", "correctioninvoice"])
+      unless validator.valid?(invoice_type)
+        fail ArgumentError, "invalid value for 'invoice_type', must be one of #{validator.allowable_values}."
+      end
+      @invoice_type = invoice_type
+    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 &&
+          guid == o.guid &&
+          legal_entity_id == o.legal_entity_id &&
+          document == o.document &&
+          invoice_number == o.invoice_number &&
+          issue_date == o.issue_date &&
+          tax_point_date == o.tax_point_date &&
+          due_date == o.due_date &&
+          document_currency_code == o.document_currency_code &&
+          vat_reverse_charge == o.vat_reverse_charge &&
+          amount_including_vat == o.amount_including_vat &&
+          allowance_charge == o.allowance_charge &&
+          payable_rounding_amount == o.payable_rounding_amount &&
+          payable_amount == o.payable_amount &&
+          source == o.source &&
+          sender == o.sender &&
+          invoice_type == o.invoice_type &&
+          period_start == o.period_start &&
+          period_end == o.period_end &&
+          buyer_reference == o.buyer_reference &&
+          billing_reference == o.billing_reference &&
+          contract_document_reference == o.contract_document_reference &&
+          invoice_lines == o.invoice_lines &&
+          accounting == o.accounting &&
+          payment_means == o.payment_means
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [guid, legal_entity_id, document, invoice_number, issue_date, tax_point_date, due_date, document_currency_code, vat_reverse_charge, amount_including_vat, allowance_charge, payable_rounding_amount, payable_amount, source, sender, invoice_type, period_start, period_end, buyer_reference, billing_reference, contract_document_reference, invoice_lines, accounting, payment_means].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.swagger_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BOOLEAN
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        temp_model = StorecoveApi.const_get(type).new
+        temp_model.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_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)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map{ |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end