mailinator_client 1.0.6 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d61079f915251b975bf65147de21720b5fb852cc9c7bf332b1683180c0dfaec2
-  data.tar.gz: 10a01b3d925703e33ac2b9273bd3c47d3e25488e0ae432fa39e8e758a9a97d48
+  metadata.gz: 842259c780481a4557f43335ae76aee7983c5d61f4c191e5513c73a8c513653d
+  data.tar.gz: c6581dbcda2131ac8673899a28589c7e19c4acbd52127835a6de24aff0a7e1f8
 SHA512:
-  metadata.gz: ae1050498f67e632586b7ff037d9f37785119370819012c872a49aa30012cd02edd5e5715cf6979b3353442b4599d14f05797727c20792790f5903f942223a6a
-  data.tar.gz: a782fc068b13f790c1974c48542435b73ce270edcec4f6087fe366e97c7e6cf7a3590a45d1b1fe3598de2c200d1d16d22f86cfd9cb722aa7c2b46dc40d822d9a
+  metadata.gz: 44ff3ba0a414f96920f357d0aa9c069f3bb957dedc7fba2a1d586f79f490867c99a8a2654575b7797a3249c79e9c51fadb0ea67e1034f54e976a49fe805ce86d
+  data.tar.gz: 4ca92063bd2a63fb5e97cf0b60d54d849c4e766f282ab06c89df4860d74c6716aca3a02e2cc92c490a57c63dc9e431d8cb154a78a353e066a38b499fb41f74ba

data/.agent/rules/tdd.md

@@ -0,0 +1,7 @@
+# TDD Protocol Rules
+- **Scope:** These rules apply ONLY when the goal is "Feature Implementation" or "Bug Fix."
+- **Passive Mode:** If I am manually editing a `*.test.*` or `*_test.*` file, switch to **Passive Mode**. 
+- **Passive Mode Behavior:** - Do not trigger the Red-Green-Refactor flow.
+    - Provide autocomplete and suggestions only. 
+    - Do not ask for "Approval" to proceed.
+- **Code Preservation:** Always enforced. Never delete implementation logic unless specifically told to "Clean up" or "Refactor."

data/.agent/tdd-flow/skill.md

@@ -0,0 +1,15 @@
+---
+name: tdd-flow
+description: Strict Red-Green-Refactor agentic workflow.
+triggers:
+  - user_mentions: ["$tdd", "implement", "build feature"]
+---
+
+## Workflow Steps
+1. **Red Phase:** Write ONE failing test. Explain the failure. **STOP.**
+- Requirement: All tests generated in this phase must adhere to the Test Expectations defined in the ai_instruction file (specifically: No mocking, real HTTP requests, and semantic validation).
+2. **Green Phase:** Write the simplest possible implementation to pass that specific test. **STOP.**
+3. **Refactor Phase:** Suggest improvements to the implementation. Do not change tests.
+
+## Constraint
+- Do not jump to Step 2 until the user confirms Step 1 passes (or fails correctly).

data/.env.example

@@ -0,0 +1,25 @@
+# Mailinator API Configuration
+# Documentation: https://www.mailinator.com/documentation/docs/api/index.html
+# Visit https://www.mailinator.com/ to get your API token and configure domains
+
+MAILINATOR_TEST_API_TOKEN=
+MAILINATOR_TEST_INBOX=
+MAILINATOR_TEST_PHONE_NUMBER=
+MAILINATOR_TEST_MESSAGE_WITH_ATTACHMENT_ID=
+
+# Delete domain (WARNING: use with caution - only if you are 100% sure)
+MAILINATOR_TEST_DELETE_DOMAIN=
+
+# Webhook token configuration
+# This assumees you have multiple webhook tokens for different testing scenarios (e.g., private domain vs twilio). Adjust as needed based on your actual test setup.
+MAILINATOR_TEST_WEBHOOKTOKEN_PRIVATEDOMAIN=
+MAILINATOR_TEST_WEBHOOKTOKEN_CUSTOMSERVICE=
+
+# Authenticator configuration
+MAILINATOR_TEST_AUTH_SECRET=
+MAILINATOR_TEST_AUTH_ID=
+
+# Webhook configuration
+# Custom service might be something like "twilio" or "sendgrid"
+MAILINATOR_TEST_WEBHOOK_INBOX=
+MAILINATOR_TEST_WEBHOOK_CUSTOMSERVICE=

