@@ -122,6 +122,11 @@ const {Client} = require('../client');
122
122
* @property {RecursivePartial<Ticket> } [ticket] - The ticket object to create or update.
123
123
*/
124
124
125
+ /**
126
+ * @typedef {object } CreateManyTickets
127
+ * @property {Array<Ticket> } [tickets] - The ticket object to create many tickets.
128
+ */
129
+
125
130
/**
126
131
* @class
127
132
* Client for the Zendesk API - Tickets.
@@ -320,17 +325,19 @@ class Tickets extends Client {
320
325
321
326
/**
322
327
* 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 .
324
329
* @returns {Promise<Array<Ticket>> } A promise that resolves to an array of created ticket objects.
325
330
* @async
326
331
* @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 }
328
333
* @example
329
334
* // 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
+ * };
334
341
* const createdTickets = await client.tickets.createMany(newTickets);
335
342
*/
336
343
async createMany ( tickets ) {
0 commit comments