Skip to content

feat: Add support for bulk actions in Custom object Service for Records #141

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 introduces support for bulk job operations on custom object records. Specifically, it adds new TypeScript interfaces and enums to model bulk job requests and responses for creating, updating, deleting, and upserting custom object records in a single asynchronous job.

Changes include:

  • Expansion of custom object model interfaces to support bulk job actions, with detailed typings for different bulk job payloads and responses.
  • Addition of a new method bulkJobsForRecords in CustomObjectService to submit bulk job requests to the Zendesk API asynchronously.
  • Extended test coverage with a new unit test validating the bulk job API call and payload handling in custom-objects.spec.ts.

No UI changes are involved.

How to manually test

  1. Run the existing test suite including the new custom-objects.spec.ts tests.
  2. Optionally create an integration environment configured with Zendesk custom objects.
  3. Use the bulkJobsForRecords method by passing a custom object key and a bulk job payload to POST bulk create/update/delete jobs.
  4. Verify that the job status response is returned according to the Zendesk API specification.

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 30, 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! 🤖 🚀 🔥

@github-actions github-actions bot dismissed their stale review May 30, 2025 18:09

Dismiss bot.

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 b730bc5 May 30, 2025
7 checks passed
@Vico1993 Vico1993 deleted the victor.piolin/custom-object-bulk-operation branch May 30, 2025 18:10
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