invoist 1.0.0

data/sig/invoist.rbs

@@ -0,0 +1,273 @@
+# The public API of the invoist gem. The response types are in
+# sig/invoist/models.rbs, generated from openapi.yaml.
+module Invoist
+  VERSION: String
+  USER_AGENT: String
+
+  def self.new: (api_key: String, ?base_url: String, ?timeout: Numeric, ?max_retries: Integer,
+                 ?transport: Transport::_Transport?, ?sleeper: Client::_Sleeper?) -> Client
+
+  # Anything Upload.wrap understands.
+  type file_input = Upload | String | _ToPath | _Reader | Hash[Symbol | String, untyped]
+  type month = String | _Strftime
+  type date = String | _Strftime
+
+  interface _Reader
+    def read: () -> String
+  end
+
+  interface _ToPath
+    def to_path: () -> String
+  end
+
+  interface _Strftime
+    def strftime: (String) -> String
+  end
+
+  class Client
+    interface _Sleeper
+      def call: (Numeric seconds) -> untyped
+    end
+
+    DEFAULT_BASE_URL: String
+    DEFAULT_TIMEOUT: Integer
+    DEFAULT_MAX_RETRIES: Integer
+    DEFAULT_WAIT_TIMEOUT: Integer
+    DEFAULT_POLL_INTERVAL: Integer
+
+    attr_reader bills: Bills
+    attr_reader held_emails: HeldEmails
+
+    def initialize: (api_key: String, ?base_url: String, ?timeout: Numeric, ?max_retries: Integer,
+                     ?transport: Transport::_Transport?, ?sleeper: _Sleeper?) -> void
+    def base_url: () -> String
+    def timeout: () -> Numeric
+    def max_retries: () -> Integer
+    def inspect: () -> String
+
+    def extract: (file_input file, ?idempotency_key: String?) -> Models::ExtractResult
+    def extract_batch: (Array[file_input] files) -> Models::BatchResult
+    def list_documents: (?limit: Integer?, ?offset: Integer?, ?status: String?, ?flagged: bool?, ?q: String?,
+                         ?category: String?) -> Array[Models::DocumentListItem]
+    def get_document: (String id) -> Models::DocumentDetail
+    def get_document_file: (String id) -> Download
+    def wait_for_extraction: (String id, ?timeout: Numeric, ?poll_interval: Numeric) -> Models::Extraction
+    def extract_and_wait: (file_input file, ?timeout: Numeric, ?poll_interval: Numeric,
+                           ?idempotency_key: String?) -> Models::ExtractResult
+    def list_review_queue: (?status: String?) -> Array[Models::ReviewQueueListItem]
+    def resolve_review_item: (String id, ?status: String) -> Models::ReviewQueueItem
+    alias resolve_review_queue_item resolve_review_item
+    def list_categories: () -> Array[Models::Category]
+    def get_usage: () -> Models::Usage
+    def get_stats: () -> Models::StatsOverview
+    def list_webhook_endpoints: () -> Models::WebhookEndpointList
+    def create_webhook_endpoint: (url: String, ?events: Array[String]?, ?description: String?)
+                               -> Models::WebhookEndpointWithSecret
+    def delete_webhook_endpoint: (String id) -> nil
+
+    private
+
+    def validate!: (untyped api_key, untyped timeout, untyped max_retries) -> void
+    def list: [T] (untyped body, String key, untyped model) -> Array[T]
+    def monotonic: () -> Float
+  end
+
+  class Bills
+    def initialize: (HTTP http) -> void
+    def list: (?paid: bool?, ?month: month?, ?sender: String?, ?q: String?, ?limit: Integer?, ?offset: Integer?)
+            -> Array[Models::Bill]
+    def get: (String id) -> Models::BillDetail
+    def get_file: (String id) -> Download
+    def summary: (?today: date?, ?days: Integer?) -> Models::BillsSummary
+    def stats: (?month: month?, ?sender: String?) -> Models::BillsStats
+    def mark_paid: (String id) -> Models::BillRecord
+    def mark_unpaid: (String id) -> Models::BillRecord
+    def inspect: () -> String
+
+    private
+
+    def record: (untyped body) -> Models::BillRecord
+  end
+
+  class HeldEmails
+    def initialize: (HTTP http) -> void
+    def list: () -> Array[Models::HeldEmail]
+    def inspect: () -> String
+  end
+
+  class Error < StandardError
+    attr_reader status: Integer
+    attr_reader code: String
+    attr_reader request_id: String?
+    attr_reader body: String?
+    attr_reader retry_after: Integer?
+
+    def initialize: (String message, status: Integer, code: String, ?request_id: String?, ?body: String?,
+                     ?retry_after: Integer?) -> void
+    def self.from_response: (status: Integer, body: String?, ?headers: Hash[String, String?]) -> Error
+    def self.integer_seconds: (untyped value) -> Integer?
+    def auth_error?: () -> bool
+    def permission_error?: () -> bool
+    def not_found?: () -> bool
+    def rate_limited?: () -> bool
+    def retryable?: () -> bool
+    def inspect: () -> String
+  end
+
+  module Model
+    def self.included: (Module base) -> void
+    def self.coerce: (untyped value, untyped type) -> untyped
+    def self.dump: (untyped value) -> untyped
+
+    module ClassMethods
+      def from_h: (Hash[String | Symbol, untyped]? hash) -> untyped
+      def nested_types: () -> Hash[Symbol, untyped]
+    end
+
+    def []: (Symbol | String key) -> untyped
+    def to_h: () -> Hash[Symbol, untyped]
+            | [K, V] () { (Symbol, untyped) -> [K, V] } -> Hash[K, V]
+    def to_json: (*untyped) -> String
+  end
+
+  module Transport
+    interface _Transport
+      def call: (Request request) -> Response
+    end
+
+    class Request < Data
+      attr_reader http_method: String
+      attr_reader url: String
+      attr_reader headers: Hash[String, String]
+      attr_reader body: String?
+      attr_reader timeout: Numeric
+
+      def initialize: (http_method: String, url: String, headers: Hash[String, String], body: String?,
+                       timeout: Numeric) -> void
+      def self.new: (http_method: String, url: String, headers: Hash[String, String], body: String?,
+                     timeout: Numeric) -> instance
+    end
+
+    class Response < Data
+      attr_reader status: Integer
+      attr_reader headers: Hash[String, String | Array[String]]
+      attr_reader body: String
+
+      def initialize: (status: Integer, headers: Hash[String, String | Array[String]], body: String) -> void
+      def self.new: (status: Integer, headers: Hash[String, String | Array[String]], body: String) -> instance
+      def header: (String name) -> String?
+    end
+
+    class NetHTTP
+      def call: (Request request) -> Response
+
+      private
+
+      def connection: (URI::Generic uri, Numeric timeout) -> Net::HTTP
+    end
+  end
+
+  class Download < Data
+    attr_reader data: String
+    attr_reader content_type: String
+    attr_reader filename: String?
+
+    def initialize: (data: String, content_type: String, filename: String?) -> void
+    def self.new: (data: String, content_type: String, filename: String?) -> instance
+    def self.filename_from: (String? header) -> String?
+    def size: () -> Integer
+    def save: (String | _ToPath path) -> Integer
+    def inspect: () -> String
+  end
+
+  class Upload
+    CONTENT_TYPES: Hash[String, String]
+
+    attr_reader data: String
+    attr_reader filename: String
+    attr_reader content_type: String
+
+    def initialize: (String data, filename: String, ?content_type: String?) -> void
+    def self.wrap: (file_input input) -> Upload
+    def self.guess_content_type: (String filename) -> String
+    def inspect: () -> String
+  end
+
+  class Multipart
+    attr_reader body: String
+    attr_reader content_type: String
+
+    def initialize: (Array[[String, Upload]] parts) -> void
+
+    private
+
+    def escape: (untyped value) -> String
+  end
+
+  module Params
+    def self.boolean: (String name, bool? value) -> String?
+    def self.month: (String name, month? value) -> String?
+    def self.date: (String name, date? value) -> String?
+    def self.integer: (String name, Integer? value) -> Integer?
+    def self.id: (untyped value) -> String
+    def self.local: [T] (T value) -> (T | Time)
+  end
+
+  class HTTP
+    TIMEOUT_ERRORS: Array[Class]
+    NETWORK_ERRORS: Array[Class]
+    BASE_DELAY: Float
+    MAX_DELAY: Float
+    JITTER: Float
+    MAX_RETRY_AFTER: Integer
+
+    attr_reader base_url: String
+    attr_reader timeout: Numeric
+    attr_reader max_retries: Integer
+
+    def initialize: (api_key: String, base_url: String, timeout: Numeric, max_retries: Integer,
+                     transport: Transport::_Transport, sleeper: Client::_Sleeper) -> void
+    def json: (String verb, String path, ?query: Hash[Symbol, untyped]?, ?body: untyped,
+               ?headers: Hash[String, String]) -> untyped
+    def multipart: (String path, Multipart form, ?headers: Hash[String, String]) -> untyped
+    def binary: (String path) -> Download
+    def sleep: (Numeric seconds) -> untyped
+    def retry_delay: (Integer attempt, ?Transport::Response? response) -> Float
+    def url: (String path, ?Hash[Symbol, untyped]? query) -> String
+
+    private
+
+    def retry?: (Error error, Integer attempt) -> bool
+  end
+
+  module Webhook
+    DOCUMENT_CREATED: String
+    EXTRACTION_COMPLETED: String
+    EXTRACTION_FAILED: String
+    REVIEW_ITEM_CREATED: String
+    REVIEW_ITEM_RESOLVED: String
+    DOCUMENT_REQUEST_FULFILLED: String
+    EVENT_TYPES: Array[String]
+    SIGNATURE_HEADER: String
+    EVENT_HEADER: String
+    DELIVERY_HEADER: String
+    DEFAULT_TOLERANCE: Integer
+
+    class Event < Data
+      include Invoist::Model
+      extend Invoist::Model::ClassMethods
+
+      attr_reader id: String
+      attr_reader type: String
+      attr_reader created_at: String
+      attr_reader data: Hash[String, untyped]
+
+      def initialize: (id: String, type: String, created_at: String, data: Hash[String, untyped]) -> void
+      def self.new: (id: String, type: String, created_at: String, data: Hash[String, untyped]) -> instance
+    end
+
+    def self.verify: (String | _Reader payload, String? signature_header, String secret, ?tolerance: Integer,
+                      ?now: (Integer | Time)?) -> Event
+    def self.sign: (String payload, String secret, ?timestamp: Integer) -> String
+  end
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification
+name: invoist
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Invoist
+bindir: bin
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+description: 'Send Invoist an invoice, receipt or bill and get its details back as
+  data: sender, totals, tax, line items, due date and anything worth a second look.
+  Covers business workspaces (extraction, documents, review queue, webhooks) and households
+  (bills, what is due, held emails), with typed responses, automatic retries and webhook
+  signature checks. Uses only Ruby''s standard library.'
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- SECURITY.md
+- lib/invoist.rb
+- lib/invoist/bills.rb
+- lib/invoist/client.rb
+- lib/invoist/download.rb
+- lib/invoist/error.rb
+- lib/invoist/http.rb
+- lib/invoist/model.rb
+- lib/invoist/models.rb
+- lib/invoist/params.rb
+- lib/invoist/transport.rb
+- lib/invoist/upload.rb
+- lib/invoist/version.rb
+- lib/invoist/webhook.rb
+- sig/invoist.rbs
+- sig/invoist/models.rbs
+homepage: https://invoi.st/docs
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://invoi.st/docs
+  documentation_uri: https://rubydoc.info/gems/invoist
+  source_code_uri: https://github.com/invoisthq/invoist-ruby
+  changelog_uri: https://github.com/invoisthq/invoist-ruby/blob/main/CHANGELOG.md
+  bug_tracker_uri: https://github.com/invoisthq/invoist-ruby/issues
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 4.0.20
+specification_version: 4
+summary: 'The official Ruby client for the Invoist API: invoices and bills in, clean
+  data out.'
+test_files: []