node-zendesk icon indicating copy to clipboard operation
node-zendesk copied to clipboard

Better types for brands, tickets, macros, webhooks, articles

Open KiraLT opened this issue 6 months ago • 0 comments

Pull Request Description

Update types for:

  • Brand API types
  • Webhooks API types
  • Macros API types
  • Knowledge API articles and categories partial types
  • Ticket API via field, updated getComments type

This PR mostly adds typing using comments. To add Brand type I needed rename Brand client to Brands, but that rename affected only internal import, from external API nothing changed. We can do either that, or change brand type to something else if we wish to avoid this change.


Related Issue(s)

  • [ ] This PR fixes/closes issue #...
  • [x] This is a new feature and does not have an associated issue.

Additional Information

  • [ ] This change is a breaking change (may require a major version update)
  • [x] This change is a new feature (non-breaking change which adds functionality)
  • [x] This change improves the code (e.g., refactoring, etc.)
  • [ ] This change includes dependency updates

Test Cases

Include any test cases or steps you took to test your changes. If you have added new functionality, please include relevant unit tests.


Documentation

  • [ ] I have updated the documentation accordingly.
  • [x] No updates are required.

Checklist

  • [x] I have read the CONTRIBUTING documentation.
  • [x] My code follows the coding standards of this project.
  • [x] All new and existing tests passed.

KiraLT avatar May 12 '25 15:05 KiraLT