feat: support for multiple business setup documented

[brettchaldecott]

Description (required)

This documents the updated Ruby SDK which enables the support for multiple businesses

Related issues & labels (optional)

• Closes #
• Suggested label:

Summary by CodeRabbit

• Documentation
  • Enhanced the Ruby SDK documentation with additional commentary on optional parameters. These updates provide clearer guidance on the default behaviors for various authentication and token management methods, helping developers better understand configurable options without affecting the existing functionality.

[coderabbitai]

Walkthrough

The changes update the Ruby SDK documentation file by adding commented-out lines in several method signatures. These comments indicate the default values drawn from the configuration object (@config) for various parameters. The updates improve the clarity of the API usage without modifying the underlying functionality.

Changes

File(s)	Change Summary
src/.../ruby-sdk.mdx	Updated method signatures for client_credentials_access, auth_url, fetch_tokens, token_expired?, and refresh_token to include commented-out default parameter values (e.g., client_id, client_secret, audience, domain, redirect_uri) for clearer usage documentation.

Suggested labels

sdk

Suggested reviewers

• marcosmartini

Poem

I'm a hopping rabbit in a code-filled glen,
Nibbling on defaults like a fresh new pen,
Comments sprout like carrots—bright and true,
Clarifying Ruby methods with a tasty review,
In this garden of docs, I cheer with a joyful spin!
🥕🐇

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @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.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (1)

src/content/docs/developer-tools/sdks/backend/ruby-sdk.mdx (1)

123-127: Clarify Default Value Documentation for client_credentials_access

The commented-out default values (e.g. # client_id: # default to @config.client_id) clearly indicate how the method may fall back to configuration values. However, since the example uses explicit ENV values for client_id and client_secret while also showing the configuration fallback as comments, consider adding a brief note (or aligning the comments) to explain when one should override the defaults versus using the provided ENV variables.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 06d91e6 and 9a59ae3.

📒 Files selected for processing (1)

• src/content/docs/developer-tools/sdks/backend/ruby-sdk.mdx (4 hunks)

🔇 Additional comments (4)

src/content/docs/developer-tools/sdks/backend/ruby-sdk.mdx (4)

136-142: Consistent Inline Documentation for auth_url

The update now documents optional parameters with inline commented-out defaults (such as # client_id: # default to @config.client_id). This improves clarity. Ensure that the order of these commented parameters matches the actual signature of the underlying method to prevent any potential confusion for developers.

---

178-185: Descriptive Defaults for fetch_tokens Method

The inline comments detailing default behavior for parameters like client_id, client_secret, domain, code_verifier, and redirect_uri significantly enhance the documentation. This makes it clear what values are assumed if not explicitly provided.

---

514-521: Clear Documentation for token_expired? Defaults

The commented parameters (including # audience: # default to "#{@config.domain}/api") offer readers a good understanding of the default configuration used in token_expired?. The consistency with the other methods is a plus.

---

521-527: Inline Default Values for refresh_token Documentation

The default values for client_id, client_secret, audience, and domain are clearly documented through inline comments. This update provides improved clarity on how the method behaves when optional parameters are omitted.