mailfloss 0.1.0

data/sig/types.rbs

@@ -0,0 +1,266 @@
+# Response shapes, hand-derived from the mailfloss v1 OpenAPI spec
+# (docs/api/openapi.v1.public.json). Responses are parsed with
+# JSON.parse(symbolize_names: true), so all keys are Symbols.
+module Mailfloss
+  module Types
+    # Cursor pagination envelope for all list endpoints:
+    # { data: [...], pagination: { next_cursor:, has_more: } }
+    type pagination = { next_cursor: String?, has_more: bool }
+
+    # GET /verify
+    # status: "passed" | "undeliverable" | "risky" | "unknown"
+    type verify_result = {
+      email: String,
+      domain: String?,
+      status: String,
+      reason: String,
+      passed: bool,
+      role: bool?,
+      disposable: bool?,
+      free: bool?,
+      suggestion: String?,
+      meta: String?
+    }
+
+    # POST /batch-verify
+    type batch_create_result = { id: String }
+
+    # GET /batch-verify/{id}/status
+    type batch_status_result = { status: String?, progress: Numeric? }
+
+    # GET /batch-verify/{id}/results
+    type batch_results_result = { id: String?, results: Array[untyped]? }
+
+    # POST /batch-verify/{id}/cancel
+    type batch_cancel_result = { success: bool? }
+
+    # Per-verdict counts on a completed job (null mid-flight/cancelled).
+    type job_results = {
+      total: Integer, processed: Integer, passed: Integer, failed: Integer,
+      undeliverable: Integer, risky: Integer, unknown: Integer
+    }
+
+    # GET /jobs/{id} and items of GET /jobs data[].
+    # status: queued|processing|completed|cancelled
+    # source: api|csv|zapier|widget|input|integration
+    type job = {
+      id: String,
+      status: String,
+      source: String,
+      source_integration: String?,
+      created_at: String?,
+      finished_at: String?,
+      results: job_results?
+    }
+
+    # GET /jobs
+    type jobs_list = { data: Array[job], pagination: pagination }
+
+    # GET /users/{user_id} and items of GET /users data[].
+    # role: administrator|contributor; status: active|invited|paused
+    type user = {
+      id: String,
+      email: String,
+      name: String?,
+      role: String,
+      is_primary: bool,
+      status: String,
+      created_at: String?
+    }
+
+    # GET /users
+    type users_list = { data: Array[user], pagination: pagination }
+
+    # GET /reports/usage — statuses/reasons/range are null for period=lifetime.
+    type usage_statuses = {
+      passed: Integer, failed: Integer, undeliverable: Integer,
+      risky: Integer, unknown: Integer
+    }
+
+    type usage_reasons = {
+      invalid: Integer, nonexistent: Integer, deactivated: Integer,
+      inbox_full: Integer, illegitimate: Integer, spam: Integer,
+      role_based: Integer, banned_words: Integer, disposable: Integer,
+      failed_exchange: Integer, accept_all: Integer, unverified: Integer,
+      complained: Integer, bounced: Integer, blacklisted: Integer,
+      available: Integer
+    }
+
+    type usage_report = {
+      period: String,
+      connection_id: String?,
+      range: { start: String, end: String }?,
+      total: Integer,
+      statuses: usage_statuses?,
+      reasons: usage_reasons?
+    }
+
+    # GET /check-key (legacy field names preserved by the API)
+    type check_key_result = {
+      name: String?,
+      organization: String?,
+      planType: String?,
+      freeMatches: Numeric?,
+      extraCredits: Numeric?
+    }
+
+    # GET /account and PATCH /account response
+    type account_address = {
+      line1: String?, line2: String?, city: String?, state: String?,
+      postal_code: String?, country: String?
+    }
+
+    type account_notifications = {
+      after_flossing: bool, weekly_report: bool,
+      monthly_report: bool, payment_receipts: bool
+    }
+
+    type account = {
+      id: String,
+      name: String?,
+      email: String,
+      email_verified: bool,
+      two_factor_enabled: bool,
+      identity_verified: bool,
+      phone: String?,
+      organization: String?,
+      vat_id: String?,
+      country: String?,
+      address: account_address?,
+      notifications: account_notifications,
+      created_at: String?
+    }
+
+    # GET /organization
+    type org_credits = { prepaid: Integer, subscription: Integer, total: Integer }
+
+    type org_usage = {
+      current_period_start: String,
+      current_period_end: String,
+      current_period_total: Integer
+    }
+
+    type org_trial = { active: bool, started_at: String?, ends_at: String? }
+
+    type org_entitlements = {
+      webhooks: bool, instafloss: bool, typo_fixer: bool, exclusions: bool,
+      update_tags: bool, sso: bool, autofloss: bool, decay_basic: bool,
+      decay_custom: bool
+    }
+
+    type organization = {
+      name: String?,
+      email: String?,
+      plan: String,
+      plan_id: String?,
+      credits: org_credits,
+      usage: org_usage,
+      trial: org_trial,
+      created_at: String?,
+      status: String,
+      entitlements: org_entitlements
+    }
+
+    # Connection settings.checks — the 12 floss check gates.
+    type connection_checks = {
+      disposable: bool, nonexistent: bool, deactivated: bool, inbox_full: bool,
+      bounced: bool, banned_words: bool, role_based: bool, complainers: bool,
+      spam: bool, failed_exchange: bool, unverified: bool, accept_all: bool
+    }
+
+    # aggressiveness: normal|aggressive|custom
+    # action: unsubscribe|delete|update_tags|update_custom_fields|do_nothing|nil
+    type connection_settings = {
+      aggressiveness: String,
+      manual_mode: bool,
+      autofloss: bool,
+      decay_protection: bool,
+      instafloss: bool,
+      action: String?,
+      checks: connection_checks,
+      blacklist_count: Integer,
+      whitelist_count: Integer
+    }
+
+    # An active ESP connection (create/get/update/sync responses and
+    # GET /integrations/{type} connections[]).
+    type connection = {
+      id: String,
+      name: String,
+      status: String,
+      created_at: String?,
+      last_synced_at: String?,
+      settings: connection_settings
+    }
+
+    type disconnected_connection = {
+      id: String,
+      name: String,
+      status: String,
+      created_at: String?,
+      disconnected_at: String?
+    }
+
+    # Items of GET /integrations data[].
+    type integration = {
+      type: String,
+      connected: bool,
+      connection_count: Integer,
+      primary: { id: String, name: String }?,
+      disconnected_count: Integer
+    }
+
+    # GET /integrations
+    type integrations_list = { data: Array[integration], pagination: pagination }
+
+    # GET /integrations/{type}
+    type integration_detail = {
+      type: String,
+      connected: bool,
+      connection_count: Integer,
+      connections: Array[connection],
+      disconnected_connections: Array[disconnected_connection]
+    }
+
+    # DELETE /integrations/{type}/connections/{id}
+    type disconnect_result = {
+      id: String, type: String, status: String, disconnected_at: String?
+    }
+
+    # POST /integrations/{type}/connections/{id}/test
+    type credential_test_result = {
+      id: String, type: String, credential_valid: bool,
+      tested_at: String, reason: String?
+    }
+
+    # Keyword rule (GET list items and POST response data[]).
+    # match: exact|contains
+    type keyword_applies_to = { localpart: bool, domain: bool, email: bool }
+
+    type keyword_rule = {
+      id: String,
+      keyword: String,
+      match: String,
+      applies_to: keyword_applies_to
+    }
+
+    # GET .../keywords/{list}
+    type keyword_rules_list = { data: Array[keyword_rule], pagination: pagination }
+
+    # POST .../keywords/{list}
+    type keyword_rules_created = { data: Array[keyword_rule] }
+
+    # DELETE .../keywords/{list}/{ruleId}
+    type keyword_rule_deleted = { deleted: bool, id: String }
+
+    # Input shape for keyword rule creation.
+    type keyword_rule_input = {
+      keyword: String,
+      match: String,
+      applies_to: Hash[Symbol, bool]
+    }
+
+    # POST /erasures
+    type erasure_result = { success: bool? }
+  end
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification
+name: mailfloss
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Mailfloss
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2026-07-22 00:00:00.000000000 Z
+dependencies: []
+description: Verify email addresses, run batch verifications, manage ESP integrations
+  and keyword rules, and read usage reports via the mailfloss REST API. Zero runtime
+  dependencies (stdlib Net::HTTP).
+email:
+- support@mailfloss.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- lib/mailfloss.rb
+- lib/mailfloss/client.rb
+- lib/mailfloss/errors.rb
+- lib/mailfloss/resources.rb
+- lib/mailfloss/transport.rb
+- lib/mailfloss/version.rb
+- sig/mailfloss.rbs
+- sig/resources.rbs
+- sig/types.rbs
+homepage: https://developers.mailfloss.com
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://developers.mailfloss.com
+  source_code_uri: https://github.com/mailfloss/mailfloss-ruby
+  changelog_uri: https://github.com/mailfloss/mailfloss-ruby/blob/main/CHANGELOG.md
+  bug_tracker_uri: https://github.com/mailfloss/mailfloss-ruby/issues
+  documentation_uri: https://developers.mailfloss.com
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.6'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3.1
+signing_key: 
+specification_version: 4
+summary: Official Ruby SDK for the mailfloss email verification API
+test_files: []