fortnox-api 0.9.2 → 1.0.0.rc2

data/lib/fortnox/api/models/article.rb

@@ -1,134 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'base'
-require_relative '../types'
-
-module Fortnox
-  module API
-    module Model
-      class Article < Fortnox::API::Model::Base
-        UNIQUE_ID = :article_number
-        STUB = { description: '' }.freeze
-
-        # Url Direct URL to the record
-        attribute :url, Types::Nullable::String.is(:read_only)
-
-        # Active If the article is active
-        attribute :active, Types::Nullable::Boolean
-
-        # ArticleNumber Article number. 50 characters
-        attribute :article_number, Types::Sized::String[50]
-
-        # Bulky If the article is bulky.
-        attribute :bulky, Types::Nullable::Boolean
-
-        # ConstructionAccount Account number for construction work (special VAT rules in Sweden).
-        # The number must be of an existing account.
-        attribute :construction_account, Types::Sized::Integer[0, 9_999]
-
-        # Depth The depth of the article in millimeters
-        attribute :depth, Types::Sized::Integer[0, 99_999_999]
-
-        # Description The description of the article
-        attribute :description, Types::Sized::String[200].is(:required)
-
-        # DisposableQuantity Disposable quantity of the article.
-        attribute :disposable_quantity, Types::Nullable::Float.is(:read_only)
-
-        # EAN EAN bar code
-        attribute :ean, Types::Sized::String[30]
-
-        # EUAccount Account number for the sales account to EU.
-        # The number must be of an existing account.
-        attribute :eu_account, Types::Sized::Integer[0, 9_999]
-
-        # EUVATAccount Account number for the sales account to EU with VAT.
-        # The number must be of an existing account.
-        attribute :eu_vat_account, Types::Sized::Integer[0, 9_999]
-
-        # ExportAccount Account number for the sales account outside EU
-        # The number must be of an existing account.
-        attribute :export_account, Types::Sized::Integer[0, 9_999]
-
-        # Height The height of the article in millimeters
-        attribute :height, Types::Sized::Integer[0, 99_999_999]
-
-        # Housework If the article is housework
-        attribute :housework, Types::Nullable::Boolean
-
-        # HouseWorkType The type of housework.
-        attribute :housework_type, Types::HouseworkType
-
-        # Manufacturer The manufacturer of the article
-        attribute :manufacturer, Types::Sized::String[50]
-
-        # ManufacturerArticleNumber The manufacturer's article number
-        attribute :manufacturer_article_number, Types::Sized::String[50]
-
-        # Note Text note
-        attribute :note, Types::Sized::String[10_000]
-
-        # PurchaseAccount Account number for purchase.
-        # The number must be of an existing account.
-        attribute :purchase_account, Types::Sized::Integer[0, 9_999]
-
-        # PurchasePrice Purchase price of the article
-        attribute :purchase_price, Types::Sized::Float[0.0, 99_999_999_999_999.9]
-
-        # QuantityInStock Quantity in stock of the article
-        attribute :quantity_in_stock, Types::Sized::Float[-100_000_000_000_000.0, 99_999_999_999_999.9]
-
-        # ReservedQuantity Reserved quantity of the article
-        attribute :reserved_quantity, Types::Nullable::Float.is(:read_only)
-
-        # SalesAccount Account number for the sales account in Sweden.
-        # The number must be of an existing account.
-        attribute :sales_account, Types::Sized::Integer[0, 9_999]
-
-        # SalesPrice Price of article for its default price list
-        attribute :sales_price, Types::Nullable::Float.is(:read_only)
-
-        # StockGoods If the article is stock goods
-        attribute :stock_goods, Types::Nullable::Boolean
-
-        # StockPlace Storage place for the article
-        attribute :stock_place, Types::Sized::String[100]
-
-        # StockValue Value in stock of the article
-        attribute :stock_value, Types::Nullable::Float.is(:read_only)
-
-        # StockWarning When to start warning for low quantity in stock
-        attribute :stock_warning, Types::Sized::Float[0.0, 99_999_999_999_999.9]
-
-        # SupplierName Name of the supplier
-        attribute :supplier_name, Types::Nullable::String.is(:read_only)
-
-        # SupplierNumber Supplier number for the article.
-        # The number must be of an existing supplier.
-        attribute :supplier_number, Types::Nullable::String
-
-        # Type The type of the article
-        attribute :type, Types::ArticleType
-
-        # Unit Unit code for the article.
-        # The code must be of an existing unit.
-        attribute :unit, Types::Nullable::String
-
-        # VAT VAT percent, this is predefined by the VAT for the sales account
-        attribute :vat, Types::Nullable::Float
-
-        # WebshopArticle If the article is a webshop article
-        attribute :webshop_article, Types::Nullable::Boolean
-
-        # Weight Weight of the article in grams
-        attribute :weight, Types::Sized::Integer[0, 99_999_999]
-
-        # Width Width of the article in millimeters.
-        attribute :width, Types::Sized::Integer[0, 99_999_999]
-
-        # Expired If the article has expired
-        attribute :expired, Types::Nullable::Boolean
-      end
-    end
-  end
-end

