Chore/readme updates

[jpvajda]

• Adds missing code examples to Readme for Management API
• Adds missing code examples to Readme for Agent API
• Adds missing code examples to Readme for Authentication
• Adds miss Docs reference links
• removes duplication of methods in this class code comment
• adds model methods to code comment

---

• To see the specific tasks where the Asana app for GitHub is being used, see below:
  • https://app.asana.com/0/0/1209878239000742

Summary by CodeRabbit

• Documentation

  • Expanded documentation with new sections for enhanced voice interactions, authentication, and model management.
  • Added clear examples demonstrating how to set up interactions, manage tokens, and utilize model retrieval features.

• New Features

  • Introduced new functionality for retrieving comprehensive model data within the SDK.

[coderabbitai[bot]]

Walkthrough

The changes expand the SDK documentation by adding new sections in the README for Voice Agent, Authentication, and Models. The README now includes code examples for establishing a voice agent connection, handling events (speech, transcripts, audio, errors, connection closure), sending audio data, and retrieving token details. Additionally, the method signature is revised from getProjectUsageRequest to getProjectUsageRequests. In the ManageRestClient class, the documentation is updated to include two new asynchronous methods—getAllModels and getModel—to support model management.

Changes

File(s)	Summary
README.md	Added new sections: Voice Agent (connection setup, event handling, audio transmission, and keep-alive), Authentication (Get Token Details), and Models (subsections for "Get All Models" and "Get Model"). Updated method usage from getProjectUsageRequest to getProjectUsageRequests.
src/packages/ManageRestClient.ts	Updated class documentation to include models functionality and added two methods: getAllModels and getModel for retrieving model details. The documentation block was streamlined for clarity.

Sequence Diagram(s)

Voice Agent Connection Flow

sequenceDiagram
    participant Client
    participant VoiceAgent
    participant Server

    Client->>VoiceAgent: Create & configure connection
    VoiceAgent->>Server: Initiate connection (WebSocket)
    Server-->>VoiceAgent: Connection acknowledgment
    VoiceAgent->>Client: Emit events (speech, transcript, audio)
    Client->>VoiceAgent: Send audio data / keep-alive signal
    VoiceAgent->>Server: Forward audio & keep-alive signal
    Server-->>VoiceAgent: Confirm receipt
    VoiceAgent->>Client: Handle error/close events

Model Retrieval Flow

sequenceDiagram
    participant Client
    participant ManageRestClient
    participant API

    Client->>ManageRestClient: Invoke getAllModels or getModel
    ManageRestClient->>API: Send model retrieval request
    API-->>ManageRestClient: Return model data
    ManageRestClient-->>Client: Deliver models information

---

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai plan to trigger planning for file edits and PR creation.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.