vatsense 0.1.0

data/lib/vatsense/models/currency_list_response.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+module Vatsense
+  module Models
+    # @see Vatsense::Resources::Currency#list
+    class CurrencyListResponse < Vatsense::Internal::Type::BaseModel
+      # @!attribute code
+      #
+      #   @return [Integer, nil]
+      optional :code, Integer
+
+      # @!attribute data
+      #
+      #   @return [Array<Vatsense::Models::CurrencyListResponse::Data>, nil]
+      optional :data, -> { Vatsense::Internal::Type::ArrayOf[Vatsense::Models::CurrencyListResponse::Data] }
+
+      # @!attribute success
+      #
+      #   @return [Boolean, nil]
+      optional :success, Vatsense::Internal::Type::Boolean
+
+      # @!method initialize(code: nil, data: nil, success: nil)
+      #   @param code [Integer]
+      #   @param data [Array<Vatsense::Models::CurrencyListResponse::Data>]
+      #   @param success [Boolean]
+
+      class Data < Vatsense::Internal::Type::BaseModel
+        # @!attribute from
+        #   The 3-character source currency code.
+        #
+        #   @return [String, nil]
+        optional :from, String
+
+        # @!attribute object
+        #
+        #   @return [Symbol, Vatsense::Models::CurrencyListResponse::Data::Object, nil]
+        optional :object, enum: -> { Vatsense::Models::CurrencyListResponse::Data::Object }
+
+        # @!attribute rate
+        #   The exchange rate.
+        #
+        #   @return [Float, nil]
+        optional :rate, Float
+
+        # @!attribute to
+        #   The 3-character target currency code (GBP or EUR).
+        #
+        #   @return [String, nil]
+        optional :to, String
+
+        # @!method initialize(from: nil, object: nil, rate: nil, to: nil)
+        #   @param from [String] The 3-character source currency code.
+        #
+        #   @param object [Symbol, Vatsense::Models::CurrencyListResponse::Data::Object]
+        #
+        #   @param rate [Float] The exchange rate.
+        #
+        #   @param to [String] The 3-character target currency code (GBP or EUR).
+
+        # @see Vatsense::Models::CurrencyListResponse::Data#object
+        module Object
+          extend Vatsense::Internal::Type::Enum
+
+          CONVERT_RATE = :convert_rate
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/vatsense/models/find_rate.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Vatsense
+  module Models
+    # @see Vatsense::Resources::Rates#details
+    class FindRate < Vatsense::Internal::Type::BaseModel
+      # @!attribute code
+      #
+      #   @return [Integer, nil]
+      optional :code, Integer
+
+      # @!attribute data
+      #
+      #   @return [Vatsense::Models::RateWithTaxRate, nil]
+      optional :data, -> { Vatsense::RateWithTaxRate }
+
+      # @!attribute success
+      #
+      #   @return [Boolean, nil]
+      optional :success, Vatsense::Internal::Type::Boolean
+
+      # @!method initialize(code: nil, data: nil, success: nil)
+      #   @param code [Integer]
+      #   @param data [Vatsense::Models::RateWithTaxRate]
+      #   @param success [Boolean]
+    end
+  end
+end

