fix(js-client): handle type definitions for request body params

[CalebBarnes]

Summary

This PR adds type definitions for the body parameter in methods that accept a request body, while maintaining proper handling for optional and void parameters. It ensures that methods with optional or no parameters are typed correctly.

Changes

• Reference Documentation and Example:

  • Updated the NetlifyAPI client definition comment to include links to the Open API Reference and Online Documentation
  • Added example usage directly in the comment for clarity.

• Request Body Types:

  • Added types for body parameters for methods with application/json or application/octet-stream request bodies.
  • Typed application/json bodies as JSON objects or functions returning JSON objects (with type definitions derived from the @netlify/open-api schema).
  • Typed application/octet-stream bodies as Node.js ReadStream or functions returning a ReadStream.

• Optional Parameters:

  • Introduced IsRequestBodyOptional to check if all properties in the request body are optional.
  • Enhanced the OperationParams type to conditionally include the body parameter only when applicable and correctly handle optional request bodies.
  • Refactored to ensure that methods with no required parameters (including request body) can be called without passing any arguments (void).

• Helper Types:

  • Added helper types to simplify logic and improve readability:
    • HasRequestBody: Determines if a method supports a request body.
    • RequestBody: Extracts the request body type based on the operation.
    • IsParamsOrRequestBodyRequired: Determines if any path, query, or request body parameters are required.
    • CombinedParamsAndRequestBody: Combines path, query, and request body parameters into a single type.

How it looks in editor

• operation createSite with request body type application/json using types derived from @netlify/open-api:
  
  

• operation uploadDeployFile with request body type application/octet-stream:
  
  

---

For us to review and ship your PR efficiently, please perform the following steps:

• Open a bug/issue before writing your code 🧑‍💻. This ensures
  we can discuss the changes and get feedback from everyone that should be involved. If you`re fixing a typo or
  something that`s on fire 🔥 (e.g. incident related), you can skip this step.
• Read the contribution guidelines 📖. This ensures
  your code follows our style guide and passes our tests.
• Update or add tests (if any source code was changed or added) 🧪
• Update or add documentation (if features were changed or added) 📝
• Make sure the status checks below are successful ✅

A picture of a cute animal (not mandatory, but encouraged)