vatsense 0.1.0

data/lib/vatsense/models/invoice_business_input.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+module Vatsense
+  module Models
+    class InvoiceBusinessInput < Vatsense::Internal::Type::BaseModel
+      # @!attribute address
+      #   Your business trading address.
+      #
+      #   @return [String]
+      required :address, String
+
+      # @!attribute name
+      #   Your business trading name.
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute vat_number
+      #   Your business VAT number.
+      #
+      #   @return [String]
+      required :vat_number, String
+
+      # @!attribute bank_account
+      #
+      #   @return [String, nil]
+      optional :bank_account, String
+
+      # @!attribute company_number
+      #   Your business company number.
+      #
+      #   @return [String, nil]
+      optional :company_number, String
+
+      # @!attribute email
+      #
+      #   @return [String, nil]
+      optional :email, String
+
+      # @!attribute logo
+      #   URL to your company logo (HTTPS only, .svg/.jpg/.png). Recommended 240px by
+      #   60px.
+      #
+      #   @return [String, nil]
+      optional :logo, String
+
+      # @!attribute phone
+      #
+      #   @return [String, nil]
+      optional :phone, String
+
+      # @!attribute website
+      #
+      #   @return [String, nil]
+      optional :website, String
+
+      # @!method initialize(address:, name:, vat_number:, bank_account: nil, company_number: nil, email: nil, logo: nil, phone: nil, website: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Vatsense::Models::InvoiceBusinessInput} for more details.
+      #
+      #   @param address [String] Your business trading address.
+      #
+      #   @param name [String] Your business trading name.
+      #
+      #   @param vat_number [String] Your business VAT number.
+      #
+      #   @param bank_account [String]
+      #
+      #   @param company_number [String] Your business company number.
+      #
+      #   @param email [String]
+      #
+      #   @param logo [String] URL to your company logo (HTTPS only, .svg/.jpg/.png). Recommended 240px by 60px
+      #
+      #   @param phone [String]
+      #
+      #   @param website [String]
+    end
+  end
+end

data/lib/vatsense/models/invoice_conversion_input.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Vatsense
+  module Models
+    class InvoiceConversionInput < Vatsense::Internal::Type::BaseModel
+      # @!attribute currency_code
+      #   The 3-character currency code for the conversion.
+      #
+      #   @return [String]
+      required :currency_code, String
+
+      # @!attribute rate
+      #   The rate of conversion.
+      #
+      #   @return [Float]
+      required :rate, Float
+
+      # @!method initialize(currency_code:, rate:)
+      #   @param currency_code [String] The 3-character currency code for the conversion.
+      #
+      #   @param rate [Float] The rate of conversion.
+    end
+  end
+end

data/lib/vatsense/models/invoice_create_params.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Vatsense
+  module Models
+    # @see Vatsense::Resources::Invoice#create
+    class InvoiceCreateParams < Vatsense::Models::CreateInvoice
+      extend Vatsense::Internal::Type::RequestParameters::Converter
+      include Vatsense::Internal::Type::RequestParameters
+
+      # @!method initialize(request_options: {})
+      #   @param request_options [Vatsense::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/vatsense/models/invoice_customer_input.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module Vatsense
+  module Models
+    class InvoiceCustomerInput < Vatsense::Internal::Type::BaseModel
+      # @!attribute name
+      #   The customer's trading name.
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute address
+      #
+      #   @return [String, nil]
+      optional :address, String
+
+      # @!attribute company_number
+      #
+      #   @return [String, nil]
+      optional :company_number, String
+
+      # @!attribute country_code
+      #
+      #   @return [String, nil]
+      optional :country_code, String
+
+      # @!attribute email
+      #
+      #   @return [String, nil]
+      optional :email, String
+
+      # @!attribute logo
+      #   URL to the customer logo (HTTPS only, .jpg/.png).
+      #
+      #   @return [String, nil]
+      optional :logo, String
+
+      # @!attribute vat_number
+      #
+      #   @return [String, nil]
+      optional :vat_number, String
+
+      # @!method initialize(name:, address: nil, company_number: nil, country_code: nil, email: nil, logo: nil, vat_number: nil)
+      #   @param name [String] The customer's trading name.
+      #
+      #   @param address [String]
+      #
+      #   @param company_number [String]
+      #
+      #   @param country_code [String]
+      #
+      #   @param email [String]
+      #
+      #   @param logo [String] URL to the customer logo (HTTPS only, .jpg/.png).
+      #
+      #   @param vat_number [String]
+    end
+  end
+end

data/lib/vatsense/models/invoice_delete_params.rb

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

data/lib/vatsense/models/invoice_delete_response.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Vatsense
+  module Models
+    # @see Vatsense::Resources::Invoice#delete
+    class InvoiceDeleteResponse < Vatsense::Internal::Type::BaseModel
+      # @!attribute code
+      #
+      #   @return [Integer]
+      required :code, Integer
+
+      # @!attribute success
+      #
+      #   @return [Boolean]
+      required :success, Vatsense::Internal::Type::Boolean
+
+      # @!method initialize(code:, success:)
+      #   @param code [Integer]
+      #   @param success [Boolean]
+    end
+  end
+end