data/lib/fortnox/api/models/base.rb

@@ -1,128 +0,0 @@
-# frozen_string_literal: true
-
-require 'ice_nine'
-
-require_relative '../types'
-
-module Fortnox
-  module API
-    module Model
-      class Base < Fortnox::API::Types::Model
-        # TODO(jonas): Restructure this class a bit, it is not very readable.
-
-        attr_accessor :unsaved
-        attr_writer :parent
-
-        def self.attribute(name, *args)
-          define_method("#{name}?") do
-            !send(name).nil?
-          end
-
-          super
-        end
-
-        def self.new(hash = {})
-          begin
-            obj = preserve_meta_properties(hash) do
-              super(hash)
-            end
-          rescue Dry::Struct::Error => exception
-            raise Fortnox::API::AttributeError, exception
-          end
-
-          IceNine.deep_freeze(obj)
-        end
-
-        def self.stub
-          new(self::STUB.dup)
-        end
-
-        def unique_id
-          send(self.class::UNIQUE_ID)
-        end
-
-        # This filtering logic could be improved since it is currently O(N*M).
-        def attributes(*options)
-          return self.class.schema if options.nil?
-
-          options = Array(options)
-
-          self.class.schema.find_all do |_name, attribute|
-            options.all? { |option| attribute.is?(option) }
-          end
-        end
-
-        def to_hash(recursive = false) # rubocop:disable Style/OptionalBooleanParameter
-          return super() if recursive
-
-          self.class.schema.each_with_object({}) do |key, result|
-            # Only output attributes that have a value set
-            result[key.name] = self[key.name] if send("#{key.name}?")
-          end
-        end
-
-        def update(hash)
-          old_attributes = to_hash
-          new_attributes = old_attributes.merge(hash).compact
-
-          return self if new_attributes == old_attributes
-
-          new_attributes[:new] = @new
-          new_attributes[:parent] = self
-          self.class.new(new_attributes)
-        end
-
-        # Generic comparison, by value, use .eql? or .equal? for object identity.
-        def ==(other)
-          return false unless other.is_a? self.class
-
-          to_hash == other.to_hash
-        end
-
-        def new?
-          @new
-        end
-
-        def saved?
-          @saved
-        end
-
-        def parent?
-          !@parent.nil?
-        end
-
-        def parent
-          @parent || self.class.new(self.class::STUB.dup)
-        end
-
-        # dry-types filter anything that isn't specified as an attribute on the
-        # class that is being instantiated. This wrapper preserves the meta
-        # properties we need to track object state during that initialisation and
-        # sets them on the object after dry-types is done with it.
-        def self.preserve_meta_properties(hash)
-          is_unsaved = hash.delete(:unsaved) { true }
-          is_new = hash.delete(:new) { true }
-          parent = hash.delete(:parent) { nil }
-
-          obj = yield
-
-          # TODO: remove new, unsaved, saved
-          obj.instance_variable_set(:@unsaved, is_unsaved)
-          obj.instance_variable_set(:@saved, !is_unsaved)
-          obj.instance_variable_set(:@new, is_new)
-          obj.instance_variable_set(:@parent, parent)
-
-          obj
-        end
-
-        private_class_method :preserve_meta_properties
-
-        private
-
-        def private_attributes
-          @private_attributes ||= attribute_set.reject(&:public_writer?)
-        end
-      end
-    end
-  end
-end