data/lib/vatsense/models/invoice/invoice_item.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module Vatsense
+  module Models
+    module Invoice
+      class InvoiceItem < Vatsense::Internal::Type::BaseModel
+        # @!attribute id
+        #
+        #   @return [String, nil]
+        optional :id, String
+
+        # @!attribute discount_rate
+        #
+        #   @return [Float, nil]
+        optional :discount_rate, Float, nil?: true
+
+        # @!attribute item
+        #
+        #   @return [String, nil]
+        optional :item, String
+
+        # @!attribute object
+        #
+        #   @return [Symbol, Vatsense::Models::Invoice::InvoiceItem::Object, nil]
+        optional :object, enum: -> { Vatsense::Invoice::InvoiceItem::Object }
+
+        # @!attribute price_each
+        #
+        #   @return [Float, nil]
+        optional :price_each, Float
+
+        # @!attribute price_total
+        #
+        #   @return [Float, nil]
+        optional :price_total, Float
+
+        # @!attribute quantity
+        #
+        #   @return [Float, nil]
+        optional :quantity, Float
+
+        # @!attribute vat_rate
+        #
+        #   @return [Float, nil]
+        optional :vat_rate, Float
+
+        # @!method initialize(id: nil, discount_rate: nil, item: nil, object: nil, price_each: nil, price_total: nil, quantity: nil, vat_rate: nil)
+        #   @param id [String]
+        #   @param discount_rate [Float, nil]
+        #   @param item [String]
+        #   @param object [Symbol, Vatsense::Models::Invoice::InvoiceItem::Object]
+        #   @param price_each [Float]
+        #   @param price_total [Float]
+        #   @param quantity [Float]
+        #   @param vat_rate [Float]
+
+        # @see Vatsense::Models::Invoice::InvoiceItem#object
+        module Object
+          extend Vatsense::Internal::Type::Enum
+
+          ITEM = :item
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+
+    InvoiceItem = Invoice::InvoiceItem
+  end
+end

data/lib/vatsense/models/invoice/invoice_item_input.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Vatsense
+  module Models
+    module Invoice
+      class InvoiceItemInput < Vatsense::Internal::Type::BaseModel
+        # @!attribute item
+        #   The description of the line item.
+        #
+        #   @return [String]
+        required :item, String
+
+        # @!attribute price_each
+        #   The price per item. Must be a decimal with 2 decimal places.
+        #
+        #   @return [Float]
+        required :price_each, Float
+
+        # @!attribute quantity
+        #   The quantity of the item.
+        #
+        #   @return [Float]
+        required :quantity, Float
+
+        # @!attribute vat_rate
+        #   A percentage VAT rate for this item.
+        #
+        #   @return [Float]
+        required :vat_rate, Float
+
+        # @!attribute discount_rate
+        #   A percentage discount to apply to the price.
+        #
+        #   @return [Float, nil]
+        optional :discount_rate, Float
+
+        # @!method initialize(item:, price_each:, quantity:, vat_rate:, discount_rate: nil)
+        #   @param item [String] The description of the line item.
+        #
+        #   @param price_each [Float] The price per item. Must be a decimal with 2 decimal places.
+        #
+        #   @param quantity [Float] The quantity of the item.
+        #
+        #   @param vat_rate [Float] A percentage VAT rate for this item.
+        #
+        #   @param discount_rate [Float] A percentage discount to apply to the price.
+      end
+    end
+
+    InvoiceItemInput = Invoice::InvoiceItemInput
+  end
+end

