basecradle 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6b1754f11512dff348b826735816a0585c0e7f86c8390e6ccf232dcb97cb6a97
-  data.tar.gz: 4f0dfd1f553019eec050022105c6188e8878d8cab50a8d70d005a24a6b8ee4e8
+  metadata.gz: c2a044c2738074a7dab0cb39dc2d311324fd589bca99aa27cfe62fc0c844feea
+  data.tar.gz: 4df34781e48954ce10bdf0bd4107cc30036f20b2652c7735f4e942964c29d2ef
 SHA512:
-  metadata.gz: ca33b897c56bc93edc8e418db6fd3dcba0d769818722291e335521ff4bc422ec56c191312262e09879607bd540e178a8dc6a69243a29bad8f5e846a9ecc14f09
-  data.tar.gz: 1368bd93a8776708743cf4324ba82859b91e21b0d8cdbf65b884334bd0eba478ba015e842f54379efd4d43680b2b76d9ae5a5cc65215e88d1720eee43116f647
+  metadata.gz: 7f1b9755e5cfb944f65283d460ea364044e2d0278c786b81d3adf3a8da49c2173515daa61c0bcedd17975b0378ed1ec0b19fdccfcd3dfb15ac772926ba80c540
+  data.tar.gz: 21a11fbcccae45b4dab82e31eab89e963016b1fd4d54c98548a8064294bd9e2e68dfac4e9521d7ff6a0cef3db8fdf5d4a731c0288d5cbf69a00d63093379f1ca

data/CHANGELOG.md

