Ivan - OpenSupports v4.1.0 release changes
This commit is contained in:
ivan
parent
0a060bd825
commit
989c2e35f8
|
|
@ -1,13 +1,13 @@
|
|||
{
|
||||
"name": "os4-react",
|
||||
"version": "4.0.0",
|
||||
"author": "Ivan Diaz <ivan@opensupports.com>",
|
||||
"description": "OpenSupports version 4 with reactjs",
|
||||
"name": "OpenSupports",
|
||||
"version": "4.1.0",
|
||||
"author": "Ivan Diaz <contact@opensupports.com>",
|
||||
"description": "Open source ticket system made with PHP and ReactJS",
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "https://github.com/ivandiazwm/opensupports.git"
|
||||
"url": "https://github.com/opensupports/opensupports"
|
||||
},
|
||||
"private": true,
|
||||
"private": false,
|
||||
"engines": {
|
||||
"node": "^0.12.x",
|
||||
"npm": "^2.1.x"
|
||||
|
|
|
|||
|
|
@ -0,0 +1,82 @@
|
|||
|
||||
/**
|
||||
* @api {post} /staff/get Get staff
|
||||
* @apiVersion 4.0.0
|
||||
*
|
||||
* @apiName Get staff
|
||||
*
|
||||
* @apiGroup Staff
|
||||
*
|
||||
* @apiDescription This path retrieves information about a staff member.
|
||||
*
|
||||
* @apiPermission staff1
|
||||
*
|
||||
* @apiParam {Number} staffId The id of the staff member to be searched.
|
||||
*
|
||||
* @apiUse NO_PERMISSION
|
||||
*
|
||||
* @apiSuccess {Object} data Information about a staff member
|
||||
* @apiSuccess {String} data.name Staff id
|
||||
* @apiSuccess {String} data.email Staff id
|
||||
* @apiSuccess {String} data.profilePic Staff id
|
||||
* @apiSuccess {Number} data.level Staff id
|
||||
* @apiSuccess {Boolean} data.staff Staff id
|
||||
* @apiSuccess {[Department](#api-Data_Structures-ObjectDepartment)[]} data.departments Array of departments that has assigned.
|
||||
* @apiSuccess {[Ticket](#api-Data_Structures-ObjectTicket)[]} data.tickets Array of tickets that has assigned.
|
||||
*
|
||||
*/
|
||||
|
||||
/**
|
||||
* @api {get} /system/download Download file
|
||||
* @apiVersion 4.0.0
|
||||
*
|
||||
* @apiName Download file
|
||||
*
|
||||
* @apiGroup System
|
||||
*
|
||||
* @apiDescription This path downloads a file.
|
||||
*
|
||||
* @apiPermission any
|
||||
*
|
||||
* @apiParam {String} file The filename to be downloaded.
|
||||
*
|
||||
*
|
||||
* @apiSuccess {Object} file File content
|
||||
*
|
||||
*/
|
||||
|
||||
/**
|
||||
* @api {post} /system/init-settings Init settings
|
||||
* @apiVersion 4.0.0
|
||||
*
|
||||
* @apiName Init settings
|
||||
*
|
||||
* @apiGroup System
|
||||
*
|
||||
* @apiDescription This path sets the initial settings. It can only be used once during installation.
|
||||
*
|
||||
* @apiPermission any
|
||||
*
|
||||
* @apiParam {String} language Indicates the default language of the system.
|
||||
* @apiParam {String} user-system-enabled Indicates if the user system should be enabled.
|
||||
* @apiParam {String} registration Indicates if the registration should be enabled.
|
||||
*
|
||||
* @apiUse INVALID_LANGUAGE
|
||||
* @apiUse INIT_SETTINGS_DONE
|
||||
*
|
||||
* @apiSuccess {Object} data Empty object
|
||||
*
|
||||
*/
|
||||
|
||||
/**
|
||||
* @api {OBJECT} Staff Staff
|
||||
* @apiVersion 4.0.0
|
||||
* @apiGroup Data Structures
|
||||
* @apiParam {String} name Name of the staff member.
|
||||
* @apiParam {String} email Email of the staff member.
|
||||
* @apiParam {String} profilePic profilePic url of the staff member.
|
||||
* @apiParam {Number} level Level of the staff member.
|
||||
* @apiParam {Object[]} departments The departments the staff member has assigned.
|
||||
* @apiParam {[Ticket](#api-Data_Structures-ObjectTicket)[]} tickets The tickets the staff member has assigned.
|
||||
* @apiParam {Number} lastLogin The last login of the staff member.
|
||||
*/
|
||||
|
|
@ -1,6 +1,6 @@
|
|||
{
|
||||
"name": "OpenSupports API Documentation",
|
||||
"version": "4.0.0",
|
||||
"version": "4.1.0",
|
||||
"title": "OpenSupports API Documentation",
|
||||
"description": "Backend API documentation for developers.",
|
||||
"header": {
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ DataValidator::with('CustomValidations', true);
|
|||
|
||||
/**
|
||||
* @api {post} /article/add-topic Add topic
|
||||
* @apiVersion 4.0.0
|
||||
* @apiVersion 4.1.0
|
||||
*
|
||||
* @apiName Add topic
|
||||
*
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ DataValidator::with('CustomValidations', true);
|
|||
|
||||
/**
|
||||
* @api {post} /article/add Add article
|
||||
* @apiVersion 4.0.0
|
||||
* @apiVersion 4.1.0
|
||||
*
|
||||
* @apiName Add article
|
||||
*
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ DataValidator::with('CustomValidations', true);
|
|||
|
||||
/**
|
||||
* @api {post} /article/delete-topic Delete topic
|
||||
* @apiVersion 4.0.0
|
||||
* @apiVersion 4.1.0
|
||||
*
|
||||
* @apiName Delete topic
|
||||
*
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ DataValidator::with('CustomValidations', true);
|
|||
|
||||
/**
|
||||
* @api {post} /article/delete Delete article
|
||||
* @apiVersion 4.0.0
|
||||
* @apiVersion 4.1.0
|
||||
*
|
||||
* @apiName Delete article
|
||||
*
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ DataValidator::with('CustomValidations', true);
|
|||
|
||||
/**
|
||||
* @api {post} /article/edit-topic Edit topic
|
||||
* @apiVersion 4.0.0
|
||||
* @apiVersion 4.1.0
|
||||
*
|
||||
* @apiName Edit topic
|
||||
*
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ DataValidator::with('CustomValidations', true);
|
|||
|
||||
/**
|
||||
* @api {post} /article/edit Edit article
|
||||
* @apiVersion 4.0.0
|
||||
* @apiVersion 4.1.0
|
||||
*
|
||||
* @apiName Edit a article
|
||||
*
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ DataValidator::with('CustomValidations', true);
|
|||
|
||||
/**
|
||||
* @api {post} /article/get-all Get all articles
|
||||
* @apiVersion 4.0.0
|
||||
* @apiVersion 4.1.0
|
||||
*
|
||||
* @apiName Get all articles
|
||||
*
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ DataValidator::with('CustomValidations', true);
|
|||
|
||||
/**
|
||||
* @api {post} /staff/add Add staff
|
||||
* @apiVersion 4.0.0
|
||||
* @apiVersion 4.1.0
|
||||
*
|
||||
* @apiName Add staff
|
||||
*
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ DataValidator::with('CustomValidations', true);
|
|||
|
||||
/**
|
||||
* @api {post} /staff/assign-ticket Assign ticket
|
||||
* @apiVersion 4.0.0
|
||||
* @apiVersion 4.1.0
|
||||
*
|
||||
* @apiName Assign ticket
|
||||
*
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ use RedBeanPHP\Facade as RedBean;
|
|||
|
||||
/**
|
||||
* @api {post} /staff/delete Delete staff
|
||||
* @apiVersion 4.0.0
|
||||
* @apiVersion 4.1.0
|
||||
*
|
||||
* @apiName Delete staff
|
||||
*
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ use Respect\Validation\Validator as DataValidator;
|
|||
|
||||
/**
|
||||
* @api {post} /staff/edit Edit staff
|
||||
* @apiVersion 4.0.0
|
||||
* @apiVersion 4.1.0
|
||||
*
|
||||
* @apiName Edit staff
|
||||
*
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ use Respect\Validation\Validator as DataValidator;
|
|||
|
||||
/**
|
||||
* @api {post} /staff/get-all-tickets Get all tickets
|
||||
* @apiVersion 4.0.0
|
||||
* @apiVersion 4.1.0
|
||||
*
|
||||
* @apiName Get all tickets
|
||||
*
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ use Respect\Validation\Validator as DataValidator;
|
|||
|
||||
/**
|
||||
* @api {post} /staff/get-all Get all staffs
|
||||
* @apiVersion 4.0.0
|
||||
* @apiVersion 4.1.0
|
||||
*
|
||||
* @apiName Get all staffs
|
||||
*
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ use Respect\Validation\Validator as DataValidator;
|
|||
|
||||
/**
|
||||
* @api {post} /staff/get-new-tickets Get new tickets
|
||||
* @apiVersion 4.0.0
|
||||
* @apiVersion 4.1.0
|
||||
*
|
||||
* @apiName Get new tickets
|
||||
*
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ use Respect\Validation\Validator as DataValidator;
|
|||
|
||||
/**
|
||||
* @api {post} /staff/get-tickets Get tickets
|
||||
* @apiVersion 4.0.0
|
||||
* @apiVersion 4.1.0
|
||||
*
|
||||
* @apiName Get tickets
|
||||
*
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ DataValidator::with('CustomValidations', true);
|
|||
|
||||
/**
|
||||
* @api {post} /staff/get Get staff
|
||||
* @apiVersion 4.0.0
|
||||
* @apiVersion 4.1.0
|
||||
*
|
||||
* @apiName Get staff
|
||||
*
|
||||
|
|
@ -19,13 +19,14 @@ DataValidator::with('CustomValidations', true);
|
|||
* @apiUse NO_PERMISSION
|
||||
*
|
||||
* @apiSuccess {Object} data Information about a staff member
|
||||
* @apiSuccess {String} data.name Staff id
|
||||
* @apiSuccess {String} data.email Staff id
|
||||
* @apiSuccess {String} data.profilePic Staff id
|
||||
* @apiSuccess {Number} data.level Staff id
|
||||
* @apiSuccess {Boolean} data.staff Staff id
|
||||
* @apiSuccess {String} data.name Name of the staff member
|
||||
* @apiSuccess {String} data.email Elmail of the staff member
|
||||
* @apiSuccess {String} data.profilePic Profile pic filename of staff member
|
||||
* @apiSuccess {Number} data.level Level of staff member
|
||||
* @apiSuccess {Boolean} data.staff Indicates that it is a staff (always true)
|
||||
* @apiSuccess {[Department](#api-Data_Structures-ObjectDepartment)[]} data.departments Array of departments that has assigned.
|
||||
* @apiSuccess {[Ticket](#api-Data_Structures-ObjectTicket)[]} data.tickets Array of tickets that has assigned.
|
||||
* @apiSuccess {Boolean} data.sendEmailOnNewTicket Indicates if this member receives a mail when a ticket is created.
|
||||
*
|
||||
*/
|
||||
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ use Respect\Validation\Validator as DataValidator;
|
|||
|
||||
/**
|
||||
* @api {post} /staff/last-events Get last events
|
||||
* @apiVersion 4.0.0
|
||||
* @apiVersion 4.1.0
|
||||
*
|
||||
* @apiName Get last events
|
||||
*
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ use Respect\Validation\Validator as DataValidator;
|
|||
|
||||
/**
|
||||
* @api {post} /staff/search-tickets Search tickets
|
||||
* @apiVersion 4.0.0
|
||||
* @apiVersion 4.1.0
|
||||
*
|
||||
* @apiName Search tickets
|
||||
*
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ DataValidator::with('CustomValidations', true);
|
|||
|
||||
/**
|
||||
* @api {post} /staff/un-assign-ticket Un-assign ticket
|
||||
* @apiVersion 4.0.0
|
||||
* @apiVersion 4.1.0
|
||||
*
|
||||
* @apiName Un-assign ticket
|
||||
*
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ use Respect\Validation\Validator as DataValidator;
|
|||
|
||||
/**
|
||||
* @api {post} /system/add-api-key Add APIKey
|
||||
* @apiVersion 4.0.0
|
||||
* @apiVersion 4.1.0
|
||||
*
|
||||
* @apiName Add APIKey
|
||||
*
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ use Respect\Validation\Validator as DataValidator;
|
|||
|
||||
/**
|
||||
* @api {post} /system/add-department Add department
|
||||
* @apiVersion 4.0.0
|
||||
* @apiVersion 4.1.0
|
||||
*
|
||||
* @apiName Add department
|
||||
*
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ use Ifsnop\Mysqldump as IMysqldump;
|
|||
|
||||
/**
|
||||
* @api {post} /system/backup-database Backup database
|
||||
* @apiVersion 4.0.0
|
||||
* @apiVersion 4.1.0
|
||||
*
|
||||
* @apiName Backup database
|
||||
*
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
/**
|
||||
* @api {post} /system/check-requirements Checks requirements
|
||||
* @apiVersion 4.0.0
|
||||
* @apiVersion 4.1.0
|
||||
*
|
||||
* @apiName Check requirements
|
||||
*
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
/**
|
||||
* @api {post} /system/csv-import CSV import
|
||||
* @apiVersion 4.0.0
|
||||
* @apiVersion 4.1.0
|
||||
*
|
||||
* @apiName CSV import
|
||||
*
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ use RedBeanPHP\Facade as RedBean;
|
|||
|
||||
/**
|
||||
* @api {post} /system/delete-all-users Delete all users
|
||||
* @apiVersion 4.0.0
|
||||
* @apiVersion 4.1.0
|
||||
*
|
||||
* @apiName Delete all users
|
||||
*
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ use Respect\Validation\Validator as DataValidator;
|
|||
|
||||
/**
|
||||
* @api {post} /system/delete-api-key Delete APIKey
|
||||
* @apiVersion 4.0.0
|
||||
* @apiVersion 4.1.0
|
||||
*
|
||||
* @apiName Delete APIKey
|
||||
*
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ DataValidator::with('CustomValidations', true);
|
|||
|
||||
/**
|
||||
* @api {post} /system/delete-department Delete department
|
||||
* @apiVersion 4.0.0
|
||||
* @apiVersion 4.1.0
|
||||
*
|
||||
* @apiName Delete department
|
||||
*
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
/**
|
||||
* @api {post} /system/disable-registration Disable registration
|
||||
* @apiVersion 4.0.0
|
||||
* @apiVersion 4.1.0
|
||||
*
|
||||
* @apiName Disable registration
|
||||
*
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
/**
|
||||
* @api {post} /system/disable-user-system Disable user system
|
||||
* @apiVersion 4.0.0
|
||||
* @apiVersion 4.1.0
|
||||
*
|
||||
* @apiName Disable user system
|
||||
*
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ use Respect\Validation\Validator as DataValidator;
|
|||
|
||||
/**
|
||||
* @api {get} /system/download Download file
|
||||
* @apiVersion 4.0.0
|
||||
* @apiVersion 4.1.0
|
||||
*
|
||||
* @apiName Download file
|
||||
*
|
||||
|
|
@ -16,6 +16,7 @@ use Respect\Validation\Validator as DataValidator;
|
|||
*
|
||||
* @apiParam {String} file The filename to be downloaded.
|
||||
*
|
||||
* @apiError 403 You have no permission to access the file.
|
||||
*
|
||||
* @apiSuccess {Object} file File content
|
||||
*
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ DataValidator::with('CustomValidations', true);
|
|||
|
||||
/**
|
||||
* @api {post} /system/edit-department Edit department
|
||||
* @apiVersion 4.0.0
|
||||
* @apiVersion 4.1.0
|
||||
*
|
||||
* @apiName Edit department
|
||||
*
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ use Respect\Validation\Validator as DataValidator;
|
|||
|
||||
/**
|
||||
* @api {post} /system/edit-mail-template Edit mail template
|
||||
* @apiVersion 4.0.0
|
||||
* @apiVersion 4.1.0
|
||||
*
|
||||
* @apiName Edit mail template
|
||||
*
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
/**
|
||||
* @api {post} /system/edit-settings Edit settings
|
||||
* @apiVersion 4.0.0
|
||||
* @apiVersion 4.1.0
|
||||
*
|
||||
* @apiName Edit settings
|
||||
*
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ use Respect\Validation\Validator as DataValidator;
|
|||
|
||||
/**
|
||||
* @api {post} /system/enable-registration Enable registration
|
||||
* @apiVersion 4.0.0
|
||||
* @apiVersion 4.1.0
|
||||
*
|
||||
* @apiName Enable registration
|
||||
*
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
/**
|
||||
* @api {post} /system/enable-user-system Enable user system
|
||||
* @apiVersion 4.0.0
|
||||
* @apiVersion 4.1.0
|
||||
*
|
||||
* @apiName Enable user system
|
||||
*
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ use Respect\Validation\Validator as DataValidator;
|
|||
|
||||
/**
|
||||
* @api {post} /system/get-api-keys Get APIKeys
|
||||
* @apiVersion 4.0.0
|
||||
* @apiVersion 4.1.0
|
||||
*
|
||||
* @apiName Get APIKeys
|
||||
*
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ use Respect\Validation\Validator as DataValidator;
|
|||
|
||||
/**
|
||||
* @api {post} /system/get-logs Get logs
|
||||
* @apiVersion 4.0.0
|
||||
* @apiVersion 4.1.0
|
||||
*
|
||||
* @apiName Get logs
|
||||
*
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ use Respect\Validation\Validator as DataValidator;
|
|||
|
||||
/**
|
||||
* @api {post} /system/get-mail-templates Get mail templates
|
||||
* @apiVersion 4.0.0
|
||||
* @apiVersion 4.1.0
|
||||
*
|
||||
* @apiName Get mail templates
|
||||
*
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
/**
|
||||
* @api {post} /system/get-settings Get settings
|
||||
* @apiVersion 4.0.0
|
||||
* @apiVersion 4.1.0
|
||||
*
|
||||
* @apiName Get settings
|
||||
*
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ use Respect\Validation\Validator as DataValidator;
|
|||
|
||||
/**
|
||||
* @api {post} /system/get-stats Get stats
|
||||
* @apiVersion 4.0.0
|
||||
* @apiVersion 4.1.0
|
||||
*
|
||||
* @apiName Get stats
|
||||
*
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ DataValidator::with('CustomValidations', true);
|
|||
|
||||
/**
|
||||
* @api {post} /system/init-admin Init admin
|
||||
* @apiVersion 4.0.0
|
||||
* @apiVersion 4.1.0
|
||||
*
|
||||
* @apiName Init admin
|
||||
*
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ use RedBeanPHP\Facade as RedBean;
|
|||
|
||||
/**
|
||||
* @api {post} /system/init-database Init database
|
||||
* @apiVersion 4.0.0
|
||||
* @apiVersion 4.1.0
|
||||
*
|
||||
* @apiName Init database
|
||||
*
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ DataValidator::with('CustomValidations', true);
|
|||
|
||||
/**
|
||||
* @api {post} /system/init-settings Init settings
|
||||
* @apiVersion 4.0.0
|
||||
* @apiVersion 4.1.0
|
||||
*
|
||||
* @apiName Init settings
|
||||
*
|
||||
|
|
@ -17,6 +17,14 @@ DataValidator::with('CustomValidations', true);
|
|||
* @apiParam {String} language Indicates the default language of the system.
|
||||
* @apiParam {String} user-system-enabled Indicates if the user system should be enabled.
|
||||
* @apiParam {String} registration Indicates if the registration should be enabled.
|
||||
* @apiParam {String} no-reply-email Email from where automated emails will be sent.
|
||||
* @apiParam {String} smtp-host SMTP Server address.
|
||||
* @apiParam {String} smtp-port SMTP Server port.
|
||||
* @apiParam {String} smtp-user SMTP Authentication User.
|
||||
* @apiParam {String} smtp-pass SMTP Authentication Password.
|
||||
* @apiParam {String} allow-attachments Indicates if files can be attached to tickets and comments.
|
||||
* @apiParam {String} title Title of the support center
|
||||
* @apiParam {String} url Url of the frontend client.
|
||||
*
|
||||
* @apiUse INVALID_LANGUAGE
|
||||
* @apiUse INIT_SETTINGS_DONE
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ use RedBeanPHP\Facade as RedBean;
|
|||
|
||||
/**
|
||||
* @api {post} /system/installation-done Installation done
|
||||
* @apiVersion 4.0.0
|
||||
* @apiVersion 4.1.0
|
||||
*
|
||||
* @apiName Installation done
|
||||
*
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ use Respect\Validation\Validator as DataValidator;
|
|||
|
||||
/**
|
||||
* @api {post} /system/recover-mail-template Recover mail template
|
||||
* @apiVersion 4.0.0
|
||||
* @apiVersion 4.1.0
|
||||
*
|
||||
* @apiName Recover mail template
|
||||
*
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ DataValidator::with('CustomValidations', true);
|
|||
|
||||
/**
|
||||
* @api {post} /ticket/add-custom-response Add custom responses
|
||||
* @apiVersion 4.0.0
|
||||
* @apiVersion 4.1.0
|
||||
*
|
||||
* @apiName Add a custom response
|
||||
*
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ DataValidator::with('CustomValidations', true);
|
|||
|
||||
/**
|
||||
* @api {post} /ticket/change-department Change department
|
||||
* @apiVersion 4.0.0
|
||||
* @apiVersion 4.1.0
|
||||
*
|
||||
* @apiName Change department
|
||||
*
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ use Respect\Validation\Validator as DataValidator;
|
|||
|
||||
/**
|
||||
* @api {post} /ticket/change-priority Change priority
|
||||
* @apiVersion 4.0.0
|
||||
* @apiVersion 4.1.0
|
||||
*
|
||||
* @apiName Change priority
|
||||
*
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ DataValidator::with('CustomValidations', true);
|
|||
|
||||
/**
|
||||
* @api {post} /ticket/check Check ticket
|
||||
* @apiVersion 4.0.0
|
||||
* @apiVersion 4.1.0
|
||||
*
|
||||
* @apiName Check ticket
|
||||
*
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ DataValidator::with('CustomValidations', true);
|
|||
|
||||
/**
|
||||
* @api {post} /ticket/close Close ticket
|
||||
* @apiVersion 4.0.0
|
||||
* @apiVersion 4.1.0
|
||||
*
|
||||
* @apiName Close
|
||||
*
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ DataValidator::with('CustomValidations', true);
|
|||
|
||||
/**
|
||||
* @api {post} /ticket/comment Comment ticket
|
||||
* @apiVersion 4.0.0
|
||||
* @apiVersion 4.1.0
|
||||
*
|
||||
* @apiName Comment ticket
|
||||
*
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ DataValidator::with('CustomValidations', true);
|
|||
|
||||
/**
|
||||
* @api {post} /ticket/create Create ticket
|
||||
* @apiVersion 4.0.0
|
||||
* @apiVersion 4.1.0
|
||||
*
|
||||
* @apiName Create ticket
|
||||
*
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ DataValidator::with('CustomValidations', true);
|
|||
|
||||
/**
|
||||
* @api {post} /ticket/delete-custom-response Delete custom response
|
||||
* @apiVersion 4.0.0
|
||||
* @apiVersion 4.1.0
|
||||
*
|
||||
* @apiName Delete custom response
|
||||
*
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ DataValidator::with('CustomValidations', true);
|
|||
|
||||
/**
|
||||
* @api {post} /ticket/edit-custom-response Edit custom response
|
||||
* @apiVersion 4.0.0
|
||||
* @apiVersion 4.1.0
|
||||
*
|
||||
* @apiName Edit custom response
|
||||
*
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ DataValidator::with('CustomValidations', true);
|
|||
|
||||
/**
|
||||
* @api {post} /ticket/get-custom-responses Get custom responses
|
||||
* @apiVersion 4.0.0
|
||||
* @apiVersion 4.1.0
|
||||
*
|
||||
* @apiName Get custom responses
|
||||
*
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ use Respect\Validation\Validator as DataValidator;
|
|||
DataValidator::with('CustomValidations', true);
|
||||
/**
|
||||
* @api {post} /ticket/get Get ticket
|
||||
* @apiVersion 4.0.0
|
||||
* @apiVersion 4.1.0
|
||||
*
|
||||
* @apiName Get ticket
|
||||
*
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ use Respect\Validation\Validator as DataValidator;
|
|||
|
||||
/**
|
||||
* @api {post} /ticket/re-open Reopen ticket
|
||||
* @apiVersion 4.0.0
|
||||
* @apiVersion 4.1.0
|
||||
*
|
||||
* @apiName Reopen ticket
|
||||
*
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ use Respect\Validation\Validator as DataValidator;
|
|||
|
||||
/**
|
||||
* @api {post} /ticket/seen See ticket
|
||||
* @apiVersion 4.0.0
|
||||
* @apiVersion 4.1.0
|
||||
*
|
||||
* @apiName See ticket
|
||||
*
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ use Respect\Validation\Validator as DataValidator;
|
|||
|
||||
/**
|
||||
* @api {post} /user/ban Ban email
|
||||
* @apiVersion 4.0.0
|
||||
* @apiVersion 4.1.0
|
||||
*
|
||||
* @apiName Ban email
|
||||
*
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
/**
|
||||
* @api {post} /user/check-session Check session
|
||||
* @apiVersion 4.0.0
|
||||
* @apiVersion 4.1.0
|
||||
*
|
||||
* @apiName Check session
|
||||
*
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ use RedBeanPHP\Facade as RedBean;
|
|||
|
||||
/**
|
||||
* @api {post} /user/delete Delete user
|
||||
* @apiVersion 4.0.0
|
||||
* @apiVersion 4.1.0
|
||||
*
|
||||
* @apiName Delete user
|
||||
*
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ use Respect\Validation\Validator as DataValidator;
|
|||
|
||||
/**
|
||||
* @api {post} /user/edit-email Edit email
|
||||
* @apiVersion 4.0.0
|
||||
* @apiVersion 4.1.0
|
||||
*
|
||||
* @apiName Edit email
|
||||
*
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ use Respect\Validation\Validator as DataValidator;
|
|||
|
||||
/**
|
||||
* @api {post} /user/edit-password Edit password
|
||||
* @apiVersion 4.0.0
|
||||
* @apiVersion 4.1.0
|
||||
*
|
||||
* @apiName Edit password
|
||||
*
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ DataValidator::with('CustomValidations', true);
|
|||
|
||||
/**
|
||||
* @api {post} /user/get-user Get user information
|
||||
* @apiVersion 4.0.0
|
||||
* @apiVersion 4.1.0
|
||||
*
|
||||
* @apiName Get user information
|
||||
*
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ use Respect\Validation\Validator as DataValidator;
|
|||
|
||||
/**
|
||||
* @api {post} /user/get-users Get users list
|
||||
* @apiVersion 4.0.0
|
||||
* @apiVersion 4.1.0
|
||||
*
|
||||
* @apiName Get users list
|
||||
*
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ DataValidator::with('CustomValidations', true);
|
|||
|
||||
/**
|
||||
* @api {post} /user/get Get my information
|
||||
* @apiVersion 4.0.0
|
||||
* @apiVersion 4.1.0
|
||||
*
|
||||
* @apiName Get my Information
|
||||
*
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ use Respect\Validation\Validator as DataValidator;
|
|||
|
||||
/**
|
||||
* @api {post} /user/list-ban Get ban list
|
||||
* @apiVersion 4.0.0
|
||||
* @apiVersion 4.1.0
|
||||
*
|
||||
* @apiName Get ban list
|
||||
*
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
|
||||
/**
|
||||
* @api {post} /user/login Login
|
||||
* @apiVersion 4.0.0
|
||||
* @apiVersion 4.1.0
|
||||
*
|
||||
* @apiName Login
|
||||
*
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
<?php
|
||||
/**
|
||||
* @api {post} /user/logout Log out
|
||||
* @apiVersion 4.0.0
|
||||
* @apiVersion 4.1.0
|
||||
*
|
||||
* @apiName Log out
|
||||
*
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ DataValidator::with('CustomValidations', true);
|
|||
|
||||
/**
|
||||
* @api {post} /user/recover-password Recover password
|
||||
* @apiVersion 4.0.0
|
||||
* @apiVersion 4.1.0
|
||||
*
|
||||
* @apiName Recover password
|
||||
*
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@ DataValidator::with('CustomValidations', true);
|
|||
|
||||
/**
|
||||
* @api {post} /user/send-recover-password Send password recovery
|
||||
* @apiVersion 4.0.0
|
||||
* @apiVersion 4.1.0
|
||||
*
|
||||
* @apiName Send password recovery
|
||||
*
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ DataValidator::with('CustomValidations', true);
|
|||
|
||||
/**
|
||||
* @api {post} /user/signup Sign up
|
||||
* @apiVersion 4.0.0
|
||||
* @apiVersion 4.1.0
|
||||
*
|
||||
* @apiName Sign up
|
||||
*
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ use Respect\Validation\Validator as DataValidator;
|
|||
|
||||
/**
|
||||
* @api {post} /user/un-ban Un ban
|
||||
* @apiVersion 4.0.0
|
||||
* @apiVersion 4.1.0
|
||||
*
|
||||
* @apiName Un ban
|
||||
*
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ use Respect\Validation\Validator as DataValidator;
|
|||
|
||||
/**
|
||||
* @api {post} /user/verify Verify email
|
||||
* @apiVersion 4.0.0
|
||||
* @apiVersion 4.1.0
|
||||
*
|
||||
* @apiName Verify email
|
||||
*
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
<?php
|
||||
/**
|
||||
* @api {OBJECT} APIKey APIKey
|
||||
* @apiVersion 4.0.0
|
||||
* @apiVersion 4.1.0
|
||||
* @apiGroup Data Structures
|
||||
* @apiParam {String} name Name of the APIKey.
|
||||
* @apiParam {String} token Token of the APIKey.
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
<?php
|
||||
/**
|
||||
* @api {OBJECT} Article Article
|
||||
* @apiVersion 4.0.0
|
||||
* @apiVersion 4.1.0
|
||||
* @apiGroup Data Structures
|
||||
* @apiParam {Number} id Id of the article.
|
||||
* @apiParam {String} title Title of the article.
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
<?php
|
||||
/**
|
||||
* @api {OBJECT} Ban Ban
|
||||
* @apiVersion 4.0.0
|
||||
* @apiVersion 4.1.0
|
||||
* @apiGroup Data Structures
|
||||
* @apiParam {Email} email The email address that is banned.
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
<?php
|
||||
/**
|
||||
* @api {OBJECT} CustomResponse CustomResponse
|
||||
* @apiVersion 4.0.0
|
||||
* @apiVersion 4.1.0
|
||||
* @apiGroup Data Structures
|
||||
* @apiParam {Number} id Id of the custom response.
|
||||
* @apiParam {String} content Content of the custom response.
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ use RedBeanPHP\Facade as RedBean;
|
|||
|
||||
/**
|
||||
* @api {OBJECT} Department Department
|
||||
* @apiVersion 4.0.0
|
||||
* @apiVersion 4.1.0
|
||||
* @apiGroup Data Structures
|
||||
* @apiParam {Number} id Id of the department.
|
||||
* @apiParam {String} name Name of the department.
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@
|
|||
use RedBeanPHP\Facade as RedBean;
|
||||
/**
|
||||
* @api {OBJECT} Log Log
|
||||
* @apiVersion 4.0.0
|
||||
* @apiVersion 4.1.0
|
||||
* @apiGroup Data Structures
|
||||
* @apiParam {String} type The type of the log.
|
||||
* @apiParam {String} to Object where the action was performed.
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ use RedBeanPHP\Facade as RedBean;
|
|||
|
||||
/**
|
||||
* @api {OBJECT} MailTemplate MailTemplate
|
||||
* @apiVersion 4.0.0
|
||||
* @apiVersion 4.1.0
|
||||
* @apiGroup Data Structures
|
||||
* @apiParam {String} type The type of the mail template.
|
||||
* @apiParam {String} subject The subject of the mail template.
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
<?php
|
||||
/**
|
||||
* @api {OBJECT} Staff Staff
|
||||
* @apiVersion 4.0.0
|
||||
* @apiVersion 4.1.0
|
||||
* @apiGroup Data Structures
|
||||
* @apiParam {String} name Name of the staff member.
|
||||
* @apiParam {String} email Email of the staff member.
|
||||
|
|
@ -10,6 +10,7 @@
|
|||
* @apiParam {Object[]} departments The departments the staff member has assigned.
|
||||
* @apiParam {[Ticket](#api-Data_Structures-ObjectTicket)[]} tickets The tickets the staff member has assigned.
|
||||
* @apiParam {Number} lastLogin The last login of the staff member.
|
||||
* @apiParam {Boolean} sendEmailOnNewTicket Indicates the staff member receives a mail when a ticket is created.
|
||||
*/
|
||||
|
||||
class Staff extends DataStore {
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
<?php
|
||||
/**
|
||||
* @api {OBJECT} Stat Stat
|
||||
* @apiVersion 4.0.0
|
||||
* @apiVersion 4.1.0
|
||||
* @apiGroup Data Structures
|
||||
* @apiParam {Number} date The date of the stat as a number in format YYYYMMDD.
|
||||
* @apiParam {String} type The type of the stat. It can be CREATE_TICKET, CLOSE, SIGNUP, COMMENT, ASSIGN or UNASSIGN
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
<?php
|
||||
/**
|
||||
* @api {OBJECT} Ticket Ticket
|
||||
* @apiVersion 4.0.0
|
||||
* @apiVersion 4.1.0
|
||||
* @apiGroup Data Structures
|
||||
* @apiParam {Number} ticketNumber The number of the ticket.
|
||||
* @apiParam {String} title The title of the ticket.
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
<?php
|
||||
/**
|
||||
* @api {OBJECT} TicketEvent TicketEvent
|
||||
* @apiVersion 4.0.0
|
||||
* @apiVersion 4.1.0
|
||||
* @apiGroup Data Structures
|
||||
* @apiParam {String} type The type of the ticket event. It can be COMMENT, ASSIGN, UN_ASSIGN, CLOSE, RE_OPEN, DEPARTMENT_CHANGED or PRIORITY_CHANGED
|
||||
* @apiParam {String} content The content of the ticket event.
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
<?php
|
||||
/**
|
||||
* @api {OBJECT} Topic Topic
|
||||
* @apiVersion 4.0.0
|
||||
* @apiVersion 4.1.0
|
||||
* @apiGroup Data Structures
|
||||
* @apiParam {Number} id Id of the topic.
|
||||
* @apiParam {String} name Name of the topic.
|
||||
|
|
|
|||
|
|
@ -3,7 +3,7 @@ use RedBeanPHP\Facade as RedBean;
|
|||
|
||||
/**
|
||||
* @api {OBJECT} User User
|
||||
* @apiVersion 4.0.0
|
||||
* @apiVersion 4.1.0
|
||||
* @apiGroup Data Structures
|
||||
* @apiParam {String} email The email of the user.
|
||||
* @apiParam {Number} id The id of the user.
|
||||
|
|
|
|||
Loading…
Reference in New Issue