Tinirau/open-ticket
3
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Added new API comments (part 11)

Browse Source
This commit is contained in:
JasperAtSchool
2025-01-28 14:22:26 +01:00
parent 58fb7b7512
commit f6c70fa62a
31 changed files with 270 additions and 270 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/core/api/openticket/blacklist.ts
+2 -2
View File
@@ -5,7 +5,7 @@ import { ODManager, ODManagerData, ODValidId } from "../modules/base"
import { ODDebugger } from "../modules/console"
/**## ODBlacklist `class`
* This is an open ticket blacklisted user.
* This is an Open Ticket blacklisted user.
*
* This class contains the id of the user this class belongs to & an optional reason for being blacklisted.
*
@@ -31,7 +31,7 @@ export class ODBlacklist extends ODManagerData {
}
/**## ODBlacklistManager `class`
* This is an open ticket blacklist manager.
* This is an Open Ticket blacklist manager.
*
* This class manages all blacklisted users & their reason. Check if someone is blacklisted using their ID in the `exists()` method.
*
src/core/api/openticket/option.ts
+14 -14
View File
@@ -10,7 +10,7 @@ import * as crypto from "crypto"
import { ODRoleUpdateMode } from "./role"
/**## ODOptionManager `class`
* This is an open ticket option manager.
* This is an Open Ticket option manager.
*
* This class manages all registered options in the bot. This also includes temporary options generated from tickets where the original option got deleted.
*
@@ -59,7 +59,7 @@ export interface ODOptionJson {
}
/**## ODOption `class`
* This is an open ticket option.
* This is an Open Ticket option.
*
* This class contains all data related to this option (parsed from the config).
*
@@ -104,7 +104,7 @@ export class ODOption extends ODManager<ODOptionData<ODValidJsonType>> {
}
/**## ODOptionData `class`
* This is open ticket option data.
* This is Open Ticket option data.
*
* This class contains a single property for an option. (string, number, boolean, object, array, null)
*
@@ -186,7 +186,7 @@ export interface ODTicketOptionIds {
}
/**## ODTicketOption `class`
* This is an open ticket ticket option.
* This is an Open Ticket ticket option.
*
* This class contains all data related to an Open Ticket ticket option (parsed from the config).
*
@@ -240,7 +240,7 @@ export interface ODWebsiteOptionIds {
}
/**## ODWebsiteOption `class`
* This is an open ticket website option.
* This is an Open Ticket website option.
*
* This class contains all data related to an Open Ticket website option (parsed from the config).
*
@@ -298,7 +298,7 @@ export interface ODRoleOptionIds {
}
/**## ODRoleOption `class`
* This is an open ticket role option.
* This is an Open Ticket role option.
*
* This class contains all data related to an Open Ticket role option (parsed from the config).
*
@@ -338,7 +338,7 @@ export class ODRoleOption extends ODOption {
}
/**## ODOptionSuffixManager `class`
* This is an open ticket option suffix manager.
* This is an Open Ticket option suffix manager.
*
* This class manages all suffixes from option in the bot. The id of an option suffix is the same as the option id.
*
@@ -358,7 +358,7 @@ export class ODOptionSuffixManager extends ODManager<ODOptionSuffix> {
}
/**## ODOptionSuffix `class`
* This is an open ticket option suffix.
* This is an Open Ticket option suffix.
*
* This class can generate a suffix for a discord channel name from a specific option.
*
@@ -380,7 +380,7 @@ export class ODOptionSuffix extends ODManagerData {
}
/**## ODOptionUserNameSuffix `class`
* This is an open ticket user-name option suffix.
* This is an Open Ticket user-name option suffix.
*
* This class can generate a user-name suffix for a discord channel name from a specific option.
*
@@ -393,7 +393,7 @@ export class ODOptionUserNameSuffix extends ODOptionSuffix {
}
/**## ODOptionUserIdSuffix `class`
* This is an open ticket user-id option suffix.
* This is an Open Ticket user-id option suffix.
*
* This class can generate a user-id suffix for a discord channel name from a specific option.
*
@@ -406,7 +406,7 @@ export class ODOptionUserIdSuffix extends ODOptionSuffix {
}
/**## ODOptionCounterDynamicSuffix `class`
* This is an open ticket counter-dynamic option suffix.
* This is an Open Ticket counter-dynamic option suffix.
*
* This class can generate a counter-dynamic suffix for a discord channel name from a specific option.
*
@@ -436,7 +436,7 @@ export class ODOptionCounterDynamicSuffix extends ODOptionSuffix {
}
/**## ODOptionCounterFixedSuffix `class`
* This is an open ticket counter-fixed option suffix.
* This is an Open Ticket counter-fixed option suffix.
*
* This class can generate a counter-fixed suffix for a discord channel name from a specific option.
*
@@ -470,7 +470,7 @@ export class ODOptionCounterFixedSuffix extends ODOptionSuffix {
}
/**## ODOptionRandomNumberSuffix `class`
* This is an open ticket random-number option suffix.
* This is an Open Ticket random-number option suffix.
*
* This class can generate a random-number suffix for a discord channel name from a specific option.
*
@@ -513,7 +513,7 @@ export class ODOptionRandomNumberSuffix extends ODOptionSuffix {
}
/**## ODOptionRandomHexSuffix `class`
* This is an open ticket random-hex option suffix.
* This is an Open Ticket random-hex option suffix.
*
* This class can generate a random-hex suffix for a discord channel name from a specific option.
*
src/core/api/openticket/panel.ts
+3 -3
View File
@@ -6,7 +6,7 @@ import { ODId, ODManager, ODValidJsonType, ODValidId, ODVersion, ODValidButtonCo
import { ODDebugger } from "../modules/console"
/**## ODPanelManager `class`
* This is an open ticket panel manager.
* This is an Open Ticket panel manager.
*
* This class manages all registered panels in the bot. Only panels which are available in this manager can be auto-updated.
*
@@ -74,7 +74,7 @@ export interface ODPanelIds {
}
/**## ODPanel `class`
* This is an open ticket panel.
* This is an Open Ticket panel.
*
* This class contains all data related to this panel (parsed from the config).
*/
@@ -134,7 +134,7 @@ export class ODPanel extends ODManager<ODPanelData<ODValidJsonType>> {
}
/**## ODPanelData `class`
* This is open ticket panel data.
* This is Open Ticket panel data.
*
* This class contains a single property for a panel. (string, number, boolean, object, array, null)
*
src/core/api/openticket/question.ts
+5 -5
View File
@@ -5,7 +5,7 @@ import { ODId, ODManager, ODValidJsonType, ODValidId, ODVersion, ODManagerData }
import { ODDebugger } from "../modules/console"
/**## ODQuestionManager `class`
* This is an open ticket question manager.
* This is an Open Ticket question manager.
*
* This class manages all registered questions in the bot. Only questions which are available in this manager can be used in options.
*
@@ -51,7 +51,7 @@ export interface ODQuestionJson {
}
/**## ODQuestion `class`
* This is an open ticket question.
* This is an Open Ticket question.
*
* This class contains all data related to this question (parsed from the config).
*
@@ -96,7 +96,7 @@ export class ODQuestion extends ODManager<ODQuestionData<ODValidJsonType>> {
}
/**## ODQuestionData `class`
* This is open ticket question data.
* This is Open Ticket question data.
*
* This class contains a single property for a question. (string, number, boolean, object, array, null)
*
@@ -140,7 +140,7 @@ export interface ODShortQuestionIds {
}
/**## ODShortQuestion `class`
* This is an open ticket short question.
* This is an Open Ticket short question.
*
* This class contains all data related to an Open Ticket short question (parsed from the config).
*
@@ -194,7 +194,7 @@ export interface ODParagraphQuestionIds {
}
/**## ODParagraphQuestion `class`
* This is an open ticket paragraph question.
* This is an Open Ticket paragraph question.
*
* This class contains all data related to an Open Ticket paragraph question (parsed from the config).
*
src/core/api/openticket/role.ts
+3 -3
View File
@@ -6,7 +6,7 @@ import { ODDebugger } from "../modules/console"
import * as discord from "discord.js"
/**## ODRoleManager `class`
* This is an open ticket role manager.
* This is an Open Ticket role manager.
*
* This class manages all registered reaction roles in the bot.
*
@@ -61,7 +61,7 @@ export interface ODRoleIds {
}
/**## ODRole `class`
* This is an open ticket role.
* This is an Open Ticket role.
*
* This class contains all data related to this role (parsed from the config).
*
@@ -123,7 +123,7 @@ export class ODRole extends ODManager<ODRoleData<ODValidJsonType>> {
}
/**## ODRoleData `class`
* This is open ticket role data.
* This is Open Ticket role data.
*
* This class contains a single property for a role. (string, number, boolean, object, array, null)
*
src/core/api/openticket/ticket.ts
+2 -2
View File
@@ -8,7 +8,7 @@ import { ODTicketOption } from "./option"
import * as discord from "discord.js"
/**## ODTicketManager `class`
* This is an open ticket ticket manager.
* This is an Open Ticket ticket manager.
*
* This class manages all currently created tickets in the bot.
*
@@ -261,7 +261,7 @@ export class ODTicket extends ODManager<ODTicketData<ODValidJsonType>> {
}
/**## ODTicketData `class`
* This is open ticket ticket data.
* This is Open Ticket ticket data.
*
* This class contains a single property for a ticket. (string, number, boolean, object, array, null)
*