From 1f794fb273cd8a4438ace1ad78d879edb329122a Mon Sep 17 00:00:00 2001
From: Farrin Reid <blakmatrix@gmail.com>
Date: Tue, 26 Nov 2024 16:54:11 -0800
Subject: [PATCH] fix(docs): correct JSDoc param syntax to fix build issues

- Updated JSDoc `@param` annotations in `ticketimport.js` to use `tickets[].field` syntax, ensuring compatibility with VitePress.
- Added `.temp` directory to `.gitignore` to prevent unnecessary files from being tracked.
- These changes resolve the issue where the docs build was failing due to improper parsing of the `@param` block.
---
 .gitignore                       |  1 +
 src/clients/core/ticketimport.js | 12 ++++++------
 2 files changed, 7 insertions(+), 6 deletions(-)

diff --git a/.gitignore b/.gitignore
index 4d62a453..f2f0ef55 100644
--- a/.gitignore
+++ b/.gitignore
@@ -47,6 +47,7 @@ jspm_packages/
 # vitepress build/dev output
 docs/.vitepress/dist
 docs/.vitepress/cache
+docs/.vitepress/.temp
 docs/api/
 docs/code/
 
diff --git a/src/clients/core/ticketimport.js b/src/clients/core/ticketimport.js
index 3899ce4e..921ef16a 100644
--- a/src/clients/core/ticketimport.js
+++ b/src/clients/core/ticketimport.js
@@ -58,12 +58,12 @@ class TicketImport extends Client {
   /**
    * Bulk imports multiple tickets into Zendesk.
    * @param {Array<object>} tickets - An array containing ticket data to be imported. Each ticket should include the following fields:
-   *   - `assignee_id` (number): The ID of the user to assign this ticket to.
-   *   - `comments` (Array<Object>): Array of comments associated with the ticket.
-   *   - `description` (string): The description of the ticket.
-   *   - `requester_id` (number): The ID of the user requesting the ticket.
-   *   - `subject` (string): The subject of the ticket.
-   *   - `tags` (Array<string>): Array of tags associated with the ticket.
+   * @param {number} tickets[].assignee_id - The ID of the user to assign this ticket to.
+   * @param {Array<object>} tickets[].comments - Array of comments associated with the ticket.
+   * @param {string} tickets[].description - The description of the ticket.
+   * @param {number} tickets[].requester_id - The ID of the user requesting the ticket.
+   * @param {string} tickets[].subject - The subject of the ticket.
+   * @param {Array<string>} tickets[].tags - Array of tags associated with the ticket.
    * **Note**: While these fields are required for each ticket object, they are not directly accessed within this function. The entire array of tickets is passed to the Zendesk API.
    * @returns {Promise<{response: object, result: object}>} The response from the Zendesk API, including a job status object.
    * @throws {Error} Throws an error if the request to the Zendesk API fails.