data/lib/vatsense/models/invoice_list_params.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Vatsense
+  module Models
+    # @see Vatsense::Resources::Invoice#list
+    class InvoiceListParams < Vatsense::Internal::Type::BaseModel
+      extend Vatsense::Internal::Type::RequestParameters::Converter
+      include Vatsense::Internal::Type::RequestParameters
+
+      # @!attribute limit
+      #   Number of invoices to return (default 10, max 100).
+      #
+      #   @return [Integer, nil]
+      optional :limit, Integer
+
+      # @!attribute offset
+      #   Number of invoices to skip (default 0).
+      #
+      #   @return [Integer, nil]
+      optional :offset, Integer
+
+      # @!attribute search
+      #   Search query to filter invoices.
+      #
+      #   @return [String, nil]
+      optional :search, String
+
+      # @!method initialize(limit: nil, offset: nil, search: nil, request_options: {})
+      #   @param limit [Integer] Number of invoices to return (default 10, max 100).
+      #
+      #   @param offset [Integer] Number of invoices to skip (default 0).
+      #
+      #   @param search [String] Search query to filter invoices.
+      #
+      #   @param request_options [Vatsense::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/vatsense/models/invoice_list_response.rb

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

data/lib/vatsense/models/invoice_response.rb

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

data/lib/vatsense/models/invoice_retrieve_params.rb

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

data/lib/vatsense/models/invoice_update_params.rb

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

data/lib/vatsense/models/rate.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module Vatsense
+  module Models
+    class Rate < 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 an EU member.
+      #
+      #   @return [Boolean, nil]
+      optional :eu, Vatsense::Internal::Type::Boolean
+
+      # @!attribute object
+      #
+      #   @return [Symbol, Vatsense::Models::Rate::Object, nil]
+      optional :object, enum: -> { Vatsense::Rate::Object }
+
+      # @!attribute other
+      #   A list of other tax rates. Null if no additional rates exist.
+      #
+      #   @return [Array<Vatsense::Models::Rate::Other>, nil]
+      optional :other, -> { Vatsense::Internal::Type::ArrayOf[Vatsense::Rate::Other] }, nil?: true
+
+      # @!attribute standard
+      #
+      #   @return [Vatsense::Models::TaxRate, nil]
+      optional :standard, -> { Vatsense::TaxRate }
+
+      # @!method initialize(country_code: nil, country_name: nil, eu: nil, object: nil, other: nil, standard: 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 an EU member.
+      #
+      #   @param object [Symbol, Vatsense::Models::Rate::Object]
+      #
+      #   @param other [Array<Vatsense::Models::Rate::Other>, nil] A list of other tax rates. Null if no additional rates exist.
+      #
+      #   @param standard [Vatsense::Models::TaxRate]
+
+      # @see Vatsense::Models::Rate#object
+      module Object
+        extend Vatsense::Internal::Type::Enum
+
+        RATE = :rate
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      class Other < Vatsense::Models::TaxRate
+        # @!attribute province
+        #   The province this rate applies to, if applicable.
+        #
+        #   @return [String, nil]
+        optional :province, String, nil?: true
+
+        # @!method initialize(province: nil)
+        #   @param province [String, nil] The province this rate applies to, if applicable.
+      end
+    end
+  end
+end

