Skip to content

feat: Add possibility to deal with Zis Job spec inside the zendesk ap… #136

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

Merged
merged 3 commits into from
May 30, 2025

Conversation

Vico1993
Copy link
Contributor

Description

This PR adds support for managing Zendesk Integration Services (ZIS) job specifications in the Zendesk API service. It introduces new methods to:

  • Fetch paginated ZIS job specs for an integration, handling multiple pages when has_more is true.
  • Create (install) a ZIS job spec by name.
  • Delete a ZIS job spec by name.

Additionally, new TypeScript interfaces representing ZIS job specs and their paginated response have been added in the zendesk-integration-services model.

The change also updates existing code to rename some interfaces for clarity (IListCustomObjectRecordsFilter to IListFilter), and adds comprehensive unit tests for the new ZIS job specs functionality covering fetching (including pagination), creation, and deletion.

How to manually test

  1. Run the unit tests located in __tests__/services/zendesk-api-service.spec.ts to verify the new ZIS job specs methods.
  2. Use the ZendeskApiService class in a development or staging environment to:
    • Fetch job specs for a given integration name and verify multiple pages are handled.
    • Create a job spec by passing its name to createZisJobSpec.
    • Delete a job spec by passing its name to deleteZisJobSpec.

Include label

  • Version: Minor

Acceptation criteria

  • Added the corrected label to my pull request
  • Added/updated tests impacted by the change
  • Documentation is up-to-date (README.md / INSTALL.md)
  • Manually tested?

github-actions[bot]
github-actions bot previously approved these changes May 28, 2025
Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! 🤖 🚀 🔥

@Vico1993 Vico1993 marked this pull request as ready for review May 29, 2025 18:12
Base automatically changed from victor.piolin/zis-integration to main May 29, 2025 18:12
@Vico1993 Vico1993 enabled auto-merge May 30, 2025 14:17
@github-actions github-actions bot dismissed their stale review May 30, 2025 18:11

Dismiss bot.

Copy link

Bump version from 0.6.0 to 0.7.0

Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! 🤖 🚀 🔥

@Vico1993 Vico1993 added this pull request to the merge queue May 30, 2025
Merged via the queue into main with commit 8c4c753 May 30, 2025
@Vico1993 Vico1993 deleted the victor.piolin/zis-jobspec branch May 30, 2025 18:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants