e-invoice-api 0.1.0.pre.alpha.5

data/rbi/e_invoice_api/models/validate_validate_peppol_id_response.rbi

@@ -0,0 +1,141 @@
+# typed: strong
+
+module EInvoiceAPI
+  module Models
+    class ValidateValidatePeppolIDResponse < EInvoiceAPI::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            EInvoiceAPI::Models::ValidateValidatePeppolIDResponse,
+            EInvoiceAPI::Internal::AnyHash
+          )
+        end
+
+      # Business card information for the Peppol ID
+      sig do
+        returns(
+          T.nilable(
+            EInvoiceAPI::Models::ValidateValidatePeppolIDResponse::BusinessCard
+          )
+        )
+      end
+      attr_reader :business_card
+
+      sig do
+        params(
+          business_card:
+            T.nilable(
+              EInvoiceAPI::Models::ValidateValidatePeppolIDResponse::BusinessCard::OrHash
+            )
+        ).void
+      end
+      attr_writer :business_card
+
+      # Whether a business card is set at the SMP
+      sig { returns(T::Boolean) }
+      attr_accessor :business_card_valid
+
+      # Whether the DNS resolves to a valid SMP
+      sig { returns(T::Boolean) }
+      attr_accessor :dns_valid
+
+      # Whether the Peppol ID is valid and registered in the Peppol network
+      sig { returns(T::Boolean) }
+      attr_accessor :is_valid
+
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_reader :supported_document_types
+
+      sig { params(supported_document_types: T::Array[String]).void }
+      attr_writer :supported_document_types
+
+      # Response for a Peppol ID validation request.
+      #
+      # This model represents the validation result of a Peppol ID in the Peppol
+      # network, including whether the ID is valid and what document types it supports.
+      sig do
+        params(
+          business_card:
+            T.nilable(
+              EInvoiceAPI::Models::ValidateValidatePeppolIDResponse::BusinessCard::OrHash
+            ),
+          business_card_valid: T::Boolean,
+          dns_valid: T::Boolean,
+          is_valid: T::Boolean,
+          supported_document_types: T::Array[String]
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Business card information for the Peppol ID
+        business_card:,
+        # Whether a business card is set at the SMP
+        business_card_valid:,
+        # Whether the DNS resolves to a valid SMP
+        dns_valid:,
+        # Whether the Peppol ID is valid and registered in the Peppol network
+        is_valid:,
+        supported_document_types: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            business_card:
+              T.nilable(
+                EInvoiceAPI::Models::ValidateValidatePeppolIDResponse::BusinessCard
+              ),
+            business_card_valid: T::Boolean,
+            dns_valid: T::Boolean,
+            is_valid: T::Boolean,
+            supported_document_types: T::Array[String]
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class BusinessCard < EInvoiceAPI::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              EInvoiceAPI::Models::ValidateValidatePeppolIDResponse::BusinessCard,
+              EInvoiceAPI::Internal::AnyHash
+            )
+          end
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :country_code
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :name
+
+        sig { returns(T.nilable(Date)) }
+        attr_accessor :registration_date
+
+        # Business card information for the Peppol ID
+        sig do
+          params(
+            country_code: T.nilable(String),
+            name: T.nilable(String),
+            registration_date: T.nilable(Date)
+          ).returns(T.attached_class)
+        end
+        def self.new(country_code: nil, name: nil, registration_date: nil)
+        end
+
+        sig do
+          override.returns(
+            {
+              country_code: T.nilable(String),
+              name: T.nilable(String),
+              registration_date: T.nilable(Date)
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/e_invoice_api/models/validate_validate_ubl_params.rbi

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

data/rbi/e_invoice_api/models/webhook_create_params.rbi

@@ -0,0 +1,54 @@
+# typed: strong
+
+module EInvoiceAPI
+  module Models
+    class WebhookCreateParams < EInvoiceAPI::Internal::Type::BaseModel
+      extend EInvoiceAPI::Internal::Type::RequestParameters::Converter
+      include EInvoiceAPI::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            EInvoiceAPI::WebhookCreateParams,
+            EInvoiceAPI::Internal::AnyHash
+          )
+        end
+
+      sig { returns(T::Array[String]) }
+      attr_accessor :events
+
+      sig { returns(String) }
+      attr_accessor :url
+
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :enabled
+
+      sig { params(enabled: T::Boolean).void }
+      attr_writer :enabled
+
+      sig do
+        params(
+          events: T::Array[String],
+          url: String,
+          enabled: T::Boolean,
+          request_options: EInvoiceAPI::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(events:, url:, enabled: nil, request_options: {})
+      end
+
+      sig do
+        override.returns(
+          {
+            events: T::Array[String],
+            url: String,
+            enabled: T::Boolean,
+            request_options: EInvoiceAPI::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/e_invoice_api/models/webhook_delete_params.rbi

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

data/rbi/e_invoice_api/models/webhook_delete_response.rbi

@@ -0,0 +1,27 @@
+# typed: strong
+
+module EInvoiceAPI
+  module Models
+    class WebhookDeleteResponse < EInvoiceAPI::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            EInvoiceAPI::Models::WebhookDeleteResponse,
+            EInvoiceAPI::Internal::AnyHash
+          )
+        end
+
+      sig { returns(T::Boolean) }
+      attr_accessor :is_deleted
+
+      # Model for webhook deletion.
+      sig { params(is_deleted: T::Boolean).returns(T.attached_class) }
+      def self.new(is_deleted:)
+      end
+
+      sig { override.returns({ is_deleted: T::Boolean }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/e_invoice_api/models/webhook_list_params.rbi

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

data/rbi/e_invoice_api/models/webhook_list_response.rbi

@@ -0,0 +1,11 @@
+# typed: strong
+
+module EInvoiceAPI
+  module Models
+    WebhookListResponse =
+      T.let(
+        EInvoiceAPI::Internal::Type::ArrayOf[EInvoiceAPI::WebhookResponse],
+        EInvoiceAPI::Internal::Type::Converter
+      )
+  end
+end

data/rbi/e_invoice_api/models/webhook_response.rbi

@@ -0,0 +1,57 @@
+# typed: strong
+
+module EInvoiceAPI
+  module Models
+    class WebhookResponse < EInvoiceAPI::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(EInvoiceAPI::WebhookResponse, EInvoiceAPI::Internal::AnyHash)
+        end
+
+      sig { returns(String) }
+      attr_accessor :id
+
+      sig { returns(T::Array[String]) }
+      attr_accessor :events
+
+      sig { returns(String) }
+      attr_accessor :secret
+
+      sig { returns(String) }
+      attr_accessor :url
+
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :enabled
+
+      sig { params(enabled: T::Boolean).void }
+      attr_writer :enabled
+
+      # Response model for webhook API endpoints.
+      sig do
+        params(
+          id: String,
+          events: T::Array[String],
+          secret: String,
+          url: String,
+          enabled: T::Boolean
+        ).returns(T.attached_class)
+      end
+      def self.new(id:, events:, secret:, url:, enabled: nil)
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            events: T::Array[String],
+            secret: String,
+            url: String,
+            enabled: T::Boolean
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/e_invoice_api/models/webhook_retrieve_params.rbi

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

data/rbi/e_invoice_api/models/webhook_update_params.rbi

@@ -0,0 +1,51 @@
+# typed: strong
+
+module EInvoiceAPI
+  module Models
+    class WebhookUpdateParams < EInvoiceAPI::Internal::Type::BaseModel
+      extend EInvoiceAPI::Internal::Type::RequestParameters::Converter
+      include EInvoiceAPI::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            EInvoiceAPI::WebhookUpdateParams,
+            EInvoiceAPI::Internal::AnyHash
+          )
+        end
+
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_accessor :enabled
+
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_accessor :events
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :url
+
+      sig do
+        params(
+          enabled: T.nilable(T::Boolean),
+          events: T.nilable(T::Array[String]),
+          url: T.nilable(String),
+          request_options: EInvoiceAPI::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(enabled: nil, events: nil, url: nil, request_options: {})
+      end
+
+      sig do
+        override.returns(
+          {
+            enabled: T.nilable(T::Boolean),
+            events: T.nilable(T::Array[String]),
+            url: T.nilable(String),
+            request_options: EInvoiceAPI::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/e_invoice_api/models.rbi

@@ -0,0 +1,70 @@
+# typed: strong
+
+module EInvoiceAPI
+  Certificate = EInvoiceAPI::Models::Certificate
+
+  CurrencyCode = EInvoiceAPI::Models::CurrencyCode
+
+  DocumentAttachmentCreate = EInvoiceAPI::Models::DocumentAttachmentCreate
+
+  DocumentCreate = EInvoiceAPI::Models::DocumentCreate
+
+  DocumentCreateParams = EInvoiceAPI::Models::DocumentCreateParams
+
+  DocumentDeleteParams = EInvoiceAPI::Models::DocumentDeleteParams
+
+  DocumentDirection = EInvoiceAPI::Models::DocumentDirection
+
+  DocumentResponse = EInvoiceAPI::Models::DocumentResponse
+
+  DocumentRetrieveParams = EInvoiceAPI::Models::DocumentRetrieveParams
+
+  Documents = EInvoiceAPI::Models::Documents
+
+  DocumentSendParams = EInvoiceAPI::Models::DocumentSendParams
+
+  DocumentState = EInvoiceAPI::Models::DocumentState
+
+  DocumentType = EInvoiceAPI::Models::DocumentType
+
+  InboxListCreditNotesParams = EInvoiceAPI::Models::InboxListCreditNotesParams
+
+  InboxListInvoicesParams = EInvoiceAPI::Models::InboxListInvoicesParams
+
+  InboxListParams = EInvoiceAPI::Models::InboxListParams
+
+  LookupRetrieveParams = EInvoiceAPI::Models::LookupRetrieveParams
+
+  OutboxListDraftDocumentsParams =
+    EInvoiceAPI::Models::OutboxListDraftDocumentsParams
+
+  OutboxListReceivedDocumentsParams =
+    EInvoiceAPI::Models::OutboxListReceivedDocumentsParams
+
+  PaginatedDocumentResponse = EInvoiceAPI::Models::PaginatedDocumentResponse
+
+  PaymentDetailCreate = EInvoiceAPI::Models::PaymentDetailCreate
+
+  UblDocumentValidation = EInvoiceAPI::Models::UblDocumentValidation
+
+  UnitOfMeasureCode = EInvoiceAPI::Models::UnitOfMeasureCode
+
+  ValidateValidateJsonParams = EInvoiceAPI::Models::ValidateValidateJsonParams
+
+  ValidateValidatePeppolIDParams =
+    EInvoiceAPI::Models::ValidateValidatePeppolIDParams
+
+  ValidateValidateUblParams = EInvoiceAPI::Models::ValidateValidateUblParams
+
+  WebhookCreateParams = EInvoiceAPI::Models::WebhookCreateParams
+
+  WebhookDeleteParams = EInvoiceAPI::Models::WebhookDeleteParams
+
+  WebhookListParams = EInvoiceAPI::Models::WebhookListParams
+
+  WebhookResponse = EInvoiceAPI::Models::WebhookResponse
+
+  WebhookRetrieveParams = EInvoiceAPI::Models::WebhookRetrieveParams
+
+  WebhookUpdateParams = EInvoiceAPI::Models::WebhookUpdateParams
+end

data/rbi/e_invoice_api/request_options.rbi

@@ -0,0 +1,59 @@
+# typed: strong
+
+module EInvoiceAPI
+  # Specify HTTP behaviour to use for a specific request. These options supplement
+  # or override those provided at the client level.
+  #
+  # When making a request, you can pass an actual {RequestOptions} instance, or
+  # simply pass a Hash with symbol keys matching the attributes on this class.
+  class RequestOptions < EInvoiceAPI::Internal::Type::BaseModel
+    OrHash =
+      T.type_alias do
+        T.any(EInvoiceAPI::RequestOptions, EInvoiceAPI::Internal::AnyHash)
+      end
+
+    # @api private
+    sig { params(opts: EInvoiceAPI::RequestOptions::OrHash).void }
+    def self.validate!(opts)
+    end
+
+    # Idempotency key to send with request and all associated retries. Will only be
+    # sent for write requests.
+    sig { returns(T.nilable(String)) }
+    attr_accessor :idempotency_key
+
+    # Extra query params to send with the request. These are `.merge`’d into any
+    # `query` given at the client level.
+    sig do
+      returns(
+        T.nilable(T::Hash[String, T.nilable(T.any(T::Array[String], String))])
+      )
+    end
+    attr_accessor :extra_query
+
+    # Extra headers to send with the request. These are `.merged`’d into any
+    # `extra_headers` given at the client level.
+    sig { returns(T.nilable(T::Hash[String, T.nilable(String)])) }
+    attr_accessor :extra_headers
+
+    # Extra data to send with the request. These are deep merged into any data
+    # generated as part of the normal request.
+    sig { returns(T.nilable(T.anything)) }
+    attr_accessor :extra_body
+
+    # Maximum number of retries to attempt after a failed initial request.
+    sig { returns(T.nilable(Integer)) }
+    attr_accessor :max_retries
+
+    # Request timeout in seconds.
+    sig { returns(T.nilable(Float)) }
+    attr_accessor :timeout
+
+    # Returns a new instance of RequestOptions.
+    sig do
+      params(values: EInvoiceAPI::Internal::AnyHash).returns(T.attached_class)
+    end
+    def self.new(values = {})
+    end
+  end
+end

data/rbi/e_invoice_api/resources/documents/attachments.rbi

@@ -0,0 +1,58 @@
+# typed: strong
+
+module EInvoiceAPI
+  module Resources
+    class Documents
+      class Attachments
+        # Get attachment details with for an invoice or credit note with link to download
+        # file (signed URL, valid for 1 hour)
+        sig do
+          params(
+            attachment_id: String,
+            document_id: String,
+            request_options: EInvoiceAPI::RequestOptions::OrHash
+          ).returns(EInvoiceAPI::Documents::DocumentAttachment)
+        end
+        def retrieve(attachment_id, document_id:, request_options: {})
+        end
+
+        # Get all attachments for an invoice or credit note
+        sig do
+          params(
+            document_id: String,
+            request_options: EInvoiceAPI::RequestOptions::OrHash
+          ).returns(T::Array[EInvoiceAPI::Documents::DocumentAttachment])
+        end
+        def list(document_id, request_options: {})
+        end
+
+        # Delete an attachment from an invoice or credit note
+        sig do
+          params(
+            attachment_id: String,
+            document_id: String,
+            request_options: EInvoiceAPI::RequestOptions::OrHash
+          ).returns(EInvoiceAPI::Models::Documents::AttachmentDeleteResponse)
+        end
+        def delete(attachment_id, document_id:, request_options: {})
+        end
+
+        # Add a new attachment to an invoice or credit note
+        sig do
+          params(
+            document_id: String,
+            file: EInvoiceAPI::Internal::FileInput,
+            request_options: EInvoiceAPI::RequestOptions::OrHash
+          ).returns(EInvoiceAPI::Documents::DocumentAttachment)
+        end
+        def add(document_id, file:, request_options: {})
+        end
+
+        # @api private
+        sig { params(client: EInvoiceAPI::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end

data/rbi/e_invoice_api/resources/documents/ubl.rbi

@@ -0,0 +1,24 @@
+# typed: strong
+
+module EInvoiceAPI
+  module Resources
+    class Documents
+      class Ubl
+        # Get the UBL for an invoice or credit note
+        sig do
+          params(
+            document_id: String,
+            request_options: EInvoiceAPI::RequestOptions::OrHash
+          ).returns(EInvoiceAPI::Models::Documents::UblGetResponse)
+        end
+        def get(document_id, request_options: {})
+        end
+
+        # @api private
+        sig { params(client: EInvoiceAPI::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end