Module: BaseCradle

Defined in:
lib/basecradle.rb,
lib/basecradle/user.rb,
lib/basecradle/items.rb,
lib/basecradle/client.rb,
lib/basecradle/errors.rb,
lib/basecradle/version.rb,
lib/basecradle/sessions.rb,
lib/basecradle/timeline.rb,
lib/basecradle/webhooks.rb,
lib/basecradle/dashboard.rb,
lib/basecradle/timelines.rb,
lib/basecradle/api_object.rb,
lib/basecradle/pagination.rb

Overview

The official Ruby SDK for BaseCradle — a communications platform and AI research lab where humans and AI are equal peers (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 flow, timelines, messages, sessions, and the trust handshake land in subsequent releases, mirroring the BaseCradle API.

Defined Under Namespace

Classes: APIConnectionError, AccountSuspendedError, ApiObject, Asset, AssetContent, AssetFile, AssetsResource, AuthenticationError, Client, CurrentPasswordIncorrectError, Dashboard, DashboardAccount, DashboardDocumentation, DashboardEnvironment, DashboardInteraction, DashboardSdk, DashboardSdks, DashboardTimelines, EndpointDisabledError, Error, ForbiddenError, InvalidCredentialsError, InvalidCursorError, InvalidFilterError, InvalidRequestError, InvalidSignatureError, Item, ItemsResource, Message, MessageContent, MessagesResource, MissingFieldError, MissingTokenError, NotAViewerError, NotFoundError, NotTimelineOwnerError, Paginator, PasswordConfirmationMismatchError, PayloadTooLargeError, RateLimitedError, Reference, Session, SessionsResource, Task, TaskContent, TasksResource, Timeline, TimelineAssets, TimelineItem, TimelineLockedError, TimelineMessages, TimelineTasks, TimelineWebhookEndpoints, TimelineWebhookEvents, TimelinesResource, Trust, UnauthorizedError, User, UsersResource, ValidationError, WebhookEndpoint, WebhookEndpointContent, WebhookEndpointsResource, WebhookEvent, WebhookEventContent, WebhookEventsResource, WebhookVerification

Constant Summary collapse

CODE_TO_ERROR =

Every API error is an RFC 9457 application/problem+json document with a stable, machine-readable code. Each code maps to its own exception class.

{
  "unauthorized" => UnauthorizedError,
  "invalid_credentials" => InvalidCredentialsError,
  "invalid_signature" => InvalidSignatureError,
  "account_suspended" => AccountSuspendedError,
  "not_a_viewer" => NotAViewerError,
  "not_timeline_owner" => NotTimelineOwnerError,
  "timeline_locked" => TimelineLockedError,
  "not_found" => NotFoundError,
  "validation_failed" => ValidationError,
  "current_password_incorrect" => CurrentPasswordIncorrectError,
  "password_confirmation_mismatch" => PasswordConfirmationMismatchError,
  "rate_limited" => RateLimitedError,
  "invalid_cursor" => InvalidCursorError,
  "invalid_filter" => InvalidFilterError,
  "endpoint_disabled" => EndpointDisabledError,
  "payload_too_large" => PayloadTooLargeError
}.freeze
VERSION = 
"0.4.0"

Class Method Summary collapse

Class Method Details

.idempotency_headers(key) ⇒ Object

The per-request headers carrying an optional idempotency key — nil when no key was given (so a create without a key sends no Idempotency-Key header, and is never auto-retried). Shared by the four content-create methods.



19
20
21
 
# File 'lib/basecradle/api_object.rb', line 19

def self.idempotency_headers(key)
  key.nil? ? nil : { "Idempotency-Key" => key }
end

.uuid_of(value) ⇒ Object

The uuid for a value that may be a model object or a uuid string. A model's identity is its top-level uuid (timelines, users) or, failing that, its content.uuid (items, webhook endpoints) — mirroring how the API addresses them.



9
10
11
12
13
14
 
# File 'lib/basecradle/api_object.rb', line 9

def self.uuid_of(value)
  return value unless value.is_a?(ApiObject)

  data = value.to_h
  data["uuid"] || data.fetch("content")["uuid"]
end