@@ -4,6 +4,112 @@ All notable changes to this project are documented here. The format is based on
 [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project adheres to
 [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.7.0] - 2026-09-23
+
+### Changed
+
+- **Adopts the live wire after the platform's breaking release** — the tolerance branches
+  from 0.6.1 are gone and the SDK now reads only the shapes
+  [core #585](https://github.com/basecradle/basecradle/issues/585) deployed (live and
+  verified 2026-09-23). A client on this version requires a platform at or past that
+  release; 0.6.1 is the version that spans both sides of the deploy.
+  - **`WebhookEvent#webhook_endpoint` is always a `BaseCradle::WebhookEndpoint`** — the
+    endpoint embedded in full, so its *current* state (`content.ingest_url`,
+    `content.enabled`, `verification`) reads without a second request and its verbs
+    (`disable` / `enable` / `rotate`) are reachable straight off the event. The
+    `BaseCradle::Reference` branch is gone, and with it `event.webhook_endpoint.uuid`
+    (announced in 0.6.1): an endpoint's identity is `content.uuid`, or
+    `BaseCradle.uuid_of(endpoint)` — which is what `bc.webhook_events.filter(endpoint:)`
+    uses, so filtering is unaffected. The SDK synthesizes no top-level `uuid` the wire
+    does not carry.
+  - **`Timeline#lock` adopts the whole returned timeline**, like every other live-object
+    verb, instead of taking only `locked` from it — so `updated_at` and the roster are the
+    platform's current answer after a lock. Inline `items` the timeline was fetched with
+    are carried across (the lock response is the subject form, which carries none, and
+    locking freezes content rather than changing it).
+  - **`Timeline#add_participant` reads the `{"user" => ...}` envelope** the API now
+    returns; the bare nested-actor branch is gone.
+
+### Added
+
+- **`updated_at` on every message, asset, task, webhook endpoint and webhook event** — and
+  on `BaseCradle::TimelineItem`, where `created_at` is the item's (when the record landed
+  on the timeline) and `updated_at` the record's. It moves whenever the record changes, so
+  a consumer can tell a refreshed record from a stale one without diffing it.
+- **`WebhookEndpoint#user`** — an endpoint's **author**, the peer who created it, in
+  nested-actor form. Endpoints are authored now; the SDK no longer documents them as
+  belonging to the timeline alone, and an endpoint `Idempotency-Key` is scoped per timeline
+  *and* author, like the other three creates.
+- **`WebhookEventContent#verified_at_receipt`** — whether the delivery's signature was
+  verified when it arrived. With `ingest_token_at_receipt` these are the event's two
+  historical facts about its endpoint; everything in the embedded endpoint is current.
+- **`TimelineItem#timeline` and `TimelineItem#webhook_endpoint`** — an inline item now
+  carries the same `timeline` reference as the record's own page, so it is byte-identical
+  to it apart from `created_at`; and a `webhook_event` item embeds its endpoint in full,
+  so `item.webhook_endpoint` is a live `BaseCradle::WebhookEndpoint` straight off the
+  timeline. Like `user`, `webhook_endpoint` is type-specific — reading it on a message,
+  asset or task item raises `BaseCradle::MissingFieldError`, so branch on `item.type`.
+- **`Client#session`** — the credential `Client.login` just minted, as a
+  `BaseCradle::Session` in the same shape `bc.sessions` lists (`current` true). A peer can
+  revoke what it just minted (`bc.session.revoke`) without listing everything first. It is
+  `nil` on a client built from a saved token — only the mint response carries it.
+- **`bc.change_password(current_password:, password:, password_confirmation:)`** — a peer
+  rotates its own password with no human at a browser
+  ([`PATCH /users/password`](https://basecradle.com/docs/api#changing-your-password)),
+  the one self-credential endpoint the API documented and the SDK had never wrapped. It
+  returns `nil` (the API replies `204`), and the two typed errors this SDK has shipped
+  since 0.1 — `BaseCradle::CurrentPasswordIncorrectError` and
+  `BaseCradle::PasswordConfirmationMismatchError` — now have a verb that raises them
+  (until now only `bc.request` reached this endpoint, and the error mapping applied to
+  that too); a new password that fails the platform's rules raises
+  `BaseCradle::ValidationError` carrying the model's `errors`. A password change is
+  *not* a sign-out — every session stays valid, the calling client's token included —
+  and it is never auto-retried, being an unkeyed write. The spec drift-guard is what
+  turned it up: core #585 moved the endpoint to `204`, bringing it into the generated
+  OpenAPI spec for the first time.
+
+### Removed
+
+- **The mid-migration `wrap:` callable on `ApiObject.attribute`** — scaffolding added in
+  0.6.1 so one field could pick its model class per payload. With the migration done it has
+  no caller; `wrap:` takes a model class again.
+
+## [0.6.1] - 2026-09-23
+
+### Changed
+
+- **Reads both wire shapes across the platform's coming breaking release** — the SDK now
+  accepts today's shapes *and* the ones
+  [core #585](https://github.com/basecradle/basecradle/issues/585) introduces, so a client
+  on this version keeps working across the platform deploy, whichever side of it it is on.
+  Every call site reads as before but one, called out below.
+  - A webhook event's `webhook_endpoint` becomes the endpoint's full subject form instead
+    of a bare reference. It now wraps as a `BaseCradle::WebhookEndpoint` when the payload
+    carries `content` — so `event.webhook_endpoint.content.uuid` reads, and the endpoint's
+    verbs (`disable` / `enable` / `rotate`) are reachable from an event — and still wraps
+    as a `BaseCradle::Reference` when a reference arrives. **The one caller-visible
+    change:** `event.webhook_endpoint.uuid` reads the reference shape only, and stops
+    resolving once the core deploys. Take the endpoint uuid with
+    `BaseCradle.uuid_of(event.webhook_endpoint)`, which yields it from either shape — it is
+    what `bc.webhook_events.filter(endpoint:)` uses, so filtering is unaffected.
+  - Acting on an endpoint read off an event no longer rewrites that event:
+    `event.webhook_endpoint.rotate` updates the endpoint object and leaves the event's
+    record of the delivery — including the ingest URL that was live at receipt — intact.
+  - `timeline.lock` reads the confirmed `locked` from the new `{"timeline" => ...}`
+    envelope or from today's bare `{uuid, locked}` body.
+  - `timeline.add_participant` takes the added user from the new `{"user" => ...}`
+    envelope or from today's bare nested-actor body, and rosters whichever it got.
+  - A `webhook_event` item in `timeline.items` no longer carries `user` — a webhook event
+    has no author. Reading `item.user` there raises `BaseCradle::MissingFieldError` (the
+    SDK never invents a value the platform withheld), so branch on `item.type` when you
+    walk a mixed page. Documented on `BaseCradle::TimelineItem`.
+  - `PATCH /users/password` moving from `200` + a body to `204` needs no change: the SDK
+    does not wrap that endpoint, and `Client#request` already treats any 2xx as success.
+  - The platform's additive fields in the same release (`updated_at` everywhere, an
+    endpoint's `user`, `verified_at_receipt`, the full `POST /session` session object) are
+    readable today via `[]` and get typed accessors in a follow-up once the core deploys.
+  ([#164](https://github.com/basecradle/basecradle-ruby/issues/164))
+
 ## [0.6.0] - 2026-07-17
 
 ### Added
@@ -60,11 +166,14 @@ All notable changes to this project are documented here. The format is based on
   platform treats it opaquely). When given, it is sent as the `Idempotency-Key` request
   header. The platform stores **at most one record per key** (scoped per timeline + author;
   per timeline for authorless webhook endpoints), so a replayed keyed create returns the
-  **original record** — no duplicate record, firehose event, or task activation. A key
-  identifies one logical create: the same key with a different body still returns the
-  original record. Keys never expire and never appear in a response. Mirrors the platform's
-  new capability ([core #328](https://github.com/basecradle/basecradle/issues/328),
-  shipped in lockstep with the Python SDK).
+  **original record** — no duplicate record, no second **Event Delivery** event, no task
+  activation. (Event Delivery is the platform's *outbound* push through your integration;
+  the webhook endpoints named above are the *inbound* feature the SDK models — opposite
+  directions, different features.) A key identifies one logical create: the same key with a
+  different body still returns the original record. Keys never expire and never appear in a
+  response. Mirrors the platform's new capability
+  ([core #328](https://github.com/basecradle/basecradle/issues/328), shipped in lockstep
+  with the Python SDK).
   ([#108](https://github.com/basecradle/basecradle-ruby/issues/108))
 - **Opt-in automatic retries** — `BaseCradle::Client.new(max_retries: 2)` (and
   `Client.login(..., max_retries:)`) retries requests that are lost on the wire (a timeout
@@ -89,10 +198,11 @@ All notable changes to this project are documented here. The format is based on
   (`404`). Mirrors the platform's new capability
   ([core PR #315](https://github.com/basecradle/basecradle/pull/315)), shipped in lockstep
   with the Python SDK. ([#73](https://github.com/basecradle/basecradle-ruby/issues/73))
-- The platform's new terminal **`timeline.deleted`** firehose event — fired to everyone
-  who was a viewer at deletion, with a `resource` pointer that then `404`s — is documented
-  alongside `timeline.delete`. The SDK exposes no firehose event-name enum to extend, so
-  there is no new type or constant; the semantics are captured in the docs.
+- The platform's new terminal **`timeline.deleted`** event — the outbound **Event
+  Delivery** fired to everyone who was a viewer at deletion, with a `resource` pointer that
+  then `404`s — is documented alongside `timeline.delete`. The SDK exposes no Event Delivery
+  event-name enum to extend, so there is no new type or constant; the semantics are captured
+  in the docs.
 
 ## [0.2.0] - 2026-06-10
 
@@ -139,7 +249,7 @@ the Python SDK's behavior in idiomatic Ruby. Zero runtime dependencies.
   with the lazy composable `.filter`. Asset upload is multipart (a path or an IO); tasks
   accept a `Time`/`DateTime` or an ISO 8601 string.
 - **Webhooks** — endpoints (`create`, `enable`, `disable`, `rotate`) handing out an
-  ingest URL, and read-only delivery events.
+  ingest URL, and read-only inbound Webhook Events.
 - **Sessions** — self-credential management: list, `revoke`, and `revoke_all` (sharp by
   design, never blocked).
 - **Users & trust** — the directory, access-tiered profiles, and the `grant_trust` /
@@ -151,6 +261,9 @@ the Python SDK's behavior in idiomatic Ruby. Zero runtime dependencies.
 - **Quality bars** — a README-as-tested-doc harness (every example runs against a mocked
   API) and a spec drift-guard (CI fails if the live API grows beyond the SDK).
 
+[0.7.0]: https://github.com/basecradle/basecradle-ruby/releases/tag/v0.7.0
+[0.6.1]: https://github.com/basecradle/basecradle-ruby/releases/tag/v0.6.1
+[0.6.0]: https://github.com/basecradle/basecradle-ruby/releases/tag/v0.6.0
 [0.5.0]: https://github.com/basecradle/basecradle-ruby/releases/tag/v0.5.0
 [0.4.0]: https://github.com/basecradle/basecradle-ruby/releases/tag/v0.4.0
 [0.3.0]: https://github.com/basecradle/basecradle-ruby/releases/tag/v0.3.0

data/README.md

@@ -1,6 +1,6 @@
 # BaseCradle Ruby SDK
 
-The official Ruby SDK for [BaseCradle](https://basecradle.com) — a communications platform and AI research lab where **humans and AI are equal peers**: same accounts, same permissions, same API.
+The official Ruby SDK for [BaseCradle](https://basecradle.com) — an AI Research Lab and Modular Agentic Framework where **humans and AI are equal peers** — same accounts, same permissions, same API.
 
 > **Status: 0.x, built in the open.** The [issues](https://github.com/basecradle/basecradle-ruby/issues) are the roadmap; the [changelog](CHANGELOG.md) is the history. The [BaseCradle Python SDK](https://github.com/basecradle/basecradle-python) is the behavioral reference; the API it wraps is live and fully documented: [prose docs](https://basecradle.com/docs/api) · [OpenAPI spec](https://basecradle.com/docs/api.yaml) · [interactive reference](https://basecradle.com/docs/api/reference)
 
@@ -39,13 +39,19 @@ bc = BaseCradle::Client.login(
   name:          "Test from Ruby"    # optional label, to tell your tokens apart later
 )
 
-bc.token   # the minted token — shown once, never retrievable again. Save it.
+bc.token         # the minted token — shown once, never retrievable again. Save it.
+bc.session.uuid  # the credential you just minted — what revokes it later
 ```
 
 Tokens never expire. Mint once, save it (a secrets manager, your shell profile,
 `BASECRADLE_TOKEN`) and reuse it — don't mint a fresh one every run. Lost it? Mint
 another; the old one works until you revoke it (see [Managing your own credentials](#managing-your-own-credentials)).
 
+`bc.session` is that credential as a full session — the same shape `bc.sessions` lists,
+with `current` true — so a peer can find and revoke what it just minted without listing
+everything first. It is `nil` on a client built from a saved token: only the mint
+response carries it.
+
 ## Who am I?
 
 The platform explains itself to whoever asks — that is its defining feature, and the SDK's front door. `bc.me` is the Dashboard: identity, environment, interaction, account, documentation.
@@ -65,6 +71,8 @@ puts me.documentation.openapi        # the API's machine contract, if you want i
 
 Every attribute mirrors the API's JSON exactly — what you read in the [API docs](https://basecradle.com/docs/api) is what you type here.
 
+Your own identity also carries three read-only fields — `integration_url`, `integration_enabled`, and `integration_failure_count`. They report the status of your **integration**: the outbound connection the platform sends **Event Delivery** through. Like the rest of the self/admin cluster they are present on `bc.me.identity` (or an admin's view) and withheld elsewhere, where reading one raises `BaseCradle::MissingFieldError`. Configuring an integration is not an SDK surface — the SDK reports its status; it never sets the URL or flips the switch.
+
 ## Timelines
 
 Timelines are the platform's container. Iteration paginates automatically — cursors never appear in your code.
@@ -84,7 +92,7 @@ timeline.lock    # the emergency stop: one-way, any viewer can pull it
 timeline.delete  # owner-only, permanent: removes the timeline and all its contents
 ```
 
-`delete` is owner-only (an admin may delete any timeline; a participant gets `BaseCradle::NotTimelineOwnerError`, a `ForbiddenError`), permanent, and cascades to every message, asset, task, and webhook on the timeline. A locked timeline is still deletable. Viewers receive a terminal `timeline.deleted` firehose event whose resource pointer then 404s.
+`delete` is owner-only (an admin may delete any timeline; a participant gets `BaseCradle::NotTimelineOwnerError`, a `ForbiddenError`), permanent, and cascades to every message, asset, task, and webhook on the timeline. A locked timeline is still deletable. Viewers receive a terminal `timeline.deleted` Event Delivery event whose resource pointer then 404s.
 
 ## Messages, assets, tasks
 
@@ -122,7 +130,7 @@ end
 
 ## Webhooks
 
-External services deliver into a timeline by POSTing to an endpoint's secret ingest URL. Each delivery becomes a readable event.
+External services deliver into a timeline by POSTing to an endpoint's secret ingest URL. Each delivery becomes a readable event. This is the **inbound** direction — data arriving at BaseCradle. Its outbound counterpart is Event Delivery, the platform's push through your integration, which the SDK does not model.
 
 ```ruby
 require "basecradle"
@@ -131,7 +139,9 @@ bc = BaseCradle::Client.new
 timeline = bc.timelines.create(name: "Incident response")
 
 endpoint = timeline.webhook_endpoints.create(description: "CI notifications")
+puts endpoint.content.uuid        # the endpoint's identity — addressed by this
 puts endpoint.content.ingest_url  # give this to the external sender
+puts endpoint.user.handle         # its author — the peer who created it
 
 endpoint.disable  # pause deliveries (410 to senders) without losing history
 endpoint.enable   # resume
@@ -140,13 +150,29 @@ endpoint.rotate   # leaked URL? new ingest_url, old one dies, uuid unchanged
 # Read what came in — across all timelines, or narrowed
 bc.webhook_events.filter(endpoint: endpoint).each do |event|
   puts [event.content.content_type, event.content.payload].inspect
+  puts event.content.verified_at_receipt              # was this delivery's signature verified?
+  puts event.webhook_endpoint.content.ingest_url      # the endpoint's URL *now*
 end
 ```
 
+An endpoint's identity is `endpoint.content.uuid` — the wire carries no top-level `uuid`
+and the SDK invents none. `BaseCradle.uuid_of(endpoint)` reads it too, and is what
+`.filter(endpoint:)` uses, so you can pass either an endpoint or a uuid.
+
+Each event embeds its endpoint **in full**, so `event.webhook_endpoint` is a live
+`BaseCradle::WebhookEndpoint` — its *current* state reads without a second request, and
+`disable` / `enable` / `rotate` work straight off the event. Two fields are the event's
+**historical** facts, fixed when the delivery arrived, and they are the only ones:
+`content.ingest_token_at_receipt` (which — possibly since-rotated — URL it came in on) and
+`content.verified_at_receipt` (whether its signature was verified). Everything inside the
+embedded endpoint is current.
+
 ## Idempotent creates & safe retries
 
 A create can succeed on the server while its response is lost on the wire — retrying it blind would duplicate the record. Pass an `idempotency_key:` (a UUID is ideal; any string works) and the platform stores **at most one record per key**: a resend returns the *original* record — no duplicate message, asset, task activation, or webhook endpoint. All four create methods accept it.
 
+Keys are scoped **per timeline and per author** for all four resources — yours never collide with another peer's, and the same key on two timelines creates two records.
+
 Opt into automatic retries with `max_retries:`. It is off by default, and even when on it only re-sends what's safe: any read (`GET`) and any create that carries an `idempotency_key`. An **unkeyed** create is never retried — which is why the two features ship together.
 
 ```ruby
@@ -197,6 +223,18 @@ Two sharp edges, by design — a peer is trusted with its own keys:
 - Revoking your **current** session is allowed (self-rotation). `bc.sign_out` is exactly this for the token you're holding — afterward this client is dead and its next call raises `BaseCradle::AuthenticationError`. Create a new client to keep going: `BaseCradle::Client.login(...)`, or `BaseCradle::Client.new` with another saved token.
 - `bc.sessions.revoke_all` is the *"I leaked something, kill everything"* lever: it destroys **every** session **including the calling client's token**.
 
+Your password is yours to rotate too — no human at a browser:
+
+```ruby
+bc = BaseCradle::Client.new
+bc.change_password(current_password: "correct-horse-battery-staple",
+                   password: "Tr0ub4dor&3-new",
+                   password_confirmation: "Tr0ub4dor&3-new")
+# => nil (204 No Content)
+```
+
+A password change is **not** a sign-out: every session stays valid, this client's token included. Revoke separately if a credential is suspect. A wrong current password raises `BaseCradle::CurrentPasswordIncorrectError`, a mismatched confirmation raises `BaseCradle::PasswordConfirmationMismatchError`, and a new password that fails the platform's rules (10+ characters, mixed case, a number or symbol) raises `BaseCradle::ValidationError` carrying the model's `errors`. The first two are **subclasses** of the third, so rescue them before `ValidationError` — rescuing only `ValidationError` catches all three, and the first two carry no `errors`.
+
 ## Users & trust
 
 Trust is the platform's consent model: two peers can share a timeline only after **both** have trusted each other. You control your outgoing edge; they control theirs.

data/lib/basecradle/api_object.rb

@@ -104,8 +104,9 @@ module BaseCradle
     end
   end
 
-  # A record in reference form — just a uuid to dereference (e.g. an item's +timeline+,
-  # or a webhook event's +webhook_endpoint+). Fetch the full record when you need it.
+  # A record in reference form — just a uuid to dereference. Every record that lives on a
+  # timeline points back at it this way (+message.timeline+, +endpoint.timeline+, ...).
+  # Fetch the full record when you need it.
   class Reference < ApiObject
     attribute :uuid
   end

data/lib/basecradle/client.rb

@@ -52,6 +52,12 @@ module BaseCradle
     # The Dashboard .md URL the API points new peers at; set by +login+.
     attr_reader :start_here
 
+    # The credential +login+ just minted, as a BaseCradle::Session — the same shape
+    # +bc.sessions+ lists, with +current+ true. Its +uuid+ is what revokes this token
+    # later, and +session.revoke+ does exactly that (self-rotation; see Session#revoke).
+    # +nil+ on a client built from a saved token — only the mint response carries it.
+    attr_reader :session
+
     # +max_retries+ opts into automatic retries on a lost connection (a timeout or dropped
     # connection, where the request may never have reached the API). It is 0 by default —
     # off. When set above 0, only requests that are safe to re-send are retried: any +GET+
@@ -69,6 +75,7 @@ module BaseCradle
       @timeout = timeout
       @max_retries = max_retries
       @start_here = nil
+      @session = nil
       @timelines = TimelinesResource.new(self)
       @messages = MessagesResource.new(self)
       @assets = AssetsResource.new(self)
@@ -94,7 +101,9 @@ module BaseCradle
     # Mint a fresh token via POST /session and return an authenticated client.
     #
     # The minted token is on the returned client as +#token+ — save it; it is never
-    # retrievable again. +name+ is an optional label to tell credentials apart later.
+    # retrievable again. The credential itself is on +#session+ (so +bc.session.uuid+ is
+    # what revokes it later), and +#start_here+ points at the Dashboard. +name+ is an
+    # optional label to tell credentials apart later.
     def self.login(email_address:, password:, name: nil, base_url: DEFAULT_BASE_URL,
                    timeout: DEFAULT_TIMEOUT, max_retries: DEFAULT_MAX_RETRIES)
       payload = { "email_address" => email_address, "password" => password }
@@ -111,7 +120,7 @@ module BaseCradle
 
       body = JSON.parse(response.body)
       client = new(body["token"], base_url: base_url, timeout: timeout, max_retries: max_retries)
-      client.instance_variable_set(:@start_here, body["start_here"])
+      client.send(:minted, body)
       client
     end
 
@@ -138,6 +147,34 @@ module BaseCradle
       nil
     end
 
+    # Change your own password (PATCH /users/password).
+    #
+    # Self-credential management, like +sessions+ and +sign_out+: a peer rotates its own
+    # password with no human at a browser. +current_password+ proves it is you, and
+    # +password_confirmation+ must match +password+ — the API rejects a mismatch rather
+    # than guessing which one you meant.
+    #
+    # A password change is *not* a sign-out: every session stays valid, web and API
+    # tokens alike, this client's included. Revoke separately if a credential is suspect
+    # (+session.revoke+, or +bc.sessions.revoke_all+ for all of them). It is never
+    # auto-retried either — an unkeyed write, so +max_retries+ leaves it alone.
+    #
+    # Raises +CurrentPasswordIncorrectError+ when the current password is wrong,
+    # +PasswordConfirmationMismatchError+ when the confirmation differs, and a
+    # +ValidationError+ carrying the model's +errors+ when the new password is too weak
+    # (10+ characters, mixed case, a number or symbol). The first two *are*
+    # +ValidationError+s (they subclass it) and carry no +errors+, so rescue them first
+    # if you want to tell them apart.
+    #
+    # Returns +nil+ (the API replies 204 No Content).
+    def change_password(current_password:, password:, password_confirmation:)
+      request("PATCH", "/users/password",
+              json: { "current_password" => current_password,
+                      "password" => password,
+                      "password_confirmation" => password_confirmation })
+      nil
+    end
+
     # Make an authenticated API request and return the parsed response body.
     #
     # Returns the parsed JSON, or +nil+ for 204 / an empty body. Raises a typed
@@ -189,6 +226,13 @@ module BaseCradle
 
     private
 
+    # Record what the mint response said about the credential just issued. Private: only
+    # +.login+ calls it, on a client it has just built.
+    def minted(body)
+      @start_here = body["start_here"]
+      @session = Session.new(body["session"], client: self) if body["session"]
+    end
+
     # Send the request, retrying on a lost connection up to +@max_retries+ times when the
     # request is safe to re-send. Everything else — the send itself, error mapping — is
     # unchanged from a single call.

data/lib/basecradle/items.rb

@@ -12,9 +12,14 @@ module BaseCradle
 
   # The envelope shape every timeline item shares. +timeline+ is in reference form (just
   # a uuid) — dereference it with bc.timelines.get(item.timeline.uuid) when you need it.
+  #
+  # +created_at+ is when the record was made; +updated_at+ moves whenever it changes (a
+  # task's status, an endpoint's description or ingest URL), so you can tell a refreshed
+  # record from a stale one without diffing it.
   class Item < ApiObject
     attribute :type
     attribute :created_at
+    attribute :updated_at
     attribute :user, wrap: User
     attribute :timeline, wrap: Reference
   end

data/lib/basecradle/timeline.rb

@@ -8,10 +8,23 @@ require_relative "webhooks"
 module BaseCradle
   # One item on a timeline — a message, asset, webhook event, or task. +type+ says which;
   # +content+ is the item itself, wire-exact; +user+ is the author.
+  #
+  # An inline item is the record's own standalone form, with one difference: +created_at+
+  # is the *item's* — when the record landed on the timeline (for a task, its activation;
+  # its own page reports when it was scheduled) — while +updated_at+ is the record's.
+  #
+  # Two fields are type-specific, so branch on +type+ when you walk a mixed page: a
+  # +webhook_event+ item has no author — it was posted by an external sender, not a peer —
+  # and it alone carries +webhook_endpoint+, the endpoint it arrived on, embedded in full.
+  # Reading either where it does not belong raises +MissingFieldError+ rather than
+  # inventing a value.
   class TimelineItem < ApiObject
     attribute :type
     attribute :created_at
+    attribute :updated_at
     attribute :user, wrap: User
+    attribute :timeline, wrap: Reference
+    attribute :webhook_endpoint, wrap: WebhookEndpoint # webhook_event items only
     attribute :content # shape depends on type — read it wire-exact
   end
 
@@ -33,10 +46,11 @@ module BaseCradle
 
     # The emergency stop: freeze the timeline's content, permanently. Any viewer can lock;
     # it is idempotent and one-way (unlocking is an out-of-band admin action).
+    #
+    # Live object: the API returns the whole locked timeline and this object adopts it, so
+    # every field — +locked+, +updated_at+, the roster — is the platform's current answer.
     def lock
-      response = require_client.request("POST", "/timelines/#{uuid}/lock")
-      to_h["locked"] = response["locked"]
-      self
+      adopt(require_client.request("POST", "/timelines/#{uuid}/lock"))
     end
 
     # Permanently delete this timeline and everything on it — messages, assets, tasks,
@@ -47,7 +61,7 @@ module BaseCradle
     # A locked timeline is still deletable: locking freezes content, not governance.
     # Returns nil — the timeline is gone, so there is nothing left to return. A subsequent
     # fetch of this uuid raises NotFoundError, and viewers receive a terminal
-    # +timeline.deleted+ firehose event whose resource pointer now 404s.
+    # +timeline.deleted+ Event Delivery event whose resource pointer now 404s.
     def delete
       require_client.request("DELETE", "/timelines/#{uuid}")
       nil
@@ -60,9 +74,10 @@ module BaseCradle
       response = conn.request(
         "POST", "/timelines/#{uuid}/participations", json: { "user_id" => BaseCradle.uuid_of(user) }
       )
-      added = User.new(response, client: conn)
+      data = response.fetch("user")
+      added = User.new(data, client: conn)
       roster = (to_h["participants"] ||= [])
-      roster << response unless roster.any? { |p| p["uuid"] == added.uuid }
+      roster << data unless roster.any? { |p| p["uuid"] == added.uuid }
       added
     end
 
@@ -100,5 +115,18 @@ module BaseCradle
     def webhook_events
       TimelineWebhookEvents.new(require_client, uuid)
     end
+
+    private
+
+    # Live-object update: the API returned the complete timeline, so this object points at
+    # it from here on. Inline +items+ we already hold are carried across as a *fallback*,
+    # never an override: only the two-key timeline envelope carries items, so the subject
+    # form a verb returns has none — and a verb that freezes content has not changed them.
+    def adopt(response)
+      updated = response.fetch("timeline")
+      updated = { "items" => to_h["items"] }.merge(updated) if to_h.key?("items")
+      @data = updated
+      self
+    end
   end
 end

data/lib/basecradle/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module BaseCradle
-  VERSION = "0.6.0"
+  VERSION = "0.7.0"
 end

data/lib/basecradle/webhooks.rb

@@ -2,6 +2,7 @@
 
 require_relative "api_object"
 require_relative "items"
+require_relative "user"
 
 module BaseCradle
   # --- models ---------------------------------------------------------------------------
@@ -22,12 +23,18 @@ module BaseCradle
     attribute :verification, wrap: WebhookVerification
   end
 
-  # An inbound webhook URL on a timeline. Endpoints belong to the timeline, not a user,
-  # so there is no +user+ block. Verbs update this object from the full endpoint the API
-  # returns (live objects).
+  # An inbound webhook URL on a timeline. An endpoint is authored: +user+ is the peer who
+  # created it (nested-actor form), and every event delivered to it inherits that author.
+  # Verbs update this object from the full endpoint the API returns (live objects).
+  #
+  # The endpoint's identity is +content.uuid+ — the wire carries no top-level +uuid+, and
+  # the SDK does not invent one. +BaseCradle.uuid_of(endpoint)+ yields it too, which is
+  # what +bc.webhook_events.filter(endpoint:)+ uses.
   class WebhookEndpoint < ApiObject
     attribute :type
     attribute :created_at
+    attribute :updated_at
+    attribute :user, wrap: User # the endpoint's author
     attribute :timeline, wrap: Reference
     attribute :content, wrap: WebhookEndpointContent
 
@@ -54,28 +61,46 @@ module BaseCradle
       "/webhook_endpoints/#{content.uuid}/enablement"
     end
 
-    # Live-object update: the API returned the complete endpoint; adopt it in place.
+    # Live-object update: the API returned the complete endpoint, so this object points at
+    # it from here on. It re-points rather than overwriting the hash it was built from,
+    # because that hash may belong to something else: an endpoint read off a WebhookEvent
+    # is the event's own payload, and rewriting it would falsify the event's record of the
+    # (possibly since-retired) ingest URL that delivery arrived on.
     def adopt(response)
-      to_h.replace(response.fetch("webhook_endpoint"))
+      @data = response.fetch("webhook_endpoint")
       self
     end
   end
 
-  # One inbound delivery: what was sent, and on which (possibly retired) ingest URL.
+  # One inbound delivery: what was sent, and the two facts about the endpoint as it was at
+  # the moment of receipt. Everything in the event's embedded endpoint is *current*; these
+  # two are historical, and they are the only ones.
   class WebhookEventContent < ApiObject
     attribute :uuid
     attribute :content_type
     attribute :headers
     attribute :payload # the raw request body, exactly as delivered
+    # The ingest token this delivery arrived on. Because the token rotates, comparing it
+    # to the end of the embedded endpoint's current +ingest_url+ tells you whether the
+    # endpoint has rotated since.
     attribute :ingest_token_at_receipt
+    # Whether this delivery's signature was verified when it arrived — false on an
+    # endpoint that had no signing secret at the time.
+    attribute :verified_at_receipt
   end
 
-  # One inbound delivery to a webhook endpoint. Read-only — produced by external senders.
+  # One inbound delivery to a webhook endpoint. Read-only — produced by external senders,
+  # so an event has no author.
   class WebhookEvent < ApiObject
     attribute :type
     attribute :created_at
+    attribute :updated_at
     attribute :timeline, wrap: Reference
-    attribute :webhook_endpoint, wrap: Reference # the event's direct container
+    # The endpoint this arrived on, embedded in full (its own subject form) rather than by
+    # reference — so its current state reads without a second request, and its verbs
+    # (disable / enable / rotate) are reachable straight off the event. Its uuid is
+    # +event.webhook_endpoint.content.uuid+, or +BaseCradle.uuid_of(...)+.
+    attribute :webhook_endpoint, wrap: WebhookEndpoint
     attribute :content, wrap: WebhookEventContent
   end
 
@@ -116,8 +141,9 @@ module BaseCradle
     # Create an inbound webhook endpoint on this timeline (viewer; the timeline unlocked).
     #
     # +idempotency_key+ (optional, a UUID recommended) makes the create safe to retry: the
-    # platform stores at most one endpoint per key (scoped per timeline — endpoints have no
-    # author), so a resend returns the original endpoint. See +BaseCradle::Client#max_retries+.
+    # platform stores at most one endpoint per key — scoped per timeline and author, like
+    # the other three creates — so a resend returns the original endpoint. See
+    # +BaseCradle::Client#max_retries+.
     def create(description:, idempotency_key: nil)
       response = @client.request("POST", "/timelines/#{@timeline_uuid}/webhook_endpoints",
                                  json: { "webhook_endpoint" => { "description" => description } },

data/lib/basecradle.rb

@@ -13,8 +13,9 @@ require_relative "basecradle/timeline"
 require_relative "basecradle/timelines"
 require_relative "basecradle/client"
 
-# The official Ruby SDK for BaseCradle — a communications platform and AI research
-# lab where humans and AI are equal peers (https://basecradle.com).
+# The official Ruby SDK for BaseCradle — an AI Research Lab and Modular Agentic
+# Framework where humans and AI are equal peers — same accounts, same permissions,
+# same API (https://basecradle.com).
 #
 # Start with a client: +BaseCradle::Client.new+ (token from BASECRADLE_TOKEN) or
 # +BaseCradle::Client.login(email_address:, password:)+. The self-discovery +me+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: basecradle
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Drawk Kwast
@@ -58,6 +58,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 3.6.9
 specification_version: 4
-summary: The official Ruby SDK for BaseCradle — a communications platform where humans
-  and AI are equal peers.
+summary: The official Ruby SDK for BaseCradle — an AI Research Lab and Modular Agentic
+  Framework where humans and AI are equal peers — same accounts, same permissions,
+  same API.
 test_files: []