invoist 1.0.0

data/lib/invoist/models.rb

@@ -0,0 +1,1598 @@
+# frozen_string_literal: true
+
+# Code generated by script/generate.rb from openapi.yaml. DO NOT EDIT.
+# Regenerate with `rake generate`.
+
+module Invoist
+  # The API's response types, generated from its OpenAPI description.
+  #
+  # Every model is an immutable `Data` object with a reader per field, named
+  # as the API sends it. Fields the API omits are `nil`; fields this version
+  # does not know are ignored. Money is always an Integer of minor units.
+  module Models
+    # The values of DocumentStatus.
+    module DocumentStatus
+      # `pending`
+      PENDING = "pending"
+      # `processing`
+      PROCESSING = "processing"
+      # `done`
+      DONE = "done"
+      # `failed`
+      FAILED = "failed"
+      # Every value, in the order the API documents them.
+      ALL = [PENDING, PROCESSING, DONE, FAILED].freeze
+    end
+
+    # How the document arrived.
+    module DocumentSource
+      # `api`
+      API = "api"
+      # `dashboard`
+      DASHBOARD = "dashboard"
+      # `email`
+      EMAIL = "email"
+      # `storage`
+      STORAGE = "storage"
+      # `sandbox`
+      SANDBOX = "sandbox"
+      # Every value, in the order the API documents them.
+      ALL = [API, DASHBOARD, EMAIL, STORAGE, SANDBOX].freeze
+    end
+
+    # The values of ExtractionStatus.
+    module ExtractionStatus
+      # `pending`
+      PENDING = "pending"
+      # `done`
+      DONE = "done"
+      # `failed`
+      FAILED = "failed"
+      # Every value, in the order the API documents them.
+      ALL = [PENDING, DONE, FAILED].freeze
+    end
+
+    # The values of ReviewStatus.
+    module ReviewStatus
+      # `pending`
+      PENDING = "pending"
+      # `resolved`
+      RESOLVED = "resolved"
+      # `dismissed`
+      DISMISSED = "dismissed"
+      # Every value, in the order the API documents them.
+      ALL = [PENDING, RESOLVED, DISMISSED].freeze
+    end
+
+    # Why the item was flagged.
+    module ReviewReason
+      # `low_confidence`
+      LOW_CONFIDENCE = "low_confidence"
+      # `total_mismatch`
+      TOTAL_MISMATCH = "total_mismatch"
+      # `poor_quality`
+      POOR_QUALITY = "poor_quality"
+      # `duplicate`
+      DUPLICATE = "duplicate"
+      # `unusual_vendor`
+      UNUSUAL_VENDOR = "unusual_vendor"
+      # `bank_details_changed`
+      BANK_DETAILS_CHANGED = "bank_details_changed"
+      # `amount_anomaly`
+      AMOUNT_ANOMALY = "amount_anomaly"
+      # `amount_over_limit`
+      AMOUNT_OVER_LIMIT = "amount_over_limit"
+      # `missing_po_number`
+      MISSING_PO_NUMBER = "missing_po_number"
+      # Every value, in the order the API documents them.
+      ALL = [
+        LOW_CONFIDENCE,
+        TOTAL_MISMATCH,
+        POOR_QUALITY,
+        DUPLICATE,
+        UNUSUAL_VENDOR,
+        BANK_DETAILS_CHANGED,
+        AMOUNT_ANOMALY,
+        AMOUNT_OVER_LIMIT,
+        MISSING_PO_NUMBER
+      ].freeze
+    end
+
+    # What a document is. Null is an ordinary invoice.
+    module BillKind
+      # `invoice`
+      INVOICE = "invoice"
+      # `reminder`
+      REMINDER = "reminder"
+      # `debt_collection`
+      DEBT_COLLECTION = "debt_collection"
+      # `credit_note`
+      CREDIT_NOTE = "credit_note"
+      # `receipt`
+      RECEIPT = "receipt"
+      # `payment_confirmation`
+      PAYMENT_CONFIRMATION = "payment_confirmation"
+      # Every value, in the order the API documents them.
+      ALL = [INVOICE, REMINDER, DEBT_COLLECTION, CREDIT_NOTE, RECEIPT, PAYMENT_CONFIRMATION].freeze
+    end
+
+    # A `ErrorDetail`, as the API returns it.
+    #
+    # @!attribute [r] code
+    #   @return [String] A stable machine-readable identifier. Branch on
+    #     this, not the message.
+    # @!attribute [r] message
+    #   @return [String] Human-readable explanation. Wording may change; do
+    #     not parse it.
+    ErrorDetail = Data.define(
+      :code,
+      :message
+    ) do
+      include Model
+    end
+
+    # One file's outcome from POST /v1/extract/batch. A rejected file carries
+    # `error` and omits the document fields; an accepted one carries the
+    # document fields and omits `error`.
+    #
+    # @!attribute [r] filename
+    #   @return [String]
+    # @!attribute [r] document_id
+    #   @return [String, nil]
+    # @!attribute [r] extraction_id
+    #   @return [String, nil]
+    # @!attribute [r] status
+    #   @return [String, nil]
+    # @!attribute [r] duplicate
+    #   @return [Boolean, nil] True when this file's bytes were already
+    #     extracted in this workspace.
+    # @!attribute [r] error
+    #   @return [ErrorDetail, nil] Present only when this file was rejected.
+    BatchResultItem = Data.define(
+      :filename,
+      :document_id,
+      :extraction_id,
+      :status,
+      :duplicate,
+      :error
+    ) do
+      include Model
+
+      # @api private
+      def self.nested_types
+        {
+          error: ErrorDetail
+        }
+      end
+    end
+
+    # A `Document`, as the API returns it.
+    #
+    # @!attribute [r] id
+    #   @return [String]
+    # @!attribute [r] source
+    #   @return [String]
+    # @!attribute [r] original_filename
+    #   @return [String]
+    # @!attribute [r] content_type
+    #   @return [String]
+    # @!attribute [r] byte_size
+    #   @return [Integer]
+    # @!attribute [r] status
+    #   @return [String]
+    # @!attribute [r] approval
+    #   @return [DocumentApproval, nil]
+    # @!attribute [r] created_at
+    #   @return [String]
+    # @!attribute [r] updated_at
+    #   @return [String]
+    Document = Data.define(
+      :id,
+      :source,
+      :original_filename,
+      :content_type,
+      :byte_size,
+      :status,
+      :approval,
+      :created_at,
+      :updated_at
+    ) do
+      include Model
+
+      # @api private
+      def self.nested_types
+        {
+          approval: DocumentApproval
+        }
+      end
+    end
+
+    # Sign-off state. Separate from `status`, which tracks extraction: this is
+    # a person's judgement, that is the machine's progress. Always "draft"
+    # unless the workspace has an approval mode switched on.
+    #
+    # @!attribute [r] state
+    #   @return [String] One of `draft`, `ready`, `approved`,
+    #     `changes_requested`.
+    # @!attribute [r] submitted_by
+    #   @return [String, nil]
+    # @!attribute [r] submitted_by_name
+    #   @return [String, nil] Captured at the time, so it survives the
+    #     person leaving.
+    # @!attribute [r] submitted_at
+    #   @return [String, nil]
+    # @!attribute [r] approved_by
+    #   @return [String, nil]
+    # @!attribute [r] approved_by_name
+    #   @return [String, nil]
+    # @!attribute [r] approved_at
+    #   @return [String, nil]
+    DocumentApproval = Data.define(
+      :state,
+      :submitted_by,
+      :submitted_by_name,
+      :submitted_at,
+      :approved_by,
+      :approved_by_name,
+      :approved_at
+    ) do
+      include Model
+    end
+
+    # A document plus a flat summary of its latest extraction.
+    #
+    # @!attribute [r] id
+    #   @return [String]
+    # @!attribute [r] source
+    #   @return [String]
+    # @!attribute [r] original_filename
+    #   @return [String]
+    # @!attribute [r] content_type
+    #   @return [String]
+    # @!attribute [r] byte_size
+    #   @return [Integer]
+    # @!attribute [r] status
+    #   @return [String]
+    # @!attribute [r] vendor_name
+    #   @return [String, nil]
+    # @!attribute [r] invoice_number
+    #   @return [String, nil]
+    # @!attribute [r] reference_number
+    #   @return [String, nil]
+    # @!attribute [r] total_cents
+    #   @return [Integer, nil]
+    # @!attribute [r] base_currency
+    #   @return [String, nil] The workspace's reporting currency, when one
+    #     is configured. Null when conversion is off, or when this invoice's
+    #     currency had no published rate for its date. The invoice's own
+    #     currency and total_cents remain authoritative.
+    # @!attribute [r] base_total_cents
+    #   @return [Integer, nil] total_cents converted into base_currency, for
+    #     reporting only.
+    # @!attribute [r] fx_rate
+    #   @return [String, nil] Reporting-currency units per one unit of the
+    #     invoice currency, as a decimal string so the exact stored value
+    #     round-trips.
+    # @!attribute [r] fx_rate_date
+    #   @return [String, nil] The date of the published rates used, which is
+    #     the invoice date or the most recent publication before it.
+    # @!attribute [r] fx_source
+    #   @return [String, nil] Who published the rate, e.g. "ecb".
+    # @!attribute [r] currency
+    #   @return [String, nil]
+    # @!attribute [r] category_id
+    #   @return [String, nil]
+    # @!attribute [r] category_name
+    #   @return [String, nil]
+    # @!attribute [r] pending_review
+    #   @return [Integer] Count of unresolved review items.
+    # @!attribute [r] flagged
+    #   @return [Boolean] True when pending_review is above zero.
+    # @!attribute [r] created_at
+    #   @return [String]
+    # @!attribute [r] updated_at
+    #   @return [String]
+    DocumentListItem = Data.define(
+      :id,
+      :source,
+      :original_filename,
+      :content_type,
+      :byte_size,
+      :status,
+      :vendor_name,
+      :invoice_number,
+      :reference_number,
+      :total_cents,
+      :base_currency,
+      :base_total_cents,
+      :fx_rate,
+      :fx_rate_date,
+      :fx_source,
+      :currency,
+      :category_id,
+      :category_name,
+      :pending_review,
+      :flagged,
+      :created_at,
+      :updated_at
+    ) do
+      include Model
+    end
+
+    # A `Extraction`, as the API returns it.
+    #
+    # @!attribute [r] id
+    #   @return [String]
+    # @!attribute [r] document_id
+    #   @return [String]
+    # @!attribute [r] engine
+    #   @return [String]
+    # @!attribute [r] status
+    #   @return [String]
+    # @!attribute [r] document_kind
+    #   @return [String, nil] What the document is. Null when the reader
+    #     could not tell, and on documents read before this field existed;
+    #     treat null as an ordinary invoice. One of `invoice`, `reminder`,
+    #     `debt_collection`, `credit_note`, `receipt`, `payment_confirmation`.
+    # @!attribute [r] invoice_number
+    #   @return [String, nil]
+    # @!attribute [r] invoice_date
+    #   @return [String, nil] Absent when not printed on the document.
+    # @!attribute [r] due_date
+    #   @return [String, nil] Absent when not printed on the document.
+    # @!attribute [r] po_number
+    #   @return [String, nil]
+    # @!attribute [r] reference_number
+    #   @return [String, nil] The payment or bank reference, distinct from
+    #     the invoice number.
+    # @!attribute [r] vendor_name
+    #   @return [String, nil]
+    # @!attribute [r] vendor_address
+    #   @return [String, nil]
+    # @!attribute [r] customer_name
+    #   @return [String, nil]
+    # @!attribute [r] currency
+    #   @return [String, nil] ISO 4217 code, e.g. EUR.
+    # @!attribute [r] subtotal_cents
+    #   @return [Integer, nil]
+    # @!attribute [r] tax_cents
+    #   @return [Integer, nil]
+    # @!attribute [r] total_cents
+    #   @return [Integer, nil]
+    # @!attribute [r] base_currency
+    #   @return [String, nil] The workspace's reporting currency, when one
+    #     is configured. Null when conversion is off, or when this invoice's
+    #     currency had no published rate for its date.
+    # @!attribute [r] base_total_cents
+    #   @return [Integer, nil] total_cents converted into base_currency, for
+    #     reporting only.
+    # @!attribute [r] fx_rate
+    #   @return [String, nil] Reporting-currency units per one unit of the
+    #     invoice currency, as a decimal string.
+    # @!attribute [r] fx_rate_date
+    #   @return [String, nil] The date of the published rates used.
+    # @!attribute [r] fx_source
+    #   @return [String, nil] Who published the rate, e.g. "ecb".
+    # @!attribute [r] confidence
+    #   @return [Hash{String => Object}, nil] Per-field confidence between 0
+    #     and 1, keyed by field name.
+    # @!attribute [r] line_items
+    #   @return [Array<LineItem>, nil]
+    # @!attribute [r] details
+    #   @return [Hash{String => Object}, nil] Optional commercial extras
+    #     (payment terms, tax IDs, IBAN, shipping). On a reminder, collection
+    #     letter or credit note it also carries original_invoice_number,
+    #     original_invoice_date, original_creditor, original_amount_cents,
+    #     fees_cents and interest_cents: the earlier invoice it is about and
+    #     what was added.
+    # @!attribute [r] fraud_indicators
+    #   @return [Array<FraudIndicator>, nil] Heuristic observations worth a
+    #     second look. Never a determination that a document is fraudulent.
+    # @!attribute [r] file_metadata
+    #   @return [Hash{String => Object}, nil] Facts read from the file's own
+    #     EXIF or PDF metadata, never inferred.
+    # @!attribute [r] custom
+    #   @return [Array<CustomValue>, nil] Workspace-declared custom fields,
+    #     filled during extraction.
+    # @!attribute [r] discoveries
+    #   @return [Array<Discovery>, nil] Coordinate-pinned findings on the
+    #     first page image.
+    # @!attribute [r] quality
+    #   @return [Quality, nil]
+    # @!attribute [r] category_id
+    #   @return [String, nil]
+    # @!attribute [r] category_source
+    #   @return [String, nil] Who chose the category. One of `model`,
+    #     `user`, `memory`.
+    # @!attribute [r] auto_approved
+    #   @return [Boolean, nil] True when this skipped the review queue
+    #     because the vendor had a clean track record.
+    # @!attribute [r] error_message
+    #   @return [String, nil]
+    # @!attribute [r] created_at
+    #   @return [String]
+    # @!attribute [r] updated_at
+    #   @return [String]
+    # @!attribute [r] edited_at
+    #   @return [String, nil] When a person last corrected these fields by
+    #     hand. Absent if the extraction has never been edited, so its
+    #     presence is how you tell a human-reviewed record from a purely
+    #     automatic one.
+    Extraction = Data.define(
+      :id,
+      :document_id,
+      :engine,
+      :status,
+      :document_kind,
+      :invoice_number,
+      :invoice_date,
+      :due_date,
+      :po_number,
+      :reference_number,
+      :vendor_name,
+      :vendor_address,
+      :customer_name,
+      :currency,
+      :subtotal_cents,
+      :tax_cents,
+      :total_cents,
+      :base_currency,
+      :base_total_cents,
+      :fx_rate,
+      :fx_rate_date,
+      :fx_source,
+      :confidence,
+      :line_items,
+      :details,
+      :fraud_indicators,
+      :file_metadata,
+      :custom,
+      :discoveries,
+      :quality,
+      :category_id,
+      :category_source,
+      :auto_approved,
+      :error_message,
+      :created_at,
+      :updated_at,
+      :edited_at
+    ) do
+      include Model
+
+      # @api private
+      def self.nested_types
+        {
+          line_items: [LineItem],
+          fraud_indicators: [FraudIndicator],
+          custom: [CustomValue],
+          discoveries: [Discovery],
+          quality: Quality
+        }
+      end
+    end
+
+    # Progress of the background run that produces an extraction. Reading a
+    # document is queued work, so this reports how that work is going: whether
+    # it is waiting, running, finished, or has given up.
+    #
+    # @!attribute [r] status
+    #   @return [String] `queued` is waiting for a worker, which includes
+    #     waiting out the backoff between attempts. `failed` means every
+    #     attempt was used or the failure was one that retrying cannot fix.
+    #     One of `queued`, `running`, `succeeded`, `failed`.
+    # @!attribute [r] attempt_count
+    #   @return [Integer] Attempts made so far, including the one currently
+    #     running.
+    # @!attribute [r] max_attempts
+    #   @return [Integer] Attempts allowed before the run is abandoned.
+    #     Deliberately small, since every attempt is a real extraction.
+    # @!attribute [r] retryable
+    #   @return [Boolean] True when the run has stopped and can be started
+    #     again. Retrying is a fresh run and is billed as one.
+    # @!attribute [r] next_attempt_at
+    #   @return [String, nil] When the next attempt is due. Present only
+    #     while a retry is genuinely still coming, so its absence on a queued
+    #     job means the job has not started yet rather than that it is
+    #     stalled.
+    ExtractionJob = Data.define(
+      :status,
+      :attempt_count,
+      :max_attempts,
+      :retryable,
+      :next_attempt_at
+    ) do
+      include Model
+    end
+
+    # A `LineItem`, as the API returns it.
+    #
+    # @!attribute [r] description
+    #   @return [String]
+    # @!attribute [r] quantity
+    #   @return [Numeric]
+    # @!attribute [r] unit
+    #   @return [String, nil]
+    # @!attribute [r] sku
+    #   @return [String, nil]
+    # @!attribute [r] unit_price_cents
+    #   @return [Integer, nil] Unit price in whole cents. Null when the
+    #     price is not an exact number of cents, which happens on utility and
+    #     fuel invoices priced per unit below one cent. Read unit_price_micros
+    #     for those.
+    # @!attribute [r] unit_price_micros
+    #   @return [Integer, nil] Unit price in millionths of one currency
+    #     unit, exact for sub-cent prices. 8.72 cents per kWh is 87200. Set
+    #     whenever a unit price is printed, including when unit_price_cents is
+    #     also set.
+    # @!attribute [r] line_total_cents
+    #   @return [Integer, nil]
+    # @!attribute [r] tax_cents
+    #   @return [Integer, nil]
+    # @!attribute [r] discount_cents
+    #   @return [Integer, nil]
+    LineItem = Data.define(
+      :description,
+      :quantity,
+      :unit,
+      :sku,
+      :unit_price_cents,
+      :unit_price_micros,
+      :line_total_cents,
+      :tax_cents,
+      :discount_cents
+    ) do
+      include Model
+    end
+
+    # A `FraudIndicator`, as the API returns it.
+    #
+    # @!attribute [r] signal
+    #   @return [String] Model-reported signals are one of `math_mismatch`,
+    #     `font_inconsistency`, `implausible_dates`, `round_total`,
+    #     `vendor_details_off`, `possible_edit`. Engine-reported signals add
+    #     `vendor_bank_change` and `vendor_amount_anomaly`.
+    # @!attribute [r] severity
+    #   @return [String] One of `low`, `medium`, `high`.
+    # @!attribute [r] description
+    #   @return [String]
+    # @!attribute [r] source
+    #   @return [String] `model` when read off the page; `engine` when
+    #     derived from workspace history. One of `model`, `engine`.
+    # @!attribute [r] page
+    #   @return [Integer, nil] 1-based page number when the finding has a
+    #     location.
+    # @!attribute [r] box
+    #   @return [RegionBox, nil]
+    FraudIndicator = Data.define(
+      :signal,
+      :severity,
+      :description,
+      :source,
+      :page,
+      :box
+    ) do
+      include Model
+
+      # @api private
+      def self.nested_types
+        {
+          box: RegionBox
+        }
+      end
+    end
+
+    # A rectangle on the page image, normalized 0 to 1, origin top-left.
+    #
+    # @!attribute [r] x
+    #   @return [Numeric]
+    # @!attribute [r] y
+    #   @return [Numeric]
+    # @!attribute [r] w
+    #   @return [Numeric]
+    # @!attribute [r] h
+    #   @return [Numeric]
+    RegionBox = Data.define(
+      :x,
+      :y,
+      :w,
+      :h
+    ) do
+      include Model
+    end
+
+    # A `WebhookEndpoint`, as the API returns it.
+    #
+    # @!attribute [r] id
+    #   @return [String]
+    # @!attribute [r] url
+    #   @return [String]
+    # @!attribute [r] description
+    #   @return [String]
+    # @!attribute [r] events
+    #   @return [Array<String>] Subscribed event types; ["*"] means
+    #     everything.
+    # @!attribute [r] enabled
+    #   @return [Boolean]
+    # @!attribute [r] consecutive_failures
+    #   @return [Integer]
+    # @!attribute [r] last_delivery_at
+    #   @return [String, nil]
+    # @!attribute [r] last_status
+    #   @return [Integer, nil]
+    # @!attribute [r] auto_disabled_at
+    #   @return [String, nil] Set when repeated failures paused this
+    #     endpoint automatically.
+    # @!attribute [r] created_at
+    #   @return [String]
+    WebhookEndpoint = Data.define(
+      :id,
+      :url,
+      :description,
+      :events,
+      :enabled,
+      :consecutive_failures,
+      :last_delivery_at,
+      :last_status,
+      :auto_disabled_at,
+      :created_at
+    ) do
+      include Model
+    end
+
+    # A `WebhookEndpointWithSecret`, as the API returns it.
+    #
+    # @!attribute [r] id
+    #   @return [String]
+    # @!attribute [r] url
+    #   @return [String]
+    # @!attribute [r] description
+    #   @return [String]
+    # @!attribute [r] events
+    #   @return [Array<String>] Subscribed event types; ["*"] means
+    #     everything.
+    # @!attribute [r] enabled
+    #   @return [Boolean]
+    # @!attribute [r] consecutive_failures
+    #   @return [Integer]
+    # @!attribute [r] last_delivery_at
+    #   @return [String, nil]
+    # @!attribute [r] last_status
+    #   @return [Integer, nil]
+    # @!attribute [r] auto_disabled_at
+    #   @return [String, nil] Set when repeated failures paused this
+    #     endpoint automatically.
+    # @!attribute [r] created_at
+    #   @return [String]
+    # @!attribute [r] secret
+    #   @return [String] HMAC key for X-Invoist-Signature. Returned only
+    #     here and on rotation, never readable again.
+    WebhookEndpointWithSecret = Data.define(
+      :id,
+      :url,
+      :description,
+      :events,
+      :enabled,
+      :consecutive_failures,
+      :last_delivery_at,
+      :last_status,
+      :auto_disabled_at,
+      :created_at,
+      :secret
+    ) do
+      include Model
+    end
+
+    # A `Discovery`, as the API returns it.
+    #
+    # @!attribute [r] page
+    #   @return [Integer, nil] 1-based page this pin belongs to. Absent or 0
+    #     means page 1, which is how discoveries extracted before multi-page
+    #     support are stored.
+    # @!attribute [r] x
+    #   @return [Numeric] Normalized 0 to 1 across that page's image.
+    # @!attribute [r] y
+    #   @return [Numeric] Normalized 0 to 1 down that page's image.
+    # @!attribute [r] label
+    #   @return [String]
+    Discovery = Data.define(
+      :page,
+      :x,
+      :y,
+      :label
+    ) do
+      include Model
+    end
+
+    # A `CustomValue`, as the API returns it.
+    #
+    # @!attribute [r] key
+    #   @return [String]
+    # @!attribute [r] label
+    #   @return [String]
+    # @!attribute [r] value
+    #   @return [String, nil]
+    # @!attribute [r] confidence
+    #   @return [Numeric, nil]
+    CustomValue = Data.define(
+      :key,
+      :label,
+      :value,
+      :confidence
+    ) do
+      include Model
+    end
+
+    # A `Quality`, as the API returns it.
+    #
+    # @!attribute [r] readability
+    #   @return [Numeric] 0 to 1, where 1 is crisp and fully legible.
+    # @!attribute [r] issues
+    #   @return [Array<String>] One of `blurry`, `cropped`, `low_contrast`,
+    #     `rotated`, `handwritten`, `partial`.
+    Quality = Data.define(
+      :readability,
+      :issues
+    ) do
+      include Model
+    end
+
+    # A `ReviewQueueItem`, as the API returns it.
+    #
+    # @!attribute [r] id
+    #   @return [String]
+    # @!attribute [r] document_id
+    #   @return [String]
+    # @!attribute [r] extraction_id
+    #   @return [String]
+    # @!attribute [r] reason
+    #   @return [String]
+    # @!attribute [r] status
+    #   @return [String]
+    # @!attribute [r] created_at
+    #   @return [String]
+    # @!attribute [r] resolved_at
+    #   @return [String, nil]
+    ReviewQueueItem = Data.define(
+      :id,
+      :document_id,
+      :extraction_id,
+      :reason,
+      :status,
+      :created_at,
+      :resolved_at
+    ) do
+      include Model
+    end
+
+    # A review item plus a summary of the document it belongs to.
+    #
+    # @!attribute [r] id
+    #   @return [String]
+    # @!attribute [r] document_id
+    #   @return [String]
+    # @!attribute [r] extraction_id
+    #   @return [String]
+    # @!attribute [r] reason
+    #   @return [String]
+    # @!attribute [r] status
+    #   @return [String]
+    # @!attribute [r] created_at
+    #   @return [String]
+    # @!attribute [r] resolved_at
+    #   @return [String, nil]
+    # @!attribute [r] original_filename
+    #   @return [String]
+    # @!attribute [r] content_type
+    #   @return [String]
+    # @!attribute [r] document_status
+    #   @return [String]
+    # @!attribute [r] vendor_name
+    #   @return [String, nil]
+    # @!attribute [r] invoice_number
+    #   @return [String, nil]
+    # @!attribute [r] reference_number
+    #   @return [String, nil]
+    # @!attribute [r] total_cents
+    #   @return [Integer, nil]
+    # @!attribute [r] currency
+    #   @return [String, nil]
+    ReviewQueueListItem = Data.define(
+      :id,
+      :document_id,
+      :extraction_id,
+      :reason,
+      :status,
+      :created_at,
+      :resolved_at,
+      :original_filename,
+      :content_type,
+      :document_status,
+      :vendor_name,
+      :invoice_number,
+      :reference_number,
+      :total_cents,
+      :currency
+    ) do
+      include Model
+    end
+
+    # A `Category`, as the API returns it.
+    #
+    # @!attribute [r] id
+    #   @return [String]
+    # @!attribute [r] name
+    #   @return [String]
+    # @!attribute [r] is_default
+    #   @return [Boolean] Part of the set seeded with the workspace.
+    # @!attribute [r] created_at
+    #   @return [String]
+    Category = Data.define(
+      :id,
+      :name,
+      :is_default,
+      :created_at
+    ) do
+      include Model
+    end
+
+    # A `Usage`, as the API returns it.
+    #
+    # @!attribute [r] period_start
+    #   @return [String]
+    # @!attribute [r] total_calls
+    #   @return [Integer]
+    # @!attribute [r] total_documents
+    #   @return [Integer]
+    # @!attribute [r] total_cost_cents
+    #   @return [Integer]
+    # @!attribute [r] by_day
+    #   @return [Array<Usage::ByDay>]
+    Usage = Data.define(
+      :period_start,
+      :total_calls,
+      :total_documents,
+      :total_cost_cents,
+      :by_day
+    ) do
+      include Model
+
+      # @api private
+      def self.nested_types
+        {
+          by_day: [Usage::ByDay]
+        }
+      end
+    end
+
+    # A `ByDay`, as the API returns it.
+    #
+    # @!attribute [r] day
+    #   @return [String, nil]
+    # @!attribute [r] calls
+    #   @return [Integer, nil]
+    # @!attribute [r] documents
+    #   @return [Integer, nil]
+    Usage::ByDay = Data.define(
+      :day,
+      :calls,
+      :documents
+    ) do
+      include Model
+    end
+
+    # A `StatsOverview`, as the API returns it.
+    #
+    # @!attribute [r] documents_this_month
+    #   @return [Integer]
+    # @!attribute [r] documents_total
+    #   @return [Integer]
+    # @!attribute [r] pending_review_count
+    #   @return [Integer]
+    # @!attribute [r] period_start
+    #   @return [String]
+    # @!attribute [r] plan
+    #   @return [String] One of `starter`, `growth`, `scale`.
+    # @!attribute [r] documents_included
+    #   @return [Integer, nil] Monthly allowance for the plan. Absent for
+    #     plans without a fixed allowance.
+    StatsOverview = Data.define(
+      :documents_this_month,
+      :documents_total,
+      :pending_review_count,
+      :period_start,
+      :plan,
+      :documents_included
+    ) do
+      include Model
+    end
+
+    # The household's own record on a bill.
+    #
+    # @!attribute [r] paid_at
+    #   @return [String, nil] When it was marked paid.
+    # @!attribute [r] paid_by
+    #   @return [String, nil] Who marked it paid.
+    # @!attribute [r] assigned_to
+    #   @return [String, nil] Who is meant to pay it.
+    BillRecord = Data.define(
+      :paid_at,
+      :paid_by,
+      :assigned_to
+    ) do
+      include Model
+    end
+
+    # The bill a letter or receipt is linked to, and how.
+    #
+    # @!attribute [r] document_id
+    #   @return [String, nil]
+    # @!attribute [r] link
+    #   @return [String] `matched` or `confirmed` when linked, `suggested`
+    #     when Invoist only thinks so, empty when unlinked.
+    BillRelated = Data.define(
+      :document_id,
+      :link
+    ) do
+      include Model
+    end
+
+    # The newest reminder or collection letter about a bill, which says what
+    # is owed now.
+    #
+    # @!attribute [r] document_id
+    #   @return [String]
+    # @!attribute [r] kind
+    #   @return [String] One of `reminder`, `debt_collection`.
+    # @!attribute [r] total_cents
+    #   @return [Integer, nil]
+    # @!attribute [r] currency
+    #   @return [String, nil]
+    # @!attribute [r] due_date
+    #   @return [String, nil]
+    # @!attribute [r] added_cents
+    #   @return [Integer, nil] Fees and interest added on top of the
+    #     original.
+    # @!attribute [r] count
+    #   @return [Integer] How many letters came for this bill.
+    BillLetter = Data.define(
+      :document_id,
+      :kind,
+      :total_cents,
+      :currency,
+      :due_date,
+      :added_cents,
+      :count
+    ) do
+      include Model
+    end
+
+    # One bill in a household's list.
+    #
+    # @!attribute [r] id
+    #   @return [String]
+    # @!attribute [r] source
+    #   @return [String]
+    # @!attribute [r] original_filename
+    #   @return [String]
+    # @!attribute [r] content_type
+    #   @return [String]
+    # @!attribute [r] byte_size
+    #   @return [Integer]
+    # @!attribute [r] status
+    #   @return [String]
+    # @!attribute [r] vendor_name
+    #   @return [String, nil]
+    # @!attribute [r] invoice_number
+    #   @return [String, nil]
+    # @!attribute [r] reference_number
+    #   @return [String, nil]
+    # @!attribute [r] total_cents
+    #   @return [Integer, nil]
+    # @!attribute [r] base_currency
+    #   @return [String, nil] The workspace's reporting currency, when one
+    #     is configured. Null when conversion is off, or when this invoice's
+    #     currency had no published rate for its date. The invoice's own
+    #     currency and total_cents remain authoritative.
+    # @!attribute [r] base_total_cents
+    #   @return [Integer, nil] total_cents converted into base_currency, for
+    #     reporting only.
+    # @!attribute [r] fx_rate
+    #   @return [String, nil] Reporting-currency units per one unit of the
+    #     invoice currency, as a decimal string so the exact stored value
+    #     round-trips.
+    # @!attribute [r] fx_rate_date
+    #   @return [String, nil] The date of the published rates used, which is
+    #     the invoice date or the most recent publication before it.
+    # @!attribute [r] fx_source
+    #   @return [String, nil] Who published the rate, e.g. "ecb".
+    # @!attribute [r] currency
+    #   @return [String, nil]
+    # @!attribute [r] category_id
+    #   @return [String, nil]
+    # @!attribute [r] category_name
+    #   @return [String, nil]
+    # @!attribute [r] pending_review
+    #   @return [Integer] Count of unresolved review items.
+    # @!attribute [r] flagged
+    #   @return [Boolean] True when pending_review is above zero.
+    # @!attribute [r] created_at
+    #   @return [String]
+    # @!attribute [r] updated_at
+    #   @return [String]
+    # @!attribute [r] due_date
+    #   @return [String, nil]
+    # @!attribute [r] bill
+    #   @return [BillRecord]
+    # @!attribute [r] kind
+    #   @return [String, nil]
+    # @!attribute [r] related
+    #   @return [BillRelated]
+    # @!attribute [r] letter
+    #   @return [BillLetter, nil]
+    # @!attribute [r] proof_document_id
+    #   @return [String, nil] A receipt or payment confirmation found for
+    #     this bill.
+    # @!attribute [r] logo
+    #   @return [String, nil] The domain whose logo stands for the sender,
+    #     when Invoist shows one: never on a bill with an open warning, never
+    #     for a domain that imitates another the household knows.
+    Bill = Data.define(
+      :id,
+      :source,
+      :original_filename,
+      :content_type,
+      :byte_size,
+      :status,
+      :vendor_name,
+      :invoice_number,
+      :reference_number,
+      :total_cents,
+      :base_currency,
+      :base_total_cents,
+      :fx_rate,
+      :fx_rate_date,
+      :fx_source,
+      :currency,
+      :category_id,
+      :category_name,
+      :pending_review,
+      :flagged,
+      :created_at,
+      :updated_at,
+      :due_date,
+      :bill,
+      :kind,
+      :related,
+      :letter,
+      :proof_document_id,
+      :logo
+    ) do
+      include Model
+
+      # @api private
+      def self.nested_types
+        {
+          bill: BillRecord,
+          related: BillRelated,
+          letter: BillLetter
+        }
+      end
+    end
+
+    # One document of a bill's chain (the bill and its letters).
+    #
+    # @!attribute [r] document_id
+    #   @return [String]
+    # @!attribute [r] kind
+    #   @return [String, nil]
+    # @!attribute [r] link
+    #   @return [String, nil]
+    # @!attribute [r] status
+    #   @return [String]
+    # @!attribute [r] original_filename
+    #   @return [String]
+    # @!attribute [r] vendor_name
+    #   @return [String, nil]
+    # @!attribute [r] invoice_number
+    #   @return [String, nil]
+    # @!attribute [r] reference_number
+    #   @return [String, nil]
+    # @!attribute [r] currency
+    #   @return [String, nil]
+    # @!attribute [r] total_cents
+    #   @return [Integer, nil]
+    # @!attribute [r] date
+    #   @return [String]
+    # @!attribute [r] due_date
+    #   @return [String, nil]
+    # @!attribute [r] paid_at
+    #   @return [String, nil]
+    # @!attribute [r] fees_cents
+    #   @return [Integer, nil]
+    # @!attribute [r] interest_cents
+    #   @return [Integer, nil]
+    # @!attribute [r] original_amount_cents
+    #   @return [Integer, nil]
+    # @!attribute [r] original_creditor
+    #   @return [String, nil]
+    # @!attribute [r] vendor_iban
+    #   @return [String, nil]
+    # @!attribute [r] vendor_bic
+    #   @return [String, nil]
+    # @!attribute [r] payment_account
+    #   @return [String, nil]
+    # @!attribute [r] warnings
+    #   @return [Array<BillChainMember::Warning>, nil]
+    BillChainMember = Data.define(
+      :document_id,
+      :kind,
+      :link,
+      :status,
+      :original_filename,
+      :vendor_name,
+      :invoice_number,
+      :reference_number,
+      :currency,
+      :total_cents,
+      :date,
+      :due_date,
+      :paid_at,
+      :fees_cents,
+      :interest_cents,
+      :original_amount_cents,
+      :original_creditor,
+      :vendor_iban,
+      :vendor_bic,
+      :payment_account,
+      :warnings
+    ) do
+      include Model
+
+      # @api private
+      def self.nested_types
+        {
+          warnings: [BillChainMember::Warning]
+        }
+      end
+    end
+
+    # A `Warning`, as the API returns it.
+    #
+    # @!attribute [r] id
+    #   @return [String]
+    # @!attribute [r] reason
+    #   @return [String]
+    BillChainMember::Warning = Data.define(
+      :id,
+      :reason
+    ) do
+      include Model
+    end
+
+    # One bill with everything read from it.
+    #
+    # @!attribute [r] document
+    #   @return [Document]
+    # @!attribute [r] extraction
+    #   @return [Extraction, nil]
+    # @!attribute [r] extraction_job
+    #   @return [ExtractionJob, nil]
+    # @!attribute [r] review_queue
+    #   @return [Array<ReviewQueueItem>] The bill's warnings; open ones have
+    #     status `pending`.
+    # @!attribute [r] period_locked
+    #   @return [Boolean, nil]
+    # @!attribute [r] bill
+    #   @return [BillRecord]
+    # @!attribute [r] related
+    #   @return [BillRelated, nil]
+    # @!attribute [r] chain
+    #   @return [BillDetail::Chain, nil] The bill and its letters, when it
+    #     has any.
+    # @!attribute [r] suggested_bill
+    #   @return [BillChainMember, nil]
+    # @!attribute [r] suggested_letters
+    #   @return [Array<BillChainMember>, nil]
+    # @!attribute [r] logo
+    #   @return [String, nil]
+    BillDetail = Data.define(
+      :document,
+      :extraction,
+      :extraction_job,
+      :review_queue,
+      :period_locked,
+      :bill,
+      :related,
+      :chain,
+      :suggested_bill,
+      :suggested_letters,
+      :logo
+    ) do
+      include Model
+
+      # @api private
+      def self.nested_types
+        {
+          document: Document,
+          extraction: Extraction,
+          extraction_job: ExtractionJob,
+          review_queue: [ReviewQueueItem],
+          bill: BillRecord,
+          related: BillRelated,
+          chain: BillDetail::Chain,
+          suggested_bill: BillChainMember,
+          suggested_letters: [BillChainMember]
+        }
+      end
+    end
+
+    # The bill and its letters, when it has any.
+    #
+    # @!attribute [r] root_id
+    #   @return [String]
+    # @!attribute [r] members
+    #   @return [Array<BillChainMember>]
+    BillDetail::Chain = Data.define(
+      :root_id,
+      :members
+    ) do
+      include Model
+
+      # @api private
+      def self.nested_types
+        {
+          members: [BillChainMember]
+        }
+      end
+    end
+
+    # A `BillsDue`, as the API returns it.
+    #
+    # @!attribute [r] currency
+    #   @return [String]
+    # @!attribute [r] count
+    #   @return [Integer]
+    # @!attribute [r] total_cents
+    #   @return [Integer]
+    BillsDue = Data.define(
+      :currency,
+      :count,
+      :total_cents
+    ) do
+      include Model
+    end
+
+    # A `BillsSummary`, as the API returns it.
+    #
+    # @!attribute [r] unpaid
+    #   @return [Integer] Bills not marked paid.
+    # @!attribute [r] overdue
+    #   @return [Integer] Unpaid bills past their due date.
+    # @!attribute [r] due_soon
+    #   @return [Array<BillsDue>] Per currency, the unpaid bills due by
+    #     today plus `days`, overdue ones included.
+    # @!attribute [r] days
+    #   @return [Integer]
+    # @!attribute [r] today
+    #   @return [String]
+    BillsSummary = Data.define(
+      :unpaid,
+      :overdue,
+      :due_soon,
+      :days,
+      :today
+    ) do
+      include Model
+
+      # @api private
+      def self.nested_types
+        {
+          due_soon: [BillsDue]
+        }
+      end
+    end
+
+    # A `BillsStats`, as the API returns it.
+    #
+    # @!attribute [r] month
+    #   @return [String] `YYYY-MM`
+    # @!attribute [r] totals
+    #   @return [Array<BillsStats::Total>]
+    # @!attribute [r] trend
+    #   @return [Array<BillsStats::Trend>] Up to twelve months ending with
+    #     `month`, per currency; months with no bills are absent.
+    # @!attribute [r] top_senders
+    #   @return [Array<BillsStats::TopSender>]
+    # @!attribute [r] senders
+    #   @return [Array<BillsStats::Sender>] Everyone who has sent the
+    #     household bills, most bills first.
+    BillsStats = Data.define(
+      :month,
+      :totals,
+      :trend,
+      :top_senders,
+      :senders
+    ) do
+      include Model
+
+      # @api private
+      def self.nested_types
+        {
+          totals: [BillsStats::Total],
+          trend: [BillsStats::Trend],
+          top_senders: [BillsStats::TopSender],
+          senders: [BillsStats::Sender]
+        }
+      end
+    end
+
+    # A `Total`, as the API returns it.
+    #
+    # @!attribute [r] currency
+    #   @return [String]
+    # @!attribute [r] count
+    #   @return [Integer]
+    # @!attribute [r] paid_count
+    #   @return [Integer]
+    # @!attribute [r] total_cents
+    #   @return [Integer]
+    # @!attribute [r] paid_cents
+    #   @return [Integer]
+    BillsStats::Total = Data.define(
+      :currency,
+      :count,
+      :paid_count,
+      :total_cents,
+      :paid_cents
+    ) do
+      include Model
+    end
+
+    # A `Trend`, as the API returns it.
+    #
+    # @!attribute [r] month
+    #   @return [String]
+    # @!attribute [r] currency
+    #   @return [String]
+    # @!attribute [r] count
+    #   @return [Integer]
+    # @!attribute [r] total_cents
+    #   @return [Integer]
+    BillsStats::Trend = Data.define(
+      :month,
+      :currency,
+      :count,
+      :total_cents
+    ) do
+      include Model
+    end
+
+    # A `TopSender`, as the API returns it.
+    #
+    # @!attribute [r] name
+    #   @return [String]
+    # @!attribute [r] currency
+    #   @return [String, nil]
+    # @!attribute [r] count
+    #   @return [Integer]
+    # @!attribute [r] total_cents
+    #   @return [Integer, nil]
+    # @!attribute [r] logo
+    #   @return [String, nil]
+    BillsStats::TopSender = Data.define(
+      :name,
+      :currency,
+      :count,
+      :total_cents,
+      :logo
+    ) do
+      include Model
+    end
+
+    # A `Sender`, as the API returns it.
+    #
+    # @!attribute [r] name
+    #   @return [String]
+    # @!attribute [r] count
+    #   @return [Integer]
+    BillsStats::Sender = Data.define(
+      :name,
+      :count
+    ) do
+      include Model
+    end
+
+    # A `HeldEmailFile`, as the API returns it.
+    #
+    # @!attribute [r] id
+    #   @return [String]
+    # @!attribute [r] filename
+    #   @return [String]
+    # @!attribute [r] content_type
+    #   @return [String]
+    # @!attribute [r] size_bytes
+    #   @return [Integer]
+    HeldEmailFile = Data.define(
+      :id,
+      :filename,
+      :content_type,
+      :size_bytes
+    ) do
+      include Model
+    end
+
+    # An email forwarded to the household that waits for approval.
+    #
+    # @!attribute [r] id
+    #   @return [String]
+    # @!attribute [r] from_email
+    #   @return [String]
+    # @!attribute [r] subject
+    #   @return [String]
+    # @!attribute [r] status
+    #   @return [String]
+    # @!attribute [r] reason
+    #   @return [String, nil]
+    # @!attribute [r] attachments
+    #   @return [Integer, nil]
+    # @!attribute [r] documents
+    #   @return [Integer, nil]
+    # @!attribute [r] created_at
+    #   @return [String]
+    # @!attribute [r] hold_reason
+    #   @return [String, nil] Why it waits. The sender reasons wait for a
+    #     person; the plan reasons clear by themselves. One of `new_sender`,
+    #     `unverified_sender`, `no_plan`, `quota_used`.
+    # @!attribute [r] held_until
+    #   @return [String, nil] When it is deleted if nobody acts.
+    # @!attribute [r] resolved_at
+    #   @return [String, nil]
+    # @!attribute [r] bounced
+    #   @return [Boolean, nil]
+    # @!attribute [r] forwarded_by
+    #   @return [String, nil] The household member whose forwarding rule
+    #     passed it on.
+    # @!attribute [r] original_from
+    #   @return [String, nil] Who wrote it first, when forwarded by hand.
+    # @!attribute [r] lookalike_of
+    #   @return [String, nil] A known domain this sender's imitates.
+    # @!attribute [r] sender
+    #   @return [String] What the mail server found about the From address.
+    #     One of `verified`, `failed`, `unknown`.
+    # @!attribute [r] files
+    #   @return [Array<HeldEmailFile>]
+    # @!attribute [r] logo
+    #   @return [String, nil]
+    HeldEmail = Data.define(
+      :id,
+      :from_email,
+      :subject,
+      :status,
+      :reason,
+      :attachments,
+      :documents,
+      :created_at,
+      :hold_reason,
+      :held_until,
+      :resolved_at,
+      :bounced,
+      :forwarded_by,
+      :original_from,
+      :lookalike_of,
+      :sender,
+      :files,
+      :logo
+    ) do
+      include Model
+
+      # @api private
+      def self.nested_types
+        {
+          files: [HeldEmailFile]
+        }
+      end
+    end
+
+    # Submit a document for extraction
+    #
+    # @!attribute [r] document
+    #   @return [Document]
+    # @!attribute [r] extraction
+    #   @return [Extraction, nil]
+    # @!attribute [r] duplicate
+    #   @return [Boolean]
+    ExtractResult = Data.define(
+      :document,
+      :extraction,
+      :duplicate
+    ) do
+      include Model
+
+      # @api private
+      def self.nested_types
+        {
+          document: Document,
+          extraction: Extraction
+        }
+      end
+    end
+
+    # Submit up to 10 documents in one call
+    #
+    # @!attribute [r] results
+    #   @return [Array<BatchResultItem>]
+    # @!attribute [r] accepted
+    #   @return [Integer] How many files were accepted and queued.
+    # @!attribute [r] rejected
+    #   @return [Integer] How many files failed validation or could not be
+    #     stored.
+    BatchResult = Data.define(
+      :results,
+      :accepted,
+      :rejected
+    ) do
+      include Model
+
+      # @api private
+      def self.nested_types
+        {
+          results: [BatchResultItem]
+        }
+      end
+    end
+
+    # Fetch a document with its extraction
+    #
+    # @!attribute [r] document
+    #   @return [Document]
+    # @!attribute [r] extraction
+    #   @return [Extraction, nil]
+    # @!attribute [r] extraction_job
+    #   @return [ExtractionJob, nil]
+    # @!attribute [r] review_queue
+    #   @return [Array<ReviewQueueItem>]
+    # @!attribute [r] period_locked
+    #   @return [Boolean, nil] Whether this document's month is closed. A
+    #     locked document can be read and exported but not edited,
+    #     categorized, deleted, or re-run until the month is reopened.
+    DocumentDetail = Data.define(
+      :document,
+      :extraction,
+      :extraction_job,
+      :review_queue,
+      :period_locked
+    ) do
+      include Model
+
+      # @api private
+      def self.nested_types
+        {
+          document: Document,
+          extraction: Extraction,
+          extraction_job: ExtractionJob,
+          review_queue: [ReviewQueueItem]
+        }
+      end
+    end
+
+    # List webhook endpoints
+    #
+    # @!attribute [r] endpoints
+    #   @return [Array<WebhookEndpoint>]
+    # @!attribute [r] known_events
+    #   @return [Array<String>]
+    WebhookEndpointList = Data.define(
+      :endpoints,
+      :known_events
+    ) do
+      include Model
+
+      # @api private
+      def self.nested_types
+        {
+          endpoints: [WebhookEndpoint]
+        }
+      end
+    end
+  end
+end