Skip to content

Fixed types for organization client methods, organization type #443

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

jan-san
Copy link

@jan-san jan-san commented May 14, 2025

Pull Request Description

The PR corrects the parameter types for the various create and update methods of the organization client (see #437 for a report on some of the issues). This change is not breaking, but merely adjusting the types to match the shape Zendesk's API expects.

The PR also adds an explicit Organization type (based on Zendesk's docs), and updates the method signatures to use that type or its derivatives.

I also updated the implementation of the upsert() method, which is just duplicating createOrUpdate(), and deprecated the method, since its naming deviates from the API's.


Related Issue(s)


Additional Information

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

Test Cases

  • manually verified that createMany and updateMany work with the updated types
  • manually verified that the output of organization client methods matches methods' updated return types

Documentation

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

Checklist

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

@jan-san jan-san force-pushed the fix-org-types branch 5 times, most recently from cbc72a0 to 9035cf5 Compare May 14, 2025 18:38
@jan-san jan-san marked this pull request as draft May 14, 2025 18:41
@jan-san jan-san force-pushed the fix-org-types branch 2 times, most recently from 834752b to fed12f1 Compare May 14, 2025 19:09
@jan-san jan-san marked this pull request as ready for review May 14, 2025 19:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant