Add createTickets path and tests#3
Open
KKrauss8 wants to merge 9 commits into
Open
Conversation
- JobStatusObject - JobStatusObjectResult - JobStatusResponse feat: add tests for createTickets path.
Jonathan-Zollinger
requested changes
May 10, 2026
Jonathan-Zollinger
left a comment
Jonathan-Zollinger
left a comment
Member
There was a problem hiding this comment.
Great PR! Some changes on testing syntax, naming and docs.
Great Work!
| * @return Create many tickets (status code 200) | ||
| */ | ||
| @Post("/api/v2/tickets/create_many") | ||
| Mono<@Valid JobStatusResponse> createTickets(@Body @Nullable @Valid TicketsCreateRequest ticketsCreateRequest); |
Member
There was a problem hiding this comment.
Suggested change
| Mono<@Valid JobStatusResponse> createTickets(@Body @Nullable @Valid TicketsCreateRequest ticketsCreateRequest); | |
| Mono<@Valid JobStatusResponse> createManyTickets(@Body @Nullable @Valid TicketsCreateRequest ticketsCreateRequest); |
|
|
||
| /** | ||
| * {@summary Create Many Tickets} | ||
| * <p>Accepts an array of up to 100 ticket objects. <strong>Note</strong>: Every ticket created with this endpoint may be affected by your business rules, which can include sending email notifications to your end users. If you are importing historical tickets or creating more than 1000 tickets, consider using the <a href=\"/api-reference/ticketing/tickets/ticket_import/#ticket-bulk-import\">Ticket Bulk Import</a> endpoint.</p> <p>This endpoint returns a <code>job_status</code> <a href=\"/api-reference/ticketing/ticket-management/job_statuses/#json-format\">JSON object</a> and queues a background job to do the work. Use the <a href=\"/api-reference/ticketing/ticket-management/job_statuses/#show-job-status\">Show Job Status</a> endpoint to check for the job's completion. Only a certain number of jobs can be queued or running at the same time. See <a href=\"/api-reference/introduction/rate-limits/#job-limit\">Job limit</a> for more information.</p> <h4 id=\"allowed-for\">Allowed For</h4> <ul> <li>Agents</li> </ul> |
Member
There was a problem hiding this comment.
Suggested change
| * <p>Accepts an array of up to 100 ticket objects. <strong>Note</strong>: Every ticket created with this endpoint may be affected by your business rules, which can include sending email notifications to your end users. If you are importing historical tickets or creating more than 1000 tickets, consider using the <a href=\"/api-reference/ticketing/tickets/ticket_import/#ticket-bulk-import\">Ticket Bulk Import</a> endpoint.</p> <p>This endpoint returns a <code>job_status</code> <a href=\"/api-reference/ticketing/ticket-management/job_statuses/#json-format\">JSON object</a> and queues a background job to do the work. Use the <a href=\"/api-reference/ticketing/ticket-management/job_statuses/#show-job-status\">Show Job Status</a> endpoint to check for the job's completion. Only a certain number of jobs can be queued or running at the same time. See <a href=\"/api-reference/introduction/rate-limits/#job-limit\">Job limit</a> for more information.</p> <h4 id=\"allowed-for\">Allowed For</h4> <ul> <li>Agents</li> </ul> | |
| * <h1>{@summary Create Many Tickets}</h1> | |
| * Accepts an array of up to 100 ticket objects. | |
| * Every ticket created with this endpoint may be affected by your business rules, which can include sending email notifications to your end users. | |
| * <blockquote>NOTE: This endpoint starts a background job on the zendesk server. The returned object reports on this background job's status.</blockquote> | |
| * <h4 id="allowed-for">Allowed For Agents</h4> |
| @Accessors(chain = true) | ||
| @NoArgsConstructor | ||
| @AllArgsConstructor | ||
| @Data |
Member
There was a problem hiding this comment.
good use of @Data instead of the generator's usage of both a getter and setter annotation!
Member
There was a problem hiding this comment.
This should be titled "JobStatus" and not "JobStatusObject"
Member
There was a problem hiding this comment.
should not contain "Object" in the title
| @Nullable | ||
| @JsonProperty(JSON_PROPERTY_STATUS) | ||
| @JsonInclude(JsonInclude.Include.USE_DEFAULTS) | ||
| private String status; |
Member
There was a problem hiding this comment.
Use an enum here for "queued", "working", "failed" and "completed". Update the javadocs to point to the enum options.
you could honestly just copy src/main/java/lol/pbu/z4j/model/SortBy.java and swap out the enum constants.
Comment on lines
+210
to
+217
| List<TicketCreateInput> ticketCreateInputList = new ArrayList<>() | ||
| for (int i = 0; i < 100; i++) { | ||
| TicketComment ticketComment = new TicketComment().setBody(faker.chuckNorris().fact()) | ||
| TicketCreateInput createTicketInput = new TicketCreateInput(ticketComment) | ||
| createTicketInput.setRawSubject(faker.chuckNorris().fact()) | ||
| ticketCreateInputList.add(createTicketInput) | ||
| } | ||
| TicketsCreateRequest createTicketsRequest = new TicketsCreateRequest(ticketCreateInputList) |
Member
There was a problem hiding this comment.
Originally I was thinking to not try to make so many tickets, but I like this. let's keep it, but let's use some groovy syntactic sugar
Suggested change
| List<TicketCreateInput> ticketCreateInputList = new ArrayList<>() | |
| for (int i = 0; i < 100; i++) { | |
| TicketComment ticketComment = new TicketComment().setBody(faker.chuckNorris().fact()) | |
| TicketCreateInput createTicketInput = new TicketCreateInput(ticketComment) | |
| createTicketInput.setRawSubject(faker.chuckNorris().fact()) | |
| ticketCreateInputList.add(createTicketInput) | |
| } | |
| TicketsCreateRequest createTicketsRequest = new TicketsCreateRequest(ticketCreateInputList) | |
| List<TicketCreateInput> inputs = (1..100).collect { | |
| new TicketCreateInput(new TicketComment().setBody(faker.chuckNorris().fact())) | |
| .setRawSubject(faker.book().title()) | |
| } | |
| TicketsCreateRequest createTicketsRequest = new TicketsCreateRequest().setTickets(inputs) |
| [client, clientType, ignored, alsoIgnored] << clientTestMatrix.findAll { !it.shouldSucceed } | ||
| } | ||
|
|
||
| def "calling createTickets() fails when trying to create more than the maximum amount(100) of tickets, even when using the correct client"(TicketClient client, String clientType, Boolean ignored, String alsoIgnored) { |
Member
There was a problem hiding this comment.
great test - see my comment on the last test, otherwise this is great
- JobStatusObject - JobStatusObjectResult - JobStatusResponse feat: add tests for createTickets path.
refactor: change "status" property in JobStatus class from String to JobStatusEnum type.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
feat: add path for createTickets. As well as associated objects.
feat: add tests for createTickets path.