{
"openapi": "3.0.0",
"info": {
"title": "Documentation for API Service of Projects",
"description": "This is list of API endpoints for CRM Project by Kodegiri. If you meet error 419 (CSRF Token Mismatch), please refresh the page.",
"license": {
"name": "Apache 2.0",
"url": "http://www.apache.org/licenses/LICENSE-2.0.html"
},
"version": "1.0.0"
},
"paths": {
"/api/tools/json-language": {
"get": {
"tags": [
"Tools"
],
"summary": "Generate i18n JSON file",
"description": "Generate i18n JSON file for the application",
"operationId": "app-SystemToolsController-i18n",
"responses": {
"200": {
"description": "Success"
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/tools/finalize-update": {
"get": {
"tags": [
"Tools"
],
"summary": "Finalize the recent update.",
"description": "Update the application to the final version.",
"operationId": "app-SystemToolsController-finalizeUpdate",
"responses": {
"200": {
"description": "Success"
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/tools/clear-cache": {
"get": {
"tags": [
"Tools"
],
"summary": "Clear application cache.",
"description": "Clean up the application cache and restart the queue.",
"operationId": "app-SystemToolsController-clearCache",
"responses": {
"200": {
"description": "Success"
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/tools/storage-link": {
"get": {
"tags": [
"Tools"
],
"summary": "Create application storage link.",
"description": "Create a symbolic link from 'public/storage' to 'storage/app/public'.",
"operationId": "app-SystemToolsController-storageLink",
"responses": {
"200": {
"description": "Success"
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/tools/migrate": {
"get": {
"tags": [
"Tools"
],
"summary": "Run the database migrations.",
"description": "Run the database migrations to update the database schema.",
"operationId": "app-SystemToolsController-migrate",
"responses": {
"200": {
"description": "Success"
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/tools/optimize": {
"get": {
"tags": [
"Tools"
],
"summary": "Cache the framework bootstrap files.",
"description": "Cache the framework bootstrap files for faster application loading.",
"operationId": "app-SystemToolsController-optimize",
"responses": {
"200": {
"description": "Success"
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/tools/seed-mailables": {
"get": {
"tags": [
"Tools"
],
"summary": "Seed the mailable templates.",
"description": "Seed the mailable templates for the application.",
"operationId": "app-SystemToolsController-seedMailableTemplates",
"responses": {
"200": {
"description": "Success"
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/twilio/app/{id}": {
"get": {
"tags": [
"Twillio"
],
"summary": "Get TwiML Application",
"description": "Get TwiML Application",
"operationId": "app-Twilio-TwilioAppController-show",
"parameters": [
{
"$ref": "#/components/parameters/TwilioAppId"
}
],
"requestBody": {
"description": "TwiML Application credentials",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwilioFormResource"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"sid": {
"type": "string",
"example": "APxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
}
},
"type": "object"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
},
"put": {
"tags": [
"Twillio"
],
"summary": "Update TwiML Application",
"description": "Update TwiML Application",
"operationId": "app-Twilio-TwilioAppController-update",
"parameters": [
{
"$ref": "#/components/parameters/TwilioAppId"
}
],
"requestBody": {
"description": "TwiML Application credentials",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwilioFormResource"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"sid": {
"type": "string",
"example": "APxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
}
},
"type": "object"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
},
"delete": {
"tags": [
"Twillio"
],
"summary": "Delete TwiML Application",
"description": "Delete TwiML Application",
"operationId": "app-Twilio-TwilioAppController-destroy",
"parameters": [
{
"$ref": "#/components/parameters/TwilioAppId"
}
],
"requestBody": {
"description": "TwiML Application credentials",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwilioFormResource"
}
}
}
},
"responses": {
"204": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "TwiML Application deleted successfully."
}
},
"type": "object"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/twilio/app": {
"post": {
"tags": [
"Twillio"
],
"summary": "Create TwiML Application",
"description": "Create TwiML Application",
"operationId": "app-Twilio-TwilioAppController-create",
"requestBody": {
"description": "TwiML Application credentials",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwilioAppFormResource"
}
}
}
},
"responses": {
"201": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"properties": {
"sid": {
"type": "string",
"example": "APxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
}
},
"type": "object"
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/twilio/numbers": {
"get": {
"tags": [
"Twillio"
],
"summary": "Get Twilio Numbers From Twilio Account",
"description": "Retrieve available incoming phone numbers",
"operationId": "app-Twilio-TwilioController-index",
"requestBody": {
"description": "TwiML Application credentials",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TwilioFormResource"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"properties": {
"incoming+phone_numbers": {
"type": "number",
"example": "25"
}
},
"type": "object"
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/twilio": {
"delete": {
"tags": [
"Twillio"
],
"summary": "Get Twilio Numbers From Twilio Account",
"description": "Retrieve available incoming phone numbers",
"operationId": "app-Twilio-TwilioController-destroy",
"responses": {
"204": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Twilio Integration has been disconnected successfully."
}
},
"type": "object"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/activities/{activity}/ics": {
"get": {
"tags": [
"Activities"
],
"summary": "Download ICS of the given activity",
"description": "Download data in ICS format of the given activity",
"operationId": "modules-Activities-ActivityController-downloadICS",
"parameters": [
{
"$ref": "#/components/parameters/ActivityId"
}
],
"responses": {
"200": {
"description": "Success"
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/activities/{activity}/complete": {
"post": {
"tags": [
"Activities"
],
"summary": "Download ICS of the given activity",
"description": "Download data in ICS format of the given activity",
"operationId": "modules-Activities-ActivityStateController-complete",
"parameters": [
{
"$ref": "#/components/parameters/ActivityId"
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActivityResource"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/activities/{activity}/incomplete": {
"post": {
"tags": [
"Activities"
],
"summary": "Mark activity as incomplete.",
"description": "Mark activity as incomplete.",
"operationId": "modules-Activities-ActivityStateController-incomplete",
"parameters": [
{
"$ref": "#/components/parameters/ActivityId"
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ActivityResource"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/calendar/account": {
"get": {
"tags": [
"Calendar"
],
"summary": "Get the user connected OAuth calendar.",
"description": "Get the user connected OAuth calendar.",
"operationId": "modules-Activities-CalendarOAuthController-index",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CalendarResource"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
},
"post": {
"tags": [
"Calendar"
],
"summary": "Connect the user connected OAuth account.",
"description": "Connect the user connected OAuth account.",
"operationId": "modules-Activities-CalendarOAuthController-save",
"requestBody": {
"description": "TwiML Application credentials",
"required": true,
"content": {
"application/json": {
"schema": {
"required": [
"activity_type_id",
"access_token_id",
"activity_types",
"calendar_id"
],
"properties": {
"activity_type_id": {
"type": "number",
"example": "1"
},
"access_token_id": {
"type": "number",
"example": "1"
},
"activity_types": {
"type": "array",
"items": {
"type": "number",
"example": "1"
}
},
"calendar_id": {
"type": "string",
"example": "1234567890"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CalendarResource"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
},
"delete": {
"tags": [
"Calendar"
],
"summary": "Stop the sync for the connected calendar account.",
"description": "Connect the user connected OAuth account.",
"operationId": "modules-Activities-CalendarOAuthController-destroy",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CalendarResource"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/calendars/{account}": {
"get": {
"tags": [
"Calendar"
],
"summary": "Get the available calendars for the given OAuth Account.",
"description": "Get the available calendars for the given OAuth Account.",
"operationId": "modules-Activities-CalendarOAuthController-calendars",
"parameters": [
{
"name": "account",
"in": "path",
"description": "OAuth Account ID",
"required": true,
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CalendarResource"
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/products/active": {
"get": {
"tags": [
"Billable"
],
"summary": "Search for active products.",
"description": "Returns a list of active products.",
"operationId": "modules-Billable-ActiveProductController-handle",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"properties": {
"id": {
"type": "integer",
"example": 1
},
"name": {
"type": "string",
"example": "Product Name"
},
"description": {
"type": "string",
"example": "Product Description"
},
"price": {
"type": "number",
"example": 10
},
"currency": {
"type": "string",
"example": "USD"
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2021-01-01T00:00:00Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2021-01-01T00:00:00Z"
}
},
"type": "object"
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/{resource}/{resourceId}/billable": {
"post": {
"tags": [
"Billable"
],
"summary": "Handle the resource billable request.",
"description": "Handle the resource billable request.",
"operationId": "modules-Billable-BillableController-handle",
"parameters": [
{
"name": "resource",
"in": "path",
"description": "Resource",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "resourceId",
"in": "path",
"description": "Resource ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Pass resource billable data",
"required": false,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BillableFormResource"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BillableResource"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/brands": {
"get": {
"tags": [
"Brands"
],
"summary": "Display a listing of the company brands.",
"description": "Returns a list of company brands.",
"operationId": "modules-Brands-BrandController-index",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BrandResource"
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
},
"post": {
"tags": [
"Brands"
],
"summary": "Store a newly created company brand in storage.",
"description": "Store a newly created company brand in storage.",
"operationId": "modules-Brands-BrandController-store",
"requestBody": {
"description": "Pass brand details",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BrandFormResource"
}
}
}
},
"responses": {
"201": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BrandResource"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/brands/{brand}": {
"get": {
"tags": [
"Brands"
],
"summary": "Display the specified company brand.",
"description": "Returns the specified company brand.",
"operationId": "modules-Brands-BrandController-show",
"parameters": [
{
"$ref": "#/components/parameters/BrandId"
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BrandResource"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
},
"put": {
"tags": [
"Brands"
],
"summary": "Update the specified company brand in storage.",
"description": "Update the specified company brand in storage.",
"operationId": "modules-Brands-BrandController-update",
"parameters": [
{
"$ref": "#/components/parameters/BrandId"
}
],
"requestBody": {
"description": "Pass brand details",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BrandFormResource"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BrandResource"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
},
"delete": {
"tags": [
"Brands"
],
"summary": "Remove the specified company brand from storage.",
"description": "Remove the specified company brand from storage.",
"operationId": "modules-Brands-BrandController-destroy",
"parameters": [
{
"$ref": "#/components/parameters/BrandId"
}
],
"responses": {
"204": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "The brand has been removed successfully."
}
},
"type": "object"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/brands/{brand}/logo/{type}": {
"post": {
"tags": [
"Brands"
],
"summary": "Upload the given brand logo.",
"description": "Upload the given brand logo.",
"operationId": "modules-Brands-BrandLogoController-store",
"parameters": [
{
"$ref": "#/components/parameters/BrandId"
},
{
"$ref": "#/components/parameters/BrandLogoType"
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"properties": {
"path": {
"type": "string",
"example": "brands/1/logo_mail.jpg"
},
"url": {
"type": "string",
"example": "http://localhost/storage/brands/1/logo_mail.jpg"
}
},
"type": "object"
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
},
"delete": {
"tags": [
"Brands"
],
"summary": "Remove the specified brand logo.",
"description": "Remove the specified brand logo.",
"operationId": "modules-Brands-BrandLogoController-delete",
"parameters": [
{
"$ref": "#/components/parameters/BrandId"
},
{
"$ref": "#/components/parameters/BrandLogoType"
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "The logo has been removed successfully."
}
},
"type": "object"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/{resource}/{resourceId}/comments": {
"get": {
"tags": [
"Comments"
],
"summary": "Display the resource comments.",
"description": "Retrieve the comments for the given resource.",
"operationId": "modules-Comments-CommentController-index",
"parameters": [
{
"$ref": "#/components/parameters/CommentResource"
},
{
"$ref": "#/components/parameters/CommentResourceId"
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CommentResource"
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
},
"post": {
"tags": [
"Comments"
],
"summary": "Add new resource comment.",
"description": "Create a new comment for the given resource.",
"operationId": "modules-Comments-CommentController-store",
"parameters": [
{
"$ref": "#/components/parameters/CommentResource"
},
{
"$ref": "#/components/parameters/CommentResourceId"
}
],
"requestBody": {
"description": "Comment data",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommentFormResource"
}
}
}
},
"responses": {
"201": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommentResource"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/comments/{comment}": {
"get": {
"tags": [
"Comments"
],
"summary": "Display the given comment.",
"description": "Retrieve the given comment.",
"operationId": "modules-Comments-CommentController-show",
"parameters": [
{
"$ref": "#/components/parameters/CommentId"
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommentResource"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
},
"put": {
"tags": [
"Comments"
],
"summary": "Update the given comment.",
"description": "Update the given comment.",
"operationId": "modules-Comments-CommentController-update",
"parameters": [
{
"$ref": "#/components/parameters/CommentId"
}
],
"requestBody": {
"description": "Comment data",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommentFormResource"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CommentResource"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
},
"delete": {
"tags": [
"Comments"
],
"summary": "Remove the given comment from storage.",
"description": "Delete the given comment.",
"operationId": "modules-Comments-CommentController-destroy",
"parameters": [
{
"$ref": "#/components/parameters/CommentId"
}
],
"responses": {
"204": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Comment deleted successfully."
}
},
"type": "object"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/calendar": {
"get": {
"tags": [
"Calendar"
],
"summary": "Display a listing of calendar events",
"description": "Get calendar events",
"operationId": "modules-Core-CalendarController-index",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CalendarEventResource"
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/cards": {
"get": {
"tags": [
"Cards"
],
"summary": "Get cards that are intended to be shown on dashboards.",
"description": "Get cards that are intended to be shown on dashboards.",
"operationId": "modules-Core-CardController-forDashboards",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CardResource"
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/{resource}/cards": {
"get": {
"tags": [
"Cards"
],
"summary": "Get the available cards for a given resource.",
"description": "Get the available cards for a given resource.",
"operationId": "modules-Core-CardController-index",
"parameters": [
{
"name": "resource",
"in": "path",
"description": "The resource name",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CardResource"
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/cards/{card}": {
"get": {
"tags": [
"Cards"
],
"summary": "Get card by given uri key.",
"description": "Get card by given uri key.",
"operationId": "modules-Core-CardController-show",
"parameters": [
{
"name": "card",
"in": "path",
"description": "The uri key of the card",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CardResource"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/countries": {
"get": {
"tags": [
"Core"
],
"summary": "Get a list of all the application countries in storage.",
"description": "Get a list of all the application countries in storage.",
"operationId": "modules-Core-CountryController-handle",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CountryResource"
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/currencies": {
"get": {
"tags": [
"Core"
],
"summary": "Get the application available currencies.",
"description": "Get the application available currencies.",
"operationId": "modules-Core-CurrencyController-invoke",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"AED": {
"properties": {
"name": {
"type": "string",
"example": "UAE Dirham"
},
"code": {
"type": "integer",
"example": "784"
},
"precision": {
"type": "integer",
"example": "2"
},
"subunit": {
"type": "integer",
"example": "100"
},
"symbol": {
"type": "string",
"example": "د.إ"
},
"symbol_first": {
"type": "boolean",
"example": "true"
},
"decimal_mark": {
"type": "string",
"example": "."
},
"thousands_separator": {
"type": "string",
"example": ","
}
},
"type": "object"
},
"AFN": {
"properties": {
"name": {
"type": "string",
"example": "Afghani"
},
"code": {
"type": "integer",
"example": "981"
},
"precision": {
"type": "integer",
"example": "2"
},
"subunit": {
"type": "integer",
"example": "100"
},
"symbol": {
"type": "string",
"example": "Ø‹"
},
"symbol_first": {
"type": "boolean",
"example": "false"
},
"decimal_mark": {
"type": "string",
"example": "."
},
"thousands_separator": {
"type": "string",
"example": ","
}
},
"type": "object"
}
},
"type": "object"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/custom-fields": {
"get": {
"tags": [
"Fields"
],
"summary": "Get the fields types that can be used as custom fields.",
"description": "Get the fields types that can be used as custom fields.",
"operationId": "modules-Core-CustomFieldController-index",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CoreCustomFieldResource"
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
},
"post": {
"tags": [
"Fields"
],
"summary": "Create new custom field.",
"description": "Create new custom field.",
"operationId": "modules-Core-CustomFieldController-store",
"requestBody": {
"description": "Pass the custom field details",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CoreCustomFieldFormResource"
}
}
}
},
"responses": {
"201": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CoreCustomFieldResource"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/custom-fields/{custom_field}": {
"put": {
"tags": [
"Fields"
],
"summary": "Update custom field.",
"description": "Update custom field.",
"operationId": "modules-Core-CustomFieldController-update",
"parameters": [
{
"$ref": "#/components/parameters/CoreCustomFieldId"
}
],
"requestBody": {
"description": "Pass the custom field details",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CoreCustomFieldFormResource"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CoreCustomFieldResource"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
},
"delete": {
"tags": [
"Fields"
],
"summary": "Delete custom field.",
"description": "Delete custom field.",
"operationId": "modules-Core-CustomFieldController-destroy",
"parameters": [
{
"$ref": "#/components/parameters/CoreCustomFieldId"
}
],
"responses": {
"204": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Custom field deleted successfully"
}
},
"type": "object"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/dashboards": {
"get": {
"tags": [
"Dashboards"
],
"summary": "Display a listing of the current user dashboards.",
"description": "Display a listing of the current user dashboards.",
"operationId": "modules-Core-DashboardController-index",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DashboardResource"
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
},
"post": {
"tags": [
"Dashboards"
],
"summary": "Store a newly created dashboard in storage.",
"description": "Store a newly created dashboard in storage.",
"operationId": "modules-Core-DashboardController-store",
"requestBody": {
"description": "Dashboard data to be stored",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DashboardFormResource"
}
}
}
},
"responses": {
"201": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DashboardResource"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/dashboards/{dashboard}": {
"get": {
"tags": [
"Dashboards"
],
"summary": "Display the specified dashboard.",
"description": "Display the specified dashboard.",
"operationId": "modules-Core-DashboardController-show",
"parameters": [
{
"$ref": "#/components/parameters/CoreDashboardId"
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DashboardResource"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
},
"put": {
"tags": [
"Dashboards"
],
"summary": "Update the specified dashboard in storage.",
"description": "Update the specified dashboard in storage.",
"operationId": "modules-Core-DashboardController-update",
"parameters": [
{
"$ref": "#/components/parameters/CoreDashboardId"
}
],
"requestBody": {
"description": "Dashboard data to be stored",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DashboardFormResource"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DashboardResource"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
},
"delete": {
"tags": [
"Dashboards"
],
"summary": "Remove the specified dashboard from storage.",
"description": "Remove the specified dashboard from storage.",
"operationId": "modules-Core-DashboardController-destroy",
"parameters": [
{
"$ref": "#/components/parameters/CoreDashboardId"
}
],
"responses": {
"204": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Dashboard deleted successfully"
}
},
"type": "object"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/fields/{group}/{view}": {
"get": {
"tags": [
"Settings"
],
"summary": "Get fields in a group for specific view for display.",
"description": "Get fields in a group for specific view for display.",
"operationId": "modules-Core-FieldController-index",
"parameters": [
{
"$ref": "#/components/parameters/CoreFieldGroup"
},
{
"$ref": "#/components/parameters/CoreFieldView"
}
],
"responses": {
"200": {
"description": "Success"
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/fields/settings/{group}/{view}": {
"get": {
"tags": [
"Settings"
],
"summary": "Get the fields that are intended for the settings.",
"description": "Get the fields that are intended for the settings.",
"operationId": "modules-Core-FieldController-settings",
"parameters": [
{
"$ref": "#/components/parameters/CoreFieldGroup"
},
{
"$ref": "#/components/parameters/CoreFieldView"
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
},
"post": {
"tags": [
"Settings"
],
"summary": "Save the customized fields from settings.",
"description": "Save the customized fields from settings.",
"operationId": "modules-Core-FieldController-update",
"parameters": [
{
"$ref": "#/components/parameters/CoreFieldGroup"
},
{
"$ref": "#/components/parameters/CoreFieldView"
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/fields/settings/bulk/{view}": {
"get": {
"tags": [
"Settings"
],
"summary": "Get fields for settings in bulk in given groups.",
"description": "Get fields for settings in bulk in given groups.",
"operationId": "modules-Core-FieldController-bulkSettings",
"parameters": [
{
"$ref": "#/components/parameters/CoreFieldView"
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"type": "object"
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/fields/settings/{group}/{view}/reset": {
"delete": {
"tags": [
"Settings"
],
"summary": "Reset the customized fields for a view.",
"description": "Reset the customized fields for a view.",
"operationId": "modules-Core-FieldController-destroy",
"parameters": [
{
"$ref": "#/components/parameters/CoreFieldGroup"
},
{
"$ref": "#/components/parameters/CoreFieldView"
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"settings": {
"type": "array",
"items": {
"type": "object"
}
},
"fields": {
"type": "array",
"items": {
"type": "object"
}
}
},
"type": "object"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/filters/{identifier}": {
"get": {
"tags": [
"Filters"
],
"summary": "Get filters from storage by identifier for logged in user.",
"description": "Get filters from storage by identifier for logged in user.",
"operationId": "modules-Core-FilterController-index",
"parameters": [
{
"name": "identifier",
"in": "path",
"description": "The identifier of the filter",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FilterResource"
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/filters": {
"post": {
"tags": [
"Filters"
],
"summary": "Create new table filter.",
"description": "Create new table filter.",
"operationId": "modules-Core-FilterController-store",
"requestBody": {
"description": "Filter data",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FilterFormResource"
}
}
}
},
"responses": {
"201": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FilterResource"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/filters/{filter}": {
"put": {
"tags": [
"Filters"
],
"summary": "Update table filter.",
"description": "Update table filter.",
"operationId": "modules-Core-FilterController-update",
"parameters": [
{
"$ref": "#/components/parameters/CoreFilterId"
}
],
"requestBody": {
"description": "Filter data",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FilterFormResource"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FilterResource"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
},
"delete": {
"tags": [
"Filters"
],
"summary": "Delete table filter.",
"description": "Delete table filter.",
"operationId": "modules-Core-FilterController-destroy",
"parameters": [
{
"$ref": "#/components/parameters/CoreFilterId"
}
],
"responses": {
"204": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Filter deleted successfully"
}
},
"type": "object"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/filters/{filter}/{view}/default": {
"put": {
"tags": [
"Filters"
],
"summary": "Mark the given filter as default for the given view.",
"description": "Mark the given filter as default for the given view.",
"operationId": "modules-Core-FilterController-markAsDefault",
"parameters": [
{
"$ref": "#/components/parameters/CoreFilterId"
},
{
"$ref": "#/components/parameters/CoreFilterView"
}
],
"responses": {
"204": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FilterResource"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
},
"delete": {
"tags": [
"Filters"
],
"summary": "Unmark the given filter as default from the given view.",
"description": "Unmark the given filter as default from the given view.",
"operationId": "modules-Core-FilterController-unMarkAsDefault",
"parameters": [
{
"$ref": "#/components/parameters/CoreFilterId"
},
{
"$ref": "#/components/parameters/CoreFilterView"
}
],
"responses": {
"204": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/FilterResource"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/highlights": {
"get": {
"tags": [
"Core"
],
"summary": "Display a listing of highlights",
"description": "Get the application highlights.",
"operationId": "modules-Core-HighlightController-invoke",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Highlights retrieved successfully."
},
"data": {
"type": "array",
"items": {
"properties": {
"count": {
"type": "integer",
"example": "0"
},
"name": {
"type": "string",
"example": "Today's Activities"
},
"route": {
"properties": {
"query": {
"properties": {
"filter_id": {
"type": "integer",
"example": "2"
}
},
"type": "object"
}
},
"type": "object"
},
"bgColorClass": {
"type": "string",
"example": "bg-warning-500"
}
},
"type": "object"
}
}
},
"type": "object"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/logo/{type}": {
"post": {
"tags": [
"Core"
],
"summary": "Save company logo.",
"description": "Save company logo.",
"operationId": "modules-Core-LogoController-store",
"parameters": [
{
"$ref": "#/components/parameters/CoreLogoType"
}
],
"requestBody": {
"description": "Logo file to be uploaded",
"required": true,
"content": {
"multipart/form-data": {
"schema": {
"properties": {
"logo_light": {
"type": "string",
"format": "binary"
},
"logo_dark": {
"type": "string",
"format": "binary"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Logo saved successfully"
},
"logo": {
"type": "string",
"example": "/storage/logo.png"
}
},
"type": "object"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
},
"delete": {
"tags": [
"Core"
],
"summary": "Remove company logo.",
"description": "Remove company logo.",
"operationId": "modules-Core-LogoController-destroy",
"parameters": [
{
"$ref": "#/components/parameters/CoreLogoType"
}
],
"responses": {
"204": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Logo deleted successfully"
}
},
"type": "object"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/mailables": {
"get": {
"tags": [
"Mailables"
],
"summary": "Retrieve all mail templates.",
"description": "Retrieve all mail templates.",
"operationId": "modules-Core-MailableController-index",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MailableResource"
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/mailables/{locale}/locale": {
"get": {
"tags": [
"Mailables"
],
"summary": "Retrieve mail templates in specific locale.",
"description": "Retrieve mail templates in specific locale.",
"operationId": "modules-Core-MailableController-forLocale",
"parameters": [
{
"name": "locale",
"in": "path",
"description": "The locale of the mail templates",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MailableResource"
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/mailables/{template}": {
"get": {
"tags": [
"Mailables"
],
"summary": "Display the specified resource.",
"description": "Display the specified resource.",
"operationId": "modules-Core-MailableController-show",
"parameters": [
{
"$ref": "#/components/parameters/CoreMailableTemplateId"
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MailableResource"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
},
"put": {
"tags": [
"Mailables"
],
"summary": "Update the specified mail template in storage.",
"description": "Update the specified mail template in storage.",
"operationId": "modules-Core-MailableController-update",
"parameters": [
{
"$ref": "#/components/parameters/CoreMailableTemplateId"
}
],
"requestBody": {
"description": "Data for updating mail template",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MailableFormResource"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MailableResource"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/media/pending/{draftId}": {
"post": {
"tags": [
"Core"
],
"summary": "Upload pending media.",
"description": "Upload pending media.",
"operationId": "modules-Core-PendingMediaController-store",
"parameters": [
{
"name": "draftId",
"in": "path",
"description": "The ID of the draft",
"required": true,
"schema": {
"type": "number"
}
}
],
"requestBody": {
"description": "Media file to be uploaded",
"required": true,
"content": {
"multipart/form-data": {
"schema": {
"properties": {
"file": {
"type": "string",
"format": "binary"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MediaResource"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/media/pending/{pendingMediaId}": {
"delete": {
"tags": [
"Core"
],
"summary": "Destroy pending media.",
"description": "Destroy pending media.",
"operationId": "modules-Core-PendingMediaController-destroy",
"parameters": [
{
"name": "pendingMediaId",
"in": "path",
"description": "The ID of the draft",
"required": true,
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Pending media deleted successfully"
}
},
"type": "object"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/permissions": {
"get": {
"tags": [
"Roles"
],
"summary": "Get all registered application permissions.",
"description": "Get all registered application permissions.",
"operationId": "modules-Core-PermissionController-index",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"grouped": {
"properties": {
"inbox": {
"properties": {
"views": {
"type": "array",
"items": {
"properties": {
"revokeable": {
"type": "boolean",
"example": "false"
},
"keys": {
"type": "array",
"items": {
"type": "string",
"example": "access shared inbox"
}
},
"single": {
"type": "boolean",
"example": "true"
},
"permissions": {
"properties": {
"access shared inbox": {
"type": "string",
"example": "Access"
}
},
"type": "object"
},
"as": {
"type": "string",
"example": "Access"
},
"view": {
"type": "string",
"example": "access-inbox"
}
},
"type": "object"
}
},
"as": {
"type": "string",
"example": "Shared Inbox"
}
},
"type": "object"
}
},
"type": "object"
},
"all": {
"type": "array",
"items": {
"type": "string",
"example": "view all companies"
}
}
},
"type": "object"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/{resource}/actions/{action}/run": {
"post": {
"tags": [
"Core"
],
"summary": "Run resource action.",
"description": "Run resource action.",
"operationId": "modules-Core-Resource-ActionController-handle",
"parameters": [
{
"name": "resource",
"in": "path",
"description": "Resource Name",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "action",
"in": "path",
"description": "Action Name",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success"
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/{resource}/{resourceId}/{associated}": {
"get": {
"tags": [
"Associations"
],
"summary": "Get the resource associations.",
"description": "Get the resource associations.",
"operationId": "modules-Core-Resource-AssociationsController-invoke",
"parameters": [
{
"$ref": "#/components/parameters/CoreAssociationResourceName"
},
{
"$ref": "#/components/parameters/CoreAssociationResourceId"
},
{
"name": "associated",
"in": "path",
"description": "Associated Resource Name",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/associations/{resource}/{resourceId}": {
"put": {
"tags": [
"Associations"
],
"summary": "Associate records to resource.",
"description": "Associate records to resource.",
"operationId": "modules-Core-Resource-AssociationsSyncController-attach",
"parameters": [
{
"$ref": "#/components/parameters/CoreAssociationResourceName"
},
{
"$ref": "#/components/parameters/CoreAssociationResourceId"
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
},
"post": {
"tags": [
"Associations"
],
"summary": "Sync records for resource.",
"description": "Sync records for resource.",
"operationId": "modules-Core-Resource-AssociationsSyncController-sync",
"parameters": [
{
"$ref": "#/components/parameters/CoreAssociationResourceName"
},
{
"$ref": "#/components/parameters/CoreAssociationResourceId"
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
},
"delete": {
"tags": [
"Associations"
],
"summary": "Dissociate records from resource.",
"description": "Dissociate records from resource.",
"operationId": "modules-Core-Resource-AssociationsSyncController-detach",
"parameters": [
{
"$ref": "#/components/parameters/CoreAssociationResourceName"
},
{
"$ref": "#/components/parameters/CoreAssociationResourceId"
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Records dissociated successfully"
}
},
"type": "object"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/{resource}/{resourceId}/clone": {
"get": {
"tags": [
"Core"
],
"summary": "Clone a resource record.",
"description": "Clone a resource record.",
"operationId": "modules-Core-Resource-CloneController-handle",
"parameters": [
{
"name": "resource",
"in": "path",
"description": "Resource Name",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "resourceId",
"in": "path",
"description": "Resource ID",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/search/email-address": {
"get": {
"tags": [
"Search"
],
"summary": "Perform email search.",
"description": "Perform email search.",
"operationId": "modules-Core-Resource-EmailSearchController-handle",
"parameters": [
{
"$ref": "#/components/parameters/CoreSearchQuery"
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"properties": {
"id": {
"type": "string",
"example": "1"
},
"address": {
"type": "string",
"example": "sleman, jogja"
},
"name": {
"type": "string",
"example": "John Doe"
},
"path": {
"type": "string",
"example": "/api/users/1"
},
"resourceName": {
"type": "string",
"example": "users"
}
},
"type": "object"
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/{resource}/export": {
"post": {
"tags": [
"Core"
],
"summary": "Export resource data.",
"description": "Export resource data.",
"operationId": "modules-Core-Resource-ExportController-handle",
"parameters": [
{
"name": "resource",
"in": "path",
"description": "The resource name",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"headers": {
"Content-Disposition": {
"description": "The filename of the downloaded file",
"schema": {
"type": "string"
}
}
},
"content": {
"text/csv": {}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/{resource}/create-fields": {
"get": {
"tags": [
"Fields"
],
"summary": "Get the resource create fields.",
"description": "Get the resource create fields.",
"operationId": "modules-Core-Resource-FieldController-create",
"parameters": [
{
"$ref": "#/components/parameters/CoreFieldResourceName"
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/{resource}/{resourceId}/update-fields": {
"get": {
"tags": [
"Fields"
],
"summary": "Get the resource update fields.",
"description": "Get the resource update fields.",
"operationId": "modules-Core-Resource-FieldController-update",
"parameters": [
{
"$ref": "#/components/parameters/CoreFieldResourceName"
},
{
"$ref": "#/components/parameters/CoreFieldResourceId"
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/{resource}/{resourceId}/detail-fields": {
"get": {
"tags": [
"Fields"
],
"summary": "Get the resource detail fields.",
"description": "Get the resource detail fields.",
"operationId": "modules-Core-Resource-FieldController-detail",
"parameters": [
{
"$ref": "#/components/parameters/CoreFieldResourceName"
},
{
"$ref": "#/components/parameters/CoreFieldResourceId"
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/{resource}/rules": {
"get": {
"tags": [
"Core"
],
"summary": "Get the resource available filters rules.",
"description": "Get the resource available filters rules.",
"operationId": "modules-Core-Resource-FilterRulesController-index",
"parameters": [
{
"name": "resource",
"in": "path",
"description": "The resource name",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CoreFilterRulesResource"
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/search": {
"get": {
"tags": [
"Search"
],
"summary": "Perform global search.",
"description": "Perform global search.",
"operationId": "modules-Core-Resource-GlobalSearchController-handle",
"parameters": [
{
"$ref": "#/components/parameters/CoreSearchQuery"
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"properties": {
"path": {
"type": "string",
"example": "/api/users"
},
"display_name": {
"type": "string",
"example": "Users"
},
"created_at": {
"type": "string",
"example": "2021-08-10T14:00:00.000000Z"
},
"users": {
"type": "string",
"example": "1"
},
"resourceName": {
"type": "string",
"example": "users"
}
},
"type": "object"
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/{resource}/import": {
"get": {
"tags": [
"Import"
],
"summary": "Get the import files in storage for the resource.",
"description": "Get the import files in storage for the resource.",
"operationId": "modules-Core-Resource-ImportController-index",
"parameters": [
{
"$ref": "#/components/parameters/CoreImportResource"
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ImportResource"
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/{resource}/import/{id}": {
"post": {
"tags": [
"Import"
],
"summary": "Perform import for the current resource.",
"description": "Perform import for the current resource.",
"operationId": "modules-Core-Resource-ImportController-handle",
"parameters": [
{
"$ref": "#/components/parameters/CoreImportResource"
},
{
"$ref": "#/components/parameters/CoreImportId"
}
],
"requestBody": {
"description": "Pass data to perform the import.",
"required": true,
"content": {
"application/json": {
"schema": {
"required": [
"mappings"
],
"properties": {
"mappings": {
"type": "array",
"items": {
"properties": {
"attribute": {
"type": "string",
"example": "name"
},
"auto_detected": {
"type": "boolean",
"example": true
},
"original": {
"type": "string",
"example": "Name"
},
"skip": {
"type": "boolean",
"example": false
},
"detected_attribute": {
"type": "string",
"example": "name"
}
},
"type": "object"
}
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImportResource"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
},
"delete": {
"tags": [
"Import"
],
"summary": "Delete the given import.",
"description": "Delete the given import.",
"operationId": "modules-Core-Resource-ImportController-destroy",
"parameters": [
{
"$ref": "#/components/parameters/CoreImportResource"
},
{
"$ref": "#/components/parameters/CoreImportId"
}
],
"responses": {
"204": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Import has been deleted successfully."
}
},
"type": "object"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/{resource}/import/upload": {
"post": {
"tags": [
"Import"
],
"summary": "Initiate new import and start mapping.",
"description": "Initiate new import and start mapping.",
"operationId": "modules-Core-Resource-ImportController-upload",
"parameters": [
{
"$ref": "#/components/parameters/CoreImportResource"
}
],
"requestBody": {
"description": "Pass data to perform the import.",
"required": true,
"content": {
"multipart/form-data": {
"schema": {
"required": [
"file"
],
"properties": {
"file": {
"type": "string",
"format": "binary"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImportResource"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/{resource}/import/sample": {
"get": {
"tags": [
"Import"
],
"summary": "Download sample import file.",
"description": "Download sample import file.",
"operationId": "modules-Core-Resource-ImportController-sample",
"parameters": [
{
"$ref": "#/components/parameters/CoreImportResource"
}
],
"responses": {
"200": {
"description": "Success",
"headers": {
"Content-Disposition": {
"description": "The filename of the downloaded file",
"schema": {
"type": "string"
}
}
},
"content": {
"text/csv": {}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/{resource}/import/{id}/skip-file": {
"get": {
"tags": [
"Import"
],
"summary": "Download the skip file for the import.",
"description": "Download the skip file for the import.",
"operationId": "modules-Core-Resource-ImportSkipFileController-download",
"parameters": [
{
"$ref": "#/components/parameters/CoreImportResource"
},
{
"$ref": "#/components/parameters/CoreImportId"
}
],
"responses": {
"200": {
"description": "Success",
"headers": {
"Content-Disposition": {
"description": "The filename of the downloaded file",
"schema": {
"type": "string"
}
}
},
"content": {
"text/csv": {}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
},
"post": {
"tags": [
"Import"
],
"summary": "Upload the fixed skip file and start mapping.",
"description": "Upload the fixed skip file and start mapping.",
"operationId": "modules-Core-Resource-ImportSkipFileController-upload",
"parameters": [
{
"$ref": "#/components/parameters/CoreImportResource"
},
{
"$ref": "#/components/parameters/CoreImportId"
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ImportResource"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/{resource}/{resourceId}/media": {
"put": {
"tags": [
"Media"
],
"summary": "Upload media to resource.",
"description": "Upload media to resource.",
"operationId": "modules-Core-Resource-MediaController-store",
"parameters": [
{
"$ref": "#/components/parameters/CoreMediaResourceName"
},
{
"$ref": "#/components/parameters/CoreMediaResourceId"
}
],
"responses": {
"201": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/MediaResource"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/{resource}/{resourceId}/media/{media}": {
"delete": {
"tags": [
"Media"
],
"summary": "Delete media from resource.",
"description": "Delete media from resource.",
"operationId": "modules-Core-Resource-MediaController-destroy",
"parameters": [
{
"$ref": "#/components/parameters/CoreMediaResourceName"
},
{
"$ref": "#/components/parameters/CoreMediaResourceId"
},
{
"name": "media",
"in": "path",
"description": "Media ID",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"204": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Media deleted successfully"
}
},
"type": "object"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/placeholders": {
"get": {
"tags": [
"Placeholders"
],
"summary": "Retrieve placeholders via fields.",
"description": "Retrieve placeholders via fields.",
"operationId": "modules-Core-Resource-PlaceholdersController-index",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/placeholders/input-fields": {
"post": {
"tags": [
"Placeholders"
],
"summary": "Parse placeholders via input fields.",
"description": "Parse placeholders via input fields.",
"operationId": "modules-Core-Resource-PlaceholdersController-parseViaInputFields",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/placeholders/interpolation": {
"post": {
"tags": [
"Placeholders"
],
"summary": "Parse placeholders via interpolation.",
"description": "Parse placeholders via interpolation.",
"operationId": "modules-Core-Resource-PlaceholdersController-parseViaInterpolation",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/{resource}": {
"get": {
"tags": [
"Resourceful"
],
"summary": "Display a listing of the resource.",
"description": "Display a listing of the resource.",
"operationId": "modules-Core-Resource-ResourcefulController-index",
"parameters": [
{
"$ref": "#/components/parameters/CoreResourcefulResourceName"
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
},
"post": {
"tags": [
"Resourceful"
],
"summary": "Store a newly created resource in storage.",
"description": "Store a newly created resource in storage.",
"operationId": "modules-Core-Resource-ResourcefulController-store",
"parameters": [
{
"$ref": "#/components/parameters/CoreResourcefulResourceName"
}
],
"requestBody": {
"description": "Pass resource data",
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"responses": {
"201": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/{resource}/{resourceId}": {
"get": {
"tags": [
"Resourceful"
],
"summary": "Display resource record.",
"description": "Display resource record.",
"operationId": "modules-Core-Resource-ResourcefulController-show",
"parameters": [
{
"$ref": "#/components/parameters/CoreResourcefulResourceName"
},
{
"$ref": "#/components/parameters/CoreResourcefulResourceId"
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
},
"put": {
"tags": [
"Resourceful"
],
"summary": "Update resource record in storage.",
"description": "Update resource record in storage.",
"operationId": "modules-Core-Resource-ResourcefulController-update",
"parameters": [
{
"$ref": "#/components/parameters/CoreResourcefulResourceName"
},
{
"$ref": "#/components/parameters/CoreResourcefulResourceId"
}
],
"requestBody": {
"description": "Pass resource data",
"required": false,
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
},
"delete": {
"tags": [
"Resourceful"
],
"summary": "Remove resource record from storage.",
"description": "Remove resource record from storage.",
"operationId": "modules-Core-Resource-ResourcefulController-destroy",
"parameters": [
{
"$ref": "#/components/parameters/CoreResourcefulResourceName"
},
{
"$ref": "#/components/parameters/CoreResourcefulResourceId"
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/{resource}/search": {
"get": {
"tags": [
"Search"
],
"summary": "Perform search for a resource.",
"description": "Perform search for a resource.",
"operationId": "modules-Core-Resource-SearchController-handle",
"parameters": [
{
"name": "resource",
"in": "path",
"description": "Resource name",
"required": true,
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/CoreSearchQuery"
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"properties": {
"id": {
"type": "string",
"example": "1"
},
"address": {
"type": "string",
"example": "sleman, jogja"
},
"name": {
"type": "string",
"example": "John Doe"
},
"path": {
"type": "string",
"example": "/api/users/1"
},
"resourceName": {
"type": "string",
"example": "users"
}
},
"type": "object"
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/{resource}/table": {
"get": {
"tags": [
"Table"
],
"summary": "Display a table listing of the resource.",
"description": "Display a table listing of the resource.",
"operationId": "modules-Core-Resource-TableController-index",
"parameters": [
{
"$ref": "#/components/parameters/CoreTableResourceName"
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/{resource}/table/settings": {
"get": {
"tags": [
"Table"
],
"summary": "Get the resource table settings.",
"description": "Get the resource table settings.",
"operationId": "modules-Core-Resource-TableController-settings",
"parameters": [
{
"$ref": "#/components/parameters/CoreTableResourceName"
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
},
"post": {
"tags": [
"Table"
],
"summary": "Get the resource table settings.",
"description": "Get the resource table settings.",
"operationId": "modules-Core-Resource-TableController-customize",
"parameters": [
{
"$ref": "#/components/parameters/CoreTableResourceName"
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/{resource}/{resourceId}/timeline": {
"get": {
"tags": [
"Core"
],
"summary": "Get the resource changelog.",
"description": "Get the resource changelog.",
"operationId": "modules-Core-Resource-TimelineController-index",
"parameters": [
{
"name": "resource",
"in": "path",
"description": "Resource Name",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "resourceId",
"in": "path",
"description": "Resource ID",
"required": true,
"schema": {
"type": "integer"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Resource changelog."
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ChangelogResource"
}
}
},
"type": "object"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/trashed/{resource}": {
"get": {
"tags": [
"Trashed"
],
"summary": "Display a listing of the resource.",
"description": "Display a listing of the resource.",
"operationId": "modules-Core-Resource-TrashedController-index",
"parameters": [
{
"$ref": "#/components/parameters/CoreTrashResourceName"
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/trashed/{resource}/search": {
"get": {
"tags": [
"Trashed"
],
"summary": "Perform search on the trashed resource.",
"description": "Perform search on the trashed resource.",
"operationId": "modules-Core-Resource-TrashedController-search",
"parameters": [
{
"$ref": "#/components/parameters/CoreTrashResourceName"
},
{
"name": "q",
"in": "query",
"description": "Search query",
"required": true,
"schema": {
"type": "string"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/trashed/{resource}/{resourceId}": {
"get": {
"tags": [
"Trashed"
],
"summary": "Display resource record.",
"description": "Display resource record.",
"operationId": "modules-Core-Resource-TrashedController-show",
"parameters": [
{
"$ref": "#/components/parameters/CoreTrashResourceName"
},
{
"$ref": "#/components/parameters/CoreTrashResourceId"
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
},
"post": {
"tags": [
"Trashed"
],
"summary": "Restore the soft deleted record.",
"description": "Restore the soft deleted record.",
"operationId": "modules-Core-Resource-TrashedController-restore",
"parameters": [
{
"$ref": "#/components/parameters/CoreTrashResourceName"
},
{
"$ref": "#/components/parameters/CoreTrashResourceId"
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "object"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
},
"delete": {
"tags": [
"Trashed"
],
"summary": "Remove resource record from storage.",
"description": "Remove resource record from storage.",
"operationId": "modules-Core-Resource-TrashedController-destroy",
"parameters": [
{
"$ref": "#/components/parameters/CoreTrashResourceName"
},
{
"$ref": "#/components/parameters/CoreTrashResourceId"
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Resource deleted successfully"
},
"content": {
"type": "object"
}
},
"type": "object"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/roles": {
"get": {
"tags": [
"Roles"
],
"summary": "Display a listing of the roles.",
"description": "Display a listing of the roles.",
"operationId": "modules-Core-RoleController-index",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RoleResource"
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
},
"post": {
"tags": [
"Roles"
],
"summary": "Store a newly created role in storage.",
"description": "Store a newly created role in storage.",
"operationId": "modules-Core-RoleController-store",
"requestBody": {
"description": "Role data",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RoleFormResource"
}
}
}
},
"responses": {
"201": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RoleResource"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/roles/{role}": {
"get": {
"tags": [
"Roles"
],
"summary": "Display the specified role.",
"description": "Display the specified role.",
"operationId": "modules-Core-RoleController-show",
"parameters": [
{
"$ref": "#/components/parameters/CoreRoleId"
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RoleResource"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
},
"put": {
"tags": [
"Roles"
],
"summary": "Update the specified role in storage.",
"description": "Update the specified role in storage.",
"operationId": "modules-Core-RoleController-update",
"parameters": [
{
"$ref": "#/components/parameters/CoreRoleId"
}
],
"requestBody": {
"description": "Role data",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RoleFormResource"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RoleResource"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
},
"delete": {
"tags": [
"Roles"
],
"summary": "Remove the specified role from storage.",
"description": "Remove the specified role from storage.",
"operationId": "modules-Core-RoleController-destroy",
"parameters": [
{
"$ref": "#/components/parameters/CoreRoleId"
}
],
"responses": {
"204": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Role deleted successfully"
}
},
"type": "object"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/settings": {
"get": {
"tags": [
"Settings"
],
"summary": "Get the application settings.",
"description": "Get the application settings.",
"operationId": "modules-Core-SettingsController-index",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"app_name": {
"type": "string",
"example": "Laravel"
},
"app_url": {
"type": "string",
"example": "http://localhost"
},
"app_logo": {
"type": "string",
"example": "http://localhost/logo.png"
}
},
"type": "object"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
},
"post": {
"tags": [
"Settings"
],
"summary": "Persist the settings in storage.",
"description": "Persist the settings in storage.",
"operationId": "modules-Core-SettingsController-save",
"requestBody": {
"description": "Pass the settings",
"required": true,
"content": {
"application/json": {
"schema": {
"required": [
"app_name"
],
"properties": {
"app_name": {
"type": "string",
"example": "Laravel"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"app_name": {
"type": "string",
"example": "Laravel"
},
"app_url": {
"type": "string",
"example": "http://localhost"
},
"app_logo": {
"type": "string",
"example": "http://localhost/logo.png"
}
},
"type": "object"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/system/info": {
"get": {
"tags": [
"System"
],
"summary": "Download the system info.",
"description": "Download the system info.",
"operationId": "modules-Core-SystemController-info",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"OS": {
"type": "string",
"example": "Linux"
},
"Webserver": {
"type": "string",
"example": "N/A"
},
"Server Protocol": {
"type": "string",
"example": "N/A"
},
"PHP Version": {
"type": "string",
"example": "7.4.3"
},
"Laravel Cron Run": {
"type": "string",
"example": "N/A"
},
"Cron Job User": {
"type": "string",
"example": "N/A"
},
"PHP IMAP Extension": {
"type": "string",
"example": "N/A"
},
"PHP ZIP Extension": {
"type": "string",
"example": "N/A"
},
"PHP proc_open function": {
"type": "string",
"example": "N/A"
},
"PHP proc_close function": {
"type": "string",
"example": "N/A"
},
"register_argc_argv": {
"type": "string",
"example": "N/A"
},
"max_input_vars": {
"type": "string",
"example": "N/A"
},
"upload_max_filesize": {
"type": "string",
"example": "N/A"
},
"post_max_size": {
"type": "string",
"example": "N/A"
},
"max_execution_time": {
"type": "string",
"example": "N/A"
},
"memory_limit": {
"type": "string",
"example": "N/A"
},
"allow_url_fopen": {
"type": "string",
"example": "Disabled"
},
"PHP Executable": {
"type": "string",
"example": "/usr/bin/php"
},
"Installed Version": {
"type": "string",
"example": "v1.0.0"
},
"CloudFlare": {
"type": "string",
"example": "No"
},
"Installation Path": {
"type": "string",
"example": "/var/www/html"
},
"Installation Date": {
"type": "string",
"example": "2021-01-01 00:00:00"
},
"Last Updated Date": {
"type": "string",
"example": "2021-01-01 00:00:00"
},
"Current Process User": {
"type": "string",
"example": "www-data"
},
"Import Status": {
"type": "string",
"example": "N/A"
},
"DB Driver Version": {
"type": "string",
"example": "N/A"
},
"DB Driver": {
"type": "string",
"example": "N/A"
},
"SQL Mode": {
"type": "string",
"example": "N/A"
},
"DB_CONNECTION": {
"type": "string",
"example": "mysql"
},
"APP_ENV": {
"type": "string",
"example": "production"
},
"APP_URL": {
"type": "string",
"example": "http://localhost"
},
"APP_DEBUG": {
"type": "string",
"example": "false"
},
"SANCTUM_STATEFUL_DOMAINS": {
"type": "string",
"example": "localhost"
},
"MAIL_MAILER": {
"type": "string",
"example": "smtp"
},
"CACHE_DRIVER": {
"type": "string",
"example": "file"
},
"SESSION_DRIVER": {
"type": "string",
"example": "file"
},
"SESSION_LIFETIME": {
"type": "string",
"example": "120"
},
"QUEUE_CONNECTION": {
"type": "string",
"example": "sync"
},
"LOG_CHANNEL": {
"type": "string",
"example": "stack"
},
"SETTINGS_DRIVER": {
"type": "string",
"example": "database"
},
"MEDIA_DISK": {
"type": "string",
"example": "public"
},
"FILESYSTEM_DISK": {
"type": "string",
"example": "public"
},
"FILESYSTEM_CLOUD": {
"type": "string",
"example": "s3"
},
"BROADCAST_DRIVER": {
"type": "string",
"example": "log"
},
"ENABLE_FAVICON": {
"type": "string",
"example": "true"
},
"HTML_PURIFY": {
"type": "string",
"example": "true"
},
"SYNC_INTERVAL": {
"type": "string",
"example": "5"
},
"USER_INVITATION_EXPIRES_AFTER": {
"type": "string",
"example": "24"
},
"PRUNE_TRASHED_RECORDS_AFTER": {
"type": "string",
"example": "30"
},
"MAX_IMPORT_ROWS": {
"type": "string",
"example": "1000"
}
},
"type": "object"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
},
"post": {
"tags": [
"System"
],
"summary": "Download the system info.",
"description": "Download the system info.",
"operationId": "modules-Core-SystemController-downloadInfo",
"responses": {
"200": {
"description": "Success",
"headers": {
"Content-Disposition": {
"description": "Content-Disposition",
"schema": {
"type": "string",
"example": "attachment; filename=system-info.xlsx"
}
}
},
"content": {
"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet": {}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/system/logs": {
"get": {
"tags": [
"System"
],
"summary": "Get the application/Laravel logs.",
"description": "Get the application/Laravel logs.",
"operationId": "modules-Core-SystemController-logs",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"success": {
"type": "boolean",
"example": "true"
},
"message": {
"type": "string",
"example": "Logs fetched successfully"
},
"log_dates": {
"type": "array",
"items": {
"type": "string",
"example": "2021-01-01"
}
},
"date": {
"type": "string",
"example": "2021-01-01"
},
"logs": {
"type": "array",
"items": {
"type": "object"
}
}
},
"type": "object"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/tags/{type?}": {
"post": {
"tags": [
"Tags"
],
"summary": "Store new tag in storage.",
"description": "Store new tag in storage.",
"operationId": "modules-Core-TagController-store",
"parameters": [
{
"$ref": "#/components/parameters/CoreTagType"
}
],
"requestBody": {
"description": "Pass the tag details",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CoreTagFormResource"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CoreTagResource"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/tags/{tag}": {
"put": {
"tags": [
"Tags"
],
"summary": "Update tag in storage.",
"description": "Update tag in storage.",
"operationId": "modules-Core-TagController-update",
"parameters": [
{
"$ref": "#/components/parameters/CoreTagId"
}
],
"requestBody": {
"description": "Pass the tag details",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CoreTagFormResource"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CoreTagResource"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
},
"delete": {
"tags": [
"Tags"
],
"summary": "Delete the tag from storage.",
"description": "Delete the tag from storage.",
"operationId": "modules-Core-TagController-destroy",
"parameters": [
{
"$ref": "#/components/parameters/CoreTagId"
}
],
"responses": {
"204": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Tag deleted successfully"
}
},
"type": "object"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/timeline/pin": {
"post": {
"tags": [
"Core"
],
"summary": "Pin the given timelineable to the given resource.",
"description": "Pin the given timelineable to the given resource.",
"operationId": "modules-Core-TimelinePinController-store",
"requestBody": {
"description": "Pass data to pin the timelineable.",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CoreTimelinePinResource"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "The timelineable has been pinned successfully."
}
},
"type": "object"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/timeline/unpin": {
"post": {
"tags": [
"Core"
],
"summary": "Unpin the given timelineable to the given resource.",
"description": "Unpin the given timelineable to the given resource.",
"operationId": "modules-Core-TimelinePinController-destroy",
"requestBody": {
"description": "Pass data to pin the timelineable.",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CoreTimelinePinResource"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "The timelineable has been unpinned successfully."
}
},
"type": "object"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/timezones": {
"get": {
"tags": [
"Core"
],
"summary": "Get a list of all timezones.",
"description": "Get a list of all timezones.",
"operationId": "modules-Core-TimezoneController-handle",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Timezones retrieved successfully."
},
"data": {
"type": "array",
"items": {
"type": "string",
"example": "Africa/Abidjan"
}
}
},
"type": "object"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/tags/order": {
"post": {
"tags": [
"Tags"
],
"summary": "Save the pipelines display order.",
"description": "Save the pipelines display order.",
"operationId": "modules-Core-UpdateTagDisplayOrder-invoke",
"requestBody": {
"description": "Pass the tags with their display order",
"required": true,
"content": {
"application/json": {
"schema": {
"required": [
"id",
"display_order"
],
"type": "array",
"items": {
"properties": {
"id": {
"type": "integer",
"example": "1"
},
"display_order": {
"type": "integer",
"example": "1"
}
},
"type": "object"
}
}
}
}
},
"responses": {
"204": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Display order updated successfully"
}
},
"type": "object"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/patches": {
"get": {
"tags": [
"Updater"
],
"summary": "Get the available patches for the installed version.",
"description": "Get the available patches for the installed version.",
"operationId": "modules-Core-Updater-PatchController-index",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"patches": {
"type": "array",
"items": {
"properties": {
"token": {
"type": "string",
"example": "patch-token"
},
"description": {
"type": "string",
"example": "Patch description"
},
"applied": {
"type": "boolean",
"example": false
}
},
"type": "object"
}
}
},
"type": "object"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/patches/{token}/{purchase_key?}": {
"post": {
"tags": [
"Updater"
],
"summary": "Apply the given patch to the current installed version.",
"description": "Apply the given patch to the current installed version.",
"operationId": "modules-Core-Updater-PatchController-apply",
"parameters": [
{
"name": "token",
"in": "path",
"description": "Patch token",
"required": true,
"schema": {
"type": "string"
}
},
{
"$ref": "#/components/parameters/CoreUpdaterPurchaseKey"
}
],
"responses": {
"204": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Patch applied successfully"
}
},
"type": "object"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/update": {
"get": {
"tags": [
"Updater"
],
"summary": "Get information about update.",
"description": "Get information about update.",
"operationId": "modules-Core-UpdateController-index",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"installed_version": {
"type": "string",
"example": "1.0.0"
},
"latest_available_version": {
"type": "string",
"example": "1.0.1"
},
"is_new_version_available": {
"type": "boolean",
"example": "true"
},
"purchase_key": {
"type": "string",
"example": "purchase-key"
}
},
"type": "object"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/update/{purchaseKey?}": {
"post": {
"tags": [
"Updater"
],
"summary": "Perform an application update.",
"description": "Perform an application update.",
"operationId": "modules-Core-UpdateController-update",
"parameters": [
{
"$ref": "#/components/parameters/CoreUpdaterPurchaseKey"
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"installed_version": {
"type": "string",
"example": "1.0.0"
},
"latest_available_version": {
"type": "string",
"example": "1.0.1"
},
"is_new_version_available": {
"type": "boolean",
"example": "true"
},
"purchase_key": {
"type": "string",
"example": "purchase-key"
}
},
"type": "object"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/voip/events": {
"post": {
"tags": [
"Voip"
],
"summary": "Call events",
"description": "Call events",
"operationId": "modules-Core-VoIPController-events",
"responses": {
"200": {
"description": "Success"
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/voip/call": {
"post": {
"tags": [
"Voip"
],
"summary": "Initiate new call",
"description": "Initiate new call",
"operationId": "modules-Core-VoIPController-newCall",
"responses": {
"200": {
"description": "Success"
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/workflows": {
"get": {
"tags": [
"Workflow"
],
"summary": "Get the stored workflows.",
"description": "Get the stored workflows.",
"operationId": "modules-Core-Workflow-WorkflowController-index",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WorkflowResource"
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
},
"post": {
"tags": [
"Workflow"
],
"summary": "Display the specified workflow.",
"description": "Display the specified workflow.",
"operationId": "modules-Core-Workflow-WorkflowController-store",
"requestBody": {
"description": "Pass the workflow details",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WorkflowFormResource"
}
}
}
},
"responses": {
"201": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WorkflowResource"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/workflows/{workflow}": {
"get": {
"tags": [
"Workflow"
],
"summary": "Display the specified workflow.",
"description": "Display the specified workflow.",
"operationId": "modules-Core-Workflow-WorkflowController-show",
"parameters": [
{
"$ref": "#/components/parameters/CoreWorkflowId"
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WorkflowResource"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
},
"put": {
"tags": [
"Workflow"
],
"summary": "Update the specified workflow in storage.",
"description": "Update the specified workflow in storage.",
"operationId": "modules-Core-Workflow-WorkflowController-update",
"parameters": [
{
"$ref": "#/components/parameters/CoreWorkflowId"
}
],
"requestBody": {
"description": "Pass the workflow details",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WorkflowFormResource"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WorkflowResource"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
},
"delete": {
"tags": [
"Workflow"
],
"summary": "Remove the specified workflow from storage.",
"description": "Remove the specified workflow from storage.",
"operationId": "modules-Core-Workflow-WorkflowController-destroy",
"parameters": [
{
"$ref": "#/components/parameters/CoreWorkflowId"
}
],
"responses": {
"204": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Workflow deleted successfully"
}
},
"type": "object"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/workflows/triggers": {
"get": {
"tags": [
"Workflow"
],
"summary": "Get the available triggers.",
"description": "Get the available triggers.",
"operationId": "modules-Core-Workflow-WorkflowTriggers-invoke",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"properties": {
"identifier": {
"type": "string",
"example": "Modules\\Calls\\Workflow\\Triggers\\MissedIncomingCall"
},
"name": {
"type": "string",
"example": "Missed Incoming Call"
},
"actions": {
"type": "array",
"items": {
"properties": {
"identifier": {
"type": "string",
"example": "Modules\\Activities\\Workflow\\Actions\\CreateActivityAction"
},
"name": {
"type": "string",
"example": "Create Activity"
},
"fields": {
"type": "array",
"items": {
"properties": {
"component": {
"type": "string",
"example": "select-field"
},
"attribute": {
"type": "string",
"example": "due_date"
},
"label": {
"type": "string",
"example": null
},
"helpText": {
"type": "string",
"example": null
},
"icon": {
"type": "string",
"example": null
},
"options": {
"type": "array",
"items": {
"properties": {
"value": {
"type": "string",
"example": "today"
},
"label": {
"type": "string",
"example": "Today"
}
},
"type": "object"
}
}
},
"type": "object"
}
}
},
"type": "object"
}
}
},
"type": "object"
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/zapier/hooks/{resourceName}/{action}": {
"post": {
"tags": [
"Zapier"
],
"summary": "Subscribe to a hook.",
"description": "Subscribe to a hook.",
"operationId": "modules-Core-ZapierHookController-store",
"parameters": [
{
"name": "resourceName",
"in": "path",
"description": "Resource name",
"required": true,
"schema": {
"type": "string"
}
},
{
"name": "action",
"in": "path",
"description": "Action",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Request body",
"required": true,
"content": {
"application/json": {
"schema": {
"required": [
"targetUrl",
"zapId",
"data"
],
"properties": {
"targetUrl": {
"type": "string",
"example": "https://hooks.zapier.com/hooks/catch/123456/abcde"
},
"zapId": {
"type": "string",
"example": "1"
},
"data": {
"type": "array",
"items": {
"type": "string",
"example": "*"
}
}
},
"type": "object"
}
}
}
},
"responses": {
"201": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"hook": {
"type": "string",
"example": "https://hooks.zapier.com/hooks/catch/123456/abcde"
},
"resource_name": {
"type": "string",
"example": "users"
},
"action": {
"type": "string",
"example": "created"
},
"user_id": {
"type": "integer",
"example": "1"
},
"zap_id": {
"type": "integer",
"example": "1"
},
"data": {
"type": "array",
"items": {
"type": "string",
"example": "*"
}
}
},
"type": "object"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/zapier/hooks/{hookId}": {
"delete": {
"tags": [
"Zapier"
],
"summary": "Unsubscribe from hook.",
"description": "Unsubscribe from hook.",
"operationId": "modules-Core-ZapierHookController-destroy",
"parameters": [
{
"name": "hookId",
"in": "path",
"description": "Hook ID",
"required": true,
"schema": {
"type": "number"
}
}
],
"responses": {
"204": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Successfully unsubscribed from hook"
}
},
"type": "object"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/deals/board/{pipeline}": {
"get": {
"tags": [
"Deals"
],
"summary": "Get the deals initial board data.",
"description": "Returns the deals initial board data.",
"operationId": "modules-Deals-DealBoardController-board",
"parameters": [
{
"$ref": "#/components/parameters/DealBoardPipelineId"
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DealBoardResource"
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
},
"post": {
"tags": [
"Deals"
],
"summary": "Update board card order and stage.",
"description": "Update board card order and stage.",
"operationId": "modules-Deals-DealBoardController-update",
"parameters": [
{
"$ref": "#/components/parameters/DealBoardPipelineId"
}
],
"requestBody": {
"description": "Pass board data",
"required": true,
"content": {
"application/json": {
"schema": {
"required": [
"id",
"stage_id",
"board_order",
"swatch_color"
],
"type": "array",
"items": {
"properties": {
"id": {
"type": "integer",
"example": 1
},
"stage_id": {
"type": "integer",
"example": 1
},
"board_order": {
"type": "integer",
"example": 1
},
"swatch_color": {
"type": "string",
"example": "#FF0000"
}
},
"type": "object"
}
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Board updated successfully."
}
},
"type": "object"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/deals/board/{pipeline}/{stageId}": {
"get": {
"tags": [
"Deals"
],
"summary": "Load more deals for the given stage.",
"description": "Returns the deals for the given stage.",
"operationId": "modules-Deals-DealBoardController-load",
"parameters": [
{
"$ref": "#/components/parameters/DealBoardPipelineId"
},
{
"name": "stageId",
"in": "path",
"description": "Stage ID",
"required": true,
"schema": {
"type": "number"
}
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DealBoardResource"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/deals/board/{pipeline}/summary": {
"get": {
"tags": [
"Deals"
],
"summary": "Get the deals board summary for the given pipeline.",
"description": "Returns the deals board summary for the given pipeline.",
"operationId": "modules-Deals-DealBoardController-summary",
"parameters": [
{
"$ref": "#/components/parameters/DealBoardPipelineId"
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"count": {
"type": "number",
"example": 1
},
"value": {
"type": "number",
"example": 12
},
"weighted_value": {
"type": "number",
"example": 1.2
}
},
"type": "object"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/deals/{deals}/status/{status}": {
"put": {
"tags": [
"Deals"
],
"summary": "Change the deal status.",
"description": "Change the deal status.",
"operationId": "modules-Deals-DealStatusController-handle",
"parameters": [
{
"name": "deal",
"in": "path",
"description": "Deal ID",
"required": true,
"schema": {
"type": "number"
}
},
{
"name": "status",
"in": "path",
"description": "The status to change the deal to.",
"required": true,
"schema": {
"type": "string"
}
}
],
"requestBody": {
"description": "Pass deal status data",
"required": false,
"content": {
"application/json": {
"schema": {
"properties": {
"lost_reason": {
"type": "string",
"example": "Lost Reason"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DealResource"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/pipelines/{pipeline}/stages": {
"get": {
"tags": [
"Deals"
],
"summary": "Retrieve pipeline stages.",
"description": "Returns a list of pipeline stages.",
"operationId": "modules-Deals-PipelineStageController-index",
"parameters": [
{
"$ref": "#/components/parameters/DealBoardPipelineId"
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/StageResource"
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/pipelines/order": {
"post": {
"tags": [
"Deals"
],
"summary": "Save the pipelines display order.",
"description": "Save the pipelines display order.",
"operationId": "modules-Deals-UpdatePipelineDisplayOrder-invoke",
"requestBody": {
"description": "Pass pipeline order data",
"required": true,
"content": {
"application/json": {
"schema": {
"required": [
"order"
],
"properties": {
"order": {
"type": "array",
"items": {
"properties": {
"id": {
"type": "integer",
"example": "1"
},
"display_order": {
"type": "integer",
"example": "1"
}
},
"type": "object"
}
}
},
"type": "object"
}
}
}
},
"responses": {
"204": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Display order updated successfully."
}
},
"type": "object"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/d/{uuid}/accept": {
"post": {
"tags": [
"Documents"
],
"summary": "Accept a document without signature.",
"description": "Accept a document without signature.",
"operationId": "modules-Documents-DocumentAcceptController-accept",
"parameters": [
{
"$ref": "#/components/parameters/DocumentUuid"
}
],
"responses": {
"204": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Document accepted successfully."
}
},
"type": "object"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/d/{uuid}/sign": {
"post": {
"tags": [
"Documents"
],
"summary": "Accept a document with signature.",
"description": "Accept a document with signature.",
"operationId": "modules-Documents-DocumentAcceptController-sign",
"parameters": [
{
"$ref": "#/components/parameters/DocumentUuid"
}
],
"requestBody": {
"description": "Pass signer data",
"required": true,
"content": {
"application/json": {
"schema": {
"required": [
"email",
"signature"
],
"properties": {
"email": {
"type": "string",
"example": "example@gmail.com"
},
"signature": {
"type": "string",
"example": "Signature"
}
},
"type": "object"
}
}
}
},
"responses": {
"204": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Document signed successfully."
}
},
"type": "object"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/d/{uuid}/draft": {
"post": {
"tags": [
"Documents"
],
"summary": "Validate the document before signing based on the provided email address.",
"description": "Validate the document before signing based on the provided email address.",
"operationId": "modules-Documents-DocumentAcceptController-validateEmailAddress",
"parameters": [
{
"$ref": "#/components/parameters/DocumentUuid"
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Email address successfully validated."
},
"name": {
"type": "string",
"example": "John Doe"
}
},
"type": "object"
}
}
}
},
"204": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Display order updated successfully."
}
},
"type": "object"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/documents/{document}/lost": {
"post": {
"tags": [
"Documents"
],
"summary": "Accept a document without signature.",
"description": "Accept a document without signature.",
"operationId": "modules-Documents-DocumentStateController-lost",
"parameters": [
{
"$ref": "#/components/parameters/DocumentId"
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Document accepted successfully."
}
},
"type": "object"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/documents/{document}/accept": {
"post": {
"tags": [
"Documents"
],
"summary": "Accept a document without signature.",
"description": "Accept a document without signature.",
"operationId": "modules-Documents-DocumentStateController-accept",
"parameters": [
{
"$ref": "#/components/parameters/DocumentId"
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Document accepted successfully."
}
},
"type": "object"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/documents/{document}/draft": {
"post": {
"tags": [
"Documents"
],
"summary": "Accept a document without signature.",
"description": "Accept a document without signature.",
"operationId": "modules-Documents-DocumentStateController-draft",
"parameters": [
{
"$ref": "#/components/parameters/DocumentId"
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Document accepted successfully."
}
},
"type": "object"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/mail/accounts/connection": {
"post": {
"tags": [
"MailClient"
],
"summary": "Display personal email accounts for the logged in user.",
"description": "Display personal email accounts for the logged in user.",
"operationId": "module-MailClient-EmailAccountConnectionTestController-handle",
"requestBody": {
"description": "Email account connection data",
"required": true,
"content": {
"application/json": {
"schema": {
"required": [
"connection_type",
"username",
"email",
"password",
"imap_server",
"imap_port",
"imap_encryption",
"smtp_server",
"smtp_port",
"smtp_encryption",
"validate_cert"
],
"properties": {
"connection_type": {
"type": "string",
"enum": [
"imap"
],
"example": "imap"
},
"username": {
"type": "string",
"example": "username"
},
"email": {
"type": "string",
"format": "email",
"example": "example@gmail.com"
},
"password": {
"type": "string",
"example": "password"
},
"imap_server": {
"type": "string",
"example": "imap.gmail.com"
},
"imap_port": {
"type": "integer",
"example": 993
},
"imap_encryption": {
"type": "string",
"enum": [
"ssl",
"tls"
],
"example": "ssl"
},
"smtp_server": {
"type": "string",
"example": "smtp.gmail.com"
},
"smtp_port": {
"type": "integer",
"example": 465
},
"smtp_encryption": {
"type": "string",
"enum": [
"ssl",
"tls"
],
"example": "ssl"
},
"validate_cert": {
"type": "boolean",
"example": true
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Email accounts list",
"content": {
"application/json": {
"schema": {
"properties": {
"folders": {
"type": "array",
"items": {
"type": "string"
}
}
},
"type": "object"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/mail/accounts": {
"get": {
"tags": [
"MailClient"
],
"summary": "Get all email accounts the user can access.",
"description": "Get all email accounts the user can access.",
"operationId": "module-MailClient-EmailAccountController-index",
"responses": {
"200": {
"description": "Email accounts list",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EmailAccountResource"
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
},
"post": {
"tags": [
"MailClient"
],
"summary": "Store a newly created email account in storage.",
"description": "Store a newly created email account in storage.",
"operationId": "module-MailClient-EmailAccountController-store",
"requestBody": {
"description": "Email account data",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EmailAccountFormResource"
}
}
}
},
"responses": {
"201": {
"description": "Email accounts list",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EmailAccountResource"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/mail/accounts/{account}": {
"get": {
"tags": [
"MailClient"
],
"summary": "Display email account.",
"description": "Display email account.",
"operationId": "module-MailClient-EmailAccountController-show",
"parameters": [
{
"$ref": "#/components/parameters/MailClientAccountId"
}
],
"responses": {
"200": {
"description": "Email accounts list",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EmailAccountResource"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
},
"put": {
"tags": [
"MailClient"
],
"summary": "Update the specified account in storage.",
"description": "Update the specified account in storage.",
"operationId": "module-MailClient-EmailAccountController-update",
"parameters": [
{
"$ref": "#/components/parameters/MailClientAccountId"
}
],
"requestBody": {
"description": "Email account data",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EmailAccountFormResource"
}
}
}
},
"responses": {
"200": {
"description": "Email accounts list",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EmailAccountResource"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
},
"delete": {
"tags": [
"MailClient"
],
"summary": "Remove the specified account from storage.",
"description": "Remove the specified account from storage.",
"operationId": "module-MailClient-EmailAccountController-destroy",
"parameters": [
{
"$ref": "#/components/parameters/MailClientAccountId"
}
],
"responses": {
"200": {
"description": "Email accounts list",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Email account has been deleted."
},
"unread_count": {
"type": "number",
"example": 5
}
},
"type": "object"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/mail/accounts/unread": {
"get": {
"tags": [
"MailClient"
],
"summary": "Get all shared accounts unread messages.",
"description": "Get all shared accounts unread messages.",
"operationId": "module-MailClient-EmailAccountController-unread",
"parameters": [
{
"$ref": "#/components/parameters/MailClientAccountId"
}
],
"responses": {
"200": {
"description": "Total email unread messages",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Unread messages found."
},
"total": {
"type": "number",
"example": 5
}
},
"type": "object"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/inbox/emails/{account_id}/{folder_id}": {
"get": {
"tags": [
"MailClient"
],
"summary": "Get messages for account folder",
"description": "Get messages for account folder",
"operationId": "module-MailClient-EmailAccountMessagesController-index",
"parameters": [
{
"$ref": "#/components/parameters/MailClientInboxAccountId"
},
{
"$ref": "#/components/parameters/MailClientInboxFolderId"
}
],
"requestBody": {
"description": "Pass email account folder data",
"required": false,
"content": {
"application/json": {
"schema": {
"properties": {
"per_page": {
"type": "number",
"example": 10
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Mail templates list",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EmailAccountMessageResource"
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/inbox/emails/{account_id}": {
"post": {
"tags": [
"MailClient"
],
"summary": "Send new message",
"description": "Send new message",
"operationId": "module-MailClient-EmailAccountMessagesController-create",
"parameters": [
{
"$ref": "#/components/parameters/MailClientInboxAccountId"
}
],
"requestBody": {
"description": "Pass email account folder data",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EmailAccountMessageFormResource"
}
}
}
},
"responses": {
"200": {
"description": "Mail templates list",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EmailAccountMessageResource"
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/emails/{message}/reply": {
"post": {
"tags": [
"MailClient"
],
"summary": "Reply to a message",
"description": "Reply to a message",
"operationId": "module-MailClient-EmailAccountMessagesController-reply",
"parameters": [
{
"$ref": "#/components/parameters/MailClientMessageId"
}
],
"requestBody": {
"description": "Pass email account folder data",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EmailAccountMessageFormResource"
}
}
}
},
"responses": {
"200": {
"description": "Mail templates list",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EmailAccountMessageResource"
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/emails/{message}/forward": {
"post": {
"tags": [
"MailClient"
],
"summary": "Forward a message",
"description": "Forward a message",
"operationId": "module-MailClient-EmailAccountMessagesController-forward",
"parameters": [
{
"$ref": "#/components/parameters/MailClientMessageId"
}
],
"requestBody": {
"description": "Pass email account folder data",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EmailAccountMessageFormResource"
}
}
}
},
"responses": {
"200": {
"description": "Mail templates list",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EmailAccountMessageResource"
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/inbox/emails/{account_id}/{message}": {
"post": {
"tags": [
"MailClient"
],
"summary": "Get email account message",
"description": "Get email account message",
"operationId": "module-MailClient-EmailAccountMessagesController-show",
"parameters": [
{
"$ref": "#/components/parameters/MailClientInboxAccountId"
},
{
"$ref": "#/components/parameters/MailClientMessageId"
}
],
"responses": {
"200": {
"description": "Mail templates list",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EmailAccountMessageResource"
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/emails/{message}": {
"delete": {
"tags": [
"MailClient"
],
"summary": "Delete message from storage",
"description": "Delete message from storage",
"operationId": "module-MailClient-EmailAccountMessagesController-destroy",
"parameters": [
{
"$ref": "#/components/parameters/MailClientMessageId"
}
],
"responses": {
"204": {
"description": "Mail templates list",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Message has been deleted."
}
},
"type": "object"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/emails/{message}/read": {
"post": {
"tags": [
"MailClient"
],
"summary": "Mark the given message as read",
"description": "Mark the given message as read",
"operationId": "module-MailClient-EmailAccountMessagesController-read",
"parameters": [
{
"$ref": "#/components/parameters/MailClientMessageId"
}
],
"responses": {
"200": {
"description": "Mail templates list",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EmailAccountMessageResource"
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/emails/{message}/unread": {
"post": {
"tags": [
"MailClient"
],
"summary": "Mark the given message as unread",
"description": "Mark the given message as unread",
"operationId": "module-MailClient-EmailAccountMessagesController-unread",
"parameters": [
{
"$ref": "#/components/parameters/MailClientMessageId"
}
],
"responses": {
"200": {
"description": "Mail templates list",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EmailAccountMessageResource"
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/mail/accounts/{account}/primary": {
"put": {
"tags": [
"MailClient"
],
"summary": "Mark the given account as primary for the current user.",
"description": "Mark the given account as primary for the current user.",
"operationId": "module-MailClient-EmailAccountPrimaryStateController-update",
"parameters": [
{
"$ref": "#/components/parameters/MailClientAccountId"
}
],
"responses": {
"204": {
"description": "Email accounts list",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Account successfully marked as primary."
}
},
"type": "object"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/mail/accounts/primary": {
"delete": {
"tags": [
"MailClient"
],
"summary": "Remove primary account for the current user.",
"description": "Remove primary account for the current user.",
"operationId": "module-MailClient-EmailAccountPrimaryStateController-destroy",
"responses": {
"204": {
"description": "Email accounts list",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Primary account successfully removed."
}
},
"type": "object"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/mail/accounts/{account}/sync": {
"get": {
"tags": [
"MailClient"
],
"summary": "Invoke synchronization for the given email account.",
"description": "Invoke synchronization for the given email account.",
"operationId": "module-MailClient-EmailAccountSync-invoke",
"parameters": [
{
"$ref": "#/components/parameters/MailClientAccountId"
}
],
"responses": {
"200": {
"description": "Notifications list",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EmailAccountResource"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/mail/accounts/{account}/sync/enable": {
"post": {
"tags": [
"MailClient"
],
"summary": "Enable synchronization for the given email account.",
"description": "Enable synchronization for the given email account.",
"operationId": "module-MailClient-EmailAccountSyncStateController-enable",
"parameters": [
{
"$ref": "#/components/parameters/MailClientAccountId"
}
],
"responses": {
"204": {
"description": "Email accounts list",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EmailAccountResource"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/mail/accounts/{account}/sync/disable": {
"post": {
"tags": [
"MailClient"
],
"summary": "Disable synchronization for the given email account.",
"description": "Disable synchronization for the given email account.",
"operationId": "module-MailClient-EmailAccountSyncStateController-disable",
"parameters": [
{
"$ref": "#/components/parameters/MailClientAccountId"
}
],
"responses": {
"204": {
"description": "Email accounts list",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EmailAccountResource"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/mail/accounts/personal": {
"get": {
"tags": [
"MailClient"
],
"summary": "Display personal email accounts for the logged in user.",
"description": "Display personal email accounts for the logged in user.",
"operationId": "module-MailClient-PersonalEmailAccountController-invoke",
"responses": {
"200": {
"description": "Email accounts list",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EmailAccountResource"
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/mails/templates": {
"get": {
"tags": [
"MailClient"
],
"summary": "Display a listing of the mail templates.",
"description": "Display a listing of the mail templates.",
"operationId": "module-MailClient-PredefinedMailTemplateController-index",
"responses": {
"200": {
"description": "Mail templates list",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PredefinedMailTemplateResource"
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
},
"post": {
"tags": [
"MailClient"
],
"summary": "Display the specified mail template.",
"description": "Display the specified mail template.",
"operationId": "module-MailClient-PredefinedMailTemplateController-store",
"requestBody": {
"description": "Mail template data",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PredefinedMailTemplateFormResource"
}
}
}
},
"responses": {
"201": {
"description": "Mail templates list",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PredefinedMailTemplateResource"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/mails/templates/{template}": {
"get": {
"tags": [
"MailClient"
],
"summary": "Display the specified mail template.",
"description": "Display the specified mail template.",
"operationId": "module-MailClient-PredefinedMailTemplateController-show",
"parameters": [
{
"$ref": "#/components/parameters/MailClientTemplateId"
}
],
"responses": {
"200": {
"description": "Mail templates list",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PredefinedMailTemplateResource"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
},
"put": {
"tags": [
"MailClient"
],
"summary": "Update the specified mail template in storage.",
"description": "Update the specified mail template in storage.",
"operationId": "module-MailClient-PredefinedMailTemplateController-update",
"parameters": [
{
"$ref": "#/components/parameters/MailClientTemplateId"
}
],
"requestBody": {
"description": "Mail template data",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PredefinedMailTemplateFormResource"
}
}
}
},
"responses": {
"200": {
"description": "Mail templates list",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PredefinedMailTemplateResource"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
},
"delete": {
"tags": [
"MailClient"
],
"summary": "Remove the specified mail template from storage.",
"description": "Remove the specified mail template from storage.",
"operationId": "module-MailClient-PredefinedMailTemplateController-destroy",
"parameters": [
{
"$ref": "#/components/parameters/MailClientTemplateId"
}
],
"responses": {
"204": {
"description": "Mail templates list",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Mail template successfully deleted."
}
},
"type": "object"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/mail/accounts/shared": {
"get": {
"tags": [
"MailClient"
],
"summary": "Display shared email accounts.",
"description": "Display shared email accounts.",
"operationId": "module-MailClient-SharedEmailAccountController-invoke",
"responses": {
"200": {
"description": "Email accounts list",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EmailAccountResource"
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/translation/{locale}": {
"get": {
"tags": [
"Translator"
],
"summary": "Display a listing of the resource.",
"description": "Get translations for the given locale.",
"operationId": "modules-Translator-TranslationController-index",
"parameters": [
{
"$ref": "#/components/parameters/TranslatorLocale"
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"source": {
"$ref": "#/components/schemas/TranslationResource"
},
"current": {
"$ref": "#/components/schemas/TranslationResource"
}
},
"type": "object"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/translation": {
"post": {
"tags": [
"Translator"
],
"summary": "Create new language locale.",
"description": "Add new language locale to the system.",
"operationId": "modules-Translator-TranslationController-store",
"requestBody": {
"description": "Pass locale data",
"required": true,
"content": {
"application/json": {
"schema": {
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"example": "fr"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "New locale created successfully."
},
"locale": {
"type": "string",
"example": "fr"
}
},
"type": "object"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/translation/{locale}/{group}": {
"put": {
"tags": [
"Translator"
],
"summary": "Update locale group translations.",
"description": "Update locale group translations.",
"operationId": "modules-Translator-TranslationController-update",
"requestBody": {
"description": "Pass translations data",
"required": true,
"content": {
"application/json": {
"schema": {
"required": [
"translations",
"namespace"
],
"properties": {
"translations": {
"properties": {
"auth.user.name": {
"type": "string",
"example": "User Name"
},
"auth.user.email": {
"type": "string",
"example": "User Email"
}
},
"type": "object"
},
"namespace": {
"type": "string",
"example": "auth"
}
},
"type": "object"
}
}
}
},
"responses": {
"204": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Translations updated successfully."
}
},
"type": "object"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/token": {
"post": {
"tags": [
"Authentication"
],
"summary": "Exchange Token",
"description": "Exchange new token for a given valid username and password",
"operationId": "module-Users-IssueTokenController-store",
"requestBody": {
"description": "User credentials",
"required": true,
"content": {
"application/json": {
"schema": {
"required": [
"email",
"password",
"device_name"
],
"properties": {
"email": {
"type": "string",
"format": "email",
"example": "hello@world.com"
},
"password": {
"type": "string",
"format": "password",
"example": "password"
},
"device_name": {
"type": "string",
"example": "iPhone 12 Pro Max"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "Login successful",
"content": {
"application/json": {
"schema": {
"properties": {
"accessToken": {
"type": "string",
"example": "2|xxxxxxxx"
},
"userId": {
"type": "integer",
"example": 1
},
"email": {
"type": "string",
"format": "email",
"example": "hello@world.com"
},
"name": {
"type": "string",
"example": "John Doe"
}
},
"type": "object"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/notifications": {
"get": {
"tags": [
"Notifications"
],
"summary": "List current user notifications.",
"description": "Returns the list of current user notifications.",
"operationId": "module-Users-NotificationController-index",
"responses": {
"200": {
"description": "Notifications list",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotificationPaginateResource"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/notifications/{notification}": {
"get": {
"tags": [
"Notifications"
],
"summary": "Retrieve current user notification.",
"description": "Returns the current user notification.",
"operationId": "module-Users-NotificationController-show",
"parameters": [
{
"$ref": "#/components/parameters/UserNotificationId"
}
],
"responses": {
"200": {
"description": "Notifications list",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/NotificationResource"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
},
"security": [
{
"sanctum": []
}
]
},
"put": {
"tags": [
"Notifications"
],
"summary": "Set all notifications for current user as read.",
"description": "Set all notifications for current user as read.",
"operationId": "module-Users-NotificationController-update",
"parameters": [
{
"$ref": "#/components/parameters/UserNotificationId"
}
],
"responses": {
"204": {
"description": "Notifications list",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Notifications have been marked as read."
}
},
"type": "object"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
},
"delete": {
"tags": [
"Notifications"
],
"summary": "Delete current user notification",
"description": "Delete current user notification",
"operationId": "module-Users-NotificationController-destroy",
"parameters": [
{
"$ref": "#/components/parameters/UserNotificationId"
}
],
"responses": {
"204": {
"description": "Notifications list",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Notification has been deleted."
}
},
"type": "object"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/personal-access-tokens": {
"get": {
"tags": [
"Authentication"
],
"summary": "Get all user personal access tokens.",
"description": "Get all user personal access tokens.",
"operationId": "module-Users-PersonalAccessTokenController-index",
"responses": {
"200": {
"description": "Personal access tokens list",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PersonalAccessTokenResource"
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
},
"post": {
"tags": [
"Authentication"
],
"summary": "Create new user personal access token.",
"description": "Create new user personal access token.",
"operationId": "module-Users-PersonalAccessTokenController-store",
"requestBody": {
"description": "Token name",
"required": true,
"content": {
"application/json": {
"schema": {
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"example": "My iPhone"
}
},
"type": "object"
}
}
}
},
"responses": {
"201": {
"description": "Personal access token created",
"content": {
"application/json": {
"schema": {
"properties": {
"accessToken": {
"$ref": "#/components/schemas/PersonalAccessTokenResource"
},
"plainTextToken": {
"type": "string",
"example": "2|xxxxxxxx"
}
},
"type": "object"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/personal-access-tokens/{token}": {
"delete": {
"tags": [
"Authentication"
],
"summary": "Revoke the given user personal access token.",
"description": "Revoke the given user personal access token.",
"operationId": "module-Users-PersonalAccessTokenController-destroy",
"parameters": [
{
"name": "token",
"in": "path",
"description": "Personal access token ID",
"required": true,
"schema": {
"type": "number"
}
}
],
"responses": {
"204": {
"description": "Token revoked successfully.",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Token revoked successfully."
}
},
"type": "object"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/me": {
"get": {
"tags": [
"Users"
],
"summary": "Get user profile",
"description": "Returns the authenticated user profile",
"operationId": "module-Users-ProfileController-show",
"responses": {
"200": {
"description": "User profile",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserResource"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/profile": {
"put": {
"tags": [
"Users"
],
"summary": "Update user profile",
"description": "Update the authenticated user profile",
"operationId": "module-Users-ProfileController-update",
"requestBody": {
"description": "User profile data",
"required": true,
"content": {
"application/json": {
"schema": {
"required": [
"name",
"email",
"time_format",
"date_format",
"first_day_of_week",
"locale",
"timezone"
],
"properties": {
"name": {
"type": "string",
"example": "John Doe"
},
"email": {
"type": "string",
"format": "email",
"example": "example@gmail.com"
},
"time_format": {
"type": "string",
"example": "H:i"
},
"date_format": {
"type": "string",
"example": "Y-m-d"
},
"first_day_of_week": {
"type": "integer",
"example": 1
},
"locale": {
"type": "string",
"example": "en"
},
"timezone": {
"type": "string",
"example": "UTC"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "User profile",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserResource"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/profile/password": {
"put": {
"tags": [
"Users"
],
"summary": "Change password.",
"description": "Change the authenticated user password.",
"operationId": "module-Users-ProfileController-password",
"requestBody": {
"description": "User profile data",
"required": true,
"content": {
"application/json": {
"schema": {
"required": [
"old_password",
"password",
"password_confirmation"
],
"properties": {
"old_password": {
"type": "string",
"format": "password",
"example": "old_password"
},
"password": {
"type": "string",
"format": "password",
"example": "new_password"
},
"password_confirmation": {
"type": "string",
"format": "password",
"example": "new_password"
}
},
"type": "object"
}
}
}
},
"responses": {
"204": {
"description": "User profile",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Password updated successfully"
}
},
"type": "object"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/teams": {
"get": {
"tags": [
"Teams"
],
"summary": "Retrieve all teams.",
"description": "Returns the list of all teams.",
"operationId": "module-Users-TeamController-index",
"responses": {
"200": {
"description": "Teams list",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TeamResource"
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
},
"post": {
"tags": [
"Teams"
],
"summary": "Create new team.",
"description": "Add a new team.",
"operationId": "module-Users-TeamController-store",
"requestBody": {
"description": "Team data",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TeamFormResource"
}
}
}
},
"responses": {
"201": {
"description": "Teams list",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TeamResource"
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/teams/{team}": {
"get": {
"tags": [
"Teams"
],
"summary": "Retrieve a teams.",
"description": "Returns the team details.",
"operationId": "mmodule-Users-TeamController-show",
"parameters": [
{
"$ref": "#/components/parameters/UserTeamsId"
}
],
"responses": {
"200": {
"description": "Teams list",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TeamResource"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
},
"put": {
"tags": [
"Teams"
],
"summary": "Update a team.",
"description": "Change the team details.",
"operationId": "module-Users-TeamController-update",
"parameters": [
{
"$ref": "#/components/parameters/UserTeamsId"
}
],
"requestBody": {
"description": "Team data",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TeamFormResource"
}
}
}
},
"responses": {
"200": {
"description": "Teams list",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/TeamResource"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
},
"delete": {
"tags": [
"Teams"
],
"summary": "Delete a team.",
"description": "Remove the team.",
"operationId": "module-Users-TeamController-destroy",
"parameters": [
{
"$ref": "#/components/parameters/UserTeamsId"
}
],
"responses": {
"204": {
"description": "Team deleted successfully.",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Team deleted successfully."
}
},
"type": "object"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/users/{user}/avatar": {
"post": {
"tags": [
"Users"
],
"summary": "Upload user avatar.",
"description": "Upload user avatar.",
"operationId": "module-Users-UserAvatarController-store",
"parameters": [
{
"$ref": "#/components/parameters/UserAvatarId"
}
],
"requestBody": {
"description": "User avatar data",
"required": true,
"content": {
"multipart/form-data": {
"schema": {
"properties": {
"avatar": {
"type": "string",
"format": "binary"
}
},
"type": "object"
}
}
}
},
"responses": {
"200": {
"description": "User profile",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserResource"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
},
"delete": {
"tags": [
"Users"
],
"summary": "Delete the user avatar.",
"description": "Delete the user avatar.",
"operationId": "module-Users-UserAvatarController-delete",
"parameters": [
{
"$ref": "#/components/parameters/UserAvatarId"
}
],
"responses": {
"200": {
"description": "User profile",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserResource"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/users/invite": {
"post": {
"tags": [
"Users"
],
"summary": "Invite the user to create account.",
"description": "Invite the user to create account.",
"operationId": "module-Users-UserInvitationController-handle",
"requestBody": {
"description": "User invitation data",
"required": true,
"content": {
"application/json": {
"schema": {
"required": [
"emails"
],
"properties": {
"emails": {
"type": "array",
"items": {
"type": "string",
"format": "email",
"example": "example@gmail.com"
}
},
"super_admin": {
"type": "boolean",
"example": true
},
"access_api": {
"type": "boolean",
"example": true
},
"roles": {
"type": "array",
"items": {
"type": "string",
"example": "admin"
}
},
"teams": {
"type": "array",
"items": {
"type": "string",
"example": "team1"
}
}
},
"type": "object"
}
}
}
},
"responses": {
"204": {
"description": "Invitations have been sent successfully.",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Invitations have been sent successfully."
}
},
"type": "object"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/forms": {
"get": {
"tags": [
"WebForms"
],
"summary": "Get all web forms.",
"description": "Returns a list of all web forms.",
"operationId": "modules-WebForms-WebFormController-index",
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/WebFormResource"
}
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
},
"post": {
"tags": [
"WebForms"
],
"summary": "Store a newly created web form in storage.",
"description": "Add a new web form.",
"operationId": "modules-WebForms-WebFormController-store",
"requestBody": {
"description": "Web Form data",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WebFormFormResource"
}
}
}
},
"responses": {
"201": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WebFormResource"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
},
"/api/forms/{form}": {
"get": {
"tags": [
"WebForms"
],
"summary": "Get specific web form.",
"description": "Returns a specific web form.",
"operationId": "modules-WebForms-WebFormController-show",
"parameters": [
{
"$ref": "#/components/parameters/WebFormId"
}
],
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WebFormResource"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
},
"put": {
"tags": [
"WebForms"
],
"summary": "Update the specified web form in storage.",
"description": "Change the web form data.",
"operationId": "modules-WebForms-WebFormController-update",
"parameters": [
{
"$ref": "#/components/parameters/WebFormId"
}
],
"requestBody": {
"description": "Web Form data",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WebFormFormResource"
}
}
}
},
"responses": {
"200": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/WebFormResource"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
},
"delete": {
"tags": [
"WebForms"
],
"summary": "Remove the specified web form from storage.",
"description": "Delete the web form.",
"operationId": "modules-WebForms-WebFormController-destroy",
"parameters": [
{
"$ref": "#/components/parameters/WebFormId"
}
],
"responses": {
"204": {
"description": "Success",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Web form deleted successfully."
}
},
"type": "object"
}
}
}
},
"401": {
"$ref": "#/components/responses/Default401Response"
},
"403": {
"$ref": "#/components/responses/Default403Response"
},
"404": {
"$ref": "#/components/responses/Default404Response"
},
"405": {
"$ref": "#/components/responses/Default405Response"
},
"409": {
"$ref": "#/components/responses/Default409Response"
},
"419": {
"$ref": "#/components/responses/Default419Response"
},
"422": {
"$ref": "#/components/responses/Default422Response"
},
"429": {
"$ref": "#/components/responses/Default429Response"
},
"500": {
"$ref": "#/components/responses/Default500Response"
}
}
}
}
},
"components": {
"schemas": {
"TwilioFormResource": {
"title": "Component for Twilio App Form Resource",
"properties": {
"account_sid": {
"type": "string",
"example": "ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
},
"auth_token": {
"type": "string",
"example": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
}
},
"type": "object"
},
"TwilioAppFormResource": {
"title": "Component for Twilio App Detail Form Resource",
"properties": {
"number": {
"type": "string",
"example": "+1234567890"
},
"account_sid": {
"type": "string",
"example": "ACxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
},
"auth_token": {
"type": "string",
"example": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
}
},
"type": "object"
},
"ActivityResource": {
"title": "Component for Activity Resource",
"properties": {
"is_reminded": {
"description": "Transform the resource collection into an array.",
"type": "boolean",
"example": "true"
},
"is_completed": {
"type": "boolean",
"example": "true"
},
"completed_at": {
"type": "string",
"example": "2021-09-01 00:00:00"
},
"is_due": {
"type": "boolean",
"example": "true"
},
"created_by": {
"type": "integer",
"example": "1"
},
"creator": {
"$ref": "#/components/schemas/UserResource"
},
"comments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CommentResource"
}
},
"comments_count": {
"type": "integer",
"example": "1"
},
"media": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MediaResource"
}
}
},
"type": "object"
},
"SimpleCalendarResource": {
"title": "Component for Simple Calendar Resource",
"properties": {
"id": {
"description": "Transform the resource collection into an array.",
"type": "integer",
"example": "1"
},
"calendar_id": {
"type": "string",
"example": "xxxxxxxxxx"
},
"start_sync_from": {
"type": "string",
"example": "2021-01-01"
},
"created_at": {
"type": "string",
"example": "2021-01-01 00:00:00"
}
},
"type": "object"
},
"CalendarResource": {
"title": "Component for Calendar Resource",
"properties": {
"id": {
"type": "integer",
"example": "1"
},
"email": {
"type": "string",
"example": "example@gmail.com"
},
"calendar_id": {
"type": "string",
"example": "xxxxxxxxxx"
},
"activity_type_id": {
"type": "integer",
"example": "1"
},
"activity_types": {
"type": "string",
"example": "activity type"
},
"start_sync_from": {
"type": "string",
"example": "2021-01-01"
},
"user_id": {
"type": "integer",
"example": "1"
},
"user": {
"$ref": "#/components/schemas/UserResource"
},
"account": {
"$ref": "#/components/schemas/OAuthAccountResource"
},
"last_sync_at": {
"type": "string",
"example": "2021-01-01 00:00:00"
},
"is_readonly": {
"type": "boolean",
"example": "true"
},
"is_shared": {
"type": "boolean",
"example": "true"
},
"is_sync_disabled": {
"type": "boolean",
"example": "true"
},
"is_sync_stopped": {
"type": "boolean",
"example": "true"
},
"is_synchronizing_via_webhook": {
"type": "boolean",
"example": "true"
},
"sync_state_comment": {
"type": "string",
"example": "sync state comment"
},
"previously_used": {
"type": "array",
"items": {
"$ref": "#/components/schemas/SimpleCalendarResource"
}
},
"created_at": {
"type": "string",
"example": "2021-01-01 00:00:00"
},
"updated_at": {
"type": "string",
"example": "2021-01-01 00:00:00"
}
},
"type": "object"
},
"BillableProductResource": {
"title": "Component for Billable Product Resource",
"properties": {
"product_id": {
"description": "Transform the resource collection into an array.",
"type": "integer",
"example": "1"
},
"name": {
"type": "string",
"example": "Product Name"
},
"description": {
"type": "string",
"example": "Product Description"
},
"unit_price": {
"type": "number",
"example": "100.00"
},
"qty": {
"type": "integer",
"example": "1"
},
"unit": {
"type": "string",
"example": "unit"
},
"tax_rate": {
"type": "number",
"example": "0.00"
},
"tax_label": {
"type": "string",
"example": "VAT"
},
"discount_type": {
"type": "string",
"example": "percentage"
},
"discount_total": {
"type": "number",
"example": "0.00"
},
"sku": {
"type": "string",
"example": "SKU123"
},
"amount": {
"type": "number",
"example": "100.00"
},
"note": {
"type": "string",
"example": "Product Note"
},
"display_order": {
"type": "integer",
"example": "1"
}
},
"type": "object"
},
"BillableProductFormResource": {
"title": "Component for Billable Product Form Resource",
"properties": {
"product_id": {
"type": "integer",
"example": 1
},
"name": {
"type": "string",
"example": "Product Name"
},
"discount_type": {
"type": "string",
"example": "fixed"
},
"display_order": {
"type": "integer",
"example": 1
},
"qty": {
"type": "number",
"example": 1
},
"unit": {
"type": "string",
"example": "unit"
},
"tax_label": {
"type": "string",
"example": "VAT"
},
"tax_rate": {
"type": "number",
"example": 0
}
},
"type": "object"
},
"BillableResource": {
"title": "Component for Billable Resource",
"properties": {
"tax_type": {
"description": "Transform the resource collection into an array.",
"type": "string",
"example": "VAT"
},
"subtotal": {
"type": "integer",
"example": "1000"
},
"total": {
"type": "integer",
"example": "1200"
},
"total_tax": {
"type": "integer",
"example": "200"
},
"taxes": {
"type": "array",
"items": {
"properties": {
"total": {
"type": "number",
"example": "20"
}
},
"type": "object"
}
},
"has_discount": {
"type": "boolean",
"example": "true"
},
"total_discount": {
"type": "integer",
"example": "100"
},
"products": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BillableProductResource"
}
}
},
"type": "object"
},
"BillableFormResource": {
"title": "Component for Billable Form Resource",
"properties": {
"tax_type": {
"type": "string",
"example": "vat"
},
"description": {
"type": "string",
"example": "Billable Description"
},
"products": {
"type": "array",
"items": {
"$ref": "#/components/schemas/BillableProductFormResource"
}
}
},
"type": "object"
},
"BillableConfigResource": {
"title": "Component for Billable Config Resource",
"properties": {
"primary_color": {
"description": "Transform the resource collection into an array.",
"type": "string",
"example": "#4f46e5"
},
"pdf": {
"properties": {
"font": {
"type": "string",
"example": "DejaVu Sans"
},
"size": {
"type": "string",
"example": "a4"
},
"orientation": {
"type": "string",
"example": "portrait"
}
},
"type": "object"
},
"navigation": {
"properties": {
"background_color": {
"type": "string",
"example": "#4f46e5"
}
},
"type": "object"
},
"document": {
"properties": {
"mail_subject": {
"properties": {
"en": {
"type": "string",
"example": "Your document is ready"
}
},
"type": "object"
},
"mail_message": {
"properties": {
"en": {
"type": "string",
"example": "Your document is ready"
}
},
"type": "object"
},
"mail_button_text": {
"properties": {
"en": {
"type": "string",
"example": "Read Your Document"
}
},
"type": "object"
},
"signed_mail_subject": {
"properties": {
"en": {
"type": "string",
"example": "Thank you for signing our document."
}
},
"type": "object"
},
"signed_mail_message": {
"properties": {
"en": {
"type": "string",
"example": "You can view the document at any time by clicking the button below. You can also download it as a PDF to save it."
}
},
"type": "object"
},
"signed_thankyou_message": {
"properties": {
"en": {
"type": "string",
"example": "Thank you for signing our document. We will be in touch shortly so that we can get started."
}
},
"type": "object"
},
"accepted_thankyou_message": {
"properties": {
"en": {
"type": "string",
"example": "Thank you for accepting our document. We will be in touch shortly so that we can get started."
}
},
"type": "object"
}
},
"type": "object"
},
"signature": {
"properties": {
"bound_text": {
"properties": {
"en": {
"type": "string",
"example": "I, {{ signerName }}, agree to the terms of this agreement and I agree that my typed name below can be used as a digital representation of my signature to that fact"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"BrandResource": {
"title": "Component for Brand Resource",
"properties": {
"id": {
"type": "integer",
"example": "1"
},
"name": {
"type": "string",
"example": "Brand 1"
},
"display_name": {
"type": "string",
"example": "Brand 1"
},
"is_default": {
"type": "boolean",
"example": "true"
},
"config": {
"$ref": "#/components/schemas/BillableConfigResource"
},
"logo_view": {
"type": "string",
"example": "logo_view.png"
},
"logo_view_url": {
"type": "string",
"example": "http://localhost:8000/storage/logo_view.png"
},
"logo_mail": {
"type": "string",
"example": "logo_mail.png"
},
"logo_mail_url": {
"type": "string",
"example": "http://localhost:8000/storage/logo_mail.png"
},
"visibility_group": {
"type": "string",
"example": "all"
}
},
"type": "object"
},
"BrandFormResource": {
"title": "Component for Brand Form Resource",
"properties": {
"name": {
"type": "string",
"example": "Brand Name"
},
"display_name": {
"type": "string",
"example": "Brand Display Name"
},
"is_default": {
"type": "boolean",
"example": "false"
},
"config": {
"properties": {
"primary_color": {
"type": "string",
"example": "#4f46e5"
},
"pdf": {
"properties": {
"font": {
"type": "string",
"example": "DejaVu Sans"
},
"size": {
"type": "string",
"example": "a4"
},
"orientation": {
"type": "string",
"example": "portrait"
}
},
"type": "object"
},
"signature": {
"properties": {
"bound_text": {
"properties": {
"en": {
"type": "string",
"example": "I, {{ signerName }}, agree to the terms of this agreement and I agree that my typed name below can be used as a digital representation of my signature to that fact"
}
},
"type": "object"
}
},
"type": "object"
},
"document": {
"properties": {
"mail_subject": {
"properties": {
"en": {
"type": "string",
"example": "Your document is ready"
}
},
"type": "object"
},
"mail_message": {
"properties": {
"en": {
"type": "string",
"example": "Your document is ready"
}
},
"type": "object"
},
"mail_button_text": {
"properties": {
"en": {
"type": "string",
"example": "Read Your Document"
}
},
"type": "object"
},
"signed_mail_subject": {
"properties": {
"en": {
"type": "string",
"example": "Thank you for signing our document."
}
},
"type": "object"
},
"signed_mail_message": {
"properties": {
"en": {
"type": "string",
"example": "You can view the document at any time by clicking the button below. You can also download it as a PDF to save it."
}
},
"type": "object"
},
"signed_thankyou_message": {
"properties": {
"en": {
"type": "string",
"example": "Thank you for signing our document. We will be in touch shortly so that we can get started."
}
},
"type": "object"
},
"accepted_thankyou_message": {
"properties": {
"en": {
"type": "string",
"example": "Thank you for accepting our document. We will be in touch shortly so that we can get started."
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"CallResource": {
"title": "Component for Call Resource",
"properties": {
"body": {
"description": "Transform the resource collection into an array.",
"type": "string",
"example": "This is a call"
},
"date": {
"type": "string",
"example": "2021-01-01 00:00:00"
},
"user_id": {
"type": "integer",
"example": "1"
},
"user": {
"$ref": "#/components/schemas/UserResource"
},
"companies": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CompanyResource"
}
},
"contacts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContactResource"
}
},
"deals": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DealResource"
}
},
"comments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CommentResource"
}
},
"comments_count": {
"type": "integer",
"example": "1"
}
},
"type": "object"
},
"CommentResource": {
"title": "Component for Comment Resource",
"properties": {
"body": {
"description": "Transform the resource collection into an array.",
"type": "string",
"example": "This is a comment"
},
"created_by": {
"type": "integer",
"example": "1"
},
"creator": {
"$ref": "#/components/schemas/UserResource"
}
},
"type": "object"
},
"CommentFormResource": {
"title": "Component for Comment Form Resource",
"properties": {
"body": {
"type": "string",
"example": "This is a comment"
},
"via_resource": {
"type": "string",
"example": "notes"
},
"via_resource_id": {
"type": "integer",
"example": "1"
}
},
"type": "object"
},
"CompanyResource": {
"title": "Component for Company Resource",
"properties": {
"notes_count": {
"description": "Transform the resource collection into an array.",
"type": "integer",
"example": "1"
},
"calls_count": {
"type": "integer",
"example": "1"
},
"parents": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CompanyResource"
}
},
"changelog": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ChangelogResource"
}
},
"notes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NoteResource"
}
},
"calls": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CallResource"
}
},
"activities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ActivityResource"
}
},
"media": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MediaResource"
}
},
"emails": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EmailAccountMessageResource"
}
}
},
"type": "object"
},
"ContactResource": {
"title": "Component for Contact Resource",
"properties": {
"notes_count": {
"description": "Transform the resource collection into an array.",
"type": "integer",
"example": "1"
},
"calls_count": {
"type": "integer",
"example": "1"
},
"avatar": {
"type": "string",
"example": "avatar.jpg"
},
"avatar_url": {
"type": "string",
"example": "http://localhost:8000/storage/avatar.jpg"
},
"uploaded_avatar_url": {
"type": "string",
"example": "http://localhost:8000/storage/avatar.jpg"
},
"changelog": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ChangelogResource"
}
},
"notes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NoteResource"
}
},
"calls": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CallResource"
}
},
"activities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ActivityResource"
}
},
"media": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MediaResource"
}
},
"emails": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EmailAccountMessageResource"
}
}
},
"type": "object"
},
"CardResource": {
"title": "Component for Card Resource",
"properties": {
"range": {
"type": "string",
"example": null
},
"ranges": {
"type": "array",
"items": {
"properties": {
"label": {
"type": "string",
"example": "This Week"
},
"value": {
"type": "string",
"example": "this_week"
}
},
"type": "object"
}
},
"uriKey": {
"type": "string",
"example": "my-activities"
},
"component": {
"type": "string",
"example": "my-activities-card"
},
"name": {
"type": "string",
"example": "My Activities"
},
"description": {
"type": "string",
"example": null
},
"width": {
"type": "string",
"example": "w-full lg:w-1/2"
},
"withUserSelection": {
"type": "boolean",
"example": false
},
"users": {
"type": "array",
"items": {
"properties": {
"id": {
"type": "integer",
"example": 1
},
"name": {
"type": "string",
"example": "John Doe"
}
},
"type": "object"
}
},
"refreshOnActionExecuted": {
"type": "boolean",
"example": false
},
"helpText": {
"type": "string",
"example": "This cards reflects the activities that you are added as owner"
},
"data": {
"type": "array",
"items": {}
},
"fields": {
"type": "array",
"items": {
"properties": {
"key": {
"type": "string",
"example": "name"
},
"label": {
"type": "string",
"example": "Name"
},
"sortable": {
"type": "boolean",
"example": true
}
},
"type": "object"
}
},
"items": {
"properties": {
"data": {
"type": "array",
"items": {}
},
"links": {
"properties": {
"first": {
"type": "string",
"example": "http://localhost/api/my-activities?page=1"
},
"last": {
"type": "string",
"example": "http://localhost/api/my-activities?page=1"
},
"prev": {
"type": "string",
"example": null
},
"next": {
"type": "string",
"example": null
}
},
"type": "object"
},
"meta": {
"properties": {
"current_page": {
"type": "integer",
"example": 1
},
"from": {
"type": "integer",
"example": 1
},
"last_page": {
"type": "integer",
"example": 1
},
"links": {
"type": "array",
"items": {
"properties": {
"url": {
"type": "string",
"example": "http://localhost/api/my-activities?page=1"
},
"label": {
"type": "string",
"example": "1"
},
"active": {
"type": "boolean",
"example": true
}
},
"type": "object"
}
},
"path": {
"type": "string",
"example": "http://localhost/api/my-activities"
},
"per_page": {
"type": "integer",
"example": 15
},
"to": {
"type": "integer",
"example": 1
},
"total": {
"type": "integer",
"example": 1
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"CoreFilterRulesResource": {
"title": "Component for Core Filter Rules Resource",
"properties": {
"id": {
"type": "string",
"example": "first_name"
},
"label": {
"type": "string",
"example": "First Name"
},
"type": {
"type": "string",
"example": "text"
},
"operators": {
"type": "array",
"items": {
"type": "string",
"example": "equals"
}
},
"operatorsOptions": {
"properties": {
"is": {
"properties": {
"next_day": {
"type": "string",
"example": "Next Day"
}
},
"type": "object"
}
},
"type": "object"
},
"component": {
"type": "string",
"example": "date-rule"
},
"isStatic": {
"type": "boolean",
"example": "false"
},
"operands": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CoreFilterRulesResource"
}
},
"has_authorization": {
"type": "boolean",
"example": "false"
},
"helpText": {
"type": "string",
"example": "This is a help text"
},
"displayAs": {
"type": "string",
"example": "text"
},
"valueKey": {
"type": "string",
"example": "value"
},
"labelKey": {
"type": "string",
"example": "label"
},
"optionsViaResource": {
"type": "string",
"example": "users"
},
"options": {
"type": "array",
"items": {
"properties": {
"label": {
"type": "string",
"example": "Due today"
},
"value": {
"type": "string",
"example": "today"
}
},
"type": "object"
}
}
},
"type": "object"
},
"CoreTimelinePinResource": {
"title": "Component for Core Timeline Pin Resource",
"properties": {
"subject_id": {
"type": "integer",
"example": "1"
},
"subject_type": {
"type": "string",
"example": "App\\Models\\User"
},
"timelineable_id": {
"type": "integer",
"example": "1"
},
"timelineable_type": {
"type": "string",
"example": "App\\Models\\Task"
}
},
"type": "object"
},
"CalendarEventResource": {
"title": "Component for Calendar EventResource Resource",
"properties": {
"id": {
"description": "Transform the resource collection into an array.",
"type": "integer",
"example": "1"
},
"title": {
"type": "string",
"example": "Meeting with John"
},
"start": {
"type": "string",
"format": "date-time",
"example": "2021-01-01 09:00:00"
},
"end": {
"type": "string",
"format": "date-time",
"example": "2021-01-01 10:00:00"
},
"allDay": {
"type": "boolean",
"example": "false"
},
"isReadOnly": {
"type": "boolean",
"example": "false"
},
"textColor": {
"type": "string",
"example": "#000000"
},
"backgroundColor": {
"type": "string",
"example": "#ffffff"
},
"borderColor": {
"type": "string",
"example": "#ffffff"
},
"extendedProps": {
"properties": {
"event_type": {
"type": "string",
"example": "meeting"
}
},
"type": "object"
}
},
"type": "object"
},
"ChangelogResource": {
"title": "Component for Change Log Resource",
"properties": {
"description": {
"description": "Transform the resource collection into an array.",
"type": "string",
"example": "User created"
},
"causer_name": {
"type": "string",
"example": "John Doe"
},
"properties": {
"type": "array",
"items": {
"type": "object"
}
},
"module": {
"type": "string",
"example": "users"
}
},
"type": "object"
},
"CountryResource": {
"title": "Component for Country Resource",
"properties": {
"id": {
"description": "Transform the resource collection into an array.",
"type": "integer",
"example": "1"
},
"name": {
"type": "string",
"example": "Afghanistan"
}
},
"type": "object"
},
"CoreCustomFieldResource": {
"title": "Component for Custom Field Resource",
"properties": {
"field_type": {
"description": "Transform the resource collection into an array.",
"type": "string",
"example": "text"
},
"resource_name": {
"type": "string",
"example": "users"
},
"field_id": {
"type": "string",
"example": "name"
},
"label": {
"type": "string",
"example": "Name"
},
"options": {
"type": "array",
"items": {
"properties": {
"data": {
"type": "string",
"example": "Option 1"
}
},
"type": "object"
}
},
"is_unique": {
"type": "boolean",
"example": "false"
}
},
"type": "object"
},
"CoreCustomFieldFormResource": {
"title": "Component for Custom Field Form Resource",
"properties": {
"resource_name": {
"type": "string",
"example": "users"
},
"label": {
"type": "string",
"example": "Name"
},
"field_type": {
"type": "string",
"example": "text"
},
"is_unique": {
"type": "boolean",
"example": "false"
},
"field_id": {
"type": "string",
"example": "name"
},
"options": {
"type": "array",
"items": {
"properties": {
"data": {
"type": "string",
"example": "Option 1"
}
},
"type": "object"
}
}
},
"type": "object"
},
"DashboardResource": {
"title": "Component for Dashboard Resource",
"properties": {
"name": {
"description": "Transform the resource collection into an array.",
"type": "string",
"example": "John Doe"
},
"is_default": {
"type": "boolean",
"example": "true"
},
"cards": {
"type": "array",
"items": {
"properties": {
"key": {
"type": "string",
"example": "my-activities"
},
"order": {
"type": "number",
"example": "1"
},
"enabled": {
"type": "boolean",
"example": true
}
},
"type": "object"
}
},
"user_id": {
"type": "integer",
"example": "1"
}
},
"type": "object"
},
"DashboardFormResource": {
"title": "Component for Dashboard Form Resource",
"properties": {
"name": {
"type": "string",
"example": "John Doe"
},
"cards": {
"type": "array",
"items": {
"properties": {
"key": {
"type": "string",
"example": "my-activities"
},
"order": {
"type": "number",
"example": "1"
},
"enabled": {
"type": "boolean",
"example": true
}
},
"type": "object"
}
},
"is_default": {
"type": "boolean",
"example": "true"
}
},
"type": "object"
},
"FilterResource": {
"title": "Component for Filter Resource",
"properties": {
"name": {
"description": "Transform the resource collection into an array.",
"type": "string",
"example": "User Registration"
},
"identifier": {
"type": "string",
"example": "user-registration"
},
"rules": {
"type": "array",
"items": {
"type": "string",
"example": "required"
}
},
"user_id": {
"type": "integer",
"example": "1"
},
"is_shared": {
"type": "boolean",
"example": "true"
},
"is_system_default": {
"type": "boolean",
"example": "true"
},
"is_readonly": {
"type": "boolean",
"example": "true"
},
"defaults": {
"type": "array",
"items": {
"properties": {
"user_id": {
"type": "integer",
"example": "1"
},
"view": {
"type": "string",
"example": "user-registration"
}
},
"type": "object"
}
}
},
"type": "object"
},
"FilterFormResource": {
"title": "Component for Filter Form Resource",
"properties": {
"name": {
"type": "string",
"example": "User Registration"
},
"identifier": {
"type": "string",
"example": "user-registration"
},
"is_shared": {
"type": "boolean",
"example": "true"
}
},
"type": "object"
},
"ImportResource": {
"title": "Component for Import Resource",
"properties": {
"file_name": {
"description": "Transform the resource collection into an array.",
"type": "string",
"example": "import.csv"
},
"skip_file_filename": {
"type": "string",
"example": "import.csv"
},
"mappings": {
"type": "array",
"items": {
"properties": {
"attribute": {
"type": "string",
"example": "first_name"
},
"auto_detected": {
"type": "boolean",
"example": true
},
"original": {
"type": "string",
"example": "First Name"
},
"skip": {
"type": "boolean",
"example": false
},
"detected_attribute": {
"type": "string",
"example": "first_name"
}
},
"type": "object"
}
},
"resource_name": {
"type": "string",
"example": "users"
},
"status": {
"type": "string",
"example": "completed"
},
"imported": {
"type": "number",
"example": 10
},
"skipped": {
"type": "number",
"example": 0
},
"duplicates": {
"type": "number",
"example": 0
},
"fields": {
"type": "array",
"items": {
"properties": {
"key": {
"type": "string",
"example": "name"
},
"label": {
"type": "string",
"example": "Name"
},
"sortable": {
"type": "boolean",
"example": true
}
},
"type": "object"
}
},
"user_id": {
"type": "integer",
"example": "1"
},
"user": {
"$ref": "#/components/schemas/UserResource"
},
"completed_at": {
"type": "string",
"format": "date-time",
"example": "2021-09-01T00:00:00Z"
}
},
"type": "object"
},
"MailableResource": {
"title": "Component for Mailable Resource",
"properties": {
"name": {
"description": "Transform the resource collection into an array.",
"type": "string",
"example": "User Registration"
},
"locale": {
"type": "string",
"example": "en"
},
"subject": {
"type": "string",
"example": "Welcome to our platform"
},
"html_template": {
"type": "string",
"example": "Welcome to our platform
"
},
"text_template": {
"type": "string",
"example": "Welcome to our platform"
},
"placeholders": {
"type": "array",
"items": {
"type": "string",
"example": ":name"
}
}
},
"type": "object"
},
"MailableFormResource": {
"title": "Component for Mailable Form Resource",
"properties": {
"subject": {
"type": "string",
"example": "Welcome to our platform"
},
"html_template": {
"type": "string",
"example": "Welcome to our platform
"
}
},
"type": "object"
},
"MediaResource": {
"title": "Component for Media Resource",
"properties": {
"file_name": {
"description": "Transform the resource collection into an array.",
"type": "string",
"example": "image.jpg"
},
"extension": {
"type": "string",
"example": "jpg"
},
"size": {
"type": "integer",
"example": "1024"
},
"disk_path": {
"type": "string",
"example": "public/images/image.jpg"
},
"mime_type": {
"type": "string",
"example": "image/jpeg"
},
"aggregate_type": {
"type": "string",
"example": "image"
},
"view_url": {
"type": "string",
"example": "http://localhost:8000/storage/images/image.jpg"
},
"preview_url": {
"type": "string",
"example": "http://localhost:8000/storage/images/image.jpg"
},
"preview_path": {
"type": "string",
"example": "public/images/image.jpg"
},
"download_url": {
"type": "string",
"example": "http://localhost:8000/storage/images/image.jpg"
},
"download_path": {
"type": "string",
"example": "public/images/image.jpg"
},
"pending_data": {
"type": "object",
"example": "{}"
}
},
"type": "object"
},
"OAuthAccountResource": {
"title": "Component for OAuth Account Resource",
"properties": {
"user_id": {
"description": "Transform the resource collection into an array.",
"type": "integer",
"example": "1"
},
"type": {
"type": "string",
"example": "google"
},
"email": {
"type": "string",
"example": "example@gmail.com"
},
"requires_auth": {
"type": "boolean",
"example": "true"
}
},
"type": "object"
},
"PermissionResource": {
"title": "Component for Permission Resource",
"properties": {
"name": {
"description": "Transform the resource collection into an array.",
"type": "string",
"example": "View Dashboard"
},
"role_id": {
"type": "integer",
"example": "1"
}
},
"type": "object"
},
"RoleResource": {
"title": "Component for Role Resource",
"properties": {
"name": {
"description": "Transform the resource collection into an array.",
"type": "string",
"example": "Super Admin"
},
"permissions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PermissionResource"
}
}
},
"type": "object"
},
"RoleFormResource": {
"title": "Component for Role Form Resource",
"properties": {
"name": {
"type": "string",
"example": "Super Admin"
}
},
"type": "object"
},
"CoreTagResource": {
"properties": {
"id": {
"description": "Transform the resource collection into an array.",
"type": "integer",
"example": "1"
},
"name": {
"type": "string",
"example": "Tag Name"
},
"swatch_color": {
"type": "string",
"example": "#000000"
},
"display_order": {
"type": "integer",
"example": "1"
},
"type": {
"type": "string",
"example": "tag"
}
},
"type": "object"
},
"CoreTagFormResource": {
"properties": {
"name": {
"type": "string",
"example": "Tag Name"
},
"swatch_color": {
"type": "string",
"example": "#000000"
},
"display_order": {
"type": "integer",
"example": "1"
}
},
"type": "object"
},
"WorkflowResource": {
"title": "Component for Workflow Resource",
"properties": {
"title": {
"description": "Transform the resource collection into an array.",
"type": "string",
"example": "Missed Incoming Call"
},
"description": {
"type": "string",
"example": "Missed incoming call workflow"
},
"is_active": {
"type": "boolean",
"example": true
},
"total_executions": {
"type": "integer",
"example": 0
},
"trigger_type": {
"type": "string",
"example": "incoming_call"
},
"action_type": {
"type": "string",
"example": "create_activity"
},
"data": {
"properties": {
"due_date": {
"type": "string",
"example": "today"
}
},
"type": "object"
}
},
"type": "object"
},
"WorkflowFormResource": {
"title": "Component for Workflow Form Resource",
"properties": {
"trigger_type": {
"type": "string",
"example": "incoming_call"
},
"action_type": {
"type": "string",
"example": "create_activity"
},
"title": {
"type": "string",
"example": "Missed Incoming Call"
},
"description": {
"type": "string",
"example": "Missed incoming call workflow"
},
"is_active": {
"type": "boolean",
"example": true
},
"data": {
"properties": {
"due_date": {
"type": "string",
"example": "today"
}
},
"type": "object"
}
},
"type": "object"
},
"DealBoardCardResource": {
"title": "Component for Deal Board Card Resource",
"properties": {
"id": {
"description": "Transform the resource collection into an array.",
"type": "integer",
"example": "1"
},
"name": {
"type": "string",
"example": "Deal 1"
},
"amount": {
"type": "integer",
"example": "1000"
},
"display_name": {
"type": "string",
"example": "Deal 1"
},
"path": {
"type": "string",
"example": "http://localhost:8000/deals/1"
},
"status": {
"type": "string",
"example": "Open"
},
"authorizations": {
"type": "array",
"items": {
"type": "object"
}
},
"expected_close_date": {
"type": "string",
"example": "2021-09-01"
},
"incomplete_activities_for_user_count": {
"type": "integer",
"example": "1"
},
"user_id": {
"type": "integer",
"example": "1"
},
"swatch_color": {
"type": "string",
"example": "#FF0000"
},
"stage_id": {
"type": "integer",
"example": "1"
},
"falls_behind_expected_close_date": {
"type": "boolean",
"example": "true"
}
},
"type": "object"
},
"DealBoardResource": {
"title": "Component for Deal Board Resource",
"properties": {
"id": {
"description": "Transform the resource collection into an array.",
"type": "integer",
"example": "1"
},
"name": {
"type": "string",
"example": "Stage 1"
},
"win_probability": {
"type": "integer",
"example": "10"
},
"display_order": {
"type": "integer",
"example": "1"
},
"summary": {
"type": "string",
"example": "Stage 1 summary"
},
"cards": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DealBoardCardResource"
}
}
},
"type": "object"
},
"DealResource": {
"title": "Component for Deal Resource",
"properties": {
"notes_count": {
"description": "Transform the resource collection into an array.",
"type": "integer",
"example": "1"
},
"calls_count": {
"type": "integer",
"example": "1"
},
"lost_reason": {
"type": "string",
"example": "Lost Reason"
},
"lost_date": {
"type": "string",
"example": "2021-09-01 00:00:00"
},
"won_date": {
"type": "string",
"example": "2021-09-01 00:00:00"
},
"stage_changed_date": {
"type": "string",
"example": "2021-09-01 00:00:00"
},
"falls_behind_expected_close_date": {
"type": "boolean",
"example": "true"
},
"board_order": {
"type": "integer",
"example": "1"
},
"time_in_stages": {
"type": "array",
"items": {
"type": "object"
}
},
"changelog": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ChangelogResource"
}
},
"notes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NoteResource"
}
},
"calls": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CallResource"
}
},
"activities": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ActivityResource"
}
},
"media": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MediaResource"
}
},
"emails": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EmailAccountMessageResource"
}
}
},
"type": "object"
},
"StageResource": {
"title": "Component for Stage Resource",
"properties": {
"name": {
"description": "Transform the resource collection into an array.",
"type": "string",
"example": "Stage 1"
},
"win_probability": {
"type": "integer",
"example": "10"
},
"display_order": {
"type": "integer",
"example": "1"
},
"pipeline_id": {
"type": "integer",
"example": "1"
}
},
"type": "object"
},
"DocumentResource": {
"title": "Component for Document Resource",
"properties": {
"requires_signature": {
"description": "Transform the resource collection into an array.",
"type": "boolean",
"example": "true"
},
"content": {
"type": "string",
"example": "Document Content"
},
"view_type": {
"type": "string",
"example": "document"
},
"brand_id": {
"type": "integer",
"example": "1"
},
"send_at": {
"type": "string",
"example": "2022-01-01 00:00:00"
},
"original_date_sent": {
"type": "string",
"example": "2022-01-01 00:00:00"
},
"last_date_sent": {
"type": "string",
"example": "2022-01-01 00:00:00"
},
"accepted_at": {
"type": "string",
"example": "2022-01-01 00:00:00"
},
"marked_accepted_by": {
"type": "integer",
"example": "1"
},
"locale": {
"type": "string",
"example": "en"
},
"created_by": {
"type": "integer",
"example": "1"
},
"public_url": {
"type": "string",
"example": "http://example.com"
},
"signers": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentSignerResource"
}
},
"recipients": {
"type": "array",
"items": {
"type": "object"
}
},
"send_mail_account_id": {
"type": "integer",
"example": "1"
},
"send_mail_subject": {
"type": "string",
"example": "Mail Subject"
},
"send_mail_body": {
"type": "string",
"example": "Mail Body"
},
"pdf": {
"type": "object",
"example": "{}"
},
"google_fonts": {
"type": "array",
"items": {
"type": "string"
}
},
"changelog": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ChangelogResource"
}
},
"contacts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContactResource"
}
},
"companies": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CompanyResource"
}
},
"deals": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DealResource"
}
}
},
"type": "object"
},
"DocumentSignerResource": {
"title": "Component for Document Signer Resource",
"properties": {
"name": {
"description": "Transform the resource collection into an array.",
"type": "string",
"example": "John Doe"
},
"email": {
"type": "string",
"example": "example@gmail.com"
},
"sent_at": {
"type": "string",
"example": "2022-01-01 00:00:00"
},
"send_email": {
"type": "boolean",
"example": "true"
},
"signed_at": {
"type": "string",
"example": "2022-01-01 00:00:00"
},
"signature": {
"type": "string",
"example": "Signature"
},
"sign_ip": {
"type": "string",
"example": "127.0.0.1"
}
},
"type": "object"
},
"EmailAccountMessageFormResource": {
"title": "Component for Email Account Message Form Resource",
"properties": {
"to": {
"type": "array",
"items": {
"properties": {
"address": {
"type": "string",
"format": "email",
"example": "example@gmail.com"
}
},
"type": "object"
}
},
"cc": {
"type": "array",
"items": {
"properties": {
"address": {
"type": "string",
"format": "email",
"example": "example@gmail.com"
}
},
"type": "object"
}
},
"bcc": {
"type": "array",
"items": {
"properties": {
"address": {
"type": "string",
"format": "email",
"example": "example@gmail.com"
}
},
"type": "object"
}
},
"subject": {
"type": "string",
"example": "Subject"
},
"via_resource": {
"type": "string",
"example": "App\\\\Models\\\\User"
},
"via_resource_id": {
"type": "number",
"example": 1
}
},
"type": "object"
},
"EmailAccountFolderResource": {
"title": "Component for Email Account Folder Resource",
"properties": {
"id": {
"description": "Transform the resource collection into an array.",
"type": "integer",
"example": "1"
},
"parent_id": {
"type": "integer",
"example": "1"
},
"email_account_id": {
"type": "integer",
"example": "1"
},
"remote_id": {
"type": "string",
"example": "1"
},
"name": {
"type": "string",
"example": "Inbox"
},
"display_name": {
"type": "string",
"example": "Inbox"
},
"syncable": {
"type": "boolean",
"example": "true"
},
"selectable": {
"type": "boolean",
"example": "true"
},
"unread_count": {
"type": "integer",
"example": "1"
},
"type": {
"type": "string",
"example": "inbox"
}
},
"type": "object"
},
"EmailAccountMessageResource": {
"title": "Component for Email Account Message Resource",
"properties": {
"email_account_id": {
"description": "Transform the resource collection into an array.",
"type": "integer",
"example": "1"
},
"email_account_email": {
"type": "string",
"example": "example@gmail.com"
},
"remote_id": {
"type": "string",
"example": "1"
},
"message_id": {
"type": "string",
"example": "1"
},
"subject": {
"type": "string",
"example": "This is a subject"
},
"html_body": {
"type": "string",
"example": "This is a html body"
},
"text_body": {
"type": "string",
"example": "This is a text body"
},
"preview_text": {
"type": "string",
"example": "This is a preview text"
},
"visible_text": {
"type": "string",
"example": "This is a visible text"
},
"hidden_text": {
"type": "string",
"example": "This is a hidden text"
},
"editor_text": {
"type": "string",
"example": "This is a editor text"
},
"is_draft": {
"type": "boolean",
"example": "true"
},
"is_read": {
"type": "boolean",
"example": "true"
},
"was_unread": {
"type": "boolean",
"example": "true"
},
"from": {
"type": "strong",
"example": "This is a from"
},
"to": {
"type": "string",
"example": "This is a to"
},
"cc": {
"type": "string",
"example": "This is a cc"
},
"bcc": {
"type": "string",
"example": "This is a bcc"
},
"reply_to": {
"type": "string",
"example": "This is a reply to"
},
"sender": {
"type": "string",
"example": "This is a sender"
},
"display_name": {
"type": "string",
"example": "This is a display name"
},
"path": {
"type": "string",
"example": "This is a path"
},
"folders": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EmailAccountFolderResource"
}
},
"contacts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContactResource"
}
},
"companies": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CompanyResource"
}
},
"deals": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DealResource"
}
},
"account_active_folders_tree": {
"type": "array",
"items": {
"type": "object"
}
},
"avatar_url": {
"type": "string",
"example": "This is a avatar url"
},
"media": {
"type": "array",
"items": {
"$ref": "#/components/schemas/MediaResource"
}
},
"date": {
"type": "string",
"example": "2021-01-01 00:00:00"
},
"opens": {
"type": "integer",
"example": "1"
},
"opened_at": {
"type": "string",
"example": "2021-01-01 00:00:00"
}
},
"type": "object"
},
"EmailAccountResource": {
"title": "Component for Email Account Resource",
"properties": {
"email": {
"description": "Transform the resource collection into an array.",
"type": "string",
"example": "example@gmail.com"
},
"alias_email": {
"type": "string",
"example": "example2@gmail.com"
},
"display_email": {
"type": "string",
"example": "naka"
},
"connection_type": {
"type": "string",
"example": "imap"
},
"requires_auth": {
"type": "boolean",
"example": true
},
"sync_state_comment": {
"type": "string",
"example": "-"
},
"initial_sync_from": {
"type": "string",
"example": "2021-09-30T00:00:00.000000Z"
},
"can_send_mails": {
"type": "boolean",
"example": true
},
"is_initial_sync_performed": {
"type": "boolean",
"example": true
},
"is_sync_disabled": {
"type": "boolean",
"example": false
},
"is_sync_stopped": {
"type": "boolean",
"example": false
},
"is_primary": {
"type": "boolean",
"example": true
},
"type": {
"type": "string",
"example": "personal"
},
"is_shared": {
"type": "boolean",
"example": false
},
"is_personal": {
"type": "boolean",
"example": true
},
"formatted_from_name_header": {
"type": "string",
"example": "naka"
},
"create_contact": {
"type": "boolean",
"example": true
},
"folders": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EmailAccountFolderResource"
}
},
"folders_tree": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EmailAccountFolderResource"
}
},
"active_folders": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EmailAccountFolderResource"
}
},
"active_folders_tree": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EmailAccountFolderResource"
}
},
"sent_folder": {
"$ref": "#/components/schemas/EmailAccountFolderResource"
},
"trash_folder": {
"$ref": "#/components/schemas/EmailAccountFolderResource"
},
"sent_folder_id": {
"type": "integer",
"example": 1
},
"trash_folder_id": {
"type": "integer",
"example": 2
},
"from_name_header": {
"type": "string",
"example": "naka"
},
"username": {
"type": "string",
"example": "naka123"
},
"imap_server": {
"type": "string",
"example": "imap.gmail.com"
},
"imap_port": {
"type": "integer",
"example": 993
},
"imap_encryption": {
"type": "string",
"example": "ssl"
},
"smtp_server": {
"type": "string",
"example": "smtp.gmail.com"
},
"smtp_port": {
"type": "integer",
"example": 465
},
"smtp_encryption": {
"type": "string",
"example": "ssl"
},
"validate_cert": {
"type": "boolean",
"example": true
}
},
"type": "object"
},
"EmailAccountFormResource": {
"title": "Component for Email Account Form Resource",
"properties": {
"connection_type": {
"type": "string",
"example": "imap"
},
"email": {
"type": "string",
"example": "example@gmail.com"
},
"password": {
"type": "string",
"example": "password"
},
"sent_folder_id": {
"type": "integer",
"example": 1
},
"trash_folder_id": {
"type": "integer",
"example": 2
},
"from_name_header": {
"type": "string",
"example": "naka"
},
"initial_sync_from": {
"type": "string",
"example": "2021-09-30T00:00:00.000000Z"
},
"imap_server": {
"type": "string",
"example": "imap.gmail.com"
},
"imap_port": {
"type": "integer",
"example": 993
},
"imap_encryption": {
"type": "string",
"example": "ssl"
},
"smtp_server": {
"type": "string",
"example": "smtp.gmail.com"
},
"smtp_port": {
"type": "integer",
"example": 465
},
"smtp_encryption": {
"type": "string",
"example": "ssl"
},
"validate_cert": {
"type": "boolean",
"example": true
}
},
"type": "object"
},
"PredefinedMailTemplateResource": {
"title": "Component for Predefined Mail Template Resource",
"properties": {
"name": {
"description": "Transform the resource collection into an array.",
"type": "string",
"example": "Template 1"
},
"subject": {
"type": "string",
"example": "Subject 1"
},
"body": {
"type": "string",
"example": "Body 1"
},
"is_shared": {
"type": "boolean",
"example": true
},
"user_id": {
"type": "integer",
"example": 1
},
"user": {
"$ref": "#/components/schemas/UserResource"
}
},
"type": "object"
},
"PredefinedMailTemplateFormResource": {
"title": "Component for Predefined Mail Template Form Resource",
"properties": {
"name": {
"type": "string",
"example": "Template 1"
},
"subject": {
"type": "string",
"example": "Subject 1"
},
"body": {
"type": "string",
"example": "Body 1"
},
"is_shared": {
"type": "boolean",
"example": true
}
},
"type": "object"
},
"NoteResource": {
"title": "Component for Note Resource",
"properties": {
"body": {
"description": "Transform the resource collection into an array.",
"type": "string",
"example": "This is a note"
},
"user_id": {
"type": "integer",
"example": "1"
},
"user": {
"$ref": "#/components/schemas/UserResource"
},
"companies": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CompanyResource"
}
},
"contacts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ContactResource"
}
},
"deals": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DealResource"
}
},
"comments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CommentResource"
}
},
"comments_count": {
"type": "integer",
"example": "1"
}
},
"type": "object"
},
"TranslationResource": {
"title": "Component for Translation Resource",
"properties": {
"groups": {
"properties": {
"auth": {
"properties": {
"user.name": {
"type": "string",
"example": "User Name"
},
"user.email": {
"type": "string",
"example": "User Email"
}
},
"type": "object"
}
},
"type": "object"
},
"namespaces": {
"properties": {
"product": {
"properties": {
"related_products": {
"type": "string",
"example": "Related Products"
},
"direct_cost": {
"type": "string",
"example": "Direct Cost"
}
},
"type": "object"
}
},
"type": "object"
}
},
"type": "object"
},
"NotificationResource": {
"title": "Component for Notification Resource",
"properties": {
"id": {
"type": "integer",
"example": 1
},
"type": {
"type": "string",
"example": "App\\Notifications\\NewUserRegistered"
},
"notifiable_id": {
"type": "integer",
"example": 1
},
"notifiable_type": {
"type": "string",
"example": "Modules\\Users\\Models\\User"
},
"data": {
"type": "object",
"example": {
"message": "New user has been registered."
}
},
"read_at": {
"type": "string",
"format": "date-time",
"example": "2021-09-30T00:00:00.000000Z"
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2021-09-30T00:00:00.000000Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2021-09-30T00:00:00.000000Z"
}
},
"type": "object"
},
"NotificationPaginateResource": {
"title": "Component for Notification Paginate Resource",
"properties": {
"current_page": {
"type": "integer",
"example": 1
},
"data": {
"type": "array",
"items": {
"$ref": "#/components/schemas/NotificationResource"
}
},
"first_page_url": {
"type": "string",
"example": "http://localhost/api/notifications?page=1"
},
"from": {
"type": "integer",
"example": 1
},
"last_page": {
"type": "integer",
"example": 1
},
"last_page_url": {
"type": "string",
"example": "http://localhost/api/notifications?page=1"
},
"next_page_url": {
"type": "string",
"example": null
},
"path": {
"type": "string",
"example": "http://localhost/api/notifications"
},
"per_page": {
"type": "integer",
"example": 15
},
"prev_page_url": {
"type": "string",
"example": null
},
"to": {
"type": "integer",
"example": 1
},
"total": {
"type": "integer",
"example": 1
},
"link": {
"type": "array",
"items": {
"properties": {
"url": {
"type": "string",
"example": "http://localhost/api/notifications?page=1"
},
"label": {
"type": "string",
"example": "1"
},
"active": {
"type": "boolean",
"example": true
}
},
"type": "object"
}
}
},
"type": "object"
},
"PersonalAccessTokenResource": {
"title": "Component for Personal Access Token Resource",
"properties": {
"id": {
"type": "integer",
"example": 1
},
"name": {
"type": "string",
"example": "My iPhone"
},
"tokenable_id": {
"type": "integer",
"example": 1
},
"tokenable_type": {
"type": "string",
"example": "Modules\\Users\\Models\\User"
},
"abilities": {
"type": "array",
"items": {
"type": "string",
"example": "*"
}
},
"expires_at": {
"type": "string",
"format": "date-time",
"example": "2021-09-30T00:00:00.000000Z"
},
"created_at": {
"type": "string",
"format": "date-time",
"example": "2021-09-30T00:00:00.000000Z"
},
"updated_at": {
"type": "string",
"format": "date-time",
"example": "2021-09-30T00:00:00.000000Z"
}
},
"type": "object"
},
"TeamResource": {
"title": "Component for Team Resource",
"properties": {
"name": {
"description": "Transform the resource collection into an array.",
"type": "string",
"example": "Team 1"
},
"description": {
"type": "string",
"example": "Team 1 description"
},
"user_id": {
"type": "integer",
"example": "1"
},
"manager": {
"$ref": "#/components/schemas/UserResource"
},
"members": {
"type": "array",
"items": {
"$ref": "#/components/schemas/UserResource"
}
}
},
"type": "object"
},
"TeamFormResource": {
"title": "Component for Team Form Resource",
"properties": {
"name": {
"type": "string",
"example": "Team 1"
},
"description": {
"type": "string",
"example": "Team Description"
},
"user_id": {
"type": "number",
"example": 1
},
"members": {
"type": "array",
"items": {
"type": "number",
"example": 1
}
}
},
"type": "object"
},
"UserResource": {
"title": "Component for User Resource",
"properties": {
"name": {
"description": "Transform the resource collection into an array.",
"type": "string",
"example": "John Doe"
},
"email": {
"type": "string",
"example": "example@gmail.com"
},
"timezone": {
"type": "string",
"example": "UTC"
},
"mail_signature": {
"type": "string",
"example": ""
},
"teams": {
"type": "array",
"items": {
"$ref": "#/components/schemas/TeamResource"
}
},
"super_admin": {
"type": "boolean",
"example": "false"
},
"access_api": {
"type": "boolean",
"example": "false"
},
"locale": {
"type": "string",
"example": "en"
},
"avatar": {
"type": "string",
"example": ""
},
"uploaded_avatar_url": {
"type": "string",
"example": ""
},
"avatar_url": {
"type": "string",
"example": ""
},
"time_format": {
"type": "string",
"example": "H:i"
},
"date_format": {
"type": "string",
"example": "Y-m-d"
},
"first_day_of_week": {
"type": "number",
"example": "1"
},
"dashboards": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DashboardResource"
}
},
"notifications": {
"type": "array",
"items": {
"properties": {
"latest": {
"type": "array",
"items": {
"type": "object"
}
},
"unread_count": {
"type": "number",
"example": "0"
},
"settings": {
"type": "array",
"items": {
"type": "object"
}
}
},
"type": "object"
}
},
"permissions": {
"type": "array",
"items": {
"$ref": "#/components/schemas/PermissionResource"
}
},
"roles": {
"type": "array",
"items": {
"$ref": "#/components/schemas/RoleResource"
}
},
"gate": {
"type": "array",
"items": {
"properties": {
"access-api": {
"type": "boolean",
"example": "false"
},
"is-super-admin": {
"type": "boolean",
"example": "false"
}
},
"type": "object"
}
}
},
"type": "object"
},
"WebFormFormResource": {
"title": "Component for Web Form Form Resource",
"properties": {
"locale": {
"type": "string",
"example": "en"
},
"title": {
"type": "string",
"example": "Contact Us"
},
"styles": {
"properties": {
"primary_color": {
"type": "string",
"example": "#000000"
},
"background_color": {
"type": "string",
"example": "#FFFFFF"
},
"logo": {
"type": "string",
"example": "dark"
}
},
"type": "object"
},
"notifications": {
"type": "array",
"items": {
"type": "string",
"example": "example@gmail.com"
}
},
"submit_data": {
"properties": {
"pipeline_id": {
"type": "number",
"example": "1"
},
"stage_id": {
"type": "number",
"example": "1"
},
"action": {
"type": "string",
"example": "message"
},
"success_title": {
"type": "string",
"example": "Thank you!"
},
"success_redirect_url": {
"type": "string",
"example": "https://example.com"
}
},
"type": "object"
},
"user_id": {
"type": "number",
"example": "1"
}
},
"type": "object"
},
"WebFormResource": {
"title": "Component for Web Form Resource",
"properties": {
"id": {
"description": "Transform the resource collection into an array.",
"type": "number",
"example": "1"
},
"title": {
"type": "string",
"example": "Contact Us"
},
"status": {
"type": "string",
"example": "active"
},
"uuid": {
"type": "string",
"example": "123e4567-e89b-12d3-a456-426614174000"
},
"sections": {
"type": "array",
"items": {
"properties": {
"id": {
"type": "number",
"example": "1"
},
"type": {
"type": "string",
"example": "introduction"
},
"label": {
"type": "string",
"example": "Introduction"
},
"message": {
"type": "string",
"example": "Welcome to our contact form."
}
},
"type": "object"
}
},
"submit_data": {
"properties": {
"success_message": {
"type": "string",
"example": "Thank you!"
}
},
"type": "object"
},
"styles": {
"properties": {
"primary_color": {
"type": "string",
"example": "#000000"
},
"background_color": {
"type": "string",
"example": "#FFFFFF"
},
"logo": {
"type": "string",
"example": "dark"
}
},
"type": "object"
},
"notifications": {
"type": "array",
"items": {
"type": "string",
"example": "example@gmail.com"
}
},
"title_prefix": {
"type": "string",
"example": "Contact Us"
},
"locale": {
"type": "string",
"example": "en"
},
"user_id": {
"type": "number",
"example": "1"
},
"user": {
"$ref": "#/components/schemas/UserResource"
},
"public_url": {
"type": "string",
"example": "https://example.com/form/123e4567-e89b-12d3-a456-426614174000"
},
"total_submissions": {
"type": "number",
"example": "1"
}
},
"type": "object"
}
},
"responses": {
"Default401Response": {
"description": "Unauthorized",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Unauthenticated"
}
},
"type": "object"
}
}
}
},
"Default403Response": {
"description": "Forbidden",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "You are not authorized to access this resource"
}
},
"type": "object"
}
}
}
},
"Default404Response": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Resource not found"
}
},
"type": "object"
}
}
}
},
"Default405Response": {
"description": "Method Not Allowed",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Method Not Allowed"
}
},
"type": "object"
}
}
}
},
"Default409Response": {
"description": "Client Error",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Data already exists"
}
},
"type": "object"
}
}
}
},
"Default419Response": {
"description": "CSRF Token Mismatch",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "CSRF Token Mismatch"
}
},
"type": "object"
}
}
}
},
"Default422Response": {
"description": "Unprocessable Entity",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "The given data was invalid."
},
"errors": {
"properties": {
"data 1": {
"type": "string",
"example": "The data 1 field is required."
},
"data 2": {
"type": "string",
"example": "The data 2 must contain 'bla bla bla'."
}
},
"type": "object"
}
},
"type": "object"
}
}
}
},
"Default429Response": {
"description": "Too Many Requests",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Too Many Requests"
}
},
"type": "object"
}
}
}
},
"Default500Response": {
"description": "Server Error",
"content": {
"application/json": {
"schema": {
"properties": {
"message": {
"type": "string",
"example": "Server Error"
}
},
"type": "object"
}
}
}
}
},
"parameters": {
"TwilioAppId": {
"name": "id",
"in": "path",
"description": "TwiML Application SID",
"required": true,
"schema": {
"type": "string"
}
},
"ActivityId": {
"name": "activity",
"in": "path",
"description": "Activity ID",
"required": true,
"schema": {
"type": "number"
}
},
"BrandId": {
"name": "brand",
"in": "path",
"description": "Brand ID",
"required": true,
"schema": {
"type": "number"
}
},
"BrandLogoType": {
"name": "type",
"in": "path",
"description": "Brand Logo Type",
"required": true,
"schema": {
"type": "string"
}
},
"CommentId": {
"name": "comment",
"in": "path",
"description": "Comment ID",
"required": true,
"schema": {
"type": "number"
}
},
"CommentResource": {
"name": "resource",
"in": "path",
"description": "The resource name.",
"required": true,
"schema": {
"type": "string"
}
},
"CommentResourceId": {
"name": "resourceId",
"in": "path",
"description": "The resource ID.",
"required": true,
"schema": {
"type": "number"
}
},
"CoreCustomFieldId": {
"name": "custom_field",
"in": "path",
"description": "Custom field ID",
"required": true,
"schema": {
"type": "integer"
}
},
"CoreDashboardId": {
"name": "dashboard",
"in": "path",
"description": "The ID of the dashboard",
"required": true,
"schema": {
"type": "integer"
}
},
"CoreFieldGroup": {
"name": "group",
"in": "path",
"description": "Field group",
"required": true,
"schema": {
"type": "string"
}
},
"CoreFieldView": {
"name": "view",
"in": "path",
"description": "Field view",
"required": true,
"schema": {
"type": "string"
}
},
"CoreFilterId": {
"name": "filter",
"in": "path",
"description": "The ID of the filter",
"required": true,
"schema": {
"type": "integer"
}
},
"CoreFilterView": {
"name": "view",
"in": "path",
"description": "The view name",
"required": true,
"schema": {
"type": "string"
}
},
"CoreLogoType": {
"name": "type",
"in": "path",
"description": "The type of the logo",
"required": true,
"schema": {
"type": "string",
"enum": [
"light",
"dark"
]
}
},
"CoreMailableTemplateId": {
"name": "template",
"in": "path",
"description": "The ID of the mail template",
"required": true,
"schema": {
"type": "integer"
}
},
"CoreAssociationResourceName": {
"name": "resource",
"in": "path",
"description": "Resource Name",
"required": true,
"schema": {
"type": "string"
}
},
"CoreAssociationResourceId": {
"name": "resourceId",
"in": "path",
"description": "Resource ID",
"required": true,
"schema": {
"type": "integer"
}
},
"CoreFieldResourceName": {
"name": "resource",
"in": "path",
"description": "Resource Name",
"required": true,
"schema": {
"type": "string"
}
},
"CoreFieldResourceId": {
"name": "resourceId",
"in": "path",
"description": "Resource ID",
"required": true,
"schema": {
"type": "integer"
}
},
"CoreImportResource": {
"name": "resource",
"in": "path",
"description": "The resource name",
"required": true,
"schema": {
"type": "string"
}
},
"CoreImportId": {
"name": "id",
"in": "path",
"description": "The import ID",
"required": true,
"schema": {
"type": "number"
}
},
"CoreMediaResourceName": {
"name": "resource",
"in": "path",
"description": "Resource Name",
"required": true,
"schema": {
"type": "string"
}
},
"CoreMediaResourceId": {
"name": "resourceId",
"in": "path",
"description": "Resource ID",
"required": true,
"schema": {
"type": "integer"
}
},
"CoreResourcefulResourceName": {
"name": "resource",
"in": "path",
"description": "Resource Name",
"required": true,
"schema": {
"type": "string"
}
},
"CoreResourcefulResourceId": {
"name": "resourceId",
"in": "path",
"description": "Resource ID",
"required": true,
"schema": {
"type": "integer"
}
},
"CoreSearchQuery": {
"name": "q",
"in": "query",
"description": "Search query",
"required": true,
"schema": {
"type": "string"
}
},
"CoreTableResourceName": {
"name": "resource",
"in": "path",
"description": "Resource Name",
"required": true,
"schema": {
"type": "string"
}
},
"CoreTrashResourceName": {
"name": "resource",
"in": "path",
"description": "Resource Name",
"required": true,
"schema": {
"type": "string"
}
},
"CoreTrashResourceId": {
"name": "resourceId",
"in": "path",
"description": "Resource ID",
"required": true,
"schema": {
"type": "integer"
}
},
"CoreRoleId": {
"name": "role",
"in": "path",
"description": "The ID of the role",
"required": true,
"schema": {
"type": "integer"
}
},
"CoreTagType": {
"name": "type",
"in": "path",
"description": "Tag type",
"required": false,
"schema": {
"type": "string"
}
},
"CoreTagId": {
"name": "tag",
"in": "path",
"description": "Tag ID",
"required": true,
"schema": {
"type": "integer"
}
},
"CoreUpdaterPurchaseKey": {
"name": "purchase_key",
"in": "path",
"description": "Purchase key",
"required": false,
"schema": {
"type": "string"
}
},
"CoreWorkflowId": {
"name": "workflow",
"in": "path",
"description": "Workflow ID",
"required": true,
"schema": {
"type": "integer"
}
},
"DealBoardPipelineId": {
"name": "pipeline",
"in": "path",
"description": "Pipeline ID",
"required": true,
"schema": {
"type": "string"
}
},
"DocumentUuid": {
"name": "uuid",
"in": "path",
"description": "Document UUID",
"required": true,
"schema": {
"type": "string"
}
},
"DocumentId": {
"name": "document",
"in": "path",
"description": "Document ID",
"required": true,
"schema": {
"type": "number"
}
},
"MailClientAccountId": {
"name": "account",
"in": "path",
"description": "Mail Client Account ID",
"required": true,
"schema": {
"type": "number"
}
},
"MailClientMessageId": {
"name": "message",
"in": "path",
"description": "Mail Client Message ID",
"required": true,
"schema": {
"type": "number"
}
},
"MailClientInboxFolderId": {
"name": "folder_id",
"in": "path",
"description": "Mail Client Inbox Folder ID",
"required": true,
"schema": {
"type": "number"
}
},
"MailClientInboxAccountId": {
"name": "account_id",
"in": "path",
"description": "Mail Client Account Folder ID",
"required": true,
"schema": {
"type": "number"
}
},
"MailClientTemplateId": {
"name": "template",
"in": "path",
"description": "Mail Client Template ID",
"required": true,
"schema": {
"type": "number"
}
},
"TranslatorLocale": {
"name": "locale",
"in": "path",
"description": "Translator Locale",
"required": true,
"schema": {
"type": "string"
}
},
"UserNotificationId": {
"name": "notification",
"in": "path",
"description": "User Notification ID",
"required": true,
"schema": {
"type": "number"
}
},
"UserTeamsId": {
"name": "team",
"in": "path",
"description": "User Team ID",
"required": true,
"schema": {
"type": "number"
}
},
"UserAvatarId": {
"name": "user",
"in": "path",
"description": "User ID",
"required": true,
"schema": {
"type": "number"
}
},
"WebFormId": {
"name": "form",
"in": "path",
"description": "Web Form ID",
"required": true,
"schema": {
"type": "number"
}
}
},
"securitySchemes": {
"sanctum": {
"type": "apiKey",
"description": "Enter token in format (Bearer x|xxxxxxxxxxxxx)",
"name": "Authorization",
"in": "header"
}
}
},
"tags": [
{
"name": "Authentication",
"description": "Endpoints for Authentication"
},
{
"name": "Activities",
"description": "Endpoints for Activities"
},
{
"name": "Calendar",
"description": "Endpoints for Calendar"
},
{
"name": "Billable",
"description": "Endpoints for Billable"
},
{
"name": "Brands",
"description": "Endpoints for Brands"
},
{
"name": "Comments",
"description": "Endpoints for Comments"
},
{
"name": "Cards",
"description": "Endpoints for Cards"
},
{
"name": "Core",
"description": "Main Endpoints for API"
},
{
"name": "Fields",
"description": "Endpoints for Fields"
},
{
"name": "Dashboards",
"description": "Endpoints for Dashboards"
},
{
"name": "Settings",
"description": "Endpoints for Settings"
},
{
"name": "Filters",
"description": "Endpoints for Filters"
},
{
"name": "Mailables",
"description": "Endpoints for Mailables"
},
{
"name": "Roles",
"description": "Endpoints for Roles"
},
{
"name": "Associations",
"description": "Endpoints for Associations"
},
{
"name": "Search",
"description": "Endpoints for Search"
},
{
"name": "Import",
"description": "Endpoints for Import"
},
{
"name": "Media",
"description": "Endpoints for Media"
},
{
"name": "Placeholders",
"description": "Endpoints for Placeholders"
},
{
"name": "Resourceful",
"description": "Endpoints for Resourceful"
},
{
"name": "Table",
"description": "Endpoints for Table"
},
{
"name": "Trashed",
"description": "Endpoints for Trashed"
},
{
"name": "Users",
"description": "Endpoints for Users"
},
{
"name": "System",
"description": "Endpoints for System"
},
{
"name": "Tags",
"description": "Endpoints for Tags"
},
{
"name": "Updater",
"description": "Endpoints for Updater"
},
{
"name": "Voip",
"description": "Endpoints for Voip"
},
{
"name": "Workflow",
"description": "Endpoints for Workflow"
},
{
"name": "Zapier",
"description": "Endpoints for Zapier"
},
{
"name": "Deals",
"description": "Endpoints for Deals"
},
{
"name": "Documents",
"description": "Endpoints for Documents"
},
{
"name": "MailClient",
"description": "Endpoints for MailClient"
},
{
"name": "Translator",
"description": "Endpoints for Translator"
},
{
"name": "Notifications",
"description": "Endpoints for Notifications"
},
{
"name": "Users",
"description": "Endpoints for Users"
},
{
"name": "Teams",
"description": "Endpoints for Teams"
},
{
"name": "WebForms",
"description": "Endpoints for WebForms"
},
{
"name": "Tools",
"description": "Tools for handle API"
},
{
"name": "Twillio",
"description": "Endpoints for Twillio"
}
],
"security": [
{
"sanctum": []
}
]
}