data/lib/vatsense/models/rate_calculate_price_params.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+module Vatsense
+  module Models
+    # @see Vatsense::Resources::Rates#calculate_price
+    class RateCalculatePriceParams < 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::RateCalculatePriceParams::TaxType]
+      required :tax_type, enum: -> { Vatsense::RateCalculatePriceParams::TaxType }
+
+      # @!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 eu
+      #   Filter results by EU membership. Use 1 for EU countries only, 0 for non-EU only.
+      #
+      #   @return [Boolean, nil]
+      optional :eu, Vatsense::Internal::Type::Boolean
+
+      # @!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
+
+      # @!attribute province_code
+      #   A 2-character province code (e.g. "NU", "NT"). If providing a province code, you
+      #   must also provide the relevant country_code.
+      #
+      #   @return [String, nil]
+      optional :province_code, String
+
+      # @!attribute type
+      #   The product type to find the applicable rate for. See the /rates/types endpoint
+      #   for a full list of valid values.
+      #
+      #   @return [String, nil]
+      optional :type, String
+
+      # @!method initialize(price:, tax_type:, country_code: nil, eu: nil, ip_address: nil, province_code: nil, type: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Vatsense::Models::RateCalculatePriceParams} 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::RateCalculatePriceParams::TaxType] Whether the provided price is inclusive or exclusive of VAT.
+      #
+      #   @param country_code [String] A 2-character ISO 3166-1 alpha-2 country code (e.g. "GB", "FR").
+      #
+      #   @param eu [Boolean] Filter results by EU membership. Use 1 for EU countries only, 0 for non-EU only.
+      #
+      #   @param ip_address [String] An IPv4 or IPv6 address. If provided, the country will be determined from the IP
+      #
+      #   @param province_code [String] A 2-character province code (e.g. "NU", "NT"). If providing a province
+      #
+      #   @param type [String] The product type to find the applicable rate for. See the /rates/types
+      #
+      #   @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/rate_calculate_price_response.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module Vatsense
+  module Models
+    # @see Vatsense::Resources::Rates#calculate_price
+    class RateCalculatePriceResponse < Vatsense::Internal::Type::BaseModel
+      # @!attribute code
+      #
+      #   @return [Integer, nil]
+      optional :code, Integer
+
+      # @!attribute data
+      #
+      #   @return [Vatsense::Models::RateCalculatePriceResponse::Data, nil]
+      optional :data, -> { Vatsense::Models::RateCalculatePriceResponse::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::RateCalculatePriceResponse::Data]
+      #   @param success [Boolean]
+
+      # @see Vatsense::Models::RateCalculatePriceResponse#data
+      class Data < Vatsense::Internal::Type::BaseModel
+        # @!attribute country_code
+        #
+        #   @return [String, nil]
+        optional :country_code, String
+
+        # @!attribute country_name
+        #
+        #   @return [String, nil]
+        optional :country_name, String
+
+        # @!attribute eu
+        #
+        #   @return [Boolean, nil]
+        optional :eu, Vatsense::Internal::Type::Boolean
+
+        # @!attribute object
+        #
+        #   @return [Symbol, Vatsense::Models::RateCalculatePriceResponse::Data::Object, nil]
+        optional :object, enum: -> { Vatsense::Models::RateCalculatePriceResponse::Data::Object }
+
+        # @!attribute tax_rate
+        #
+        #   @return [Vatsense::Models::TaxRate, nil]
+        optional :tax_rate, -> { Vatsense::TaxRate }
+
+        # @!attribute vat_price
+        #
+        #   @return [Vatsense::Models::VatPrice, nil]
+        optional :vat_price, -> { Vatsense::VatPrice }
+
+        # @!method initialize(country_code: nil, country_name: nil, eu: nil, object: nil, tax_rate: nil, vat_price: nil)
+        #   @param country_code [String]
+        #   @param country_name [String]
+        #   @param eu [Boolean]
+        #   @param object [Symbol, Vatsense::Models::RateCalculatePriceResponse::Data::Object]
+        #   @param tax_rate [Vatsense::Models::TaxRate]
+        #   @param vat_price [Vatsense::Models::VatPrice]
+
+        # @see Vatsense::Models::RateCalculatePriceResponse::Data#object
+        module Object
+          extend Vatsense::Internal::Type::Enum
+
+          RATE = :rate
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/vatsense/models/rate_details_params.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module Vatsense
+  module Models
+    # @see Vatsense::Resources::Rates#details
+    class RateDetailsParams < 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 eu
+      #   Filter results by EU membership. Use 1 for EU countries only, 0 for non-EU only.
+      #
+      #   @return [Boolean, nil]
+      optional :eu, Vatsense::Internal::Type::Boolean
+
+      # @!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
+
+      # @!attribute period
+      #   A historical date to retrieve rates for (format "YYYY-MM-DD HH:MM:SS"). Must be
+      #   a past date.
+      #
+      #   @return [Time, nil]
+      optional :period, Time
+
+      # @!attribute province_code
+      #   A 2-character province code (e.g. "NU", "NT"). If providing a province code, you
+      #   must also provide the relevant country_code.
+      #
+      #   @return [String, nil]
+      optional :province_code, String
+
+      # @!attribute type
+      #   The product type to find the applicable rate for. See the /rates/types endpoint
+      #   for a full list of valid values.
+      #
+      #   @return [String, nil]
+      optional :type, String
+
+      # @!method initialize(country_code: nil, eu: nil, ip_address: nil, period: nil, province_code: nil, type: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Vatsense::Models::RateDetailsParams} for more details.
+      #
+      #   @param country_code [String] A 2-character ISO 3166-1 alpha-2 country code (e.g. "GB", "FR").
+      #
+      #   @param eu [Boolean] Filter results by EU membership. Use 1 for EU countries only, 0 for non-EU only.
+      #
+      #   @param ip_address [String] An IPv4 or IPv6 address. If provided, the country will be determined from the IP
+      #
+      #   @param period [Time] A historical date to retrieve rates for (format "YYYY-MM-DD HH:MM:SS"). Must be
+      #
+      #   @param province_code [String] A 2-character province code (e.g. "NU", "NT"). If providing a province
+      #
+      #   @param type [String] The product type to find the applicable rate for. See the /rates/types
+      #
+      #   @param request_options [Vatsense::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end