lint:fix

Author: blakmatrix

examples/check-oauth-token.js

@@ -2,6 +2,9 @@ const process = require('node:process');
 const zd = require('../src/index');
 const exampleConfig = require('./exampleConfig');
 
+/**
+ *
+ */
 function getZendeskConfig() {
   return {
     token:
@@ -14,6 +17,9 @@ function getZendeskConfig() {
 
 const client = zd.createClient(getZendeskConfig());
 
+/**
+ *
+ */
 async function checkOAuth() {
   try {
     const {result: user} = await client.users.auth();

examples/delete-many-organizations.js

@@ -18,6 +18,9 @@ const setupClient = (config) => {
 // Placeholder organization ID for development/testing.
 // IMPORTANT: Replace with a valid organization ID before running in production.
 
+/**
+ *
+ */
 async function organizationsDelete() {
   let collector = [];
   try {

examples/endpoint.js

@@ -14,6 +14,9 @@ const setupClient = (config) => {
   });
 };
 
+/**
+ *
+ */
 async function usersList() {
   try {
     const client = setupClient({debug: false});

examples/optional-axios-transport.js

@@ -52,6 +52,9 @@ const setupClient = (config) => {
   });
 };
 
+/**
+ *
+ */
 async function foo() {
   try {
     const client = setupClient({debug: false});

examples/optional-deprecated-request-transport.js

@@ -58,6 +58,9 @@ const setupClient = (config) => {
   });
 };
 
+/**
+ *
+ */
 async function foo() {
   try {
     const client = setupClient({debug: false});

examples/organization-upsert.js

@@ -21,6 +21,10 @@ client.organizations.upsert(organization, function (error, request, result) {
   console.log(JSON.stringify(result, null, 2, true));
 });
 
+/**
+ *
+ * @param error
+ */
 function handleError(error) {
   console.log(error);
   process.exit(-1);

examples/organizations-delete-bulk.js

@@ -7,6 +7,9 @@ const zd = require('../src/index.js');
 
 dotenv.config();
 
+/**
+ *
+ */
 function initializeZendeskClient() {
   return zd.createClient({
     username: process.env.ZENDESK_USERNAME,
@@ -16,12 +19,21 @@ function initializeZendeskClient() {
   });
 }
 
+/**
+ *
+ * @param organizations
+ */
 function getTestOrganizationIds(organizations) {
   return organizations
     .filter((org) => org.name.startsWith('test') || org.name.startsWith('Test'))
     .map((org) => org.id);
 }
 
+/**
+ *
+ * @param array
+ * @param chunkSize
+ */
 function chunkArray(array, chunkSize) {
   const chunks = [];
   for (let i = 0; i < array.length; i += chunkSize) {
@@ -31,6 +43,11 @@ function chunkArray(array, chunkSize) {
   return chunks;
 }
 
+/**
+ *
+ * @param client
+ * @param jobID
+ */
 async function monitorJobCompletion(client, jobID) {
   try {
     await client.jobstatuses.watch(jobID, 1000, 30);
@@ -40,6 +57,9 @@ async function monitorJobCompletion(client, jobID) {
   }
 }
 
+/**
+ *
+ */
 async function bulkDeleteTestOrganizations() {
   const client = initializeZendeskClient();
 

examples/organizations-delete.js

@@ -18,6 +18,9 @@ const setupClient = (config) => {
 // IMPORTANT: Replace with a valid organization ID before running in production.
 const organizationID = 1_234_567_890;
 
+/**
+ *
+ */
 async function organizationsDelete() {
   try {
     const client = setupClient({debug: false});

examples/ticket-create-promise.js

@@ -27,6 +27,10 @@ const ticket = {
   }
 })();
 
+/**
+ *
+ * @param error
+ */
 function handleError(error) {
   console.log(error);
   process.exit(-1);

examples/ticket-create.js

@@ -23,6 +23,10 @@ client.tickets.create(ticket, function (error, request, result) {
   console.log(JSON.stringify(result, null, 2, true));
 });
 
+/**
+ *
+ * @param error
+ */
 function handleError(error) {
   console.log(error);
   process.exit(-1);