vatsense 0.1.0

data/rbi/vatsense/models/sandbox_generate_key_params.rbi

@@ -0,0 +1,27 @@
+# typed: strong
+
+module Vatsense
+  module Models
+    class SandboxGenerateKeyParams < Vatsense::Internal::Type::BaseModel
+      extend Vatsense::Internal::Type::RequestParameters::Converter
+      include Vatsense::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Vatsense::SandboxGenerateKeyParams, Vatsense::Internal::AnyHash)
+        end
+
+      sig do
+        params(request_options: Vatsense::RequestOptions::OrHash).returns(
+          T.attached_class
+        )
+      end
+      def self.new(request_options: {})
+      end
+
+      sig { override.returns({ request_options: Vatsense::RequestOptions }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/vatsense/models/sandbox_generate_key_response.rbi

@@ -0,0 +1,135 @@
+# typed: strong
+
+module Vatsense
+  module Models
+    class SandboxGenerateKeyResponse < Vatsense::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Vatsense::Models::SandboxGenerateKeyResponse,
+            Vatsense::Internal::AnyHash
+          )
+        end
+
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :code
+
+      sig { params(code: Integer).void }
+      attr_writer :code
+
+      sig do
+        returns(T.nilable(Vatsense::Models::SandboxGenerateKeyResponse::Data))
+      end
+      attr_reader :data
+
+      sig do
+        params(
+          data: Vatsense::Models::SandboxGenerateKeyResponse::Data::OrHash
+        ).void
+      end
+      attr_writer :data
+
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :success
+
+      sig { params(success: T::Boolean).void }
+      attr_writer :success
+
+      sig do
+        params(
+          code: Integer,
+          data: Vatsense::Models::SandboxGenerateKeyResponse::Data::OrHash,
+          success: T::Boolean
+        ).returns(T.attached_class)
+      end
+      def self.new(code: nil, data: nil, success: nil)
+      end
+
+      sig do
+        override.returns(
+          {
+            code: Integer,
+            data: Vatsense::Models::SandboxGenerateKeyResponse::Data,
+            success: T::Boolean
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Data < Vatsense::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Vatsense::Models::SandboxGenerateKeyResponse::Data,
+              Vatsense::Internal::AnyHash
+            )
+          end
+
+        sig { returns(T.nilable(T::Array[String])) }
+        attr_reader :allowed_endpoints
+
+        sig { params(allowed_endpoints: T::Array[String]).void }
+        attr_writer :allowed_endpoints
+
+        sig { returns(T.nilable(Time)) }
+        attr_reader :expires_at
+
+        sig { params(expires_at: Time).void }
+        attr_writer :expires_at
+
+        # The temporary sandbox API key.
+        sig { returns(T.nilable(String)) }
+        attr_reader :key
+
+        sig { params(key: String).void }
+        attr_writer :key
+
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :requests_remaining
+
+        sig { params(requests_remaining: Integer).void }
+        attr_writer :requests_remaining
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :signup_url
+
+        sig { params(signup_url: String).void }
+        attr_writer :signup_url
+
+        sig do
+          params(
+            allowed_endpoints: T::Array[String],
+            expires_at: Time,
+            key: String,
+            requests_remaining: Integer,
+            signup_url: String
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          allowed_endpoints: nil,
+          expires_at: nil,
+          # The temporary sandbox API key.
+          key: nil,
+          requests_remaining: nil,
+          signup_url: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              allowed_endpoints: T::Array[String],
+              expires_at: Time,
+              key: String,
+              requests_remaining: Integer,
+              signup_url: String
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/vatsense/models/tax_rate.rbi

@@ -0,0 +1,109 @@
+# typed: strong
+
+module Vatsense
+  module Models
+    class TaxRate < Vatsense::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias { T.any(Vatsense::TaxRate, Vatsense::Internal::AnyHash) }
+
+      # The rate class (e.g. "standard", "reduced", "zero").
+      sig { returns(T.nilable(String)) }
+      attr_reader :class_
+
+      sig { params(class_: String).void }
+      attr_writer :class_
+
+      # A description of what goods/services this rate applies to.
+      sig { returns(T.nilable(String)) }
+      attr_reader :description
+
+      sig { params(description: String).void }
+      attr_writer :description
+
+      sig { returns(T.nilable(Vatsense::TaxRate::Object::TaggedSymbol)) }
+      attr_reader :object
+
+      sig { params(object: Vatsense::TaxRate::Object::OrSymbol).void }
+      attr_writer :object
+
+      # The tax rate percentage.
+      sig { returns(T.nilable(Float)) }
+      attr_reader :rate
+
+      sig { params(rate: Float).void }
+      attr_writer :rate
+
+      # Comma-separated list of product types this rate applies to, or false if it
+      # applies generally.
+      sig { returns(T.nilable(Vatsense::TaxRate::Types::Variants)) }
+      attr_reader :types
+
+      sig { params(types: Vatsense::TaxRate::Types::Variants).void }
+      attr_writer :types
+
+      sig do
+        params(
+          class_: String,
+          description: String,
+          object: Vatsense::TaxRate::Object::OrSymbol,
+          rate: Float,
+          types: Vatsense::TaxRate::Types::Variants
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The rate class (e.g. "standard", "reduced", "zero").
+        class_: nil,
+        # A description of what goods/services this rate applies to.
+        description: nil,
+        object: nil,
+        # The tax rate percentage.
+        rate: nil,
+        # Comma-separated list of product types this rate applies to, or false if it
+        # applies generally.
+        types: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            class_: String,
+            description: String,
+            object: Vatsense::TaxRate::Object::TaggedSymbol,
+            rate: Float,
+            types: Vatsense::TaxRate::Types::Variants
+          }
+        )
+      end
+      def to_hash
+      end
+
+      module Object
+        extend Vatsense::Internal::Type::Enum
+
+        TaggedSymbol = T.type_alias { T.all(Symbol, Vatsense::TaxRate::Object) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        TAX_RATE = T.let(:tax_rate, Vatsense::TaxRate::Object::TaggedSymbol)
+
+        sig do
+          override.returns(T::Array[Vatsense::TaxRate::Object::TaggedSymbol])
+        end
+        def self.values
+        end
+      end
+
+      # Comma-separated list of product types this rate applies to, or false if it
+      # applies generally.
+      module Types
+        extend Vatsense::Internal::Type::Union
+
+        Variants = T.type_alias { T.any(String, T::Boolean) }
+
+        sig { override.returns(T::Array[Vatsense::TaxRate::Types::Variants]) }
+        def self.variants
+        end
+      end
+    end
+  end
+end

data/rbi/vatsense/models/usage_retrieve_params.rbi

@@ -0,0 +1,27 @@
+# typed: strong
+
+module Vatsense
+  module Models
+    class UsageRetrieveParams < Vatsense::Internal::Type::BaseModel
+      extend Vatsense::Internal::Type::RequestParameters::Converter
+      include Vatsense::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Vatsense::UsageRetrieveParams, Vatsense::Internal::AnyHash)
+        end
+
+      sig do
+        params(request_options: Vatsense::RequestOptions::OrHash).returns(
+          T.attached_class
+        )
+      end
+      def self.new(request_options: {})
+      end
+
+      sig { override.returns({ request_options: Vatsense::RequestOptions }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/vatsense/models/usage_retrieve_response.rbi

@@ -0,0 +1,155 @@
+# typed: strong
+
+module Vatsense
+  module Models
+    class UsageRetrieveResponse < Vatsense::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Vatsense::Models::UsageRetrieveResponse,
+            Vatsense::Internal::AnyHash
+          )
+        end
+
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :code
+
+      sig { params(code: Integer).void }
+      attr_writer :code
+
+      sig { returns(T.nilable(Vatsense::Models::UsageRetrieveResponse::Data)) }
+      attr_reader :data
+
+      sig do
+        params(data: Vatsense::Models::UsageRetrieveResponse::Data::OrHash).void
+      end
+      attr_writer :data
+
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :success
+
+      sig { params(success: T::Boolean).void }
+      attr_writer :success
+
+      sig do
+        params(
+          code: Integer,
+          data: Vatsense::Models::UsageRetrieveResponse::Data::OrHash,
+          success: T::Boolean
+        ).returns(T.attached_class)
+      end
+      def self.new(code: nil, data: nil, success: nil)
+      end
+
+      sig do
+        override.returns(
+          {
+            code: Integer,
+            data: Vatsense::Models::UsageRetrieveResponse::Data,
+            success: T::Boolean
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Data < Vatsense::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Vatsense::Models::UsageRetrieveResponse::Data,
+              Vatsense::Internal::AnyHash
+            )
+          end
+
+        sig do
+          returns(
+            T.nilable(Vatsense::Models::UsageRetrieveResponse::Data::Requests)
+          )
+        end
+        attr_reader :requests
+
+        sig do
+          params(
+            requests:
+              Vatsense::Models::UsageRetrieveResponse::Data::Requests::OrHash
+          ).void
+        end
+        attr_writer :requests
+
+        sig do
+          params(
+            requests:
+              Vatsense::Models::UsageRetrieveResponse::Data::Requests::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(requests: nil)
+        end
+
+        sig do
+          override.returns(
+            {
+              requests: Vatsense::Models::UsageRetrieveResponse::Data::Requests
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Requests < Vatsense::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Vatsense::Models::UsageRetrieveResponse::Data::Requests,
+                Vatsense::Internal::AnyHash
+              )
+            end
+
+          # Requests remaining before the limit is reached.
+          sig { returns(T.nilable(Integer)) }
+          attr_reader :remaining
+
+          sig { params(remaining: Integer).void }
+          attr_writer :remaining
+
+          # Total requests allowed on your plan.
+          sig { returns(T.nilable(Integer)) }
+          attr_reader :total
+
+          sig { params(total: Integer).void }
+          attr_writer :total
+
+          # Requests used in the last 30 days.
+          sig { returns(T.nilable(Integer)) }
+          attr_reader :used
+
+          sig { params(used: Integer).void }
+          attr_writer :used
+
+          sig do
+            params(remaining: Integer, total: Integer, used: Integer).returns(
+              T.attached_class
+            )
+          end
+          def self.new(
+            # Requests remaining before the limit is reached.
+            remaining: nil,
+            # Total requests allowed on your plan.
+            total: nil,
+            # Requests used in the last 30 days.
+            used: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              { remaining: Integer, total: Integer, used: Integer }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/vatsense/models/validate_check_params.rbi

@@ -0,0 +1,82 @@
+# typed: strong
+
+module Vatsense
+  module Models
+    class ValidateCheckParams < Vatsense::Internal::Type::BaseModel
+      extend Vatsense::Internal::Type::RequestParameters::Converter
+      include Vatsense::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Vatsense::ValidateCheckParams, Vatsense::Internal::AnyHash)
+        end
+
+      # The EORI number to validate. Must include the leading 2-character country code
+      # (e.g. "GB123456789123"). UK and EU only.
+      sig { returns(T.nilable(String)) }
+      attr_reader :eori_number
+
+      sig { params(eori_number: String).void }
+      attr_writer :eori_number
+
+      # Your own VAT number. If supplied, the response will include a unique
+      # consultation number issued by the relevant authority (VIES or HMRC). Must
+      # include the leading 2-character country code.
+      #
+      # Note: GB requester numbers only work for GB validations; EU requester numbers
+      # only work for EU validations. Cross-region is not supported.
+      sig { returns(T.nilable(String)) }
+      attr_reader :requester_vat_number
+
+      sig { params(requester_vat_number: String).void }
+      attr_writer :requester_vat_number
+
+      # The VAT number to validate. Must include the leading 2-character country code
+      # (e.g. "GB288305674", "FR12345678901").
+      sig { returns(T.nilable(String)) }
+      attr_reader :vat_number
+
+      sig { params(vat_number: String).void }
+      attr_writer :vat_number
+
+      sig do
+        params(
+          eori_number: String,
+          requester_vat_number: String,
+          vat_number: String,
+          request_options: Vatsense::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The EORI number to validate. Must include the leading 2-character country code
+        # (e.g. "GB123456789123"). UK and EU only.
+        eori_number: nil,
+        # Your own VAT number. If supplied, the response will include a unique
+        # consultation number issued by the relevant authority (VIES or HMRC). Must
+        # include the leading 2-character country code.
+        #
+        # Note: GB requester numbers only work for GB validations; EU requester numbers
+        # only work for EU validations. Cross-region is not supported.
+        requester_vat_number: nil,
+        # The VAT number to validate. Must include the leading 2-character country code
+        # (e.g. "GB288305674", "FR12345678901").
+        vat_number: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            eori_number: String,
+            requester_vat_number: String,
+            vat_number: String,
+            request_options: Vatsense::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end