DeleteSObject - Added option to specify API version

[FrendsSarlinS]

Closes #20 . Major version bump to 2.0.0. You can now specify API-version in the input-section. If left empty, the latest version as of today will be used (v61.0).

Summary by CodeRabbit

• New Features

  • Users can now specify the Salesforce API version in the input parameters for enhanced flexibility and control.
  • A new property allows for defining the API version in requests, defaulting to "v61.0".

• Bug Fixes

  • Improved compatibility with different Salesforce API versions, ensuring more reliable interactions.

• Tests

  • Updated unit tests to consistently include the API version in delete operations, improving robustness and accuracy.
  • New test cases added for various scenarios involving the API version parameter.

• Chores

  • Project version updated from 1.0.1 to 2.0.0, indicating major updates and enhancements.

[coderabbitai]

Warning

Rate limit exceeded

@FrendsSarlinS has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 21 minutes and 39 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

Commits

Files that changed from the base of the PR and between 3d90c1a and 8f024f9.

Walkthrough

The recent updates to the Frends.Salesforce.DeleteSObject module introduce a significant enhancement by allowing users to specify the Salesforce API version in their requests. This change not only improves flexibility but also ensures better compatibility with different API versions. Alongside this, unit tests have been updated to consistently incorporate the new API version parameter, reinforcing the robustness of the testing framework.

Changes

Files	Change Summary
Frends.Salesforce.DeleteSObject/CHANGELOG.md	Added changelog entry for API version flexibility; retained previous version entry for maintenance.
Frends.Salesforce.DeleteSObject/Frends.Salesforce.DeleteSObject.Tests/UnitTests.cs	Updated tests to include ApiVersion, added new test methods for better coverage.
Frends.Salesforce.DeleteSObject/Definitions/Input.cs	Introduced ApiVersion property with default value set to "v61.0".
Frends.Salesforce.DeleteSObject/DeleteSObject.cs	Replaced hardcoded API version with dynamic reference to input.ApiVersion.
Frends.Salesforce.DeleteSObject/Frends.Salesforce.DeleteSObject.csproj	Bumped version number from 1.0.1 to 2.0.0 to indicate major updates.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant DeleteSObject
    participant SalesforceAPI

    User->>DeleteSObject: Request to delete object with API version
    DeleteSObject->>SalesforceAPI: Call DeleteSObject with specified API version
    SalesforceAPI-->>DeleteSObject: Response with deletion status
    DeleteSObject-->>User: Return deletion status

Loading

Assessment against linked issues

Objective	Addressed	Explanation
Add option to specify Salesforce API version (#20)	✅
Default to latest API version (breaking change) (#18)	✅

🐇 In the world of code, so bright and grand,
A new version hops, like a rabbit on land.
API versions now in our hands we do wield,
Flexibility grows, with changes revealed.
In harmony, tests dance, ensuring all’s right,
With each line of code, our future is bright! 🌟

---

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>.
  • 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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 as 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.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

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

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between ae5b69c and 3d90c1a.

Files selected for processing (5)

• Frends.Salesforce.DeleteSObject/CHANGELOG.md (1 hunks)
• Frends.Salesforce.DeleteSObject/Frends.Salesforce.DeleteSObject.Tests/UnitTests.cs (13 hunks)
• Frends.Salesforce.DeleteSObject/Frends.Salesforce.DeleteSObject/Definitions/Input.cs (1 hunks)
• Frends.Salesforce.DeleteSObject/Frends.Salesforce.DeleteSObject/DeleteSObject.cs (1 hunks)
• Frends.Salesforce.DeleteSObject/Frends.Salesforce.DeleteSObject/Frends.Salesforce.DeleteSObject.csproj (1 hunks)

Additional comments not posted (5)

Frends.Salesforce.DeleteSObject/CHANGELOG.md (1)

3-5: Changelog update is accurate.

The changelog entry correctly reflects the new feature allowing specification of the Salesforce API version.

Frends.Salesforce.DeleteSObject/Frends.Salesforce.DeleteSObject/Frends.Salesforce.DeleteSObject.csproj (1)

5-5: Version update is appropriate.

The version bump to 2.0.0 is suitable given the breaking changes introduced by allowing API version specification.

Frends.Salesforce.DeleteSObject/Frends.Salesforce.DeleteSObject/Definitions/Input.cs (1)

19-24: Addition of ApiVersion property is well-implemented.

The ApiVersion property provides flexibility by allowing users to specify the API version, with a sensible default value of "v61.0".

Frends.Salesforce.DeleteSObject/Frends.Salesforce.DeleteSObject/DeleteSObject.cs (1)

36-36: Dynamic API version usage is well-implemented.

Using input.ApiVersion in the RestClient URL enhances flexibility by allowing different API versions to be specified.

Frends.Salesforce.DeleteSObject/Frends.Salesforce.DeleteSObject.Tests/UnitTests.cs (1)

59-64: Unit test updates are comprehensive.

The inclusion of the ApiVersion parameter in tests and the addition of new test cases ensure thorough coverage of the new functionality.

Also applies to: 66-72, 86-86, 108-111, 129-129, 141-141, 162-162, 183-183, 204-204, 225-225, 249-249, 274-274, 299-299, 321-321