vatsense 0.1.0

data/lib/vatsense/internal.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Vatsense
+  module Internal
+    extend Vatsense::Internal::Util::SorbetRuntimeSupport
+
+    OMIT =
+      Object.new.tap do
+        _1.define_singleton_method(:inspect) { "#<#{Vatsense::Internal}::OMIT>" }
+      end
+        .freeze
+
+    define_sorbet_constant!(:AnyHash) do
+      T.type_alias { T::Hash[Symbol, T.anything] }
+    end
+    define_sorbet_constant!(:FileInput) do
+      T.type_alias { T.any(Pathname, StringIO, IO, String, Vatsense::FilePart) }
+    end
+  end
+end

data/lib/vatsense/models/country.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module Vatsense
+  module Models
+    class Country < Vatsense::Internal::Type::BaseModel
+      # @!attribute country_code
+      #   2-character ISO 3166-1 alpha-2 country code.
+      #
+      #   @return [String, nil]
+      optional :country_code, String
+
+      # @!attribute country_name
+      #
+      #   @return [String, nil]
+      optional :country_name, String
+
+      # @!attribute eu
+      #   Whether the country is subject to EU VAT.
+      #
+      #   @return [Boolean, nil]
+      optional :eu, Vatsense::Internal::Type::Boolean
+
+      # @!attribute latitude
+      #
+      #   @return [Float, nil]
+      optional :latitude, Float
+
+      # @!attribute longitude
+      #
+      #   @return [Float, nil]
+      optional :longitude, Float
+
+      # @!attribute object
+      #
+      #   @return [Symbol, Vatsense::Models::Country::Object, nil]
+      optional :object, enum: -> { Vatsense::Country::Object }
+
+      # @!attribute vat
+      #   Whether the country is subject to VAT/GST.
+      #
+      #   @return [Boolean, nil]
+      optional :vat, Vatsense::Internal::Type::Boolean
+
+      # @!method initialize(country_code: nil, country_name: nil, eu: nil, latitude: nil, longitude: nil, object: nil, vat: nil)
+      #   @param country_code [String] 2-character ISO 3166-1 alpha-2 country code.
+      #
+      #   @param country_name [String]
+      #
+      #   @param eu [Boolean] Whether the country is subject to EU VAT.
+      #
+      #   @param latitude [Float]
+      #
+      #   @param longitude [Float]
+      #
+      #   @param object [Symbol, Vatsense::Models::Country::Object]
+      #
+      #   @param vat [Boolean] Whether the country is subject to VAT/GST.
+
+      # @see Vatsense::Models::Country#object
+      module Object
+        extend Vatsense::Internal::Type::Enum
+
+        COUNTRY = :country
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/vatsense/models/country_list_params.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Vatsense
+  module Models
+    # @see Vatsense::Resources::Countries#list
+    class CountryListParams < Vatsense::Internal::Type::BaseModel
+      extend Vatsense::Internal::Type::RequestParameters::Converter
+      include Vatsense::Internal::Type::RequestParameters
+
+      # @!attribute country_code
+      #   A 2-character ISO 3166-1 alpha-2 country code (e.g. "GB", "FR").
+      #
+      #   @return [String, nil]
+      optional :country_code, String
+
+      # @!attribute ip_address
+      #   An IPv4 or IPv6 address. If provided, the country will be determined from the IP
+      #   address.
+      #
+      #   @return [String, nil]
+      optional :ip_address, String
+
+      # @!method initialize(country_code: nil, ip_address: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Vatsense::Models::CountryListParams} for more details.
+      #
+      #   @param country_code [String] A 2-character ISO 3166-1 alpha-2 country code (e.g. "GB", "FR").
+      #
+      #   @param ip_address [String] An IPv4 or IPv6 address. If provided, the country will be determined from the IP
+      #
+      #   @param request_options [Vatsense::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/vatsense/models/country_list_provinces_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Vatsense
+  module Models
+    # @see Vatsense::Resources::Countries#list_provinces
+    class CountryListProvincesParams < Vatsense::Internal::Type::BaseModel
+      extend Vatsense::Internal::Type::RequestParameters::Converter
+      include Vatsense::Internal::Type::RequestParameters
+
+      # @!attribute country_code
+      #   A 2-character ISO 3166-1 alpha-2 country code (e.g. "CA").
+      #
+      #   @return [String]
+      required :country_code, String
+
+      # @!method initialize(country_code:, request_options: {})
+      #   @param country_code [String] A 2-character ISO 3166-1 alpha-2 country code (e.g. "CA").
+      #
+      #   @param request_options [Vatsense::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/vatsense/models/country_list_provinces_response.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module Vatsense
+  module Models
+    # @see Vatsense::Resources::Countries#list_provinces
+    class CountryListProvincesResponse < Vatsense::Internal::Type::BaseModel
+      # @!attribute code
+      #
+      #   @return [Integer, nil]
+      optional :code, Integer
+
+      # @!attribute data
+      #
+      #   @return [Array<Vatsense::Models::CountryListProvincesResponse::Data>, nil]
+      optional :data,
+               -> { Vatsense::Internal::Type::ArrayOf[Vatsense::Models::CountryListProvincesResponse::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::CountryListProvincesResponse::Data>]
+      #   @param success [Boolean]
+
+      class Data < Vatsense::Internal::Type::BaseModel
+        # @!attribute country_code
+        #
+        #   @return [String, nil]
+        optional :country_code, String
+
+        # @!attribute object
+        #
+        #   @return [Symbol, Vatsense::Models::CountryListProvincesResponse::Data::Object, nil]
+        optional :object, enum: -> { Vatsense::Models::CountryListProvincesResponse::Data::Object }
+
+        # @!attribute province_code
+        #
+        #   @return [String, nil]
+        optional :province_code, String
+
+        # @!attribute province_name
+        #
+        #   @return [String, nil]
+        optional :province_name, String
+
+        # @!method initialize(country_code: nil, object: nil, province_code: nil, province_name: nil)
+        #   @param country_code [String]
+        #   @param object [Symbol, Vatsense::Models::CountryListProvincesResponse::Data::Object]
+        #   @param province_code [String]
+        #   @param province_name [String]
+
+        # @see Vatsense::Models::CountryListProvincesResponse::Data#object
+        module Object
+          extend Vatsense::Internal::Type::Enum
+
+          PROVINCE = :province
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/vatsense/models/country_list_response.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Vatsense
+  module Models
+    # @see Vatsense::Resources::Countries#list
+    class CountryListResponse < Vatsense::Internal::Type::BaseModel
+      # @!attribute code
+      #
+      #   @return [Integer, nil]
+      optional :code, Integer
+
+      # @!attribute data
+      #
+      #   @return [Array<Vatsense::Models::Country>, nil]
+      optional :data, -> { Vatsense::Internal::Type::ArrayOf[Vatsense::Country] }
+
+      # @!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::Country>]
+      #   @param success [Boolean]
+    end
+  end
+end

data/lib/vatsense/models/create_invoice.rb

@@ -0,0 +1,171 @@
+# frozen_string_literal: true
+
+module Vatsense
+  module Models
+    class CreateInvoice < Vatsense::Internal::Type::BaseModel
+      # @!attribute business
+      #
+      #   @return [Vatsense::Models::InvoiceBusinessInput]
+      required :business, -> { Vatsense::InvoiceBusinessInput }
+
+      # @!attribute currency_code
+      #   The 3-character currency code the invoice is billed in.
+      #
+      #   @return [String]
+      required :currency_code, String
+
+      # @!attribute date
+      #   The date the invoice was issued (YYYY-MM-DD or YYYY-MM-DD HH:MM:SS).
+      #
+      #   @return [String]
+      required :date, String
+
+      # @!attribute items
+      #
+      #   @return [Array<Vatsense::Models::Invoice::InvoiceItemInput>]
+      required :items, -> { Vatsense::Internal::Type::ArrayOf[Vatsense::Invoice::InvoiceItemInput] }
+
+      # @!attribute tax_point
+      #   The tax point or "time of supply" (YYYY-MM-DD or YYYY-MM-DD HH:MM:SS).
+      #
+      #   @return [String]
+      required :tax_point, String
+
+      # @!attribute conversion
+      #
+      #   @return [Vatsense::Models::InvoiceConversionInput, nil]
+      optional :conversion, -> { Vatsense::InvoiceConversionInput }
+
+      # @!attribute customer
+      #
+      #   @return [Vatsense::Models::InvoiceCustomerInput, nil]
+      optional :customer, -> { Vatsense::InvoiceCustomerInput }
+
+      # @!attribute has_vat
+      #   Whether the invoice is subject to VAT.
+      #
+      #   @return [Boolean, nil]
+      optional :has_vat, Vatsense::Internal::Type::Boolean
+
+      # @!attribute invoice_number
+      #   A unique invoice number. If not provided, defaults to an auto-incremented
+      #   number.
+      #
+      #   @return [String, nil]
+      optional :invoice_number, String
+
+      # @!attribute is_copy
+      #   Whether the invoice is a copy of a primary invoice.
+      #
+      #   @return [Boolean, nil]
+      optional :is_copy, Vatsense::Internal::Type::Boolean
+
+      # @!attribute is_reverse_charge
+      #   Whether the invoice is zero-rated due to reverse charge.
+      #
+      #   @return [Boolean, nil]
+      optional :is_reverse_charge, Vatsense::Internal::Type::Boolean
+
+      # @!attribute notes
+      #   Any additional notes for the invoice.
+      #
+      #   @return [String, nil]
+      optional :notes, String
+
+      # @!attribute pad_invoice_number
+      #   Pad the auto-generated invoice number with leading zeros to this length.
+      #
+      #   @return [Integer, nil]
+      optional :pad_invoice_number, Integer
+
+      # @!attribute serial
+      #   A serial prepended to the auto-generated invoice number. Each unique serial has
+      #   its own auto-increment range.
+      #
+      #   @return [String, nil]
+      optional :serial, String
+
+      # @!attribute tax_type
+      #   Whether item prices include or exclude VAT.
+      #
+      #   @return [Symbol, Vatsense::Models::CreateInvoice::TaxType, nil]
+      optional :tax_type, enum: -> { Vatsense::CreateInvoice::TaxType }
+
+      # @!attribute type
+      #   The type of invoice.
+      #
+      #   @return [Symbol, Vatsense::Models::CreateInvoice::Type, nil]
+      optional :type, enum: -> { Vatsense::CreateInvoice::Type }
+
+      # @!attribute zero_rated
+      #   Whether the invoice has been zero-rated.
+      #
+      #   @return [Boolean, nil]
+      optional :zero_rated, Vatsense::Internal::Type::Boolean
+
+      # @!method initialize(business:, currency_code:, date:, items:, tax_point:, conversion: nil, customer: nil, has_vat: nil, invoice_number: nil, is_copy: nil, is_reverse_charge: nil, notes: nil, pad_invoice_number: nil, serial: nil, tax_type: nil, type: nil, zero_rated: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Vatsense::Models::CreateInvoice} for more details.
+      #
+      #   @param business [Vatsense::Models::InvoiceBusinessInput]
+      #
+      #   @param currency_code [String] The 3-character currency code the invoice is billed in.
+      #
+      #   @param date [String] The date the invoice was issued (YYYY-MM-DD or YYYY-MM-DD HH:MM:SS).
+      #
+      #   @param items [Array<Vatsense::Models::Invoice::InvoiceItemInput>]
+      #
+      #   @param tax_point [String] The tax point or "time of supply" (YYYY-MM-DD or YYYY-MM-DD HH:MM:SS).
+      #
+      #   @param conversion [Vatsense::Models::InvoiceConversionInput]
+      #
+      #   @param customer [Vatsense::Models::InvoiceCustomerInput]
+      #
+      #   @param has_vat [Boolean] Whether the invoice is subject to VAT.
+      #
+      #   @param invoice_number [String] A unique invoice number. If not provided, defaults to an auto-incremented number
+      #
+      #   @param is_copy [Boolean] Whether the invoice is a copy of a primary invoice.
+      #
+      #   @param is_reverse_charge [Boolean] Whether the invoice is zero-rated due to reverse charge.
+      #
+      #   @param notes [String] Any additional notes for the invoice.
+      #
+      #   @param pad_invoice_number [Integer] Pad the auto-generated invoice number with leading zeros to this length.
+      #
+      #   @param serial [String] A serial prepended to the auto-generated invoice number. Each unique serial has
+      #
+      #   @param tax_type [Symbol, Vatsense::Models::CreateInvoice::TaxType] Whether item prices include or exclude VAT.
+      #
+      #   @param type [Symbol, Vatsense::Models::CreateInvoice::Type] The type of invoice.
+      #
+      #   @param zero_rated [Boolean] Whether the invoice has been zero-rated.
+
+      # Whether item prices include or exclude VAT.
+      #
+      # @see Vatsense::Models::CreateInvoice#tax_type
+      module TaxType
+        extend Vatsense::Internal::Type::Enum
+
+        INCL = :incl
+        EXCL = :excl
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # The type of invoice.
+      #
+      # @see Vatsense::Models::CreateInvoice#type
+      module Type
+        extend Vatsense::Internal::Type::Enum
+
+        SALE = :sale
+        REFUND = :refund
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/vatsense/models/currency_calculate_vat_price_params.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Vatsense
+  module Models
+    # @see Vatsense::Resources::Currency#calculate_vat_price
+    class CurrencyCalculateVatPriceParams < Vatsense::Internal::Type::BaseModel
+      extend Vatsense::Internal::Type::RequestParameters::Converter
+      include Vatsense::Internal::Type::RequestParameters
+
+      # @!attribute price
+      #   The price to calculate on. Must be a string with exactly 2 decimal places (e.g.
+      #   "30.00", "59.95").
+      #
+      #   @return [String]
+      required :price, String
+
+      # @!attribute tax_type
+      #   Whether the provided price is inclusive or exclusive of VAT.
+      #
+      #   @return [Symbol, Vatsense::Models::CurrencyCalculateVatPriceParams::TaxType]
+      required :tax_type, enum: -> { Vatsense::CurrencyCalculateVatPriceParams::TaxType }
+
+      # @!attribute vat_rate
+      #   A percentage VAT rate to use for the calculation.
+      #
+      #   @return [Float]
+      required :vat_rate, Float
+
+      # @!method initialize(price:, tax_type:, vat_rate:, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Vatsense::Models::CurrencyCalculateVatPriceParams} for more details.
+      #
+      #   @param price [String] The price to calculate on. Must be a string with exactly 2 decimal places (e.g.
+      #
+      #   @param tax_type [Symbol, Vatsense::Models::CurrencyCalculateVatPriceParams::TaxType] Whether the provided price is inclusive or exclusive of VAT.
+      #
+      #   @param vat_rate [Float] A percentage VAT rate to use for the calculation.
+      #
+      #   @param request_options [Vatsense::RequestOptions, Hash{Symbol=>Object}]
+
+      # Whether the provided price is inclusive or exclusive of VAT.
+      module TaxType
+        extend Vatsense::Internal::Type::Enum
+
+        INCL = :incl
+        EXCL = :excl
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/vatsense/models/currency_calculate_vat_price_response.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Vatsense
+  module Models
+    # @see Vatsense::Resources::Currency#calculate_vat_price
+    class CurrencyCalculateVatPriceResponse < Vatsense::Internal::Type::BaseModel
+      # @!attribute code
+      #
+      #   @return [Integer, nil]
+      optional :code, Integer
+
+      # @!attribute data
+      #
+      #   @return [Vatsense::Models::VatPrice, nil]
+      optional :data, -> { Vatsense::VatPrice }
+
+      # @!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::VatPrice]
+      #   @param success [Boolean]
+    end
+  end
+end

data/lib/vatsense/models/currency_convert_params.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+module Vatsense
+  module Models
+    # @see Vatsense::Resources::Currency#convert
+    class CurrencyConvertParams < Vatsense::Internal::Type::BaseModel
+      extend Vatsense::Internal::Type::RequestParameters::Converter
+      include Vatsense::Internal::Type::RequestParameters
+
+      # @!attribute amount
+      #   The amount to convert. Must be a string with exactly 2 decimal places (e.g.
+      #   "39.99").
+      #
+      #   @return [String]
+      required :amount, String
+
+      # @!attribute from
+      #   The 3-character source currency code (e.g. "USD", "CAD").
+      #
+      #   @return [String]
+      required :from, String
+
+      # @!attribute to
+      #   The 3-character target currency code. Must be either "GBP" or "EUR".
+      #
+      #   @return [Symbol, Vatsense::Models::CurrencyConvertParams::To]
+      required :to, enum: -> { Vatsense::CurrencyConvertParams::To }
+
+      # @!method initialize(amount:, from:, to:, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Vatsense::Models::CurrencyConvertParams} for more details.
+      #
+      #   @param amount [String] The amount to convert. Must be a string with exactly 2 decimal places (e.g. "39.
+      #
+      #   @param from [String] The 3-character source currency code (e.g. "USD", "CAD").
+      #
+      #   @param to [Symbol, Vatsense::Models::CurrencyConvertParams::To] The 3-character target currency code. Must be either "GBP" or "EUR".
+      #
+      #   @param request_options [Vatsense::RequestOptions, Hash{Symbol=>Object}]
+
+      # The 3-character target currency code. Must be either "GBP" or "EUR".
+      module To
+        extend Vatsense::Internal::Type::Enum
+
+        GBP = :GBP
+        EUR = :EUR
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/vatsense/models/currency_convert_response.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+module Vatsense
+  module Models
+    # @see Vatsense::Resources::Currency#convert
+    class CurrencyConvertResponse < Vatsense::Internal::Type::BaseModel
+      # @!attribute code
+      #
+      #   @return [Integer, nil]
+      optional :code, Integer
+
+      # @!attribute data
+      #
+      #   @return [Vatsense::Models::CurrencyConvertResponse::Data, nil]
+      optional :data, -> { Vatsense::Models::CurrencyConvertResponse::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 [Vatsense::Models::CurrencyConvertResponse::Data]
+      #   @param success [Boolean]
+
+      # @see Vatsense::Models::CurrencyConvertResponse#data
+      class Data < Vatsense::Internal::Type::BaseModel
+        # @!attribute amount
+        #   The original amount.
+        #
+        #   @return [Float, nil]
+        optional :amount, Float
+
+        # @!attribute converted
+        #   The converted amount.
+        #
+        #   @return [Float, nil]
+        optional :converted, Float
+
+        # @!attribute from
+        #
+        #   @return [String, nil]
+        optional :from, String
+
+        # @!attribute object
+        #
+        #   @return [Symbol, Vatsense::Models::CurrencyConvertResponse::Data::Object, nil]
+        optional :object, enum: -> { Vatsense::Models::CurrencyConvertResponse::Data::Object }
+
+        # @!attribute rate
+        #   The exchange rate used.
+        #
+        #   @return [Float, nil]
+        optional :rate, Float
+
+        # @!attribute to
+        #
+        #   @return [String, nil]
+        optional :to, String
+
+        # @!method initialize(amount: nil, converted: nil, from: nil, object: nil, rate: nil, to: nil)
+        #   @param amount [Float] The original amount.
+        #
+        #   @param converted [Float] The converted amount.
+        #
+        #   @param from [String]
+        #
+        #   @param object [Symbol, Vatsense::Models::CurrencyConvertResponse::Data::Object]
+        #
+        #   @param rate [Float] The exchange rate used.
+        #
+        #   @param to [String]
+
+        # @see Vatsense::Models::CurrencyConvertResponse::Data#object
+        module Object
+          extend Vatsense::Internal::Type::Enum
+
+          CONVERSION = :conversion
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/vatsense/models/currency_list_params.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Vatsense
+  module Models
+    # @see Vatsense::Resources::Currency#list
+    class CurrencyListParams < Vatsense::Internal::Type::BaseModel
+      extend Vatsense::Internal::Type::RequestParameters::Converter
+      include Vatsense::Internal::Type::RequestParameters
+
+      # @!attribute from
+      #   The 3-character currency code(s) to convert from (e.g. "USD", "CAD"). Can be a
+      #   comma-separated list without spaces (e.g. "USD,CAD,AUD").
+      #
+      #   @return [String, nil]
+      optional :from, String
+
+      # @!attribute to
+      #   The 3-character target currency code. Must be either "GBP" or "EUR".
+      #
+      #   @return [Symbol, Vatsense::Models::CurrencyListParams::To, nil]
+      optional :to, enum: -> { Vatsense::CurrencyListParams::To }
+
+      # @!method initialize(from: nil, to: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Vatsense::Models::CurrencyListParams} for more details.
+      #
+      #   @param from [String] The 3-character currency code(s) to convert from (e.g. "USD", "CAD").
+      #
+      #   @param to [Symbol, Vatsense::Models::CurrencyListParams::To] The 3-character target currency code. Must be either "GBP" or "EUR".
+      #
+      #   @param request_options [Vatsense::RequestOptions, Hash{Symbol=>Object}]
+
+      # The 3-character target currency code. Must be either "GBP" or "EUR".
+      module To
+        extend Vatsense::Internal::Type::Enum
+
+        GBP = :GBP
+        EUR = :EUR
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end