data/lib/vatsense/models/invoice/item_add_params.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Vatsense
+  module Models
+    module Invoice
+      # @see Vatsense::Resources::Invoice::Item#add
+      class ItemAddParams < Vatsense::Internal::Type::BaseModel
+        extend Vatsense::Internal::Type::RequestParameters::Converter
+        include Vatsense::Internal::Type::RequestParameters
+
+        # @!attribute invoice_id
+        #
+        #   @return [String]
+        required :invoice_id, String
+
+        # @!attribute items
+        #
+        #   @return [Array<Vatsense::Models::Invoice::InvoiceItemInput>]
+        required :items, -> { Vatsense::Internal::Type::ArrayOf[Vatsense::Invoice::InvoiceItemInput] }
+
+        # @!method initialize(invoice_id:, items:, request_options: {})
+        #   @param invoice_id [String]
+        #   @param items [Array<Vatsense::Models::Invoice::InvoiceItemInput>]
+        #   @param request_options [Vatsense::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/vatsense/models/invoice/item_delete_params.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Vatsense
+  module Models
+    module Invoice
+      # @see Vatsense::Resources::Invoice::Item#delete
+      class ItemDeleteParams < Vatsense::Internal::Type::BaseModel
+        extend Vatsense::Internal::Type::RequestParameters::Converter
+        include Vatsense::Internal::Type::RequestParameters
+
+        # @!attribute invoice_id
+        #
+        #   @return [String]
+        required :invoice_id, String
+
+        # @!attribute item_id
+        #
+        #   @return [String]
+        required :item_id, String
+
+        # @!method initialize(invoice_id:, item_id:, request_options: {})
+        #   @param invoice_id [String]
+        #   @param item_id [String]
+        #   @param request_options [Vatsense::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/vatsense/models/invoice/item_retrieve_params.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Vatsense
+  module Models
+    module Invoice
+      # @see Vatsense::Resources::Invoice::Item#retrieve
+      class ItemRetrieveParams < Vatsense::Internal::Type::BaseModel
+        extend Vatsense::Internal::Type::RequestParameters::Converter
+        include Vatsense::Internal::Type::RequestParameters
+
+        # @!attribute invoice_id
+        #
+        #   @return [String]
+        required :invoice_id, String
+
+        # @!attribute item_id
+        #
+        #   @return [String]
+        required :item_id, String
+
+        # @!method initialize(invoice_id:, item_id:, request_options: {})
+        #   @param invoice_id [String]
+        #   @param item_id [String]
+        #   @param request_options [Vatsense::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/vatsense/models/invoice/item_retrieve_response.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Vatsense
+  module Models
+    module Invoice
+      # @see Vatsense::Resources::Invoice::Item#retrieve
+      class ItemRetrieveResponse < Vatsense::Internal::Type::BaseModel
+        # @!attribute code
+        #
+        #   @return [Integer, nil]
+        optional :code, Integer
+
+        # @!attribute data
+        #
+        #   @return [Vatsense::Models::Invoice::InvoiceItem, nil]
+        optional :data, -> { Vatsense::Invoice::InvoiceItem }
+
+        # @!attribute success
+        #
+        #   @return [Boolean, nil]
+        optional :success, Vatsense::Internal::Type::Boolean
+
+        # @!method initialize(code: nil, data: nil, success: nil)
+        #   @param code [Integer]
+        #   @param data [Vatsense::Models::Invoice::InvoiceItem]
+        #   @param success [Boolean]
+      end
+    end
+  end
+end

data/lib/vatsense/models/invoice/item_update_params.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Vatsense
+  module Models
+    module Invoice
+      # @see Vatsense::Resources::Invoice::Item#update
+      class ItemUpdateParams < Vatsense::Models::Invoice::InvoiceItemInput
+        extend Vatsense::Internal::Type::RequestParameters::Converter
+        include Vatsense::Internal::Type::RequestParameters
+
+        # @!attribute invoice_id
+        #
+        #   @return [String]
+        required :invoice_id, String
+
+        # @!attribute item_id
+        #
+        #   @return [String]
+        required :item_id, String
+
+        # @!method initialize(invoice_id:, item_id:, request_options: {})
+        #   @param invoice_id [String]
+        #   @param item_id [String]
+        #   @param request_options [Vatsense::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/vatsense/models/invoice.rb