data/.github/copilot-instructions.md

@@ -0,0 +1,7 @@
+# TDD Instructions for Copilot
+Refer to the project standards in AGENTS.md and the rules in .agent/rules/tdd.md.
+
+## Critical Constraints:
+1. **Red-Green-Refactor:** When I ask for a feature, write a failing test FIRST. Stop and wait for me to run it. Do not provide implementation until I approve the test.
+2. **No Deletions:** Never remove implementation code, even if a test is skipped.
+3. **Minimalism:** Write only the assertions I ask for. Do not add boilerplate "safety" assertions.

data/.gitignore

@@ -21,3 +21,5 @@ test/tmp
 test/version_tmp
 tmp
 Gemfile.lock
+
+.env

data/.ruby-version

@@ -1 +1 @@
-2.7.6
+2.7.6

data/AGENTS.md

@@ -0,0 +1,9 @@
+All AI agents (Codex, Copilot, Antigravity) must adhere to the rules defined in .agent/rules/ and this file.
+
+# Project Standards & Agent Behavior
+
+- **Primary Workflow:** We use the `tdd-flow` skill for all new feature development.
+- **Test Style:** Focus on behavior-driven assertions. No mocking.
+- **Anti-Pattern Guardrail:** Do not "hallucinate" implementation for skipped tests. If a test is ignored, the underlying code must remain untouched.
+- **Language/Framework:** Ruby with RSpec for testing.
+- **Spec-Strictness:** When generating tests for the SDK, only assert properties explicitly defined in the OpenAPI specification provided. Do not invent "common sense" validations that are not codified in the schema. Call out any ambiguities or gaps in the spec for human review instead of making assumptions.

data/AI_INSTRUCTIONS.md

