Update Numerals for Consistency

[dvonthenen]

Proposed changes

This just renames numerals -> Numerals and places it alphabetically in the class for consistency.

Types of changes

What types of changes does your code introduce to the community .NET SDK?
Put an x in the boxes that apply

• Bugfix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• Documentation update or tests (if none of the other choices apply)

Checklist

Put an x in the boxes that apply. You can also fill these out after creating the PR. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your code.

• I have read the CONTRIBUTING doc
• I have lint'ed all of my code using repo standards
• I have added tests that prove my fix is effective or that my feature works
• I have added necessary documentation (if appropriate)

Further comments

NA

Summary by CodeRabbit

• New Features
  • Introduced a Numerals property in both PreRecordedSchema and LiveSchema to enhance number conversion from written to numerical format.
• Bug Fixes
  • Removed the old numerals property to standardize naming conventions and improve output clarity.

[coderabbitai]

Walkthrough

The changes involve the addition of a new nullable property, Numerals, to both the PreRecordedSchema and LiveSchema classes within the Deepgram Models. This property is intended to facilitate the conversion of numbers from written to numerical format. The previous similarly named property, numerals, has been removed to standardize the naming convention to PascalCase. Both new properties are marked with JsonIgnore to ensure they are not serialized when null.

Changes

File Path	Change Summary
Deepgram/Models/Listen/v1/REST/PreRecordedSchema.cs	Added public bool? Numerals { get; set; } and removed public bool? numerals { get; set; }.
Deepgram/Models/Listen/v1/WebSocket/LiveSchema.cs	Added public bool? Numerals { get; set; } and removed public bool? numerals { get; set; }.

Possibly related PRs

• add numerals query param for batch and streaming #327: The changes in this PR also involve the PreRecordedSchema and LiveSchema classes, specifically adding a numerals property, which is directly related to the new Numerals property introduced in the main PR.

Suggested reviewers

• jkroll-deepgram
• jjmaldonis

---

Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between c9606cf and d183bf4.

Files selected for processing (2)

• Deepgram/Models/Listen/v1/REST/PreRecordedSchema.cs (1 hunks)
• Deepgram/Models/Listen/v1/WebSocket/LiveSchema.cs (1 hunks)

Additional comments not posted (2)

Deepgram/Models/Listen/v1/WebSocket/LiveSchema.cs (1)

152-158: LGTM!

The new Numerals property is a valuable addition to the LiveSchema class. The property is well-named, follows the naming convention, and has a clear purpose. The JsonIgnore attribute is used appropriately to handle null values, and the summary comment provides helpful documentation.

Deepgram/Models/Listen/v1/REST/PreRecordedSchema.cs (1)

183-189: LGTM!

The new Numerals property is a great addition to the PreRecordedSchema class. It follows C# naming conventions, is appropriately nullable, and is well-documented with a clear summary and reference link. The JsonIgnore attribute ensures clean serialization output. The property enhances the schema's functionality and is properly placed in alphabetical order within the class.

---

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 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.