guibranco / VTEX-SDK-dotnet

🛒 ⚙️ VTEX platform .NET SDK
https://guibranco.github.io/VTEX-SDK-dotnet/
MIT License
12 stars 7 forks source link

GitAuto: [FEATURE] Implement SKU Complement #333

Closed gitauto-ai[bot] closed 1 week ago

gitauto-ai[bot] commented 1 month ago

Resolves #25

What is the feature

Implement the ability to consult, create, and update an SKU Complement, which is a new SKU associated with a Parent SKU. This feature will integrate the SKU Complement functionality provided by the VTEX Catalog API.

Why we need the feature

SKU Complements are essential for managing complex product catalogs that include products with variations or additional options. By supporting SKU Complements, we enable users to:

Integrating this feature expands the capabilities of our application, making it more suitable for businesses with advanced product management needs.

How to implement and why

  1. Create SKU Complement Models: Define new data models to represent SKU Complements, including necessary fields such as ParentSKUId, ComplementSKUId, and any additional attributes required by the VTEX API.

  2. Develop API Client Methods: Implement methods in the API client to interact with the VTEX SKU Complement endpoints for:

    • Consulting an SKU Complement: Retrieve details of an SKU Complement by its ID.
    • Creating an SKU Complement: Send requests to create new SKU Complements linked to Parent SKUs.
    • Updating an SKU Complement: Update existing SKU Complement information as needed.
  3. Integrate with Service Layer: Update the service layer to include new operations for SKU Complements, ensuring proper handling of requests, responses, and error management, while adhering to VTEX API protocols.

  4. Add Unit and Integration Tests: Write comprehensive tests to validate the new functionality, ensuring reliability and preventing regressions.

  5. Update Documentation: Document the new features, including API usage instructions, examples, and any necessary configuration steps.

Reasons:

About backward compatibility

This implementation will maintain backward compatibility because:

By ensuring backward compatibility, we allow current users to continue using the application without interruption while providing new capabilities for those who need them.

Test these changes locally

git checkout -b gitauto/issue-#25-ccb604f8-908d-4f4d-9c89-0fa19c891513
git pull origin gitauto/issue-#25-ccb604f8-908d-4f4d-9c89-0fa19c891513
github-actions[bot] commented 1 month ago

Infisical secrets check: ✅ No secrets leaked!

💻 Scan logs ```txt 12:12AM INF scanning for exposed secrets... 12:12AM INF 316 commits scanned. 12:12AM INF scan completed in 250ms 12:12AM INF no leaks found ```
AppVeyorBot commented 1 month ago

:x: Build VTEX-SDK-dotnet 2.3.1174 failed (commit https://github.com/guibranco/VTEX-SDK-dotnet/commit/885bae08af by @gitauto-ai[bot])