Skip to content

Commit e396120

Browse files
authored
Merge pull request #412 from 1frenk6/fix-create-many-tickets-type
Changed create-many tickets object type
2 parents c2a85ad + eebd5d4 commit e396120

File tree

1 file changed

+13
-6
lines changed

1 file changed

+13
-6
lines changed

src/clients/core/tickets.js

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -122,6 +122,11 @@ const {Client} = require('../client');
122122
* @property {RecursivePartial<Ticket>} [ticket] - The ticket object to create or update.
123123
*/
124124

125+
/**
126+
* @typedef {object} CreateManyTickets
127+
* @property {Array<Ticket>} [tickets] - The ticket object to create many tickets.
128+
*/
129+
125130
/**
126131
* @class
127132
* Client for the Zendesk API - Tickets.
@@ -320,17 +325,19 @@ class Tickets extends Client {
320325

321326
/**
322327
* Create multiple new tickets.
323-
* @param {Array<CreateOrUpdateTicket>} tickets - An array of ticket objects to create.
328+
* @param {CreateManyTickets} tickets - An object of tickets containing an array of tickets.
324329
* @returns {Promise<Array<Ticket>>} A promise that resolves to an array of created ticket objects.
325330
* @async
326331
* @throws {Error} If the provided `tickets` is not an array or is empty.
327-
* @see {@link https://developer.zendesk.com/api-reference/ticketing/tickets/tickets/#create-multiple-tickets}
332+
* @see {@link https://developer.zendesk.com/api-reference/ticketing/tickets/tickets/#create-many-tickets}
328333
* @example
329334
* // Create multiple new tickets
330-
* const newTickets = [
331-
* { subject: 'Ticket 1', description: 'Description 1' },
332-
* { subject: 'Ticket 2', description: 'Description 2' },
333-
* ];
335+
* const newTickets = {
336+
* tickets: [
337+
* { subject: 'Ticket 1', description: 'Description 1' },
338+
* { subject: 'Ticket 2', description: 'Description 2' },
339+
* ]
340+
* };
334341
* const createdTickets = await client.tickets.createMany(newTickets);
335342
*/
336343
async createMany(tickets) {

0 commit comments

Comments
 (0)