@@ -0,0 +1,205 @@
+# AI Instructions
+
+This document explains the relationship between this Ruby client and the Mailinator OpenAPI specification.
+
+**OpenAPI Specification:** [Found on GitHub](https://github.com/manybrain/mailinatordocs/blob/main/openapi/mailinator-api.yaml)
+
+## Codebase Structure
+
+The codebase structure in `lib/mailinator_client/` reflects Mailinator API resource groups.
+
+-   **Entrypoints:**
+    -   `lib/mailinator_client.rb` loads all components and provides module-level delegation to a singleton `Client`.
+    -   `lib/mailinator_client/client.rb` defines the HTTP execution path and shared request behavior.
+-   **Resource wrappers:** API resources live in peer files under `lib/mailinator_client/`:
+    -   `authenticators.rb` for authenticator endpoints.
+    -   `domains.rb` for domain endpoints.
+    -   `messages.rb` for inbox/message endpoints.
+    -   `rules.rb` for rule endpoints.
+    -   `stats.rb` for team/stat endpoints.
+    -   `webhooks.rb` for webhook injection endpoints.
+-   **Support files:**
+    -   `utils.rb` normalizes input/query structures.
+    -   `error.rb` defines `ResponseError`.
+    -   `version.rb` defines gem version metadata used in user agent headers.
+
+## Request Patterns
+
+This client uses a **resource wrapper** pattern, not per-operation request classes.
+
+-   Each resource class exposes Ruby methods (for example, `fetch_inbox`, `get_domains`, `create_rule`) that:
+    -   accept a params hash,
+    -   validate required keys with `ArgumentError`,
+    -   construct `path`, `query`, and optional `body`,
+    -   call `@client.request(...)`.
+-   Method names are snake_case and generally map to one API operation each.
+-   Paths are resource-relative and are joined to the client base URL (`https://api.mailinator.com/api/v2`) inside `Client#request`.
+
+## Execution
+
+Requests are executed through `MailinatorClient::Client#request`, which uses `HTTParty`.
+
+```ruby
+client = MailinatorClient::Client.new(auth_token: "api_token")
+response = client.messages.fetch_inbox(domain: "domain.com", inbox: "inbox_name")
+```
+
+Execution flow:
+-   Resource method builds request inputs (`method`, `path`, `query`, `headers`, `body`).
+-   `Client#request` appends the path to `https://api.mailinator.com/api/v2`.
+-   `HTTParty.send` performs the HTTP call with JSON headers and optional authorization.
+-   Non-2xx/3xx responses raise `MailinatorClient::ResponseError`.
+
+## Entities
+
+This Ruby SDK mostly returns parsed response hashes/arrays directly, rather than strongly typed model classes.
+
+-   API responses are returned as Ruby data structures from `HTTParty` (`Hash`/`Array`).
+-   Error responses are wrapped in `MailinatorClient::ResponseError` with:
+    -   `code` (HTTP status),
+    -   `type` (error type from API payload),
+    -   exception message from the API response.
+-   Request inputs are plain Ruby hashes, typically normalized by `Utils.symbolize_hash_keys`.
+
+---
+
+## Gap Analysis Workflow
+
+Use this workflow whenever you want to audit the SDK against the OpenAPI spec, identify missing or extra coverage, and bring the two into alignment.
+
+### Step 1 — Fetch the OpenAPI Specification
+
+Retrieve the raw YAML from:
+
+```
+https://raw.githubusercontent.com/manybrain/mailinatordocs/main/openapi/mailinator-api.yaml
+```
+
+> The rendered GitHub page is at https://github.com/manybrain/mailinatordocs/blob/main/openapi/mailinator-api.yaml
+> but always read the **raw** URL for machine parsing.
+
+Extract every `paths` entry. For each path, record:
+- The HTTP method (`get`, `post`, `put`, `delete`, etc.)
+- The full path string (e.g. `/api/v2/domains/{domain}/inboxes/{inbox}`)
+- The `operationId`
+- The tag (maps to the SDK module directory)
+- All query parameters defined under `parameters`
+
+### Step 2 — Catalog the SDK
+
+For each resource file under `lib/mailinator_client/` (`messages.rb`, `domains.rb`, `rules.rb`, etc.):
+1. Enumerate every public method that issues `@client.request(...)`.
+2. Identify the HTTP method (`:get`, `:post`, `:put`, `:delete`).
+3. Extract the `path` template used by that method.
+4. Record query parameters populated in `query_params`.
+5. Note methods already marked deprecated in comments/docs.
+
+Also map resource files to OpenAPI tags and check if any tag has no SDK wrapper.
+
+### Step 3 — Identify Gaps
+
+Produce a gap report with four sections:
+
+#### A. In the spec but missing from the SDK
+List every `operationId` that has no corresponding Ruby method. This is what needs to be **added**.
+
+#### B. In the SDK but not in the spec
+List every SDK method whose path+method has no matching entry in the spec.
+- If it is already marked deprecated, note that separately.
+- If it is not deprecated but absent from the spec, flag it for clarification (it may be undocumented).
+
+#### C. URL path mismatches
+Compare the base path used by each SDK method against the spec.
+- The spec base URL is `https://api.mailinator.com` and all paths start with `/api/v2/`.
+- The SDK **must** use `/api/v2/` not `/v2/`. Flag any method/path using the wrong prefix.
+
+#### D. Query parameter gaps
+For each existing SDK method, compare sent query parameters against the spec's declared parameters for that operation. List any missing parameters.
+
+#### Exception — Domain Listing
+The OpenAPI operation `GET /api/v2/domains/{domain}/inboxes` (list domain messages) is considered **covered** by `messages.fetch_inbox` when called with `inbox: "*"`. Do not treat this as a missing SDK method in future gap analyses.
+
+### Step 4 — Build a Plan
+
+Before making any changes, write out a plan that includes:
+
+1. **New methods to add** — one method per missing `operationId`, grouped by resource file.
+2. **URL fixes** — list every file where the prefix needs to change from `/v2/` to `/api/v2/`.
+3. **Query parameter additions** — list every file and which parameters to add.
+4. **Deprecated methods** — decide whether to keep and mark as deprecated or remove. Do not remove without confirmation.
+5. **Response/entity notes** — list response shape expectations or wrappers needed for consistency.
+
+Present the plan to the user and wait for approval before proceeding.
+
+### Step 5 — Implement
+
+Follow the existing patterns in the codebase:
+
+#### Adding a new method
+
+Use an existing method in the matching resource file as a template.
+
+```ruby
+def get_example(params = {})
+  params = Utils.symbolize_hash_keys(params)
+  query_params = {}
+  headers = {}
+  body = nil
+
+  raise ArgumentError.new("domain is required") unless params.has_key?(:domain)
+  raise ArgumentError.new("id is required") unless params.has_key?(:id)
+
+  path = "/domains/#{params[:domain]}/examples/#{params[:id]}"
+
+  @client.request(
+    method: :get,
+    path: path,
+    query: query_params,
+    headers: headers,
+    body: body
+  )
+end
+```
+
+Key rules:
+- **Always** use `/api/v2/` as the path prefix — never `/v2/`.
+- Keep methods in the appropriate resource file (`messages.rb`, `rules.rb`, etc.).
+- Validate required params with `ArgumentError`.
+- Use snake_case method names and preserve existing naming conventions in the file.
+
+#### Fixing a URL prefix
+
+If any hardcoded URL includes `/v2/`, change it to `/api/v2/`. Prefer resource-relative `path` values (`/domains/...`) and let `Client#request` prepend base URL.
+
+#### Adding a missing query parameter
+
+Add an assignment in the method's query assembly:
+```ruby
+query_params[:my_param] = params[:myParam] if params.has_key?(:myParam)
+```
+Then document the optional parameter in the method comment block.
+
+### Step 6 — Verify
+
+After implementing:
+1. Run tests: `ruby -I test test/mailinator_client_api_test.rb` (with required env vars).
+2. Run lint/static checks if configured for this repo.
+3. Manually verify at least one changed method generates the exact spec path and sends expected query params.
+
+### Notes on SDK Conventions
+
+| Convention | Detail |
+|---|---|
+| Version source | `lib/mailinator_client/version.rb` (`MailinatorClient::VERSION`), referenced by gemspec and user-agent string. |
+| Auth header | Set in `Client#request` as `Authorization` when `auth_token` is provided. |
+| No-token requests | Supported by instantiating `Client` without `auth_token` (used by some webhook flows). |
+| Deprecation marker | Use Ruby/YARD style deprecation comments near method definitions and reflect in README/docs. |
+| Entrypoint loading | `lib/mailinator_client.rb` requires resource/support files and delegates module methods to singleton client. |
+
+### Test Expectations
+
+- Integration tests should exercise real HTTP requests to Mailinator endpoints. Do not use request-mocking tools (for example, `WebMock.stub_request`) for endpoint coverage tests.
+- Assertions must validate response semantics, not just existence. Prefer checking:
+  - expected HTTP success behavior (or explicit failure with returned status code),
+  - expected JSON shape (required keys),
+  - important field-level values (for example, IDs or arrays) relevant to the endpoint contract.

data/CHANGELOG.md

@@ -0,0 +1,65 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project aims to follow [Semantic Versioning](https://semver.org/).
+
+## [1.1.0]
+
+### Changed
+
+- Added `messages.fetch_message_summary` for `GET /api/v2/domains/{domain}/messages/{messageId}/summary`.
+- Added `messages.fetch_message_text` for `GET /api/v2/domains/{domain}/messages/{messageId}/text`.
+- Added `messages.fetch_message_textplain` for `GET /api/v2/domains/{domain}/messages/{messageId}/textplain`.
+- Added `messages.fetch_message_texthtml` for `GET /api/v2/domains/{domain}/messages/{messageId}/texthtml`.
+- Added `messages.fetch_message_headers` for `GET /api/v2/domains/{domain}/messages/{messageId}/headers`.
+- Added `messages.stream_domain_messages` for `GET /api/v2/domains/{domain}/stream`.
+- Added `messages.stream_inbox_messages` for `GET /api/v2/domains/{domain}/stream/{inbox}`.
+- Removed `wait` query parameter from `messages.fetch_sms_message` because the endpoint does not support it.
+- Removed `wait` query parameter from `messages.fetch_inbox`.
+- Fixed `webhooks.private_webhook` to include the webhook payload in the request body.
+- Debugging and test updates.
+- Made attachment download tests derive attachment IDs from the attachments list, removing the need for `MAILINATOR_TEST_ATTACHMENT_ID`.
+- Documented that `GET /domains/{domain}/inboxes` is covered by `messages.fetch_inbox` with `inbox: "*"`.
+
+## [1.0.7]
+
+### Added
+
+- Optional `delete` query parameter support to `messages.fetch_inbox_message`.
+- Inbox-list query parameters to `messages.fetch_sms_message` (`skip`, `limit`, `sort`, `decode_subject`, `cursor`, `full`, `delete`).
+- `.env.example` with Mailinator integration test variables.
+- Resource-scoped integration test files:
+  - `test/authenticators_api_test.rb`
+  - `test/domains_api_test.rb`
+  - `test/messages_api_test.rb`
+  - `test/rules_api_test.rb`
+  - `test/stats_api_test.rb`
+  - `test/webhooks_api_test.rb`
+- Focused query-parameter regression tests in `test/messages_query_params_test.rb`.
+
+### Deprecated
+
+- Marked all Rules endpoints as deprecated:
+  - `client.rules.create_rule`
+  - `client.rules.enable_rule`
+  - `client.rules.disable_rule`
+  - `client.rules.get_all_rules`
+  - `client.rules.get_rule`
+  - `client.rules.delete_rule`
+- Marked Domain mutation endpoints as deprecated:
+  - `client.domains.create_domain`
+  - `client.domains.delete_domain`
+- Added deprecation markers in code (`lib/mailinator_client/rules.rb`) and deprecation notices in docs (`docs/rules.md`, `README.md`).
+
+### Changed
+
+- Updated dependency constraints:
+  - Runtime: `httparty` to `>= 0.21, < 0.22` (Ruby 2.6-compatible)
+  - Development: `minitest >= 5.25, < 7.0`, `rake >= 13.0, < 14.0`, `webmock >= 3.26, < 4.0`
+- Updated integration testing structure by splitting the previous monolithic `test/mailinator_client_api_test.rb`.
+- Added `.env` loading support in `test/test_helper.rb`.
+- Hardened API error handling for non-JSON/empty error responses:
+  - `MailinatorClient::ResponseError` now handles `nil` parsed responses safely.
+  - `Client#request` now passes raw response body into `ResponseError`.

data/EXAMPLES.md

@@ -0,0 +1,11 @@
+# Examples
+
+This document will collect practical usage examples for the Mailinator Ruby client.
+
+## Planned Sections
+
+- Authentication setup
+- Domain and inbox operations
+- Message retrieval and parsing
+- Webhooks and rules
+- Error handling patterns

data/README.md

@@ -1,12 +1,17 @@
-# Mailinator Ruby REST API Client
+# Mailinator Ruby SDK
 
-[![Build Status](https://travis-ci.org/manybrain/mailinator-ruby-client.svg?branch=master)](https://travis-ci.org/manybrain/mailinator-ruby-client)  [![Gem Version](https://badge.fury.io/rb/mailinator_client.svg)](https://badge.fury.io/rb/mailinator_client)
+The official Mailinator Ruby SDK. This REST API client is implemented as a thin wrapper around the [Mailinator API](https://www.mailinator.com/documentation/docs/api/index.html). The OpenAPI specification is the source of truth.
 
-The [Mailinator](https://www.mailinator.com/) REST API client provides a simple way to use the comprehensive Mailinator API.
+[![Gem Version](https://badge.fury.io/rb/mailinator_client.svg)](https://badge.fury.io/rb/mailinator_client)
 
-This client works with Ruby 2.1 and higher. It uses [HTTParty](https://github.com/jnunemaker/httparty) under the covers for the actual HTTP communication.
+> [!NOTE]
+> This client works with Ruby 2.1 and higher. It uses [HTTParty](https://github.com/jnunemaker/httparty) under the covers for the actual HTTP communication.
 
-<br/>
+
+
+## API Reference
+
+See [Mailinator's API Reference](https://www.mailinator.com/documentation/docs/api/index.html) for all of the currently available API endpoints.
 
 ## Installation
 
@@ -56,6 +61,7 @@ Each of the following is a method on the client object, and returns a wrapper fo
 
 * [rules](docs/rules.md)  
   Contains all of the actions that can be performed against the set of [Rules](https://manybrain.github.io/m8rdocs/#rules-api) that the currently authenticated user has access to - such as listing the rules or creating a new rule.
+  **Deprecated:** Rules endpoints in this SDK are deprecated.
 
 * [messages](docs/messages.md)  
   Contains all of the actions that can be performed against the set of [Messages](https://manybrain.github.io/m8rdocs/#message-api) that the currently authenticated user has access to - such as listing the messages or injecting a new message.
@@ -84,12 +90,18 @@ When the Mailinator API returns a unsuccessful response, an instance of Response
 
 ## Testing
 
-Run integration tests with real API Key.
+Run individual integration tests with real API Key.
 
 ```ruby
 ruby -I test test/mailinator_client_api_test.rb
 ```
 
+OR run them all:
+
+```ruby
+bundle exec rake test
+```
+
 Most of the tests require env variables with valid values. Visit tests source code and review `mailinator_client_api_test.rb` file. The more env variables you set, the more tests are run.
 
 * `MAILINATOR_TEST_API_TOKEN` - API tokens for authentication; basic requirement across many tests;see also https://manybrain.github.io/m8rdocs/#api-authentication
@@ -104,10 +116,3 @@ Most of the tests require env variables with valid values. Visit tests source co
 * `MAILINATOR_TEST_AUTH_ID` - authenticator id
 * `MAILINATOR_TEST_WEBHOOK_INBOX` - inbox for webhook
 * `MAILINATOR_TEST_WEBHOOK_CUSTOMSERVICE` - custom service for webhook
-
-
-*****
-
-Copyright (c) 2024 Manybrain, Inc
-
-<https://www.mailinator.com/>

data/ROADMAP.md

@@ -0,0 +1,58 @@
+# Roadmap
+
+This document tracks completed work, current gaps, and planned improvements for the Mailinator Ruby client.
+
+Gap analysis source of truth: Mailinator OpenAPI spec (`version: 2026-03-04`) from:
+`https://raw.githubusercontent.com/manybrain/mailinatordocs/main/openapi/mailinator-api.yaml`
+
+## Hardening (Phase 3)
+
+- [ ] Produce and maintain endpoint coverage matrix (OpenAPI operationId -> SDK method)
+- [ ] Add CI check to detect future OpenAPI drift against SDK path+method map
+- [ ] Define policy for operations present in SDK but missing from spec:
+  - [ ] keep + mark deprecated
+  - [ ] keep + annotate as undocumented
+  - [ ] remove in next major release (requires explicit approval)
+- [ ] Define policy for flaky/500-prone integration flows (`messages.fetch_inbox` with `full`/`wait`, `webhooks.private_webhook`):
+  - [ ] gate by env vars and/or quarantine tags
+  - [ ] separate smoke and full integration suites
+
+Webhooks (`lib/mailinator_client/webhooks.rb`):
+- [ ] Add domain-scoped webhook methods matching spec routes
+- [ ] Keep existing private-webhook methods for backward compatibility until deprecation decision is approved
+
+- [ ] Fix messages_api_test.rb. Split up into multiple files if needed to isolate new test cases and avoid timeouts. Assert on the body of the responses. 
+- [ ] Fix integration test bug: use `MAILINATOR_TEST_WEBHOOKTOKEN_CUSTOMSERVICE` for custom-service webhook tests
+- [ ] Add explicit assertions for custom-service webhook calls
+- [ ] Update README/docs links to current API reference and remove stale `manybrain.github.io/m8rdocs` links
+- [ ] Align docs arg naming with SDK (`domain`, `inbox`, `messageId`)
+
+
+## Completed (Phase 1)
+
+- [x] Add structural docs (`ROADMAP.md`, `CHANGELOG.md`, `AI_INSTRUCTIONS.md`, `EXAMPLES.md`)
+- [x] Update outdated dependencies (`rake` and `webmock`; `httparty` pinned to latest Ruby 2.6-compatible range)
+- [x] Update version number (`1.0.7`)
+- [x] Publish those changes (minor release)
+- [x] Add optional query parameter support:
+  - `messages.fetch_inbox_message` supports optional `delete`
+  - `messages.fetch_sms_message` supports inbox listing query params (`skip`, `limit`, `sort`, `decode_subject`/`decodeSubject`, `cursor`, `full`, `wait`, `delete`)
+- [x] Mark deprecated endpoints as deprecated in code/docs:
+  - Rules endpoints
+  - `client.domains.create_domain` and `client.domains.delete_domain`
+
+## Completed (Phase 2)
+
+### Added Missing Spec Endpoints
+
+Messages (`lib/mailinator_client/messages.rb`):
+- [x] Add `fetch_message_summary` for `GET /domains/{domain}/messages/{messageId}/summary`
+- [x] Add `fetch_message_text` for `GET /domains/{domain}/messages/{messageId}/text`
+- [x] Add `fetch_message_text_plain` for `GET /domains/{domain}/messages/{messageId}/textplain`
+- [x] Add `fetch_message_text_html` for `GET /domains/{domain}/messages/{messageId}/texthtml`
+- [x] Add `fetch_message_headers` for `GET /domains/{domain}/messages/{messageId}/headers`
+- [x] Add `stream_domain_messages` for `GET /domains/{domain}/stream`
+- [x] Add `stream_inbox_messages` for `GET /domains/{domain}/stream/{inbox}`
+- [x] Add `list_domain_messages` for `GET /domains/{domain}/inboxes` (covered by `messages.fetch_inbox` with `inbox: "*"`)
+
+Note: We are intentionally not adding a separate SDK method for `GET /domains/{domain}/inboxes`. The existing `messages.fetch_inbox` with `inbox: "*"` provides equivalent domain-wide listing. Future gap analyses should treat this as covered.

data/docs/domains.md

@@ -37,6 +37,9 @@ puts result
 
 ## CreateDomain
 
+> [!WARNING]
+> Deprecated in this SDK.
+
 This endpoint creates a private domain attached to your account. Note, the domain must be unique to the system and you must have not reached your maximum number of Private Domains.
 
 ```ruby
@@ -49,6 +52,9 @@ puts result
 
 ## DeleteDomain
 
+> [!WARNING]
+> Deprecated in this SDK.
+
 This endpoint deletes a Private Domain
 
 ```ruby

data/docs/rules.md

@@ -2,6 +2,9 @@
 
 Details on the various actions that can be performed on the Rules resource, including the expected parameters and the potential responses.
 
+> [!WARNING]
+> All Rules endpoints in this SDK are deprecated.
+
 ##### Contents
 
 *   [CreateRule](#createrule)
@@ -13,7 +16,7 @@ Details on the various actions that can be performed on the Rules resource, incl
 
 <br/>
 
-## CreateRule
+## CreateRule (Deprecated)
 
 Creates a Rule
 
@@ -28,7 +31,7 @@ puts result
 
 <br/>
 
-## EnableRule
+## EnableRule (Deprecated)
 
 Enables an existing Rule
 
@@ -42,7 +45,7 @@ puts result
 
 <br/>
 
-## DisableRule
+## DisableRule (Deprecated)
 
 Disables an existing Rule
 
@@ -56,7 +59,7 @@ puts result
 
 <br/>
 
-## GetAllRules
+## GetAllRules (Deprecated)
 
 Fetches all Rules for a Domain
 
@@ -68,7 +71,7 @@ puts result
 
 <br/>
 
-## GetRule
+## GetRule (Deprecated)
 
 Fetches a specific rule for a Domain
 
@@ -82,7 +85,7 @@ puts result
 
 <br/>
 
-## DeleteRule
+## DeleteRule (Deprecated)
 
 Deletes a specific rule for a Domain
 

data/lib/mailinator_client/authenticators.rb

@@ -1,25 +1,3 @@
-# The MIT License (MIT)
-#
-# Copyright (c) 2024 Manybrain, Inc.
-#
-# Permission is hereby granted, free of charge, to any person obtaining a copy
-# of this software and associated documentation files (the "Software"), to deal
-# in the Software without restriction, including without limitation the rights
-# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-# copies of the Software, and to permit persons to whom the Software is
-# furnished to do so, subject to the following conditions:
-#
-# The above copyright notice and this permission notice shall be included in all
-# copies or substantial portions of the Software.
-#
-# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-# SOFTWARE.
-
 require "json"
 
 module MailinatorClient