data/lib/fortnox/api/models/customer.rb

@@ -1,210 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'base'
-require_relative '../types'
-
-module Fortnox
-  module API
-    module Model
-      class Customer < Fortnox::API::Model::Base
-        UNIQUE_ID = :customer_number
-        STUB = { name: '' }.freeze
-
-        # searchable_attributes(
-        #     :city, :customer_number, :email, :name, :organisation_number,
-        #     :phone1, :zip_code
-        # )
-        #
-        # sortable_attributes(
-        #   :customer_number, :name
-        # )
-        #
-        # filter(
-        #   :active
-        # )
-        #
-        # actions(
-        #   :hire
-        # )
-
-        # Url Direct URL to the record
-        attribute :url, Types::Nullable::String.is(:read_only)
-
-        # Address1  First address of the customer. 1024 characters
-        attribute :address1, Types::Sized::String[1024]
-
-        # Address2  Second address of the customer. 1024 characters
-        attribute :address2, Types::Sized::String[1024]
-
-        # City  City of the customer. 1024 characters
-        attribute :city, Types::Sized::String[1024]
-
-        # Country  Country of the customer. Read-only.
-        attribute :country, Types::Nullable::String.is(:read_only)
-
-        # Comments  Comments. 1024 characters.
-        attribute :comments, Types::Sized::String[1024]
-
-        # Currency  Currency of the customer, 3 letters
-        attribute :currency, Types::Currency
-
-        # CostCenter  Cost center of the customer, Cost center in Fortnox
-        attribute :cost_center, Types::Nullable::String
-
-        # CountryCode  Country code of the customer, 2 letters
-        attribute :country_code, Types::CountryCode
-
-        # CustomerNumber  Customer number. 1024 characters
-        attribute :customer_number, Types::Sized::String[1024]
-
-        # DefaultDeliveryTypes The properties for this object is listed in the table for "Default Delivery Types".
-        attribute :default_delivery_types, Types::DefaultDeliveryTypes
-
-        # The properties for this object is listed in the table for "Default Templates".
-        attribute :default_templates, Types::DefaultTemplates
-
-        # DeliveryAddress1  First delivery address of the customer. 1024 characters
-        attribute :delivery_address1, Types::Sized::String[1024]
-
-        # DeliveryAddress2  Second delivery address of the customer. 1024 characters
-        attribute :delivery_address2, Types::Sized::String[1024]
-
-        # DeliveryCity  Delivery city of the customer. 1024 characters
-        attribute :delivery_city, Types::Sized::String[1024]
-
-        # DeliveryCountry  Delivery country of the customer. Read-only.
-        attribute :delivery_country, Types::Nullable::String.is(:read_only)
-
-        # DeliveryCountryCode  Delivery country code of the customer, 2 letters
-        attribute :delivery_country_code, Types::CountryCode
-
-        # DeliveryFax  Delivery fax number of the customer. 1024 characters
-        attribute :delivery_fax, Types::Sized::String[1024]
-
-        # DeliveryName  Delivery name of the customer. 1024 characters
-        attribute :delivery_name, Types::Sized::String[1024]
-
-        # DeliveryPhone1  First delivery phone number of the customer. 1024 characters
-        attribute :delivery_phone1, Types::Sized::String[1024]
-
-        # DeliveryPhone2  Second delivery phone number of the customer. 1024 characters
-        attribute :delivery_phone2, Types::Sized::String[1024]
-
-        # DeliveryZipCode  Delivery zip code of the customer. 1024 characters.
-        attribute :delivery_zip_code, Types::Sized::String[1024]
-
-        # Email  Email address of the customer. 1024 characters
-        attribute :email, Types::Email
-
-        # EmailInvoice  Invoice email address of the customer. 1024 characters
-        attribute :email_invoice, Types::Email
-
-        # EmailInvoiceBCC  Invoice BCC email address of the customer. 1024 characters
-        attribute :email_invoice_bcc, Types::Email
-
-        # EmailInvoiceCC  Invoice CC email address of the customer. 1024 characters
-        attribute :email_invoice_cc, Types::Email
-
-        # EmailOffer  Offer email address of the customer. 1024 characters
-        attribute :email_offer, Types::Email
-
-        # EmailOfferBCC  Offer BCC email address of the customer. 1024 characters
-        attribute :email_offer_bcc, Types::Email
-
-        # EmailOfferCC  Offer CC email address of the customer. 1024 characters
-        attribute :email_offer_cc, Types::Email
-
-        # EmailOrder  Order email address of the customer. 1024 characters
-        attribute :email_order, Types::Email
-
-        # EmailOrderBCC  Order BCC email address of the customer. 1024 characters
-        attribute :email_order_bcc, Types::Email
-
-        # EmailOrderCC  Order CC email address of the customer. 1024 characters
-        attribute :email_order_cc, Types::Email
-
-        # Fax  Fax number of the customer. 1024 characters
-        attribute :fax, Types::Sized::String[1024]
-
-        # InvoiceAdministrationFee  Invoice administration fee of the customer, 12 digits (incl. decimals).
-        attribute :invoice_administration_fee,
-                  Types::Sized::Float[0.0, 99_999_999_999.9]
-
-        # InvoiceDiscount  Invoice discount of the customer, 12 digits (incl. decimals)
-        attribute :invoice_discount, Types::Sized::Float[0.0, 99_999_999_999.9]
-
-        # InvoiceFreight  Invoice freight fee of the customer, 12 digits (incl. decimals)
-        attribute :invoice_freight, Types::Sized::Float[0.0, 99_999_999_999.9]
-
-        # InvoiceRemark  Invoice remark of the customer. 1024 characters
-        attribute :invoice_remark, Types::Sized::String[1024]
-
-        # Name  Name of the customer, 1024 characters
-        attribute :name, Types::Sized::String[1024].is(:required)
-
-        # OrganisationNumber  Organisation number of the customer. 30 characters
-        attribute :organisation_number, Types::Sized::String[30]
-
-        # OurReference  Our reference of the customer. 50 characters
-        attribute :our_reference, Types::Sized::String[50]
-
-        # Phone1  First phone number of the customer. 1024 characters
-        attribute :phone1, Types::Sized::String[1024]
-
-        # Phone2  Second phone number of the customer. 1024 characters
-        attribute :phone2, Types::Sized::String[1024]
-
-        # PriceList  Price list of the customer, Price list in Fortnox
-        attribute :price_list, Types::Nullable::String
-
-        # Project  Project of the customer, Project in Fortnox
-        attribute :project, Types::Nullable::String
-
-        # SalesAccount  Sales account of the customer, 4 characters
-        attribute :sales_account, Types::SalesAccount
-
-        # ShowPriceVATIncluded  Show prices with VAT included or not
-        attribute :show_price_vat_included, Types::Nullable::Boolean
-
-        # TermsOfDeliveryCode  Terms of delivery code of the customer
-        attribute :terms_of_delivery, Types::Nullable::String
-
-        # TermsOfPaymentCode  Terms of payment code of the customer
-        attribute :terms_of_payment, Types::Nullable::String
-
-        # Type  Customer type, PRIVATE / COMPANY
-        attribute :type, Types::CustomerType
-
-        # VATNumber  VAT number of the customer
-        attribute :vat_number, Types::Nullable::String
-
-        # VATType  VAT type of the customer, SEVAT / SEREVERSEDVAT / EUREVERSEDVAT / EUVAT / EXPORT
-        attribute :vat_type, Types::VATType
-
-        # VisitAddress  Visit address of the customer. 128 characters
-        attribute :visiting_address, Types::Sized::String[128]
-
-        # VisitCity  Visit city of the customer. 128 characters
-        attribute :visiting_city, Types::Sized::String[128]
-
-        # VisitCountry  Visit country of the customer, read-only
-        attribute :visiting_country, Types::Nullable::String.is(:read_only)
-
-        # VisitingCountryCode Code of the visiting country for the customer, 2 letters
-        attribute :visiting_country_code, Types::CountryCode
-
-        # VisitZipCode  Visit zip code of the customer. 10 characters
-        attribute :visiting_zip_code, Types::Sized::String[10]
-
-        # WayOfDeliveryCode  Way of delivery code of the customer
-        attribute :way_of_delivery, Types::Nullable::String
-
-        # YourReference  Your reference of the customer. 50 characters
-        attribute :your_reference, Types::Sized::String[50]
-
-        # ZipCode  Zip code of the customer. 10 characters
-        attribute :zip_code, Types::Sized::String[10]
-      end
-    end
-  end
-end

