GitAuto: [FEATURE] Implement SKU Kit API

[gitauto-ai]

Resolves #29

What is the feature

This feature implements the SKU Kit API within the SDK, allowing users to consult, create, and update SKU Kits. A SKU Kit is an SKU composed of one or more other SKUs, functioning as a bundled product. By integrating this API, users can manage SKU Kits directly through the SDK.

Why we need the feature

Implementing the SKU Kit API enhances the SDK's capabilities by supporting the full range of VTEX catalog functionalities. Businesses that offer product bundles rely on SKU Kits to manage inventory and sales efficiently. By providing this feature, we enable developers to create more complex product offerings and streamline their catalog management processes.

How to implement and why

1. Review the VTEX SKU Kit API Documentation:

   • Familiarize ourselves with the SKU Kit API endpoints provided by VTEX.
   • Understand the required request and response formats, authentication methods, and any limitations.

2. Define Data Models for SKU Kits:

   • Create new data models (SkuKit, SkuKitItem, etc.) in the Src directory to represent SKU Kits and their components accurately.
   • Ensure that all necessary properties (e.g., Id, Quantity, SkuComponents) are included to match the API specifications.

3. Implement API Client Methods:

   • Add new methods to the SDK's API client to handle SKU Kit operations:
     • GetSkuKit(int skuId): Retrieve the details of an existing SKU Kit.
     • CreateSkuKit(SkuKit kit): Create a new SKU Kit.
     • UpdateSkuKit(int skuId, SkuKit kit): Update an existing SKU Kit.
   • Place these methods in a relevant service class within the Src directory, such as SkuKitService.

4. Handle Authentication and Authorization:

   • Ensure that the new methods properly handle authentication tokens and any required headers.
   • Validate that the user has the necessary permissions to perform SKU Kit operations.

5. Implement Error Handling and Logging:

   • Include comprehensive error handling to catch and process API errors gracefully.
   • Log relevant information to assist with debugging and monitoring.

6. Write Unit and Integration Tests:

   • Develop unit tests for the new data models and API client methods in the Tests directory.
   • Create integration tests to verify the interactions with the VTEX API.

7. Update Documentation and Examples:

   • Add documentation for the new SKU Kit features, including method descriptions and usage examples.
   • Update the README.md and any relevant markdown files in the docs directory to reflect these changes.

8. Ensure Code Consistency and Style Compliance:

   • Follow the existing coding standards defined in files like .csharpierrc.yaml.
   • Use consistent naming conventions and documentation styles throughout the codebase.

Why:

• Step-by-step implementation ensures that all aspects of the feature are thoroughly addressed, from data modeling to user documentation.
• Defining data models first provides a strong foundation for building API interactions.
• Comprehensive testing guarantees reliability and helps maintain the SDK's quality.
• Updating documentation is crucial for user adoption and helps developers understand how to use the new feature effectively.

About backward compatibility

Introducing the SKU Kit API is an additive change that does not modify or remove existing functionalities. It maintains backward compatibility because:

• Existing classes and methods remain unchanged.
• New methods are added in a way that does not interfere with current SDK usage.
• Users who choose not to use the SKU Kit features will experience no impact on their existing implementations.

Therefore, the addition enhances the SDK without introducing any breaking changes.

Test these changes locally

git checkout -b gitauto/issue-29-51d54d6f-f299-42e1-b073-513c4727e3a9
git pull origin gitauto/issue-29-51d54d6f-f299-42e1-b073-513c4727e3a9

[coderabbitai]

Important

Review skipped

Bot user detected.

To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

---

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

[codacy-production]

Coverage summary from Codacy

See diff coverage on Codacy

Coverage variation	Diff coverage
✅ +0.00% (target: -1.00%)	✅ ∅

Coverage variation details

	Coverable lines	Covered lines	Coverage
Common ancestor commit (1b318bd)	1777	4	0.23%
Head commit (051aa37)	1777 (+0)	4 (+0)	0.23% (+0.00%)

Coverage variation is the difference between the coverage for the head and common ancestor commits of the pull request branch: <coverage of head commit> - <coverage of common ancestor commit>

Diff coverage details

	Coverable lines	Covered lines	Diff coverage
Pull request (#335)	0	0	∅ (not applicable)

Diff coverage is the percentage of lines that are covered by tests out of the coverable lines that the pull request added or modified: <covered lines added or modified>/<coverable lines added or modified> * 100%

See your quality gate settings    Change summary preferences

_{Codacy stopped sending the deprecated coverage status on June 5th, 2024. Learn more}

[AppVeyorBot]

✅ Build VTEX-SDK-dotnet 2.3.1181 completed (commit dd65f9e3a7 by @code-factor)

[github-actions]

Infisical secrets check: ✅ No secrets leaked!

💻 Scan logs

11:39AM INF scanning for exposed secrets...
11:39AM INF 526 commits scanned.
11:39AM INF scan completed in 276ms
11:39AM INF no leaks found

[github-advanced-security]

Sonarcsharp (reported by Codacy) found more than 20 potential problems in the proposed changes. Check the Files changed tab for more details.

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

[AppVeyorBot]

✅ Build VTEX-SDK-dotnet 2.4.19 completed (commit 732039e396 by @gstraccini[bot])