@@ -0,0 +1,301 @@
+# frozen_string_literal: true
+
+module Vatsense
+  module Models
+    class InvoiceAPI < Vatsense::Internal::Type::BaseModel
+      # @!attribute id
+      #
+      #   @return [String, nil]
+      optional :id, String
+
+      # @!attribute business
+      #
+      #   @return [Vatsense::Models::InvoiceAPI::Business, nil]
+      optional :business, -> { Vatsense::InvoiceAPI::Business }
+
+      # @!attribute conversion
+      #
+      #   @return [Vatsense::Models::InvoiceConversionInput, nil]
+      optional :conversion, -> { Vatsense::InvoiceConversionInput }, nil?: true
+
+      # @!attribute created
+      #
+      #   @return [Time, nil]
+      optional :created, Time
+
+      # @!attribute currency_code
+      #
+      #   @return [String, nil]
+      optional :currency_code, String
+
+      # @!attribute customer
+      #
+      #   @return [Vatsense::Models::InvoiceAPI::Customer, nil]
+      optional :customer, -> { Vatsense::InvoiceAPI::Customer }, nil?: true
+
+      # @!attribute date
+      #
+      #   @return [String, nil]
+      optional :date, String
+
+      # @!attribute has_vat
+      #
+      #   @return [Boolean, nil]
+      optional :has_vat, Vatsense::Internal::Type::Boolean
+
+      # @!attribute invoice_number
+      #
+      #   @return [String, nil]
+      optional :invoice_number, String
+
+      # @!attribute invoice_url
+      #   Unique URL to view the invoice. Append "/pdf" to download a PDF copy.
+      #
+      #   @return [String, nil]
+      optional :invoice_url, String
+
+      # @!attribute is_copy
+      #
+      #   @return [Boolean, nil]
+      optional :is_copy, Vatsense::Internal::Type::Boolean
+
+      # @!attribute is_reverse_charge
+      #
+      #   @return [Boolean, nil]
+      optional :is_reverse_charge, Vatsense::Internal::Type::Boolean
+
+      # @!attribute items
+      #
+      #   @return [Array<Vatsense::Models::Invoice::InvoiceItem>, nil]
+      optional :items, -> { Vatsense::Internal::Type::ArrayOf[Vatsense::Invoice::InvoiceItem] }
+
+      # @!attribute notes
+      #
+      #   @return [String, nil]
+      optional :notes, String, nil?: true
+
+      # @!attribute num_items
+      #
+      #   @return [Integer, nil]
+      optional :num_items, Integer
+
+      # @!attribute object
+      #
+      #   @return [Symbol, Vatsense::Models::InvoiceAPI::Object, nil]
+      optional :object, enum: -> { Vatsense::InvoiceAPI::Object }
+
+      # @!attribute tax_point
+      #
+      #   @return [String, nil]
+      optional :tax_point, String
+
+      # @!attribute tax_type
+      #
+      #   @return [Symbol, Vatsense::Models::InvoiceAPI::TaxType, nil]
+      optional :tax_type, enum: -> { Vatsense::InvoiceAPI::TaxType }
+
+      # @!attribute totals
+      #
+      #   @return [Vatsense::Models::InvoiceAPI::Totals, nil]
+      optional :totals, -> { Vatsense::InvoiceAPI::Totals }
+
+      # @!attribute type
+      #
+      #   @return [Symbol, Vatsense::Models::InvoiceAPI::Type, nil]
+      optional :type, enum: -> { Vatsense::InvoiceAPI::Type }
+
+      # @!attribute updated
+      #
+      #   @return [Time, nil]
+      optional :updated, Time
+
+      # @!attribute zero_rated
+      #
+      #   @return [Boolean, nil]
+      optional :zero_rated, Vatsense::Internal::Type::Boolean
+
+      # @!method initialize(id: nil, business: nil, conversion: nil, created: nil, currency_code: nil, customer: nil, date: nil, has_vat: nil, invoice_number: nil, invoice_url: nil, is_copy: nil, is_reverse_charge: nil, items: nil, notes: nil, num_items: nil, object: nil, tax_point: nil, tax_type: nil, totals: nil, type: nil, updated: nil, zero_rated: nil)
+      #   @param id [String]
+      #
+      #   @param business [Vatsense::Models::InvoiceAPI::Business]
+      #
+      #   @param conversion [Vatsense::Models::InvoiceConversionInput, nil]
+      #
+      #   @param created [Time]
+      #
+      #   @param currency_code [String]
+      #
+      #   @param customer [Vatsense::Models::InvoiceAPI::Customer, nil]
+      #
+      #   @param date [String]
+      #
+      #   @param has_vat [Boolean]
+      #
+      #   @param invoice_number [String]
+      #
+      #   @param invoice_url [String] Unique URL to view the invoice. Append "/pdf" to download a PDF copy.
+      #
+      #   @param is_copy [Boolean]
+      #
+      #   @param is_reverse_charge [Boolean]
+      #
+      #   @param items [Array<Vatsense::Models::Invoice::InvoiceItem>]
+      #
+      #   @param notes [String, nil]
+      #
+      #   @param num_items [Integer]
+      #
+      #   @param object [Symbol, Vatsense::Models::InvoiceAPI::Object]
+      #
+      #   @param tax_point [String]
+      #
+      #   @param tax_type [Symbol, Vatsense::Models::InvoiceAPI::TaxType]
+      #
+      #   @param totals [Vatsense::Models::InvoiceAPI::Totals]
+      #
+      #   @param type [Symbol, Vatsense::Models::InvoiceAPI::Type]
+      #
+      #   @param updated [Time]
+      #
+      #   @param zero_rated [Boolean]
+
+      # @see Vatsense::Models::InvoiceAPI#business
+      class Business < Vatsense::Internal::Type::BaseModel
+        # @!attribute address
+        #
+        #   @return [String, nil]
+        optional :address, String
+
+        # @!attribute company_number
+        #
+        #   @return [String, nil]
+        optional :company_number, String
+
+        # @!attribute logo
+        #
+        #   @return [String, nil]
+        optional :logo, String, nil?: true
+
+        # @!attribute name
+        #
+        #   @return [String, nil]
+        optional :name, String
+
+        # @!attribute vat_number
+        #
+        #   @return [String, nil]
+        optional :vat_number, String
+
+        # @!method initialize(address: nil, company_number: nil, logo: nil, name: nil, vat_number: nil)
+        #   @param address [String]
+        #   @param company_number [String]
+        #   @param logo [String, nil]
+        #   @param name [String]
+        #   @param vat_number [String]
+      end
+
+      # @see Vatsense::Models::InvoiceAPI#customer
+      class Customer < Vatsense::Internal::Type::BaseModel
+        # @!attribute address
+        #
+        #   @return [String, nil]
+        optional :address, String
+
+        # @!attribute company_number
+        #
+        #   @return [String, nil]
+        optional :company_number, String
+
+        # @!attribute logo
+        #
+        #   @return [String, nil]
+        optional :logo, String, nil?: true
+
+        # @!attribute name
+        #
+        #   @return [String, nil]
+        optional :name, String
+
+        # @!attribute vat_number
+        #
+        #   @return [String, nil]
+        optional :vat_number, String
+
+        # @!method initialize(address: nil, company_number: nil, logo: nil, name: nil, vat_number: nil)
+        #   @param address [String]
+        #   @param company_number [String]
+        #   @param logo [String, nil]
+        #   @param name [String]
+        #   @param vat_number [String]
+      end
+
+      # @see Vatsense::Models::InvoiceAPI#object
+      module Object
+        extend Vatsense::Internal::Type::Enum
+
+        INVOICE = :invoice
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # @see Vatsense::Models::InvoiceAPI#tax_type
+      module TaxType
+        extend Vatsense::Internal::Type::Enum
+
+        INCL = :incl
+        EXCL = :excl
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # @see Vatsense::Models::InvoiceAPI#totals
+      class Totals < Vatsense::Internal::Type::BaseModel
+        # @!attribute discount
+        #   Total discount amount.
+        #
+        #   @return [Float, nil]
+        optional :discount, Float
+
+        # @!attribute subtotal
+        #   Total before VAT.
+        #
+        #   @return [Float, nil]
+        optional :subtotal, Float
+
+        # @!attribute total
+        #   Grand total.
+        #
+        #   @return [Float, nil]
+        optional :total, Float
+
+        # @!attribute vat
+        #   Total VAT amount.
+        #
+        #   @return [Float, nil]
+        optional :vat, Float
+
+        # @!method initialize(discount: nil, subtotal: nil, total: nil, vat: nil)
+        #   @param discount [Float] Total discount amount.
+        #
+        #   @param subtotal [Float] Total before VAT.
+        #
+        #   @param total [Float] Grand total.
+        #
+        #   @param vat [Float] Total VAT amount.
+      end
+
+      # @see Vatsense::Models::InvoiceAPI#type
+      module Type
+        extend Vatsense::Internal::Type::Enum
+
+        SALE = :sale
+        REFUND = :refund
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end