data/lib/fortnox/api/models/document.rb

@@ -1,189 +0,0 @@
-# frozen_string_literal: true
-
-require_relative '../types'
-require_relative 'label'
-
-module Fortnox
-  module API
-    module Model
-      # This model is the shared attributes for Offer, Order and Invoice, the three "docuemnt models" in Fortnox.
-      # In the Fortnox implementation these are so close together that they are saved in the same database table.
-      # This is never used standalone, only included in the respective models.
-      class Document < Fortnox::API::Model::Base
-        # Url Direct url to the record.
-        attribute :url, Types::Nullable::String.is(:read_only)
-
-        # AdministrationFee The document administration fee.
-        attribute :administration_fee, Types::Nullable::Float
-
-        # AdministrationFeeVAT VAT of the document administration fee.
-        attribute :administration_fee_vat, Types::Nullable::Float.is(:read_only)
-
-        # Address1 Document address 1. 1024 characters
-        attribute :address1, Types::Sized::String[1024]
-
-        # Address2 Document address 2. 1024 characters
-        attribute :address2, Types::Sized::String[1024]
-
-        # BasisTaxReduction Basis of tax reduction.
-        attribute :basis_tax_reduction, Types::Nullable::Float.is(:read_only)
-
-        # Cancelled If the document is cancelled.
-        attribute :cancelled, Types::Nullable::Boolean.is(:read_only)
-
-        # City City for the document address.
-        attribute :city, Types::Sized::String[1024]
-
-        # Comments Comments of the document
-        attribute :comments, Types::Sized::String[1024]
-
-        # ContributionPercent Document contribution in percent.
-        attribute :contribution_percent, Types::Nullable::Float.is(:read_only)
-
-        # ContributionValue Document contribution in amount.
-        attribute :contribution_value, Types::Nullable::Float.is(:read_only)
-
-        # Country Country for the document address.
-        attribute :country, Types::Country
-
-        # CostCenter Code of the cost center.
-        attribute :cost_center, Types::Nullable::String
-
-        # Currency Code of the currency.
-        attribute :currency, Types::Currency
-
-        # CurrencyRate Currency rate used for the document
-        attribute :currency_rate, Types::Nullable::Float
-
-        # CurrencyUnit Currency unit used for the document
-        attribute :currency_unit, Types::Nullable::Float
-
-        # CustomerName Name of the customer. 1024 characters
-        attribute :customer_name, Types::Sized::String[1024]
-
-        # CustomerNumber Customer number of the customer. Required
-        attribute :customer_number, Types::Required::String
-
-        # DeliveryAddress1 Document delivery address 1.
-        attribute :delivery_address1, Types::Sized::String[1024]
-
-        # DeliveryAddress2 Document delivery address 2.
-        attribute :delivery_address2, Types::Sized::String[1024]
-
-        # DeliveryCity City for the document delivery address.
-        attribute :delivery_city, Types::Sized::String[1024]
-
-        # DeliveryCountry Country for the document delivery address.
-        attribute :delivery_country, Types::Country
-
-        # DeliveryDate Date of delivery.
-        attribute :delivery_date, Types::Nullable::Date
-
-        # DeliveryName  Name of the recipient of the delivery
-        attribute :delivery_name, Types::Sized::String[1024]
-
-        # DeliveryZipCode ZipCode for the document delivery address.
-        attribute :delivery_zip_code, Types::Sized::String[1024]
-
-        # DocumentNumber The document number.
-        attribute :document_number, Types::Nullable::Integer
-
-        # EmailInformation Separete EmailInformation object
-        attribute :email_information, Types::EmailInformation
-
-        # ExternalInvoiceReference1 External document reference 1. 80 characters
-        attribute :external_invoice_reference1, Types::Sized::String[80]
-
-        # ExternalInvoiceReference2 External document reference 2. 80 characters
-        attribute :external_invoice_reference2, Types::Sized::String[80]
-
-        # Freight Freight cost of the document. 12 digits (incl. decimals)
-        attribute :freight, Types::Sized::Float[0.0, 99_999_999_999.9]
-
-        # FreightVAT VAT of the freight cost.
-        attribute :freight_vat, Types::Nullable::Float.is(:read_only)
-
-        # Gross Gross value of the document
-        attribute :gross, Types::Nullable::Float.is(:read_only)
-
-        # HouseWork If there is any row of the document marked "housework".
-        attribute :housework, Types::Nullable::Boolean.is(:read_only)
-
-        attribute :labels, Types::Strict::Array.of(Label)
-
-        # Net Net amount
-        attribute :net, Types::Nullable::Float.is(:read_only)
-
-        # NotCompleted If the document is set as not completed.
-        attribute :not_completed, Types::Nullable::Boolean
-
-        # OfferReference Reference to the offer, if one exists.
-        attribute :offer_reference, Types::Nullable::Integer.is(:read_only)
-
-        # OrganisationNumber Organisation number of the customer for the
-        # document.
-        attribute :organisation_number, Types::Nullable::String.is(:read_only)
-
-        # OurReference Our reference. 50 characters
-        attribute :our_reference, Types::Sized::String[50]
-
-        # Phone1 Phone number 1 of the customer for the document. 1024 characters
-        attribute :phone1, Types::Sized::String[1024]
-
-        # Phone2 Phone number 2 of the customer for the document. 1024 characters
-        attribute :phone2, Types::Sized::String[1024]
-
-        # PriceList Code of the price list.
-        attribute :price_list, Types::Nullable::String
-
-        # PrintTemplate Print template of the document.
-        attribute :print_template, Types::Nullable::String
-
-        # Project Code of the project.
-        attribute :project, Types::Nullable::String
-
-        # Remarks Remarks of the document. 1024 characters
-        attribute :remarks, Types::Sized::String[1024]
-
-        # RoundOff Round off amount for the document.
-        attribute :round_off, Types::Nullable::Float.is(:read_only)
-
-        # Sent If the document is printed or sent in any way.
-        attribute :sent, Types::Nullable::Boolean.is(:read_only)
-
-        # TaxReduction The amount of tax reduction.
-        attribute :tax_reduction, Types::Nullable::Integer.is(:read_only)
-
-        # TaxReductionType Tax Reduction Type
-        attribute :tax_reduction_type, Types::TaxReductionType
-
-        # TermsOfDelivery Code of the terms of delivery.
-        attribute :terms_of_delivery, Types::Nullable::String
-
-        # TermsOfPayment Code of the terms of payment.
-        attribute :terms_of_payment, Types::Nullable::String
-
-        # Total The total amount of the document.
-        attribute :total, Types::Nullable::Float.is(:read_only)
-
-        # TotalVAT The total VAT amount of the document.
-        attribute :total_vat, Types::Nullable::Float.is(:read_only)
-
-        # VATIncluded If the price of the document is including VAT.
-        attribute :vat_included, Types::Nullable::Boolean
-
-        # WayOfDelivery Code of the way of delivery.
-        attribute :way_of_delivery, Types::Nullable::String
-
-        # YourOrderNumber Your order number. 30 characters
-        attribute :your_order_number, Types::Sized::String[30]
-
-        # YourReference Your reference. 50 characters
-        attribute :your_reference, Types::Sized::String[50]
-
-        # ZipCode Zip code of the document. 1024 characters
-        attribute :zip_code, Types::Sized::String[1024]
-      end
-    end
-  end
-end